diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml new file mode 100644 index 00000000..6a4b3543 --- /dev/null +++ b/.github/workflows/ci.yml @@ -0,0 +1,361 @@ +name: CI + +on: + push: + branches: [ main, maint-0.x ] + pull_request: + branches: [ main, maint-0.x ] + +jobs: + test-python-312-single-user: + runs-on: ubuntu-latest + + steps: + - uses: actions/checkout@v4 + + - name: Set up Python 3.12 + uses: actions/setup-python@v4 + with: + python-version: "3.12" + + - name: Install dependencies + run: | + python -m pip install --upgrade pip + pip install -e .[dev] + + - name: Lint with flake8 and pylint + run: make lint + + - name: Set up Docker Buildx + uses: docker/setup-buildx-action@v3 + + - name: Generate certificates + run: make certs + + - name: Start NiFi infrastructure (single-user) + run: make up NIPYAPI_PROFILE=single-user + + - name: Wait for NiFi to be ready + run: make wait-ready NIPYAPI_PROFILE=single-user + + - name: Run integration tests with coverage + run: NIPYAPI_PROFILE=single-user PYTHONPATH=${{ github.workspace }}:$PYTHONPATH pytest --cov=nipyapi --cov-report=xml --cov-report=term-missing + env: + PYTHONHTTPSVERIFY: "0" + CURL_CA_BUNDLE: "" + REQUESTS_CA_BUNDLE: "" + + - name: Test distribution build and import + run: make test-dist + + - name: Stop NiFi infrastructure + if: always() + run: make down + + - name: Upload coverage to Codecov + uses: codecov/codecov-action@v4 + with: + file: ./coverage.xml + fail_ci_if_error: false + verbose: true + env: + CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }} + + test-python-311-single-user: + runs-on: ubuntu-latest + + steps: + - uses: actions/checkout@v4 + + - name: Set up Python 3.11 + uses: actions/setup-python@v4 + with: + python-version: "3.11" + + - name: Install dependencies + run: | + python -m pip install --upgrade pip + pip install -e .[dev] + + - name: Set up Docker Buildx + uses: docker/setup-buildx-action@v3 + + - name: Generate certificates + run: make certs + + - name: Start NiFi infrastructure (single-user) + run: make up NIPYAPI_PROFILE=single-user + + - name: Wait for NiFi to be ready + run: make wait-ready NIPYAPI_PROFILE=single-user + + - name: Run integration tests + run: NIPYAPI_PROFILE=single-user PYTHONPATH=${{ github.workspace }}:$PYTHONPATH pytest + env: + PYTHONHTTPSVERIFY: "0" + CURL_CA_BUNDLE: "" + REQUESTS_CA_BUNDLE: "" + + - name: Stop NiFi infrastructure + if: always() + run: make down + + test-python-310-single-user: + runs-on: ubuntu-latest + + steps: + - uses: actions/checkout@v4 + + - name: Set up Python 3.10 + uses: actions/setup-python@v4 + with: + python-version: "3.10" + + - name: Install dependencies + run: | + python -m pip install --upgrade pip + pip install -e .[dev] + + - name: Set up Docker Buildx + uses: docker/setup-buildx-action@v3 + + - name: Generate certificates + run: make certs + + - name: Start NiFi infrastructure (single-user) + run: make up NIPYAPI_PROFILE=single-user + + - name: Wait for NiFi to be ready + run: make wait-ready NIPYAPI_PROFILE=single-user + + - name: Run integration tests + run: NIPYAPI_PROFILE=single-user PYTHONPATH=${{ github.workspace }}:$PYTHONPATH pytest + env: + PYTHONHTTPSVERIFY: "0" + CURL_CA_BUNDLE: "" + REQUESTS_CA_BUNDLE: "" + + - name: Stop NiFi infrastructure + if: always() + run: make down + + test-python-39-single-user: + runs-on: ubuntu-latest + + steps: + - uses: actions/checkout@v4 + + - name: Set up Python 3.9 + uses: actions/setup-python@v4 + with: + python-version: "3.9" + + - name: Install dependencies + run: | + python -m pip install --upgrade pip + pip install -e .[dev] + + - name: Set up Docker Buildx + uses: docker/setup-buildx-action@v3 + + - name: Generate certificates + run: make certs + + - name: Start NiFi infrastructure (single-user) + run: make up NIPYAPI_PROFILE=single-user + + - name: Wait for NiFi to be ready + run: make wait-ready NIPYAPI_PROFILE=single-user + + - name: Run integration tests + run: NIPYAPI_PROFILE=single-user PYTHONPATH=${{ github.workspace }}:$PYTHONPATH pytest + env: + PYTHONHTTPSVERIFY: "0" + CURL_CA_BUNDLE: "" + REQUESTS_CA_BUNDLE: "" + + - name: Stop NiFi infrastructure + if: always() + run: make down + + test-python-312-secure-ldap: + runs-on: ubuntu-latest + + steps: + - uses: actions/checkout@v4 + + - name: Set up Python 3.12 + uses: actions/setup-python@v4 + with: + python-version: "3.12" + + - name: Install dependencies + run: | + python -m pip install --upgrade pip + pip install -e .[dev] + + - name: Set up Docker Buildx + uses: docker/setup-buildx-action@v3 + + - name: Generate certificates + run: make certs + + - name: Start NiFi infrastructure (secure-ldap) + run: make up NIPYAPI_PROFILE=secure-ldap + + - name: Wait for containers to stabilize + run: sleep 5 && docker ps -a + + - name: Debug SSL environment + run: | + python -c "import ssl; print('OpenSSL version:', ssl.OPENSSL_VERSION)" + python -c "import ssl; print('SSL context flags:', ssl.create_default_context().verify_flags)" + + - name: Debug environment variables + run: | + echo "=== Environment Variables ===" + echo "NIFI_VERIFY_SSL: ${NIFI_VERIFY_SSL:-unset}" + echo "REGISTRY_VERIFY_SSL: ${REGISTRY_VERIFY_SSL:-unset}" + echo "NIPYAPI_CHECK_HOSTNAME: ${NIPYAPI_CHECK_HOSTNAME:-unset}" + echo "=== Testing getenv_bool parsing ===" + python -c " + import os + os.environ['NIFI_VERIFY_SSL'] = '0' + os.environ['REGISTRY_VERIFY_SSL'] = '0' + os.environ['NIPYAPI_CHECK_HOSTNAME'] = '0' + import nipyapi + print('NIFI_VERIFY_SSL via getenv_bool:', nipyapi.utils.getenv_bool('NIFI_VERIFY_SSL')) + print('REGISTRY_VERIFY_SSL via getenv_bool:', nipyapi.utils.getenv_bool('REGISTRY_VERIFY_SSL')) + print('NIPYAPI_CHECK_HOSTNAME via getenv_bool:', nipyapi.utils.getenv_bool('NIPYAPI_CHECK_HOSTNAME')) + " + env: + NIFI_VERIFY_SSL: "0" + REGISTRY_VERIFY_SSL: "0" + NIPYAPI_CHECK_HOSTNAME: "0" + + - name: Wait for NiFi to be ready + run: make wait-ready NIPYAPI_PROFILE=secure-ldap + env: + PYTHONHTTPSVERIFY: "0" + CURL_CA_BUNDLE: "" + REQUESTS_CA_BUNDLE: "" + NIFI_VERIFY_SSL: "0" + REGISTRY_VERIFY_SSL: "0" + NIPYAPI_CHECK_HOSTNAME: "0" + + - name: Run integration tests + run: NIPYAPI_PROFILE=secure-ldap PYTHONPATH=${{ github.workspace }}:$PYTHONPATH pytest + env: + PYTHONHTTPSVERIFY: "0" + CURL_CA_BUNDLE: "" + REQUESTS_CA_BUNDLE: "" + NIFI_VERIFY_SSL: "0" + REGISTRY_VERIFY_SSL: "0" + NIPYAPI_CHECK_HOSTNAME: "0" + + - name: Dump running containers and logs on failure + if: failure() + run: | + echo "=== Container Status ===" + docker ps -a + echo "=== Container Logs ===" + for container in $(docker ps -aq); do + echo "--- Logs for container: $container ---" + docker logs "$container" 2>&1 || echo "Failed to get logs for container $container" + echo "" + done + + - name: Stop NiFi infrastructure + if: always() + run: make down + + test-python-312-secure-mtls: + runs-on: ubuntu-latest + + steps: + - uses: actions/checkout@v4 + + - name: Set up Python 3.12 + uses: actions/setup-python@v4 + with: + python-version: "3.12" + + - name: Install dependencies + run: | + python -m pip install --upgrade pip + pip install -e .[dev] + + - name: Set up Docker Buildx + uses: docker/setup-buildx-action@v3 + + - name: Generate certificates + run: make certs + + - name: Start NiFi infrastructure (secure-mtls) + run: make up NIPYAPI_PROFILE=secure-mtls + + - name: Wait for containers to stabilize + run: sleep 5 && docker ps -a + + - name: Debug SSL environment + run: | + python -c "import ssl; print('OpenSSL version:', ssl.OPENSSL_VERSION)" + python -c "import ssl; print('SSL context flags:', ssl.create_default_context().verify_flags)" + + - name: Debug environment variables + run: | + echo "=== Environment Variables ===" + echo "NIFI_VERIFY_SSL: ${NIFI_VERIFY_SSL:-unset}" + echo "REGISTRY_VERIFY_SSL: ${REGISTRY_VERIFY_SSL:-unset}" + echo "NIPYAPI_CHECK_HOSTNAME: ${NIPYAPI_CHECK_HOSTNAME:-unset}" + echo "=== Testing getenv_bool parsing ===" + python -c " + import os + os.environ['NIFI_VERIFY_SSL'] = '0' + os.environ['REGISTRY_VERIFY_SSL'] = '0' + os.environ['NIPYAPI_CHECK_HOSTNAME'] = '0' + import nipyapi + print('NIFI_VERIFY_SSL via getenv_bool:', nipyapi.utils.getenv_bool('NIFI_VERIFY_SSL')) + print('REGISTRY_VERIFY_SSL via getenv_bool:', nipyapi.utils.getenv_bool('REGISTRY_VERIFY_SSL')) + print('NIPYAPI_CHECK_HOSTNAME via getenv_bool:', nipyapi.utils.getenv_bool('NIPYAPI_CHECK_HOSTNAME')) + " + env: + NIFI_VERIFY_SSL: "0" + REGISTRY_VERIFY_SSL: "0" + NIPYAPI_CHECK_HOSTNAME: "0" + + - name: Wait for NiFi to be ready + run: make wait-ready NIPYAPI_PROFILE=secure-mtls + env: + PYTHONHTTPSVERIFY: "0" + CURL_CA_BUNDLE: "" + REQUESTS_CA_BUNDLE: "" + NIFI_VERIFY_SSL: "0" + REGISTRY_VERIFY_SSL: "0" + NIPYAPI_CHECK_HOSTNAME: "0" + + - name: Run integration tests + run: NIPYAPI_PROFILE=secure-mtls PYTHONPATH=${{ github.workspace }}:$PYTHONPATH pytest + env: + PYTHONHTTPSVERIFY: "0" + CURL_CA_BUNDLE: "" + REQUESTS_CA_BUNDLE: "" + NIFI_VERIFY_SSL: "0" + REGISTRY_VERIFY_SSL: "0" + NIPYAPI_CHECK_HOSTNAME: "0" + + - name: Dump running containers and logs on failure + if: failure() + run: | + echo "=== Container Status ===" + docker ps -a + echo "=== Container Logs ===" + for container in $(docker ps -aq); do + echo "--- Logs for container: $container ---" + docker logs "$container" 2>&1 || echo "Failed to get logs for container $container" + echo "" + done + + - name: Stop NiFi infrastructure + if: always() + run: make down diff --git a/.gitignore b/.gitignore index a08bc8af..7c2cd788 100644 --- a/.gitignore +++ b/.gitignore @@ -38,6 +38,22 @@ pip-delete-this-directory.txt # Unit test / coverage reports htmlcov/ + +# NiPyAPI generated cert artifacts (keep script, ignore outputs) +resources/certs/ca/ +resources/certs/nifi/ +resources/certs/registry/ +resources/certs/truststore/ +resources/certs/client/ +resources/certs/*.env + +# Client-gen caches and augmented OpenAPI outputs +resources/client_gen/_cache/ +resources/client_gen/_tmp/ +resources/client_gen/api_defs/*.augmented.json + +# Local scripts/helpers +resources/scripts/__pycache__/ .tox/ .coverage .coverage.* @@ -157,9 +173,18 @@ fabric.properties # Stupid OSX exclusions /.vscode - .DS_Store + # Coverage reports coverage* .coverage htmlcov/ + +# VSCode +*.code-workspace + +# Cursor AI rules (personal AI assistant configuration) +.cursorrules + +# setuptools-scm generated version file +nipyapi/_version.py diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml new file mode 100644 index 00000000..cf567a46 --- /dev/null +++ b/.pre-commit-config.yaml @@ -0,0 +1,47 @@ +# Pre-commit configuration for NiPyAPI +# IMPORTANT: Only runs on core nipyapi/ files, excludes generated API clients +repos: + - repo: https://github.com/pre-commit/pre-commit-hooks + rev: v4.6.0 + hooks: + - id: trailing-whitespace + files: ^nipyapi/.*\.py$ + exclude: ^nipyapi/(nifi|registry|_version\.py) + - id: end-of-file-fixer + files: ^nipyapi/.*\.py$ + exclude: ^nipyapi/(nifi|registry|_version\.py) + - id: debug-statements + files: ^nipyapi/.*\.py$ + exclude: ^nipyapi/(nifi|registry|_version\.py) + + - repo: https://github.com/psf/black + rev: 24.8.0 + hooks: + - id: black + files: ^nipyapi/.*\.py$ + exclude: ^nipyapi/(nifi|registry|_version\.py) + + - repo: https://github.com/pycqa/isort + rev: 5.13.2 + hooks: + - id: isort + files: ^nipyapi/.*\.py$ + exclude: ^nipyapi/(nifi|registry|_version\.py) + + - repo: https://github.com/PyCQA/flake8 + rev: 7.3.0 + hooks: + - id: flake8 + files: ^nipyapi/.*\.py$ + exclude: ^nipyapi/(nifi|registry|_version\.py) + args: [--config=setup.cfg] + + - repo: local + hooks: + - id: pylint-core-only + name: pylint (core nipyapi only) + entry: pylint + language: system + files: ^nipyapi/.*\.py$ + exclude: ^nipyapi/(nifi|registry|_version\.py) + args: [--rcfile=pylintrc] diff --git a/MANIFEST.in b/MANIFEST.in index c1b9b832..59d27808 100644 --- a/MANIFEST.in +++ b/MANIFEST.in @@ -1,12 +1,12 @@ -include docs/authors.rst -include docs/contributing.rst -include docs/history.rst include LICENSE +include NOTICE include README.rst include requirements.txt -include nipyapi/demo/keys/* recursive-include nipyapi * recursive-exclude * *.py[co] -recursive-include docs *.rst conf.py Makefile make.bat +# Prune docs and resources +prune docs +prune resources +prune examples \ No newline at end of file diff --git a/Makefile b/Makefile index 6223a0d5..9daeaec5 100644 --- a/Makefile +++ b/Makefile @@ -1,5 +1,20 @@ -.PHONY: clean clean-test clean-pyc clean-build docs help +.PHONY: clean clean-pyc clean-build docs help .DEFAULT_GOAL := help + +# Default NiFi/Registry version for docker compose profiles +NIFI_VERSION ?= 2.5.0 + +# Python command for cross-platform compatibility +# Defaults to 'python' for conda/venv users, override with PYTHON=python3 for system installs +PYTHON ?= python + +# Paths and docker compose helpers (avoid cd by using -f) +COMPOSE_DIR := $(abspath resources/docker) +COMPOSE_FILE := $(COMPOSE_DIR)/compose.yml +# Use a stable project name to avoid noisy warnings about defaulting to 'docker' +COMPOSE_PROJECT_NAME ?= nipyapi +DC := COMPOSE_PROJECT_NAME=$(COMPOSE_PROJECT_NAME) NIFI_VERSION=$(NIFI_VERSION) docker compose -f $(COMPOSE_FILE) + define BROWSER_PYSCRIPT import os, webbrowser, sys try: @@ -14,27 +29,74 @@ export BROWSER_PYSCRIPT define PRINT_HELP_PYSCRIPT import re, sys +current_section = "" +sections = {} + for line in sys.stdin: - match = re.match(r'^([a-zA-Z_-]+):.*?## (.*)$$', line) - if match: - target, help = match.groups() - print("%-20s %s" % (target, help)) + # Check for section headers + section_match = re.match(r'^## (.+) ##$$', line) + if section_match: + current_section = section_match.group(1) + sections[current_section] = [] + continue + + # Check for targets + target_match = re.match(r'^([a-zA-Z_-]+):.*?## (.*)$$', line) + if target_match: + target, help_text = target_match.groups() + if current_section: + sections[current_section].append((target, help_text)) + +# Print sections in order +section_order = ["Operational Targets", "Low-Level Targets", "Meta Targets"] +for section in section_order: + if section in sections: + print(f"\n{section}:") + print("=" * (len(section) + 1)) + for target, help_text in sections[section]: + print(f" {target:<18} {help_text}") + +# Print any remaining sections not in the predefined order +for section, targets in sections.items(): + if section not in section_order: + print(f"\n{section}:") + print("=" * (len(section) + 1)) + for target, help_text in targets: + print(f" {target:<18} {help_text}") endef export PRINT_HELP_PYSCRIPT -BROWSER := python -c "$$BROWSER_PYSCRIPT" +BROWSER := $(PYTHON) -c "$$BROWSER_PYSCRIPT" help: - @python -c "$$PRINT_HELP_PYSCRIPT" < $(MAKEFILE_LIST) + @$(PYTHON) -c "$$PRINT_HELP_PYSCRIPT" < $(MAKEFILE_LIST) + +################################################################################# +## Operational Targets ## +################################################################################# -clean: clean-build clean-pyc clean-test ## remove all build, test, coverage and Python artifacts +clean: clean-build clean-pyc ## remove all build, test, coverage and Python artifacts +clean-all: clean-build clean-pyc openapi-clean ## comprehensive clean: ALL artifacts (build + clients + specs + docs + coverage) + @echo "=== Comprehensive Clean: ALL Artifacts ===" + # Generated clients + rm -rf nipyapi/nifi/apis/* nipyapi/nifi/models/* || true + rm -rf nipyapi/registry/apis/* nipyapi/registry/models/* || true + # Generated documentation + rm -rf docs/nipyapi-docs docs/_build/* || true + # Coverage artifacts + rm -rf htmlcov/ .coverage coverage.xml .pytest_cache || true + # Temporary generation files + rm -rf resources/client_gen/_tmp/* || true + # Auto-generated version file + rm -f nipyapi/_version.py || true + @echo "โœ… ALL artifacts removed: build, Python, OpenAPI, clients, docs, coverage, temp files." clean-build: ## remove build artifacts rm -fr build/ rm -fr dist/ rm -fr .eggs/ find . -name '*.egg-info' -exec rm -fr {} + - find . -name '*.egg' -exec rm -fr {} + + find . -name '*.egg' -exec rm -f {} + clean-pyc: ## remove Python file artifacts find . -name '*.pyc' -exec rm -f {} + @@ -42,46 +104,223 @@ clean-pyc: ## remove Python file artifacts find . -name '*~' -exec rm -f {} + find . -name '__pycache__' -exec rm -fr {} + -clean-test: ## remove test and coverage artifacts - rm -fr .tox/ - rm -f .coverage - rm -fr htmlcov/ +openapi-clean: ## remove generated augmented/backup OpenAPI artifacts + rm -f resources/client_gen/api_defs/*.augmented.json \ + resources/client_gen/api_defs/*.normalized.backup.json + @echo "Cleaned generated OpenAPI artifacts." + +install: clean ## install the package to the active Python's site-packages + pip install . + +dev-install: ## install dev extras for local development + pip install -e ".[dev]" + +docs-install: ## install docs extras + pip install -e ".[docs]" + +coverage: ensure-certs ## run pytest with coverage and generate report (set coverage-min=NN to enforce; requires infrastructure) + @echo "๐Ÿงช Running coverage analysis (single-user profile)..." + @echo "Ensuring single-user infrastructure is ready..." + $(MAKE) up NIPYAPI_PROFILE=single-user + $(MAKE) wait-ready NIPYAPI_PROFILE=single-user + @echo "Running pytest with coverage..." + NIPYAPI_PROFILE=single-user PYTHONPATH=$(PWD):$$PYTHONPATH pytest --cov=nipyapi --cov-report=term-missing --cov-report=html + @if [ -n "$(coverage-min)" ]; then coverage report --fail-under=$(coverage-min); fi + @echo "โœ… Coverage analysis complete. See htmlcov/index.html for detailed report." + +coverage-upload: coverage ## run coverage and upload to codecov (CI only - requires CODECOV_TOKEN) + @echo "๐Ÿ“ค Uploading coverage to codecov..." + @if [ -z "$$CODECOV_TOKEN" ] && [ -z "$$CI" ]; then \ + echo "โŒ codecov upload requires CODECOV_TOKEN environment variable or CI environment"; \ + echo "๐Ÿ’ก For local development, use 'make coverage' to view reports in htmlcov/index.html"; \ + exit 1; \ + fi + codecov + +lint: ## run all linting checks (flake8 + pylint on core nipyapi files only) + @echo "Running flake8..." + flake8 nipyapi/ --config=setup.cfg --exclude=nipyapi/nifi,nipyapi/registry,nipyapi/_version.py + @echo "Running pylint..." + pylint nipyapi/ --rcfile=pylintrc --ignore=nifi,registry,_version.py + @echo "โœ… All linting checks passed" + +flake8: ## run flake8 linter on core nipyapi files + flake8 nipyapi/ --config=setup.cfg --exclude=nipyapi/nifi,nipyapi/registry,nipyapi/_version.py + +pylint: ## run pylint on core nipyapi files + pylint nipyapi/ --rcfile=pylintrc --ignore=nifi,registry,_version.py + +pre-commit: ## run pre-commit hooks on all files + pre-commit run --all-files + +################################################################################# +## Low-Level Targets ## +################################################################################# + +# Dependency checking functions +check-certs: + @test -f resources/certs/certs.env || \ + (echo "โŒ Certificates missing. Run: make certs" && exit 1) -lint: ## check style with flake8 - flake8 nipyapi tests +ensure-certs: ## generate certificates only if they don't already exist + @if [ ! -f resources/certs/certs.env ]; then \ + echo "๐Ÿ“ Certificates not found - generating fresh certificates..."; \ + $(MAKE) certs; \ + else \ + echo "โœ… Certificates already exist - skipping generation"; \ + fi -test: ## run tests quickly with the default Python - py.test +check-infra: + @$(DC) ps -q 2>/dev/null | grep -q . || \ + (echo "โŒ Infrastructure not running. Run: make up NIPYAPI_PROFILE=" && exit 1) +# Infrastructure operations +certs: ## generate PKCS12 certs and env for docker profiles + @if $(DC) ps -q 2>/dev/null | grep -q .; then \ + echo "โš ๏ธ Active containers detected - stopping before certificate regeneration..."; \ + $(MAKE) down; \ + echo ""; \ + fi + cd resources/certs && bash gen_certs.sh + @echo "โœ… Fresh certificates generated - containers will use new certs on next startup" -test-all: ## run tests on every Python version with tox - tox +up: ## bring up docker profile: make up NIPYAPI_PROFILE=single-user|secure-ldap|secure-mtls|secure-oidc (uses NIFI_VERSION=$(NIFI_VERSION)) + @if [ -z "$(NIPYAPI_PROFILE)" ]; then echo "NIPYAPI_PROFILE is required (single-user|secure-ldap|secure-mtls|secure-oidc)"; exit 1; fi + $(DC) --profile $(NIPYAPI_PROFILE) up -d -coverage: ## check code coverage quickly with the default Python - coverage run --source nipyapi -m pytest - coverage report -m - coverage html - $(BROWSER) htmlcov/index.html +down: ## bring down all docker services + @echo "Bringing down Docker services (NIFI_VERSION=$(NIFI_VERSION))" + @$(DC) --profile single-user --profile secure-ldap --profile secure-mtls --profile secure-oidc down -v --remove-orphans || true + @echo "Verifying expected containers are stopped/removed:" + @COMPOSE_PROJECT_NAME=$(COMPOSE_PROJECT_NAME) NIFI_VERSION=$(NIFI_VERSION) docker compose -f $(COMPOSE_FILE) ps --format "table {{.Name}}\t{{.State}}" | tail -n +2 | awk '{print " - " $$1 ": " $$2}' || true -docs: ## generate Sphinx HTML documentation, including API docs - rm -f docs/nipyapi.rst - rm -f docs/modules.rst - sphinx-apidoc -o docs/ nipyapi +wait-ready: ## wait for readiness using profile configuration; requires NIPYAPI_PROFILE=single-user|secure-ldap|secure-mtls|secure-oidc + @if [ -z "$(NIPYAPI_PROFILE)" ]; then echo "โŒ NIPYAPI_PROFILE is required"; exit 1; fi + @echo "โณ Waiting for $(NIPYAPI_PROFILE) infrastructure to be ready..." + @NIPYAPI_PROFILE=$(NIPYAPI_PROFILE) $(PYTHON) resources/scripts/wait_ready.py + +# API & Client generation +fetch-openapi-base: ## refresh base OpenAPI specs for current NIFI_VERSION (always overwrite base) + @echo "Refreshing base specs for NIFI_VERSION=$(NIFI_VERSION)" + bash resources/client_gen/fetch_nifi_openapi.sh nifi-single || exit 1 + bash resources/client_gen/fetch_registry_openapi.sh registry-single || exit 1 + @echo "Base specs refreshed." + +augment-openapi: ## generate augmented OpenAPI specs from base (always overwrite augmented) + @echo "Generating augmented specs for NIFI_VERSION=$(NIFI_VERSION)" + rm -f resources/client_gen/api_defs/nifi-$(NIFI_VERSION).augmented.json \ + resources/client_gen/api_defs/registry-$(NIFI_VERSION).augmented.json + bash resources/client_gen/apply_augmentations.sh nifi \ + resources/client_gen/api_defs/nifi-$(NIFI_VERSION).json \ + resources/client_gen/api_defs/nifi-$(NIFI_VERSION).augmented.json + bash resources/client_gen/apply_augmentations.sh registry \ + resources/client_gen/api_defs/registry-$(NIFI_VERSION).json \ + resources/client_gen/api_defs/registry-$(NIFI_VERSION).augmented.json + @echo "Augmented specs generated." + +fetch-openapi: fetch-openapi-base augment-openapi ## convenience: fetch base then augment + +gen-clients: ## generate NiFi and Registry clients from specs (use wv_spec_variant=augmented|base) + WV_SPEC_VARIANT=augmented bash resources/client_gen/generate_api_client.sh + +# Individual testing + +test: ## run pytest with provided NIPYAPI_PROFILE; config resolved by tests/conftest.py + @if [ -z "$(NIPYAPI_PROFILE)" ]; then echo "NIPYAPI_PROFILE is required (single-user|secure-ldap|secure-mtls|secure-oidc)"; exit 1; fi; \ + NIPYAPI_PROFILE=$(NIPYAPI_PROFILE) PYTHONPATH=$(PWD):$$PYTHONPATH pytest -q + +test-su: ## shortcut: NIPYAPI_PROFILE=single-user pytest + NIPYAPI_PROFILE=single-user $(MAKE) test + +test-ldap: ## shortcut: NIPYAPI_PROFILE=secure-ldap pytest + NIPYAPI_PROFILE=secure-ldap $(MAKE) test + +test-mtls: ## shortcut: NIPYAPI_PROFILE=secure-mtls pytest + NIPYAPI_PROFILE=secure-mtls $(MAKE) test + +test-oidc: check-certs ## shortcut: NIPYAPI_PROFILE=secure-oidc pytest (requires: make sandbox NIPYAPI_PROFILE=secure-oidc) + NIPYAPI_PROFILE=secure-oidc $(MAKE) test + +test-specific: ## run specific pytest with provided NIPYAPI_PROFILE and TEST_ARGS + @if [ -z "$(NIPYAPI_PROFILE)" ]; then echo "NIPYAPI_PROFILE is required (single-user|secure-ldap|secure-mtls|secure-oidc)"; exit 1; fi; \ + if [ -z "$(TEST_ARGS)" ]; then echo "TEST_ARGS is required (e.g., tests/test_utils.py::test_dump -v)"; exit 1; fi; \ + NIPYAPI_PROFILE=$(NIPYAPI_PROFILE) PYTHONPATH=$(PWD):$$PYTHONPATH pytest -q $(TEST_ARGS) + + +# Build & Documentation +dist: clean ## builds source and wheel package using modern build system + $(PYTHON) -m build + +wheel: clean ## builds wheel package only + $(PYTHON) -m build --wheel + +sdist: clean ## builds source distribution only + $(PYTHON) -m build --sdist + +check-dist: dist ## validate distribution files + $(PYTHON) -m twine check dist/* + +test-dist: dist ## test that built distribution can be imported and used + $(PYTHON) resources/scripts/test_distribution.py + +docs: ## generate Sphinx HTML documentation with improved navigation + $(PYTHON) docs/scripts/generate_structured_docs.py $(MAKE) -C docs clean $(MAKE) -C docs html - $(BROWSER) docs/_build/html/index.html + @echo "" + @echo "Documentation built. Open: docs/_build/html/index.html" -servedocs: docs ## compile the docs watching for changes - watchmedo shell-command -p '*.rst' -c '$(MAKE) -C docs html' -R -D . -release: clean ## package and upload a release - python setup.py sdist upload - python setup.py bdist_wheel upload +################################################################################# +## Meta Targets ## +################################################################################# -dist: clean ## builds source and wheel package - python setup.py sdist - python setup.py bdist_wheel - ls -l dist +test-all: ensure-certs ## run full e2e tests across automated profiles (requires: make certs) + @echo "Running full e2e tests across automated profiles..." + @for profile in single-user secure-ldap secure-mtls; do \ + echo "=== Running e2e test for profile: $$profile ==="; \ + $(MAKE) up NIPYAPI_PROFILE=$$profile && \ + $(MAKE) wait-ready NIPYAPI_PROFILE=$$profile && \ + $(MAKE) test NIPYAPI_PROFILE=$$profile; \ + test_result=$$?; \ + if [ $$test_result -ne 0 ]; then \ + echo "Tests failed for profile: $$profile"; \ + exit $$test_result; \ + fi; \ + done + @echo "โœ… All profiles tested successfully" -install: clean ## install the package to the active Python's site-packages - python setup.py install +sandbox: ensure-certs ## create isolated environment with sample objects: make sandbox NIPYAPI_PROFILE=single-user|secure-ldap|secure-mtls|secure-oidc + @if [ -z "$(NIPYAPI_PROFILE)" ]; then echo "โŒ NIPYAPI_PROFILE is required (single-user|secure-ldap|secure-mtls|secure-oidc)"; exit 1; fi + @echo "๐Ÿ—๏ธ Setting up NiPyAPI sandbox with profile: $(NIPYAPI_PROFILE)" + @echo "=== 1/4: Starting infrastructure ===" + $(MAKE) up NIPYAPI_PROFILE=$(NIPYAPI_PROFILE) + @echo "=== 2/4: Waiting for readiness ===" + $(MAKE) wait-ready NIPYAPI_PROFILE=$(NIPYAPI_PROFILE) + @echo "=== 3/4: Setting up authentication and sample objects ===" + @NIPYAPI_PROFILE=$(NIPYAPI_PROFILE) $(PYTHON) examples/sandbox.py $(NIPYAPI_PROFILE) + +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 "=== 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 + @echo "=== 4/9: Augment OpenAPI Specs ===" + $(MAKE) augment-openapi + @echo "=== 5/9: Generate Fresh Clients ===" + $(MAKE) gen-clients + @echo "=== 6/9: Test All Profiles with Fresh Clients ===" + $(MAKE) test-all + @echo "=== 7/9: Build Distribution Packages ===" + $(MAKE) dist + @echo "=== 8/9: Validate Distribution Packages ===" + $(MAKE) check-dist + $(MAKE) test-dist + @echo "=== 9/9: Generate Documentation ===" + $(MAKE) docs + @echo "โœ… Comprehensive rebuild completed successfully!" diff --git a/README.rst b/README.rst index d0ece809..bf9fcfd3 100644 --- a/README.rst +++ b/README.rst @@ -15,14 +15,14 @@ Nifi-Python-Api: A rich Apache NiFi Python Client SDK :target: https://nipyapi.readthedocs.io/en/latest/?badge=latest :alt: Documentation Status +.. image:: https://codecov.io/gh/Chaffelson/nipyapi/branch/NiFi2x/graph/badge.svg + :target: https://codecov.io/gh/Chaffelson/nipyapi + :alt: Coverage Status + .. image:: https://pyup.io/repos/github/Chaffelson/nipyapi/shield.svg :target: https://pyup.io/repos/github/Chaffelson/nipyapi/ :alt: Python Updates -.. image:: https://coveralls.io/repos/github/Chaffelson/nipyapi/badge.svg?branch=main - :target: https://coveralls.io/github/Chaffelson/nipyapi?branch=main&service=github - :alt: test coverage - .. image:: https://img.shields.io/badge/License-Apache%202.0-blue.svg :target: https://opensource.org/licenses/Apache-2.0 :alt: License @@ -32,19 +32,20 @@ Features -------- **Three layers of Python support for working with Apache NiFi:** - - High-level Demos and example scripts + - Top-level examples (see `examples directory `_ with usage guide) - Mid-level Client SDK for typical complex tasks - Low-level Client SDKs for the full API implementation of NiFi and selected sub-projects **Functionality Highlights:** - - Detailed documentation of the full SDK at all levels - - CRUD wrappers for common task areas like Processor Groups, Processors, Templates, Registry Clients, Registry Buckets, Registry Flows, etc. - - Convenience functions for inventory tasks, such as recursively retrieving the entire canvas, or a flat list of all Process Groups - - Support for scheduling and purging flows, controller services, and connections - - Support for fetching and updating Variable Registries - - Support for import/export of Versioned Flows from NiFi-Registry - - Docker Compose configurations for testing and deployment - - A scripted deployment of an interactive environment, and a secured configuration, for testing and demonstration purposes + - **Profiles System**: One-command environment switching with ``nipyapi.profiles.switch('single-user')`` (see `profiles documentation `_) + - **Modern Authentication**: Built-in support for Basic Auth, mTLS, OIDC/OAuth2, and LDAP + - **Environment Management**: YAML/JSON configuration with environment variable overrides + - **Detailed documentation** of the full SDK at all levels + - **CRUD wrappers** for common task areas like Processor Groups, Processors, Clients, Buckets, Flows, etc. + - **Convenience functions** for inventory tasks, such as recursively retrieving the entire canvas, or a flat list of all Process Groups + - **Support for scheduling and purging** flows, controller services, and connections + - **Support for import/export** of Versioned Flows from various sources + - **Integrated Docker workflow** with Makefile automation and profile-based testing Please see the `issue `_ register for more information on current development. @@ -52,64 +53,147 @@ Please see the `issue `_ register Quick Start ----------- -| There are several scripts to produce demo environments in *nipyapi.demo.** -| The mid-level functionality is in *nipyapi.canvas / nipyapi.security / nipyapi.templates / nipyapi.versioning* +| The mid-level functionality is in *nipyapi.canvas / nipyapi.security / nipyapi.parameters / nipyapi.versioning* | You can access the entire API using the low-level SDKs in *nipyapi.nifi / nipyapi.registry* -The easiest way to install NiPyApi is with pip:: +You need a running NiFi instance to connect to. Choose the approach that fits your situation: + +**Path A: Quick Start with Docker (Recommended for New Users)** + +.. Note:: You will need to have Docker Desktop installed and running to use the Docker profiles. + +Use our provided Docker environment for immediate testing:: + + # Clone the repository (includes Docker profiles and Makefile) + git clone https://github.com/Chaffelson/nipyapi.git + cd nipyapi + + # Install NiPyAPI in development mode + pip install -e ".[dev]" + + # Start complete NiFi environment (this may take a few minutes) + make certs && make up NIPYAPI_PROFILE=single-user && make wait-ready NIPYAPI_PROFILE=single-user + + # Test the connection + python3 -c " + import nipyapi + nipyapi.profiles.switch('single-user') + version = nipyapi.system.get_nifi_version_info() + print(f'โœ“ Connected to NiFi {version}') + " + +**Path B: Connect to Your Existing NiFi** + +If you already have NiFi running, install and configure:: + + # Install NiPyAPI + pip install nipyapi + + # Create your own profiles.yml + mkdir -p ~/.nipyapi + cat > ~/.nipyapi/profiles.yml << EOF + my-nifi: + nifi_url: https://your-nifi-host.com/nifi-api + registry_url: http://your-registry-host.com/nifi-registry-api + nifi_user: your_username + nifi_pass: your_password + nifi_verify_ssl: true + EOF + + # Test your custom profile + python3 -c " + import nipyapi + nipyapi.config.default_profiles_file = '~/.nipyapi/profiles.yml' + nipyapi.profiles.switch('my-nifi') + version = nipyapi.system.get_nifi_version_info() + print(f'โœ“ Connected to NiFi {version}') + " + +**Path C: Manual Configuration (Advanced)** + +For advanced use cases without profiles:: - # in bash + # Install NiPyAPI pip install nipyapi - - # or with docker support for demos - pip install nipyapi[demo] -You can set the config for your endpoints in the central config file:: + # Configure in Python code + import nipyapi + from nipyapi import config, utils + + # Configure endpoints + config.nifi_config.host = 'https://your-nifi-host.com/nifi-api' + config.registry_config.host = 'http://your-registry-host.com/nifi-registry-api' + + # Configure authentication + utils.set_endpoint(config.nifi_config.host, ssl=True, login=True, + username='your_username', password='your_password') + +**Next Steps: Start Using NiPyAPI** + +Once your environment is set up, you can start using NiPyAPI:: - # in python import nipyapi - nipyapi.config.nifi_config.host = 'https://localhost:8080/nifi-api' - nipyapi.config.registry_config.host = 'http://localhost:18080/nifi-registry-api' -Then import a module and execute tasks:: + # If using profiles (Paths A or B) + nipyapi.profiles.switch('single-user') # or your custom profile name + + # Basic operations + root_pg_id = nipyapi.canvas.get_root_pg_id() + version = nipyapi.system.get_nifi_version_info() + process_groups = nipyapi.canvas.list_all_process_groups() + + print(f"Connected to NiFi {version}") + print(f"Root Process Group: {root_pg_id}") + print(f"Found {len(process_groups)} process groups") +**Built-in Docker Profiles:** - nipyapi.canvas.get_root_pg_id() - >'4d5dcf9a-015e-1000-097e-e505ed0f7fd2' +When using Path A (Docker), these profiles are available: -You can use the Docker demos to create a secured interactive console showing many features:: +- ``single-user`` - HTTP Basic authentication (easiest to start with) +- ``secure-ldap`` - LDAP authentication over TLS +- ``secure-mtls`` - Mutual TLS certificate authentication +- ``secure-oidc`` - OpenID Connect (OAuth2) authentication - from nipyapi.demo.secured_console import * - from nipyapi.demo.console import * +See ``docs/profiles.rst`` for complete profiles documentation and ``docs/migration.rst`` for upgrading from 0.x. -You can also explore the scripts to get ideas for how NiPyAPi can be used to automate your environment. +**Examples and Advanced Usage:** -Please check out the `Contribution Guide `_ if you are interested in contributing to the feature set. +- **Flow Development Lifecycle**: See ``examples/fdlc.py`` for multi-environment workflow patterns +- **Interactive Sandbox**: Run ``make sandbox NIPYAPI_PROFILE=single-user`` for experimentation (requires Docker setup) +- **Custom Profiles**: Create your own ``profiles.yml`` for production environments +- **Environment Variables**: Override any setting with ``NIFI_API_ENDPOINT``, ``NIFI_USERNAME``, etc. +- **Testing Different Auth Methods**: Use ``make up NIPYAPI_PROFILE=secure-ldap`` to try LDAP authentication + +Please check out the `Contribution Guide `_ if you are interested in contributing to the feature set. Background and Documentation ---------------------------- -| For more information on Apache NiFi, please visit `https://nifi.apache.org `_ -| For Documentation on this package please visit `https://nipyapi.readthedocs.io. `_ +| For more information on **Apache NiFi**, please visit `https://nifi.apache.org `_ +| For **complete NiPyAPI documentation**, please visit `https://nipyapi.readthedocs.io `_ +| For **migration from 0.x to 1.x**, see ``docs/migration.rst`` in the repository +| For **profiles and authentication**, see ``docs/profiles.rst`` and ``docs/security.rst`` NiFi Version Support -------------------- -| Currently we are testing against NiFi versions 1.9.2 - 1.28.1, and NiFi-Registry versions 0.3.0 - 1.28.1. - -| We have also tested against the latest NiFi-2.2.0 release using the 1.x SDK and have found that basic functionality works as expected. -| Apache NiFi offers no compatibility guarantees between major versions, and while many functions may work the same, you should test carefully for your specific use case. -| In future we will create a specific branch of NiPyAPI for NiFi 2.x SDKs, and maintain separate NiFi 1.x and NiFi 2.x clients. - +| **NiPyAPI 1.x targets Apache NiFi 2.x and NiFi Registry 2.x** (tested against 2.5.0). +| **For NiFi 1.x compatibility**, please use NiPyAPI 0.x branch or pin nipyapi < 1.0.0. +| **Breaking changes** exist between 0.x and 1.x - see ``docs/migration.rst`` for upgrade guidance. +| **Docker profiles require Docker Desktop** with sufficient memory (recommend 4GB+ for NiFi). | If you find a version compatibility problem please raise an `issue `_ Python Support -------------- -| Python 3.9-12 supported, though other versions may work. -| Python2 is no longer supported as of the 1.0 release, please use the 0.x branch for Python2 projects. -| OSX M1 chips have had various issues with Requests and Certificates. +| **Python 3.9-12 supported**, though other versions may work. +| **Python2 is no longer supported** as of the NiPyAPI 1.0 release, please use the 0.x branch for Python2 projects. +| OSX M1 chips have been known to have had various issues with Requests and Certificates, as did Python 3.10. -| Tested on AL2023, developed on OSX 14+ and Windows 10 with Docker Desktop. -| Outside of the standard Python modules, we make use of lxml, DeepDiff, ruamel.yaml and xmltodict in processing, and Docker for demo/tests. +| Tests are run against **upstream Apache NiFi and NiFi Registry Docker images** via integrated Makefile automation. +| **Profile-driven testing** supports single-user, LDAP, mTLS, and OIDC authentication modes. +| Developed on **macOS 14+ and Windows 10**. +| **Runtime dependencies**: requests/urllib3, PyYAML, and PySocks. +| **Development tools**: Comprehensive Makefile with ``make up``, ``make test``, ``make sandbox`` targets. diff --git a/docs/apiReference.rst b/docs/apiReference.rst deleted file mode 100644 index c035f6af..00000000 --- a/docs/apiReference.rst +++ /dev/null @@ -1,8 +0,0 @@ -========================= -NiPyApi Package Reference -========================= - -.. toctree:: - :maxdepth: 4 - - nipyapi-docs/nipyapi diff --git a/docs/authors.rst b/docs/authors.rst index 5284b80f..a8203342 100644 --- a/docs/authors.rst +++ b/docs/authors.rst @@ -21,11 +21,11 @@ This package was created with Cookiecutter_ and the `audreyr/cookiecutter-pypack .. _Cookiecutter: https://github.com/audreyr/cookiecutter .. _`audreyr/cookiecutter-pypackage`: https://github.com/audreyr/cookiecutter-pypackage -Inspired by the equivalent Java client maintained over at -`hermannpencole/nifi-config `_ +Inspired by the original Java client written by `Hermann Pencole `_ -The swagger 2.0 compliant client auto-generated using the -`Swagger Codegen `_ project, -and then cleaned / bugfixed by the authors +The client SDKs are generated from OpenAPI definitions using +`swagger-codegen v3 `_, +with repo-maintained mustache templates. Generated code is then reviewed +and refined in this project. Props to the NiFi-dev and NiFi-user mailing list members over at Apache for all the assistance and kindnesses. diff --git a/docs/conf.py b/docs/conf.py index d3726998..d170a742 100755 --- a/docs/conf.py +++ b/docs/conf.py @@ -40,8 +40,13 @@ # Add any Sphinx extension module names here, as strings. They can be # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones. -extensions = ['sphinx.ext.autodoc', 'sphinx.ext.viewcode', - 'sphinx.ext.napoleon'] +extensions = [ + 'sphinx.ext.autodoc', + 'sphinx.ext.linkcode', # Link to GitHub source code + 'sphinx.ext.napoleon', + 'sphinx.ext.intersphinx', # Link to external docs + 'sphinx.ext.autosummary', # Generate summary tables +] # Add any paths that contain templates here, relative to this directory. templates_path = ['_templates'] @@ -57,7 +62,7 @@ # General information about the project. project = u'Nipyapi' -copyright = u"2017, Daniel Chaffelson" +copyright = u"2017-2025, Daniel Chaffelson" # The version info for the project you're documenting, acts as replacement # for |version| and |release|, also used in various other places throughout @@ -119,8 +124,13 @@ # documentation. html_theme_options = { 'collapse_navigation': False, - 'display_version': False, - 'navigation_depth': 3, + 'sticky_navigation': True, + 'navigation_depth': 4, # Increased for better navigation + 'includehidden': True, + 'titles_only': False, + 'prev_next_buttons_location': 'bottom', + 'style_external_links': True, + 'style_nav_header_background': '#004849', # NiFi theme color } # Add any paths that contain custom themes here, relative to this directory. @@ -289,3 +299,100 @@ # M2R no_underscore_emphasis = True m2r_parse_relative_links = True + +# -- Extension Configuration -- + +# Autosummary settings +autosummary_generate = True +autosummary_imported_members = True + +# Autodoc settings +autodoc_default_options = { + 'members': True, + 'undoc-members': True, + 'show-inheritance': True, + 'special-members': '__init__', +} + +# Napoleon settings (Google/NumPy style docstrings) +napoleon_google_docstring = True +napoleon_numpy_docstring = True +napoleon_include_init_with_doc = False +napoleon_include_private_with_doc = False +napoleon_include_special_with_doc = True +napoleon_use_admonition_for_examples = False +napoleon_use_admonition_for_notes = False +napoleon_use_admonition_for_references = False +napoleon_use_ivar = False +napoleon_use_param = True +napoleon_use_rtype = True + +# Intersphinx mapping for external docs +intersphinx_mapping = { + 'python': ('https://docs.python.org/3', None), + 'requests': ('https://requests.readthedocs.io/en/latest/', None), + 'urllib3': ('https://urllib3.readthedocs.io/en/stable/', None), +} + +# -- GitHub source code linking --------------------------------------------- + +def linkcode_resolve(domain, info): + """ + Determine the URL corresponding to Python object. + + This function maps Python objects to their GitHub source URLs. + """ + if domain != 'py': + return None + + modname = info['module'] + fullname = info['fullname'] + + # Only link to nipyapi modules, not external dependencies + if not modname.startswith('nipyapi'): + return None + + # GitHub repository configuration + github_user = 'Chaffelson' + github_repo = 'nipyapi' + github_branch = 'NiFi2x' # Current working branch + + # Build the base GitHub URL + github_url = f"https://github.com/{github_user}/{github_repo}/blob/{github_branch}" + + try: + # Import the module to get file location + import importlib + mod = importlib.import_module(modname) + + # Get the file path + if hasattr(mod, '__file__') and mod.__file__: + # Convert absolute path to relative path from project root + import os + filepath = os.path.relpath(mod.__file__, start=project_root) + + # Normalize path separators for URLs + filepath = filepath.replace(os.sep, '/') + + # Try to get line number for the specific object + if hasattr(mod, fullname.split('.')[-1]): + obj = getattr(mod, fullname.split('.')[-1]) + if hasattr(obj, '__code__'): + lineno = obj.__code__.co_firstlineno + return f"{github_url}/{filepath}#L{lineno}" + elif hasattr(obj, '__init__') and hasattr(obj.__init__, '__code__'): + # For classes, link to __init__ method + lineno = obj.__init__.__code__.co_firstlineno + return f"{github_url}/{filepath}#L{lineno}" + + # Fallback: just link to the file + return f"{github_url}/{filepath}" + + except (ImportError, AttributeError, ValueError): + # Fallback: construct path based on module name + module_path = modname.replace('.', '/') + if not module_path.endswith('.py'): + module_path += '.py' + return f"{github_url}/{module_path}" + + return None diff --git a/docs/contributing.rst b/docs/contributing.rst index 3f5e0008..a65e0b08 100644 --- a/docs/contributing.rst +++ b/docs/contributing.rst @@ -64,11 +64,17 @@ Ready to contribute? Here's how to set up `nipyapi` for local development. $ git clone git@github.com:Chaffelson/nipyapi.git -3. Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development:: +3. Create and activate a Python 3.9+ virtual environment (venv or conda), then install dev extras:: - $ mkvirtualenv nipyapi + # using venv + $ python -m venv .venv && source .venv/bin/activate $ cd nipyapi/ - $ python setup.py develop + $ pip install -e ".[dev]" + + # or using conda + $ conda create -n nipyapi-dev python=3.11 -y + $ conda activate nipyapi-dev + $ pip install -e ".[dev]" 4. Create a branch for local development:: @@ -76,35 +82,35 @@ Ready to contribute? Here's how to set up `nipyapi` for local development. Now you can make your changes locally. -5. You may want to leverage the provided Docker configuration for testing and development +5. You may want to leverage the provided Docker profiles for testing and development - Install the latest version of Docker - - Use the provided Docker Compose configuration in ./resources/docker/latest and run the tests:: - - $ cd resources/docker/latest - $ docker-compose up -d - $ cd ../../../ - $ tox - $ cd resources/docker/latest - $ docker-compose stop + - Use the provided Docker Compose configuration in `resources/docker/compose.yml` and run tests via Makefile:: + # generate local test certificates (run once or after cleanup) + $ make certs -6. You may also want to interactively test your code leveraging the convenience console in the demo package:: + # bring up single-user profile and wait for readiness + $ make up NIPYAPI_PROFILE=single-user + $ make wait-ready NIPYAPI_PROFILE=single-user + # run tests (conftest resolves URLs, credentials, and TLS for the profile) + $ make test + # bring everything down when done + $ make down - $ python - > from nipyapi.demo.console import * -7. When you're done making changes, check that your changes pass the tests, including testing other Python versions, with tox:: +6. When you're done making changes, run the test suites for all profiles:: - $ tox + # convenience shortcuts + $ make test-all -8. Commit your changes and push your branch to GitHub:: +7. Commit your changes and push your branch to GitHub:: $ git add . $ git commit -m "Your detailed description of your changes." $ git push origin name-of-your-bugfix-or-feature -9. Submit a pull request through the GitHub website. +8. Submit a pull request through the GitHub website. Pull Request Guidelines ----------------------- @@ -115,5 +121,6 @@ Before you submit a pull request, check that it meets these guidelines: 2. If the pull request adds functionality, the docs should be updated. Put your new functionality into a function with a docstring, and add the feature to the list in README.rst. -3. The pull request should pass all tox tests, including for security and regression. +3. The pull request should pass lint and all three profile test suites (use `make lint` and `make test-su`, `make test-ldap`, `make test-mtls`). + Exceptions (e.g., docs-only changes) should note why profile tests were skipped. 4. Pull requests should be created against 'main' branch for new features or work with NiFi-2.x, or maint-0.x for critical patches to NiFi-1.x featuers. diff --git a/docs/devnotes.rst b/docs/devnotes.rst index d4048c86..a760f0c6 100644 --- a/docs/devnotes.rst +++ b/docs/devnotes.rst @@ -10,201 +10,216 @@ A collection point for information about the development process for future coll Decision Points --------------- -* Using Swagger 2.0 instead of OpenAPI3.0 as it (currently as of Aug2017) has wider adoption and completed codegen tools +* OpenAPI-based client generation using swagger-codegen v3 (OpenAPI 3.x definitions), with project-specific mustache templates * We use Google style Docstrings to better enable Sphinx to produce nicely readable documentation +* We try to use minimal dependencies, and prefer to use the standard library where possible + +Docker Test Environment +----------------------- + +There is an Apache NiFi image available on Dockerhub:: + + docker pull apache/nifi:latest + +There are a couple of configuration files for launching various Docker environment configurations in resources/docker for convenience. Testing Notes ------------- -When running tests on new code, you are advised to run 'test_default' first, then 'test_regression', then finally 'test_ldap' and/or 'test_mtls'. -Because of the way errors are propagated you may have code failures which cause a teardown which then fails because of security controls, which can then obscure the original error. +When running tests on new code, start with the single-user profile, then test secure profiles: +.. code-block:: shell -Docker Test Environment ------------------------ + # Full test suite with infrastructure setup/teardown (recommended) + make test-all -There is an Apache NiFi image available on Dockerhub:: + # Manual workflow for individual profile testing: + # 1. Set up infrastructure + make certs + make up NIPYAPI_PROFILE=single-user + make wait-ready NIPYAPI_PROFILE=single-user - docker pull apache/nifi:latest + # 2. Run tests (assumes infrastructure is running) + make test NIPYAPI_PROFILE=single-user -There are a couple of configuration files for launching various Docker environment configurations in resources/docker for convenience. + # 3. Clean up + make down + + # Other profiles follow the same pattern: + make up NIPYAPI_PROFILE=secure-ldap && make wait-ready NIPYAPI_PROFILE=secure-ldap + make test NIPYAPI_PROFILE=secure-ldap + make down + +Because of the way errors are propagated, you may have code failures which cause a teardown that then fails because of security controls, which can obscure the original error. Starting with single-user helps isolate functional issues from authentication complexities. -Remote testing on AWS:AL3 with Visual Studio Code on OSX --------------------------------------------------------- - -Instructions:: - - Deploy a t2.xlarge on EC2, preferably with an elastic IP - Add the machine as a remote on Visual Studio Code and Connect - Open up the console and install git so VSCode can clone the repo `sudo dnf install -y git` - Use the VSCode Source Control plugin to clone nipyapi https://github.com/Chaffelson/nipyapi.git - You can then open these notes in VSCode with the terminal for easy execution - Now install dependencies `sudo dnf install -y docker && sudo dnf groupinstall "Development Tools" -y` - Now ensure docker starts with the OS and gives your user access `sudo systemctl start docker && sudo systemctl enable docker && sudo usermod -a -G docker $USER` - Restart your terminal, or run `newgrp docker` to get Docker access permissions active - Install Pip `sudo dnf install python3-pip -y` - Instal docker compose `sudo curl -L "https://github.com/docker/compose/releases/download/v2.26.1/docker-compose-$(uname -s)-$(uname -m)" -o /usr/local/bin/docker-compose` - I recommend you install PyEnv to manage Python versions `sudo curl https://pyenv.run | bash` - Follow the instructions to set up your .bashrc - To build various versions of Python for testing you may also need `sudo dnf install bzip2-devel openssl-devel libffi-devel zlib-devel readline-devel sqlite-devel -y` - Install the latest supported version of Python for your main dev environment `pyenv install 3.9 2.7 3.12` - Set these versions as global in pyenv so tox can see them. Use the actual versions with the command `pyenv global 3.9.16 2.7.18 3.12.2` - You'll want to stand up the two sets of NiFi containers for testing. resources/docker/tox-full for default and regression tests, and resources/docker/secure for tests under auth. - You can switch between the tests by changing flags in tests/conftest.py around line 17. - Python3 can be tested automatically using Tox. - Python2 can be tested using the following steps within a Python2 virtualenv: - 1. Install requirements: pip install -r requirements.txt - 2. Install dev requirements: `pip install -r requirements_dev.txt` - 3. Install package in editable mode with test support: `pip install -e .[test]` - 4. Run tests: `pytest -v -s tests --tb=long -W ignore::urllib3.exceptions.InsecureRequestWarning` Setup Code Signing ------------------ -If you want to sign and push code from your EC2 instance, you'll need to set up code signing. -Ensuring security of your keys is important, so please protect them with a good secret passphrase +**Signed commits are required for all pull requests.** This ensures commit authenticity and maintains project security. + +For OS-specific GPG setup instructions, see the `GitHub documentation on commit signature verification `_. + +**Setup for macOS**:: + + # Install GPG via Homebrew (recommended) + brew install gnupg -Instructions:: + # Alternative: Install GPG Suite (GUI option) + # Download from https://gpgtools.org/ - On your AL2023 instance, replace the default minimal gnupg package with the full one `sudo dnf install --allowerasing gnupg2-full` - Generate signing keys `gpg --full-generate-key` - Use the long key ID as your signingkey `git config --global user.signingkey ` + # Generate signing keys (use a strong passphrase) + gpg --full-generate-key + + # Configure git to use GPG signing + git config --global user.signingkey git config --global commit.gpgsign true - Add the tty setting for gpg to your ~/.bashrc `export GPG_TTY=$(tty)` -Remote Testing on Centos7 -------------------------- + # Add GPG TTY setting to shell profile + echo 'export GPG_TTY=$(tty)' >> ~/.zshrc + source ~/.zshrc -**Deprecated. Instructions kept for legacy reference.** +**For other operating systems:** -Deploy a 4x16 or better on EC2 running Centos 7.5 or better, ssh in as root:: +- **Ubuntu/Debian**: ``sudo apt install gnupg`` +- **Windows**: Use Git for Windows with GPG4Win or WSL - yum-config-manager --add-repo https://download.docker.com/linux/centos/docker-ce.repo - yum update -y - yum install -y centos-release-scl yum-utils device-mapper-persistent-data lvm2 - yum install -y rh-python36 docker-ce docker-ce-cli containerd.io - systemctl start docker - scl enable rh-python36 bash - sudo curl -L "https://github.com/docker/compose/releases/download/1.25.0/docker-compose-$(uname -s)-$(uname -m)" -o /usr/local/bin/docker-compose - sudo chmod +x /usr/local/bin/docker-compose - sudo ln -s /usr/local/bin/docker-compose /usr/bin/docker-compose +Ensure your GPG public key is added to your GitHub account under Settings โ†’ SSH and GPG keys. -Set up remote execution environment to this server from your IDE, such as PyCharm. -Python3 will be in a path like /opt/rh/rh-python36/root/usr/bin/python -These commands are conveniently presented in /resources/test_setup/setup_centos7.sh -You will then want to open up /home/centos/tmp//resources/docker/tox-full and run:: +Generate API Clients +--------------------- - docker-compose pull - docker-compose up -d +NiPyAPI uses automated client generation from OpenAPI 3.x specifications. The process is streamlined through Make targets and shell scripts in ``resources/client_gen/``. -Testing on OSX --------------- +Prerequisites +~~~~~~~~~~~~~ -There is a known issue with testing newer versions of Python on OSX. -You may receive an error reporting [SSL: CERTIFICATE_VERIFY_FAILED] when trying to install packages from Pypi +- Java 17+ (for swagger-codegen-cli) +- Running NiFi/Registry instances to fetch current OpenAPI specs from -You can fix this by running the following commands:: +Client Generation Workflow +~~~~~~~~~~~~~~~~~~~~~~~~~~~ - export PIP_REQUIRE_VIRTUALENV=false - /Applications/Python\ 3.6/Install\ Certificates.command +The complete client regeneration process: -Generate Swagger Client ------------------------ +.. code-block:: shell -The NiFi and NiFi Registry REST API clients are generated using swagger-codegen, which is available via a variety of methods: + # Full regeneration (clean -> certs -> infra -> fetch specs -> generate clients) + make rebuild-all -- the package manager for your OS -- github: https://github.com/swagger-api/swagger-codegen -- maven: https://repo1.maven.org/maven2/io/swagger/swagger-codegen-cli/2.3.1/swagger-codegen-cli-2.4.41.jar -- pre-built Docker images on DockerHub (https://hub.docker.com/r/swaggerapi/swagger-codegen-cli/) + # Individual steps for targeted updates: -In the examples below, we'll use Homebrew for macOS:: + # 1. Start NiFi infrastructure (single-user sufficient for spec extraction) + make certs + make up NIPYAPI_PROFILE=single-user && make wait-ready NIPYAPI_PROFILE=single-user - brew install swagger-codegen + # 2. Extract OpenAPI specifications from running instances + make fetch-openapi -NiFi Swagger Client -~~~~~~~~~~~~~~~~~~~ + # 3. Apply authentication augmentations (temporary workaround until upstream fixes) + make augment-openapi -1. build relevant version of NiFi from source -2. use swagger-codegen to generate the Python client:: + # 4. Generate Python clients using swagger-codegen + custom templates + make gen-clients - mkdir -p ~/tmp && \ - echo '{ "packageName": "nifi" }' > ~/tmp/swagger-nifi-python-config.json && \ - rm -rf ~/tmp/nifi-python-client && \ - swagger-codegen generate \ - --lang python \ - --config swagger-nifi-python-config.json \ - --api-package apis \ - --model-package models \ - --template-dir /path/to/nipyapi/swagger_templates \ - --input-spec /path/to/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/target/swagger-ui/swagger.json \ - --output ~/tmp/nifi-python-client + # 5. Test generated clients + make test-all -3. replace the embedded clients:: + # 6. Clean up infrastructure + make down - rm -rf /path/to/nipyapi/nipyapi/nifi && cp -rf ~/tmp/nifi-python-client/nifi /path/to/nipyapi/nipyapi/nifi +Customization +~~~~~~~~~~~~~ -4. review the changes and submit a PR! +- **Templates**: Custom Mustache templates in ``resources/client_gen/swagger_templates/`` control generated code formatting +- **Augmentations**: Scripts in ``resources/client_gen/augmentations/`` modify OpenAPI specs before generation (e.g., add missing authentication schemes) +- **Configuration**: Client generation controlled by ``resources/client_gen/generate_api_client.sh`` -NiFi Registry Swagger Client -~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +The generated clients replace the existing ``nipyapi/nifi/`` and ``nipyapi/registry/`` packages. Always test thoroughly after regeneration and commit the changes as a cohesive unit. -1. Fetch the definition from a running Registry instance at URI: /nifi-registry-api/swagger/swagger.json -2. use swagger-codegen to generate the Python client:: - mkdir -p ~/tmp && \ - echo '{ "packageName": "registry" }' > ~/tmp/swagger-registry-python-config.json && \ - rm -rf ~/tmp/nifi-registry-python-client && \ - swagger-codegen generate \ - --lang python \ - --config swagger-registry-python-config.json \ - --api-package apis \ - --model-package models \ - --template-dir /path/to/nipyapi/swagger_templates \ - --input-spec /path/to/nifi-registry/nifi-registry-web-api/target/swagger-ui/swagger.json \ - --output ~/tmp/nifi-registry-python-client +Release Process +--------------- -3. replace the embedded clients:: +Streamlined release workflow using our modern build system. Assumes development environment is set up (``make dev-install`` completed). - rm -r /path/to/nipyapi/nipyapi/registry && cp -rf /tmp/nifi-registry-python-client/swagger_client /path/to/nipyapi/nipyapi/registry +Pre-release Preparation +~~~~~~~~~~~~~~~~~~~~~~~ -4. review the changes and submit a PR! +1. **Update Release Notes**: + Update ``docs/history.rst`` with comprehensive release notes including new features, breaking changes, bug fixes, and migration guidance. +2. **Validate Project State**: -Release Process ---------------- + .. code-block:: shell -This assumes you have virtualenvwrapper, git, and appropriate python versions installed, as well as the necessary test environment: - -- update History.rst -- check setup.py -- check requirements.txt and requirements_dev.txt -- Commit all changes -- in bash:: - - cd ProjectDir - source ./my_virtualenv/bin/activate - bumpversion patch|minor|major - python setup.py develop - tox - python setup.py test - Run `make html` in the docs subdir - # check docs in build/sphinx/html/index.html - python setup.py sdist bdist_wheel - mktmpenv # or pyenv virtualenvwrapper mktmpenv if using pyenv - pip install path/to/nipyapi-0.3.1-py2.py3-none-any.whl # for example - # Run appropriate tests, such as usage tests etc. - deactivate - Push changes to Github - Check dockerhub automated build - # You may have to reactivate your original virtualenv - twine upload dist/* - # You may get a file exists error, check you're not trying to reupload an existing version + # Ensure clean working directory + git status + + # Full rebuild: clean -> certs -> specs -> client generation -> tests -> build -> validate -> docs + make rebuild-all + +3. **Commit Release Preparation**: + + .. code-block:: shell + + git add docs/history.rst + git commit -S -m "Prepare release: update history and documentation" + +Build and Quality Assurance +~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +.. code-block:: shell + + # Build fresh distributions for release (rebuild-all already validated them) + make clean-all + make dist + +Create Release +~~~~~~~~~~~~~~ + +.. code-block:: shell + + # Tag the release (triggers version detection via setuptools-scm) + git tag -a -s v1.0.0 -m "Release 1.0.0" + + # Push commit and tags to GitHub (triggers CI validation) + git push origin main git push --tags -- check docs on ReadTheDocs -- check release published on Github and PyPi +Publish to PyPI +~~~~~~~~~~~~~~~ + +.. code-block:: shell + + # Upload to PyPI (requires PyPI API token configured) + twine upload dist/* + + # Alternative: Upload to TestPyPI first for validation + # twine upload --repository testpypi dist/* + +Post-release Verification +~~~~~~~~~~~~~~~~~~~~~~~~~ + +1. **GitHub**: Verify release appears in GitHub Releases page +2. **PyPI**: Check package page, metadata, and download links +3. **Documentation**: Confirm ReadTheDocs rebuild triggered and succeeded +4. **Installation Test**: + + .. code-block:: shell + + # Test installation in clean environment + pip install nipyapi=={version} + python -c "import nipyapi; print(nipyapi.__version__)" + +Version Management Notes +~~~~~~~~~~~~~~~~~~~~~~~~ + +- **Automatic Versioning**: ``setuptools-scm`` generates versions from git tags and commits +- **Development Versions**: Commits after tags get ``.devN+gHASH`` suffix automatically +- **Release Versions**: Clean git tags (e.g., ``v1.0.0``) produce clean versions (``1.0.0``) +- **Pre-releases**: Use tag patterns like ``v1.0.0rc1`` for release candidates diff --git a/docs/history.rst b/docs/history.rst index 059d7c42..9a50e42e 100644 --- a/docs/history.rst +++ b/docs/history.rst @@ -2,6 +2,53 @@ History ======= +1.0 (2025-08-23) +------------------- + +| Major migration to Apache NiFi/Registry 2.x (tested against 2.5.0). Drops 1.x support on main. + +**Breaking Changes - Action Required** + +- **Function renaming**: Upstream API specification changes result in operation IDs now using suffixed names (e.g., ``update_run_status1``) and some other functions are also renamed +- **Authentication and configuration overhaul**: Significant changes to align with modern API standards and upstream API changes +- **Users must review and update authentication patterns** - legacy configuration methods will be different + +**Profile Management System** + +- **Extensible file format** (YAML/JSON) with **environment variable overrides** and **sane defaults** - familiar workflow like AWS CLI +- Intelligent authentication method detection: OIDC, mTLS, and Basic authentication based on available configuration parameters +- Built-in profiles for common deployment patterns: ``single-user``, ``secure-ldap``, ``secure-mtls``, ``secure-oidc`` +- 15+ configurable parameters (URLs, credentials, certificates, SSL settings) with ``NIPYAPI_PROFILE`` environment variable +- Profile switching with ``nipyapi.profiles.switch()`` configures endpoints, authentication, and SSL settings in single function call + +**Automated Development Workflow** + +- **Comprehensive Makefile targets** for all key development and release processes +- **End-to-end automation**: entire client generation and testing sequence from test certificates to final integration tests +- **GitHub Actions CI** with full Docker NiFi integration tests and coverage reporting +- Smart certificate regeneration and optimized rebuild flows to avoid unnecessary infrastructure cycling + +**Quick Start and Migration Tools** + +- **Sandbox Docker environment** for testing different authentication mechanisms with ``make sandbox`` target +- **FDLC example retained** and modernized to demonstrate proper multi-environment workflows (single-user dev, secure-ldap prod) +- **Comprehensive migration guide** (``docs/migration.rst``) for upgrading from NiPyAPI 0.x/NiFi 1.x to 1.x/2.x + +**Core Technical Improvements** + +- **Documentation system rebuild**: Complete Sphinx overhaul with individual pages for all Core client, NiFi APIs and Registry APIs - with a flat API structure with optimal navigation +- **Test coverage expansion**: Comprehensive test suite with profile-driven automation rather than manual reconfiguration +- **Pre-commit checks**: Automated code quality with trailing whitespace, debug statements, flake8, and pylint hooks +- **Modern dependency management**: Migrated to ``python -m build``, replaced ruamel.yaml with PyYAML, explicit urllib3/certifi/requests inclusion +- **Enhanced documentation**: Direct GitHub source code links with line-level precision, standardized docstrings throughout generated clients +- **Profile-driven testing**: Deprecated complex tox regression suite in favor of spec-driven single version testing +- **Legacy pruning**: Removed Python 2.7 and NiFi 1.x references, deprecated template-era dependencies (lxml, xmltodict) +- **Codecov migration**: Switched from Coveralls with pytest-cov integration and build process automation +- **Enhanced convenience functions**: Improved ``set_endpoint`` and various ``ensure_*`` object functions +- **Certificate handling improvements**: Resolved user complexity with automatic CA certificate setup and validation +- **Extensive authentication documentation**: OIDC setup instructions, Safari keychain guidance, development vs production practices +- **API augmentation system**: Client build-time patching for upstream API issues (currently: enum handling and missing security schemes) + 0.22.0 (2025-03-25) -------------------- @@ -18,9 +65,9 @@ History * issue-360: handle -9 error messages better by @ottobackwards in https://github.com/Chaffelson/nipyapi/pull/361 * Handle plain text response types so json values are correctly returned by @michaelarnauts in https://github.com/Chaffelson/nipyapi/pull/358 * update clients to 1.27.0 by @Chaffelson in https://github.com/Chaffelson/nipyapi/pull/365 -* Simplified the use of setattr in recurse_flow, flatten, and list_all_by_kind methods in nipyapi/canvas.py. -* Added support for key_password in the Configuration class and its usage in nipyapi/nifi/rest.py and nipyapi/registry/rest.py. -* Fixed the method to retrieve HTTP headers in nipyapi/nifi/rest.py and nipyapi/registry/rest.py. +* Simplified the use of setattr in recurse_flow, flatten, and list_all_by_kind methods in nipyapi/canvas.py. +* Added support for key_password in the Configuration class and its usage in nipyapi/nifi/rest.py and nipyapi/registry/rest.py. +* Fixed the method to retrieve HTTP headers in nipyapi/nifi/rest.py and nipyapi/registry/rest.py. * Fixed issue #326 where the latest flow version was not being deployed by default * Updated pylintrc to match more modern python standards * Fixes nipyapi.nifi.ProcessGroupsApi.upload_process_group_with_http_info() incomplete #310 diff --git a/docs/index.rst b/docs/index.rst index d7e7938b..27ee46d4 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -8,8 +8,10 @@ Contents: readme installation - apiReference - todo + profiles + security + migration + nipyapi-docs/api_reference contributing devnotes authors diff --git a/docs/installation.rst b/docs/installation.rst index 68e83462..c3517ddf 100644 --- a/docs/installation.rst +++ b/docs/installation.rst @@ -4,48 +4,160 @@ Installation ============ +Requirements +------------ + +- **Python**: 3.9 or higher +- **Apache NiFi**: 2.0.0 or higher (for target NiFi instances) +- **Apache NiFi Registry**: 2.0.0 or higher (optional, for local versioning features) +- **Docker Desktop**: Optional, for local development and testing with provided profiles -Stable release +Stable Release -------------- -To install Nipyapi, run this command in your terminal: +To install NiPyAPI from PyPI, run this command in your terminal: .. code-block:: console $ pip install nipyapi -This is the preferred method to install Nipyapi, as it will always install the most recent stable release. +This is the preferred method to install NiPyAPI, as it will always install the most recent stable release. -If you don't have `pip`_ installed, this `Python installation guide`_ can guide -you through the process. +If you don't have `pip`_ installed, this `Python installation guide`_ can guide you through the process. .. _pip: https://pip.pypa.io -.. _Python installation guide: http://docs.python-guide.org/en/latest/starting/installation/ +.. _Python installation guide: https://packaging.python.org/tutorials/installing-packages/ +Virtual Environment (Recommended) +---------------------------------- -From sources ------------- +It's recommended to install NiPyAPI in a virtual environment to avoid conflicts: + +.. code-block:: console + + $ python -m venv nipyapi-env + $ source nipyapi-env/bin/activate # On Windows: nipyapi-env\Scripts\activate + $ pip install nipyapi + +Development Installation +------------------------ + +To install NiPyAPI for development or to get the latest features: + +.. code-block:: console + + # Clone the repository + $ git clone https://github.com/Chaffelson/nipyapi.git + $ cd nipyapi -The sources for Nipyapi can be downloaded from the `Github repo`_. + # Install in development mode with all dependencies + $ pip install -e ".[dev,docs]" -You can either clone the public repository: +Or to get the latest development version directly: .. code-block:: console - $ git clone git://github.com/Chaffelson/nipyapi + $ pip install git+https://github.com/Chaffelson/nipyapi.git@main + +From Source Archive +------------------- -Or download the `tarball`_: +You can download and install from a source archive: .. code-block:: console - $ curl -OL https://github.com/Chaffelson/nipyapi/tarball/master + # Download the latest source + $ curl -OL https://github.com/Chaffelson/nipyapi/tarball/main + $ tar -xzf main + $ cd Chaffelson-nipyapi-* + + # Install using pip (recommended) + $ pip install . + + # Or build and install manually + $ python -m build + $ pip install dist/*.whl -Once you have a copy of the source, you can install it with: +Verify Installation +------------------- + +To verify that NiPyAPI is installed correctly: .. code-block:: console - $ python setup.py install + $ python -c "import nipyapi; print(f'NiPyAPI {nipyapi.__version__} installed successfully')" + +Next Steps +---------- + +**Option 1: Quick Test with Docker (Recommended for New Users)** + +If you have Docker Desktop, you can test with our provided environment: + +.. code-block:: console + + # Clone repository for Docker profiles + $ git clone https://github.com/Chaffelson/nipyapi.git + $ cd nipyapi + + # Start test environment + $ make certs && make up NIPYAPI_PROFILE=single-user && make wait-ready NIPYAPI_PROFILE=single-user + +Then test the connection: + +.. code-block:: python + + import nipyapi + + # Use built-in profile (no manual configuration needed) + nipyapi.profiles.switch('single-user') + + # Test connection + try: + version = nipyapi.system.get_nifi_version_info() + print(f"โœ“ Connected to NiFi {version}") + except Exception as e: + print(f"โœ— Connection failed: {e}") + +**Option 2: Connect to Your Existing NiFi** + +If you have NiFi already running, create a custom profile: + +.. code-block:: python + + import nipyapi + + # Create custom profile configuration + custom_config = { + 'nifi_url': 'https://your-nifi.com/nifi-api', # NiFi 2.x typically uses HTTPS + 'nifi_user': 'your_username', + 'nifi_pass': 'your_password', + 'nifi_verify_ssl': True + } + + # Test connection + try: + # Manual configuration (advanced) + nipyapi.config.nifi_config.host = custom_config['nifi_url'] + nipyapi.utils.set_endpoint(custom_config['nifi_url'], ssl=True, login=True, + username=custom_config['nifi_user'], + password=custom_config['nifi_pass']) + + version = nipyapi.system.get_nifi_version_info() + print(f"โœ“ Connected to NiFi {version}") + except Exception as e: + print(f"โœ— Connection failed: {e}") + +**Learn More** + +For complete configuration options and authentication methods: + +- **Profiles System**: See ``docs/profiles.rst`` for centralized configuration management +- **Authentication**: See ``docs/security.rst`` for all supported authentication methods +- **Migration**: See ``docs/migration.rst`` if upgrading from NiPyAPI 0.x +- **Quick Start**: See ``README.rst`` for step-by-step setup instructions + +.. include:: nipyapi-docs/dependencies.rst .. _Github repo: https://github.com/Chaffelson/nipyapi -.. _tarball: https://github.com/Chaffelson/nipyapi/tarball/master diff --git a/docs/migration.rst b/docs/migration.rst new file mode 100644 index 00000000..3007c292 --- /dev/null +++ b/docs/migration.rst @@ -0,0 +1,1009 @@ +=============== +Migration Guide +=============== + +Upgrading from NiPyAPI 0.x/NiFi 1.x to NiPyAPI 1.x/NiFi 2.x +------------------------------------------------------------- + +This guide helps you migrate existing code from NiPyAPI 0.x (targeting Apache NiFi/Registry 1.x) to NiPyAPI 1.x (targeting Apache NiFi/Registry 2.x). + +.. note:: + **Breaking Changes**: This is a major version upgrade with significant breaking changes. + Plan for code updates and testing when migrating. + +.. note:: + **New in 1.x**: The **Profiles System** provides centralized configuration management. + You can use profiles, environment variables, or direct configuration - all approaches work with the same underlying system. + +Version Overview +---------------- + ++------------------+----------------------+----------------------+ +| Component | Old Version (0.x) | New Version (1.x) | ++==================+======================+======================+ +| **NiPyAPI** | 0.x | 1.x | ++------------------+----------------------+----------------------+ +| **Apache NiFi** | 1.x (tested: 1.28.1)| 2.x (tested: 2.5.0) | ++------------------+----------------------+----------------------+ +| **NiFi Registry**| 0.x, 1.x | 2.x (tested: 2.5.0) | ++------------------+----------------------+----------------------+ +| **Python** | 2.7, 3.6+ | 3.9+ | ++------------------+----------------------+----------------------+ + +Understanding Migration Scope +------------------------------ + +.. important:: + **NiPyAPI Migration โ‰  NiFi Flow Migration** + + Upgrading NiPyAPI from 0.x to 1.x **does not automatically migrate your NiFi flows** from NiFi 1.x to 2.x. + These are separate migration processes: + +**What NiPyAPI 1.x Migration Covers:** + +- Python client library compatibility with NiFi 2.x APIs +- Authentication and connection management +- SDK function names and parameters +- Configuration and deployment automation + +**What NiFi Flow Migration Requires Separately:** + +- **Processor Updates**: Many processors have new names, properties, or behaviors in NiFi 2.x +- **Controller Service Changes**: Connection pool configurations, SSL contexts, and service properties +- **Expression Language**: Some expression language functions and syntax have changed +- **Flow Structure**: Deprecated components need replacement with 2.x equivalents +- **Property Validation**: New validation rules and required properties +- **Deprecations**: Variable Registry and Templates are deprecated, use Parameters and Git versioning instead. + +**How NiPyAPI 1.x Can Help Your Flow Migration:** + +NiPyAPI 1.x provides powerful automation tools for flow migration tasks: + +- **Flow Analysis**: Inventory processors, controller services, and configurations across environments +- **Bulk Updates**: Programmatically update processor properties and relationships +- **Version Control**: Export, modify, and import flows through NiFi Registry +- **Environment Promotion**: Move updated flows between development, staging, and production +- **Migration Scripts**: Automate repetitive flow update tasks +- **Validation Functions**: Report on invalid processors, controller services, and connections +- **Sandbox Environment**: Test different authentication mechanisms with ``make sandbox`` target +- **Parameter Management**: Manage parameters across environments + +You can continue to use NiPyAPI 0.x with NiFi 1.x, and NiPyAPI 1.x with NiFi 2.x to assist with the migration process. + +For NiFi-specific migration guidance, consult the `Apache NiFi Migration Guide `_ and your organization's NiFi administrators. + +Major Changes Summary +--------------------- + +**Breaking Changes - Action Required** +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +- **Function renaming**: Upstream API specification changes result in operation IDs now using suffixed names (e.g., ``update_run_status1``) and some other functions are also renamed +- **Authentication and configuration overhaul**: Significant changes to align with modern API standards and upstream API changes +- **Users must review and update authentication patterns** - legacy configuration methods will be different + +**Removed Features** +~~~~~~~~~~~~~~~~~~~~ + +- **Templates API**: Deprecated in NiFi 2.x - use Process Groups and Git or Flow Registry instead +- **Python 2.7 Support**: EOL, dropped in favor of modern Python 3.9+ +- **Legacy Authentication**: Simplified to modern bearer token approach + +**NEW: Profile Management System** +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +- **Extensible file format** (YAML/JSON) with **environment variable overrides** and **sane defaults** - familiar workflow like AWS CLI +- **Intelligent authentication method detection**: OIDC, mTLS, and Basic authentication based on available configuration parameters +- **Built-in profiles** for common deployment patterns: ``single-user``, ``secure-ldap``, ``secure-mtls``, ``secure-oidc`` +- **Extensible profiles** with provided ``examples/profiles.yml`` as a starting point, or create your own +- **15+ configurable parameters** (URLs, credentials, certificates, SSL settings) with environment variable overrides +- **Profile switching** with ``nipyapi.profiles.switch()`` configures endpoints, authentication, and SSL settings in single function call configurable directly or with ``NIPYAPI_PROFILE`` environment variable + +**Enhanced Development Workflow** +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +- **Comprehensive Makefile targets** for all key development and release processes +- **End-to-end automation**: entire client generation and testing sequence from test certificates to final integration tests +- **GitHub Actions CI** with full Docker NiFi integration tests and coverage reporting +- **Sandbox Docker environment** for testing different authentication mechanisms with ``make sandbox`` target + +**Updated APIs** +~~~~~~~~~~~~~~~~ + +- **Client Generation**: Now uses OpenAPI 3.x specs with swagger-codegen v3 +- **Authentication**: Bearer token-based authentication replacing custom token handling +- **Renamed Operations**: Updated to match upstream NiFi 2.x naming (e.g., ``update_run_status1``) + +**Enhanced Features** +~~~~~~~~~~~~~~~~~~~~~ + +- **Docker Profiles**: Streamlined LDAP, mTLS, and single-user configurations +- **Security**: Enhanced certificate management and authentication flows +- **Documentation**: Completely restructured with individual API pages +- **Build System**: Modern Python packaging with ``pyproject.toml`` and ``Makefile`` + +Understanding the Profiles System +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +NiPyAPI 1.x introduces a **centralized configuration system** that eliminates the need for complex manual setup. The system revolves around two key components: + +1. **Configuration File**: ``examples/profiles.yml`` (or your custom file) +2. **Python Interface**: ``nipyapi.profiles.switch('profile-name')`` + +**How it works:** + +.. code-block:: python + + # 1. Profiles file defines your environments + # examples/profiles.yml contains: single-user, secure-ldap, secure-mtls, secure-oidc + + # 2. Switch to any environment with one function call + import nipyapi + nipyapi.profiles.switch('single-user') # Configures everything automatically + + # 3. Use NiPyAPI normally - authentication and SSL are handled + about = nipyapi.system.get_nifi_version_info() + +**Why this matters for migration:** + +- **0.x approach**: 10+ lines of manual configuration per environment +- **1.x approach**: 1 line switches entire environment configuration +- **Zero code changes** needed to switch between dev/staging/production + +Working with profiles.yml +~~~~~~~~~~~~~~~~~~~~~~~~~ + +The profiles system depends on a YAML configuration file that defines your environments. You have two main options: + +**Option A: Use the Provided File (Recommended for Getting Started)** + +NiPyAPI includes ``examples/profiles.yml`` with 4 working profiles: + +.. code-block:: yaml + + # examples/profiles.yml (excerpt) + single-user: + nifi_url: https://localhost:9443/nifi-api + registry_url: http://localhost:18080/nifi-registry-api + nifi_user: einstein + nifi_pass: password1234 + nifi_disable_host_check: true # Disable hostname verification for self-signed certs + suppress_ssl_warnings: true # Suppress SSL warnings in development + + secure-ldap: + nifi_url: https://localhost:9444/nifi-api + registry_url: https://localhost:18444/nifi-registry-api + nifi_user: einstein + nifi_pass: password + ca_path: "resources/certs/client/ca.pem" + +**Quick test with provided profiles:** + +.. code-block:: python + + # These profiles work immediately with NiPyAPI Docker environment + nipyapi.profiles.switch('single-user') # HTTP Basic auth + nipyapi.profiles.switch('secure-ldap') # LDAP over TLS + nipyapi.profiles.switch('secure-mtls') # Certificate auth + nipyapi.profiles.switch('secure-oidc') # OAuth2/OIDC auth + +**Option B: Create Your Own profiles.yml (Production Use)** + +For your actual environments, create a custom profiles file: + +.. code-block:: yaml + + # /etc/nipyapi/profiles.yml or ~/.nipyapi/profiles.yml + my-dev: + nifi_url: https://nifi-dev.company.com/nifi-api + registry_url: https://registry-dev.company.com/nifi-registry-api + nifi_user: dev_user + nifi_pass: dev_password + ca_path: /etc/ssl/certs/company-ca.pem + + my-production: + nifi_url: https://nifi.company.com/nifi-api + registry_url: https://registry.company.com/nifi-registry-api + # Use environment variables for production secrets + # NIFI_USERNAME and NIFI_PASSWORD will override + # nifi_verify_ssl: true (smart default for HTTPS URLs) + # nifi_disable_host_check: null (secure default - hostname verification enabled) + ca_path: /etc/ssl/certs/company-ca.pem + +**Use your custom profiles:** + +.. code-block:: python + + # Method 1: Set default file location + nipyapi.config.default_profiles_file = '/etc/nipyapi/profiles.yml' + nipyapi.profiles.switch('my-production') + + # Method 2: Specify file per call + nipyapi.profiles.switch('my-production', profiles_file='/etc/nipyapi/profiles.yml') + + # Method 3: Environment variable (global) + # export NIPYAPI_PROFILES_FILE=/etc/nipyapi/profiles.yml + nipyapi.profiles.switch('my-production') + +Breaking Changes +---------------- + +Authentication and Configuration +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +**Environment Variables** + +.. list-table:: + :header-rows: 1 + :widths: 30 30 40 + + * - Old (0.x) + - New (1.x) + - Notes + * - ``test_default = True`` (in conftest.py) + - ``NIPYAPI_PROFILE`` + - Environment variable replaces file editing + * - ``NIFI_CA_CERT`` + - ``config.nifi_config.ssl_ca_cert`` + - Programmatic configuration preferred + +**Authentication Migration Strategy** + +The 1.x authentication approach is **profiles-first**. Instead of manually configuring each service, define your authentication in profiles.yml and let the system handle the complexity. The old calls are still present, but the new method is intended to remove the complexity of understanding the underlying authentication mechanisms. + +**Old approach (0.x) - Manual configuration**: + +.. code-block:: python + + # 0.x: Complex manual setup (DO NOT USE in 1.x) + import nipyapi + nipyapi.config.nifi_config.ssl_ca_cert = nipyapi.config.default_ssl_context["ca_file"] + nipyapi.utils.set_endpoint("https://localhost:8443/nifi-api", ssl=True, login=True, + username="nobel", password="supersecret1!") + +**New approach (1.x) - Profiles-based configuration**: + +.. code-block:: python + + # 1.x: Profiles handle everything automatically (RECOMMENDED) + import nipyapi + + # For development/testing (uses examples/profiles.yml) + nipyapi.profiles.switch('single-user') + + # For your production environment (uses custom profiles.yml) + nipyapi.profiles.switch('production', profiles_file='/etc/nipyapi/profiles.yml') + + # Environment variables can override any profile setting + # export NIFI_API_ENDPOINT=https://special.endpoint.com/nifi-api + # export NIFI_USERNAME=override_user + nipyapi.profiles.switch('single-user') # Uses environment overrides + +**Manual Configuration**: + +.. code-block:: python + + # 1.x: Manual configuration still supported but more verbose + import nipyapi + from nipyapi import config, utils + + # HTTPS is now the default with proper certificate management + config.nifi_config.ssl_ca_cert = "resources/certs/ca/ca.crt" + + # Establish authenticated endpoint + utils.set_endpoint("https://localhost:9443/nifi-api", ssl=True, login=True, + username="einstein", password="password1234") + +**What profiles.yml handles for you:** + +- **Endpoints**: NiFi and Registry URLs +- **Authentication**: Username/password, certificates, OIDC tokens +- **SSL Configuration**: CA certificates, SSL verification, hostname checking, warning suppression +- **Service Integration**: NiFi โ†’ Registry proxy identity +- **Environment Flexibility**: Development vs production settings with smart SSL defaults + +**Docker Environment and Testing** + +We now use the ``Makefile`` to start and stop the Docker environment, with integrated profiles support. + +**Integrated Docker + Profiles Workflow** + +.. code-block:: shell + + # One-command environment setup + make certs && make up NIPYAPI_PROFILE=secure-ldap && make wait-ready NIPYAPI_PROFILE=secure-ldap + + # Python code matches the environment + nipyapi.profiles.switch('secure-ldap') + + # Testing with the same profile + make test NIPYAPI_PROFILE=secure-ldap + +**Old commands**:: + + # 0.x approach + cd resources/docker/some_profile + docker-compose up -d + +**New commands**:: + + # 1.x approach + make up NIPYAPI_PROFILE=secure-ldap + make wait-ready NIPYAPI_PROFILE=secure-ldap + +**Development vs Production Security** + +**Development (Self-signed certificates)**:: + + # Quick setup for learning and testing + make certs + make up NIPYAPI_PROFILE=single-user + nipyapi.profiles.switch('single-user') + + # SSL warnings are safely suppressed in development + nipyapi.config.disable_insecure_request_warnings = True + +**Production (Trusted certificates)**:: + + # Use trusted CA certificates + export TLS_CA_CERT_PATH=/etc/ssl/certs/ca-bundle.crt + export NIFI_API_ENDPOINT=https://nifi.company.com/nifi-api + export NIFI_USERNAME=service_account + + # SSL verification is always enabled in production + nipyapi.profiles.switch('production') + +API Changes +~~~~~~~~~~~ + +**Removed: Templates** + +Old code (0.x):: + + import nipyapi.templates + templates = nipyapi.templates.list_all_templates() + +Migration strategy:: + + # Templates are deprecated in NiFi 2.x + # Use Process Groups and Flow Registry instead: + import nipyapi.canvas + import nipyapi.versioning + + # Create reusable flows in Registry + flow = nipyapi.versioning.save_flow_ver(process_group, registry_client, bucket) + +**Updated: Operation Names** + +Due to upstream NiFi 2.x API changes, many operation IDs now use suffixed names. **You must update your code**: + +.. list-table:: + :header-rows: 1 + :widths: 40 40 20 + + * - Old Method (0.x) + - New Method (1.x) + - Status + * - ``update_run_status`` + - ``update_run_status1`` + - **Renamed - Action Required** + * - ``FlowfileQueuesApi`` + - ``FlowFileQueuesApi`` + - Case change + * - Various processor operations + - Many now have ``1`` suffix + - **Check your API calls** + +.. important:: + **Function Renaming**: Upstream API specification changes result in operation IDs now using suffixed names. + If you get ``AttributeError`` exceptions, check for renamed operations - many now have '1' suffix. + +**Common Migration Pattern**: + +.. code-block:: python + + # Before (0.x) + api.update_run_status(processor_id, request_body) + + # After (1.x) - Note the '1' suffix + api.update_run_status1(processor_id, request_body) + +**Updated: Controller Service Management** + +Old approach (0.x):: + + # 0.x pattern + nipyapi.canvas.schedule_controller_service(service_id, scheduled=True) + +New approach (1.x):: + + # 1.x pattern - uses different underlying API endpoint + nipyapi.canvas.schedule_controller_service(service_id, scheduled=True) + # Implementation uses ControllerServicesApi.update_run_status1() + +.. Note:: Behavior of the new mthods may be the same, but you should test carefully. + +Configuration Changes +~~~~~~~~~~~~~~~~~~~~~ + +**SSL/TLS Configuration** + +NiPyAPI 1.x introduces **smart SSL defaults** and **granular SSL controls**: + +**Smart SSL Defaults (NEW in 1.x)**:: + + # SSL verification automatically enabled for HTTPS URLs + nifi_url: https://nifi.company.com/nifi-api # verify_ssl=true (automatic) + registry_url: http://registry.company.com/ # verify_ssl=false (automatic) + +**Granular SSL Controls (NEW in 1.x)**:: + + # Development profile with self-signed certificates + nifi_disable_host_check: true # Disable hostname verification for HTTPS + suppress_ssl_warnings: true # Suppress urllib3 warnings for development + + # Production profile with trusted certificates + nifi_disable_host_check: null # Enable hostname verification (default) + suppress_ssl_warnings: false # Show all SSL warnings + +**Key SSL Behavior Changes from 0.x to 1.x:** + +**1. SSL Parameter in set_endpoint()** + +Old behavior (0.x):: + + # ssl=True parameter enabled SSL verification with default system behavior + nipyapi.utils.set_endpoint("https://localhost:8443/nifi-api", ssl=True, login=True, + username="nobel", password="supersecret1!") + # SSL verification was system-dependent and not granularly controlled + +New behavior (1.x):: + + # ssl=True still works, but now respects granular configuration + nipyapi.config.nifi_config.verify_ssl = True # Explicit SSL verification control + nipyapi.config.nifi_config.disable_host_check = False # Hostname verification control + nipyapi.utils.set_endpoint("https://localhost:9443/nifi-api", ssl=True, login=True, + username="einstein", password="password1234") + +**2. SSL Context Configuration** + +Old approach (0.x):: + + import os + # Environment variables + default_ssl_context pattern + os.environ['NIFI_CA_CERT'] = '/path/to/ca.pem' + nipyapi.config.nifi_config.ssl_ca_cert = nipyapi.config.default_ssl_context["ca_file"] + +New approach (1.x) - Direct Configuration:: + + import nipyapi + # Direct configuration (no default_ssl_context needed) + nipyapi.config.nifi_config.ssl_ca_cert = '/path/to/ca.pem' + nipyapi.config.registry_config.ssl_ca_cert = '/path/to/ca.pem' # Per-service control + nipyapi.config.nifi_config.verify_ssl = True + nipyapi.config.nifi_config.disable_host_check = False # Hostname verification + +New approach (1.x) - Profiles (Recommended):: + + # Use profiles with smart defaults - handles all SSL complexity + nipyapi.profiles.switch('production') # All SSL settings configured automatically + +**3. SSL Configuration Complexity Reduction** + +SSL configuration approach changes: + +.. list-table:: + :header-rows: 1 + :widths: 40 30 30 + + * - Aspect + - 0.x Approach + - 1.x Approach + * - **SSL Configuration** + - Complex: global settings + env vars + manual config + - Simple: profiles with smart defaults + * - **Per-Service Control** + - Global ``global_ssl_verify`` affects both services + - Independent ``nifi_verify_ssl`` / ``registry_verify_ssl`` + * - **Hostname Checking** + - Global ``global_ssl_host_check`` setting + - Per-service ``nifi_disable_host_check`` / ``registry_disable_host_check`` + * - **Certificate Management** + - Environment variables (``NIFI_CA_CERT``) + ``default_ssl_context`` + - Profiles with shared/per-service certificates + smart resolution + * - **Configuration Style** + - Manual: Set globals, env vars, then configure each service + - Declarative: Define environment in profile, apply with one call + +**4. Enhanced SSL Controls (1.x)** + +**0.x approach - Global settings affecting both services:** + +.. code-block:: python + + # 0.x: Global SSL settings affected both NiFi and Registry + nipyapi.config.global_ssl_verify = True # Applied to both services + nipyapi.config.global_ssl_host_check = True # Applied to both services + nipyapi.config.disable_insecure_request_warnings = False + + # Complex environment variable setup + os.environ['NIFI_CA_CERT'] = '/path/to/ca.pem' + nipyapi.config.nifi_config.ssl_ca_cert = nipyapi.config.default_ssl_context["ca_file"] + +**1.x approach - Per-service granular control:** + +.. code-block:: yaml + + # 1.x: Fine-grained per-service SSL control in profiles + nifi_verify_ssl: true # Independent NiFi SSL verification + registry_verify_ssl: false # Independent Registry SSL control + nifi_disable_host_check: true # Per-service hostname verification control + registry_disable_host_check: null # Different setting per service + suppress_ssl_warnings: true # Global warning suppression (cleaner than 0.x) + +**Complexity Comparison Example:** + +.. code-block:: python + + # 0.x: Complex multi-step configuration (10+ lines) + import os + import nipyapi + + # Step 1: Set global SSL settings + nipyapi.config.global_ssl_verify = True + nipyapi.config.global_ssl_host_check = False # But this affects BOTH services! + nipyapi.config.disable_insecure_request_warnings = True + + # Step 2: Set environment variables + os.environ['NIFI_CA_CERT'] = '/path/to/ca.pem' + + # Step 3: Apply to NiFi config + nipyapi.config.nifi_config.ssl_ca_cert = nipyapi.config.default_ssl_context["ca_file"] + + # Step 4: Manually configure each service endpoint + nipyapi.utils.set_endpoint("https://localhost:8443/nifi-api", ssl=True, login=True) + # Registry SSL settings? More complex configuration needed... + + # vs. + + # 1.x: Simple declarative configuration (1 line) + nipyapi.profiles.switch('single-user') # Everything configured automatically + +**Common SSL Migration Issues and Solutions:** + +**Issue: "ssl=True doesn't work like it used to"** + +In 0.x, ``ssl=True`` behavior was system-dependent. In 1.x, it respects explicit configuration: + +.. code-block:: python + + # 1.x: Configure SSL explicitly before calling set_endpoint + nipyapi.config.nifi_config.verify_ssl = True + nipyapi.config.nifi_config.ssl_ca_cert = '/path/to/ca.pem' + nipyapi.utils.set_endpoint(url, ssl=True, login=True) + +**Issue: "Self-signed certificates cause hostname errors"** + +0.x had system-dependent hostname checking. 1.x provides granular control: + +.. code-block:: python + + # For development with self-signed certificates + nipyapi.config.nifi_config.disable_host_check = True # NEW in 1.x + nipyapi.config.nifi_config.verify_ssl = False # Accept self-signed certs + +**Issue: "Different SSL requirements for NiFi vs Registry"** + +0.x primarily supported NiFi. 1.x supports independent SSL configuration: + +.. code-block:: python + + # 1.x: Independent SSL control per service + nipyapi.config.nifi_config.verify_ssl = True # HTTPS with trusted certs + nipyapi.config.registry_config.verify_ssl = False # HTTP or self-signed + +**Testing Profiles** + +Old commands:: + + pytest tests/ + +New commands:: + + make test NIPYAPI_PROFILE=secure-ldap + # or + NIPYAPI_PROFILE=secure-ldap pytest tests/ + +See the ``devnotes.rst`` guide for more details. + +New Authentication Methods +~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +NiPyAPI 1.x adds support for modern authentication: + +**OpenID Connect (OIDC)**:: + + # OAuth2 with external identity providers + nipyapi.profiles.switch('secure-oidc') + # Supports Keycloak, Okta, Azure AD, etc. + +**Enhanced mTLS**:: + + # Certificate-based authentication + nipyapi.profiles.switch('secure-mtls') + # Simplified certificate management + +**Environment Variable Integration**:: + + # Override any profile setting + export NIFI_API_ENDPOINT=https://production.company.com/nifi-api + export NIFI_USERNAME=production_user + export NIFI_DISABLE_HOST_CHECK=true # Disable hostname verification + export NIPYAPI_SUPPRESS_SSL_WARNINGS=true # Suppress SSL warnings + nipyapi.profiles.switch('single-user') # Uses overrides + +Migration Steps +--------------- + +1. **Update Dependencies** +~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Update your ``requirements.txt`` or ``pyproject.toml``: + +.. code-block:: text + + # Old + nipyapi>=0.22,<1.0 + + # New + nipyapi>=1.0,<2.0 + +2. **Choose Your Profiles Strategy** +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +**Strategy A: Start with Built-in Profiles (Recommended)** + +Use the provided ``examples/profiles.yml`` for immediate compatibility: + +.. code-block:: python + + # Test with development Docker environment + nipyapi.profiles.switch('single-user') + + # Validate connection + version = nipyapi.system.get_nifi_version_info() + print(f"Connected to NiFi {version}") + +**Strategy B: Create Custom Profiles** + +Create your own ``profiles.yml`` for your environments: + +.. code-block:: bash + + # Copy the example as a starting point + cp examples/profiles.yml ~/.nipyapi/profiles.yml + + # Edit for your environments + vim ~/.nipyapi/profiles.yml + +**Strategy C: Environment-Driven Configuration** + +Use profiles with environment variable overrides: + +.. code-block:: python + + # Code stays the same across environments + nipyapi.profiles.switch('base-profile') + + # Environment variables control the actual connection + # export NIFI_API_ENDPOINT=https://nifi.staging.com/nifi-api # staging + # export NIFI_API_ENDPOINT=https://nifi.company.com/nifi-api # production + +3. **Test Your Profile Configuration** +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Validate your profiles work before migrating production code: + +.. code-block:: python + + import nipyapi + + # Test profile loading + try: + nipyapi.profiles.switch('your-profile-name') + print("โœ“ Profile loaded successfully") + except Exception as e: + print(f"โœ— Profile error: {e}") + + # Test connectivity + try: + version = nipyapi.system.get_nifi_version_info() + print(f"โœ“ Connected to NiFi {version}") + except Exception as e: + print(f"โœ— Connection error: {e}") + +4. **Update Your Application Code** +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +**Replace manual configuration with profile switching:** + +.. code-block:: python + + # Before (0.x) - Complex setup + import nipyapi + nipyapi.config.nifi_config.ssl_ca_cert = "/path/to/ca.pem" + nipyapi.utils.set_endpoint("https://nifi.com/nifi-api", ssl=True, login=True, + username="user", password="pass") + # ... 10+ more configuration lines ... + + # After (1.x) - Simple profile switch + import nipyapi + nipyapi.profiles.switch('production') + + # Your existing business logic stays the same + flows = nipyapi.canvas.list_all_process_groups() + about = nipyapi.system.get_nifi_version_info() + +**Fix renamed function calls:** + +.. code-block:: python + + # Before (0.x) + api.update_run_status(processor_id, request_body) + + # After (1.x) - Note the '1' suffix + api.update_run_status1(processor_id, request_body) + +5. **Update Testing Environment** +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +The 0.x testing used hardcoded boolean flags in ``conftest.py``, not environment variables: + +.. code-block:: python + + # 0.x approach (edit conftest.py) + # In tests/conftest.py: + test_default = True # Test against default endpoints + test_ldap = False # Enable LDAP testing + test_mtls = False # Enable mTLS testing + + # Then run tests directly + pytest tests/ + +The 1.x approach uses environment-driven profiles: + +.. code-block:: shell + + # 1.x approach (environment-driven) + make up NIPYAPI_PROFILE=secure-ldap + make wait-ready NIPYAPI_PROFILE=secure-ldap + make test NIPYAPI_PROFILE=secure-ldap + +See the ``devnotes.rst`` guide for more details. + +6. **Remove Templates Usage** +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Replace template-based workflows with Process Groups and Registry: + +.. code-block:: python + + # Before (0.x) - Templates + import nipyapi.templates + template = nipyapi.templates.upload_template('flow.xml') + nipyapi.templates.deploy_template(pg_id, template.id) + + # After (1.x) - Registry Flows + import nipyapi.versioning + # Save flow to registry + flow_ver = nipyapi.versioning.save_flow_ver(pg, registry_client, bucket) + # Deploy to other environments + deployed_pg = nipyapi.versioning.deploy_flow_version( + parent_pg_id, registry_client.id, bucket.identifier, flow_ver.flow.identifier + ) + +.. Note:: An example of using NiFi Registry is provided in ``examples/fdlc.py`` + + +7. **Update Configuration and Ports** +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Key configuration changes between NiPyAPI 0.x and 1.x: + +.. list-table:: + :header-rows: 1 + :widths: 25 35 35 + + * - Component + - 0.x (NiFi 1.x) + - 1.x (NiFi 2.x) + * - **Default NiFi** + - ``http://localhost:8080/nifi-api`` + - ``https://localhost:9443/nifi-api`` + * - **Default Registry** + - ``http://localhost:18080/nifi-registry-api`` + - ``http://localhost:18080/nifi-registry-api`` + * - **Test Credentials** + - ``nobel/supersecret1!`` (default) + - ``einstein/password1234`` (single-user) + * - **LDAP Credentials** + - ``nobel/password`` + - ``einstein/password`` + * - **Certificate Location** + - ``demo/keys/`` (localhost-ts.pem) + - ``resources/certs/`` (ca.crt) + * - **Docker Test Ports** + - Default: 8443, LDAP: 9443 + - Single: 9443, LDAP: 9444, mTLS: 9445 + +Common Migration Issues +----------------------- + +**Issue: SSL Certificate Errors** + +.. code-block:: text + + SSLError: [SSL: CERTIFICATE_VERIFY_FAILED] certificate verify failed + +**Solution**: Ensure mounted and presented certificates are valid. Then configure CA certificate properly: + +.. code-block:: python + + nipyapi.config.nifi_config.ssl_ca_cert = 'resources/certs/ca/ca.crt' + +See the ``authentication.rst`` guide for more details. + +**Issue: Authentication Failures** + +.. code-block:: text + + Unauthorized: No valid authentication + +**Solution**: Use proper authentication flow: + +.. code-block:: python + + nipyapi.profiles.switch('production') + +**Issue: Operation Not Found** + +.. code-block:: text + + AttributeError: 'ProcessGroupsApi' object has no attribute 'update_run_status' + +**Solution**: Check for renamed operations (many now have '1' suffix): + +.. code-block:: python + + # Old: update_run_status + # New: update_run_status1 + +.. important:: + **Function Renaming**: This is the most common migration issue. Upstream API specification changes result in operation IDs now using suffixed names. If you get AttributeError exceptions, check for renamed operations. + +**Systematic approach to find renamed functions:** + +.. code-block:: python + + # Use dir() to find available methods + import nipyapi + api = nipyapi.nifi.ProcessGroupsApi() + methods = [m for m in dir(api) if 'update' in m.lower()] + print(methods) # Will show: ['update_run_status1', ...] + + # Or check the API documentation + help(api.update_run_status1) + +**Issue: Authorization Failures After Authentication** + +.. code-block:: text + + No applicable policies could be found + Forbidden: Access is denied due to insufficient permissions + +Note: NiFi 2.x is more strict by default about Authentication and Authorization. + +**Solution**: Bootstrap security policies for secure profiles: + +.. code-block:: python + + # For NiFi operations + nipyapi.security.bootstrap_security_policies(service='nifi') + + # For Registry operations (with proxy identity) + nipyapi.security.bootstrap_security_policies( + service='registry', + nifi_proxy_identity='C=US, O=NiPyAPI, CN=nifi' + ) + +.. Note:: You can find examples of using the boostrap functions in ``examples/sandbox.py`` + +**Issue: Registry Proxy Identity Not Authorized** + +.. code-block:: text + + Untrusted proxy + Unable to list buckets: access denied + +**Solution**: Ensure Registry proxy configuration is set up: + +.. code-block:: python + + # Registry must trust NiFi as a proxy + nipyapi.security.bootstrap_security_policies( + service='registry', + nifi_proxy_identity='C=US, O=NiPyAPI, CN=nifi' + ) + +The proxy identity must match the NiFi certificate subject DN when using secure profiles. + +.. Important:: Reversing the DN will not work, as it's an exact match. + +**Issue: OIDC Authentication Setup** + +.. code-block:: text + + No applicable policies could be found + Untrusted proxy identity + +**Solution**: OIDC requires one-time manual setup due to NiFi's security architecture: + +.. code-block:: shell + + # 1. Use sandbox to discover your OIDC application UUID + make sandbox NIPYAPI_PROFILE=secure-oidc + + # 2. Follow the printed instructions to create the user and assign policies in NiFi UI + # 3. Re-run sandbox to complete bootstrap + make sandbox NIPYAPI_PROFILE=secure-oidc + +See the ``security.rst`` guide for detailed OIDC setup instructions, or follow the sandbox. + +Quick Migration Checklist +-------------------------- + +โ˜ **Update dependencies**: ``nipyapi>=1.0,<2.0`` + +โ˜ **Choose migration approach**: + - โœ… **Recommended**: Use profiles (``nipyapi.profiles.switch('single-user')``) + - **Manual**: Direct programmatic configuration (more control) + +โ˜ **Test with Docker environment**: + - ``make certs && make up NIPYAPI_PROFILE=single-user`` for development + - ``make test NIPYAPI_PROFILE=single-user`` to validate + +โ˜ **Handle breaking changes**: + - Replace ``update_run_status`` with ``update_run_status1`` (check all API calls) + - Remove templates usage โ†’ use Registry flows + - Remove variable registry usage โ†’ use Parameters + - Replace invalid Processors/Controller Services โ†’ use replacement components + - Update certificate paths (``demo/keys/`` โ†’ ``resources/certs/``) + - Update default ports (8080 โ†’ 9443 for NiFi, credentials: nobel โ†’ einstein) + +โ˜ **Migrate SSL configuration**: + - Replace ``nipyapi.config.default_ssl_context`` pattern with profile configuration + - Update ``ssl=True`` usage to explicitly configure ``verify_ssl`` and ``disable_host_check`` + - Replace ``NIFI_CA_CERT`` environment variables with ``REQUESTS_CA_BUNDLE`` or direct config + - Consider disabling hostname verification for self-signed certificates (``disable_host_check: true``) + - Configure per-service SSL settings for NiFi and Registry independently + - Use profiles for centralized SSL management (recommended) + +โ˜ **Production deployment**: + - Set environment variables or Profiles for credentials/endpoints + - Use trusted certificates (not self-signed) + - Enable SSL verification (default in production profiles) + +Testing Your Migration +----------------------- + +1. **Start Simple**: Begin with single-user profile testing +2. **Incremental Migration**: Migrate one authentication mode at a time +3. **Integration Testing**: Use ``make test NIPYAPI_PROFILE=single-user`` for comprehensive validation +4. **Docker Environment**: Test with provided Docker profiles before production + +For additional support: + +- **Examples**: See ``examples/fdlc.py`` for modern patterns +- **Sandbox**: Use ``make sandbox NIPYAPI_PROFILE=single-user`` for experimentation +- **Documentation**: Updated profiles guide at ``docs/profiles.rst`` and security guide at ``docs/security.rst`` +- **Issues**: Please raise an issue on `GitHub `_ if you encounter any problems. diff --git a/docs/nipyapi-docs/api_reference.rst b/docs/nipyapi-docs/api_reference.rst new file mode 100644 index 00000000..5b0155f7 --- /dev/null +++ b/docs/nipyapi-docs/api_reference.rst @@ -0,0 +1,17 @@ +API Reference +============= + +Complete API documentation for NiPyApi, organized for easy navigation. + +.. toctree:: + :maxdepth: 2 + :caption: Documentation Sections + + client_architecture + core_modules + nifi_apis/index + nifi_models/index + registry_apis/index + registry_models/index + examples + diff --git a/docs/nipyapi-docs/client_architecture.rst b/docs/nipyapi-docs/client_architecture.rst new file mode 100644 index 00000000..53e8d151 --- /dev/null +++ b/docs/nipyapi-docs/client_architecture.rst @@ -0,0 +1,84 @@ +Client Architecture +=================== + +Understanding how NiPyApi clients are structured and how to use them effectively. + +Client Layers +------------- + +NiPyApi provides multiple layers of abstraction: + +**Core Modules** (High-level): :doc:`core_modules` - Convenient Python functions for common operations + +**Generated APIs** (Low-level): :doc:`nifi_apis/index` and :doc:`registry_apis/index` - Direct REST API access + +**Models**: :doc:`nifi_models/index` and :doc:`registry_models/index` - Data structures used by APIs + +Generated API Structure +----------------------- + +Each generated API class provides two methods for every operation: + +**Base Methods** (e.g., ``copy()``) + Return response data directly. Use these for most operations. + +**HTTP Info Methods** (e.g., ``copy_with_http_info()``) + Return detailed response including status code and headers. + Use when you need HTTP metadata or error details. + +Example Usage +~~~~~~~~~~~~~ + +.. code-block:: python + + import nipyapi + + # High-level approach (recommended for most users) + process_groups = nipyapi.canvas.list_all_process_groups() + + # Low-level API approach + api_instance = nipyapi.nifi.ProcessGroupsApi() + + # Get just the data + flow = api_instance.get_flow('root') + + # Get data + HTTP details + flow, status, headers = api_instance.get_flow_with_http_info('root') + print(f"HTTP Status: {status}") + +Callback Functions +------------------ + +The generated clients support callback functions for asynchronous operations: + +.. code-block:: python + + def my_callback(response): + print(f"Response received: {response}") + + # Use callback for async-style processing + api_instance.get_flow('root', callback=my_callback) + +**Note**: Callbacks are inherited from the original Swagger-generated client. +They maintain backwards compatibility but are not commonly used. + +Error Handling +-------------- + +APIs can raise exceptions on HTTP errors: + +.. code-block:: python + + from nipyapi.nifi.rest import ApiException + + try: + flow = api_instance.get_flow('invalid-id') + except ApiException as e: + print(f"API Error: {e.status} - {e.reason}") + +Model Cross-References +---------------------- + +API documentation includes clickable links to model classes. +Click any model type (e.g., :class:`~nipyapi.nifi.models.ProcessGroupEntity`) to jump to its detailed documentation. + diff --git a/docs/nipyapi-docs/core_modules.rst b/docs/nipyapi-docs/core_modules.rst new file mode 100644 index 00000000..d159c966 --- /dev/null +++ b/docs/nipyapi-docs/core_modules.rst @@ -0,0 +1,17 @@ +Core Client Modules +=================== + +These modules provide high-level convenience functions for common NiFi operations. +They wrap the lower-level generated API clients with Pythonic interfaces. + +.. toctree:: + :maxdepth: 1 + + core_modules/canvas + core_modules/system + core_modules/config + core_modules/versioning + core_modules/utils + core_modules/security + core_modules/parameters + core_modules/profiles diff --git a/docs/nipyapi-docs/core_modules/canvas.rst b/docs/nipyapi-docs/core_modules/canvas.rst new file mode 100644 index 00000000..32a25fe1 --- /dev/null +++ b/docs/nipyapi-docs/core_modules/canvas.rst @@ -0,0 +1,9 @@ +Canvas +====== + +Canvas operations and flow management + +.. automodule:: nipyapi.canvas + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/nipyapi-docs/core_modules/config.rst b/docs/nipyapi-docs/core_modules/config.rst new file mode 100644 index 00000000..897f733d --- /dev/null +++ b/docs/nipyapi-docs/core_modules/config.rst @@ -0,0 +1,9 @@ +Config +====== + +Configuration management + +.. automodule:: nipyapi.config + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/nipyapi-docs/core_modules/parameters.rst b/docs/nipyapi-docs/core_modules/parameters.rst new file mode 100644 index 00000000..22b646ef --- /dev/null +++ b/docs/nipyapi-docs/core_modules/parameters.rst @@ -0,0 +1,9 @@ +Parameters +========== + +Parameter context management + +.. automodule:: nipyapi.parameters + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/nipyapi-docs/core_modules/profiles.rst b/docs/nipyapi-docs/core_modules/profiles.rst new file mode 100644 index 00000000..f87f955e --- /dev/null +++ b/docs/nipyapi-docs/core_modules/profiles.rst @@ -0,0 +1,9 @@ +Profiles +======== + +Profiles functionality + +.. automodule:: nipyapi.profiles + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/nipyapi-docs/core_modules/security.rst b/docs/nipyapi-docs/core_modules/security.rst new file mode 100644 index 00000000..caa37587 --- /dev/null +++ b/docs/nipyapi-docs/core_modules/security.rst @@ -0,0 +1,9 @@ +Security +======== + +Security and authentication utilities + +.. automodule:: nipyapi.security + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/nipyapi-docs/core_modules/system.rst b/docs/nipyapi-docs/core_modules/system.rst new file mode 100644 index 00000000..ac1d5a2c --- /dev/null +++ b/docs/nipyapi-docs/core_modules/system.rst @@ -0,0 +1,9 @@ +System +====== + +System information and diagnostics + +.. automodule:: nipyapi.system + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/nipyapi-docs/core_modules/utils.rst b/docs/nipyapi-docs/core_modules/utils.rst new file mode 100644 index 00000000..812d5ff4 --- /dev/null +++ b/docs/nipyapi-docs/core_modules/utils.rst @@ -0,0 +1,9 @@ +Utils +===== + +Utility functions and helpers + +.. automodule:: nipyapi.utils + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/nipyapi-docs/core_modules/versioning.rst b/docs/nipyapi-docs/core_modules/versioning.rst new file mode 100644 index 00000000..d8a9f796 --- /dev/null +++ b/docs/nipyapi-docs/core_modules/versioning.rst @@ -0,0 +1,9 @@ +Versioning +========== + +Version control operations + +.. automodule:: nipyapi.versioning + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/nipyapi-docs/dependencies.rst b/docs/nipyapi-docs/dependencies.rst new file mode 100644 index 00000000..6df49c32 --- /dev/null +++ b/docs/nipyapi-docs/dependencies.rst @@ -0,0 +1,71 @@ +Dependencies +------------- + +NiPyAPI automatically manages its dependencies during installation. Here are the complete dependency details, automatically generated from the actual project dependency files. + +Runtime Dependencies +-------------------- + +These dependencies are automatically installed when you install NiPyAPI: + + +**Core HTTP Stack:** + +- ``certifi>=2023.7.22`` - SSL certificate verification +- ``pysocks>=1.7.1`` - SOCKS proxy support +- ``requests>=2.18`` - Primary HTTP client for API communication +- ``urllib3>=1.26,<3`` - HTTP client backend and connection pooling + +**Utilities:** + +- ``PyYAML>=6.0`` - YAML file processing and serialization +- ``packaging>=17.1`` - Version comparison utilities + +**Build & Packaging:** + +- ``setuptools>=38.5`` - Package management and distribution + +Optional Dependencies +--------------------- + +**Development Dependencies** (install with ``pip install nipyapi[dev]``): + +- ``codecov>=2.1.13`` - Coverage reporting service integration +- ``coverage>=7.0`` - Coverage analysis and reporting +- ``deepdiff>=3.3.0`` - Deep data structure comparison for testing +- ``flake8>=3.6.0`` - Code style and syntax checking +- ``pre-commit>=3.0.0`` - Development tool +- ``pylint>=3.3.0`` - Advanced code analysis and linting +- ``pytest-cov>=5.0.0`` - Test coverage measurement +- ``pytest>=8.4`` - Testing framework +- ``twine>=6.0.0`` - Package distribution to PyPI + +**Documentation Dependencies** (install with ``pip install nipyapi[docs]``): + +- ``Sphinx>=7.4.0`` - Documentation generation framework +- ``sphinx_rtd_theme>=3.0.0`` - Read the Docs theme for Sphinx +- ``sphinxcontrib-jquery>=4.1`` - jQuery support for Sphinx themes + +Dependency Management +--------------------- + +**Automatic Installation:** +All runtime dependencies are automatically installed when you install NiPyAPI via pip. + +**Version Constraints:** +NiPyAPI specifies minimum versions for compatibility but allows newer versions unless there are known incompatibilities. + +**Development Setup:** +For a complete development environment with all optional dependencies: + +.. code-block:: console + + $ pip install -e ".[dev,docs]" + +**Minimal Installation:** +NiPyAPI requires only 7 runtime dependencies for basic functionality. + +.. note:: + This dependency information is automatically generated from the project's + ``requirements.txt`` and ``pyproject.toml`` files during documentation build. + diff --git a/docs/nipyapi-docs/examples.rst b/docs/nipyapi-docs/examples.rst new file mode 100644 index 00000000..67ceb4a9 --- /dev/null +++ b/docs/nipyapi-docs/examples.rst @@ -0,0 +1,62 @@ +Examples and Tutorials +====================== + +Example scripts demonstrating NiPyApi functionality can be found in the +`examples/ directory `_ +of the source repository. + +Available Examples +------------------ + +* **fdlc.py**: **Flow Development Life Cycle (FDLC)** - A comprehensive example demonstrating enterprise NiFi development workflow using NiFi Registry for version control. Shows the complete cycle: DEV environment flow creation โ†’ PROD environment deployment โ†’ iterative development โ†’ production updates. Includes multi-environment authentication, flow versioning, and Registry integration patterns. + +* **sandbox.py**: **Multi-Profile Authentication Demo** - Interactive script showcasing all NiPyAPI authentication methods (single-user, LDAP, mTLS, OIDC) with real Docker environments. Demonstrates SSL/TLS configuration, security bootstrapping, Registry client setup, and sample object creation. Perfect for learning authentication patterns and testing different security configurations. + +* **profiles.yml**: **Configuration Templates** - Complete YAML configuration file with working profiles for all supported authentication methods. Includes detailed comments explaining certificate paths, environment variable overrides, and per-service vs shared certificate configurations. Use as a starting template for your own deployments. + +Quick Start +----------- + +**New to NiPyAPI?** Start with the sandbox environment: + +.. code-block:: console + + $ make sandbox NIPYAPI_PROFILE=single-user + $ python examples/sandbox.py single-user + +**Ready for enterprise patterns?** Try the FDLC workflow: + +.. code-block:: console + + $ python examples/fdlc.py + +**Need authentication setup?** Copy and customize ``profiles.yml`` for your environment. + +Sandbox Environment +------------------- + +For quick experimentation, use the sandbox make target to set up a ready-to-use environment: + +.. code-block:: console + + $ make sandbox NIPYAPI_PROFILE=single-user # Recommended - simple setup + $ make sandbox NIPYAPI_PROFILE=secure-ldap # LDAP authentication + $ make sandbox NIPYAPI_PROFILE=secure-mtls # Certificate authentication (advanced) + +The sandbox automatically creates: + +* Properly configured authentication and SSL +* Sample registry client and bucket +* Simple demo flow ready for experimentation +* All necessary security bootstrapping + +When finished experimenting: + +.. code-block:: console + + $ make down # Clean up Docker containers + +.. note:: + These are standalone Python scripts, not importable modules. + Run them directly with Python after setting up your environment. + diff --git a/docs/nipyapi-docs/nifi_apis/access_api.rst b/docs/nipyapi-docs/nifi_apis/access_api.rst new file mode 100644 index 00000000..1caa30ae --- /dev/null +++ b/docs/nipyapi-docs/nifi_apis/access_api.rst @@ -0,0 +1,4 @@ +.. automodule:: nipyapi.nifi.apis.access_api + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/nipyapi-docs/nifi_apis/authentication_api.rst b/docs/nipyapi-docs/nifi_apis/authentication_api.rst new file mode 100644 index 00000000..4b914f0b --- /dev/null +++ b/docs/nipyapi-docs/nifi_apis/authentication_api.rst @@ -0,0 +1,4 @@ +.. automodule:: nipyapi.nifi.apis.authentication_api + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/nipyapi-docs/nifi_apis/connections_api.rst b/docs/nipyapi-docs/nifi_apis/connections_api.rst new file mode 100644 index 00000000..4aeb7583 --- /dev/null +++ b/docs/nipyapi-docs/nifi_apis/connections_api.rst @@ -0,0 +1,4 @@ +.. automodule:: nipyapi.nifi.apis.connections_api + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/nipyapi-docs/nifi_apis/controller_api.rst b/docs/nipyapi-docs/nifi_apis/controller_api.rst new file mode 100644 index 00000000..034fb62a --- /dev/null +++ b/docs/nipyapi-docs/nifi_apis/controller_api.rst @@ -0,0 +1,4 @@ +.. automodule:: nipyapi.nifi.apis.controller_api + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/nipyapi-docs/nifi_apis/controller_services_api.rst b/docs/nipyapi-docs/nifi_apis/controller_services_api.rst new file mode 100644 index 00000000..4c3c6767 --- /dev/null +++ b/docs/nipyapi-docs/nifi_apis/controller_services_api.rst @@ -0,0 +1,4 @@ +.. automodule:: nipyapi.nifi.apis.controller_services_api + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/nipyapi-docs/nifi_apis/counters_api.rst b/docs/nipyapi-docs/nifi_apis/counters_api.rst new file mode 100644 index 00000000..df839f63 --- /dev/null +++ b/docs/nipyapi-docs/nifi_apis/counters_api.rst @@ -0,0 +1,4 @@ +.. automodule:: nipyapi.nifi.apis.counters_api + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/nipyapi-docs/nifi_apis/data_transfer_api.rst b/docs/nipyapi-docs/nifi_apis/data_transfer_api.rst new file mode 100644 index 00000000..2a6177de --- /dev/null +++ b/docs/nipyapi-docs/nifi_apis/data_transfer_api.rst @@ -0,0 +1,4 @@ +.. automodule:: nipyapi.nifi.apis.data_transfer_api + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/nipyapi-docs/nifi_apis/flow_api.rst b/docs/nipyapi-docs/nifi_apis/flow_api.rst new file mode 100644 index 00000000..09f1a03e --- /dev/null +++ b/docs/nipyapi-docs/nifi_apis/flow_api.rst @@ -0,0 +1,4 @@ +.. automodule:: nipyapi.nifi.apis.flow_api + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/nipyapi-docs/nifi_apis/flow_file_queues_api.rst b/docs/nipyapi-docs/nifi_apis/flow_file_queues_api.rst new file mode 100644 index 00000000..ad307216 --- /dev/null +++ b/docs/nipyapi-docs/nifi_apis/flow_file_queues_api.rst @@ -0,0 +1,4 @@ +.. automodule:: nipyapi.nifi.apis.flow_file_queues_api + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/nipyapi-docs/nifi_apis/funnels_api.rst b/docs/nipyapi-docs/nifi_apis/funnels_api.rst new file mode 100644 index 00000000..8f06932e --- /dev/null +++ b/docs/nipyapi-docs/nifi_apis/funnels_api.rst @@ -0,0 +1,4 @@ +.. automodule:: nipyapi.nifi.apis.funnels_api + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/nipyapi-docs/nifi_apis/index.rst b/docs/nipyapi-docs/nifi_apis/index.rst new file mode 100644 index 00000000..9994b4c7 --- /dev/null +++ b/docs/nipyapi-docs/nifi_apis/index.rst @@ -0,0 +1,38 @@ +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. + +.. toctree:: + :maxdepth: 1 + + access_api + authentication_api + connections_api + controller_api + controller_services_api + counters_api + data_transfer_api + flow_api + flow_file_queues_api + funnels_api + input_ports_api + labels_api + output_ports_api + parameter_contexts_api + parameter_providers_api + policies_api + process_groups_api + processors_api + provenance_api + provenance_events_api + remote_process_groups_api + reporting_tasks_api + resources_api + site_to_site_api + snippets_api + system_diagnostics_api + tenants_api + versions_api diff --git a/docs/nipyapi-docs/nifi_apis/input_ports_api.rst b/docs/nipyapi-docs/nifi_apis/input_ports_api.rst new file mode 100644 index 00000000..2b0449d2 --- /dev/null +++ b/docs/nipyapi-docs/nifi_apis/input_ports_api.rst @@ -0,0 +1,4 @@ +.. automodule:: nipyapi.nifi.apis.input_ports_api + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/nipyapi-docs/nifi_apis/labels_api.rst b/docs/nipyapi-docs/nifi_apis/labels_api.rst new file mode 100644 index 00000000..639994d6 --- /dev/null +++ b/docs/nipyapi-docs/nifi_apis/labels_api.rst @@ -0,0 +1,4 @@ +.. automodule:: nipyapi.nifi.apis.labels_api + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/nipyapi-docs/nifi_apis/output_ports_api.rst b/docs/nipyapi-docs/nifi_apis/output_ports_api.rst new file mode 100644 index 00000000..1be7c972 --- /dev/null +++ b/docs/nipyapi-docs/nifi_apis/output_ports_api.rst @@ -0,0 +1,4 @@ +.. automodule:: nipyapi.nifi.apis.output_ports_api + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/nipyapi-docs/nifi_apis/parameter_contexts_api.rst b/docs/nipyapi-docs/nifi_apis/parameter_contexts_api.rst new file mode 100644 index 00000000..afdd57c3 --- /dev/null +++ b/docs/nipyapi-docs/nifi_apis/parameter_contexts_api.rst @@ -0,0 +1,4 @@ +.. automodule:: nipyapi.nifi.apis.parameter_contexts_api + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/nipyapi-docs/nifi_apis/parameter_providers_api.rst b/docs/nipyapi-docs/nifi_apis/parameter_providers_api.rst new file mode 100644 index 00000000..98b3b8da --- /dev/null +++ b/docs/nipyapi-docs/nifi_apis/parameter_providers_api.rst @@ -0,0 +1,4 @@ +.. automodule:: nipyapi.nifi.apis.parameter_providers_api + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/nipyapi-docs/nifi_apis/policies_api.rst b/docs/nipyapi-docs/nifi_apis/policies_api.rst new file mode 100644 index 00000000..94c5061e --- /dev/null +++ b/docs/nipyapi-docs/nifi_apis/policies_api.rst @@ -0,0 +1,4 @@ +.. automodule:: nipyapi.nifi.apis.policies_api + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/nipyapi-docs/nifi_apis/process_groups_api.rst b/docs/nipyapi-docs/nifi_apis/process_groups_api.rst new file mode 100644 index 00000000..e9a9a545 --- /dev/null +++ b/docs/nipyapi-docs/nifi_apis/process_groups_api.rst @@ -0,0 +1,4 @@ +.. automodule:: nipyapi.nifi.apis.process_groups_api + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/nipyapi-docs/nifi_apis/processors_api.rst b/docs/nipyapi-docs/nifi_apis/processors_api.rst new file mode 100644 index 00000000..32ed4473 --- /dev/null +++ b/docs/nipyapi-docs/nifi_apis/processors_api.rst @@ -0,0 +1,4 @@ +.. automodule:: nipyapi.nifi.apis.processors_api + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/nipyapi-docs/nifi_apis/provenance_api.rst b/docs/nipyapi-docs/nifi_apis/provenance_api.rst new file mode 100644 index 00000000..706dee5d --- /dev/null +++ b/docs/nipyapi-docs/nifi_apis/provenance_api.rst @@ -0,0 +1,4 @@ +.. automodule:: nipyapi.nifi.apis.provenance_api + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/nipyapi-docs/nifi_apis/provenance_events_api.rst b/docs/nipyapi-docs/nifi_apis/provenance_events_api.rst new file mode 100644 index 00000000..ee8c364c --- /dev/null +++ b/docs/nipyapi-docs/nifi_apis/provenance_events_api.rst @@ -0,0 +1,4 @@ +.. automodule:: nipyapi.nifi.apis.provenance_events_api + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/nipyapi-docs/nifi_apis/remote_process_groups_api.rst b/docs/nipyapi-docs/nifi_apis/remote_process_groups_api.rst new file mode 100644 index 00000000..2b76f6dd --- /dev/null +++ b/docs/nipyapi-docs/nifi_apis/remote_process_groups_api.rst @@ -0,0 +1,4 @@ +.. automodule:: nipyapi.nifi.apis.remote_process_groups_api + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/nipyapi-docs/nifi_apis/reporting_tasks_api.rst b/docs/nipyapi-docs/nifi_apis/reporting_tasks_api.rst new file mode 100644 index 00000000..f5f407af --- /dev/null +++ b/docs/nipyapi-docs/nifi_apis/reporting_tasks_api.rst @@ -0,0 +1,4 @@ +.. automodule:: nipyapi.nifi.apis.reporting_tasks_api + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/nipyapi-docs/nifi_apis/resources_api.rst b/docs/nipyapi-docs/nifi_apis/resources_api.rst new file mode 100644 index 00000000..b70ced75 --- /dev/null +++ b/docs/nipyapi-docs/nifi_apis/resources_api.rst @@ -0,0 +1,4 @@ +.. automodule:: nipyapi.nifi.apis.resources_api + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/nipyapi-docs/nifi_apis/site_to_site_api.rst b/docs/nipyapi-docs/nifi_apis/site_to_site_api.rst new file mode 100644 index 00000000..a71061ec --- /dev/null +++ b/docs/nipyapi-docs/nifi_apis/site_to_site_api.rst @@ -0,0 +1,4 @@ +.. automodule:: nipyapi.nifi.apis.site_to_site_api + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/nipyapi-docs/nifi_apis/snippets_api.rst b/docs/nipyapi-docs/nifi_apis/snippets_api.rst new file mode 100644 index 00000000..2d8da5ee --- /dev/null +++ b/docs/nipyapi-docs/nifi_apis/snippets_api.rst @@ -0,0 +1,4 @@ +.. automodule:: nipyapi.nifi.apis.snippets_api + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/nipyapi-docs/nifi_apis/system_diagnostics_api.rst b/docs/nipyapi-docs/nifi_apis/system_diagnostics_api.rst new file mode 100644 index 00000000..f0074417 --- /dev/null +++ b/docs/nipyapi-docs/nifi_apis/system_diagnostics_api.rst @@ -0,0 +1,4 @@ +.. automodule:: nipyapi.nifi.apis.system_diagnostics_api + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/nipyapi-docs/nifi_apis/tenants_api.rst b/docs/nipyapi-docs/nifi_apis/tenants_api.rst new file mode 100644 index 00000000..c6abc2cf --- /dev/null +++ b/docs/nipyapi-docs/nifi_apis/tenants_api.rst @@ -0,0 +1,4 @@ +.. automodule:: nipyapi.nifi.apis.tenants_api + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/nipyapi-docs/nifi_apis/versions_api.rst b/docs/nipyapi-docs/nifi_apis/versions_api.rst new file mode 100644 index 00000000..25296613 --- /dev/null +++ b/docs/nipyapi-docs/nifi_apis/versions_api.rst @@ -0,0 +1,4 @@ +.. automodule:: nipyapi.nifi.apis.versions_api + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/nipyapi-docs/nifi_models/index.rst b/docs/nipyapi-docs/nifi_models/index.rst new file mode 100644 index 00000000..c429ebeb --- /dev/null +++ b/docs/nipyapi-docs/nifi_models/index.rst @@ -0,0 +1,10 @@ +NiFi Models +=========== + +Complete NiFi model class documentation with cross-reference support. + +.. toctree:: + :maxdepth: 1 + + models + diff --git a/docs/nipyapi-docs/nifi_models/models.rst b/docs/nipyapi-docs/nifi_models/models.rst new file mode 100644 index 00000000..82bc2596 --- /dev/null +++ b/docs/nipyapi-docs/nifi_models/models.rst @@ -0,0 +1,1600 @@ +NiFi Models +=========== + +Complete model class reference for NiFi APIs. + +This reference documents all **394** 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 +-------------------- + +**Entity Classes** (e.g., ProcessGroupEntity): Complete API objects with metadata and revision information + +**DTO Classes** (e.g., ProcessGroupDTO): Core data transfer objects containing the essential properties + +**Status Classes** (e.g., ProcessGroupStatus): Runtime status and statistics for monitoring + +**Configuration Classes**: Settings, parameters, and configuration objects + + +.. currentmodule:: nipyapi.nifi.models + +All Model Classes +------------------ + +.. autoclass:: AboutDTO + :members: + :show-inheritance: + +.. autoclass:: AboutEntity + :members: + :show-inheritance: + +.. autoclass:: AccessPolicyDTO + :members: + :show-inheritance: + +.. autoclass:: AccessPolicyEntity + :members: + :show-inheritance: + +.. autoclass:: AccessPolicySummaryDTO + :members: + :show-inheritance: + +.. autoclass:: AccessPolicySummaryEntity + :members: + :show-inheritance: + +.. autoclass:: AccessTokenBody + :members: + :show-inheritance: + +.. autoclass:: ActionDTO + :members: + :show-inheritance: + +.. autoclass:: ActionDetailsDTO + :members: + :show-inheritance: + +.. autoclass:: ActionEntity + :members: + :show-inheritance: + +.. autoclass:: ActivateControllerServicesEntity + :members: + :show-inheritance: + +.. autoclass:: AdditionalDetailsEntity + :members: + :show-inheritance: + +.. autoclass:: AffectedComponentDTO + :members: + :show-inheritance: + +.. autoclass:: AffectedComponentEntity + :members: + :show-inheritance: + +.. autoclass:: AllowableValueDTO + :members: + :show-inheritance: + +.. autoclass:: AllowableValueEntity + :members: + :show-inheritance: + +.. autoclass:: AssetDTO + :members: + :show-inheritance: + +.. autoclass:: AssetEntity + :members: + :show-inheritance: + +.. autoclass:: AssetReferenceDTO + :members: + :show-inheritance: + +.. autoclass:: AssetsEntity + :members: + :show-inheritance: + +.. autoclass:: Attribute + :members: + :show-inheritance: + +.. autoclass:: AttributeDTO + :members: + :show-inheritance: + +.. autoclass:: AuthenticationConfigurationDTO + :members: + :show-inheritance: + +.. autoclass:: AuthenticationConfigurationEntity + :members: + :show-inheritance: + +.. autoclass:: BannerDTO + :members: + :show-inheritance: + +.. autoclass:: BannerEntity + :members: + :show-inheritance: + +.. autoclass:: BatchSettingsDTO + :members: + :show-inheritance: + +.. autoclass:: BatchSize + :members: + :show-inheritance: + +.. autoclass:: BuildInfo + :members: + :show-inheritance: + +.. autoclass:: BulletinBoardDTO + :members: + :show-inheritance: + +.. autoclass:: BulletinBoardEntity + :members: + :show-inheritance: + +.. autoclass:: BulletinBoardPatternParameter + :members: + :show-inheritance: + +.. autoclass:: BulletinDTO + :members: + :show-inheritance: + +.. autoclass:: BulletinEntity + :members: + :show-inheritance: + +.. autoclass:: Bundle + :members: + :show-inheritance: + +.. autoclass:: BundleDTO + :members: + :show-inheritance: + +.. autoclass:: ClientIdParameter + :members: + :show-inheritance: + +.. autoclass:: ClusterDTO + :members: + :show-inheritance: + +.. autoclass:: ClusterEntity + :members: + :show-inheritance: + +.. autoclass:: ClusterSearchResultsEntity + :members: + :show-inheritance: + +.. autoclass:: ClusterSummaryDTO + :members: + :show-inheritance: + +.. autoclass:: ClusterSummaryEntity + :members: + :show-inheritance: + +.. autoclass:: ComponentDetailsDTO + :members: + :show-inheritance: + +.. autoclass:: ComponentDifferenceDTO + :members: + :show-inheritance: + +.. autoclass:: ComponentHistoryDTO + :members: + :show-inheritance: + +.. autoclass:: ComponentHistoryEntity + :members: + :show-inheritance: + +.. autoclass:: ComponentManifest + :members: + :show-inheritance: + +.. autoclass:: ComponentReferenceDTO + :members: + :show-inheritance: + +.. autoclass:: ComponentReferenceEntity + :members: + :show-inheritance: + +.. autoclass:: ComponentRestrictionPermissionDTO + :members: + :show-inheritance: + +.. autoclass:: ComponentSearchResultDTO + :members: + :show-inheritance: + +.. autoclass:: ComponentStateDTO + :members: + :show-inheritance: + +.. autoclass:: ComponentStateEntity + :members: + :show-inheritance: + +.. autoclass:: ComponentValidationResultDTO + :members: + :show-inheritance: + +.. autoclass:: ComponentValidationResultEntity + :members: + :show-inheritance: + +.. autoclass:: ComponentValidationResultsEntity + :members: + :show-inheritance: + +.. autoclass:: ConfigVerificationResultDTO + :members: + :show-inheritance: + +.. autoclass:: ConfigurationAnalysisDTO + :members: + :show-inheritance: + +.. autoclass:: ConfigurationAnalysisEntity + :members: + :show-inheritance: + +.. autoclass:: ConnectableComponent + :members: + :show-inheritance: + +.. autoclass:: ConnectableDTO + :members: + :show-inheritance: + +.. autoclass:: ConnectionDTO + :members: + :show-inheritance: + +.. autoclass:: ConnectionEntity + :members: + :show-inheritance: + +.. autoclass:: ConnectionStatisticsDTO + :members: + :show-inheritance: + +.. autoclass:: ConnectionStatisticsEntity + :members: + :show-inheritance: + +.. autoclass:: ConnectionStatisticsSnapshotDTO + :members: + :show-inheritance: + +.. autoclass:: ConnectionStatusDTO + :members: + :show-inheritance: + +.. autoclass:: ConnectionStatusEntity + :members: + :show-inheritance: + +.. autoclass:: ConnectionStatusPredictionsSnapshotDTO + :members: + :show-inheritance: + +.. autoclass:: ConnectionStatusSnapshotDTO + :members: + :show-inheritance: + +.. autoclass:: ConnectionStatusSnapshotEntity + :members: + :show-inheritance: + +.. autoclass:: ConnectionsEntity + :members: + :show-inheritance: + +.. autoclass:: ContentViewerDTO + :members: + :show-inheritance: + +.. autoclass:: ContentViewerEntity + :members: + :show-inheritance: + +.. autoclass:: ControllerBulletinsEntity + :members: + :show-inheritance: + +.. autoclass:: ControllerConfigurationDTO + :members: + :show-inheritance: + +.. autoclass:: ControllerConfigurationEntity + :members: + :show-inheritance: + +.. autoclass:: ControllerDTO + :members: + :show-inheritance: + +.. autoclass:: ControllerEntity + :members: + :show-inheritance: + +.. autoclass:: ControllerServiceAPI + :members: + :show-inheritance: + +.. autoclass:: ControllerServiceApiDTO + :members: + :show-inheritance: + +.. autoclass:: ControllerServiceDTO + :members: + :show-inheritance: + +.. autoclass:: ControllerServiceDefinition + :members: + :show-inheritance: + +.. autoclass:: ControllerServiceEntity + :members: + :show-inheritance: + +.. autoclass:: ControllerServiceReferencingComponentDTO + :members: + :show-inheritance: + +.. autoclass:: ControllerServiceReferencingComponentEntity + :members: + :show-inheritance: + +.. autoclass:: ControllerServiceReferencingComponentsEntity + :members: + :show-inheritance: + +.. autoclass:: ControllerServiceRunStatusEntity + :members: + :show-inheritance: + +.. autoclass:: ControllerServiceStatusDTO + :members: + :show-inheritance: + +.. autoclass:: ControllerServiceTypesEntity + :members: + :show-inheritance: + +.. autoclass:: ControllerServicesEntity + :members: + :show-inheritance: + +.. autoclass:: ControllerStatusDTO + :members: + :show-inheritance: + +.. autoclass:: ControllerStatusEntity + :members: + :show-inheritance: + +.. autoclass:: CopyRequestEntity + :members: + :show-inheritance: + +.. autoclass:: CopyResponseEntity + :members: + :show-inheritance: + +.. autoclass:: CopySnippetRequestEntity + :members: + :show-inheritance: + +.. autoclass:: CounterDTO + :members: + :show-inheritance: + +.. autoclass:: CounterEntity + :members: + :show-inheritance: + +.. autoclass:: CountersDTO + :members: + :show-inheritance: + +.. autoclass:: CountersEntity + :members: + :show-inheritance: + +.. autoclass:: CountersSnapshotDTO + :members: + :show-inheritance: + +.. autoclass:: CreateActiveRequestEntity + :members: + :show-inheritance: + +.. autoclass:: CurrentUserEntity + :members: + :show-inheritance: + +.. autoclass:: DateTimeParameter + :members: + :show-inheritance: + +.. autoclass:: DefinedType + :members: + :show-inheritance: + +.. autoclass:: DifferenceDTO + :members: + :show-inheritance: + +.. autoclass:: DimensionsDTO + :members: + :show-inheritance: + +.. autoclass:: DocumentedTypeDTO + :members: + :show-inheritance: + +.. autoclass:: DropRequestDTO + :members: + :show-inheritance: + +.. autoclass:: DropRequestEntity + :members: + :show-inheritance: + +.. autoclass:: DynamicProperty + :members: + :show-inheritance: + +.. autoclass:: DynamicRelationship + :members: + :show-inheritance: + +.. autoclass:: ExplicitRestrictionDTO + :members: + :show-inheritance: + +.. autoclass:: ExternalControllerServiceReference + :members: + :show-inheritance: + +.. autoclass:: FlowAnalysisResultEntity + :members: + :show-inheritance: + +.. autoclass:: FlowAnalysisRuleDTO + :members: + :show-inheritance: + +.. autoclass:: FlowAnalysisRuleDefinition + :members: + :show-inheritance: + +.. autoclass:: FlowAnalysisRuleEntity + :members: + :show-inheritance: + +.. autoclass:: FlowAnalysisRuleRunStatusEntity + :members: + :show-inheritance: + +.. autoclass:: FlowAnalysisRuleStatusDTO + :members: + :show-inheritance: + +.. autoclass:: FlowAnalysisRuleTypesEntity + :members: + :show-inheritance: + +.. autoclass:: FlowAnalysisRuleViolationDTO + :members: + :show-inheritance: + +.. autoclass:: FlowAnalysisRulesEntity + :members: + :show-inheritance: + +.. autoclass:: FlowBreadcrumbDTO + :members: + :show-inheritance: + +.. autoclass:: FlowBreadcrumbEntity + :members: + :show-inheritance: + +.. autoclass:: FlowComparisonEntity + :members: + :show-inheritance: + +.. autoclass:: FlowConfigurationDTO + :members: + :show-inheritance: + +.. autoclass:: FlowConfigurationEntity + :members: + :show-inheritance: + +.. autoclass:: FlowDTO + :members: + :show-inheritance: + +.. autoclass:: FlowEntity + :members: + :show-inheritance: + +.. autoclass:: FlowFileDTO + :members: + :show-inheritance: + +.. autoclass:: FlowFileEntity + :members: + :show-inheritance: + +.. autoclass:: FlowFileSummaryDTO + :members: + :show-inheritance: + +.. autoclass:: FlowRegistryBranchDTO + :members: + :show-inheritance: + +.. autoclass:: FlowRegistryBranchEntity + :members: + :show-inheritance: + +.. autoclass:: FlowRegistryBranchesEntity + :members: + :show-inheritance: + +.. autoclass:: FlowRegistryBucket + :members: + :show-inheritance: + +.. autoclass:: FlowRegistryBucketDTO + :members: + :show-inheritance: + +.. autoclass:: FlowRegistryBucketEntity + :members: + :show-inheritance: + +.. autoclass:: FlowRegistryBucketsEntity + :members: + :show-inheritance: + +.. autoclass:: FlowRegistryClientDTO + :members: + :show-inheritance: + +.. autoclass:: FlowRegistryClientEntity + :members: + :show-inheritance: + +.. autoclass:: FlowRegistryClientTypesEntity + :members: + :show-inheritance: + +.. autoclass:: FlowRegistryClientsEntity + :members: + :show-inheritance: + +.. autoclass:: FlowRegistryPermissions + :members: + :show-inheritance: + +.. autoclass:: FlowSnippetDTO + :members: + :show-inheritance: + +.. autoclass:: FunnelDTO + :members: + :show-inheritance: + +.. autoclass:: FunnelEntity + :members: + :show-inheritance: + +.. autoclass:: FunnelsEntity + :members: + :show-inheritance: + +.. autoclass:: GarbageCollectionDTO + :members: + :show-inheritance: + +.. autoclass:: HistoryDTO + :members: + :show-inheritance: + +.. autoclass:: HistoryEntity + :members: + :show-inheritance: + +.. autoclass:: InputPortsEntity + :members: + :show-inheritance: + +.. autoclass:: IntegerParameter + :members: + :show-inheritance: + +.. autoclass:: JmxMetricsResultDTO + :members: + :show-inheritance: + +.. autoclass:: JmxMetricsResultsEntity + :members: + :show-inheritance: + +.. autoclass:: LabelDTO + :members: + :show-inheritance: + +.. autoclass:: LabelEntity + :members: + :show-inheritance: + +.. autoclass:: LabelsEntity + :members: + :show-inheritance: + +.. autoclass:: LatestProvenanceEventsDTO + :members: + :show-inheritance: + +.. autoclass:: LatestProvenanceEventsEntity + :members: + :show-inheritance: + +.. autoclass:: LineageDTO + :members: + :show-inheritance: + +.. autoclass:: LineageEntity + :members: + :show-inheritance: + +.. autoclass:: LineageRequestDTO + :members: + :show-inheritance: + +.. autoclass:: LineageResultsDTO + :members: + :show-inheritance: + +.. autoclass:: ListingRequestDTO + :members: + :show-inheritance: + +.. autoclass:: ListingRequestEntity + :members: + :show-inheritance: + +.. autoclass:: LongParameter + :members: + :show-inheritance: + +.. autoclass:: MultiProcessorUseCase + :members: + :show-inheritance: + +.. autoclass:: NarCoordinateDTO + :members: + :show-inheritance: + +.. autoclass:: NarDetailsEntity + :members: + :show-inheritance: + +.. autoclass:: NarSummariesEntity + :members: + :show-inheritance: + +.. autoclass:: NarSummaryDTO + :members: + :show-inheritance: + +.. autoclass:: NarSummaryEntity + :members: + :show-inheritance: + +.. autoclass:: NodeConnectionStatisticsSnapshotDTO + :members: + :show-inheritance: + +.. autoclass:: NodeConnectionStatusSnapshotDTO + :members: + :show-inheritance: + +.. autoclass:: NodeCountersSnapshotDTO + :members: + :show-inheritance: + +.. autoclass:: NodeDTO + :members: + :show-inheritance: + +.. autoclass:: NodeEntity + :members: + :show-inheritance: + +.. autoclass:: NodeEventDTO + :members: + :show-inheritance: + +.. autoclass:: NodePortStatusSnapshotDTO + :members: + :show-inheritance: + +.. autoclass:: NodeProcessGroupStatusSnapshotDTO + :members: + :show-inheritance: + +.. autoclass:: NodeProcessorStatusSnapshotDTO + :members: + :show-inheritance: + +.. autoclass:: NodeRemoteProcessGroupStatusSnapshotDTO + :members: + :show-inheritance: + +.. autoclass:: NodeReplayLastEventSnapshotDTO + :members: + :show-inheritance: + +.. autoclass:: NodeSearchResultDTO + :members: + :show-inheritance: + +.. autoclass:: NodeStatusSnapshotsDTO + :members: + :show-inheritance: + +.. autoclass:: NodeSystemDiagnosticsSnapshotDTO + :members: + :show-inheritance: + +.. autoclass:: OutputPortsEntity + :members: + :show-inheritance: + +.. autoclass:: ParameterContextDTO + :members: + :show-inheritance: + +.. autoclass:: ParameterContextEntity + :members: + :show-inheritance: + +.. autoclass:: ParameterContextReferenceDTO + :members: + :show-inheritance: + +.. autoclass:: ParameterContextReferenceEntity + :members: + :show-inheritance: + +.. autoclass:: ParameterContextUpdateEntity + :members: + :show-inheritance: + +.. autoclass:: ParameterContextUpdateRequestDTO + :members: + :show-inheritance: + +.. autoclass:: ParameterContextUpdateRequestEntity + :members: + :show-inheritance: + +.. autoclass:: ParameterContextUpdateStepDTO + :members: + :show-inheritance: + +.. autoclass:: ParameterContextValidationRequestDTO + :members: + :show-inheritance: + +.. autoclass:: ParameterContextValidationRequestEntity + :members: + :show-inheritance: + +.. autoclass:: ParameterContextValidationStepDTO + :members: + :show-inheritance: + +.. autoclass:: ParameterContextsEntity + :members: + :show-inheritance: + +.. autoclass:: ParameterDTO + :members: + :show-inheritance: + +.. autoclass:: ParameterEntity + :members: + :show-inheritance: + +.. autoclass:: ParameterGroupConfigurationEntity + :members: + :show-inheritance: + +.. autoclass:: ParameterProviderApplyParametersRequestDTO + :members: + :show-inheritance: + +.. autoclass:: ParameterProviderApplyParametersRequestEntity + :members: + :show-inheritance: + +.. autoclass:: ParameterProviderApplyParametersUpdateStepDTO + :members: + :show-inheritance: + +.. autoclass:: ParameterProviderConfigurationDTO + :members: + :show-inheritance: + +.. autoclass:: ParameterProviderConfigurationEntity + :members: + :show-inheritance: + +.. autoclass:: ParameterProviderDTO + :members: + :show-inheritance: + +.. autoclass:: ParameterProviderDefinition + :members: + :show-inheritance: + +.. autoclass:: ParameterProviderEntity + :members: + :show-inheritance: + +.. autoclass:: ParameterProviderParameterApplicationEntity + :members: + :show-inheritance: + +.. autoclass:: ParameterProviderParameterFetchEntity + :members: + :show-inheritance: + +.. autoclass:: ParameterProviderReference + :members: + :show-inheritance: + +.. autoclass:: ParameterProviderReferencingComponentDTO + :members: + :show-inheritance: + +.. autoclass:: ParameterProviderReferencingComponentEntity + :members: + :show-inheritance: + +.. autoclass:: ParameterProviderReferencingComponentsEntity + :members: + :show-inheritance: + +.. autoclass:: ParameterProviderTypesEntity + :members: + :show-inheritance: + +.. autoclass:: ParameterProvidersEntity + :members: + :show-inheritance: + +.. autoclass:: ParameterStatusDTO + :members: + :show-inheritance: + +.. autoclass:: PasteRequestEntity + :members: + :show-inheritance: + +.. autoclass:: PasteResponseEntity + :members: + :show-inheritance: + +.. autoclass:: PeerDTO + :members: + :show-inheritance: + +.. autoclass:: PeersEntity + :members: + :show-inheritance: + +.. autoclass:: PermissionsDTO + :members: + :show-inheritance: + +.. autoclass:: PortDTO + :members: + :show-inheritance: + +.. autoclass:: PortEntity + :members: + :show-inheritance: + +.. autoclass:: PortRunStatusEntity + :members: + :show-inheritance: + +.. autoclass:: PortStatusDTO + :members: + :show-inheritance: + +.. autoclass:: PortStatusEntity + :members: + :show-inheritance: + +.. autoclass:: PortStatusSnapshotDTO + :members: + :show-inheritance: + +.. autoclass:: PortStatusSnapshotEntity + :members: + :show-inheritance: + +.. autoclass:: Position + :members: + :show-inheritance: + +.. autoclass:: PositionDTO + :members: + :show-inheritance: + +.. autoclass:: PreviousValueDTO + :members: + :show-inheritance: + +.. autoclass:: PrioritizerTypesEntity + :members: + :show-inheritance: + +.. autoclass:: ProcessGroupDTO + :members: + :show-inheritance: + +.. autoclass:: ProcessGroupEntity + :members: + :show-inheritance: + +.. autoclass:: ProcessGroupFlowDTO + :members: + :show-inheritance: + +.. autoclass:: ProcessGroupFlowEntity + :members: + :show-inheritance: + +.. autoclass:: ProcessGroupImportEntity + :members: + :show-inheritance: + +.. autoclass:: ProcessGroupNameDTO + :members: + :show-inheritance: + +.. autoclass:: ProcessGroupReplaceRequestDTO + :members: + :show-inheritance: + +.. autoclass:: ProcessGroupReplaceRequestEntity + :members: + :show-inheritance: + +.. autoclass:: ProcessGroupStatusDTO + :members: + :show-inheritance: + +.. autoclass:: ProcessGroupStatusEntity + :members: + :show-inheritance: + +.. autoclass:: ProcessGroupStatusSnapshotDTO + :members: + :show-inheritance: + +.. autoclass:: ProcessGroupStatusSnapshotEntity + :members: + :show-inheritance: + +.. autoclass:: ProcessGroupUploadEntity + :members: + :show-inheritance: + +.. autoclass:: ProcessGroupsEntity + :members: + :show-inheritance: + +.. autoclass:: ProcessgroupsUploadBody + :members: + :show-inheritance: + +.. autoclass:: ProcessingPerformanceStatusDTO + :members: + :show-inheritance: + +.. autoclass:: ProcessorConfigDTO + :members: + :show-inheritance: + +.. autoclass:: ProcessorConfiguration + :members: + :show-inheritance: + +.. autoclass:: ProcessorDTO + :members: + :show-inheritance: + +.. autoclass:: ProcessorDefinition + :members: + :show-inheritance: + +.. autoclass:: ProcessorEntity + :members: + :show-inheritance: + +.. autoclass:: ProcessorRunStatusDetailsDTO + :members: + :show-inheritance: + +.. autoclass:: ProcessorRunStatusDetailsEntity + :members: + :show-inheritance: + +.. autoclass:: ProcessorRunStatusEntity + :members: + :show-inheritance: + +.. autoclass:: ProcessorStatusDTO + :members: + :show-inheritance: + +.. autoclass:: ProcessorStatusEntity + :members: + :show-inheritance: + +.. autoclass:: ProcessorStatusSnapshotDTO + :members: + :show-inheritance: + +.. autoclass:: ProcessorStatusSnapshotEntity + :members: + :show-inheritance: + +.. autoclass:: ProcessorTypesEntity + :members: + :show-inheritance: + +.. autoclass:: ProcessorsEntity + :members: + :show-inheritance: + +.. autoclass:: ProcessorsRunStatusDetailsEntity + :members: + :show-inheritance: + +.. autoclass:: PropertyAllowableValue + :members: + :show-inheritance: + +.. autoclass:: PropertyDependency + :members: + :show-inheritance: + +.. autoclass:: PropertyDependencyDTO + :members: + :show-inheritance: + +.. autoclass:: PropertyDescriptor + :members: + :show-inheritance: + +.. autoclass:: PropertyDescriptorDTO + :members: + :show-inheritance: + +.. autoclass:: PropertyDescriptorEntity + :members: + :show-inheritance: + +.. autoclass:: PropertyHistoryDTO + :members: + :show-inheritance: + +.. autoclass:: PropertyResourceDefinition + :members: + :show-inheritance: + +.. autoclass:: ProvenanceDTO + :members: + :show-inheritance: + +.. autoclass:: ProvenanceEntity + :members: + :show-inheritance: + +.. autoclass:: ProvenanceEventDTO + :members: + :show-inheritance: + +.. autoclass:: ProvenanceEventEntity + :members: + :show-inheritance: + +.. autoclass:: ProvenanceLinkDTO + :members: + :show-inheritance: + +.. autoclass:: ProvenanceNodeDTO + :members: + :show-inheritance: + +.. autoclass:: ProvenanceOptionsDTO + :members: + :show-inheritance: + +.. autoclass:: ProvenanceOptionsEntity + :members: + :show-inheritance: + +.. autoclass:: ProvenanceRequestDTO + :members: + :show-inheritance: + +.. autoclass:: ProvenanceResultsDTO + :members: + :show-inheritance: + +.. autoclass:: ProvenanceSearchValueDTO + :members: + :show-inheritance: + +.. autoclass:: ProvenanceSearchableFieldDTO + :members: + :show-inheritance: + +.. autoclass:: QueueSizeDTO + :members: + :show-inheritance: + +.. autoclass:: RegisteredFlow + :members: + :show-inheritance: + +.. autoclass:: RegisteredFlowSnapshot + :members: + :show-inheritance: + +.. autoclass:: RegisteredFlowSnapshotMetadata + :members: + :show-inheritance: + +.. autoclass:: RegisteredFlowVersionInfo + :members: + :show-inheritance: + +.. autoclass:: Relationship + :members: + :show-inheritance: + +.. autoclass:: RelationshipDTO + :members: + :show-inheritance: + +.. autoclass:: RemotePortRunStatusEntity + :members: + :show-inheritance: + +.. autoclass:: RemoteProcessGroupContentsDTO + :members: + :show-inheritance: + +.. autoclass:: RemoteProcessGroupDTO + :members: + :show-inheritance: + +.. autoclass:: RemoteProcessGroupEntity + :members: + :show-inheritance: + +.. autoclass:: RemoteProcessGroupPortDTO + :members: + :show-inheritance: + +.. autoclass:: RemoteProcessGroupPortEntity + :members: + :show-inheritance: + +.. autoclass:: RemoteProcessGroupStatusDTO + :members: + :show-inheritance: + +.. autoclass:: RemoteProcessGroupStatusEntity + :members: + :show-inheritance: + +.. autoclass:: RemoteProcessGroupStatusSnapshotDTO + :members: + :show-inheritance: + +.. autoclass:: RemoteProcessGroupStatusSnapshotEntity + :members: + :show-inheritance: + +.. autoclass:: RemoteProcessGroupsEntity + :members: + :show-inheritance: + +.. autoclass:: ReplayLastEventRequestEntity + :members: + :show-inheritance: + +.. autoclass:: ReplayLastEventResponseEntity + :members: + :show-inheritance: + +.. autoclass:: ReplayLastEventSnapshotDTO + :members: + :show-inheritance: + +.. autoclass:: ReportingTaskDTO + :members: + :show-inheritance: + +.. autoclass:: ReportingTaskDefinition + :members: + :show-inheritance: + +.. autoclass:: ReportingTaskEntity + :members: + :show-inheritance: + +.. autoclass:: ReportingTaskRunStatusEntity + :members: + :show-inheritance: + +.. autoclass:: ReportingTaskStatusDTO + :members: + :show-inheritance: + +.. autoclass:: ReportingTaskTypesEntity + :members: + :show-inheritance: + +.. autoclass:: ReportingTasksEntity + :members: + :show-inheritance: + +.. autoclass:: RequiredPermissionDTO + :members: + :show-inheritance: + +.. autoclass:: ResourceClaimDetailsDTO + :members: + :show-inheritance: + +.. autoclass:: ResourceDTO + :members: + :show-inheritance: + +.. autoclass:: ResourcesEntity + :members: + :show-inheritance: + +.. autoclass:: Restriction + :members: + :show-inheritance: + +.. autoclass:: RevisionDTO + :members: + :show-inheritance: + +.. autoclass:: RunStatusDetailsRequestEntity + :members: + :show-inheritance: + +.. autoclass:: RuntimeManifest + :members: + :show-inheritance: + +.. autoclass:: RuntimeManifestEntity + :members: + :show-inheritance: + +.. autoclass:: ScheduleComponentsEntity + :members: + :show-inheritance: + +.. autoclass:: SchedulingDefaults + :members: + :show-inheritance: + +.. autoclass:: SearchResultGroupDTO + :members: + :show-inheritance: + +.. autoclass:: SearchResultsDTO + :members: + :show-inheritance: + +.. autoclass:: SearchResultsEntity + :members: + :show-inheritance: + +.. autoclass:: SnippetDTO + :members: + :show-inheritance: + +.. autoclass:: SnippetEntity + :members: + :show-inheritance: + +.. autoclass:: StartVersionControlRequestEntity + :members: + :show-inheritance: + +.. autoclass:: StateEntryDTO + :members: + :show-inheritance: + +.. autoclass:: StateMapDTO + :members: + :show-inheritance: + +.. autoclass:: Stateful + :members: + :show-inheritance: + +.. autoclass:: StatusDescriptorDTO + :members: + :show-inheritance: + +.. autoclass:: StatusHistoryDTO + :members: + :show-inheritance: + +.. autoclass:: StatusHistoryEntity + :members: + :show-inheritance: + +.. autoclass:: StatusSnapshotDTO + :members: + :show-inheritance: + +.. autoclass:: StorageUsageDTO + :members: + :show-inheritance: + +.. autoclass:: StreamingOutput + :members: + :show-inheritance: + +.. autoclass:: SubmitReplayRequestEntity + :members: + :show-inheritance: + +.. autoclass:: SupportedMimeTypesDTO + :members: + :show-inheritance: + +.. autoclass:: SystemDiagnosticsDTO + :members: + :show-inheritance: + +.. autoclass:: SystemDiagnosticsEntity + :members: + :show-inheritance: + +.. autoclass:: SystemDiagnosticsSnapshotDTO + :members: + :show-inheritance: + +.. autoclass:: SystemResourceConsideration + :members: + :show-inheritance: + +.. autoclass:: TenantDTO + :members: + :show-inheritance: + +.. autoclass:: TenantEntity + :members: + :show-inheritance: + +.. autoclass:: TenantsEntity + :members: + :show-inheritance: + +.. autoclass:: TransactionResultEntity + :members: + :show-inheritance: + +.. autoclass:: UpdateControllerServiceReferenceRequestEntity + :members: + :show-inheritance: + +.. autoclass:: UseCase + :members: + :show-inheritance: + +.. autoclass:: UserDTO + :members: + :show-inheritance: + +.. autoclass:: UserEntity + :members: + :show-inheritance: + +.. autoclass:: UserGroupDTO + :members: + :show-inheritance: + +.. autoclass:: UserGroupEntity + :members: + :show-inheritance: + +.. autoclass:: UserGroupsEntity + :members: + :show-inheritance: + +.. autoclass:: UsersEntity + :members: + :show-inheritance: + +.. autoclass:: VerifyConfigRequestDTO + :members: + :show-inheritance: + +.. autoclass:: VerifyConfigRequestEntity + :members: + :show-inheritance: + +.. autoclass:: VerifyConfigUpdateStepDTO + :members: + :show-inheritance: + +.. autoclass:: VersionControlComponentMappingEntity + :members: + :show-inheritance: + +.. autoclass:: VersionControlInformationDTO + :members: + :show-inheritance: + +.. autoclass:: VersionControlInformationEntity + :members: + :show-inheritance: + +.. autoclass:: VersionInfoDTO + :members: + :show-inheritance: + +.. autoclass:: VersionedAsset + :members: + :show-inheritance: + +.. autoclass:: VersionedConnection + :members: + :show-inheritance: + +.. autoclass:: VersionedControllerService + :members: + :show-inheritance: + +.. autoclass:: VersionedFlowCoordinates + :members: + :show-inheritance: + +.. autoclass:: VersionedFlowDTO + :members: + :show-inheritance: + +.. autoclass:: VersionedFlowEntity + :members: + :show-inheritance: + +.. autoclass:: VersionedFlowSnapshotEntity + :members: + :show-inheritance: + +.. autoclass:: VersionedFlowSnapshotMetadataEntity + :members: + :show-inheritance: + +.. autoclass:: VersionedFlowSnapshotMetadataSetEntity + :members: + :show-inheritance: + +.. autoclass:: VersionedFlowUpdateRequestDTO + :members: + :show-inheritance: + +.. autoclass:: VersionedFlowUpdateRequestEntity + :members: + :show-inheritance: + +.. autoclass:: VersionedFlowsEntity + :members: + :show-inheritance: + +.. autoclass:: VersionedFunnel + :members: + :show-inheritance: + +.. autoclass:: VersionedLabel + :members: + :show-inheritance: + +.. autoclass:: VersionedParameter + :members: + :show-inheritance: + +.. autoclass:: VersionedParameterContext + :members: + :show-inheritance: + +.. autoclass:: VersionedPort + :members: + :show-inheritance: + +.. autoclass:: VersionedProcessGroup + :members: + :show-inheritance: + +.. autoclass:: VersionedProcessor + :members: + :show-inheritance: + +.. autoclass:: VersionedPropertyDescriptor + :members: + :show-inheritance: + +.. autoclass:: VersionedRemoteGroupPort + :members: + :show-inheritance: + +.. autoclass:: VersionedRemoteProcessGroup + :members: + :show-inheritance: + +.. autoclass:: VersionedReportingTask + :members: + :show-inheritance: + +.. autoclass:: VersionedReportingTaskImportRequestEntity + :members: + :show-inheritance: + +.. autoclass:: VersionedReportingTaskImportResponseEntity + :members: + :show-inheritance: + +.. autoclass:: VersionedReportingTaskSnapshot + :members: + :show-inheritance: + +.. autoclass:: VersionedResourceDefinition + :members: + :show-inheritance: + diff --git a/docs/nipyapi-docs/nipyapi.demo.rst b/docs/nipyapi-docs/nipyapi.demo.rst deleted file mode 100644 index 28d3cf44..00000000 --- a/docs/nipyapi-docs/nipyapi.demo.rst +++ /dev/null @@ -1,48 +0,0 @@ -FDLC ----- - -Importing this module provides further instructions for it's use. -It will guide you through the steps involved in flow promotion. - -Note that it makes extensive use of Docker Containers. - -Usage:: - - from nipyapi.demo.fdlc import * - -Console -------- - -Importing this module will run a script which populates the NiFi canvas with a -Process Group containing a processor, and creates a sequence of Versioned -Flow Objects from it, along with a Template and various export versions. - -This is intended to give the user a base set of objects to explore the API. - -Usage:: - - from nipyapi.demo.console import * - -Secured Connection ------------------- - -Importing this module will pull recent Docker containers from Dockerhub, deploy -them in a secured configuration, and prepare the environment for access via -TLS in NiFi-Registry's case, and public LDAP username/password for NiFi. - -This is intended to give the user an example of a secured environment. -May be combined with the Console to produce a secured environment with demo -objects. - -Note that this demo makes extensive use of Docker Containers. - -Usage:: - - from nipyapi.demo.secured_connection import * - - -bbende How Do I Deploy My Flow ------------------------------- - -An incomplete version of BBende's excellent demo. -It currently deploys some Docker NiFi and Registry instances. diff --git a/docs/nipyapi-docs/nipyapi.nifi.apis.rst b/docs/nipyapi-docs/nipyapi.nifi.apis.rst deleted file mode 100644 index ccdd8dd4..00000000 --- a/docs/nipyapi-docs/nipyapi.nifi.apis.rst +++ /dev/null @@ -1,221 +0,0 @@ -nipyapi.nifi.apis package -========================= - -Submodules ----------- - -nipyapi.nifi.apis.access\_api module ------------------------------------- - -.. automodule:: nipyapi.nifi.apis.access_api - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.apis.connections\_api module ------------------------------------------ - -.. automodule:: nipyapi.nifi.apis.connections_api - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.apis.controller\_api module ----------------------------------------- - -.. automodule:: nipyapi.nifi.apis.controller_api - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.apis.controller\_services\_api module --------------------------------------------------- - -.. automodule:: nipyapi.nifi.apis.controller_services_api - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.apis.counters\_api module --------------------------------------- - -.. automodule:: nipyapi.nifi.apis.counters_api - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.apis.data\_transfer\_api module --------------------------------------------- - -.. automodule:: nipyapi.nifi.apis.data_transfer_api - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.apis.flow\_api module ----------------------------------- - -.. automodule:: nipyapi.nifi.apis.flow_api - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.apis.flowfile\_queues\_api module ----------------------------------------------- - -.. automodule:: nipyapi.nifi.apis.flowfile_queues_api - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.apis.funnel\_api module ------------------------------------- - -.. automodule:: nipyapi.nifi.apis.funnel_api - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.apis.input\_ports\_api module ------------------------------------------- - -.. automodule:: nipyapi.nifi.apis.input_ports_api - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.apis.labels\_api module ------------------------------------- - -.. automodule:: nipyapi.nifi.apis.labels_api - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.apis.output\_ports\_api module -------------------------------------------- - -.. automodule:: nipyapi.nifi.apis.output_ports_api - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.apis.parameter\_contexts\_api module -------------------------------------------------- - -.. automodule:: nipyapi.nifi.apis.parameter_contexts_api - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.apis.policies\_api module --------------------------------------- - -.. automodule:: nipyapi.nifi.apis.policies_api - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.apis.process\_groups\_api module ---------------------------------------------- - -.. automodule:: nipyapi.nifi.apis.process_groups_api - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.apis.processors\_api module ----------------------------------------- - -.. automodule:: nipyapi.nifi.apis.processors_api - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.apis.provenance\_api module ----------------------------------------- - -.. automodule:: nipyapi.nifi.apis.provenance_api - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.apis.provenance\_events\_api module ------------------------------------------------- - -.. automodule:: nipyapi.nifi.apis.provenance_events_api - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.apis.remote\_process\_groups\_api module ------------------------------------------------------ - -.. automodule:: nipyapi.nifi.apis.remote_process_groups_api - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.apis.reporting\_tasks\_api module ----------------------------------------------- - -.. automodule:: nipyapi.nifi.apis.reporting_tasks_api - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.apis.resources\_api module ---------------------------------------- - -.. automodule:: nipyapi.nifi.apis.resources_api - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.apis.site\_to\_site\_api module --------------------------------------------- - -.. automodule:: nipyapi.nifi.apis.site_to_site_api - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.apis.snippets\_api module --------------------------------------- - -.. automodule:: nipyapi.nifi.apis.snippets_api - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.apis.system\_diagnostics\_api module -------------------------------------------------- - -.. automodule:: nipyapi.nifi.apis.system_diagnostics_api - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.apis.templates\_api module ---------------------------------------- - -.. automodule:: nipyapi.nifi.apis.templates_api - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.apis.tenants\_api module -------------------------------------- - -.. automodule:: nipyapi.nifi.apis.tenants_api - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.apis.versions\_api module --------------------------------------- - -.. automodule:: nipyapi.nifi.apis.versions_api - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/nipyapi-docs/nipyapi.nifi.models.rst b/docs/nipyapi-docs/nipyapi.nifi.models.rst deleted file mode 100644 index f9a9c175..00000000 --- a/docs/nipyapi-docs/nipyapi.nifi.models.rst +++ /dev/null @@ -1,1990 +0,0 @@ -nipyapi.nifi.models package -=========================== - -Submodules ----------- - -nipyapi.nifi.models.about\_dto module -------------------------------------- - -.. automodule:: nipyapi.nifi.models.about_dto - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.models.about\_entity module ----------------------------------------- - -.. automodule:: nipyapi.nifi.models.about_entity - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.models.access\_configuration\_dto module ------------------------------------------------------ - -.. automodule:: nipyapi.nifi.models.access_configuration_dto - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.models.access\_configuration\_entity module --------------------------------------------------------- - -.. automodule:: nipyapi.nifi.models.access_configuration_entity - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.models.access\_policy\_dto module ----------------------------------------------- - -.. automodule:: nipyapi.nifi.models.access_policy_dto - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.models.access\_policy\_entity module -------------------------------------------------- - -.. automodule:: nipyapi.nifi.models.access_policy_entity - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.models.access\_policy\_summary\_dto module -------------------------------------------------------- - -.. automodule:: nipyapi.nifi.models.access_policy_summary_dto - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.models.access\_policy\_summary\_entity module ----------------------------------------------------------- - -.. automodule:: nipyapi.nifi.models.access_policy_summary_entity - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.models.access\_status\_dto module ----------------------------------------------- - -.. automodule:: nipyapi.nifi.models.access_status_dto - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.models.access\_status\_entity module -------------------------------------------------- - -.. automodule:: nipyapi.nifi.models.access_status_entity - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.models.action\_details\_dto module ------------------------------------------------ - -.. automodule:: nipyapi.nifi.models.action_details_dto - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.models.action\_dto module --------------------------------------- - -.. automodule:: nipyapi.nifi.models.action_dto - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.models.action\_entity module ------------------------------------------ - -.. automodule:: nipyapi.nifi.models.action_entity - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.models.activate\_controller\_services\_entity module ------------------------------------------------------------------ - -.. automodule:: nipyapi.nifi.models.activate_controller_services_entity - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.models.affected\_component\_dto module ---------------------------------------------------- - -.. automodule:: nipyapi.nifi.models.affected_component_dto - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.models.affected\_component\_entity module ------------------------------------------------------- - -.. automodule:: nipyapi.nifi.models.affected_component_entity - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.models.allowable\_value\_dto module ------------------------------------------------- - -.. automodule:: nipyapi.nifi.models.allowable_value_dto - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.models.allowable\_value\_entity module ---------------------------------------------------- - -.. automodule:: nipyapi.nifi.models.allowable_value_entity - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.models.attribute\_dto module ------------------------------------------ - -.. automodule:: nipyapi.nifi.models.attribute_dto - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.models.banner\_dto module --------------------------------------- - -.. automodule:: nipyapi.nifi.models.banner_dto - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.models.banner\_entity module ------------------------------------------ - -.. automodule:: nipyapi.nifi.models.banner_entity - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.models.batch\_settings\_dto module ------------------------------------------------ - -.. automodule:: nipyapi.nifi.models.batch_settings_dto - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.models.batch\_size module --------------------------------------- - -.. automodule:: nipyapi.nifi.models.batch_size - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.models.bulletin\_board\_dto module ------------------------------------------------ - -.. automodule:: nipyapi.nifi.models.bulletin_board_dto - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.models.bulletin\_board\_entity module --------------------------------------------------- - -.. automodule:: nipyapi.nifi.models.bulletin_board_entity - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.models.bulletin\_dto module ----------------------------------------- - -.. automodule:: nipyapi.nifi.models.bulletin_dto - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.models.bulletin\_entity module -------------------------------------------- - -.. automodule:: nipyapi.nifi.models.bulletin_entity - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.models.bundle module ---------------------------------- - -.. automodule:: nipyapi.nifi.models.bundle - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.models.bundle\_dto module --------------------------------------- - -.. automodule:: nipyapi.nifi.models.bundle_dto - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.models.cluste\_summary\_entity module --------------------------------------------------- - -.. automodule:: nipyapi.nifi.models.cluste_summary_entity - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.models.cluster\_dto module ---------------------------------------- - -.. automodule:: nipyapi.nifi.models.cluster_dto - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.models.cluster\_entity module ------------------------------------------- - -.. automodule:: nipyapi.nifi.models.cluster_entity - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.models.cluster\_search\_results\_entity module ------------------------------------------------------------ - -.. automodule:: nipyapi.nifi.models.cluster_search_results_entity - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.models.cluster\_summary\_dto module ------------------------------------------------- - -.. automodule:: nipyapi.nifi.models.cluster_summary_dto - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.models.component\_details\_dto module --------------------------------------------------- - -.. automodule:: nipyapi.nifi.models.component_details_dto - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.models.component\_difference\_dto module ------------------------------------------------------ - -.. automodule:: nipyapi.nifi.models.component_difference_dto - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.models.component\_history\_dto module --------------------------------------------------- - -.. automodule:: nipyapi.nifi.models.component_history_dto - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.models.component\_history\_entity module ------------------------------------------------------ - -.. automodule:: nipyapi.nifi.models.component_history_entity - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.models.component\_reference\_dto module ----------------------------------------------------- - -.. automodule:: nipyapi.nifi.models.component_reference_dto - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.models.component\_reference\_entity module -------------------------------------------------------- - -.. automodule:: nipyapi.nifi.models.component_reference_entity - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.models.component\_search\_result\_dto module ---------------------------------------------------------- - -.. automodule:: nipyapi.nifi.models.component_search_result_dto - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.models.component\_state\_dto module ------------------------------------------------- - -.. automodule:: nipyapi.nifi.models.component_state_dto - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.models.component\_state\_entity module ---------------------------------------------------- - -.. automodule:: nipyapi.nifi.models.component_state_entity - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.models.connectable\_component module -------------------------------------------------- - -.. automodule:: nipyapi.nifi.models.connectable_component - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.models.connectable\_dto module -------------------------------------------- - -.. automodule:: nipyapi.nifi.models.connectable_dto - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.models.connection\_dto module ------------------------------------------- - -.. automodule:: nipyapi.nifi.models.connection_dto - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.models.connection\_entity module ---------------------------------------------- - -.. automodule:: nipyapi.nifi.models.connection_entity - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.models.connection\_status\_dto module --------------------------------------------------- - -.. automodule:: nipyapi.nifi.models.connection_status_dto - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.models.connection\_status\_entity module ------------------------------------------------------ - -.. automodule:: nipyapi.nifi.models.connection_status_entity - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.models.connection\_status\_snapshot\_dto module ------------------------------------------------------------- - -.. automodule:: nipyapi.nifi.models.connection_status_snapshot_dto - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.models.connection\_status\_snapshot\_entity module ---------------------------------------------------------------- - -.. automodule:: nipyapi.nifi.models.connection_status_snapshot_entity - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.models.connections\_entity module ----------------------------------------------- - -.. automodule:: nipyapi.nifi.models.connections_entity - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.models.controller\_bulletins\_entity module --------------------------------------------------------- - -.. automodule:: nipyapi.nifi.models.controller_bulletins_entity - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.models.controller\_configuration\_dto module ---------------------------------------------------------- - -.. automodule:: nipyapi.nifi.models.controller_configuration_dto - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.models.controller\_configuration\_entity module ------------------------------------------------------------- - -.. automodule:: nipyapi.nifi.models.controller_configuration_entity - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.models.controller\_dto module ------------------------------------------- - -.. automodule:: nipyapi.nifi.models.controller_dto - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.models.controller\_entity module ---------------------------------------------- - -.. automodule:: nipyapi.nifi.models.controller_entity - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.models.controller\_service\_api module ---------------------------------------------------- - -.. automodule:: nipyapi.nifi.models.controller_service_api - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.models.controller\_service\_api\_dto module --------------------------------------------------------- - -.. automodule:: nipyapi.nifi.models.controller_service_api_dto - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.models.controller\_service\_dto module ---------------------------------------------------- - -.. automodule:: nipyapi.nifi.models.controller_service_dto - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.models.controller\_service\_entity module ------------------------------------------------------- - -.. automodule:: nipyapi.nifi.models.controller_service_entity - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.models.controller\_service\_referencing\_component\_dto module ---------------------------------------------------------------------------- - -.. automodule:: nipyapi.nifi.models.controller_service_referencing_component_dto - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.models.controller\_service\_referencing\_component\_entity module ------------------------------------------------------------------------------- - -.. automodule:: nipyapi.nifi.models.controller_service_referencing_component_entity - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.models.controller\_service\_referencing\_components\_entity module -------------------------------------------------------------------------------- - -.. automodule:: nipyapi.nifi.models.controller_service_referencing_components_entity - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.models.controller\_service\_types\_entity module -------------------------------------------------------------- - -.. automodule:: nipyapi.nifi.models.controller_service_types_entity - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.models.controller\_services\_entity module -------------------------------------------------------- - -.. automodule:: nipyapi.nifi.models.controller_services_entity - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.models.controller\_status\_dto module --------------------------------------------------- - -.. automodule:: nipyapi.nifi.models.controller_status_dto - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.models.controller\_status\_entity module ------------------------------------------------------ - -.. automodule:: nipyapi.nifi.models.controller_status_entity - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.models.copy\_snippet\_request\_entity module ---------------------------------------------------------- - -.. automodule:: nipyapi.nifi.models.copy_snippet_request_entity - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.models.counter\_dto module ---------------------------------------- - -.. automodule:: nipyapi.nifi.models.counter_dto - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.models.counter\_entity module ------------------------------------------- - -.. automodule:: nipyapi.nifi.models.counter_entity - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.models.counters\_dto module ----------------------------------------- - -.. automodule:: nipyapi.nifi.models.counters_dto - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.models.counters\_entity module -------------------------------------------- - -.. automodule:: nipyapi.nifi.models.counters_entity - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.models.counters\_snapshot\_dto module --------------------------------------------------- - -.. automodule:: nipyapi.nifi.models.counters_snapshot_dto - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.models.create\_active\_request\_entity module ----------------------------------------------------------- - -.. automodule:: nipyapi.nifi.models.create_active_request_entity - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.models.create\_template\_request\_entity module ------------------------------------------------------------- - -.. automodule:: nipyapi.nifi.models.create_template_request_entity - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.models.current\_user\_entity module ------------------------------------------------- - -.. automodule:: nipyapi.nifi.models.current_user_entity - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.models.difference\_dto module ------------------------------------------- - -.. automodule:: nipyapi.nifi.models.difference_dto - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.models.dimensions\_dto module ------------------------------------------- - -.. automodule:: nipyapi.nifi.models.dimensions_dto - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.models.documented\_type\_dto module ------------------------------------------------- - -.. automodule:: nipyapi.nifi.models.documented_type_dto - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.models.drop\_request\_dto module ---------------------------------------------- - -.. automodule:: nipyapi.nifi.models.drop_request_dto - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.models.drop\_request\_entity module ------------------------------------------------- - -.. automodule:: nipyapi.nifi.models.drop_request_entity - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.models.flow\_breadcrumb\_dto module ------------------------------------------------- - -.. automodule:: nipyapi.nifi.models.flow_breadcrumb_dto - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.models.flow\_breadcrumb\_entity module ---------------------------------------------------- - -.. automodule:: nipyapi.nifi.models.flow_breadcrumb_entity - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.models.flow\_comparison\_entity module ---------------------------------------------------- - -.. automodule:: nipyapi.nifi.models.flow_comparison_entity - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.models.flow\_configuration\_dto module ---------------------------------------------------- - -.. automodule:: nipyapi.nifi.models.flow_configuration_dto - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.models.flow\_configuration\_entity module ------------------------------------------------------- - -.. automodule:: nipyapi.nifi.models.flow_configuration_entity - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.models.flow\_dto module ------------------------------------- - -.. automodule:: nipyapi.nifi.models.flow_dto - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.models.flow\_entity module ---------------------------------------- - -.. automodule:: nipyapi.nifi.models.flow_entity - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.models.flow\_file\_dto module ------------------------------------------- - -.. automodule:: nipyapi.nifi.models.flow_file_dto - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.models.flow\_file\_entity module ---------------------------------------------- - -.. automodule:: nipyapi.nifi.models.flow_file_entity - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.models.flow\_file\_summary\_dto module ---------------------------------------------------- - -.. automodule:: nipyapi.nifi.models.flow_file_summary_dto - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.models.flow\_snippet\_dto module ---------------------------------------------- - -.. automodule:: nipyapi.nifi.models.flow_snippet_dto - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.models.funnel\_dto module --------------------------------------- - -.. automodule:: nipyapi.nifi.models.funnel_dto - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.models.funnel\_entity module ------------------------------------------ - -.. automodule:: nipyapi.nifi.models.funnel_entity - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.models.funnels\_entity module ------------------------------------------- - -.. automodule:: nipyapi.nifi.models.funnels_entity - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.models.garbage\_collection\_dto module ---------------------------------------------------- - -.. automodule:: nipyapi.nifi.models.garbage_collection_dto - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.models.history\_dto module ---------------------------------------- - -.. automodule:: nipyapi.nifi.models.history_dto - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.models.history\_entity module ------------------------------------------- - -.. automodule:: nipyapi.nifi.models.history_entity - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.models.input\_ports\_entity module ------------------------------------------------ - -.. automodule:: nipyapi.nifi.models.input_ports_entity - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.models.instantiate\_template\_request\_entity module ------------------------------------------------------------------ - -.. automodule:: nipyapi.nifi.models.instantiate_template_request_entity - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.models.label\_dto module -------------------------------------- - -.. automodule:: nipyapi.nifi.models.label_dto - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.models.label\_entity module ----------------------------------------- - -.. automodule:: nipyapi.nifi.models.label_entity - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.models.labels\_entity module ------------------------------------------ - -.. automodule:: nipyapi.nifi.models.labels_entity - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.models.lineage\_dto module ---------------------------------------- - -.. automodule:: nipyapi.nifi.models.lineage_dto - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.models.lineage\_entity module ------------------------------------------- - -.. automodule:: nipyapi.nifi.models.lineage_entity - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.models.lineage\_request\_dto module ------------------------------------------------- - -.. automodule:: nipyapi.nifi.models.lineage_request_dto - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.models.lineage\_results\_dto module ------------------------------------------------- - -.. automodule:: nipyapi.nifi.models.lineage_results_dto - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.models.listing\_request\_dto module ------------------------------------------------- - -.. automodule:: nipyapi.nifi.models.listing_request_dto - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.models.listing\_request\_entity module ---------------------------------------------------- - -.. automodule:: nipyapi.nifi.models.listing_request_entity - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.models.node\_connection\_status\_snapshot\_dto module ------------------------------------------------------------------- - -.. automodule:: nipyapi.nifi.models.node_connection_status_snapshot_dto - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.models.node\_counters\_snapshot\_dto module --------------------------------------------------------- - -.. automodule:: nipyapi.nifi.models.node_counters_snapshot_dto - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.models.node\_dto module ------------------------------------- - -.. automodule:: nipyapi.nifi.models.node_dto - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.models.node\_entity module ---------------------------------------- - -.. automodule:: nipyapi.nifi.models.node_entity - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.models.node\_event\_dto module -------------------------------------------- - -.. automodule:: nipyapi.nifi.models.node_event_dto - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.models.node\_port\_status\_snapshot\_dto module ------------------------------------------------------------- - -.. automodule:: nipyapi.nifi.models.node_port_status_snapshot_dto - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.models.node\_process\_group\_status\_snapshot\_dto module ----------------------------------------------------------------------- - -.. automodule:: nipyapi.nifi.models.node_process_group_status_snapshot_dto - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.models.node\_processor\_status\_snapshot\_dto module ------------------------------------------------------------------ - -.. automodule:: nipyapi.nifi.models.node_processor_status_snapshot_dto - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.models.node\_remote\_process\_group\_status\_snapshot\_dto module ------------------------------------------------------------------------------- - -.. automodule:: nipyapi.nifi.models.node_remote_process_group_status_snapshot_dto - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.models.node\_search\_result\_dto module ----------------------------------------------------- - -.. automodule:: nipyapi.nifi.models.node_search_result_dto - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.models.node\_status\_snapshots\_dto module -------------------------------------------------------- - -.. automodule:: nipyapi.nifi.models.node_status_snapshots_dto - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.models.node\_system\_diagnostics\_snapshot\_dto module -------------------------------------------------------------------- - -.. automodule:: nipyapi.nifi.models.node_system_diagnostics_snapshot_dto - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.models.output\_ports\_entity module ------------------------------------------------- - -.. automodule:: nipyapi.nifi.models.output_ports_entity - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.models.peer\_dto module ------------------------------------- - -.. automodule:: nipyapi.nifi.models.peer_dto - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.models.peers\_entity module ----------------------------------------- - -.. automodule:: nipyapi.nifi.models.peers_entity - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.models.permissions\_dto module -------------------------------------------- - -.. automodule:: nipyapi.nifi.models.permissions_dto - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.models.port\_dto module ------------------------------------- - -.. automodule:: nipyapi.nifi.models.port_dto - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.models.port\_entity module ---------------------------------------- - -.. automodule:: nipyapi.nifi.models.port_entity - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.models.port\_status\_dto module --------------------------------------------- - -.. automodule:: nipyapi.nifi.models.port_status_dto - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.models.port\_status\_entity module ------------------------------------------------ - -.. automodule:: nipyapi.nifi.models.port_status_entity - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.models.port\_status\_snapshot\_dto module ------------------------------------------------------- - -.. automodule:: nipyapi.nifi.models.port_status_snapshot_dto - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.models.port\_status\_snapshot\_entity module ---------------------------------------------------------- - -.. automodule:: nipyapi.nifi.models.port_status_snapshot_entity - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.models.position\_dto module ----------------------------------------- - -.. automodule:: nipyapi.nifi.models.position_dto - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.models.previous\_value\_dto module ------------------------------------------------ - -.. automodule:: nipyapi.nifi.models.previous_value_dto - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.models.prioritizer\_types\_entity module ------------------------------------------------------ - -.. automodule:: nipyapi.nifi.models.prioritizer_types_entity - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.models.process\_group\_dto module ----------------------------------------------- - -.. automodule:: nipyapi.nifi.models.process_group_dto - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.models.process\_group\_entity module -------------------------------------------------- - -.. automodule:: nipyapi.nifi.models.process_group_entity - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.models.process\_group\_flow\_dto module ----------------------------------------------------- - -.. automodule:: nipyapi.nifi.models.process_group_flow_dto - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.models.process\_group\_flow\_entity module -------------------------------------------------------- - -.. automodule:: nipyapi.nifi.models.process_group_flow_entity - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.models.process\_group\_status\_dto module ------------------------------------------------------- - -.. automodule:: nipyapi.nifi.models.process_group_status_dto - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.models.process\_group\_status\_entity module ---------------------------------------------------------- - -.. automodule:: nipyapi.nifi.models.process_group_status_entity - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.models.process\_group\_status\_snapshot\_dto module ----------------------------------------------------------------- - -.. automodule:: nipyapi.nifi.models.process_group_status_snapshot_dto - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.models.process\_group\_status\_snapshot\_entity module -------------------------------------------------------------------- - -.. automodule:: nipyapi.nifi.models.process_group_status_snapshot_entity - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.models.process\_groups\_entity module --------------------------------------------------- - -.. automodule:: nipyapi.nifi.models.process_groups_entity - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.models.processor\_config\_dto module -------------------------------------------------- - -.. automodule:: nipyapi.nifi.models.processor_config_dto - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.models.processor\_dto module ------------------------------------------ - -.. automodule:: nipyapi.nifi.models.processor_dto - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.models.processor\_entity module --------------------------------------------- - -.. automodule:: nipyapi.nifi.models.processor_entity - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.models.processor\_status\_dto module -------------------------------------------------- - -.. automodule:: nipyapi.nifi.models.processor_status_dto - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.models.processor\_status\_entity module ----------------------------------------------------- - -.. automodule:: nipyapi.nifi.models.processor_status_entity - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.models.processor\_status\_snapshot\_dto module ------------------------------------------------------------ - -.. automodule:: nipyapi.nifi.models.processor_status_snapshot_dto - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.models.processor\_status\_snapshot\_entity module --------------------------------------------------------------- - -.. automodule:: nipyapi.nifi.models.processor_status_snapshot_entity - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.models.processor\_types\_entity module ---------------------------------------------------- - -.. automodule:: nipyapi.nifi.models.processor_types_entity - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.models.processors\_entity module ---------------------------------------------- - -.. automodule:: nipyapi.nifi.models.processors_entity - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.models.property\_descriptor\_dto module ----------------------------------------------------- - -.. automodule:: nipyapi.nifi.models.property_descriptor_dto - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.models.property\_descriptor\_entity module -------------------------------------------------------- - -.. automodule:: nipyapi.nifi.models.property_descriptor_entity - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.models.property\_history\_dto module -------------------------------------------------- - -.. automodule:: nipyapi.nifi.models.property_history_dto - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.models.provenance\_dto module ------------------------------------------- - -.. automodule:: nipyapi.nifi.models.provenance_dto - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.models.provenance\_entity module ---------------------------------------------- - -.. automodule:: nipyapi.nifi.models.provenance_entity - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.models.provenance\_event\_dto module -------------------------------------------------- - -.. automodule:: nipyapi.nifi.models.provenance_event_dto - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.models.provenance\_event\_entity module ----------------------------------------------------- - -.. automodule:: nipyapi.nifi.models.provenance_event_entity - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.models.provenance\_link\_dto module ------------------------------------------------- - -.. automodule:: nipyapi.nifi.models.provenance_link_dto - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.models.provenance\_node\_dto module ------------------------------------------------- - -.. automodule:: nipyapi.nifi.models.provenance_node_dto - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.models.provenance\_options\_dto module ---------------------------------------------------- - -.. automodule:: nipyapi.nifi.models.provenance_options_dto - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.models.provenance\_options\_entity module ------------------------------------------------------- - -.. automodule:: nipyapi.nifi.models.provenance_options_entity - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.models.provenance\_request\_dto module ---------------------------------------------------- - -.. automodule:: nipyapi.nifi.models.provenance_request_dto - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.models.provenance\_results\_dto module ---------------------------------------------------- - -.. automodule:: nipyapi.nifi.models.provenance_results_dto - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.models.provenance\_searchable\_field\_dto module -------------------------------------------------------------- - -.. automodule:: nipyapi.nifi.models.provenance_searchable_field_dto - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.models.queue\_size\_dto module -------------------------------------------- - -.. automodule:: nipyapi.nifi.models.queue_size_dto - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.models.relationship\_dto module --------------------------------------------- - -.. automodule:: nipyapi.nifi.models.relationship_dto - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.models.remote\_process\_group\_contents\_dto module ----------------------------------------------------------------- - -.. automodule:: nipyapi.nifi.models.remote_process_group_contents_dto - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.models.remote\_process\_group\_dto module ------------------------------------------------------- - -.. automodule:: nipyapi.nifi.models.remote_process_group_dto - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.models.remote\_process\_group\_entity module ---------------------------------------------------------- - -.. automodule:: nipyapi.nifi.models.remote_process_group_entity - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.models.remote\_process\_group\_port\_dto module ------------------------------------------------------------- - -.. automodule:: nipyapi.nifi.models.remote_process_group_port_dto - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.models.remote\_process\_group\_port\_entity module ---------------------------------------------------------------- - -.. automodule:: nipyapi.nifi.models.remote_process_group_port_entity - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.models.remote\_process\_group\_status\_dto module --------------------------------------------------------------- - -.. automodule:: nipyapi.nifi.models.remote_process_group_status_dto - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.models.remote\_process\_group\_status\_entity module ------------------------------------------------------------------ - -.. automodule:: nipyapi.nifi.models.remote_process_group_status_entity - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.models.remote\_process\_group\_status\_snapshot\_dto module ------------------------------------------------------------------------- - -.. automodule:: nipyapi.nifi.models.remote_process_group_status_snapshot_dto - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.models.remote\_process\_group\_status\_snapshot\_entity module ---------------------------------------------------------------------------- - -.. automodule:: nipyapi.nifi.models.remote_process_group_status_snapshot_entity - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.models.remote\_process\_groups\_entity module ----------------------------------------------------------- - -.. automodule:: nipyapi.nifi.models.remote_process_groups_entity - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.models.reporting\_task\_dto module ------------------------------------------------ - -.. automodule:: nipyapi.nifi.models.reporting_task_dto - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.models.reporting\_task\_entity module --------------------------------------------------- - -.. automodule:: nipyapi.nifi.models.reporting_task_entity - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.models.reporting\_task\_types\_entity module ---------------------------------------------------------- - -.. automodule:: nipyapi.nifi.models.reporting_task_types_entity - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.models.reporting\_tasks\_entity module ---------------------------------------------------- - -.. automodule:: nipyapi.nifi.models.reporting_tasks_entity - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.models.resource\_dto module ----------------------------------------- - -.. automodule:: nipyapi.nifi.models.resource_dto - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.models.resources\_entity module --------------------------------------------- - -.. automodule:: nipyapi.nifi.models.resources_entity - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.models.revision\_dto module ----------------------------------------- - -.. automodule:: nipyapi.nifi.models.revision_dto - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.models.schedule\_components\_entity module -------------------------------------------------------- - -.. automodule:: nipyapi.nifi.models.schedule_components_entity - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.models.search\_results\_dto module ------------------------------------------------ - -.. automodule:: nipyapi.nifi.models.search_results_dto - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.models.search\_results\_entity module --------------------------------------------------- - -.. automodule:: nipyapi.nifi.models.search_results_entity - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.models.snippet\_dto module ---------------------------------------- - -.. automodule:: nipyapi.nifi.models.snippet_dto - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.models.snippet\_entity module ------------------------------------------- - -.. automodule:: nipyapi.nifi.models.snippet_entity - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.models.start\_version\_control\_request\_entity module -------------------------------------------------------------------- - -.. automodule:: nipyapi.nifi.models.start_version_control_request_entity - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.models.state\_entry\_dto module --------------------------------------------- - -.. automodule:: nipyapi.nifi.models.state_entry_dto - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.models.state\_map\_dto module ------------------------------------------- - -.. automodule:: nipyapi.nifi.models.state_map_dto - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.models.status\_descriptor\_dto module --------------------------------------------------- - -.. automodule:: nipyapi.nifi.models.status_descriptor_dto - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.models.status\_history\_dto module ------------------------------------------------ - -.. automodule:: nipyapi.nifi.models.status_history_dto - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.models.status\_history\_entity module --------------------------------------------------- - -.. automodule:: nipyapi.nifi.models.status_history_entity - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.models.status\_snapshot\_dto module ------------------------------------------------- - -.. automodule:: nipyapi.nifi.models.status_snapshot_dto - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.models.storage\_usage\_dto module ----------------------------------------------- - -.. automodule:: nipyapi.nifi.models.storage_usage_dto - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.models.streaming\_output module --------------------------------------------- - -.. automodule:: nipyapi.nifi.models.streaming_output - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.models.submit\_replay\_request\_entity module ----------------------------------------------------------- - -.. automodule:: nipyapi.nifi.models.submit_replay_request_entity - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.models.system\_diagnostics\_dto module ---------------------------------------------------- - -.. automodule:: nipyapi.nifi.models.system_diagnostics_dto - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.models.system\_diagnostics\_entity module ------------------------------------------------------- - -.. automodule:: nipyapi.nifi.models.system_diagnostics_entity - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.models.system\_diagnostics\_snapshot\_dto module -------------------------------------------------------------- - -.. automodule:: nipyapi.nifi.models.system_diagnostics_snapshot_dto - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.models.template\_dto module ----------------------------------------- - -.. automodule:: nipyapi.nifi.models.template_dto - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.models.template\_entity module -------------------------------------------- - -.. automodule:: nipyapi.nifi.models.template_entity - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.models.templates\_entity module --------------------------------------------- - -.. automodule:: nipyapi.nifi.models.templates_entity - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.models.tenant\_dto module --------------------------------------- - -.. automodule:: nipyapi.nifi.models.tenant_dto - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.models.tenant\_entity module ------------------------------------------ - -.. automodule:: nipyapi.nifi.models.tenant_entity - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.models.tenants\_entity module ------------------------------------------- - -.. automodule:: nipyapi.nifi.models.tenants_entity - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.models.transaction\_result\_entity module ------------------------------------------------------- - -.. automodule:: nipyapi.nifi.models.transaction_result_entity - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.models.update\_controller\_service\_reference\_request\_entity module ----------------------------------------------------------------------------------- - -.. automodule:: nipyapi.nifi.models.update_controller_service_reference_request_entity - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.models.user\_dto module ------------------------------------- - -.. automodule:: nipyapi.nifi.models.user_dto - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.models.user\_entity module ---------------------------------------- - -.. automodule:: nipyapi.nifi.models.user_entity - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.models.user\_group\_dto module -------------------------------------------- - -.. automodule:: nipyapi.nifi.models.user_group_dto - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.models.user\_group\_entity module ----------------------------------------------- - -.. automodule:: nipyapi.nifi.models.user_group_entity - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.models.user\_groups\_entity module ------------------------------------------------ - -.. automodule:: nipyapi.nifi.models.user_groups_entity - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.models.users\_entity module ----------------------------------------- - -.. automodule:: nipyapi.nifi.models.users_entity - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.models.variable\_dto module ----------------------------------------- - -.. automodule:: nipyapi.nifi.models.variable_dto - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.models.variable\_entity module -------------------------------------------- - -.. automodule:: nipyapi.nifi.models.variable_entity - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.models.variable\_registry\_dto module --------------------------------------------------- - -.. automodule:: nipyapi.nifi.models.variable_registry_dto - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.models.variable\_registry\_entity module ------------------------------------------------------ - -.. automodule:: nipyapi.nifi.models.variable_registry_entity - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.models.variable\_registry\_update\_request\_dto module -------------------------------------------------------------------- - -.. automodule:: nipyapi.nifi.models.variable_registry_update_request_dto - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.models.variable\_registry\_update\_request\_entity module ----------------------------------------------------------------------- - -.. automodule:: nipyapi.nifi.models.variable_registry_update_request_entity - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.models.variable\_registry\_update\_step\_dto module ----------------------------------------------------------------- - -.. automodule:: nipyapi.nifi.models.variable_registry_update_step_dto - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.models.version\_control\_component\_mapping\_entity module ------------------------------------------------------------------------ - -.. automodule:: nipyapi.nifi.models.version_control_component_mapping_entity - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.models.version\_control\_information\_dto module -------------------------------------------------------------- - -.. automodule:: nipyapi.nifi.models.version_control_information_dto - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.models.version\_control\_information\_entity module ----------------------------------------------------------------- - -.. automodule:: nipyapi.nifi.models.version_control_information_entity - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.models.version\_info\_dto module ---------------------------------------------- - -.. automodule:: nipyapi.nifi.models.version_info_dto - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.models.versioned\_connection module ------------------------------------------------- - -.. automodule:: nipyapi.nifi.models.versioned_connection - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.models.versioned\_controller\_service module ---------------------------------------------------------- - -.. automodule:: nipyapi.nifi.models.versioned_controller_service - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.models.versioned\_flow\_coordinates module -------------------------------------------------------- - -.. automodule:: nipyapi.nifi.models.versioned_flow_coordinates - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.models.versioned\_flow\_dto module ------------------------------------------------ - -.. automodule:: nipyapi.nifi.models.versioned_flow_dto - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.models.versioned\_flow\_entity module --------------------------------------------------- - -.. automodule:: nipyapi.nifi.models.versioned_flow_entity - :members: - :undoc-members: - :show-inheritance: - - -nipyapi.nifi.models.versioned\_flow\_snapshot\_entity module ------------------------------------------------------------- - -.. automodule:: nipyapi.nifi.models.versioned_flow_snapshot_entity - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.models.versioned\_flow\_snapshot\_metadata\_entity module ----------------------------------------------------------------------- - -.. automodule:: nipyapi.nifi.models.versioned_flow_snapshot_metadata_entity - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.models.versioned\_flow\_snapshot\_metadata\_set\_entity module ---------------------------------------------------------------------------- - -.. automodule:: nipyapi.nifi.models.versioned_flow_snapshot_metadata_set_entity - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.models.versioned\_flow\_update\_request\_dto module ----------------------------------------------------------------- - -.. automodule:: nipyapi.nifi.models.versioned_flow_update_request_dto - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.models.versioned\_flow\_update\_request\_entity module -------------------------------------------------------------------- - -.. automodule:: nipyapi.nifi.models.versioned_flow_update_request_entity - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.models.versioned\_flows\_entity module ---------------------------------------------------- - -.. automodule:: nipyapi.nifi.models.versioned_flows_entity - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.models.versioned\_funnel module --------------------------------------------- - -.. automodule:: nipyapi.nifi.models.versioned_funnel - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.models.versioned\_label module -------------------------------------------- - -.. automodule:: nipyapi.nifi.models.versioned_label - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.models.versioned\_port module ------------------------------------------- - -.. automodule:: nipyapi.nifi.models.versioned_port - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.models.versioned\_process\_group module ----------------------------------------------------- - -.. automodule:: nipyapi.nifi.models.versioned_process_group - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.models.versioned\_processor module ------------------------------------------------ - -.. automodule:: nipyapi.nifi.models.versioned_processor - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.models.versioned\_property\_descriptor module ----------------------------------------------------------- - -.. automodule:: nipyapi.nifi.models.versioned_property_descriptor - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.models.versioned\_remote\_group\_port module ---------------------------------------------------------- - -.. automodule:: nipyapi.nifi.models.versioned_remote_group_port - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.models.versioned\_remote\_process\_group module ------------------------------------------------------------- - -.. automodule:: nipyapi.nifi.models.versioned_remote_process_group - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/nipyapi-docs/nipyapi.nifi.rst b/docs/nipyapi-docs/nipyapi.nifi.rst deleted file mode 100644 index aa150666..00000000 --- a/docs/nipyapi-docs/nipyapi.nifi.rst +++ /dev/null @@ -1,37 +0,0 @@ -NiFi Swagger Client -=================== - -Subpackages ------------ - -.. toctree:: - - nipyapi.nifi.apis - nipyapi.nifi.models - -Submodules ----------- - -nipyapi.nifi.api\_client module -------------------------------- - -.. automodule:: nipyapi.nifi.api_client - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.configuration module ---------------------------------- - -.. automodule:: nipyapi.nifi.configuration - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.rest module ------------------------- - -.. automodule:: nipyapi.nifi.rest - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/nipyapi-docs/nipyapi.registry.apis.rst b/docs/nipyapi-docs/nipyapi.registry.apis.rst deleted file mode 100644 index ace0a9fe..00000000 --- a/docs/nipyapi-docs/nipyapi.registry.apis.rst +++ /dev/null @@ -1,61 +0,0 @@ -nipyapi.registry.apis package -============================= - -Submodules ----------- - -nipyapi.registry.apis.access\_api module ----------------------------------------- - -.. automodule:: nipyapi.registry.apis.access_api - :members: - :undoc-members: - :show-inheritance: - -nipyapi.registry.apis.bucket\_flows\_api module ------------------------------------------------ - -.. automodule:: nipyapi.registry.apis.bucket_flows_api - :members: - :undoc-members: - :show-inheritance: - -nipyapi.registry.apis.buckets\_api module ------------------------------------------ - -.. automodule:: nipyapi.registry.apis.buckets_api - :members: - :undoc-members: - :show-inheritance: - -nipyapi.registry.apis.flows\_api module ---------------------------------------- - -.. automodule:: nipyapi.registry.apis.flows_api - :members: - :undoc-members: - :show-inheritance: - -nipyapi.registry.apis.items\_api module ---------------------------------------- - -.. automodule:: nipyapi.registry.apis.items_api - :members: - :undoc-members: - :show-inheritance: - -nipyapi.registry.apis.policies\_api module ------------------------------------------- - -.. automodule:: nipyapi.registry.apis.policies_api - :members: - :undoc-members: - :show-inheritance: - -nipyapi.registry.apis.tenants\_api module ------------------------------------------ - -.. automodule:: nipyapi.registry.apis.tenants_api - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/nipyapi-docs/nipyapi.registry.models.rst b/docs/nipyapi-docs/nipyapi.registry.models.rst deleted file mode 100644 index 447965cf..00000000 --- a/docs/nipyapi-docs/nipyapi.registry.models.rst +++ /dev/null @@ -1,245 +0,0 @@ -nipyapi.registry.models package -=============================== - -Submodules ----------- - -nipyapi.registry.models.access\_policy module ---------------------------------------------- - -.. automodule:: nipyapi.registry.models.access_policy - :members: - :undoc-members: - :show-inheritance: - -nipyapi.registry.models.access\_policy\_summary module ------------------------------------------------------- - -.. automodule:: nipyapi.registry.models.access_policy_summary - :members: - :undoc-members: - :show-inheritance: - -nipyapi.registry.models.batch\_size module ------------------------------------------- - -.. automodule:: nipyapi.registry.models.batch_size - :members: - :undoc-members: - :show-inheritance: - -nipyapi.registry.models.bucket module -------------------------------------- - -.. automodule:: nipyapi.registry.models.bucket - :members: - :undoc-members: - :show-inheritance: - -nipyapi.registry.models.bucket\_item module -------------------------------------------- - -.. automodule:: nipyapi.registry.models.bucket_item - :members: - :undoc-members: - :show-inheritance: - -nipyapi.registry.models.bundle module -------------------------------------- - -.. automodule:: nipyapi.registry.models.bundle - :members: - :undoc-members: - :show-inheritance: - -nipyapi.registry.models.connectable\_component module ------------------------------------------------------ - -.. automodule:: nipyapi.registry.models.connectable_component - :members: - :undoc-members: - :show-inheritance: - -nipyapi.registry.models.controller\_service\_api module -------------------------------------------------------- - -.. automodule:: nipyapi.registry.models.controller_service_api - :members: - :undoc-members: - :show-inheritance: - -nipyapi.registry.models.current\_user module --------------------------------------------- - -.. automodule:: nipyapi.registry.models.current_user - :members: - :undoc-members: - :show-inheritance: - -nipyapi.registry.models.fields module -------------------------------------- - -.. automodule:: nipyapi.registry.models.fields - :members: - :undoc-members: - :show-inheritance: - -nipyapi.registry.models.permissions module ------------------------------------------- - -.. automodule:: nipyapi.registry.models.permissions - :members: - :undoc-members: - :show-inheritance: - -nipyapi.registry.models.resource module ---------------------------------------- - -.. automodule:: nipyapi.registry.models.resource - :members: - :undoc-members: - :show-inheritance: - -nipyapi.registry.models.resource\_permissions module ----------------------------------------------------- - -.. automodule:: nipyapi.registry.models.resource_permissions - :members: - :undoc-members: - :show-inheritance: - -nipyapi.registry.models.tenant module -------------------------------------- - -.. automodule:: nipyapi.registry.models.tenant - :members: - :undoc-members: - :show-inheritance: - -nipyapi.registry.models.user module ------------------------------------ - -.. automodule:: nipyapi.registry.models.user - :members: - :undoc-members: - :show-inheritance: - -nipyapi.registry.models.user\_group module ------------------------------------------- - -.. automodule:: nipyapi.registry.models.user_group - :members: - :undoc-members: - :show-inheritance: - -nipyapi.registry.models.versioned\_connection module ----------------------------------------------------- - -.. automodule:: nipyapi.registry.models.versioned_connection - :members: - :undoc-members: - :show-inheritance: - -nipyapi.registry.models.versioned\_controller\_service module -------------------------------------------------------------- - -.. automodule:: nipyapi.registry.models.versioned_controller_service - :members: - :undoc-members: - :show-inheritance: - -nipyapi.registry.models.versioned\_flow module ----------------------------------------------- - -.. automodule:: nipyapi.registry.models.versioned_flow - :members: - :undoc-members: - :show-inheritance: - -nipyapi.registry.models.versioned\_flow\_coordinates module ------------------------------------------------------------ - -.. automodule:: nipyapi.registry.models.versioned_flow_coordinates - :members: - :undoc-members: - :show-inheritance: - -nipyapi.registry.models.versioned\_flow\_snapshot module --------------------------------------------------------- - -.. automodule:: nipyapi.registry.models.versioned_flow_snapshot - :members: - :undoc-members: - :show-inheritance: - -nipyapi.registry.models.versioned\_flow\_snapshot\_metadata module ------------------------------------------------------------------- - -.. automodule:: nipyapi.registry.models.versioned_flow_snapshot_metadata - :members: - :undoc-members: - :show-inheritance: - -nipyapi.registry.models.versioned\_funnel module ------------------------------------------------- - -.. automodule:: nipyapi.registry.models.versioned_funnel - :members: - :undoc-members: - :show-inheritance: - -nipyapi.registry.models.versioned\_label module ------------------------------------------------ - -.. automodule:: nipyapi.registry.models.versioned_label - :members: - :undoc-members: - :show-inheritance: - -nipyapi.registry.models.versioned\_port module ----------------------------------------------- - -.. automodule:: nipyapi.registry.models.versioned_port - :members: - :undoc-members: - :show-inheritance: - -nipyapi.registry.models.versioned\_process\_group module --------------------------------------------------------- - -.. automodule:: nipyapi.registry.models.versioned_process_group - :members: - :undoc-members: - :show-inheritance: - -nipyapi.registry.models.versioned\_processor module ---------------------------------------------------- - -.. automodule:: nipyapi.registry.models.versioned_processor - :members: - :undoc-members: - :show-inheritance: - -nipyapi.registry.models.versioned\_property\_descriptor module --------------------------------------------------------------- - -.. automodule:: nipyapi.registry.models.versioned_property_descriptor - :members: - :undoc-members: - :show-inheritance: - -nipyapi.registry.models.versioned\_remote\_group\_port module -------------------------------------------------------------- - -.. automodule:: nipyapi.registry.models.versioned_remote_group_port - :members: - :undoc-members: - :show-inheritance: - -nipyapi.registry.models.versioned\_remote\_process\_group module ----------------------------------------------------------------- - -.. automodule:: nipyapi.registry.models.versioned_remote_process_group - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/nipyapi-docs/nipyapi.registry.rst b/docs/nipyapi-docs/nipyapi.registry.rst deleted file mode 100644 index 0daa1e6d..00000000 --- a/docs/nipyapi-docs/nipyapi.registry.rst +++ /dev/null @@ -1,37 +0,0 @@ -NiFi-Registry Swagger Client -============================ - -Subpackages ------------ - -.. toctree:: - - nipyapi.registry.apis - nipyapi.registry.models - -Submodules ----------- - -nipyapi.registry.api\_client module ------------------------------------ - -.. automodule:: nipyapi.registry.api_client - :members: - :undoc-members: - :show-inheritance: - -nipyapi.registry.configuration module -------------------------------------- - -.. automodule:: nipyapi.registry.configuration - :members: - :undoc-members: - :show-inheritance: - -nipyapi.registry.rest module ----------------------------- - -.. automodule:: nipyapi.registry.rest - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/nipyapi-docs/nipyapi.rst b/docs/nipyapi-docs/nipyapi.rst deleted file mode 100644 index 48a992c4..00000000 --- a/docs/nipyapi-docs/nipyapi.rst +++ /dev/null @@ -1,91 +0,0 @@ -Demos -===== - -These modules leverage functionality within the rest of the Package to demonstrate various capabilities - -.. toctree:: - :maxdepth: 2 - - nipyapi.demo - -Client SDK modules -================== - -These wrapper modules contain collections of convenience functions for daily operations of your NiFi and NiFi-Registry environment. -They wrap and surface underlying data structures and calls to the full SDK swagger clients which are also included in the package. - -Canvas ------- - -.. automodule:: nipyapi.canvas - :members: - :undoc-members: - :show-inheritance: - -Config ------- - -.. automodule:: nipyapi.config - :members: - :undoc-members: - :show-inheritance: - -Parameters ----------- - -.. automodule:: nipyapi.parameters - :members: - :undoc-members: - :show-inheritance: - -Security --------- - -.. automodule:: nipyapi.security - :members: - :undoc-members: - :show-inheritance: - -System ------- - -.. automodule:: nipyapi.system - :members: - :undoc-members: - :show-inheritance: - -Templates ---------- - -.. automodule:: nipyapi.templates - :members: - :undoc-members: - :show-inheritance: - -Utils ------ - -.. automodule:: nipyapi.utils - :members: - :undoc-members: - :show-inheritance: - -Versioning ----------- - -.. automodule:: nipyapi.versioning - :members: - :undoc-members: - :show-inheritance: - - -Swagger Client SDKs -=================== - -These sub-packages are full swagger clients to the NiFi and NiFi-Registry APIs and may be used directly, or wrapped into the NiPyApi SDK convenience functions - -.. toctree:: - :maxdepth: 3 - - nipyapi.nifi - nipyapi.registry diff --git a/docs/nipyapi-docs/registry_apis/about_api.rst b/docs/nipyapi-docs/registry_apis/about_api.rst new file mode 100644 index 00000000..e317ba4a --- /dev/null +++ b/docs/nipyapi-docs/registry_apis/about_api.rst @@ -0,0 +1,4 @@ +.. automodule:: nipyapi.registry.apis.about_api + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/nipyapi-docs/registry_apis/access_api.rst b/docs/nipyapi-docs/registry_apis/access_api.rst new file mode 100644 index 00000000..9893f614 --- /dev/null +++ b/docs/nipyapi-docs/registry_apis/access_api.rst @@ -0,0 +1,4 @@ +.. automodule:: nipyapi.registry.apis.access_api + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/nipyapi-docs/registry_apis/bucket_bundles_api.rst b/docs/nipyapi-docs/registry_apis/bucket_bundles_api.rst new file mode 100644 index 00000000..8034da0a --- /dev/null +++ b/docs/nipyapi-docs/registry_apis/bucket_bundles_api.rst @@ -0,0 +1,4 @@ +.. automodule:: nipyapi.registry.apis.bucket_bundles_api + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/nipyapi-docs/registry_apis/bucket_flows_api.rst b/docs/nipyapi-docs/registry_apis/bucket_flows_api.rst new file mode 100644 index 00000000..a9dfdd0c --- /dev/null +++ b/docs/nipyapi-docs/registry_apis/bucket_flows_api.rst @@ -0,0 +1,4 @@ +.. automodule:: nipyapi.registry.apis.bucket_flows_api + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/nipyapi-docs/registry_apis/buckets_api.rst b/docs/nipyapi-docs/registry_apis/buckets_api.rst new file mode 100644 index 00000000..0b55200a --- /dev/null +++ b/docs/nipyapi-docs/registry_apis/buckets_api.rst @@ -0,0 +1,4 @@ +.. automodule:: nipyapi.registry.apis.buckets_api + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/nipyapi-docs/registry_apis/bundles_api.rst b/docs/nipyapi-docs/registry_apis/bundles_api.rst new file mode 100644 index 00000000..f165de69 --- /dev/null +++ b/docs/nipyapi-docs/registry_apis/bundles_api.rst @@ -0,0 +1,4 @@ +.. automodule:: nipyapi.registry.apis.bundles_api + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/nipyapi-docs/registry_apis/config_api.rst b/docs/nipyapi-docs/registry_apis/config_api.rst new file mode 100644 index 00000000..1afaba62 --- /dev/null +++ b/docs/nipyapi-docs/registry_apis/config_api.rst @@ -0,0 +1,4 @@ +.. automodule:: nipyapi.registry.apis.config_api + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/nipyapi-docs/registry_apis/extension_repository_api.rst b/docs/nipyapi-docs/registry_apis/extension_repository_api.rst new file mode 100644 index 00000000..d7cc313c --- /dev/null +++ b/docs/nipyapi-docs/registry_apis/extension_repository_api.rst @@ -0,0 +1,4 @@ +.. automodule:: nipyapi.registry.apis.extension_repository_api + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/nipyapi-docs/registry_apis/extensions_api.rst b/docs/nipyapi-docs/registry_apis/extensions_api.rst new file mode 100644 index 00000000..09e72e4e --- /dev/null +++ b/docs/nipyapi-docs/registry_apis/extensions_api.rst @@ -0,0 +1,4 @@ +.. automodule:: nipyapi.registry.apis.extensions_api + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/nipyapi-docs/registry_apis/flows_api.rst b/docs/nipyapi-docs/registry_apis/flows_api.rst new file mode 100644 index 00000000..f985d98e --- /dev/null +++ b/docs/nipyapi-docs/registry_apis/flows_api.rst @@ -0,0 +1,4 @@ +.. automodule:: nipyapi.registry.apis.flows_api + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/nipyapi-docs/registry_apis/index.rst b/docs/nipyapi-docs/registry_apis/index.rst new file mode 100644 index 00000000..72178261 --- /dev/null +++ b/docs/nipyapi-docs/registry_apis/index.rst @@ -0,0 +1,23 @@ +Registry APIs +============= + +Complete Registry REST API client documentation. + +This section documents all **13** Registry API classes. Each API class provides methods for interacting with specific Registry endpoints. Click any API to see its methods and their model parameters. + +.. toctree:: + :maxdepth: 1 + + about_api + access_api + bucket_bundles_api + bucket_flows_api + buckets_api + bundles_api + config_api + extension_repository_api + extensions_api + flows_api + items_api + policies_api + tenants_api diff --git a/docs/nipyapi-docs/registry_apis/items_api.rst b/docs/nipyapi-docs/registry_apis/items_api.rst new file mode 100644 index 00000000..9e3766f2 --- /dev/null +++ b/docs/nipyapi-docs/registry_apis/items_api.rst @@ -0,0 +1,4 @@ +.. automodule:: nipyapi.registry.apis.items_api + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/nipyapi-docs/registry_apis/policies_api.rst b/docs/nipyapi-docs/registry_apis/policies_api.rst new file mode 100644 index 00000000..a2b2321b --- /dev/null +++ b/docs/nipyapi-docs/registry_apis/policies_api.rst @@ -0,0 +1,4 @@ +.. automodule:: nipyapi.registry.apis.policies_api + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/nipyapi-docs/registry_apis/tenants_api.rst b/docs/nipyapi-docs/registry_apis/tenants_api.rst new file mode 100644 index 00000000..298aa18c --- /dev/null +++ b/docs/nipyapi-docs/registry_apis/tenants_api.rst @@ -0,0 +1,4 @@ +.. automodule:: nipyapi.registry.apis.tenants_api + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/nipyapi-docs/registry_models/index.rst b/docs/nipyapi-docs/registry_models/index.rst new file mode 100644 index 00000000..072feb6b --- /dev/null +++ b/docs/nipyapi-docs/registry_models/index.rst @@ -0,0 +1,10 @@ +Registry Models +=============== + +Complete Registry model class documentation with cross-reference support. + +.. toctree:: + :maxdepth: 1 + + models + diff --git a/docs/nipyapi-docs/registry_models/models.rst b/docs/nipyapi-docs/registry_models/models.rst new file mode 100644 index 00000000..07b6ca3b --- /dev/null +++ b/docs/nipyapi-docs/registry_models/models.rst @@ -0,0 +1,364 @@ +Registry Models +=============== + +Complete model class reference for Registry APIs. + +This reference documents all **85** 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 +-------------------- + +**Entity Classes** (e.g., ProcessGroupEntity): Complete API objects with metadata and revision information + +**DTO Classes** (e.g., ProcessGroupDTO): Core data transfer objects containing the essential properties + +**Status Classes** (e.g., ProcessGroupStatus): Runtime status and statistics for monitoring + +**Configuration Classes**: Settings, parameters, and configuration objects + + +.. currentmodule:: nipyapi.registry.models + +All Model Classes +------------------ + +.. autoclass:: AccessPolicy + :members: + :show-inheritance: + +.. autoclass:: AccessPolicySummary + :members: + :show-inheritance: + +.. autoclass:: AllowableValue + :members: + :show-inheritance: + +.. autoclass:: Attribute + :members: + :show-inheritance: + +.. autoclass:: BatchSize + :members: + :show-inheritance: + +.. autoclass:: Bucket + :members: + :show-inheritance: + +.. autoclass:: BucketItem + :members: + :show-inheritance: + +.. autoclass:: BuildInfo + :members: + :show-inheritance: + +.. autoclass:: Bundle + :members: + :show-inheritance: + +.. autoclass:: BundleInfo + :members: + :show-inheritance: + +.. autoclass:: BundleVersion + :members: + :show-inheritance: + +.. autoclass:: BundleVersionDependency + :members: + :show-inheritance: + +.. autoclass:: BundleVersionMetadata + :members: + :show-inheritance: + +.. autoclass:: BundlesBundleTypeBody + :members: + :show-inheritance: + +.. autoclass:: ClientIdParameter + :members: + :show-inheritance: + +.. autoclass:: ComponentDifference + :members: + :show-inheritance: + +.. autoclass:: ComponentDifferenceGroup + :members: + :show-inheritance: + +.. autoclass:: ConnectableComponent + :members: + :show-inheritance: + +.. autoclass:: ControllerServiceAPI + :members: + :show-inheritance: + +.. autoclass:: ControllerServiceDefinition + :members: + :show-inheritance: + +.. autoclass:: CurrentUser + :members: + :show-inheritance: + +.. autoclass:: DefaultSchedule + :members: + :show-inheritance: + +.. autoclass:: DefaultSettings + :members: + :show-inheritance: + +.. autoclass:: Dependency + :members: + :show-inheritance: + +.. autoclass:: DependentValues + :members: + :show-inheritance: + +.. autoclass:: DeprecationNotice + :members: + :show-inheritance: + +.. autoclass:: DynamicProperty + :members: + :show-inheritance: + +.. autoclass:: DynamicRelationship + :members: + :show-inheritance: + +.. autoclass:: Extension + :members: + :show-inheritance: + +.. autoclass:: ExtensionFilterParams + :members: + :show-inheritance: + +.. autoclass:: ExtensionMetadata + :members: + :show-inheritance: + +.. autoclass:: ExtensionMetadataContainer + :members: + :show-inheritance: + +.. autoclass:: ExtensionRepoArtifact + :members: + :show-inheritance: + +.. autoclass:: ExtensionRepoBucket + :members: + :show-inheritance: + +.. autoclass:: ExtensionRepoGroup + :members: + :show-inheritance: + +.. autoclass:: ExtensionRepoVersion + :members: + :show-inheritance: + +.. autoclass:: ExtensionRepoVersionSummary + :members: + :show-inheritance: + +.. autoclass:: ExternalControllerServiceReference + :members: + :show-inheritance: + +.. autoclass:: Fields + :members: + :show-inheritance: + +.. autoclass:: FormDataContentDisposition + :members: + :show-inheritance: + +.. autoclass:: Link + :members: + :show-inheritance: + +.. autoclass:: LongParameter + :members: + :show-inheritance: + +.. autoclass:: ModelProperty + :members: + :show-inheritance: + +.. autoclass:: MultiProcessorUseCase + :members: + :show-inheritance: + +.. autoclass:: ParameterProviderReference + :members: + :show-inheritance: + +.. autoclass:: Permissions + :members: + :show-inheritance: + +.. autoclass:: Position + :members: + :show-inheritance: + +.. autoclass:: ProcessorConfiguration + :members: + :show-inheritance: + +.. autoclass:: ProvidedServiceAPI + :members: + :show-inheritance: + +.. autoclass:: RegistryAbout + :members: + :show-inheritance: + +.. autoclass:: RegistryConfiguration + :members: + :show-inheritance: + +.. autoclass:: Relationship + :members: + :show-inheritance: + +.. autoclass:: Resource + :members: + :show-inheritance: + +.. autoclass:: ResourceDefinition + :members: + :show-inheritance: + +.. autoclass:: ResourcePermissions + :members: + :show-inheritance: + +.. autoclass:: Restricted + :members: + :show-inheritance: + +.. autoclass:: Restriction + :members: + :show-inheritance: + +.. autoclass:: RevisionInfo + :members: + :show-inheritance: + +.. autoclass:: Stateful + :members: + :show-inheritance: + +.. autoclass:: SystemResourceConsideration + :members: + :show-inheritance: + +.. autoclass:: TagCount + :members: + :show-inheritance: + +.. autoclass:: Tenant + :members: + :show-inheritance: + +.. autoclass:: UriBuilder + :members: + :show-inheritance: + +.. autoclass:: UseCase + :members: + :show-inheritance: + +.. autoclass:: User + :members: + :show-inheritance: + +.. autoclass:: UserGroup + :members: + :show-inheritance: + +.. autoclass:: VersionedAsset + :members: + :show-inheritance: + +.. autoclass:: VersionedConnection + :members: + :show-inheritance: + +.. autoclass:: VersionedControllerService + :members: + :show-inheritance: + +.. autoclass:: VersionedFlow + :members: + :show-inheritance: + +.. autoclass:: VersionedFlowCoordinates + :members: + :show-inheritance: + +.. autoclass:: VersionedFlowDifference + :members: + :show-inheritance: + +.. autoclass:: VersionedFlowSnapshot + :members: + :show-inheritance: + +.. autoclass:: VersionedFlowSnapshotMetadata + :members: + :show-inheritance: + +.. autoclass:: VersionedFunnel + :members: + :show-inheritance: + +.. autoclass:: VersionedLabel + :members: + :show-inheritance: + +.. autoclass:: VersionedParameter + :members: + :show-inheritance: + +.. autoclass:: VersionedParameterContext + :members: + :show-inheritance: + +.. autoclass:: VersionedPort + :members: + :show-inheritance: + +.. autoclass:: VersionedProcessGroup + :members: + :show-inheritance: + +.. autoclass:: VersionedProcessor + :members: + :show-inheritance: + +.. autoclass:: VersionedPropertyDescriptor + :members: + :show-inheritance: + +.. autoclass:: VersionedRemoteGroupPort + :members: + :show-inheritance: + +.. autoclass:: VersionedRemoteProcessGroup + :members: + :show-inheritance: + +.. autoclass:: VersionedResourceDefinition + :members: + :show-inheritance: + diff --git a/docs/profiles.rst b/docs/profiles.rst new file mode 100644 index 00000000..e09af512 --- /dev/null +++ b/docs/profiles.rst @@ -0,0 +1,514 @@ +.. highlight:: python + +================================= +Environment Profiles with NiPyAPI +================================= + +NiPyAPI profiles provide a centralized configuration system for managing different Apache NiFi and NiFi Registry environments. This system exists because enterprise environments typically have multiple deployments (development, staging, production) that administrators and developers need to switch between when performing tasks. Instead of manually reconfiguring endpoints, certificates, and authentication for each environment, profiles let you switch between pre-configured setups with a single function call. + +Quick Start +=========== + +**1. Start the infrastructure first:** + +.. code-block:: console + + # Generate certificates and start Docker environment + make certs + make up NIPYAPI_PROFILE=single-user + make wait-ready NIPYAPI_PROFILE=single-user + +**2. Switch to the profile and start working:** + +.. code-block:: python + + import nipyapi + + # Switch to single-user development environment + nipyapi.profiles.switch('single-user') + + # Now all API calls use the single-user configuration + about = nipyapi.system.get_nifi_version_info() + flows = nipyapi.canvas.list_all_process_groups() + +**Available built-in profiles:** + +- ``single-user`` - HTTP Basic authentication (recommended for getting started) +- ``secure-ldap`` - LDAP authentication over TLS +- ``secure-mtls`` - Mutual TLS certificate authentication +- ``secure-oidc`` - OpenID Connect (OAuth2) authentication + +Why Use Profiles? +================= + +**Without profiles** (manual configuration): + +.. code-block:: python + + import nipyapi + from nipyapi import config, utils + + # Manual configuration for each environment + config.nifi_config.username = "einstein" + config.nifi_config.password = "password1234" + config.nifi_config.ssl_ca_cert = "/path/to/ca.crt" + config.registry_config.username = "einstein" + config.registry_config.password = "password1234" + utils.set_endpoint("https://localhost:9443/nifi-api", ssl=True, login=True) + utils.set_endpoint("http://localhost:18080/nifi-registry-api", ssl=True, login=True) + + # Repeat for every environment... + +**With profiles** (centralized configuration): + +.. code-block:: python + + import nipyapi + + # Single function call configures everything + nipyapi.profiles.switch('single-user') + + # Switch to production when ready + nipyapi.profiles.switch('production') + +Configuration Structure +======================= + +Default profiles are defined in ``examples/profiles.yml`` (JSON is also supported). The structure uses a flat key-value format: + +.. code-block:: yaml + + profile_name: + # Service endpoints + nifi_url: "https://localhost:9443/nifi-api" + registry_url: "http://localhost:18080/nifi-registry-api" + registry_internal_url: "http://registry-single:18080" + + # Authentication credentials + nifi_user: "einstein" + nifi_pass: "password1234" + registry_user: "einstein" + registry_pass: "password1234" + + # Shared certificate configuration (simple PKI) + ca_path: "resources/certs/client/ca.pem" + client_cert: "resources/certs/client/client.crt" + client_key: "resources/certs/client/client.key" + client_key_password: "" + + # Per-service certificate configuration (complex PKI) + nifi_ca_path: null + registry_ca_path: null + nifi_client_cert: null + registry_client_cert: null + nifi_client_key: null + registry_client_key: null + nifi_client_key_password: null + registry_client_key_password: null + + # SSL/TLS security settings + nifi_verify_ssl: null + registry_verify_ssl: null + nifi_disable_host_check: null + registry_disable_host_check: null + suppress_ssl_warnings: null + + # Advanced settings + nifi_proxy_identity: null + + # OIDC configuration + oidc_token_endpoint: null + oidc_client_id: null + oidc_client_secret: null + +**All Configuration Keys:** + +Core connection settings: + - ``nifi_url`` - NiFi API endpoint URL + - ``registry_url`` - Registry API endpoint URL + - ``registry_internal_url`` - Internal Registry URL for NiFi โ†’ Registry communication (used when services are on private networks like Docker where internal hostnames differ from external access) + +Authentication credentials: + - ``nifi_user`` / ``nifi_pass`` - NiFi Basic authentication credentials + - ``registry_user`` / ``registry_pass`` - Registry Basic authentication credentials + +Shared SSL/TLS certificates (simple PKI - convenience options where both NiFi and Registry share configuration): + - ``ca_path`` - CA certificate bundle path (used by both services) + - ``client_cert`` - Client certificate path (used by both services for mTLS) + - ``client_key`` - Client private key path (used by both services for mTLS) + - ``client_key_password`` - Private key password + +Per-service SSL/TLS certificates (complex PKI): + - ``nifi_ca_path`` / ``registry_ca_path`` - Service-specific CA certificate paths + - ``nifi_client_cert`` / ``registry_client_cert`` - Service-specific client certificate paths + - ``nifi_client_key`` / ``registry_client_key`` - Service-specific client key paths + - ``nifi_client_key_password`` / ``registry_client_key_password`` - Service-specific key passwords + +SSL/TLS security settings: + - ``nifi_verify_ssl`` / ``registry_verify_ssl`` - SSL certificate verification (true/false/null). Smart defaults: true for HTTPS URLs, false for HTTP URLs + - ``nifi_disable_host_check`` / ``registry_disable_host_check`` - Disable SSL hostname verification (true/false/null). Only applies to HTTPS connections. Default: null (secure hostname checking enabled) + - ``suppress_ssl_warnings`` - Suppress SSL warnings for development with self-signed certificates (true/false/null) + +Advanced settings: + - ``nifi_proxy_identity`` - Identity for NiFi โ†’ Registry proxied requests + +OIDC authentication: + - ``oidc_token_endpoint`` - OAuth2 token endpoint URL + - ``oidc_client_id`` / ``oidc_client_secret`` - OAuth2 client credentials + +Profile Switching Behavior +=========================== + +**Authentication Method Precedence**: When multiple authentication methods are present in a profile, the system uses this priority order: **1) OIDC** (``oidc_token_endpoint``), **2) mTLS** (``client_cert`` + ``client_key``), **3) Basic Auth** (``nifi_user`` + ``nifi_pass``). To ensure predictable behavior, design profiles with only one authentication method per environment. + +**Service Connection Logic**: Performing a switch to NiFi or Registry is based on whether the ``nifi_url`` or ``registry_url`` is present in the profile. You can have a profile that contains only a ``nifi_url`` and it would not attempt to authenticate to Registry. + +**OIDC Authentication Note**: For OIDC profiles, the presence of an ``oidc_token_endpoint`` means that the basic credentials (``nifi_user``/``nifi_pass``) will be applied to the OIDC service rather than directly to the NiFi or Registry service. + +Path Resolution +=============== + +SSL libraries prefer absolute paths over relative paths for certificate files. Where relative paths are provided in profiles, they will be resolved to absolute paths in the operating system. You can override the root directory for relative path resolution using the ``NIPYAPI_CERTS_ROOT_PATH`` environment variable. + +Built-in Profiles +================== + +single-user (Recommended for Development) +------------------------------------------ + +HTTP Basic authentication with HTTPS NiFi and HTTP Registry: + +.. code-block:: python + + nipyapi.profiles.switch('single-user') + +**Authentication method**: Basic (detected by presence of ``nifi_user`` and ``nifi_pass``) + +**Required properties**: + - ``nifi_user: einstein`` + - ``nifi_pass: password1234`` + - ``registry_user: einstein`` + - ``registry_pass: password1234`` + +**Additional properties used**: + - ``nifi_url: https://localhost:9443/nifi-api`` + - ``registry_url: http://localhost:18080/nifi-registry-api`` + - ``registry_internal_url: http://registry-single:18080`` + - ``ca_path: resources/certs/client/ca.pem`` + - ``client_cert: resources/certs/client/client.crt`` + - ``client_key: resources/certs/client/client.key`` + - ``client_key_password: ""`` + - ``nifi_disable_host_check: true`` (development with self-signed certificates) + - ``suppress_ssl_warnings: true`` (suppress warnings for development) + +**Use case**: Development, testing, learning NiPyAPI + +secure-ldap +----------- + +LDAP authentication over TLS for both services: + +.. code-block:: python + + nipyapi.profiles.switch('secure-ldap') + +**Authentication method**: Basic (detected by presence of ``nifi_user`` and ``nifi_pass``) + +**Required properties**: + - ``nifi_user: einstein`` + - ``nifi_pass: password`` + - ``registry_user: einstein`` + - ``registry_pass: password`` + +**Additional properties used**: + - ``nifi_url: https://localhost:9444/nifi-api`` + - ``registry_url: https://localhost:18444/nifi-registry-api`` + - ``registry_internal_url: https://registry-ldap:18443`` + - ``ca_path: resources/certs/client/ca.pem`` + - ``client_cert: resources/certs/client/client.crt`` + - ``client_key: resources/certs/client/client.key`` + - ``client_key_password: ""`` + - ``nifi_proxy_identity: C=US, O=NiPyAPI, CN=nifi`` + +**Use case**: Enterprise LDAP authentication testing + +**Note**: Although both ``single-user`` and ``secure-ldap`` profiles use Basic authentication (detected by ``nifi_user``/``nifi_pass``), they are separate profiles because they use different Docker container configurations with different authentication providers. The ``single-user`` profile uses NiFi's built-in single-user authentication, while ``secure-ldap`` uses LDAP authentication backend. + +secure-mtls +----------- + +Mutual TLS certificate authentication: + +.. code-block:: python + + nipyapi.profiles.switch('secure-mtls') + +**Authentication method**: mTLS (detected by presence of ``client_cert`` and ``client_key``) + +**Required properties**: + - ``client_cert: resources/certs/client/client.crt`` + - ``client_key: resources/certs/client/client.key`` + +**Optional properties**: + - ``client_key_password: ""`` + +**Additional properties used**: + - ``nifi_url: https://localhost:9445/nifi-api`` + - ``registry_url: https://localhost:18445/nifi-registry-api`` + - ``registry_internal_url: https://registry-mtls:18443`` + - ``ca_path: resources/certs/client/ca.pem`` + - ``nifi_proxy_identity: C=US, O=NiPyAPI, CN=nifi`` + +**Use case**: High-security environments, certificate-based authentication + +secure-oidc +----------- + +OpenID Connect (OAuth2) authentication: + +.. code-block:: python + + nipyapi.profiles.switch('secure-oidc') + +**Authentication method**: OIDC (detected by presence of ``oidc_token_endpoint``) + +**Required properties**: + - ``oidc_token_endpoint: http://localhost:8080/realms/nipyapi/protocol/openid-connect/token`` + - ``oidc_client_id: nipyapi-client`` + - ``oidc_client_secret: nipyapi-secret`` + - ``nifi_user: einstein`` + - ``nifi_pass: password1234`` + +**Additional properties used**: + - ``nifi_url: https://localhost:9446/nifi-api`` + - ``registry_url: http://localhost:18446/nifi-registry-api`` + - ``registry_internal_url: http://registry-oidc:18080`` + - ``registry_user: einstein`` + - ``registry_pass: password1234`` + - ``ca_path: resources/certs/client/ca.pem`` + - ``client_cert: resources/certs/client/client.crt`` + - ``client_key: resources/certs/client/client.key`` + - ``client_key_password: ""`` + +**Use case**: Modern OAuth2 integration, external identity providers + +Environment Variable Overrides +=============================== + +Any profile configuration can be overridden with environment variables: + +.. code-block:: shell + + # Override service endpoints + export NIFI_API_ENDPOINT=https://production.example.com/nifi-api + export REGISTRY_API_ENDPOINT=https://registry.production.example.com/nifi-registry-api + + # Override credentials + export NIFI_USERNAME=production_user + export NIFI_PASSWORD=production_password + export REGISTRY_USERNAME=production_user + export REGISTRY_PASSWORD=production_password + + # Override certificates + export TLS_CA_CERT_PATH=/etc/ssl/certs/production-ca.pem + export MTLS_CLIENT_CERT=/etc/ssl/certs/client.crt + export MTLS_CLIENT_KEY=/etc/ssl/private/client.key + export MTLS_CLIENT_KEY_PASSWORD=key_password + + # Override SSL verification + export NIFI_VERIFY_SSL=true + export REGISTRY_VERIFY_SSL=true + + # Override OIDC configuration + export OIDC_TOKEN_ENDPOINT=https://sso.company.com/auth/realms/company/protocol/openid-connect/token + export OIDC_CLIENT_ID=nipyapi-production + export OIDC_CLIENT_SECRET=production_secret + +**Environment variable mapping (from profiles.py):** + +URLs and credentials: + - ``NIFI_API_ENDPOINT`` โ†’ ``nifi_url`` + - ``REGISTRY_API_ENDPOINT`` โ†’ ``registry_url`` + - ``NIFI_USERNAME`` โ†’ ``nifi_user`` + - ``NIFI_PASSWORD`` โ†’ ``nifi_pass`` + - ``REGISTRY_USERNAME`` โ†’ ``registry_user`` + - ``REGISTRY_PASSWORD`` โ†’ ``registry_pass`` + +Basic certificate paths: + - ``TLS_CA_CERT_PATH`` โ†’ ``ca_path`` + - ``MTLS_CLIENT_CERT`` โ†’ ``client_cert`` + - ``MTLS_CLIENT_KEY`` โ†’ ``client_key`` + - ``MTLS_CLIENT_KEY_PASSWORD`` โ†’ ``client_key_password`` + +SSL/TLS security settings: + - ``NIFI_VERIFY_SSL`` โ†’ ``nifi_verify_ssl`` + - ``REGISTRY_VERIFY_SSL`` โ†’ ``registry_verify_ssl`` + - ``NIFI_DISABLE_HOST_CHECK`` โ†’ ``nifi_disable_host_check`` + - ``REGISTRY_DISABLE_HOST_CHECK`` โ†’ ``registry_disable_host_check`` + - ``NIPYAPI_SUPPRESS_SSL_WARNINGS`` โ†’ ``suppress_ssl_warnings`` + +Advanced settings: + - ``NIFI_PROXY_IDENTITY`` โ†’ ``nifi_proxy_identity`` + +OIDC configuration: + - ``OIDC_TOKEN_ENDPOINT`` โ†’ ``oidc_token_endpoint`` + - ``OIDC_CLIENT_ID`` โ†’ ``oidc_client_id`` + - ``OIDC_CLIENT_SECRET`` โ†’ ``oidc_client_secret`` + +Per-service certificate overrides (complex PKI): + - ``NIFI_CA_CERT_PATH`` โ†’ ``nifi_ca_path`` + - ``REGISTRY_CA_CERT_PATH`` โ†’ ``registry_ca_path`` + - ``NIFI_CLIENT_CERT`` โ†’ ``nifi_client_cert`` + - ``REGISTRY_CLIENT_CERT`` โ†’ ``registry_client_cert`` + - ``NIFI_CLIENT_KEY`` โ†’ ``nifi_client_key`` + - ``REGISTRY_CLIENT_KEY`` โ†’ ``registry_client_key`` + - ``NIFI_CLIENT_KEY_PASSWORD`` โ†’ ``nifi_client_key_password`` + - ``REGISTRY_CLIENT_KEY_PASSWORD`` โ†’ ``registry_client_key_password`` + +Path resolution: + - ``NIPYAPI_CERTS_ROOT_PATH`` โ†’ Custom root directory for relative path resolution + +Profiles system: + - ``NIPYAPI_PROFILES_FILE`` โ†’ Custom profiles file path (overrides default examples/profiles.yml) + +Creating Custom Profiles +========================= + +You have several options for creating custom profiles: + +**Option 1: Modify or extend examples/profiles.yml** + +.. code-block:: yaml + + my-production: + # Service endpoints + nifi_url: "https://nifi.company.com/nifi-api" + registry_url: "https://registry.company.com/nifi-registry-api" + registry_internal_url: "https://registry.company.com/nifi-registry-api" + + # Authentication credentials + nifi_user: "service_account" + nifi_pass: "secure_password" + registry_user: "service_account" + registry_pass: "secure_password" + + # SSL settings + nifi_verify_ssl: true + registry_verify_ssl: true + ca_path: "/etc/ssl/company-ca.pem" + +**Option 2: Create your own profile file** + +You can configure a custom profiles file location using multiple methods: + +*Method 2a: Environment Variable (Global)* + +.. code-block:: shell + + export NIPYAPI_PROFILES_FILE=/home/user/.nipyapi/profiles.yml + +*Method 2b: Config Override (Programmatic)* + +.. code-block:: python + + import nipyapi + nipyapi.config.default_profiles_file = '/home/user/.nipyapi/profiles.yml' + nipyapi.profiles.switch('production') # Uses custom file + +*Method 2c: Per-Call Override (Explicit)* + +.. code-block:: python + + import nipyapi + # Point to custom profile file location + nipyapi.profiles.switch('my-production', profiles_file='/home/user/.nipyapi/profiles.yml') + +**Profiles File Resolution Order** + +The system resolves the profiles file path in this priority order: + +1. **Explicit parameter**: ``profiles_file`` argument to ``switch()`` +2. **Environment variable**: ``NIPYAPI_PROFILES_FILE`` +3. **Config default**: ``nipyapi.config.default_profiles_file`` (defaults to ``examples/profiles.yml``) + +**Sparse Profile Definitions** + +You don't have to specify values that are otherwise null unless required for that given authentication method. **Smart SSL defaults** are automatically applied: + +- ``verify_ssl``: Defaults to ``true`` for HTTPS URLs, ``false`` for HTTP URLs +- ``disable_host_check``: Defaults to ``null`` (secure hostname checking), forced to ``null`` for HTTP URLs (not applicable) +- ``suppress_ssl_warnings``: Defaults to ``null`` (show warnings) + +.. code-block:: yaml + + my-staging: + # Only specify what differs from defaults + nifi_url: "https://nifi.staging.company.com/nifi-api" + registry_url: "https://registry.staging.company.com/nifi-registry-api" + nifi_user: "staging_user" + nifi_pass: "staging_password" + # All other values use system defaults + +**Alternative: Direct Client Configuration** + +You don't have to use profiles. You can also directly configure the NiPyAPI client using ``nipyapi.config`` and ``nipyapi.utils.set_endpoint()`` as shown in earlier examples. + +Integration with Examples +========================= + +The NiPyAPI example scripts use profiles for simplified setup: + +**FDLC (Flow Development Life Cycle)** + +The FDLC example demonstrates enterprise flow development workflows using ``single-user`` (development) and ``secure-ldap`` (production) profiles: + +.. code-block:: console + + # Interactive mode (recommended) + python -i examples/fdlc.py + >>> step_1_setup_environments() + >>> step_2_create_dev_flow() + >>> # ... continue with remaining steps + + # Auto run (complete demo) + python examples/fdlc.py --auto + +Demonstrates flow version management across environments using profile switching. + +**Sandbox Environment** + +.. code-block:: console + + $ make sandbox NIPYAPI_PROFILE=single-user + +Creates a complete development environment with sample data using the specified profile. + +Profile API Reference +===================== + +**nipyapi.profiles.switch(profile_name, profiles_file=None)** + +Switch to a named profile. + +:param profile_name: Name of the profile to switch to +:type profile_name: str +:param profiles_file: Path to profiles file. Resolution order: 1) Explicit parameter, 2) NIPYAPI_PROFILES_FILE env var, 3) nipyapi.config.default_profiles_file +:type profiles_file: str or None +:raises ValueError: If profile is not found or configuration is invalid + +.. code-block:: python + + # Switch to named profile + nipyapi.profiles.switch('single-user') + + # Switch using custom profiles file + nipyapi.profiles.switch('production', profiles_file='/home/user/.nipyapi/profiles.yml') + +Cross-References +================ + +**For technical authentication details:** See `Security with NiPyAPI `_ + +**For API reference:** See `API Reference `_ + +**For examples:** See `Examples and Tutorials `_ diff --git a/docs/scripts/generate_structured_docs.py b/docs/scripts/generate_structured_docs.py new file mode 100644 index 00000000..9eb4cfc4 --- /dev/null +++ b/docs/scripts/generate_structured_docs.py @@ -0,0 +1,793 @@ +#!/usr/bin/env python3 +""" +Custom Sphinx documentation generator for NiPyApi. + +This script replaces the default sphinx-apidoc behavior to create better-organized, +more navigable documentation that addresses GitHub issue #376. + +Instead of monolithic files with 1000+ lines, this creates logical groupings +of APIs and models for easier navigation. + +This script automatically introspects the current codebase structure to ensure +it stays synchronized with client generation updates. +""" + +import os +import sys +import importlib +import inspect +from pathlib import Path + +def get_actual_core_modules(): + """Get the actual core nipyapi modules by introspecting __all__.""" + sys.path.insert(0, os.path.abspath('.')) + try: + import nipyapi + # Remove the generated client modules to get just the core modules + core_modules = [mod for mod in nipyapi.__all__ if mod not in ['nifi', 'registry']] + return core_modules + except ImportError: + # Fallback to known modules if import fails + return ['canvas', 'config', 'parameters', 'security', 'system', 'utils', 'versioning'] + +def get_actual_apis(module_path): + """Get actual APIs by introspecting the generated modules.""" + try: + module = importlib.import_module(f"{module_path}.apis") + # Get all classes that end with 'Api' + apis = [] + for name, obj in inspect.getmembers(module): + if (inspect.isclass(obj) and + name.endswith('Api') and + hasattr(obj, '__module__') and + obj.__module__.startswith(module_path)): + # Convert class name to snake_case module name + snake_name = ''.join(['_' + c.lower() if c.isupper() else c for c in name]).lstrip('_') + apis.append(snake_name) + return sorted(apis) + except (ImportError, AttributeError): + return [] + +def categorize_apis_automatically(apis): + """Automatically categorize APIs based on naming patterns.""" + categories = { + "core_flow": { + "title": "Core Flow Management", + "description": "Essential APIs for managing NiFi flows, processors, and connections", + "apis": [] + }, + "security": { + "title": "Security & Access Control", + "description": "Authentication, authorization, policies, and user management", + "apis": [] + }, + "data_management": { + "title": "Data & Provenance", + "description": "Data transfer, queues, provenance tracking, and lineage", + "apis": [] + }, + "system_monitoring": { + "title": "System & Monitoring", + "description": "System diagnostics, counters, and reporting", + "apis": [] + }, + "configuration": { + "title": "Configuration Management", + "description": "Parameters, controller services, and configuration", + "apis": [] + }, + "templates_versioning": { + "title": "Templates & Versioning", + "description": "Flow templates, snippets, and version control", + "apis": [] + }, + "infrastructure": { + "title": "Infrastructure Components", + "description": "Ports, funnels, labels, and remote connections", + "apis": [] + }, + "other": { + "title": "Other APIs", + "description": "Additional API endpoints", + "apis": [] + } + } + + # Categorize based on API names + for api in apis: + if any(keyword in api for keyword in ['flow', 'process', 'connection', 'processor']): + categories["core_flow"]["apis"].append(api) + elif any(keyword in api for keyword in ['access', 'authentication', 'policies', 'tenant']): + categories["security"]["apis"].append(api) + elif any(keyword in api for keyword in ['data_transfer', 'provenance', 'queue']): + categories["data_management"]["apis"].append(api) + elif any(keyword in api for keyword in ['system', 'counter', 'reporting']): + categories["system_monitoring"]["apis"].append(api) + elif any(keyword in api for keyword in ['parameter', 'controller_service', 'config']): + categories["configuration"]["apis"].append(api) + elif any(keyword in api for keyword in ['snippet', 'version', 'template']): + categories["templates_versioning"]["apis"].append(api) + elif any(keyword in api for keyword in ['port', 'funnel', 'label', 'remote', 'site']): + categories["infrastructure"]["apis"].append(api) + else: + categories["other"]["apis"].append(api) + + # Remove empty categories + return {k: v for k, v in categories.items() if v["apis"]} + +# Legacy API groupings (kept for reference but will be replaced by automated detection) +NIFI_API_GROUPS = { + "core_flow": { + "title": "Core Flow Management", + "description": "Essential APIs for managing NiFi flows, processors, and connections", + "apis": [ + "flow_api", + "process_groups_api", + "processors_api", + "connections_api", + "controller_api", + ] + }, + "security": { + "title": "Security & Access Control", + "description": "Authentication, authorization, policies, and user management", + "apis": [ + "access_api", + "authentication_api", + "policies_api", + "tenants_api", + ] + }, + "data_management": { + "title": "Data & Provenance", + "description": "Data transfer, queues, provenance tracking, and lineage", + "apis": [ + "data_transfer_api", + "flow_file_queues_api", + "provenance_api", + "provenance_events_api", + ] + }, + "system_monitoring": { + "title": "System & Monitoring", + "description": "System diagnostics, counters, and reporting", + "apis": [ + "system_diagnostics_api", + "counters_api", + "reporting_tasks_api", + ] + }, + "configuration": { + "title": "Configuration Management", + "description": "Parameters, controller services, and configuration", + "apis": [ + "parameter_contexts_api", + "parameter_providers_api", + "controller_services_api", + ] + }, + "templates_versioning": { + "title": "Templates & Versioning", + "description": "Flow templates, snippets, and version control", + "apis": [ + "snippets_api", + "versions_api", + ] + }, + "infrastructure": { + "title": "Infrastructure Components", + "description": "Ports, funnels, labels, and remote connections", + "apis": [ + "input_ports_api", + "output_ports_api", + "funnels_api", + "labels_api", + "remote_process_groups_api", + "site_to_site_api", + ] + }, + "resources": { + "title": "Resources & Utilities", + "description": "Resource management and utility functions", + "apis": [ + "resources_api", + ] + } +} + +# Note: Model groupings removed - using comprehensive single-section approach +# for better cross-referencing between APIs and models + +REGISTRY_API_GROUPS = { + "core": { + "title": "Core Registry APIs", + "description": "Flow management, buckets, and version control", + "apis": ["flows_api", "buckets_api", "items_api"] + }, + "access": { + "title": "Access & Security", + "description": "Authentication and access control", + "apis": ["access_api", "policies_api", "tenants_api"] + }, + "config": { + "title": "Configuration", + "description": "Configuration and administrative functions", + "apis": ["config_api", "about_api"] + } +} + + +def write_rst_file(filepath, content): + """Write content to RST file with proper encoding.""" + os.makedirs(os.path.dirname(filepath), exist_ok=True) + with open(filepath, 'w', encoding='utf-8') as f: + f.write(content) + print(f"Generated: {filepath}") + + +def generate_individual_api_files(apis, base_module, output_dir): + """Generate individual RST files for each API (flat structure).""" + api_files = [] + for api in apis: + api_content = f".. automodule:: {base_module}.{api}\n" + api_content += " :members:\n" + api_content += " :undoc-members:\n" + api_content += " :show-inheritance:\n" + + api_filename = f"{api}.rst" + api_filepath = os.path.join(output_dir, api_filename) + write_rst_file(api_filepath, api_content) + api_files.append(api_filename) + + return api_files + + +def generate_flat_api_index(api_files, base_module, output_dir, title_prefix): + """Generate main index file for all APIs (flat structure).""" + title = f"{title_prefix} APIs" + content = f"{title}\n" + content += "=" * len(title) + "\n\n" + content += f"Complete {title_prefix} REST API client documentation.\n\n" + + content += f"This section documents all **{len(api_files)}** {title_prefix} API classes. " + content += f"Each API class provides methods for interacting with specific {title_prefix} endpoints. " + content += "Click any API to see its methods and their model parameters.\n\n" + + # Add clean toctree with all APIs + content += ".. toctree::\n" + content += " :maxdepth: 1\n\n" + + for api_file in sorted(api_files): + # Clean display name: connections_api -> Connections API + api_name = api_file.replace('.rst', '').replace('_api', '').replace('_', ' ').title() + ' API' + content += f" {api_file.replace('.rst', '')}\n" + + filepath = os.path.join(output_dir, "index.rst") + write_rst_file(filepath, content) + + +def generate_core_module_docs(output_dir): + """Generate modular documentation for core nipyapi modules.""" + # Get actual modules from the codebase + actual_modules = get_actual_core_modules() + + # Module descriptions + module_descriptions = { + "canvas": "Canvas operations and flow management", + "config": "Configuration management", + "parameters": "Parameter context management", + "security": "Security and authentication utilities", + "system": "System information and diagnostics", + "utils": "Utility functions and helpers", + "versioning": "Version control operations", + } + + # Create core_modules directory + core_modules_dir = os.path.join(output_dir, "core_modules") + os.makedirs(core_modules_dir, exist_ok=True) + + # Generate individual module files + for module_name in actual_modules: + description = module_descriptions.get(module_name, f"{module_name.title()} functionality") + module_title = module_name.title() + + content = f"{module_title}\n" + content += "=" * len(module_title) + "\n\n" + content += f"{description}\n\n" + content += f".. automodule:: nipyapi.{module_name}\n" + content += " :members:\n" + content += " :undoc-members:\n" + content += " :show-inheritance:\n" + + filepath = os.path.join(core_modules_dir, f"{module_name}.rst") + write_rst_file(filepath, content) + + # Generate core modules index + title = "Core Client Modules" + content = f"{title}\n" + content += "=" * len(title) + "\n\n" + content += "These modules provide high-level convenience functions for common NiFi operations.\n" + content += "They wrap the lower-level generated API clients with Pythonic interfaces.\n\n" + + # Add toctree for separate module files + content += ".. toctree::\n" + content += " :maxdepth: 1\n\n" + + for module_name in actual_modules: + content += f" core_modules/{module_name}\n" + + filepath = os.path.join(output_dir, "core_modules.rst") + write_rst_file(filepath, content) + return "core_modules.rst" + + +def generate_main_api_reference(output_dir): + """Generate the main API reference index.""" + title = "API Reference" + content = f"{title}\n" + content += "=" * len(title) + "\n\n" + content += "Complete API documentation for NiPyApi, organized for easy navigation.\n\n" + + content += ".. toctree::\n" + content += " :maxdepth: 2\n" + content += " :caption: Documentation Sections\n\n" + content += " client_architecture\n" + content += " core_modules\n" + content += " nifi_apis/index\n" + content += " nifi_models/index\n" + content += " registry_apis/index\n" + content += " registry_models/index\n" + content += " examples\n\n" + + filepath = os.path.join(output_dir, "api_reference.rst") + write_rst_file(filepath, content) + + +def generate_examples_docs(output_dir): + """Generate documentation for example scripts (not a module).""" + title = "Examples and Tutorials" + content = f"{title}\n" + content += "=" * len(title) + "\n\n" + content += "Example scripts demonstrating NiPyApi functionality can be found in the\n" + content += "`examples/ directory `_\n" + content += "of the source repository.\n\n" + + content += "Available Examples\n" + content += "------------------\n\n" + content += "* **fdlc.py**: **Flow Development Life Cycle (FDLC)** - A comprehensive example demonstrating enterprise NiFi development workflow using NiFi Registry for version control. Shows the complete cycle: DEV environment flow creation โ†’ PROD environment deployment โ†’ iterative development โ†’ production updates. Includes multi-environment authentication, flow versioning, and Registry integration patterns.\n\n" + content += "* **sandbox.py**: **Multi-Profile Authentication Demo** - Interactive script showcasing all NiPyAPI authentication methods (single-user, LDAP, mTLS, OIDC) with real Docker environments. Demonstrates SSL/TLS configuration, security bootstrapping, Registry client setup, and sample object creation. Perfect for learning authentication patterns and testing different security configurations.\n\n" + content += "* **profiles.yml**: **Configuration Templates** - Complete YAML configuration file with working profiles for all supported authentication methods. Includes detailed comments explaining certificate paths, environment variable overrides, and per-service vs shared certificate configurations. Use as a starting template for your own deployments.\n\n" + content += "Quick Start\n" + content += "-----------\n\n" + content += "**New to NiPyAPI?** Start with the sandbox environment:\n\n" + content += ".. code-block:: console\n\n" + content += " $ make sandbox NIPYAPI_PROFILE=single-user\n" + content += " $ python examples/sandbox.py single-user\n\n" + content += "**Ready for enterprise patterns?** Try the FDLC workflow:\n\n" + content += ".. code-block:: console\n\n" + content += " $ python examples/fdlc.py\n\n" + content += "**Need authentication setup?** Copy and customize ``profiles.yml`` for your environment.\n\n" + + content += "Sandbox Environment\n" + content += "-------------------\n\n" + content += "For quick experimentation, use the sandbox make target to set up a ready-to-use environment:\n\n" + content += ".. code-block:: console\n\n" + content += " $ make sandbox NIPYAPI_PROFILE=single-user # Recommended - simple setup\n" + content += " $ make sandbox NIPYAPI_PROFILE=secure-ldap # LDAP authentication\n" + content += " $ make sandbox NIPYAPI_PROFILE=secure-mtls # Certificate authentication (advanced)\n\n" + content += "The sandbox automatically creates:\n\n" + content += "* Properly configured authentication and SSL\n" + content += "* Sample registry client and bucket\n" + content += "* Simple demo flow ready for experimentation\n" + content += "* All necessary security bootstrapping\n\n" + content += "When finished experimenting:\n\n" + content += ".. code-block:: console\n\n" + content += " $ make down # Clean up Docker containers\n\n" + + content += ".. note::\n" + content += " These are standalone Python scripts, not importable modules.\n" + content += " Run them directly with Python after setting up your environment.\n\n" + + filepath = os.path.join(output_dir, "examples.rst") + write_rst_file(filepath, content) + + +def generate_client_architecture_docs(output_dir): + """Generate documentation explaining the client architecture.""" + title = "Client Architecture" + content = f"{title}\n" + content += "=" * len(title) + "\n\n" + content += "Understanding how NiPyApi clients are structured and how to use them effectively.\n\n" + + content += "Client Layers\n" + content += "-------------\n\n" + content += "NiPyApi provides multiple layers of abstraction:\n\n" + content += "**Core Modules** (High-level): :doc:`core_modules` - Convenient Python functions for common operations\n\n" + content += "**Generated APIs** (Low-level): :doc:`nifi_apis/index` and :doc:`registry_apis/index` - Direct REST API access\n\n" + content += "**Models**: :doc:`nifi_models/index` and :doc:`registry_models/index` - Data structures used by APIs\n\n" + + content += "Generated API Structure\n" + content += "-----------------------\n\n" + content += "Each generated API class provides two methods for every operation:\n\n" + content += "**Base Methods** (e.g., ``copy()``)\n" + content += " Return response data directly. Use these for most operations.\n\n" + content += "**HTTP Info Methods** (e.g., ``copy_with_http_info()``)\n" + content += " Return detailed response including status code and headers.\n" + content += " Use when you need HTTP metadata or error details.\n\n" + + content += "Example Usage\n" + content += "~~~~~~~~~~~~~\n\n" + content += ".. code-block:: python\n\n" + content += " import nipyapi\n\n" + content += " # High-level approach (recommended for most users)\n" + content += " process_groups = nipyapi.canvas.list_all_process_groups()\n\n" + content += " # Low-level API approach\n" + content += " api_instance = nipyapi.nifi.ProcessGroupsApi()\n" + content += " \n" + content += " # Get just the data\n" + content += " flow = api_instance.get_flow('root')\n" + content += " \n" + content += " # Get data + HTTP details\n" + content += " flow, status, headers = api_instance.get_flow_with_http_info('root')\n" + content += " print(f\"HTTP Status: {status}\")\n\n" + + content += "Callback Functions\n" + content += "------------------\n\n" + content += "The generated clients support callback functions for asynchronous operations:\n\n" + content += ".. code-block:: python\n\n" + content += " def my_callback(response):\n" + content += " print(f\"Response received: {response}\")\n\n" + content += " # Use callback for async-style processing\n" + content += " api_instance.get_flow('root', callback=my_callback)\n\n" + content += "**Note**: Callbacks are inherited from the original Swagger-generated client.\n" + content += "They maintain backwards compatibility but are not commonly used.\n\n" + + content += "Error Handling\n" + content += "--------------\n\n" + content += "APIs can raise exceptions on HTTP errors:\n\n" + content += ".. code-block:: python\n\n" + content += " from nipyapi.nifi.rest import ApiException\n\n" + content += " try:\n" + content += " flow = api_instance.get_flow('invalid-id')\n" + content += " except ApiException as e:\n" + content += " print(f\"API Error: {e.status} - {e.reason}\")\n\n" + + content += "Model Cross-References\n" + content += "----------------------\n\n" + content += "API documentation includes clickable links to model classes.\n" + content += "Click any model type (e.g., :class:`~nipyapi.nifi.models.ProcessGroupEntity`) " + content += "to jump to its detailed documentation.\n\n" + + filepath = os.path.join(output_dir, "client_architecture.rst") + write_rst_file(filepath, content) + + +def generate_comprehensive_models_docs(base_module, output_dir, title_prefix): + """Generate comprehensive model documentation with all classes for proper cross-referencing.""" + title = f"{title_prefix} Models" + + # Get all model classes from the module + try: + import importlib + module = importlib.import_module(base_module) + # Get all classes that don't start with underscore + model_classes = [name for name in dir(module) + if not name.startswith('_') and + hasattr(getattr(module, name), '__module__') and + getattr(module, name).__module__.startswith(base_module)] + print(f" Found {len(model_classes)} model classes") + except Exception as e: + print(f" โš ๏ธ Could not import {base_module}: {e}") + model_classes = [] + + content = f"{title}\n" + content += "=" * len(title) + "\n\n" + content += f"Complete model class reference for {title_prefix} APIs.\n\n" + + if model_classes: + content += f"This reference documents all **{len(model_classes)}** model classes used by {title_prefix} APIs. " + content += "These classes are automatically cross-referenced from API documentation - " + content += "click any model type in API documentation to jump directly to its definition here.\n\n" + + content += "Model Type Patterns\n" + content += "--------------------\n\n" + content += "**Entity Classes** (e.g., ProcessGroupEntity): Complete API objects with metadata and revision information\n\n" + content += "**DTO Classes** (e.g., ProcessGroupDTO): Core data transfer objects containing the essential properties\n\n" + content += "**Status Classes** (e.g., ProcessGroupStatus): Runtime status and statistics for monitoring\n\n" + content += "**Configuration Classes**: Settings, parameters, and configuration objects\n\n" + + content += f"\n.. currentmodule:: {base_module}\n\n" + content += "All Model Classes\n" + content += "------------------\n\n" + + # Document ALL classes individually for proper cross-referencing + for cls in sorted(model_classes): + content += f".. autoclass:: {cls}\n" + content += f" :members:\n" + content += f" :show-inheritance:\n\n" + + else: + content += ".. note::\n" + content += f" Model classes for {title_prefix} could not be loaded.\n" + content += f" Please check the :py:mod:`{base_module}` module.\n\n" + + # Create index file + index_content = f"{title}\n" + index_content += "=" * len(title) + "\n\n" + index_content += f"Complete {title_prefix} model class documentation with cross-reference support.\n\n" + index_content += ".. toctree::\n" + index_content += " :maxdepth: 1\n\n" + index_content += " models\n\n" + + os.makedirs(output_dir, exist_ok=True) + write_rst_file(os.path.join(output_dir, "index.rst"), index_content) + write_rst_file(os.path.join(output_dir, "models.rst"), content) + + +def generate_dependencies_docs(docs_dir): + """Generate dependencies documentation from actual dependency files.""" + import re + + project_root = Path(__file__).parent.parent.parent + + # Read requirements.txt + requirements_file = project_root / "requirements.txt" + runtime_deps = [] + + if requirements_file.exists(): + with open(requirements_file) as f: + for line in f: + line = line.strip() + if line and not line.startswith('#') and not line.startswith('-'): + runtime_deps.append(line) + + # Read pyproject.toml for optional dependencies + pyproject_file = project_root / "pyproject.toml" + dev_deps = [] + docs_deps = [] + + if pyproject_file.exists(): + # Try to parse pyproject.toml for optional dependencies + try: + # Python 3.11+ has tomllib built-in + try: + import tomllib + except ImportError: + # Fallback to tomli for older Python versions + try: + import tomli as tomllib + except ImportError: + tomllib = None + + if tomllib: + with open(pyproject_file, 'rb') as f: + data = tomllib.load(f) + optional_deps = data.get('project', {}).get('optional-dependencies', {}) + dev_deps = optional_deps.get('dev', []) + docs_deps = optional_deps.get('docs', []) + else: + # Fallback: parse manually for known sections + print("โš ๏ธ TOML parsing not available, using basic fallback") + with open(pyproject_file, 'r') as f: + content = f.read() + # Simple regex-based parsing for our specific use case + if '[project.optional-dependencies]' in content: + lines = content.split('\n') + in_dev = False + in_docs = False + for line in lines: + line = line.strip() + if line.startswith('dev = ['): + in_dev = True + in_docs = False + elif line.startswith('docs = ['): + in_docs = True + in_dev = False + elif line.startswith(']'): + in_dev = in_docs = False + elif in_dev and line.startswith('"') and line.endswith('",'): + dev_deps.append(line.strip('"",')) + elif in_docs and line.startswith('"') and line.endswith('",'): + docs_deps.append(line.strip('"",')) + except Exception as e: + print(f"โš ๏ธ Could not parse pyproject.toml: {e}") + print(" Continuing with runtime dependencies only...") + + # Categorize runtime dependencies + def categorize_runtime_deps(deps): + categories = { + 'Core HTTP Stack': [], + 'Utilities': [], + 'Build & Packaging': [] + } + + for dep in deps: + dep_lower = dep.lower() + if any(x in dep_lower for x in ['requests', 'urllib3', 'certifi', 'pysocks']): + categories['Core HTTP Stack'].append(dep) + elif any(x in dep_lower for x in ['pyyaml', 'packaging']): + categories['Utilities'].append(dep) + elif any(x in dep_lower for x in ['setuptools']): + categories['Build & Packaging'].append(dep) + else: + categories['Utilities'].append(dep) # Default category + + return categories + + runtime_categories = categorize_runtime_deps(runtime_deps) + + # Generate the dependencies.rst file + deps_content = """Dependencies +------------- + +NiPyAPI automatically manages its dependencies during installation. Here are the complete dependency details, automatically generated from the actual project dependency files. + +Runtime Dependencies +-------------------- + +These dependencies are automatically installed when you install NiPyAPI: + +""" + + # Add runtime dependencies by category + for category, deps in runtime_categories.items(): + if deps: + deps_content += f"\n**{category}:**\n\n" + for dep in sorted(deps): + # Parse dependency for description + dep_name = re.split(r'[>=<]', dep)[0] + + descriptions = { + 'requests': 'Primary HTTP client for API communication', + 'urllib3': 'HTTP client backend and connection pooling', + 'certifi': 'SSL certificate verification', + 'pysocks': 'SOCKS proxy support', + 'PyYAML': 'YAML file processing and serialization', + 'packaging': 'Version comparison utilities', + 'setuptools': 'Package management and distribution' + } + + desc = descriptions.get(dep_name, 'Required dependency') + deps_content += f"- ``{dep}`` - {desc}\n" + + # Add optional dependencies + if dev_deps or docs_deps: + deps_content += "\nOptional Dependencies\n---------------------\n\n" + + if dev_deps: + deps_content += "**Development Dependencies** (install with ``pip install nipyapi[dev]``):\n\n" + for dep in sorted(dev_deps): + dep_name = re.split(r'[>=<]', dep)[0] + dev_descriptions = { + 'pytest': 'Testing framework', + 'pytest-cov': 'Test coverage measurement', + 'coverage': 'Coverage analysis and reporting', + 'codecov': 'Coverage reporting service integration', + 'flake8': 'Code style and syntax checking', + 'pylint': 'Advanced code analysis and linting', + 'deepdiff': 'Deep data structure comparison for testing', + 'twine': 'Package distribution to PyPI' + } + desc = dev_descriptions.get(dep_name, 'Development tool') + deps_content += f"- ``{dep}`` - {desc}\n" + + if docs_deps: + deps_content += "\n**Documentation Dependencies** (install with ``pip install nipyapi[docs]``):\n\n" + for dep in sorted(docs_deps): + dep_name = re.split(r'[>=<]', dep)[0] + docs_descriptions = { + 'Sphinx': 'Documentation generation framework', + 'sphinx_rtd_theme': 'Read the Docs theme for Sphinx', + 'sphinxcontrib-jquery': 'jQuery support for Sphinx themes' + } + desc = docs_descriptions.get(dep_name, 'Documentation tool') + deps_content += f"- ``{dep}`` - {desc}\n" + + deps_content += f""" +Dependency Management +--------------------- + +**Automatic Installation:** +All runtime dependencies are automatically installed when you install NiPyAPI via pip. + +**Version Constraints:** +NiPyAPI specifies minimum versions for compatibility but allows newer versions unless there are known incompatibilities. + +**Development Setup:** +For a complete development environment with all optional dependencies: + +.. code-block:: console + + $ pip install -e ".[dev,docs]" + +**Minimal Installation:** +NiPyAPI requires only {len(runtime_deps)} runtime dependencies for basic functionality. + +.. note:: + This dependency information is automatically generated from the project's + ``requirements.txt`` and ``pyproject.toml`` files during documentation build. + +""" + + # Write the dependencies file + deps_file = docs_dir / "dependencies.rst" + with open(deps_file, 'w') as f: + f.write(deps_content) + + print(f"Generated: {deps_file}") + return deps_file + + +def main(): + """Generate structured documentation.""" + print("๐Ÿš€ Generating structured NiPyApi documentation...") + print("๐Ÿ” Auto-detecting current codebase structure...") + + # Base output directory + docs_dir = Path("docs/nipyapi-docs") + + # Clean and recreate output directory + import shutil + if docs_dir.exists(): + shutil.rmtree(docs_dir) + docs_dir.mkdir(parents=True, exist_ok=True) + + # Generate core modules documentation + print("\n๐Ÿ“š Generating core modules...") + actual_modules = get_actual_core_modules() + generate_core_module_docs(docs_dir) + print(f"Generated: docs/nipyapi-docs/core_modules.rst (index)") + for module in actual_modules: + print(f"Generated: docs/nipyapi-docs/core_modules/{module}.rst") + + # Auto-detect and generate NiFi API documentation (flat structure) + print("\n๐Ÿ”ง Auto-detecting NiFi APIs...") + nifi_apis = get_actual_apis("nipyapi.nifi") + print(f" Found {len(nifi_apis)} APIs") + + nifi_apis_dir = docs_dir / "nifi_apis" + nifi_apis_dir.mkdir(exist_ok=True) + + nifi_api_files = generate_individual_api_files(nifi_apis, "nipyapi.nifi.apis", nifi_apis_dir) + generate_flat_api_index(nifi_api_files, "nipyapi.nifi.apis", nifi_apis_dir, "NiFi") + + # Auto-detect and generate Registry API documentation (flat structure) + print("\n๐Ÿ“‹ Auto-detecting Registry APIs...") + registry_apis = get_actual_apis("nipyapi.registry") + print(f" Found {len(registry_apis)} APIs") + + registry_apis_dir = docs_dir / "registry_apis" + registry_apis_dir.mkdir(exist_ok=True) + + registry_api_files = generate_individual_api_files(registry_apis, "nipyapi.registry.apis", registry_apis_dir) + generate_flat_api_index(registry_api_files, "nipyapi.registry.apis", registry_apis_dir, "Registry") + + # Generate comprehensive model documentation for cross-referencing + print("\n๐Ÿ“Š Generating model documentation...") + generate_comprehensive_models_docs("nipyapi.nifi.models", docs_dir / "nifi_models", "NiFi") + generate_comprehensive_models_docs("nipyapi.registry.models", docs_dir / "registry_models", "Registry") + + # Generate examples documentation (not a module) + print("\n๐ŸŽฏ Generating examples documentation...") + generate_examples_docs(docs_dir) + + # Generate client architecture documentation + print("\n๐Ÿ“š Generating client architecture documentation...") + generate_client_architecture_docs(docs_dir) + + # Generate dependencies documentation + print("\n๐Ÿ“ฆ Generating dependencies documentation...") + generate_dependencies_docs(docs_dir) + + # Generate main API reference + print("\n๐Ÿ“– Generating main API reference...") + generate_main_api_reference(docs_dir) + + print(f"\nโœ… Documentation generation complete!") + print(f"๐Ÿ“ Output directory: {docs_dir.resolve()}") + print(f"๐Ÿ”— Entry point: {docs_dir / 'api_reference.rst'}") + print(f"๐Ÿค– Auto-detected: {len(nifi_apis)} NiFi APIs, {len(registry_apis)} Registry APIs") + + +if __name__ == "__main__": + main() diff --git a/docs/security.rst b/docs/security.rst new file mode 100644 index 00000000..683bcc87 --- /dev/null +++ b/docs/security.rst @@ -0,0 +1,733 @@ +.. highlight:: python + +======================= +Security with NiPyAPI 2 +======================= + +NiPyAPI 1.x targets Apache NiFi 2.x and NiFi Registry 2.x, which prefer secure-by-default deployments. +This page covers authentication methods, SSL/TLS configuration, certificate management, and security practices +for both development and production environments. + +.. note:: + **Quick Environment Switching:** + + For simplified workflow-focused configuration management, see `Environment Profiles `_. + Profiles provide a centralized way to switch between development, testing, and production environments + with a single function call. This page focuses on the underlying technical authentication mechanisms. + +.. note:: + **Test vs Production Certificates:** + + Example snippets below use the NiPyAPI repository's generated test certificates (``resources/certs/``) + and localhost URLs for demonstration with the provided Docker profiles. + + **For production deployments:** Replace certificate/key/CA bundle paths with your own production + credentials and endpoints. The authentication patterns remain largely the same, only the paths and URLs change. + +Development vs Production Security +================================== + +Understanding the security model differences between development and production environments is crucial for proper NiPyAPI usage. + +Development Environment Security +-------------------------------- + +**Self-Signed Certificate Infrastructure** + +The NiPyAPI development environment uses self-signed certificates generated via ``make certs``: + +- **Root CA**: ``resources/certs/ca/ca.crt`` - Custom certificate authority for all test certificates +- **Server Certificates**: Generated with proper Subject Alternative Names (SANs) for localhost, container names +- **Client Certificates**: ``resources/certs/client/client.crt`` - For mTLS authentication testing +- **Unified Trust**: All certificates signed by the same root CA for simplified testing + +**SSL Warning Suppression** + +Development environments deliberately disable SSL verification warnings: + +.. code-block:: python + + # In development/testing code + nipyapi.config.disable_insecure_request_warnings = True + +**Why this is safe in development:** + +- Certificates are **properly signed** by our controlled root CA +- **Subject Alternative Names** correctly match hostnames (localhost, container names) +- **Trust chain is valid** - only the root CA is self-signed +- **Controlled environment** - no risk of man-in-the-middle attacks +- **Consistent test results** - eliminates noise from certificate warnings + +**Why warnings are suppressed:** + +SSL libraries correctly identify the root CA as "self-signed" and issue warnings, even though: + +- The certificate chain is cryptographically valid +- Hostname verification passes +- The certificates provide real security within the controlled environment + +Production Environment Security +------------------------------- + +**Enterprise PKI Integration** + +Production deployments should use certificates from trusted certificate authorities: + +- **Commercial CAs** (DigiCert, Let's Encrypt, etc.) +- **Enterprise PKI** (internal certificate authorities) +- **Cloud Provider CAs** (AWS Certificate Manager, Azure Key Vault, etc.) + +**SSL Verification Best Practices** + +.. code-block:: python + + # In production code - NEVER disable SSL verification + nipyapi.config.nifi_config.verify_ssl = True + nipyapi.config.registry_config.verify_ssl = True + + # Use proper CA bundles + nipyapi.config.nifi_config.ssl_ca_cert = "/etc/ssl/certs/ca-bundle.crt" + nipyapi.config.registry_config.ssl_ca_cert = "/etc/ssl/certs/ca-bundle.crt" + +**Security Configuration Guidelines** + +1. **Never disable SSL verification** in production +2. **Use proper certificate validation** with trusted CAs +3. **Rotate certificates regularly** according to your security policy +4. **Monitor certificate expiration** and automate renewal +5. **Use least privilege access** for service accounts +6. **Audit authentication events** and API access + +Certificate Generation and Management +===================================== + +**Development Certificate Generation** + +The NiPyAPI repository includes scripts for generating development certificates:: + + # Generate complete certificate infrastructure + make certs + + # Manual generation (if needed) + ./resources/certs/gen_certs.sh + +**Certificate Structure** + +Generated certificates include: + +- **ca/ca.crt** - Root certificate authority (self-signed) +- **ca/ca.key** - Root CA private key +- **nifi/keystore.p12** - NiFi server certificate (PKCS#12) +- **registry/keystore.p12** - Registry server certificate (PKCS#12) +- **client/client.crt** - Client certificate for mTLS (PEM) +- **client/client.key** - Client private key for mTLS (PEM) +- **client/client.p12** - Client certificate for browser import (PKCS#12) +- **truststore/truststore.p12** - Java truststore with root CA + +**Production Certificate Requirements** + +For production deployments: + +1. **Obtain certificates from trusted CAs** +2. **Include proper Subject Alternative Names** for all hostnames/IPs +3. **Use appropriate key lengths** (2048-bit RSA minimum, 256-bit ECDSA preferred) +4. **Implement certificate lifecycle management** +5. **Store private keys securely** (HSM, encrypted storage) + +Prerequisites +============= + +If you want to use the provided Docker profiles, you need to: + +- Generate local test certificates (if using the provided Docker profiles):: + + make certs + +- Bring up a set of Docker containers for a profile and wait for readiness (examples):: + + make up NIPYAPI_PROFILE=single-user && make wait-ready NIPYAPI_PROFILE=single-user + # or + make up NIPYAPI_PROFILE=secure-ldap && make wait-ready NIPYAPI_PROFILE=secure-ldap + # or + make up NIPYAPI_PROFILE=secure-mtls && make wait-ready NIPYAPI_PROFILE=secure-mtls + # or + make up NIPYAPI_PROFILE=secure-oidc && make wait-ready NIPYAPI_PROFILE=secure-oidc + +Environment variables +===================== + +Environment variables provide a way to override profile configurations or configure NiPyAPI directly. + +.. important:: + **Recommended Approach**: Use the **Profiles System** (``nipyapi.profiles.switch()``) for configuration management. + + The profiles system supports multiple configuration sources: + + - **YAML/JSON files**: ``examples/profiles.yml`` or custom profile files + - **Environment variables**: Override any profile setting (e.g., ``NIFI_API_ENDPOINT``, ``NIFI_USERNAME``) + - **Programmatic overrides**: Direct configuration object manipulation + + All approaches use the same profiles system under the hood and provide automatic authentication + method detection. Environment variables are a **valid and supported** way to use profiles, + especially useful for CI/CD and containerized deployments. + +For complete environment variable documentation including profiles system integration, see `Environment Profiles `_. + +**Core Configuration Variables** + +These variables are read at import time to seed defaults (see ``nipyapi/config.py``): + +.. code-block:: shell + + # Service endpoints (used by both profiles and direct configuration) + export NIFI_API_ENDPOINT=https://localhost:9443/nifi-api + export REGISTRY_API_ENDPOINT=http://localhost:18080/nifi-registry-api + + # SSL configuration (current) + export REQUESTS_CA_BUNDLE=/path/to/ca.pem # Standard Python/requests CA bundle + export TLS_CA_CERT_PATH=/path/to/ca.pem # Shared CA for both NiFi and Registry + export NIPYAPI_VERIFY_SSL=1 # Global SSL verification toggle + export NIPYAPI_CHECK_HOSTNAME=1 # Hostname verification toggle + +.. warning:: + **Deprecated Environment Variables** + + These variables are deprecated and will show warnings in NiPyAPI 1.x: + + .. code-block:: shell + + # DEPRECATED - Use REQUESTS_CA_BUNDLE or direct configuration instead + export NIFI_CA_CERT=/path/to/ca.pem + export NIFI_CLIENT_CERT=/path/to/client.crt + export NIFI_CLIENT_KEY=/path/to/client.key + export REGISTRY_CA_CERT=/path/to/ca.pem + export REGISTRY_CLIENT_CERT=/path/to/client.crt + export REGISTRY_CLIENT_KEY=/path/to/client.key + + **Migration**: Use the profiles system or set ``configuration.ssl_ca_cert/cert_file/key_file`` directly. + +**Profile System Variables** + +When using the profiles system, these variables can override any profile configuration: + +.. code-block:: shell + + # Profiles system configuration + export NIPYAPI_PROFILES_FILE=/path/to/custom/profiles.yml # Custom profiles file location + + # Authentication overrides (see profiles.rst for complete list) + export NIFI_USERNAME=production_user + export NIFI_PASSWORD=production_password + export TLS_CA_CERT_PATH=/path/to/ca.pem + export MTLS_CLIENT_CERT=/path/to/client.crt + export MTLS_CLIENT_KEY=/path/to/client.key + +**Direct Configuration** + +For programmatic configuration: + +.. code-block:: python + + # Modern approach: Set configuration directly (NiPyAPI 1.x) + import nipyapi + from nipyapi import config + + # Configure endpoints + config.nifi_config.host = "https://nifi.company.com/nifi-api" + config.registry_config.host = "https://registry.company.com/nifi-registry-api" + + # Configure SSL certificates + config.nifi_config.ssl_ca_cert = "/path/to/ca.pem" + config.nifi_config.cert_file = "/path/to/client.crt" # For mTLS + config.nifi_config.key_file = "/path/to/client.key" # For mTLS + + # Configure authentication + config.nifi_config.username = "user" + config.nifi_config.password = "password" + + # Establish connection + nipyapi.utils.set_endpoint(config.nifi_config.host, ssl=True, login=True) + +.. note:: + **Recommendation**: Use the profiles system instead of manual configuration for better maintainability and environment management. + +Authentication Methods +====================== + +NiPyAPI provides several approaches for configuring authentication and SSL/TLS, from high-level profiles to low-level configuration. + +**Option A: Profiles System (recommended for most users)** + +The profiles system provides centralized configuration management for different environments: + +.. code-block:: python + + import nipyapi + + # Switch to pre-configured profile + nipyapi.profiles.switch('single-user') # Development environment + nipyapi.profiles.switch('secure-ldap') # LDAP authentication + nipyapi.profiles.switch('secure-mtls') # Certificate authentication + nipyapi.profiles.switch('secure-oidc') # OAuth2/OIDC authentication + + # Custom profiles file + nipyapi.profiles.switch('production', profiles_file='/etc/nipyapi/profiles.yml') + +For complete profiles documentation, see `Environment Profiles `_. + +**Option B: Environment Variables (simple overrides)** + +Environment variables can override any profile configuration or provide direct configuration: + +.. code-block:: shell + + # Set CA bundle for both services via standard environment variable + export REQUESTS_CA_BUNDLE=/path/to/ca.pem + + # Override profile settings + export NIFI_API_ENDPOINT=https://production.company.com/nifi-api + export NIFI_USERNAME=service_account + +**Option C: Convenience Functions (manual configuration)** + +.. code-block:: python + + import nipyapi + + # Set CA certificate for both NiFi and Registry services at once + nipyapi.security.set_shared_ca_cert("/path/to/ca.pem") + + # Reset connections to apply SSL changes + nipyapi.security.reset_service_connections() + +**Option D: Per-Service Configuration** + +.. code-block:: python + + import nipyapi + + # Explicit per-service config (when services use different CAs) + nipyapi.config.nifi_config.ssl_ca_cert = "/path/to/nifi-ca.pem" + nipyapi.config.registry_config.ssl_ca_cert = "/path/to/registry-ca.pem" + + # Reset connections to apply changes + nipyapi.security.reset_service_connections() + + +Single-user (basic auth) +------------------------ + +Default ports (Docker profile): NiFi ``https://localhost:9443/nifi-api``; Registry ``http://localhost:18080/nifi-registry-api``. + +.. code-block:: python + + from nipyapi import config, utils + + # Basic auth credentials (Docker profile defaults) + config.nifi_config.username = "einstein" + config.nifi_config.password = "password1234" # single-user default + config.registry_config.username = "einstein" + config.registry_config.password = "password1234" # single-user default + + # Establish sessions (uses credentials already set on config) + utils.set_endpoint("https://localhost:9443/nifi-api", ssl=True, login=True) + utils.set_endpoint("http://localhost:18080/nifi-registry-api", ssl=True, login=True) + + +Secure LDAP (basic auth over TLS) +--------------------------------- + +Default ports (Docker profile): NiFi ``https://localhost:9444/nifi-api``; Registry ``https://localhost:18444/nifi-registry-api``. + +.. code-block:: python + + from nipyapi import config, utils + + config.nifi_config.username = "einstein" + config.nifi_config.password = "password" + config.registry_config.username = "einstein" + config.registry_config.password = "password" + + utils.set_endpoint("https://localhost:9444/nifi-api", ssl=True, login=True) + utils.set_endpoint("https://localhost:18444/nifi-registry-api", ssl=True, login=True) + + +Secure mTLS (client certificate) +-------------------------------- + +Default ports (Docker profile): NiFi ``https://localhost:9445/nifi-api``; Registry ``https://localhost:18445/nifi-registry-api``. + +.. code-block:: python + + from nipyapi import config, utils + + # Set client cert and key (PEM) + # For NiPyAPI test environment: "resources/certs/client/client.crt" and "resources/certs/client/client.key" + # For production: replace with your own client certificate paths + config.nifi_config.cert_file = "/path/to/client.crt" + config.nifi_config.key_file = "/path/to/client.key" + # If your key is encrypted, set key password via MTLS_CLIENT_KEY_PASSWORD env or programmatically + # Reuse for Registry if using the same client identity + config.registry_config.cert_file = config.nifi_config.cert_file + config.registry_config.key_file = config.nifi_config.key_file + # CA bundle for both services (or per-service as above) + # For NiPyAPI test environment: "resources/certs/ca/ca.crt" + # For production: replace with your own CA bundle path + config.nifi_config.ssl_ca_cert = "/path/to/ca.pem" + config.registry_config.ssl_ca_cert = "/path/to/ca.pem" + + # Establish endpoints without token login (mTLS provides auth) + utils.set_endpoint("https://localhost:9445/nifi-api", ssl=True, login=False) + utils.set_endpoint("https://localhost:18445/nifi-registry-api", ssl=True, login=False) + + +Browser Certificate Import (mTLS Web UI Access) +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +For mTLS web UI access, you must import the client certificate into your browser **before** visiting the NiFi/Registry URLs. + +**Using NiPyAPI test certificates:** The NiPyAPI Docker environment generates a browser-compatible PKCS#12 certificate at: +``resources/certs/client/client.p12`` (password: ``changeit``) + +**Using production certificates:** Convert your client certificate and key to PKCS#12 format for browser import as required: + +.. code-block:: shell + + openssl pkcs12 -export -in /path/to/client.crt -inkey /path/to/client.key -out client.p12 + +**Chrome/Edge:** + +1. Settings โ†’ Privacy & Security โ†’ Security โ†’ **Manage certificates** +2. **Personal** tab โ†’ **Import** โ†’ Browse to your ``.p12`` file +3. Enter your certificate password (``changeit`` for NiPyAPI test certs) +4. โœ“ Check "Mark this key as exportable" โ†’ **Next** โ†’ **Finish** + +**Firefox:** + +1. Settings โ†’ Privacy & Security โ†’ Certificates โ†’ **View Certificates** +2. **Your Certificates** tab โ†’ **Import** โ†’ Select your ``.p12`` file +3. Enter your certificate password (``changeit`` for NiPyAPI test certs) + +**Safari:** + +1. Double-click your ``.p12`` file +2. **Keychain Access** opens โ†’ Choose **"login"** keychain โ†’ Enter your certificate password (``changeit`` for NiPyAPI test certs) +3. Right-click imported certificate โ†’ **Get Info** โ†’ **Trust** โ†’ **Always Trust** + +**After Import:** + +Visit https://localhost:9445/nifi or https://localhost:18445/nifi-registry and your browser +will prompt to select the "client" certificate. The certificate subject ``CN=user1`` is +pre-configured with admin access in the Docker environment. + +**Safari Keychain Authentication:** + +After selecting the certificate, Safari will prompt for your macOS user/admin password to access +the keychain. You have two options: + +- **"Allow"** - Enter password each time you access the NiFi/Registry site +- **"Always Allow"** - Grant permanent access (no password prompt on subsequent visits) + +Choose based on your security requirements and company policy. For development environments, +"Always Allow" provides convenience. For production access, consider the security implications +of storing keychain access permissions. + +OpenID Connect (OIDC) +--------------------- + +OIDC provides modern OAuth2-based authentication for NiFi using external identity providers like Keycloak, Okta, or Azure AD. Both browser-based and programmatic access are supported. + +**Default ports (Docker profile):** NiFi ``https://localhost:9446/nifi-api``; Registry ``http://localhost:18446/nifi-registry-api``. + +**Server-Side Configuration** + +The Docker profile includes a pre-configured Keycloak instance with: + +- **Realm:** ``nipyapi`` +- **Client ID:** ``nipyapi-client`` +- **Client Secret:** ``nipyapi-secret`` +- **Test User:** ``einstein@example.com`` / ``password1234`` +- **Admin Console:** http://localhost:8080/admin (admin/password) + +**Browser Authentication** + +For browser-based access: + +1. Visit https://localhost:9446/nifi +2. You'll be redirected to Keycloak login +3. Login with ``einstein`` / ``password1234`` +4. You'll be redirected back to NiFi with initial access + +**Programmatic Authentication (Multi-Step Setup)** + +.. important:: + **One-Time Manual Setup Required:** + + Programmatic OIDC access requires a one-time manual setup due to NiFi's security architecture. + The OAuth2 password flow creates a separate application identity that needs admin policies. + So the initial admin identity (einstein) manually authorizes the OIDC application identity (a UUID), which then bootstraps policies for both identities. + +**Step 1: Initial Discovery** + +Use the sandbox script to discover your OIDC application UUID:: + + make sandbox NIPYAPI_PROFILE=secure-oidc + +Note: This leverages the comprehensive example script ``examples/sandbox.py`` which demonstrates robust JWT token parsing to extract the OIDC application UUID. + +This will attempt OAuth2 authentication and display the required manual steps, including a unique UUID like ``2a670050-ff88-41d6-a01f-d32ed7e90e09``. + +**Step 2: Manual Policy Configuration** + +.. note:: + The script will print these instructions in the console along with the generated UUID. + +1. Open your browser and navigate to the NiFi UI (https://localhost:9446/nifi) +2. Login via OIDC with your credentials (``einstein`` / ``password1234``) +3. Go to **Settings โ†’ Users** (hamburger menu โ†’ Settings) +4. Click **"Add User"** and create a new user with the exact OIDC application UUID displayed in Step 1 +5. Go to **Settings โ†’ Policies** +6. Grant these policies to the OIDC application UUID: + + - **"view the user interface"** (view access) + - **"view users"** (view access) + - **"view policies"** (view access) + - **"modify policies"** (modify access) + +.. note:: + These are the minimum policies required for programmatic access. You can add more policies as needed. + The bootstrap script will grant the remaining policies automatically if you run it. + +.. note:: + **User Creation Required**: You must create the user (Step 4) before assigning policies (Step 6). + The OIDC application UUID is dynamically generated and the user won't exist until you create it manually. + +**Step 3: Retry Setup** + +Simply re-run the same sandbox command to now complete the bootstrap:: + + make sandbox NIPYAPI_PROFILE=secure-oidc + +**Programmatic Access After Setup** + +After setup, programmatic access works seamlessly using the profiles system: + +.. code-block:: python + + import nipyapi + + # Use the secure-oidc profile (handles all OIDC configuration automatically) + nipyapi.profiles.switch('secure-oidc') + + # All API calls now work with full admin privileges + about_info = nipyapi.nifi.FlowApi().get_about_info() + current_user = nipyapi.nifi.FlowApi().get_current_user() + flows = nipyapi.canvas.list_all_process_groups() + +**Manual OIDC Configuration** + +For direct programmatic control: + +.. code-block:: python + + import nipyapi + + # Manual OAuth2 password flow configuration + nipyapi.security.service_login_oidc( + service='nifi', + username='einstein', + password='password1234', + oidc_token_endpoint='http://localhost:8080/realms/nipyapi/protocol/openid-connect/token', + client_id='nipyapi-client', + client_secret='nipyapi-secret' + ) + + # API calls work the same way + about_info = nipyapi.nifi.FlowApi().get_about_info() + current_user = nipyapi.nifi.FlowApi().get_current_user() + +**Why This Setup is Required** + +NiFi's OIDC implementation creates different identities for different authentication flows: + +- **Browser authentication**: Uses the configured user claim (e.g., ``einstein@example.com``) +- **OAuth2 password flow**: Uses the JWT token's 'sub' field as the user identity (a UUID like ``51c482de-649c-4951-ae1e-50075aa8340b``) + +The OAuth2 application identity is dynamically generated by the OIDC provider and doesn't exist in NiFi's user registry until manually created. This is why both user creation and policy assignment are required. + +.. tip:: + **Automated Bootstrap**: The sandbox script automatically handles policy assignment for both identities: + the browser user (``einstein@example.com``) AND the OAuth2 application identity. This ensures + both browser and programmatic access work seamlessly after the one-time manual setup. + +**Troubleshooting OIDC** + +**Problem**: "No applicable policies could be found" errors after manual setup + +**Solution**: Ensure both user creation AND policy assignment steps were completed: + +1. Verify the user exists: **Settings โ†’ Users** โ†’ Search for your UUID +2. Verify policies assigned: **Settings โ†’ Policies** โ†’ Check each required policy contains your UUID +3. Clear browser cache and retry authentication + +**Problem**: "Untrusted proxy identity" errors in Registry + +**Solution**: This indicates NiFi โ†’ Registry communication issues. Verify: + +1. Registry is accessible: ``curl http://localhost:18446/nifi-registry-api/about`` +2. NiFi is using the correct URL for the Registry client in your environment +3. Registry authentication works independently +4. Registry proxy user policies are configured (handled automatically by sandbox script) + +**Problem**: Manual setup seems to work but programmatic access still fails + +**Solution**: The setup affects only new authentications. Clear any cached API clients: + +.. code-block:: python + + import nipyapi + nipyapi.config.nifi_config.api_client = None # Clear cached client + # Retry authentication + +**General Debugging** + +For complex connectivity or authentication issues, especially with Registry, scripts can help identify specific blockers: + +Use the sandbox script and test suite to validate Registry connectivity and troubleshoot configuration issues: + +.. code-block:: shell + + # Test complete Registry integration + make sandbox NIPYAPI_PROFILE=secure-ldap + make test NIPYAPI_PROFILE=secure-ldap + +Quick connection checks +======================= + +After configuring endpoints and credentials/certificates as above, you can verify connectivity without +needing any policy bootstrap using lightweight version probes: + +.. code-block:: python + + from nipyapi import system + # Should return NiFi version info (object or version string) + print(system.get_nifi_version_info()) + # Should return a non-empty version string for Registry + print(system.get_registry_version_info()) + + +NiFi Registry Client SSL Configuration +====================================== + +Understanding SSL trust relationships is important when configuring NiFi Registry clients for flow version control. NiFi and Registry can interact through implicit trust (shared CA) or explicit SSL Context Services. + +Implicit Trust (Shared Root CA) +-------------------------------- + +When NiFi and Registry share a common root certificate authority, they automatically trust each other through NiFi's global SSL configuration: + +**How it works:** +- When Registry Client's `ssl-context-service` property is `null`, NiFi falls back to global SSL configuration +- NiFi's global truststore (configured via environment variables) contains the shared root CA +- Registry's certificate is signed by the same root CA +- NiFi automatically trusts Registry connections through this fallback mechanism +- Registry Client components work immediately without explicit SSL Context Services + +**Benefits:** +- Simplified configuration and reduced complexity +- No additional SSL Context Services required +- Automatic trust relationship establishment +- Lower operational overhead + +**Example: Simple Registry Client (implicit trust)**:: + + # No SSL Context Service needed - uses NiFi's global SSL configuration + registry_client = nipyapi.versioning.ensure_registry_client( + name='my_registry_client', + uri='https://registry.example.com/nifi-registry-api', + description='Registry Client using implicit SSL trust' + ) + +Explicit SSL Context Services +----------------------------- + +When NiFi and Registry have different certificate authorities or specific PKI requirements, explicit SSL Context Services provide per-component SSL configuration: + +**When required:** +- **Different certificate authorities** (NiFi and Registry use different root CAs) +- **Enterprise PKI integration** (complex trust hierarchies, intermediate CAs) +- **Component-specific certificates** (different keystores per Registry Client) +- **Granular security policies** (different SSL requirements per component) +- **Cloud platform requirements** (e.g., Cloudera DataHub NiFi implementations) + +**Example: Explicit SSL Context Service**:: + + # Create SSL Context Service for specific PKI requirements + ssl_context = nipyapi.security.ensure_ssl_context( + name='registry_ssl_context', + parent_pg=parent_pg, + keystore_file='/path/to/specific/keystore.p12', + keystore_password='password', + truststore_file='/path/to/specific/truststore.p12', + truststore_password='password' + ) + + # Registry Client with explicit SSL Context + registry_client = nipyapi.versioning.ensure_registry_client( + name='secure_registry_client', + uri='https://secure-registry.example.com/nifi-registry-api', + description='Registry Client with explicit SSL Context', + ssl_context_service=ssl_context + ) + +NiPyAPI Testing Implementation +------------------------------ + +The NiPyAPI test infrastructure uses the **implicit trust** approach: + +- All test certificates share a common root CA (``resources/certs/ca/ca.crt``) +- NiFi containers are configured with global truststore containing the shared CA +- Registry Clients work automatically without SSL Context Services +- Simplified test setup and maintenance + +This approach is suitable for development, testing, and deployments where certificate management is centralized. Enterprise deployments with complex PKI requirements may require explicit SSL Context Services. + +Security Module Organization +============================= + +Understanding where to find different types of security functionality: + +**nipyapi.security** - Taking Security Actions +----------------------------------------------- + +The security module performs active security operations: + +- **Authentication functions**: ``service_login_oidc()``, ``set_service_auth_token()`` +- **SSL configuration**: ``set_shared_ca_cert()``, ``set_service_ssl_context()``, ``reset_service_connections()`` +- **Security bootstrapping**: Policy creation, user setup, admin access management +- **Trust management**: Certificate verification, SSL context services + +*Use this module when you need to perform security operations or configure authentication.* + +**nipyapi.profiles** - Configuration Management +------------------------------------------------ + +The profiles module handles configuration definitions and validation: + +- **Environment switching**: ``switch()`` function for changing between environments +- **Configuration validation**: Ensuring certificate paths exist, URLs are valid +- **Environment variable mapping**: How ``NIFI_API_ENDPOINT`` maps to internal config +- **Profile definitions**: Built-in and custom profile management + +*Use this module when you want to switch environments or manage configuration centrally.* + +**nipyapi.utils** - Supporting Utilities +----------------------------------------- + +The utils module provides supporting functions: + +- **Path resolution**: Converting relative certificate paths to absolute paths +- **Endpoint management**: Lower-level endpoint configuration functions +- **Data transformation**: Helper functions for security-related data handling + +*Use this module when you need utility functions for path handling and data transformation.* diff --git a/docs/todo.rst b/docs/todo.rst deleted file mode 100644 index e9b38672..00000000 --- a/docs/todo.rst +++ /dev/null @@ -1,17 +0,0 @@ -===== -ToDo -===== - -* Bring accross features from https://github.com/pvillard31/nifi-api-client-python -* Bring across features from https://github.com/jdye64/nifi-shell -* Look into how sensitive properties are handled on template import -* Add a depth limit to the recursion on the canvas flow fetcher -* Add specific 'secure mode' switch which allows commands to run with simple defaults -* https://community.hortonworks.com/articles/56849/automate-deployment-of-hdf-20-clusters-using-ambar.html -* https://github.com/hayanige/docker-nifi-cluster -* Set enforcement of ProcessGroup best practice like unique template names -* Create Ansible wrappers for executing against Yaml -* Create more deterministic deploy/reset/kill controls for Demo/Test fixtures -* Setup regression testing to handle forward version logic - -Please see the `issue `_ register for more information on current development. diff --git a/examples/README.md b/examples/README.md new file mode 100644 index 00000000..30cfa9df --- /dev/null +++ b/examples/README.md @@ -0,0 +1,58 @@ +# NiPyAPI Examples + +This directory contains practical examples demonstrating NiPyAPI usage patterns and best practices. + +## Available Examples + +### [`fdlc.py`](fdlc.py) - Flow Development Lifecycle +**Purpose:** Complete iterative workflow for enterprise NiFi development using NiFi Registry version control. + +**What it demonstrates:** +- DEV โ†’ PROD flow promotion patterns +- Registry-based version control +- Multi-environment workflow management +- Enterprise development best practices + +**Usage:** `python examples/fdlc.py` + +--- + +### [`sandbox.py`](sandbox.py) - Multi-Profile Environment Setup +**Purpose:** Comprehensive authentication and environment setup across all supported profile types. + +**What it demonstrates:** +- Multi-profile authentication (single-user, secure-ldap, secure-mtls, secure-oidc) +- SSL/TLS configuration and certificate handling +- Security policy bootstrapping for secure environments +- Registry client setup with Docker networking +- Sample object creation (buckets, flows, versioning) + +**Usage:** `python examples/sandbox.py ` or `make sandbox NIPYAPI_PROFILE=single-user` from project root. + +**Supported profiles:** `single-user`, `secure-ldap`, `secure-mtls`, `secure-oidc` + +--- + +### [`profiles.yml`](profiles.yml) - Configuration Template +**Purpose:** Example configuration file showing all supported authentication methods and settings. + +**What it contains:** +- Complete profile configuration examples +- Authentication method templates +- SSL/TLS configuration patterns +- Environment variable override examples + +**Usage:** Copy and modify for your own environments, then use with `nipyapi.config.default_profiles_file = 'path/to/your/profiles.yml'` + +## Getting Started + +1. **For new users:** Start with the Docker-based quick start in the main README, then try `sandbox.py` +2. **For enterprise workflows:** Study `fdlc.py` for development lifecycle patterns +3. **For configuration:** Use `profiles.yml` as a template for your environments + +## Documentation + +For complete API documentation and detailed guides, see: +- [Profiles Documentation](../docs/profiles.rst) - Configuration and authentication +- [Security Documentation](../docs/security.rst) - SSL/TLS and authentication setup +- [Migration Guide](../docs/migration.rst) - Upgrading from 0.x to 1.x diff --git a/examples/fdlc.py b/examples/fdlc.py new file mode 100644 index 00000000..c8b83cf9 --- /dev/null +++ b/examples/fdlc.py @@ -0,0 +1,671 @@ +""" +Flow Development Lifecycle (FDLC) Example using NiFi Registry + +This example demonstrates the complete iterative workflow for enterprise NiFi development +done using NiFi Registry for version control. + +NOTE: This example uses NiFi Registry as the persistence provider. Modern NiFi +deployments increasingly use Git-based persistence providers for version control. +This Registry-based approach remains valuable for understanding core concepts. + +Prerequisites: +- Docker and Docker Compose installed +- nipyapi project with make commands available +- This script should be run from the nipyapi project root + +The FDLC workflow demonstrates: +1. DEV: Create flow and establish version control +2. โ†’ PROD: Export and import flow to production +3. โ† DEV: Make changes and commit new version +4. โ†’ PROD: Promote changes and update production + +This iterative cycle is the heart of enterprise NiFi development. +""" + +import logging +import subprocess +from pathlib import Path + +# Setup logging +logging.basicConfig(level=logging.INFO, format='%(asctime)s - %(levelname)s - %(message)s') +log = logging.getLogger(__name__) + +# Import nipyapi - required for all operations +import nipyapi + +# Two-environment setup for realistic FDLC +DEV_PROFILE = 'single-user' # Development: rapid iteration +PROD_PROFILE = 'secure-ldap' # Production: enterprise security + +# Environment profiles (endpoints now managed by profiles system) +# DEV: single-user profile (rapid iteration) +# PROD: secure-ldap profile (enterprise security) + +# Component names for the demo +FLOW_NAMES = { + 'process_group': 'fdlc_demo_flow', + 'processor': 'fdlc_generator', + 'dev_registry_client': 'dev_registry_client', + 'prod_registry_client': 'prod_registry_client', + 'dev_bucket': 'development', + 'prod_bucket': 'production', + 'versioned_flow': 'demo_data_pipeline' +} + +def check_prerequisites(): + """Quick prerequisite check""" + if not Path('Makefile').exists(): + raise RuntimeError("Run from nipyapi project root: cd /path/to/nipyapi && python examples/fdlc.py") + try: + subprocess.run(['docker', '--version'], capture_output=True, check=True) + except (FileNotFoundError, subprocess.CalledProcessError): + raise RuntimeError("Docker not available") + +def run_make_command(command): + """Helper to run make commands""" + log.info(f"Running: make {command}") + result = subprocess.run(['make'] + command.split(), capture_output=True, text=True) + if result.returncode != 0: + log.error(f"Command failed: {result.stderr}") + raise RuntimeError(f"Make command failed: make {command}") + return result + +def connect_to_dev(): + """Switch to development environment""" + log.info("โ†’ Connecting to DEVELOPMENT environment") + nipyapi.profiles.switch('single-user') + +def connect_to_prod(): + """Switch to production environment""" + log.info("โ†’ Connecting to PRODUCTION environment") + nipyapi.profiles.switch('secure-ldap') + +def step_1_setup_environments(): + """ + Step 1: Quick setup of both development and production environments + + Gets both environments running so we can focus on the FDLC workflow. + """ + print(""" +=== STEP 1: Environment Setup === + +Setting up TWO environments for FDLC demonstration: +โ€ข DEVELOPMENT (single-user): https://localhost:9443 + http://localhost:18080 +โ€ข PRODUCTION (secure-ldap): https://localhost:9444 + https://localhost:18444 + +This gives us realistic environment separation for demonstrating promotion workflows. + """) + + check_prerequisites() + + # Clean slate + log.info("Cleaning up any existing containers...") + run_make_command('down') + + # Ensure certificates exist (don't regenerate if already present) + log.info("Ensuring certificates are available...") + run_make_command('ensure-certs') + + # Start both environments + log.info("Starting development environment...") + run_make_command(f'up NIPYAPI_PROFILE={DEV_PROFILE}') + run_make_command(f'wait-ready NIPYAPI_PROFILE={DEV_PROFILE}') + + log.info("Starting production environment...") + run_make_command(f'up NIPYAPI_PROFILE={PROD_PROFILE}') + run_make_command(f'wait-ready NIPYAPI_PROFILE={PROD_PROFILE}') + + # Bootstrap security policies for production environment (one-time setup) + log.info("Bootstrapping production environment security...") + connect_to_prod() + + log.info("Bootstrapping production NiFi security policies...") + nipyapi.security.bootstrap_security_policies(service='nifi') + + log.info("Bootstrapping production Registry security policies...") + nipyapi.security.bootstrap_security_policies( + service='registry', + nifi_proxy_identity='C=US, O=NiPyAPI, CN=nifi' + ) + + print(""" +โœ… Both environments ready with security bootstrapped! + +DEVELOPMENT: https://localhost:9443/nifi (einstein/password1234) +PRODUCTION: https://localhost:9444/nifi (einstein/password) + โ€ข Security policies: Bootstrapped for secure operations + โ€ข Registry proxy: Configured for NiFi โ†’ Registry communication + +Next: step_2_create_dev_flow() - Create flow in development + """) + +def step_2_create_dev_flow(): + """ + Step 2: Create and prepare flow in development environment + + Creates a simple flow and establishes version control - the foundation + for the promotion workflow. + """ + print(""" +=== STEP 2: Create Development Flow === + +Creating a simple data processing flow in DEVELOPMENT environment +and establishing version control foundation. + """) + + connect_to_dev() + + # Clean up any existing components + log.info("Cleaning up existing components...") + try: + existing_pg = nipyapi.canvas.get_process_group(FLOW_NAMES['process_group']) + if existing_pg: + nipyapi.canvas.delete_process_group(existing_pg, force=True) + except ValueError: + pass + + try: + existing_bucket = nipyapi.versioning.get_registry_bucket(FLOW_NAMES['dev_bucket']) + if existing_bucket: + nipyapi.versioning.delete_registry_bucket(existing_bucket) + except ValueError: + pass + + # Ensure Registry client for version control + log.info("Ensuring Registry client...") + nipyapi.versioning.ensure_registry_client( + name=FLOW_NAMES['dev_registry_client'], + uri='http://registry-single:18080', # Matches conftest.py working configuration + description='Development Registry Client' + ) + + # Create Registry bucket + log.info("Creating development bucket...") + nipyapi.versioning.create_registry_bucket(FLOW_NAMES['dev_bucket']) + + # Create the flow + log.info("Creating demo flow...") + root_pg = nipyapi.canvas.get_process_group(nipyapi.canvas.get_root_pg_id(), 'id') + + process_group = nipyapi.canvas.create_process_group( + parent_pg=root_pg, + new_pg_name=FLOW_NAMES['process_group'], + location=(400.0, 400.0) + ) + + nipyapi.canvas.create_processor( + parent_pg=process_group, + processor=nipyapi.canvas.get_processor_type('GenerateFlowFile'), + location=(400.0, 400.0), + name=FLOW_NAMES['processor'], + config=nipyapi.nifi.ProcessorConfigDTO( + scheduling_period='5s', + auto_terminated_relationships=['success'] + ) + ) + + print(""" +โœ… Development flow created! + +In DEV NiFi UI (https://localhost:9443/nifi): +โ€ข Process Group: fdlc_demo_flow +โ€ข Processor: GenerateFlowFile (5-second interval) +โ€ข Status: Not yet under version control + +Next: step_3_version_dev_flow() - Put flow under version control + """) + +def step_3_version_dev_flow(): + """ + Step 3: Put development flow under version control + + Establishes version control for the flow, creating version 1. + This is the foundation for promotion workflows. + """ + print(""" +=== STEP 3: Establish Version Control === + +Putting the development flow under version control. +This creates version 1 and enables promotion workflows. + """) + + connect_to_dev() + + # Get components + process_group = nipyapi.canvas.get_process_group(FLOW_NAMES['process_group']) + registry_client = nipyapi.versioning.get_registry_client(FLOW_NAMES['dev_registry_client']) + bucket = nipyapi.versioning.get_registry_bucket(FLOW_NAMES['dev_bucket']) + + # Save to version control + log.info("Saving flow to version control...") + version_info = nipyapi.versioning.save_flow_ver( + process_group=process_group, + registry_client=registry_client, + bucket=bucket, + flow_name=FLOW_NAMES['versioned_flow'], + desc='Demo data pipeline for FDLC demonstration', + comment='Initial version - basic data generation flow' + ) + + version = version_info.version_control_information.version + log.info(f"Flow saved as version {version}") + + print(f""" +โœ… Flow under version control! + +โ€ข Flow name: {FLOW_NAMES['versioned_flow']} +โ€ข Version: {version} +โ€ข Status: Development flow shows green โœ“ (up-to-date) + +DEV Registry UI (http://localhost:18080/nifi-registry): +โ€ข Bucket: {FLOW_NAMES['dev_bucket']} +โ€ข Flow: {FLOW_NAMES['versioned_flow']} (version {version}) + +Next: step_4_promote_to_prod() - Export and promote to production + """) + +def step_4_promote_to_prod(): + """ + Step 4: Promote flow to production + + Export from dev Registry and import into prod Registry. + This simulates the promotion through CI/CD pipeline. + """ + print(""" +=== STEP 4: Promote to Production === + +Exporting flow from DEVELOPMENT and importing into PRODUCTION. +This simulates promoting through a CI/CD pipeline between environments. + """) + + # Export from development + connect_to_dev() + log.info("Exporting flow from development...") + + dev_bucket = nipyapi.versioning.get_registry_bucket(FLOW_NAMES['dev_bucket']) + dev_flow = nipyapi.versioning.get_flow_in_bucket( + dev_bucket.identifier, + identifier=FLOW_NAMES['versioned_flow'] + ) + + flow_export = nipyapi.versioning.export_flow_version( + bucket_id=dev_bucket.identifier, + flow_id=dev_flow.identifier, + mode='yaml' + ) + + # Import to production + connect_to_prod() + log.info("Importing flow to production Registry...") + + # Clean up existing prod components + try: + existing_bucket = nipyapi.versioning.get_registry_bucket(FLOW_NAMES['prod_bucket']) + if existing_bucket: + nipyapi.versioning.delete_registry_bucket(existing_bucket) + except ValueError: + pass + + # Create production bucket and import + prod_bucket = nipyapi.versioning.create_registry_bucket(FLOW_NAMES['prod_bucket']) + + log.info("Importing flow into production...") + imported_flow = nipyapi.versioning.import_flow_version( + bucket_id=prod_bucket.identifier, + encoded_flow=flow_export, + flow_name=FLOW_NAMES['versioned_flow'] + ) + + print(f""" +โœ… Flow promoted to production! + +PRODUCTION Registry (https://localhost:18444/nifi-registry): +โ€ข Bucket: {FLOW_NAMES['prod_bucket']} +โ€ข Flow: {FLOW_NAMES['versioned_flow']} (version 1) +โ€ข Status: Available for deployment + +This represents the flow moving through your CI/CD pipeline: +DEV Registry โ†’ CI/CD โ†’ PROD Registry + +Next: step_5_deploy_to_prod_nifi() - Deploy flow in production NiFi + """) + +def step_5_deploy_to_prod_nifi(): + """ + Step 5: Deploy flow in production NiFi + + Create Registry client in prod NiFi and deploy the versioned flow. + This makes the flow live in production. + """ + print(""" +=== STEP 5: Deploy to Production NiFi === + +Creating production Registry client and deploying the versioned flow. +This makes the flow live in the production environment. + """) + + connect_to_prod() + + # Ensure production Registry client + log.info("Ensuring production Registry client...") + prod_registry_client = nipyapi.versioning.ensure_registry_client( + name=FLOW_NAMES['prod_registry_client'], + uri='https://registry-ldap:18443', # Matches conftest.py working configuration for secure-ldap + description='Production Registry Client' + ) + + # Deploy the versioned flow + log.info("Deploying versioned flow to production...") + prod_bucket = nipyapi.versioning.get_registry_bucket(FLOW_NAMES['prod_bucket']) + prod_flow = nipyapi.versioning.get_flow_in_bucket( + prod_bucket.identifier, + identifier=FLOW_NAMES['versioned_flow'] + ) + + deployed_pg = nipyapi.versioning.deploy_flow_version( + parent_id=nipyapi.canvas.get_root_pg_id(), + location=(400.0, 400.0), + bucket_id=prod_bucket.identifier, + flow_id=prod_flow.identifier, + reg_client_id=prod_registry_client.id, + version=None # Deploy latest version + ) + + print(f""" +โœ… Flow deployed to production! + +PRODUCTION NiFi (https://localhost:9444/nifi): +โ€ข Process Group: {FLOW_NAMES['versioned_flow']} +โ€ข Status: Green โœ“ (deployed from version control) +โ€ข Flow is now live and processing data in production + +The flow has completed its journey: +DEV (created) โ†’ DEV Registry โ†’ PROD Registry โ†’ PROD NiFi (live) + +Next: step_6_make_dev_changes() - Demonstrate change management + """) + +def step_6_make_dev_changes(): + """ + Step 6: Make changes in development + + Modify the development flow to simulate ongoing development. + This demonstrates the iterative nature of flow development. + """ + print(""" +=== STEP 6: Make Development Changes === + +Making changes to the development flow to simulate ongoing development. +This shows the iterative cycle: develop โ†’ version โ†’ promote. + """) + + connect_to_dev() + + # Modify the processor + log.info("Making changes to development flow...") + processor = nipyapi.canvas.get_processor(FLOW_NAMES['processor']) + + nipyapi.canvas.update_processor( + processor=processor, + update=nipyapi.nifi.ProcessorConfigDTO( + scheduling_period='10s' # Changed from 5s to 10s + ) + ) + + print(""" +โœ… Development changes made! + +DEV NiFi UI (https://localhost:9443/nifi): +โ€ข Process Group now shows orange star โ˜… (uncommitted changes) +โ€ข Processor scheduling changed: 5s โ†’ 10s +โ€ข Status: Local changes not yet versioned + +This represents typical development iteration: +โ€ข Developer modifies flow configuration +โ€ข Changes are local until committed to version control +โ€ข Production remains unchanged + +Next: step_7_version_changes() - Commit changes as version 2 + """) + +def step_7_version_changes(): + """ + Step 7: Version the changes + + Commit the development changes to create version 2. + This establishes the new version for promotion. + """ + print(""" +=== STEP 7: Version the Changes === + +Committing development changes to create version 2. +This establishes the new version for promotion to production. + """) + + connect_to_dev() + + # Get components for versioning + process_group = nipyapi.canvas.get_process_group(FLOW_NAMES['process_group']) + registry_client = nipyapi.versioning.get_registry_client(FLOW_NAMES['dev_registry_client']) + dev_bucket = nipyapi.versioning.get_registry_bucket(FLOW_NAMES['dev_bucket']) + dev_flow = nipyapi.versioning.get_flow_in_bucket( + dev_bucket.identifier, + identifier=FLOW_NAMES['versioned_flow'] + ) + + # Commit changes + log.info("Committing changes to version control...") + version_info = nipyapi.versioning.save_flow_ver( + process_group=process_group, + registry_client=registry_client, + bucket=dev_bucket, + flow_id=dev_flow.identifier, + comment='Performance tuning - reduced generation frequency from 5s to 10s' + ) + + version = version_info.version_control_information.version + log.info(f"Changes committed as version {version}") + + print(f""" +โœ… Changes versioned! + +DEV NiFi UI: +โ€ข Process Group shows green โœ“ (changes committed) +โ€ข Version: {version} + +DEV Registry UI: +โ€ข Flow: {FLOW_NAMES['versioned_flow']} +โ€ข Versions: 1 (initial), {version} (performance tuning) +โ€ข Latest comment: "Performance tuning - reduced generation frequency" + +Ready for promotion to production! + +Next: step_8_promote_changes() - Promote version 2 to production + """) + +def step_8_promote_changes(): + """ + Step 8: Promote changes to production + + Export version 2 and import into production, then update production deployment. + This completes the full development lifecycle. + """ + print(""" +=== STEP 8: Promote Changes to Production === + +Promoting version 2 to production and updating the live deployment. +This completes the full development lifecycle demonstration. + """) + + # Export version 2 from development + connect_to_dev() + log.info("Exporting version 2 from development...") + + dev_bucket = nipyapi.versioning.get_registry_bucket(FLOW_NAMES['dev_bucket']) + dev_flow = nipyapi.versioning.get_flow_in_bucket( + dev_bucket.identifier, + identifier=FLOW_NAMES['versioned_flow'] + ) + + flow_export_v2 = nipyapi.versioning.export_flow_version( + bucket_id=dev_bucket.identifier, + flow_id=dev_flow.identifier, + mode='yaml' + ) + + # Import to production + connect_to_prod() + log.info("Importing version 2 to production...") + + prod_bucket = nipyapi.versioning.get_registry_bucket(FLOW_NAMES['prod_bucket']) + prod_flow = nipyapi.versioning.get_flow_in_bucket( + prod_bucket.identifier, + identifier=FLOW_NAMES['versioned_flow'] + ) + + nipyapi.versioning.import_flow_version( + bucket_id=prod_bucket.identifier, + encoded_flow=flow_export_v2, + flow_id=prod_flow.identifier + ) + + print(f""" +โœ… FDLC cycle completed! + +PRODUCTION Status: +โ€ข Registry: Version 2 available +โ€ข NiFi: Shows red up-arrow โฌ† (new version available) + +The complete enterprise development lifecycle: + +1. DEV: Created flow โ†’ versioned (v1) +2. โ†’ PROD: Promoted v1 โ†’ deployed to production +3. โ† DEV: Made changes โ†’ versioned (v2) +4. โ†’ PROD: Promoted v2 โ†’ ready for deployment update + +Production team can now: +โ€ข Review version 2 changes +โ€ข Update production deployment +โ€ข Validate the changes in production + +This demonstrates the complete iterative development cycle +that's central to enterprise NiFi workflows! + +Final step: step_9_cleanup() - Clean up environments + """) + +def step_9_cleanup(): + """ + Step 9: Clean up demonstration environments + """ + print(""" +=== STEP 9: Cleanup === + +Cleaning up demonstration environments. + """) + + log.info("Stopping all containers...") + run_make_command('down') + + print(""" +โœ… FDLC demonstration completed! + +You've seen the complete enterprise flow development lifecycle: + +๐Ÿ”„ **The FDLC Rhythm:** +1. **Develop** flows in development environment +2. **Version** changes using Registry +3. **Promote** through CI/CD pipeline +4. **Deploy** to production environment +5. **Iterate** - make changes and repeat + +๐Ÿข **Enterprise Value:** +โ€ข Controlled promotion between environments +โ€ข Version history and rollback capabilities +โ€ข Audit trails for all changes +โ€ข Separation of development and production + +๐Ÿ“ **Registry vs Git:** +This demo used NiFi Registry for version control. +Modern deployments increasingly use Git-based persistence +providers as an alternative approach. + +Thank you for exploring the Flow Development Lifecycle! + """) + +# Interactive mode +if __name__ == '__main__': + import sys + + print(""" +๐Ÿš€ Flow Development Lifecycle (FDLC) Demo +======================================== + +This demonstration shows the ITERATIVE WORKFLOW of enterprise NiFi development: +the back-and-forth promotion process between development and production. + +๐Ÿ”„ THE WORKFLOW: +DEV: Create โ†’ Version โ†’ โ†’ PROD: Import โ†’ Deploy + โ†— โ†˜ +DEV: Change โ†’ Version โ† โ† โ† โ† โ† โ† Update + +Two environments: +โ€ข DEVELOPMENT: single-user (rapid iteration) +โ€ข PRODUCTION: secure-ldap (enterprise security) + +Steps: +1. step_1_setup_environments() # Quick setup of both environments +2. step_2_create_dev_flow() # Create flow in development +3. step_3_version_dev_flow() # Put under version control (v1) +4. step_4_promote_to_prod() # Export dev โ†’ import prod +5. step_5_deploy_to_prod_nifi() # Deploy in production NiFi +6. step_6_make_dev_changes() # Make changes in development +7. step_7_version_changes() # Commit changes (v2) +8. step_8_promote_changes() # Promote v2 to production +9. step_9_cleanup() # Clean up + """) + + # Check if user wants auto-run mode + if len(sys.argv) > 1 and sys.argv[1] == '--auto': + print("\n๐Ÿš€ Running complete FDLC demo automatically...\n") + try: + step_1_setup_environments() + step_2_create_dev_flow() + step_3_version_dev_flow() + step_4_promote_to_prod() + step_5_deploy_to_prod_nifi() + step_6_make_dev_changes() + step_7_version_changes() + step_8_promote_changes() + step_9_cleanup() + print("\n๐ŸŽ‰ Complete FDLC demo finished!") + except Exception as e: + print(f"\nโŒ Demo failed: {e}") + print("You can run step_9_cleanup() to clean up if needed.") + sys.exit(1) + else: + print(""" +๐Ÿ“– HOW TO RUN: + +Option 1 - Interactive Mode (Recommended): + python -i examples/fdlc.py + >>> step_1_setup_environments() + >>> step_2_create_dev_flow() + >>> # ... continue with remaining steps + >>> exit() # or Ctrl+D to exit when done + +Option 2 - Auto Run (Complete Demo): + python examples/fdlc.py --auto + +Option 3 - Import Mode: + python + >>> exec(open('examples/fdlc.py').read()) + >>> step_1_setup_environments() + >>> exit() # or Ctrl+D to exit when done + +๐Ÿ’ก TIP: Use interactive mode to go step-by-step and see results! +๐Ÿ’ก TIP: Run step_9_cleanup() before exiting to stop Docker containers +๐Ÿ’ก TIP: Most steps require infrastructure (step 1) but can be run individually for testing + +To start interactively: python -i examples/fdlc.py + """) diff --git a/examples/profiles.yml b/examples/profiles.yml new file mode 100644 index 00000000..81b8330e --- /dev/null +++ b/examples/profiles.yml @@ -0,0 +1,88 @@ +# Development and testing profiles for NiPyAPI +# These profiles provide working configurations for Docker-based development +# +# Format Support: This file uses YAML, but JSON is also supported since JSON is a subset of YAML +# +# Certificate Configuration: +# - Simple configuration: Use shared ca_path, client_cert, client_key for both NiFi and Registry +# - Complex PKI: Use per-service nifi_ca_path/registry_ca_path, nifi_client_cert/registry_client_cert, etc. +# - Per-service values take precedence over shared values if specified +# - Environment variables can override any certificate path (see security.rst docs) +# +# Examples: +# - Shared CA, different client certs: Set ca_path, then nifi_client_cert + registry_client_cert +# - Different CAs: Set nifi_ca_path + registry_ca_path (ca_path becomes fallback) +# - Environment override: NIFI_CA_CERT_PATH=/custom/nifi-ca.pem overrides nifi_ca_path + +single-user: + nifi_url: https://localhost:9443/nifi-api + registry_url: http://localhost:18080/nifi-registry-api + registry_internal_url: http://registry-single:18080 + nifi_user: einstein + nifi_pass: password1234 + registry_user: einstein + registry_pass: password1234 + # NiFi uses HTTPS with self-signed certs, Registry uses HTTP + nifi_verify_ssl: false # Accept self-signed certificates + registry_verify_ssl: false + nifi_disable_host_check: true # Self-signed certs often have wrong hostnames + registry_disable_host_check: null # Registry is HTTP, so no host check + suppress_ssl_warnings: true # Suppress warnings in development + # No client certificates needed for single-user basic auth + ca_path: null + client_cert: null + client_key: null + client_key_password: null + # Per-service certificates (complex PKI) - defaults to shared if not specified + nifi_ca_path: null + registry_ca_path: null + nifi_client_cert: null + registry_client_cert: null + nifi_client_key: null + registry_client_key: null + nifi_client_key_password: null + registry_client_key_password: null + # NiFi proxy identity for Registry communication (null = no proxy needed) + nifi_proxy_identity: null + # OIDC-specific configuration (OAuth2 Resource Owner Password Credentials flow) + oidc_token_endpoint: null + oidc_client_id: null + oidc_client_secret: null + +secure-ldap: + nifi_url: https://localhost:9444/nifi-api + registry_url: https://localhost:18444/nifi-registry-api + registry_internal_url: https://registry-ldap:18443 + nifi_user: einstein + nifi_pass: password + registry_user: einstein + registry_pass: password + ca_path: "resources/certs/client/ca.pem" + suppress_ssl_warnings: true # Supress self-signed certificate warnings + nifi_proxy_identity: "C=US, O=NiPyAPI, CN=nifi" + +secure-mtls: + nifi_url: https://localhost:9445/nifi-api + registry_url: https://localhost:18445/nifi-registry-api + registry_internal_url: https://registry-mtls:18443 + ca_path: "resources/certs/client/ca.pem" + client_cert: "resources/certs/client/client.crt" + client_key: "resources/certs/client/client.key" + client_key_password: "" + suppress_ssl_warnings: true # Supress self-signed certificate warnings + nifi_proxy_identity: "C=US, O=NiPyAPI, CN=nifi" + +secure-oidc: + nifi_url: https://localhost:9446/nifi-api + registry_url: http://localhost:18446/nifi-registry-api + registry_internal_url: http://registry-oidc:18080 + nifi_user: einstein + nifi_pass: password1234 + registry_user: einstein + registry_pass: password1234 + ca_path: "resources/certs/client/ca.pem" + suppress_ssl_warnings: true # Supress self-signed certificate warnings + # OIDC-specific configuration (OAuth2 Resource Owner Password Credentials flow) + oidc_token_endpoint: "http://localhost:8080/realms/nipyapi/protocol/openid-connect/token" + oidc_client_id: "nipyapi-client" + oidc_client_secret: "nipyapi-secret" diff --git a/examples/sandbox.py b/examples/sandbox.py new file mode 100755 index 00000000..18520b74 --- /dev/null +++ b/examples/sandbox.py @@ -0,0 +1,371 @@ +#!/usr/bin/env python3 +""" +NiPyAPI Sandbox Setup Example + +This comprehensive example demonstrates NiPyAPI best practices for: +โ€ข Multi-profile authentication (single-user, secure-ldap, secure-mtls, secure-oidc) +โ€ข SSL/TLS configuration and certificate handling +โ€ข Security policy bootstrapping for secure environments +โ€ข Registry client setup with Docker networking considerations +โ€ข Sample object creation (buckets, flows, versioning) +โ€ข Robust error handling and artifact reuse patterns + +USAGE: + python examples/sandbox.py + + Profiles: single-user, secure-ldap, secure-mtls, secure-oidc + + Example: python examples/sandbox.py secure-ldap + +This script creates a ready-to-use NiFi environment with sample objects for +experimentation and learning. Copy and adapt this code for your own automation scripts. + +WHAT IT CREATES: +โ€ข sandbox_registry_client: NiFi Registry client for version control +โ€ข sandbox_bucket: Sample bucket for storing flows +โ€ข sandbox_demo_flow: Simple GenerateFlowFile flow with versioning + +The script handles authentication differences across profiles and provides +clear instructions for manual setup steps (especially OIDC). +""" + +import sys +import logging +import nipyapi + +# Sandbox object names +SANDBOX_PREFIX = "sandbox" +SANDBOX_REGISTRY_CLIENT = f"{SANDBOX_PREFIX}_registry_client" +SANDBOX_BUCKET = f"{SANDBOX_PREFIX}_bucket" +SANDBOX_FLOW = f"{SANDBOX_PREFIX}_demo_flow" + +log = logging.getLogger(__name__) + + +def get_profile_config(profile): + """Get resolved configuration for the given profile.""" + profiles_path = nipyapi.utils.resolve_relative_paths('examples/profiles.yml') + return nipyapi.profiles.resolve_profile_config(profile_name=profile, profiles_file_path=profiles_path) + + +def bootstrap_security_policies(profile, auth_metadata=None): + """Bootstrap security policies for secure profiles. + + Args: + profile (str): Name of the profile being used + auth_metadata: Authentication metadata from profile switch: + - OIDC: token_data dict for UUID extraction + - Basic: username string + - mTLS: None + + Returns: + str: 'success', 'manual_setup_required', or 'error' + """ + # NiFi security policies + if profile in ('secure-ldap', 'secure-mtls'): + nipyapi.security.bootstrap_security_policies(service='nifi') + log.info("NiFi security policies bootstrapped") + elif profile == 'secure-oidc': + result = _bootstrap_oidc_security_policies(auth_metadata) + if result != 'success': + return result # Return early for manual setup or error + + # Registry security policies + if profile in ('secure-ldap', 'secure-mtls'): + # NiFi always needs to be a trusted proxy in secure deployments + config = get_profile_config(profile) + nifi_proxy_identity = config.get('nifi_proxy_identity') + nipyapi.security.bootstrap_security_policies(service='registry', nifi_proxy_identity=nifi_proxy_identity) + log.info("Registry security policies bootstrapped") + else: + log.info("Registry security policies skipped (single-user or oidc profile)") + + return 'success' + + +def _bootstrap_oidc_security_policies(auth_metadata=None): + """ + OIDC bootstrap is a two-phase process: + + Phase 1 (first run): OIDC app has no rights โ†’ 403 โ†’ manual setup instructions + Phase 2 (second run): Bootstrap both OIDC app + Einstein with full admin rights + + Args: + auth_metadata: OIDC token data from profile switch for UUID extraction + + Returns: + str: 'success', 'manual_setup_required', or 'error' + """ + try: + # Bootstrap the OIDC application user (programmatic bearer token access) + # Needed so we can use the sandbox for testing OIDC authentication + nipyapi.security.bootstrap_security_policies(service='nifi') + + # Bootstrap Einstein user for full UI access (including flow modification) + # Einstein starts with minimal rights, needs full admin rights after manual setup + einstein_user = nipyapi.security.get_service_user('einstein@example.com', service="nifi") + if einstein_user: + nipyapi.security.bootstrap_security_policies(service='nifi', user_identity=einstein_user) + log.info("OIDC bootstrap complete: both app and Einstein have full admin rights") + else: + log.info("OIDC app bootstrap complete (Einstein user not found)") + + return 'success' + + except Exception as e: + if '403' in str(e): + # Phase 1: Expected on first run - manual setup required + log.info("OIDC authentication requires one-time manual policy setup") + + # Extract UUID from auth_metadata if available + oidc_uuid = None + if auth_metadata: + try: + oidc_uuid = nipyapi.utils.extract_oidc_user_identity(auth_metadata) + except Exception as extract_error: + log.warning("Could not extract OIDC UUID from metadata: %s", extract_error) + + _print_oidc_manual_setup_instructions(oidc_uuid) + return 'manual_setup_required' + else: + log.warning("OIDC security policy bootstrapping error: %s", e) + return 'error' + + + +def _print_oidc_manual_setup_instructions(oidc_uuid=None): + """Print OIDC manual setup instructions with the extracted UUID.""" + log.info("MANUAL SETUP REQUIRED (one-time only):") + log.info(" 1. Open browser: %s", nipyapi.config.nifi_config.host.replace('/nifi-api', '/nifi')) + log.info(" 2. Login via OIDC as: einstein / password1234") + log.info(" 3. Go to: Settings โ†’ Users โ†’ Add User") + + if oidc_uuid: + log.info(" 4. Create user with this exact UUID: %s", oidc_uuid) + else: + log.info(" 4. Create user with extracted UUID from token (see error above)") + + log.info(" 5. Go to: Settings โ†’ Policies") + if oidc_uuid: + log.info(" 6. Grant these policies to UUID %s:", oidc_uuid) + else: + log.info(" 6. Grant these policies to the UUID:") + log.info(" โ€ข 'view the user interface'") + log.info(" โ€ข 'view users' (view)") + log.info(" โ€ข 'view policies' (view)") + log.info(" โ€ข 'modify policies' (modify)") + log.info(" 7. Re-run: make sandbox NIPYAPI_PROFILE=secure-oidc") + log.info("TIP: After manual setup, the same command will work automatically") + + +def _print_setup_complete_summary(profile): + """Print detailed setup completion summary with profile-specific instructions.""" + print("\nSandbox setup complete!") + print(f" Profile: {profile}") + + if profile == 'secure-mtls': + _print_mtls_certificate_instructions() + else: + # Get config for UI URLs and credentials + config = get_profile_config(profile) + nifi_ui = config['nifi_url'].replace('/nifi-api', '/nifi') + registry_ui = config['registry_url'].replace('/nifi-registry-api', '/nifi-registry') + print(f" NiFi UI: {nifi_ui} ({config['nifi_user']}/{config['nifi_pass']})") + print(f" Registry UI: {registry_ui} ({config['registry_user']}/{config['registry_pass']})") + + print(f" Registry Client: {SANDBOX_REGISTRY_CLIENT}") + print(f" Sample Bucket: {SANDBOX_BUCKET}") + print(f" Sample Flow: {SANDBOX_FLOW}") + print("\nReady for experimentation! Run 'make down' when finished.") + + +def _print_mtls_certificate_instructions(): + """Print detailed mTLS certificate setup instructions.""" + config = get_profile_config('secure-mtls') + cert_p12_path = config['client_cert'].replace('.crt', '.p12') + nifi_ui = config['nifi_url'].replace('/nifi-api', '/nifi') + registry_ui = config['registry_url'].replace('/nifi-registry-api', '/nifi-registry') + + print(f" NiFi UI: {nifi_ui}") + print(f" Registry UI: {registry_ui}") + print(f" Authentication: Client certificate required (ADVANCED)") + print() + print(" TIP: For easier setup, try:") + print(" make sandbox NIPYAPI_PROFILE=single-user (recommended - simple setup)") + print(" make sandbox NIPYAPI_PROFILE=secure-ldap (more complex security)") + print() + print(" IMPORT CLIENT CERTIFICATE FIRST:") + print(f" Certificate file: {cert_p12_path}") + print(" Import password: changeit") + print(" Certificate name: client (configured for admin access)") + print() + print(" BROWSER IMPORT INSTRUCTIONS:") + print() + print(" Chrome/Edge:") + print(" 1. Settings โ†’ Privacy & Security โ†’ Security โ†’ Manage certificates") + print(f" 2. Personal tab โ†’ Import โ†’ Browse to: {cert_p12_path}") + print(" 3. Enter password: changeit") + print(" 4. โœ“ Mark keys as exportable โ†’ Next โ†’ Finish") + print() + print(" Firefox:") + print(" 1. Settings โ†’ Privacy & Security โ†’ Certificates โ†’ View Certificates") + print(f" 2. Your Certificates tab โ†’ Import โ†’ Select: {cert_p12_path}") + print(" 3. Enter password: changeit") + print() + print(" Safari:") + print(f" 1. Double-click: {cert_p12_path}") + print(" 2. Keychain Access โ†’ Enter password: changeit") + print(" 3. Trust Settings โ†’ Always Trust") + print() + print(" WARNING: THEN visit URLs above - browser will prompt to select 'client' certificate") + + +def create_registry_client(registry_internal_url): + """Create registry client using ensure pattern for robust automation.""" + registry_client = nipyapi.versioning.ensure_registry_client( + name=SANDBOX_REGISTRY_CLIENT, + uri=registry_internal_url, + description='NiPyAPI Sandbox Registry Client' + ) + log.info("Registry client ready: %s โ†’ %s", SANDBOX_REGISTRY_CLIENT, registry_internal_url) + return registry_client + + +def create_sample_bucket(): + """Create sample bucket using ensure pattern for robust automation.""" + bucket = nipyapi.versioning.ensure_registry_bucket(SANDBOX_BUCKET) + log.info("Sample bucket ready: %s", SANDBOX_BUCKET) + return bucket + + +def create_sample_flow(registry_client, bucket): + """Create a simple sample flow for experimentation.""" + # Check if flow already exists and reuse it + try: + existing_pg = nipyapi.canvas.get_process_group(SANDBOX_FLOW) + if existing_pg: + log.info("Reusing existing sample flow: %s", SANDBOX_FLOW) + return existing_pg, None # Return None for version_info since we're reusing + except Exception: + # Flow doesn't exist, we'll create it below + pass + + # Create simple process group with GenerateFlowFile + root_pg = nipyapi.canvas.get_process_group(nipyapi.canvas.get_root_pg_id(), 'id') + + # Create process group + try: + sample_pg = nipyapi.canvas.create_process_group( + parent_pg=root_pg, + new_pg_name=SANDBOX_FLOW, + location=(200.0, 200.0) + ) + except Exception as e: + # If creation fails, try to get existing process group (race condition handling) + if "already exists" in str(e) or "duplicate" in str(e).lower(): + try: + sample_pg = nipyapi.canvas.get_process_group(SANDBOX_FLOW) + log.info("Found existing process group after failed creation: %s", SANDBOX_FLOW) + return sample_pg, None # Return None for version_info since we're reusing + except Exception: + pass + raise e + + # Add GenerateFlowFile processor + _ = nipyapi.canvas.create_processor( + parent_pg=sample_pg, + processor=nipyapi.canvas.get_processor_type('GenerateFlowFile'), + location=(400.0, 300.0), + name=f"{SANDBOX_PREFIX}_generator", + config=nipyapi.nifi.ProcessorConfigDTO( + scheduling_period='10s', + auto_terminated_relationships=['success'] + ) + ) + + log.info("Sample flow created: %s (with GenerateFlowFile processor)", SANDBOX_FLOW) + + # Version the flow + try: + version_info = nipyapi.versioning.save_flow_ver( + process_group=sample_pg, + registry_client=registry_client, + bucket=bucket, + flow_name=SANDBOX_FLOW, + comment='Initial sandbox flow version', + desc='Simple flow for experimentation' + ) + log.info("Sample flow versioned: %s v1", SANDBOX_FLOW) + return sample_pg, version_info + except Exception as e: + log.warning("Flow versioning failed (flow still created): %s", e) + return sample_pg, None + + +def main(): + """Main sandbox setup function.""" + if len(sys.argv) != 2: + # Load available profiles from the profiles system + try: + profiles_path = nipyapi.utils.resolve_relative_paths('examples/profiles.yml') + profiles = nipyapi.profiles.load_profiles_from_file(profiles_path) + available_profiles = ', '.join(sorted(profiles.keys())) + except Exception as e: + available_profiles = "Error loading profiles" + print(f"Warning: Could not load profiles: {e}") + + print(f"Usage: {sys.argv[0]} ") + print(f"Available profiles: {available_profiles}") + print(f"Profile 'single-user' recommended for new users") + sys.exit(1) + + profile = sys.argv[1] + + # Setup logging + logging.basicConfig(level=logging.INFO, format='%(message)s') + + try: + log.info("Setting up NiPyAPI sandbox for profile: %s", profile) + + # 1. Use centralized profile switching (replaces config resolution, SSL setup, authentication) + profiles_path = nipyapi.utils.resolve_relative_paths('examples/profiles.yml') + profile_name, auth_metadata = nipyapi.profiles.switch(profile, profiles_path) + log.info("Profile switching complete: %s", profile_name) + + # 2. Get config for sample object creation + config = get_profile_config(profile) + + # 3. Bootstrap security policies (server-side setup) + bootstrap_result = bootstrap_security_policies(profile, auth_metadata) + if bootstrap_result == 'manual_setup_required': + print("\nOIDC manual setup required - follow instructions above") + print(" After completing setup, re-run: make sandbox NIPYAPI_PROFILE=secure-oidc") + sys.exit(0) # Clean exit, not an error + elif bootstrap_result == 'error': + log.error("Security policy bootstrap failed") + sys.exit(1) + + # 4. Create registry client + registry_client = create_registry_client(config['registry_internal_url']) + + # 5. Create sample bucket + bucket = create_sample_bucket() + + # 6. Create sample flow + _, _ = create_sample_flow(registry_client, bucket) + + # Success summary + _print_setup_complete_summary(profile) + + # Final success message (only shown when setup actually completes) + print("\n=== 4/4: Sandbox ready! ===") + print("Your NiPyAPI sandbox is ready for experimentation!") + print(" Run 'make down' when finished to clean up") + + except Exception as e: + log.error("Sandbox setup failed: %s", e) + sys.exit(1) + + +if __name__ == '__main__': + main() diff --git a/nipyapi/__init__.py b/nipyapi/__init__.py index 06ba6233..5e120ecf 100644 --- a/nipyapi/__init__.py +++ b/nipyapi/__init__.py @@ -5,10 +5,30 @@ import importlib __author__ = """Daniel Chaffelson""" -__email__ = 'chaffelson@gmail.com' -__version__ = '0.22.0' -__all__ = ['canvas', 'system', 'templates', 'config', 'nifi', 'registry', - 'versioning', 'demo', 'utils', 'security', 'parameters'] +__email__ = "chaffelson@gmail.com" +try: + # Generated during build by setuptools_scm + from ._version import version as __version__ # type: ignore +except ImportError: # pragma: no cover - version file not present in editable contexts + from importlib.metadata import PackageNotFoundError + from importlib.metadata import version as _pkg_version + + try: + __version__ = _pkg_version("nipyapi") + except PackageNotFoundError: # package metadata not available (e.g., source checkout) + __version__ = "0.0.0+unknown" +__all__ = [ + "canvas", + "system", + "config", + "nifi", + "registry", + "versioning", + "utils", + "security", + "parameters", + "profiles", +] for sub_module in __all__: - importlib.import_module('nipyapi.' + sub_module) + importlib.import_module("nipyapi." + sub_module) diff --git a/nipyapi/canvas.py b/nipyapi/canvas.py index b9eb06c5..a70a25f3 100644 --- a/nipyapi/canvas.py +++ b/nipyapi/canvas.py @@ -5,28 +5,64 @@ """ import logging + import nipyapi from nipyapi.utils import exception_handler __all__ = [ - "get_root_pg_id", "recurse_flow", "get_flow", "get_process_group_status", - "get_process_group", "list_all_process_groups", "delete_process_group", - "schedule_process_group", "create_process_group", "list_all_processors", - "list_all_processor_types", "get_processor_type", 'create_processor', - 'delete_processor', 'get_processor', 'schedule_processor', 'get_funnel', - 'update_processor', 'get_variable_registry', 'update_variable_registry', - 'purge_connection', 'purge_process_group', 'schedule_components', - 'get_bulletins', 'get_bulletin_board', 'list_invalid_processors', - 'list_sensitive_processors', 'list_all_connections', 'create_connection', - 'delete_connection', 'get_component_connections', 'create_controller', - 'list_all_controllers', 'delete_controller', 'update_controller', - 'schedule_controller', 'get_controller', 'list_all_controller_types', - 'list_all_by_kind', 'list_all_input_ports', 'list_all_output_ports', - 'list_all_funnels', 'list_all_remote_process_groups', 'delete_funnel', - 'get_remote_process_group', 'update_process_group', 'create_funnel', - 'create_remote_process_group', 'delete_remote_process_group', - 'set_remote_process_group_transmission', 'get_pg_parents_ids', - 'delete_port', 'create_port' + "get_root_pg_id", + "recurse_flow", + "get_flow", + "get_process_group_status", + "get_process_group", + "list_all_process_groups", + "delete_process_group", + "schedule_process_group", + "create_process_group", + "list_all_processors", + "list_all_processor_types", + "get_processor_type", + "create_processor", + "delete_processor", + "get_processor", + "schedule_processor", + "get_funnel", + "update_processor", + "get_variable_registry", + "update_variable_registry", + "purge_connection", + "purge_process_group", + "schedule_components", + "get_bulletins", + "get_bulletin_board", + "list_invalid_processors", + "list_sensitive_processors", + "list_all_connections", + "create_connection", + "delete_connection", + "get_component_connections", + "create_controller", + "list_all_controllers", + "delete_controller", + "update_controller", + "schedule_controller", + "get_controller", + "list_all_controller_types", + "list_all_by_kind", + "list_all_input_ports", + "list_all_output_ports", + "list_all_funnels", + "list_all_remote_process_groups", + "delete_funnel", + "get_remote_process_group", + "update_process_group", + "create_funnel", + "create_remote_process_group", + "delete_remote_process_group", + "set_remote_process_group_transmission", + "get_pg_parents_ids", + "delete_port", + "create_port", ] log = logging.getLogger(__name__) @@ -38,23 +74,24 @@ def get_root_pg_id(): Returns (str): The UUID of the root PG """ - return nipyapi.nifi.FlowApi().get_process_group_status('root') \ - .process_group_status.id + return nipyapi.nifi.FlowApi().get_process_group_status("root").process_group_status.id -def recurse_flow(pg_id='root'): +def recurse_flow(pg_id="root"): """ Returns information about a Process Group and all its Child Flows. + Recurses the child flows by appending each process group with a 'nipyapi_extended' parameter which contains the child process groups, etc. + Note: This previously used actual recursion which broke on large NiFi - environments, we now use a task/list update approach + environments, we now use a task/list update approach. Args: pg_id (str): The Process Group UUID Returns: - (ProcessGroupFlowEntity): enriched NiFi Flow object + :class:`~nipyapi.nifi.models.ProcessGroupFlowEntity`: enriched NiFi Flow object """ assert isinstance(pg_id, str), "pg_id should be a string" @@ -63,13 +100,12 @@ def recurse_flow(pg_id='root'): while tasks: this_pg_id, this_parent_obj = tasks.pop() this_flow = get_flow(this_pg_id) - setattr(this_parent_obj, 'nipyapi_extended', this_flow) - tasks += [(x.id, x) for x in - this_flow.process_group_flow.flow.process_groups] + setattr(this_parent_obj, "nipyapi_extended", this_flow) + tasks += [(x.id, x) for x in this_flow.process_group_flow.flow.process_groups] return out -def get_flow(pg_id='root'): +def get_flow(pg_id="root"): """ Returns information about a Process Group and flow. @@ -81,14 +117,14 @@ def get_flow(pg_id='root'): process group if not set Returns: - (ProcessGroupFlowEntity): The Process Group object + :class:`~nipyapi.nifi.models.ProcessGroupFlowEntity`: The Process Group object """ assert isinstance(pg_id, str), "pg_id should be a string" with nipyapi.utils.rest_exceptions(): return nipyapi.nifi.FlowApi().get_flow(pg_id) -def get_process_group_status(pg_id='root', detail='names'): +def get_process_group_status(pg_id="root", detail="names"): """ Returns an entity containing the status of the Process Group. Optionally may be configured to return a simple dict of name:id pairings @@ -102,21 +138,20 @@ def get_process_group_status(pg_id='root', detail='names'): name:id pairings, or the full details. Defaults to 'names' Returns: - (ProcessGroupEntity): The Process Group Entity including the status + :class:`~nipyapi.nifi.models.ProcessGroupEntity`: The Process Group Entity including + the status """ assert isinstance(pg_id, str), "pg_id should be a string" - assert detail in ['names', 'all'] + assert detail in ["names", "all"] raw = nipyapi.nifi.ProcessGroupsApi().get_process_group(id=pg_id) - if detail == 'names': - out = { - raw.component.name: raw.component.id - } + if detail == "names": + out = {raw.component.name: raw.component.id} return out return raw @exception_handler(404, None) -def get_process_group(identifier, identifier_type='name', greedy=True): +def get_process_group(identifier, identifier_type="name", greedy=True): """ Filters the list of all process groups against a given identifier string occurring in a given identifier_type field. @@ -132,21 +167,20 @@ def get_process_group(identifier, identifier_type='name', greedy=True): """ assert isinstance(identifier, str) - assert identifier_type in ['name', 'id'] + assert identifier_type in ["name", "id"] with nipyapi.utils.rest_exceptions(): - if identifier_type == 'id' or identifier == 'root': + 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) + out = nipyapi.utils.filter_obj(obj, identifier, identifier_type, greedy=greedy) return out # pylint: disable=R1737 -def list_all_process_groups(pg_id='root'): +def list_all_process_groups(pg_id="root"): """ Returns a flattened list of all Process Groups on the canvas. Potentially slow if you have a large canvas. @@ -185,8 +219,8 @@ def flatten(parent_pg): # Flatten list of children with extended detail out = list(flatten(root_flow)) # update parent with flattened list of extended child detail - root_entity = get_process_group(pg_id, 'id') - setattr(root_entity, 'nipyapi_extended', root_flow) + root_entity = get_process_group(pg_id, "id") + setattr(root_entity, "nipyapi_extended", root_flow) out.append(root_entity) return out # @@ -198,7 +232,7 @@ def flatten(parent_pg): # return out -def list_invalid_processors(pg_id='root', summary=False): +def list_invalid_processors(pg_id="root", summary=False): """ Returns a flattened list of all Processors with Invalid Statuses @@ -213,17 +247,15 @@ def list_invalid_processors(pg_id='root', summary=False): """ assert isinstance(pg_id, str), "pg_id should be a string" assert isinstance(summary, bool) - proc_list = [x for x in list_all_processors(pg_id) - if x.component.validation_errors] + proc_list = [x for x in list_all_processors(pg_id) if x.component.validation_errors] if summary: - out = [{'id': x.id, 'summary': x.component.validation_errors} - for x in proc_list] + out = [{"id": x.id, "summary": x.component.validation_errors} for x in proc_list] else: out = proc_list return out -def list_sensitive_processors(pg_id='root', summary=False): +def list_sensitive_processors(pg_id="root", summary=False): """ Returns a flattened list of all Processors on the canvas which have sensitive properties that would need to be managed during deployment @@ -239,7 +271,7 @@ def list_sensitive_processors(pg_id='root', summary=False): """ assert isinstance(pg_id, str), "pg_id should be a string" assert isinstance(summary, bool) - cache = nipyapi.config.cache.get('list_sensitive_processors') + cache = nipyapi.config.cache.get("list_sensitive_processors") if not cache: cache = [] matches = [] @@ -257,18 +289,16 @@ def list_sensitive_processors(pg_id='root', summary=False): matches.append(proc) cache.append(str(proc.component.type)) if cache: - nipyapi.config.cache['list_sensitive_processors'] = cache + nipyapi.config.cache["list_sensitive_processors"] = cache if summary: return [ - {x.id: [ - p for p, q in x.component.config.descriptors.items() - if q.sensitive is True]} + {x.id: [p for p, q in x.component.config.descriptors.items() if q.sensitive is True]} for x in matches ] return matches -def list_all_processors(pg_id='root'): +def list_all_processors(pg_id="root"): """ Returns a flat list of all Processors under the provided Process Group @@ -281,11 +311,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: + 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 + id=pg_id, include_descendant_groups=True ) return targets.processors # Handle older NiFi instances @@ -324,22 +353,15 @@ def _running_schedule_process_group(pg_id_): return True return False - assert isinstance( - get_process_group(process_group_id, 'id'), - nipyapi.nifi.ProcessGroupEntity - ) - result = schedule_components( - pg_id=process_group_id, - scheduled=scheduled - ) + assert isinstance(get_process_group(process_group_id, "id"), nipyapi.nifi.ProcessGroupEntity) + result = schedule_components(pg_id=process_group_id, scheduled=scheduled) # If target scheduled state was successfully updated if result: # If we want to stop the processor if not scheduled: # Test that the processor threads have halted stop_test = nipyapi.utils.wait_to_complete( - _running_schedule_process_group, - process_group_id + _running_schedule_process_group, process_group_id ) if stop_test: # Return True if we stopped the Process Group @@ -374,15 +396,12 @@ def delete_process_group(process_group, force=False, refresh=True): target = process_group try: return nipyapi.nifi.ProcessGroupsApi().remove_process_group( - id=target.id, - version=target.revision.version, - client_id=target.revision.client_id + id=target.id, version=target.revision.version, client_id=target.revision.client_id ) except nipyapi.nifi.rest.ApiException as e: if force: # Retrieve parent process group - parent_pg_id = nipyapi.canvas.get_process_group(pg_id, 'id')\ - .component.parent_group_id + parent_pg_id = nipyapi.canvas.get_process_group(pg_id, "id").component.parent_group_id # Stop, drop, and roll. purge_process_group(target, stop=True) # Remove inbound connections @@ -400,21 +419,19 @@ def delete_process_group(process_group, force=False, refresh=True): removed_controllers_id.append(x.component.id) # Templates are not supported in NiFi 2.x - if nipyapi.utils.check_version('2', service='nifi') == 1: + if nipyapi.utils.check_version("2", service="nifi") == 1: for template in nipyapi.templates.list_all_templates(native=False): if target.id == template.template.group_id: nipyapi.templates.delete_template(template.id) # have to refresh revision after changes target = nipyapi.nifi.ProcessGroupsApi().get_process_group(pg_id) return nipyapi.nifi.ProcessGroupsApi().remove_process_group( - id=target.id, - version=target.revision.version, - client_id=target.revision.client_id + id=target.id, version=target.revision.version, client_id=target.revision.client_id ) raise ValueError(e.body) from e -def create_process_group(parent_pg, new_pg_name, location, comment=''): +def create_process_group(parent_pg, new_pg_name, location, comment=""): """ Creates a new Process Group with the given name under the provided parent Process Group at the given Location @@ -428,7 +445,7 @@ def create_process_group(parent_pg, new_pg_name, location, comment=''): comment (str): Entry for the Comments field Returns: - (ProcessGroupEntity): The new Process Group + :class:`~nipyapi.nifi.models.ProcessGroupEntity`: The new Process Group """ assert isinstance(parent_pg, nipyapi.nifi.ProcessGroupEntity) @@ -438,16 +455,13 @@ def create_process_group(parent_pg, new_pg_name, location, comment=''): return nipyapi.nifi.ProcessGroupsApi().create_process_group( id=parent_pg.id, body=nipyapi.nifi.ProcessGroupEntity( - revision={'version': 0}, + revision={"version": 0}, component=nipyapi.nifi.ProcessGroupDTO( name=new_pg_name, - position=nipyapi.nifi.PositionDTO( - x=float(location[0]), - y=float(location[1]) - ), - comments=comment - ) - ) + position=nipyapi.nifi.PositionDTO(x=float(location[0]), y=float(location[1])), + comments=comment, + ), + ), ) @@ -464,7 +478,7 @@ def list_all_processor_types(): return nipyapi.nifi.FlowApi().get_processor_types() -def get_processor_type(identifier, identifier_type='name', greedy=True): +def get_processor_type(identifier, identifier_type="name", greedy=True): """ Gets the abstract object describing a Processor, or list thereof @@ -481,9 +495,7 @@ def get_processor_type(identifier, identifier_type='name', greedy=True): with nipyapi.utils.rest_exceptions(): obj = list_all_processor_types().processor_types if obj: - return nipyapi.utils.filter_obj( - obj, identifier, identifier_type, greedy=greedy - ) + return nipyapi.utils.filter_obj(obj, identifier, identifier_type, greedy=greedy) return obj @@ -501,13 +513,13 @@ def create_processor(parent_pg, processor, location, name=None, config=None): new processor Returns: - (ProcessorEntity): The new Processor + :class:`~nipyapi.nifi.models.ProcessorEntity`: The new Processor """ assert isinstance(parent_pg, nipyapi.nifi.ProcessGroupEntity) assert isinstance(processor, nipyapi.nifi.DocumentedTypeDTO) if name is None: - processor_name = processor.type.split('.')[-1] + processor_name = processor.type.split(".")[-1] else: processor_name = name if config is None: @@ -518,22 +530,19 @@ def create_processor(parent_pg, processor, location, name=None, config=None): return nipyapi.nifi.ProcessGroupsApi().create_processor( id=parent_pg.id, body=nipyapi.nifi.ProcessorEntity( - revision={'version': 0}, + revision={"version": 0}, component=nipyapi.nifi.ProcessorDTO( - position=nipyapi.nifi.PositionDTO( - x=float(location[0]), - y=float(location[1]) - ), + position=nipyapi.nifi.PositionDTO(x=float(location[0]), y=float(location[1])), type=processor.type, name=processor_name, - config=target_config - ) - ) + config=target_config, + ), + ), ) @exception_handler(404, None) -def get_processor(identifier, identifier_type='name', greedy=True): +def get_processor(identifier, identifier_type="name", greedy=True): """ Filters the list of all Processors against the given identifier string in the given identifier_type field @@ -549,14 +558,12 @@ def get_processor(identifier, identifier_type='name', greedy=True): list(Objects) for multiple matches """ assert isinstance(identifier, str) - assert identifier_type in ['name', 'id'] - if identifier_type == 'id': + assert identifier_type in ["name", "id"] + if identifier_type == "id": out = nipyapi.nifi.ProcessorsApi().get_processor(identifier) else: obj = list_all_processors() - out = nipyapi.utils.filter_obj( - obj, identifier, identifier_type, greedy=greedy - ) + out = nipyapi.utils.filter_obj(obj, identifier, identifier_type, greedy=greedy) return out @@ -571,14 +578,14 @@ def delete_processor(processor, refresh=True, force=False): Processor before deletion. Behavior may change in future releases. Returns: - (ProcessorEntity): The updated ProcessorEntity + :class:`~nipyapi.nifi.models.ProcessorEntity`: The updated ProcessorEntity """ assert isinstance(processor, nipyapi.nifi.ProcessorEntity) assert isinstance(refresh, bool) assert isinstance(force, bool) if refresh or force: - target = get_processor(processor.id, 'id') + target = get_processor(processor.id, "id") if target is None: return None # Processor does not exist assert isinstance(target, nipyapi.nifi.ProcessorEntity) @@ -586,21 +593,18 @@ def delete_processor(processor, refresh=True, force=False): target = processor if force: if not schedule_processor(target, False): - raise ValueError("Could not prepare processor {0} for deletion" - .format(target.id)) + raise ValueError("Could not prepare processor {0} for deletion".format(target.id)) inbound_cons = [ - x for x in get_component_connections(processor) - if processor.id == x.destination_id + x for x in get_component_connections(processor) if processor.id == x.destination_id ] for con in inbound_cons: delete_connection(con, purge=True) # refresh state before trying delete - target = get_processor(processor.id, 'id') + target = get_processor(processor.id, "id") assert isinstance(target, nipyapi.nifi.ProcessorEntity) with nipyapi.utils.rest_exceptions(): return nipyapi.nifi.ProcessorsApi().delete_processor( - id=target.id, - version=target.revision.version + id=target.id, version=target.revision.version ) @@ -622,24 +626,15 @@ def schedule_components(pg_id, scheduled, components=None): (bool): True for success, False for not """ - assert isinstance( - get_process_group(pg_id, 'id'), - nipyapi.nifi.ProcessGroupEntity - ) + assert isinstance(get_process_group(pg_id, "id"), nipyapi.nifi.ProcessGroupEntity) assert isinstance(scheduled, bool) assert components is None or isinstance(components, list) - target_state = 'RUNNING' if scheduled else 'STOPPED' - body = nipyapi.nifi.ScheduleComponentsEntity( - id=pg_id, - state=target_state - ) + target_state = "RUNNING" if scheduled else "STOPPED" + body = nipyapi.nifi.ScheduleComponentsEntity(id=pg_id, state=target_state) if components: body.components = {i.id: i.revision for i in components} with nipyapi.utils.rest_exceptions(): - result = nipyapi.nifi.FlowApi().schedule_components( - id=pg_id, - body=body - ) + result = nipyapi.nifi.FlowApi().schedule_components(id=pg_id, body=body) if result.state == target_state: return True return False @@ -667,49 +662,44 @@ def schedule_processor(processor, scheduled, refresh=True): assert isinstance(refresh, bool) def _running_schedule_processor(processor_): - test_obj = nipyapi.canvas.get_processor(processor_.id, 'id') + test_obj = nipyapi.canvas.get_processor(processor_.id, "id") if test_obj.status.aggregate_snapshot.active_thread_count == 0: return True - log.info("Processor not stopped, active thread count %s", - test_obj.status.aggregate_snapshot.active_thread_count) + log.info( + "Processor not stopped, active thread count %s", + test_obj.status.aggregate_snapshot.active_thread_count, + ) return False def _starting_schedule_processor(processor_): - test_obj = nipyapi.canvas.get_processor(processor_.id, 'id') - if test_obj.component.state == 'RUNNING': + test_obj = nipyapi.canvas.get_processor(processor_.id, "id") + if test_obj.component.state == "RUNNING": return True - log.info("Processor not started, run_status %s", - test_obj.component.state) + log.info("Processor not started, run_status %s", test_obj.component.state) return False assert isinstance(scheduled, bool) if refresh: - target = nipyapi.canvas.get_processor(processor.id, 'id') + target = nipyapi.canvas.get_processor(processor.id, "id") assert isinstance(target, nipyapi.nifi.ProcessorEntity) else: target = processor result = schedule_components( - pg_id=target.status.group_id, - scheduled=scheduled, - components=[target] + pg_id=target.status.group_id, scheduled=scheduled, components=[target] ) # If target scheduled state was successfully updated if result: # If we want to stop the processor if not scheduled: # Test that the processor threads have halted - stop_test = nipyapi.utils.wait_to_complete( - _running_schedule_processor, target - ) + stop_test = nipyapi.utils.wait_to_complete(_running_schedule_processor, target) if stop_test: # Return True if we stopped the processor return result # Return False if we scheduled a stop, but it didn't stop return False # Test that the Processor started - start_test = nipyapi.utils.wait_to_complete( - _starting_schedule_processor, target - ) + start_test = nipyapi.utils.wait_to_complete(_starting_schedule_processor, target) if start_test: return result return False @@ -717,33 +707,30 @@ def _starting_schedule_processor(processor_): def update_process_group(pg, update, refresh=True): """ - Updates a given Process Group. + Updates a given Process Group. - Args: - pg (ProcessGroupEntity): The Process Group to - target for update - update (dict): key:value pairs to update - refresh (bool): Whether to refresh the Process Group before - applying the update + Args: + pg (ProcessGroupEntity): The Process Group to + target for update + update (dict): key:value pairs to update + refresh (bool): Whether to refresh the Process Group before + applying the update - Returns: - (ProcessGroupEntity): The updated ProcessorEntity + Returns: + :class:`~nipyapi.nifi.models.ProcessGroupEntity`: The updated ProcessorEntity - """ + """ assert isinstance(pg, nipyapi.nifi.ProcessGroupEntity) with nipyapi.utils.rest_exceptions(): if refresh: - pg = get_process_group(pg.id, 'id') + pg = get_process_group(pg.id, "id") return nipyapi.nifi.ProcessGroupsApi().update_process_group( id=pg.id, body=nipyapi.nifi.ProcessGroupEntity( - component=nipyapi.nifi.ProcessGroupDTO( - id=pg.id, - **update - ), + component=nipyapi.nifi.ProcessGroupDTO(id=pg.id, **update), id=pg.id, - revision=pg.revision - ) + revision=pg.revision, + ), ) @@ -761,25 +748,20 @@ def update_processor(processor, update, refresh=True): before applying the update Returns: - (ProcessorEntity): The updated ProcessorEntity + :class:`~nipyapi.nifi.models.ProcessorEntity`: The updated ProcessorEntity """ if not isinstance(update, nipyapi.nifi.ProcessorConfigDTO): - raise ValueError( - "update param is not an instance of nifi.ProcessorConfigDTO" - ) + raise ValueError("update param is not an instance of nifi.ProcessorConfigDTO") with nipyapi.utils.rest_exceptions(): if refresh: - processor = get_processor(processor.id, 'id') + processor = get_processor(processor.id, "id") return nipyapi.nifi.ProcessorsApi().update_processor( id=processor.id, body=nipyapi.nifi.ProcessorEntity( - component=nipyapi.nifi.ProcessorDTO( - config=update, - id=processor.id - ), + component=nipyapi.nifi.ProcessorDTO(config=update, id=processor.id), revision=processor.revision, - ) + ), ) @@ -794,13 +776,12 @@ def get_variable_registry(process_group, ancestors=True): Process Groups Returns: - (VariableRegistryEntity): The Variable Registry + :class:`~nipyapi.nifi.models.VariableRegistryEntity`: The Variable Registry """ with nipyapi.utils.rest_exceptions(): return nipyapi.nifi.ProcessGroupsApi().get_variable_registry( - process_group.id, - include_ancestor_groups=ancestors + process_group.id, include_ancestor_groups=ancestors ) @@ -809,46 +790,38 @@ def update_variable_registry(process_group, update, refresh=True): Updates one or more key:value pairs in the variable registry Args: - process_group (ProcessGroupEntity): The Process Group which has the - Variable Registry to be updated + process_group (:class:`~nipyapi.nifi.models.ProcessGroupEntity`): The Process Group which + has the Variable Registry to be updated update (list[tuple]): The variables to write to the registry refresh (bool): Whether to refresh the object revision before updating Returns: - (VariableRegistryEntity): The created or updated Variable Registry - Entries + :class:`~nipyapi.nifi.models.VariableRegistryEntity`: The created or updated Variable + Registry Entries """ if not isinstance(process_group, nipyapi.nifi.ProcessGroupEntity): - raise ValueError( - 'param process_group is not a valid nifi.ProcessGroupEntity' - ) + raise ValueError("param process_group is not a valid nifi.ProcessGroupEntity") if not isinstance(update, list): - raise ValueError( - 'param update is not a valid list of (key,value) tuples' - ) + raise ValueError("param update is not a valid list of (key,value) tuples") # Parse variable update into the datatype var_update = [ nipyapi.nifi.VariableEntity( - nipyapi.nifi.VariableDTO( - name=li[0], - value=li[1], - process_group_id=process_group.id - ) - ) for li in update + nipyapi.nifi.VariableDTO(name=li[0], value=li[1], process_group_id=process_group.id) + ) + for li in update ] with nipyapi.utils.rest_exceptions(): if refresh: - process_group = get_process_group(process_group.id, 'id') + process_group = get_process_group(process_group.id, "id") return nipyapi.nifi.ProcessGroupsApi().update_variable_registry( id=process_group.id, body=nipyapi.nifi.VariableRegistryEntity( process_group_revision=process_group.revision, variable_registry=nipyapi.nifi.VariableRegistryDTO( - process_group_id=process_group.id, - variables=var_update - ) - ) + process_group_id=process_group.id, variables=var_update + ), + ), ) @@ -864,26 +837,26 @@ def create_connection(source, target, relationships=None, name=None): name (str): Defaults to None, String of Name for Connection (optional) Returns: - (ConnectionEntity): for the created connection + :class:`~nipyapi.nifi.models.ConnectionEntity`: for the created connection """ # determine source and destination strings by class supplied source_type = nipyapi.utils.infer_object_label_from_class(source) target_type = nipyapi.utils.infer_object_label_from_class(target) - if source_type not in ['OUTPUT_PORT', 'INPUT_PORT', 'FUNNEL']: + if source_type not in ["OUTPUT_PORT", "INPUT_PORT", "FUNNEL"]: source_rels = [x.name for x in source.component.relationships] if relationships: - assert all(i in source_rels for i in relationships), \ - "One or more relationships [{0}] not in list of valid " \ - "Source Relationships [{1}]" \ - .format(str(relationships), str(source_rels)) + assert all(i in source_rels for i in relationships), ( + "One or more relationships [{0}] not in list of valid " + "Source Relationships [{1}]".format(str(relationships), str(source_rels)) + ) else: # if no relationships supplied, we connect them all relationships = source_rels - if source_type == 'OUTPUT_PORT': + if source_type == "OUTPUT_PORT": # the hosting process group for an Output port connection to another # process group is the common parent process group - parent_pg = get_process_group(source.component.parent_group_id, 'id') + parent_pg = get_process_group(source.component.parent_group_id, "id") if parent_pg.id == get_root_pg_id(): parent_id = parent_pg.id else: @@ -894,26 +867,20 @@ def create_connection(source, target, relationships=None, name=None): return nipyapi.nifi.ProcessGroupsApi().create_connection( id=parent_id, body=nipyapi.nifi.ConnectionEntity( - revision=nipyapi.nifi.RevisionDTO( - version=0 - ), + revision=nipyapi.nifi.RevisionDTO(version=0), source_type=source_type, destination_type=target_type, component=nipyapi.nifi.ConnectionDTO( source=nipyapi.nifi.ConnectableDTO( - id=source.id, - group_id=source.component.parent_group_id, - type=source_type + id=source.id, group_id=source.component.parent_group_id, type=source_type ), name=name, destination=nipyapi.nifi.ConnectableDTO( - id=target.id, - group_id=target.component.parent_group_id, - type=target_type + id=target.id, group_id=target.component.parent_group_id, type=target_type ), - selected_relationships=relationships - ) - ) + selected_relationships=relationships, + ), + ), ) @@ -926,7 +893,7 @@ def delete_connection(connection, purge=False): purge (bool): True to Purge, Defaults to False Returns: - (ConnectionEntity): the modified Connection + :class:`~nipyapi.nifi.models.ConnectionEntity`: the modified Connection """ assert isinstance(connection, nipyapi.nifi.ConnectionEntity) @@ -934,12 +901,11 @@ def delete_connection(connection, purge=False): purge_connection(connection.id) with nipyapi.utils.rest_exceptions(): return nipyapi.nifi.ConnectionsApi().delete_connection( - id=connection.id, - version=connection.revision.version + id=connection.id, version=connection.revision.version ) -def list_all_connections(pg_id='root', descendants=True): +def list_all_connections(pg_id="root", descendants=True): """ Lists all connections for a given Process Group ID @@ -951,7 +917,7 @@ def list_all_connections(pg_id='root', descendants=True): (list): List of ConnectionEntity objects """ - return list_all_by_kind('connections', pg_id, descendants) + return list_all_by_kind("connections", pg_id, descendants) def get_component_connections(component): @@ -966,8 +932,8 @@ def get_component_connections(component): """ assert isinstance(component, nipyapi.nifi.ProcessorEntity) return [ - x for x - in list_all_connections(pg_id=component.component.parent_group_id) + x + for x in list_all_connections(pg_id=component.component.parent_group_id) if component.id in [x.destination_id, x.source_id] ] @@ -985,27 +951,29 @@ def purge_connection(con_id): con_id (str): The UUID of the Connection to be purged Returns: - (DropRequestEntity): The status reporting object for the drop + :class:`~nipyapi.nifi.models.DropRequestEntity`: The status reporting object for the drop request. """ def _autumn_leaves(con_id_, drop_request_): - test_obj = nipyapi.nifi.FlowfileQueuesApi().get_drop_request( - con_id_, - drop_request_.drop_request.id - ).drop_request + test_obj = ( + nipyapi.nifi.FlowFileQueuesApi() + .get_drop_request(con_id_, drop_request_.drop_request.id) + .drop_request + ) if not test_obj.finished: return False if test_obj.failure_reason: raise ValueError( - "Unable to complete drop request{0}, error was {1}" - .format(test_obj, test_obj.drop_request.failure_reason) + "Unable to complete drop request{0}, error was {1}".format( + test_obj, test_obj.drop_request.failure_reason + ) ) return True with nipyapi.utils.rest_exceptions(): - drop_req = nipyapi.nifi.FlowfileQueuesApi().create_drop_request(con_id) + drop_req = nipyapi.nifi.FlowFileQueuesApi().create_drop_request(con_id) assert isinstance(drop_req, nipyapi.nifi.DropRequestEntity) return nipyapi.utils.wait_to_complete(_autumn_leaves, con_id, drop_req) @@ -1030,8 +998,7 @@ def purge_process_group(process_group, stop=False): if stop: if not schedule_process_group(process_group.id, False): raise ValueError( - "Unable to stop Process Group {0} for purging" - .format(process_group.id) + "Unable to stop Process Group {0} for purging".format(process_group.id) ) cons = list_all_connections(process_group.id) result = [] @@ -1065,47 +1032,43 @@ def get_bulletin_board(): def create_controller(parent_pg, controller, name=None): """ - Creates a new Controller Service in a given Process Group of the given - Controller type, with the given Name + Creates a new Controller Service in a given Process Group of the given Controller type, with the + given Name. Args: - parent_pg (ProcessGroupEntity): Target Parent PG - controller (DocumentedTypeDTO): Type of Controller to create, found - via the list_all_controller_types method - name (str[Optional]): Name for the new Controller as a String + parent_pg (:class:`~nipyapi.nifi.models.ProcessGroupEntity`): Target Parent PG + controller (:class:`~nipyapi.nifi.models.DocumentedTypeDTO`): Type of Controller to create, + found via the list_all_controller_types method + name (str, optional): Name for the new Controller as a String Returns: - (ControllerServiceEntity) + :class:`~nipyapi.nifi.models.ControllerServiceEntity`: The created controller service """ assert isinstance(controller, nipyapi.nifi.DocumentedTypeDTO) assert isinstance(parent_pg, nipyapi.nifi.ProcessGroupEntity) assert name is None or isinstance(name, str) with nipyapi.utils.rest_exceptions(): - out = nipyapi.nifi.ProcessGroupsApi().create_controller_service( + # NiFi 2.x creates a PG-scoped Controller Service via ProcessGroupsApi + out = nipyapi.nifi.ProcessGroupsApi().create_controller_service1( id=parent_pg.id, body=nipyapi.nifi.ControllerServiceEntity( - revision={'version': 0}, + revision={"version": 0}, component=nipyapi.nifi.ControllerServiceDTO( - bundle=controller.bundle, - type=controller.type - ) + bundle=controller.bundle, type=controller.type + ), ), ) if name: - update_controller( - out, - nipyapi.nifi.ControllerServiceDTO( - name=name - ) - ) + update_controller(out, nipyapi.nifi.ControllerServiceDTO(name=name)) return out -def list_all_controllers(pg_id='root', descendants=True, include_reporting_tasks=False): +def list_all_controllers(pg_id="root", descendants=True, include_reporting_tasks=False): """ - Lists all controllers under a given Process Group, defaults to Root - Optionally recurses all child Process Groups as well + Lists all controllers under a given Process Group, defaults to Root. + Optionally recurses all child Process Groups as well. + Args: pg_id (str): String of the ID of the Process Group to list from descendants (bool): True to recurse child PGs, False to not @@ -1120,27 +1083,22 @@ def list_all_controllers(pg_id='root', descendants=True, include_reporting_tasks 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: + 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')] + pgs = [get_process_group(pg_id, "id")] for pg in pgs: - new_conts = handle.get_controller_services_from_group( - pg.id).controller_services + new_conts = handle.get_controller_services_from_group(pg.id).controller_services # trim duplicates from inheritance - out += [ - x for x in new_conts - if x.id not in [y.id for y in out] - ] + 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 + pg_id, include_descendant_groups=descendants ).controller_services if include_reporting_tasks: mgmt_handle = nipyapi.nifi.FlowApi() @@ -1164,7 +1122,7 @@ def delete_controller(controller, force=False): assert isinstance(force, bool) def _del_cont(cont_id): - if not get_controller(cont_id, 'id', bool_response=True): + if not get_controller(cont_id, "id", bool_response=True): return True return False @@ -1174,14 +1132,10 @@ def _del_cont(cont_id): controller = schedule_controller(controller, False, True) with nipyapi.utils.rest_exceptions(): result = handle.remove_controller_service( - id=controller.id, - version=controller.revision.version + id=controller.id, version=controller.revision.version ) del_test = nipyapi.utils.wait_to_complete( - _del_cont, - controller.id, - nipyapi_max_wait=15, - nipyapi_delay=1 + _del_cont, controller.id, nipyapi_max_wait=15, nipyapi_delay=1 ) if not del_test: raise ValueError("Timed out waiting for Controller Deletion") @@ -1208,10 +1162,8 @@ def update_controller(controller, update): return nipyapi.nifi.ControllerServicesApi().update_controller_service( id=controller.id, body=nipyapi.nifi.ControllerServiceEntity( - component=update, - revision=controller.revision, - id=controller.id - ) + component=update, revision=controller.revision, id=controller.id + ), ) @@ -1233,33 +1185,23 @@ def schedule_controller(controller, scheduled, refresh=False): assert isinstance(scheduled, bool) def _schedule_controller_state(cont_id, tgt_state): - test_obj = get_controller(cont_id, 'id') + test_obj = get_controller(cont_id, "id") if test_obj.component.state == tgt_state: return True return False handle = nipyapi.nifi.ControllerServicesApi() - target_state = 'ENABLED' if scheduled else 'DISABLED' + target_state = "ENABLED" if scheduled else "DISABLED" if refresh: - controller = nipyapi.canvas.get_controller(controller.id, 'id') + controller = nipyapi.canvas.get_controller(controller.id, "id") assert isinstance(controller, nipyapi.nifi.ControllerServiceEntity) - if nipyapi.utils.check_version('1.2.0') >= 0: - # Case where NiFi <= 1.2.0 - result = update_controller( - controller=controller, - update=nipyapi.nifi.ControllerServiceDTO( - state=target_state - ) - ) - else: - # Case where NiFi > 1.2.0 - result = handle.update_run_status( - id=controller.id, - body=nipyapi.nifi.ControllerServiceRunStatusEntity( - revision=controller.revision, - state=target_state - ) - ) + # NiFi 2.x: update run status via ControllerServicesApi.update_run_status1 + result = handle.update_run_status1( + id=controller.id, + body=nipyapi.nifi.ControllerServiceRunStatusEntity( + revision=controller.revision, state=target_state + ), + ) if not result: raise ValueError("Scheduling request failed") state_test = nipyapi.utils.wait_to_complete( @@ -1267,15 +1209,16 @@ def _schedule_controller_state(cont_id, tgt_state): controller.id, target_state, nipyapi_delay=nipyapi.config.long_retry_delay, - nipyapi_max_wait=nipyapi.config.long_max_wait + nipyapi_max_wait=nipyapi.config.long_max_wait, ) if state_test: - return get_controller(controller.id, 'id') + return get_controller(controller.id, "id") raise ValueError("Scheduling request timed out") -def get_controller(identifier, identifier_type='name', bool_response=False, - include_reporting_tasks=True): +def get_controller( + identifier, identifier_type="name", bool_response=False, include_reporting_tasks=True +): """ Retrieve a given Controller @@ -1290,11 +1233,11 @@ def get_controller(identifier, identifier_type='name', bool_response=False, """ assert isinstance(identifier, str) - assert identifier_type in ['name', 'id'] + assert identifier_type in ["name", "id"] handle = nipyapi.nifi.ControllerServicesApi() out = None try: - if identifier_type == 'id': + if identifier_type == "id": out = handle.get_controller_service(identifier) else: obj = list_all_controllers(include_reporting_tasks=include_reporting_tasks) @@ -1317,7 +1260,7 @@ def list_all_controller_types(): return handle.get_controller_service_types().controller_service_types -def get_controller_type(identifier, identifier_type='name', greedy=True): +def get_controller_type(identifier, identifier_type="name", greedy=True): """ Gets the abstract object describing a controller, or list thereof @@ -1334,13 +1277,11 @@ def get_controller_type(identifier, identifier_type='name', greedy=True): with nipyapi.utils.rest_exceptions(): obj = list_all_controller_types() if obj: - return nipyapi.utils.filter_obj( - obj, identifier, identifier_type, greedy=greedy - ) + return nipyapi.utils.filter_obj(obj, identifier, identifier_type, greedy=greedy) return obj -def list_all_by_kind(kind, pg_id='root', descendants=True): +def list_all_by_kind(kind, pg_id="root", descendants=True): """ Retrieves a list of all instances of a supported object type @@ -1355,63 +1296,64 @@ def list_all_by_kind(kind, pg_id='root', descendants=True): """ assert kind in [ - 'input_ports', 'output_ports', 'funnels', 'controllers', 'connections', - 'remote_process_groups' + "input_ports", + "output_ports", + "funnels", + "controllers", + "connections", + "remote_process_groups", ] - if kind == 'controllers': + if kind == "controllers": return list_all_controllers(pg_id, descendants) handle = nipyapi.nifi.ProcessGroupsApi() - call_function = getattr(handle, 'get_' + kind) + call_function = getattr(handle, "get_" + kind) out = [] if descendants: pgs = list_all_process_groups(pg_id) else: - pgs = [get_process_group(pg_id, 'id')] + pgs = [get_process_group(pg_id, "id")] for pg in pgs: out += getattr(call_function(pg.id), kind) return out -def list_all_input_ports(pg_id='root', descendants=True): +def list_all_input_ports(pg_id="root", descendants=True): """Convenience wrapper for list_all_by_kind for input ports""" - return list_all_by_kind('input_ports', pg_id, descendants) + return list_all_by_kind("input_ports", pg_id, descendants) -def list_all_output_ports(pg_id='root', descendants=True): +def list_all_output_ports(pg_id="root", descendants=True): """Convenience wrapper for list_all_by_kind for output ports""" - return list_all_by_kind('output_ports', pg_id, descendants) + return list_all_by_kind("output_ports", pg_id, descendants) -def list_all_funnels(pg_id='root', descendants=True): +def list_all_funnels(pg_id="root", descendants=True): """Convenience wrapper for list_all_by_kind for funnels""" - return list_all_by_kind('funnels', pg_id, descendants) + return list_all_by_kind("funnels", pg_id, descendants) -def list_all_remote_process_groups(pg_id='root', descendants=True): +def list_all_remote_process_groups(pg_id="root", descendants=True): """Convenience wrapper for list_all_by_kind for remote process groups""" - return list_all_by_kind('remote_process_groups', pg_id, descendants) + return list_all_by_kind("remote_process_groups", pg_id, descendants) def get_remote_process_group(rpg_id, summary=False): """ Fetch a remote process group object, with optional summary of just ports """ - rpg = nipyapi.nifi.RemoteProcessGroupsApi().get_remote_process_group( - rpg_id - ) + rpg = nipyapi.nifi.RemoteProcessGroupsApi().get_remote_process_group(rpg_id) if not summary: out = rpg else: out = { - 'id': rpg.id, - 'input_ports': rpg.component.contents.input_ports, - 'output_ports': rpg.component.contents.output_ports + "id": rpg.id, + "input_ports": rpg.component.contents.input_ports, + "output_ports": rpg.component.contents.output_ports, } return out -def create_remote_process_group(target_uris, transport='RAW', pg_id='root', - position=None): +def create_remote_process_group(target_uris, transport="RAW", pg_id="root", position=None): """ Creates a new Remote Process Group with given parameters @@ -1426,9 +1368,9 @@ def create_remote_process_group(target_uris, transport='RAW', pg_id='root', (RemoteProcessGroupEntity) """ assert isinstance(target_uris, str) - assert transport in ['RAW', 'HTTP'] + assert transport in ["RAW", "HTTP"] assert isinstance(pg_id, str) - pg_id = pg_id if not 'root' else get_root_pg_id() + pg_id = pg_id if not "root" else get_root_pg_id() position = position if position else (400, 400) assert isinstance(position, tuple) with nipyapi.utils.rest_exceptions(): @@ -1436,15 +1378,12 @@ def create_remote_process_group(target_uris, transport='RAW', pg_id='root', id=pg_id, body=nipyapi.nifi.RemoteProcessGroupEntity( component=nipyapi.nifi.RemoteProcessGroupDTO( - position=nipyapi.nifi.PositionDTO( - x=float(position[0]), - y=float(position[1]) - ), + position=nipyapi.nifi.PositionDTO(x=float(position[0]), y=float(position[1])), target_uris=target_uris, - transport_protocol=transport + transport_protocol=transport, ), revision=nipyapi.nifi.RevisionDTO(version=0), - ) + ), ) @@ -1464,10 +1403,7 @@ def delete_remote_process_group(rpg, refresh=True): rpg = get_remote_process_group(rpg.id) handle = nipyapi.nifi.RemoteProcessGroupsApi() with nipyapi.utils.rest_exceptions(): - return handle.remove_remote_process_group( - id=rpg.id, - version=rpg.revision.version - ) + return handle.remove_remote_process_group(id=rpg.id, version=rpg.revision.version) def set_remote_process_group_transmission(rpg, enable=True, refresh=True): @@ -1492,9 +1428,8 @@ def set_remote_process_group_transmission(rpg, enable=True, refresh=True): return handle.update_remote_process_group_run_status( id=rpg.id, body=nipyapi.nifi.RemotePortRunStatusEntity( - state='TRANSMITTING' if enable else 'STOPPED', - revision=rpg.revision - ) + state="TRANSMITTING" if enable else "STOPPED", revision=rpg.revision + ), ) @@ -1519,7 +1454,7 @@ def create_port(pg_id, port_type, name, state, position=None): position = position if position else (400, 400) assert isinstance(position, tuple) handle = nipyapi.nifi.ProcessGroupsApi() - port_generator = getattr(handle, 'create_' + port_type.lower()) + port_generator = getattr(handle, "create_" + port_type.lower()) with nipyapi.utils.rest_exceptions(): return port_generator( id=pg_id, @@ -1527,35 +1462,32 @@ def create_port(pg_id, port_type, name, state, position=None): revision=nipyapi.nifi.RevisionDTO(version=0), component=nipyapi.nifi.PortDTO( parent_group_id=pg_id, - position=nipyapi.nifi.PositionDTO( - x=float(position[0]), - y=float(position[1]) - ), - name=name - ) - ) + position=nipyapi.nifi.PositionDTO(x=float(position[0]), y=float(position[1])), + name=name, + ), + ), ) def delete_port(port): """Deletes a given port from the canvas if possible""" assert isinstance(port, nipyapi.nifi.PortEntity) - if 'INPUT' in port.port_type: + if "INPUT" in port.port_type: with nipyapi.utils.rest_exceptions(): return nipyapi.nifi.InputPortsApi().remove_input_port( - id=port.id, - version=port.revision.version) - if 'OUTPUT' in port.port_type: + id=port.id, version=port.revision.version + ) + if "OUTPUT" in port.port_type: with nipyapi.utils.rest_exceptions(): return nipyapi.nifi.OutputPortsApi().remove_output_port( - id=port.id, - version=port.revision.version) + id=port.id, version=port.revision.version + ) def get_funnel(funnel_id): """Gets a given Funnel by ID""" with nipyapi.utils.rest_exceptions(): - return nipyapi.nifi.FunnelApi().get_funnel(funnel_id) + return nipyapi.nifi.FunnelsApi().get_funnel(funnel_id) def create_funnel(pg_id, position=None): @@ -1567,7 +1499,7 @@ def create_funnel(pg_id, position=None): position (tuple[int, int]): Position on canvas Returns: - (FunnelEntity) Created Funnel + :class:`~nipyapi.nifi.models.FunnelEntity`: Created Funnel """ position = position if position else (400, 400) assert isinstance(position, tuple) @@ -1578,12 +1510,9 @@ def create_funnel(pg_id, position=None): revision=nipyapi.nifi.RevisionDTO(version=0), component=nipyapi.nifi.FunnelDTO( parent_group_id=pg_id, - position=nipyapi.nifi.PositionDTO( - x=float(position[0]), - y=float(position[1]) - ), - ) - ) + position=nipyapi.nifi.PositionDTO(x=float(position[0]), y=float(position[1])), + ), + ), ) @@ -1597,15 +1526,14 @@ def delete_funnel(funnel, refresh=True): before execution Returns: - (FunnelEntity) Deleted FunnelEntity reference + :class:`~nipyapi.nifi.models.FunnelEntity`: Deleted FunnelEntity reference """ assert isinstance(funnel, nipyapi.nifi.FunnelEntity) with nipyapi.utils.rest_exceptions(): if refresh: funnel = get_funnel(funnel.id) - return nipyapi.nifi.FunnelApi().remove_funnel( - id=funnel.id, - version=funnel.revision.version + return nipyapi.nifi.FunnelsApi().remove_funnel( + id=funnel.id, version=funnel.revision.version ) @@ -1621,8 +1549,7 @@ def get_pg_parents_ids(pg_id): """ parent_groups = [] while pg_id: - pg_id = nipyapi.canvas.get_process_group(pg_id, 'id') \ - .component.parent_group_id + pg_id = nipyapi.canvas.get_process_group(pg_id, "id").component.parent_group_id parent_groups.append(pg_id) # Removing the None value parent_groups.pop() diff --git a/nipyapi/config.py b/nipyapi/config.py index 94755aee..8aaf511a 100644 --- a/nipyapi/config.py +++ b/nipyapi/config.py @@ -2,15 +2,38 @@ A set of defaults and parameters used elsewhere in the project. Also provides a handy link to the low-level client SDK configuration singleton objects. + +Notes for NiFi/Registry 2.x: + +- Prefer configuring TLS on the configuration objects directly: + + - nifi_config.ssl_ca_cert, nifi_config.cert_file, nifi_config.key_file + - registry_config.ssl_ca_cert, registry_config.cert_file, registry_config.key_file + +- Then connect via utils.set_endpoint(url, ssl=True, login=True|False) + + - For mTLS, pass login=False and rely on the configured client cert/key +- Supported environment toggles for tests and convenience: + - REQUESTS_CA_BUNDLE (CA bundle) + - NIPYAPI_VERIFY_SSL (0/1) and NIPYAPI_CHECK_HOSTNAME (0/1) + +For a step-by-step guide on configuring NiFi/Registry authentication +(single-user, LDAP, mTLS, OIDC), +see the project documentation: docs/profiles.rst and docs/security.rst or the online guide at +https://nipyapi.readthedocs.io/en/latest/profiles.html + +Deprecated (kept for backward compatibility; prefer explicit configuration): +- NIFI_CA_CERT / NIFI_CLIENT_CERT / NIFI_CLIENT_KEY +- REGISTRY_CA_CERT / REGISTRY_CLIENT_CERT / REGISTRY_CLIENT_KEY +- Demo/test credentials (default_nifi_username/password, default_registry_username/password) """ import os -import ssl -import urllib3 +import warnings + from nipyapi.nifi import configuration as nifi_config from nipyapi.registry import configuration as registry_config - # --- Default Host URLs ----- # Note that changing the default hosts below will not # affect an API connection that's already running. @@ -20,17 +43,23 @@ # Set Default Host for NiFi default_host = "localhost" # Default to localhost for release # -nifi_config.host = os.getenv( - "NIFI_API_ENDPOINT", "http://" + default_host + ":8080/nifi-api" +nifi_config.host = os.getenv("NIFI_API_ENDPOINT", "https://" + default_host + ":9443/nifi-api") +# Set Default Host for NiFi-Registry (default secure in 2.x single/ldap profiles use +# 18444/18445; single-user registry is http 18080) +registry_config.host = os.getenv( + "REGISTRY_API_ENDPOINT", "http://" + default_host + ":18080/nifi-registry-api" ) -# Set Default Host for NiFi-Registry -registry_config.host = "http://" + default_host + ":18080/nifi-registry-api" # --- Project Root ------ # Is is helpful to have a reference to the root directory of the project PROJECT_ROOT_DIR = os.path.abspath(os.path.dirname(__file__)) +# --- Profiles Configuration ------ +# Default path to profiles file (can be overridden programmatically or via environment) +default_profiles_file = "examples/profiles.yml" + + # --- Task wait delays ------ # Set how fast to recheck for completion of a short running task in seconds short_retry_delay = 0.5 @@ -52,35 +81,23 @@ # Note that 'id' is used for UUID by convention, but should not be confused # with 'identity' in security contexts. registered_filters = { - 'Bucket': {'id': ['identifier'], 'name': ['name']}, - 'VersionedFlow': {'id': ['identifier'], 'name': ['name']}, - 'FlowRegistryClientEntity': {'id': ['id'], 'name': ['component', 'name']}, - 'ProcessGroupEntity': {'id': ['id'], 'name': ['status', 'name']}, - 'DocumentedTypeDTO': {'bundle': ['bundle', 'artifact'], - 'name': ['type'], - 'tag': ['tags']}, - 'ProcessorEntity': {'id': ['id'], 'name': ['status', 'name']}, - 'User': {'identity': ['identity'], 'id': ['identifier']}, - 'UserGroupEntity': {'identity': ['component', 'identity'], 'id': ['id']}, - 'UserGroup': {'identity': ['identity'], 'id': ['identifier']}, - 'UserEntity': {'identity': ['component', 'identity'], 'id': ['id']}, - 'TemplateEntity': {'id': ['id'], 'name': ['template', 'name']}, - 'ControllerServiceEntity': {'id': ['id'], 'name': ['component', 'name']}, - 'ParameterContextEntity': {'id': ['id'], 'name': ['component', 'name']}, - 'ReportingTaskEntity': {'id': ['id'], 'name': ['component', 'name']} + "Bucket": {"id": ["identifier"], "name": ["name"]}, + "VersionedFlow": {"id": ["identifier"], "name": ["name"]}, + "FlowRegistryClientEntity": {"id": ["id"], "name": ["component", "name"]}, + "ProcessGroupEntity": {"id": ["id"], "name": ["status", "name"]}, + "DocumentedTypeDTO": {"bundle": ["bundle", "artifact"], "name": ["type"], "tag": ["tags"]}, + "ProcessorEntity": {"id": ["id"], "name": ["status", "name"]}, + "User": {"identity": ["identity"], "id": ["identifier"]}, + "UserGroupEntity": {"identity": ["component", "identity"], "id": ["id"]}, + "UserGroup": {"identity": ["identity"], "id": ["identifier"]}, + "UserEntity": {"identity": ["component", "identity"], "id": ["id"]}, + "TemplateEntity": {"id": ["id"], "name": ["template", "name"]}, + "ControllerServiceEntity": {"id": ["id"], "name": ["component", "name"]}, + "ParameterContextEntity": {"id": ["id"], "name": ["component", "name"]}, + "ReportingTaskEntity": {"id": ["id"], "name": ["component", "name"]}, } -# --- Version Checking -# Method to check if we're compatible with the API endpoint -# NOT YET IMPLEMENTED -# If None, then no check has been done -# If True, then we have tested and there are no issues -# If False, then we believe we are incompatible -nifi_config.version_check = None -registry_config.version_check = None - - # --- Simple Cache # This is a simple session-wide insecure cache for certain slow calls to speed # up subsequent requests. It is very stupid, so do not expect session handling, @@ -88,65 +105,57 @@ cache = {} -# --- Security Context -# This allows easy reference to a set of certificates for use in automation -# By default it points to our demo certs, change it for your environment -default_certs_path = os.path.join(PROJECT_ROOT_DIR, "demo/keys") -default_ssl_context = { - "ca_file": os.path.join(default_certs_path, "localhost-ts.pem"), - "client_cert_file": os.path.join(default_certs_path, "client-cert.pem"), - "client_key_file": os.path.join(default_certs_path, "client-key.pem"), - "client_key_password": "clientPassword", -} -# Identities and passwords to be used for service login if called for -default_nifi_username = "nobel" -default_nifi_password = "password" -default_registry_username = "nobel" -default_registry_password = "password" -# Identity to be used for mTLS authentication -default_mtls_identity = "CN=user1, OU=nifi" -# Identity to be used in the Registry Client Proxy setup -# If called for during policy setup, particularly bootstrap_policies -default_proxy_user = "CN=user1, OU=nifi" - -# Auth handling -# If set, NiPyAPI will always include the Basic Authorization header -global_force_basic_auth = False -nifi_config.username = default_nifi_username -nifi_config.password = default_nifi_password -nifi_config.force_basic_auth = global_force_basic_auth -registry_config.username = default_registry_username -registry_config.password = default_registry_password -registry_config.force_basic_auth = global_force_basic_auth - -# Set SSL Handling -# When operating with self signed certs, your log can fill up with -# unnecessary warnings -# Set to True by default, change to false if necessary -global_ssl_verify = True -disable_insecure_request_warnings = False - -nifi_config.verify_ssl = global_ssl_verify -registry_config.verify_ssl = global_ssl_verify -if not global_ssl_verify or disable_insecure_request_warnings: - urllib3.disable_warnings(urllib3.exceptions.InsecureRequestWarning) - -# Enforce no host checking when SSL context is disabled -global_ssl_host_check = False -if not global_ssl_host_check: - nifi_config.ssl_context = ssl.create_default_context() - nifi_config.ssl_context.check_hostname = False - nifi_config.ssl_context.verify_mode = ssl.CERT_NONE - - registry_config.ssl_context = ssl.create_default_context() - registry_config.ssl_context.check_hostname = False - registry_config.ssl_context.verify_mode = ssl.CERT_NONE - -if os.getenv("NIFI_CA_CERT") is not None: - nifi_config.ssl_ca_cert = os.getenv("NIFI_CA_CERT") +# --- SSL Configuration Values --- + +# Global SSL settings (DEPRECATED - use profiles for per-service control) +global_ssl_verify = True # Deprecated: Use profiles with nifi_verify_ssl/registry_verify_ssl +global_ssl_host_check = ( + True # Deprecated: Use profiles with nifi_disable_host_check/registry_disable_host_check +) +disable_insecure_request_warnings = False # Deprecated: Use profiles with suppress_ssl_warnings + + +# --- Environment Variable Certificate Setup --- + +# Back-compat TLS envs (DEPRECATED): prefer REQUESTS_CA_BUNDLE or direct config +_nifi_ca = os.getenv("NIFI_CA_CERT") +if _nifi_ca is not None: + warnings.warn( + "NIFI_CA_CERT / NIFI_CLIENT_CERT / NIFI_CLIENT_KEY are deprecated; " + "set configuration.ssl_ca_cert/cert_file/key_file explicitly or use REQUESTS_CA_BUNDLE", + DeprecationWarning, + stacklevel=2, + ) + nifi_config.ssl_ca_cert = _nifi_ca nifi_config.cert_file = os.getenv("NIFI_CLIENT_CERT") nifi_config.key_file = os.getenv("NIFI_CLIENT_KEY") +# Optional: registry-specific CA envs +_reg_ca = os.getenv("REGISTRY_CA_CERT") +if _reg_ca is not None: + warnings.warn( + "REGISTRY_CA_CERT / REGISTRY_CLIENT_CERT / REGISTRY_CLIENT_KEY are deprecated; " + "set configuration.ssl_ca_cert/cert_file/key_file explicitly or use REQUESTS_CA_BUNDLE", + DeprecationWarning, + stacklevel=2, + ) + registry_config.ssl_ca_cert = _reg_ca + registry_config.cert_file = os.getenv("REGISTRY_CLIENT_CERT") + registry_config.key_file = os.getenv("REGISTRY_CLIENT_KEY") + +# Fallback: shared TLS CA for both services (e.g., local test CA) +_shared_ca = os.getenv("TLS_CA_CERT_PATH") or os.getenv("REQUESTS_CA_BUNDLE") +if _shared_ca: + # Only set if not already configured from deprecated variables above + if not nifi_config.ssl_ca_cert and not registry_config.ssl_ca_cert: + nifi_config.ssl_ca_cert = _shared_ca + registry_config.ssl_ca_cert = _shared_ca + # Enable SSL verification when CA is provided via environment + global_ssl_verify = True + nifi_config.verify_ssl = True + registry_config.verify_ssl = True + + # --- Encoding # URL Encoding bypass characters will not be encoded during submission default_safe_chars = "" diff --git a/nipyapi/demo/__init__.py b/nipyapi/demo/__init__.py deleted file mode 100644 index e69de29b..00000000 diff --git a/nipyapi/demo/console.py b/nipyapi/demo/console.py deleted file mode 100644 index 946f7b70..00000000 --- a/nipyapi/demo/console.py +++ /dev/null @@ -1,162 +0,0 @@ -""" -A convenience script for generating an interactive test environment. -""" - -import logging -import nipyapi - -# Note that this is the URI for NiFi to connect to Registry -# Which may be different from your localhost connection if using Docker -# Docker is likely to be http://:18080 - -_insecure_rc_endpoint = 'http://registry:18080' - - -_basename = "nipyapi_console" -_pg0 = _basename + '_process_group_0' -_proc0 = _basename + '_processor_0' -_rc0 = _basename + '_reg_client_0' -_b0 = _basename + '_bucket_0' -_b1 = _basename + '_bucket_1' -_vf0 = _basename + '_ver_flow_0' -_vf1 = _basename + '_ver_flow_1' - -__all__ = ['process_group_0', 'processor_0', 'reg_client_0', 'bucket_0', - 'bucket_1', 'ver_flow_info_0', 'ver_flow_0', 'ver_flow_snapshot_0', - 'ver_flow_1', 'ver_flow_snapshot_1', 'ver_flow_json_0', - 'ver_flow_yaml_0', 'ver_flow_raw_0', 'flow_template_0'] - -log = logging.getLogger(__name__) -log.setLevel(logging.INFO) - -log.info("Setting up NiPyApi Demo Console") -log.info("Cleaning up old NiPyApi Console Process Groups") -process_group_0 = nipyapi.canvas.get_process_group(_pg0) -if process_group_0 is not None: - nipyapi.canvas.delete_process_group( - process_group_0, - force=True, - refresh=True - ) -log.info("Creating process_group_0 as an empty process group name %s", _pg0) -process_group_0 = nipyapi.canvas.create_process_group( - nipyapi.canvas.get_process_group(nipyapi.canvas.get_root_pg_id(), 'id'), - _pg0, - location=(400.0, 400.0) -) - -log.info("Cleaning up old NiPyApi Console Processors") -processor_0 = nipyapi.canvas.get_processor(_proc0) -if processor_0 is not None: - nipyapi.canvas.delete_processor(process_group_0, True) -log.info("Creating processor_0 as a new GenerateFlowFile named %s in the " - "previous ProcessGroup", _proc0) -processor_0 = nipyapi.canvas.create_processor( - parent_pg=process_group_0, - processor=nipyapi.canvas.get_processor_type('GenerateFlowFile'), - location=(400.0, 400.0), - name=_proc0, - config=nipyapi.nifi.ProcessorConfigDTO( - scheduling_period='5s', - auto_terminated_relationships=['failure'] - ) -) - -log.info("Creating reg_client_0 as NiFi Registry Client") -# If the secured environment demo setup has already run, then we just -# want to reuse that client for NiFi <> Registry Comms -reg_client_0 = nipyapi.versioning.get_registry_client( - 'nipyapi_secure_reg_client_0', - 'name' -) -try: - reg_client_0 = nipyapi.versioning.list_registry_clients().registries[0] -except IndexError: - reg_client_0 = None - -if not reg_client_0: - try: - reg_client_0 = nipyapi.versioning.create_registry_client( - name=_rc0, - uri=_insecure_rc_endpoint, - description='NiPyApi Demo Console' - ) - except ValueError: - reg_client_0 = nipyapi.versioning.get_registry_client(_rc0) - -log.info("Cleaning up old NiPyApi Console Registry Buckets") -bucket_0 = nipyapi.versioning.get_registry_bucket(_b0) -if bucket_0 is not None: - nipyapi.versioning.delete_registry_bucket(bucket_0) -bucket_1 = nipyapi.versioning.get_registry_bucket(_b1) -if bucket_1 is not None: - nipyapi.versioning.delete_registry_bucket(bucket_1) -log.info("Creating bucket_0 as new a Registry Bucket named %s", _b0) -bucket_0 = nipyapi.versioning.create_registry_bucket(_b0) -assert isinstance(bucket_0, nipyapi.registry.Bucket) -log.info("Creating bucket_1 as new a Registry Bucket named %s", _b1) -bucket_1 = nipyapi.versioning.create_registry_bucket(_b1) -assert isinstance(bucket_1, nipyapi.registry.Bucket) - -log.info("Saving %s as a new Versioned Flow named %s in Bucket %s, and saving " - "as variable ver_flow_info_0", _pg0, _vf0, _b0) -ver_flow_info_0 = nipyapi.versioning.save_flow_ver( - process_group=process_group_0, - registry_client=reg_client_0, - bucket=bucket_0, - flow_name=_vf0, - desc='A Versioned Flow', - comment='A Versioned Flow' -) -log.info("Creating ver_flow_0 as a copy of the new Versioned Flow object") -ver_flow_0 = nipyapi.versioning.get_flow_in_bucket( - bucket_0.identifier, - ver_flow_info_0.version_control_information.flow_id, - 'id' -) -log.info("Creating ver_flow_snapshot_0 as a copy of the new Versioned Flow" - "Snapshot") -ver_flow_snapshot_0 = nipyapi.versioning.get_latest_flow_ver( - bucket_0.identifier, ver_flow_0.identifier -) - -log.info("Creating ver_flow_1 as an empty Versioned Flow stub named %s in %s", - _vf1, _b1) -ver_flow_1 = nipyapi.versioning.create_flow( - bucket_id=bucket_1.identifier, - flow_name=_vf1, - flow_desc='A cloned Versioned NiFi-Registry Flow' -) -log.info("Creating ver_flow_snapshot_1 by cloning the first snapshot %s into " - "the new Versioned Flow Stub %s", _vf0, _vf1) -ver_flow_snapshot_1 = nipyapi.versioning.create_flow_version( - flow=ver_flow_1, - flow_snapshot=ver_flow_snapshot_0 -) - -log.info("Creating ver_flow_raw_0 as a raw Json export of %s", _vf0) -ver_flow_raw_0 = nipyapi.versioning.get_flow_version( - bucket_0.identifier, ver_flow_0.identifier, export=True -) -log.info("Creating ver_flow_json_0 as a sorted pretty Json export of %s", _vf0) -ver_flow_json_0 = nipyapi.versioning.export_flow_version( - bucket_0.identifier, ver_flow_0.identifier, mode='json' -) -log.info("Creating ver_flow_yaml_0 as a sorted pretty Yaml export of %s", _vf0) -ver_flow_yaml_0 = nipyapi.versioning.export_flow_version( - bucket_0.identifier, ver_flow_0.identifier, mode='yaml' -) - -log.info("Creating flow_template_0 as a new Template from Process Group %s", - _pg0) -flow_template_0 = nipyapi.templates.get_template_by_name( - process_group_0.status.name -) -if flow_template_0 is not None: - nipyapi.templates.delete_template(flow_template_0.id) -flow_template_0 = nipyapi.templates.create_template( - process_group_0.id, - process_group_0.status.name, - 'A Demo Template' -) -print("Demo Console deployed!") diff --git a/nipyapi/demo/fdlc.py b/nipyapi/demo/fdlc.py deleted file mode 100644 index d305e883..00000000 --- a/nipyapi/demo/fdlc.py +++ /dev/null @@ -1,543 +0,0 @@ -# pylint: disable=R0801 - -""" -A self-paced walkthrough of version control using NiFi-Registry. -See initial print statement for detailed explanation. -""" - -import logging -from time import sleep -import nipyapi - -try: - from nipyapi.utils import DockerContainer -except ImportError: - print("The 'docker' package is required for this demo. " - "Please install nipyapi with the 'demo' extra: " - "pip install nipyapi[demo]") - import sys - sys.exit(1) - -log = logging.getLogger(__name__) -log.setLevel(logging.INFO) -logging.getLogger('nipyapi.versioning').setLevel(logging.INFO) -logging.getLogger('nipyapi.utils').setLevel(logging.INFO) - -d_network_name = 'fdlcdemo' - -dev_nifi_port = 8080 -prod_nifi_port = 9090 -dev_reg_port = dev_nifi_port + 1 -prod_reg_port = prod_nifi_port + 1 - -dev_nifi_url = 'http://localhost:' + str(dev_nifi_port) + '/nifi' -prod_nifi_url = 'http://localhost:' + str(prod_nifi_port) + '/nifi' -dev_reg_url = 'http://localhost:' + str(dev_reg_port) + '/nifi-registry' -prod_reg_url = 'http://localhost:' + str(prod_reg_port) + '/nifi-registry' - -dev_nifi_api_url = dev_nifi_url + '-api' -prod_nifi_api_url = prod_nifi_url + '-api' -dev_reg_api_url = dev_reg_url + '-api' -prod_reg_api_url = prod_reg_url + '-api' - -d_containers = [ - DockerContainer( - name='nifi-dev', - image_name='apache/nifi', - image_tag='1.27.0', - ports={str(dev_nifi_port) + '/tcp': dev_nifi_port}, - env={'NIFI_WEB_HTTP_PORT': str(dev_nifi_port)} - ), - DockerContainer( - name='nifi-prod', - image_name='apache/nifi', - image_tag='1.27.0', - ports={str(prod_nifi_port) + '/tcp': prod_nifi_port}, - env={'NIFI_WEB_HTTP_PORT': str(prod_nifi_port)} - ), - DockerContainer( - name='reg-dev', - image_name='apache/nifi-registry', - image_tag='latest', - ports={str(dev_reg_port) + '/tcp': dev_reg_port}, - env={'NIFI_REGISTRY_WEB_HTTP_PORT': str(dev_reg_port)} - ), - DockerContainer( - name='reg-prod', - image_name='apache/nifi-registry', - image_tag='latest', - ports={str(prod_reg_port) + '/tcp': prod_reg_port}, - env={'NIFI_REGISTRY_WEB_HTTP_PORT': str(prod_reg_port)} - ) -] - -dev_pg_name = 'my_pg_0' -dev_proc_name = 'my_proc_0' -dev_proc2_name = 'my_s_proc_0' -dev_reg_client_name = 'dev_reg_client_0' -dev_bucket_name = 'dev_bucket_0' -dev_ver_flow_name = 'dev_ver_flow_0' -dev_flow_export_name = 'dev_flow_export_0' -prod_bucket_name = 'prod_bucket_0' -prod_ver_flow_name = 'prod_ver_flow_0' -prod_reg_client_name = 'prod_reg_client_0' - -print("This python script demonstrates the steps to manage promotion of " - "versioned Flows between different environments. \nIt deploys NiFi and " - "NiFi-Registry in local Docker containers and illustrates the " - "steps you might follow in such a process." - "\nEach step is presented as a function of this script, they count up " - "in hex (0,1,2,3,4,5,6,7,8,9,a,b,c,d) and should be called in order." - "\nEach step will log activities to INFO, and you are encouraged to " - "look at the code in this script to see how each step is completed." - "\nhttp://github.com/Chaffelson/nipyapi/blob/master/nipyapi/demo/fdlc.py" - "\nEach step will also issue instructions through print statements like " - "this one, these instructions will vary so please read them as you go." - "\nNote that the first call will log a lot of information while it boots" - " the Docker containers, further instructions will follow." - "\nNote that you can reset it at any time by calling step_1 again.\n" - "\nPlease start by calling the function 'step_1_boot_demo_env()'.") - - -def step_1_boot_demo_env(): - """step_1_boot_demo_env""" - log.info("Starting Dev and Prod NiFi and NiFi-Registry Docker Containers" - "\nPlease wait, this may take a few minutes to download the " - "Docker images and then start them.") - nipyapi.utils.start_docker_containers( - docker_containers=d_containers, - network_name=d_network_name - ) - for reg_instance in [dev_reg_api_url, prod_reg_api_url]: - log.info("Waiting for NiFi Registries to be ready") - nipyapi.utils.set_endpoint(reg_instance) - nipyapi.utils.wait_to_complete( - test_function=nipyapi.utils.is_endpoint_up, - endpoint_url='-'.join(reg_instance.split('-')[:-1]), - nipyapi_delay=nipyapi.config.long_retry_delay, - nipyapi_max_wait=nipyapi.config.long_max_wait - ) - for nifi_instance in [dev_nifi_api_url, prod_nifi_api_url]: - log.info("Waiting for NiFi instances to be ready") - nipyapi.utils.set_endpoint(nifi_instance) - nipyapi.utils.wait_to_complete( - test_function=nipyapi.utils.is_endpoint_up, - endpoint_url='-'.join(nifi_instance.split('-')[:-1]), - nipyapi_delay=nipyapi.config.long_retry_delay, - nipyapi_max_wait=nipyapi.config.long_max_wait - ) - # Sleeping to wait for all startups to return before printing guide - sleep(1) - print("Your Docker containers should now be ready, please find them at the" - "following URLs:" - "\nnifi-dev ", dev_nifi_url, - "\nreg-dev ", dev_reg_url, - "\nreg-prod ", prod_reg_url, - "\nnifi-prod ", prod_nifi_url, - "\nPlease open each of these in a browser tab." - "\nPlease then call the function 'step_2_create_reg_clients()'\n") - - -def step_2_create_reg_clients(): - """Set client connections between NiFi and Registry""" - log.info("Creating Dev Environment Nifi to NiFi-Registry Client") - nipyapi.utils.set_endpoint(dev_nifi_api_url) - nipyapi.versioning.create_registry_client( - name=dev_reg_client_name, - uri='http://reg-dev:8081', - description='' - ) - log.info("Creating Prod Environment Nifi to NiFi-Registry Client") - nipyapi.utils.set_endpoint(prod_nifi_api_url) - nipyapi.versioning.create_registry_client( - name=prod_reg_client_name, - uri='http://reg-prod:9091', - description='' - ) - print("We have attached each NiFi environment to its relevant Registry " - "for upcoming Version Control activities." - "\nYou can see these by going to NiFi, clicking on the 3Bar menu " - "icon in the top right corner, selecting 'Controller Settings', and" - " looking at the 'Registry Clients' tab." - "\nPlease now call 'step_3_create_dev_flow()'\n") - - -def step_3_create_dev_flow(): - """Connecting to Dev environment and creating some test objects""" - log.info("Connecting to Dev environment and creating some test objects") - nipyapi.utils.set_endpoint(dev_nifi_api_url) - nipyapi.utils.set_endpoint(dev_reg_api_url) - - log.info("Creating %s as an empty process group", dev_pg_name) - dev_process_group_0 = nipyapi.canvas.create_process_group( - nipyapi.canvas.get_process_group(nipyapi.canvas.get_root_pg_id(), - 'id'), - dev_pg_name, - location=(400.0, 400.0) - ) - log.info("Creating dev_processor_0 as a new GenerateFlowFile in the PG") - nipyapi.canvas.create_processor( - parent_pg=dev_process_group_0, - processor=nipyapi.canvas.get_processor_type('GenerateFlowFile'), - location=(400.0, 400.0), - name=dev_proc_name, - config=nipyapi.nifi.ProcessorConfigDTO( - scheduling_period='1s', - auto_terminated_relationships=['success'] - ) - ) - print("We have procedurally generated a new Process Group with a child " - "Processor in Dev NiFi. It is not yet version controlled." - "\nGo to your Dev NiFi browser tab, and refresh to see the new " - "Process Group, open the Process Group to see the new Generate " - "FlowFile Processor. Open the Processor and look at the Scheduling " - "tab to note that it is set to 1s." - "\nPlease now call 'step_4_create_dev_ver_bucket()'\n") - - -def step_4_create_dev_ver_bucket(): - """Creating dev registry bucket""" - log.info("Creating %s as new a Registry Bucket", dev_bucket_name) - nipyapi.versioning.create_registry_bucket(dev_bucket_name) - print("We have created a new Versioned Flow Bucket in the Dev " - "NiFi-Registry. Please go to the Dev Registry tab in your browser " - "and refresh, then click the arrow next to 'All' in the page header " - "to select the new bucket and see that it is currently empty." - "\nPlease now call 'step_5_save_flow_to_bucket()'\n") - - -def step_5_save_flow_to_bucket(): - """Saving the flow to the bucket as a new versioned flow""" - log.info( - "Saving %s to %s", dev_pg_name, dev_bucket_name) - process_group = nipyapi.canvas.get_process_group(dev_pg_name) - bucket = nipyapi.versioning.get_registry_bucket(dev_bucket_name) - registry_client = nipyapi.versioning.get_registry_client( - dev_reg_client_name) - nipyapi.versioning.save_flow_ver( - process_group=process_group, - registry_client=registry_client, - bucket=bucket, - flow_name=dev_ver_flow_name, - desc='A Versioned Flow', - comment='A Versioned Flow' - ) - print("We have now saved the Dev Process Group to the Dev Registry bucket " - "as a new Versioned Flow. Return to the Dev Registry tab in your " - "browser and refresh to see the flow. Click on the flow to show " - "some details, note that it is version 1." - "\nPlease note that the next function requires that you save the " - "output to a variable when you continue." - "\nPlease now call 'flow = step_6_export_dev_flow()'\n") - - -def step_6_export_dev_flow(): - """Exporting the versioned flow as a yaml definition""" - log.info("Creating a sorted pretty Yaml export of %s", - dev_flow_export_name) - bucket = nipyapi.versioning.get_registry_bucket(dev_bucket_name) - ver_flow = nipyapi.versioning.get_flow_in_bucket( - bucket.identifier, - identifier=dev_ver_flow_name - ) - out = nipyapi.versioning.export_flow_version( - bucket_id=bucket.identifier, - flow_id=ver_flow.identifier, - mode='yaml' - ) - print("We have now exported the versioned Flow from the Dev environment as" - " a formatted YAML document, which is one of several options. Note " - "that you were asked to save it as the variable 'flow' so you can " - "then import it into your Prod environment." - "\nIf you want to view it, call 'print(flow)'." - "\nWhen you are ready, please call 'step_7_create_prod_ver_bucket()'" - "\n") - return out - - -def step_7_create_prod_ver_bucket(): - """Connecting to the Prod environment and creating a new bucket""" - log.info("Connecting to Prod Environment") - nipyapi.utils.set_endpoint(prod_nifi_api_url) - nipyapi.utils.set_endpoint(prod_reg_api_url) - log.info("Creating %s as a new Registry Bucket", prod_bucket_name) - nipyapi.versioning.create_registry_bucket(prod_bucket_name) - print("We have now created a bucket in the Prod Registry to promote our " - "Dev flow into. Go to the Prod Registry tab and click the arrow next" - " to 'All' to select it and see that it is currently empty." - "\nPlease note that the next function requires that you supply the " - "variable you saved from step 5." - "\nPlease call 'step_8_import_dev_flow_to_prod_reg(flow)'\n") - - -def step_8_import_dev_flow_to_prod_reg(versioned_flow): - """Importing the yaml string into Prod""" - log.info("Saving dev flow export to prod container") - bucket = nipyapi.versioning.get_registry_bucket(prod_bucket_name) - nipyapi.versioning.import_flow_version( - bucket_id=bucket.identifier, - encoded_flow=versioned_flow, - flow_name=prod_ver_flow_name - ) - print("The flow we exported from Dev is now imported into the bucket in " - "the Prod Registry, and ready for deployment to the Prod NiFi." - "\nPlease refresh your Prod Registry and you will see it, note that" - " it is version 1 and has the same comment as the Dev Flow Version." - "\nPlease then call 'step_9_deploy_prod_flow_to_nifi()'\n") - - -def step_9_deploy_prod_flow_to_nifi(): - """Deploying the flow to the Prod environment""" - log.info("Deploying promoted flow from Prod Registry to Prod Nifi") - bucket = nipyapi.versioning.get_registry_bucket(prod_bucket_name) - flow = nipyapi.versioning.get_flow_in_bucket( - bucket_id=bucket.identifier, - identifier=prod_ver_flow_name - ) - reg_client = nipyapi.versioning.get_registry_client(prod_reg_client_name) - nipyapi.versioning.deploy_flow_ver( - parent_id=nipyapi.canvas.get_root_pg_id(), - location=(0, 0), - bucket_id=bucket.identifier, - flow_id=flow.identifier, - reg_client_id=reg_client.id, - version=None - ) - print("The Promoted Flow has now been deployed to the Prod NiFi, please " - "refresh the Prod NiFi tab and note that the Process Group has the " - "same name as the Dev Process Group, and has a green tick(โˆš) " - "indicating it is up to date with Version Control. " - "\n Open the Process Group and note that the Processor is also the " - "same, including the Schedule of 1s." - "\nPlease now call 'step_a_change_dev_flow()'\n") - - -def step_a_change_dev_flow(): - """Procedurally modifying the Dev flow""" - log.info("Connecting to Dev Environment") - nipyapi.utils.set_endpoint(dev_nifi_api_url) - nipyapi.utils.set_endpoint(dev_reg_api_url) - log.info("Modifying Dev Processor Schedule") - processor = nipyapi.canvas.get_processor(dev_proc_name) - nipyapi.canvas.update_processor( - processor=processor, - update=nipyapi.nifi.ProcessorConfigDTO( - scheduling_period='3s' - ) - ) - print("Here we have made a simple modification to the processor in our Dev" - "Flow. \nGo to the Dev NiFi tab and refresh it, you will see that " - "the Process Group now has a star(*) icon next to the name, " - "indicating there are unsaved changes. Look at the Scheduling tab " - "in the Processor and note that it has changed from 1s to 3s." - "\nPlease now call 'step_b_update_dev_flow_ver()'\n") - - -def step_b_update_dev_flow_ver(): - """Committing the change to the dev flow version""" - log.info("Saving changes in Dev Flow to Version Control") - process_group = nipyapi.canvas.get_process_group(dev_pg_name) - bucket = nipyapi.versioning.get_registry_bucket(dev_bucket_name) - registry_client = nipyapi.versioning.get_registry_client( - dev_reg_client_name) - flow = nipyapi.versioning.get_flow_in_bucket( - bucket_id=bucket.identifier, - identifier=dev_ver_flow_name - ) - nipyapi.versioning.save_flow_ver( - process_group=process_group, - registry_client=registry_client, - bucket=bucket, - flow_id=flow.identifier, - comment='An Updated Flow' - ) - print("We have saved the change to the Dev Registry as a new version." - "\nRefresh the Dev Registry to see that the Flow now has a version " - "2, and a new comment." - "\nRefresh the Dev NiFi to see that the Process Group now has a " - "green tick again, indicating that Version Control is up to date." - "\nPlease now call 'step_c_promote_change_to_prod_reg()'\n") - - -def step_c_promote_change_to_prod_reg(): - """Promoting the committed change across to the prod environment""" - log.info("Exporting updated Dev Flow Version") - dev_bucket = nipyapi.versioning.get_registry_bucket(dev_bucket_name) - dev_ver_flow = nipyapi.versioning.get_flow_in_bucket( - dev_bucket.identifier, - identifier=dev_ver_flow_name - ) - dev_export = nipyapi.versioning.export_flow_version( - bucket_id=dev_bucket.identifier, - flow_id=dev_ver_flow.identifier, - mode='yaml' - ) - log.info("Connecting to Prod Environment") - nipyapi.utils.set_endpoint(prod_nifi_api_url) - nipyapi.utils.set_endpoint(prod_reg_api_url) - log.info("Pushing updated version into Prod Registry Flow") - prod_bucket = nipyapi.versioning.get_registry_bucket(prod_bucket_name) - prod_flow = nipyapi.versioning.get_flow_in_bucket( - bucket_id=prod_bucket.identifier, - identifier=prod_ver_flow_name - ) - nipyapi.versioning.import_flow_version( - bucket_id=prod_bucket.identifier, - encoded_flow=dev_export, - flow_id=prod_flow.identifier - ) - print("We have promoted the change from our Dev Registry to Prod, please " - "refresh your Prod Registry Tab to see the new version is present, " - "and that the new comment matches the Dev Environment." - "\nRefresh your Prod NiFi tab to see that the Process Group has a " - "red UpArrow(โฌ†๏ธŽ) icon indicating a new version is available for " - "deployment." - "\nPlease now call 'step_d_promote_change_to_prod_nifi()'\n") - - -def step_d_promote_change_to_prod_nifi(): - """Pushing the change into the Prod flow""" - log.info("Moving deployed Prod Process Group to the latest version") - prod_pg = nipyapi.canvas.get_process_group(dev_pg_name) - nipyapi.versioning.update_flow_ver( - process_group=prod_pg, - target_version=None - ) - print("Refresh your Prod NiFi to see that the PG now shows the green tick " - "of being up to date with its version control." - "\nLook at the Processor scheduling to note that it now matches the " - "dev environment as 3s." - "\nNow we will examine some typical deployment tests." - "\nPlease now call 'step_e_check_sensitive_processors()'\n") - - -def step_e_check_sensitive_processors(): - """Create and test for Sensitive Properties to be set in the Canvas""" - log.info("Connecting to Dev Environment") - nipyapi.utils.set_endpoint(dev_nifi_api_url) - nipyapi.utils.set_endpoint(dev_reg_api_url) - log.info("Creating additional complex Processor") - nipyapi.canvas.create_processor( - parent_pg=nipyapi.canvas.get_process_group(dev_pg_name), - processor=nipyapi.canvas.get_processor_type('GetTwitter'), - location=(400.0, 600.0), - name=dev_proc2_name, - ) - s_proc = nipyapi.canvas.list_sensitive_processors(summary=True) - print("We have created a new Processor {0} which has security protected" - "properties, these will need to be completed in each environment " - "that this flow is used in. These properties are discoverable using " - "the API calls list 'canvas.list_sensitive_processors()'" - "\nFunction 'nipyapi.canvas.update_processor' as used in step_a is" - " intended for this purpose" - "\nPlease now call 'step_f_set_sensitive_values()'\n" - .format(s_proc[0])) - - -def step_f_set_sensitive_values(): - """Set the Sensitive Properties to pass the deployment test""" - log.info("Setting Sensitive Values on Processor") - nipyapi.canvas.update_processor( - processor=nipyapi.canvas.get_processor(dev_proc2_name), - update=nipyapi.nifi.ProcessorConfigDTO( - properties={ - 'Consumer Key': 'Some', - 'Consumer Secret': 'Secret', - 'Access Token': 'values', - 'Access Token Secret': 'here' - } - ) - ) - print("Here we have set the Sensitive values, again using the Update" - " process. Typically these values will be looked up in a Config DB " - "or some other secured service." - "\nPlease now call 'step_g_check_invalid_processors()'\n") - - -def step_g_check_invalid_processors(): - """Look for Processors with Invalid Properties to be remediated""" - log.info("Retrieving Processors in Invalid States") - i_proc = nipyapi.canvas.list_invalid_processors()[0] - print("We now run a validity test against our flow to ensure that it can " - "be deployed. We can see that Processors [{0}] need further " - "attention." - "\nWe can also easily see the reasons for this [{1}]." - "\nPlease now call 'step_h_fix_validation_errors()'\n" - .format(i_proc.status.name, i_proc.component.validation_errors)) - - -def step_h_fix_validation_errors(): - """Update values for Invalid Processors to pass the deployment test""" - log.info("Autoterminating Success status") - nipyapi.canvas.update_processor( - processor=nipyapi.canvas.get_processor(dev_proc2_name), - update=nipyapi.nifi.ProcessorConfigDTO( - auto_terminated_relationships=['success'] - ) - ) - print("We now see that our Processor is configured and Valid within this " - "environment, and is ready for Promotion to the next stage." - "\nPlease now call 'step_i_promote_deploy_and_validate()'\n") - - -def step_i_promote_deploy_and_validate(): - """Promotion and Deployment in a single method""" - log.info("Saving changes in Dev Flow to Version Control") - dev_process_group = nipyapi.canvas.get_process_group(dev_pg_name) - dev_bucket = nipyapi.versioning.get_registry_bucket(dev_bucket_name) - dev_registry_client = nipyapi.versioning.get_registry_client( - dev_reg_client_name) - dev_flow = nipyapi.versioning.get_flow_in_bucket( - bucket_id=dev_bucket.identifier, - identifier=dev_ver_flow_name - ) - nipyapi.versioning.save_flow_ver( - process_group=dev_process_group, - registry_client=dev_registry_client, - bucket=dev_bucket, - flow_id=dev_flow.identifier, - comment='A Flow update with a Complex Processor' - ) - dev_ver_flow = nipyapi.versioning.get_flow_in_bucket( - dev_bucket.identifier, - identifier=dev_ver_flow_name - ) - log.info("Exporting the Dev flow to Yaml") - dev_export = nipyapi.versioning.export_flow_version( - bucket_id=dev_bucket.identifier, - flow_id=dev_ver_flow.identifier, - mode='yaml' - ) - log.info("Connecting to Prod Environment") - nipyapi.utils.set_endpoint(prod_nifi_api_url) - nipyapi.utils.set_endpoint(prod_reg_api_url) - log.info("Importing the Updated Dev Yaml to the Prod Bucket Flow") - prod_bucket = nipyapi.versioning.get_registry_bucket(prod_bucket_name) - prod_flow = nipyapi.versioning.get_flow_in_bucket( - bucket_id=prod_bucket.identifier, - identifier=prod_ver_flow_name - ) - nipyapi.versioning.import_flow_version( - bucket_id=prod_bucket.identifier, - encoded_flow=dev_export, - flow_id=prod_flow.identifier - ) - log.info("Pushing the new Version into the Prod Flow") - prod_pg = nipyapi.canvas.get_process_group(dev_pg_name) - nipyapi.versioning.update_flow_ver( - process_group=prod_pg, - target_version=None - ) - log.info("Checking for Invalid Processors in the new flow") - val_errors = nipyapi.canvas.list_invalid_processors() - print("Here we have put all the steps in one place by taking the dev " - "changes all the way through to prod deployment. If we check" - " our Processor Validation again, we see that our regular " - "Properties have been carried through, but our Sensitive " - "Properties are unset in Production [{0}]" - "\nThis is because NiFi will not break" - " security by carrying them to a new environment. We leave setting" - " them again as an exercise for the user." - .format(val_errors[0].component.validation_errors)) - print("\nThis is the end of the guide, you may restart at any time by " - "calling 'step_1_boot_demo_env()'\n") diff --git a/nipyapi/demo/keys/client-cert.pem b/nipyapi/demo/keys/client-cert.pem deleted file mode 100644 index 611e85ac..00000000 --- a/nipyapi/demo/keys/client-cert.pem +++ /dev/null @@ -1,49 +0,0 @@ -Bag Attributes - friendlyName: nifi-key - localKeyID: 54 69 6D 65 20 31 35 32 30 30 32 38 30 32 38 33 39 33 -subject=/OU=nifi/CN=user1 -issuer=/OU=nifi/CN=localhost ------BEGIN CERTIFICATE----- -MIIDQjCCAiqgAwIBAgIKAWHouwp+AAAAADANBgkqhkiG9w0BAQsFADAjMQ0wCwYD -VQQLDARuaWZpMRIwEAYDVQQDDAlsb2NhbGhvc3QwHhcNMTgwMzAyMjIwMDI3WhcN -NDUwNzE3MjIwMDI3WjAfMQ0wCwYDVQQLDARuaWZpMQ4wDAYDVQQDDAV1c2VyMTCC -ASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAPc5sF+JJ/B9yHPqYF1CFOhw -ZDp226IcddledAiGFC20h7LdiToDBUrEMj56mepNFTHUt3HB15kJ8hDJutYLL8J+ -MiJEjchlTjL24qE9YCYV+vjBeEb8axzlPp1/dkgEUld+0XHLgI0ma2kLLd0P7gBr -bdzDACnFpDvGmo98jCcF7t9/HvuU9e4rOzKLc962gwQixdrClMoFYXiphBl5PmtK -fyBYxA9kBEat4M/1xbZKXlZDW4cT8jRrxAD+719Y5vyByq+8+6I+F59uG1w2wCHb -Jfw12S0JgFVNSKLgQiYqqtQc7eSU42ItqjorWoPaUavAHgWWPblQdllodCdlY58C -AwEAAaN8MHowHQYDVR0OBBYEFNPLPB0tKHgnMbB2d0o3FRIbSnAmMB8GA1UdIwQY -MBaAFCofAt+2RLft0SMVSznxT95fJnxaMA4GA1UdDwEB/wQEAwID+DAJBgNVHRME -AjAAMB0GA1UdJQQWMBQGCCsGAQUFBwMCBggrBgEFBQcDATANBgkqhkiG9w0BAQsF -AAOCAQEAaQScOpVd5pnFR4FhCcfWdd4GA4flyrsKFgGxnEeX7m8rjZIPWP2VLe1w -HnEYo0xdGBRGAh5SQ+4TuS48BBLFG87RNXDNjZGUKF7BHkSiD5JI5S5IJxnOWNb/ -VIufxQae5OdgY6n1CWaMSRjbK2VzOmHAP14XzotTvgqdJUUun3dV7mcozlLruJgO -QY+vX8sw4FEVpH9U2jpxnA2JkjO5RFGagyC9z8UNBggiB4GFcC+/pcurDgmjktnc -/UjthH15SlbQEglimu15Kn+UXStbrM/D82N5RLesn2fTgu1L9etke4MN/zKLBBtw -fTGbPI378w+GWLlAJlV49Hxnat6elg== ------END CERTIFICATE----- -Bag Attributes - friendlyName: CN=localhost,OU=nifi -subject=/OU=nifi/CN=localhost -issuer=/OU=nifi/CN=localhost ------BEGIN CERTIFICATE----- -MIIDSTCCAjGgAwIBAgIKAWHouwjKAAAAADANBgkqhkiG9w0BAQsFADAjMQ0wCwYD -VQQLDARuaWZpMRIwEAYDVQQDDAlsb2NhbGhvc3QwHhcNMTgwMzAyMjIwMDI3WhcN -NDUwNzE3MjIwMDI3WjAjMQ0wCwYDVQQLDARuaWZpMRIwEAYDVQQDDAlsb2NhbGhv -c3QwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQCJ9DuU5wHvRfwQKghG -G27Hgif7F3RpMzxlV+vrWIKYKH5FBWT9dhdCxNNcG1uaJveEu1HZOxJ6QjjgP5l1 -cO/vc+LHUct+DAZENMSujIzppw6a79Tg0SsmTPLoexcz5AGgtyVmcLSvzv2aNpo6 -s5+OhCfO6ZBBqGNtEhjBqN988eLYcWw0/FRj9W4TkgTgkIuvsvPyYIiZ9Km2AwFc -HoBKBTJhMMZHAxmGvhX0PD3oAEjTCDSEB7xv6ZrZ8erhONTb40yvVPek7dB09GjU -P9XzpIR7D5XUAJrumDbYBPJQjsZEzksJ7iQ38+EUYHFhm9FuvkGRV7lkAOHX4jnX -nV3fAgMBAAGjfzB9MA4GA1UdDwEB/wQEAwIB/jAMBgNVHRMEBTADAQH/MB0GA1Ud -DgQWBBQqHwLftkS37dEjFUs58U/eXyZ8WjAfBgNVHSMEGDAWgBQqHwLftkS37dEj -FUs58U/eXyZ8WjAdBgNVHSUEFjAUBggrBgEFBQcDAgYIKwYBBQUHAwEwDQYJKoZI -hvcNAQELBQADggEBAC5tH7kJ8IXYhwMuCCLCfPMck4Z3LzjCn7OPjyFfbuoe9zm7 -iRUq8X9EufOSIUJtAz2woWcdTPgjINdzKoKhGZ0s8zoiq/3dKg4C41XAE0OOhM2P -+Hj7QqFQKhBEH7+cW5qqx8ECTuc8/LAbi8ZAklMOy8MLhGfrxh4CBrl1NUVge0L0 -W8T5X8wgWzn36UxX9S2xc2yQzqtRkZShKBWVFaeJYuuO+Nxs5Jgu743ZUAQAV81n -epTDkcOfOePUHL19b5zmM5KdCbpetJjjh96KvPMfcjjgHBCTsvU4MAtYWCddJ8JT -OTfGTlv98aNsqKlk7UWi5a8d8NHBfRd0RL8LjDA= ------END CERTIFICATE----- diff --git a/nipyapi/demo/keys/client-key.pem b/nipyapi/demo/keys/client-key.pem deleted file mode 100644 index 7264a99f..00000000 --- a/nipyapi/demo/keys/client-key.pem +++ /dev/null @@ -1,83 +0,0 @@ -Bag Attributes - friendlyName: nifi-key - localKeyID: 54 69 6D 65 20 31 35 32 30 30 32 38 30 32 38 33 39 33 -Key Attributes: ------BEGIN RSA PRIVATE KEY----- -Proc-Type: 4,ENCRYPTED -DEK-Info: DES-EDE3-CBC,46E6494677E5DEEA - -M8Eo2hgggkN+G3wGA8/+MESQEv+K4U5kRG4RbbWebEAXi9A8nJAIbeEA1MZLmve3 -w5f//Z1pjIhA8uSh3EBpL/cBROpEKb27Wm+PMOhBACVsqWq1SK3Ej7LWjO+vsclM -LeuG0tY9SvGT9KotbN0+CxHorN6DIGnqRNNi7kxUgISsxfXYC0NU3J12nQLKT50W -VePx2ofDQBSM479XbAcVn3RN45Ap6v6TWiTxBrDev9BVBNshXfO6DTpmjJHFKRHx -kw99H9MzHl6FR6PuiWX5Zq8dENvdJcRmLrkZhxr0vCXvxgbLPSrhkG0f+aRVN9F1 -YypM9jLP/x1ZDH8sSw9Vvu/Qe9INX9TlhhH7Hx3puKtiWDKPit+2PPu3JgA5+1nY -Q9u9q5pMTwEBIDc+7A9Cfyd55sNAr5usjW30arIXSyxjxV27skNNbiTBSO3OVWoQ -P4gm7LVYPqEHrWtUfp3SRem56LKYe/+NutUwQTXvoQ+EWp91c6Irv9aSkvR5TtMY -j053nDiRafyOOv+JyOP8x2H6KyOEZ7tx/vkHSNH9lfVcxt20XYgffy9zDZo5EO+D -x8a/kWhFpalT+ZPQRajaSAYBY12YFwYhxIvXhHtbxAz1OdeSMRMgQqBXVx2UBI6R -+SamLqbpYIDO+XRmRudMGEPHyNeBb3M1wyHSRa7X62lJ15s0XzNa0uPq/aD4Nah+ -sVPRBP9Ny7NZcUpbMAKdV94XhyyB3jgh/XWU1TpJxuQXHizibxoi/o7OxHbjwMrD -iyOo7jVQ3ZSTVqYfr9fDZ/cCEbRqeaL9urVq3q+iSE5SacGVSR8LtzIGQxPThqmB -xmxeruRsp5gBPv/SaRNjfcgwYVfO2Z+NkV8tjTvmqx8+U5p9cYym/Zf+VRpycupm -vS/4ouvdenrVxfniSCCY7eweHYvLuuKX8EaQAur2MOZFGklx9mLADMkTcX12XG8U -RfU6ck0kAetZv6fSElS2UmghqN8zPxazsUOeiAhJRAgjweexMUnyZtRUxxkSt+7h -J32aWsd7efynSUs6aXhLBq5JsKAKjApC/7+jgqydydY1dV4vpnWCSdXaRRm8PgI/ -AM4glYUCbeVhV+q/U0Sg19Gq7l72d/qRUWYylNAIfu2gCHTN5I3XdLeGC3ZWXLjJ -N98H9YpzwQE7sw5u98a4wmjtFCP7BKz07pJu7HPCckrW4SqMass/fgcWFLgmf9Ug -GgvOZCRW/wxs5QgotJkqpBD17fwFEds4/ro5Ai+rV/DhqNwzuDlmWlM2+x+hMedD -k5Wg63PEFNBB7cciQXNVTsamWXwOsCBa0OL+4rMOAqrf1AwsiU5vRNlXT0F2zBrt -aB9OuvMLPBrhrFokqpIT68GqKlqR9n6U68HRxf2bQQNtyFi3/IImTGyRbDSwPCn/ -wT3lwDekjpby0GRYxOut3TpJmyMUKc3bEr4kKLfypf7sbW/agbLbA62tE0rDWUTc -0slhz3+S7ZaI4VUucNTXDol9xNqBpbh0LYIzCYIwYpNWNSkcDyP+vjI1/ChSGg+O -SFfLgCsHP0dZsIYwCRR8sG2DqxzoZuxK9UmqyMbnu9r310oHqTHayE7JEOxshNI7 ------END RSA PRIVATE KEY----- -Bag Attributes - friendlyName: nifi-key - localKeyID: 54 69 6D 65 20 31 35 32 30 30 32 38 30 32 38 33 39 33 -subject=/OU=nifi/CN=user1 -issuer=/OU=nifi/CN=localhost ------BEGIN CERTIFICATE----- -MIIDQjCCAiqgAwIBAgIKAWHouwp+AAAAADANBgkqhkiG9w0BAQsFADAjMQ0wCwYD -VQQLDARuaWZpMRIwEAYDVQQDDAlsb2NhbGhvc3QwHhcNMTgwMzAyMjIwMDI3WhcN -NDUwNzE3MjIwMDI3WjAfMQ0wCwYDVQQLDARuaWZpMQ4wDAYDVQQDDAV1c2VyMTCC -ASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAPc5sF+JJ/B9yHPqYF1CFOhw -ZDp226IcddledAiGFC20h7LdiToDBUrEMj56mepNFTHUt3HB15kJ8hDJutYLL8J+ -MiJEjchlTjL24qE9YCYV+vjBeEb8axzlPp1/dkgEUld+0XHLgI0ma2kLLd0P7gBr -bdzDACnFpDvGmo98jCcF7t9/HvuU9e4rOzKLc962gwQixdrClMoFYXiphBl5PmtK -fyBYxA9kBEat4M/1xbZKXlZDW4cT8jRrxAD+719Y5vyByq+8+6I+F59uG1w2wCHb -Jfw12S0JgFVNSKLgQiYqqtQc7eSU42ItqjorWoPaUavAHgWWPblQdllodCdlY58C -AwEAAaN8MHowHQYDVR0OBBYEFNPLPB0tKHgnMbB2d0o3FRIbSnAmMB8GA1UdIwQY -MBaAFCofAt+2RLft0SMVSznxT95fJnxaMA4GA1UdDwEB/wQEAwID+DAJBgNVHRME -AjAAMB0GA1UdJQQWMBQGCCsGAQUFBwMCBggrBgEFBQcDATANBgkqhkiG9w0BAQsF -AAOCAQEAaQScOpVd5pnFR4FhCcfWdd4GA4flyrsKFgGxnEeX7m8rjZIPWP2VLe1w -HnEYo0xdGBRGAh5SQ+4TuS48BBLFG87RNXDNjZGUKF7BHkSiD5JI5S5IJxnOWNb/ -VIufxQae5OdgY6n1CWaMSRjbK2VzOmHAP14XzotTvgqdJUUun3dV7mcozlLruJgO -QY+vX8sw4FEVpH9U2jpxnA2JkjO5RFGagyC9z8UNBggiB4GFcC+/pcurDgmjktnc -/UjthH15SlbQEglimu15Kn+UXStbrM/D82N5RLesn2fTgu1L9etke4MN/zKLBBtw -fTGbPI378w+GWLlAJlV49Hxnat6elg== ------END CERTIFICATE----- -Bag Attributes - friendlyName: CN=localhost,OU=nifi -subject=/OU=nifi/CN=localhost -issuer=/OU=nifi/CN=localhost ------BEGIN CERTIFICATE----- -MIIDSTCCAjGgAwIBAgIKAWHouwjKAAAAADANBgkqhkiG9w0BAQsFADAjMQ0wCwYD -VQQLDARuaWZpMRIwEAYDVQQDDAlsb2NhbGhvc3QwHhcNMTgwMzAyMjIwMDI3WhcN -NDUwNzE3MjIwMDI3WjAjMQ0wCwYDVQQLDARuaWZpMRIwEAYDVQQDDAlsb2NhbGhv -c3QwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQCJ9DuU5wHvRfwQKghG -G27Hgif7F3RpMzxlV+vrWIKYKH5FBWT9dhdCxNNcG1uaJveEu1HZOxJ6QjjgP5l1 -cO/vc+LHUct+DAZENMSujIzppw6a79Tg0SsmTPLoexcz5AGgtyVmcLSvzv2aNpo6 -s5+OhCfO6ZBBqGNtEhjBqN988eLYcWw0/FRj9W4TkgTgkIuvsvPyYIiZ9Km2AwFc -HoBKBTJhMMZHAxmGvhX0PD3oAEjTCDSEB7xv6ZrZ8erhONTb40yvVPek7dB09GjU -P9XzpIR7D5XUAJrumDbYBPJQjsZEzksJ7iQ38+EUYHFhm9FuvkGRV7lkAOHX4jnX -nV3fAgMBAAGjfzB9MA4GA1UdDwEB/wQEAwIB/jAMBgNVHRMEBTADAQH/MB0GA1Ud -DgQWBBQqHwLftkS37dEjFUs58U/eXyZ8WjAfBgNVHSMEGDAWgBQqHwLftkS37dEj -FUs58U/eXyZ8WjAdBgNVHSUEFjAUBggrBgEFBQcDAgYIKwYBBQUHAwEwDQYJKoZI -hvcNAQELBQADggEBAC5tH7kJ8IXYhwMuCCLCfPMck4Z3LzjCn7OPjyFfbuoe9zm7 -iRUq8X9EufOSIUJtAz2woWcdTPgjINdzKoKhGZ0s8zoiq/3dKg4C41XAE0OOhM2P -+Hj7QqFQKhBEH7+cW5qqx8ECTuc8/LAbi8ZAklMOy8MLhGfrxh4CBrl1NUVge0L0 -W8T5X8wgWzn36UxX9S2xc2yQzqtRkZShKBWVFaeJYuuO+Nxs5Jgu743ZUAQAV81n -epTDkcOfOePUHL19b5zmM5KdCbpetJjjh96KvPMfcjjgHBCTsvU4MAtYWCddJ8JT -OTfGTlv98aNsqKlk7UWi5a8d8NHBfRd0RL8LjDA= ------END CERTIFICATE----- diff --git a/nipyapi/demo/keys/client-ks.jks b/nipyapi/demo/keys/client-ks.jks deleted file mode 100644 index e78dc212..00000000 Binary files a/nipyapi/demo/keys/client-ks.jks and /dev/null differ diff --git a/nipyapi/demo/keys/client-ks.p12 b/nipyapi/demo/keys/client-ks.p12 deleted file mode 100644 index b37b659d..00000000 Binary files a/nipyapi/demo/keys/client-ks.p12 and /dev/null differ diff --git a/nipyapi/demo/keys/localhost-ks.jks b/nipyapi/demo/keys/localhost-ks.jks deleted file mode 100644 index b4a9c10a..00000000 Binary files a/nipyapi/demo/keys/localhost-ks.jks and /dev/null differ diff --git a/nipyapi/demo/keys/localhost-ts.jks b/nipyapi/demo/keys/localhost-ts.jks deleted file mode 100644 index 5faf1e61..00000000 Binary files a/nipyapi/demo/keys/localhost-ts.jks and /dev/null differ diff --git a/nipyapi/demo/keys/localhost-ts.p12 b/nipyapi/demo/keys/localhost-ts.p12 deleted file mode 100644 index a89c14c7..00000000 Binary files a/nipyapi/demo/keys/localhost-ts.p12 and /dev/null differ diff --git a/nipyapi/demo/keys/localhost-ts.pem b/nipyapi/demo/keys/localhost-ts.pem deleted file mode 100644 index 78d470af..00000000 --- a/nipyapi/demo/keys/localhost-ts.pem +++ /dev/null @@ -1,25 +0,0 @@ -Bag Attributes - friendlyName: nifi-cert - 2.16.840.1.113894.746875.1.1: -subject=/OU=nifi/CN=localhost -issuer=/OU=nifi/CN=localhost ------BEGIN CERTIFICATE----- -MIIDSTCCAjGgAwIBAgIKAWHouwjKAAAAADANBgkqhkiG9w0BAQsFADAjMQ0wCwYD -VQQLDARuaWZpMRIwEAYDVQQDDAlsb2NhbGhvc3QwHhcNMTgwMzAyMjIwMDI3WhcN -NDUwNzE3MjIwMDI3WjAjMQ0wCwYDVQQLDARuaWZpMRIwEAYDVQQDDAlsb2NhbGhv -c3QwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQCJ9DuU5wHvRfwQKghG -G27Hgif7F3RpMzxlV+vrWIKYKH5FBWT9dhdCxNNcG1uaJveEu1HZOxJ6QjjgP5l1 -cO/vc+LHUct+DAZENMSujIzppw6a79Tg0SsmTPLoexcz5AGgtyVmcLSvzv2aNpo6 -s5+OhCfO6ZBBqGNtEhjBqN988eLYcWw0/FRj9W4TkgTgkIuvsvPyYIiZ9Km2AwFc -HoBKBTJhMMZHAxmGvhX0PD3oAEjTCDSEB7xv6ZrZ8erhONTb40yvVPek7dB09GjU -P9XzpIR7D5XUAJrumDbYBPJQjsZEzksJ7iQ38+EUYHFhm9FuvkGRV7lkAOHX4jnX -nV3fAgMBAAGjfzB9MA4GA1UdDwEB/wQEAwIB/jAMBgNVHRMEBTADAQH/MB0GA1Ud -DgQWBBQqHwLftkS37dEjFUs58U/eXyZ8WjAfBgNVHSMEGDAWgBQqHwLftkS37dEj -FUs58U/eXyZ8WjAdBgNVHSUEFjAUBggrBgEFBQcDAgYIKwYBBQUHAwEwDQYJKoZI -hvcNAQELBQADggEBAC5tH7kJ8IXYhwMuCCLCfPMck4Z3LzjCn7OPjyFfbuoe9zm7 -iRUq8X9EufOSIUJtAz2woWcdTPgjINdzKoKhGZ0s8zoiq/3dKg4C41XAE0OOhM2P -+Hj7QqFQKhBEH7+cW5qqx8ECTuc8/LAbi8ZAklMOy8MLhGfrxh4CBrl1NUVge0L0 -W8T5X8wgWzn36UxX9S2xc2yQzqtRkZShKBWVFaeJYuuO+Nxs5Jgu743ZUAQAV81n -epTDkcOfOePUHL19b5zmM5KdCbpetJjjh96KvPMfcjjgHBCTsvU4MAtYWCddJ8JT -OTfGTlv98aNsqKlk7UWi5a8d8NHBfRd0RL8LjDA= ------END CERTIFICATE----- diff --git a/nipyapi/demo/secure_connection.py b/nipyapi/demo/secure_connection.py deleted file mode 100644 index 069d526b..00000000 --- a/nipyapi/demo/secure_connection.py +++ /dev/null @@ -1,262 +0,0 @@ -""" -An implementation helper for connecting to secure NiFi instances. - -Note: If running on OSX you may have certificate issues with Python which -prevent the nobel user logging into NiFI due to SSL errors. -See this StackOverflow for fixes: https://stackoverflow.com/a/42098127/4717963 -""" - -import logging -from pprint import pprint -from os import path -import sys -import nipyapi - -try: - from nipyapi.utils import DockerContainer - DOCKER_AVAILABLE = True -except ImportError: - DOCKER_AVAILABLE = False - print("The 'docker' package is required for this demo. " - "Please install nipyapi with the 'demo' extra: " - "pip install nipyapi[demo]") - sys.exit(1) - -log = logging.getLogger(__name__) -log.setLevel(logging.INFO) -logging.getLogger('nipyapi.utils').setLevel(logging.INFO) -logging.getLogger('nipyapi.security').setLevel(logging.INFO) -logging.getLogger('nipyapi.versioning').setLevel(logging.INFO) - -# Uncomment the block below to enable debug logging -# nipyapi.config.nifi_config.debug=True -# nipyapi.config.registry_config.debug=True -# root_logger = logging.getLogger() -# root_logger.setLevel(logging.DEBUG) - - -_basename = "nipyapi_secure" -_rc0 = _basename + '_reg_client_0' - -d_network_name = 'securedemo' - -secured_registry_url = 'https://localhost:18443/nifi-registry-api' -secured_nifi_url = 'https://localhost:8443/nifi-api' - -host_certs_path = path.join( - nipyapi.config.PROJECT_ROOT_DIR, - "demo/keys" -) - -tls_env_vars = { - 'AUTH': 'tls', - 'KEYSTORE_PATH': '/opt/certs/localhost-ks.jks', - 'KEYSTORE_TYPE': 'JKS', - 'KEYSTORE_PASSWORD': 'localhostKeystorePassword', - 'TRUSTSTORE_PATH': '/opt/certs/localhost-ts.jks', - 'TRUSTSTORE_PASSWORD': 'localhostTruststorePassword', - 'TRUSTSTORE_TYPE': 'JKS', - 'INITIAL_ADMIN_IDENTITY': 'CN=user1, OU=nifi', -} - -ldap_env_vars = { - 'AUTH': 'ldap', - 'KEYSTORE_PATH': '/opt/certs/localhost-ks.jks', - 'KEYSTORE_TYPE': 'JKS', - 'KEYSTORE_PASSWORD': 'localhostKeystorePassword', - 'TRUSTSTORE_PATH': '/opt/certs/localhost-ts.jks', - 'TRUSTSTORE_PASSWORD': 'localhostTruststorePassword', - 'TRUSTSTORE_TYPE': 'JKS', - 'INITIAL_ADMIN_IDENTITY': 'nobel', - 'LDAP_AUTHENTICATION_STRATEGY': 'SIMPLE', - 'LDAP_MANAGER_DN': 'cn=read-only-admin,dc=example,dc=com', - 'LDAP_MANAGER_PASSWORD': 'password', - 'LDAP_USER_SEARCH_BASE': 'dc=example,dc=com', - 'LDAP_USER_SEARCH_FILTER': '(uid={0})', - 'LDAP_IDENTITY_STRATEGY': 'USE_USERNAME', - 'LDAP_URL': 'ldap://ldap.forumsys.com:389', -} - -d_containers = [ - DockerContainer( - name='secure-nifi', - image_name='apache/nifi', - image_tag='1.27.0', - ports={'8443/tcp': 8443}, - env=ldap_env_vars, - volumes={ - host_certs_path: {'bind': '/opt/certs', 'mode': 'ro'} - }, - ), - DockerContainer( - name='secure-registry', - image_name='apache/nifi-registry', - image_tag='1.27.0', - ports={'18443/tcp': 18443}, - env=tls_env_vars, - volumes={ - host_certs_path: {'bind': '/opt/certs', 'mode': 'ro'} - }, - ), - # For now this uses a publicly available LDAP test server -] - - -def connect_nifi_to_registry(): - """ - Add the NiFi server as a trusted client/proxy for the NiFi Registry - """ - - # Add NiFi server identity as user to NiFi Registry - # nifi_proxy = nipyapi.registry.User(identity="CN=localhost, OU=nifi") - # nifi_proxy = nipyapi.registry.TenantsApi().create_user(nifi_proxy) - nifi_proxy = nipyapi.security.create_service_user( - identity="CN=localhost, OU=nifi", - service='registry' - ) - - # Make NiFi server a trusted proxy in NiFi Registry - proxy_access_policies = [ - ("write", "/proxy"), - ("read", "/buckets") - ] - for action, resource in proxy_access_policies: - pol = nipyapi.security.get_access_policy_for_resource( - resource=resource, - action=action, - service='registry', - auto_create=True - ) - nipyapi.security.add_user_to_access_policy( - user=nifi_proxy, - policy=pol, - service='registry' - ) - - # Add current NiFi user (our NiFi admin) as user to NiFi Registry - nifi_user_obj = nipyapi.security.get_service_user('nobel') - nifi_reg_user = nipyapi.security.create_service_user( - identity=nifi_user_obj.component.identity, - service='registry' - ) - - # Make NiFi "nobel" user have access to all buckets in Registry - all_buckets_access_policies = [ - ("read", "/buckets"), - ("write", "/buckets"), - ("delete", "/buckets") - ] - for action, resource in all_buckets_access_policies: - pol = nipyapi.security.get_access_policy_for_resource( - resource=resource, - action=action, - service='registry', - auto_create=True - ) - nipyapi.security.add_user_to_access_policy( - user=nifi_reg_user, - policy=pol, - service='registry' - ) - - -def bootstrap_nifi_access_policies(user='nobel'): - """ - Grant the current nifi user access to the root process group - - Note: Not sure not work with the current LDAP-configured Docker image. - It may need to be tweaked to configure the ldap-user-group-provider. - """ - rpg_id = nipyapi.canvas.get_root_pg_id() - nifi_user_identity = nipyapi.security.get_service_user(user) - - access_policies = [ - ('write', 'process-groups', rpg_id), - ('read', 'process-groups', rpg_id) - ] - for pol in access_policies: - ap = nipyapi.security.create_access_policy( - action=pol[0], - resource=pol[1], - r_id=pol[2], - service='nifi' - ) - nipyapi.security.add_user_to_access_policy( - nifi_user_identity, - policy=ap, - service='nifi' - ) - - -# connection test disabled as it not configured with the correct SSLContext -log.info("Starting Secured NiFi and NiFi-Registry Docker Containers") -nipyapi.utils.start_docker_containers( - docker_containers=d_containers, - network_name=d_network_name -) - -log.info("Creating Registry security context") -nipyapi.utils.set_endpoint(secured_registry_url) -log.info("Using demo certs from %s", host_certs_path) -nipyapi.security.set_service_ssl_context( - service='registry', - ca_file=path.join(host_certs_path, 'localhost-ts.pem'), - client_cert_file=path.join(host_certs_path, 'client-cert.pem'), - client_key_file=path.join(host_certs_path, 'client-key.pem'), - client_key_password='clientPassword' -) -log.info("Waiting for Registry to be ready for login") -registry_user = nipyapi.utils.wait_to_complete( - test_function=nipyapi.security.get_service_access_status, - service='registry', - bool_response=True, - nipyapi_delay=nipyapi.config.long_retry_delay, - nipyapi_max_wait=nipyapi.config.long_max_wait -) -pprint('nipyapi_secured_registry CurrentUser: ' + registry_user.identity) - -log.info("Creating NiFi security context") -nipyapi.utils.set_endpoint(secured_nifi_url) -nipyapi.security.set_service_ssl_context( - service='nifi', - ca_file=host_certs_path + '/localhost-ts.pem' -) -log.info("Waiting for NiFi to be ready for login") -nipyapi.utils.wait_to_complete( - test_function=nipyapi.security.service_login, - service='nifi', - username='nobel', - password='supersecret1!', - bool_response=True, - nipyapi_delay=nipyapi.config.long_retry_delay, - nipyapi_max_wait=nipyapi.config.long_max_wait -) -nifi_user = nipyapi.security.get_service_access_status(service='nifi') -pprint( - 'nipyapi_secured_nifi CurrentUser: ' + nifi_user.access_status.identity -) - -log.info("Granting NiFi user access to root process group") -bootstrap_nifi_access_policies() - -log.info("Connecting secured NiFi to secured Registry and granting NiFi " - "user " - "access to Registry") -connect_nifi_to_registry() - -log.info("Creating reg_client_0 as NiFi Registry Client named %s", _rc0) -try: - reg_client_0 = nipyapi.versioning.create_registry_client( - name=_rc0, - uri='https://secure-registry:18443', - description='NiPyApi Secure Test' - ) -except ValueError: - reg_client_0 = nipyapi.versioning.get_registry_client(_rc0) - -log.info("killing the running containers") - -for docker_container in d_containers: - docker_container.get_container().kill() - -pprint("All Done!") diff --git a/nipyapi/nifi/__init__.py b/nipyapi/nifi/__init__.py index 876be2d0..b669f91c 100644 --- a/nipyapi/nifi/__init__.py +++ b/nipyapi/nifi/__init__.py @@ -1,38 +1,37 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - - - # import models into sdk package from .models.about_dto import AboutDTO from .models.about_entity import AboutEntity -from .models.access_configuration_dto import AccessConfigurationDTO -from .models.access_configuration_entity import AccessConfigurationEntity from .models.access_policy_dto import AccessPolicyDTO from .models.access_policy_entity import AccessPolicyEntity from .models.access_policy_summary_dto import AccessPolicySummaryDTO from .models.access_policy_summary_entity import AccessPolicySummaryEntity -from .models.access_status_dto import AccessStatusDTO -from .models.access_status_entity import AccessStatusEntity -from .models.access_token_expiration_dto import AccessTokenExpirationDTO -from .models.access_token_expiration_entity import AccessTokenExpirationEntity +from .models.access_token_body import AccessTokenBody from .models.action_dto import ActionDTO from .models.action_details_dto import ActionDetailsDTO from .models.action_entity import ActionEntity from .models.activate_controller_services_entity import ActivateControllerServicesEntity +from .models.additional_details_entity import AdditionalDetailsEntity from .models.affected_component_dto import AffectedComponentDTO from .models.affected_component_entity import AffectedComponentEntity from .models.allowable_value_dto import AllowableValueDTO from .models.allowable_value_entity import AllowableValueEntity +from .models.asset_dto import AssetDTO +from .models.asset_entity import AssetEntity +from .models.asset_reference_dto import AssetReferenceDTO +from .models.assets_entity import AssetsEntity from .models.attribute import Attribute from .models.attribute_dto import AttributeDTO +from .models.authentication_configuration_dto import AuthenticationConfigurationDTO +from .models.authentication_configuration_entity import AuthenticationConfigurationEntity from .models.banner_dto import BannerDTO from .models.banner_entity import BannerEntity from .models.batch_settings_dto import BatchSettingsDTO @@ -40,21 +39,21 @@ from .models.build_info import BuildInfo from .models.bulletin_board_dto import BulletinBoardDTO from .models.bulletin_board_entity import BulletinBoardEntity +from .models.bulletin_board_pattern_parameter import BulletinBoardPatternParameter from .models.bulletin_dto import BulletinDTO from .models.bulletin_entity import BulletinEntity from .models.bundle import Bundle from .models.bundle_dto import BundleDTO -from .models.class_loader_diagnostics_dto import ClassLoaderDiagnosticsDTO -from .models.cluste_summary_entity import ClusteSummaryEntity +from .models.client_id_parameter import ClientIdParameter from .models.cluster_dto import ClusterDTO from .models.cluster_entity import ClusterEntity from .models.cluster_search_results_entity import ClusterSearchResultsEntity from .models.cluster_summary_dto import ClusterSummaryDTO +from .models.cluster_summary_entity import ClusterSummaryEntity from .models.component_details_dto import ComponentDetailsDTO from .models.component_difference_dto import ComponentDifferenceDTO from .models.component_history_dto import ComponentHistoryDTO from .models.component_history_entity import ComponentHistoryEntity -from .models.component_lifecycle import ComponentLifecycle from .models.component_manifest import ComponentManifest from .models.component_reference_dto import ComponentReferenceDTO from .models.component_reference_entity import ComponentReferenceEntity @@ -71,8 +70,6 @@ from .models.connectable_component import ConnectableComponent from .models.connectable_dto import ConnectableDTO from .models.connection_dto import ConnectionDTO -from .models.connection_diagnostics_dto import ConnectionDiagnosticsDTO -from .models.connection_diagnostics_snapshot_dto import ConnectionDiagnosticsSnapshotDTO from .models.connection_entity import ConnectionEntity from .models.connection_statistics_dto import ConnectionStatisticsDTO from .models.connection_statistics_entity import ConnectionStatisticsEntity @@ -83,6 +80,8 @@ from .models.connection_status_snapshot_dto import ConnectionStatusSnapshotDTO from .models.connection_status_snapshot_entity import ConnectionStatusSnapshotEntity from .models.connections_entity import ConnectionsEntity +from .models.content_viewer_dto import ContentViewerDTO +from .models.content_viewer_entity import ContentViewerEntity from .models.controller_bulletins_entity import ControllerBulletinsEntity from .models.controller_configuration_dto import ControllerConfigurationDTO from .models.controller_configuration_entity import ControllerConfigurationEntity @@ -92,7 +91,6 @@ from .models.controller_service_api_dto import ControllerServiceApiDTO from .models.controller_service_dto import ControllerServiceDTO from .models.controller_service_definition import ControllerServiceDefinition -from .models.controller_service_diagnostics_dto import ControllerServiceDiagnosticsDTO from .models.controller_service_entity import ControllerServiceEntity from .models.controller_service_referencing_component_dto import ControllerServiceReferencingComponentDTO from .models.controller_service_referencing_component_entity import ControllerServiceReferencingComponentEntity @@ -103,6 +101,8 @@ from .models.controller_services_entity import ControllerServicesEntity from .models.controller_status_dto import ControllerStatusDTO from .models.controller_status_entity import ControllerStatusEntity +from .models.copy_request_entity import CopyRequestEntity +from .models.copy_response_entity import CopyResponseEntity from .models.copy_snippet_request_entity import CopySnippetRequestEntity from .models.counter_dto import CounterDTO from .models.counter_entity import CounterEntity @@ -110,20 +110,27 @@ from .models.counters_entity import CountersEntity from .models.counters_snapshot_dto import CountersSnapshotDTO from .models.create_active_request_entity import CreateActiveRequestEntity -from .models.create_template_request_entity import CreateTemplateRequestEntity from .models.current_user_entity import CurrentUserEntity +from .models.date_time_parameter import DateTimeParameter from .models.defined_type import DefinedType from .models.difference_dto import DifferenceDTO from .models.dimensions_dto import DimensionsDTO from .models.documented_type_dto import DocumentedTypeDTO from .models.drop_request_dto import DropRequestDTO from .models.drop_request_entity import DropRequestEntity -from .models.dto_factory import DtoFactory from .models.dynamic_property import DynamicProperty from .models.dynamic_relationship import DynamicRelationship -from .models.entity import Entity from .models.explicit_restriction_dto import ExplicitRestrictionDTO from .models.external_controller_service_reference import ExternalControllerServiceReference +from .models.flow_analysis_result_entity import FlowAnalysisResultEntity +from .models.flow_analysis_rule_dto import FlowAnalysisRuleDTO +from .models.flow_analysis_rule_definition import FlowAnalysisRuleDefinition +from .models.flow_analysis_rule_entity import FlowAnalysisRuleEntity +from .models.flow_analysis_rule_run_status_entity import FlowAnalysisRuleRunStatusEntity +from .models.flow_analysis_rule_status_dto import FlowAnalysisRuleStatusDTO +from .models.flow_analysis_rule_types_entity import FlowAnalysisRuleTypesEntity +from .models.flow_analysis_rule_violation_dto import FlowAnalysisRuleViolationDTO +from .models.flow_analysis_rules_entity import FlowAnalysisRulesEntity from .models.flow_breadcrumb_dto import FlowBreadcrumbDTO from .models.flow_breadcrumb_entity import FlowBreadcrumbEntity from .models.flow_comparison_entity import FlowComparisonEntity @@ -134,6 +141,9 @@ from .models.flow_file_dto import FlowFileDTO from .models.flow_file_entity import FlowFileEntity from .models.flow_file_summary_dto import FlowFileSummaryDTO +from .models.flow_registry_branch_dto import FlowRegistryBranchDTO +from .models.flow_registry_branch_entity import FlowRegistryBranchEntity +from .models.flow_registry_branches_entity import FlowRegistryBranchesEntity from .models.flow_registry_bucket import FlowRegistryBucket from .models.flow_registry_bucket_dto import FlowRegistryBucketDTO from .models.flow_registry_bucket_entity import FlowRegistryBucketEntity @@ -147,45 +157,42 @@ from .models.funnel_dto import FunnelDTO from .models.funnel_entity import FunnelEntity from .models.funnels_entity import FunnelsEntity -from .models.gc_diagnostics_snapshot_dto import GCDiagnosticsSnapshotDTO from .models.garbage_collection_dto import GarbageCollectionDTO -from .models.garbage_collection_diagnostics_dto import GarbageCollectionDiagnosticsDTO from .models.history_dto import HistoryDTO from .models.history_entity import HistoryEntity from .models.input_ports_entity import InputPortsEntity -from .models.input_stream import InputStream -from .models.instantiate_template_request_entity import InstantiateTemplateRequestEntity -from .models.jvm_controller_diagnostics_snapshot_dto import JVMControllerDiagnosticsSnapshotDTO -from .models.jvm_diagnostics_dto import JVMDiagnosticsDTO -from .models.jvm_diagnostics_snapshot_dto import JVMDiagnosticsSnapshotDTO -from .models.jvm_flow_diagnostics_snapshot_dto import JVMFlowDiagnosticsSnapshotDTO -from .models.jvm_system_diagnostics_snapshot_dto import JVMSystemDiagnosticsSnapshotDTO +from .models.integer_parameter import IntegerParameter from .models.jmx_metrics_result_dto import JmxMetricsResultDTO from .models.jmx_metrics_results_entity import JmxMetricsResultsEntity from .models.label_dto import LabelDTO from .models.label_entity import LabelEntity from .models.labels_entity import LabelsEntity +from .models.latest_provenance_events_dto import LatestProvenanceEventsDTO +from .models.latest_provenance_events_entity import LatestProvenanceEventsEntity from .models.lineage_dto import LineageDTO from .models.lineage_entity import LineageEntity from .models.lineage_request_dto import LineageRequestDTO from .models.lineage_results_dto import LineageResultsDTO from .models.listing_request_dto import ListingRequestDTO from .models.listing_request_entity import ListingRequestEntity -from .models.local_queue_partition_dto import LocalQueuePartitionDTO +from .models.long_parameter import LongParameter +from .models.multi_processor_use_case import MultiProcessorUseCase +from .models.nar_coordinate_dto import NarCoordinateDTO +from .models.nar_details_entity import NarDetailsEntity +from .models.nar_summaries_entity import NarSummariesEntity +from .models.nar_summary_dto import NarSummaryDTO +from .models.nar_summary_entity import NarSummaryEntity from .models.node_connection_statistics_snapshot_dto import NodeConnectionStatisticsSnapshotDTO from .models.node_connection_status_snapshot_dto import NodeConnectionStatusSnapshotDTO from .models.node_counters_snapshot_dto import NodeCountersSnapshotDTO from .models.node_dto import NodeDTO from .models.node_entity import NodeEntity from .models.node_event_dto import NodeEventDTO -from .models.node_identifier import NodeIdentifier -from .models.node_jvm_diagnostics_snapshot_dto import NodeJVMDiagnosticsSnapshotDTO from .models.node_port_status_snapshot_dto import NodePortStatusSnapshotDTO from .models.node_process_group_status_snapshot_dto import NodeProcessGroupStatusSnapshotDTO from .models.node_processor_status_snapshot_dto import NodeProcessorStatusSnapshotDTO from .models.node_remote_process_group_status_snapshot_dto import NodeRemoteProcessGroupStatusSnapshotDTO from .models.node_replay_last_event_snapshot_dto import NodeReplayLastEventSnapshotDTO -from .models.node_response import NodeResponse from .models.node_search_result_dto import NodeSearchResultDTO from .models.node_status_snapshots_dto import NodeStatusSnapshotsDTO from .models.node_system_diagnostics_snapshot_dto import NodeSystemDiagnosticsSnapshotDTO @@ -211,6 +218,7 @@ from .models.parameter_provider_configuration_dto import ParameterProviderConfigurationDTO from .models.parameter_provider_configuration_entity import ParameterProviderConfigurationEntity from .models.parameter_provider_dto import ParameterProviderDTO +from .models.parameter_provider_definition import ParameterProviderDefinition from .models.parameter_provider_entity import ParameterProviderEntity from .models.parameter_provider_parameter_application_entity import ParameterProviderParameterApplicationEntity from .models.parameter_provider_parameter_fetch_entity import ParameterProviderParameterFetchEntity @@ -221,6 +229,8 @@ from .models.parameter_provider_types_entity import ParameterProviderTypesEntity from .models.parameter_providers_entity import ParameterProvidersEntity from .models.parameter_status_dto import ParameterStatusDTO +from .models.paste_request_entity import PasteRequestEntity +from .models.paste_response_entity import PasteResponseEntity from .models.peer_dto import PeerDTO from .models.peers_entity import PeersEntity from .models.permissions_dto import PermissionsDTO @@ -247,13 +257,14 @@ from .models.process_group_status_entity import ProcessGroupStatusEntity from .models.process_group_status_snapshot_dto import ProcessGroupStatusSnapshotDTO from .models.process_group_status_snapshot_entity import ProcessGroupStatusSnapshotEntity +from .models.process_group_upload_entity import ProcessGroupUploadEntity from .models.process_groups_entity import ProcessGroupsEntity +from .models.processgroups_upload_body import ProcessgroupsUploadBody from .models.processing_performance_status_dto import ProcessingPerformanceStatusDTO from .models.processor_config_dto import ProcessorConfigDTO +from .models.processor_configuration import ProcessorConfiguration from .models.processor_dto import ProcessorDTO from .models.processor_definition import ProcessorDefinition -from .models.processor_diagnostics_dto import ProcessorDiagnosticsDTO -from .models.processor_diagnostics_entity import ProcessorDiagnosticsEntity from .models.processor_entity import ProcessorEntity from .models.processor_run_status_details_dto import ProcessorRunStatusDetailsDTO from .models.processor_run_status_details_entity import ProcessorRunStatusDetailsEntity @@ -303,7 +314,6 @@ from .models.remote_process_group_status_snapshot_dto import RemoteProcessGroupStatusSnapshotDTO from .models.remote_process_group_status_snapshot_entity import RemoteProcessGroupStatusSnapshotEntity from .models.remote_process_groups_entity import RemoteProcessGroupsEntity -from .models.remote_queue_partition_dto import RemoteQueuePartitionDTO from .models.replay_last_event_request_entity import ReplayLastEventRequestEntity from .models.replay_last_event_response_entity import ReplayLastEventResponseEntity from .models.replay_last_event_snapshot_dto import ReplayLastEventSnapshotDTO @@ -314,11 +324,10 @@ from .models.reporting_task_status_dto import ReportingTaskStatusDTO from .models.reporting_task_types_entity import ReportingTaskTypesEntity from .models.reporting_tasks_entity import ReportingTasksEntity -from .models.repository_usage_dto import RepositoryUsageDTO from .models.required_permission_dto import RequiredPermissionDTO +from .models.resource_claim_details_dto import ResourceClaimDetailsDTO from .models.resource_dto import ResourceDTO from .models.resources_entity import ResourcesEntity -from .models.response import Response from .models.restriction import Restriction from .models.revision_dto import RevisionDTO from .models.run_status_details_request_entity import RunStatusDetailsRequestEntity @@ -331,7 +340,6 @@ from .models.search_results_entity import SearchResultsEntity from .models.snippet_dto import SnippetDTO from .models.snippet_entity import SnippetEntity -from .models.stack_trace_element import StackTraceElement from .models.start_version_control_request_entity import StartVersionControlRequestEntity from .models.state_entry_dto import StateEntryDTO from .models.state_map_dto import StateMapDTO @@ -343,33 +351,23 @@ from .models.storage_usage_dto import StorageUsageDTO from .models.streaming_output import StreamingOutput from .models.submit_replay_request_entity import SubmitReplayRequestEntity +from .models.supported_mime_types_dto import SupportedMimeTypesDTO from .models.system_diagnostics_dto import SystemDiagnosticsDTO from .models.system_diagnostics_entity import SystemDiagnosticsEntity from .models.system_diagnostics_snapshot_dto import SystemDiagnosticsSnapshotDTO from .models.system_resource_consideration import SystemResourceConsideration -from .models.template_dto import TemplateDTO -from .models.template_entity import TemplateEntity -from .models.templates_entity import TemplatesEntity from .models.tenant_dto import TenantDTO from .models.tenant_entity import TenantEntity from .models.tenants_entity import TenantsEntity -from .models.thread_dump_dto import ThreadDumpDTO -from .models.throwable import Throwable from .models.transaction_result_entity import TransactionResultEntity from .models.update_controller_service_reference_request_entity import UpdateControllerServiceReferenceRequestEntity +from .models.use_case import UseCase from .models.user_dto import UserDTO from .models.user_entity import UserEntity from .models.user_group_dto import UserGroupDTO from .models.user_group_entity import UserGroupEntity from .models.user_groups_entity import UserGroupsEntity from .models.users_entity import UsersEntity -from .models.variable_dto import VariableDTO -from .models.variable_entity import VariableEntity -from .models.variable_registry_dto import VariableRegistryDTO -from .models.variable_registry_entity import VariableRegistryEntity -from .models.variable_registry_update_request_dto import VariableRegistryUpdateRequestDTO -from .models.variable_registry_update_request_entity import VariableRegistryUpdateRequestEntity -from .models.variable_registry_update_step_dto import VariableRegistryUpdateStepDTO from .models.verify_config_request_dto import VerifyConfigRequestDTO from .models.verify_config_request_entity import VerifyConfigRequestEntity from .models.verify_config_update_step_dto import VerifyConfigUpdateStepDTO @@ -377,6 +375,7 @@ from .models.version_control_information_dto import VersionControlInformationDTO from .models.version_control_information_entity import VersionControlInformationEntity from .models.version_info_dto import VersionInfoDTO +from .models.versioned_asset import VersionedAsset from .models.versioned_connection import VersionedConnection from .models.versioned_controller_service import VersionedControllerService from .models.versioned_flow_coordinates import VersionedFlowCoordinates @@ -399,19 +398,21 @@ from .models.versioned_remote_group_port import VersionedRemoteGroupPort from .models.versioned_remote_process_group import VersionedRemoteProcessGroup from .models.versioned_reporting_task import VersionedReportingTask +from .models.versioned_reporting_task_import_request_entity import VersionedReportingTaskImportRequestEntity +from .models.versioned_reporting_task_import_response_entity import VersionedReportingTaskImportResponseEntity from .models.versioned_reporting_task_snapshot import VersionedReportingTaskSnapshot from .models.versioned_resource_definition import VersionedResourceDefinition - # import apis into sdk package from .apis.access_api import AccessApi +from .apis.authentication_api import AuthenticationApi from .apis.connections_api import ConnectionsApi from .apis.controller_api import ControllerApi from .apis.controller_services_api import ControllerServicesApi from .apis.counters_api import CountersApi from .apis.data_transfer_api import DataTransferApi from .apis.flow_api import FlowApi -from .apis.flowfile_queues_api import FlowfileQueuesApi -from .apis.funnel_api import FunnelApi +from .apis.flow_file_queues_api import FlowFileQueuesApi +from .apis.funnels_api import FunnelsApi from .apis.input_ports_api import InputPortsApi from .apis.labels_api import LabelsApi from .apis.output_ports_api import OutputPortsApi @@ -428,10 +429,8 @@ from .apis.site_to_site_api import SiteToSiteApi from .apis.snippets_api import SnippetsApi from .apis.system_diagnostics_api import SystemDiagnosticsApi -from .apis.templates_api import TemplatesApi from .apis.tenants_api import TenantsApi from .apis.versions_api import VersionsApi - # import ApiClient from .api_client import ApiClient diff --git a/nipyapi/nifi/api_client.py b/nipyapi/nifi/api_client.py index 5cf02cbe..abade8c8 100644 --- a/nipyapi/nifi/api_client.py +++ b/nipyapi/nifi/api_client.py @@ -1,20 +1,18 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - import os import re import json import mimetypes import tempfile -import threading from datetime import date, datetime from urllib.parse import quote @@ -91,7 +89,7 @@ def set_default_header(self, header_name, header_value): def __call_api(self, resource_path, method, path_params=None, query_params=None, header_params=None, body=None, post_params=None, files=None, - response_type=None, auth_settings=None, callback=None, + response_type=None, auth_settings=None, _return_http_data_only=None, collection_formats=None, _preload_content=True, _request_timeout=None): @@ -158,12 +156,7 @@ def __call_api(self, resource_path, method, else: return_data = None - if callback: - if _return_http_data_only: - callback(return_data) - else: - callback((return_data, response_data.status, response_data.headers)) - elif _return_http_data_only: + if _return_http_data_only: return (return_data) else: return (return_data, response_data.status, response_data.headers) @@ -255,7 +248,7 @@ def __deserialize(self, data, klass): if type(klass) == str: if klass.startswith('list['): - sub_kls = re.match('list\[(.*)\]', klass).group(1) + sub_kls = re.match(r'list\[(.*)\]', klass).group(1) if isinstance(data, dict): # ok, we got a single instance when we may have gotten a list return self.__deserialize(data, sub_kls) @@ -263,7 +256,7 @@ def __deserialize(self, data, klass): for sub_data in data] if klass.startswith('dict('): - sub_kls = re.match('dict\(([^,]*), (.*)\)', klass).group(2) + sub_kls = re.match(r'dict\(([^,]*), (.*)\)', klass).group(2) return {k: self.__deserialize(v, sub_kls) for k, v in data.items()} @@ -287,12 +280,11 @@ def __deserialize(self, data, klass): def call_api(self, resource_path, method, path_params=None, query_params=None, header_params=None, body=None, post_params=None, files=None, - response_type=None, auth_settings=None, callback=None, + response_type=None, auth_settings=None, _return_http_data_only=None, collection_formats=None, _preload_content=True, _request_timeout=None): """ Makes the HTTP request (synchronous) and return the deserialized data. - To make an async request, define a function for callback. :param resource_path: Path to method endpoint. :param method: Method to call. @@ -307,9 +299,6 @@ def call_api(self, resource_path, method, :param response: Response data type. :param files dict: key -> filename, value -> filepath, for `multipart/form-data`. - :param callback function: Callback function for asynchronous request. - If provide this parameter, - the request will be called asynchronously. :param _return_http_data_only: response data without head status code and headers :param collection_formats: dict of collection formats for path, query, header, and post parameters. @@ -324,23 +313,11 @@ def call_api(self, resource_path, method, If parameter callback is None, then the method will return the response directly. """ - if callback is None: - return self.__call_api(resource_path, method, - path_params, query_params, header_params, - body, post_params, files, - response_type, auth_settings, callback, - _return_http_data_only, collection_formats, _preload_content, _request_timeout) - else: - thread = threading.Thread(target=self.__call_api, - args=(resource_path, method, - path_params, query_params, - header_params, body, - post_params, files, - response_type, auth_settings, - callback, _return_http_data_only, - collection_formats, _preload_content, _request_timeout)) - thread.start() - return thread + return self.__call_api(resource_path, method, + path_params, query_params, header_params, + body, post_params, files, + response_type, auth_settings, + _return_http_data_only, collection_formats, _preload_content, _request_timeout) def request(self, method, url, query_params=None, headers=None, post_params=None, body=None, _preload_content=True, _request_timeout=None): diff --git a/nipyapi/nifi/apis/__init__.py b/nipyapi/nifi/apis/__init__.py index e316038e..b58e19fd 100644 --- a/nipyapi/nifi/apis/__init__.py +++ b/nipyapi/nifi/apis/__init__.py @@ -1,14 +1,15 @@ # import apis into api package from .access_api import AccessApi +from .authentication_api import AuthenticationApi from .connections_api import ConnectionsApi from .controller_api import ControllerApi from .controller_services_api import ControllerServicesApi from .counters_api import CountersApi from .data_transfer_api import DataTransferApi from .flow_api import FlowApi -from .flowfile_queues_api import FlowfileQueuesApi -from .funnel_api import FunnelApi +from .flow_file_queues_api import FlowFileQueuesApi +from .funnels_api import FunnelsApi from .input_ports_api import InputPortsApi from .labels_api import LabelsApi from .output_ports_api import OutputPortsApi @@ -25,6 +26,5 @@ from .site_to_site_api import SiteToSiteApi from .snippets_api import SnippetsApi from .system_diagnostics_api import SystemDiagnosticsApi -from .templates_api import TemplatesApi from .tenants_api import TenantsApi from .versions_api import VersionsApi diff --git a/nipyapi/nifi/apis/access_api.py b/nipyapi/nifi/apis/access_api.py index 3cfcaa02..407a958c 100644 --- a/nipyapi/nifi/apis/access_api.py +++ b/nipyapi/nifi/apis/access_api.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - import sys import os import re @@ -35,23 +34,21 @@ def __init__(self, api_client=None): def create_access_token(self, **kwargs): """ - Creates a token for accessing the REST API via username/password + Creates a token for accessing the REST API via username/password. + The token returned is formatted as a JSON Web Token (JWT). The token is base64 encoded and comprised of three parts. The header, the body, and the signature. The expiration of the token is a contained within the body. It is stored in the browser as a cookie, but also returned inthe response body to be stored/used by third party client scripts. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.create_access_token(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str username: - :param str password: - :return: str - If the method is called asynchronously, - returns the request thread. + + 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_access_token_with_http_info()`` method instead. + + Args: + password (str): + username (str): + + Returns: + str: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): @@ -62,27 +59,24 @@ def create_access_token(self, **kwargs): def create_access_token_with_http_info(self, **kwargs): """ - Creates a token for accessing the REST API via username/password + Creates a token for accessing the REST API via username/password. + The token returned is formatted as a JSON Web Token (JWT). The token is base64 encoded and comprised of three parts. The header, the body, and the signature. The expiration of the token is a contained within the body. It is stored in the browser as a cookie, but also returned inthe response body to be stored/used by third party client scripts. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.create_access_token_with_http_info(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str username: - :param str password: - :return: str - If the method is called asynchronously, - returns the request thread. + + 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_access_token()`` method instead. + + Args: + password (str): + username (str): + + Returns: + tuple: (str, status_code, headers) - Response data with HTTP details. """ - all_params = ['username', 'password'] - all_params.append('callback') + all_params = ['password', 'username'] all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -97,7 +91,8 @@ def create_access_token_with_http_info(self, **kwargs): params[key] = val del params['kwargs'] - + + collection_formats = {} path_params = {} @@ -108,10 +103,10 @@ def create_access_token_with_http_info(self, **kwargs): form_params = [] local_var_files = {} - if 'username' in params: - form_params.append(('username', params['username'])) if 'password' in params: form_params.append(('password', params['password'])) + if 'username' in params: + form_params.append(('username', params['username'])) body_params = None # HTTP header `Accept` @@ -123,7 +118,7 @@ def create_access_token_with_http_info(self, **kwargs): select_header_content_type(['application/x-www-form-urlencoded']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = [] return self.api_client.call_api('/access/token', 'POST', path_params, @@ -134,711 +129,26 @@ def create_access_token_with_http_info(self, **kwargs): files=local_var_files, response_type='str', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def create_access_token_from_ticket(self, **kwargs): - """ - Creates a token for accessing the REST API via Kerberos ticket exchange / SPNEGO negotiation - The token returned is formatted as a JSON Web Token (JWT). The token is base64 encoded and comprised of three parts. The header, the body, and the signature. The expiration of the token is a contained within the body. The token can be used in the Authorization header in the format 'Authorization: Bearer '. It is also stored in the browser as a cookie. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.create_access_token_from_ticket(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :return: str - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.create_access_token_from_ticket_with_http_info(**kwargs) - else: - (data) = self.create_access_token_from_ticket_with_http_info(**kwargs) - return data - - def create_access_token_from_ticket_with_http_info(self, **kwargs): - """ - Creates a token for accessing the REST API via Kerberos ticket exchange / SPNEGO negotiation - The token returned is formatted as a JSON Web Token (JWT). The token is base64 encoded and comprised of three parts. The header, the body, and the signature. The expiration of the token is a contained within the body. The token can be used in the Authorization header in the format 'Authorization: Bearer '. It is also stored in the browser as a cookie. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.create_access_token_from_ticket_with_http_info(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :return: str - If the method is called asynchronously, - returns the request thread. - """ - - all_params = [] - all_params.append('callback') - all_params.append('_return_http_data_only') - all_params.append('_preload_content') - all_params.append('_request_timeout') - - params = locals() - for key, val in params['kwargs'].items(): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method create_access_token_from_ticket" % key - ) - params[key] = val - del params['kwargs'] - - collection_formats = {} - - path_params = {} - - query_params = [] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['text/plain']) - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['text/plain']) - - # Authentication setting - auth_settings = ['tokenAuth'] - - return self.api_client.call_api('/access/kerberos', 'POST', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='str', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only'), - _preload_content=params.get('_preload_content', True), - _request_timeout=params.get('_request_timeout'), - collection_formats=collection_formats) - - def get_access_status(self, **kwargs): - """ - Gets the status the client's access - Note: This endpoint is subject to change as NiFi and it's REST API evolve. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_access_status(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :return: AccessStatusEntity - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_access_status_with_http_info(**kwargs) - else: - (data) = self.get_access_status_with_http_info(**kwargs) - return data - - def get_access_status_with_http_info(self, **kwargs): - """ - Gets the status the client's access - Note: This endpoint is subject to change as NiFi and it's REST API evolve. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_access_status_with_http_info(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :return: AccessStatusEntity - If the method is called asynchronously, - returns the request thread. - """ - - all_params = [] - all_params.append('callback') - all_params.append('_return_http_data_only') - all_params.append('_preload_content') - all_params.append('_request_timeout') - - params = locals() - for key, val in params['kwargs'].items(): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_access_status" % key - ) - params[key] = val - del params['kwargs'] - - collection_formats = {} - - path_params = {} - - query_params = [] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['*/*']) - - # Authentication setting - auth_settings = ['tokenAuth'] - - return self.api_client.call_api('/access', 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='AccessStatusEntity', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only'), - _preload_content=params.get('_preload_content', True), - _request_timeout=params.get('_request_timeout'), - collection_formats=collection_formats) - - def get_access_token_expiration(self, **kwargs): - """ - Get expiration for current Access Token - Note: This endpoint is subject to change as NiFi and it's REST API evolve. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_access_token_expiration(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :return: AccessTokenExpirationEntity - If the method is called asynchronously, - returns the request thread. + def log_out(self, **kwargs): """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_access_token_expiration_with_http_info(**kwargs) - else: - (data) = self.get_access_token_expiration_with_http_info(**kwargs) - return data + Performs a logout for other providers that have been issued a JWT.. - def get_access_token_expiration_with_http_info(self, **kwargs): - """ - Get expiration for current Access Token Note: This endpoint is subject to change as NiFi and it's REST API evolve. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_access_token_expiration_with_http_info(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :return: AccessTokenExpirationEntity - If the method is called asynchronously, - returns the request thread. - """ - - all_params = [] - all_params.append('callback') - all_params.append('_return_http_data_only') - all_params.append('_preload_content') - all_params.append('_request_timeout') - - params = locals() - for key, val in params['kwargs'].items(): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_access_token_expiration" % key - ) - params[key] = val - del params['kwargs'] - - collection_formats = {} - - path_params = {} - - query_params = [] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - - # Authentication setting - auth_settings = ['tokenAuth'] - - return self.api_client.call_api('/access/token/expiration', 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='AccessTokenExpirationEntity', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only'), - _preload_content=params.get('_preload_content', True), - _request_timeout=params.get('_request_timeout'), - collection_formats=collection_formats) - def get_login_config(self, **kwargs): - """ - Retrieves the access configuration for this NiFi + This method makes a synchronous HTTP request and returns the response data directly. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_login_config(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :return: AccessConfigurationEntity - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_login_config_with_http_info(**kwargs) - else: - (data) = self.get_login_config_with_http_info(**kwargs) - return data - - def get_login_config_with_http_info(self, **kwargs): - """ - Retrieves the access configuration for this NiFi + For full HTTP response details (status code, headers, etc.), use the corresponding + ``log_out_with_http_info()`` method instead. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_login_config_with_http_info(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :return: AccessConfigurationEntity - If the method is called asynchronously, - returns the request thread. - """ - - all_params = [] - all_params.append('callback') - all_params.append('_return_http_data_only') - all_params.append('_preload_content') - all_params.append('_request_timeout') - - params = locals() - for key, val in params['kwargs'].items(): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_login_config" % key - ) - params[key] = val - del params['kwargs'] - - collection_formats = {} - - path_params = {} - - query_params = [] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['*/*']) - - # Authentication setting - auth_settings = ['tokenAuth'] - - return self.api_client.call_api('/access/config', 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='AccessConfigurationEntity', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only'), - _preload_content=params.get('_preload_content', True), - _request_timeout=params.get('_request_timeout'), - collection_formats=collection_formats) - - def knox_callback(self, **kwargs): - """ - Redirect/callback URI for processing the result of the Apache Knox login sequence. - Note: This endpoint is subject to change as NiFi and it's REST API evolve. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.knox_callback(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :return: None - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.knox_callback_with_http_info(**kwargs) - else: - (data) = self.knox_callback_with_http_info(**kwargs) - return data - - def knox_callback_with_http_info(self, **kwargs): - """ - Redirect/callback URI for processing the result of the Apache Knox login sequence. - Note: This endpoint is subject to change as NiFi and it's REST API evolve. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.knox_callback_with_http_info(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :return: None - If the method is called asynchronously, - returns the request thread. - """ - - all_params = [] - all_params.append('callback') - all_params.append('_return_http_data_only') - all_params.append('_preload_content') - all_params.append('_request_timeout') - - params = locals() - for key, val in params['kwargs'].items(): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method knox_callback" % key - ) - params[key] = val - del params['kwargs'] - - collection_formats = {} - - path_params = {} - - query_params = [] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['*/*']) - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['*/*']) - - # Authentication setting - auth_settings = ['tokenAuth'] - - return self.api_client.call_api('/access/knox/callback', 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type=None, - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only'), - _preload_content=params.get('_preload_content', True), - _request_timeout=params.get('_request_timeout'), - collection_formats=collection_formats) - - def knox_logout(self, **kwargs): - """ - Performs a logout in the Apache Knox. - Note: This endpoint is subject to change as NiFi and it's REST API evolve. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.knox_logout(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :return: None - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.knox_logout_with_http_info(**kwargs) - else: - (data) = self.knox_logout_with_http_info(**kwargs) - return data - - def knox_logout_with_http_info(self, **kwargs): - """ - Performs a logout in the Apache Knox. - Note: This endpoint is subject to change as NiFi and it's REST API evolve. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.knox_logout_with_http_info(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :return: None - If the method is called asynchronously, - returns the request thread. - """ - - all_params = [] - all_params.append('callback') - all_params.append('_return_http_data_only') - all_params.append('_preload_content') - all_params.append('_request_timeout') - - params = locals() - for key, val in params['kwargs'].items(): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method knox_logout" % key - ) - params[key] = val - del params['kwargs'] - - collection_formats = {} - - path_params = {} - - query_params = [] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['*/*']) - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['*/*']) - - # Authentication setting - auth_settings = ['tokenAuth'] - - return self.api_client.call_api('/access/knox/logout', 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type=None, - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only'), - _preload_content=params.get('_preload_content', True), - _request_timeout=params.get('_request_timeout'), - collection_formats=collection_formats) - - def knox_request(self, **kwargs): - """ - Initiates a request to authenticate through Apache Knox. - Note: This endpoint is subject to change as NiFi and it's REST API evolve. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.knox_request(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :return: None - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.knox_request_with_http_info(**kwargs) - else: - (data) = self.knox_request_with_http_info(**kwargs) - return data - - def knox_request_with_http_info(self, **kwargs): - """ - Initiates a request to authenticate through Apache Knox. - Note: This endpoint is subject to change as NiFi and it's REST API evolve. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.knox_request_with_http_info(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :return: None - If the method is called asynchronously, - returns the request thread. - """ - - all_params = [] - all_params.append('callback') - all_params.append('_return_http_data_only') - all_params.append('_preload_content') - all_params.append('_request_timeout') - - params = locals() - for key, val in params['kwargs'].items(): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method knox_request" % key - ) - params[key] = val - del params['kwargs'] - - collection_formats = {} - - path_params = {} - - query_params = [] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['*/*']) - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['*/*']) - - # Authentication setting - auth_settings = ['tokenAuth'] - - return self.api_client.call_api('/access/knox/request', 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type=None, - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only'), - _preload_content=params.get('_preload_content', True), - _request_timeout=params.get('_request_timeout'), - collection_formats=collection_formats) - - def log_out(self, **kwargs): - """ - Performs a logout for other providers that have been issued a JWT. - Note: This endpoint is subject to change as NiFi and it's REST API evolve. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.log_out(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :return: None - If the method is called asynchronously, - returns the request thread. + Args: + + Returns: + None """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): @@ -849,25 +159,22 @@ def log_out(self, **kwargs): def log_out_with_http_info(self, **kwargs): """ - Performs a logout for other providers that have been issued a JWT. + Performs a logout for other providers that have been issued a JWT.. + Note: This endpoint is subject to change as NiFi and it's REST API evolve. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.log_out_with_http_info(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :return: None - If the method is called asynchronously, - returns the request thread. + + 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 ``log_out()`` method instead. + + Args: + + Returns: + tuple: (None, status_code, headers) - Response data with HTTP details. """ all_params = [] - all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -894,16 +201,8 @@ def log_out_with_http_info(self, **kwargs): local_var_files = {} body_params = None - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['*/*']) - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['*/*']) - # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/access/logout', 'DELETE', path_params, @@ -914,7 +213,6 @@ def log_out_with_http_info(self, **kwargs): files=local_var_files, response_type=None, auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), @@ -922,21 +220,19 @@ def log_out_with_http_info(self, **kwargs): def log_out_complete(self, **kwargs): """ - Completes the logout sequence by removing the cached Logout Request and Cookie if they existed and redirects to /nifi/login. + Completes the logout sequence by removing the cached Logout Request and Cookie if they existed and redirects to /nifi/login.. + Note: This endpoint is subject to change as NiFi and it's REST API evolve. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.log_out_complete(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :return: None - If the method is called asynchronously, - returns the request thread. + + 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 + ``log_out_complete_with_http_info()`` method instead. + + Args: + + Returns: + None """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): @@ -947,25 +243,22 @@ def log_out_complete(self, **kwargs): def log_out_complete_with_http_info(self, **kwargs): """ - Completes the logout sequence by removing the cached Logout Request and Cookie if they existed and redirects to /nifi/login. + Completes the logout sequence by removing the cached Logout Request and Cookie if they existed and redirects to /nifi/login.. + Note: This endpoint is subject to change as NiFi and it's REST API evolve. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.log_out_complete_with_http_info(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :return: None - If the method is called asynchronously, - returns the request thread. + + 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 ``log_out_complete()`` method instead. + + Args: + + Returns: + tuple: (None, status_code, headers) - Response data with HTTP details. """ all_params = [] - all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -992,16 +285,8 @@ def log_out_complete_with_http_info(self, **kwargs): local_var_files = {} body_params = None - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['*/*']) - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['*/*']) - # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/access/logout/complete', 'GET', path_params, @@ -1012,7 +297,6 @@ def log_out_complete_with_http_info(self, **kwargs): files=local_var_files, response_type=None, auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), diff --git a/nipyapi/nifi/apis/authentication_api.py b/nipyapi/nifi/apis/authentication_api.py new file mode 100644 index 00000000..77c0b442 --- /dev/null +++ b/nipyapi/nifi/apis/authentication_api.py @@ -0,0 +1,115 @@ +""" + Apache NiFi REST API + + REST API definition for Apache NiFi web services + + OpenAPI spec version: 2.5.0 + Contact: dev@nifi.apache.org + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import sys +import os +import re + +from ..configuration import Configuration +from ..api_client import ApiClient + + +class AuthenticationApi(object): + """ + NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. + Ref: https://github.com/swagger-api/swagger-codegen + """ + + def __init__(self, api_client=None): + config = Configuration() + if api_client: + self.api_client = api_client + else: + if not config.api_client: + config.api_client = ApiClient() + self.api_client = config.api_client + + def get_authentication_configuration(self, **kwargs): + """ + Retrieves the authentication configuration endpoint and status information. + 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_authentication_configuration_with_http_info()`` method instead. + + Args: + + Returns: + :class:`~nipyapi.nifi.models.AuthenticationConfigurationEntity`: The response data. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('callback'): + return self.get_authentication_configuration_with_http_info(**kwargs) + else: + (data) = self.get_authentication_configuration_with_http_info(**kwargs) + return data + + def get_authentication_configuration_with_http_info(self, **kwargs): + """ + Retrieves the authentication configuration endpoint and status information. + 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_authentication_configuration()`` method instead. + + Args: + + Returns: + tuple: (:class:`~nipyapi.nifi.models.AuthenticationConfigurationEntity`, status_code, headers) - Response data with HTTP details. + """ + + all_params = [] + 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_authentication_configuration" % key + ) + params[key] = val + del params['kwargs'] + + collection_formats = {} + + path_params = {} + + query_params = [] + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.\ + select_header_accept(['application/json']) + + # Authentication setting + auth_settings = ['bearerAuth'] + + return self.api_client.call_api('/authentication/configuration', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='AuthenticationConfigurationEntity', + 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) diff --git a/nipyapi/nifi/apis/connections_api.py b/nipyapi/nifi/apis/connections_api.py index fb5a92b3..c9c6b6f8 100644 --- a/nipyapi/nifi/apis/connections_api.py +++ b/nipyapi/nifi/apis/connections_api.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - import sys import os import re @@ -35,25 +34,24 @@ def __init__(self, api_client=None): def delete_connection(self, id, **kwargs): """ - Deletes a connection + Deletes a connection. + 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_connection_with_http_info()`` method instead. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.delete_connection(id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The connection id. (required) - :param str version: The revision is used to verify the client is working with the latest version of the flow. - :param str client_id: If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response. - :param bool disconnected_node_acknowledged: Acknowledges that this node is disconnected to allow for mutable requests to proceed. - :return: ConnectionEntity - If the method is called asynchronously, - returns the request thread. + Args: + id (str): + The connection 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.ConnectionEntity`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): @@ -64,29 +62,27 @@ def delete_connection(self, id, **kwargs): def delete_connection_with_http_info(self, id, **kwargs): """ - Deletes a connection + Deletes a connection. + 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_connection()`` method instead. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.delete_connection_with_http_info(id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The connection id. (required) - :param str version: The revision is used to verify the client is working with the latest version of the flow. - :param str client_id: If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response. - :param bool disconnected_node_acknowledged: Acknowledges that this node is disconnected to allow for mutable requests to proceed. - :return: ConnectionEntity - If the method is called asynchronously, - returns the request thread. + Args: + id (str): + The connection 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.ConnectionEntity`, status_code, headers) - Response data with HTTP details. """ all_params = ['id', 'version', 'client_id', 'disconnected_node_acknowledged'] - all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -104,7 +100,10 @@ def delete_connection_with_http_info(self, id, **kwargs): if ('id' not in params) or (params['id'] is None): raise ValueError("Missing the required parameter `id` when calling `delete_connection`") - + + + + collection_formats = {} path_params = {} @@ -129,12 +128,8 @@ def delete_connection_with_http_info(self, id, **kwargs): header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['*/*']) - # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/connections/{id}', 'DELETE', path_params, @@ -145,7 +140,6 @@ def delete_connection_with_http_info(self, id, **kwargs): files=local_var_files, response_type='ConnectionEntity', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), @@ -153,22 +147,18 @@ def delete_connection_with_http_info(self, id, **kwargs): def get_connection(self, id, **kwargs): """ - Gets a connection + Gets a connection. + 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_connection_with_http_info()`` method instead. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_connection(id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The connection id. (required) - :return: ConnectionEntity - If the method is called asynchronously, - returns the request thread. + Args: + id (str): + The connection id. (required) + + Returns: + :class:`~nipyapi.nifi.models.ConnectionEntity`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): @@ -179,26 +169,21 @@ def get_connection(self, id, **kwargs): def get_connection_with_http_info(self, id, **kwargs): """ - Gets a connection + Gets a connection. + 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_connection()`` method instead. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_connection_with_http_info(id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The connection id. (required) - :return: ConnectionEntity - If the method is called asynchronously, - returns the request thread. + Args: + id (str): + The connection id. (required) + + Returns: + tuple: (:class:`~nipyapi.nifi.models.ConnectionEntity`, status_code, headers) - Response data with HTTP details. """ all_params = ['id'] - all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -216,7 +201,7 @@ def get_connection_with_http_info(self, id, **kwargs): if ('id' not in params) or (params['id'] is None): raise ValueError("Missing the required parameter `id` when calling `get_connection`") - + collection_formats = {} path_params = {} @@ -235,12 +220,8 @@ def get_connection_with_http_info(self, id, **kwargs): header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['*/*']) - # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/connections/{id}', 'GET', path_params, @@ -251,62 +232,54 @@ def get_connection_with_http_info(self, id, **kwargs): files=local_var_files, response_type='ConnectionEntity', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def update_connection(self, id, body, **kwargs): + def update_connection(self, body, id, **kwargs): """ - Updates a connection + Updates a connection. + 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 + ``update_connection_with_http_info()`` method instead. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.update_connection(id, body, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The connection id. (required) - :param ConnectionEntity body: The connection configuration details. (required) - :return: ConnectionEntity - If the method is called asynchronously, - returns the request thread. + Args: + body (:class:`~nipyapi.nifi.models.ConnectionEntity`): + The connection configuration details. (required) + id (str): + The connection id. (required) + + Returns: + :class:`~nipyapi.nifi.models.ConnectionEntity`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.update_connection_with_http_info(id, body, **kwargs) + return self.update_connection_with_http_info(body, id, **kwargs) else: - (data) = self.update_connection_with_http_info(id, body, **kwargs) + (data) = self.update_connection_with_http_info(body, id, **kwargs) return data - def update_connection_with_http_info(self, id, body, **kwargs): + def update_connection_with_http_info(self, body, id, **kwargs): """ - Updates a connection + Updates a connection. + This method makes a synchronous HTTP request and returns detailed response information. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.update_connection_with_http_info(id, body, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The connection id. (required) - :param ConnectionEntity body: The connection configuration details. (required) - :return: ConnectionEntity - If the method is called asynchronously, - returns the request thread. + Returns the response data along with HTTP status code, headers, and other metadata. + For just the response data, use the corresponding ``update_connection()`` method instead. + + Args: + body (:class:`~nipyapi.nifi.models.ConnectionEntity`): + The connection configuration details. (required) + id (str): + The connection id. (required) + + Returns: + tuple: (:class:`~nipyapi.nifi.models.ConnectionEntity`, status_code, headers) - Response data with HTTP details. """ - all_params = ['id', 'body'] - all_params.append('callback') + all_params = ['body', 'id'] all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -320,14 +293,15 @@ def update_connection_with_http_info(self, id, body, **kwargs): ) params[key] = val del params['kwargs'] - # verify the required parameter 'id' is set - if ('id' not in params) or (params['id'] is None): - raise ValueError("Missing the required parameter `id` when calling `update_connection`") # verify the required parameter 'body' is set if ('body' not in params) or (params['body'] is None): raise ValueError("Missing the required parameter `body` when calling `update_connection`") + # verify the required parameter 'id' is set + if ('id' not in params) or (params['id'] is None): + raise ValueError("Missing the required parameter `id` when calling `update_connection`") - + + collection_formats = {} path_params = {} @@ -353,7 +327,7 @@ def update_connection_with_http_info(self, id, body, **kwargs): select_header_content_type(['application/json']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/connections/{id}', 'PUT', path_params, @@ -364,7 +338,6 @@ def update_connection_with_http_info(self, id, body, **kwargs): files=local_var_files, response_type='ConnectionEntity', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), diff --git a/nipyapi/nifi/apis/controller_api.py b/nipyapi/nifi/apis/controller_api.py index 09aab8ad..f5f005d8 100644 --- a/nipyapi/nifi/apis/controller_api.py +++ b/nipyapi/nifi/apis/controller_api.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - import sys import os import re @@ -33,54 +32,49 @@ def __init__(self, api_client=None): config.api_client = ApiClient() self.api_client = config.api_client - def create_bulletin(self, body, **kwargs): + def analyze_flow_analysis_rule_configuration(self, body, id, **kwargs): """ - Creates a new bulletin + Performs analysis of the component's configuration, providing information about which attributes are referenced.. + This method makes a synchronous HTTP request and returns the response data directly. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.create_bulletin(body, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param BulletinEntity body: The reporting task configuration details. (required) - :return: BulletinEntity - If the method is called asynchronously, - returns the request thread. + For full HTTP response details (status code, headers, etc.), use the corresponding + ``analyze_flow_analysis_rule_configuration_with_http_info()`` method instead. + + Args: + body (:class:`~nipyapi.nifi.models.ConfigurationAnalysisEntity`): + The configuration analysis request. (required) + id (str): + The flow analysis rules id. (required) + + Returns: + :class:`~nipyapi.nifi.models.ConfigurationAnalysisEntity`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.create_bulletin_with_http_info(body, **kwargs) + return self.analyze_flow_analysis_rule_configuration_with_http_info(body, id, **kwargs) else: - (data) = self.create_bulletin_with_http_info(body, **kwargs) + (data) = self.analyze_flow_analysis_rule_configuration_with_http_info(body, id, **kwargs) return data - def create_bulletin_with_http_info(self, body, **kwargs): + def analyze_flow_analysis_rule_configuration_with_http_info(self, body, id, **kwargs): """ - Creates a new bulletin + Performs analysis of the component's configuration, providing information about which attributes are referenced.. + This method makes a synchronous HTTP request and returns detailed response information. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.create_bulletin_with_http_info(body, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param BulletinEntity body: The reporting task configuration details. (required) - :return: BulletinEntity - If the method is called asynchronously, - returns the request thread. + Returns the response data along with HTTP status code, headers, and other metadata. + For just the response data, use the corresponding ``analyze_flow_analysis_rule_configuration()`` method instead. + + Args: + body (:class:`~nipyapi.nifi.models.ConfigurationAnalysisEntity`): + The configuration analysis request. (required) + id (str): + The flow analysis rules id. (required) + + Returns: + tuple: (:class:`~nipyapi.nifi.models.ConfigurationAnalysisEntity`, status_code, headers) - Response data with HTTP details. """ - all_params = ['body'] - all_params.append('callback') + all_params = ['body', 'id'] all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -90,18 +84,24 @@ def create_bulletin_with_http_info(self, body, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method create_bulletin" % key + " to method analyze_flow_analysis_rule_configuration" % 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_bulletin`") - + raise ValueError("Missing the required parameter `body` when calling `analyze_flow_analysis_rule_configuration`") + # 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 `analyze_flow_analysis_rule_configuration`") + + collection_formats = {} path_params = {} + if 'id' in params: + path_params['id'] = params['id'] query_params = [] @@ -122,71 +122,61 @@ def create_bulletin_with_http_info(self, body, **kwargs): select_header_content_type(['application/json']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] - return self.api_client.call_api('/controller/bulletin', 'POST', + return self.api_client.call_api('/controller/flow-analysis-rules/{id}/config/analysis', 'POST', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, - response_type='BulletinEntity', + response_type='ConfigurationAnalysisEntity', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def create_controller_service(self, body, **kwargs): + def clear_state(self, id, **kwargs): """ - Creates a new controller service + Clears the state for a flow analysis rule. + This method makes a synchronous HTTP request and returns the response data directly. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.create_controller_service(body, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param ControllerServiceEntity body: The controller service configuration details. (required) - :return: ControllerServiceEntity - If the method is called asynchronously, - returns the request thread. + For full HTTP response details (status code, headers, etc.), use the corresponding + ``clear_state_with_http_info()`` method instead. + + Args: + id (str): + The flow analysis rule id. (required) + + Returns: + :class:`~nipyapi.nifi.models.ComponentStateEntity`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.create_controller_service_with_http_info(body, **kwargs) + return self.clear_state_with_http_info(id, **kwargs) else: - (data) = self.create_controller_service_with_http_info(body, **kwargs) + (data) = self.clear_state_with_http_info(id, **kwargs) return data - def create_controller_service_with_http_info(self, body, **kwargs): + def clear_state_with_http_info(self, id, **kwargs): """ - Creates a new controller service + Clears the state for a flow analysis rule. + This method makes a synchronous HTTP request and returns detailed response information. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.create_controller_service_with_http_info(body, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param ControllerServiceEntity body: The controller service configuration details. (required) - :return: ControllerServiceEntity - If the method is called asynchronously, - returns the request thread. + Returns the response data along with HTTP status code, headers, and other metadata. + For just the response data, use the corresponding ``clear_state()`` method instead. + + Args: + id (str): + The flow analysis rule id. (required) + + Returns: + tuple: (:class:`~nipyapi.nifi.models.ComponentStateEntity`, status_code, headers) - Response data with HTTP details. """ - all_params = ['body'] - all_params.append('callback') + all_params = ['id'] all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -196,18 +186,20 @@ def create_controller_service_with_http_info(self, body, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method create_controller_service" % key + " to method clear_state" % 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_controller_service`") - + # 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 `clear_state`") + collection_formats = {} path_params = {} + if 'id' in params: + path_params['id'] = params['id'] query_params = [] @@ -217,82 +209,66 @@ def create_controller_service_with_http_info(self, body, **kwargs): local_var_files = {} body_params = None - if 'body' in params: - body_params = params['body'] # HTTP header `Accept` header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['application/json']) - # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] - return self.api_client.call_api('/controller/controller-services', 'POST', + return self.api_client.call_api('/controller/flow-analysis-rules/{id}/state/clear-requests', 'POST', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, - response_type='ControllerServiceEntity', + response_type='ComponentStateEntity', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def create_flow_registry_client(self, body, **kwargs): + def create_bulletin(self, body, **kwargs): """ - Creates a new flow registry client + Creates a new bulletin. + This method makes a synchronous HTTP request and returns the response data directly. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.create_flow_registry_client(body, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param FlowRegistryClientEntity body: The flow registry client configuration details. (required) - :return: FlowRegistryClientEntity - If the method is called asynchronously, - returns the request thread. + For full HTTP response details (status code, headers, etc.), use the corresponding + ``create_bulletin_with_http_info()`` method instead. + + Args: + body (:class:`~nipyapi.nifi.models.BulletinEntity`): + The reporting task configuration details. (required) + + Returns: + :class:`~nipyapi.nifi.models.BulletinEntity`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.create_flow_registry_client_with_http_info(body, **kwargs) + return self.create_bulletin_with_http_info(body, **kwargs) else: - (data) = self.create_flow_registry_client_with_http_info(body, **kwargs) + (data) = self.create_bulletin_with_http_info(body, **kwargs) return data - def create_flow_registry_client_with_http_info(self, body, **kwargs): + def create_bulletin_with_http_info(self, body, **kwargs): """ - Creates a new flow registry client + Creates a new bulletin. + This method makes a synchronous HTTP request and returns detailed response information. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.create_flow_registry_client_with_http_info(body, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param FlowRegistryClientEntity body: The flow registry client configuration details. (required) - :return: FlowRegistryClientEntity - If the method is called asynchronously, - returns the request thread. + Returns the response data along with HTTP status code, headers, and other metadata. + For just the response data, use the corresponding ``create_bulletin()`` method instead. + + Args: + body (:class:`~nipyapi.nifi.models.BulletinEntity`): + The reporting task configuration details. (required) + + Returns: + tuple: (:class:`~nipyapi.nifi.models.BulletinEntity`, status_code, headers) - Response data with HTTP details. """ all_params = ['body'] - all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -302,15 +278,15 @@ def create_flow_registry_client_with_http_info(self, body, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method create_flow_registry_client" % key + " to method create_bulletin" % 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_flow_registry_client`") - + raise ValueError("Missing the required parameter `body` when calling `create_bulletin`") + collection_formats = {} path_params = {} @@ -334,71 +310,61 @@ def create_flow_registry_client_with_http_info(self, body, **kwargs): select_header_content_type(['application/json']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] - return self.api_client.call_api('/controller/registry-clients', 'POST', + return self.api_client.call_api('/controller/bulletin', 'POST', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, - response_type='FlowRegistryClientEntity', + response_type='BulletinEntity', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def create_parameter_provider(self, body, **kwargs): + def create_controller_service(self, body, **kwargs): """ - Creates a new parameter provider + Creates a new controller service. + This method makes a synchronous HTTP request and returns the response data directly. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.create_parameter_provider(body, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param ParameterProviderEntity body: The parameter provider configuration details. (required) - :return: ParameterProviderEntity - If the method is called asynchronously, - returns the request thread. + For full HTTP response details (status code, headers, etc.), use the corresponding + ``create_controller_service_with_http_info()`` method instead. + + Args: + body (:class:`~nipyapi.nifi.models.ControllerServiceEntity`): + The controller service configuration details. (required) + + Returns: + :class:`~nipyapi.nifi.models.ControllerServiceEntity`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.create_parameter_provider_with_http_info(body, **kwargs) + return self.create_controller_service_with_http_info(body, **kwargs) else: - (data) = self.create_parameter_provider_with_http_info(body, **kwargs) + (data) = self.create_controller_service_with_http_info(body, **kwargs) return data - def create_parameter_provider_with_http_info(self, body, **kwargs): + def create_controller_service_with_http_info(self, body, **kwargs): """ - Creates a new parameter provider + Creates a new controller service. + This method makes a synchronous HTTP request and returns detailed response information. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.create_parameter_provider_with_http_info(body, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param ParameterProviderEntity body: The parameter provider configuration details. (required) - :return: ParameterProviderEntity - If the method is called asynchronously, - returns the request thread. + Returns the response data along with HTTP status code, headers, and other metadata. + For just the response data, use the corresponding ``create_controller_service()`` method instead. + + Args: + body (:class:`~nipyapi.nifi.models.ControllerServiceEntity`): + The controller service configuration details. (required) + + Returns: + tuple: (:class:`~nipyapi.nifi.models.ControllerServiceEntity`, status_code, headers) - Response data with HTTP details. """ all_params = ['body'] - all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -408,15 +374,15 @@ def create_parameter_provider_with_http_info(self, body, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method create_parameter_provider" % key + " to method create_controller_service" % key ) params[key] = val del params['kwargs'] # verify the required parameter 'body' is set if ('body' not in params) or (params['body'] is None): - raise ValueError("Missing the required parameter `body` when calling `create_parameter_provider`") - + raise ValueError("Missing the required parameter `body` when calling `create_controller_service`") + collection_formats = {} path_params = {} @@ -440,71 +406,61 @@ def create_parameter_provider_with_http_info(self, body, **kwargs): select_header_content_type(['application/json']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] - return self.api_client.call_api('/controller/parameter-providers', 'POST', + return self.api_client.call_api('/controller/controller-services', 'POST', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, - response_type='ParameterProviderEntity', + response_type='ControllerServiceEntity', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def create_reporting_task(self, body, **kwargs): + def create_flow_analysis_rule(self, body, **kwargs): """ - Creates a new reporting task + Creates a new flow analysis rule. + This method makes a synchronous HTTP request and returns the response data directly. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.create_reporting_task(body, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param ReportingTaskEntity body: The reporting task configuration details. (required) - :return: ReportingTaskEntity - If the method is called asynchronously, - returns the request thread. + For full HTTP response details (status code, headers, etc.), use the corresponding + ``create_flow_analysis_rule_with_http_info()`` method instead. + + Args: + body (:class:`~nipyapi.nifi.models.FlowAnalysisRuleEntity`): + The flow analysis rule configuration details. (required) + + Returns: + :class:`~nipyapi.nifi.models.FlowAnalysisRuleEntity`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.create_reporting_task_with_http_info(body, **kwargs) + return self.create_flow_analysis_rule_with_http_info(body, **kwargs) else: - (data) = self.create_reporting_task_with_http_info(body, **kwargs) + (data) = self.create_flow_analysis_rule_with_http_info(body, **kwargs) return data - def create_reporting_task_with_http_info(self, body, **kwargs): + def create_flow_analysis_rule_with_http_info(self, body, **kwargs): """ - Creates a new reporting task + Creates a new flow analysis rule. + This method makes a synchronous HTTP request and returns detailed response information. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.create_reporting_task_with_http_info(body, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param ReportingTaskEntity body: The reporting task configuration details. (required) - :return: ReportingTaskEntity - If the method is called asynchronously, - returns the request thread. + Returns the response data along with HTTP status code, headers, and other metadata. + For just the response data, use the corresponding ``create_flow_analysis_rule()`` method instead. + + Args: + body (:class:`~nipyapi.nifi.models.FlowAnalysisRuleEntity`): + The flow analysis rule configuration details. (required) + + Returns: + tuple: (:class:`~nipyapi.nifi.models.FlowAnalysisRuleEntity`, status_code, headers) - Response data with HTTP details. """ all_params = ['body'] - all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -514,15 +470,15 @@ def create_reporting_task_with_http_info(self, body, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method create_reporting_task" % key + " to method create_flow_analysis_rule" % 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_reporting_task`") - + raise ValueError("Missing the required parameter `body` when calling `create_flow_analysis_rule`") + collection_formats = {} path_params = {} @@ -546,77 +502,61 @@ def create_reporting_task_with_http_info(self, body, **kwargs): select_header_content_type(['application/json']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] - return self.api_client.call_api('/controller/reporting-tasks', 'POST', + return self.api_client.call_api('/controller/flow-analysis-rules', 'POST', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, - response_type='ReportingTaskEntity', + response_type='FlowAnalysisRuleEntity', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def delete_flow_registry_client(self, id, **kwargs): + def create_flow_registry_client(self, body, **kwargs): """ - Deletes a flow registry client - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.delete_flow_registry_client(id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The flow registry client id. (required) - :param str version: The revision is used to verify the client is working with the latest version of the flow. - :param str client_id: If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response. - :param bool disconnected_node_acknowledged: Acknowledges that this node is disconnected to allow for mutable requests to proceed. - :return: FlowRegistryClientEntity - If the method is called asynchronously, - returns the request thread. + Creates a new flow registry client. + 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_flow_registry_client_with_http_info()`` method instead. + + Args: + body (:class:`~nipyapi.nifi.models.FlowRegistryClientEntity`): + The flow registry client configuration details. (required) + + Returns: + :class:`~nipyapi.nifi.models.FlowRegistryClientEntity`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.delete_flow_registry_client_with_http_info(id, **kwargs) + return self.create_flow_registry_client_with_http_info(body, **kwargs) else: - (data) = self.delete_flow_registry_client_with_http_info(id, **kwargs) + (data) = self.create_flow_registry_client_with_http_info(body, **kwargs) return data - def delete_flow_registry_client_with_http_info(self, id, **kwargs): + def create_flow_registry_client_with_http_info(self, body, **kwargs): """ - Deletes a flow registry client + Creates a new flow registry client. + This method makes a synchronous HTTP request and returns detailed response information. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.delete_flow_registry_client_with_http_info(id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The flow registry client id. (required) - :param str version: The revision is used to verify the client is working with the latest version of the flow. - :param str client_id: If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response. - :param bool disconnected_node_acknowledged: Acknowledges that this node is disconnected to allow for mutable requests to proceed. - :return: FlowRegistryClientEntity - If the method is called asynchronously, - returns the request thread. + Returns the response data along with HTTP status code, headers, and other metadata. + For just the response data, use the corresponding ``create_flow_registry_client()`` method instead. + + Args: + body (:class:`~nipyapi.nifi.models.FlowRegistryClientEntity`): + The flow registry client configuration details. (required) + + Returns: + tuple: (:class:`~nipyapi.nifi.models.FlowRegistryClientEntity`, status_code, headers) - Response data with HTTP details. """ - all_params = ['id', 'version', 'client_id', 'disconnected_node_acknowledged'] - all_params.append('callback') + all_params = ['body'] all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -626,28 +566,20 @@ def delete_flow_registry_client_with_http_info(self, id, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method delete_flow_registry_client" % key + " to method create_flow_registry_client" % 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_flow_registry_client`") - + # 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_flow_registry_client`") + 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 = {} @@ -655,18 +587,20 @@ def delete_flow_registry_client_with_http_info(self, id, **kwargs): 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(['*/*']) + select_header_content_type(['application/json']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] - return self.api_client.call_api('/controller/registry-clients/{id}', 'DELETE', + return self.api_client.call_api('/controller/registry-clients', 'POST', path_params, query_params, header_params, @@ -675,60 +609,50 @@ def delete_flow_registry_client_with_http_info(self, id, **kwargs): files=local_var_files, response_type='FlowRegistryClientEntity', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def delete_history(self, end_date, **kwargs): + def create_parameter_provider(self, body, **kwargs): """ - Purges history + Creates a new parameter provider. + This method makes a synchronous HTTP request and returns the response data directly. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.delete_history(end_date, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str end_date: Purge actions before this date/time. (required) - :return: HistoryEntity - If the method is called asynchronously, - returns the request thread. + For full HTTP response details (status code, headers, etc.), use the corresponding + ``create_parameter_provider_with_http_info()`` method instead. + + Args: + body (:class:`~nipyapi.nifi.models.ParameterProviderEntity`): + The parameter provider configuration details. (required) + + Returns: + :class:`~nipyapi.nifi.models.ParameterProviderEntity`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.delete_history_with_http_info(end_date, **kwargs) + return self.create_parameter_provider_with_http_info(body, **kwargs) else: - (data) = self.delete_history_with_http_info(end_date, **kwargs) + (data) = self.create_parameter_provider_with_http_info(body, **kwargs) return data - def delete_history_with_http_info(self, end_date, **kwargs): + def create_parameter_provider_with_http_info(self, body, **kwargs): """ - Purges history + Creates a new parameter provider. + This method makes a synchronous HTTP request and returns detailed response information. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.delete_history_with_http_info(end_date, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str end_date: Purge actions before this date/time. (required) - :return: HistoryEntity - If the method is called asynchronously, - returns the request thread. + Returns the response data along with HTTP status code, headers, and other metadata. + For just the response data, use the corresponding ``create_parameter_provider()`` method instead. + + Args: + body (:class:`~nipyapi.nifi.models.ParameterProviderEntity`): + The parameter provider configuration details. (required) + + Returns: + tuple: (:class:`~nipyapi.nifi.models.ParameterProviderEntity`, status_code, headers) - Response data with HTTP details. """ - all_params = ['end_date'] - all_params.append('callback') + all_params = ['body'] all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -738,22 +662,20 @@ def delete_history_with_http_info(self, end_date, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method delete_history" % key + " to method create_parameter_provider" % key ) params[key] = val del params['kwargs'] - # verify the required parameter 'end_date' is set - if ('end_date' not in params) or (params['end_date'] is None): - raise ValueError("Missing the required parameter `end_date` when calling `delete_history`") - + # verify the required parameter 'body' is set + if ('body' not in params) or (params['body'] is None): + raise ValueError("Missing the required parameter `body` when calling `create_parameter_provider`") + collection_formats = {} path_params = {} query_params = [] - if 'end_date' in params: - query_params.append(('endDate', params['end_date'])) header_params = {} @@ -761,80 +683,72 @@ def delete_history_with_http_info(self, end_date, **kwargs): 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(['*/*']) + select_header_content_type(['application/json']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] - return self.api_client.call_api('/controller/history', 'DELETE', + return self.api_client.call_api('/controller/parameter-providers', 'POST', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, - response_type='HistoryEntity', + response_type='ParameterProviderEntity', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def delete_node(self, id, **kwargs): + def create_reporting_task(self, body, **kwargs): """ - Removes a node from the cluster + Creates a new reporting task. + This method makes a synchronous HTTP request and returns the response data directly. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.delete_node(id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The node id. (required) - :return: NodeEntity - If the method is called asynchronously, - returns the request thread. + For full HTTP response details (status code, headers, etc.), use the corresponding + ``create_reporting_task_with_http_info()`` method instead. + + Args: + body (:class:`~nipyapi.nifi.models.ReportingTaskEntity`): + The reporting task configuration details. (required) + + Returns: + :class:`~nipyapi.nifi.models.ReportingTaskEntity`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.delete_node_with_http_info(id, **kwargs) + return self.create_reporting_task_with_http_info(body, **kwargs) else: - (data) = self.delete_node_with_http_info(id, **kwargs) + (data) = self.create_reporting_task_with_http_info(body, **kwargs) return data - def delete_node_with_http_info(self, id, **kwargs): + def create_reporting_task_with_http_info(self, body, **kwargs): """ - Removes a node from the cluster + Creates a new reporting task. + This method makes a synchronous HTTP request and returns detailed response information. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.delete_node_with_http_info(id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The node id. (required) - :return: NodeEntity - If the method is called asynchronously, - returns the request thread. + Returns the response data along with HTTP status code, headers, and other metadata. + For just the response data, use the corresponding ``create_reporting_task()`` method instead. + + Args: + body (:class:`~nipyapi.nifi.models.ReportingTaskEntity`): + The reporting task configuration details. (required) + + Returns: + tuple: (:class:`~nipyapi.nifi.models.ReportingTaskEntity`, status_code, headers) - Response data with HTTP details. """ - all_params = ['id'] - all_params.append('callback') + all_params = ['body'] all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -844,20 +758,18 @@ def delete_node_with_http_info(self, id, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method delete_node" % key + " to method create_reporting_task" % 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_node`") - + # 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_reporting_task`") + collection_formats = {} path_params = {} - if 'id' in params: - path_params['id'] = params['id'] query_params = [] @@ -867,78 +779,82 @@ def delete_node_with_http_info(self, id, **kwargs): 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(['*/*']) + select_header_content_type(['application/json']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] - return self.api_client.call_api('/controller/cluster/nodes/{id}', 'DELETE', + return self.api_client.call_api('/controller/reporting-tasks', 'POST', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, - response_type='NodeEntity', + response_type='ReportingTaskEntity', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def get_cluster(self, **kwargs): + def delete_flow_analysis_rule_verification_request(self, id, request_id, **kwargs): """ - Gets the contents of the cluster - Returns the contents of the cluster including all nodes and their status. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_cluster(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :return: ClusterEntity - If the method is called asynchronously, - returns the request thread. + Deletes the Verification Request with the given ID. + + Deletes the Verification Request with the given ID. After a request is created, it is expected that the client will properly clean up the request by DELETE'ing it, once the Verification process has completed. If the request is deleted before the request completes, then the Verification request will finish the step that it is currently performing and then will cancel any subsequent steps. + + This method makes a synchronous HTTP request and returns the response data directly. + + For full HTTP response details (status code, headers, etc.), use the corresponding + ``delete_flow_analysis_rule_verification_request_with_http_info()`` method instead. + + Args: + id (str): + The ID of the Flow Analysis Rule (required) + request_id (str): + The ID of the Verification Request (required) + + Returns: + :class:`~nipyapi.nifi.models.VerifyConfigRequestEntity`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.get_cluster_with_http_info(**kwargs) + return self.delete_flow_analysis_rule_verification_request_with_http_info(id, request_id, **kwargs) else: - (data) = self.get_cluster_with_http_info(**kwargs) + (data) = self.delete_flow_analysis_rule_verification_request_with_http_info(id, request_id, **kwargs) return data - def get_cluster_with_http_info(self, **kwargs): + def delete_flow_analysis_rule_verification_request_with_http_info(self, id, request_id, **kwargs): """ - Gets the contents of the cluster - Returns the contents of the cluster including all nodes and their status. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_cluster_with_http_info(callback=callback_function) + Deletes the Verification Request with the given ID. + + Deletes the Verification Request with the given ID. After a request is created, it is expected that the client will properly clean up the request by DELETE'ing it, once the Verification process has completed. If the request is deleted before the request completes, then the Verification request will finish the step that it is currently performing and then will cancel any subsequent steps. - :param callback function: The callback function - for asynchronous request. (optional) - :return: ClusterEntity - If the method is called asynchronously, - returns the request thread. + 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_flow_analysis_rule_verification_request()`` method instead. + + Args: + id (str): + The ID of the Flow Analysis Rule (required) + request_id (str): + The ID of the Verification Request (required) + + Returns: + tuple: (:class:`~nipyapi.nifi.models.VerifyConfigRequestEntity`, status_code, headers) - Response data with HTTP details. """ - all_params = [] - all_params.append('callback') + all_params = ['id', 'request_id'] all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -948,16 +864,1901 @@ def get_cluster_with_http_info(self, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method get_cluster" % key + " to method delete_flow_analysis_rule_verification_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_flow_analysis_rule_verification_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_flow_analysis_rule_verification_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('/controller/flow-analysis-rules/{id}/config/verification-requests/{requestId}', 'DELETE', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='VerifyConfigRequestEntity', + 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_flow_registry_client(self, id, **kwargs): + """ + Deletes a flow registry client. + 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_flow_registry_client_with_http_info()`` method instead. + + Args: + id (str): + The flow registry client 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.FlowRegistryClientEntity`: The response data. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('callback'): + return self.delete_flow_registry_client_with_http_info(id, **kwargs) + else: + (data) = self.delete_flow_registry_client_with_http_info(id, **kwargs) + return data + + def delete_flow_registry_client_with_http_info(self, id, **kwargs): + """ + Deletes a flow registry client. + 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_flow_registry_client()`` method instead. + + Args: + id (str): + The flow registry client 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.FlowRegistryClientEntity`, 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 delete_flow_registry_client" % 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_flow_registry_client`") + + + + + + 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('/controller/registry-clients/{id}', 'DELETE', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='FlowRegistryClientEntity', + 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_history(self, end_date, **kwargs): + """ + Purges history. + 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_history_with_http_info()`` method instead. + + Args: + end_date (:class:`~nipyapi.nifi.models.DateTimeParameter`): + Purge actions before this date/time. (required) + + Returns: + :class:`~nipyapi.nifi.models.HistoryEntity`: The response data. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('callback'): + return self.delete_history_with_http_info(end_date, **kwargs) + else: + (data) = self.delete_history_with_http_info(end_date, **kwargs) + return data + + def delete_history_with_http_info(self, end_date, **kwargs): + """ + Purges history. + 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_history()`` method instead. + + Args: + end_date (:class:`~nipyapi.nifi.models.DateTimeParameter`): + Purge actions before this date/time. (required) + + Returns: + tuple: (:class:`~nipyapi.nifi.models.HistoryEntity`, status_code, headers) - Response data with HTTP details. + """ + + all_params = ['end_date'] + 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_history" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'end_date' is set + if ('end_date' not in params) or (params['end_date'] is None): + raise ValueError("Missing the required parameter `end_date` when calling `delete_history`") + + + collection_formats = {} + + path_params = {} + + query_params = [] + if 'end_date' in params: + query_params.append(('endDate', params['end_date'])) + + 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('/controller/history', 'DELETE', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='HistoryEntity', + 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_nar(self, id, **kwargs): + """ + Deletes an installed NAR. + 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_nar_with_http_info()`` method instead. + + Args: + id (str): + The id of the NAR. (required) + disconnected_node_acknowledged (bool): + force (bool): + + Returns: + :class:`~nipyapi.nifi.models.NarSummaryEntity`: The response data. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('callback'): + return self.delete_nar_with_http_info(id, **kwargs) + else: + (data) = self.delete_nar_with_http_info(id, **kwargs) + return data + + def delete_nar_with_http_info(self, id, **kwargs): + """ + Deletes an installed NAR. + 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_nar()`` method instead. + + Args: + id (str): + The id of the NAR. (required) + disconnected_node_acknowledged (bool): + force (bool): + + Returns: + tuple: (:class:`~nipyapi.nifi.models.NarSummaryEntity`, status_code, headers) - Response data with HTTP details. + """ + + all_params = ['id', 'disconnected_node_acknowledged', 'force'] + 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_nar" % 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_nar`") + + + + + 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'])) + if 'force' in params: + query_params.append(('force', params['force'])) + + 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('/controller/nar-manager/nars/{id}', 'DELETE', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='NarSummaryEntity', + 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_node(self, id, **kwargs): + """ + Removes a node from the cluster. + 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_node_with_http_info()`` method instead. + + Args: + id (str): + The node id. (required) + + Returns: + :class:`~nipyapi.nifi.models.NodeEntity`: The response data. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('callback'): + return self.delete_node_with_http_info(id, **kwargs) + else: + (data) = self.delete_node_with_http_info(id, **kwargs) + return data + + def delete_node_with_http_info(self, id, **kwargs): + """ + Removes a node from the cluster. + 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_node()`` method instead. + + Args: + id (str): + The node id. (required) + + Returns: + tuple: (:class:`~nipyapi.nifi.models.NodeEntity`, 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 delete_node" % 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_node`") + + + 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('/controller/cluster/nodes/{id}', 'DELETE', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='NodeEntity', + 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 download_nar(self, id, **kwargs): + """ + Retrieves the content of the NAR 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 + ``download_nar_with_http_info()`` method instead. + + Args: + id (str): + The id of the NAR. (required) + + Returns: + str: The response data. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('callback'): + return self.download_nar_with_http_info(id, **kwargs) + else: + (data) = self.download_nar_with_http_info(id, **kwargs) + return data + + def download_nar_with_http_info(self, id, **kwargs): + """ + Retrieves the content of the NAR 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 ``download_nar()`` method instead. + + Args: + id (str): + The id of the NAR. (required) + + Returns: + tuple: (str, 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 download_nar" % 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 `download_nar`") + + + 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/octet-stream']) + + # Authentication setting + auth_settings = ['bearerAuth'] + + return self.api_client.call_api('/controller/nar-manager/nars/{id}/content', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='str', + auth_settings=auth_settings, + _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_cluster(self, **kwargs): + """ + Gets the contents of the cluster. + + Returns the contents of the cluster including all nodes and their status. + + This method makes a synchronous HTTP request and returns the response data directly. + + For full HTTP response details (status code, headers, etc.), use the corresponding + ``get_cluster_with_http_info()`` method instead. + + Args: + + Returns: + :class:`~nipyapi.nifi.models.ClusterEntity`: The response data. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('callback'): + return self.get_cluster_with_http_info(**kwargs) + else: + (data) = self.get_cluster_with_http_info(**kwargs) + return data + + def get_cluster_with_http_info(self, **kwargs): + """ + Gets the contents of the cluster. + + Returns the contents of the cluster including all nodes and their status. + + This method makes a synchronous HTTP request 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_cluster()`` method instead. + + Args: + + Returns: + tuple: (:class:`~nipyapi.nifi.models.ClusterEntity`, status_code, headers) - Response data with HTTP details. + """ + + all_params = [] + 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_cluster" % key + ) + params[key] = val + del params['kwargs'] + + collection_formats = {} + + path_params = {} + + query_params = [] + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.\ + select_header_accept(['application/json']) + + # Authentication setting + auth_settings = ['bearerAuth'] + + return self.api_client.call_api('/controller/cluster', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='ClusterEntity', + 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_controller_config(self, **kwargs): + """ + Retrieves the configuration for this NiFi Controller. + 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_controller_config_with_http_info()`` method instead. + + Args: + + Returns: + :class:`~nipyapi.nifi.models.ControllerConfigurationEntity`: The response data. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('callback'): + return self.get_controller_config_with_http_info(**kwargs) + else: + (data) = self.get_controller_config_with_http_info(**kwargs) + return data + + def get_controller_config_with_http_info(self, **kwargs): + """ + Retrieves the configuration for this NiFi Controller. + 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_controller_config()`` method instead. + + Args: + + Returns: + tuple: (:class:`~nipyapi.nifi.models.ControllerConfigurationEntity`, status_code, headers) - Response data with HTTP details. + """ + + all_params = [] + 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_controller_config" % key + ) + params[key] = val + del params['kwargs'] + + collection_formats = {} + + path_params = {} + + query_params = [] + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.\ + select_header_accept(['application/json']) + + # Authentication setting + auth_settings = ['bearerAuth'] + + return self.api_client.call_api('/controller/config', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='ControllerConfigurationEntity', + 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_flow_analysis_rule(self, id, **kwargs): + """ + Gets a flow analysis rule. + 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_flow_analysis_rule_with_http_info()`` method instead. + + Args: + id (str): + The flow analysis rule id. (required) + + Returns: + :class:`~nipyapi.nifi.models.FlowAnalysisRuleEntity`: The response data. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('callback'): + return self.get_flow_analysis_rule_with_http_info(id, **kwargs) + else: + (data) = self.get_flow_analysis_rule_with_http_info(id, **kwargs) + return data + + def get_flow_analysis_rule_with_http_info(self, id, **kwargs): + """ + Gets a flow analysis rule. + 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_flow_analysis_rule()`` method instead. + + Args: + id (str): + The flow analysis rule id. (required) + + Returns: + tuple: (:class:`~nipyapi.nifi.models.FlowAnalysisRuleEntity`, 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_flow_analysis_rule" % 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_flow_analysis_rule`") + + + 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('/controller/flow-analysis-rules/{id}', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='FlowAnalysisRuleEntity', + 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_flow_analysis_rule_property_descriptor(self, id, property_name, **kwargs): + """ + Gets a flow analysis rule property descriptor. + 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_flow_analysis_rule_property_descriptor_with_http_info()`` method instead. + + Args: + id (str): + The flow analysis rule id. (required) + property_name (str): + The property name. (required) + sensitive (bool): + Property Descriptor requested sensitive status + + Returns: + :class:`~nipyapi.nifi.models.PropertyDescriptorEntity`: The response data. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('callback'): + return self.get_flow_analysis_rule_property_descriptor_with_http_info(id, property_name, **kwargs) + else: + (data) = self.get_flow_analysis_rule_property_descriptor_with_http_info(id, property_name, **kwargs) + return data + + def get_flow_analysis_rule_property_descriptor_with_http_info(self, id, property_name, **kwargs): + """ + Gets a flow analysis rule property descriptor. + 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_flow_analysis_rule_property_descriptor()`` method instead. + + Args: + id (str): + The flow analysis rule id. (required) + property_name (str): + The property name. (required) + sensitive (bool): + Property Descriptor requested sensitive status + + Returns: + tuple: (:class:`~nipyapi.nifi.models.PropertyDescriptorEntity`, status_code, headers) - Response data with HTTP details. + """ + + all_params = ['id', 'property_name', 'sensitive'] + 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_flow_analysis_rule_property_descriptor" % 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_flow_analysis_rule_property_descriptor`") + # verify the required parameter 'property_name' is set + if ('property_name' not in params) or (params['property_name'] is None): + raise ValueError("Missing the required parameter `property_name` when calling `get_flow_analysis_rule_property_descriptor`") + + + + + collection_formats = {} + + path_params = {} + if 'id' in params: + path_params['id'] = params['id'] + + query_params = [] + if 'property_name' in params: + query_params.append(('propertyName', params['property_name'])) + if 'sensitive' in params: + query_params.append(('sensitive', params['sensitive'])) + + 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('/controller/flow-analysis-rules/{id}/descriptors', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='PropertyDescriptorEntity', + 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_flow_analysis_rule_state(self, id, **kwargs): + """ + Gets the state for a flow analysis rule. + 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_flow_analysis_rule_state_with_http_info()`` method instead. + + Args: + id (str): + The flow analysis rule id. (required) + + Returns: + :class:`~nipyapi.nifi.models.ComponentStateEntity`: The response data. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('callback'): + return self.get_flow_analysis_rule_state_with_http_info(id, **kwargs) + else: + (data) = self.get_flow_analysis_rule_state_with_http_info(id, **kwargs) + return data + + def get_flow_analysis_rule_state_with_http_info(self, id, **kwargs): + """ + Gets the state for a flow analysis rule. + 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_flow_analysis_rule_state()`` method instead. + + Args: + id (str): + The flow analysis rule id. (required) + + Returns: + tuple: (:class:`~nipyapi.nifi.models.ComponentStateEntity`, 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_flow_analysis_rule_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_flow_analysis_rule_state`") + + + collection_formats = {} + + path_params = {} + if 'id' in params: + path_params['id'] = params['id'] + + query_params = [] + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.\ + select_header_accept(['application/json']) + + # Authentication setting + auth_settings = ['bearerAuth'] + + return self.api_client.call_api('/controller/flow-analysis-rules/{id}/state', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='ComponentStateEntity', + auth_settings=auth_settings, + _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_flow_analysis_rule_verification_request(self, id, request_id, **kwargs): + """ + Returns the Verification Request with the given ID. + + Returns the Verification Request with the given ID. Once an Verification Request has been created, that request can subsequently be retrieved via this endpoint, and the request that is fetched will contain the updated state, such as percent complete, the current state of the request, and any failures. + + This method makes a synchronous HTTP request and returns the response data directly. + + For full HTTP response details (status code, headers, etc.), use the corresponding + ``get_flow_analysis_rule_verification_request_with_http_info()`` method instead. + + Args: + id (str): + The ID of the Flow Analysis Rule (required) + request_id (str): + The ID of the Verification Request (required) + + Returns: + :class:`~nipyapi.nifi.models.VerifyConfigRequestEntity`: The response data. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('callback'): + return self.get_flow_analysis_rule_verification_request_with_http_info(id, request_id, **kwargs) + else: + (data) = self.get_flow_analysis_rule_verification_request_with_http_info(id, request_id, **kwargs) + return data + + def get_flow_analysis_rule_verification_request_with_http_info(self, id, request_id, **kwargs): + """ + Returns the Verification Request with the given ID. + + Returns the Verification Request with the given ID. Once an Verification Request has been created, that request can subsequently be retrieved via this endpoint, and the request that is fetched will contain the updated state, such as percent complete, the current state of the request, and any failures. + + This method makes a synchronous HTTP request 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_flow_analysis_rule_verification_request()`` method instead. + + Args: + id (str): + The ID of the Flow Analysis Rule (required) + request_id (str): + The ID of the Verification Request (required) + + Returns: + tuple: (:class:`~nipyapi.nifi.models.VerifyConfigRequestEntity`, 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_flow_analysis_rule_verification_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_flow_analysis_rule_verification_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_flow_analysis_rule_verification_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('/controller/flow-analysis-rules/{id}/config/verification-requests/{requestId}', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='VerifyConfigRequestEntity', + 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_flow_analysis_rules(self, **kwargs): + """ + Gets all flow analysis rules. + 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_flow_analysis_rules_with_http_info()`` method instead. + + Args: + + Returns: + :class:`~nipyapi.nifi.models.FlowAnalysisRulesEntity`: The response data. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('callback'): + return self.get_flow_analysis_rules_with_http_info(**kwargs) + else: + (data) = self.get_flow_analysis_rules_with_http_info(**kwargs) + return data + + def get_flow_analysis_rules_with_http_info(self, **kwargs): + """ + Gets all flow analysis rules. + 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_flow_analysis_rules()`` method instead. + + Args: + + Returns: + tuple: (:class:`~nipyapi.nifi.models.FlowAnalysisRulesEntity`, status_code, headers) - Response data with HTTP details. + """ + + all_params = [] + 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_flow_analysis_rules" % key + ) + params[key] = val + del params['kwargs'] + + collection_formats = {} + + path_params = {} + + query_params = [] + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.\ + select_header_accept(['application/json']) + + # Authentication setting + auth_settings = ['bearerAuth'] + + return self.api_client.call_api('/controller/flow-analysis-rules', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='FlowAnalysisRulesEntity', + 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_flow_registry_client(self, id, **kwargs): + """ + Gets a flow registry client. + 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_flow_registry_client_with_http_info()`` method instead. + + Args: + id (str): + The flow registry client id. (required) + + Returns: + :class:`~nipyapi.nifi.models.FlowRegistryClientEntity`: The response data. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('callback'): + return self.get_flow_registry_client_with_http_info(id, **kwargs) + else: + (data) = self.get_flow_registry_client_with_http_info(id, **kwargs) + return data + + def get_flow_registry_client_with_http_info(self, id, **kwargs): + """ + Gets a flow registry client. + 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_flow_registry_client()`` method instead. + + Args: + id (str): + The flow registry client id. (required) + + Returns: + tuple: (:class:`~nipyapi.nifi.models.FlowRegistryClientEntity`, 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_flow_registry_client" % 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_flow_registry_client`") + + + 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('/controller/registry-clients/{id}', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='FlowRegistryClientEntity', + 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_flow_registry_clients(self, **kwargs): + """ + Gets the listing of available flow registry clients. + 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_flow_registry_clients_with_http_info()`` method instead. + + Args: + + Returns: + :class:`~nipyapi.nifi.models.FlowRegistryClientsEntity`: The response data. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('callback'): + return self.get_flow_registry_clients_with_http_info(**kwargs) + else: + (data) = self.get_flow_registry_clients_with_http_info(**kwargs) + return data + + def get_flow_registry_clients_with_http_info(self, **kwargs): + """ + Gets the listing of available flow registry clients. + 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_flow_registry_clients()`` method instead. + + Args: + + Returns: + tuple: (:class:`~nipyapi.nifi.models.FlowRegistryClientsEntity`, status_code, headers) - Response data with HTTP details. + """ + + all_params = [] + 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_flow_registry_clients" % key + ) + params[key] = val + del params['kwargs'] + + collection_formats = {} + + path_params = {} + + query_params = [] + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.\ + select_header_accept(['application/json']) + + # Authentication setting + auth_settings = ['bearerAuth'] + + return self.api_client.call_api('/controller/registry-clients', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='FlowRegistryClientsEntity', + 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_nar_details(self, id, **kwargs): + """ + Retrieves the component types available from the installed NARs. + 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_nar_details_with_http_info()`` method instead. + + Args: + id (str): + The id of the NAR. (required) + + Returns: + :class:`~nipyapi.nifi.models.NarDetailsEntity`: The response data. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('callback'): + return self.get_nar_details_with_http_info(id, **kwargs) + else: + (data) = self.get_nar_details_with_http_info(id, **kwargs) + return data + + def get_nar_details_with_http_info(self, id, **kwargs): + """ + Retrieves the component types available from the installed NARs. + 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_nar_details()`` method instead. + + Args: + id (str): + The id of the NAR. (required) + + Returns: + tuple: (:class:`~nipyapi.nifi.models.NarDetailsEntity`, 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_nar_details" % 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_nar_details`") + + + 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('/controller/nar-manager/nars/{id}/details', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='NarDetailsEntity', + 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_nar_summaries(self, **kwargs): + """ + Retrieves summary information for installed NARs. + 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_nar_summaries_with_http_info()`` method instead. + + Args: + + Returns: + :class:`~nipyapi.nifi.models.NarSummariesEntity`: The response data. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('callback'): + return self.get_nar_summaries_with_http_info(**kwargs) + else: + (data) = self.get_nar_summaries_with_http_info(**kwargs) + return data + + def get_nar_summaries_with_http_info(self, **kwargs): + """ + Retrieves summary information for installed NARs. + 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_nar_summaries()`` method instead. + + Args: + + Returns: + tuple: (:class:`~nipyapi.nifi.models.NarSummariesEntity`, status_code, headers) - Response data with HTTP details. + """ + + all_params = [] + 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_nar_summaries" % key + ) + params[key] = val + del params['kwargs'] + + collection_formats = {} + + path_params = {} + + query_params = [] + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.\ + select_header_accept(['application/json']) + + # Authentication setting + auth_settings = ['bearerAuth'] + + return self.api_client.call_api('/controller/nar-manager/nars', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='NarSummariesEntity', + 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_nar_summary(self, id, **kwargs): + """ + Retrieves the summary information for the NAR with the given identifier. + 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_nar_summary_with_http_info()`` method instead. + + Args: + id (str): + The id of the NAR. (required) + + Returns: + :class:`~nipyapi.nifi.models.NarDetailsEntity`: The response data. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('callback'): + return self.get_nar_summary_with_http_info(id, **kwargs) + else: + (data) = self.get_nar_summary_with_http_info(id, **kwargs) + return data + + def get_nar_summary_with_http_info(self, id, **kwargs): + """ + Retrieves the summary information for the NAR with the given identifier. + 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_nar_summary()`` method instead. + + Args: + id (str): + The id of the NAR. (required) + + Returns: + tuple: (:class:`~nipyapi.nifi.models.NarDetailsEntity`, 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_nar_summary" % 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_nar_summary`") + + + 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('/controller/nar-manager/nars/{id}', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='NarDetailsEntity', + 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_node(self, id, **kwargs): + """ + Gets a node in the cluster. + 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_node_with_http_info()`` method instead. + + Args: + id (str): + The node id. (required) + + Returns: + :class:`~nipyapi.nifi.models.NodeEntity`: The response data. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('callback'): + return self.get_node_with_http_info(id, **kwargs) + else: + (data) = self.get_node_with_http_info(id, **kwargs) + return data + + def get_node_with_http_info(self, id, **kwargs): + """ + Gets a node in the cluster. + 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_node()`` method instead. + + Args: + id (str): + The node id. (required) + + Returns: + tuple: (:class:`~nipyapi.nifi.models.NodeEntity`, 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_node" % 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_node`") + + + 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('/controller/cluster/nodes/{id}', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='NodeEntity', + 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_node_status_history(self, **kwargs): + """ + Gets status history for the node. + + Note: This endpoint is subject to change as NiFi and it's REST API evolve. + + This method makes a synchronous HTTP request and returns the response data directly. + + For full HTTP response details (status code, headers, etc.), use the corresponding + ``get_node_status_history_with_http_info()`` method instead. + + Args: + + Returns: + :class:`~nipyapi.nifi.models.ComponentHistoryEntity`: The response data. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('callback'): + return self.get_node_status_history_with_http_info(**kwargs) + else: + (data) = self.get_node_status_history_with_http_info(**kwargs) + return data + + def get_node_status_history_with_http_info(self, **kwargs): + """ + Gets status history for the node. + + Note: This endpoint is subject to change as NiFi and it's REST API evolve. + + This method makes a synchronous HTTP request 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_node_status_history()`` method instead. + + Args: + + Returns: + tuple: (:class:`~nipyapi.nifi.models.ComponentHistoryEntity`, status_code, headers) - Response data with HTTP details. + """ + + all_params = [] + 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_node_status_history" % key + ) + params[key] = val + del params['kwargs'] + + collection_formats = {} + + path_params = {} + + query_params = [] + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.\ + select_header_accept(['application/json']) + + # Authentication setting + auth_settings = ['bearerAuth'] + + return self.api_client.call_api('/controller/status/history', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='ComponentHistoryEntity', + 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_property_descriptor(self, id, property_name, **kwargs): + """ + Gets a flow registry client property descriptor. + 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_property_descriptor_with_http_info()`` method instead. + + Args: + id (str): + The flow registry client id. (required) + property_name (str): + The property name. (required) + sensitive (bool): + Property Descriptor requested sensitive status + + Returns: + :class:`~nipyapi.nifi.models.PropertyDescriptorEntity`: The response data. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('callback'): + return self.get_property_descriptor_with_http_info(id, property_name, **kwargs) + else: + (data) = self.get_property_descriptor_with_http_info(id, property_name, **kwargs) + return data + + def get_property_descriptor_with_http_info(self, id, property_name, **kwargs): + """ + Gets a flow registry client property descriptor. + 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_property_descriptor()`` method instead. + + Args: + id (str): + The flow registry client id. (required) + property_name (str): + The property name. (required) + sensitive (bool): + Property Descriptor requested sensitive status + + Returns: + tuple: (:class:`~nipyapi.nifi.models.PropertyDescriptorEntity`, status_code, headers) - Response data with HTTP details. + """ + + all_params = ['id', 'property_name', 'sensitive'] + 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_property_descriptor" % 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_property_descriptor`") + # verify the required parameter 'property_name' is set + if ('property_name' not in params) or (params['property_name'] is None): + raise ValueError("Missing the required parameter `property_name` when calling `get_property_descriptor`") + + + collection_formats = {} path_params = {} + if 'id' in params: + path_params['id'] = params['id'] query_params = [] + if 'property_name' in params: + query_params.append(('propertyName', params['property_name'])) + if 'sensitive' in params: + query_params.append(('sensitive', params['sensitive'])) header_params = {} @@ -969,74 +2770,64 @@ def get_cluster_with_http_info(self, **kwargs): header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['*/*']) - # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] - return self.api_client.call_api('/controller/cluster', 'GET', + return self.api_client.call_api('/controller/registry-clients/{id}/descriptors', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, - response_type='ClusterEntity', + response_type='PropertyDescriptorEntity', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def get_controller_config(self, **kwargs): + def get_registry_client_types(self, **kwargs): """ - Retrieves the configuration for this NiFi Controller - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_controller_config(callback=callback_function) + Retrieves the types of flow that this NiFi supports. + + Note: This endpoint is subject to change as NiFi and it's REST API evolve. - :param callback function: The callback function - for asynchronous request. (optional) - :return: ControllerConfigurationEntity - If the method is called asynchronously, - returns the request thread. + 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_registry_client_types_with_http_info()`` method instead. + + Args: + + Returns: + :class:`~nipyapi.nifi.models.FlowRegistryClientTypesEntity`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.get_controller_config_with_http_info(**kwargs) + return self.get_registry_client_types_with_http_info(**kwargs) else: - (data) = self.get_controller_config_with_http_info(**kwargs) + (data) = self.get_registry_client_types_with_http_info(**kwargs) return data - def get_controller_config_with_http_info(self, **kwargs): + def get_registry_client_types_with_http_info(self, **kwargs): """ - Retrieves the configuration for this NiFi Controller - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_controller_config_with_http_info(callback=callback_function) + Retrieves the types of flow that this NiFi supports. + + Note: This endpoint is subject to change as NiFi and it's REST API evolve. - :param callback function: The callback function - for asynchronous request. (optional) - :return: ControllerConfigurationEntity - If the method is called asynchronously, - returns the request thread. + 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_registry_client_types()`` method instead. + + Args: + + Returns: + tuple: (:class:`~nipyapi.nifi.models.FlowRegistryClientTypesEntity`, status_code, headers) - Response data with HTTP details. """ all_params = [] - all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -1046,7 +2837,7 @@ def get_controller_config_with_http_info(self, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method get_controller_config" % key + " to method get_registry_client_types" % key ) params[key] = val del params['kwargs'] @@ -1067,76 +2858,62 @@ def get_controller_config_with_http_info(self, **kwargs): header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['*/*']) - # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] - return self.api_client.call_api('/controller/config', 'GET', + return self.api_client.call_api('/controller/registry-types', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, - response_type='ControllerConfigurationEntity', + response_type='FlowRegistryClientTypesEntity', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def get_flow_registry_client(self, id, **kwargs): + def import_reporting_task_snapshot(self, body, **kwargs): """ - Gets a flow registry client + Imports a reporting task snapshot. + This method makes a synchronous HTTP request and returns the response data directly. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_flow_registry_client(id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The flow registry client id. (required) - :return: FlowRegistryClientEntity - If the method is called asynchronously, - returns the request thread. + For full HTTP response details (status code, headers, etc.), use the corresponding + ``import_reporting_task_snapshot_with_http_info()`` method instead. + + Args: + body (:class:`~nipyapi.nifi.models.VersionedReportingTaskImportRequestEntity`): + The import request containing the reporting task snapshot to import. (required) + + Returns: + :class:`~nipyapi.nifi.models.VersionedReportingTaskImportResponseEntity`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.get_flow_registry_client_with_http_info(id, **kwargs) + return self.import_reporting_task_snapshot_with_http_info(body, **kwargs) else: - (data) = self.get_flow_registry_client_with_http_info(id, **kwargs) + (data) = self.import_reporting_task_snapshot_with_http_info(body, **kwargs) return data - def get_flow_registry_client_with_http_info(self, id, **kwargs): + def import_reporting_task_snapshot_with_http_info(self, body, **kwargs): """ - Gets a flow registry client + Imports a reporting task snapshot. + This method makes a synchronous HTTP request and returns detailed response information. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_flow_registry_client_with_http_info(id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The flow registry client id. (required) - :return: FlowRegistryClientEntity - If the method is called asynchronously, - returns the request thread. + Returns the response data along with HTTP status code, headers, and other metadata. + For just the response data, use the corresponding ``import_reporting_task_snapshot()`` method instead. + + Args: + body (:class:`~nipyapi.nifi.models.VersionedReportingTaskImportRequestEntity`): + The import request containing the reporting task snapshot to import. (required) + + Returns: + tuple: (:class:`~nipyapi.nifi.models.VersionedReportingTaskImportResponseEntity`, status_code, headers) - Response data with HTTP details. """ - all_params = ['id'] - all_params.append('callback') + all_params = ['body'] all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -1146,20 +2923,18 @@ def get_flow_registry_client_with_http_info(self, id, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method get_flow_registry_client" % key + " to method import_reporting_task_snapshot" % 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_flow_registry_client`") - + # 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 `import_reporting_task_snapshot`") + collection_formats = {} path_params = {} - if 'id' in params: - path_params['id'] = params['id'] query_params = [] @@ -1169,78 +2944,84 @@ def get_flow_registry_client_with_http_info(self, id, **kwargs): 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(['*/*']) + select_header_content_type(['application/json']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] - return self.api_client.call_api('/controller/registry-clients/{id}', 'GET', + return self.api_client.call_api('/controller/reporting-tasks/import', 'POST', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, - response_type='FlowRegistryClientEntity', + response_type='VersionedReportingTaskImportResponseEntity', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def get_flow_registry_clients(self, **kwargs): + def remove_flow_analysis_rule(self, id, **kwargs): """ - Gets the listing of available flow registry clients + Deletes a flow analysis rule. + This method makes a synchronous HTTP request and returns the response data directly. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_flow_registry_clients(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :return: FlowRegistryClientsEntity - If the method is called asynchronously, - returns the request thread. + For full HTTP response details (status code, headers, etc.), use the corresponding + ``remove_flow_analysis_rule_with_http_info()`` method instead. + + Args: + id (str): + The flow analysis rule 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.FlowAnalysisRuleEntity`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.get_flow_registry_clients_with_http_info(**kwargs) + return self.remove_flow_analysis_rule_with_http_info(id, **kwargs) else: - (data) = self.get_flow_registry_clients_with_http_info(**kwargs) + (data) = self.remove_flow_analysis_rule_with_http_info(id, **kwargs) return data - def get_flow_registry_clients_with_http_info(self, **kwargs): + def remove_flow_analysis_rule_with_http_info(self, id, **kwargs): """ - Gets the listing of available flow registry clients + Deletes a flow analysis rule. + This method makes a synchronous HTTP request and returns detailed response information. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_flow_registry_clients_with_http_info(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :return: FlowRegistryClientsEntity - If the method is called asynchronously, - returns the request thread. + Returns the response data along with HTTP status code, headers, and other metadata. + For just the response data, use the corresponding ``remove_flow_analysis_rule()`` method instead. + + Args: + id (str): + The flow analysis rule 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.FlowAnalysisRuleEntity`, status_code, headers) - Response data with HTTP details. """ - all_params = [] - all_params.append('callback') + 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') @@ -1250,16 +3031,31 @@ def get_flow_registry_clients_with_http_info(self, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method get_flow_registry_clients" % key + " to method remove_flow_analysis_rule" % key ) params[key] = val del params['kwargs'] + # verify the required parameter 'id' is set + if ('id' not in params) or (params['id'] is None): + raise ValueError("Missing the required parameter `id` when calling `remove_flow_analysis_rule`") + + + + 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 = {} @@ -1271,76 +3067,72 @@ def get_flow_registry_clients_with_http_info(self, **kwargs): header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['*/*']) - # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] - return self.api_client.call_api('/controller/registry-clients', 'GET', + return self.api_client.call_api('/controller/flow-analysis-rules/{id}', 'DELETE', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, - response_type='FlowRegistryClientsEntity', + response_type='FlowAnalysisRuleEntity', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def get_node(self, id, **kwargs): + def submit_flow_analysis_rule_config_verification_request(self, body, id, **kwargs): """ - Gets a node in the cluster - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_node(id, callback=callback_function) + Performs verification of the Flow Analysis Rule's configuration. + + 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}. - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The node id. (required) - :return: NodeEntity - If the method is called asynchronously, - returns the request thread. + 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_flow_analysis_rule_config_verification_request_with_http_info()`` method instead. + + Args: + body (:class:`~nipyapi.nifi.models.VerifyConfigRequestEntity`): + The flow analysis rules configuration verification request. (required) + id (str): + The flow analysis rules id. (required) + + Returns: + :class:`~nipyapi.nifi.models.VerifyConfigRequestEntity`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.get_node_with_http_info(id, **kwargs) + return self.submit_flow_analysis_rule_config_verification_request_with_http_info(body, id, **kwargs) else: - (data) = self.get_node_with_http_info(id, **kwargs) + (data) = self.submit_flow_analysis_rule_config_verification_request_with_http_info(body, id, **kwargs) return data - def get_node_with_http_info(self, id, **kwargs): + def submit_flow_analysis_rule_config_verification_request_with_http_info(self, body, id, **kwargs): """ - Gets a node in the cluster - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_node_with_http_info(id, callback=callback_function) + Performs verification of the Flow Analysis Rule's configuration. - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The node id. (required) - :return: NodeEntity - If the method is called asynchronously, - returns the request thread. + 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}. + + 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_flow_analysis_rule_config_verification_request()`` method instead. + + Args: + body (:class:`~nipyapi.nifi.models.VerifyConfigRequestEntity`): + The flow analysis rules configuration verification request. (required) + id (str): + The flow analysis rules id. (required) + + Returns: + tuple: (:class:`~nipyapi.nifi.models.VerifyConfigRequestEntity`, status_code, headers) - Response data with HTTP details. """ - all_params = ['id'] - all_params.append('callback') + all_params = ['body', 'id'] all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -1350,15 +3142,19 @@ def get_node_with_http_info(self, id, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method get_node" % key + " to method submit_flow_analysis_rule_config_verification_request" % 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 `submit_flow_analysis_rule_config_verification_request`") # verify the required parameter 'id' is set if ('id' not in params) or (params['id'] is None): - raise ValueError("Missing the required parameter `id` when calling `get_node`") - + raise ValueError("Missing the required parameter `id` when calling `submit_flow_analysis_rule_config_verification_request`") + + collection_formats = {} path_params = {} @@ -1373,78 +3169,72 @@ def get_node_with_http_info(self, id, **kwargs): 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(['*/*']) + select_header_content_type(['application/json']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] - return self.api_client.call_api('/controller/cluster/nodes/{id}', 'GET', + return self.api_client.call_api('/controller/flow-analysis-rules/{id}/config/verification-requests', 'POST', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, - response_type='NodeEntity', + response_type='VerifyConfigRequestEntity', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def get_node_status_history(self, **kwargs): + def update_controller_config(self, body, **kwargs): """ - Gets status history for the node - Note: This endpoint is subject to change as NiFi and it's REST API evolve. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_node_status_history(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :return: ComponentHistoryEntity - If the method is called asynchronously, - returns the request thread. + Retrieves the configuration for this NiFi. + 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 + ``update_controller_config_with_http_info()`` method instead. + + Args: + body (:class:`~nipyapi.nifi.models.ControllerConfigurationEntity`): + The controller configuration. (required) + + Returns: + :class:`~nipyapi.nifi.models.ControllerConfigurationEntity`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.get_node_status_history_with_http_info(**kwargs) + return self.update_controller_config_with_http_info(body, **kwargs) else: - (data) = self.get_node_status_history_with_http_info(**kwargs) + (data) = self.update_controller_config_with_http_info(body, **kwargs) return data - def get_node_status_history_with_http_info(self, **kwargs): + def update_controller_config_with_http_info(self, body, **kwargs): """ - Gets status history for the node - Note: This endpoint is subject to change as NiFi and it's REST API evolve. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_node_status_history_with_http_info(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :return: ComponentHistoryEntity - If the method is called asynchronously, - returns the request thread. + Retrieves the configuration for this NiFi. + 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 ``update_controller_config()`` method instead. + + Args: + body (:class:`~nipyapi.nifi.models.ControllerConfigurationEntity`): + The controller configuration. (required) + + Returns: + tuple: (:class:`~nipyapi.nifi.models.ControllerConfigurationEntity`, status_code, headers) - Response data with HTTP details. """ - all_params = [] - all_params.append('callback') + all_params = ['body'] all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -1454,11 +3244,15 @@ def get_node_status_history_with_http_info(self, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method get_node_status_history" % key + " to method update_controller_config" % 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 `update_controller_config`") + collection_formats = {} path_params = {} @@ -1471,84 +3265,76 @@ def get_node_status_history_with_http_info(self, **kwargs): 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(['*/*']) + select_header_content_type(['application/json']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] - return self.api_client.call_api('/controller/status/history', 'GET', + return self.api_client.call_api('/controller/config', 'PUT', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, - response_type='ComponentHistoryEntity', + response_type='ControllerConfigurationEntity', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def get_property_descriptor(self, id, property_name, **kwargs): + def update_flow_analysis_rule(self, body, id, **kwargs): """ - Gets a flow registry client property descriptor - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_property_descriptor(id, property_name, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The flow registry client id. (required) - :param str property_name: The property name. (required) - :param bool sensitive: Property Descriptor requested sensitive status - :return: PropertyDescriptorEntity - If the method is called asynchronously, - returns the request thread. + Updates a flow analysis rule. + 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 + ``update_flow_analysis_rule_with_http_info()`` method instead. + + Args: + body (:class:`~nipyapi.nifi.models.FlowAnalysisRuleEntity`): + The flow analysis rule configuration details. (required) + id (str): + The flow analysis rule id. (required) + + Returns: + :class:`~nipyapi.nifi.models.FlowAnalysisRuleEntity`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.get_property_descriptor_with_http_info(id, property_name, **kwargs) + return self.update_flow_analysis_rule_with_http_info(body, id, **kwargs) else: - (data) = self.get_property_descriptor_with_http_info(id, property_name, **kwargs) + (data) = self.update_flow_analysis_rule_with_http_info(body, id, **kwargs) return data - def get_property_descriptor_with_http_info(self, id, property_name, **kwargs): + def update_flow_analysis_rule_with_http_info(self, body, id, **kwargs): """ - Gets a flow registry client property descriptor + Updates a flow analysis rule. + This method makes a synchronous HTTP request and returns detailed response information. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_property_descriptor_with_http_info(id, property_name, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The flow registry client id. (required) - :param str property_name: The property name. (required) - :param bool sensitive: Property Descriptor requested sensitive status - :return: PropertyDescriptorEntity - If the method is called asynchronously, - returns the request thread. + Returns the response data along with HTTP status code, headers, and other metadata. + For just the response data, use the corresponding ``update_flow_analysis_rule()`` method instead. + + Args: + body (:class:`~nipyapi.nifi.models.FlowAnalysisRuleEntity`): + The flow analysis rule configuration details. (required) + id (str): + The flow analysis rule id. (required) + + Returns: + tuple: (:class:`~nipyapi.nifi.models.FlowAnalysisRuleEntity`, status_code, headers) - Response data with HTTP details. """ - all_params = ['id', 'property_name', 'sensitive'] - all_params.append('callback') + all_params = ['body', 'id'] all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -1558,18 +3344,19 @@ def get_property_descriptor_with_http_info(self, id, property_name, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method get_property_descriptor" % key + " to method update_flow_analysis_rule" % 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 `update_flow_analysis_rule`") # 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_property_descriptor`") - # verify the required parameter 'property_name' is set - if ('property_name' not in params) or (params['property_name'] is None): - raise ValueError("Missing the required parameter `property_name` when calling `get_property_descriptor`") - + raise ValueError("Missing the required parameter `id` when calling `update_flow_analysis_rule`") + + collection_formats = {} path_params = {} @@ -1577,10 +3364,6 @@ def get_property_descriptor_with_http_info(self, id, property_name, **kwargs): path_params['id'] = params['id'] query_params = [] - if 'property_name' in params: - query_params.append(('propertyName', params['property_name'])) - if 'sensitive' in params: - query_params.append(('sensitive', params['sensitive'])) header_params = {} @@ -1588,78 +3371,76 @@ def get_property_descriptor_with_http_info(self, id, property_name, **kwargs): 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(['*/*']) + select_header_content_type(['application/json']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] - return self.api_client.call_api('/controller/registry-clients/{id}/descriptors', 'GET', + return self.api_client.call_api('/controller/flow-analysis-rules/{id}', 'PUT', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, - response_type='PropertyDescriptorEntity', + response_type='FlowAnalysisRuleEntity', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def get_registry_client_types(self, **kwargs): + def update_flow_registry_client(self, body, id, **kwargs): """ - Retrieves the types of flow that this NiFi supports - Note: This endpoint is subject to change as NiFi and it's REST API evolve. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_registry_client_types(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :return: FlowRegistryClientTypesEntity - If the method is called asynchronously, - returns the request thread. + Updates a flow registry client. + 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 + ``update_flow_registry_client_with_http_info()`` method instead. + + Args: + body (:class:`~nipyapi.nifi.models.FlowRegistryClientEntity`): + The flow registry client configuration details. (required) + id (str): + The flow registry client id. (required) + + Returns: + :class:`~nipyapi.nifi.models.FlowRegistryClientEntity`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.get_registry_client_types_with_http_info(**kwargs) + return self.update_flow_registry_client_with_http_info(body, id, **kwargs) else: - (data) = self.get_registry_client_types_with_http_info(**kwargs) + (data) = self.update_flow_registry_client_with_http_info(body, id, **kwargs) return data - def get_registry_client_types_with_http_info(self, **kwargs): + def update_flow_registry_client_with_http_info(self, body, id, **kwargs): """ - Retrieves the types of flow that this NiFi supports - Note: This endpoint is subject to change as NiFi and it's REST API evolve. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_registry_client_types_with_http_info(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :return: FlowRegistryClientTypesEntity - If the method is called asynchronously, - returns the request thread. + Updates a flow registry client. + 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 ``update_flow_registry_client()`` method instead. + + Args: + body (:class:`~nipyapi.nifi.models.FlowRegistryClientEntity`): + The flow registry client configuration details. (required) + id (str): + The flow registry client id. (required) + + Returns: + tuple: (:class:`~nipyapi.nifi.models.FlowRegistryClientEntity`, status_code, headers) - Response data with HTTP details. """ - all_params = [] - all_params.append('callback') + all_params = ['body', 'id'] all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -1669,14 +3450,24 @@ def get_registry_client_types_with_http_info(self, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method get_registry_client_types" % key + " to method update_flow_registry_client" % 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 `update_flow_registry_client`") + # verify the required parameter 'id' is set + if ('id' not in params) or (params['id'] is None): + raise ValueError("Missing the required parameter `id` when calling `update_flow_registry_client`") + + collection_formats = {} path_params = {} + if 'id' in params: + path_params['id'] = params['id'] query_params = [] @@ -1686,80 +3477,76 @@ def get_registry_client_types_with_http_info(self, **kwargs): 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(['*/*']) + select_header_content_type(['application/json']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] - return self.api_client.call_api('/controller/registry-types', 'GET', + return self.api_client.call_api('/controller/registry-clients/{id}', 'PUT', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, - response_type='FlowRegistryClientTypesEntity', + response_type='FlowRegistryClientEntity', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def update_controller_config(self, body, **kwargs): + def update_node(self, body, id, **kwargs): """ - Retrieves the configuration for this NiFi + Updates a node in the cluster. + This method makes a synchronous HTTP request and returns the response data directly. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.update_controller_config(body, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param ControllerConfigurationEntity body: The controller configuration. (required) - :return: ControllerConfigurationEntity - If the method is called asynchronously, - returns the request thread. + For full HTTP response details (status code, headers, etc.), use the corresponding + ``update_node_with_http_info()`` method instead. + + Args: + body (:class:`~nipyapi.nifi.models.NodeEntity`): + The node configuration. The only configuration that will be honored at this endpoint is the status. (required) + id (str): + The node id. (required) + + Returns: + :class:`~nipyapi.nifi.models.NodeEntity`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.update_controller_config_with_http_info(body, **kwargs) + return self.update_node_with_http_info(body, id, **kwargs) else: - (data) = self.update_controller_config_with_http_info(body, **kwargs) + (data) = self.update_node_with_http_info(body, id, **kwargs) return data - def update_controller_config_with_http_info(self, body, **kwargs): + def update_node_with_http_info(self, body, id, **kwargs): """ - Retrieves the configuration for this NiFi + Updates a node in the cluster. + This method makes a synchronous HTTP request and returns detailed response information. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.update_controller_config_with_http_info(body, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param ControllerConfigurationEntity body: The controller configuration. (required) - :return: ControllerConfigurationEntity - If the method is called asynchronously, - returns the request thread. + Returns the response data along with HTTP status code, headers, and other metadata. + For just the response data, use the corresponding ``update_node()`` method instead. + + Args: + body (:class:`~nipyapi.nifi.models.NodeEntity`): + The node configuration. The only configuration that will be honored at this endpoint is the status. (required) + id (str): + The node id. (required) + + Returns: + tuple: (:class:`~nipyapi.nifi.models.NodeEntity`, status_code, headers) - Response data with HTTP details. """ - all_params = ['body'] - all_params.append('callback') + all_params = ['body', 'id'] all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -1769,18 +3556,24 @@ def update_controller_config_with_http_info(self, body, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method update_controller_config" % key + " to method update_node" % 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 `update_controller_config`") - + raise ValueError("Missing the required parameter `body` when calling `update_node`") + # verify the required parameter 'id' is set + if ('id' not in params) or (params['id'] is None): + raise ValueError("Missing the required parameter `id` when calling `update_node`") + + collection_formats = {} path_params = {} + if 'id' in params: + path_params['id'] = params['id'] query_params = [] @@ -1801,73 +3594,65 @@ def update_controller_config_with_http_info(self, body, **kwargs): select_header_content_type(['application/json']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] - return self.api_client.call_api('/controller/config', 'PUT', + return self.api_client.call_api('/controller/cluster/nodes/{id}', 'PUT', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, - response_type='ControllerConfigurationEntity', + response_type='NodeEntity', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def update_flow_registry_client(self, id, body, **kwargs): + def update_run_status(self, body, id, **kwargs): """ - Updates a flow registry client + Updates run status of a flow analysis rule. + This method makes a synchronous HTTP request and returns the response data directly. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.update_flow_registry_client(id, body, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The flow registry client id. (required) - :param FlowRegistryClientEntity body: The flow registry client configuration details. (required) - :return: FlowRegistryClientEntity - If the method is called asynchronously, - returns the request thread. + For full HTTP response details (status code, headers, etc.), use the corresponding + ``update_run_status_with_http_info()`` method instead. + + Args: + body (:class:`~nipyapi.nifi.models.FlowAnalysisRuleRunStatusEntity`): + The flow analysis rule run status. (required) + id (str): + The flow analysis rule id. (required) + + Returns: + :class:`~nipyapi.nifi.models.FlowAnalysisRuleEntity`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.update_flow_registry_client_with_http_info(id, body, **kwargs) + return self.update_run_status_with_http_info(body, id, **kwargs) else: - (data) = self.update_flow_registry_client_with_http_info(id, body, **kwargs) + (data) = self.update_run_status_with_http_info(body, id, **kwargs) return data - def update_flow_registry_client_with_http_info(self, id, body, **kwargs): + def update_run_status_with_http_info(self, body, id, **kwargs): """ - Updates a flow registry client + Updates run status of a flow analysis rule. + This method makes a synchronous HTTP request and returns detailed response information. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.update_flow_registry_client_with_http_info(id, body, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The flow registry client id. (required) - :param FlowRegistryClientEntity body: The flow registry client configuration details. (required) - :return: FlowRegistryClientEntity - If the method is called asynchronously, - returns the request thread. + Returns the response data along with HTTP status code, headers, and other metadata. + For just the response data, use the corresponding ``update_run_status()`` method instead. + + Args: + body (:class:`~nipyapi.nifi.models.FlowAnalysisRuleRunStatusEntity`): + The flow analysis rule run status. (required) + id (str): + The flow analysis rule id. (required) + + Returns: + tuple: (:class:`~nipyapi.nifi.models.FlowAnalysisRuleEntity`, status_code, headers) - Response data with HTTP details. """ - all_params = ['id', 'body'] - all_params.append('callback') + all_params = ['body', 'id'] all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -1877,18 +3662,19 @@ def update_flow_registry_client_with_http_info(self, id, body, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method update_flow_registry_client" % key + " to method update_run_status" % key ) params[key] = val del params['kwargs'] - # verify the required parameter 'id' is set - if ('id' not in params) or (params['id'] is None): - raise ValueError("Missing the required parameter `id` when calling `update_flow_registry_client`") # verify the required parameter 'body' is set if ('body' not in params) or (params['body'] is None): - raise ValueError("Missing the required parameter `body` when calling `update_flow_registry_client`") - + raise ValueError("Missing the required parameter `body` when calling `update_run_status`") + # verify the required parameter 'id' is set + if ('id' not in params) or (params['id'] is None): + raise ValueError("Missing the required parameter `id` when calling `update_run_status`") + + collection_formats = {} path_params = {} @@ -1914,73 +3700,63 @@ def update_flow_registry_client_with_http_info(self, id, body, **kwargs): select_header_content_type(['application/json']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] - return self.api_client.call_api('/controller/registry-clients/{id}', 'PUT', + return self.api_client.call_api('/controller/flow-analysis-rules/{id}/run-status', 'PUT', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, - response_type='FlowRegistryClientEntity', + response_type='FlowAnalysisRuleEntity', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def update_node(self, id, body, **kwargs): + def upload_nar(self, body, **kwargs): """ - Updates a node in the cluster + Uploads a NAR and requests for it to be installed. + This method makes a synchronous HTTP request and returns the response data directly. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.update_node(id, body, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The node id. (required) - :param NodeEntity body: The node configuration. The only configuration that will be honored at this endpoint is the status. (required) - :return: NodeEntity - If the method is called asynchronously, - returns the request thread. + For full HTTP response details (status code, headers, etc.), use the corresponding + ``upload_nar_with_http_info()`` method instead. + + Args: + body (:class:`~nipyapi.nifi.models.object`): + The contents of the NAR file. (required) + filename (str): + + Returns: + :class:`~nipyapi.nifi.models.NarSummaryEntity`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.update_node_with_http_info(id, body, **kwargs) + return self.upload_nar_with_http_info(body, **kwargs) else: - (data) = self.update_node_with_http_info(id, body, **kwargs) + (data) = self.upload_nar_with_http_info(body, **kwargs) return data - def update_node_with_http_info(self, id, body, **kwargs): + def upload_nar_with_http_info(self, body, **kwargs): """ - Updates a node in the cluster + Uploads a NAR and requests for it to be installed. + This method makes a synchronous HTTP request and returns detailed response information. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.update_node_with_http_info(id, body, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The node id. (required) - :param NodeEntity body: The node configuration. The only configuration that will be honored at this endpoint is the status. (required) - :return: NodeEntity - If the method is called asynchronously, - returns the request thread. + Returns the response data along with HTTP status code, headers, and other metadata. + For just the response data, use the corresponding ``upload_nar()`` method instead. + + Args: + body (:class:`~nipyapi.nifi.models.object`): + The contents of the NAR file. (required) + filename (str): + + Returns: + tuple: (:class:`~nipyapi.nifi.models.NarSummaryEntity`, status_code, headers) - Response data with HTTP details. """ - all_params = ['id', 'body'] - all_params.append('callback') + all_params = ['body', 'filename'] all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -1990,27 +3766,25 @@ def update_node_with_http_info(self, id, body, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method update_node" % key + " to method upload_nar" % key ) params[key] = val del params['kwargs'] - # verify the required parameter 'id' is set - if ('id' not in params) or (params['id'] is None): - raise ValueError("Missing the required parameter `id` when calling `update_node`") # verify the required parameter 'body' is set if ('body' not in params) or (params['body'] is None): - raise ValueError("Missing the required parameter `body` when calling `update_node`") - + raise ValueError("Missing the required parameter `body` when calling `upload_nar`") + + collection_formats = {} path_params = {} - if 'id' in params: - path_params['id'] = params['id'] query_params = [] header_params = {} + if 'filename' in params: + header_params['Filename'] = params['filename'] form_params = [] local_var_files = {} @@ -2024,21 +3798,20 @@ def update_node_with_http_info(self, id, body, **kwargs): # HTTP header `Content-Type` header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['application/json']) + select_header_content_type(['application/octet-stream']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] - return self.api_client.call_api('/controller/cluster/nodes/{id}', 'PUT', + return self.api_client.call_api('/controller/nar-manager/nars/content', 'POST', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, - response_type='NodeEntity', + response_type='NarSummaryEntity', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), diff --git a/nipyapi/nifi/apis/controller_services_api.py b/nipyapi/nifi/apis/controller_services_api.py index 3a099eb4..6364fa51 100644 --- a/nipyapi/nifi/apis/controller_services_api.py +++ b/nipyapi/nifi/apis/controller_services_api.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - import sys import os import re @@ -33,56 +32,49 @@ def __init__(self, api_client=None): config.api_client = ApiClient() self.api_client = config.api_client - def analyze_configuration(self, id, body, **kwargs): + def analyze_configuration(self, body, id, **kwargs): """ - Performs analysis of the component's configuration, providing information about which attributes are referenced. + Performs analysis of the component's configuration, providing information about which attributes are referenced.. + 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 + ``analyze_configuration_with_http_info()`` method instead. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.analyze_configuration(id, body, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The controller service id. (required) - :param ConfigurationAnalysisEntity body: The configuration analysis request. (required) - :return: ConfigurationAnalysisEntity - If the method is called asynchronously, - returns the request thread. + Args: + body (:class:`~nipyapi.nifi.models.ConfigurationAnalysisEntity`): + The configuration analysis request. (required) + id (str): + The controller service id. (required) + + Returns: + :class:`~nipyapi.nifi.models.ConfigurationAnalysisEntity`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.analyze_configuration_with_http_info(id, body, **kwargs) + return self.analyze_configuration_with_http_info(body, id, **kwargs) else: - (data) = self.analyze_configuration_with_http_info(id, body, **kwargs) + (data) = self.analyze_configuration_with_http_info(body, id, **kwargs) return data - def analyze_configuration_with_http_info(self, id, body, **kwargs): + def analyze_configuration_with_http_info(self, body, id, **kwargs): """ - Performs analysis of the component's configuration, providing information about which attributes are referenced. + Performs analysis of the component's configuration, providing information about which attributes are referenced.. + This method makes a synchronous HTTP request and returns detailed response information. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.analyze_configuration_with_http_info(id, body, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The controller service id. (required) - :param ConfigurationAnalysisEntity body: The configuration analysis request. (required) - :return: ConfigurationAnalysisEntity - If the method is called asynchronously, - returns the request thread. + Returns the response data along with HTTP status code, headers, and other metadata. + For just the response data, use the corresponding ``analyze_configuration()`` method instead. + + Args: + body (:class:`~nipyapi.nifi.models.ConfigurationAnalysisEntity`): + The configuration analysis request. (required) + id (str): + The controller service id. (required) + + Returns: + tuple: (:class:`~nipyapi.nifi.models.ConfigurationAnalysisEntity`, status_code, headers) - Response data with HTTP details. """ - all_params = ['id', 'body'] - all_params.append('callback') + all_params = ['body', 'id'] all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -96,14 +88,15 @@ def analyze_configuration_with_http_info(self, id, body, **kwargs): ) 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 `analyze_configuration`") # 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 `analyze_configuration`") + # 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 `analyze_configuration`") - + + collection_formats = {} path_params = {} @@ -129,7 +122,7 @@ def analyze_configuration_with_http_info(self, id, body, **kwargs): select_header_content_type(['application/json']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/controller-services/{id}/config/analysis', 'POST', path_params, @@ -140,60 +133,50 @@ def analyze_configuration_with_http_info(self, id, body, **kwargs): files=local_var_files, response_type='ConfigurationAnalysisEntity', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def clear_state(self, id, **kwargs): + def clear_state1(self, id, **kwargs): """ - Clears the state for a controller service + Clears the state for a controller service. + This method makes a synchronous HTTP request and returns the response data directly. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.clear_state(id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The controller service id. (required) - :return: ComponentStateEntity - If the method is called asynchronously, - returns the request thread. + For full HTTP response details (status code, headers, etc.), use the corresponding + ``clear_state1_with_http_info()`` method instead. + + Args: + id (str): + The controller service id. (required) + + Returns: + :class:`~nipyapi.nifi.models.ComponentStateEntity`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.clear_state_with_http_info(id, **kwargs) + return self.clear_state1_with_http_info(id, **kwargs) else: - (data) = self.clear_state_with_http_info(id, **kwargs) + (data) = self.clear_state1_with_http_info(id, **kwargs) return data - def clear_state_with_http_info(self, id, **kwargs): + def clear_state1_with_http_info(self, id, **kwargs): """ - Clears the state for a controller service + Clears the state for a controller service. + 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 ``clear_state1()`` method instead. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.clear_state_with_http_info(id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The controller service id. (required) - :return: ComponentStateEntity - If the method is called asynchronously, - returns the request thread. + Args: + id (str): + The controller service id. (required) + + Returns: + tuple: (:class:`~nipyapi.nifi.models.ComponentStateEntity`, status_code, headers) - Response data with HTTP details. """ all_params = ['id'] - all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -203,15 +186,15 @@ def clear_state_with_http_info(self, id, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method clear_state" % key + " to method clear_state1" % 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 `clear_state`") - + raise ValueError("Missing the required parameter `id` when calling `clear_state1`") + collection_formats = {} path_params = {} @@ -230,12 +213,8 @@ def clear_state_with_http_info(self, id, **kwargs): header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['*/*']) - # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/controller-services/{id}/state/clear-requests', 'POST', path_params, @@ -246,7 +225,6 @@ def clear_state_with_http_info(self, id, **kwargs): files=local_var_files, response_type='ComponentStateEntity', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), @@ -254,23 +232,23 @@ def clear_state_with_http_info(self, id, **kwargs): def delete_verification_request(self, id, request_id, **kwargs): """ - Deletes the Verification Request with the given ID + Deletes the Verification Request with the given ID. + Deletes the Verification Request with the given ID. After a request is created, it is expected that the client will properly clean up the request by DELETE'ing it, once the Verification process has completed. If the request is deleted before the request completes, then the Verification request will finish the step that it is currently performing and then will cancel any subsequent steps. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.delete_verification_request(id, request_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The ID of the Controller Service (required) - :param str request_id: The ID of the Verification Request (required) - :return: VerifyConfigRequestEntity - If the method is called asynchronously, - returns the request thread. + + 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_verification_request_with_http_info()`` method instead. + + Args: + id (str): + The ID of the Controller Service (required) + request_id (str): + The ID of the Verification Request (required) + + Returns: + :class:`~nipyapi.nifi.models.VerifyConfigRequestEntity`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): @@ -281,27 +259,26 @@ def delete_verification_request(self, id, request_id, **kwargs): def delete_verification_request_with_http_info(self, id, request_id, **kwargs): """ - Deletes the Verification Request with the given ID + Deletes the Verification Request with the given ID. + Deletes the Verification Request with the given ID. After a request is created, it is expected that the client will properly clean up the request by DELETE'ing it, once the Verification process has completed. If the request is deleted before the request completes, then the Verification request will finish the step that it is currently performing and then will cancel any subsequent steps. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.delete_verification_request_with_http_info(id, request_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The ID of the Controller Service (required) - :param str request_id: The ID of the Verification Request (required) - :return: VerifyConfigRequestEntity - If the method is called asynchronously, - returns the request thread. + + 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_verification_request()`` method instead. + + Args: + id (str): + The ID of the Controller Service (required) + request_id (str): + The ID of the Verification Request (required) + + Returns: + tuple: (:class:`~nipyapi.nifi.models.VerifyConfigRequestEntity`, status_code, headers) - Response data with HTTP details. """ all_params = ['id', 'request_id'] - all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -322,7 +299,8 @@ def delete_verification_request_with_http_info(self, id, request_id, **kwargs): if ('request_id' not in params) or (params['request_id'] is None): raise ValueError("Missing the required parameter `request_id` when calling `delete_verification_request`") - + + collection_formats = {} path_params = {} @@ -343,12 +321,8 @@ def delete_verification_request_with_http_info(self, id, request_id, **kwargs): header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['*/*']) - # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/controller-services/{id}/config/verification-requests/{requestId}', 'DELETE', path_params, @@ -359,7 +333,6 @@ def delete_verification_request_with_http_info(self, id, request_id, **kwargs): files=local_var_files, response_type='VerifyConfigRequestEntity', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), @@ -367,23 +340,22 @@ def delete_verification_request_with_http_info(self, id, request_id, **kwargs): def get_controller_service(self, id, **kwargs): """ - Gets a controller service + Gets a controller service. + If the uiOnly query parameter is provided with a value of true, the returned entity may only contain fields that are necessary for rendering the NiFi User Interface. As such, the selected fields may change at any time, even during incremental releases, without warning. As a result, this parameter should not be provided by any client other than the UI. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_controller_service(id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The controller service id. (required) - :param bool ui_only: - :return: ControllerServiceEntity - If the method is called asynchronously, - returns the request thread. + + 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_controller_service_with_http_info()`` method instead. + + Args: + id (str): + The controller service id. (required) + ui_only (bool): + + Returns: + :class:`~nipyapi.nifi.models.ControllerServiceEntity`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): @@ -394,27 +366,25 @@ def get_controller_service(self, id, **kwargs): def get_controller_service_with_http_info(self, id, **kwargs): """ - Gets a controller service + Gets a controller service. + If the uiOnly query parameter is provided with a value of true, the returned entity may only contain fields that are necessary for rendering the NiFi User Interface. As such, the selected fields may change at any time, even during incremental releases, without warning. As a result, this parameter should not be provided by any client other than the UI. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_controller_service_with_http_info(id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The controller service id. (required) - :param bool ui_only: - :return: ControllerServiceEntity - If the method is called asynchronously, - returns the request thread. + + 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_controller_service()`` method instead. + + Args: + id (str): + The controller service id. (required) + ui_only (bool): + + Returns: + tuple: (:class:`~nipyapi.nifi.models.ControllerServiceEntity`, status_code, headers) - Response data with HTTP details. """ all_params = ['id', 'ui_only'] - all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -432,7 +402,8 @@ def get_controller_service_with_http_info(self, id, **kwargs): if ('id' not in params) or (params['id'] is None): raise ValueError("Missing the required parameter `id` when calling `get_controller_service`") - + + collection_formats = {} path_params = {} @@ -453,12 +424,8 @@ def get_controller_service_with_http_info(self, id, **kwargs): header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['*/*']) - # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/controller-services/{id}', 'GET', path_params, @@ -469,7 +436,6 @@ def get_controller_service_with_http_info(self, id, **kwargs): files=local_var_files, response_type='ControllerServiceEntity', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), @@ -477,22 +443,18 @@ def get_controller_service_with_http_info(self, id, **kwargs): def get_controller_service_references(self, id, **kwargs): """ - Gets a controller service + Gets a controller service. + 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_controller_service_references_with_http_info()`` method instead. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_controller_service_references(id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The controller service id. (required) - :return: ControllerServiceReferencingComponentsEntity - If the method is called asynchronously, - returns the request thread. + Args: + id (str): + The controller service id. (required) + + Returns: + :class:`~nipyapi.nifi.models.ControllerServiceReferencingComponentsEntity`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): @@ -503,26 +465,21 @@ def get_controller_service_references(self, id, **kwargs): def get_controller_service_references_with_http_info(self, id, **kwargs): """ - Gets a controller service + Gets a controller service. + This method makes a synchronous HTTP request and returns detailed response information. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_controller_service_references_with_http_info(id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The controller service id. (required) - :return: ControllerServiceReferencingComponentsEntity - If the method is called asynchronously, - returns the request thread. + Returns the response data along with HTTP status code, headers, and other metadata. + For just the response data, use the corresponding ``get_controller_service_references()`` method instead. + + Args: + id (str): + The controller service id. (required) + + Returns: + tuple: (:class:`~nipyapi.nifi.models.ControllerServiceReferencingComponentsEntity`, status_code, headers) - Response data with HTTP details. """ all_params = ['id'] - all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -540,7 +497,7 @@ def get_controller_service_references_with_http_info(self, id, **kwargs): if ('id' not in params) or (params['id'] is None): raise ValueError("Missing the required parameter `id` when calling `get_controller_service_references`") - + collection_formats = {} path_params = {} @@ -559,12 +516,8 @@ def get_controller_service_references_with_http_info(self, id, **kwargs): header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['*/*']) - # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/controller-services/{id}/references', 'GET', path_params, @@ -575,64 +528,58 @@ def get_controller_service_references_with_http_info(self, id, **kwargs): files=local_var_files, response_type='ControllerServiceReferencingComponentsEntity', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def get_property_descriptor(self, id, property_name, **kwargs): + def get_property_descriptor1(self, id, property_name, **kwargs): """ - Gets a controller service property descriptor + Gets a controller service property descriptor. + This method makes a synchronous HTTP request and returns the response data directly. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_property_descriptor(id, property_name, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The controller service id. (required) - :param str property_name: The property name to return the descriptor for. (required) - :param bool sensitive: Property Descriptor requested sensitive status - :return: PropertyDescriptorEntity - If the method is called asynchronously, - returns the request thread. + For full HTTP response details (status code, headers, etc.), use the corresponding + ``get_property_descriptor1_with_http_info()`` method instead. + + Args: + id (str): + The controller service id. (required) + property_name (str): + The property name to return the descriptor for. (required) + sensitive (bool): + Property Descriptor requested sensitive status + + Returns: + :class:`~nipyapi.nifi.models.PropertyDescriptorEntity`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.get_property_descriptor_with_http_info(id, property_name, **kwargs) + return self.get_property_descriptor1_with_http_info(id, property_name, **kwargs) else: - (data) = self.get_property_descriptor_with_http_info(id, property_name, **kwargs) + (data) = self.get_property_descriptor1_with_http_info(id, property_name, **kwargs) return data - def get_property_descriptor_with_http_info(self, id, property_name, **kwargs): + def get_property_descriptor1_with_http_info(self, id, property_name, **kwargs): """ - Gets a controller service property descriptor + Gets a controller service property descriptor. + 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_property_descriptor1()`` method instead. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_property_descriptor_with_http_info(id, property_name, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The controller service id. (required) - :param str property_name: The property name to return the descriptor for. (required) - :param bool sensitive: Property Descriptor requested sensitive status - :return: PropertyDescriptorEntity - If the method is called asynchronously, - returns the request thread. + Args: + id (str): + The controller service id. (required) + property_name (str): + The property name to return the descriptor for. (required) + sensitive (bool): + Property Descriptor requested sensitive status + + Returns: + tuple: (:class:`~nipyapi.nifi.models.PropertyDescriptorEntity`, status_code, headers) - Response data with HTTP details. """ all_params = ['id', 'property_name', 'sensitive'] - all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -642,18 +589,20 @@ def get_property_descriptor_with_http_info(self, id, property_name, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method get_property_descriptor" % key + " to method get_property_descriptor1" % 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_property_descriptor`") + raise ValueError("Missing the required parameter `id` when calling `get_property_descriptor1`") # verify the required parameter 'property_name' is set if ('property_name' not in params) or (params['property_name'] is None): - raise ValueError("Missing the required parameter `property_name` when calling `get_property_descriptor`") - + raise ValueError("Missing the required parameter `property_name` when calling `get_property_descriptor1`") + + + collection_formats = {} path_params = {} @@ -676,12 +625,8 @@ def get_property_descriptor_with_http_info(self, id, property_name, **kwargs): header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['*/*']) - # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/controller-services/{id}/descriptors', 'GET', path_params, @@ -692,7 +637,6 @@ def get_property_descriptor_with_http_info(self, id, property_name, **kwargs): files=local_var_files, response_type='PropertyDescriptorEntity', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), @@ -700,22 +644,18 @@ def get_property_descriptor_with_http_info(self, id, property_name, **kwargs): def get_state(self, id, **kwargs): """ - Gets the state for a controller service + Gets the state for a controller service. + 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_state_with_http_info()`` method instead. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_state(id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The controller service id. (required) - :return: ComponentStateEntity - If the method is called asynchronously, - returns the request thread. + Args: + id (str): + The controller service id. (required) + + Returns: + :class:`~nipyapi.nifi.models.ComponentStateEntity`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): @@ -726,26 +666,21 @@ def get_state(self, id, **kwargs): def get_state_with_http_info(self, id, **kwargs): """ - Gets the state for a controller service + Gets the state for a controller service. + This method makes a synchronous HTTP request and returns detailed response information. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_state_with_http_info(id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The controller service id. (required) - :return: ComponentStateEntity - If the method is called asynchronously, - returns the request thread. + Returns the response data along with HTTP status code, headers, and other metadata. + For just the response data, use the corresponding ``get_state()`` method instead. + + Args: + id (str): + The controller service id. (required) + + Returns: + tuple: (:class:`~nipyapi.nifi.models.ComponentStateEntity`, status_code, headers) - Response data with HTTP details. """ all_params = ['id'] - all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -763,7 +698,7 @@ def get_state_with_http_info(self, id, **kwargs): if ('id' not in params) or (params['id'] is None): raise ValueError("Missing the required parameter `id` when calling `get_state`") - + collection_formats = {} path_params = {} @@ -782,12 +717,8 @@ def get_state_with_http_info(self, id, **kwargs): header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['*/*']) - # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/controller-services/{id}/state', 'GET', path_params, @@ -798,7 +729,6 @@ def get_state_with_http_info(self, id, **kwargs): files=local_var_files, response_type='ComponentStateEntity', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), @@ -806,23 +736,23 @@ def get_state_with_http_info(self, id, **kwargs): def get_verification_request(self, id, request_id, **kwargs): """ - Returns the Verification Request with the given ID + Returns the Verification Request with the given ID. + Returns the Verification Request with the given ID. Once an Verification Request has been created, that request can subsequently be retrieved via this endpoint, and the request that is fetched will contain the updated state, such as percent complete, the current state of the request, and any failures. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_verification_request(id, request_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The ID of the Controller Service (required) - :param str request_id: The ID of the Verification Request (required) - :return: VerifyConfigRequestEntity - If the method is called asynchronously, - returns the request thread. + + 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_verification_request_with_http_info()`` method instead. + + Args: + id (str): + The ID of the Controller Service (required) + request_id (str): + The ID of the Verification Request (required) + + Returns: + :class:`~nipyapi.nifi.models.VerifyConfigRequestEntity`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): @@ -833,27 +763,26 @@ def get_verification_request(self, id, request_id, **kwargs): def get_verification_request_with_http_info(self, id, request_id, **kwargs): """ - Returns the Verification Request with the given ID + Returns the Verification Request with the given ID. + Returns the Verification Request with the given ID. Once an Verification Request has been created, that request can subsequently be retrieved via this endpoint, and the request that is fetched will contain the updated state, such as percent complete, the current state of the request, and any failures. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_verification_request_with_http_info(id, request_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The ID of the Controller Service (required) - :param str request_id: The ID of the Verification Request (required) - :return: VerifyConfigRequestEntity - If the method is called asynchronously, - returns the request thread. + + 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_verification_request()`` method instead. + + Args: + id (str): + The ID of the Controller Service (required) + request_id (str): + The ID of the Verification Request (required) + + Returns: + tuple: (:class:`~nipyapi.nifi.models.VerifyConfigRequestEntity`, status_code, headers) - Response data with HTTP details. """ all_params = ['id', 'request_id'] - all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -874,7 +803,8 @@ def get_verification_request_with_http_info(self, id, request_id, **kwargs): if ('request_id' not in params) or (params['request_id'] is None): raise ValueError("Missing the required parameter `request_id` when calling `get_verification_request`") - + + collection_formats = {} path_params = {} @@ -895,12 +825,8 @@ def get_verification_request_with_http_info(self, id, request_id, **kwargs): header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['*/*']) - # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/controller-services/{id}/config/verification-requests/{requestId}', 'GET', path_params, @@ -911,7 +837,6 @@ def get_verification_request_with_http_info(self, id, request_id, **kwargs): files=local_var_files, response_type='VerifyConfigRequestEntity', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), @@ -919,25 +844,24 @@ def get_verification_request_with_http_info(self, id, request_id, **kwargs): def remove_controller_service(self, id, **kwargs): """ - Deletes a controller service + Deletes a controller service. + This method makes a synchronous HTTP request and returns the response data directly. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.remove_controller_service(id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The controller service id. (required) - :param str version: The revision is used to verify the client is working with the latest version of the flow. - :param str client_id: If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response. - :param bool disconnected_node_acknowledged: Acknowledges that this node is disconnected to allow for mutable requests to proceed. - :return: ControllerServiceEntity - If the method is called asynchronously, - returns the request thread. + For full HTTP response details (status code, headers, etc.), use the corresponding + ``remove_controller_service_with_http_info()`` method instead. + + Args: + id (str): + The controller service 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.ControllerServiceEntity`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): @@ -948,29 +872,27 @@ def remove_controller_service(self, id, **kwargs): def remove_controller_service_with_http_info(self, id, **kwargs): """ - Deletes a controller service + Deletes a controller service. + 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 ``remove_controller_service()`` method instead. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.remove_controller_service_with_http_info(id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The controller service id. (required) - :param str version: The revision is used to verify the client is working with the latest version of the flow. - :param str client_id: If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response. - :param bool disconnected_node_acknowledged: Acknowledges that this node is disconnected to allow for mutable requests to proceed. - :return: ControllerServiceEntity - If the method is called asynchronously, - returns the request thread. + Args: + id (str): + The controller service 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.ControllerServiceEntity`, status_code, headers) - Response data with HTTP details. """ all_params = ['id', 'version', 'client_id', 'disconnected_node_acknowledged'] - all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -988,7 +910,10 @@ def remove_controller_service_with_http_info(self, id, **kwargs): if ('id' not in params) or (params['id'] is None): raise ValueError("Missing the required parameter `id` when calling `remove_controller_service`") - + + + + collection_formats = {} path_params = {} @@ -1013,12 +938,8 @@ def remove_controller_service_with_http_info(self, id, **kwargs): header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['*/*']) - # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/controller-services/{id}', 'DELETE', path_params, @@ -1029,62 +950,60 @@ def remove_controller_service_with_http_info(self, id, **kwargs): files=local_var_files, response_type='ControllerServiceEntity', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def submit_config_verification_request(self, id, body, **kwargs): + def submit_config_verification_request(self, body, id, **kwargs): """ - Performs verification of the Controller Service's configuration + Performs verification of the Controller Service's configuration. + This will initiate the process of verifying a given Controller Service configuration. This may be a long-running task. As a result, this endpoint will immediately return a ControllerServiceConfigVerificationRequestEntity, and the process of performing the verification will occur asynchronously in the background. The client may then periodically poll the status of the request by issuing a GET request to /controller-services/{serviceId}/verification-requests/{requestId}. Once the request is completed, the client is expected to issue a DELETE request to /controller-services/{serviceId}/verification-requests/{requestId}. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.submit_config_verification_request(id, body, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The controller service id. (required) - :param VerifyConfigRequestEntity body: The controller service configuration verification request. (required) - :return: VerifyConfigRequestEntity - If the method is called asynchronously, - returns the request thread. + + 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_config_verification_request_with_http_info()`` method instead. + + Args: + body (:class:`~nipyapi.nifi.models.VerifyConfigRequestEntity`): + The controller service configuration verification request. (required) + id (str): + The controller service id. (required) + + Returns: + :class:`~nipyapi.nifi.models.VerifyConfigRequestEntity`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.submit_config_verification_request_with_http_info(id, body, **kwargs) + return self.submit_config_verification_request_with_http_info(body, id, **kwargs) else: - (data) = self.submit_config_verification_request_with_http_info(id, body, **kwargs) + (data) = self.submit_config_verification_request_with_http_info(body, id, **kwargs) return data - def submit_config_verification_request_with_http_info(self, id, body, **kwargs): + def submit_config_verification_request_with_http_info(self, body, id, **kwargs): """ - Performs verification of the Controller Service's configuration + Performs verification of the Controller Service's configuration. + This will initiate the process of verifying a given Controller Service configuration. This may be a long-running task. As a result, this endpoint will immediately return a ControllerServiceConfigVerificationRequestEntity, and the process of performing the verification will occur asynchronously in the background. The client may then periodically poll the status of the request by issuing a GET request to /controller-services/{serviceId}/verification-requests/{requestId}. Once the request is completed, the client is expected to issue a DELETE request to /controller-services/{serviceId}/verification-requests/{requestId}. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.submit_config_verification_request_with_http_info(id, body, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The controller service id. (required) - :param VerifyConfigRequestEntity body: The controller service configuration verification request. (required) - :return: VerifyConfigRequestEntity - If the method is called asynchronously, - returns the request thread. + + 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_config_verification_request()`` method instead. + + Args: + body (:class:`~nipyapi.nifi.models.VerifyConfigRequestEntity`): + The controller service configuration verification request. (required) + id (str): + The controller service id. (required) + + Returns: + tuple: (:class:`~nipyapi.nifi.models.VerifyConfigRequestEntity`, status_code, headers) - Response data with HTTP details. """ - all_params = ['id', 'body'] - all_params.append('callback') + all_params = ['body', 'id'] all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -1098,14 +1017,15 @@ def submit_config_verification_request_with_http_info(self, id, body, **kwargs): ) 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_config_verification_request`") # verify the required parameter 'body' is set if ('body' not in params) or (params['body'] is None): raise ValueError("Missing the required parameter `body` when calling `submit_config_verification_request`") + # verify the required parameter 'id' is set + if ('id' not in params) or (params['id'] is None): + raise ValueError("Missing the required parameter `id` when calling `submit_config_verification_request`") - + + collection_formats = {} path_params = {} @@ -1131,7 +1051,7 @@ def submit_config_verification_request_with_http_info(self, id, body, **kwargs): select_header_content_type(['application/json']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/controller-services/{id}/config/verification-requests', 'POST', path_params, @@ -1142,62 +1062,54 @@ def submit_config_verification_request_with_http_info(self, id, body, **kwargs): files=local_var_files, response_type='VerifyConfigRequestEntity', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def update_controller_service(self, id, body, **kwargs): + def update_controller_service(self, body, id, **kwargs): """ - Updates a controller service + Updates a controller service. + This method makes a synchronous HTTP request and returns the response data directly. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.update_controller_service(id, body, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The controller service id. (required) - :param ControllerServiceEntity body: The controller service configuration details. (required) - :return: ControllerServiceEntity - If the method is called asynchronously, - returns the request thread. + For full HTTP response details (status code, headers, etc.), use the corresponding + ``update_controller_service_with_http_info()`` method instead. + + Args: + body (:class:`~nipyapi.nifi.models.ControllerServiceEntity`): + The controller service configuration details. (required) + id (str): + The controller service id. (required) + + Returns: + :class:`~nipyapi.nifi.models.ControllerServiceEntity`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.update_controller_service_with_http_info(id, body, **kwargs) + return self.update_controller_service_with_http_info(body, id, **kwargs) else: - (data) = self.update_controller_service_with_http_info(id, body, **kwargs) + (data) = self.update_controller_service_with_http_info(body, id, **kwargs) return data - def update_controller_service_with_http_info(self, id, body, **kwargs): + def update_controller_service_with_http_info(self, body, id, **kwargs): """ - Updates a controller service + Updates a controller service. + 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 ``update_controller_service()`` method instead. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.update_controller_service_with_http_info(id, body, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The controller service id. (required) - :param ControllerServiceEntity body: The controller service configuration details. (required) - :return: ControllerServiceEntity - If the method is called asynchronously, - returns the request thread. + Args: + body (:class:`~nipyapi.nifi.models.ControllerServiceEntity`): + The controller service configuration details. (required) + id (str): + The controller service id. (required) + + Returns: + tuple: (:class:`~nipyapi.nifi.models.ControllerServiceEntity`, status_code, headers) - Response data with HTTP details. """ - all_params = ['id', 'body'] - all_params.append('callback') + all_params = ['body', 'id'] all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -1211,14 +1123,15 @@ def update_controller_service_with_http_info(self, id, body, **kwargs): ) params[key] = val del params['kwargs'] - # verify the required parameter 'id' is set - if ('id' not in params) or (params['id'] is None): - raise ValueError("Missing the required parameter `id` when calling `update_controller_service`") # verify the required parameter 'body' is set if ('body' not in params) or (params['body'] is None): raise ValueError("Missing the required parameter `body` when calling `update_controller_service`") + # verify the required parameter 'id' is set + if ('id' not in params) or (params['id'] is None): + raise ValueError("Missing the required parameter `id` when calling `update_controller_service`") - + + collection_formats = {} path_params = {} @@ -1244,7 +1157,7 @@ def update_controller_service_with_http_info(self, id, body, **kwargs): select_header_content_type(['application/json']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/controller-services/{id}', 'PUT', path_params, @@ -1255,62 +1168,54 @@ def update_controller_service_with_http_info(self, id, body, **kwargs): files=local_var_files, response_type='ControllerServiceEntity', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def update_controller_service_references(self, id, body, **kwargs): + def update_controller_service_references(self, body, id, **kwargs): """ - Updates a controller services references + Updates a controller services references. + 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 + ``update_controller_service_references_with_http_info()`` method instead. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.update_controller_service_references(id, body, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The controller service id. (required) - :param UpdateControllerServiceReferenceRequestEntity body: The controller service request update request. (required) - :return: ControllerServiceReferencingComponentsEntity - If the method is called asynchronously, - returns the request thread. + Args: + body (:class:`~nipyapi.nifi.models.UpdateControllerServiceReferenceRequestEntity`): + The controller service request update request. (required) + id (str): + The controller service id. (required) + + Returns: + :class:`~nipyapi.nifi.models.ControllerServiceReferencingComponentsEntity`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.update_controller_service_references_with_http_info(id, body, **kwargs) + return self.update_controller_service_references_with_http_info(body, id, **kwargs) else: - (data) = self.update_controller_service_references_with_http_info(id, body, **kwargs) + (data) = self.update_controller_service_references_with_http_info(body, id, **kwargs) return data - def update_controller_service_references_with_http_info(self, id, body, **kwargs): + def update_controller_service_references_with_http_info(self, body, id, **kwargs): """ - Updates a controller services references + Updates a controller services references. + 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 ``update_controller_service_references()`` method instead. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.update_controller_service_references_with_http_info(id, body, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The controller service id. (required) - :param UpdateControllerServiceReferenceRequestEntity body: The controller service request update request. (required) - :return: ControllerServiceReferencingComponentsEntity - If the method is called asynchronously, - returns the request thread. + Args: + body (:class:`~nipyapi.nifi.models.UpdateControllerServiceReferenceRequestEntity`): + The controller service request update request. (required) + id (str): + The controller service id. (required) + + Returns: + tuple: (:class:`~nipyapi.nifi.models.ControllerServiceReferencingComponentsEntity`, status_code, headers) - Response data with HTTP details. """ - all_params = ['id', 'body'] - all_params.append('callback') + all_params = ['body', 'id'] all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -1324,14 +1229,15 @@ def update_controller_service_references_with_http_info(self, id, body, **kwargs ) params[key] = val del params['kwargs'] - # verify the required parameter 'id' is set - if ('id' not in params) or (params['id'] is None): - raise ValueError("Missing the required parameter `id` when calling `update_controller_service_references`") # verify the required parameter 'body' is set if ('body' not in params) or (params['body'] is None): raise ValueError("Missing the required parameter `body` when calling `update_controller_service_references`") + # verify the required parameter 'id' is set + if ('id' not in params) or (params['id'] is None): + raise ValueError("Missing the required parameter `id` when calling `update_controller_service_references`") - + + collection_formats = {} path_params = {} @@ -1357,7 +1263,7 @@ def update_controller_service_references_with_http_info(self, id, body, **kwargs select_header_content_type(['application/json']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/controller-services/{id}/references', 'PUT', path_params, @@ -1368,62 +1274,54 @@ def update_controller_service_references_with_http_info(self, id, body, **kwargs files=local_var_files, response_type='ControllerServiceReferencingComponentsEntity', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def update_run_status(self, id, body, **kwargs): + def update_run_status1(self, body, id, **kwargs): """ - Updates run status of a controller service + Updates run status of a controller service. + This method makes a synchronous HTTP request and returns the response data directly. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.update_run_status(id, body, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The controller service id. (required) - :param ControllerServiceRunStatusEntity body: The controller service run status. (required) - :return: ControllerServiceEntity - If the method is called asynchronously, - returns the request thread. + For full HTTP response details (status code, headers, etc.), use the corresponding + ``update_run_status1_with_http_info()`` method instead. + + Args: + body (:class:`~nipyapi.nifi.models.ControllerServiceRunStatusEntity`): + The controller service run status. (required) + id (str): + The controller service id. (required) + + Returns: + :class:`~nipyapi.nifi.models.ControllerServiceEntity`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.update_run_status_with_http_info(id, body, **kwargs) + return self.update_run_status1_with_http_info(body, id, **kwargs) else: - (data) = self.update_run_status_with_http_info(id, body, **kwargs) + (data) = self.update_run_status1_with_http_info(body, id, **kwargs) return data - def update_run_status_with_http_info(self, id, body, **kwargs): + def update_run_status1_with_http_info(self, body, id, **kwargs): """ - Updates run status of a controller service + Updates run status of a controller service. + 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 ``update_run_status1()`` method instead. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.update_run_status_with_http_info(id, body, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The controller service id. (required) - :param ControllerServiceRunStatusEntity body: The controller service run status. (required) - :return: ControllerServiceEntity - If the method is called asynchronously, - returns the request thread. + Args: + body (:class:`~nipyapi.nifi.models.ControllerServiceRunStatusEntity`): + The controller service run status. (required) + id (str): + The controller service id. (required) + + Returns: + tuple: (:class:`~nipyapi.nifi.models.ControllerServiceEntity`, status_code, headers) - Response data with HTTP details. """ - all_params = ['id', 'body'] - all_params.append('callback') + all_params = ['body', 'id'] all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -1433,18 +1331,19 @@ def update_run_status_with_http_info(self, id, body, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method update_run_status" % key + " to method update_run_status1" % key ) params[key] = val del params['kwargs'] - # verify the required parameter 'id' is set - if ('id' not in params) or (params['id'] is None): - raise ValueError("Missing the required parameter `id` when calling `update_run_status`") # verify the required parameter 'body' is set if ('body' not in params) or (params['body'] is None): - raise ValueError("Missing the required parameter `body` when calling `update_run_status`") - + raise ValueError("Missing the required parameter `body` when calling `update_run_status1`") + # verify the required parameter 'id' is set + if ('id' not in params) or (params['id'] is None): + raise ValueError("Missing the required parameter `id` when calling `update_run_status1`") + + collection_formats = {} path_params = {} @@ -1470,7 +1369,7 @@ def update_run_status_with_http_info(self, id, body, **kwargs): select_header_content_type(['application/json']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/controller-services/{id}/run-status', 'PUT', path_params, @@ -1481,7 +1380,6 @@ def update_run_status_with_http_info(self, id, body, **kwargs): files=local_var_files, response_type='ControllerServiceEntity', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), diff --git a/nipyapi/nifi/apis/counters_api.py b/nipyapi/nifi/apis/counters_api.py index de0ed8a1..a69524ad 100644 --- a/nipyapi/nifi/apis/counters_api.py +++ b/nipyapi/nifi/apis/counters_api.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - import sys import os import re @@ -35,23 +34,23 @@ def __init__(self, api_client=None): def get_counters(self, **kwargs): """ - Gets the current counters for this NiFi + Gets the current counters for this NiFi. + Note: This endpoint is subject to change as NiFi and it's REST API evolve. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_counters(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param bool nodewise: Whether or not to include the breakdown per node. Optional, defaults to false - :param str cluster_node_id: The id of the node where to get the status. - :return: CountersEntity - If the method is called asynchronously, - returns the request thread. + + 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_counters_with_http_info()`` method instead. + + Args: + nodewise (bool): + Whether or not to include the breakdown per node. Optional, defaults to false + cluster_node_id (str): + The id of the node where to get the status. + + Returns: + :class:`~nipyapi.nifi.models.CountersEntity`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): @@ -62,27 +61,26 @@ def get_counters(self, **kwargs): def get_counters_with_http_info(self, **kwargs): """ - Gets the current counters for this NiFi + Gets the current counters for this NiFi. + Note: This endpoint is subject to change as NiFi and it's REST API evolve. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_counters_with_http_info(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param bool nodewise: Whether or not to include the breakdown per node. Optional, defaults to false - :param str cluster_node_id: The id of the node where to get the status. - :return: CountersEntity - If the method is called asynchronously, - returns the request thread. + + 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_counters()`` method instead. + + Args: + nodewise (bool): + Whether or not to include the breakdown per node. Optional, defaults to false + cluster_node_id (str): + The id of the node where to get the status. + + Returns: + tuple: (:class:`~nipyapi.nifi.models.CountersEntity`, status_code, headers) - Response data with HTTP details. """ all_params = ['nodewise', 'cluster_node_id'] - all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -97,7 +95,8 @@ def get_counters_with_http_info(self, **kwargs): params[key] = val del params['kwargs'] - + + collection_formats = {} path_params = {} @@ -118,12 +117,8 @@ def get_counters_with_http_info(self, **kwargs): header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['*/*']) - # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/counters', 'GET', path_params, @@ -134,7 +129,6 @@ def get_counters_with_http_info(self, **kwargs): files=local_var_files, response_type='CountersEntity', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), @@ -142,22 +136,21 @@ def get_counters_with_http_info(self, **kwargs): def update_counter(self, id, **kwargs): """ - Updates the specified counter. This will reset the counter value to 0 + Updates the specified counter. This will reset the counter value to 0. + Note: This endpoint is subject to change as NiFi and it's REST API evolve. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.update_counter(id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The id of the counter. (required) - :return: CounterEntity - If the method is called asynchronously, - returns the request thread. + + 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 + ``update_counter_with_http_info()`` method instead. + + Args: + id (str): + The id of the counter. (required) + + Returns: + :class:`~nipyapi.nifi.models.CounterEntity`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): @@ -168,26 +161,24 @@ def update_counter(self, id, **kwargs): def update_counter_with_http_info(self, id, **kwargs): """ - Updates the specified counter. This will reset the counter value to 0 + Updates the specified counter. This will reset the counter value to 0. + Note: This endpoint is subject to change as NiFi and it's REST API evolve. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.update_counter_with_http_info(id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The id of the counter. (required) - :return: CounterEntity - If the method is called asynchronously, - returns the request thread. + + 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 ``update_counter()`` method instead. + + Args: + id (str): + The id of the counter. (required) + + Returns: + tuple: (:class:`~nipyapi.nifi.models.CounterEntity`, status_code, headers) - Response data with HTTP details. """ all_params = ['id'] - all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -205,7 +196,7 @@ def update_counter_with_http_info(self, id, **kwargs): if ('id' not in params) or (params['id'] is None): raise ValueError("Missing the required parameter `id` when calling `update_counter`") - + collection_formats = {} path_params = {} @@ -224,12 +215,8 @@ def update_counter_with_http_info(self, id, **kwargs): header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['*/*']) - # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/counters/{id}', 'PUT', path_params, @@ -240,7 +227,6 @@ def update_counter_with_http_info(self, id, **kwargs): files=local_var_files, response_type='CounterEntity', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), diff --git a/nipyapi/nifi/apis/data_transfer_api.py b/nipyapi/nifi/apis/data_transfer_api.py index d58b63e5..99ed28db 100644 --- a/nipyapi/nifi/apis/data_transfer_api.py +++ b/nipyapi/nifi/apis/data_transfer_api.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - import sys import os import re @@ -35,24 +34,23 @@ def __init__(self, api_client=None): def commit_input_port_transaction(self, response_code, port_id, transaction_id, **kwargs): """ - Commit or cancel the specified transaction + Commit or cancel the specified transaction. + 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 + ``commit_input_port_transaction_with_http_info()`` method instead. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.commit_input_port_transaction(response_code, port_id, transaction_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param int response_code: The response code. Available values are BAD_CHECKSUM(19), CONFIRM_TRANSACTION(12) or CANCEL_TRANSACTION(15). (required) - :param str port_id: The input port id. (required) - :param str transaction_id: The transaction id. (required) - :return: TransactionResultEntity - If the method is called asynchronously, - returns the request thread. + Args: + response_code (int): + The response code. Available values are BAD_CHECKSUM(19), CONFIRM_TRANSACTION(12) or CANCEL_TRANSACTION(15). (required) + port_id (str): + The input port id. (required) + transaction_id (str): + The transaction id. (required) + body (:class:`~nipyapi.nifi.models.object`): + + Returns: + :class:`~nipyapi.nifi.models.TransactionResultEntity`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): @@ -63,28 +61,26 @@ def commit_input_port_transaction(self, response_code, port_id, transaction_id, def commit_input_port_transaction_with_http_info(self, response_code, port_id, transaction_id, **kwargs): """ - Commit or cancel the specified transaction + Commit or cancel the specified transaction. + This method makes a synchronous HTTP request and returns detailed response information. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.commit_input_port_transaction_with_http_info(response_code, port_id, transaction_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param int response_code: The response code. Available values are BAD_CHECKSUM(19), CONFIRM_TRANSACTION(12) or CANCEL_TRANSACTION(15). (required) - :param str port_id: The input port id. (required) - :param str transaction_id: The transaction id. (required) - :return: TransactionResultEntity - If the method is called asynchronously, - returns the request thread. + Returns the response data along with HTTP status code, headers, and other metadata. + For just the response data, use the corresponding ``commit_input_port_transaction()`` method instead. + + Args: + response_code (int): + The response code. Available values are BAD_CHECKSUM(19), CONFIRM_TRANSACTION(12) or CANCEL_TRANSACTION(15). (required) + port_id (str): + The input port id. (required) + transaction_id (str): + The transaction id. (required) + body (:class:`~nipyapi.nifi.models.object`): + + Returns: + tuple: (:class:`~nipyapi.nifi.models.TransactionResultEntity`, status_code, headers) - Response data with HTTP details. """ - all_params = ['response_code', 'port_id', 'transaction_id'] - all_params.append('callback') + all_params = ['response_code', 'port_id', 'transaction_id', 'body'] all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -108,7 +104,10 @@ def commit_input_port_transaction_with_http_info(self, response_code, port_id, t if ('transaction_id' not in params) or (params['transaction_id'] is None): raise ValueError("Missing the required parameter `transaction_id` when calling `commit_input_port_transaction`") - + + + + collection_formats = {} path_params = {} @@ -127,6 +126,8 @@ def commit_input_port_transaction_with_http_info(self, response_code, port_id, t 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']) @@ -136,7 +137,7 @@ def commit_input_port_transaction_with_http_info(self, response_code, port_id, t select_header_content_type(['application/octet-stream']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/data-transfer/input-ports/{portId}/transactions/{transactionId}', 'DELETE', path_params, @@ -147,7 +148,6 @@ def commit_input_port_transaction_with_http_info(self, response_code, port_id, t files=local_var_files, response_type='TransactionResultEntity', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), @@ -155,25 +155,25 @@ def commit_input_port_transaction_with_http_info(self, response_code, port_id, t def commit_output_port_transaction(self, response_code, checksum, port_id, transaction_id, **kwargs): """ - Commit or cancel the specified transaction + Commit or cancel the specified transaction. + This method makes a synchronous HTTP request and returns the response data directly. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.commit_output_port_transaction(response_code, checksum, port_id, transaction_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param int response_code: The response code. Available values are CONFIRM_TRANSACTION(12) or CANCEL_TRANSACTION(15). (required) - :param str checksum: A checksum calculated at client side using CRC32 to check flow file content integrity. It must match with the value calculated at server side. (required) - :param str port_id: The output port id. (required) - :param str transaction_id: The transaction id. (required) - :return: TransactionResultEntity - If the method is called asynchronously, - returns the request thread. + For full HTTP response details (status code, headers, etc.), use the corresponding + ``commit_output_port_transaction_with_http_info()`` method instead. + + Args: + response_code (int): + The response code. Available values are CONFIRM_TRANSACTION(12) or CANCEL_TRANSACTION(15). (required) + checksum (str): + A checksum calculated at client side using CRC32 to check flow file content integrity. It must match with the value calculated at server side. (required) + port_id (str): + The output port id. (required) + transaction_id (str): + The transaction id. (required) + body (:class:`~nipyapi.nifi.models.object`): + + Returns: + :class:`~nipyapi.nifi.models.TransactionResultEntity`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): @@ -184,29 +184,28 @@ def commit_output_port_transaction(self, response_code, checksum, port_id, trans def commit_output_port_transaction_with_http_info(self, response_code, checksum, port_id, transaction_id, **kwargs): """ - Commit or cancel the specified transaction + Commit or cancel the specified transaction. + 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 ``commit_output_port_transaction()`` method instead. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.commit_output_port_transaction_with_http_info(response_code, checksum, port_id, transaction_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param int response_code: The response code. Available values are CONFIRM_TRANSACTION(12) or CANCEL_TRANSACTION(15). (required) - :param str checksum: A checksum calculated at client side using CRC32 to check flow file content integrity. It must match with the value calculated at server side. (required) - :param str port_id: The output port id. (required) - :param str transaction_id: The transaction id. (required) - :return: TransactionResultEntity - If the method is called asynchronously, - returns the request thread. + Args: + response_code (int): + The response code. Available values are CONFIRM_TRANSACTION(12) or CANCEL_TRANSACTION(15). (required) + checksum (str): + A checksum calculated at client side using CRC32 to check flow file content integrity. It must match with the value calculated at server side. (required) + port_id (str): + The output port id. (required) + transaction_id (str): + The transaction id. (required) + body (:class:`~nipyapi.nifi.models.object`): + + Returns: + tuple: (:class:`~nipyapi.nifi.models.TransactionResultEntity`, status_code, headers) - Response data with HTTP details. """ - all_params = ['response_code', 'checksum', 'port_id', 'transaction_id'] - all_params.append('callback') + all_params = ['response_code', 'checksum', 'port_id', 'transaction_id', 'body'] all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -233,7 +232,11 @@ def commit_output_port_transaction_with_http_info(self, response_code, checksum, if ('transaction_id' not in params) or (params['transaction_id'] is None): raise ValueError("Missing the required parameter `transaction_id` when calling `commit_output_port_transaction`") - + + + + + collection_formats = {} path_params = {} @@ -254,6 +257,8 @@ def commit_output_port_transaction_with_http_info(self, response_code, checksum, 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']) @@ -263,7 +268,7 @@ def commit_output_port_transaction_with_http_info(self, response_code, checksum, select_header_content_type(['application/octet-stream']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/data-transfer/output-ports/{portId}/transactions/{transactionId}', 'DELETE', path_params, @@ -274,7 +279,6 @@ def commit_output_port_transaction_with_http_info(self, response_code, checksum, files=local_var_files, response_type='TransactionResultEntity', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), @@ -282,23 +286,20 @@ def commit_output_port_transaction_with_http_info(self, response_code, checksum, def create_port_transaction(self, port_type, port_id, **kwargs): """ - Create a transaction to the specified output port or input port + Create a transaction to the specified output port or input port. + This method makes a synchronous HTTP request and returns the response data directly. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.create_port_transaction(port_type, port_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str port_type: The port type. (required) - :param str port_id: (required) - :return: TransactionResultEntity - If the method is called asynchronously, - returns the request thread. + For full HTTP response details (status code, headers, etc.), use the corresponding + ``create_port_transaction_with_http_info()`` method instead. + + Args: + port_type (str): + The port type. (required) + port_id (str): (required) + body (:class:`~nipyapi.nifi.models.object`): + + Returns: + :class:`~nipyapi.nifi.models.TransactionResultEntity`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): @@ -309,27 +310,23 @@ def create_port_transaction(self, port_type, port_id, **kwargs): def create_port_transaction_with_http_info(self, port_type, port_id, **kwargs): """ - Create a transaction to the specified output port or input port + Create a transaction to the specified output port or input port. + 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_port_transaction()`` method instead. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.create_port_transaction_with_http_info(port_type, port_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str port_type: The port type. (required) - :param str port_id: (required) - :return: TransactionResultEntity - If the method is called asynchronously, - returns the request thread. + Args: + port_type (str): + The port type. (required) + port_id (str): (required) + body (:class:`~nipyapi.nifi.models.object`): + + Returns: + tuple: (:class:`~nipyapi.nifi.models.TransactionResultEntity`, status_code, headers) - Response data with HTTP details. """ - all_params = ['port_type', 'port_id'] - all_params.append('callback') + all_params = ['port_type', 'port_id', 'body'] all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -350,7 +347,9 @@ def create_port_transaction_with_http_info(self, port_type, port_id, **kwargs): if ('port_id' not in params) or (params['port_id'] is None): raise ValueError("Missing the required parameter `port_id` when calling `create_port_transaction`") - + + + collection_formats = {} path_params = {} @@ -367,12 +366,18 @@ def create_port_transaction_with_http_info(self, port_type, port_id, **kwargs): 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(['*/*']) + # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/data-transfer/{portType}/{portId}/transactions', 'POST', path_params, @@ -383,7 +388,6 @@ def create_port_transaction_with_http_info(self, port_type, port_id, **kwargs): files=local_var_files, response_type='TransactionResultEntity', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), @@ -391,23 +395,19 @@ def create_port_transaction_with_http_info(self, port_type, port_id, **kwargs): def extend_input_port_transaction_ttl(self, port_id, transaction_id, **kwargs): """ - Extend transaction TTL + Extend transaction TTL. + 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 + ``extend_input_port_transaction_ttl_with_http_info()`` method instead. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.extend_input_port_transaction_ttl(port_id, transaction_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str port_id: (required) - :param str transaction_id: (required) - :return: TransactionResultEntity - If the method is called asynchronously, - returns the request thread. + Args: + port_id (str): (required) + transaction_id (str): (required) + body (:class:`~nipyapi.nifi.models.object`): + + Returns: + :class:`~nipyapi.nifi.models.TransactionResultEntity`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): @@ -418,27 +418,22 @@ def extend_input_port_transaction_ttl(self, port_id, transaction_id, **kwargs): def extend_input_port_transaction_ttl_with_http_info(self, port_id, transaction_id, **kwargs): """ - Extend transaction TTL + Extend transaction TTL. + This method makes a synchronous HTTP request and returns detailed response information. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.extend_input_port_transaction_ttl_with_http_info(port_id, transaction_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str port_id: (required) - :param str transaction_id: (required) - :return: TransactionResultEntity - If the method is called asynchronously, - returns the request thread. + Returns the response data along with HTTP status code, headers, and other metadata. + For just the response data, use the corresponding ``extend_input_port_transaction_ttl()`` method instead. + + Args: + port_id (str): (required) + transaction_id (str): (required) + body (:class:`~nipyapi.nifi.models.object`): + + Returns: + tuple: (:class:`~nipyapi.nifi.models.TransactionResultEntity`, status_code, headers) - Response data with HTTP details. """ - all_params = ['port_id', 'transaction_id'] - all_params.append('callback') + all_params = ['port_id', 'transaction_id', 'body'] all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -459,7 +454,9 @@ def extend_input_port_transaction_ttl_with_http_info(self, port_id, transaction_ if ('transaction_id' not in params) or (params['transaction_id'] is None): raise ValueError("Missing the required parameter `transaction_id` when calling `extend_input_port_transaction_ttl`") - + + + collection_formats = {} path_params = {} @@ -476,6 +473,8 @@ def extend_input_port_transaction_ttl_with_http_info(self, port_id, transaction_ 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']) @@ -485,7 +484,7 @@ def extend_input_port_transaction_ttl_with_http_info(self, port_id, transaction_ select_header_content_type(['*/*']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/data-transfer/input-ports/{portId}/transactions/{transactionId}', 'PUT', path_params, @@ -496,7 +495,6 @@ def extend_input_port_transaction_ttl_with_http_info(self, port_id, transaction_ files=local_var_files, response_type='TransactionResultEntity', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), @@ -504,23 +502,19 @@ def extend_input_port_transaction_ttl_with_http_info(self, port_id, transaction_ def extend_output_port_transaction_ttl(self, port_id, transaction_id, **kwargs): """ - Extend transaction TTL + Extend transaction TTL. + This method makes a synchronous HTTP request and returns the response data directly. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.extend_output_port_transaction_ttl(port_id, transaction_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str port_id: (required) - :param str transaction_id: (required) - :return: TransactionResultEntity - If the method is called asynchronously, - returns the request thread. + For full HTTP response details (status code, headers, etc.), use the corresponding + ``extend_output_port_transaction_ttl_with_http_info()`` method instead. + + Args: + port_id (str): (required) + transaction_id (str): (required) + body (:class:`~nipyapi.nifi.models.object`): + + Returns: + :class:`~nipyapi.nifi.models.TransactionResultEntity`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): @@ -531,27 +525,22 @@ def extend_output_port_transaction_ttl(self, port_id, transaction_id, **kwargs): def extend_output_port_transaction_ttl_with_http_info(self, port_id, transaction_id, **kwargs): """ - Extend transaction TTL + Extend transaction TTL. + 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 ``extend_output_port_transaction_ttl()`` method instead. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.extend_output_port_transaction_ttl_with_http_info(port_id, transaction_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str port_id: (required) - :param str transaction_id: (required) - :return: TransactionResultEntity - If the method is called asynchronously, - returns the request thread. + Args: + port_id (str): (required) + transaction_id (str): (required) + body (:class:`~nipyapi.nifi.models.object`): + + Returns: + tuple: (:class:`~nipyapi.nifi.models.TransactionResultEntity`, status_code, headers) - Response data with HTTP details. """ - all_params = ['port_id', 'transaction_id'] - all_params.append('callback') + all_params = ['port_id', 'transaction_id', 'body'] all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -572,7 +561,9 @@ def extend_output_port_transaction_ttl_with_http_info(self, port_id, transaction if ('transaction_id' not in params) or (params['transaction_id'] is None): raise ValueError("Missing the required parameter `transaction_id` when calling `extend_output_port_transaction_ttl`") - + + + collection_formats = {} path_params = {} @@ -589,6 +580,8 @@ def extend_output_port_transaction_ttl_with_http_info(self, port_id, transaction 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']) @@ -598,7 +591,7 @@ def extend_output_port_transaction_ttl_with_http_info(self, port_id, transaction select_header_content_type(['*/*']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/data-transfer/output-ports/{portId}/transactions/{transactionId}', 'PUT', path_params, @@ -609,7 +602,6 @@ def extend_output_port_transaction_ttl_with_http_info(self, port_id, transaction files=local_var_files, response_type='TransactionResultEntity', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), @@ -617,23 +609,20 @@ def extend_output_port_transaction_ttl_with_http_info(self, port_id, transaction def receive_flow_files(self, port_id, transaction_id, **kwargs): """ - Transfer flow files to the input port + Transfer flow files to the input port. + This method makes a synchronous HTTP request and returns the response data directly. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.receive_flow_files(port_id, transaction_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str port_id: The input port id. (required) - :param str transaction_id: (required) - :return: str - If the method is called asynchronously, - returns the request thread. + For full HTTP response details (status code, headers, etc.), use the corresponding + ``receive_flow_files_with_http_info()`` method instead. + + Args: + port_id (str): + The input port id. (required) + transaction_id (str): (required) + body (:class:`~nipyapi.nifi.models.object`): + + Returns: + str: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): @@ -644,27 +633,23 @@ def receive_flow_files(self, port_id, transaction_id, **kwargs): def receive_flow_files_with_http_info(self, port_id, transaction_id, **kwargs): """ - Transfer flow files to the input port + Transfer flow files to the input port. + 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 ``receive_flow_files()`` method instead. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.receive_flow_files_with_http_info(port_id, transaction_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str port_id: The input port id. (required) - :param str transaction_id: (required) - :return: str - If the method is called asynchronously, - returns the request thread. + Args: + port_id (str): + The input port id. (required) + transaction_id (str): (required) + body (:class:`~nipyapi.nifi.models.object`): + + Returns: + tuple: (str, status_code, headers) - Response data with HTTP details. """ - all_params = ['port_id', 'transaction_id'] - all_params.append('callback') + all_params = ['port_id', 'transaction_id', 'body'] all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -685,7 +670,9 @@ def receive_flow_files_with_http_info(self, port_id, transaction_id, **kwargs): if ('transaction_id' not in params) or (params['transaction_id'] is None): raise ValueError("Missing the required parameter `transaction_id` when calling `receive_flow_files`") - + + + collection_formats = {} path_params = {} @@ -702,6 +689,8 @@ def receive_flow_files_with_http_info(self, port_id, transaction_id, **kwargs): 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(['text/plain']) @@ -711,7 +700,7 @@ def receive_flow_files_with_http_info(self, port_id, transaction_id, **kwargs): select_header_content_type(['application/octet-stream']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/data-transfer/input-ports/{portId}/transactions/{transactionId}/flow-files', 'POST', path_params, @@ -722,7 +711,6 @@ def receive_flow_files_with_http_info(self, port_id, transaction_id, **kwargs): files=local_var_files, response_type='str', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), @@ -730,23 +718,20 @@ def receive_flow_files_with_http_info(self, port_id, transaction_id, **kwargs): def transfer_flow_files(self, port_id, transaction_id, **kwargs): """ - Transfer flow files from the output port + Transfer flow files from the output port. + This method makes a synchronous HTTP request and returns the response data directly. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.transfer_flow_files(port_id, transaction_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str port_id: The output port id. (required) - :param str transaction_id: (required) - :return: StreamingOutput - If the method is called asynchronously, - returns the request thread. + For full HTTP response details (status code, headers, etc.), use the corresponding + ``transfer_flow_files_with_http_info()`` method instead. + + Args: + port_id (str): + The output port id. (required) + transaction_id (str): (required) + body (:class:`~nipyapi.nifi.models.object`): + + Returns: + None """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): @@ -757,27 +742,23 @@ def transfer_flow_files(self, port_id, transaction_id, **kwargs): def transfer_flow_files_with_http_info(self, port_id, transaction_id, **kwargs): """ - Transfer flow files from the output port + Transfer flow files from the output port. + 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 ``transfer_flow_files()`` method instead. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.transfer_flow_files_with_http_info(port_id, transaction_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str port_id: The output port id. (required) - :param str transaction_id: (required) - :return: StreamingOutput - If the method is called asynchronously, - returns the request thread. + Args: + port_id (str): + The output port id. (required) + transaction_id (str): (required) + body (:class:`~nipyapi.nifi.models.object`): + + Returns: + tuple: (None, status_code, headers) - Response data with HTTP details. """ - all_params = ['port_id', 'transaction_id'] - all_params.append('callback') + all_params = ['port_id', 'transaction_id', 'body'] all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -798,7 +779,9 @@ def transfer_flow_files_with_http_info(self, port_id, transaction_id, **kwargs): if ('transaction_id' not in params) or (params['transaction_id'] is None): raise ValueError("Missing the required parameter `transaction_id` when calling `transfer_flow_files`") - + + + collection_formats = {} path_params = {} @@ -815,6 +798,8 @@ def transfer_flow_files_with_http_info(self, port_id, transaction_id, **kwargs): 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/octet-stream']) @@ -824,7 +809,7 @@ def transfer_flow_files_with_http_info(self, port_id, transaction_id, **kwargs): select_header_content_type(['*/*']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/data-transfer/output-ports/{portId}/transactions/{transactionId}/flow-files', 'GET', path_params, @@ -833,9 +818,8 @@ def transfer_flow_files_with_http_info(self, port_id, transaction_id, **kwargs): body=body_params, post_params=form_params, files=local_var_files, - response_type='StreamingOutput', + response_type=None, auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), diff --git a/nipyapi/nifi/apis/flow_api.py b/nipyapi/nifi/apis/flow_api.py index b98de7d7..02f0973c 100644 --- a/nipyapi/nifi/apis/flow_api.py +++ b/nipyapi/nifi/apis/flow_api.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - import sys import os import re @@ -33,56 +32,49 @@ def __init__(self, api_client=None): config.api_client = ApiClient() self.api_client = config.api_client - def activate_controller_services(self, id, body, **kwargs): + def activate_controller_services(self, body, id, **kwargs): """ - Enable or disable Controller Services in the specified Process Group. + Enable or disable Controller Services in the specified Process Group.. + This method makes a synchronous HTTP request and returns the response data directly. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.activate_controller_services(id, body, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The process group id. (required) - :param ActivateControllerServicesEntity body: The request to schedule or unschedule. If the comopnents in the request are not specified, all authorized components will be considered. (required) - :return: ActivateControllerServicesEntity - If the method is called asynchronously, - returns the request thread. + For full HTTP response details (status code, headers, etc.), use the corresponding + ``activate_controller_services_with_http_info()`` method instead. + + Args: + body (:class:`~nipyapi.nifi.models.ActivateControllerServicesEntity`): + The request to schedule or unschedule. If the comopnents in the request are not specified, all authorized components will be considered. (required) + id (str): + The process group id. (required) + + Returns: + :class:`~nipyapi.nifi.models.ActivateControllerServicesEntity`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.activate_controller_services_with_http_info(id, body, **kwargs) + return self.activate_controller_services_with_http_info(body, id, **kwargs) else: - (data) = self.activate_controller_services_with_http_info(id, body, **kwargs) + (data) = self.activate_controller_services_with_http_info(body, id, **kwargs) return data - def activate_controller_services_with_http_info(self, id, body, **kwargs): + def activate_controller_services_with_http_info(self, body, id, **kwargs): """ - Enable or disable Controller Services in the specified Process Group. + Enable or disable Controller Services in the specified Process Group.. + This method makes a synchronous HTTP request and returns detailed response information. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.activate_controller_services_with_http_info(id, body, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The process group id. (required) - :param ActivateControllerServicesEntity body: The request to schedule or unschedule. If the comopnents in the request are not specified, all authorized components will be considered. (required) - :return: ActivateControllerServicesEntity - If the method is called asynchronously, - returns the request thread. + Returns the response data along with HTTP status code, headers, and other metadata. + For just the response data, use the corresponding ``activate_controller_services()`` method instead. + + Args: + body (:class:`~nipyapi.nifi.models.ActivateControllerServicesEntity`): + The request to schedule or unschedule. If the comopnents in the request are not specified, all authorized components will be considered. (required) + id (str): + The process group id. (required) + + Returns: + tuple: (:class:`~nipyapi.nifi.models.ActivateControllerServicesEntity`, status_code, headers) - Response data with HTTP details. """ - all_params = ['id', 'body'] - all_params.append('callback') + all_params = ['body', 'id'] all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -96,14 +88,15 @@ def activate_controller_services_with_http_info(self, id, body, **kwargs): ) 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 `activate_controller_services`") # 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 `activate_controller_services`") + # 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 `activate_controller_services`") - + + collection_formats = {} path_params = {} @@ -129,7 +122,7 @@ def activate_controller_services_with_http_info(self, id, body, **kwargs): select_header_content_type(['application/json']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/flow/process-groups/{id}/controller-services', 'PUT', path_params, @@ -140,7 +133,6 @@ def activate_controller_services_with_http_info(self, id, body, **kwargs): files=local_var_files, response_type='ActivateControllerServicesEntity', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), @@ -148,22 +140,18 @@ def activate_controller_services_with_http_info(self, id, body, **kwargs): def download_reporting_task_snapshot(self, **kwargs): """ - Download a snapshot of the given reporting tasks and any controller services they use + Download a snapshot of the given reporting tasks and any controller services they use. + This method makes a synchronous HTTP request and returns the response data directly. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.download_reporting_task_snapshot(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str reporting_task_id: Specifies a reporting task id to export. If not specified, all reporting tasks will be exported. - :return: list[str] - If the method is called asynchronously, - returns the request thread. + For full HTTP response details (status code, headers, etc.), use the corresponding + ``download_reporting_task_snapshot_with_http_info()`` method instead. + + Args: + reporting_task_id (str): + Specifies a reporting task id to export. If not specified, all reporting tasks will be exported. + + Returns: + str: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): @@ -174,26 +162,21 @@ def download_reporting_task_snapshot(self, **kwargs): def download_reporting_task_snapshot_with_http_info(self, **kwargs): """ - Download a snapshot of the given reporting tasks and any controller services they use + Download a snapshot of the given reporting tasks and any controller services they use. + This method makes a synchronous HTTP request and returns detailed response information. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.download_reporting_task_snapshot_with_http_info(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str reporting_task_id: Specifies a reporting task id to export. If not specified, all reporting tasks will be exported. - :return: list[str] - If the method is called asynchronously, - returns the request thread. + Returns the response data along with HTTP status code, headers, and other metadata. + For just the response data, use the corresponding ``download_reporting_task_snapshot()`` method instead. + + Args: + reporting_task_id (str): + Specifies a reporting task id to export. If not specified, all reporting tasks will be exported. + + Returns: + tuple: (str, status_code, headers) - Response data with HTTP details. """ all_params = ['reporting_task_id'] - all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -208,7 +191,7 @@ def download_reporting_task_snapshot_with_http_info(self, **kwargs): params[key] = val del params['kwargs'] - + collection_formats = {} path_params = {} @@ -227,12 +210,8 @@ def download_reporting_task_snapshot_with_http_info(self, **kwargs): header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['*/*']) - # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/flow/reporting-tasks/download', 'GET', path_params, @@ -241,9 +220,8 @@ def download_reporting_task_snapshot_with_http_info(self, **kwargs): body=body_params, post_params=form_params, files=local_var_files, - response_type='list[str]', + response_type='str', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), @@ -251,21 +229,16 @@ def download_reporting_task_snapshot_with_http_info(self, **kwargs): def generate_client_id(self, **kwargs): """ - Generates a client id. + Generates a client id.. + This method makes a synchronous HTTP request and returns the response data directly. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.generate_client_id(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :return: str - If the method is called asynchronously, - returns the request thread. + For full HTTP response details (status code, headers, etc.), use the corresponding + ``generate_client_id_with_http_info()`` method instead. + + Args: + + Returns: + str: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): @@ -276,25 +249,19 @@ def generate_client_id(self, **kwargs): def generate_client_id_with_http_info(self, **kwargs): """ - Generates a client id. + Generates a client id.. + This method makes a synchronous HTTP request and returns detailed response information. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.generate_client_id_with_http_info(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :return: str - If the method is called asynchronously, - returns the request thread. + Returns the response data along with HTTP status code, headers, and other metadata. + For just the response data, use the corresponding ``generate_client_id()`` method instead. + + Args: + + Returns: + tuple: (str, status_code, headers) - Response data with HTTP details. """ all_params = [] - all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -325,12 +292,8 @@ def generate_client_id_with_http_info(self, **kwargs): header_params['Accept'] = self.api_client.\ select_header_accept(['text/plain']) - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['*/*']) - # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/flow/client-id', 'GET', path_params, @@ -341,7 +304,6 @@ def generate_client_id_with_http_info(self, **kwargs): files=local_var_files, response_type='str', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), @@ -349,21 +311,16 @@ def generate_client_id_with_http_info(self, **kwargs): def get_about_info(self, **kwargs): """ - Retrieves details about this NiFi to put in the About dialog + Retrieves details about this NiFi to put in the About dialog. + This method makes a synchronous HTTP request and returns the response data directly. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_about_info(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :return: AboutEntity - If the method is called asynchronously, - returns the request thread. + For full HTTP response details (status code, headers, etc.), use the corresponding + ``get_about_info_with_http_info()`` method instead. + + Args: + + Returns: + :class:`~nipyapi.nifi.models.AboutEntity`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): @@ -374,25 +331,19 @@ def get_about_info(self, **kwargs): def get_about_info_with_http_info(self, **kwargs): """ - Retrieves details about this NiFi to put in the About dialog + Retrieves details about this NiFi to put in the About dialog. + This method makes a synchronous HTTP request and returns detailed response information. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_about_info_with_http_info(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :return: AboutEntity - If the method is called asynchronously, - returns the request thread. + Returns the response data along with HTTP status code, headers, and other metadata. + For just the response data, use the corresponding ``get_about_info()`` method instead. + + Args: + + Returns: + tuple: (:class:`~nipyapi.nifi.models.AboutEntity`, status_code, headers) - Response data with HTTP details. """ all_params = [] - all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -423,12 +374,8 @@ def get_about_info_with_http_info(self, **kwargs): header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['*/*']) - # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/flow/about', 'GET', path_params, @@ -439,7 +386,6 @@ def get_about_info_with_http_info(self, **kwargs): files=local_var_files, response_type='AboutEntity', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), @@ -447,22 +393,21 @@ def get_about_info_with_http_info(self, **kwargs): def get_action(self, id, **kwargs): """ - Gets an action + Gets an action. + Note: This endpoint is subject to change as NiFi and it's REST API evolve. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_action(id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The action id. (required) - :return: ActionEntity - If the method is called asynchronously, - returns the request thread. + + 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_action_with_http_info()`` method instead. + + Args: + id (:class:`~nipyapi.nifi.models.IntegerParameter`): + The action id. (required) + + Returns: + :class:`~nipyapi.nifi.models.ActionEntity`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): @@ -473,26 +418,24 @@ def get_action(self, id, **kwargs): def get_action_with_http_info(self, id, **kwargs): """ - Gets an action + Gets an action. + Note: This endpoint is subject to change as NiFi and it's REST API evolve. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_action_with_http_info(id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The action id. (required) - :return: ActionEntity - If the method is called asynchronously, - returns the request thread. + + 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_action()`` method instead. + + Args: + id (:class:`~nipyapi.nifi.models.IntegerParameter`): + The action id. (required) + + Returns: + tuple: (:class:`~nipyapi.nifi.models.ActionEntity`, status_code, headers) - Response data with HTTP details. """ all_params = ['id'] - all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -510,7 +453,7 @@ def get_action_with_http_info(self, id, **kwargs): if ('id' not in params) or (params['id'] is None): raise ValueError("Missing the required parameter `id` when calling `get_action`") - + collection_formats = {} path_params = {} @@ -529,12 +472,8 @@ def get_action_with_http_info(self, id, **kwargs): header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['*/*']) - # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/flow/history/{id}', 'GET', path_params, @@ -545,58 +484,68 @@ def get_action_with_http_info(self, id, **kwargs): files=local_var_files, response_type='ActionEntity', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def get_banners(self, **kwargs): + def get_additional_details(self, group, artifact, version, type, **kwargs): """ - Retrieves the banners for this NiFi - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_banners(callback=callback_function) + Retrieves the additional details for the specified component type.. + + Note: This endpoint is subject to change as NiFi and it's REST API evolve. - :param callback function: The callback function - for asynchronous request. (optional) - :return: BannerEntity - If the method is called asynchronously, - returns the request thread. + 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_additional_details_with_http_info()`` method instead. + + Args: + group (str): + The bundle group (required) + artifact (str): + The bundle artifact (required) + version (str): + The bundle version (required) + type (str): + The processor type (required) + + Returns: + :class:`~nipyapi.nifi.models.AdditionalDetailsEntity`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.get_banners_with_http_info(**kwargs) + return self.get_additional_details_with_http_info(group, artifact, version, type, **kwargs) else: - (data) = self.get_banners_with_http_info(**kwargs) + (data) = self.get_additional_details_with_http_info(group, artifact, version, type, **kwargs) return data - def get_banners_with_http_info(self, **kwargs): + def get_additional_details_with_http_info(self, group, artifact, version, type, **kwargs): """ - Retrieves the banners for this NiFi - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_banners_with_http_info(callback=callback_function) + Retrieves the additional details for the specified component type.. - :param callback function: The callback function - for asynchronous request. (optional) - :return: BannerEntity - If the method is called asynchronously, - returns the request thread. - """ + Note: This endpoint is subject to change as NiFi and it's REST API evolve. - all_params = [] - all_params.append('callback') + 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_additional_details()`` method instead. + + Args: + group (str): + The bundle group (required) + artifact (str): + The bundle artifact (required) + version (str): + The bundle version (required) + type (str): + The processor type (required) + + Returns: + tuple: (:class:`~nipyapi.nifi.models.AdditionalDetailsEntity`, status_code, headers) - Response data with HTTP details. + """ + + all_params = ['group', 'artifact', 'version', 'type'] all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -606,14 +555,38 @@ def get_banners_with_http_info(self, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method get_banners" % key + " to method get_additional_details" % key ) params[key] = val del params['kwargs'] - + # verify the required parameter 'group' is set + if ('group' not in params) or (params['group'] is None): + raise ValueError("Missing the required parameter `group` when calling `get_additional_details`") + # verify the required parameter 'artifact' is set + if ('artifact' not in params) or (params['artifact'] is None): + raise ValueError("Missing the required parameter `artifact` when calling `get_additional_details`") + # verify the required parameter 'version' is set + if ('version' not in params) or (params['version'] is None): + raise ValueError("Missing the required parameter `version` when calling `get_additional_details`") + # verify the required parameter 'type' is set + if ('type' not in params) or (params['type'] is None): + raise ValueError("Missing the required parameter `type` when calling `get_additional_details`") + + + + + collection_formats = {} path_params = {} + if 'group' in params: + path_params['group'] = params['group'] + if 'artifact' in params: + path_params['artifact'] = params['artifact'] + if 'version' in params: + path_params['version'] = params['version'] + if 'type' in params: + path_params['type'] = params['type'] query_params = [] @@ -627,76 +600,58 @@ def get_banners_with_http_info(self, **kwargs): header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['*/*']) - # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] - return self.api_client.call_api('/flow/banners', 'GET', + return self.api_client.call_api('/flow/additional-details/{group}/{artifact}/{version}/{type}', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, - response_type='BannerEntity', + response_type='AdditionalDetailsEntity', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def get_buckets(self, id, **kwargs): + def get_all_flow_analysis_results(self, **kwargs): """ - Gets the buckets from the specified registry for the current user + Returns all flow analysis results currently in effect. + This method makes a synchronous HTTP request and returns the response data directly. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_buckets(id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The registry id. (required) - :return: FlowRegistryBucketsEntity - If the method is called asynchronously, - returns the request thread. + For full HTTP response details (status code, headers, etc.), use the corresponding + ``get_all_flow_analysis_results_with_http_info()`` method instead. + + Args: + + Returns: + :class:`~nipyapi.nifi.models.FlowAnalysisResultEntity`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.get_buckets_with_http_info(id, **kwargs) + return self.get_all_flow_analysis_results_with_http_info(**kwargs) else: - (data) = self.get_buckets_with_http_info(id, **kwargs) + (data) = self.get_all_flow_analysis_results_with_http_info(**kwargs) return data - def get_buckets_with_http_info(self, id, **kwargs): + def get_all_flow_analysis_results_with_http_info(self, **kwargs): """ - Gets the buckets from the specified registry for the current user + Returns all flow analysis results currently in effect. + This method makes a synchronous HTTP request and returns detailed response information. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_buckets_with_http_info(id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The registry id. (required) - :return: FlowRegistryBucketsEntity - If the method is called asynchronously, - returns the request thread. + Returns the response data along with HTTP status code, headers, and other metadata. + For just the response data, use the corresponding ``get_all_flow_analysis_results()`` method instead. + + Args: + + Returns: + tuple: (:class:`~nipyapi.nifi.models.FlowAnalysisResultEntity`, status_code, headers) - Response data with HTTP details. """ - all_params = ['id'] - all_params.append('callback') + all_params = [] all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -706,20 +661,14 @@ def get_buckets_with_http_info(self, id, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method get_buckets" % key + " to method get_all_flow_analysis_results" % 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_buckets`") - collection_formats = {} path_params = {} - if 'id' in params: - path_params['id'] = params['id'] query_params = [] @@ -733,86 +682,58 @@ def get_buckets_with_http_info(self, id, **kwargs): header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['*/*']) - # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] - return self.api_client.call_api('/flow/registries/{id}/buckets', 'GET', + return self.api_client.call_api('/flow/flow-analysis/results', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, - response_type='FlowRegistryBucketsEntity', + response_type='FlowAnalysisResultEntity', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def get_bulletin_board(self, **kwargs): + def get_banners(self, **kwargs): """ - Gets current bulletins - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_bulletin_board(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str after: Includes bulletins with an id after this value. - :param str source_name: Includes bulletins originating from this sources whose name match this regular expression. - :param str message: Includes bulletins whose message that match this regular expression. - :param str source_id: Includes bulletins originating from this sources whose id match this regular expression. - :param str group_id: Includes bulletins originating from this sources whose group id match this regular expression. - :param str limit: The number of bulletins to limit the response to. - :return: BulletinBoardEntity - If the method is called asynchronously, - returns the request thread. + Retrieves the banners for this NiFi. + 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_banners_with_http_info()`` method instead. + + Args: + + Returns: + :class:`~nipyapi.nifi.models.BannerEntity`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.get_bulletin_board_with_http_info(**kwargs) + return self.get_banners_with_http_info(**kwargs) else: - (data) = self.get_bulletin_board_with_http_info(**kwargs) + (data) = self.get_banners_with_http_info(**kwargs) return data - def get_bulletin_board_with_http_info(self, **kwargs): + def get_banners_with_http_info(self, **kwargs): """ - Gets current bulletins - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_bulletin_board_with_http_info(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str after: Includes bulletins with an id after this value. - :param str source_name: Includes bulletins originating from this sources whose name match this regular expression. - :param str message: Includes bulletins whose message that match this regular expression. - :param str source_id: Includes bulletins originating from this sources whose id match this regular expression. - :param str group_id: Includes bulletins originating from this sources whose group id match this regular expression. - :param str limit: The number of bulletins to limit the response to. - :return: BulletinBoardEntity - If the method is called asynchronously, - returns the request thread. + Retrieves the banners for this NiFi. + 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_banners()`` method instead. + + Args: + + Returns: + tuple: (:class:`~nipyapi.nifi.models.BannerEntity`, status_code, headers) - Response data with HTTP details. """ - all_params = ['after', 'source_name', 'message', 'source_id', 'group_id', 'limit'] - all_params.append('callback') + all_params = [] all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -822,29 +743,16 @@ def get_bulletin_board_with_http_info(self, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method get_bulletin_board" % key + " to method get_banners" % key ) params[key] = val del params['kwargs'] - collection_formats = {} path_params = {} query_params = [] - if 'after' in params: - query_params.append(('after', params['after'])) - if 'source_name' in params: - query_params.append(('sourceName', params['source_name'])) - if 'message' in params: - query_params.append(('message', params['message'])) - if 'source_id' in params: - query_params.append(('sourceId', params['source_id'])) - if 'group_id' in params: - query_params.append(('groupId', params['group_id'])) - if 'limit' in params: - query_params.append(('limit', params['limit'])) header_params = {} @@ -856,74 +764,62 @@ def get_bulletin_board_with_http_info(self, **kwargs): header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['*/*']) - # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] - return self.api_client.call_api('/flow/bulletin-board', 'GET', + return self.api_client.call_api('/flow/banners', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, - response_type='BulletinBoardEntity', + response_type='BannerEntity', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def get_bulletins(self, **kwargs): + def get_branches(self, id, **kwargs): """ - Retrieves Controller level bulletins + Gets the branches from the specified registry for the current user. + This method makes a synchronous HTTP request and returns the response data directly. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_bulletins(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :return: ControllerBulletinsEntity - If the method is called asynchronously, - returns the request thread. + For full HTTP response details (status code, headers, etc.), use the corresponding + ``get_branches_with_http_info()`` method instead. + + Args: + id (str): + The registry id. (required) + + Returns: + :class:`~nipyapi.nifi.models.FlowRegistryBranchesEntity`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.get_bulletins_with_http_info(**kwargs) + return self.get_branches_with_http_info(id, **kwargs) else: - (data) = self.get_bulletins_with_http_info(**kwargs) + (data) = self.get_branches_with_http_info(id, **kwargs) return data - def get_bulletins_with_http_info(self, **kwargs): + def get_branches_with_http_info(self, id, **kwargs): """ - Retrieves Controller level bulletins + Gets the branches from the specified registry for the current user. + This method makes a synchronous HTTP request and returns detailed response information. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_bulletins_with_http_info(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :return: ControllerBulletinsEntity - If the method is called asynchronously, - returns the request thread. + Returns the response data along with HTTP status code, headers, and other metadata. + For just the response data, use the corresponding ``get_branches()`` method instead. + + Args: + id (str): + The registry id. (required) + + Returns: + tuple: (:class:`~nipyapi.nifi.models.FlowRegistryBranchesEntity`, status_code, headers) - Response data with HTTP details. """ - all_params = [] - all_params.append('callback') + all_params = ['id'] all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -933,14 +829,20 @@ def get_bulletins_with_http_info(self, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method get_bulletins" % key + " to method get_branches" % 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_branches`") + collection_formats = {} path_params = {} + if 'id' in params: + path_params['id'] = params['id'] query_params = [] @@ -954,74 +856,62 @@ def get_bulletins_with_http_info(self, **kwargs): header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['*/*']) - # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] - return self.api_client.call_api('/flow/controller/bulletins', 'GET', + return self.api_client.call_api('/flow/registries/{id}/branches', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, - response_type='ControllerBulletinsEntity', + response_type='FlowRegistryBranchesEntity', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def get_cluster_summary(self, **kwargs): + def get_breadcrumbs(self, id, **kwargs): """ - The cluster summary for this NiFi + Gets the breadcrumbs for a process group. + This method makes a synchronous HTTP request and returns the response data directly. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_cluster_summary(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :return: ClusteSummaryEntity - If the method is called asynchronously, - returns the request thread. + For full HTTP response details (status code, headers, etc.), use the corresponding + ``get_breadcrumbs_with_http_info()`` method instead. + + Args: + id (str): + The process group id. (required) + + Returns: + :class:`~nipyapi.nifi.models.FlowBreadcrumbEntity`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.get_cluster_summary_with_http_info(**kwargs) + return self.get_breadcrumbs_with_http_info(id, **kwargs) else: - (data) = self.get_cluster_summary_with_http_info(**kwargs) + (data) = self.get_breadcrumbs_with_http_info(id, **kwargs) return data - def get_cluster_summary_with_http_info(self, **kwargs): + def get_breadcrumbs_with_http_info(self, id, **kwargs): """ - The cluster summary for this NiFi + Gets the breadcrumbs for a process group. + This method makes a synchronous HTTP request and returns detailed response information. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_cluster_summary_with_http_info(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :return: ClusteSummaryEntity - If the method is called asynchronously, - returns the request thread. + Returns the response data along with HTTP status code, headers, and other metadata. + For just the response data, use the corresponding ``get_breadcrumbs()`` method instead. + + Args: + id (str): + The process group id. (required) + + Returns: + tuple: (:class:`~nipyapi.nifi.models.FlowBreadcrumbEntity`, status_code, headers) - Response data with HTTP details. """ - all_params = [] - all_params.append('callback') + all_params = ['id'] all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -1031,14 +921,20 @@ def get_cluster_summary_with_http_info(self, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method get_cluster_summary" % key + " to method get_breadcrumbs" % 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_breadcrumbs`") + collection_formats = {} path_params = {} + if 'id' in params: + path_params['id'] = params['id'] query_params = [] @@ -1052,76 +948,66 @@ def get_cluster_summary_with_http_info(self, **kwargs): header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['*/*']) - # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] - return self.api_client.call_api('/flow/cluster/summary', 'GET', + return self.api_client.call_api('/flow/process-groups/{id}/breadcrumbs', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, - response_type='ClusteSummaryEntity', + response_type='FlowBreadcrumbEntity', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def get_component_history(self, component_id, **kwargs): + def get_buckets(self, id, **kwargs): """ - Gets configuration history for a component - Note: This endpoint is subject to change as NiFi and it's REST API evolve. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_component_history(component_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str component_id: The component id. (required) - :return: ComponentHistoryEntity - If the method is called asynchronously, - returns the request thread. + Gets the buckets from the specified registry for the current user. + 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_buckets_with_http_info()`` method instead. + + Args: + id (str): + The registry id. (required) + branch (str): + The name of a branch to get the buckets from. If not specified the default branch of the registry client will be used. + + Returns: + :class:`~nipyapi.nifi.models.FlowRegistryBucketsEntity`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.get_component_history_with_http_info(component_id, **kwargs) + return self.get_buckets_with_http_info(id, **kwargs) else: - (data) = self.get_component_history_with_http_info(component_id, **kwargs) + (data) = self.get_buckets_with_http_info(id, **kwargs) return data - def get_component_history_with_http_info(self, component_id, **kwargs): + def get_buckets_with_http_info(self, id, **kwargs): """ - Gets configuration history for a component - Note: This endpoint is subject to change as NiFi and it's REST API evolve. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_component_history_with_http_info(component_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str component_id: The component id. (required) - :return: ComponentHistoryEntity - If the method is called asynchronously, - returns the request thread. + Gets the buckets from the specified registry for the current user. + 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_buckets()`` method instead. + + Args: + id (str): + The registry id. (required) + branch (str): + The name of a branch to get the buckets from. If not specified the default branch of the registry client will be used. + + Returns: + tuple: (:class:`~nipyapi.nifi.models.FlowRegistryBucketsEntity`, status_code, headers) - Response data with HTTP details. """ - all_params = ['component_id'] - all_params.append('callback') + all_params = ['id', 'branch'] all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -1131,22 +1017,25 @@ def get_component_history_with_http_info(self, component_id, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method get_component_history" % key + " to method get_buckets" % key ) params[key] = val del params['kwargs'] - # verify the required parameter 'component_id' is set - if ('component_id' not in params) or (params['component_id'] is None): - raise ValueError("Missing the required parameter `component_id` when calling `get_component_history`") - + # 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_buckets`") + + collection_formats = {} path_params = {} - if 'component_id' in params: - path_params['componentId'] = params['component_id'] + if 'id' in params: + path_params['id'] = params['id'] query_params = [] + if 'branch' in params: + query_params.append(('branch', params['branch'])) header_params = {} @@ -1158,80 +1047,82 @@ def get_component_history_with_http_info(self, component_id, **kwargs): header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['*/*']) - # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] - return self.api_client.call_api('/flow/history/components/{componentId}', 'GET', + return self.api_client.call_api('/flow/registries/{id}/buckets', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, - response_type='ComponentHistoryEntity', + response_type='FlowRegistryBucketsEntity', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def get_connection_statistics(self, id, **kwargs): + def get_bulletin_board(self, **kwargs): """ - Gets statistics for a connection - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_connection_statistics(id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The connection id. (required) - :param bool nodewise: Whether or not to include the breakdown per node. Optional, defaults to false - :param str cluster_node_id: The id of the node where to get the statistics. - :return: ConnectionStatisticsEntity - If the method is called asynchronously, - returns the request thread. + Gets current bulletins. + 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_bulletin_board_with_http_info()`` method instead. + + Args: + after (:class:`~nipyapi.nifi.models.LongParameter`): + Includes bulletins with an id after this value. + source_name (:class:`~nipyapi.nifi.models.BulletinBoardPatternParameter`): + Includes bulletins originating from this sources whose name match this regular expression. + message (:class:`~nipyapi.nifi.models.BulletinBoardPatternParameter`): + Includes bulletins whose message that match this regular expression. + source_id (:class:`~nipyapi.nifi.models.BulletinBoardPatternParameter`): + Includes bulletins originating from this sources whose id match this regular expression. + group_id (:class:`~nipyapi.nifi.models.BulletinBoardPatternParameter`): + Includes bulletins originating from this sources whose group id match this regular expression. + limit (:class:`~nipyapi.nifi.models.IntegerParameter`): + The number of bulletins to limit the response to. + + Returns: + :class:`~nipyapi.nifi.models.BulletinBoardEntity`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.get_connection_statistics_with_http_info(id, **kwargs) + return self.get_bulletin_board_with_http_info(**kwargs) else: - (data) = self.get_connection_statistics_with_http_info(id, **kwargs) + (data) = self.get_bulletin_board_with_http_info(**kwargs) return data - def get_connection_statistics_with_http_info(self, id, **kwargs): + def get_bulletin_board_with_http_info(self, **kwargs): """ - Gets statistics for a connection + Gets current bulletins. + This method makes a synchronous HTTP request and returns detailed response information. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_connection_statistics_with_http_info(id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The connection id. (required) - :param bool nodewise: Whether or not to include the breakdown per node. Optional, defaults to false - :param str cluster_node_id: The id of the node where to get the statistics. - :return: ConnectionStatisticsEntity - If the method is called asynchronously, - returns the request thread. + Returns the response data along with HTTP status code, headers, and other metadata. + For just the response data, use the corresponding ``get_bulletin_board()`` method instead. + + Args: + after (:class:`~nipyapi.nifi.models.LongParameter`): + Includes bulletins with an id after this value. + source_name (:class:`~nipyapi.nifi.models.BulletinBoardPatternParameter`): + Includes bulletins originating from this sources whose name match this regular expression. + message (:class:`~nipyapi.nifi.models.BulletinBoardPatternParameter`): + Includes bulletins whose message that match this regular expression. + source_id (:class:`~nipyapi.nifi.models.BulletinBoardPatternParameter`): + Includes bulletins originating from this sources whose id match this regular expression. + group_id (:class:`~nipyapi.nifi.models.BulletinBoardPatternParameter`): + Includes bulletins originating from this sources whose group id match this regular expression. + limit (:class:`~nipyapi.nifi.models.IntegerParameter`): + The number of bulletins to limit the response to. + + Returns: + tuple: (:class:`~nipyapi.nifi.models.BulletinBoardEntity`, status_code, headers) - Response data with HTTP details. """ - all_params = ['id', 'nodewise', 'cluster_node_id'] - all_params.append('callback') + all_params = ['after', 'source_name', 'message', 'source_id', 'group_id', 'limit'] all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -1241,26 +1132,34 @@ def get_connection_statistics_with_http_info(self, id, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method get_connection_statistics" % key + " to method get_bulletin_board" % key ) params[key] = val del params['kwargs'] - # verify the required parameter 'id' is set - if ('id' not in params) or (params['id'] is None): - raise ValueError("Missing the required parameter `id` when calling `get_connection_statistics`") - + + + + + + collection_formats = {} path_params = {} - if 'id' in params: - path_params['id'] = params['id'] query_params = [] - if 'nodewise' in params: - query_params.append(('nodewise', params['nodewise'])) - if 'cluster_node_id' in params: - query_params.append(('clusterNodeId', params['cluster_node_id'])) + if 'after' in params: + query_params.append(('after', params['after'])) + if 'source_name' in params: + query_params.append(('sourceName', params['source_name'])) + if 'message' in params: + query_params.append(('message', params['message'])) + if 'source_id' in params: + query_params.append(('sourceId', params['source_id'])) + if 'group_id' in params: + query_params.append(('groupId', params['group_id'])) + if 'limit' in params: + query_params.append(('limit', params['limit'])) header_params = {} @@ -1272,80 +1171,438 @@ def get_connection_statistics_with_http_info(self, id, **kwargs): header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['*/*']) - # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] - return self.api_client.call_api('/flow/connections/{id}/statistics', 'GET', + return self.api_client.call_api('/flow/bulletin-board', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, - response_type='ConnectionStatisticsEntity', + response_type='BulletinBoardEntity', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def get_connection_status(self, id, **kwargs): + def get_bulletins(self, **kwargs): """ - Gets status for a connection - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_connection_status(id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The connection id. (required) - :param bool nodewise: Whether or not to include the breakdown per node. Optional, defaults to false - :param str cluster_node_id: The id of the node where to get the status. - :return: ConnectionStatusEntity - If the method is called asynchronously, - returns the request thread. + Retrieves Controller level bulletins. + 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_bulletins_with_http_info()`` method instead. + + Args: + + Returns: + :class:`~nipyapi.nifi.models.ControllerBulletinsEntity`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.get_connection_status_with_http_info(id, **kwargs) + return self.get_bulletins_with_http_info(**kwargs) else: - (data) = self.get_connection_status_with_http_info(id, **kwargs) + (data) = self.get_bulletins_with_http_info(**kwargs) return data - def get_connection_status_with_http_info(self, id, **kwargs): + def get_bulletins_with_http_info(self, **kwargs): + """ + Retrieves Controller level bulletins. + 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_bulletins()`` method instead. + + Args: + + Returns: + tuple: (:class:`~nipyapi.nifi.models.ControllerBulletinsEntity`, status_code, headers) - Response data with HTTP details. + """ + + all_params = [] + 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_bulletins" % key + ) + params[key] = val + del params['kwargs'] + + collection_formats = {} + + path_params = {} + + query_params = [] + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.\ + select_header_accept(['application/json']) + + # Authentication setting + auth_settings = ['bearerAuth'] + + return self.api_client.call_api('/flow/controller/bulletins', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='ControllerBulletinsEntity', + 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_cluster_summary(self, **kwargs): + """ + The cluster summary for this NiFi. + 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_cluster_summary_with_http_info()`` method instead. + + Args: + + Returns: + :class:`~nipyapi.nifi.models.ClusterSummaryEntity`: The response data. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('callback'): + return self.get_cluster_summary_with_http_info(**kwargs) + else: + (data) = self.get_cluster_summary_with_http_info(**kwargs) + return data + + def get_cluster_summary_with_http_info(self, **kwargs): + """ + The cluster summary for this NiFi. + 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_cluster_summary()`` method instead. + + Args: + + Returns: + tuple: (:class:`~nipyapi.nifi.models.ClusterSummaryEntity`, status_code, headers) - Response data with HTTP details. + """ + + all_params = [] + 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_cluster_summary" % key + ) + params[key] = val + del params['kwargs'] + + collection_formats = {} + + path_params = {} + + query_params = [] + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.\ + select_header_accept(['application/json']) + + # Authentication setting + auth_settings = ['bearerAuth'] + + return self.api_client.call_api('/flow/cluster/summary', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='ClusterSummaryEntity', + 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_component_history(self, component_id, **kwargs): + """ + Gets configuration history for a component. + + Note: This endpoint is subject to change as NiFi and it's REST API evolve. + + This method makes a synchronous HTTP request and returns the response data directly. + + For full HTTP response details (status code, headers, etc.), use the corresponding + ``get_component_history_with_http_info()`` method instead. + + Args: + component_id (str): + The component id. (required) + + Returns: + :class:`~nipyapi.nifi.models.ComponentHistoryEntity`: The response data. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('callback'): + return self.get_component_history_with_http_info(component_id, **kwargs) + else: + (data) = self.get_component_history_with_http_info(component_id, **kwargs) + return data + + def get_component_history_with_http_info(self, component_id, **kwargs): """ - Gets status for a connection + Gets configuration history for a component. + + Note: This endpoint is subject to change as NiFi and it's REST API evolve. + + This method makes a synchronous HTTP request and returns detailed response information. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_connection_status_with_http_info(id, callback=callback_function) + Returns the response data along with HTTP status code, headers, and other metadata. + For just the response data, use the corresponding ``get_component_history()`` method instead. + + Args: + component_id (str): + The component id. (required) + + Returns: + tuple: (:class:`~nipyapi.nifi.models.ComponentHistoryEntity`, status_code, headers) - Response data with HTTP details. + """ + + all_params = ['component_id'] + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The connection id. (required) - :param bool nodewise: Whether or not to include the breakdown per node. Optional, defaults to false - :param str cluster_node_id: The id of the node where to get the status. - :return: ConnectionStatusEntity - If the method is called asynchronously, - returns the request thread. + 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_component_history" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'component_id' is set + if ('component_id' not in params) or (params['component_id'] is None): + raise ValueError("Missing the required parameter `component_id` when calling `get_component_history`") + + + collection_formats = {} + + path_params = {} + if 'component_id' in params: + path_params['componentId'] = params['component_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('/flow/history/components/{componentId}', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='ComponentHistoryEntity', + 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_connection_statistics(self, id, **kwargs): + """ + Gets statistics for a connection. + 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_connection_statistics_with_http_info()`` method instead. + + Args: + id (str): + The connection id. (required) + nodewise (bool): + Whether or not to include the breakdown per node. Optional, defaults to false + cluster_node_id (str): + The id of the node where to get the statistics. + + Returns: + :class:`~nipyapi.nifi.models.ConnectionStatisticsEntity`: The response data. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('callback'): + return self.get_connection_statistics_with_http_info(id, **kwargs) + else: + (data) = self.get_connection_statistics_with_http_info(id, **kwargs) + return data + + def get_connection_statistics_with_http_info(self, id, **kwargs): + """ + Gets statistics for a connection. + This method makes a synchronous HTTP request 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_connection_statistics()`` method instead. + + Args: + id (str): + The connection id. (required) + nodewise (bool): + Whether or not to include the breakdown per node. Optional, defaults to false + cluster_node_id (str): + The id of the node where to get the statistics. + + Returns: + tuple: (:class:`~nipyapi.nifi.models.ConnectionStatisticsEntity`, status_code, headers) - Response data with HTTP details. + """ + + all_params = ['id', 'nodewise', 'cluster_node_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_connection_statistics" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'id' is set + if ('id' not in params) or (params['id'] is None): + raise ValueError("Missing the required parameter `id` when calling `get_connection_statistics`") + + + + + collection_formats = {} + + path_params = {} + if 'id' in params: + path_params['id'] = params['id'] + + query_params = [] + if 'nodewise' in params: + query_params.append(('nodewise', params['nodewise'])) + if 'cluster_node_id' in params: + query_params.append(('clusterNodeId', params['cluster_node_id'])) + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.\ + select_header_accept(['application/json']) + + # Authentication setting + auth_settings = ['bearerAuth'] + + return self.api_client.call_api('/flow/connections/{id}/statistics', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='ConnectionStatisticsEntity', + auth_settings=auth_settings, + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def get_connection_status(self, id, **kwargs): + """ + Gets status for a connection. + 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_connection_status_with_http_info()`` method instead. + + Args: + id (str): + The connection id. (required) + nodewise (bool): + Whether or not to include the breakdown per node. Optional, defaults to false + cluster_node_id (str): + The id of the node where to get the status. + + Returns: + :class:`~nipyapi.nifi.models.ConnectionStatusEntity`: The response data. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('callback'): + return self.get_connection_status_with_http_info(id, **kwargs) + else: + (data) = self.get_connection_status_with_http_info(id, **kwargs) + return data + + def get_connection_status_with_http_info(self, id, **kwargs): + """ + Gets status for a connection. + 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_connection_status()`` method instead. + + Args: + id (str): + The connection id. (required) + nodewise (bool): + Whether or not to include the breakdown per node. Optional, defaults to false + cluster_node_id (str): + The id of the node where to get the status. + + Returns: + tuple: (:class:`~nipyapi.nifi.models.ConnectionStatusEntity`, status_code, headers) - Response data with HTTP details. """ all_params = ['id', 'nodewise', 'cluster_node_id'] - all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -1363,7 +1620,9 @@ def get_connection_status_with_http_info(self, id, **kwargs): if ('id' not in params) or (params['id'] is None): raise ValueError("Missing the required parameter `id` when calling `get_connection_status`") - + + + collection_formats = {} path_params = {} @@ -1386,12 +1645,8 @@ def get_connection_status_with_http_info(self, id, **kwargs): header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['*/*']) - # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/flow/connections/{id}/status', 'GET', path_params, @@ -1402,7 +1657,6 @@ def get_connection_status_with_http_info(self, id, **kwargs): files=local_var_files, response_type='ConnectionStatusEntity', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), @@ -1410,22 +1664,18 @@ def get_connection_status_with_http_info(self, id, **kwargs): def get_connection_status_history(self, id, **kwargs): """ - Gets the status history for a connection + Gets the status history for a connection. + This method makes a synchronous HTTP request and returns the response data directly. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_connection_status_history(id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The connection id. (required) - :return: StatusHistoryEntity - If the method is called asynchronously, - returns the request thread. + For full HTTP response details (status code, headers, etc.), use the corresponding + ``get_connection_status_history_with_http_info()`` method instead. + + Args: + 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'): @@ -1436,26 +1686,21 @@ def get_connection_status_history(self, id, **kwargs): def get_connection_status_history_with_http_info(self, id, **kwargs): """ - Gets the status history for a connection + Gets the status history for a connection. + This method makes a synchronous HTTP request and returns detailed response information. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_connection_status_history_with_http_info(id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The connection id. (required) - :return: StatusHistoryEntity - If the method is called asynchronously, - returns the request thread. + Returns the response data along with HTTP status code, headers, and other metadata. + For just the response data, use the corresponding ``get_connection_status_history()`` method instead. + + Args: + id (str): + The connection id. (required) + + Returns: + tuple: (:class:`~nipyapi.nifi.models.StatusHistoryEntity`, status_code, headers) - Response data with HTTP details. """ all_params = ['id'] - all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -1473,7 +1718,7 @@ def get_connection_status_history_with_http_info(self, id, **kwargs): if ('id' not in params) or (params['id'] is None): raise ValueError("Missing the required parameter `id` when calling `get_connection_status_history`") - + collection_formats = {} path_params = {} @@ -1492,12 +1737,8 @@ def get_connection_status_history_with_http_info(self, id, **kwargs): header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['*/*']) - # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/flow/connections/{id}/status/history', 'GET', path_params, @@ -1508,7 +1749,216 @@ def get_connection_status_history_with_http_info(self, id, **kwargs): files=local_var_files, response_type='StatusHistoryEntity', auth_settings=auth_settings, - callback=params.get('callback'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def get_content_viewers(self, **kwargs): + """ + Retrieves the registered content viewers. + 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_content_viewers_with_http_info()`` method instead. + + Args: + + Returns: + :class:`~nipyapi.nifi.models.ContentViewerEntity`: The response data. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('callback'): + return self.get_content_viewers_with_http_info(**kwargs) + else: + (data) = self.get_content_viewers_with_http_info(**kwargs) + return data + + def get_content_viewers_with_http_info(self, **kwargs): + """ + Retrieves the registered content viewers. + 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_content_viewers()`` method instead. + + Args: + + Returns: + tuple: (:class:`~nipyapi.nifi.models.ContentViewerEntity`, status_code, headers) - Response data with HTTP details. + """ + + all_params = [] + 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_content_viewers" % key + ) + params[key] = val + del params['kwargs'] + + collection_formats = {} + + path_params = {} + + query_params = [] + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.\ + select_header_accept(['application/json']) + + # Authentication setting + auth_settings = ['bearerAuth'] + + return self.api_client.call_api('/flow/content-viewers', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='ContentViewerEntity', + 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_controller_service_definition(self, group, artifact, version, type, **kwargs): + """ + Retrieves the Controller Service Definition for the specified component type.. + + 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_controller_service_definition_with_http_info()`` method instead. + + Args: + group (str): + The bundle group (required) + artifact (str): + The bundle artifact (required) + version (str): + The bundle version (required) + type (str): + The controller service type (required) + + Returns: + :class:`~nipyapi.nifi.models.ControllerServiceDefinition`: The response data. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('callback'): + return self.get_controller_service_definition_with_http_info(group, artifact, version, type, **kwargs) + else: + (data) = self.get_controller_service_definition_with_http_info(group, artifact, version, type, **kwargs) + return data + + def get_controller_service_definition_with_http_info(self, group, artifact, version, type, **kwargs): + """ + Retrieves the Controller Service Definition for the specified component type.. + + 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_controller_service_definition()`` method instead. + + Args: + group (str): + The bundle group (required) + artifact (str): + The bundle artifact (required) + version (str): + The bundle version (required) + type (str): + The controller service type (required) + + Returns: + tuple: (:class:`~nipyapi.nifi.models.ControllerServiceDefinition`, status_code, headers) - Response data with HTTP details. + """ + + all_params = ['group', 'artifact', 'version', 'type'] + 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_controller_service_definition" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'group' is set + if ('group' not in params) or (params['group'] is None): + raise ValueError("Missing the required parameter `group` when calling `get_controller_service_definition`") + # verify the required parameter 'artifact' is set + if ('artifact' not in params) or (params['artifact'] is None): + raise ValueError("Missing the required parameter `artifact` when calling `get_controller_service_definition`") + # verify the required parameter 'version' is set + if ('version' not in params) or (params['version'] is None): + raise ValueError("Missing the required parameter `version` when calling `get_controller_service_definition`") + # verify the required parameter 'type' is set + if ('type' not in params) or (params['type'] is None): + raise ValueError("Missing the required parameter `type` when calling `get_controller_service_definition`") + + + + + + collection_formats = {} + + path_params = {} + if 'group' in params: + path_params['group'] = params['group'] + if 'artifact' in params: + path_params['artifact'] = params['artifact'] + if 'version' in params: + path_params['version'] = params['version'] + if 'type' in params: + path_params['type'] = params['type'] + + query_params = [] + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.\ + select_header_accept(['application/json']) + + # Authentication setting + auth_settings = ['bearerAuth'] + + return self.api_client.call_api('/flow/controller-service-definition/{group}/{artifact}/{version}/{type}', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='ControllerServiceDefinition', + 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'), @@ -1516,28 +1966,33 @@ def get_connection_status_history_with_http_info(self, id, **kwargs): def get_controller_service_types(self, **kwargs): """ - Retrieves the types of controller services that this NiFi supports + Retrieves the types of controller services that this NiFi supports. + Note: This endpoint is subject to change as NiFi and it's REST API evolve. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_controller_service_types(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str service_type: If specified, will only return controller services that are compatible with this type of service. - :param str service_bundle_group: If serviceType specified, is the bundle group of the serviceType. - :param str service_bundle_artifact: If serviceType specified, is the bundle artifact of the serviceType. - :param str service_bundle_version: If serviceType specified, is the bundle version of the serviceType. - :param str bundle_group_filter: If specified, will only return types that are a member of this bundle group. - :param str bundle_artifact_filter: If specified, will only return types that are a member of this bundle artifact. - :param str type_filter: If specified, will only return types whose fully qualified classname matches. - :return: ControllerServiceTypesEntity - If the method is called asynchronously, - returns the request thread. + + 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_controller_service_types_with_http_info()`` method instead. + + Args: + service_type (str): + If specified, will only return controller services that are compatible with this type of service. + service_bundle_group (str): + If serviceType specified, is the bundle group of the serviceType. + service_bundle_artifact (str): + If serviceType specified, is the bundle artifact of the serviceType. + service_bundle_version (str): + If serviceType specified, is the bundle version of the serviceType. + bundle_group_filter (str): + If specified, will only return types that are a member of this bundle group. + bundle_artifact_filter (str): + If specified, will only return types that are a member of this bundle artifact. + type_filter (str): + If specified, will only return types whose fully qualified classname matches. + + Returns: + :class:`~nipyapi.nifi.models.ControllerServiceTypesEntity`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): @@ -1548,32 +2003,36 @@ def get_controller_service_types(self, **kwargs): def get_controller_service_types_with_http_info(self, **kwargs): """ - Retrieves the types of controller services that this NiFi supports + Retrieves the types of controller services that this NiFi supports. + Note: This endpoint is subject to change as NiFi and it's REST API evolve. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_controller_service_types_with_http_info(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str service_type: If specified, will only return controller services that are compatible with this type of service. - :param str service_bundle_group: If serviceType specified, is the bundle group of the serviceType. - :param str service_bundle_artifact: If serviceType specified, is the bundle artifact of the serviceType. - :param str service_bundle_version: If serviceType specified, is the bundle version of the serviceType. - :param str bundle_group_filter: If specified, will only return types that are a member of this bundle group. - :param str bundle_artifact_filter: If specified, will only return types that are a member of this bundle artifact. - :param str type_filter: If specified, will only return types whose fully qualified classname matches. - :return: ControllerServiceTypesEntity - If the method is called asynchronously, - returns the request thread. + + 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_controller_service_types()`` method instead. + + Args: + service_type (str): + If specified, will only return controller services that are compatible with this type of service. + service_bundle_group (str): + If serviceType specified, is the bundle group of the serviceType. + service_bundle_artifact (str): + If serviceType specified, is the bundle artifact of the serviceType. + service_bundle_version (str): + If serviceType specified, is the bundle version of the serviceType. + bundle_group_filter (str): + If specified, will only return types that are a member of this bundle group. + bundle_artifact_filter (str): + If specified, will only return types that are a member of this bundle artifact. + type_filter (str): + If specified, will only return types whose fully qualified classname matches. + + Returns: + tuple: (:class:`~nipyapi.nifi.models.ControllerServiceTypesEntity`, status_code, headers) - Response data with HTTP details. """ all_params = ['service_type', 'service_bundle_group', 'service_bundle_artifact', 'service_bundle_version', 'bundle_group_filter', 'bundle_artifact_filter', 'type_filter'] - all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -1588,7 +2047,13 @@ def get_controller_service_types_with_http_info(self, **kwargs): params[key] = val del params['kwargs'] - + + + + + + + collection_formats = {} path_params = {} @@ -1619,12 +2084,8 @@ def get_controller_service_types_with_http_info(self, **kwargs): header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['*/*']) - # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/flow/controller-service-types', 'GET', path_params, @@ -1635,7 +2096,6 @@ def get_controller_service_types_with_http_info(self, **kwargs): files=local_var_files, response_type='ControllerServiceTypesEntity', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), @@ -1643,23 +2103,22 @@ def get_controller_service_types_with_http_info(self, **kwargs): def get_controller_services_from_controller(self, **kwargs): """ - Gets controller services for reporting tasks + Gets controller services for reporting tasks. + If the uiOnly query parameter is provided with a value of true, the returned entity may only contain fields that are necessary for rendering the NiFi User Interface. As such, the selected fields may change at any time, even during incremental releases, without warning. As a result, this parameter should not be provided by any client other than the UI. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_controller_services_from_controller(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param bool ui_only: - :param bool include_referencing_components: Whether or not to include services' referencing components in the response - :return: ControllerServicesEntity - If the method is called asynchronously, - returns the request thread. + + 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_controller_services_from_controller_with_http_info()`` method instead. + + Args: + ui_only (bool): + include_referencing_components (bool): + Whether or not to include services' referencing components in the response + + Returns: + :class:`~nipyapi.nifi.models.ControllerServicesEntity`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): @@ -1670,27 +2129,25 @@ def get_controller_services_from_controller(self, **kwargs): def get_controller_services_from_controller_with_http_info(self, **kwargs): """ - Gets controller services for reporting tasks + Gets controller services for reporting tasks. + If the uiOnly query parameter is provided with a value of true, the returned entity may only contain fields that are necessary for rendering the NiFi User Interface. As such, the selected fields may change at any time, even during incremental releases, without warning. As a result, this parameter should not be provided by any client other than the UI. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_controller_services_from_controller_with_http_info(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param bool ui_only: - :param bool include_referencing_components: Whether or not to include services' referencing components in the response - :return: ControllerServicesEntity - If the method is called asynchronously, - returns the request thread. + + 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_controller_services_from_controller()`` method instead. + + Args: + ui_only (bool): + include_referencing_components (bool): + Whether or not to include services' referencing components in the response + + Returns: + tuple: (:class:`~nipyapi.nifi.models.ControllerServicesEntity`, status_code, headers) - Response data with HTTP details. """ all_params = ['ui_only', 'include_referencing_components'] - all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -1705,7 +2162,8 @@ def get_controller_services_from_controller_with_http_info(self, **kwargs): params[key] = val del params['kwargs'] - + + collection_formats = {} path_params = {} @@ -1726,12 +2184,8 @@ def get_controller_services_from_controller_with_http_info(self, **kwargs): header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['*/*']) - # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/flow/controller/controller-services', 'GET', path_params, @@ -1742,7 +2196,6 @@ def get_controller_services_from_controller_with_http_info(self, **kwargs): files=local_var_files, response_type='ControllerServicesEntity', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), @@ -1750,26 +2203,28 @@ def get_controller_services_from_controller_with_http_info(self, **kwargs): def get_controller_services_from_group(self, id, **kwargs): """ - Gets all controller services + Gets all controller services. + If the uiOnly query parameter is provided with a value of true, the returned entity may only contain fields that are necessary for rendering the NiFi User Interface. As such, the selected fields may change at any time, even during incremental releases, without warning. As a result, this parameter should not be provided by any client other than the UI. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_controller_services_from_group(id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The process group id. (required) - :param bool include_ancestor_groups: Whether or not to include parent/ancestor process groups - :param bool include_descendant_groups: Whether or not to include descendant process groups - :param bool include_referencing_components: Whether or not to include services' referencing components in the response - :param bool ui_only: - :return: ControllerServicesEntity - If the method is called asynchronously, - returns the request thread. + + 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_controller_services_from_group_with_http_info()`` method instead. + + Args: + id (str): + The process group id. (required) + include_ancestor_groups (bool): + Whether or not to include parent/ancestor process groups + include_descendant_groups (bool): + Whether or not to include descendant process groups + include_referencing_components (bool): + Whether or not to include services' referencing components in the response + ui_only (bool): + + Returns: + :class:`~nipyapi.nifi.models.ControllerServicesEntity`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): @@ -1780,30 +2235,31 @@ def get_controller_services_from_group(self, id, **kwargs): def get_controller_services_from_group_with_http_info(self, id, **kwargs): """ - Gets all controller services + Gets all controller services. + If the uiOnly query parameter is provided with a value of true, the returned entity may only contain fields that are necessary for rendering the NiFi User Interface. As such, the selected fields may change at any time, even during incremental releases, without warning. As a result, this parameter should not be provided by any client other than the UI. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_controller_services_from_group_with_http_info(id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The process group id. (required) - :param bool include_ancestor_groups: Whether or not to include parent/ancestor process groups - :param bool include_descendant_groups: Whether or not to include descendant process groups - :param bool include_referencing_components: Whether or not to include services' referencing components in the response - :param bool ui_only: - :return: ControllerServicesEntity - If the method is called asynchronously, - returns the request thread. + + 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_controller_services_from_group()`` method instead. + + Args: + id (str): + The process group id. (required) + include_ancestor_groups (bool): + Whether or not to include parent/ancestor process groups + include_descendant_groups (bool): + Whether or not to include descendant process groups + include_referencing_components (bool): + Whether or not to include services' referencing components in the response + ui_only (bool): + + Returns: + tuple: (:class:`~nipyapi.nifi.models.ControllerServicesEntity`, status_code, headers) - Response data with HTTP details. """ all_params = ['id', 'include_ancestor_groups', 'include_descendant_groups', 'include_referencing_components', 'ui_only'] - all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -1821,7 +2277,11 @@ def get_controller_services_from_group_with_http_info(self, id, **kwargs): if ('id' not in params) or (params['id'] is None): raise ValueError("Missing the required parameter `id` when calling `get_controller_services_from_group`") - + + + + + collection_formats = {} path_params = {} @@ -1848,12 +2308,8 @@ def get_controller_services_from_group_with_http_info(self, id, **kwargs): header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['*/*']) - # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/flow/process-groups/{id}/controller-services', 'GET', path_params, @@ -1864,7 +2320,6 @@ def get_controller_services_from_group_with_http_info(self, id, **kwargs): files=local_var_files, response_type='ControllerServicesEntity', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), @@ -1872,21 +2327,16 @@ def get_controller_services_from_group_with_http_info(self, id, **kwargs): def get_controller_status(self, **kwargs): """ - Gets the current status of this NiFi + Gets the current status of this NiFi. + This method makes a synchronous HTTP request and returns the response data directly. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_controller_status(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :return: ControllerStatusEntity - If the method is called asynchronously, - returns the request thread. + For full HTTP response details (status code, headers, etc.), use the corresponding + ``get_controller_status_with_http_info()`` method instead. + + Args: + + Returns: + :class:`~nipyapi.nifi.models.ControllerStatusEntity`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): @@ -1897,25 +2347,19 @@ def get_controller_status(self, **kwargs): def get_controller_status_with_http_info(self, **kwargs): """ - Gets the current status of this NiFi + Gets the current status of this NiFi. + This method makes a synchronous HTTP request and returns detailed response information. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_controller_status_with_http_info(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :return: ControllerStatusEntity - If the method is called asynchronously, - returns the request thread. + Returns the response data along with HTTP status code, headers, and other metadata. + For just the response data, use the corresponding ``get_controller_status()`` method instead. + + Args: + + Returns: + tuple: (:class:`~nipyapi.nifi.models.ControllerStatusEntity`, status_code, headers) - Response data with HTTP details. """ all_params = [] - all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -1946,12 +2390,8 @@ def get_controller_status_with_http_info(self, **kwargs): header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['*/*']) - # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/flow/status', 'GET', path_params, @@ -1962,7 +2402,6 @@ def get_controller_status_with_http_info(self, **kwargs): files=local_var_files, response_type='ControllerStatusEntity', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), @@ -1970,21 +2409,16 @@ def get_controller_status_with_http_info(self, **kwargs): def get_current_user(self, **kwargs): """ - Retrieves the user identity of the user making the request + Retrieves the user identity of the user making the request. + This method makes a synchronous HTTP request and returns the response data directly. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_current_user(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :return: CurrentUserEntity - If the method is called asynchronously, - returns the request thread. + For full HTTP response details (status code, headers, etc.), use the corresponding + ``get_current_user_with_http_info()`` method instead. + + Args: + + Returns: + :class:`~nipyapi.nifi.models.CurrentUserEntity`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): @@ -1995,25 +2429,19 @@ def get_current_user(self, **kwargs): def get_current_user_with_http_info(self, **kwargs): """ - Retrieves the user identity of the user making the request + Retrieves the user identity of the user making the request. + This method makes a synchronous HTTP request and returns detailed response information. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_current_user_with_http_info(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :return: CurrentUserEntity - If the method is called asynchronously, - returns the request thread. + Returns the response data along with HTTP status code, headers, and other metadata. + For just the response data, use the corresponding ``get_current_user()`` method instead. + + Args: + + Returns: + tuple: (:class:`~nipyapi.nifi.models.CurrentUserEntity`, status_code, headers) - Response data with HTTP details. """ all_params = [] - all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -2044,12 +2472,8 @@ def get_current_user_with_http_info(self, **kwargs): header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['*/*']) - # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/flow/current-user', 'GET', path_params, @@ -2060,7 +2484,6 @@ def get_current_user_with_http_info(self, **kwargs): files=local_var_files, response_type='CurrentUserEntity', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), @@ -2068,24 +2491,24 @@ def get_current_user_with_http_info(self, **kwargs): def get_details(self, registry_id, bucket_id, flow_id, **kwargs): """ - Gets the details of a flow from the specified registry and bucket for the specified flow for the current user - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_details(registry_id, bucket_id, flow_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str registry_id: The registry client id. (required) - :param str bucket_id: The bucket id. (required) - :param str flow_id: The flow id. (required) - :return: VersionedFlowEntity - If the method is called asynchronously, - returns the request thread. + Gets the details of a flow from the specified registry and bucket for the specified flow for the current user. + 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_details_with_http_info()`` method instead. + + Args: + registry_id (str): + The registry client id. (required) + bucket_id (str): + The bucket id. (required) + flow_id (str): + The flow id. (required) + branch (str): + The name of a branch to get the flow from. If not specified the default branch of the registry client will be used. + + Returns: + :class:`~nipyapi.nifi.models.VersionedFlowEntity`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): @@ -2096,28 +2519,27 @@ def get_details(self, registry_id, bucket_id, flow_id, **kwargs): def get_details_with_http_info(self, registry_id, bucket_id, flow_id, **kwargs): """ - Gets the details of a flow from the specified registry and bucket for the specified flow for the current user + Gets the details of a flow from the specified registry and bucket for the specified flow for the current user. + This method makes a synchronous HTTP request and returns detailed response information. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_details_with_http_info(registry_id, bucket_id, flow_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str registry_id: The registry client id. (required) - :param str bucket_id: The bucket id. (required) - :param str flow_id: The flow id. (required) - :return: VersionedFlowEntity - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['registry_id', 'bucket_id', 'flow_id'] - all_params.append('callback') + Returns the response data along with HTTP status code, headers, and other metadata. + For just the response data, use the corresponding ``get_details()`` method instead. + + Args: + registry_id (str): + The registry client id. (required) + bucket_id (str): + The bucket id. (required) + flow_id (str): + The flow id. (required) + branch (str): + The name of a branch to get the flow from. If not specified the default branch of the registry client will be used. + + Returns: + tuple: (:class:`~nipyapi.nifi.models.VersionedFlowEntity`, status_code, headers) - Response data with HTTP details. + """ + + all_params = ['registry_id', 'bucket_id', 'flow_id', 'branch'] all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -2141,7 +2563,10 @@ def get_details_with_http_info(self, registry_id, bucket_id, flow_id, **kwargs): if ('flow_id' not in params) or (params['flow_id'] is None): raise ValueError("Missing the required parameter `flow_id` when calling `get_details`") - + + + + collection_formats = {} path_params = {} @@ -2153,6 +2578,8 @@ def get_details_with_http_info(self, registry_id, bucket_id, flow_id, **kwargs): path_params['flow-id'] = params['flow_id'] query_params = [] + if 'branch' in params: + query_params.append(('branch', params['branch'])) header_params = {} @@ -2164,12 +2591,8 @@ def get_details_with_http_info(self, registry_id, bucket_id, flow_id, **kwargs): header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['*/*']) - # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/flow/registries/{registry-id}/buckets/{bucket-id}/flows/{flow-id}/details', 'GET', path_params, @@ -2180,7 +2603,6 @@ def get_details_with_http_info(self, registry_id, bucket_id, flow_id, **kwargs): files=local_var_files, response_type='VersionedFlowEntity', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), @@ -2188,23 +2610,22 @@ def get_details_with_http_info(self, registry_id, bucket_id, flow_id, **kwargs): def get_flow(self, id, **kwargs): """ - Gets a process group + Gets a process group. + If the uiOnly query parameter is provided with a value of true, the returned entity may only contain fields that are necessary for rendering the NiFi User Interface. As such, the selected fields may change at any time, even during incremental releases, without warning. As a result, this parameter should not be provided by any client other than the UI. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_flow(id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The process group id. (required) - :param bool ui_only: - :return: ProcessGroupFlowEntity - If the method is called asynchronously, - returns the request thread. + + 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_flow_with_http_info()`` method instead. + + Args: + id (str): + The process group id. (required) + ui_only (bool): + + Returns: + :class:`~nipyapi.nifi.models.ProcessGroupFlowEntity`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): @@ -2215,27 +2636,354 @@ def get_flow(self, id, **kwargs): def get_flow_with_http_info(self, id, **kwargs): """ - Gets a process group - If the uiOnly query parameter is provided with a value of true, the returned entity may only contain fields that are necessary for rendering the NiFi User Interface. As such, the selected fields may change at any time, even during incremental releases, without warning. As a result, this parameter should not be provided by any client other than the UI. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_flow_with_http_info(id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The process group id. (required) - :param bool ui_only: - :return: ProcessGroupFlowEntity - If the method is called asynchronously, - returns the request thread. + Gets a process group. + + If the uiOnly query parameter is provided with a value of true, the returned entity may only contain fields that are necessary for rendering the NiFi User Interface. As such, the selected fields may change at any time, even during incremental releases, without warning. As a result, this parameter should not be provided by any client other than the UI. + + This method makes a synchronous HTTP request 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_flow()`` method instead. + + Args: + id (str): + The process group id. (required) + ui_only (bool): + + Returns: + tuple: (:class:`~nipyapi.nifi.models.ProcessGroupFlowEntity`, status_code, headers) - Response data with HTTP details. + """ + + all_params = ['id', 'ui_only'] + 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_flow" % 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_flow`") + + + + collection_formats = {} + + path_params = {} + if 'id' in params: + path_params['id'] = params['id'] + + query_params = [] + if 'ui_only' in params: + query_params.append(('uiOnly', params['ui_only'])) + + 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('/flow/process-groups/{id}', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='ProcessGroupFlowEntity', + 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_flow_analysis_results(self, process_group_id, **kwargs): + """ + Returns flow analysis results produced by the analysis of a given process group. + 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_flow_analysis_results_with_http_info()`` method instead. + + Args: + process_group_id (str): + The id of the process group representing (a part of) the flow to be analyzed. (required) + + Returns: + :class:`~nipyapi.nifi.models.FlowAnalysisResultEntity`: The response data. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('callback'): + return self.get_flow_analysis_results_with_http_info(process_group_id, **kwargs) + else: + (data) = self.get_flow_analysis_results_with_http_info(process_group_id, **kwargs) + return data + + def get_flow_analysis_results_with_http_info(self, process_group_id, **kwargs): + """ + Returns flow analysis results produced by the analysis of a given process group. + 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_flow_analysis_results()`` method instead. + + Args: + process_group_id (str): + The id of the process group representing (a part of) the flow to be analyzed. (required) + + Returns: + tuple: (:class:`~nipyapi.nifi.models.FlowAnalysisResultEntity`, status_code, headers) - Response data with HTTP details. + """ + + all_params = ['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_flow_analysis_results" % key + ) + params[key] = val + del params['kwargs'] + # 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_flow_analysis_results`") + + + collection_formats = {} + + path_params = {} + if 'process_group_id' in params: + path_params['processGroupId'] = params['process_group_id'] + + query_params = [] + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.\ + select_header_accept(['application/json']) + + # Authentication setting + auth_settings = ['bearerAuth'] + + return self.api_client.call_api('/flow/flow-analysis/results/{processGroupId}', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='FlowAnalysisResultEntity', + 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_flow_analysis_rule_definition(self, group, artifact, version, type, **kwargs): + """ + Retrieves the Flow Analysis Rule Definition for the specified component type.. + + 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_flow_analysis_rule_definition_with_http_info()`` method instead. + + Args: + group (str): + The bundle group (required) + artifact (str): + The bundle artifact (required) + version (str): + The bundle version (required) + type (str): + The flow analysis rule type (required) + + Returns: + :class:`~nipyapi.nifi.models.FlowAnalysisRuleDefinition`: The response data. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('callback'): + return self.get_flow_analysis_rule_definition_with_http_info(group, artifact, version, type, **kwargs) + else: + (data) = self.get_flow_analysis_rule_definition_with_http_info(group, artifact, version, type, **kwargs) + return data + + def get_flow_analysis_rule_definition_with_http_info(self, group, artifact, version, type, **kwargs): + """ + Retrieves the Flow Analysis Rule Definition for the specified component type.. + + 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_flow_analysis_rule_definition()`` method instead. + + Args: + group (str): + The bundle group (required) + artifact (str): + The bundle artifact (required) + version (str): + The bundle version (required) + type (str): + The flow analysis rule type (required) + + Returns: + tuple: (:class:`~nipyapi.nifi.models.FlowAnalysisRuleDefinition`, status_code, headers) - Response data with HTTP details. + """ + + all_params = ['group', 'artifact', 'version', 'type'] + 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_flow_analysis_rule_definition" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'group' is set + if ('group' not in params) or (params['group'] is None): + raise ValueError("Missing the required parameter `group` when calling `get_flow_analysis_rule_definition`") + # verify the required parameter 'artifact' is set + if ('artifact' not in params) or (params['artifact'] is None): + raise ValueError("Missing the required parameter `artifact` when calling `get_flow_analysis_rule_definition`") + # verify the required parameter 'version' is set + if ('version' not in params) or (params['version'] is None): + raise ValueError("Missing the required parameter `version` when calling `get_flow_analysis_rule_definition`") + # verify the required parameter 'type' is set + if ('type' not in params) or (params['type'] is None): + raise ValueError("Missing the required parameter `type` when calling `get_flow_analysis_rule_definition`") + + + + + + collection_formats = {} + + path_params = {} + if 'group' in params: + path_params['group'] = params['group'] + if 'artifact' in params: + path_params['artifact'] = params['artifact'] + if 'version' in params: + path_params['version'] = params['version'] + if 'type' in params: + path_params['type'] = params['type'] + + query_params = [] + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.\ + select_header_accept(['application/json']) + + # Authentication setting + auth_settings = ['bearerAuth'] + + return self.api_client.call_api('/flow/flow-analysis-rule-definition/{group}/{artifact}/{version}/{type}', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='FlowAnalysisRuleDefinition', + 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_flow_analysis_rule_types(self, **kwargs): + """ + Retrieves the types of available Flow Analysis Rules. + + 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_flow_analysis_rule_types_with_http_info()`` method instead. + + Args: + bundle_group_filter (str): + If specified, will only return types that are a member of this bundle group. + bundle_artifact_filter (str): + If specified, will only return types that are a member of this bundle artifact. + type (str): + If specified, will only return types whose fully qualified classname matches. + + Returns: + :class:`~nipyapi.nifi.models.FlowAnalysisRuleTypesEntity`: The response data. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('callback'): + return self.get_flow_analysis_rule_types_with_http_info(**kwargs) + else: + (data) = self.get_flow_analysis_rule_types_with_http_info(**kwargs) + return data + + def get_flow_analysis_rule_types_with_http_info(self, **kwargs): + """ + Retrieves the types of available Flow Analysis Rules. + + 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_flow_analysis_rule_types()`` method instead. + + Args: + bundle_group_filter (str): + If specified, will only return types that are a member of this bundle group. + bundle_artifact_filter (str): + If specified, will only return types that are a member of this bundle artifact. + type (str): + If specified, will only return types whose fully qualified classname matches. + + Returns: + tuple: (:class:`~nipyapi.nifi.models.FlowAnalysisRuleTypesEntity`, status_code, headers) - Response data with HTTP details. """ - all_params = ['id', 'ui_only'] - all_params.append('callback') + all_params = ['bundle_group_filter', 'bundle_artifact_filter', 'type'] all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -2245,24 +2993,25 @@ def get_flow_with_http_info(self, id, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method get_flow" % key + " to method get_flow_analysis_rule_types" % 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_flow`") - + + + collection_formats = {} path_params = {} - if 'id' in params: - path_params['id'] = params['id'] query_params = [] - if 'ui_only' in params: - query_params.append(('uiOnly', params['ui_only'])) + if 'bundle_group_filter' in params: + query_params.append(('bundleGroupFilter', params['bundle_group_filter'])) + if 'bundle_artifact_filter' in params: + query_params.append(('bundleArtifactFilter', params['bundle_artifact_filter'])) + if 'type' in params: + query_params.append(('type', params['type'])) header_params = {} @@ -2274,23 +3023,18 @@ def get_flow_with_http_info(self, id, **kwargs): header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['*/*']) - # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] - return self.api_client.call_api('/flow/process-groups/{id}', 'GET', + return self.api_client.call_api('/flow/flow-analysis-rule-types', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, - response_type='ProcessGroupFlowEntity', + response_type='FlowAnalysisRuleTypesEntity', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), @@ -2298,21 +3042,16 @@ def get_flow_with_http_info(self, id, **kwargs): def get_flow_config(self, **kwargs): """ - Retrieves the configuration for this NiFi flow + Retrieves the configuration for this NiFi flow. + This method makes a synchronous HTTP request and returns the response data directly. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_flow_config(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :return: FlowConfigurationEntity - If the method is called asynchronously, - returns the request thread. + For full HTTP response details (status code, headers, etc.), use the corresponding + ``get_flow_config_with_http_info()`` method instead. + + Args: + + Returns: + :class:`~nipyapi.nifi.models.FlowConfigurationEntity`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): @@ -2323,25 +3062,19 @@ def get_flow_config(self, **kwargs): def get_flow_config_with_http_info(self, **kwargs): """ - Retrieves the configuration for this NiFi flow + Retrieves the configuration for this NiFi flow. + This method makes a synchronous HTTP request and returns detailed response information. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_flow_config_with_http_info(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :return: FlowConfigurationEntity - If the method is called asynchronously, - returns the request thread. + Returns the response data along with HTTP status code, headers, and other metadata. + For just the response data, use the corresponding ``get_flow_config()`` method instead. + + Args: + + Returns: + tuple: (:class:`~nipyapi.nifi.models.FlowConfigurationEntity`, status_code, headers) - Response data with HTTP details. """ all_params = [] - all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -2372,12 +3105,8 @@ def get_flow_config_with_http_info(self, **kwargs): header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['*/*']) - # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/flow/config', 'GET', path_params, @@ -2388,7 +3117,6 @@ def get_flow_config_with_http_info(self, **kwargs): files=local_var_files, response_type='FlowConfigurationEntity', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), @@ -2396,26 +3124,26 @@ def get_flow_config_with_http_info(self, **kwargs): def get_flow_metrics(self, producer, **kwargs): """ - Gets all metrics for the flow from a particular node - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_flow_metrics(producer, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str producer: The producer for flow file metrics. Each producer may have its own output format. (required) - :param list[str] included_registries: Set of included metrics registries - :param str sample_name: Regular Expression Pattern to be applied against the sample name field - :param str sample_label_value: Regular Expression Pattern to be applied against the sample label value field - :param str root_field_name: Name of the first field of JSON object. Applicable for JSON producer only. - :return: StreamingOutput - If the method is called asynchronously, - returns the request thread. + Gets all metrics for the flow from a particular node. + 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_flow_metrics_with_http_info()`` method instead. + + Args: + producer (str): + The producer for flow file metrics. Each producer may have its own output format. (required) + included_registries (:class:`~nipyapi.nifi.models.list[str]`): + Set of included metrics registries. Duplicate the parameter to include multiple registries. All registries are included by default. + sample_name (str): + Regular Expression Pattern to be applied against the sample name field + sample_label_value (str): + Regular Expression Pattern to be applied against the sample label value field + root_field_name (str): + Name of the first field of JSON object. Applicable for JSON producer only. + + Returns: + :class:`~nipyapi.nifi.models.StreamingOutput`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): @@ -2426,30 +3154,29 @@ def get_flow_metrics(self, producer, **kwargs): def get_flow_metrics_with_http_info(self, producer, **kwargs): """ - Gets all metrics for the flow from a particular node + Gets all metrics for the flow from a particular node. + This method makes a synchronous HTTP request and returns detailed response information. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_flow_metrics_with_http_info(producer, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str producer: The producer for flow file metrics. Each producer may have its own output format. (required) - :param list[str] included_registries: Set of included metrics registries - :param str sample_name: Regular Expression Pattern to be applied against the sample name field - :param str sample_label_value: Regular Expression Pattern to be applied against the sample label value field - :param str root_field_name: Name of the first field of JSON object. Applicable for JSON producer only. - :return: StreamingOutput - If the method is called asynchronously, - returns the request thread. + Returns the response data along with HTTP status code, headers, and other metadata. + For just the response data, use the corresponding ``get_flow_metrics()`` method instead. + + Args: + producer (str): + The producer for flow file metrics. Each producer may have its own output format. (required) + included_registries (:class:`~nipyapi.nifi.models.list[str]`): + Set of included metrics registries. Duplicate the parameter to include multiple registries. All registries are included by default. + sample_name (str): + Regular Expression Pattern to be applied against the sample name field + sample_label_value (str): + Regular Expression Pattern to be applied against the sample label value field + root_field_name (str): + Name of the first field of JSON object. Applicable for JSON producer only. + + Returns: + tuple: (:class:`~nipyapi.nifi.models.StreamingOutput`, status_code, headers) - Response data with HTTP details. """ all_params = ['producer', 'included_registries', 'sample_name', 'sample_label_value', 'root_field_name'] - all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -2467,7 +3194,11 @@ def get_flow_metrics_with_http_info(self, producer, **kwargs): if ('producer' not in params) or (params['producer'] is None): raise ValueError("Missing the required parameter `producer` when calling `get_flow_metrics`") - + + + + + collection_formats = {} path_params = {} @@ -2495,12 +3226,8 @@ def get_flow_metrics_with_http_info(self, producer, **kwargs): header_params['Accept'] = self.api_client.\ select_header_accept(['*/*']) - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['*/*']) - # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/flow/metrics/{producer}', 'GET', path_params, @@ -2511,7 +3238,6 @@ def get_flow_metrics_with_http_info(self, producer, **kwargs): files=local_var_files, response_type='StreamingOutput', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), @@ -2519,23 +3245,22 @@ def get_flow_metrics_with_http_info(self, producer, **kwargs): def get_flows(self, registry_id, bucket_id, **kwargs): """ - Gets the flows from the specified registry and bucket for the current user + Gets the flows from the specified registry and bucket for the current user. + This method makes a synchronous HTTP request and returns the response data directly. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_flows(registry_id, bucket_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str registry_id: The registry client id. (required) - :param str bucket_id: The bucket id. (required) - :return: VersionedFlowsEntity - If the method is called asynchronously, - returns the request thread. + For full HTTP response details (status code, headers, etc.), use the corresponding + ``get_flows_with_http_info()`` method instead. + + Args: + registry_id (str): + The registry client id. (required) + bucket_id (str): + The bucket id. (required) + branch (str): + The name of a branch to get the flows from. If not specified the default branch of the registry client will be used. + + Returns: + :class:`~nipyapi.nifi.models.VersionedFlowsEntity`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): @@ -2546,27 +3271,25 @@ def get_flows(self, registry_id, bucket_id, **kwargs): def get_flows_with_http_info(self, registry_id, bucket_id, **kwargs): """ - Gets the flows from the specified registry and bucket for the current user + Gets the flows from the specified registry and bucket for the current user. + This method makes a synchronous HTTP request and returns detailed response information. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_flows_with_http_info(registry_id, bucket_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str registry_id: The registry client id. (required) - :param str bucket_id: The bucket id. (required) - :return: VersionedFlowsEntity - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['registry_id', 'bucket_id'] - all_params.append('callback') + Returns the response data along with HTTP status code, headers, and other metadata. + For just the response data, use the corresponding ``get_flows()`` method instead. + + Args: + registry_id (str): + The registry client id. (required) + bucket_id (str): + The bucket id. (required) + branch (str): + The name of a branch to get the flows from. If not specified the default branch of the registry client will be used. + + Returns: + tuple: (:class:`~nipyapi.nifi.models.VersionedFlowsEntity`, status_code, headers) - Response data with HTTP details. + """ + + all_params = ['registry_id', 'bucket_id', 'branch'] all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -2587,7 +3310,9 @@ def get_flows_with_http_info(self, registry_id, bucket_id, **kwargs): if ('bucket_id' not in params) or (params['bucket_id'] is None): raise ValueError("Missing the required parameter `bucket_id` when calling `get_flows`") - + + + collection_formats = {} path_params = {} @@ -2597,6 +3322,8 @@ def get_flows_with_http_info(self, registry_id, bucket_id, **kwargs): path_params['bucket-id'] = params['bucket_id'] query_params = [] + if 'branch' in params: + query_params.append(('branch', params['branch'])) header_params = {} @@ -2608,12 +3335,8 @@ def get_flows_with_http_info(self, registry_id, bucket_id, **kwargs): header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['*/*']) - # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/flow/registries/{registry-id}/buckets/{bucket-id}/flows', 'GET', path_params, @@ -2624,7 +3347,6 @@ def get_flows_with_http_info(self, registry_id, bucket_id, **kwargs): files=local_var_files, response_type='VersionedFlowsEntity', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), @@ -2632,24 +3354,22 @@ def get_flows_with_http_info(self, registry_id, bucket_id, **kwargs): def get_input_port_status(self, id, **kwargs): """ - Gets status for an input port - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_input_port_status(id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The input port id. (required) - :param bool nodewise: Whether or not to include the breakdown per node. Optional, defaults to false - :param str cluster_node_id: The id of the node where to get the status. - :return: PortStatusEntity - If the method is called asynchronously, - returns the request thread. + Gets status for an input port. + 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_input_port_status_with_http_info()`` method instead. + + Args: + id (str): + The input port id. (required) + nodewise (bool): + Whether or not to include the breakdown per node. Optional, defaults to false + cluster_node_id (str): + The id of the node where to get the status. + + Returns: + :class:`~nipyapi.nifi.models.PortStatusEntity`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): @@ -2660,28 +3380,25 @@ def get_input_port_status(self, id, **kwargs): def get_input_port_status_with_http_info(self, id, **kwargs): """ - Gets status for an input port + Gets status for an input port. + This method makes a synchronous HTTP request and returns detailed response information. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_input_port_status_with_http_info(id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The input port id. (required) - :param bool nodewise: Whether or not to include the breakdown per node. Optional, defaults to false - :param str cluster_node_id: The id of the node where to get the status. - :return: PortStatusEntity - If the method is called asynchronously, - returns the request thread. + Returns the response data along with HTTP status code, headers, and other metadata. + For just the response data, use the corresponding ``get_input_port_status()`` method instead. + + Args: + id (str): + The input port id. (required) + nodewise (bool): + Whether or not to include the breakdown per node. Optional, defaults to false + cluster_node_id (str): + The id of the node where to get the status. + + Returns: + tuple: (:class:`~nipyapi.nifi.models.PortStatusEntity`, status_code, headers) - Response data with HTTP details. """ all_params = ['id', 'nodewise', 'cluster_node_id'] - all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -2699,7 +3416,9 @@ def get_input_port_status_with_http_info(self, id, **kwargs): if ('id' not in params) or (params['id'] is None): raise ValueError("Missing the required parameter `id` when calling `get_input_port_status`") - + + + collection_formats = {} path_params = {} @@ -2722,12 +3441,8 @@ def get_input_port_status_with_http_info(self, id, **kwargs): header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['*/*']) - # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/flow/input-ports/{id}/status', 'GET', path_params, @@ -2738,7 +3453,6 @@ def get_input_port_status_with_http_info(self, id, **kwargs): files=local_var_files, response_type='PortStatusEntity', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), @@ -2746,24 +3460,22 @@ def get_input_port_status_with_http_info(self, id, **kwargs): def get_output_port_status(self, id, **kwargs): """ - Gets status for an output port - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_output_port_status(id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The output port id. (required) - :param bool nodewise: Whether or not to include the breakdown per node. Optional, defaults to false - :param str cluster_node_id: The id of the node where to get the status. - :return: PortStatusEntity - If the method is called asynchronously, - returns the request thread. + Gets status for an output port. + 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_output_port_status_with_http_info()`` method instead. + + Args: + id (str): + The output port id. (required) + nodewise (bool): + Whether or not to include the breakdown per node. Optional, defaults to false + cluster_node_id (str): + The id of the node where to get the status. + + Returns: + :class:`~nipyapi.nifi.models.PortStatusEntity`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): @@ -2774,28 +3486,25 @@ def get_output_port_status(self, id, **kwargs): def get_output_port_status_with_http_info(self, id, **kwargs): """ - Gets status for an output port + Gets status for an output port. + This method makes a synchronous HTTP request and returns detailed response information. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_output_port_status_with_http_info(id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The output port id. (required) - :param bool nodewise: Whether or not to include the breakdown per node. Optional, defaults to false - :param str cluster_node_id: The id of the node where to get the status. - :return: PortStatusEntity - If the method is called asynchronously, - returns the request thread. + Returns the response data along with HTTP status code, headers, and other metadata. + For just the response data, use the corresponding ``get_output_port_status()`` method instead. + + Args: + id (str): + The output port id. (required) + nodewise (bool): + Whether or not to include the breakdown per node. Optional, defaults to false + cluster_node_id (str): + The id of the node where to get the status. + + Returns: + tuple: (:class:`~nipyapi.nifi.models.PortStatusEntity`, status_code, headers) - Response data with HTTP details. """ all_params = ['id', 'nodewise', 'cluster_node_id'] - all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -2813,7 +3522,9 @@ def get_output_port_status_with_http_info(self, id, **kwargs): if ('id' not in params) or (params['id'] is None): raise ValueError("Missing the required parameter `id` when calling `get_output_port_status`") - + + + collection_formats = {} path_params = {} @@ -2836,12 +3547,8 @@ def get_output_port_status_with_http_info(self, id, **kwargs): header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['*/*']) - # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/flow/output-ports/{id}/status', 'GET', path_params, @@ -2852,7 +3559,6 @@ def get_output_port_status_with_http_info(self, id, **kwargs): files=local_var_files, response_type='PortStatusEntity', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), @@ -2860,21 +3566,16 @@ def get_output_port_status_with_http_info(self, id, **kwargs): def get_parameter_contexts(self, **kwargs): """ - Gets all Parameter Contexts + Gets all Parameter Contexts. + This method makes a synchronous HTTP request and returns the response data directly. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_parameter_contexts(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :return: ParameterContextsEntity - If the method is called asynchronously, - returns the request thread. + For full HTTP response details (status code, headers, etc.), use the corresponding + ``get_parameter_contexts_with_http_info()`` method instead. + + Args: + + Returns: + :class:`~nipyapi.nifi.models.ParameterContextsEntity`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): @@ -2885,25 +3586,19 @@ def get_parameter_contexts(self, **kwargs): def get_parameter_contexts_with_http_info(self, **kwargs): """ - Gets all Parameter Contexts + Gets all Parameter Contexts. + This method makes a synchronous HTTP request and returns detailed response information. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_parameter_contexts_with_http_info(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :return: ParameterContextsEntity - If the method is called asynchronously, - returns the request thread. + Returns the response data along with HTTP status code, headers, and other metadata. + For just the response data, use the corresponding ``get_parameter_contexts()`` method instead. + + Args: + + Returns: + tuple: (:class:`~nipyapi.nifi.models.ParameterContextsEntity`, status_code, headers) - Response data with HTTP details. """ all_params = [] - all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -2934,12 +3629,8 @@ def get_parameter_contexts_with_http_info(self, **kwargs): header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['*/*']) - # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/flow/parameter-contexts', 'GET', path_params, @@ -2950,7 +3641,134 @@ def get_parameter_contexts_with_http_info(self, **kwargs): files=local_var_files, response_type='ParameterContextsEntity', auth_settings=auth_settings, - callback=params.get('callback'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def get_parameter_provider_definition(self, group, artifact, version, type, **kwargs): + """ + Retrieves the Parameter Provider Definition for the specified component type.. + + 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_parameter_provider_definition_with_http_info()`` method instead. + + Args: + group (str): + The bundle group (required) + artifact (str): + The bundle artifact (required) + version (str): + The bundle version (required) + type (str): + The parameter provider type (required) + + Returns: + :class:`~nipyapi.nifi.models.ParameterProviderDefinition`: The response data. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('callback'): + return self.get_parameter_provider_definition_with_http_info(group, artifact, version, type, **kwargs) + else: + (data) = self.get_parameter_provider_definition_with_http_info(group, artifact, version, type, **kwargs) + return data + + def get_parameter_provider_definition_with_http_info(self, group, artifact, version, type, **kwargs): + """ + Retrieves the Parameter Provider Definition for the specified component type.. + + 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_parameter_provider_definition()`` method instead. + + Args: + group (str): + The bundle group (required) + artifact (str): + The bundle artifact (required) + version (str): + The bundle version (required) + type (str): + The parameter provider type (required) + + Returns: + tuple: (:class:`~nipyapi.nifi.models.ParameterProviderDefinition`, status_code, headers) - Response data with HTTP details. + """ + + all_params = ['group', 'artifact', 'version', 'type'] + 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_parameter_provider_definition" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'group' is set + if ('group' not in params) or (params['group'] is None): + raise ValueError("Missing the required parameter `group` when calling `get_parameter_provider_definition`") + # verify the required parameter 'artifact' is set + if ('artifact' not in params) or (params['artifact'] is None): + raise ValueError("Missing the required parameter `artifact` when calling `get_parameter_provider_definition`") + # verify the required parameter 'version' is set + if ('version' not in params) or (params['version'] is None): + raise ValueError("Missing the required parameter `version` when calling `get_parameter_provider_definition`") + # verify the required parameter 'type' is set + if ('type' not in params) or (params['type'] is None): + raise ValueError("Missing the required parameter `type` when calling `get_parameter_provider_definition`") + + + + + + collection_formats = {} + + path_params = {} + if 'group' in params: + path_params['group'] = params['group'] + if 'artifact' in params: + path_params['artifact'] = params['artifact'] + if 'version' in params: + path_params['version'] = params['version'] + if 'type' in params: + path_params['type'] = params['type'] + + query_params = [] + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.\ + select_header_accept(['application/json']) + + # Authentication setting + auth_settings = ['bearerAuth'] + + return self.api_client.call_api('/flow/parameter-provider-definition/{group}/{artifact}/{version}/{type}', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='ParameterProviderDefinition', + 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'), @@ -2958,24 +3776,25 @@ def get_parameter_contexts_with_http_info(self, **kwargs): def get_parameter_provider_types(self, **kwargs): """ - Retrieves the types of parameter providers that this NiFi supports + Retrieves the types of parameter providers that this NiFi supports. + Note: This endpoint is subject to change as NiFi and it's REST API evolve. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_parameter_provider_types(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str bundle_group_filter: If specified, will only return types that are a member of this bundle group. - :param str bundle_artifact_filter: If specified, will only return types that are a member of this bundle artifact. - :param str type: If specified, will only return types whose fully qualified classname matches. - :return: ParameterProviderTypesEntity - If the method is called asynchronously, - returns the request thread. + + 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_parameter_provider_types_with_http_info()`` method instead. + + Args: + bundle_group_filter (str): + If specified, will only return types that are a member of this bundle group. + bundle_artifact_filter (str): + If specified, will only return types that are a member of this bundle artifact. + type (str): + If specified, will only return types whose fully qualified classname matches. + + Returns: + :class:`~nipyapi.nifi.models.ParameterProviderTypesEntity`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): @@ -2986,28 +3805,28 @@ def get_parameter_provider_types(self, **kwargs): def get_parameter_provider_types_with_http_info(self, **kwargs): """ - Retrieves the types of parameter providers that this NiFi supports + Retrieves the types of parameter providers that this NiFi supports. + Note: This endpoint is subject to change as NiFi and it's REST API evolve. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_parameter_provider_types_with_http_info(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str bundle_group_filter: If specified, will only return types that are a member of this bundle group. - :param str bundle_artifact_filter: If specified, will only return types that are a member of this bundle artifact. - :param str type: If specified, will only return types whose fully qualified classname matches. - :return: ParameterProviderTypesEntity - If the method is called asynchronously, - returns the request thread. + + 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_parameter_provider_types()`` method instead. + + Args: + bundle_group_filter (str): + If specified, will only return types that are a member of this bundle group. + bundle_artifact_filter (str): + If specified, will only return types that are a member of this bundle artifact. + type (str): + If specified, will only return types whose fully qualified classname matches. + + Returns: + tuple: (:class:`~nipyapi.nifi.models.ParameterProviderTypesEntity`, status_code, headers) - Response data with HTTP details. """ all_params = ['bundle_group_filter', 'bundle_artifact_filter', 'type'] - all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -3022,7 +3841,9 @@ def get_parameter_provider_types_with_http_info(self, **kwargs): params[key] = val del params['kwargs'] - + + + collection_formats = {} path_params = {} @@ -3045,12 +3866,8 @@ def get_parameter_provider_types_with_http_info(self, **kwargs): header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['*/*']) - # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/flow/parameter-provider-types', 'GET', path_params, @@ -3061,7 +3878,6 @@ def get_parameter_provider_types_with_http_info(self, **kwargs): files=local_var_files, response_type='ParameterProviderTypesEntity', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), @@ -3069,21 +3885,16 @@ def get_parameter_provider_types_with_http_info(self, **kwargs): def get_parameter_providers(self, **kwargs): """ - Gets all parameter providers + Gets all parameter providers. + This method makes a synchronous HTTP request and returns the response data directly. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_parameter_providers(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :return: ParameterProvidersEntity - If the method is called asynchronously, - returns the request thread. + For full HTTP response details (status code, headers, etc.), use the corresponding + ``get_parameter_providers_with_http_info()`` method instead. + + Args: + + Returns: + :class:`~nipyapi.nifi.models.ParameterProvidersEntity`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): @@ -3094,25 +3905,19 @@ def get_parameter_providers(self, **kwargs): def get_parameter_providers_with_http_info(self, **kwargs): """ - Gets all parameter providers + Gets all parameter providers. + This method makes a synchronous HTTP request and returns detailed response information. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_parameter_providers_with_http_info(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :return: ParameterProvidersEntity - If the method is called asynchronously, - returns the request thread. + Returns the response data along with HTTP status code, headers, and other metadata. + For just the response data, use the corresponding ``get_parameter_providers()`` method instead. + + Args: + + Returns: + tuple: (:class:`~nipyapi.nifi.models.ParameterProvidersEntity`, status_code, headers) - Response data with HTTP details. """ all_params = [] - all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -3143,12 +3948,8 @@ def get_parameter_providers_with_http_info(self, **kwargs): header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['*/*']) - # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/flow/parameter-providers', 'GET', path_params, @@ -3159,7 +3960,6 @@ def get_parameter_providers_with_http_info(self, **kwargs): files=local_var_files, response_type='ParameterProvidersEntity', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), @@ -3167,21 +3967,19 @@ def get_parameter_providers_with_http_info(self, **kwargs): def get_prioritizers(self, **kwargs): """ - Retrieves the types of prioritizers that this NiFi supports + Retrieves the types of prioritizers that this NiFi supports. + Note: This endpoint is subject to change as NiFi and it's REST API evolve. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_prioritizers(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :return: PrioritizerTypesEntity - If the method is called asynchronously, - returns the request thread. + + 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_prioritizers_with_http_info()`` method instead. + + Args: + + Returns: + :class:`~nipyapi.nifi.models.PrioritizerTypesEntity`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): @@ -3192,25 +3990,22 @@ def get_prioritizers(self, **kwargs): def get_prioritizers_with_http_info(self, **kwargs): """ - Retrieves the types of prioritizers that this NiFi supports + Retrieves the types of prioritizers that this NiFi supports. + Note: This endpoint is subject to change as NiFi and it's REST API evolve. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_prioritizers_with_http_info(callback=callback_function) - :param callback function: The callback function - for asynchronous request. (optional) - :return: PrioritizerTypesEntity - If the method is called asynchronously, - returns the request thread. + 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_prioritizers()`` method instead. + + Args: + + Returns: + tuple: (:class:`~nipyapi.nifi.models.PrioritizerTypesEntity`, status_code, headers) - Response data with HTTP details. """ all_params = [] - all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -3241,12 +4036,8 @@ def get_prioritizers_with_http_info(self, **kwargs): header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['*/*']) - # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/flow/prioritizers', 'GET', path_params, @@ -3257,7 +4048,6 @@ def get_prioritizers_with_http_info(self, **kwargs): files=local_var_files, response_type='PrioritizerTypesEntity', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), @@ -3265,25 +4055,27 @@ def get_prioritizers_with_http_info(self, **kwargs): def get_process_group_status(self, id, **kwargs): """ - Gets the status for a process group + Gets the status for a process group. + The status for a process group includes status for all descendent components. When invoked on the root group with recursive set to true, it will return the current status of every component in the flow. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_process_group_status(id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The process group id. (required) - :param bool recursive: Whether all descendant groups and the status of their content will be included. Optional, defaults to false - :param bool nodewise: Whether or not to include the breakdown per node. Optional, defaults to false - :param str cluster_node_id: The id of the node where to get the status. - :return: ProcessGroupStatusEntity - If the method is called asynchronously, - returns the request thread. + + 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_process_group_status_with_http_info()`` method instead. + + Args: + id (str): + The process group id. (required) + recursive (bool): + Whether all descendant groups and the status of their content will be included. Optional, defaults to false + nodewise (bool): + Whether or not to include the breakdown per node. Optional, defaults to false + cluster_node_id (str): + The id of the node where to get the status. + + Returns: + :class:`~nipyapi.nifi.models.ProcessGroupStatusEntity`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): @@ -3294,29 +4086,30 @@ def get_process_group_status(self, id, **kwargs): def get_process_group_status_with_http_info(self, id, **kwargs): """ - Gets the status for a process group + Gets the status for a process group. + The status for a process group includes status for all descendent components. When invoked on the root group with recursive set to true, it will return the current status of every component in the flow. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_process_group_status_with_http_info(id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The process group id. (required) - :param bool recursive: Whether all descendant groups and the status of their content will be included. Optional, defaults to false - :param bool nodewise: Whether or not to include the breakdown per node. Optional, defaults to false - :param str cluster_node_id: The id of the node where to get the status. - :return: ProcessGroupStatusEntity - If the method is called asynchronously, - returns the request thread. + + 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_process_group_status()`` method instead. + + Args: + id (str): + The process group id. (required) + recursive (bool): + Whether all descendant groups and the status of their content will be included. Optional, defaults to false + nodewise (bool): + Whether or not to include the breakdown per node. Optional, defaults to false + cluster_node_id (str): + The id of the node where to get the status. + + Returns: + tuple: (:class:`~nipyapi.nifi.models.ProcessGroupStatusEntity`, status_code, headers) - Response data with HTTP details. """ all_params = ['id', 'recursive', 'nodewise', 'cluster_node_id'] - all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -3334,7 +4127,10 @@ def get_process_group_status_with_http_info(self, id, **kwargs): if ('id' not in params) or (params['id'] is None): raise ValueError("Missing the required parameter `id` when calling `get_process_group_status`") - + + + + collection_formats = {} path_params = {} @@ -3359,12 +4155,8 @@ def get_process_group_status_with_http_info(self, id, **kwargs): header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['*/*']) - # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/flow/process-groups/{id}/status', 'GET', path_params, @@ -3375,7 +4167,6 @@ def get_process_group_status_with_http_info(self, id, **kwargs): files=local_var_files, response_type='ProcessGroupStatusEntity', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), @@ -3383,22 +4174,18 @@ def get_process_group_status_with_http_info(self, id, **kwargs): def get_process_group_status_history(self, id, **kwargs): """ - Gets status history for a remote process group + Gets status history for a remote process group. + This method makes a synchronous HTTP request and returns the response data directly. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_process_group_status_history(id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The process group id. (required) - :return: StatusHistoryEntity - If the method is called asynchronously, - returns the request thread. + For full HTTP response details (status code, headers, etc.), use the corresponding + ``get_process_group_status_history_with_http_info()`` method instead. + + Args: + id (str): + The process group id. (required) + + Returns: + :class:`~nipyapi.nifi.models.StatusHistoryEntity`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): @@ -3409,26 +4196,21 @@ def get_process_group_status_history(self, id, **kwargs): def get_process_group_status_history_with_http_info(self, id, **kwargs): """ - Gets status history for a remote process group + Gets status history for a remote process group. + This method makes a synchronous HTTP request and returns detailed response information. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_process_group_status_history_with_http_info(id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The process group id. (required) - :return: StatusHistoryEntity - If the method is called asynchronously, - returns the request thread. + Returns the response data along with HTTP status code, headers, and other metadata. + For just the response data, use the corresponding ``get_process_group_status_history()`` method instead. + + Args: + id (str): + The process group id. (required) + + Returns: + tuple: (:class:`~nipyapi.nifi.models.StatusHistoryEntity`, status_code, headers) - Response data with HTTP details. """ all_params = ['id'] - all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -3446,7 +4228,7 @@ def get_process_group_status_history_with_http_info(self, id, **kwargs): if ('id' not in params) or (params['id'] is None): raise ValueError("Missing the required parameter `id` when calling `get_process_group_status_history`") - + collection_formats = {} path_params = {} @@ -3465,12 +4247,8 @@ def get_process_group_status_history_with_http_info(self, id, **kwargs): header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['*/*']) - # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/flow/process-groups/{id}/status/history', 'GET', path_params, @@ -3481,7 +4259,134 @@ def get_process_group_status_history_with_http_info(self, id, **kwargs): files=local_var_files, response_type='StatusHistoryEntity', auth_settings=auth_settings, - callback=params.get('callback'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def get_processor_definition(self, group, artifact, version, type, **kwargs): + """ + Retrieves the Processor Definition for the specified component type.. + + 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_processor_definition_with_http_info()`` method instead. + + Args: + group (str): + The bundle group (required) + artifact (str): + The bundle artifact (required) + version (str): + The bundle version (required) + type (str): + The processor type (required) + + Returns: + :class:`~nipyapi.nifi.models.ProcessorDefinition`: The response data. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('callback'): + return self.get_processor_definition_with_http_info(group, artifact, version, type, **kwargs) + else: + (data) = self.get_processor_definition_with_http_info(group, artifact, version, type, **kwargs) + return data + + def get_processor_definition_with_http_info(self, group, artifact, version, type, **kwargs): + """ + Retrieves the Processor Definition for the specified component type.. + + 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_processor_definition()`` method instead. + + Args: + group (str): + The bundle group (required) + artifact (str): + The bundle artifact (required) + version (str): + The bundle version (required) + type (str): + The processor type (required) + + Returns: + tuple: (:class:`~nipyapi.nifi.models.ProcessorDefinition`, status_code, headers) - Response data with HTTP details. + """ + + all_params = ['group', 'artifact', 'version', 'type'] + 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_processor_definition" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'group' is set + if ('group' not in params) or (params['group'] is None): + raise ValueError("Missing the required parameter `group` when calling `get_processor_definition`") + # verify the required parameter 'artifact' is set + if ('artifact' not in params) or (params['artifact'] is None): + raise ValueError("Missing the required parameter `artifact` when calling `get_processor_definition`") + # verify the required parameter 'version' is set + if ('version' not in params) or (params['version'] is None): + raise ValueError("Missing the required parameter `version` when calling `get_processor_definition`") + # verify the required parameter 'type' is set + if ('type' not in params) or (params['type'] is None): + raise ValueError("Missing the required parameter `type` when calling `get_processor_definition`") + + + + + + collection_formats = {} + + path_params = {} + if 'group' in params: + path_params['group'] = params['group'] + if 'artifact' in params: + path_params['artifact'] = params['artifact'] + if 'version' in params: + path_params['version'] = params['version'] + if 'type' in params: + path_params['type'] = params['type'] + + query_params = [] + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.\ + select_header_accept(['application/json']) + + # Authentication setting + auth_settings = ['bearerAuth'] + + return self.api_client.call_api('/flow/processor-definition/{group}/{artifact}/{version}/{type}', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='ProcessorDefinition', + 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'), @@ -3489,24 +4394,22 @@ def get_process_group_status_history_with_http_info(self, id, **kwargs): def get_processor_status(self, id, **kwargs): """ - Gets status for a processor - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_processor_status(id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The processor id. (required) - :param bool nodewise: Whether or not to include the breakdown per node. Optional, defaults to false - :param str cluster_node_id: The id of the node where to get the status. - :return: ProcessorStatusEntity - If the method is called asynchronously, - returns the request thread. + Gets status for a processor. + 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_processor_status_with_http_info()`` method instead. + + Args: + id (str): + The processor id. (required) + nodewise (bool): + Whether or not to include the breakdown per node. Optional, defaults to false + cluster_node_id (str): + The id of the node where to get the status. + + Returns: + :class:`~nipyapi.nifi.models.ProcessorStatusEntity`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): @@ -3517,28 +4420,25 @@ def get_processor_status(self, id, **kwargs): def get_processor_status_with_http_info(self, id, **kwargs): """ - Gets status for a processor + Gets status for a processor. + This method makes a synchronous HTTP request and returns detailed response information. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_processor_status_with_http_info(id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The processor id. (required) - :param bool nodewise: Whether or not to include the breakdown per node. Optional, defaults to false - :param str cluster_node_id: The id of the node where to get the status. - :return: ProcessorStatusEntity - If the method is called asynchronously, - returns the request thread. + Returns the response data along with HTTP status code, headers, and other metadata. + For just the response data, use the corresponding ``get_processor_status()`` method instead. + + Args: + id (str): + The processor id. (required) + nodewise (bool): + Whether or not to include the breakdown per node. Optional, defaults to false + cluster_node_id (str): + The id of the node where to get the status. + + Returns: + tuple: (:class:`~nipyapi.nifi.models.ProcessorStatusEntity`, status_code, headers) - Response data with HTTP details. """ all_params = ['id', 'nodewise', 'cluster_node_id'] - all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -3556,7 +4456,9 @@ def get_processor_status_with_http_info(self, id, **kwargs): if ('id' not in params) or (params['id'] is None): raise ValueError("Missing the required parameter `id` when calling `get_processor_status`") - + + + collection_formats = {} path_params = {} @@ -3579,12 +4481,8 @@ def get_processor_status_with_http_info(self, id, **kwargs): header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['*/*']) - # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/flow/processors/{id}/status', 'GET', path_params, @@ -3595,7 +4493,6 @@ def get_processor_status_with_http_info(self, id, **kwargs): files=local_var_files, response_type='ProcessorStatusEntity', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), @@ -3603,22 +4500,18 @@ def get_processor_status_with_http_info(self, id, **kwargs): def get_processor_status_history(self, id, **kwargs): """ - Gets status history for a processor + Gets status history for a processor. + 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_processor_status_history_with_http_info()`` method instead. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_processor_status_history(id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The processor id. (required) - :return: StatusHistoryEntity - If the method is called asynchronously, - returns the request thread. + Args: + id (str): + The processor id. (required) + + Returns: + :class:`~nipyapi.nifi.models.StatusHistoryEntity`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): @@ -3629,26 +4522,21 @@ def get_processor_status_history(self, id, **kwargs): def get_processor_status_history_with_http_info(self, id, **kwargs): """ - Gets status history for a processor + Gets status history for a processor. + This method makes a synchronous HTTP request and returns detailed response information. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_processor_status_history_with_http_info(id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The processor id. (required) - :return: StatusHistoryEntity - If the method is called asynchronously, - returns the request thread. + Returns the response data along with HTTP status code, headers, and other metadata. + For just the response data, use the corresponding ``get_processor_status_history()`` method instead. + + Args: + id (str): + The processor id. (required) + + Returns: + tuple: (:class:`~nipyapi.nifi.models.StatusHistoryEntity`, status_code, headers) - Response data with HTTP details. """ all_params = ['id'] - all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -3666,7 +4554,7 @@ def get_processor_status_history_with_http_info(self, id, **kwargs): if ('id' not in params) or (params['id'] is None): raise ValueError("Missing the required parameter `id` when calling `get_processor_status_history`") - + collection_formats = {} path_params = {} @@ -3685,12 +4573,8 @@ def get_processor_status_history_with_http_info(self, id, **kwargs): header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['*/*']) - # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/flow/processors/{id}/status/history', 'GET', path_params, @@ -3701,7 +4585,6 @@ def get_processor_status_history_with_http_info(self, id, **kwargs): files=local_var_files, response_type='StatusHistoryEntity', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), @@ -3709,24 +4592,25 @@ def get_processor_status_history_with_http_info(self, id, **kwargs): def get_processor_types(self, **kwargs): """ - Retrieves the types of processors that this NiFi supports + Retrieves the types of processors that this NiFi supports. + Note: This endpoint is subject to change as NiFi and it's REST API evolve. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_processor_types(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str bundle_group_filter: If specified, will only return types that are a member of this bundle group. - :param str bundle_artifact_filter: If specified, will only return types that are a member of this bundle artifact. - :param str type: If specified, will only return types whose fully qualified classname matches. - :return: ProcessorTypesEntity - If the method is called asynchronously, - returns the request thread. + + 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_processor_types_with_http_info()`` method instead. + + Args: + bundle_group_filter (str): + If specified, will only return types that are a member of this bundle group. + bundle_artifact_filter (str): + If specified, will only return types that are a member of this bundle artifact. + type (str): + If specified, will only return types whose fully qualified classname matches. + + Returns: + :class:`~nipyapi.nifi.models.ProcessorTypesEntity`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): @@ -3737,28 +4621,28 @@ def get_processor_types(self, **kwargs): def get_processor_types_with_http_info(self, **kwargs): """ - Retrieves the types of processors that this NiFi supports + Retrieves the types of processors that this NiFi supports. + Note: This endpoint is subject to change as NiFi and it's REST API evolve. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_processor_types_with_http_info(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str bundle_group_filter: If specified, will only return types that are a member of this bundle group. - :param str bundle_artifact_filter: If specified, will only return types that are a member of this bundle artifact. - :param str type: If specified, will only return types whose fully qualified classname matches. - :return: ProcessorTypesEntity - If the method is called asynchronously, - returns the request thread. + + 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_processor_types()`` method instead. + + Args: + bundle_group_filter (str): + If specified, will only return types that are a member of this bundle group. + bundle_artifact_filter (str): + If specified, will only return types that are a member of this bundle artifact. + type (str): + If specified, will only return types whose fully qualified classname matches. + + Returns: + tuple: (:class:`~nipyapi.nifi.models.ProcessorTypesEntity`, status_code, headers) - Response data with HTTP details. """ all_params = ['bundle_group_filter', 'bundle_artifact_filter', 'type'] - all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -3773,7 +4657,9 @@ def get_processor_types_with_http_info(self, **kwargs): params[key] = val del params['kwargs'] - + + + collection_formats = {} path_params = {} @@ -3796,12 +4682,8 @@ def get_processor_types_with_http_info(self, **kwargs): header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['*/*']) - # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/flow/processor-types', 'GET', path_params, @@ -3812,7 +4694,6 @@ def get_processor_types_with_http_info(self, **kwargs): files=local_var_files, response_type='ProcessorTypesEntity', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), @@ -3820,21 +4701,16 @@ def get_processor_types_with_http_info(self, **kwargs): def get_registry_clients(self, **kwargs): """ - Gets the listing of available flow registry clients + Gets the listing of available flow registry clients. + This method makes a synchronous HTTP request and returns the response data directly. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_registry_clients(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :return: FlowRegistryClientsEntity - If the method is called asynchronously, - returns the request thread. + For full HTTP response details (status code, headers, etc.), use the corresponding + ``get_registry_clients_with_http_info()`` method instead. + + Args: + + Returns: + :class:`~nipyapi.nifi.models.FlowRegistryClientsEntity`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): @@ -3845,25 +4721,19 @@ def get_registry_clients(self, **kwargs): def get_registry_clients_with_http_info(self, **kwargs): """ - Gets the listing of available flow registry clients + Gets the listing of available flow registry clients. + This method makes a synchronous HTTP request and returns detailed response information. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_registry_clients_with_http_info(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :return: FlowRegistryClientsEntity - If the method is called asynchronously, - returns the request thread. + Returns the response data along with HTTP status code, headers, and other metadata. + For just the response data, use the corresponding ``get_registry_clients()`` method instead. + + Args: + + Returns: + tuple: (:class:`~nipyapi.nifi.models.FlowRegistryClientsEntity`, status_code, headers) - Response data with HTTP details. """ all_params = [] - all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -3894,12 +4764,8 @@ def get_registry_clients_with_http_info(self, **kwargs): header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['*/*']) - # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/flow/registries', 'GET', path_params, @@ -3910,7 +4776,6 @@ def get_registry_clients_with_http_info(self, **kwargs): files=local_var_files, response_type='FlowRegistryClientsEntity', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), @@ -3918,24 +4783,22 @@ def get_registry_clients_with_http_info(self, **kwargs): def get_remote_process_group_status(self, id, **kwargs): """ - Gets status for a remote process group - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_remote_process_group_status(id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The remote process group id. (required) - :param bool nodewise: Whether or not to include the breakdown per node. Optional, defaults to false - :param str cluster_node_id: The id of the node where to get the status. - :return: RemoteProcessGroupStatusEntity - If the method is called asynchronously, - returns the request thread. + Gets status for a remote process group. + 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_remote_process_group_status_with_http_info()`` method instead. + + Args: + id (str): + The remote process group id. (required) + nodewise (bool): + Whether or not to include the breakdown per node. Optional, defaults to false + cluster_node_id (str): + The id of the node where to get the status. + + Returns: + :class:`~nipyapi.nifi.models.RemoteProcessGroupStatusEntity`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): @@ -3946,28 +4809,25 @@ def get_remote_process_group_status(self, id, **kwargs): def get_remote_process_group_status_with_http_info(self, id, **kwargs): """ - Gets status for a remote process group + Gets status for a remote process group. + This method makes a synchronous HTTP request and returns detailed response information. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_remote_process_group_status_with_http_info(id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The remote process group id. (required) - :param bool nodewise: Whether or not to include the breakdown per node. Optional, defaults to false - :param str cluster_node_id: The id of the node where to get the status. - :return: RemoteProcessGroupStatusEntity - If the method is called asynchronously, - returns the request thread. + Returns the response data along with HTTP status code, headers, and other metadata. + For just the response data, use the corresponding ``get_remote_process_group_status()`` method instead. + + Args: + id (str): + The remote process group id. (required) + nodewise (bool): + Whether or not to include the breakdown per node. Optional, defaults to false + cluster_node_id (str): + The id of the node where to get the status. + + Returns: + tuple: (:class:`~nipyapi.nifi.models.RemoteProcessGroupStatusEntity`, status_code, headers) - Response data with HTTP details. """ all_params = ['id', 'nodewise', 'cluster_node_id'] - all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -3985,7 +4845,9 @@ def get_remote_process_group_status_with_http_info(self, id, **kwargs): if ('id' not in params) or (params['id'] is None): raise ValueError("Missing the required parameter `id` when calling `get_remote_process_group_status`") - + + + collection_formats = {} path_params = {} @@ -4008,12 +4870,8 @@ def get_remote_process_group_status_with_http_info(self, id, **kwargs): header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['*/*']) - # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/flow/remote-process-groups/{id}/status', 'GET', path_params, @@ -4024,7 +4882,6 @@ def get_remote_process_group_status_with_http_info(self, id, **kwargs): files=local_var_files, response_type='RemoteProcessGroupStatusEntity', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), @@ -4032,22 +4889,18 @@ def get_remote_process_group_status_with_http_info(self, id, **kwargs): def get_remote_process_group_status_history(self, id, **kwargs): """ - Gets the status history + Gets the status history. + This method makes a synchronous HTTP request and returns the response data directly. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_remote_process_group_status_history(id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The remote process group id. (required) - :return: StatusHistoryEntity - If the method is called asynchronously, - returns the request thread. + For full HTTP response details (status code, headers, etc.), use the corresponding + ``get_remote_process_group_status_history_with_http_info()`` method instead. + + Args: + 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'): @@ -4058,26 +4911,21 @@ def get_remote_process_group_status_history(self, id, **kwargs): def get_remote_process_group_status_history_with_http_info(self, id, **kwargs): """ - Gets the status history + Gets the status history. + This method makes a synchronous HTTP request and returns detailed response information. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_remote_process_group_status_history_with_http_info(id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The remote process group id. (required) - :return: StatusHistoryEntity - If the method is called asynchronously, - returns the request thread. + Returns the response data along with HTTP status code, headers, and other metadata. + For just the response data, use the corresponding ``get_remote_process_group_status_history()`` method instead. + + Args: + 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'] - all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -4095,7 +4943,7 @@ def get_remote_process_group_status_history_with_http_info(self, id, **kwargs): if ('id' not in params) or (params['id'] is None): raise ValueError("Missing the required parameter `id` when calling `get_remote_process_group_status_history`") - + collection_formats = {} path_params = {} @@ -4114,12 +4962,8 @@ def get_remote_process_group_status_history_with_http_info(self, id, **kwargs): header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['*/*']) - # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/flow/remote-process-groups/{id}/status/history', 'GET', path_params, @@ -4130,60 +4974,68 @@ def get_remote_process_group_status_history_with_http_info(self, id, **kwargs): files=local_var_files, response_type='StatusHistoryEntity', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def get_reporting_task_snapshot(self, **kwargs): + def get_reporting_task_definition(self, group, artifact, version, type, **kwargs): """ - Get a snapshot of the given reporting tasks and any controller services they use - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_reporting_task_snapshot(callback=callback_function) + Retrieves the Reporting Task Definition for the specified component type.. - :param callback function: The callback function - for asynchronous request. (optional) - :param str reporting_task_id: Specifies a reporting task id to export. If not specified, all reporting tasks will be exported. - :return: VersionedReportingTaskSnapshot - If the method is called asynchronously, - returns the request thread. + 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_reporting_task_definition_with_http_info()`` method instead. + + Args: + group (str): + The bundle group (required) + artifact (str): + The bundle artifact (required) + version (str): + The bundle version (required) + type (str): + The reporting task type (required) + + Returns: + :class:`~nipyapi.nifi.models.ReportingTaskDefinition`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.get_reporting_task_snapshot_with_http_info(**kwargs) + return self.get_reporting_task_definition_with_http_info(group, artifact, version, type, **kwargs) else: - (data) = self.get_reporting_task_snapshot_with_http_info(**kwargs) + (data) = self.get_reporting_task_definition_with_http_info(group, artifact, version, type, **kwargs) return data - def get_reporting_task_snapshot_with_http_info(self, **kwargs): + def get_reporting_task_definition_with_http_info(self, group, artifact, version, type, **kwargs): """ - Get a snapshot of the given reporting tasks and any controller services they use - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_reporting_task_snapshot_with_http_info(callback=callback_function) + Retrieves the Reporting Task Definition for the specified component type.. - :param callback function: The callback function - for asynchronous request. (optional) - :param str reporting_task_id: Specifies a reporting task id to export. If not specified, all reporting tasks will be exported. - :return: VersionedReportingTaskSnapshot - If the method is called asynchronously, - returns the request thread. - """ + Note: This endpoint is subject to change as NiFi and it's REST API evolve. - all_params = ['reporting_task_id'] - all_params.append('callback') + 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_reporting_task_definition()`` method instead. + + Args: + group (str): + The bundle group (required) + artifact (str): + The bundle artifact (required) + version (str): + The bundle version (required) + type (str): + The reporting task type (required) + + Returns: + tuple: (:class:`~nipyapi.nifi.models.ReportingTaskDefinition`, status_code, headers) - Response data with HTTP details. + """ + + all_params = ['group', 'artifact', 'version', 'type'] all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -4193,19 +5045,40 @@ def get_reporting_task_snapshot_with_http_info(self, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method get_reporting_task_snapshot" % key + " to method get_reporting_task_definition" % key ) params[key] = val del params['kwargs'] - - + # verify the required parameter 'group' is set + if ('group' not in params) or (params['group'] is None): + raise ValueError("Missing the required parameter `group` when calling `get_reporting_task_definition`") + # verify the required parameter 'artifact' is set + if ('artifact' not in params) or (params['artifact'] is None): + raise ValueError("Missing the required parameter `artifact` when calling `get_reporting_task_definition`") + # verify the required parameter 'version' is set + if ('version' not in params) or (params['version'] is None): + raise ValueError("Missing the required parameter `version` when calling `get_reporting_task_definition`") + # verify the required parameter 'type' is set + if ('type' not in params) or (params['type'] is None): + raise ValueError("Missing the required parameter `type` when calling `get_reporting_task_definition`") + + + + + collection_formats = {} path_params = {} + if 'group' in params: + path_params['group'] = params['group'] + if 'artifact' in params: + path_params['artifact'] = params['artifact'] + if 'version' in params: + path_params['version'] = params['version'] + if 'type' in params: + path_params['type'] = params['type'] query_params = [] - if 'reporting_task_id' in params: - query_params.append(('reportingTaskId', params['reporting_task_id'])) header_params = {} @@ -4217,80 +5090,62 @@ def get_reporting_task_snapshot_with_http_info(self, **kwargs): header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['*/*']) - # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] - return self.api_client.call_api('/flow/reporting-tasks/snapshot', 'GET', + return self.api_client.call_api('/flow/reporting-task-definition/{group}/{artifact}/{version}/{type}', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, - response_type='VersionedReportingTaskSnapshot', + response_type='ReportingTaskDefinition', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def get_reporting_task_types(self, **kwargs): + def get_reporting_task_snapshot(self, **kwargs): """ - Retrieves the types of reporting tasks that this NiFi supports - Note: This endpoint is subject to change as NiFi and it's REST API evolve. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_reporting_task_types(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str bundle_group_filter: If specified, will only return types that are a member of this bundle group. - :param str bundle_artifact_filter: If specified, will only return types that are a member of this bundle artifact. - :param str type: If specified, will only return types whose fully qualified classname matches. - :return: ReportingTaskTypesEntity - If the method is called asynchronously, - returns the request thread. + Get a snapshot of the given reporting tasks and any controller services they use. + 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_reporting_task_snapshot_with_http_info()`` method instead. + + Args: + reporting_task_id (str): + Specifies a reporting task id to export. If not specified, all reporting tasks will be exported. + + Returns: + :class:`~nipyapi.nifi.models.VersionedReportingTaskSnapshot`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.get_reporting_task_types_with_http_info(**kwargs) + return self.get_reporting_task_snapshot_with_http_info(**kwargs) else: - (data) = self.get_reporting_task_types_with_http_info(**kwargs) + (data) = self.get_reporting_task_snapshot_with_http_info(**kwargs) return data - def get_reporting_task_types_with_http_info(self, **kwargs): + def get_reporting_task_snapshot_with_http_info(self, **kwargs): """ - Retrieves the types of reporting tasks that this NiFi supports - Note: This endpoint is subject to change as NiFi and it's REST API evolve. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_reporting_task_types_with_http_info(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str bundle_group_filter: If specified, will only return types that are a member of this bundle group. - :param str bundle_artifact_filter: If specified, will only return types that are a member of this bundle artifact. - :param str type: If specified, will only return types whose fully qualified classname matches. - :return: ReportingTaskTypesEntity - If the method is called asynchronously, - returns the request thread. + Get a snapshot of the given reporting tasks and any controller services they use. + 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_reporting_task_snapshot()`` method instead. + + Args: + reporting_task_id (str): + Specifies a reporting task id to export. If not specified, all reporting tasks will be exported. + + Returns: + tuple: (:class:`~nipyapi.nifi.models.VersionedReportingTaskSnapshot`, status_code, headers) - Response data with HTTP details. """ - all_params = ['bundle_group_filter', 'bundle_artifact_filter', 'type'] - all_params.append('callback') + all_params = ['reporting_task_id'] all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -4300,23 +5155,19 @@ def get_reporting_task_types_with_http_info(self, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method get_reporting_task_types" % key + " to method get_reporting_task_snapshot" % key ) params[key] = val del params['kwargs'] - + collection_formats = {} path_params = {} query_params = [] - if 'bundle_group_filter' in params: - query_params.append(('bundleGroupFilter', params['bundle_group_filter'])) - if 'bundle_artifact_filter' in params: - query_params.append(('bundleArtifactFilter', params['bundle_artifact_filter'])) - if 'type' in params: - query_params.append(('type', params['type'])) + if 'reporting_task_id' in params: + query_params.append(('reportingTaskId', params['reporting_task_id'])) header_params = {} @@ -4328,74 +5179,76 @@ def get_reporting_task_types_with_http_info(self, **kwargs): header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['*/*']) - # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] - return self.api_client.call_api('/flow/reporting-task-types', 'GET', + return self.api_client.call_api('/flow/reporting-tasks/snapshot', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, - response_type='ReportingTaskTypesEntity', + response_type='VersionedReportingTaskSnapshot', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def get_reporting_tasks(self, **kwargs): + def get_reporting_task_types(self, **kwargs): """ - Gets all reporting tasks - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_reporting_tasks(callback=callback_function) + Retrieves the types of reporting tasks that this NiFi supports. + + Note: This endpoint is subject to change as NiFi and it's REST API evolve. - :param callback function: The callback function - for asynchronous request. (optional) - :return: ReportingTasksEntity - If the method is called asynchronously, - returns the request thread. + 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_reporting_task_types_with_http_info()`` method instead. + + Args: + bundle_group_filter (str): + If specified, will only return types that are a member of this bundle group. + bundle_artifact_filter (str): + If specified, will only return types that are a member of this bundle artifact. + type (str): + If specified, will only return types whose fully qualified classname matches. + + Returns: + :class:`~nipyapi.nifi.models.ReportingTaskTypesEntity`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.get_reporting_tasks_with_http_info(**kwargs) + return self.get_reporting_task_types_with_http_info(**kwargs) else: - (data) = self.get_reporting_tasks_with_http_info(**kwargs) + (data) = self.get_reporting_task_types_with_http_info(**kwargs) return data - def get_reporting_tasks_with_http_info(self, **kwargs): + def get_reporting_task_types_with_http_info(self, **kwargs): """ - Gets all reporting tasks - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_reporting_tasks_with_http_info(callback=callback_function) + Retrieves the types of reporting tasks that this NiFi supports. - :param callback function: The callback function - for asynchronous request. (optional) - :return: ReportingTasksEntity - If the method is called asynchronously, - returns the request thread. + 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_reporting_task_types()`` method instead. + + Args: + bundle_group_filter (str): + If specified, will only return types that are a member of this bundle group. + bundle_artifact_filter (str): + If specified, will only return types that are a member of this bundle artifact. + type (str): + If specified, will only return types whose fully qualified classname matches. + + Returns: + tuple: (:class:`~nipyapi.nifi.models.ReportingTaskTypesEntity`, status_code, headers) - Response data with HTTP details. """ - all_params = [] - all_params.append('callback') + all_params = ['bundle_group_filter', 'bundle_artifact_filter', 'type'] all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -4405,16 +5258,25 @@ def get_reporting_tasks_with_http_info(self, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method get_reporting_tasks" % key + " to method get_reporting_task_types" % key ) params[key] = val del params['kwargs'] + + + collection_formats = {} path_params = {} query_params = [] + if 'bundle_group_filter' in params: + query_params.append(('bundleGroupFilter', params['bundle_group_filter'])) + if 'bundle_artifact_filter' in params: + query_params.append(('bundleArtifactFilter', params['bundle_artifact_filter'])) + if 'type' in params: + query_params.append(('type', params['type'])) header_params = {} @@ -4426,74 +5288,58 @@ def get_reporting_tasks_with_http_info(self, **kwargs): header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['*/*']) - # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] - return self.api_client.call_api('/flow/reporting-tasks', 'GET', + return self.api_client.call_api('/flow/reporting-task-types', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, - response_type='ReportingTasksEntity', + response_type='ReportingTaskTypesEntity', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def get_runtime_manifest(self, **kwargs): + def get_reporting_tasks(self, **kwargs): """ - Retrieves the runtime manifest for this NiFi instance. - Note: This endpoint is subject to change as NiFi and it's REST API evolve. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_runtime_manifest(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :return: RuntimeManifestEntity - If the method is called asynchronously, - returns the request thread. + Gets all reporting 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 + ``get_reporting_tasks_with_http_info()`` method instead. + + Args: + + Returns: + :class:`~nipyapi.nifi.models.ReportingTasksEntity`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.get_runtime_manifest_with_http_info(**kwargs) + return self.get_reporting_tasks_with_http_info(**kwargs) else: - (data) = self.get_runtime_manifest_with_http_info(**kwargs) + (data) = self.get_reporting_tasks_with_http_info(**kwargs) return data - def get_runtime_manifest_with_http_info(self, **kwargs): + def get_reporting_tasks_with_http_info(self, **kwargs): """ - Retrieves the runtime manifest for this NiFi instance. - Note: This endpoint is subject to change as NiFi and it's REST API evolve. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_runtime_manifest_with_http_info(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :return: RuntimeManifestEntity - If the method is called asynchronously, - returns the request thread. + Gets all reporting 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 ``get_reporting_tasks()`` method instead. + + Args: + + Returns: + tuple: (:class:`~nipyapi.nifi.models.ReportingTasksEntity`, status_code, headers) - Response data with HTTP details. """ all_params = [] - all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -4503,7 +5349,7 @@ def get_runtime_manifest_with_http_info(self, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method get_runtime_manifest" % key + " to method get_reporting_tasks" % key ) params[key] = val del params['kwargs'] @@ -4524,74 +5370,64 @@ def get_runtime_manifest_with_http_info(self, **kwargs): header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['*/*']) - # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] - return self.api_client.call_api('/flow/runtime-manifest', 'GET', + return self.api_client.call_api('/flow/reporting-tasks', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, - response_type='RuntimeManifestEntity', + response_type='ReportingTasksEntity', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def get_templates(self, **kwargs): + def get_runtime_manifest(self, **kwargs): """ - Gets all templates - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_templates(callback=callback_function) + Retrieves the runtime manifest for this NiFi instance.. + + Note: This endpoint is subject to change as NiFi and it's REST API evolve. - :param callback function: The callback function - for asynchronous request. (optional) - :return: TemplatesEntity - If the method is called asynchronously, - returns the request thread. + 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_runtime_manifest_with_http_info()`` method instead. + + Args: + + Returns: + :class:`~nipyapi.nifi.models.RuntimeManifestEntity`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.get_templates_with_http_info(**kwargs) + return self.get_runtime_manifest_with_http_info(**kwargs) else: - (data) = self.get_templates_with_http_info(**kwargs) + (data) = self.get_runtime_manifest_with_http_info(**kwargs) return data - def get_templates_with_http_info(self, **kwargs): + def get_runtime_manifest_with_http_info(self, **kwargs): """ - Gets all templates - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_templates_with_http_info(callback=callback_function) + Retrieves the runtime manifest for this NiFi instance.. + + Note: This endpoint is subject to change as NiFi and it's REST API evolve. - :param callback function: The callback function - for asynchronous request. (optional) - :return: TemplatesEntity - If the method is called asynchronously, - returns the request thread. + 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_runtime_manifest()`` method instead. + + Args: + + Returns: + tuple: (:class:`~nipyapi.nifi.models.RuntimeManifestEntity`, status_code, headers) - Response data with HTTP details. """ all_params = [] - all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -4601,7 +5437,7 @@ def get_templates_with_http_info(self, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method get_templates" % key + " to method get_runtime_manifest" % key ) params[key] = val del params['kwargs'] @@ -4622,88 +5458,102 @@ def get_templates_with_http_info(self, **kwargs): header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['*/*']) - # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] - return self.api_client.call_api('/flow/templates', 'GET', + return self.api_client.call_api('/flow/runtime-manifest', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, - response_type='TemplatesEntity', + response_type='RuntimeManifestEntity', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def get_version_differences(self, registry_id, bucket_id, flow_id, version_a, version_b, **kwargs): - """ - Gets the differences between two versions of the same versioned flow, the basis of the comparison will be the first version - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_version_differences(registry_id, bucket_id, flow_id, version_a, version_b, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str registry_id: The registry client id. (required) - :param str bucket_id: The bucket id. (required) - :param str flow_id: The flow id. (required) - :param int version_a: The base version. (required) - :param int version_b: The compared version. (required) - :param int offset: Must be a non-negative number. Specifies the starting point of the listing. 0 means start from the beginning. - :param int limit: Limits the number of differences listed. This might lead to partial result. 0 means no limitation is applied. - :return: FlowComparisonEntity - If the method is called asynchronously, - returns the request thread. + def get_version_differences(self, registry_id, branch_id_a, bucket_id_a, flow_id_a, version_a, branch_id_b, bucket_id_b, flow_id_b, version_b, **kwargs): + """ + Gets the differences between two versions of the same versioned flow, the basis of the comparison will be the first version. + 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_version_differences_with_http_info()`` method instead. + + Args: + registry_id (str): + The registry client id. (required) + branch_id_a (str): + The branch id for the base version. (required) + bucket_id_a (str): + The bucket id for the base version. (required) + flow_id_a (str): + The flow id for the base version. (required) + version_a (str): + The base version. (required) + branch_id_b (str): + The branch id for the compared version. (required) + bucket_id_b (str): + The bucket id for the compared version. (required) + flow_id_b (str): + The flow id for the compared version. (required) + version_b (str): + The compared version. (required) + offset (int): + Must be a non-negative number. Specifies the starting point of the listing. 0 means start from the beginning. + limit (int): + Limits the number of differences listed. This might lead to partial result. 0 means no limitation is applied. + + Returns: + :class:`~nipyapi.nifi.models.FlowComparisonEntity`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.get_version_differences_with_http_info(registry_id, bucket_id, flow_id, version_a, version_b, **kwargs) + return self.get_version_differences_with_http_info(registry_id, branch_id_a, bucket_id_a, flow_id_a, version_a, branch_id_b, bucket_id_b, flow_id_b, version_b, **kwargs) else: - (data) = self.get_version_differences_with_http_info(registry_id, bucket_id, flow_id, version_a, version_b, **kwargs) + (data) = self.get_version_differences_with_http_info(registry_id, branch_id_a, bucket_id_a, flow_id_a, version_a, branch_id_b, bucket_id_b, flow_id_b, version_b, **kwargs) return data - def get_version_differences_with_http_info(self, registry_id, bucket_id, flow_id, version_a, version_b, **kwargs): - """ - Gets the differences between two versions of the same versioned flow, the basis of the comparison will be the first version - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_version_differences_with_http_info(registry_id, bucket_id, flow_id, version_a, version_b, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str registry_id: The registry client id. (required) - :param str bucket_id: The bucket id. (required) - :param str flow_id: The flow id. (required) - :param int version_a: The base version. (required) - :param int version_b: The compared version. (required) - :param int offset: Must be a non-negative number. Specifies the starting point of the listing. 0 means start from the beginning. - :param int limit: Limits the number of differences listed. This might lead to partial result. 0 means no limitation is applied. - :return: FlowComparisonEntity - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['registry_id', 'bucket_id', 'flow_id', 'version_a', 'version_b', 'offset', 'limit'] - all_params.append('callback') + def get_version_differences_with_http_info(self, registry_id, branch_id_a, bucket_id_a, flow_id_a, version_a, branch_id_b, bucket_id_b, flow_id_b, version_b, **kwargs): + """ + Gets the differences between two versions of the same versioned flow, the basis of the comparison will be the first version. + 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_version_differences()`` method instead. + + Args: + registry_id (str): + The registry client id. (required) + branch_id_a (str): + The branch id for the base version. (required) + bucket_id_a (str): + The bucket id for the base version. (required) + flow_id_a (str): + The flow id for the base version. (required) + version_a (str): + The base version. (required) + branch_id_b (str): + The branch id for the compared version. (required) + bucket_id_b (str): + The bucket id for the compared version. (required) + flow_id_b (str): + The flow id for the compared version. (required) + version_b (str): + The compared version. (required) + offset (int): + Must be a non-negative number. Specifies the starting point of the listing. 0 means start from the beginning. + limit (int): + Limits the number of differences listed. This might lead to partial result. 0 means no limitation is applied. + + Returns: + tuple: (:class:`~nipyapi.nifi.models.FlowComparisonEntity`, status_code, headers) - Response data with HTTP details. + """ + + all_params = ['registry_id', 'branch_id_a', 'bucket_id_a', 'flow_id_a', 'version_a', 'branch_id_b', 'bucket_id_b', 'flow_id_b', 'version_b', 'offset', 'limit'] all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -4720,31 +5570,61 @@ def get_version_differences_with_http_info(self, registry_id, bucket_id, flow_id # verify the required parameter 'registry_id' is set if ('registry_id' not in params) or (params['registry_id'] is None): raise ValueError("Missing the required parameter `registry_id` when calling `get_version_differences`") - # verify the required parameter 'bucket_id' is set - if ('bucket_id' not in params) or (params['bucket_id'] is None): - raise ValueError("Missing the required parameter `bucket_id` when calling `get_version_differences`") - # verify the required parameter 'flow_id' is set - if ('flow_id' not in params) or (params['flow_id'] is None): - raise ValueError("Missing the required parameter `flow_id` when calling `get_version_differences`") + # verify the required parameter 'branch_id_a' is set + if ('branch_id_a' not in params) or (params['branch_id_a'] is None): + raise ValueError("Missing the required parameter `branch_id_a` when calling `get_version_differences`") + # verify the required parameter 'bucket_id_a' is set + if ('bucket_id_a' not in params) or (params['bucket_id_a'] is None): + raise ValueError("Missing the required parameter `bucket_id_a` when calling `get_version_differences`") + # verify the required parameter 'flow_id_a' is set + if ('flow_id_a' not in params) or (params['flow_id_a'] is None): + raise ValueError("Missing the required parameter `flow_id_a` when calling `get_version_differences`") # verify the required parameter 'version_a' is set if ('version_a' not in params) or (params['version_a'] is None): raise ValueError("Missing the required parameter `version_a` when calling `get_version_differences`") + # verify the required parameter 'branch_id_b' is set + if ('branch_id_b' not in params) or (params['branch_id_b'] is None): + raise ValueError("Missing the required parameter `branch_id_b` when calling `get_version_differences`") + # verify the required parameter 'bucket_id_b' is set + if ('bucket_id_b' not in params) or (params['bucket_id_b'] is None): + raise ValueError("Missing the required parameter `bucket_id_b` when calling `get_version_differences`") + # verify the required parameter 'flow_id_b' is set + if ('flow_id_b' not in params) or (params['flow_id_b'] is None): + raise ValueError("Missing the required parameter `flow_id_b` when calling `get_version_differences`") # verify the required parameter 'version_b' is set if ('version_b' not in params) or (params['version_b'] is None): raise ValueError("Missing the required parameter `version_b` when calling `get_version_differences`") - + + + + + + + + + + + collection_formats = {} path_params = {} if 'registry_id' in params: path_params['registry-id'] = params['registry_id'] - if 'bucket_id' in params: - path_params['bucket-id'] = params['bucket_id'] - if 'flow_id' in params: - path_params['flow-id'] = params['flow_id'] + if 'branch_id_a' in params: + path_params['branch-id-a'] = params['branch_id_a'] + if 'bucket_id_a' in params: + path_params['bucket-id-a'] = params['bucket_id_a'] + if 'flow_id_a' in params: + path_params['flow-id-a'] = params['flow_id_a'] if 'version_a' in params: path_params['version-a'] = params['version_a'] + if 'branch_id_b' in params: + path_params['branch-id-b'] = params['branch_id_b'] + if 'bucket_id_b' in params: + path_params['bucket-id-b'] = params['bucket_id_b'] + if 'flow_id_b' in params: + path_params['flow-id-b'] = params['flow_id_b'] if 'version_b' in params: path_params['version-b'] = params['version_b'] @@ -4764,14 +5644,10 @@ def get_version_differences_with_http_info(self, registry_id, bucket_id, flow_id header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['*/*']) - # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] - return self.api_client.call_api('/flow/registries/{registry-id}/buckets/{bucket-id}/flows/{flow-id}/{version-a}/diff/{version-b}', 'GET', + return self.api_client.call_api('/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', path_params, query_params, header_params, @@ -4780,7 +5656,6 @@ def get_version_differences_with_http_info(self, registry_id, bucket_id, flow_id files=local_var_files, response_type='FlowComparisonEntity', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), @@ -4788,24 +5663,24 @@ def get_version_differences_with_http_info(self, registry_id, bucket_id, flow_id def get_versions(self, registry_id, bucket_id, flow_id, **kwargs): """ - Gets the flow versions from the specified registry and bucket for the specified flow for the current user - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_versions(registry_id, bucket_id, flow_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str registry_id: The registry client id. (required) - :param str bucket_id: The bucket id. (required) - :param str flow_id: The flow id. (required) - :return: VersionedFlowSnapshotMetadataSetEntity - If the method is called asynchronously, - returns the request thread. + Gets the flow versions from the specified registry and bucket for the specified flow for the current user. + This method makes a synchronous HTTP request and returns the response data directly. + + For full HTTP response details (status code, headers, etc.), use the corresponding + ``get_versions_with_http_info()`` method instead. + + Args: + registry_id (str): + The registry client id. (required) + bucket_id (str): + The bucket id. (required) + flow_id (str): + The flow id. (required) + branch (str): + The name of a branch to get the flow versions from. If not specified the default branch of the registry client will be used. + + Returns: + :class:`~nipyapi.nifi.models.VersionedFlowSnapshotMetadataSetEntity`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): @@ -4816,28 +5691,27 @@ def get_versions(self, registry_id, bucket_id, flow_id, **kwargs): def get_versions_with_http_info(self, registry_id, bucket_id, flow_id, **kwargs): """ - Gets the flow versions from the specified registry and bucket for the specified flow for the current user + Gets the flow versions from the specified registry and bucket for the specified flow for the current user. + This method makes a synchronous HTTP request and returns detailed response information. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_versions_with_http_info(registry_id, bucket_id, flow_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str registry_id: The registry client id. (required) - :param str bucket_id: The bucket id. (required) - :param str flow_id: The flow id. (required) - :return: VersionedFlowSnapshotMetadataSetEntity - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['registry_id', 'bucket_id', 'flow_id'] - all_params.append('callback') + Returns the response data along with HTTP status code, headers, and other metadata. + For just the response data, use the corresponding ``get_versions()`` method instead. + + Args: + registry_id (str): + The registry client id. (required) + bucket_id (str): + The bucket id. (required) + flow_id (str): + The flow id. (required) + branch (str): + The name of a branch to get the flow versions from. If not specified the default branch of the registry client will be used. + + Returns: + tuple: (:class:`~nipyapi.nifi.models.VersionedFlowSnapshotMetadataSetEntity`, status_code, headers) - Response data with HTTP details. + """ + + all_params = ['registry_id', 'bucket_id', 'flow_id', 'branch'] all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -4861,7 +5735,10 @@ def get_versions_with_http_info(self, registry_id, bucket_id, flow_id, **kwargs) if ('flow_id' not in params) or (params['flow_id'] is None): raise ValueError("Missing the required parameter `flow_id` when calling `get_versions`") - + + + + collection_formats = {} path_params = {} @@ -4873,6 +5750,8 @@ def get_versions_with_http_info(self, registry_id, bucket_id, flow_id, **kwargs) path_params['flow-id'] = params['flow_id'] query_params = [] + if 'branch' in params: + query_params.append(('branch', params['branch'])) header_params = {} @@ -4884,12 +5763,8 @@ def get_versions_with_http_info(self, registry_id, bucket_id, flow_id, **kwargs) header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['*/*']) - # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/flow/registries/{registry-id}/buckets/{bucket-id}/flows/{flow-id}/versions', 'GET', path_params, @@ -4900,7 +5775,6 @@ def get_versions_with_http_info(self, registry_id, bucket_id, flow_id, **kwargs) files=local_var_files, response_type='VersionedFlowSnapshotMetadataSetEntity', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), @@ -4908,29 +5782,35 @@ def get_versions_with_http_info(self, registry_id, bucket_id, flow_id, **kwargs) def query_history(self, offset, count, **kwargs): """ - Gets configuration history + Gets configuration history. + Note: This endpoint is subject to change as NiFi and it's REST API evolve. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.query_history(offset, count, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str offset: The offset into the result set. (required) - :param str count: The number of actions to return. (required) - :param str sort_column: The field to sort on. - :param str sort_order: The direction to sort. - :param str start_date: Include actions after this date. - :param str end_date: Include actions before this date. - :param str user_identity: Include actions performed by this user. - :param str source_id: Include actions on this component. - :return: HistoryEntity - If the method is called asynchronously, - returns the request thread. + + 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 + ``query_history_with_http_info()`` method instead. + + Args: + offset (:class:`~nipyapi.nifi.models.IntegerParameter`): + The offset into the result set. (required) + count (:class:`~nipyapi.nifi.models.IntegerParameter`): + The number of actions to return. (required) + sort_column (str): + The field to sort on. + sort_order (str): + The direction to sort. + start_date (:class:`~nipyapi.nifi.models.DateTimeParameter`): + Include actions after this date. + end_date (:class:`~nipyapi.nifi.models.DateTimeParameter`): + Include actions before this date. + user_identity (str): + Include actions performed by this user. + source_id (str): + Include actions on this component. + + Returns: + :class:`~nipyapi.nifi.models.HistoryEntity`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): @@ -4941,33 +5821,38 @@ def query_history(self, offset, count, **kwargs): def query_history_with_http_info(self, offset, count, **kwargs): """ - Gets configuration history + Gets configuration history. + Note: This endpoint is subject to change as NiFi and it's REST API evolve. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.query_history_with_http_info(offset, count, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str offset: The offset into the result set. (required) - :param str count: The number of actions to return. (required) - :param str sort_column: The field to sort on. - :param str sort_order: The direction to sort. - :param str start_date: Include actions after this date. - :param str end_date: Include actions before this date. - :param str user_identity: Include actions performed by this user. - :param str source_id: Include actions on this component. - :return: HistoryEntity - If the method is called asynchronously, - returns the request thread. + + 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 ``query_history()`` method instead. + + Args: + offset (:class:`~nipyapi.nifi.models.IntegerParameter`): + The offset into the result set. (required) + count (:class:`~nipyapi.nifi.models.IntegerParameter`): + The number of actions to return. (required) + sort_column (str): + The field to sort on. + sort_order (str): + The direction to sort. + start_date (:class:`~nipyapi.nifi.models.DateTimeParameter`): + Include actions after this date. + end_date (:class:`~nipyapi.nifi.models.DateTimeParameter`): + Include actions before this date. + user_identity (str): + Include actions performed by this user. + source_id (str): + Include actions on this component. + + Returns: + tuple: (:class:`~nipyapi.nifi.models.HistoryEntity`, status_code, headers) - Response data with HTTP details. """ all_params = ['offset', 'count', 'sort_column', 'sort_order', 'start_date', 'end_date', 'user_identity', 'source_id'] - all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -4988,7 +5873,14 @@ def query_history_with_http_info(self, offset, count, **kwargs): if ('count' not in params) or (params['count'] is None): raise ValueError("Missing the required parameter `count` when calling `query_history`") - + + + + + + + + collection_formats = {} path_params = {} @@ -5021,12 +5913,8 @@ def query_history_with_http_info(self, offset, count, **kwargs): header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['*/*']) - # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/flow/history', 'GET', path_params, @@ -5037,62 +5925,54 @@ def query_history_with_http_info(self, offset, count, **kwargs): files=local_var_files, response_type='HistoryEntity', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def schedule_components(self, id, body, **kwargs): + def schedule_components(self, body, id, **kwargs): """ - Schedule or unschedule components in the specified Process Group. + Schedule or unschedule components in the specified Process Group.. + This method makes a synchronous HTTP request and returns the response data directly. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.schedule_components(id, body, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The process group id. (required) - :param ScheduleComponentsEntity body: The request to schedule or unschedule. If the comopnents in the request are not specified, all authorized components will be considered. (required) - :return: ScheduleComponentsEntity - If the method is called asynchronously, - returns the request thread. + For full HTTP response details (status code, headers, etc.), use the corresponding + ``schedule_components_with_http_info()`` method instead. + + Args: + body (:class:`~nipyapi.nifi.models.ScheduleComponentsEntity`): + The request to schedule or unschedule. If the components in the request are not specified, all authorized components will be considered. (required) + id (str): + The process group id. (required) + + Returns: + :class:`~nipyapi.nifi.models.ScheduleComponentsEntity`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.schedule_components_with_http_info(id, body, **kwargs) + return self.schedule_components_with_http_info(body, id, **kwargs) else: - (data) = self.schedule_components_with_http_info(id, body, **kwargs) + (data) = self.schedule_components_with_http_info(body, id, **kwargs) return data - def schedule_components_with_http_info(self, id, body, **kwargs): + def schedule_components_with_http_info(self, body, id, **kwargs): """ - Schedule or unschedule components in the specified Process Group. + Schedule or unschedule components in the specified Process Group.. + This method makes a synchronous HTTP request and returns detailed response information. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.schedule_components_with_http_info(id, body, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The process group id. (required) - :param ScheduleComponentsEntity body: The request to schedule or unschedule. If the comopnents in the request are not specified, all authorized components will be considered. (required) - :return: ScheduleComponentsEntity - If the method is called asynchronously, - returns the request thread. + Returns the response data along with HTTP status code, headers, and other metadata. + For just the response data, use the corresponding ``schedule_components()`` method instead. + + Args: + body (:class:`~nipyapi.nifi.models.ScheduleComponentsEntity`): + The request to schedule or unschedule. If the components in the request are not specified, all authorized components will be considered. (required) + id (str): + The process group id. (required) + + Returns: + tuple: (:class:`~nipyapi.nifi.models.ScheduleComponentsEntity`, status_code, headers) - Response data with HTTP details. """ - all_params = ['id', 'body'] - all_params.append('callback') + all_params = ['body', 'id'] all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -5106,14 +5986,15 @@ def schedule_components_with_http_info(self, id, body, **kwargs): ) 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 `schedule_components`") # 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 `schedule_components`") + # 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 `schedule_components`") - + + collection_formats = {} path_params = {} @@ -5139,7 +6020,7 @@ def schedule_components_with_http_info(self, id, body, **kwargs): select_header_content_type(['application/json']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/flow/process-groups/{id}', 'PUT', path_params, @@ -5150,7 +6031,6 @@ def schedule_components_with_http_info(self, id, body, **kwargs): files=local_var_files, response_type='ScheduleComponentsEntity', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), @@ -5158,22 +6038,21 @@ def schedule_components_with_http_info(self, id, body, **kwargs): def search_cluster(self, q, **kwargs): """ - Searches the cluster for a node with the specified address + Searches the cluster for a node with the specified address. + Note: This endpoint is subject to change as NiFi and it's REST API evolve. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.search_cluster(q, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str q: Node address to search for. (required) - :return: ClusterSearchResultsEntity - If the method is called asynchronously, - returns the request thread. + + 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 + ``search_cluster_with_http_info()`` method instead. + + Args: + q (str): + Node address to search for. (required) + + Returns: + :class:`~nipyapi.nifi.models.ClusterSearchResultsEntity`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): @@ -5184,26 +6063,24 @@ def search_cluster(self, q, **kwargs): def search_cluster_with_http_info(self, q, **kwargs): """ - Searches the cluster for a node with the specified address + Searches the cluster for a node with the specified address. + Note: This endpoint is subject to change as NiFi and it's REST API evolve. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.search_cluster_with_http_info(q, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str q: Node address to search for. (required) - :return: ClusterSearchResultsEntity - If the method is called asynchronously, - returns the request thread. + + 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 ``search_cluster()`` method instead. + + Args: + q (str): + Node address to search for. (required) + + Returns: + tuple: (:class:`~nipyapi.nifi.models.ClusterSearchResultsEntity`, status_code, headers) - Response data with HTTP details. """ all_params = ['q'] - all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -5221,7 +6098,7 @@ def search_cluster_with_http_info(self, q, **kwargs): if ('q' not in params) or (params['q'] is None): raise ValueError("Missing the required parameter `q` when calling `search_cluster`") - + collection_formats = {} path_params = {} @@ -5240,12 +6117,8 @@ def search_cluster_with_http_info(self, q, **kwargs): header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['*/*']) - # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/flow/cluster/search-results', 'GET', path_params, @@ -5256,7 +6129,6 @@ def search_cluster_with_http_info(self, q, **kwargs): files=local_var_files, response_type='ClusterSearchResultsEntity', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), @@ -5264,23 +6136,21 @@ def search_cluster_with_http_info(self, q, **kwargs): def search_flow(self, **kwargs): """ - Performs a search against this NiFi using the specified search term + Performs a search against this NiFi using the specified search term. + Only search results from authorized components will be returned. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.search_flow(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str q: - :param str a: - :return: SearchResultsEntity - If the method is called asynchronously, - returns the request thread. + + 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 + ``search_flow_with_http_info()`` method instead. + + Args: + q (str): + a (str): + + Returns: + :class:`~nipyapi.nifi.models.SearchResultsEntity`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): @@ -5291,27 +6161,24 @@ def search_flow(self, **kwargs): def search_flow_with_http_info(self, **kwargs): """ - Performs a search against this NiFi using the specified search term + Performs a search against this NiFi using the specified search term. + Only search results from authorized components will be returned. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.search_flow_with_http_info(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str q: - :param str a: - :return: SearchResultsEntity - If the method is called asynchronously, - returns the request thread. + + 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 ``search_flow()`` method instead. + + Args: + q (str): + a (str): + + Returns: + tuple: (:class:`~nipyapi.nifi.models.SearchResultsEntity`, status_code, headers) - Response data with HTTP details. """ all_params = ['q', 'a'] - all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -5326,7 +6193,8 @@ def search_flow_with_http_info(self, **kwargs): params[key] = val del params['kwargs'] - + + collection_formats = {} path_params = {} @@ -5347,12 +6215,8 @@ def search_flow_with_http_info(self, **kwargs): header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['*/*']) - # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/flow/search-results', 'GET', path_params, @@ -5363,7 +6227,6 @@ def search_flow_with_http_info(self, **kwargs): files=local_var_files, response_type='SearchResultsEntity', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), diff --git a/nipyapi/nifi/apis/flowfile_queues_api.py b/nipyapi/nifi/apis/flow_file_queues_api.py similarity index 61% rename from nipyapi/nifi/apis/flowfile_queues_api.py rename to nipyapi/nifi/apis/flow_file_queues_api.py index af7e3468..0cae1f70 100644 --- a/nipyapi/nifi/apis/flowfile_queues_api.py +++ b/nipyapi/nifi/apis/flow_file_queues_api.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - import sys import os import re @@ -17,7 +16,7 @@ from ..api_client import ApiClient -class FlowfileQueuesApi(object): +class FlowFileQueuesApi(object): """ NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually. @@ -35,22 +34,18 @@ def __init__(self, api_client=None): def create_drop_request(self, id, **kwargs): """ - Creates a request to drop the contents of the queue in this connection. + Creates a request to drop the contents of the queue in this connection.. + This method makes a synchronous HTTP request and returns the response data directly. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.create_drop_request(id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The connection id. (required) - :return: DropRequestEntity - If the method is called asynchronously, - returns the request thread. + For full HTTP response details (status code, headers, etc.), use the corresponding + ``create_drop_request_with_http_info()`` method instead. + + Args: + id (str): + The connection id. (required) + + Returns: + :class:`~nipyapi.nifi.models.DropRequestEntity`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): @@ -61,26 +56,21 @@ def create_drop_request(self, id, **kwargs): def create_drop_request_with_http_info(self, id, **kwargs): """ - Creates a request to drop the contents of the queue in this connection. + Creates a request to drop the contents of the queue in this connection.. + This method makes a synchronous HTTP request and returns detailed response information. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.create_drop_request_with_http_info(id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The connection id. (required) - :return: DropRequestEntity - If the method is called asynchronously, - returns the request thread. + Returns the response data along with HTTP status code, headers, and other metadata. + For just the response data, use the corresponding ``create_drop_request()`` method instead. + + Args: + id (str): + The connection id. (required) + + Returns: + tuple: (:class:`~nipyapi.nifi.models.DropRequestEntity`, status_code, headers) - Response data with HTTP details. """ all_params = ['id'] - all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -98,7 +88,7 @@ def create_drop_request_with_http_info(self, id, **kwargs): if ('id' not in params) or (params['id'] is None): raise ValueError("Missing the required parameter `id` when calling `create_drop_request`") - + collection_formats = {} path_params = {} @@ -117,12 +107,8 @@ def create_drop_request_with_http_info(self, id, **kwargs): header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['*/*']) - # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/flowfile-queues/{id}/drop-requests', 'POST', path_params, @@ -133,7 +119,6 @@ def create_drop_request_with_http_info(self, id, **kwargs): files=local_var_files, response_type='DropRequestEntity', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), @@ -141,22 +126,18 @@ def create_drop_request_with_http_info(self, id, **kwargs): def create_flow_file_listing(self, id, **kwargs): """ - Lists the contents of the queue in this connection. + Lists the contents of the queue in this connection.. + This method makes a synchronous HTTP request and returns the response data directly. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.create_flow_file_listing(id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The connection id. (required) - :return: ListingRequestEntity - If the method is called asynchronously, - returns the request thread. + For full HTTP response details (status code, headers, etc.), use the corresponding + ``create_flow_file_listing_with_http_info()`` method instead. + + Args: + id (str): + The connection id. (required) + + Returns: + :class:`~nipyapi.nifi.models.ListingRequestEntity`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): @@ -167,26 +148,21 @@ def create_flow_file_listing(self, id, **kwargs): def create_flow_file_listing_with_http_info(self, id, **kwargs): """ - Lists the contents of the queue in this connection. + Lists the contents of the queue in this connection.. + This method makes a synchronous HTTP request and returns detailed response information. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.create_flow_file_listing_with_http_info(id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The connection id. (required) - :return: ListingRequestEntity - If the method is called asynchronously, - returns the request thread. + Returns the response data along with HTTP status code, headers, and other metadata. + For just the response data, use the corresponding ``create_flow_file_listing()`` method instead. + + Args: + id (str): + The connection id. (required) + + Returns: + tuple: (:class:`~nipyapi.nifi.models.ListingRequestEntity`, status_code, headers) - Response data with HTTP details. """ all_params = ['id'] - all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -204,7 +180,7 @@ def create_flow_file_listing_with_http_info(self, id, **kwargs): if ('id' not in params) or (params['id'] is None): raise ValueError("Missing the required parameter `id` when calling `create_flow_file_listing`") - + collection_formats = {} path_params = {} @@ -223,12 +199,8 @@ def create_flow_file_listing_with_http_info(self, id, **kwargs): header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['*/*']) - # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/flowfile-queues/{id}/listing-requests', 'POST', path_params, @@ -239,7 +211,6 @@ def create_flow_file_listing_with_http_info(self, id, **kwargs): files=local_var_files, response_type='ListingRequestEntity', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), @@ -247,23 +218,20 @@ def create_flow_file_listing_with_http_info(self, id, **kwargs): def delete_listing_request(self, id, listing_request_id, **kwargs): """ - Cancels and/or removes a request to list the contents of this connection. + Cancels and/or removes a request to list the contents of this connection.. + This method makes a synchronous HTTP request and returns the response data directly. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.delete_listing_request(id, listing_request_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The connection id. (required) - :param str listing_request_id: The listing request id. (required) - :return: ListingRequestEntity - If the method is called asynchronously, - returns the request thread. + For full HTTP response details (status code, headers, etc.), use the corresponding + ``delete_listing_request_with_http_info()`` method instead. + + Args: + id (str): + The connection id. (required) + listing_request_id (str): + The listing request id. (required) + + Returns: + :class:`~nipyapi.nifi.models.ListingRequestEntity`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): @@ -274,27 +242,23 @@ def delete_listing_request(self, id, listing_request_id, **kwargs): def delete_listing_request_with_http_info(self, id, listing_request_id, **kwargs): """ - Cancels and/or removes a request to list the contents of this connection. + Cancels and/or removes a request to list the contents of this connection.. + This method makes a synchronous HTTP request and returns detailed response information. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.delete_listing_request_with_http_info(id, listing_request_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The connection id. (required) - :param str listing_request_id: The listing request id. (required) - :return: ListingRequestEntity - If the method is called asynchronously, - returns the request thread. + Returns the response data along with HTTP status code, headers, and other metadata. + For just the response data, use the corresponding ``delete_listing_request()`` method instead. + + Args: + id (str): + The connection id. (required) + listing_request_id (str): + The listing request id. (required) + + Returns: + tuple: (:class:`~nipyapi.nifi.models.ListingRequestEntity`, status_code, headers) - Response data with HTTP details. """ all_params = ['id', 'listing_request_id'] - all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -315,7 +279,8 @@ def delete_listing_request_with_http_info(self, id, listing_request_id, **kwargs if ('listing_request_id' not in params) or (params['listing_request_id'] is None): raise ValueError("Missing the required parameter `listing_request_id` when calling `delete_listing_request`") - + + collection_formats = {} path_params = {} @@ -336,12 +301,8 @@ def delete_listing_request_with_http_info(self, id, listing_request_id, **kwargs header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['*/*']) - # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/flowfile-queues/{id}/listing-requests/{listing-request-id}', 'DELETE', path_params, @@ -352,7 +313,6 @@ def delete_listing_request_with_http_info(self, id, listing_request_id, **kwargs files=local_var_files, response_type='ListingRequestEntity', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), @@ -360,25 +320,26 @@ def delete_listing_request_with_http_info(self, id, listing_request_id, **kwargs def download_flow_file_content(self, id, flowfile_uuid, **kwargs): """ - Gets the content for a FlowFile in a Connection. - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.download_flow_file_content(id, flowfile_uuid, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The connection id. (required) - :param str flowfile_uuid: The flowfile uuid. (required) - :param str client_id: If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response. - :param str cluster_node_id: The id of the node where the content exists if clustered. - :return: StreamingOutput - If the method is called asynchronously, - returns the request thread. + Gets the content for a FlowFile in a Connection.. + 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 + ``download_flow_file_content_with_http_info()`` method instead. + + Args: + id (str): + The connection id. (required) + flowfile_uuid (str): + The flowfile uuid. (required) + range (str): + Range of bytes requested + 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. + cluster_node_id (str): + The id of the node where the content exists if clustered. + + Returns: + :class:`~nipyapi.nifi.models.StreamingOutput`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): @@ -389,29 +350,29 @@ def download_flow_file_content(self, id, flowfile_uuid, **kwargs): def download_flow_file_content_with_http_info(self, id, flowfile_uuid, **kwargs): """ - Gets the content for a FlowFile in a Connection. - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.download_flow_file_content_with_http_info(id, flowfile_uuid, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The connection id. (required) - :param str flowfile_uuid: The flowfile uuid. (required) - :param str client_id: If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response. - :param str cluster_node_id: The id of the node where the content exists if clustered. - :return: StreamingOutput - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['id', 'flowfile_uuid', 'client_id', 'cluster_node_id'] - all_params.append('callback') + Gets the content for a FlowFile in a Connection.. + 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 ``download_flow_file_content()`` method instead. + + Args: + id (str): + The connection id. (required) + flowfile_uuid (str): + The flowfile uuid. (required) + range (str): + Range of bytes requested + 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. + cluster_node_id (str): + The id of the node where the content exists if clustered. + + Returns: + tuple: (:class:`~nipyapi.nifi.models.StreamingOutput`, status_code, headers) - Response data with HTTP details. + """ + + all_params = ['id', 'flowfile_uuid', 'range', 'client_id', 'cluster_node_id'] all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -432,7 +393,11 @@ def download_flow_file_content_with_http_info(self, id, flowfile_uuid, **kwargs) if ('flowfile_uuid' not in params) or (params['flowfile_uuid'] is None): raise ValueError("Missing the required parameter `flowfile_uuid` when calling `download_flow_file_content`") - + + + + + collection_formats = {} path_params = {} @@ -448,6 +413,8 @@ def download_flow_file_content_with_http_info(self, id, flowfile_uuid, **kwargs) query_params.append(('clusterNodeId', params['cluster_node_id'])) header_params = {} + if 'range' in params: + header_params['Range'] = params['range'] form_params = [] local_var_files = {} @@ -457,12 +424,8 @@ def download_flow_file_content_with_http_info(self, id, flowfile_uuid, **kwargs) header_params['Accept'] = self.api_client.\ select_header_accept(['*/*']) - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['*/*']) - # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/flowfile-queues/{id}/flowfiles/{flowfile-uuid}/content', 'GET', path_params, @@ -473,7 +436,6 @@ def download_flow_file_content_with_http_info(self, id, flowfile_uuid, **kwargs) files=local_var_files, response_type='StreamingOutput', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), @@ -481,23 +443,20 @@ def download_flow_file_content_with_http_info(self, id, flowfile_uuid, **kwargs) def get_drop_request(self, id, drop_request_id, **kwargs): """ - Gets the current status of a drop request for the specified connection. + Gets the current status of a drop request for the specified connection.. + This method makes a synchronous HTTP request and returns the response data directly. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_drop_request(id, drop_request_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The connection id. (required) - :param str drop_request_id: The drop request id. (required) - :return: DropRequestEntity - If the method is called asynchronously, - returns the request thread. + For full HTTP response details (status code, headers, etc.), use the corresponding + ``get_drop_request_with_http_info()`` method instead. + + Args: + id (str): + The connection id. (required) + drop_request_id (str): + The drop request id. (required) + + Returns: + :class:`~nipyapi.nifi.models.DropRequestEntity`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): @@ -508,27 +467,23 @@ def get_drop_request(self, id, drop_request_id, **kwargs): def get_drop_request_with_http_info(self, id, drop_request_id, **kwargs): """ - Gets the current status of a drop request for the specified connection. + Gets the current status of a drop request for the specified connection.. + This method makes a synchronous HTTP request and returns detailed response information. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_drop_request_with_http_info(id, drop_request_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The connection id. (required) - :param str drop_request_id: The drop request id. (required) - :return: DropRequestEntity - If the method is called asynchronously, - returns the request thread. + Returns the response data along with HTTP status code, headers, and other metadata. + For just the response data, use the corresponding ``get_drop_request()`` method instead. + + Args: + id (str): + The connection id. (required) + drop_request_id (str): + The drop request id. (required) + + Returns: + tuple: (:class:`~nipyapi.nifi.models.DropRequestEntity`, status_code, headers) - Response data with HTTP details. """ all_params = ['id', 'drop_request_id'] - all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -549,7 +504,8 @@ def get_drop_request_with_http_info(self, id, drop_request_id, **kwargs): if ('drop_request_id' not in params) or (params['drop_request_id'] is None): raise ValueError("Missing the required parameter `drop_request_id` when calling `get_drop_request`") - + + collection_formats = {} path_params = {} @@ -570,12 +526,8 @@ def get_drop_request_with_http_info(self, id, drop_request_id, **kwargs): header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['*/*']) - # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/flowfile-queues/{id}/drop-requests/{drop-request-id}', 'GET', path_params, @@ -586,7 +538,6 @@ def get_drop_request_with_http_info(self, id, drop_request_id, **kwargs): files=local_var_files, response_type='DropRequestEntity', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), @@ -594,24 +545,22 @@ def get_drop_request_with_http_info(self, id, drop_request_id, **kwargs): def get_flow_file(self, id, flowfile_uuid, **kwargs): """ - Gets a FlowFile from a Connection. - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_flow_file(id, flowfile_uuid, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The connection id. (required) - :param str flowfile_uuid: The flowfile uuid. (required) - :param str cluster_node_id: The id of the node where the content exists if clustered. - :return: FlowFileEntity - If the method is called asynchronously, - returns the request thread. + Gets a FlowFile from a Connection.. + 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_flow_file_with_http_info()`` method instead. + + Args: + id (str): + The connection id. (required) + flowfile_uuid (str): + The flowfile uuid. (required) + cluster_node_id (str): + The id of the node where the content exists if clustered. + + Returns: + :class:`~nipyapi.nifi.models.FlowFileEntity`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): @@ -622,28 +571,25 @@ def get_flow_file(self, id, flowfile_uuid, **kwargs): def get_flow_file_with_http_info(self, id, flowfile_uuid, **kwargs): """ - Gets a FlowFile from a Connection. + Gets a FlowFile from a Connection.. + This method makes a synchronous HTTP request and returns detailed response information. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_flow_file_with_http_info(id, flowfile_uuid, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The connection id. (required) - :param str flowfile_uuid: The flowfile uuid. (required) - :param str cluster_node_id: The id of the node where the content exists if clustered. - :return: FlowFileEntity - If the method is called asynchronously, - returns the request thread. + Returns the response data along with HTTP status code, headers, and other metadata. + For just the response data, use the corresponding ``get_flow_file()`` method instead. + + Args: + id (str): + The connection id. (required) + flowfile_uuid (str): + The flowfile uuid. (required) + cluster_node_id (str): + The id of the node where the content exists if clustered. + + Returns: + tuple: (:class:`~nipyapi.nifi.models.FlowFileEntity`, status_code, headers) - Response data with HTTP details. """ all_params = ['id', 'flowfile_uuid', 'cluster_node_id'] - all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -664,7 +610,9 @@ def get_flow_file_with_http_info(self, id, flowfile_uuid, **kwargs): if ('flowfile_uuid' not in params) or (params['flowfile_uuid'] is None): raise ValueError("Missing the required parameter `flowfile_uuid` when calling `get_flow_file`") - + + + collection_formats = {} path_params = {} @@ -687,12 +635,8 @@ def get_flow_file_with_http_info(self, id, flowfile_uuid, **kwargs): header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['*/*']) - # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/flowfile-queues/{id}/flowfiles/{flowfile-uuid}', 'GET', path_params, @@ -703,7 +647,6 @@ def get_flow_file_with_http_info(self, id, flowfile_uuid, **kwargs): files=local_var_files, response_type='FlowFileEntity', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), @@ -711,23 +654,20 @@ def get_flow_file_with_http_info(self, id, flowfile_uuid, **kwargs): def get_listing_request(self, id, listing_request_id, **kwargs): """ - Gets the current status of a listing request for the specified connection. + Gets the current status of a listing request for the specified connection.. + This method makes a synchronous HTTP request and returns the response data directly. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_listing_request(id, listing_request_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The connection id. (required) - :param str listing_request_id: The listing request id. (required) - :return: ListingRequestEntity - If the method is called asynchronously, - returns the request thread. + For full HTTP response details (status code, headers, etc.), use the corresponding + ``get_listing_request_with_http_info()`` method instead. + + Args: + id (str): + The connection id. (required) + listing_request_id (str): + The listing request id. (required) + + Returns: + :class:`~nipyapi.nifi.models.ListingRequestEntity`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): @@ -738,27 +678,23 @@ def get_listing_request(self, id, listing_request_id, **kwargs): def get_listing_request_with_http_info(self, id, listing_request_id, **kwargs): """ - Gets the current status of a listing request for the specified connection. + Gets the current status of a listing request for the specified connection.. + This method makes a synchronous HTTP request and returns detailed response information. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_listing_request_with_http_info(id, listing_request_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The connection id. (required) - :param str listing_request_id: The listing request id. (required) - :return: ListingRequestEntity - If the method is called asynchronously, - returns the request thread. + Returns the response data along with HTTP status code, headers, and other metadata. + For just the response data, use the corresponding ``get_listing_request()`` method instead. + + Args: + id (str): + The connection id. (required) + listing_request_id (str): + The listing request id. (required) + + Returns: + tuple: (:class:`~nipyapi.nifi.models.ListingRequestEntity`, status_code, headers) - Response data with HTTP details. """ all_params = ['id', 'listing_request_id'] - all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -779,7 +715,8 @@ def get_listing_request_with_http_info(self, id, listing_request_id, **kwargs): if ('listing_request_id' not in params) or (params['listing_request_id'] is None): raise ValueError("Missing the required parameter `listing_request_id` when calling `get_listing_request`") - + + collection_formats = {} path_params = {} @@ -800,12 +737,8 @@ def get_listing_request_with_http_info(self, id, listing_request_id, **kwargs): header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['*/*']) - # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/flowfile-queues/{id}/listing-requests/{listing-request-id}', 'GET', path_params, @@ -816,7 +749,6 @@ def get_listing_request_with_http_info(self, id, listing_request_id, **kwargs): files=local_var_files, response_type='ListingRequestEntity', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), @@ -824,23 +756,20 @@ def get_listing_request_with_http_info(self, id, listing_request_id, **kwargs): def remove_drop_request(self, id, drop_request_id, **kwargs): """ - Cancels and/or removes a request to drop the contents of this connection. + Cancels and/or removes a request to drop the contents of this connection.. + This method makes a synchronous HTTP request and returns the response data directly. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.remove_drop_request(id, drop_request_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The connection id. (required) - :param str drop_request_id: The drop request id. (required) - :return: DropRequestEntity - If the method is called asynchronously, - returns the request thread. + For full HTTP response details (status code, headers, etc.), use the corresponding + ``remove_drop_request_with_http_info()`` method instead. + + Args: + id (str): + The connection id. (required) + drop_request_id (str): + The drop request id. (required) + + Returns: + :class:`~nipyapi.nifi.models.DropRequestEntity`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): @@ -851,27 +780,23 @@ def remove_drop_request(self, id, drop_request_id, **kwargs): def remove_drop_request_with_http_info(self, id, drop_request_id, **kwargs): """ - Cancels and/or removes a request to drop the contents of this connection. + Cancels and/or removes a request to drop the contents of this connection.. + This method makes a synchronous HTTP request and returns detailed response information. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.remove_drop_request_with_http_info(id, drop_request_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The connection id. (required) - :param str drop_request_id: The drop request id. (required) - :return: DropRequestEntity - If the method is called asynchronously, - returns the request thread. + Returns the response data along with HTTP status code, headers, and other metadata. + For just the response data, use the corresponding ``remove_drop_request()`` method instead. + + Args: + id (str): + The connection id. (required) + drop_request_id (str): + The drop request id. (required) + + Returns: + tuple: (:class:`~nipyapi.nifi.models.DropRequestEntity`, status_code, headers) - Response data with HTTP details. """ all_params = ['id', 'drop_request_id'] - all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -892,7 +817,8 @@ def remove_drop_request_with_http_info(self, id, drop_request_id, **kwargs): if ('drop_request_id' not in params) or (params['drop_request_id'] is None): raise ValueError("Missing the required parameter `drop_request_id` when calling `remove_drop_request`") - + + collection_formats = {} path_params = {} @@ -913,12 +839,8 @@ def remove_drop_request_with_http_info(self, id, drop_request_id, **kwargs): header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['*/*']) - # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/flowfile-queues/{id}/drop-requests/{drop-request-id}', 'DELETE', path_params, @@ -929,7 +851,6 @@ def remove_drop_request_with_http_info(self, id, drop_request_id, **kwargs): files=local_var_files, response_type='DropRequestEntity', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), diff --git a/nipyapi/nifi/apis/funnel_api.py b/nipyapi/nifi/apis/funnels_api.py similarity index 57% rename from nipyapi/nifi/apis/funnel_api.py rename to nipyapi/nifi/apis/funnels_api.py index 6c8f4516..04e2c9db 100644 --- a/nipyapi/nifi/apis/funnel_api.py +++ b/nipyapi/nifi/apis/funnels_api.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - import sys import os import re @@ -17,7 +16,7 @@ from ..api_client import ApiClient -class FunnelApi(object): +class FunnelsApi(object): """ NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually. @@ -35,22 +34,18 @@ def __init__(self, api_client=None): def get_funnel(self, id, **kwargs): """ - Gets a funnel + Gets a funnel. + 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_funnel_with_http_info()`` method instead. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_funnel(id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The funnel id. (required) - :return: FunnelEntity - If the method is called asynchronously, - returns the request thread. + Args: + id (str): + The funnel id. (required) + + Returns: + :class:`~nipyapi.nifi.models.FunnelEntity`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): @@ -61,26 +56,21 @@ def get_funnel(self, id, **kwargs): def get_funnel_with_http_info(self, id, **kwargs): """ - Gets a funnel + Gets a funnel. + 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_funnel()`` method instead. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_funnel_with_http_info(id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The funnel id. (required) - :return: FunnelEntity - If the method is called asynchronously, - returns the request thread. + Args: + id (str): + The funnel id. (required) + + Returns: + tuple: (:class:`~nipyapi.nifi.models.FunnelEntity`, status_code, headers) - Response data with HTTP details. """ all_params = ['id'] - all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -98,7 +88,7 @@ def get_funnel_with_http_info(self, id, **kwargs): if ('id' not in params) or (params['id'] is None): raise ValueError("Missing the required parameter `id` when calling `get_funnel`") - + collection_formats = {} path_params = {} @@ -117,12 +107,8 @@ def get_funnel_with_http_info(self, id, **kwargs): header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['*/*']) - # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/funnels/{id}', 'GET', path_params, @@ -133,7 +119,6 @@ def get_funnel_with_http_info(self, id, **kwargs): files=local_var_files, response_type='FunnelEntity', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), @@ -141,25 +126,24 @@ def get_funnel_with_http_info(self, id, **kwargs): def remove_funnel(self, id, **kwargs): """ - Deletes a funnel + Deletes a funnel. + 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 + ``remove_funnel_with_http_info()`` method instead. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.remove_funnel(id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The funnel id. (required) - :param str version: The revision is used to verify the client is working with the latest version of the flow. - :param str client_id: If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response. - :param bool disconnected_node_acknowledged: Acknowledges that this node is disconnected to allow for mutable requests to proceed. - :return: FunnelEntity - If the method is called asynchronously, - returns the request thread. + Args: + id (str): + The funnel 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.FunnelEntity`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): @@ -170,29 +154,27 @@ def remove_funnel(self, id, **kwargs): def remove_funnel_with_http_info(self, id, **kwargs): """ - Deletes a funnel + Deletes a funnel. + 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 ``remove_funnel()`` method instead. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.remove_funnel_with_http_info(id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The funnel id. (required) - :param str version: The revision is used to verify the client is working with the latest version of the flow. - :param str client_id: If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response. - :param bool disconnected_node_acknowledged: Acknowledges that this node is disconnected to allow for mutable requests to proceed. - :return: FunnelEntity - If the method is called asynchronously, - returns the request thread. + Args: + id (str): + The funnel 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.FunnelEntity`, status_code, headers) - Response data with HTTP details. """ all_params = ['id', 'version', 'client_id', 'disconnected_node_acknowledged'] - all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -210,7 +192,10 @@ def remove_funnel_with_http_info(self, id, **kwargs): if ('id' not in params) or (params['id'] is None): raise ValueError("Missing the required parameter `id` when calling `remove_funnel`") - + + + + collection_formats = {} path_params = {} @@ -235,12 +220,8 @@ def remove_funnel_with_http_info(self, id, **kwargs): header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['*/*']) - # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/funnels/{id}', 'DELETE', path_params, @@ -251,62 +232,54 @@ def remove_funnel_with_http_info(self, id, **kwargs): files=local_var_files, response_type='FunnelEntity', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def update_funnel(self, id, body, **kwargs): + def update_funnel(self, body, id, **kwargs): """ - Updates a funnel + Updates a funnel. + 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 + ``update_funnel_with_http_info()`` method instead. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.update_funnel(id, body, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The funnel id. (required) - :param FunnelEntity body: The funnel configuration details. (required) - :return: FunnelEntity - If the method is called asynchronously, - returns the request thread. + Args: + body (:class:`~nipyapi.nifi.models.FunnelEntity`): + The funnel configuration details. (required) + id (str): + The funnel id. (required) + + Returns: + :class:`~nipyapi.nifi.models.FunnelEntity`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.update_funnel_with_http_info(id, body, **kwargs) + return self.update_funnel_with_http_info(body, id, **kwargs) else: - (data) = self.update_funnel_with_http_info(id, body, **kwargs) + (data) = self.update_funnel_with_http_info(body, id, **kwargs) return data - def update_funnel_with_http_info(self, id, body, **kwargs): + def update_funnel_with_http_info(self, body, id, **kwargs): """ - Updates a funnel + Updates a funnel. + This method makes a synchronous HTTP request and returns detailed response information. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.update_funnel_with_http_info(id, body, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The funnel id. (required) - :param FunnelEntity body: The funnel configuration details. (required) - :return: FunnelEntity - If the method is called asynchronously, - returns the request thread. + Returns the response data along with HTTP status code, headers, and other metadata. + For just the response data, use the corresponding ``update_funnel()`` method instead. + + Args: + body (:class:`~nipyapi.nifi.models.FunnelEntity`): + The funnel configuration details. (required) + id (str): + The funnel id. (required) + + Returns: + tuple: (:class:`~nipyapi.nifi.models.FunnelEntity`, status_code, headers) - Response data with HTTP details. """ - all_params = ['id', 'body'] - all_params.append('callback') + all_params = ['body', 'id'] all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -320,14 +293,15 @@ def update_funnel_with_http_info(self, id, body, **kwargs): ) params[key] = val del params['kwargs'] - # verify the required parameter 'id' is set - if ('id' not in params) or (params['id'] is None): - raise ValueError("Missing the required parameter `id` when calling `update_funnel`") # verify the required parameter 'body' is set if ('body' not in params) or (params['body'] is None): raise ValueError("Missing the required parameter `body` when calling `update_funnel`") + # verify the required parameter 'id' is set + if ('id' not in params) or (params['id'] is None): + raise ValueError("Missing the required parameter `id` when calling `update_funnel`") - + + collection_formats = {} path_params = {} @@ -353,7 +327,7 @@ def update_funnel_with_http_info(self, id, body, **kwargs): select_header_content_type(['application/json']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/funnels/{id}', 'PUT', path_params, @@ -364,7 +338,6 @@ def update_funnel_with_http_info(self, id, body, **kwargs): files=local_var_files, response_type='FunnelEntity', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), diff --git a/nipyapi/nifi/apis/input_ports_api.py b/nipyapi/nifi/apis/input_ports_api.py index e8cebca6..f28c34ff 100644 --- a/nipyapi/nifi/apis/input_ports_api.py +++ b/nipyapi/nifi/apis/input_ports_api.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - import sys import os import re @@ -35,22 +34,18 @@ def __init__(self, api_client=None): def get_input_port(self, id, **kwargs): """ - Gets an input port + Gets an input port. + 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_input_port_with_http_info()`` method instead. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_input_port(id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The input port id. (required) - :return: PortEntity - If the method is called asynchronously, - returns the request thread. + Args: + id (str): + The input port id. (required) + + Returns: + :class:`~nipyapi.nifi.models.PortEntity`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): @@ -61,26 +56,21 @@ def get_input_port(self, id, **kwargs): def get_input_port_with_http_info(self, id, **kwargs): """ - Gets an input port + Gets an input port. + This method makes a synchronous HTTP request and returns detailed response information. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_input_port_with_http_info(id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The input port id. (required) - :return: PortEntity - If the method is called asynchronously, - returns the request thread. + Returns the response data along with HTTP status code, headers, and other metadata. + For just the response data, use the corresponding ``get_input_port()`` method instead. + + Args: + id (str): + The input port id. (required) + + Returns: + tuple: (:class:`~nipyapi.nifi.models.PortEntity`, status_code, headers) - Response data with HTTP details. """ all_params = ['id'] - all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -98,7 +88,7 @@ def get_input_port_with_http_info(self, id, **kwargs): if ('id' not in params) or (params['id'] is None): raise ValueError("Missing the required parameter `id` when calling `get_input_port`") - + collection_formats = {} path_params = {} @@ -117,12 +107,8 @@ def get_input_port_with_http_info(self, id, **kwargs): header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['*/*']) - # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/input-ports/{id}', 'GET', path_params, @@ -133,7 +119,6 @@ def get_input_port_with_http_info(self, id, **kwargs): files=local_var_files, response_type='PortEntity', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), @@ -141,25 +126,24 @@ def get_input_port_with_http_info(self, id, **kwargs): def remove_input_port(self, id, **kwargs): """ - Deletes an input port + Deletes an input port. + 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 + ``remove_input_port_with_http_info()`` method instead. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.remove_input_port(id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The input port id. (required) - :param str version: The revision is used to verify the client is working with the latest version of the flow. - :param str client_id: If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response. - :param bool disconnected_node_acknowledged: Acknowledges that this node is disconnected to allow for mutable requests to proceed. - :return: PortEntity - If the method is called asynchronously, - returns the request thread. + Args: + id (str): + The input port 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.PortEntity`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): @@ -170,29 +154,27 @@ def remove_input_port(self, id, **kwargs): def remove_input_port_with_http_info(self, id, **kwargs): """ - Deletes an input port + Deletes an input port. + This method makes a synchronous HTTP request and returns detailed response information. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.remove_input_port_with_http_info(id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The input port id. (required) - :param str version: The revision is used to verify the client is working with the latest version of the flow. - :param str client_id: If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response. - :param bool disconnected_node_acknowledged: Acknowledges that this node is disconnected to allow for mutable requests to proceed. - :return: PortEntity - If the method is called asynchronously, - returns the request thread. + Returns the response data along with HTTP status code, headers, and other metadata. + For just the response data, use the corresponding ``remove_input_port()`` method instead. + + Args: + id (str): + The input port 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.PortEntity`, status_code, headers) - Response data with HTTP details. """ all_params = ['id', 'version', 'client_id', 'disconnected_node_acknowledged'] - all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -210,7 +192,10 @@ def remove_input_port_with_http_info(self, id, **kwargs): if ('id' not in params) or (params['id'] is None): raise ValueError("Missing the required parameter `id` when calling `remove_input_port`") - + + + + collection_formats = {} path_params = {} @@ -235,12 +220,8 @@ def remove_input_port_with_http_info(self, id, **kwargs): header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['*/*']) - # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/input-ports/{id}', 'DELETE', path_params, @@ -251,62 +232,54 @@ def remove_input_port_with_http_info(self, id, **kwargs): files=local_var_files, response_type='PortEntity', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def update_input_port(self, id, body, **kwargs): + def update_input_port(self, body, id, **kwargs): """ - Updates an input port + Updates an input port. + 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 + ``update_input_port_with_http_info()`` method instead. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.update_input_port(id, body, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The input port id. (required) - :param PortEntity body: The input port configuration details. (required) - :return: PortEntity - If the method is called asynchronously, - returns the request thread. + Args: + body (:class:`~nipyapi.nifi.models.PortEntity`): + The input port configuration details. (required) + id (str): + The input port id. (required) + + Returns: + :class:`~nipyapi.nifi.models.PortEntity`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.update_input_port_with_http_info(id, body, **kwargs) + return self.update_input_port_with_http_info(body, id, **kwargs) else: - (data) = self.update_input_port_with_http_info(id, body, **kwargs) + (data) = self.update_input_port_with_http_info(body, id, **kwargs) return data - def update_input_port_with_http_info(self, id, body, **kwargs): + def update_input_port_with_http_info(self, body, id, **kwargs): """ - Updates an input port + Updates an input port. + 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 ``update_input_port()`` method instead. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.update_input_port_with_http_info(id, body, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The input port id. (required) - :param PortEntity body: The input port configuration details. (required) - :return: PortEntity - If the method is called asynchronously, - returns the request thread. + Args: + body (:class:`~nipyapi.nifi.models.PortEntity`): + The input port configuration details. (required) + id (str): + The input port id. (required) + + Returns: + tuple: (:class:`~nipyapi.nifi.models.PortEntity`, status_code, headers) - Response data with HTTP details. """ - all_params = ['id', 'body'] - all_params.append('callback') + all_params = ['body', 'id'] all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -320,14 +293,15 @@ def update_input_port_with_http_info(self, id, body, **kwargs): ) params[key] = val del params['kwargs'] - # verify the required parameter 'id' is set - if ('id' not in params) or (params['id'] is None): - raise ValueError("Missing the required parameter `id` when calling `update_input_port`") # verify the required parameter 'body' is set if ('body' not in params) or (params['body'] is None): raise ValueError("Missing the required parameter `body` when calling `update_input_port`") + # verify the required parameter 'id' is set + if ('id' not in params) or (params['id'] is None): + raise ValueError("Missing the required parameter `id` when calling `update_input_port`") - + + collection_formats = {} path_params = {} @@ -353,7 +327,7 @@ def update_input_port_with_http_info(self, id, body, **kwargs): select_header_content_type(['application/json']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/input-ports/{id}', 'PUT', path_params, @@ -364,62 +338,54 @@ def update_input_port_with_http_info(self, id, body, **kwargs): files=local_var_files, response_type='PortEntity', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def update_run_status(self, id, body, **kwargs): + def update_run_status2(self, body, id, **kwargs): """ - Updates run status of an input-port + Updates run status of an input-port. + This method makes a synchronous HTTP request and returns the response data directly. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.update_run_status(id, body, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The port id. (required) - :param PortRunStatusEntity body: The port run status. (required) - :return: ProcessorEntity - If the method is called asynchronously, - returns the request thread. + For full HTTP response details (status code, headers, etc.), use the corresponding + ``update_run_status2_with_http_info()`` method instead. + + Args: + body (:class:`~nipyapi.nifi.models.PortRunStatusEntity`): + The port run status. (required) + id (str): + The port id. (required) + + Returns: + :class:`~nipyapi.nifi.models.ProcessorEntity`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.update_run_status_with_http_info(id, body, **kwargs) + return self.update_run_status2_with_http_info(body, id, **kwargs) else: - (data) = self.update_run_status_with_http_info(id, body, **kwargs) + (data) = self.update_run_status2_with_http_info(body, id, **kwargs) return data - def update_run_status_with_http_info(self, id, body, **kwargs): + def update_run_status2_with_http_info(self, body, id, **kwargs): """ - Updates run status of an input-port + Updates run status of an input-port. + 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 ``update_run_status2()`` method instead. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.update_run_status_with_http_info(id, body, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The port id. (required) - :param PortRunStatusEntity body: The port run status. (required) - :return: ProcessorEntity - If the method is called asynchronously, - returns the request thread. + Args: + body (:class:`~nipyapi.nifi.models.PortRunStatusEntity`): + The port run status. (required) + id (str): + The port id. (required) + + Returns: + tuple: (:class:`~nipyapi.nifi.models.ProcessorEntity`, status_code, headers) - Response data with HTTP details. """ - all_params = ['id', 'body'] - all_params.append('callback') + all_params = ['body', 'id'] all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -429,18 +395,19 @@ def update_run_status_with_http_info(self, id, body, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method update_run_status" % key + " to method update_run_status2" % key ) params[key] = val del params['kwargs'] - # verify the required parameter 'id' is set - if ('id' not in params) or (params['id'] is None): - raise ValueError("Missing the required parameter `id` when calling `update_run_status`") # verify the required parameter 'body' is set if ('body' not in params) or (params['body'] is None): - raise ValueError("Missing the required parameter `body` when calling `update_run_status`") - + raise ValueError("Missing the required parameter `body` when calling `update_run_status2`") + # verify the required parameter 'id' is set + if ('id' not in params) or (params['id'] is None): + raise ValueError("Missing the required parameter `id` when calling `update_run_status2`") + + collection_formats = {} path_params = {} @@ -466,7 +433,7 @@ def update_run_status_with_http_info(self, id, body, **kwargs): select_header_content_type(['application/json']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/input-ports/{id}/run-status', 'PUT', path_params, @@ -477,7 +444,6 @@ def update_run_status_with_http_info(self, id, body, **kwargs): files=local_var_files, response_type='ProcessorEntity', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), diff --git a/nipyapi/nifi/apis/labels_api.py b/nipyapi/nifi/apis/labels_api.py index 3c99b2db..04d68bcc 100644 --- a/nipyapi/nifi/apis/labels_api.py +++ b/nipyapi/nifi/apis/labels_api.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - import sys import os import re @@ -35,22 +34,18 @@ def __init__(self, api_client=None): def get_label(self, id, **kwargs): """ - Gets a label + Gets a label. + 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_label_with_http_info()`` method instead. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_label(id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The label id. (required) - :return: LabelEntity - If the method is called asynchronously, - returns the request thread. + Args: + id (str): + The label id. (required) + + Returns: + :class:`~nipyapi.nifi.models.LabelEntity`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): @@ -61,26 +56,21 @@ def get_label(self, id, **kwargs): def get_label_with_http_info(self, id, **kwargs): """ - Gets a label + Gets a label. + 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_label()`` method instead. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_label_with_http_info(id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The label id. (required) - :return: LabelEntity - If the method is called asynchronously, - returns the request thread. + Args: + id (str): + The label id. (required) + + Returns: + tuple: (:class:`~nipyapi.nifi.models.LabelEntity`, status_code, headers) - Response data with HTTP details. """ all_params = ['id'] - all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -98,7 +88,7 @@ def get_label_with_http_info(self, id, **kwargs): if ('id' not in params) or (params['id'] is None): raise ValueError("Missing the required parameter `id` when calling `get_label`") - + collection_formats = {} path_params = {} @@ -117,12 +107,8 @@ def get_label_with_http_info(self, id, **kwargs): header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['*/*']) - # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/labels/{id}', 'GET', path_params, @@ -133,7 +119,6 @@ def get_label_with_http_info(self, id, **kwargs): files=local_var_files, response_type='LabelEntity', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), @@ -141,25 +126,24 @@ def get_label_with_http_info(self, id, **kwargs): def remove_label(self, id, **kwargs): """ - Deletes a label + Deletes a label. + 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 + ``remove_label_with_http_info()`` method instead. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.remove_label(id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The label id. (required) - :param str version: The revision is used to verify the client is working with the latest version of the flow. - :param str client_id: If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response. - :param bool disconnected_node_acknowledged: Acknowledges that this node is disconnected to allow for mutable requests to proceed. - :return: LabelEntity - If the method is called asynchronously, - returns the request thread. + Args: + id (str): + The label 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.LabelEntity`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): @@ -170,29 +154,27 @@ def remove_label(self, id, **kwargs): def remove_label_with_http_info(self, id, **kwargs): """ - Deletes a label + Deletes a label. + 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 ``remove_label()`` method instead. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.remove_label_with_http_info(id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The label id. (required) - :param str version: The revision is used to verify the client is working with the latest version of the flow. - :param str client_id: If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response. - :param bool disconnected_node_acknowledged: Acknowledges that this node is disconnected to allow for mutable requests to proceed. - :return: LabelEntity - If the method is called asynchronously, - returns the request thread. + Args: + id (str): + The label 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.LabelEntity`, status_code, headers) - Response data with HTTP details. """ all_params = ['id', 'version', 'client_id', 'disconnected_node_acknowledged'] - all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -210,7 +192,10 @@ def remove_label_with_http_info(self, id, **kwargs): if ('id' not in params) or (params['id'] is None): raise ValueError("Missing the required parameter `id` when calling `remove_label`") - + + + + collection_formats = {} path_params = {} @@ -235,12 +220,8 @@ def remove_label_with_http_info(self, id, **kwargs): header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['*/*']) - # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/labels/{id}', 'DELETE', path_params, @@ -251,62 +232,54 @@ def remove_label_with_http_info(self, id, **kwargs): files=local_var_files, response_type='LabelEntity', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def update_label(self, id, body, **kwargs): + def update_label(self, body, id, **kwargs): """ - Updates a label + Updates a label. + 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 + ``update_label_with_http_info()`` method instead. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.update_label(id, body, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The label id. (required) - :param LabelEntity body: The label configuration details. (required) - :return: LabelEntity - If the method is called asynchronously, - returns the request thread. + Args: + body (:class:`~nipyapi.nifi.models.LabelEntity`): + The label configuration details. (required) + id (str): + The label id. (required) + + Returns: + :class:`~nipyapi.nifi.models.LabelEntity`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.update_label_with_http_info(id, body, **kwargs) + return self.update_label_with_http_info(body, id, **kwargs) else: - (data) = self.update_label_with_http_info(id, body, **kwargs) + (data) = self.update_label_with_http_info(body, id, **kwargs) return data - def update_label_with_http_info(self, id, body, **kwargs): + def update_label_with_http_info(self, body, id, **kwargs): """ - Updates a label + Updates a label. + This method makes a synchronous HTTP request and returns detailed response information. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.update_label_with_http_info(id, body, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The label id. (required) - :param LabelEntity body: The label configuration details. (required) - :return: LabelEntity - If the method is called asynchronously, - returns the request thread. + Returns the response data along with HTTP status code, headers, and other metadata. + For just the response data, use the corresponding ``update_label()`` method instead. + + Args: + body (:class:`~nipyapi.nifi.models.LabelEntity`): + The label configuration details. (required) + id (str): + The label id. (required) + + Returns: + tuple: (:class:`~nipyapi.nifi.models.LabelEntity`, status_code, headers) - Response data with HTTP details. """ - all_params = ['id', 'body'] - all_params.append('callback') + all_params = ['body', 'id'] all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -320,14 +293,15 @@ def update_label_with_http_info(self, id, body, **kwargs): ) params[key] = val del params['kwargs'] - # verify the required parameter 'id' is set - if ('id' not in params) or (params['id'] is None): - raise ValueError("Missing the required parameter `id` when calling `update_label`") # verify the required parameter 'body' is set if ('body' not in params) or (params['body'] is None): raise ValueError("Missing the required parameter `body` when calling `update_label`") + # verify the required parameter 'id' is set + if ('id' not in params) or (params['id'] is None): + raise ValueError("Missing the required parameter `id` when calling `update_label`") - + + collection_formats = {} path_params = {} @@ -353,7 +327,7 @@ def update_label_with_http_info(self, id, body, **kwargs): select_header_content_type(['application/json']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/labels/{id}', 'PUT', path_params, @@ -364,7 +338,6 @@ def update_label_with_http_info(self, id, body, **kwargs): files=local_var_files, response_type='LabelEntity', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), diff --git a/nipyapi/nifi/apis/output_ports_api.py b/nipyapi/nifi/apis/output_ports_api.py index e86a9b10..739111e4 100644 --- a/nipyapi/nifi/apis/output_ports_api.py +++ b/nipyapi/nifi/apis/output_ports_api.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - import sys import os import re @@ -35,22 +34,18 @@ def __init__(self, api_client=None): def get_output_port(self, id, **kwargs): """ - Gets an output port + Gets an output port. + 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_output_port_with_http_info()`` method instead. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_output_port(id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The output port id. (required) - :return: PortEntity - If the method is called asynchronously, - returns the request thread. + Args: + id (str): + The output port id. (required) + + Returns: + :class:`~nipyapi.nifi.models.PortEntity`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): @@ -61,26 +56,21 @@ def get_output_port(self, id, **kwargs): def get_output_port_with_http_info(self, id, **kwargs): """ - Gets an output port + Gets an output port. + This method makes a synchronous HTTP request and returns detailed response information. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_output_port_with_http_info(id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The output port id. (required) - :return: PortEntity - If the method is called asynchronously, - returns the request thread. + Returns the response data along with HTTP status code, headers, and other metadata. + For just the response data, use the corresponding ``get_output_port()`` method instead. + + Args: + id (str): + The output port id. (required) + + Returns: + tuple: (:class:`~nipyapi.nifi.models.PortEntity`, status_code, headers) - Response data with HTTP details. """ all_params = ['id'] - all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -98,7 +88,7 @@ def get_output_port_with_http_info(self, id, **kwargs): if ('id' not in params) or (params['id'] is None): raise ValueError("Missing the required parameter `id` when calling `get_output_port`") - + collection_formats = {} path_params = {} @@ -117,12 +107,8 @@ def get_output_port_with_http_info(self, id, **kwargs): header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['*/*']) - # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/output-ports/{id}', 'GET', path_params, @@ -133,7 +119,6 @@ def get_output_port_with_http_info(self, id, **kwargs): files=local_var_files, response_type='PortEntity', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), @@ -141,25 +126,24 @@ def get_output_port_with_http_info(self, id, **kwargs): def remove_output_port(self, id, **kwargs): """ - Deletes an output port + Deletes an output port. + 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 + ``remove_output_port_with_http_info()`` method instead. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.remove_output_port(id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The output port id. (required) - :param str version: The revision is used to verify the client is working with the latest version of the flow. - :param str client_id: If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response. - :param bool disconnected_node_acknowledged: Acknowledges that this node is disconnected to allow for mutable requests to proceed. - :return: PortEntity - If the method is called asynchronously, - returns the request thread. + Args: + id (str): + The output port 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.PortEntity`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): @@ -170,29 +154,27 @@ def remove_output_port(self, id, **kwargs): def remove_output_port_with_http_info(self, id, **kwargs): """ - Deletes an output port + Deletes an output port. + This method makes a synchronous HTTP request and returns detailed response information. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.remove_output_port_with_http_info(id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The output port id. (required) - :param str version: The revision is used to verify the client is working with the latest version of the flow. - :param str client_id: If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response. - :param bool disconnected_node_acknowledged: Acknowledges that this node is disconnected to allow for mutable requests to proceed. - :return: PortEntity - If the method is called asynchronously, - returns the request thread. + Returns the response data along with HTTP status code, headers, and other metadata. + For just the response data, use the corresponding ``remove_output_port()`` method instead. + + Args: + id (str): + The output port 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.PortEntity`, status_code, headers) - Response data with HTTP details. """ all_params = ['id', 'version', 'client_id', 'disconnected_node_acknowledged'] - all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -210,7 +192,10 @@ def remove_output_port_with_http_info(self, id, **kwargs): if ('id' not in params) or (params['id'] is None): raise ValueError("Missing the required parameter `id` when calling `remove_output_port`") - + + + + collection_formats = {} path_params = {} @@ -235,12 +220,8 @@ def remove_output_port_with_http_info(self, id, **kwargs): header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['*/*']) - # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/output-ports/{id}', 'DELETE', path_params, @@ -251,62 +232,54 @@ def remove_output_port_with_http_info(self, id, **kwargs): files=local_var_files, response_type='PortEntity', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def update_output_port(self, id, body, **kwargs): + def update_output_port(self, body, id, **kwargs): """ - Updates an output port + Updates an output port. + 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 + ``update_output_port_with_http_info()`` method instead. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.update_output_port(id, body, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The output port id. (required) - :param PortEntity body: The output port configuration details. (required) - :return: PortEntity - If the method is called asynchronously, - returns the request thread. + Args: + body (:class:`~nipyapi.nifi.models.PortEntity`): + The output port configuration details. (required) + id (str): + The output port id. (required) + + Returns: + :class:`~nipyapi.nifi.models.PortEntity`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.update_output_port_with_http_info(id, body, **kwargs) + return self.update_output_port_with_http_info(body, id, **kwargs) else: - (data) = self.update_output_port_with_http_info(id, body, **kwargs) + (data) = self.update_output_port_with_http_info(body, id, **kwargs) return data - def update_output_port_with_http_info(self, id, body, **kwargs): + def update_output_port_with_http_info(self, body, id, **kwargs): """ - Updates an output port + Updates an output port. + 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 ``update_output_port()`` method instead. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.update_output_port_with_http_info(id, body, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The output port id. (required) - :param PortEntity body: The output port configuration details. (required) - :return: PortEntity - If the method is called asynchronously, - returns the request thread. + Args: + body (:class:`~nipyapi.nifi.models.PortEntity`): + The output port configuration details. (required) + id (str): + The output port id. (required) + + Returns: + tuple: (:class:`~nipyapi.nifi.models.PortEntity`, status_code, headers) - Response data with HTTP details. """ - all_params = ['id', 'body'] - all_params.append('callback') + all_params = ['body', 'id'] all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -320,14 +293,15 @@ def update_output_port_with_http_info(self, id, body, **kwargs): ) params[key] = val del params['kwargs'] - # verify the required parameter 'id' is set - if ('id' not in params) or (params['id'] is None): - raise ValueError("Missing the required parameter `id` when calling `update_output_port`") # verify the required parameter 'body' is set if ('body' not in params) or (params['body'] is None): raise ValueError("Missing the required parameter `body` when calling `update_output_port`") + # verify the required parameter 'id' is set + if ('id' not in params) or (params['id'] is None): + raise ValueError("Missing the required parameter `id` when calling `update_output_port`") - + + collection_formats = {} path_params = {} @@ -353,7 +327,7 @@ def update_output_port_with_http_info(self, id, body, **kwargs): select_header_content_type(['application/json']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/output-ports/{id}', 'PUT', path_params, @@ -364,62 +338,54 @@ def update_output_port_with_http_info(self, id, body, **kwargs): files=local_var_files, response_type='PortEntity', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def update_run_status(self, id, body, **kwargs): + def update_run_status3(self, body, id, **kwargs): """ - Updates run status of an output-port + Updates run status of an output-port. + This method makes a synchronous HTTP request and returns the response data directly. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.update_run_status(id, body, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The port id. (required) - :param PortRunStatusEntity body: The port run status. (required) - :return: ProcessorEntity - If the method is called asynchronously, - returns the request thread. + For full HTTP response details (status code, headers, etc.), use the corresponding + ``update_run_status3_with_http_info()`` method instead. + + Args: + body (:class:`~nipyapi.nifi.models.PortRunStatusEntity`): + The port run status. (required) + id (str): + The port id. (required) + + Returns: + :class:`~nipyapi.nifi.models.ProcessorEntity`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.update_run_status_with_http_info(id, body, **kwargs) + return self.update_run_status3_with_http_info(body, id, **kwargs) else: - (data) = self.update_run_status_with_http_info(id, body, **kwargs) + (data) = self.update_run_status3_with_http_info(body, id, **kwargs) return data - def update_run_status_with_http_info(self, id, body, **kwargs): + def update_run_status3_with_http_info(self, body, id, **kwargs): """ - Updates run status of an output-port + Updates run status of an output-port. + 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 ``update_run_status3()`` method instead. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.update_run_status_with_http_info(id, body, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The port id. (required) - :param PortRunStatusEntity body: The port run status. (required) - :return: ProcessorEntity - If the method is called asynchronously, - returns the request thread. + Args: + body (:class:`~nipyapi.nifi.models.PortRunStatusEntity`): + The port run status. (required) + id (str): + The port id. (required) + + Returns: + tuple: (:class:`~nipyapi.nifi.models.ProcessorEntity`, status_code, headers) - Response data with HTTP details. """ - all_params = ['id', 'body'] - all_params.append('callback') + all_params = ['body', 'id'] all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -429,18 +395,19 @@ def update_run_status_with_http_info(self, id, body, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method update_run_status" % key + " to method update_run_status3" % key ) params[key] = val del params['kwargs'] - # verify the required parameter 'id' is set - if ('id' not in params) or (params['id'] is None): - raise ValueError("Missing the required parameter `id` when calling `update_run_status`") # verify the required parameter 'body' is set if ('body' not in params) or (params['body'] is None): - raise ValueError("Missing the required parameter `body` when calling `update_run_status`") - + raise ValueError("Missing the required parameter `body` when calling `update_run_status3`") + # verify the required parameter 'id' is set + if ('id' not in params) or (params['id'] is None): + raise ValueError("Missing the required parameter `id` when calling `update_run_status3`") + + collection_formats = {} path_params = {} @@ -466,7 +433,7 @@ def update_run_status_with_http_info(self, id, body, **kwargs): select_header_content_type(['application/json']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/output-ports/{id}/run-status', 'PUT', path_params, @@ -477,7 +444,6 @@ def update_run_status_with_http_info(self, id, body, **kwargs): files=local_var_files, response_type='ProcessorEntity', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), diff --git a/nipyapi/nifi/apis/parameter_contexts_api.py b/nipyapi/nifi/apis/parameter_contexts_api.py index c684186e..0040393e 100644 --- a/nipyapi/nifi/apis/parameter_contexts_api.py +++ b/nipyapi/nifi/apis/parameter_contexts_api.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - import sys import os import re @@ -33,24 +32,135 @@ def __init__(self, api_client=None): config.api_client = ApiClient() self.api_client = config.api_client + def create_asset(self, body, context_id, **kwargs): + """ + Creates a new Asset in the given Parameter Context. + + 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. + + 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_asset_with_http_info()`` method instead. + + Args: + body (:class:`~nipyapi.nifi.models.object`): + The contents of the asset. (required) + context_id (str): (required) + filename (str): + + Returns: + :class:`~nipyapi.nifi.models.AssetEntity`: The response data. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('callback'): + return self.create_asset_with_http_info(body, context_id, **kwargs) + else: + (data) = self.create_asset_with_http_info(body, context_id, **kwargs) + return data + + def create_asset_with_http_info(self, body, context_id, **kwargs): + """ + Creates a new Asset in the given Parameter Context. + + 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. + + 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_asset()`` method instead. + + Args: + body (:class:`~nipyapi.nifi.models.object`): + The contents of the asset. (required) + context_id (str): (required) + filename (str): + + Returns: + tuple: (:class:`~nipyapi.nifi.models.AssetEntity`, status_code, headers) - Response data with HTTP details. + """ + + all_params = ['body', 'context_id', 'filename'] + 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_asset" % 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_asset`") + # verify the required parameter 'context_id' is set + if ('context_id' not in params) or (params['context_id'] is None): + raise ValueError("Missing the required parameter `context_id` when calling `create_asset`") + + + + + collection_formats = {} + + path_params = {} + if 'context_id' in params: + path_params['contextId'] = params['context_id'] + + query_params = [] + + header_params = {} + if 'filename' in params: + header_params['Filename'] = params['filename'] + + 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('/parameter-contexts/{contextId}/assets', 'POST', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='AssetEntity', + 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_parameter_context(self, body, **kwargs): """ - Create a Parameter Context + Create a Parameter Context. + This method makes a synchronous HTTP request and returns the response data directly. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.create_parameter_context(body, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param ParameterContextEntity body: The Parameter Context. (required) - :return: ParameterContextEntity - If the method is called asynchronously, - returns the request thread. + For full HTTP response details (status code, headers, etc.), use the corresponding + ``create_parameter_context_with_http_info()`` method instead. + + Args: + body (:class:`~nipyapi.nifi.models.ParameterContextEntity`): + The Parameter Context. (required) + + Returns: + :class:`~nipyapi.nifi.models.ParameterContextEntity`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): @@ -61,26 +171,21 @@ def create_parameter_context(self, body, **kwargs): def create_parameter_context_with_http_info(self, body, **kwargs): """ - Create a Parameter Context + Create a Parameter Context. + 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_parameter_context()`` method instead. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.create_parameter_context_with_http_info(body, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param ParameterContextEntity body: The Parameter Context. (required) - :return: ParameterContextEntity - If the method is called asynchronously, - returns the request thread. + Args: + body (:class:`~nipyapi.nifi.models.ParameterContextEntity`): + The Parameter Context. (required) + + Returns: + tuple: (:class:`~nipyapi.nifi.models.ParameterContextEntity`, status_code, headers) - Response data with HTTP details. """ all_params = ['body'] - all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -98,7 +203,7 @@ def create_parameter_context_with_http_info(self, body, **kwargs): if ('body' not in params) or (params['body'] is None): raise ValueError("Missing the required parameter `body` when calling `create_parameter_context`") - + collection_formats = {} path_params = {} @@ -122,7 +227,7 @@ def create_parameter_context_with_http_info(self, body, **kwargs): select_header_content_type(['application/json']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/parameter-contexts', 'POST', path_params, @@ -133,7 +238,119 @@ def create_parameter_context_with_http_info(self, body, **kwargs): files=local_var_files, response_type='ParameterContextEntity', auth_settings=auth_settings, - callback=params.get('callback'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def delete_asset(self, context_id, asset_id, **kwargs): + """ + Deletes an Asset from the given Parameter Context. + + 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. + + 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_asset_with_http_info()`` method instead. + + Args: + context_id (str): + The ID of the Parameter Context (required) + asset_id (str): + The ID of the Asset (required) + disconnected_node_acknowledged (bool): + + Returns: + :class:`~nipyapi.nifi.models.AssetEntity`: The response data. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('callback'): + return self.delete_asset_with_http_info(context_id, asset_id, **kwargs) + else: + (data) = self.delete_asset_with_http_info(context_id, asset_id, **kwargs) + return data + + def delete_asset_with_http_info(self, context_id, asset_id, **kwargs): + """ + Deletes an Asset from the given Parameter Context. + + 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. + + 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_asset()`` method instead. + + Args: + context_id (str): + The ID of the Parameter Context (required) + asset_id (str): + The ID of the Asset (required) + disconnected_node_acknowledged (bool): + + Returns: + tuple: (:class:`~nipyapi.nifi.models.AssetEntity`, status_code, headers) - Response data with HTTP details. + """ + + all_params = ['context_id', 'asset_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_asset" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'context_id' is set + if ('context_id' not in params) or (params['context_id'] is None): + raise ValueError("Missing the required parameter `context_id` when calling `delete_asset`") + # verify the required parameter 'asset_id' is set + if ('asset_id' not in params) or (params['asset_id'] is None): + raise ValueError("Missing the required parameter `asset_id` when calling `delete_asset`") + + + + + collection_formats = {} + + path_params = {} + if 'context_id' in params: + path_params['contextId'] = params['context_id'] + if 'asset_id' in params: + path_params['assetId'] = params['asset_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('/parameter-contexts/{contextId}/assets/{assetId}', 'DELETE', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='AssetEntity', + 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'), @@ -141,25 +358,27 @@ def create_parameter_context_with_http_info(self, body, **kwargs): def delete_parameter_context(self, id, **kwargs): """ - Deletes the Parameter Context with the given ID Deletes the Parameter Context with the given ID. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.delete_parameter_context(id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The Parameter Context ID. (required) - :param str version: The version is used to verify the client is working with the latest version of the flow. - :param str client_id: If the client id is not specified, a new one will be generated. This value (whether specified or generated) is included in the response. - :param bool disconnected_node_acknowledged: Acknowledges that this node is disconnected to allow for mutable requests to proceed. - :return: ParameterContextEntity - If the method is called asynchronously, - returns the request thread. + + Deletes the Parameter Context 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 + ``delete_parameter_context_with_http_info()`` method instead. + + Args: + id (str): + The Parameter Context ID. (required) + version (:class:`~nipyapi.nifi.models.LongParameter`): + The version 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, a new one will be generated. This value (whether specified or generated) is included in the response. + disconnected_node_acknowledged (bool): + Acknowledges that this node is disconnected to allow for mutable requests to proceed. + + Returns: + :class:`~nipyapi.nifi.models.ParameterContextEntity`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): @@ -170,29 +389,30 @@ def delete_parameter_context(self, id, **kwargs): def delete_parameter_context_with_http_info(self, id, **kwargs): """ - Deletes the Parameter Context with the given ID Deletes the Parameter Context with the given ID. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.delete_parameter_context_with_http_info(id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The Parameter Context ID. (required) - :param str version: The version is used to verify the client is working with the latest version of the flow. - :param str client_id: If the client id is not specified, a new one will be generated. This value (whether specified or generated) is included in the response. - :param bool disconnected_node_acknowledged: Acknowledges that this node is disconnected to allow for mutable requests to proceed. - :return: ParameterContextEntity - If the method is called asynchronously, - returns the request thread. + + Deletes the Parameter Context 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 ``delete_parameter_context()`` method instead. + + Args: + id (str): + The Parameter Context ID. (required) + version (:class:`~nipyapi.nifi.models.LongParameter`): + The version 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, a new one will be generated. This value (whether specified or generated) is included in the response. + disconnected_node_acknowledged (bool): + Acknowledges that this node is disconnected to allow for mutable requests to proceed. + + Returns: + tuple: (:class:`~nipyapi.nifi.models.ParameterContextEntity`, status_code, headers) - Response data with HTTP details. """ all_params = ['id', 'version', 'client_id', 'disconnected_node_acknowledged'] - all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -210,7 +430,10 @@ def delete_parameter_context_with_http_info(self, id, **kwargs): if ('id' not in params) or (params['id'] is None): raise ValueError("Missing the required parameter `id` when calling `delete_parameter_context`") - + + + + collection_formats = {} path_params = {} @@ -235,12 +458,8 @@ def delete_parameter_context_with_http_info(self, id, **kwargs): header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['*/*']) - # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/parameter-contexts/{id}', 'DELETE', path_params, @@ -251,7 +470,6 @@ def delete_parameter_context_with_http_info(self, id, **kwargs): files=local_var_files, response_type='ParameterContextEntity', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), @@ -259,24 +477,25 @@ def delete_parameter_context_with_http_info(self, id, **kwargs): def delete_update_request(self, context_id, request_id, **kwargs): """ - Deletes the Update Request with the given ID + Deletes the Update Request with the given ID. + Deletes the Update Request with the given ID. After a request is created via a POST to /nifi-api/parameter-contexts/update-requests, it is expected that the client will properly clean up the request by DELETE'ing it, once the Update process has completed. If the request is deleted before the request completes, then the Update request will finish the step that it is currently performing and then will cancel any subsequent steps. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.delete_update_request(context_id, request_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str context_id: The ID of the ParameterContext (required) - :param str request_id: The ID of the Update Request (required) - :param bool disconnected_node_acknowledged: Acknowledges that this node is disconnected to allow for mutable requests to proceed. - :return: ParameterContextUpdateRequestEntity - If the method is called asynchronously, - returns the request thread. + + 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_update_request_with_http_info()`` method instead. + + Args: + context_id (str): + The ID of the ParameterContext (required) + request_id (str): + The ID of the Update Request (required) + disconnected_node_acknowledged (bool): + Acknowledges that this node is disconnected to allow for mutable requests to proceed. + + Returns: + :class:`~nipyapi.nifi.models.ParameterContextUpdateRequestEntity`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): @@ -287,28 +506,28 @@ def delete_update_request(self, context_id, request_id, **kwargs): def delete_update_request_with_http_info(self, context_id, request_id, **kwargs): """ - Deletes the Update Request with the given ID + Deletes the Update Request with the given ID. + Deletes the Update Request with the given ID. After a request is created via a POST to /nifi-api/parameter-contexts/update-requests, it is expected that the client will properly clean up the request by DELETE'ing it, once the Update process has completed. If the request is deleted before the request completes, then the Update request will finish the step that it is currently performing and then will cancel any subsequent steps. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.delete_update_request_with_http_info(context_id, request_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str context_id: The ID of the ParameterContext (required) - :param str request_id: The ID of the Update Request (required) - :param bool disconnected_node_acknowledged: Acknowledges that this node is disconnected to allow for mutable requests to proceed. - :return: ParameterContextUpdateRequestEntity - If the method is called asynchronously, - returns the request thread. + + 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_update_request()`` method instead. + + Args: + context_id (str): + The ID of the ParameterContext (required) + request_id (str): + The ID of the Update Request (required) + disconnected_node_acknowledged (bool): + Acknowledges that this node is disconnected to allow for mutable requests to proceed. + + Returns: + tuple: (:class:`~nipyapi.nifi.models.ParameterContextUpdateRequestEntity`, status_code, headers) - Response data with HTTP details. """ all_params = ['context_id', 'request_id', 'disconnected_node_acknowledged'] - all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -329,7 +548,9 @@ def delete_update_request_with_http_info(self, context_id, request_id, **kwargs) if ('request_id' not in params) or (params['request_id'] is None): raise ValueError("Missing the required parameter `request_id` when calling `delete_update_request`") - + + + collection_formats = {} path_params = {} @@ -352,12 +573,8 @@ def delete_update_request_with_http_info(self, context_id, request_id, **kwargs) header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['*/*']) - # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/parameter-contexts/{contextId}/update-requests/{requestId}', 'DELETE', path_params, @@ -368,7 +585,6 @@ def delete_update_request_with_http_info(self, context_id, request_id, **kwargs) files=local_var_files, response_type='ParameterContextUpdateRequestEntity', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), @@ -376,24 +592,25 @@ def delete_update_request_with_http_info(self, context_id, request_id, **kwargs) def delete_validation_request(self, context_id, id, **kwargs): """ - Deletes the Validation Request with the given ID + Deletes the Validation Request with the given ID. + Deletes the Validation Request with the given ID. After a request is created via a POST to /nifi-api/validation-contexts, it is expected that the client will properly clean up the request by DELETE'ing it, once the validation process has completed. If the request is deleted before the request completes, then the Validation request will finish the step that it is currently performing and then will cancel any subsequent steps. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.delete_validation_request(context_id, id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str context_id: The ID of the Parameter Context (required) - :param str id: The ID of the Update Request (required) - :param bool disconnected_node_acknowledged: Acknowledges that this node is disconnected to allow for mutable requests to proceed. - :return: ParameterContextValidationRequestEntity - If the method is called asynchronously, - returns the request thread. + + 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_validation_request_with_http_info()`` method instead. + + Args: + context_id (str): + The ID of the Parameter Context (required) + id (str): + The ID of the Update Request (required) + disconnected_node_acknowledged (bool): + Acknowledges that this node is disconnected to allow for mutable requests to proceed. + + Returns: + :class:`~nipyapi.nifi.models.ParameterContextValidationRequestEntity`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): @@ -404,28 +621,28 @@ def delete_validation_request(self, context_id, id, **kwargs): def delete_validation_request_with_http_info(self, context_id, id, **kwargs): """ - Deletes the Validation Request with the given ID + Deletes the Validation Request with the given ID. + Deletes the Validation Request with the given ID. After a request is created via a POST to /nifi-api/validation-contexts, it is expected that the client will properly clean up the request by DELETE'ing it, once the validation process has completed. If the request is deleted before the request completes, then the Validation request will finish the step that it is currently performing and then will cancel any subsequent steps. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.delete_validation_request_with_http_info(context_id, id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str context_id: The ID of the Parameter Context (required) - :param str id: The ID of the Update Request (required) - :param bool disconnected_node_acknowledged: Acknowledges that this node is disconnected to allow for mutable requests to proceed. - :return: ParameterContextValidationRequestEntity - If the method is called asynchronously, - returns the request thread. + + 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_validation_request()`` method instead. + + Args: + context_id (str): + The ID of the Parameter Context (required) + id (str): + The ID of the Update Request (required) + disconnected_node_acknowledged (bool): + Acknowledges that this node is disconnected to allow for mutable requests to proceed. + + Returns: + tuple: (:class:`~nipyapi.nifi.models.ParameterContextValidationRequestEntity`, status_code, headers) - Response data with HTTP details. """ all_params = ['context_id', 'id', 'disconnected_node_acknowledged'] - all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -446,7 +663,9 @@ def delete_validation_request_with_http_info(self, context_id, id, **kwargs): if ('id' not in params) or (params['id'] is None): raise ValueError("Missing the required parameter `id` when calling `delete_validation_request`") - + + + collection_formats = {} path_params = {} @@ -469,12 +688,8 @@ def delete_validation_request_with_http_info(self, context_id, id, **kwargs): header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['*/*']) - # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/parameter-contexts/{contextId}/validation-requests/{id}', 'DELETE', path_params, @@ -485,7 +700,206 @@ def delete_validation_request_with_http_info(self, context_id, id, **kwargs): files=local_var_files, response_type='ParameterContextValidationRequestEntity', auth_settings=auth_settings, - callback=params.get('callback'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def get_asset_content(self, context_id, asset_id, **kwargs): + """ + Retrieves the content of the asset 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_asset_content_with_http_info()`` method instead. + + Args: + context_id (str): + The ID of the Parameter Context (required) + asset_id (str): + The ID of the Asset (required) + + Returns: + str: The response data. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('callback'): + return self.get_asset_content_with_http_info(context_id, asset_id, **kwargs) + else: + (data) = self.get_asset_content_with_http_info(context_id, asset_id, **kwargs) + return data + + def get_asset_content_with_http_info(self, context_id, asset_id, **kwargs): + """ + Retrieves the content of the asset 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_asset_content()`` method instead. + + Args: + context_id (str): + The ID of the Parameter Context (required) + asset_id (str): + The ID of the Asset (required) + + Returns: + tuple: (str, status_code, headers) - Response data with HTTP details. + """ + + all_params = ['context_id', 'asset_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_asset_content" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'context_id' is set + if ('context_id' not in params) or (params['context_id'] is None): + raise ValueError("Missing the required parameter `context_id` when calling `get_asset_content`") + # verify the required parameter 'asset_id' is set + if ('asset_id' not in params) or (params['asset_id'] is None): + raise ValueError("Missing the required parameter `asset_id` when calling `get_asset_content`") + + + + collection_formats = {} + + path_params = {} + if 'context_id' in params: + path_params['contextId'] = params['context_id'] + if 'asset_id' in params: + path_params['assetId'] = params['asset_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/octet-stream']) + + # Authentication setting + auth_settings = ['bearerAuth'] + + return self.api_client.call_api('/parameter-contexts/{contextId}/assets/{assetId}', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='str', + auth_settings=auth_settings, + _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_assets(self, context_id, **kwargs): + """ + Lists the assets that belong to the Parameter Context with the given ID. + + Lists the assets that belong to the Parameter Context 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_assets_with_http_info()`` method instead. + + Args: + context_id (str): + The ID of the Parameter Context (required) + + Returns: + :class:`~nipyapi.nifi.models.AssetsEntity`: The response data. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('callback'): + return self.get_assets_with_http_info(context_id, **kwargs) + else: + (data) = self.get_assets_with_http_info(context_id, **kwargs) + return data + + def get_assets_with_http_info(self, context_id, **kwargs): + """ + Lists the assets that belong to the Parameter Context with the given ID. + + Lists the assets that belong to the Parameter Context 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_assets()`` method instead. + + Args: + context_id (str): + The ID of the Parameter Context (required) + + Returns: + tuple: (:class:`~nipyapi.nifi.models.AssetsEntity`, status_code, headers) - Response data with HTTP details. + """ + + all_params = ['context_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_assets" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'context_id' is set + if ('context_id' not in params) or (params['context_id'] is None): + raise ValueError("Missing the required parameter `context_id` when calling `get_assets`") + + + collection_formats = {} + + path_params = {} + if 'context_id' in params: + path_params['contextId'] = params['context_id'] + + query_params = [] + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # 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('/parameter-contexts/{contextId}/assets', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='AssetsEntity', + 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'), @@ -493,23 +907,23 @@ def delete_validation_request_with_http_info(self, context_id, id, **kwargs): def get_parameter_context(self, id, **kwargs): """ - Returns the Parameter Context with the given ID Returns the Parameter Context with the given ID. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_parameter_context(id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The ID of the Parameter Context (required) - :param bool include_inherited_parameters: 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. - :return: ParameterContextEntity - If the method is called asynchronously, - returns the request thread. + + Returns the Parameter Context 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_parameter_context_with_http_info()`` method instead. + + Args: + id (str): + The ID of the Parameter Context (required) + include_inherited_parameters (bool): + Whether or not to include inherited parameters from other parameter contexts, and therefore also overridden values. If true, the result will be the 'effective' parameter context. + + Returns: + :class:`~nipyapi.nifi.models.ParameterContextEntity`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): @@ -520,27 +934,26 @@ def get_parameter_context(self, id, **kwargs): def get_parameter_context_with_http_info(self, id, **kwargs): """ - Returns the Parameter Context with the given ID Returns the Parameter Context with the given ID. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_parameter_context_with_http_info(id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The ID of the Parameter Context (required) - :param bool include_inherited_parameters: 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. - :return: ParameterContextEntity - If the method is called asynchronously, - returns the request thread. + + Returns the Parameter Context 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_parameter_context()`` method instead. + + Args: + id (str): + The ID of the Parameter Context (required) + include_inherited_parameters (bool): + Whether or not to include inherited parameters from other parameter contexts, and therefore also overridden values. If true, the result will be the 'effective' parameter context. + + Returns: + tuple: (:class:`~nipyapi.nifi.models.ParameterContextEntity`, status_code, headers) - Response data with HTTP details. """ all_params = ['id', 'include_inherited_parameters'] - all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -558,7 +971,8 @@ def get_parameter_context_with_http_info(self, id, **kwargs): if ('id' not in params) or (params['id'] is None): raise ValueError("Missing the required parameter `id` when calling `get_parameter_context`") - + + collection_formats = {} path_params = {} @@ -579,12 +993,8 @@ def get_parameter_context_with_http_info(self, id, **kwargs): header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['*/*']) - # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/parameter-contexts/{id}', 'GET', path_params, @@ -595,7 +1005,6 @@ def get_parameter_context_with_http_info(self, id, **kwargs): files=local_var_files, response_type='ParameterContextEntity', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), @@ -603,23 +1012,23 @@ def get_parameter_context_with_http_info(self, id, **kwargs): def get_parameter_context_update(self, context_id, request_id, **kwargs): """ - Returns the Update Request with the given ID + Returns the Update Request with the given ID. + Returns the Update Request with the given ID. Once an Update Request has been created by performing a POST to /nifi-api/parameter-contexts, that request can subsequently be retrieved via this endpoint, and the request that is fetched will contain the updated state, such as percent complete, the current state of the request, and any failures. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_parameter_context_update(context_id, request_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str context_id: The ID of the Parameter Context (required) - :param str request_id: The ID of the Update Request (required) - :return: ParameterContextUpdateRequestEntity - If the method is called asynchronously, - returns the request thread. + + 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_parameter_context_update_with_http_info()`` method instead. + + Args: + context_id (str): + The ID of the Parameter Context (required) + request_id (str): + The ID of the Update Request (required) + + Returns: + :class:`~nipyapi.nifi.models.ParameterContextUpdateRequestEntity`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): @@ -630,27 +1039,26 @@ def get_parameter_context_update(self, context_id, request_id, **kwargs): def get_parameter_context_update_with_http_info(self, context_id, request_id, **kwargs): """ - Returns the Update Request with the given ID + Returns the Update Request with the given ID. + Returns the Update Request with the given ID. Once an Update Request has been created by performing a POST to /nifi-api/parameter-contexts, that request can subsequently be retrieved via this endpoint, and the request that is fetched will contain the updated state, such as percent complete, the current state of the request, and any failures. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_parameter_context_update_with_http_info(context_id, request_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str context_id: The ID of the Parameter Context (required) - :param str request_id: The ID of the Update Request (required) - :return: ParameterContextUpdateRequestEntity - If the method is called asynchronously, - returns the request thread. + + 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_parameter_context_update()`` method instead. + + Args: + context_id (str): + The ID of the Parameter Context (required) + request_id (str): + The ID of the Update Request (required) + + Returns: + tuple: (:class:`~nipyapi.nifi.models.ParameterContextUpdateRequestEntity`, status_code, headers) - Response data with HTTP details. """ all_params = ['context_id', 'request_id'] - all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -671,7 +1079,8 @@ def get_parameter_context_update_with_http_info(self, context_id, request_id, ** if ('request_id' not in params) or (params['request_id'] is None): raise ValueError("Missing the required parameter `request_id` when calling `get_parameter_context_update`") - + + collection_formats = {} path_params = {} @@ -692,12 +1101,8 @@ def get_parameter_context_update_with_http_info(self, context_id, request_id, ** header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['*/*']) - # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/parameter-contexts/{contextId}/update-requests/{requestId}', 'GET', path_params, @@ -708,7 +1113,6 @@ def get_parameter_context_update_with_http_info(self, context_id, request_id, ** files=local_var_files, response_type='ParameterContextUpdateRequestEntity', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), @@ -716,23 +1120,23 @@ def get_parameter_context_update_with_http_info(self, context_id, request_id, ** def get_validation_request(self, context_id, id, **kwargs): """ - Returns the Validation Request with the given ID + Returns the Validation Request with the given ID. + Returns the Validation Request with the given ID. Once a Validation Request has been created by performing a POST to /nifi-api/validation-contexts, that request can subsequently be retrieved via this endpoint, and the request that is fetched will contain the updated state, such as percent complete, the current state of the request, and any failures. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_validation_request(context_id, id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str context_id: The ID of the Parameter Context (required) - :param str id: The ID of the Validation Request (required) - :return: ParameterContextValidationRequestEntity - If the method is called asynchronously, - returns the request thread. + + 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_validation_request_with_http_info()`` method instead. + + Args: + context_id (str): + The ID of the Parameter Context (required) + id (str): + The ID of the Validation Request (required) + + Returns: + :class:`~nipyapi.nifi.models.ParameterContextValidationRequestEntity`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): @@ -743,27 +1147,26 @@ def get_validation_request(self, context_id, id, **kwargs): def get_validation_request_with_http_info(self, context_id, id, **kwargs): """ - Returns the Validation Request with the given ID + Returns the Validation Request with the given ID. + Returns the Validation Request with the given ID. Once a Validation Request has been created by performing a POST to /nifi-api/validation-contexts, that request can subsequently be retrieved via this endpoint, and the request that is fetched will contain the updated state, such as percent complete, the current state of the request, and any failures. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_validation_request_with_http_info(context_id, id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str context_id: The ID of the Parameter Context (required) - :param str id: The ID of the Validation Request (required) - :return: ParameterContextValidationRequestEntity - If the method is called asynchronously, - returns the request thread. + + 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_validation_request()`` method instead. + + Args: + context_id (str): + The ID of the Parameter Context (required) + id (str): + The ID of the Validation Request (required) + + Returns: + tuple: (:class:`~nipyapi.nifi.models.ParameterContextValidationRequestEntity`, status_code, headers) - Response data with HTTP details. """ all_params = ['context_id', 'id'] - all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -784,7 +1187,8 @@ def get_validation_request_with_http_info(self, context_id, id, **kwargs): if ('id' not in params) or (params['id'] is None): raise ValueError("Missing the required parameter `id` when calling `get_validation_request`") - + + collection_formats = {} path_params = {} @@ -805,12 +1209,8 @@ def get_validation_request_with_http_info(self, context_id, id, **kwargs): header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['*/*']) - # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/parameter-contexts/{contextId}/validation-requests/{id}', 'GET', path_params, @@ -821,62 +1221,58 @@ def get_validation_request_with_http_info(self, context_id, id, **kwargs): files=local_var_files, response_type='ParameterContextValidationRequestEntity', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def submit_parameter_context_update(self, context_id, body, **kwargs): + def submit_parameter_context_update(self, body, context_id, **kwargs): """ - Initiate the Update Request of a Parameter Context + Initiate the Update Request of a Parameter Context. + This will initiate the process of updating a Parameter Context. Changing the value of a Parameter may require that one or more components be stopped and restarted, so this action may take significantly more time than many other REST API actions. As a result, this endpoint will immediately return a ParameterContextUpdateRequestEntity, and the process of updating the necessary components will occur asynchronously in the background. The client may then periodically poll the status of the request by issuing a GET request to /parameter-contexts/update-requests/{requestId}. Once the request is completed, the client is expected to issue a DELETE request to /parameter-contexts/update-requests/{requestId}. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.submit_parameter_context_update(context_id, body, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str context_id: (required) - :param ParameterContextEntity body: The updated version of the parameter context. (required) - :return: ParameterContextUpdateRequestEntity - If the method is called asynchronously, - returns the request thread. + + 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_parameter_context_update_with_http_info()`` method instead. + + Args: + body (:class:`~nipyapi.nifi.models.ParameterContextEntity`): + The updated version of the parameter context. (required) + context_id (str): (required) + + Returns: + :class:`~nipyapi.nifi.models.ParameterContextUpdateRequestEntity`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.submit_parameter_context_update_with_http_info(context_id, body, **kwargs) + return self.submit_parameter_context_update_with_http_info(body, context_id, **kwargs) else: - (data) = self.submit_parameter_context_update_with_http_info(context_id, body, **kwargs) + (data) = self.submit_parameter_context_update_with_http_info(body, context_id, **kwargs) return data - def submit_parameter_context_update_with_http_info(self, context_id, body, **kwargs): + def submit_parameter_context_update_with_http_info(self, body, context_id, **kwargs): """ - Initiate the Update Request of a Parameter Context + Initiate the Update Request of a Parameter Context. + This will initiate the process of updating a Parameter Context. Changing the value of a Parameter may require that one or more components be stopped and restarted, so this action may take significantly more time than many other REST API actions. As a result, this endpoint will immediately return a ParameterContextUpdateRequestEntity, and the process of updating the necessary components will occur asynchronously in the background. The client may then periodically poll the status of the request by issuing a GET request to /parameter-contexts/update-requests/{requestId}. Once the request is completed, the client is expected to issue a DELETE request to /parameter-contexts/update-requests/{requestId}. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.submit_parameter_context_update_with_http_info(context_id, body, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str context_id: (required) - :param ParameterContextEntity body: The updated version of the parameter context. (required) - :return: ParameterContextUpdateRequestEntity - If the method is called asynchronously, - returns the request thread. + + 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_parameter_context_update()`` method instead. + + Args: + body (:class:`~nipyapi.nifi.models.ParameterContextEntity`): + The updated version of the parameter context. (required) + context_id (str): (required) + + Returns: + tuple: (:class:`~nipyapi.nifi.models.ParameterContextUpdateRequestEntity`, status_code, headers) - Response data with HTTP details. """ - all_params = ['context_id', 'body'] - all_params.append('callback') + all_params = ['body', 'context_id'] all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -890,14 +1286,15 @@ def submit_parameter_context_update_with_http_info(self, context_id, body, **kwa ) params[key] = val del params['kwargs'] - # verify the required parameter 'context_id' is set - if ('context_id' not in params) or (params['context_id'] is None): - raise ValueError("Missing the required parameter `context_id` when calling `submit_parameter_context_update`") # verify the required parameter 'body' is set if ('body' not in params) or (params['body'] is None): raise ValueError("Missing the required parameter `body` when calling `submit_parameter_context_update`") + # verify the required parameter 'context_id' is set + if ('context_id' not in params) or (params['context_id'] is None): + raise ValueError("Missing the required parameter `context_id` when calling `submit_parameter_context_update`") - + + collection_formats = {} path_params = {} @@ -923,7 +1320,7 @@ def submit_parameter_context_update_with_http_info(self, context_id, body, **kwa select_header_content_type(['application/json']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/parameter-contexts/{contextId}/update-requests', 'POST', path_params, @@ -934,62 +1331,58 @@ def submit_parameter_context_update_with_http_info(self, context_id, body, **kwa files=local_var_files, response_type='ParameterContextUpdateRequestEntity', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def submit_validation_request(self, context_id, body, **kwargs): + def submit_validation_request(self, body, context_id, **kwargs): """ - Initiate a Validation Request to determine how the validity of components will change if a Parameter Context were to be updated + Initiate a Validation Request to determine how the validity of components will change if a Parameter Context were to be updated. + This will initiate the process of validating all components whose Process Group is bound to the specified Parameter Context. Performing validation against an arbitrary number of components may be expect and take significantly more time than many other REST API actions. As a result, this endpoint will immediately return a ParameterContextValidationRequestEntity, and the process of validating the necessary components will occur asynchronously in the background. The client may then periodically poll the status of the request by issuing a GET request to /parameter-contexts/validation-requests/{requestId}. Once the request is completed, the client is expected to issue a DELETE request to /parameter-contexts/validation-requests/{requestId}. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.submit_validation_request(context_id, body, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str context_id: (required) - :param ParameterContextValidationRequestEntity body: The validation request (required) - :return: ParameterContextValidationRequestEntity - If the method is called asynchronously, - returns the request thread. + + 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_validation_request_with_http_info()`` method instead. + + Args: + body (:class:`~nipyapi.nifi.models.ParameterContextValidationRequestEntity`): + The validation request (required) + context_id (str): (required) + + Returns: + :class:`~nipyapi.nifi.models.ParameterContextValidationRequestEntity`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.submit_validation_request_with_http_info(context_id, body, **kwargs) + return self.submit_validation_request_with_http_info(body, context_id, **kwargs) else: - (data) = self.submit_validation_request_with_http_info(context_id, body, **kwargs) + (data) = self.submit_validation_request_with_http_info(body, context_id, **kwargs) return data - def submit_validation_request_with_http_info(self, context_id, body, **kwargs): + def submit_validation_request_with_http_info(self, body, context_id, **kwargs): """ - Initiate a Validation Request to determine how the validity of components will change if a Parameter Context were to be updated + Initiate a Validation Request to determine how the validity of components will change if a Parameter Context were to be updated. + This will initiate the process of validating all components whose Process Group is bound to the specified Parameter Context. Performing validation against an arbitrary number of components may be expect and take significantly more time than many other REST API actions. As a result, this endpoint will immediately return a ParameterContextValidationRequestEntity, and the process of validating the necessary components will occur asynchronously in the background. The client may then periodically poll the status of the request by issuing a GET request to /parameter-contexts/validation-requests/{requestId}. Once the request is completed, the client is expected to issue a DELETE request to /parameter-contexts/validation-requests/{requestId}. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.submit_validation_request_with_http_info(context_id, body, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str context_id: (required) - :param ParameterContextValidationRequestEntity body: The validation request (required) - :return: ParameterContextValidationRequestEntity - If the method is called asynchronously, - returns the request thread. + + 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_validation_request()`` method instead. + + Args: + body (:class:`~nipyapi.nifi.models.ParameterContextValidationRequestEntity`): + The validation request (required) + context_id (str): (required) + + Returns: + tuple: (:class:`~nipyapi.nifi.models.ParameterContextValidationRequestEntity`, status_code, headers) - Response data with HTTP details. """ - all_params = ['context_id', 'body'] - all_params.append('callback') + all_params = ['body', 'context_id'] all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -1003,14 +1396,15 @@ def submit_validation_request_with_http_info(self, context_id, body, **kwargs): ) params[key] = val del params['kwargs'] - # verify the required parameter 'context_id' is set - if ('context_id' not in params) or (params['context_id'] is None): - raise ValueError("Missing the required parameter `context_id` when calling `submit_validation_request`") # verify the required parameter 'body' is set if ('body' not in params) or (params['body'] is None): raise ValueError("Missing the required parameter `body` when calling `submit_validation_request`") + # verify the required parameter 'context_id' is set + if ('context_id' not in params) or (params['context_id'] is None): + raise ValueError("Missing the required parameter `context_id` when calling `submit_validation_request`") - + + collection_formats = {} path_params = {} @@ -1036,7 +1430,7 @@ def submit_validation_request_with_http_info(self, context_id, body, **kwargs): select_header_content_type(['application/json']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/parameter-contexts/{contextId}/validation-requests', 'POST', path_params, @@ -1047,62 +1441,58 @@ def submit_validation_request_with_http_info(self, context_id, body, **kwargs): files=local_var_files, response_type='ParameterContextValidationRequestEntity', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def update_parameter_context(self, id, body, **kwargs): + def update_parameter_context(self, body, id, **kwargs): """ - Modifies a Parameter Context + Modifies a Parameter Context. + This endpoint will update a Parameter Context to match the provided entity. However, this request will fail if any component is running and is referencing a Parameter in the Parameter Context. Generally, this endpoint is not called directly. Instead, an update request should be submitted by making a POST to the /parameter-contexts/update-requests endpoint. That endpoint will, in turn, call this endpoint. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.update_parameter_context(id, body, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: (required) - :param ParameterContextEntity body: The updated Parameter Context (required) - :return: ParameterContextEntity - If the method is called asynchronously, - returns the request thread. + + 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 + ``update_parameter_context_with_http_info()`` method instead. + + Args: + body (:class:`~nipyapi.nifi.models.ParameterContextEntity`): + The updated Parameter Context (required) + id (str): (required) + + Returns: + :class:`~nipyapi.nifi.models.ParameterContextEntity`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.update_parameter_context_with_http_info(id, body, **kwargs) + return self.update_parameter_context_with_http_info(body, id, **kwargs) else: - (data) = self.update_parameter_context_with_http_info(id, body, **kwargs) + (data) = self.update_parameter_context_with_http_info(body, id, **kwargs) return data - def update_parameter_context_with_http_info(self, id, body, **kwargs): + def update_parameter_context_with_http_info(self, body, id, **kwargs): """ - Modifies a Parameter Context + Modifies a Parameter Context. + This endpoint will update a Parameter Context to match the provided entity. However, this request will fail if any component is running and is referencing a Parameter in the Parameter Context. Generally, this endpoint is not called directly. Instead, an update request should be submitted by making a POST to the /parameter-contexts/update-requests endpoint. That endpoint will, in turn, call this endpoint. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.update_parameter_context_with_http_info(id, body, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: (required) - :param ParameterContextEntity body: The updated Parameter Context (required) - :return: ParameterContextEntity - If the method is called asynchronously, - returns the request thread. + + 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 ``update_parameter_context()`` method instead. + + Args: + body (:class:`~nipyapi.nifi.models.ParameterContextEntity`): + The updated Parameter Context (required) + id (str): (required) + + Returns: + tuple: (:class:`~nipyapi.nifi.models.ParameterContextEntity`, status_code, headers) - Response data with HTTP details. """ - all_params = ['id', 'body'] - all_params.append('callback') + all_params = ['body', 'id'] all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -1116,14 +1506,15 @@ def update_parameter_context_with_http_info(self, id, body, **kwargs): ) params[key] = val del params['kwargs'] - # verify the required parameter 'id' is set - if ('id' not in params) or (params['id'] is None): - raise ValueError("Missing the required parameter `id` when calling `update_parameter_context`") # verify the required parameter 'body' is set if ('body' not in params) or (params['body'] is None): raise ValueError("Missing the required parameter `body` when calling `update_parameter_context`") + # verify the required parameter 'id' is set + if ('id' not in params) or (params['id'] is None): + raise ValueError("Missing the required parameter `id` when calling `update_parameter_context`") - + + collection_formats = {} path_params = {} @@ -1149,7 +1540,7 @@ def update_parameter_context_with_http_info(self, id, body, **kwargs): select_header_content_type(['application/json']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/parameter-contexts/{id}', 'PUT', path_params, @@ -1160,7 +1551,6 @@ def update_parameter_context_with_http_info(self, id, body, **kwargs): files=local_var_files, response_type='ParameterContextEntity', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), diff --git a/nipyapi/nifi/apis/parameter_providers_api.py b/nipyapi/nifi/apis/parameter_providers_api.py index 571c5e8f..d753430d 100644 --- a/nipyapi/nifi/apis/parameter_providers_api.py +++ b/nipyapi/nifi/apis/parameter_providers_api.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - import sys import os import re @@ -33,56 +32,49 @@ def __init__(self, api_client=None): config.api_client = ApiClient() self.api_client = config.api_client - def analyze_configuration(self, id, body, **kwargs): + def analyze_configuration1(self, body, id, **kwargs): """ - Performs analysis of the component's configuration, providing information about which attributes are referenced. + Performs analysis of the component's configuration, providing information about which attributes are referenced.. + 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 + ``analyze_configuration1_with_http_info()`` method instead. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.analyze_configuration(id, body, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The parameter provider id. (required) - :param ConfigurationAnalysisEntity body: The configuration analysis request. (required) - :return: ConfigurationAnalysisEntity - If the method is called asynchronously, - returns the request thread. + Args: + body (:class:`~nipyapi.nifi.models.ConfigurationAnalysisEntity`): + The configuration analysis request. (required) + id (str): + The parameter provider id. (required) + + Returns: + :class:`~nipyapi.nifi.models.ConfigurationAnalysisEntity`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.analyze_configuration_with_http_info(id, body, **kwargs) + return self.analyze_configuration1_with_http_info(body, id, **kwargs) else: - (data) = self.analyze_configuration_with_http_info(id, body, **kwargs) + (data) = self.analyze_configuration1_with_http_info(body, id, **kwargs) return data - def analyze_configuration_with_http_info(self, id, body, **kwargs): + def analyze_configuration1_with_http_info(self, body, id, **kwargs): """ - Performs analysis of the component's configuration, providing information about which attributes are referenced. + Performs analysis of the component's configuration, providing information about which attributes are referenced.. + 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 ``analyze_configuration1()`` method instead. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.analyze_configuration_with_http_info(id, body, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The parameter provider id. (required) - :param ConfigurationAnalysisEntity body: The configuration analysis request. (required) - :return: ConfigurationAnalysisEntity - If the method is called asynchronously, - returns the request thread. + Args: + body (:class:`~nipyapi.nifi.models.ConfigurationAnalysisEntity`): + The configuration analysis request. (required) + id (str): + The parameter provider id. (required) + + Returns: + tuple: (:class:`~nipyapi.nifi.models.ConfigurationAnalysisEntity`, status_code, headers) - Response data with HTTP details. """ - all_params = ['id', 'body'] - all_params.append('callback') + all_params = ['body', 'id'] all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -92,18 +84,19 @@ def analyze_configuration_with_http_info(self, id, body, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method analyze_configuration" % key + " to method analyze_configuration1" % 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 `analyze_configuration`") # 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 `analyze_configuration`") - + raise ValueError("Missing the required parameter `body` when calling `analyze_configuration1`") + # 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 `analyze_configuration1`") + + collection_formats = {} path_params = {} @@ -129,7 +122,7 @@ def analyze_configuration_with_http_info(self, id, body, **kwargs): select_header_content_type(['application/json']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/parameter-providers/{id}/config/analysis', 'POST', path_params, @@ -140,60 +133,50 @@ def analyze_configuration_with_http_info(self, id, body, **kwargs): files=local_var_files, response_type='ConfigurationAnalysisEntity', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def clear_state(self, id, **kwargs): + def clear_state2(self, id, **kwargs): """ - Clears the state for a parameter provider + Clears the state for a parameter provider. + 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 + ``clear_state2_with_http_info()`` method instead. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.clear_state(id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The parameter provider id. (required) - :return: ComponentStateEntity - If the method is called asynchronously, - returns the request thread. + Args: + id (str): + The parameter provider id. (required) + + Returns: + :class:`~nipyapi.nifi.models.ComponentStateEntity`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.clear_state_with_http_info(id, **kwargs) + return self.clear_state2_with_http_info(id, **kwargs) else: - (data) = self.clear_state_with_http_info(id, **kwargs) + (data) = self.clear_state2_with_http_info(id, **kwargs) return data - def clear_state_with_http_info(self, id, **kwargs): + def clear_state2_with_http_info(self, id, **kwargs): """ - Clears the state for a parameter provider + Clears the state for a parameter provider. + This method makes a synchronous HTTP request and returns detailed response information. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.clear_state_with_http_info(id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The parameter provider id. (required) - :return: ComponentStateEntity - If the method is called asynchronously, - returns the request thread. + Returns the response data along with HTTP status code, headers, and other metadata. + For just the response data, use the corresponding ``clear_state2()`` method instead. + + Args: + id (str): + The parameter provider id. (required) + + Returns: + tuple: (:class:`~nipyapi.nifi.models.ComponentStateEntity`, status_code, headers) - Response data with HTTP details. """ all_params = ['id'] - all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -203,15 +186,15 @@ def clear_state_with_http_info(self, id, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method clear_state" % key + " to method clear_state2" % 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 `clear_state`") - + raise ValueError("Missing the required parameter `id` when calling `clear_state2`") + collection_formats = {} path_params = {} @@ -230,12 +213,8 @@ def clear_state_with_http_info(self, id, **kwargs): header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['*/*']) - # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/parameter-providers/{id}/state/clear-requests', 'POST', path_params, @@ -246,7 +225,6 @@ def clear_state_with_http_info(self, id, **kwargs): files=local_var_files, response_type='ComponentStateEntity', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), @@ -254,24 +232,25 @@ def clear_state_with_http_info(self, id, **kwargs): def delete_apply_parameters_request(self, provider_id, request_id, **kwargs): """ - Deletes the Apply Parameters Request with the given ID + Deletes the Apply Parameters Request with the given ID. + 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. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.delete_apply_parameters_request(provider_id, request_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str provider_id: The ID of the Parameter Provider (required) - :param str request_id: The ID of the Apply Parameters Request (required) - :param bool disconnected_node_acknowledged: Acknowledges that this node is disconnected to allow for mutable requests to proceed. - :return: ParameterProviderApplyParametersRequestEntity - If the method is called asynchronously, - returns the request thread. + + 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_apply_parameters_request_with_http_info()`` method instead. + + Args: + provider_id (str): + The ID of the Parameter Provider (required) + request_id (str): + The ID of the Apply Parameters Request (required) + disconnected_node_acknowledged (bool): + Acknowledges that this node is disconnected to allow for mutable requests to proceed. + + Returns: + :class:`~nipyapi.nifi.models.ParameterProviderApplyParametersRequestEntity`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): @@ -282,28 +261,28 @@ def delete_apply_parameters_request(self, provider_id, request_id, **kwargs): def delete_apply_parameters_request_with_http_info(self, provider_id, request_id, **kwargs): """ - Deletes the Apply Parameters Request with the given ID + Deletes the Apply Parameters Request with the given ID. + 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. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.delete_apply_parameters_request_with_http_info(provider_id, request_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str provider_id: The ID of the Parameter Provider (required) - :param str request_id: The ID of the Apply Parameters Request (required) - :param bool disconnected_node_acknowledged: Acknowledges that this node is disconnected to allow for mutable requests to proceed. - :return: ParameterProviderApplyParametersRequestEntity - If the method is called asynchronously, - returns the request thread. + + 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_apply_parameters_request()`` method instead. + + Args: + provider_id (str): + The ID of the Parameter Provider (required) + request_id (str): + The ID of the Apply Parameters 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.ParameterProviderApplyParametersRequestEntity`, status_code, headers) - Response data with HTTP details. """ all_params = ['provider_id', 'request_id', 'disconnected_node_acknowledged'] - all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -324,7 +303,9 @@ def delete_apply_parameters_request_with_http_info(self, provider_id, request_id if ('request_id' not in params) or (params['request_id'] is None): raise ValueError("Missing the required parameter `request_id` when calling `delete_apply_parameters_request`") - + + + collection_formats = {} path_params = {} @@ -347,12 +328,8 @@ def delete_apply_parameters_request_with_http_info(self, provider_id, request_id header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['*/*']) - # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/parameter-providers/{providerId}/apply-parameters-requests/{requestId}', 'DELETE', path_params, @@ -363,62 +340,60 @@ def delete_apply_parameters_request_with_http_info(self, provider_id, request_id files=local_var_files, response_type='ParameterProviderApplyParametersRequestEntity', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def delete_verification_request(self, id, request_id, **kwargs): + def delete_verification_request1(self, id, request_id, **kwargs): """ - Deletes the Verification Request with the given ID + Deletes the Verification Request with the given ID. + Deletes the Verification Request with the given ID. After a request is created, it is expected that the client will properly clean up the request by DELETE'ing it, once the Verification process has completed. If the request is deleted before the request completes, then the Verification request will finish the step that it is currently performing and then will cancel any subsequent steps. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.delete_verification_request(id, request_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The ID of the Parameter Provider (required) - :param str request_id: The ID of the Verification Request (required) - :return: VerifyConfigRequestEntity - If the method is called asynchronously, - returns the request thread. + + 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_verification_request1_with_http_info()`` method instead. + + Args: + id (str): + The ID of the Parameter Provider (required) + request_id (str): + The ID of the Verification Request (required) + + Returns: + :class:`~nipyapi.nifi.models.VerifyConfigRequestEntity`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.delete_verification_request_with_http_info(id, request_id, **kwargs) + return self.delete_verification_request1_with_http_info(id, request_id, **kwargs) else: - (data) = self.delete_verification_request_with_http_info(id, request_id, **kwargs) + (data) = self.delete_verification_request1_with_http_info(id, request_id, **kwargs) return data - def delete_verification_request_with_http_info(self, id, request_id, **kwargs): + def delete_verification_request1_with_http_info(self, id, request_id, **kwargs): """ - Deletes the Verification Request with the given ID + Deletes the Verification Request with the given ID. + Deletes the Verification Request with the given ID. After a request is created, it is expected that the client will properly clean up the request by DELETE'ing it, once the Verification process has completed. If the request is deleted before the request completes, then the Verification request will finish the step that it is currently performing and then will cancel any subsequent steps. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.delete_verification_request_with_http_info(id, request_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The ID of the Parameter Provider (required) - :param str request_id: The ID of the Verification Request (required) - :return: VerifyConfigRequestEntity - If the method is called asynchronously, - returns the request thread. + + 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_verification_request1()`` method instead. + + Args: + id (str): + The ID of the Parameter Provider (required) + request_id (str): + The ID of the Verification Request (required) + + Returns: + tuple: (:class:`~nipyapi.nifi.models.VerifyConfigRequestEntity`, status_code, headers) - Response data with HTTP details. """ all_params = ['id', 'request_id'] - all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -428,18 +403,19 @@ def delete_verification_request_with_http_info(self, id, request_id, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method delete_verification_request" % key + " to method delete_verification_request1" % 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_verification_request`") + raise ValueError("Missing the required parameter `id` when calling `delete_verification_request1`") # 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_verification_request`") - + raise ValueError("Missing the required parameter `request_id` when calling `delete_verification_request1`") + + collection_formats = {} path_params = {} @@ -460,12 +436,8 @@ def delete_verification_request_with_http_info(self, id, request_id, **kwargs): header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['*/*']) - # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/parameter-providers/{id}/config/verification-requests/{requestId}', 'DELETE', path_params, @@ -476,62 +448,54 @@ def delete_verification_request_with_http_info(self, id, request_id, **kwargs): files=local_var_files, response_type='VerifyConfigRequestEntity', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def fetch_parameters(self, id, body, **kwargs): + def fetch_parameters(self, body, id, **kwargs): """ - Fetches and temporarily caches the parameters for a provider + Fetches and temporarily caches the parameters for a provider. + This method makes a synchronous HTTP request and returns the response data directly. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.fetch_parameters(id, body, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The parameter provider id. (required) - :param ParameterProviderParameterFetchEntity body: The parameter fetch request. (required) - :return: ParameterProviderEntity - If the method is called asynchronously, - returns the request thread. + For full HTTP response details (status code, headers, etc.), use the corresponding + ``fetch_parameters_with_http_info()`` method instead. + + Args: + body (:class:`~nipyapi.nifi.models.ParameterProviderParameterFetchEntity`): + The parameter fetch request. (required) + id (str): + The parameter provider id. (required) + + Returns: + :class:`~nipyapi.nifi.models.ParameterProviderEntity`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.fetch_parameters_with_http_info(id, body, **kwargs) + return self.fetch_parameters_with_http_info(body, id, **kwargs) else: - (data) = self.fetch_parameters_with_http_info(id, body, **kwargs) + (data) = self.fetch_parameters_with_http_info(body, id, **kwargs) return data - def fetch_parameters_with_http_info(self, id, body, **kwargs): + def fetch_parameters_with_http_info(self, body, id, **kwargs): """ - Fetches and temporarily caches the parameters for a provider + Fetches and temporarily caches the parameters for a provider. + 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 ``fetch_parameters()`` method instead. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.fetch_parameters_with_http_info(id, body, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The parameter provider id. (required) - :param ParameterProviderParameterFetchEntity body: The parameter fetch request. (required) - :return: ParameterProviderEntity - If the method is called asynchronously, - returns the request thread. + Args: + body (:class:`~nipyapi.nifi.models.ParameterProviderParameterFetchEntity`): + The parameter fetch request. (required) + id (str): + The parameter provider id. (required) + + Returns: + tuple: (:class:`~nipyapi.nifi.models.ParameterProviderEntity`, status_code, headers) - Response data with HTTP details. """ - all_params = ['id', 'body'] - all_params.append('callback') + all_params = ['body', 'id'] all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -545,14 +509,15 @@ def fetch_parameters_with_http_info(self, id, body, **kwargs): ) 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 `fetch_parameters`") # 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 `fetch_parameters`") + # 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 `fetch_parameters`") - + + collection_formats = {} path_params = {} @@ -578,7 +543,7 @@ def fetch_parameters_with_http_info(self, id, body, **kwargs): select_header_content_type(['application/json']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/parameter-providers/{id}/parameters/fetch-requests', 'POST', path_params, @@ -589,7 +554,6 @@ def fetch_parameters_with_http_info(self, id, body, **kwargs): files=local_var_files, response_type='ParameterProviderEntity', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), @@ -597,22 +561,18 @@ def fetch_parameters_with_http_info(self, id, body, **kwargs): def get_parameter_provider(self, id, **kwargs): """ - Gets a parameter provider + Gets a parameter provider. + 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_parameter_provider_with_http_info()`` method instead. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_parameter_provider(id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The parameter provider id. (required) - :return: ParameterProviderEntity - If the method is called asynchronously, - returns the request thread. + Args: + id (str): + The parameter provider id. (required) + + Returns: + :class:`~nipyapi.nifi.models.ParameterProviderEntity`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): @@ -623,26 +583,21 @@ def get_parameter_provider(self, id, **kwargs): def get_parameter_provider_with_http_info(self, id, **kwargs): """ - Gets a parameter provider + Gets a parameter provider. + This method makes a synchronous HTTP request and returns detailed response information. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_parameter_provider_with_http_info(id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The parameter provider id. (required) - :return: ParameterProviderEntity - If the method is called asynchronously, - returns the request thread. + Returns the response data along with HTTP status code, headers, and other metadata. + For just the response data, use the corresponding ``get_parameter_provider()`` method instead. + + Args: + id (str): + The parameter provider id. (required) + + Returns: + tuple: (:class:`~nipyapi.nifi.models.ParameterProviderEntity`, status_code, headers) - Response data with HTTP details. """ all_params = ['id'] - all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -660,7 +615,7 @@ def get_parameter_provider_with_http_info(self, id, **kwargs): if ('id' not in params) or (params['id'] is None): raise ValueError("Missing the required parameter `id` when calling `get_parameter_provider`") - + collection_formats = {} path_params = {} @@ -679,12 +634,8 @@ def get_parameter_provider_with_http_info(self, id, **kwargs): header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['*/*']) - # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/parameter-providers/{id}', 'GET', path_params, @@ -695,7 +646,6 @@ def get_parameter_provider_with_http_info(self, id, **kwargs): files=local_var_files, response_type='ParameterProviderEntity', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), @@ -703,23 +653,23 @@ def get_parameter_provider_with_http_info(self, id, **kwargs): def get_parameter_provider_apply_parameters_request(self, provider_id, request_id, **kwargs): """ - Returns the Apply Parameters Request with the given ID + Returns the Apply Parameters Request with the given ID. + 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. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_parameter_provider_apply_parameters_request(provider_id, request_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str provider_id: The ID of the Parameter Provider (required) - :param str request_id: The ID of the Apply Parameters Request (required) - :return: ParameterProviderApplyParametersRequestEntity - If the method is called asynchronously, - returns the request thread. + + 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_parameter_provider_apply_parameters_request_with_http_info()`` method instead. + + Args: + provider_id (str): + The ID of the Parameter Provider (required) + request_id (str): + The ID of the Apply Parameters Request (required) + + Returns: + :class:`~nipyapi.nifi.models.ParameterProviderApplyParametersRequestEntity`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): @@ -730,27 +680,26 @@ def get_parameter_provider_apply_parameters_request(self, provider_id, request_i def get_parameter_provider_apply_parameters_request_with_http_info(self, provider_id, request_id, **kwargs): """ - Returns the Apply Parameters Request with the given ID + Returns the Apply Parameters Request with the given ID. + 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. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_parameter_provider_apply_parameters_request_with_http_info(provider_id, request_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str provider_id: The ID of the Parameter Provider (required) - :param str request_id: The ID of the Apply Parameters Request (required) - :return: ParameterProviderApplyParametersRequestEntity - If the method is called asynchronously, - returns the request thread. + + 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_parameter_provider_apply_parameters_request()`` method instead. + + Args: + provider_id (str): + The ID of the Parameter Provider (required) + request_id (str): + The ID of the Apply Parameters Request (required) + + Returns: + tuple: (:class:`~nipyapi.nifi.models.ParameterProviderApplyParametersRequestEntity`, status_code, headers) - Response data with HTTP details. """ all_params = ['provider_id', 'request_id'] - all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -771,7 +720,8 @@ def get_parameter_provider_apply_parameters_request_with_http_info(self, provide if ('request_id' not in params) or (params['request_id'] is None): raise ValueError("Missing the required parameter `request_id` when calling `get_parameter_provider_apply_parameters_request`") - + + collection_formats = {} path_params = {} @@ -792,12 +742,8 @@ def get_parameter_provider_apply_parameters_request_with_http_info(self, provide header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['*/*']) - # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/parameter-providers/{providerId}/apply-parameters-requests/{requestId}', 'GET', path_params, @@ -808,7 +754,6 @@ def get_parameter_provider_apply_parameters_request_with_http_info(self, provide files=local_var_files, response_type='ParameterProviderApplyParametersRequestEntity', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), @@ -816,22 +761,18 @@ def get_parameter_provider_apply_parameters_request_with_http_info(self, provide def get_parameter_provider_references(self, id, **kwargs): """ - Gets all references to a parameter provider + Gets all references to a parameter provider. + This method makes a synchronous HTTP request and returns the response data directly. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_parameter_provider_references(id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The parameter provider id. (required) - :return: ParameterProviderReferencingComponentsEntity - If the method is called asynchronously, - returns the request thread. + For full HTTP response details (status code, headers, etc.), use the corresponding + ``get_parameter_provider_references_with_http_info()`` method instead. + + Args: + id (str): + The parameter provider id. (required) + + Returns: + :class:`~nipyapi.nifi.models.ParameterProviderReferencingComponentsEntity`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): @@ -842,26 +783,21 @@ def get_parameter_provider_references(self, id, **kwargs): def get_parameter_provider_references_with_http_info(self, id, **kwargs): """ - Gets all references to a parameter provider + Gets all references to a parameter provider. + 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_parameter_provider_references()`` method instead. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_parameter_provider_references_with_http_info(id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The parameter provider id. (required) - :return: ParameterProviderReferencingComponentsEntity - If the method is called asynchronously, - returns the request thread. + Args: + id (str): + The parameter provider id. (required) + + Returns: + tuple: (:class:`~nipyapi.nifi.models.ParameterProviderReferencingComponentsEntity`, status_code, headers) - Response data with HTTP details. """ all_params = ['id'] - all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -879,7 +815,7 @@ def get_parameter_provider_references_with_http_info(self, id, **kwargs): if ('id' not in params) or (params['id'] is None): raise ValueError("Missing the required parameter `id` when calling `get_parameter_provider_references`") - + collection_formats = {} path_params = {} @@ -898,12 +834,8 @@ def get_parameter_provider_references_with_http_info(self, id, **kwargs): header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['*/*']) - # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/parameter-providers/{id}/references', 'GET', path_params, @@ -914,62 +846,54 @@ def get_parameter_provider_references_with_http_info(self, id, **kwargs): files=local_var_files, response_type='ParameterProviderReferencingComponentsEntity', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def get_property_descriptor(self, id, property_name, **kwargs): + def get_property_descriptor2(self, id, property_name, **kwargs): """ - Gets a parameter provider property descriptor + Gets a parameter provider property descriptor. + 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_property_descriptor2_with_http_info()`` method instead. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_property_descriptor(id, property_name, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The parameter provider id. (required) - :param str property_name: The property name. (required) - :return: PropertyDescriptorEntity - If the method is called asynchronously, - returns the request thread. + Args: + id (str): + The parameter provider id. (required) + property_name (str): + The property name. (required) + + Returns: + :class:`~nipyapi.nifi.models.PropertyDescriptorEntity`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.get_property_descriptor_with_http_info(id, property_name, **kwargs) + return self.get_property_descriptor2_with_http_info(id, property_name, **kwargs) else: - (data) = self.get_property_descriptor_with_http_info(id, property_name, **kwargs) + (data) = self.get_property_descriptor2_with_http_info(id, property_name, **kwargs) return data - def get_property_descriptor_with_http_info(self, id, property_name, **kwargs): + def get_property_descriptor2_with_http_info(self, id, property_name, **kwargs): """ - Gets a parameter provider property descriptor + Gets a parameter provider property descriptor. + This method makes a synchronous HTTP request and returns detailed response information. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_property_descriptor_with_http_info(id, property_name, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The parameter provider id. (required) - :param str property_name: The property name. (required) - :return: PropertyDescriptorEntity - If the method is called asynchronously, - returns the request thread. + Returns the response data along with HTTP status code, headers, and other metadata. + For just the response data, use the corresponding ``get_property_descriptor2()`` method instead. + + Args: + id (str): + The parameter provider id. (required) + property_name (str): + The property name. (required) + + Returns: + tuple: (:class:`~nipyapi.nifi.models.PropertyDescriptorEntity`, status_code, headers) - Response data with HTTP details. """ all_params = ['id', 'property_name'] - all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -979,18 +903,19 @@ def get_property_descriptor_with_http_info(self, id, property_name, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method get_property_descriptor" % key + " to method get_property_descriptor2" % 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_property_descriptor`") + raise ValueError("Missing the required parameter `id` when calling `get_property_descriptor2`") # verify the required parameter 'property_name' is set if ('property_name' not in params) or (params['property_name'] is None): - raise ValueError("Missing the required parameter `property_name` when calling `get_property_descriptor`") - + raise ValueError("Missing the required parameter `property_name` when calling `get_property_descriptor2`") + + collection_formats = {} path_params = {} @@ -1011,12 +936,8 @@ def get_property_descriptor_with_http_info(self, id, property_name, **kwargs): header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['*/*']) - # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/parameter-providers/{id}/descriptors', 'GET', path_params, @@ -1027,60 +948,50 @@ def get_property_descriptor_with_http_info(self, id, property_name, **kwargs): files=local_var_files, response_type='PropertyDescriptorEntity', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def get_state(self, id, **kwargs): + def get_state1(self, id, **kwargs): """ - Gets the state for a parameter provider + Gets the state for a parameter provider. + 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_state1_with_http_info()`` method instead. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_state(id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The parameter provider id. (required) - :return: ComponentStateEntity - If the method is called asynchronously, - returns the request thread. + Args: + id (str): + The parameter provider id. (required) + + Returns: + :class:`~nipyapi.nifi.models.ComponentStateEntity`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.get_state_with_http_info(id, **kwargs) + return self.get_state1_with_http_info(id, **kwargs) else: - (data) = self.get_state_with_http_info(id, **kwargs) + (data) = self.get_state1_with_http_info(id, **kwargs) return data - def get_state_with_http_info(self, id, **kwargs): + def get_state1_with_http_info(self, id, **kwargs): """ - Gets the state for a parameter provider + Gets the state for a parameter provider. + This method makes a synchronous HTTP request and returns detailed response information. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_state_with_http_info(id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The parameter provider id. (required) - :return: ComponentStateEntity - If the method is called asynchronously, - returns the request thread. + Returns the response data along with HTTP status code, headers, and other metadata. + For just the response data, use the corresponding ``get_state1()`` method instead. + + Args: + id (str): + The parameter provider id. (required) + + Returns: + tuple: (:class:`~nipyapi.nifi.models.ComponentStateEntity`, status_code, headers) - Response data with HTTP details. """ all_params = ['id'] - all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -1090,15 +1001,15 @@ def get_state_with_http_info(self, id, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method get_state" % key + " to method get_state1" % key ) params[key] = val del params['kwargs'] # verify the required parameter 'id' is set if ('id' not in params) or (params['id'] is None): - raise ValueError("Missing the required parameter `id` when calling `get_state`") - + raise ValueError("Missing the required parameter `id` when calling `get_state1`") + collection_formats = {} path_params = {} @@ -1117,12 +1028,8 @@ def get_state_with_http_info(self, id, **kwargs): header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['*/*']) - # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/parameter-providers/{id}/state', 'GET', path_params, @@ -1133,62 +1040,60 @@ def get_state_with_http_info(self, id, **kwargs): files=local_var_files, response_type='ComponentStateEntity', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def get_verification_request(self, id, request_id, **kwargs): + def get_verification_request1(self, id, request_id, **kwargs): """ - Returns the Verification Request with the given ID + Returns the Verification Request with the given ID. + Returns the Verification Request with the given ID. Once an Verification Request has been created, that request can subsequently be retrieved via this endpoint, and the request that is fetched will contain the updated state, such as percent complete, the current state of the request, and any failures. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_verification_request(id, request_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The ID of the Parameter Provider (required) - :param str request_id: The ID of the Verification Request (required) - :return: VerifyConfigRequestEntity - If the method is called asynchronously, - returns the request thread. + + 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_verification_request1_with_http_info()`` method instead. + + Args: + id (str): + The ID of the Parameter Provider (required) + request_id (str): + The ID of the Verification Request (required) + + Returns: + :class:`~nipyapi.nifi.models.VerifyConfigRequestEntity`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.get_verification_request_with_http_info(id, request_id, **kwargs) + return self.get_verification_request1_with_http_info(id, request_id, **kwargs) else: - (data) = self.get_verification_request_with_http_info(id, request_id, **kwargs) + (data) = self.get_verification_request1_with_http_info(id, request_id, **kwargs) return data - def get_verification_request_with_http_info(self, id, request_id, **kwargs): + def get_verification_request1_with_http_info(self, id, request_id, **kwargs): """ - Returns the Verification Request with the given ID + Returns the Verification Request with the given ID. + Returns the Verification Request with the given ID. Once an Verification Request has been created, that request can subsequently be retrieved via this endpoint, and the request that is fetched will contain the updated state, such as percent complete, the current state of the request, and any failures. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_verification_request_with_http_info(id, request_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The ID of the Parameter Provider (required) - :param str request_id: The ID of the Verification Request (required) - :return: VerifyConfigRequestEntity - If the method is called asynchronously, - returns the request thread. + + 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_verification_request1()`` method instead. + + Args: + id (str): + The ID of the Parameter Provider (required) + request_id (str): + The ID of the Verification Request (required) + + Returns: + tuple: (:class:`~nipyapi.nifi.models.VerifyConfigRequestEntity`, status_code, headers) - Response data with HTTP details. """ all_params = ['id', 'request_id'] - all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -1198,18 +1103,19 @@ def get_verification_request_with_http_info(self, id, request_id, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method get_verification_request" % key + " to method get_verification_request1" % 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_verification_request`") + raise ValueError("Missing the required parameter `id` when calling `get_verification_request1`") # 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_verification_request`") - + raise ValueError("Missing the required parameter `request_id` when calling `get_verification_request1`") + + collection_formats = {} path_params = {} @@ -1230,12 +1136,8 @@ def get_verification_request_with_http_info(self, id, request_id, **kwargs): header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['*/*']) - # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/parameter-providers/{id}/config/verification-requests/{requestId}', 'GET', path_params, @@ -1246,7 +1148,6 @@ def get_verification_request_with_http_info(self, id, request_id, **kwargs): files=local_var_files, response_type='VerifyConfigRequestEntity', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), @@ -1254,25 +1155,24 @@ def get_verification_request_with_http_info(self, id, request_id, **kwargs): def remove_parameter_provider(self, id, **kwargs): """ - Deletes a parameter provider + Deletes a parameter provider. + 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 + ``remove_parameter_provider_with_http_info()`` method instead. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.remove_parameter_provider(id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The parameter provider id. (required) - :param str version: The revision is used to verify the client is working with the latest version of the flow. - :param str client_id: If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response. - :param bool disconnected_node_acknowledged: Acknowledges that this node is disconnected to allow for mutable requests to proceed. - :return: ParameterProviderEntity - If the method is called asynchronously, - returns the request thread. + Args: + id (str): + The parameter provider 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.ParameterProviderEntity`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): @@ -1283,29 +1183,27 @@ def remove_parameter_provider(self, id, **kwargs): def remove_parameter_provider_with_http_info(self, id, **kwargs): """ - Deletes a parameter provider + Deletes a parameter provider. + This method makes a synchronous HTTP request and returns detailed response information. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.remove_parameter_provider_with_http_info(id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The parameter provider id. (required) - :param str version: The revision is used to verify the client is working with the latest version of the flow. - :param str client_id: If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response. - :param bool disconnected_node_acknowledged: Acknowledges that this node is disconnected to allow for mutable requests to proceed. - :return: ParameterProviderEntity - If the method is called asynchronously, - returns the request thread. + Returns the response data along with HTTP status code, headers, and other metadata. + For just the response data, use the corresponding ``remove_parameter_provider()`` method instead. + + Args: + id (str): + The parameter provider 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.ParameterProviderEntity`, status_code, headers) - Response data with HTTP details. """ all_params = ['id', 'version', 'client_id', 'disconnected_node_acknowledged'] - all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -1323,7 +1221,10 @@ def remove_parameter_provider_with_http_info(self, id, **kwargs): if ('id' not in params) or (params['id'] is None): raise ValueError("Missing the required parameter `id` when calling `remove_parameter_provider`") - + + + + collection_formats = {} path_params = {} @@ -1348,12 +1249,8 @@ def remove_parameter_provider_with_http_info(self, id, **kwargs): header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['*/*']) - # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/parameter-providers/{id}', 'DELETE', path_params, @@ -1364,62 +1261,58 @@ def remove_parameter_provider_with_http_info(self, id, **kwargs): files=local_var_files, response_type='ParameterProviderEntity', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def submit_apply_parameters(self, provider_id, body, **kwargs): + def submit_apply_parameters(self, body, provider_id, **kwargs): """ - Initiate a request to apply the fetched parameters of a Parameter Provider + Initiate a request to apply the fetched parameters of a Parameter Provider. + 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}. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.submit_apply_parameters(provider_id, body, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str provider_id: (required) - :param ParameterProviderParameterApplicationEntity body: The apply parameters request. (required) - :return: ParameterProviderApplyParametersRequestEntity - If the method is called asynchronously, - returns the request thread. + + 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_apply_parameters_with_http_info()`` method instead. + + Args: + body (:class:`~nipyapi.nifi.models.ParameterProviderParameterApplicationEntity`): + The apply parameters request. (required) + provider_id (str): (required) + + Returns: + :class:`~nipyapi.nifi.models.ParameterProviderApplyParametersRequestEntity`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.submit_apply_parameters_with_http_info(provider_id, body, **kwargs) + return self.submit_apply_parameters_with_http_info(body, provider_id, **kwargs) else: - (data) = self.submit_apply_parameters_with_http_info(provider_id, body, **kwargs) + (data) = self.submit_apply_parameters_with_http_info(body, provider_id, **kwargs) return data - def submit_apply_parameters_with_http_info(self, provider_id, body, **kwargs): + def submit_apply_parameters_with_http_info(self, body, provider_id, **kwargs): """ - Initiate a request to apply the fetched parameters of a Parameter Provider + Initiate a request to apply the fetched parameters of a Parameter Provider. + 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}. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.submit_apply_parameters_with_http_info(provider_id, body, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str provider_id: (required) - :param ParameterProviderParameterApplicationEntity body: The apply parameters request. (required) - :return: ParameterProviderApplyParametersRequestEntity - If the method is called asynchronously, - returns the request thread. + + 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_apply_parameters()`` method instead. + + Args: + body (:class:`~nipyapi.nifi.models.ParameterProviderParameterApplicationEntity`): + The apply parameters request. (required) + provider_id (str): (required) + + Returns: + tuple: (:class:`~nipyapi.nifi.models.ParameterProviderApplyParametersRequestEntity`, status_code, headers) - Response data with HTTP details. """ - all_params = ['provider_id', 'body'] - all_params.append('callback') + all_params = ['body', 'provider_id'] all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -1433,14 +1326,15 @@ def submit_apply_parameters_with_http_info(self, provider_id, body, **kwargs): ) params[key] = val del params['kwargs'] - # verify the required parameter 'provider_id' is set - if ('provider_id' not in params) or (params['provider_id'] is None): - raise ValueError("Missing the required parameter `provider_id` when calling `submit_apply_parameters`") # verify the required parameter 'body' is set if ('body' not in params) or (params['body'] is None): raise ValueError("Missing the required parameter `body` when calling `submit_apply_parameters`") + # verify the required parameter 'provider_id' is set + if ('provider_id' not in params) or (params['provider_id'] is None): + raise ValueError("Missing the required parameter `provider_id` when calling `submit_apply_parameters`") - + + collection_formats = {} path_params = {} @@ -1466,7 +1360,7 @@ def submit_apply_parameters_with_http_info(self, provider_id, body, **kwargs): select_header_content_type(['application/json']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/parameter-providers/{providerId}/apply-parameters-requests', 'POST', path_params, @@ -1477,62 +1371,60 @@ def submit_apply_parameters_with_http_info(self, provider_id, body, **kwargs): files=local_var_files, response_type='ParameterProviderApplyParametersRequestEntity', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def submit_config_verification_request(self, id, body, **kwargs): + def submit_config_verification_request1(self, body, id, **kwargs): """ - Performs verification of the Parameter Provider's configuration + Performs verification of the Parameter Provider's configuration. + 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}. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.submit_config_verification_request(id, body, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The parameter provider id. (required) - :param VerifyConfigRequestEntity body: The parameter provider configuration verification request. (required) - :return: VerifyConfigRequestEntity - If the method is called asynchronously, - returns the request thread. + + 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_config_verification_request1_with_http_info()`` method instead. + + Args: + body (:class:`~nipyapi.nifi.models.VerifyConfigRequestEntity`): + The parameter provider configuration verification request. (required) + id (str): + The parameter provider id. (required) + + Returns: + :class:`~nipyapi.nifi.models.VerifyConfigRequestEntity`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.submit_config_verification_request_with_http_info(id, body, **kwargs) + return self.submit_config_verification_request1_with_http_info(body, id, **kwargs) else: - (data) = self.submit_config_verification_request_with_http_info(id, body, **kwargs) + (data) = self.submit_config_verification_request1_with_http_info(body, id, **kwargs) return data - def submit_config_verification_request_with_http_info(self, id, body, **kwargs): + def submit_config_verification_request1_with_http_info(self, body, id, **kwargs): """ - Performs verification of the Parameter Provider's configuration + Performs verification of the Parameter Provider's configuration. + 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}. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.submit_config_verification_request_with_http_info(id, body, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The parameter provider id. (required) - :param VerifyConfigRequestEntity body: The parameter provider configuration verification request. (required) - :return: VerifyConfigRequestEntity - If the method is called asynchronously, - returns the request thread. + + 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_config_verification_request1()`` method instead. + + Args: + body (:class:`~nipyapi.nifi.models.VerifyConfigRequestEntity`): + The parameter provider configuration verification request. (required) + id (str): + The parameter provider id. (required) + + Returns: + tuple: (:class:`~nipyapi.nifi.models.VerifyConfigRequestEntity`, status_code, headers) - Response data with HTTP details. """ - all_params = ['id', 'body'] - all_params.append('callback') + all_params = ['body', 'id'] all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -1542,18 +1434,19 @@ def submit_config_verification_request_with_http_info(self, id, body, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method submit_config_verification_request" % key + " to method submit_config_verification_request1" % 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_config_verification_request`") # verify the required parameter 'body' is set if ('body' not in params) or (params['body'] is None): - raise ValueError("Missing the required parameter `body` when calling `submit_config_verification_request`") - + raise ValueError("Missing the required parameter `body` when calling `submit_config_verification_request1`") + # 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_config_verification_request1`") + + collection_formats = {} path_params = {} @@ -1579,7 +1472,7 @@ def submit_config_verification_request_with_http_info(self, id, body, **kwargs): select_header_content_type(['application/json']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/parameter-providers/{id}/config/verification-requests', 'POST', path_params, @@ -1590,62 +1483,54 @@ def submit_config_verification_request_with_http_info(self, id, body, **kwargs): files=local_var_files, response_type='VerifyConfigRequestEntity', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def update_parameter_provider(self, id, body, **kwargs): + def update_parameter_provider(self, body, id, **kwargs): """ - Updates a parameter provider + Updates a parameter provider. + 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 + ``update_parameter_provider_with_http_info()`` method instead. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.update_parameter_provider(id, body, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The parameter provider id. (required) - :param ParameterProviderEntity body: The parameter provider configuration details. (required) - :return: ParameterProviderEntity - If the method is called asynchronously, - returns the request thread. + Args: + body (:class:`~nipyapi.nifi.models.ParameterProviderEntity`): + The parameter provider configuration details. (required) + id (str): + The parameter provider id. (required) + + Returns: + :class:`~nipyapi.nifi.models.ParameterProviderEntity`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.update_parameter_provider_with_http_info(id, body, **kwargs) + return self.update_parameter_provider_with_http_info(body, id, **kwargs) else: - (data) = self.update_parameter_provider_with_http_info(id, body, **kwargs) + (data) = self.update_parameter_provider_with_http_info(body, id, **kwargs) return data - def update_parameter_provider_with_http_info(self, id, body, **kwargs): + def update_parameter_provider_with_http_info(self, body, id, **kwargs): """ - Updates a parameter provider + Updates a parameter provider. + This method makes a synchronous HTTP request and returns detailed response information. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.update_parameter_provider_with_http_info(id, body, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The parameter provider id. (required) - :param ParameterProviderEntity body: The parameter provider configuration details. (required) - :return: ParameterProviderEntity - If the method is called asynchronously, - returns the request thread. + Returns the response data along with HTTP status code, headers, and other metadata. + For just the response data, use the corresponding ``update_parameter_provider()`` method instead. + + Args: + body (:class:`~nipyapi.nifi.models.ParameterProviderEntity`): + The parameter provider configuration details. (required) + id (str): + The parameter provider id. (required) + + Returns: + tuple: (:class:`~nipyapi.nifi.models.ParameterProviderEntity`, status_code, headers) - Response data with HTTP details. """ - all_params = ['id', 'body'] - all_params.append('callback') + all_params = ['body', 'id'] all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -1659,14 +1544,15 @@ def update_parameter_provider_with_http_info(self, id, body, **kwargs): ) params[key] = val del params['kwargs'] - # verify the required parameter 'id' is set - if ('id' not in params) or (params['id'] is None): - raise ValueError("Missing the required parameter `id` when calling `update_parameter_provider`") # verify the required parameter 'body' is set if ('body' not in params) or (params['body'] is None): raise ValueError("Missing the required parameter `body` when calling `update_parameter_provider`") + # verify the required parameter 'id' is set + if ('id' not in params) or (params['id'] is None): + raise ValueError("Missing the required parameter `id` when calling `update_parameter_provider`") - + + collection_formats = {} path_params = {} @@ -1692,7 +1578,7 @@ def update_parameter_provider_with_http_info(self, id, body, **kwargs): select_header_content_type(['application/json']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/parameter-providers/{id}', 'PUT', path_params, @@ -1703,7 +1589,6 @@ def update_parameter_provider_with_http_info(self, id, body, **kwargs): files=local_var_files, response_type='ParameterProviderEntity', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), diff --git a/nipyapi/nifi/apis/policies_api.py b/nipyapi/nifi/apis/policies_api.py index cc98bf9a..575d214c 100644 --- a/nipyapi/nifi/apis/policies_api.py +++ b/nipyapi/nifi/apis/policies_api.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - import sys import os import re @@ -35,22 +34,18 @@ def __init__(self, api_client=None): def create_access_policy(self, body, **kwargs): """ - Creates an access policy + Creates an access policy. + 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_access_policy_with_http_info()`` method instead. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.create_access_policy(body, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param AccessPolicyEntity body: The access policy configuration details. (required) - :return: AccessPolicyEntity - If the method is called asynchronously, - returns the request thread. + Args: + body (:class:`~nipyapi.nifi.models.AccessPolicyEntity`): + The access policy configuration details. (required) + + Returns: + :class:`~nipyapi.nifi.models.AccessPolicyEntity`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): @@ -61,26 +56,21 @@ def create_access_policy(self, body, **kwargs): def create_access_policy_with_http_info(self, body, **kwargs): """ - Creates an access policy + Creates an access policy. + 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_access_policy()`` method instead. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.create_access_policy_with_http_info(body, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param AccessPolicyEntity body: The access policy configuration details. (required) - :return: AccessPolicyEntity - If the method is called asynchronously, - returns the request thread. + Args: + body (:class:`~nipyapi.nifi.models.AccessPolicyEntity`): + The access policy configuration details. (required) + + Returns: + tuple: (:class:`~nipyapi.nifi.models.AccessPolicyEntity`, status_code, headers) - Response data with HTTP details. """ all_params = ['body'] - all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -98,7 +88,7 @@ def create_access_policy_with_http_info(self, body, **kwargs): if ('body' not in params) or (params['body'] is None): raise ValueError("Missing the required parameter `body` when calling `create_access_policy`") - + collection_formats = {} path_params = {} @@ -122,7 +112,7 @@ def create_access_policy_with_http_info(self, body, **kwargs): select_header_content_type(['application/json']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/policies', 'POST', path_params, @@ -133,7 +123,6 @@ def create_access_policy_with_http_info(self, body, **kwargs): files=local_var_files, response_type='AccessPolicyEntity', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), @@ -141,22 +130,18 @@ def create_access_policy_with_http_info(self, body, **kwargs): def get_access_policy(self, id, **kwargs): """ - Gets an access policy + Gets an access policy. + 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_access_policy_with_http_info()`` method instead. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_access_policy(id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The access policy id. (required) - :return: AccessPolicyEntity - If the method is called asynchronously, - returns the request thread. + Args: + id (str): + The access policy id. (required) + + Returns: + :class:`~nipyapi.nifi.models.AccessPolicyEntity`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): @@ -167,26 +152,21 @@ def get_access_policy(self, id, **kwargs): def get_access_policy_with_http_info(self, id, **kwargs): """ - Gets an access policy + Gets an access policy. + This method makes a synchronous HTTP request and returns detailed response information. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_access_policy_with_http_info(id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The access policy id. (required) - :return: AccessPolicyEntity - If the method is called asynchronously, - returns the request thread. + Returns the response data along with HTTP status code, headers, and other metadata. + For just the response data, use the corresponding ``get_access_policy()`` method instead. + + Args: + id (str): + The access policy id. (required) + + Returns: + tuple: (:class:`~nipyapi.nifi.models.AccessPolicyEntity`, status_code, headers) - Response data with HTTP details. """ all_params = ['id'] - all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -204,7 +184,7 @@ def get_access_policy_with_http_info(self, id, **kwargs): if ('id' not in params) or (params['id'] is None): raise ValueError("Missing the required parameter `id` when calling `get_access_policy`") - + collection_formats = {} path_params = {} @@ -223,12 +203,8 @@ def get_access_policy_with_http_info(self, id, **kwargs): header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['*/*']) - # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/policies/{id}', 'GET', path_params, @@ -239,7 +215,6 @@ def get_access_policy_with_http_info(self, id, **kwargs): files=local_var_files, response_type='AccessPolicyEntity', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), @@ -247,23 +222,23 @@ def get_access_policy_with_http_info(self, id, **kwargs): def get_access_policy_for_resource(self, action, resource, **kwargs): """ - Gets an access policy for the specified action and resource + Gets an access policy for the specified action and resource. + Will return the effective policy if no component specific policy exists for the specified action and resource. Must have Read permissions to the policy with the desired action and resource. Permissions for the policy that is returned will be indicated in the response. This means the client could be authorized to get the policy for a given component but the effective policy may be inherited from an ancestor Process Group. If the client does not have permissions to that policy, the response will not include the policy and the permissions in the response will be marked accordingly. If the client does not have permissions to the policy of the desired action and resource a 403 response will be returned. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_access_policy_for_resource(action, resource, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str action: The request action. (required) - :param str resource: The resource of the policy. (required) - :return: AccessPolicyEntity - If the method is called asynchronously, - returns the request thread. + + 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_access_policy_for_resource_with_http_info()`` method instead. + + Args: + action (str): + The request action. (required) + resource (str): + The resource of the policy. (required) + + Returns: + :class:`~nipyapi.nifi.models.AccessPolicyEntity`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): @@ -274,27 +249,26 @@ def get_access_policy_for_resource(self, action, resource, **kwargs): def get_access_policy_for_resource_with_http_info(self, action, resource, **kwargs): """ - Gets an access policy for the specified action and resource + Gets an access policy for the specified action and resource. + Will return the effective policy if no component specific policy exists for the specified action and resource. Must have Read permissions to the policy with the desired action and resource. Permissions for the policy that is returned will be indicated in the response. This means the client could be authorized to get the policy for a given component but the effective policy may be inherited from an ancestor Process Group. If the client does not have permissions to that policy, the response will not include the policy and the permissions in the response will be marked accordingly. If the client does not have permissions to the policy of the desired action and resource a 403 response will be returned. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_access_policy_for_resource_with_http_info(action, resource, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str action: The request action. (required) - :param str resource: The resource of the policy. (required) - :return: AccessPolicyEntity - If the method is called asynchronously, - returns the request thread. + + 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_access_policy_for_resource()`` method instead. + + Args: + action (str): + The request action. (required) + resource (str): + The resource of the policy. (required) + + Returns: + tuple: (:class:`~nipyapi.nifi.models.AccessPolicyEntity`, status_code, headers) - Response data with HTTP details. """ all_params = ['action', 'resource'] - all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -315,9 +289,8 @@ def get_access_policy_for_resource_with_http_info(self, action, resource, **kwar if ('resource' not in params) or (params['resource'] is None): raise ValueError("Missing the required parameter `resource` when calling `get_access_policy_for_resource`") - if 'resource' in params and not re.search('.+', params['resource']): - raise ValueError("Invalid value for parameter `resource` when calling `get_access_policy_for_resource`, must conform to the pattern `/.+/`") - + + collection_formats = {} path_params = {} @@ -338,12 +311,8 @@ def get_access_policy_for_resource_with_http_info(self, action, resource, **kwar header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['*/*']) - # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/policies/{action}/{resource}', 'GET', path_params, @@ -354,7 +323,6 @@ def get_access_policy_for_resource_with_http_info(self, action, resource, **kwar files=local_var_files, response_type='AccessPolicyEntity', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), @@ -362,25 +330,24 @@ def get_access_policy_for_resource_with_http_info(self, action, resource, **kwar def remove_access_policy(self, id, **kwargs): """ - Deletes an access policy + Deletes an access policy. + This method makes a synchronous HTTP request and returns the response data directly. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.remove_access_policy(id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The access policy id. (required) - :param str version: The revision is used to verify the client is working with the latest version of the flow. - :param str client_id: If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response. - :param bool disconnected_node_acknowledged: Acknowledges that this node is disconnected to allow for mutable requests to proceed. - :return: AccessPolicyEntity - If the method is called asynchronously, - returns the request thread. + For full HTTP response details (status code, headers, etc.), use the corresponding + ``remove_access_policy_with_http_info()`` method instead. + + Args: + id (str): + The access policy 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.AccessPolicyEntity`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): @@ -391,29 +358,27 @@ def remove_access_policy(self, id, **kwargs): def remove_access_policy_with_http_info(self, id, **kwargs): """ - Deletes an access policy + Deletes an access policy. + 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 ``remove_access_policy()`` method instead. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.remove_access_policy_with_http_info(id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The access policy id. (required) - :param str version: The revision is used to verify the client is working with the latest version of the flow. - :param str client_id: If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response. - :param bool disconnected_node_acknowledged: Acknowledges that this node is disconnected to allow for mutable requests to proceed. - :return: AccessPolicyEntity - If the method is called asynchronously, - returns the request thread. + Args: + id (str): + The access policy 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.AccessPolicyEntity`, status_code, headers) - Response data with HTTP details. """ all_params = ['id', 'version', 'client_id', 'disconnected_node_acknowledged'] - all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -431,7 +396,10 @@ def remove_access_policy_with_http_info(self, id, **kwargs): if ('id' not in params) or (params['id'] is None): raise ValueError("Missing the required parameter `id` when calling `remove_access_policy`") - + + + + collection_formats = {} path_params = {} @@ -456,12 +424,8 @@ def remove_access_policy_with_http_info(self, id, **kwargs): header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['*/*']) - # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/policies/{id}', 'DELETE', path_params, @@ -472,62 +436,54 @@ def remove_access_policy_with_http_info(self, id, **kwargs): files=local_var_files, response_type='AccessPolicyEntity', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def update_access_policy(self, id, body, **kwargs): + def update_access_policy(self, body, id, **kwargs): """ - Updates a access policy + Updates a access policy. + This method makes a synchronous HTTP request and returns the response data directly. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.update_access_policy(id, body, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The access policy id. (required) - :param AccessPolicyEntity body: The access policy configuration details. (required) - :return: AccessPolicyEntity - If the method is called asynchronously, - returns the request thread. + For full HTTP response details (status code, headers, etc.), use the corresponding + ``update_access_policy_with_http_info()`` method instead. + + Args: + body (:class:`~nipyapi.nifi.models.AccessPolicyEntity`): + The access policy configuration details. (required) + id (str): + The access policy id. (required) + + Returns: + :class:`~nipyapi.nifi.models.AccessPolicyEntity`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.update_access_policy_with_http_info(id, body, **kwargs) + return self.update_access_policy_with_http_info(body, id, **kwargs) else: - (data) = self.update_access_policy_with_http_info(id, body, **kwargs) + (data) = self.update_access_policy_with_http_info(body, id, **kwargs) return data - def update_access_policy_with_http_info(self, id, body, **kwargs): + def update_access_policy_with_http_info(self, body, id, **kwargs): """ - Updates a access policy + Updates a access policy. + 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 ``update_access_policy()`` method instead. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.update_access_policy_with_http_info(id, body, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The access policy id. (required) - :param AccessPolicyEntity body: The access policy configuration details. (required) - :return: AccessPolicyEntity - If the method is called asynchronously, - returns the request thread. + Args: + body (:class:`~nipyapi.nifi.models.AccessPolicyEntity`): + The access policy configuration details. (required) + id (str): + The access policy id. (required) + + Returns: + tuple: (:class:`~nipyapi.nifi.models.AccessPolicyEntity`, status_code, headers) - Response data with HTTP details. """ - all_params = ['id', 'body'] - all_params.append('callback') + all_params = ['body', 'id'] all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -541,14 +497,15 @@ def update_access_policy_with_http_info(self, id, body, **kwargs): ) params[key] = val del params['kwargs'] - # verify the required parameter 'id' is set - if ('id' not in params) or (params['id'] is None): - raise ValueError("Missing the required parameter `id` when calling `update_access_policy`") # verify the required parameter 'body' is set if ('body' not in params) or (params['body'] is None): raise ValueError("Missing the required parameter `body` when calling `update_access_policy`") + # verify the required parameter 'id' is set + if ('id' not in params) or (params['id'] is None): + raise ValueError("Missing the required parameter `id` when calling `update_access_policy`") - + + collection_formats = {} path_params = {} @@ -574,7 +531,7 @@ def update_access_policy_with_http_info(self, id, body, **kwargs): select_header_content_type(['application/json']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/policies/{id}', 'PUT', path_params, @@ -585,7 +542,6 @@ def update_access_policy_with_http_info(self, id, body, **kwargs): files=local_var_files, response_type='AccessPolicyEntity', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), diff --git a/nipyapi/nifi/apis/process_groups_api.py b/nipyapi/nifi/apis/process_groups_api.py index e6a62893..e1aab21a 100644 --- a/nipyapi/nifi/apis/process_groups_api.py +++ b/nipyapi/nifi/apis/process_groups_api.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - import sys import os import re @@ -33,56 +32,49 @@ def __init__(self, api_client=None): config.api_client = ApiClient() self.api_client = config.api_client - def copy_snippet(self, id, body, **kwargs): + def copy(self, body, id, **kwargs): """ - Copies a snippet and discards it. + Generates a copy response for the given copy request. + This method makes a synchronous HTTP request and returns the response data directly. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.copy_snippet(id, body, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The process group id. (required) - :param CopySnippetRequestEntity body: The copy snippet request. (required) - :return: FlowEntity - If the method is called asynchronously, - returns the request thread. + For full HTTP response details (status code, headers, etc.), use the corresponding + ``copy_with_http_info()`` method instead. + + Args: + body (:class:`~nipyapi.nifi.models.CopyRequestEntity`): + The request including the components to be copied from the specified Process Group. (required) + id (str): + The process group id. (required) + + Returns: + :class:`~nipyapi.nifi.models.CopyResponseEntity`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.copy_snippet_with_http_info(id, body, **kwargs) + return self.copy_with_http_info(body, id, **kwargs) else: - (data) = self.copy_snippet_with_http_info(id, body, **kwargs) + (data) = self.copy_with_http_info(body, id, **kwargs) return data - def copy_snippet_with_http_info(self, id, body, **kwargs): + def copy_with_http_info(self, body, id, **kwargs): """ - Copies a snippet and discards it. + Generates a copy response for the given copy request. + This method makes a synchronous HTTP request and returns detailed response information. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.copy_snippet_with_http_info(id, body, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The process group id. (required) - :param CopySnippetRequestEntity body: The copy snippet request. (required) - :return: FlowEntity - If the method is called asynchronously, - returns the request thread. + Returns the response data along with HTTP status code, headers, and other metadata. + For just the response data, use the corresponding ``copy()`` method instead. + + Args: + body (:class:`~nipyapi.nifi.models.CopyRequestEntity`): + The request including the components to be copied from the specified Process Group. (required) + id (str): + The process group id. (required) + + Returns: + tuple: (:class:`~nipyapi.nifi.models.CopyResponseEntity`, status_code, headers) - Response data with HTTP details. """ - all_params = ['id', 'body'] - all_params.append('callback') + all_params = ['body', 'id'] all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -92,18 +84,125 @@ def copy_snippet_with_http_info(self, id, body, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method copy_snippet" % key + " to method copy" % 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 `copy`") # 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 `copy_snippet`") + raise ValueError("Missing the required parameter `id` when calling `copy`") + + + + 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('/process-groups/{id}/copy', 'POST', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='CopyResponseEntity', + 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 copy_snippet(self, body, id, **kwargs): + """ + Copies a snippet and discards it.. + 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 + ``copy_snippet_with_http_info()`` method instead. + + Args: + body (:class:`~nipyapi.nifi.models.CopySnippetRequestEntity`): + The copy snippet request. (required) + id (str): + The process group id. (required) + + Returns: + :class:`~nipyapi.nifi.models.FlowEntity`: The response data. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('callback'): + return self.copy_snippet_with_http_info(body, id, **kwargs) + else: + (data) = self.copy_snippet_with_http_info(body, id, **kwargs) + return data + + def copy_snippet_with_http_info(self, body, id, **kwargs): + """ + Copies a snippet and discards it.. + 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 ``copy_snippet()`` method instead. + + Args: + body (:class:`~nipyapi.nifi.models.CopySnippetRequestEntity`): + The copy snippet request. (required) + id (str): + The process group id. (required) + + Returns: + tuple: (:class:`~nipyapi.nifi.models.FlowEntity`, 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 copy_snippet" % 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 `copy_snippet`") + # 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 `copy_snippet`") - + + collection_formats = {} path_params = {} @@ -129,7 +228,7 @@ def copy_snippet_with_http_info(self, id, body, **kwargs): select_header_content_type(['application/json']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/process-groups/{id}/snippet-instance', 'POST', path_params, @@ -140,62 +239,54 @@ def copy_snippet_with_http_info(self, id, body, **kwargs): files=local_var_files, response_type='FlowEntity', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def create_connection(self, id, body, **kwargs): + def create_connection(self, body, id, **kwargs): """ - Creates a connection + Creates a connection. + This method makes a synchronous HTTP request and returns the response data directly. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.create_connection(id, body, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The process group id. (required) - :param ConnectionEntity body: The connection configuration details. (required) - :return: ConnectionEntity - If the method is called asynchronously, - returns the request thread. + For full HTTP response details (status code, headers, etc.), use the corresponding + ``create_connection_with_http_info()`` method instead. + + Args: + body (:class:`~nipyapi.nifi.models.ConnectionEntity`): + The connection configuration details. (required) + id (str): + The process group id. (required) + + Returns: + :class:`~nipyapi.nifi.models.ConnectionEntity`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.create_connection_with_http_info(id, body, **kwargs) + return self.create_connection_with_http_info(body, id, **kwargs) else: - (data) = self.create_connection_with_http_info(id, body, **kwargs) + (data) = self.create_connection_with_http_info(body, id, **kwargs) return data - def create_connection_with_http_info(self, id, body, **kwargs): + def create_connection_with_http_info(self, body, id, **kwargs): """ - Creates a connection + Creates a connection. + This method makes a synchronous HTTP request and returns detailed response information. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.create_connection_with_http_info(id, body, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The process group id. (required) - :param ConnectionEntity body: The connection configuration details. (required) - :return: ConnectionEntity - If the method is called asynchronously, - returns the request thread. + Returns the response data along with HTTP status code, headers, and other metadata. + For just the response data, use the corresponding ``create_connection()`` method instead. + + Args: + body (:class:`~nipyapi.nifi.models.ConnectionEntity`): + The connection configuration details. (required) + id (str): + The process group id. (required) + + Returns: + tuple: (:class:`~nipyapi.nifi.models.ConnectionEntity`, status_code, headers) - Response data with HTTP details. """ - all_params = ['id', 'body'] - all_params.append('callback') + all_params = ['body', 'id'] all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -209,14 +300,15 @@ def create_connection_with_http_info(self, id, body, **kwargs): ) 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_connection`") # 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_connection`") + # 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_connection`") - + + collection_formats = {} path_params = {} @@ -242,7 +334,7 @@ def create_connection_with_http_info(self, id, body, **kwargs): select_header_content_type(['application/json']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/process-groups/{id}/connections', 'POST', path_params, @@ -253,62 +345,54 @@ def create_connection_with_http_info(self, id, body, **kwargs): files=local_var_files, response_type='ConnectionEntity', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def create_controller_service(self, id, body, **kwargs): + def create_controller_service1(self, body, id, **kwargs): """ - Creates a new controller service + Creates a new controller service. + This method makes a synchronous HTTP request and returns the response data directly. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.create_controller_service(id, body, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The process group id. (required) - :param ControllerServiceEntity body: The controller service configuration details. (required) - :return: ControllerServiceEntity - If the method is called asynchronously, - returns the request thread. + For full HTTP response details (status code, headers, etc.), use the corresponding + ``create_controller_service1_with_http_info()`` method instead. + + Args: + body (:class:`~nipyapi.nifi.models.ControllerServiceEntity`): + The controller service configuration details. (required) + id (str): + The process group id. (required) + + Returns: + :class:`~nipyapi.nifi.models.ControllerServiceEntity`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.create_controller_service_with_http_info(id, body, **kwargs) + return self.create_controller_service1_with_http_info(body, id, **kwargs) else: - (data) = self.create_controller_service_with_http_info(id, body, **kwargs) + (data) = self.create_controller_service1_with_http_info(body, id, **kwargs) return data - def create_controller_service_with_http_info(self, id, body, **kwargs): + def create_controller_service1_with_http_info(self, body, id, **kwargs): """ - Creates a new controller service + Creates a new controller service. + This method makes a synchronous HTTP request and returns detailed response information. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.create_controller_service_with_http_info(id, body, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The process group id. (required) - :param ControllerServiceEntity body: The controller service configuration details. (required) - :return: ControllerServiceEntity - If the method is called asynchronously, - returns the request thread. + Returns the response data along with HTTP status code, headers, and other metadata. + For just the response data, use the corresponding ``create_controller_service1()`` method instead. + + Args: + body (:class:`~nipyapi.nifi.models.ControllerServiceEntity`): + The controller service configuration details. (required) + id (str): + The process group id. (required) + + Returns: + tuple: (:class:`~nipyapi.nifi.models.ControllerServiceEntity`, status_code, headers) - Response data with HTTP details. """ - all_params = ['id', 'body'] - all_params.append('callback') + all_params = ['body', 'id'] all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -318,18 +402,19 @@ def create_controller_service_with_http_info(self, id, body, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method create_controller_service" % key + " to method create_controller_service1" % 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_controller_service`") # 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_controller_service`") - + raise ValueError("Missing the required parameter `body` when calling `create_controller_service1`") + # 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_controller_service1`") + + collection_formats = {} path_params = {} @@ -355,7 +440,7 @@ def create_controller_service_with_http_info(self, id, body, **kwargs): select_header_content_type(['application/json']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/process-groups/{id}/controller-services', 'POST', path_params, @@ -366,7 +451,6 @@ def create_controller_service_with_http_info(self, id, body, **kwargs): files=local_var_files, response_type='ControllerServiceEntity', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), @@ -374,22 +458,18 @@ def create_controller_service_with_http_info(self, id, body, **kwargs): def create_empty_all_connections_request(self, id, **kwargs): """ - Creates a request to drop all flowfiles of all connection queues in this process group. + Creates a request to drop all flowfiles of all connection queues in this process group.. + This method makes a synchronous HTTP request and returns the response data directly. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.create_empty_all_connections_request(id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The process group id. (required) - :return: DropRequestEntity - If the method is called asynchronously, - returns the request thread. + For full HTTP response details (status code, headers, etc.), use the corresponding + ``create_empty_all_connections_request_with_http_info()`` method instead. + + Args: + id (str): + The process group id. (required) + + Returns: + :class:`~nipyapi.nifi.models.DropRequestEntity`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): @@ -400,26 +480,21 @@ def create_empty_all_connections_request(self, id, **kwargs): def create_empty_all_connections_request_with_http_info(self, id, **kwargs): """ - Creates a request to drop all flowfiles of all connection queues in this process group. + Creates a request to drop all flowfiles of all connection queues in this process group.. + This method makes a synchronous HTTP request and returns detailed response information. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.create_empty_all_connections_request_with_http_info(id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The process group id. (required) - :return: DropRequestEntity - If the method is called asynchronously, - returns the request thread. + Returns the response data along with HTTP status code, headers, and other metadata. + For just the response data, use the corresponding ``create_empty_all_connections_request()`` method instead. + + Args: + id (str): + The process group id. (required) + + Returns: + tuple: (:class:`~nipyapi.nifi.models.DropRequestEntity`, status_code, headers) - Response data with HTTP details. """ all_params = ['id'] - all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -437,7 +512,7 @@ def create_empty_all_connections_request_with_http_info(self, id, **kwargs): if ('id' not in params) or (params['id'] is None): raise ValueError("Missing the required parameter `id` when calling `create_empty_all_connections_request`") - + collection_formats = {} path_params = {} @@ -456,12 +531,8 @@ def create_empty_all_connections_request_with_http_info(self, id, **kwargs): header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['*/*']) - # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/process-groups/{id}/empty-all-connections-requests', 'POST', path_params, @@ -472,62 +543,54 @@ def create_empty_all_connections_request_with_http_info(self, id, **kwargs): files=local_var_files, response_type='DropRequestEntity', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def create_funnel(self, id, body, **kwargs): + def create_funnel(self, body, id, **kwargs): """ - Creates a funnel + Creates a funnel. + This method makes a synchronous HTTP request and returns the response data directly. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.create_funnel(id, body, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The process group id. (required) - :param FunnelEntity body: The funnel configuration details. (required) - :return: FunnelEntity - If the method is called asynchronously, - returns the request thread. + For full HTTP response details (status code, headers, etc.), use the corresponding + ``create_funnel_with_http_info()`` method instead. + + Args: + body (:class:`~nipyapi.nifi.models.FunnelEntity`): + The funnel configuration details. (required) + id (str): + The process group id. (required) + + Returns: + :class:`~nipyapi.nifi.models.FunnelEntity`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.create_funnel_with_http_info(id, body, **kwargs) + return self.create_funnel_with_http_info(body, id, **kwargs) else: - (data) = self.create_funnel_with_http_info(id, body, **kwargs) + (data) = self.create_funnel_with_http_info(body, id, **kwargs) return data - def create_funnel_with_http_info(self, id, body, **kwargs): + def create_funnel_with_http_info(self, body, id, **kwargs): """ - Creates a funnel + Creates a funnel. + This method makes a synchronous HTTP request and returns detailed response information. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.create_funnel_with_http_info(id, body, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The process group id. (required) - :param FunnelEntity body: The funnel configuration details. (required) - :return: FunnelEntity - If the method is called asynchronously, - returns the request thread. + Returns the response data along with HTTP status code, headers, and other metadata. + For just the response data, use the corresponding ``create_funnel()`` method instead. + + Args: + body (:class:`~nipyapi.nifi.models.FunnelEntity`): + The funnel configuration details. (required) + id (str): + The process group id. (required) + + Returns: + tuple: (:class:`~nipyapi.nifi.models.FunnelEntity`, status_code, headers) - Response data with HTTP details. """ - all_params = ['id', 'body'] - all_params.append('callback') + all_params = ['body', 'id'] all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -541,14 +604,15 @@ def create_funnel_with_http_info(self, id, body, **kwargs): ) 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_funnel`") # 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_funnel`") + # 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_funnel`") - + + collection_formats = {} path_params = {} @@ -574,7 +638,7 @@ def create_funnel_with_http_info(self, id, body, **kwargs): select_header_content_type(['application/json']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/process-groups/{id}/funnels', 'POST', path_params, @@ -585,62 +649,54 @@ def create_funnel_with_http_info(self, id, body, **kwargs): files=local_var_files, response_type='FunnelEntity', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def create_input_port(self, id, body, **kwargs): + def create_input_port(self, body, id, **kwargs): """ - Creates an input port + Creates an input port. + This method makes a synchronous HTTP request and returns the response data directly. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.create_input_port(id, body, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The process group id. (required) - :param PortEntity body: The input port configuration details. (required) - :return: PortEntity - If the method is called asynchronously, - returns the request thread. + For full HTTP response details (status code, headers, etc.), use the corresponding + ``create_input_port_with_http_info()`` method instead. + + Args: + body (:class:`~nipyapi.nifi.models.PortEntity`): + The input port configuration details. (required) + id (str): + The process group id. (required) + + Returns: + :class:`~nipyapi.nifi.models.PortEntity`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.create_input_port_with_http_info(id, body, **kwargs) + return self.create_input_port_with_http_info(body, id, **kwargs) else: - (data) = self.create_input_port_with_http_info(id, body, **kwargs) + (data) = self.create_input_port_with_http_info(body, id, **kwargs) return data - def create_input_port_with_http_info(self, id, body, **kwargs): + def create_input_port_with_http_info(self, body, id, **kwargs): """ - Creates an input port + Creates an input port. + This method makes a synchronous HTTP request and returns detailed response information. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.create_input_port_with_http_info(id, body, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The process group id. (required) - :param PortEntity body: The input port configuration details. (required) - :return: PortEntity - If the method is called asynchronously, - returns the request thread. + Returns the response data along with HTTP status code, headers, and other metadata. + For just the response data, use the corresponding ``create_input_port()`` method instead. + + Args: + body (:class:`~nipyapi.nifi.models.PortEntity`): + The input port configuration details. (required) + id (str): + The process group id. (required) + + Returns: + tuple: (:class:`~nipyapi.nifi.models.PortEntity`, status_code, headers) - Response data with HTTP details. """ - all_params = ['id', 'body'] - all_params.append('callback') + all_params = ['body', 'id'] all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -654,14 +710,15 @@ def create_input_port_with_http_info(self, id, body, **kwargs): ) 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_input_port`") # 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_input_port`") + # 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_input_port`") - + + collection_formats = {} path_params = {} @@ -687,7 +744,7 @@ def create_input_port_with_http_info(self, id, body, **kwargs): select_header_content_type(['application/json']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/process-groups/{id}/input-ports', 'POST', path_params, @@ -698,62 +755,54 @@ def create_input_port_with_http_info(self, id, body, **kwargs): files=local_var_files, response_type='PortEntity', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def create_label(self, id, body, **kwargs): + def create_label(self, body, id, **kwargs): """ - Creates a label + Creates a label. + This method makes a synchronous HTTP request and returns the response data directly. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.create_label(id, body, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The process group id. (required) - :param LabelEntity body: The label configuration details. (required) - :return: LabelEntity - If the method is called asynchronously, - returns the request thread. + For full HTTP response details (status code, headers, etc.), use the corresponding + ``create_label_with_http_info()`` method instead. + + Args: + body (:class:`~nipyapi.nifi.models.LabelEntity`): + The label configuration details. (required) + id (str): + The process group id. (required) + + Returns: + :class:`~nipyapi.nifi.models.LabelEntity`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.create_label_with_http_info(id, body, **kwargs) + return self.create_label_with_http_info(body, id, **kwargs) else: - (data) = self.create_label_with_http_info(id, body, **kwargs) + (data) = self.create_label_with_http_info(body, id, **kwargs) return data - def create_label_with_http_info(self, id, body, **kwargs): + def create_label_with_http_info(self, body, id, **kwargs): """ - Creates a label + Creates a label. + This method makes a synchronous HTTP request and returns detailed response information. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.create_label_with_http_info(id, body, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The process group id. (required) - :param LabelEntity body: The label configuration details. (required) - :return: LabelEntity - If the method is called asynchronously, - returns the request thread. + Returns the response data along with HTTP status code, headers, and other metadata. + For just the response data, use the corresponding ``create_label()`` method instead. + + Args: + body (:class:`~nipyapi.nifi.models.LabelEntity`): + The label configuration details. (required) + id (str): + The process group id. (required) + + Returns: + tuple: (:class:`~nipyapi.nifi.models.LabelEntity`, status_code, headers) - Response data with HTTP details. """ - all_params = ['id', 'body'] - all_params.append('callback') + all_params = ['body', 'id'] all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -767,14 +816,15 @@ def create_label_with_http_info(self, id, body, **kwargs): ) 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_label`") # 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_label`") + # 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_label`") - + + collection_formats = {} path_params = {} @@ -800,7 +850,7 @@ def create_label_with_http_info(self, id, body, **kwargs): select_header_content_type(['application/json']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/process-groups/{id}/labels', 'POST', path_params, @@ -811,62 +861,54 @@ def create_label_with_http_info(self, id, body, **kwargs): files=local_var_files, response_type='LabelEntity', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def create_output_port(self, id, body, **kwargs): + def create_output_port(self, body, id, **kwargs): """ - Creates an output port + Creates an output port. + This method makes a synchronous HTTP request and returns the response data directly. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.create_output_port(id, body, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The process group id. (required) - :param PortEntity body: The output port configuration. (required) - :return: PortEntity - If the method is called asynchronously, - returns the request thread. + For full HTTP response details (status code, headers, etc.), use the corresponding + ``create_output_port_with_http_info()`` method instead. + + Args: + body (:class:`~nipyapi.nifi.models.PortEntity`): + The output port configuration. (required) + id (str): + The process group id. (required) + + Returns: + :class:`~nipyapi.nifi.models.PortEntity`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.create_output_port_with_http_info(id, body, **kwargs) + return self.create_output_port_with_http_info(body, id, **kwargs) else: - (data) = self.create_output_port_with_http_info(id, body, **kwargs) + (data) = self.create_output_port_with_http_info(body, id, **kwargs) return data - def create_output_port_with_http_info(self, id, body, **kwargs): + def create_output_port_with_http_info(self, body, id, **kwargs): """ - Creates an output port + Creates an output port. + This method makes a synchronous HTTP request and returns detailed response information. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.create_output_port_with_http_info(id, body, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The process group id. (required) - :param PortEntity body: The output port configuration. (required) - :return: PortEntity - If the method is called asynchronously, - returns the request thread. + Returns the response data along with HTTP status code, headers, and other metadata. + For just the response data, use the corresponding ``create_output_port()`` method instead. + + Args: + body (:class:`~nipyapi.nifi.models.PortEntity`): + The output port configuration. (required) + id (str): + The process group id. (required) + + Returns: + tuple: (:class:`~nipyapi.nifi.models.PortEntity`, status_code, headers) - Response data with HTTP details. """ - all_params = ['id', 'body'] - all_params.append('callback') + all_params = ['body', 'id'] all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -880,14 +922,15 @@ def create_output_port_with_http_info(self, id, body, **kwargs): ) 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_output_port`") # 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_output_port`") + # 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_output_port`") - + + collection_formats = {} path_params = {} @@ -913,7 +956,7 @@ def create_output_port_with_http_info(self, id, body, **kwargs): select_header_content_type(['application/json']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/process-groups/{id}/output-ports', 'POST', path_params, @@ -924,64 +967,58 @@ def create_output_port_with_http_info(self, id, body, **kwargs): files=local_var_files, response_type='PortEntity', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def create_process_group(self, id, body, **kwargs): + def create_process_group(self, body, id, **kwargs): """ - Creates a process group + Creates a process group. + This method makes a synchronous HTTP request and returns the response data directly. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.create_process_group(id, body, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The process group id. (required) - :param ProcessGroupEntity body: The process group configuration details. (required) - :param str parameter_context_handling_strategy: Handling Strategy controls whether to keep or replace Parameter Contexts - :return: ProcessGroupEntity - If the method is called asynchronously, - returns the request thread. + For full HTTP response details (status code, headers, etc.), use the corresponding + ``create_process_group_with_http_info()`` method instead. + + Args: + body (:class:`~nipyapi.nifi.models.ProcessGroupEntity`): + The process group configuration details. (required) + id (str): + The process group id. (required) + parameter_context_handling_strategy (str): + Handling Strategy controls whether to keep or replace Parameter Contexts + + Returns: + :class:`~nipyapi.nifi.models.ProcessGroupEntity`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.create_process_group_with_http_info(id, body, **kwargs) + return self.create_process_group_with_http_info(body, id, **kwargs) else: - (data) = self.create_process_group_with_http_info(id, body, **kwargs) + (data) = self.create_process_group_with_http_info(body, id, **kwargs) return data - def create_process_group_with_http_info(self, id, body, **kwargs): + def create_process_group_with_http_info(self, body, id, **kwargs): """ - Creates a process group + Creates a process group. + This method makes a synchronous HTTP request and returns detailed response information. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.create_process_group_with_http_info(id, body, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The process group id. (required) - :param ProcessGroupEntity body: The process group configuration details. (required) - :param str parameter_context_handling_strategy: Handling Strategy controls whether to keep or replace Parameter Contexts - :return: ProcessGroupEntity - If the method is called asynchronously, - returns the request thread. + Returns the response data along with HTTP status code, headers, and other metadata. + For just the response data, use the corresponding ``create_process_group()`` method instead. + + Args: + body (:class:`~nipyapi.nifi.models.ProcessGroupEntity`): + The process group configuration details. (required) + id (str): + The process group id. (required) + parameter_context_handling_strategy (str): + Handling Strategy controls whether to keep or replace Parameter Contexts + + Returns: + tuple: (:class:`~nipyapi.nifi.models.ProcessGroupEntity`, status_code, headers) - Response data with HTTP details. """ - all_params = ['id', 'body', 'parameter_context_handling_strategy'] - all_params.append('callback') + all_params = ['body', 'id', 'parameter_context_handling_strategy'] all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -995,14 +1032,16 @@ def create_process_group_with_http_info(self, id, body, **kwargs): ) 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_process_group`") # verify the required parameter 'body' is set if ('body' not in params) or (params['body'] is None): raise ValueError("Missing the required parameter `body` when calling `create_process_group`") + # 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_process_group`") - + + + collection_formats = {} path_params = {} @@ -1030,7 +1069,7 @@ def create_process_group_with_http_info(self, id, body, **kwargs): select_header_content_type(['application/json']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/process-groups/{id}/process-groups', 'POST', path_params, @@ -1041,62 +1080,54 @@ def create_process_group_with_http_info(self, id, body, **kwargs): files=local_var_files, response_type='ProcessGroupEntity', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def create_processor(self, id, body, **kwargs): + def create_processor(self, body, id, **kwargs): """ - Creates a new processor + Creates a new processor. + This method makes a synchronous HTTP request and returns the response data directly. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.create_processor(id, body, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The process group id. (required) - :param ProcessorEntity body: The processor configuration details. (required) - :return: ProcessorEntity - If the method is called asynchronously, - returns the request thread. + For full HTTP response details (status code, headers, etc.), use the corresponding + ``create_processor_with_http_info()`` method instead. + + Args: + body (:class:`~nipyapi.nifi.models.ProcessorEntity`): + The processor configuration details. (required) + id (str): + The process group id. (required) + + Returns: + :class:`~nipyapi.nifi.models.ProcessorEntity`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.create_processor_with_http_info(id, body, **kwargs) + return self.create_processor_with_http_info(body, id, **kwargs) else: - (data) = self.create_processor_with_http_info(id, body, **kwargs) + (data) = self.create_processor_with_http_info(body, id, **kwargs) return data - def create_processor_with_http_info(self, id, body, **kwargs): + def create_processor_with_http_info(self, body, id, **kwargs): """ - Creates a new processor + Creates a new processor. + This method makes a synchronous HTTP request and returns detailed response information. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.create_processor_with_http_info(id, body, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The process group id. (required) - :param ProcessorEntity body: The processor configuration details. (required) - :return: ProcessorEntity - If the method is called asynchronously, - returns the request thread. + Returns the response data along with HTTP status code, headers, and other metadata. + For just the response data, use the corresponding ``create_processor()`` method instead. + + Args: + body (:class:`~nipyapi.nifi.models.ProcessorEntity`): + The processor configuration details. (required) + id (str): + The process group id. (required) + + Returns: + tuple: (:class:`~nipyapi.nifi.models.ProcessorEntity`, status_code, headers) - Response data with HTTP details. """ - all_params = ['id', 'body'] - all_params.append('callback') + all_params = ['body', 'id'] all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -1110,14 +1141,15 @@ def create_processor_with_http_info(self, id, body, **kwargs): ) 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_processor`") # 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_processor`") + # 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_processor`") - + + collection_formats = {} path_params = {} @@ -1143,7 +1175,7 @@ def create_processor_with_http_info(self, id, body, **kwargs): select_header_content_type(['application/json']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/process-groups/{id}/processors', 'POST', path_params, @@ -1154,62 +1186,54 @@ def create_processor_with_http_info(self, id, body, **kwargs): files=local_var_files, response_type='ProcessorEntity', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def create_remote_process_group(self, id, body, **kwargs): + def create_remote_process_group(self, body, id, **kwargs): """ - Creates a new process group + Creates a new process group. + This method makes a synchronous HTTP request and returns the response data directly. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.create_remote_process_group(id, body, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The process group id. (required) - :param RemoteProcessGroupEntity body: The remote process group configuration details. (required) - :return: RemoteProcessGroupEntity - If the method is called asynchronously, - returns the request thread. + For full HTTP response details (status code, headers, etc.), use the corresponding + ``create_remote_process_group_with_http_info()`` method instead. + + Args: + body (:class:`~nipyapi.nifi.models.RemoteProcessGroupEntity`): + The remote process group configuration details. (required) + id (str): + The process group id. (required) + + Returns: + :class:`~nipyapi.nifi.models.RemoteProcessGroupEntity`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.create_remote_process_group_with_http_info(id, body, **kwargs) + return self.create_remote_process_group_with_http_info(body, id, **kwargs) else: - (data) = self.create_remote_process_group_with_http_info(id, body, **kwargs) + (data) = self.create_remote_process_group_with_http_info(body, id, **kwargs) return data - def create_remote_process_group_with_http_info(self, id, body, **kwargs): + def create_remote_process_group_with_http_info(self, body, id, **kwargs): """ - Creates a new process group + Creates a new process group. + This method makes a synchronous HTTP request and returns detailed response information. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.create_remote_process_group_with_http_info(id, body, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The process group id. (required) - :param RemoteProcessGroupEntity body: The remote process group configuration details. (required) - :return: RemoteProcessGroupEntity - If the method is called asynchronously, - returns the request thread. + Returns the response data along with HTTP status code, headers, and other metadata. + For just the response data, use the corresponding ``create_remote_process_group()`` method instead. + + Args: + body (:class:`~nipyapi.nifi.models.RemoteProcessGroupEntity`): + The remote process group configuration details. (required) + id (str): + The process group id. (required) + + Returns: + tuple: (:class:`~nipyapi.nifi.models.RemoteProcessGroupEntity`, status_code, headers) - Response data with HTTP details. """ - all_params = ['id', 'body'] - all_params.append('callback') + all_params = ['body', 'id'] all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -1223,14 +1247,15 @@ def create_remote_process_group_with_http_info(self, id, body, **kwargs): ) 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_remote_process_group`") # verify the required parameter 'body' is set if ('body' not in params) or (params['body'] is None): raise ValueError("Missing the required parameter `body` when calling `create_remote_process_group`") + # 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_remote_process_group`") - + + collection_formats = {} path_params = {} @@ -1256,7 +1281,7 @@ def create_remote_process_group_with_http_info(self, id, body, **kwargs): select_header_content_type(['application/json']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/process-groups/{id}/remote-process-groups', 'POST', path_params, @@ -1267,62 +1292,60 @@ def create_remote_process_group_with_http_info(self, id, body, **kwargs): files=local_var_files, response_type='RemoteProcessGroupEntity', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def create_template(self, id, body, **kwargs): + def delete_replace_process_group_request(self, id, **kwargs): """ - Creates a template and discards the specified snippet. - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.create_template(id, body, callback=callback_function) + Deletes the Replace Request with the given ID. + + Deletes the Replace Request with the given ID. After a request is created via a POST to /process-groups/{id}/replace-requests, it is expected that the client will properly clean up the request by DELETE'ing it, once the Replace process has completed. If the request is deleted before the request completes, then the Replace request will finish the step that it is currently performing and then will cancel any subsequent steps. Note: This endpoint is subject to change as NiFi and it's REST API evolve. - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The process group id. (required) - :param CreateTemplateRequestEntity body: The create template request. (required) - :return: TemplateEntity - If the method is called asynchronously, - returns the request thread. + 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_replace_process_group_request_with_http_info()`` method instead. + + Args: + id (str): + The ID of the Update Request (required) + disconnected_node_acknowledged (bool): + Acknowledges that this node is disconnected to allow for mutable requests to proceed. + + Returns: + :class:`~nipyapi.nifi.models.ProcessGroupReplaceRequestEntity`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.create_template_with_http_info(id, body, **kwargs) + return self.delete_replace_process_group_request_with_http_info(id, **kwargs) else: - (data) = self.create_template_with_http_info(id, body, **kwargs) + (data) = self.delete_replace_process_group_request_with_http_info(id, **kwargs) return data - def create_template_with_http_info(self, id, body, **kwargs): + def delete_replace_process_group_request_with_http_info(self, id, **kwargs): """ - Creates a template and discards the specified snippet. - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.create_template_with_http_info(id, body, callback=callback_function) + Deletes the Replace Request with the given ID. + + Deletes the Replace Request with the given ID. After a request is created via a POST to /process-groups/{id}/replace-requests, it is expected that the client will properly clean up the request by DELETE'ing it, once the Replace process has completed. If the request is deleted before the request completes, then the Replace request will finish the step that it is currently performing and then will cancel any subsequent steps. Note: This endpoint is subject to change as NiFi and it's REST API evolve. - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The process group id. (required) - :param CreateTemplateRequestEntity body: The create template request. (required) - :return: TemplateEntity - If the method is called asynchronously, - returns the request thread. + 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_replace_process_group_request()`` method instead. + + Args: + id (str): + The ID of the Update Request (required) + disconnected_node_acknowledged (bool): + Acknowledges that this node is disconnected to allow for mutable requests to proceed. + + Returns: + tuple: (:class:`~nipyapi.nifi.models.ProcessGroupReplaceRequestEntity`, status_code, headers) - Response data with HTTP details. """ - all_params = ['id', 'body'] - all_params.append('callback') + all_params = ['id', 'disconnected_node_acknowledged'] all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -1332,18 +1355,16 @@ def create_template_with_http_info(self, id, body, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method create_template" % key + " to method delete_replace_process_group_request" % key ) params[key] = val del params['kwargs'] # verify the required parameter 'id' is set if ('id' not in params) or (params['id'] is None): - raise ValueError("Missing the required parameter `id` when calling `create_template`") - # 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_template`") - + raise ValueError("Missing the required parameter `id` when calling `delete_replace_process_group_request`") + + collection_formats = {} path_params = {} @@ -1351,6 +1372,8 @@ def create_template_with_http_info(self, id, body, **kwargs): path_params['id'] = params['id'] query_params = [] + if 'disconnected_node_acknowledged' in params: + query_params.append(('disconnectedNodeAcknowledged', params['disconnected_node_acknowledged'])) header_params = {} @@ -1358,84 +1381,70 @@ def create_template_with_http_info(self, id, body, **kwargs): local_var_files = {} body_params = None - if 'body' in params: - body_params = params['body'] # HTTP header `Accept` header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['application/json']) - # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] - return self.api_client.call_api('/process-groups/{id}/templates', 'POST', + return self.api_client.call_api('/process-groups/replace-requests/{id}', 'DELETE', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, - response_type='TemplateEntity', + response_type='ProcessGroupReplaceRequestEntity', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def delete_replace_process_group_request(self, id, **kwargs): + def export_process_group(self, id, **kwargs): """ - Deletes the Replace Request with the given ID - Deletes the Replace Request with the given ID. After a request is created via a POST to /process-groups/{id}/replace-requests, it is expected that the client will properly clean up the request by DELETE'ing it, once the Replace process has completed. If the request is deleted before the request completes, then the Replace request will finish the step that it is currently performing and then will cancel any subsequent steps. Note: This endpoint is subject to change as NiFi and it's REST API evolve. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.delete_replace_process_group_request(id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The ID of the Update Request (required) - :param bool disconnected_node_acknowledged: Acknowledges that this node is disconnected to allow for mutable requests to proceed. - :return: ProcessGroupReplaceRequestEntity - If the method is called asynchronously, - returns the request thread. + Gets a process group for download. + 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 + ``export_process_group_with_http_info()`` method instead. + + Args: + id (str): + The process group id. (required) + include_referenced_services (bool): + If referenced services from outside the target group should be included + + Returns: + str: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.delete_replace_process_group_request_with_http_info(id, **kwargs) + return self.export_process_group_with_http_info(id, **kwargs) else: - (data) = self.delete_replace_process_group_request_with_http_info(id, **kwargs) + (data) = self.export_process_group_with_http_info(id, **kwargs) return data - def delete_replace_process_group_request_with_http_info(self, id, **kwargs): + def export_process_group_with_http_info(self, id, **kwargs): """ - Deletes the Replace Request with the given ID - Deletes the Replace Request with the given ID. After a request is created via a POST to /process-groups/{id}/replace-requests, it is expected that the client will properly clean up the request by DELETE'ing it, once the Replace process has completed. If the request is deleted before the request completes, then the Replace request will finish the step that it is currently performing and then will cancel any subsequent steps. Note: This endpoint is subject to change as NiFi and it's REST API evolve. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.delete_replace_process_group_request_with_http_info(id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The ID of the Update Request (required) - :param bool disconnected_node_acknowledged: Acknowledges that this node is disconnected to allow for mutable requests to proceed. - :return: ProcessGroupReplaceRequestEntity - If the method is called asynchronously, - returns the request thread. + Gets a process group for download. + 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 ``export_process_group()`` method instead. + + Args: + id (str): + The process group id. (required) + include_referenced_services (bool): + If referenced services from outside the target group should be included + + Returns: + tuple: (str, status_code, headers) - Response data with HTTP details. """ - all_params = ['id', 'disconnected_node_acknowledged'] - all_params.append('callback') + all_params = ['id', 'include_referenced_services'] all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -1445,15 +1454,16 @@ def delete_replace_process_group_request_with_http_info(self, id, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method delete_replace_process_group_request" % key + " to method export_process_group" % key ) params[key] = val del params['kwargs'] # verify the required parameter 'id' is set if ('id' not in params) or (params['id'] is None): - raise ValueError("Missing the required parameter `id` when calling `delete_replace_process_group_request`") - + raise ValueError("Missing the required parameter `id` when calling `export_process_group`") + + collection_formats = {} path_params = {} @@ -1461,8 +1471,8 @@ def delete_replace_process_group_request_with_http_info(self, id, **kwargs): path_params['id'] = params['id'] query_params = [] - if 'disconnected_node_acknowledged' in params: - query_params.append(('disconnectedNodeAcknowledged', params['disconnected_node_acknowledged'])) + if 'include_referenced_services' in params: + query_params.append(('includeReferencedServices', params['include_referenced_services'])) header_params = {} @@ -1474,250 +1484,18 @@ def delete_replace_process_group_request_with_http_info(self, id, **kwargs): header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['*/*']) - # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] - return self.api_client.call_api('/process-groups/replace-requests/{id}', 'DELETE', + return self.api_client.call_api('/process-groups/{id}/download', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, - response_type='ProcessGroupReplaceRequestEntity', + response_type='str', auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only'), - _preload_content=params.get('_preload_content', True), - _request_timeout=params.get('_request_timeout'), - collection_formats=collection_formats) - - def delete_variable_registry_update_request(self, group_id, update_id, **kwargs): - """ - Deletes an update request for a process group's variable registry. If the request is not yet complete, it will automatically be cancelled. - Note: This endpoint is subject to change as NiFi and it's REST API evolve. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.delete_variable_registry_update_request(group_id, update_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str group_id: The process group id. (required) - :param str update_id: The ID of the Variable Registry Update Request (required) - :param bool disconnected_node_acknowledged: Acknowledges that this node is disconnected to allow for mutable requests to proceed. - :return: VariableRegistryUpdateRequestEntity - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.delete_variable_registry_update_request_with_http_info(group_id, update_id, **kwargs) - else: - (data) = self.delete_variable_registry_update_request_with_http_info(group_id, update_id, **kwargs) - return data - - def delete_variable_registry_update_request_with_http_info(self, group_id, update_id, **kwargs): - """ - Deletes an update request for a process group's variable registry. If the request is not yet complete, it will automatically be cancelled. - Note: This endpoint is subject to change as NiFi and it's REST API evolve. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.delete_variable_registry_update_request_with_http_info(group_id, update_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str group_id: The process group id. (required) - :param str update_id: The ID of the Variable Registry Update Request (required) - :param bool disconnected_node_acknowledged: Acknowledges that this node is disconnected to allow for mutable requests to proceed. - :return: VariableRegistryUpdateRequestEntity - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['group_id', 'update_id', 'disconnected_node_acknowledged'] - all_params.append('callback') - all_params.append('_return_http_data_only') - all_params.append('_preload_content') - all_params.append('_request_timeout') - - params = locals() - for key, val in params['kwargs'].items(): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method delete_variable_registry_update_request" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'group_id' is set - if ('group_id' not in params) or (params['group_id'] is None): - raise ValueError("Missing the required parameter `group_id` when calling `delete_variable_registry_update_request`") - # verify the required parameter 'update_id' is set - if ('update_id' not in params) or (params['update_id'] is None): - raise ValueError("Missing the required parameter `update_id` when calling `delete_variable_registry_update_request`") - - - collection_formats = {} - - path_params = {} - if 'group_id' in params: - path_params['groupId'] = params['group_id'] - if 'update_id' in params: - path_params['updateId'] = params['update_id'] - - query_params = [] - if 'disconnected_node_acknowledged' in params: - query_params.append(('disconnectedNodeAcknowledged', params['disconnected_node_acknowledged'])) - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['*/*']) - - # Authentication setting - auth_settings = ['tokenAuth'] - - return self.api_client.call_api('/process-groups/{groupId}/variable-registry/update-requests/{updateId}', 'DELETE', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='VariableRegistryUpdateRequestEntity', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only'), - _preload_content=params.get('_preload_content', True), - _request_timeout=params.get('_request_timeout'), - collection_formats=collection_formats) - - def export_process_group(self, id, **kwargs): - """ - Gets a process group for download - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.export_process_group(id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The process group id. (required) - :param bool include_referenced_services: If referenced services from outside the target group should be included - :return: str - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.export_process_group_with_http_info(id, **kwargs) - else: - (data) = self.export_process_group_with_http_info(id, **kwargs) - return data - - def export_process_group_with_http_info(self, id, **kwargs): - """ - Gets a process group for download - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.export_process_group_with_http_info(id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The process group id. (required) - :param bool include_referenced_services: If referenced services from outside the target group should be included - :return: str - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['id', 'include_referenced_services'] - all_params.append('callback') - all_params.append('_return_http_data_only') - all_params.append('_preload_content') - all_params.append('_request_timeout') - - params = locals() - for key, val in params['kwargs'].items(): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method export_process_group" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'id' is set - if ('id' not in params) or (params['id'] is None): - raise ValueError("Missing the required parameter `id` when calling `export_process_group`") - - - collection_formats = {} - - path_params = {} - if 'id' in params: - path_params['id'] = params['id'] - - query_params = [] - if 'include_referenced_services' in params: - query_params.append(('includeReferencedServices', params['include_referenced_services'])) - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['*/*']) - - # Authentication setting - auth_settings = ['tokenAuth'] - - return self.api_client.call_api('/process-groups/{id}/download', 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='str', - auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), @@ -1725,22 +1503,18 @@ def export_process_group_with_http_info(self, id, **kwargs): def get_connections(self, id, **kwargs): """ - Gets all connections + Gets all connections. + This method makes a synchronous HTTP request and returns the response data directly. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_connections(id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The process group id. (required) - :return: ConnectionsEntity - If the method is called asynchronously, - returns the request thread. + For full HTTP response details (status code, headers, etc.), use the corresponding + ``get_connections_with_http_info()`` method instead. + + Args: + id (str): + The process group id. (required) + + Returns: + :class:`~nipyapi.nifi.models.ConnectionsEntity`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): @@ -1751,26 +1525,21 @@ def get_connections(self, id, **kwargs): def get_connections_with_http_info(self, id, **kwargs): """ - Gets all connections + Gets all connections. + This method makes a synchronous HTTP request and returns detailed response information. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_connections_with_http_info(id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The process group id. (required) - :return: ConnectionsEntity - If the method is called asynchronously, - returns the request thread. + Returns the response data along with HTTP status code, headers, and other metadata. + For just the response data, use the corresponding ``get_connections()`` method instead. + + Args: + id (str): + The process group id. (required) + + Returns: + tuple: (:class:`~nipyapi.nifi.models.ConnectionsEntity`, status_code, headers) - Response data with HTTP details. """ all_params = ['id'] - all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -1788,7 +1557,7 @@ def get_connections_with_http_info(self, id, **kwargs): if ('id' not in params) or (params['id'] is None): raise ValueError("Missing the required parameter `id` when calling `get_connections`") - + collection_formats = {} path_params = {} @@ -1807,12 +1576,8 @@ def get_connections_with_http_info(self, id, **kwargs): header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['*/*']) - # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/process-groups/{id}/connections', 'GET', path_params, @@ -1823,7 +1588,6 @@ def get_connections_with_http_info(self, id, **kwargs): files=local_var_files, response_type='ConnectionsEntity', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), @@ -1831,23 +1595,20 @@ def get_connections_with_http_info(self, id, **kwargs): def get_drop_all_flowfiles_request(self, id, drop_request_id, **kwargs): """ - Gets the current status of a drop all flowfiles request. + Gets the current status of a drop all flowfiles request.. + This method makes a synchronous HTTP request and returns the response data directly. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_drop_all_flowfiles_request(id, drop_request_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The process group id. (required) - :param str drop_request_id: The drop request id. (required) - :return: DropRequestEntity - If the method is called asynchronously, - returns the request thread. + For full HTTP response details (status code, headers, etc.), use the corresponding + ``get_drop_all_flowfiles_request_with_http_info()`` method instead. + + Args: + id (str): + The process group id. (required) + drop_request_id (str): + The drop request id. (required) + + Returns: + :class:`~nipyapi.nifi.models.DropRequestEntity`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): @@ -1858,27 +1619,23 @@ def get_drop_all_flowfiles_request(self, id, drop_request_id, **kwargs): def get_drop_all_flowfiles_request_with_http_info(self, id, drop_request_id, **kwargs): """ - Gets the current status of a drop all flowfiles request. + Gets the current status of a drop all flowfiles request.. + This method makes a synchronous HTTP request and returns detailed response information. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_drop_all_flowfiles_request_with_http_info(id, drop_request_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The process group id. (required) - :param str drop_request_id: The drop request id. (required) - :return: DropRequestEntity - If the method is called asynchronously, - returns the request thread. + Returns the response data along with HTTP status code, headers, and other metadata. + For just the response data, use the corresponding ``get_drop_all_flowfiles_request()`` method instead. + + Args: + id (str): + The process group id. (required) + drop_request_id (str): + The drop request id. (required) + + Returns: + tuple: (:class:`~nipyapi.nifi.models.DropRequestEntity`, status_code, headers) - Response data with HTTP details. """ all_params = ['id', 'drop_request_id'] - all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -1899,7 +1656,8 @@ def get_drop_all_flowfiles_request_with_http_info(self, id, drop_request_id, **k if ('drop_request_id' not in params) or (params['drop_request_id'] is None): raise ValueError("Missing the required parameter `drop_request_id` when calling `get_drop_all_flowfiles_request`") - + + collection_formats = {} path_params = {} @@ -1920,12 +1678,8 @@ def get_drop_all_flowfiles_request_with_http_info(self, id, drop_request_id, **k header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['*/*']) - # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/process-groups/{id}/empty-all-connections-requests/{drop-request-id}', 'GET', path_params, @@ -1936,7 +1690,6 @@ def get_drop_all_flowfiles_request_with_http_info(self, id, drop_request_id, **k files=local_var_files, response_type='DropRequestEntity', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), @@ -1944,22 +1697,18 @@ def get_drop_all_flowfiles_request_with_http_info(self, id, drop_request_id, **k def get_funnels(self, id, **kwargs): """ - Gets all funnels + Gets all funnels. + This method makes a synchronous HTTP request and returns the response data directly. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_funnels(id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The process group id. (required) - :return: FunnelsEntity - If the method is called asynchronously, - returns the request thread. + For full HTTP response details (status code, headers, etc.), use the corresponding + ``get_funnels_with_http_info()`` method instead. + + Args: + id (str): + The process group id. (required) + + Returns: + :class:`~nipyapi.nifi.models.FunnelsEntity`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): @@ -1970,26 +1719,21 @@ def get_funnels(self, id, **kwargs): def get_funnels_with_http_info(self, id, **kwargs): """ - Gets all funnels + Gets all funnels. + This method makes a synchronous HTTP request and returns detailed response information. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_funnels_with_http_info(id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The process group id. (required) - :return: FunnelsEntity - If the method is called asynchronously, - returns the request thread. + Returns the response data along with HTTP status code, headers, and other metadata. + For just the response data, use the corresponding ``get_funnels()`` method instead. + + Args: + id (str): + The process group id. (required) + + Returns: + tuple: (:class:`~nipyapi.nifi.models.FunnelsEntity`, status_code, headers) - Response data with HTTP details. """ all_params = ['id'] - all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -2007,7 +1751,7 @@ def get_funnels_with_http_info(self, id, **kwargs): if ('id' not in params) or (params['id'] is None): raise ValueError("Missing the required parameter `id` when calling `get_funnels`") - + collection_formats = {} path_params = {} @@ -2026,12 +1770,8 @@ def get_funnels_with_http_info(self, id, **kwargs): header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['*/*']) - # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/process-groups/{id}/funnels', 'GET', path_params, @@ -2042,7 +1782,6 @@ def get_funnels_with_http_info(self, id, **kwargs): files=local_var_files, response_type='FunnelsEntity', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), @@ -2050,22 +1789,18 @@ def get_funnels_with_http_info(self, id, **kwargs): def get_input_ports(self, id, **kwargs): """ - Gets all input ports + Gets all input ports. + This method makes a synchronous HTTP request and returns the response data directly. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_input_ports(id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The process group id. (required) - :return: InputPortsEntity - If the method is called asynchronously, - returns the request thread. + For full HTTP response details (status code, headers, etc.), use the corresponding + ``get_input_ports_with_http_info()`` method instead. + + Args: + id (str): + The process group id. (required) + + Returns: + :class:`~nipyapi.nifi.models.InputPortsEntity`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): @@ -2076,26 +1811,21 @@ def get_input_ports(self, id, **kwargs): def get_input_ports_with_http_info(self, id, **kwargs): """ - Gets all input ports + Gets all input ports. + This method makes a synchronous HTTP request and returns detailed response information. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_input_ports_with_http_info(id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The process group id. (required) - :return: InputPortsEntity - If the method is called asynchronously, - returns the request thread. + Returns the response data along with HTTP status code, headers, and other metadata. + For just the response data, use the corresponding ``get_input_ports()`` method instead. + + Args: + id (str): + The process group id. (required) + + Returns: + tuple: (:class:`~nipyapi.nifi.models.InputPortsEntity`, status_code, headers) - Response data with HTTP details. """ all_params = ['id'] - all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -2113,7 +1843,7 @@ def get_input_ports_with_http_info(self, id, **kwargs): if ('id' not in params) or (params['id'] is None): raise ValueError("Missing the required parameter `id` when calling `get_input_ports`") - + collection_formats = {} path_params = {} @@ -2132,12 +1862,8 @@ def get_input_ports_with_http_info(self, id, **kwargs): header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['*/*']) - # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/process-groups/{id}/input-ports', 'GET', path_params, @@ -2148,7 +1874,6 @@ def get_input_ports_with_http_info(self, id, **kwargs): files=local_var_files, response_type='InputPortsEntity', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), @@ -2156,22 +1881,18 @@ def get_input_ports_with_http_info(self, id, **kwargs): def get_labels(self, id, **kwargs): """ - Gets all labels + Gets all labels. + This method makes a synchronous HTTP request and returns the response data directly. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_labels(id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The process group id. (required) - :return: LabelsEntity - If the method is called asynchronously, - returns the request thread. + For full HTTP response details (status code, headers, etc.), use the corresponding + ``get_labels_with_http_info()`` method instead. + + Args: + id (str): + The process group id. (required) + + Returns: + :class:`~nipyapi.nifi.models.LabelsEntity`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): @@ -2182,26 +1903,21 @@ def get_labels(self, id, **kwargs): def get_labels_with_http_info(self, id, **kwargs): """ - Gets all labels + Gets all labels. + This method makes a synchronous HTTP request and returns detailed response information. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_labels_with_http_info(id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The process group id. (required) - :return: LabelsEntity - If the method is called asynchronously, - returns the request thread. + Returns the response data along with HTTP status code, headers, and other metadata. + For just the response data, use the corresponding ``get_labels()`` method instead. + + Args: + id (str): + The process group id. (required) + + Returns: + tuple: (:class:`~nipyapi.nifi.models.LabelsEntity`, status_code, headers) - Response data with HTTP details. """ all_params = ['id'] - all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -2219,7 +1935,7 @@ def get_labels_with_http_info(self, id, **kwargs): if ('id' not in params) or (params['id'] is None): raise ValueError("Missing the required parameter `id` when calling `get_labels`") - + collection_formats = {} path_params = {} @@ -2238,12 +1954,8 @@ def get_labels_with_http_info(self, id, **kwargs): header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['*/*']) - # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/process-groups/{id}/labels', 'GET', path_params, @@ -2254,7 +1966,6 @@ def get_labels_with_http_info(self, id, **kwargs): files=local_var_files, response_type='LabelsEntity', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), @@ -2262,22 +1973,18 @@ def get_labels_with_http_info(self, id, **kwargs): def get_local_modifications(self, id, **kwargs): """ - Gets a list of local modifications to the Process Group since it was last synchronized with the Flow Registry + Gets a list of local modifications to the Process Group since it was last synchronized with the Flow Registry. + This method makes a synchronous HTTP request and returns the response data directly. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_local_modifications(id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The process group id. (required) - :return: FlowComparisonEntity - If the method is called asynchronously, - returns the request thread. + For full HTTP response details (status code, headers, etc.), use the corresponding + ``get_local_modifications_with_http_info()`` method instead. + + Args: + id (str): + The process group id. (required) + + Returns: + :class:`~nipyapi.nifi.models.FlowComparisonEntity`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): @@ -2288,26 +1995,21 @@ def get_local_modifications(self, id, **kwargs): def get_local_modifications_with_http_info(self, id, **kwargs): """ - Gets a list of local modifications to the Process Group since it was last synchronized with the Flow Registry + Gets a list of local modifications to the Process Group since it was last synchronized with the Flow Registry. + This method makes a synchronous HTTP request and returns detailed response information. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_local_modifications_with_http_info(id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The process group id. (required) - :return: FlowComparisonEntity - If the method is called asynchronously, - returns the request thread. + Returns the response data along with HTTP status code, headers, and other metadata. + For just the response data, use the corresponding ``get_local_modifications()`` method instead. + + Args: + id (str): + The process group id. (required) + + Returns: + tuple: (:class:`~nipyapi.nifi.models.FlowComparisonEntity`, status_code, headers) - Response data with HTTP details. """ all_params = ['id'] - all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -2325,7 +2027,7 @@ def get_local_modifications_with_http_info(self, id, **kwargs): if ('id' not in params) or (params['id'] is None): raise ValueError("Missing the required parameter `id` when calling `get_local_modifications`") - + collection_formats = {} path_params = {} @@ -2344,12 +2046,8 @@ def get_local_modifications_with_http_info(self, id, **kwargs): header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['*/*']) - # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/process-groups/{id}/local-modifications', 'GET', path_params, @@ -2360,7 +2058,6 @@ def get_local_modifications_with_http_info(self, id, **kwargs): files=local_var_files, response_type='FlowComparisonEntity', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), @@ -2368,22 +2065,18 @@ def get_local_modifications_with_http_info(self, id, **kwargs): def get_output_ports(self, id, **kwargs): """ - Gets all output ports + Gets all output ports. + This method makes a synchronous HTTP request and returns the response data directly. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_output_ports(id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The process group id. (required) - :return: OutputPortsEntity - If the method is called asynchronously, - returns the request thread. + For full HTTP response details (status code, headers, etc.), use the corresponding + ``get_output_ports_with_http_info()`` method instead. + + Args: + id (str): + The process group id. (required) + + Returns: + :class:`~nipyapi.nifi.models.OutputPortsEntity`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): @@ -2394,26 +2087,21 @@ def get_output_ports(self, id, **kwargs): def get_output_ports_with_http_info(self, id, **kwargs): """ - Gets all output ports + Gets all output ports. + This method makes a synchronous HTTP request and returns detailed response information. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_output_ports_with_http_info(id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The process group id. (required) - :return: OutputPortsEntity - If the method is called asynchronously, - returns the request thread. + Returns the response data along with HTTP status code, headers, and other metadata. + For just the response data, use the corresponding ``get_output_ports()`` method instead. + + Args: + id (str): + The process group id. (required) + + Returns: + tuple: (:class:`~nipyapi.nifi.models.OutputPortsEntity`, status_code, headers) - Response data with HTTP details. """ all_params = ['id'] - all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -2431,7 +2119,7 @@ def get_output_ports_with_http_info(self, id, **kwargs): if ('id' not in params) or (params['id'] is None): raise ValueError("Missing the required parameter `id` when calling `get_output_ports`") - + collection_formats = {} path_params = {} @@ -2450,12 +2138,8 @@ def get_output_ports_with_http_info(self, id, **kwargs): header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['*/*']) - # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/process-groups/{id}/output-ports', 'GET', path_params, @@ -2466,7 +2150,6 @@ def get_output_ports_with_http_info(self, id, **kwargs): files=local_var_files, response_type='OutputPortsEntity', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), @@ -2474,22 +2157,18 @@ def get_output_ports_with_http_info(self, id, **kwargs): def get_process_group(self, id, **kwargs): """ - Gets a process group + Gets a process group. + This method makes a synchronous HTTP request and returns the response data directly. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_process_group(id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The process group id. (required) - :return: ProcessGroupEntity - If the method is called asynchronously, - returns the request thread. + For full HTTP response details (status code, headers, etc.), use the corresponding + ``get_process_group_with_http_info()`` method instead. + + Args: + id (str): + The process group id. (required) + + Returns: + :class:`~nipyapi.nifi.models.ProcessGroupEntity`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): @@ -2500,26 +2179,21 @@ def get_process_group(self, id, **kwargs): def get_process_group_with_http_info(self, id, **kwargs): """ - Gets a process group + Gets a process group. + This method makes a synchronous HTTP request and returns detailed response information. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_process_group_with_http_info(id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The process group id. (required) - :return: ProcessGroupEntity - If the method is called asynchronously, - returns the request thread. + Returns the response data along with HTTP status code, headers, and other metadata. + For just the response data, use the corresponding ``get_process_group()`` method instead. + + Args: + id (str): + The process group id. (required) + + Returns: + tuple: (:class:`~nipyapi.nifi.models.ProcessGroupEntity`, status_code, headers) - Response data with HTTP details. """ all_params = ['id'] - all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -2537,7 +2211,7 @@ def get_process_group_with_http_info(self, id, **kwargs): if ('id' not in params) or (params['id'] is None): raise ValueError("Missing the required parameter `id` when calling `get_process_group`") - + collection_formats = {} path_params = {} @@ -2556,12 +2230,8 @@ def get_process_group_with_http_info(self, id, **kwargs): header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['*/*']) - # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/process-groups/{id}', 'GET', path_params, @@ -2572,7 +2242,6 @@ def get_process_group_with_http_info(self, id, **kwargs): files=local_var_files, response_type='ProcessGroupEntity', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), @@ -2580,22 +2249,18 @@ def get_process_group_with_http_info(self, id, **kwargs): def get_process_groups(self, id, **kwargs): """ - Gets all process groups + Gets all process groups. + This method makes a synchronous HTTP request and returns the response data directly. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_process_groups(id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The process group id. (required) - :return: ProcessGroupsEntity - If the method is called asynchronously, - returns the request thread. + For full HTTP response details (status code, headers, etc.), use the corresponding + ``get_process_groups_with_http_info()`` method instead. + + Args: + id (str): + The process group id. (required) + + Returns: + :class:`~nipyapi.nifi.models.ProcessGroupsEntity`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): @@ -2606,26 +2271,21 @@ def get_process_groups(self, id, **kwargs): def get_process_groups_with_http_info(self, id, **kwargs): """ - Gets all process groups + Gets all process groups. + This method makes a synchronous HTTP request and returns detailed response information. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_process_groups_with_http_info(id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The process group id. (required) - :return: ProcessGroupsEntity - If the method is called asynchronously, - returns the request thread. + Returns the response data along with HTTP status code, headers, and other metadata. + For just the response data, use the corresponding ``get_process_groups()`` method instead. + + Args: + id (str): + The process group id. (required) + + Returns: + tuple: (:class:`~nipyapi.nifi.models.ProcessGroupsEntity`, status_code, headers) - Response data with HTTP details. """ all_params = ['id'] - all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -2643,7 +2303,7 @@ def get_process_groups_with_http_info(self, id, **kwargs): if ('id' not in params) or (params['id'] is None): raise ValueError("Missing the required parameter `id` when calling `get_process_groups`") - + collection_formats = {} path_params = {} @@ -2662,12 +2322,8 @@ def get_process_groups_with_http_info(self, id, **kwargs): header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['*/*']) - # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/process-groups/{id}/process-groups', 'GET', path_params, @@ -2678,7 +2334,6 @@ def get_process_groups_with_http_info(self, id, **kwargs): files=local_var_files, response_type='ProcessGroupsEntity', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), @@ -2686,23 +2341,20 @@ def get_process_groups_with_http_info(self, id, **kwargs): def get_processors(self, id, **kwargs): """ - Gets all processors + Gets all processors. + This method makes a synchronous HTTP request and returns the response data directly. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_processors(id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The process group id. (required) - :param bool include_descendant_groups: Whether or not to include processors from descendant process groups - :return: ProcessorsEntity - If the method is called asynchronously, - returns the request thread. + For full HTTP response details (status code, headers, etc.), use the corresponding + ``get_processors_with_http_info()`` method instead. + + Args: + id (str): + The process group id. (required) + include_descendant_groups (bool): + Whether or not to include processors from descendant process groups + + Returns: + :class:`~nipyapi.nifi.models.ProcessorsEntity`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): @@ -2713,27 +2365,23 @@ def get_processors(self, id, **kwargs): def get_processors_with_http_info(self, id, **kwargs): """ - Gets all processors + Gets all processors. + This method makes a synchronous HTTP request and returns detailed response information. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_processors_with_http_info(id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The process group id. (required) - :param bool include_descendant_groups: Whether or not to include processors from descendant process groups - :return: ProcessorsEntity - If the method is called asynchronously, - returns the request thread. + Returns the response data along with HTTP status code, headers, and other metadata. + For just the response data, use the corresponding ``get_processors()`` method instead. + + Args: + id (str): + The process group id. (required) + include_descendant_groups (bool): + Whether or not to include processors from descendant process groups + + Returns: + tuple: (:class:`~nipyapi.nifi.models.ProcessorsEntity`, status_code, headers) - Response data with HTTP details. """ all_params = ['id', 'include_descendant_groups'] - all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -2751,7 +2399,8 @@ def get_processors_with_http_info(self, id, **kwargs): if ('id' not in params) or (params['id'] is None): raise ValueError("Missing the required parameter `id` when calling `get_processors`") - + + collection_formats = {} path_params = {} @@ -2772,12 +2421,8 @@ def get_processors_with_http_info(self, id, **kwargs): header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['*/*']) - # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/process-groups/{id}/processors', 'GET', path_params, @@ -2788,7 +2433,6 @@ def get_processors_with_http_info(self, id, **kwargs): files=local_var_files, response_type='ProcessorsEntity', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), @@ -2796,22 +2440,18 @@ def get_processors_with_http_info(self, id, **kwargs): def get_remote_process_groups(self, id, **kwargs): """ - Gets all remote process groups + Gets all remote process groups. + This method makes a synchronous HTTP request and returns the response data directly. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_remote_process_groups(id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The process group id. (required) - :return: RemoteProcessGroupsEntity - If the method is called asynchronously, - returns the request thread. + For full HTTP response details (status code, headers, etc.), use the corresponding + ``get_remote_process_groups_with_http_info()`` method instead. + + Args: + id (str): + The process group id. (required) + + Returns: + :class:`~nipyapi.nifi.models.RemoteProcessGroupsEntity`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): @@ -2822,26 +2462,21 @@ def get_remote_process_groups(self, id, **kwargs): def get_remote_process_groups_with_http_info(self, id, **kwargs): """ - Gets all remote process groups + Gets all remote process groups. + This method makes a synchronous HTTP request and returns detailed response information. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_remote_process_groups_with_http_info(id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The process group id. (required) - :return: RemoteProcessGroupsEntity - If the method is called asynchronously, - returns the request thread. + Returns the response data along with HTTP status code, headers, and other metadata. + For just the response data, use the corresponding ``get_remote_process_groups()`` method instead. + + Args: + id (str): + The process group id. (required) + + Returns: + tuple: (:class:`~nipyapi.nifi.models.RemoteProcessGroupsEntity`, status_code, headers) - Response data with HTTP details. """ all_params = ['id'] - all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -2859,7 +2494,7 @@ def get_remote_process_groups_with_http_info(self, id, **kwargs): if ('id' not in params) or (params['id'] is None): raise ValueError("Missing the required parameter `id` when calling `get_remote_process_groups`") - + collection_formats = {} path_params = {} @@ -2878,12 +2513,8 @@ def get_remote_process_groups_with_http_info(self, id, **kwargs): header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['*/*']) - # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/process-groups/{id}/remote-process-groups', 'GET', path_params, @@ -2894,7 +2525,6 @@ def get_remote_process_groups_with_http_info(self, id, **kwargs): files=local_var_files, response_type='RemoteProcessGroupsEntity', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), @@ -2902,22 +2532,21 @@ def get_remote_process_groups_with_http_info(self, id, **kwargs): def get_replace_process_group_request(self, id, **kwargs): """ - Returns the Replace Request with the given ID + Returns the Replace Request with the given ID. + Returns the Replace Request with the given ID. Once a Replace Request has been created by performing a POST to /process-groups/{id}/replace-requests, that request can subsequently be retrieved via this endpoint, and the request that is fetched will contain the updated state, such as percent complete, the current state of the request, and any failures. Note: This endpoint is subject to change as NiFi and it's REST API evolve. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_replace_process_group_request(id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The ID of the Replace Request (required) - :return: ProcessGroupReplaceRequestEntity - If the method is called asynchronously, - returns the request thread. + + 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_replace_process_group_request_with_http_info()`` method instead. + + Args: + id (str): + The ID of the Replace Request (required) + + Returns: + :class:`~nipyapi.nifi.models.ProcessGroupReplaceRequestEntity`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): @@ -2928,26 +2557,24 @@ def get_replace_process_group_request(self, id, **kwargs): def get_replace_process_group_request_with_http_info(self, id, **kwargs): """ - Returns the Replace Request with the given ID + Returns the Replace Request with the given ID. + Returns the Replace Request with the given ID. Once a Replace Request has been created by performing a POST to /process-groups/{id}/replace-requests, that request can subsequently be retrieved via this endpoint, and the request that is fetched will contain the updated state, such as percent complete, the current state of the request, and any failures. Note: This endpoint is subject to change as NiFi and it's REST API evolve. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_replace_process_group_request_with_http_info(id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The ID of the Replace Request (required) - :return: ProcessGroupReplaceRequestEntity - If the method is called asynchronously, - returns the request thread. + + 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_replace_process_group_request()`` method instead. + + Args: + id (str): + The ID of the Replace Request (required) + + Returns: + tuple: (:class:`~nipyapi.nifi.models.ProcessGroupReplaceRequestEntity`, status_code, headers) - Response data with HTTP details. """ all_params = ['id'] - all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -2965,7 +2592,7 @@ def get_replace_process_group_request_with_http_info(self, id, **kwargs): if ('id' not in params) or (params['id'] is None): raise ValueError("Missing the required parameter `id` when calling `get_replace_process_group_request`") - + collection_formats = {} path_params = {} @@ -2984,12 +2611,8 @@ def get_replace_process_group_request_with_http_info(self, id, **kwargs): header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['*/*']) - # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/process-groups/replace-requests/{id}', 'GET', path_params, @@ -3000,62 +2623,52 @@ def get_replace_process_group_request_with_http_info(self, id, **kwargs): files=local_var_files, response_type='ProcessGroupReplaceRequestEntity', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def get_variable_registry(self, id, **kwargs): - """ - Gets a process group's variable registry - Note: This endpoint is subject to change as NiFi and it's REST API evolve. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_variable_registry(id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The process group id. (required) - :param bool include_ancestor_groups: Whether or not to include ancestor groups - :return: VariableRegistryEntity - If the method is called asynchronously, - returns the request thread. + def import_process_group(self, id, **kwargs): + """ + Imports a specified process group. + 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 + ``import_process_group_with_http_info()`` method instead. + + Args: + id (str): + The process group id. (required) + body (:class:`~nipyapi.nifi.models.ProcessGroupUploadEntity`): + + Returns: + :class:`~nipyapi.nifi.models.ProcessGroupEntity`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.get_variable_registry_with_http_info(id, **kwargs) + return self.import_process_group_with_http_info(id, **kwargs) else: - (data) = self.get_variable_registry_with_http_info(id, **kwargs) + (data) = self.import_process_group_with_http_info(id, **kwargs) return data - def get_variable_registry_with_http_info(self, id, **kwargs): - """ - Gets a process group's variable registry - Note: This endpoint is subject to change as NiFi and it's REST API evolve. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_variable_registry_with_http_info(id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The process group id. (required) - :param bool include_ancestor_groups: Whether or not to include ancestor groups - :return: VariableRegistryEntity - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['id', 'include_ancestor_groups'] - all_params.append('callback') + def import_process_group_with_http_info(self, id, **kwargs): + """ + Imports a specified process group. + 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 ``import_process_group()`` method instead. + + Args: + id (str): + The process group id. (required) + body (:class:`~nipyapi.nifi.models.ProcessGroupUploadEntity`): + + Returns: + tuple: (:class:`~nipyapi.nifi.models.ProcessGroupEntity`, 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') @@ -3065,15 +2678,16 @@ def get_variable_registry_with_http_info(self, id, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method get_variable_registry" % key + " to method import_process_group" % key ) params[key] = val del params['kwargs'] # verify the required parameter 'id' is set if ('id' not in params) or (params['id'] is None): - raise ValueError("Missing the required parameter `id` when calling `get_variable_registry`") - + raise ValueError("Missing the required parameter `id` when calling `import_process_group`") + + collection_formats = {} path_params = {} @@ -3081,8 +2695,6 @@ def get_variable_registry_with_http_info(self, id, **kwargs): path_params['id'] = params['id'] query_params = [] - if 'include_ancestor_groups' in params: - query_params.append(('includeAncestorGroups', params['include_ancestor_groups'])) header_params = {} @@ -3090,407 +2702,82 @@ def get_variable_registry_with_http_info(self, id, **kwargs): 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(['*/*']) + select_header_content_type(['application/json']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] - return self.api_client.call_api('/process-groups/{id}/variable-registry', 'GET', + return self.api_client.call_api('/process-groups/{id}/process-groups/import', 'POST', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, - response_type='VariableRegistryEntity', + response_type='ProcessGroupEntity', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def get_variable_registry_update_request(self, group_id, update_id, **kwargs): - """ - Gets a process group's variable registry - Note: This endpoint is subject to change as NiFi and it's REST API evolve. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_variable_registry_update_request(group_id, update_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str group_id: The process group id. (required) - :param str update_id: The ID of the Variable Registry Update Request (required) - :return: VariableRegistryUpdateRequestEntity - If the method is called asynchronously, - returns the request thread. + def initiate_replace_process_group(self, body, id, **kwargs): """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_variable_registry_update_request_with_http_info(group_id, update_id, **kwargs) - else: - (data) = self.get_variable_registry_update_request_with_http_info(group_id, update_id, **kwargs) - return data + Initiate the Replace Request of a Process Group with the given ID. - def get_variable_registry_update_request_with_http_info(self, group_id, update_id, **kwargs): - """ - Gets a process group's variable registry - Note: This endpoint is subject to change as NiFi and it's REST API evolve. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_variable_registry_update_request_with_http_info(group_id, update_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str group_id: The process group id. (required) - :param str update_id: The ID of the Variable Registry Update Request (required) - :return: VariableRegistryUpdateRequestEntity - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['group_id', 'update_id'] - all_params.append('callback') - all_params.append('_return_http_data_only') - all_params.append('_preload_content') - all_params.append('_request_timeout') - - params = locals() - for key, val in params['kwargs'].items(): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_variable_registry_update_request" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'group_id' is set - if ('group_id' not in params) or (params['group_id'] is None): - raise ValueError("Missing the required parameter `group_id` when calling `get_variable_registry_update_request`") - # verify the required parameter 'update_id' is set - if ('update_id' not in params) or (params['update_id'] is None): - raise ValueError("Missing the required parameter `update_id` when calling `get_variable_registry_update_request`") - - - collection_formats = {} - - path_params = {} - if 'group_id' in params: - path_params['groupId'] = params['group_id'] - if 'update_id' in params: - path_params['updateId'] = params['update_id'] - - query_params = [] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['*/*']) - - # Authentication setting - auth_settings = ['tokenAuth'] - - return self.api_client.call_api('/process-groups/{groupId}/variable-registry/update-requests/{updateId}', 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='VariableRegistryUpdateRequestEntity', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only'), - _preload_content=params.get('_preload_content', True), - _request_timeout=params.get('_request_timeout'), - collection_formats=collection_formats) + 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. - def import_process_group(self, id, **kwargs): - """ - Imports a specified process group + This method makes a synchronous HTTP request and returns the response data directly. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.import_process_group(id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The process group id. (required) - :return: ProcessGroupEntity - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.import_process_group_with_http_info(id, **kwargs) - else: - (data) = self.import_process_group_with_http_info(id, **kwargs) - return data - - def import_process_group_with_http_info(self, id, **kwargs): - """ - Imports a specified process group + For full HTTP response details (status code, headers, etc.), use the corresponding + ``initiate_replace_process_group_with_http_info()`` method instead. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.import_process_group_with_http_info(id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The process group id. (required) - :return: ProcessGroupEntity - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['id'] - all_params.append('callback') - all_params.append('_return_http_data_only') - all_params.append('_preload_content') - all_params.append('_request_timeout') - - params = locals() - for key, val in params['kwargs'].items(): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method import_process_group" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'id' is set - if ('id' not in params) or (params['id'] is None): - raise ValueError("Missing the required parameter `id` when calling `import_process_group`") - - - collection_formats = {} - - path_params = {} - if 'id' in params: - path_params['id'] = params['id'] - - query_params = [] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['application/json']) - - # Authentication setting - auth_settings = ['tokenAuth'] - - return self.api_client.call_api('/process-groups/{id}/process-groups/import', 'POST', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='ProcessGroupEntity', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only'), - _preload_content=params.get('_preload_content', True), - _request_timeout=params.get('_request_timeout'), - collection_formats=collection_formats) - - def import_template(self, id, **kwargs): - """ - Imports a template - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.import_template(id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The process group id. (required) - :return: TemplateEntity - If the method is called asynchronously, - returns the request thread. + Args: + body (:class:`~nipyapi.nifi.models.ProcessGroupImportEntity`): + The process group replace request entity (required) + id (str): + The process group id. (required) + + Returns: + :class:`~nipyapi.nifi.models.ProcessGroupReplaceRequestEntity`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.import_template_with_http_info(id, **kwargs) + return self.initiate_replace_process_group_with_http_info(body, id, **kwargs) else: - (data) = self.import_template_with_http_info(id, **kwargs) + (data) = self.initiate_replace_process_group_with_http_info(body, id, **kwargs) return data - def import_template_with_http_info(self, id, **kwargs): + def initiate_replace_process_group_with_http_info(self, body, id, **kwargs): """ - Imports a template - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.import_template_with_http_info(id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The process group id. (required) - :return: TemplateEntity - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['id'] - all_params.append('callback') - all_params.append('_return_http_data_only') - all_params.append('_preload_content') - all_params.append('_request_timeout') - - params = locals() - for key, val in params['kwargs'].items(): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method import_template" % 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 `import_template`") - - - collection_formats = {} + Initiate the Replace Request of a Process Group with the given ID. - 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/xml']) - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['application/xml']) - - # Authentication setting - auth_settings = ['tokenAuth'] - - return self.api_client.call_api('/process-groups/{id}/templates/import', 'POST', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='TemplateEntity', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only'), - _preload_content=params.get('_preload_content', True), - _request_timeout=params.get('_request_timeout'), - collection_formats=collection_formats) - - def initiate_replace_process_group(self, id, body, **kwargs): - """ - Initiate the Replace Request of a Process Group with the given ID This will initiate the action of replacing a process group with the given process group. This can be a lengthy process, as it will stop any Processors and disable any Controller Services necessary to perform the action and then restart them. As a result, the endpoint will immediately return a ProcessGroupReplaceRequestEntity, and the process of replacing the flow will occur asynchronously in the background. The client may then periodically poll the status of the request by issuing a GET request to /process-groups/replace-requests/{requestId}. Once the request is completed, the client is expected to issue a DELETE request to /process-groups/replace-requests/{requestId}. Note: This endpoint is subject to change as NiFi and it's REST API evolve. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.initiate_replace_process_group(id, body, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The process group id. (required) - :param ProcessGroupImportEntity body: The process group replace request entity (required) - :return: ProcessGroupReplaceRequestEntity - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.initiate_replace_process_group_with_http_info(id, body, **kwargs) - else: - (data) = self.initiate_replace_process_group_with_http_info(id, body, **kwargs) - return data - def initiate_replace_process_group_with_http_info(self, id, body, **kwargs): - """ - Initiate the Replace Request of a Process Group with the given ID - This will initiate the action of replacing a process group with the given process group. This can be a lengthy process, as it will stop any Processors and disable any Controller Services necessary to perform the action and then restart them. As a result, the endpoint will immediately return a ProcessGroupReplaceRequestEntity, and the process of replacing the flow will occur asynchronously in the background. The client may then periodically poll the status of the request by issuing a GET request to /process-groups/replace-requests/{requestId}. Once the request is completed, the client is expected to issue a DELETE request to /process-groups/replace-requests/{requestId}. Note: This endpoint is subject to change as NiFi and it's REST API evolve. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.initiate_replace_process_group_with_http_info(id, body, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The process group id. (required) - :param ProcessGroupImportEntity body: The process group replace request entity (required) - :return: ProcessGroupReplaceRequestEntity - If the method is called asynchronously, - returns the request thread. + 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_replace_process_group()`` method instead. + + Args: + body (:class:`~nipyapi.nifi.models.ProcessGroupImportEntity`): + The process group replace request entity (required) + id (str): + The process group id. (required) + + Returns: + tuple: (:class:`~nipyapi.nifi.models.ProcessGroupReplaceRequestEntity`, status_code, headers) - Response data with HTTP details. """ - all_params = ['id', 'body'] - all_params.append('callback') + all_params = ['body', 'id'] all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -3504,14 +2791,15 @@ def initiate_replace_process_group_with_http_info(self, id, body, **kwargs): ) params[key] = val del params['kwargs'] - # verify the required parameter 'id' is set - if ('id' not in params) or (params['id'] is None): - raise ValueError("Missing the required parameter `id` when calling `initiate_replace_process_group`") # verify the required parameter 'body' is set if ('body' not in params) or (params['body'] is None): raise ValueError("Missing the required parameter `body` when calling `initiate_replace_process_group`") + # verify the required parameter 'id' is set + if ('id' not in params) or (params['id'] is None): + raise ValueError("Missing the required parameter `id` when calling `initiate_replace_process_group`") - + + collection_formats = {} path_params = {} @@ -3537,7 +2825,7 @@ def initiate_replace_process_group_with_http_info(self, id, body, **kwargs): select_header_content_type(['application/json']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/process-groups/{id}/replace-requests', 'POST', path_params, @@ -3548,62 +2836,54 @@ def initiate_replace_process_group_with_http_info(self, id, body, **kwargs): files=local_var_files, response_type='ProcessGroupReplaceRequestEntity', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def instantiate_template(self, id, body, **kwargs): + def paste(self, body, id, **kwargs): """ - Instantiates a template + Pastes into the specified process group. + This method makes a synchronous HTTP request and returns the response data directly. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.instantiate_template(id, body, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The process group id. (required) - :param InstantiateTemplateRequestEntity body: The instantiate template request. (required) - :return: FlowEntity - If the method is called asynchronously, - returns the request thread. + For full HTTP response details (status code, headers, etc.), use the corresponding + ``paste_with_http_info()`` method instead. + + Args: + body (:class:`~nipyapi.nifi.models.PasteRequestEntity`): + The request including the components to be pasted into the specified Process Group. (required) + id (str): + The process group id. (required) + + Returns: + :class:`~nipyapi.nifi.models.PasteResponseEntity`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.instantiate_template_with_http_info(id, body, **kwargs) + return self.paste_with_http_info(body, id, **kwargs) else: - (data) = self.instantiate_template_with_http_info(id, body, **kwargs) + (data) = self.paste_with_http_info(body, id, **kwargs) return data - def instantiate_template_with_http_info(self, id, body, **kwargs): + def paste_with_http_info(self, body, id, **kwargs): """ - Instantiates a template + Pastes into the specified process group. + This method makes a synchronous HTTP request and returns detailed response information. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.instantiate_template_with_http_info(id, body, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The process group id. (required) - :param InstantiateTemplateRequestEntity body: The instantiate template request. (required) - :return: FlowEntity - If the method is called asynchronously, - returns the request thread. + Returns the response data along with HTTP status code, headers, and other metadata. + For just the response data, use the corresponding ``paste()`` method instead. + + Args: + body (:class:`~nipyapi.nifi.models.PasteRequestEntity`): + The request including the components to be pasted into the specified Process Group. (required) + id (str): + The process group id. (required) + + Returns: + tuple: (:class:`~nipyapi.nifi.models.PasteResponseEntity`, status_code, headers) - Response data with HTTP details. """ - all_params = ['id', 'body'] - all_params.append('callback') + all_params = ['body', 'id'] all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -3613,18 +2893,19 @@ def instantiate_template_with_http_info(self, id, body, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method instantiate_template" % key + " to method paste" % 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 `instantiate_template`") # 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 `instantiate_template`") - + raise ValueError("Missing the required parameter `body` when calling `paste`") + # 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 `paste`") + + collection_formats = {} path_params = {} @@ -3650,73 +2931,65 @@ def instantiate_template_with_http_info(self, id, body, **kwargs): select_header_content_type(['application/json']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] - return self.api_client.call_api('/process-groups/{id}/template-instance', 'POST', + return self.api_client.call_api('/process-groups/{id}/paste', 'PUT', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, - response_type='FlowEntity', + response_type='PasteResponseEntity', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def remove_drop_request(self, id, drop_request_id, **kwargs): + def remove_drop_request1(self, id, drop_request_id, **kwargs): """ - Cancels and/or removes a request to drop all flowfiles. + Cancels and/or removes a request to drop all flowfiles.. + This method makes a synchronous HTTP request and returns the response data directly. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.remove_drop_request(id, drop_request_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The process group id. (required) - :param str drop_request_id: The drop request id. (required) - :return: DropRequestEntity - If the method is called asynchronously, - returns the request thread. + For full HTTP response details (status code, headers, etc.), use the corresponding + ``remove_drop_request1_with_http_info()`` method instead. + + Args: + id (str): + The process group id. (required) + drop_request_id (str): + The drop request id. (required) + + Returns: + :class:`~nipyapi.nifi.models.DropRequestEntity`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.remove_drop_request_with_http_info(id, drop_request_id, **kwargs) + return self.remove_drop_request1_with_http_info(id, drop_request_id, **kwargs) else: - (data) = self.remove_drop_request_with_http_info(id, drop_request_id, **kwargs) + (data) = self.remove_drop_request1_with_http_info(id, drop_request_id, **kwargs) return data - def remove_drop_request_with_http_info(self, id, drop_request_id, **kwargs): + def remove_drop_request1_with_http_info(self, id, drop_request_id, **kwargs): """ - Cancels and/or removes a request to drop all flowfiles. + Cancels and/or removes a request to drop all flowfiles.. + This method makes a synchronous HTTP request and returns detailed response information. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.remove_drop_request_with_http_info(id, drop_request_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The process group id. (required) - :param str drop_request_id: The drop request id. (required) - :return: DropRequestEntity - If the method is called asynchronously, - returns the request thread. + Returns the response data along with HTTP status code, headers, and other metadata. + For just the response data, use the corresponding ``remove_drop_request1()`` method instead. + + Args: + id (str): + The process group id. (required) + drop_request_id (str): + The drop request id. (required) + + Returns: + tuple: (:class:`~nipyapi.nifi.models.DropRequestEntity`, status_code, headers) - Response data with HTTP details. """ all_params = ['id', 'drop_request_id'] - all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -3726,18 +2999,19 @@ def remove_drop_request_with_http_info(self, id, drop_request_id, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method remove_drop_request" % key + " to method remove_drop_request1" % key ) params[key] = val del params['kwargs'] # verify the required parameter 'id' is set if ('id' not in params) or (params['id'] is None): - raise ValueError("Missing the required parameter `id` when calling `remove_drop_request`") + raise ValueError("Missing the required parameter `id` when calling `remove_drop_request1`") # verify the required parameter 'drop_request_id' is set if ('drop_request_id' not in params) or (params['drop_request_id'] is None): - raise ValueError("Missing the required parameter `drop_request_id` when calling `remove_drop_request`") - + raise ValueError("Missing the required parameter `drop_request_id` when calling `remove_drop_request1`") + + collection_formats = {} path_params = {} @@ -3758,12 +3032,8 @@ def remove_drop_request_with_http_info(self, id, drop_request_id, **kwargs): header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['*/*']) - # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/process-groups/{id}/empty-all-connections-requests/{drop-request-id}', 'DELETE', path_params, @@ -3774,7 +3044,6 @@ def remove_drop_request_with_http_info(self, id, drop_request_id, **kwargs): files=local_var_files, response_type='DropRequestEntity', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), @@ -3782,25 +3051,24 @@ def remove_drop_request_with_http_info(self, id, drop_request_id, **kwargs): def remove_process_group(self, id, **kwargs): """ - Deletes a process group - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.remove_process_group(id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The process group id. (required) - :param str version: The revision is used to verify the client is working with the latest version of the flow. - :param str client_id: If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response. - :param bool disconnected_node_acknowledged: Acknowledges that this node is disconnected to allow for mutable requests to proceed. - :return: ProcessGroupEntity - If the method is called asynchronously, - returns the request thread. + Deletes a process group. + 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 + ``remove_process_group_with_http_info()`` method instead. + + Args: + id (str): + The process group 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.ProcessGroupEntity`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): @@ -3811,29 +3079,27 @@ def remove_process_group(self, id, **kwargs): def remove_process_group_with_http_info(self, id, **kwargs): """ - Deletes a process group + Deletes a process group. + This method makes a synchronous HTTP request and returns detailed response information. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.remove_process_group_with_http_info(id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The process group id. (required) - :param str version: The revision is used to verify the client is working with the latest version of the flow. - :param str client_id: If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response. - :param bool disconnected_node_acknowledged: Acknowledges that this node is disconnected to allow for mutable requests to proceed. - :return: ProcessGroupEntity - If the method is called asynchronously, - returns the request thread. + Returns the response data along with HTTP status code, headers, and other metadata. + For just the response data, use the corresponding ``remove_process_group()`` method instead. + + Args: + id (str): + The process group 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.ProcessGroupEntity`, status_code, headers) - Response data with HTTP details. """ all_params = ['id', 'version', 'client_id', 'disconnected_node_acknowledged'] - all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -3851,7 +3117,10 @@ def remove_process_group_with_http_info(self, id, **kwargs): if ('id' not in params) or (params['id'] is None): raise ValueError("Missing the required parameter `id` when calling `remove_process_group`") - + + + + collection_formats = {} path_params = {} @@ -3876,12 +3145,8 @@ def remove_process_group_with_http_info(self, id, **kwargs): header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['*/*']) - # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/process-groups/{id}', 'DELETE', path_params, @@ -3892,62 +3157,60 @@ def remove_process_group_with_http_info(self, id, **kwargs): files=local_var_files, response_type='ProcessGroupEntity', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def replace_process_group(self, id, body, **kwargs): + def replace_process_group(self, body, id, **kwargs): """ - Replace Process Group contents with the given ID with the specified Process Group contents + Replace Process Group contents with the given ID with the specified Process Group contents. + This endpoint is used for replication within a cluster, when replacing a flow with a new flow. It expects that the flow beingreplaced is not under version control and that the given snapshot will not modify any Processor that is currently running or any Controller Service that is enabled. Note: This endpoint is subject to change as NiFi and it's REST API evolve. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.replace_process_group(id, body, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The process group id. (required) - :param ProcessGroupImportEntity body: The process group replace request entity. (required) - :return: ProcessGroupImportEntity - If the method is called asynchronously, - returns the request thread. + + 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 + ``replace_process_group_with_http_info()`` method instead. + + Args: + body (:class:`~nipyapi.nifi.models.ProcessGroupImportEntity`): + The process group replace request entity. (required) + id (str): + The process group id. (required) + + Returns: + :class:`~nipyapi.nifi.models.ProcessGroupImportEntity`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.replace_process_group_with_http_info(id, body, **kwargs) + return self.replace_process_group_with_http_info(body, id, **kwargs) else: - (data) = self.replace_process_group_with_http_info(id, body, **kwargs) + (data) = self.replace_process_group_with_http_info(body, id, **kwargs) return data - def replace_process_group_with_http_info(self, id, body, **kwargs): + def replace_process_group_with_http_info(self, body, id, **kwargs): """ - Replace Process Group contents with the given ID with the specified Process Group contents + Replace Process Group contents with the given ID with the specified Process Group contents. + This endpoint is used for replication within a cluster, when replacing a flow with a new flow. It expects that the flow beingreplaced is not under version control and that the given snapshot will not modify any Processor that is currently running or any Controller Service that is enabled. Note: This endpoint is subject to change as NiFi and it's REST API evolve. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.replace_process_group_with_http_info(id, body, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The process group id. (required) - :param ProcessGroupImportEntity body: The process group replace request entity. (required) - :return: ProcessGroupImportEntity - If the method is called asynchronously, - returns the request thread. + + 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 ``replace_process_group()`` method instead. + + Args: + body (:class:`~nipyapi.nifi.models.ProcessGroupImportEntity`): + The process group replace request entity. (required) + id (str): + The process group id. (required) + + Returns: + tuple: (:class:`~nipyapi.nifi.models.ProcessGroupImportEntity`, status_code, headers) - Response data with HTTP details. """ - all_params = ['id', 'body'] - all_params.append('callback') + all_params = ['body', 'id'] all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -3961,127 +3224,15 @@ def replace_process_group_with_http_info(self, id, body, **kwargs): ) params[key] = val del params['kwargs'] - # verify the required parameter 'id' is set - if ('id' not in params) or (params['id'] is None): - raise ValueError("Missing the required parameter `id` when calling `replace_process_group`") # verify the required parameter 'body' is set if ('body' not in params) or (params['body'] is None): raise ValueError("Missing the required parameter `body` when calling `replace_process_group`") - - - collection_formats = {} - - path_params = {} - if 'id' in params: - path_params['id'] = params['id'] - - query_params = [] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - if 'body' in params: - body_params = params['body'] - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['application/json']) - - # Authentication setting - auth_settings = ['tokenAuth'] - - return self.api_client.call_api('/process-groups/{id}/flow-contents', 'PUT', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='ProcessGroupImportEntity', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only'), - _preload_content=params.get('_preload_content', True), - _request_timeout=params.get('_request_timeout'), - collection_formats=collection_formats) - - def submit_update_variable_registry_request(self, id, body, **kwargs): - """ - Submits a request to update a process group's variable registry - Note: This endpoint is subject to change as NiFi and it's REST API evolve. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.submit_update_variable_registry_request(id, body, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The process group id. (required) - :param VariableRegistryEntity body: The variable registry configuration details. (required) - :return: VariableRegistryUpdateRequestEntity - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.submit_update_variable_registry_request_with_http_info(id, body, **kwargs) - else: - (data) = self.submit_update_variable_registry_request_with_http_info(id, body, **kwargs) - return data - - def submit_update_variable_registry_request_with_http_info(self, id, body, **kwargs): - """ - Submits a request to update a process group's variable registry - Note: This endpoint is subject to change as NiFi and it's REST API evolve. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.submit_update_variable_registry_request_with_http_info(id, body, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The process group id. (required) - :param VariableRegistryEntity body: The variable registry configuration details. (required) - :return: VariableRegistryUpdateRequestEntity - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['id', 'body'] - all_params.append('callback') - all_params.append('_return_http_data_only') - all_params.append('_preload_content') - all_params.append('_request_timeout') - - params = locals() - for key, val in params['kwargs'].items(): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method submit_update_variable_registry_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_update_variable_registry_request`") - # verify the required parameter 'body' is set - if ('body' not in params) or (params['body'] is None): - raise ValueError("Missing the required parameter `body` when calling `submit_update_variable_registry_request`") - + raise ValueError("Missing the required parameter `id` when calling `replace_process_group`") + + collection_formats = {} path_params = {} @@ -4107,73 +3258,65 @@ def submit_update_variable_registry_request_with_http_info(self, id, body, **kwa select_header_content_type(['application/json']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] - return self.api_client.call_api('/process-groups/{id}/variable-registry/update-requests', 'POST', + return self.api_client.call_api('/process-groups/{id}/flow-contents', 'PUT', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, - response_type='VariableRegistryUpdateRequestEntity', + response_type='ProcessGroupImportEntity', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def update_process_group(self, id, body, **kwargs): + def update_process_group(self, body, id, **kwargs): """ - Updates a process group + Updates a process group. + This method makes a synchronous HTTP request and returns the response data directly. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.update_process_group(id, body, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The process group id. (required) - :param ProcessGroupEntity body: The process group configuration details. (required) - :return: ProcessGroupEntity - If the method is called asynchronously, - returns the request thread. + For full HTTP response details (status code, headers, etc.), use the corresponding + ``update_process_group_with_http_info()`` method instead. + + Args: + body (:class:`~nipyapi.nifi.models.ProcessGroupEntity`): + The process group configuration details. (required) + id (str): + The process group id. (required) + + Returns: + :class:`~nipyapi.nifi.models.ProcessGroupEntity`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.update_process_group_with_http_info(id, body, **kwargs) + return self.update_process_group_with_http_info(body, id, **kwargs) else: - (data) = self.update_process_group_with_http_info(id, body, **kwargs) + (data) = self.update_process_group_with_http_info(body, id, **kwargs) return data - def update_process_group_with_http_info(self, id, body, **kwargs): + def update_process_group_with_http_info(self, body, id, **kwargs): """ - Updates a process group + Updates a process group. + This method makes a synchronous HTTP request and returns detailed response information. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.update_process_group_with_http_info(id, body, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The process group id. (required) - :param ProcessGroupEntity body: The process group configuration details. (required) - :return: ProcessGroupEntity - If the method is called asynchronously, - returns the request thread. + Returns the response data along with HTTP status code, headers, and other metadata. + For just the response data, use the corresponding ``update_process_group()`` method instead. + + Args: + body (:class:`~nipyapi.nifi.models.ProcessGroupEntity`): + The process group configuration details. (required) + id (str): + The process group id. (required) + + Returns: + tuple: (:class:`~nipyapi.nifi.models.ProcessGroupEntity`, status_code, headers) - Response data with HTTP details. """ - all_params = ['id', 'body'] - all_params.append('callback') + all_params = ['body', 'id'] all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -4187,14 +3330,15 @@ def update_process_group_with_http_info(self, id, body, **kwargs): ) params[key] = val del params['kwargs'] - # verify the required parameter 'id' is set - if ('id' not in params) or (params['id'] is None): - raise ValueError("Missing the required parameter `id` when calling `update_process_group`") # verify the required parameter 'body' is set if ('body' not in params) or (params['body'] is None): raise ValueError("Missing the required parameter `body` when calling `update_process_group`") + # verify the required parameter 'id' is set + if ('id' not in params) or (params['id'] is None): + raise ValueError("Missing the required parameter `id` when calling `update_process_group`") - + + collection_formats = {} path_params = {} @@ -4220,7 +3364,7 @@ def update_process_group_with_http_info(self, id, body, **kwargs): select_header_content_type(['application/json']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/process-groups/{id}', 'PUT', path_params, @@ -4231,185 +3375,62 @@ def update_process_group_with_http_info(self, id, body, **kwargs): files=local_var_files, response_type='ProcessGroupEntity', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def update_variable_registry(self, id, body, **kwargs): - """ - Updates the contents of a Process Group's variable Registry - Note: This endpoint is subject to change as NiFi and it's REST API evolve. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.update_variable_registry(id, body, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The process group id. (required) - :param VariableRegistryEntity body: The variable registry configuration details. (required) - :return: VariableRegistryEntity - If the method is called asynchronously, - returns the request thread. + def upload_process_group(self, id, **kwargs): + """ + Uploads a versioned flow definition and creates a process group. + 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 + ``upload_process_group_with_http_info()`` method instead. + + Args: + id (str): + The process group id. (required) + client_id (str): + disconnected_node_acknowledged (bool): + file (:class:`~nipyapi.nifi.models.object`): + group_name (str): + position_x (float): + position_y (float): + + Returns: + :class:`~nipyapi.nifi.models.ProcessGroupEntity`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.update_variable_registry_with_http_info(id, body, **kwargs) + return self.upload_process_group_with_http_info(id, **kwargs) else: - (data) = self.update_variable_registry_with_http_info(id, body, **kwargs) + (data) = self.upload_process_group_with_http_info(id, **kwargs) return data - def update_variable_registry_with_http_info(self, id, body, **kwargs): + def upload_process_group_with_http_info(self, id, **kwargs): """ - Updates the contents of a Process Group's variable Registry - Note: This endpoint is subject to change as NiFi and it's REST API evolve. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.update_variable_registry_with_http_info(id, body, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The process group id. (required) - :param VariableRegistryEntity body: The variable registry configuration details. (required) - :return: VariableRegistryEntity - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['id', 'body'] - all_params.append('callback') - all_params.append('_return_http_data_only') - all_params.append('_preload_content') - all_params.append('_request_timeout') - - params = locals() - for key, val in params['kwargs'].items(): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method update_variable_registry" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'id' is set - if ('id' not in params) or (params['id'] is None): - raise ValueError("Missing the required parameter `id` when calling `update_variable_registry`") - # verify the required parameter 'body' is set - if ('body' not in params) or (params['body'] is None): - raise ValueError("Missing the required parameter `body` when calling `update_variable_registry`") - - - collection_formats = {} - - path_params = {} - if 'id' in params: - path_params['id'] = params['id'] - - query_params = [] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - if 'body' in params: - body_params = params['body'] - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['application/json']) - - # Authentication setting - auth_settings = ['tokenAuth'] - - return self.api_client.call_api('/process-groups/{id}/variable-registry', 'PUT', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='VariableRegistryEntity', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only'), - _preload_content=params.get('_preload_content', True), - _request_timeout=params.get('_request_timeout'), - collection_formats=collection_formats) - - def upload_process_group(self, id, group_name, position_x, position_y, client_id, file, **kwargs): - """ - Uploads a versioned flow definition and creates a process group - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.upload_process_group(id, group_name, position_x, position_y, client_id, file, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The process group id. (required) - :param str group_name: The process group name. (required) - :param float position_x: The process group X position. (required) - :param float position_y: The process group Y position. (required) - :param str client_id: The client id. (required) - :param file file: The binary content of the versioned flow definition file being uploaded. (required) - :param bool disconnected_node_acknowledged: Acknowledges that this node is disconnected to allow for mutable requests to proceed. - :return: ProcessGroupEntity - If the method is called asynchronously, - returns the request thread. + Uploads a versioned flow definition and creates a process group. + 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 ``upload_process_group()`` method instead. + + Args: + id (str): + The process group id. (required) + client_id (str): + disconnected_node_acknowledged (bool): + file (:class:`~nipyapi.nifi.models.object`): + group_name (str): + position_x (float): + position_y (float): + + Returns: + tuple: (:class:`~nipyapi.nifi.models.ProcessGroupEntity`, status_code, headers) - Response data with HTTP details. """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.upload_process_group_with_http_info(id, group_name, position_x, position_y, client_id, file, **kwargs) - else: - (data) = self.upload_process_group_with_http_info(id, group_name, position_x, position_y, client_id, file, **kwargs) - return data - def upload_process_group_with_http_info(self, id, group_name, position_x, position_y, client_id, file, **kwargs): - """ - Uploads a versioned flow definition and creates a process group - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.upload_process_group_with_http_info(id, group_name, position_x, position_y, client_id, file, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The process group id. (required) - :param str group_name: The process group name. (required) - :param float position_x: The process group X position. (required) - :param float position_y: The process group Y position. (required) - :param str client_id: The client id. (required) - :param file file: The binary content of the versioned flow definition file being uploaded. (required) - :param bool disconnected_node_acknowledged: Acknowledges that this node is disconnected to allow for mutable requests to proceed. - :return: ProcessGroupEntity - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['id', 'group_name', 'position_x', 'position_y', 'client_id', 'file', 'disconnected_node_acknowledged'] - all_params.append('callback') + all_params = ['id', 'client_id', 'disconnected_node_acknowledged', 'file', 'group_name', 'position_x', 'position_y'] all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -4426,23 +3447,14 @@ def upload_process_group_with_http_info(self, id, group_name, position_x, positi # 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 `upload_process_group`") - # verify the required parameter 'group_name' is set - if ('group_name' not in params) or (params['group_name'] is None): - raise ValueError("Missing the required parameter `group_name` when calling `upload_process_group`") - # verify the required parameter 'position_x' is set - if ('position_x' not in params) or (params['position_x'] is None): - raise ValueError("Missing the required parameter `position_x` when calling `upload_process_group`") - # verify the required parameter 'position_y' is set - if ('position_y' not in params) or (params['position_y'] is None): - raise ValueError("Missing the required parameter `position_y` when calling `upload_process_group`") - # verify the required parameter 'client_id' is set - if ('client_id' not in params) or (params['client_id'] is None): - raise ValueError("Missing the required parameter `client_id` when calling `upload_process_group`") - # verify the required parameter 'file' is set - if ('file' not in params) or (params['file'] is None): - raise ValueError("Missing the required parameter `file` when calling `upload_process_group`") - + + + + + + + collection_formats = {} path_params = {} @@ -4455,18 +3467,18 @@ def upload_process_group_with_http_info(self, id, group_name, position_x, positi form_params = [] local_var_files = {} + if 'client_id' in params: + form_params.append(('clientId', params['client_id'])) + if 'disconnected_node_acknowledged' in params: + form_params.append(('disconnectedNodeAcknowledged', params['disconnected_node_acknowledged'])) + if 'file' in params: + form_params.append(('file', params['file'])) if 'group_name' in params: form_params.append(('groupName', params['group_name'])) if 'position_x' in params: form_params.append(('positionX', params['position_x'])) if 'position_y' in params: form_params.append(('positionY', params['position_y'])) - if 'client_id' in params: - form_params.append(('clientId', params['client_id'])) - if 'disconnected_node_acknowledged' in params: - form_params.append(('disconnectedNodeAcknowledged', params['disconnected_node_acknowledged'])) - if 'file' in params: - local_var_files['file'] = params['file'] body_params = None # HTTP header `Accept` @@ -4478,7 +3490,7 @@ def upload_process_group_with_http_info(self, id, group_name, position_x, positi select_header_content_type(['multipart/form-data']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/process-groups/{id}/process-groups/upload', 'POST', path_params, @@ -4489,124 +3501,6 @@ def upload_process_group_with_http_info(self, id, group_name, position_x, positi files=local_var_files, response_type='ProcessGroupEntity', auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only'), - _preload_content=params.get('_preload_content', True), - _request_timeout=params.get('_request_timeout'), - collection_formats=collection_formats) - - def upload_template(self, id, template, **kwargs): - """ - Uploads a template - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.upload_template(id, template, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The process group id. (required) - :param file template: The binary content of the template file being uploaded. (required) - :param bool disconnected_node_acknowledged: Acknowledges that this node is disconnected to allow for mutable requests to proceed. - :return: TemplateEntity - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.upload_template_with_http_info(id, template, **kwargs) - else: - (data) = self.upload_template_with_http_info(id, template, **kwargs) - return data - - def upload_template_with_http_info(self, id, template, **kwargs): - """ - Uploads a template - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.upload_template_with_http_info(id, template, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The process group id. (required) - :param file template: The binary content of the template file being uploaded. (required) - :param bool disconnected_node_acknowledged: Acknowledges that this node is disconnected to allow for mutable requests to proceed. - :return: TemplateEntity - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['id', 'template', 'disconnected_node_acknowledged'] - all_params.append('callback') - all_params.append('_return_http_data_only') - all_params.append('_preload_content') - all_params.append('_request_timeout') - - params = locals() - for key, val in params['kwargs'].items(): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method upload_template" % 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 `upload_template`") - # verify the required parameter 'template' is set - if ('template' not in params) or (params['template'] is None): - raise ValueError("Missing the required parameter `template` when calling `upload_template`") - - - collection_formats = {} - - path_params = {} - if 'id' in params: - path_params['id'] = params['id'] - - query_params = [] - - header_params = {} - - form_params = [] - local_var_files = {} - if 'disconnected_node_acknowledged' in params: - form_params.append(('disconnectedNodeAcknowledged', params['disconnected_node_acknowledged'])) - if 'template' in params: - local_var_files['template'] = params['template'] - - body_params = None - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/xml']) - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['multipart/form-data']) - - # Authentication setting - auth_settings = ['tokenAuth'] - - return self.api_client.call_api('/process-groups/{id}/templates/upload', 'POST', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='TemplateEntity', - auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), diff --git a/nipyapi/nifi/apis/processors_api.py b/nipyapi/nifi/apis/processors_api.py index 061cb52d..100ac912 100644 --- a/nipyapi/nifi/apis/processors_api.py +++ b/nipyapi/nifi/apis/processors_api.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - import sys import os import re @@ -33,56 +32,49 @@ def __init__(self, api_client=None): config.api_client = ApiClient() self.api_client = config.api_client - def analyze_configuration(self, id, body, **kwargs): + def analyze_configuration2(self, body, id, **kwargs): """ - Performs analysis of the component's configuration, providing information about which attributes are referenced. + Performs analysis of the component's configuration, providing information about which attributes are referenced.. + 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 + ``analyze_configuration2_with_http_info()`` method instead. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.analyze_configuration(id, body, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The processor id. (required) - :param ConfigurationAnalysisEntity body: The processor configuration analysis request. (required) - :return: ConfigurationAnalysisEntity - If the method is called asynchronously, - returns the request thread. + Args: + body (:class:`~nipyapi.nifi.models.ConfigurationAnalysisEntity`): + The processor configuration analysis request. (required) + id (str): + The processor id. (required) + + Returns: + :class:`~nipyapi.nifi.models.ConfigurationAnalysisEntity`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.analyze_configuration_with_http_info(id, body, **kwargs) + return self.analyze_configuration2_with_http_info(body, id, **kwargs) else: - (data) = self.analyze_configuration_with_http_info(id, body, **kwargs) + (data) = self.analyze_configuration2_with_http_info(body, id, **kwargs) return data - def analyze_configuration_with_http_info(self, id, body, **kwargs): + def analyze_configuration2_with_http_info(self, body, id, **kwargs): """ - Performs analysis of the component's configuration, providing information about which attributes are referenced. + Performs analysis of the component's configuration, providing information about which attributes are referenced.. + This method makes a synchronous HTTP request and returns detailed response information. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.analyze_configuration_with_http_info(id, body, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The processor id. (required) - :param ConfigurationAnalysisEntity body: The processor configuration analysis request. (required) - :return: ConfigurationAnalysisEntity - If the method is called asynchronously, - returns the request thread. + Returns the response data along with HTTP status code, headers, and other metadata. + For just the response data, use the corresponding ``analyze_configuration2()`` method instead. + + Args: + body (:class:`~nipyapi.nifi.models.ConfigurationAnalysisEntity`): + The processor configuration analysis request. (required) + id (str): + The processor id. (required) + + Returns: + tuple: (:class:`~nipyapi.nifi.models.ConfigurationAnalysisEntity`, status_code, headers) - Response data with HTTP details. """ - all_params = ['id', 'body'] - all_params.append('callback') + all_params = ['body', 'id'] all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -92,18 +84,19 @@ def analyze_configuration_with_http_info(self, id, body, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method analyze_configuration" % key + " to method analyze_configuration2" % 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 `analyze_configuration`") # 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 `analyze_configuration`") - + raise ValueError("Missing the required parameter `body` when calling `analyze_configuration2`") + # 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 `analyze_configuration2`") + + collection_formats = {} path_params = {} @@ -129,7 +122,7 @@ def analyze_configuration_with_http_info(self, id, body, **kwargs): select_header_content_type(['application/json']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/processors/{id}/config/analysis', 'POST', path_params, @@ -140,60 +133,50 @@ def analyze_configuration_with_http_info(self, id, body, **kwargs): files=local_var_files, response_type='ConfigurationAnalysisEntity', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def clear_state(self, id, **kwargs): + def clear_state3(self, id, **kwargs): """ - Clears the state for a processor + Clears the state for a processor. + This method makes a synchronous HTTP request and returns the response data directly. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.clear_state(id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The processor id. (required) - :return: ComponentStateEntity - If the method is called asynchronously, - returns the request thread. + For full HTTP response details (status code, headers, etc.), use the corresponding + ``clear_state3_with_http_info()`` method instead. + + Args: + 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.clear_state_with_http_info(id, **kwargs) + return self.clear_state3_with_http_info(id, **kwargs) else: - (data) = self.clear_state_with_http_info(id, **kwargs) + (data) = self.clear_state3_with_http_info(id, **kwargs) return data - def clear_state_with_http_info(self, id, **kwargs): + def clear_state3_with_http_info(self, id, **kwargs): """ - Clears the state for a processor + Clears the state for a processor. + 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 ``clear_state3()`` method instead. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.clear_state_with_http_info(id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The processor id. (required) - :return: ComponentStateEntity - If the method is called asynchronously, - returns the request thread. + Args: + id (str): + The processor id. (required) + + Returns: + tuple: (:class:`~nipyapi.nifi.models.ComponentStateEntity`, status_code, headers) - Response data with HTTP details. """ all_params = ['id'] - all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -203,15 +186,15 @@ def clear_state_with_http_info(self, id, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method clear_state" % key + " to method clear_state3" % 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 `clear_state`") - + raise ValueError("Missing the required parameter `id` when calling `clear_state3`") + collection_formats = {} path_params = {} @@ -230,12 +213,8 @@ def clear_state_with_http_info(self, id, **kwargs): header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['*/*']) - # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/processors/{id}/state/clear-requests', 'POST', path_params, @@ -246,7 +225,6 @@ def clear_state_with_http_info(self, id, **kwargs): files=local_var_files, response_type='ComponentStateEntity', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), @@ -254,25 +232,24 @@ def clear_state_with_http_info(self, id, **kwargs): def delete_processor(self, id, **kwargs): """ - Deletes a processor + Deletes a processor. + 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_processor_with_http_info()`` method instead. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.delete_processor(id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The processor id. (required) - :param str version: The revision is used to verify the client is working with the latest version of the flow. - :param str client_id: If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response. - :param bool disconnected_node_acknowledged: Acknowledges that this node is disconnected to allow for mutable requests to proceed. - :return: ProcessorEntity - If the method is called asynchronously, - returns the request thread. + Args: + id (str): + The processor 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.ProcessorEntity`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): @@ -283,29 +260,27 @@ def delete_processor(self, id, **kwargs): def delete_processor_with_http_info(self, id, **kwargs): """ - Deletes a processor + Deletes a processor. + This method makes a synchronous HTTP request and returns detailed response information. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.delete_processor_with_http_info(id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The processor id. (required) - :param str version: The revision is used to verify the client is working with the latest version of the flow. - :param str client_id: If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response. - :param bool disconnected_node_acknowledged: Acknowledges that this node is disconnected to allow for mutable requests to proceed. - :return: ProcessorEntity - If the method is called asynchronously, - returns the request thread. + Returns the response data along with HTTP status code, headers, and other metadata. + For just the response data, use the corresponding ``delete_processor()`` method instead. + + Args: + id (str): + The processor 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.ProcessorEntity`, status_code, headers) - Response data with HTTP details. """ all_params = ['id', 'version', 'client_id', 'disconnected_node_acknowledged'] - all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -323,7 +298,10 @@ def delete_processor_with_http_info(self, id, **kwargs): if ('id' not in params) or (params['id'] is None): raise ValueError("Missing the required parameter `id` when calling `delete_processor`") - + + + + collection_formats = {} path_params = {} @@ -348,12 +326,8 @@ def delete_processor_with_http_info(self, id, **kwargs): header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['*/*']) - # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/processors/{id}', 'DELETE', path_params, @@ -364,62 +338,60 @@ def delete_processor_with_http_info(self, id, **kwargs): files=local_var_files, response_type='ProcessorEntity', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def delete_verification_request(self, id, request_id, **kwargs): + def delete_verification_request2(self, id, request_id, **kwargs): """ - Deletes the Verification Request with the given ID + Deletes the Verification Request with the given ID. + Deletes the Verification Request with the given ID. After a request is created, it is expected that the client will properly clean up the request by DELETE'ing it, once the Verification process has completed. If the request is deleted before the request completes, then the Verification request will finish the step that it is currently performing and then will cancel any subsequent steps. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.delete_verification_request(id, request_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The ID of the Processor (required) - :param str request_id: The ID of the Verification Request (required) - :return: VerifyConfigRequestEntity - If the method is called asynchronously, - returns the request thread. + + 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_verification_request2_with_http_info()`` method instead. + + Args: + id (str): + The ID of the Processor (required) + request_id (str): + The ID of the Verification Request (required) + + Returns: + :class:`~nipyapi.nifi.models.VerifyConfigRequestEntity`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.delete_verification_request_with_http_info(id, request_id, **kwargs) + return self.delete_verification_request2_with_http_info(id, request_id, **kwargs) else: - (data) = self.delete_verification_request_with_http_info(id, request_id, **kwargs) + (data) = self.delete_verification_request2_with_http_info(id, request_id, **kwargs) return data - def delete_verification_request_with_http_info(self, id, request_id, **kwargs): + def delete_verification_request2_with_http_info(self, id, request_id, **kwargs): """ - Deletes the Verification Request with the given ID + Deletes the Verification Request with the given ID. + Deletes the Verification Request with the given ID. After a request is created, it is expected that the client will properly clean up the request by DELETE'ing it, once the Verification process has completed. If the request is deleted before the request completes, then the Verification request will finish the step that it is currently performing and then will cancel any subsequent steps. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.delete_verification_request_with_http_info(id, request_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The ID of the Processor (required) - :param str request_id: The ID of the Verification Request (required) - :return: VerifyConfigRequestEntity - If the method is called asynchronously, - returns the request thread. + + 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_verification_request2()`` method instead. + + Args: + id (str): + The ID of the Processor (required) + request_id (str): + The ID of the Verification Request (required) + + Returns: + tuple: (:class:`~nipyapi.nifi.models.VerifyConfigRequestEntity`, status_code, headers) - Response data with HTTP details. """ all_params = ['id', 'request_id'] - all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -429,18 +401,19 @@ def delete_verification_request_with_http_info(self, id, request_id, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method delete_verification_request" % key + " to method delete_verification_request2" % 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_verification_request`") + raise ValueError("Missing the required parameter `id` when calling `delete_verification_request2`") # 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_verification_request`") - + raise ValueError("Missing the required parameter `request_id` when calling `delete_verification_request2`") + + collection_formats = {} path_params = {} @@ -461,12 +434,8 @@ def delete_verification_request_with_http_info(self, id, request_id, **kwargs): header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['*/*']) - # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/processors/{id}/config/verification-requests/{requestId}', 'DELETE', path_params, @@ -477,7 +446,6 @@ def delete_verification_request_with_http_info(self, id, request_id, **kwargs): files=local_var_files, response_type='VerifyConfigRequestEntity', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), @@ -485,22 +453,18 @@ def delete_verification_request_with_http_info(self, id, request_id, **kwargs): def get_processor(self, id, **kwargs): """ - Gets a processor + Gets a processor. + 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_processor_with_http_info()`` method instead. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_processor(id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The processor id. (required) - :return: ProcessorEntity - If the method is called asynchronously, - returns the request thread. + Args: + id (str): + The processor id. (required) + + Returns: + :class:`~nipyapi.nifi.models.ProcessorEntity`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): @@ -511,26 +475,21 @@ def get_processor(self, id, **kwargs): def get_processor_with_http_info(self, id, **kwargs): """ - Gets a processor + Gets a processor. + This method makes a synchronous HTTP request and returns detailed response information. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_processor_with_http_info(id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The processor id. (required) - :return: ProcessorEntity - If the method is called asynchronously, - returns the request thread. + Returns the response data along with HTTP status code, headers, and other metadata. + For just the response data, use the corresponding ``get_processor()`` method instead. + + Args: + id (str): + The processor id. (required) + + Returns: + tuple: (:class:`~nipyapi.nifi.models.ProcessorEntity`, status_code, headers) - Response data with HTTP details. """ all_params = ['id'] - all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -548,7 +507,7 @@ def get_processor_with_http_info(self, id, **kwargs): if ('id' not in params) or (params['id'] is None): raise ValueError("Missing the required parameter `id` when calling `get_processor`") - + collection_formats = {} path_params = {} @@ -567,12 +526,8 @@ def get_processor_with_http_info(self, id, **kwargs): header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['*/*']) - # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/processors/{id}', 'GET', path_params, @@ -583,7 +538,6 @@ def get_processor_with_http_info(self, id, **kwargs): files=local_var_files, response_type='ProcessorEntity', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), @@ -591,22 +545,21 @@ def get_processor_with_http_info(self, id, **kwargs): def get_processor_diagnostics(self, id, **kwargs): """ - Gets diagnostics information about a processor + Gets diagnostics information about a processor. + Note: This endpoint is subject to change as NiFi and it's REST API evolve. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_processor_diagnostics(id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The processor id. (required) - :return: ProcessorEntity - If the method is called asynchronously, - returns the request thread. + + 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_processor_diagnostics_with_http_info()`` method instead. + + Args: + id (str): + The processor id. (required) + + Returns: + :class:`~nipyapi.nifi.models.ProcessorEntity`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): @@ -617,26 +570,24 @@ def get_processor_diagnostics(self, id, **kwargs): def get_processor_diagnostics_with_http_info(self, id, **kwargs): """ - Gets diagnostics information about a processor + Gets diagnostics information about a processor. + Note: This endpoint is subject to change as NiFi and it's REST API evolve. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_processor_diagnostics_with_http_info(id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The processor id. (required) - :return: ProcessorEntity - If the method is called asynchronously, - returns the request thread. + + 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_processor_diagnostics()`` method instead. + + Args: + id (str): + The processor id. (required) + + Returns: + tuple: (:class:`~nipyapi.nifi.models.ProcessorEntity`, status_code, headers) - Response data with HTTP details. """ all_params = ['id'] - all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -654,7 +605,7 @@ def get_processor_diagnostics_with_http_info(self, id, **kwargs): if ('id' not in params) or (params['id'] is None): raise ValueError("Missing the required parameter `id` when calling `get_processor_diagnostics`") - + collection_formats = {} path_params = {} @@ -673,12 +624,8 @@ def get_processor_diagnostics_with_http_info(self, id, **kwargs): header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['*/*']) - # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/processors/{id}/diagnostics', 'GET', path_params, @@ -689,7 +636,6 @@ def get_processor_diagnostics_with_http_info(self, id, **kwargs): files=local_var_files, response_type='ProcessorEntity', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), @@ -697,22 +643,18 @@ def get_processor_diagnostics_with_http_info(self, id, **kwargs): def get_processor_run_status_details(self, **kwargs): """ - Submits a query to retrieve the run status details of all processors that are in the given list of Processor IDs + Submits a query to retrieve the run status details of all processors that are in the given list of Processor IDs. + This method makes a synchronous HTTP request and returns the response data directly. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_processor_run_status_details(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param RunStatusDetailsRequestEntity body: The request for the processors that should be included in the results - :return: ProcessorsRunStatusDetailsEntity - If the method is called asynchronously, - returns the request thread. + For full HTTP response details (status code, headers, etc.), use the corresponding + ``get_processor_run_status_details_with_http_info()`` method instead. + + Args: + body (:class:`~nipyapi.nifi.models.RunStatusDetailsRequestEntity`): + The request for the processors that should be included in the results + + Returns: + :class:`~nipyapi.nifi.models.ProcessorsRunStatusDetailsEntity`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): @@ -723,26 +665,21 @@ def get_processor_run_status_details(self, **kwargs): def get_processor_run_status_details_with_http_info(self, **kwargs): """ - Submits a query to retrieve the run status details of all processors that are in the given list of Processor IDs + Submits a query to retrieve the run status details of all processors that are in the given list of Processor IDs. + This method makes a synchronous HTTP request 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_processor_run_status_details()`` method instead. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_processor_run_status_details_with_http_info(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param RunStatusDetailsRequestEntity body: The request for the processors that should be included in the results - :return: ProcessorsRunStatusDetailsEntity - If the method is called asynchronously, - returns the request thread. + Args: + body (:class:`~nipyapi.nifi.models.RunStatusDetailsRequestEntity`): + The request for the processors that should be included in the results + + Returns: + tuple: (:class:`~nipyapi.nifi.models.ProcessorsRunStatusDetailsEntity`, status_code, headers) - Response data with HTTP details. """ all_params = ['body'] - all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -757,7 +694,7 @@ def get_processor_run_status_details_with_http_info(self, **kwargs): params[key] = val del params['kwargs'] - + collection_formats = {} path_params = {} @@ -781,7 +718,7 @@ def get_processor_run_status_details_with_http_info(self, **kwargs): select_header_content_type(['application/json']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/processors/run-status-details/queries', 'POST', path_params, @@ -792,66 +729,62 @@ def get_processor_run_status_details_with_http_info(self, **kwargs): files=local_var_files, response_type='ProcessorsRunStatusDetailsEntity', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def get_property_descriptor(self, id, property_name, **kwargs): + def get_property_descriptor3(self, id, property_name, **kwargs): """ - Gets the descriptor for a processor property + Gets the descriptor for a processor property. + 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_property_descriptor3_with_http_info()`` method instead. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_property_descriptor(id, property_name, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The processor id. (required) - :param str property_name: The property name. (required) - :param str client_id: If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response. - :param bool sensitive: Property Descriptor requested sensitive status - :return: PropertyDescriptorEntity - If the method is called asynchronously, - returns the request thread. + Args: + id (str): + The processor id. (required) + property_name (str): + The property name. (required) + 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. + sensitive (bool): + Property Descriptor requested sensitive status + + Returns: + :class:`~nipyapi.nifi.models.PropertyDescriptorEntity`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.get_property_descriptor_with_http_info(id, property_name, **kwargs) + return self.get_property_descriptor3_with_http_info(id, property_name, **kwargs) else: - (data) = self.get_property_descriptor_with_http_info(id, property_name, **kwargs) + (data) = self.get_property_descriptor3_with_http_info(id, property_name, **kwargs) return data - def get_property_descriptor_with_http_info(self, id, property_name, **kwargs): + def get_property_descriptor3_with_http_info(self, id, property_name, **kwargs): """ - Gets the descriptor for a processor property + Gets the descriptor for a processor property. + This method makes a synchronous HTTP request and returns detailed response information. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_property_descriptor_with_http_info(id, property_name, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The processor id. (required) - :param str property_name: The property name. (required) - :param str client_id: If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response. - :param bool sensitive: Property Descriptor requested sensitive status - :return: PropertyDescriptorEntity - If the method is called asynchronously, - returns the request thread. + Returns the response data along with HTTP status code, headers, and other metadata. + For just the response data, use the corresponding ``get_property_descriptor3()`` method instead. + + Args: + id (str): + The processor id. (required) + property_name (str): + The property name. (required) + 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. + sensitive (bool): + Property Descriptor requested sensitive status + + Returns: + tuple: (:class:`~nipyapi.nifi.models.PropertyDescriptorEntity`, status_code, headers) - Response data with HTTP details. """ all_params = ['id', 'property_name', 'client_id', 'sensitive'] - all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -861,18 +794,21 @@ def get_property_descriptor_with_http_info(self, id, property_name, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method get_property_descriptor" % key + " to method get_property_descriptor3" % 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_property_descriptor`") + raise ValueError("Missing the required parameter `id` when calling `get_property_descriptor3`") # verify the required parameter 'property_name' is set if ('property_name' not in params) or (params['property_name'] is None): - raise ValueError("Missing the required parameter `property_name` when calling `get_property_descriptor`") - + raise ValueError("Missing the required parameter `property_name` when calling `get_property_descriptor3`") + + + + collection_formats = {} path_params = {} @@ -897,12 +833,8 @@ def get_property_descriptor_with_http_info(self, id, property_name, **kwargs): header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['*/*']) - # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/processors/{id}/descriptors', 'GET', path_params, @@ -913,60 +845,50 @@ def get_property_descriptor_with_http_info(self, id, property_name, **kwargs): files=local_var_files, response_type='PropertyDescriptorEntity', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def get_state(self, id, **kwargs): + def get_state2(self, id, **kwargs): """ - Gets the state for a processor + Gets the state for a processor. + This method makes a synchronous HTTP request and returns the response data directly. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_state(id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The processor id. (required) - :return: ComponentStateEntity - If the method is called asynchronously, - returns the request thread. + For full HTTP response details (status code, headers, etc.), use the corresponding + ``get_state2_with_http_info()`` method instead. + + Args: + 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_state_with_http_info(id, **kwargs) + return self.get_state2_with_http_info(id, **kwargs) else: - (data) = self.get_state_with_http_info(id, **kwargs) + (data) = self.get_state2_with_http_info(id, **kwargs) return data - def get_state_with_http_info(self, id, **kwargs): + def get_state2_with_http_info(self, id, **kwargs): """ - Gets the state for a processor + Gets the state for a processor. + 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_state2()`` method instead. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_state_with_http_info(id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The processor id. (required) - :return: ComponentStateEntity - If the method is called asynchronously, - returns the request thread. + Args: + id (str): + The processor id. (required) + + Returns: + tuple: (:class:`~nipyapi.nifi.models.ComponentStateEntity`, status_code, headers) - Response data with HTTP details. """ all_params = ['id'] - all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -976,15 +898,15 @@ def get_state_with_http_info(self, id, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method get_state" % key + " to method get_state2" % key ) params[key] = val del params['kwargs'] # verify the required parameter 'id' is set if ('id' not in params) or (params['id'] is None): - raise ValueError("Missing the required parameter `id` when calling `get_state`") - + raise ValueError("Missing the required parameter `id` when calling `get_state2`") + collection_formats = {} path_params = {} @@ -1003,12 +925,8 @@ def get_state_with_http_info(self, id, **kwargs): header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['*/*']) - # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/processors/{id}/state', 'GET', path_params, @@ -1019,62 +937,60 @@ def get_state_with_http_info(self, id, **kwargs): files=local_var_files, response_type='ComponentStateEntity', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def get_verification_request(self, id, request_id, **kwargs): + def get_verification_request2(self, id, request_id, **kwargs): """ - Returns the Verification Request with the given ID + Returns the Verification Request with the given ID. + Returns the Verification Request with the given ID. Once an Verification Request has been created, that request can subsequently be retrieved via this endpoint, and the request that is fetched will contain the updated state, such as percent complete, the current state of the request, and any failures. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_verification_request(id, request_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The ID of the Processor (required) - :param str request_id: The ID of the Verification Request (required) - :return: VerifyConfigRequestEntity - If the method is called asynchronously, - returns the request thread. + + 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_verification_request2_with_http_info()`` method instead. + + Args: + id (str): + The ID of the Processor (required) + request_id (str): + The ID of the Verification Request (required) + + Returns: + :class:`~nipyapi.nifi.models.VerifyConfigRequestEntity`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.get_verification_request_with_http_info(id, request_id, **kwargs) + return self.get_verification_request2_with_http_info(id, request_id, **kwargs) else: - (data) = self.get_verification_request_with_http_info(id, request_id, **kwargs) + (data) = self.get_verification_request2_with_http_info(id, request_id, **kwargs) return data - def get_verification_request_with_http_info(self, id, request_id, **kwargs): + def get_verification_request2_with_http_info(self, id, request_id, **kwargs): """ - Returns the Verification Request with the given ID + Returns the Verification Request with the given ID. + Returns the Verification Request with the given ID. Once an Verification Request has been created, that request can subsequently be retrieved via this endpoint, and the request that is fetched will contain the updated state, such as percent complete, the current state of the request, and any failures. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_verification_request_with_http_info(id, request_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The ID of the Processor (required) - :param str request_id: The ID of the Verification Request (required) - :return: VerifyConfigRequestEntity - If the method is called asynchronously, - returns the request thread. + + 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_verification_request2()`` method instead. + + Args: + id (str): + The ID of the Processor (required) + request_id (str): + The ID of the Verification Request (required) + + Returns: + tuple: (:class:`~nipyapi.nifi.models.VerifyConfigRequestEntity`, status_code, headers) - Response data with HTTP details. """ all_params = ['id', 'request_id'] - all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -1084,18 +1000,19 @@ def get_verification_request_with_http_info(self, id, request_id, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method get_verification_request" % key + " to method get_verification_request2" % 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_verification_request`") + raise ValueError("Missing the required parameter `id` when calling `get_verification_request2`") # 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_verification_request`") - + raise ValueError("Missing the required parameter `request_id` when calling `get_verification_request2`") + + collection_formats = {} path_params = {} @@ -1116,12 +1033,8 @@ def get_verification_request_with_http_info(self, id, request_id, **kwargs): header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['*/*']) - # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/processors/{id}/config/verification-requests/{requestId}', 'GET', path_params, @@ -1132,62 +1045,60 @@ def get_verification_request_with_http_info(self, id, request_id, **kwargs): files=local_var_files, response_type='VerifyConfigRequestEntity', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def submit_processor_verification_request(self, id, body, **kwargs): + def submit_processor_verification_request(self, body, id, **kwargs): """ - Performs verification of the Processor's configuration + Performs verification of the Processor's configuration. + This will initiate the process of verifying a given Processor configuration. This may be a long-running task. As a result, this endpoint will immediately return a ProcessorConfigVerificationRequestEntity, and the process of performing the verification will occur asynchronously in the background. The client may then periodically poll the status of the request by issuing a GET request to /processors/{processorId}/verification-requests/{requestId}. Once the request is completed, the client is expected to issue a DELETE request to /processors/{processorId}/verification-requests/{requestId}. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.submit_processor_verification_request(id, body, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The processor id. (required) - :param VerifyConfigRequestEntity body: The processor configuration verification request. (required) - :return: VerifyConfigRequestEntity - If the method is called asynchronously, - returns the request thread. + + 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_verification_request_with_http_info()`` method instead. + + Args: + body (:class:`~nipyapi.nifi.models.VerifyConfigRequestEntity`): + The processor configuration verification request. (required) + id (str): + The processor id. (required) + + Returns: + :class:`~nipyapi.nifi.models.VerifyConfigRequestEntity`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.submit_processor_verification_request_with_http_info(id, body, **kwargs) + return self.submit_processor_verification_request_with_http_info(body, id, **kwargs) else: - (data) = self.submit_processor_verification_request_with_http_info(id, body, **kwargs) + (data) = self.submit_processor_verification_request_with_http_info(body, id, **kwargs) return data - def submit_processor_verification_request_with_http_info(self, id, body, **kwargs): + def submit_processor_verification_request_with_http_info(self, body, id, **kwargs): """ - Performs verification of the Processor's configuration + Performs verification of the Processor's configuration. + This will initiate the process of verifying a given Processor configuration. This may be a long-running task. As a result, this endpoint will immediately return a ProcessorConfigVerificationRequestEntity, and the process of performing the verification will occur asynchronously in the background. The client may then periodically poll the status of the request by issuing a GET request to /processors/{processorId}/verification-requests/{requestId}. Once the request is completed, the client is expected to issue a DELETE request to /processors/{processorId}/verification-requests/{requestId}. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.submit_processor_verification_request_with_http_info(id, body, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The processor id. (required) - :param VerifyConfigRequestEntity body: The processor configuration verification request. (required) - :return: VerifyConfigRequestEntity - If the method is called asynchronously, - returns the request thread. + + 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_verification_request()`` method instead. + + Args: + body (:class:`~nipyapi.nifi.models.VerifyConfigRequestEntity`): + The processor configuration verification request. (required) + id (str): + The processor id. (required) + + Returns: + tuple: (:class:`~nipyapi.nifi.models.VerifyConfigRequestEntity`, status_code, headers) - Response data with HTTP details. """ - all_params = ['id', 'body'] - all_params.append('callback') + all_params = ['body', 'id'] all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -1201,14 +1112,15 @@ def submit_processor_verification_request_with_http_info(self, id, body, **kwarg ) 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_verification_request`") # verify the required parameter 'body' is set if ('body' not in params) or (params['body'] is None): raise ValueError("Missing the required parameter `body` when calling `submit_processor_verification_request`") + # verify the required parameter 'id' is set + if ('id' not in params) or (params['id'] is None): + raise ValueError("Missing the required parameter `id` when calling `submit_processor_verification_request`") - + + collection_formats = {} path_params = {} @@ -1234,7 +1146,7 @@ def submit_processor_verification_request_with_http_info(self, id, body, **kwarg select_header_content_type(['application/json']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/processors/{id}/config/verification-requests', 'POST', path_params, @@ -1245,7 +1157,6 @@ def submit_processor_verification_request_with_http_info(self, id, body, **kwarg files=local_var_files, response_type='VerifyConfigRequestEntity', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), @@ -1253,22 +1164,18 @@ def submit_processor_verification_request_with_http_info(self, id, body, **kwarg def terminate_processor(self, id, **kwargs): """ - Terminates a processor, essentially \"deleting\" its threads and any active tasks + Terminates a processor, essentially \"deleting\" its threads and any 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 + ``terminate_processor_with_http_info()`` method instead. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.terminate_processor(id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The processor id. (required) - :return: ProcessorEntity - If the method is called asynchronously, - returns the request thread. + Args: + id (str): + The processor id. (required) + + Returns: + :class:`~nipyapi.nifi.models.ProcessorEntity`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): @@ -1279,26 +1186,21 @@ def terminate_processor(self, id, **kwargs): def terminate_processor_with_http_info(self, id, **kwargs): """ - Terminates a processor, essentially \"deleting\" its threads and any active tasks + Terminates a processor, essentially \"deleting\" its threads and any active tasks. + This method makes a synchronous HTTP request and returns detailed response information. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.terminate_processor_with_http_info(id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The processor id. (required) - :return: ProcessorEntity - If the method is called asynchronously, - returns the request thread. + Returns the response data along with HTTP status code, headers, and other metadata. + For just the response data, use the corresponding ``terminate_processor()`` method instead. + + Args: + id (str): + The processor id. (required) + + Returns: + tuple: (:class:`~nipyapi.nifi.models.ProcessorEntity`, status_code, headers) - Response data with HTTP details. """ all_params = ['id'] - all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -1316,7 +1218,7 @@ def terminate_processor_with_http_info(self, id, **kwargs): if ('id' not in params) or (params['id'] is None): raise ValueError("Missing the required parameter `id` when calling `terminate_processor`") - + collection_formats = {} path_params = {} @@ -1335,12 +1237,8 @@ def terminate_processor_with_http_info(self, id, **kwargs): header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['*/*']) - # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/processors/{id}/threads', 'DELETE', path_params, @@ -1351,62 +1249,54 @@ def terminate_processor_with_http_info(self, id, **kwargs): files=local_var_files, response_type='ProcessorEntity', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def update_processor(self, id, body, **kwargs): + def update_processor(self, body, id, **kwargs): """ - Updates a processor + Updates a processor. + 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 + ``update_processor_with_http_info()`` method instead. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.update_processor(id, body, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The processor id. (required) - :param ProcessorEntity body: The processor configuration details. (required) - :return: ProcessorEntity - If the method is called asynchronously, - returns the request thread. + Args: + body (:class:`~nipyapi.nifi.models.ProcessorEntity`): + The processor configuration details. (required) + id (str): + The processor id. (required) + + Returns: + :class:`~nipyapi.nifi.models.ProcessorEntity`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.update_processor_with_http_info(id, body, **kwargs) + return self.update_processor_with_http_info(body, id, **kwargs) else: - (data) = self.update_processor_with_http_info(id, body, **kwargs) + (data) = self.update_processor_with_http_info(body, id, **kwargs) return data - def update_processor_with_http_info(self, id, body, **kwargs): + def update_processor_with_http_info(self, body, id, **kwargs): """ - Updates a processor + Updates a processor. + 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 ``update_processor()`` method instead. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.update_processor_with_http_info(id, body, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The processor id. (required) - :param ProcessorEntity body: The processor configuration details. (required) - :return: ProcessorEntity - If the method is called asynchronously, - returns the request thread. + Args: + body (:class:`~nipyapi.nifi.models.ProcessorEntity`): + The processor configuration details. (required) + id (str): + The processor id. (required) + + Returns: + tuple: (:class:`~nipyapi.nifi.models.ProcessorEntity`, status_code, headers) - Response data with HTTP details. """ - all_params = ['id', 'body'] - all_params.append('callback') + all_params = ['body', 'id'] all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -1420,14 +1310,15 @@ def update_processor_with_http_info(self, id, body, **kwargs): ) params[key] = val del params['kwargs'] - # verify the required parameter 'id' is set - if ('id' not in params) or (params['id'] is None): - raise ValueError("Missing the required parameter `id` when calling `update_processor`") # verify the required parameter 'body' is set if ('body' not in params) or (params['body'] is None): raise ValueError("Missing the required parameter `body` when calling `update_processor`") + # verify the required parameter 'id' is set + if ('id' not in params) or (params['id'] is None): + raise ValueError("Missing the required parameter `id` when calling `update_processor`") - + + collection_formats = {} path_params = {} @@ -1453,7 +1344,7 @@ def update_processor_with_http_info(self, id, body, **kwargs): select_header_content_type(['application/json']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/processors/{id}', 'PUT', path_params, @@ -1464,62 +1355,54 @@ def update_processor_with_http_info(self, id, body, **kwargs): files=local_var_files, response_type='ProcessorEntity', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def update_run_status(self, id, body, **kwargs): + def update_run_status4(self, body, id, **kwargs): """ - Updates run status of a processor + Updates run status of a processor. + This method makes a synchronous HTTP request and returns the response data directly. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.update_run_status(id, body, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The processor id. (required) - :param ProcessorRunStatusEntity body: The processor run status. (required) - :return: ProcessorEntity - If the method is called asynchronously, - returns the request thread. + For full HTTP response details (status code, headers, etc.), use the corresponding + ``update_run_status4_with_http_info()`` method instead. + + Args: + body (:class:`~nipyapi.nifi.models.ProcessorRunStatusEntity`): + The processor run status. (required) + id (str): + The processor id. (required) + + Returns: + :class:`~nipyapi.nifi.models.ProcessorEntity`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.update_run_status_with_http_info(id, body, **kwargs) + return self.update_run_status4_with_http_info(body, id, **kwargs) else: - (data) = self.update_run_status_with_http_info(id, body, **kwargs) + (data) = self.update_run_status4_with_http_info(body, id, **kwargs) return data - def update_run_status_with_http_info(self, id, body, **kwargs): + def update_run_status4_with_http_info(self, body, id, **kwargs): """ - Updates run status of a processor + Updates run status of a processor. + 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 ``update_run_status4()`` method instead. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.update_run_status_with_http_info(id, body, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The processor id. (required) - :param ProcessorRunStatusEntity body: The processor run status. (required) - :return: ProcessorEntity - If the method is called asynchronously, - returns the request thread. + Args: + body (:class:`~nipyapi.nifi.models.ProcessorRunStatusEntity`): + The processor run status. (required) + id (str): + The processor id. (required) + + Returns: + tuple: (:class:`~nipyapi.nifi.models.ProcessorEntity`, status_code, headers) - Response data with HTTP details. """ - all_params = ['id', 'body'] - all_params.append('callback') + all_params = ['body', 'id'] all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -1529,18 +1412,19 @@ def update_run_status_with_http_info(self, id, body, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method update_run_status" % key + " to method update_run_status4" % key ) params[key] = val del params['kwargs'] - # verify the required parameter 'id' is set - if ('id' not in params) or (params['id'] is None): - raise ValueError("Missing the required parameter `id` when calling `update_run_status`") # verify the required parameter 'body' is set if ('body' not in params) or (params['body'] is None): - raise ValueError("Missing the required parameter `body` when calling `update_run_status`") - + raise ValueError("Missing the required parameter `body` when calling `update_run_status4`") + # verify the required parameter 'id' is set + if ('id' not in params) or (params['id'] is None): + raise ValueError("Missing the required parameter `id` when calling `update_run_status4`") + + collection_formats = {} path_params = {} @@ -1566,7 +1450,7 @@ def update_run_status_with_http_info(self, id, body, **kwargs): select_header_content_type(['application/json']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/processors/{id}/run-status', 'PUT', path_params, @@ -1577,7 +1461,6 @@ def update_run_status_with_http_info(self, id, body, **kwargs): files=local_var_files, response_type='ProcessorEntity', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), diff --git a/nipyapi/nifi/apis/provenance_api.py b/nipyapi/nifi/apis/provenance_api.py index 1df05e1f..13b89171 100644 --- a/nipyapi/nifi/apis/provenance_api.py +++ b/nipyapi/nifi/apis/provenance_api.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - import sys import os import re @@ -35,23 +34,20 @@ def __init__(self, api_client=None): def delete_lineage(self, id, **kwargs): """ - Deletes a lineage query + Deletes a lineage query. + 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_lineage_with_http_info()`` method instead. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.delete_lineage(id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The id of the lineage query. (required) - :param str cluster_node_id: The id of the node where this query exists if clustered. - :return: LineageEntity - If the method is called asynchronously, - returns the request thread. + Args: + id (str): + The id of the lineage query. (required) + cluster_node_id (str): + The id of the node where this query exists if clustered. + + Returns: + :class:`~nipyapi.nifi.models.LineageEntity`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): @@ -62,27 +58,23 @@ def delete_lineage(self, id, **kwargs): def delete_lineage_with_http_info(self, id, **kwargs): """ - Deletes a lineage query + Deletes a lineage query. + 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_lineage()`` method instead. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.delete_lineage_with_http_info(id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The id of the lineage query. (required) - :param str cluster_node_id: The id of the node where this query exists if clustered. - :return: LineageEntity - If the method is called asynchronously, - returns the request thread. + Args: + id (str): + The id of the lineage query. (required) + cluster_node_id (str): + The id of the node where this query exists if clustered. + + Returns: + tuple: (:class:`~nipyapi.nifi.models.LineageEntity`, status_code, headers) - Response data with HTTP details. """ all_params = ['id', 'cluster_node_id'] - all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -100,7 +92,8 @@ def delete_lineage_with_http_info(self, id, **kwargs): if ('id' not in params) or (params['id'] is None): raise ValueError("Missing the required parameter `id` when calling `delete_lineage`") - + + collection_formats = {} path_params = {} @@ -121,12 +114,8 @@ def delete_lineage_with_http_info(self, id, **kwargs): header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['*/*']) - # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/provenance/lineage/{id}', 'DELETE', path_params, @@ -137,7 +126,6 @@ def delete_lineage_with_http_info(self, id, **kwargs): files=local_var_files, response_type='LineageEntity', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), @@ -145,23 +133,20 @@ def delete_lineage_with_http_info(self, id, **kwargs): def delete_provenance(self, id, **kwargs): """ - Deletes a provenance query + Deletes a provenance query. + 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_provenance_with_http_info()`` method instead. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.delete_provenance(id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The id of the provenance query. (required) - :param str cluster_node_id: The id of the node where this query exists if clustered. - :return: ProvenanceEntity - If the method is called asynchronously, - returns the request thread. + Args: + id (str): + The id of the provenance query. (required) + cluster_node_id (str): + The id of the node where this query exists if clustered. + + Returns: + :class:`~nipyapi.nifi.models.ProvenanceEntity`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): @@ -172,27 +157,23 @@ def delete_provenance(self, id, **kwargs): def delete_provenance_with_http_info(self, id, **kwargs): """ - Deletes a provenance query + Deletes a provenance query. + 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_provenance()`` method instead. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.delete_provenance_with_http_info(id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The id of the provenance query. (required) - :param str cluster_node_id: The id of the node where this query exists if clustered. - :return: ProvenanceEntity - If the method is called asynchronously, - returns the request thread. + Args: + id (str): + The id of the provenance query. (required) + cluster_node_id (str): + The id of the node where this query exists if clustered. + + Returns: + tuple: (:class:`~nipyapi.nifi.models.ProvenanceEntity`, status_code, headers) - Response data with HTTP details. """ all_params = ['id', 'cluster_node_id'] - all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -210,7 +191,8 @@ def delete_provenance_with_http_info(self, id, **kwargs): if ('id' not in params) or (params['id'] is None): raise ValueError("Missing the required parameter `id` when calling `delete_provenance`") - + + collection_formats = {} path_params = {} @@ -231,12 +213,8 @@ def delete_provenance_with_http_info(self, id, **kwargs): header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['*/*']) - # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/provenance/{id}', 'DELETE', path_params, @@ -247,7 +225,6 @@ def delete_provenance_with_http_info(self, id, **kwargs): files=local_var_files, response_type='ProvenanceEntity', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), @@ -255,23 +232,20 @@ def delete_provenance_with_http_info(self, id, **kwargs): def get_lineage(self, id, **kwargs): """ - Gets a lineage query + Gets a lineage query. + 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_lineage_with_http_info()`` method instead. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_lineage(id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The id of the lineage query. (required) - :param str cluster_node_id: The id of the node where this query exists if clustered. - :return: LineageEntity - If the method is called asynchronously, - returns the request thread. + Args: + id (str): + The id of the lineage query. (required) + cluster_node_id (str): + The id of the node where this query exists if clustered. + + Returns: + :class:`~nipyapi.nifi.models.LineageEntity`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): @@ -282,27 +256,23 @@ def get_lineage(self, id, **kwargs): def get_lineage_with_http_info(self, id, **kwargs): """ - Gets a lineage query + Gets a lineage query. + 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_lineage()`` method instead. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_lineage_with_http_info(id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The id of the lineage query. (required) - :param str cluster_node_id: The id of the node where this query exists if clustered. - :return: LineageEntity - If the method is called asynchronously, - returns the request thread. + Args: + id (str): + The id of the lineage query. (required) + cluster_node_id (str): + The id of the node where this query exists if clustered. + + Returns: + tuple: (:class:`~nipyapi.nifi.models.LineageEntity`, status_code, headers) - Response data with HTTP details. """ all_params = ['id', 'cluster_node_id'] - all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -320,7 +290,8 @@ def get_lineage_with_http_info(self, id, **kwargs): if ('id' not in params) or (params['id'] is None): raise ValueError("Missing the required parameter `id` when calling `get_lineage`") - + + collection_formats = {} path_params = {} @@ -341,12 +312,8 @@ def get_lineage_with_http_info(self, id, **kwargs): header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['*/*']) - # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/provenance/lineage/{id}', 'GET', path_params, @@ -357,7 +324,6 @@ def get_lineage_with_http_info(self, id, **kwargs): files=local_var_files, response_type='LineageEntity', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), @@ -365,25 +331,24 @@ def get_lineage_with_http_info(self, id, **kwargs): def get_provenance(self, id, **kwargs): """ - Gets a provenance query + Gets a provenance query. + 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_provenance_with_http_info()`` method instead. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_provenance(id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The id of the provenance query. (required) - :param str cluster_node_id: The id of the node where this query exists if clustered. - :param bool summarize: Whether or not incremental results are returned. If false, provenance events are only returned once the query completes. This property is true by default. - :param bool incremental_results: Whether or not to summarize provenance events returned. This property is false by default. - :return: ProvenanceEntity - If the method is called asynchronously, - returns the request thread. + Args: + id (str): + The id of the provenance query. (required) + cluster_node_id (str): + The id of the node where this query exists if clustered. + summarize (bool): + Whether or not incremental results are returned. If false, provenance events are only returned once the query completes. This property is true by default. + incremental_results (bool): + Whether or not to summarize provenance events returned. This property is false by default. + + Returns: + :class:`~nipyapi.nifi.models.ProvenanceEntity`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): @@ -394,29 +359,27 @@ def get_provenance(self, id, **kwargs): def get_provenance_with_http_info(self, id, **kwargs): """ - Gets a provenance query + Gets a provenance query. + 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_provenance()`` method instead. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_provenance_with_http_info(id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The id of the provenance query. (required) - :param str cluster_node_id: The id of the node where this query exists if clustered. - :param bool summarize: Whether or not incremental results are returned. If false, provenance events are only returned once the query completes. This property is true by default. - :param bool incremental_results: Whether or not to summarize provenance events returned. This property is false by default. - :return: ProvenanceEntity - If the method is called asynchronously, - returns the request thread. + Args: + id (str): + The id of the provenance query. (required) + cluster_node_id (str): + The id of the node where this query exists if clustered. + summarize (bool): + Whether or not incremental results are returned. If false, provenance events are only returned once the query completes. This property is true by default. + incremental_results (bool): + Whether or not to summarize provenance events returned. This property is false by default. + + Returns: + tuple: (:class:`~nipyapi.nifi.models.ProvenanceEntity`, status_code, headers) - Response data with HTTP details. """ all_params = ['id', 'cluster_node_id', 'summarize', 'incremental_results'] - all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -434,7 +397,10 @@ def get_provenance_with_http_info(self, id, **kwargs): if ('id' not in params) or (params['id'] is None): raise ValueError("Missing the required parameter `id` when calling `get_provenance`") - + + + + collection_formats = {} path_params = {} @@ -459,12 +425,8 @@ def get_provenance_with_http_info(self, id, **kwargs): header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['*/*']) - # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/provenance/{id}', 'GET', path_params, @@ -475,7 +437,6 @@ def get_provenance_with_http_info(self, id, **kwargs): files=local_var_files, response_type='ProvenanceEntity', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), @@ -483,21 +444,16 @@ def get_provenance_with_http_info(self, id, **kwargs): def get_search_options(self, **kwargs): """ - Gets the searchable attributes for provenance events + Gets the searchable attributes for provenance events. + 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_search_options_with_http_info()`` method instead. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_search_options(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :return: ProvenanceOptionsEntity - If the method is called asynchronously, - returns the request thread. + Args: + + Returns: + :class:`~nipyapi.nifi.models.ProvenanceOptionsEntity`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): @@ -508,25 +464,19 @@ def get_search_options(self, **kwargs): def get_search_options_with_http_info(self, **kwargs): """ - Gets the searchable attributes for provenance events + Gets the searchable attributes for provenance events. + 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_search_options()`` method instead. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_search_options_with_http_info(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :return: ProvenanceOptionsEntity - If the method is called asynchronously, - returns the request thread. + Args: + + Returns: + tuple: (:class:`~nipyapi.nifi.models.ProvenanceOptionsEntity`, status_code, headers) - Response data with HTTP details. """ all_params = [] - all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -557,12 +507,8 @@ def get_search_options_with_http_info(self, **kwargs): header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['*/*']) - # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/provenance/search-options', 'GET', path_params, @@ -573,7 +519,6 @@ def get_search_options_with_http_info(self, **kwargs): files=local_var_files, response_type='ProvenanceOptionsEntity', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), @@ -581,22 +526,21 @@ def get_search_options_with_http_info(self, **kwargs): def submit_lineage_request(self, body, **kwargs): """ - Submits a lineage query + Submits a lineage query. + Lineage queries may be long running so this endpoint submits a request. The response will include the current state of the query. If the request is not completed the URI in the response can be used at a later time to get the updated state of the query. Once the query has completed the lineage request should be deleted by the client who originally submitted it. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.submit_lineage_request(body, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param LineageEntity body: The lineage query details. (required) - :return: LineageEntity - If the method is called asynchronously, - returns the request thread. + + 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_lineage_request_with_http_info()`` method instead. + + Args: + body (:class:`~nipyapi.nifi.models.LineageEntity`): + The lineage query details. (required) + + Returns: + :class:`~nipyapi.nifi.models.LineageEntity`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): @@ -607,26 +551,24 @@ def submit_lineage_request(self, body, **kwargs): def submit_lineage_request_with_http_info(self, body, **kwargs): """ - Submits a lineage query + Submits a lineage query. + Lineage queries may be long running so this endpoint submits a request. The response will include the current state of the query. If the request is not completed the URI in the response can be used at a later time to get the updated state of the query. Once the query has completed the lineage request should be deleted by the client who originally submitted it. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.submit_lineage_request_with_http_info(body, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param LineageEntity body: The lineage query details. (required) - :return: LineageEntity - If the method is called asynchronously, - returns the request thread. + + 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_lineage_request()`` method instead. + + Args: + body (:class:`~nipyapi.nifi.models.LineageEntity`): + The lineage query details. (required) + + Returns: + tuple: (:class:`~nipyapi.nifi.models.LineageEntity`, status_code, headers) - Response data with HTTP details. """ all_params = ['body'] - all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -644,7 +586,7 @@ def submit_lineage_request_with_http_info(self, body, **kwargs): if ('body' not in params) or (params['body'] is None): raise ValueError("Missing the required parameter `body` when calling `submit_lineage_request`") - + collection_formats = {} path_params = {} @@ -668,7 +610,7 @@ def submit_lineage_request_with_http_info(self, body, **kwargs): select_header_content_type(['application/json']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/provenance/lineage', 'POST', path_params, @@ -679,7 +621,6 @@ def submit_lineage_request_with_http_info(self, body, **kwargs): files=local_var_files, response_type='LineageEntity', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), @@ -687,22 +628,21 @@ def submit_lineage_request_with_http_info(self, body, **kwargs): def submit_provenance_request(self, body, **kwargs): """ - Submits a provenance query + Submits a provenance query. + Provenance queries may be long running so this endpoint submits a request. The response will include the current state of the query. If the request is not completed the URI in the response can be used at a later time to get the updated state of the query. Once the query has completed the provenance request should be deleted by the client who originally submitted it. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.submit_provenance_request(body, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param ProvenanceEntity body: The provenance query details. (required) - :return: ProvenanceEntity - If the method is called asynchronously, - returns the request thread. + + 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_provenance_request_with_http_info()`` method instead. + + Args: + body (:class:`~nipyapi.nifi.models.ProvenanceEntity`): + The provenance query details. (required) + + Returns: + :class:`~nipyapi.nifi.models.ProvenanceEntity`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): @@ -713,26 +653,24 @@ def submit_provenance_request(self, body, **kwargs): def submit_provenance_request_with_http_info(self, body, **kwargs): """ - Submits a provenance query + Submits a provenance query. + Provenance queries may be long running so this endpoint submits a request. The response will include the current state of the query. If the request is not completed the URI in the response can be used at a later time to get the updated state of the query. Once the query has completed the provenance request should be deleted by the client who originally submitted it. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.submit_provenance_request_with_http_info(body, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param ProvenanceEntity body: The provenance query details. (required) - :return: ProvenanceEntity - If the method is called asynchronously, - returns the request thread. + + 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_provenance_request()`` method instead. + + Args: + body (:class:`~nipyapi.nifi.models.ProvenanceEntity`): + The provenance query details. (required) + + Returns: + tuple: (:class:`~nipyapi.nifi.models.ProvenanceEntity`, status_code, headers) - Response data with HTTP details. """ all_params = ['body'] - all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -750,7 +688,7 @@ def submit_provenance_request_with_http_info(self, body, **kwargs): if ('body' not in params) or (params['body'] is None): raise ValueError("Missing the required parameter `body` when calling `submit_provenance_request`") - + collection_formats = {} path_params = {} @@ -774,7 +712,7 @@ def submit_provenance_request_with_http_info(self, body, **kwargs): select_header_content_type(['application/json']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/provenance', 'POST', path_params, @@ -785,7 +723,6 @@ def submit_provenance_request_with_http_info(self, body, **kwargs): files=local_var_files, response_type='ProvenanceEntity', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), diff --git a/nipyapi/nifi/apis/provenance_events_api.py b/nipyapi/nifi/apis/provenance_events_api.py index f88e04de..b4b394fd 100644 --- a/nipyapi/nifi/apis/provenance_events_api.py +++ b/nipyapi/nifi/apis/provenance_events_api.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - import sys import os import re @@ -35,23 +34,22 @@ def __init__(self, api_client=None): def get_input_content(self, id, **kwargs): """ - Gets the input content for a provenance event + Gets the input content for a provenance event. + 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_input_content_with_http_info()`` method instead. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_input_content(id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The provenance event id. (required) - :param str cluster_node_id: The id of the node where the content exists if clustered. - :return: StreamingOutput - If the method is called asynchronously, - returns the request thread. + Args: + id (:class:`~nipyapi.nifi.models.LongParameter`): + The provenance event id. (required) + range (str): + Range of bytes requested + cluster_node_id (str): + The id of the node where the content exists if clustered. + + Returns: + :class:`~nipyapi.nifi.models.StreamingOutput`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): @@ -62,27 +60,25 @@ def get_input_content(self, id, **kwargs): def get_input_content_with_http_info(self, id, **kwargs): """ - Gets the input content for a provenance event + Gets the input content for a provenance event. + 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_input_content()`` method instead. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_input_content_with_http_info(id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The provenance event id. (required) - :param str cluster_node_id: The id of the node where the content exists if clustered. - :return: StreamingOutput - If the method is called asynchronously, - returns the request thread. + Args: + id (:class:`~nipyapi.nifi.models.LongParameter`): + The provenance event id. (required) + range (str): + Range of bytes requested + cluster_node_id (str): + The id of the node where the content exists if clustered. + + Returns: + tuple: (:class:`~nipyapi.nifi.models.StreamingOutput`, status_code, headers) - Response data with HTTP details. """ - all_params = ['id', 'cluster_node_id'] - all_params.append('callback') + all_params = ['id', 'range', 'cluster_node_id'] all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -100,7 +96,9 @@ def get_input_content_with_http_info(self, id, **kwargs): if ('id' not in params) or (params['id'] is None): raise ValueError("Missing the required parameter `id` when calling `get_input_content`") - + + + collection_formats = {} path_params = {} @@ -112,6 +110,8 @@ def get_input_content_with_http_info(self, id, **kwargs): query_params.append(('clusterNodeId', params['cluster_node_id'])) header_params = {} + if 'range' in params: + header_params['Range'] = params['range'] form_params = [] local_var_files = {} @@ -121,12 +121,8 @@ def get_input_content_with_http_info(self, id, **kwargs): header_params['Accept'] = self.api_client.\ select_header_accept(['*/*']) - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['*/*']) - # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/provenance-events/{id}/content/input', 'GET', path_params, @@ -137,7 +133,105 @@ def get_input_content_with_http_info(self, id, **kwargs): files=local_var_files, response_type='StreamingOutput', auth_settings=auth_settings, - callback=params.get('callback'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def get_latest_provenance_events(self, component_id, **kwargs): + """ + Retrieves the latest cached Provenance Events for the specified component. + 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_latest_provenance_events_with_http_info()`` method instead. + + Args: + component_id (str): + The ID of the component to retrieve the latest Provenance Events for. (required) + limit (int): + The number of events to limit the response to. Defaults to 10. + + Returns: + :class:`~nipyapi.nifi.models.LatestProvenanceEventsEntity`: The response data. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('callback'): + return self.get_latest_provenance_events_with_http_info(component_id, **kwargs) + else: + (data) = self.get_latest_provenance_events_with_http_info(component_id, **kwargs) + return data + + def get_latest_provenance_events_with_http_info(self, component_id, **kwargs): + """ + Retrieves the latest cached Provenance Events for the specified component. + 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_latest_provenance_events()`` method instead. + + Args: + component_id (str): + The ID of the component to retrieve the latest Provenance Events for. (required) + limit (int): + The number of events to limit the response to. Defaults to 10. + + Returns: + tuple: (:class:`~nipyapi.nifi.models.LatestProvenanceEventsEntity`, status_code, headers) - Response data with HTTP details. + """ + + all_params = ['component_id', 'limit'] + 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_latest_provenance_events" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'component_id' is set + if ('component_id' not in params) or (params['component_id'] is None): + raise ValueError("Missing the required parameter `component_id` when calling `get_latest_provenance_events`") + + + + collection_formats = {} + + path_params = {} + if 'component_id' in params: + path_params['componentId'] = params['component_id'] + + query_params = [] + if 'limit' in params: + query_params.append(('limit', params['limit'])) + + 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('/provenance-events/latest/{componentId}', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='LatestProvenanceEventsEntity', + 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'), @@ -145,23 +239,22 @@ def get_input_content_with_http_info(self, id, **kwargs): def get_output_content(self, id, **kwargs): """ - Gets the output content for a provenance event + Gets the output content for a provenance event. + 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_output_content_with_http_info()`` method instead. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_output_content(id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The provenance event id. (required) - :param str cluster_node_id: The id of the node where the content exists if clustered. - :return: StreamingOutput - If the method is called asynchronously, - returns the request thread. + Args: + id (:class:`~nipyapi.nifi.models.LongParameter`): + The provenance event id. (required) + range (str): + Range of bytes requested + cluster_node_id (str): + The id of the node where the content exists if clustered. + + Returns: + :class:`~nipyapi.nifi.models.StreamingOutput`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): @@ -172,27 +265,25 @@ def get_output_content(self, id, **kwargs): def get_output_content_with_http_info(self, id, **kwargs): """ - Gets the output content for a provenance event + Gets the output content for a provenance event. + This method makes a synchronous HTTP request and returns detailed response information. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_output_content_with_http_info(id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The provenance event id. (required) - :param str cluster_node_id: The id of the node where the content exists if clustered. - :return: StreamingOutput - If the method is called asynchronously, - returns the request thread. + Returns the response data along with HTTP status code, headers, and other metadata. + For just the response data, use the corresponding ``get_output_content()`` method instead. + + Args: + id (:class:`~nipyapi.nifi.models.LongParameter`): + The provenance event id. (required) + range (str): + Range of bytes requested + cluster_node_id (str): + The id of the node where the content exists if clustered. + + Returns: + tuple: (:class:`~nipyapi.nifi.models.StreamingOutput`, status_code, headers) - Response data with HTTP details. """ - all_params = ['id', 'cluster_node_id'] - all_params.append('callback') + all_params = ['id', 'range', 'cluster_node_id'] all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -210,7 +301,9 @@ def get_output_content_with_http_info(self, id, **kwargs): if ('id' not in params) or (params['id'] is None): raise ValueError("Missing the required parameter `id` when calling `get_output_content`") - + + + collection_formats = {} path_params = {} @@ -222,6 +315,8 @@ def get_output_content_with_http_info(self, id, **kwargs): query_params.append(('clusterNodeId', params['cluster_node_id'])) header_params = {} + if 'range' in params: + header_params['Range'] = params['range'] form_params = [] local_var_files = {} @@ -231,12 +326,8 @@ def get_output_content_with_http_info(self, id, **kwargs): header_params['Accept'] = self.api_client.\ select_header_accept(['*/*']) - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['*/*']) - # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/provenance-events/{id}/content/output', 'GET', path_params, @@ -247,7 +338,6 @@ def get_output_content_with_http_info(self, id, **kwargs): files=local_var_files, response_type='StreamingOutput', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), @@ -255,23 +345,20 @@ def get_output_content_with_http_info(self, id, **kwargs): def get_provenance_event(self, id, **kwargs): """ - Gets a provenance event + Gets a provenance event. + This method makes a synchronous HTTP request and returns the response data directly. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_provenance_event(id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The provenance event id. (required) - :param str cluster_node_id: The id of the node where this event exists if clustered. - :return: ProvenanceEventEntity - If the method is called asynchronously, - returns the request thread. + For full HTTP response details (status code, headers, etc.), use the corresponding + ``get_provenance_event_with_http_info()`` method instead. + + Args: + id (:class:`~nipyapi.nifi.models.LongParameter`): + The provenance event id. (required) + cluster_node_id (str): + The id of the node where this event exists if clustered. + + Returns: + :class:`~nipyapi.nifi.models.ProvenanceEventEntity`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): @@ -282,27 +369,23 @@ def get_provenance_event(self, id, **kwargs): def get_provenance_event_with_http_info(self, id, **kwargs): """ - Gets a provenance event + Gets a provenance event. + 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_provenance_event()`` method instead. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_provenance_event_with_http_info(id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The provenance event id. (required) - :param str cluster_node_id: The id of the node where this event exists if clustered. - :return: ProvenanceEventEntity - If the method is called asynchronously, - returns the request thread. + Args: + id (:class:`~nipyapi.nifi.models.LongParameter`): + The provenance event id. (required) + cluster_node_id (str): + The id of the node where this event exists if clustered. + + Returns: + tuple: (:class:`~nipyapi.nifi.models.ProvenanceEventEntity`, status_code, headers) - Response data with HTTP details. """ all_params = ['id', 'cluster_node_id'] - all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -320,7 +403,8 @@ def get_provenance_event_with_http_info(self, id, **kwargs): if ('id' not in params) or (params['id'] is None): raise ValueError("Missing the required parameter `id` when calling `get_provenance_event`") - + + collection_formats = {} path_params = {} @@ -341,12 +425,8 @@ def get_provenance_event_with_http_info(self, id, **kwargs): header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['*/*']) - # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/provenance-events/{id}', 'GET', path_params, @@ -357,7 +437,6 @@ def get_provenance_event_with_http_info(self, id, **kwargs): files=local_var_files, response_type='ProvenanceEventEntity', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), @@ -365,22 +444,18 @@ def get_provenance_event_with_http_info(self, id, **kwargs): def submit_replay(self, body, **kwargs): """ - Replays content from a provenance event + Replays content from a provenance event. + 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_replay_with_http_info()`` method instead. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.submit_replay(body, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param SubmitReplayRequestEntity body: The replay request. (required) - :return: ProvenanceEventEntity - If the method is called asynchronously, - returns the request thread. + Args: + body (:class:`~nipyapi.nifi.models.SubmitReplayRequestEntity`): + The replay request. (required) + + Returns: + :class:`~nipyapi.nifi.models.ProvenanceEventEntity`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): @@ -391,26 +466,21 @@ def submit_replay(self, body, **kwargs): def submit_replay_with_http_info(self, body, **kwargs): """ - Replays content from a provenance event + Replays content from a provenance event. + This method makes a synchronous HTTP request and returns detailed response information. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.submit_replay_with_http_info(body, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param SubmitReplayRequestEntity body: The replay request. (required) - :return: ProvenanceEventEntity - If the method is called asynchronously, - returns the request thread. + Returns the response data along with HTTP status code, headers, and other metadata. + For just the response data, use the corresponding ``submit_replay()`` method instead. + + Args: + body (:class:`~nipyapi.nifi.models.SubmitReplayRequestEntity`): + The replay request. (required) + + Returns: + tuple: (:class:`~nipyapi.nifi.models.ProvenanceEventEntity`, status_code, headers) - Response data with HTTP details. """ all_params = ['body'] - all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -428,7 +498,7 @@ def submit_replay_with_http_info(self, body, **kwargs): if ('body' not in params) or (params['body'] is None): raise ValueError("Missing the required parameter `body` when calling `submit_replay`") - + collection_formats = {} path_params = {} @@ -452,7 +522,7 @@ def submit_replay_with_http_info(self, body, **kwargs): select_header_content_type(['application/json']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/provenance-events/replays', 'POST', path_params, @@ -463,7 +533,6 @@ def submit_replay_with_http_info(self, body, **kwargs): files=local_var_files, response_type='ProvenanceEventEntity', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), @@ -471,22 +540,18 @@ def submit_replay_with_http_info(self, body, **kwargs): def submit_replay_latest_event(self, body, **kwargs): """ - Replays content from a provenance event + Replays content from a provenance event. + 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_replay_latest_event_with_http_info()`` method instead. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.submit_replay_latest_event(body, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param ReplayLastEventRequestEntity body: The replay request. (required) - :return: ReplayLastEventResponseEntity - If the method is called asynchronously, - returns the request thread. + Args: + body (:class:`~nipyapi.nifi.models.ReplayLastEventRequestEntity`): + The replay request. (required) + + Returns: + :class:`~nipyapi.nifi.models.ReplayLastEventResponseEntity`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): @@ -497,26 +562,21 @@ def submit_replay_latest_event(self, body, **kwargs): def submit_replay_latest_event_with_http_info(self, body, **kwargs): """ - Replays content from a provenance event + Replays content from a provenance event. + This method makes a synchronous HTTP request and returns detailed response information. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.submit_replay_latest_event_with_http_info(body, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param ReplayLastEventRequestEntity body: The replay request. (required) - :return: ReplayLastEventResponseEntity - If the method is called asynchronously, - returns the request thread. + Returns the response data along with HTTP status code, headers, and other metadata. + For just the response data, use the corresponding ``submit_replay_latest_event()`` method instead. + + Args: + body (:class:`~nipyapi.nifi.models.ReplayLastEventRequestEntity`): + The replay request. (required) + + Returns: + tuple: (:class:`~nipyapi.nifi.models.ReplayLastEventResponseEntity`, status_code, headers) - Response data with HTTP details. """ all_params = ['body'] - all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -534,7 +594,7 @@ def submit_replay_latest_event_with_http_info(self, body, **kwargs): if ('body' not in params) or (params['body'] is None): raise ValueError("Missing the required parameter `body` when calling `submit_replay_latest_event`") - + collection_formats = {} path_params = {} @@ -558,7 +618,7 @@ def submit_replay_latest_event_with_http_info(self, body, **kwargs): select_header_content_type(['application/json']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/provenance-events/latest/replays', 'POST', path_params, @@ -569,7 +629,6 @@ def submit_replay_latest_event_with_http_info(self, body, **kwargs): files=local_var_files, response_type='ReplayLastEventResponseEntity', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), diff --git a/nipyapi/nifi/apis/remote_process_groups_api.py b/nipyapi/nifi/apis/remote_process_groups_api.py index 1e8129e4..4f556a89 100644 --- a/nipyapi/nifi/apis/remote_process_groups_api.py +++ b/nipyapi/nifi/apis/remote_process_groups_api.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - import sys import os import re @@ -35,22 +34,18 @@ def __init__(self, api_client=None): def get_remote_process_group(self, id, **kwargs): """ - Gets a remote process group + Gets a remote process group. + 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_remote_process_group_with_http_info()`` method instead. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_remote_process_group(id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The remote process group id. (required) - :return: RemoteProcessGroupEntity - If the method is called asynchronously, - returns the request thread. + Args: + id (str): + The remote process group id. (required) + + Returns: + :class:`~nipyapi.nifi.models.RemoteProcessGroupEntity`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): @@ -61,26 +56,21 @@ def get_remote_process_group(self, id, **kwargs): def get_remote_process_group_with_http_info(self, id, **kwargs): """ - Gets a remote process group + Gets a remote process group. + This method makes a synchronous HTTP request and returns detailed response information. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_remote_process_group_with_http_info(id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The remote process group id. (required) - :return: RemoteProcessGroupEntity - If the method is called asynchronously, - returns the request thread. + Returns the response data along with HTTP status code, headers, and other metadata. + For just the response data, use the corresponding ``get_remote_process_group()`` method instead. + + Args: + id (str): + The remote process group id. (required) + + Returns: + tuple: (:class:`~nipyapi.nifi.models.RemoteProcessGroupEntity`, status_code, headers) - Response data with HTTP details. """ all_params = ['id'] - all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -98,7 +88,7 @@ def get_remote_process_group_with_http_info(self, id, **kwargs): if ('id' not in params) or (params['id'] is None): raise ValueError("Missing the required parameter `id` when calling `get_remote_process_group`") - + collection_formats = {} path_params = {} @@ -117,12 +107,8 @@ def get_remote_process_group_with_http_info(self, id, **kwargs): header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['*/*']) - # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/remote-process-groups/{id}', 'GET', path_params, @@ -133,60 +119,50 @@ def get_remote_process_group_with_http_info(self, id, **kwargs): files=local_var_files, response_type='RemoteProcessGroupEntity', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def get_state(self, id, **kwargs): + def get_state3(self, id, **kwargs): """ - Gets the state for a RemoteProcessGroup + Gets the state for a RemoteProcessGroup. + This method makes a synchronous HTTP request and returns the response data directly. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_state(id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The processor id. (required) - :return: ComponentStateEntity - If the method is called asynchronously, - returns the request thread. + For full HTTP response details (status code, headers, etc.), use the corresponding + ``get_state3_with_http_info()`` method instead. + + Args: + 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_state_with_http_info(id, **kwargs) + return self.get_state3_with_http_info(id, **kwargs) else: - (data) = self.get_state_with_http_info(id, **kwargs) + (data) = self.get_state3_with_http_info(id, **kwargs) return data - def get_state_with_http_info(self, id, **kwargs): + def get_state3_with_http_info(self, id, **kwargs): """ - Gets the state for a RemoteProcessGroup + Gets the state for a RemoteProcessGroup. + 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_state3()`` method instead. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_state_with_http_info(id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The processor id. (required) - :return: ComponentStateEntity - If the method is called asynchronously, - returns the request thread. + Args: + id (str): + The processor id. (required) + + Returns: + tuple: (:class:`~nipyapi.nifi.models.ComponentStateEntity`, status_code, headers) - Response data with HTTP details. """ all_params = ['id'] - all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -196,15 +172,15 @@ def get_state_with_http_info(self, id, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method get_state" % key + " to method get_state3" % key ) params[key] = val del params['kwargs'] # verify the required parameter 'id' is set if ('id' not in params) or (params['id'] is None): - raise ValueError("Missing the required parameter `id` when calling `get_state`") - + raise ValueError("Missing the required parameter `id` when calling `get_state3`") + collection_formats = {} path_params = {} @@ -223,12 +199,8 @@ def get_state_with_http_info(self, id, **kwargs): header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['*/*']) - # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/remote-process-groups/{id}/state', 'GET', path_params, @@ -239,7 +211,6 @@ def get_state_with_http_info(self, id, **kwargs): files=local_var_files, response_type='ComponentStateEntity', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), @@ -247,25 +218,24 @@ def get_state_with_http_info(self, id, **kwargs): def remove_remote_process_group(self, id, **kwargs): """ - Deletes a remote process group + Deletes a remote process group. + 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 + ``remove_remote_process_group_with_http_info()`` method instead. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.remove_remote_process_group(id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The remote process group id. (required) - :param str version: The revision is used to verify the client is working with the latest version of the flow. - :param str client_id: If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response. - :param bool disconnected_node_acknowledged: Acknowledges that this node is disconnected to allow for mutable requests to proceed. - :return: RemoteProcessGroupEntity - If the method is called asynchronously, - returns the request thread. + Args: + id (str): + The remote process group 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.RemoteProcessGroupEntity`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): @@ -276,29 +246,27 @@ def remove_remote_process_group(self, id, **kwargs): def remove_remote_process_group_with_http_info(self, id, **kwargs): """ - Deletes a remote process group + Deletes a remote process group. + This method makes a synchronous HTTP request and returns detailed response information. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.remove_remote_process_group_with_http_info(id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The remote process group id. (required) - :param str version: The revision is used to verify the client is working with the latest version of the flow. - :param str client_id: If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response. - :param bool disconnected_node_acknowledged: Acknowledges that this node is disconnected to allow for mutable requests to proceed. - :return: RemoteProcessGroupEntity - If the method is called asynchronously, - returns the request thread. + Returns the response data along with HTTP status code, headers, and other metadata. + For just the response data, use the corresponding ``remove_remote_process_group()`` method instead. + + Args: + id (str): + The remote process group 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.RemoteProcessGroupEntity`, status_code, headers) - Response data with HTTP details. """ all_params = ['id', 'version', 'client_id', 'disconnected_node_acknowledged'] - all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -316,7 +284,10 @@ def remove_remote_process_group_with_http_info(self, id, **kwargs): if ('id' not in params) or (params['id'] is None): raise ValueError("Missing the required parameter `id` when calling `remove_remote_process_group`") - + + + + collection_formats = {} path_params = {} @@ -341,12 +312,8 @@ def remove_remote_process_group_with_http_info(self, id, **kwargs): header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['*/*']) - # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/remote-process-groups/{id}', 'DELETE', path_params, @@ -357,62 +324,54 @@ def remove_remote_process_group_with_http_info(self, id, **kwargs): files=local_var_files, response_type='RemoteProcessGroupEntity', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def update_remote_process_group(self, id, body, **kwargs): + def update_remote_process_group(self, body, id, **kwargs): """ - Updates a remote process group + Updates a remote process group. + 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 + ``update_remote_process_group_with_http_info()`` method instead. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.update_remote_process_group(id, body, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The remote process group id. (required) - :param RemoteProcessGroupEntity body: The remote process group. (required) - :return: RemoteProcessGroupEntity - If the method is called asynchronously, - returns the request thread. + Args: + body (:class:`~nipyapi.nifi.models.RemoteProcessGroupEntity`): + The remote process group. (required) + id (str): + The remote process group id. (required) + + Returns: + :class:`~nipyapi.nifi.models.RemoteProcessGroupEntity`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.update_remote_process_group_with_http_info(id, body, **kwargs) + return self.update_remote_process_group_with_http_info(body, id, **kwargs) else: - (data) = self.update_remote_process_group_with_http_info(id, body, **kwargs) + (data) = self.update_remote_process_group_with_http_info(body, id, **kwargs) return data - def update_remote_process_group_with_http_info(self, id, body, **kwargs): + def update_remote_process_group_with_http_info(self, body, id, **kwargs): """ - Updates a remote process group + Updates a remote process group. + 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 ``update_remote_process_group()`` method instead. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.update_remote_process_group_with_http_info(id, body, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The remote process group id. (required) - :param RemoteProcessGroupEntity body: The remote process group. (required) - :return: RemoteProcessGroupEntity - If the method is called asynchronously, - returns the request thread. + Args: + body (:class:`~nipyapi.nifi.models.RemoteProcessGroupEntity`): + The remote process group. (required) + id (str): + The remote process group id. (required) + + Returns: + tuple: (:class:`~nipyapi.nifi.models.RemoteProcessGroupEntity`, status_code, headers) - Response data with HTTP details. """ - all_params = ['id', 'body'] - all_params.append('callback') + all_params = ['body', 'id'] all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -426,14 +385,15 @@ def update_remote_process_group_with_http_info(self, id, body, **kwargs): ) params[key] = val del params['kwargs'] - # verify the required parameter 'id' is set - if ('id' not in params) or (params['id'] is None): - raise ValueError("Missing the required parameter `id` when calling `update_remote_process_group`") # verify the required parameter 'body' is set if ('body' not in params) or (params['body'] is None): raise ValueError("Missing the required parameter `body` when calling `update_remote_process_group`") + # verify the required parameter 'id' is set + if ('id' not in params) or (params['id'] is None): + raise ValueError("Missing the required parameter `id` when calling `update_remote_process_group`") - + + collection_formats = {} path_params = {} @@ -459,7 +419,7 @@ def update_remote_process_group_with_http_info(self, id, body, **kwargs): select_header_content_type(['application/json']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/remote-process-groups/{id}', 'PUT', path_params, @@ -470,64 +430,64 @@ def update_remote_process_group_with_http_info(self, id, body, **kwargs): files=local_var_files, response_type='RemoteProcessGroupEntity', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def update_remote_process_group_input_port(self, id, port_id, body, **kwargs): + def update_remote_process_group_input_port(self, body, id, port_id, **kwargs): """ - Updates a remote port + Updates a remote port. + Note: This endpoint is subject to change as NiFi and it's REST API evolve. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.update_remote_process_group_input_port(id, port_id, body, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The remote process group id. (required) - :param str port_id: The remote process group port id. (required) - :param RemoteProcessGroupPortEntity body: The remote process group port. (required) - :return: RemoteProcessGroupPortEntity - If the method is called asynchronously, - returns the request thread. + + 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 + ``update_remote_process_group_input_port_with_http_info()`` method instead. + + Args: + body (:class:`~nipyapi.nifi.models.RemoteProcessGroupPortEntity`): + The remote process group port. (required) + id (str): + The remote process group id. (required) + port_id (str): + The remote process group port id. (required) + + Returns: + :class:`~nipyapi.nifi.models.RemoteProcessGroupPortEntity`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.update_remote_process_group_input_port_with_http_info(id, port_id, body, **kwargs) + return self.update_remote_process_group_input_port_with_http_info(body, id, port_id, **kwargs) else: - (data) = self.update_remote_process_group_input_port_with_http_info(id, port_id, body, **kwargs) + (data) = self.update_remote_process_group_input_port_with_http_info(body, id, port_id, **kwargs) return data - def update_remote_process_group_input_port_with_http_info(self, id, port_id, body, **kwargs): + def update_remote_process_group_input_port_with_http_info(self, body, id, port_id, **kwargs): """ - Updates a remote port + Updates a remote port. + Note: This endpoint is subject to change as NiFi and it's REST API evolve. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.update_remote_process_group_input_port_with_http_info(id, port_id, body, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The remote process group id. (required) - :param str port_id: The remote process group port id. (required) - :param RemoteProcessGroupPortEntity body: The remote process group port. (required) - :return: RemoteProcessGroupPortEntity - If the method is called asynchronously, - returns the request thread. + + 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 ``update_remote_process_group_input_port()`` method instead. + + Args: + body (:class:`~nipyapi.nifi.models.RemoteProcessGroupPortEntity`): + The remote process group port. (required) + id (str): + The remote process group id. (required) + port_id (str): + The remote process group port id. (required) + + Returns: + tuple: (:class:`~nipyapi.nifi.models.RemoteProcessGroupPortEntity`, status_code, headers) - Response data with HTTP details. """ - all_params = ['id', 'port_id', 'body'] - all_params.append('callback') + all_params = ['body', 'id', 'port_id'] all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -541,17 +501,19 @@ def update_remote_process_group_input_port_with_http_info(self, id, port_id, bod ) 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 `update_remote_process_group_input_port`") # verify the required parameter 'id' is set if ('id' not in params) or (params['id'] is None): raise ValueError("Missing the required parameter `id` when calling `update_remote_process_group_input_port`") # verify the required parameter 'port_id' is set if ('port_id' not in params) or (params['port_id'] is None): raise ValueError("Missing the required parameter `port_id` when calling `update_remote_process_group_input_port`") - # verify the required parameter 'body' is set - if ('body' not in params) or (params['body'] is None): - raise ValueError("Missing the required parameter `body` when calling `update_remote_process_group_input_port`") - + + + collection_formats = {} path_params = {} @@ -579,7 +541,7 @@ def update_remote_process_group_input_port_with_http_info(self, id, port_id, bod select_header_content_type(['application/json']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/remote-process-groups/{id}/input-ports/{port-id}', 'PUT', path_params, @@ -590,64 +552,64 @@ def update_remote_process_group_input_port_with_http_info(self, id, port_id, bod files=local_var_files, response_type='RemoteProcessGroupPortEntity', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def update_remote_process_group_input_port_run_status(self, id, port_id, body, **kwargs): + def update_remote_process_group_input_port_run_status(self, body, id, port_id, **kwargs): """ - Updates run status of a remote port + Updates run status of a remote port. + Note: This endpoint is subject to change as NiFi and it's REST API evolve. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.update_remote_process_group_input_port_run_status(id, port_id, body, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The remote process group id. (required) - :param str port_id: The remote process group port id. (required) - :param RemotePortRunStatusEntity body: The remote process group port. (required) - :return: RemoteProcessGroupPortEntity - If the method is called asynchronously, - returns the request thread. + + 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 + ``update_remote_process_group_input_port_run_status_with_http_info()`` method instead. + + Args: + body (:class:`~nipyapi.nifi.models.RemotePortRunStatusEntity`): + The remote process group port. (required) + id (str): + The remote process group id. (required) + port_id (str): + The remote process group port id. (required) + + Returns: + :class:`~nipyapi.nifi.models.RemoteProcessGroupPortEntity`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.update_remote_process_group_input_port_run_status_with_http_info(id, port_id, body, **kwargs) + return self.update_remote_process_group_input_port_run_status_with_http_info(body, id, port_id, **kwargs) else: - (data) = self.update_remote_process_group_input_port_run_status_with_http_info(id, port_id, body, **kwargs) + (data) = self.update_remote_process_group_input_port_run_status_with_http_info(body, id, port_id, **kwargs) return data - def update_remote_process_group_input_port_run_status_with_http_info(self, id, port_id, body, **kwargs): + def update_remote_process_group_input_port_run_status_with_http_info(self, body, id, port_id, **kwargs): """ - Updates run status of a remote port + Updates run status of a remote port. + Note: This endpoint is subject to change as NiFi and it's REST API evolve. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.update_remote_process_group_input_port_run_status_with_http_info(id, port_id, body, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The remote process group id. (required) - :param str port_id: The remote process group port id. (required) - :param RemotePortRunStatusEntity body: The remote process group port. (required) - :return: RemoteProcessGroupPortEntity - If the method is called asynchronously, - returns the request thread. + + 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 ``update_remote_process_group_input_port_run_status()`` method instead. + + Args: + body (:class:`~nipyapi.nifi.models.RemotePortRunStatusEntity`): + The remote process group port. (required) + id (str): + The remote process group id. (required) + port_id (str): + The remote process group port id. (required) + + Returns: + tuple: (:class:`~nipyapi.nifi.models.RemoteProcessGroupPortEntity`, status_code, headers) - Response data with HTTP details. """ - all_params = ['id', 'port_id', 'body'] - all_params.append('callback') + all_params = ['body', 'id', 'port_id'] all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -661,17 +623,19 @@ def update_remote_process_group_input_port_run_status_with_http_info(self, id, p ) 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 `update_remote_process_group_input_port_run_status`") # verify the required parameter 'id' is set if ('id' not in params) or (params['id'] is None): raise ValueError("Missing the required parameter `id` when calling `update_remote_process_group_input_port_run_status`") # verify the required parameter 'port_id' is set if ('port_id' not in params) or (params['port_id'] is None): raise ValueError("Missing the required parameter `port_id` when calling `update_remote_process_group_input_port_run_status`") - # verify the required parameter 'body' is set - if ('body' not in params) or (params['body'] is None): - raise ValueError("Missing the required parameter `body` when calling `update_remote_process_group_input_port_run_status`") - + + + collection_formats = {} path_params = {} @@ -699,7 +663,7 @@ def update_remote_process_group_input_port_run_status_with_http_info(self, id, p select_header_content_type(['application/json']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/remote-process-groups/{id}/input-ports/{port-id}/run-status', 'PUT', path_params, @@ -710,64 +674,64 @@ def update_remote_process_group_input_port_run_status_with_http_info(self, id, p files=local_var_files, response_type='RemoteProcessGroupPortEntity', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def update_remote_process_group_output_port(self, id, port_id, body, **kwargs): + def update_remote_process_group_output_port(self, body, id, port_id, **kwargs): """ - Updates a remote port + Updates a remote port. + Note: This endpoint is subject to change as NiFi and it's REST API evolve. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.update_remote_process_group_output_port(id, port_id, body, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The remote process group id. (required) - :param str port_id: The remote process group port id. (required) - :param RemoteProcessGroupPortEntity body: The remote process group port. (required) - :return: RemoteProcessGroupPortEntity - If the method is called asynchronously, - returns the request thread. + + 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 + ``update_remote_process_group_output_port_with_http_info()`` method instead. + + Args: + body (:class:`~nipyapi.nifi.models.RemoteProcessGroupPortEntity`): + The remote process group port. (required) + id (str): + The remote process group id. (required) + port_id (str): + The remote process group port id. (required) + + Returns: + :class:`~nipyapi.nifi.models.RemoteProcessGroupPortEntity`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.update_remote_process_group_output_port_with_http_info(id, port_id, body, **kwargs) + return self.update_remote_process_group_output_port_with_http_info(body, id, port_id, **kwargs) else: - (data) = self.update_remote_process_group_output_port_with_http_info(id, port_id, body, **kwargs) + (data) = self.update_remote_process_group_output_port_with_http_info(body, id, port_id, **kwargs) return data - def update_remote_process_group_output_port_with_http_info(self, id, port_id, body, **kwargs): + def update_remote_process_group_output_port_with_http_info(self, body, id, port_id, **kwargs): """ - Updates a remote port + Updates a remote port. + Note: This endpoint is subject to change as NiFi and it's REST API evolve. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.update_remote_process_group_output_port_with_http_info(id, port_id, body, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The remote process group id. (required) - :param str port_id: The remote process group port id. (required) - :param RemoteProcessGroupPortEntity body: The remote process group port. (required) - :return: RemoteProcessGroupPortEntity - If the method is called asynchronously, - returns the request thread. + + 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 ``update_remote_process_group_output_port()`` method instead. + + Args: + body (:class:`~nipyapi.nifi.models.RemoteProcessGroupPortEntity`): + The remote process group port. (required) + id (str): + The remote process group id. (required) + port_id (str): + The remote process group port id. (required) + + Returns: + tuple: (:class:`~nipyapi.nifi.models.RemoteProcessGroupPortEntity`, status_code, headers) - Response data with HTTP details. """ - all_params = ['id', 'port_id', 'body'] - all_params.append('callback') + all_params = ['body', 'id', 'port_id'] all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -781,17 +745,19 @@ def update_remote_process_group_output_port_with_http_info(self, id, port_id, bo ) 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 `update_remote_process_group_output_port`") # verify the required parameter 'id' is set if ('id' not in params) or (params['id'] is None): raise ValueError("Missing the required parameter `id` when calling `update_remote_process_group_output_port`") # verify the required parameter 'port_id' is set if ('port_id' not in params) or (params['port_id'] is None): raise ValueError("Missing the required parameter `port_id` when calling `update_remote_process_group_output_port`") - # verify the required parameter 'body' is set - if ('body' not in params) or (params['body'] is None): - raise ValueError("Missing the required parameter `body` when calling `update_remote_process_group_output_port`") - + + + collection_formats = {} path_params = {} @@ -819,7 +785,7 @@ def update_remote_process_group_output_port_with_http_info(self, id, port_id, bo select_header_content_type(['application/json']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/remote-process-groups/{id}/output-ports/{port-id}', 'PUT', path_params, @@ -830,64 +796,64 @@ def update_remote_process_group_output_port_with_http_info(self, id, port_id, bo files=local_var_files, response_type='RemoteProcessGroupPortEntity', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def update_remote_process_group_output_port_run_status(self, id, port_id, body, **kwargs): + def update_remote_process_group_output_port_run_status(self, body, id, port_id, **kwargs): """ - Updates run status of a remote port + Updates run status of a remote port. + Note: This endpoint is subject to change as NiFi and it's REST API evolve. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.update_remote_process_group_output_port_run_status(id, port_id, body, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The remote process group id. (required) - :param str port_id: The remote process group port id. (required) - :param RemotePortRunStatusEntity body: The remote process group port. (required) - :return: RemoteProcessGroupPortEntity - If the method is called asynchronously, - returns the request thread. + + 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 + ``update_remote_process_group_output_port_run_status_with_http_info()`` method instead. + + Args: + body (:class:`~nipyapi.nifi.models.RemotePortRunStatusEntity`): + The remote process group port. (required) + id (str): + The remote process group id. (required) + port_id (str): + The remote process group port id. (required) + + Returns: + :class:`~nipyapi.nifi.models.RemoteProcessGroupPortEntity`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.update_remote_process_group_output_port_run_status_with_http_info(id, port_id, body, **kwargs) + return self.update_remote_process_group_output_port_run_status_with_http_info(body, id, port_id, **kwargs) else: - (data) = self.update_remote_process_group_output_port_run_status_with_http_info(id, port_id, body, **kwargs) + (data) = self.update_remote_process_group_output_port_run_status_with_http_info(body, id, port_id, **kwargs) return data - def update_remote_process_group_output_port_run_status_with_http_info(self, id, port_id, body, **kwargs): + def update_remote_process_group_output_port_run_status_with_http_info(self, body, id, port_id, **kwargs): """ - Updates run status of a remote port + Updates run status of a remote port. + Note: This endpoint is subject to change as NiFi and it's REST API evolve. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.update_remote_process_group_output_port_run_status_with_http_info(id, port_id, body, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The remote process group id. (required) - :param str port_id: The remote process group port id. (required) - :param RemotePortRunStatusEntity body: The remote process group port. (required) - :return: RemoteProcessGroupPortEntity - If the method is called asynchronously, - returns the request thread. + + 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 ``update_remote_process_group_output_port_run_status()`` method instead. + + Args: + body (:class:`~nipyapi.nifi.models.RemotePortRunStatusEntity`): + The remote process group port. (required) + id (str): + The remote process group id. (required) + port_id (str): + The remote process group port id. (required) + + Returns: + tuple: (:class:`~nipyapi.nifi.models.RemoteProcessGroupPortEntity`, status_code, headers) - Response data with HTTP details. """ - all_params = ['id', 'port_id', 'body'] - all_params.append('callback') + all_params = ['body', 'id', 'port_id'] all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -901,17 +867,19 @@ def update_remote_process_group_output_port_run_status_with_http_info(self, id, ) 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 `update_remote_process_group_output_port_run_status`") # verify the required parameter 'id' is set if ('id' not in params) or (params['id'] is None): raise ValueError("Missing the required parameter `id` when calling `update_remote_process_group_output_port_run_status`") # verify the required parameter 'port_id' is set if ('port_id' not in params) or (params['port_id'] is None): raise ValueError("Missing the required parameter `port_id` when calling `update_remote_process_group_output_port_run_status`") - # verify the required parameter 'body' is set - if ('body' not in params) or (params['body'] is None): - raise ValueError("Missing the required parameter `body` when calling `update_remote_process_group_output_port_run_status`") - + + + collection_formats = {} path_params = {} @@ -939,7 +907,7 @@ def update_remote_process_group_output_port_run_status_with_http_info(self, id, select_header_content_type(['application/json']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/remote-process-groups/{id}/output-ports/{port-id}/run-status', 'PUT', path_params, @@ -950,62 +918,54 @@ def update_remote_process_group_output_port_run_status_with_http_info(self, id, files=local_var_files, response_type='RemoteProcessGroupPortEntity', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def update_remote_process_group_run_status(self, id, body, **kwargs): + def update_remote_process_group_run_status(self, body, id, **kwargs): """ - Updates run status of a remote process group + Updates run status of a remote process group. + 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 + ``update_remote_process_group_run_status_with_http_info()`` method instead. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.update_remote_process_group_run_status(id, body, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The remote process group id. (required) - :param RemotePortRunStatusEntity body: The remote process group run status. (required) - :return: RemoteProcessGroupEntity - If the method is called asynchronously, - returns the request thread. + Args: + body (:class:`~nipyapi.nifi.models.RemotePortRunStatusEntity`): + The remote process group run status. (required) + id (str): + The remote process group id. (required) + + Returns: + :class:`~nipyapi.nifi.models.RemoteProcessGroupEntity`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.update_remote_process_group_run_status_with_http_info(id, body, **kwargs) + return self.update_remote_process_group_run_status_with_http_info(body, id, **kwargs) else: - (data) = self.update_remote_process_group_run_status_with_http_info(id, body, **kwargs) + (data) = self.update_remote_process_group_run_status_with_http_info(body, id, **kwargs) return data - def update_remote_process_group_run_status_with_http_info(self, id, body, **kwargs): + def update_remote_process_group_run_status_with_http_info(self, body, id, **kwargs): """ - Updates run status of a remote process group + Updates run status of a remote process group. + 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 ``update_remote_process_group_run_status()`` method instead. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.update_remote_process_group_run_status_with_http_info(id, body, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The remote process group id. (required) - :param RemotePortRunStatusEntity body: The remote process group run status. (required) - :return: RemoteProcessGroupEntity - If the method is called asynchronously, - returns the request thread. + Args: + body (:class:`~nipyapi.nifi.models.RemotePortRunStatusEntity`): + The remote process group run status. (required) + id (str): + The remote process group id. (required) + + Returns: + tuple: (:class:`~nipyapi.nifi.models.RemoteProcessGroupEntity`, status_code, headers) - Response data with HTTP details. """ - all_params = ['id', 'body'] - all_params.append('callback') + all_params = ['body', 'id'] all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -1019,14 +979,15 @@ def update_remote_process_group_run_status_with_http_info(self, id, body, **kwar ) params[key] = val del params['kwargs'] - # verify the required parameter 'id' is set - if ('id' not in params) or (params['id'] is None): - raise ValueError("Missing the required parameter `id` when calling `update_remote_process_group_run_status`") # verify the required parameter 'body' is set if ('body' not in params) or (params['body'] is None): raise ValueError("Missing the required parameter `body` when calling `update_remote_process_group_run_status`") + # verify the required parameter 'id' is set + if ('id' not in params) or (params['id'] is None): + raise ValueError("Missing the required parameter `id` when calling `update_remote_process_group_run_status`") - + + collection_formats = {} path_params = {} @@ -1052,7 +1013,7 @@ def update_remote_process_group_run_status_with_http_info(self, id, body, **kwar select_header_content_type(['application/json']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/remote-process-groups/{id}/run-status', 'PUT', path_params, @@ -1063,62 +1024,54 @@ def update_remote_process_group_run_status_with_http_info(self, id, body, **kwar files=local_var_files, response_type='RemoteProcessGroupEntity', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def update_remote_process_group_run_statuses(self, id, body, **kwargs): + def update_remote_process_group_run_statuses(self, body, id, **kwargs): """ - Updates run status of all remote process groups in a process group (recursively) + Updates run status of all remote process groups in a process group (recursively). + This method makes a synchronous HTTP request and returns the response data directly. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.update_remote_process_group_run_statuses(id, body, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The process group id. (required) - :param RemotePortRunStatusEntity body: The remote process groups run status. (required) - :return: RemoteProcessGroupEntity - If the method is called asynchronously, - returns the request thread. + For full HTTP response details (status code, headers, etc.), use the corresponding + ``update_remote_process_group_run_statuses_with_http_info()`` method instead. + + Args: + body (:class:`~nipyapi.nifi.models.RemotePortRunStatusEntity`): + The remote process groups run status. (required) + id (str): + The process group id. (required) + + Returns: + :class:`~nipyapi.nifi.models.RemoteProcessGroupEntity`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.update_remote_process_group_run_statuses_with_http_info(id, body, **kwargs) + return self.update_remote_process_group_run_statuses_with_http_info(body, id, **kwargs) else: - (data) = self.update_remote_process_group_run_statuses_with_http_info(id, body, **kwargs) + (data) = self.update_remote_process_group_run_statuses_with_http_info(body, id, **kwargs) return data - def update_remote_process_group_run_statuses_with_http_info(self, id, body, **kwargs): + def update_remote_process_group_run_statuses_with_http_info(self, body, id, **kwargs): """ - Updates run status of all remote process groups in a process group (recursively) + Updates run status of all remote process groups in a process group (recursively). + 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 ``update_remote_process_group_run_statuses()`` method instead. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.update_remote_process_group_run_statuses_with_http_info(id, body, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The process group id. (required) - :param RemotePortRunStatusEntity body: The remote process groups run status. (required) - :return: RemoteProcessGroupEntity - If the method is called asynchronously, - returns the request thread. + Args: + body (:class:`~nipyapi.nifi.models.RemotePortRunStatusEntity`): + The remote process groups run status. (required) + id (str): + The process group id. (required) + + Returns: + tuple: (:class:`~nipyapi.nifi.models.RemoteProcessGroupEntity`, status_code, headers) - Response data with HTTP details. """ - all_params = ['id', 'body'] - all_params.append('callback') + all_params = ['body', 'id'] all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -1132,14 +1085,15 @@ def update_remote_process_group_run_statuses_with_http_info(self, id, body, **kw ) params[key] = val del params['kwargs'] - # verify the required parameter 'id' is set - if ('id' not in params) or (params['id'] is None): - raise ValueError("Missing the required parameter `id` when calling `update_remote_process_group_run_statuses`") # verify the required parameter 'body' is set if ('body' not in params) or (params['body'] is None): raise ValueError("Missing the required parameter `body` when calling `update_remote_process_group_run_statuses`") + # verify the required parameter 'id' is set + if ('id' not in params) or (params['id'] is None): + raise ValueError("Missing the required parameter `id` when calling `update_remote_process_group_run_statuses`") - + + collection_formats = {} path_params = {} @@ -1165,7 +1119,7 @@ def update_remote_process_group_run_statuses_with_http_info(self, id, body, **kw select_header_content_type(['application/json']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/remote-process-groups/process-group/{id}/run-status', 'PUT', path_params, @@ -1176,7 +1130,6 @@ def update_remote_process_group_run_statuses_with_http_info(self, id, body, **kw files=local_var_files, response_type='RemoteProcessGroupEntity', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), diff --git a/nipyapi/nifi/apis/reporting_tasks_api.py b/nipyapi/nifi/apis/reporting_tasks_api.py index 35da8bba..17df435e 100644 --- a/nipyapi/nifi/apis/reporting_tasks_api.py +++ b/nipyapi/nifi/apis/reporting_tasks_api.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - import sys import os import re @@ -33,56 +32,49 @@ def __init__(self, api_client=None): config.api_client = ApiClient() self.api_client = config.api_client - def analyze_configuration(self, id, body, **kwargs): + def analyze_configuration3(self, body, id, **kwargs): """ - Performs analysis of the component's configuration, providing information about which attributes are referenced. + Performs analysis of the component's configuration, providing information about which attributes are referenced.. + 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 + ``analyze_configuration3_with_http_info()`` method instead. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.analyze_configuration(id, body, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The reporting task id. (required) - :param ConfigurationAnalysisEntity body: The configuration analysis request. (required) - :return: ConfigurationAnalysisEntity - If the method is called asynchronously, - returns the request thread. + Args: + body (:class:`~nipyapi.nifi.models.ConfigurationAnalysisEntity`): + The configuration analysis request. (required) + id (str): + The reporting task id. (required) + + Returns: + :class:`~nipyapi.nifi.models.ConfigurationAnalysisEntity`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.analyze_configuration_with_http_info(id, body, **kwargs) + return self.analyze_configuration3_with_http_info(body, id, **kwargs) else: - (data) = self.analyze_configuration_with_http_info(id, body, **kwargs) + (data) = self.analyze_configuration3_with_http_info(body, id, **kwargs) return data - def analyze_configuration_with_http_info(self, id, body, **kwargs): + def analyze_configuration3_with_http_info(self, body, id, **kwargs): """ - Performs analysis of the component's configuration, providing information about which attributes are referenced. + Performs analysis of the component's configuration, providing information about which attributes are referenced.. + 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 ``analyze_configuration3()`` method instead. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.analyze_configuration_with_http_info(id, body, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The reporting task id. (required) - :param ConfigurationAnalysisEntity body: The configuration analysis request. (required) - :return: ConfigurationAnalysisEntity - If the method is called asynchronously, - returns the request thread. + Args: + body (:class:`~nipyapi.nifi.models.ConfigurationAnalysisEntity`): + The configuration analysis request. (required) + id (str): + The reporting task id. (required) + + Returns: + tuple: (:class:`~nipyapi.nifi.models.ConfigurationAnalysisEntity`, status_code, headers) - Response data with HTTP details. """ - all_params = ['id', 'body'] - all_params.append('callback') + all_params = ['body', 'id'] all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -92,18 +84,19 @@ def analyze_configuration_with_http_info(self, id, body, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method analyze_configuration" % key + " to method analyze_configuration3" % 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 `analyze_configuration`") # 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 `analyze_configuration`") - + raise ValueError("Missing the required parameter `body` when calling `analyze_configuration3`") + # 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 `analyze_configuration3`") + + collection_formats = {} path_params = {} @@ -129,7 +122,7 @@ def analyze_configuration_with_http_info(self, id, body, **kwargs): select_header_content_type(['application/json']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/reporting-tasks/{id}/config/analysis', 'POST', path_params, @@ -140,60 +133,50 @@ def analyze_configuration_with_http_info(self, id, body, **kwargs): files=local_var_files, response_type='ConfigurationAnalysisEntity', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def clear_state(self, id, **kwargs): + def clear_state4(self, id, **kwargs): """ - Clears the state for a reporting task + Clears the state for a reporting task. + 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 + ``clear_state4_with_http_info()`` method instead. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.clear_state(id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The reporting task id. (required) - :return: ComponentStateEntity - If the method is called asynchronously, - returns the request thread. + Args: + id (str): + The reporting task id. (required) + + Returns: + :class:`~nipyapi.nifi.models.ComponentStateEntity`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.clear_state_with_http_info(id, **kwargs) + return self.clear_state4_with_http_info(id, **kwargs) else: - (data) = self.clear_state_with_http_info(id, **kwargs) + (data) = self.clear_state4_with_http_info(id, **kwargs) return data - def clear_state_with_http_info(self, id, **kwargs): + def clear_state4_with_http_info(self, id, **kwargs): """ - Clears the state for a reporting task + Clears the state for a reporting task. + This method makes a synchronous HTTP request and returns detailed response information. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.clear_state_with_http_info(id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The reporting task id. (required) - :return: ComponentStateEntity - If the method is called asynchronously, - returns the request thread. + Returns the response data along with HTTP status code, headers, and other metadata. + For just the response data, use the corresponding ``clear_state4()`` method instead. + + Args: + id (str): + The reporting task id. (required) + + Returns: + tuple: (:class:`~nipyapi.nifi.models.ComponentStateEntity`, status_code, headers) - Response data with HTTP details. """ all_params = ['id'] - all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -203,15 +186,15 @@ def clear_state_with_http_info(self, id, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method clear_state" % key + " to method clear_state4" % 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 `clear_state`") - + raise ValueError("Missing the required parameter `id` when calling `clear_state4`") + collection_formats = {} path_params = {} @@ -230,12 +213,8 @@ def clear_state_with_http_info(self, id, **kwargs): header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['*/*']) - # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/reporting-tasks/{id}/state/clear-requests', 'POST', path_params, @@ -246,62 +225,60 @@ def clear_state_with_http_info(self, id, **kwargs): files=local_var_files, response_type='ComponentStateEntity', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def delete_verification_request(self, id, request_id, **kwargs): + def delete_verification_request3(self, id, request_id, **kwargs): """ - Deletes the Verification Request with the given ID + Deletes the Verification Request with the given ID. + Deletes the Verification Request with the given ID. After a request is created, it is expected that the client will properly clean up the request by DELETE'ing it, once the Verification process has completed. If the request is deleted before the request completes, then the Verification request will finish the step that it is currently performing and then will cancel any subsequent steps. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.delete_verification_request(id, request_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The ID of the Reporting Task (required) - :param str request_id: The ID of the Verification Request (required) - :return: VerifyConfigRequestEntity - If the method is called asynchronously, - returns the request thread. + + 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_verification_request3_with_http_info()`` method instead. + + Args: + id (str): + The ID of the Reporting Task (required) + request_id (str): + The ID of the Verification Request (required) + + Returns: + :class:`~nipyapi.nifi.models.VerifyConfigRequestEntity`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.delete_verification_request_with_http_info(id, request_id, **kwargs) + return self.delete_verification_request3_with_http_info(id, request_id, **kwargs) else: - (data) = self.delete_verification_request_with_http_info(id, request_id, **kwargs) + (data) = self.delete_verification_request3_with_http_info(id, request_id, **kwargs) return data - def delete_verification_request_with_http_info(self, id, request_id, **kwargs): + def delete_verification_request3_with_http_info(self, id, request_id, **kwargs): """ - Deletes the Verification Request with the given ID + Deletes the Verification Request with the given ID. + Deletes the Verification Request with the given ID. After a request is created, it is expected that the client will properly clean up the request by DELETE'ing it, once the Verification process has completed. If the request is deleted before the request completes, then the Verification request will finish the step that it is currently performing and then will cancel any subsequent steps. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.delete_verification_request_with_http_info(id, request_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The ID of the Reporting Task (required) - :param str request_id: The ID of the Verification Request (required) - :return: VerifyConfigRequestEntity - If the method is called asynchronously, - returns the request thread. + + 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_verification_request3()`` method instead. + + Args: + id (str): + The ID of the Reporting Task (required) + request_id (str): + The ID of the Verification Request (required) + + Returns: + tuple: (:class:`~nipyapi.nifi.models.VerifyConfigRequestEntity`, status_code, headers) - Response data with HTTP details. """ all_params = ['id', 'request_id'] - all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -311,18 +288,19 @@ def delete_verification_request_with_http_info(self, id, request_id, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method delete_verification_request" % key + " to method delete_verification_request3" % 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_verification_request`") + raise ValueError("Missing the required parameter `id` when calling `delete_verification_request3`") # 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_verification_request`") - + raise ValueError("Missing the required parameter `request_id` when calling `delete_verification_request3`") + + collection_formats = {} path_params = {} @@ -343,12 +321,8 @@ def delete_verification_request_with_http_info(self, id, request_id, **kwargs): header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['*/*']) - # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/reporting-tasks/{id}/config/verification-requests/{requestId}', 'DELETE', path_params, @@ -359,64 +333,58 @@ def delete_verification_request_with_http_info(self, id, request_id, **kwargs): files=local_var_files, response_type='VerifyConfigRequestEntity', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def get_property_descriptor(self, id, property_name, **kwargs): + def get_property_descriptor4(self, id, property_name, **kwargs): """ - Gets a reporting task property descriptor + Gets a reporting task property descriptor. + This method makes a synchronous HTTP request and returns the response data directly. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_property_descriptor(id, property_name, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The reporting task id. (required) - :param str property_name: The property name. (required) - :param bool sensitive: Property Descriptor requested sensitive status - :return: PropertyDescriptorEntity - If the method is called asynchronously, - returns the request thread. + For full HTTP response details (status code, headers, etc.), use the corresponding + ``get_property_descriptor4_with_http_info()`` method instead. + + Args: + id (str): + The reporting task id. (required) + property_name (str): + The property name. (required) + sensitive (bool): + Property Descriptor requested sensitive status + + Returns: + :class:`~nipyapi.nifi.models.PropertyDescriptorEntity`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.get_property_descriptor_with_http_info(id, property_name, **kwargs) + return self.get_property_descriptor4_with_http_info(id, property_name, **kwargs) else: - (data) = self.get_property_descriptor_with_http_info(id, property_name, **kwargs) + (data) = self.get_property_descriptor4_with_http_info(id, property_name, **kwargs) return data - def get_property_descriptor_with_http_info(self, id, property_name, **kwargs): + def get_property_descriptor4_with_http_info(self, id, property_name, **kwargs): """ - Gets a reporting task property descriptor + Gets a reporting task property descriptor. + 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_property_descriptor4()`` method instead. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_property_descriptor_with_http_info(id, property_name, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The reporting task id. (required) - :param str property_name: The property name. (required) - :param bool sensitive: Property Descriptor requested sensitive status - :return: PropertyDescriptorEntity - If the method is called asynchronously, - returns the request thread. + Args: + id (str): + The reporting task id. (required) + property_name (str): + The property name. (required) + sensitive (bool): + Property Descriptor requested sensitive status + + Returns: + tuple: (:class:`~nipyapi.nifi.models.PropertyDescriptorEntity`, status_code, headers) - Response data with HTTP details. """ all_params = ['id', 'property_name', 'sensitive'] - all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -426,18 +394,20 @@ def get_property_descriptor_with_http_info(self, id, property_name, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method get_property_descriptor" % key + " to method get_property_descriptor4" % 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_property_descriptor`") + raise ValueError("Missing the required parameter `id` when calling `get_property_descriptor4`") # verify the required parameter 'property_name' is set if ('property_name' not in params) or (params['property_name'] is None): - raise ValueError("Missing the required parameter `property_name` when calling `get_property_descriptor`") - + raise ValueError("Missing the required parameter `property_name` when calling `get_property_descriptor4`") + + + collection_formats = {} path_params = {} @@ -460,12 +430,8 @@ def get_property_descriptor_with_http_info(self, id, property_name, **kwargs): header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['*/*']) - # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/reporting-tasks/{id}/descriptors', 'GET', path_params, @@ -476,7 +442,6 @@ def get_property_descriptor_with_http_info(self, id, property_name, **kwargs): files=local_var_files, response_type='PropertyDescriptorEntity', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), @@ -484,22 +449,18 @@ def get_property_descriptor_with_http_info(self, id, property_name, **kwargs): def get_reporting_task(self, id, **kwargs): """ - Gets a reporting task + Gets a reporting task. + This method makes a synchronous HTTP request and returns the response data directly. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_reporting_task(id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The reporting task id. (required) - :return: ReportingTaskEntity - If the method is called asynchronously, - returns the request thread. + For full HTTP response details (status code, headers, etc.), use the corresponding + ``get_reporting_task_with_http_info()`` method instead. + + Args: + id (str): + The reporting task id. (required) + + Returns: + :class:`~nipyapi.nifi.models.ReportingTaskEntity`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): @@ -510,26 +471,21 @@ def get_reporting_task(self, id, **kwargs): def get_reporting_task_with_http_info(self, id, **kwargs): """ - Gets a reporting task + Gets a reporting task. + 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_reporting_task()`` method instead. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_reporting_task_with_http_info(id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The reporting task id. (required) - :return: ReportingTaskEntity - If the method is called asynchronously, - returns the request thread. + Args: + id (str): + The reporting task id. (required) + + Returns: + tuple: (:class:`~nipyapi.nifi.models.ReportingTaskEntity`, status_code, headers) - Response data with HTTP details. """ all_params = ['id'] - all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -547,7 +503,7 @@ def get_reporting_task_with_http_info(self, id, **kwargs): if ('id' not in params) or (params['id'] is None): raise ValueError("Missing the required parameter `id` when calling `get_reporting_task`") - + collection_formats = {} path_params = {} @@ -566,12 +522,8 @@ def get_reporting_task_with_http_info(self, id, **kwargs): header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['*/*']) - # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/reporting-tasks/{id}', 'GET', path_params, @@ -582,60 +534,50 @@ def get_reporting_task_with_http_info(self, id, **kwargs): files=local_var_files, response_type='ReportingTaskEntity', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def get_state(self, id, **kwargs): + def get_state4(self, id, **kwargs): """ - Gets the state for a reporting task + Gets the state for a reporting task. + This method makes a synchronous HTTP request and returns the response data directly. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_state(id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The reporting task id. (required) - :return: ComponentStateEntity - If the method is called asynchronously, - returns the request thread. + For full HTTP response details (status code, headers, etc.), use the corresponding + ``get_state4_with_http_info()`` method instead. + + Args: + id (str): + The reporting task id. (required) + + Returns: + :class:`~nipyapi.nifi.models.ComponentStateEntity`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.get_state_with_http_info(id, **kwargs) + return self.get_state4_with_http_info(id, **kwargs) else: - (data) = self.get_state_with_http_info(id, **kwargs) + (data) = self.get_state4_with_http_info(id, **kwargs) return data - def get_state_with_http_info(self, id, **kwargs): + def get_state4_with_http_info(self, id, **kwargs): """ - Gets the state for a reporting task + Gets the state for a reporting task. + 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_state4()`` method instead. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_state_with_http_info(id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The reporting task id. (required) - :return: ComponentStateEntity - If the method is called asynchronously, - returns the request thread. + Args: + id (str): + The reporting task id. (required) + + Returns: + tuple: (:class:`~nipyapi.nifi.models.ComponentStateEntity`, status_code, headers) - Response data with HTTP details. """ all_params = ['id'] - all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -645,15 +587,15 @@ def get_state_with_http_info(self, id, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method get_state" % key + " to method get_state4" % key ) params[key] = val del params['kwargs'] # verify the required parameter 'id' is set if ('id' not in params) or (params['id'] is None): - raise ValueError("Missing the required parameter `id` when calling `get_state`") - + raise ValueError("Missing the required parameter `id` when calling `get_state4`") + collection_formats = {} path_params = {} @@ -672,12 +614,8 @@ def get_state_with_http_info(self, id, **kwargs): header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['*/*']) - # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/reporting-tasks/{id}/state', 'GET', path_params, @@ -688,62 +626,60 @@ def get_state_with_http_info(self, id, **kwargs): files=local_var_files, response_type='ComponentStateEntity', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def get_verification_request(self, id, request_id, **kwargs): + def get_verification_request3(self, id, request_id, **kwargs): """ - Returns the Verification Request with the given ID + Returns the Verification Request with the given ID. + Returns the Verification Request with the given ID. Once an Verification Request has been created, that request can subsequently be retrieved via this endpoint, and the request that is fetched will contain the updated state, such as percent complete, the current state of the request, and any failures. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_verification_request(id, request_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The ID of the Reporting Task (required) - :param str request_id: The ID of the Verification Request (required) - :return: VerifyConfigRequestEntity - If the method is called asynchronously, - returns the request thread. + + 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_verification_request3_with_http_info()`` method instead. + + Args: + id (str): + The ID of the Reporting Task (required) + request_id (str): + The ID of the Verification Request (required) + + Returns: + :class:`~nipyapi.nifi.models.VerifyConfigRequestEntity`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.get_verification_request_with_http_info(id, request_id, **kwargs) + return self.get_verification_request3_with_http_info(id, request_id, **kwargs) else: - (data) = self.get_verification_request_with_http_info(id, request_id, **kwargs) + (data) = self.get_verification_request3_with_http_info(id, request_id, **kwargs) return data - def get_verification_request_with_http_info(self, id, request_id, **kwargs): + def get_verification_request3_with_http_info(self, id, request_id, **kwargs): """ - Returns the Verification Request with the given ID + Returns the Verification Request with the given ID. + Returns the Verification Request with the given ID. Once an Verification Request has been created, that request can subsequently be retrieved via this endpoint, and the request that is fetched will contain the updated state, such as percent complete, the current state of the request, and any failures. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_verification_request_with_http_info(id, request_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The ID of the Reporting Task (required) - :param str request_id: The ID of the Verification Request (required) - :return: VerifyConfigRequestEntity - If the method is called asynchronously, - returns the request thread. + + 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_verification_request3()`` method instead. + + Args: + id (str): + The ID of the Reporting Task (required) + request_id (str): + The ID of the Verification Request (required) + + Returns: + tuple: (:class:`~nipyapi.nifi.models.VerifyConfigRequestEntity`, status_code, headers) - Response data with HTTP details. """ all_params = ['id', 'request_id'] - all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -753,18 +689,19 @@ def get_verification_request_with_http_info(self, id, request_id, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method get_verification_request" % key + " to method get_verification_request3" % 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_verification_request`") + raise ValueError("Missing the required parameter `id` when calling `get_verification_request3`") # 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_verification_request`") - + raise ValueError("Missing the required parameter `request_id` when calling `get_verification_request3`") + + collection_formats = {} path_params = {} @@ -785,12 +722,8 @@ def get_verification_request_with_http_info(self, id, request_id, **kwargs): header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['*/*']) - # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/reporting-tasks/{id}/config/verification-requests/{requestId}', 'GET', path_params, @@ -801,7 +734,6 @@ def get_verification_request_with_http_info(self, id, request_id, **kwargs): files=local_var_files, response_type='VerifyConfigRequestEntity', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), @@ -809,25 +741,24 @@ def get_verification_request_with_http_info(self, id, request_id, **kwargs): def remove_reporting_task(self, id, **kwargs): """ - Deletes a reporting task + Deletes a reporting task. + 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 + ``remove_reporting_task_with_http_info()`` method instead. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.remove_reporting_task(id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The reporting task id. (required) - :param str version: The revision is used to verify the client is working with the latest version of the flow. - :param str client_id: If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response. - :param bool disconnected_node_acknowledged: Acknowledges that this node is disconnected to allow for mutable requests to proceed. - :return: ReportingTaskEntity - If the method is called asynchronously, - returns the request thread. + Args: + id (str): + The reporting task 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.ReportingTaskEntity`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): @@ -838,29 +769,27 @@ def remove_reporting_task(self, id, **kwargs): def remove_reporting_task_with_http_info(self, id, **kwargs): """ - Deletes a reporting task + Deletes a reporting task. + 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 ``remove_reporting_task()`` method instead. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.remove_reporting_task_with_http_info(id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The reporting task id. (required) - :param str version: The revision is used to verify the client is working with the latest version of the flow. - :param str client_id: If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response. - :param bool disconnected_node_acknowledged: Acknowledges that this node is disconnected to allow for mutable requests to proceed. - :return: ReportingTaskEntity - If the method is called asynchronously, - returns the request thread. + Args: + id (str): + The reporting task 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.ReportingTaskEntity`, status_code, headers) - Response data with HTTP details. """ all_params = ['id', 'version', 'client_id', 'disconnected_node_acknowledged'] - all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -878,7 +807,10 @@ def remove_reporting_task_with_http_info(self, id, **kwargs): if ('id' not in params) or (params['id'] is None): raise ValueError("Missing the required parameter `id` when calling `remove_reporting_task`") - + + + + collection_formats = {} path_params = {} @@ -903,12 +835,8 @@ def remove_reporting_task_with_http_info(self, id, **kwargs): header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['*/*']) - # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/reporting-tasks/{id}', 'DELETE', path_params, @@ -919,62 +847,60 @@ def remove_reporting_task_with_http_info(self, id, **kwargs): files=local_var_files, response_type='ReportingTaskEntity', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def submit_config_verification_request(self, id, body, **kwargs): + def submit_config_verification_request2(self, body, id, **kwargs): """ - Performs verification of the Reporting Task's configuration + Performs verification of the Reporting Task's configuration. + This will initiate the process of verifying a given Reporting Task configuration. This may be a long-running task. As a result, this endpoint will immediately return a ReportingTaskConfigVerificationRequestEntity, and the process of performing the verification will occur asynchronously in the background. The client may then periodically poll the status of the request by issuing a GET request to /reporting-tasks/{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}. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.submit_config_verification_request(id, body, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The reporting task id. (required) - :param VerifyConfigRequestEntity body: The reporting task configuration verification request. (required) - :return: VerifyConfigRequestEntity - If the method is called asynchronously, - returns the request thread. + + 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_config_verification_request2_with_http_info()`` method instead. + + Args: + body (:class:`~nipyapi.nifi.models.VerifyConfigRequestEntity`): + The reporting task configuration verification request. (required) + id (str): + The reporting task id. (required) + + Returns: + :class:`~nipyapi.nifi.models.VerifyConfigRequestEntity`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.submit_config_verification_request_with_http_info(id, body, **kwargs) + return self.submit_config_verification_request2_with_http_info(body, id, **kwargs) else: - (data) = self.submit_config_verification_request_with_http_info(id, body, **kwargs) + (data) = self.submit_config_verification_request2_with_http_info(body, id, **kwargs) return data - def submit_config_verification_request_with_http_info(self, id, body, **kwargs): + def submit_config_verification_request2_with_http_info(self, body, id, **kwargs): """ - Performs verification of the Reporting Task's configuration + Performs verification of the Reporting Task's configuration. + This will initiate the process of verifying a given Reporting Task configuration. This may be a long-running task. As a result, this endpoint will immediately return a ReportingTaskConfigVerificationRequestEntity, and the process of performing the verification will occur asynchronously in the background. The client may then periodically poll the status of the request by issuing a GET request to /reporting-tasks/{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}. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.submit_config_verification_request_with_http_info(id, body, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The reporting task id. (required) - :param VerifyConfigRequestEntity body: The reporting task configuration verification request. (required) - :return: VerifyConfigRequestEntity - If the method is called asynchronously, - returns the request thread. + + 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_config_verification_request2()`` method instead. + + Args: + body (:class:`~nipyapi.nifi.models.VerifyConfigRequestEntity`): + The reporting task configuration verification request. (required) + id (str): + The reporting task id. (required) + + Returns: + tuple: (:class:`~nipyapi.nifi.models.VerifyConfigRequestEntity`, status_code, headers) - Response data with HTTP details. """ - all_params = ['id', 'body'] - all_params.append('callback') + all_params = ['body', 'id'] all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -984,18 +910,19 @@ def submit_config_verification_request_with_http_info(self, id, body, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method submit_config_verification_request" % key + " to method submit_config_verification_request2" % 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_config_verification_request`") # verify the required parameter 'body' is set if ('body' not in params) or (params['body'] is None): - raise ValueError("Missing the required parameter `body` when calling `submit_config_verification_request`") - + raise ValueError("Missing the required parameter `body` when calling `submit_config_verification_request2`") + # 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_config_verification_request2`") + + collection_formats = {} path_params = {} @@ -1021,7 +948,7 @@ def submit_config_verification_request_with_http_info(self, id, body, **kwargs): select_header_content_type(['application/json']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/reporting-tasks/{id}/config/verification-requests', 'POST', path_params, @@ -1032,62 +959,54 @@ def submit_config_verification_request_with_http_info(self, id, body, **kwargs): files=local_var_files, response_type='VerifyConfigRequestEntity', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def update_reporting_task(self, id, body, **kwargs): + def update_reporting_task(self, body, id, **kwargs): """ - Updates a reporting task + Updates a reporting task. + This method makes a synchronous HTTP request and returns the response data directly. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.update_reporting_task(id, body, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The reporting task id. (required) - :param ReportingTaskEntity body: The reporting task configuration details. (required) - :return: ReportingTaskEntity - If the method is called asynchronously, - returns the request thread. + For full HTTP response details (status code, headers, etc.), use the corresponding + ``update_reporting_task_with_http_info()`` method instead. + + Args: + body (:class:`~nipyapi.nifi.models.ReportingTaskEntity`): + The reporting task configuration details. (required) + id (str): + The reporting task id. (required) + + Returns: + :class:`~nipyapi.nifi.models.ReportingTaskEntity`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.update_reporting_task_with_http_info(id, body, **kwargs) + return self.update_reporting_task_with_http_info(body, id, **kwargs) else: - (data) = self.update_reporting_task_with_http_info(id, body, **kwargs) + (data) = self.update_reporting_task_with_http_info(body, id, **kwargs) return data - def update_reporting_task_with_http_info(self, id, body, **kwargs): + def update_reporting_task_with_http_info(self, body, id, **kwargs): """ - Updates a reporting task + Updates a reporting task. + 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 ``update_reporting_task()`` method instead. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.update_reporting_task_with_http_info(id, body, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The reporting task id. (required) - :param ReportingTaskEntity body: The reporting task configuration details. (required) - :return: ReportingTaskEntity - If the method is called asynchronously, - returns the request thread. + Args: + body (:class:`~nipyapi.nifi.models.ReportingTaskEntity`): + The reporting task configuration details. (required) + id (str): + The reporting task id. (required) + + Returns: + tuple: (:class:`~nipyapi.nifi.models.ReportingTaskEntity`, status_code, headers) - Response data with HTTP details. """ - all_params = ['id', 'body'] - all_params.append('callback') + all_params = ['body', 'id'] all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -1101,14 +1020,15 @@ def update_reporting_task_with_http_info(self, id, body, **kwargs): ) params[key] = val del params['kwargs'] - # verify the required parameter 'id' is set - if ('id' not in params) or (params['id'] is None): - raise ValueError("Missing the required parameter `id` when calling `update_reporting_task`") # verify the required parameter 'body' is set if ('body' not in params) or (params['body'] is None): raise ValueError("Missing the required parameter `body` when calling `update_reporting_task`") + # verify the required parameter 'id' is set + if ('id' not in params) or (params['id'] is None): + raise ValueError("Missing the required parameter `id` when calling `update_reporting_task`") - + + collection_formats = {} path_params = {} @@ -1134,7 +1054,7 @@ def update_reporting_task_with_http_info(self, id, body, **kwargs): select_header_content_type(['application/json']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/reporting-tasks/{id}', 'PUT', path_params, @@ -1145,62 +1065,54 @@ def update_reporting_task_with_http_info(self, id, body, **kwargs): files=local_var_files, response_type='ReportingTaskEntity', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def update_run_status(self, id, body, **kwargs): + def update_run_status5(self, body, id, **kwargs): """ - Updates run status of a reporting task + Updates run status of a reporting task. + 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 + ``update_run_status5_with_http_info()`` method instead. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.update_run_status(id, body, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The reporting task id. (required) - :param ReportingTaskRunStatusEntity body: The reporting task run status. (required) - :return: ReportingTaskEntity - If the method is called asynchronously, - returns the request thread. + Args: + body (:class:`~nipyapi.nifi.models.ReportingTaskRunStatusEntity`): + The reporting task run status. (required) + id (str): + The reporting task id. (required) + + Returns: + :class:`~nipyapi.nifi.models.ReportingTaskEntity`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.update_run_status_with_http_info(id, body, **kwargs) + return self.update_run_status5_with_http_info(body, id, **kwargs) else: - (data) = self.update_run_status_with_http_info(id, body, **kwargs) + (data) = self.update_run_status5_with_http_info(body, id, **kwargs) return data - def update_run_status_with_http_info(self, id, body, **kwargs): + def update_run_status5_with_http_info(self, body, id, **kwargs): """ - Updates run status of a reporting task + Updates run status of a reporting task. + 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 ``update_run_status5()`` method instead. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.update_run_status_with_http_info(id, body, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The reporting task id. (required) - :param ReportingTaskRunStatusEntity body: The reporting task run status. (required) - :return: ReportingTaskEntity - If the method is called asynchronously, - returns the request thread. + Args: + body (:class:`~nipyapi.nifi.models.ReportingTaskRunStatusEntity`): + The reporting task run status. (required) + id (str): + The reporting task id. (required) + + Returns: + tuple: (:class:`~nipyapi.nifi.models.ReportingTaskEntity`, status_code, headers) - Response data with HTTP details. """ - all_params = ['id', 'body'] - all_params.append('callback') + all_params = ['body', 'id'] all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -1210,18 +1122,19 @@ def update_run_status_with_http_info(self, id, body, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method update_run_status" % key + " to method update_run_status5" % key ) params[key] = val del params['kwargs'] - # verify the required parameter 'id' is set - if ('id' not in params) or (params['id'] is None): - raise ValueError("Missing the required parameter `id` when calling `update_run_status`") # verify the required parameter 'body' is set if ('body' not in params) or (params['body'] is None): - raise ValueError("Missing the required parameter `body` when calling `update_run_status`") - + raise ValueError("Missing the required parameter `body` when calling `update_run_status5`") + # verify the required parameter 'id' is set + if ('id' not in params) or (params['id'] is None): + raise ValueError("Missing the required parameter `id` when calling `update_run_status5`") + + collection_formats = {} path_params = {} @@ -1247,7 +1160,7 @@ def update_run_status_with_http_info(self, id, body, **kwargs): select_header_content_type(['application/json']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/reporting-tasks/{id}/run-status', 'PUT', path_params, @@ -1258,7 +1171,6 @@ def update_run_status_with_http_info(self, id, body, **kwargs): files=local_var_files, response_type='ReportingTaskEntity', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), diff --git a/nipyapi/nifi/apis/resources_api.py b/nipyapi/nifi/apis/resources_api.py index c372cae3..b88c0934 100644 --- a/nipyapi/nifi/apis/resources_api.py +++ b/nipyapi/nifi/apis/resources_api.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - import sys import os import re @@ -35,21 +34,16 @@ def __init__(self, api_client=None): def get_resources(self, **kwargs): """ - Gets the available resources that support access/authorization policies + Gets the available resources that support access/authorization policies. + 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_resources_with_http_info()`` method instead. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_resources(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :return: ResourcesEntity - If the method is called asynchronously, - returns the request thread. + Args: + + Returns: + :class:`~nipyapi.nifi.models.ResourcesEntity`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): @@ -60,25 +54,19 @@ def get_resources(self, **kwargs): def get_resources_with_http_info(self, **kwargs): """ - Gets the available resources that support access/authorization policies + Gets the available resources that support access/authorization policies. + This method makes a synchronous HTTP request and returns detailed response information. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_resources_with_http_info(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :return: ResourcesEntity - If the method is called asynchronously, - returns the request thread. + Returns the response data along with HTTP status code, headers, and other metadata. + For just the response data, use the corresponding ``get_resources()`` method instead. + + Args: + + Returns: + tuple: (:class:`~nipyapi.nifi.models.ResourcesEntity`, status_code, headers) - Response data with HTTP details. """ all_params = [] - all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -109,12 +97,8 @@ def get_resources_with_http_info(self, **kwargs): header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['*/*']) - # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/resources', 'GET', path_params, @@ -125,7 +109,6 @@ def get_resources_with_http_info(self, **kwargs): files=local_var_files, response_type='ResourcesEntity', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), diff --git a/nipyapi/nifi/apis/site_to_site_api.py b/nipyapi/nifi/apis/site_to_site_api.py index b47af19a..8b17a7ac 100644 --- a/nipyapi/nifi/apis/site_to_site_api.py +++ b/nipyapi/nifi/apis/site_to_site_api.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - import sys import os import re @@ -35,21 +34,16 @@ def __init__(self, api_client=None): def get_peers(self, **kwargs): """ - Returns the available Peers and its status of this NiFi + Returns the available Peers and its status of this NiFi. + 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_peers_with_http_info()`` method instead. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_peers(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :return: PeersEntity - If the method is called asynchronously, - returns the request thread. + Args: + + Returns: + :class:`~nipyapi.nifi.models.PeersEntity`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): @@ -60,25 +54,19 @@ def get_peers(self, **kwargs): def get_peers_with_http_info(self, **kwargs): """ - Returns the available Peers and its status of this NiFi + Returns the available Peers and its status of this NiFi. + This method makes a synchronous HTTP request and returns detailed response information. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_peers_with_http_info(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :return: PeersEntity - If the method is called asynchronously, - returns the request thread. + Returns the response data along with HTTP status code, headers, and other metadata. + For just the response data, use the corresponding ``get_peers()`` method instead. + + Args: + + Returns: + tuple: (:class:`~nipyapi.nifi.models.PeersEntity`, status_code, headers) - Response data with HTTP details. """ all_params = [] - all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -109,12 +97,8 @@ def get_peers_with_http_info(self, **kwargs): header_params['Accept'] = self.api_client.\ select_header_accept(['application/json', 'application/xml']) - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['*/*']) - # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/site-to-site/peers', 'GET', path_params, @@ -125,7 +109,6 @@ def get_peers_with_http_info(self, **kwargs): files=local_var_files, response_type='PeersEntity', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), @@ -133,21 +116,16 @@ def get_peers_with_http_info(self, **kwargs): def get_site_to_site_details(self, **kwargs): """ - Returns the details about this NiFi necessary to communicate via site to site + Returns the details about this NiFi necessary to communicate via site to site. + This method makes a synchronous HTTP request and returns the response data directly. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_site_to_site_details(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :return: ControllerEntity - If the method is called asynchronously, - returns the request thread. + For full HTTP response details (status code, headers, etc.), use the corresponding + ``get_site_to_site_details_with_http_info()`` method instead. + + Args: + + Returns: + :class:`~nipyapi.nifi.models.ControllerEntity`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): @@ -158,25 +136,19 @@ def get_site_to_site_details(self, **kwargs): def get_site_to_site_details_with_http_info(self, **kwargs): """ - Returns the details about this NiFi necessary to communicate via site to site + Returns the details about this NiFi necessary to communicate via site to site. + 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_site_to_site_details()`` method instead. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_site_to_site_details_with_http_info(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :return: ControllerEntity - If the method is called asynchronously, - returns the request thread. + Args: + + Returns: + tuple: (:class:`~nipyapi.nifi.models.ControllerEntity`, status_code, headers) - Response data with HTTP details. """ all_params = [] - all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -207,12 +179,8 @@ def get_site_to_site_details_with_http_info(self, **kwargs): header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['*/*']) - # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/site-to-site', 'GET', path_params, @@ -223,7 +191,6 @@ def get_site_to_site_details_with_http_info(self, **kwargs): files=local_var_files, response_type='ControllerEntity', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), diff --git a/nipyapi/nifi/apis/snippets_api.py b/nipyapi/nifi/apis/snippets_api.py index 8e67f43f..1f5d5042 100644 --- a/nipyapi/nifi/apis/snippets_api.py +++ b/nipyapi/nifi/apis/snippets_api.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - import sys import os import re @@ -35,22 +34,18 @@ def __init__(self, api_client=None): def create_snippet(self, body, **kwargs): """ - Creates a snippet. The snippet will be automatically discarded if not used in a subsequent request after 1 minute. + Creates a snippet. The snippet will be automatically discarded if not used in a subsequent request after 1 minute.. + This method makes a synchronous HTTP request and returns the response data directly. + + For full HTTP response details (status code, headers, etc.), use the corresponding + ``create_snippet_with_http_info()`` method instead. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.create_snippet(body, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param SnippetEntity body: The snippet configuration details. (required) - :return: SnippetEntity - If the method is called asynchronously, - returns the request thread. + Args: + body (:class:`~nipyapi.nifi.models.SnippetEntity`): + The snippet configuration details. (required) + + Returns: + :class:`~nipyapi.nifi.models.SnippetEntity`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): @@ -61,26 +56,21 @@ def create_snippet(self, body, **kwargs): def create_snippet_with_http_info(self, body, **kwargs): """ - Creates a snippet. The snippet will be automatically discarded if not used in a subsequent request after 1 minute. + Creates a snippet. The snippet will be automatically discarded if not used in a subsequent request after 1 minute.. + This method makes a synchronous HTTP request 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_snippet()`` method instead. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.create_snippet_with_http_info(body, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param SnippetEntity body: The snippet configuration details. (required) - :return: SnippetEntity - If the method is called asynchronously, - returns the request thread. + Args: + body (:class:`~nipyapi.nifi.models.SnippetEntity`): + The snippet configuration details. (required) + + Returns: + tuple: (:class:`~nipyapi.nifi.models.SnippetEntity`, status_code, headers) - Response data with HTTP details. """ all_params = ['body'] - all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -98,7 +88,7 @@ def create_snippet_with_http_info(self, body, **kwargs): if ('body' not in params) or (params['body'] is None): raise ValueError("Missing the required parameter `body` when calling `create_snippet`") - + collection_formats = {} path_params = {} @@ -122,7 +112,7 @@ def create_snippet_with_http_info(self, body, **kwargs): select_header_content_type(['application/json']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/snippets', 'POST', path_params, @@ -133,7 +123,6 @@ def create_snippet_with_http_info(self, body, **kwargs): files=local_var_files, response_type='SnippetEntity', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), @@ -141,23 +130,20 @@ def create_snippet_with_http_info(self, body, **kwargs): def delete_snippet(self, id, **kwargs): """ - Deletes the components in a snippet and discards the snippet + Deletes the components in a snippet and discards the snippet. + 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_snippet_with_http_info()`` method instead. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.delete_snippet(id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The snippet id. (required) - :param bool disconnected_node_acknowledged: Acknowledges that this node is disconnected to allow for mutable requests to proceed. - :return: SnippetEntity - If the method is called asynchronously, - returns the request thread. + Args: + id (str): + The snippet id. (required) + disconnected_node_acknowledged (bool): + Acknowledges that this node is disconnected to allow for mutable requests to proceed. + + Returns: + :class:`~nipyapi.nifi.models.SnippetEntity`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): @@ -168,27 +154,23 @@ def delete_snippet(self, id, **kwargs): def delete_snippet_with_http_info(self, id, **kwargs): """ - Deletes the components in a snippet and discards the snippet + Deletes the components in a snippet and discards the snippet. + This method makes a synchronous HTTP request and returns detailed response information. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.delete_snippet_with_http_info(id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The snippet id. (required) - :param bool disconnected_node_acknowledged: Acknowledges that this node is disconnected to allow for mutable requests to proceed. - :return: SnippetEntity - If the method is called asynchronously, - returns the request thread. + Returns the response data along with HTTP status code, headers, and other metadata. + For just the response data, use the corresponding ``delete_snippet()`` method instead. + + Args: + id (str): + The snippet id. (required) + disconnected_node_acknowledged (bool): + Acknowledges that this node is disconnected to allow for mutable requests to proceed. + + Returns: + tuple: (:class:`~nipyapi.nifi.models.SnippetEntity`, status_code, headers) - Response data with HTTP details. """ all_params = ['id', 'disconnected_node_acknowledged'] - all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -206,7 +188,8 @@ def delete_snippet_with_http_info(self, id, **kwargs): if ('id' not in params) or (params['id'] is None): raise ValueError("Missing the required parameter `id` when calling `delete_snippet`") - + + collection_formats = {} path_params = {} @@ -227,12 +210,8 @@ def delete_snippet_with_http_info(self, id, **kwargs): header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['*/*']) - # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/snippets/{id}', 'DELETE', path_params, @@ -243,62 +222,54 @@ def delete_snippet_with_http_info(self, id, **kwargs): files=local_var_files, response_type='SnippetEntity', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def update_snippet(self, id, body, **kwargs): + def update_snippet(self, body, id, **kwargs): """ - Move's the components in this Snippet into a new Process Group and discards the snippet + Move's the components in this Snippet into a new Process Group and discards the snippet. + This method makes a synchronous HTTP request and returns the response data directly. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.update_snippet(id, body, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The snippet id. (required) - :param SnippetEntity body: The snippet configuration details. (required) - :return: SnippetEntity - If the method is called asynchronously, - returns the request thread. + For full HTTP response details (status code, headers, etc.), use the corresponding + ``update_snippet_with_http_info()`` method instead. + + Args: + body (:class:`~nipyapi.nifi.models.SnippetEntity`): + The snippet configuration details. (required) + id (str): + The snippet id. (required) + + Returns: + :class:`~nipyapi.nifi.models.SnippetEntity`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.update_snippet_with_http_info(id, body, **kwargs) + return self.update_snippet_with_http_info(body, id, **kwargs) else: - (data) = self.update_snippet_with_http_info(id, body, **kwargs) + (data) = self.update_snippet_with_http_info(body, id, **kwargs) return data - def update_snippet_with_http_info(self, id, body, **kwargs): + def update_snippet_with_http_info(self, body, id, **kwargs): """ - Move's the components in this Snippet into a new Process Group and discards the snippet + Move's the components in this Snippet into a new Process Group and discards the snippet. + 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 ``update_snippet()`` method instead. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.update_snippet_with_http_info(id, body, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The snippet id. (required) - :param SnippetEntity body: The snippet configuration details. (required) - :return: SnippetEntity - If the method is called asynchronously, - returns the request thread. + Args: + body (:class:`~nipyapi.nifi.models.SnippetEntity`): + The snippet configuration details. (required) + id (str): + The snippet id. (required) + + Returns: + tuple: (:class:`~nipyapi.nifi.models.SnippetEntity`, status_code, headers) - Response data with HTTP details. """ - all_params = ['id', 'body'] - all_params.append('callback') + all_params = ['body', 'id'] all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -312,14 +283,15 @@ def update_snippet_with_http_info(self, id, body, **kwargs): ) params[key] = val del params['kwargs'] - # verify the required parameter 'id' is set - if ('id' not in params) or (params['id'] is None): - raise ValueError("Missing the required parameter `id` when calling `update_snippet`") # verify the required parameter 'body' is set if ('body' not in params) or (params['body'] is None): raise ValueError("Missing the required parameter `body` when calling `update_snippet`") + # verify the required parameter 'id' is set + if ('id' not in params) or (params['id'] is None): + raise ValueError("Missing the required parameter `id` when calling `update_snippet`") - + + collection_formats = {} path_params = {} @@ -345,7 +317,7 @@ def update_snippet_with_http_info(self, id, body, **kwargs): select_header_content_type(['application/json']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/snippets/{id}', 'PUT', path_params, @@ -356,7 +328,6 @@ def update_snippet_with_http_info(self, id, body, **kwargs): files=local_var_files, response_type='SnippetEntity', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), diff --git a/nipyapi/nifi/apis/system_diagnostics_api.py b/nipyapi/nifi/apis/system_diagnostics_api.py index a3fe8c65..2872c98c 100644 --- a/nipyapi/nifi/apis/system_diagnostics_api.py +++ b/nipyapi/nifi/apis/system_diagnostics_api.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - import sys import os import re @@ -35,22 +34,21 @@ def __init__(self, api_client=None): def get_jmx_metrics(self, **kwargs): """ - Retrieve available JMX metrics + Retrieve available JMX metrics. + Note: This endpoint is subject to change as NiFi and it's REST API evolve. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_jmx_metrics(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str bean_name_filter: Regular Expression Pattern to be applied against the ObjectName - :return: JmxMetricsResultsEntity - If the method is called asynchronously, - returns the request thread. + + 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_jmx_metrics_with_http_info()`` method instead. + + Args: + bean_name_filter (str): + Regular Expression Pattern to be applied against the ObjectName + + Returns: + :class:`~nipyapi.nifi.models.JmxMetricsResultsEntity`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): @@ -61,26 +59,24 @@ def get_jmx_metrics(self, **kwargs): def get_jmx_metrics_with_http_info(self, **kwargs): """ - Retrieve available JMX metrics + Retrieve available JMX metrics. + Note: This endpoint is subject to change as NiFi and it's REST API evolve. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_jmx_metrics_with_http_info(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str bean_name_filter: Regular Expression Pattern to be applied against the ObjectName - :return: JmxMetricsResultsEntity - If the method is called asynchronously, - returns the request thread. + + 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_jmx_metrics()`` method instead. + + Args: + bean_name_filter (str): + Regular Expression Pattern to be applied against the ObjectName + + Returns: + tuple: (:class:`~nipyapi.nifi.models.JmxMetricsResultsEntity`, status_code, headers) - Response data with HTTP details. """ all_params = ['bean_name_filter'] - all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -95,7 +91,7 @@ def get_jmx_metrics_with_http_info(self, **kwargs): params[key] = val del params['kwargs'] - + collection_formats = {} path_params = {} @@ -114,12 +110,8 @@ def get_jmx_metrics_with_http_info(self, **kwargs): header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['application/json']) - # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/system-diagnostics/jmx-metrics', 'GET', path_params, @@ -130,7 +122,6 @@ def get_jmx_metrics_with_http_info(self, **kwargs): files=local_var_files, response_type='JmxMetricsResultsEntity', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), @@ -138,23 +129,22 @@ def get_jmx_metrics_with_http_info(self, **kwargs): def get_system_diagnostics(self, **kwargs): """ - Gets the diagnostics for the system NiFi is running on + Gets the diagnostics for the system NiFi is running on. + 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_system_diagnostics_with_http_info()`` method instead. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_system_diagnostics(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param bool nodewise: Whether or not to include the breakdown per node. Optional, defaults to false - :param str cluster_node_id: The id of the node where to get the status. - :return: SystemDiagnosticsEntity - If the method is called asynchronously, - returns the request thread. + Args: + nodewise (bool): + Whether or not to include the breakdown per node. Optional, defaults to false + diagnostic_level (str): + Whether or not to include verbose details. Optional, defaults to false + cluster_node_id (str): + The id of the node where to get the status. + + Returns: + :class:`~nipyapi.nifi.models.SystemDiagnosticsEntity`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): @@ -165,27 +155,25 @@ def get_system_diagnostics(self, **kwargs): def get_system_diagnostics_with_http_info(self, **kwargs): """ - Gets the diagnostics for the system NiFi is running on + Gets the diagnostics for the system NiFi is running on. + This method makes a synchronous HTTP request and returns detailed response information. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_system_diagnostics_with_http_info(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param bool nodewise: Whether or not to include the breakdown per node. Optional, defaults to false - :param str cluster_node_id: The id of the node where to get the status. - :return: SystemDiagnosticsEntity - If the method is called asynchronously, - returns the request thread. + Returns the response data along with HTTP status code, headers, and other metadata. + For just the response data, use the corresponding ``get_system_diagnostics()`` method instead. + + Args: + nodewise (bool): + Whether or not to include the breakdown per node. Optional, defaults to false + diagnostic_level (str): + Whether or not to include verbose details. Optional, defaults to false + cluster_node_id (str): + The id of the node where to get the status. + + Returns: + tuple: (:class:`~nipyapi.nifi.models.SystemDiagnosticsEntity`, status_code, headers) - Response data with HTTP details. """ - all_params = ['nodewise', 'cluster_node_id'] - all_params.append('callback') + all_params = ['nodewise', 'diagnostic_level', 'cluster_node_id'] all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -200,7 +188,9 @@ def get_system_diagnostics_with_http_info(self, **kwargs): params[key] = val del params['kwargs'] - + + + collection_formats = {} path_params = {} @@ -208,6 +198,8 @@ def get_system_diagnostics_with_http_info(self, **kwargs): query_params = [] if 'nodewise' in params: query_params.append(('nodewise', params['nodewise'])) + if 'diagnostic_level' in params: + query_params.append(('diagnosticLevel', params['diagnostic_level'])) if 'cluster_node_id' in params: query_params.append(('clusterNodeId', params['cluster_node_id'])) @@ -221,12 +213,8 @@ def get_system_diagnostics_with_http_info(self, **kwargs): header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['*/*']) - # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/system-diagnostics', 'GET', path_params, @@ -237,7 +225,6 @@ def get_system_diagnostics_with_http_info(self, **kwargs): files=local_var_files, response_type='SystemDiagnosticsEntity', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), diff --git a/nipyapi/nifi/apis/templates_api.py b/nipyapi/nifi/apis/templates_api.py deleted file mode 100644 index 6b60a4f3..00000000 --- a/nipyapi/nifi/apis/templates_api.py +++ /dev/null @@ -1,250 +0,0 @@ -""" - NiFi Rest API - - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - - OpenAPI spec version: 1.28.1 - Contact: dev@nifi.apache.org - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - - -import sys -import os -import re - -from ..configuration import Configuration -from ..api_client import ApiClient - - -class TemplatesApi(object): - """ - NOTE: This class is auto generated by the swagger code generator program. - Do not edit the class manually. - Ref: https://github.com/swagger-api/swagger-codegen - """ - - def __init__(self, api_client=None): - config = Configuration() - if api_client: - self.api_client = api_client - else: - if not config.api_client: - config.api_client = ApiClient() - self.api_client = config.api_client - - def export_template(self, id, **kwargs): - """ - Exports a template - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.export_template(id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The template id. (required) - :return: str - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.export_template_with_http_info(id, **kwargs) - else: - (data) = self.export_template_with_http_info(id, **kwargs) - return data - - def export_template_with_http_info(self, id, **kwargs): - """ - Exports a template - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.export_template_with_http_info(id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The template id. (required) - :return: str - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['id'] - all_params.append('callback') - all_params.append('_return_http_data_only') - all_params.append('_preload_content') - all_params.append('_request_timeout') - - params = locals() - for key, val in params['kwargs'].items(): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method export_template" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'id' is set - if ('id' not in params) or (params['id'] is None): - raise ValueError("Missing the required parameter `id` when calling `export_template`") - - - 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/xml']) - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['*/*']) - - # Authentication setting - auth_settings = ['tokenAuth'] - - return self.api_client.call_api('/templates/{id}/download', 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='str', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only'), - _preload_content=params.get('_preload_content', True), - _request_timeout=params.get('_request_timeout'), - collection_formats=collection_formats) - - def remove_template(self, id, **kwargs): - """ - Deletes a template - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.remove_template(id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The template id. (required) - :param bool disconnected_node_acknowledged: Acknowledges that this node is disconnected to allow for mutable requests to proceed. - :return: TemplateEntity - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.remove_template_with_http_info(id, **kwargs) - else: - (data) = self.remove_template_with_http_info(id, **kwargs) - return data - - def remove_template_with_http_info(self, id, **kwargs): - """ - Deletes a template - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.remove_template_with_http_info(id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The template id. (required) - :param bool disconnected_node_acknowledged: Acknowledges that this node is disconnected to allow for mutable requests to proceed. - :return: TemplateEntity - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['id', 'disconnected_node_acknowledged'] - all_params.append('callback') - all_params.append('_return_http_data_only') - all_params.append('_preload_content') - all_params.append('_request_timeout') - - params = locals() - for key, val in params['kwargs'].items(): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method remove_template" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'id' is set - if ('id' not in params) or (params['id'] is None): - raise ValueError("Missing the required parameter `id` when calling `remove_template`") - - - collection_formats = {} - - path_params = {} - if 'id' in params: - path_params['id'] = params['id'] - - query_params = [] - if 'disconnected_node_acknowledged' in params: - query_params.append(('disconnectedNodeAcknowledged', params['disconnected_node_acknowledged'])) - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['*/*']) - - # Authentication setting - auth_settings = ['tokenAuth'] - - return self.api_client.call_api('/templates/{id}', 'DELETE', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='TemplateEntity', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only'), - _preload_content=params.get('_preload_content', True), - _request_timeout=params.get('_request_timeout'), - collection_formats=collection_formats) diff --git a/nipyapi/nifi/apis/tenants_api.py b/nipyapi/nifi/apis/tenants_api.py index f064a864..f831a40d 100644 --- a/nipyapi/nifi/apis/tenants_api.py +++ b/nipyapi/nifi/apis/tenants_api.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - import sys import os import re @@ -35,22 +34,21 @@ def __init__(self, api_client=None): def create_user(self, body, **kwargs): """ - Creates a user + Creates a user. + Note: This endpoint is subject to change as NiFi and it's REST API evolve. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.create_user(body, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param UserEntity body: The user configuration details. (required) - :return: UserEntity - If the method is called asynchronously, - returns the request thread. + + 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_user_with_http_info()`` method instead. + + Args: + body (:class:`~nipyapi.nifi.models.UserEntity`): + The user configuration details. (required) + + Returns: + :class:`~nipyapi.nifi.models.UserEntity`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): @@ -61,26 +59,24 @@ def create_user(self, body, **kwargs): def create_user_with_http_info(self, body, **kwargs): """ - Creates a user + Creates a user. + Note: This endpoint is subject to change as NiFi and it's REST API evolve. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.create_user_with_http_info(body, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param UserEntity body: The user configuration details. (required) - :return: UserEntity - If the method is called asynchronously, - returns the request thread. + + 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_user()`` method instead. + + Args: + body (:class:`~nipyapi.nifi.models.UserEntity`): + The user configuration details. (required) + + Returns: + tuple: (:class:`~nipyapi.nifi.models.UserEntity`, status_code, headers) - Response data with HTTP details. """ all_params = ['body'] - all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -98,7 +94,7 @@ def create_user_with_http_info(self, body, **kwargs): if ('body' not in params) or (params['body'] is None): raise ValueError("Missing the required parameter `body` when calling `create_user`") - + collection_formats = {} path_params = {} @@ -122,7 +118,7 @@ def create_user_with_http_info(self, body, **kwargs): select_header_content_type(['application/json']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/tenants/users', 'POST', path_params, @@ -133,7 +129,6 @@ def create_user_with_http_info(self, body, **kwargs): files=local_var_files, response_type='UserEntity', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), @@ -141,22 +136,21 @@ def create_user_with_http_info(self, body, **kwargs): def create_user_group(self, body, **kwargs): """ - Creates a user group + Creates a user group. + Note: This endpoint is subject to change as NiFi and it's REST API evolve. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.create_user_group(body, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param UserGroupEntity body: The user group configuration details. (required) - :return: UserGroupEntity - If the method is called asynchronously, - returns the request thread. + + 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_user_group_with_http_info()`` method instead. + + Args: + body (:class:`~nipyapi.nifi.models.UserGroupEntity`): + The user group configuration details. (required) + + Returns: + :class:`~nipyapi.nifi.models.UserGroupEntity`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): @@ -167,26 +161,24 @@ def create_user_group(self, body, **kwargs): def create_user_group_with_http_info(self, body, **kwargs): """ - Creates a user group + Creates a user group. + Note: This endpoint is subject to change as NiFi and it's REST API evolve. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.create_user_group_with_http_info(body, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param UserGroupEntity body: The user group configuration details. (required) - :return: UserGroupEntity - If the method is called asynchronously, - returns the request thread. + + 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_user_group()`` method instead. + + Args: + body (:class:`~nipyapi.nifi.models.UserGroupEntity`): + The user group configuration details. (required) + + Returns: + tuple: (:class:`~nipyapi.nifi.models.UserGroupEntity`, status_code, headers) - Response data with HTTP details. """ all_params = ['body'] - all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -204,7 +196,7 @@ def create_user_group_with_http_info(self, body, **kwargs): if ('body' not in params) or (params['body'] is None): raise ValueError("Missing the required parameter `body` when calling `create_user_group`") - + collection_formats = {} path_params = {} @@ -228,7 +220,7 @@ def create_user_group_with_http_info(self, body, **kwargs): select_header_content_type(['application/json']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/tenants/user-groups', 'POST', path_params, @@ -239,7 +231,6 @@ def create_user_group_with_http_info(self, body, **kwargs): files=local_var_files, response_type='UserGroupEntity', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), @@ -247,22 +238,21 @@ def create_user_group_with_http_info(self, body, **kwargs): def get_user(self, id, **kwargs): """ - Gets a user + Gets a user. + Note: This endpoint is subject to change as NiFi and it's REST API evolve. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_user(id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The user id. (required) - :return: UserEntity - If the method is called asynchronously, - returns the request thread. + + 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_user_with_http_info()`` method instead. + + Args: + id (str): + The user id. (required) + + Returns: + :class:`~nipyapi.nifi.models.UserEntity`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): @@ -273,26 +263,24 @@ def get_user(self, id, **kwargs): def get_user_with_http_info(self, id, **kwargs): """ - Gets a user + Gets a user. + Note: This endpoint is subject to change as NiFi and it's REST API evolve. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_user_with_http_info(id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The user id. (required) - :return: UserEntity - If the method is called asynchronously, - returns the request thread. + + 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_user()`` method instead. + + Args: + id (str): + The user id. (required) + + Returns: + tuple: (:class:`~nipyapi.nifi.models.UserEntity`, status_code, headers) - Response data with HTTP details. """ all_params = ['id'] - all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -310,7 +298,7 @@ def get_user_with_http_info(self, id, **kwargs): if ('id' not in params) or (params['id'] is None): raise ValueError("Missing the required parameter `id` when calling `get_user`") - + collection_formats = {} path_params = {} @@ -329,12 +317,8 @@ def get_user_with_http_info(self, id, **kwargs): header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['*/*']) - # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/tenants/users/{id}', 'GET', path_params, @@ -345,7 +329,6 @@ def get_user_with_http_info(self, id, **kwargs): files=local_var_files, response_type='UserEntity', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), @@ -353,22 +336,21 @@ def get_user_with_http_info(self, id, **kwargs): def get_user_group(self, id, **kwargs): """ - Gets a user group + Gets a user group. + Note: This endpoint is subject to change as NiFi and it's REST API evolve. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_user_group(id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The user group id. (required) - :return: UserGroupEntity - If the method is called asynchronously, - returns the request thread. + + 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_user_group_with_http_info()`` method instead. + + Args: + id (str): + The user group id. (required) + + Returns: + :class:`~nipyapi.nifi.models.UserGroupEntity`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): @@ -379,26 +361,24 @@ def get_user_group(self, id, **kwargs): def get_user_group_with_http_info(self, id, **kwargs): """ - Gets a user group + Gets a user group. + Note: This endpoint is subject to change as NiFi and it's REST API evolve. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_user_group_with_http_info(id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The user group id. (required) - :return: UserGroupEntity - If the method is called asynchronously, - returns the request thread. + + 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_user_group()`` method instead. + + Args: + id (str): + The user group id. (required) + + Returns: + tuple: (:class:`~nipyapi.nifi.models.UserGroupEntity`, status_code, headers) - Response data with HTTP details. """ all_params = ['id'] - all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -416,7 +396,7 @@ def get_user_group_with_http_info(self, id, **kwargs): if ('id' not in params) or (params['id'] is None): raise ValueError("Missing the required parameter `id` when calling `get_user_group`") - + collection_formats = {} path_params = {} @@ -435,12 +415,8 @@ def get_user_group_with_http_info(self, id, **kwargs): header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['*/*']) - # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/tenants/user-groups/{id}', 'GET', path_params, @@ -451,7 +427,6 @@ def get_user_group_with_http_info(self, id, **kwargs): files=local_var_files, response_type='UserGroupEntity', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), @@ -459,21 +434,19 @@ def get_user_group_with_http_info(self, id, **kwargs): def get_user_groups(self, **kwargs): """ - Gets all user groups + Gets all user groups. + Note: This endpoint is subject to change as NiFi and it's REST API evolve. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_user_groups(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :return: UserGroupsEntity - If the method is called asynchronously, - returns the request thread. + + 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_user_groups_with_http_info()`` method instead. + + Args: + + Returns: + :class:`~nipyapi.nifi.models.UserGroupsEntity`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): @@ -484,25 +457,22 @@ def get_user_groups(self, **kwargs): def get_user_groups_with_http_info(self, **kwargs): """ - Gets all user groups + Gets all user groups. + Note: This endpoint is subject to change as NiFi and it's REST API evolve. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_user_groups_with_http_info(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :return: UserGroupsEntity - If the method is called asynchronously, - returns the request thread. + + 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_user_groups()`` method instead. + + Args: + + Returns: + tuple: (:class:`~nipyapi.nifi.models.UserGroupsEntity`, status_code, headers) - Response data with HTTP details. """ all_params = [] - all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -533,12 +503,8 @@ def get_user_groups_with_http_info(self, **kwargs): header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['*/*']) - # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/tenants/user-groups', 'GET', path_params, @@ -549,7 +515,6 @@ def get_user_groups_with_http_info(self, **kwargs): files=local_var_files, response_type='UserGroupsEntity', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), @@ -557,21 +522,19 @@ def get_user_groups_with_http_info(self, **kwargs): def get_users(self, **kwargs): """ - Gets all users + Gets all users. + Note: This endpoint is subject to change as NiFi and it's REST API evolve. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_users(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :return: UsersEntity - If the method is called asynchronously, - returns the request thread. + + 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_users_with_http_info()`` method instead. + + Args: + + Returns: + :class:`~nipyapi.nifi.models.UsersEntity`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): @@ -582,25 +545,22 @@ def get_users(self, **kwargs): def get_users_with_http_info(self, **kwargs): """ - Gets all users + Gets all users. + Note: This endpoint is subject to change as NiFi and it's REST API evolve. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_users_with_http_info(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :return: UsersEntity - If the method is called asynchronously, - returns the request thread. + + 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_users()`` method instead. + + Args: + + Returns: + tuple: (:class:`~nipyapi.nifi.models.UsersEntity`, status_code, headers) - Response data with HTTP details. """ all_params = [] - all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -631,12 +591,8 @@ def get_users_with_http_info(self, **kwargs): header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['*/*']) - # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/tenants/users', 'GET', path_params, @@ -647,7 +603,6 @@ def get_users_with_http_info(self, **kwargs): files=local_var_files, response_type='UsersEntity', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), @@ -655,25 +610,27 @@ def get_users_with_http_info(self, **kwargs): def remove_user(self, id, **kwargs): """ - Deletes a user + Deletes a user. + Note: This endpoint is subject to change as NiFi and it's REST API evolve. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.remove_user(id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The user id. (required) - :param str version: The revision is used to verify the client is working with the latest version of the flow. - :param str client_id: If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response. - :param bool disconnected_node_acknowledged: Acknowledges that this node is disconnected to allow for mutable requests to proceed. - :return: UserEntity - If the method is called asynchronously, - returns the request thread. + + 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 + ``remove_user_with_http_info()`` method instead. + + Args: + id (str): + The user 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.UserEntity`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): @@ -684,29 +641,30 @@ def remove_user(self, id, **kwargs): def remove_user_with_http_info(self, id, **kwargs): """ - Deletes a user + Deletes a user. + Note: This endpoint is subject to change as NiFi and it's REST API evolve. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.remove_user_with_http_info(id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The user id. (required) - :param str version: The revision is used to verify the client is working with the latest version of the flow. - :param str client_id: If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response. - :param bool disconnected_node_acknowledged: Acknowledges that this node is disconnected to allow for mutable requests to proceed. - :return: UserEntity - If the method is called asynchronously, - returns the request thread. + + 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 ``remove_user()`` method instead. + + Args: + id (str): + The user 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.UserEntity`, status_code, headers) - Response data with HTTP details. """ all_params = ['id', 'version', 'client_id', 'disconnected_node_acknowledged'] - all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -724,7 +682,10 @@ def remove_user_with_http_info(self, id, **kwargs): if ('id' not in params) or (params['id'] is None): raise ValueError("Missing the required parameter `id` when calling `remove_user`") - + + + + collection_formats = {} path_params = {} @@ -749,12 +710,8 @@ def remove_user_with_http_info(self, id, **kwargs): header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['*/*']) - # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/tenants/users/{id}', 'DELETE', path_params, @@ -765,7 +722,6 @@ def remove_user_with_http_info(self, id, **kwargs): files=local_var_files, response_type='UserEntity', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), @@ -773,25 +729,27 @@ def remove_user_with_http_info(self, id, **kwargs): def remove_user_group(self, id, **kwargs): """ - Deletes a user group + Deletes a user group. + Note: This endpoint is subject to change as NiFi and it's REST API evolve. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.remove_user_group(id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The user group id. (required) - :param str version: The revision is used to verify the client is working with the latest version of the flow. - :param str client_id: If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response. - :param bool disconnected_node_acknowledged: Acknowledges that this node is disconnected to allow for mutable requests to proceed. - :return: UserGroupEntity - If the method is called asynchronously, - returns the request thread. + + 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 + ``remove_user_group_with_http_info()`` method instead. + + Args: + id (str): + The user group 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.UserGroupEntity`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): @@ -802,29 +760,30 @@ def remove_user_group(self, id, **kwargs): def remove_user_group_with_http_info(self, id, **kwargs): """ - Deletes a user group + Deletes a user group. + Note: This endpoint is subject to change as NiFi and it's REST API evolve. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.remove_user_group_with_http_info(id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The user group id. (required) - :param str version: The revision is used to verify the client is working with the latest version of the flow. - :param str client_id: If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response. - :param bool disconnected_node_acknowledged: Acknowledges that this node is disconnected to allow for mutable requests to proceed. - :return: UserGroupEntity - If the method is called asynchronously, - returns the request thread. + + 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 ``remove_user_group()`` method instead. + + Args: + id (str): + The user group 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.UserGroupEntity`, status_code, headers) - Response data with HTTP details. """ all_params = ['id', 'version', 'client_id', 'disconnected_node_acknowledged'] - all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -842,7 +801,10 @@ def remove_user_group_with_http_info(self, id, **kwargs): if ('id' not in params) or (params['id'] is None): raise ValueError("Missing the required parameter `id` when calling `remove_user_group`") - + + + + collection_formats = {} path_params = {} @@ -867,12 +829,8 @@ def remove_user_group_with_http_info(self, id, **kwargs): header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['*/*']) - # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/tenants/user-groups/{id}', 'DELETE', path_params, @@ -883,7 +841,6 @@ def remove_user_group_with_http_info(self, id, **kwargs): files=local_var_files, response_type='UserGroupEntity', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), @@ -891,22 +848,21 @@ def remove_user_group_with_http_info(self, id, **kwargs): def search_tenants(self, q, **kwargs): """ - Searches for a tenant with the specified identity + Searches for a tenant with the specified identity. + Note: This endpoint is subject to change as NiFi and it's REST API evolve. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.search_tenants(q, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str q: Identity to search for. (required) - :return: TenantsEntity - If the method is called asynchronously, - returns the request thread. + + 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 + ``search_tenants_with_http_info()`` method instead. + + Args: + q (str): + Identity to search for. (required) + + Returns: + :class:`~nipyapi.nifi.models.TenantsEntity`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): @@ -917,26 +873,24 @@ def search_tenants(self, q, **kwargs): def search_tenants_with_http_info(self, q, **kwargs): """ - Searches for a tenant with the specified identity + Searches for a tenant with the specified identity. + Note: This endpoint is subject to change as NiFi and it's REST API evolve. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.search_tenants_with_http_info(q, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str q: Identity to search for. (required) - :return: TenantsEntity - If the method is called asynchronously, - returns the request thread. + + 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 ``search_tenants()`` method instead. + + Args: + q (str): + Identity to search for. (required) + + Returns: + tuple: (:class:`~nipyapi.nifi.models.TenantsEntity`, status_code, headers) - Response data with HTTP details. """ all_params = ['q'] - all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -954,7 +908,7 @@ def search_tenants_with_http_info(self, q, **kwargs): if ('q' not in params) or (params['q'] is None): raise ValueError("Missing the required parameter `q` when calling `search_tenants`") - + collection_formats = {} path_params = {} @@ -973,12 +927,8 @@ def search_tenants_with_http_info(self, q, **kwargs): header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['*/*']) - # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/tenants/search-results', 'GET', path_params, @@ -989,62 +939,60 @@ def search_tenants_with_http_info(self, q, **kwargs): files=local_var_files, response_type='TenantsEntity', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def update_user(self, id, body, **kwargs): + def update_user(self, body, id, **kwargs): """ - Updates a user + Updates a user. + Note: This endpoint is subject to change as NiFi and it's REST API evolve. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.update_user(id, body, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The user id. (required) - :param UserEntity body: The user configuration details. (required) - :return: UserEntity - If the method is called asynchronously, - returns the request thread. + + 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 + ``update_user_with_http_info()`` method instead. + + Args: + body (:class:`~nipyapi.nifi.models.UserEntity`): + The user configuration details. (required) + id (str): + The user id. (required) + + Returns: + :class:`~nipyapi.nifi.models.UserEntity`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.update_user_with_http_info(id, body, **kwargs) + return self.update_user_with_http_info(body, id, **kwargs) else: - (data) = self.update_user_with_http_info(id, body, **kwargs) + (data) = self.update_user_with_http_info(body, id, **kwargs) return data - def update_user_with_http_info(self, id, body, **kwargs): + def update_user_with_http_info(self, body, id, **kwargs): """ - Updates a user + Updates a user. + Note: This endpoint is subject to change as NiFi and it's REST API evolve. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.update_user_with_http_info(id, body, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The user id. (required) - :param UserEntity body: The user configuration details. (required) - :return: UserEntity - If the method is called asynchronously, - returns the request thread. + + 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 ``update_user()`` method instead. + + Args: + body (:class:`~nipyapi.nifi.models.UserEntity`): + The user configuration details. (required) + id (str): + The user id. (required) + + Returns: + tuple: (:class:`~nipyapi.nifi.models.UserEntity`, status_code, headers) - Response data with HTTP details. """ - all_params = ['id', 'body'] - all_params.append('callback') + all_params = ['body', 'id'] all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -1058,14 +1006,15 @@ def update_user_with_http_info(self, id, body, **kwargs): ) params[key] = val del params['kwargs'] - # verify the required parameter 'id' is set - if ('id' not in params) or (params['id'] is None): - raise ValueError("Missing the required parameter `id` when calling `update_user`") # verify the required parameter 'body' is set if ('body' not in params) or (params['body'] is None): raise ValueError("Missing the required parameter `body` when calling `update_user`") + # verify the required parameter 'id' is set + if ('id' not in params) or (params['id'] is None): + raise ValueError("Missing the required parameter `id` when calling `update_user`") - + + collection_formats = {} path_params = {} @@ -1091,7 +1040,7 @@ def update_user_with_http_info(self, id, body, **kwargs): select_header_content_type(['application/json']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/tenants/users/{id}', 'PUT', path_params, @@ -1102,62 +1051,60 @@ def update_user_with_http_info(self, id, body, **kwargs): files=local_var_files, response_type='UserEntity', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def update_user_group(self, id, body, **kwargs): + def update_user_group(self, body, id, **kwargs): """ - Updates a user group + Updates a user group. + Note: This endpoint is subject to change as NiFi and it's REST API evolve. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.update_user_group(id, body, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The user group id. (required) - :param UserGroupEntity body: The user group configuration details. (required) - :return: UserGroupEntity - If the method is called asynchronously, - returns the request thread. + + 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 + ``update_user_group_with_http_info()`` method instead. + + Args: + body (:class:`~nipyapi.nifi.models.UserGroupEntity`): + The user group configuration details. (required) + id (str): + The user group id. (required) + + Returns: + :class:`~nipyapi.nifi.models.UserGroupEntity`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.update_user_group_with_http_info(id, body, **kwargs) + return self.update_user_group_with_http_info(body, id, **kwargs) else: - (data) = self.update_user_group_with_http_info(id, body, **kwargs) + (data) = self.update_user_group_with_http_info(body, id, **kwargs) return data - def update_user_group_with_http_info(self, id, body, **kwargs): + def update_user_group_with_http_info(self, body, id, **kwargs): """ - Updates a user group + Updates a user group. + Note: This endpoint is subject to change as NiFi and it's REST API evolve. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.update_user_group_with_http_info(id, body, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The user group id. (required) - :param UserGroupEntity body: The user group configuration details. (required) - :return: UserGroupEntity - If the method is called asynchronously, - returns the request thread. + + 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 ``update_user_group()`` method instead. + + Args: + body (:class:`~nipyapi.nifi.models.UserGroupEntity`): + The user group configuration details. (required) + id (str): + The user group id. (required) + + Returns: + tuple: (:class:`~nipyapi.nifi.models.UserGroupEntity`, status_code, headers) - Response data with HTTP details. """ - all_params = ['id', 'body'] - all_params.append('callback') + all_params = ['body', 'id'] all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -1171,14 +1118,15 @@ def update_user_group_with_http_info(self, id, body, **kwargs): ) params[key] = val del params['kwargs'] - # verify the required parameter 'id' is set - if ('id' not in params) or (params['id'] is None): - raise ValueError("Missing the required parameter `id` when calling `update_user_group`") # verify the required parameter 'body' is set if ('body' not in params) or (params['body'] is None): raise ValueError("Missing the required parameter `body` when calling `update_user_group`") + # verify the required parameter 'id' is set + if ('id' not in params) or (params['id'] is None): + raise ValueError("Missing the required parameter `id` when calling `update_user_group`") - + + collection_formats = {} path_params = {} @@ -1204,7 +1152,7 @@ def update_user_group_with_http_info(self, id, body, **kwargs): select_header_content_type(['application/json']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/tenants/user-groups/{id}', 'PUT', path_params, @@ -1215,7 +1163,6 @@ def update_user_group_with_http_info(self, id, body, **kwargs): files=local_var_files, response_type='UserGroupEntity', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), diff --git a/nipyapi/nifi/apis/versions_api.py b/nipyapi/nifi/apis/versions_api.py index fa8c5a77..56fedb11 100644 --- a/nipyapi/nifi/apis/versions_api.py +++ b/nipyapi/nifi/apis/versions_api.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - import sys import os import re @@ -35,22 +34,21 @@ def __init__(self, api_client=None): def create_version_control_request(self, body, **kwargs): """ - Create a version control request + Create a version control request. + Creates a request so that a Process Group can be placed under Version Control or have its Version Control configuration changed. Creating this request will prevent any other threads from simultaneously saving local changes to Version Control. It will not, however, actually save the local flow to the Flow Registry. A POST to /versions/process-groups/{id} should be used to initiate saving of the local flow to the Flow Registry. Note: This endpoint is subject to change as NiFi and it's REST API evolve. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.create_version_control_request(body, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param CreateActiveRequestEntity body: The versioned flow details. (required) - :return: str - If the method is called asynchronously, - returns the request thread. + + 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_version_control_request_with_http_info()`` method instead. + + Args: + body (:class:`~nipyapi.nifi.models.CreateActiveRequestEntity`): + The versioned flow details. (required) + + Returns: + str: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): @@ -61,26 +59,24 @@ def create_version_control_request(self, body, **kwargs): def create_version_control_request_with_http_info(self, body, **kwargs): """ - Create a version control request + Create a version control request. + Creates a request so that a Process Group can be placed under Version Control or have its Version Control configuration changed. Creating this request will prevent any other threads from simultaneously saving local changes to Version Control. It will not, however, actually save the local flow to the Flow Registry. A POST to /versions/process-groups/{id} should be used to initiate saving of the local flow to the Flow Registry. Note: This endpoint is subject to change as NiFi and it's REST API evolve. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.create_version_control_request_with_http_info(body, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param CreateActiveRequestEntity body: The versioned flow details. (required) - :return: str - If the method is called asynchronously, - returns the request thread. + + 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_version_control_request()`` method instead. + + Args: + body (:class:`~nipyapi.nifi.models.CreateActiveRequestEntity`): + The versioned flow details. (required) + + Returns: + tuple: (str, status_code, headers) - Response data with HTTP details. """ all_params = ['body'] - all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -98,7 +94,7 @@ def create_version_control_request_with_http_info(self, body, **kwargs): if ('body' not in params) or (params['body'] is None): raise ValueError("Missing the required parameter `body` when calling `create_version_control_request`") - + collection_formats = {} path_params = {} @@ -122,7 +118,7 @@ def create_version_control_request_with_http_info(self, body, **kwargs): select_header_content_type(['application/json']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/versions/active-requests', 'POST', path_params, @@ -133,7 +129,6 @@ def create_version_control_request_with_http_info(self, body, **kwargs): files=local_var_files, response_type='str', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), @@ -141,23 +136,23 @@ def create_version_control_request_with_http_info(self, body, **kwargs): def delete_revert_request(self, id, **kwargs): """ - Deletes the Revert Request with the given ID + Deletes the Revert Request with the given ID. + Deletes the Revert Request with the given ID. After a request is created via a POST to /versions/revert-requests/process-groups/{id}, it is expected that the client will properly clean up the request by DELETE'ing it, once the Revert process has completed. If the request is deleted before the request completes, then the Revert request will finish the step that it is currently performing and then will cancel any subsequent steps. Note: This endpoint is subject to change as NiFi and it's REST API evolve. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.delete_revert_request(id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The ID of the Revert Request (required) - :param bool disconnected_node_acknowledged: Acknowledges that this node is disconnected to allow for mutable requests to proceed. - :return: VersionedFlowUpdateRequestEntity - If the method is called asynchronously, - returns the request thread. + + 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_revert_request_with_http_info()`` method instead. + + Args: + id (str): + The ID of the Revert Request (required) + disconnected_node_acknowledged (bool): + Acknowledges that this node is disconnected to allow for mutable requests to proceed. + + Returns: + :class:`~nipyapi.nifi.models.VersionedFlowUpdateRequestEntity`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): @@ -168,27 +163,26 @@ def delete_revert_request(self, id, **kwargs): def delete_revert_request_with_http_info(self, id, **kwargs): """ - Deletes the Revert Request with the given ID + Deletes the Revert Request with the given ID. + Deletes the Revert Request with the given ID. After a request is created via a POST to /versions/revert-requests/process-groups/{id}, it is expected that the client will properly clean up the request by DELETE'ing it, once the Revert process has completed. If the request is deleted before the request completes, then the Revert request will finish the step that it is currently performing and then will cancel any subsequent steps. Note: This endpoint is subject to change as NiFi and it's REST API evolve. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.delete_revert_request_with_http_info(id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The ID of the Revert Request (required) - :param bool disconnected_node_acknowledged: Acknowledges that this node is disconnected to allow for mutable requests to proceed. - :return: VersionedFlowUpdateRequestEntity - If the method is called asynchronously, - returns the request thread. + + 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_revert_request()`` method instead. + + Args: + id (str): + The ID of the Revert Request (required) + disconnected_node_acknowledged (bool): + Acknowledges that this node is disconnected to allow for mutable requests to proceed. + + Returns: + tuple: (:class:`~nipyapi.nifi.models.VersionedFlowUpdateRequestEntity`, status_code, headers) - Response data with HTTP details. """ all_params = ['id', 'disconnected_node_acknowledged'] - all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -206,7 +200,8 @@ def delete_revert_request_with_http_info(self, id, **kwargs): if ('id' not in params) or (params['id'] is None): raise ValueError("Missing the required parameter `id` when calling `delete_revert_request`") - + + collection_formats = {} path_params = {} @@ -227,12 +222,8 @@ def delete_revert_request_with_http_info(self, id, **kwargs): header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['*/*']) - # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/versions/revert-requests/{id}', 'DELETE', path_params, @@ -243,62 +234,60 @@ def delete_revert_request_with_http_info(self, id, **kwargs): files=local_var_files, response_type='VersionedFlowUpdateRequestEntity', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def delete_update_request(self, id, **kwargs): + def delete_update_request1(self, id, **kwargs): """ - Deletes the Update Request with the given ID + Deletes the Update Request with the given ID. + Deletes the Update Request with the given ID. After a request is created via a POST to /versions/update-requests/process-groups/{id}, it is expected that the client will properly clean up the request by DELETE'ing it, once the Update process has completed. If the request is deleted before the request completes, then the Update request will finish the step that it is currently performing and then will cancel any subsequent steps. Note: This endpoint is subject to change as NiFi and it's REST API evolve. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.delete_update_request(id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The ID of the Update Request (required) - :param bool disconnected_node_acknowledged: Acknowledges that this node is disconnected to allow for mutable requests to proceed. - :return: VersionedFlowUpdateRequestEntity - If the method is called asynchronously, - returns the request thread. + + 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_update_request1_with_http_info()`` method instead. + + Args: + id (str): + The ID of the Update Request (required) + disconnected_node_acknowledged (bool): + Acknowledges that this node is disconnected to allow for mutable requests to proceed. + + Returns: + :class:`~nipyapi.nifi.models.VersionedFlowUpdateRequestEntity`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.delete_update_request_with_http_info(id, **kwargs) + return self.delete_update_request1_with_http_info(id, **kwargs) else: - (data) = self.delete_update_request_with_http_info(id, **kwargs) + (data) = self.delete_update_request1_with_http_info(id, **kwargs) return data - def delete_update_request_with_http_info(self, id, **kwargs): + def delete_update_request1_with_http_info(self, id, **kwargs): """ - Deletes the Update Request with the given ID + Deletes the Update Request with the given ID. + Deletes the Update Request with the given ID. After a request is created via a POST to /versions/update-requests/process-groups/{id}, it is expected that the client will properly clean up the request by DELETE'ing it, once the Update process has completed. If the request is deleted before the request completes, then the Update request will finish the step that it is currently performing and then will cancel any subsequent steps. Note: This endpoint is subject to change as NiFi and it's REST API evolve. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.delete_update_request_with_http_info(id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The ID of the Update Request (required) - :param bool disconnected_node_acknowledged: Acknowledges that this node is disconnected to allow for mutable requests to proceed. - :return: VersionedFlowUpdateRequestEntity - If the method is called asynchronously, - returns the request thread. + + 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_update_request1()`` method instead. + + Args: + id (str): + The ID of the Update Request (required) + disconnected_node_acknowledged (bool): + Acknowledges that this node is disconnected to allow for mutable requests to proceed. + + Returns: + tuple: (:class:`~nipyapi.nifi.models.VersionedFlowUpdateRequestEntity`, status_code, headers) - Response data with HTTP details. """ all_params = ['id', 'disconnected_node_acknowledged'] - all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -308,15 +297,16 @@ def delete_update_request_with_http_info(self, id, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method delete_update_request" % key + " to method delete_update_request1" % 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_update_request`") - + raise ValueError("Missing the required parameter `id` when calling `delete_update_request1`") + + collection_formats = {} path_params = {} @@ -337,12 +327,8 @@ def delete_update_request_with_http_info(self, id, **kwargs): header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['*/*']) - # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/versions/update-requests/{id}', 'DELETE', path_params, @@ -353,7 +339,6 @@ def delete_update_request_with_http_info(self, id, **kwargs): files=local_var_files, response_type='VersionedFlowUpdateRequestEntity', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), @@ -361,23 +346,23 @@ def delete_update_request_with_http_info(self, id, **kwargs): def delete_version_control_request(self, id, **kwargs): """ - Deletes the version control request with the given ID + Deletes the version control request with the given ID. + Deletes the Version Control Request with the given ID. This will allow other threads to save flows to the Flow Registry. See also the documentation for POSTing to /versions/active-requests for information regarding why this is done. Note: This endpoint is subject to change as NiFi and it's REST API evolve. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.delete_version_control_request(id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The request ID. (required) - :param bool disconnected_node_acknowledged: Acknowledges that this node is disconnected to allow for mutable requests to proceed. - :return: None - If the method is called asynchronously, - returns the request thread. + + 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_version_control_request_with_http_info()`` method instead. + + Args: + id (str): + The request ID. (required) + disconnected_node_acknowledged (bool): + Acknowledges that this node is disconnected to allow for mutable requests to proceed. + + Returns: + None """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): @@ -388,27 +373,26 @@ def delete_version_control_request(self, id, **kwargs): def delete_version_control_request_with_http_info(self, id, **kwargs): """ - Deletes the version control request with the given ID + Deletes the version control request with the given ID. + Deletes the Version Control Request with the given ID. This will allow other threads to save flows to the Flow Registry. See also the documentation for POSTing to /versions/active-requests for information regarding why this is done. Note: This endpoint is subject to change as NiFi and it's REST API evolve. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.delete_version_control_request_with_http_info(id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The request ID. (required) - :param bool disconnected_node_acknowledged: Acknowledges that this node is disconnected to allow for mutable requests to proceed. - :return: None - If the method is called asynchronously, - returns the request thread. + + 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_version_control_request()`` method instead. + + Args: + id (str): + The request ID. (required) + disconnected_node_acknowledged (bool): + Acknowledges that this node is disconnected to allow for mutable requests to proceed. + + Returns: + tuple: (None, status_code, headers) - Response data with HTTP details. """ all_params = ['id', 'disconnected_node_acknowledged'] - all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -426,7 +410,8 @@ def delete_version_control_request_with_http_info(self, id, **kwargs): if ('id' not in params) or (params['id'] is None): raise ValueError("Missing the required parameter `id` when calling `delete_version_control_request`") - + + collection_formats = {} path_params = {} @@ -443,16 +428,8 @@ def delete_version_control_request_with_http_info(self, id, **kwargs): local_var_files = {} body_params = None - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['*/*']) - # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/versions/active-requests/{id}', 'DELETE', path_params, @@ -463,7 +440,6 @@ def delete_version_control_request_with_http_info(self, id, **kwargs): files=local_var_files, response_type=None, auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), @@ -471,22 +447,18 @@ def delete_version_control_request_with_http_info(self, id, **kwargs): def export_flow_version(self, id, **kwargs): """ - Gets the latest version of a Process Group for download + Gets the latest version of a Process Group for download. + 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 + ``export_flow_version_with_http_info()`` method instead. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.export_flow_version(id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The process group id. (required) - :return: str - If the method is called asynchronously, - returns the request thread. + Args: + id (str): + The process group id. (required) + + Returns: + str: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): @@ -497,26 +469,21 @@ def export_flow_version(self, id, **kwargs): def export_flow_version_with_http_info(self, id, **kwargs): """ - Gets the latest version of a Process Group for download + Gets the latest version of a Process Group for download. + This method makes a synchronous HTTP request and returns detailed response information. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.export_flow_version_with_http_info(id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The process group id. (required) - :return: str - If the method is called asynchronously, - returns the request thread. + Returns the response data along with HTTP status code, headers, and other metadata. + For just the response data, use the corresponding ``export_flow_version()`` method instead. + + Args: + id (str): + The process group id. (required) + + Returns: + tuple: (str, status_code, headers) - Response data with HTTP details. """ all_params = ['id'] - all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -534,7 +501,7 @@ def export_flow_version_with_http_info(self, id, **kwargs): if ('id' not in params) or (params['id'] is None): raise ValueError("Missing the required parameter `id` when calling `export_flow_version`") - + collection_formats = {} path_params = {} @@ -553,12 +520,8 @@ def export_flow_version_with_http_info(self, id, **kwargs): header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['*/*']) - # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/versions/process-groups/{id}/download', 'GET', path_params, @@ -569,7 +532,6 @@ def export_flow_version_with_http_info(self, id, **kwargs): files=local_var_files, response_type='str', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), @@ -577,22 +539,21 @@ def export_flow_version_with_http_info(self, id, **kwargs): def get_revert_request(self, id, **kwargs): """ - Returns the Revert Request with the given ID + Returns the Revert Request with the given ID. + Returns the Revert Request with the given ID. Once a Revert Request has been created by performing a POST to /versions/revert-requests/process-groups/{id}, that request can subsequently be retrieved via this endpoint, and the request that is fetched will contain the updated state, such as percent complete, the current state of the request, and any failures. Note: This endpoint is subject to change as NiFi and it's REST API evolve. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_revert_request(id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The ID of the Revert Request (required) - :return: VersionedFlowUpdateRequestEntity - If the method is called asynchronously, - returns the request thread. + + 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_revert_request_with_http_info()`` method instead. + + Args: + id (str): + The ID of the Revert Request (required) + + Returns: + :class:`~nipyapi.nifi.models.VersionedFlowUpdateRequestEntity`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): @@ -603,26 +564,24 @@ def get_revert_request(self, id, **kwargs): def get_revert_request_with_http_info(self, id, **kwargs): """ - Returns the Revert Request with the given ID + Returns the Revert Request with the given ID. + Returns the Revert Request with the given ID. Once a Revert Request has been created by performing a POST to /versions/revert-requests/process-groups/{id}, that request can subsequently be retrieved via this endpoint, and the request that is fetched will contain the updated state, such as percent complete, the current state of the request, and any failures. Note: This endpoint is subject to change as NiFi and it's REST API evolve. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_revert_request_with_http_info(id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The ID of the Revert Request (required) - :return: VersionedFlowUpdateRequestEntity - If the method is called asynchronously, - returns the request thread. + + 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_revert_request()`` method instead. + + Args: + id (str): + The ID of the Revert Request (required) + + Returns: + tuple: (:class:`~nipyapi.nifi.models.VersionedFlowUpdateRequestEntity`, status_code, headers) - Response data with HTTP details. """ all_params = ['id'] - all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -640,7 +599,7 @@ def get_revert_request_with_http_info(self, id, **kwargs): if ('id' not in params) or (params['id'] is None): raise ValueError("Missing the required parameter `id` when calling `get_revert_request`") - + collection_formats = {} path_params = {} @@ -659,12 +618,8 @@ def get_revert_request_with_http_info(self, id, **kwargs): header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['*/*']) - # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/versions/revert-requests/{id}', 'GET', path_params, @@ -675,7 +630,6 @@ def get_revert_request_with_http_info(self, id, **kwargs): files=local_var_files, response_type='VersionedFlowUpdateRequestEntity', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), @@ -683,22 +637,21 @@ def get_revert_request_with_http_info(self, id, **kwargs): def get_update_request(self, id, **kwargs): """ - Returns the Update Request with the given ID + Returns the Update Request with the given ID. + Returns the Update Request with the given ID. Once an Update Request has been created by performing a POST to /versions/update-requests/process-groups/{id}, that request can subsequently be retrieved via this endpoint, and the request that is fetched will contain the updated state, such as percent complete, the current state of the request, and any failures. Note: This endpoint is subject to change as NiFi and it's REST API evolve. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_update_request(id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The ID of the Update Request (required) - :return: VersionedFlowUpdateRequestEntity - If the method is called asynchronously, - returns the request thread. + + 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_update_request_with_http_info()`` method instead. + + Args: + id (str): + The ID of the Update Request (required) + + Returns: + :class:`~nipyapi.nifi.models.VersionedFlowUpdateRequestEntity`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): @@ -709,26 +662,24 @@ def get_update_request(self, id, **kwargs): def get_update_request_with_http_info(self, id, **kwargs): """ - Returns the Update Request with the given ID + Returns the Update Request with the given ID. + Returns the Update Request with the given ID. Once an Update Request has been created by performing a POST to /versions/update-requests/process-groups/{id}, that request can subsequently be retrieved via this endpoint, and the request that is fetched will contain the updated state, such as percent complete, the current state of the request, and any failures. Note: This endpoint is subject to change as NiFi and it's REST API evolve. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_update_request_with_http_info(id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The ID of the Update Request (required) - :return: VersionedFlowUpdateRequestEntity - If the method is called asynchronously, - returns the request thread. + + 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_update_request()`` method instead. + + Args: + id (str): + The ID of the Update Request (required) + + Returns: + tuple: (:class:`~nipyapi.nifi.models.VersionedFlowUpdateRequestEntity`, status_code, headers) - Response data with HTTP details. """ all_params = ['id'] - all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -746,7 +697,7 @@ def get_update_request_with_http_info(self, id, **kwargs): if ('id' not in params) or (params['id'] is None): raise ValueError("Missing the required parameter `id` when calling `get_update_request`") - + collection_formats = {} path_params = {} @@ -765,12 +716,8 @@ def get_update_request_with_http_info(self, id, **kwargs): header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['*/*']) - # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/versions/update-requests/{id}', 'GET', path_params, @@ -781,7 +728,6 @@ def get_update_request_with_http_info(self, id, **kwargs): files=local_var_files, response_type='VersionedFlowUpdateRequestEntity', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), @@ -789,22 +735,21 @@ def get_update_request_with_http_info(self, id, **kwargs): def get_version_information(self, id, **kwargs): """ - Gets the Version Control information for a process group + Gets the Version Control information for a process group. + Note: This endpoint is subject to change as NiFi and it's REST API evolve. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_version_information(id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The process group id. (required) - :return: VersionControlInformationEntity - If the method is called asynchronously, - returns the request thread. + + 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_version_information_with_http_info()`` method instead. + + Args: + 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'): @@ -815,26 +760,24 @@ def get_version_information(self, id, **kwargs): def get_version_information_with_http_info(self, id, **kwargs): """ - Gets the Version Control information for a process group + Gets the Version Control information for a process group. + Note: This endpoint is subject to change as NiFi and it's REST API evolve. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_version_information_with_http_info(id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The process group id. (required) - :return: VersionControlInformationEntity - If the method is called asynchronously, - returns the request thread. + + 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_version_information()`` method instead. + + Args: + id (str): + The process group id. (required) + + Returns: + tuple: (:class:`~nipyapi.nifi.models.VersionControlInformationEntity`, status_code, headers) - Response data with HTTP details. """ all_params = ['id'] - all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -852,7 +795,7 @@ def get_version_information_with_http_info(self, id, **kwargs): if ('id' not in params) or (params['id'] is None): raise ValueError("Missing the required parameter `id` when calling `get_version_information`") - + collection_formats = {} path_params = {} @@ -871,12 +814,8 @@ def get_version_information_with_http_info(self, id, **kwargs): header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['*/*']) - # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/versions/process-groups/{id}', 'GET', path_params, @@ -887,62 +826,60 @@ def get_version_information_with_http_info(self, id, **kwargs): files=local_var_files, response_type='VersionControlInformationEntity', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def initiate_revert_flow_version(self, id, body, **kwargs): + def initiate_revert_flow_version(self, body, id, **kwargs): """ - Initiate the Revert Request of a Process Group with the given ID + Initiate the Revert Request of a Process Group with the given ID. + For a Process Group that is already under Version Control, this will initiate the action of reverting any local changes that have been made to the Process Group since it was last synchronized with the Flow Registry. This will result in the flow matching the Versioned Flow that exists in the Flow Registry. This can be a lengthy process, as it will stop any Processors and disable any Controller Services necessary to perform the action and then restart them. As a result, the endpoint will immediately return a VersionedFlowUpdateRequestEntity, and the process of updating the flow will occur asynchronously in the background. The client may then periodically poll the status of the request by issuing a GET request to /versions/revert-requests/{requestId}. Once the request is completed, the client is expected to issue a DELETE request to /versions/revert-requests/{requestId}. Note: This endpoint is subject to change as NiFi and it's REST API evolve. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.initiate_revert_flow_version(id, body, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The process group id. (required) - :param VersionControlInformationEntity body: The Version Control Information to revert to. (required) - :return: VersionedFlowUpdateRequestEntity - If the method is called asynchronously, - returns the request thread. + + 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_revert_flow_version_with_http_info()`` method instead. + + Args: + body (:class:`~nipyapi.nifi.models.VersionControlInformationEntity`): + The Version Control Information to revert to. (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_revert_flow_version_with_http_info(id, body, **kwargs) + return self.initiate_revert_flow_version_with_http_info(body, id, **kwargs) else: - (data) = self.initiate_revert_flow_version_with_http_info(id, body, **kwargs) + (data) = self.initiate_revert_flow_version_with_http_info(body, id, **kwargs) return data - def initiate_revert_flow_version_with_http_info(self, id, body, **kwargs): + def initiate_revert_flow_version_with_http_info(self, body, id, **kwargs): """ - Initiate the Revert Request of a Process Group with the given ID + Initiate the Revert Request of a Process Group with the given ID. + For a Process Group that is already under Version Control, this will initiate the action of reverting any local changes that have been made to the Process Group since it was last synchronized with the Flow Registry. This will result in the flow matching the Versioned Flow that exists in the Flow Registry. This can be a lengthy process, as it will stop any Processors and disable any Controller Services necessary to perform the action and then restart them. As a result, the endpoint will immediately return a VersionedFlowUpdateRequestEntity, and the process of updating the flow will occur asynchronously in the background. The client may then periodically poll the status of the request by issuing a GET request to /versions/revert-requests/{requestId}. Once the request is completed, the client is expected to issue a DELETE request to /versions/revert-requests/{requestId}. Note: This endpoint is subject to change as NiFi and it's REST API evolve. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.initiate_revert_flow_version_with_http_info(id, body, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The process group id. (required) - :param VersionControlInformationEntity body: The Version Control Information to revert to. (required) - :return: VersionedFlowUpdateRequestEntity - If the method is called asynchronously, - returns the request thread. + + 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_revert_flow_version()`` method instead. + + Args: + body (:class:`~nipyapi.nifi.models.VersionControlInformationEntity`): + The Version Control Information to revert to. (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 = ['id', 'body'] - all_params.append('callback') + all_params = ['body', 'id'] all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -956,14 +893,15 @@ def initiate_revert_flow_version_with_http_info(self, id, body, **kwargs): ) params[key] = val del params['kwargs'] - # verify the required parameter 'id' is set - if ('id' not in params) or (params['id'] is None): - raise ValueError("Missing the required parameter `id` when calling `initiate_revert_flow_version`") # 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_revert_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 `initiate_revert_flow_version`") - + + collection_formats = {} path_params = {} @@ -989,7 +927,7 @@ def initiate_revert_flow_version_with_http_info(self, id, body, **kwargs): select_header_content_type(['application/json']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/versions/revert-requests/process-groups/{id}', 'POST', path_params, @@ -1000,62 +938,60 @@ def initiate_revert_flow_version_with_http_info(self, id, body, **kwargs): files=local_var_files, response_type='VersionedFlowUpdateRequestEntity', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def initiate_version_control_update(self, id, body, **kwargs): + def initiate_version_control_update(self, body, id, **kwargs): """ - Initiate the Update Request of a Process Group with the given ID + Initiate the Update Request of a Process Group with the given ID. + For a Process Group that is already under Version Control, this will initiate the action of changing from a specific version of the flow in the Flow Registry to a different version of the flow. This can be a lengthy process, as it will stop any Processors and disable any Controller Services necessary to perform the action and then restart them. As a result, the endpoint will immediately return a VersionedFlowUpdateRequestEntity, and the process of updating the flow will occur asynchronously in the background. The client may then periodically poll the status of the request by issuing a GET request to /versions/update-requests/{requestId}. Once the request is completed, the client is expected to issue a DELETE request to /versions/update-requests/{requestId}. Note: This endpoint is subject to change as NiFi and it's REST API evolve. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.initiate_version_control_update(id, body, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The process group id. (required) - :param VersionControlInformationEntity body: The controller service configuration details. (required) - :return: VersionedFlowUpdateRequestEntity - If the method is called asynchronously, - returns the request thread. + + 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_version_control_update_with_http_info()`` method instead. + + Args: + body (:class:`~nipyapi.nifi.models.VersionControlInformationEntity`): + The controller service configuration 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_version_control_update_with_http_info(id, body, **kwargs) + return self.initiate_version_control_update_with_http_info(body, id, **kwargs) else: - (data) = self.initiate_version_control_update_with_http_info(id, body, **kwargs) + (data) = self.initiate_version_control_update_with_http_info(body, id, **kwargs) return data - def initiate_version_control_update_with_http_info(self, id, body, **kwargs): + def initiate_version_control_update_with_http_info(self, body, id, **kwargs): """ - Initiate the Update Request of a Process Group with the given ID + Initiate the Update Request of a Process Group with the given ID. + For a Process Group that is already under Version Control, this will initiate the action of changing from a specific version of the flow in the Flow Registry to a different version of the flow. This can be a lengthy process, as it will stop any Processors and disable any Controller Services necessary to perform the action and then restart them. As a result, the endpoint will immediately return a VersionedFlowUpdateRequestEntity, and the process of updating the flow will occur asynchronously in the background. The client may then periodically poll the status of the request by issuing a GET request to /versions/update-requests/{requestId}. Once the request is completed, the client is expected to issue a DELETE request to /versions/update-requests/{requestId}. Note: This endpoint is subject to change as NiFi and it's REST API evolve. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.initiate_version_control_update_with_http_info(id, body, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The process group id. (required) - :param VersionControlInformationEntity body: The controller service configuration details. (required) - :return: VersionedFlowUpdateRequestEntity - If the method is called asynchronously, - returns the request thread. + + 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_version_control_update()`` method instead. + + Args: + body (:class:`~nipyapi.nifi.models.VersionControlInformationEntity`): + The controller service configuration 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 = ['id', 'body'] - all_params.append('callback') + all_params = ['body', 'id'] all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -1069,14 +1005,15 @@ def initiate_version_control_update_with_http_info(self, id, body, **kwargs): ) params[key] = val del params['kwargs'] - # verify the required parameter 'id' is set - if ('id' not in params) or (params['id'] is None): - raise ValueError("Missing the required parameter `id` when calling `initiate_version_control_update`") # verify the required parameter 'body' is set if ('body' not in params) or (params['body'] is None): raise ValueError("Missing the required parameter `body` when calling `initiate_version_control_update`") + # 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_version_control_update`") - + + collection_formats = {} path_params = {} @@ -1102,7 +1039,7 @@ def initiate_version_control_update_with_http_info(self, id, body, **kwargs): select_header_content_type(['application/json']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/versions/update-requests/process-groups/{id}', 'POST', path_params, @@ -1113,62 +1050,60 @@ def initiate_version_control_update_with_http_info(self, id, body, **kwargs): files=local_var_files, response_type='VersionedFlowUpdateRequestEntity', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def save_to_flow_registry(self, id, body, **kwargs): + def save_to_flow_registry(self, body, id, **kwargs): """ - Save the Process Group with the given ID + Save the Process Group with the given ID. + Begins version controlling the Process Group with the given ID or commits changes to the Versioned Flow, depending on if the provided VersionControlInformation includes a flowId. Note: This endpoint is subject to change as NiFi and it's REST API evolve. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.save_to_flow_registry(id, body, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The process group id. (required) - :param StartVersionControlRequestEntity body: The versioned flow details. (required) - :return: VersionControlInformationEntity - If the method is called asynchronously, - returns the request thread. + + 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 + ``save_to_flow_registry_with_http_info()`` method instead. + + Args: + body (:class:`~nipyapi.nifi.models.StartVersionControlRequestEntity`): + The versioned flow details. (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.save_to_flow_registry_with_http_info(id, body, **kwargs) + return self.save_to_flow_registry_with_http_info(body, id, **kwargs) else: - (data) = self.save_to_flow_registry_with_http_info(id, body, **kwargs) + (data) = self.save_to_flow_registry_with_http_info(body, id, **kwargs) return data - def save_to_flow_registry_with_http_info(self, id, body, **kwargs): + def save_to_flow_registry_with_http_info(self, body, id, **kwargs): """ - Save the Process Group with the given ID + Save the Process Group with the given ID. + Begins version controlling the Process Group with the given ID or commits changes to the Versioned Flow, depending on if the provided VersionControlInformation includes a flowId. Note: This endpoint is subject to change as NiFi and it's REST API evolve. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.save_to_flow_registry_with_http_info(id, body, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The process group id. (required) - :param StartVersionControlRequestEntity body: The versioned flow details. (required) - :return: VersionControlInformationEntity - If the method is called asynchronously, - returns the request thread. + + 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 ``save_to_flow_registry()`` method instead. + + Args: + body (:class:`~nipyapi.nifi.models.StartVersionControlRequestEntity`): + The versioned flow details. (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 = ['id', 'body'] - all_params.append('callback') + all_params = ['body', 'id'] all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -1182,14 +1117,15 @@ def save_to_flow_registry_with_http_info(self, id, body, **kwargs): ) 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 `save_to_flow_registry`") # 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 `save_to_flow_registry`") + # 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 `save_to_flow_registry`") - + + collection_formats = {} path_params = {} @@ -1215,7 +1151,7 @@ def save_to_flow_registry_with_http_info(self, id, body, **kwargs): select_header_content_type(['application/json']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/versions/process-groups/{id}', 'POST', path_params, @@ -1226,7 +1162,6 @@ def save_to_flow_registry_with_http_info(self, id, body, **kwargs): files=local_var_files, response_type='VersionControlInformationEntity', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), @@ -1234,25 +1169,27 @@ def save_to_flow_registry_with_http_info(self, id, body, **kwargs): def stop_version_control(self, id, **kwargs): """ - Stops version controlling the Process Group with the given ID + Stops version controlling the Process Group with the given ID. + Stops version controlling the Process Group with the given ID. The Process Group will no longer track to any Versioned Flow. Note: This endpoint is subject to change as NiFi and it's REST API evolve. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.stop_version_control(id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The process group id. (required) - :param str version: The version is used to verify the client is working with the latest version of the flow. - :param str client_id: If the client id is not specified, a new one will be generated. This value (whether specified or generated) is included in the response. - :param bool disconnected_node_acknowledged: Acknowledges that this node is disconnected to allow for mutable requests to proceed. - :return: VersionControlInformationEntity - If the method is called asynchronously, - returns the request thread. + + 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 + ``stop_version_control_with_http_info()`` method instead. + + Args: + id (str): + The process group id. (required) + version (:class:`~nipyapi.nifi.models.LongParameter`): + The version 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, a new one will be generated. This value (whether specified or generated) is included in the response. + disconnected_node_acknowledged (bool): + Acknowledges that this node is disconnected to allow for mutable requests to proceed. + + Returns: + :class:`~nipyapi.nifi.models.VersionControlInformationEntity`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): @@ -1263,29 +1200,30 @@ def stop_version_control(self, id, **kwargs): def stop_version_control_with_http_info(self, id, **kwargs): """ - Stops version controlling the Process Group with the given ID + Stops version controlling the Process Group with the given ID. + Stops version controlling the Process Group with the given ID. The Process Group will no longer track to any Versioned Flow. Note: This endpoint is subject to change as NiFi and it's REST API evolve. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.stop_version_control_with_http_info(id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The process group id. (required) - :param str version: The version is used to verify the client is working with the latest version of the flow. - :param str client_id: If the client id is not specified, a new one will be generated. This value (whether specified or generated) is included in the response. - :param bool disconnected_node_acknowledged: Acknowledges that this node is disconnected to allow for mutable requests to proceed. - :return: VersionControlInformationEntity - If the method is called asynchronously, - returns the request thread. + + 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 ``stop_version_control()`` method instead. + + Args: + id (str): + The process group id. (required) + version (:class:`~nipyapi.nifi.models.LongParameter`): + The version 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, a new one will be generated. This value (whether specified or generated) is included in the response. + disconnected_node_acknowledged (bool): + Acknowledges that this node is disconnected to allow for mutable requests to proceed. + + Returns: + tuple: (:class:`~nipyapi.nifi.models.VersionControlInformationEntity`, status_code, headers) - Response data with HTTP details. """ all_params = ['id', 'version', 'client_id', 'disconnected_node_acknowledged'] - all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -1303,7 +1241,10 @@ def stop_version_control_with_http_info(self, id, **kwargs): if ('id' not in params) or (params['id'] is None): raise ValueError("Missing the required parameter `id` when calling `stop_version_control`") - + + + + collection_formats = {} path_params = {} @@ -1328,12 +1269,8 @@ def stop_version_control_with_http_info(self, id, **kwargs): header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['*/*']) - # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/versions/process-groups/{id}', 'DELETE', path_params, @@ -1344,62 +1281,60 @@ def stop_version_control_with_http_info(self, id, **kwargs): files=local_var_files, response_type='VersionControlInformationEntity', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def update_flow_version(self, id, body, **kwargs): + def update_flow_version(self, body, id, **kwargs): """ - Update the version of a Process Group with the given ID + Update the version of a Process Group with the given ID. + For a Process Group that is already under Version Control, this will update the version of the flow to a different version. This endpoint expects that the given snapshot will not modify any Processor that is currently running or any Controller Service that is enabled. Note: This endpoint is subject to change as NiFi and it's REST API evolve. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.update_flow_version(id, body, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The process group id. (required) - :param VersionedFlowSnapshotEntity body: The controller service configuration details. (required) - :return: VersionControlInformationEntity - If the method is called asynchronously, - returns the request thread. + + 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 + ``update_flow_version_with_http_info()`` method instead. + + Args: + body (:class:`~nipyapi.nifi.models.VersionedFlowSnapshotEntity`): + The controller service configuration details. (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.update_flow_version_with_http_info(id, body, **kwargs) + return self.update_flow_version_with_http_info(body, id, **kwargs) else: - (data) = self.update_flow_version_with_http_info(id, body, **kwargs) + (data) = self.update_flow_version_with_http_info(body, id, **kwargs) return data - def update_flow_version_with_http_info(self, id, body, **kwargs): + def update_flow_version_with_http_info(self, body, id, **kwargs): """ - Update the version of a Process Group with the given ID + Update the version of a Process Group with the given ID. + For a Process Group that is already under Version Control, this will update the version of the flow to a different version. This endpoint expects that the given snapshot will not modify any Processor that is currently running or any Controller Service that is enabled. Note: This endpoint is subject to change as NiFi and it's REST API evolve. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.update_flow_version_with_http_info(id, body, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The process group id. (required) - :param VersionedFlowSnapshotEntity body: The controller service configuration details. (required) - :return: VersionControlInformationEntity - If the method is called asynchronously, - returns the request thread. + + 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 ``update_flow_version()`` method instead. + + Args: + body (:class:`~nipyapi.nifi.models.VersionedFlowSnapshotEntity`): + The controller service configuration details. (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 = ['id', 'body'] - all_params.append('callback') + all_params = ['body', 'id'] all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -1413,14 +1348,15 @@ def update_flow_version_with_http_info(self, id, body, **kwargs): ) params[key] = val del params['kwargs'] - # verify the required parameter 'id' is set - if ('id' not in params) or (params['id'] is None): - raise ValueError("Missing the required parameter `id` when calling `update_flow_version`") # verify the required parameter 'body' is set if ('body' not in params) or (params['body'] is None): raise ValueError("Missing the required parameter `body` when calling `update_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 `update_flow_version`") - + + collection_formats = {} path_params = {} @@ -1446,7 +1382,7 @@ def update_flow_version_with_http_info(self, id, body, **kwargs): select_header_content_type(['application/json']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/versions/process-groups/{id}', 'PUT', path_params, @@ -1457,62 +1393,60 @@ def update_flow_version_with_http_info(self, id, body, **kwargs): files=local_var_files, response_type='VersionControlInformationEntity', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def update_version_control_request(self, id, body, **kwargs): + def update_version_control_request(self, body, id, **kwargs): """ - Updates the request with the given ID + Updates the request with the given ID. + Note: This endpoint is subject to change as NiFi and it's REST API evolve. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.update_version_control_request(id, body, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The request ID. (required) - :param VersionControlComponentMappingEntity body: The version control component mapping. (required) - :return: VersionControlInformationEntity - If the method is called asynchronously, - returns the request thread. + + 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 + ``update_version_control_request_with_http_info()`` method instead. + + Args: + body (:class:`~nipyapi.nifi.models.VersionControlComponentMappingEntity`): + The version control component mapping. (required) + id (str): + The request ID. (required) + + Returns: + :class:`~nipyapi.nifi.models.VersionControlInformationEntity`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.update_version_control_request_with_http_info(id, body, **kwargs) + return self.update_version_control_request_with_http_info(body, id, **kwargs) else: - (data) = self.update_version_control_request_with_http_info(id, body, **kwargs) + (data) = self.update_version_control_request_with_http_info(body, id, **kwargs) return data - def update_version_control_request_with_http_info(self, id, body, **kwargs): + def update_version_control_request_with_http_info(self, body, id, **kwargs): """ - Updates the request with the given ID + Updates the request with the given ID. + Note: This endpoint is subject to change as NiFi and it's REST API evolve. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.update_version_control_request_with_http_info(id, body, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The request ID. (required) - :param VersionControlComponentMappingEntity body: The version control component mapping. (required) - :return: VersionControlInformationEntity - If the method is called asynchronously, - returns the request thread. + + 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 ``update_version_control_request()`` method instead. + + Args: + body (:class:`~nipyapi.nifi.models.VersionControlComponentMappingEntity`): + The version control component mapping. (required) + id (str): + The request ID. (required) + + Returns: + tuple: (:class:`~nipyapi.nifi.models.VersionControlInformationEntity`, status_code, headers) - Response data with HTTP details. """ - all_params = ['id', 'body'] - all_params.append('callback') + all_params = ['body', 'id'] all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -1526,14 +1460,15 @@ def update_version_control_request_with_http_info(self, id, body, **kwargs): ) params[key] = val del params['kwargs'] - # verify the required parameter 'id' is set - if ('id' not in params) or (params['id'] is None): - raise ValueError("Missing the required parameter `id` when calling `update_version_control_request`") # verify the required parameter 'body' is set if ('body' not in params) or (params['body'] is None): raise ValueError("Missing the required parameter `body` when calling `update_version_control_request`") + # verify the required parameter 'id' is set + if ('id' not in params) or (params['id'] is None): + raise ValueError("Missing the required parameter `id` when calling `update_version_control_request`") - + + collection_formats = {} path_params = {} @@ -1559,7 +1494,7 @@ def update_version_control_request_with_http_info(self, id, body, **kwargs): select_header_content_type(['application/json']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/versions/active-requests/{id}', 'PUT', path_params, @@ -1570,7 +1505,6 @@ def update_version_control_request_with_http_info(self, id, body, **kwargs): files=local_var_files, response_type='VersionControlInformationEntity', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), diff --git a/nipyapi/nifi/configuration.py b/nipyapi/nifi/configuration.py index 6a1967fc..c3506821 100644 --- a/nipyapi/nifi/configuration.py +++ b/nipyapi/nifi/configuration.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - import urllib3 import sys @@ -40,7 +39,7 @@ def __init__(self): Constructor """ # Default Base url - self.host = "http://localhost/nifi-api" + self.host = "/" # Default api client self.api_client = None # Temp file folder for downloading files @@ -56,7 +55,6 @@ def __init__(self): self.username = "" # Password for HTTP basic authentication self.password = "" - # Logging Settings self.logger = {} self.logger["package_logger"] = logging.getLogger("nifi") @@ -83,6 +81,8 @@ def __init__(self): self.key_file = None # client key password self.key_password = None + # Set this to false to skip hostname verification when calling API from https server. + self.disable_host_check = None # Alternative TLS configuration: set this to an instance of ssl.SSLContext or urllib3.util.ssl_.SSLContext self.ssl_context = None @@ -207,21 +207,13 @@ def auth_settings(self): :return: The Auth Settings information dict. """ return { - 'tokenAuth': + 'bearerAuth': { 'type': 'api_key', 'in': 'header', 'key': 'Authorization', - 'value': self.get_api_key_with_prefix('tokenAuth') + 'value': self.get_api_key_with_prefix('bearerAuth') }, - 'basicAuth': - { - 'type': 'basic', - 'in': 'header', - 'key': 'Authorization', - 'value': self.get_basic_auth_token() - }, - } def to_debug_report(self): @@ -233,6 +225,6 @@ def to_debug_report(self): return "Python SDK Debug Report:\n"\ "OS: {env}\n"\ "Python Version: {pyversion}\n"\ - "Version of the API: 1.28.1\n"\ + "Version of the API: 2.5.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 67c26e63..31d8964b 100644 --- a/nipyapi/nifi/models/__init__.py +++ b/nipyapi/nifi/models/__init__.py @@ -1,37 +1,38 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - # import models into model package from .about_dto import AboutDTO from .about_entity import AboutEntity -from .access_configuration_dto import AccessConfigurationDTO -from .access_configuration_entity import AccessConfigurationEntity from .access_policy_dto import AccessPolicyDTO from .access_policy_entity import AccessPolicyEntity from .access_policy_summary_dto import AccessPolicySummaryDTO from .access_policy_summary_entity import AccessPolicySummaryEntity -from .access_status_dto import AccessStatusDTO -from .access_status_entity import AccessStatusEntity -from .access_token_expiration_dto import AccessTokenExpirationDTO -from .access_token_expiration_entity import AccessTokenExpirationEntity +from .access_token_body import AccessTokenBody from .action_dto import ActionDTO from .action_details_dto import ActionDetailsDTO from .action_entity import ActionEntity from .activate_controller_services_entity import ActivateControllerServicesEntity +from .additional_details_entity import AdditionalDetailsEntity from .affected_component_dto import AffectedComponentDTO from .affected_component_entity import AffectedComponentEntity from .allowable_value_dto import AllowableValueDTO from .allowable_value_entity import AllowableValueEntity +from .asset_dto import AssetDTO +from .asset_entity import AssetEntity +from .asset_reference_dto import AssetReferenceDTO +from .assets_entity import AssetsEntity from .attribute import Attribute from .attribute_dto import AttributeDTO +from .authentication_configuration_dto import AuthenticationConfigurationDTO +from .authentication_configuration_entity import AuthenticationConfigurationEntity from .banner_dto import BannerDTO from .banner_entity import BannerEntity from .batch_settings_dto import BatchSettingsDTO @@ -39,21 +40,21 @@ from .build_info import BuildInfo from .bulletin_board_dto import BulletinBoardDTO from .bulletin_board_entity import BulletinBoardEntity +from .bulletin_board_pattern_parameter import BulletinBoardPatternParameter from .bulletin_dto import BulletinDTO from .bulletin_entity import BulletinEntity from .bundle import Bundle from .bundle_dto import BundleDTO -from .class_loader_diagnostics_dto import ClassLoaderDiagnosticsDTO -from .cluste_summary_entity import ClusteSummaryEntity +from .client_id_parameter import ClientIdParameter from .cluster_dto import ClusterDTO from .cluster_entity import ClusterEntity from .cluster_search_results_entity import ClusterSearchResultsEntity from .cluster_summary_dto import ClusterSummaryDTO +from .cluster_summary_entity import ClusterSummaryEntity from .component_details_dto import ComponentDetailsDTO from .component_difference_dto import ComponentDifferenceDTO from .component_history_dto import ComponentHistoryDTO from .component_history_entity import ComponentHistoryEntity -from .component_lifecycle import ComponentLifecycle from .component_manifest import ComponentManifest from .component_reference_dto import ComponentReferenceDTO from .component_reference_entity import ComponentReferenceEntity @@ -70,8 +71,6 @@ from .connectable_component import ConnectableComponent from .connectable_dto import ConnectableDTO from .connection_dto import ConnectionDTO -from .connection_diagnostics_dto import ConnectionDiagnosticsDTO -from .connection_diagnostics_snapshot_dto import ConnectionDiagnosticsSnapshotDTO from .connection_entity import ConnectionEntity from .connection_statistics_dto import ConnectionStatisticsDTO from .connection_statistics_entity import ConnectionStatisticsEntity @@ -82,6 +81,8 @@ from .connection_status_snapshot_dto import ConnectionStatusSnapshotDTO from .connection_status_snapshot_entity import ConnectionStatusSnapshotEntity from .connections_entity import ConnectionsEntity +from .content_viewer_dto import ContentViewerDTO +from .content_viewer_entity import ContentViewerEntity from .controller_bulletins_entity import ControllerBulletinsEntity from .controller_configuration_dto import ControllerConfigurationDTO from .controller_configuration_entity import ControllerConfigurationEntity @@ -91,7 +92,6 @@ from .controller_service_api_dto import ControllerServiceApiDTO from .controller_service_dto import ControllerServiceDTO from .controller_service_definition import ControllerServiceDefinition -from .controller_service_diagnostics_dto import ControllerServiceDiagnosticsDTO from .controller_service_entity import ControllerServiceEntity from .controller_service_referencing_component_dto import ControllerServiceReferencingComponentDTO from .controller_service_referencing_component_entity import ControllerServiceReferencingComponentEntity @@ -102,6 +102,8 @@ from .controller_services_entity import ControllerServicesEntity from .controller_status_dto import ControllerStatusDTO from .controller_status_entity import ControllerStatusEntity +from .copy_request_entity import CopyRequestEntity +from .copy_response_entity import CopyResponseEntity from .copy_snippet_request_entity import CopySnippetRequestEntity from .counter_dto import CounterDTO from .counter_entity import CounterEntity @@ -109,20 +111,27 @@ from .counters_entity import CountersEntity from .counters_snapshot_dto import CountersSnapshotDTO from .create_active_request_entity import CreateActiveRequestEntity -from .create_template_request_entity import CreateTemplateRequestEntity from .current_user_entity import CurrentUserEntity +from .date_time_parameter import DateTimeParameter from .defined_type import DefinedType from .difference_dto import DifferenceDTO from .dimensions_dto import DimensionsDTO from .documented_type_dto import DocumentedTypeDTO from .drop_request_dto import DropRequestDTO from .drop_request_entity import DropRequestEntity -from .dto_factory import DtoFactory from .dynamic_property import DynamicProperty from .dynamic_relationship import DynamicRelationship -from .entity import Entity from .explicit_restriction_dto import ExplicitRestrictionDTO from .external_controller_service_reference import ExternalControllerServiceReference +from .flow_analysis_result_entity import FlowAnalysisResultEntity +from .flow_analysis_rule_dto import FlowAnalysisRuleDTO +from .flow_analysis_rule_definition import FlowAnalysisRuleDefinition +from .flow_analysis_rule_entity import FlowAnalysisRuleEntity +from .flow_analysis_rule_run_status_entity import FlowAnalysisRuleRunStatusEntity +from .flow_analysis_rule_status_dto import FlowAnalysisRuleStatusDTO +from .flow_analysis_rule_types_entity import FlowAnalysisRuleTypesEntity +from .flow_analysis_rule_violation_dto import FlowAnalysisRuleViolationDTO +from .flow_analysis_rules_entity import FlowAnalysisRulesEntity from .flow_breadcrumb_dto import FlowBreadcrumbDTO from .flow_breadcrumb_entity import FlowBreadcrumbEntity from .flow_comparison_entity import FlowComparisonEntity @@ -133,6 +142,9 @@ from .flow_file_dto import FlowFileDTO from .flow_file_entity import FlowFileEntity from .flow_file_summary_dto import FlowFileSummaryDTO +from .flow_registry_branch_dto import FlowRegistryBranchDTO +from .flow_registry_branch_entity import FlowRegistryBranchEntity +from .flow_registry_branches_entity import FlowRegistryBranchesEntity from .flow_registry_bucket import FlowRegistryBucket from .flow_registry_bucket_dto import FlowRegistryBucketDTO from .flow_registry_bucket_entity import FlowRegistryBucketEntity @@ -146,45 +158,42 @@ from .funnel_dto import FunnelDTO from .funnel_entity import FunnelEntity from .funnels_entity import FunnelsEntity -from .gc_diagnostics_snapshot_dto import GCDiagnosticsSnapshotDTO from .garbage_collection_dto import GarbageCollectionDTO -from .garbage_collection_diagnostics_dto import GarbageCollectionDiagnosticsDTO from .history_dto import HistoryDTO from .history_entity import HistoryEntity from .input_ports_entity import InputPortsEntity -from .input_stream import InputStream -from .instantiate_template_request_entity import InstantiateTemplateRequestEntity -from .jvm_controller_diagnostics_snapshot_dto import JVMControllerDiagnosticsSnapshotDTO -from .jvm_diagnostics_dto import JVMDiagnosticsDTO -from .jvm_diagnostics_snapshot_dto import JVMDiagnosticsSnapshotDTO -from .jvm_flow_diagnostics_snapshot_dto import JVMFlowDiagnosticsSnapshotDTO -from .jvm_system_diagnostics_snapshot_dto import JVMSystemDiagnosticsSnapshotDTO +from .integer_parameter import IntegerParameter from .jmx_metrics_result_dto import JmxMetricsResultDTO from .jmx_metrics_results_entity import JmxMetricsResultsEntity from .label_dto import LabelDTO from .label_entity import LabelEntity from .labels_entity import LabelsEntity +from .latest_provenance_events_dto import LatestProvenanceEventsDTO +from .latest_provenance_events_entity import LatestProvenanceEventsEntity from .lineage_dto import LineageDTO from .lineage_entity import LineageEntity from .lineage_request_dto import LineageRequestDTO from .lineage_results_dto import LineageResultsDTO from .listing_request_dto import ListingRequestDTO from .listing_request_entity import ListingRequestEntity -from .local_queue_partition_dto import LocalQueuePartitionDTO +from .long_parameter import LongParameter +from .multi_processor_use_case import MultiProcessorUseCase +from .nar_coordinate_dto import NarCoordinateDTO +from .nar_details_entity import NarDetailsEntity +from .nar_summaries_entity import NarSummariesEntity +from .nar_summary_dto import NarSummaryDTO +from .nar_summary_entity import NarSummaryEntity from .node_connection_statistics_snapshot_dto import NodeConnectionStatisticsSnapshotDTO from .node_connection_status_snapshot_dto import NodeConnectionStatusSnapshotDTO from .node_counters_snapshot_dto import NodeCountersSnapshotDTO from .node_dto import NodeDTO from .node_entity import NodeEntity from .node_event_dto import NodeEventDTO -from .node_identifier import NodeIdentifier -from .node_jvm_diagnostics_snapshot_dto import NodeJVMDiagnosticsSnapshotDTO from .node_port_status_snapshot_dto import NodePortStatusSnapshotDTO from .node_process_group_status_snapshot_dto import NodeProcessGroupStatusSnapshotDTO from .node_processor_status_snapshot_dto import NodeProcessorStatusSnapshotDTO from .node_remote_process_group_status_snapshot_dto import NodeRemoteProcessGroupStatusSnapshotDTO from .node_replay_last_event_snapshot_dto import NodeReplayLastEventSnapshotDTO -from .node_response import NodeResponse from .node_search_result_dto import NodeSearchResultDTO from .node_status_snapshots_dto import NodeStatusSnapshotsDTO from .node_system_diagnostics_snapshot_dto import NodeSystemDiagnosticsSnapshotDTO @@ -210,6 +219,7 @@ from .parameter_provider_configuration_dto import ParameterProviderConfigurationDTO from .parameter_provider_configuration_entity import ParameterProviderConfigurationEntity from .parameter_provider_dto import ParameterProviderDTO +from .parameter_provider_definition import ParameterProviderDefinition from .parameter_provider_entity import ParameterProviderEntity from .parameter_provider_parameter_application_entity import ParameterProviderParameterApplicationEntity from .parameter_provider_parameter_fetch_entity import ParameterProviderParameterFetchEntity @@ -220,6 +230,8 @@ from .parameter_provider_types_entity import ParameterProviderTypesEntity from .parameter_providers_entity import ParameterProvidersEntity from .parameter_status_dto import ParameterStatusDTO +from .paste_request_entity import PasteRequestEntity +from .paste_response_entity import PasteResponseEntity from .peer_dto import PeerDTO from .peers_entity import PeersEntity from .permissions_dto import PermissionsDTO @@ -246,13 +258,14 @@ from .process_group_status_entity import ProcessGroupStatusEntity from .process_group_status_snapshot_dto import ProcessGroupStatusSnapshotDTO from .process_group_status_snapshot_entity import ProcessGroupStatusSnapshotEntity +from .process_group_upload_entity import ProcessGroupUploadEntity from .process_groups_entity import ProcessGroupsEntity +from .processgroups_upload_body import ProcessgroupsUploadBody from .processing_performance_status_dto import ProcessingPerformanceStatusDTO from .processor_config_dto import ProcessorConfigDTO +from .processor_configuration import ProcessorConfiguration from .processor_dto import ProcessorDTO from .processor_definition import ProcessorDefinition -from .processor_diagnostics_dto import ProcessorDiagnosticsDTO -from .processor_diagnostics_entity import ProcessorDiagnosticsEntity from .processor_entity import ProcessorEntity from .processor_run_status_details_dto import ProcessorRunStatusDetailsDTO from .processor_run_status_details_entity import ProcessorRunStatusDetailsEntity @@ -302,7 +315,6 @@ from .remote_process_group_status_snapshot_dto import RemoteProcessGroupStatusSnapshotDTO from .remote_process_group_status_snapshot_entity import RemoteProcessGroupStatusSnapshotEntity from .remote_process_groups_entity import RemoteProcessGroupsEntity -from .remote_queue_partition_dto import RemoteQueuePartitionDTO from .replay_last_event_request_entity import ReplayLastEventRequestEntity from .replay_last_event_response_entity import ReplayLastEventResponseEntity from .replay_last_event_snapshot_dto import ReplayLastEventSnapshotDTO @@ -313,11 +325,10 @@ from .reporting_task_status_dto import ReportingTaskStatusDTO from .reporting_task_types_entity import ReportingTaskTypesEntity from .reporting_tasks_entity import ReportingTasksEntity -from .repository_usage_dto import RepositoryUsageDTO from .required_permission_dto import RequiredPermissionDTO +from .resource_claim_details_dto import ResourceClaimDetailsDTO from .resource_dto import ResourceDTO from .resources_entity import ResourcesEntity -from .response import Response from .restriction import Restriction from .revision_dto import RevisionDTO from .run_status_details_request_entity import RunStatusDetailsRequestEntity @@ -330,7 +341,6 @@ from .search_results_entity import SearchResultsEntity from .snippet_dto import SnippetDTO from .snippet_entity import SnippetEntity -from .stack_trace_element import StackTraceElement from .start_version_control_request_entity import StartVersionControlRequestEntity from .state_entry_dto import StateEntryDTO from .state_map_dto import StateMapDTO @@ -342,33 +352,23 @@ from .storage_usage_dto import StorageUsageDTO from .streaming_output import StreamingOutput from .submit_replay_request_entity import SubmitReplayRequestEntity +from .supported_mime_types_dto import SupportedMimeTypesDTO from .system_diagnostics_dto import SystemDiagnosticsDTO from .system_diagnostics_entity import SystemDiagnosticsEntity from .system_diagnostics_snapshot_dto import SystemDiagnosticsSnapshotDTO from .system_resource_consideration import SystemResourceConsideration -from .template_dto import TemplateDTO -from .template_entity import TemplateEntity -from .templates_entity import TemplatesEntity from .tenant_dto import TenantDTO from .tenant_entity import TenantEntity from .tenants_entity import TenantsEntity -from .thread_dump_dto import ThreadDumpDTO -from .throwable import Throwable from .transaction_result_entity import TransactionResultEntity from .update_controller_service_reference_request_entity import UpdateControllerServiceReferenceRequestEntity +from .use_case import UseCase from .user_dto import UserDTO from .user_entity import UserEntity from .user_group_dto import UserGroupDTO from .user_group_entity import UserGroupEntity from .user_groups_entity import UserGroupsEntity from .users_entity import UsersEntity -from .variable_dto import VariableDTO -from .variable_entity import VariableEntity -from .variable_registry_dto import VariableRegistryDTO -from .variable_registry_entity import VariableRegistryEntity -from .variable_registry_update_request_dto import VariableRegistryUpdateRequestDTO -from .variable_registry_update_request_entity import VariableRegistryUpdateRequestEntity -from .variable_registry_update_step_dto import VariableRegistryUpdateStepDTO from .verify_config_request_dto import VerifyConfigRequestDTO from .verify_config_request_entity import VerifyConfigRequestEntity from .verify_config_update_step_dto import VerifyConfigUpdateStepDTO @@ -376,6 +376,7 @@ from .version_control_information_dto import VersionControlInformationDTO from .version_control_information_entity import VersionControlInformationEntity from .version_info_dto import VersionInfoDTO +from .versioned_asset import VersionedAsset from .versioned_connection import VersionedConnection from .versioned_controller_service import VersionedControllerService from .versioned_flow_coordinates import VersionedFlowCoordinates @@ -398,5 +399,7 @@ from .versioned_remote_group_port import VersionedRemoteGroupPort from .versioned_remote_process_group import VersionedRemoteProcessGroup from .versioned_reporting_task import VersionedReportingTask +from .versioned_reporting_task_import_request_entity import VersionedReportingTaskImportRequestEntity +from .versioned_reporting_task_import_response_entity import VersionedReportingTaskImportResponseEntity from .versioned_reporting_task_snapshot import VersionedReportingTaskSnapshot from .versioned_resource_definition import VersionedResourceDefinition diff --git a/nipyapi/nifi/models/about_dto.py b/nipyapi/nifi/models/about_dto.py index 9b352c43..9cc84e51 100644 --- a/nipyapi/nifi/models/about_dto.py +++ b/nipyapi/nifi/models/about_dto.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,131 +27,152 @@ class AboutDTO(object): and the value is json key in definition. """ swagger_types = { - 'title': 'str', - 'version': 'str', - 'uri': 'str', - 'content_viewer_url': 'str', - 'timezone': 'str', - 'build_tag': 'str', - 'build_revision': 'str', 'build_branch': 'str', - 'build_timestamp': 'str' - } +'build_revision': 'str', +'build_tag': 'str', +'build_timestamp': 'str', +'content_viewer_url': 'str', +'timezone': 'str', +'title': 'str', +'uri': 'str', +'version': 'str' } attribute_map = { - 'title': 'title', - 'version': 'version', - 'uri': 'uri', - 'content_viewer_url': 'contentViewerUrl', - 'timezone': 'timezone', - 'build_tag': 'buildTag', - 'build_revision': 'buildRevision', 'build_branch': 'buildBranch', - 'build_timestamp': 'buildTimestamp' - } +'build_revision': 'buildRevision', +'build_tag': 'buildTag', +'build_timestamp': 'buildTimestamp', +'content_viewer_url': 'contentViewerUrl', +'timezone': 'timezone', +'title': 'title', +'uri': 'uri', +'version': 'version' } - def __init__(self, title=None, version=None, uri=None, content_viewer_url=None, timezone=None, build_tag=None, build_revision=None, build_branch=None, build_timestamp=None): + def __init__(self, build_branch=None, build_revision=None, build_tag=None, build_timestamp=None, content_viewer_url=None, timezone=None, title=None, uri=None, version=None): """ AboutDTO - a model defined in Swagger """ - self._title = None - self._version = None - self._uri = None - self._content_viewer_url = None - self._timezone = None - self._build_tag = None - self._build_revision = None self._build_branch = None + self._build_revision = None + self._build_tag = None self._build_timestamp = None + self._content_viewer_url = None + self._timezone = None + self._title = None + self._uri = None + self._version = None - if title is not None: - self.title = title - if version is not None: - self.version = version - if uri is not None: - self.uri = uri - if content_viewer_url is not None: - self.content_viewer_url = content_viewer_url - if timezone is not None: - self.timezone = timezone - if build_tag is not None: - self.build_tag = build_tag - if build_revision is not None: - self.build_revision = build_revision if build_branch is not None: self.build_branch = build_branch + if build_revision is not None: + self.build_revision = build_revision + if build_tag is not None: + self.build_tag = build_tag if build_timestamp is not None: self.build_timestamp = build_timestamp + if content_viewer_url is not None: + self.content_viewer_url = content_viewer_url + if timezone is not None: + self.timezone = timezone + if title is not None: + self.title = title + if uri is not None: + self.uri = uri + if version is not None: + self.version = version @property - def title(self): + def build_branch(self): """ - Gets the title of this AboutDTO. - The title to be used on the page and in the about dialog. + Gets the build_branch of this AboutDTO. + Build branch - :return: The title of this AboutDTO. + :return: The build_branch of this AboutDTO. :rtype: str """ - return self._title + return self._build_branch - @title.setter - def title(self, title): + @build_branch.setter + def build_branch(self, build_branch): """ - Sets the title of this AboutDTO. - The title to be used on the page and in the about dialog. + Sets the build_branch of this AboutDTO. + Build branch - :param title: The title of this AboutDTO. + :param build_branch: The build_branch of this AboutDTO. :type: str """ - self._title = title + self._build_branch = build_branch @property - def version(self): + def build_revision(self): """ - Gets the version of this AboutDTO. - The version of this NiFi. + Gets the build_revision of this AboutDTO. + Build revision or commit hash - :return: The version of this AboutDTO. + :return: The build_revision of this AboutDTO. :rtype: str """ - return self._version + return self._build_revision - @version.setter - def version(self, version): + @build_revision.setter + def build_revision(self, build_revision): """ - Sets the version of this AboutDTO. - The version of this NiFi. + Sets the build_revision of this AboutDTO. + Build revision or commit hash - :param version: The version of this AboutDTO. + :param build_revision: The build_revision of this AboutDTO. :type: str """ - self._version = version + self._build_revision = build_revision @property - def uri(self): + def build_tag(self): """ - Gets the uri of this AboutDTO. - The URI for the NiFi. + Gets the build_tag of this AboutDTO. + Build tag - :return: The uri of this AboutDTO. + :return: The build_tag of this AboutDTO. :rtype: str """ - return self._uri + return self._build_tag - @uri.setter - def uri(self, uri): + @build_tag.setter + def build_tag(self, build_tag): """ - Sets the uri of this AboutDTO. - The URI for the NiFi. + Sets the build_tag of this AboutDTO. + Build tag - :param uri: The uri of this AboutDTO. + :param build_tag: The build_tag of this AboutDTO. :type: str """ - self._uri = uri + self._build_tag = build_tag + + @property + def build_timestamp(self): + """ + Gets the build_timestamp of this AboutDTO. + Build timestamp + + :return: The build_timestamp of this AboutDTO. + :rtype: str + """ + return self._build_timestamp + + @build_timestamp.setter + def build_timestamp(self, build_timestamp): + """ + Sets the build_timestamp of this AboutDTO. + Build timestamp + + :param build_timestamp: The build_timestamp of this AboutDTO. + :type: str + """ + + self._build_timestamp = build_timestamp @property def content_viewer_url(self): @@ -201,96 +221,73 @@ def timezone(self, timezone): self._timezone = timezone @property - def build_tag(self): - """ - Gets the build_tag of this AboutDTO. - Build tag - - :return: The build_tag of this AboutDTO. - :rtype: str - """ - return self._build_tag - - @build_tag.setter - def build_tag(self, build_tag): - """ - Sets the build_tag of this AboutDTO. - Build tag - - :param build_tag: The build_tag of this AboutDTO. - :type: str - """ - - self._build_tag = build_tag - - @property - def build_revision(self): + def title(self): """ - Gets the build_revision of this AboutDTO. - Build revision or commit hash + Gets the title of this AboutDTO. + The title to be used on the page and in the about dialog. - :return: The build_revision of this AboutDTO. + :return: The title of this AboutDTO. :rtype: str """ - return self._build_revision + return self._title - @build_revision.setter - def build_revision(self, build_revision): + @title.setter + def title(self, title): """ - Sets the build_revision of this AboutDTO. - Build revision or commit hash + Sets the title of this AboutDTO. + The title to be used on the page and in the about dialog. - :param build_revision: The build_revision of this AboutDTO. + :param title: The title of this AboutDTO. :type: str """ - self._build_revision = build_revision + self._title = title @property - def build_branch(self): + def uri(self): """ - Gets the build_branch of this AboutDTO. - Build branch + Gets the uri of this AboutDTO. + The URI for the NiFi. - :return: The build_branch of this AboutDTO. + :return: The uri of this AboutDTO. :rtype: str """ - return self._build_branch + return self._uri - @build_branch.setter - def build_branch(self, build_branch): + @uri.setter + def uri(self, uri): """ - Sets the build_branch of this AboutDTO. - Build branch + Sets the uri of this AboutDTO. + The URI for the NiFi. - :param build_branch: The build_branch of this AboutDTO. + :param uri: The uri of this AboutDTO. :type: str """ - self._build_branch = build_branch + self._uri = uri @property - def build_timestamp(self): + def version(self): """ - Gets the build_timestamp of this AboutDTO. - Build timestamp + Gets the version of this AboutDTO. + The version of this NiFi. - :return: The build_timestamp of this AboutDTO. + :return: The version of this AboutDTO. :rtype: str """ - return self._build_timestamp + return self._version - @build_timestamp.setter - def build_timestamp(self, build_timestamp): + @version.setter + def version(self, version): """ - Sets the build_timestamp of this AboutDTO. - Build timestamp + Sets the version of this AboutDTO. + The version of this NiFi. - :param build_timestamp: The build_timestamp of this AboutDTO. + :param version: The version of this AboutDTO. :type: str """ - self._build_timestamp = build_timestamp + self._version = version def to_dict(self): """ diff --git a/nipyapi/nifi/models/about_entity.py b/nipyapi/nifi/models/about_entity.py index b25e9559..18ce0ade 100644 --- a/nipyapi/nifi/models/about_entity.py +++ b/nipyapi/nifi/models/about_entity.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,12 +27,10 @@ class AboutEntity(object): and the value is json key in definition. """ swagger_types = { - 'about': 'AboutDTO' - } + 'about': 'AboutDTO' } attribute_map = { - 'about': 'about' - } + 'about': 'about' } def __init__(self, about=None): """ diff --git a/nipyapi/nifi/models/access_configuration_dto.py b/nipyapi/nifi/models/access_configuration_dto.py deleted file mode 100644 index 93909d82..00000000 --- a/nipyapi/nifi/models/access_configuration_dto.py +++ /dev/null @@ -1,122 +0,0 @@ -""" - NiFi Rest API - - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - - OpenAPI spec version: 1.28.1 - Contact: dev@nifi.apache.org - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - - -from pprint import pformat -import re - - -class AccessConfigurationDTO(object): - """ - NOTE: This class is auto generated by the swagger code generator program. - Do not edit the class manually. - """ - - - """ - Attributes: - swagger_types (dict): The key is attribute name - and the value is attribute type. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - """ - swagger_types = { - 'supports_login': 'bool' - } - - attribute_map = { - 'supports_login': 'supportsLogin' - } - - def __init__(self, supports_login=None): - """ - AccessConfigurationDTO - a model defined in Swagger - """ - - self._supports_login = None - - if supports_login is not None: - self.supports_login = supports_login - - @property - def supports_login(self): - """ - Gets the supports_login of this AccessConfigurationDTO. - Indicates whether or not this NiFi supports user login. - - :return: The supports_login of this AccessConfigurationDTO. - :rtype: bool - """ - return self._supports_login - - @supports_login.setter - def supports_login(self, supports_login): - """ - Sets the supports_login of this AccessConfigurationDTO. - Indicates whether or not this NiFi supports user login. - - :param supports_login: The supports_login of this AccessConfigurationDTO. - :type: bool - """ - - self._supports_login = supports_login - - 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, AccessConfigurationDTO): - 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/access_policy_dto.py b/nipyapi/nifi/models/access_policy_dto.py index be3bc532..337f1dcc 100644 --- a/nipyapi/nifi/models/access_policy_dto.py +++ b/nipyapi/nifi/models/access_policy_dto.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,113 +27,161 @@ class AccessPolicyDTO(object): and the value is json key in definition. """ swagger_types = { - 'id': 'str', - 'versioned_component_id': 'str', - 'parent_group_id': 'str', - 'position': 'PositionDTO', - 'resource': 'str', 'action': 'str', - 'component_reference': 'ComponentReferenceEntity', - 'configurable': 'bool', - 'users': 'list[TenantEntity]', - 'user_groups': 'list[TenantEntity]' - } +'component_reference': 'ComponentReferenceEntity', +'configurable': 'bool', +'id': 'str', +'parent_group_id': 'str', +'position': 'PositionDTO', +'resource': 'str', +'user_groups': 'list[TenantEntity]', +'users': 'list[TenantEntity]', +'versioned_component_id': 'str' } attribute_map = { - 'id': 'id', - 'versioned_component_id': 'versionedComponentId', - 'parent_group_id': 'parentGroupId', - 'position': 'position', - 'resource': 'resource', 'action': 'action', - 'component_reference': 'componentReference', - 'configurable': 'configurable', - 'users': 'users', - 'user_groups': 'userGroups' - } - - def __init__(self, id=None, versioned_component_id=None, parent_group_id=None, position=None, resource=None, action=None, component_reference=None, configurable=None, users=None, user_groups=None): +'component_reference': 'componentReference', +'configurable': 'configurable', +'id': 'id', +'parent_group_id': 'parentGroupId', +'position': 'position', +'resource': 'resource', +'user_groups': 'userGroups', +'users': 'users', +'versioned_component_id': 'versionedComponentId' } + + def __init__(self, action=None, component_reference=None, configurable=None, id=None, parent_group_id=None, position=None, resource=None, user_groups=None, users=None, versioned_component_id=None): """ AccessPolicyDTO - a model defined in Swagger """ + self._action = None + self._component_reference = None + self._configurable = None self._id = None - self._versioned_component_id = None self._parent_group_id = None self._position = None self._resource = None - self._action = None - self._component_reference = None - self._configurable = None - self._users = None self._user_groups = None + self._users = None + self._versioned_component_id = None + if action is not None: + self.action = action + if component_reference is not None: + self.component_reference = component_reference + if configurable is not None: + self.configurable = configurable if id is not None: self.id = id - if versioned_component_id is not None: - self.versioned_component_id = versioned_component_id if parent_group_id is not None: self.parent_group_id = parent_group_id if position is not None: self.position = position if resource is not None: self.resource = resource - if action is not None: - self.action = action - if component_reference is not None: - self.component_reference = component_reference - if configurable is not None: - self.configurable = configurable - if users is not None: - self.users = users if user_groups is not None: self.user_groups = user_groups + if users is not None: + self.users = users + if versioned_component_id is not None: + self.versioned_component_id = versioned_component_id @property - def id(self): + def action(self): """ - Gets the id of this AccessPolicyDTO. - The id of the component. + Gets the action of this AccessPolicyDTO. + The action associated with this access policy. - :return: The id of this AccessPolicyDTO. + :return: The action of this AccessPolicyDTO. :rtype: str """ - return self._id + return self._action - @id.setter - def id(self, id): + @action.setter + def action(self, action): """ - Sets the id of this AccessPolicyDTO. - The id of the component. + Sets the action of this AccessPolicyDTO. + The action associated with this access policy. - :param id: The id of this AccessPolicyDTO. + :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) + ) - self._id = id + self._action = action @property - def versioned_component_id(self): + def component_reference(self): """ - Gets the versioned_component_id of this AccessPolicyDTO. - The ID of the corresponding component that is under version control + Gets the component_reference of this AccessPolicyDTO. - :return: The versioned_component_id of this AccessPolicyDTO. + :return: The component_reference of this AccessPolicyDTO. + :rtype: ComponentReferenceEntity + """ + return self._component_reference + + @component_reference.setter + def component_reference(self, component_reference): + """ + Sets the component_reference of this AccessPolicyDTO. + + :param component_reference: The component_reference of this AccessPolicyDTO. + :type: ComponentReferenceEntity + """ + + self._component_reference = component_reference + + @property + def configurable(self): + """ + Gets the configurable of this AccessPolicyDTO. + Whether this policy is configurable. + + :return: The configurable of this AccessPolicyDTO. + :rtype: bool + """ + return self._configurable + + @configurable.setter + def configurable(self, configurable): + """ + Sets the configurable of this AccessPolicyDTO. + Whether this policy is configurable. + + :param configurable: The configurable of this AccessPolicyDTO. + :type: bool + """ + + self._configurable = configurable + + @property + def id(self): + """ + Gets the id of this AccessPolicyDTO. + The id of the component. + + :return: The id of this AccessPolicyDTO. :rtype: str """ - return self._versioned_component_id + return self._id - @versioned_component_id.setter - def versioned_component_id(self, versioned_component_id): + @id.setter + def id(self, id): """ - Sets the versioned_component_id of this AccessPolicyDTO. - The ID of the corresponding component that is under version control + Sets the id of this AccessPolicyDTO. + The id of the component. - :param versioned_component_id: The versioned_component_id of this AccessPolicyDTO. + :param id: The id of this AccessPolicyDTO. :type: str """ - self._versioned_component_id = versioned_component_id + self._id = id @property def parent_group_id(self): @@ -163,7 +210,6 @@ def parent_group_id(self, parent_group_id): def position(self): """ Gets the position of this AccessPolicyDTO. - The position of this component in the UI if applicable. :return: The position of this AccessPolicyDTO. :rtype: PositionDTO @@ -174,7 +220,6 @@ def position(self): def position(self, position): """ Sets the position of this AccessPolicyDTO. - The position of this component in the UI if applicable. :param position: The position of this AccessPolicyDTO. :type: PositionDTO @@ -206,79 +251,27 @@ def resource(self, resource): self._resource = resource @property - def action(self): - """ - Gets the action of this AccessPolicyDTO. - The action associated with this access policy. - - :return: The action of this AccessPolicyDTO. - :rtype: str - """ - return self._action - - @action.setter - def action(self, action): - """ - Sets the action of this AccessPolicyDTO. - The action associated with this access policy. - - :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) - ) - - self._action = action - - @property - def component_reference(self): - """ - Gets the component_reference of this AccessPolicyDTO. - Component this policy references if applicable. - - :return: The component_reference of this AccessPolicyDTO. - :rtype: ComponentReferenceEntity - """ - return self._component_reference - - @component_reference.setter - def component_reference(self, component_reference): - """ - Sets the component_reference of this AccessPolicyDTO. - Component this policy references if applicable. - - :param component_reference: The component_reference of this AccessPolicyDTO. - :type: ComponentReferenceEntity - """ - - self._component_reference = component_reference - - @property - def configurable(self): + def user_groups(self): """ - Gets the configurable of this AccessPolicyDTO. - Whether this policy is configurable. + Gets the user_groups of this AccessPolicyDTO. + The set of user group IDs associated with this access policy. - :return: The configurable of this AccessPolicyDTO. - :rtype: bool + :return: The user_groups of this AccessPolicyDTO. + :rtype: list[TenantEntity] """ - return self._configurable + return self._user_groups - @configurable.setter - def configurable(self, configurable): + @user_groups.setter + def user_groups(self, user_groups): """ - Sets the configurable of this AccessPolicyDTO. - Whether this policy is configurable. + Sets the user_groups of this AccessPolicyDTO. + The set of user group IDs associated with this access policy. - :param configurable: The configurable of this AccessPolicyDTO. - :type: bool + :param user_groups: The user_groups of this AccessPolicyDTO. + :type: list[TenantEntity] """ - self._configurable = configurable + self._user_groups = user_groups @property def users(self): @@ -304,27 +297,27 @@ def users(self, users): self._users = users @property - def user_groups(self): + def versioned_component_id(self): """ - Gets the user_groups of this AccessPolicyDTO. - The set of user group IDs associated with this access policy. + Gets the versioned_component_id of this AccessPolicyDTO. + The ID of the corresponding component that is under version control - :return: The user_groups of this AccessPolicyDTO. - :rtype: list[TenantEntity] + :return: The versioned_component_id of this AccessPolicyDTO. + :rtype: str """ - return self._user_groups + return self._versioned_component_id - @user_groups.setter - def user_groups(self, user_groups): + @versioned_component_id.setter + def versioned_component_id(self, versioned_component_id): """ - Sets the user_groups of this AccessPolicyDTO. - The set of user group IDs associated with this access policy. + Sets the versioned_component_id of this AccessPolicyDTO. + The ID of the corresponding component that is under version control - :param user_groups: The user_groups of this AccessPolicyDTO. - :type: list[TenantEntity] + :param versioned_component_id: The versioned_component_id of this AccessPolicyDTO. + :type: str """ - self._user_groups = user_groups + self._versioned_component_id = versioned_component_id def to_dict(self): """ diff --git a/nipyapi/nifi/models/access_policy_entity.py b/nipyapi/nifi/models/access_policy_entity.py index 863257c4..36f9303d 100644 --- a/nipyapi/nifi/models/access_policy_entity.py +++ b/nipyapi/nifi/models/access_policy_entity.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,160 +27,178 @@ class AccessPolicyEntity(object): and the value is json key in definition. """ swagger_types = { - 'revision': 'RevisionDTO', - 'id': 'str', - 'uri': 'str', - 'position': 'PositionDTO', - 'permissions': 'PermissionsDTO', 'bulletins': 'list[BulletinEntity]', - 'disconnected_node_acknowledged': 'bool', - 'generated': 'str', - 'component': 'AccessPolicyDTO' - } +'component': 'AccessPolicyDTO', +'disconnected_node_acknowledged': 'bool', +'generated': 'str', +'id': 'str', +'permissions': 'PermissionsDTO', +'position': 'PositionDTO', +'revision': 'RevisionDTO', +'uri': 'str' } attribute_map = { - 'revision': 'revision', - 'id': 'id', - 'uri': 'uri', - 'position': 'position', - 'permissions': 'permissions', 'bulletins': 'bulletins', - 'disconnected_node_acknowledged': 'disconnectedNodeAcknowledged', - 'generated': 'generated', - 'component': 'component' - } +'component': 'component', +'disconnected_node_acknowledged': 'disconnectedNodeAcknowledged', +'generated': 'generated', +'id': 'id', +'permissions': 'permissions', +'position': 'position', +'revision': 'revision', +'uri': 'uri' } - def __init__(self, revision=None, id=None, uri=None, position=None, permissions=None, bulletins=None, disconnected_node_acknowledged=None, generated=None, component=None): + def __init__(self, bulletins=None, component=None, disconnected_node_acknowledged=None, generated=None, id=None, permissions=None, position=None, revision=None, uri=None): """ AccessPolicyEntity - a model defined in Swagger """ - self._revision = None - self._id = None - self._uri = None - self._position = None - self._permissions = None self._bulletins = None + self._component = None self._disconnected_node_acknowledged = None self._generated = None - self._component = None + self._id = None + self._permissions = None + self._position = None + self._revision = None + self._uri = None - if revision is not None: - self.revision = revision - if id is not None: - self.id = id - if uri is not None: - self.uri = uri - if position is not None: - self.position = position - if permissions is not None: - self.permissions = permissions if bulletins is not None: self.bulletins = bulletins + if component is not None: + self.component = component if disconnected_node_acknowledged is not None: self.disconnected_node_acknowledged = disconnected_node_acknowledged if generated is not None: self.generated = generated - if component is not None: - self.component = component + if id is not None: + self.id = id + if permissions is not None: + self.permissions = permissions + if position is not None: + self.position = position + if revision is not None: + self.revision = revision + if uri is not None: + self.uri = uri @property - def revision(self): + def bulletins(self): """ - Gets the revision of this AccessPolicyEntity. - The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses. + Gets the bulletins of this AccessPolicyEntity. + The bulletins for this component. - :return: The revision of this AccessPolicyEntity. - :rtype: RevisionDTO + :return: The bulletins of this AccessPolicyEntity. + :rtype: list[BulletinEntity] """ - return self._revision + return self._bulletins - @revision.setter - def revision(self, revision): + @bulletins.setter + def bulletins(self, bulletins): """ - Sets the revision of this AccessPolicyEntity. - The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses. + Sets the bulletins of this AccessPolicyEntity. + The bulletins for this component. - :param revision: The revision of this AccessPolicyEntity. - :type: RevisionDTO + :param bulletins: The bulletins of this AccessPolicyEntity. + :type: list[BulletinEntity] """ - self._revision = revision + self._bulletins = bulletins @property - def id(self): + def component(self): """ - Gets the id of this AccessPolicyEntity. - The id of the component. + Gets the component of this AccessPolicyEntity. - :return: The id of this AccessPolicyEntity. - :rtype: str + :return: The component of this AccessPolicyEntity. + :rtype: AccessPolicyDTO """ - return self._id + return self._component - @id.setter - def id(self, id): + @component.setter + def component(self, component): """ - Sets the id of this AccessPolicyEntity. - The id of the component. + Sets the component of this AccessPolicyEntity. - :param id: The id of this AccessPolicyEntity. - :type: str + :param component: The component of this AccessPolicyEntity. + :type: AccessPolicyDTO """ - self._id = id + self._component = component @property - def uri(self): + def disconnected_node_acknowledged(self): """ - Gets the uri of this AccessPolicyEntity. - The URI for futures requests to the component. + Gets the disconnected_node_acknowledged of this AccessPolicyEntity. + Acknowledges that this node is disconnected to allow for mutable requests to proceed. - :return: The uri of this AccessPolicyEntity. + :return: The disconnected_node_acknowledged of this AccessPolicyEntity. + :rtype: bool + """ + return self._disconnected_node_acknowledged + + @disconnected_node_acknowledged.setter + def disconnected_node_acknowledged(self, disconnected_node_acknowledged): + """ + Sets the disconnected_node_acknowledged of this AccessPolicyEntity. + Acknowledges that this node is disconnected to allow for mutable requests to proceed. + + :param disconnected_node_acknowledged: The disconnected_node_acknowledged of this AccessPolicyEntity. + :type: bool + """ + + self._disconnected_node_acknowledged = disconnected_node_acknowledged + + @property + def generated(self): + """ + Gets the generated of this AccessPolicyEntity. + When this content was generated. + + :return: The generated of this AccessPolicyEntity. :rtype: str """ - return self._uri + return self._generated - @uri.setter - def uri(self, uri): + @generated.setter + def generated(self, generated): """ - Sets the uri of this AccessPolicyEntity. - The URI for futures requests to the component. + Sets the generated of this AccessPolicyEntity. + When this content was generated. - :param uri: The uri of this AccessPolicyEntity. + :param generated: The generated of this AccessPolicyEntity. :type: str """ - self._uri = uri + self._generated = generated @property - def position(self): + def id(self): """ - Gets the position of this AccessPolicyEntity. - The position of this component in the UI if applicable. + Gets the id of this AccessPolicyEntity. + The id of the component. - :return: The position of this AccessPolicyEntity. - :rtype: PositionDTO + :return: The id of this AccessPolicyEntity. + :rtype: str """ - return self._position + return self._id - @position.setter - def position(self, position): + @id.setter + def id(self, id): """ - Sets the position of this AccessPolicyEntity. - The position of this component in the UI if applicable. + Sets the id of this AccessPolicyEntity. + The id of the component. - :param position: The position of this AccessPolicyEntity. - :type: PositionDTO + :param id: The id of this AccessPolicyEntity. + :type: str """ - self._position = position + self._id = id @property def permissions(self): """ Gets the permissions of this AccessPolicyEntity. - The permissions for this component. :return: The permissions of this AccessPolicyEntity. :rtype: PermissionsDTO @@ -192,7 +209,6 @@ def permissions(self): def permissions(self, permissions): """ Sets the permissions of this AccessPolicyEntity. - The permissions for this component. :param permissions: The permissions of this AccessPolicyEntity. :type: PermissionsDTO @@ -201,94 +217,69 @@ def permissions(self, permissions): self._permissions = permissions @property - def bulletins(self): + def position(self): """ - Gets the bulletins of this AccessPolicyEntity. - The bulletins for this component. + Gets the position of this AccessPolicyEntity. - :return: The bulletins of this AccessPolicyEntity. - :rtype: list[BulletinEntity] + :return: The position of this AccessPolicyEntity. + :rtype: PositionDTO """ - return self._bulletins + return self._position - @bulletins.setter - def bulletins(self, bulletins): + @position.setter + def position(self, position): """ - Sets the bulletins of this AccessPolicyEntity. - The bulletins for this component. + Sets the position of this AccessPolicyEntity. - :param bulletins: The bulletins of this AccessPolicyEntity. - :type: list[BulletinEntity] + :param position: The position of this AccessPolicyEntity. + :type: PositionDTO """ - self._bulletins = bulletins + self._position = position @property - def disconnected_node_acknowledged(self): + def revision(self): """ - Gets the disconnected_node_acknowledged of this AccessPolicyEntity. - Acknowledges that this node is disconnected to allow for mutable requests to proceed. + Gets the revision of this AccessPolicyEntity. - :return: The disconnected_node_acknowledged of this AccessPolicyEntity. - :rtype: bool + :return: The revision of this AccessPolicyEntity. + :rtype: RevisionDTO """ - return self._disconnected_node_acknowledged + return self._revision - @disconnected_node_acknowledged.setter - def disconnected_node_acknowledged(self, disconnected_node_acknowledged): + @revision.setter + def revision(self, revision): """ - Sets the disconnected_node_acknowledged of this AccessPolicyEntity. - Acknowledges that this node is disconnected to allow for mutable requests to proceed. + Sets the revision of this AccessPolicyEntity. - :param disconnected_node_acknowledged: The disconnected_node_acknowledged of this AccessPolicyEntity. - :type: bool + :param revision: The revision of this AccessPolicyEntity. + :type: RevisionDTO """ - self._disconnected_node_acknowledged = disconnected_node_acknowledged + self._revision = revision @property - def generated(self): + def uri(self): """ - Gets the generated of this AccessPolicyEntity. - When this content was generated. + Gets the uri of this AccessPolicyEntity. + The URI for futures requests to the component. - :return: The generated of this AccessPolicyEntity. + :return: The uri of this AccessPolicyEntity. :rtype: str """ - return self._generated + return self._uri - @generated.setter - def generated(self, generated): + @uri.setter + def uri(self, uri): """ - Sets the generated of this AccessPolicyEntity. - When this content was generated. + Sets the uri of this AccessPolicyEntity. + The URI for futures requests to the component. - :param generated: The generated of this AccessPolicyEntity. + :param uri: The uri of this AccessPolicyEntity. :type: str """ - self._generated = generated - - @property - def component(self): - """ - Gets the component of this AccessPolicyEntity. - - :return: The component of this AccessPolicyEntity. - :rtype: AccessPolicyDTO - """ - return self._component - - @component.setter - def component(self, component): - """ - Sets the component of this AccessPolicyEntity. - - :param component: The component of this AccessPolicyEntity. - :type: AccessPolicyDTO - """ - - self._component = component + self._uri = uri def to_dict(self): """ diff --git a/nipyapi/nifi/models/access_policy_summary_dto.py b/nipyapi/nifi/models/access_policy_summary_dto.py index 7db64293..04a7e1f0 100644 --- a/nipyapi/nifi/models/access_policy_summary_dto.py +++ b/nipyapi/nifi/models/access_policy_summary_dto.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,103 +27,151 @@ class AccessPolicySummaryDTO(object): and the value is json key in definition. """ swagger_types = { - 'id': 'str', - 'versioned_component_id': 'str', - 'parent_group_id': 'str', - 'position': 'PositionDTO', - 'resource': 'str', 'action': 'str', - 'component_reference': 'ComponentReferenceEntity', - 'configurable': 'bool' - } +'component_reference': 'ComponentReferenceEntity', +'configurable': 'bool', +'id': 'str', +'parent_group_id': 'str', +'position': 'PositionDTO', +'resource': 'str', +'versioned_component_id': 'str' } attribute_map = { - 'id': 'id', - 'versioned_component_id': 'versionedComponentId', - 'parent_group_id': 'parentGroupId', - 'position': 'position', - 'resource': 'resource', 'action': 'action', - 'component_reference': 'componentReference', - 'configurable': 'configurable' - } +'component_reference': 'componentReference', +'configurable': 'configurable', +'id': 'id', +'parent_group_id': 'parentGroupId', +'position': 'position', +'resource': 'resource', +'versioned_component_id': 'versionedComponentId' } - def __init__(self, id=None, versioned_component_id=None, parent_group_id=None, position=None, resource=None, action=None, component_reference=None, configurable=None): + def __init__(self, action=None, component_reference=None, configurable=None, id=None, parent_group_id=None, position=None, resource=None, versioned_component_id=None): """ AccessPolicySummaryDTO - a model defined in Swagger """ + self._action = None + self._component_reference = None + self._configurable = None self._id = None - self._versioned_component_id = None self._parent_group_id = None self._position = None self._resource = None - self._action = None - self._component_reference = None - self._configurable = None + self._versioned_component_id = None + if action is not None: + self.action = action + if component_reference is not None: + self.component_reference = component_reference + if configurable is not None: + self.configurable = configurable if id is not None: self.id = id - if versioned_component_id is not None: - self.versioned_component_id = versioned_component_id if parent_group_id is not None: self.parent_group_id = parent_group_id if position is not None: self.position = position if resource is not None: self.resource = resource - if action is not None: - self.action = action - if component_reference is not None: - self.component_reference = component_reference - if configurable is not None: - self.configurable = configurable + if versioned_component_id is not None: + self.versioned_component_id = versioned_component_id @property - def id(self): + def action(self): """ - Gets the id of this AccessPolicySummaryDTO. - The id of the component. + Gets the action of this AccessPolicySummaryDTO. + The action associated with this access policy. - :return: The id of this AccessPolicySummaryDTO. + :return: The action of this AccessPolicySummaryDTO. :rtype: str """ - return self._id + return self._action - @id.setter - def id(self, id): + @action.setter + def action(self, action): """ - Sets the id of this AccessPolicySummaryDTO. - The id of the component. + Sets the action of this AccessPolicySummaryDTO. + The action associated with this access policy. - :param id: The id of this AccessPolicySummaryDTO. + :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) + ) - self._id = id + self._action = action @property - def versioned_component_id(self): + def component_reference(self): """ - Gets the versioned_component_id of this AccessPolicySummaryDTO. - The ID of the corresponding component that is under version control + Gets the component_reference of this AccessPolicySummaryDTO. - :return: The versioned_component_id of this AccessPolicySummaryDTO. + :return: The component_reference of this AccessPolicySummaryDTO. + :rtype: ComponentReferenceEntity + """ + return self._component_reference + + @component_reference.setter + def component_reference(self, component_reference): + """ + Sets the component_reference of this AccessPolicySummaryDTO. + + :param component_reference: The component_reference of this AccessPolicySummaryDTO. + :type: ComponentReferenceEntity + """ + + self._component_reference = component_reference + + @property + def configurable(self): + """ + Gets the configurable of this AccessPolicySummaryDTO. + Whether this policy is configurable. + + :return: The configurable of this AccessPolicySummaryDTO. + :rtype: bool + """ + return self._configurable + + @configurable.setter + def configurable(self, configurable): + """ + Sets the configurable of this AccessPolicySummaryDTO. + Whether this policy is configurable. + + :param configurable: The configurable of this AccessPolicySummaryDTO. + :type: bool + """ + + self._configurable = configurable + + @property + def id(self): + """ + Gets the id of this AccessPolicySummaryDTO. + The id of the component. + + :return: The id of this AccessPolicySummaryDTO. :rtype: str """ - return self._versioned_component_id + return self._id - @versioned_component_id.setter - def versioned_component_id(self, versioned_component_id): + @id.setter + def id(self, id): """ - Sets the versioned_component_id of this AccessPolicySummaryDTO. - The ID of the corresponding component that is under version control + Sets the id of this AccessPolicySummaryDTO. + The id of the component. - :param versioned_component_id: The versioned_component_id of this AccessPolicySummaryDTO. + :param id: The id of this AccessPolicySummaryDTO. :type: str """ - self._versioned_component_id = versioned_component_id + self._id = id @property def parent_group_id(self): @@ -153,7 +200,6 @@ def parent_group_id(self, parent_group_id): def position(self): """ Gets the position of this AccessPolicySummaryDTO. - The position of this component in the UI if applicable. :return: The position of this AccessPolicySummaryDTO. :rtype: PositionDTO @@ -164,7 +210,6 @@ def position(self): def position(self, position): """ Sets the position of this AccessPolicySummaryDTO. - The position of this component in the UI if applicable. :param position: The position of this AccessPolicySummaryDTO. :type: PositionDTO @@ -196,79 +241,27 @@ def resource(self, resource): self._resource = resource @property - def action(self): + def versioned_component_id(self): """ - Gets the action of this AccessPolicySummaryDTO. - The action associated with this access policy. + Gets the versioned_component_id of this AccessPolicySummaryDTO. + The ID of the corresponding component that is under version control - :return: The action of this AccessPolicySummaryDTO. + :return: The versioned_component_id of this AccessPolicySummaryDTO. :rtype: str """ - return self._action + return self._versioned_component_id - @action.setter - def action(self, action): + @versioned_component_id.setter + def versioned_component_id(self, versioned_component_id): """ - Sets the action of this AccessPolicySummaryDTO. - The action associated with this access policy. + Sets the versioned_component_id of this AccessPolicySummaryDTO. + The ID of the corresponding component that is under version control - :param action: The action of this AccessPolicySummaryDTO. + :param versioned_component_id: The versioned_component_id 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) - ) - - self._action = action - - @property - def component_reference(self): - """ - Gets the component_reference of this AccessPolicySummaryDTO. - Component this policy references if applicable. - - :return: The component_reference of this AccessPolicySummaryDTO. - :rtype: ComponentReferenceEntity - """ - return self._component_reference - - @component_reference.setter - def component_reference(self, component_reference): - """ - Sets the component_reference of this AccessPolicySummaryDTO. - Component this policy references if applicable. - - :param component_reference: The component_reference of this AccessPolicySummaryDTO. - :type: ComponentReferenceEntity - """ - - self._component_reference = component_reference - @property - def configurable(self): - """ - Gets the configurable of this AccessPolicySummaryDTO. - Whether this policy is configurable. - - :return: The configurable of this AccessPolicySummaryDTO. - :rtype: bool - """ - return self._configurable - - @configurable.setter - def configurable(self, configurable): - """ - Sets the configurable of this AccessPolicySummaryDTO. - Whether this policy is configurable. - - :param configurable: The configurable of this AccessPolicySummaryDTO. - :type: bool - """ - - self._configurable = configurable + self._versioned_component_id = versioned_component_id def to_dict(self): """ diff --git a/nipyapi/nifi/models/access_policy_summary_entity.py b/nipyapi/nifi/models/access_policy_summary_entity.py index 473f7413..fe5620af 100644 --- a/nipyapi/nifi/models/access_policy_summary_entity.py +++ b/nipyapi/nifi/models/access_policy_summary_entity.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,155 +27,150 @@ class AccessPolicySummaryEntity(object): and the value is json key in definition. """ swagger_types = { - 'revision': 'RevisionDTO', - 'id': 'str', - 'uri': 'str', - 'position': 'PositionDTO', - 'permissions': 'PermissionsDTO', 'bulletins': 'list[BulletinEntity]', - 'disconnected_node_acknowledged': 'bool', - 'component': 'AccessPolicySummaryDTO' - } +'component': 'AccessPolicySummaryDTO', +'disconnected_node_acknowledged': 'bool', +'id': 'str', +'permissions': 'PermissionsDTO', +'position': 'PositionDTO', +'revision': 'RevisionDTO', +'uri': 'str' } attribute_map = { - 'revision': 'revision', - 'id': 'id', - 'uri': 'uri', - 'position': 'position', - 'permissions': 'permissions', 'bulletins': 'bulletins', - 'disconnected_node_acknowledged': 'disconnectedNodeAcknowledged', - 'component': 'component' - } +'component': 'component', +'disconnected_node_acknowledged': 'disconnectedNodeAcknowledged', +'id': 'id', +'permissions': 'permissions', +'position': 'position', +'revision': 'revision', +'uri': 'uri' } - def __init__(self, revision=None, id=None, uri=None, position=None, permissions=None, bulletins=None, disconnected_node_acknowledged=None, component=None): + def __init__(self, bulletins=None, component=None, disconnected_node_acknowledged=None, id=None, permissions=None, position=None, revision=None, uri=None): """ AccessPolicySummaryEntity - a model defined in Swagger """ - self._revision = None - self._id = None - self._uri = None - self._position = None - self._permissions = None self._bulletins = None - self._disconnected_node_acknowledged = None self._component = None + self._disconnected_node_acknowledged = None + self._id = None + self._permissions = None + self._position = None + self._revision = None + self._uri = None - if revision is not None: - self.revision = revision - if id is not None: - self.id = id - if uri is not None: - self.uri = uri - if position is not None: - self.position = position - if permissions is not None: - self.permissions = permissions if bulletins is not None: self.bulletins = bulletins - if disconnected_node_acknowledged is not None: - self.disconnected_node_acknowledged = disconnected_node_acknowledged if component is not None: self.component = component + if disconnected_node_acknowledged is not None: + self.disconnected_node_acknowledged = disconnected_node_acknowledged + if id is not None: + self.id = id + if permissions is not None: + self.permissions = permissions + if position is not None: + self.position = position + if revision is not None: + self.revision = revision + if uri is not None: + self.uri = uri @property - def revision(self): + def bulletins(self): """ - Gets the revision of this AccessPolicySummaryEntity. - The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses. + Gets the bulletins of this AccessPolicySummaryEntity. + The bulletins for this component. - :return: The revision of this AccessPolicySummaryEntity. - :rtype: RevisionDTO + :return: The bulletins of this AccessPolicySummaryEntity. + :rtype: list[BulletinEntity] """ - return self._revision + return self._bulletins - @revision.setter - def revision(self, revision): + @bulletins.setter + def bulletins(self, bulletins): """ - Sets the revision of this AccessPolicySummaryEntity. - The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses. + Sets the bulletins of this AccessPolicySummaryEntity. + The bulletins for this component. - :param revision: The revision of this AccessPolicySummaryEntity. - :type: RevisionDTO + :param bulletins: The bulletins of this AccessPolicySummaryEntity. + :type: list[BulletinEntity] """ - self._revision = revision + self._bulletins = bulletins @property - def id(self): + def component(self): """ - Gets the id of this AccessPolicySummaryEntity. - The id of the component. + Gets the component of this AccessPolicySummaryEntity. - :return: The id of this AccessPolicySummaryEntity. - :rtype: str + :return: The component of this AccessPolicySummaryEntity. + :rtype: AccessPolicySummaryDTO """ - return self._id + return self._component - @id.setter - def id(self, id): + @component.setter + def component(self, component): """ - Sets the id of this AccessPolicySummaryEntity. - The id of the component. + Sets the component of this AccessPolicySummaryEntity. - :param id: The id of this AccessPolicySummaryEntity. - :type: str + :param component: The component of this AccessPolicySummaryEntity. + :type: AccessPolicySummaryDTO """ - self._id = id + self._component = component @property - def uri(self): + def disconnected_node_acknowledged(self): """ - Gets the uri of this AccessPolicySummaryEntity. - The URI for futures requests to the component. + Gets the disconnected_node_acknowledged of this AccessPolicySummaryEntity. + Acknowledges that this node is disconnected to allow for mutable requests to proceed. - :return: The uri of this AccessPolicySummaryEntity. - :rtype: str + :return: The disconnected_node_acknowledged of this AccessPolicySummaryEntity. + :rtype: bool """ - return self._uri + return self._disconnected_node_acknowledged - @uri.setter - def uri(self, uri): + @disconnected_node_acknowledged.setter + def disconnected_node_acknowledged(self, disconnected_node_acknowledged): """ - Sets the uri of this AccessPolicySummaryEntity. - The URI for futures requests to the component. + Sets the disconnected_node_acknowledged of this AccessPolicySummaryEntity. + Acknowledges that this node is disconnected to allow for mutable requests to proceed. - :param uri: The uri of this AccessPolicySummaryEntity. - :type: str + :param disconnected_node_acknowledged: The disconnected_node_acknowledged of this AccessPolicySummaryEntity. + :type: bool """ - self._uri = uri + self._disconnected_node_acknowledged = disconnected_node_acknowledged @property - def position(self): + def id(self): """ - Gets the position of this AccessPolicySummaryEntity. - The position of this component in the UI if applicable. + Gets the id of this AccessPolicySummaryEntity. + The id of the component. - :return: The position of this AccessPolicySummaryEntity. - :rtype: PositionDTO + :return: The id of this AccessPolicySummaryEntity. + :rtype: str """ - return self._position + return self._id - @position.setter - def position(self, position): + @id.setter + def id(self, id): """ - Sets the position of this AccessPolicySummaryEntity. - The position of this component in the UI if applicable. + Sets the id of this AccessPolicySummaryEntity. + The id of the component. - :param position: The position of this AccessPolicySummaryEntity. - :type: PositionDTO + :param id: The id of this AccessPolicySummaryEntity. + :type: str """ - self._position = position + self._id = id @property def permissions(self): """ Gets the permissions of this AccessPolicySummaryEntity. - The permissions for this component. :return: The permissions of this AccessPolicySummaryEntity. :rtype: PermissionsDTO @@ -187,7 +181,6 @@ def permissions(self): def permissions(self, permissions): """ Sets the permissions of this AccessPolicySummaryEntity. - The permissions for this component. :param permissions: The permissions of this AccessPolicySummaryEntity. :type: PermissionsDTO @@ -196,71 +189,69 @@ def permissions(self, permissions): self._permissions = permissions @property - def bulletins(self): + def position(self): """ - Gets the bulletins of this AccessPolicySummaryEntity. - The bulletins for this component. + Gets the position of this AccessPolicySummaryEntity. - :return: The bulletins of this AccessPolicySummaryEntity. - :rtype: list[BulletinEntity] + :return: The position of this AccessPolicySummaryEntity. + :rtype: PositionDTO """ - return self._bulletins + return self._position - @bulletins.setter - def bulletins(self, bulletins): + @position.setter + def position(self, position): """ - Sets the bulletins of this AccessPolicySummaryEntity. - The bulletins for this component. + Sets the position of this AccessPolicySummaryEntity. - :param bulletins: The bulletins of this AccessPolicySummaryEntity. - :type: list[BulletinEntity] + :param position: The position of this AccessPolicySummaryEntity. + :type: PositionDTO """ - self._bulletins = bulletins + self._position = position @property - def disconnected_node_acknowledged(self): + def revision(self): """ - Gets the disconnected_node_acknowledged of this AccessPolicySummaryEntity. - Acknowledges that this node is disconnected to allow for mutable requests to proceed. + Gets the revision of this AccessPolicySummaryEntity. - :return: The disconnected_node_acknowledged of this AccessPolicySummaryEntity. - :rtype: bool + :return: The revision of this AccessPolicySummaryEntity. + :rtype: RevisionDTO """ - return self._disconnected_node_acknowledged + return self._revision - @disconnected_node_acknowledged.setter - def disconnected_node_acknowledged(self, disconnected_node_acknowledged): + @revision.setter + def revision(self, revision): """ - Sets the disconnected_node_acknowledged of this AccessPolicySummaryEntity. - Acknowledges that this node is disconnected to allow for mutable requests to proceed. + Sets the revision of this AccessPolicySummaryEntity. - :param disconnected_node_acknowledged: The disconnected_node_acknowledged of this AccessPolicySummaryEntity. - :type: bool + :param revision: The revision of this AccessPolicySummaryEntity. + :type: RevisionDTO """ - self._disconnected_node_acknowledged = disconnected_node_acknowledged + self._revision = revision @property - def component(self): + def uri(self): """ - Gets the component of this AccessPolicySummaryEntity. + Gets the uri of this AccessPolicySummaryEntity. + The URI for futures requests to the component. - :return: The component of this AccessPolicySummaryEntity. - :rtype: AccessPolicySummaryDTO + :return: The uri of this AccessPolicySummaryEntity. + :rtype: str """ - return self._component + return self._uri - @component.setter - def component(self, component): + @uri.setter + def uri(self, uri): """ - Sets the component of this AccessPolicySummaryEntity. + Sets the uri of this AccessPolicySummaryEntity. + The URI for futures requests to the component. - :param component: The component of this AccessPolicySummaryEntity. - :type: AccessPolicySummaryDTO + :param uri: The uri of this AccessPolicySummaryEntity. + :type: str """ - self._component = component + self._uri = uri def to_dict(self): """ diff --git a/nipyapi/nifi/models/access_status_dto.py b/nipyapi/nifi/models/access_status_dto.py deleted file mode 100644 index 36fba752..00000000 --- a/nipyapi/nifi/models/access_status_dto.py +++ /dev/null @@ -1,178 +0,0 @@ -""" - NiFi Rest API - - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - - OpenAPI spec version: 1.28.1 - Contact: dev@nifi.apache.org - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - - -from pprint import pformat -import re - - -class AccessStatusDTO(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 = { - 'identity': 'str', - 'status': 'str', - 'message': 'str' - } - - attribute_map = { - 'identity': 'identity', - 'status': 'status', - 'message': 'message' - } - - def __init__(self, identity=None, status=None, message=None): - """ - AccessStatusDTO - a model defined in Swagger - """ - - self._identity = None - self._status = None - self._message = None - - if identity is not None: - self.identity = identity - if status is not None: - self.status = status - if message is not None: - self.message = message - - @property - def identity(self): - """ - Gets the identity of this AccessStatusDTO. - The user identity. - - :return: The identity of this AccessStatusDTO. - :rtype: str - """ - return self._identity - - @identity.setter - def identity(self, identity): - """ - Sets the identity of this AccessStatusDTO. - The user identity. - - :param identity: The identity of this AccessStatusDTO. - :type: str - """ - - self._identity = identity - - @property - def status(self): - """ - Gets the status of this AccessStatusDTO. - The user access status. - - :return: The status of this AccessStatusDTO. - :rtype: str - """ - return self._status - - @status.setter - def status(self, status): - """ - Sets the status of this AccessStatusDTO. - The user access status. - - :param status: The status of this AccessStatusDTO. - :type: str - """ - - self._status = status - - @property - def message(self): - """ - Gets the message of this AccessStatusDTO. - Additional details about the user access status. - - :return: The message of this AccessStatusDTO. - :rtype: str - """ - return self._message - - @message.setter - def message(self, message): - """ - Sets the message of this AccessStatusDTO. - Additional details about the user access status. - - :param message: The message of this AccessStatusDTO. - :type: str - """ - - self._message = message - - 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, AccessStatusDTO): - 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/access_token_expiration_dto.py b/nipyapi/nifi/models/access_token_body.py similarity index 59% rename from nipyapi/nifi/models/access_token_expiration_dto.py rename to nipyapi/nifi/models/access_token_body.py index 0cb748d9..45864b3b 100644 --- a/nipyapi/nifi/models/access_token_expiration_dto.py +++ b/nipyapi/nifi/models/access_token_body.py @@ -1,19 +1,18 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re -class AccessTokenExpirationDTO(object): +class AccessTokenBody(object): """ NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually. @@ -28,45 +27,67 @@ class AccessTokenExpirationDTO(object): and the value is json key in definition. """ swagger_types = { - 'expiration': 'str' - } + 'password': 'str', +'username': 'str' } attribute_map = { - 'expiration': 'expiration' - } + 'password': 'password', +'username': 'username' } - def __init__(self, expiration=None): + def __init__(self, password=None, username=None): """ - AccessTokenExpirationDTO - a model defined in Swagger + AccessTokenBody - a model defined in Swagger """ - self._expiration = None + self._password = None + self._username = None + + if password is not None: + self.password = password + if username is not None: + self.username = username + + @property + def password(self): + """ + Gets the password of this AccessTokenBody. + + :return: The password of this AccessTokenBody. + :rtype: str + """ + return self._password + + @password.setter + def password(self, password): + """ + Sets the password of this AccessTokenBody. + + :param password: The password of this AccessTokenBody. + :type: str + """ - if expiration is not None: - self.expiration = expiration + self._password = password @property - def expiration(self): + def username(self): """ - Gets the expiration of this AccessTokenExpirationDTO. - Token Expiration + Gets the username of this AccessTokenBody. - :return: The expiration of this AccessTokenExpirationDTO. + :return: The username of this AccessTokenBody. :rtype: str """ - return self._expiration + return self._username - @expiration.setter - def expiration(self, expiration): + @username.setter + def username(self, username): """ - Sets the expiration of this AccessTokenExpirationDTO. - Token Expiration + Sets the username of this AccessTokenBody. - :param expiration: The expiration of this AccessTokenExpirationDTO. + :param username: The username of this AccessTokenBody. :type: str """ - self._expiration = expiration + self._username = username def to_dict(self): """ @@ -110,7 +131,7 @@ def __eq__(self, other): """ Returns true if both objects are equal """ - if not isinstance(other, AccessTokenExpirationDTO): + if not isinstance(other, AccessTokenBody): return False return self.__dict__ == other.__dict__ diff --git a/nipyapi/nifi/models/action_details_dto.py b/nipyapi/nifi/models/action_details_dto.py index 94e10829..b9881b84 100644 --- a/nipyapi/nifi/models/action_details_dto.py +++ b/nipyapi/nifi/models/action_details_dto.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,12 +27,10 @@ class ActionDetailsDTO(object): and the value is json key in definition. """ swagger_types = { - - } + } attribute_map = { - - } + } def __init__(self): """ diff --git a/nipyapi/nifi/models/action_dto.py b/nipyapi/nifi/models/action_dto.py index e2a2d075..1202fb98 100644 --- a/nipyapi/nifi/models/action_dto.py +++ b/nipyapi/nifi/models/action_dto.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,62 +27,102 @@ class ActionDTO(object): and the value is json key in definition. """ swagger_types = { - 'id': 'int', - 'user_identity': 'str', - 'timestamp': 'str', - 'source_id': 'str', - 'source_name': 'str', - 'source_type': 'str', - 'component_details': 'ComponentDetailsDTO', - 'operation': 'str', - 'action_details': 'ActionDetailsDTO' - } + 'action_details': 'ActionDetailsDTO', +'component_details': 'ComponentDetailsDTO', +'id': 'int', +'operation': 'str', +'source_id': 'str', +'source_name': 'str', +'source_type': 'str', +'timestamp': 'str', +'user_identity': 'str' } attribute_map = { - 'id': 'id', - 'user_identity': 'userIdentity', - 'timestamp': 'timestamp', - 'source_id': 'sourceId', - 'source_name': 'sourceName', - 'source_type': 'sourceType', - 'component_details': 'componentDetails', - 'operation': 'operation', - 'action_details': 'actionDetails' - } - - def __init__(self, id=None, user_identity=None, timestamp=None, source_id=None, source_name=None, source_type=None, component_details=None, operation=None, action_details=None): + 'action_details': 'actionDetails', +'component_details': 'componentDetails', +'id': 'id', +'operation': 'operation', +'source_id': 'sourceId', +'source_name': 'sourceName', +'source_type': 'sourceType', +'timestamp': 'timestamp', +'user_identity': 'userIdentity' } + + def __init__(self, action_details=None, component_details=None, id=None, operation=None, source_id=None, source_name=None, source_type=None, timestamp=None, user_identity=None): """ ActionDTO - a model defined in Swagger """ + self._action_details = None + self._component_details = None self._id = None - self._user_identity = None - self._timestamp = None + self._operation = None self._source_id = None self._source_name = None self._source_type = None - self._component_details = None - self._operation = None - self._action_details = None + self._timestamp = None + self._user_identity = None + if action_details is not None: + self.action_details = action_details + if component_details is not None: + self.component_details = component_details if id is not None: self.id = id - if user_identity is not None: - self.user_identity = user_identity - if timestamp is not None: - self.timestamp = timestamp + if operation is not None: + self.operation = operation if source_id is not None: self.source_id = source_id if source_name is not None: self.source_name = source_name if source_type is not None: self.source_type = source_type - if component_details is not None: - self.component_details = component_details - if operation is not None: - self.operation = operation - if action_details is not None: - self.action_details = action_details + if timestamp is not None: + self.timestamp = timestamp + if user_identity is not None: + self.user_identity = user_identity + + @property + def action_details(self): + """ + Gets the action_details of this ActionDTO. + + :return: The action_details of this ActionDTO. + :rtype: ActionDetailsDTO + """ + return self._action_details + + @action_details.setter + def action_details(self, action_details): + """ + Sets the action_details of this ActionDTO. + + :param action_details: The action_details of this ActionDTO. + :type: ActionDetailsDTO + """ + + self._action_details = action_details + + @property + def component_details(self): + """ + Gets the component_details of this ActionDTO. + + :return: The component_details of this ActionDTO. + :rtype: ComponentDetailsDTO + """ + return self._component_details + + @component_details.setter + def component_details(self, component_details): + """ + Sets the component_details of this ActionDTO. + + :param component_details: The component_details of this ActionDTO. + :type: ComponentDetailsDTO + """ + + self._component_details = component_details @property def id(self): @@ -109,50 +148,27 @@ def id(self, id): self._id = id @property - def user_identity(self): - """ - Gets the user_identity of this ActionDTO. - The identity of the user that performed the action. - - :return: The user_identity of this ActionDTO. - :rtype: str - """ - return self._user_identity - - @user_identity.setter - def user_identity(self, user_identity): - """ - Sets the user_identity of this ActionDTO. - The identity of the user that performed the action. - - :param user_identity: The user_identity of this ActionDTO. - :type: str - """ - - self._user_identity = user_identity - - @property - def timestamp(self): + def operation(self): """ - Gets the timestamp of this ActionDTO. - The timestamp of the action. + Gets the operation of this ActionDTO. + The operation that was performed. - :return: The timestamp of this ActionDTO. + :return: The operation of this ActionDTO. :rtype: str """ - return self._timestamp + return self._operation - @timestamp.setter - def timestamp(self, timestamp): + @operation.setter + def operation(self, operation): """ - Sets the timestamp of this ActionDTO. - The timestamp of the action. + Sets the operation of this ActionDTO. + The operation that was performed. - :param timestamp: The timestamp of this ActionDTO. + :param operation: The operation of this ActionDTO. :type: str """ - self._timestamp = timestamp + self._operation = operation @property def source_id(self): @@ -224,73 +240,50 @@ def source_type(self, source_type): self._source_type = source_type @property - def component_details(self): - """ - Gets the component_details of this ActionDTO. - The details of the source component. - - :return: The component_details of this ActionDTO. - :rtype: ComponentDetailsDTO - """ - return self._component_details - - @component_details.setter - def component_details(self, component_details): - """ - Sets the component_details of this ActionDTO. - The details of the source component. - - :param component_details: The component_details of this ActionDTO. - :type: ComponentDetailsDTO - """ - - self._component_details = component_details - - @property - def operation(self): + def timestamp(self): """ - Gets the operation of this ActionDTO. - The operation that was performed. + Gets the timestamp of this ActionDTO. + The timestamp of the action. - :return: The operation of this ActionDTO. + :return: The timestamp of this ActionDTO. :rtype: str """ - return self._operation + return self._timestamp - @operation.setter - def operation(self, operation): + @timestamp.setter + def timestamp(self, timestamp): """ - Sets the operation of this ActionDTO. - The operation that was performed. + Sets the timestamp of this ActionDTO. + The timestamp of the action. - :param operation: The operation of this ActionDTO. + :param timestamp: The timestamp of this ActionDTO. :type: str """ - self._operation = operation + self._timestamp = timestamp @property - def action_details(self): + def user_identity(self): """ - Gets the action_details of this ActionDTO. - The details of the action. + Gets the user_identity of this ActionDTO. + The identity of the user that performed the action. - :return: The action_details of this ActionDTO. - :rtype: ActionDetailsDTO + :return: The user_identity of this ActionDTO. + :rtype: str """ - return self._action_details + return self._user_identity - @action_details.setter - def action_details(self, action_details): + @user_identity.setter + def user_identity(self, user_identity): """ - Sets the action_details of this ActionDTO. - The details of the action. + Sets the user_identity of this ActionDTO. + The identity of the user that performed the action. - :param action_details: The action_details of this ActionDTO. - :type: ActionDetailsDTO + :param user_identity: The user_identity of this ActionDTO. + :type: str """ - self._action_details = action_details + self._user_identity = user_identity def to_dict(self): """ diff --git a/nipyapi/nifi/models/action_entity.py b/nipyapi/nifi/models/action_entity.py index be42ab50..5d3928fc 100644 --- a/nipyapi/nifi/models/action_entity.py +++ b/nipyapi/nifi/models/action_entity.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,42 +27,84 @@ class ActionEntity(object): and the value is json key in definition. """ swagger_types = { - 'id': 'int', - 'timestamp': 'str', - 'source_id': 'str', - 'can_read': 'bool', - 'action': 'ActionDTO' - } + 'action': 'ActionDTO', +'can_read': 'bool', +'id': 'int', +'source_id': 'str', +'timestamp': 'str' } attribute_map = { - 'id': 'id', - 'timestamp': 'timestamp', - 'source_id': 'sourceId', - 'can_read': 'canRead', - 'action': 'action' - } + 'action': 'action', +'can_read': 'canRead', +'id': 'id', +'source_id': 'sourceId', +'timestamp': 'timestamp' } - def __init__(self, id=None, timestamp=None, source_id=None, can_read=None, action=None): + def __init__(self, action=None, can_read=None, id=None, source_id=None, timestamp=None): """ ActionEntity - a model defined in Swagger """ + self._action = None + self._can_read = None self._id = None - self._timestamp = None self._source_id = None - self._can_read = None - self._action = None + self._timestamp = None + if action is not None: + self.action = action + if can_read is not None: + self.can_read = can_read if id is not None: self.id = id - if timestamp is not None: - self.timestamp = timestamp if source_id is not None: self.source_id = source_id - if can_read is not None: - self.can_read = can_read - if action is not None: - self.action = action + if timestamp is not None: + self.timestamp = timestamp + + @property + def action(self): + """ + Gets the action of this ActionEntity. + + :return: The action of this ActionEntity. + :rtype: ActionDTO + """ + return self._action + + @action.setter + def action(self, action): + """ + Sets the action of this ActionEntity. + + :param action: The action of this ActionEntity. + :type: ActionDTO + """ + + self._action = action + + @property + def can_read(self): + """ + Gets the can_read of this ActionEntity. + Indicates whether the user can read a given resource. + + :return: The can_read of this ActionEntity. + :rtype: bool + """ + return self._can_read + + @can_read.setter + def can_read(self, can_read): + """ + Sets the can_read of this ActionEntity. + Indicates whether the user can read a given resource. + + :param can_read: The can_read of this ActionEntity. + :type: bool + """ + + self._can_read = can_read @property def id(self): @@ -86,29 +127,6 @@ def id(self, id): self._id = id - @property - def timestamp(self): - """ - Gets the timestamp of this ActionEntity. - The timestamp of the action. - - :return: The timestamp of this ActionEntity. - :rtype: str - """ - return self._timestamp - - @timestamp.setter - def timestamp(self, timestamp): - """ - Sets the timestamp of this ActionEntity. - The timestamp of the action. - - :param timestamp: The timestamp of this ActionEntity. - :type: str - """ - - self._timestamp = timestamp - @property def source_id(self): """ @@ -131,48 +149,27 @@ def source_id(self, source_id): self._source_id = source_id @property - def can_read(self): - """ - Gets the can_read of this ActionEntity. - Indicates whether the user can read a given resource. - - :return: The can_read of this ActionEntity. - :rtype: bool - """ - return self._can_read - - @can_read.setter - def can_read(self, can_read): - """ - Sets the can_read of this ActionEntity. - Indicates whether the user can read a given resource. - - :param can_read: The can_read of this ActionEntity. - :type: bool - """ - - self._can_read = can_read - - @property - def action(self): + def timestamp(self): """ - Gets the action of this ActionEntity. + Gets the timestamp of this ActionEntity. + The timestamp of the action. - :return: The action of this ActionEntity. - :rtype: ActionDTO + :return: The timestamp of this ActionEntity. + :rtype: str """ - return self._action + return self._timestamp - @action.setter - def action(self, action): + @timestamp.setter + def timestamp(self, timestamp): """ - Sets the action of this ActionEntity. + Sets the timestamp of this ActionEntity. + The timestamp of the action. - :param action: The action of this ActionEntity. - :type: ActionDTO + :param timestamp: The timestamp of this ActionEntity. + :type: str """ - self._action = action + self._timestamp = timestamp def to_dict(self): """ diff --git a/nipyapi/nifi/models/activate_controller_services_entity.py b/nipyapi/nifi/models/activate_controller_services_entity.py index 99b5fe46..45c6b0a0 100644 --- a/nipyapi/nifi/models/activate_controller_services_entity.py +++ b/nipyapi/nifi/models/activate_controller_services_entity.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,37 +27,81 @@ class ActivateControllerServicesEntity(object): and the value is json key in definition. """ swagger_types = { - 'id': 'str', - 'state': 'str', 'components': 'dict(str, RevisionDTO)', - 'disconnected_node_acknowledged': 'bool' - } +'disconnected_node_acknowledged': 'bool', +'id': 'str', +'state': 'str' } attribute_map = { - 'id': 'id', - 'state': 'state', 'components': 'components', - 'disconnected_node_acknowledged': 'disconnectedNodeAcknowledged' - } +'disconnected_node_acknowledged': 'disconnectedNodeAcknowledged', +'id': 'id', +'state': 'state' } - def __init__(self, id=None, state=None, components=None, disconnected_node_acknowledged=None): + def __init__(self, components=None, disconnected_node_acknowledged=None, id=None, state=None): """ ActivateControllerServicesEntity - a model defined in Swagger """ - self._id = None - self._state = None self._components = None self._disconnected_node_acknowledged = None + self._id = None + self._state = None - if id is not None: - self.id = id - if state is not None: - self.state = state if components is not None: self.components = components if disconnected_node_acknowledged is not None: self.disconnected_node_acknowledged = disconnected_node_acknowledged + if id is not None: + self.id = id + if state is not None: + self.state = state + + @property + def components(self): + """ + Gets the components of this ActivateControllerServicesEntity. + Optional services to schedule. If not specified, all authorized descendant controller services will be used. + + :return: The components of this ActivateControllerServicesEntity. + :rtype: dict(str, RevisionDTO) + """ + return self._components + + @components.setter + def components(self, components): + """ + Sets the components of this ActivateControllerServicesEntity. + Optional services to schedule. If not specified, all authorized descendant controller services will be used. + + :param components: The components of this ActivateControllerServicesEntity. + :type: dict(str, RevisionDTO) + """ + + self._components = components + + @property + def disconnected_node_acknowledged(self): + """ + Gets the disconnected_node_acknowledged of this ActivateControllerServicesEntity. + Acknowledges that this node is disconnected to allow for mutable requests to proceed. + + :return: The disconnected_node_acknowledged of this ActivateControllerServicesEntity. + :rtype: bool + """ + return self._disconnected_node_acknowledged + + @disconnected_node_acknowledged.setter + def disconnected_node_acknowledged(self, disconnected_node_acknowledged): + """ + Sets the disconnected_node_acknowledged of this ActivateControllerServicesEntity. + Acknowledges that this node is disconnected to allow for mutable requests to proceed. + + :param disconnected_node_acknowledged: The disconnected_node_acknowledged of this ActivateControllerServicesEntity. + :type: bool + """ + + self._disconnected_node_acknowledged = disconnected_node_acknowledged @property def id(self): @@ -103,7 +146,7 @@ def state(self, state): :param state: The state of this ActivateControllerServicesEntity. :type: str """ - allowed_values = ["ENABLED", "DISABLED"] + allowed_values = ["ENABLED", "DISABLED", ] if state not in allowed_values: raise ValueError( "Invalid value for `state` ({0}), must be one of {1}" @@ -112,52 +155,6 @@ def state(self, state): self._state = state - @property - def components(self): - """ - Gets the components of this ActivateControllerServicesEntity. - Optional services to schedule. If not specified, all authorized descendant controller services will be used. - - :return: The components of this ActivateControllerServicesEntity. - :rtype: dict(str, RevisionDTO) - """ - return self._components - - @components.setter - def components(self, components): - """ - Sets the components of this ActivateControllerServicesEntity. - Optional services to schedule. If not specified, all authorized descendant controller services will be used. - - :param components: The components of this ActivateControllerServicesEntity. - :type: dict(str, RevisionDTO) - """ - - self._components = components - - @property - def disconnected_node_acknowledged(self): - """ - Gets the disconnected_node_acknowledged of this ActivateControllerServicesEntity. - Acknowledges that this node is disconnected to allow for mutable requests to proceed. - - :return: The disconnected_node_acknowledged of this ActivateControllerServicesEntity. - :rtype: bool - """ - return self._disconnected_node_acknowledged - - @disconnected_node_acknowledged.setter - def disconnected_node_acknowledged(self, disconnected_node_acknowledged): - """ - Sets the disconnected_node_acknowledged of this ActivateControllerServicesEntity. - Acknowledges that this node is disconnected to allow for mutable requests to proceed. - - :param disconnected_node_acknowledged: The disconnected_node_acknowledged of this ActivateControllerServicesEntity. - :type: bool - """ - - self._disconnected_node_acknowledged = disconnected_node_acknowledged - def to_dict(self): """ Returns the model properties as a dict diff --git a/nipyapi/nifi/models/additional_details_entity.py b/nipyapi/nifi/models/additional_details_entity.py new file mode 100644 index 00000000..af873c72 --- /dev/null +++ b/nipyapi/nifi/models/additional_details_entity.py @@ -0,0 +1,117 @@ +""" + Apache NiFi REST API + + REST API definition for Apache NiFi web services + + OpenAPI spec version: 2.5.0 + Contact: dev@nifi.apache.org + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from pprint import pformat +import re + + +class AdditionalDetailsEntity(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 = { + 'additional_details': 'str' } + + attribute_map = { + 'additional_details': 'additionalDetails' } + + def __init__(self, additional_details=None): + """ + AdditionalDetailsEntity - a model defined in Swagger + """ + + self._additional_details = None + + if additional_details is not None: + self.additional_details = additional_details + + @property + def additional_details(self): + """ + Gets the additional_details of this AdditionalDetailsEntity. + + :return: The additional_details of this AdditionalDetailsEntity. + :rtype: str + """ + return self._additional_details + + @additional_details.setter + def additional_details(self, additional_details): + """ + Sets the additional_details of this AdditionalDetailsEntity. + + :param additional_details: The additional_details of this AdditionalDetailsEntity. + :type: str + """ + + self._additional_details = additional_details + + 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, AdditionalDetailsEntity): + 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/affected_component_dto.py b/nipyapi/nifi/models/affected_component_dto.py index f4e2a78b..45ba174f 100644 --- a/nipyapi/nifi/models/affected_component_dto.py +++ b/nipyapi/nifi/models/affected_component_dto.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,75 +27,73 @@ class AffectedComponentDTO(object): and the value is json key in definition. """ swagger_types = { - 'process_group_id': 'str', - 'id': 'str', - 'reference_type': 'str', - 'name': 'str', - 'state': 'str', 'active_thread_count': 'int', - 'validation_errors': 'list[str]' - } +'id': 'str', +'name': 'str', +'process_group_id': 'str', +'reference_type': 'str', +'state': 'str', +'validation_errors': 'list[str]' } attribute_map = { - 'process_group_id': 'processGroupId', - 'id': 'id', - 'reference_type': 'referenceType', - 'name': 'name', - 'state': 'state', 'active_thread_count': 'activeThreadCount', - 'validation_errors': 'validationErrors' - } +'id': 'id', +'name': 'name', +'process_group_id': 'processGroupId', +'reference_type': 'referenceType', +'state': 'state', +'validation_errors': 'validationErrors' } - def __init__(self, process_group_id=None, id=None, reference_type=None, name=None, state=None, active_thread_count=None, validation_errors=None): + def __init__(self, active_thread_count=None, id=None, name=None, process_group_id=None, reference_type=None, state=None, validation_errors=None): """ AffectedComponentDTO - a model defined in Swagger """ - self._process_group_id = None + self._active_thread_count = None self._id = None - self._reference_type = None self._name = None + self._process_group_id = None + self._reference_type = None self._state = None - self._active_thread_count = None self._validation_errors = None - if process_group_id is not None: - self.process_group_id = process_group_id + if active_thread_count is not None: + self.active_thread_count = active_thread_count if id is not None: self.id = id - if reference_type is not None: - self.reference_type = reference_type if name is not None: self.name = name + if process_group_id is not None: + self.process_group_id = process_group_id + if reference_type is not None: + self.reference_type = reference_type if state is not None: self.state = state - if active_thread_count is not None: - self.active_thread_count = active_thread_count if validation_errors is not None: self.validation_errors = validation_errors @property - def process_group_id(self): + def active_thread_count(self): """ - Gets the process_group_id of this AffectedComponentDTO. - The UUID of the Process Group that this component is in + Gets the active_thread_count of this AffectedComponentDTO. + The number of active threads for the referencing component. - :return: The process_group_id of this AffectedComponentDTO. - :rtype: str + :return: The active_thread_count of this AffectedComponentDTO. + :rtype: int """ - return self._process_group_id + return self._active_thread_count - @process_group_id.setter - def process_group_id(self, process_group_id): + @active_thread_count.setter + def active_thread_count(self, active_thread_count): """ - Sets the process_group_id of this AffectedComponentDTO. - The UUID of the Process Group that this component is in + Sets the active_thread_count of this AffectedComponentDTO. + The number of active threads for the referencing component. - :param process_group_id: The process_group_id of this AffectedComponentDTO. - :type: str + :param active_thread_count: The active_thread_count of this AffectedComponentDTO. + :type: int """ - self._process_group_id = process_group_id + self._active_thread_count = active_thread_count @property def id(self): @@ -121,6 +118,52 @@ def id(self, id): self._id = id + @property + def name(self): + """ + Gets the name of this AffectedComponentDTO. + The name of this component. + + :return: The name of this AffectedComponentDTO. + :rtype: str + """ + return self._name + + @name.setter + def name(self, name): + """ + Sets the name of this AffectedComponentDTO. + The name of this component. + + :param name: The name of this AffectedComponentDTO. + :type: str + """ + + self._name = name + + @property + def process_group_id(self): + """ + Gets the process_group_id of this AffectedComponentDTO. + The UUID of the Process Group that this component is in + + :return: The process_group_id of this AffectedComponentDTO. + :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 AffectedComponentDTO. + The UUID of the Process Group that this component is in + + :param process_group_id: The process_group_id of this AffectedComponentDTO. + :type: str + """ + + self._process_group_id = process_group_id + @property def reference_type(self): """ @@ -141,7 +184,7 @@ 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"] + 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}" @@ -150,29 +193,6 @@ def reference_type(self, reference_type): self._reference_type = reference_type - @property - def name(self): - """ - Gets the name of this AffectedComponentDTO. - The name of this component. - - :return: The name of this AffectedComponentDTO. - :rtype: str - """ - return self._name - - @name.setter - def name(self, name): - """ - Sets the name of this AffectedComponentDTO. - The name of this component. - - :param name: The name of this AffectedComponentDTO. - :type: str - """ - - self._name = name - @property def state(self): """ @@ -196,29 +216,6 @@ def state(self, state): self._state = state - @property - def active_thread_count(self): - """ - Gets the active_thread_count of this AffectedComponentDTO. - The number of active threads for the referencing component. - - :return: The active_thread_count of this AffectedComponentDTO. - :rtype: int - """ - return self._active_thread_count - - @active_thread_count.setter - def active_thread_count(self, active_thread_count): - """ - Sets the active_thread_count of this AffectedComponentDTO. - The number of active threads for the referencing component. - - :param active_thread_count: The active_thread_count of this AffectedComponentDTO. - :type: int - """ - - self._active_thread_count = active_thread_count - @property def validation_errors(self): """ diff --git a/nipyapi/nifi/models/affected_component_entity.py b/nipyapi/nifi/models/affected_component_entity.py index 411a2a77..25efafe5 100644 --- a/nipyapi/nifi/models/affected_component_entity.py +++ b/nipyapi/nifi/models/affected_component_entity.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,165 +27,160 @@ class AffectedComponentEntity(object): and the value is json key in definition. """ swagger_types = { - 'revision': 'RevisionDTO', - 'id': 'str', - 'uri': 'str', - 'position': 'PositionDTO', - 'permissions': 'PermissionsDTO', 'bulletins': 'list[BulletinEntity]', - 'disconnected_node_acknowledged': 'bool', - 'component': 'AffectedComponentDTO', - 'process_group': 'ProcessGroupNameDTO', - 'reference_type': 'str' - } +'component': 'AffectedComponentDTO', +'disconnected_node_acknowledged': 'bool', +'id': 'str', +'permissions': 'PermissionsDTO', +'position': 'PositionDTO', +'process_group': 'ProcessGroupNameDTO', +'reference_type': 'str', +'revision': 'RevisionDTO', +'uri': 'str' } attribute_map = { - 'revision': 'revision', - 'id': 'id', - 'uri': 'uri', - 'position': 'position', - 'permissions': 'permissions', 'bulletins': 'bulletins', - 'disconnected_node_acknowledged': 'disconnectedNodeAcknowledged', - 'component': 'component', - 'process_group': 'processGroup', - 'reference_type': 'referenceType' - } - - def __init__(self, revision=None, id=None, uri=None, position=None, permissions=None, bulletins=None, disconnected_node_acknowledged=None, component=None, process_group=None, reference_type=None): +'component': 'component', +'disconnected_node_acknowledged': 'disconnectedNodeAcknowledged', +'id': 'id', +'permissions': 'permissions', +'position': 'position', +'process_group': 'processGroup', +'reference_type': 'referenceType', +'revision': 'revision', +'uri': 'uri' } + + def __init__(self, bulletins=None, component=None, disconnected_node_acknowledged=None, id=None, permissions=None, position=None, process_group=None, reference_type=None, revision=None, uri=None): """ AffectedComponentEntity - a model defined in Swagger """ - self._revision = None - self._id = None - self._uri = None - self._position = None - self._permissions = None self._bulletins = None - self._disconnected_node_acknowledged = None self._component = None + self._disconnected_node_acknowledged = None + self._id = None + self._permissions = None + self._position = None self._process_group = None self._reference_type = None + self._revision = None + self._uri = None - if revision is not None: - self.revision = revision - if id is not None: - self.id = id - if uri is not None: - self.uri = uri - if position is not None: - self.position = position - if permissions is not None: - self.permissions = permissions if bulletins is not None: self.bulletins = bulletins - if disconnected_node_acknowledged is not None: - self.disconnected_node_acknowledged = disconnected_node_acknowledged if component is not None: self.component = component + if disconnected_node_acknowledged is not None: + self.disconnected_node_acknowledged = disconnected_node_acknowledged + if id is not None: + self.id = id + if permissions is not None: + self.permissions = permissions + if position is not None: + self.position = position if process_group is not None: self.process_group = process_group if reference_type is not None: self.reference_type = reference_type + if revision is not None: + self.revision = revision + if uri is not None: + self.uri = uri @property - def revision(self): + def bulletins(self): """ - Gets the revision of this AffectedComponentEntity. - The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses. + Gets the bulletins of this AffectedComponentEntity. + The bulletins for this component. - :return: The revision of this AffectedComponentEntity. - :rtype: RevisionDTO + :return: The bulletins of this AffectedComponentEntity. + :rtype: list[BulletinEntity] """ - return self._revision + return self._bulletins - @revision.setter - def revision(self, revision): + @bulletins.setter + def bulletins(self, bulletins): """ - Sets the revision of this AffectedComponentEntity. - The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses. + Sets the bulletins of this AffectedComponentEntity. + The bulletins for this component. - :param revision: The revision of this AffectedComponentEntity. - :type: RevisionDTO + :param bulletins: The bulletins of this AffectedComponentEntity. + :type: list[BulletinEntity] """ - self._revision = revision + self._bulletins = bulletins @property - def id(self): + def component(self): """ - Gets the id of this AffectedComponentEntity. - The id of the component. + Gets the component of this AffectedComponentEntity. - :return: The id of this AffectedComponentEntity. - :rtype: str + :return: The component of this AffectedComponentEntity. + :rtype: AffectedComponentDTO """ - return self._id + return self._component - @id.setter - def id(self, id): + @component.setter + def component(self, component): """ - Sets the id of this AffectedComponentEntity. - The id of the component. + Sets the component of this AffectedComponentEntity. - :param id: The id of this AffectedComponentEntity. - :type: str + :param component: The component of this AffectedComponentEntity. + :type: AffectedComponentDTO """ - self._id = id + self._component = component @property - def uri(self): + def disconnected_node_acknowledged(self): """ - Gets the uri of this AffectedComponentEntity. - The URI for futures requests to the component. + Gets the disconnected_node_acknowledged of this AffectedComponentEntity. + Acknowledges that this node is disconnected to allow for mutable requests to proceed. - :return: The uri of this AffectedComponentEntity. - :rtype: str + :return: The disconnected_node_acknowledged of this AffectedComponentEntity. + :rtype: bool """ - return self._uri + return self._disconnected_node_acknowledged - @uri.setter - def uri(self, uri): + @disconnected_node_acknowledged.setter + def disconnected_node_acknowledged(self, disconnected_node_acknowledged): """ - Sets the uri of this AffectedComponentEntity. - The URI for futures requests to the component. + Sets the disconnected_node_acknowledged of this AffectedComponentEntity. + Acknowledges that this node is disconnected to allow for mutable requests to proceed. - :param uri: The uri of this AffectedComponentEntity. - :type: str + :param disconnected_node_acknowledged: The disconnected_node_acknowledged of this AffectedComponentEntity. + :type: bool """ - self._uri = uri + self._disconnected_node_acknowledged = disconnected_node_acknowledged @property - def position(self): + def id(self): """ - Gets the position of this AffectedComponentEntity. - The position of this component in the UI if applicable. + Gets the id of this AffectedComponentEntity. + The id of the component. - :return: The position of this AffectedComponentEntity. - :rtype: PositionDTO + :return: The id of this AffectedComponentEntity. + :rtype: str """ - return self._position + return self._id - @position.setter - def position(self, position): + @id.setter + def id(self, id): """ - Sets the position of this AffectedComponentEntity. - The position of this component in the UI if applicable. + Sets the id of this AffectedComponentEntity. + The id of the component. - :param position: The position of this AffectedComponentEntity. - :type: PositionDTO + :param id: The id of this AffectedComponentEntity. + :type: str """ - self._position = position + self._id = id @property def permissions(self): """ Gets the permissions of this AffectedComponentEntity. - The permissions for this component. :return: The permissions of this AffectedComponentEntity. :rtype: PermissionsDTO @@ -197,7 +191,6 @@ def permissions(self): def permissions(self, permissions): """ Sets the permissions of this AffectedComponentEntity. - The permissions for this component. :param permissions: The permissions of this AffectedComponentEntity. :type: PermissionsDTO @@ -206,77 +199,30 @@ def permissions(self, permissions): self._permissions = permissions @property - def bulletins(self): - """ - Gets the bulletins of this AffectedComponentEntity. - The bulletins for this component. - - :return: The bulletins of this AffectedComponentEntity. - :rtype: list[BulletinEntity] - """ - return self._bulletins - - @bulletins.setter - def bulletins(self, bulletins): - """ - Sets the bulletins of this AffectedComponentEntity. - The bulletins for this component. - - :param bulletins: The bulletins of this AffectedComponentEntity. - :type: list[BulletinEntity] - """ - - self._bulletins = bulletins - - @property - def disconnected_node_acknowledged(self): - """ - Gets the disconnected_node_acknowledged of this AffectedComponentEntity. - Acknowledges that this node is disconnected to allow for mutable requests to proceed. - - :return: The disconnected_node_acknowledged of this AffectedComponentEntity. - :rtype: bool - """ - return self._disconnected_node_acknowledged - - @disconnected_node_acknowledged.setter - def disconnected_node_acknowledged(self, disconnected_node_acknowledged): - """ - Sets the disconnected_node_acknowledged of this AffectedComponentEntity. - Acknowledges that this node is disconnected to allow for mutable requests to proceed. - - :param disconnected_node_acknowledged: The disconnected_node_acknowledged of this AffectedComponentEntity. - :type: bool - """ - - self._disconnected_node_acknowledged = disconnected_node_acknowledged - - @property - def component(self): + def position(self): """ - Gets the component of this AffectedComponentEntity. + Gets the position of this AffectedComponentEntity. - :return: The component of this AffectedComponentEntity. - :rtype: AffectedComponentDTO + :return: The position of this AffectedComponentEntity. + :rtype: PositionDTO """ - return self._component + return self._position - @component.setter - def component(self, component): + @position.setter + def position(self, position): """ - Sets the component of this AffectedComponentEntity. + Sets the position of this AffectedComponentEntity. - :param component: The component of this AffectedComponentEntity. - :type: AffectedComponentDTO + :param position: The position of this AffectedComponentEntity. + :type: PositionDTO """ - self._component = component + self._position = position @property def process_group(self): """ Gets the process_group of this AffectedComponentEntity. - The Process Group that the component belongs to :return: The process_group of this AffectedComponentEntity. :rtype: ProcessGroupNameDTO @@ -287,7 +233,6 @@ def process_group(self): def process_group(self, process_group): """ Sets the process_group of this AffectedComponentEntity. - The Process Group that the component belongs to :param process_group: The process_group of this AffectedComponentEntity. :type: ProcessGroupNameDTO @@ -315,7 +260,7 @@ 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"] + 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}" @@ -324,6 +269,50 @@ def reference_type(self, reference_type): self._reference_type = reference_type + @property + def revision(self): + """ + Gets the revision of this AffectedComponentEntity. + + :return: The revision of this AffectedComponentEntity. + :rtype: RevisionDTO + """ + return self._revision + + @revision.setter + def revision(self, revision): + """ + Sets the revision of this AffectedComponentEntity. + + :param revision: The revision of this AffectedComponentEntity. + :type: RevisionDTO + """ + + self._revision = revision + + @property + def uri(self): + """ + Gets the uri of this AffectedComponentEntity. + The URI for futures requests to the component. + + :return: The uri of this AffectedComponentEntity. + :rtype: str + """ + return self._uri + + @uri.setter + def uri(self, uri): + """ + Sets the uri of this AffectedComponentEntity. + The URI for futures requests to the component. + + :param uri: The uri of this AffectedComponentEntity. + :type: str + """ + + self._uri = uri + def to_dict(self): """ Returns the model properties as a dict diff --git a/nipyapi/nifi/models/allowable_value_dto.py b/nipyapi/nifi/models/allowable_value_dto.py index 9642d502..9577152c 100644 --- a/nipyapi/nifi/models/allowable_value_dto.py +++ b/nipyapi/nifi/models/allowable_value_dto.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,32 +27,53 @@ class AllowableValueDTO(object): and the value is json key in definition. """ swagger_types = { - 'display_name': 'str', - 'value': 'str', - 'description': 'str' - } + 'description': 'str', +'display_name': 'str', +'value': 'str' } attribute_map = { - 'display_name': 'displayName', - 'value': 'value', - 'description': 'description' - } + 'description': 'description', +'display_name': 'displayName', +'value': 'value' } - def __init__(self, display_name=None, value=None, description=None): + def __init__(self, description=None, display_name=None, value=None): """ AllowableValueDTO - a model defined in Swagger """ + self._description = None self._display_name = None self._value = None - self._description = None + if description is not None: + self.description = description if display_name is not None: self.display_name = display_name if value is not None: self.value = value - if description is not None: - self.description = description + + @property + def description(self): + """ + Gets the description of this AllowableValueDTO. + A description for this allowable value. + + :return: The description of this AllowableValueDTO. + :rtype: str + """ + return self._description + + @description.setter + def description(self, description): + """ + Sets the description of this AllowableValueDTO. + A description for this allowable value. + + :param description: The description of this AllowableValueDTO. + :type: str + """ + + self._description = description @property def display_name(self): @@ -101,29 +121,6 @@ def value(self, value): self._value = value - @property - def description(self): - """ - Gets the description of this AllowableValueDTO. - A description for this allowable value. - - :return: The description of this AllowableValueDTO. - :rtype: str - """ - return self._description - - @description.setter - def description(self, description): - """ - Sets the description of this AllowableValueDTO. - A description for this allowable value. - - :param description: The description of this AllowableValueDTO. - :type: str - """ - - self._description = description - def to_dict(self): """ Returns the model properties as a dict diff --git a/nipyapi/nifi/models/allowable_value_entity.py b/nipyapi/nifi/models/allowable_value_entity.py index 661f7602..3e632361 100644 --- a/nipyapi/nifi/models/allowable_value_entity.py +++ b/nipyapi/nifi/models/allowable_value_entity.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -29,13 +28,11 @@ class AllowableValueEntity(object): """ swagger_types = { 'allowable_value': 'AllowableValueDTO', - 'can_read': 'bool' - } +'can_read': 'bool' } attribute_map = { 'allowable_value': 'allowableValue', - 'can_read': 'canRead' - } +'can_read': 'canRead' } def __init__(self, allowable_value=None, can_read=None): """ diff --git a/nipyapi/nifi/models/asset_dto.py b/nipyapi/nifi/models/asset_dto.py new file mode 100644 index 00000000..555f6ce8 --- /dev/null +++ b/nipyapi/nifi/models/asset_dto.py @@ -0,0 +1,203 @@ +""" + Apache NiFi REST API + + REST API definition for Apache NiFi web services + + OpenAPI spec version: 2.5.0 + Contact: dev@nifi.apache.org + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from pprint import pformat +import re + + +class AssetDTO(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 = { + 'digest': 'str', +'id': 'str', +'missing_content': 'bool', +'name': 'str' } + + attribute_map = { + 'digest': 'digest', +'id': 'id', +'missing_content': 'missingContent', +'name': 'name' } + + def __init__(self, digest=None, id=None, missing_content=None, name=None): + """ + AssetDTO - a model defined in Swagger + """ + + self._digest = None + self._id = None + self._missing_content = None + self._name = None + + if digest is not None: + self.digest = digest + if id is not None: + self.id = id + if missing_content is not None: + self.missing_content = missing_content + if name is not None: + self.name = name + + @property + def digest(self): + """ + Gets the digest of this AssetDTO. + The digest of the asset, will be null if the asset content is missing. + + :return: The digest of this AssetDTO. + :rtype: str + """ + return self._digest + + @digest.setter + def digest(self, digest): + """ + Sets the digest of this AssetDTO. + The digest of the asset, will be null if the asset content is missing. + + :param digest: The digest of this AssetDTO. + :type: str + """ + + self._digest = digest + + @property + def id(self): + """ + Gets the id of this AssetDTO. + The identifier of the asset. + + :return: The id of this AssetDTO. + :rtype: str + """ + return self._id + + @id.setter + def id(self, id): + """ + Sets the id of this AssetDTO. + The identifier of the asset. + + :param id: The id of this AssetDTO. + :type: str + """ + + self._id = id + + @property + def missing_content(self): + """ + Gets the missing_content of this AssetDTO. + Indicates if the content of the asset is missing. + + :return: The missing_content of this AssetDTO. + :rtype: bool + """ + return self._missing_content + + @missing_content.setter + def missing_content(self, missing_content): + """ + Sets the missing_content of this AssetDTO. + Indicates if the content of the asset is missing. + + :param missing_content: The missing_content of this AssetDTO. + :type: bool + """ + + self._missing_content = missing_content + + @property + def name(self): + """ + Gets the name of this AssetDTO. + The name of the asset. + + :return: The name of this AssetDTO. + :rtype: str + """ + return self._name + + @name.setter + def name(self, name): + """ + Sets the name of this AssetDTO. + The name of the asset. + + :param name: The name of this AssetDTO. + :type: str + """ + + self._name = name + + 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, AssetDTO): + 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/dto_factory.py b/nipyapi/nifi/models/asset_entity.py similarity index 70% rename from nipyapi/nifi/models/dto_factory.py rename to nipyapi/nifi/models/asset_entity.py index 854de56e..6c7aff7e 100644 --- a/nipyapi/nifi/models/dto_factory.py +++ b/nipyapi/nifi/models/asset_entity.py @@ -1,19 +1,18 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re -class DtoFactory(object): +class AssetEntity(object): """ NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually. @@ -28,19 +27,41 @@ class DtoFactory(object): and the value is json key in definition. """ swagger_types = { - - } + 'asset': 'AssetDTO' } attribute_map = { - - } + 'asset': 'asset' } + + def __init__(self, asset=None): + """ + AssetEntity - a model defined in Swagger + """ + + self._asset = None - def __init__(self): + if asset is not None: + self.asset = asset + + @property + def asset(self): """ - DtoFactory - a model defined in Swagger + Gets the asset of this AssetEntity. + + :return: The asset of this AssetEntity. + :rtype: AssetDTO """ + return self._asset + @asset.setter + def asset(self, asset): + """ + Sets the asset of this AssetEntity. + + :param asset: The asset of this AssetEntity. + :type: AssetDTO + """ + self._asset = asset def to_dict(self): """ @@ -84,7 +105,7 @@ def __eq__(self, other): """ Returns true if both objects are equal """ - if not isinstance(other, DtoFactory): + if not isinstance(other, AssetEntity): return False return self.__dict__ == other.__dict__ diff --git a/nipyapi/nifi/models/asset_reference_dto.py b/nipyapi/nifi/models/asset_reference_dto.py new file mode 100644 index 00000000..930d2cbd --- /dev/null +++ b/nipyapi/nifi/models/asset_reference_dto.py @@ -0,0 +1,147 @@ +""" + Apache NiFi REST API + + REST API definition for Apache NiFi web services + + OpenAPI spec version: 2.5.0 + Contact: dev@nifi.apache.org + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from pprint import pformat +import re + + +class AssetReferenceDTO(object): + """ + NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. + """ + + + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'id': 'str', +'name': 'str' } + + attribute_map = { + 'id': 'id', +'name': 'name' } + + def __init__(self, id=None, name=None): + """ + AssetReferenceDTO - a model defined in Swagger + """ + + self._id = None + self._name = None + + if id is not None: + self.id = id + if name is not None: + self.name = name + + @property + def id(self): + """ + Gets the id of this AssetReferenceDTO. + The identifier of the referenced asset. + + :return: The id of this AssetReferenceDTO. + :rtype: str + """ + return self._id + + @id.setter + def id(self, id): + """ + Sets the id of this AssetReferenceDTO. + The identifier of the referenced asset. + + :param id: The id of this AssetReferenceDTO. + :type: str + """ + + self._id = id + + @property + def name(self): + """ + Gets the name of this AssetReferenceDTO. + The name of the referenced asset. + + :return: The name of this AssetReferenceDTO. + :rtype: str + """ + return self._name + + @name.setter + def name(self, name): + """ + Sets the name of this AssetReferenceDTO. + The name of the referenced asset. + + :param name: The name of this AssetReferenceDTO. + :type: str + """ + + self._name = name + + 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, AssetReferenceDTO): + 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/assets_entity.py b/nipyapi/nifi/models/assets_entity.py new file mode 100644 index 00000000..e38c7b9d --- /dev/null +++ b/nipyapi/nifi/models/assets_entity.py @@ -0,0 +1,119 @@ +""" + Apache NiFi REST API + + REST API definition for Apache NiFi web services + + OpenAPI spec version: 2.5.0 + Contact: dev@nifi.apache.org + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from pprint import pformat +import re + + +class AssetsEntity(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 = { + 'assets': 'list[AssetEntity]' } + + attribute_map = { + 'assets': 'assets' } + + def __init__(self, assets=None): + """ + AssetsEntity - a model defined in Swagger + """ + + self._assets = None + + if assets is not None: + self.assets = assets + + @property + def assets(self): + """ + Gets the assets of this AssetsEntity. + The asset entities + + :return: The assets of this AssetsEntity. + :rtype: list[AssetEntity] + """ + return self._assets + + @assets.setter + def assets(self, assets): + """ + Sets the assets of this AssetsEntity. + The asset entities + + :param assets: The assets of this AssetsEntity. + :type: list[AssetEntity] + """ + + self._assets = assets + + 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, AssetsEntity): + 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/attribute.py b/nipyapi/nifi/models/attribute.py index 09cd7211..8f349411 100644 --- a/nipyapi/nifi/models/attribute.py +++ b/nipyapi/nifi/models/attribute.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,73 +27,71 @@ class Attribute(object): and the value is json key in definition. """ swagger_types = { - 'name': 'str', - 'description': 'str' - } + 'description': 'str', +'name': 'str' } attribute_map = { - 'name': 'name', - 'description': 'description' - } + 'description': 'description', +'name': 'name' } - def __init__(self, name=None, description=None): + def __init__(self, description=None, name=None): """ Attribute - a model defined in Swagger """ - self._name = None self._description = None + self._name = None - if name is not None: - self.name = name if description is not None: self.description = description + if name is not None: + self.name = name @property - def name(self): + def description(self): """ - Gets the name of this Attribute. - The name of the attribute + Gets the description of this Attribute. + The description of the attribute - :return: The name of this Attribute. + :return: The description of this Attribute. :rtype: str """ - return self._name + return self._description - @name.setter - def name(self, name): + @description.setter + def description(self, description): """ - Sets the name of this Attribute. - The name of the attribute + Sets the description of this Attribute. + The description of the attribute - :param name: The name of this Attribute. + :param description: The description of this Attribute. :type: str """ - self._name = name + self._description = description @property - def description(self): + def name(self): """ - Gets the description of this Attribute. - The description of the attribute + Gets the name of this Attribute. + The name of the attribute - :return: The description of this Attribute. + :return: The name of this Attribute. :rtype: str """ - return self._description + return self._name - @description.setter - def description(self, description): + @name.setter + def name(self, name): """ - Sets the description of this Attribute. - The description of the attribute + Sets the name of this Attribute. + The name of the attribute - :param description: The description of this Attribute. + :param name: The name of this Attribute. :type: str """ - self._description = description + self._name = name def to_dict(self): """ diff --git a/nipyapi/nifi/models/attribute_dto.py b/nipyapi/nifi/models/attribute_dto.py index b68ede9f..5a04fc4e 100644 --- a/nipyapi/nifi/models/attribute_dto.py +++ b/nipyapi/nifi/models/attribute_dto.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -29,31 +28,29 @@ class AttributeDTO(object): """ swagger_types = { 'name': 'str', - 'value': 'str', - 'previous_value': 'str' - } +'previous_value': 'str', +'value': 'str' } attribute_map = { 'name': 'name', - 'value': 'value', - 'previous_value': 'previousValue' - } +'previous_value': 'previousValue', +'value': 'value' } - def __init__(self, name=None, value=None, previous_value=None): + def __init__(self, name=None, previous_value=None, value=None): """ AttributeDTO - a model defined in Swagger """ self._name = None - self._value = None self._previous_value = None + self._value = None if name is not None: self.name = name - if value is not None: - self.value = value if previous_value is not None: self.previous_value = previous_value + if value is not None: + self.value = value @property def name(self): @@ -79,50 +76,50 @@ def name(self, name): self._name = name @property - def value(self): + def previous_value(self): """ - Gets the value of this AttributeDTO. - The attribute value. + Gets the previous_value of this AttributeDTO. + The value of the attribute before the event took place. - :return: The value of this AttributeDTO. + :return: The previous_value of this AttributeDTO. :rtype: str """ - return self._value + return self._previous_value - @value.setter - def value(self, value): + @previous_value.setter + def previous_value(self, previous_value): """ - Sets the value of this AttributeDTO. - The attribute value. + Sets the previous_value of this AttributeDTO. + The value of the attribute before the event took place. - :param value: The value of this AttributeDTO. + :param previous_value: The previous_value of this AttributeDTO. :type: str """ - self._value = value + self._previous_value = previous_value @property - def previous_value(self): + def value(self): """ - Gets the previous_value of this AttributeDTO. - The value of the attribute before the event took place. + Gets the value of this AttributeDTO. + The attribute value. - :return: The previous_value of this AttributeDTO. + :return: The value of this AttributeDTO. :rtype: str """ - return self._previous_value + return self._value - @previous_value.setter - def previous_value(self, previous_value): + @value.setter + def value(self, value): """ - Sets the previous_value of this AttributeDTO. - The value of the attribute before the event took place. + Sets the value of this AttributeDTO. + The attribute value. - :param previous_value: The previous_value of this AttributeDTO. + :param value: The value of this AttributeDTO. :type: str """ - self._previous_value = previous_value + self._value = value def to_dict(self): """ diff --git a/nipyapi/nifi/models/authentication_configuration_dto.py b/nipyapi/nifi/models/authentication_configuration_dto.py new file mode 100644 index 00000000..21b3fb5b --- /dev/null +++ b/nipyapi/nifi/models/authentication_configuration_dto.py @@ -0,0 +1,203 @@ +""" + Apache NiFi REST API + + REST API definition for Apache NiFi web services + + OpenAPI spec version: 2.5.0 + Contact: dev@nifi.apache.org + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from pprint import pformat +import re + + +class AuthenticationConfigurationDTO(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 = { + 'external_login_required': 'bool', +'login_supported': 'bool', +'login_uri': 'str', +'logout_uri': 'str' } + + attribute_map = { + 'external_login_required': 'externalLoginRequired', +'login_supported': 'loginSupported', +'login_uri': 'loginUri', +'logout_uri': 'logoutUri' } + + def __init__(self, external_login_required=None, login_supported=None, login_uri=None, logout_uri=None): + """ + AuthenticationConfigurationDTO - a model defined in Swagger + """ + + self._external_login_required = None + self._login_supported = None + self._login_uri = None + self._logout_uri = None + + if external_login_required is not None: + self.external_login_required = external_login_required + if login_supported is not None: + self.login_supported = login_supported + if login_uri is not None: + self.login_uri = login_uri + if logout_uri is not None: + self.logout_uri = logout_uri + + @property + def external_login_required(self): + """ + Gets the external_login_required of this AuthenticationConfigurationDTO. + Whether the system requires login through an external Identity Provider + + :return: The external_login_required of this AuthenticationConfigurationDTO. + :rtype: bool + """ + return self._external_login_required + + @external_login_required.setter + def external_login_required(self, external_login_required): + """ + Sets the external_login_required of this AuthenticationConfigurationDTO. + Whether the system requires login through an external Identity Provider + + :param external_login_required: The external_login_required of this AuthenticationConfigurationDTO. + :type: bool + """ + + self._external_login_required = external_login_required + + @property + def login_supported(self): + """ + Gets the login_supported of this AuthenticationConfigurationDTO. + Whether the system is configured to support login operations + + :return: The login_supported of this AuthenticationConfigurationDTO. + :rtype: bool + """ + return self._login_supported + + @login_supported.setter + def login_supported(self, login_supported): + """ + Sets the login_supported of this AuthenticationConfigurationDTO. + Whether the system is configured to support login operations + + :param login_supported: The login_supported of this AuthenticationConfigurationDTO. + :type: bool + """ + + self._login_supported = login_supported + + @property + def login_uri(self): + """ + Gets the login_uri of this AuthenticationConfigurationDTO. + Location for initiating login processing + + :return: The login_uri of this AuthenticationConfigurationDTO. + :rtype: str + """ + return self._login_uri + + @login_uri.setter + def login_uri(self, login_uri): + """ + Sets the login_uri of this AuthenticationConfigurationDTO. + Location for initiating login processing + + :param login_uri: The login_uri of this AuthenticationConfigurationDTO. + :type: str + """ + + self._login_uri = login_uri + + @property + def logout_uri(self): + """ + Gets the logout_uri of this AuthenticationConfigurationDTO. + Location for initiating logout processing + + :return: The logout_uri of this AuthenticationConfigurationDTO. + :rtype: str + """ + return self._logout_uri + + @logout_uri.setter + def logout_uri(self, logout_uri): + """ + Sets the logout_uri of this AuthenticationConfigurationDTO. + Location for initiating logout processing + + :param logout_uri: The logout_uri of this AuthenticationConfigurationDTO. + :type: str + """ + + self._logout_uri = logout_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, AuthenticationConfigurationDTO): + 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/authentication_configuration_entity.py b/nipyapi/nifi/models/authentication_configuration_entity.py new file mode 100644 index 00000000..f29039b5 --- /dev/null +++ b/nipyapi/nifi/models/authentication_configuration_entity.py @@ -0,0 +1,117 @@ +""" + Apache NiFi REST API + + REST API definition for Apache NiFi web services + + OpenAPI spec version: 2.5.0 + Contact: dev@nifi.apache.org + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from pprint import pformat +import re + + +class AuthenticationConfigurationEntity(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 = { + 'authentication_configuration': 'AuthenticationConfigurationDTO' } + + attribute_map = { + 'authentication_configuration': 'authenticationConfiguration' } + + def __init__(self, authentication_configuration=None): + """ + AuthenticationConfigurationEntity - a model defined in Swagger + """ + + self._authentication_configuration = None + + if authentication_configuration is not None: + self.authentication_configuration = authentication_configuration + + @property + def authentication_configuration(self): + """ + Gets the authentication_configuration of this AuthenticationConfigurationEntity. + + :return: The authentication_configuration of this AuthenticationConfigurationEntity. + :rtype: AuthenticationConfigurationDTO + """ + return self._authentication_configuration + + @authentication_configuration.setter + def authentication_configuration(self, authentication_configuration): + """ + Sets the authentication_configuration of this AuthenticationConfigurationEntity. + + :param authentication_configuration: The authentication_configuration of this AuthenticationConfigurationEntity. + :type: AuthenticationConfigurationDTO + """ + + self._authentication_configuration = authentication_configuration + + 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, AuthenticationConfigurationEntity): + 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 2427661e..5b1e12b7 100644 --- a/nipyapi/nifi/models/banner_dto.py +++ b/nipyapi/nifi/models/banner_dto.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,73 +27,71 @@ class BannerDTO(object): and the value is json key in definition. """ swagger_types = { - 'header_text': 'str', - 'footer_text': 'str' - } + 'footer_text': 'str', +'header_text': 'str' } attribute_map = { - 'header_text': 'headerText', - 'footer_text': 'footerText' - } + 'footer_text': 'footerText', +'header_text': 'headerText' } - def __init__(self, header_text=None, footer_text=None): + def __init__(self, footer_text=None, header_text=None): """ BannerDTO - a model defined in Swagger """ - self._header_text = None self._footer_text = None + self._header_text = None - if header_text is not None: - self.header_text = header_text if footer_text is not None: self.footer_text = footer_text + if header_text is not None: + self.header_text = header_text @property - def header_text(self): + def footer_text(self): """ - Gets the header_text of this BannerDTO. - The header text. + Gets the footer_text of this BannerDTO. + The footer text. - :return: The header_text of this BannerDTO. + :return: The footer_text of this BannerDTO. :rtype: str """ - return self._header_text + return self._footer_text - @header_text.setter - def header_text(self, header_text): + @footer_text.setter + def footer_text(self, footer_text): """ - Sets the header_text of this BannerDTO. - The header text. + Sets the footer_text of this BannerDTO. + The footer text. - :param header_text: The header_text of this BannerDTO. + :param footer_text: The footer_text of this BannerDTO. :type: str """ - self._header_text = header_text + self._footer_text = footer_text @property - def footer_text(self): + def header_text(self): """ - Gets the footer_text of this BannerDTO. - The footer text. + Gets the header_text of this BannerDTO. + The header text. - :return: The footer_text of this BannerDTO. + :return: The header_text of this BannerDTO. :rtype: str """ - return self._footer_text + return self._header_text - @footer_text.setter - def footer_text(self, footer_text): + @header_text.setter + def header_text(self, header_text): """ - Sets the footer_text of this BannerDTO. - The footer text. + Sets the header_text of this BannerDTO. + The header text. - :param footer_text: The footer_text of this BannerDTO. + :param header_text: The header_text of this BannerDTO. :type: str """ - self._footer_text = footer_text + self._header_text = header_text def to_dict(self): """ diff --git a/nipyapi/nifi/models/banner_entity.py b/nipyapi/nifi/models/banner_entity.py index d097f713..0a53b275 100644 --- a/nipyapi/nifi/models/banner_entity.py +++ b/nipyapi/nifi/models/banner_entity.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,12 +27,10 @@ class BannerEntity(object): and the value is json key in definition. """ swagger_types = { - 'banners': 'BannerDTO' - } + 'banners': 'BannerDTO' } attribute_map = { - 'banners': 'banners' - } + 'banners': 'banners' } def __init__(self, banners=None): """ diff --git a/nipyapi/nifi/models/batch_settings_dto.py b/nipyapi/nifi/models/batch_settings_dto.py index acc8fb89..00d3804a 100644 --- a/nipyapi/nifi/models/batch_settings_dto.py +++ b/nipyapi/nifi/models/batch_settings_dto.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -29,31 +28,29 @@ class BatchSettingsDTO(object): """ swagger_types = { 'count': 'int', - 'size': 'str', - 'duration': 'str' - } +'duration': 'str', +'size': 'str' } attribute_map = { 'count': 'count', - 'size': 'size', - 'duration': 'duration' - } +'duration': 'duration', +'size': 'size' } - def __init__(self, count=None, size=None, duration=None): + def __init__(self, count=None, duration=None, size=None): """ BatchSettingsDTO - a model defined in Swagger """ self._count = None - self._size = None self._duration = None + self._size = None if count is not None: self.count = count - if size is not None: - self.size = size if duration is not None: self.duration = duration + if size is not None: + self.size = size @property def count(self): @@ -79,50 +76,50 @@ def count(self, count): self._count = count @property - def size(self): + def duration(self): """ - Gets the size of this BatchSettingsDTO. - Preferred number of bytes to include in a transaction. + Gets the duration of this BatchSettingsDTO. + Preferred amount of time that a transaction should span. - :return: The size of this BatchSettingsDTO. + :return: The duration of this BatchSettingsDTO. :rtype: str """ - return self._size + return self._duration - @size.setter - def size(self, size): + @duration.setter + def duration(self, duration): """ - Sets the size of this BatchSettingsDTO. - Preferred number of bytes to include in a transaction. + Sets the duration of this BatchSettingsDTO. + Preferred amount of time that a transaction should span. - :param size: The size of this BatchSettingsDTO. + :param duration: The duration of this BatchSettingsDTO. :type: str """ - self._size = size + self._duration = duration @property - def duration(self): + def size(self): """ - Gets the duration of this BatchSettingsDTO. - Preferred amount of time that a transaction should span. + Gets the size of this BatchSettingsDTO. + Preferred number of bytes to include in a transaction. - :return: The duration of this BatchSettingsDTO. + :return: The size of this BatchSettingsDTO. :rtype: str """ - return self._duration + return self._size - @duration.setter - def duration(self, duration): + @size.setter + def size(self, size): """ - Sets the duration of this BatchSettingsDTO. - Preferred amount of time that a transaction should span. + Sets the size of this BatchSettingsDTO. + Preferred number of bytes to include in a transaction. - :param duration: The duration of this BatchSettingsDTO. + :param size: The size of this BatchSettingsDTO. :type: str """ - self._duration = duration + self._size = size def to_dict(self): """ diff --git a/nipyapi/nifi/models/batch_size.py b/nipyapi/nifi/models/batch_size.py index 84d8a8c7..b76fd864 100644 --- a/nipyapi/nifi/models/batch_size.py +++ b/nipyapi/nifi/models/batch_size.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -29,31 +28,29 @@ class BatchSize(object): """ swagger_types = { 'count': 'int', - 'size': 'str', - 'duration': 'str' - } +'duration': 'str', +'size': 'str' } attribute_map = { 'count': 'count', - 'size': 'size', - 'duration': 'duration' - } +'duration': 'duration', +'size': 'size' } - def __init__(self, count=None, size=None, duration=None): + def __init__(self, count=None, duration=None, size=None): """ BatchSize - a model defined in Swagger """ self._count = None - self._size = None self._duration = None + self._size = None if count is not None: self.count = count - if size is not None: - self.size = size if duration is not None: self.duration = duration + if size is not None: + self.size = size @property def count(self): @@ -79,50 +76,50 @@ def count(self, count): self._count = count @property - def size(self): + def duration(self): """ - Gets the size of this BatchSize. - Preferred number of bytes to include in a transaction. + Gets the duration of this BatchSize. + Preferred amount of time that a transaction should span. - :return: The size of this BatchSize. + :return: The duration of this BatchSize. :rtype: str """ - return self._size + return self._duration - @size.setter - def size(self, size): + @duration.setter + def duration(self, duration): """ - Sets the size of this BatchSize. - Preferred number of bytes to include in a transaction. + Sets the duration of this BatchSize. + Preferred amount of time that a transaction should span. - :param size: The size of this BatchSize. + :param duration: The duration of this BatchSize. :type: str """ - self._size = size + self._duration = duration @property - def duration(self): + def size(self): """ - Gets the duration of this BatchSize. - Preferred amount of time that a transaction should span. + Gets the size of this BatchSize. + Preferred number of bytes to include in a transaction. - :return: The duration of this BatchSize. + :return: The size of this BatchSize. :rtype: str """ - return self._duration + return self._size - @duration.setter - def duration(self, duration): + @size.setter + def size(self, size): """ - Sets the duration of this BatchSize. - Preferred amount of time that a transaction should span. + Sets the size of this BatchSize. + Preferred number of bytes to include in a transaction. - :param duration: The duration of this BatchSize. + :param size: The size of this BatchSize. :type: str """ - self._duration = duration + self._size = size def to_dict(self): """ diff --git a/nipyapi/nifi/models/build_info.py b/nipyapi/nifi/models/build_info.py index ecb0c598..bf5109bd 100644 --- a/nipyapi/nifi/models/build_info.py +++ b/nipyapi/nifi/models/build_info.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,70 +27,91 @@ class BuildInfo(object): and the value is json key in definition. """ swagger_types = { - 'version': 'str', - 'revision': 'str', - 'timestamp': 'int', - 'target_arch': 'str', 'compiler': 'str', - 'compiler_flags': 'str' - } +'compiler_flags': 'str', +'revision': 'str', +'target_arch': 'str', +'timestamp': 'int', +'version': 'str' } attribute_map = { - 'version': 'version', - 'revision': 'revision', - 'timestamp': 'timestamp', - 'target_arch': 'targetArch', 'compiler': 'compiler', - 'compiler_flags': 'compilerFlags' - } +'compiler_flags': 'compilerFlags', +'revision': 'revision', +'target_arch': 'targetArch', +'timestamp': 'timestamp', +'version': 'version' } - def __init__(self, version=None, revision=None, timestamp=None, target_arch=None, compiler=None, compiler_flags=None): + def __init__(self, compiler=None, compiler_flags=None, revision=None, target_arch=None, timestamp=None, version=None): """ BuildInfo - a model defined in Swagger """ - self._version = None - self._revision = None - self._timestamp = None - self._target_arch = None self._compiler = None self._compiler_flags = None + self._revision = None + self._target_arch = None + self._timestamp = None + self._version = None - if version is not None: - self.version = version - if revision is not None: - self.revision = revision - if timestamp is not None: - self.timestamp = timestamp - if target_arch is not None: - self.target_arch = target_arch if compiler is not None: self.compiler = compiler if compiler_flags is not None: self.compiler_flags = compiler_flags + if revision is not None: + self.revision = revision + if target_arch is not None: + self.target_arch = target_arch + if timestamp is not None: + self.timestamp = timestamp + if version is not None: + self.version = version @property - def version(self): + def compiler(self): """ - Gets the version of this BuildInfo. - The version number of the built component. + Gets the compiler of this BuildInfo. + The compiler used for the build - :return: The version of this BuildInfo. + :return: The compiler of this BuildInfo. :rtype: str """ - return self._version + return self._compiler - @version.setter - def version(self, version): + @compiler.setter + def compiler(self, compiler): """ - Sets the version of this BuildInfo. - The version number of the built component. + Sets the compiler of this BuildInfo. + The compiler used for the build - :param version: The version of this BuildInfo. + :param compiler: The compiler of this BuildInfo. :type: str """ - self._version = version + self._compiler = compiler + + @property + def compiler_flags(self): + """ + Gets the compiler_flags of this BuildInfo. + The compiler flags used for the build. + + :return: The compiler_flags of this BuildInfo. + :rtype: str + """ + return self._compiler_flags + + @compiler_flags.setter + def compiler_flags(self, compiler_flags): + """ + Sets the compiler_flags of this BuildInfo. + The compiler flags used for the build. + + :param compiler_flags: The compiler_flags of this BuildInfo. + :type: str + """ + + self._compiler_flags = compiler_flags @property def revision(self): @@ -116,29 +136,6 @@ def revision(self, revision): self._revision = revision - @property - def timestamp(self): - """ - Gets the timestamp of this BuildInfo. - The timestamp (milliseconds since Epoch) of the build. - - :return: The timestamp of this BuildInfo. - :rtype: int - """ - return self._timestamp - - @timestamp.setter - def timestamp(self, timestamp): - """ - Sets the timestamp of this BuildInfo. - The timestamp (milliseconds since Epoch) of the build. - - :param timestamp: The timestamp of this BuildInfo. - :type: int - """ - - self._timestamp = timestamp - @property def target_arch(self): """ @@ -163,50 +160,50 @@ def target_arch(self, target_arch): self._target_arch = target_arch @property - def compiler(self): + def timestamp(self): """ - Gets the compiler of this BuildInfo. - The compiler used for the build + Gets the timestamp of this BuildInfo. + The timestamp (milliseconds since Epoch) of the build. - :return: The compiler of this BuildInfo. - :rtype: str + :return: The timestamp of this BuildInfo. + :rtype: int """ - return self._compiler + return self._timestamp - @compiler.setter - def compiler(self, compiler): + @timestamp.setter + def timestamp(self, timestamp): """ - Sets the compiler of this BuildInfo. - The compiler used for the build + Sets the timestamp of this BuildInfo. + The timestamp (milliseconds since Epoch) of the build. - :param compiler: The compiler of this BuildInfo. - :type: str + :param timestamp: The timestamp of this BuildInfo. + :type: int """ - self._compiler = compiler + self._timestamp = timestamp @property - def compiler_flags(self): + def version(self): """ - Gets the compiler_flags of this BuildInfo. - The compiler flags used for the build. + Gets the version of this BuildInfo. + The version number of the built component. - :return: The compiler_flags of this BuildInfo. + :return: The version of this BuildInfo. :rtype: str """ - return self._compiler_flags + return self._version - @compiler_flags.setter - def compiler_flags(self, compiler_flags): + @version.setter + def version(self, version): """ - Sets the compiler_flags of this BuildInfo. - The compiler flags used for the build. + Sets the version of this BuildInfo. + The version number of the built component. - :param compiler_flags: The compiler_flags of this BuildInfo. + :param version: The version of this BuildInfo. :type: str """ - self._compiler_flags = compiler_flags + self._version = version def to_dict(self): """ diff --git a/nipyapi/nifi/models/bulletin_board_dto.py b/nipyapi/nifi/models/bulletin_board_dto.py index 5e7460ff..c03de6fa 100644 --- a/nipyapi/nifi/models/bulletin_board_dto.py +++ b/nipyapi/nifi/models/bulletin_board_dto.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -29,13 +28,11 @@ class BulletinBoardDTO(object): """ swagger_types = { 'bulletins': 'list[BulletinEntity]', - 'generated': 'str' - } +'generated': 'str' } attribute_map = { 'bulletins': 'bulletins', - 'generated': 'generated' - } +'generated': 'generated' } def __init__(self, bulletins=None, generated=None): """ diff --git a/nipyapi/nifi/models/bulletin_board_entity.py b/nipyapi/nifi/models/bulletin_board_entity.py index bb41e82c..2185b823 100644 --- a/nipyapi/nifi/models/bulletin_board_entity.py +++ b/nipyapi/nifi/models/bulletin_board_entity.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,12 +27,10 @@ class BulletinBoardEntity(object): and the value is json key in definition. """ swagger_types = { - 'bulletin_board': 'BulletinBoardDTO' - } + 'bulletin_board': 'BulletinBoardDTO' } attribute_map = { - 'bulletin_board': 'bulletinBoard' - } + 'bulletin_board': 'bulletinBoard' } def __init__(self, bulletin_board=None): """ diff --git a/nipyapi/nifi/models/bulletin_board_pattern_parameter.py b/nipyapi/nifi/models/bulletin_board_pattern_parameter.py new file mode 100644 index 00000000..07556882 --- /dev/null +++ b/nipyapi/nifi/models/bulletin_board_pattern_parameter.py @@ -0,0 +1,143 @@ +""" + Apache NiFi REST API + + REST API definition for Apache NiFi web services + + OpenAPI spec version: 2.5.0 + Contact: dev@nifi.apache.org + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from pprint import pformat +import re + + +class BulletinBoardPatternParameter(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 = { + 'pattern': 'object', +'raw_pattern': 'str' } + + attribute_map = { + 'pattern': 'pattern', +'raw_pattern': 'rawPattern' } + + def __init__(self, pattern=None, raw_pattern=None): + """ + BulletinBoardPatternParameter - a model defined in Swagger + """ + + self._pattern = None + self._raw_pattern = None + + if pattern is not None: + self.pattern = pattern + if raw_pattern is not None: + self.raw_pattern = raw_pattern + + @property + def pattern(self): + """ + Gets the pattern of this BulletinBoardPatternParameter. + + :return: The pattern of this BulletinBoardPatternParameter. + :rtype: object + """ + return self._pattern + + @pattern.setter + def pattern(self, pattern): + """ + Sets the pattern of this BulletinBoardPatternParameter. + + :param pattern: The pattern of this BulletinBoardPatternParameter. + :type: object + """ + + self._pattern = pattern + + @property + def raw_pattern(self): + """ + Gets the raw_pattern of this BulletinBoardPatternParameter. + + :return: The raw_pattern of this BulletinBoardPatternParameter. + :rtype: str + """ + return self._raw_pattern + + @raw_pattern.setter + def raw_pattern(self, raw_pattern): + """ + Sets the raw_pattern of this BulletinBoardPatternParameter. + + :param raw_pattern: The raw_pattern of this BulletinBoardPatternParameter. + :type: str + """ + + self._raw_pattern = raw_pattern + + 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, BulletinBoardPatternParameter): + 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/bulletin_dto.py b/nipyapi/nifi/models/bulletin_dto.py index 2e82b506..c3e63b43 100644 --- a/nipyapi/nifi/models/bulletin_dto.py +++ b/nipyapi/nifi/models/bulletin_dto.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,63 +27,112 @@ class BulletinDTO(object): and the value is json key in definition. """ swagger_types = { - 'id': 'int', - 'node_address': 'str', 'category': 'str', - 'group_id': 'str', - 'source_id': 'str', - 'source_name': 'str', - 'level': 'str', - 'message': 'str', - 'timestamp': 'str' - } +'group_id': 'str', +'id': 'int', +'level': 'str', +'message': 'str', +'node_address': 'str', +'source_id': 'str', +'source_name': 'str', +'source_type': 'str', +'timestamp': 'str' } attribute_map = { - 'id': 'id', - 'node_address': 'nodeAddress', 'category': 'category', - 'group_id': 'groupId', - 'source_id': 'sourceId', - 'source_name': 'sourceName', - 'level': 'level', - 'message': 'message', - 'timestamp': 'timestamp' - } - - def __init__(self, id=None, node_address=None, category=None, group_id=None, source_id=None, source_name=None, level=None, message=None, timestamp=None): +'group_id': 'groupId', +'id': 'id', +'level': 'level', +'message': 'message', +'node_address': 'nodeAddress', +'source_id': 'sourceId', +'source_name': 'sourceName', +'source_type': 'sourceType', +'timestamp': 'timestamp' } + + def __init__(self, category=None, group_id=None, id=None, level=None, message=None, node_address=None, source_id=None, source_name=None, source_type=None, timestamp=None): """ BulletinDTO - a model defined in Swagger """ - self._id = None - self._node_address = None self._category = None self._group_id = None - self._source_id = None - self._source_name = None + self._id = None self._level = None self._message = None + self._node_address = None + self._source_id = None + self._source_name = None + self._source_type = None self._timestamp = None - if id is not None: - self.id = id - if node_address is not None: - self.node_address = node_address if category is not None: self.category = category if group_id is not None: self.group_id = group_id - if source_id is not None: - self.source_id = source_id - if source_name is not None: - self.source_name = source_name + if id is not None: + self.id = id if level is not None: self.level = level if message is not None: self.message = message + if node_address is not None: + self.node_address = node_address + if source_id is not None: + self.source_id = source_id + if source_name is not None: + self.source_name = source_name + if source_type is not None: + self.source_type = source_type if timestamp is not None: self.timestamp = timestamp + @property + def category(self): + """ + Gets the category of this BulletinDTO. + The category of this bulletin. + + :return: The category of this BulletinDTO. + :rtype: str + """ + return self._category + + @category.setter + def category(self, category): + """ + Sets the category of this BulletinDTO. + The category of this bulletin. + + :param category: The category of this BulletinDTO. + :type: str + """ + + self._category = category + + @property + def group_id(self): + """ + Gets the group_id of this BulletinDTO. + The group id of the source component. + + :return: The group_id of this BulletinDTO. + :rtype: str + """ + return self._group_id + + @group_id.setter + def group_id(self, group_id): + """ + Sets the group_id of this BulletinDTO. + The group id of the source component. + + :param group_id: The group_id of this BulletinDTO. + :type: str + """ + + self._group_id = group_id + @property def id(self): """ @@ -109,73 +157,73 @@ def id(self, id): self._id = id @property - def node_address(self): + def level(self): """ - Gets the node_address of this BulletinDTO. - If clustered, the address of the node from which the bulletin originated. + Gets the level of this BulletinDTO. + The level of the bulletin. - :return: The node_address of this BulletinDTO. + :return: The level of this BulletinDTO. :rtype: str """ - return self._node_address + return self._level - @node_address.setter - def node_address(self, node_address): + @level.setter + def level(self, level): """ - Sets the node_address of this BulletinDTO. - If clustered, the address of the node from which the bulletin originated. + Sets the level of this BulletinDTO. + The level of the bulletin. - :param node_address: The node_address of this BulletinDTO. + :param level: The level of this BulletinDTO. :type: str """ - self._node_address = node_address + self._level = level @property - def category(self): + def message(self): """ - Gets the category of this BulletinDTO. - The category of this bulletin. + Gets the message of this BulletinDTO. + The bulletin message. - :return: The category of this BulletinDTO. + :return: The message of this BulletinDTO. :rtype: str """ - return self._category + return self._message - @category.setter - def category(self, category): + @message.setter + def message(self, message): """ - Sets the category of this BulletinDTO. - The category of this bulletin. + Sets the message of this BulletinDTO. + The bulletin message. - :param category: The category of this BulletinDTO. + :param message: The message of this BulletinDTO. :type: str """ - self._category = category + self._message = message @property - def group_id(self): + def node_address(self): """ - Gets the group_id of this BulletinDTO. - The group id of the source component. + Gets the node_address of this BulletinDTO. + If clustered, the address of the node from which the bulletin originated. - :return: The group_id of this BulletinDTO. + :return: The node_address of this BulletinDTO. :rtype: str """ - return self._group_id + return self._node_address - @group_id.setter - def group_id(self, group_id): + @node_address.setter + def node_address(self, node_address): """ - Sets the group_id of this BulletinDTO. - The group id of the source component. + Sets the node_address of this BulletinDTO. + If clustered, the address of the node from which the bulletin originated. - :param group_id: The group_id of this BulletinDTO. + :param node_address: The node_address of this BulletinDTO. :type: str """ - self._group_id = group_id + self._node_address = node_address @property def source_id(self): @@ -224,50 +272,27 @@ def source_name(self, source_name): self._source_name = source_name @property - def level(self): + def source_type(self): """ - Gets the level of this BulletinDTO. - The level of the bulletin. + Gets the source_type of this BulletinDTO. + The type of the source component - :return: The level of this BulletinDTO. + :return: The source_type of this BulletinDTO. :rtype: str """ - return self._level + return self._source_type - @level.setter - def level(self, level): + @source_type.setter + def source_type(self, source_type): """ - Sets the level of this BulletinDTO. - The level of the bulletin. + Sets the source_type of this BulletinDTO. + The type of the source component - :param level: The level of this BulletinDTO. + :param source_type: The source_type of this BulletinDTO. :type: str """ - self._level = level - - @property - def message(self): - """ - Gets the message of this BulletinDTO. - The bulletin message. - - :return: The message of this BulletinDTO. - :rtype: str - """ - return self._message - - @message.setter - def message(self, message): - """ - Sets the message of this BulletinDTO. - The bulletin message. - - :param message: The message of this BulletinDTO. - :type: str - """ - - self._message = message + self._source_type = source_type @property def timestamp(self): diff --git a/nipyapi/nifi/models/bulletin_entity.py b/nipyapi/nifi/models/bulletin_entity.py index fe9799f1..8051c8ae 100644 --- a/nipyapi/nifi/models/bulletin_entity.py +++ b/nipyapi/nifi/models/bulletin_entity.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,138 +27,136 @@ class BulletinEntity(object): and the value is json key in definition. """ swagger_types = { - 'id': 'int', - 'group_id': 'str', - 'source_id': 'str', - 'timestamp': 'str', - 'node_address': 'str', - 'can_read': 'bool', - 'bulletin': 'BulletinDTO' - } + 'bulletin': 'BulletinDTO', +'can_read': 'bool', +'group_id': 'str', +'id': 'int', +'node_address': 'str', +'source_id': 'str', +'timestamp': 'str' } attribute_map = { - 'id': 'id', - 'group_id': 'groupId', - 'source_id': 'sourceId', - 'timestamp': 'timestamp', - 'node_address': 'nodeAddress', - 'can_read': 'canRead', - 'bulletin': 'bulletin' - } + 'bulletin': 'bulletin', +'can_read': 'canRead', +'group_id': 'groupId', +'id': 'id', +'node_address': 'nodeAddress', +'source_id': 'sourceId', +'timestamp': 'timestamp' } - def __init__(self, id=None, group_id=None, source_id=None, timestamp=None, node_address=None, can_read=None, bulletin=None): + def __init__(self, bulletin=None, can_read=None, group_id=None, id=None, node_address=None, source_id=None, timestamp=None): """ BulletinEntity - a model defined in Swagger """ - self._id = None + self._bulletin = None + self._can_read = None self._group_id = None + self._id = None + self._node_address = None self._source_id = None self._timestamp = None - self._node_address = None - self._can_read = None - self._bulletin = None - if id is not None: - self.id = id + if bulletin is not None: + self.bulletin = bulletin + if can_read is not None: + self.can_read = can_read if group_id is not None: self.group_id = group_id + if id is not None: + self.id = id + if node_address is not None: + self.node_address = node_address if source_id is not None: self.source_id = source_id if timestamp is not None: self.timestamp = timestamp - if node_address is not None: - self.node_address = node_address - if can_read is not None: - self.can_read = can_read - if bulletin is not None: - self.bulletin = bulletin @property - def id(self): + def bulletin(self): """ - Gets the id of this BulletinEntity. + Gets the bulletin of this BulletinEntity. - :return: The id of this BulletinEntity. - :rtype: int + :return: The bulletin of this BulletinEntity. + :rtype: BulletinDTO """ - return self._id + return self._bulletin - @id.setter - def id(self, id): + @bulletin.setter + def bulletin(self, bulletin): """ - Sets the id of this BulletinEntity. + Sets the bulletin of this BulletinEntity. - :param id: The id of this BulletinEntity. - :type: int + :param bulletin: The bulletin of this BulletinEntity. + :type: BulletinDTO """ - self._id = id + self._bulletin = bulletin @property - def group_id(self): + def can_read(self): """ - Gets the group_id of this BulletinEntity. + Gets the can_read of this BulletinEntity. + Indicates whether the user can read a given resource. - :return: The group_id of this BulletinEntity. - :rtype: str + :return: The can_read of this BulletinEntity. + :rtype: bool """ - return self._group_id + return self._can_read - @group_id.setter - def group_id(self, group_id): + @can_read.setter + def can_read(self, can_read): """ - Sets the group_id of this BulletinEntity. + Sets the can_read of this BulletinEntity. + Indicates whether the user can read a given resource. - :param group_id: The group_id of this BulletinEntity. - :type: str + :param can_read: The can_read of this BulletinEntity. + :type: bool """ - self._group_id = group_id + self._can_read = can_read @property - def source_id(self): + def group_id(self): """ - Gets the source_id of this BulletinEntity. + Gets the group_id of this BulletinEntity. - :return: The source_id of this BulletinEntity. + :return: The group_id of this BulletinEntity. :rtype: str """ - return self._source_id + return self._group_id - @source_id.setter - def source_id(self, source_id): + @group_id.setter + def group_id(self, group_id): """ - Sets the source_id of this BulletinEntity. + Sets the group_id of this BulletinEntity. - :param source_id: The source_id of this BulletinEntity. + :param group_id: The group_id of this BulletinEntity. :type: str """ - self._source_id = source_id + self._group_id = group_id @property - def timestamp(self): + def id(self): """ - Gets the timestamp of this BulletinEntity. - When this bulletin was generated. + Gets the id of this BulletinEntity. - :return: The timestamp of this BulletinEntity. - :rtype: str + :return: The id of this BulletinEntity. + :rtype: int """ - return self._timestamp + return self._id - @timestamp.setter - def timestamp(self, timestamp): + @id.setter + def id(self, id): """ - Sets the timestamp of this BulletinEntity. - When this bulletin was generated. + Sets the id of this BulletinEntity. - :param timestamp: The timestamp of this BulletinEntity. - :type: str + :param id: The id of this BulletinEntity. + :type: int """ - self._timestamp = timestamp + self._id = id @property def node_address(self): @@ -183,48 +180,48 @@ def node_address(self, node_address): self._node_address = node_address @property - def can_read(self): + def source_id(self): """ - Gets the can_read of this BulletinEntity. - Indicates whether the user can read a given resource. + Gets the source_id of this BulletinEntity. - :return: The can_read of this BulletinEntity. - :rtype: bool + :return: The source_id of this BulletinEntity. + :rtype: str """ - return self._can_read + return self._source_id - @can_read.setter - def can_read(self, can_read): + @source_id.setter + def source_id(self, source_id): """ - Sets the can_read of this BulletinEntity. - Indicates whether the user can read a given resource. + Sets the source_id of this BulletinEntity. - :param can_read: The can_read of this BulletinEntity. - :type: bool + :param source_id: The source_id of this BulletinEntity. + :type: str """ - self._can_read = can_read + self._source_id = source_id @property - def bulletin(self): + def timestamp(self): """ - Gets the bulletin of this BulletinEntity. + Gets the timestamp of this BulletinEntity. + When this bulletin was generated. - :return: The bulletin of this BulletinEntity. - :rtype: BulletinDTO + :return: The timestamp of this BulletinEntity. + :rtype: str """ - return self._bulletin + return self._timestamp - @bulletin.setter - def bulletin(self, bulletin): + @timestamp.setter + def timestamp(self, timestamp): """ - Sets the bulletin of this BulletinEntity. + Sets the timestamp of this BulletinEntity. + When this bulletin was generated. - :param bulletin: The bulletin of this BulletinEntity. - :type: BulletinDTO + :param timestamp: The timestamp of this BulletinEntity. + :type: str """ - self._bulletin = bulletin + self._timestamp = timestamp def to_dict(self): """ diff --git a/nipyapi/nifi/models/bundle.py b/nipyapi/nifi/models/bundle.py index 73598455..4985373f 100644 --- a/nipyapi/nifi/models/bundle.py +++ b/nipyapi/nifi/models/bundle.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,78 +27,76 @@ class Bundle(object): and the value is json key in definition. """ swagger_types = { - 'group': 'str', 'artifact': 'str', - 'version': 'str' - } +'group': 'str', +'version': 'str' } attribute_map = { - 'group': 'group', 'artifact': 'artifact', - 'version': 'version' - } +'group': 'group', +'version': 'version' } - def __init__(self, group=None, artifact=None, version=None): + def __init__(self, artifact=None, group=None, version=None): """ Bundle - a model defined in Swagger """ - self._group = None self._artifact = None + self._group = None self._version = None - if group is not None: - self.group = group if artifact is not None: self.artifact = artifact + if group is not None: + self.group = group if version is not None: self.version = version @property - def group(self): + def artifact(self): """ - Gets the group of this Bundle. - The group of the bundle + Gets the artifact of this Bundle. + The artifact of the bundle - :return: The group of this Bundle. + :return: The artifact of this Bundle. :rtype: str """ - return self._group + return self._artifact - @group.setter - def group(self, group): + @artifact.setter + def artifact(self, artifact): """ - Sets the group of this Bundle. - The group of the bundle + Sets the artifact of this Bundle. + The artifact of the bundle - :param group: The group of this Bundle. + :param artifact: The artifact of this Bundle. :type: str """ - self._group = group + self._artifact = artifact @property - def artifact(self): + def group(self): """ - Gets the artifact of this Bundle. - The artifact of the bundle + Gets the group of this Bundle. + The group of the bundle - :return: The artifact of this Bundle. + :return: The group of this Bundle. :rtype: str """ - return self._artifact + return self._group - @artifact.setter - def artifact(self, artifact): + @group.setter + def group(self, group): """ - Sets the artifact of this Bundle. - The artifact of the bundle + Sets the group of this Bundle. + The group of the bundle - :param artifact: The artifact of this Bundle. + :param group: The group of this Bundle. :type: str """ - self._artifact = artifact + self._group = group @property def version(self): diff --git a/nipyapi/nifi/models/bundle_dto.py b/nipyapi/nifi/models/bundle_dto.py index f071008b..06051619 100644 --- a/nipyapi/nifi/models/bundle_dto.py +++ b/nipyapi/nifi/models/bundle_dto.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,78 +27,76 @@ class BundleDTO(object): and the value is json key in definition. """ swagger_types = { - 'group': 'str', 'artifact': 'str', - 'version': 'str' - } +'group': 'str', +'version': 'str' } attribute_map = { - 'group': 'group', 'artifact': 'artifact', - 'version': 'version' - } +'group': 'group', +'version': 'version' } - def __init__(self, group=None, artifact=None, version=None): + def __init__(self, artifact=None, group=None, version=None): """ BundleDTO - a model defined in Swagger """ - self._group = None self._artifact = None + self._group = None self._version = None - if group is not None: - self.group = group if artifact is not None: self.artifact = artifact + if group is not None: + self.group = group if version is not None: self.version = version @property - def group(self): + def artifact(self): """ - Gets the group of this BundleDTO. - The group of the bundle. + Gets the artifact of this BundleDTO. + The artifact of the bundle. - :return: The group of this BundleDTO. + :return: The artifact of this BundleDTO. :rtype: str """ - return self._group + return self._artifact - @group.setter - def group(self, group): + @artifact.setter + def artifact(self, artifact): """ - Sets the group of this BundleDTO. - The group of the bundle. + Sets the artifact of this BundleDTO. + The artifact of the bundle. - :param group: The group of this BundleDTO. + :param artifact: The artifact of this BundleDTO. :type: str """ - self._group = group + self._artifact = artifact @property - def artifact(self): + def group(self): """ - Gets the artifact of this BundleDTO. - The artifact of the bundle. + Gets the group of this BundleDTO. + The group of the bundle. - :return: The artifact of this BundleDTO. + :return: The group of this BundleDTO. :rtype: str """ - return self._artifact + return self._group - @artifact.setter - def artifact(self, artifact): + @group.setter + def group(self, group): """ - Sets the artifact of this BundleDTO. - The artifact of the bundle. + Sets the group of this BundleDTO. + The group of the bundle. - :param artifact: The artifact of this BundleDTO. + :param group: The group of this BundleDTO. :type: str """ - self._artifact = artifact + self._group = group @property def version(self): diff --git a/nipyapi/nifi/models/class_loader_diagnostics_dto.py b/nipyapi/nifi/models/class_loader_diagnostics_dto.py deleted file mode 100644 index 79edfb0f..00000000 --- a/nipyapi/nifi/models/class_loader_diagnostics_dto.py +++ /dev/null @@ -1,150 +0,0 @@ -""" - NiFi Rest API - - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - - OpenAPI spec version: 1.28.1 - Contact: dev@nifi.apache.org - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - - -from pprint import pformat -import re - - -class ClassLoaderDiagnosticsDTO(object): - """ - NOTE: This class is auto generated by the swagger code generator program. - Do not edit the class manually. - """ - - - """ - Attributes: - swagger_types (dict): The key is attribute name - and the value is attribute type. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - """ - swagger_types = { - 'bundle': 'BundleDTO', - 'parent_class_loader': 'ClassLoaderDiagnosticsDTO' - } - - attribute_map = { - 'bundle': 'bundle', - 'parent_class_loader': 'parentClassLoader' - } - - def __init__(self, bundle=None, parent_class_loader=None): - """ - ClassLoaderDiagnosticsDTO - a model defined in Swagger - """ - - self._bundle = None - self._parent_class_loader = None - - if bundle is not None: - self.bundle = bundle - if parent_class_loader is not None: - self.parent_class_loader = parent_class_loader - - @property - def bundle(self): - """ - Gets the bundle of this ClassLoaderDiagnosticsDTO. - Information about the Bundle that the ClassLoader belongs to, if any - - :return: The bundle of this ClassLoaderDiagnosticsDTO. - :rtype: BundleDTO - """ - return self._bundle - - @bundle.setter - def bundle(self, bundle): - """ - Sets the bundle of this ClassLoaderDiagnosticsDTO. - Information about the Bundle that the ClassLoader belongs to, if any - - :param bundle: The bundle of this ClassLoaderDiagnosticsDTO. - :type: BundleDTO - """ - - self._bundle = bundle - - @property - def parent_class_loader(self): - """ - Gets the parent_class_loader of this ClassLoaderDiagnosticsDTO. - A ClassLoaderDiagnosticsDTO that provides information about the parent ClassLoader - - :return: The parent_class_loader of this ClassLoaderDiagnosticsDTO. - :rtype: ClassLoaderDiagnosticsDTO - """ - return self._parent_class_loader - - @parent_class_loader.setter - def parent_class_loader(self, parent_class_loader): - """ - Sets the parent_class_loader of this ClassLoaderDiagnosticsDTO. - A ClassLoaderDiagnosticsDTO that provides information about the parent ClassLoader - - :param parent_class_loader: The parent_class_loader of this ClassLoaderDiagnosticsDTO. - :type: ClassLoaderDiagnosticsDTO - """ - - self._parent_class_loader = parent_class_loader - - 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, ClassLoaderDiagnosticsDTO): - 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/client_id_parameter.py b/nipyapi/nifi/models/client_id_parameter.py new file mode 100644 index 00000000..f2a639c2 --- /dev/null +++ b/nipyapi/nifi/models/client_id_parameter.py @@ -0,0 +1,117 @@ +""" + Apache NiFi REST API + + REST API definition for Apache NiFi web services + + OpenAPI spec version: 2.5.0 + Contact: dev@nifi.apache.org + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from pprint import pformat +import re + + +class ClientIdParameter(object): + """ + NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. + """ + + + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'client_id': 'str' } + + attribute_map = { + 'client_id': 'clientId' } + + def __init__(self, client_id=None): + """ + ClientIdParameter - a model defined in Swagger + """ + + self._client_id = None + + if client_id is not None: + self.client_id = client_id + + @property + def client_id(self): + """ + Gets the client_id of this ClientIdParameter. + + :return: The client_id of this ClientIdParameter. + :rtype: str + """ + return self._client_id + + @client_id.setter + def client_id(self, client_id): + """ + Sets the client_id of this ClientIdParameter. + + :param client_id: The client_id of this ClientIdParameter. + :type: str + """ + + self._client_id = client_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, ClientIdParameter): + 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/cluster_dto.py b/nipyapi/nifi/models/cluster_dto.py index c12bf28b..3561706b 100644 --- a/nipyapi/nifi/models/cluster_dto.py +++ b/nipyapi/nifi/models/cluster_dto.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,50 +27,25 @@ class ClusterDTO(object): and the value is json key in definition. """ swagger_types = { - 'nodes': 'list[NodeDTO]', - 'generated': 'str' - } + 'generated': 'str', +'nodes': 'list[NodeDTO]' } attribute_map = { - 'nodes': 'nodes', - 'generated': 'generated' - } + 'generated': 'generated', +'nodes': 'nodes' } - def __init__(self, nodes=None, generated=None): + def __init__(self, generated=None, nodes=None): """ ClusterDTO - a model defined in Swagger """ - self._nodes = None self._generated = None + self._nodes = None - if nodes is not None: - self.nodes = nodes if generated is not None: self.generated = generated - - @property - def nodes(self): - """ - Gets the nodes of this ClusterDTO. - The collection of nodes that are part of the cluster. - - :return: The nodes of this ClusterDTO. - :rtype: list[NodeDTO] - """ - return self._nodes - - @nodes.setter - def nodes(self, nodes): - """ - Sets the nodes of this ClusterDTO. - The collection of nodes that are part of the cluster. - - :param nodes: The nodes of this ClusterDTO. - :type: list[NodeDTO] - """ - - self._nodes = nodes + if nodes is not None: + self.nodes = nodes @property def generated(self): @@ -96,6 +70,29 @@ def generated(self, generated): self._generated = generated + @property + def nodes(self): + """ + Gets the nodes of this ClusterDTO. + The collection of nodes that are part of the cluster. + + :return: The nodes of this ClusterDTO. + :rtype: list[NodeDTO] + """ + return self._nodes + + @nodes.setter + def nodes(self, nodes): + """ + Sets the nodes of this ClusterDTO. + The collection of nodes that are part of the cluster. + + :param nodes: The nodes of this ClusterDTO. + :type: list[NodeDTO] + """ + + self._nodes = nodes + def to_dict(self): """ Returns the model properties as a dict diff --git a/nipyapi/nifi/models/cluster_entity.py b/nipyapi/nifi/models/cluster_entity.py index c12a155e..faccfcf8 100644 --- a/nipyapi/nifi/models/cluster_entity.py +++ b/nipyapi/nifi/models/cluster_entity.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,12 +27,10 @@ class ClusterEntity(object): and the value is json key in definition. """ swagger_types = { - 'cluster': 'ClusterDTO' - } + 'cluster': 'ClusterDTO' } attribute_map = { - 'cluster': 'cluster' - } + 'cluster': 'cluster' } def __init__(self, cluster=None): """ diff --git a/nipyapi/nifi/models/cluster_search_results_entity.py b/nipyapi/nifi/models/cluster_search_results_entity.py index 2a755c46..dc24a833 100644 --- a/nipyapi/nifi/models/cluster_search_results_entity.py +++ b/nipyapi/nifi/models/cluster_search_results_entity.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,12 +27,10 @@ class ClusterSearchResultsEntity(object): and the value is json key in definition. """ swagger_types = { - 'node_results': 'list[NodeSearchResultDTO]' - } + 'node_results': 'list[NodeSearchResultDTO]' } attribute_map = { - 'node_results': 'nodeResults' - } + 'node_results': 'nodeResults' } def __init__(self, node_results=None): """ diff --git a/nipyapi/nifi/models/cluster_summary_dto.py b/nipyapi/nifi/models/cluster_summary_dto.py index 1b34f823..29416bb3 100644 --- a/nipyapi/nifi/models/cluster_summary_dto.py +++ b/nipyapi/nifi/models/cluster_summary_dto.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,65 +27,63 @@ class ClusterSummaryDTO(object): and the value is json key in definition. """ swagger_types = { - 'connected_nodes': 'str', - 'connected_node_count': 'int', - 'total_node_count': 'int', - 'connected_to_cluster': 'bool', - 'clustered': 'bool' - } + 'clustered': 'bool', +'connected_node_count': 'int', +'connected_nodes': 'str', +'connected_to_cluster': 'bool', +'total_node_count': 'int' } attribute_map = { - 'connected_nodes': 'connectedNodes', - 'connected_node_count': 'connectedNodeCount', - 'total_node_count': 'totalNodeCount', - 'connected_to_cluster': 'connectedToCluster', - 'clustered': 'clustered' - } + 'clustered': 'clustered', +'connected_node_count': 'connectedNodeCount', +'connected_nodes': 'connectedNodes', +'connected_to_cluster': 'connectedToCluster', +'total_node_count': 'totalNodeCount' } - def __init__(self, connected_nodes=None, connected_node_count=None, total_node_count=None, connected_to_cluster=None, clustered=None): + def __init__(self, clustered=None, connected_node_count=None, connected_nodes=None, connected_to_cluster=None, total_node_count=None): """ ClusterSummaryDTO - a model defined in Swagger """ - self._connected_nodes = None + self._clustered = None self._connected_node_count = None - self._total_node_count = None + self._connected_nodes = None self._connected_to_cluster = None - self._clustered = None + self._total_node_count = None - if connected_nodes is not None: - self.connected_nodes = connected_nodes + if clustered is not None: + self.clustered = clustered if connected_node_count is not None: self.connected_node_count = connected_node_count - if total_node_count is not None: - self.total_node_count = total_node_count + if connected_nodes is not None: + self.connected_nodes = connected_nodes if connected_to_cluster is not None: self.connected_to_cluster = connected_to_cluster - if clustered is not None: - self.clustered = clustered + if total_node_count is not None: + self.total_node_count = total_node_count @property - def connected_nodes(self): + def clustered(self): """ - Gets the connected_nodes of this ClusterSummaryDTO. - When clustered, reports the number of nodes connected vs the number of nodes in the cluster. + Gets the clustered of this ClusterSummaryDTO. + Whether this NiFi instance is clustered. - :return: The connected_nodes of this ClusterSummaryDTO. - :rtype: str + :return: The clustered of this ClusterSummaryDTO. + :rtype: bool """ - return self._connected_nodes + return self._clustered - @connected_nodes.setter - def connected_nodes(self, connected_nodes): + @clustered.setter + def clustered(self, clustered): """ - Sets the connected_nodes of this ClusterSummaryDTO. - When clustered, reports the number of nodes connected vs the number of nodes in the cluster. + Sets the clustered of this ClusterSummaryDTO. + Whether this NiFi instance is clustered. - :param connected_nodes: The connected_nodes of this ClusterSummaryDTO. - :type: str + :param clustered: The clustered of this ClusterSummaryDTO. + :type: bool """ - self._connected_nodes = connected_nodes + self._clustered = clustered @property def connected_node_count(self): @@ -112,27 +109,27 @@ def connected_node_count(self, connected_node_count): self._connected_node_count = connected_node_count @property - def total_node_count(self): + def connected_nodes(self): """ - Gets the total_node_count of this ClusterSummaryDTO. - The number of nodes in the cluster, regardless of whether or not they are connected + Gets the connected_nodes of this ClusterSummaryDTO. + When clustered, reports the number of nodes connected vs the number of nodes in the cluster. - :return: The total_node_count of this ClusterSummaryDTO. - :rtype: int + :return: The connected_nodes of this ClusterSummaryDTO. + :rtype: str """ - return self._total_node_count + return self._connected_nodes - @total_node_count.setter - def total_node_count(self, total_node_count): + @connected_nodes.setter + def connected_nodes(self, connected_nodes): """ - Sets the total_node_count of this ClusterSummaryDTO. - The number of nodes in the cluster, regardless of whether or not they are connected + Sets the connected_nodes of this ClusterSummaryDTO. + When clustered, reports the number of nodes connected vs the number of nodes in the cluster. - :param total_node_count: The total_node_count of this ClusterSummaryDTO. - :type: int + :param connected_nodes: The connected_nodes of this ClusterSummaryDTO. + :type: str """ - self._total_node_count = total_node_count + self._connected_nodes = connected_nodes @property def connected_to_cluster(self): @@ -158,27 +155,27 @@ def connected_to_cluster(self, connected_to_cluster): self._connected_to_cluster = connected_to_cluster @property - def clustered(self): + def total_node_count(self): """ - Gets the clustered of this ClusterSummaryDTO. - Whether this NiFi instance is clustered. + Gets the total_node_count of this ClusterSummaryDTO. + The number of nodes in the cluster, regardless of whether or not they are connected - :return: The clustered of this ClusterSummaryDTO. - :rtype: bool + :return: The total_node_count of this ClusterSummaryDTO. + :rtype: int """ - return self._clustered + return self._total_node_count - @clustered.setter - def clustered(self, clustered): + @total_node_count.setter + def total_node_count(self, total_node_count): """ - Sets the clustered of this ClusterSummaryDTO. - Whether this NiFi instance is clustered. + Sets the total_node_count of this ClusterSummaryDTO. + The number of nodes in the cluster, regardless of whether or not they are connected - :param clustered: The clustered of this ClusterSummaryDTO. - :type: bool + :param total_node_count: The total_node_count of this ClusterSummaryDTO. + :type: int """ - self._clustered = clustered + self._total_node_count = total_node_count def to_dict(self): """ diff --git a/nipyapi/nifi/models/cluste_summary_entity.py b/nipyapi/nifi/models/cluster_summary_entity.py similarity index 72% rename from nipyapi/nifi/models/cluste_summary_entity.py rename to nipyapi/nifi/models/cluster_summary_entity.py index 9c1b47db..cb45754c 100644 --- a/nipyapi/nifi/models/cluste_summary_entity.py +++ b/nipyapi/nifi/models/cluster_summary_entity.py @@ -1,19 +1,18 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re -class ClusteSummaryEntity(object): +class ClusterSummaryEntity(object): """ NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually. @@ -28,16 +27,14 @@ class ClusteSummaryEntity(object): and the value is json key in definition. """ swagger_types = { - 'cluster_summary': 'ClusterSummaryDTO' - } + 'cluster_summary': 'ClusterSummaryDTO' } attribute_map = { - 'cluster_summary': 'clusterSummary' - } + 'cluster_summary': 'clusterSummary' } def __init__(self, cluster_summary=None): """ - ClusteSummaryEntity - a model defined in Swagger + ClusterSummaryEntity - a model defined in Swagger """ self._cluster_summary = None @@ -48,9 +45,9 @@ def __init__(self, cluster_summary=None): @property def cluster_summary(self): """ - Gets the cluster_summary of this ClusteSummaryEntity. + Gets the cluster_summary of this ClusterSummaryEntity. - :return: The cluster_summary of this ClusteSummaryEntity. + :return: The cluster_summary of this ClusterSummaryEntity. :rtype: ClusterSummaryDTO """ return self._cluster_summary @@ -58,9 +55,9 @@ def cluster_summary(self): @cluster_summary.setter def cluster_summary(self, cluster_summary): """ - Sets the cluster_summary of this ClusteSummaryEntity. + Sets the cluster_summary of this ClusterSummaryEntity. - :param cluster_summary: The cluster_summary of this ClusteSummaryEntity. + :param cluster_summary: The cluster_summary of this ClusterSummaryEntity. :type: ClusterSummaryDTO """ @@ -108,7 +105,7 @@ def __eq__(self, other): """ Returns true if both objects are equal """ - if not isinstance(other, ClusteSummaryEntity): + if not isinstance(other, ClusterSummaryEntity): return False return self.__dict__ == other.__dict__ diff --git a/nipyapi/nifi/models/component_details_dto.py b/nipyapi/nifi/models/component_details_dto.py index bbe1fb8e..e5999f0b 100644 --- a/nipyapi/nifi/models/component_details_dto.py +++ b/nipyapi/nifi/models/component_details_dto.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,12 +27,10 @@ class ComponentDetailsDTO(object): and the value is json key in definition. """ swagger_types = { - - } + } attribute_map = { - - } + } def __init__(self): """ diff --git a/nipyapi/nifi/models/component_difference_dto.py b/nipyapi/nifi/models/component_difference_dto.py index 60c611f0..da5bd8d2 100644 --- a/nipyapi/nifi/models/component_difference_dto.py +++ b/nipyapi/nifi/models/component_difference_dto.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,65 +27,40 @@ class ComponentDifferenceDTO(object): and the value is json key in definition. """ swagger_types = { - 'component_type': 'str', 'component_id': 'str', - 'component_name': 'str', - 'process_group_id': 'str', - 'differences': 'list[DifferenceDTO]' - } +'component_name': 'str', +'component_type': 'str', +'differences': 'list[DifferenceDTO]', +'process_group_id': 'str' } attribute_map = { - 'component_type': 'componentType', 'component_id': 'componentId', - 'component_name': 'componentName', - 'process_group_id': 'processGroupId', - 'differences': 'differences' - } +'component_name': 'componentName', +'component_type': 'componentType', +'differences': 'differences', +'process_group_id': 'processGroupId' } - def __init__(self, component_type=None, component_id=None, component_name=None, process_group_id=None, differences=None): + def __init__(self, component_id=None, component_name=None, component_type=None, differences=None, process_group_id=None): """ ComponentDifferenceDTO - a model defined in Swagger """ - self._component_type = None self._component_id = None self._component_name = None - self._process_group_id = None + self._component_type = None self._differences = None + self._process_group_id = None - if component_type is not None: - self.component_type = component_type if component_id is not None: self.component_id = component_id if component_name is not None: self.component_name = component_name - if process_group_id is not None: - self.process_group_id = process_group_id + if component_type is not None: + self.component_type = component_type if differences is not None: self.differences = differences - - @property - def component_type(self): - """ - Gets the component_type of this ComponentDifferenceDTO. - The type of component - - :return: The component_type of this ComponentDifferenceDTO. - :rtype: str - """ - return self._component_type - - @component_type.setter - def component_type(self, component_type): - """ - Sets the component_type of this ComponentDifferenceDTO. - The type of component - - :param component_type: The component_type of this ComponentDifferenceDTO. - :type: str - """ - - self._component_type = component_type + if process_group_id is not None: + self.process_group_id = process_group_id @property def component_id(self): @@ -135,27 +109,27 @@ def component_name(self, component_name): self._component_name = component_name @property - def process_group_id(self): + def component_type(self): """ - Gets the process_group_id of this ComponentDifferenceDTO. - The ID of the Process Group that the component belongs to + Gets the component_type of this ComponentDifferenceDTO. + The type of component - :return: The process_group_id of this ComponentDifferenceDTO. + :return: The component_type of this ComponentDifferenceDTO. :rtype: str """ - return self._process_group_id + return self._component_type - @process_group_id.setter - def process_group_id(self, process_group_id): + @component_type.setter + def component_type(self, component_type): """ - Sets the process_group_id of this ComponentDifferenceDTO. - The ID of the Process Group that the component belongs to + Sets the component_type of this ComponentDifferenceDTO. + The type of component - :param process_group_id: The process_group_id of this ComponentDifferenceDTO. + :param component_type: The component_type of this ComponentDifferenceDTO. :type: str """ - self._process_group_id = process_group_id + self._component_type = component_type @property def differences(self): @@ -180,6 +154,29 @@ def differences(self, differences): self._differences = differences + @property + def process_group_id(self): + """ + Gets the process_group_id of this ComponentDifferenceDTO. + The ID of the Process Group that the component belongs to + + :return: The process_group_id of this ComponentDifferenceDTO. + :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 ComponentDifferenceDTO. + The ID of the Process Group that the component belongs to + + :param process_group_id: The process_group_id of this ComponentDifferenceDTO. + :type: str + """ + + self._process_group_id = process_group_id + def to_dict(self): """ Returns the model properties as a dict diff --git a/nipyapi/nifi/models/component_history_dto.py b/nipyapi/nifi/models/component_history_dto.py index dff2232f..e46a3113 100644 --- a/nipyapi/nifi/models/component_history_dto.py +++ b/nipyapi/nifi/models/component_history_dto.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -29,13 +28,11 @@ class ComponentHistoryDTO(object): """ swagger_types = { 'component_id': 'str', - 'property_history': 'dict(str, PropertyHistoryDTO)' - } +'property_history': 'dict(str, PropertyHistoryDTO)' } attribute_map = { 'component_id': 'componentId', - 'property_history': 'propertyHistory' - } +'property_history': 'propertyHistory' } def __init__(self, component_id=None, property_history=None): """ diff --git a/nipyapi/nifi/models/component_history_entity.py b/nipyapi/nifi/models/component_history_entity.py index 2e3c1261..f459ef16 100644 --- a/nipyapi/nifi/models/component_history_entity.py +++ b/nipyapi/nifi/models/component_history_entity.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,12 +27,10 @@ class ComponentHistoryEntity(object): and the value is json key in definition. """ swagger_types = { - 'component_history': 'ComponentHistoryDTO' - } + 'component_history': 'ComponentHistoryDTO' } attribute_map = { - 'component_history': 'componentHistory' - } + 'component_history': 'componentHistory' } def __init__(self, component_history=None): """ diff --git a/nipyapi/nifi/models/component_manifest.py b/nipyapi/nifi/models/component_manifest.py index 84a7a735..bf7c7896 100644 --- a/nipyapi/nifi/models/component_manifest.py +++ b/nipyapi/nifi/models/component_manifest.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -29,25 +28,29 @@ class ComponentManifest(object): """ swagger_types = { 'apis': 'list[DefinedType]', - 'controller_services': 'list[ControllerServiceDefinition]', - 'processors': 'list[ProcessorDefinition]', - 'reporting_tasks': 'list[ReportingTaskDefinition]' - } +'controller_services': 'list[ControllerServiceDefinition]', +'flow_analysis_rules': 'list[FlowAnalysisRuleDefinition]', +'parameter_providers': 'list[ParameterProviderDefinition]', +'processors': 'list[ProcessorDefinition]', +'reporting_tasks': 'list[ReportingTaskDefinition]' } attribute_map = { 'apis': 'apis', - 'controller_services': 'controllerServices', - 'processors': 'processors', - 'reporting_tasks': 'reportingTasks' - } +'controller_services': 'controllerServices', +'flow_analysis_rules': 'flowAnalysisRules', +'parameter_providers': 'parameterProviders', +'processors': 'processors', +'reporting_tasks': 'reportingTasks' } - def __init__(self, apis=None, controller_services=None, processors=None, reporting_tasks=None): + def __init__(self, apis=None, controller_services=None, flow_analysis_rules=None, parameter_providers=None, processors=None, reporting_tasks=None): """ ComponentManifest - a model defined in Swagger """ self._apis = None self._controller_services = None + self._flow_analysis_rules = None + self._parameter_providers = None self._processors = None self._reporting_tasks = None @@ -55,6 +58,10 @@ def __init__(self, apis=None, controller_services=None, processors=None, reporti self.apis = apis if controller_services is not None: self.controller_services = controller_services + if flow_analysis_rules is not None: + self.flow_analysis_rules = flow_analysis_rules + if parameter_providers is not None: + self.parameter_providers = parameter_providers if processors is not None: self.processors = processors if reporting_tasks is not None: @@ -106,6 +113,52 @@ def controller_services(self, controller_services): self._controller_services = controller_services + @property + def flow_analysis_rules(self): + """ + Gets the flow_analysis_rules of this ComponentManifest. + Flow Analysis Rules provided in this bundle + + :return: The flow_analysis_rules of this ComponentManifest. + :rtype: list[FlowAnalysisRuleDefinition] + """ + return self._flow_analysis_rules + + @flow_analysis_rules.setter + def flow_analysis_rules(self, flow_analysis_rules): + """ + Sets the flow_analysis_rules of this ComponentManifest. + Flow Analysis Rules provided in this bundle + + :param flow_analysis_rules: The flow_analysis_rules of this ComponentManifest. + :type: list[FlowAnalysisRuleDefinition] + """ + + self._flow_analysis_rules = flow_analysis_rules + + @property + def parameter_providers(self): + """ + Gets the parameter_providers of this ComponentManifest. + Parameter Providers provided in this bundle + + :return: The parameter_providers of this ComponentManifest. + :rtype: list[ParameterProviderDefinition] + """ + return self._parameter_providers + + @parameter_providers.setter + def parameter_providers(self, parameter_providers): + """ + Sets the parameter_providers of this ComponentManifest. + Parameter Providers provided in this bundle + + :param parameter_providers: The parameter_providers of this ComponentManifest. + :type: list[ParameterProviderDefinition] + """ + + self._parameter_providers = parameter_providers + @property def processors(self): """ diff --git a/nipyapi/nifi/models/component_reference_dto.py b/nipyapi/nifi/models/component_reference_dto.py index cabf7560..5f55b2e0 100644 --- a/nipyapi/nifi/models/component_reference_dto.py +++ b/nipyapi/nifi/models/component_reference_dto.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -29,41 +28,39 @@ class ComponentReferenceDTO(object): """ swagger_types = { 'id': 'str', - 'versioned_component_id': 'str', - 'parent_group_id': 'str', - 'position': 'PositionDTO', - 'name': 'str' - } +'name': 'str', +'parent_group_id': 'str', +'position': 'PositionDTO', +'versioned_component_id': 'str' } attribute_map = { 'id': 'id', - 'versioned_component_id': 'versionedComponentId', - 'parent_group_id': 'parentGroupId', - 'position': 'position', - 'name': 'name' - } +'name': 'name', +'parent_group_id': 'parentGroupId', +'position': 'position', +'versioned_component_id': 'versionedComponentId' } - def __init__(self, id=None, versioned_component_id=None, parent_group_id=None, position=None, name=None): + def __init__(self, id=None, name=None, parent_group_id=None, position=None, versioned_component_id=None): """ ComponentReferenceDTO - a model defined in Swagger """ self._id = None - self._versioned_component_id = None + self._name = None self._parent_group_id = None self._position = None - self._name = None + self._versioned_component_id = None if id is not None: self.id = id - if versioned_component_id is not None: - self.versioned_component_id = versioned_component_id + if name is not None: + self.name = name if parent_group_id is not None: self.parent_group_id = parent_group_id if position is not None: self.position = position - if name is not None: - self.name = name + if versioned_component_id is not None: + self.versioned_component_id = versioned_component_id @property def id(self): @@ -89,27 +86,27 @@ def id(self, id): self._id = id @property - def versioned_component_id(self): + def name(self): """ - Gets the versioned_component_id of this ComponentReferenceDTO. - The ID of the corresponding component that is under version control + Gets the name of this ComponentReferenceDTO. + The name of the component. - :return: The versioned_component_id of this ComponentReferenceDTO. + :return: The name of this ComponentReferenceDTO. :rtype: str """ - return self._versioned_component_id + return self._name - @versioned_component_id.setter - def versioned_component_id(self, versioned_component_id): + @name.setter + def name(self, name): """ - Sets the versioned_component_id of this ComponentReferenceDTO. - The ID of the corresponding component that is under version control + Sets the name of this ComponentReferenceDTO. + The name of the component. - :param versioned_component_id: The versioned_component_id of this ComponentReferenceDTO. + :param name: The name of this ComponentReferenceDTO. :type: str """ - self._versioned_component_id = versioned_component_id + self._name = name @property def parent_group_id(self): @@ -138,7 +135,6 @@ def parent_group_id(self, parent_group_id): def position(self): """ Gets the position of this ComponentReferenceDTO. - The position of this component in the UI if applicable. :return: The position of this ComponentReferenceDTO. :rtype: PositionDTO @@ -149,7 +145,6 @@ def position(self): def position(self, position): """ Sets the position of this ComponentReferenceDTO. - The position of this component in the UI if applicable. :param position: The position of this ComponentReferenceDTO. :type: PositionDTO @@ -158,27 +153,27 @@ def position(self, position): self._position = position @property - def name(self): + def versioned_component_id(self): """ - Gets the name of this ComponentReferenceDTO. - The name of the component. + Gets the versioned_component_id of this ComponentReferenceDTO. + The ID of the corresponding component that is under version control - :return: The name of this ComponentReferenceDTO. + :return: The versioned_component_id of this ComponentReferenceDTO. :rtype: str """ - return self._name + return self._versioned_component_id - @name.setter - def name(self, name): + @versioned_component_id.setter + def versioned_component_id(self, versioned_component_id): """ - Sets the name of this ComponentReferenceDTO. - The name of the component. + Sets the versioned_component_id of this ComponentReferenceDTO. + The ID of the corresponding component that is under version control - :param name: The name of this ComponentReferenceDTO. + :param versioned_component_id: The versioned_component_id of this ComponentReferenceDTO. :type: str """ - self._name = name + self._versioned_component_id = versioned_component_id def to_dict(self): """ diff --git a/nipyapi/nifi/models/component_reference_entity.py b/nipyapi/nifi/models/component_reference_entity.py index bdd42529..76e05201 100644 --- a/nipyapi/nifi/models/component_reference_entity.py +++ b/nipyapi/nifi/models/component_reference_entity.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,85 +27,127 @@ class ComponentReferenceEntity(object): and the value is json key in definition. """ swagger_types = { - 'revision': 'RevisionDTO', - 'id': 'str', - 'uri': 'str', - 'position': 'PositionDTO', - 'permissions': 'PermissionsDTO', 'bulletins': 'list[BulletinEntity]', - 'disconnected_node_acknowledged': 'bool', - 'parent_group_id': 'str', - 'component': 'ComponentReferenceDTO' - } +'component': 'ComponentReferenceDTO', +'disconnected_node_acknowledged': 'bool', +'id': 'str', +'parent_group_id': 'str', +'permissions': 'PermissionsDTO', +'position': 'PositionDTO', +'revision': 'RevisionDTO', +'uri': 'str' } attribute_map = { - 'revision': 'revision', - 'id': 'id', - 'uri': 'uri', - 'position': 'position', - 'permissions': 'permissions', 'bulletins': 'bulletins', - 'disconnected_node_acknowledged': 'disconnectedNodeAcknowledged', - 'parent_group_id': 'parentGroupId', - 'component': 'component' - } +'component': 'component', +'disconnected_node_acknowledged': 'disconnectedNodeAcknowledged', +'id': 'id', +'parent_group_id': 'parentGroupId', +'permissions': 'permissions', +'position': 'position', +'revision': 'revision', +'uri': 'uri' } - def __init__(self, revision=None, id=None, uri=None, position=None, permissions=None, bulletins=None, disconnected_node_acknowledged=None, parent_group_id=None, component=None): + def __init__(self, bulletins=None, component=None, disconnected_node_acknowledged=None, id=None, parent_group_id=None, permissions=None, position=None, revision=None, uri=None): """ ComponentReferenceEntity - a model defined in Swagger """ - self._revision = None - self._id = None - self._uri = None - self._position = None - self._permissions = None self._bulletins = None + self._component = None self._disconnected_node_acknowledged = None + self._id = None self._parent_group_id = None - self._component = None + self._permissions = None + self._position = None + self._revision = None + self._uri = None - if revision is not None: - self.revision = revision - if id is not None: - self.id = id - if uri is not None: - self.uri = uri - if position is not None: - self.position = position - if permissions is not None: - self.permissions = permissions if bulletins is not None: self.bulletins = bulletins + if component is not None: + self.component = component if disconnected_node_acknowledged is not None: self.disconnected_node_acknowledged = disconnected_node_acknowledged + if id is not None: + self.id = id if parent_group_id is not None: self.parent_group_id = parent_group_id - if component is not None: - self.component = component + if permissions is not None: + self.permissions = permissions + if position is not None: + self.position = position + if revision is not None: + self.revision = revision + if uri is not None: + self.uri = uri @property - def revision(self): + def bulletins(self): """ - Gets the revision of this ComponentReferenceEntity. - The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses. + Gets the bulletins of this ComponentReferenceEntity. + The bulletins for this component. - :return: The revision of this ComponentReferenceEntity. - :rtype: RevisionDTO + :return: The bulletins of this ComponentReferenceEntity. + :rtype: list[BulletinEntity] """ - return self._revision + return self._bulletins - @revision.setter - def revision(self, revision): + @bulletins.setter + def bulletins(self, bulletins): """ - Sets the revision of this ComponentReferenceEntity. - The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses. + Sets the bulletins of this ComponentReferenceEntity. + The bulletins for this component. - :param revision: The revision of this ComponentReferenceEntity. - :type: RevisionDTO + :param bulletins: The bulletins of this ComponentReferenceEntity. + :type: list[BulletinEntity] """ - self._revision = revision + self._bulletins = bulletins + + @property + def component(self): + """ + Gets the component of this ComponentReferenceEntity. + + :return: The component of this ComponentReferenceEntity. + :rtype: ComponentReferenceDTO + """ + return self._component + + @component.setter + def component(self, component): + """ + Sets the component of this ComponentReferenceEntity. + + :param component: The component of this ComponentReferenceEntity. + :type: ComponentReferenceDTO + """ + + self._component = component + + @property + def disconnected_node_acknowledged(self): + """ + Gets the disconnected_node_acknowledged of this ComponentReferenceEntity. + Acknowledges that this node is disconnected to allow for mutable requests to proceed. + + :return: The disconnected_node_acknowledged of this ComponentReferenceEntity. + :rtype: bool + """ + return self._disconnected_node_acknowledged + + @disconnected_node_acknowledged.setter + def disconnected_node_acknowledged(self, disconnected_node_acknowledged): + """ + Sets the disconnected_node_acknowledged of this ComponentReferenceEntity. + Acknowledges that this node is disconnected to allow for mutable requests to proceed. + + :param disconnected_node_acknowledged: The disconnected_node_acknowledged of this ComponentReferenceEntity. + :type: bool + """ + + self._disconnected_node_acknowledged = disconnected_node_acknowledged @property def id(self): @@ -132,56 +173,32 @@ def id(self, id): self._id = id @property - def uri(self): + def parent_group_id(self): """ - Gets the uri of this ComponentReferenceEntity. - The URI for futures requests to the component. + Gets the parent_group_id of this ComponentReferenceEntity. + The id of parent process group of this component if applicable. - :return: The uri of this ComponentReferenceEntity. + :return: The parent_group_id of this ComponentReferenceEntity. :rtype: str """ - return self._uri + return self._parent_group_id - @uri.setter - def uri(self, uri): + @parent_group_id.setter + def parent_group_id(self, parent_group_id): """ - Sets the uri of this ComponentReferenceEntity. - The URI for futures requests to the component. + Sets the parent_group_id of this ComponentReferenceEntity. + The id of parent process group of this component if applicable. - :param uri: The uri of this ComponentReferenceEntity. + :param parent_group_id: The parent_group_id of this ComponentReferenceEntity. :type: str """ - self._uri = uri - - @property - def position(self): - """ - Gets the position of this ComponentReferenceEntity. - The position of this component in the UI if applicable. - - :return: The position of this ComponentReferenceEntity. - :rtype: PositionDTO - """ - return self._position - - @position.setter - def position(self, position): - """ - Sets the position of this ComponentReferenceEntity. - The position of this component in the UI if applicable. - - :param position: The position of this ComponentReferenceEntity. - :type: PositionDTO - """ - - self._position = position + self._parent_group_id = parent_group_id @property def permissions(self): """ Gets the permissions of this ComponentReferenceEntity. - The permissions for this component. :return: The permissions of this ComponentReferenceEntity. :rtype: PermissionsDTO @@ -192,7 +209,6 @@ def permissions(self): def permissions(self, permissions): """ Sets the permissions of this ComponentReferenceEntity. - The permissions for this component. :param permissions: The permissions of this ComponentReferenceEntity. :type: PermissionsDTO @@ -201,94 +217,69 @@ def permissions(self, permissions): self._permissions = permissions @property - def bulletins(self): + def position(self): """ - Gets the bulletins of this ComponentReferenceEntity. - The bulletins for this component. + Gets the position of this ComponentReferenceEntity. - :return: The bulletins of this ComponentReferenceEntity. - :rtype: list[BulletinEntity] + :return: The position of this ComponentReferenceEntity. + :rtype: PositionDTO """ - return self._bulletins + return self._position - @bulletins.setter - def bulletins(self, bulletins): + @position.setter + def position(self, position): """ - Sets the bulletins of this ComponentReferenceEntity. - The bulletins for this component. + Sets the position of this ComponentReferenceEntity. - :param bulletins: The bulletins of this ComponentReferenceEntity. - :type: list[BulletinEntity] + :param position: The position of this ComponentReferenceEntity. + :type: PositionDTO """ - self._bulletins = bulletins + self._position = position @property - def disconnected_node_acknowledged(self): + def revision(self): """ - Gets the disconnected_node_acknowledged of this ComponentReferenceEntity. - Acknowledges that this node is disconnected to allow for mutable requests to proceed. + Gets the revision of this ComponentReferenceEntity. - :return: The disconnected_node_acknowledged of this ComponentReferenceEntity. - :rtype: bool + :return: The revision of this ComponentReferenceEntity. + :rtype: RevisionDTO """ - return self._disconnected_node_acknowledged + return self._revision - @disconnected_node_acknowledged.setter - def disconnected_node_acknowledged(self, disconnected_node_acknowledged): + @revision.setter + def revision(self, revision): """ - Sets the disconnected_node_acknowledged of this ComponentReferenceEntity. - Acknowledges that this node is disconnected to allow for mutable requests to proceed. + Sets the revision of this ComponentReferenceEntity. - :param disconnected_node_acknowledged: The disconnected_node_acknowledged of this ComponentReferenceEntity. - :type: bool + :param revision: The revision of this ComponentReferenceEntity. + :type: RevisionDTO """ - self._disconnected_node_acknowledged = disconnected_node_acknowledged + self._revision = revision @property - def parent_group_id(self): + def uri(self): """ - Gets the parent_group_id of this ComponentReferenceEntity. - The id of parent process group of this component if applicable. + Gets the uri of this ComponentReferenceEntity. + The URI for futures requests to the component. - :return: The parent_group_id of this ComponentReferenceEntity. + :return: The uri of this ComponentReferenceEntity. :rtype: str """ - return self._parent_group_id + return self._uri - @parent_group_id.setter - def parent_group_id(self, parent_group_id): + @uri.setter + def uri(self, uri): """ - Sets the parent_group_id of this ComponentReferenceEntity. - The id of parent process group of this component if applicable. + Sets the uri of this ComponentReferenceEntity. + The URI for futures requests to the component. - :param parent_group_id: The parent_group_id of this ComponentReferenceEntity. + :param uri: The uri of this ComponentReferenceEntity. :type: str """ - self._parent_group_id = parent_group_id - - @property - def component(self): - """ - Gets the component of this ComponentReferenceEntity. - - :return: The component of this ComponentReferenceEntity. - :rtype: ComponentReferenceDTO - """ - return self._component - - @component.setter - def component(self, component): - """ - Sets the component of this ComponentReferenceEntity. - - :param component: The component of this ComponentReferenceEntity. - :type: ComponentReferenceDTO - """ - - self._component = component + self._uri = uri def to_dict(self): """ diff --git a/nipyapi/nifi/models/component_restriction_permission_dto.py b/nipyapi/nifi/models/component_restriction_permission_dto.py index 72e0384e..b2611e88 100644 --- a/nipyapi/nifi/models/component_restriction_permission_dto.py +++ b/nipyapi/nifi/models/component_restriction_permission_dto.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,56 +27,30 @@ class ComponentRestrictionPermissionDTO(object): and the value is json key in definition. """ swagger_types = { - 'required_permission': 'RequiredPermissionDTO', - 'permissions': 'PermissionsDTO' - } + 'permissions': 'PermissionsDTO', +'required_permission': 'RequiredPermissionDTO' } attribute_map = { - 'required_permission': 'requiredPermission', - 'permissions': 'permissions' - } + 'permissions': 'permissions', +'required_permission': 'requiredPermission' } - def __init__(self, required_permission=None, permissions=None): + def __init__(self, permissions=None, required_permission=None): """ ComponentRestrictionPermissionDTO - a model defined in Swagger """ - self._required_permission = None self._permissions = None + self._required_permission = None - if required_permission is not None: - self.required_permission = required_permission if permissions is not None: self.permissions = permissions - - @property - def required_permission(self): - """ - Gets the required_permission of this ComponentRestrictionPermissionDTO. - The required permission necessary for this restriction. - - :return: The required_permission of this ComponentRestrictionPermissionDTO. - :rtype: RequiredPermissionDTO - """ - return self._required_permission - - @required_permission.setter - def required_permission(self, required_permission): - """ - Sets the required_permission of this ComponentRestrictionPermissionDTO. - The required permission necessary for this restriction. - - :param required_permission: The required_permission of this ComponentRestrictionPermissionDTO. - :type: RequiredPermissionDTO - """ - - self._required_permission = required_permission + if required_permission is not None: + self.required_permission = required_permission @property def permissions(self): """ Gets the permissions of this ComponentRestrictionPermissionDTO. - The permissions for this component restriction. Note: the read permission are not used and will always be false. :return: The permissions of this ComponentRestrictionPermissionDTO. :rtype: PermissionsDTO @@ -88,7 +61,6 @@ def permissions(self): def permissions(self, permissions): """ Sets the permissions of this ComponentRestrictionPermissionDTO. - The permissions for this component restriction. Note: the read permission are not used and will always be false. :param permissions: The permissions of this ComponentRestrictionPermissionDTO. :type: PermissionsDTO @@ -96,6 +68,27 @@ def permissions(self, permissions): self._permissions = permissions + @property + def required_permission(self): + """ + Gets the required_permission of this ComponentRestrictionPermissionDTO. + + :return: The required_permission of this ComponentRestrictionPermissionDTO. + :rtype: RequiredPermissionDTO + """ + return self._required_permission + + @required_permission.setter + def required_permission(self, required_permission): + """ + Sets the required_permission of this ComponentRestrictionPermissionDTO. + + :param required_permission: The required_permission of this ComponentRestrictionPermissionDTO. + :type: RequiredPermissionDTO + """ + + self._required_permission = required_permission + def to_dict(self): """ Returns the model properties as a dict diff --git a/nipyapi/nifi/models/component_search_result_dto.py b/nipyapi/nifi/models/component_search_result_dto.py index 2f765459..5fc7a57b 100644 --- a/nipyapi/nifi/models/component_search_result_dto.py +++ b/nipyapi/nifi/models/component_search_result_dto.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,47 +27,68 @@ class ComponentSearchResultDTO(object): and the value is json key in definition. """ swagger_types = { - 'id': 'str', 'group_id': 'str', - 'parent_group': 'SearchResultGroupDTO', - 'versioned_group': 'SearchResultGroupDTO', - 'name': 'str', - 'matches': 'list[str]' - } +'id': 'str', +'matches': 'list[str]', +'name': 'str', +'parent_group': 'SearchResultGroupDTO', +'versioned_group': 'SearchResultGroupDTO' } attribute_map = { - 'id': 'id', 'group_id': 'groupId', - 'parent_group': 'parentGroup', - 'versioned_group': 'versionedGroup', - 'name': 'name', - 'matches': 'matches' - } +'id': 'id', +'matches': 'matches', +'name': 'name', +'parent_group': 'parentGroup', +'versioned_group': 'versionedGroup' } - def __init__(self, id=None, group_id=None, parent_group=None, versioned_group=None, name=None, matches=None): + def __init__(self, group_id=None, id=None, matches=None, name=None, parent_group=None, versioned_group=None): """ ComponentSearchResultDTO - a model defined in Swagger """ - self._id = None self._group_id = None + self._id = None + self._matches = None + self._name = None self._parent_group = None self._versioned_group = None - self._name = None - self._matches = None - if id is not None: - self.id = id if group_id is not None: self.group_id = group_id + if id is not None: + self.id = id + if matches is not None: + self.matches = matches + if name is not None: + self.name = name if parent_group is not None: self.parent_group = parent_group if versioned_group is not None: self.versioned_group = versioned_group - if name is not None: - self.name = name - if matches is not None: - self.matches = matches + + @property + def group_id(self): + """ + Gets the group_id of this ComponentSearchResultDTO. + The group id of the component that matched the search. + + :return: The group_id of this ComponentSearchResultDTO. + :rtype: str + """ + return self._group_id + + @group_id.setter + def group_id(self, group_id): + """ + Sets the group_id of this ComponentSearchResultDTO. + The group id of the component that matched the search. + + :param group_id: The group_id of this ComponentSearchResultDTO. + :type: str + """ + + self._group_id = group_id @property def id(self): @@ -94,33 +114,55 @@ def id(self, id): self._id = id @property - def group_id(self): + def matches(self): """ - Gets the group_id of this ComponentSearchResultDTO. - The group id of the component that matched the search. + Gets the matches of this ComponentSearchResultDTO. + What matched the search from the component. - :return: The group_id of this ComponentSearchResultDTO. + :return: The matches of this ComponentSearchResultDTO. + :rtype: list[str] + """ + return self._matches + + @matches.setter + def matches(self, matches): + """ + Sets the matches of this ComponentSearchResultDTO. + What matched the search from the component. + + :param matches: The matches of this ComponentSearchResultDTO. + :type: list[str] + """ + + self._matches = matches + + @property + def name(self): + """ + Gets the name of this ComponentSearchResultDTO. + The name of the component that matched the search. + + :return: The name of this ComponentSearchResultDTO. :rtype: str """ - return self._group_id + return self._name - @group_id.setter - def group_id(self, group_id): + @name.setter + def name(self, name): """ - Sets the group_id of this ComponentSearchResultDTO. - The group id of the component that matched the search. + Sets the name of this ComponentSearchResultDTO. + The name of the component that matched the search. - :param group_id: The group_id of this ComponentSearchResultDTO. + :param name: The name of this ComponentSearchResultDTO. :type: str """ - self._group_id = group_id + self._name = name @property def parent_group(self): """ Gets the parent_group of this ComponentSearchResultDTO. - The parent group of the component that matched the search. :return: The parent_group of this ComponentSearchResultDTO. :rtype: SearchResultGroupDTO @@ -131,7 +173,6 @@ def parent_group(self): def parent_group(self, parent_group): """ Sets the parent_group of this ComponentSearchResultDTO. - The parent group of the component that matched the search. :param parent_group: The parent_group of this ComponentSearchResultDTO. :type: SearchResultGroupDTO @@ -143,7 +184,6 @@ def parent_group(self, parent_group): def versioned_group(self): """ Gets the versioned_group of this ComponentSearchResultDTO. - The nearest versioned ancestor group of the component that matched the search. :return: The versioned_group of this ComponentSearchResultDTO. :rtype: SearchResultGroupDTO @@ -154,7 +194,6 @@ def versioned_group(self): def versioned_group(self, versioned_group): """ Sets the versioned_group of this ComponentSearchResultDTO. - The nearest versioned ancestor group of the component that matched the search. :param versioned_group: The versioned_group of this ComponentSearchResultDTO. :type: SearchResultGroupDTO @@ -162,52 +201,6 @@ def versioned_group(self, versioned_group): self._versioned_group = versioned_group - @property - def name(self): - """ - Gets the name of this ComponentSearchResultDTO. - The name of the component that matched the search. - - :return: The name of this ComponentSearchResultDTO. - :rtype: str - """ - return self._name - - @name.setter - def name(self, name): - """ - Sets the name of this ComponentSearchResultDTO. - The name of the component that matched the search. - - :param name: The name of this ComponentSearchResultDTO. - :type: str - """ - - self._name = name - - @property - def matches(self): - """ - Gets the matches of this ComponentSearchResultDTO. - What matched the search from the component. - - :return: The matches of this ComponentSearchResultDTO. - :rtype: list[str] - """ - return self._matches - - @matches.setter - def matches(self, matches): - """ - Sets the matches of this ComponentSearchResultDTO. - What matched the search from the component. - - :param matches: The matches of this ComponentSearchResultDTO. - :type: list[str] - """ - - self._matches = matches - def to_dict(self): """ Returns the model properties as a dict diff --git a/nipyapi/nifi/models/component_state_dto.py b/nipyapi/nifi/models/component_state_dto.py index b0085988..21f99687 100644 --- a/nipyapi/nifi/models/component_state_dto.py +++ b/nipyapi/nifi/models/component_state_dto.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,37 +27,56 @@ class ComponentStateDTO(object): and the value is json key in definition. """ swagger_types = { - 'component_id': 'str', - 'state_description': 'str', 'cluster_state': 'StateMapDTO', - 'local_state': 'StateMapDTO' - } +'component_id': 'str', +'local_state': 'StateMapDTO', +'state_description': 'str' } attribute_map = { - 'component_id': 'componentId', - 'state_description': 'stateDescription', 'cluster_state': 'clusterState', - 'local_state': 'localState' - } +'component_id': 'componentId', +'local_state': 'localState', +'state_description': 'stateDescription' } - def __init__(self, component_id=None, state_description=None, cluster_state=None, local_state=None): + def __init__(self, cluster_state=None, component_id=None, local_state=None, state_description=None): """ ComponentStateDTO - a model defined in Swagger """ - self._component_id = None - self._state_description = None self._cluster_state = None + self._component_id = None self._local_state = None + self._state_description = None - if component_id is not None: - self.component_id = component_id - if state_description is not None: - self.state_description = state_description if cluster_state is not None: self.cluster_state = cluster_state + if component_id is not None: + self.component_id = component_id if local_state is not None: self.local_state = local_state + if state_description is not None: + self.state_description = state_description + + @property + def cluster_state(self): + """ + Gets the cluster_state of this ComponentStateDTO. + + :return: The cluster_state of this ComponentStateDTO. + :rtype: StateMapDTO + """ + return self._cluster_state + + @cluster_state.setter + def cluster_state(self, cluster_state): + """ + Sets the cluster_state of this ComponentStateDTO. + + :param cluster_state: The cluster_state of this ComponentStateDTO. + :type: StateMapDTO + """ + + self._cluster_state = cluster_state @property def component_id(self): @@ -83,6 +101,27 @@ def component_id(self, component_id): self._component_id = component_id + @property + def local_state(self): + """ + Gets the local_state of this ComponentStateDTO. + + :return: The local_state of this ComponentStateDTO. + :rtype: StateMapDTO + """ + return self._local_state + + @local_state.setter + def local_state(self, local_state): + """ + Sets the local_state of this ComponentStateDTO. + + :param local_state: The local_state of this ComponentStateDTO. + :type: StateMapDTO + """ + + self._local_state = local_state + @property def state_description(self): """ @@ -106,52 +145,6 @@ def state_description(self, state_description): self._state_description = state_description - @property - def cluster_state(self): - """ - Gets the cluster_state of this ComponentStateDTO. - The cluster state for this component, or null if this NiFi is a standalone instance. - - :return: The cluster_state of this ComponentStateDTO. - :rtype: StateMapDTO - """ - return self._cluster_state - - @cluster_state.setter - def cluster_state(self, cluster_state): - """ - Sets the cluster_state of this ComponentStateDTO. - The cluster state for this component, or null if this NiFi is a standalone instance. - - :param cluster_state: The cluster_state of this ComponentStateDTO. - :type: StateMapDTO - """ - - self._cluster_state = cluster_state - - @property - def local_state(self): - """ - Gets the local_state of this ComponentStateDTO. - The local state for this component. - - :return: The local_state of this ComponentStateDTO. - :rtype: StateMapDTO - """ - return self._local_state - - @local_state.setter - def local_state(self, local_state): - """ - Sets the local_state of this ComponentStateDTO. - The local state for this component. - - :param local_state: The local_state of this ComponentStateDTO. - :type: StateMapDTO - """ - - self._local_state = local_state - def to_dict(self): """ Returns the model properties as a dict diff --git a/nipyapi/nifi/models/component_state_entity.py b/nipyapi/nifi/models/component_state_entity.py index db337725..b9b5826a 100644 --- a/nipyapi/nifi/models/component_state_entity.py +++ b/nipyapi/nifi/models/component_state_entity.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,12 +27,10 @@ class ComponentStateEntity(object): and the value is json key in definition. """ swagger_types = { - 'component_state': 'ComponentStateDTO' - } + 'component_state': 'ComponentStateDTO' } attribute_map = { - 'component_state': 'componentState' - } + 'component_state': 'componentState' } def __init__(self, component_state=None): """ @@ -49,7 +46,6 @@ def __init__(self, component_state=None): def component_state(self): """ Gets the component_state of this ComponentStateEntity. - The component state. :return: The component_state of this ComponentStateEntity. :rtype: ComponentStateDTO @@ -60,7 +56,6 @@ def component_state(self): def component_state(self, component_state): """ Sets the component_state of this ComponentStateEntity. - The component state. :param component_state: The component_state of this ComponentStateEntity. :type: ComponentStateDTO diff --git a/nipyapi/nifi/models/component_validation_result_dto.py b/nipyapi/nifi/models/component_validation_result_dto.py index 7ad7db35..8fdc650c 100644 --- a/nipyapi/nifi/models/component_validation_result_dto.py +++ b/nipyapi/nifi/models/component_validation_result_dto.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,90 +27,111 @@ class ComponentValidationResultDTO(object): and the value is json key in definition. """ swagger_types = { - 'process_group_id': 'str', - 'id': 'str', - 'reference_type': 'str', - 'name': 'str', - 'state': 'str', 'active_thread_count': 'int', - 'validation_errors': 'list[str]', - 'currently_valid': 'bool', - 'results_valid': 'bool', - 'resultant_validation_errors': 'list[str]' - } +'currently_valid': 'bool', +'id': 'str', +'name': 'str', +'process_group_id': 'str', +'reference_type': 'str', +'resultant_validation_errors': 'list[str]', +'results_valid': 'bool', +'state': 'str', +'validation_errors': 'list[str]' } attribute_map = { - 'process_group_id': 'processGroupId', - 'id': 'id', - 'reference_type': 'referenceType', - 'name': 'name', - 'state': 'state', 'active_thread_count': 'activeThreadCount', - 'validation_errors': 'validationErrors', - 'currently_valid': 'currentlyValid', - 'results_valid': 'resultsValid', - 'resultant_validation_errors': 'resultantValidationErrors' - } - - def __init__(self, process_group_id=None, id=None, reference_type=None, name=None, state=None, active_thread_count=None, validation_errors=None, currently_valid=None, results_valid=None, resultant_validation_errors=None): +'currently_valid': 'currentlyValid', +'id': 'id', +'name': 'name', +'process_group_id': 'processGroupId', +'reference_type': 'referenceType', +'resultant_validation_errors': 'resultantValidationErrors', +'results_valid': 'resultsValid', +'state': 'state', +'validation_errors': 'validationErrors' } + + def __init__(self, active_thread_count=None, currently_valid=None, id=None, name=None, process_group_id=None, reference_type=None, resultant_validation_errors=None, results_valid=None, state=None, validation_errors=None): """ ComponentValidationResultDTO - a model defined in Swagger """ - self._process_group_id = None + self._active_thread_count = None + self._currently_valid = None self._id = None - self._reference_type = None self._name = None + self._process_group_id = None + self._reference_type = None + self._resultant_validation_errors = None + self._results_valid = None self._state = None - self._active_thread_count = None self._validation_errors = None - self._currently_valid = None - self._results_valid = None - self._resultant_validation_errors = None - if process_group_id is not None: - self.process_group_id = process_group_id + if active_thread_count is not None: + self.active_thread_count = active_thread_count + if currently_valid is not None: + self.currently_valid = currently_valid if id is not None: self.id = id - if reference_type is not None: - self.reference_type = reference_type if name is not None: self.name = name + if process_group_id is not None: + self.process_group_id = process_group_id + if reference_type is not None: + self.reference_type = reference_type + if resultant_validation_errors is not None: + self.resultant_validation_errors = resultant_validation_errors + if results_valid is not None: + self.results_valid = results_valid if state is not None: self.state = state - if active_thread_count is not None: - self.active_thread_count = active_thread_count if validation_errors is not None: self.validation_errors = validation_errors - if currently_valid is not None: - self.currently_valid = currently_valid - if results_valid is not None: - self.results_valid = results_valid - if resultant_validation_errors is not None: - self.resultant_validation_errors = resultant_validation_errors @property - def process_group_id(self): + def active_thread_count(self): """ - Gets the process_group_id of this ComponentValidationResultDTO. - The UUID of the Process Group that this component is in + Gets the active_thread_count of this ComponentValidationResultDTO. + The number of active threads for the referencing component. - :return: The process_group_id of this ComponentValidationResultDTO. - :rtype: str + :return: The active_thread_count of this ComponentValidationResultDTO. + :rtype: int """ - return self._process_group_id + return self._active_thread_count - @process_group_id.setter - def process_group_id(self, process_group_id): + @active_thread_count.setter + def active_thread_count(self, active_thread_count): """ - Sets the process_group_id of this ComponentValidationResultDTO. - The UUID of the Process Group that this component is in + Sets the active_thread_count of this ComponentValidationResultDTO. + The number of active threads for the referencing component. - :param process_group_id: The process_group_id of this ComponentValidationResultDTO. - :type: str + :param active_thread_count: The active_thread_count of this ComponentValidationResultDTO. + :type: int """ - self._process_group_id = process_group_id + self._active_thread_count = active_thread_count + + @property + def currently_valid(self): + """ + Gets the currently_valid of this ComponentValidationResultDTO. + Whether or not the component is currently valid + + :return: The currently_valid of this ComponentValidationResultDTO. + :rtype: bool + """ + return self._currently_valid + + @currently_valid.setter + def currently_valid(self, currently_valid): + """ + Sets the currently_valid of this ComponentValidationResultDTO. + Whether or not the component is currently valid + + :param currently_valid: The currently_valid of this ComponentValidationResultDTO. + :type: bool + """ + + self._currently_valid = currently_valid @property def id(self): @@ -136,35 +156,6 @@ def id(self, id): self._id = id - @property - def reference_type(self): - """ - Gets the reference_type of this ComponentValidationResultDTO. - The type of this component - - :return: The reference_type of this ComponentValidationResultDTO. - :rtype: str - """ - return self._reference_type - - @reference_type.setter - def reference_type(self, reference_type): - """ - Sets the reference_type of this ComponentValidationResultDTO. - The type of this component - - :param reference_type: The reference_type of this ComponentValidationResultDTO. - :type: str - """ - allowed_values = ["PROCESSOR", "CONTROLLER_SERVICE", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT"] - if reference_type not in allowed_values: - raise ValueError( - "Invalid value for `reference_type` ({0}), must be one of {1}" - .format(reference_type, allowed_values) - ) - - self._reference_type = reference_type - @property def name(self): """ @@ -189,96 +180,79 @@ def name(self, name): self._name = name @property - def state(self): + def process_group_id(self): """ - Gets the state of this ComponentValidationResultDTO. - The scheduled state of a processor or reporting task referencing a controller service. If this component is another controller service, this field represents the controller service state. + Gets the process_group_id of this ComponentValidationResultDTO. + The UUID of the Process Group that this component is in - :return: The state of this ComponentValidationResultDTO. + :return: The process_group_id of this ComponentValidationResultDTO. :rtype: str """ - return self._state + return self._process_group_id - @state.setter - def state(self, state): + @process_group_id.setter + def process_group_id(self, process_group_id): """ - Sets the state of this ComponentValidationResultDTO. - The scheduled state of a processor or reporting task referencing a controller service. If this component is another controller service, this field represents the controller service state. + Sets the process_group_id of this ComponentValidationResultDTO. + The UUID of the Process Group that this component is in - :param state: The state of this ComponentValidationResultDTO. + :param process_group_id: The process_group_id of this ComponentValidationResultDTO. :type: str """ - self._state = state + self._process_group_id = process_group_id @property - def active_thread_count(self): + def reference_type(self): """ - Gets the active_thread_count of this ComponentValidationResultDTO. - The number of active threads for the referencing component. + Gets the reference_type of this ComponentValidationResultDTO. + The type of this component - :return: The active_thread_count of this ComponentValidationResultDTO. - :rtype: int + :return: The reference_type of this ComponentValidationResultDTO. + :rtype: str """ - return self._active_thread_count + return self._reference_type - @active_thread_count.setter - def active_thread_count(self, active_thread_count): + @reference_type.setter + def reference_type(self, reference_type): """ - Sets the active_thread_count of this ComponentValidationResultDTO. - The number of active threads for the referencing component. + Sets the reference_type of this ComponentValidationResultDTO. + The type of this component - :param active_thread_count: The active_thread_count of this ComponentValidationResultDTO. - :type: int + :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) + ) - self._active_thread_count = active_thread_count + self._reference_type = reference_type @property - def validation_errors(self): + def resultant_validation_errors(self): """ - Gets the validation_errors of this ComponentValidationResultDTO. - The validation errors for the component. + Gets the resultant_validation_errors of this ComponentValidationResultDTO. + The validation errors that will apply to the component if the Parameter Context is changed - :return: The validation_errors of this ComponentValidationResultDTO. + :return: The resultant_validation_errors of this ComponentValidationResultDTO. :rtype: list[str] """ - return self._validation_errors + return self._resultant_validation_errors - @validation_errors.setter - def validation_errors(self, validation_errors): + @resultant_validation_errors.setter + def resultant_validation_errors(self, resultant_validation_errors): """ - Sets the validation_errors of this ComponentValidationResultDTO. - The validation errors for the component. + Sets the resultant_validation_errors of this ComponentValidationResultDTO. + The validation errors that will apply to the component if the Parameter Context is changed - :param validation_errors: The validation_errors of this ComponentValidationResultDTO. + :param resultant_validation_errors: The resultant_validation_errors of this ComponentValidationResultDTO. :type: list[str] """ - self._validation_errors = validation_errors - - @property - def currently_valid(self): - """ - Gets the currently_valid of this ComponentValidationResultDTO. - Whether or not the component is currently valid - - :return: The currently_valid of this ComponentValidationResultDTO. - :rtype: bool - """ - return self._currently_valid - - @currently_valid.setter - def currently_valid(self, currently_valid): - """ - Sets the currently_valid of this ComponentValidationResultDTO. - Whether or not the component is currently valid - - :param currently_valid: The currently_valid of this ComponentValidationResultDTO. - :type: bool - """ - - self._currently_valid = currently_valid + self._resultant_validation_errors = resultant_validation_errors @property def results_valid(self): @@ -304,27 +278,50 @@ def results_valid(self, results_valid): self._results_valid = results_valid @property - def resultant_validation_errors(self): + def state(self): """ - Gets the resultant_validation_errors of this ComponentValidationResultDTO. - The validation errors that will apply to the component if the Parameter Context is changed + Gets the state of this ComponentValidationResultDTO. + The scheduled state of a processor or reporting task referencing a controller service. If this component is another controller service, this field represents the controller service state. - :return: The resultant_validation_errors of this ComponentValidationResultDTO. + :return: The state of this ComponentValidationResultDTO. + :rtype: str + """ + return self._state + + @state.setter + def state(self, state): + """ + Sets the state of this ComponentValidationResultDTO. + The scheduled state of a processor or reporting task referencing a controller service. If this component is another controller service, this field represents the controller service state. + + :param state: The state of this ComponentValidationResultDTO. + :type: str + """ + + self._state = state + + @property + def validation_errors(self): + """ + Gets the validation_errors of this ComponentValidationResultDTO. + The validation errors for the component. + + :return: The validation_errors of this ComponentValidationResultDTO. :rtype: list[str] """ - return self._resultant_validation_errors + return self._validation_errors - @resultant_validation_errors.setter - def resultant_validation_errors(self, resultant_validation_errors): + @validation_errors.setter + def validation_errors(self, validation_errors): """ - Sets the resultant_validation_errors of this ComponentValidationResultDTO. - The validation errors that will apply to the component if the Parameter Context is changed + Sets the validation_errors of this ComponentValidationResultDTO. + The validation errors for the component. - :param resultant_validation_errors: The resultant_validation_errors of this ComponentValidationResultDTO. + :param validation_errors: The validation_errors of this ComponentValidationResultDTO. :type: list[str] """ - self._resultant_validation_errors = resultant_validation_errors + self._validation_errors = validation_errors def to_dict(self): """ diff --git a/nipyapi/nifi/models/component_validation_result_entity.py b/nipyapi/nifi/models/component_validation_result_entity.py index 0ee92aa7..b9e1055d 100644 --- a/nipyapi/nifi/models/component_validation_result_entity.py +++ b/nipyapi/nifi/models/component_validation_result_entity.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,155 +27,150 @@ class ComponentValidationResultEntity(object): and the value is json key in definition. """ swagger_types = { - 'revision': 'RevisionDTO', - 'id': 'str', - 'uri': 'str', - 'position': 'PositionDTO', - 'permissions': 'PermissionsDTO', 'bulletins': 'list[BulletinEntity]', - 'disconnected_node_acknowledged': 'bool', - 'component': 'ComponentValidationResultDTO' - } +'component': 'ComponentValidationResultDTO', +'disconnected_node_acknowledged': 'bool', +'id': 'str', +'permissions': 'PermissionsDTO', +'position': 'PositionDTO', +'revision': 'RevisionDTO', +'uri': 'str' } attribute_map = { - 'revision': 'revision', - 'id': 'id', - 'uri': 'uri', - 'position': 'position', - 'permissions': 'permissions', 'bulletins': 'bulletins', - 'disconnected_node_acknowledged': 'disconnectedNodeAcknowledged', - 'component': 'component' - } +'component': 'component', +'disconnected_node_acknowledged': 'disconnectedNodeAcknowledged', +'id': 'id', +'permissions': 'permissions', +'position': 'position', +'revision': 'revision', +'uri': 'uri' } - def __init__(self, revision=None, id=None, uri=None, position=None, permissions=None, bulletins=None, disconnected_node_acknowledged=None, component=None): + def __init__(self, bulletins=None, component=None, disconnected_node_acknowledged=None, id=None, permissions=None, position=None, revision=None, uri=None): """ ComponentValidationResultEntity - a model defined in Swagger """ - self._revision = None - self._id = None - self._uri = None - self._position = None - self._permissions = None self._bulletins = None - self._disconnected_node_acknowledged = None self._component = None + self._disconnected_node_acknowledged = None + self._id = None + self._permissions = None + self._position = None + self._revision = None + self._uri = None - if revision is not None: - self.revision = revision - if id is not None: - self.id = id - if uri is not None: - self.uri = uri - if position is not None: - self.position = position - if permissions is not None: - self.permissions = permissions if bulletins is not None: self.bulletins = bulletins - if disconnected_node_acknowledged is not None: - self.disconnected_node_acknowledged = disconnected_node_acknowledged if component is not None: self.component = component + if disconnected_node_acknowledged is not None: + self.disconnected_node_acknowledged = disconnected_node_acknowledged + if id is not None: + self.id = id + if permissions is not None: + self.permissions = permissions + if position is not None: + self.position = position + if revision is not None: + self.revision = revision + if uri is not None: + self.uri = uri @property - def revision(self): + def bulletins(self): """ - Gets the revision of this ComponentValidationResultEntity. - The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses. + Gets the bulletins of this ComponentValidationResultEntity. + The bulletins for this component. - :return: The revision of this ComponentValidationResultEntity. - :rtype: RevisionDTO + :return: The bulletins of this ComponentValidationResultEntity. + :rtype: list[BulletinEntity] """ - return self._revision + return self._bulletins - @revision.setter - def revision(self, revision): + @bulletins.setter + def bulletins(self, bulletins): """ - Sets the revision of this ComponentValidationResultEntity. - The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses. + Sets the bulletins of this ComponentValidationResultEntity. + The bulletins for this component. - :param revision: The revision of this ComponentValidationResultEntity. - :type: RevisionDTO + :param bulletins: The bulletins of this ComponentValidationResultEntity. + :type: list[BulletinEntity] """ - self._revision = revision + self._bulletins = bulletins @property - def id(self): + def component(self): """ - Gets the id of this ComponentValidationResultEntity. - The id of the component. + Gets the component of this ComponentValidationResultEntity. - :return: The id of this ComponentValidationResultEntity. - :rtype: str + :return: The component of this ComponentValidationResultEntity. + :rtype: ComponentValidationResultDTO """ - return self._id + return self._component - @id.setter - def id(self, id): + @component.setter + def component(self, component): """ - Sets the id of this ComponentValidationResultEntity. - The id of the component. + Sets the component of this ComponentValidationResultEntity. - :param id: The id of this ComponentValidationResultEntity. - :type: str + :param component: The component of this ComponentValidationResultEntity. + :type: ComponentValidationResultDTO """ - self._id = id + self._component = component @property - def uri(self): + def disconnected_node_acknowledged(self): """ - Gets the uri of this ComponentValidationResultEntity. - The URI for futures requests to the component. + Gets the disconnected_node_acknowledged of this ComponentValidationResultEntity. + Acknowledges that this node is disconnected to allow for mutable requests to proceed. - :return: The uri of this ComponentValidationResultEntity. - :rtype: str + :return: The disconnected_node_acknowledged of this ComponentValidationResultEntity. + :rtype: bool """ - return self._uri + return self._disconnected_node_acknowledged - @uri.setter - def uri(self, uri): + @disconnected_node_acknowledged.setter + def disconnected_node_acknowledged(self, disconnected_node_acknowledged): """ - Sets the uri of this ComponentValidationResultEntity. - The URI for futures requests to the component. + Sets the disconnected_node_acknowledged of this ComponentValidationResultEntity. + Acknowledges that this node is disconnected to allow for mutable requests to proceed. - :param uri: The uri of this ComponentValidationResultEntity. - :type: str + :param disconnected_node_acknowledged: The disconnected_node_acknowledged of this ComponentValidationResultEntity. + :type: bool """ - self._uri = uri + self._disconnected_node_acknowledged = disconnected_node_acknowledged @property - def position(self): + def id(self): """ - Gets the position of this ComponentValidationResultEntity. - The position of this component in the UI if applicable. + Gets the id of this ComponentValidationResultEntity. + The id of the component. - :return: The position of this ComponentValidationResultEntity. - :rtype: PositionDTO + :return: The id of this ComponentValidationResultEntity. + :rtype: str """ - return self._position + return self._id - @position.setter - def position(self, position): + @id.setter + def id(self, id): """ - Sets the position of this ComponentValidationResultEntity. - The position of this component in the UI if applicable. + Sets the id of this ComponentValidationResultEntity. + The id of the component. - :param position: The position of this ComponentValidationResultEntity. - :type: PositionDTO + :param id: The id of this ComponentValidationResultEntity. + :type: str """ - self._position = position + self._id = id @property def permissions(self): """ Gets the permissions of this ComponentValidationResultEntity. - The permissions for this component. :return: The permissions of this ComponentValidationResultEntity. :rtype: PermissionsDTO @@ -187,7 +181,6 @@ def permissions(self): def permissions(self, permissions): """ Sets the permissions of this ComponentValidationResultEntity. - The permissions for this component. :param permissions: The permissions of this ComponentValidationResultEntity. :type: PermissionsDTO @@ -196,71 +189,69 @@ def permissions(self, permissions): self._permissions = permissions @property - def bulletins(self): + def position(self): """ - Gets the bulletins of this ComponentValidationResultEntity. - The bulletins for this component. + Gets the position of this ComponentValidationResultEntity. - :return: The bulletins of this ComponentValidationResultEntity. - :rtype: list[BulletinEntity] + :return: The position of this ComponentValidationResultEntity. + :rtype: PositionDTO """ - return self._bulletins + return self._position - @bulletins.setter - def bulletins(self, bulletins): + @position.setter + def position(self, position): """ - Sets the bulletins of this ComponentValidationResultEntity. - The bulletins for this component. + Sets the position of this ComponentValidationResultEntity. - :param bulletins: The bulletins of this ComponentValidationResultEntity. - :type: list[BulletinEntity] + :param position: The position of this ComponentValidationResultEntity. + :type: PositionDTO """ - self._bulletins = bulletins + self._position = position @property - def disconnected_node_acknowledged(self): + def revision(self): """ - Gets the disconnected_node_acknowledged of this ComponentValidationResultEntity. - Acknowledges that this node is disconnected to allow for mutable requests to proceed. + Gets the revision of this ComponentValidationResultEntity. - :return: The disconnected_node_acknowledged of this ComponentValidationResultEntity. - :rtype: bool + :return: The revision of this ComponentValidationResultEntity. + :rtype: RevisionDTO """ - return self._disconnected_node_acknowledged + return self._revision - @disconnected_node_acknowledged.setter - def disconnected_node_acknowledged(self, disconnected_node_acknowledged): + @revision.setter + def revision(self, revision): """ - Sets the disconnected_node_acknowledged of this ComponentValidationResultEntity. - Acknowledges that this node is disconnected to allow for mutable requests to proceed. + Sets the revision of this ComponentValidationResultEntity. - :param disconnected_node_acknowledged: The disconnected_node_acknowledged of this ComponentValidationResultEntity. - :type: bool + :param revision: The revision of this ComponentValidationResultEntity. + :type: RevisionDTO """ - self._disconnected_node_acknowledged = disconnected_node_acknowledged + self._revision = revision @property - def component(self): + def uri(self): """ - Gets the component of this ComponentValidationResultEntity. + Gets the uri of this ComponentValidationResultEntity. + The URI for futures requests to the component. - :return: The component of this ComponentValidationResultEntity. - :rtype: ComponentValidationResultDTO + :return: The uri of this ComponentValidationResultEntity. + :rtype: str """ - return self._component + return self._uri - @component.setter - def component(self, component): + @uri.setter + def uri(self, uri): """ - Sets the component of this ComponentValidationResultEntity. + Sets the uri of this ComponentValidationResultEntity. + The URI for futures requests to the component. - :param component: The component of this ComponentValidationResultEntity. - :type: ComponentValidationResultDTO + :param uri: The uri of this ComponentValidationResultEntity. + :type: str """ - self._component = component + self._uri = uri def to_dict(self): """ diff --git a/nipyapi/nifi/models/component_validation_results_entity.py b/nipyapi/nifi/models/component_validation_results_entity.py index 9ee7dc4c..254830c0 100644 --- a/nipyapi/nifi/models/component_validation_results_entity.py +++ b/nipyapi/nifi/models/component_validation_results_entity.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,12 +27,10 @@ class ComponentValidationResultsEntity(object): and the value is json key in definition. """ swagger_types = { - 'validation_results': 'list[ComponentValidationResultEntity]' - } + 'validation_results': 'list[ComponentValidationResultEntity]' } attribute_map = { - 'validation_results': 'validationResults' - } + 'validation_results': 'validationResults' } def __init__(self, validation_results=None): """ diff --git a/nipyapi/nifi/models/config_verification_result_dto.py b/nipyapi/nifi/models/config_verification_result_dto.py index 75b6cd43..b974aed9 100644 --- a/nipyapi/nifi/models/config_verification_result_dto.py +++ b/nipyapi/nifi/models/config_verification_result_dto.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,32 +27,53 @@ class ConfigVerificationResultDTO(object): and the value is json key in definition. """ swagger_types = { - 'outcome': 'str', - 'verification_step_name': 'str', - 'explanation': 'str' - } + 'explanation': 'str', +'outcome': 'str', +'verification_step_name': 'str' } attribute_map = { - 'outcome': 'outcome', - 'verification_step_name': 'verificationStepName', - 'explanation': 'explanation' - } + 'explanation': 'explanation', +'outcome': 'outcome', +'verification_step_name': 'verificationStepName' } - def __init__(self, outcome=None, verification_step_name=None, explanation=None): + def __init__(self, explanation=None, outcome=None, verification_step_name=None): """ ConfigVerificationResultDTO - a model defined in Swagger """ + self._explanation = None self._outcome = None self._verification_step_name = None - self._explanation = None + if explanation is not None: + self.explanation = explanation if outcome is not None: self.outcome = outcome if verification_step_name is not None: self.verification_step_name = verification_step_name - if explanation is not None: - self.explanation = explanation + + @property + def explanation(self): + """ + Gets the explanation of this ConfigVerificationResultDTO. + An explanation of why the step was or was not successful + + :return: The explanation of this ConfigVerificationResultDTO. + :rtype: str + """ + return self._explanation + + @explanation.setter + def explanation(self, explanation): + """ + Sets the explanation of this ConfigVerificationResultDTO. + An explanation of why the step was or was not successful + + :param explanation: The explanation of this ConfigVerificationResultDTO. + :type: str + """ + + self._explanation = explanation @property def outcome(self): @@ -75,7 +95,7 @@ def outcome(self, outcome): :param outcome: The outcome of this ConfigVerificationResultDTO. :type: str """ - allowed_values = ["SUCCESSFUL", "FAILED", "SKIPPED"] + allowed_values = ["SUCCESSFUL", "FAILED", "SKIPPED", ] if outcome not in allowed_values: raise ValueError( "Invalid value for `outcome` ({0}), must be one of {1}" @@ -107,29 +127,6 @@ def verification_step_name(self, verification_step_name): self._verification_step_name = verification_step_name - @property - def explanation(self): - """ - Gets the explanation of this ConfigVerificationResultDTO. - An explanation of why the step was or was not successful - - :return: The explanation of this ConfigVerificationResultDTO. - :rtype: str - """ - return self._explanation - - @explanation.setter - def explanation(self, explanation): - """ - Sets the explanation of this ConfigVerificationResultDTO. - An explanation of why the step was or was not successful - - :param explanation: The explanation of this ConfigVerificationResultDTO. - :type: str - """ - - self._explanation = explanation - def to_dict(self): """ Returns the model properties as a dict diff --git a/nipyapi/nifi/models/configuration_analysis_dto.py b/nipyapi/nifi/models/configuration_analysis_dto.py index 3def0662..4d90797f 100644 --- a/nipyapi/nifi/models/configuration_analysis_dto.py +++ b/nipyapi/nifi/models/configuration_analysis_dto.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -29,17 +28,15 @@ class ConfigurationAnalysisDTO(object): """ swagger_types = { 'component_id': 'str', - 'properties': 'dict(str, str)', - 'referenced_attributes': 'dict(str, str)', - 'supports_verification': 'bool' - } +'properties': 'dict(str, str)', +'referenced_attributes': 'dict(str, str)', +'supports_verification': 'bool' } attribute_map = { 'component_id': 'componentId', - 'properties': 'properties', - 'referenced_attributes': 'referencedAttributes', - 'supports_verification': 'supportsVerification' - } +'properties': 'properties', +'referenced_attributes': 'referencedAttributes', +'supports_verification': 'supportsVerification' } def __init__(self, component_id=None, properties=None, referenced_attributes=None, supports_verification=None): """ diff --git a/nipyapi/nifi/models/configuration_analysis_entity.py b/nipyapi/nifi/models/configuration_analysis_entity.py index d00f4a75..b199f338 100644 --- a/nipyapi/nifi/models/configuration_analysis_entity.py +++ b/nipyapi/nifi/models/configuration_analysis_entity.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,12 +27,10 @@ class ConfigurationAnalysisEntity(object): and the value is json key in definition. """ swagger_types = { - 'configuration_analysis': 'ConfigurationAnalysisDTO' - } + 'configuration_analysis': 'ConfigurationAnalysisDTO' } attribute_map = { - 'configuration_analysis': 'configurationAnalysis' - } + 'configuration_analysis': 'configurationAnalysis' } def __init__(self, configuration_analysis=None): """ @@ -49,7 +46,6 @@ def __init__(self, configuration_analysis=None): def configuration_analysis(self): """ Gets the configuration_analysis of this ConfigurationAnalysisEntity. - The configuration analysis :return: The configuration_analysis of this ConfigurationAnalysisEntity. :rtype: ConfigurationAnalysisDTO @@ -60,7 +56,6 @@ def configuration_analysis(self): def configuration_analysis(self, configuration_analysis): """ Sets the configuration_analysis of this ConfigurationAnalysisEntity. - The configuration analysis :param configuration_analysis: The configuration_analysis of this ConfigurationAnalysisEntity. :type: ConfigurationAnalysisDTO diff --git a/nipyapi/nifi/models/connectable_component.py b/nipyapi/nifi/models/connectable_component.py index ce4090c1..515a8238 100644 --- a/nipyapi/nifi/models/connectable_component.py +++ b/nipyapi/nifi/models/connectable_component.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,194 +27,189 @@ class ConnectableComponent(object): and the value is json key in definition. """ swagger_types = { - 'id': 'str', - 'type': 'str', - 'group_id': 'str', - 'name': 'str', 'comments': 'str', - 'instance_identifier': 'str' - } +'group_id': 'str', +'id': 'str', +'instance_identifier': 'str', +'name': 'str', +'type': 'str' } attribute_map = { - 'id': 'id', - 'type': 'type', - 'group_id': 'groupId', - 'name': 'name', 'comments': 'comments', - 'instance_identifier': 'instanceIdentifier' - } +'group_id': 'groupId', +'id': 'id', +'instance_identifier': 'instanceIdentifier', +'name': 'name', +'type': 'type' } - def __init__(self, id=None, type=None, group_id=None, name=None, comments=None, instance_identifier=None): + def __init__(self, comments=None, group_id=None, id=None, instance_identifier=None, name=None, type=None): """ ConnectableComponent - a model defined in Swagger """ - self._id = None - self._type = None - self._group_id = None - self._name = None self._comments = None + self._group_id = None + self._id = None self._instance_identifier = None + self._name = None + self._type = None - self.id = id - self.type = type - self.group_id = group_id - if name is not None: - self.name = name if comments is not None: self.comments = comments + if group_id is not None: + self.group_id = group_id + if id is not None: + self.id = id if instance_identifier is not None: self.instance_identifier = instance_identifier + if name is not None: + self.name = name + if type is not None: + self.type = type @property - def id(self): + def comments(self): """ - Gets the id of this ConnectableComponent. - The id of the connectable component. + Gets the comments of this ConnectableComponent. + The comments for the connectable component. - :return: The id of this ConnectableComponent. + :return: The comments of this ConnectableComponent. :rtype: str """ - return self._id + return self._comments - @id.setter - def id(self, id): + @comments.setter + def comments(self, comments): """ - Sets the id of this ConnectableComponent. - The id of the connectable component. + Sets the comments of this ConnectableComponent. + The comments for the connectable component. - :param id: The id of this ConnectableComponent. + :param comments: The comments of this ConnectableComponent. :type: str """ - if id is None: - raise ValueError("Invalid value for `id`, must not be `None`") - self._id = id + self._comments = comments @property - def type(self): + def group_id(self): """ - Gets the type of this ConnectableComponent. - The type of component the connectable is. + Gets the group_id of this ConnectableComponent. + The id of the group that the connectable component resides in - :return: The type of this ConnectableComponent. + :return: The group_id of this ConnectableComponent. :rtype: str """ - return self._type + return self._group_id - @type.setter - def type(self, type): + @group_id.setter + def group_id(self, group_id): """ - Sets the type of this ConnectableComponent. - The type of component the connectable is. + Sets the group_id of this ConnectableComponent. + The id of the group that the connectable component resides in - :param type: The type of this ConnectableComponent. + :param group_id: The group_id of this ConnectableComponent. :type: str """ - 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) - ) - self._type = type + self._group_id = group_id @property - def group_id(self): + def id(self): """ - Gets the group_id of this ConnectableComponent. - The id of the group that the connectable component resides in + Gets the id of this ConnectableComponent. + The id of the connectable component. - :return: The group_id of this ConnectableComponent. + :return: The id of this ConnectableComponent. :rtype: str """ - return self._group_id + return self._id - @group_id.setter - def group_id(self, group_id): + @id.setter + def id(self, id): """ - Sets the group_id of this ConnectableComponent. - The id of the group that the connectable component resides in + Sets the id of this ConnectableComponent. + The id of the connectable component. - :param group_id: The group_id of this ConnectableComponent. + :param id: The id of this ConnectableComponent. :type: str """ - if group_id is None: - raise ValueError("Invalid value for `group_id`, must not be `None`") - self._group_id = group_id + self._id = id @property - def name(self): + def instance_identifier(self): """ - Gets the name of this ConnectableComponent. - The name of the connectable component + Gets the instance_identifier of this ConnectableComponent. + The instance ID of an existing component that is described by this VersionedComponent, or null if this is not mapped to an instantiated component - :return: The name of this ConnectableComponent. + :return: The instance_identifier of this ConnectableComponent. :rtype: str """ - return self._name + return self._instance_identifier - @name.setter - def name(self, name): + @instance_identifier.setter + def instance_identifier(self, instance_identifier): """ - Sets the name of this ConnectableComponent. - The name of the connectable component + Sets the instance_identifier of this ConnectableComponent. + The instance ID of an existing component that is described by this VersionedComponent, or null if this is not mapped to an instantiated component - :param name: The name of this ConnectableComponent. + :param instance_identifier: The instance_identifier of this ConnectableComponent. :type: str """ - self._name = name + self._instance_identifier = instance_identifier @property - def comments(self): + def name(self): """ - Gets the comments of this ConnectableComponent. - The comments for the connectable component. + Gets the name of this ConnectableComponent. + The name of the connectable component - :return: The comments of this ConnectableComponent. + :return: The name of this ConnectableComponent. :rtype: str """ - return self._comments + return self._name - @comments.setter - def comments(self, comments): + @name.setter + def name(self, name): """ - Sets the comments of this ConnectableComponent. - The comments for the connectable component. + Sets the name of this ConnectableComponent. + The name of the connectable component - :param comments: The comments of this ConnectableComponent. + :param name: The name of this ConnectableComponent. :type: str """ - self._comments = comments + self._name = name @property - def instance_identifier(self): + def type(self): """ - Gets the instance_identifier of this ConnectableComponent. - The instance ID of an existing component that is described by this VersionedComponent, or null if this is not mapped to an instantiated component + Gets the type of this ConnectableComponent. + The type of component the connectable is. - :return: The instance_identifier of this ConnectableComponent. + :return: The type of this ConnectableComponent. :rtype: str """ - return self._instance_identifier + return self._type - @instance_identifier.setter - def instance_identifier(self, instance_identifier): + @type.setter + def type(self, type): """ - Sets the instance_identifier of this ConnectableComponent. - The instance ID of an existing component that is described by this VersionedComponent, or null if this is not mapped to an instantiated component + Sets the type of this ConnectableComponent. + The type of component the connectable is. - :param instance_identifier: The instance_identifier of this ConnectableComponent. + :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) + ) - self._instance_identifier = instance_identifier + self._type = type def to_dict(self): """ diff --git a/nipyapi/nifi/models/connectable_dto.py b/nipyapi/nifi/models/connectable_dto.py index b4296904..c9003330 100644 --- a/nipyapi/nifi/models/connectable_dto.py +++ b/nipyapi/nifi/models/connectable_dto.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,138 +27,103 @@ class ConnectableDTO(object): and the value is json key in definition. """ swagger_types = { - 'id': 'str', - 'versioned_component_id': 'str', - 'type': 'str', - 'group_id': 'str', - 'name': 'str', - 'running': 'bool', - 'transmitting': 'bool', - 'exists': 'bool', - 'comments': 'str' - } + 'comments': 'str', +'exists': 'bool', +'group_id': 'str', +'id': 'str', +'name': 'str', +'running': 'bool', +'transmitting': 'bool', +'type': 'str', +'versioned_component_id': 'str' } attribute_map = { - 'id': 'id', - 'versioned_component_id': 'versionedComponentId', - 'type': 'type', - 'group_id': 'groupId', - 'name': 'name', - 'running': 'running', - 'transmitting': 'transmitting', - 'exists': 'exists', - 'comments': 'comments' - } - - def __init__(self, id=None, versioned_component_id=None, type=None, group_id=None, name=None, running=None, transmitting=None, exists=None, comments=None): + 'comments': 'comments', +'exists': 'exists', +'group_id': 'groupId', +'id': 'id', +'name': 'name', +'running': 'running', +'transmitting': 'transmitting', +'type': 'type', +'versioned_component_id': 'versionedComponentId' } + + def __init__(self, comments=None, exists=None, group_id=None, id=None, name=None, running=None, transmitting=None, type=None, versioned_component_id=None): """ ConnectableDTO - a model defined in Swagger """ - self._id = None - self._versioned_component_id = None - self._type = None + self._comments = None + self._exists = None self._group_id = None + self._id = None self._name = None self._running = None self._transmitting = None - self._exists = None - self._comments = None + self._type = None + self._versioned_component_id = None - self.id = id - if versioned_component_id is not None: - self.versioned_component_id = versioned_component_id - self.type = type + if comments is not None: + self.comments = comments + if exists is not None: + self.exists = exists self.group_id = group_id + self.id = id if name is not None: self.name = name if running is not None: self.running = running if transmitting is not None: self.transmitting = transmitting - if exists is not None: - self.exists = exists - if comments is not None: - self.comments = comments - - @property - def id(self): - """ - Gets the id of this ConnectableDTO. - The id of the connectable component. - - :return: The id of this ConnectableDTO. - :rtype: str - """ - return self._id - - @id.setter - def id(self, id): - """ - Sets the id of this ConnectableDTO. - The id of the connectable component. - - :param id: The id of this ConnectableDTO. - :type: str - """ - if id is None: - raise ValueError("Invalid value for `id`, must not be `None`") - - self._id = id + self.type = type + if versioned_component_id is not None: + self.versioned_component_id = versioned_component_id @property - def versioned_component_id(self): + def comments(self): """ - Gets the versioned_component_id of this ConnectableDTO. - The ID of the corresponding component that is under version control + Gets the comments of this ConnectableDTO. + The comments for the connectable component. - :return: The versioned_component_id of this ConnectableDTO. + :return: The comments of this ConnectableDTO. :rtype: str """ - return self._versioned_component_id + return self._comments - @versioned_component_id.setter - def versioned_component_id(self, versioned_component_id): + @comments.setter + def comments(self, comments): """ - Sets the versioned_component_id of this ConnectableDTO. - The ID of the corresponding component that is under version control + Sets the comments of this ConnectableDTO. + The comments for the connectable component. - :param versioned_component_id: The versioned_component_id of this ConnectableDTO. + :param comments: The comments of this ConnectableDTO. :type: str """ - self._versioned_component_id = versioned_component_id + self._comments = comments @property - def type(self): + def exists(self): """ - Gets the type of this ConnectableDTO. - The type of component the connectable is. + Gets the exists of this ConnectableDTO. + If the connectable component represents a remote port, indicates if the target exists. - :return: The type of this ConnectableDTO. - :rtype: str + :return: The exists of this ConnectableDTO. + :rtype: bool """ - return self._type + return self._exists - @type.setter - def type(self, type): + @exists.setter + def exists(self, exists): """ - Sets the type of this ConnectableDTO. - The type of component the connectable is. + Sets the exists of this ConnectableDTO. + If the connectable component represents a remote port, indicates if the target exists. - :param type: The type of this ConnectableDTO. - :type: str + :param exists: The exists of this ConnectableDTO. + :type: bool """ - 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) - ) - self._type = type + self._exists = exists @property def group_id(self): @@ -186,6 +150,31 @@ def group_id(self, group_id): self._group_id = group_id + @property + def id(self): + """ + Gets the id of this ConnectableDTO. + The id of the connectable component. + + :return: The id of this ConnectableDTO. + :rtype: str + """ + return self._id + + @id.setter + def id(self, id): + """ + Sets the id of this ConnectableDTO. + The id of the connectable component. + + :param id: The id of this ConnectableDTO. + :type: str + """ + if id is None: + raise ValueError("Invalid value for `id`, must not be `None`") + + self._id = id + @property def name(self): """ @@ -256,50 +245,58 @@ def transmitting(self, transmitting): self._transmitting = transmitting @property - def exists(self): + def type(self): """ - Gets the exists of this ConnectableDTO. - If the connectable component represents a remote port, indicates if the target exists. + Gets the type of this ConnectableDTO. + The type of component the connectable is. - :return: The exists of this ConnectableDTO. - :rtype: bool + :return: The type of this ConnectableDTO. + :rtype: str """ - return self._exists + return self._type - @exists.setter - def exists(self, exists): + @type.setter + def type(self, type): """ - Sets the exists of this ConnectableDTO. - If the connectable component represents a remote port, indicates if the target exists. + Sets the type of this ConnectableDTO. + The type of component the connectable is. - :param exists: The exists of this ConnectableDTO. - :type: bool + :param type: The type of this ConnectableDTO. + :type: str """ + 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) + ) - self._exists = exists + self._type = type @property - def comments(self): + def versioned_component_id(self): """ - Gets the comments of this ConnectableDTO. - The comments for the connectable component. + Gets the versioned_component_id of this ConnectableDTO. + The ID of the corresponding component that is under version control - :return: The comments of this ConnectableDTO. + :return: The versioned_component_id of this ConnectableDTO. :rtype: str """ - return self._comments + return self._versioned_component_id - @comments.setter - def comments(self, comments): + @versioned_component_id.setter + def versioned_component_id(self, versioned_component_id): """ - Sets the comments of this ConnectableDTO. - The comments for the connectable component. + Sets the versioned_component_id of this ConnectableDTO. + The ID of the corresponding component that is under version control - :param comments: The comments of this ConnectableDTO. + :param versioned_component_id: The versioned_component_id of this ConnectableDTO. :type: str """ - self._comments = comments + self._versioned_component_id = versioned_component_id def to_dict(self): """ diff --git a/nipyapi/nifi/models/connection_diagnostics_dto.py b/nipyapi/nifi/models/connection_diagnostics_dto.py deleted file mode 100644 index 09b5a6f3..00000000 --- a/nipyapi/nifi/models/connection_diagnostics_dto.py +++ /dev/null @@ -1,178 +0,0 @@ -""" - NiFi Rest API - - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - - OpenAPI spec version: 1.28.1 - Contact: dev@nifi.apache.org - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - - -from pprint import pformat -import re - - -class ConnectionDiagnosticsDTO(object): - """ - NOTE: This class is auto generated by the swagger code generator program. - Do not edit the class manually. - """ - - - """ - Attributes: - swagger_types (dict): The key is attribute name - and the value is attribute type. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - """ - swagger_types = { - 'connection': 'ConnectionDTO', - 'aggregate_snapshot': 'ConnectionDiagnosticsSnapshotDTO', - 'node_snapshots': 'list[ConnectionDiagnosticsSnapshotDTO]' - } - - attribute_map = { - 'connection': 'connection', - 'aggregate_snapshot': 'aggregateSnapshot', - 'node_snapshots': 'nodeSnapshots' - } - - def __init__(self, connection=None, aggregate_snapshot=None, node_snapshots=None): - """ - ConnectionDiagnosticsDTO - a model defined in Swagger - """ - - self._connection = None - self._aggregate_snapshot = None - self._node_snapshots = None - - if connection is not None: - self.connection = connection - if aggregate_snapshot is not None: - self.aggregate_snapshot = aggregate_snapshot - if node_snapshots is not None: - self.node_snapshots = node_snapshots - - @property - def connection(self): - """ - Gets the connection of this ConnectionDiagnosticsDTO. - Details about the connection - - :return: The connection of this ConnectionDiagnosticsDTO. - :rtype: ConnectionDTO - """ - return self._connection - - @connection.setter - def connection(self, connection): - """ - Sets the connection of this ConnectionDiagnosticsDTO. - Details about the connection - - :param connection: The connection of this ConnectionDiagnosticsDTO. - :type: ConnectionDTO - """ - - self._connection = connection - - @property - def aggregate_snapshot(self): - """ - Gets the aggregate_snapshot of this ConnectionDiagnosticsDTO. - Aggregate values for all nodes in the cluster, or for this instance if not clustered - - :return: The aggregate_snapshot of this ConnectionDiagnosticsDTO. - :rtype: ConnectionDiagnosticsSnapshotDTO - """ - return self._aggregate_snapshot - - @aggregate_snapshot.setter - def aggregate_snapshot(self, aggregate_snapshot): - """ - Sets the aggregate_snapshot of this ConnectionDiagnosticsDTO. - Aggregate values for all nodes in the cluster, or for this instance if not clustered - - :param aggregate_snapshot: The aggregate_snapshot of this ConnectionDiagnosticsDTO. - :type: ConnectionDiagnosticsSnapshotDTO - """ - - self._aggregate_snapshot = aggregate_snapshot - - @property - def node_snapshots(self): - """ - Gets the node_snapshots of this ConnectionDiagnosticsDTO. - A list of values for each node in the cluster, if clustered. - - :return: The node_snapshots of this ConnectionDiagnosticsDTO. - :rtype: list[ConnectionDiagnosticsSnapshotDTO] - """ - return self._node_snapshots - - @node_snapshots.setter - def node_snapshots(self, node_snapshots): - """ - Sets the node_snapshots of this ConnectionDiagnosticsDTO. - A list of values for each node in the cluster, if clustered. - - :param node_snapshots: The node_snapshots of this ConnectionDiagnosticsDTO. - :type: list[ConnectionDiagnosticsSnapshotDTO] - """ - - self._node_snapshots = node_snapshots - - 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, ConnectionDiagnosticsDTO): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other): - """ - Returns true if both objects are not equal - """ - return not self == other diff --git a/nipyapi/nifi/models/connection_diagnostics_snapshot_dto.py b/nipyapi/nifi/models/connection_diagnostics_snapshot_dto.py deleted file mode 100644 index 207a4514..00000000 --- a/nipyapi/nifi/models/connection_diagnostics_snapshot_dto.py +++ /dev/null @@ -1,232 +0,0 @@ -""" - NiFi Rest API - - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - - OpenAPI spec version: 1.28.1 - Contact: dev@nifi.apache.org - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - - -from pprint import pformat -import re - - -class ConnectionDiagnosticsSnapshotDTO(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 = { - 'total_flow_file_count': 'int', - 'total_byte_count': 'int', - 'node_identifier': 'str', - 'local_queue_partition': 'LocalQueuePartitionDTO', - 'remote_queue_partitions': 'list[RemoteQueuePartitionDTO]' - } - - attribute_map = { - 'total_flow_file_count': 'totalFlowFileCount', - 'total_byte_count': 'totalByteCount', - 'node_identifier': 'nodeIdentifier', - 'local_queue_partition': 'localQueuePartition', - 'remote_queue_partitions': 'remoteQueuePartitions' - } - - def __init__(self, total_flow_file_count=None, total_byte_count=None, node_identifier=None, local_queue_partition=None, remote_queue_partitions=None): - """ - ConnectionDiagnosticsSnapshotDTO - a model defined in Swagger - """ - - self._total_flow_file_count = None - self._total_byte_count = None - self._node_identifier = None - self._local_queue_partition = None - self._remote_queue_partitions = None - - if total_flow_file_count is not None: - self.total_flow_file_count = total_flow_file_count - if total_byte_count is not None: - self.total_byte_count = total_byte_count - if node_identifier is not None: - self.node_identifier = node_identifier - if local_queue_partition is not None: - self.local_queue_partition = local_queue_partition - if remote_queue_partitions is not None: - self.remote_queue_partitions = remote_queue_partitions - - @property - def total_flow_file_count(self): - """ - Gets the total_flow_file_count of this ConnectionDiagnosticsSnapshotDTO. - Total number of FlowFiles owned by the Connection - - :return: The total_flow_file_count of this ConnectionDiagnosticsSnapshotDTO. - :rtype: int - """ - return self._total_flow_file_count - - @total_flow_file_count.setter - def total_flow_file_count(self, total_flow_file_count): - """ - Sets the total_flow_file_count of this ConnectionDiagnosticsSnapshotDTO. - Total number of FlowFiles owned by the Connection - - :param total_flow_file_count: The total_flow_file_count of this ConnectionDiagnosticsSnapshotDTO. - :type: int - """ - - self._total_flow_file_count = total_flow_file_count - - @property - def total_byte_count(self): - """ - Gets the total_byte_count of this ConnectionDiagnosticsSnapshotDTO. - Total number of bytes that make up the content for the FlowFiles owned by this Connection - - :return: The total_byte_count of this ConnectionDiagnosticsSnapshotDTO. - :rtype: int - """ - return self._total_byte_count - - @total_byte_count.setter - def total_byte_count(self, total_byte_count): - """ - Sets the total_byte_count of this ConnectionDiagnosticsSnapshotDTO. - Total number of bytes that make up the content for the FlowFiles owned by this Connection - - :param total_byte_count: The total_byte_count of this ConnectionDiagnosticsSnapshotDTO. - :type: int - """ - - self._total_byte_count = total_byte_count - - @property - def node_identifier(self): - """ - Gets the node_identifier of this ConnectionDiagnosticsSnapshotDTO. - The Node Identifier that this information pertains to - - :return: The node_identifier of this ConnectionDiagnosticsSnapshotDTO. - :rtype: str - """ - return self._node_identifier - - @node_identifier.setter - def node_identifier(self, node_identifier): - """ - Sets the node_identifier of this ConnectionDiagnosticsSnapshotDTO. - The Node Identifier that this information pertains to - - :param node_identifier: The node_identifier of this ConnectionDiagnosticsSnapshotDTO. - :type: str - """ - - self._node_identifier = node_identifier - - @property - def local_queue_partition(self): - """ - Gets the local_queue_partition of this ConnectionDiagnosticsSnapshotDTO. - The local queue partition, from which components can pull FlowFiles on this node. - - :return: The local_queue_partition of this ConnectionDiagnosticsSnapshotDTO. - :rtype: LocalQueuePartitionDTO - """ - return self._local_queue_partition - - @local_queue_partition.setter - def local_queue_partition(self, local_queue_partition): - """ - Sets the local_queue_partition of this ConnectionDiagnosticsSnapshotDTO. - The local queue partition, from which components can pull FlowFiles on this node. - - :param local_queue_partition: The local_queue_partition of this ConnectionDiagnosticsSnapshotDTO. - :type: LocalQueuePartitionDTO - """ - - self._local_queue_partition = local_queue_partition - - @property - def remote_queue_partitions(self): - """ - Gets the remote_queue_partitions of this ConnectionDiagnosticsSnapshotDTO. - - :return: The remote_queue_partitions of this ConnectionDiagnosticsSnapshotDTO. - :rtype: list[RemoteQueuePartitionDTO] - """ - return self._remote_queue_partitions - - @remote_queue_partitions.setter - def remote_queue_partitions(self, remote_queue_partitions): - """ - Sets the remote_queue_partitions of this ConnectionDiagnosticsSnapshotDTO. - - :param remote_queue_partitions: The remote_queue_partitions of this ConnectionDiagnosticsSnapshotDTO. - :type: list[RemoteQueuePartitionDTO] - """ - - self._remote_queue_partitions = remote_queue_partitions - - 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, ConnectionDiagnosticsSnapshotDTO): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other): - """ - Returns true if both objects are not equal - """ - return not self == other diff --git a/nipyapi/nifi/models/connection_dto.py b/nipyapi/nifi/models/connection_dto.py index 72e6387b..37d6f649 100644 --- a/nipyapi/nifi/models/connection_dto.py +++ b/nipyapi/nifi/models/connection_dto.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,238 +27,212 @@ class ConnectionDTO(object): and the value is json key in definition. """ swagger_types = { - 'id': 'str', - 'versioned_component_id': 'str', - 'parent_group_id': 'str', - 'position': 'PositionDTO', - 'source': 'ConnectableDTO', - 'destination': 'ConnectableDTO', - 'name': 'str', - 'label_index': 'int', - 'getz_index': 'int', - 'selected_relationships': 'list[str]', 'available_relationships': 'list[str]', - 'back_pressure_object_threshold': 'int', - 'back_pressure_data_size_threshold': 'str', - 'flow_file_expiration': 'str', - 'prioritizers': 'list[str]', - 'bends': 'list[PositionDTO]', - 'load_balance_strategy': 'str', - 'load_balance_partition_attribute': 'str', - 'load_balance_compression': 'str', - 'load_balance_status': 'str' - } +'back_pressure_data_size_threshold': 'str', +'back_pressure_object_threshold': 'int', +'bends': 'list[PositionDTO]', +'destination': 'ConnectableDTO', +'flow_file_expiration': 'str', +'getz_index': 'int', +'id': 'str', +'label_index': 'int', +'load_balance_compression': 'str', +'load_balance_partition_attribute': 'str', +'load_balance_status': 'str', +'load_balance_strategy': 'str', +'name': 'str', +'parent_group_id': 'str', +'position': 'PositionDTO', +'prioritizers': 'list[str]', +'selected_relationships': 'list[str]', +'source': 'ConnectableDTO', +'versioned_component_id': 'str' } attribute_map = { - 'id': 'id', - 'versioned_component_id': 'versionedComponentId', - 'parent_group_id': 'parentGroupId', - 'position': 'position', - 'source': 'source', - 'destination': 'destination', - 'name': 'name', - 'label_index': 'labelIndex', - 'getz_index': 'getzIndex', - 'selected_relationships': 'selectedRelationships', 'available_relationships': 'availableRelationships', - 'back_pressure_object_threshold': 'backPressureObjectThreshold', - 'back_pressure_data_size_threshold': 'backPressureDataSizeThreshold', - 'flow_file_expiration': 'flowFileExpiration', - 'prioritizers': 'prioritizers', - 'bends': 'bends', - 'load_balance_strategy': 'loadBalanceStrategy', - 'load_balance_partition_attribute': 'loadBalancePartitionAttribute', - 'load_balance_compression': 'loadBalanceCompression', - 'load_balance_status': 'loadBalanceStatus' - } - - def __init__(self, id=None, versioned_component_id=None, parent_group_id=None, position=None, source=None, destination=None, name=None, label_index=None, getz_index=None, selected_relationships=None, available_relationships=None, back_pressure_object_threshold=None, back_pressure_data_size_threshold=None, flow_file_expiration=None, prioritizers=None, bends=None, load_balance_strategy=None, load_balance_partition_attribute=None, load_balance_compression=None, load_balance_status=None): +'back_pressure_data_size_threshold': 'backPressureDataSizeThreshold', +'back_pressure_object_threshold': 'backPressureObjectThreshold', +'bends': 'bends', +'destination': 'destination', +'flow_file_expiration': 'flowFileExpiration', +'getz_index': 'getzIndex', +'id': 'id', +'label_index': 'labelIndex', +'load_balance_compression': 'loadBalanceCompression', +'load_balance_partition_attribute': 'loadBalancePartitionAttribute', +'load_balance_status': 'loadBalanceStatus', +'load_balance_strategy': 'loadBalanceStrategy', +'name': 'name', +'parent_group_id': 'parentGroupId', +'position': 'position', +'prioritizers': 'prioritizers', +'selected_relationships': 'selectedRelationships', +'source': 'source', +'versioned_component_id': 'versionedComponentId' } + + def __init__(self, available_relationships=None, back_pressure_data_size_threshold=None, back_pressure_object_threshold=None, bends=None, destination=None, flow_file_expiration=None, getz_index=None, id=None, label_index=None, load_balance_compression=None, load_balance_partition_attribute=None, load_balance_status=None, load_balance_strategy=None, name=None, parent_group_id=None, position=None, prioritizers=None, selected_relationships=None, source=None, versioned_component_id=None): """ ConnectionDTO - a model defined in Swagger """ - self._id = None - self._versioned_component_id = None - self._parent_group_id = None - self._position = None - self._source = None - self._destination = None - self._name = None - self._label_index = None - self._getz_index = None - self._selected_relationships = None self._available_relationships = None - self._back_pressure_object_threshold = None self._back_pressure_data_size_threshold = None - self._flow_file_expiration = None - self._prioritizers = None + self._back_pressure_object_threshold = None self._bends = None - self._load_balance_strategy = None - self._load_balance_partition_attribute = None + self._destination = None + self._flow_file_expiration = None + self._getz_index = None + self._id = None + self._label_index = None self._load_balance_compression = None + self._load_balance_partition_attribute = None self._load_balance_status = None + self._load_balance_strategy = None + self._name = None + self._parent_group_id = None + self._position = None + self._prioritizers = None + self._selected_relationships = None + self._source = None + self._versioned_component_id = None - if id is not None: - self.id = id - if versioned_component_id is not None: - self.versioned_component_id = versioned_component_id - if parent_group_id is not None: - self.parent_group_id = parent_group_id - if position is not None: - self.position = position - if source is not None: - self.source = source - if destination is not None: - self.destination = destination - if name is not None: - self.name = name - if label_index is not None: - self.label_index = label_index - if getz_index is not None: - self.getz_index = getz_index - if selected_relationships is not None: - self.selected_relationships = selected_relationships if available_relationships is not None: self.available_relationships = available_relationships - if back_pressure_object_threshold is not None: - self.back_pressure_object_threshold = back_pressure_object_threshold if back_pressure_data_size_threshold is not None: self.back_pressure_data_size_threshold = back_pressure_data_size_threshold - if flow_file_expiration is not None: - self.flow_file_expiration = flow_file_expiration - if prioritizers is not None: - self.prioritizers = prioritizers + if back_pressure_object_threshold is not None: + self.back_pressure_object_threshold = back_pressure_object_threshold if bends is not None: self.bends = bends - if load_balance_strategy is not None: - self.load_balance_strategy = load_balance_strategy - if load_balance_partition_attribute is not None: - self.load_balance_partition_attribute = load_balance_partition_attribute + if destination is not None: + self.destination = destination + if flow_file_expiration is not None: + self.flow_file_expiration = flow_file_expiration + if getz_index is not None: + self.getz_index = getz_index + if id is not None: + self.id = id + if label_index is not None: + self.label_index = label_index if load_balance_compression is not None: self.load_balance_compression = load_balance_compression + if load_balance_partition_attribute is not None: + self.load_balance_partition_attribute = load_balance_partition_attribute if load_balance_status is not None: self.load_balance_status = load_balance_status + if load_balance_strategy is not None: + self.load_balance_strategy = load_balance_strategy + if name is not None: + self.name = name + if parent_group_id is not None: + self.parent_group_id = parent_group_id + if position is not None: + self.position = position + if prioritizers is not None: + self.prioritizers = prioritizers + if selected_relationships is not None: + self.selected_relationships = selected_relationships + if source is not None: + self.source = source + if versioned_component_id is not None: + self.versioned_component_id = versioned_component_id @property - def id(self): - """ - Gets the id of this ConnectionDTO. - The id of the component. - - :return: The id of this ConnectionDTO. - :rtype: str - """ - return self._id - - @id.setter - def id(self, id): - """ - Sets the id of this ConnectionDTO. - The id of the component. - - :param id: The id of this ConnectionDTO. - :type: str - """ - - self._id = id - - @property - def versioned_component_id(self): + def available_relationships(self): """ - Gets the versioned_component_id of this ConnectionDTO. - The ID of the corresponding component that is under version control + Gets the available_relationships of this ConnectionDTO. + The relationships that the source of the connection currently supports. - :return: The versioned_component_id of this ConnectionDTO. - :rtype: str + :return: The available_relationships of this ConnectionDTO. + :rtype: list[str] """ - return self._versioned_component_id + return self._available_relationships - @versioned_component_id.setter - def versioned_component_id(self, versioned_component_id): + @available_relationships.setter + def available_relationships(self, available_relationships): """ - Sets the versioned_component_id of this ConnectionDTO. - The ID of the corresponding component that is under version control + Sets the available_relationships of this ConnectionDTO. + The relationships that the source of the connection currently supports. - :param versioned_component_id: The versioned_component_id of this ConnectionDTO. - :type: str + :param available_relationships: The available_relationships of this ConnectionDTO. + :type: list[str] """ - self._versioned_component_id = versioned_component_id + self._available_relationships = available_relationships @property - def parent_group_id(self): + def back_pressure_data_size_threshold(self): """ - Gets the parent_group_id of this ConnectionDTO. - The id of parent process group of this component if applicable. + Gets the back_pressure_data_size_threshold of this ConnectionDTO. + The object data size threshold for determining when back pressure is applied. Updating this value is a passive change in the sense that it won't impact whether existing files over the limit are affected but it does help feeder processors to stop pushing too much into this work queue. - :return: The parent_group_id of this ConnectionDTO. + :return: The back_pressure_data_size_threshold of this ConnectionDTO. :rtype: str """ - return self._parent_group_id + return self._back_pressure_data_size_threshold - @parent_group_id.setter - def parent_group_id(self, parent_group_id): + @back_pressure_data_size_threshold.setter + def back_pressure_data_size_threshold(self, back_pressure_data_size_threshold): """ - Sets the parent_group_id of this ConnectionDTO. - The id of parent process group of this component if applicable. + Sets the back_pressure_data_size_threshold of this ConnectionDTO. + The object data size threshold for determining when back pressure is applied. Updating this value is a passive change in the sense that it won't impact whether existing files over the limit are affected but it does help feeder processors to stop pushing too much into this work queue. - :param parent_group_id: The parent_group_id of this ConnectionDTO. + :param back_pressure_data_size_threshold: The back_pressure_data_size_threshold of this ConnectionDTO. :type: str """ - self._parent_group_id = parent_group_id + self._back_pressure_data_size_threshold = back_pressure_data_size_threshold @property - def position(self): + def back_pressure_object_threshold(self): """ - Gets the position of this ConnectionDTO. - The position of this component in the UI if applicable. + Gets the back_pressure_object_threshold of this ConnectionDTO. + The object count threshold for determining when back pressure is applied. Updating this value is a passive change in the sense that it won't impact whether existing files over the limit are affected but it does help feeder processors to stop pushing too much into this work queue. - :return: The position of this ConnectionDTO. - :rtype: PositionDTO + :return: The back_pressure_object_threshold of this ConnectionDTO. + :rtype: int """ - return self._position + return self._back_pressure_object_threshold - @position.setter - def position(self, position): + @back_pressure_object_threshold.setter + def back_pressure_object_threshold(self, back_pressure_object_threshold): """ - Sets the position of this ConnectionDTO. - The position of this component in the UI if applicable. + Sets the back_pressure_object_threshold of this ConnectionDTO. + The object count threshold for determining when back pressure is applied. Updating this value is a passive change in the sense that it won't impact whether existing files over the limit are affected but it does help feeder processors to stop pushing too much into this work queue. - :param position: The position of this ConnectionDTO. - :type: PositionDTO + :param back_pressure_object_threshold: The back_pressure_object_threshold of this ConnectionDTO. + :type: int """ - self._position = position + self._back_pressure_object_threshold = back_pressure_object_threshold @property - def source(self): + def bends(self): """ - Gets the source of this ConnectionDTO. - The source of the connection. + Gets the bends of this ConnectionDTO. + The bend points on the connection. - :return: The source of this ConnectionDTO. - :rtype: ConnectableDTO + :return: The bends of this ConnectionDTO. + :rtype: list[PositionDTO] """ - return self._source + return self._bends - @source.setter - def source(self, source): + @bends.setter + def bends(self, bends): """ - Sets the source of this ConnectionDTO. - The source of the connection. + Sets the bends of this ConnectionDTO. + The bend points on the connection. - :param source: The source of this ConnectionDTO. - :type: ConnectableDTO + :param bends: The bends of this ConnectionDTO. + :type: list[PositionDTO] """ - self._source = source + self._bends = bends @property def destination(self): """ Gets the destination of this ConnectionDTO. - The destination of the connection. :return: The destination of this ConnectionDTO. :rtype: ConnectableDTO @@ -270,7 +243,6 @@ def destination(self): def destination(self, destination): """ Sets the destination of this ConnectionDTO. - The destination of the connection. :param destination: The destination of this ConnectionDTO. :type: ConnectableDTO @@ -279,50 +251,27 @@ def destination(self, destination): self._destination = destination @property - def name(self): + def flow_file_expiration(self): """ - Gets the name of this ConnectionDTO. - The name of the connection. + Gets the flow_file_expiration of this ConnectionDTO. + The amount of time a flow file may be in the flow before it will be automatically aged out of the flow. Once a flow file reaches this age it will be terminated from the flow the next time a processor attempts to start work on it. - :return: The name of this ConnectionDTO. + :return: The flow_file_expiration of this ConnectionDTO. :rtype: str """ - return self._name + return self._flow_file_expiration - @name.setter - def name(self, name): + @flow_file_expiration.setter + def flow_file_expiration(self, flow_file_expiration): """ - Sets the name of this ConnectionDTO. - The name of the connection. + Sets the flow_file_expiration of this ConnectionDTO. + The amount of time a flow file may be in the flow before it will be automatically aged out of the flow. Once a flow file reaches this age it will be terminated from the flow the next time a processor attempts to start work on it. - :param name: The name of this ConnectionDTO. + :param flow_file_expiration: The flow_file_expiration of this ConnectionDTO. :type: str """ - self._name = name - - @property - def label_index(self): - """ - Gets the label_index of this ConnectionDTO. - The index of the bend point where to place the connection label. - - :return: The label_index of this ConnectionDTO. - :rtype: int - """ - return self._label_index - - @label_index.setter - def label_index(self, label_index): - """ - Sets the label_index of this ConnectionDTO. - The index of the bend point where to place the connection label. - - :param label_index: The label_index of this ConnectionDTO. - :type: int - """ - - self._label_index = label_index + self._flow_file_expiration = flow_file_expiration @property def getz_index(self): @@ -348,165 +297,131 @@ def getz_index(self, getz_index): self._getz_index = getz_index @property - def selected_relationships(self): - """ - Gets the selected_relationships of this ConnectionDTO. - The selected relationship that comprise the connection. - - :return: The selected_relationships of this ConnectionDTO. - :rtype: list[str] - """ - return self._selected_relationships - - @selected_relationships.setter - def selected_relationships(self, selected_relationships): - """ - Sets the selected_relationships of this ConnectionDTO. - The selected relationship that comprise the connection. - - :param selected_relationships: The selected_relationships of this ConnectionDTO. - :type: list[str] - """ - - self._selected_relationships = selected_relationships - - @property - def available_relationships(self): + def id(self): """ - Gets the available_relationships of this ConnectionDTO. - The relationships that the source of the connection currently supports. + Gets the id of this ConnectionDTO. + The id of the component. - :return: The available_relationships of this ConnectionDTO. - :rtype: list[str] + :return: The id of this ConnectionDTO. + :rtype: str """ - return self._available_relationships + return self._id - @available_relationships.setter - def available_relationships(self, available_relationships): + @id.setter + def id(self, id): """ - Sets the available_relationships of this ConnectionDTO. - The relationships that the source of the connection currently supports. + Sets the id of this ConnectionDTO. + The id of the component. - :param available_relationships: The available_relationships of this ConnectionDTO. - :type: list[str] + :param id: The id of this ConnectionDTO. + :type: str """ - self._available_relationships = available_relationships + self._id = id @property - def back_pressure_object_threshold(self): + def label_index(self): """ - Gets the back_pressure_object_threshold of this ConnectionDTO. - The object count threshold for determining when back pressure is applied. Updating this value is a passive change in the sense that it won't impact whether existing files over the limit are affected but it does help feeder processors to stop pushing too much into this work queue. + Gets the label_index of this ConnectionDTO. + The index of the bend point where to place the connection label. - :return: The back_pressure_object_threshold of this ConnectionDTO. + :return: The label_index of this ConnectionDTO. :rtype: int """ - return self._back_pressure_object_threshold + return self._label_index - @back_pressure_object_threshold.setter - def back_pressure_object_threshold(self, back_pressure_object_threshold): + @label_index.setter + def label_index(self, label_index): """ - Sets the back_pressure_object_threshold of this ConnectionDTO. - The object count threshold for determining when back pressure is applied. Updating this value is a passive change in the sense that it won't impact whether existing files over the limit are affected but it does help feeder processors to stop pushing too much into this work queue. + Sets the label_index of this ConnectionDTO. + The index of the bend point where to place the connection label. - :param back_pressure_object_threshold: The back_pressure_object_threshold of this ConnectionDTO. + :param label_index: The label_index of this ConnectionDTO. :type: int """ - self._back_pressure_object_threshold = back_pressure_object_threshold + self._label_index = label_index @property - def back_pressure_data_size_threshold(self): + def load_balance_compression(self): """ - Gets the back_pressure_data_size_threshold of this ConnectionDTO. - The object data size threshold for determining when back pressure is applied. Updating this value is a passive change in the sense that it won't impact whether existing files over the limit are affected but it does help feeder processors to stop pushing too much into this work queue. + Gets the load_balance_compression of this ConnectionDTO. + Whether or not data should be compressed when being transferred between nodes in the cluster. - :return: The back_pressure_data_size_threshold of this ConnectionDTO. + :return: The load_balance_compression of this ConnectionDTO. :rtype: str """ - return self._back_pressure_data_size_threshold + return self._load_balance_compression - @back_pressure_data_size_threshold.setter - def back_pressure_data_size_threshold(self, back_pressure_data_size_threshold): + @load_balance_compression.setter + def load_balance_compression(self, load_balance_compression): """ - Sets the back_pressure_data_size_threshold of this ConnectionDTO. - The object data size threshold for determining when back pressure is applied. Updating this value is a passive change in the sense that it won't impact whether existing files over the limit are affected but it does help feeder processors to stop pushing too much into this work queue. + Sets the load_balance_compression of this ConnectionDTO. + Whether or not data should be compressed when being transferred between nodes in the cluster. - :param back_pressure_data_size_threshold: The back_pressure_data_size_threshold of this ConnectionDTO. + :param load_balance_compression: The load_balance_compression of this ConnectionDTO. :type: str """ + allowed_values = ["DO_NOT_COMPRESS", "COMPRESS_ATTRIBUTES_ONLY", "COMPRESS_ATTRIBUTES_AND_CONTENT", ] + if load_balance_compression not in allowed_values: + raise ValueError( + "Invalid value for `load_balance_compression` ({0}), must be one of {1}" + .format(load_balance_compression, allowed_values) + ) - self._back_pressure_data_size_threshold = back_pressure_data_size_threshold + self._load_balance_compression = load_balance_compression @property - def flow_file_expiration(self): + def load_balance_partition_attribute(self): """ - Gets the flow_file_expiration of this ConnectionDTO. - The amount of time a flow file may be in the flow before it will be automatically aged out of the flow. Once a flow file reaches this age it will be terminated from the flow the next time a processor attempts to start work on it. + Gets the load_balance_partition_attribute of this ConnectionDTO. + The FlowFile Attribute to use for determining which node a FlowFile will go to if the Load Balancing Strategy is set to PARTITION_BY_ATTRIBUTE - :return: The flow_file_expiration of this ConnectionDTO. + :return: The load_balance_partition_attribute of this ConnectionDTO. :rtype: str """ - return self._flow_file_expiration + return self._load_balance_partition_attribute - @flow_file_expiration.setter - def flow_file_expiration(self, flow_file_expiration): + @load_balance_partition_attribute.setter + def load_balance_partition_attribute(self, load_balance_partition_attribute): """ - Sets the flow_file_expiration of this ConnectionDTO. - The amount of time a flow file may be in the flow before it will be automatically aged out of the flow. Once a flow file reaches this age it will be terminated from the flow the next time a processor attempts to start work on it. + Sets the load_balance_partition_attribute of this ConnectionDTO. + The FlowFile Attribute to use for determining which node a FlowFile will go to if the Load Balancing Strategy is set to PARTITION_BY_ATTRIBUTE - :param flow_file_expiration: The flow_file_expiration of this ConnectionDTO. + :param load_balance_partition_attribute: The load_balance_partition_attribute of this ConnectionDTO. :type: str """ - self._flow_file_expiration = flow_file_expiration - - @property - def prioritizers(self): - """ - Gets the prioritizers of this ConnectionDTO. - The comparators used to prioritize the queue. - - :return: The prioritizers of this ConnectionDTO. - :rtype: list[str] - """ - return self._prioritizers - - @prioritizers.setter - def prioritizers(self, prioritizers): - """ - Sets the prioritizers of this ConnectionDTO. - The comparators used to prioritize the queue. - - :param prioritizers: The prioritizers of this ConnectionDTO. - :type: list[str] - """ - - self._prioritizers = prioritizers + self._load_balance_partition_attribute = load_balance_partition_attribute @property - def bends(self): + def load_balance_status(self): """ - Gets the bends of this ConnectionDTO. - The bend points on the connection. + Gets the load_balance_status of this ConnectionDTO. + The current status of the Connection's Load Balancing Activities. Status can indicate that Load Balancing is not configured for the connection, that Load Balancing is configured but inactive (not currently transferring data to another node), or that Load Balancing is configured and actively transferring data to another node. - :return: The bends of this ConnectionDTO. - :rtype: list[PositionDTO] + :return: The load_balance_status of this ConnectionDTO. + :rtype: str """ - return self._bends + return self._load_balance_status - @bends.setter - def bends(self, bends): + @load_balance_status.setter + def load_balance_status(self, load_balance_status): """ - Sets the bends of this ConnectionDTO. - The bend points on the connection. + Sets the load_balance_status of this ConnectionDTO. + The current status of the Connection's Load Balancing Activities. Status can indicate that Load Balancing is not configured for the connection, that Load Balancing is configured but inactive (not currently transferring data to another node), or that Load Balancing is configured and actively transferring data to another node. - :param bends: The bends of this ConnectionDTO. - :type: list[PositionDTO] + :param load_balance_status: The load_balance_status of this ConnectionDTO. + :type: str """ + allowed_values = ["LOAD_BALANCE_NOT_CONFIGURED", "LOAD_BALANCE_INACTIVE", "LOAD_BALANCE_ACTIVE", ] + 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._bends = bends + self._load_balance_status = load_balance_status @property def load_balance_strategy(self): @@ -528,7 +443,7 @@ def load_balance_strategy(self, load_balance_strategy): :param load_balance_strategy: The load_balance_strategy of this ConnectionDTO. :type: str """ - allowed_values = ["DO_NOT_LOAD_BALANCE", "PARTITION_BY_ATTRIBUTE", "ROUND_ROBIN", "SINGLE_NODE"] + allowed_values = ["DO_NOT_LOAD_BALANCE", "PARTITION_BY_ATTRIBUTE", "ROUND_ROBIN", "SINGLE_NODE", ] if load_balance_strategy not in allowed_values: raise ValueError( "Invalid value for `load_balance_strategy` ({0}), must be one of {1}" @@ -538,85 +453,161 @@ def load_balance_strategy(self, load_balance_strategy): self._load_balance_strategy = load_balance_strategy @property - def load_balance_partition_attribute(self): + def name(self): """ - Gets the load_balance_partition_attribute of this ConnectionDTO. - The FlowFile Attribute to use for determining which node a FlowFile will go to if the Load Balancing Strategy is set to PARTITION_BY_ATTRIBUTE + Gets the name of this ConnectionDTO. + The name of the connection. - :return: The load_balance_partition_attribute of this ConnectionDTO. + :return: The name of this ConnectionDTO. :rtype: str """ - return self._load_balance_partition_attribute + return self._name - @load_balance_partition_attribute.setter - def load_balance_partition_attribute(self, load_balance_partition_attribute): + @name.setter + def name(self, name): """ - Sets the load_balance_partition_attribute of this ConnectionDTO. - The FlowFile Attribute to use for determining which node a FlowFile will go to if the Load Balancing Strategy is set to PARTITION_BY_ATTRIBUTE + Sets the name of this ConnectionDTO. + The name of the connection. - :param load_balance_partition_attribute: The load_balance_partition_attribute of this ConnectionDTO. + :param name: The name of this ConnectionDTO. :type: str """ - self._load_balance_partition_attribute = load_balance_partition_attribute + self._name = name @property - def load_balance_compression(self): + def parent_group_id(self): """ - Gets the load_balance_compression of this ConnectionDTO. - Whether or not data should be compressed when being transferred between nodes in the cluster. + Gets the parent_group_id of this ConnectionDTO. + The id of parent process group of this component if applicable. - :return: The load_balance_compression of this ConnectionDTO. + :return: The parent_group_id of this ConnectionDTO. :rtype: str """ - return self._load_balance_compression + return self._parent_group_id - @load_balance_compression.setter - def load_balance_compression(self, load_balance_compression): + @parent_group_id.setter + def parent_group_id(self, parent_group_id): """ - Sets the load_balance_compression of this ConnectionDTO. - Whether or not data should be compressed when being transferred between nodes in the cluster. + Sets the parent_group_id of this ConnectionDTO. + The id of parent process group of this component if applicable. - :param load_balance_compression: The load_balance_compression of this ConnectionDTO. + :param parent_group_id: The parent_group_id of this ConnectionDTO. :type: str """ - allowed_values = ["DO_NOT_COMPRESS", "COMPRESS_ATTRIBUTES_ONLY", "COMPRESS_ATTRIBUTES_AND_CONTENT"] - if load_balance_compression not in allowed_values: - raise ValueError( - "Invalid value for `load_balance_compression` ({0}), must be one of {1}" - .format(load_balance_compression, allowed_values) - ) - self._load_balance_compression = load_balance_compression + self._parent_group_id = parent_group_id @property - def load_balance_status(self): + def position(self): """ - Gets the load_balance_status of this ConnectionDTO. - The current status of the Connection's Load Balancing Activities. Status can indicate that Load Balancing is not configured for the connection, that Load Balancing is configured but inactive (not currently transferring data to another node), or that Load Balancing is configured and actively transferring data to another node. + Gets the position of this ConnectionDTO. - :return: The load_balance_status of this ConnectionDTO. + :return: The position of this ConnectionDTO. + :rtype: PositionDTO + """ + return self._position + + @position.setter + def position(self, position): + """ + Sets the position of this ConnectionDTO. + + :param position: The position of this ConnectionDTO. + :type: PositionDTO + """ + + self._position = position + + @property + def prioritizers(self): + """ + Gets the prioritizers of this ConnectionDTO. + The comparators used to prioritize the queue. + + :return: The prioritizers of this ConnectionDTO. + :rtype: list[str] + """ + return self._prioritizers + + @prioritizers.setter + def prioritizers(self, prioritizers): + """ + Sets the prioritizers of this ConnectionDTO. + The comparators used to prioritize the queue. + + :param prioritizers: The prioritizers of this ConnectionDTO. + :type: list[str] + """ + + self._prioritizers = prioritizers + + @property + def selected_relationships(self): + """ + Gets the selected_relationships of this ConnectionDTO. + The selected relationship that comprise the connection. + + :return: The selected_relationships of this ConnectionDTO. + :rtype: list[str] + """ + return self._selected_relationships + + @selected_relationships.setter + def selected_relationships(self, selected_relationships): + """ + Sets the selected_relationships of this ConnectionDTO. + The selected relationship that comprise the connection. + + :param selected_relationships: The selected_relationships of this ConnectionDTO. + :type: list[str] + """ + + self._selected_relationships = selected_relationships + + @property + def source(self): + """ + Gets the source of this ConnectionDTO. + + :return: The source of this ConnectionDTO. + :rtype: ConnectableDTO + """ + return self._source + + @source.setter + def source(self, source): + """ + Sets the source of this ConnectionDTO. + + :param source: The source of this ConnectionDTO. + :type: ConnectableDTO + """ + + self._source = source + + @property + def versioned_component_id(self): + """ + Gets the versioned_component_id of this ConnectionDTO. + The ID of the corresponding component that is under version control + + :return: The versioned_component_id of this ConnectionDTO. :rtype: str """ - return self._load_balance_status + return self._versioned_component_id - @load_balance_status.setter - def load_balance_status(self, load_balance_status): + @versioned_component_id.setter + def versioned_component_id(self, versioned_component_id): """ - Sets the load_balance_status of this ConnectionDTO. - The current status of the Connection's Load Balancing Activities. Status can indicate that Load Balancing is not configured for the connection, that Load Balancing is configured but inactive (not currently transferring data to another node), or that Load Balancing is configured and actively transferring data to another node. + Sets the versioned_component_id of this ConnectionDTO. + The ID of the corresponding component that is under version control - :param load_balance_status: The load_balance_status of this ConnectionDTO. + :param versioned_component_id: The versioned_component_id of this ConnectionDTO. :type: str """ - allowed_values = ["LOAD_BALANCE_NOT_CONFIGURED", "LOAD_BALANCE_INACTIVE", "LOAD_BALANCE_ACTIVE"] - 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 + self._versioned_component_id = versioned_component_id def to_dict(self): """ diff --git a/nipyapi/nifi/models/connection_entity.py b/nipyapi/nifi/models/connection_entity.py index 7868ca2d..9bd42b1f 100644 --- a/nipyapi/nifi/models/connection_entity.py +++ b/nipyapi/nifi/models/connection_entity.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,243 +27,247 @@ class ConnectionEntity(object): and the value is json key in definition. """ swagger_types = { - 'revision': 'RevisionDTO', - 'id': 'str', - 'uri': 'str', - 'position': 'PositionDTO', - 'permissions': 'PermissionsDTO', - 'bulletins': 'list[BulletinEntity]', - 'disconnected_node_acknowledged': 'bool', - 'component': 'ConnectionDTO', - 'status': 'ConnectionStatusDTO', 'bends': 'list[PositionDTO]', - 'label_index': 'int', - 'getz_index': 'int', - 'source_id': 'str', - 'source_group_id': 'str', - 'source_type': 'str', - 'destination_id': 'str', - 'destination_group_id': 'str', - 'destination_type': 'str' - } +'bulletins': 'list[BulletinEntity]', +'component': 'ConnectionDTO', +'destination_group_id': 'str', +'destination_id': 'str', +'destination_type': 'str', +'disconnected_node_acknowledged': 'bool', +'getz_index': 'int', +'id': 'str', +'label_index': 'int', +'permissions': 'PermissionsDTO', +'position': 'PositionDTO', +'revision': 'RevisionDTO', +'source_group_id': 'str', +'source_id': 'str', +'source_type': 'str', +'status': 'ConnectionStatusDTO', +'uri': 'str' } attribute_map = { - 'revision': 'revision', - 'id': 'id', - 'uri': 'uri', - 'position': 'position', - 'permissions': 'permissions', - 'bulletins': 'bulletins', - 'disconnected_node_acknowledged': 'disconnectedNodeAcknowledged', - 'component': 'component', - 'status': 'status', 'bends': 'bends', - 'label_index': 'labelIndex', - 'getz_index': 'getzIndex', - 'source_id': 'sourceId', - 'source_group_id': 'sourceGroupId', - 'source_type': 'sourceType', - 'destination_id': 'destinationId', - 'destination_group_id': 'destinationGroupId', - 'destination_type': 'destinationType' - } - - def __init__(self, revision=None, id=None, uri=None, position=None, permissions=None, bulletins=None, disconnected_node_acknowledged=None, component=None, status=None, bends=None, label_index=None, getz_index=None, source_id=None, source_group_id=None, source_type=None, destination_id=None, destination_group_id=None, destination_type=None): +'bulletins': 'bulletins', +'component': 'component', +'destination_group_id': 'destinationGroupId', +'destination_id': 'destinationId', +'destination_type': 'destinationType', +'disconnected_node_acknowledged': 'disconnectedNodeAcknowledged', +'getz_index': 'getzIndex', +'id': 'id', +'label_index': 'labelIndex', +'permissions': 'permissions', +'position': 'position', +'revision': 'revision', +'source_group_id': 'sourceGroupId', +'source_id': 'sourceId', +'source_type': 'sourceType', +'status': 'status', +'uri': 'uri' } + + def __init__(self, bends=None, bulletins=None, component=None, destination_group_id=None, destination_id=None, destination_type=None, disconnected_node_acknowledged=None, getz_index=None, id=None, label_index=None, permissions=None, position=None, revision=None, source_group_id=None, source_id=None, source_type=None, status=None, uri=None): """ ConnectionEntity - a model defined in Swagger """ - self._revision = None - self._id = None - self._uri = None - self._position = None - self._permissions = None + self._bends = None self._bulletins = None - self._disconnected_node_acknowledged = None self._component = None - self._status = None - self._bends = None - self._label_index = None + self._destination_group_id = None + self._destination_id = None + self._destination_type = None + self._disconnected_node_acknowledged = None self._getz_index = None - self._source_id = None + self._id = None + self._label_index = None + self._permissions = None + self._position = None + self._revision = None self._source_group_id = None + self._source_id = None self._source_type = None - self._destination_id = None - self._destination_group_id = None - self._destination_type = None + self._status = None + self._uri = None - if revision is not None: - self.revision = revision - if id is not None: - self.id = id - if uri is not None: - self.uri = uri - if position is not None: - self.position = position - if permissions is not None: - self.permissions = permissions + if bends is not None: + self.bends = bends if bulletins is not None: self.bulletins = bulletins - if disconnected_node_acknowledged is not None: - self.disconnected_node_acknowledged = disconnected_node_acknowledged if component is not None: self.component = component - if status is not None: - self.status = status - if bends is not None: - self.bends = bends - if label_index is not None: - self.label_index = label_index + if destination_group_id is not None: + self.destination_group_id = destination_group_id + if destination_id is not None: + self.destination_id = destination_id + self.destination_type = destination_type + if disconnected_node_acknowledged is not None: + self.disconnected_node_acknowledged = disconnected_node_acknowledged if getz_index is not None: self.getz_index = getz_index - if source_id is not None: - self.source_id = source_id + if id is not None: + self.id = id + if label_index is not None: + self.label_index = label_index + if permissions is not None: + self.permissions = permissions + if position is not None: + self.position = position + if revision is not None: + self.revision = revision if source_group_id is not None: self.source_group_id = source_group_id + if source_id is not None: + self.source_id = source_id self.source_type = source_type - if destination_id is not None: - self.destination_id = destination_id - if destination_group_id is not None: - self.destination_group_id = destination_group_id - self.destination_type = destination_type + if status is not None: + self.status = status + if uri is not None: + self.uri = uri @property - def revision(self): + def bends(self): """ - Gets the revision of this ConnectionEntity. - The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses. + Gets the bends of this ConnectionEntity. + The bend points on the connection. - :return: The revision of this ConnectionEntity. - :rtype: RevisionDTO + :return: The bends of this ConnectionEntity. + :rtype: list[PositionDTO] """ - return self._revision + return self._bends - @revision.setter - def revision(self, revision): + @bends.setter + def bends(self, bends): """ - Sets the revision of this ConnectionEntity. - The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses. + Sets the bends of this ConnectionEntity. + The bend points on the connection. - :param revision: The revision of this ConnectionEntity. - :type: RevisionDTO + :param bends: The bends of this ConnectionEntity. + :type: list[PositionDTO] """ - self._revision = revision + self._bends = bends @property - def id(self): + def bulletins(self): """ - Gets the id of this ConnectionEntity. - The id of the component. + Gets the bulletins of this ConnectionEntity. + The bulletins for this component. - :return: The id of this ConnectionEntity. - :rtype: str + :return: The bulletins of this ConnectionEntity. + :rtype: list[BulletinEntity] """ - return self._id + return self._bulletins - @id.setter - def id(self, id): + @bulletins.setter + def bulletins(self, bulletins): """ - Sets the id of this ConnectionEntity. - The id of the component. + Sets the bulletins of this ConnectionEntity. + The bulletins for this component. - :param id: The id of this ConnectionEntity. - :type: str + :param bulletins: The bulletins of this ConnectionEntity. + :type: list[BulletinEntity] """ - self._id = id + self._bulletins = bulletins @property - def uri(self): + def component(self): """ - Gets the uri of this ConnectionEntity. - The URI for futures requests to the component. + Gets the component of this ConnectionEntity. - :return: The uri of this ConnectionEntity. - :rtype: str + :return: The component of this ConnectionEntity. + :rtype: ConnectionDTO """ - return self._uri + return self._component - @uri.setter - def uri(self, uri): + @component.setter + def component(self, component): """ - Sets the uri of this ConnectionEntity. - The URI for futures requests to the component. + Sets the component of this ConnectionEntity. - :param uri: The uri of this ConnectionEntity. - :type: str + :param component: The component of this ConnectionEntity. + :type: ConnectionDTO """ - self._uri = uri + self._component = component @property - def position(self): + def destination_group_id(self): """ - Gets the position of this ConnectionEntity. - The position of this component in the UI if applicable. + Gets the destination_group_id of this ConnectionEntity. + The identifier of the group of the destination of this connection. - :return: The position of this ConnectionEntity. - :rtype: PositionDTO + :return: The destination_group_id of this ConnectionEntity. + :rtype: str """ - return self._position + return self._destination_group_id - @position.setter - def position(self, position): + @destination_group_id.setter + def destination_group_id(self, destination_group_id): """ - Sets the position of this ConnectionEntity. - The position of this component in the UI if applicable. + Sets the destination_group_id of this ConnectionEntity. + The identifier of the group of the destination of this connection. - :param position: The position of this ConnectionEntity. - :type: PositionDTO + :param destination_group_id: The destination_group_id of this ConnectionEntity. + :type: str """ - self._position = position + self._destination_group_id = destination_group_id @property - def permissions(self): + def destination_id(self): """ - Gets the permissions of this ConnectionEntity. - The permissions for this component. + Gets the destination_id of this ConnectionEntity. + The identifier of the destination of this connection. - :return: The permissions of this ConnectionEntity. - :rtype: PermissionsDTO + :return: The destination_id of this ConnectionEntity. + :rtype: str """ - return self._permissions + return self._destination_id - @permissions.setter - def permissions(self, permissions): + @destination_id.setter + def destination_id(self, destination_id): """ - Sets the permissions of this ConnectionEntity. - The permissions for this component. + Sets the destination_id of this ConnectionEntity. + The identifier of the destination of this connection. - :param permissions: The permissions of this ConnectionEntity. - :type: PermissionsDTO + :param destination_id: The destination_id of this ConnectionEntity. + :type: str """ - self._permissions = permissions + self._destination_id = destination_id @property - def bulletins(self): + def destination_type(self): """ - Gets the bulletins of this ConnectionEntity. - The bulletins for this component. + Gets the destination_type of this ConnectionEntity. + The type of component the destination connectable is. - :return: The bulletins of this ConnectionEntity. - :rtype: list[BulletinEntity] + :return: The destination_type of this ConnectionEntity. + :rtype: str """ - return self._bulletins + return self._destination_type - @bulletins.setter - def bulletins(self, bulletins): + @destination_type.setter + def destination_type(self, destination_type): """ - Sets the bulletins of this ConnectionEntity. - The bulletins for this component. + Sets the destination_type of this ConnectionEntity. + The type of component the destination connectable is. - :param bulletins: The bulletins of this ConnectionEntity. - :type: list[BulletinEntity] + :param destination_type: The destination_type of this ConnectionEntity. + :type: str """ + 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) + ) - self._bulletins = bulletins + self._destination_type = destination_type @property def disconnected_node_acknowledged(self): @@ -290,71 +293,50 @@ def disconnected_node_acknowledged(self, disconnected_node_acknowledged): self._disconnected_node_acknowledged = disconnected_node_acknowledged @property - def component(self): - """ - Gets the component of this ConnectionEntity. - - :return: The component of this ConnectionEntity. - :rtype: ConnectionDTO - """ - return self._component - - @component.setter - def component(self, component): - """ - Sets the component of this ConnectionEntity. - - :param component: The component of this ConnectionEntity. - :type: ConnectionDTO - """ - - self._component = component - - @property - def status(self): + def getz_index(self): """ - Gets the status of this ConnectionEntity. - The status of the connection. + Gets the getz_index of this ConnectionEntity. + The z index of the connection. - :return: The status of this ConnectionEntity. - :rtype: ConnectionStatusDTO + :return: The getz_index of this ConnectionEntity. + :rtype: int """ - return self._status + return self._getz_index - @status.setter - def status(self, status): + @getz_index.setter + def getz_index(self, getz_index): """ - Sets the status of this ConnectionEntity. - The status of the connection. + Sets the getz_index of this ConnectionEntity. + The z index of the connection. - :param status: The status of this ConnectionEntity. - :type: ConnectionStatusDTO + :param getz_index: The getz_index of this ConnectionEntity. + :type: int """ - self._status = status + self._getz_index = getz_index @property - def bends(self): + def id(self): """ - Gets the bends of this ConnectionEntity. - The bend points on the connection. + Gets the id of this ConnectionEntity. + The id of the component. - :return: The bends of this ConnectionEntity. - :rtype: list[PositionDTO] + :return: The id of this ConnectionEntity. + :rtype: str """ - return self._bends + return self._id - @bends.setter - def bends(self, bends): + @id.setter + def id(self, id): """ - Sets the bends of this ConnectionEntity. - The bend points on the connection. + Sets the id of this ConnectionEntity. + The id of the component. - :param bends: The bends of this ConnectionEntity. - :type: list[PositionDTO] + :param id: The id of this ConnectionEntity. + :type: str """ - self._bends = bends + self._id = id @property def label_index(self): @@ -380,50 +362,67 @@ def label_index(self, label_index): self._label_index = label_index @property - def getz_index(self): + def permissions(self): """ - Gets the getz_index of this ConnectionEntity. - The z index of the connection. + Gets the permissions of this ConnectionEntity. - :return: The getz_index of this ConnectionEntity. - :rtype: int + :return: The permissions of this ConnectionEntity. + :rtype: PermissionsDTO """ - return self._getz_index + return self._permissions - @getz_index.setter - def getz_index(self, getz_index): + @permissions.setter + def permissions(self, permissions): """ - Sets the getz_index of this ConnectionEntity. - The z index of the connection. + Sets the permissions of this ConnectionEntity. - :param getz_index: The getz_index of this ConnectionEntity. - :type: int + :param permissions: The permissions of this ConnectionEntity. + :type: PermissionsDTO """ - self._getz_index = getz_index + self._permissions = permissions @property - def source_id(self): + def position(self): """ - Gets the source_id of this ConnectionEntity. - The identifier of the source of this connection. + Gets the position of this ConnectionEntity. - :return: The source_id of this ConnectionEntity. - :rtype: str + :return: The position of this ConnectionEntity. + :rtype: PositionDTO """ - return self._source_id + return self._position - @source_id.setter - def source_id(self, source_id): + @position.setter + def position(self, position): """ - Sets the source_id of this ConnectionEntity. - The identifier of the source of this connection. + Sets the position of this ConnectionEntity. - :param source_id: The source_id of this ConnectionEntity. - :type: str + :param position: The position of this ConnectionEntity. + :type: PositionDTO """ - self._source_id = source_id + self._position = position + + @property + def revision(self): + """ + Gets the revision of this ConnectionEntity. + + :return: The revision of this ConnectionEntity. + :rtype: RevisionDTO + """ + return self._revision + + @revision.setter + def revision(self, revision): + """ + Sets the revision of this ConnectionEntity. + + :param revision: The revision of this ConnectionEntity. + :type: RevisionDTO + """ + + self._revision = revision @property def source_group_id(self): @@ -448,6 +447,29 @@ def source_group_id(self, source_group_id): self._source_group_id = source_group_id + @property + def source_id(self): + """ + Gets the source_id of this ConnectionEntity. + The identifier of the source of this connection. + + :return: The source_id of this ConnectionEntity. + :rtype: str + """ + return self._source_id + + @source_id.setter + def source_id(self, source_id): + """ + Sets the source_id of this ConnectionEntity. + The identifier of the source of this connection. + + :param source_id: The source_id of this ConnectionEntity. + :type: str + """ + + self._source_id = source_id + @property def source_type(self): """ @@ -470,7 +492,7 @@ 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"] + 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}" @@ -480,81 +502,48 @@ def source_type(self, source_type): self._source_type = source_type @property - def destination_id(self): - """ - Gets the destination_id of this ConnectionEntity. - The identifier of the destination of this connection. - - :return: The destination_id of this ConnectionEntity. - :rtype: str - """ - return self._destination_id - - @destination_id.setter - def destination_id(self, destination_id): - """ - Sets the destination_id of this ConnectionEntity. - The identifier of the destination of this connection. - - :param destination_id: The destination_id of this ConnectionEntity. - :type: str - """ - - self._destination_id = destination_id - - @property - def destination_group_id(self): + def status(self): """ - Gets the destination_group_id of this ConnectionEntity. - The identifier of the group of the destination of this connection. + Gets the status of this ConnectionEntity. - :return: The destination_group_id of this ConnectionEntity. - :rtype: str + :return: The status of this ConnectionEntity. + :rtype: ConnectionStatusDTO """ - return self._destination_group_id + return self._status - @destination_group_id.setter - def destination_group_id(self, destination_group_id): + @status.setter + def status(self, status): """ - Sets the destination_group_id of this ConnectionEntity. - The identifier of the group of the destination of this connection. + Sets the status of this ConnectionEntity. - :param destination_group_id: The destination_group_id of this ConnectionEntity. - :type: str + :param status: The status of this ConnectionEntity. + :type: ConnectionStatusDTO """ - self._destination_group_id = destination_group_id + self._status = status @property - def destination_type(self): + def uri(self): """ - Gets the destination_type of this ConnectionEntity. - The type of component the destination connectable is. + Gets the uri of this ConnectionEntity. + The URI for futures requests to the component. - :return: The destination_type of this ConnectionEntity. + :return: The uri of this ConnectionEntity. :rtype: str """ - return self._destination_type + return self._uri - @destination_type.setter - def destination_type(self, destination_type): + @uri.setter + def uri(self, uri): """ - Sets the destination_type of this ConnectionEntity. - The type of component the destination connectable is. + Sets the uri of this ConnectionEntity. + The URI for futures requests to the component. - :param destination_type: The destination_type of this ConnectionEntity. + :param uri: The uri of this ConnectionEntity. :type: str """ - 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) - ) - self._destination_type = destination_type + self._uri = uri def to_dict(self): """ diff --git a/nipyapi/nifi/models/connection_statistics_dto.py b/nipyapi/nifi/models/connection_statistics_dto.py index 2c3e3314..fbb1b181 100644 --- a/nipyapi/nifi/models/connection_statistics_dto.py +++ b/nipyapi/nifi/models/connection_statistics_dto.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,37 +27,56 @@ class ConnectionStatisticsDTO(object): and the value is json key in definition. """ swagger_types = { - 'id': 'str', - 'stats_last_refreshed': 'str', 'aggregate_snapshot': 'ConnectionStatisticsSnapshotDTO', - 'node_snapshots': 'list[NodeConnectionStatisticsSnapshotDTO]' - } +'id': 'str', +'node_snapshots': 'list[NodeConnectionStatisticsSnapshotDTO]', +'stats_last_refreshed': 'str' } attribute_map = { - 'id': 'id', - 'stats_last_refreshed': 'statsLastRefreshed', 'aggregate_snapshot': 'aggregateSnapshot', - 'node_snapshots': 'nodeSnapshots' - } +'id': 'id', +'node_snapshots': 'nodeSnapshots', +'stats_last_refreshed': 'statsLastRefreshed' } - def __init__(self, id=None, stats_last_refreshed=None, aggregate_snapshot=None, node_snapshots=None): + def __init__(self, aggregate_snapshot=None, id=None, node_snapshots=None, stats_last_refreshed=None): """ ConnectionStatisticsDTO - a model defined in Swagger """ - self._id = None - self._stats_last_refreshed = None self._aggregate_snapshot = None + self._id = None self._node_snapshots = None + self._stats_last_refreshed = None - if id is not None: - self.id = id - if stats_last_refreshed is not None: - self.stats_last_refreshed = stats_last_refreshed if aggregate_snapshot is not None: self.aggregate_snapshot = aggregate_snapshot + if id is not None: + self.id = id if node_snapshots is not None: self.node_snapshots = node_snapshots + if stats_last_refreshed is not None: + self.stats_last_refreshed = stats_last_refreshed + + @property + def aggregate_snapshot(self): + """ + Gets the aggregate_snapshot of this ConnectionStatisticsDTO. + + :return: The aggregate_snapshot of this ConnectionStatisticsDTO. + :rtype: ConnectionStatisticsSnapshotDTO + """ + return self._aggregate_snapshot + + @aggregate_snapshot.setter + def aggregate_snapshot(self, aggregate_snapshot): + """ + Sets the aggregate_snapshot of this ConnectionStatisticsDTO. + + :param aggregate_snapshot: The aggregate_snapshot of this ConnectionStatisticsDTO. + :type: ConnectionStatisticsSnapshotDTO + """ + + self._aggregate_snapshot = aggregate_snapshot @property def id(self): @@ -83,52 +101,6 @@ def id(self, id): self._id = id - @property - def stats_last_refreshed(self): - """ - Gets the stats_last_refreshed of this ConnectionStatisticsDTO. - The timestamp of when the stats were last refreshed - - :return: The stats_last_refreshed of this ConnectionStatisticsDTO. - :rtype: str - """ - return self._stats_last_refreshed - - @stats_last_refreshed.setter - def stats_last_refreshed(self, stats_last_refreshed): - """ - Sets the stats_last_refreshed of this ConnectionStatisticsDTO. - The timestamp of when the stats were last refreshed - - :param stats_last_refreshed: The stats_last_refreshed of this ConnectionStatisticsDTO. - :type: str - """ - - self._stats_last_refreshed = stats_last_refreshed - - @property - def aggregate_snapshot(self): - """ - Gets the aggregate_snapshot of this ConnectionStatisticsDTO. - The status snapshot that represents the aggregate stats of the cluster - - :return: The aggregate_snapshot of this ConnectionStatisticsDTO. - :rtype: ConnectionStatisticsSnapshotDTO - """ - return self._aggregate_snapshot - - @aggregate_snapshot.setter - def aggregate_snapshot(self, aggregate_snapshot): - """ - Sets the aggregate_snapshot of this ConnectionStatisticsDTO. - The status snapshot that represents the aggregate stats of the cluster - - :param aggregate_snapshot: The aggregate_snapshot of this ConnectionStatisticsDTO. - :type: ConnectionStatisticsSnapshotDTO - """ - - self._aggregate_snapshot = aggregate_snapshot - @property def node_snapshots(self): """ @@ -152,6 +124,29 @@ def node_snapshots(self, node_snapshots): self._node_snapshots = node_snapshots + @property + def stats_last_refreshed(self): + """ + Gets the stats_last_refreshed of this ConnectionStatisticsDTO. + The timestamp of when the stats were last refreshed + + :return: The stats_last_refreshed of this ConnectionStatisticsDTO. + :rtype: str + """ + return self._stats_last_refreshed + + @stats_last_refreshed.setter + def stats_last_refreshed(self, stats_last_refreshed): + """ + Sets the stats_last_refreshed of this ConnectionStatisticsDTO. + The timestamp of when the stats were last refreshed + + :param stats_last_refreshed: The stats_last_refreshed of this ConnectionStatisticsDTO. + :type: str + """ + + self._stats_last_refreshed = stats_last_refreshed + def to_dict(self): """ Returns the model properties as a dict diff --git a/nipyapi/nifi/models/connection_statistics_entity.py b/nipyapi/nifi/models/connection_statistics_entity.py index 64a84221..f34bdee5 100644 --- a/nipyapi/nifi/models/connection_statistics_entity.py +++ b/nipyapi/nifi/models/connection_statistics_entity.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,48 +27,25 @@ class ConnectionStatisticsEntity(object): and the value is json key in definition. """ swagger_types = { - 'connection_statistics': 'ConnectionStatisticsDTO', - 'can_read': 'bool' - } + 'can_read': 'bool', +'connection_statistics': 'ConnectionStatisticsDTO' } attribute_map = { - 'connection_statistics': 'connectionStatistics', - 'can_read': 'canRead' - } + 'can_read': 'canRead', +'connection_statistics': 'connectionStatistics' } - def __init__(self, connection_statistics=None, can_read=None): + def __init__(self, can_read=None, connection_statistics=None): """ ConnectionStatisticsEntity - a model defined in Swagger """ - self._connection_statistics = None self._can_read = None + self._connection_statistics = None - if connection_statistics is not None: - self.connection_statistics = connection_statistics if can_read is not None: self.can_read = can_read - - @property - def connection_statistics(self): - """ - Gets the connection_statistics of this ConnectionStatisticsEntity. - - :return: The connection_statistics of this ConnectionStatisticsEntity. - :rtype: ConnectionStatisticsDTO - """ - return self._connection_statistics - - @connection_statistics.setter - def connection_statistics(self, connection_statistics): - """ - Sets the connection_statistics of this ConnectionStatisticsEntity. - - :param connection_statistics: The connection_statistics of this ConnectionStatisticsEntity. - :type: ConnectionStatisticsDTO - """ - - self._connection_statistics = connection_statistics + if connection_statistics is not None: + self.connection_statistics = connection_statistics @property def can_read(self): @@ -94,6 +70,27 @@ def can_read(self, can_read): self._can_read = can_read + @property + def connection_statistics(self): + """ + Gets the connection_statistics of this ConnectionStatisticsEntity. + + :return: The connection_statistics of this ConnectionStatisticsEntity. + :rtype: ConnectionStatisticsDTO + """ + return self._connection_statistics + + @connection_statistics.setter + def connection_statistics(self, connection_statistics): + """ + Sets the connection_statistics of this ConnectionStatisticsEntity. + + :param connection_statistics: The connection_statistics of this ConnectionStatisticsEntity. + :type: ConnectionStatisticsDTO + """ + + self._connection_statistics = connection_statistics + def to_dict(self): """ Returns the model properties as a dict diff --git a/nipyapi/nifi/models/connection_statistics_snapshot_dto.py b/nipyapi/nifi/models/connection_statistics_snapshot_dto.py index a1ee78ea..0f1a48a9 100644 --- a/nipyapi/nifi/models/connection_statistics_snapshot_dto.py +++ b/nipyapi/nifi/models/connection_statistics_snapshot_dto.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -29,54 +28,52 @@ class ConnectionStatisticsSnapshotDTO(object): """ swagger_types = { 'id': 'str', - 'predicted_millis_until_count_backpressure': 'int', - 'predicted_millis_until_bytes_backpressure': 'int', - 'predicted_count_at_next_interval': 'int', - 'predicted_bytes_at_next_interval': 'int', - 'predicted_percent_count': 'int', - 'predicted_percent_bytes': 'int', - 'prediction_interval_millis': 'int' - } +'predicted_bytes_at_next_interval': 'int', +'predicted_count_at_next_interval': 'int', +'predicted_millis_until_bytes_backpressure': 'int', +'predicted_millis_until_count_backpressure': 'int', +'predicted_percent_bytes': 'int', +'predicted_percent_count': 'int', +'prediction_interval_millis': 'int' } attribute_map = { 'id': 'id', - 'predicted_millis_until_count_backpressure': 'predictedMillisUntilCountBackpressure', - 'predicted_millis_until_bytes_backpressure': 'predictedMillisUntilBytesBackpressure', - 'predicted_count_at_next_interval': 'predictedCountAtNextInterval', - 'predicted_bytes_at_next_interval': 'predictedBytesAtNextInterval', - 'predicted_percent_count': 'predictedPercentCount', - 'predicted_percent_bytes': 'predictedPercentBytes', - 'prediction_interval_millis': 'predictionIntervalMillis' - } +'predicted_bytes_at_next_interval': 'predictedBytesAtNextInterval', +'predicted_count_at_next_interval': 'predictedCountAtNextInterval', +'predicted_millis_until_bytes_backpressure': 'predictedMillisUntilBytesBackpressure', +'predicted_millis_until_count_backpressure': 'predictedMillisUntilCountBackpressure', +'predicted_percent_bytes': 'predictedPercentBytes', +'predicted_percent_count': 'predictedPercentCount', +'prediction_interval_millis': 'predictionIntervalMillis' } - def __init__(self, id=None, predicted_millis_until_count_backpressure=None, predicted_millis_until_bytes_backpressure=None, predicted_count_at_next_interval=None, predicted_bytes_at_next_interval=None, predicted_percent_count=None, predicted_percent_bytes=None, prediction_interval_millis=None): + def __init__(self, id=None, predicted_bytes_at_next_interval=None, predicted_count_at_next_interval=None, predicted_millis_until_bytes_backpressure=None, predicted_millis_until_count_backpressure=None, predicted_percent_bytes=None, predicted_percent_count=None, prediction_interval_millis=None): """ ConnectionStatisticsSnapshotDTO - a model defined in Swagger """ self._id = None - self._predicted_millis_until_count_backpressure = None - self._predicted_millis_until_bytes_backpressure = None - self._predicted_count_at_next_interval = None self._predicted_bytes_at_next_interval = None - self._predicted_percent_count = None + self._predicted_count_at_next_interval = None + self._predicted_millis_until_bytes_backpressure = None + self._predicted_millis_until_count_backpressure = None self._predicted_percent_bytes = None + self._predicted_percent_count = None self._prediction_interval_millis = None if id is not None: self.id = id - if predicted_millis_until_count_backpressure is not None: - self.predicted_millis_until_count_backpressure = predicted_millis_until_count_backpressure - if predicted_millis_until_bytes_backpressure is not None: - self.predicted_millis_until_bytes_backpressure = predicted_millis_until_bytes_backpressure - if predicted_count_at_next_interval is not None: - self.predicted_count_at_next_interval = predicted_count_at_next_interval if predicted_bytes_at_next_interval is not None: self.predicted_bytes_at_next_interval = predicted_bytes_at_next_interval - if predicted_percent_count is not None: - self.predicted_percent_count = predicted_percent_count + if predicted_count_at_next_interval is not None: + self.predicted_count_at_next_interval = predicted_count_at_next_interval + if predicted_millis_until_bytes_backpressure is not None: + self.predicted_millis_until_bytes_backpressure = predicted_millis_until_bytes_backpressure + if predicted_millis_until_count_backpressure is not None: + self.predicted_millis_until_count_backpressure = predicted_millis_until_count_backpressure if predicted_percent_bytes is not None: self.predicted_percent_bytes = predicted_percent_bytes + if predicted_percent_count is not None: + self.predicted_percent_count = predicted_percent_count if prediction_interval_millis is not None: self.prediction_interval_millis = prediction_interval_millis @@ -104,50 +101,27 @@ def id(self, id): self._id = id @property - def predicted_millis_until_count_backpressure(self): - """ - Gets the predicted_millis_until_count_backpressure of this ConnectionStatisticsSnapshotDTO. - The predicted number of milliseconds before the connection will have backpressure applied, based on the queued count. - - :return: The predicted_millis_until_count_backpressure of this ConnectionStatisticsSnapshotDTO. - :rtype: int - """ - return self._predicted_millis_until_count_backpressure - - @predicted_millis_until_count_backpressure.setter - def predicted_millis_until_count_backpressure(self, predicted_millis_until_count_backpressure): - """ - Sets the predicted_millis_until_count_backpressure of this ConnectionStatisticsSnapshotDTO. - The predicted number of milliseconds before the connection will have backpressure applied, based on the queued count. - - :param predicted_millis_until_count_backpressure: The predicted_millis_until_count_backpressure of this ConnectionStatisticsSnapshotDTO. - :type: int - """ - - self._predicted_millis_until_count_backpressure = predicted_millis_until_count_backpressure - - @property - def predicted_millis_until_bytes_backpressure(self): + def predicted_bytes_at_next_interval(self): """ - Gets the predicted_millis_until_bytes_backpressure of this ConnectionStatisticsSnapshotDTO. - The predicted number of milliseconds before the connection will have backpressure applied, based on the total number of bytes in the queue. + Gets the predicted_bytes_at_next_interval of this ConnectionStatisticsSnapshotDTO. + The predicted total number of bytes in the queue at the next configured interval. - :return: The predicted_millis_until_bytes_backpressure of this ConnectionStatisticsSnapshotDTO. + :return: The predicted_bytes_at_next_interval of this ConnectionStatisticsSnapshotDTO. :rtype: int """ - return self._predicted_millis_until_bytes_backpressure + return self._predicted_bytes_at_next_interval - @predicted_millis_until_bytes_backpressure.setter - def predicted_millis_until_bytes_backpressure(self, predicted_millis_until_bytes_backpressure): + @predicted_bytes_at_next_interval.setter + def predicted_bytes_at_next_interval(self, predicted_bytes_at_next_interval): """ - Sets the predicted_millis_until_bytes_backpressure of this ConnectionStatisticsSnapshotDTO. - The predicted number of milliseconds before the connection will have backpressure applied, based on the total number of bytes in the queue. + Sets the predicted_bytes_at_next_interval of this ConnectionStatisticsSnapshotDTO. + The predicted total number of bytes in the queue at the next configured interval. - :param predicted_millis_until_bytes_backpressure: The predicted_millis_until_bytes_backpressure of this ConnectionStatisticsSnapshotDTO. + :param predicted_bytes_at_next_interval: The predicted_bytes_at_next_interval of this ConnectionStatisticsSnapshotDTO. :type: int """ - self._predicted_millis_until_bytes_backpressure = predicted_millis_until_bytes_backpressure + self._predicted_bytes_at_next_interval = predicted_bytes_at_next_interval @property def predicted_count_at_next_interval(self): @@ -173,50 +147,50 @@ def predicted_count_at_next_interval(self, predicted_count_at_next_interval): self._predicted_count_at_next_interval = predicted_count_at_next_interval @property - def predicted_bytes_at_next_interval(self): + def predicted_millis_until_bytes_backpressure(self): """ - Gets the predicted_bytes_at_next_interval of this ConnectionStatisticsSnapshotDTO. - The predicted total number of bytes in the queue at the next configured interval. + Gets the predicted_millis_until_bytes_backpressure of this ConnectionStatisticsSnapshotDTO. + The predicted number of milliseconds before the connection will have backpressure applied, based on the total number of bytes in the queue. - :return: The predicted_bytes_at_next_interval of this ConnectionStatisticsSnapshotDTO. + :return: The predicted_millis_until_bytes_backpressure of this ConnectionStatisticsSnapshotDTO. :rtype: int """ - return self._predicted_bytes_at_next_interval + return self._predicted_millis_until_bytes_backpressure - @predicted_bytes_at_next_interval.setter - def predicted_bytes_at_next_interval(self, predicted_bytes_at_next_interval): + @predicted_millis_until_bytes_backpressure.setter + def predicted_millis_until_bytes_backpressure(self, predicted_millis_until_bytes_backpressure): """ - Sets the predicted_bytes_at_next_interval of this ConnectionStatisticsSnapshotDTO. - The predicted total number of bytes in the queue at the next configured interval. + Sets the predicted_millis_until_bytes_backpressure of this ConnectionStatisticsSnapshotDTO. + The predicted number of milliseconds before the connection will have backpressure applied, based on the total number of bytes in the queue. - :param predicted_bytes_at_next_interval: The predicted_bytes_at_next_interval of this ConnectionStatisticsSnapshotDTO. + :param predicted_millis_until_bytes_backpressure: The predicted_millis_until_bytes_backpressure of this ConnectionStatisticsSnapshotDTO. :type: int """ - self._predicted_bytes_at_next_interval = predicted_bytes_at_next_interval + self._predicted_millis_until_bytes_backpressure = predicted_millis_until_bytes_backpressure @property - def predicted_percent_count(self): + def predicted_millis_until_count_backpressure(self): """ - Gets the predicted_percent_count of this ConnectionStatisticsSnapshotDTO. - The predicted percentage of queued objects at the next configured interval. + Gets the predicted_millis_until_count_backpressure of this ConnectionStatisticsSnapshotDTO. + The predicted number of milliseconds before the connection will have backpressure applied, based on the queued count. - :return: The predicted_percent_count of this ConnectionStatisticsSnapshotDTO. + :return: The predicted_millis_until_count_backpressure of this ConnectionStatisticsSnapshotDTO. :rtype: int """ - return self._predicted_percent_count + return self._predicted_millis_until_count_backpressure - @predicted_percent_count.setter - def predicted_percent_count(self, predicted_percent_count): + @predicted_millis_until_count_backpressure.setter + def predicted_millis_until_count_backpressure(self, predicted_millis_until_count_backpressure): """ - Sets the predicted_percent_count of this ConnectionStatisticsSnapshotDTO. - The predicted percentage of queued objects at the next configured interval. + Sets the predicted_millis_until_count_backpressure of this ConnectionStatisticsSnapshotDTO. + The predicted number of milliseconds before the connection will have backpressure applied, based on the queued count. - :param predicted_percent_count: The predicted_percent_count of this ConnectionStatisticsSnapshotDTO. + :param predicted_millis_until_count_backpressure: The predicted_millis_until_count_backpressure of this ConnectionStatisticsSnapshotDTO. :type: int """ - self._predicted_percent_count = predicted_percent_count + self._predicted_millis_until_count_backpressure = predicted_millis_until_count_backpressure @property def predicted_percent_bytes(self): @@ -241,6 +215,29 @@ def predicted_percent_bytes(self, predicted_percent_bytes): self._predicted_percent_bytes = predicted_percent_bytes + @property + def predicted_percent_count(self): + """ + Gets the predicted_percent_count of this ConnectionStatisticsSnapshotDTO. + The predicted percentage of queued objects at the next configured interval. + + :return: The predicted_percent_count of this ConnectionStatisticsSnapshotDTO. + :rtype: int + """ + return self._predicted_percent_count + + @predicted_percent_count.setter + def predicted_percent_count(self, predicted_percent_count): + """ + Sets the predicted_percent_count of this ConnectionStatisticsSnapshotDTO. + The predicted percentage of queued objects at the next configured interval. + + :param predicted_percent_count: The predicted_percent_count of this ConnectionStatisticsSnapshotDTO. + :type: int + """ + + self._predicted_percent_count = predicted_percent_count + @property def prediction_interval_millis(self): """ diff --git a/nipyapi/nifi/models/connection_status_dto.py b/nipyapi/nifi/models/connection_status_dto.py index fea7fea1..b91157a7 100644 --- a/nipyapi/nifi/models/connection_status_dto.py +++ b/nipyapi/nifi/models/connection_status_dto.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,90 +27,132 @@ class ConnectionStatusDTO(object): and the value is json key in definition. """ swagger_types = { - 'id': 'str', - 'group_id': 'str', - 'name': 'str', - 'stats_last_refreshed': 'str', - 'source_id': 'str', - 'source_name': 'str', - 'destination_id': 'str', - 'destination_name': 'str', 'aggregate_snapshot': 'ConnectionStatusSnapshotDTO', - 'node_snapshots': 'list[NodeConnectionStatusSnapshotDTO]' - } +'destination_id': 'str', +'destination_name': 'str', +'group_id': 'str', +'id': 'str', +'name': 'str', +'node_snapshots': 'list[NodeConnectionStatusSnapshotDTO]', +'source_id': 'str', +'source_name': 'str', +'stats_last_refreshed': 'str' } attribute_map = { - 'id': 'id', - 'group_id': 'groupId', - 'name': 'name', - 'stats_last_refreshed': 'statsLastRefreshed', - 'source_id': 'sourceId', - 'source_name': 'sourceName', - 'destination_id': 'destinationId', - 'destination_name': 'destinationName', 'aggregate_snapshot': 'aggregateSnapshot', - 'node_snapshots': 'nodeSnapshots' - } - - def __init__(self, id=None, group_id=None, name=None, stats_last_refreshed=None, source_id=None, source_name=None, destination_id=None, destination_name=None, aggregate_snapshot=None, node_snapshots=None): +'destination_id': 'destinationId', +'destination_name': 'destinationName', +'group_id': 'groupId', +'id': 'id', +'name': 'name', +'node_snapshots': 'nodeSnapshots', +'source_id': 'sourceId', +'source_name': 'sourceName', +'stats_last_refreshed': 'statsLastRefreshed' } + + def __init__(self, aggregate_snapshot=None, destination_id=None, destination_name=None, group_id=None, id=None, name=None, node_snapshots=None, source_id=None, source_name=None, stats_last_refreshed=None): """ ConnectionStatusDTO - a model defined in Swagger """ - self._id = None + self._aggregate_snapshot = None + self._destination_id = None + self._destination_name = None self._group_id = None + self._id = None self._name = None - self._stats_last_refreshed = None + self._node_snapshots = None self._source_id = None self._source_name = None - self._destination_id = None - self._destination_name = None - self._aggregate_snapshot = None - self._node_snapshots = None + self._stats_last_refreshed = None - if id is not None: - self.id = id + if aggregate_snapshot is not None: + self.aggregate_snapshot = aggregate_snapshot + if destination_id is not None: + self.destination_id = destination_id + if destination_name is not None: + self.destination_name = destination_name if group_id is not None: self.group_id = group_id + if id is not None: + self.id = id if name is not None: self.name = name - if stats_last_refreshed is not None: - self.stats_last_refreshed = stats_last_refreshed + if node_snapshots is not None: + self.node_snapshots = node_snapshots if source_id is not None: self.source_id = source_id if source_name is not None: self.source_name = source_name - if destination_id is not None: - self.destination_id = destination_id - if destination_name is not None: - self.destination_name = destination_name - if aggregate_snapshot is not None: - self.aggregate_snapshot = aggregate_snapshot - if node_snapshots is not None: - self.node_snapshots = node_snapshots + if stats_last_refreshed is not None: + self.stats_last_refreshed = stats_last_refreshed @property - def id(self): + def aggregate_snapshot(self): """ - Gets the id of this ConnectionStatusDTO. - The ID of the connection + Gets the aggregate_snapshot of this ConnectionStatusDTO. - :return: The id of this ConnectionStatusDTO. + :return: The aggregate_snapshot of this ConnectionStatusDTO. + :rtype: ConnectionStatusSnapshotDTO + """ + return self._aggregate_snapshot + + @aggregate_snapshot.setter + def aggregate_snapshot(self, aggregate_snapshot): + """ + Sets the aggregate_snapshot of this ConnectionStatusDTO. + + :param aggregate_snapshot: The aggregate_snapshot of this ConnectionStatusDTO. + :type: ConnectionStatusSnapshotDTO + """ + + self._aggregate_snapshot = aggregate_snapshot + + @property + def destination_id(self): + """ + Gets the destination_id of this ConnectionStatusDTO. + The ID of the destination component + + :return: The destination_id of this ConnectionStatusDTO. :rtype: str """ - return self._id + return self._destination_id - @id.setter - def id(self, id): + @destination_id.setter + def destination_id(self, destination_id): """ - Sets the id of this ConnectionStatusDTO. - The ID of the connection + Sets the destination_id of this ConnectionStatusDTO. + The ID of the destination component - :param id: The id of this ConnectionStatusDTO. + :param destination_id: The destination_id of this ConnectionStatusDTO. :type: str """ - self._id = id + self._destination_id = destination_id + + @property + def destination_name(self): + """ + Gets the destination_name of this ConnectionStatusDTO. + The name of the destination component + + :return: The destination_name of this ConnectionStatusDTO. + :rtype: str + """ + return self._destination_name + + @destination_name.setter + def destination_name(self, destination_name): + """ + Sets the destination_name of this ConnectionStatusDTO. + The name of the destination component + + :param destination_name: The destination_name of this ConnectionStatusDTO. + :type: str + """ + + self._destination_name = destination_name @property def group_id(self): @@ -136,6 +177,29 @@ def group_id(self, group_id): self._group_id = group_id + @property + def id(self): + """ + Gets the id of this ConnectionStatusDTO. + The ID of the connection + + :return: The id of this ConnectionStatusDTO. + :rtype: str + """ + return self._id + + @id.setter + def id(self, id): + """ + Sets the id of this ConnectionStatusDTO. + The ID of the connection + + :param id: The id of this ConnectionStatusDTO. + :type: str + """ + + self._id = id + @property def name(self): """ @@ -160,27 +224,27 @@ def name(self, name): self._name = name @property - def stats_last_refreshed(self): + def node_snapshots(self): """ - Gets the stats_last_refreshed of this ConnectionStatusDTO. - The timestamp of when the stats were last refreshed + Gets the node_snapshots of this ConnectionStatusDTO. + A list of status snapshots for each node - :return: The stats_last_refreshed of this ConnectionStatusDTO. - :rtype: str + :return: The node_snapshots of this ConnectionStatusDTO. + :rtype: list[NodeConnectionStatusSnapshotDTO] """ - return self._stats_last_refreshed + return self._node_snapshots - @stats_last_refreshed.setter - def stats_last_refreshed(self, stats_last_refreshed): + @node_snapshots.setter + def node_snapshots(self, node_snapshots): """ - Sets the stats_last_refreshed of this ConnectionStatusDTO. - The timestamp of when the stats were last refreshed + Sets the node_snapshots of this ConnectionStatusDTO. + A list of status snapshots for each node - :param stats_last_refreshed: The stats_last_refreshed of this ConnectionStatusDTO. - :type: str + :param node_snapshots: The node_snapshots of this ConnectionStatusDTO. + :type: list[NodeConnectionStatusSnapshotDTO] """ - self._stats_last_refreshed = stats_last_refreshed + self._node_snapshots = node_snapshots @property def source_id(self): @@ -229,96 +293,27 @@ def source_name(self, source_name): self._source_name = source_name @property - def destination_id(self): - """ - Gets the destination_id of this ConnectionStatusDTO. - The ID of the destination component - - :return: The destination_id of this ConnectionStatusDTO. - :rtype: str - """ - return self._destination_id - - @destination_id.setter - def destination_id(self, destination_id): - """ - Sets the destination_id of this ConnectionStatusDTO. - The ID of the destination component - - :param destination_id: The destination_id of this ConnectionStatusDTO. - :type: str - """ - - self._destination_id = destination_id - - @property - def destination_name(self): + def stats_last_refreshed(self): """ - Gets the destination_name of this ConnectionStatusDTO. - The name of the destination component + Gets the stats_last_refreshed of this ConnectionStatusDTO. + The timestamp of when the stats were last refreshed - :return: The destination_name of this ConnectionStatusDTO. + :return: The stats_last_refreshed of this ConnectionStatusDTO. :rtype: str """ - return self._destination_name + return self._stats_last_refreshed - @destination_name.setter - def destination_name(self, destination_name): + @stats_last_refreshed.setter + def stats_last_refreshed(self, stats_last_refreshed): """ - Sets the destination_name of this ConnectionStatusDTO. - The name of the destination component + Sets the stats_last_refreshed of this ConnectionStatusDTO. + The timestamp of when the stats were last refreshed - :param destination_name: The destination_name of this ConnectionStatusDTO. + :param stats_last_refreshed: The stats_last_refreshed of this ConnectionStatusDTO. :type: str """ - self._destination_name = destination_name - - @property - def aggregate_snapshot(self): - """ - Gets the aggregate_snapshot of this ConnectionStatusDTO. - The status snapshot that represents the aggregate stats of the cluster - - :return: The aggregate_snapshot of this ConnectionStatusDTO. - :rtype: ConnectionStatusSnapshotDTO - """ - return self._aggregate_snapshot - - @aggregate_snapshot.setter - def aggregate_snapshot(self, aggregate_snapshot): - """ - Sets the aggregate_snapshot of this ConnectionStatusDTO. - The status snapshot that represents the aggregate stats of the cluster - - :param aggregate_snapshot: The aggregate_snapshot of this ConnectionStatusDTO. - :type: ConnectionStatusSnapshotDTO - """ - - self._aggregate_snapshot = aggregate_snapshot - - @property - def node_snapshots(self): - """ - Gets the node_snapshots of this ConnectionStatusDTO. - A list of status snapshots for each node - - :return: The node_snapshots of this ConnectionStatusDTO. - :rtype: list[NodeConnectionStatusSnapshotDTO] - """ - return self._node_snapshots - - @node_snapshots.setter - def node_snapshots(self, node_snapshots): - """ - Sets the node_snapshots of this ConnectionStatusDTO. - A list of status snapshots for each node - - :param node_snapshots: The node_snapshots of this ConnectionStatusDTO. - :type: list[NodeConnectionStatusSnapshotDTO] - """ - - self._node_snapshots = node_snapshots + self._stats_last_refreshed = stats_last_refreshed def to_dict(self): """ diff --git a/nipyapi/nifi/models/connection_status_entity.py b/nipyapi/nifi/models/connection_status_entity.py index a0c154d7..f42a4412 100644 --- a/nipyapi/nifi/models/connection_status_entity.py +++ b/nipyapi/nifi/models/connection_status_entity.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,48 +27,25 @@ class ConnectionStatusEntity(object): and the value is json key in definition. """ swagger_types = { - 'connection_status': 'ConnectionStatusDTO', - 'can_read': 'bool' - } + 'can_read': 'bool', +'connection_status': 'ConnectionStatusDTO' } attribute_map = { - 'connection_status': 'connectionStatus', - 'can_read': 'canRead' - } + 'can_read': 'canRead', +'connection_status': 'connectionStatus' } - def __init__(self, connection_status=None, can_read=None): + def __init__(self, can_read=None, connection_status=None): """ ConnectionStatusEntity - a model defined in Swagger """ - self._connection_status = None self._can_read = None + self._connection_status = None - if connection_status is not None: - self.connection_status = connection_status if can_read is not None: self.can_read = can_read - - @property - def connection_status(self): - """ - Gets the connection_status of this ConnectionStatusEntity. - - :return: The connection_status of this ConnectionStatusEntity. - :rtype: ConnectionStatusDTO - """ - return self._connection_status - - @connection_status.setter - def connection_status(self, connection_status): - """ - Sets the connection_status of this ConnectionStatusEntity. - - :param connection_status: The connection_status of this ConnectionStatusEntity. - :type: ConnectionStatusDTO - """ - - self._connection_status = connection_status + if connection_status is not None: + self.connection_status = connection_status @property def can_read(self): @@ -94,6 +70,27 @@ def can_read(self, can_read): self._can_read = can_read + @property + def connection_status(self): + """ + Gets the connection_status of this ConnectionStatusEntity. + + :return: The connection_status of this ConnectionStatusEntity. + :rtype: ConnectionStatusDTO + """ + return self._connection_status + + @connection_status.setter + def connection_status(self, connection_status): + """ + Sets the connection_status of this ConnectionStatusEntity. + + :param connection_status: The connection_status of this ConnectionStatusEntity. + :type: ConnectionStatusDTO + """ + + self._connection_status = connection_status + def to_dict(self): """ Returns the model properties as a dict diff --git a/nipyapi/nifi/models/connection_status_predictions_snapshot_dto.py b/nipyapi/nifi/models/connection_status_predictions_snapshot_dto.py index 02fd1f20..e4b5cf68 100644 --- a/nipyapi/nifi/models/connection_status_predictions_snapshot_dto.py +++ b/nipyapi/nifi/models/connection_status_predictions_snapshot_dto.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,167 +27,165 @@ class ConnectionStatusPredictionsSnapshotDTO(object): and the value is json key in definition. """ swagger_types = { - 'predicted_millis_until_count_backpressure': 'int', - 'predicted_millis_until_bytes_backpressure': 'int', - 'prediction_interval_seconds': 'int', - 'predicted_count_at_next_interval': 'int', 'predicted_bytes_at_next_interval': 'int', - 'predicted_percent_count': 'int', - 'predicted_percent_bytes': 'int' - } +'predicted_count_at_next_interval': 'int', +'predicted_millis_until_bytes_backpressure': 'int', +'predicted_millis_until_count_backpressure': 'int', +'predicted_percent_bytes': 'int', +'predicted_percent_count': 'int', +'prediction_interval_seconds': 'int' } attribute_map = { - 'predicted_millis_until_count_backpressure': 'predictedMillisUntilCountBackpressure', - 'predicted_millis_until_bytes_backpressure': 'predictedMillisUntilBytesBackpressure', - 'prediction_interval_seconds': 'predictionIntervalSeconds', - 'predicted_count_at_next_interval': 'predictedCountAtNextInterval', 'predicted_bytes_at_next_interval': 'predictedBytesAtNextInterval', - 'predicted_percent_count': 'predictedPercentCount', - 'predicted_percent_bytes': 'predictedPercentBytes' - } +'predicted_count_at_next_interval': 'predictedCountAtNextInterval', +'predicted_millis_until_bytes_backpressure': 'predictedMillisUntilBytesBackpressure', +'predicted_millis_until_count_backpressure': 'predictedMillisUntilCountBackpressure', +'predicted_percent_bytes': 'predictedPercentBytes', +'predicted_percent_count': 'predictedPercentCount', +'prediction_interval_seconds': 'predictionIntervalSeconds' } - def __init__(self, predicted_millis_until_count_backpressure=None, predicted_millis_until_bytes_backpressure=None, prediction_interval_seconds=None, predicted_count_at_next_interval=None, predicted_bytes_at_next_interval=None, predicted_percent_count=None, predicted_percent_bytes=None): + def __init__(self, predicted_bytes_at_next_interval=None, predicted_count_at_next_interval=None, predicted_millis_until_bytes_backpressure=None, predicted_millis_until_count_backpressure=None, predicted_percent_bytes=None, predicted_percent_count=None, prediction_interval_seconds=None): """ ConnectionStatusPredictionsSnapshotDTO - a model defined in Swagger """ - self._predicted_millis_until_count_backpressure = None - self._predicted_millis_until_bytes_backpressure = None - self._prediction_interval_seconds = None - self._predicted_count_at_next_interval = None self._predicted_bytes_at_next_interval = None - self._predicted_percent_count = None + self._predicted_count_at_next_interval = None + self._predicted_millis_until_bytes_backpressure = None + self._predicted_millis_until_count_backpressure = None self._predicted_percent_bytes = None + self._predicted_percent_count = None + self._prediction_interval_seconds = None - if predicted_millis_until_count_backpressure is not None: - self.predicted_millis_until_count_backpressure = predicted_millis_until_count_backpressure - if predicted_millis_until_bytes_backpressure is not None: - self.predicted_millis_until_bytes_backpressure = predicted_millis_until_bytes_backpressure - if prediction_interval_seconds is not None: - self.prediction_interval_seconds = prediction_interval_seconds - if predicted_count_at_next_interval is not None: - self.predicted_count_at_next_interval = predicted_count_at_next_interval if predicted_bytes_at_next_interval is not None: self.predicted_bytes_at_next_interval = predicted_bytes_at_next_interval - if predicted_percent_count is not None: - self.predicted_percent_count = predicted_percent_count + if predicted_count_at_next_interval is not None: + self.predicted_count_at_next_interval = predicted_count_at_next_interval + if predicted_millis_until_bytes_backpressure is not None: + self.predicted_millis_until_bytes_backpressure = predicted_millis_until_bytes_backpressure + if predicted_millis_until_count_backpressure is not None: + self.predicted_millis_until_count_backpressure = predicted_millis_until_count_backpressure if predicted_percent_bytes is not None: self.predicted_percent_bytes = predicted_percent_bytes + if predicted_percent_count is not None: + self.predicted_percent_count = predicted_percent_count + if prediction_interval_seconds is not None: + self.prediction_interval_seconds = prediction_interval_seconds @property - def predicted_millis_until_count_backpressure(self): + def predicted_bytes_at_next_interval(self): """ - Gets the predicted_millis_until_count_backpressure of this ConnectionStatusPredictionsSnapshotDTO. - The predicted number of milliseconds before the connection will have backpressure applied, based on the queued count. + Gets the predicted_bytes_at_next_interval of this ConnectionStatusPredictionsSnapshotDTO. + The predicted total number of bytes in the queue at the next configured interval. - :return: The predicted_millis_until_count_backpressure of this ConnectionStatusPredictionsSnapshotDTO. + :return: The predicted_bytes_at_next_interval of this ConnectionStatusPredictionsSnapshotDTO. :rtype: int """ - return self._predicted_millis_until_count_backpressure + return self._predicted_bytes_at_next_interval - @predicted_millis_until_count_backpressure.setter - def predicted_millis_until_count_backpressure(self, predicted_millis_until_count_backpressure): + @predicted_bytes_at_next_interval.setter + def predicted_bytes_at_next_interval(self, predicted_bytes_at_next_interval): """ - Sets the predicted_millis_until_count_backpressure of this ConnectionStatusPredictionsSnapshotDTO. - The predicted number of milliseconds before the connection will have backpressure applied, based on the queued count. + Sets the predicted_bytes_at_next_interval of this ConnectionStatusPredictionsSnapshotDTO. + The predicted total number of bytes in the queue at the next configured interval. - :param predicted_millis_until_count_backpressure: The predicted_millis_until_count_backpressure of this ConnectionStatusPredictionsSnapshotDTO. + :param predicted_bytes_at_next_interval: The predicted_bytes_at_next_interval of this ConnectionStatusPredictionsSnapshotDTO. :type: int """ - self._predicted_millis_until_count_backpressure = predicted_millis_until_count_backpressure + self._predicted_bytes_at_next_interval = predicted_bytes_at_next_interval @property - def predicted_millis_until_bytes_backpressure(self): + def predicted_count_at_next_interval(self): """ - Gets the predicted_millis_until_bytes_backpressure of this ConnectionStatusPredictionsSnapshotDTO. - The predicted number of milliseconds before the connection will have backpressure applied, based on the total number of bytes in the queue. + Gets the predicted_count_at_next_interval of this ConnectionStatusPredictionsSnapshotDTO. + The predicted number of queued objects at the next configured interval. - :return: The predicted_millis_until_bytes_backpressure of this ConnectionStatusPredictionsSnapshotDTO. + :return: The predicted_count_at_next_interval of this ConnectionStatusPredictionsSnapshotDTO. :rtype: int """ - return self._predicted_millis_until_bytes_backpressure + return self._predicted_count_at_next_interval - @predicted_millis_until_bytes_backpressure.setter - def predicted_millis_until_bytes_backpressure(self, predicted_millis_until_bytes_backpressure): + @predicted_count_at_next_interval.setter + def predicted_count_at_next_interval(self, predicted_count_at_next_interval): """ - Sets the predicted_millis_until_bytes_backpressure of this ConnectionStatusPredictionsSnapshotDTO. - The predicted number of milliseconds before the connection will have backpressure applied, based on the total number of bytes in the queue. + Sets the predicted_count_at_next_interval of this ConnectionStatusPredictionsSnapshotDTO. + The predicted number of queued objects at the next configured interval. - :param predicted_millis_until_bytes_backpressure: The predicted_millis_until_bytes_backpressure of this ConnectionStatusPredictionsSnapshotDTO. + :param predicted_count_at_next_interval: The predicted_count_at_next_interval of this ConnectionStatusPredictionsSnapshotDTO. :type: int """ - self._predicted_millis_until_bytes_backpressure = predicted_millis_until_bytes_backpressure + self._predicted_count_at_next_interval = predicted_count_at_next_interval @property - def prediction_interval_seconds(self): + def predicted_millis_until_bytes_backpressure(self): """ - Gets the prediction_interval_seconds of this ConnectionStatusPredictionsSnapshotDTO. - The configured interval (in seconds) for predicting connection queue count and size (and percent usage). + Gets the predicted_millis_until_bytes_backpressure of this ConnectionStatusPredictionsSnapshotDTO. + The predicted number of milliseconds before the connection will have backpressure applied, based on the total number of bytes in the queue. - :return: The prediction_interval_seconds of this ConnectionStatusPredictionsSnapshotDTO. + :return: The predicted_millis_until_bytes_backpressure of this ConnectionStatusPredictionsSnapshotDTO. :rtype: int """ - return self._prediction_interval_seconds + return self._predicted_millis_until_bytes_backpressure - @prediction_interval_seconds.setter - def prediction_interval_seconds(self, prediction_interval_seconds): + @predicted_millis_until_bytes_backpressure.setter + def predicted_millis_until_bytes_backpressure(self, predicted_millis_until_bytes_backpressure): """ - Sets the prediction_interval_seconds of this ConnectionStatusPredictionsSnapshotDTO. - The configured interval (in seconds) for predicting connection queue count and size (and percent usage). + Sets the predicted_millis_until_bytes_backpressure of this ConnectionStatusPredictionsSnapshotDTO. + The predicted number of milliseconds before the connection will have backpressure applied, based on the total number of bytes in the queue. - :param prediction_interval_seconds: The prediction_interval_seconds of this ConnectionStatusPredictionsSnapshotDTO. + :param predicted_millis_until_bytes_backpressure: The predicted_millis_until_bytes_backpressure of this ConnectionStatusPredictionsSnapshotDTO. :type: int """ - self._prediction_interval_seconds = prediction_interval_seconds + self._predicted_millis_until_bytes_backpressure = predicted_millis_until_bytes_backpressure @property - def predicted_count_at_next_interval(self): + def predicted_millis_until_count_backpressure(self): """ - Gets the predicted_count_at_next_interval of this ConnectionStatusPredictionsSnapshotDTO. - The predicted number of queued objects at the next configured interval. + Gets the predicted_millis_until_count_backpressure of this ConnectionStatusPredictionsSnapshotDTO. + The predicted number of milliseconds before the connection will have backpressure applied, based on the queued count. - :return: The predicted_count_at_next_interval of this ConnectionStatusPredictionsSnapshotDTO. + :return: The predicted_millis_until_count_backpressure of this ConnectionStatusPredictionsSnapshotDTO. :rtype: int """ - return self._predicted_count_at_next_interval + return self._predicted_millis_until_count_backpressure - @predicted_count_at_next_interval.setter - def predicted_count_at_next_interval(self, predicted_count_at_next_interval): + @predicted_millis_until_count_backpressure.setter + def predicted_millis_until_count_backpressure(self, predicted_millis_until_count_backpressure): """ - Sets the predicted_count_at_next_interval of this ConnectionStatusPredictionsSnapshotDTO. - The predicted number of queued objects at the next configured interval. + Sets the predicted_millis_until_count_backpressure of this ConnectionStatusPredictionsSnapshotDTO. + The predicted number of milliseconds before the connection will have backpressure applied, based on the queued count. - :param predicted_count_at_next_interval: The predicted_count_at_next_interval of this ConnectionStatusPredictionsSnapshotDTO. + :param predicted_millis_until_count_backpressure: The predicted_millis_until_count_backpressure of this ConnectionStatusPredictionsSnapshotDTO. :type: int """ - self._predicted_count_at_next_interval = predicted_count_at_next_interval + self._predicted_millis_until_count_backpressure = predicted_millis_until_count_backpressure @property - def predicted_bytes_at_next_interval(self): + def predicted_percent_bytes(self): """ - Gets the predicted_bytes_at_next_interval of this ConnectionStatusPredictionsSnapshotDTO. - The predicted total number of bytes in the queue at the next configured interval. + Gets the predicted_percent_bytes of this ConnectionStatusPredictionsSnapshotDTO. + Predicted connection percent use regarding queued flow files size and backpressure threshold if configured. - :return: The predicted_bytes_at_next_interval of this ConnectionStatusPredictionsSnapshotDTO. + :return: The predicted_percent_bytes of this ConnectionStatusPredictionsSnapshotDTO. :rtype: int """ - return self._predicted_bytes_at_next_interval + return self._predicted_percent_bytes - @predicted_bytes_at_next_interval.setter - def predicted_bytes_at_next_interval(self, predicted_bytes_at_next_interval): + @predicted_percent_bytes.setter + def predicted_percent_bytes(self, predicted_percent_bytes): """ - Sets the predicted_bytes_at_next_interval of this ConnectionStatusPredictionsSnapshotDTO. - The predicted total number of bytes in the queue at the next configured interval. + Sets the predicted_percent_bytes of this ConnectionStatusPredictionsSnapshotDTO. + Predicted connection percent use regarding queued flow files size and backpressure threshold if configured. - :param predicted_bytes_at_next_interval: The predicted_bytes_at_next_interval of this ConnectionStatusPredictionsSnapshotDTO. + :param predicted_percent_bytes: The predicted_percent_bytes of this ConnectionStatusPredictionsSnapshotDTO. :type: int """ - self._predicted_bytes_at_next_interval = predicted_bytes_at_next_interval + self._predicted_percent_bytes = predicted_percent_bytes @property def predicted_percent_count(self): @@ -214,27 +211,27 @@ def predicted_percent_count(self, predicted_percent_count): self._predicted_percent_count = predicted_percent_count @property - def predicted_percent_bytes(self): + def prediction_interval_seconds(self): """ - Gets the predicted_percent_bytes of this ConnectionStatusPredictionsSnapshotDTO. - Predicted connection percent use regarding queued flow files size and backpressure threshold if configured. + Gets the prediction_interval_seconds of this ConnectionStatusPredictionsSnapshotDTO. + The configured interval (in seconds) for predicting connection queue count and size (and percent usage). - :return: The predicted_percent_bytes of this ConnectionStatusPredictionsSnapshotDTO. + :return: The prediction_interval_seconds of this ConnectionStatusPredictionsSnapshotDTO. :rtype: int """ - return self._predicted_percent_bytes + return self._prediction_interval_seconds - @predicted_percent_bytes.setter - def predicted_percent_bytes(self, predicted_percent_bytes): + @prediction_interval_seconds.setter + def prediction_interval_seconds(self, prediction_interval_seconds): """ - Sets the predicted_percent_bytes of this ConnectionStatusPredictionsSnapshotDTO. - Predicted connection percent use regarding queued flow files size and backpressure threshold if configured. + Sets the prediction_interval_seconds of this ConnectionStatusPredictionsSnapshotDTO. + The configured interval (in seconds) for predicting connection queue count and size (and percent usage). - :param predicted_percent_bytes: The predicted_percent_bytes of this ConnectionStatusPredictionsSnapshotDTO. + :param prediction_interval_seconds: The prediction_interval_seconds of this ConnectionStatusPredictionsSnapshotDTO. :type: int """ - self._predicted_percent_bytes = predicted_percent_bytes + self._prediction_interval_seconds = prediction_interval_seconds def to_dict(self): """ diff --git a/nipyapi/nifi/models/connection_status_snapshot_dto.py b/nipyapi/nifi/models/connection_status_snapshot_dto.py index c240c5b6..fde8edd6 100644 --- a/nipyapi/nifi/models/connection_status_snapshot_dto.py +++ b/nipyapi/nifi/models/connection_status_snapshot_dto.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,242 +27,194 @@ class ConnectionStatusSnapshotDTO(object): and the value is json key in definition. """ swagger_types = { - 'id': 'str', - 'group_id': 'str', - 'name': 'str', - 'source_id': 'str', - 'source_name': 'str', - 'destination_id': 'str', - 'destination_name': 'str', - 'predictions': 'ConnectionStatusPredictionsSnapshotDTO', - 'flow_files_in': 'int', 'bytes_in': 'int', - 'input': 'str', - 'flow_files_out': 'int', - 'bytes_out': 'int', - 'output': 'str', - 'flow_files_queued': 'int', - 'bytes_queued': 'int', - 'queued': 'str', - 'queued_size': 'str', - 'queued_count': 'str', - 'percent_use_count': 'int', - 'percent_use_bytes': 'int', - 'flow_file_availability': 'str' - } +'bytes_out': 'int', +'bytes_queued': 'int', +'destination_id': 'str', +'destination_name': 'str', +'flow_file_availability': 'str', +'flow_files_in': 'int', +'flow_files_out': 'int', +'flow_files_queued': 'int', +'group_id': 'str', +'id': 'str', +'input': 'str', +'name': 'str', +'output': 'str', +'percent_use_bytes': 'int', +'percent_use_count': 'int', +'predictions': 'ConnectionStatusPredictionsSnapshotDTO', +'queued': 'str', +'queued_count': 'str', +'queued_size': 'str', +'source_id': 'str', +'source_name': 'str' } attribute_map = { - 'id': 'id', - 'group_id': 'groupId', - 'name': 'name', - 'source_id': 'sourceId', - 'source_name': 'sourceName', - 'destination_id': 'destinationId', - 'destination_name': 'destinationName', - 'predictions': 'predictions', - 'flow_files_in': 'flowFilesIn', 'bytes_in': 'bytesIn', - 'input': 'input', - 'flow_files_out': 'flowFilesOut', - 'bytes_out': 'bytesOut', - 'output': 'output', - 'flow_files_queued': 'flowFilesQueued', - 'bytes_queued': 'bytesQueued', - 'queued': 'queued', - 'queued_size': 'queuedSize', - 'queued_count': 'queuedCount', - 'percent_use_count': 'percentUseCount', - 'percent_use_bytes': 'percentUseBytes', - 'flow_file_availability': 'flowFileAvailability' - } - - def __init__(self, id=None, group_id=None, name=None, source_id=None, source_name=None, destination_id=None, destination_name=None, predictions=None, flow_files_in=None, bytes_in=None, input=None, flow_files_out=None, bytes_out=None, output=None, flow_files_queued=None, bytes_queued=None, queued=None, queued_size=None, queued_count=None, percent_use_count=None, percent_use_bytes=None, flow_file_availability=None): +'bytes_out': 'bytesOut', +'bytes_queued': 'bytesQueued', +'destination_id': 'destinationId', +'destination_name': 'destinationName', +'flow_file_availability': 'flowFileAvailability', +'flow_files_in': 'flowFilesIn', +'flow_files_out': 'flowFilesOut', +'flow_files_queued': 'flowFilesQueued', +'group_id': 'groupId', +'id': 'id', +'input': 'input', +'name': 'name', +'output': 'output', +'percent_use_bytes': 'percentUseBytes', +'percent_use_count': 'percentUseCount', +'predictions': 'predictions', +'queued': 'queued', +'queued_count': 'queuedCount', +'queued_size': 'queuedSize', +'source_id': 'sourceId', +'source_name': 'sourceName' } + + def __init__(self, bytes_in=None, bytes_out=None, bytes_queued=None, destination_id=None, destination_name=None, flow_file_availability=None, flow_files_in=None, flow_files_out=None, flow_files_queued=None, group_id=None, id=None, input=None, name=None, output=None, percent_use_bytes=None, percent_use_count=None, predictions=None, queued=None, queued_count=None, queued_size=None, source_id=None, source_name=None): """ ConnectionStatusSnapshotDTO - a model defined in Swagger """ - self._id = None - self._group_id = None - self._name = None - self._source_id = None - self._source_name = None + self._bytes_in = None + self._bytes_out = None + self._bytes_queued = None self._destination_id = None self._destination_name = None - self._predictions = None + self._flow_file_availability = None self._flow_files_in = None - self._bytes_in = None - self._input = None self._flow_files_out = None - self._bytes_out = None - self._output = None self._flow_files_queued = None - self._bytes_queued = None + self._group_id = None + self._id = None + self._input = None + self._name = None + self._output = None + self._percent_use_bytes = None + self._percent_use_count = None + self._predictions = None self._queued = None - self._queued_size = None self._queued_count = None - self._percent_use_count = None - self._percent_use_bytes = None - self._flow_file_availability = None + self._queued_size = None + self._source_id = None + self._source_name = None - if id is not None: - self.id = id - if group_id is not None: - self.group_id = group_id - if name is not None: - self.name = name - if source_id is not None: - self.source_id = source_id - if source_name is not None: - self.source_name = source_name + if bytes_in is not None: + self.bytes_in = bytes_in + if bytes_out is not None: + self.bytes_out = bytes_out + if bytes_queued is not None: + self.bytes_queued = bytes_queued if destination_id is not None: self.destination_id = destination_id if destination_name is not None: self.destination_name = destination_name - if predictions is not None: - self.predictions = predictions + if flow_file_availability is not None: + self.flow_file_availability = flow_file_availability if flow_files_in is not None: self.flow_files_in = flow_files_in - if bytes_in is not None: - self.bytes_in = bytes_in - if input is not None: - self.input = input if flow_files_out is not None: self.flow_files_out = flow_files_out - if bytes_out is not None: - self.bytes_out = bytes_out - if output is not None: - self.output = output if flow_files_queued is not None: self.flow_files_queued = flow_files_queued - if bytes_queued is not None: - self.bytes_queued = bytes_queued + if group_id is not None: + self.group_id = group_id + if id is not None: + self.id = id + if input is not None: + self.input = input + if name is not None: + self.name = name + if output is not None: + self.output = output + if percent_use_bytes is not None: + self.percent_use_bytes = percent_use_bytes + if percent_use_count is not None: + self.percent_use_count = percent_use_count + if predictions is not None: + self.predictions = predictions if queued is not None: self.queued = queued - if queued_size is not None: - self.queued_size = queued_size if queued_count is not None: self.queued_count = queued_count - if percent_use_count is not None: - self.percent_use_count = percent_use_count - if percent_use_bytes is not None: - self.percent_use_bytes = percent_use_bytes - if flow_file_availability is not None: - self.flow_file_availability = flow_file_availability - - @property - def id(self): - """ - Gets the id of this ConnectionStatusSnapshotDTO. - The id of the connection. - - :return: The id of this ConnectionStatusSnapshotDTO. - :rtype: str - """ - return self._id - - @id.setter - def id(self, id): - """ - Sets the id of this ConnectionStatusSnapshotDTO. - The id of the connection. - - :param id: The id of this ConnectionStatusSnapshotDTO. - :type: str - """ - - self._id = id - - @property - def group_id(self): - """ - Gets the group_id of this ConnectionStatusSnapshotDTO. - The id of the process group the connection belongs to. - - :return: The group_id of this ConnectionStatusSnapshotDTO. - :rtype: str - """ - return self._group_id - - @group_id.setter - def group_id(self, group_id): - """ - Sets the group_id of this ConnectionStatusSnapshotDTO. - The id of the process group the connection belongs to. - - :param group_id: The group_id of this ConnectionStatusSnapshotDTO. - :type: str - """ - - self._group_id = group_id + if queued_size is not None: + self.queued_size = queued_size + if source_id is not None: + self.source_id = source_id + if source_name is not None: + self.source_name = source_name @property - def name(self): + def bytes_in(self): """ - Gets the name of this ConnectionStatusSnapshotDTO. - The name of the connection. + Gets the bytes_in of this ConnectionStatusSnapshotDTO. + The size of the FlowFiles that have come into the connection in the last 5 minutes. - :return: The name of this ConnectionStatusSnapshotDTO. - :rtype: str + :return: The bytes_in of this ConnectionStatusSnapshotDTO. + :rtype: int """ - return self._name + return self._bytes_in - @name.setter - def name(self, name): + @bytes_in.setter + def bytes_in(self, bytes_in): """ - Sets the name of this ConnectionStatusSnapshotDTO. - The name of the connection. + Sets the bytes_in of this ConnectionStatusSnapshotDTO. + The size of the FlowFiles that have come into the connection in the last 5 minutes. - :param name: The name of this ConnectionStatusSnapshotDTO. - :type: str + :param bytes_in: The bytes_in of this ConnectionStatusSnapshotDTO. + :type: int """ - self._name = name + self._bytes_in = bytes_in @property - def source_id(self): + def bytes_out(self): """ - Gets the source_id of this ConnectionStatusSnapshotDTO. - The id of the source of the connection. + Gets the bytes_out of this ConnectionStatusSnapshotDTO. + The number of bytes that have left the connection in the last 5 minutes. - :return: The source_id of this ConnectionStatusSnapshotDTO. - :rtype: str + :return: The bytes_out of this ConnectionStatusSnapshotDTO. + :rtype: int """ - return self._source_id + return self._bytes_out - @source_id.setter - def source_id(self, source_id): + @bytes_out.setter + def bytes_out(self, bytes_out): """ - Sets the source_id of this ConnectionStatusSnapshotDTO. - The id of the source of the connection. + Sets the bytes_out of this ConnectionStatusSnapshotDTO. + The number of bytes that have left the connection in the last 5 minutes. - :param source_id: The source_id of this ConnectionStatusSnapshotDTO. - :type: str + :param bytes_out: The bytes_out of this ConnectionStatusSnapshotDTO. + :type: int """ - self._source_id = source_id + self._bytes_out = bytes_out @property - def source_name(self): + def bytes_queued(self): """ - Gets the source_name of this ConnectionStatusSnapshotDTO. - The name of the source of the connection. + Gets the bytes_queued of this ConnectionStatusSnapshotDTO. + The size of the FlowFiles that are currently queued in the connection. - :return: The source_name of this ConnectionStatusSnapshotDTO. - :rtype: str + :return: The bytes_queued of this ConnectionStatusSnapshotDTO. + :rtype: int """ - return self._source_name + return self._bytes_queued - @source_name.setter - def source_name(self, source_name): + @bytes_queued.setter + def bytes_queued(self, bytes_queued): """ - Sets the source_name of this ConnectionStatusSnapshotDTO. - The name of the source of the connection. + Sets the bytes_queued of this ConnectionStatusSnapshotDTO. + The size of the FlowFiles that are currently queued in the connection. - :param source_name: The source_name of this ConnectionStatusSnapshotDTO. - :type: str + :param bytes_queued: The bytes_queued of this ConnectionStatusSnapshotDTO. + :type: int """ - self._source_name = source_name + self._bytes_queued = bytes_queued @property def destination_id(self): @@ -312,27 +263,27 @@ def destination_name(self, destination_name): self._destination_name = destination_name @property - def predictions(self): + def flow_file_availability(self): """ - Gets the predictions of this ConnectionStatusSnapshotDTO. - Predictions, if available, for this connection (null if not available) + Gets the flow_file_availability of this ConnectionStatusSnapshotDTO. + The availability of FlowFiles in this connection - :return: The predictions of this ConnectionStatusSnapshotDTO. - :rtype: ConnectionStatusPredictionsSnapshotDTO + :return: The flow_file_availability of this ConnectionStatusSnapshotDTO. + :rtype: str """ - return self._predictions + return self._flow_file_availability - @predictions.setter - def predictions(self, predictions): + @flow_file_availability.setter + def flow_file_availability(self, flow_file_availability): """ - Sets the predictions of this ConnectionStatusSnapshotDTO. - Predictions, if available, for this connection (null if not available) + Sets the flow_file_availability of this ConnectionStatusSnapshotDTO. + The availability of FlowFiles in this connection - :param predictions: The predictions of this ConnectionStatusSnapshotDTO. - :type: ConnectionStatusPredictionsSnapshotDTO + :param flow_file_availability: The flow_file_availability of this ConnectionStatusSnapshotDTO. + :type: str """ - self._predictions = predictions + self._flow_file_availability = flow_file_availability @property def flow_files_in(self): @@ -343,42 +294,111 @@ def flow_files_in(self): :return: The flow_files_in of this ConnectionStatusSnapshotDTO. :rtype: int """ - return self._flow_files_in + return self._flow_files_in + + @flow_files_in.setter + def flow_files_in(self, flow_files_in): + """ + Sets the flow_files_in of this ConnectionStatusSnapshotDTO. + The number of FlowFiles that have come into the connection in the last 5 minutes. + + :param flow_files_in: The flow_files_in of this ConnectionStatusSnapshotDTO. + :type: int + """ + + self._flow_files_in = flow_files_in + + @property + def flow_files_out(self): + """ + Gets the flow_files_out of this ConnectionStatusSnapshotDTO. + The number of FlowFiles that have left the connection in the last 5 minutes. + + :return: The flow_files_out of this ConnectionStatusSnapshotDTO. + :rtype: int + """ + return self._flow_files_out + + @flow_files_out.setter + def flow_files_out(self, flow_files_out): + """ + Sets the flow_files_out of this ConnectionStatusSnapshotDTO. + The number of FlowFiles that have left the connection in the last 5 minutes. + + :param flow_files_out: The flow_files_out of this ConnectionStatusSnapshotDTO. + :type: int + """ + + self._flow_files_out = flow_files_out + + @property + def flow_files_queued(self): + """ + Gets the flow_files_queued of this ConnectionStatusSnapshotDTO. + The number of FlowFiles that are currently queued in the connection. + + :return: The flow_files_queued of this ConnectionStatusSnapshotDTO. + :rtype: int + """ + return self._flow_files_queued + + @flow_files_queued.setter + def flow_files_queued(self, flow_files_queued): + """ + Sets the flow_files_queued of this ConnectionStatusSnapshotDTO. + The number of FlowFiles that are currently queued in the connection. + + :param flow_files_queued: The flow_files_queued of this ConnectionStatusSnapshotDTO. + :type: int + """ + + self._flow_files_queued = flow_files_queued + + @property + def group_id(self): + """ + Gets the group_id of this ConnectionStatusSnapshotDTO. + The id of the process group the connection belongs to. + + :return: The group_id of this ConnectionStatusSnapshotDTO. + :rtype: str + """ + return self._group_id - @flow_files_in.setter - def flow_files_in(self, flow_files_in): + @group_id.setter + def group_id(self, group_id): """ - Sets the flow_files_in of this ConnectionStatusSnapshotDTO. - The number of FlowFiles that have come into the connection in the last 5 minutes. + Sets the group_id of this ConnectionStatusSnapshotDTO. + The id of the process group the connection belongs to. - :param flow_files_in: The flow_files_in of this ConnectionStatusSnapshotDTO. - :type: int + :param group_id: The group_id of this ConnectionStatusSnapshotDTO. + :type: str """ - self._flow_files_in = flow_files_in + self._group_id = group_id @property - def bytes_in(self): + def id(self): """ - Gets the bytes_in of this ConnectionStatusSnapshotDTO. - The size of the FlowFiles that have come into the connection in the last 5 minutes. + Gets the id of this ConnectionStatusSnapshotDTO. + The id of the connection. - :return: The bytes_in of this ConnectionStatusSnapshotDTO. - :rtype: int + :return: The id of this ConnectionStatusSnapshotDTO. + :rtype: str """ - return self._bytes_in + return self._id - @bytes_in.setter - def bytes_in(self, bytes_in): + @id.setter + def id(self, id): """ - Sets the bytes_in of this ConnectionStatusSnapshotDTO. - The size of the FlowFiles that have come into the connection in the last 5 minutes. + Sets the id of this ConnectionStatusSnapshotDTO. + The id of the connection. - :param bytes_in: The bytes_in of this ConnectionStatusSnapshotDTO. - :type: int + :param id: The id of this ConnectionStatusSnapshotDTO. + :type: str """ - self._bytes_in = bytes_in + self._id = id @property def input(self): @@ -404,50 +424,27 @@ def input(self, input): self._input = input @property - def flow_files_out(self): - """ - Gets the flow_files_out of this ConnectionStatusSnapshotDTO. - The number of FlowFiles that have left the connection in the last 5 minutes. - - :return: The flow_files_out of this ConnectionStatusSnapshotDTO. - :rtype: int - """ - return self._flow_files_out - - @flow_files_out.setter - def flow_files_out(self, flow_files_out): - """ - Sets the flow_files_out of this ConnectionStatusSnapshotDTO. - The number of FlowFiles that have left the connection in the last 5 minutes. - - :param flow_files_out: The flow_files_out of this ConnectionStatusSnapshotDTO. - :type: int - """ - - self._flow_files_out = flow_files_out - - @property - def bytes_out(self): + def name(self): """ - Gets the bytes_out of this ConnectionStatusSnapshotDTO. - The number of bytes that have left the connection in the last 5 minutes. + Gets the name of this ConnectionStatusSnapshotDTO. + The name of the connection. - :return: The bytes_out of this ConnectionStatusSnapshotDTO. - :rtype: int + :return: The name of this ConnectionStatusSnapshotDTO. + :rtype: str """ - return self._bytes_out + return self._name - @bytes_out.setter - def bytes_out(self, bytes_out): + @name.setter + def name(self, name): """ - Sets the bytes_out of this ConnectionStatusSnapshotDTO. - The number of bytes that have left the connection in the last 5 minutes. + Sets the name of this ConnectionStatusSnapshotDTO. + The name of the connection. - :param bytes_out: The bytes_out of this ConnectionStatusSnapshotDTO. - :type: int + :param name: The name of this ConnectionStatusSnapshotDTO. + :type: str """ - self._bytes_out = bytes_out + self._name = name @property def output(self): @@ -473,50 +470,71 @@ def output(self, output): self._output = output @property - def flow_files_queued(self): + def percent_use_bytes(self): """ - Gets the flow_files_queued of this ConnectionStatusSnapshotDTO. - The number of FlowFiles that are currently queued in the connection. + Gets the percent_use_bytes of this ConnectionStatusSnapshotDTO. + Connection percent use regarding queued flow files size and backpressure threshold if configured. - :return: The flow_files_queued of this ConnectionStatusSnapshotDTO. + :return: The percent_use_bytes of this ConnectionStatusSnapshotDTO. :rtype: int """ - return self._flow_files_queued + return self._percent_use_bytes - @flow_files_queued.setter - def flow_files_queued(self, flow_files_queued): + @percent_use_bytes.setter + def percent_use_bytes(self, percent_use_bytes): """ - Sets the flow_files_queued of this ConnectionStatusSnapshotDTO. - The number of FlowFiles that are currently queued in the connection. + Sets the percent_use_bytes of this ConnectionStatusSnapshotDTO. + Connection percent use regarding queued flow files size and backpressure threshold if configured. - :param flow_files_queued: The flow_files_queued of this ConnectionStatusSnapshotDTO. + :param percent_use_bytes: The percent_use_bytes of this ConnectionStatusSnapshotDTO. :type: int """ - self._flow_files_queued = flow_files_queued + self._percent_use_bytes = percent_use_bytes @property - def bytes_queued(self): + def percent_use_count(self): """ - Gets the bytes_queued of this ConnectionStatusSnapshotDTO. - The size of the FlowFiles that are currently queued in the connection. + Gets the percent_use_count of this ConnectionStatusSnapshotDTO. + Connection percent use regarding queued flow files count and backpressure threshold if configured. - :return: The bytes_queued of this ConnectionStatusSnapshotDTO. + :return: The percent_use_count of this ConnectionStatusSnapshotDTO. :rtype: int """ - return self._bytes_queued + return self._percent_use_count - @bytes_queued.setter - def bytes_queued(self, bytes_queued): + @percent_use_count.setter + def percent_use_count(self, percent_use_count): """ - Sets the bytes_queued of this ConnectionStatusSnapshotDTO. - The size of the FlowFiles that are currently queued in the connection. + Sets the percent_use_count of this ConnectionStatusSnapshotDTO. + Connection percent use regarding queued flow files count and backpressure threshold if configured. - :param bytes_queued: The bytes_queued of this ConnectionStatusSnapshotDTO. + :param percent_use_count: The percent_use_count of this ConnectionStatusSnapshotDTO. :type: int """ - self._bytes_queued = bytes_queued + self._percent_use_count = percent_use_count + + @property + def predictions(self): + """ + Gets the predictions of this ConnectionStatusSnapshotDTO. + + :return: The predictions of this ConnectionStatusSnapshotDTO. + :rtype: ConnectionStatusPredictionsSnapshotDTO + """ + return self._predictions + + @predictions.setter + def predictions(self, predictions): + """ + Sets the predictions of this ConnectionStatusSnapshotDTO. + + :param predictions: The predictions of this ConnectionStatusSnapshotDTO. + :type: ConnectionStatusPredictionsSnapshotDTO + """ + + self._predictions = predictions @property def queued(self): @@ -541,29 +559,6 @@ def queued(self, queued): self._queued = queued - @property - def queued_size(self): - """ - Gets the queued_size of this ConnectionStatusSnapshotDTO. - The total size of flowfiles that are queued formatted. - - :return: The queued_size of this ConnectionStatusSnapshotDTO. - :rtype: str - """ - return self._queued_size - - @queued_size.setter - def queued_size(self, queued_size): - """ - Sets the queued_size of this ConnectionStatusSnapshotDTO. - The total size of flowfiles that are queued formatted. - - :param queued_size: The queued_size of this ConnectionStatusSnapshotDTO. - :type: str - """ - - self._queued_size = queued_size - @property def queued_count(self): """ @@ -588,73 +583,73 @@ def queued_count(self, queued_count): self._queued_count = queued_count @property - def percent_use_count(self): + def queued_size(self): """ - Gets the percent_use_count of this ConnectionStatusSnapshotDTO. - Connection percent use regarding queued flow files count and backpressure threshold if configured. + Gets the queued_size of this ConnectionStatusSnapshotDTO. + The total size of flowfiles that are queued formatted. - :return: The percent_use_count of this ConnectionStatusSnapshotDTO. - :rtype: int + :return: The queued_size of this ConnectionStatusSnapshotDTO. + :rtype: str """ - return self._percent_use_count + return self._queued_size - @percent_use_count.setter - def percent_use_count(self, percent_use_count): + @queued_size.setter + def queued_size(self, queued_size): """ - Sets the percent_use_count of this ConnectionStatusSnapshotDTO. - Connection percent use regarding queued flow files count and backpressure threshold if configured. + Sets the queued_size of this ConnectionStatusSnapshotDTO. + The total size of flowfiles that are queued formatted. - :param percent_use_count: The percent_use_count of this ConnectionStatusSnapshotDTO. - :type: int + :param queued_size: The queued_size of this ConnectionStatusSnapshotDTO. + :type: str """ - self._percent_use_count = percent_use_count + self._queued_size = queued_size @property - def percent_use_bytes(self): + def source_id(self): """ - Gets the percent_use_bytes of this ConnectionStatusSnapshotDTO. - Connection percent use regarding queued flow files size and backpressure threshold if configured. + Gets the source_id of this ConnectionStatusSnapshotDTO. + The id of the source of the connection. - :return: The percent_use_bytes of this ConnectionStatusSnapshotDTO. - :rtype: int + :return: The source_id of this ConnectionStatusSnapshotDTO. + :rtype: str """ - return self._percent_use_bytes + return self._source_id - @percent_use_bytes.setter - def percent_use_bytes(self, percent_use_bytes): + @source_id.setter + def source_id(self, source_id): """ - Sets the percent_use_bytes of this ConnectionStatusSnapshotDTO. - Connection percent use regarding queued flow files size and backpressure threshold if configured. + Sets the source_id of this ConnectionStatusSnapshotDTO. + The id of the source of the connection. - :param percent_use_bytes: The percent_use_bytes of this ConnectionStatusSnapshotDTO. - :type: int + :param source_id: The source_id of this ConnectionStatusSnapshotDTO. + :type: str """ - self._percent_use_bytes = percent_use_bytes + self._source_id = source_id @property - def flow_file_availability(self): + def source_name(self): """ - Gets the flow_file_availability of this ConnectionStatusSnapshotDTO. - The availability of FlowFiles in this connection + Gets the source_name of this ConnectionStatusSnapshotDTO. + The name of the source of the connection. - :return: The flow_file_availability of this ConnectionStatusSnapshotDTO. + :return: The source_name of this ConnectionStatusSnapshotDTO. :rtype: str """ - return self._flow_file_availability + return self._source_name - @flow_file_availability.setter - def flow_file_availability(self, flow_file_availability): + @source_name.setter + def source_name(self, source_name): """ - Sets the flow_file_availability of this ConnectionStatusSnapshotDTO. - The availability of FlowFiles in this connection + Sets the source_name of this ConnectionStatusSnapshotDTO. + The name of the source of the connection. - :param flow_file_availability: The flow_file_availability of this ConnectionStatusSnapshotDTO. + :param source_name: The source_name of this ConnectionStatusSnapshotDTO. :type: str """ - self._flow_file_availability = flow_file_availability + self._source_name = source_name def to_dict(self): """ diff --git a/nipyapi/nifi/models/connection_status_snapshot_entity.py b/nipyapi/nifi/models/connection_status_snapshot_entity.py index 4e85deeb..40b45f53 100644 --- a/nipyapi/nifi/models/connection_status_snapshot_entity.py +++ b/nipyapi/nifi/models/connection_status_snapshot_entity.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,55 +27,53 @@ class ConnectionStatusSnapshotEntity(object): and the value is json key in definition. """ swagger_types = { - 'id': 'str', - 'connection_status_snapshot': 'ConnectionStatusSnapshotDTO', - 'can_read': 'bool' - } + 'can_read': 'bool', +'connection_status_snapshot': 'ConnectionStatusSnapshotDTO', +'id': 'str' } attribute_map = { - 'id': 'id', - 'connection_status_snapshot': 'connectionStatusSnapshot', - 'can_read': 'canRead' - } + 'can_read': 'canRead', +'connection_status_snapshot': 'connectionStatusSnapshot', +'id': 'id' } - def __init__(self, id=None, connection_status_snapshot=None, can_read=None): + def __init__(self, can_read=None, connection_status_snapshot=None, id=None): """ ConnectionStatusSnapshotEntity - a model defined in Swagger """ - self._id = None - self._connection_status_snapshot = None self._can_read = None + self._connection_status_snapshot = None + self._id = None - if id is not None: - self.id = id - if connection_status_snapshot is not None: - self.connection_status_snapshot = connection_status_snapshot if can_read is not None: self.can_read = can_read + if connection_status_snapshot is not None: + self.connection_status_snapshot = connection_status_snapshot + if id is not None: + self.id = id @property - def id(self): + def can_read(self): """ - Gets the id of this ConnectionStatusSnapshotEntity. - The id of the connection. + Gets the can_read of this ConnectionStatusSnapshotEntity. + Indicates whether the user can read a given resource. - :return: The id of this ConnectionStatusSnapshotEntity. - :rtype: str + :return: The can_read of this ConnectionStatusSnapshotEntity. + :rtype: bool """ - return self._id + return self._can_read - @id.setter - def id(self, id): + @can_read.setter + def can_read(self, can_read): """ - Sets the id of this ConnectionStatusSnapshotEntity. - The id of the connection. + Sets the can_read of this ConnectionStatusSnapshotEntity. + Indicates whether the user can read a given resource. - :param id: The id of this ConnectionStatusSnapshotEntity. - :type: str + :param can_read: The can_read of this ConnectionStatusSnapshotEntity. + :type: bool """ - self._id = id + self._can_read = can_read @property def connection_status_snapshot(self): @@ -100,27 +97,27 @@ def connection_status_snapshot(self, connection_status_snapshot): self._connection_status_snapshot = connection_status_snapshot @property - def can_read(self): + def id(self): """ - Gets the can_read of this ConnectionStatusSnapshotEntity. - Indicates whether the user can read a given resource. + Gets the id of this ConnectionStatusSnapshotEntity. + The id of the connection. - :return: The can_read of this ConnectionStatusSnapshotEntity. - :rtype: bool + :return: The id of this ConnectionStatusSnapshotEntity. + :rtype: str """ - return self._can_read + return self._id - @can_read.setter - def can_read(self, can_read): + @id.setter + def id(self, id): """ - Sets the can_read of this ConnectionStatusSnapshotEntity. - Indicates whether the user can read a given resource. + Sets the id of this ConnectionStatusSnapshotEntity. + The id of the connection. - :param can_read: The can_read of this ConnectionStatusSnapshotEntity. - :type: bool + :param id: The id of this ConnectionStatusSnapshotEntity. + :type: str """ - self._can_read = can_read + self._id = id def to_dict(self): """ diff --git a/nipyapi/nifi/models/connections_entity.py b/nipyapi/nifi/models/connections_entity.py index 25075581..148709f0 100644 --- a/nipyapi/nifi/models/connections_entity.py +++ b/nipyapi/nifi/models/connections_entity.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,12 +27,10 @@ class ConnectionsEntity(object): and the value is json key in definition. """ swagger_types = { - 'connections': 'list[ConnectionEntity]' - } + 'connections': 'list[ConnectionEntity]' } attribute_map = { - 'connections': 'connections' - } + 'connections': 'connections' } def __init__(self, connections=None): """ diff --git a/nipyapi/nifi/models/content_viewer_dto.py b/nipyapi/nifi/models/content_viewer_dto.py new file mode 100644 index 00000000..9dea6f11 --- /dev/null +++ b/nipyapi/nifi/models/content_viewer_dto.py @@ -0,0 +1,175 @@ +""" + Apache NiFi REST API + + REST API definition for Apache NiFi web services + + OpenAPI spec version: 2.5.0 + Contact: dev@nifi.apache.org + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from pprint import pformat +import re + + +class ContentViewerDTO(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 = { + 'display_name': 'str', +'supported_mime_types': 'list[SupportedMimeTypesDTO]', +'uri': 'str' } + + attribute_map = { + 'display_name': 'displayName', +'supported_mime_types': 'supportedMimeTypes', +'uri': 'uri' } + + def __init__(self, display_name=None, supported_mime_types=None, uri=None): + """ + ContentViewerDTO - a model defined in Swagger + """ + + self._display_name = None + self._supported_mime_types = None + self._uri = None + + if display_name is not None: + self.display_name = display_name + if supported_mime_types is not None: + self.supported_mime_types = supported_mime_types + if uri is not None: + self.uri = uri + + @property + def display_name(self): + """ + Gets the display_name of this ContentViewerDTO. + The display name of the Content Viewer. + + :return: The display_name of this ContentViewerDTO. + :rtype: str + """ + return self._display_name + + @display_name.setter + def display_name(self, display_name): + """ + Sets the display_name of this ContentViewerDTO. + The display name of the Content Viewer. + + :param display_name: The display_name of this ContentViewerDTO. + :type: str + """ + + self._display_name = display_name + + @property + def supported_mime_types(self): + """ + Gets the supported_mime_types of this ContentViewerDTO. + The mime types this Content Viewer supports. + + :return: The supported_mime_types of this ContentViewerDTO. + :rtype: list[SupportedMimeTypesDTO] + """ + return self._supported_mime_types + + @supported_mime_types.setter + def supported_mime_types(self, supported_mime_types): + """ + Sets the supported_mime_types of this ContentViewerDTO. + The mime types this Content Viewer supports. + + :param supported_mime_types: The supported_mime_types of this ContentViewerDTO. + :type: list[SupportedMimeTypesDTO] + """ + + self._supported_mime_types = supported_mime_types + + @property + def uri(self): + """ + Gets the uri of this ContentViewerDTO. + The uri of the Content Viewer. + + :return: The uri of this ContentViewerDTO. + :rtype: str + """ + return self._uri + + @uri.setter + def uri(self, uri): + """ + Sets the uri of this ContentViewerDTO. + The uri of the Content Viewer. + + :param uri: The uri of this ContentViewerDTO. + :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, ContentViewerDTO): + 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/content_viewer_entity.py b/nipyapi/nifi/models/content_viewer_entity.py new file mode 100644 index 00000000..8502481d --- /dev/null +++ b/nipyapi/nifi/models/content_viewer_entity.py @@ -0,0 +1,119 @@ +""" + Apache NiFi REST API + + REST API definition for Apache NiFi web services + + OpenAPI spec version: 2.5.0 + Contact: dev@nifi.apache.org + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from pprint import pformat +import re + + +class ContentViewerEntity(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 = { + 'content_viewers': 'list[ContentViewerDTO]' } + + attribute_map = { + 'content_viewers': 'contentViewers' } + + def __init__(self, content_viewers=None): + """ + ContentViewerEntity - a model defined in Swagger + """ + + self._content_viewers = None + + if content_viewers is not None: + self.content_viewers = content_viewers + + @property + def content_viewers(self): + """ + Gets the content_viewers of this ContentViewerEntity. + The Content Viewers. + + :return: The content_viewers of this ContentViewerEntity. + :rtype: list[ContentViewerDTO] + """ + return self._content_viewers + + @content_viewers.setter + def content_viewers(self, content_viewers): + """ + Sets the content_viewers of this ContentViewerEntity. + The Content Viewers. + + :param content_viewers: The content_viewers of this ContentViewerEntity. + :type: list[ContentViewerDTO] + """ + + self._content_viewers = content_viewers + + 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, ContentViewerEntity): + 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/controller_bulletins_entity.py b/nipyapi/nifi/models/controller_bulletins_entity.py index d727f6c2..26e94578 100644 --- a/nipyapi/nifi/models/controller_bulletins_entity.py +++ b/nipyapi/nifi/models/controller_bulletins_entity.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -29,41 +28,44 @@ class ControllerBulletinsEntity(object): """ swagger_types = { 'bulletins': 'list[BulletinEntity]', - 'controller_service_bulletins': 'list[BulletinEntity]', - 'reporting_task_bulletins': 'list[BulletinEntity]', - 'parameter_provider_bulletins': 'list[BulletinEntity]', - 'flow_registry_client_bulletins': 'list[BulletinEntity]' - } +'controller_service_bulletins': 'list[BulletinEntity]', +'flow_analysis_rule_bulletins': 'list[BulletinEntity]', +'flow_registry_client_bulletins': 'list[BulletinEntity]', +'parameter_provider_bulletins': 'list[BulletinEntity]', +'reporting_task_bulletins': 'list[BulletinEntity]' } attribute_map = { 'bulletins': 'bulletins', - 'controller_service_bulletins': 'controllerServiceBulletins', - 'reporting_task_bulletins': 'reportingTaskBulletins', - 'parameter_provider_bulletins': 'parameterProviderBulletins', - 'flow_registry_client_bulletins': 'flowRegistryClientBulletins' - } +'controller_service_bulletins': 'controllerServiceBulletins', +'flow_analysis_rule_bulletins': 'flowAnalysisRuleBulletins', +'flow_registry_client_bulletins': 'flowRegistryClientBulletins', +'parameter_provider_bulletins': 'parameterProviderBulletins', +'reporting_task_bulletins': 'reportingTaskBulletins' } - def __init__(self, bulletins=None, controller_service_bulletins=None, reporting_task_bulletins=None, parameter_provider_bulletins=None, flow_registry_client_bulletins=None): + def __init__(self, bulletins=None, controller_service_bulletins=None, flow_analysis_rule_bulletins=None, flow_registry_client_bulletins=None, parameter_provider_bulletins=None, reporting_task_bulletins=None): """ ControllerBulletinsEntity - a model defined in Swagger """ self._bulletins = None self._controller_service_bulletins = None - self._reporting_task_bulletins = None - self._parameter_provider_bulletins = None + self._flow_analysis_rule_bulletins = None self._flow_registry_client_bulletins = None + self._parameter_provider_bulletins = None + self._reporting_task_bulletins = None if bulletins is not None: self.bulletins = bulletins if controller_service_bulletins is not None: self.controller_service_bulletins = controller_service_bulletins - if reporting_task_bulletins is not None: - self.reporting_task_bulletins = reporting_task_bulletins - if parameter_provider_bulletins is not None: - self.parameter_provider_bulletins = parameter_provider_bulletins + if flow_analysis_rule_bulletins is not None: + self.flow_analysis_rule_bulletins = flow_analysis_rule_bulletins if flow_registry_client_bulletins is not None: self.flow_registry_client_bulletins = flow_registry_client_bulletins + if parameter_provider_bulletins is not None: + self.parameter_provider_bulletins = parameter_provider_bulletins + if reporting_task_bulletins is not None: + self.reporting_task_bulletins = reporting_task_bulletins @property def bulletins(self): @@ -112,27 +114,50 @@ def controller_service_bulletins(self, controller_service_bulletins): self._controller_service_bulletins = controller_service_bulletins @property - def reporting_task_bulletins(self): + def flow_analysis_rule_bulletins(self): """ - Gets the reporting_task_bulletins of this ControllerBulletinsEntity. - Reporting task bulletins to be reported to the user. + Gets the flow_analysis_rule_bulletins of this ControllerBulletinsEntity. + Flow Analysis Rule bulletins to be reported to the user. - :return: The reporting_task_bulletins of this ControllerBulletinsEntity. + :return: The flow_analysis_rule_bulletins of this ControllerBulletinsEntity. :rtype: list[BulletinEntity] """ - return self._reporting_task_bulletins + return self._flow_analysis_rule_bulletins - @reporting_task_bulletins.setter - def reporting_task_bulletins(self, reporting_task_bulletins): + @flow_analysis_rule_bulletins.setter + def flow_analysis_rule_bulletins(self, flow_analysis_rule_bulletins): """ - Sets the reporting_task_bulletins of this ControllerBulletinsEntity. - Reporting task bulletins to be reported to the user. + Sets the flow_analysis_rule_bulletins of this ControllerBulletinsEntity. + Flow Analysis Rule bulletins to be reported to the user. - :param reporting_task_bulletins: The reporting_task_bulletins of this ControllerBulletinsEntity. + :param flow_analysis_rule_bulletins: The flow_analysis_rule_bulletins of this ControllerBulletinsEntity. :type: list[BulletinEntity] """ - self._reporting_task_bulletins = reporting_task_bulletins + self._flow_analysis_rule_bulletins = flow_analysis_rule_bulletins + + @property + def flow_registry_client_bulletins(self): + """ + Gets the flow_registry_client_bulletins of this ControllerBulletinsEntity. + Flow registry client bulletins to be reported to the user. + + :return: The flow_registry_client_bulletins of this ControllerBulletinsEntity. + :rtype: list[BulletinEntity] + """ + return self._flow_registry_client_bulletins + + @flow_registry_client_bulletins.setter + def flow_registry_client_bulletins(self, flow_registry_client_bulletins): + """ + Sets the flow_registry_client_bulletins of this ControllerBulletinsEntity. + Flow registry client bulletins to be reported to the user. + + :param flow_registry_client_bulletins: The flow_registry_client_bulletins of this ControllerBulletinsEntity. + :type: list[BulletinEntity] + """ + + self._flow_registry_client_bulletins = flow_registry_client_bulletins @property def parameter_provider_bulletins(self): @@ -158,27 +183,27 @@ def parameter_provider_bulletins(self, parameter_provider_bulletins): self._parameter_provider_bulletins = parameter_provider_bulletins @property - def flow_registry_client_bulletins(self): + def reporting_task_bulletins(self): """ - Gets the flow_registry_client_bulletins of this ControllerBulletinsEntity. - Flow registry client bulletins to be reported to the user. + Gets the reporting_task_bulletins of this ControllerBulletinsEntity. + Reporting task bulletins to be reported to the user. - :return: The flow_registry_client_bulletins of this ControllerBulletinsEntity. + :return: The reporting_task_bulletins of this ControllerBulletinsEntity. :rtype: list[BulletinEntity] """ - return self._flow_registry_client_bulletins + return self._reporting_task_bulletins - @flow_registry_client_bulletins.setter - def flow_registry_client_bulletins(self, flow_registry_client_bulletins): + @reporting_task_bulletins.setter + def reporting_task_bulletins(self, reporting_task_bulletins): """ - Sets the flow_registry_client_bulletins of this ControllerBulletinsEntity. - Flow registry client bulletins to be reported to the user. + Sets the reporting_task_bulletins of this ControllerBulletinsEntity. + Reporting task bulletins to be reported to the user. - :param flow_registry_client_bulletins: The flow_registry_client_bulletins of this ControllerBulletinsEntity. + :param reporting_task_bulletins: The reporting_task_bulletins of this ControllerBulletinsEntity. :type: list[BulletinEntity] """ - self._flow_registry_client_bulletins = flow_registry_client_bulletins + self._reporting_task_bulletins = reporting_task_bulletins def to_dict(self): """ diff --git a/nipyapi/nifi/models/controller_configuration_dto.py b/nipyapi/nifi/models/controller_configuration_dto.py index 0caf4442..dba782a6 100644 --- a/nipyapi/nifi/models/controller_configuration_dto.py +++ b/nipyapi/nifi/models/controller_configuration_dto.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,27 +27,20 @@ class ControllerConfigurationDTO(object): and the value is json key in definition. """ swagger_types = { - 'max_timer_driven_thread_count': 'int', - 'max_event_driven_thread_count': 'int' - } + 'max_timer_driven_thread_count': 'int' } attribute_map = { - 'max_timer_driven_thread_count': 'maxTimerDrivenThreadCount', - 'max_event_driven_thread_count': 'maxEventDrivenThreadCount' - } + 'max_timer_driven_thread_count': 'maxTimerDrivenThreadCount' } - def __init__(self, max_timer_driven_thread_count=None, max_event_driven_thread_count=None): + def __init__(self, max_timer_driven_thread_count=None): """ ControllerConfigurationDTO - a model defined in Swagger """ self._max_timer_driven_thread_count = None - self._max_event_driven_thread_count = None if max_timer_driven_thread_count is not None: self.max_timer_driven_thread_count = max_timer_driven_thread_count - if max_event_driven_thread_count is not None: - self.max_event_driven_thread_count = max_event_driven_thread_count @property def max_timer_driven_thread_count(self): @@ -73,29 +65,6 @@ def max_timer_driven_thread_count(self, max_timer_driven_thread_count): self._max_timer_driven_thread_count = max_timer_driven_thread_count - @property - def max_event_driven_thread_count(self): - """ - Gets the max_event_driven_thread_count of this ControllerConfigurationDTO. - The maximum number of event driven threads the NiFi has available. - - :return: The max_event_driven_thread_count of this ControllerConfigurationDTO. - :rtype: int - """ - return self._max_event_driven_thread_count - - @max_event_driven_thread_count.setter - def max_event_driven_thread_count(self, max_event_driven_thread_count): - """ - Sets the max_event_driven_thread_count of this ControllerConfigurationDTO. - The maximum number of event driven threads the NiFi has available. - - :param max_event_driven_thread_count: The max_event_driven_thread_count of this ControllerConfigurationDTO. - :type: int - """ - - self._max_event_driven_thread_count = max_event_driven_thread_count - def to_dict(self): """ Returns the model properties as a dict diff --git a/nipyapi/nifi/models/controller_configuration_entity.py b/nipyapi/nifi/models/controller_configuration_entity.py index 7226d9ef..8ddca5f3 100644 --- a/nipyapi/nifi/models/controller_configuration_entity.py +++ b/nipyapi/nifi/models/controller_configuration_entity.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,83 +27,56 @@ class ControllerConfigurationEntity(object): and the value is json key in definition. """ swagger_types = { - 'revision': 'RevisionDTO', - 'permissions': 'PermissionsDTO', - 'disconnected_node_acknowledged': 'bool', - 'component': 'ControllerConfigurationDTO' - } + 'component': 'ControllerConfigurationDTO', +'disconnected_node_acknowledged': 'bool', +'permissions': 'PermissionsDTO', +'revision': 'RevisionDTO' } attribute_map = { - 'revision': 'revision', - 'permissions': 'permissions', - 'disconnected_node_acknowledged': 'disconnectedNodeAcknowledged', - 'component': 'component' - } + 'component': 'component', +'disconnected_node_acknowledged': 'disconnectedNodeAcknowledged', +'permissions': 'permissions', +'revision': 'revision' } - def __init__(self, revision=None, permissions=None, disconnected_node_acknowledged=None, component=None): + def __init__(self, component=None, disconnected_node_acknowledged=None, permissions=None, revision=None): """ ControllerConfigurationEntity - a model defined in Swagger """ - self._revision = None - self._permissions = None - self._disconnected_node_acknowledged = None self._component = None + self._disconnected_node_acknowledged = None + self._permissions = None + self._revision = None - if revision is not None: - self.revision = revision - if permissions is not None: - self.permissions = permissions - if disconnected_node_acknowledged is not None: - self.disconnected_node_acknowledged = disconnected_node_acknowledged if component is not None: self.component = component + if disconnected_node_acknowledged is not None: + self.disconnected_node_acknowledged = disconnected_node_acknowledged + if permissions is not None: + self.permissions = permissions + if revision is not None: + self.revision = revision @property - def revision(self): - """ - Gets the revision of this ControllerConfigurationEntity. - The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses. - - :return: The revision of this ControllerConfigurationEntity. - :rtype: RevisionDTO - """ - return self._revision - - @revision.setter - def revision(self, revision): - """ - Sets the revision of this ControllerConfigurationEntity. - The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses. - - :param revision: The revision of this ControllerConfigurationEntity. - :type: RevisionDTO - """ - - self._revision = revision - - @property - def permissions(self): + def component(self): """ - Gets the permissions of this ControllerConfigurationEntity. - The permissions for this component. + Gets the component of this ControllerConfigurationEntity. - :return: The permissions of this ControllerConfigurationEntity. - :rtype: PermissionsDTO + :return: The component of this ControllerConfigurationEntity. + :rtype: ControllerConfigurationDTO """ - return self._permissions + return self._component - @permissions.setter - def permissions(self, permissions): + @component.setter + def component(self, component): """ - Sets the permissions of this ControllerConfigurationEntity. - The permissions for this component. + Sets the component of this ControllerConfigurationEntity. - :param permissions: The permissions of this ControllerConfigurationEntity. - :type: PermissionsDTO + :param component: The component of this ControllerConfigurationEntity. + :type: ControllerConfigurationDTO """ - self._permissions = permissions + self._component = component @property def disconnected_node_acknowledged(self): @@ -130,27 +102,46 @@ def disconnected_node_acknowledged(self, disconnected_node_acknowledged): self._disconnected_node_acknowledged = disconnected_node_acknowledged @property - def component(self): + def permissions(self): """ - Gets the component of this ControllerConfigurationEntity. - The controller configuration. + Gets the permissions of this ControllerConfigurationEntity. - :return: The component of this ControllerConfigurationEntity. - :rtype: ControllerConfigurationDTO + :return: The permissions of this ControllerConfigurationEntity. + :rtype: PermissionsDTO """ - return self._component + return self._permissions - @component.setter - def component(self, component): + @permissions.setter + def permissions(self, permissions): """ - Sets the component of this ControllerConfigurationEntity. - The controller configuration. + Sets the permissions of this ControllerConfigurationEntity. - :param component: The component of this ControllerConfigurationEntity. - :type: ControllerConfigurationDTO + :param permissions: The permissions of this ControllerConfigurationEntity. + :type: PermissionsDTO """ - self._component = component + self._permissions = permissions + + @property + def revision(self): + """ + Gets the revision of this ControllerConfigurationEntity. + + :return: The revision of this ControllerConfigurationEntity. + :rtype: RevisionDTO + """ + return self._revision + + @revision.setter + def revision(self, revision): + """ + Sets the revision of this ControllerConfigurationEntity. + + :param revision: The revision of this ControllerConfigurationEntity. + :type: RevisionDTO + """ + + self._revision = revision def to_dict(self): """ diff --git a/nipyapi/nifi/models/controller_dto.py b/nipyapi/nifi/models/controller_dto.py index 0c2d4371..dbb27caf 100644 --- a/nipyapi/nifi/models/controller_dto.py +++ b/nipyapi/nifi/models/controller_dto.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,148 +27,123 @@ class ControllerDTO(object): and the value is json key in definition. """ swagger_types = { - 'id': 'str', - 'name': 'str', - 'comments': 'str', - 'running_count': 'int', - 'stopped_count': 'int', - 'invalid_count': 'int', - 'disabled_count': 'int', 'active_remote_port_count': 'int', - 'inactive_remote_port_count': 'int', - 'input_port_count': 'int', - 'output_port_count': 'int', - 'remote_site_listening_port': 'int', - 'remote_site_http_listening_port': 'int', - 'site_to_site_secure': 'bool', - 'instance_id': 'str', - 'input_ports': 'list[PortDTO]', - 'output_ports': 'list[PortDTO]' - } +'comments': 'str', +'disabled_count': 'int', +'id': 'str', +'inactive_remote_port_count': 'int', +'input_port_count': 'int', +'input_ports': 'list[PortDTO]', +'instance_id': 'str', +'invalid_count': 'int', +'name': 'str', +'output_port_count': 'int', +'output_ports': 'list[PortDTO]', +'remote_site_http_listening_port': 'int', +'remote_site_listening_port': 'int', +'running_count': 'int', +'site_to_site_secure': 'bool', +'stopped_count': 'int' } attribute_map = { - 'id': 'id', - 'name': 'name', - 'comments': 'comments', - 'running_count': 'runningCount', - 'stopped_count': 'stoppedCount', - 'invalid_count': 'invalidCount', - 'disabled_count': 'disabledCount', 'active_remote_port_count': 'activeRemotePortCount', - 'inactive_remote_port_count': 'inactiveRemotePortCount', - 'input_port_count': 'inputPortCount', - 'output_port_count': 'outputPortCount', - 'remote_site_listening_port': 'remoteSiteListeningPort', - 'remote_site_http_listening_port': 'remoteSiteHttpListeningPort', - 'site_to_site_secure': 'siteToSiteSecure', - 'instance_id': 'instanceId', - 'input_ports': 'inputPorts', - 'output_ports': 'outputPorts' - } - - def __init__(self, id=None, name=None, comments=None, running_count=None, stopped_count=None, invalid_count=None, disabled_count=None, active_remote_port_count=None, inactive_remote_port_count=None, input_port_count=None, output_port_count=None, remote_site_listening_port=None, remote_site_http_listening_port=None, site_to_site_secure=None, instance_id=None, input_ports=None, output_ports=None): +'comments': 'comments', +'disabled_count': 'disabledCount', +'id': 'id', +'inactive_remote_port_count': 'inactiveRemotePortCount', +'input_port_count': 'inputPortCount', +'input_ports': 'inputPorts', +'instance_id': 'instanceId', +'invalid_count': 'invalidCount', +'name': 'name', +'output_port_count': 'outputPortCount', +'output_ports': 'outputPorts', +'remote_site_http_listening_port': 'remoteSiteHttpListeningPort', +'remote_site_listening_port': 'remoteSiteListeningPort', +'running_count': 'runningCount', +'site_to_site_secure': 'siteToSiteSecure', +'stopped_count': 'stoppedCount' } + + def __init__(self, active_remote_port_count=None, comments=None, disabled_count=None, id=None, inactive_remote_port_count=None, input_port_count=None, input_ports=None, instance_id=None, invalid_count=None, name=None, output_port_count=None, output_ports=None, remote_site_http_listening_port=None, remote_site_listening_port=None, running_count=None, site_to_site_secure=None, stopped_count=None): """ ControllerDTO - a model defined in Swagger """ - self._id = None - self._name = None + self._active_remote_port_count = None self._comments = None - self._running_count = None - self._stopped_count = None - self._invalid_count = None self._disabled_count = None - self._active_remote_port_count = None + self._id = None self._inactive_remote_port_count = None self._input_port_count = None + self._input_ports = None + self._instance_id = None + self._invalid_count = None + self._name = None self._output_port_count = None - self._remote_site_listening_port = None + self._output_ports = None self._remote_site_http_listening_port = None + self._remote_site_listening_port = None + self._running_count = None self._site_to_site_secure = None - self._instance_id = None - self._input_ports = None - self._output_ports = None + self._stopped_count = None - if id is not None: - self.id = id - if name is not None: - self.name = name + if active_remote_port_count is not None: + self.active_remote_port_count = active_remote_port_count if comments is not None: self.comments = comments - if running_count is not None: - self.running_count = running_count - if stopped_count is not None: - self.stopped_count = stopped_count - if invalid_count is not None: - self.invalid_count = invalid_count if disabled_count is not None: self.disabled_count = disabled_count - if active_remote_port_count is not None: - self.active_remote_port_count = active_remote_port_count + if id is not None: + self.id = id if inactive_remote_port_count is not None: self.inactive_remote_port_count = inactive_remote_port_count if input_port_count is not None: self.input_port_count = input_port_count + if input_ports is not None: + self.input_ports = input_ports + if instance_id is not None: + self.instance_id = instance_id + if invalid_count is not None: + self.invalid_count = invalid_count + if name is not None: + self.name = name if output_port_count is not None: self.output_port_count = output_port_count - if remote_site_listening_port is not None: - self.remote_site_listening_port = remote_site_listening_port + if output_ports is not None: + self.output_ports = output_ports if remote_site_http_listening_port is not None: self.remote_site_http_listening_port = remote_site_http_listening_port + if remote_site_listening_port is not None: + self.remote_site_listening_port = remote_site_listening_port + if running_count is not None: + self.running_count = running_count if site_to_site_secure is not None: self.site_to_site_secure = site_to_site_secure - if instance_id is not None: - self.instance_id = instance_id - if input_ports is not None: - self.input_ports = input_ports - if output_ports is not None: - self.output_ports = output_ports - - @property - def id(self): - """ - Gets the id of this ControllerDTO. - The id of the NiFi. - - :return: The id of this ControllerDTO. - :rtype: str - """ - return self._id - - @id.setter - def id(self, id): - """ - Sets the id of this ControllerDTO. - The id of the NiFi. - - :param id: The id of this ControllerDTO. - :type: str - """ - - self._id = id + if stopped_count is not None: + self.stopped_count = stopped_count @property - def name(self): + def active_remote_port_count(self): """ - Gets the name of this ControllerDTO. - The name of the NiFi. + Gets the active_remote_port_count of this ControllerDTO. + The number of active remote ports contained in the NiFi. - :return: The name of this ControllerDTO. - :rtype: str + :return: The active_remote_port_count of this ControllerDTO. + :rtype: int """ - return self._name + return self._active_remote_port_count - @name.setter - def name(self, name): + @active_remote_port_count.setter + def active_remote_port_count(self, active_remote_port_count): """ - Sets the name of this ControllerDTO. - The name of the NiFi. + Sets the active_remote_port_count of this ControllerDTO. + The number of active remote ports contained in the NiFi. - :param name: The name of this ControllerDTO. - :type: str + :param active_remote_port_count: The active_remote_port_count of this ControllerDTO. + :type: int """ - self._name = name + self._active_remote_port_count = active_remote_port_count @property def comments(self): @@ -194,75 +168,6 @@ def comments(self, comments): self._comments = comments - @property - def running_count(self): - """ - Gets the running_count of this ControllerDTO. - The number of running components in the NiFi. - - :return: The running_count of this ControllerDTO. - :rtype: int - """ - return self._running_count - - @running_count.setter - def running_count(self, running_count): - """ - Sets the running_count of this ControllerDTO. - The number of running components in the NiFi. - - :param running_count: The running_count of this ControllerDTO. - :type: int - """ - - self._running_count = running_count - - @property - def stopped_count(self): - """ - Gets the stopped_count of this ControllerDTO. - The number of stopped components in the NiFi. - - :return: The stopped_count of this ControllerDTO. - :rtype: int - """ - return self._stopped_count - - @stopped_count.setter - def stopped_count(self, stopped_count): - """ - Sets the stopped_count of this ControllerDTO. - The number of stopped components in the NiFi. - - :param stopped_count: The stopped_count of this ControllerDTO. - :type: int - """ - - self._stopped_count = stopped_count - - @property - def invalid_count(self): - """ - Gets the invalid_count of this ControllerDTO. - The number of invalid components in the NiFi. - - :return: The invalid_count of this ControllerDTO. - :rtype: int - """ - return self._invalid_count - - @invalid_count.setter - def invalid_count(self, invalid_count): - """ - Sets the invalid_count of this ControllerDTO. - The number of invalid components in the NiFi. - - :param invalid_count: The invalid_count of this ControllerDTO. - :type: int - """ - - self._invalid_count = invalid_count - @property def disabled_count(self): """ @@ -287,27 +192,27 @@ def disabled_count(self, disabled_count): self._disabled_count = disabled_count @property - def active_remote_port_count(self): + def id(self): """ - Gets the active_remote_port_count of this ControllerDTO. - The number of active remote ports contained in the NiFi. + Gets the id of this ControllerDTO. + The id of the NiFi. - :return: The active_remote_port_count of this ControllerDTO. - :rtype: int + :return: The id of this ControllerDTO. + :rtype: str """ - return self._active_remote_port_count + return self._id - @active_remote_port_count.setter - def active_remote_port_count(self, active_remote_port_count): + @id.setter + def id(self, id): """ - Sets the active_remote_port_count of this ControllerDTO. - The number of active remote ports contained in the NiFi. + Sets the id of this ControllerDTO. + The id of the NiFi. - :param active_remote_port_count: The active_remote_port_count of this ControllerDTO. - :type: int + :param id: The id of this ControllerDTO. + :type: str """ - self._active_remote_port_count = active_remote_port_count + self._id = id @property def inactive_remote_port_count(self): @@ -355,6 +260,98 @@ def input_port_count(self, input_port_count): self._input_port_count = input_port_count + @property + def input_ports(self): + """ + Gets the input_ports of this ControllerDTO. + The input ports available to send data to for the NiFi. + + :return: The input_ports of this ControllerDTO. + :rtype: list[PortDTO] + """ + return self._input_ports + + @input_ports.setter + def input_ports(self, input_ports): + """ + Sets the input_ports of this ControllerDTO. + The input ports available to send data to for the NiFi. + + :param input_ports: The input_ports of this ControllerDTO. + :type: list[PortDTO] + """ + + self._input_ports = input_ports + + @property + def instance_id(self): + """ + Gets the instance_id of this ControllerDTO. + If clustered, the id of the Cluster Manager, otherwise the id of the NiFi. + + :return: The instance_id of this ControllerDTO. + :rtype: str + """ + return self._instance_id + + @instance_id.setter + def instance_id(self, instance_id): + """ + Sets the instance_id of this ControllerDTO. + If clustered, the id of the Cluster Manager, otherwise the id of the NiFi. + + :param instance_id: The instance_id of this ControllerDTO. + :type: str + """ + + self._instance_id = instance_id + + @property + def invalid_count(self): + """ + Gets the invalid_count of this ControllerDTO. + The number of invalid components in the NiFi. + + :return: The invalid_count of this ControllerDTO. + :rtype: int + """ + return self._invalid_count + + @invalid_count.setter + def invalid_count(self, invalid_count): + """ + Sets the invalid_count of this ControllerDTO. + The number of invalid components in the NiFi. + + :param invalid_count: The invalid_count of this ControllerDTO. + :type: int + """ + + self._invalid_count = invalid_count + + @property + def name(self): + """ + Gets the name of this ControllerDTO. + The name of the NiFi. + + :return: The name of this ControllerDTO. + :rtype: str + """ + return self._name + + @name.setter + def name(self, name): + """ + Sets the name of this ControllerDTO. + The name of the NiFi. + + :param name: The name of this ControllerDTO. + :type: str + """ + + self._name = name + @property def output_port_count(self): """ @@ -379,27 +376,27 @@ def output_port_count(self, output_port_count): self._output_port_count = output_port_count @property - def remote_site_listening_port(self): + def output_ports(self): """ - Gets the remote_site_listening_port of this ControllerDTO. - The Socket Port on which this instance is listening for Remote Transfers of Flow Files. If this instance is not configured to receive Flow Files from remote instances, this will be null. + Gets the output_ports of this ControllerDTO. + The output ports available to received data from the NiFi. - :return: The remote_site_listening_port of this ControllerDTO. - :rtype: int + :return: The output_ports of this ControllerDTO. + :rtype: list[PortDTO] """ - return self._remote_site_listening_port + return self._output_ports - @remote_site_listening_port.setter - def remote_site_listening_port(self, remote_site_listening_port): + @output_ports.setter + def output_ports(self, output_ports): """ - Sets the remote_site_listening_port of this ControllerDTO. - The Socket Port on which this instance is listening for Remote Transfers of Flow Files. If this instance is not configured to receive Flow Files from remote instances, this will be null. + Sets the output_ports of this ControllerDTO. + The output ports available to received data from the NiFi. - :param remote_site_listening_port: The remote_site_listening_port of this ControllerDTO. - :type: int + :param output_ports: The output_ports of this ControllerDTO. + :type: list[PortDTO] """ - self._remote_site_listening_port = remote_site_listening_port + self._output_ports = output_ports @property def remote_site_http_listening_port(self): @@ -425,96 +422,96 @@ def remote_site_http_listening_port(self, remote_site_http_listening_port): self._remote_site_http_listening_port = remote_site_http_listening_port @property - def site_to_site_secure(self): + def remote_site_listening_port(self): """ - Gets the site_to_site_secure of this ControllerDTO. - Indicates whether or not Site-to-Site communications with this instance is secure (2-way authentication). + Gets the remote_site_listening_port of this ControllerDTO. + The Socket Port on which this instance is listening for Remote Transfers of Flow Files. If this instance is not configured to receive Flow Files from remote instances, this will be null. - :return: The site_to_site_secure of this ControllerDTO. - :rtype: bool + :return: The remote_site_listening_port of this ControllerDTO. + :rtype: int """ - return self._site_to_site_secure + return self._remote_site_listening_port - @site_to_site_secure.setter - def site_to_site_secure(self, site_to_site_secure): + @remote_site_listening_port.setter + def remote_site_listening_port(self, remote_site_listening_port): """ - Sets the site_to_site_secure of this ControllerDTO. - Indicates whether or not Site-to-Site communications with this instance is secure (2-way authentication). + Sets the remote_site_listening_port of this ControllerDTO. + The Socket Port on which this instance is listening for Remote Transfers of Flow Files. If this instance is not configured to receive Flow Files from remote instances, this will be null. - :param site_to_site_secure: The site_to_site_secure of this ControllerDTO. - :type: bool + :param remote_site_listening_port: The remote_site_listening_port of this ControllerDTO. + :type: int """ - self._site_to_site_secure = site_to_site_secure + self._remote_site_listening_port = remote_site_listening_port @property - def instance_id(self): + def running_count(self): """ - Gets the instance_id of this ControllerDTO. - If clustered, the id of the Cluster Manager, otherwise the id of the NiFi. + Gets the running_count of this ControllerDTO. + The number of running components in the NiFi. - :return: The instance_id of this ControllerDTO. - :rtype: str + :return: The running_count of this ControllerDTO. + :rtype: int """ - return self._instance_id + return self._running_count - @instance_id.setter - def instance_id(self, instance_id): + @running_count.setter + def running_count(self, running_count): """ - Sets the instance_id of this ControllerDTO. - If clustered, the id of the Cluster Manager, otherwise the id of the NiFi. + Sets the running_count of this ControllerDTO. + The number of running components in the NiFi. - :param instance_id: The instance_id of this ControllerDTO. - :type: str + :param running_count: The running_count of this ControllerDTO. + :type: int """ - self._instance_id = instance_id + self._running_count = running_count @property - def input_ports(self): + def site_to_site_secure(self): """ - Gets the input_ports of this ControllerDTO. - The input ports available to send data to for the NiFi. + Gets the site_to_site_secure of this ControllerDTO. + Indicates whether or not Site-to-Site communications with this instance is secure (2-way authentication). - :return: The input_ports of this ControllerDTO. - :rtype: list[PortDTO] + :return: The site_to_site_secure of this ControllerDTO. + :rtype: bool """ - return self._input_ports + return self._site_to_site_secure - @input_ports.setter - def input_ports(self, input_ports): + @site_to_site_secure.setter + def site_to_site_secure(self, site_to_site_secure): """ - Sets the input_ports of this ControllerDTO. - The input ports available to send data to for the NiFi. + Sets the site_to_site_secure of this ControllerDTO. + Indicates whether or not Site-to-Site communications with this instance is secure (2-way authentication). - :param input_ports: The input_ports of this ControllerDTO. - :type: list[PortDTO] + :param site_to_site_secure: The site_to_site_secure of this ControllerDTO. + :type: bool """ - self._input_ports = input_ports + self._site_to_site_secure = site_to_site_secure @property - def output_ports(self): + def stopped_count(self): """ - Gets the output_ports of this ControllerDTO. - The output ports available to received data from the NiFi. + Gets the stopped_count of this ControllerDTO. + The number of stopped components in the NiFi. - :return: The output_ports of this ControllerDTO. - :rtype: list[PortDTO] + :return: The stopped_count of this ControllerDTO. + :rtype: int """ - return self._output_ports + return self._stopped_count - @output_ports.setter - def output_ports(self, output_ports): + @stopped_count.setter + def stopped_count(self, stopped_count): """ - Sets the output_ports of this ControllerDTO. - The output ports available to received data from the NiFi. + Sets the stopped_count of this ControllerDTO. + The number of stopped components in the NiFi. - :param output_ports: The output_ports of this ControllerDTO. - :type: list[PortDTO] + :param stopped_count: The stopped_count of this ControllerDTO. + :type: int """ - self._output_ports = output_ports + self._stopped_count = stopped_count def to_dict(self): """ diff --git a/nipyapi/nifi/models/controller_entity.py b/nipyapi/nifi/models/controller_entity.py index bd31ea87..413377f5 100644 --- a/nipyapi/nifi/models/controller_entity.py +++ b/nipyapi/nifi/models/controller_entity.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,12 +27,10 @@ class ControllerEntity(object): and the value is json key in definition. """ swagger_types = { - 'controller': 'ControllerDTO' - } + 'controller': 'ControllerDTO' } attribute_map = { - 'controller': 'controller' - } + 'controller': 'controller' } def __init__(self, controller=None): """ diff --git a/nipyapi/nifi/models/controller_service_api.py b/nipyapi/nifi/models/controller_service_api.py index 82cff79b..43b2d080 100644 --- a/nipyapi/nifi/models/controller_service_api.py +++ b/nipyapi/nifi/models/controller_service_api.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,27 +27,46 @@ class ControllerServiceAPI(object): and the value is json key in definition. """ swagger_types = { - 'type': 'str', - 'bundle': 'Bundle' - } + 'bundle': 'Bundle', +'type': 'str' } attribute_map = { - 'type': 'type', - 'bundle': 'bundle' - } + 'bundle': 'bundle', +'type': 'type' } - def __init__(self, type=None, bundle=None): + def __init__(self, bundle=None, type=None): """ ControllerServiceAPI - a model defined in Swagger """ - self._type = None self._bundle = None + self._type = None - if type is not None: - self.type = type if bundle is not None: self.bundle = bundle + if type is not None: + self.type = type + + @property + def bundle(self): + """ + Gets the bundle of this ControllerServiceAPI. + + :return: The bundle of this ControllerServiceAPI. + :rtype: Bundle + """ + return self._bundle + + @bundle.setter + def bundle(self, bundle): + """ + Sets the bundle of this ControllerServiceAPI. + + :param bundle: The bundle of this ControllerServiceAPI. + :type: Bundle + """ + + self._bundle = bundle @property def type(self): @@ -73,29 +91,6 @@ def type(self, type): self._type = type - @property - def bundle(self): - """ - Gets the bundle of this ControllerServiceAPI. - The details of the artifact that bundled this service interface. - - :return: The bundle of this ControllerServiceAPI. - :rtype: Bundle - """ - return self._bundle - - @bundle.setter - def bundle(self, bundle): - """ - Sets the bundle of this ControllerServiceAPI. - The details of the artifact that bundled this service interface. - - :param bundle: The bundle of this ControllerServiceAPI. - :type: Bundle - """ - - self._bundle = bundle - def to_dict(self): """ Returns the model properties as a dict diff --git a/nipyapi/nifi/models/controller_service_api_dto.py b/nipyapi/nifi/models/controller_service_api_dto.py index 8063ace1..0fd19595 100644 --- a/nipyapi/nifi/models/controller_service_api_dto.py +++ b/nipyapi/nifi/models/controller_service_api_dto.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,27 +27,46 @@ class ControllerServiceApiDTO(object): and the value is json key in definition. """ swagger_types = { - 'type': 'str', - 'bundle': 'BundleDTO' - } + 'bundle': 'BundleDTO', +'type': 'str' } attribute_map = { - 'type': 'type', - 'bundle': 'bundle' - } + 'bundle': 'bundle', +'type': 'type' } - def __init__(self, type=None, bundle=None): + def __init__(self, bundle=None, type=None): """ ControllerServiceApiDTO - a model defined in Swagger """ - self._type = None self._bundle = None + self._type = None - if type is not None: - self.type = type if bundle is not None: self.bundle = bundle + if type is not None: + self.type = type + + @property + def bundle(self): + """ + Gets the bundle of this ControllerServiceApiDTO. + + :return: The bundle of this ControllerServiceApiDTO. + :rtype: BundleDTO + """ + return self._bundle + + @bundle.setter + def bundle(self, bundle): + """ + Sets the bundle of this ControllerServiceApiDTO. + + :param bundle: The bundle of this ControllerServiceApiDTO. + :type: BundleDTO + """ + + self._bundle = bundle @property def type(self): @@ -73,29 +91,6 @@ def type(self, type): self._type = type - @property - def bundle(self): - """ - Gets the bundle of this ControllerServiceApiDTO. - The details of the artifact that bundled this service interface. - - :return: The bundle of this ControllerServiceApiDTO. - :rtype: BundleDTO - """ - return self._bundle - - @bundle.setter - def bundle(self, bundle): - """ - Sets the bundle of this ControllerServiceApiDTO. - The details of the artifact that bundled this service interface. - - :param bundle: The bundle of this ControllerServiceApiDTO. - :type: BundleDTO - """ - - self._bundle = bundle - def to_dict(self): """ Returns the model properties as a dict diff --git a/nipyapi/nifi/models/controller_service_definition.py b/nipyapi/nifi/models/controller_service_definition.py index c49feb29..1d8c2b00 100644 --- a/nipyapi/nifi/models/controller_service_definition.py +++ b/nipyapi/nifi/models/controller_service_definition.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,149 +27,148 @@ class ControllerServiceDefinition(object): and the value is json key in definition. """ swagger_types = { - 'group': 'str', - 'artifact': 'str', - 'version': 'str', - 'type': 'str', - 'type_description': 'str', - 'build_info': 'BuildInfo', - 'provided_api_implementations': 'list[DefinedType]', - 'tags': 'list[str]', - 'see_also': 'list[str]', - 'deprecated': 'bool', - 'deprecation_reason': 'str', - 'deprecation_alternatives': 'list[str]', - 'restricted': 'bool', - 'restricted_explanation': 'str', - 'explicit_restrictions': 'list[Restriction]', - 'stateful': 'Stateful', - 'system_resource_considerations': 'list[SystemResourceConsideration]', 'additional_details': 'bool', - 'property_descriptors': 'dict(str, PropertyDescriptor)', - 'supports_dynamic_properties': 'bool', - 'supports_sensitive_dynamic_properties': 'bool', - 'dynamic_properties': 'list[DynamicProperty]' - } +'artifact': 'str', +'build_info': 'BuildInfo', +'deprecated': 'bool', +'deprecation_alternatives': 'list[str]', +'deprecation_reason': 'str', +'dynamic_properties': 'list[DynamicProperty]', +'explicit_restrictions': 'list[Restriction]', +'group': 'str', +'property_descriptors': 'dict(str, PropertyDescriptor)', +'provided_api_implementations': 'list[DefinedType]', +'restricted': 'bool', +'restricted_explanation': 'str', +'see_also': 'list[str]', +'stateful': 'Stateful', +'supports_dynamic_properties': 'bool', +'supports_sensitive_dynamic_properties': 'bool', +'system_resource_considerations': 'list[SystemResourceConsideration]', +'tags': 'list[str]', +'type': 'str', +'type_description': 'str', +'version': 'str' } attribute_map = { - 'group': 'group', - 'artifact': 'artifact', - 'version': 'version', - 'type': 'type', - 'type_description': 'typeDescription', - 'build_info': 'buildInfo', - 'provided_api_implementations': 'providedApiImplementations', - 'tags': 'tags', - 'see_also': 'seeAlso', - 'deprecated': 'deprecated', - 'deprecation_reason': 'deprecationReason', - 'deprecation_alternatives': 'deprecationAlternatives', - 'restricted': 'restricted', - 'restricted_explanation': 'restrictedExplanation', - 'explicit_restrictions': 'explicitRestrictions', - 'stateful': 'stateful', - 'system_resource_considerations': 'systemResourceConsiderations', 'additional_details': 'additionalDetails', - 'property_descriptors': 'propertyDescriptors', - 'supports_dynamic_properties': 'supportsDynamicProperties', - 'supports_sensitive_dynamic_properties': 'supportsSensitiveDynamicProperties', - 'dynamic_properties': 'dynamicProperties' - } - - def __init__(self, group=None, artifact=None, version=None, type=None, type_description=None, build_info=None, provided_api_implementations=None, tags=None, see_also=None, deprecated=None, deprecation_reason=None, deprecation_alternatives=None, restricted=None, restricted_explanation=None, explicit_restrictions=None, stateful=None, system_resource_considerations=None, additional_details=None, property_descriptors=None, supports_dynamic_properties=None, supports_sensitive_dynamic_properties=None, dynamic_properties=None): +'artifact': 'artifact', +'build_info': 'buildInfo', +'deprecated': 'deprecated', +'deprecation_alternatives': 'deprecationAlternatives', +'deprecation_reason': 'deprecationReason', +'dynamic_properties': 'dynamicProperties', +'explicit_restrictions': 'explicitRestrictions', +'group': 'group', +'property_descriptors': 'propertyDescriptors', +'provided_api_implementations': 'providedApiImplementations', +'restricted': 'restricted', +'restricted_explanation': 'restrictedExplanation', +'see_also': 'seeAlso', +'stateful': 'stateful', +'supports_dynamic_properties': 'supportsDynamicProperties', +'supports_sensitive_dynamic_properties': 'supportsSensitiveDynamicProperties', +'system_resource_considerations': 'systemResourceConsiderations', +'tags': 'tags', +'type': 'type', +'type_description': 'typeDescription', +'version': 'version' } + + def __init__(self, additional_details=None, artifact=None, build_info=None, deprecated=None, deprecation_alternatives=None, deprecation_reason=None, dynamic_properties=None, explicit_restrictions=None, group=None, property_descriptors=None, provided_api_implementations=None, restricted=None, restricted_explanation=None, see_also=None, stateful=None, supports_dynamic_properties=None, supports_sensitive_dynamic_properties=None, system_resource_considerations=None, tags=None, type=None, type_description=None, version=None): """ ControllerServiceDefinition - a model defined in Swagger """ - self._group = None + self._additional_details = None self._artifact = None - self._version = None - self._type = None - self._type_description = None self._build_info = None - self._provided_api_implementations = None - self._tags = None - self._see_also = None self._deprecated = None - self._deprecation_reason = None self._deprecation_alternatives = None + self._deprecation_reason = None + self._dynamic_properties = None + self._explicit_restrictions = None + self._group = None + self._property_descriptors = None + self._provided_api_implementations = None self._restricted = None self._restricted_explanation = None - self._explicit_restrictions = None + self._see_also = None self._stateful = None - self._system_resource_considerations = None - self._additional_details = None - self._property_descriptors = None self._supports_dynamic_properties = None self._supports_sensitive_dynamic_properties = None - self._dynamic_properties = None + self._system_resource_considerations = None + self._tags = None + self._type = None + self._type_description = None + self._version = None - if group is not None: - self.group = group + if additional_details is not None: + self.additional_details = additional_details if artifact is not None: self.artifact = artifact - if version is not None: - self.version = version - self.type = type - if type_description is not None: - self.type_description = type_description if build_info is not None: self.build_info = build_info - if provided_api_implementations is not None: - self.provided_api_implementations = provided_api_implementations - if tags is not None: - self.tags = tags - if see_also is not None: - self.see_also = see_also if deprecated is not None: self.deprecated = deprecated - if deprecation_reason is not None: - self.deprecation_reason = deprecation_reason if deprecation_alternatives is not None: self.deprecation_alternatives = deprecation_alternatives + if deprecation_reason is not None: + self.deprecation_reason = deprecation_reason + if dynamic_properties is not None: + self.dynamic_properties = dynamic_properties + if explicit_restrictions is not None: + self.explicit_restrictions = explicit_restrictions + if group is not None: + self.group = group + if property_descriptors is not None: + self.property_descriptors = property_descriptors + if provided_api_implementations is not None: + self.provided_api_implementations = provided_api_implementations if restricted is not None: self.restricted = restricted if restricted_explanation is not None: self.restricted_explanation = restricted_explanation - if explicit_restrictions is not None: - self.explicit_restrictions = explicit_restrictions + if see_also is not None: + self.see_also = see_also if stateful is not None: self.stateful = stateful - if system_resource_considerations is not None: - self.system_resource_considerations = system_resource_considerations - if additional_details is not None: - self.additional_details = additional_details - if property_descriptors is not None: - self.property_descriptors = property_descriptors if supports_dynamic_properties is not None: self.supports_dynamic_properties = supports_dynamic_properties if supports_sensitive_dynamic_properties is not None: self.supports_sensitive_dynamic_properties = supports_sensitive_dynamic_properties - if dynamic_properties is not None: - self.dynamic_properties = dynamic_properties + if system_resource_considerations is not None: + self.system_resource_considerations = system_resource_considerations + if tags is not None: + self.tags = tags + if type is not None: + self.type = type + if type_description is not None: + self.type_description = type_description + if version is not None: + self.version = version @property - def group(self): + def additional_details(self): """ - Gets the group of this ControllerServiceDefinition. - The group name of the bundle that provides the referenced type. + Gets the additional_details of this ControllerServiceDefinition. + Indicates if the component has additional details documentation - :return: The group of this ControllerServiceDefinition. - :rtype: str + :return: The additional_details of this ControllerServiceDefinition. + :rtype: bool """ - return self._group + return self._additional_details - @group.setter - def group(self, group): + @additional_details.setter + def additional_details(self, additional_details): """ - Sets the group of this ControllerServiceDefinition. - The group name of the bundle that provides the referenced type. + Sets the additional_details of this ControllerServiceDefinition. + Indicates if the component has additional details documentation - :param group: The group of this ControllerServiceDefinition. - :type: str + :param additional_details: The additional_details of this ControllerServiceDefinition. + :type: bool """ - self._group = group + self._additional_details = additional_details @property def artifact(self): @@ -196,236 +194,209 @@ def artifact(self, artifact): self._artifact = artifact @property - def version(self): - """ - Gets the version of this ControllerServiceDefinition. - The version of the bundle that provides the referenced type. - - :return: The version of this ControllerServiceDefinition. - :rtype: str - """ - return self._version - - @version.setter - def version(self, version): - """ - Sets the version of this ControllerServiceDefinition. - The version of the bundle that provides the referenced type. - - :param version: The version of this ControllerServiceDefinition. - :type: str - """ - - self._version = version - - @property - def type(self): + def build_info(self): """ - Gets the type of this ControllerServiceDefinition. - The fully-qualified class type + Gets the build_info of this ControllerServiceDefinition. - :return: The type of this ControllerServiceDefinition. - :rtype: str + :return: The build_info of this ControllerServiceDefinition. + :rtype: BuildInfo """ - return self._type + return self._build_info - @type.setter - def type(self, type): + @build_info.setter + def build_info(self, build_info): """ - Sets the type of this ControllerServiceDefinition. - The fully-qualified class type + Sets the build_info of this ControllerServiceDefinition. - :param type: The type of this ControllerServiceDefinition. - :type: str + :param build_info: The build_info of this ControllerServiceDefinition. + :type: BuildInfo """ - if type is None: - raise ValueError("Invalid value for `type`, must not be `None`") - self._type = type + self._build_info = build_info @property - def type_description(self): + def deprecated(self): """ - Gets the type_description of this ControllerServiceDefinition. - The description of the type. + Gets the deprecated of this ControllerServiceDefinition. + Whether or not the component has been deprecated - :return: The type_description of this ControllerServiceDefinition. - :rtype: str + :return: The deprecated of this ControllerServiceDefinition. + :rtype: bool """ - return self._type_description + return self._deprecated - @type_description.setter - def type_description(self, type_description): + @deprecated.setter + def deprecated(self, deprecated): """ - Sets the type_description of this ControllerServiceDefinition. - The description of the type. + Sets the deprecated of this ControllerServiceDefinition. + Whether or not the component has been deprecated - :param type_description: The type_description of this ControllerServiceDefinition. - :type: str + :param deprecated: The deprecated of this ControllerServiceDefinition. + :type: bool """ - self._type_description = type_description + self._deprecated = deprecated @property - def build_info(self): + def deprecation_alternatives(self): """ - Gets the build_info of this ControllerServiceDefinition. - The build metadata for this component + Gets the deprecation_alternatives of this ControllerServiceDefinition. + If this component has been deprecated, this optional field provides alternatives to use - :return: The build_info of this ControllerServiceDefinition. - :rtype: BuildInfo + :return: The deprecation_alternatives of this ControllerServiceDefinition. + :rtype: list[str] """ - return self._build_info + return self._deprecation_alternatives - @build_info.setter - def build_info(self, build_info): + @deprecation_alternatives.setter + def deprecation_alternatives(self, deprecation_alternatives): """ - Sets the build_info of this ControllerServiceDefinition. - The build metadata for this component + Sets the deprecation_alternatives of this ControllerServiceDefinition. + If this component has been deprecated, this optional field provides alternatives to use - :param build_info: The build_info of this ControllerServiceDefinition. - :type: BuildInfo + :param deprecation_alternatives: The deprecation_alternatives of this ControllerServiceDefinition. + :type: list[str] """ - self._build_info = build_info + self._deprecation_alternatives = deprecation_alternatives @property - def provided_api_implementations(self): + def deprecation_reason(self): """ - Gets the provided_api_implementations of this ControllerServiceDefinition. - If this type represents a provider for an interface, this lists the APIs it implements + Gets the deprecation_reason of this ControllerServiceDefinition. + If this component has been deprecated, this optional field can be used to provide an explanation - :return: The provided_api_implementations of this ControllerServiceDefinition. - :rtype: list[DefinedType] + :return: The deprecation_reason of this ControllerServiceDefinition. + :rtype: str """ - return self._provided_api_implementations + return self._deprecation_reason - @provided_api_implementations.setter - def provided_api_implementations(self, provided_api_implementations): + @deprecation_reason.setter + def deprecation_reason(self, deprecation_reason): """ - Sets the provided_api_implementations of this ControllerServiceDefinition. - If this type represents a provider for an interface, this lists the APIs it implements + Sets the deprecation_reason of this ControllerServiceDefinition. + If this component has been deprecated, this optional field can be used to provide an explanation - :param provided_api_implementations: The provided_api_implementations of this ControllerServiceDefinition. - :type: list[DefinedType] + :param deprecation_reason: The deprecation_reason of this ControllerServiceDefinition. + :type: str """ - self._provided_api_implementations = provided_api_implementations + self._deprecation_reason = deprecation_reason @property - def tags(self): + def dynamic_properties(self): """ - Gets the tags of this ControllerServiceDefinition. - The tags associated with this type + Gets the dynamic_properties of this ControllerServiceDefinition. + Describes the dynamic properties supported by this component - :return: The tags of this ControllerServiceDefinition. - :rtype: list[str] + :return: The dynamic_properties of this ControllerServiceDefinition. + :rtype: list[DynamicProperty] """ - return self._tags + return self._dynamic_properties - @tags.setter - def tags(self, tags): + @dynamic_properties.setter + def dynamic_properties(self, dynamic_properties): """ - Sets the tags of this ControllerServiceDefinition. - The tags associated with this type + Sets the dynamic_properties of this ControllerServiceDefinition. + Describes the dynamic properties supported by this component - :param tags: The tags of this ControllerServiceDefinition. - :type: list[str] + :param dynamic_properties: The dynamic_properties of this ControllerServiceDefinition. + :type: list[DynamicProperty] """ - self._tags = tags + self._dynamic_properties = dynamic_properties @property - def see_also(self): + def explicit_restrictions(self): """ - Gets the see_also of this ControllerServiceDefinition. - The names of other component types that may be related + Gets the explicit_restrictions of this ControllerServiceDefinition. + Explicit restrictions that indicate a require permission to use the component - :return: The see_also of this ControllerServiceDefinition. - :rtype: list[str] + :return: The explicit_restrictions of this ControllerServiceDefinition. + :rtype: list[Restriction] """ - return self._see_also + return self._explicit_restrictions - @see_also.setter - def see_also(self, see_also): + @explicit_restrictions.setter + def explicit_restrictions(self, explicit_restrictions): """ - Sets the see_also of this ControllerServiceDefinition. - The names of other component types that may be related + Sets the explicit_restrictions of this ControllerServiceDefinition. + Explicit restrictions that indicate a require permission to use the component - :param see_also: The see_also of this ControllerServiceDefinition. - :type: list[str] + :param explicit_restrictions: The explicit_restrictions of this ControllerServiceDefinition. + :type: list[Restriction] """ - self._see_also = see_also + self._explicit_restrictions = explicit_restrictions @property - def deprecated(self): + def group(self): """ - Gets the deprecated of this ControllerServiceDefinition. - Whether or not the component has been deprecated + Gets the group of this ControllerServiceDefinition. + The group name of the bundle that provides the referenced type. - :return: The deprecated of this ControllerServiceDefinition. - :rtype: bool + :return: The group of this ControllerServiceDefinition. + :rtype: str """ - return self._deprecated + return self._group - @deprecated.setter - def deprecated(self, deprecated): + @group.setter + def group(self, group): """ - Sets the deprecated of this ControllerServiceDefinition. - Whether or not the component has been deprecated - - :param deprecated: The deprecated of this ControllerServiceDefinition. - :type: bool + Sets the group of this ControllerServiceDefinition. + The group name of the bundle that provides the referenced type. + + :param group: The group of this ControllerServiceDefinition. + :type: str """ - self._deprecated = deprecated + self._group = group @property - def deprecation_reason(self): + def property_descriptors(self): """ - Gets the deprecation_reason of this ControllerServiceDefinition. - If this component has been deprecated, this optional field can be used to provide an explanation + Gets the property_descriptors of this ControllerServiceDefinition. + Descriptions of configuration properties applicable to this component. - :return: The deprecation_reason of this ControllerServiceDefinition. - :rtype: str + :return: The property_descriptors of this ControllerServiceDefinition. + :rtype: dict(str, PropertyDescriptor) """ - return self._deprecation_reason + return self._property_descriptors - @deprecation_reason.setter - def deprecation_reason(self, deprecation_reason): + @property_descriptors.setter + def property_descriptors(self, property_descriptors): """ - Sets the deprecation_reason of this ControllerServiceDefinition. - If this component has been deprecated, this optional field can be used to provide an explanation + Sets the property_descriptors of this ControllerServiceDefinition. + Descriptions of configuration properties applicable to this component. - :param deprecation_reason: The deprecation_reason of this ControllerServiceDefinition. - :type: str + :param property_descriptors: The property_descriptors of this ControllerServiceDefinition. + :type: dict(str, PropertyDescriptor) """ - self._deprecation_reason = deprecation_reason + self._property_descriptors = property_descriptors @property - def deprecation_alternatives(self): + def provided_api_implementations(self): """ - Gets the deprecation_alternatives of this ControllerServiceDefinition. - If this component has been deprecated, this optional field provides alternatives to use + Gets the provided_api_implementations of this ControllerServiceDefinition. + If this type represents a provider for an interface, this lists the APIs it implements - :return: The deprecation_alternatives of this ControllerServiceDefinition. - :rtype: list[str] + :return: The provided_api_implementations of this ControllerServiceDefinition. + :rtype: list[DefinedType] """ - return self._deprecation_alternatives + return self._provided_api_implementations - @deprecation_alternatives.setter - def deprecation_alternatives(self, deprecation_alternatives): + @provided_api_implementations.setter + def provided_api_implementations(self, provided_api_implementations): """ - Sets the deprecation_alternatives of this ControllerServiceDefinition. - If this component has been deprecated, this optional field provides alternatives to use + Sets the provided_api_implementations of this ControllerServiceDefinition. + If this type represents a provider for an interface, this lists the APIs it implements - :param deprecation_alternatives: The deprecation_alternatives of this ControllerServiceDefinition. - :type: list[str] + :param provided_api_implementations: The provided_api_implementations of this ControllerServiceDefinition. + :type: list[DefinedType] """ - self._deprecation_alternatives = deprecation_alternatives + self._provided_api_implementations = provided_api_implementations @property def restricted(self): @@ -474,33 +445,32 @@ def restricted_explanation(self, restricted_explanation): self._restricted_explanation = restricted_explanation @property - def explicit_restrictions(self): + def see_also(self): """ - Gets the explicit_restrictions of this ControllerServiceDefinition. - Explicit restrictions that indicate a require permission to use the component + Gets the see_also of this ControllerServiceDefinition. + The names of other component types that may be related - :return: The explicit_restrictions of this ControllerServiceDefinition. - :rtype: list[Restriction] + :return: The see_also of this ControllerServiceDefinition. + :rtype: list[str] """ - return self._explicit_restrictions + return self._see_also - @explicit_restrictions.setter - def explicit_restrictions(self, explicit_restrictions): + @see_also.setter + def see_also(self, see_also): """ - Sets the explicit_restrictions of this ControllerServiceDefinition. - Explicit restrictions that indicate a require permission to use the component + Sets the see_also of this ControllerServiceDefinition. + The names of other component types that may be related - :param explicit_restrictions: The explicit_restrictions of this ControllerServiceDefinition. - :type: list[Restriction] + :param see_also: The see_also of this ControllerServiceDefinition. + :type: list[str] """ - self._explicit_restrictions = explicit_restrictions + self._see_also = see_also @property def stateful(self): """ Gets the stateful of this ControllerServiceDefinition. - Indicates if the component stores state :return: The stateful of this ControllerServiceDefinition. :rtype: Stateful @@ -511,7 +481,6 @@ def stateful(self): def stateful(self, stateful): """ Sets the stateful of this ControllerServiceDefinition. - Indicates if the component stores state :param stateful: The stateful of this ControllerServiceDefinition. :type: Stateful @@ -519,6 +488,52 @@ def stateful(self, stateful): self._stateful = stateful + @property + def supports_dynamic_properties(self): + """ + Gets the supports_dynamic_properties of this ControllerServiceDefinition. + Whether or not this component makes use of dynamic (user-set) properties. + + :return: The supports_dynamic_properties of this ControllerServiceDefinition. + :rtype: bool + """ + return self._supports_dynamic_properties + + @supports_dynamic_properties.setter + def supports_dynamic_properties(self, supports_dynamic_properties): + """ + Sets the supports_dynamic_properties of this ControllerServiceDefinition. + Whether or not this component makes use of dynamic (user-set) properties. + + :param supports_dynamic_properties: The supports_dynamic_properties of this ControllerServiceDefinition. + :type: bool + """ + + self._supports_dynamic_properties = supports_dynamic_properties + + @property + def supports_sensitive_dynamic_properties(self): + """ + Gets the supports_sensitive_dynamic_properties of this ControllerServiceDefinition. + Whether or not this component makes use of sensitive dynamic (user-set) properties. + + :return: The supports_sensitive_dynamic_properties of this ControllerServiceDefinition. + :rtype: bool + """ + return self._supports_sensitive_dynamic_properties + + @supports_sensitive_dynamic_properties.setter + def supports_sensitive_dynamic_properties(self, supports_sensitive_dynamic_properties): + """ + Sets the supports_sensitive_dynamic_properties of this ControllerServiceDefinition. + Whether or not this component makes use of sensitive dynamic (user-set) properties. + + :param supports_sensitive_dynamic_properties: The supports_sensitive_dynamic_properties of this ControllerServiceDefinition. + :type: bool + """ + + self._supports_sensitive_dynamic_properties = supports_sensitive_dynamic_properties + @property def system_resource_considerations(self): """ @@ -543,119 +558,96 @@ def system_resource_considerations(self, system_resource_considerations): self._system_resource_considerations = system_resource_considerations @property - def additional_details(self): - """ - Gets the additional_details of this ControllerServiceDefinition. - Indicates if the component has additional details documentation - - :return: The additional_details of this ControllerServiceDefinition. - :rtype: bool - """ - return self._additional_details - - @additional_details.setter - def additional_details(self, additional_details): - """ - Sets the additional_details of this ControllerServiceDefinition. - Indicates if the component has additional details documentation - - :param additional_details: The additional_details of this ControllerServiceDefinition. - :type: bool - """ - - self._additional_details = additional_details - - @property - def property_descriptors(self): + def tags(self): """ - Gets the property_descriptors of this ControllerServiceDefinition. - Descriptions of configuration properties applicable to this component. + Gets the tags of this ControllerServiceDefinition. + The tags associated with this type - :return: The property_descriptors of this ControllerServiceDefinition. - :rtype: dict(str, PropertyDescriptor) + :return: The tags of this ControllerServiceDefinition. + :rtype: list[str] """ - return self._property_descriptors + return self._tags - @property_descriptors.setter - def property_descriptors(self, property_descriptors): + @tags.setter + def tags(self, tags): """ - Sets the property_descriptors of this ControllerServiceDefinition. - Descriptions of configuration properties applicable to this component. + Sets the tags of this ControllerServiceDefinition. + The tags associated with this type - :param property_descriptors: The property_descriptors of this ControllerServiceDefinition. - :type: dict(str, PropertyDescriptor) + :param tags: The tags of this ControllerServiceDefinition. + :type: list[str] """ - self._property_descriptors = property_descriptors + self._tags = tags @property - def supports_dynamic_properties(self): + def type(self): """ - Gets the supports_dynamic_properties of this ControllerServiceDefinition. - Whether or not this component makes use of dynamic (user-set) properties. + Gets the type of this ControllerServiceDefinition. + The fully-qualified class type - :return: The supports_dynamic_properties of this ControllerServiceDefinition. - :rtype: bool + :return: The type of this ControllerServiceDefinition. + :rtype: str """ - return self._supports_dynamic_properties + return self._type - @supports_dynamic_properties.setter - def supports_dynamic_properties(self, supports_dynamic_properties): + @type.setter + def type(self, type): """ - Sets the supports_dynamic_properties of this ControllerServiceDefinition. - Whether or not this component makes use of dynamic (user-set) properties. + Sets the type of this ControllerServiceDefinition. + The fully-qualified class type - :param supports_dynamic_properties: The supports_dynamic_properties of this ControllerServiceDefinition. - :type: bool + :param type: The type of this ControllerServiceDefinition. + :type: str """ - self._supports_dynamic_properties = supports_dynamic_properties + self._type = type @property - def supports_sensitive_dynamic_properties(self): + def type_description(self): """ - Gets the supports_sensitive_dynamic_properties of this ControllerServiceDefinition. - Whether or not this component makes use of sensitive dynamic (user-set) properties. + Gets the type_description of this ControllerServiceDefinition. + The description of the type. - :return: The supports_sensitive_dynamic_properties of this ControllerServiceDefinition. - :rtype: bool + :return: The type_description of this ControllerServiceDefinition. + :rtype: str """ - return self._supports_sensitive_dynamic_properties + return self._type_description - @supports_sensitive_dynamic_properties.setter - def supports_sensitive_dynamic_properties(self, supports_sensitive_dynamic_properties): + @type_description.setter + def type_description(self, type_description): """ - Sets the supports_sensitive_dynamic_properties of this ControllerServiceDefinition. - Whether or not this component makes use of sensitive dynamic (user-set) properties. + Sets the type_description of this ControllerServiceDefinition. + The description of the type. - :param supports_sensitive_dynamic_properties: The supports_sensitive_dynamic_properties of this ControllerServiceDefinition. - :type: bool + :param type_description: The type_description of this ControllerServiceDefinition. + :type: str """ - self._supports_sensitive_dynamic_properties = supports_sensitive_dynamic_properties + self._type_description = type_description @property - def dynamic_properties(self): + def version(self): """ - Gets the dynamic_properties of this ControllerServiceDefinition. - Describes the dynamic properties supported by this component + Gets the version of this ControllerServiceDefinition. + The version of the bundle that provides the referenced type. - :return: The dynamic_properties of this ControllerServiceDefinition. - :rtype: list[DynamicProperty] + :return: The version of this ControllerServiceDefinition. + :rtype: str """ - return self._dynamic_properties + return self._version - @dynamic_properties.setter - def dynamic_properties(self, dynamic_properties): + @version.setter + def version(self, version): """ - Sets the dynamic_properties of this ControllerServiceDefinition. - Describes the dynamic properties supported by this component + Sets the version of this ControllerServiceDefinition. + The version of the bundle that provides the referenced type. - :param dynamic_properties: The dynamic_properties of this ControllerServiceDefinition. - :type: list[DynamicProperty] + :param version: The version of this ControllerServiceDefinition. + :type: str """ - self._dynamic_properties = dynamic_properties + self._version = version def to_dict(self): """ diff --git a/nipyapi/nifi/models/controller_service_diagnostics_dto.py b/nipyapi/nifi/models/controller_service_diagnostics_dto.py deleted file mode 100644 index 1bbcffcd..00000000 --- a/nipyapi/nifi/models/controller_service_diagnostics_dto.py +++ /dev/null @@ -1,150 +0,0 @@ -""" - NiFi Rest API - - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - - OpenAPI spec version: 1.28.1 - Contact: dev@nifi.apache.org - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - - -from pprint import pformat -import re - - -class ControllerServiceDiagnosticsDTO(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 = { - 'controller_service': 'ControllerServiceEntity', - 'class_loader_diagnostics': 'ClassLoaderDiagnosticsDTO' - } - - attribute_map = { - 'controller_service': 'controllerService', - 'class_loader_diagnostics': 'classLoaderDiagnostics' - } - - def __init__(self, controller_service=None, class_loader_diagnostics=None): - """ - ControllerServiceDiagnosticsDTO - a model defined in Swagger - """ - - self._controller_service = None - self._class_loader_diagnostics = None - - if controller_service is not None: - self.controller_service = controller_service - if class_loader_diagnostics is not None: - self.class_loader_diagnostics = class_loader_diagnostics - - @property - def controller_service(self): - """ - Gets the controller_service of this ControllerServiceDiagnosticsDTO. - The Controller Service - - :return: The controller_service of this ControllerServiceDiagnosticsDTO. - :rtype: ControllerServiceEntity - """ - return self._controller_service - - @controller_service.setter - def controller_service(self, controller_service): - """ - Sets the controller_service of this ControllerServiceDiagnosticsDTO. - The Controller Service - - :param controller_service: The controller_service of this ControllerServiceDiagnosticsDTO. - :type: ControllerServiceEntity - """ - - self._controller_service = controller_service - - @property - def class_loader_diagnostics(self): - """ - Gets the class_loader_diagnostics of this ControllerServiceDiagnosticsDTO. - Information about the Controller Service's Class Loader - - :return: The class_loader_diagnostics of this ControllerServiceDiagnosticsDTO. - :rtype: ClassLoaderDiagnosticsDTO - """ - return self._class_loader_diagnostics - - @class_loader_diagnostics.setter - def class_loader_diagnostics(self, class_loader_diagnostics): - """ - Sets the class_loader_diagnostics of this ControllerServiceDiagnosticsDTO. - Information about the Controller Service's Class Loader - - :param class_loader_diagnostics: The class_loader_diagnostics of this ControllerServiceDiagnosticsDTO. - :type: ClassLoaderDiagnosticsDTO - """ - - self._class_loader_diagnostics = class_loader_diagnostics - - 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, ControllerServiceDiagnosticsDTO): - 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/controller_service_dto.py b/nipyapi/nifi/models/controller_service_dto.py index c7ba8325..4d413f8d 100644 --- a/nipyapi/nifi/models/controller_service_dto.py +++ b/nipyapi/nifi/models/controller_service_dto.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,493 +27,481 @@ class ControllerServiceDTO(object): and the value is json key in definition. """ swagger_types = { - 'id': 'str', - 'versioned_component_id': 'str', - 'parent_group_id': 'str', - 'position': 'PositionDTO', - 'name': 'str', - 'type': 'str', - 'bundle': 'BundleDTO', - 'controller_service_apis': 'list[ControllerServiceApiDTO]', - 'comments': 'str', - 'state': 'str', - 'persists_state': 'bool', - 'restricted': 'bool', - 'deprecated': 'bool', - 'multiple_versions_available': 'bool', - 'supports_sensitive_dynamic_properties': 'bool', - 'properties': 'dict(str, str)', - 'descriptors': 'dict(str, PropertyDescriptorDTO)', - 'sensitive_dynamic_property_names': 'list[str]', - 'custom_ui_url': 'str', 'annotation_data': 'str', - 'referencing_components': 'list[ControllerServiceReferencingComponentEntity]', - 'validation_errors': 'list[str]', - 'validation_status': 'str', - 'bulletin_level': 'str', - 'extension_missing': 'bool' - } +'bulletin_level': 'str', +'bundle': 'BundleDTO', +'comments': 'str', +'controller_service_apis': 'list[ControllerServiceApiDTO]', +'custom_ui_url': 'str', +'deprecated': 'bool', +'descriptors': 'dict(str, PropertyDescriptorDTO)', +'extension_missing': 'bool', +'id': 'str', +'multiple_versions_available': 'bool', +'name': 'str', +'parent_group_id': 'str', +'persists_state': 'bool', +'position': 'PositionDTO', +'properties': 'dict(str, str)', +'referencing_components': 'list[ControllerServiceReferencingComponentEntity]', +'restricted': 'bool', +'sensitive_dynamic_property_names': 'list[str]', +'state': 'str', +'supports_sensitive_dynamic_properties': 'bool', +'type': 'str', +'validation_errors': 'list[str]', +'validation_status': 'str', +'versioned_component_id': 'str' } attribute_map = { - 'id': 'id', - 'versioned_component_id': 'versionedComponentId', - 'parent_group_id': 'parentGroupId', - 'position': 'position', - 'name': 'name', - 'type': 'type', - 'bundle': 'bundle', - 'controller_service_apis': 'controllerServiceApis', - 'comments': 'comments', - 'state': 'state', - 'persists_state': 'persistsState', - 'restricted': 'restricted', - 'deprecated': 'deprecated', - 'multiple_versions_available': 'multipleVersionsAvailable', - 'supports_sensitive_dynamic_properties': 'supportsSensitiveDynamicProperties', - 'properties': 'properties', - 'descriptors': 'descriptors', - 'sensitive_dynamic_property_names': 'sensitiveDynamicPropertyNames', - 'custom_ui_url': 'customUiUrl', 'annotation_data': 'annotationData', - 'referencing_components': 'referencingComponents', - 'validation_errors': 'validationErrors', - 'validation_status': 'validationStatus', - 'bulletin_level': 'bulletinLevel', - 'extension_missing': 'extensionMissing' - } - - def __init__(self, id=None, versioned_component_id=None, parent_group_id=None, position=None, name=None, type=None, bundle=None, controller_service_apis=None, comments=None, state=None, persists_state=None, restricted=None, deprecated=None, multiple_versions_available=None, supports_sensitive_dynamic_properties=None, properties=None, descriptors=None, sensitive_dynamic_property_names=None, custom_ui_url=None, annotation_data=None, referencing_components=None, validation_errors=None, validation_status=None, bulletin_level=None, extension_missing=None): +'bulletin_level': 'bulletinLevel', +'bundle': 'bundle', +'comments': 'comments', +'controller_service_apis': 'controllerServiceApis', +'custom_ui_url': 'customUiUrl', +'deprecated': 'deprecated', +'descriptors': 'descriptors', +'extension_missing': 'extensionMissing', +'id': 'id', +'multiple_versions_available': 'multipleVersionsAvailable', +'name': 'name', +'parent_group_id': 'parentGroupId', +'persists_state': 'persistsState', +'position': 'position', +'properties': 'properties', +'referencing_components': 'referencingComponents', +'restricted': 'restricted', +'sensitive_dynamic_property_names': 'sensitiveDynamicPropertyNames', +'state': 'state', +'supports_sensitive_dynamic_properties': 'supportsSensitiveDynamicProperties', +'type': 'type', +'validation_errors': 'validationErrors', +'validation_status': 'validationStatus', +'versioned_component_id': 'versionedComponentId' } + + def __init__(self, annotation_data=None, bulletin_level=None, bundle=None, comments=None, controller_service_apis=None, custom_ui_url=None, deprecated=None, descriptors=None, extension_missing=None, id=None, multiple_versions_available=None, name=None, parent_group_id=None, persists_state=None, position=None, properties=None, referencing_components=None, restricted=None, sensitive_dynamic_property_names=None, state=None, supports_sensitive_dynamic_properties=None, type=None, validation_errors=None, validation_status=None, versioned_component_id=None): """ ControllerServiceDTO - a model defined in Swagger """ - self._id = None - self._versioned_component_id = None - self._parent_group_id = None - self._position = None - self._name = None - self._type = None + self._annotation_data = None + self._bulletin_level = None self._bundle = None - self._controller_service_apis = None self._comments = None - self._state = None - self._persists_state = None - self._restricted = None + self._controller_service_apis = None + self._custom_ui_url = None self._deprecated = None + self._descriptors = None + self._extension_missing = None + self._id = None self._multiple_versions_available = None - self._supports_sensitive_dynamic_properties = None + self._name = None + self._parent_group_id = None + self._persists_state = None + self._position = None self._properties = None - self._descriptors = None - self._sensitive_dynamic_property_names = None - self._custom_ui_url = None - self._annotation_data = None self._referencing_components = None + self._restricted = None + self._sensitive_dynamic_property_names = None + self._state = None + self._supports_sensitive_dynamic_properties = None + self._type = None self._validation_errors = None self._validation_status = None - self._bulletin_level = None - self._extension_missing = None + self._versioned_component_id = None - if id is not None: - self.id = id - if versioned_component_id is not None: - self.versioned_component_id = versioned_component_id - if parent_group_id is not None: - self.parent_group_id = parent_group_id - if position is not None: - self.position = position - if name is not None: - self.name = name - if type is not None: - self.type = type + if annotation_data is not None: + self.annotation_data = annotation_data + if bulletin_level is not None: + self.bulletin_level = bulletin_level if bundle is not None: self.bundle = bundle - if controller_service_apis is not None: - self.controller_service_apis = controller_service_apis if comments is not None: self.comments = comments - if state is not None: - self.state = state - if persists_state is not None: - self.persists_state = persists_state - if restricted is not None: - self.restricted = restricted + if controller_service_apis is not None: + self.controller_service_apis = controller_service_apis + if custom_ui_url is not None: + self.custom_ui_url = custom_ui_url if deprecated is not None: self.deprecated = deprecated + if descriptors is not None: + self.descriptors = descriptors + if extension_missing is not None: + self.extension_missing = extension_missing + if id is not None: + self.id = id if multiple_versions_available is not None: self.multiple_versions_available = multiple_versions_available - if supports_sensitive_dynamic_properties is not None: - self.supports_sensitive_dynamic_properties = supports_sensitive_dynamic_properties + if name is not None: + self.name = name + if parent_group_id is not None: + self.parent_group_id = parent_group_id + if persists_state is not None: + self.persists_state = persists_state + if position is not None: + self.position = position if properties is not None: self.properties = properties - if descriptors is not None: - self.descriptors = descriptors - if sensitive_dynamic_property_names is not None: - self.sensitive_dynamic_property_names = sensitive_dynamic_property_names - if custom_ui_url is not None: - self.custom_ui_url = custom_ui_url - if annotation_data is not None: - self.annotation_data = annotation_data if referencing_components is not None: self.referencing_components = referencing_components + if restricted is not None: + self.restricted = restricted + if sensitive_dynamic_property_names is not None: + self.sensitive_dynamic_property_names = sensitive_dynamic_property_names + if state is not None: + self.state = state + if supports_sensitive_dynamic_properties is not None: + self.supports_sensitive_dynamic_properties = supports_sensitive_dynamic_properties + if type is not None: + self.type = type if validation_errors is not None: self.validation_errors = validation_errors if validation_status is not None: self.validation_status = validation_status - if bulletin_level is not None: - self.bulletin_level = bulletin_level - if extension_missing is not None: - self.extension_missing = extension_missing + if versioned_component_id is not None: + self.versioned_component_id = versioned_component_id @property - def id(self): + def annotation_data(self): """ - Gets the id of this ControllerServiceDTO. - The id of the component. + Gets the annotation_data of this ControllerServiceDTO. + The annotation for the controller service. This is how the custom UI relays configuration to the controller service. - :return: The id of this ControllerServiceDTO. + :return: The annotation_data of this ControllerServiceDTO. :rtype: str """ - return self._id + return self._annotation_data - @id.setter - def id(self, id): + @annotation_data.setter + def annotation_data(self, annotation_data): """ - Sets the id of this ControllerServiceDTO. - The id of the component. + Sets the annotation_data of this ControllerServiceDTO. + The annotation for the controller service. This is how the custom UI relays configuration to the controller service. - :param id: The id of this ControllerServiceDTO. + :param annotation_data: The annotation_data of this ControllerServiceDTO. :type: str """ - self._id = id + self._annotation_data = annotation_data @property - def versioned_component_id(self): + def bulletin_level(self): """ - Gets the versioned_component_id of this ControllerServiceDTO. - The ID of the corresponding component that is under version control + Gets the bulletin_level of this ControllerServiceDTO. + The level at which the controller service will report bulletins. - :return: The versioned_component_id of this ControllerServiceDTO. + :return: The bulletin_level of this ControllerServiceDTO. :rtype: str """ - return self._versioned_component_id + return self._bulletin_level - @versioned_component_id.setter - def versioned_component_id(self, versioned_component_id): + @bulletin_level.setter + def bulletin_level(self, bulletin_level): """ - Sets the versioned_component_id of this ControllerServiceDTO. - The ID of the corresponding component that is under version control + Sets the bulletin_level of this ControllerServiceDTO. + The level at which the controller service will report bulletins. - :param versioned_component_id: The versioned_component_id of this ControllerServiceDTO. + :param bulletin_level: The bulletin_level of this ControllerServiceDTO. :type: str """ - self._versioned_component_id = versioned_component_id + self._bulletin_level = bulletin_level @property - def parent_group_id(self): + def bundle(self): """ - Gets the parent_group_id of this ControllerServiceDTO. - The id of parent process group of this component if applicable. + Gets the bundle of this ControllerServiceDTO. - :return: The parent_group_id of this ControllerServiceDTO. - :rtype: str + :return: The bundle of this ControllerServiceDTO. + :rtype: BundleDTO """ - return self._parent_group_id + return self._bundle - @parent_group_id.setter - def parent_group_id(self, parent_group_id): + @bundle.setter + def bundle(self, bundle): """ - Sets the parent_group_id of this ControllerServiceDTO. - The id of parent process group of this component if applicable. + Sets the bundle of this ControllerServiceDTO. - :param parent_group_id: The parent_group_id of this ControllerServiceDTO. - :type: str + :param bundle: The bundle of this ControllerServiceDTO. + :type: BundleDTO """ - self._parent_group_id = parent_group_id + self._bundle = bundle @property - def position(self): + def comments(self): """ - Gets the position of this ControllerServiceDTO. - The position of this component in the UI if applicable. + Gets the comments of this ControllerServiceDTO. + The comments for the controller service. - :return: The position of this ControllerServiceDTO. - :rtype: PositionDTO + :return: The comments of this ControllerServiceDTO. + :rtype: str """ - return self._position + return self._comments - @position.setter - def position(self, position): + @comments.setter + def comments(self, comments): """ - Sets the position of this ControllerServiceDTO. - The position of this component in the UI if applicable. + Sets the comments of this ControllerServiceDTO. + The comments for the controller service. - :param position: The position of this ControllerServiceDTO. - :type: PositionDTO + :param comments: The comments of this ControllerServiceDTO. + :type: str """ - self._position = position + self._comments = comments @property - def name(self): + def controller_service_apis(self): """ - Gets the name of this ControllerServiceDTO. - The name of the controller service. + Gets the controller_service_apis of this ControllerServiceDTO. + Lists the APIs this Controller Service implements. - :return: The name of this ControllerServiceDTO. - :rtype: str + :return: The controller_service_apis of this ControllerServiceDTO. + :rtype: list[ControllerServiceApiDTO] """ - return self._name + return self._controller_service_apis - @name.setter - def name(self, name): + @controller_service_apis.setter + def controller_service_apis(self, controller_service_apis): """ - Sets the name of this ControllerServiceDTO. - The name of the controller service. + Sets the controller_service_apis of this ControllerServiceDTO. + Lists the APIs this Controller Service implements. - :param name: The name of this ControllerServiceDTO. - :type: str + :param controller_service_apis: The controller_service_apis of this ControllerServiceDTO. + :type: list[ControllerServiceApiDTO] """ - self._name = name + self._controller_service_apis = controller_service_apis @property - def type(self): + def custom_ui_url(self): """ - Gets the type of this ControllerServiceDTO. - The type of the controller service. + Gets the custom_ui_url of this ControllerServiceDTO. + The URL for the controller services custom configuration UI if applicable. - :return: The type of this ControllerServiceDTO. + :return: The custom_ui_url of this ControllerServiceDTO. :rtype: str """ - return self._type + return self._custom_ui_url - @type.setter - def type(self, type): + @custom_ui_url.setter + def custom_ui_url(self, custom_ui_url): """ - Sets the type of this ControllerServiceDTO. - The type of the controller service. + Sets the custom_ui_url of this ControllerServiceDTO. + The URL for the controller services custom configuration UI if applicable. - :param type: The type of this ControllerServiceDTO. + :param custom_ui_url: The custom_ui_url of this ControllerServiceDTO. :type: str """ - self._type = type + self._custom_ui_url = custom_ui_url @property - def bundle(self): + def deprecated(self): """ - Gets the bundle of this ControllerServiceDTO. - The details of the artifact that bundled this processor type. + Gets the deprecated of this ControllerServiceDTO. + Whether the ontroller service has been deprecated. - :return: The bundle of this ControllerServiceDTO. - :rtype: BundleDTO + :return: The deprecated of this ControllerServiceDTO. + :rtype: bool """ - return self._bundle + return self._deprecated - @bundle.setter - def bundle(self, bundle): + @deprecated.setter + def deprecated(self, deprecated): """ - Sets the bundle of this ControllerServiceDTO. - The details of the artifact that bundled this processor type. + Sets the deprecated of this ControllerServiceDTO. + Whether the ontroller service has been deprecated. - :param bundle: The bundle of this ControllerServiceDTO. - :type: BundleDTO + :param deprecated: The deprecated of this ControllerServiceDTO. + :type: bool """ - self._bundle = bundle + self._deprecated = deprecated @property - def controller_service_apis(self): + def descriptors(self): """ - Gets the controller_service_apis of this ControllerServiceDTO. - Lists the APIs this Controller Service implements. + Gets the descriptors of this ControllerServiceDTO. + The descriptors for the controller service properties. - :return: The controller_service_apis of this ControllerServiceDTO. - :rtype: list[ControllerServiceApiDTO] + :return: The descriptors of this ControllerServiceDTO. + :rtype: dict(str, PropertyDescriptorDTO) """ - return self._controller_service_apis + return self._descriptors - @controller_service_apis.setter - def controller_service_apis(self, controller_service_apis): + @descriptors.setter + def descriptors(self, descriptors): """ - Sets the controller_service_apis of this ControllerServiceDTO. - Lists the APIs this Controller Service implements. + Sets the descriptors of this ControllerServiceDTO. + The descriptors for the controller service properties. - :param controller_service_apis: The controller_service_apis of this ControllerServiceDTO. - :type: list[ControllerServiceApiDTO] + :param descriptors: The descriptors of this ControllerServiceDTO. + :type: dict(str, PropertyDescriptorDTO) """ - self._controller_service_apis = controller_service_apis + self._descriptors = descriptors @property - def comments(self): + def extension_missing(self): """ - Gets the comments of this ControllerServiceDTO. - The comments for the controller service. + Gets the extension_missing of this ControllerServiceDTO. + Whether the underlying extension is missing. - :return: The comments of this ControllerServiceDTO. - :rtype: str + :return: The extension_missing of this ControllerServiceDTO. + :rtype: bool """ - return self._comments + return self._extension_missing - @comments.setter - def comments(self, comments): + @extension_missing.setter + def extension_missing(self, extension_missing): """ - Sets the comments of this ControllerServiceDTO. - The comments for the controller service. + Sets the extension_missing of this ControllerServiceDTO. + Whether the underlying extension is missing. - :param comments: The comments of this ControllerServiceDTO. - :type: str + :param extension_missing: The extension_missing of this ControllerServiceDTO. + :type: bool """ - self._comments = comments + self._extension_missing = extension_missing @property - def state(self): + def id(self): """ - Gets the state of this ControllerServiceDTO. - The state of the controller service. + Gets the id of this ControllerServiceDTO. + The id of the component. - :return: The state of this ControllerServiceDTO. + :return: The id of this ControllerServiceDTO. :rtype: str """ - return self._state + return self._id - @state.setter - def state(self, state): + @id.setter + def id(self, id): """ - Sets the state of this ControllerServiceDTO. - The state of the controller service. + Sets the id of this ControllerServiceDTO. + The id of the component. - :param state: The state of this ControllerServiceDTO. + :param id: The id 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) - ) - self._state = state + self._id = id @property - def persists_state(self): + def multiple_versions_available(self): """ - Gets the persists_state of this ControllerServiceDTO. - Whether the controller service persists state. + Gets the multiple_versions_available of this ControllerServiceDTO. + Whether the controller service has multiple versions available. - :return: The persists_state of this ControllerServiceDTO. + :return: The multiple_versions_available of this ControllerServiceDTO. :rtype: bool """ - return self._persists_state + return self._multiple_versions_available - @persists_state.setter - def persists_state(self, persists_state): + @multiple_versions_available.setter + def multiple_versions_available(self, multiple_versions_available): """ - Sets the persists_state of this ControllerServiceDTO. - Whether the controller service persists state. + Sets the multiple_versions_available of this ControllerServiceDTO. + Whether the controller service has multiple versions available. - :param persists_state: The persists_state of this ControllerServiceDTO. + :param multiple_versions_available: The multiple_versions_available of this ControllerServiceDTO. :type: bool """ - self._persists_state = persists_state + self._multiple_versions_available = multiple_versions_available @property - def restricted(self): + def name(self): """ - Gets the restricted of this ControllerServiceDTO. - Whether the controller service requires elevated privileges. + Gets the name of this ControllerServiceDTO. + The name of the controller service. - :return: The restricted of this ControllerServiceDTO. - :rtype: bool + :return: The name of this ControllerServiceDTO. + :rtype: str """ - return self._restricted + return self._name - @restricted.setter - def restricted(self, restricted): + @name.setter + def name(self, name): """ - Sets the restricted of this ControllerServiceDTO. - Whether the controller service requires elevated privileges. + Sets the name of this ControllerServiceDTO. + The name of the controller service. - :param restricted: The restricted of this ControllerServiceDTO. - :type: bool + :param name: The name of this ControllerServiceDTO. + :type: str """ - self._restricted = restricted + self._name = name @property - def deprecated(self): + def parent_group_id(self): """ - Gets the deprecated of this ControllerServiceDTO. - Whether the ontroller service has been deprecated. + Gets the parent_group_id of this ControllerServiceDTO. + The id of parent process group of this component if applicable. - :return: The deprecated of this ControllerServiceDTO. - :rtype: bool + :return: The parent_group_id of this ControllerServiceDTO. + :rtype: str """ - return self._deprecated + return self._parent_group_id - @deprecated.setter - def deprecated(self, deprecated): + @parent_group_id.setter + def parent_group_id(self, parent_group_id): """ - Sets the deprecated of this ControllerServiceDTO. - Whether the ontroller service has been deprecated. + Sets the parent_group_id of this ControllerServiceDTO. + The id of parent process group of this component if applicable. - :param deprecated: The deprecated of this ControllerServiceDTO. - :type: bool + :param parent_group_id: The parent_group_id of this ControllerServiceDTO. + :type: str """ - self._deprecated = deprecated + self._parent_group_id = parent_group_id @property - def multiple_versions_available(self): + def persists_state(self): """ - Gets the multiple_versions_available of this ControllerServiceDTO. - Whether the controller service has multiple versions available. + Gets the persists_state of this ControllerServiceDTO. + Whether the controller service persists state. - :return: The multiple_versions_available of this ControllerServiceDTO. + :return: The persists_state of this ControllerServiceDTO. :rtype: bool """ - return self._multiple_versions_available + return self._persists_state - @multiple_versions_available.setter - def multiple_versions_available(self, multiple_versions_available): + @persists_state.setter + def persists_state(self, persists_state): """ - Sets the multiple_versions_available of this ControllerServiceDTO. - Whether the controller service has multiple versions available. + Sets the persists_state of this ControllerServiceDTO. + Whether the controller service persists state. - :param multiple_versions_available: The multiple_versions_available of this ControllerServiceDTO. + :param persists_state: The persists_state of this ControllerServiceDTO. :type: bool """ - self._multiple_versions_available = multiple_versions_available + self._persists_state = persists_state @property - def supports_sensitive_dynamic_properties(self): + def position(self): """ - Gets the supports_sensitive_dynamic_properties of this ControllerServiceDTO. - Whether the controller service supports sensitive dynamic properties. + Gets the position of this ControllerServiceDTO. - :return: The supports_sensitive_dynamic_properties of this ControllerServiceDTO. - :rtype: bool + :return: The position of this ControllerServiceDTO. + :rtype: PositionDTO """ - return self._supports_sensitive_dynamic_properties + return self._position - @supports_sensitive_dynamic_properties.setter - def supports_sensitive_dynamic_properties(self, supports_sensitive_dynamic_properties): + @position.setter + def position(self, position): """ - Sets the supports_sensitive_dynamic_properties of this ControllerServiceDTO. - Whether the controller service supports sensitive dynamic properties. + Sets the position of this ControllerServiceDTO. - :param supports_sensitive_dynamic_properties: The supports_sensitive_dynamic_properties of this ControllerServiceDTO. - :type: bool + :param position: The position of this ControllerServiceDTO. + :type: PositionDTO """ - self._supports_sensitive_dynamic_properties = supports_sensitive_dynamic_properties + self._position = position @property def properties(self): @@ -540,27 +527,50 @@ def properties(self, properties): self._properties = properties @property - def descriptors(self): + def referencing_components(self): """ - Gets the descriptors of this ControllerServiceDTO. - The descriptors for the controller service properties. + Gets the referencing_components of this ControllerServiceDTO. + All components referencing this controller service. - :return: The descriptors of this ControllerServiceDTO. - :rtype: dict(str, PropertyDescriptorDTO) + :return: The referencing_components of this ControllerServiceDTO. + :rtype: list[ControllerServiceReferencingComponentEntity] """ - return self._descriptors + return self._referencing_components - @descriptors.setter - def descriptors(self, descriptors): + @referencing_components.setter + def referencing_components(self, referencing_components): """ - Sets the descriptors of this ControllerServiceDTO. - The descriptors for the controller service properties. + Sets the referencing_components of this ControllerServiceDTO. + All components referencing this controller service. - :param descriptors: The descriptors of this ControllerServiceDTO. - :type: dict(str, PropertyDescriptorDTO) + :param referencing_components: The referencing_components of this ControllerServiceDTO. + :type: list[ControllerServiceReferencingComponentEntity] """ - self._descriptors = descriptors + self._referencing_components = referencing_components + + @property + def restricted(self): + """ + Gets the restricted of this ControllerServiceDTO. + Whether the controller service requires elevated privileges. + + :return: The restricted of this ControllerServiceDTO. + :rtype: bool + """ + return self._restricted + + @restricted.setter + def restricted(self, restricted): + """ + Sets the restricted of this ControllerServiceDTO. + Whether the controller service requires elevated privileges. + + :param restricted: The restricted of this ControllerServiceDTO. + :type: bool + """ + + self._restricted = restricted @property def sensitive_dynamic_property_names(self): @@ -586,79 +596,85 @@ def sensitive_dynamic_property_names(self, sensitive_dynamic_property_names): self._sensitive_dynamic_property_names = sensitive_dynamic_property_names @property - def custom_ui_url(self): + def state(self): """ - Gets the custom_ui_url of this ControllerServiceDTO. - The URL for the controller services custom configuration UI if applicable. + Gets the state of this ControllerServiceDTO. + The state of the controller service. - :return: The custom_ui_url of this ControllerServiceDTO. + :return: The state of this ControllerServiceDTO. :rtype: str """ - return self._custom_ui_url + return self._state - @custom_ui_url.setter - def custom_ui_url(self, custom_ui_url): + @state.setter + def state(self, state): """ - Sets the custom_ui_url of this ControllerServiceDTO. - The URL for the controller services custom configuration UI if applicable. + Sets the state of this ControllerServiceDTO. + The state of the controller service. - :param custom_ui_url: The custom_ui_url of this ControllerServiceDTO. + :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) + ) - self._custom_ui_url = custom_ui_url + self._state = state @property - def annotation_data(self): + def supports_sensitive_dynamic_properties(self): """ - Gets the annotation_data of this ControllerServiceDTO. - The annotation for the controller service. This is how the custom UI relays configuration to the controller service. + Gets the supports_sensitive_dynamic_properties of this ControllerServiceDTO. + Whether the controller service supports sensitive dynamic properties. - :return: The annotation_data of this ControllerServiceDTO. - :rtype: str + :return: The supports_sensitive_dynamic_properties of this ControllerServiceDTO. + :rtype: bool """ - return self._annotation_data + return self._supports_sensitive_dynamic_properties - @annotation_data.setter - def annotation_data(self, annotation_data): + @supports_sensitive_dynamic_properties.setter + def supports_sensitive_dynamic_properties(self, supports_sensitive_dynamic_properties): """ - Sets the annotation_data of this ControllerServiceDTO. - The annotation for the controller service. This is how the custom UI relays configuration to the controller service. + Sets the supports_sensitive_dynamic_properties of this ControllerServiceDTO. + Whether the controller service supports sensitive dynamic properties. - :param annotation_data: The annotation_data of this ControllerServiceDTO. - :type: str + :param supports_sensitive_dynamic_properties: The supports_sensitive_dynamic_properties of this ControllerServiceDTO. + :type: bool """ - self._annotation_data = annotation_data + self._supports_sensitive_dynamic_properties = supports_sensitive_dynamic_properties @property - def referencing_components(self): + def type(self): """ - Gets the referencing_components of this ControllerServiceDTO. - All components referencing this controller service. + Gets the type of this ControllerServiceDTO. + The type of the controller service. - :return: The referencing_components of this ControllerServiceDTO. - :rtype: list[ControllerServiceReferencingComponentEntity] + :return: The type of this ControllerServiceDTO. + :rtype: str """ - return self._referencing_components + return self._type - @referencing_components.setter - def referencing_components(self, referencing_components): + @type.setter + def type(self, type): """ - Sets the referencing_components of this ControllerServiceDTO. - All components referencing this controller service. + Sets the type of this ControllerServiceDTO. + The type of the controller service. - :param referencing_components: The referencing_components of this ControllerServiceDTO. - :type: list[ControllerServiceReferencingComponentEntity] + :param type: The type of this ControllerServiceDTO. + :type: str """ - self._referencing_components = referencing_components + self._type = type @property def validation_errors(self): """ Gets the validation_errors of this ControllerServiceDTO. - The validation errors from the controller service. These validation errors represent the problems with the controller service that must be resolved before it can be enabled. + The validation errors from the controller service. These validation errors represent the problems with the controller service that must be resolved before it can be enabled. :return: The validation_errors of this ControllerServiceDTO. :rtype: list[str] @@ -669,7 +685,7 @@ def validation_errors(self): def validation_errors(self, validation_errors): """ Sets the validation_errors of this ControllerServiceDTO. - The validation errors from the controller service. These validation errors represent the problems with the controller service that must be resolved before it can be enabled. + The validation errors from the controller service. These validation errors represent the problems with the controller service that must be resolved before it can be enabled. :param validation_errors: The validation_errors of this ControllerServiceDTO. :type: list[str] @@ -697,7 +713,7 @@ def validation_status(self, validation_status): :param validation_status: The validation_status of this ControllerServiceDTO. :type: str """ - allowed_values = ["VALID", "INVALID", "VALIDATING"] + 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}" @@ -707,50 +723,27 @@ def validation_status(self, validation_status): self._validation_status = validation_status @property - def bulletin_level(self): + def versioned_component_id(self): """ - Gets the bulletin_level of this ControllerServiceDTO. - The level at which the controller service will report bulletins. + Gets the versioned_component_id of this ControllerServiceDTO. + The ID of the corresponding component that is under version control - :return: The bulletin_level of this ControllerServiceDTO. + :return: The versioned_component_id of this ControllerServiceDTO. :rtype: str """ - return self._bulletin_level + return self._versioned_component_id - @bulletin_level.setter - def bulletin_level(self, bulletin_level): + @versioned_component_id.setter + def versioned_component_id(self, versioned_component_id): """ - Sets the bulletin_level of this ControllerServiceDTO. - The level at which the controller service will report bulletins. + Sets the versioned_component_id of this ControllerServiceDTO. + The ID of the corresponding component that is under version control - :param bulletin_level: The bulletin_level of this ControllerServiceDTO. + :param versioned_component_id: The versioned_component_id of this ControllerServiceDTO. :type: str """ - self._bulletin_level = bulletin_level - - @property - def extension_missing(self): - """ - Gets the extension_missing of this ControllerServiceDTO. - Whether the underlying extension is missing. - - :return: The extension_missing of this ControllerServiceDTO. - :rtype: bool - """ - return self._extension_missing - - @extension_missing.setter - def extension_missing(self, extension_missing): - """ - Sets the extension_missing of this ControllerServiceDTO. - Whether the underlying extension is missing. - - :param extension_missing: The extension_missing of this ControllerServiceDTO. - :type: bool - """ - - self._extension_missing = extension_missing + self._versioned_component_id = versioned_component_id def to_dict(self): """ diff --git a/nipyapi/nifi/models/controller_service_entity.py b/nipyapi/nifi/models/controller_service_entity.py index 7b639941..b675a75a 100644 --- a/nipyapi/nifi/models/controller_service_entity.py +++ b/nipyapi/nifi/models/controller_service_entity.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,233 +27,181 @@ class ControllerServiceEntity(object): and the value is json key in definition. """ swagger_types = { - 'revision': 'RevisionDTO', - 'id': 'str', - 'uri': 'str', - 'position': 'PositionDTO', - 'permissions': 'PermissionsDTO', 'bulletins': 'list[BulletinEntity]', - 'disconnected_node_acknowledged': 'bool', - 'parent_group_id': 'str', - 'component': 'ControllerServiceDTO', - 'operate_permissions': 'PermissionsDTO', - 'status': 'ControllerServiceStatusDTO' - } +'component': 'ControllerServiceDTO', +'disconnected_node_acknowledged': 'bool', +'id': 'str', +'operate_permissions': 'PermissionsDTO', +'parent_group_id': 'str', +'permissions': 'PermissionsDTO', +'position': 'PositionDTO', +'revision': 'RevisionDTO', +'status': 'ControllerServiceStatusDTO', +'uri': 'str' } attribute_map = { - 'revision': 'revision', - 'id': 'id', - 'uri': 'uri', - 'position': 'position', - 'permissions': 'permissions', 'bulletins': 'bulletins', - 'disconnected_node_acknowledged': 'disconnectedNodeAcknowledged', - 'parent_group_id': 'parentGroupId', - 'component': 'component', - 'operate_permissions': 'operatePermissions', - 'status': 'status' - } - - def __init__(self, revision=None, id=None, uri=None, position=None, permissions=None, bulletins=None, disconnected_node_acknowledged=None, parent_group_id=None, component=None, operate_permissions=None, status=None): +'component': 'component', +'disconnected_node_acknowledged': 'disconnectedNodeAcknowledged', +'id': 'id', +'operate_permissions': 'operatePermissions', +'parent_group_id': 'parentGroupId', +'permissions': 'permissions', +'position': 'position', +'revision': 'revision', +'status': 'status', +'uri': 'uri' } + + def __init__(self, bulletins=None, component=None, disconnected_node_acknowledged=None, id=None, operate_permissions=None, parent_group_id=None, permissions=None, position=None, revision=None, status=None, uri=None): """ ControllerServiceEntity - a model defined in Swagger """ - self._revision = None - self._id = None - self._uri = None - self._position = None - self._permissions = None self._bulletins = None - self._disconnected_node_acknowledged = None - self._parent_group_id = None self._component = None + self._disconnected_node_acknowledged = None + self._id = None self._operate_permissions = None + self._parent_group_id = None + self._permissions = None + self._position = None + self._revision = None self._status = None + self._uri = None - if revision is not None: - self.revision = revision - if id is not None: - self.id = id - if uri is not None: - self.uri = uri - if position is not None: - self.position = position - if permissions is not None: - self.permissions = permissions if bulletins is not None: self.bulletins = bulletins - if disconnected_node_acknowledged is not None: - self.disconnected_node_acknowledged = disconnected_node_acknowledged - if parent_group_id is not None: - self.parent_group_id = parent_group_id if component is not None: self.component = component + if disconnected_node_acknowledged is not None: + self.disconnected_node_acknowledged = disconnected_node_acknowledged + if id is not None: + self.id = id if operate_permissions is not None: self.operate_permissions = operate_permissions + if parent_group_id is not None: + self.parent_group_id = parent_group_id + if permissions is not None: + self.permissions = permissions + if position is not None: + self.position = position + if revision is not None: + self.revision = revision if status is not None: self.status = status + if uri is not None: + self.uri = uri @property - def revision(self): + def bulletins(self): """ - Gets the revision of this ControllerServiceEntity. - The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses. + Gets the bulletins of this ControllerServiceEntity. + The bulletins for this component. - :return: The revision of this ControllerServiceEntity. - :rtype: RevisionDTO + :return: The bulletins of this ControllerServiceEntity. + :rtype: list[BulletinEntity] """ - return self._revision + return self._bulletins - @revision.setter - def revision(self, revision): + @bulletins.setter + def bulletins(self, bulletins): """ - Sets the revision of this ControllerServiceEntity. - The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses. + Sets the bulletins of this ControllerServiceEntity. + The bulletins for this component. - :param revision: The revision of this ControllerServiceEntity. - :type: RevisionDTO + :param bulletins: The bulletins of this ControllerServiceEntity. + :type: list[BulletinEntity] """ - self._revision = revision + self._bulletins = bulletins @property - def id(self): + def component(self): """ - Gets the id of this ControllerServiceEntity. - The id of the component. + Gets the component of this ControllerServiceEntity. - :return: The id of this ControllerServiceEntity. - :rtype: str + :return: The component of this ControllerServiceEntity. + :rtype: ControllerServiceDTO """ - return self._id + return self._component - @id.setter - def id(self, id): + @component.setter + def component(self, component): """ - Sets the id of this ControllerServiceEntity. - The id of the component. + Sets the component of this ControllerServiceEntity. - :param id: The id of this ControllerServiceEntity. - :type: str + :param component: The component of this ControllerServiceEntity. + :type: ControllerServiceDTO """ - self._id = id + self._component = component @property - def uri(self): + def disconnected_node_acknowledged(self): """ - Gets the uri of this ControllerServiceEntity. - The URI for futures requests to the component. + Gets the disconnected_node_acknowledged of this ControllerServiceEntity. + Acknowledges that this node is disconnected to allow for mutable requests to proceed. - :return: The uri of this ControllerServiceEntity. - :rtype: str + :return: The disconnected_node_acknowledged of this ControllerServiceEntity. + :rtype: bool """ - return self._uri + return self._disconnected_node_acknowledged - @uri.setter - def uri(self, uri): + @disconnected_node_acknowledged.setter + def disconnected_node_acknowledged(self, disconnected_node_acknowledged): """ - Sets the uri of this ControllerServiceEntity. - The URI for futures requests to the component. + Sets the disconnected_node_acknowledged of this ControllerServiceEntity. + Acknowledges that this node is disconnected to allow for mutable requests to proceed. - :param uri: The uri of this ControllerServiceEntity. - :type: str + :param disconnected_node_acknowledged: The disconnected_node_acknowledged of this ControllerServiceEntity. + :type: bool """ - self._uri = uri + self._disconnected_node_acknowledged = disconnected_node_acknowledged @property - def position(self): + def id(self): """ - Gets the position of this ControllerServiceEntity. - The position of this component in the UI if applicable. + Gets the id of this ControllerServiceEntity. + The id of the component. - :return: The position of this ControllerServiceEntity. - :rtype: PositionDTO + :return: The id of this ControllerServiceEntity. + :rtype: str """ - return self._position + return self._id - @position.setter - def position(self, position): + @id.setter + def id(self, id): """ - Sets the position of this ControllerServiceEntity. - The position of this component in the UI if applicable. + Sets the id of this ControllerServiceEntity. + The id of the component. - :param position: The position of this ControllerServiceEntity. - :type: PositionDTO + :param id: The id of this ControllerServiceEntity. + :type: str """ - self._position = position + self._id = id @property - def permissions(self): + def operate_permissions(self): """ - Gets the permissions of this ControllerServiceEntity. - The permissions for this component. + Gets the operate_permissions of this ControllerServiceEntity. - :return: The permissions of this ControllerServiceEntity. + :return: The operate_permissions of this ControllerServiceEntity. :rtype: PermissionsDTO """ - return self._permissions + return self._operate_permissions - @permissions.setter - def permissions(self, permissions): + @operate_permissions.setter + def operate_permissions(self, operate_permissions): """ - Sets the permissions of this ControllerServiceEntity. - The permissions for this component. + Sets the operate_permissions of this ControllerServiceEntity. - :param permissions: The permissions of this ControllerServiceEntity. + :param operate_permissions: The operate_permissions of this ControllerServiceEntity. :type: PermissionsDTO """ - self._permissions = permissions - - @property - def bulletins(self): - """ - Gets the bulletins of this ControllerServiceEntity. - The bulletins for this component. - - :return: The bulletins of this ControllerServiceEntity. - :rtype: list[BulletinEntity] - """ - return self._bulletins - - @bulletins.setter - def bulletins(self, bulletins): - """ - Sets the bulletins of this ControllerServiceEntity. - The bulletins for this component. - - :param bulletins: The bulletins of this ControllerServiceEntity. - :type: list[BulletinEntity] - """ - - self._bulletins = bulletins - - @property - def disconnected_node_acknowledged(self): - """ - Gets the disconnected_node_acknowledged of this ControllerServiceEntity. - Acknowledges that this node is disconnected to allow for mutable requests to proceed. - - :return: The disconnected_node_acknowledged of this ControllerServiceEntity. - :rtype: bool - """ - return self._disconnected_node_acknowledged - - @disconnected_node_acknowledged.setter - def disconnected_node_acknowledged(self, disconnected_node_acknowledged): - """ - Sets the disconnected_node_acknowledged of this ControllerServiceEntity. - Acknowledges that this node is disconnected to allow for mutable requests to proceed. - - :param disconnected_node_acknowledged: The disconnected_node_acknowledged of this ControllerServiceEntity. - :type: bool - """ - - self._disconnected_node_acknowledged = disconnected_node_acknowledged + self._operate_permissions = operate_permissions @property def parent_group_id(self): @@ -280,54 +227,72 @@ def parent_group_id(self, parent_group_id): self._parent_group_id = parent_group_id @property - def component(self): + def permissions(self): """ - Gets the component of this ControllerServiceEntity. + Gets the permissions of this ControllerServiceEntity. - :return: The component of this ControllerServiceEntity. - :rtype: ControllerServiceDTO + :return: The permissions of this ControllerServiceEntity. + :rtype: PermissionsDTO """ - return self._component + return self._permissions - @component.setter - def component(self, component): + @permissions.setter + def permissions(self, permissions): """ - Sets the component of this ControllerServiceEntity. + Sets the permissions of this ControllerServiceEntity. - :param component: The component of this ControllerServiceEntity. - :type: ControllerServiceDTO + :param permissions: The permissions of this ControllerServiceEntity. + :type: PermissionsDTO """ - self._component = component + self._permissions = permissions @property - def operate_permissions(self): + def position(self): """ - Gets the operate_permissions of this ControllerServiceEntity. - The permissions for this component operations. + Gets the position of this ControllerServiceEntity. - :return: The operate_permissions of this ControllerServiceEntity. - :rtype: PermissionsDTO + :return: The position of this ControllerServiceEntity. + :rtype: PositionDTO """ - return self._operate_permissions + return self._position - @operate_permissions.setter - def operate_permissions(self, operate_permissions): + @position.setter + def position(self, position): """ - Sets the operate_permissions of this ControllerServiceEntity. - The permissions for this component operations. + Sets the position of this ControllerServiceEntity. - :param operate_permissions: The operate_permissions of this ControllerServiceEntity. - :type: PermissionsDTO + :param position: The position of this ControllerServiceEntity. + :type: PositionDTO """ - self._operate_permissions = operate_permissions + self._position = position + + @property + def revision(self): + """ + Gets the revision of this ControllerServiceEntity. + + :return: The revision of this ControllerServiceEntity. + :rtype: RevisionDTO + """ + return self._revision + + @revision.setter + def revision(self, revision): + """ + Sets the revision of this ControllerServiceEntity. + + :param revision: The revision of this ControllerServiceEntity. + :type: RevisionDTO + """ + + self._revision = revision @property def status(self): """ Gets the status of this ControllerServiceEntity. - The status for this ControllerService. :return: The status of this ControllerServiceEntity. :rtype: ControllerServiceStatusDTO @@ -338,7 +303,6 @@ def status(self): def status(self, status): """ Sets the status of this ControllerServiceEntity. - The status for this ControllerService. :param status: The status of this ControllerServiceEntity. :type: ControllerServiceStatusDTO @@ -346,6 +310,29 @@ def status(self, status): self._status = status + @property + def uri(self): + """ + Gets the uri of this ControllerServiceEntity. + The URI for futures requests to the component. + + :return: The uri of this ControllerServiceEntity. + :rtype: str + """ + return self._uri + + @uri.setter + def uri(self, uri): + """ + Sets the uri of this ControllerServiceEntity. + The URI for futures requests to the component. + + :param uri: The uri of this ControllerServiceEntity. + :type: str + """ + + self._uri = uri + def to_dict(self): """ Returns the model properties as a dict diff --git a/nipyapi/nifi/models/controller_service_referencing_component_dto.py b/nipyapi/nifi/models/controller_service_referencing_component_dto.py index 4ecadc97..57976841 100644 --- a/nipyapi/nifi/models/controller_service_referencing_component_dto.py +++ b/nipyapi/nifi/models/controller_service_referencing_component_dto.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,77 +27,121 @@ class ControllerServiceReferencingComponentDTO(object): and the value is json key in definition. """ swagger_types = { - 'group_id': 'str', - 'id': 'str', - 'name': 'str', - 'type': 'str', - 'state': 'str', - 'properties': 'dict(str, str)', - 'descriptors': 'dict(str, PropertyDescriptorDTO)', - 'validation_errors': 'list[str]', - 'reference_type': 'str', 'active_thread_count': 'int', - 'reference_cycle': 'bool', - 'referencing_components': 'list[ControllerServiceReferencingComponentEntity]' - } +'descriptors': 'dict(str, PropertyDescriptorDTO)', +'group_id': 'str', +'id': 'str', +'name': 'str', +'properties': 'dict(str, str)', +'reference_cycle': 'bool', +'reference_type': 'str', +'referencing_components': 'list[ControllerServiceReferencingComponentEntity]', +'state': 'str', +'type': 'str', +'validation_errors': 'list[str]' } attribute_map = { - 'group_id': 'groupId', - 'id': 'id', - 'name': 'name', - 'type': 'type', - 'state': 'state', - 'properties': 'properties', - 'descriptors': 'descriptors', - 'validation_errors': 'validationErrors', - 'reference_type': 'referenceType', 'active_thread_count': 'activeThreadCount', - 'reference_cycle': 'referenceCycle', - 'referencing_components': 'referencingComponents' - } - - def __init__(self, group_id=None, id=None, name=None, type=None, state=None, properties=None, descriptors=None, validation_errors=None, reference_type=None, active_thread_count=None, reference_cycle=None, referencing_components=None): +'descriptors': 'descriptors', +'group_id': 'groupId', +'id': 'id', +'name': 'name', +'properties': 'properties', +'reference_cycle': 'referenceCycle', +'reference_type': 'referenceType', +'referencing_components': 'referencingComponents', +'state': 'state', +'type': 'type', +'validation_errors': 'validationErrors' } + + def __init__(self, active_thread_count=None, descriptors=None, group_id=None, id=None, name=None, properties=None, reference_cycle=None, reference_type=None, referencing_components=None, state=None, type=None, validation_errors=None): """ ControllerServiceReferencingComponentDTO - a model defined in Swagger """ + self._active_thread_count = None + self._descriptors = None self._group_id = None self._id = None self._name = None - self._type = None - self._state = None self._properties = None - self._descriptors = None - self._validation_errors = None - self._reference_type = None - self._active_thread_count = None self._reference_cycle = None + self._reference_type = None self._referencing_components = None + self._state = None + self._type = None + self._validation_errors = None + if active_thread_count is not None: + self.active_thread_count = active_thread_count + if descriptors is not None: + self.descriptors = descriptors if group_id is not None: self.group_id = group_id if id is not None: self.id = id if name is not None: self.name = name - if type is not None: - self.type = type - if state is not None: - self.state = state if properties is not None: self.properties = properties - if descriptors is not None: - self.descriptors = descriptors - if validation_errors is not None: - self.validation_errors = validation_errors - if reference_type is not None: - self.reference_type = reference_type - if active_thread_count is not None: - self.active_thread_count = active_thread_count if reference_cycle is not None: self.reference_cycle = reference_cycle + if reference_type is not None: + self.reference_type = reference_type if referencing_components is not None: self.referencing_components = referencing_components + if state is not None: + self.state = state + if type is not None: + self.type = type + if validation_errors is not None: + self.validation_errors = validation_errors + + @property + def active_thread_count(self): + """ + Gets the active_thread_count of this ControllerServiceReferencingComponentDTO. + The number of active threads for the referencing component. + + :return: The active_thread_count of this ControllerServiceReferencingComponentDTO. + :rtype: int + """ + return self._active_thread_count + + @active_thread_count.setter + def active_thread_count(self, active_thread_count): + """ + Sets the active_thread_count of this ControllerServiceReferencingComponentDTO. + The number of active threads for the referencing component. + + :param active_thread_count: The active_thread_count of this ControllerServiceReferencingComponentDTO. + :type: int + """ + + self._active_thread_count = active_thread_count + + @property + def descriptors(self): + """ + Gets the descriptors of this ControllerServiceReferencingComponentDTO. + The descriptors for the component properties. + + :return: The descriptors of this ControllerServiceReferencingComponentDTO. + :rtype: dict(str, PropertyDescriptorDTO) + """ + return self._descriptors + + @descriptors.setter + def descriptors(self, descriptors): + """ + Sets the descriptors of this ControllerServiceReferencingComponentDTO. + The descriptors for the component properties. + + :param descriptors: The descriptors of this ControllerServiceReferencingComponentDTO. + :type: dict(str, PropertyDescriptorDTO) + """ + + self._descriptors = descriptors @property def group_id(self): @@ -169,52 +212,6 @@ def name(self, name): self._name = name - @property - def type(self): - """ - Gets the type of this ControllerServiceReferencingComponentDTO. - The type of the component referencing a controller service in simple Java class name format without package name. - - :return: The type of this ControllerServiceReferencingComponentDTO. - :rtype: str - """ - return self._type - - @type.setter - def type(self, type): - """ - Sets the type of this ControllerServiceReferencingComponentDTO. - The type of the component referencing a controller service in simple Java class name format without package name. - - :param type: The type of this ControllerServiceReferencingComponentDTO. - :type: str - """ - - self._type = type - - @property - def state(self): - """ - Gets the state of this ControllerServiceReferencingComponentDTO. - The scheduled state of a processor or reporting task referencing a controller service. If this component is another controller service, this field represents the controller service state. - - :return: The state of this ControllerServiceReferencingComponentDTO. - :rtype: str - """ - return self._state - - @state.setter - def state(self, state): - """ - Sets the state of this ControllerServiceReferencingComponentDTO. - The scheduled state of a processor or reporting task referencing a controller service. If this component is another controller service, this field represents the controller service state. - - :param state: The state of this ControllerServiceReferencingComponentDTO. - :type: str - """ - - self._state = state - @property def properties(self): """ @@ -239,50 +236,27 @@ def properties(self, properties): self._properties = properties @property - def descriptors(self): - """ - Gets the descriptors of this ControllerServiceReferencingComponentDTO. - The descriptors for the component properties. - - :return: The descriptors of this ControllerServiceReferencingComponentDTO. - :rtype: dict(str, PropertyDescriptorDTO) - """ - return self._descriptors - - @descriptors.setter - def descriptors(self, descriptors): - """ - Sets the descriptors of this ControllerServiceReferencingComponentDTO. - The descriptors for the component properties. - - :param descriptors: The descriptors of this ControllerServiceReferencingComponentDTO. - :type: dict(str, PropertyDescriptorDTO) - """ - - self._descriptors = descriptors - - @property - def validation_errors(self): + def reference_cycle(self): """ - Gets the validation_errors of this ControllerServiceReferencingComponentDTO. - The validation errors for the component. + Gets the reference_cycle of this ControllerServiceReferencingComponentDTO. + If the referencing component represents a controller service, this indicates whether it has already been represented in this hierarchy. - :return: The validation_errors of this ControllerServiceReferencingComponentDTO. - :rtype: list[str] + :return: The reference_cycle of this ControllerServiceReferencingComponentDTO. + :rtype: bool """ - return self._validation_errors + return self._reference_cycle - @validation_errors.setter - def validation_errors(self, validation_errors): + @reference_cycle.setter + def reference_cycle(self, reference_cycle): """ - Sets the validation_errors of this ControllerServiceReferencingComponentDTO. - The validation errors for the component. + Sets the reference_cycle of this ControllerServiceReferencingComponentDTO. + If the referencing component represents a controller service, this indicates whether it has already been represented in this hierarchy. - :param validation_errors: The validation_errors of this ControllerServiceReferencingComponentDTO. - :type: list[str] + :param reference_cycle: The reference_cycle of this ControllerServiceReferencingComponentDTO. + :type: bool """ - self._validation_errors = validation_errors + self._reference_cycle = reference_cycle @property def reference_type(self): @@ -304,7 +278,7 @@ def reference_type(self, reference_type): :param reference_type: The reference_type of this ControllerServiceReferencingComponentDTO. :type: str """ - allowed_values = ["Processor", "ControllerService", "ReportingTask", "FlowRegistryClient"] + allowed_values = ["Processor", "ControllerService", "ReportingTask", "FlowRegistryClient", ] if reference_type not in allowed_values: raise ValueError( "Invalid value for `reference_type` ({0}), must be one of {1}" @@ -314,73 +288,96 @@ def reference_type(self, reference_type): self._reference_type = reference_type @property - def active_thread_count(self): + def referencing_components(self): """ - Gets the active_thread_count of this ControllerServiceReferencingComponentDTO. - The number of active threads for the referencing component. + Gets the referencing_components of this ControllerServiceReferencingComponentDTO. + If the referencing component represents a controller service, these are the components that reference it. - :return: The active_thread_count of this ControllerServiceReferencingComponentDTO. - :rtype: int + :return: The referencing_components of this ControllerServiceReferencingComponentDTO. + :rtype: list[ControllerServiceReferencingComponentEntity] """ - return self._active_thread_count + return self._referencing_components - @active_thread_count.setter - def active_thread_count(self, active_thread_count): + @referencing_components.setter + def referencing_components(self, referencing_components): """ - Sets the active_thread_count of this ControllerServiceReferencingComponentDTO. - The number of active threads for the referencing component. + Sets the referencing_components of this ControllerServiceReferencingComponentDTO. + If the referencing component represents a controller service, these are the components that reference it. - :param active_thread_count: The active_thread_count of this ControllerServiceReferencingComponentDTO. - :type: int + :param referencing_components: The referencing_components of this ControllerServiceReferencingComponentDTO. + :type: list[ControllerServiceReferencingComponentEntity] """ - self._active_thread_count = active_thread_count + self._referencing_components = referencing_components @property - def reference_cycle(self): + def state(self): """ - Gets the reference_cycle of this ControllerServiceReferencingComponentDTO. - If the referencing component represents a controller service, this indicates whether it has already been represented in this hierarchy. + Gets the state of this ControllerServiceReferencingComponentDTO. + The scheduled state of a processor or reporting task referencing a controller service. If this component is another controller service, this field represents the controller service state. - :return: The reference_cycle of this ControllerServiceReferencingComponentDTO. - :rtype: bool + :return: The state of this ControllerServiceReferencingComponentDTO. + :rtype: str """ - return self._reference_cycle + return self._state - @reference_cycle.setter - def reference_cycle(self, reference_cycle): + @state.setter + def state(self, state): """ - Sets the reference_cycle of this ControllerServiceReferencingComponentDTO. - If the referencing component represents a controller service, this indicates whether it has already been represented in this hierarchy. + Sets the state of this ControllerServiceReferencingComponentDTO. + The scheduled state of a processor or reporting task referencing a controller service. If this component is another controller service, this field represents the controller service state. - :param reference_cycle: The reference_cycle of this ControllerServiceReferencingComponentDTO. - :type: bool + :param state: The state of this ControllerServiceReferencingComponentDTO. + :type: str """ - self._reference_cycle = reference_cycle + self._state = state @property - def referencing_components(self): + def type(self): """ - Gets the referencing_components of this ControllerServiceReferencingComponentDTO. - If the referencing component represents a controller service, these are the components that reference it. + Gets the type of this ControllerServiceReferencingComponentDTO. + The type of the component referencing a controller service in simple Java class name format without package name. - :return: The referencing_components of this ControllerServiceReferencingComponentDTO. - :rtype: list[ControllerServiceReferencingComponentEntity] + :return: The type of this ControllerServiceReferencingComponentDTO. + :rtype: str """ - return self._referencing_components + return self._type - @referencing_components.setter - def referencing_components(self, referencing_components): + @type.setter + def type(self, type): """ - Sets the referencing_components of this ControllerServiceReferencingComponentDTO. - If the referencing component represents a controller service, these are the components that reference it. + Sets the type of this ControllerServiceReferencingComponentDTO. + The type of the component referencing a controller service in simple Java class name format without package name. - :param referencing_components: The referencing_components of this ControllerServiceReferencingComponentDTO. - :type: list[ControllerServiceReferencingComponentEntity] + :param type: The type of this ControllerServiceReferencingComponentDTO. + :type: str """ - self._referencing_components = referencing_components + self._type = type + + @property + def validation_errors(self): + """ + Gets the validation_errors of this ControllerServiceReferencingComponentDTO. + The validation errors for the component. + + :return: The validation_errors of this ControllerServiceReferencingComponentDTO. + :rtype: list[str] + """ + return self._validation_errors + + @validation_errors.setter + def validation_errors(self, validation_errors): + """ + Sets the validation_errors of this ControllerServiceReferencingComponentDTO. + The validation errors for the component. + + :param validation_errors: The validation_errors of this ControllerServiceReferencingComponentDTO. + :type: list[str] + """ + + self._validation_errors = validation_errors def to_dict(self): """ diff --git a/nipyapi/nifi/models/controller_service_referencing_component_entity.py b/nipyapi/nifi/models/controller_service_referencing_component_entity.py index 355f225d..115d1358 100644 --- a/nipyapi/nifi/models/controller_service_referencing_component_entity.py +++ b/nipyapi/nifi/models/controller_service_referencing_component_entity.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,85 +27,127 @@ class ControllerServiceReferencingComponentEntity(object): and the value is json key in definition. """ swagger_types = { - 'revision': 'RevisionDTO', - 'id': 'str', - 'uri': 'str', - 'position': 'PositionDTO', - 'permissions': 'PermissionsDTO', 'bulletins': 'list[BulletinEntity]', - 'disconnected_node_acknowledged': 'bool', - 'component': 'ControllerServiceReferencingComponentDTO', - 'operate_permissions': 'PermissionsDTO' - } +'component': 'ControllerServiceReferencingComponentDTO', +'disconnected_node_acknowledged': 'bool', +'id': 'str', +'operate_permissions': 'PermissionsDTO', +'permissions': 'PermissionsDTO', +'position': 'PositionDTO', +'revision': 'RevisionDTO', +'uri': 'str' } attribute_map = { - 'revision': 'revision', - 'id': 'id', - 'uri': 'uri', - 'position': 'position', - 'permissions': 'permissions', 'bulletins': 'bulletins', - 'disconnected_node_acknowledged': 'disconnectedNodeAcknowledged', - 'component': 'component', - 'operate_permissions': 'operatePermissions' - } +'component': 'component', +'disconnected_node_acknowledged': 'disconnectedNodeAcknowledged', +'id': 'id', +'operate_permissions': 'operatePermissions', +'permissions': 'permissions', +'position': 'position', +'revision': 'revision', +'uri': 'uri' } - def __init__(self, revision=None, id=None, uri=None, position=None, permissions=None, bulletins=None, disconnected_node_acknowledged=None, component=None, operate_permissions=None): + def __init__(self, bulletins=None, component=None, disconnected_node_acknowledged=None, id=None, operate_permissions=None, permissions=None, position=None, revision=None, uri=None): """ ControllerServiceReferencingComponentEntity - a model defined in Swagger """ - self._revision = None - self._id = None - self._uri = None - self._position = None - self._permissions = None self._bulletins = None - self._disconnected_node_acknowledged = None self._component = None + self._disconnected_node_acknowledged = None + self._id = None self._operate_permissions = None + self._permissions = None + self._position = None + self._revision = None + self._uri = None - if revision is not None: - self.revision = revision - if id is not None: - self.id = id - if uri is not None: - self.uri = uri - if position is not None: - self.position = position - if permissions is not None: - self.permissions = permissions if bulletins is not None: self.bulletins = bulletins - if disconnected_node_acknowledged is not None: - self.disconnected_node_acknowledged = disconnected_node_acknowledged if component is not None: self.component = component + if disconnected_node_acknowledged is not None: + self.disconnected_node_acknowledged = disconnected_node_acknowledged + if id is not None: + self.id = id if operate_permissions is not None: self.operate_permissions = operate_permissions + if permissions is not None: + self.permissions = permissions + if position is not None: + self.position = position + if revision is not None: + self.revision = revision + if uri is not None: + self.uri = uri @property - def revision(self): + def bulletins(self): """ - Gets the revision of this ControllerServiceReferencingComponentEntity. - The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses. + Gets the bulletins of this ControllerServiceReferencingComponentEntity. + The bulletins for this component. - :return: The revision of this ControllerServiceReferencingComponentEntity. - :rtype: RevisionDTO + :return: The bulletins of this ControllerServiceReferencingComponentEntity. + :rtype: list[BulletinEntity] """ - return self._revision + return self._bulletins - @revision.setter - def revision(self, revision): + @bulletins.setter + def bulletins(self, bulletins): """ - Sets the revision of this ControllerServiceReferencingComponentEntity. - The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses. + Sets the bulletins of this ControllerServiceReferencingComponentEntity. + The bulletins for this component. - :param revision: The revision of this ControllerServiceReferencingComponentEntity. - :type: RevisionDTO + :param bulletins: The bulletins of this ControllerServiceReferencingComponentEntity. + :type: list[BulletinEntity] """ - self._revision = revision + self._bulletins = bulletins + + @property + def component(self): + """ + Gets the component of this ControllerServiceReferencingComponentEntity. + + :return: The component of this ControllerServiceReferencingComponentEntity. + :rtype: ControllerServiceReferencingComponentDTO + """ + return self._component + + @component.setter + def component(self, component): + """ + Sets the component of this ControllerServiceReferencingComponentEntity. + + :param component: The component of this ControllerServiceReferencingComponentEntity. + :type: ControllerServiceReferencingComponentDTO + """ + + self._component = component + + @property + def disconnected_node_acknowledged(self): + """ + Gets the disconnected_node_acknowledged of this ControllerServiceReferencingComponentEntity. + Acknowledges that this node is disconnected to allow for mutable requests to proceed. + + :return: The disconnected_node_acknowledged of this ControllerServiceReferencingComponentEntity. + :rtype: bool + """ + return self._disconnected_node_acknowledged + + @disconnected_node_acknowledged.setter + def disconnected_node_acknowledged(self, disconnected_node_acknowledged): + """ + Sets the disconnected_node_acknowledged of this ControllerServiceReferencingComponentEntity. + Acknowledges that this node is disconnected to allow for mutable requests to proceed. + + :param disconnected_node_acknowledged: The disconnected_node_acknowledged of this ControllerServiceReferencingComponentEntity. + :type: bool + """ + + self._disconnected_node_acknowledged = disconnected_node_acknowledged @property def id(self): @@ -132,56 +173,30 @@ def id(self, id): self._id = id @property - def uri(self): - """ - Gets the uri of this ControllerServiceReferencingComponentEntity. - The URI for futures requests to the component. - - :return: The uri of this ControllerServiceReferencingComponentEntity. - :rtype: str - """ - return self._uri - - @uri.setter - def uri(self, uri): - """ - Sets the uri of this ControllerServiceReferencingComponentEntity. - The URI for futures requests to the component. - - :param uri: The uri of this ControllerServiceReferencingComponentEntity. - :type: str - """ - - self._uri = uri - - @property - def position(self): + def operate_permissions(self): """ - Gets the position of this ControllerServiceReferencingComponentEntity. - The position of this component in the UI if applicable. + Gets the operate_permissions of this ControllerServiceReferencingComponentEntity. - :return: The position of this ControllerServiceReferencingComponentEntity. - :rtype: PositionDTO + :return: The operate_permissions of this ControllerServiceReferencingComponentEntity. + :rtype: PermissionsDTO """ - return self._position + return self._operate_permissions - @position.setter - def position(self, position): + @operate_permissions.setter + def operate_permissions(self, operate_permissions): """ - Sets the position of this ControllerServiceReferencingComponentEntity. - The position of this component in the UI if applicable. + Sets the operate_permissions of this ControllerServiceReferencingComponentEntity. - :param position: The position of this ControllerServiceReferencingComponentEntity. - :type: PositionDTO + :param operate_permissions: The operate_permissions of this ControllerServiceReferencingComponentEntity. + :type: PermissionsDTO """ - self._position = position + self._operate_permissions = operate_permissions @property def permissions(self): """ Gets the permissions of this ControllerServiceReferencingComponentEntity. - The permissions for this component. :return: The permissions of this ControllerServiceReferencingComponentEntity. :rtype: PermissionsDTO @@ -192,7 +207,6 @@ def permissions(self): def permissions(self, permissions): """ Sets the permissions of this ControllerServiceReferencingComponentEntity. - The permissions for this component. :param permissions: The permissions of this ControllerServiceReferencingComponentEntity. :type: PermissionsDTO @@ -201,94 +215,69 @@ def permissions(self, permissions): self._permissions = permissions @property - def bulletins(self): - """ - Gets the bulletins of this ControllerServiceReferencingComponentEntity. - The bulletins for this component. - - :return: The bulletins of this ControllerServiceReferencingComponentEntity. - :rtype: list[BulletinEntity] - """ - return self._bulletins - - @bulletins.setter - def bulletins(self, bulletins): - """ - Sets the bulletins of this ControllerServiceReferencingComponentEntity. - The bulletins for this component. - - :param bulletins: The bulletins of this ControllerServiceReferencingComponentEntity. - :type: list[BulletinEntity] - """ - - self._bulletins = bulletins - - @property - def disconnected_node_acknowledged(self): + def position(self): """ - Gets the disconnected_node_acknowledged of this ControllerServiceReferencingComponentEntity. - Acknowledges that this node is disconnected to allow for mutable requests to proceed. + Gets the position of this ControllerServiceReferencingComponentEntity. - :return: The disconnected_node_acknowledged of this ControllerServiceReferencingComponentEntity. - :rtype: bool + :return: The position of this ControllerServiceReferencingComponentEntity. + :rtype: PositionDTO """ - return self._disconnected_node_acknowledged + return self._position - @disconnected_node_acknowledged.setter - def disconnected_node_acknowledged(self, disconnected_node_acknowledged): + @position.setter + def position(self, position): """ - Sets the disconnected_node_acknowledged of this ControllerServiceReferencingComponentEntity. - Acknowledges that this node is disconnected to allow for mutable requests to proceed. + Sets the position of this ControllerServiceReferencingComponentEntity. - :param disconnected_node_acknowledged: The disconnected_node_acknowledged of this ControllerServiceReferencingComponentEntity. - :type: bool + :param position: The position of this ControllerServiceReferencingComponentEntity. + :type: PositionDTO """ - self._disconnected_node_acknowledged = disconnected_node_acknowledged + self._position = position @property - def component(self): + def revision(self): """ - Gets the component of this ControllerServiceReferencingComponentEntity. + Gets the revision of this ControllerServiceReferencingComponentEntity. - :return: The component of this ControllerServiceReferencingComponentEntity. - :rtype: ControllerServiceReferencingComponentDTO + :return: The revision of this ControllerServiceReferencingComponentEntity. + :rtype: RevisionDTO """ - return self._component + return self._revision - @component.setter - def component(self, component): + @revision.setter + def revision(self, revision): """ - Sets the component of this ControllerServiceReferencingComponentEntity. + Sets the revision of this ControllerServiceReferencingComponentEntity. - :param component: The component of this ControllerServiceReferencingComponentEntity. - :type: ControllerServiceReferencingComponentDTO + :param revision: The revision of this ControllerServiceReferencingComponentEntity. + :type: RevisionDTO """ - self._component = component + self._revision = revision @property - def operate_permissions(self): + def uri(self): """ - Gets the operate_permissions of this ControllerServiceReferencingComponentEntity. - The permissions for this component operations. + Gets the uri of this ControllerServiceReferencingComponentEntity. + The URI for futures requests to the component. - :return: The operate_permissions of this ControllerServiceReferencingComponentEntity. - :rtype: PermissionsDTO + :return: The uri of this ControllerServiceReferencingComponentEntity. + :rtype: str """ - return self._operate_permissions + return self._uri - @operate_permissions.setter - def operate_permissions(self, operate_permissions): + @uri.setter + def uri(self, uri): """ - Sets the operate_permissions of this ControllerServiceReferencingComponentEntity. - The permissions for this component operations. + Sets the uri of this ControllerServiceReferencingComponentEntity. + The URI for futures requests to the component. - :param operate_permissions: The operate_permissions of this ControllerServiceReferencingComponentEntity. - :type: PermissionsDTO + :param uri: The uri of this ControllerServiceReferencingComponentEntity. + :type: str """ - self._operate_permissions = operate_permissions + self._uri = uri def to_dict(self): """ diff --git a/nipyapi/nifi/models/controller_service_referencing_components_entity.py b/nipyapi/nifi/models/controller_service_referencing_components_entity.py index cdc5c7a6..dd439e27 100644 --- a/nipyapi/nifi/models/controller_service_referencing_components_entity.py +++ b/nipyapi/nifi/models/controller_service_referencing_components_entity.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,12 +27,10 @@ class ControllerServiceReferencingComponentsEntity(object): and the value is json key in definition. """ swagger_types = { - 'controller_service_referencing_components': 'list[ControllerServiceReferencingComponentEntity]' - } + 'controller_service_referencing_components': 'list[ControllerServiceReferencingComponentEntity]' } attribute_map = { - 'controller_service_referencing_components': 'controllerServiceReferencingComponents' - } + 'controller_service_referencing_components': 'controllerServiceReferencingComponents' } def __init__(self, controller_service_referencing_components=None): """ diff --git a/nipyapi/nifi/models/controller_service_run_status_entity.py b/nipyapi/nifi/models/controller_service_run_status_entity.py index e36ca6c6..0e00625f 100644 --- a/nipyapi/nifi/models/controller_service_run_status_entity.py +++ b/nipyapi/nifi/models/controller_service_run_status_entity.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,43 +27,63 @@ class ControllerServiceRunStatusEntity(object): and the value is json key in definition. """ swagger_types = { - 'revision': 'RevisionDTO', - 'state': 'str', 'disconnected_node_acknowledged': 'bool', - 'ui_only': 'bool' - } +'revision': 'RevisionDTO', +'state': 'str', +'ui_only': 'bool' } attribute_map = { - 'revision': 'revision', - 'state': 'state', 'disconnected_node_acknowledged': 'disconnectedNodeAcknowledged', - 'ui_only': 'uiOnly' - } +'revision': 'revision', +'state': 'state', +'ui_only': 'uiOnly' } - def __init__(self, revision=None, state=None, disconnected_node_acknowledged=None, ui_only=None): + def __init__(self, disconnected_node_acknowledged=None, revision=None, state=None, ui_only=None): """ ControllerServiceRunStatusEntity - a model defined in Swagger """ + self._disconnected_node_acknowledged = None self._revision = None self._state = None - self._disconnected_node_acknowledged = None self._ui_only = None + if disconnected_node_acknowledged is not None: + self.disconnected_node_acknowledged = disconnected_node_acknowledged if revision is not None: self.revision = revision if state is not None: self.state = state - if disconnected_node_acknowledged is not None: - self.disconnected_node_acknowledged = disconnected_node_acknowledged if ui_only is not None: self.ui_only = ui_only + @property + def disconnected_node_acknowledged(self): + """ + Gets the disconnected_node_acknowledged of this ControllerServiceRunStatusEntity. + Acknowledges that this node is disconnected to allow for mutable requests to proceed. + + :return: The disconnected_node_acknowledged of this ControllerServiceRunStatusEntity. + :rtype: bool + """ + return self._disconnected_node_acknowledged + + @disconnected_node_acknowledged.setter + def disconnected_node_acknowledged(self, disconnected_node_acknowledged): + """ + Sets the disconnected_node_acknowledged of this ControllerServiceRunStatusEntity. + Acknowledges that this node is disconnected to allow for mutable requests to proceed. + + :param disconnected_node_acknowledged: The disconnected_node_acknowledged of this ControllerServiceRunStatusEntity. + :type: bool + """ + + self._disconnected_node_acknowledged = disconnected_node_acknowledged + @property def revision(self): """ Gets the revision of this ControllerServiceRunStatusEntity. - The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses. :return: The revision of this ControllerServiceRunStatusEntity. :rtype: RevisionDTO @@ -75,7 +94,6 @@ def revision(self): def revision(self, revision): """ Sets the revision of this ControllerServiceRunStatusEntity. - The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses. :param revision: The revision of this ControllerServiceRunStatusEntity. :type: RevisionDTO @@ -103,7 +121,7 @@ def state(self, state): :param state: The state of this ControllerServiceRunStatusEntity. :type: str """ - allowed_values = ["ENABLED", "DISABLED"] + allowed_values = ["ENABLED", "DISABLED", ] if state not in allowed_values: raise ValueError( "Invalid value for `state` ({0}), must be one of {1}" @@ -112,34 +130,11 @@ def state(self, state): self._state = state - @property - def disconnected_node_acknowledged(self): - """ - Gets the disconnected_node_acknowledged of this ControllerServiceRunStatusEntity. - Acknowledges that this node is disconnected to allow for mutable requests to proceed. - - :return: The disconnected_node_acknowledged of this ControllerServiceRunStatusEntity. - :rtype: bool - """ - return self._disconnected_node_acknowledged - - @disconnected_node_acknowledged.setter - def disconnected_node_acknowledged(self, disconnected_node_acknowledged): - """ - Sets the disconnected_node_acknowledged of this ControllerServiceRunStatusEntity. - Acknowledges that this node is disconnected to allow for mutable requests to proceed. - - :param disconnected_node_acknowledged: The disconnected_node_acknowledged of this ControllerServiceRunStatusEntity. - :type: bool - """ - - self._disconnected_node_acknowledged = disconnected_node_acknowledged - @property def ui_only(self): """ Gets the ui_only of this ControllerServiceRunStatusEntity. - Indicates whether or not responses should only include fields necessary for rendering the NiFi User Interface. As such, when this value is set to true, some fields may be returned as null values, and the selected fields may change at any time without notice. As a result, this value should not be set to true by any client other than the UI. + Indicates whether or not responses should only include fields necessary for rendering the NiFi User Interface. As such, when this value is set to true, some fields may be returned as null values, and the selected fields may change at any time without notice. As a result, this value should not be set to true by any client other than the UI. :return: The ui_only of this ControllerServiceRunStatusEntity. :rtype: bool @@ -150,7 +145,7 @@ def ui_only(self): def ui_only(self, ui_only): """ Sets the ui_only of this ControllerServiceRunStatusEntity. - Indicates whether or not responses should only include fields necessary for rendering the NiFi User Interface. As such, when this value is set to true, some fields may be returned as null values, and the selected fields may change at any time without notice. As a result, this value should not be set to true by any client other than the UI. + Indicates whether or not responses should only include fields necessary for rendering the NiFi User Interface. As such, when this value is set to true, some fields may be returned as null values, and the selected fields may change at any time without notice. As a result, this value should not be set to true by any client other than the UI. :param ui_only: The ui_only of this ControllerServiceRunStatusEntity. :type: bool diff --git a/nipyapi/nifi/models/controller_service_status_dto.py b/nipyapi/nifi/models/controller_service_status_dto.py index c88dd634..87d63c4e 100644 --- a/nipyapi/nifi/models/controller_service_status_dto.py +++ b/nipyapi/nifi/models/controller_service_status_dto.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,32 +27,53 @@ class ControllerServiceStatusDTO(object): and the value is json key in definition. """ swagger_types = { - 'run_status': 'str', - 'validation_status': 'str', - 'active_thread_count': 'int' - } + 'active_thread_count': 'int', +'run_status': 'str', +'validation_status': 'str' } attribute_map = { - 'run_status': 'runStatus', - 'validation_status': 'validationStatus', - 'active_thread_count': 'activeThreadCount' - } + 'active_thread_count': 'activeThreadCount', +'run_status': 'runStatus', +'validation_status': 'validationStatus' } - def __init__(self, run_status=None, validation_status=None, active_thread_count=None): + def __init__(self, active_thread_count=None, run_status=None, validation_status=None): """ ControllerServiceStatusDTO - a model defined in Swagger """ + self._active_thread_count = None self._run_status = None self._validation_status = None - self._active_thread_count = None + if active_thread_count is not None: + self.active_thread_count = active_thread_count if run_status is not None: self.run_status = run_status if validation_status is not None: self.validation_status = validation_status - if active_thread_count is not None: - self.active_thread_count = active_thread_count + + @property + def active_thread_count(self): + """ + Gets the active_thread_count of this ControllerServiceStatusDTO. + The number of active threads for the component. + + :return: The active_thread_count of this ControllerServiceStatusDTO. + :rtype: int + """ + return self._active_thread_count + + @active_thread_count.setter + def active_thread_count(self, active_thread_count): + """ + Sets the active_thread_count of this ControllerServiceStatusDTO. + The number of active threads for the component. + + :param active_thread_count: The active_thread_count of this ControllerServiceStatusDTO. + :type: int + """ + + self._active_thread_count = active_thread_count @property def run_status(self): @@ -75,7 +95,7 @@ def run_status(self, run_status): :param run_status: The run_status of this ControllerServiceStatusDTO. :type: str """ - allowed_values = ["ENABLED", "ENABLING", "DISABLED", "DISABLING"] + 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}" @@ -104,7 +124,7 @@ def validation_status(self, validation_status): :param validation_status: The validation_status of this ControllerServiceStatusDTO. :type: str """ - allowed_values = ["VALID", "INVALID", "VALIDATING"] + 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}" @@ -113,29 +133,6 @@ def validation_status(self, validation_status): self._validation_status = validation_status - @property - def active_thread_count(self): - """ - Gets the active_thread_count of this ControllerServiceStatusDTO. - The number of active threads for the component. - - :return: The active_thread_count of this ControllerServiceStatusDTO. - :rtype: int - """ - return self._active_thread_count - - @active_thread_count.setter - def active_thread_count(self, active_thread_count): - """ - Sets the active_thread_count of this ControllerServiceStatusDTO. - The number of active threads for the component. - - :param active_thread_count: The active_thread_count of this ControllerServiceStatusDTO. - :type: int - """ - - self._active_thread_count = active_thread_count - def to_dict(self): """ Returns the model properties as a dict diff --git a/nipyapi/nifi/models/controller_service_types_entity.py b/nipyapi/nifi/models/controller_service_types_entity.py index 5abd66d1..273de014 100644 --- a/nipyapi/nifi/models/controller_service_types_entity.py +++ b/nipyapi/nifi/models/controller_service_types_entity.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,12 +27,10 @@ class ControllerServiceTypesEntity(object): and the value is json key in definition. """ swagger_types = { - 'controller_service_types': 'list[DocumentedTypeDTO]' - } + 'controller_service_types': 'list[DocumentedTypeDTO]' } attribute_map = { - 'controller_service_types': 'controllerServiceTypes' - } + 'controller_service_types': 'controllerServiceTypes' } def __init__(self, controller_service_types=None): """ diff --git a/nipyapi/nifi/models/controller_services_entity.py b/nipyapi/nifi/models/controller_services_entity.py index e4978de2..de229e5e 100644 --- a/nipyapi/nifi/models/controller_services_entity.py +++ b/nipyapi/nifi/models/controller_services_entity.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,27 +27,46 @@ class ControllerServicesEntity(object): and the value is json key in definition. """ swagger_types = { - 'current_time': 'str', - 'controller_services': 'list[ControllerServiceEntity]' - } + 'controller_services': 'list[ControllerServiceEntity]', +'current_time': 'str' } attribute_map = { - 'current_time': 'currentTime', - 'controller_services': 'controllerServices' - } + 'controller_services': 'controllerServices', +'current_time': 'currentTime' } - def __init__(self, current_time=None, controller_services=None): + def __init__(self, controller_services=None, current_time=None): """ ControllerServicesEntity - a model defined in Swagger """ - self._current_time = None self._controller_services = None + self._current_time = None - if current_time is not None: - self.current_time = current_time if controller_services is not None: self.controller_services = controller_services + if current_time is not None: + self.current_time = current_time + + @property + def controller_services(self): + """ + Gets the controller_services of this ControllerServicesEntity. + + :return: The controller_services of this ControllerServicesEntity. + :rtype: list[ControllerServiceEntity] + """ + return self._controller_services + + @controller_services.setter + def controller_services(self, controller_services): + """ + Sets the controller_services of this ControllerServicesEntity. + + :param controller_services: The controller_services of this ControllerServicesEntity. + :type: list[ControllerServiceEntity] + """ + + self._controller_services = controller_services @property def current_time(self): @@ -73,27 +91,6 @@ def current_time(self, current_time): self._current_time = current_time - @property - def controller_services(self): - """ - Gets the controller_services of this ControllerServicesEntity. - - :return: The controller_services of this ControllerServicesEntity. - :rtype: list[ControllerServiceEntity] - """ - return self._controller_services - - @controller_services.setter - def controller_services(self, controller_services): - """ - Sets the controller_services of this ControllerServicesEntity. - - :param controller_services: The controller_services of this ControllerServicesEntity. - :type: list[ControllerServiceEntity] - """ - - self._controller_services = controller_services - def to_dict(self): """ Returns the model properties as a dict diff --git a/nipyapi/nifi/models/controller_status_dto.py b/nipyapi/nifi/models/controller_status_dto.py index 02b3084d..17d12128 100644 --- a/nipyapi/nifi/models/controller_status_dto.py +++ b/nipyapi/nifi/models/controller_status_dto.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,97 +27,118 @@ class ControllerStatusDTO(object): and the value is json key in definition. """ swagger_types = { - 'active_thread_count': 'int', - 'terminated_thread_count': 'int', - 'queued': 'str', - 'flow_files_queued': 'int', - 'bytes_queued': 'int', - 'running_count': 'int', - 'stopped_count': 'int', - 'invalid_count': 'int', - 'disabled_count': 'int', 'active_remote_port_count': 'int', - 'inactive_remote_port_count': 'int', - 'up_to_date_count': 'int', - 'locally_modified_count': 'int', - 'stale_count': 'int', - 'locally_modified_and_stale_count': 'int', - 'sync_failure_count': 'int' - } +'active_thread_count': 'int', +'bytes_queued': 'int', +'disabled_count': 'int', +'flow_files_queued': 'int', +'inactive_remote_port_count': 'int', +'invalid_count': 'int', +'locally_modified_and_stale_count': 'int', +'locally_modified_count': 'int', +'queued': 'str', +'running_count': 'int', +'stale_count': 'int', +'stopped_count': 'int', +'sync_failure_count': 'int', +'terminated_thread_count': 'int', +'up_to_date_count': 'int' } attribute_map = { - 'active_thread_count': 'activeThreadCount', - 'terminated_thread_count': 'terminatedThreadCount', - 'queued': 'queued', - 'flow_files_queued': 'flowFilesQueued', - 'bytes_queued': 'bytesQueued', - 'running_count': 'runningCount', - 'stopped_count': 'stoppedCount', - 'invalid_count': 'invalidCount', - 'disabled_count': 'disabledCount', 'active_remote_port_count': 'activeRemotePortCount', - 'inactive_remote_port_count': 'inactiveRemotePortCount', - 'up_to_date_count': 'upToDateCount', - 'locally_modified_count': 'locallyModifiedCount', - 'stale_count': 'staleCount', - 'locally_modified_and_stale_count': 'locallyModifiedAndStaleCount', - 'sync_failure_count': 'syncFailureCount' - } - - def __init__(self, active_thread_count=None, terminated_thread_count=None, queued=None, flow_files_queued=None, bytes_queued=None, running_count=None, stopped_count=None, invalid_count=None, disabled_count=None, active_remote_port_count=None, inactive_remote_port_count=None, up_to_date_count=None, locally_modified_count=None, stale_count=None, locally_modified_and_stale_count=None, sync_failure_count=None): +'active_thread_count': 'activeThreadCount', +'bytes_queued': 'bytesQueued', +'disabled_count': 'disabledCount', +'flow_files_queued': 'flowFilesQueued', +'inactive_remote_port_count': 'inactiveRemotePortCount', +'invalid_count': 'invalidCount', +'locally_modified_and_stale_count': 'locallyModifiedAndStaleCount', +'locally_modified_count': 'locallyModifiedCount', +'queued': 'queued', +'running_count': 'runningCount', +'stale_count': 'staleCount', +'stopped_count': 'stoppedCount', +'sync_failure_count': 'syncFailureCount', +'terminated_thread_count': 'terminatedThreadCount', +'up_to_date_count': 'upToDateCount' } + + def __init__(self, active_remote_port_count=None, active_thread_count=None, bytes_queued=None, disabled_count=None, flow_files_queued=None, inactive_remote_port_count=None, invalid_count=None, locally_modified_and_stale_count=None, locally_modified_count=None, queued=None, running_count=None, stale_count=None, stopped_count=None, sync_failure_count=None, terminated_thread_count=None, up_to_date_count=None): """ ControllerStatusDTO - a model defined in Swagger """ + self._active_remote_port_count = None self._active_thread_count = None - self._terminated_thread_count = None - self._queued = None - self._flow_files_queued = None self._bytes_queued = None - self._running_count = None - self._stopped_count = None - self._invalid_count = None self._disabled_count = None - self._active_remote_port_count = None + self._flow_files_queued = None self._inactive_remote_port_count = None - self._up_to_date_count = None + self._invalid_count = None + self._locally_modified_and_stale_count = None self._locally_modified_count = None + self._queued = None + self._running_count = None self._stale_count = None - self._locally_modified_and_stale_count = None + self._stopped_count = None self._sync_failure_count = None + self._terminated_thread_count = None + self._up_to_date_count = None + if active_remote_port_count is not None: + self.active_remote_port_count = active_remote_port_count if active_thread_count is not None: self.active_thread_count = active_thread_count - if terminated_thread_count is not None: - self.terminated_thread_count = terminated_thread_count - if queued is not None: - self.queued = queued - if flow_files_queued is not None: - self.flow_files_queued = flow_files_queued if bytes_queued is not None: self.bytes_queued = bytes_queued - if running_count is not None: - self.running_count = running_count - if stopped_count is not None: - self.stopped_count = stopped_count - if invalid_count is not None: - self.invalid_count = invalid_count if disabled_count is not None: self.disabled_count = disabled_count - if active_remote_port_count is not None: - self.active_remote_port_count = active_remote_port_count + if flow_files_queued is not None: + self.flow_files_queued = flow_files_queued if inactive_remote_port_count is not None: self.inactive_remote_port_count = inactive_remote_port_count - if up_to_date_count is not None: - self.up_to_date_count = up_to_date_count + if invalid_count is not None: + self.invalid_count = invalid_count + if locally_modified_and_stale_count is not None: + self.locally_modified_and_stale_count = locally_modified_and_stale_count if locally_modified_count is not None: self.locally_modified_count = locally_modified_count + if queued is not None: + self.queued = queued + if running_count is not None: + self.running_count = running_count if stale_count is not None: self.stale_count = stale_count - if locally_modified_and_stale_count is not None: - self.locally_modified_and_stale_count = locally_modified_and_stale_count + if stopped_count is not None: + self.stopped_count = stopped_count if sync_failure_count is not None: self.sync_failure_count = sync_failure_count + if terminated_thread_count is not None: + self.terminated_thread_count = terminated_thread_count + if up_to_date_count is not None: + self.up_to_date_count = up_to_date_count + + @property + def active_remote_port_count(self): + """ + Gets the active_remote_port_count of this ControllerStatusDTO. + The number of active remote ports in the NiFi. + + :return: The active_remote_port_count of this ControllerStatusDTO. + :rtype: int + """ + return self._active_remote_port_count + + @active_remote_port_count.setter + def active_remote_port_count(self, active_remote_port_count): + """ + Sets the active_remote_port_count of this ControllerStatusDTO. + The number of active remote ports in the NiFi. + + :param active_remote_port_count: The active_remote_port_count of this ControllerStatusDTO. + :type: int + """ + + self._active_remote_port_count = active_remote_port_count @property def active_thread_count(self): @@ -144,50 +164,50 @@ def active_thread_count(self, active_thread_count): self._active_thread_count = active_thread_count @property - def terminated_thread_count(self): + def bytes_queued(self): """ - Gets the terminated_thread_count of this ControllerStatusDTO. - The number of terminated threads in the NiFi. + Gets the bytes_queued of this ControllerStatusDTO. + The size of the FlowFiles queued across the entire flow - :return: The terminated_thread_count of this ControllerStatusDTO. + :return: The bytes_queued of this ControllerStatusDTO. :rtype: int """ - return self._terminated_thread_count + return self._bytes_queued - @terminated_thread_count.setter - def terminated_thread_count(self, terminated_thread_count): + @bytes_queued.setter + def bytes_queued(self, bytes_queued): """ - Sets the terminated_thread_count of this ControllerStatusDTO. - The number of terminated threads in the NiFi. + Sets the bytes_queued of this ControllerStatusDTO. + The size of the FlowFiles queued across the entire flow - :param terminated_thread_count: The terminated_thread_count of this ControllerStatusDTO. + :param bytes_queued: The bytes_queued of this ControllerStatusDTO. :type: int """ - self._terminated_thread_count = terminated_thread_count + self._bytes_queued = bytes_queued @property - def queued(self): + def disabled_count(self): """ - Gets the queued of this ControllerStatusDTO. - The number of flowfiles queued in the NiFi. + Gets the disabled_count of this ControllerStatusDTO. + The number of disabled components in the NiFi. - :return: The queued of this ControllerStatusDTO. - :rtype: str + :return: The disabled_count of this ControllerStatusDTO. + :rtype: int """ - return self._queued + return self._disabled_count - @queued.setter - def queued(self, queued): + @disabled_count.setter + def disabled_count(self, disabled_count): """ - Sets the queued of this ControllerStatusDTO. - The number of flowfiles queued in the NiFi. + Sets the disabled_count of this ControllerStatusDTO. + The number of disabled components in the NiFi. - :param queued: The queued of this ControllerStatusDTO. - :type: str + :param disabled_count: The disabled_count of this ControllerStatusDTO. + :type: int """ - self._queued = queued + self._disabled_count = disabled_count @property def flow_files_queued(self): @@ -213,73 +233,27 @@ def flow_files_queued(self, flow_files_queued): self._flow_files_queued = flow_files_queued @property - def bytes_queued(self): - """ - Gets the bytes_queued of this ControllerStatusDTO. - The size of the FlowFiles queued across the entire flow - - :return: The bytes_queued of this ControllerStatusDTO. - :rtype: int - """ - return self._bytes_queued - - @bytes_queued.setter - def bytes_queued(self, bytes_queued): - """ - Sets the bytes_queued of this ControllerStatusDTO. - The size of the FlowFiles queued across the entire flow - - :param bytes_queued: The bytes_queued of this ControllerStatusDTO. - :type: int - """ - - self._bytes_queued = bytes_queued - - @property - def running_count(self): - """ - Gets the running_count of this ControllerStatusDTO. - The number of running components in the NiFi. - - :return: The running_count of this ControllerStatusDTO. - :rtype: int - """ - return self._running_count - - @running_count.setter - def running_count(self, running_count): - """ - Sets the running_count of this ControllerStatusDTO. - The number of running components in the NiFi. - - :param running_count: The running_count of this ControllerStatusDTO. - :type: int - """ - - self._running_count = running_count - - @property - def stopped_count(self): + def inactive_remote_port_count(self): """ - Gets the stopped_count of this ControllerStatusDTO. - The number of stopped components in the NiFi. + Gets the inactive_remote_port_count of this ControllerStatusDTO. + The number of inactive remote ports in the NiFi. - :return: The stopped_count of this ControllerStatusDTO. + :return: The inactive_remote_port_count of this ControllerStatusDTO. :rtype: int """ - return self._stopped_count + return self._inactive_remote_port_count - @stopped_count.setter - def stopped_count(self, stopped_count): + @inactive_remote_port_count.setter + def inactive_remote_port_count(self, inactive_remote_port_count): """ - Sets the stopped_count of this ControllerStatusDTO. - The number of stopped components in the NiFi. + Sets the inactive_remote_port_count of this ControllerStatusDTO. + The number of inactive remote ports in the NiFi. - :param stopped_count: The stopped_count of this ControllerStatusDTO. + :param inactive_remote_port_count: The inactive_remote_port_count of this ControllerStatusDTO. :type: int """ - self._stopped_count = stopped_count + self._inactive_remote_port_count = inactive_remote_port_count @property def invalid_count(self): @@ -305,119 +279,96 @@ def invalid_count(self, invalid_count): self._invalid_count = invalid_count @property - def disabled_count(self): - """ - Gets the disabled_count of this ControllerStatusDTO. - The number of disabled components in the NiFi. - - :return: The disabled_count of this ControllerStatusDTO. - :rtype: int - """ - return self._disabled_count - - @disabled_count.setter - def disabled_count(self, disabled_count): - """ - Sets the disabled_count of this ControllerStatusDTO. - The number of disabled components in the NiFi. - - :param disabled_count: The disabled_count of this ControllerStatusDTO. - :type: int - """ - - self._disabled_count = disabled_count - - @property - def active_remote_port_count(self): + def locally_modified_and_stale_count(self): """ - Gets the active_remote_port_count of this ControllerStatusDTO. - The number of active remote ports in the NiFi. + Gets the locally_modified_and_stale_count of this ControllerStatusDTO. + The number of locally modified and stale versioned process groups in the NiFi. - :return: The active_remote_port_count of this ControllerStatusDTO. + :return: The locally_modified_and_stale_count of this ControllerStatusDTO. :rtype: int """ - return self._active_remote_port_count + return self._locally_modified_and_stale_count - @active_remote_port_count.setter - def active_remote_port_count(self, active_remote_port_count): + @locally_modified_and_stale_count.setter + def locally_modified_and_stale_count(self, locally_modified_and_stale_count): """ - Sets the active_remote_port_count of this ControllerStatusDTO. - The number of active remote ports in the NiFi. + Sets the locally_modified_and_stale_count of this ControllerStatusDTO. + The number of locally modified and stale versioned process groups in the NiFi. - :param active_remote_port_count: The active_remote_port_count of this ControllerStatusDTO. + :param locally_modified_and_stale_count: The locally_modified_and_stale_count of this ControllerStatusDTO. :type: int """ - self._active_remote_port_count = active_remote_port_count + self._locally_modified_and_stale_count = locally_modified_and_stale_count @property - def inactive_remote_port_count(self): + def locally_modified_count(self): """ - Gets the inactive_remote_port_count of this ControllerStatusDTO. - The number of inactive remote ports in the NiFi. + Gets the locally_modified_count of this ControllerStatusDTO. + The number of locally modified versioned process groups in the NiFi. - :return: The inactive_remote_port_count of this ControllerStatusDTO. + :return: The locally_modified_count of this ControllerStatusDTO. :rtype: int """ - return self._inactive_remote_port_count + return self._locally_modified_count - @inactive_remote_port_count.setter - def inactive_remote_port_count(self, inactive_remote_port_count): + @locally_modified_count.setter + def locally_modified_count(self, locally_modified_count): """ - Sets the inactive_remote_port_count of this ControllerStatusDTO. - The number of inactive remote ports in the NiFi. + Sets the locally_modified_count of this ControllerStatusDTO. + The number of locally modified versioned process groups in the NiFi. - :param inactive_remote_port_count: The inactive_remote_port_count of this ControllerStatusDTO. + :param locally_modified_count: The locally_modified_count of this ControllerStatusDTO. :type: int """ - self._inactive_remote_port_count = inactive_remote_port_count + self._locally_modified_count = locally_modified_count @property - def up_to_date_count(self): + def queued(self): """ - Gets the up_to_date_count of this ControllerStatusDTO. - The number of up to date versioned process groups in the NiFi. + Gets the queued of this ControllerStatusDTO. + The number of flowfiles queued in the NiFi. - :return: The up_to_date_count of this ControllerStatusDTO. - :rtype: int + :return: The queued of this ControllerStatusDTO. + :rtype: str """ - return self._up_to_date_count + return self._queued - @up_to_date_count.setter - def up_to_date_count(self, up_to_date_count): + @queued.setter + def queued(self, queued): """ - Sets the up_to_date_count of this ControllerStatusDTO. - The number of up to date versioned process groups in the NiFi. + Sets the queued of this ControllerStatusDTO. + The number of flowfiles queued in the NiFi. - :param up_to_date_count: The up_to_date_count of this ControllerStatusDTO. - :type: int + :param queued: The queued of this ControllerStatusDTO. + :type: str """ - self._up_to_date_count = up_to_date_count + self._queued = queued @property - def locally_modified_count(self): + def running_count(self): """ - Gets the locally_modified_count of this ControllerStatusDTO. - The number of locally modified versioned process groups in the NiFi. + Gets the running_count of this ControllerStatusDTO. + The number of running components in the NiFi. - :return: The locally_modified_count of this ControllerStatusDTO. + :return: The running_count of this ControllerStatusDTO. :rtype: int """ - return self._locally_modified_count + return self._running_count - @locally_modified_count.setter - def locally_modified_count(self, locally_modified_count): + @running_count.setter + def running_count(self, running_count): """ - Sets the locally_modified_count of this ControllerStatusDTO. - The number of locally modified versioned process groups in the NiFi. + Sets the running_count of this ControllerStatusDTO. + The number of running components in the NiFi. - :param locally_modified_count: The locally_modified_count of this ControllerStatusDTO. + :param running_count: The running_count of this ControllerStatusDTO. :type: int """ - self._locally_modified_count = locally_modified_count + self._running_count = running_count @property def stale_count(self): @@ -443,27 +394,27 @@ def stale_count(self, stale_count): self._stale_count = stale_count @property - def locally_modified_and_stale_count(self): + def stopped_count(self): """ - Gets the locally_modified_and_stale_count of this ControllerStatusDTO. - The number of locally modified and stale versioned process groups in the NiFi. + Gets the stopped_count of this ControllerStatusDTO. + The number of stopped components in the NiFi. - :return: The locally_modified_and_stale_count of this ControllerStatusDTO. + :return: The stopped_count of this ControllerStatusDTO. :rtype: int """ - return self._locally_modified_and_stale_count + return self._stopped_count - @locally_modified_and_stale_count.setter - def locally_modified_and_stale_count(self, locally_modified_and_stale_count): + @stopped_count.setter + def stopped_count(self, stopped_count): """ - Sets the locally_modified_and_stale_count of this ControllerStatusDTO. - The number of locally modified and stale versioned process groups in the NiFi. + Sets the stopped_count of this ControllerStatusDTO. + The number of stopped components in the NiFi. - :param locally_modified_and_stale_count: The locally_modified_and_stale_count of this ControllerStatusDTO. + :param stopped_count: The stopped_count of this ControllerStatusDTO. :type: int """ - self._locally_modified_and_stale_count = locally_modified_and_stale_count + self._stopped_count = stopped_count @property def sync_failure_count(self): @@ -488,6 +439,52 @@ def sync_failure_count(self, sync_failure_count): self._sync_failure_count = sync_failure_count + @property + def terminated_thread_count(self): + """ + Gets the terminated_thread_count of this ControllerStatusDTO. + The number of terminated threads in the NiFi. + + :return: The terminated_thread_count of this ControllerStatusDTO. + :rtype: int + """ + return self._terminated_thread_count + + @terminated_thread_count.setter + def terminated_thread_count(self, terminated_thread_count): + """ + Sets the terminated_thread_count of this ControllerStatusDTO. + The number of terminated threads in the NiFi. + + :param terminated_thread_count: The terminated_thread_count of this ControllerStatusDTO. + :type: int + """ + + self._terminated_thread_count = terminated_thread_count + + @property + def up_to_date_count(self): + """ + Gets the up_to_date_count of this ControllerStatusDTO. + The number of up to date versioned process groups in the NiFi. + + :return: The up_to_date_count of this ControllerStatusDTO. + :rtype: int + """ + return self._up_to_date_count + + @up_to_date_count.setter + def up_to_date_count(self, up_to_date_count): + """ + Sets the up_to_date_count of this ControllerStatusDTO. + The number of up to date versioned process groups in the NiFi. + + :param up_to_date_count: The up_to_date_count of this ControllerStatusDTO. + :type: int + """ + + self._up_to_date_count = up_to_date_count + def to_dict(self): """ Returns the model properties as a dict diff --git a/nipyapi/nifi/models/controller_status_entity.py b/nipyapi/nifi/models/controller_status_entity.py index 648f6c5a..45dead85 100644 --- a/nipyapi/nifi/models/controller_status_entity.py +++ b/nipyapi/nifi/models/controller_status_entity.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,12 +27,10 @@ class ControllerStatusEntity(object): and the value is json key in definition. """ swagger_types = { - 'controller_status': 'ControllerStatusDTO' - } + 'controller_status': 'ControllerStatusDTO' } attribute_map = { - 'controller_status': 'controllerStatus' - } + 'controller_status': 'controllerStatus' } def __init__(self, controller_status=None): """ diff --git a/nipyapi/nifi/models/copy_request_entity.py b/nipyapi/nifi/models/copy_request_entity.py new file mode 100644 index 00000000..12ff66c3 --- /dev/null +++ b/nipyapi/nifi/models/copy_request_entity.py @@ -0,0 +1,315 @@ +""" + Apache NiFi REST API + + REST API definition for Apache NiFi web services + + OpenAPI spec version: 2.5.0 + Contact: dev@nifi.apache.org + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from pprint import pformat +import re + + +class CopyRequestEntity(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 = { + 'connections': 'list[str]', +'funnels': 'list[str]', +'input_ports': 'list[str]', +'labels': 'list[str]', +'output_ports': 'list[str]', +'process_groups': 'list[str]', +'processors': 'list[str]', +'remote_process_groups': 'list[str]' } + + attribute_map = { + 'connections': 'connections', +'funnels': 'funnels', +'input_ports': 'inputPorts', +'labels': 'labels', +'output_ports': 'outputPorts', +'process_groups': 'processGroups', +'processors': 'processors', +'remote_process_groups': 'remoteProcessGroups' } + + def __init__(self, connections=None, funnels=None, input_ports=None, labels=None, output_ports=None, process_groups=None, processors=None, remote_process_groups=None): + """ + CopyRequestEntity - a model defined in Swagger + """ + + self._connections = None + self._funnels = None + self._input_ports = None + self._labels = None + self._output_ports = None + self._process_groups = None + self._processors = None + self._remote_process_groups = None + + if connections is not None: + self.connections = connections + if funnels is not None: + self.funnels = funnels + if input_ports is not None: + self.input_ports = input_ports + if labels is not None: + self.labels = labels + if output_ports is not None: + self.output_ports = output_ports + if process_groups is not None: + self.process_groups = process_groups + if processors is not None: + self.processors = processors + if remote_process_groups is not None: + self.remote_process_groups = remote_process_groups + + @property + def connections(self): + """ + Gets the connections of this CopyRequestEntity. + The ids of the connections to be copied. + + :return: The connections of this CopyRequestEntity. + :rtype: list[str] + """ + return self._connections + + @connections.setter + def connections(self, connections): + """ + Sets the connections of this CopyRequestEntity. + The ids of the connections to be copied. + + :param connections: The connections of this CopyRequestEntity. + :type: list[str] + """ + + self._connections = connections + + @property + def funnels(self): + """ + Gets the funnels of this CopyRequestEntity. + The ids of the funnels to be copied. + + :return: The funnels of this CopyRequestEntity. + :rtype: list[str] + """ + return self._funnels + + @funnels.setter + def funnels(self, funnels): + """ + Sets the funnels of this CopyRequestEntity. + The ids of the funnels to be copied. + + :param funnels: The funnels of this CopyRequestEntity. + :type: list[str] + """ + + self._funnels = funnels + + @property + def input_ports(self): + """ + Gets the input_ports of this CopyRequestEntity. + The ids of the input ports to be copied. + + :return: The input_ports of this CopyRequestEntity. + :rtype: list[str] + """ + return self._input_ports + + @input_ports.setter + def input_ports(self, input_ports): + """ + Sets the input_ports of this CopyRequestEntity. + The ids of the input ports to be copied. + + :param input_ports: The input_ports of this CopyRequestEntity. + :type: list[str] + """ + + self._input_ports = input_ports + + @property + def labels(self): + """ + Gets the labels of this CopyRequestEntity. + The ids of the labels to be copied. + + :return: The labels of this CopyRequestEntity. + :rtype: list[str] + """ + return self._labels + + @labels.setter + def labels(self, labels): + """ + Sets the labels of this CopyRequestEntity. + The ids of the labels to be copied. + + :param labels: The labels of this CopyRequestEntity. + :type: list[str] + """ + + self._labels = labels + + @property + def output_ports(self): + """ + Gets the output_ports of this CopyRequestEntity. + The ids of the output ports to be copied. + + :return: The output_ports of this CopyRequestEntity. + :rtype: list[str] + """ + return self._output_ports + + @output_ports.setter + def output_ports(self, output_ports): + """ + Sets the output_ports of this CopyRequestEntity. + The ids of the output ports to be copied. + + :param output_ports: The output_ports of this CopyRequestEntity. + :type: list[str] + """ + + self._output_ports = output_ports + + @property + def process_groups(self): + """ + Gets the process_groups of this CopyRequestEntity. + The ids of the process groups to be copied. + + :return: The process_groups of this CopyRequestEntity. + :rtype: list[str] + """ + return self._process_groups + + @process_groups.setter + def process_groups(self, process_groups): + """ + Sets the process_groups of this CopyRequestEntity. + The ids of the process groups to be copied. + + :param process_groups: The process_groups of this CopyRequestEntity. + :type: list[str] + """ + + self._process_groups = process_groups + + @property + def processors(self): + """ + Gets the processors of this CopyRequestEntity. + The ids of the processors to be copied. + + :return: The processors of this CopyRequestEntity. + :rtype: list[str] + """ + return self._processors + + @processors.setter + def processors(self, processors): + """ + Sets the processors of this CopyRequestEntity. + The ids of the processors to be copied. + + :param processors: The processors of this CopyRequestEntity. + :type: list[str] + """ + + self._processors = processors + + @property + def remote_process_groups(self): + """ + Gets the remote_process_groups of this CopyRequestEntity. + The ids of the remote process groups to be copied. + + :return: The remote_process_groups of this CopyRequestEntity. + :rtype: list[str] + """ + return self._remote_process_groups + + @remote_process_groups.setter + def remote_process_groups(self, remote_process_groups): + """ + Sets the remote_process_groups of this CopyRequestEntity. + The ids of the remote process groups to be copied. + + :param remote_process_groups: The remote_process_groups of this CopyRequestEntity. + :type: list[str] + """ + + self._remote_process_groups = remote_process_groups + + 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, CopyRequestEntity): + 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/copy_response_entity.py b/nipyapi/nifi/models/copy_response_entity.py new file mode 100644 index 00000000..3a5ec855 --- /dev/null +++ b/nipyapi/nifi/models/copy_response_entity.py @@ -0,0 +1,427 @@ +""" + Apache NiFi REST API + + REST API definition for Apache NiFi web services + + OpenAPI spec version: 2.5.0 + Contact: dev@nifi.apache.org + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from pprint import pformat +import re + + +class CopyResponseEntity(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 = { + 'connections': 'list[VersionedConnection]', +'external_controller_service_references': 'dict(str, ExternalControllerServiceReference)', +'funnels': 'list[VersionedFunnel]', +'id': 'str', +'input_ports': 'list[VersionedPort]', +'labels': 'list[VersionedLabel]', +'output_ports': 'list[VersionedPort]', +'parameter_contexts': 'dict(str, VersionedParameterContext)', +'parameter_providers': 'dict(str, ParameterProviderReference)', +'process_groups': 'list[VersionedProcessGroup]', +'processors': 'list[VersionedProcessor]', +'remote_process_groups': 'list[VersionedRemoteProcessGroup]' } + + attribute_map = { + 'connections': 'connections', +'external_controller_service_references': 'externalControllerServiceReferences', +'funnels': 'funnels', +'id': 'id', +'input_ports': 'inputPorts', +'labels': 'labels', +'output_ports': 'outputPorts', +'parameter_contexts': 'parameterContexts', +'parameter_providers': 'parameterProviders', +'process_groups': 'processGroups', +'processors': 'processors', +'remote_process_groups': 'remoteProcessGroups' } + + def __init__(self, connections=None, external_controller_service_references=None, funnels=None, id=None, input_ports=None, labels=None, output_ports=None, parameter_contexts=None, parameter_providers=None, process_groups=None, processors=None, remote_process_groups=None): + """ + CopyResponseEntity - a model defined in Swagger + """ + + self._connections = None + self._external_controller_service_references = None + self._funnels = None + self._id = None + self._input_ports = None + self._labels = None + self._output_ports = None + self._parameter_contexts = None + self._parameter_providers = None + self._process_groups = None + self._processors = None + self._remote_process_groups = None + + if connections is not None: + self.connections = connections + if external_controller_service_references is not None: + self.external_controller_service_references = external_controller_service_references + if funnels is not None: + self.funnels = funnels + if id is not None: + self.id = id + if input_ports is not None: + self.input_ports = input_ports + if labels is not None: + self.labels = labels + if output_ports is not None: + self.output_ports = output_ports + if parameter_contexts is not None: + self.parameter_contexts = parameter_contexts + if parameter_providers is not None: + self.parameter_providers = parameter_providers + if process_groups is not None: + self.process_groups = process_groups + if processors is not None: + self.processors = processors + if remote_process_groups is not None: + self.remote_process_groups = remote_process_groups + + @property + def connections(self): + """ + Gets the connections of this CopyResponseEntity. + The connections being copied. + + :return: The connections of this CopyResponseEntity. + :rtype: list[VersionedConnection] + """ + return self._connections + + @connections.setter + def connections(self, connections): + """ + Sets the connections of this CopyResponseEntity. + The connections being copied. + + :param connections: The connections of this CopyResponseEntity. + :type: list[VersionedConnection] + """ + + self._connections = connections + + @property + def external_controller_service_references(self): + """ + Gets the external_controller_service_references of this CopyResponseEntity. + The external controller service references. + + :return: The external_controller_service_references of this CopyResponseEntity. + :rtype: dict(str, ExternalControllerServiceReference) + """ + return self._external_controller_service_references + + @external_controller_service_references.setter + def external_controller_service_references(self, external_controller_service_references): + """ + Sets the external_controller_service_references of this CopyResponseEntity. + The external controller service references. + + :param external_controller_service_references: The external_controller_service_references of this CopyResponseEntity. + :type: dict(str, ExternalControllerServiceReference) + """ + + self._external_controller_service_references = external_controller_service_references + + @property + def funnels(self): + """ + Gets the funnels of this CopyResponseEntity. + The funnels being copied. + + :return: The funnels of this CopyResponseEntity. + :rtype: list[VersionedFunnel] + """ + return self._funnels + + @funnels.setter + def funnels(self, funnels): + """ + Sets the funnels of this CopyResponseEntity. + The funnels being copied. + + :param funnels: The funnels of this CopyResponseEntity. + :type: list[VersionedFunnel] + """ + + self._funnels = funnels + + @property + def id(self): + """ + Gets the id of this CopyResponseEntity. + The id for this copy action. + + :return: The id of this CopyResponseEntity. + :rtype: str + """ + return self._id + + @id.setter + def id(self, id): + """ + Sets the id of this CopyResponseEntity. + The id for this copy action. + + :param id: The id of this CopyResponseEntity. + :type: str + """ + + self._id = id + + @property + def input_ports(self): + """ + Gets the input_ports of this CopyResponseEntity. + The input ports being copied. + + :return: The input_ports of this CopyResponseEntity. + :rtype: list[VersionedPort] + """ + return self._input_ports + + @input_ports.setter + def input_ports(self, input_ports): + """ + Sets the input_ports of this CopyResponseEntity. + The input ports being copied. + + :param input_ports: The input_ports of this CopyResponseEntity. + :type: list[VersionedPort] + """ + + self._input_ports = input_ports + + @property + def labels(self): + """ + Gets the labels of this CopyResponseEntity. + The labels being copied. + + :return: The labels of this CopyResponseEntity. + :rtype: list[VersionedLabel] + """ + return self._labels + + @labels.setter + def labels(self, labels): + """ + Sets the labels of this CopyResponseEntity. + The labels being copied. + + :param labels: The labels of this CopyResponseEntity. + :type: list[VersionedLabel] + """ + + self._labels = labels + + @property + def output_ports(self): + """ + Gets the output_ports of this CopyResponseEntity. + The output ports being copied. + + :return: The output_ports of this CopyResponseEntity. + :rtype: list[VersionedPort] + """ + return self._output_ports + + @output_ports.setter + def output_ports(self, output_ports): + """ + Sets the output_ports of this CopyResponseEntity. + The output ports being copied. + + :param output_ports: The output_ports of this CopyResponseEntity. + :type: list[VersionedPort] + """ + + self._output_ports = output_ports + + @property + def parameter_contexts(self): + """ + Gets the parameter_contexts of this CopyResponseEntity. + The referenced parameter contexts. + + :return: The parameter_contexts of this CopyResponseEntity. + :rtype: dict(str, VersionedParameterContext) + """ + return self._parameter_contexts + + @parameter_contexts.setter + def parameter_contexts(self, parameter_contexts): + """ + Sets the parameter_contexts of this CopyResponseEntity. + The referenced parameter contexts. + + :param parameter_contexts: The parameter_contexts of this CopyResponseEntity. + :type: dict(str, VersionedParameterContext) + """ + + self._parameter_contexts = parameter_contexts + + @property + def parameter_providers(self): + """ + Gets the parameter_providers of this CopyResponseEntity. + The referenced parameter providers. + + :return: The parameter_providers of this CopyResponseEntity. + :rtype: dict(str, ParameterProviderReference) + """ + return self._parameter_providers + + @parameter_providers.setter + def parameter_providers(self, parameter_providers): + """ + Sets the parameter_providers of this CopyResponseEntity. + The referenced parameter providers. + + :param parameter_providers: The parameter_providers of this CopyResponseEntity. + :type: dict(str, ParameterProviderReference) + """ + + self._parameter_providers = parameter_providers + + @property + def process_groups(self): + """ + Gets the process_groups of this CopyResponseEntity. + The process groups being copied. + + :return: The process_groups of this CopyResponseEntity. + :rtype: list[VersionedProcessGroup] + """ + return self._process_groups + + @process_groups.setter + def process_groups(self, process_groups): + """ + Sets the process_groups of this CopyResponseEntity. + The process groups being copied. + + :param process_groups: The process_groups of this CopyResponseEntity. + :type: list[VersionedProcessGroup] + """ + + self._process_groups = process_groups + + @property + def processors(self): + """ + Gets the processors of this CopyResponseEntity. + The processors being copied. + + :return: The processors of this CopyResponseEntity. + :rtype: list[VersionedProcessor] + """ + return self._processors + + @processors.setter + def processors(self, processors): + """ + Sets the processors of this CopyResponseEntity. + The processors being copied. + + :param processors: The processors of this CopyResponseEntity. + :type: list[VersionedProcessor] + """ + + self._processors = processors + + @property + def remote_process_groups(self): + """ + Gets the remote_process_groups of this CopyResponseEntity. + The remote process groups being copied. + + :return: The remote_process_groups of this CopyResponseEntity. + :rtype: list[VersionedRemoteProcessGroup] + """ + return self._remote_process_groups + + @remote_process_groups.setter + def remote_process_groups(self, remote_process_groups): + """ + Sets the remote_process_groups of this CopyResponseEntity. + The remote process groups being copied. + + :param remote_process_groups: The remote_process_groups of this CopyResponseEntity. + :type: list[VersionedRemoteProcessGroup] + """ + + self._remote_process_groups = remote_process_groups + + 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, CopyResponseEntity): + 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/copy_snippet_request_entity.py b/nipyapi/nifi/models/copy_snippet_request_entity.py index 3c99f396..92b9e397 100644 --- a/nipyapi/nifi/models/copy_snippet_request_entity.py +++ b/nipyapi/nifi/models/copy_snippet_request_entity.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,60 +27,58 @@ class CopySnippetRequestEntity(object): and the value is json key in definition. """ swagger_types = { - 'snippet_id': 'str', - 'origin_x': 'float', - 'origin_y': 'float', - 'disconnected_node_acknowledged': 'bool' - } + 'disconnected_node_acknowledged': 'bool', +'origin_x': 'float', +'origin_y': 'float', +'snippet_id': 'str' } attribute_map = { - 'snippet_id': 'snippetId', - 'origin_x': 'originX', - 'origin_y': 'originY', - 'disconnected_node_acknowledged': 'disconnectedNodeAcknowledged' - } + 'disconnected_node_acknowledged': 'disconnectedNodeAcknowledged', +'origin_x': 'originX', +'origin_y': 'originY', +'snippet_id': 'snippetId' } - def __init__(self, snippet_id=None, origin_x=None, origin_y=None, disconnected_node_acknowledged=None): + def __init__(self, disconnected_node_acknowledged=None, origin_x=None, origin_y=None, snippet_id=None): """ CopySnippetRequestEntity - a model defined in Swagger """ - self._snippet_id = None + self._disconnected_node_acknowledged = None self._origin_x = None self._origin_y = None - self._disconnected_node_acknowledged = None + self._snippet_id = None - if snippet_id is not None: - self.snippet_id = snippet_id + if disconnected_node_acknowledged is not None: + self.disconnected_node_acknowledged = disconnected_node_acknowledged if origin_x is not None: self.origin_x = origin_x if origin_y is not None: self.origin_y = origin_y - if disconnected_node_acknowledged is not None: - self.disconnected_node_acknowledged = disconnected_node_acknowledged + if snippet_id is not None: + self.snippet_id = snippet_id @property - def snippet_id(self): + def disconnected_node_acknowledged(self): """ - Gets the snippet_id of this CopySnippetRequestEntity. - The identifier of the snippet. + Gets the disconnected_node_acknowledged of this CopySnippetRequestEntity. + Acknowledges that this node is disconnected to allow for mutable requests to proceed. - :return: The snippet_id of this CopySnippetRequestEntity. - :rtype: str + :return: The disconnected_node_acknowledged of this CopySnippetRequestEntity. + :rtype: bool """ - return self._snippet_id + return self._disconnected_node_acknowledged - @snippet_id.setter - def snippet_id(self, snippet_id): + @disconnected_node_acknowledged.setter + def disconnected_node_acknowledged(self, disconnected_node_acknowledged): """ - Sets the snippet_id of this CopySnippetRequestEntity. - The identifier of the snippet. + Sets the disconnected_node_acknowledged of this CopySnippetRequestEntity. + Acknowledges that this node is disconnected to allow for mutable requests to proceed. - :param snippet_id: The snippet_id of this CopySnippetRequestEntity. - :type: str + :param disconnected_node_acknowledged: The disconnected_node_acknowledged of this CopySnippetRequestEntity. + :type: bool """ - self._snippet_id = snippet_id + self._disconnected_node_acknowledged = disconnected_node_acknowledged @property def origin_x(self): @@ -130,27 +127,27 @@ def origin_y(self, origin_y): self._origin_y = origin_y @property - def disconnected_node_acknowledged(self): + def snippet_id(self): """ - Gets the disconnected_node_acknowledged of this CopySnippetRequestEntity. - Acknowledges that this node is disconnected to allow for mutable requests to proceed. + Gets the snippet_id of this CopySnippetRequestEntity. + The identifier of the snippet. - :return: The disconnected_node_acknowledged of this CopySnippetRequestEntity. - :rtype: bool + :return: The snippet_id of this CopySnippetRequestEntity. + :rtype: str """ - return self._disconnected_node_acknowledged + return self._snippet_id - @disconnected_node_acknowledged.setter - def disconnected_node_acknowledged(self, disconnected_node_acknowledged): + @snippet_id.setter + def snippet_id(self, snippet_id): """ - Sets the disconnected_node_acknowledged of this CopySnippetRequestEntity. - Acknowledges that this node is disconnected to allow for mutable requests to proceed. + Sets the snippet_id of this CopySnippetRequestEntity. + The identifier of the snippet. - :param disconnected_node_acknowledged: The disconnected_node_acknowledged of this CopySnippetRequestEntity. - :type: bool + :param snippet_id: The snippet_id of this CopySnippetRequestEntity. + :type: str """ - self._disconnected_node_acknowledged = disconnected_node_acknowledged + self._snippet_id = snippet_id def to_dict(self): """ diff --git a/nipyapi/nifi/models/counter_dto.py b/nipyapi/nifi/models/counter_dto.py index 6ee88657..bb1c56ef 100644 --- a/nipyapi/nifi/models/counter_dto.py +++ b/nipyapi/nifi/models/counter_dto.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,88 +27,86 @@ class CounterDTO(object): and the value is json key in definition. """ swagger_types = { - 'id': 'str', 'context': 'str', - 'name': 'str', - 'value_count': 'int', - 'value': 'str' - } +'id': 'str', +'name': 'str', +'value': 'str', +'value_count': 'int' } attribute_map = { - 'id': 'id', 'context': 'context', - 'name': 'name', - 'value_count': 'valueCount', - 'value': 'value' - } +'id': 'id', +'name': 'name', +'value': 'value', +'value_count': 'valueCount' } - def __init__(self, id=None, context=None, name=None, value_count=None, value=None): + def __init__(self, context=None, id=None, name=None, value=None, value_count=None): """ CounterDTO - a model defined in Swagger """ - self._id = None self._context = None + self._id = None self._name = None - self._value_count = None self._value = None + self._value_count = None - if id is not None: - self.id = id if context is not None: self.context = context + if id is not None: + self.id = id if name is not None: self.name = name - if value_count is not None: - self.value_count = value_count if value is not None: self.value = value + if value_count is not None: + self.value_count = value_count @property - def id(self): + def context(self): """ - Gets the id of this CounterDTO. - The id of the counter. + Gets the context of this CounterDTO. + The context of the counter. - :return: The id of this CounterDTO. + :return: The context of this CounterDTO. :rtype: str """ - return self._id + return self._context - @id.setter - def id(self, id): + @context.setter + def context(self, context): """ - Sets the id of this CounterDTO. - The id of the counter. + Sets the context of this CounterDTO. + The context of the counter. - :param id: The id of this CounterDTO. + :param context: The context of this CounterDTO. :type: str """ - self._id = id + self._context = context @property - def context(self): + def id(self): """ - Gets the context of this CounterDTO. - The context of the counter. + Gets the id of this CounterDTO. + The id of the counter. - :return: The context of this CounterDTO. + :return: The id of this CounterDTO. :rtype: str """ - return self._context + return self._id - @context.setter - def context(self, context): + @id.setter + def id(self, id): """ - Sets the context of this CounterDTO. - The context of the counter. + Sets the id of this CounterDTO. + The id of the counter. - :param context: The context of this CounterDTO. + :param id: The id of this CounterDTO. :type: str """ - self._context = context + self._id = id @property def name(self): @@ -134,29 +131,6 @@ def name(self, name): self._name = name - @property - def value_count(self): - """ - Gets the value_count of this CounterDTO. - The value count. - - :return: The value_count of this CounterDTO. - :rtype: int - """ - return self._value_count - - @value_count.setter - def value_count(self, value_count): - """ - Sets the value_count of this CounterDTO. - The value count. - - :param value_count: The value_count of this CounterDTO. - :type: int - """ - - self._value_count = value_count - @property def value(self): """ @@ -180,6 +154,29 @@ def value(self, value): self._value = value + @property + def value_count(self): + """ + Gets the value_count of this CounterDTO. + The value count. + + :return: The value_count of this CounterDTO. + :rtype: int + """ + return self._value_count + + @value_count.setter + def value_count(self, value_count): + """ + Sets the value_count of this CounterDTO. + The value count. + + :param value_count: The value_count of this CounterDTO. + :type: int + """ + + self._value_count = value_count + def to_dict(self): """ Returns the model properties as a dict diff --git a/nipyapi/nifi/models/counter_entity.py b/nipyapi/nifi/models/counter_entity.py index 5780b90f..d8ad07ab 100644 --- a/nipyapi/nifi/models/counter_entity.py +++ b/nipyapi/nifi/models/counter_entity.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,12 +27,10 @@ class CounterEntity(object): and the value is json key in definition. """ swagger_types = { - 'counter': 'CounterDTO' - } + 'counter': 'CounterDTO' } attribute_map = { - 'counter': 'counter' - } + 'counter': 'counter' } def __init__(self, counter=None): """ diff --git a/nipyapi/nifi/models/counters_dto.py b/nipyapi/nifi/models/counters_dto.py index a6dc5e09..6458754f 100644 --- a/nipyapi/nifi/models/counters_dto.py +++ b/nipyapi/nifi/models/counters_dto.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -29,13 +28,11 @@ class CountersDTO(object): """ swagger_types = { 'aggregate_snapshot': 'CountersSnapshotDTO', - 'node_snapshots': 'list[NodeCountersSnapshotDTO]' - } +'node_snapshots': 'list[NodeCountersSnapshotDTO]' } attribute_map = { 'aggregate_snapshot': 'aggregateSnapshot', - 'node_snapshots': 'nodeSnapshots' - } +'node_snapshots': 'nodeSnapshots' } def __init__(self, aggregate_snapshot=None, node_snapshots=None): """ @@ -54,7 +51,6 @@ def __init__(self, aggregate_snapshot=None, node_snapshots=None): def aggregate_snapshot(self): """ Gets the aggregate_snapshot of this CountersDTO. - A Counters snapshot that represents the aggregate values of all nodes in the cluster. If the NiFi instance is a standalone instance, rather than a cluster, this represents the stats of the single instance. :return: The aggregate_snapshot of this CountersDTO. :rtype: CountersSnapshotDTO @@ -65,7 +61,6 @@ def aggregate_snapshot(self): def aggregate_snapshot(self, aggregate_snapshot): """ Sets the aggregate_snapshot of this CountersDTO. - A Counters snapshot that represents the aggregate values of all nodes in the cluster. If the NiFi instance is a standalone instance, rather than a cluster, this represents the stats of the single instance. :param aggregate_snapshot: The aggregate_snapshot of this CountersDTO. :type: CountersSnapshotDTO diff --git a/nipyapi/nifi/models/counters_entity.py b/nipyapi/nifi/models/counters_entity.py index fdfe3bd2..b22a28fe 100644 --- a/nipyapi/nifi/models/counters_entity.py +++ b/nipyapi/nifi/models/counters_entity.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,12 +27,10 @@ class CountersEntity(object): and the value is json key in definition. """ swagger_types = { - 'counters': 'CountersDTO' - } + 'counters': 'CountersDTO' } attribute_map = { - 'counters': 'counters' - } + 'counters': 'counters' } def __init__(self, counters=None): """ diff --git a/nipyapi/nifi/models/counters_snapshot_dto.py b/nipyapi/nifi/models/counters_snapshot_dto.py index 91ba7069..87acf4d0 100644 --- a/nipyapi/nifi/models/counters_snapshot_dto.py +++ b/nipyapi/nifi/models/counters_snapshot_dto.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,50 +27,25 @@ class CountersSnapshotDTO(object): and the value is json key in definition. """ swagger_types = { - 'generated': 'str', - 'counters': 'list[CounterDTO]' - } + 'counters': 'list[CounterDTO]', +'generated': 'str' } attribute_map = { - 'generated': 'generated', - 'counters': 'counters' - } + 'counters': 'counters', +'generated': 'generated' } - def __init__(self, generated=None, counters=None): + def __init__(self, counters=None, generated=None): """ CountersSnapshotDTO - a model defined in Swagger """ - self._generated = None self._counters = None + self._generated = None - if generated is not None: - self.generated = generated if counters is not None: self.counters = counters - - @property - def generated(self): - """ - Gets the generated of this CountersSnapshotDTO. - The timestamp when the report was generated. - - :return: The generated of this CountersSnapshotDTO. - :rtype: str - """ - return self._generated - - @generated.setter - def generated(self, generated): - """ - Sets the generated of this CountersSnapshotDTO. - The timestamp when the report was generated. - - :param generated: The generated of this CountersSnapshotDTO. - :type: str - """ - - self._generated = generated + if generated is not None: + self.generated = generated @property def counters(self): @@ -96,6 +70,29 @@ def counters(self, counters): self._counters = counters + @property + def generated(self): + """ + Gets the generated of this CountersSnapshotDTO. + The timestamp when the report was generated. + + :return: The generated of this CountersSnapshotDTO. + :rtype: str + """ + return self._generated + + @generated.setter + def generated(self, generated): + """ + Sets the generated of this CountersSnapshotDTO. + The timestamp when the report was generated. + + :param generated: The generated of this CountersSnapshotDTO. + :type: str + """ + + self._generated = generated + def to_dict(self): """ Returns the model properties as a dict diff --git a/nipyapi/nifi/models/create_active_request_entity.py b/nipyapi/nifi/models/create_active_request_entity.py index 00950ae2..d63ab1e0 100644 --- a/nipyapi/nifi/models/create_active_request_entity.py +++ b/nipyapi/nifi/models/create_active_request_entity.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,50 +27,25 @@ class CreateActiveRequestEntity(object): and the value is json key in definition. """ swagger_types = { - 'process_group_id': 'str', - 'disconnected_node_acknowledged': 'bool' - } + 'disconnected_node_acknowledged': 'bool', +'process_group_id': 'str' } attribute_map = { - 'process_group_id': 'processGroupId', - 'disconnected_node_acknowledged': 'disconnectedNodeAcknowledged' - } + 'disconnected_node_acknowledged': 'disconnectedNodeAcknowledged', +'process_group_id': 'processGroupId' } - def __init__(self, process_group_id=None, disconnected_node_acknowledged=None): + def __init__(self, disconnected_node_acknowledged=None, process_group_id=None): """ CreateActiveRequestEntity - a model defined in Swagger """ - self._process_group_id = None self._disconnected_node_acknowledged = None + self._process_group_id = None - if process_group_id is not None: - self.process_group_id = process_group_id if disconnected_node_acknowledged is not None: self.disconnected_node_acknowledged = disconnected_node_acknowledged - - @property - def process_group_id(self): - """ - Gets the process_group_id of this CreateActiveRequestEntity. - The Process Group ID that this active request will update - - :return: The process_group_id of this CreateActiveRequestEntity. - :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 CreateActiveRequestEntity. - The Process Group ID that this active request will update - - :param process_group_id: The process_group_id of this CreateActiveRequestEntity. - :type: str - """ - - self._process_group_id = process_group_id + if process_group_id is not None: + self.process_group_id = process_group_id @property def disconnected_node_acknowledged(self): @@ -96,6 +70,29 @@ def disconnected_node_acknowledged(self, disconnected_node_acknowledged): self._disconnected_node_acknowledged = disconnected_node_acknowledged + @property + def process_group_id(self): + """ + Gets the process_group_id of this CreateActiveRequestEntity. + The Process Group ID that this active request will update + + :return: The process_group_id of this CreateActiveRequestEntity. + :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 CreateActiveRequestEntity. + The Process Group ID that this active request will update + + :param process_group_id: The process_group_id of this CreateActiveRequestEntity. + :type: str + """ + + self._process_group_id = process_group_id + def to_dict(self): """ Returns the model properties as a dict diff --git a/nipyapi/nifi/models/create_template_request_entity.py b/nipyapi/nifi/models/create_template_request_entity.py deleted file mode 100644 index 77dd6f61..00000000 --- a/nipyapi/nifi/models/create_template_request_entity.py +++ /dev/null @@ -1,206 +0,0 @@ -""" - NiFi Rest API - - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - - OpenAPI spec version: 1.28.1 - Contact: dev@nifi.apache.org - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - - -from pprint import pformat -import re - - -class CreateTemplateRequestEntity(object): - """ - NOTE: This class is auto generated by the swagger code generator program. - Do not edit the class manually. - """ - - - """ - Attributes: - swagger_types (dict): The key is attribute name - and the value is attribute type. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - """ - swagger_types = { - 'name': 'str', - 'description': 'str', - 'snippet_id': 'str', - 'disconnected_node_acknowledged': 'bool' - } - - attribute_map = { - 'name': 'name', - 'description': 'description', - 'snippet_id': 'snippetId', - 'disconnected_node_acknowledged': 'disconnectedNodeAcknowledged' - } - - def __init__(self, name=None, description=None, snippet_id=None, disconnected_node_acknowledged=None): - """ - CreateTemplateRequestEntity - a model defined in Swagger - """ - - self._name = None - self._description = None - self._snippet_id = None - self._disconnected_node_acknowledged = None - - if name is not None: - self.name = name - if description is not None: - self.description = description - if snippet_id is not None: - self.snippet_id = snippet_id - if disconnected_node_acknowledged is not None: - self.disconnected_node_acknowledged = disconnected_node_acknowledged - - @property - def name(self): - """ - Gets the name of this CreateTemplateRequestEntity. - The name of the template. - - :return: The name of this CreateTemplateRequestEntity. - :rtype: str - """ - return self._name - - @name.setter - def name(self, name): - """ - Sets the name of this CreateTemplateRequestEntity. - The name of the template. - - :param name: The name of this CreateTemplateRequestEntity. - :type: str - """ - - self._name = name - - @property - def description(self): - """ - Gets the description of this CreateTemplateRequestEntity. - The description of the template. - - :return: The description of this CreateTemplateRequestEntity. - :rtype: str - """ - return self._description - - @description.setter - def description(self, description): - """ - Sets the description of this CreateTemplateRequestEntity. - The description of the template. - - :param description: The description of this CreateTemplateRequestEntity. - :type: str - """ - - self._description = description - - @property - def snippet_id(self): - """ - Gets the snippet_id of this CreateTemplateRequestEntity. - The identifier of the snippet. - - :return: The snippet_id of this CreateTemplateRequestEntity. - :rtype: str - """ - return self._snippet_id - - @snippet_id.setter - def snippet_id(self, snippet_id): - """ - Sets the snippet_id of this CreateTemplateRequestEntity. - The identifier of the snippet. - - :param snippet_id: The snippet_id of this CreateTemplateRequestEntity. - :type: str - """ - - self._snippet_id = snippet_id - - @property - def disconnected_node_acknowledged(self): - """ - Gets the disconnected_node_acknowledged of this CreateTemplateRequestEntity. - Acknowledges that this node is disconnected to allow for mutable requests to proceed. - - :return: The disconnected_node_acknowledged of this CreateTemplateRequestEntity. - :rtype: bool - """ - return self._disconnected_node_acknowledged - - @disconnected_node_acknowledged.setter - def disconnected_node_acknowledged(self, disconnected_node_acknowledged): - """ - Sets the disconnected_node_acknowledged of this CreateTemplateRequestEntity. - Acknowledges that this node is disconnected to allow for mutable requests to proceed. - - :param disconnected_node_acknowledged: The disconnected_node_acknowledged of this CreateTemplateRequestEntity. - :type: bool - """ - - self._disconnected_node_acknowledged = disconnected_node_acknowledged - - 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, CreateTemplateRequestEntity): - 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/current_user_entity.py b/nipyapi/nifi/models/current_user_entity.py index 6343e5e0..8c313fd4 100644 --- a/nipyapi/nifi/models/current_user_entity.py +++ b/nipyapi/nifi/models/current_user_entity.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,100 +27,80 @@ class CurrentUserEntity(object): and the value is json key in definition. """ swagger_types = { - 'identity': 'str', 'anonymous': 'bool', - 'provenance_permissions': 'PermissionsDTO', - 'counters_permissions': 'PermissionsDTO', - 'tenants_permissions': 'PermissionsDTO', - 'controller_permissions': 'PermissionsDTO', - 'policies_permissions': 'PermissionsDTO', - 'system_permissions': 'PermissionsDTO', - 'parameter_context_permissions': 'PermissionsDTO', - 'restricted_components_permissions': 'PermissionsDTO', - 'component_restriction_permissions': 'list[ComponentRestrictionPermissionDTO]', - 'can_version_flows': 'bool' - } +'can_version_flows': 'bool', +'component_restriction_permissions': 'list[ComponentRestrictionPermissionDTO]', +'controller_permissions': 'PermissionsDTO', +'counters_permissions': 'PermissionsDTO', +'identity': 'str', +'logout_supported': 'bool', +'parameter_context_permissions': 'PermissionsDTO', +'policies_permissions': 'PermissionsDTO', +'provenance_permissions': 'PermissionsDTO', +'restricted_components_permissions': 'PermissionsDTO', +'system_permissions': 'PermissionsDTO', +'tenants_permissions': 'PermissionsDTO' } attribute_map = { - 'identity': 'identity', 'anonymous': 'anonymous', - 'provenance_permissions': 'provenancePermissions', - 'counters_permissions': 'countersPermissions', - 'tenants_permissions': 'tenantsPermissions', - 'controller_permissions': 'controllerPermissions', - 'policies_permissions': 'policiesPermissions', - 'system_permissions': 'systemPermissions', - 'parameter_context_permissions': 'parameterContextPermissions', - 'restricted_components_permissions': 'restrictedComponentsPermissions', - 'component_restriction_permissions': 'componentRestrictionPermissions', - 'can_version_flows': 'canVersionFlows' - } - - def __init__(self, identity=None, anonymous=None, provenance_permissions=None, counters_permissions=None, tenants_permissions=None, controller_permissions=None, policies_permissions=None, system_permissions=None, parameter_context_permissions=None, restricted_components_permissions=None, component_restriction_permissions=None, can_version_flows=None): +'can_version_flows': 'canVersionFlows', +'component_restriction_permissions': 'componentRestrictionPermissions', +'controller_permissions': 'controllerPermissions', +'counters_permissions': 'countersPermissions', +'identity': 'identity', +'logout_supported': 'logoutSupported', +'parameter_context_permissions': 'parameterContextPermissions', +'policies_permissions': 'policiesPermissions', +'provenance_permissions': 'provenancePermissions', +'restricted_components_permissions': 'restrictedComponentsPermissions', +'system_permissions': 'systemPermissions', +'tenants_permissions': 'tenantsPermissions' } + + def __init__(self, anonymous=None, can_version_flows=None, component_restriction_permissions=None, controller_permissions=None, counters_permissions=None, identity=None, logout_supported=None, parameter_context_permissions=None, policies_permissions=None, provenance_permissions=None, restricted_components_permissions=None, system_permissions=None, tenants_permissions=None): """ CurrentUserEntity - a model defined in Swagger """ - self._identity = None self._anonymous = None - self._provenance_permissions = None - self._counters_permissions = None - self._tenants_permissions = None + self._can_version_flows = None + self._component_restriction_permissions = None self._controller_permissions = None - self._policies_permissions = None - self._system_permissions = None + self._counters_permissions = None + self._identity = None + self._logout_supported = None self._parameter_context_permissions = None + self._policies_permissions = None + self._provenance_permissions = None self._restricted_components_permissions = None - self._component_restriction_permissions = None - self._can_version_flows = None + self._system_permissions = None + self._tenants_permissions = None - if identity is not None: - self.identity = identity if anonymous is not None: self.anonymous = anonymous - if provenance_permissions is not None: - self.provenance_permissions = provenance_permissions - if counters_permissions is not None: - self.counters_permissions = counters_permissions - if tenants_permissions is not None: - self.tenants_permissions = tenants_permissions + if can_version_flows is not None: + self.can_version_flows = can_version_flows + if component_restriction_permissions is not None: + self.component_restriction_permissions = component_restriction_permissions if controller_permissions is not None: self.controller_permissions = controller_permissions - if policies_permissions is not None: - self.policies_permissions = policies_permissions - if system_permissions is not None: - self.system_permissions = system_permissions + if counters_permissions is not None: + self.counters_permissions = counters_permissions + if identity is not None: + self.identity = identity + if logout_supported is not None: + self.logout_supported = logout_supported if parameter_context_permissions is not None: self.parameter_context_permissions = parameter_context_permissions + if policies_permissions is not None: + self.policies_permissions = policies_permissions + if provenance_permissions is not None: + self.provenance_permissions = provenance_permissions if restricted_components_permissions is not None: self.restricted_components_permissions = restricted_components_permissions - if component_restriction_permissions is not None: - self.component_restriction_permissions = component_restriction_permissions - if can_version_flows is not None: - self.can_version_flows = can_version_flows - - @property - def identity(self): - """ - Gets the identity of this CurrentUserEntity. - The user identity being serialized. - - :return: The identity of this CurrentUserEntity. - :rtype: str - """ - return self._identity - - @identity.setter - def identity(self, identity): - """ - Sets the identity of this CurrentUserEntity. - The user identity being serialized. - - :param identity: The identity of this CurrentUserEntity. - :type: str - """ - - self._identity = identity + if system_permissions is not None: + self.system_permissions = system_permissions + if tenants_permissions is not None: + self.tenants_permissions = tenants_permissions @property def anonymous(self): @@ -147,33 +126,76 @@ def anonymous(self, anonymous): self._anonymous = anonymous @property - def provenance_permissions(self): + def can_version_flows(self): """ - Gets the provenance_permissions of this CurrentUserEntity. - Permissions for querying provenance. + Gets the can_version_flows of this CurrentUserEntity. + Whether the current user can version flows. - :return: The provenance_permissions of this CurrentUserEntity. + :return: The can_version_flows of this CurrentUserEntity. + :rtype: bool + """ + return self._can_version_flows + + @can_version_flows.setter + def can_version_flows(self, can_version_flows): + """ + Sets the can_version_flows of this CurrentUserEntity. + Whether the current user can version flows. + + :param can_version_flows: The can_version_flows of this CurrentUserEntity. + :type: bool + """ + + self._can_version_flows = can_version_flows + + @property + def component_restriction_permissions(self): + """ + Gets the component_restriction_permissions of this CurrentUserEntity. + Permissions for specific component restrictions. + + :return: The component_restriction_permissions of this CurrentUserEntity. + :rtype: list[ComponentRestrictionPermissionDTO] + """ + return self._component_restriction_permissions + + @component_restriction_permissions.setter + def component_restriction_permissions(self, component_restriction_permissions): + """ + Sets the component_restriction_permissions of this CurrentUserEntity. + Permissions for specific component restrictions. + + :param component_restriction_permissions: The component_restriction_permissions of this CurrentUserEntity. + :type: list[ComponentRestrictionPermissionDTO] + """ + + self._component_restriction_permissions = component_restriction_permissions + + @property + def controller_permissions(self): + """ + Gets the controller_permissions of this CurrentUserEntity. + + :return: The controller_permissions of this CurrentUserEntity. :rtype: PermissionsDTO """ - return self._provenance_permissions + return self._controller_permissions - @provenance_permissions.setter - def provenance_permissions(self, provenance_permissions): + @controller_permissions.setter + def controller_permissions(self, controller_permissions): """ - Sets the provenance_permissions of this CurrentUserEntity. - Permissions for querying provenance. + Sets the controller_permissions of this CurrentUserEntity. - :param provenance_permissions: The provenance_permissions of this CurrentUserEntity. + :param controller_permissions: The controller_permissions of this CurrentUserEntity. :type: PermissionsDTO """ - self._provenance_permissions = provenance_permissions + self._controller_permissions = controller_permissions @property def counters_permissions(self): """ Gets the counters_permissions of this CurrentUserEntity. - Permissions for accessing counters. :return: The counters_permissions of this CurrentUserEntity. :rtype: PermissionsDTO @@ -184,7 +206,6 @@ def counters_permissions(self): def counters_permissions(self, counters_permissions): """ Sets the counters_permissions of this CurrentUserEntity. - Permissions for accessing counters. :param counters_permissions: The counters_permissions of this CurrentUserEntity. :type: PermissionsDTO @@ -193,125 +214,118 @@ def counters_permissions(self, counters_permissions): self._counters_permissions = counters_permissions @property - def tenants_permissions(self): + def identity(self): """ - Gets the tenants_permissions of this CurrentUserEntity. - Permissions for accessing tenants. + Gets the identity of this CurrentUserEntity. + The user identity being serialized. - :return: The tenants_permissions of this CurrentUserEntity. - :rtype: PermissionsDTO + :return: The identity of this CurrentUserEntity. + :rtype: str """ - return self._tenants_permissions + return self._identity - @tenants_permissions.setter - def tenants_permissions(self, tenants_permissions): + @identity.setter + def identity(self, identity): """ - Sets the tenants_permissions of this CurrentUserEntity. - Permissions for accessing tenants. + Sets the identity of this CurrentUserEntity. + The user identity being serialized. - :param tenants_permissions: The tenants_permissions of this CurrentUserEntity. - :type: PermissionsDTO + :param identity: The identity of this CurrentUserEntity. + :type: str """ - self._tenants_permissions = tenants_permissions + self._identity = identity @property - def controller_permissions(self): + def logout_supported(self): """ - Gets the controller_permissions of this CurrentUserEntity. - Permissions for accessing the controller. + Gets the logout_supported of this CurrentUserEntity. + Whether the system is configured to support logout operations based on current user authentication status - :return: The controller_permissions of this CurrentUserEntity. - :rtype: PermissionsDTO + :return: The logout_supported of this CurrentUserEntity. + :rtype: bool """ - return self._controller_permissions + return self._logout_supported - @controller_permissions.setter - def controller_permissions(self, controller_permissions): + @logout_supported.setter + def logout_supported(self, logout_supported): """ - Sets the controller_permissions of this CurrentUserEntity. - Permissions for accessing the controller. + Sets the logout_supported of this CurrentUserEntity. + Whether the system is configured to support logout operations based on current user authentication status - :param controller_permissions: The controller_permissions of this CurrentUserEntity. - :type: PermissionsDTO + :param logout_supported: The logout_supported of this CurrentUserEntity. + :type: bool """ - self._controller_permissions = controller_permissions + self._logout_supported = logout_supported @property - def policies_permissions(self): + def parameter_context_permissions(self): """ - Gets the policies_permissions of this CurrentUserEntity. - Permissions for accessing the policies. + Gets the parameter_context_permissions of this CurrentUserEntity. - :return: The policies_permissions of this CurrentUserEntity. + :return: The parameter_context_permissions of this CurrentUserEntity. :rtype: PermissionsDTO """ - return self._policies_permissions + return self._parameter_context_permissions - @policies_permissions.setter - def policies_permissions(self, policies_permissions): + @parameter_context_permissions.setter + def parameter_context_permissions(self, parameter_context_permissions): """ - Sets the policies_permissions of this CurrentUserEntity. - Permissions for accessing the policies. + Sets the parameter_context_permissions of this CurrentUserEntity. - :param policies_permissions: The policies_permissions of this CurrentUserEntity. + :param parameter_context_permissions: The parameter_context_permissions of this CurrentUserEntity. :type: PermissionsDTO """ - self._policies_permissions = policies_permissions + self._parameter_context_permissions = parameter_context_permissions @property - def system_permissions(self): + def policies_permissions(self): """ - Gets the system_permissions of this CurrentUserEntity. - Permissions for accessing system. + Gets the policies_permissions of this CurrentUserEntity. - :return: The system_permissions of this CurrentUserEntity. + :return: The policies_permissions of this CurrentUserEntity. :rtype: PermissionsDTO """ - return self._system_permissions + return self._policies_permissions - @system_permissions.setter - def system_permissions(self, system_permissions): + @policies_permissions.setter + def policies_permissions(self, policies_permissions): """ - Sets the system_permissions of this CurrentUserEntity. - Permissions for accessing system. + Sets the policies_permissions of this CurrentUserEntity. - :param system_permissions: The system_permissions of this CurrentUserEntity. + :param policies_permissions: The policies_permissions of this CurrentUserEntity. :type: PermissionsDTO """ - self._system_permissions = system_permissions + self._policies_permissions = policies_permissions @property - def parameter_context_permissions(self): + def provenance_permissions(self): """ - Gets the parameter_context_permissions of this CurrentUserEntity. - Permissions for accessing parameter contexts. + Gets the provenance_permissions of this CurrentUserEntity. - :return: The parameter_context_permissions of this CurrentUserEntity. + :return: The provenance_permissions of this CurrentUserEntity. :rtype: PermissionsDTO """ - return self._parameter_context_permissions + return self._provenance_permissions - @parameter_context_permissions.setter - def parameter_context_permissions(self, parameter_context_permissions): + @provenance_permissions.setter + def provenance_permissions(self, provenance_permissions): """ - Sets the parameter_context_permissions of this CurrentUserEntity. - Permissions for accessing parameter contexts. + Sets the provenance_permissions of this CurrentUserEntity. - :param parameter_context_permissions: The parameter_context_permissions of this CurrentUserEntity. + :param provenance_permissions: The provenance_permissions of this CurrentUserEntity. :type: PermissionsDTO """ - self._parameter_context_permissions = parameter_context_permissions + self._provenance_permissions = provenance_permissions @property def restricted_components_permissions(self): """ Gets the restricted_components_permissions of this CurrentUserEntity. - Permissions for accessing restricted components. Note: the read permission are not used and will always be false. :return: The restricted_components_permissions of this CurrentUserEntity. :rtype: PermissionsDTO @@ -322,7 +336,6 @@ def restricted_components_permissions(self): def restricted_components_permissions(self, restricted_components_permissions): """ Sets the restricted_components_permissions of this CurrentUserEntity. - Permissions for accessing restricted components. Note: the read permission are not used and will always be false. :param restricted_components_permissions: The restricted_components_permissions of this CurrentUserEntity. :type: PermissionsDTO @@ -331,50 +344,46 @@ def restricted_components_permissions(self, restricted_components_permissions): self._restricted_components_permissions = restricted_components_permissions @property - def component_restriction_permissions(self): + def system_permissions(self): """ - Gets the component_restriction_permissions of this CurrentUserEntity. - Permissions for specific component restrictions. + Gets the system_permissions of this CurrentUserEntity. - :return: The component_restriction_permissions of this CurrentUserEntity. - :rtype: list[ComponentRestrictionPermissionDTO] + :return: The system_permissions of this CurrentUserEntity. + :rtype: PermissionsDTO """ - return self._component_restriction_permissions + return self._system_permissions - @component_restriction_permissions.setter - def component_restriction_permissions(self, component_restriction_permissions): + @system_permissions.setter + def system_permissions(self, system_permissions): """ - Sets the component_restriction_permissions of this CurrentUserEntity. - Permissions for specific component restrictions. + Sets the system_permissions of this CurrentUserEntity. - :param component_restriction_permissions: The component_restriction_permissions of this CurrentUserEntity. - :type: list[ComponentRestrictionPermissionDTO] + :param system_permissions: The system_permissions of this CurrentUserEntity. + :type: PermissionsDTO """ - self._component_restriction_permissions = component_restriction_permissions + self._system_permissions = system_permissions @property - def can_version_flows(self): + def tenants_permissions(self): """ - Gets the can_version_flows of this CurrentUserEntity. - Whether the current user can version flows. + Gets the tenants_permissions of this CurrentUserEntity. - :return: The can_version_flows of this CurrentUserEntity. - :rtype: bool + :return: The tenants_permissions of this CurrentUserEntity. + :rtype: PermissionsDTO """ - return self._can_version_flows + return self._tenants_permissions - @can_version_flows.setter - def can_version_flows(self, can_version_flows): + @tenants_permissions.setter + def tenants_permissions(self, tenants_permissions): """ - Sets the can_version_flows of this CurrentUserEntity. - Whether the current user can version flows. + Sets the tenants_permissions of this CurrentUserEntity. - :param can_version_flows: The can_version_flows of this CurrentUserEntity. - :type: bool + :param tenants_permissions: The tenants_permissions of this CurrentUserEntity. + :type: PermissionsDTO """ - self._can_version_flows = can_version_flows + self._tenants_permissions = tenants_permissions def to_dict(self): """ diff --git a/nipyapi/nifi/models/date_time_parameter.py b/nipyapi/nifi/models/date_time_parameter.py new file mode 100644 index 00000000..e7cf3953 --- /dev/null +++ b/nipyapi/nifi/models/date_time_parameter.py @@ -0,0 +1,117 @@ +""" + Apache NiFi REST API + + REST API definition for Apache NiFi web services + + OpenAPI spec version: 2.5.0 + Contact: dev@nifi.apache.org + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from pprint import pformat +import re + + +class DateTimeParameter(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 = { + 'date_time': 'datetime' } + + attribute_map = { + 'date_time': 'dateTime' } + + def __init__(self, date_time=None): + """ + DateTimeParameter - a model defined in Swagger + """ + + self._date_time = None + + if date_time is not None: + self.date_time = date_time + + @property + def date_time(self): + """ + Gets the date_time of this DateTimeParameter. + + :return: The date_time of this DateTimeParameter. + :rtype: datetime + """ + return self._date_time + + @date_time.setter + def date_time(self, date_time): + """ + Sets the date_time of this DateTimeParameter. + + :param date_time: The date_time of this DateTimeParameter. + :type: datetime + """ + + self._date_time = date_time + + 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, DateTimeParameter): + 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/defined_type.py b/nipyapi/nifi/models/defined_type.py index 7d90908b..1cbbf533 100644 --- a/nipyapi/nifi/models/defined_type.py +++ b/nipyapi/nifi/models/defined_type.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,64 +27,40 @@ class DefinedType(object): and the value is json key in definition. """ swagger_types = { - 'group': 'str', 'artifact': 'str', - 'version': 'str', - 'type': 'str', - 'type_description': 'str' - } +'group': 'str', +'type': 'str', +'type_description': 'str', +'version': 'str' } attribute_map = { - 'group': 'group', 'artifact': 'artifact', - 'version': 'version', - 'type': 'type', - 'type_description': 'typeDescription' - } +'group': 'group', +'type': 'type', +'type_description': 'typeDescription', +'version': 'version' } - def __init__(self, group=None, artifact=None, version=None, type=None, type_description=None): + def __init__(self, artifact=None, group=None, type=None, type_description=None, version=None): """ DefinedType - a model defined in Swagger """ - self._group = None self._artifact = None - self._version = None + self._group = None self._type = None self._type_description = None + self._version = None - if group is not None: - self.group = group if artifact is not None: self.artifact = artifact - if version is not None: - self.version = version - self.type = type + if group is not None: + self.group = group + if type is not None: + self.type = type if type_description is not None: self.type_description = type_description - - @property - def group(self): - """ - Gets the group of this DefinedType. - The group name of the bundle that provides the referenced type. - - :return: The group of this DefinedType. - :rtype: str - """ - return self._group - - @group.setter - def group(self, group): - """ - Sets the group of this DefinedType. - The group name of the bundle that provides the referenced type. - - :param group: The group of this DefinedType. - :type: str - """ - - self._group = group + if version is not None: + self.version = version @property def artifact(self): @@ -111,27 +86,27 @@ def artifact(self, artifact): self._artifact = artifact @property - def version(self): + def group(self): """ - Gets the version of this DefinedType. - The version of the bundle that provides the referenced type. + Gets the group of this DefinedType. + The group name of the bundle that provides the referenced type. - :return: The version of this DefinedType. + :return: The group of this DefinedType. :rtype: str """ - return self._version + return self._group - @version.setter - def version(self, version): + @group.setter + def group(self, group): """ - Sets the version of this DefinedType. - The version of the bundle that provides the referenced type. + Sets the group of this DefinedType. + The group name of the bundle that provides the referenced type. - :param version: The version of this DefinedType. + :param group: The group of this DefinedType. :type: str """ - self._version = version + self._group = group @property def type(self): @@ -153,8 +128,6 @@ def type(self, type): :param type: The type of this DefinedType. :type: str """ - if type is None: - raise ValueError("Invalid value for `type`, must not be `None`") self._type = type @@ -181,6 +154,29 @@ def type_description(self, type_description): self._type_description = type_description + @property + def version(self): + """ + Gets the version of this DefinedType. + The version of the bundle that provides the referenced type. + + :return: The version of this DefinedType. + :rtype: str + """ + return self._version + + @version.setter + def version(self, version): + """ + Sets the version of this DefinedType. + The version of the bundle that provides the referenced type. + + :param version: The version of this DefinedType. + :type: str + """ + + self._version = version + def to_dict(self): """ Returns the model properties as a dict diff --git a/nipyapi/nifi/models/difference_dto.py b/nipyapi/nifi/models/difference_dto.py index 94be13a0..f595181a 100644 --- a/nipyapi/nifi/models/difference_dto.py +++ b/nipyapi/nifi/models/difference_dto.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,73 +27,71 @@ class DifferenceDTO(object): and the value is json key in definition. """ swagger_types = { - 'difference_type': 'str', - 'difference': 'str' - } + 'difference': 'str', +'difference_type': 'str' } attribute_map = { - 'difference_type': 'differenceType', - 'difference': 'difference' - } + 'difference': 'difference', +'difference_type': 'differenceType' } - def __init__(self, difference_type=None, difference=None): + def __init__(self, difference=None, difference_type=None): """ DifferenceDTO - a model defined in Swagger """ - self._difference_type = None self._difference = None + self._difference_type = None - if difference_type is not None: - self.difference_type = difference_type if difference is not None: self.difference = difference + if difference_type is not None: + self.difference_type = difference_type @property - def difference_type(self): + def difference(self): """ - Gets the difference_type of this DifferenceDTO. - The type of difference + Gets the difference of this DifferenceDTO. + Description of the difference - :return: The difference_type of this DifferenceDTO. + :return: The difference of this DifferenceDTO. :rtype: str """ - return self._difference_type + return self._difference - @difference_type.setter - def difference_type(self, difference_type): + @difference.setter + def difference(self, difference): """ - Sets the difference_type of this DifferenceDTO. - The type of difference + Sets the difference of this DifferenceDTO. + Description of the difference - :param difference_type: The difference_type of this DifferenceDTO. + :param difference: The difference of this DifferenceDTO. :type: str """ - self._difference_type = difference_type + self._difference = difference @property - def difference(self): + def difference_type(self): """ - Gets the difference of this DifferenceDTO. - Description of the difference + Gets the difference_type of this DifferenceDTO. + The type of difference - :return: The difference of this DifferenceDTO. + :return: The difference_type of this DifferenceDTO. :rtype: str """ - return self._difference + return self._difference_type - @difference.setter - def difference(self, difference): + @difference_type.setter + def difference_type(self, difference_type): """ - Sets the difference of this DifferenceDTO. - Description of the difference + Sets the difference_type of this DifferenceDTO. + The type of difference - :param difference: The difference of this DifferenceDTO. + :param difference_type: The difference_type of this DifferenceDTO. :type: str """ - self._difference = difference + self._difference_type = difference_type def to_dict(self): """ diff --git a/nipyapi/nifi/models/dimensions_dto.py b/nipyapi/nifi/models/dimensions_dto.py index cd43c136..34822e17 100644 --- a/nipyapi/nifi/models/dimensions_dto.py +++ b/nipyapi/nifi/models/dimensions_dto.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,73 +27,71 @@ class DimensionsDTO(object): and the value is json key in definition. """ swagger_types = { - 'width': 'float', - 'height': 'float' - } + 'height': 'float', +'width': 'float' } attribute_map = { - 'width': 'width', - 'height': 'height' - } + 'height': 'height', +'width': 'width' } - def __init__(self, width=None, height=None): + def __init__(self, height=None, width=None): """ DimensionsDTO - a model defined in Swagger """ - self._width = None self._height = None + self._width = None - if width is not None: - self.width = width if height is not None: self.height = height + if width is not None: + self.width = width @property - def width(self): + def height(self): """ - Gets the width of this DimensionsDTO. - The width of the label in pixels when at a 1:1 scale. + Gets the height of this DimensionsDTO. + The height of the label in pixels when at a 1:1 scale. - :return: The width of this DimensionsDTO. + :return: The height of this DimensionsDTO. :rtype: float """ - return self._width + return self._height - @width.setter - def width(self, width): + @height.setter + def height(self, height): """ - Sets the width of this DimensionsDTO. - The width of the label in pixels when at a 1:1 scale. + Sets the height of this DimensionsDTO. + The height of the label in pixels when at a 1:1 scale. - :param width: The width of this DimensionsDTO. + :param height: The height of this DimensionsDTO. :type: float """ - self._width = width + self._height = height @property - def height(self): + def width(self): """ - Gets the height of this DimensionsDTO. - The height of the label in pixels when at a 1:1 scale. + Gets the width of this DimensionsDTO. + The width of the label in pixels when at a 1:1 scale. - :return: The height of this DimensionsDTO. + :return: The width of this DimensionsDTO. :rtype: float """ - return self._height + return self._width - @height.setter - def height(self, height): + @width.setter + def width(self, width): """ - Sets the height of this DimensionsDTO. - The height of the label in pixels when at a 1:1 scale. + Sets the width of this DimensionsDTO. + The width of the label in pixels when at a 1:1 scale. - :param height: The height of this DimensionsDTO. + :param width: The width of this DimensionsDTO. :type: float """ - self._height = height + self._width = width def to_dict(self): """ diff --git a/nipyapi/nifi/models/documented_type_dto.py b/nipyapi/nifi/models/documented_type_dto.py index 6483b732..a6e1d22d 100644 --- a/nipyapi/nifi/models/documented_type_dto.py +++ b/nipyapi/nifi/models/documented_type_dto.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,91 +27,65 @@ class DocumentedTypeDTO(object): and the value is json key in definition. """ swagger_types = { - 'type': 'str', 'bundle': 'BundleDTO', - 'controller_service_apis': 'list[ControllerServiceApiDTO]', - 'description': 'str', - 'restricted': 'bool', - 'usage_restriction': 'str', - 'explicit_restrictions': 'list[ExplicitRestrictionDTO]', - 'deprecation_reason': 'str', - 'tags': 'list[str]' - } +'controller_service_apis': 'list[ControllerServiceApiDTO]', +'deprecation_reason': 'str', +'description': 'str', +'explicit_restrictions': 'list[ExplicitRestrictionDTO]', +'restricted': 'bool', +'tags': 'list[str]', +'type': 'str', +'usage_restriction': 'str' } attribute_map = { - 'type': 'type', 'bundle': 'bundle', - 'controller_service_apis': 'controllerServiceApis', - 'description': 'description', - 'restricted': 'restricted', - 'usage_restriction': 'usageRestriction', - 'explicit_restrictions': 'explicitRestrictions', - 'deprecation_reason': 'deprecationReason', - 'tags': 'tags' - } +'controller_service_apis': 'controllerServiceApis', +'deprecation_reason': 'deprecationReason', +'description': 'description', +'explicit_restrictions': 'explicitRestrictions', +'restricted': 'restricted', +'tags': 'tags', +'type': 'type', +'usage_restriction': 'usageRestriction' } - def __init__(self, type=None, bundle=None, controller_service_apis=None, description=None, restricted=None, usage_restriction=None, explicit_restrictions=None, deprecation_reason=None, tags=None): + def __init__(self, bundle=None, controller_service_apis=None, deprecation_reason=None, description=None, explicit_restrictions=None, restricted=None, tags=None, type=None, usage_restriction=None): """ DocumentedTypeDTO - a model defined in Swagger """ - self._type = None self._bundle = None self._controller_service_apis = None + self._deprecation_reason = None self._description = None - self._restricted = None - self._usage_restriction = None self._explicit_restrictions = None - self._deprecation_reason = None + self._restricted = None self._tags = None + self._type = None + self._usage_restriction = None - if type is not None: - self.type = type if bundle is not None: self.bundle = bundle if controller_service_apis is not None: self.controller_service_apis = controller_service_apis + if deprecation_reason is not None: + self.deprecation_reason = deprecation_reason if description is not None: self.description = description - if restricted is not None: - self.restricted = restricted - if usage_restriction is not None: - self.usage_restriction = usage_restriction if explicit_restrictions is not None: self.explicit_restrictions = explicit_restrictions - if deprecation_reason is not None: - self.deprecation_reason = deprecation_reason + if restricted is not None: + self.restricted = restricted if tags is not None: self.tags = tags - - @property - def type(self): - """ - Gets the type of this DocumentedTypeDTO. - The fully qualified name of the type. - - :return: The type of this DocumentedTypeDTO. - :rtype: str - """ - return self._type - - @type.setter - def type(self, type): - """ - Sets the type of this DocumentedTypeDTO. - The fully qualified name of the type. - - :param type: The type of this DocumentedTypeDTO. - :type: str - """ - - self._type = type + if type is not None: + self.type = type + if usage_restriction is not None: + self.usage_restriction = usage_restriction @property def bundle(self): """ Gets the bundle of this DocumentedTypeDTO. - The details of the artifact that bundled this type. :return: The bundle of this DocumentedTypeDTO. :rtype: BundleDTO @@ -123,7 +96,6 @@ def bundle(self): def bundle(self, bundle): """ Sets the bundle of this DocumentedTypeDTO. - The details of the artifact that bundled this type. :param bundle: The bundle of this DocumentedTypeDTO. :type: BundleDTO @@ -155,73 +127,50 @@ def controller_service_apis(self, controller_service_apis): self._controller_service_apis = controller_service_apis @property - def description(self): + def deprecation_reason(self): """ - Gets the description of this DocumentedTypeDTO. - The description of the type. + Gets the deprecation_reason of this DocumentedTypeDTO. + The description of why the usage of this component is restricted. - :return: The description of this DocumentedTypeDTO. + :return: The deprecation_reason of this DocumentedTypeDTO. :rtype: str """ - return self._description + return self._deprecation_reason - @description.setter - def description(self, description): + @deprecation_reason.setter + def deprecation_reason(self, deprecation_reason): """ - Sets the description of this DocumentedTypeDTO. - The description of the type. + Sets the deprecation_reason of this DocumentedTypeDTO. + The description of why the usage of this component is restricted. - :param description: The description of this DocumentedTypeDTO. + :param deprecation_reason: The deprecation_reason of this DocumentedTypeDTO. :type: str """ - self._description = description - - @property - def restricted(self): - """ - Gets the restricted of this DocumentedTypeDTO. - Whether this type is restricted. - - :return: The restricted of this DocumentedTypeDTO. - :rtype: bool - """ - return self._restricted - - @restricted.setter - def restricted(self, restricted): - """ - Sets the restricted of this DocumentedTypeDTO. - Whether this type is restricted. - - :param restricted: The restricted of this DocumentedTypeDTO. - :type: bool - """ - - self._restricted = restricted + self._deprecation_reason = deprecation_reason @property - def usage_restriction(self): + def description(self): """ - Gets the usage_restriction of this DocumentedTypeDTO. - The optional description of why the usage of this component is restricted. + Gets the description of this DocumentedTypeDTO. + The description of the type. - :return: The usage_restriction of this DocumentedTypeDTO. + :return: The description of this DocumentedTypeDTO. :rtype: str """ - return self._usage_restriction + return self._description - @usage_restriction.setter - def usage_restriction(self, usage_restriction): + @description.setter + def description(self, description): """ - Sets the usage_restriction of this DocumentedTypeDTO. - The optional description of why the usage of this component is restricted. + Sets the description of this DocumentedTypeDTO. + The description of the type. - :param usage_restriction: The usage_restriction of this DocumentedTypeDTO. + :param description: The description of this DocumentedTypeDTO. :type: str """ - self._usage_restriction = usage_restriction + self._description = description @property def explicit_restrictions(self): @@ -247,27 +196,27 @@ def explicit_restrictions(self, explicit_restrictions): self._explicit_restrictions = explicit_restrictions @property - def deprecation_reason(self): + def restricted(self): """ - Gets the deprecation_reason of this DocumentedTypeDTO. - The description of why the usage of this component is restricted. + Gets the restricted of this DocumentedTypeDTO. + Whether this type is restricted. - :return: The deprecation_reason of this DocumentedTypeDTO. - :rtype: str + :return: The restricted of this DocumentedTypeDTO. + :rtype: bool """ - return self._deprecation_reason + return self._restricted - @deprecation_reason.setter - def deprecation_reason(self, deprecation_reason): + @restricted.setter + def restricted(self, restricted): """ - Sets the deprecation_reason of this DocumentedTypeDTO. - The description of why the usage of this component is restricted. + Sets the restricted of this DocumentedTypeDTO. + Whether this type is restricted. - :param deprecation_reason: The deprecation_reason of this DocumentedTypeDTO. - :type: str + :param restricted: The restricted of this DocumentedTypeDTO. + :type: bool """ - self._deprecation_reason = deprecation_reason + self._restricted = restricted @property def tags(self): @@ -292,6 +241,52 @@ def tags(self, tags): self._tags = tags + @property + def type(self): + """ + Gets the type of this DocumentedTypeDTO. + The fully qualified name of the type. + + :return: The type of this DocumentedTypeDTO. + :rtype: str + """ + return self._type + + @type.setter + def type(self, type): + """ + Sets the type of this DocumentedTypeDTO. + The fully qualified name of the type. + + :param type: The type of this DocumentedTypeDTO. + :type: str + """ + + self._type = type + + @property + def usage_restriction(self): + """ + Gets the usage_restriction of this DocumentedTypeDTO. + The optional description of why the usage of this component is restricted. + + :return: The usage_restriction of this DocumentedTypeDTO. + :rtype: str + """ + return self._usage_restriction + + @usage_restriction.setter + def usage_restriction(self, usage_restriction): + """ + Sets the usage_restriction of this DocumentedTypeDTO. + The optional description of why the usage of this component is restricted. + + :param usage_restriction: The usage_restriction of this DocumentedTypeDTO. + :type: str + """ + + self._usage_restriction = usage_restriction + def to_dict(self): """ Returns the model properties as a dict diff --git a/nipyapi/nifi/models/drop_request_dto.py b/nipyapi/nifi/models/drop_request_dto.py index 755c2709..7a79b810 100644 --- a/nipyapi/nifi/models/drop_request_dto.py +++ b/nipyapi/nifi/models/drop_request_dto.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,240 +27,238 @@ class DropRequestDTO(object): and the value is json key in definition. """ swagger_types = { - 'id': 'str', - 'uri': 'str', - 'submission_time': 'str', - 'last_updated': 'str', - 'percent_completed': 'int', - 'finished': 'bool', - 'failure_reason': 'str', - 'current_count': 'int', - 'current_size': 'int', 'current': 'str', - 'original_count': 'int', - 'original_size': 'int', - 'original': 'str', - 'dropped_count': 'int', - 'dropped_size': 'int', - 'dropped': 'str', - 'state': 'str' - } +'current_count': 'int', +'current_size': 'int', +'dropped': 'str', +'dropped_count': 'int', +'dropped_size': 'int', +'failure_reason': 'str', +'finished': 'bool', +'id': 'str', +'last_updated': 'str', +'original': 'str', +'original_count': 'int', +'original_size': 'int', +'percent_completed': 'int', +'state': 'str', +'submission_time': 'str', +'uri': 'str' } attribute_map = { - 'id': 'id', - 'uri': 'uri', - 'submission_time': 'submissionTime', - 'last_updated': 'lastUpdated', - 'percent_completed': 'percentCompleted', - 'finished': 'finished', - 'failure_reason': 'failureReason', - 'current_count': 'currentCount', - 'current_size': 'currentSize', 'current': 'current', - 'original_count': 'originalCount', - 'original_size': 'originalSize', - 'original': 'original', - 'dropped_count': 'droppedCount', - 'dropped_size': 'droppedSize', - 'dropped': 'dropped', - 'state': 'state' - } - - def __init__(self, id=None, uri=None, submission_time=None, last_updated=None, percent_completed=None, finished=None, failure_reason=None, current_count=None, current_size=None, current=None, original_count=None, original_size=None, original=None, dropped_count=None, dropped_size=None, dropped=None, state=None): +'current_count': 'currentCount', +'current_size': 'currentSize', +'dropped': 'dropped', +'dropped_count': 'droppedCount', +'dropped_size': 'droppedSize', +'failure_reason': 'failureReason', +'finished': 'finished', +'id': 'id', +'last_updated': 'lastUpdated', +'original': 'original', +'original_count': 'originalCount', +'original_size': 'originalSize', +'percent_completed': 'percentCompleted', +'state': 'state', +'submission_time': 'submissionTime', +'uri': 'uri' } + + def __init__(self, current=None, current_count=None, current_size=None, dropped=None, dropped_count=None, dropped_size=None, failure_reason=None, finished=None, id=None, last_updated=None, original=None, original_count=None, original_size=None, percent_completed=None, state=None, submission_time=None, uri=None): """ DropRequestDTO - a model defined in Swagger """ - self._id = None - self._uri = None - self._submission_time = None - self._last_updated = None - self._percent_completed = None - self._finished = None - self._failure_reason = None + self._current = None self._current_count = None self._current_size = None - self._current = None - self._original_count = None - self._original_size = None - self._original = None + self._dropped = None self._dropped_count = None self._dropped_size = None - self._dropped = None + self._failure_reason = None + self._finished = None + self._id = None + self._last_updated = None + self._original = None + self._original_count = None + self._original_size = None + self._percent_completed = None self._state = None + self._submission_time = None + self._uri = None - if id is not None: - self.id = id - if uri is not None: - self.uri = uri - if submission_time is not None: - self.submission_time = submission_time - if last_updated is not None: - self.last_updated = last_updated - if percent_completed is not None: - self.percent_completed = percent_completed - if finished is not None: - self.finished = finished - if failure_reason is not None: - self.failure_reason = failure_reason + if current is not None: + self.current = current if current_count is not None: self.current_count = current_count if current_size is not None: self.current_size = current_size - if current is not None: - self.current = current - if original_count is not None: - self.original_count = original_count - if original_size is not None: - self.original_size = original_size - if original is not None: - self.original = original + if dropped is not None: + self.dropped = dropped if dropped_count is not None: self.dropped_count = dropped_count if dropped_size is not None: self.dropped_size = dropped_size - if dropped is not None: - self.dropped = dropped + if failure_reason is not None: + self.failure_reason = failure_reason + if finished is not None: + self.finished = finished + if id is not None: + self.id = id + if last_updated is not None: + self.last_updated = last_updated + if original is not None: + self.original = original + if original_count is not None: + self.original_count = original_count + if original_size is not None: + self.original_size = original_size + if percent_completed is not None: + self.percent_completed = percent_completed if state is not None: self.state = state + if submission_time is not None: + self.submission_time = submission_time + if uri is not None: + self.uri = uri @property - def id(self): + def current(self): """ - Gets the id of this DropRequestDTO. - The id for this drop request. + Gets the current of this DropRequestDTO. + The count and size of flow files currently queued. - :return: The id of this DropRequestDTO. + :return: The current of this DropRequestDTO. :rtype: str """ - return self._id + return self._current - @id.setter - def id(self, id): + @current.setter + def current(self, current): """ - Sets the id of this DropRequestDTO. - The id for this drop request. + Sets the current of this DropRequestDTO. + The count and size of flow files currently queued. - :param id: The id of this DropRequestDTO. + :param current: The current of this DropRequestDTO. :type: str """ - self._id = id + self._current = current @property - def uri(self): + def current_count(self): """ - Gets the uri of this DropRequestDTO. - The URI for future requests to this drop request. + Gets the current_count of this DropRequestDTO. + The number of flow files currently queued. - :return: The uri of this DropRequestDTO. - :rtype: str + :return: The current_count of this DropRequestDTO. + :rtype: int """ - return self._uri + return self._current_count - @uri.setter - def uri(self, uri): + @current_count.setter + def current_count(self, current_count): """ - Sets the uri of this DropRequestDTO. - The URI for future requests to this drop request. + Sets the current_count of this DropRequestDTO. + The number of flow files currently queued. - :param uri: The uri of this DropRequestDTO. - :type: str + :param current_count: The current_count of this DropRequestDTO. + :type: int """ - self._uri = uri + self._current_count = current_count @property - def submission_time(self): + def current_size(self): """ - Gets the submission_time of this DropRequestDTO. - The timestamp when the query was submitted. + Gets the current_size of this DropRequestDTO. + The size of flow files currently queued in bytes. - :return: The submission_time of this DropRequestDTO. - :rtype: str + :return: The current_size of this DropRequestDTO. + :rtype: int """ - return self._submission_time + return self._current_size - @submission_time.setter - def submission_time(self, submission_time): + @current_size.setter + def current_size(self, current_size): """ - Sets the submission_time of this DropRequestDTO. - The timestamp when the query was submitted. + Sets the current_size of this DropRequestDTO. + The size of flow files currently queued in bytes. - :param submission_time: The submission_time of this DropRequestDTO. - :type: str + :param current_size: The current_size of this DropRequestDTO. + :type: int """ - self._submission_time = submission_time + self._current_size = current_size @property - def last_updated(self): + def dropped(self): """ - Gets the last_updated of this DropRequestDTO. - The last time this drop request was updated. + Gets the dropped of this DropRequestDTO. + The count and size of flow files that have been dropped thus far. - :return: The last_updated of this DropRequestDTO. + :return: The dropped of this DropRequestDTO. :rtype: str """ - return self._last_updated + return self._dropped - @last_updated.setter - def last_updated(self, last_updated): + @dropped.setter + def dropped(self, dropped): """ - Sets the last_updated of this DropRequestDTO. - The last time this drop request was updated. + Sets the dropped of this DropRequestDTO. + The count and size of flow files that have been dropped thus far. - :param last_updated: The last_updated of this DropRequestDTO. + :param dropped: The dropped of this DropRequestDTO. :type: str """ - self._last_updated = last_updated + self._dropped = dropped @property - def percent_completed(self): + def dropped_count(self): """ - Gets the percent_completed of this DropRequestDTO. - The current percent complete. + Gets the dropped_count of this DropRequestDTO. + The number of flow files that have been dropped thus far. - :return: The percent_completed of this DropRequestDTO. + :return: The dropped_count of this DropRequestDTO. :rtype: int """ - return self._percent_completed + return self._dropped_count - @percent_completed.setter - def percent_completed(self, percent_completed): + @dropped_count.setter + def dropped_count(self, dropped_count): """ - Sets the percent_completed of this DropRequestDTO. - The current percent complete. + Sets the dropped_count of this DropRequestDTO. + The number of flow files that have been dropped thus far. - :param percent_completed: The percent_completed of this DropRequestDTO. + :param dropped_count: The dropped_count of this DropRequestDTO. :type: int """ - self._percent_completed = percent_completed + self._dropped_count = dropped_count @property - def finished(self): + def dropped_size(self): """ - Gets the finished of this DropRequestDTO. - Whether the query has finished. + Gets the dropped_size of this DropRequestDTO. + The size of flow files that have been dropped thus far in bytes. - :return: The finished of this DropRequestDTO. - :rtype: bool + :return: The dropped_size of this DropRequestDTO. + :rtype: int """ - return self._finished + return self._dropped_size - @finished.setter - def finished(self, finished): + @dropped_size.setter + def dropped_size(self, dropped_size): """ - Sets the finished of this DropRequestDTO. - Whether the query has finished. + Sets the dropped_size of this DropRequestDTO. + The size of flow files that have been dropped thus far in bytes. - :param finished: The finished of this DropRequestDTO. - :type: bool + :param dropped_size: The dropped_size of this DropRequestDTO. + :type: int """ - self._finished = finished + self._dropped_size = dropped_size @property def failure_reason(self): @@ -287,73 +284,96 @@ def failure_reason(self, failure_reason): self._failure_reason = failure_reason @property - def current_count(self): + def finished(self): """ - Gets the current_count of this DropRequestDTO. - The number of flow files currently queued. + Gets the finished of this DropRequestDTO. + Whether the query has finished. - :return: The current_count of this DropRequestDTO. - :rtype: int + :return: The finished of this DropRequestDTO. + :rtype: bool """ - return self._current_count + return self._finished - @current_count.setter - def current_count(self, current_count): + @finished.setter + def finished(self, finished): """ - Sets the current_count of this DropRequestDTO. - The number of flow files currently queued. + Sets the finished of this DropRequestDTO. + Whether the query has finished. - :param current_count: The current_count of this DropRequestDTO. - :type: int + :param finished: The finished of this DropRequestDTO. + :type: bool """ - self._current_count = current_count + self._finished = finished @property - def current_size(self): + def id(self): """ - Gets the current_size of this DropRequestDTO. - The size of flow files currently queued in bytes. + Gets the id of this DropRequestDTO. + The id for this drop request. - :return: The current_size of this DropRequestDTO. - :rtype: int + :return: The id of this DropRequestDTO. + :rtype: str """ - return self._current_size + return self._id - @current_size.setter - def current_size(self, current_size): + @id.setter + def id(self, id): """ - Sets the current_size of this DropRequestDTO. - The size of flow files currently queued in bytes. + Sets the id of this DropRequestDTO. + The id for this drop request. - :param current_size: The current_size of this DropRequestDTO. - :type: int + :param id: The id of this DropRequestDTO. + :type: str """ - self._current_size = current_size + self._id = id @property - def current(self): + def last_updated(self): """ - Gets the current of this DropRequestDTO. - The count and size of flow files currently queued. + Gets the last_updated of this DropRequestDTO. + The last time this drop request was updated. - :return: The current of this DropRequestDTO. + :return: The last_updated of this DropRequestDTO. :rtype: str """ - return self._current + return self._last_updated - @current.setter - def current(self, current): + @last_updated.setter + def last_updated(self, last_updated): """ - Sets the current of this DropRequestDTO. - The count and size of flow files currently queued. + Sets the last_updated of this DropRequestDTO. + The last time this drop request was updated. - :param current: The current of this DropRequestDTO. + :param last_updated: The last_updated of this DropRequestDTO. :type: str """ - self._current = current + self._last_updated = last_updated + + @property + def original(self): + """ + Gets the original of this DropRequestDTO. + The count and size of flow files to be dropped as a result of this request. + + :return: The original of this DropRequestDTO. + :rtype: str + """ + return self._original + + @original.setter + def original(self, original): + """ + Sets the original of this DropRequestDTO. + The count and size of flow files to be dropped as a result of this request. + + :param original: The original of this DropRequestDTO. + :type: str + """ + + self._original = original @property def original_count(self): @@ -402,119 +422,96 @@ def original_size(self, original_size): self._original_size = original_size @property - def original(self): - """ - Gets the original of this DropRequestDTO. - The count and size of flow files to be dropped as a result of this request. - - :return: The original of this DropRequestDTO. - :rtype: str - """ - return self._original - - @original.setter - def original(self, original): - """ - Sets the original of this DropRequestDTO. - The count and size of flow files to be dropped as a result of this request. - - :param original: The original of this DropRequestDTO. - :type: str - """ - - self._original = original - - @property - def dropped_count(self): + def percent_completed(self): """ - Gets the dropped_count of this DropRequestDTO. - The number of flow files that have been dropped thus far. + Gets the percent_completed of this DropRequestDTO. + The current percent complete. - :return: The dropped_count of this DropRequestDTO. + :return: The percent_completed of this DropRequestDTO. :rtype: int """ - return self._dropped_count + return self._percent_completed - @dropped_count.setter - def dropped_count(self, dropped_count): + @percent_completed.setter + def percent_completed(self, percent_completed): """ - Sets the dropped_count of this DropRequestDTO. - The number of flow files that have been dropped thus far. + Sets the percent_completed of this DropRequestDTO. + The current percent complete. - :param dropped_count: The dropped_count of this DropRequestDTO. + :param percent_completed: The percent_completed of this DropRequestDTO. :type: int """ - self._dropped_count = dropped_count + self._percent_completed = percent_completed @property - def dropped_size(self): + def state(self): """ - Gets the dropped_size of this DropRequestDTO. - The size of flow files that have been dropped thus far in bytes. + Gets the state of this DropRequestDTO. + The current state of the drop request. - :return: The dropped_size of this DropRequestDTO. - :rtype: int + :return: The state of this DropRequestDTO. + :rtype: str """ - return self._dropped_size + return self._state - @dropped_size.setter - def dropped_size(self, dropped_size): + @state.setter + def state(self, state): """ - Sets the dropped_size of this DropRequestDTO. - The size of flow files that have been dropped thus far in bytes. + Sets the state of this DropRequestDTO. + The current state of the drop request. - :param dropped_size: The dropped_size of this DropRequestDTO. - :type: int + :param state: The state of this DropRequestDTO. + :type: str """ - self._dropped_size = dropped_size + self._state = state @property - def dropped(self): + def submission_time(self): """ - Gets the dropped of this DropRequestDTO. - The count and size of flow files that have been dropped thus far. + Gets the submission_time of this DropRequestDTO. + The timestamp when the query was submitted. - :return: The dropped of this DropRequestDTO. + :return: The submission_time of this DropRequestDTO. :rtype: str """ - return self._dropped + return self._submission_time - @dropped.setter - def dropped(self, dropped): + @submission_time.setter + def submission_time(self, submission_time): """ - Sets the dropped of this DropRequestDTO. - The count and size of flow files that have been dropped thus far. + Sets the submission_time of this DropRequestDTO. + The timestamp when the query was submitted. - :param dropped: The dropped of this DropRequestDTO. + :param submission_time: The submission_time of this DropRequestDTO. :type: str """ - self._dropped = dropped + self._submission_time = submission_time @property - def state(self): + def uri(self): """ - Gets the state of this DropRequestDTO. - The current state of the drop request. + Gets the uri of this DropRequestDTO. + The URI for future requests to this drop request. - :return: The state of this DropRequestDTO. + :return: The uri of this DropRequestDTO. :rtype: str """ - return self._state + return self._uri - @state.setter - def state(self, state): + @uri.setter + def uri(self, uri): """ - Sets the state of this DropRequestDTO. - The current state of the drop request. + Sets the uri of this DropRequestDTO. + The URI for future requests to this drop request. - :param state: The state of this DropRequestDTO. + :param uri: The uri of this DropRequestDTO. :type: str """ - self._state = state + self._uri = uri def to_dict(self): """ diff --git a/nipyapi/nifi/models/drop_request_entity.py b/nipyapi/nifi/models/drop_request_entity.py index fe73622a..c3894e69 100644 --- a/nipyapi/nifi/models/drop_request_entity.py +++ b/nipyapi/nifi/models/drop_request_entity.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,12 +27,10 @@ class DropRequestEntity(object): and the value is json key in definition. """ swagger_types = { - 'drop_request': 'DropRequestDTO' - } + 'drop_request': 'DropRequestDTO' } attribute_map = { - 'drop_request': 'dropRequest' - } + 'drop_request': 'dropRequest' } def __init__(self, drop_request=None): """ diff --git a/nipyapi/nifi/models/dynamic_property.py b/nipyapi/nifi/models/dynamic_property.py index 22ff237c..b3b5cf3d 100644 --- a/nipyapi/nifi/models/dynamic_property.py +++ b/nipyapi/nifi/models/dynamic_property.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,83 +27,35 @@ class DynamicProperty(object): and the value is json key in definition. """ swagger_types = { - 'name': 'str', - 'value': 'str', 'description': 'str', - 'expression_language_scope': 'str' - } +'expression_language_scope': 'str', +'name': 'str', +'value': 'str' } attribute_map = { - 'name': 'name', - 'value': 'value', 'description': 'description', - 'expression_language_scope': 'expressionLanguageScope' - } +'expression_language_scope': 'expressionLanguageScope', +'name': 'name', +'value': 'value' } - def __init__(self, name=None, value=None, description=None, expression_language_scope=None): + def __init__(self, description=None, expression_language_scope=None, name=None, value=None): """ DynamicProperty - a model defined in Swagger """ - self._name = None - self._value = None self._description = None self._expression_language_scope = None + self._name = None + self._value = None - if name is not None: - self.name = name - if value is not None: - self.value = value if description is not None: self.description = description if expression_language_scope is not None: self.expression_language_scope = expression_language_scope - - @property - def name(self): - """ - Gets the name of this DynamicProperty. - The description of the dynamic property name - - :return: The name of this DynamicProperty. - :rtype: str - """ - return self._name - - @name.setter - def name(self, name): - """ - Sets the name of this DynamicProperty. - The description of the dynamic property name - - :param name: The name of this DynamicProperty. - :type: str - """ - - self._name = name - - @property - def value(self): - """ - Gets the value of this DynamicProperty. - The description of the dynamic property value - - :return: The value of this DynamicProperty. - :rtype: str - """ - return self._value - - @value.setter - def value(self, value): - """ - Sets the value of this DynamicProperty. - The description of the dynamic property value - - :param value: The value of this DynamicProperty. - :type: str - """ - - self._value = value + if name is not None: + self.name = name + if value is not None: + self.value = value @property def description(self): @@ -149,7 +100,7 @@ def expression_language_scope(self, expression_language_scope): :param expression_language_scope: The expression_language_scope of this DynamicProperty. :type: str """ - allowed_values = ["NONE", "VARIABLE_REGISTRY", "FLOWFILE_ATTRIBUTES"] + 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}" @@ -158,6 +109,52 @@ def expression_language_scope(self, expression_language_scope): self._expression_language_scope = expression_language_scope + @property + def name(self): + """ + Gets the name of this DynamicProperty. + The description of the dynamic property name + + :return: The name of this DynamicProperty. + :rtype: str + """ + return self._name + + @name.setter + def name(self, name): + """ + Sets the name of this DynamicProperty. + The description of the dynamic property name + + :param name: The name of this DynamicProperty. + :type: str + """ + + self._name = name + + @property + def value(self): + """ + Gets the value of this DynamicProperty. + The description of the dynamic property value + + :return: The value of this DynamicProperty. + :rtype: str + """ + return self._value + + @value.setter + def value(self, value): + """ + Sets the value of this DynamicProperty. + The description of the dynamic property value + + :param value: The value of this DynamicProperty. + :type: str + """ + + self._value = value + def to_dict(self): """ Returns the model properties as a dict diff --git a/nipyapi/nifi/models/dynamic_relationship.py b/nipyapi/nifi/models/dynamic_relationship.py index 757e264a..cb9b3613 100644 --- a/nipyapi/nifi/models/dynamic_relationship.py +++ b/nipyapi/nifi/models/dynamic_relationship.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,73 +27,71 @@ class DynamicRelationship(object): and the value is json key in definition. """ swagger_types = { - 'name': 'str', - 'description': 'str' - } + 'description': 'str', +'name': 'str' } attribute_map = { - 'name': 'name', - 'description': 'description' - } + 'description': 'description', +'name': 'name' } - def __init__(self, name=None, description=None): + def __init__(self, description=None, name=None): """ DynamicRelationship - a model defined in Swagger """ - self._name = None self._description = None + self._name = None - if name is not None: - self.name = name if description is not None: self.description = description + if name is not None: + self.name = name @property - def name(self): + def description(self): """ - Gets the name of this DynamicRelationship. - The description of the dynamic relationship name + Gets the description of this DynamicRelationship. + The description of the dynamic relationship - :return: The name of this DynamicRelationship. + :return: The description of this DynamicRelationship. :rtype: str """ - return self._name + return self._description - @name.setter - def name(self, name): + @description.setter + def description(self, description): """ - Sets the name of this DynamicRelationship. - The description of the dynamic relationship name + Sets the description of this DynamicRelationship. + The description of the dynamic relationship - :param name: The name of this DynamicRelationship. + :param description: The description of this DynamicRelationship. :type: str """ - self._name = name + self._description = description @property - def description(self): + def name(self): """ - Gets the description of this DynamicRelationship. - The description of the dynamic relationship + Gets the name of this DynamicRelationship. + The description of the dynamic relationship name - :return: The description of this DynamicRelationship. + :return: The name of this DynamicRelationship. :rtype: str """ - return self._description + return self._name - @description.setter - def description(self, description): + @name.setter + def name(self, name): """ - Sets the description of this DynamicRelationship. - The description of the dynamic relationship + Sets the name of this DynamicRelationship. + The description of the dynamic relationship name - :param description: The description of this DynamicRelationship. + :param name: The name of this DynamicRelationship. :type: str """ - self._description = description + self._name = name def to_dict(self): """ diff --git a/nipyapi/nifi/models/explicit_restriction_dto.py b/nipyapi/nifi/models/explicit_restriction_dto.py index 3e4f5d1c..d36786cd 100644 --- a/nipyapi/nifi/models/explicit_restriction_dto.py +++ b/nipyapi/nifi/models/explicit_restriction_dto.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,50 +27,25 @@ class ExplicitRestrictionDTO(object): and the value is json key in definition. """ swagger_types = { - 'required_permission': 'RequiredPermissionDTO', - 'explanation': 'str' - } + 'explanation': 'str', +'required_permission': 'RequiredPermissionDTO' } attribute_map = { - 'required_permission': 'requiredPermission', - 'explanation': 'explanation' - } + 'explanation': 'explanation', +'required_permission': 'requiredPermission' } - def __init__(self, required_permission=None, explanation=None): + def __init__(self, explanation=None, required_permission=None): """ ExplicitRestrictionDTO - a model defined in Swagger """ - self._required_permission = None self._explanation = None + self._required_permission = None - if required_permission is not None: - self.required_permission = required_permission if explanation is not None: self.explanation = explanation - - @property - def required_permission(self): - """ - Gets the required_permission of this ExplicitRestrictionDTO. - The required permission necessary for this restriction. - - :return: The required_permission of this ExplicitRestrictionDTO. - :rtype: RequiredPermissionDTO - """ - return self._required_permission - - @required_permission.setter - def required_permission(self, required_permission): - """ - Sets the required_permission of this ExplicitRestrictionDTO. - The required permission necessary for this restriction. - - :param required_permission: The required_permission of this ExplicitRestrictionDTO. - :type: RequiredPermissionDTO - """ - - self._required_permission = required_permission + if required_permission is not None: + self.required_permission = required_permission @property def explanation(self): @@ -96,6 +70,27 @@ def explanation(self, explanation): self._explanation = explanation + @property + def required_permission(self): + """ + Gets the required_permission of this ExplicitRestrictionDTO. + + :return: The required_permission of this ExplicitRestrictionDTO. + :rtype: RequiredPermissionDTO + """ + return self._required_permission + + @required_permission.setter + def required_permission(self, required_permission): + """ + Sets the required_permission of this ExplicitRestrictionDTO. + + :param required_permission: The required_permission of this ExplicitRestrictionDTO. + :type: RequiredPermissionDTO + """ + + self._required_permission = required_permission + def to_dict(self): """ Returns the model properties as a dict diff --git a/nipyapi/nifi/models/external_controller_service_reference.py b/nipyapi/nifi/models/external_controller_service_reference.py index b61f0bff..486df14d 100644 --- a/nipyapi/nifi/models/external_controller_service_reference.py +++ b/nipyapi/nifi/models/external_controller_service_reference.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -29,13 +28,11 @@ class ExternalControllerServiceReference(object): """ swagger_types = { 'identifier': 'str', - 'name': 'str' - } +'name': 'str' } attribute_map = { 'identifier': 'identifier', - 'name': 'name' - } +'name': 'name' } def __init__(self, identifier=None, name=None): """ diff --git a/nipyapi/nifi/models/flow_analysis_result_entity.py b/nipyapi/nifi/models/flow_analysis_result_entity.py new file mode 100644 index 00000000..9b407edb --- /dev/null +++ b/nipyapi/nifi/models/flow_analysis_result_entity.py @@ -0,0 +1,169 @@ +""" + Apache NiFi REST API + + REST API definition for Apache NiFi web services + + OpenAPI spec version: 2.5.0 + Contact: dev@nifi.apache.org + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from pprint import pformat +import re + + +class FlowAnalysisResultEntity(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 = { + 'flow_analysis_pending': 'bool', +'rule_violations': 'list[FlowAnalysisRuleViolationDTO]', +'rules': 'list[FlowAnalysisRuleDTO]' } + + attribute_map = { + 'flow_analysis_pending': 'flowAnalysisPending', +'rule_violations': 'ruleViolations', +'rules': 'rules' } + + def __init__(self, flow_analysis_pending=None, rule_violations=None, rules=None): + """ + FlowAnalysisResultEntity - a model defined in Swagger + """ + + self._flow_analysis_pending = None + self._rule_violations = None + self._rules = None + + if flow_analysis_pending is not None: + self.flow_analysis_pending = flow_analysis_pending + if rule_violations is not None: + self.rule_violations = rule_violations + if rules is not None: + self.rules = rules + + @property + def flow_analysis_pending(self): + """ + Gets the flow_analysis_pending of this FlowAnalysisResultEntity. + + :return: The flow_analysis_pending of this FlowAnalysisResultEntity. + :rtype: bool + """ + return self._flow_analysis_pending + + @flow_analysis_pending.setter + def flow_analysis_pending(self, flow_analysis_pending): + """ + Sets the flow_analysis_pending of this FlowAnalysisResultEntity. + + :param flow_analysis_pending: The flow_analysis_pending of this FlowAnalysisResultEntity. + :type: bool + """ + + self._flow_analysis_pending = flow_analysis_pending + + @property + def rule_violations(self): + """ + Gets the rule_violations of this FlowAnalysisResultEntity. + + :return: The rule_violations of this FlowAnalysisResultEntity. + :rtype: list[FlowAnalysisRuleViolationDTO] + """ + return self._rule_violations + + @rule_violations.setter + def rule_violations(self, rule_violations): + """ + Sets the rule_violations of this FlowAnalysisResultEntity. + + :param rule_violations: The rule_violations of this FlowAnalysisResultEntity. + :type: list[FlowAnalysisRuleViolationDTO] + """ + + self._rule_violations = rule_violations + + @property + def rules(self): + """ + Gets the rules of this FlowAnalysisResultEntity. + + :return: The rules of this FlowAnalysisResultEntity. + :rtype: list[FlowAnalysisRuleDTO] + """ + return self._rules + + @rules.setter + def rules(self, rules): + """ + Sets the rules of this FlowAnalysisResultEntity. + + :param rules: The rules of this FlowAnalysisResultEntity. + :type: list[FlowAnalysisRuleDTO] + """ + + self._rules = rules + + 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, FlowAnalysisResultEntity): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """ + Returns true if both objects are not equal + """ + return not self == other diff --git a/nipyapi/nifi/models/flow_analysis_rule_definition.py b/nipyapi/nifi/models/flow_analysis_rule_definition.py new file mode 100644 index 00000000..7c847dd1 --- /dev/null +++ b/nipyapi/nifi/models/flow_analysis_rule_definition.py @@ -0,0 +1,703 @@ +""" + Apache NiFi REST API + + REST API definition for Apache NiFi web services + + OpenAPI spec version: 2.5.0 + Contact: dev@nifi.apache.org + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from pprint import pformat +import re + + +class FlowAnalysisRuleDefinition(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 = { + 'additional_details': 'bool', +'artifact': 'str', +'build_info': 'BuildInfo', +'deprecated': 'bool', +'deprecation_alternatives': 'list[str]', +'deprecation_reason': 'str', +'dynamic_properties': 'list[DynamicProperty]', +'explicit_restrictions': 'list[Restriction]', +'group': 'str', +'property_descriptors': 'dict(str, PropertyDescriptor)', +'provided_api_implementations': 'list[DefinedType]', +'restricted': 'bool', +'restricted_explanation': 'str', +'see_also': 'list[str]', +'stateful': 'Stateful', +'supports_dynamic_properties': 'bool', +'supports_sensitive_dynamic_properties': 'bool', +'system_resource_considerations': 'list[SystemResourceConsideration]', +'tags': 'list[str]', +'type': 'str', +'type_description': 'str', +'version': 'str' } + + attribute_map = { + 'additional_details': 'additionalDetails', +'artifact': 'artifact', +'build_info': 'buildInfo', +'deprecated': 'deprecated', +'deprecation_alternatives': 'deprecationAlternatives', +'deprecation_reason': 'deprecationReason', +'dynamic_properties': 'dynamicProperties', +'explicit_restrictions': 'explicitRestrictions', +'group': 'group', +'property_descriptors': 'propertyDescriptors', +'provided_api_implementations': 'providedApiImplementations', +'restricted': 'restricted', +'restricted_explanation': 'restrictedExplanation', +'see_also': 'seeAlso', +'stateful': 'stateful', +'supports_dynamic_properties': 'supportsDynamicProperties', +'supports_sensitive_dynamic_properties': 'supportsSensitiveDynamicProperties', +'system_resource_considerations': 'systemResourceConsiderations', +'tags': 'tags', +'type': 'type', +'type_description': 'typeDescription', +'version': 'version' } + + def __init__(self, additional_details=None, artifact=None, build_info=None, deprecated=None, deprecation_alternatives=None, deprecation_reason=None, dynamic_properties=None, explicit_restrictions=None, group=None, property_descriptors=None, provided_api_implementations=None, restricted=None, restricted_explanation=None, see_also=None, stateful=None, supports_dynamic_properties=None, supports_sensitive_dynamic_properties=None, system_resource_considerations=None, tags=None, type=None, type_description=None, version=None): + """ + FlowAnalysisRuleDefinition - a model defined in Swagger + """ + + self._additional_details = None + self._artifact = None + self._build_info = None + self._deprecated = None + self._deprecation_alternatives = None + self._deprecation_reason = None + self._dynamic_properties = None + self._explicit_restrictions = None + self._group = None + self._property_descriptors = None + self._provided_api_implementations = None + self._restricted = None + self._restricted_explanation = None + self._see_also = None + self._stateful = None + self._supports_dynamic_properties = None + self._supports_sensitive_dynamic_properties = None + self._system_resource_considerations = None + self._tags = None + self._type = None + self._type_description = None + self._version = None + + if additional_details is not None: + self.additional_details = additional_details + if artifact is not None: + self.artifact = artifact + if build_info is not None: + self.build_info = build_info + if deprecated is not None: + self.deprecated = deprecated + if deprecation_alternatives is not None: + self.deprecation_alternatives = deprecation_alternatives + if deprecation_reason is not None: + self.deprecation_reason = deprecation_reason + if dynamic_properties is not None: + self.dynamic_properties = dynamic_properties + if explicit_restrictions is not None: + self.explicit_restrictions = explicit_restrictions + if group is not None: + self.group = group + if property_descriptors is not None: + self.property_descriptors = property_descriptors + if provided_api_implementations is not None: + self.provided_api_implementations = provided_api_implementations + if restricted is not None: + self.restricted = restricted + if restricted_explanation is not None: + self.restricted_explanation = restricted_explanation + if see_also is not None: + self.see_also = see_also + if stateful is not None: + self.stateful = stateful + if supports_dynamic_properties is not None: + self.supports_dynamic_properties = supports_dynamic_properties + if supports_sensitive_dynamic_properties is not None: + self.supports_sensitive_dynamic_properties = supports_sensitive_dynamic_properties + if system_resource_considerations is not None: + self.system_resource_considerations = system_resource_considerations + if tags is not None: + self.tags = tags + if type is not None: + self.type = type + if type_description is not None: + self.type_description = type_description + if version is not None: + self.version = version + + @property + def additional_details(self): + """ + Gets the additional_details of this FlowAnalysisRuleDefinition. + Indicates if the component has additional details documentation + + :return: The additional_details of this FlowAnalysisRuleDefinition. + :rtype: bool + """ + return self._additional_details + + @additional_details.setter + def additional_details(self, additional_details): + """ + Sets the additional_details of this FlowAnalysisRuleDefinition. + Indicates if the component has additional details documentation + + :param additional_details: The additional_details of this FlowAnalysisRuleDefinition. + :type: bool + """ + + self._additional_details = additional_details + + @property + def artifact(self): + """ + Gets the artifact of this FlowAnalysisRuleDefinition. + The artifact name of the bundle that provides the referenced type. + + :return: The artifact of this FlowAnalysisRuleDefinition. + :rtype: str + """ + return self._artifact + + @artifact.setter + def artifact(self, artifact): + """ + Sets the artifact of this FlowAnalysisRuleDefinition. + The artifact name of the bundle that provides the referenced type. + + :param artifact: The artifact of this FlowAnalysisRuleDefinition. + :type: str + """ + + self._artifact = artifact + + @property + def build_info(self): + """ + Gets the build_info of this FlowAnalysisRuleDefinition. + + :return: The build_info of this FlowAnalysisRuleDefinition. + :rtype: BuildInfo + """ + return self._build_info + + @build_info.setter + def build_info(self, build_info): + """ + Sets the build_info of this FlowAnalysisRuleDefinition. + + :param build_info: The build_info of this FlowAnalysisRuleDefinition. + :type: BuildInfo + """ + + self._build_info = build_info + + @property + def deprecated(self): + """ + Gets the deprecated of this FlowAnalysisRuleDefinition. + Whether or not the component has been deprecated + + :return: The deprecated of this FlowAnalysisRuleDefinition. + :rtype: bool + """ + return self._deprecated + + @deprecated.setter + def deprecated(self, deprecated): + """ + Sets the deprecated of this FlowAnalysisRuleDefinition. + Whether or not the component has been deprecated + + :param deprecated: The deprecated of this FlowAnalysisRuleDefinition. + :type: bool + """ + + self._deprecated = deprecated + + @property + def deprecation_alternatives(self): + """ + Gets the deprecation_alternatives of this FlowAnalysisRuleDefinition. + If this component has been deprecated, this optional field provides alternatives to use + + :return: The deprecation_alternatives of this FlowAnalysisRuleDefinition. + :rtype: list[str] + """ + return self._deprecation_alternatives + + @deprecation_alternatives.setter + def deprecation_alternatives(self, deprecation_alternatives): + """ + Sets the deprecation_alternatives of this FlowAnalysisRuleDefinition. + If this component has been deprecated, this optional field provides alternatives to use + + :param deprecation_alternatives: The deprecation_alternatives of this FlowAnalysisRuleDefinition. + :type: list[str] + """ + + self._deprecation_alternatives = deprecation_alternatives + + @property + def deprecation_reason(self): + """ + Gets the deprecation_reason of this FlowAnalysisRuleDefinition. + If this component has been deprecated, this optional field can be used to provide an explanation + + :return: The deprecation_reason of this FlowAnalysisRuleDefinition. + :rtype: str + """ + return self._deprecation_reason + + @deprecation_reason.setter + def deprecation_reason(self, deprecation_reason): + """ + Sets the deprecation_reason of this FlowAnalysisRuleDefinition. + If this component has been deprecated, this optional field can be used to provide an explanation + + :param deprecation_reason: The deprecation_reason of this FlowAnalysisRuleDefinition. + :type: str + """ + + self._deprecation_reason = deprecation_reason + + @property + def dynamic_properties(self): + """ + Gets the dynamic_properties of this FlowAnalysisRuleDefinition. + Describes the dynamic properties supported by this component + + :return: The dynamic_properties of this FlowAnalysisRuleDefinition. + :rtype: list[DynamicProperty] + """ + return self._dynamic_properties + + @dynamic_properties.setter + def dynamic_properties(self, dynamic_properties): + """ + Sets the dynamic_properties of this FlowAnalysisRuleDefinition. + Describes the dynamic properties supported by this component + + :param dynamic_properties: The dynamic_properties of this FlowAnalysisRuleDefinition. + :type: list[DynamicProperty] + """ + + self._dynamic_properties = dynamic_properties + + @property + def explicit_restrictions(self): + """ + Gets the explicit_restrictions of this FlowAnalysisRuleDefinition. + Explicit restrictions that indicate a require permission to use the component + + :return: The explicit_restrictions of this FlowAnalysisRuleDefinition. + :rtype: list[Restriction] + """ + return self._explicit_restrictions + + @explicit_restrictions.setter + def explicit_restrictions(self, explicit_restrictions): + """ + Sets the explicit_restrictions of this FlowAnalysisRuleDefinition. + Explicit restrictions that indicate a require permission to use the component + + :param explicit_restrictions: The explicit_restrictions of this FlowAnalysisRuleDefinition. + :type: list[Restriction] + """ + + self._explicit_restrictions = explicit_restrictions + + @property + def group(self): + """ + Gets the group of this FlowAnalysisRuleDefinition. + The group name of the bundle that provides the referenced type. + + :return: The group of this FlowAnalysisRuleDefinition. + :rtype: str + """ + return self._group + + @group.setter + def group(self, group): + """ + Sets the group of this FlowAnalysisRuleDefinition. + The group name of the bundle that provides the referenced type. + + :param group: The group of this FlowAnalysisRuleDefinition. + :type: str + """ + + self._group = group + + @property + def property_descriptors(self): + """ + Gets the property_descriptors of this FlowAnalysisRuleDefinition. + Descriptions of configuration properties applicable to this component. + + :return: The property_descriptors of this FlowAnalysisRuleDefinition. + :rtype: dict(str, PropertyDescriptor) + """ + return self._property_descriptors + + @property_descriptors.setter + def property_descriptors(self, property_descriptors): + """ + Sets the property_descriptors of this FlowAnalysisRuleDefinition. + Descriptions of configuration properties applicable to this component. + + :param property_descriptors: The property_descriptors of this FlowAnalysisRuleDefinition. + :type: dict(str, PropertyDescriptor) + """ + + self._property_descriptors = property_descriptors + + @property + def provided_api_implementations(self): + """ + Gets the provided_api_implementations of this FlowAnalysisRuleDefinition. + If this type represents a provider for an interface, this lists the APIs it implements + + :return: The provided_api_implementations of this FlowAnalysisRuleDefinition. + :rtype: list[DefinedType] + """ + return self._provided_api_implementations + + @provided_api_implementations.setter + def provided_api_implementations(self, provided_api_implementations): + """ + Sets the provided_api_implementations of this FlowAnalysisRuleDefinition. + If this type represents a provider for an interface, this lists the APIs it implements + + :param provided_api_implementations: The provided_api_implementations of this FlowAnalysisRuleDefinition. + :type: list[DefinedType] + """ + + self._provided_api_implementations = provided_api_implementations + + @property + def restricted(self): + """ + Gets the restricted of this FlowAnalysisRuleDefinition. + Whether or not the component has a general restriction + + :return: The restricted of this FlowAnalysisRuleDefinition. + :rtype: bool + """ + return self._restricted + + @restricted.setter + def restricted(self, restricted): + """ + Sets the restricted of this FlowAnalysisRuleDefinition. + Whether or not the component has a general restriction + + :param restricted: The restricted of this FlowAnalysisRuleDefinition. + :type: bool + """ + + self._restricted = restricted + + @property + def restricted_explanation(self): + """ + Gets the restricted_explanation of this FlowAnalysisRuleDefinition. + An optional description of the general restriction + + :return: The restricted_explanation of this FlowAnalysisRuleDefinition. + :rtype: str + """ + return self._restricted_explanation + + @restricted_explanation.setter + def restricted_explanation(self, restricted_explanation): + """ + Sets the restricted_explanation of this FlowAnalysisRuleDefinition. + An optional description of the general restriction + + :param restricted_explanation: The restricted_explanation of this FlowAnalysisRuleDefinition. + :type: str + """ + + self._restricted_explanation = restricted_explanation + + @property + def see_also(self): + """ + Gets the see_also of this FlowAnalysisRuleDefinition. + The names of other component types that may be related + + :return: The see_also of this FlowAnalysisRuleDefinition. + :rtype: list[str] + """ + return self._see_also + + @see_also.setter + def see_also(self, see_also): + """ + Sets the see_also of this FlowAnalysisRuleDefinition. + The names of other component types that may be related + + :param see_also: The see_also of this FlowAnalysisRuleDefinition. + :type: list[str] + """ + + self._see_also = see_also + + @property + def stateful(self): + """ + Gets the stateful of this FlowAnalysisRuleDefinition. + + :return: The stateful of this FlowAnalysisRuleDefinition. + :rtype: Stateful + """ + return self._stateful + + @stateful.setter + def stateful(self, stateful): + """ + Sets the stateful of this FlowAnalysisRuleDefinition. + + :param stateful: The stateful of this FlowAnalysisRuleDefinition. + :type: Stateful + """ + + self._stateful = stateful + + @property + def supports_dynamic_properties(self): + """ + Gets the supports_dynamic_properties of this FlowAnalysisRuleDefinition. + Whether or not this component makes use of dynamic (user-set) properties. + + :return: The supports_dynamic_properties of this FlowAnalysisRuleDefinition. + :rtype: bool + """ + return self._supports_dynamic_properties + + @supports_dynamic_properties.setter + def supports_dynamic_properties(self, supports_dynamic_properties): + """ + Sets the supports_dynamic_properties of this FlowAnalysisRuleDefinition. + Whether or not this component makes use of dynamic (user-set) properties. + + :param supports_dynamic_properties: The supports_dynamic_properties of this FlowAnalysisRuleDefinition. + :type: bool + """ + + self._supports_dynamic_properties = supports_dynamic_properties + + @property + def supports_sensitive_dynamic_properties(self): + """ + Gets the supports_sensitive_dynamic_properties of this FlowAnalysisRuleDefinition. + Whether or not this component makes use of sensitive dynamic (user-set) properties. + + :return: The supports_sensitive_dynamic_properties of this FlowAnalysisRuleDefinition. + :rtype: bool + """ + return self._supports_sensitive_dynamic_properties + + @supports_sensitive_dynamic_properties.setter + def supports_sensitive_dynamic_properties(self, supports_sensitive_dynamic_properties): + """ + Sets the supports_sensitive_dynamic_properties of this FlowAnalysisRuleDefinition. + Whether or not this component makes use of sensitive dynamic (user-set) properties. + + :param supports_sensitive_dynamic_properties: The supports_sensitive_dynamic_properties of this FlowAnalysisRuleDefinition. + :type: bool + """ + + self._supports_sensitive_dynamic_properties = supports_sensitive_dynamic_properties + + @property + def system_resource_considerations(self): + """ + Gets the system_resource_considerations of this FlowAnalysisRuleDefinition. + The system resource considerations for the given component + + :return: The system_resource_considerations of this FlowAnalysisRuleDefinition. + :rtype: list[SystemResourceConsideration] + """ + return self._system_resource_considerations + + @system_resource_considerations.setter + def system_resource_considerations(self, system_resource_considerations): + """ + Sets the system_resource_considerations of this FlowAnalysisRuleDefinition. + The system resource considerations for the given component + + :param system_resource_considerations: The system_resource_considerations of this FlowAnalysisRuleDefinition. + :type: list[SystemResourceConsideration] + """ + + self._system_resource_considerations = system_resource_considerations + + @property + def tags(self): + """ + Gets the tags of this FlowAnalysisRuleDefinition. + The tags associated with this type + + :return: The tags of this FlowAnalysisRuleDefinition. + :rtype: list[str] + """ + return self._tags + + @tags.setter + def tags(self, tags): + """ + Sets the tags of this FlowAnalysisRuleDefinition. + The tags associated with this type + + :param tags: The tags of this FlowAnalysisRuleDefinition. + :type: list[str] + """ + + self._tags = tags + + @property + def type(self): + """ + Gets the type of this FlowAnalysisRuleDefinition. + The fully-qualified class type + + :return: The type of this FlowAnalysisRuleDefinition. + :rtype: str + """ + return self._type + + @type.setter + def type(self, type): + """ + Sets the type of this FlowAnalysisRuleDefinition. + The fully-qualified class type + + :param type: The type of this FlowAnalysisRuleDefinition. + :type: str + """ + + self._type = type + + @property + def type_description(self): + """ + Gets the type_description of this FlowAnalysisRuleDefinition. + The description of the type. + + :return: The type_description of this FlowAnalysisRuleDefinition. + :rtype: str + """ + return self._type_description + + @type_description.setter + def type_description(self, type_description): + """ + Sets the type_description of this FlowAnalysisRuleDefinition. + The description of the type. + + :param type_description: The type_description of this FlowAnalysisRuleDefinition. + :type: str + """ + + self._type_description = type_description + + @property + def version(self): + """ + Gets the version of this FlowAnalysisRuleDefinition. + The version of the bundle that provides the referenced type. + + :return: The version of this FlowAnalysisRuleDefinition. + :rtype: str + """ + return self._version + + @version.setter + def version(self, version): + """ + Sets the version of this FlowAnalysisRuleDefinition. + The version of the bundle that provides the referenced type. + + :param version: The version of this FlowAnalysisRuleDefinition. + :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, FlowAnalysisRuleDefinition): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """ + Returns true if both objects are not equal + """ + return not self == other diff --git a/nipyapi/nifi/models/flow_analysis_rule_dto.py b/nipyapi/nifi/models/flow_analysis_rule_dto.py new file mode 100644 index 00000000..6413dbe6 --- /dev/null +++ b/nipyapi/nifi/models/flow_analysis_rule_dto.py @@ -0,0 +1,687 @@ +""" + Apache NiFi REST API + + REST API definition for Apache NiFi web services + + OpenAPI spec version: 2.5.0 + Contact: dev@nifi.apache.org + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from pprint import pformat +import re + + +class FlowAnalysisRuleDTO(object): + """ + NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. + """ + + + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'bundle': 'BundleDTO', +'comments': 'str', +'deprecated': 'bool', +'descriptors': 'dict(str, PropertyDescriptorDTO)', +'enforcement_policy': 'str', +'extension_missing': 'bool', +'id': 'str', +'multiple_versions_available': 'bool', +'name': 'str', +'parent_group_id': 'str', +'persists_state': 'bool', +'position': 'PositionDTO', +'properties': 'dict(str, str)', +'restricted': 'bool', +'sensitive_dynamic_property_names': 'list[str]', +'state': 'str', +'supports_sensitive_dynamic_properties': 'bool', +'type': 'str', +'validation_errors': 'list[str]', +'validation_status': 'str', +'versioned_component_id': 'str' } + + attribute_map = { + 'bundle': 'bundle', +'comments': 'comments', +'deprecated': 'deprecated', +'descriptors': 'descriptors', +'enforcement_policy': 'enforcementPolicy', +'extension_missing': 'extensionMissing', +'id': 'id', +'multiple_versions_available': 'multipleVersionsAvailable', +'name': 'name', +'parent_group_id': 'parentGroupId', +'persists_state': 'persistsState', +'position': 'position', +'properties': 'properties', +'restricted': 'restricted', +'sensitive_dynamic_property_names': 'sensitiveDynamicPropertyNames', +'state': 'state', +'supports_sensitive_dynamic_properties': 'supportsSensitiveDynamicProperties', +'type': 'type', +'validation_errors': 'validationErrors', +'validation_status': 'validationStatus', +'versioned_component_id': 'versionedComponentId' } + + def __init__(self, bundle=None, comments=None, deprecated=None, descriptors=None, enforcement_policy=None, extension_missing=None, id=None, multiple_versions_available=None, name=None, parent_group_id=None, persists_state=None, position=None, properties=None, restricted=None, sensitive_dynamic_property_names=None, state=None, supports_sensitive_dynamic_properties=None, type=None, validation_errors=None, validation_status=None, versioned_component_id=None): + """ + FlowAnalysisRuleDTO - a model defined in Swagger + """ + + self._bundle = None + self._comments = None + self._deprecated = None + self._descriptors = None + self._enforcement_policy = None + self._extension_missing = None + self._id = None + self._multiple_versions_available = None + self._name = None + self._parent_group_id = None + self._persists_state = None + self._position = None + self._properties = None + self._restricted = None + self._sensitive_dynamic_property_names = None + self._state = None + self._supports_sensitive_dynamic_properties = None + self._type = None + self._validation_errors = None + self._validation_status = None + self._versioned_component_id = None + + if bundle is not None: + self.bundle = bundle + if comments is not None: + self.comments = comments + if deprecated is not None: + self.deprecated = deprecated + if descriptors is not None: + self.descriptors = descriptors + if enforcement_policy is not None: + self.enforcement_policy = enforcement_policy + if extension_missing is not None: + self.extension_missing = extension_missing + if id is not None: + self.id = id + if multiple_versions_available is not None: + self.multiple_versions_available = multiple_versions_available + if name is not None: + self.name = name + if parent_group_id is not None: + self.parent_group_id = parent_group_id + if persists_state is not None: + self.persists_state = persists_state + if position is not None: + self.position = position + if properties is not None: + self.properties = properties + if restricted is not None: + self.restricted = restricted + if sensitive_dynamic_property_names is not None: + self.sensitive_dynamic_property_names = sensitive_dynamic_property_names + if state is not None: + self.state = state + if supports_sensitive_dynamic_properties is not None: + self.supports_sensitive_dynamic_properties = supports_sensitive_dynamic_properties + if type is not None: + self.type = type + if validation_errors is not None: + self.validation_errors = validation_errors + if validation_status is not None: + self.validation_status = validation_status + if versioned_component_id is not None: + self.versioned_component_id = versioned_component_id + + @property + def bundle(self): + """ + Gets the bundle of this FlowAnalysisRuleDTO. + + :return: The bundle of this FlowAnalysisRuleDTO. + :rtype: BundleDTO + """ + return self._bundle + + @bundle.setter + def bundle(self, bundle): + """ + Sets the bundle of this FlowAnalysisRuleDTO. + + :param bundle: The bundle of this FlowAnalysisRuleDTO. + :type: BundleDTO + """ + + self._bundle = bundle + + @property + def comments(self): + """ + Gets the comments of this FlowAnalysisRuleDTO. + The comments of the flow analysis rule. + + :return: The comments of this FlowAnalysisRuleDTO. + :rtype: str + """ + return self._comments + + @comments.setter + def comments(self, comments): + """ + Sets the comments of this FlowAnalysisRuleDTO. + The comments of the flow analysis rule. + + :param comments: The comments of this FlowAnalysisRuleDTO. + :type: str + """ + + self._comments = comments + + @property + def deprecated(self): + """ + Gets the deprecated of this FlowAnalysisRuleDTO. + Whether the flow analysis rule has been deprecated. + + :return: The deprecated of this FlowAnalysisRuleDTO. + :rtype: bool + """ + return self._deprecated + + @deprecated.setter + def deprecated(self, deprecated): + """ + Sets the deprecated of this FlowAnalysisRuleDTO. + Whether the flow analysis rule has been deprecated. + + :param deprecated: The deprecated of this FlowAnalysisRuleDTO. + :type: bool + """ + + self._deprecated = deprecated + + @property + def descriptors(self): + """ + Gets the descriptors of this FlowAnalysisRuleDTO. + The descriptors for the flow analysis rules properties. + + :return: The descriptors of this FlowAnalysisRuleDTO. + :rtype: dict(str, PropertyDescriptorDTO) + """ + return self._descriptors + + @descriptors.setter + def descriptors(self, descriptors): + """ + Sets the descriptors of this FlowAnalysisRuleDTO. + The descriptors for the flow analysis rules properties. + + :param descriptors: The descriptors of this FlowAnalysisRuleDTO. + :type: dict(str, PropertyDescriptorDTO) + """ + + self._descriptors = descriptors + + @property + def enforcement_policy(self): + """ + Gets the enforcement_policy of this FlowAnalysisRuleDTO. + Enforcement Policy. + + :return: The enforcement_policy of this FlowAnalysisRuleDTO. + :rtype: str + """ + return self._enforcement_policy + + @enforcement_policy.setter + def enforcement_policy(self, enforcement_policy): + """ + Sets the enforcement_policy of this FlowAnalysisRuleDTO. + Enforcement Policy. + + :param enforcement_policy: The enforcement_policy of this FlowAnalysisRuleDTO. + :type: str + """ + + self._enforcement_policy = enforcement_policy + + @property + def extension_missing(self): + """ + Gets the extension_missing of this FlowAnalysisRuleDTO. + Whether the underlying extension is missing. + + :return: The extension_missing of this FlowAnalysisRuleDTO. + :rtype: bool + """ + return self._extension_missing + + @extension_missing.setter + def extension_missing(self, extension_missing): + """ + Sets the extension_missing of this FlowAnalysisRuleDTO. + Whether the underlying extension is missing. + + :param extension_missing: The extension_missing of this FlowAnalysisRuleDTO. + :type: bool + """ + + self._extension_missing = extension_missing + + @property + def id(self): + """ + Gets the id of this FlowAnalysisRuleDTO. + The id of the component. + + :return: The id of this FlowAnalysisRuleDTO. + :rtype: str + """ + return self._id + + @id.setter + def id(self, id): + """ + Sets the id of this FlowAnalysisRuleDTO. + The id of the component. + + :param id: The id of this FlowAnalysisRuleDTO. + :type: str + """ + + self._id = id + + @property + def multiple_versions_available(self): + """ + Gets the multiple_versions_available of this FlowAnalysisRuleDTO. + Whether the flow analysis rule has multiple versions available. + + :return: The multiple_versions_available of this FlowAnalysisRuleDTO. + :rtype: bool + """ + return self._multiple_versions_available + + @multiple_versions_available.setter + def multiple_versions_available(self, multiple_versions_available): + """ + Sets the multiple_versions_available of this FlowAnalysisRuleDTO. + Whether the flow analysis rule has multiple versions available. + + :param multiple_versions_available: The multiple_versions_available of this FlowAnalysisRuleDTO. + :type: bool + """ + + self._multiple_versions_available = multiple_versions_available + + @property + def name(self): + """ + Gets the name of this FlowAnalysisRuleDTO. + The name of the flow analysis rule. + + :return: The name of this FlowAnalysisRuleDTO. + :rtype: str + """ + return self._name + + @name.setter + def name(self, name): + """ + Sets the name of this FlowAnalysisRuleDTO. + The name of the flow analysis rule. + + :param name: The name of this FlowAnalysisRuleDTO. + :type: str + """ + + self._name = name + + @property + def parent_group_id(self): + """ + Gets the parent_group_id of this FlowAnalysisRuleDTO. + The id of parent process group of this component if applicable. + + :return: The parent_group_id of this FlowAnalysisRuleDTO. + :rtype: str + """ + return self._parent_group_id + + @parent_group_id.setter + def parent_group_id(self, parent_group_id): + """ + Sets the parent_group_id of this FlowAnalysisRuleDTO. + The id of parent process group of this component if applicable. + + :param parent_group_id: The parent_group_id of this FlowAnalysisRuleDTO. + :type: str + """ + + self._parent_group_id = parent_group_id + + @property + def persists_state(self): + """ + Gets the persists_state of this FlowAnalysisRuleDTO. + Whether the flow analysis rule persists state. + + :return: The persists_state of this FlowAnalysisRuleDTO. + :rtype: bool + """ + return self._persists_state + + @persists_state.setter + def persists_state(self, persists_state): + """ + Sets the persists_state of this FlowAnalysisRuleDTO. + Whether the flow analysis rule persists state. + + :param persists_state: The persists_state of this FlowAnalysisRuleDTO. + :type: bool + """ + + self._persists_state = persists_state + + @property + def position(self): + """ + Gets the position of this FlowAnalysisRuleDTO. + + :return: The position of this FlowAnalysisRuleDTO. + :rtype: PositionDTO + """ + return self._position + + @position.setter + def position(self, position): + """ + Sets the position of this FlowAnalysisRuleDTO. + + :param position: The position of this FlowAnalysisRuleDTO. + :type: PositionDTO + """ + + self._position = position + + @property + def properties(self): + """ + Gets the properties of this FlowAnalysisRuleDTO. + The properties of the flow analysis rule. + + :return: The properties of this FlowAnalysisRuleDTO. + :rtype: dict(str, str) + """ + return self._properties + + @properties.setter + def properties(self, properties): + """ + Sets the properties of this FlowAnalysisRuleDTO. + The properties of the flow analysis rule. + + :param properties: The properties of this FlowAnalysisRuleDTO. + :type: dict(str, str) + """ + + self._properties = properties + + @property + def restricted(self): + """ + Gets the restricted of this FlowAnalysisRuleDTO. + Whether the flow analysis rule requires elevated privileges. + + :return: The restricted of this FlowAnalysisRuleDTO. + :rtype: bool + """ + return self._restricted + + @restricted.setter + def restricted(self, restricted): + """ + Sets the restricted of this FlowAnalysisRuleDTO. + Whether the flow analysis rule requires elevated privileges. + + :param restricted: The restricted of this FlowAnalysisRuleDTO. + :type: bool + """ + + self._restricted = restricted + + @property + def sensitive_dynamic_property_names(self): + """ + Gets the sensitive_dynamic_property_names of this FlowAnalysisRuleDTO. + Set of sensitive dynamic property names + + :return: The sensitive_dynamic_property_names of this FlowAnalysisRuleDTO. + :rtype: list[str] + """ + return self._sensitive_dynamic_property_names + + @sensitive_dynamic_property_names.setter + def sensitive_dynamic_property_names(self, sensitive_dynamic_property_names): + """ + Sets the sensitive_dynamic_property_names of this FlowAnalysisRuleDTO. + Set of sensitive dynamic property names + + :param sensitive_dynamic_property_names: The sensitive_dynamic_property_names of this FlowAnalysisRuleDTO. + :type: list[str] + """ + + self._sensitive_dynamic_property_names = sensitive_dynamic_property_names + + @property + def state(self): + """ + Gets the state of this FlowAnalysisRuleDTO. + The state of the flow analysis rule. + + :return: The state of this FlowAnalysisRuleDTO. + :rtype: str + """ + return self._state + + @state.setter + def state(self, state): + """ + Sets the state of this FlowAnalysisRuleDTO. + The state of the flow analysis rule. + + :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) + ) + + self._state = state + + @property + def supports_sensitive_dynamic_properties(self): + """ + Gets the supports_sensitive_dynamic_properties of this FlowAnalysisRuleDTO. + Whether the flow analysis rule supports sensitive dynamic properties. + + :return: The supports_sensitive_dynamic_properties of this FlowAnalysisRuleDTO. + :rtype: bool + """ + return self._supports_sensitive_dynamic_properties + + @supports_sensitive_dynamic_properties.setter + def supports_sensitive_dynamic_properties(self, supports_sensitive_dynamic_properties): + """ + Sets the supports_sensitive_dynamic_properties of this FlowAnalysisRuleDTO. + Whether the flow analysis rule supports sensitive dynamic properties. + + :param supports_sensitive_dynamic_properties: The supports_sensitive_dynamic_properties of this FlowAnalysisRuleDTO. + :type: bool + """ + + self._supports_sensitive_dynamic_properties = supports_sensitive_dynamic_properties + + @property + def type(self): + """ + Gets the type of this FlowAnalysisRuleDTO. + The fully qualified type of the flow analysis rule. + + :return: The type of this FlowAnalysisRuleDTO. + :rtype: str + """ + return self._type + + @type.setter + def type(self, type): + """ + Sets the type of this FlowAnalysisRuleDTO. + The fully qualified type of the flow analysis rule. + + :param type: The type of this FlowAnalysisRuleDTO. + :type: str + """ + + self._type = type + + @property + def validation_errors(self): + """ + Gets the validation_errors of this FlowAnalysisRuleDTO. + 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. + + :return: The validation_errors of this FlowAnalysisRuleDTO. + :rtype: list[str] + """ + return self._validation_errors + + @validation_errors.setter + def validation_errors(self, validation_errors): + """ + Sets the validation_errors of this FlowAnalysisRuleDTO. + 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. + + :param validation_errors: The validation_errors of this FlowAnalysisRuleDTO. + :type: list[str] + """ + + self._validation_errors = validation_errors + + @property + def validation_status(self): + """ + Gets the validation_status of this FlowAnalysisRuleDTO. + 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) + + :return: The validation_status of this FlowAnalysisRuleDTO. + :rtype: str + """ + return self._validation_status + + @validation_status.setter + def validation_status(self, validation_status): + """ + Sets the validation_status of this FlowAnalysisRuleDTO. + 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) + + :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) + ) + + self._validation_status = validation_status + + @property + def versioned_component_id(self): + """ + Gets the versioned_component_id of this FlowAnalysisRuleDTO. + The ID of the corresponding component that is under version control + + :return: The versioned_component_id of this FlowAnalysisRuleDTO. + :rtype: str + """ + return self._versioned_component_id + + @versioned_component_id.setter + def versioned_component_id(self, versioned_component_id): + """ + Sets the versioned_component_id of this FlowAnalysisRuleDTO. + The ID of the corresponding component that is under version control + + :param versioned_component_id: The versioned_component_id of this FlowAnalysisRuleDTO. + :type: str + """ + + self._versioned_component_id = versioned_component_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, FlowAnalysisRuleDTO): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """ + Returns true if both objects are not equal + """ + return not self == other diff --git a/nipyapi/nifi/models/processor_diagnostics_entity.py b/nipyapi/nifi/models/flow_analysis_rule_entity.py similarity index 55% rename from nipyapi/nifi/models/processor_diagnostics_entity.py rename to nipyapi/nifi/models/flow_analysis_rule_entity.py index b4d0bdfe..31de1123 100644 --- a/nipyapi/nifi/models/processor_diagnostics_entity.py +++ b/nipyapi/nifi/models/flow_analysis_rule_entity.py @@ -1,19 +1,18 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re -class ProcessorDiagnosticsEntity(object): +class FlowAnalysisRuleEntity(object): """ NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually. @@ -28,157 +27,183 @@ class ProcessorDiagnosticsEntity(object): and the value is json key in definition. """ swagger_types = { - 'revision': 'RevisionDTO', - 'id': 'str', - 'uri': 'str', - 'position': 'PositionDTO', - 'permissions': 'PermissionsDTO', 'bulletins': 'list[BulletinEntity]', - 'disconnected_node_acknowledged': 'bool', - 'component': 'ProcessorDiagnosticsDTO' - } +'component': 'FlowAnalysisRuleDTO', +'disconnected_node_acknowledged': 'bool', +'id': 'str', +'operate_permissions': 'PermissionsDTO', +'permissions': 'PermissionsDTO', +'position': 'PositionDTO', +'revision': 'RevisionDTO', +'status': 'FlowAnalysisRuleStatusDTO', +'uri': 'str' } attribute_map = { - 'revision': 'revision', - 'id': 'id', - 'uri': 'uri', - 'position': 'position', - 'permissions': 'permissions', 'bulletins': 'bulletins', - 'disconnected_node_acknowledged': 'disconnectedNodeAcknowledged', - 'component': 'component' - } +'component': 'component', +'disconnected_node_acknowledged': 'disconnectedNodeAcknowledged', +'id': 'id', +'operate_permissions': 'operatePermissions', +'permissions': 'permissions', +'position': 'position', +'revision': 'revision', +'status': 'status', +'uri': 'uri' } - def __init__(self, revision=None, id=None, uri=None, position=None, permissions=None, bulletins=None, disconnected_node_acknowledged=None, component=None): + def __init__(self, bulletins=None, component=None, disconnected_node_acknowledged=None, id=None, operate_permissions=None, permissions=None, position=None, revision=None, status=None, uri=None): """ - ProcessorDiagnosticsEntity - a model defined in Swagger + FlowAnalysisRuleEntity - a model defined in Swagger """ - self._revision = None - self._id = None - self._uri = None - self._position = None - self._permissions = None self._bulletins = None - self._disconnected_node_acknowledged = None self._component = None + self._disconnected_node_acknowledged = None + self._id = None + self._operate_permissions = None + self._permissions = None + self._position = None + self._revision = None + self._status = None + self._uri = None - if revision is not None: - self.revision = revision - if id is not None: - self.id = id - if uri is not None: - self.uri = uri - if position is not None: - self.position = position - if permissions is not None: - self.permissions = permissions if bulletins is not None: self.bulletins = bulletins - if disconnected_node_acknowledged is not None: - self.disconnected_node_acknowledged = disconnected_node_acknowledged if component is not None: self.component = component + if disconnected_node_acknowledged is not None: + self.disconnected_node_acknowledged = disconnected_node_acknowledged + if id is not None: + self.id = id + if operate_permissions is not None: + self.operate_permissions = operate_permissions + if permissions is not None: + self.permissions = permissions + if position is not None: + self.position = position + if revision is not None: + self.revision = revision + if status is not None: + self.status = status + if uri is not None: + self.uri = uri @property - def revision(self): + def bulletins(self): """ - Gets the revision of this ProcessorDiagnosticsEntity. - The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses. + Gets the bulletins of this FlowAnalysisRuleEntity. + The bulletins for this component. - :return: The revision of this ProcessorDiagnosticsEntity. - :rtype: RevisionDTO + :return: The bulletins of this FlowAnalysisRuleEntity. + :rtype: list[BulletinEntity] """ - return self._revision + return self._bulletins - @revision.setter - def revision(self, revision): + @bulletins.setter + def bulletins(self, bulletins): """ - Sets the revision of this ProcessorDiagnosticsEntity. - The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses. + Sets the bulletins of this FlowAnalysisRuleEntity. + The bulletins for this component. - :param revision: The revision of this ProcessorDiagnosticsEntity. - :type: RevisionDTO + :param bulletins: The bulletins of this FlowAnalysisRuleEntity. + :type: list[BulletinEntity] """ - self._revision = revision + self._bulletins = bulletins @property - def id(self): + def component(self): """ - Gets the id of this ProcessorDiagnosticsEntity. - The id of the component. + Gets the component of this FlowAnalysisRuleEntity. - :return: The id of this ProcessorDiagnosticsEntity. - :rtype: str + :return: The component of this FlowAnalysisRuleEntity. + :rtype: FlowAnalysisRuleDTO """ - return self._id + return self._component - @id.setter - def id(self, id): + @component.setter + def component(self, component): """ - Sets the id of this ProcessorDiagnosticsEntity. - The id of the component. + Sets the component of this FlowAnalysisRuleEntity. - :param id: The id of this ProcessorDiagnosticsEntity. - :type: str + :param component: The component of this FlowAnalysisRuleEntity. + :type: FlowAnalysisRuleDTO """ - self._id = id + self._component = component @property - def uri(self): + def disconnected_node_acknowledged(self): + """ + Gets the disconnected_node_acknowledged of this FlowAnalysisRuleEntity. + Acknowledges that this node is disconnected to allow for mutable requests to proceed. + + :return: The disconnected_node_acknowledged of this FlowAnalysisRuleEntity. + :rtype: bool + """ + return self._disconnected_node_acknowledged + + @disconnected_node_acknowledged.setter + def disconnected_node_acknowledged(self, disconnected_node_acknowledged): + """ + Sets the disconnected_node_acknowledged of this FlowAnalysisRuleEntity. + Acknowledges that this node is disconnected to allow for mutable requests to proceed. + + :param disconnected_node_acknowledged: The disconnected_node_acknowledged of this FlowAnalysisRuleEntity. + :type: bool """ - Gets the uri of this ProcessorDiagnosticsEntity. - The URI for futures requests to the component. - :return: The uri of this ProcessorDiagnosticsEntity. + self._disconnected_node_acknowledged = disconnected_node_acknowledged + + @property + def id(self): + """ + Gets the id of this FlowAnalysisRuleEntity. + The id of the component. + + :return: The id of this FlowAnalysisRuleEntity. :rtype: str """ - return self._uri + return self._id - @uri.setter - def uri(self, uri): + @id.setter + def id(self, id): """ - Sets the uri of this ProcessorDiagnosticsEntity. - The URI for futures requests to the component. + Sets the id of this FlowAnalysisRuleEntity. + The id of the component. - :param uri: The uri of this ProcessorDiagnosticsEntity. + :param id: The id of this FlowAnalysisRuleEntity. :type: str """ - self._uri = uri + self._id = id @property - def position(self): + def operate_permissions(self): """ - Gets the position of this ProcessorDiagnosticsEntity. - The position of this component in the UI if applicable. + Gets the operate_permissions of this FlowAnalysisRuleEntity. - :return: The position of this ProcessorDiagnosticsEntity. - :rtype: PositionDTO + :return: The operate_permissions of this FlowAnalysisRuleEntity. + :rtype: PermissionsDTO """ - return self._position + return self._operate_permissions - @position.setter - def position(self, position): + @operate_permissions.setter + def operate_permissions(self, operate_permissions): """ - Sets the position of this ProcessorDiagnosticsEntity. - The position of this component in the UI if applicable. + Sets the operate_permissions of this FlowAnalysisRuleEntity. - :param position: The position of this ProcessorDiagnosticsEntity. - :type: PositionDTO + :param operate_permissions: The operate_permissions of this FlowAnalysisRuleEntity. + :type: PermissionsDTO """ - self._position = position + self._operate_permissions = operate_permissions @property def permissions(self): """ - Gets the permissions of this ProcessorDiagnosticsEntity. - The permissions for this component. + Gets the permissions of this FlowAnalysisRuleEntity. - :return: The permissions of this ProcessorDiagnosticsEntity. + :return: The permissions of this FlowAnalysisRuleEntity. :rtype: PermissionsDTO """ return self._permissions @@ -186,83 +211,99 @@ def permissions(self): @permissions.setter def permissions(self, permissions): """ - Sets the permissions of this ProcessorDiagnosticsEntity. - The permissions for this component. + Sets the permissions of this FlowAnalysisRuleEntity. - :param permissions: The permissions of this ProcessorDiagnosticsEntity. + :param permissions: The permissions of this FlowAnalysisRuleEntity. :type: PermissionsDTO """ self._permissions = permissions @property - def bulletins(self): + def position(self): """ - Gets the bulletins of this ProcessorDiagnosticsEntity. - The bulletins for this component. + Gets the position of this FlowAnalysisRuleEntity. - :return: The bulletins of this ProcessorDiagnosticsEntity. - :rtype: list[BulletinEntity] + :return: The position of this FlowAnalysisRuleEntity. + :rtype: PositionDTO """ - return self._bulletins + return self._position - @bulletins.setter - def bulletins(self, bulletins): + @position.setter + def position(self, position): """ - Sets the bulletins of this ProcessorDiagnosticsEntity. - The bulletins for this component. + Sets the position of this FlowAnalysisRuleEntity. - :param bulletins: The bulletins of this ProcessorDiagnosticsEntity. - :type: list[BulletinEntity] + :param position: The position of this FlowAnalysisRuleEntity. + :type: PositionDTO """ - self._bulletins = bulletins + self._position = position @property - def disconnected_node_acknowledged(self): + def revision(self): """ - Gets the disconnected_node_acknowledged of this ProcessorDiagnosticsEntity. - Acknowledges that this node is disconnected to allow for mutable requests to proceed. + Gets the revision of this FlowAnalysisRuleEntity. - :return: The disconnected_node_acknowledged of this ProcessorDiagnosticsEntity. - :rtype: bool + :return: The revision of this FlowAnalysisRuleEntity. + :rtype: RevisionDTO """ - return self._disconnected_node_acknowledged + return self._revision - @disconnected_node_acknowledged.setter - def disconnected_node_acknowledged(self, disconnected_node_acknowledged): + @revision.setter + def revision(self, revision): """ - Sets the disconnected_node_acknowledged of this ProcessorDiagnosticsEntity. - Acknowledges that this node is disconnected to allow for mutable requests to proceed. + Sets the revision of this FlowAnalysisRuleEntity. - :param disconnected_node_acknowledged: The disconnected_node_acknowledged of this ProcessorDiagnosticsEntity. - :type: bool + :param revision: The revision of this FlowAnalysisRuleEntity. + :type: RevisionDTO """ - self._disconnected_node_acknowledged = disconnected_node_acknowledged + self._revision = revision @property - def component(self): + def status(self): """ - Gets the component of this ProcessorDiagnosticsEntity. - The Processor Diagnostics + Gets the status of this FlowAnalysisRuleEntity. - :return: The component of this ProcessorDiagnosticsEntity. - :rtype: ProcessorDiagnosticsDTO + :return: The status of this FlowAnalysisRuleEntity. + :rtype: FlowAnalysisRuleStatusDTO """ - return self._component + return self._status - @component.setter - def component(self, component): + @status.setter + def status(self, status): """ - Sets the component of this ProcessorDiagnosticsEntity. - The Processor Diagnostics + Sets the status of this FlowAnalysisRuleEntity. - :param component: The component of this ProcessorDiagnosticsEntity. - :type: ProcessorDiagnosticsDTO + :param status: The status of this FlowAnalysisRuleEntity. + :type: FlowAnalysisRuleStatusDTO """ - self._component = component + self._status = status + + @property + def uri(self): + """ + Gets the uri of this FlowAnalysisRuleEntity. + The URI for futures requests to the component. + + :return: The uri of this FlowAnalysisRuleEntity. + :rtype: str + """ + return self._uri + + @uri.setter + def uri(self, uri): + """ + Sets the uri of this FlowAnalysisRuleEntity. + The URI for futures requests to the component. + + :param uri: The uri of this FlowAnalysisRuleEntity. + :type: str + """ + + self._uri = uri def to_dict(self): """ @@ -306,7 +347,7 @@ def __eq__(self, other): """ Returns true if both objects are equal """ - if not isinstance(other, ProcessorDiagnosticsEntity): + if not isinstance(other, FlowAnalysisRuleEntity): return False return self.__dict__ == other.__dict__ diff --git a/nipyapi/nifi/models/variable_registry_entity.py b/nipyapi/nifi/models/flow_analysis_rule_run_status_entity.py similarity index 51% rename from nipyapi/nifi/models/variable_registry_entity.py rename to nipyapi/nifi/models/flow_analysis_rule_run_status_entity.py index 533fa1c5..5c550672 100644 --- a/nipyapi/nifi/models/variable_registry_entity.py +++ b/nipyapi/nifi/models/flow_analysis_rule_run_status_entity.py @@ -1,19 +1,18 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re -class VariableRegistryEntity(object): +class FlowAnalysisRuleRunStatusEntity(object): """ NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually. @@ -28,101 +27,103 @@ class VariableRegistryEntity(object): and the value is json key in definition. """ swagger_types = { - 'process_group_revision': 'RevisionDTO', - 'variable_registry': 'VariableRegistryDTO', - 'disconnected_node_acknowledged': 'bool' - } + 'disconnected_node_acknowledged': 'bool', +'revision': 'RevisionDTO', +'state': 'str' } attribute_map = { - 'process_group_revision': 'processGroupRevision', - 'variable_registry': 'variableRegistry', - 'disconnected_node_acknowledged': 'disconnectedNodeAcknowledged' - } + 'disconnected_node_acknowledged': 'disconnectedNodeAcknowledged', +'revision': 'revision', +'state': 'state' } - def __init__(self, process_group_revision=None, variable_registry=None, disconnected_node_acknowledged=None): + def __init__(self, disconnected_node_acknowledged=None, revision=None, state=None): """ - VariableRegistryEntity - a model defined in Swagger + FlowAnalysisRuleRunStatusEntity - a model defined in Swagger """ - self._process_group_revision = None - self._variable_registry = None self._disconnected_node_acknowledged = None + self._revision = None + self._state = None - if process_group_revision is not None: - self.process_group_revision = process_group_revision - if variable_registry is not None: - self.variable_registry = variable_registry if disconnected_node_acknowledged is not None: self.disconnected_node_acknowledged = disconnected_node_acknowledged + if revision is not None: + self.revision = revision + if state is not None: + self.state = state @property - def process_group_revision(self): + def disconnected_node_acknowledged(self): """ - Gets the process_group_revision of this VariableRegistryEntity. - The revision of the Process Group that the Variable Registry belongs to + Gets the disconnected_node_acknowledged of this FlowAnalysisRuleRunStatusEntity. + Acknowledges that this node is disconnected to allow for mutable requests to proceed. - :return: The process_group_revision of this VariableRegistryEntity. - :rtype: RevisionDTO + :return: The disconnected_node_acknowledged of this FlowAnalysisRuleRunStatusEntity. + :rtype: bool """ - return self._process_group_revision + return self._disconnected_node_acknowledged - @process_group_revision.setter - def process_group_revision(self, process_group_revision): + @disconnected_node_acknowledged.setter + def disconnected_node_acknowledged(self, disconnected_node_acknowledged): """ - Sets the process_group_revision of this VariableRegistryEntity. - The revision of the Process Group that the Variable Registry belongs to + Sets the disconnected_node_acknowledged of this FlowAnalysisRuleRunStatusEntity. + Acknowledges that this node is disconnected to allow for mutable requests to proceed. - :param process_group_revision: The process_group_revision of this VariableRegistryEntity. - :type: RevisionDTO + :param disconnected_node_acknowledged: The disconnected_node_acknowledged of this FlowAnalysisRuleRunStatusEntity. + :type: bool """ - self._process_group_revision = process_group_revision + self._disconnected_node_acknowledged = disconnected_node_acknowledged @property - def variable_registry(self): + def revision(self): """ - Gets the variable_registry of this VariableRegistryEntity. - The Variable Registry. + Gets the revision of this FlowAnalysisRuleRunStatusEntity. - :return: The variable_registry of this VariableRegistryEntity. - :rtype: VariableRegistryDTO + :return: The revision of this FlowAnalysisRuleRunStatusEntity. + :rtype: RevisionDTO """ - return self._variable_registry + return self._revision - @variable_registry.setter - def variable_registry(self, variable_registry): + @revision.setter + def revision(self, revision): """ - Sets the variable_registry of this VariableRegistryEntity. - The Variable Registry. + Sets the revision of this FlowAnalysisRuleRunStatusEntity. - :param variable_registry: The variable_registry of this VariableRegistryEntity. - :type: VariableRegistryDTO + :param revision: The revision of this FlowAnalysisRuleRunStatusEntity. + :type: RevisionDTO """ - self._variable_registry = variable_registry + self._revision = revision @property - def disconnected_node_acknowledged(self): + def state(self): """ - Gets the disconnected_node_acknowledged of this VariableRegistryEntity. - Acknowledges that this node is disconnected to allow for mutable requests to proceed. + Gets the state of this FlowAnalysisRuleRunStatusEntity. + The state of the FlowAnalysisRule. - :return: The disconnected_node_acknowledged of this VariableRegistryEntity. - :rtype: bool + :return: The state of this FlowAnalysisRuleRunStatusEntity. + :rtype: str """ - return self._disconnected_node_acknowledged + return self._state - @disconnected_node_acknowledged.setter - def disconnected_node_acknowledged(self, disconnected_node_acknowledged): + @state.setter + def state(self, state): """ - Sets the disconnected_node_acknowledged of this VariableRegistryEntity. - Acknowledges that this node is disconnected to allow for mutable requests to proceed. + Sets the state of this FlowAnalysisRuleRunStatusEntity. + The state of the FlowAnalysisRule. - :param disconnected_node_acknowledged: The disconnected_node_acknowledged of this VariableRegistryEntity. - :type: bool + :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) + ) - self._disconnected_node_acknowledged = disconnected_node_acknowledged + self._state = state def to_dict(self): """ @@ -166,7 +167,7 @@ def __eq__(self, other): """ Returns true if both objects are equal """ - if not isinstance(other, VariableRegistryEntity): + if not isinstance(other, FlowAnalysisRuleRunStatusEntity): return False return self.__dict__ == other.__dict__ diff --git a/nipyapi/nifi/models/flow_analysis_rule_status_dto.py b/nipyapi/nifi/models/flow_analysis_rule_status_dto.py new file mode 100644 index 00000000..6b468593 --- /dev/null +++ b/nipyapi/nifi/models/flow_analysis_rule_status_dto.py @@ -0,0 +1,187 @@ +""" + Apache NiFi REST API + + REST API definition for Apache NiFi web services + + OpenAPI spec version: 2.5.0 + Contact: dev@nifi.apache.org + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from pprint import pformat +import re + + +class FlowAnalysisRuleStatusDTO(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 = { + 'active_thread_count': 'int', +'run_status': 'str', +'validation_status': 'str' } + + attribute_map = { + 'active_thread_count': 'activeThreadCount', +'run_status': 'runStatus', +'validation_status': 'validationStatus' } + + def __init__(self, active_thread_count=None, run_status=None, validation_status=None): + """ + FlowAnalysisRuleStatusDTO - a model defined in Swagger + """ + + self._active_thread_count = None + self._run_status = None + self._validation_status = None + + if active_thread_count is not None: + self.active_thread_count = active_thread_count + if run_status is not None: + self.run_status = run_status + if validation_status is not None: + self.validation_status = validation_status + + @property + def active_thread_count(self): + """ + Gets the active_thread_count of this FlowAnalysisRuleStatusDTO. + The number of active threads for the component. + + :return: The active_thread_count of this FlowAnalysisRuleStatusDTO. + :rtype: int + """ + return self._active_thread_count + + @active_thread_count.setter + def active_thread_count(self, active_thread_count): + """ + Sets the active_thread_count of this FlowAnalysisRuleStatusDTO. + The number of active threads for the component. + + :param active_thread_count: The active_thread_count of this FlowAnalysisRuleStatusDTO. + :type: int + """ + + self._active_thread_count = active_thread_count + + @property + def run_status(self): + """ + Gets the run_status of this FlowAnalysisRuleStatusDTO. + The run status of this FlowAnalysisRule + + :return: The run_status of this FlowAnalysisRuleStatusDTO. + :rtype: str + """ + return self._run_status + + @run_status.setter + def run_status(self, run_status): + """ + Sets the run_status of this FlowAnalysisRuleStatusDTO. + The run status of this FlowAnalysisRule + + :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) + ) + + self._run_status = run_status + + @property + def validation_status(self): + """ + Gets the validation_status of this FlowAnalysisRuleStatusDTO. + 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) + + :return: The validation_status of this FlowAnalysisRuleStatusDTO. + :rtype: str + """ + return self._validation_status + + @validation_status.setter + def validation_status(self, validation_status): + """ + Sets the validation_status of this FlowAnalysisRuleStatusDTO. + 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) + + :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) + ) + + self._validation_status = validation_status + + 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, FlowAnalysisRuleStatusDTO): + 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/access_configuration_entity.py b/nipyapi/nifi/models/flow_analysis_rule_types_entity.py similarity index 60% rename from nipyapi/nifi/models/access_configuration_entity.py rename to nipyapi/nifi/models/flow_analysis_rule_types_entity.py index 54485a38..eeac9451 100644 --- a/nipyapi/nifi/models/access_configuration_entity.py +++ b/nipyapi/nifi/models/flow_analysis_rule_types_entity.py @@ -1,19 +1,18 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re -class AccessConfigurationEntity(object): +class FlowAnalysisRuleTypesEntity(object): """ NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually. @@ -28,43 +27,41 @@ class AccessConfigurationEntity(object): and the value is json key in definition. """ swagger_types = { - 'config': 'AccessConfigurationDTO' - } + 'flow_analysis_rule_types': 'list[DocumentedTypeDTO]' } attribute_map = { - 'config': 'config' - } + 'flow_analysis_rule_types': 'flowAnalysisRuleTypes' } - def __init__(self, config=None): + def __init__(self, flow_analysis_rule_types=None): """ - AccessConfigurationEntity - a model defined in Swagger + FlowAnalysisRuleTypesEntity - a model defined in Swagger """ - self._config = None + self._flow_analysis_rule_types = None - if config is not None: - self.config = config + if flow_analysis_rule_types is not None: + self.flow_analysis_rule_types = flow_analysis_rule_types @property - def config(self): + def flow_analysis_rule_types(self): """ - Gets the config of this AccessConfigurationEntity. + Gets the flow_analysis_rule_types of this FlowAnalysisRuleTypesEntity. - :return: The config of this AccessConfigurationEntity. - :rtype: AccessConfigurationDTO + :return: The flow_analysis_rule_types of this FlowAnalysisRuleTypesEntity. + :rtype: list[DocumentedTypeDTO] """ - return self._config + return self._flow_analysis_rule_types - @config.setter - def config(self, config): + @flow_analysis_rule_types.setter + def flow_analysis_rule_types(self, flow_analysis_rule_types): """ - Sets the config of this AccessConfigurationEntity. + Sets the flow_analysis_rule_types of this FlowAnalysisRuleTypesEntity. - :param config: The config of this AccessConfigurationEntity. - :type: AccessConfigurationDTO + :param flow_analysis_rule_types: The flow_analysis_rule_types of this FlowAnalysisRuleTypesEntity. + :type: list[DocumentedTypeDTO] """ - self._config = config + self._flow_analysis_rule_types = flow_analysis_rule_types def to_dict(self): """ @@ -108,7 +105,7 @@ def __eq__(self, other): """ Returns true if both objects are equal """ - if not isinstance(other, AccessConfigurationEntity): + if not isinstance(other, FlowAnalysisRuleTypesEntity): return False return self.__dict__ == other.__dict__ diff --git a/nipyapi/nifi/models/flow_analysis_rule_violation_dto.py b/nipyapi/nifi/models/flow_analysis_rule_violation_dto.py new file mode 100644 index 00000000..c6813843 --- /dev/null +++ b/nipyapi/nifi/models/flow_analysis_rule_violation_dto.py @@ -0,0 +1,377 @@ +""" + Apache NiFi REST API + + REST API definition for Apache NiFi web services + + OpenAPI spec version: 2.5.0 + Contact: dev@nifi.apache.org + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from pprint import pformat +import re + + +class FlowAnalysisRuleViolationDTO(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 = { + 'enabled': 'bool', +'enforcement_policy': 'str', +'group_id': 'str', +'issue_id': 'str', +'rule_id': 'str', +'scope': 'str', +'subject_component_type': 'str', +'subject_display_name': 'str', +'subject_id': 'str', +'subject_permission_dto': 'PermissionsDTO', +'violation_message': 'str' } + + attribute_map = { + 'enabled': 'enabled', +'enforcement_policy': 'enforcementPolicy', +'group_id': 'groupId', +'issue_id': 'issueId', +'rule_id': 'ruleId', +'scope': 'scope', +'subject_component_type': 'subjectComponentType', +'subject_display_name': 'subjectDisplayName', +'subject_id': 'subjectId', +'subject_permission_dto': 'subjectPermissionDto', +'violation_message': 'violationMessage' } + + def __init__(self, enabled=None, enforcement_policy=None, group_id=None, issue_id=None, rule_id=None, scope=None, subject_component_type=None, subject_display_name=None, subject_id=None, subject_permission_dto=None, violation_message=None): + """ + FlowAnalysisRuleViolationDTO - a model defined in Swagger + """ + + self._enabled = None + self._enforcement_policy = None + self._group_id = None + self._issue_id = None + self._rule_id = None + self._scope = None + self._subject_component_type = None + self._subject_display_name = None + self._subject_id = None + self._subject_permission_dto = None + self._violation_message = None + + if enabled is not None: + self.enabled = enabled + if enforcement_policy is not None: + self.enforcement_policy = enforcement_policy + if group_id is not None: + self.group_id = group_id + if issue_id is not None: + self.issue_id = issue_id + if rule_id is not None: + self.rule_id = rule_id + if scope is not None: + self.scope = scope + if subject_component_type is not None: + self.subject_component_type = subject_component_type + if subject_display_name is not None: + self.subject_display_name = subject_display_name + if subject_id is not None: + self.subject_id = subject_id + if subject_permission_dto is not None: + self.subject_permission_dto = subject_permission_dto + if violation_message is not None: + self.violation_message = violation_message + + @property + def enabled(self): + """ + Gets the enabled of this FlowAnalysisRuleViolationDTO. + + :return: The enabled of this FlowAnalysisRuleViolationDTO. + :rtype: bool + """ + return self._enabled + + @enabled.setter + def enabled(self, enabled): + """ + Sets the enabled of this FlowAnalysisRuleViolationDTO. + + :param enabled: The enabled of this FlowAnalysisRuleViolationDTO. + :type: bool + """ + + self._enabled = enabled + + @property + def enforcement_policy(self): + """ + Gets the enforcement_policy of this FlowAnalysisRuleViolationDTO. + + :return: The enforcement_policy of this FlowAnalysisRuleViolationDTO. + :rtype: str + """ + return self._enforcement_policy + + @enforcement_policy.setter + def enforcement_policy(self, enforcement_policy): + """ + Sets the enforcement_policy of this FlowAnalysisRuleViolationDTO. + + :param enforcement_policy: The enforcement_policy of this FlowAnalysisRuleViolationDTO. + :type: str + """ + + self._enforcement_policy = enforcement_policy + + @property + def group_id(self): + """ + Gets the group_id of this FlowAnalysisRuleViolationDTO. + + :return: The group_id of this FlowAnalysisRuleViolationDTO. + :rtype: str + """ + return self._group_id + + @group_id.setter + def group_id(self, group_id): + """ + Sets the group_id of this FlowAnalysisRuleViolationDTO. + + :param group_id: The group_id of this FlowAnalysisRuleViolationDTO. + :type: str + """ + + self._group_id = group_id + + @property + def issue_id(self): + """ + Gets the issue_id of this FlowAnalysisRuleViolationDTO. + + :return: The issue_id of this FlowAnalysisRuleViolationDTO. + :rtype: str + """ + return self._issue_id + + @issue_id.setter + def issue_id(self, issue_id): + """ + Sets the issue_id of this FlowAnalysisRuleViolationDTO. + + :param issue_id: The issue_id of this FlowAnalysisRuleViolationDTO. + :type: str + """ + + self._issue_id = issue_id + + @property + def rule_id(self): + """ + Gets the rule_id of this FlowAnalysisRuleViolationDTO. + + :return: The rule_id of this FlowAnalysisRuleViolationDTO. + :rtype: str + """ + return self._rule_id + + @rule_id.setter + def rule_id(self, rule_id): + """ + Sets the rule_id of this FlowAnalysisRuleViolationDTO. + + :param rule_id: The rule_id of this FlowAnalysisRuleViolationDTO. + :type: str + """ + + self._rule_id = rule_id + + @property + def scope(self): + """ + Gets the scope of this FlowAnalysisRuleViolationDTO. + + :return: The scope of this FlowAnalysisRuleViolationDTO. + :rtype: str + """ + return self._scope + + @scope.setter + def scope(self, scope): + """ + Sets the scope of this FlowAnalysisRuleViolationDTO. + + :param scope: The scope of this FlowAnalysisRuleViolationDTO. + :type: str + """ + + self._scope = scope + + @property + def subject_component_type(self): + """ + Gets the subject_component_type of this FlowAnalysisRuleViolationDTO. + + :return: The subject_component_type of this FlowAnalysisRuleViolationDTO. + :rtype: str + """ + return self._subject_component_type + + @subject_component_type.setter + def subject_component_type(self, subject_component_type): + """ + Sets the subject_component_type of this FlowAnalysisRuleViolationDTO. + + :param subject_component_type: The subject_component_type of this FlowAnalysisRuleViolationDTO. + :type: str + """ + + self._subject_component_type = subject_component_type + + @property + def subject_display_name(self): + """ + Gets the subject_display_name of this FlowAnalysisRuleViolationDTO. + + :return: The subject_display_name of this FlowAnalysisRuleViolationDTO. + :rtype: str + """ + return self._subject_display_name + + @subject_display_name.setter + def subject_display_name(self, subject_display_name): + """ + Sets the subject_display_name of this FlowAnalysisRuleViolationDTO. + + :param subject_display_name: The subject_display_name of this FlowAnalysisRuleViolationDTO. + :type: str + """ + + self._subject_display_name = subject_display_name + + @property + def subject_id(self): + """ + Gets the subject_id of this FlowAnalysisRuleViolationDTO. + + :return: The subject_id of this FlowAnalysisRuleViolationDTO. + :rtype: str + """ + return self._subject_id + + @subject_id.setter + def subject_id(self, subject_id): + """ + Sets the subject_id of this FlowAnalysisRuleViolationDTO. + + :param subject_id: The subject_id of this FlowAnalysisRuleViolationDTO. + :type: str + """ + + self._subject_id = subject_id + + @property + def subject_permission_dto(self): + """ + Gets the subject_permission_dto of this FlowAnalysisRuleViolationDTO. + + :return: The subject_permission_dto of this FlowAnalysisRuleViolationDTO. + :rtype: PermissionsDTO + """ + return self._subject_permission_dto + + @subject_permission_dto.setter + def subject_permission_dto(self, subject_permission_dto): + """ + Sets the subject_permission_dto of this FlowAnalysisRuleViolationDTO. + + :param subject_permission_dto: The subject_permission_dto of this FlowAnalysisRuleViolationDTO. + :type: PermissionsDTO + """ + + self._subject_permission_dto = subject_permission_dto + + @property + def violation_message(self): + """ + Gets the violation_message of this FlowAnalysisRuleViolationDTO. + + :return: The violation_message of this FlowAnalysisRuleViolationDTO. + :rtype: str + """ + return self._violation_message + + @violation_message.setter + def violation_message(self, violation_message): + """ + Sets the violation_message of this FlowAnalysisRuleViolationDTO. + + :param violation_message: The violation_message of this FlowAnalysisRuleViolationDTO. + :type: str + """ + + self._violation_message = violation_message + + 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, FlowAnalysisRuleViolationDTO): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """ + Returns true if both objects are not equal + """ + return not self == other diff --git a/nipyapi/nifi/models/flow_analysis_rules_entity.py b/nipyapi/nifi/models/flow_analysis_rules_entity.py new file mode 100644 index 00000000..fb732d3b --- /dev/null +++ b/nipyapi/nifi/models/flow_analysis_rules_entity.py @@ -0,0 +1,145 @@ +""" + Apache NiFi REST API + + REST API definition for Apache NiFi web services + + OpenAPI spec version: 2.5.0 + Contact: dev@nifi.apache.org + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from pprint import pformat +import re + + +class FlowAnalysisRulesEntity(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 = { + 'current_time': 'str', +'flow_analysis_rules': 'list[FlowAnalysisRuleEntity]' } + + attribute_map = { + 'current_time': 'currentTime', +'flow_analysis_rules': 'flowAnalysisRules' } + + def __init__(self, current_time=None, flow_analysis_rules=None): + """ + FlowAnalysisRulesEntity - a model defined in Swagger + """ + + self._current_time = None + self._flow_analysis_rules = None + + if current_time is not None: + self.current_time = current_time + if flow_analysis_rules is not None: + self.flow_analysis_rules = flow_analysis_rules + + @property + def current_time(self): + """ + Gets the current_time of this FlowAnalysisRulesEntity. + The current time on the system. + + :return: The current_time of this FlowAnalysisRulesEntity. + :rtype: str + """ + return self._current_time + + @current_time.setter + def current_time(self, current_time): + """ + Sets the current_time of this FlowAnalysisRulesEntity. + The current time on the system. + + :param current_time: The current_time of this FlowAnalysisRulesEntity. + :type: str + """ + + self._current_time = current_time + + @property + def flow_analysis_rules(self): + """ + Gets the flow_analysis_rules of this FlowAnalysisRulesEntity. + + :return: The flow_analysis_rules of this FlowAnalysisRulesEntity. + :rtype: list[FlowAnalysisRuleEntity] + """ + return self._flow_analysis_rules + + @flow_analysis_rules.setter + def flow_analysis_rules(self, flow_analysis_rules): + """ + Sets the flow_analysis_rules of this FlowAnalysisRulesEntity. + + :param flow_analysis_rules: The flow_analysis_rules of this FlowAnalysisRulesEntity. + :type: list[FlowAnalysisRuleEntity] + """ + + self._flow_analysis_rules = flow_analysis_rules + + 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, FlowAnalysisRulesEntity): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """ + Returns true if both objects are not equal + """ + return not self == other diff --git a/nipyapi/nifi/models/flow_breadcrumb_dto.py b/nipyapi/nifi/models/flow_breadcrumb_dto.py index f65075de..56a26db6 100644 --- a/nipyapi/nifi/models/flow_breadcrumb_dto.py +++ b/nipyapi/nifi/models/flow_breadcrumb_dto.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -29,15 +28,13 @@ class FlowBreadcrumbDTO(object): """ swagger_types = { 'id': 'str', - 'name': 'str', - 'version_control_information': 'VersionControlInformationDTO' - } +'name': 'str', +'version_control_information': 'VersionControlInformationDTO' } attribute_map = { 'id': 'id', - 'name': 'name', - 'version_control_information': 'versionControlInformation' - } +'name': 'name', +'version_control_information': 'versionControlInformation' } def __init__(self, id=None, name=None, version_control_information=None): """ @@ -105,7 +102,6 @@ def name(self, name): def version_control_information(self): """ Gets the version_control_information of this FlowBreadcrumbDTO. - The process group version control information or null if not version controlled. :return: The version_control_information of this FlowBreadcrumbDTO. :rtype: VersionControlInformationDTO @@ -116,7 +112,6 @@ def version_control_information(self): def version_control_information(self, version_control_information): """ Sets the version_control_information of this FlowBreadcrumbDTO. - The process group version control information or null if not version controlled. :param version_control_information: The version_control_information of this FlowBreadcrumbDTO. :type: VersionControlInformationDTO diff --git a/nipyapi/nifi/models/flow_breadcrumb_entity.py b/nipyapi/nifi/models/flow_breadcrumb_entity.py index ef1eb76c..6e46a9bf 100644 --- a/nipyapi/nifi/models/flow_breadcrumb_entity.py +++ b/nipyapi/nifi/models/flow_breadcrumb_entity.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,42 +27,61 @@ class FlowBreadcrumbEntity(object): and the value is json key in definition. """ swagger_types = { - 'id': 'str', - 'permissions': 'PermissionsDTO', - 'versioned_flow_state': 'str', 'breadcrumb': 'FlowBreadcrumbDTO', - 'parent_breadcrumb': 'FlowBreadcrumbEntity' - } +'id': 'str', +'parent_breadcrumb': 'FlowBreadcrumbEntity', +'permissions': 'PermissionsDTO', +'versioned_flow_state': 'str' } attribute_map = { - 'id': 'id', - 'permissions': 'permissions', - 'versioned_flow_state': 'versionedFlowState', 'breadcrumb': 'breadcrumb', - 'parent_breadcrumb': 'parentBreadcrumb' - } +'id': 'id', +'parent_breadcrumb': 'parentBreadcrumb', +'permissions': 'permissions', +'versioned_flow_state': 'versionedFlowState' } - def __init__(self, id=None, permissions=None, versioned_flow_state=None, breadcrumb=None, parent_breadcrumb=None): + def __init__(self, breadcrumb=None, id=None, parent_breadcrumb=None, permissions=None, versioned_flow_state=None): """ FlowBreadcrumbEntity - a model defined in Swagger """ + self._breadcrumb = None self._id = None + self._parent_breadcrumb = None self._permissions = None self._versioned_flow_state = None - self._breadcrumb = None - self._parent_breadcrumb = None + if breadcrumb is not None: + self.breadcrumb = breadcrumb if id is not None: self.id = id + if parent_breadcrumb is not None: + self.parent_breadcrumb = parent_breadcrumb if permissions is not None: self.permissions = permissions if versioned_flow_state is not None: self.versioned_flow_state = versioned_flow_state - if breadcrumb is not None: - self.breadcrumb = breadcrumb - if parent_breadcrumb is not None: - self.parent_breadcrumb = parent_breadcrumb + + @property + def breadcrumb(self): + """ + Gets the breadcrumb of this FlowBreadcrumbEntity. + + :return: The breadcrumb of this FlowBreadcrumbEntity. + :rtype: FlowBreadcrumbDTO + """ + return self._breadcrumb + + @breadcrumb.setter + def breadcrumb(self, breadcrumb): + """ + Sets the breadcrumb of this FlowBreadcrumbEntity. + + :param breadcrumb: The breadcrumb of this FlowBreadcrumbEntity. + :type: FlowBreadcrumbDTO + """ + + self._breadcrumb = breadcrumb @property def id(self): @@ -88,11 +106,31 @@ def id(self, id): self._id = id + @property + def parent_breadcrumb(self): + """ + Gets the parent_breadcrumb of this FlowBreadcrumbEntity. + + :return: The parent_breadcrumb of this FlowBreadcrumbEntity. + :rtype: FlowBreadcrumbEntity + """ + return self._parent_breadcrumb + + @parent_breadcrumb.setter + def parent_breadcrumb(self, parent_breadcrumb): + """ + Sets the parent_breadcrumb of this FlowBreadcrumbEntity. + + :param parent_breadcrumb: The parent_breadcrumb of this FlowBreadcrumbEntity. + :type: FlowBreadcrumbEntity + """ + + self._parent_breadcrumb = parent_breadcrumb + @property def permissions(self): """ Gets the permissions of this FlowBreadcrumbEntity. - The permissions for this ancestor ProcessGroup. :return: The permissions of this FlowBreadcrumbEntity. :rtype: PermissionsDTO @@ -103,7 +141,6 @@ def permissions(self): def permissions(self, permissions): """ Sets the permissions of this FlowBreadcrumbEntity. - The permissions for this ancestor ProcessGroup. :param permissions: The permissions of this FlowBreadcrumbEntity. :type: PermissionsDTO @@ -131,7 +168,7 @@ 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"] + 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}" @@ -140,52 +177,6 @@ def versioned_flow_state(self, versioned_flow_state): self._versioned_flow_state = versioned_flow_state - @property - def breadcrumb(self): - """ - Gets the breadcrumb of this FlowBreadcrumbEntity. - This breadcrumb. - - :return: The breadcrumb of this FlowBreadcrumbEntity. - :rtype: FlowBreadcrumbDTO - """ - return self._breadcrumb - - @breadcrumb.setter - def breadcrumb(self, breadcrumb): - """ - Sets the breadcrumb of this FlowBreadcrumbEntity. - This breadcrumb. - - :param breadcrumb: The breadcrumb of this FlowBreadcrumbEntity. - :type: FlowBreadcrumbDTO - """ - - self._breadcrumb = breadcrumb - - @property - def parent_breadcrumb(self): - """ - Gets the parent_breadcrumb of this FlowBreadcrumbEntity. - The parent breadcrumb for this breadcrumb. - - :return: The parent_breadcrumb of this FlowBreadcrumbEntity. - :rtype: FlowBreadcrumbEntity - """ - return self._parent_breadcrumb - - @parent_breadcrumb.setter - def parent_breadcrumb(self, parent_breadcrumb): - """ - Sets the parent_breadcrumb of this FlowBreadcrumbEntity. - The parent breadcrumb for this breadcrumb. - - :param parent_breadcrumb: The parent_breadcrumb of this FlowBreadcrumbEntity. - :type: FlowBreadcrumbEntity - """ - - self._parent_breadcrumb = parent_breadcrumb - def to_dict(self): """ Returns the model properties as a dict diff --git a/nipyapi/nifi/models/flow_comparison_entity.py b/nipyapi/nifi/models/flow_comparison_entity.py index 248862a3..d3b54feb 100644 --- a/nipyapi/nifi/models/flow_comparison_entity.py +++ b/nipyapi/nifi/models/flow_comparison_entity.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,12 +27,10 @@ class FlowComparisonEntity(object): and the value is json key in definition. """ swagger_types = { - 'component_differences': 'list[ComponentDifferenceDTO]' - } + 'component_differences': 'list[ComponentDifferenceDTO]' } attribute_map = { - 'component_differences': 'componentDifferences' - } + 'component_differences': 'componentDifferences' } def __init__(self, component_differences=None): """ diff --git a/nipyapi/nifi/models/flow_configuration_dto.py b/nipyapi/nifi/models/flow_configuration_dto.py index fe89eace..ab5951d3 100644 --- a/nipyapi/nifi/models/flow_configuration_dto.py +++ b/nipyapi/nifi/models/flow_configuration_dto.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,80 +27,119 @@ class FlowConfigurationDTO(object): and the value is json key in definition. """ swagger_types = { - 'supports_managed_authorizer': 'bool', - 'supports_configurable_authorizer': 'bool', - 'supports_configurable_users_and_groups': 'bool', - 'auto_refresh_interval_seconds': 'int', 'current_time': 'str', - 'time_offset': 'int', - 'default_back_pressure_object_threshold': 'int', - 'default_back_pressure_data_size_threshold': 'str' - } +'default_back_pressure_data_size_threshold': 'str', +'default_back_pressure_object_threshold': 'int', +'supports_configurable_authorizer': 'bool', +'supports_configurable_users_and_groups': 'bool', +'supports_managed_authorizer': 'bool', +'time_offset': 'int' } attribute_map = { - 'supports_managed_authorizer': 'supportsManagedAuthorizer', - 'supports_configurable_authorizer': 'supportsConfigurableAuthorizer', - 'supports_configurable_users_and_groups': 'supportsConfigurableUsersAndGroups', - 'auto_refresh_interval_seconds': 'autoRefreshIntervalSeconds', 'current_time': 'currentTime', - 'time_offset': 'timeOffset', - 'default_back_pressure_object_threshold': 'defaultBackPressureObjectThreshold', - 'default_back_pressure_data_size_threshold': 'defaultBackPressureDataSizeThreshold' - } +'default_back_pressure_data_size_threshold': 'defaultBackPressureDataSizeThreshold', +'default_back_pressure_object_threshold': 'defaultBackPressureObjectThreshold', +'supports_configurable_authorizer': 'supportsConfigurableAuthorizer', +'supports_configurable_users_and_groups': 'supportsConfigurableUsersAndGroups', +'supports_managed_authorizer': 'supportsManagedAuthorizer', +'time_offset': 'timeOffset' } - def __init__(self, supports_managed_authorizer=None, supports_configurable_authorizer=None, supports_configurable_users_and_groups=None, auto_refresh_interval_seconds=None, current_time=None, time_offset=None, default_back_pressure_object_threshold=None, default_back_pressure_data_size_threshold=None): + def __init__(self, current_time=None, default_back_pressure_data_size_threshold=None, default_back_pressure_object_threshold=None, supports_configurable_authorizer=None, supports_configurable_users_and_groups=None, supports_managed_authorizer=None, time_offset=None): """ FlowConfigurationDTO - a model defined in Swagger """ - self._supports_managed_authorizer = None + self._current_time = None + self._default_back_pressure_data_size_threshold = None + self._default_back_pressure_object_threshold = None self._supports_configurable_authorizer = None self._supports_configurable_users_and_groups = None - self._auto_refresh_interval_seconds = None - self._current_time = None + self._supports_managed_authorizer = None self._time_offset = None - self._default_back_pressure_object_threshold = None - self._default_back_pressure_data_size_threshold = None - if supports_managed_authorizer is not None: - self.supports_managed_authorizer = supports_managed_authorizer + if current_time is not None: + self.current_time = current_time + if default_back_pressure_data_size_threshold is not None: + self.default_back_pressure_data_size_threshold = default_back_pressure_data_size_threshold + if default_back_pressure_object_threshold is not None: + self.default_back_pressure_object_threshold = default_back_pressure_object_threshold if supports_configurable_authorizer is not None: self.supports_configurable_authorizer = supports_configurable_authorizer if supports_configurable_users_and_groups is not None: self.supports_configurable_users_and_groups = supports_configurable_users_and_groups - if auto_refresh_interval_seconds is not None: - self.auto_refresh_interval_seconds = auto_refresh_interval_seconds - if current_time is not None: - self.current_time = current_time + if supports_managed_authorizer is not None: + self.supports_managed_authorizer = supports_managed_authorizer if time_offset is not None: self.time_offset = time_offset - if default_back_pressure_object_threshold is not None: - self.default_back_pressure_object_threshold = default_back_pressure_object_threshold - if default_back_pressure_data_size_threshold is not None: - self.default_back_pressure_data_size_threshold = default_back_pressure_data_size_threshold @property - def supports_managed_authorizer(self): + def current_time(self): """ - Gets the supports_managed_authorizer of this FlowConfigurationDTO. - Whether this NiFi supports a managed authorizer. Managed authorizers can visualize users, groups, and policies in the UI. + Gets the current_time of this FlowConfigurationDTO. + The current time on the system. - :return: The supports_managed_authorizer of this FlowConfigurationDTO. - :rtype: bool + :return: The current_time of this FlowConfigurationDTO. + :rtype: str """ - return self._supports_managed_authorizer + return self._current_time - @supports_managed_authorizer.setter - def supports_managed_authorizer(self, supports_managed_authorizer): + @current_time.setter + def current_time(self, current_time): """ - Sets the supports_managed_authorizer of this FlowConfigurationDTO. - Whether this NiFi supports a managed authorizer. Managed authorizers can visualize users, groups, and policies in the UI. + Sets the current_time of this FlowConfigurationDTO. + The current time on the system. - :param supports_managed_authorizer: The supports_managed_authorizer of this FlowConfigurationDTO. - :type: bool + :param current_time: The current_time of this FlowConfigurationDTO. + :type: str """ - self._supports_managed_authorizer = supports_managed_authorizer + self._current_time = current_time + + @property + def default_back_pressure_data_size_threshold(self): + """ + Gets the default_back_pressure_data_size_threshold of this FlowConfigurationDTO. + The default back pressure data size threshold. + + :return: The default_back_pressure_data_size_threshold of this FlowConfigurationDTO. + :rtype: str + """ + return self._default_back_pressure_data_size_threshold + + @default_back_pressure_data_size_threshold.setter + def default_back_pressure_data_size_threshold(self, default_back_pressure_data_size_threshold): + """ + Sets the default_back_pressure_data_size_threshold of this FlowConfigurationDTO. + The default back pressure data size threshold. + + :param default_back_pressure_data_size_threshold: The default_back_pressure_data_size_threshold of this FlowConfigurationDTO. + :type: str + """ + + self._default_back_pressure_data_size_threshold = default_back_pressure_data_size_threshold + + @property + def default_back_pressure_object_threshold(self): + """ + Gets the default_back_pressure_object_threshold of this FlowConfigurationDTO. + The default back pressure object threshold. + + :return: The default_back_pressure_object_threshold of this FlowConfigurationDTO. + :rtype: int + """ + return self._default_back_pressure_object_threshold + + @default_back_pressure_object_threshold.setter + def default_back_pressure_object_threshold(self, default_back_pressure_object_threshold): + """ + Sets the default_back_pressure_object_threshold of this FlowConfigurationDTO. + The default back pressure object threshold. + + :param default_back_pressure_object_threshold: The default_back_pressure_object_threshold of this FlowConfigurationDTO. + :type: int + """ + + self._default_back_pressure_object_threshold = default_back_pressure_object_threshold @property def supports_configurable_authorizer(self): @@ -150,50 +188,27 @@ def supports_configurable_users_and_groups(self, supports_configurable_users_and self._supports_configurable_users_and_groups = supports_configurable_users_and_groups @property - def auto_refresh_interval_seconds(self): - """ - Gets the auto_refresh_interval_seconds of this FlowConfigurationDTO. - The interval in seconds between the automatic NiFi refresh requests. - - :return: The auto_refresh_interval_seconds of this FlowConfigurationDTO. - :rtype: int - """ - return self._auto_refresh_interval_seconds - - @auto_refresh_interval_seconds.setter - def auto_refresh_interval_seconds(self, auto_refresh_interval_seconds): - """ - Sets the auto_refresh_interval_seconds of this FlowConfigurationDTO. - The interval in seconds between the automatic NiFi refresh requests. - - :param auto_refresh_interval_seconds: The auto_refresh_interval_seconds of this FlowConfigurationDTO. - :type: int - """ - - self._auto_refresh_interval_seconds = auto_refresh_interval_seconds - - @property - def current_time(self): + def supports_managed_authorizer(self): """ - Gets the current_time of this FlowConfigurationDTO. - The current time on the system. + Gets the supports_managed_authorizer of this FlowConfigurationDTO. + Whether this NiFi supports a managed authorizer. Managed authorizers can visualize users, groups, and policies in the UI. - :return: The current_time of this FlowConfigurationDTO. - :rtype: str + :return: The supports_managed_authorizer of this FlowConfigurationDTO. + :rtype: bool """ - return self._current_time + return self._supports_managed_authorizer - @current_time.setter - def current_time(self, current_time): + @supports_managed_authorizer.setter + def supports_managed_authorizer(self, supports_managed_authorizer): """ - Sets the current_time of this FlowConfigurationDTO. - The current time on the system. + Sets the supports_managed_authorizer of this FlowConfigurationDTO. + Whether this NiFi supports a managed authorizer. Managed authorizers can visualize users, groups, and policies in the UI. - :param current_time: The current_time of this FlowConfigurationDTO. - :type: str + :param supports_managed_authorizer: The supports_managed_authorizer of this FlowConfigurationDTO. + :type: bool """ - self._current_time = current_time + self._supports_managed_authorizer = supports_managed_authorizer @property def time_offset(self): @@ -218,52 +233,6 @@ def time_offset(self, time_offset): self._time_offset = time_offset - @property - def default_back_pressure_object_threshold(self): - """ - Gets the default_back_pressure_object_threshold of this FlowConfigurationDTO. - The default back pressure object threshold. - - :return: The default_back_pressure_object_threshold of this FlowConfigurationDTO. - :rtype: int - """ - return self._default_back_pressure_object_threshold - - @default_back_pressure_object_threshold.setter - def default_back_pressure_object_threshold(self, default_back_pressure_object_threshold): - """ - Sets the default_back_pressure_object_threshold of this FlowConfigurationDTO. - The default back pressure object threshold. - - :param default_back_pressure_object_threshold: The default_back_pressure_object_threshold of this FlowConfigurationDTO. - :type: int - """ - - self._default_back_pressure_object_threshold = default_back_pressure_object_threshold - - @property - def default_back_pressure_data_size_threshold(self): - """ - Gets the default_back_pressure_data_size_threshold of this FlowConfigurationDTO. - The default back pressure data size threshold. - - :return: The default_back_pressure_data_size_threshold of this FlowConfigurationDTO. - :rtype: str - """ - return self._default_back_pressure_data_size_threshold - - @default_back_pressure_data_size_threshold.setter - def default_back_pressure_data_size_threshold(self, default_back_pressure_data_size_threshold): - """ - Sets the default_back_pressure_data_size_threshold of this FlowConfigurationDTO. - The default back pressure data size threshold. - - :param default_back_pressure_data_size_threshold: The default_back_pressure_data_size_threshold of this FlowConfigurationDTO. - :type: str - """ - - self._default_back_pressure_data_size_threshold = default_back_pressure_data_size_threshold - def to_dict(self): """ Returns the model properties as a dict diff --git a/nipyapi/nifi/models/flow_configuration_entity.py b/nipyapi/nifi/models/flow_configuration_entity.py index fa37bd3c..6315a939 100644 --- a/nipyapi/nifi/models/flow_configuration_entity.py +++ b/nipyapi/nifi/models/flow_configuration_entity.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,12 +27,10 @@ class FlowConfigurationEntity(object): and the value is json key in definition. """ swagger_types = { - 'flow_configuration': 'FlowConfigurationDTO' - } + 'flow_configuration': 'FlowConfigurationDTO' } attribute_map = { - 'flow_configuration': 'flowConfiguration' - } + 'flow_configuration': 'flowConfiguration' } def __init__(self, flow_configuration=None): """ @@ -49,7 +46,6 @@ def __init__(self, flow_configuration=None): def flow_configuration(self): """ Gets the flow_configuration of this FlowConfigurationEntity. - The controller configuration. :return: The flow_configuration of this FlowConfigurationEntity. :rtype: FlowConfigurationDTO @@ -60,7 +56,6 @@ def flow_configuration(self): def flow_configuration(self, flow_configuration): """ Sets the flow_configuration of this FlowConfigurationEntity. - The controller configuration. :param flow_configuration: The flow_configuration of this FlowConfigurationEntity. :type: FlowConfigurationDTO diff --git a/nipyapi/nifi/models/flow_dto.py b/nipyapi/nifi/models/flow_dto.py index 9e3c4f69..020e7c31 100644 --- a/nipyapi/nifi/models/flow_dto.py +++ b/nipyapi/nifi/models/flow_dto.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,126 +27,101 @@ class FlowDTO(object): and the value is json key in definition. """ swagger_types = { - 'process_groups': 'list[ProcessGroupEntity]', - 'remote_process_groups': 'list[RemoteProcessGroupEntity]', - 'processors': 'list[ProcessorEntity]', - 'input_ports': 'list[PortEntity]', - 'output_ports': 'list[PortEntity]', 'connections': 'list[ConnectionEntity]', - 'labels': 'list[LabelEntity]', - 'funnels': 'list[FunnelEntity]' - } +'funnels': 'list[FunnelEntity]', +'input_ports': 'list[PortEntity]', +'labels': 'list[LabelEntity]', +'output_ports': 'list[PortEntity]', +'process_groups': 'list[ProcessGroupEntity]', +'processors': 'list[ProcessorEntity]', +'remote_process_groups': 'list[RemoteProcessGroupEntity]' } attribute_map = { - 'process_groups': 'processGroups', - 'remote_process_groups': 'remoteProcessGroups', - 'processors': 'processors', - 'input_ports': 'inputPorts', - 'output_ports': 'outputPorts', 'connections': 'connections', - 'labels': 'labels', - 'funnels': 'funnels' - } +'funnels': 'funnels', +'input_ports': 'inputPorts', +'labels': 'labels', +'output_ports': 'outputPorts', +'process_groups': 'processGroups', +'processors': 'processors', +'remote_process_groups': 'remoteProcessGroups' } - def __init__(self, process_groups=None, remote_process_groups=None, processors=None, input_ports=None, output_ports=None, connections=None, labels=None, funnels=None): + def __init__(self, connections=None, funnels=None, input_ports=None, labels=None, output_ports=None, process_groups=None, processors=None, remote_process_groups=None): """ FlowDTO - a model defined in Swagger """ - self._process_groups = None - self._remote_process_groups = None - self._processors = None - self._input_ports = None - self._output_ports = None self._connections = None - self._labels = None self._funnels = None + self._input_ports = None + self._labels = None + self._output_ports = None + self._process_groups = None + self._processors = None + self._remote_process_groups = None - if process_groups is not None: - self.process_groups = process_groups - if remote_process_groups is not None: - self.remote_process_groups = remote_process_groups - if processors is not None: - self.processors = processors - if input_ports is not None: - self.input_ports = input_ports - if output_ports is not None: - self.output_ports = output_ports if connections is not None: self.connections = connections - if labels is not None: - self.labels = labels if funnels is not None: self.funnels = funnels + if input_ports is not None: + self.input_ports = input_ports + if labels is not None: + self.labels = labels + if output_ports is not None: + self.output_ports = output_ports + if process_groups is not None: + self.process_groups = process_groups + if processors is not None: + self.processors = processors + if remote_process_groups is not None: + self.remote_process_groups = remote_process_groups @property - def process_groups(self): - """ - Gets the process_groups of this FlowDTO. - The process groups in this flow. - - :return: The process_groups of this FlowDTO. - :rtype: list[ProcessGroupEntity] - """ - return self._process_groups - - @process_groups.setter - def process_groups(self, process_groups): - """ - Sets the process_groups of this FlowDTO. - The process groups in this flow. - - :param process_groups: The process_groups of this FlowDTO. - :type: list[ProcessGroupEntity] - """ - - self._process_groups = process_groups - - @property - def remote_process_groups(self): + def connections(self): """ - Gets the remote_process_groups of this FlowDTO. - The remote process groups in this flow. + Gets the connections of this FlowDTO. + The connections in this flow. - :return: The remote_process_groups of this FlowDTO. - :rtype: list[RemoteProcessGroupEntity] + :return: The connections of this FlowDTO. + :rtype: list[ConnectionEntity] """ - return self._remote_process_groups + return self._connections - @remote_process_groups.setter - def remote_process_groups(self, remote_process_groups): + @connections.setter + def connections(self, connections): """ - Sets the remote_process_groups of this FlowDTO. - The remote process groups in this flow. + Sets the connections of this FlowDTO. + The connections in this flow. - :param remote_process_groups: The remote_process_groups of this FlowDTO. - :type: list[RemoteProcessGroupEntity] + :param connections: The connections of this FlowDTO. + :type: list[ConnectionEntity] """ - self._remote_process_groups = remote_process_groups + self._connections = connections @property - def processors(self): + def funnels(self): """ - Gets the processors of this FlowDTO. - The processors in this flow. + Gets the funnels of this FlowDTO. + The funnels in this flow. - :return: The processors of this FlowDTO. - :rtype: list[ProcessorEntity] + :return: The funnels of this FlowDTO. + :rtype: list[FunnelEntity] """ - return self._processors + return self._funnels - @processors.setter - def processors(self, processors): + @funnels.setter + def funnels(self, funnels): """ - Sets the processors of this FlowDTO. - The processors in this flow. + Sets the funnels of this FlowDTO. + The funnels in this flow. - :param processors: The processors of this FlowDTO. - :type: list[ProcessorEntity] + :param funnels: The funnels of this FlowDTO. + :type: list[FunnelEntity] """ - self._processors = processors + self._funnels = funnels @property def input_ports(self): @@ -172,6 +146,29 @@ def input_ports(self, input_ports): self._input_ports = input_ports + @property + def labels(self): + """ + Gets the labels of this FlowDTO. + The labels in this flow. + + :return: The labels of this FlowDTO. + :rtype: list[LabelEntity] + """ + return self._labels + + @labels.setter + def labels(self, labels): + """ + Sets the labels of this FlowDTO. + The labels in this flow. + + :param labels: The labels of this FlowDTO. + :type: list[LabelEntity] + """ + + self._labels = labels + @property def output_ports(self): """ @@ -196,73 +193,73 @@ def output_ports(self, output_ports): self._output_ports = output_ports @property - def connections(self): + def process_groups(self): """ - Gets the connections of this FlowDTO. - The connections in this flow. + Gets the process_groups of this FlowDTO. + The process groups in this flow. - :return: The connections of this FlowDTO. - :rtype: list[ConnectionEntity] + :return: The process_groups of this FlowDTO. + :rtype: list[ProcessGroupEntity] """ - return self._connections + return self._process_groups - @connections.setter - def connections(self, connections): + @process_groups.setter + def process_groups(self, process_groups): """ - Sets the connections of this FlowDTO. - The connections in this flow. + Sets the process_groups of this FlowDTO. + The process groups in this flow. - :param connections: The connections of this FlowDTO. - :type: list[ConnectionEntity] + :param process_groups: The process_groups of this FlowDTO. + :type: list[ProcessGroupEntity] """ - self._connections = connections + self._process_groups = process_groups @property - def labels(self): + def processors(self): """ - Gets the labels of this FlowDTO. - The labels in this flow. + Gets the processors of this FlowDTO. + The processors in this flow. - :return: The labels of this FlowDTO. - :rtype: list[LabelEntity] + :return: The processors of this FlowDTO. + :rtype: list[ProcessorEntity] """ - return self._labels + return self._processors - @labels.setter - def labels(self, labels): + @processors.setter + def processors(self, processors): """ - Sets the labels of this FlowDTO. - The labels in this flow. + Sets the processors of this FlowDTO. + The processors in this flow. - :param labels: The labels of this FlowDTO. - :type: list[LabelEntity] + :param processors: The processors of this FlowDTO. + :type: list[ProcessorEntity] """ - self._labels = labels + self._processors = processors @property - def funnels(self): + def remote_process_groups(self): """ - Gets the funnels of this FlowDTO. - The funnels in this flow. + Gets the remote_process_groups of this FlowDTO. + The remote process groups in this flow. - :return: The funnels of this FlowDTO. - :rtype: list[FunnelEntity] + :return: The remote_process_groups of this FlowDTO. + :rtype: list[RemoteProcessGroupEntity] """ - return self._funnels + return self._remote_process_groups - @funnels.setter - def funnels(self, funnels): + @remote_process_groups.setter + def remote_process_groups(self, remote_process_groups): """ - Sets the funnels of this FlowDTO. - The funnels in this flow. + Sets the remote_process_groups of this FlowDTO. + The remote process groups in this flow. - :param funnels: The funnels of this FlowDTO. - :type: list[FunnelEntity] + :param remote_process_groups: The remote_process_groups of this FlowDTO. + :type: list[RemoteProcessGroupEntity] """ - self._funnels = funnels + self._remote_process_groups = remote_process_groups def to_dict(self): """ diff --git a/nipyapi/nifi/models/flow_entity.py b/nipyapi/nifi/models/flow_entity.py index 7f756fb0..441cae49 100644 --- a/nipyapi/nifi/models/flow_entity.py +++ b/nipyapi/nifi/models/flow_entity.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,12 +27,10 @@ class FlowEntity(object): and the value is json key in definition. """ swagger_types = { - 'flow': 'FlowDTO' - } + 'flow': 'FlowDTO' } attribute_map = { - 'flow': 'flow' - } + 'flow': 'flow' } def __init__(self, flow=None): """ diff --git a/nipyapi/nifi/models/flow_file_dto.py b/nipyapi/nifi/models/flow_file_dto.py index 18088b8d..4de84ed9 100644 --- a/nipyapi/nifi/models/flow_file_dto.py +++ b/nipyapi/nifi/models/flow_file_dto.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,521 +27,547 @@ class FlowFileDTO(object): and the value is json key in definition. """ swagger_types = { - 'uri': 'str', - 'uuid': 'str', - 'filename': 'str', - 'position': 'int', - 'size': 'int', - 'queued_duration': 'int', - 'lineage_duration': 'int', - 'penalty_expires_in': 'int', - 'cluster_node_id': 'str', - 'cluster_node_address': 'str', 'attributes': 'dict(str, str)', - 'content_claim_section': 'str', - 'content_claim_container': 'str', - 'content_claim_identifier': 'str', - 'content_claim_offset': 'int', - 'content_claim_file_size': 'str', - 'content_claim_file_size_bytes': 'int', - 'penalized': 'bool' - } +'cluster_node_address': 'str', +'cluster_node_id': 'str', +'content_claim_container': 'str', +'content_claim_file_size': 'str', +'content_claim_file_size_bytes': 'int', +'content_claim_identifier': 'str', +'content_claim_offset': 'int', +'content_claim_section': 'str', +'filename': 'str', +'lineage_duration': 'int', +'mime_type': 'str', +'penalized': 'bool', +'penalty_expires_in': 'int', +'position': 'int', +'queued_duration': 'int', +'size': 'int', +'uri': 'str', +'uuid': 'str' } attribute_map = { - 'uri': 'uri', - 'uuid': 'uuid', - 'filename': 'filename', - 'position': 'position', - 'size': 'size', - 'queued_duration': 'queuedDuration', - 'lineage_duration': 'lineageDuration', - 'penalty_expires_in': 'penaltyExpiresIn', - 'cluster_node_id': 'clusterNodeId', - 'cluster_node_address': 'clusterNodeAddress', 'attributes': 'attributes', - 'content_claim_section': 'contentClaimSection', - 'content_claim_container': 'contentClaimContainer', - 'content_claim_identifier': 'contentClaimIdentifier', - 'content_claim_offset': 'contentClaimOffset', - 'content_claim_file_size': 'contentClaimFileSize', - 'content_claim_file_size_bytes': 'contentClaimFileSizeBytes', - 'penalized': 'penalized' - } - - def __init__(self, uri=None, uuid=None, filename=None, position=None, size=None, queued_duration=None, lineage_duration=None, penalty_expires_in=None, cluster_node_id=None, cluster_node_address=None, attributes=None, content_claim_section=None, content_claim_container=None, content_claim_identifier=None, content_claim_offset=None, content_claim_file_size=None, content_claim_file_size_bytes=None, penalized=None): +'cluster_node_address': 'clusterNodeAddress', +'cluster_node_id': 'clusterNodeId', +'content_claim_container': 'contentClaimContainer', +'content_claim_file_size': 'contentClaimFileSize', +'content_claim_file_size_bytes': 'contentClaimFileSizeBytes', +'content_claim_identifier': 'contentClaimIdentifier', +'content_claim_offset': 'contentClaimOffset', +'content_claim_section': 'contentClaimSection', +'filename': 'filename', +'lineage_duration': 'lineageDuration', +'mime_type': 'mimeType', +'penalized': 'penalized', +'penalty_expires_in': 'penaltyExpiresIn', +'position': 'position', +'queued_duration': 'queuedDuration', +'size': 'size', +'uri': 'uri', +'uuid': 'uuid' } + + def __init__(self, attributes=None, cluster_node_address=None, cluster_node_id=None, content_claim_container=None, content_claim_file_size=None, content_claim_file_size_bytes=None, content_claim_identifier=None, content_claim_offset=None, content_claim_section=None, filename=None, lineage_duration=None, mime_type=None, penalized=None, penalty_expires_in=None, position=None, queued_duration=None, size=None, uri=None, uuid=None): """ FlowFileDTO - a model defined in Swagger """ - self._uri = None - self._uuid = None - self._filename = None - self._position = None - self._size = None - self._queued_duration = None - self._lineage_duration = None - self._penalty_expires_in = None - self._cluster_node_id = None - self._cluster_node_address = None self._attributes = None - self._content_claim_section = None + self._cluster_node_address = None + self._cluster_node_id = None self._content_claim_container = None - self._content_claim_identifier = None - self._content_claim_offset = None self._content_claim_file_size = None self._content_claim_file_size_bytes = None + self._content_claim_identifier = None + self._content_claim_offset = None + self._content_claim_section = None + self._filename = None + self._lineage_duration = None + self._mime_type = None self._penalized = None + self._penalty_expires_in = None + self._position = None + self._queued_duration = None + self._size = None + self._uri = None + self._uuid = None - if uri is not None: - self.uri = uri - if uuid is not None: - self.uuid = uuid - if filename is not None: - self.filename = filename - if position is not None: - self.position = position - if size is not None: - self.size = size - if queued_duration is not None: - self.queued_duration = queued_duration - if lineage_duration is not None: - self.lineage_duration = lineage_duration - if penalty_expires_in is not None: - self.penalty_expires_in = penalty_expires_in - if cluster_node_id is not None: - self.cluster_node_id = cluster_node_id - if cluster_node_address is not None: - self.cluster_node_address = cluster_node_address if attributes is not None: self.attributes = attributes - if content_claim_section is not None: - self.content_claim_section = content_claim_section + if cluster_node_address is not None: + self.cluster_node_address = cluster_node_address + if cluster_node_id is not None: + self.cluster_node_id = cluster_node_id if content_claim_container is not None: self.content_claim_container = content_claim_container - if content_claim_identifier is not None: - self.content_claim_identifier = content_claim_identifier - if content_claim_offset is not None: - self.content_claim_offset = content_claim_offset if content_claim_file_size is not None: self.content_claim_file_size = content_claim_file_size if content_claim_file_size_bytes is not None: self.content_claim_file_size_bytes = content_claim_file_size_bytes + if content_claim_identifier is not None: + self.content_claim_identifier = content_claim_identifier + if content_claim_offset is not None: + self.content_claim_offset = content_claim_offset + if content_claim_section is not None: + self.content_claim_section = content_claim_section + if filename is not None: + self.filename = filename + if lineage_duration is not None: + self.lineage_duration = lineage_duration + if mime_type is not None: + self.mime_type = mime_type if penalized is not None: self.penalized = penalized + if penalty_expires_in is not None: + self.penalty_expires_in = penalty_expires_in + if position is not None: + self.position = position + if queued_duration is not None: + self.queued_duration = queued_duration + if size is not None: + self.size = size + if uri is not None: + self.uri = uri + if uuid is not None: + self.uuid = uuid @property - def uri(self): + def attributes(self): """ - Gets the uri of this FlowFileDTO. - The URI that can be used to access this FlowFile. + Gets the attributes of this FlowFileDTO. + The FlowFile attributes. - :return: The uri of this FlowFileDTO. - :rtype: str + :return: The attributes of this FlowFileDTO. + :rtype: dict(str, str) """ - return self._uri + return self._attributes - @uri.setter - def uri(self, uri): + @attributes.setter + def attributes(self, attributes): """ - Sets the uri of this FlowFileDTO. - The URI that can be used to access this FlowFile. + Sets the attributes of this FlowFileDTO. + The FlowFile attributes. - :param uri: The uri of this FlowFileDTO. - :type: str + :param attributes: The attributes of this FlowFileDTO. + :type: dict(str, str) """ - self._uri = uri + self._attributes = attributes @property - def uuid(self): + def cluster_node_address(self): """ - Gets the uuid of this FlowFileDTO. - The FlowFile UUID. + Gets the cluster_node_address of this FlowFileDTO. + The label for the node where this FlowFile resides. - :return: The uuid of this FlowFileDTO. + :return: The cluster_node_address of this FlowFileDTO. :rtype: str """ - return self._uuid + return self._cluster_node_address - @uuid.setter - def uuid(self, uuid): + @cluster_node_address.setter + def cluster_node_address(self, cluster_node_address): """ - Sets the uuid of this FlowFileDTO. - The FlowFile UUID. + Sets the cluster_node_address of this FlowFileDTO. + The label for the node where this FlowFile resides. - :param uuid: The uuid of this FlowFileDTO. + :param cluster_node_address: The cluster_node_address of this FlowFileDTO. :type: str """ - self._uuid = uuid + self._cluster_node_address = cluster_node_address @property - def filename(self): + def cluster_node_id(self): """ - Gets the filename of this FlowFileDTO. - The FlowFile filename. + Gets the cluster_node_id of this FlowFileDTO. + The id of the node where this FlowFile resides. - :return: The filename of this FlowFileDTO. + :return: The cluster_node_id of this FlowFileDTO. :rtype: str """ - return self._filename + return self._cluster_node_id - @filename.setter - def filename(self, filename): + @cluster_node_id.setter + def cluster_node_id(self, cluster_node_id): """ - Sets the filename of this FlowFileDTO. - The FlowFile filename. + Sets the cluster_node_id of this FlowFileDTO. + The id of the node where this FlowFile resides. - :param filename: The filename of this FlowFileDTO. + :param cluster_node_id: The cluster_node_id of this FlowFileDTO. :type: str """ - self._filename = filename + self._cluster_node_id = cluster_node_id @property - def position(self): + def content_claim_container(self): """ - Gets the position of this FlowFileDTO. - The FlowFile's position in the queue. + Gets the content_claim_container of this FlowFileDTO. + The container in which the content claim lives. - :return: The position of this FlowFileDTO. - :rtype: int + :return: The content_claim_container of this FlowFileDTO. + :rtype: str """ - return self._position + return self._content_claim_container - @position.setter - def position(self, position): + @content_claim_container.setter + def content_claim_container(self, content_claim_container): """ - Sets the position of this FlowFileDTO. - The FlowFile's position in the queue. + Sets the content_claim_container of this FlowFileDTO. + The container in which the content claim lives. - :param position: The position of this FlowFileDTO. - :type: int + :param content_claim_container: The content_claim_container of this FlowFileDTO. + :type: str """ - self._position = position + self._content_claim_container = content_claim_container @property - def size(self): + def content_claim_file_size(self): """ - Gets the size of this FlowFileDTO. - The FlowFile file size. + Gets the content_claim_file_size of this FlowFileDTO. + The file size of the content claim formatted. - :return: The size of this FlowFileDTO. - :rtype: int + :return: The content_claim_file_size of this FlowFileDTO. + :rtype: str """ - return self._size + return self._content_claim_file_size - @size.setter - def size(self, size): + @content_claim_file_size.setter + def content_claim_file_size(self, content_claim_file_size): """ - Sets the size of this FlowFileDTO. - The FlowFile file size. + Sets the content_claim_file_size of this FlowFileDTO. + The file size of the content claim formatted. - :param size: The size of this FlowFileDTO. - :type: int + :param content_claim_file_size: The content_claim_file_size of this FlowFileDTO. + :type: str """ - self._size = size + self._content_claim_file_size = content_claim_file_size @property - def queued_duration(self): + def content_claim_file_size_bytes(self): """ - Gets the queued_duration of this FlowFileDTO. - How long this FlowFile has been enqueued. + Gets the content_claim_file_size_bytes of this FlowFileDTO. + The file size of the content claim in bytes. - :return: The queued_duration of this FlowFileDTO. + :return: The content_claim_file_size_bytes of this FlowFileDTO. :rtype: int """ - return self._queued_duration + return self._content_claim_file_size_bytes - @queued_duration.setter - def queued_duration(self, queued_duration): + @content_claim_file_size_bytes.setter + def content_claim_file_size_bytes(self, content_claim_file_size_bytes): """ - Sets the queued_duration of this FlowFileDTO. - How long this FlowFile has been enqueued. + Sets the content_claim_file_size_bytes of this FlowFileDTO. + The file size of the content claim in bytes. - :param queued_duration: The queued_duration of this FlowFileDTO. + :param content_claim_file_size_bytes: The content_claim_file_size_bytes of this FlowFileDTO. :type: int """ - self._queued_duration = queued_duration + self._content_claim_file_size_bytes = content_claim_file_size_bytes @property - def lineage_duration(self): + def content_claim_identifier(self): """ - Gets the lineage_duration of this FlowFileDTO. - Duration since the FlowFile's greatest ancestor entered the flow. + Gets the content_claim_identifier of this FlowFileDTO. + The identifier of the content claim. - :return: The lineage_duration of this FlowFileDTO. - :rtype: int + :return: The content_claim_identifier of this FlowFileDTO. + :rtype: str """ - return self._lineage_duration + return self._content_claim_identifier - @lineage_duration.setter - def lineage_duration(self, lineage_duration): + @content_claim_identifier.setter + def content_claim_identifier(self, content_claim_identifier): """ - Sets the lineage_duration of this FlowFileDTO. - Duration since the FlowFile's greatest ancestor entered the flow. + Sets the content_claim_identifier of this FlowFileDTO. + The identifier of the content claim. - :param lineage_duration: The lineage_duration of this FlowFileDTO. - :type: int + :param content_claim_identifier: The content_claim_identifier of this FlowFileDTO. + :type: str """ - self._lineage_duration = lineage_duration + self._content_claim_identifier = content_claim_identifier @property - def penalty_expires_in(self): + def content_claim_offset(self): """ - Gets the penalty_expires_in of this FlowFileDTO. - How long in milliseconds until the FlowFile penalty expires. + Gets the content_claim_offset of this FlowFileDTO. + The offset into the content claim where the flowfile's content begins. - :return: The penalty_expires_in of this FlowFileDTO. + :return: The content_claim_offset of this FlowFileDTO. :rtype: int """ - return self._penalty_expires_in + return self._content_claim_offset - @penalty_expires_in.setter - def penalty_expires_in(self, penalty_expires_in): + @content_claim_offset.setter + def content_claim_offset(self, content_claim_offset): """ - Sets the penalty_expires_in of this FlowFileDTO. - How long in milliseconds until the FlowFile penalty expires. + Sets the content_claim_offset of this FlowFileDTO. + The offset into the content claim where the flowfile's content begins. - :param penalty_expires_in: The penalty_expires_in of this FlowFileDTO. + :param content_claim_offset: The content_claim_offset of this FlowFileDTO. :type: int """ - self._penalty_expires_in = penalty_expires_in + self._content_claim_offset = content_claim_offset @property - def cluster_node_id(self): + def content_claim_section(self): """ - Gets the cluster_node_id of this FlowFileDTO. - The id of the node where this FlowFile resides. + Gets the content_claim_section of this FlowFileDTO. + The section in which the content claim lives. - :return: The cluster_node_id of this FlowFileDTO. + :return: The content_claim_section of this FlowFileDTO. :rtype: str """ - return self._cluster_node_id + return self._content_claim_section - @cluster_node_id.setter - def cluster_node_id(self, cluster_node_id): + @content_claim_section.setter + def content_claim_section(self, content_claim_section): """ - Sets the cluster_node_id of this FlowFileDTO. - The id of the node where this FlowFile resides. + Sets the content_claim_section of this FlowFileDTO. + The section in which the content claim lives. - :param cluster_node_id: The cluster_node_id of this FlowFileDTO. + :param content_claim_section: The content_claim_section of this FlowFileDTO. :type: str """ - self._cluster_node_id = cluster_node_id + self._content_claim_section = content_claim_section @property - def cluster_node_address(self): + def filename(self): """ - Gets the cluster_node_address of this FlowFileDTO. - The label for the node where this FlowFile resides. + Gets the filename of this FlowFileDTO. + The FlowFile filename. - :return: The cluster_node_address of this FlowFileDTO. + :return: The filename of this FlowFileDTO. :rtype: str """ - return self._cluster_node_address + return self._filename - @cluster_node_address.setter - def cluster_node_address(self, cluster_node_address): + @filename.setter + def filename(self, filename): """ - Sets the cluster_node_address of this FlowFileDTO. - The label for the node where this FlowFile resides. + Sets the filename of this FlowFileDTO. + The FlowFile filename. - :param cluster_node_address: The cluster_node_address of this FlowFileDTO. + :param filename: The filename of this FlowFileDTO. :type: str """ - self._cluster_node_address = cluster_node_address + self._filename = filename @property - def attributes(self): + def lineage_duration(self): """ - Gets the attributes of this FlowFileDTO. - The FlowFile attributes. + Gets the lineage_duration of this FlowFileDTO. + Duration since the FlowFile's greatest ancestor entered the flow. - :return: The attributes of this FlowFileDTO. - :rtype: dict(str, str) + :return: The lineage_duration of this FlowFileDTO. + :rtype: int """ - return self._attributes + return self._lineage_duration - @attributes.setter - def attributes(self, attributes): + @lineage_duration.setter + def lineage_duration(self, lineage_duration): """ - Sets the attributes of this FlowFileDTO. - The FlowFile attributes. + Sets the lineage_duration of this FlowFileDTO. + Duration since the FlowFile's greatest ancestor entered the flow. - :param attributes: The attributes of this FlowFileDTO. - :type: dict(str, str) + :param lineage_duration: The lineage_duration of this FlowFileDTO. + :type: int """ - self._attributes = attributes + self._lineage_duration = lineage_duration @property - def content_claim_section(self): + def mime_type(self): """ - Gets the content_claim_section of this FlowFileDTO. - The section in which the content claim lives. + Gets the mime_type of this FlowFileDTO. + The FlowFile mime type. - :return: The content_claim_section of this FlowFileDTO. + :return: The mime_type of this FlowFileDTO. :rtype: str """ - return self._content_claim_section + return self._mime_type - @content_claim_section.setter - def content_claim_section(self, content_claim_section): + @mime_type.setter + def mime_type(self, mime_type): """ - Sets the content_claim_section of this FlowFileDTO. - The section in which the content claim lives. + Sets the mime_type of this FlowFileDTO. + The FlowFile mime type. - :param content_claim_section: The content_claim_section of this FlowFileDTO. + :param mime_type: The mime_type of this FlowFileDTO. :type: str """ - self._content_claim_section = content_claim_section + self._mime_type = mime_type @property - def content_claim_container(self): + def penalized(self): """ - Gets the content_claim_container of this FlowFileDTO. - The container in which the content claim lives. + Gets the penalized of this FlowFileDTO. + If the FlowFile is penalized. - :return: The content_claim_container of this FlowFileDTO. - :rtype: str + :return: The penalized of this FlowFileDTO. + :rtype: bool """ - return self._content_claim_container + return self._penalized - @content_claim_container.setter - def content_claim_container(self, content_claim_container): + @penalized.setter + def penalized(self, penalized): """ - Sets the content_claim_container of this FlowFileDTO. - The container in which the content claim lives. + Sets the penalized of this FlowFileDTO. + If the FlowFile is penalized. - :param content_claim_container: The content_claim_container of this FlowFileDTO. - :type: str + :param penalized: The penalized of this FlowFileDTO. + :type: bool """ - self._content_claim_container = content_claim_container + self._penalized = penalized @property - def content_claim_identifier(self): + def penalty_expires_in(self): """ - Gets the content_claim_identifier of this FlowFileDTO. - The identifier of the content claim. + Gets the penalty_expires_in of this FlowFileDTO. + How long in milliseconds until the FlowFile penalty expires. - :return: The content_claim_identifier of this FlowFileDTO. - :rtype: str + :return: The penalty_expires_in of this FlowFileDTO. + :rtype: int """ - return self._content_claim_identifier + return self._penalty_expires_in - @content_claim_identifier.setter - def content_claim_identifier(self, content_claim_identifier): + @penalty_expires_in.setter + def penalty_expires_in(self, penalty_expires_in): """ - Sets the content_claim_identifier of this FlowFileDTO. - The identifier of the content claim. + Sets the penalty_expires_in of this FlowFileDTO. + How long in milliseconds until the FlowFile penalty expires. - :param content_claim_identifier: The content_claim_identifier of this FlowFileDTO. - :type: str + :param penalty_expires_in: The penalty_expires_in of this FlowFileDTO. + :type: int """ - self._content_claim_identifier = content_claim_identifier + self._penalty_expires_in = penalty_expires_in @property - def content_claim_offset(self): + def position(self): """ - Gets the content_claim_offset of this FlowFileDTO. - The offset into the content claim where the flowfile's content begins. + Gets the position of this FlowFileDTO. + The FlowFile's position in the queue. - :return: The content_claim_offset of this FlowFileDTO. + :return: The position of this FlowFileDTO. :rtype: int """ - return self._content_claim_offset + return self._position - @content_claim_offset.setter - def content_claim_offset(self, content_claim_offset): + @position.setter + def position(self, position): """ - Sets the content_claim_offset of this FlowFileDTO. - The offset into the content claim where the flowfile's content begins. + Sets the position of this FlowFileDTO. + The FlowFile's position in the queue. - :param content_claim_offset: The content_claim_offset of this FlowFileDTO. + :param position: The position of this FlowFileDTO. :type: int """ - self._content_claim_offset = content_claim_offset + self._position = position @property - def content_claim_file_size(self): + def queued_duration(self): """ - Gets the content_claim_file_size of this FlowFileDTO. - The file size of the content claim formatted. + Gets the queued_duration of this FlowFileDTO. + How long this FlowFile has been enqueued. - :return: The content_claim_file_size of this FlowFileDTO. - :rtype: str + :return: The queued_duration of this FlowFileDTO. + :rtype: int """ - return self._content_claim_file_size + return self._queued_duration - @content_claim_file_size.setter - def content_claim_file_size(self, content_claim_file_size): + @queued_duration.setter + def queued_duration(self, queued_duration): """ - Sets the content_claim_file_size of this FlowFileDTO. - The file size of the content claim formatted. + Sets the queued_duration of this FlowFileDTO. + How long this FlowFile has been enqueued. - :param content_claim_file_size: The content_claim_file_size of this FlowFileDTO. - :type: str + :param queued_duration: The queued_duration of this FlowFileDTO. + :type: int """ - self._content_claim_file_size = content_claim_file_size + self._queued_duration = queued_duration @property - def content_claim_file_size_bytes(self): + def size(self): """ - Gets the content_claim_file_size_bytes of this FlowFileDTO. - The file size of the content claim in bytes. + Gets the size of this FlowFileDTO. + The FlowFile file size. - :return: The content_claim_file_size_bytes of this FlowFileDTO. + :return: The size of this FlowFileDTO. :rtype: int """ - return self._content_claim_file_size_bytes + return self._size - @content_claim_file_size_bytes.setter - def content_claim_file_size_bytes(self, content_claim_file_size_bytes): + @size.setter + def size(self, size): """ - Sets the content_claim_file_size_bytes of this FlowFileDTO. - The file size of the content claim in bytes. + Sets the size of this FlowFileDTO. + The FlowFile file size. - :param content_claim_file_size_bytes: The content_claim_file_size_bytes of this FlowFileDTO. + :param size: The size of this FlowFileDTO. :type: int """ - self._content_claim_file_size_bytes = content_claim_file_size_bytes + self._size = size @property - def penalized(self): + def uri(self): """ - Gets the penalized of this FlowFileDTO. - If the FlowFile is penalized. + Gets the uri of this FlowFileDTO. + The URI that can be used to access this FlowFile. - :return: The penalized of this FlowFileDTO. - :rtype: bool + :return: The uri of this FlowFileDTO. + :rtype: str """ - return self._penalized + return self._uri - @penalized.setter - def penalized(self, penalized): + @uri.setter + def uri(self, uri): """ - Sets the penalized of this FlowFileDTO. - If the FlowFile is penalized. + Sets the uri of this FlowFileDTO. + The URI that can be used to access this FlowFile. - :param penalized: The penalized of this FlowFileDTO. - :type: bool + :param uri: The uri of this FlowFileDTO. + :type: str """ - self._penalized = penalized + self._uri = uri + + @property + def uuid(self): + """ + Gets the uuid of this FlowFileDTO. + The FlowFile UUID. + + :return: The uuid of this FlowFileDTO. + :rtype: str + """ + return self._uuid + + @uuid.setter + def uuid(self, uuid): + """ + Sets the uuid of this FlowFileDTO. + The FlowFile UUID. + + :param uuid: The uuid of this FlowFileDTO. + :type: str + """ + + self._uuid = uuid def to_dict(self): """ diff --git a/nipyapi/nifi/models/flow_file_entity.py b/nipyapi/nifi/models/flow_file_entity.py index cfc2c908..fbbf3283 100644 --- a/nipyapi/nifi/models/flow_file_entity.py +++ b/nipyapi/nifi/models/flow_file_entity.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,12 +27,10 @@ class FlowFileEntity(object): and the value is json key in definition. """ swagger_types = { - 'flow_file': 'FlowFileDTO' - } + 'flow_file': 'FlowFileDTO' } attribute_map = { - 'flow_file': 'flowFile' - } + 'flow_file': 'flowFile' } def __init__(self, flow_file=None): """ diff --git a/nipyapi/nifi/models/flow_file_summary_dto.py b/nipyapi/nifi/models/flow_file_summary_dto.py index 85e6b3be..d6d41332 100644 --- a/nipyapi/nifi/models/flow_file_summary_dto.py +++ b/nipyapi/nifi/models/flow_file_summary_dto.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,118 +27,121 @@ class FlowFileSummaryDTO(object): and the value is json key in definition. """ swagger_types = { - 'uri': 'str', - 'uuid': 'str', - 'filename': 'str', - 'position': 'int', - 'size': 'int', - 'queued_duration': 'int', - 'lineage_duration': 'int', - 'penalty_expires_in': 'int', - 'cluster_node_id': 'str', 'cluster_node_address': 'str', - 'penalized': 'bool' - } +'cluster_node_id': 'str', +'filename': 'str', +'lineage_duration': 'int', +'mime_type': 'str', +'penalized': 'bool', +'penalty_expires_in': 'int', +'position': 'int', +'queued_duration': 'int', +'size': 'int', +'uri': 'str', +'uuid': 'str' } attribute_map = { - 'uri': 'uri', - 'uuid': 'uuid', - 'filename': 'filename', - 'position': 'position', - 'size': 'size', - 'queued_duration': 'queuedDuration', - 'lineage_duration': 'lineageDuration', - 'penalty_expires_in': 'penaltyExpiresIn', - 'cluster_node_id': 'clusterNodeId', 'cluster_node_address': 'clusterNodeAddress', - 'penalized': 'penalized' - } - - def __init__(self, uri=None, uuid=None, filename=None, position=None, size=None, queued_duration=None, lineage_duration=None, penalty_expires_in=None, cluster_node_id=None, cluster_node_address=None, penalized=None): +'cluster_node_id': 'clusterNodeId', +'filename': 'filename', +'lineage_duration': 'lineageDuration', +'mime_type': 'mimeType', +'penalized': 'penalized', +'penalty_expires_in': 'penaltyExpiresIn', +'position': 'position', +'queued_duration': 'queuedDuration', +'size': 'size', +'uri': 'uri', +'uuid': 'uuid' } + + def __init__(self, cluster_node_address=None, cluster_node_id=None, filename=None, lineage_duration=None, mime_type=None, penalized=None, penalty_expires_in=None, position=None, queued_duration=None, size=None, uri=None, uuid=None): """ FlowFileSummaryDTO - a model defined in Swagger """ - self._uri = None - self._uuid = None + self._cluster_node_address = None + self._cluster_node_id = None self._filename = None - self._position = None - self._size = None - self._queued_duration = None self._lineage_duration = None - self._penalty_expires_in = None - self._cluster_node_id = None - self._cluster_node_address = None + self._mime_type = None self._penalized = None + self._penalty_expires_in = None + self._position = None + self._queued_duration = None + self._size = None + self._uri = None + self._uuid = None - if uri is not None: - self.uri = uri - if uuid is not None: - self.uuid = uuid + if cluster_node_address is not None: + self.cluster_node_address = cluster_node_address + if cluster_node_id is not None: + self.cluster_node_id = cluster_node_id if filename is not None: self.filename = filename - if position is not None: - self.position = position - if size is not None: - self.size = size - if queued_duration is not None: - self.queued_duration = queued_duration if lineage_duration is not None: self.lineage_duration = lineage_duration - if penalty_expires_in is not None: - self.penalty_expires_in = penalty_expires_in - if cluster_node_id is not None: - self.cluster_node_id = cluster_node_id - if cluster_node_address is not None: - self.cluster_node_address = cluster_node_address + if mime_type is not None: + self.mime_type = mime_type if penalized is not None: self.penalized = penalized + if penalty_expires_in is not None: + self.penalty_expires_in = penalty_expires_in + if position is not None: + self.position = position + if queued_duration is not None: + self.queued_duration = queued_duration + if size is not None: + self.size = size + if uri is not None: + self.uri = uri + if uuid is not None: + self.uuid = uuid @property - def uri(self): + def cluster_node_address(self): """ - Gets the uri of this FlowFileSummaryDTO. - The URI that can be used to access this FlowFile. + Gets the cluster_node_address of this FlowFileSummaryDTO. + The label for the node where this FlowFile resides. - :return: The uri of this FlowFileSummaryDTO. + :return: The cluster_node_address of this FlowFileSummaryDTO. :rtype: str """ - return self._uri + return self._cluster_node_address - @uri.setter - def uri(self, uri): + @cluster_node_address.setter + def cluster_node_address(self, cluster_node_address): """ - Sets the uri of this FlowFileSummaryDTO. - The URI that can be used to access this FlowFile. + Sets the cluster_node_address of this FlowFileSummaryDTO. + The label for the node where this FlowFile resides. - :param uri: The uri of this FlowFileSummaryDTO. + :param cluster_node_address: The cluster_node_address of this FlowFileSummaryDTO. :type: str """ - self._uri = uri + self._cluster_node_address = cluster_node_address @property - def uuid(self): + def cluster_node_id(self): """ - Gets the uuid of this FlowFileSummaryDTO. - The FlowFile UUID. + Gets the cluster_node_id of this FlowFileSummaryDTO. + The id of the node where this FlowFile resides. - :return: The uuid of this FlowFileSummaryDTO. + :return: The cluster_node_id of this FlowFileSummaryDTO. :rtype: str """ - return self._uuid + return self._cluster_node_id - @uuid.setter - def uuid(self, uuid): + @cluster_node_id.setter + def cluster_node_id(self, cluster_node_id): """ - Sets the uuid of this FlowFileSummaryDTO. - The FlowFile UUID. + Sets the cluster_node_id of this FlowFileSummaryDTO. + The id of the node where this FlowFile resides. - :param uuid: The uuid of this FlowFileSummaryDTO. + :param cluster_node_id: The cluster_node_id of this FlowFileSummaryDTO. :type: str """ - self._uuid = uuid + self._cluster_node_id = cluster_node_id @property def filename(self): @@ -165,188 +167,211 @@ def filename(self, filename): self._filename = filename @property - def position(self): + def lineage_duration(self): """ - Gets the position of this FlowFileSummaryDTO. - The FlowFile's position in the queue. + Gets the lineage_duration of this FlowFileSummaryDTO. + Duration since the FlowFile's greatest ancestor entered the flow. - :return: The position of this FlowFileSummaryDTO. + :return: The lineage_duration of this FlowFileSummaryDTO. :rtype: int """ - return self._position + return self._lineage_duration - @position.setter - def position(self, position): + @lineage_duration.setter + def lineage_duration(self, lineage_duration): """ - Sets the position of this FlowFileSummaryDTO. - The FlowFile's position in the queue. + Sets the lineage_duration of this FlowFileSummaryDTO. + Duration since the FlowFile's greatest ancestor entered the flow. - :param position: The position of this FlowFileSummaryDTO. + :param lineage_duration: The lineage_duration of this FlowFileSummaryDTO. :type: int """ - self._position = position + self._lineage_duration = lineage_duration @property - def size(self): + def mime_type(self): """ - Gets the size of this FlowFileSummaryDTO. - The FlowFile file size. + Gets the mime_type of this FlowFileSummaryDTO. + The FlowFile mime type. - :return: The size of this FlowFileSummaryDTO. - :rtype: int + :return: The mime_type of this FlowFileSummaryDTO. + :rtype: str """ - return self._size + return self._mime_type - @size.setter - def size(self, size): + @mime_type.setter + def mime_type(self, mime_type): """ - Sets the size of this FlowFileSummaryDTO. - The FlowFile file size. + Sets the mime_type of this FlowFileSummaryDTO. + The FlowFile mime type. - :param size: The size of this FlowFileSummaryDTO. - :type: int + :param mime_type: The mime_type of this FlowFileSummaryDTO. + :type: str """ - self._size = size + self._mime_type = mime_type @property - def queued_duration(self): + def penalized(self): """ - Gets the queued_duration of this FlowFileSummaryDTO. - How long this FlowFile has been enqueued. + Gets the penalized of this FlowFileSummaryDTO. + If the FlowFile is penalized. - :return: The queued_duration of this FlowFileSummaryDTO. + :return: The penalized of this FlowFileSummaryDTO. + :rtype: bool + """ + return self._penalized + + @penalized.setter + def penalized(self, penalized): + """ + Sets the penalized of this FlowFileSummaryDTO. + If the FlowFile is penalized. + + :param penalized: The penalized of this FlowFileSummaryDTO. + :type: bool + """ + + self._penalized = penalized + + @property + def penalty_expires_in(self): + """ + Gets the penalty_expires_in of this FlowFileSummaryDTO. + How long in milliseconds until the FlowFile penalty expires. + + :return: The penalty_expires_in of this FlowFileSummaryDTO. :rtype: int """ - return self._queued_duration + return self._penalty_expires_in - @queued_duration.setter - def queued_duration(self, queued_duration): + @penalty_expires_in.setter + def penalty_expires_in(self, penalty_expires_in): """ - Sets the queued_duration of this FlowFileSummaryDTO. - How long this FlowFile has been enqueued. + Sets the penalty_expires_in of this FlowFileSummaryDTO. + How long in milliseconds until the FlowFile penalty expires. - :param queued_duration: The queued_duration of this FlowFileSummaryDTO. + :param penalty_expires_in: The penalty_expires_in of this FlowFileSummaryDTO. :type: int """ - self._queued_duration = queued_duration + self._penalty_expires_in = penalty_expires_in @property - def lineage_duration(self): + def position(self): """ - Gets the lineage_duration of this FlowFileSummaryDTO. - Duration since the FlowFile's greatest ancestor entered the flow. + Gets the position of this FlowFileSummaryDTO. + The FlowFile's position in the queue. - :return: The lineage_duration of this FlowFileSummaryDTO. + :return: The position of this FlowFileSummaryDTO. :rtype: int """ - return self._lineage_duration + return self._position - @lineage_duration.setter - def lineage_duration(self, lineage_duration): + @position.setter + def position(self, position): """ - Sets the lineage_duration of this FlowFileSummaryDTO. - Duration since the FlowFile's greatest ancestor entered the flow. + Sets the position of this FlowFileSummaryDTO. + The FlowFile's position in the queue. - :param lineage_duration: The lineage_duration of this FlowFileSummaryDTO. + :param position: The position of this FlowFileSummaryDTO. :type: int """ - self._lineage_duration = lineage_duration + self._position = position @property - def penalty_expires_in(self): + def queued_duration(self): """ - Gets the penalty_expires_in of this FlowFileSummaryDTO. - How long in milliseconds until the FlowFile penalty expires. + Gets the queued_duration of this FlowFileSummaryDTO. + How long this FlowFile has been enqueued. - :return: The penalty_expires_in of this FlowFileSummaryDTO. + :return: The queued_duration of this FlowFileSummaryDTO. :rtype: int """ - return self._penalty_expires_in + return self._queued_duration - @penalty_expires_in.setter - def penalty_expires_in(self, penalty_expires_in): + @queued_duration.setter + def queued_duration(self, queued_duration): """ - Sets the penalty_expires_in of this FlowFileSummaryDTO. - How long in milliseconds until the FlowFile penalty expires. + Sets the queued_duration of this FlowFileSummaryDTO. + How long this FlowFile has been enqueued. - :param penalty_expires_in: The penalty_expires_in of this FlowFileSummaryDTO. + :param queued_duration: The queued_duration of this FlowFileSummaryDTO. :type: int """ - self._penalty_expires_in = penalty_expires_in + self._queued_duration = queued_duration @property - def cluster_node_id(self): + def size(self): """ - Gets the cluster_node_id of this FlowFileSummaryDTO. - The id of the node where this FlowFile resides. + Gets the size of this FlowFileSummaryDTO. + The FlowFile file size. - :return: The cluster_node_id of this FlowFileSummaryDTO. - :rtype: str + :return: The size of this FlowFileSummaryDTO. + :rtype: int """ - return self._cluster_node_id + return self._size - @cluster_node_id.setter - def cluster_node_id(self, cluster_node_id): + @size.setter + def size(self, size): """ - Sets the cluster_node_id of this FlowFileSummaryDTO. - The id of the node where this FlowFile resides. + Sets the size of this FlowFileSummaryDTO. + The FlowFile file size. - :param cluster_node_id: The cluster_node_id of this FlowFileSummaryDTO. - :type: str + :param size: The size of this FlowFileSummaryDTO. + :type: int """ - self._cluster_node_id = cluster_node_id + self._size = size @property - def cluster_node_address(self): + def uri(self): """ - Gets the cluster_node_address of this FlowFileSummaryDTO. - The label for the node where this FlowFile resides. + Gets the uri of this FlowFileSummaryDTO. + The URI that can be used to access this FlowFile. - :return: The cluster_node_address of this FlowFileSummaryDTO. + :return: The uri of this FlowFileSummaryDTO. :rtype: str """ - return self._cluster_node_address + return self._uri - @cluster_node_address.setter - def cluster_node_address(self, cluster_node_address): + @uri.setter + def uri(self, uri): """ - Sets the cluster_node_address of this FlowFileSummaryDTO. - The label for the node where this FlowFile resides. + Sets the uri of this FlowFileSummaryDTO. + The URI that can be used to access this FlowFile. - :param cluster_node_address: The cluster_node_address of this FlowFileSummaryDTO. + :param uri: The uri of this FlowFileSummaryDTO. :type: str """ - self._cluster_node_address = cluster_node_address + self._uri = uri @property - def penalized(self): + def uuid(self): """ - Gets the penalized of this FlowFileSummaryDTO. - If the FlowFile is penalized. + Gets the uuid of this FlowFileSummaryDTO. + The FlowFile UUID. - :return: The penalized of this FlowFileSummaryDTO. - :rtype: bool + :return: The uuid of this FlowFileSummaryDTO. + :rtype: str """ - return self._penalized + return self._uuid - @penalized.setter - def penalized(self, penalized): + @uuid.setter + def uuid(self, uuid): """ - Sets the penalized of this FlowFileSummaryDTO. - If the FlowFile is penalized. + Sets the uuid of this FlowFileSummaryDTO. + The FlowFile UUID. - :param penalized: The penalized of this FlowFileSummaryDTO. - :type: bool + :param uuid: The uuid of this FlowFileSummaryDTO. + :type: str """ - self._penalized = penalized + self._uuid = uuid def to_dict(self): """ diff --git a/nipyapi/nifi/models/flow_registry_branch_dto.py b/nipyapi/nifi/models/flow_registry_branch_dto.py new file mode 100644 index 00000000..5776e521 --- /dev/null +++ b/nipyapi/nifi/models/flow_registry_branch_dto.py @@ -0,0 +1,119 @@ +""" + Apache NiFi REST API + + REST API definition for Apache NiFi web services + + OpenAPI spec version: 2.5.0 + Contact: dev@nifi.apache.org + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from pprint import pformat +import re + + +class FlowRegistryBranchDTO(object): + """ + NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. + """ + + + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'name': 'str' } + + attribute_map = { + 'name': 'name' } + + def __init__(self, name=None): + """ + FlowRegistryBranchDTO - a model defined in Swagger + """ + + self._name = None + + if name is not None: + self.name = name + + @property + def name(self): + """ + Gets the name of this FlowRegistryBranchDTO. + The branch name + + :return: The name of this FlowRegistryBranchDTO. + :rtype: str + """ + return self._name + + @name.setter + def name(self, name): + """ + Sets the name of this FlowRegistryBranchDTO. + The branch name + + :param name: The name of this FlowRegistryBranchDTO. + :type: str + """ + + self._name = name + + 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, FlowRegistryBranchDTO): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """ + Returns true if both objects are not equal + """ + return not self == other diff --git a/nipyapi/nifi/models/flow_registry_branch_entity.py b/nipyapi/nifi/models/flow_registry_branch_entity.py new file mode 100644 index 00000000..1d8a9d1c --- /dev/null +++ b/nipyapi/nifi/models/flow_registry_branch_entity.py @@ -0,0 +1,117 @@ +""" + Apache NiFi REST API + + REST API definition for Apache NiFi web services + + OpenAPI spec version: 2.5.0 + Contact: dev@nifi.apache.org + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from pprint import pformat +import re + + +class FlowRegistryBranchEntity(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 = { + 'branch': 'FlowRegistryBranchDTO' } + + attribute_map = { + 'branch': 'branch' } + + def __init__(self, branch=None): + """ + FlowRegistryBranchEntity - a model defined in Swagger + """ + + self._branch = None + + if branch is not None: + self.branch = branch + + @property + def branch(self): + """ + Gets the branch of this FlowRegistryBranchEntity. + + :return: The branch of this FlowRegistryBranchEntity. + :rtype: FlowRegistryBranchDTO + """ + return self._branch + + @branch.setter + def branch(self, branch): + """ + Sets the branch of this FlowRegistryBranchEntity. + + :param branch: The branch of this FlowRegistryBranchEntity. + :type: FlowRegistryBranchDTO + """ + + self._branch = branch + + 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, FlowRegistryBranchEntity): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """ + Returns true if both objects are not equal + """ + return not self == other diff --git a/nipyapi/nifi/models/flow_registry_branches_entity.py b/nipyapi/nifi/models/flow_registry_branches_entity.py new file mode 100644 index 00000000..ce106bed --- /dev/null +++ b/nipyapi/nifi/models/flow_registry_branches_entity.py @@ -0,0 +1,117 @@ +""" + Apache NiFi REST API + + REST API definition for Apache NiFi web services + + OpenAPI spec version: 2.5.0 + Contact: dev@nifi.apache.org + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from pprint import pformat +import re + + +class FlowRegistryBranchesEntity(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 = { + 'branches': 'list[FlowRegistryBranchEntity]' } + + attribute_map = { + 'branches': 'branches' } + + def __init__(self, branches=None): + """ + FlowRegistryBranchesEntity - a model defined in Swagger + """ + + self._branches = None + + if branches is not None: + self.branches = branches + + @property + def branches(self): + """ + Gets the branches of this FlowRegistryBranchesEntity. + + :return: The branches of this FlowRegistryBranchesEntity. + :rtype: list[FlowRegistryBranchEntity] + """ + return self._branches + + @branches.setter + def branches(self, branches): + """ + Sets the branches of this FlowRegistryBranchesEntity. + + :param branches: The branches of this FlowRegistryBranchesEntity. + :type: list[FlowRegistryBranchEntity] + """ + + self._branches = branches + + 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, FlowRegistryBranchesEntity): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """ + Returns true if both objects are not equal + """ + return not self == other diff --git a/nipyapi/nifi/models/flow_registry_bucket.py b/nipyapi/nifi/models/flow_registry_bucket.py index 3b8666e7..8f3ef0aa 100644 --- a/nipyapi/nifi/models/flow_registry_bucket.py +++ b/nipyapi/nifi/models/flow_registry_bucket.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,126 +27,124 @@ class FlowRegistryBucket(object): and the value is json key in definition. """ swagger_types = { - 'identifier': 'str', - 'name': 'str', - 'description': 'str', 'created_timestamp': 'int', - 'permissions': 'FlowRegistryPermissions' - } +'description': 'str', +'identifier': 'str', +'name': 'str', +'permissions': 'FlowRegistryPermissions' } attribute_map = { - 'identifier': 'identifier', - 'name': 'name', - 'description': 'description', 'created_timestamp': 'createdTimestamp', - 'permissions': 'permissions' - } +'description': 'description', +'identifier': 'identifier', +'name': 'name', +'permissions': 'permissions' } - def __init__(self, identifier=None, name=None, description=None, created_timestamp=None, permissions=None): + def __init__(self, created_timestamp=None, description=None, identifier=None, name=None, permissions=None): """ FlowRegistryBucket - a model defined in Swagger """ + self._created_timestamp = None + self._description = None self._identifier = None self._name = None - self._description = None - self._created_timestamp = None self._permissions = None + if created_timestamp is not None: + self.created_timestamp = created_timestamp + if description is not None: + self.description = description if identifier is not None: self.identifier = identifier if name is not None: self.name = name - if description is not None: - self.description = description - if created_timestamp is not None: - self.created_timestamp = created_timestamp if permissions is not None: self.permissions = permissions @property - def identifier(self): + def created_timestamp(self): """ - Gets the identifier of this FlowRegistryBucket. + Gets the created_timestamp of this FlowRegistryBucket. - :return: The identifier of this FlowRegistryBucket. - :rtype: str + :return: The created_timestamp of this FlowRegistryBucket. + :rtype: int """ - return self._identifier + return self._created_timestamp - @identifier.setter - def identifier(self, identifier): + @created_timestamp.setter + def created_timestamp(self, created_timestamp): """ - Sets the identifier of this FlowRegistryBucket. + Sets the created_timestamp of this FlowRegistryBucket. - :param identifier: The identifier of this FlowRegistryBucket. - :type: str + :param created_timestamp: The created_timestamp of this FlowRegistryBucket. + :type: int """ - self._identifier = identifier + self._created_timestamp = created_timestamp @property - def name(self): + def description(self): """ - Gets the name of this FlowRegistryBucket. + Gets the description of this FlowRegistryBucket. - :return: The name of this FlowRegistryBucket. + :return: The description of this FlowRegistryBucket. :rtype: str """ - return self._name + return self._description - @name.setter - def name(self, name): + @description.setter + def description(self, description): """ - Sets the name of this FlowRegistryBucket. + Sets the description of this FlowRegistryBucket. - :param name: The name of this FlowRegistryBucket. + :param description: The description of this FlowRegistryBucket. :type: str """ - self._name = name + self._description = description @property - def description(self): + def identifier(self): """ - Gets the description of this FlowRegistryBucket. + Gets the identifier of this FlowRegistryBucket. - :return: The description of this FlowRegistryBucket. + :return: The identifier of this FlowRegistryBucket. :rtype: str """ - return self._description + return self._identifier - @description.setter - def description(self, description): + @identifier.setter + def identifier(self, identifier): """ - Sets the description of this FlowRegistryBucket. + Sets the identifier of this FlowRegistryBucket. - :param description: The description of this FlowRegistryBucket. + :param identifier: The identifier of this FlowRegistryBucket. :type: str """ - self._description = description + self._identifier = identifier @property - def created_timestamp(self): + def name(self): """ - Gets the created_timestamp of this FlowRegistryBucket. + Gets the name of this FlowRegistryBucket. - :return: The created_timestamp of this FlowRegistryBucket. - :rtype: int + :return: The name of this FlowRegistryBucket. + :rtype: str """ - return self._created_timestamp + return self._name - @created_timestamp.setter - def created_timestamp(self, created_timestamp): + @name.setter + def name(self, name): """ - Sets the created_timestamp of this FlowRegistryBucket. + Sets the name of this FlowRegistryBucket. - :param created_timestamp: The created_timestamp of this FlowRegistryBucket. - :type: int + :param name: The name of this FlowRegistryBucket. + :type: str """ - self._created_timestamp = created_timestamp + self._name = name @property def permissions(self): diff --git a/nipyapi/nifi/models/flow_registry_bucket_dto.py b/nipyapi/nifi/models/flow_registry_bucket_dto.py index ee81434a..7ff65a24 100644 --- a/nipyapi/nifi/models/flow_registry_bucket_dto.py +++ b/nipyapi/nifi/models/flow_registry_bucket_dto.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,37 +27,81 @@ class FlowRegistryBucketDTO(object): and the value is json key in definition. """ swagger_types = { - 'id': 'str', - 'name': 'str', - 'description': 'str', - 'created': 'int' - } + 'created': 'int', +'description': 'str', +'id': 'str', +'name': 'str' } attribute_map = { - 'id': 'id', - 'name': 'name', - 'description': 'description', - 'created': 'created' - } + 'created': 'created', +'description': 'description', +'id': 'id', +'name': 'name' } - def __init__(self, id=None, name=None, description=None, created=None): + def __init__(self, created=None, description=None, id=None, name=None): """ FlowRegistryBucketDTO - a model defined in Swagger """ + self._created = None + self._description = None self._id = None self._name = None - self._description = None - self._created = None + if created is not None: + self.created = created + if description is not None: + self.description = description if id is not None: self.id = id if name is not None: self.name = name - if description is not None: - self.description = description - if created is not None: - self.created = created + + @property + def created(self): + """ + Gets the created of this FlowRegistryBucketDTO. + The created timestamp of this bucket + + :return: The created of this FlowRegistryBucketDTO. + :rtype: int + """ + return self._created + + @created.setter + def created(self, created): + """ + Sets the created of this FlowRegistryBucketDTO. + The created timestamp of this bucket + + :param created: The created of this FlowRegistryBucketDTO. + :type: int + """ + + self._created = created + + @property + def description(self): + """ + Gets the description of this FlowRegistryBucketDTO. + The bucket description + + :return: The description of this FlowRegistryBucketDTO. + :rtype: str + """ + return self._description + + @description.setter + def description(self, description): + """ + Sets the description of this FlowRegistryBucketDTO. + The bucket description + + :param description: The description of this FlowRegistryBucketDTO. + :type: str + """ + + self._description = description @property def id(self): @@ -106,52 +149,6 @@ def name(self, name): self._name = name - @property - def description(self): - """ - Gets the description of this FlowRegistryBucketDTO. - The bucket description - - :return: The description of this FlowRegistryBucketDTO. - :rtype: str - """ - return self._description - - @description.setter - def description(self, description): - """ - Sets the description of this FlowRegistryBucketDTO. - The bucket description - - :param description: The description of this FlowRegistryBucketDTO. - :type: str - """ - - self._description = description - - @property - def created(self): - """ - Gets the created of this FlowRegistryBucketDTO. - The created timestamp of this bucket - - :return: The created of this FlowRegistryBucketDTO. - :rtype: int - """ - return self._created - - @created.setter - def created(self, created): - """ - Sets the created of this FlowRegistryBucketDTO. - The created timestamp of this bucket - - :param created: The created of this FlowRegistryBucketDTO. - :type: int - """ - - self._created = created - def to_dict(self): """ Returns the model properties as a dict diff --git a/nipyapi/nifi/models/flow_registry_bucket_entity.py b/nipyapi/nifi/models/flow_registry_bucket_entity.py index 0c6d0582..cbff4031 100644 --- a/nipyapi/nifi/models/flow_registry_bucket_entity.py +++ b/nipyapi/nifi/models/flow_registry_bucket_entity.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,54 +27,31 @@ class FlowRegistryBucketEntity(object): and the value is json key in definition. """ swagger_types = { - 'id': 'str', 'bucket': 'FlowRegistryBucketDTO', - 'permissions': 'PermissionsDTO' - } +'id': 'str', +'permissions': 'PermissionsDTO' } attribute_map = { - 'id': 'id', 'bucket': 'bucket', - 'permissions': 'permissions' - } +'id': 'id', +'permissions': 'permissions' } - def __init__(self, id=None, bucket=None, permissions=None): + def __init__(self, bucket=None, id=None, permissions=None): """ FlowRegistryBucketEntity - a model defined in Swagger """ - self._id = None self._bucket = None + self._id = None self._permissions = None - if id is not None: - self.id = id if bucket is not None: self.bucket = bucket + if id is not None: + self.id = id if permissions is not None: self.permissions = permissions - @property - def id(self): - """ - Gets the id of this FlowRegistryBucketEntity. - - :return: The id of this FlowRegistryBucketEntity. - :rtype: str - """ - return self._id - - @id.setter - def id(self, id): - """ - Sets the id of this FlowRegistryBucketEntity. - - :param id: The id of this FlowRegistryBucketEntity. - :type: str - """ - - self._id = id - @property def bucket(self): """ @@ -97,6 +73,27 @@ def bucket(self, bucket): self._bucket = bucket + @property + def id(self): + """ + Gets the id of this FlowRegistryBucketEntity. + + :return: The id of this FlowRegistryBucketEntity. + :rtype: str + """ + return self._id + + @id.setter + def id(self, id): + """ + Sets the id of this FlowRegistryBucketEntity. + + :param id: The id of this FlowRegistryBucketEntity. + :type: str + """ + + self._id = id + @property def permissions(self): """ diff --git a/nipyapi/nifi/models/flow_registry_buckets_entity.py b/nipyapi/nifi/models/flow_registry_buckets_entity.py index d5a6bf0f..714cec5f 100644 --- a/nipyapi/nifi/models/flow_registry_buckets_entity.py +++ b/nipyapi/nifi/models/flow_registry_buckets_entity.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,12 +27,10 @@ class FlowRegistryBucketsEntity(object): and the value is json key in definition. """ swagger_types = { - 'buckets': 'list[FlowRegistryBucketEntity]' - } + 'buckets': 'list[FlowRegistryBucketEntity]' } attribute_map = { - 'buckets': 'buckets' - } + 'buckets': 'buckets' } def __init__(self, buckets=None): """ diff --git a/nipyapi/nifi/models/flow_registry_client_dto.py b/nipyapi/nifi/models/flow_registry_client_dto.py index a7516c26..58eab63a 100644 --- a/nipyapi/nifi/models/flow_registry_client_dto.py +++ b/nipyapi/nifi/models/flow_registry_client_dto.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,148 +27,167 @@ class FlowRegistryClientDTO(object): and the value is json key in definition. """ swagger_types = { - 'id': 'str', - 'name': 'str', - 'description': 'str', - 'uri': 'str', - 'type': 'str', - 'bundle': 'BundleDTO', - 'properties': 'dict(str, str)', - 'descriptors': 'dict(str, PropertyDescriptorDTO)', - 'sensitive_dynamic_property_names': 'list[str]', - 'supports_sensitive_dynamic_properties': 'bool', - 'restricted': 'bool', - 'deprecated': 'bool', - 'validation_errors': 'list[str]', - 'validation_status': 'str', 'annotation_data': 'str', - 'extension_missing': 'bool', - 'multiple_versions_available': 'bool' - } +'bundle': 'BundleDTO', +'deprecated': 'bool', +'description': 'str', +'descriptors': 'dict(str, PropertyDescriptorDTO)', +'extension_missing': 'bool', +'id': 'str', +'multiple_versions_available': 'bool', +'name': 'str', +'properties': 'dict(str, str)', +'restricted': 'bool', +'sensitive_dynamic_property_names': 'list[str]', +'supports_branching': 'bool', +'supports_sensitive_dynamic_properties': 'bool', +'type': 'str', +'validation_errors': 'list[str]', +'validation_status': 'str' } attribute_map = { - 'id': 'id', - 'name': 'name', - 'description': 'description', - 'uri': 'uri', - 'type': 'type', - 'bundle': 'bundle', - 'properties': 'properties', - 'descriptors': 'descriptors', - 'sensitive_dynamic_property_names': 'sensitiveDynamicPropertyNames', - 'supports_sensitive_dynamic_properties': 'supportsSensitiveDynamicProperties', - 'restricted': 'restricted', - 'deprecated': 'deprecated', - 'validation_errors': 'validationErrors', - 'validation_status': 'validationStatus', 'annotation_data': 'annotationData', - 'extension_missing': 'extensionMissing', - 'multiple_versions_available': 'multipleVersionsAvailable' - } - - def __init__(self, id=None, name=None, description=None, uri=None, type=None, bundle=None, properties=None, descriptors=None, sensitive_dynamic_property_names=None, supports_sensitive_dynamic_properties=None, restricted=None, deprecated=None, validation_errors=None, validation_status=None, annotation_data=None, extension_missing=None, multiple_versions_available=None): +'bundle': 'bundle', +'deprecated': 'deprecated', +'description': 'description', +'descriptors': 'descriptors', +'extension_missing': 'extensionMissing', +'id': 'id', +'multiple_versions_available': 'multipleVersionsAvailable', +'name': 'name', +'properties': 'properties', +'restricted': 'restricted', +'sensitive_dynamic_property_names': 'sensitiveDynamicPropertyNames', +'supports_branching': 'supportsBranching', +'supports_sensitive_dynamic_properties': 'supportsSensitiveDynamicProperties', +'type': 'type', +'validation_errors': 'validationErrors', +'validation_status': 'validationStatus' } + + def __init__(self, annotation_data=None, bundle=None, deprecated=None, description=None, descriptors=None, extension_missing=None, id=None, multiple_versions_available=None, name=None, properties=None, restricted=None, sensitive_dynamic_property_names=None, supports_branching=None, supports_sensitive_dynamic_properties=None, type=None, validation_errors=None, validation_status=None): """ FlowRegistryClientDTO - a model defined in Swagger """ + self._annotation_data = None + self._bundle = None + self._deprecated = None + self._description = None + self._descriptors = None + self._extension_missing = None self._id = None + self._multiple_versions_available = None self._name = None - self._description = None - self._uri = None - self._type = None - self._bundle = None self._properties = None - self._descriptors = None + self._restricted = None self._sensitive_dynamic_property_names = None + self._supports_branching = None self._supports_sensitive_dynamic_properties = None - self._restricted = None - self._deprecated = None + self._type = None self._validation_errors = None self._validation_status = None - self._annotation_data = None - self._extension_missing = None - self._multiple_versions_available = None + if annotation_data is not None: + self.annotation_data = annotation_data + if bundle is not None: + self.bundle = bundle + if deprecated is not None: + self.deprecated = deprecated + if description is not None: + self.description = description + if descriptors is not None: + self.descriptors = descriptors + if extension_missing is not None: + self.extension_missing = extension_missing if id is not None: self.id = id + if multiple_versions_available is not None: + self.multiple_versions_available = multiple_versions_available if name is not None: self.name = name - if description is not None: - self.description = description - if uri is not None: - self.uri = uri - if type is not None: - self.type = type - if bundle is not None: - self.bundle = bundle if properties is not None: self.properties = properties - if descriptors is not None: - self.descriptors = descriptors + if restricted is not None: + self.restricted = restricted if sensitive_dynamic_property_names is not None: self.sensitive_dynamic_property_names = sensitive_dynamic_property_names + if supports_branching is not None: + self.supports_branching = supports_branching if supports_sensitive_dynamic_properties is not None: self.supports_sensitive_dynamic_properties = supports_sensitive_dynamic_properties - if restricted is not None: - self.restricted = restricted - if deprecated is not None: - self.deprecated = deprecated + if type is not None: + self.type = type if validation_errors is not None: self.validation_errors = validation_errors if validation_status is not None: self.validation_status = validation_status - if annotation_data is not None: - self.annotation_data = annotation_data - if extension_missing is not None: - self.extension_missing = extension_missing - if multiple_versions_available is not None: - self.multiple_versions_available = multiple_versions_available @property - def id(self): + def annotation_data(self): """ - Gets the id of this FlowRegistryClientDTO. - The registry identifier + Gets the annotation_data of this FlowRegistryClientDTO. + The annotation data for the registry client. This is how the custom UI relays configuration to the registry client. - :return: The id of this FlowRegistryClientDTO. + :return: The annotation_data of this FlowRegistryClientDTO. :rtype: str """ - return self._id + return self._annotation_data - @id.setter - def id(self, id): + @annotation_data.setter + def annotation_data(self, annotation_data): """ - Sets the id of this FlowRegistryClientDTO. - The registry identifier + Sets the annotation_data of this FlowRegistryClientDTO. + The annotation data for the registry client. This is how the custom UI relays configuration to the registry client. - :param id: The id of this FlowRegistryClientDTO. + :param annotation_data: The annotation_data of this FlowRegistryClientDTO. :type: str """ - self._id = id + self._annotation_data = annotation_data @property - def name(self): + def bundle(self): """ - Gets the name of this FlowRegistryClientDTO. - The registry name + Gets the bundle of this FlowRegistryClientDTO. - :return: The name of this FlowRegistryClientDTO. - :rtype: str + :return: The bundle of this FlowRegistryClientDTO. + :rtype: BundleDTO """ - return self._name + return self._bundle - @name.setter - def name(self, name): + @bundle.setter + def bundle(self, bundle): """ - Sets the name of this FlowRegistryClientDTO. - The registry name + Sets the bundle of this FlowRegistryClientDTO. - :param name: The name of this FlowRegistryClientDTO. - :type: str + :param bundle: The bundle of this FlowRegistryClientDTO. + :type: BundleDTO """ - self._name = name + self._bundle = bundle + + @property + def deprecated(self): + """ + Gets the deprecated of this FlowRegistryClientDTO. + Whether the registry client has been deprecated. + + :return: The deprecated of this FlowRegistryClientDTO. + :rtype: bool + """ + return self._deprecated + + @deprecated.setter + def deprecated(self, deprecated): + """ + Sets the deprecated of this FlowRegistryClientDTO. + Whether the registry client has been deprecated. + + :param deprecated: The deprecated of this FlowRegistryClientDTO. + :type: bool + """ + + self._deprecated = deprecated @property def description(self): @@ -195,77 +213,125 @@ def description(self, description): self._description = description @property - def uri(self): + def descriptors(self): """ - Gets the uri of this FlowRegistryClientDTO. + Gets the descriptors of this FlowRegistryClientDTO. + The descriptors for the registry client properties. - :return: The uri of this FlowRegistryClientDTO. - :rtype: str + :return: The descriptors of this FlowRegistryClientDTO. + :rtype: dict(str, PropertyDescriptorDTO) """ - return self._uri + return self._descriptors - @uri.setter - def uri(self, uri): + @descriptors.setter + def descriptors(self, descriptors): """ - Sets the uri of this FlowRegistryClientDTO. + Sets the descriptors of this FlowRegistryClientDTO. + The descriptors for the registry client properties. - :param uri: The uri of this FlowRegistryClientDTO. - :type: str + :param descriptors: The descriptors of this FlowRegistryClientDTO. + :type: dict(str, PropertyDescriptorDTO) """ - self._uri = uri + self._descriptors = descriptors @property - def type(self): + def extension_missing(self): """ - Gets the type of this FlowRegistryClientDTO. - The type of the controller service. + Gets the extension_missing of this FlowRegistryClientDTO. + Whether the underlying extension is missing. - :return: The type of this FlowRegistryClientDTO. + :return: The extension_missing of this FlowRegistryClientDTO. + :rtype: bool + """ + return self._extension_missing + + @extension_missing.setter + def extension_missing(self, extension_missing): + """ + Sets the extension_missing of this FlowRegistryClientDTO. + Whether the underlying extension is missing. + + :param extension_missing: The extension_missing of this FlowRegistryClientDTO. + :type: bool + """ + + self._extension_missing = extension_missing + + @property + def id(self): + """ + Gets the id of this FlowRegistryClientDTO. + The registry identifier + + :return: The id of this FlowRegistryClientDTO. :rtype: str """ - return self._type + return self._id - @type.setter - def type(self, type): + @id.setter + def id(self, id): """ - Sets the type of this FlowRegistryClientDTO. - The type of the controller service. + Sets the id of this FlowRegistryClientDTO. + The registry identifier - :param type: The type of this FlowRegistryClientDTO. + :param id: The id of this FlowRegistryClientDTO. :type: str """ - self._type = type + self._id = id @property - def bundle(self): + def multiple_versions_available(self): """ - Gets the bundle of this FlowRegistryClientDTO. - The details of the artifact that bundled this processor type. + Gets the multiple_versions_available of this FlowRegistryClientDTO. + Whether the flow registry client has multiple versions available. - :return: The bundle of this FlowRegistryClientDTO. - :rtype: BundleDTO + :return: The multiple_versions_available of this FlowRegistryClientDTO. + :rtype: bool """ - return self._bundle + return self._multiple_versions_available - @bundle.setter - def bundle(self, bundle): + @multiple_versions_available.setter + def multiple_versions_available(self, multiple_versions_available): """ - Sets the bundle of this FlowRegistryClientDTO. - The details of the artifact that bundled this processor type. + Sets the multiple_versions_available of this FlowRegistryClientDTO. + Whether the flow registry client has multiple versions available. - :param bundle: The bundle of this FlowRegistryClientDTO. - :type: BundleDTO + :param multiple_versions_available: The multiple_versions_available of this FlowRegistryClientDTO. + :type: bool """ - self._bundle = bundle + self._multiple_versions_available = multiple_versions_available + + @property + def name(self): + """ + Gets the name of this FlowRegistryClientDTO. + The registry name + + :return: The name of this FlowRegistryClientDTO. + :rtype: str + """ + return self._name + + @name.setter + def name(self, name): + """ + Sets the name of this FlowRegistryClientDTO. + The registry name + + :param name: The name of this FlowRegistryClientDTO. + :type: str + """ + + self._name = name @property def properties(self): """ Gets the properties of this FlowRegistryClientDTO. - The properties of the controller service. + The properties of the registry client. :return: The properties of this FlowRegistryClientDTO. :rtype: dict(str, str) @@ -276,7 +342,7 @@ def properties(self): def properties(self, properties): """ Sets the properties of this FlowRegistryClientDTO. - The properties of the controller service. + The properties of the registry client. :param properties: The properties of this FlowRegistryClientDTO. :type: dict(str, str) @@ -285,27 +351,27 @@ def properties(self, properties): self._properties = properties @property - def descriptors(self): + def restricted(self): """ - Gets the descriptors of this FlowRegistryClientDTO. - The descriptors for the controller service properties. + Gets the restricted of this FlowRegistryClientDTO. + Whether the registry client requires elevated privileges. - :return: The descriptors of this FlowRegistryClientDTO. - :rtype: dict(str, PropertyDescriptorDTO) + :return: The restricted of this FlowRegistryClientDTO. + :rtype: bool """ - return self._descriptors + return self._restricted - @descriptors.setter - def descriptors(self, descriptors): + @restricted.setter + def restricted(self, restricted): """ - Sets the descriptors of this FlowRegistryClientDTO. - The descriptors for the controller service properties. + Sets the restricted of this FlowRegistryClientDTO. + Whether the registry client requires elevated privileges. - :param descriptors: The descriptors of this FlowRegistryClientDTO. - :type: dict(str, PropertyDescriptorDTO) + :param restricted: The restricted of this FlowRegistryClientDTO. + :type: bool """ - self._descriptors = descriptors + self._restricted = restricted @property def sensitive_dynamic_property_names(self): @@ -331,79 +397,79 @@ def sensitive_dynamic_property_names(self, sensitive_dynamic_property_names): self._sensitive_dynamic_property_names = sensitive_dynamic_property_names @property - def supports_sensitive_dynamic_properties(self): + def supports_branching(self): """ - Gets the supports_sensitive_dynamic_properties of this FlowRegistryClientDTO. - Whether the reporting task supports sensitive dynamic properties. + Gets the supports_branching of this FlowRegistryClientDTO. + Whether the registry client supports branching. - :return: The supports_sensitive_dynamic_properties of this FlowRegistryClientDTO. + :return: The supports_branching of this FlowRegistryClientDTO. :rtype: bool """ - return self._supports_sensitive_dynamic_properties + return self._supports_branching - @supports_sensitive_dynamic_properties.setter - def supports_sensitive_dynamic_properties(self, supports_sensitive_dynamic_properties): + @supports_branching.setter + def supports_branching(self, supports_branching): """ - Sets the supports_sensitive_dynamic_properties of this FlowRegistryClientDTO. - Whether the reporting task supports sensitive dynamic properties. + Sets the supports_branching of this FlowRegistryClientDTO. + Whether the registry client supports branching. - :param supports_sensitive_dynamic_properties: The supports_sensitive_dynamic_properties of this FlowRegistryClientDTO. + :param supports_branching: The supports_branching of this FlowRegistryClientDTO. :type: bool """ - self._supports_sensitive_dynamic_properties = supports_sensitive_dynamic_properties + self._supports_branching = supports_branching @property - def restricted(self): + def supports_sensitive_dynamic_properties(self): """ - Gets the restricted of this FlowRegistryClientDTO. - Whether the reporting task requires elevated privileges. + Gets the supports_sensitive_dynamic_properties of this FlowRegistryClientDTO. + Whether the registry client supports sensitive dynamic properties. - :return: The restricted of this FlowRegistryClientDTO. + :return: The supports_sensitive_dynamic_properties of this FlowRegistryClientDTO. :rtype: bool """ - return self._restricted + return self._supports_sensitive_dynamic_properties - @restricted.setter - def restricted(self, restricted): + @supports_sensitive_dynamic_properties.setter + def supports_sensitive_dynamic_properties(self, supports_sensitive_dynamic_properties): """ - Sets the restricted of this FlowRegistryClientDTO. - Whether the reporting task requires elevated privileges. + Sets the supports_sensitive_dynamic_properties of this FlowRegistryClientDTO. + Whether the registry client supports sensitive dynamic properties. - :param restricted: The restricted of this FlowRegistryClientDTO. + :param supports_sensitive_dynamic_properties: The supports_sensitive_dynamic_properties of this FlowRegistryClientDTO. :type: bool """ - self._restricted = restricted + self._supports_sensitive_dynamic_properties = supports_sensitive_dynamic_properties @property - def deprecated(self): + def type(self): """ - Gets the deprecated of this FlowRegistryClientDTO. - Whether the reporting task has been deprecated. + Gets the type of this FlowRegistryClientDTO. + The type of the registry client. - :return: The deprecated of this FlowRegistryClientDTO. - :rtype: bool + :return: The type of this FlowRegistryClientDTO. + :rtype: str """ - return self._deprecated + return self._type - @deprecated.setter - def deprecated(self, deprecated): + @type.setter + def type(self, type): """ - Sets the deprecated of this FlowRegistryClientDTO. - Whether the reporting task has been deprecated. + Sets the type of this FlowRegistryClientDTO. + The type of the registry client. - :param deprecated: The deprecated of this FlowRegistryClientDTO. - :type: bool + :param type: The type of this FlowRegistryClientDTO. + :type: str """ - self._deprecated = deprecated + self._type = type @property def validation_errors(self): """ Gets the validation_errors of this FlowRegistryClientDTO. - 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. + 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. :return: The validation_errors of this FlowRegistryClientDTO. :rtype: list[str] @@ -414,7 +480,7 @@ def validation_errors(self): def validation_errors(self, validation_errors): """ Sets the validation_errors of this FlowRegistryClientDTO. - 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. + 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. :param validation_errors: The validation_errors of this FlowRegistryClientDTO. :type: list[str] @@ -426,7 +492,7 @@ def validation_errors(self, validation_errors): def validation_status(self): """ Gets the validation_status of this FlowRegistryClientDTO. - 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) + 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) :return: The validation_status of this FlowRegistryClientDTO. :rtype: str @@ -437,12 +503,12 @@ def validation_status(self): def validation_status(self, validation_status): """ Sets the validation_status of this FlowRegistryClientDTO. - 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) + 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) :param validation_status: The validation_status of this FlowRegistryClientDTO. :type: str """ - allowed_values = ["VALID", "INVALID", "VALIDATING"] + 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}" @@ -451,75 +517,6 @@ def validation_status(self, validation_status): self._validation_status = validation_status - @property - def annotation_data(self): - """ - Gets the annotation_data of this FlowRegistryClientDTO. - The annotation data for the repoting task. This is how the custom UI relays configuration to the reporting task. - - :return: The annotation_data of this FlowRegistryClientDTO. - :rtype: str - """ - return self._annotation_data - - @annotation_data.setter - def annotation_data(self, annotation_data): - """ - Sets the annotation_data of this FlowRegistryClientDTO. - The annotation data for the repoting task. This is how the custom UI relays configuration to the reporting task. - - :param annotation_data: The annotation_data of this FlowRegistryClientDTO. - :type: str - """ - - self._annotation_data = annotation_data - - @property - def extension_missing(self): - """ - Gets the extension_missing of this FlowRegistryClientDTO. - Whether the underlying extension is missing. - - :return: The extension_missing of this FlowRegistryClientDTO. - :rtype: bool - """ - return self._extension_missing - - @extension_missing.setter - def extension_missing(self, extension_missing): - """ - Sets the extension_missing of this FlowRegistryClientDTO. - Whether the underlying extension is missing. - - :param extension_missing: The extension_missing of this FlowRegistryClientDTO. - :type: bool - """ - - self._extension_missing = extension_missing - - @property - def multiple_versions_available(self): - """ - Gets the multiple_versions_available of this FlowRegistryClientDTO. - Whether the flow registry client has multiple versions available. - - :return: The multiple_versions_available of this FlowRegistryClientDTO. - :rtype: bool - """ - return self._multiple_versions_available - - @multiple_versions_available.setter - def multiple_versions_available(self, multiple_versions_available): - """ - Sets the multiple_versions_available of this FlowRegistryClientDTO. - Whether the flow registry client has multiple versions available. - - :param multiple_versions_available: The multiple_versions_available of this FlowRegistryClientDTO. - :type: bool - """ - - self._multiple_versions_available = multiple_versions_available - def to_dict(self): """ Returns the model properties as a dict diff --git a/nipyapi/nifi/models/flow_registry_client_entity.py b/nipyapi/nifi/models/flow_registry_client_entity.py index 8827a3bc..7c88a6ce 100644 --- a/nipyapi/nifi/models/flow_registry_client_entity.py +++ b/nipyapi/nifi/models/flow_registry_client_entity.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,90 +27,127 @@ class FlowRegistryClientEntity(object): and the value is json key in definition. """ swagger_types = { - 'revision': 'RevisionDTO', - 'id': 'str', - 'uri': 'str', - 'position': 'PositionDTO', - 'permissions': 'PermissionsDTO', 'bulletins': 'list[BulletinEntity]', - 'disconnected_node_acknowledged': 'bool', - 'registry': 'FlowRegistryClientDTO', - 'operate_permissions': 'PermissionsDTO', - 'component': 'FlowRegistryClientDTO' - } +'component': 'FlowRegistryClientDTO', +'disconnected_node_acknowledged': 'bool', +'id': 'str', +'operate_permissions': 'PermissionsDTO', +'permissions': 'PermissionsDTO', +'position': 'PositionDTO', +'revision': 'RevisionDTO', +'uri': 'str' } attribute_map = { - 'revision': 'revision', - 'id': 'id', - 'uri': 'uri', - 'position': 'position', - 'permissions': 'permissions', 'bulletins': 'bulletins', - 'disconnected_node_acknowledged': 'disconnectedNodeAcknowledged', - 'registry': 'registry', - 'operate_permissions': 'operatePermissions', - 'component': 'component' - } +'component': 'component', +'disconnected_node_acknowledged': 'disconnectedNodeAcknowledged', +'id': 'id', +'operate_permissions': 'operatePermissions', +'permissions': 'permissions', +'position': 'position', +'revision': 'revision', +'uri': 'uri' } - def __init__(self, revision=None, id=None, uri=None, position=None, permissions=None, bulletins=None, disconnected_node_acknowledged=None, registry=None, operate_permissions=None, component=None): + def __init__(self, bulletins=None, component=None, disconnected_node_acknowledged=None, id=None, operate_permissions=None, permissions=None, position=None, revision=None, uri=None): """ FlowRegistryClientEntity - a model defined in Swagger """ - self._revision = None - self._id = None - self._uri = None - self._position = None - self._permissions = None self._bulletins = None + self._component = None self._disconnected_node_acknowledged = None - self._registry = None + self._id = None self._operate_permissions = None - self._component = None + self._permissions = None + self._position = None + self._revision = None + self._uri = None - if revision is not None: - self.revision = revision - if id is not None: - self.id = id - if uri is not None: - self.uri = uri - if position is not None: - self.position = position - if permissions is not None: - self.permissions = permissions if bulletins is not None: self.bulletins = bulletins + if component is not None: + self.component = component if disconnected_node_acknowledged is not None: self.disconnected_node_acknowledged = disconnected_node_acknowledged - if registry is not None: - self.registry = registry + if id is not None: + self.id = id if operate_permissions is not None: self.operate_permissions = operate_permissions - if component is not None: - self.component = component + if permissions is not None: + self.permissions = permissions + if position is not None: + self.position = position + if revision is not None: + self.revision = revision + if uri is not None: + self.uri = uri @property - def revision(self): + def bulletins(self): """ - Gets the revision of this FlowRegistryClientEntity. - The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses. + Gets the bulletins of this FlowRegistryClientEntity. + The bulletins for this component. - :return: The revision of this FlowRegistryClientEntity. - :rtype: RevisionDTO + :return: The bulletins of this FlowRegistryClientEntity. + :rtype: list[BulletinEntity] """ - return self._revision + return self._bulletins - @revision.setter - def revision(self, revision): + @bulletins.setter + def bulletins(self, bulletins): """ - Sets the revision of this FlowRegistryClientEntity. - The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses. + Sets the bulletins of this FlowRegistryClientEntity. + The bulletins for this component. - :param revision: The revision of this FlowRegistryClientEntity. - :type: RevisionDTO + :param bulletins: The bulletins of this FlowRegistryClientEntity. + :type: list[BulletinEntity] """ - self._revision = revision + self._bulletins = bulletins + + @property + def component(self): + """ + Gets the component of this FlowRegistryClientEntity. + + :return: The component of this FlowRegistryClientEntity. + :rtype: FlowRegistryClientDTO + """ + return self._component + + @component.setter + def component(self, component): + """ + Sets the component of this FlowRegistryClientEntity. + + :param component: The component of this FlowRegistryClientEntity. + :type: FlowRegistryClientDTO + """ + + self._component = component + + @property + def disconnected_node_acknowledged(self): + """ + Gets the disconnected_node_acknowledged of this FlowRegistryClientEntity. + Acknowledges that this node is disconnected to allow for mutable requests to proceed. + + :return: The disconnected_node_acknowledged of this FlowRegistryClientEntity. + :rtype: bool + """ + return self._disconnected_node_acknowledged + + @disconnected_node_acknowledged.setter + def disconnected_node_acknowledged(self, disconnected_node_acknowledged): + """ + Sets the disconnected_node_acknowledged of this FlowRegistryClientEntity. + Acknowledges that this node is disconnected to allow for mutable requests to proceed. + + :param disconnected_node_acknowledged: The disconnected_node_acknowledged of this FlowRegistryClientEntity. + :type: bool + """ + + self._disconnected_node_acknowledged = disconnected_node_acknowledged @property def id(self): @@ -137,56 +173,30 @@ def id(self, id): self._id = id @property - def uri(self): - """ - Gets the uri of this FlowRegistryClientEntity. - The URI for futures requests to the component. - - :return: The uri of this FlowRegistryClientEntity. - :rtype: str - """ - return self._uri - - @uri.setter - def uri(self, uri): - """ - Sets the uri of this FlowRegistryClientEntity. - The URI for futures requests to the component. - - :param uri: The uri of this FlowRegistryClientEntity. - :type: str - """ - - self._uri = uri - - @property - def position(self): + def operate_permissions(self): """ - Gets the position of this FlowRegistryClientEntity. - The position of this component in the UI if applicable. + Gets the operate_permissions of this FlowRegistryClientEntity. - :return: The position of this FlowRegistryClientEntity. - :rtype: PositionDTO + :return: The operate_permissions of this FlowRegistryClientEntity. + :rtype: PermissionsDTO """ - return self._position + return self._operate_permissions - @position.setter - def position(self, position): + @operate_permissions.setter + def operate_permissions(self, operate_permissions): """ - Sets the position of this FlowRegistryClientEntity. - The position of this component in the UI if applicable. + Sets the operate_permissions of this FlowRegistryClientEntity. - :param position: The position of this FlowRegistryClientEntity. - :type: PositionDTO + :param operate_permissions: The operate_permissions of this FlowRegistryClientEntity. + :type: PermissionsDTO """ - self._position = position + self._operate_permissions = operate_permissions @property def permissions(self): """ Gets the permissions of this FlowRegistryClientEntity. - The permissions for this component. :return: The permissions of this FlowRegistryClientEntity. :rtype: PermissionsDTO @@ -197,7 +207,6 @@ def permissions(self): def permissions(self, permissions): """ Sets the permissions of this FlowRegistryClientEntity. - The permissions for this component. :param permissions: The permissions of this FlowRegistryClientEntity. :type: PermissionsDTO @@ -206,113 +215,69 @@ def permissions(self, permissions): self._permissions = permissions @property - def bulletins(self): - """ - Gets the bulletins of this FlowRegistryClientEntity. - The bulletins for this component. - - :return: The bulletins of this FlowRegistryClientEntity. - :rtype: list[BulletinEntity] - """ - return self._bulletins - - @bulletins.setter - def bulletins(self, bulletins): - """ - Sets the bulletins of this FlowRegistryClientEntity. - The bulletins for this component. - - :param bulletins: The bulletins of this FlowRegistryClientEntity. - :type: list[BulletinEntity] - """ - - self._bulletins = bulletins - - @property - def disconnected_node_acknowledged(self): - """ - Gets the disconnected_node_acknowledged of this FlowRegistryClientEntity. - Acknowledges that this node is disconnected to allow for mutable requests to proceed. - - :return: The disconnected_node_acknowledged of this FlowRegistryClientEntity. - :rtype: bool - """ - return self._disconnected_node_acknowledged - - @disconnected_node_acknowledged.setter - def disconnected_node_acknowledged(self, disconnected_node_acknowledged): - """ - Sets the disconnected_node_acknowledged of this FlowRegistryClientEntity. - Acknowledges that this node is disconnected to allow for mutable requests to proceed. - - :param disconnected_node_acknowledged: The disconnected_node_acknowledged of this FlowRegistryClientEntity. - :type: bool - """ - - self._disconnected_node_acknowledged = disconnected_node_acknowledged - - @property - def registry(self): + def position(self): """ - Gets the registry of this FlowRegistryClientEntity. + Gets the position of this FlowRegistryClientEntity. - :return: The registry of this FlowRegistryClientEntity. - :rtype: FlowRegistryClientDTO + :return: The position of this FlowRegistryClientEntity. + :rtype: PositionDTO """ - return self._registry + return self._position - @registry.setter - def registry(self, registry): + @position.setter + def position(self, position): """ - Sets the registry of this FlowRegistryClientEntity. + Sets the position of this FlowRegistryClientEntity. - :param registry: The registry of this FlowRegistryClientEntity. - :type: FlowRegistryClientDTO + :param position: The position of this FlowRegistryClientEntity. + :type: PositionDTO """ - self._registry = registry + self._position = position @property - def operate_permissions(self): + def revision(self): """ - Gets the operate_permissions of this FlowRegistryClientEntity. + Gets the revision of this FlowRegistryClientEntity. - :return: The operate_permissions of this FlowRegistryClientEntity. - :rtype: PermissionsDTO + :return: The revision of this FlowRegistryClientEntity. + :rtype: RevisionDTO """ - return self._operate_permissions + return self._revision - @operate_permissions.setter - def operate_permissions(self, operate_permissions): + @revision.setter + def revision(self, revision): """ - Sets the operate_permissions of this FlowRegistryClientEntity. + Sets the revision of this FlowRegistryClientEntity. - :param operate_permissions: The operate_permissions of this FlowRegistryClientEntity. - :type: PermissionsDTO + :param revision: The revision of this FlowRegistryClientEntity. + :type: RevisionDTO """ - self._operate_permissions = operate_permissions + self._revision = revision @property - def component(self): + def uri(self): """ - Gets the component of this FlowRegistryClientEntity. + Gets the uri of this FlowRegistryClientEntity. + The URI for futures requests to the component. - :return: The component of this FlowRegistryClientEntity. - :rtype: FlowRegistryClientDTO + :return: The uri of this FlowRegistryClientEntity. + :rtype: str """ - return self._component + return self._uri - @component.setter - def component(self, component): + @uri.setter + def uri(self, uri): """ - Sets the component of this FlowRegistryClientEntity. + Sets the uri of this FlowRegistryClientEntity. + The URI for futures requests to the component. - :param component: The component of this FlowRegistryClientEntity. - :type: FlowRegistryClientDTO + :param uri: The uri of this FlowRegistryClientEntity. + :type: str """ - self._component = component + self._uri = uri def to_dict(self): """ diff --git a/nipyapi/nifi/models/flow_registry_client_types_entity.py b/nipyapi/nifi/models/flow_registry_client_types_entity.py index b059fe0c..e9670d89 100644 --- a/nipyapi/nifi/models/flow_registry_client_types_entity.py +++ b/nipyapi/nifi/models/flow_registry_client_types_entity.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,12 +27,10 @@ class FlowRegistryClientTypesEntity(object): and the value is json key in definition. """ swagger_types = { - 'flow_registry_client_types': 'list[DocumentedTypeDTO]' - } + 'flow_registry_client_types': 'list[DocumentedTypeDTO]' } attribute_map = { - 'flow_registry_client_types': 'flowRegistryClientTypes' - } + 'flow_registry_client_types': 'flowRegistryClientTypes' } def __init__(self, flow_registry_client_types=None): """ diff --git a/nipyapi/nifi/models/flow_registry_clients_entity.py b/nipyapi/nifi/models/flow_registry_clients_entity.py index 7087ab3f..582952d0 100644 --- a/nipyapi/nifi/models/flow_registry_clients_entity.py +++ b/nipyapi/nifi/models/flow_registry_clients_entity.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,23 +27,49 @@ class FlowRegistryClientsEntity(object): and the value is json key in definition. """ swagger_types = { - 'registries': 'list[FlowRegistryClientEntity]' - } + 'current_time': 'str', +'registries': 'list[FlowRegistryClientEntity]' } attribute_map = { - 'registries': 'registries' - } + 'current_time': 'currentTime', +'registries': 'registries' } - def __init__(self, registries=None): + def __init__(self, current_time=None, registries=None): """ FlowRegistryClientsEntity - a model defined in Swagger """ + self._current_time = None self._registries = None + if current_time is not None: + self.current_time = current_time if registries is not None: self.registries = registries + @property + def current_time(self): + """ + Gets the current_time of this FlowRegistryClientsEntity. + The current time on the system. + + :return: The current_time of this FlowRegistryClientsEntity. + :rtype: str + """ + return self._current_time + + @current_time.setter + def current_time(self, current_time): + """ + Sets the current_time of this FlowRegistryClientsEntity. + The current time on the system. + + :param current_time: The current_time of this FlowRegistryClientsEntity. + :type: str + """ + + self._current_time = current_time + @property def registries(self): """ diff --git a/nipyapi/nifi/models/flow_registry_permissions.py b/nipyapi/nifi/models/flow_registry_permissions.py index eaf9c33c..1a336b2b 100644 --- a/nipyapi/nifi/models/flow_registry_permissions.py +++ b/nipyapi/nifi/models/flow_registry_permissions.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,32 +27,51 @@ class FlowRegistryPermissions(object): and the value is json key in definition. """ swagger_types = { - 'can_read': 'bool', - 'can_write': 'bool', - 'can_delete': 'bool' - } + 'can_delete': 'bool', +'can_read': 'bool', +'can_write': 'bool' } attribute_map = { - 'can_read': 'canRead', - 'can_write': 'canWrite', - 'can_delete': 'canDelete' - } + 'can_delete': 'canDelete', +'can_read': 'canRead', +'can_write': 'canWrite' } - def __init__(self, can_read=None, can_write=None, can_delete=None): + def __init__(self, can_delete=None, can_read=None, can_write=None): """ FlowRegistryPermissions - a model defined in Swagger """ + self._can_delete = None self._can_read = None self._can_write = None - self._can_delete = None + if can_delete is not None: + self.can_delete = can_delete if can_read is not None: self.can_read = can_read if can_write is not None: self.can_write = can_write - if can_delete is not None: - self.can_delete = can_delete + + @property + def can_delete(self): + """ + Gets the can_delete of this FlowRegistryPermissions. + + :return: The can_delete of this FlowRegistryPermissions. + :rtype: bool + """ + return self._can_delete + + @can_delete.setter + def can_delete(self, can_delete): + """ + Sets the can_delete of this FlowRegistryPermissions. + + :param can_delete: The can_delete of this FlowRegistryPermissions. + :type: bool + """ + + self._can_delete = can_delete @property def can_read(self): @@ -97,27 +115,6 @@ def can_write(self, can_write): self._can_write = can_write - @property - def can_delete(self): - """ - Gets the can_delete of this FlowRegistryPermissions. - - :return: The can_delete of this FlowRegistryPermissions. - :rtype: bool - """ - return self._can_delete - - @can_delete.setter - def can_delete(self, can_delete): - """ - Sets the can_delete of this FlowRegistryPermissions. - - :param can_delete: The can_delete of this FlowRegistryPermissions. - :type: bool - """ - - self._can_delete = can_delete - def to_dict(self): """ Returns the model properties as a dict diff --git a/nipyapi/nifi/models/flow_snippet_dto.py b/nipyapi/nifi/models/flow_snippet_dto.py index 3fc47c43..325f4c0c 100644 --- a/nipyapi/nifi/models/flow_snippet_dto.py +++ b/nipyapi/nifi/models/flow_snippet_dto.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,131 +27,129 @@ class FlowSnippetDTO(object): and the value is json key in definition. """ swagger_types = { - 'process_groups': 'list[ProcessGroupDTO]', - 'remote_process_groups': 'list[RemoteProcessGroupDTO]', - 'processors': 'list[ProcessorDTO]', - 'input_ports': 'list[PortDTO]', - 'output_ports': 'list[PortDTO]', 'connections': 'list[ConnectionDTO]', - 'labels': 'list[LabelDTO]', - 'funnels': 'list[FunnelDTO]', - 'controller_services': 'list[ControllerServiceDTO]' - } +'controller_services': 'list[ControllerServiceDTO]', +'funnels': 'list[FunnelDTO]', +'input_ports': 'list[PortDTO]', +'labels': 'list[LabelDTO]', +'output_ports': 'list[PortDTO]', +'process_groups': 'list[ProcessGroupDTO]', +'processors': 'list[ProcessorDTO]', +'remote_process_groups': 'list[RemoteProcessGroupDTO]' } attribute_map = { - 'process_groups': 'processGroups', - 'remote_process_groups': 'remoteProcessGroups', - 'processors': 'processors', - 'input_ports': 'inputPorts', - 'output_ports': 'outputPorts', 'connections': 'connections', - 'labels': 'labels', - 'funnels': 'funnels', - 'controller_services': 'controllerServices' - } +'controller_services': 'controllerServices', +'funnels': 'funnels', +'input_ports': 'inputPorts', +'labels': 'labels', +'output_ports': 'outputPorts', +'process_groups': 'processGroups', +'processors': 'processors', +'remote_process_groups': 'remoteProcessGroups' } - def __init__(self, process_groups=None, remote_process_groups=None, processors=None, input_ports=None, output_ports=None, connections=None, labels=None, funnels=None, controller_services=None): + def __init__(self, connections=None, controller_services=None, funnels=None, input_ports=None, labels=None, output_ports=None, process_groups=None, processors=None, remote_process_groups=None): """ FlowSnippetDTO - a model defined in Swagger """ - self._process_groups = None - self._remote_process_groups = None - self._processors = None - self._input_ports = None - self._output_ports = None self._connections = None - self._labels = None - self._funnels = None self._controller_services = None + self._funnels = None + self._input_ports = None + self._labels = None + self._output_ports = None + self._process_groups = None + self._processors = None + self._remote_process_groups = None - if process_groups is not None: - self.process_groups = process_groups - if remote_process_groups is not None: - self.remote_process_groups = remote_process_groups - if processors is not None: - self.processors = processors - if input_ports is not None: - self.input_ports = input_ports - if output_ports is not None: - self.output_ports = output_ports if connections is not None: self.connections = connections - if labels is not None: - self.labels = labels - if funnels is not None: - self.funnels = funnels if controller_services is not None: self.controller_services = controller_services + if funnels is not None: + self.funnels = funnels + if input_ports is not None: + self.input_ports = input_ports + if labels is not None: + self.labels = labels + if output_ports is not None: + self.output_ports = output_ports + if process_groups is not None: + self.process_groups = process_groups + if processors is not None: + self.processors = processors + if remote_process_groups is not None: + self.remote_process_groups = remote_process_groups @property - def process_groups(self): + def connections(self): """ - Gets the process_groups of this FlowSnippetDTO. - The process groups in this flow snippet. + Gets the connections of this FlowSnippetDTO. + The connections in this flow snippet. - :return: The process_groups of this FlowSnippetDTO. - :rtype: list[ProcessGroupDTO] + :return: The connections of this FlowSnippetDTO. + :rtype: list[ConnectionDTO] """ - return self._process_groups + return self._connections - @process_groups.setter - def process_groups(self, process_groups): + @connections.setter + def connections(self, connections): """ - Sets the process_groups of this FlowSnippetDTO. - The process groups in this flow snippet. + Sets the connections of this FlowSnippetDTO. + The connections in this flow snippet. - :param process_groups: The process_groups of this FlowSnippetDTO. - :type: list[ProcessGroupDTO] + :param connections: The connections of this FlowSnippetDTO. + :type: list[ConnectionDTO] """ - self._process_groups = process_groups + self._connections = connections @property - def remote_process_groups(self): + def controller_services(self): """ - Gets the remote_process_groups of this FlowSnippetDTO. - The remote process groups in this flow snippet. + Gets the controller_services of this FlowSnippetDTO. + The controller services in this flow snippet. - :return: The remote_process_groups of this FlowSnippetDTO. - :rtype: list[RemoteProcessGroupDTO] + :return: The controller_services of this FlowSnippetDTO. + :rtype: list[ControllerServiceDTO] """ - return self._remote_process_groups + return self._controller_services - @remote_process_groups.setter - def remote_process_groups(self, remote_process_groups): + @controller_services.setter + def controller_services(self, controller_services): """ - Sets the remote_process_groups of this FlowSnippetDTO. - The remote process groups in this flow snippet. + Sets the controller_services of this FlowSnippetDTO. + The controller services in this flow snippet. - :param remote_process_groups: The remote_process_groups of this FlowSnippetDTO. - :type: list[RemoteProcessGroupDTO] + :param controller_services: The controller_services of this FlowSnippetDTO. + :type: list[ControllerServiceDTO] """ - self._remote_process_groups = remote_process_groups + self._controller_services = controller_services @property - def processors(self): + def funnels(self): """ - Gets the processors of this FlowSnippetDTO. - The processors in this flow snippet. + Gets the funnels of this FlowSnippetDTO. + The funnels in this flow snippet. - :return: The processors of this FlowSnippetDTO. - :rtype: list[ProcessorDTO] + :return: The funnels of this FlowSnippetDTO. + :rtype: list[FunnelDTO] """ - return self._processors + return self._funnels - @processors.setter - def processors(self, processors): + @funnels.setter + def funnels(self, funnels): """ - Sets the processors of this FlowSnippetDTO. - The processors in this flow snippet. + Sets the funnels of this FlowSnippetDTO. + The funnels in this flow snippet. - :param processors: The processors of this FlowSnippetDTO. - :type: list[ProcessorDTO] + :param funnels: The funnels of this FlowSnippetDTO. + :type: list[FunnelDTO] """ - self._processors = processors + self._funnels = funnels @property def input_ports(self): @@ -177,6 +174,29 @@ def input_ports(self, input_ports): self._input_ports = input_ports + @property + def labels(self): + """ + Gets the labels of this FlowSnippetDTO. + The labels in this flow snippet. + + :return: The labels of this FlowSnippetDTO. + :rtype: list[LabelDTO] + """ + return self._labels + + @labels.setter + def labels(self, labels): + """ + Sets the labels of this FlowSnippetDTO. + The labels in this flow snippet. + + :param labels: The labels of this FlowSnippetDTO. + :type: list[LabelDTO] + """ + + self._labels = labels + @property def output_ports(self): """ @@ -201,96 +221,73 @@ def output_ports(self, output_ports): self._output_ports = output_ports @property - def connections(self): - """ - Gets the connections of this FlowSnippetDTO. - The connections in this flow snippet. - - :return: The connections of this FlowSnippetDTO. - :rtype: list[ConnectionDTO] - """ - return self._connections - - @connections.setter - def connections(self, connections): - """ - Sets the connections of this FlowSnippetDTO. - The connections in this flow snippet. - - :param connections: The connections of this FlowSnippetDTO. - :type: list[ConnectionDTO] - """ - - self._connections = connections - - @property - def labels(self): + def process_groups(self): """ - Gets the labels of this FlowSnippetDTO. - The labels in this flow snippet. + Gets the process_groups of this FlowSnippetDTO. + The process groups in this flow snippet. - :return: The labels of this FlowSnippetDTO. - :rtype: list[LabelDTO] + :return: The process_groups of this FlowSnippetDTO. + :rtype: list[ProcessGroupDTO] """ - return self._labels + return self._process_groups - @labels.setter - def labels(self, labels): + @process_groups.setter + def process_groups(self, process_groups): """ - Sets the labels of this FlowSnippetDTO. - The labels in this flow snippet. + Sets the process_groups of this FlowSnippetDTO. + The process groups in this flow snippet. - :param labels: The labels of this FlowSnippetDTO. - :type: list[LabelDTO] + :param process_groups: The process_groups of this FlowSnippetDTO. + :type: list[ProcessGroupDTO] """ - self._labels = labels + self._process_groups = process_groups @property - def funnels(self): + def processors(self): """ - Gets the funnels of this FlowSnippetDTO. - The funnels in this flow snippet. + Gets the processors of this FlowSnippetDTO. + The processors in this flow snippet. - :return: The funnels of this FlowSnippetDTO. - :rtype: list[FunnelDTO] + :return: The processors of this FlowSnippetDTO. + :rtype: list[ProcessorDTO] """ - return self._funnels + return self._processors - @funnels.setter - def funnels(self, funnels): + @processors.setter + def processors(self, processors): """ - Sets the funnels of this FlowSnippetDTO. - The funnels in this flow snippet. + Sets the processors of this FlowSnippetDTO. + The processors in this flow snippet. - :param funnels: The funnels of this FlowSnippetDTO. - :type: list[FunnelDTO] + :param processors: The processors of this FlowSnippetDTO. + :type: list[ProcessorDTO] """ - self._funnels = funnels + self._processors = processors @property - def controller_services(self): + def remote_process_groups(self): """ - Gets the controller_services of this FlowSnippetDTO. - The controller services in this flow snippet. + Gets the remote_process_groups of this FlowSnippetDTO. + The remote process groups in this flow snippet. - :return: The controller_services of this FlowSnippetDTO. - :rtype: list[ControllerServiceDTO] + :return: The remote_process_groups of this FlowSnippetDTO. + :rtype: list[RemoteProcessGroupDTO] """ - return self._controller_services + return self._remote_process_groups - @controller_services.setter - def controller_services(self, controller_services): + @remote_process_groups.setter + def remote_process_groups(self, remote_process_groups): """ - Sets the controller_services of this FlowSnippetDTO. - The controller services in this flow snippet. + Sets the remote_process_groups of this FlowSnippetDTO. + The remote process groups in this flow snippet. - :param controller_services: The controller_services of this FlowSnippetDTO. - :type: list[ControllerServiceDTO] + :param remote_process_groups: The remote_process_groups of this FlowSnippetDTO. + :type: list[RemoteProcessGroupDTO] """ - self._controller_services = controller_services + self._remote_process_groups = remote_process_groups def to_dict(self): """ diff --git a/nipyapi/nifi/models/funnel_dto.py b/nipyapi/nifi/models/funnel_dto.py index 2086cf0e..929c4441 100644 --- a/nipyapi/nifi/models/funnel_dto.py +++ b/nipyapi/nifi/models/funnel_dto.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -29,36 +28,34 @@ class FunnelDTO(object): """ swagger_types = { 'id': 'str', - 'versioned_component_id': 'str', - 'parent_group_id': 'str', - 'position': 'PositionDTO' - } +'parent_group_id': 'str', +'position': 'PositionDTO', +'versioned_component_id': 'str' } attribute_map = { 'id': 'id', - 'versioned_component_id': 'versionedComponentId', - 'parent_group_id': 'parentGroupId', - 'position': 'position' - } +'parent_group_id': 'parentGroupId', +'position': 'position', +'versioned_component_id': 'versionedComponentId' } - def __init__(self, id=None, versioned_component_id=None, parent_group_id=None, position=None): + def __init__(self, id=None, parent_group_id=None, position=None, versioned_component_id=None): """ FunnelDTO - a model defined in Swagger """ self._id = None - self._versioned_component_id = None self._parent_group_id = None self._position = None + self._versioned_component_id = None if id is not None: self.id = id - if versioned_component_id is not None: - self.versioned_component_id = versioned_component_id if parent_group_id is not None: self.parent_group_id = parent_group_id if position is not None: self.position = position + if versioned_component_id is not None: + self.versioned_component_id = versioned_component_id @property def id(self): @@ -83,29 +80,6 @@ def id(self, id): self._id = id - @property - def versioned_component_id(self): - """ - Gets the versioned_component_id of this FunnelDTO. - The ID of the corresponding component that is under version control - - :return: The versioned_component_id of this FunnelDTO. - :rtype: str - """ - return self._versioned_component_id - - @versioned_component_id.setter - def versioned_component_id(self, versioned_component_id): - """ - Sets the versioned_component_id of this FunnelDTO. - The ID of the corresponding component that is under version control - - :param versioned_component_id: The versioned_component_id of this FunnelDTO. - :type: str - """ - - self._versioned_component_id = versioned_component_id - @property def parent_group_id(self): """ @@ -133,7 +107,6 @@ def parent_group_id(self, parent_group_id): def position(self): """ Gets the position of this FunnelDTO. - The position of this component in the UI if applicable. :return: The position of this FunnelDTO. :rtype: PositionDTO @@ -144,7 +117,6 @@ def position(self): def position(self, position): """ Sets the position of this FunnelDTO. - The position of this component in the UI if applicable. :param position: The position of this FunnelDTO. :type: PositionDTO @@ -152,6 +124,29 @@ def position(self, position): self._position = position + @property + def versioned_component_id(self): + """ + Gets the versioned_component_id of this FunnelDTO. + The ID of the corresponding component that is under version control + + :return: The versioned_component_id of this FunnelDTO. + :rtype: str + """ + return self._versioned_component_id + + @versioned_component_id.setter + def versioned_component_id(self, versioned_component_id): + """ + Sets the versioned_component_id of this FunnelDTO. + The ID of the corresponding component that is under version control + + :param versioned_component_id: The versioned_component_id of this FunnelDTO. + :type: str + """ + + self._versioned_component_id = versioned_component_id + def to_dict(self): """ Returns the model properties as a dict diff --git a/nipyapi/nifi/models/funnel_entity.py b/nipyapi/nifi/models/funnel_entity.py index ff007040..897d0cf2 100644 --- a/nipyapi/nifi/models/funnel_entity.py +++ b/nipyapi/nifi/models/funnel_entity.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,155 +27,150 @@ class FunnelEntity(object): and the value is json key in definition. """ swagger_types = { - 'revision': 'RevisionDTO', - 'id': 'str', - 'uri': 'str', - 'position': 'PositionDTO', - 'permissions': 'PermissionsDTO', 'bulletins': 'list[BulletinEntity]', - 'disconnected_node_acknowledged': 'bool', - 'component': 'FunnelDTO' - } +'component': 'FunnelDTO', +'disconnected_node_acknowledged': 'bool', +'id': 'str', +'permissions': 'PermissionsDTO', +'position': 'PositionDTO', +'revision': 'RevisionDTO', +'uri': 'str' } attribute_map = { - 'revision': 'revision', - 'id': 'id', - 'uri': 'uri', - 'position': 'position', - 'permissions': 'permissions', 'bulletins': 'bulletins', - 'disconnected_node_acknowledged': 'disconnectedNodeAcknowledged', - 'component': 'component' - } +'component': 'component', +'disconnected_node_acknowledged': 'disconnectedNodeAcknowledged', +'id': 'id', +'permissions': 'permissions', +'position': 'position', +'revision': 'revision', +'uri': 'uri' } - def __init__(self, revision=None, id=None, uri=None, position=None, permissions=None, bulletins=None, disconnected_node_acknowledged=None, component=None): + def __init__(self, bulletins=None, component=None, disconnected_node_acknowledged=None, id=None, permissions=None, position=None, revision=None, uri=None): """ FunnelEntity - a model defined in Swagger """ - self._revision = None - self._id = None - self._uri = None - self._position = None - self._permissions = None self._bulletins = None - self._disconnected_node_acknowledged = None self._component = None + self._disconnected_node_acknowledged = None + self._id = None + self._permissions = None + self._position = None + self._revision = None + self._uri = None - if revision is not None: - self.revision = revision - if id is not None: - self.id = id - if uri is not None: - self.uri = uri - if position is not None: - self.position = position - if permissions is not None: - self.permissions = permissions if bulletins is not None: self.bulletins = bulletins - if disconnected_node_acknowledged is not None: - self.disconnected_node_acknowledged = disconnected_node_acknowledged if component is not None: self.component = component + if disconnected_node_acknowledged is not None: + self.disconnected_node_acknowledged = disconnected_node_acknowledged + if id is not None: + self.id = id + if permissions is not None: + self.permissions = permissions + if position is not None: + self.position = position + if revision is not None: + self.revision = revision + if uri is not None: + self.uri = uri @property - def revision(self): + def bulletins(self): """ - Gets the revision of this FunnelEntity. - The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses. + Gets the bulletins of this FunnelEntity. + The bulletins for this component. - :return: The revision of this FunnelEntity. - :rtype: RevisionDTO + :return: The bulletins of this FunnelEntity. + :rtype: list[BulletinEntity] """ - return self._revision + return self._bulletins - @revision.setter - def revision(self, revision): + @bulletins.setter + def bulletins(self, bulletins): """ - Sets the revision of this FunnelEntity. - The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses. + Sets the bulletins of this FunnelEntity. + The bulletins for this component. - :param revision: The revision of this FunnelEntity. - :type: RevisionDTO + :param bulletins: The bulletins of this FunnelEntity. + :type: list[BulletinEntity] """ - self._revision = revision + self._bulletins = bulletins @property - def id(self): + def component(self): """ - Gets the id of this FunnelEntity. - The id of the component. + Gets the component of this FunnelEntity. - :return: The id of this FunnelEntity. - :rtype: str + :return: The component of this FunnelEntity. + :rtype: FunnelDTO """ - return self._id + return self._component - @id.setter - def id(self, id): + @component.setter + def component(self, component): """ - Sets the id of this FunnelEntity. - The id of the component. + Sets the component of this FunnelEntity. - :param id: The id of this FunnelEntity. - :type: str + :param component: The component of this FunnelEntity. + :type: FunnelDTO """ - self._id = id + self._component = component @property - def uri(self): + def disconnected_node_acknowledged(self): """ - Gets the uri of this FunnelEntity. - The URI for futures requests to the component. + Gets the disconnected_node_acknowledged of this FunnelEntity. + Acknowledges that this node is disconnected to allow for mutable requests to proceed. - :return: The uri of this FunnelEntity. - :rtype: str + :return: The disconnected_node_acknowledged of this FunnelEntity. + :rtype: bool """ - return self._uri + return self._disconnected_node_acknowledged - @uri.setter - def uri(self, uri): + @disconnected_node_acknowledged.setter + def disconnected_node_acknowledged(self, disconnected_node_acknowledged): """ - Sets the uri of this FunnelEntity. - The URI for futures requests to the component. + Sets the disconnected_node_acknowledged of this FunnelEntity. + Acknowledges that this node is disconnected to allow for mutable requests to proceed. - :param uri: The uri of this FunnelEntity. - :type: str + :param disconnected_node_acknowledged: The disconnected_node_acknowledged of this FunnelEntity. + :type: bool """ - self._uri = uri + self._disconnected_node_acknowledged = disconnected_node_acknowledged @property - def position(self): + def id(self): """ - Gets the position of this FunnelEntity. - The position of this component in the UI if applicable. + Gets the id of this FunnelEntity. + The id of the component. - :return: The position of this FunnelEntity. - :rtype: PositionDTO + :return: The id of this FunnelEntity. + :rtype: str """ - return self._position + return self._id - @position.setter - def position(self, position): + @id.setter + def id(self, id): """ - Sets the position of this FunnelEntity. - The position of this component in the UI if applicable. + Sets the id of this FunnelEntity. + The id of the component. - :param position: The position of this FunnelEntity. - :type: PositionDTO + :param id: The id of this FunnelEntity. + :type: str """ - self._position = position + self._id = id @property def permissions(self): """ Gets the permissions of this FunnelEntity. - The permissions for this component. :return: The permissions of this FunnelEntity. :rtype: PermissionsDTO @@ -187,7 +181,6 @@ def permissions(self): def permissions(self, permissions): """ Sets the permissions of this FunnelEntity. - The permissions for this component. :param permissions: The permissions of this FunnelEntity. :type: PermissionsDTO @@ -196,71 +189,69 @@ def permissions(self, permissions): self._permissions = permissions @property - def bulletins(self): + def position(self): """ - Gets the bulletins of this FunnelEntity. - The bulletins for this component. + Gets the position of this FunnelEntity. - :return: The bulletins of this FunnelEntity. - :rtype: list[BulletinEntity] + :return: The position of this FunnelEntity. + :rtype: PositionDTO """ - return self._bulletins + return self._position - @bulletins.setter - def bulletins(self, bulletins): + @position.setter + def position(self, position): """ - Sets the bulletins of this FunnelEntity. - The bulletins for this component. + Sets the position of this FunnelEntity. - :param bulletins: The bulletins of this FunnelEntity. - :type: list[BulletinEntity] + :param position: The position of this FunnelEntity. + :type: PositionDTO """ - self._bulletins = bulletins + self._position = position @property - def disconnected_node_acknowledged(self): + def revision(self): """ - Gets the disconnected_node_acknowledged of this FunnelEntity. - Acknowledges that this node is disconnected to allow for mutable requests to proceed. + Gets the revision of this FunnelEntity. - :return: The disconnected_node_acknowledged of this FunnelEntity. - :rtype: bool + :return: The revision of this FunnelEntity. + :rtype: RevisionDTO """ - return self._disconnected_node_acknowledged + return self._revision - @disconnected_node_acknowledged.setter - def disconnected_node_acknowledged(self, disconnected_node_acknowledged): + @revision.setter + def revision(self, revision): """ - Sets the disconnected_node_acknowledged of this FunnelEntity. - Acknowledges that this node is disconnected to allow for mutable requests to proceed. + Sets the revision of this FunnelEntity. - :param disconnected_node_acknowledged: The disconnected_node_acknowledged of this FunnelEntity. - :type: bool + :param revision: The revision of this FunnelEntity. + :type: RevisionDTO """ - self._disconnected_node_acknowledged = disconnected_node_acknowledged + self._revision = revision @property - def component(self): + def uri(self): """ - Gets the component of this FunnelEntity. + Gets the uri of this FunnelEntity. + The URI for futures requests to the component. - :return: The component of this FunnelEntity. - :rtype: FunnelDTO + :return: The uri of this FunnelEntity. + :rtype: str """ - return self._component + return self._uri - @component.setter - def component(self, component): + @uri.setter + def uri(self, uri): """ - Sets the component of this FunnelEntity. + Sets the uri of this FunnelEntity. + The URI for futures requests to the component. - :param component: The component of this FunnelEntity. - :type: FunnelDTO + :param uri: The uri of this FunnelEntity. + :type: str """ - self._component = component + self._uri = uri def to_dict(self): """ diff --git a/nipyapi/nifi/models/funnels_entity.py b/nipyapi/nifi/models/funnels_entity.py index cb6ea773..0b8b6c92 100644 --- a/nipyapi/nifi/models/funnels_entity.py +++ b/nipyapi/nifi/models/funnels_entity.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,12 +27,10 @@ class FunnelsEntity(object): and the value is json key in definition. """ swagger_types = { - 'funnels': 'list[FunnelEntity]' - } + 'funnels': 'list[FunnelEntity]' } attribute_map = { - 'funnels': 'funnels' - } + 'funnels': 'funnels' } def __init__(self, funnels=None): """ diff --git a/nipyapi/nifi/models/garbage_collection_diagnostics_dto.py b/nipyapi/nifi/models/garbage_collection_diagnostics_dto.py deleted file mode 100644 index 3dbce7c5..00000000 --- a/nipyapi/nifi/models/garbage_collection_diagnostics_dto.py +++ /dev/null @@ -1,150 +0,0 @@ -""" - NiFi Rest API - - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - - OpenAPI spec version: 1.28.1 - Contact: dev@nifi.apache.org - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - - -from pprint import pformat -import re - - -class GarbageCollectionDiagnosticsDTO(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 = { - 'memory_manager_name': 'str', - 'snapshots': 'list[GCDiagnosticsSnapshotDTO]' - } - - attribute_map = { - 'memory_manager_name': 'memoryManagerName', - 'snapshots': 'snapshots' - } - - def __init__(self, memory_manager_name=None, snapshots=None): - """ - GarbageCollectionDiagnosticsDTO - a model defined in Swagger - """ - - self._memory_manager_name = None - self._snapshots = None - - if memory_manager_name is not None: - self.memory_manager_name = memory_manager_name - if snapshots is not None: - self.snapshots = snapshots - - @property - def memory_manager_name(self): - """ - Gets the memory_manager_name of this GarbageCollectionDiagnosticsDTO. - The name of the Memory Manager that this Garbage Collection information pertains to - - :return: The memory_manager_name of this GarbageCollectionDiagnosticsDTO. - :rtype: str - """ - return self._memory_manager_name - - @memory_manager_name.setter - def memory_manager_name(self, memory_manager_name): - """ - Sets the memory_manager_name of this GarbageCollectionDiagnosticsDTO. - The name of the Memory Manager that this Garbage Collection information pertains to - - :param memory_manager_name: The memory_manager_name of this GarbageCollectionDiagnosticsDTO. - :type: str - """ - - self._memory_manager_name = memory_manager_name - - @property - def snapshots(self): - """ - Gets the snapshots of this GarbageCollectionDiagnosticsDTO. - A list of snapshots that have been taken to determine the health of the JVM's heap - - :return: The snapshots of this GarbageCollectionDiagnosticsDTO. - :rtype: list[GCDiagnosticsSnapshotDTO] - """ - return self._snapshots - - @snapshots.setter - def snapshots(self, snapshots): - """ - Sets the snapshots of this GarbageCollectionDiagnosticsDTO. - A list of snapshots that have been taken to determine the health of the JVM's heap - - :param snapshots: The snapshots of this GarbageCollectionDiagnosticsDTO. - :type: list[GCDiagnosticsSnapshotDTO] - """ - - self._snapshots = snapshots - - 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, GarbageCollectionDiagnosticsDTO): - 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/garbage_collection_dto.py b/nipyapi/nifi/models/garbage_collection_dto.py index 570b93ee..ece40ee1 100644 --- a/nipyapi/nifi/models/garbage_collection_dto.py +++ b/nipyapi/nifi/models/garbage_collection_dto.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,60 +27,35 @@ class GarbageCollectionDTO(object): and the value is json key in definition. """ swagger_types = { - 'name': 'str', 'collection_count': 'int', - 'collection_time': 'str', - 'collection_millis': 'int' - } +'collection_millis': 'int', +'collection_time': 'str', +'name': 'str' } attribute_map = { - 'name': 'name', 'collection_count': 'collectionCount', - 'collection_time': 'collectionTime', - 'collection_millis': 'collectionMillis' - } +'collection_millis': 'collectionMillis', +'collection_time': 'collectionTime', +'name': 'name' } - def __init__(self, name=None, collection_count=None, collection_time=None, collection_millis=None): + def __init__(self, collection_count=None, collection_millis=None, collection_time=None, name=None): """ GarbageCollectionDTO - a model defined in Swagger """ - self._name = None self._collection_count = None - self._collection_time = None self._collection_millis = None + self._collection_time = None + self._name = None - if name is not None: - self.name = name if collection_count is not None: self.collection_count = collection_count - if collection_time is not None: - self.collection_time = collection_time if collection_millis is not None: self.collection_millis = collection_millis - - @property - def name(self): - """ - Gets the name of this GarbageCollectionDTO. - The name of the garbage collector. - - :return: The name of this GarbageCollectionDTO. - :rtype: str - """ - return self._name - - @name.setter - def name(self, name): - """ - Sets the name of this GarbageCollectionDTO. - The name of the garbage collector. - - :param name: The name of this GarbageCollectionDTO. - :type: str - """ - - self._name = name + if collection_time is not None: + self.collection_time = collection_time + if name is not None: + self.name = name @property def collection_count(self): @@ -106,6 +80,29 @@ def collection_count(self, collection_count): self._collection_count = collection_count + @property + def collection_millis(self): + """ + Gets the collection_millis of this GarbageCollectionDTO. + The total number of milliseconds spent garbage collecting. + + :return: The collection_millis of this GarbageCollectionDTO. + :rtype: int + """ + return self._collection_millis + + @collection_millis.setter + def collection_millis(self, collection_millis): + """ + Sets the collection_millis of this GarbageCollectionDTO. + The total number of milliseconds spent garbage collecting. + + :param collection_millis: The collection_millis of this GarbageCollectionDTO. + :type: int + """ + + self._collection_millis = collection_millis + @property def collection_time(self): """ @@ -130,27 +127,27 @@ def collection_time(self, collection_time): self._collection_time = collection_time @property - def collection_millis(self): + def name(self): """ - Gets the collection_millis of this GarbageCollectionDTO. - The total number of milliseconds spent garbage collecting. + Gets the name of this GarbageCollectionDTO. + The name of the garbage collector. - :return: The collection_millis of this GarbageCollectionDTO. - :rtype: int + :return: The name of this GarbageCollectionDTO. + :rtype: str """ - return self._collection_millis + return self._name - @collection_millis.setter - def collection_millis(self, collection_millis): + @name.setter + def name(self, name): """ - Sets the collection_millis of this GarbageCollectionDTO. - The total number of milliseconds spent garbage collecting. + Sets the name of this GarbageCollectionDTO. + The name of the garbage collector. - :param collection_millis: The collection_millis of this GarbageCollectionDTO. - :type: int + :param name: The name of this GarbageCollectionDTO. + :type: str """ - self._collection_millis = collection_millis + self._name = name def to_dict(self): """ diff --git a/nipyapi/nifi/models/gc_diagnostics_snapshot_dto.py b/nipyapi/nifi/models/gc_diagnostics_snapshot_dto.py deleted file mode 100644 index 077faece..00000000 --- a/nipyapi/nifi/models/gc_diagnostics_snapshot_dto.py +++ /dev/null @@ -1,178 +0,0 @@ -""" - NiFi Rest API - - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - - OpenAPI spec version: 1.28.1 - Contact: dev@nifi.apache.org - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - - -from pprint import pformat -import re - - -class GCDiagnosticsSnapshotDTO(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 = { - 'timestamp': 'datetime', - 'collection_count': 'int', - 'collection_millis': 'int' - } - - attribute_map = { - 'timestamp': 'timestamp', - 'collection_count': 'collectionCount', - 'collection_millis': 'collectionMillis' - } - - def __init__(self, timestamp=None, collection_count=None, collection_millis=None): - """ - GCDiagnosticsSnapshotDTO - a model defined in Swagger - """ - - self._timestamp = None - self._collection_count = None - self._collection_millis = None - - if timestamp is not None: - self.timestamp = timestamp - if collection_count is not None: - self.collection_count = collection_count - if collection_millis is not None: - self.collection_millis = collection_millis - - @property - def timestamp(self): - """ - Gets the timestamp of this GCDiagnosticsSnapshotDTO. - The timestamp of when the Snapshot was taken - - :return: The timestamp of this GCDiagnosticsSnapshotDTO. - :rtype: datetime - """ - return self._timestamp - - @timestamp.setter - def timestamp(self, timestamp): - """ - Sets the timestamp of this GCDiagnosticsSnapshotDTO. - The timestamp of when the Snapshot was taken - - :param timestamp: The timestamp of this GCDiagnosticsSnapshotDTO. - :type: datetime - """ - - self._timestamp = timestamp - - @property - def collection_count(self): - """ - Gets the collection_count of this GCDiagnosticsSnapshotDTO. - The number of times that Garbage Collection has occurred - - :return: The collection_count of this GCDiagnosticsSnapshotDTO. - :rtype: int - """ - return self._collection_count - - @collection_count.setter - def collection_count(self, collection_count): - """ - Sets the collection_count of this GCDiagnosticsSnapshotDTO. - The number of times that Garbage Collection has occurred - - :param collection_count: The collection_count of this GCDiagnosticsSnapshotDTO. - :type: int - """ - - self._collection_count = collection_count - - @property - def collection_millis(self): - """ - Gets the collection_millis of this GCDiagnosticsSnapshotDTO. - The number of milliseconds that the Garbage Collector spent performing Garbage Collection duties - - :return: The collection_millis of this GCDiagnosticsSnapshotDTO. - :rtype: int - """ - return self._collection_millis - - @collection_millis.setter - def collection_millis(self, collection_millis): - """ - Sets the collection_millis of this GCDiagnosticsSnapshotDTO. - The number of milliseconds that the Garbage Collector spent performing Garbage Collection duties - - :param collection_millis: The collection_millis of this GCDiagnosticsSnapshotDTO. - :type: int - """ - - self._collection_millis = collection_millis - - 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, GCDiagnosticsSnapshotDTO): - 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/history_dto.py b/nipyapi/nifi/models/history_dto.py index e28e0cf9..3e8b1938 100644 --- a/nipyapi/nifi/models/history_dto.py +++ b/nipyapi/nifi/models/history_dto.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,55 +27,53 @@ class HistoryDTO(object): and the value is json key in definition. """ swagger_types = { - 'total': 'int', - 'last_refreshed': 'str', - 'actions': 'list[ActionEntity]' - } + 'actions': 'list[ActionEntity]', +'last_refreshed': 'str', +'total': 'int' } attribute_map = { - 'total': 'total', - 'last_refreshed': 'lastRefreshed', - 'actions': 'actions' - } + 'actions': 'actions', +'last_refreshed': 'lastRefreshed', +'total': 'total' } - def __init__(self, total=None, last_refreshed=None, actions=None): + def __init__(self, actions=None, last_refreshed=None, total=None): """ HistoryDTO - a model defined in Swagger """ - self._total = None - self._last_refreshed = None self._actions = None + self._last_refreshed = None + self._total = None - if total is not None: - self.total = total - if last_refreshed is not None: - self.last_refreshed = last_refreshed if actions is not None: self.actions = actions + if last_refreshed is not None: + self.last_refreshed = last_refreshed + if total is not None: + self.total = total @property - def total(self): + def actions(self): """ - Gets the total of this HistoryDTO. - The number of number of actions that matched the search criteria.. + Gets the actions of this HistoryDTO. + The actions. - :return: The total of this HistoryDTO. - :rtype: int + :return: The actions of this HistoryDTO. + :rtype: list[ActionEntity] """ - return self._total + return self._actions - @total.setter - def total(self, total): + @actions.setter + def actions(self, actions): """ - Sets the total of this HistoryDTO. - The number of number of actions that matched the search criteria.. + Sets the actions of this HistoryDTO. + The actions. - :param total: The total of this HistoryDTO. - :type: int + :param actions: The actions of this HistoryDTO. + :type: list[ActionEntity] """ - self._total = total + self._actions = actions @property def last_refreshed(self): @@ -102,27 +99,27 @@ def last_refreshed(self, last_refreshed): self._last_refreshed = last_refreshed @property - def actions(self): + def total(self): """ - Gets the actions of this HistoryDTO. - The actions. + Gets the total of this HistoryDTO. + The number of number of actions that matched the search criteria.. - :return: The actions of this HistoryDTO. - :rtype: list[ActionEntity] + :return: The total of this HistoryDTO. + :rtype: int """ - return self._actions + return self._total - @actions.setter - def actions(self, actions): + @total.setter + def total(self, total): """ - Sets the actions of this HistoryDTO. - The actions. + Sets the total of this HistoryDTO. + The number of number of actions that matched the search criteria.. - :param actions: The actions of this HistoryDTO. - :type: list[ActionEntity] + :param total: The total of this HistoryDTO. + :type: int """ - self._actions = actions + self._total = total def to_dict(self): """ diff --git a/nipyapi/nifi/models/history_entity.py b/nipyapi/nifi/models/history_entity.py index 1f4e8c41..617b407b 100644 --- a/nipyapi/nifi/models/history_entity.py +++ b/nipyapi/nifi/models/history_entity.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,12 +27,10 @@ class HistoryEntity(object): and the value is json key in definition. """ swagger_types = { - 'history': 'HistoryDTO' - } + 'history': 'HistoryDTO' } attribute_map = { - 'history': 'history' - } + 'history': 'history' } def __init__(self, history=None): """ diff --git a/nipyapi/nifi/models/input_ports_entity.py b/nipyapi/nifi/models/input_ports_entity.py index 0cc0dfd2..64370c1d 100644 --- a/nipyapi/nifi/models/input_ports_entity.py +++ b/nipyapi/nifi/models/input_ports_entity.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,12 +27,10 @@ class InputPortsEntity(object): and the value is json key in definition. """ swagger_types = { - 'input_ports': 'list[PortEntity]' - } + 'input_ports': 'list[PortEntity]' } attribute_map = { - 'input_ports': 'inputPorts' - } + 'input_ports': 'inputPorts' } def __init__(self, input_ports=None): """ diff --git a/nipyapi/nifi/models/instantiate_template_request_entity.py b/nipyapi/nifi/models/instantiate_template_request_entity.py deleted file mode 100644 index 210d593f..00000000 --- a/nipyapi/nifi/models/instantiate_template_request_entity.py +++ /dev/null @@ -1,262 +0,0 @@ -""" - NiFi Rest API - - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - - OpenAPI spec version: 1.28.1 - Contact: dev@nifi.apache.org - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - - -from pprint import pformat -import re - - -class InstantiateTemplateRequestEntity(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 = { - 'origin_x': 'float', - 'origin_y': 'float', - 'template_id': 'str', - 'encoding_version': 'str', - 'snippet': 'FlowSnippetDTO', - 'disconnected_node_acknowledged': 'bool' - } - - attribute_map = { - 'origin_x': 'originX', - 'origin_y': 'originY', - 'template_id': 'templateId', - 'encoding_version': 'encodingVersion', - 'snippet': 'snippet', - 'disconnected_node_acknowledged': 'disconnectedNodeAcknowledged' - } - - def __init__(self, origin_x=None, origin_y=None, template_id=None, encoding_version=None, snippet=None, disconnected_node_acknowledged=None): - """ - InstantiateTemplateRequestEntity - a model defined in Swagger - """ - - self._origin_x = None - self._origin_y = None - self._template_id = None - self._encoding_version = None - self._snippet = None - self._disconnected_node_acknowledged = None - - if origin_x is not None: - self.origin_x = origin_x - if origin_y is not None: - self.origin_y = origin_y - if template_id is not None: - self.template_id = template_id - if encoding_version is not None: - self.encoding_version = encoding_version - if snippet is not None: - self.snippet = snippet - if disconnected_node_acknowledged is not None: - self.disconnected_node_acknowledged = disconnected_node_acknowledged - - @property - def origin_x(self): - """ - Gets the origin_x of this InstantiateTemplateRequestEntity. - The x coordinate of the origin of the bounding box where the new components will be placed. - - :return: The origin_x of this InstantiateTemplateRequestEntity. - :rtype: float - """ - return self._origin_x - - @origin_x.setter - def origin_x(self, origin_x): - """ - Sets the origin_x of this InstantiateTemplateRequestEntity. - The x coordinate of the origin of the bounding box where the new components will be placed. - - :param origin_x: The origin_x of this InstantiateTemplateRequestEntity. - :type: float - """ - - self._origin_x = origin_x - - @property - def origin_y(self): - """ - Gets the origin_y of this InstantiateTemplateRequestEntity. - The y coordinate of the origin of the bounding box where the new components will be placed. - - :return: The origin_y of this InstantiateTemplateRequestEntity. - :rtype: float - """ - return self._origin_y - - @origin_y.setter - def origin_y(self, origin_y): - """ - Sets the origin_y of this InstantiateTemplateRequestEntity. - The y coordinate of the origin of the bounding box where the new components will be placed. - - :param origin_y: The origin_y of this InstantiateTemplateRequestEntity. - :type: float - """ - - self._origin_y = origin_y - - @property - def template_id(self): - """ - Gets the template_id of this InstantiateTemplateRequestEntity. - The identifier of the template. - - :return: The template_id of this InstantiateTemplateRequestEntity. - :rtype: str - """ - return self._template_id - - @template_id.setter - def template_id(self, template_id): - """ - Sets the template_id of this InstantiateTemplateRequestEntity. - The identifier of the template. - - :param template_id: The template_id of this InstantiateTemplateRequestEntity. - :type: str - """ - - self._template_id = template_id - - @property - def encoding_version(self): - """ - Gets the encoding_version of this InstantiateTemplateRequestEntity. - The encoding version of the flow snippet. If not specified, this is automatically populated by the node receiving the user request. If the snippet is specified, the version will be the latest. If the snippet is not specified, the version will come from the underlying template. These details need to be replicated throughout the cluster to ensure consistency. - - :return: The encoding_version of this InstantiateTemplateRequestEntity. - :rtype: str - """ - return self._encoding_version - - @encoding_version.setter - def encoding_version(self, encoding_version): - """ - Sets the encoding_version of this InstantiateTemplateRequestEntity. - The encoding version of the flow snippet. If not specified, this is automatically populated by the node receiving the user request. If the snippet is specified, the version will be the latest. If the snippet is not specified, the version will come from the underlying template. These details need to be replicated throughout the cluster to ensure consistency. - - :param encoding_version: The encoding_version of this InstantiateTemplateRequestEntity. - :type: str - """ - - self._encoding_version = encoding_version - - @property - def snippet(self): - """ - Gets the snippet of this InstantiateTemplateRequestEntity. - A flow snippet of the template contents. If not specified, this is automatically populated by the node receiving the user request. These details need to be replicated throughout the cluster to ensure consistency. - - :return: The snippet of this InstantiateTemplateRequestEntity. - :rtype: FlowSnippetDTO - """ - return self._snippet - - @snippet.setter - def snippet(self, snippet): - """ - Sets the snippet of this InstantiateTemplateRequestEntity. - A flow snippet of the template contents. If not specified, this is automatically populated by the node receiving the user request. These details need to be replicated throughout the cluster to ensure consistency. - - :param snippet: The snippet of this InstantiateTemplateRequestEntity. - :type: FlowSnippetDTO - """ - - self._snippet = snippet - - @property - def disconnected_node_acknowledged(self): - """ - Gets the disconnected_node_acknowledged of this InstantiateTemplateRequestEntity. - Acknowledges that this node is disconnected to allow for mutable requests to proceed. - - :return: The disconnected_node_acknowledged of this InstantiateTemplateRequestEntity. - :rtype: bool - """ - return self._disconnected_node_acknowledged - - @disconnected_node_acknowledged.setter - def disconnected_node_acknowledged(self, disconnected_node_acknowledged): - """ - Sets the disconnected_node_acknowledged of this InstantiateTemplateRequestEntity. - Acknowledges that this node is disconnected to allow for mutable requests to proceed. - - :param disconnected_node_acknowledged: The disconnected_node_acknowledged of this InstantiateTemplateRequestEntity. - :type: bool - """ - - self._disconnected_node_acknowledged = disconnected_node_acknowledged - - 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, InstantiateTemplateRequestEntity): - 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/integer_parameter.py b/nipyapi/nifi/models/integer_parameter.py new file mode 100644 index 00000000..f08e99bd --- /dev/null +++ b/nipyapi/nifi/models/integer_parameter.py @@ -0,0 +1,117 @@ +""" + Apache NiFi REST API + + REST API definition for Apache NiFi web services + + OpenAPI spec version: 2.5.0 + Contact: dev@nifi.apache.org + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from pprint import pformat +import re + + +class IntegerParameter(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 = { + 'integer': 'int' } + + attribute_map = { + 'integer': 'integer' } + + def __init__(self, integer=None): + """ + IntegerParameter - a model defined in Swagger + """ + + self._integer = None + + if integer is not None: + self.integer = integer + + @property + def integer(self): + """ + Gets the integer of this IntegerParameter. + + :return: The integer of this IntegerParameter. + :rtype: int + """ + return self._integer + + @integer.setter + def integer(self, integer): + """ + Sets the integer of this IntegerParameter. + + :param integer: The integer of this IntegerParameter. + :type: int + """ + + self._integer = integer + + 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, IntegerParameter): + 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/jmx_metrics_result_dto.py b/nipyapi/nifi/models/jmx_metrics_result_dto.py index 61aa37a0..1dce0fca 100644 --- a/nipyapi/nifi/models/jmx_metrics_result_dto.py +++ b/nipyapi/nifi/models/jmx_metrics_result_dto.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,55 +27,30 @@ class JmxMetricsResultDTO(object): and the value is json key in definition. """ swagger_types = { - 'bean_name': 'str', 'attribute_name': 'str', - 'attribute_value': 'object' - } +'attribute_value': 'object', +'bean_name': 'str' } attribute_map = { - 'bean_name': 'beanName', 'attribute_name': 'attributeName', - 'attribute_value': 'attributeValue' - } +'attribute_value': 'attributeValue', +'bean_name': 'beanName' } - def __init__(self, bean_name=None, attribute_name=None, attribute_value=None): + def __init__(self, attribute_name=None, attribute_value=None, bean_name=None): """ JmxMetricsResultDTO - a model defined in Swagger """ - self._bean_name = None self._attribute_name = None self._attribute_value = None + self._bean_name = None - if bean_name is not None: - self.bean_name = bean_name if attribute_name is not None: self.attribute_name = attribute_name if attribute_value is not None: self.attribute_value = attribute_value - - @property - def bean_name(self): - """ - Gets the bean_name of this JmxMetricsResultDTO. - The bean name of the metrics bean. - - :return: The bean_name of this JmxMetricsResultDTO. - :rtype: str - """ - return self._bean_name - - @bean_name.setter - def bean_name(self, bean_name): - """ - Sets the bean_name of this JmxMetricsResultDTO. - The bean name of the metrics bean. - - :param bean_name: The bean_name of this JmxMetricsResultDTO. - :type: str - """ - - self._bean_name = bean_name + if bean_name is not None: + self.bean_name = bean_name @property def attribute_name(self): @@ -124,6 +98,29 @@ def attribute_value(self, attribute_value): self._attribute_value = attribute_value + @property + def bean_name(self): + """ + Gets the bean_name of this JmxMetricsResultDTO. + The bean name of the metrics bean. + + :return: The bean_name of this JmxMetricsResultDTO. + :rtype: str + """ + return self._bean_name + + @bean_name.setter + def bean_name(self, bean_name): + """ + Sets the bean_name of this JmxMetricsResultDTO. + The bean name of the metrics bean. + + :param bean_name: The bean_name of this JmxMetricsResultDTO. + :type: str + """ + + self._bean_name = bean_name + def to_dict(self): """ Returns the model properties as a dict diff --git a/nipyapi/nifi/models/jmx_metrics_results_entity.py b/nipyapi/nifi/models/jmx_metrics_results_entity.py index 37161eed..cbc0e482 100644 --- a/nipyapi/nifi/models/jmx_metrics_results_entity.py +++ b/nipyapi/nifi/models/jmx_metrics_results_entity.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,12 +27,10 @@ class JmxMetricsResultsEntity(object): and the value is json key in definition. """ swagger_types = { - 'jmx_metrics_results': 'list[JmxMetricsResultDTO]' - } + 'jmx_metrics_results': 'list[JmxMetricsResultDTO]' } attribute_map = { - 'jmx_metrics_results': 'jmxMetricsResults' - } + 'jmx_metrics_results': 'jmxMetricsResults' } def __init__(self, jmx_metrics_results=None): """ diff --git a/nipyapi/nifi/models/jvm_controller_diagnostics_snapshot_dto.py b/nipyapi/nifi/models/jvm_controller_diagnostics_snapshot_dto.py deleted file mode 100644 index 0aff0266..00000000 --- a/nipyapi/nifi/models/jvm_controller_diagnostics_snapshot_dto.py +++ /dev/null @@ -1,206 +0,0 @@ -""" - NiFi Rest API - - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - - OpenAPI spec version: 1.28.1 - Contact: dev@nifi.apache.org - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - - -from pprint import pformat -import re - - -class JVMControllerDiagnosticsSnapshotDTO(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 = { - 'primary_node': 'bool', - 'cluster_coordinator': 'bool', - 'max_timer_driven_threads': 'int', - 'max_event_driven_threads': 'int' - } - - attribute_map = { - 'primary_node': 'primaryNode', - 'cluster_coordinator': 'clusterCoordinator', - 'max_timer_driven_threads': 'maxTimerDrivenThreads', - 'max_event_driven_threads': 'maxEventDrivenThreads' - } - - def __init__(self, primary_node=None, cluster_coordinator=None, max_timer_driven_threads=None, max_event_driven_threads=None): - """ - JVMControllerDiagnosticsSnapshotDTO - a model defined in Swagger - """ - - self._primary_node = None - self._cluster_coordinator = None - self._max_timer_driven_threads = None - self._max_event_driven_threads = None - - if primary_node is not None: - self.primary_node = primary_node - if cluster_coordinator is not None: - self.cluster_coordinator = cluster_coordinator - if max_timer_driven_threads is not None: - self.max_timer_driven_threads = max_timer_driven_threads - if max_event_driven_threads is not None: - self.max_event_driven_threads = max_event_driven_threads - - @property - def primary_node(self): - """ - Gets the primary_node of this JVMControllerDiagnosticsSnapshotDTO. - Whether or not this node is primary node - - :return: The primary_node of this JVMControllerDiagnosticsSnapshotDTO. - :rtype: bool - """ - return self._primary_node - - @primary_node.setter - def primary_node(self, primary_node): - """ - Sets the primary_node of this JVMControllerDiagnosticsSnapshotDTO. - Whether or not this node is primary node - - :param primary_node: The primary_node of this JVMControllerDiagnosticsSnapshotDTO. - :type: bool - """ - - self._primary_node = primary_node - - @property - def cluster_coordinator(self): - """ - Gets the cluster_coordinator of this JVMControllerDiagnosticsSnapshotDTO. - Whether or not this node is cluster coordinator - - :return: The cluster_coordinator of this JVMControllerDiagnosticsSnapshotDTO. - :rtype: bool - """ - return self._cluster_coordinator - - @cluster_coordinator.setter - def cluster_coordinator(self, cluster_coordinator): - """ - Sets the cluster_coordinator of this JVMControllerDiagnosticsSnapshotDTO. - Whether or not this node is cluster coordinator - - :param cluster_coordinator: The cluster_coordinator of this JVMControllerDiagnosticsSnapshotDTO. - :type: bool - """ - - self._cluster_coordinator = cluster_coordinator - - @property - def max_timer_driven_threads(self): - """ - Gets the max_timer_driven_threads of this JVMControllerDiagnosticsSnapshotDTO. - The maximum number of timer-driven threads - - :return: The max_timer_driven_threads of this JVMControllerDiagnosticsSnapshotDTO. - :rtype: int - """ - return self._max_timer_driven_threads - - @max_timer_driven_threads.setter - def max_timer_driven_threads(self, max_timer_driven_threads): - """ - Sets the max_timer_driven_threads of this JVMControllerDiagnosticsSnapshotDTO. - The maximum number of timer-driven threads - - :param max_timer_driven_threads: The max_timer_driven_threads of this JVMControllerDiagnosticsSnapshotDTO. - :type: int - """ - - self._max_timer_driven_threads = max_timer_driven_threads - - @property - def max_event_driven_threads(self): - """ - Gets the max_event_driven_threads of this JVMControllerDiagnosticsSnapshotDTO. - The maximum number of event-driven threads - - :return: The max_event_driven_threads of this JVMControllerDiagnosticsSnapshotDTO. - :rtype: int - """ - return self._max_event_driven_threads - - @max_event_driven_threads.setter - def max_event_driven_threads(self, max_event_driven_threads): - """ - Sets the max_event_driven_threads of this JVMControllerDiagnosticsSnapshotDTO. - The maximum number of event-driven threads - - :param max_event_driven_threads: The max_event_driven_threads of this JVMControllerDiagnosticsSnapshotDTO. - :type: int - """ - - self._max_event_driven_threads = max_event_driven_threads - - 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, JVMControllerDiagnosticsSnapshotDTO): - 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/jvm_diagnostics_dto.py b/nipyapi/nifi/models/jvm_diagnostics_dto.py deleted file mode 100644 index 450f4594..00000000 --- a/nipyapi/nifi/models/jvm_diagnostics_dto.py +++ /dev/null @@ -1,206 +0,0 @@ -""" - NiFi Rest API - - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - - OpenAPI spec version: 1.28.1 - Contact: dev@nifi.apache.org - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - - -from pprint import pformat -import re - - -class JVMDiagnosticsDTO(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 = { - 'clustered': 'bool', - 'connected': 'bool', - 'aggregate_snapshot': 'JVMDiagnosticsSnapshotDTO', - 'node_snapshots': 'list[NodeJVMDiagnosticsSnapshotDTO]' - } - - attribute_map = { - 'clustered': 'clustered', - 'connected': 'connected', - 'aggregate_snapshot': 'aggregateSnapshot', - 'node_snapshots': 'nodeSnapshots' - } - - def __init__(self, clustered=None, connected=None, aggregate_snapshot=None, node_snapshots=None): - """ - JVMDiagnosticsDTO - a model defined in Swagger - """ - - self._clustered = None - self._connected = None - self._aggregate_snapshot = None - self._node_snapshots = None - - if clustered is not None: - self.clustered = clustered - if connected is not None: - self.connected = connected - if aggregate_snapshot is not None: - self.aggregate_snapshot = aggregate_snapshot - if node_snapshots is not None: - self.node_snapshots = node_snapshots - - @property - def clustered(self): - """ - Gets the clustered of this JVMDiagnosticsDTO. - Whether or not the NiFi instance is clustered - - :return: The clustered of this JVMDiagnosticsDTO. - :rtype: bool - """ - return self._clustered - - @clustered.setter - def clustered(self, clustered): - """ - Sets the clustered of this JVMDiagnosticsDTO. - Whether or not the NiFi instance is clustered - - :param clustered: The clustered of this JVMDiagnosticsDTO. - :type: bool - """ - - self._clustered = clustered - - @property - def connected(self): - """ - Gets the connected of this JVMDiagnosticsDTO. - Whether or not the node is connected to the cluster - - :return: The connected of this JVMDiagnosticsDTO. - :rtype: bool - """ - return self._connected - - @connected.setter - def connected(self, connected): - """ - Sets the connected of this JVMDiagnosticsDTO. - Whether or not the node is connected to the cluster - - :param connected: The connected of this JVMDiagnosticsDTO. - :type: bool - """ - - self._connected = connected - - @property - def aggregate_snapshot(self): - """ - Gets the aggregate_snapshot of this JVMDiagnosticsDTO. - Aggregate JVM diagnostic information about the entire cluster - - :return: The aggregate_snapshot of this JVMDiagnosticsDTO. - :rtype: JVMDiagnosticsSnapshotDTO - """ - return self._aggregate_snapshot - - @aggregate_snapshot.setter - def aggregate_snapshot(self, aggregate_snapshot): - """ - Sets the aggregate_snapshot of this JVMDiagnosticsDTO. - Aggregate JVM diagnostic information about the entire cluster - - :param aggregate_snapshot: The aggregate_snapshot of this JVMDiagnosticsDTO. - :type: JVMDiagnosticsSnapshotDTO - """ - - self._aggregate_snapshot = aggregate_snapshot - - @property - def node_snapshots(self): - """ - Gets the node_snapshots of this JVMDiagnosticsDTO. - Node-wise breakdown of JVM diagnostic information - - :return: The node_snapshots of this JVMDiagnosticsDTO. - :rtype: list[NodeJVMDiagnosticsSnapshotDTO] - """ - return self._node_snapshots - - @node_snapshots.setter - def node_snapshots(self, node_snapshots): - """ - Sets the node_snapshots of this JVMDiagnosticsDTO. - Node-wise breakdown of JVM diagnostic information - - :param node_snapshots: The node_snapshots of this JVMDiagnosticsDTO. - :type: list[NodeJVMDiagnosticsSnapshotDTO] - """ - - self._node_snapshots = node_snapshots - - 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, JVMDiagnosticsDTO): - 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/jvm_diagnostics_snapshot_dto.py b/nipyapi/nifi/models/jvm_diagnostics_snapshot_dto.py deleted file mode 100644 index 89735998..00000000 --- a/nipyapi/nifi/models/jvm_diagnostics_snapshot_dto.py +++ /dev/null @@ -1,178 +0,0 @@ -""" - NiFi Rest API - - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - - OpenAPI spec version: 1.28.1 - Contact: dev@nifi.apache.org - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - - -from pprint import pformat -import re - - -class JVMDiagnosticsSnapshotDTO(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 = { - 'system_diagnostics_dto': 'JVMSystemDiagnosticsSnapshotDTO', - 'flow_diagnostics_dto': 'JVMFlowDiagnosticsSnapshotDTO', - 'controller_diagnostics': 'JVMControllerDiagnosticsSnapshotDTO' - } - - attribute_map = { - 'system_diagnostics_dto': 'systemDiagnosticsDto', - 'flow_diagnostics_dto': 'flowDiagnosticsDto', - 'controller_diagnostics': 'controllerDiagnostics' - } - - def __init__(self, system_diagnostics_dto=None, flow_diagnostics_dto=None, controller_diagnostics=None): - """ - JVMDiagnosticsSnapshotDTO - a model defined in Swagger - """ - - self._system_diagnostics_dto = None - self._flow_diagnostics_dto = None - self._controller_diagnostics = None - - if system_diagnostics_dto is not None: - self.system_diagnostics_dto = system_diagnostics_dto - if flow_diagnostics_dto is not None: - self.flow_diagnostics_dto = flow_diagnostics_dto - if controller_diagnostics is not None: - self.controller_diagnostics = controller_diagnostics - - @property - def system_diagnostics_dto(self): - """ - Gets the system_diagnostics_dto of this JVMDiagnosticsSnapshotDTO. - System-related diagnostics information - - :return: The system_diagnostics_dto of this JVMDiagnosticsSnapshotDTO. - :rtype: JVMSystemDiagnosticsSnapshotDTO - """ - return self._system_diagnostics_dto - - @system_diagnostics_dto.setter - def system_diagnostics_dto(self, system_diagnostics_dto): - """ - Sets the system_diagnostics_dto of this JVMDiagnosticsSnapshotDTO. - System-related diagnostics information - - :param system_diagnostics_dto: The system_diagnostics_dto of this JVMDiagnosticsSnapshotDTO. - :type: JVMSystemDiagnosticsSnapshotDTO - """ - - self._system_diagnostics_dto = system_diagnostics_dto - - @property - def flow_diagnostics_dto(self): - """ - Gets the flow_diagnostics_dto of this JVMDiagnosticsSnapshotDTO. - Flow-related diagnostics information - - :return: The flow_diagnostics_dto of this JVMDiagnosticsSnapshotDTO. - :rtype: JVMFlowDiagnosticsSnapshotDTO - """ - return self._flow_diagnostics_dto - - @flow_diagnostics_dto.setter - def flow_diagnostics_dto(self, flow_diagnostics_dto): - """ - Sets the flow_diagnostics_dto of this JVMDiagnosticsSnapshotDTO. - Flow-related diagnostics information - - :param flow_diagnostics_dto: The flow_diagnostics_dto of this JVMDiagnosticsSnapshotDTO. - :type: JVMFlowDiagnosticsSnapshotDTO - """ - - self._flow_diagnostics_dto = flow_diagnostics_dto - - @property - def controller_diagnostics(self): - """ - Gets the controller_diagnostics of this JVMDiagnosticsSnapshotDTO. - Controller-related diagnostics information - - :return: The controller_diagnostics of this JVMDiagnosticsSnapshotDTO. - :rtype: JVMControllerDiagnosticsSnapshotDTO - """ - return self._controller_diagnostics - - @controller_diagnostics.setter - def controller_diagnostics(self, controller_diagnostics): - """ - Sets the controller_diagnostics of this JVMDiagnosticsSnapshotDTO. - Controller-related diagnostics information - - :param controller_diagnostics: The controller_diagnostics of this JVMDiagnosticsSnapshotDTO. - :type: JVMControllerDiagnosticsSnapshotDTO - """ - - self._controller_diagnostics = controller_diagnostics - - 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, JVMDiagnosticsSnapshotDTO): - 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/jvm_flow_diagnostics_snapshot_dto.py b/nipyapi/nifi/models/jvm_flow_diagnostics_snapshot_dto.py deleted file mode 100644 index 877fd815..00000000 --- a/nipyapi/nifi/models/jvm_flow_diagnostics_snapshot_dto.py +++ /dev/null @@ -1,234 +0,0 @@ -""" - NiFi Rest API - - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - - OpenAPI spec version: 1.28.1 - Contact: dev@nifi.apache.org - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - - -from pprint import pformat -import re - - -class JVMFlowDiagnosticsSnapshotDTO(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 = { - 'uptime': 'str', - 'time_zone': 'str', - 'active_timer_driven_threads': 'int', - 'active_event_driven_threads': 'int', - 'bundles_loaded': 'list[BundleDTO]' - } - - attribute_map = { - 'uptime': 'uptime', - 'time_zone': 'timeZone', - 'active_timer_driven_threads': 'activeTimerDrivenThreads', - 'active_event_driven_threads': 'activeEventDrivenThreads', - 'bundles_loaded': 'bundlesLoaded' - } - - def __init__(self, uptime=None, time_zone=None, active_timer_driven_threads=None, active_event_driven_threads=None, bundles_loaded=None): - """ - JVMFlowDiagnosticsSnapshotDTO - a model defined in Swagger - """ - - self._uptime = None - self._time_zone = None - self._active_timer_driven_threads = None - self._active_event_driven_threads = None - self._bundles_loaded = None - - if uptime is not None: - self.uptime = uptime - if time_zone is not None: - self.time_zone = time_zone - if active_timer_driven_threads is not None: - self.active_timer_driven_threads = active_timer_driven_threads - if active_event_driven_threads is not None: - self.active_event_driven_threads = active_event_driven_threads - if bundles_loaded is not None: - self.bundles_loaded = bundles_loaded - - @property - def uptime(self): - """ - Gets the uptime of this JVMFlowDiagnosticsSnapshotDTO. - How long this node has been running, formatted as hours:minutes:seconds.milliseconds - - :return: The uptime of this JVMFlowDiagnosticsSnapshotDTO. - :rtype: str - """ - return self._uptime - - @uptime.setter - def uptime(self, uptime): - """ - Sets the uptime of this JVMFlowDiagnosticsSnapshotDTO. - How long this node has been running, formatted as hours:minutes:seconds.milliseconds - - :param uptime: The uptime of this JVMFlowDiagnosticsSnapshotDTO. - :type: str - """ - - self._uptime = uptime - - @property - def time_zone(self): - """ - Gets the time_zone of this JVMFlowDiagnosticsSnapshotDTO. - The name of the Time Zone that is configured, if available - - :return: The time_zone of this JVMFlowDiagnosticsSnapshotDTO. - :rtype: str - """ - return self._time_zone - - @time_zone.setter - def time_zone(self, time_zone): - """ - Sets the time_zone of this JVMFlowDiagnosticsSnapshotDTO. - The name of the Time Zone that is configured, if available - - :param time_zone: The time_zone of this JVMFlowDiagnosticsSnapshotDTO. - :type: str - """ - - self._time_zone = time_zone - - @property - def active_timer_driven_threads(self): - """ - Gets the active_timer_driven_threads of this JVMFlowDiagnosticsSnapshotDTO. - The number of timer-driven threads that are active - - :return: The active_timer_driven_threads of this JVMFlowDiagnosticsSnapshotDTO. - :rtype: int - """ - return self._active_timer_driven_threads - - @active_timer_driven_threads.setter - def active_timer_driven_threads(self, active_timer_driven_threads): - """ - Sets the active_timer_driven_threads of this JVMFlowDiagnosticsSnapshotDTO. - The number of timer-driven threads that are active - - :param active_timer_driven_threads: The active_timer_driven_threads of this JVMFlowDiagnosticsSnapshotDTO. - :type: int - """ - - self._active_timer_driven_threads = active_timer_driven_threads - - @property - def active_event_driven_threads(self): - """ - Gets the active_event_driven_threads of this JVMFlowDiagnosticsSnapshotDTO. - The number of event-driven threads that are active - - :return: The active_event_driven_threads of this JVMFlowDiagnosticsSnapshotDTO. - :rtype: int - """ - return self._active_event_driven_threads - - @active_event_driven_threads.setter - def active_event_driven_threads(self, active_event_driven_threads): - """ - Sets the active_event_driven_threads of this JVMFlowDiagnosticsSnapshotDTO. - The number of event-driven threads that are active - - :param active_event_driven_threads: The active_event_driven_threads of this JVMFlowDiagnosticsSnapshotDTO. - :type: int - """ - - self._active_event_driven_threads = active_event_driven_threads - - @property - def bundles_loaded(self): - """ - Gets the bundles_loaded of this JVMFlowDiagnosticsSnapshotDTO. - The NiFi Bundles (NARs) that are loaded by NiFi - - :return: The bundles_loaded of this JVMFlowDiagnosticsSnapshotDTO. - :rtype: list[BundleDTO] - """ - return self._bundles_loaded - - @bundles_loaded.setter - def bundles_loaded(self, bundles_loaded): - """ - Sets the bundles_loaded of this JVMFlowDiagnosticsSnapshotDTO. - The NiFi Bundles (NARs) that are loaded by NiFi - - :param bundles_loaded: The bundles_loaded of this JVMFlowDiagnosticsSnapshotDTO. - :type: list[BundleDTO] - """ - - self._bundles_loaded = bundles_loaded - - 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, JVMFlowDiagnosticsSnapshotDTO): - 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/jvm_system_diagnostics_snapshot_dto.py b/nipyapi/nifi/models/jvm_system_diagnostics_snapshot_dto.py deleted file mode 100644 index bed021a6..00000000 --- a/nipyapi/nifi/models/jvm_system_diagnostics_snapshot_dto.py +++ /dev/null @@ -1,430 +0,0 @@ -""" - NiFi Rest API - - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - - OpenAPI spec version: 1.28.1 - Contact: dev@nifi.apache.org - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - - -from pprint import pformat -import re - - -class JVMSystemDiagnosticsSnapshotDTO(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 = { - 'flow_file_repository_storage_usage': 'RepositoryUsageDTO', - 'content_repository_storage_usage': 'list[RepositoryUsageDTO]', - 'provenance_repository_storage_usage': 'list[RepositoryUsageDTO]', - 'max_heap_bytes': 'int', - 'max_heap': 'str', - 'garbage_collection_diagnostics': 'list[GarbageCollectionDiagnosticsDTO]', - 'cpu_cores': 'int', - 'cpu_load_average': 'float', - 'physical_memory_bytes': 'int', - 'physical_memory': 'str', - 'open_file_descriptors': 'int', - 'max_open_file_descriptors': 'int' - } - - attribute_map = { - 'flow_file_repository_storage_usage': 'flowFileRepositoryStorageUsage', - 'content_repository_storage_usage': 'contentRepositoryStorageUsage', - 'provenance_repository_storage_usage': 'provenanceRepositoryStorageUsage', - 'max_heap_bytes': 'maxHeapBytes', - 'max_heap': 'maxHeap', - 'garbage_collection_diagnostics': 'garbageCollectionDiagnostics', - 'cpu_cores': 'cpuCores', - 'cpu_load_average': 'cpuLoadAverage', - 'physical_memory_bytes': 'physicalMemoryBytes', - 'physical_memory': 'physicalMemory', - 'open_file_descriptors': 'openFileDescriptors', - 'max_open_file_descriptors': 'maxOpenFileDescriptors' - } - - def __init__(self, flow_file_repository_storage_usage=None, content_repository_storage_usage=None, provenance_repository_storage_usage=None, max_heap_bytes=None, max_heap=None, garbage_collection_diagnostics=None, cpu_cores=None, cpu_load_average=None, physical_memory_bytes=None, physical_memory=None, open_file_descriptors=None, max_open_file_descriptors=None): - """ - JVMSystemDiagnosticsSnapshotDTO - a model defined in Swagger - """ - - self._flow_file_repository_storage_usage = None - self._content_repository_storage_usage = None - self._provenance_repository_storage_usage = None - self._max_heap_bytes = None - self._max_heap = None - self._garbage_collection_diagnostics = None - self._cpu_cores = None - self._cpu_load_average = None - self._physical_memory_bytes = None - self._physical_memory = None - self._open_file_descriptors = None - self._max_open_file_descriptors = None - - if flow_file_repository_storage_usage is not None: - self.flow_file_repository_storage_usage = flow_file_repository_storage_usage - if content_repository_storage_usage is not None: - self.content_repository_storage_usage = content_repository_storage_usage - if provenance_repository_storage_usage is not None: - self.provenance_repository_storage_usage = provenance_repository_storage_usage - if max_heap_bytes is not None: - self.max_heap_bytes = max_heap_bytes - if max_heap is not None: - self.max_heap = max_heap - if garbage_collection_diagnostics is not None: - self.garbage_collection_diagnostics = garbage_collection_diagnostics - if cpu_cores is not None: - self.cpu_cores = cpu_cores - if cpu_load_average is not None: - self.cpu_load_average = cpu_load_average - if physical_memory_bytes is not None: - self.physical_memory_bytes = physical_memory_bytes - if physical_memory is not None: - self.physical_memory = physical_memory - if open_file_descriptors is not None: - self.open_file_descriptors = open_file_descriptors - if max_open_file_descriptors is not None: - self.max_open_file_descriptors = max_open_file_descriptors - - @property - def flow_file_repository_storage_usage(self): - """ - Gets the flow_file_repository_storage_usage of this JVMSystemDiagnosticsSnapshotDTO. - Information about the FlowFile Repository's usage - - :return: The flow_file_repository_storage_usage of this JVMSystemDiagnosticsSnapshotDTO. - :rtype: RepositoryUsageDTO - """ - return self._flow_file_repository_storage_usage - - @flow_file_repository_storage_usage.setter - def flow_file_repository_storage_usage(self, flow_file_repository_storage_usage): - """ - Sets the flow_file_repository_storage_usage of this JVMSystemDiagnosticsSnapshotDTO. - Information about the FlowFile Repository's usage - - :param flow_file_repository_storage_usage: The flow_file_repository_storage_usage of this JVMSystemDiagnosticsSnapshotDTO. - :type: RepositoryUsageDTO - """ - - self._flow_file_repository_storage_usage = flow_file_repository_storage_usage - - @property - def content_repository_storage_usage(self): - """ - Gets the content_repository_storage_usage of this JVMSystemDiagnosticsSnapshotDTO. - Information about the Content Repository's usage - - :return: The content_repository_storage_usage of this JVMSystemDiagnosticsSnapshotDTO. - :rtype: list[RepositoryUsageDTO] - """ - return self._content_repository_storage_usage - - @content_repository_storage_usage.setter - def content_repository_storage_usage(self, content_repository_storage_usage): - """ - Sets the content_repository_storage_usage of this JVMSystemDiagnosticsSnapshotDTO. - Information about the Content Repository's usage - - :param content_repository_storage_usage: The content_repository_storage_usage of this JVMSystemDiagnosticsSnapshotDTO. - :type: list[RepositoryUsageDTO] - """ - - self._content_repository_storage_usage = content_repository_storage_usage - - @property - def provenance_repository_storage_usage(self): - """ - Gets the provenance_repository_storage_usage of this JVMSystemDiagnosticsSnapshotDTO. - Information about the Provenance Repository's usage - - :return: The provenance_repository_storage_usage of this JVMSystemDiagnosticsSnapshotDTO. - :rtype: list[RepositoryUsageDTO] - """ - return self._provenance_repository_storage_usage - - @provenance_repository_storage_usage.setter - def provenance_repository_storage_usage(self, provenance_repository_storage_usage): - """ - Sets the provenance_repository_storage_usage of this JVMSystemDiagnosticsSnapshotDTO. - Information about the Provenance Repository's usage - - :param provenance_repository_storage_usage: The provenance_repository_storage_usage of this JVMSystemDiagnosticsSnapshotDTO. - :type: list[RepositoryUsageDTO] - """ - - self._provenance_repository_storage_usage = provenance_repository_storage_usage - - @property - def max_heap_bytes(self): - """ - Gets the max_heap_bytes of this JVMSystemDiagnosticsSnapshotDTO. - The maximum number of bytes that the JVM heap is configured to use for heap - - :return: The max_heap_bytes of this JVMSystemDiagnosticsSnapshotDTO. - :rtype: int - """ - return self._max_heap_bytes - - @max_heap_bytes.setter - def max_heap_bytes(self, max_heap_bytes): - """ - Sets the max_heap_bytes of this JVMSystemDiagnosticsSnapshotDTO. - The maximum number of bytes that the JVM heap is configured to use for heap - - :param max_heap_bytes: The max_heap_bytes of this JVMSystemDiagnosticsSnapshotDTO. - :type: int - """ - - self._max_heap_bytes = max_heap_bytes - - @property - def max_heap(self): - """ - Gets the max_heap of this JVMSystemDiagnosticsSnapshotDTO. - The maximum number of bytes that the JVM heap is configured to use, as a human-readable value - - :return: The max_heap of this JVMSystemDiagnosticsSnapshotDTO. - :rtype: str - """ - return self._max_heap - - @max_heap.setter - def max_heap(self, max_heap): - """ - Sets the max_heap of this JVMSystemDiagnosticsSnapshotDTO. - The maximum number of bytes that the JVM heap is configured to use, as a human-readable value - - :param max_heap: The max_heap of this JVMSystemDiagnosticsSnapshotDTO. - :type: str - """ - - self._max_heap = max_heap - - @property - def garbage_collection_diagnostics(self): - """ - Gets the garbage_collection_diagnostics of this JVMSystemDiagnosticsSnapshotDTO. - Diagnostic information about the JVM's garbage collections - - :return: The garbage_collection_diagnostics of this JVMSystemDiagnosticsSnapshotDTO. - :rtype: list[GarbageCollectionDiagnosticsDTO] - """ - return self._garbage_collection_diagnostics - - @garbage_collection_diagnostics.setter - def garbage_collection_diagnostics(self, garbage_collection_diagnostics): - """ - Sets the garbage_collection_diagnostics of this JVMSystemDiagnosticsSnapshotDTO. - Diagnostic information about the JVM's garbage collections - - :param garbage_collection_diagnostics: The garbage_collection_diagnostics of this JVMSystemDiagnosticsSnapshotDTO. - :type: list[GarbageCollectionDiagnosticsDTO] - """ - - self._garbage_collection_diagnostics = garbage_collection_diagnostics - - @property - def cpu_cores(self): - """ - Gets the cpu_cores of this JVMSystemDiagnosticsSnapshotDTO. - The number of CPU Cores available on the system - - :return: The cpu_cores of this JVMSystemDiagnosticsSnapshotDTO. - :rtype: int - """ - return self._cpu_cores - - @cpu_cores.setter - def cpu_cores(self, cpu_cores): - """ - Sets the cpu_cores of this JVMSystemDiagnosticsSnapshotDTO. - The number of CPU Cores available on the system - - :param cpu_cores: The cpu_cores of this JVMSystemDiagnosticsSnapshotDTO. - :type: int - """ - - self._cpu_cores = cpu_cores - - @property - def cpu_load_average(self): - """ - Gets the cpu_load_average of this JVMSystemDiagnosticsSnapshotDTO. - The 1-minute CPU Load Average - - :return: The cpu_load_average of this JVMSystemDiagnosticsSnapshotDTO. - :rtype: float - """ - return self._cpu_load_average - - @cpu_load_average.setter - def cpu_load_average(self, cpu_load_average): - """ - Sets the cpu_load_average of this JVMSystemDiagnosticsSnapshotDTO. - The 1-minute CPU Load Average - - :param cpu_load_average: The cpu_load_average of this JVMSystemDiagnosticsSnapshotDTO. - :type: float - """ - - self._cpu_load_average = cpu_load_average - - @property - def physical_memory_bytes(self): - """ - Gets the physical_memory_bytes of this JVMSystemDiagnosticsSnapshotDTO. - The number of bytes of RAM available on the system - - :return: The physical_memory_bytes of this JVMSystemDiagnosticsSnapshotDTO. - :rtype: int - """ - return self._physical_memory_bytes - - @physical_memory_bytes.setter - def physical_memory_bytes(self, physical_memory_bytes): - """ - Sets the physical_memory_bytes of this JVMSystemDiagnosticsSnapshotDTO. - The number of bytes of RAM available on the system - - :param physical_memory_bytes: The physical_memory_bytes of this JVMSystemDiagnosticsSnapshotDTO. - :type: int - """ - - self._physical_memory_bytes = physical_memory_bytes - - @property - def physical_memory(self): - """ - Gets the physical_memory of this JVMSystemDiagnosticsSnapshotDTO. - The number of bytes of RAM available on the system as a human-readable value - - :return: The physical_memory of this JVMSystemDiagnosticsSnapshotDTO. - :rtype: str - """ - return self._physical_memory - - @physical_memory.setter - def physical_memory(self, physical_memory): - """ - Sets the physical_memory of this JVMSystemDiagnosticsSnapshotDTO. - The number of bytes of RAM available on the system as a human-readable value - - :param physical_memory: The physical_memory of this JVMSystemDiagnosticsSnapshotDTO. - :type: str - """ - - self._physical_memory = physical_memory - - @property - def open_file_descriptors(self): - """ - Gets the open_file_descriptors of this JVMSystemDiagnosticsSnapshotDTO. - The number of files that are open by the NiFi process - - :return: The open_file_descriptors of this JVMSystemDiagnosticsSnapshotDTO. - :rtype: int - """ - return self._open_file_descriptors - - @open_file_descriptors.setter - def open_file_descriptors(self, open_file_descriptors): - """ - Sets the open_file_descriptors of this JVMSystemDiagnosticsSnapshotDTO. - The number of files that are open by the NiFi process - - :param open_file_descriptors: The open_file_descriptors of this JVMSystemDiagnosticsSnapshotDTO. - :type: int - """ - - self._open_file_descriptors = open_file_descriptors - - @property - def max_open_file_descriptors(self): - """ - Gets the max_open_file_descriptors of this JVMSystemDiagnosticsSnapshotDTO. - The maximum number of open file descriptors that are available to each process - - :return: The max_open_file_descriptors of this JVMSystemDiagnosticsSnapshotDTO. - :rtype: int - """ - return self._max_open_file_descriptors - - @max_open_file_descriptors.setter - def max_open_file_descriptors(self, max_open_file_descriptors): - """ - Sets the max_open_file_descriptors of this JVMSystemDiagnosticsSnapshotDTO. - The maximum number of open file descriptors that are available to each process - - :param max_open_file_descriptors: The max_open_file_descriptors of this JVMSystemDiagnosticsSnapshotDTO. - :type: int - """ - - self._max_open_file_descriptors = max_open_file_descriptors - - 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, JVMSystemDiagnosticsSnapshotDTO): - 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/label_dto.py b/nipyapi/nifi/models/label_dto.py index 40dd1c59..86eb2907 100644 --- a/nipyapi/nifi/models/label_dto.py +++ b/nipyapi/nifi/models/label_dto.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,62 +27,106 @@ class LabelDTO(object): and the value is json key in definition. """ swagger_types = { - 'id': 'str', - 'versioned_component_id': 'str', - 'parent_group_id': 'str', - 'position': 'PositionDTO', - 'label': 'str', - 'width': 'float', - 'height': 'float', 'getz_index': 'int', - 'style': 'dict(str, str)' - } +'height': 'float', +'id': 'str', +'label': 'str', +'parent_group_id': 'str', +'position': 'PositionDTO', +'style': 'dict(str, str)', +'versioned_component_id': 'str', +'width': 'float' } attribute_map = { - 'id': 'id', - 'versioned_component_id': 'versionedComponentId', - 'parent_group_id': 'parentGroupId', - 'position': 'position', - 'label': 'label', - 'width': 'width', - 'height': 'height', 'getz_index': 'getzIndex', - 'style': 'style' - } +'height': 'height', +'id': 'id', +'label': 'label', +'parent_group_id': 'parentGroupId', +'position': 'position', +'style': 'style', +'versioned_component_id': 'versionedComponentId', +'width': 'width' } - def __init__(self, id=None, versioned_component_id=None, parent_group_id=None, position=None, label=None, width=None, height=None, getz_index=None, style=None): + def __init__(self, getz_index=None, height=None, id=None, label=None, parent_group_id=None, position=None, style=None, versioned_component_id=None, width=None): """ LabelDTO - a model defined in Swagger """ + self._getz_index = None + self._height = None self._id = None - self._versioned_component_id = None + self._label = None self._parent_group_id = None self._position = None - self._label = None - self._width = None - self._height = None - self._getz_index = None self._style = None + self._versioned_component_id = None + self._width = None + if getz_index is not None: + self.getz_index = getz_index + if height is not None: + self.height = height if id is not None: self.id = id - if versioned_component_id is not None: - self.versioned_component_id = versioned_component_id + if label is not None: + self.label = label if parent_group_id is not None: self.parent_group_id = parent_group_id if position is not None: self.position = position - if label is not None: - self.label = label - if width is not None: - self.width = width - if height is not None: - self.height = height - if getz_index is not None: - self.getz_index = getz_index if style is not None: self.style = style + if versioned_component_id is not None: + self.versioned_component_id = versioned_component_id + if width is not None: + self.width = width + + @property + def getz_index(self): + """ + Gets the getz_index of this LabelDTO. + The z index of the label. + + :return: The getz_index of this LabelDTO. + :rtype: int + """ + return self._getz_index + + @getz_index.setter + def getz_index(self, getz_index): + """ + Sets the getz_index of this LabelDTO. + The z index of the label. + + :param getz_index: The getz_index of this LabelDTO. + :type: int + """ + + self._getz_index = getz_index + + @property + def height(self): + """ + Gets the height of this LabelDTO. + The height of the label in pixels when at a 1:1 scale. + + :return: The height of this LabelDTO. + :rtype: float + """ + return self._height + + @height.setter + def height(self, height): + """ + Sets the height of this LabelDTO. + The height of the label in pixels when at a 1:1 scale. + + :param height: The height of this LabelDTO. + :type: float + """ + + self._height = height @property def id(self): @@ -109,27 +152,27 @@ def id(self, id): self._id = id @property - def versioned_component_id(self): + def label(self): """ - Gets the versioned_component_id of this LabelDTO. - The ID of the corresponding component that is under version control + Gets the label of this LabelDTO. + The text that appears in the label. - :return: The versioned_component_id of this LabelDTO. + :return: The label of this LabelDTO. :rtype: str """ - return self._versioned_component_id + return self._label - @versioned_component_id.setter - def versioned_component_id(self, versioned_component_id): + @label.setter + def label(self, label): """ - Sets the versioned_component_id of this LabelDTO. - The ID of the corresponding component that is under version control + Sets the label of this LabelDTO. + The text that appears in the label. - :param versioned_component_id: The versioned_component_id of this LabelDTO. + :param label: The label of this LabelDTO. :type: str """ - self._versioned_component_id = versioned_component_id + self._label = label @property def parent_group_id(self): @@ -158,7 +201,6 @@ def parent_group_id(self, parent_group_id): def position(self): """ Gets the position of this LabelDTO. - The position of this component in the UI if applicable. :return: The position of this LabelDTO. :rtype: PositionDTO @@ -169,7 +211,6 @@ def position(self): def position(self, position): """ Sets the position of this LabelDTO. - The position of this component in the UI if applicable. :param position: The position of this LabelDTO. :type: PositionDTO @@ -178,27 +219,50 @@ def position(self, position): self._position = position @property - def label(self): + def style(self): """ - Gets the label of this LabelDTO. - The text that appears in the label. + Gets the style of this LabelDTO. + The styles for this label (font-size : 12px, background-color : #eee, etc). - :return: The label of this LabelDTO. + :return: The style of this LabelDTO. + :rtype: dict(str, str) + """ + return self._style + + @style.setter + def style(self, style): + """ + Sets the style of this LabelDTO. + The styles for this label (font-size : 12px, background-color : #eee, etc). + + :param style: The style of this LabelDTO. + :type: dict(str, str) + """ + + self._style = style + + @property + def versioned_component_id(self): + """ + Gets the versioned_component_id of this LabelDTO. + The ID of the corresponding component that is under version control + + :return: The versioned_component_id of this LabelDTO. :rtype: str """ - return self._label + return self._versioned_component_id - @label.setter - def label(self, label): + @versioned_component_id.setter + def versioned_component_id(self, versioned_component_id): """ - Sets the label of this LabelDTO. - The text that appears in the label. + Sets the versioned_component_id of this LabelDTO. + The ID of the corresponding component that is under version control - :param label: The label of this LabelDTO. + :param versioned_component_id: The versioned_component_id of this LabelDTO. :type: str """ - self._label = label + self._versioned_component_id = versioned_component_id @property def width(self): @@ -223,75 +287,6 @@ def width(self, width): self._width = width - @property - def height(self): - """ - Gets the height of this LabelDTO. - The height of the label in pixels when at a 1:1 scale. - - :return: The height of this LabelDTO. - :rtype: float - """ - return self._height - - @height.setter - def height(self, height): - """ - Sets the height of this LabelDTO. - The height of the label in pixels when at a 1:1 scale. - - :param height: The height of this LabelDTO. - :type: float - """ - - self._height = height - - @property - def getz_index(self): - """ - Gets the getz_index of this LabelDTO. - The z index of the label. - - :return: The getz_index of this LabelDTO. - :rtype: int - """ - return self._getz_index - - @getz_index.setter - def getz_index(self, getz_index): - """ - Sets the getz_index of this LabelDTO. - The z index of the label. - - :param getz_index: The getz_index of this LabelDTO. - :type: int - """ - - self._getz_index = getz_index - - @property - def style(self): - """ - Gets the style of this LabelDTO. - The styles for this label (font-size : 12px, background-color : #eee, etc). - - :return: The style of this LabelDTO. - :rtype: dict(str, str) - """ - return self._style - - @style.setter - def style(self, style): - """ - Sets the style of this LabelDTO. - The styles for this label (font-size : 12px, background-color : #eee, etc). - - :param style: The style of this LabelDTO. - :type: dict(str, str) - """ - - self._style = style - def to_dict(self): """ Returns the model properties as a dict diff --git a/nipyapi/nifi/models/label_entity.py b/nipyapi/nifi/models/label_entity.py index b48c87d3..b11ad5b3 100644 --- a/nipyapi/nifi/models/label_entity.py +++ b/nipyapi/nifi/models/label_entity.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,293 +27,285 @@ class LabelEntity(object): and the value is json key in definition. """ swagger_types = { - 'revision': 'RevisionDTO', - 'id': 'str', - 'uri': 'str', - 'position': 'PositionDTO', - 'permissions': 'PermissionsDTO', 'bulletins': 'list[BulletinEntity]', - 'disconnected_node_acknowledged': 'bool', - 'dimensions': 'DimensionsDTO', - 'getz_index': 'int', - 'component': 'LabelDTO' - } +'component': 'LabelDTO', +'dimensions': 'DimensionsDTO', +'disconnected_node_acknowledged': 'bool', +'getz_index': 'int', +'id': 'str', +'permissions': 'PermissionsDTO', +'position': 'PositionDTO', +'revision': 'RevisionDTO', +'uri': 'str' } attribute_map = { - 'revision': 'revision', - 'id': 'id', - 'uri': 'uri', - 'position': 'position', - 'permissions': 'permissions', 'bulletins': 'bulletins', - 'disconnected_node_acknowledged': 'disconnectedNodeAcknowledged', - 'dimensions': 'dimensions', - 'getz_index': 'getzIndex', - 'component': 'component' - } - - def __init__(self, revision=None, id=None, uri=None, position=None, permissions=None, bulletins=None, disconnected_node_acknowledged=None, dimensions=None, getz_index=None, component=None): +'component': 'component', +'dimensions': 'dimensions', +'disconnected_node_acknowledged': 'disconnectedNodeAcknowledged', +'getz_index': 'getzIndex', +'id': 'id', +'permissions': 'permissions', +'position': 'position', +'revision': 'revision', +'uri': 'uri' } + + def __init__(self, bulletins=None, component=None, dimensions=None, disconnected_node_acknowledged=None, getz_index=None, id=None, permissions=None, position=None, revision=None, uri=None): """ LabelEntity - a model defined in Swagger """ - self._revision = None - self._id = None - self._uri = None - self._position = None - self._permissions = None self._bulletins = None - self._disconnected_node_acknowledged = None + self._component = None self._dimensions = None + self._disconnected_node_acknowledged = None self._getz_index = None - self._component = None + self._id = None + self._permissions = None + self._position = None + self._revision = None + self._uri = None - if revision is not None: - self.revision = revision - if id is not None: - self.id = id - if uri is not None: - self.uri = uri - if position is not None: - self.position = position - if permissions is not None: - self.permissions = permissions if bulletins is not None: self.bulletins = bulletins - if disconnected_node_acknowledged is not None: - self.disconnected_node_acknowledged = disconnected_node_acknowledged + if component is not None: + self.component = component if dimensions is not None: self.dimensions = dimensions + if disconnected_node_acknowledged is not None: + self.disconnected_node_acknowledged = disconnected_node_acknowledged if getz_index is not None: self.getz_index = getz_index - if component is not None: - self.component = component + if id is not None: + self.id = id + if permissions is not None: + self.permissions = permissions + if position is not None: + self.position = position + if revision is not None: + self.revision = revision + if uri is not None: + self.uri = uri @property - def revision(self): + def bulletins(self): """ - Gets the revision of this LabelEntity. - The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses. + Gets the bulletins of this LabelEntity. + The bulletins for this component. - :return: The revision of this LabelEntity. - :rtype: RevisionDTO + :return: The bulletins of this LabelEntity. + :rtype: list[BulletinEntity] """ - return self._revision + return self._bulletins - @revision.setter - def revision(self, revision): + @bulletins.setter + def bulletins(self, bulletins): """ - Sets the revision of this LabelEntity. - The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses. + Sets the bulletins of this LabelEntity. + The bulletins for this component. - :param revision: The revision of this LabelEntity. - :type: RevisionDTO + :param bulletins: The bulletins of this LabelEntity. + :type: list[BulletinEntity] """ - self._revision = revision + self._bulletins = bulletins @property - def id(self): + def component(self): """ - Gets the id of this LabelEntity. - The id of the component. + Gets the component of this LabelEntity. - :return: The id of this LabelEntity. - :rtype: str + :return: The component of this LabelEntity. + :rtype: LabelDTO """ - return self._id + return self._component - @id.setter - def id(self, id): + @component.setter + def component(self, component): """ - Sets the id of this LabelEntity. - The id of the component. + Sets the component of this LabelEntity. - :param id: The id of this LabelEntity. - :type: str + :param component: The component of this LabelEntity. + :type: LabelDTO """ - self._id = id + self._component = component @property - def uri(self): + def dimensions(self): """ - Gets the uri of this LabelEntity. - The URI for futures requests to the component. + Gets the dimensions of this LabelEntity. - :return: The uri of this LabelEntity. - :rtype: str + :return: The dimensions of this LabelEntity. + :rtype: DimensionsDTO """ - return self._uri + return self._dimensions - @uri.setter - def uri(self, uri): + @dimensions.setter + def dimensions(self, dimensions): """ - Sets the uri of this LabelEntity. - The URI for futures requests to the component. + Sets the dimensions of this LabelEntity. - :param uri: The uri of this LabelEntity. - :type: str + :param dimensions: The dimensions of this LabelEntity. + :type: DimensionsDTO """ - self._uri = uri + self._dimensions = dimensions @property - def position(self): + def disconnected_node_acknowledged(self): """ - Gets the position of this LabelEntity. - The position of this component in the UI if applicable. + Gets the disconnected_node_acknowledged of this LabelEntity. + Acknowledges that this node is disconnected to allow for mutable requests to proceed. - :return: The position of this LabelEntity. - :rtype: PositionDTO + :return: The disconnected_node_acknowledged of this LabelEntity. + :rtype: bool """ - return self._position + return self._disconnected_node_acknowledged - @position.setter - def position(self, position): + @disconnected_node_acknowledged.setter + def disconnected_node_acknowledged(self, disconnected_node_acknowledged): """ - Sets the position of this LabelEntity. - The position of this component in the UI if applicable. + Sets the disconnected_node_acknowledged of this LabelEntity. + Acknowledges that this node is disconnected to allow for mutable requests to proceed. - :param position: The position of this LabelEntity. - :type: PositionDTO + :param disconnected_node_acknowledged: The disconnected_node_acknowledged of this LabelEntity. + :type: bool """ - self._position = position + self._disconnected_node_acknowledged = disconnected_node_acknowledged @property - def permissions(self): + def getz_index(self): """ - Gets the permissions of this LabelEntity. - The permissions for this component. + Gets the getz_index of this LabelEntity. + The z index of the label. - :return: The permissions of this LabelEntity. - :rtype: PermissionsDTO + :return: The getz_index of this LabelEntity. + :rtype: int """ - return self._permissions + return self._getz_index - @permissions.setter - def permissions(self, permissions): + @getz_index.setter + def getz_index(self, getz_index): """ - Sets the permissions of this LabelEntity. - The permissions for this component. + Sets the getz_index of this LabelEntity. + The z index of the label. - :param permissions: The permissions of this LabelEntity. - :type: PermissionsDTO + :param getz_index: The getz_index of this LabelEntity. + :type: int """ - self._permissions = permissions + self._getz_index = getz_index @property - def bulletins(self): + def id(self): """ - Gets the bulletins of this LabelEntity. - The bulletins for this component. + Gets the id of this LabelEntity. + The id of the component. - :return: The bulletins of this LabelEntity. - :rtype: list[BulletinEntity] + :return: The id of this LabelEntity. + :rtype: str """ - return self._bulletins + return self._id - @bulletins.setter - def bulletins(self, bulletins): + @id.setter + def id(self, id): """ - Sets the bulletins of this LabelEntity. - The bulletins for this component. + Sets the id of this LabelEntity. + The id of the component. - :param bulletins: The bulletins of this LabelEntity. - :type: list[BulletinEntity] + :param id: The id of this LabelEntity. + :type: str """ - self._bulletins = bulletins + self._id = id @property - def disconnected_node_acknowledged(self): + def permissions(self): """ - Gets the disconnected_node_acknowledged of this LabelEntity. - Acknowledges that this node is disconnected to allow for mutable requests to proceed. + Gets the permissions of this LabelEntity. - :return: The disconnected_node_acknowledged of this LabelEntity. - :rtype: bool + :return: The permissions of this LabelEntity. + :rtype: PermissionsDTO """ - return self._disconnected_node_acknowledged + return self._permissions - @disconnected_node_acknowledged.setter - def disconnected_node_acknowledged(self, disconnected_node_acknowledged): + @permissions.setter + def permissions(self, permissions): """ - Sets the disconnected_node_acknowledged of this LabelEntity. - Acknowledges that this node is disconnected to allow for mutable requests to proceed. + Sets the permissions of this LabelEntity. - :param disconnected_node_acknowledged: The disconnected_node_acknowledged of this LabelEntity. - :type: bool + :param permissions: The permissions of this LabelEntity. + :type: PermissionsDTO """ - self._disconnected_node_acknowledged = disconnected_node_acknowledged + self._permissions = permissions @property - def dimensions(self): + def position(self): """ - Gets the dimensions of this LabelEntity. + Gets the position of this LabelEntity. - :return: The dimensions of this LabelEntity. - :rtype: DimensionsDTO + :return: The position of this LabelEntity. + :rtype: PositionDTO """ - return self._dimensions + return self._position - @dimensions.setter - def dimensions(self, dimensions): + @position.setter + def position(self, position): """ - Sets the dimensions of this LabelEntity. + Sets the position of this LabelEntity. - :param dimensions: The dimensions of this LabelEntity. - :type: DimensionsDTO + :param position: The position of this LabelEntity. + :type: PositionDTO """ - self._dimensions = dimensions + self._position = position @property - def getz_index(self): + def revision(self): """ - Gets the getz_index of this LabelEntity. - The z index of the label. + Gets the revision of this LabelEntity. - :return: The getz_index of this LabelEntity. - :rtype: int + :return: The revision of this LabelEntity. + :rtype: RevisionDTO """ - return self._getz_index + return self._revision - @getz_index.setter - def getz_index(self, getz_index): + @revision.setter + def revision(self, revision): """ - Sets the getz_index of this LabelEntity. - The z index of the label. + Sets the revision of this LabelEntity. - :param getz_index: The getz_index of this LabelEntity. - :type: int + :param revision: The revision of this LabelEntity. + :type: RevisionDTO """ - self._getz_index = getz_index + self._revision = revision @property - def component(self): + def uri(self): """ - Gets the component of this LabelEntity. + Gets the uri of this LabelEntity. + The URI for futures requests to the component. - :return: The component of this LabelEntity. - :rtype: LabelDTO + :return: The uri of this LabelEntity. + :rtype: str """ - return self._component + return self._uri - @component.setter - def component(self, component): + @uri.setter + def uri(self, uri): """ - Sets the component of this LabelEntity. + Sets the uri of this LabelEntity. + The URI for futures requests to the component. - :param component: The component of this LabelEntity. - :type: LabelDTO + :param uri: The uri of this LabelEntity. + :type: str """ - self._component = component + self._uri = uri def to_dict(self): """ diff --git a/nipyapi/nifi/models/labels_entity.py b/nipyapi/nifi/models/labels_entity.py index c466bf08..9a2ec511 100644 --- a/nipyapi/nifi/models/labels_entity.py +++ b/nipyapi/nifi/models/labels_entity.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,12 +27,10 @@ class LabelsEntity(object): and the value is json key in definition. """ swagger_types = { - 'labels': 'list[LabelEntity]' - } + 'labels': 'list[LabelEntity]' } attribute_map = { - 'labels': 'labels' - } + 'labels': 'labels' } def __init__(self, labels=None): """ diff --git a/nipyapi/nifi/models/templates_entity.py b/nipyapi/nifi/models/latest_provenance_events_dto.py similarity index 52% rename from nipyapi/nifi/models/templates_entity.py rename to nipyapi/nifi/models/latest_provenance_events_dto.py index 6c65f5fe..391cb396 100644 --- a/nipyapi/nifi/models/templates_entity.py +++ b/nipyapi/nifi/models/latest_provenance_events_dto.py @@ -1,19 +1,18 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re -class TemplatesEntity(object): +class LatestProvenanceEventsDTO(object): """ NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually. @@ -28,71 +27,67 @@ class TemplatesEntity(object): and the value is json key in definition. """ swagger_types = { - 'templates': 'list[TemplateEntity]', - 'generated': 'str' - } + 'component_id': 'str', +'provenance_events': 'list[ProvenanceEventDTO]' } attribute_map = { - 'templates': 'templates', - 'generated': 'generated' - } + 'component_id': 'componentId', +'provenance_events': 'provenanceEvents' } - def __init__(self, templates=None, generated=None): + def __init__(self, component_id=None, provenance_events=None): """ - TemplatesEntity - a model defined in Swagger + LatestProvenanceEventsDTO - a model defined in Swagger """ - self._templates = None - self._generated = None + self._component_id = None + self._provenance_events = None - if templates is not None: - self.templates = templates - if generated is not None: - self.generated = generated + if component_id is not None: + self.component_id = component_id + if provenance_events is not None: + self.provenance_events = provenance_events @property - def templates(self): + def component_id(self): """ - Gets the templates of this TemplatesEntity. + Gets the component_id of this LatestProvenanceEventsDTO. - :return: The templates of this TemplatesEntity. - :rtype: list[TemplateEntity] + :return: The component_id of this LatestProvenanceEventsDTO. + :rtype: str """ - return self._templates + return self._component_id - @templates.setter - def templates(self, templates): + @component_id.setter + def component_id(self, component_id): """ - Sets the templates of this TemplatesEntity. + Sets the component_id of this LatestProvenanceEventsDTO. - :param templates: The templates of this TemplatesEntity. - :type: list[TemplateEntity] + :param component_id: The component_id of this LatestProvenanceEventsDTO. + :type: str """ - self._templates = templates + self._component_id = component_id @property - def generated(self): + def provenance_events(self): """ - Gets the generated of this TemplatesEntity. - When this content was generated. + Gets the provenance_events of this LatestProvenanceEventsDTO. - :return: The generated of this TemplatesEntity. - :rtype: str + :return: The provenance_events of this LatestProvenanceEventsDTO. + :rtype: list[ProvenanceEventDTO] """ - return self._generated + return self._provenance_events - @generated.setter - def generated(self, generated): + @provenance_events.setter + def provenance_events(self, provenance_events): """ - Sets the generated of this TemplatesEntity. - When this content was generated. + Sets the provenance_events of this LatestProvenanceEventsDTO. - :param generated: The generated of this TemplatesEntity. - :type: str + :param provenance_events: The provenance_events of this LatestProvenanceEventsDTO. + :type: list[ProvenanceEventDTO] """ - self._generated = generated + self._provenance_events = provenance_events def to_dict(self): """ @@ -136,7 +131,7 @@ def __eq__(self, other): """ Returns true if both objects are equal """ - if not isinstance(other, TemplatesEntity): + if not isinstance(other, LatestProvenanceEventsDTO): return False return self.__dict__ == other.__dict__ diff --git a/nipyapi/nifi/models/access_status_entity.py b/nipyapi/nifi/models/latest_provenance_events_entity.py similarity index 59% rename from nipyapi/nifi/models/access_status_entity.py rename to nipyapi/nifi/models/latest_provenance_events_entity.py index d2a7cec2..40fe3de6 100644 --- a/nipyapi/nifi/models/access_status_entity.py +++ b/nipyapi/nifi/models/latest_provenance_events_entity.py @@ -1,19 +1,18 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re -class AccessStatusEntity(object): +class LatestProvenanceEventsEntity(object): """ NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually. @@ -28,43 +27,41 @@ class AccessStatusEntity(object): and the value is json key in definition. """ swagger_types = { - 'access_status': 'AccessStatusDTO' - } + 'latest_provenance_events': 'LatestProvenanceEventsDTO' } attribute_map = { - 'access_status': 'accessStatus' - } + 'latest_provenance_events': 'latestProvenanceEvents' } - def __init__(self, access_status=None): + def __init__(self, latest_provenance_events=None): """ - AccessStatusEntity - a model defined in Swagger + LatestProvenanceEventsEntity - a model defined in Swagger """ - self._access_status = None + self._latest_provenance_events = None - if access_status is not None: - self.access_status = access_status + if latest_provenance_events is not None: + self.latest_provenance_events = latest_provenance_events @property - def access_status(self): + def latest_provenance_events(self): """ - Gets the access_status of this AccessStatusEntity. + Gets the latest_provenance_events of this LatestProvenanceEventsEntity. - :return: The access_status of this AccessStatusEntity. - :rtype: AccessStatusDTO + :return: The latest_provenance_events of this LatestProvenanceEventsEntity. + :rtype: LatestProvenanceEventsDTO """ - return self._access_status + return self._latest_provenance_events - @access_status.setter - def access_status(self, access_status): + @latest_provenance_events.setter + def latest_provenance_events(self, latest_provenance_events): """ - Sets the access_status of this AccessStatusEntity. + Sets the latest_provenance_events of this LatestProvenanceEventsEntity. - :param access_status: The access_status of this AccessStatusEntity. - :type: AccessStatusDTO + :param latest_provenance_events: The latest_provenance_events of this LatestProvenanceEventsEntity. + :type: LatestProvenanceEventsDTO """ - self._access_status = access_status + self._latest_provenance_events = latest_provenance_events def to_dict(self): """ @@ -108,7 +105,7 @@ def __eq__(self, other): """ Returns true if both objects are equal """ - if not isinstance(other, AccessStatusEntity): + if not isinstance(other, LatestProvenanceEventsEntity): return False return self.__dict__ == other.__dict__ diff --git a/nipyapi/nifi/models/lineage_dto.py b/nipyapi/nifi/models/lineage_dto.py index 44b75242..0f1abc7f 100644 --- a/nipyapi/nifi/models/lineage_dto.py +++ b/nipyapi/nifi/models/lineage_dto.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,149 +27,124 @@ class LineageDTO(object): and the value is json key in definition. """ swagger_types = { - 'id': 'str', - 'uri': 'str', - 'submission_time': 'str', 'expiration': 'str', - 'percent_completed': 'int', - 'finished': 'bool', - 'request': 'LineageRequestDTO', - 'results': 'LineageResultsDTO' - } +'finished': 'bool', +'id': 'str', +'percent_completed': 'int', +'request': 'LineageRequestDTO', +'results': 'LineageResultsDTO', +'submission_time': 'str', +'uri': 'str' } attribute_map = { - 'id': 'id', - 'uri': 'uri', - 'submission_time': 'submissionTime', 'expiration': 'expiration', - 'percent_completed': 'percentCompleted', - 'finished': 'finished', - 'request': 'request', - 'results': 'results' - } +'finished': 'finished', +'id': 'id', +'percent_completed': 'percentCompleted', +'request': 'request', +'results': 'results', +'submission_time': 'submissionTime', +'uri': 'uri' } - def __init__(self, id=None, uri=None, submission_time=None, expiration=None, percent_completed=None, finished=None, request=None, results=None): + def __init__(self, expiration=None, finished=None, id=None, percent_completed=None, request=None, results=None, submission_time=None, uri=None): """ LineageDTO - a model defined in Swagger """ - self._id = None - self._uri = None - self._submission_time = None self._expiration = None - self._percent_completed = None self._finished = None + self._id = None + self._percent_completed = None self._request = None self._results = None + self._submission_time = None + self._uri = None - if id is not None: - self.id = id - if uri is not None: - self.uri = uri - if submission_time is not None: - self.submission_time = submission_time if expiration is not None: self.expiration = expiration - if percent_completed is not None: - self.percent_completed = percent_completed if finished is not None: self.finished = finished + if id is not None: + self.id = id + if percent_completed is not None: + self.percent_completed = percent_completed if request is not None: self.request = request if results is not None: self.results = results + if submission_time is not None: + self.submission_time = submission_time + if uri is not None: + self.uri = uri @property - def id(self): - """ - Gets the id of this LineageDTO. - The id of this lineage query. - - :return: The id of this LineageDTO. - :rtype: str - """ - return self._id - - @id.setter - def id(self, id): - """ - Sets the id of this LineageDTO. - The id of this lineage query. - - :param id: The id of this LineageDTO. - :type: str - """ - - self._id = id - - @property - def uri(self): + def expiration(self): """ - Gets the uri of this LineageDTO. - The URI for this lineage query for later retrieval and deletion. + Gets the expiration of this LineageDTO. + When the lineage query will expire. - :return: The uri of this LineageDTO. + :return: The expiration of this LineageDTO. :rtype: str """ - return self._uri + return self._expiration - @uri.setter - def uri(self, uri): + @expiration.setter + def expiration(self, expiration): """ - Sets the uri of this LineageDTO. - The URI for this lineage query for later retrieval and deletion. + Sets the expiration of this LineageDTO. + When the lineage query will expire. - :param uri: The uri of this LineageDTO. + :param expiration: The expiration of this LineageDTO. :type: str """ - self._uri = uri + self._expiration = expiration @property - def submission_time(self): + def finished(self): """ - Gets the submission_time of this LineageDTO. - When the lineage query was submitted. + Gets the finished of this LineageDTO. + Whether the lineage query has finished. - :return: The submission_time of this LineageDTO. - :rtype: str + :return: The finished of this LineageDTO. + :rtype: bool """ - return self._submission_time + return self._finished - @submission_time.setter - def submission_time(self, submission_time): + @finished.setter + def finished(self, finished): """ - Sets the submission_time of this LineageDTO. - When the lineage query was submitted. + Sets the finished of this LineageDTO. + Whether the lineage query has finished. - :param submission_time: The submission_time of this LineageDTO. - :type: str + :param finished: The finished of this LineageDTO. + :type: bool """ - self._submission_time = submission_time + self._finished = finished @property - def expiration(self): + def id(self): """ - Gets the expiration of this LineageDTO. - When the lineage query will expire. + Gets the id of this LineageDTO. + The id of this lineage query. - :return: The expiration of this LineageDTO. + :return: The id of this LineageDTO. :rtype: str """ - return self._expiration + return self._id - @expiration.setter - def expiration(self, expiration): + @id.setter + def id(self, id): """ - Sets the expiration of this LineageDTO. - When the lineage query will expire. + Sets the id of this LineageDTO. + The id of this lineage query. - :param expiration: The expiration of this LineageDTO. + :param id: The id of this LineageDTO. :type: str """ - self._expiration = expiration + self._id = id @property def percent_completed(self): @@ -195,34 +169,10 @@ def percent_completed(self, percent_completed): self._percent_completed = percent_completed - @property - def finished(self): - """ - Gets the finished of this LineageDTO. - Whether the lineage query has finished. - - :return: The finished of this LineageDTO. - :rtype: bool - """ - return self._finished - - @finished.setter - def finished(self, finished): - """ - Sets the finished of this LineageDTO. - Whether the lineage query has finished. - - :param finished: The finished of this LineageDTO. - :type: bool - """ - - self._finished = finished - @property def request(self): """ Gets the request of this LineageDTO. - The initial lineage result. :return: The request of this LineageDTO. :rtype: LineageRequestDTO @@ -233,7 +183,6 @@ def request(self): def request(self, request): """ Sets the request of this LineageDTO. - The initial lineage result. :param request: The request of this LineageDTO. :type: LineageRequestDTO @@ -245,7 +194,6 @@ def request(self, request): def results(self): """ Gets the results of this LineageDTO. - The results of the lineage query. :return: The results of this LineageDTO. :rtype: LineageResultsDTO @@ -256,7 +204,6 @@ def results(self): def results(self, results): """ Sets the results of this LineageDTO. - The results of the lineage query. :param results: The results of this LineageDTO. :type: LineageResultsDTO @@ -264,6 +211,52 @@ def results(self, results): self._results = results + @property + def submission_time(self): + """ + Gets the submission_time of this LineageDTO. + When the lineage query was submitted. + + :return: The submission_time of this LineageDTO. + :rtype: str + """ + return self._submission_time + + @submission_time.setter + def submission_time(self, submission_time): + """ + Sets the submission_time of this LineageDTO. + When the lineage query was submitted. + + :param submission_time: The submission_time of this LineageDTO. + :type: str + """ + + self._submission_time = submission_time + + @property + def uri(self): + """ + Gets the uri of this LineageDTO. + The URI for this lineage query for later retrieval and deletion. + + :return: The uri of this LineageDTO. + :rtype: str + """ + return self._uri + + @uri.setter + def uri(self, uri): + """ + Sets the uri of this LineageDTO. + The URI for this lineage query for later retrieval and deletion. + + :param uri: The uri of this LineageDTO. + :type: str + """ + + self._uri = uri + def to_dict(self): """ Returns the model properties as a dict diff --git a/nipyapi/nifi/models/lineage_entity.py b/nipyapi/nifi/models/lineage_entity.py index ceef8e8b..bf0a8218 100644 --- a/nipyapi/nifi/models/lineage_entity.py +++ b/nipyapi/nifi/models/lineage_entity.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,12 +27,10 @@ class LineageEntity(object): and the value is json key in definition. """ swagger_types = { - 'lineage': 'LineageDTO' - } + 'lineage': 'LineageDTO' } attribute_map = { - 'lineage': 'lineage' - } + 'lineage': 'lineage' } def __init__(self, lineage=None): """ diff --git a/nipyapi/nifi/models/lineage_request_dto.py b/nipyapi/nifi/models/lineage_request_dto.py index a9981354..7dd753f9 100644 --- a/nipyapi/nifi/models/lineage_request_dto.py +++ b/nipyapi/nifi/models/lineage_request_dto.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,43 +27,64 @@ class LineageRequestDTO(object): and the value is json key in definition. """ swagger_types = { - 'event_id': 'int', - 'lineage_request_type': 'str', - 'uuid': 'str', - 'cluster_node_id': 'str' - } + 'cluster_node_id': 'str', +'event_id': 'int', +'lineage_request_type': 'str', +'uuid': 'str' } attribute_map = { - 'event_id': 'eventId', - 'lineage_request_type': 'lineageRequestType', - 'uuid': 'uuid', - 'cluster_node_id': 'clusterNodeId' - } + 'cluster_node_id': 'clusterNodeId', +'event_id': 'eventId', +'lineage_request_type': 'lineageRequestType', +'uuid': 'uuid' } - def __init__(self, event_id=None, lineage_request_type=None, uuid=None, cluster_node_id=None): + def __init__(self, cluster_node_id=None, event_id=None, lineage_request_type=None, uuid=None): """ LineageRequestDTO - a model defined in Swagger """ + self._cluster_node_id = None self._event_id = None self._lineage_request_type = None self._uuid = None - self._cluster_node_id = None + if cluster_node_id is not None: + self.cluster_node_id = cluster_node_id if event_id is not None: self.event_id = event_id if lineage_request_type is not None: self.lineage_request_type = lineage_request_type if uuid is not None: self.uuid = uuid - if cluster_node_id is not None: - self.cluster_node_id = cluster_node_id + + @property + def cluster_node_id(self): + """ + Gets the cluster_node_id of this LineageRequestDTO. + The id of the node where this lineage originated if clustered. + + :return: The cluster_node_id of this LineageRequestDTO. + :rtype: str + """ + return self._cluster_node_id + + @cluster_node_id.setter + def cluster_node_id(self, cluster_node_id): + """ + Sets the cluster_node_id of this LineageRequestDTO. + The id of the node where this lineage originated if clustered. + + :param cluster_node_id: The cluster_node_id of this LineageRequestDTO. + :type: str + """ + + self._cluster_node_id = cluster_node_id @property def event_id(self): """ Gets the event_id of this LineageRequestDTO. - The event id that was used to generate this lineage, if applicable. The event id is allowed for any type of lineageRequestType. If the lineageRequestType is FLOWFILE and the flowfile uuid is also included in the request, the event id will be ignored. + The event id that was used to generate this lineage, if applicable. The event id is allowed for any type of lineageRequestType. If the lineageRequestType is FLOWFILE and the flowfile uuid is also included in the request, the event id will be ignored. :return: The event_id of this LineageRequestDTO. :rtype: int @@ -75,7 +95,7 @@ def event_id(self): def event_id(self, event_id): """ Sets the event_id of this LineageRequestDTO. - The event id that was used to generate this lineage, if applicable. The event id is allowed for any type of lineageRequestType. If the lineageRequestType is FLOWFILE and the flowfile uuid is also included in the request, the event id will be ignored. + The event id that was used to generate this lineage, if applicable. The event id is allowed for any type of lineageRequestType. If the lineageRequestType is FLOWFILE and the flowfile uuid is also included in the request, the event id will be ignored. :param event_id: The event_id of this LineageRequestDTO. :type: int @@ -103,7 +123,7 @@ 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", "and FLOWFILE"] + 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}" @@ -135,29 +155,6 @@ def uuid(self, uuid): self._uuid = uuid - @property - def cluster_node_id(self): - """ - Gets the cluster_node_id of this LineageRequestDTO. - The id of the node where this lineage originated if clustered. - - :return: The cluster_node_id of this LineageRequestDTO. - :rtype: str - """ - return self._cluster_node_id - - @cluster_node_id.setter - def cluster_node_id(self, cluster_node_id): - """ - Sets the cluster_node_id of this LineageRequestDTO. - The id of the node where this lineage originated if clustered. - - :param cluster_node_id: The cluster_node_id of this LineageRequestDTO. - :type: str - """ - - self._cluster_node_id = cluster_node_id - def to_dict(self): """ Returns the model properties as a dict diff --git a/nipyapi/nifi/models/lineage_results_dto.py b/nipyapi/nifi/models/lineage_results_dto.py index b21681ea..99bf2cb7 100644 --- a/nipyapi/nifi/models/lineage_results_dto.py +++ b/nipyapi/nifi/models/lineage_results_dto.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -29,31 +28,29 @@ class LineageResultsDTO(object): """ swagger_types = { 'errors': 'list[str]', - 'nodes': 'list[ProvenanceNodeDTO]', - 'links': 'list[ProvenanceLinkDTO]' - } +'links': 'list[ProvenanceLinkDTO]', +'nodes': 'list[ProvenanceNodeDTO]' } attribute_map = { 'errors': 'errors', - 'nodes': 'nodes', - 'links': 'links' - } +'links': 'links', +'nodes': 'nodes' } - def __init__(self, errors=None, nodes=None, links=None): + def __init__(self, errors=None, links=None, nodes=None): """ LineageResultsDTO - a model defined in Swagger """ self._errors = None - self._nodes = None self._links = None + self._nodes = None if errors is not None: self.errors = errors - if nodes is not None: - self.nodes = nodes if links is not None: self.links = links + if nodes is not None: + self.nodes = nodes @property def errors(self): @@ -78,29 +75,6 @@ def errors(self, errors): self._errors = errors - @property - def nodes(self): - """ - Gets the nodes of this LineageResultsDTO. - The nodes in the lineage. - - :return: The nodes of this LineageResultsDTO. - :rtype: list[ProvenanceNodeDTO] - """ - return self._nodes - - @nodes.setter - def nodes(self, nodes): - """ - Sets the nodes of this LineageResultsDTO. - The nodes in the lineage. - - :param nodes: The nodes of this LineageResultsDTO. - :type: list[ProvenanceNodeDTO] - """ - - self._nodes = nodes - @property def links(self): """ @@ -124,6 +98,29 @@ def links(self, links): self._links = links + @property + def nodes(self): + """ + Gets the nodes of this LineageResultsDTO. + The nodes in the lineage. + + :return: The nodes of this LineageResultsDTO. + :rtype: list[ProvenanceNodeDTO] + """ + return self._nodes + + @nodes.setter + def nodes(self, nodes): + """ + Sets the nodes of this LineageResultsDTO. + The nodes in the lineage. + + :param nodes: The nodes of this LineageResultsDTO. + :type: list[ProvenanceNodeDTO] + """ + + self._nodes = nodes + def to_dict(self): """ Returns the model properties as a dict diff --git a/nipyapi/nifi/models/listing_request_dto.py b/nipyapi/nifi/models/listing_request_dto.py index a82b03e0..5cb8765a 100644 --- a/nipyapi/nifi/models/listing_request_dto.py +++ b/nipyapi/nifi/models/listing_request_dto.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,243 +27,218 @@ class ListingRequestDTO(object): and the value is json key in definition. """ swagger_types = { - 'id': 'str', - 'uri': 'str', - 'submission_time': 'str', - 'last_updated': 'str', - 'percent_completed': 'int', - 'finished': 'bool', - 'failure_reason': 'str', - 'max_results': 'int', - 'state': 'str', - 'queue_size': 'QueueSizeDTO', - 'flow_file_summaries': 'list[FlowFileSummaryDTO]', 'destination_running': 'bool', - 'source_running': 'bool' - } +'failure_reason': 'str', +'finished': 'bool', +'flow_file_summaries': 'list[FlowFileSummaryDTO]', +'id': 'str', +'last_updated': 'str', +'max_results': 'int', +'percent_completed': 'int', +'queue_size': 'QueueSizeDTO', +'source_running': 'bool', +'state': 'str', +'submission_time': 'str', +'uri': 'str' } attribute_map = { - 'id': 'id', - 'uri': 'uri', - 'submission_time': 'submissionTime', - 'last_updated': 'lastUpdated', - 'percent_completed': 'percentCompleted', - 'finished': 'finished', - 'failure_reason': 'failureReason', - 'max_results': 'maxResults', - 'state': 'state', - 'queue_size': 'queueSize', - 'flow_file_summaries': 'flowFileSummaries', 'destination_running': 'destinationRunning', - 'source_running': 'sourceRunning' - } - - def __init__(self, id=None, uri=None, submission_time=None, last_updated=None, percent_completed=None, finished=None, failure_reason=None, max_results=None, state=None, queue_size=None, flow_file_summaries=None, destination_running=None, source_running=None): +'failure_reason': 'failureReason', +'finished': 'finished', +'flow_file_summaries': 'flowFileSummaries', +'id': 'id', +'last_updated': 'lastUpdated', +'max_results': 'maxResults', +'percent_completed': 'percentCompleted', +'queue_size': 'queueSize', +'source_running': 'sourceRunning', +'state': 'state', +'submission_time': 'submissionTime', +'uri': 'uri' } + + def __init__(self, destination_running=None, failure_reason=None, finished=None, flow_file_summaries=None, id=None, last_updated=None, max_results=None, percent_completed=None, queue_size=None, source_running=None, state=None, submission_time=None, uri=None): """ ListingRequestDTO - a model defined in Swagger """ + self._destination_running = None + self._failure_reason = None + self._finished = None + self._flow_file_summaries = None self._id = None - self._uri = None - self._submission_time = None self._last_updated = None - self._percent_completed = None - self._finished = None - self._failure_reason = None self._max_results = None - self._state = None + self._percent_completed = None self._queue_size = None - self._flow_file_summaries = None - self._destination_running = None self._source_running = None + self._state = None + self._submission_time = None + self._uri = None + if destination_running is not None: + self.destination_running = destination_running + if failure_reason is not None: + self.failure_reason = failure_reason + if finished is not None: + self.finished = finished + if flow_file_summaries is not None: + self.flow_file_summaries = flow_file_summaries if id is not None: self.id = id - if uri is not None: - self.uri = uri - if submission_time is not None: - self.submission_time = submission_time if last_updated is not None: self.last_updated = last_updated - if percent_completed is not None: - self.percent_completed = percent_completed - if finished is not None: - self.finished = finished - if failure_reason is not None: - self.failure_reason = failure_reason if max_results is not None: self.max_results = max_results - if state is not None: - self.state = state + if percent_completed is not None: + self.percent_completed = percent_completed if queue_size is not None: self.queue_size = queue_size - if flow_file_summaries is not None: - self.flow_file_summaries = flow_file_summaries - if destination_running is not None: - self.destination_running = destination_running if source_running is not None: self.source_running = source_running + if state is not None: + self.state = state + if submission_time is not None: + self.submission_time = submission_time + if uri is not None: + self.uri = uri @property - def id(self): - """ - Gets the id of this ListingRequestDTO. - The id for this listing request. - - :return: The id of this ListingRequestDTO. - :rtype: str - """ - return self._id - - @id.setter - def id(self, id): - """ - Sets the id of this ListingRequestDTO. - The id for this listing request. - - :param id: The id of this ListingRequestDTO. - :type: str - """ - - self._id = id - - @property - def uri(self): + def destination_running(self): """ - Gets the uri of this ListingRequestDTO. - The URI for future requests to this listing request. + Gets the destination_running of this ListingRequestDTO. + Whether the destination of the connection is running - :return: The uri of this ListingRequestDTO. - :rtype: str + :return: The destination_running of this ListingRequestDTO. + :rtype: bool """ - return self._uri + return self._destination_running - @uri.setter - def uri(self, uri): + @destination_running.setter + def destination_running(self, destination_running): """ - Sets the uri of this ListingRequestDTO. - The URI for future requests to this listing request. + Sets the destination_running of this ListingRequestDTO. + Whether the destination of the connection is running - :param uri: The uri of this ListingRequestDTO. - :type: str + :param destination_running: The destination_running of this ListingRequestDTO. + :type: bool """ - self._uri = uri + self._destination_running = destination_running @property - def submission_time(self): + def failure_reason(self): """ - Gets the submission_time of this ListingRequestDTO. - The timestamp when the query was submitted. + Gets the failure_reason of this ListingRequestDTO. + The reason, if any, that this listing request failed. - :return: The submission_time of this ListingRequestDTO. + :return: The failure_reason of this ListingRequestDTO. :rtype: str """ - return self._submission_time + return self._failure_reason - @submission_time.setter - def submission_time(self, submission_time): + @failure_reason.setter + def failure_reason(self, failure_reason): """ - Sets the submission_time of this ListingRequestDTO. - The timestamp when the query was submitted. + Sets the failure_reason of this ListingRequestDTO. + The reason, if any, that this listing request failed. - :param submission_time: The submission_time of this ListingRequestDTO. + :param failure_reason: The failure_reason of this ListingRequestDTO. :type: str """ - self._submission_time = submission_time + self._failure_reason = failure_reason @property - def last_updated(self): + def finished(self): """ - Gets the last_updated of this ListingRequestDTO. - The last time this listing request was updated. + Gets the finished of this ListingRequestDTO. + Whether the query has finished. - :return: The last_updated of this ListingRequestDTO. - :rtype: str + :return: The finished of this ListingRequestDTO. + :rtype: bool """ - return self._last_updated + return self._finished - @last_updated.setter - def last_updated(self, last_updated): + @finished.setter + def finished(self, finished): """ - Sets the last_updated of this ListingRequestDTO. - The last time this listing request was updated. + Sets the finished of this ListingRequestDTO. + Whether the query has finished. - :param last_updated: The last_updated of this ListingRequestDTO. - :type: str + :param finished: The finished of this ListingRequestDTO. + :type: bool """ - self._last_updated = last_updated + self._finished = finished @property - def percent_completed(self): + def flow_file_summaries(self): """ - Gets the percent_completed of this ListingRequestDTO. - The current percent complete. + Gets the flow_file_summaries of this ListingRequestDTO. + The FlowFile summaries. The summaries will be populated once the request has completed. - :return: The percent_completed of this ListingRequestDTO. - :rtype: int + :return: The flow_file_summaries of this ListingRequestDTO. + :rtype: list[FlowFileSummaryDTO] """ - return self._percent_completed + return self._flow_file_summaries - @percent_completed.setter - def percent_completed(self, percent_completed): + @flow_file_summaries.setter + def flow_file_summaries(self, flow_file_summaries): """ - Sets the percent_completed of this ListingRequestDTO. - The current percent complete. + Sets the flow_file_summaries of this ListingRequestDTO. + The FlowFile summaries. The summaries will be populated once the request has completed. - :param percent_completed: The percent_completed of this ListingRequestDTO. - :type: int + :param flow_file_summaries: The flow_file_summaries of this ListingRequestDTO. + :type: list[FlowFileSummaryDTO] """ - self._percent_completed = percent_completed + self._flow_file_summaries = flow_file_summaries @property - def finished(self): + def id(self): """ - Gets the finished of this ListingRequestDTO. - Whether the query has finished. + Gets the id of this ListingRequestDTO. + The id for this listing request. - :return: The finished of this ListingRequestDTO. - :rtype: bool + :return: The id of this ListingRequestDTO. + :rtype: str """ - return self._finished + return self._id - @finished.setter - def finished(self, finished): + @id.setter + def id(self, id): """ - Sets the finished of this ListingRequestDTO. - Whether the query has finished. + Sets the id of this ListingRequestDTO. + The id for this listing request. - :param finished: The finished of this ListingRequestDTO. - :type: bool + :param id: The id of this ListingRequestDTO. + :type: str """ - self._finished = finished + self._id = id @property - def failure_reason(self): + def last_updated(self): """ - Gets the failure_reason of this ListingRequestDTO. - The reason, if any, that this listing request failed. + Gets the last_updated of this ListingRequestDTO. + The last time this listing request was updated. - :return: The failure_reason of this ListingRequestDTO. + :return: The last_updated of this ListingRequestDTO. :rtype: str """ - return self._failure_reason + return self._last_updated - @failure_reason.setter - def failure_reason(self, failure_reason): + @last_updated.setter + def last_updated(self, last_updated): """ - Sets the failure_reason of this ListingRequestDTO. - The reason, if any, that this listing request failed. + Sets the last_updated of this ListingRequestDTO. + The last time this listing request was updated. - :param failure_reason: The failure_reason of this ListingRequestDTO. + :param last_updated: The last_updated of this ListingRequestDTO. :type: str """ - self._failure_reason = failure_reason + self._last_updated = last_updated @property def max_results(self): @@ -290,33 +264,32 @@ def max_results(self, max_results): self._max_results = max_results @property - def state(self): + def percent_completed(self): """ - Gets the state of this ListingRequestDTO. - The current state of the listing request. + Gets the percent_completed of this ListingRequestDTO. + The current percent complete. - :return: The state of this ListingRequestDTO. - :rtype: str + :return: The percent_completed of this ListingRequestDTO. + :rtype: int """ - return self._state + return self._percent_completed - @state.setter - def state(self, state): + @percent_completed.setter + def percent_completed(self, percent_completed): """ - Sets the state of this ListingRequestDTO. - The current state of the listing request. + Sets the percent_completed of this ListingRequestDTO. + The current percent complete. - :param state: The state of this ListingRequestDTO. - :type: str + :param percent_completed: The percent_completed of this ListingRequestDTO. + :type: int """ - self._state = state + self._percent_completed = percent_completed @property def queue_size(self): """ Gets the queue_size of this ListingRequestDTO. - The size of the queue :return: The queue_size of this ListingRequestDTO. :rtype: QueueSizeDTO @@ -327,7 +300,6 @@ def queue_size(self): def queue_size(self, queue_size): """ Sets the queue_size of this ListingRequestDTO. - The size of the queue :param queue_size: The queue_size of this ListingRequestDTO. :type: QueueSizeDTO @@ -336,73 +308,96 @@ def queue_size(self, queue_size): self._queue_size = queue_size @property - def flow_file_summaries(self): + def source_running(self): """ - Gets the flow_file_summaries of this ListingRequestDTO. - The FlowFile summaries. The summaries will be populated once the request has completed. + Gets the source_running of this ListingRequestDTO. + Whether the source of the connection is running - :return: The flow_file_summaries of this ListingRequestDTO. - :rtype: list[FlowFileSummaryDTO] + :return: The source_running of this ListingRequestDTO. + :rtype: bool """ - return self._flow_file_summaries + return self._source_running - @flow_file_summaries.setter - def flow_file_summaries(self, flow_file_summaries): + @source_running.setter + def source_running(self, source_running): """ - Sets the flow_file_summaries of this ListingRequestDTO. - The FlowFile summaries. The summaries will be populated once the request has completed. + Sets the source_running of this ListingRequestDTO. + Whether the source of the connection is running - :param flow_file_summaries: The flow_file_summaries of this ListingRequestDTO. - :type: list[FlowFileSummaryDTO] + :param source_running: The source_running of this ListingRequestDTO. + :type: bool """ - self._flow_file_summaries = flow_file_summaries + self._source_running = source_running @property - def destination_running(self): + def state(self): """ - Gets the destination_running of this ListingRequestDTO. - Whether the destination of the connection is running + Gets the state of this ListingRequestDTO. + The current state of the listing request. - :return: The destination_running of this ListingRequestDTO. - :rtype: bool + :return: The state of this ListingRequestDTO. + :rtype: str """ - return self._destination_running + return self._state - @destination_running.setter - def destination_running(self, destination_running): + @state.setter + def state(self, state): """ - Sets the destination_running of this ListingRequestDTO. - Whether the destination of the connection is running + Sets the state of this ListingRequestDTO. + The current state of the listing request. - :param destination_running: The destination_running of this ListingRequestDTO. - :type: bool + :param state: The state of this ListingRequestDTO. + :type: str """ - self._destination_running = destination_running + self._state = state @property - def source_running(self): + def submission_time(self): """ - Gets the source_running of this ListingRequestDTO. - Whether the source of the connection is running + Gets the submission_time of this ListingRequestDTO. + The timestamp when the query was submitted. - :return: The source_running of this ListingRequestDTO. - :rtype: bool + :return: The submission_time of this ListingRequestDTO. + :rtype: str """ - return self._source_running + return self._submission_time - @source_running.setter - def source_running(self, source_running): + @submission_time.setter + def submission_time(self, submission_time): """ - Sets the source_running of this ListingRequestDTO. - Whether the source of the connection is running + Sets the submission_time of this ListingRequestDTO. + The timestamp when the query was submitted. - :param source_running: The source_running of this ListingRequestDTO. - :type: bool + :param submission_time: The submission_time of this ListingRequestDTO. + :type: str """ - self._source_running = source_running + self._submission_time = submission_time + + @property + def uri(self): + """ + Gets the uri of this ListingRequestDTO. + The URI for future requests to this listing request. + + :return: The uri of this ListingRequestDTO. + :rtype: str + """ + return self._uri + + @uri.setter + def uri(self, uri): + """ + Sets the uri of this ListingRequestDTO. + The URI for future requests to this listing request. + + :param uri: The uri of this ListingRequestDTO. + :type: str + """ + + self._uri = uri def to_dict(self): """ diff --git a/nipyapi/nifi/models/listing_request_entity.py b/nipyapi/nifi/models/listing_request_entity.py index 292a46ea..53966b6c 100644 --- a/nipyapi/nifi/models/listing_request_entity.py +++ b/nipyapi/nifi/models/listing_request_entity.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,12 +27,10 @@ class ListingRequestEntity(object): and the value is json key in definition. """ swagger_types = { - 'listing_request': 'ListingRequestDTO' - } + 'listing_request': 'ListingRequestDTO' } attribute_map = { - 'listing_request': 'listingRequest' - } + 'listing_request': 'listingRequest' } def __init__(self, listing_request=None): """ diff --git a/nipyapi/nifi/models/local_queue_partition_dto.py b/nipyapi/nifi/models/local_queue_partition_dto.py deleted file mode 100644 index 00c5ab0d..00000000 --- a/nipyapi/nifi/models/local_queue_partition_dto.py +++ /dev/null @@ -1,402 +0,0 @@ -""" - NiFi Rest API - - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - - OpenAPI spec version: 1.28.1 - Contact: dev@nifi.apache.org - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - - -from pprint import pformat -import re - - -class LocalQueuePartitionDTO(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 = { - 'total_flow_file_count': 'int', - 'total_byte_count': 'int', - 'active_queue_flow_file_count': 'int', - 'active_queue_byte_count': 'int', - 'swap_flow_file_count': 'int', - 'swap_byte_count': 'int', - 'swap_files': 'int', - 'in_flight_flow_file_count': 'int', - 'in_flight_byte_count': 'int', - 'all_active_queue_flow_files_penalized': 'bool', - 'any_active_queue_flow_files_penalized': 'bool' - } - - attribute_map = { - 'total_flow_file_count': 'totalFlowFileCount', - 'total_byte_count': 'totalByteCount', - 'active_queue_flow_file_count': 'activeQueueFlowFileCount', - 'active_queue_byte_count': 'activeQueueByteCount', - 'swap_flow_file_count': 'swapFlowFileCount', - 'swap_byte_count': 'swapByteCount', - 'swap_files': 'swapFiles', - 'in_flight_flow_file_count': 'inFlightFlowFileCount', - 'in_flight_byte_count': 'inFlightByteCount', - 'all_active_queue_flow_files_penalized': 'allActiveQueueFlowFilesPenalized', - 'any_active_queue_flow_files_penalized': 'anyActiveQueueFlowFilesPenalized' - } - - def __init__(self, total_flow_file_count=None, total_byte_count=None, active_queue_flow_file_count=None, active_queue_byte_count=None, swap_flow_file_count=None, swap_byte_count=None, swap_files=None, in_flight_flow_file_count=None, in_flight_byte_count=None, all_active_queue_flow_files_penalized=None, any_active_queue_flow_files_penalized=None): - """ - LocalQueuePartitionDTO - a model defined in Swagger - """ - - self._total_flow_file_count = None - self._total_byte_count = None - self._active_queue_flow_file_count = None - self._active_queue_byte_count = None - self._swap_flow_file_count = None - self._swap_byte_count = None - self._swap_files = None - self._in_flight_flow_file_count = None - self._in_flight_byte_count = None - self._all_active_queue_flow_files_penalized = None - self._any_active_queue_flow_files_penalized = None - - if total_flow_file_count is not None: - self.total_flow_file_count = total_flow_file_count - if total_byte_count is not None: - self.total_byte_count = total_byte_count - if active_queue_flow_file_count is not None: - self.active_queue_flow_file_count = active_queue_flow_file_count - if active_queue_byte_count is not None: - self.active_queue_byte_count = active_queue_byte_count - if swap_flow_file_count is not None: - self.swap_flow_file_count = swap_flow_file_count - if swap_byte_count is not None: - self.swap_byte_count = swap_byte_count - if swap_files is not None: - self.swap_files = swap_files - if in_flight_flow_file_count is not None: - self.in_flight_flow_file_count = in_flight_flow_file_count - if in_flight_byte_count is not None: - self.in_flight_byte_count = in_flight_byte_count - if all_active_queue_flow_files_penalized is not None: - self.all_active_queue_flow_files_penalized = all_active_queue_flow_files_penalized - if any_active_queue_flow_files_penalized is not None: - self.any_active_queue_flow_files_penalized = any_active_queue_flow_files_penalized - - @property - def total_flow_file_count(self): - """ - Gets the total_flow_file_count of this LocalQueuePartitionDTO. - Total number of FlowFiles owned by the Connection - - :return: The total_flow_file_count of this LocalQueuePartitionDTO. - :rtype: int - """ - return self._total_flow_file_count - - @total_flow_file_count.setter - def total_flow_file_count(self, total_flow_file_count): - """ - Sets the total_flow_file_count of this LocalQueuePartitionDTO. - Total number of FlowFiles owned by the Connection - - :param total_flow_file_count: The total_flow_file_count of this LocalQueuePartitionDTO. - :type: int - """ - - self._total_flow_file_count = total_flow_file_count - - @property - def total_byte_count(self): - """ - Gets the total_byte_count of this LocalQueuePartitionDTO. - Total number of bytes that make up the content for the FlowFiles owned by this Connection - - :return: The total_byte_count of this LocalQueuePartitionDTO. - :rtype: int - """ - return self._total_byte_count - - @total_byte_count.setter - def total_byte_count(self, total_byte_count): - """ - Sets the total_byte_count of this LocalQueuePartitionDTO. - Total number of bytes that make up the content for the FlowFiles owned by this Connection - - :param total_byte_count: The total_byte_count of this LocalQueuePartitionDTO. - :type: int - """ - - self._total_byte_count = total_byte_count - - @property - def active_queue_flow_file_count(self): - """ - Gets the active_queue_flow_file_count of this LocalQueuePartitionDTO. - Total number of FlowFiles that exist in the Connection's Active Queue, immediately available to be offered up to a component - - :return: The active_queue_flow_file_count of this LocalQueuePartitionDTO. - :rtype: int - """ - return self._active_queue_flow_file_count - - @active_queue_flow_file_count.setter - def active_queue_flow_file_count(self, active_queue_flow_file_count): - """ - Sets the active_queue_flow_file_count of this LocalQueuePartitionDTO. - Total number of FlowFiles that exist in the Connection's Active Queue, immediately available to be offered up to a component - - :param active_queue_flow_file_count: The active_queue_flow_file_count of this LocalQueuePartitionDTO. - :type: int - """ - - self._active_queue_flow_file_count = active_queue_flow_file_count - - @property - def active_queue_byte_count(self): - """ - Gets the active_queue_byte_count of this LocalQueuePartitionDTO. - Total number of bytes that make up the content for the FlowFiles that are present in the Connection's Active Queue - - :return: The active_queue_byte_count of this LocalQueuePartitionDTO. - :rtype: int - """ - return self._active_queue_byte_count - - @active_queue_byte_count.setter - def active_queue_byte_count(self, active_queue_byte_count): - """ - Sets the active_queue_byte_count of this LocalQueuePartitionDTO. - Total number of bytes that make up the content for the FlowFiles that are present in the Connection's Active Queue - - :param active_queue_byte_count: The active_queue_byte_count of this LocalQueuePartitionDTO. - :type: int - """ - - self._active_queue_byte_count = active_queue_byte_count - - @property - def swap_flow_file_count(self): - """ - Gets the swap_flow_file_count of this LocalQueuePartitionDTO. - The total number of FlowFiles that are swapped out for this Connection - - :return: The swap_flow_file_count of this LocalQueuePartitionDTO. - :rtype: int - """ - return self._swap_flow_file_count - - @swap_flow_file_count.setter - def swap_flow_file_count(self, swap_flow_file_count): - """ - Sets the swap_flow_file_count of this LocalQueuePartitionDTO. - The total number of FlowFiles that are swapped out for this Connection - - :param swap_flow_file_count: The swap_flow_file_count of this LocalQueuePartitionDTO. - :type: int - """ - - self._swap_flow_file_count = swap_flow_file_count - - @property - def swap_byte_count(self): - """ - Gets the swap_byte_count of this LocalQueuePartitionDTO. - Total number of bytes that make up the content for the FlowFiles that are swapped out to disk for the Connection - - :return: The swap_byte_count of this LocalQueuePartitionDTO. - :rtype: int - """ - return self._swap_byte_count - - @swap_byte_count.setter - def swap_byte_count(self, swap_byte_count): - """ - Sets the swap_byte_count of this LocalQueuePartitionDTO. - Total number of bytes that make up the content for the FlowFiles that are swapped out to disk for the Connection - - :param swap_byte_count: The swap_byte_count of this LocalQueuePartitionDTO. - :type: int - """ - - self._swap_byte_count = swap_byte_count - - @property - def swap_files(self): - """ - Gets the swap_files of this LocalQueuePartitionDTO. - The number of Swap Files that exist for this Connection - - :return: The swap_files of this LocalQueuePartitionDTO. - :rtype: int - """ - return self._swap_files - - @swap_files.setter - def swap_files(self, swap_files): - """ - Sets the swap_files of this LocalQueuePartitionDTO. - The number of Swap Files that exist for this Connection - - :param swap_files: The swap_files of this LocalQueuePartitionDTO. - :type: int - """ - - self._swap_files = swap_files - - @property - def in_flight_flow_file_count(self): - """ - Gets the in_flight_flow_file_count of this LocalQueuePartitionDTO. - The number of In-Flight FlowFiles for this Connection. These are FlowFiles that belong to the connection but are currently being operated on by a Processor, Port, etc. - - :return: The in_flight_flow_file_count of this LocalQueuePartitionDTO. - :rtype: int - """ - return self._in_flight_flow_file_count - - @in_flight_flow_file_count.setter - def in_flight_flow_file_count(self, in_flight_flow_file_count): - """ - Sets the in_flight_flow_file_count of this LocalQueuePartitionDTO. - The number of In-Flight FlowFiles for this Connection. These are FlowFiles that belong to the connection but are currently being operated on by a Processor, Port, etc. - - :param in_flight_flow_file_count: The in_flight_flow_file_count of this LocalQueuePartitionDTO. - :type: int - """ - - self._in_flight_flow_file_count = in_flight_flow_file_count - - @property - def in_flight_byte_count(self): - """ - Gets the in_flight_byte_count of this LocalQueuePartitionDTO. - The number bytes that make up the content of the FlowFiles that are In-Flight - - :return: The in_flight_byte_count of this LocalQueuePartitionDTO. - :rtype: int - """ - return self._in_flight_byte_count - - @in_flight_byte_count.setter - def in_flight_byte_count(self, in_flight_byte_count): - """ - Sets the in_flight_byte_count of this LocalQueuePartitionDTO. - The number bytes that make up the content of the FlowFiles that are In-Flight - - :param in_flight_byte_count: The in_flight_byte_count of this LocalQueuePartitionDTO. - :type: int - """ - - self._in_flight_byte_count = in_flight_byte_count - - @property - def all_active_queue_flow_files_penalized(self): - """ - Gets the all_active_queue_flow_files_penalized of this LocalQueuePartitionDTO. - Whether or not all of the FlowFiles in the Active Queue are penalized - - :return: The all_active_queue_flow_files_penalized of this LocalQueuePartitionDTO. - :rtype: bool - """ - return self._all_active_queue_flow_files_penalized - - @all_active_queue_flow_files_penalized.setter - def all_active_queue_flow_files_penalized(self, all_active_queue_flow_files_penalized): - """ - Sets the all_active_queue_flow_files_penalized of this LocalQueuePartitionDTO. - Whether or not all of the FlowFiles in the Active Queue are penalized - - :param all_active_queue_flow_files_penalized: The all_active_queue_flow_files_penalized of this LocalQueuePartitionDTO. - :type: bool - """ - - self._all_active_queue_flow_files_penalized = all_active_queue_flow_files_penalized - - @property - def any_active_queue_flow_files_penalized(self): - """ - Gets the any_active_queue_flow_files_penalized of this LocalQueuePartitionDTO. - Whether or not any of the FlowFiles in the Active Queue are penalized - - :return: The any_active_queue_flow_files_penalized of this LocalQueuePartitionDTO. - :rtype: bool - """ - return self._any_active_queue_flow_files_penalized - - @any_active_queue_flow_files_penalized.setter - def any_active_queue_flow_files_penalized(self, any_active_queue_flow_files_penalized): - """ - Sets the any_active_queue_flow_files_penalized of this LocalQueuePartitionDTO. - Whether or not any of the FlowFiles in the Active Queue are penalized - - :param any_active_queue_flow_files_penalized: The any_active_queue_flow_files_penalized of this LocalQueuePartitionDTO. - :type: bool - """ - - self._any_active_queue_flow_files_penalized = any_active_queue_flow_files_penalized - - 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, LocalQueuePartitionDTO): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other): - """ - Returns true if both objects are not equal - """ - return not self == other diff --git a/nipyapi/nifi/models/component_lifecycle.py b/nipyapi/nifi/models/long_parameter.py similarity index 71% rename from nipyapi/nifi/models/component_lifecycle.py rename to nipyapi/nifi/models/long_parameter.py index d9fd1765..56481c2e 100644 --- a/nipyapi/nifi/models/component_lifecycle.py +++ b/nipyapi/nifi/models/long_parameter.py @@ -1,19 +1,18 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re -class ComponentLifecycle(object): +class LongParameter(object): """ NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually. @@ -28,19 +27,41 @@ class ComponentLifecycle(object): and the value is json key in definition. """ swagger_types = { - - } + 'long': 'int' } attribute_map = { - - } + 'long': 'long' } + + def __init__(self, long=None): + """ + LongParameter - a model defined in Swagger + """ + + self._long = None - def __init__(self): + if long is not None: + self.long = long + + @property + def long(self): """ - ComponentLifecycle - a model defined in Swagger + Gets the long of this LongParameter. + + :return: The long of this LongParameter. + :rtype: int """ + return self._long + @long.setter + def long(self, long): + """ + Sets the long of this LongParameter. + + :param long: The long of this LongParameter. + :type: int + """ + self._long = long def to_dict(self): """ @@ -84,7 +105,7 @@ def __eq__(self, other): """ Returns true if both objects are equal """ - if not isinstance(other, ComponentLifecycle): + if not isinstance(other, LongParameter): return False return self.__dict__ == other.__dict__ diff --git a/nipyapi/nifi/models/multi_processor_use_case.py b/nipyapi/nifi/models/multi_processor_use_case.py new file mode 100644 index 00000000..346f5466 --- /dev/null +++ b/nipyapi/nifi/models/multi_processor_use_case.py @@ -0,0 +1,203 @@ +""" + Apache NiFi REST API + + REST API definition for Apache NiFi web services + + OpenAPI spec version: 2.5.0 + Contact: dev@nifi.apache.org + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from pprint import pformat +import re + + +class MultiProcessorUseCase(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 = { + 'configurations': 'list[ProcessorConfiguration]', +'description': 'str', +'keywords': 'list[str]', +'notes': 'str' } + + attribute_map = { + 'configurations': 'configurations', +'description': 'description', +'keywords': 'keywords', +'notes': 'notes' } + + def __init__(self, configurations=None, description=None, keywords=None, notes=None): + """ + MultiProcessorUseCase - a model defined in Swagger + """ + + self._configurations = None + self._description = None + self._keywords = None + self._notes = None + + if configurations is not None: + self.configurations = configurations + if description is not None: + self.description = description + if keywords is not None: + self.keywords = keywords + if notes is not None: + self.notes = notes + + @property + def configurations(self): + """ + Gets the configurations of this MultiProcessorUseCase. + A description of how to configure the Processor to perform the task described in the use case + + :return: The configurations of this MultiProcessorUseCase. + :rtype: list[ProcessorConfiguration] + """ + return self._configurations + + @configurations.setter + def configurations(self, configurations): + """ + Sets the configurations of this MultiProcessorUseCase. + A description of how to configure the Processor to perform the task described in the use case + + :param configurations: The configurations of this MultiProcessorUseCase. + :type: list[ProcessorConfiguration] + """ + + self._configurations = configurations + + @property + def description(self): + """ + Gets the description of this MultiProcessorUseCase. + A description of the use case + + :return: The description of this MultiProcessorUseCase. + :rtype: str + """ + return self._description + + @description.setter + def description(self, description): + """ + Sets the description of this MultiProcessorUseCase. + A description of the use case + + :param description: The description of this MultiProcessorUseCase. + :type: str + """ + + self._description = description + + @property + def keywords(self): + """ + Gets the keywords of this MultiProcessorUseCase. + Keywords that pertain to the use csae + + :return: The keywords of this MultiProcessorUseCase. + :rtype: list[str] + """ + return self._keywords + + @keywords.setter + def keywords(self, keywords): + """ + Sets the keywords of this MultiProcessorUseCase. + Keywords that pertain to the use csae + + :param keywords: The keywords of this MultiProcessorUseCase. + :type: list[str] + """ + + self._keywords = keywords + + @property + def notes(self): + """ + Gets the notes of this MultiProcessorUseCase. + Any pertinent notes about the use case + + :return: The notes of this MultiProcessorUseCase. + :rtype: str + """ + return self._notes + + @notes.setter + def notes(self, notes): + """ + Sets the notes of this MultiProcessorUseCase. + Any pertinent notes about the use case + + :param notes: The notes of this MultiProcessorUseCase. + :type: str + """ + + self._notes = notes + + 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, MultiProcessorUseCase): + 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/nar_coordinate_dto.py b/nipyapi/nifi/models/nar_coordinate_dto.py new file mode 100644 index 00000000..fb0af736 --- /dev/null +++ b/nipyapi/nifi/models/nar_coordinate_dto.py @@ -0,0 +1,175 @@ +""" + Apache NiFi REST API + + REST API definition for Apache NiFi web services + + OpenAPI spec version: 2.5.0 + Contact: dev@nifi.apache.org + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from pprint import pformat +import re + + +class NarCoordinateDTO(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 = { + 'artifact': 'str', +'group': 'str', +'version': 'str' } + + attribute_map = { + 'artifact': 'artifact', +'group': 'group', +'version': 'version' } + + def __init__(self, artifact=None, group=None, version=None): + """ + NarCoordinateDTO - a model defined in Swagger + """ + + self._artifact = None + self._group = None + self._version = None + + if artifact is not None: + self.artifact = artifact + if group is not None: + self.group = group + if version is not None: + self.version = version + + @property + def artifact(self): + """ + Gets the artifact of this NarCoordinateDTO. + The artifact id of the NAR. + + :return: The artifact of this NarCoordinateDTO. + :rtype: str + """ + return self._artifact + + @artifact.setter + def artifact(self, artifact): + """ + Sets the artifact of this NarCoordinateDTO. + The artifact id of the NAR. + + :param artifact: The artifact of this NarCoordinateDTO. + :type: str + """ + + self._artifact = artifact + + @property + def group(self): + """ + Gets the group of this NarCoordinateDTO. + The group of the NAR. + + :return: The group of this NarCoordinateDTO. + :rtype: str + """ + return self._group + + @group.setter + def group(self, group): + """ + Sets the group of this NarCoordinateDTO. + The group of the NAR. + + :param group: The group of this NarCoordinateDTO. + :type: str + """ + + self._group = group + + @property + def version(self): + """ + Gets the version of this NarCoordinateDTO. + The version of the NAR. + + :return: The version of this NarCoordinateDTO. + :rtype: str + """ + return self._version + + @version.setter + def version(self, version): + """ + Sets the version of this NarCoordinateDTO. + The version of the NAR. + + :param version: The version of this NarCoordinateDTO. + :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, NarCoordinateDTO): + 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/nar_details_entity.py b/nipyapi/nifi/models/nar_details_entity.py new file mode 100644 index 00000000..fef69af9 --- /dev/null +++ b/nipyapi/nifi/models/nar_details_entity.py @@ -0,0 +1,313 @@ +""" + Apache NiFi REST API + + REST API definition for Apache NiFi web services + + OpenAPI spec version: 2.5.0 + Contact: dev@nifi.apache.org + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from pprint import pformat +import re + + +class NarDetailsEntity(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 = { + 'controller_service_types': 'list[DocumentedTypeDTO]', +'dependent_coordinates': 'list[NarCoordinateDTO]', +'flow_analysis_rule_types': 'list[DocumentedTypeDTO]', +'flow_registry_client_types': 'list[DocumentedTypeDTO]', +'nar_summary': 'NarSummaryDTO', +'parameter_provider_types': 'list[DocumentedTypeDTO]', +'processor_types': 'list[DocumentedTypeDTO]', +'reporting_task_types': 'list[DocumentedTypeDTO]' } + + attribute_map = { + 'controller_service_types': 'controllerServiceTypes', +'dependent_coordinates': 'dependentCoordinates', +'flow_analysis_rule_types': 'flowAnalysisRuleTypes', +'flow_registry_client_types': 'flowRegistryClientTypes', +'nar_summary': 'narSummary', +'parameter_provider_types': 'parameterProviderTypes', +'processor_types': 'processorTypes', +'reporting_task_types': 'reportingTaskTypes' } + + def __init__(self, controller_service_types=None, dependent_coordinates=None, flow_analysis_rule_types=None, flow_registry_client_types=None, nar_summary=None, parameter_provider_types=None, processor_types=None, reporting_task_types=None): + """ + NarDetailsEntity - a model defined in Swagger + """ + + self._controller_service_types = None + self._dependent_coordinates = None + self._flow_analysis_rule_types = None + self._flow_registry_client_types = None + self._nar_summary = None + self._parameter_provider_types = None + self._processor_types = None + self._reporting_task_types = None + + if controller_service_types is not None: + self.controller_service_types = controller_service_types + if dependent_coordinates is not None: + self.dependent_coordinates = dependent_coordinates + if flow_analysis_rule_types is not None: + self.flow_analysis_rule_types = flow_analysis_rule_types + if flow_registry_client_types is not None: + self.flow_registry_client_types = flow_registry_client_types + if nar_summary is not None: + self.nar_summary = nar_summary + if parameter_provider_types is not None: + self.parameter_provider_types = parameter_provider_types + if processor_types is not None: + self.processor_types = processor_types + if reporting_task_types is not None: + self.reporting_task_types = reporting_task_types + + @property + def controller_service_types(self): + """ + Gets the controller_service_types of this NarDetailsEntity. + The ControllerService types contained in the NAR + + :return: The controller_service_types of this NarDetailsEntity. + :rtype: list[DocumentedTypeDTO] + """ + return self._controller_service_types + + @controller_service_types.setter + def controller_service_types(self, controller_service_types): + """ + Sets the controller_service_types of this NarDetailsEntity. + The ControllerService types contained in the NAR + + :param controller_service_types: The controller_service_types of this NarDetailsEntity. + :type: list[DocumentedTypeDTO] + """ + + self._controller_service_types = controller_service_types + + @property + def dependent_coordinates(self): + """ + Gets the dependent_coordinates of this NarDetailsEntity. + The coordinates of NARs that depend on this NAR + + :return: The dependent_coordinates of this NarDetailsEntity. + :rtype: list[NarCoordinateDTO] + """ + return self._dependent_coordinates + + @dependent_coordinates.setter + def dependent_coordinates(self, dependent_coordinates): + """ + Sets the dependent_coordinates of this NarDetailsEntity. + The coordinates of NARs that depend on this NAR + + :param dependent_coordinates: The dependent_coordinates of this NarDetailsEntity. + :type: list[NarCoordinateDTO] + """ + + self._dependent_coordinates = dependent_coordinates + + @property + def flow_analysis_rule_types(self): + """ + Gets the flow_analysis_rule_types of this NarDetailsEntity. + The FlowAnalysisRule types contained in the NAR + + :return: The flow_analysis_rule_types of this NarDetailsEntity. + :rtype: list[DocumentedTypeDTO] + """ + return self._flow_analysis_rule_types + + @flow_analysis_rule_types.setter + def flow_analysis_rule_types(self, flow_analysis_rule_types): + """ + Sets the flow_analysis_rule_types of this NarDetailsEntity. + The FlowAnalysisRule types contained in the NAR + + :param flow_analysis_rule_types: The flow_analysis_rule_types of this NarDetailsEntity. + :type: list[DocumentedTypeDTO] + """ + + self._flow_analysis_rule_types = flow_analysis_rule_types + + @property + def flow_registry_client_types(self): + """ + Gets the flow_registry_client_types of this NarDetailsEntity. + The FlowRegistryClient types contained in the NAR + + :return: The flow_registry_client_types of this NarDetailsEntity. + :rtype: list[DocumentedTypeDTO] + """ + return self._flow_registry_client_types + + @flow_registry_client_types.setter + def flow_registry_client_types(self, flow_registry_client_types): + """ + Sets the flow_registry_client_types of this NarDetailsEntity. + The FlowRegistryClient types contained in the NAR + + :param flow_registry_client_types: The flow_registry_client_types of this NarDetailsEntity. + :type: list[DocumentedTypeDTO] + """ + + self._flow_registry_client_types = flow_registry_client_types + + @property + def nar_summary(self): + """ + Gets the nar_summary of this NarDetailsEntity. + + :return: The nar_summary of this NarDetailsEntity. + :rtype: NarSummaryDTO + """ + return self._nar_summary + + @nar_summary.setter + def nar_summary(self, nar_summary): + """ + Sets the nar_summary of this NarDetailsEntity. + + :param nar_summary: The nar_summary of this NarDetailsEntity. + :type: NarSummaryDTO + """ + + self._nar_summary = nar_summary + + @property + def parameter_provider_types(self): + """ + Gets the parameter_provider_types of this NarDetailsEntity. + The ParameterProvider types contained in the NAR + + :return: The parameter_provider_types of this NarDetailsEntity. + :rtype: list[DocumentedTypeDTO] + """ + return self._parameter_provider_types + + @parameter_provider_types.setter + def parameter_provider_types(self, parameter_provider_types): + """ + Sets the parameter_provider_types of this NarDetailsEntity. + The ParameterProvider types contained in the NAR + + :param parameter_provider_types: The parameter_provider_types of this NarDetailsEntity. + :type: list[DocumentedTypeDTO] + """ + + self._parameter_provider_types = parameter_provider_types + + @property + def processor_types(self): + """ + Gets the processor_types of this NarDetailsEntity. + The Processor types contained in the NAR + + :return: The processor_types of this NarDetailsEntity. + :rtype: list[DocumentedTypeDTO] + """ + return self._processor_types + + @processor_types.setter + def processor_types(self, processor_types): + """ + Sets the processor_types of this NarDetailsEntity. + The Processor types contained in the NAR + + :param processor_types: The processor_types of this NarDetailsEntity. + :type: list[DocumentedTypeDTO] + """ + + self._processor_types = processor_types + + @property + def reporting_task_types(self): + """ + Gets the reporting_task_types of this NarDetailsEntity. + The ReportingTask types contained in the NAR + + :return: The reporting_task_types of this NarDetailsEntity. + :rtype: list[DocumentedTypeDTO] + """ + return self._reporting_task_types + + @reporting_task_types.setter + def reporting_task_types(self, reporting_task_types): + """ + Sets the reporting_task_types of this NarDetailsEntity. + The ReportingTask types contained in the NAR + + :param reporting_task_types: The reporting_task_types of this NarDetailsEntity. + :type: list[DocumentedTypeDTO] + """ + + self._reporting_task_types = reporting_task_types + + 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, NarDetailsEntity): + 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/nar_summaries_entity.py b/nipyapi/nifi/models/nar_summaries_entity.py new file mode 100644 index 00000000..e14992ec --- /dev/null +++ b/nipyapi/nifi/models/nar_summaries_entity.py @@ -0,0 +1,147 @@ +""" + Apache NiFi REST API + + REST API definition for Apache NiFi web services + + OpenAPI spec version: 2.5.0 + Contact: dev@nifi.apache.org + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from pprint import pformat +import re + + +class NarSummariesEntity(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 = { + 'current_time': 'str', +'nar_summaries': 'list[NarSummaryEntity]' } + + attribute_map = { + 'current_time': 'currentTime', +'nar_summaries': 'narSummaries' } + + def __init__(self, current_time=None, nar_summaries=None): + """ + NarSummariesEntity - a model defined in Swagger + """ + + self._current_time = None + self._nar_summaries = None + + if current_time is not None: + self.current_time = current_time + if nar_summaries is not None: + self.nar_summaries = nar_summaries + + @property + def current_time(self): + """ + Gets the current_time of this NarSummariesEntity. + The current time on the system. + + :return: The current_time of this NarSummariesEntity. + :rtype: str + """ + return self._current_time + + @current_time.setter + def current_time(self, current_time): + """ + Sets the current_time of this NarSummariesEntity. + The current time on the system. + + :param current_time: The current_time of this NarSummariesEntity. + :type: str + """ + + self._current_time = current_time + + @property + def nar_summaries(self): + """ + Gets the nar_summaries of this NarSummariesEntity. + The NAR summaries + + :return: The nar_summaries of this NarSummariesEntity. + :rtype: list[NarSummaryEntity] + """ + return self._nar_summaries + + @nar_summaries.setter + def nar_summaries(self, nar_summaries): + """ + Sets the nar_summaries of this NarSummariesEntity. + The NAR summaries + + :param nar_summaries: The nar_summaries of this NarSummariesEntity. + :type: list[NarSummaryEntity] + """ + + self._nar_summaries = nar_summaries + + 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, NarSummariesEntity): + 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/nar_summary_dto.py b/nipyapi/nifi/models/nar_summary_dto.py new file mode 100644 index 00000000..e9c7da4c --- /dev/null +++ b/nipyapi/nifi/models/nar_summary_dto.py @@ -0,0 +1,423 @@ +""" + Apache NiFi REST API + + REST API definition for Apache NiFi web services + + OpenAPI spec version: 2.5.0 + Contact: dev@nifi.apache.org + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from pprint import pformat +import re + + +class NarSummaryDTO(object): + """ + NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. + """ + + + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'build_time': 'str', +'coordinate': 'NarCoordinateDTO', +'created_by': 'str', +'dependency_coordinate': 'NarCoordinateDTO', +'digest': 'str', +'extension_count': 'int', +'failure_message': 'str', +'identifier': 'str', +'install_complete': 'bool', +'source_identifier': 'str', +'source_type': 'str', +'state': 'str' } + + attribute_map = { + 'build_time': 'buildTime', +'coordinate': 'coordinate', +'created_by': 'createdBy', +'dependency_coordinate': 'dependencyCoordinate', +'digest': 'digest', +'extension_count': 'extensionCount', +'failure_message': 'failureMessage', +'identifier': 'identifier', +'install_complete': 'installComplete', +'source_identifier': 'sourceIdentifier', +'source_type': 'sourceType', +'state': 'state' } + + def __init__(self, build_time=None, coordinate=None, created_by=None, dependency_coordinate=None, digest=None, extension_count=None, failure_message=None, identifier=None, install_complete=None, source_identifier=None, source_type=None, state=None): + """ + NarSummaryDTO - a model defined in Swagger + """ + + self._build_time = None + self._coordinate = None + self._created_by = None + self._dependency_coordinate = None + self._digest = None + self._extension_count = None + self._failure_message = None + self._identifier = None + self._install_complete = None + self._source_identifier = None + self._source_type = None + self._state = None + + if build_time is not None: + self.build_time = build_time + if coordinate is not None: + self.coordinate = coordinate + if created_by is not None: + self.created_by = created_by + if dependency_coordinate is not None: + self.dependency_coordinate = dependency_coordinate + if digest is not None: + self.digest = digest + if extension_count is not None: + self.extension_count = extension_count + if failure_message is not None: + self.failure_message = failure_message + if identifier is not None: + self.identifier = identifier + if install_complete is not None: + self.install_complete = install_complete + if source_identifier is not None: + self.source_identifier = source_identifier + if source_type is not None: + self.source_type = source_type + if state is not None: + self.state = state + + @property + def build_time(self): + """ + Gets the build_time of this NarSummaryDTO. + The time the NAR was built according to it's MANIFEST + + :return: The build_time of this NarSummaryDTO. + :rtype: str + """ + return self._build_time + + @build_time.setter + def build_time(self, build_time): + """ + Sets the build_time of this NarSummaryDTO. + The time the NAR was built according to it's MANIFEST + + :param build_time: The build_time of this NarSummaryDTO. + :type: str + """ + + self._build_time = build_time + + @property + def coordinate(self): + """ + Gets the coordinate of this NarSummaryDTO. + + :return: The coordinate of this NarSummaryDTO. + :rtype: NarCoordinateDTO + """ + return self._coordinate + + @coordinate.setter + def coordinate(self, coordinate): + """ + Sets the coordinate of this NarSummaryDTO. + + :param coordinate: The coordinate of this NarSummaryDTO. + :type: NarCoordinateDTO + """ + + self._coordinate = coordinate + + @property + def created_by(self): + """ + Gets the created_by of this NarSummaryDTO. + The plugin that created the NAR according to it's MANIFEST + + :return: The created_by of this NarSummaryDTO. + :rtype: str + """ + return self._created_by + + @created_by.setter + def created_by(self, created_by): + """ + Sets the created_by of this NarSummaryDTO. + The plugin that created the NAR according to it's MANIFEST + + :param created_by: The created_by of this NarSummaryDTO. + :type: str + """ + + self._created_by = created_by + + @property + def dependency_coordinate(self): + """ + Gets the dependency_coordinate of this NarSummaryDTO. + + :return: The dependency_coordinate of this NarSummaryDTO. + :rtype: NarCoordinateDTO + """ + return self._dependency_coordinate + + @dependency_coordinate.setter + def dependency_coordinate(self, dependency_coordinate): + """ + Sets the dependency_coordinate of this NarSummaryDTO. + + :param dependency_coordinate: The dependency_coordinate of this NarSummaryDTO. + :type: NarCoordinateDTO + """ + + self._dependency_coordinate = dependency_coordinate + + @property + def digest(self): + """ + Gets the digest of this NarSummaryDTO. + The hex digest of the NAR contents + + :return: The digest of this NarSummaryDTO. + :rtype: str + """ + return self._digest + + @digest.setter + def digest(self, digest): + """ + Sets the digest of this NarSummaryDTO. + The hex digest of the NAR contents + + :param digest: The digest of this NarSummaryDTO. + :type: str + """ + + self._digest = digest + + @property + def extension_count(self): + """ + Gets the extension_count of this NarSummaryDTO. + The number of extensions contained in this NAR + + :return: The extension_count of this NarSummaryDTO. + :rtype: int + """ + return self._extension_count + + @extension_count.setter + def extension_count(self, extension_count): + """ + Sets the extension_count of this NarSummaryDTO. + The number of extensions contained in this NAR + + :param extension_count: The extension_count of this NarSummaryDTO. + :type: int + """ + + self._extension_count = extension_count + + @property + def failure_message(self): + """ + Gets the failure_message of this NarSummaryDTO. + Information about why the installation failed, only populated when the state is failed + + :return: The failure_message of this NarSummaryDTO. + :rtype: str + """ + return self._failure_message + + @failure_message.setter + def failure_message(self, failure_message): + """ + Sets the failure_message of this NarSummaryDTO. + Information about why the installation failed, only populated when the state is failed + + :param failure_message: The failure_message of this NarSummaryDTO. + :type: str + """ + + self._failure_message = failure_message + + @property + def identifier(self): + """ + Gets the identifier of this NarSummaryDTO. + The identifier of the NAR. + + :return: The identifier of this NarSummaryDTO. + :rtype: str + """ + return self._identifier + + @identifier.setter + def identifier(self, identifier): + """ + Sets the identifier of this NarSummaryDTO. + The identifier of the NAR. + + :param identifier: The identifier of this NarSummaryDTO. + :type: str + """ + + self._identifier = identifier + + @property + def install_complete(self): + """ + Gets the install_complete of this NarSummaryDTO. + Indicates if the install task has completed + + :return: The install_complete of this NarSummaryDTO. + :rtype: bool + """ + return self._install_complete + + @install_complete.setter + def install_complete(self, install_complete): + """ + Sets the install_complete of this NarSummaryDTO. + Indicates if the install task has completed + + :param install_complete: The install_complete of this NarSummaryDTO. + :type: bool + """ + + self._install_complete = install_complete + + @property + def source_identifier(self): + """ + Gets the source_identifier of this NarSummaryDTO. + The identifier of the source of this NAR + + :return: The source_identifier of this NarSummaryDTO. + :rtype: str + """ + return self._source_identifier + + @source_identifier.setter + def source_identifier(self, source_identifier): + """ + Sets the source_identifier of this NarSummaryDTO. + The identifier of the source of this NAR + + :param source_identifier: The source_identifier of this NarSummaryDTO. + :type: str + """ + + self._source_identifier = source_identifier + + @property + def source_type(self): + """ + Gets the source_type of this NarSummaryDTO. + The source of this NAR + + :return: The source_type of this NarSummaryDTO. + :rtype: str + """ + return self._source_type + + @source_type.setter + def source_type(self, source_type): + """ + Sets the source_type of this NarSummaryDTO. + The source of this NAR + + :param source_type: The source_type of this NarSummaryDTO. + :type: str + """ + + self._source_type = source_type + + @property + def state(self): + """ + Gets the state of this NarSummaryDTO. + The state of the NAR (i.e. Installed, or not) + + :return: The state of this NarSummaryDTO. + :rtype: str + """ + return self._state + + @state.setter + def state(self, state): + """ + Sets the state of this NarSummaryDTO. + The state of the NAR (i.e. Installed, or not) + + :param state: The state of this NarSummaryDTO. + :type: str + """ + + self._state = state + + 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, NarSummaryDTO): + 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/nar_summary_entity.py b/nipyapi/nifi/models/nar_summary_entity.py new file mode 100644 index 00000000..612921b2 --- /dev/null +++ b/nipyapi/nifi/models/nar_summary_entity.py @@ -0,0 +1,117 @@ +""" + Apache NiFi REST API + + REST API definition for Apache NiFi web services + + OpenAPI spec version: 2.5.0 + Contact: dev@nifi.apache.org + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from pprint import pformat +import re + + +class NarSummaryEntity(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 = { + 'nar_summary': 'NarSummaryDTO' } + + attribute_map = { + 'nar_summary': 'narSummary' } + + def __init__(self, nar_summary=None): + """ + NarSummaryEntity - a model defined in Swagger + """ + + self._nar_summary = None + + if nar_summary is not None: + self.nar_summary = nar_summary + + @property + def nar_summary(self): + """ + Gets the nar_summary of this NarSummaryEntity. + + :return: The nar_summary of this NarSummaryEntity. + :rtype: NarSummaryDTO + """ + return self._nar_summary + + @nar_summary.setter + def nar_summary(self, nar_summary): + """ + Sets the nar_summary of this NarSummaryEntity. + + :param nar_summary: The nar_summary of this NarSummaryEntity. + :type: NarSummaryDTO + """ + + self._nar_summary = nar_summary + + 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, NarSummaryEntity): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """ + Returns true if both objects are not equal + """ + return not self == other diff --git a/nipyapi/nifi/models/node_connection_statistics_snapshot_dto.py b/nipyapi/nifi/models/node_connection_statistics_snapshot_dto.py index 5a942d99..9d1521f5 100644 --- a/nipyapi/nifi/models/node_connection_statistics_snapshot_dto.py +++ b/nipyapi/nifi/models/node_connection_statistics_snapshot_dto.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,61 +27,36 @@ class NodeConnectionStatisticsSnapshotDTO(object): and the value is json key in definition. """ swagger_types = { - 'node_id': 'str', 'address': 'str', - 'api_port': 'int', - 'statistics_snapshot': 'ConnectionStatisticsSnapshotDTO' - } +'api_port': 'int', +'node_id': 'str', +'statistics_snapshot': 'ConnectionStatisticsSnapshotDTO' } attribute_map = { - 'node_id': 'nodeId', 'address': 'address', - 'api_port': 'apiPort', - 'statistics_snapshot': 'statisticsSnapshot' - } +'api_port': 'apiPort', +'node_id': 'nodeId', +'statistics_snapshot': 'statisticsSnapshot' } - def __init__(self, node_id=None, address=None, api_port=None, statistics_snapshot=None): + def __init__(self, address=None, api_port=None, node_id=None, statistics_snapshot=None): """ NodeConnectionStatisticsSnapshotDTO - a model defined in Swagger """ - self._node_id = None self._address = None self._api_port = None + self._node_id = None self._statistics_snapshot = None - if node_id is not None: - self.node_id = node_id if address is not None: self.address = address if api_port is not None: self.api_port = api_port + if node_id is not None: + self.node_id = node_id if statistics_snapshot is not None: self.statistics_snapshot = statistics_snapshot - @property - def node_id(self): - """ - Gets the node_id of this NodeConnectionStatisticsSnapshotDTO. - The unique ID that identifies the node - - :return: The node_id of this NodeConnectionStatisticsSnapshotDTO. - :rtype: str - """ - return self._node_id - - @node_id.setter - def node_id(self, node_id): - """ - Sets the node_id of this NodeConnectionStatisticsSnapshotDTO. - The unique ID that identifies the node - - :param node_id: The node_id of this NodeConnectionStatisticsSnapshotDTO. - :type: str - """ - - self._node_id = node_id - @property def address(self): """ @@ -129,11 +103,33 @@ def api_port(self, api_port): self._api_port = api_port + @property + def node_id(self): + """ + Gets the node_id of this NodeConnectionStatisticsSnapshotDTO. + The unique ID that identifies the node + + :return: The node_id of this NodeConnectionStatisticsSnapshotDTO. + :rtype: str + """ + return self._node_id + + @node_id.setter + def node_id(self, node_id): + """ + Sets the node_id of this NodeConnectionStatisticsSnapshotDTO. + The unique ID that identifies the node + + :param node_id: The node_id of this NodeConnectionStatisticsSnapshotDTO. + :type: str + """ + + self._node_id = node_id + @property def statistics_snapshot(self): """ Gets the statistics_snapshot of this NodeConnectionStatisticsSnapshotDTO. - The connection status snapshot from the node. :return: The statistics_snapshot of this NodeConnectionStatisticsSnapshotDTO. :rtype: ConnectionStatisticsSnapshotDTO @@ -144,7 +140,6 @@ def statistics_snapshot(self): def statistics_snapshot(self, statistics_snapshot): """ Sets the statistics_snapshot of this NodeConnectionStatisticsSnapshotDTO. - The connection status snapshot from the node. :param statistics_snapshot: The statistics_snapshot of this NodeConnectionStatisticsSnapshotDTO. :type: ConnectionStatisticsSnapshotDTO diff --git a/nipyapi/nifi/models/node_connection_status_snapshot_dto.py b/nipyapi/nifi/models/node_connection_status_snapshot_dto.py index f638a1b3..bb63e061 100644 --- a/nipyapi/nifi/models/node_connection_status_snapshot_dto.py +++ b/nipyapi/nifi/models/node_connection_status_snapshot_dto.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,61 +27,36 @@ class NodeConnectionStatusSnapshotDTO(object): and the value is json key in definition. """ swagger_types = { - 'node_id': 'str', 'address': 'str', - 'api_port': 'int', - 'status_snapshot': 'ConnectionStatusSnapshotDTO' - } +'api_port': 'int', +'node_id': 'str', +'status_snapshot': 'ConnectionStatusSnapshotDTO' } attribute_map = { - 'node_id': 'nodeId', 'address': 'address', - 'api_port': 'apiPort', - 'status_snapshot': 'statusSnapshot' - } +'api_port': 'apiPort', +'node_id': 'nodeId', +'status_snapshot': 'statusSnapshot' } - def __init__(self, node_id=None, address=None, api_port=None, status_snapshot=None): + def __init__(self, address=None, api_port=None, node_id=None, status_snapshot=None): """ NodeConnectionStatusSnapshotDTO - a model defined in Swagger """ - self._node_id = None self._address = None self._api_port = None + self._node_id = None self._status_snapshot = None - if node_id is not None: - self.node_id = node_id if address is not None: self.address = address if api_port is not None: self.api_port = api_port + if node_id is not None: + self.node_id = node_id if status_snapshot is not None: self.status_snapshot = status_snapshot - @property - def node_id(self): - """ - Gets the node_id of this NodeConnectionStatusSnapshotDTO. - The unique ID that identifies the node - - :return: The node_id of this NodeConnectionStatusSnapshotDTO. - :rtype: str - """ - return self._node_id - - @node_id.setter - def node_id(self, node_id): - """ - Sets the node_id of this NodeConnectionStatusSnapshotDTO. - The unique ID that identifies the node - - :param node_id: The node_id of this NodeConnectionStatusSnapshotDTO. - :type: str - """ - - self._node_id = node_id - @property def address(self): """ @@ -129,11 +103,33 @@ def api_port(self, api_port): self._api_port = api_port + @property + def node_id(self): + """ + Gets the node_id of this NodeConnectionStatusSnapshotDTO. + The unique ID that identifies the node + + :return: The node_id of this NodeConnectionStatusSnapshotDTO. + :rtype: str + """ + return self._node_id + + @node_id.setter + def node_id(self, node_id): + """ + Sets the node_id of this NodeConnectionStatusSnapshotDTO. + The unique ID that identifies the node + + :param node_id: The node_id of this NodeConnectionStatusSnapshotDTO. + :type: str + """ + + self._node_id = node_id + @property def status_snapshot(self): """ Gets the status_snapshot of this NodeConnectionStatusSnapshotDTO. - The connection status snapshot from the node. :return: The status_snapshot of this NodeConnectionStatusSnapshotDTO. :rtype: ConnectionStatusSnapshotDTO @@ -144,7 +140,6 @@ def status_snapshot(self): def status_snapshot(self, status_snapshot): """ Sets the status_snapshot of this NodeConnectionStatusSnapshotDTO. - The connection status snapshot from the node. :param status_snapshot: The status_snapshot of this NodeConnectionStatusSnapshotDTO. :type: ConnectionStatusSnapshotDTO diff --git a/nipyapi/nifi/models/node_counters_snapshot_dto.py b/nipyapi/nifi/models/node_counters_snapshot_dto.py index 8b4f04b7..150a745f 100644 --- a/nipyapi/nifi/models/node_counters_snapshot_dto.py +++ b/nipyapi/nifi/models/node_counters_snapshot_dto.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,61 +27,36 @@ class NodeCountersSnapshotDTO(object): and the value is json key in definition. """ swagger_types = { - 'node_id': 'str', 'address': 'str', - 'api_port': 'int', - 'snapshot': 'CountersSnapshotDTO' - } +'api_port': 'int', +'node_id': 'str', +'snapshot': 'CountersSnapshotDTO' } attribute_map = { - 'node_id': 'nodeId', 'address': 'address', - 'api_port': 'apiPort', - 'snapshot': 'snapshot' - } +'api_port': 'apiPort', +'node_id': 'nodeId', +'snapshot': 'snapshot' } - def __init__(self, node_id=None, address=None, api_port=None, snapshot=None): + def __init__(self, address=None, api_port=None, node_id=None, snapshot=None): """ NodeCountersSnapshotDTO - a model defined in Swagger """ - self._node_id = None self._address = None self._api_port = None + self._node_id = None self._snapshot = None - if node_id is not None: - self.node_id = node_id if address is not None: self.address = address if api_port is not None: self.api_port = api_port + if node_id is not None: + self.node_id = node_id if snapshot is not None: self.snapshot = snapshot - @property - def node_id(self): - """ - Gets the node_id of this NodeCountersSnapshotDTO. - The unique ID that identifies the node - - :return: The node_id of this NodeCountersSnapshotDTO. - :rtype: str - """ - return self._node_id - - @node_id.setter - def node_id(self, node_id): - """ - Sets the node_id of this NodeCountersSnapshotDTO. - The unique ID that identifies the node - - :param node_id: The node_id of this NodeCountersSnapshotDTO. - :type: str - """ - - self._node_id = node_id - @property def address(self): """ @@ -129,11 +103,33 @@ def api_port(self, api_port): self._api_port = api_port + @property + def node_id(self): + """ + Gets the node_id of this NodeCountersSnapshotDTO. + The unique ID that identifies the node + + :return: The node_id of this NodeCountersSnapshotDTO. + :rtype: str + """ + return self._node_id + + @node_id.setter + def node_id(self, node_id): + """ + Sets the node_id of this NodeCountersSnapshotDTO. + The unique ID that identifies the node + + :param node_id: The node_id of this NodeCountersSnapshotDTO. + :type: str + """ + + self._node_id = node_id + @property def snapshot(self): """ Gets the snapshot of this NodeCountersSnapshotDTO. - The counters from the node. :return: The snapshot of this NodeCountersSnapshotDTO. :rtype: CountersSnapshotDTO @@ -144,7 +140,6 @@ def snapshot(self): def snapshot(self, snapshot): """ Sets the snapshot of this NodeCountersSnapshotDTO. - The counters from the node. :param snapshot: The snapshot of this NodeCountersSnapshotDTO. :type: CountersSnapshotDTO diff --git a/nipyapi/nifi/models/node_dto.py b/nipyapi/nifi/models/node_dto.py index 451313fb..7ea6160e 100644 --- a/nipyapi/nifi/models/node_dto.py +++ b/nipyapi/nifi/models/node_dto.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,95 +27,108 @@ class NodeDTO(object): and the value is json key in definition. """ swagger_types = { - 'node_id': 'str', - 'address': 'str', - 'api_port': 'int', - 'status': 'str', - 'heartbeat': 'str', - 'connection_requested': 'str', - 'roles': 'list[str]', 'active_thread_count': 'int', - 'queued': 'str', - 'events': 'list[NodeEventDTO]', - 'node_start_time': 'str' - } +'address': 'str', +'api_port': 'int', +'bytes_queued': 'int', +'connection_requested': 'str', +'events': 'list[NodeEventDTO]', +'flow_file_bytes': 'int', +'flow_files_queued': 'int', +'heartbeat': 'str', +'node_id': 'str', +'node_start_time': 'str', +'queued': 'str', +'roles': 'list[str]', +'status': 'str' } attribute_map = { - 'node_id': 'nodeId', - 'address': 'address', - 'api_port': 'apiPort', - 'status': 'status', - 'heartbeat': 'heartbeat', - 'connection_requested': 'connectionRequested', - 'roles': 'roles', 'active_thread_count': 'activeThreadCount', - 'queued': 'queued', - 'events': 'events', - 'node_start_time': 'nodeStartTime' - } - - def __init__(self, node_id=None, address=None, api_port=None, status=None, heartbeat=None, connection_requested=None, roles=None, active_thread_count=None, queued=None, events=None, node_start_time=None): +'address': 'address', +'api_port': 'apiPort', +'bytes_queued': 'bytesQueued', +'connection_requested': 'connectionRequested', +'events': 'events', +'flow_file_bytes': 'flowFileBytes', +'flow_files_queued': 'flowFilesQueued', +'heartbeat': 'heartbeat', +'node_id': 'nodeId', +'node_start_time': 'nodeStartTime', +'queued': 'queued', +'roles': 'roles', +'status': 'status' } + + def __init__(self, active_thread_count=None, address=None, api_port=None, bytes_queued=None, connection_requested=None, events=None, flow_file_bytes=None, flow_files_queued=None, heartbeat=None, node_id=None, node_start_time=None, queued=None, roles=None, status=None): """ NodeDTO - a model defined in Swagger """ - self._node_id = None + self._active_thread_count = None self._address = None self._api_port = None - self._status = None - self._heartbeat = None + self._bytes_queued = None self._connection_requested = None - self._roles = None - self._active_thread_count = None - self._queued = None self._events = None + self._flow_file_bytes = None + self._flow_files_queued = None + self._heartbeat = None + self._node_id = None self._node_start_time = None + self._queued = None + self._roles = None + self._status = None - if node_id is not None: - self.node_id = node_id + if active_thread_count is not None: + self.active_thread_count = active_thread_count if address is not None: self.address = address if api_port is not None: self.api_port = api_port - if status is not None: - self.status = status - if heartbeat is not None: - self.heartbeat = heartbeat + if bytes_queued is not None: + self.bytes_queued = bytes_queued if connection_requested is not None: self.connection_requested = connection_requested - if roles is not None: - self.roles = roles - if active_thread_count is not None: - self.active_thread_count = active_thread_count - if queued is not None: - self.queued = queued if events is not None: self.events = events + if flow_file_bytes is not None: + self.flow_file_bytes = flow_file_bytes + if flow_files_queued is not None: + self.flow_files_queued = flow_files_queued + if heartbeat is not None: + self.heartbeat = heartbeat + if node_id is not None: + self.node_id = node_id if node_start_time is not None: self.node_start_time = node_start_time + if queued is not None: + self.queued = queued + if roles is not None: + self.roles = roles + if status is not None: + self.status = status @property - def node_id(self): + def active_thread_count(self): """ - Gets the node_id of this NodeDTO. - The id of the node. + Gets the active_thread_count of this NodeDTO. + The active threads for the NiFi on the node. - :return: The node_id of this NodeDTO. - :rtype: str + :return: The active_thread_count of this NodeDTO. + :rtype: int """ - return self._node_id + return self._active_thread_count - @node_id.setter - def node_id(self, node_id): + @active_thread_count.setter + def active_thread_count(self, active_thread_count): """ - Sets the node_id of this NodeDTO. - The id of the node. + Sets the active_thread_count of this NodeDTO. + The active threads for the NiFi on the node. - :param node_id: The node_id of this NodeDTO. - :type: str + :param active_thread_count: The active_thread_count of this NodeDTO. + :type: int """ - self._node_id = node_id + self._active_thread_count = active_thread_count @property def address(self): @@ -165,27 +177,117 @@ def api_port(self, api_port): self._api_port = api_port @property - def status(self): + def bytes_queued(self): """ - Gets the status of this NodeDTO. - The node's status. + Gets the bytes_queued of this NodeDTO. + The total size of all FlowFiles that are queued up on the node - :return: The status of this NodeDTO. + :return: The bytes_queued of this NodeDTO. + :rtype: int + """ + return self._bytes_queued + + @bytes_queued.setter + def bytes_queued(self, bytes_queued): + """ + Sets the bytes_queued of this NodeDTO. + The total size of all FlowFiles that are queued up on the node + + :param bytes_queued: The bytes_queued of this NodeDTO. + :type: int + """ + + self._bytes_queued = bytes_queued + + @property + def connection_requested(self): + """ + Gets the connection_requested of this NodeDTO. + The time of the node's last connection request. + + :return: The connection_requested of this NodeDTO. :rtype: str """ - return self._status + return self._connection_requested - @status.setter - def status(self, status): + @connection_requested.setter + def connection_requested(self, connection_requested): """ - Sets the status of this NodeDTO. - The node's status. + Sets the connection_requested of this NodeDTO. + The time of the node's last connection request. - :param status: The status of this NodeDTO. + :param connection_requested: The connection_requested of this NodeDTO. :type: str """ - self._status = status + self._connection_requested = connection_requested + + @property + def events(self): + """ + Gets the events of this NodeDTO. + The node's events. + + :return: The events of this NodeDTO. + :rtype: list[NodeEventDTO] + """ + return self._events + + @events.setter + def events(self, events): + """ + Sets the events of this NodeDTO. + The node's events. + + :param events: The events of this NodeDTO. + :type: list[NodeEventDTO] + """ + + self._events = events + + @property + def flow_file_bytes(self): + """ + Gets the flow_file_bytes of this NodeDTO. + + :return: The flow_file_bytes of this NodeDTO. + :rtype: int + """ + return self._flow_file_bytes + + @flow_file_bytes.setter + def flow_file_bytes(self, flow_file_bytes): + """ + Sets the flow_file_bytes of this NodeDTO. + + :param flow_file_bytes: The flow_file_bytes of this NodeDTO. + :type: int + """ + + self._flow_file_bytes = flow_file_bytes + + @property + def flow_files_queued(self): + """ + Gets the flow_files_queued of this NodeDTO. + The number of FlowFiles that are queued up on the node + + :return: The flow_files_queued of this NodeDTO. + :rtype: int + """ + return self._flow_files_queued + + @flow_files_queued.setter + def flow_files_queued(self, flow_files_queued): + """ + Sets the flow_files_queued of this NodeDTO. + The number of FlowFiles that are queued up on the node + + :param flow_files_queued: The flow_files_queued of this NodeDTO. + :type: int + """ + + self._flow_files_queued = flow_files_queued @property def heartbeat(self): @@ -211,73 +313,50 @@ def heartbeat(self, heartbeat): self._heartbeat = heartbeat @property - def connection_requested(self): + def node_id(self): """ - Gets the connection_requested of this NodeDTO. - The time of the node's last connection request. + Gets the node_id of this NodeDTO. + The id of the node. - :return: The connection_requested of this NodeDTO. + :return: The node_id of this NodeDTO. :rtype: str """ - return self._connection_requested + return self._node_id - @connection_requested.setter - def connection_requested(self, connection_requested): + @node_id.setter + def node_id(self, node_id): """ - Sets the connection_requested of this NodeDTO. - The time of the node's last connection request. + Sets the node_id of this NodeDTO. + The id of the node. - :param connection_requested: The connection_requested of this NodeDTO. + :param node_id: The node_id of this NodeDTO. :type: str """ - self._connection_requested = connection_requested - - @property - def roles(self): - """ - Gets the roles of this NodeDTO. - The roles of this node. - - :return: The roles of this NodeDTO. - :rtype: list[str] - """ - return self._roles - - @roles.setter - def roles(self, roles): - """ - Sets the roles of this NodeDTO. - The roles of this node. - - :param roles: The roles of this NodeDTO. - :type: list[str] - """ - - self._roles = roles + self._node_id = node_id @property - def active_thread_count(self): + def node_start_time(self): """ - Gets the active_thread_count of this NodeDTO. - The active threads for the NiFi on the node. + Gets the node_start_time of this NodeDTO. + The time at which this Node was last refreshed. - :return: The active_thread_count of this NodeDTO. - :rtype: int + :return: The node_start_time of this NodeDTO. + :rtype: str """ - return self._active_thread_count + return self._node_start_time - @active_thread_count.setter - def active_thread_count(self, active_thread_count): + @node_start_time.setter + def node_start_time(self, node_start_time): """ - Sets the active_thread_count of this NodeDTO. - The active threads for the NiFi on the node. + Sets the node_start_time of this NodeDTO. + The time at which this Node was last refreshed. - :param active_thread_count: The active_thread_count of this NodeDTO. - :type: int + :param node_start_time: The node_start_time of this NodeDTO. + :type: str """ - self._active_thread_count = active_thread_count + self._node_start_time = node_start_time @property def queued(self): @@ -303,50 +382,50 @@ def queued(self, queued): self._queued = queued @property - def events(self): + def roles(self): """ - Gets the events of this NodeDTO. - The node's events. + Gets the roles of this NodeDTO. + The roles of this node. - :return: The events of this NodeDTO. - :rtype: list[NodeEventDTO] + :return: The roles of this NodeDTO. + :rtype: list[str] """ - return self._events + return self._roles - @events.setter - def events(self, events): + @roles.setter + def roles(self, roles): """ - Sets the events of this NodeDTO. - The node's events. + Sets the roles of this NodeDTO. + The roles of this node. - :param events: The events of this NodeDTO. - :type: list[NodeEventDTO] + :param roles: The roles of this NodeDTO. + :type: list[str] """ - self._events = events + self._roles = roles @property - def node_start_time(self): + def status(self): """ - Gets the node_start_time of this NodeDTO. - The time at which this Node was last refreshed. + Gets the status of this NodeDTO. + The node's status. - :return: The node_start_time of this NodeDTO. + :return: The status of this NodeDTO. :rtype: str """ - return self._node_start_time + return self._status - @node_start_time.setter - def node_start_time(self, node_start_time): + @status.setter + def status(self, status): """ - Sets the node_start_time of this NodeDTO. - The time at which this Node was last refreshed. + Sets the status of this NodeDTO. + The node's status. - :param node_start_time: The node_start_time of this NodeDTO. + :param status: The status of this NodeDTO. :type: str """ - self._node_start_time = node_start_time + self._status = status def to_dict(self): """ diff --git a/nipyapi/nifi/models/node_entity.py b/nipyapi/nifi/models/node_entity.py index 425f753c..2a8f4c33 100644 --- a/nipyapi/nifi/models/node_entity.py +++ b/nipyapi/nifi/models/node_entity.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,12 +27,10 @@ class NodeEntity(object): and the value is json key in definition. """ swagger_types = { - 'node': 'NodeDTO' - } + 'node': 'NodeDTO' } attribute_map = { - 'node': 'node' - } + 'node': 'node' } def __init__(self, node=None): """ diff --git a/nipyapi/nifi/models/node_event_dto.py b/nipyapi/nifi/models/node_event_dto.py index 9ee69a93..84f02c72 100644 --- a/nipyapi/nifi/models/node_event_dto.py +++ b/nipyapi/nifi/models/node_event_dto.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,55 +27,30 @@ class NodeEventDTO(object): and the value is json key in definition. """ swagger_types = { - 'timestamp': 'str', 'category': 'str', - 'message': 'str' - } +'message': 'str', +'timestamp': 'str' } attribute_map = { - 'timestamp': 'timestamp', 'category': 'category', - 'message': 'message' - } +'message': 'message', +'timestamp': 'timestamp' } - def __init__(self, timestamp=None, category=None, message=None): + def __init__(self, category=None, message=None, timestamp=None): """ NodeEventDTO - a model defined in Swagger """ - self._timestamp = None self._category = None self._message = None + self._timestamp = None - if timestamp is not None: - self.timestamp = timestamp if category is not None: self.category = category if message is not None: self.message = message - - @property - def timestamp(self): - """ - Gets the timestamp of this NodeEventDTO. - The timestamp of the node event. - - :return: The timestamp of this NodeEventDTO. - :rtype: str - """ - return self._timestamp - - @timestamp.setter - def timestamp(self, timestamp): - """ - Sets the timestamp of this NodeEventDTO. - The timestamp of the node event. - - :param timestamp: The timestamp of this NodeEventDTO. - :type: str - """ - - self._timestamp = timestamp + if timestamp is not None: + self.timestamp = timestamp @property def category(self): @@ -124,6 +98,29 @@ def message(self, message): self._message = message + @property + def timestamp(self): + """ + Gets the timestamp of this NodeEventDTO. + The timestamp of the node event. + + :return: The timestamp of this NodeEventDTO. + :rtype: str + """ + return self._timestamp + + @timestamp.setter + def timestamp(self, timestamp): + """ + Sets the timestamp of this NodeEventDTO. + The timestamp of the node event. + + :param timestamp: The timestamp of this NodeEventDTO. + :type: str + """ + + self._timestamp = timestamp + def to_dict(self): """ Returns the model properties as a dict diff --git a/nipyapi/nifi/models/node_identifier.py b/nipyapi/nifi/models/node_identifier.py deleted file mode 100644 index e2d11c09..00000000 --- a/nipyapi/nifi/models/node_identifier.py +++ /dev/null @@ -1,432 +0,0 @@ -""" - NiFi Rest API - - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - - OpenAPI spec version: 1.28.1 - Contact: dev@nifi.apache.org - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - - -from pprint import pformat -import re - - -class NodeIdentifier(object): - """ - NOTE: This class is auto generated by the swagger code generator program. - Do not edit the class manually. - """ - - - """ - Attributes: - swagger_types (dict): The key is attribute name - and the value is attribute type. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - """ - swagger_types = { - 'id': 'str', - 'api_address': 'str', - 'api_port': 'int', - 'socket_address': 'str', - 'socket_port': 'int', - 'load_balance_address': 'str', - 'load_balance_port': 'int', - 'site_to_site_address': 'str', - 'site_to_site_port': 'int', - 'site_to_site_http_api_port': 'int', - 'site_to_site_secure': 'bool', - 'node_identities': 'list[str]', - 'full_description': 'str' - } - - attribute_map = { - 'id': 'id', - 'api_address': 'apiAddress', - 'api_port': 'apiPort', - 'socket_address': 'socketAddress', - 'socket_port': 'socketPort', - 'load_balance_address': 'loadBalanceAddress', - 'load_balance_port': 'loadBalancePort', - 'site_to_site_address': 'siteToSiteAddress', - 'site_to_site_port': 'siteToSitePort', - 'site_to_site_http_api_port': 'siteToSiteHttpApiPort', - 'site_to_site_secure': 'siteToSiteSecure', - 'node_identities': 'nodeIdentities', - 'full_description': 'fullDescription' - } - - def __init__(self, id=None, api_address=None, api_port=None, socket_address=None, socket_port=None, load_balance_address=None, load_balance_port=None, site_to_site_address=None, site_to_site_port=None, site_to_site_http_api_port=None, site_to_site_secure=None, node_identities=None, full_description=None): - """ - NodeIdentifier - a model defined in Swagger - """ - - self._id = None - self._api_address = None - self._api_port = None - self._socket_address = None - self._socket_port = None - self._load_balance_address = None - self._load_balance_port = None - self._site_to_site_address = None - self._site_to_site_port = None - self._site_to_site_http_api_port = None - self._site_to_site_secure = None - self._node_identities = None - self._full_description = None - - if id is not None: - self.id = id - if api_address is not None: - self.api_address = api_address - if api_port is not None: - self.api_port = api_port - if socket_address is not None: - self.socket_address = socket_address - if socket_port is not None: - self.socket_port = socket_port - if load_balance_address is not None: - self.load_balance_address = load_balance_address - if load_balance_port is not None: - self.load_balance_port = load_balance_port - if site_to_site_address is not None: - self.site_to_site_address = site_to_site_address - if site_to_site_port is not None: - self.site_to_site_port = site_to_site_port - if site_to_site_http_api_port is not None: - self.site_to_site_http_api_port = site_to_site_http_api_port - if site_to_site_secure is not None: - self.site_to_site_secure = site_to_site_secure - if node_identities is not None: - self.node_identities = node_identities - if full_description is not None: - self.full_description = full_description - - @property - def id(self): - """ - Gets the id of this NodeIdentifier. - - :return: The id of this NodeIdentifier. - :rtype: str - """ - return self._id - - @id.setter - def id(self, id): - """ - Sets the id of this NodeIdentifier. - - :param id: The id of this NodeIdentifier. - :type: str - """ - - self._id = id - - @property - def api_address(self): - """ - Gets the api_address of this NodeIdentifier. - - :return: The api_address of this NodeIdentifier. - :rtype: str - """ - return self._api_address - - @api_address.setter - def api_address(self, api_address): - """ - Sets the api_address of this NodeIdentifier. - - :param api_address: The api_address of this NodeIdentifier. - :type: str - """ - - self._api_address = api_address - - @property - def api_port(self): - """ - Gets the api_port of this NodeIdentifier. - - :return: The api_port of this NodeIdentifier. - :rtype: int - """ - return self._api_port - - @api_port.setter - def api_port(self, api_port): - """ - Sets the api_port of this NodeIdentifier. - - :param api_port: The api_port of this NodeIdentifier. - :type: int - """ - - self._api_port = api_port - - @property - def socket_address(self): - """ - Gets the socket_address of this NodeIdentifier. - - :return: The socket_address of this NodeIdentifier. - :rtype: str - """ - return self._socket_address - - @socket_address.setter - def socket_address(self, socket_address): - """ - Sets the socket_address of this NodeIdentifier. - - :param socket_address: The socket_address of this NodeIdentifier. - :type: str - """ - - self._socket_address = socket_address - - @property - def socket_port(self): - """ - Gets the socket_port of this NodeIdentifier. - - :return: The socket_port of this NodeIdentifier. - :rtype: int - """ - return self._socket_port - - @socket_port.setter - def socket_port(self, socket_port): - """ - Sets the socket_port of this NodeIdentifier. - - :param socket_port: The socket_port of this NodeIdentifier. - :type: int - """ - - self._socket_port = socket_port - - @property - def load_balance_address(self): - """ - Gets the load_balance_address of this NodeIdentifier. - - :return: The load_balance_address of this NodeIdentifier. - :rtype: str - """ - return self._load_balance_address - - @load_balance_address.setter - def load_balance_address(self, load_balance_address): - """ - Sets the load_balance_address of this NodeIdentifier. - - :param load_balance_address: The load_balance_address of this NodeIdentifier. - :type: str - """ - - self._load_balance_address = load_balance_address - - @property - def load_balance_port(self): - """ - Gets the load_balance_port of this NodeIdentifier. - - :return: The load_balance_port of this NodeIdentifier. - :rtype: int - """ - return self._load_balance_port - - @load_balance_port.setter - def load_balance_port(self, load_balance_port): - """ - Sets the load_balance_port of this NodeIdentifier. - - :param load_balance_port: The load_balance_port of this NodeIdentifier. - :type: int - """ - - self._load_balance_port = load_balance_port - - @property - def site_to_site_address(self): - """ - Gets the site_to_site_address of this NodeIdentifier. - - :return: The site_to_site_address of this NodeIdentifier. - :rtype: str - """ - return self._site_to_site_address - - @site_to_site_address.setter - def site_to_site_address(self, site_to_site_address): - """ - Sets the site_to_site_address of this NodeIdentifier. - - :param site_to_site_address: The site_to_site_address of this NodeIdentifier. - :type: str - """ - - self._site_to_site_address = site_to_site_address - - @property - def site_to_site_port(self): - """ - Gets the site_to_site_port of this NodeIdentifier. - - :return: The site_to_site_port of this NodeIdentifier. - :rtype: int - """ - return self._site_to_site_port - - @site_to_site_port.setter - def site_to_site_port(self, site_to_site_port): - """ - Sets the site_to_site_port of this NodeIdentifier. - - :param site_to_site_port: The site_to_site_port of this NodeIdentifier. - :type: int - """ - - self._site_to_site_port = site_to_site_port - - @property - def site_to_site_http_api_port(self): - """ - Gets the site_to_site_http_api_port of this NodeIdentifier. - - :return: The site_to_site_http_api_port of this NodeIdentifier. - :rtype: int - """ - return self._site_to_site_http_api_port - - @site_to_site_http_api_port.setter - def site_to_site_http_api_port(self, site_to_site_http_api_port): - """ - Sets the site_to_site_http_api_port of this NodeIdentifier. - - :param site_to_site_http_api_port: The site_to_site_http_api_port of this NodeIdentifier. - :type: int - """ - - self._site_to_site_http_api_port = site_to_site_http_api_port - - @property - def site_to_site_secure(self): - """ - Gets the site_to_site_secure of this NodeIdentifier. - - :return: The site_to_site_secure of this NodeIdentifier. - :rtype: bool - """ - return self._site_to_site_secure - - @site_to_site_secure.setter - def site_to_site_secure(self, site_to_site_secure): - """ - Sets the site_to_site_secure of this NodeIdentifier. - - :param site_to_site_secure: The site_to_site_secure of this NodeIdentifier. - :type: bool - """ - - self._site_to_site_secure = site_to_site_secure - - @property - def node_identities(self): - """ - Gets the node_identities of this NodeIdentifier. - - :return: The node_identities of this NodeIdentifier. - :rtype: list[str] - """ - return self._node_identities - - @node_identities.setter - def node_identities(self, node_identities): - """ - Sets the node_identities of this NodeIdentifier. - - :param node_identities: The node_identities of this NodeIdentifier. - :type: list[str] - """ - - self._node_identities = node_identities - - @property - def full_description(self): - """ - Gets the full_description of this NodeIdentifier. - - :return: The full_description of this NodeIdentifier. - :rtype: str - """ - return self._full_description - - @full_description.setter - def full_description(self, full_description): - """ - Sets the full_description of this NodeIdentifier. - - :param full_description: The full_description of this NodeIdentifier. - :type: str - """ - - self._full_description = full_description - - 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, NodeIdentifier): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other): - """ - Returns true if both objects are not equal - """ - return not self == other diff --git a/nipyapi/nifi/models/node_jvm_diagnostics_snapshot_dto.py b/nipyapi/nifi/models/node_jvm_diagnostics_snapshot_dto.py deleted file mode 100644 index bf5291a4..00000000 --- a/nipyapi/nifi/models/node_jvm_diagnostics_snapshot_dto.py +++ /dev/null @@ -1,206 +0,0 @@ -""" - NiFi Rest API - - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - - OpenAPI spec version: 1.28.1 - Contact: dev@nifi.apache.org - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - - -from pprint import pformat -import re - - -class NodeJVMDiagnosticsSnapshotDTO(object): - """ - NOTE: This class is auto generated by the swagger code generator program. - Do not edit the class manually. - """ - - - """ - Attributes: - swagger_types (dict): The key is attribute name - and the value is attribute type. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - """ - swagger_types = { - 'node_id': 'str', - 'address': 'str', - 'api_port': 'int', - 'snapshot': 'JVMDiagnosticsSnapshotDTO' - } - - attribute_map = { - 'node_id': 'nodeId', - 'address': 'address', - 'api_port': 'apiPort', - 'snapshot': 'snapshot' - } - - def __init__(self, node_id=None, address=None, api_port=None, snapshot=None): - """ - NodeJVMDiagnosticsSnapshotDTO - a model defined in Swagger - """ - - self._node_id = None - self._address = None - self._api_port = None - self._snapshot = None - - if node_id is not None: - self.node_id = node_id - if address is not None: - self.address = address - if api_port is not None: - self.api_port = api_port - if snapshot is not None: - self.snapshot = snapshot - - @property - def node_id(self): - """ - Gets the node_id of this NodeJVMDiagnosticsSnapshotDTO. - The unique ID that identifies the node - - :return: The node_id of this NodeJVMDiagnosticsSnapshotDTO. - :rtype: str - """ - return self._node_id - - @node_id.setter - def node_id(self, node_id): - """ - Sets the node_id of this NodeJVMDiagnosticsSnapshotDTO. - The unique ID that identifies the node - - :param node_id: The node_id of this NodeJVMDiagnosticsSnapshotDTO. - :type: str - """ - - self._node_id = node_id - - @property - def address(self): - """ - Gets the address of this NodeJVMDiagnosticsSnapshotDTO. - The API address of the node - - :return: The address of this NodeJVMDiagnosticsSnapshotDTO. - :rtype: str - """ - return self._address - - @address.setter - def address(self, address): - """ - Sets the address of this NodeJVMDiagnosticsSnapshotDTO. - The API address of the node - - :param address: The address of this NodeJVMDiagnosticsSnapshotDTO. - :type: str - """ - - self._address = address - - @property - def api_port(self): - """ - Gets the api_port of this NodeJVMDiagnosticsSnapshotDTO. - The API port used to communicate with the node - - :return: The api_port of this NodeJVMDiagnosticsSnapshotDTO. - :rtype: int - """ - return self._api_port - - @api_port.setter - def api_port(self, api_port): - """ - Sets the api_port of this NodeJVMDiagnosticsSnapshotDTO. - The API port used to communicate with the node - - :param api_port: The api_port of this NodeJVMDiagnosticsSnapshotDTO. - :type: int - """ - - self._api_port = api_port - - @property - def snapshot(self): - """ - Gets the snapshot of this NodeJVMDiagnosticsSnapshotDTO. - The JVM Diagnostics Snapshot - - :return: The snapshot of this NodeJVMDiagnosticsSnapshotDTO. - :rtype: JVMDiagnosticsSnapshotDTO - """ - return self._snapshot - - @snapshot.setter - def snapshot(self, snapshot): - """ - Sets the snapshot of this NodeJVMDiagnosticsSnapshotDTO. - The JVM Diagnostics Snapshot - - :param snapshot: The snapshot of this NodeJVMDiagnosticsSnapshotDTO. - :type: JVMDiagnosticsSnapshotDTO - """ - - self._snapshot = snapshot - - 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, NodeJVMDiagnosticsSnapshotDTO): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other): - """ - Returns true if both objects are not equal - """ - return not self == other diff --git a/nipyapi/nifi/models/node_port_status_snapshot_dto.py b/nipyapi/nifi/models/node_port_status_snapshot_dto.py index b81a2ac5..f843af5d 100644 --- a/nipyapi/nifi/models/node_port_status_snapshot_dto.py +++ b/nipyapi/nifi/models/node_port_status_snapshot_dto.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,61 +27,36 @@ class NodePortStatusSnapshotDTO(object): and the value is json key in definition. """ swagger_types = { - 'node_id': 'str', 'address': 'str', - 'api_port': 'int', - 'status_snapshot': 'PortStatusSnapshotDTO' - } +'api_port': 'int', +'node_id': 'str', +'status_snapshot': 'PortStatusSnapshotDTO' } attribute_map = { - 'node_id': 'nodeId', 'address': 'address', - 'api_port': 'apiPort', - 'status_snapshot': 'statusSnapshot' - } +'api_port': 'apiPort', +'node_id': 'nodeId', +'status_snapshot': 'statusSnapshot' } - def __init__(self, node_id=None, address=None, api_port=None, status_snapshot=None): + def __init__(self, address=None, api_port=None, node_id=None, status_snapshot=None): """ NodePortStatusSnapshotDTO - a model defined in Swagger """ - self._node_id = None self._address = None self._api_port = None + self._node_id = None self._status_snapshot = None - if node_id is not None: - self.node_id = node_id if address is not None: self.address = address if api_port is not None: self.api_port = api_port + if node_id is not None: + self.node_id = node_id if status_snapshot is not None: self.status_snapshot = status_snapshot - @property - def node_id(self): - """ - Gets the node_id of this NodePortStatusSnapshotDTO. - The unique ID that identifies the node - - :return: The node_id of this NodePortStatusSnapshotDTO. - :rtype: str - """ - return self._node_id - - @node_id.setter - def node_id(self, node_id): - """ - Sets the node_id of this NodePortStatusSnapshotDTO. - The unique ID that identifies the node - - :param node_id: The node_id of this NodePortStatusSnapshotDTO. - :type: str - """ - - self._node_id = node_id - @property def address(self): """ @@ -129,11 +103,33 @@ def api_port(self, api_port): self._api_port = api_port + @property + def node_id(self): + """ + Gets the node_id of this NodePortStatusSnapshotDTO. + The unique ID that identifies the node + + :return: The node_id of this NodePortStatusSnapshotDTO. + :rtype: str + """ + return self._node_id + + @node_id.setter + def node_id(self, node_id): + """ + Sets the node_id of this NodePortStatusSnapshotDTO. + The unique ID that identifies the node + + :param node_id: The node_id of this NodePortStatusSnapshotDTO. + :type: str + """ + + self._node_id = node_id + @property def status_snapshot(self): """ Gets the status_snapshot of this NodePortStatusSnapshotDTO. - The port status snapshot from the node. :return: The status_snapshot of this NodePortStatusSnapshotDTO. :rtype: PortStatusSnapshotDTO @@ -144,7 +140,6 @@ def status_snapshot(self): def status_snapshot(self, status_snapshot): """ Sets the status_snapshot of this NodePortStatusSnapshotDTO. - The port status snapshot from the node. :param status_snapshot: The status_snapshot of this NodePortStatusSnapshotDTO. :type: PortStatusSnapshotDTO 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 896370c0..e23d251a 100644 --- a/nipyapi/nifi/models/node_process_group_status_snapshot_dto.py +++ b/nipyapi/nifi/models/node_process_group_status_snapshot_dto.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,61 +27,36 @@ class NodeProcessGroupStatusSnapshotDTO(object): and the value is json key in definition. """ swagger_types = { - 'node_id': 'str', 'address': 'str', - 'api_port': 'int', - 'status_snapshot': 'ProcessGroupStatusSnapshotDTO' - } +'api_port': 'int', +'node_id': 'str', +'status_snapshot': 'ProcessGroupStatusSnapshotDTO' } attribute_map = { - 'node_id': 'nodeId', 'address': 'address', - 'api_port': 'apiPort', - 'status_snapshot': 'statusSnapshot' - } +'api_port': 'apiPort', +'node_id': 'nodeId', +'status_snapshot': 'statusSnapshot' } - def __init__(self, node_id=None, address=None, api_port=None, status_snapshot=None): + def __init__(self, address=None, api_port=None, node_id=None, status_snapshot=None): """ NodeProcessGroupStatusSnapshotDTO - a model defined in Swagger """ - self._node_id = None self._address = None self._api_port = None + self._node_id = None self._status_snapshot = None - if node_id is not None: - self.node_id = node_id if address is not None: self.address = address if api_port is not None: self.api_port = api_port + if node_id is not None: + self.node_id = node_id if status_snapshot is not None: self.status_snapshot = status_snapshot - @property - def node_id(self): - """ - Gets the node_id of this NodeProcessGroupStatusSnapshotDTO. - The unique ID that identifies the node - - :return: The node_id of this NodeProcessGroupStatusSnapshotDTO. - :rtype: str - """ - return self._node_id - - @node_id.setter - def node_id(self, node_id): - """ - Sets the node_id of this NodeProcessGroupStatusSnapshotDTO. - The unique ID that identifies the node - - :param node_id: The node_id of this NodeProcessGroupStatusSnapshotDTO. - :type: str - """ - - self._node_id = node_id - @property def address(self): """ @@ -129,11 +103,33 @@ def api_port(self, api_port): self._api_port = api_port + @property + def node_id(self): + """ + Gets the node_id of this NodeProcessGroupStatusSnapshotDTO. + The unique ID that identifies the node + + :return: The node_id of this NodeProcessGroupStatusSnapshotDTO. + :rtype: str + """ + return self._node_id + + @node_id.setter + def node_id(self, node_id): + """ + Sets the node_id of this NodeProcessGroupStatusSnapshotDTO. + The unique ID that identifies the node + + :param node_id: The node_id of this NodeProcessGroupStatusSnapshotDTO. + :type: str + """ + + self._node_id = node_id + @property def status_snapshot(self): """ Gets the status_snapshot of this NodeProcessGroupStatusSnapshotDTO. - The process group status snapshot from the node. :return: The status_snapshot of this NodeProcessGroupStatusSnapshotDTO. :rtype: ProcessGroupStatusSnapshotDTO @@ -144,7 +140,6 @@ def status_snapshot(self): def status_snapshot(self, status_snapshot): """ Sets the status_snapshot of this NodeProcessGroupStatusSnapshotDTO. - The process group status snapshot from the node. :param status_snapshot: The status_snapshot of this NodeProcessGroupStatusSnapshotDTO. :type: ProcessGroupStatusSnapshotDTO diff --git a/nipyapi/nifi/models/node_processor_status_snapshot_dto.py b/nipyapi/nifi/models/node_processor_status_snapshot_dto.py index 0c63ea84..684e65ba 100644 --- a/nipyapi/nifi/models/node_processor_status_snapshot_dto.py +++ b/nipyapi/nifi/models/node_processor_status_snapshot_dto.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,61 +27,36 @@ class NodeProcessorStatusSnapshotDTO(object): and the value is json key in definition. """ swagger_types = { - 'node_id': 'str', 'address': 'str', - 'api_port': 'int', - 'status_snapshot': 'ProcessorStatusSnapshotDTO' - } +'api_port': 'int', +'node_id': 'str', +'status_snapshot': 'ProcessorStatusSnapshotDTO' } attribute_map = { - 'node_id': 'nodeId', 'address': 'address', - 'api_port': 'apiPort', - 'status_snapshot': 'statusSnapshot' - } +'api_port': 'apiPort', +'node_id': 'nodeId', +'status_snapshot': 'statusSnapshot' } - def __init__(self, node_id=None, address=None, api_port=None, status_snapshot=None): + def __init__(self, address=None, api_port=None, node_id=None, status_snapshot=None): """ NodeProcessorStatusSnapshotDTO - a model defined in Swagger """ - self._node_id = None self._address = None self._api_port = None + self._node_id = None self._status_snapshot = None - if node_id is not None: - self.node_id = node_id if address is not None: self.address = address if api_port is not None: self.api_port = api_port + if node_id is not None: + self.node_id = node_id if status_snapshot is not None: self.status_snapshot = status_snapshot - @property - def node_id(self): - """ - Gets the node_id of this NodeProcessorStatusSnapshotDTO. - The unique ID that identifies the node - - :return: The node_id of this NodeProcessorStatusSnapshotDTO. - :rtype: str - """ - return self._node_id - - @node_id.setter - def node_id(self, node_id): - """ - Sets the node_id of this NodeProcessorStatusSnapshotDTO. - The unique ID that identifies the node - - :param node_id: The node_id of this NodeProcessorStatusSnapshotDTO. - :type: str - """ - - self._node_id = node_id - @property def address(self): """ @@ -129,11 +103,33 @@ def api_port(self, api_port): self._api_port = api_port + @property + def node_id(self): + """ + Gets the node_id of this NodeProcessorStatusSnapshotDTO. + The unique ID that identifies the node + + :return: The node_id of this NodeProcessorStatusSnapshotDTO. + :rtype: str + """ + return self._node_id + + @node_id.setter + def node_id(self, node_id): + """ + Sets the node_id of this NodeProcessorStatusSnapshotDTO. + The unique ID that identifies the node + + :param node_id: The node_id of this NodeProcessorStatusSnapshotDTO. + :type: str + """ + + self._node_id = node_id + @property def status_snapshot(self): """ Gets the status_snapshot of this NodeProcessorStatusSnapshotDTO. - The processor status snapshot from the node. :return: The status_snapshot of this NodeProcessorStatusSnapshotDTO. :rtype: ProcessorStatusSnapshotDTO @@ -144,7 +140,6 @@ def status_snapshot(self): def status_snapshot(self, status_snapshot): """ Sets the status_snapshot of this NodeProcessorStatusSnapshotDTO. - The processor status snapshot from the node. :param status_snapshot: The status_snapshot of this NodeProcessorStatusSnapshotDTO. :type: ProcessorStatusSnapshotDTO 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 8ed21afc..5b9af872 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 @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,61 +27,36 @@ class NodeRemoteProcessGroupStatusSnapshotDTO(object): and the value is json key in definition. """ swagger_types = { - 'node_id': 'str', 'address': 'str', - 'api_port': 'int', - 'status_snapshot': 'RemoteProcessGroupStatusSnapshotDTO' - } +'api_port': 'int', +'node_id': 'str', +'status_snapshot': 'RemoteProcessGroupStatusSnapshotDTO' } attribute_map = { - 'node_id': 'nodeId', 'address': 'address', - 'api_port': 'apiPort', - 'status_snapshot': 'statusSnapshot' - } +'api_port': 'apiPort', +'node_id': 'nodeId', +'status_snapshot': 'statusSnapshot' } - def __init__(self, node_id=None, address=None, api_port=None, status_snapshot=None): + def __init__(self, address=None, api_port=None, node_id=None, status_snapshot=None): """ NodeRemoteProcessGroupStatusSnapshotDTO - a model defined in Swagger """ - self._node_id = None self._address = None self._api_port = None + self._node_id = None self._status_snapshot = None - if node_id is not None: - self.node_id = node_id if address is not None: self.address = address if api_port is not None: self.api_port = api_port + if node_id is not None: + self.node_id = node_id if status_snapshot is not None: self.status_snapshot = status_snapshot - @property - def node_id(self): - """ - Gets the node_id of this NodeRemoteProcessGroupStatusSnapshotDTO. - The unique ID that identifies the node - - :return: The node_id of this NodeRemoteProcessGroupStatusSnapshotDTO. - :rtype: str - """ - return self._node_id - - @node_id.setter - def node_id(self, node_id): - """ - Sets the node_id of this NodeRemoteProcessGroupStatusSnapshotDTO. - The unique ID that identifies the node - - :param node_id: The node_id of this NodeRemoteProcessGroupStatusSnapshotDTO. - :type: str - """ - - self._node_id = node_id - @property def address(self): """ @@ -129,11 +103,33 @@ def api_port(self, api_port): self._api_port = api_port + @property + def node_id(self): + """ + Gets the node_id of this NodeRemoteProcessGroupStatusSnapshotDTO. + The unique ID that identifies the node + + :return: The node_id of this NodeRemoteProcessGroupStatusSnapshotDTO. + :rtype: str + """ + return self._node_id + + @node_id.setter + def node_id(self, node_id): + """ + Sets the node_id of this NodeRemoteProcessGroupStatusSnapshotDTO. + The unique ID that identifies the node + + :param node_id: The node_id of this NodeRemoteProcessGroupStatusSnapshotDTO. + :type: str + """ + + self._node_id = node_id + @property def status_snapshot(self): """ Gets the status_snapshot of this NodeRemoteProcessGroupStatusSnapshotDTO. - The remote process group status snapshot from the node. :return: The status_snapshot of this NodeRemoteProcessGroupStatusSnapshotDTO. :rtype: RemoteProcessGroupStatusSnapshotDTO @@ -144,7 +140,6 @@ def status_snapshot(self): def status_snapshot(self, status_snapshot): """ Sets the status_snapshot of this NodeRemoteProcessGroupStatusSnapshotDTO. - The remote process group status snapshot from the node. :param status_snapshot: The status_snapshot of this NodeRemoteProcessGroupStatusSnapshotDTO. :type: RemoteProcessGroupStatusSnapshotDTO 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 ef0f14a2..5f41822e 100644 --- a/nipyapi/nifi/models/node_replay_last_event_snapshot_dto.py +++ b/nipyapi/nifi/models/node_replay_last_event_snapshot_dto.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,61 +27,36 @@ class NodeReplayLastEventSnapshotDTO(object): and the value is json key in definition. """ swagger_types = { - 'node_id': 'str', 'address': 'str', - 'api_port': 'int', - 'snapshot': 'ReplayLastEventSnapshotDTO' - } +'api_port': 'int', +'node_id': 'str', +'snapshot': 'ReplayLastEventSnapshotDTO' } attribute_map = { - 'node_id': 'nodeId', 'address': 'address', - 'api_port': 'apiPort', - 'snapshot': 'snapshot' - } +'api_port': 'apiPort', +'node_id': 'nodeId', +'snapshot': 'snapshot' } - def __init__(self, node_id=None, address=None, api_port=None, snapshot=None): + def __init__(self, address=None, api_port=None, node_id=None, snapshot=None): """ NodeReplayLastEventSnapshotDTO - a model defined in Swagger """ - self._node_id = None self._address = None self._api_port = None + self._node_id = None self._snapshot = None - if node_id is not None: - self.node_id = node_id if address is not None: self.address = address if api_port is not None: self.api_port = api_port + if node_id is not None: + self.node_id = node_id if snapshot is not None: self.snapshot = snapshot - @property - def node_id(self): - """ - Gets the node_id of this NodeReplayLastEventSnapshotDTO. - The unique ID that identifies the node - - :return: The node_id of this NodeReplayLastEventSnapshotDTO. - :rtype: str - """ - return self._node_id - - @node_id.setter - def node_id(self, node_id): - """ - Sets the node_id of this NodeReplayLastEventSnapshotDTO. - The unique ID that identifies the node - - :param node_id: The node_id of this NodeReplayLastEventSnapshotDTO. - :type: str - """ - - self._node_id = node_id - @property def address(self): """ @@ -129,11 +103,33 @@ def api_port(self, api_port): self._api_port = api_port + @property + def node_id(self): + """ + Gets the node_id of this NodeReplayLastEventSnapshotDTO. + The unique ID that identifies the node + + :return: The node_id of this NodeReplayLastEventSnapshotDTO. + :rtype: str + """ + return self._node_id + + @node_id.setter + def node_id(self, node_id): + """ + Sets the node_id of this NodeReplayLastEventSnapshotDTO. + The unique ID that identifies the node + + :param node_id: The node_id of this NodeReplayLastEventSnapshotDTO. + :type: str + """ + + self._node_id = node_id + @property def snapshot(self): """ Gets the snapshot of this NodeReplayLastEventSnapshotDTO. - The snapshot from the node :return: The snapshot of this NodeReplayLastEventSnapshotDTO. :rtype: ReplayLastEventSnapshotDTO @@ -144,7 +140,6 @@ def snapshot(self): def snapshot(self, snapshot): """ Sets the snapshot of this NodeReplayLastEventSnapshotDTO. - The snapshot from the node :param snapshot: The snapshot of this NodeReplayLastEventSnapshotDTO. :type: ReplayLastEventSnapshotDTO diff --git a/nipyapi/nifi/models/node_response.py b/nipyapi/nifi/models/node_response.py deleted file mode 100644 index 30787b24..00000000 --- a/nipyapi/nifi/models/node_response.py +++ /dev/null @@ -1,406 +0,0 @@ -""" - NiFi Rest API - - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - - OpenAPI spec version: 1.28.1 - Contact: dev@nifi.apache.org - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - - -from pprint import pformat -import re - - -class NodeResponse(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 = { - 'http_method': 'str', - 'request_uri': 'str', - 'response': 'Response', - 'node_id': 'NodeIdentifier', - 'throwable': 'Throwable', - 'updated_entity': 'Entity', - 'request_id': 'str', - 'input_stream': 'InputStream', - 'status': 'int', - 'client_response': 'Response', - 'is5xx': 'bool', - 'is2xx': 'bool' - } - - attribute_map = { - 'http_method': 'httpMethod', - 'request_uri': 'requestUri', - 'response': 'response', - 'node_id': 'nodeId', - 'throwable': 'throwable', - 'updated_entity': 'updatedEntity', - 'request_id': 'requestId', - 'input_stream': 'inputStream', - 'status': 'status', - 'client_response': 'clientResponse', - 'is5xx': 'is5xx', - 'is2xx': 'is2xx' - } - - def __init__(self, http_method=None, request_uri=None, response=None, node_id=None, throwable=None, updated_entity=None, request_id=None, input_stream=None, status=None, client_response=None, is5xx=None, is2xx=None): - """ - NodeResponse - a model defined in Swagger - """ - - self._http_method = None - self._request_uri = None - self._response = None - self._node_id = None - self._throwable = None - self._updated_entity = None - self._request_id = None - self._input_stream = None - self._status = None - self._client_response = None - self._is5xx = None - self._is2xx = None - - if http_method is not None: - self.http_method = http_method - if request_uri is not None: - self.request_uri = request_uri - if response is not None: - self.response = response - if node_id is not None: - self.node_id = node_id - if throwable is not None: - self.throwable = throwable - if updated_entity is not None: - self.updated_entity = updated_entity - if request_id is not None: - self.request_id = request_id - if input_stream is not None: - self.input_stream = input_stream - if status is not None: - self.status = status - if client_response is not None: - self.client_response = client_response - if is5xx is not None: - self.is5xx = is5xx - if is2xx is not None: - self.is2xx = is2xx - - @property - def http_method(self): - """ - Gets the http_method of this NodeResponse. - - :return: The http_method of this NodeResponse. - :rtype: str - """ - return self._http_method - - @http_method.setter - def http_method(self, http_method): - """ - Sets the http_method of this NodeResponse. - - :param http_method: The http_method of this NodeResponse. - :type: str - """ - - self._http_method = http_method - - @property - def request_uri(self): - """ - Gets the request_uri of this NodeResponse. - - :return: The request_uri of this NodeResponse. - :rtype: str - """ - return self._request_uri - - @request_uri.setter - def request_uri(self, request_uri): - """ - Sets the request_uri of this NodeResponse. - - :param request_uri: The request_uri of this NodeResponse. - :type: str - """ - - self._request_uri = request_uri - - @property - def response(self): - """ - Gets the response of this NodeResponse. - - :return: The response of this NodeResponse. - :rtype: Response - """ - return self._response - - @response.setter - def response(self, response): - """ - Sets the response of this NodeResponse. - - :param response: The response of this NodeResponse. - :type: Response - """ - - self._response = response - - @property - def node_id(self): - """ - Gets the node_id of this NodeResponse. - - :return: The node_id of this NodeResponse. - :rtype: NodeIdentifier - """ - return self._node_id - - @node_id.setter - def node_id(self, node_id): - """ - Sets the node_id of this NodeResponse. - - :param node_id: The node_id of this NodeResponse. - :type: NodeIdentifier - """ - - self._node_id = node_id - - @property - def throwable(self): - """ - Gets the throwable of this NodeResponse. - - :return: The throwable of this NodeResponse. - :rtype: Throwable - """ - return self._throwable - - @throwable.setter - def throwable(self, throwable): - """ - Sets the throwable of this NodeResponse. - - :param throwable: The throwable of this NodeResponse. - :type: Throwable - """ - - self._throwable = throwable - - @property - def updated_entity(self): - """ - Gets the updated_entity of this NodeResponse. - - :return: The updated_entity of this NodeResponse. - :rtype: Entity - """ - return self._updated_entity - - @updated_entity.setter - def updated_entity(self, updated_entity): - """ - Sets the updated_entity of this NodeResponse. - - :param updated_entity: The updated_entity of this NodeResponse. - :type: Entity - """ - - self._updated_entity = updated_entity - - @property - def request_id(self): - """ - Gets the request_id of this NodeResponse. - - :return: The request_id of this NodeResponse. - :rtype: str - """ - return self._request_id - - @request_id.setter - def request_id(self, request_id): - """ - Sets the request_id of this NodeResponse. - - :param request_id: The request_id of this NodeResponse. - :type: str - """ - - self._request_id = request_id - - @property - def input_stream(self): - """ - Gets the input_stream of this NodeResponse. - - :return: The input_stream of this NodeResponse. - :rtype: InputStream - """ - return self._input_stream - - @input_stream.setter - def input_stream(self, input_stream): - """ - Sets the input_stream of this NodeResponse. - - :param input_stream: The input_stream of this NodeResponse. - :type: InputStream - """ - - self._input_stream = input_stream - - @property - def status(self): - """ - Gets the status of this NodeResponse. - - :return: The status of this NodeResponse. - :rtype: int - """ - return self._status - - @status.setter - def status(self, status): - """ - Sets the status of this NodeResponse. - - :param status: The status of this NodeResponse. - :type: int - """ - - self._status = status - - @property - def client_response(self): - """ - Gets the client_response of this NodeResponse. - - :return: The client_response of this NodeResponse. - :rtype: Response - """ - return self._client_response - - @client_response.setter - def client_response(self, client_response): - """ - Sets the client_response of this NodeResponse. - - :param client_response: The client_response of this NodeResponse. - :type: Response - """ - - self._client_response = client_response - - @property - def is5xx(self): - """ - Gets the is5xx of this NodeResponse. - - :return: The is5xx of this NodeResponse. - :rtype: bool - """ - return self._is5xx - - @is5xx.setter - def is5xx(self, is5xx): - """ - Sets the is5xx of this NodeResponse. - - :param is5xx: The is5xx of this NodeResponse. - :type: bool - """ - - self._is5xx = is5xx - - @property - def is2xx(self): - """ - Gets the is2xx of this NodeResponse. - - :return: The is2xx of this NodeResponse. - :rtype: bool - """ - return self._is2xx - - @is2xx.setter - def is2xx(self, is2xx): - """ - Sets the is2xx of this NodeResponse. - - :param is2xx: The is2xx of this NodeResponse. - :type: bool - """ - - self._is2xx = is2xx - - 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, NodeResponse): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other): - """ - Returns true if both objects are not equal - """ - return not self == other diff --git a/nipyapi/nifi/models/node_search_result_dto.py b/nipyapi/nifi/models/node_search_result_dto.py index 566c474f..a1f9e644 100644 --- a/nipyapi/nifi/models/node_search_result_dto.py +++ b/nipyapi/nifi/models/node_search_result_dto.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,73 +27,71 @@ class NodeSearchResultDTO(object): and the value is json key in definition. """ swagger_types = { - 'id': 'str', - 'address': 'str' - } + 'address': 'str', +'id': 'str' } attribute_map = { - 'id': 'id', - 'address': 'address' - } + 'address': 'address', +'id': 'id' } - def __init__(self, id=None, address=None): + def __init__(self, address=None, id=None): """ NodeSearchResultDTO - a model defined in Swagger """ - self._id = None self._address = None + self._id = None - if id is not None: - self.id = id if address is not None: self.address = address + if id is not None: + self.id = id @property - def id(self): + def address(self): """ - Gets the id of this NodeSearchResultDTO. - The id of the node that matched the search. + Gets the address of this NodeSearchResultDTO. + The address of the node that matched the search. - :return: The id of this NodeSearchResultDTO. + :return: The address of this NodeSearchResultDTO. :rtype: str """ - return self._id + return self._address - @id.setter - def id(self, id): + @address.setter + def address(self, address): """ - Sets the id of this NodeSearchResultDTO. - The id of the node that matched the search. + Sets the address of this NodeSearchResultDTO. + The address of the node that matched the search. - :param id: The id of this NodeSearchResultDTO. + :param address: The address of this NodeSearchResultDTO. :type: str """ - self._id = id + self._address = address @property - def address(self): + def id(self): """ - Gets the address of this NodeSearchResultDTO. - The address of the node that matched the search. + Gets the id of this NodeSearchResultDTO. + The id of the node that matched the search. - :return: The address of this NodeSearchResultDTO. + :return: The id of this NodeSearchResultDTO. :rtype: str """ - return self._address + return self._id - @address.setter - def address(self, address): + @id.setter + def id(self, id): """ - Sets the address of this NodeSearchResultDTO. - The address of the node that matched the search. + Sets the id of this NodeSearchResultDTO. + The id of the node that matched the search. - :param address: The address of this NodeSearchResultDTO. + :param id: The id of this NodeSearchResultDTO. :type: str """ - self._address = address + self._id = id def to_dict(self): """ diff --git a/nipyapi/nifi/models/node_status_snapshots_dto.py b/nipyapi/nifi/models/node_status_snapshots_dto.py index c52b4127..56fba122 100644 --- a/nipyapi/nifi/models/node_status_snapshots_dto.py +++ b/nipyapi/nifi/models/node_status_snapshots_dto.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,61 +27,36 @@ class NodeStatusSnapshotsDTO(object): and the value is json key in definition. """ swagger_types = { - 'node_id': 'str', 'address': 'str', - 'api_port': 'int', - 'status_snapshots': 'list[StatusSnapshotDTO]' - } +'api_port': 'int', +'node_id': 'str', +'status_snapshots': 'list[StatusSnapshotDTO]' } attribute_map = { - 'node_id': 'nodeId', 'address': 'address', - 'api_port': 'apiPort', - 'status_snapshots': 'statusSnapshots' - } +'api_port': 'apiPort', +'node_id': 'nodeId', +'status_snapshots': 'statusSnapshots' } - def __init__(self, node_id=None, address=None, api_port=None, status_snapshots=None): + def __init__(self, address=None, api_port=None, node_id=None, status_snapshots=None): """ NodeStatusSnapshotsDTO - a model defined in Swagger """ - self._node_id = None self._address = None self._api_port = None + self._node_id = None self._status_snapshots = None - if node_id is not None: - self.node_id = node_id if address is not None: self.address = address if api_port is not None: self.api_port = api_port + if node_id is not None: + self.node_id = node_id if status_snapshots is not None: self.status_snapshots = status_snapshots - @property - def node_id(self): - """ - Gets the node_id of this NodeStatusSnapshotsDTO. - The id of the node. - - :return: The node_id of this NodeStatusSnapshotsDTO. - :rtype: str - """ - return self._node_id - - @node_id.setter - def node_id(self, node_id): - """ - Sets the node_id of this NodeStatusSnapshotsDTO. - The id of the node. - - :param node_id: The node_id of this NodeStatusSnapshotsDTO. - :type: str - """ - - self._node_id = node_id - @property def address(self): """ @@ -129,6 +103,29 @@ def api_port(self, api_port): self._api_port = api_port + @property + def node_id(self): + """ + Gets the node_id of this NodeStatusSnapshotsDTO. + The id of the node. + + :return: The node_id of this NodeStatusSnapshotsDTO. + :rtype: str + """ + return self._node_id + + @node_id.setter + def node_id(self, node_id): + """ + Sets the node_id of this NodeStatusSnapshotsDTO. + The id of the node. + + :param node_id: The node_id of this NodeStatusSnapshotsDTO. + :type: str + """ + + self._node_id = node_id + @property def status_snapshots(self): """ diff --git a/nipyapi/nifi/models/node_system_diagnostics_snapshot_dto.py b/nipyapi/nifi/models/node_system_diagnostics_snapshot_dto.py index 0db7d968..a249b0c2 100644 --- a/nipyapi/nifi/models/node_system_diagnostics_snapshot_dto.py +++ b/nipyapi/nifi/models/node_system_diagnostics_snapshot_dto.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,61 +27,36 @@ class NodeSystemDiagnosticsSnapshotDTO(object): and the value is json key in definition. """ swagger_types = { - 'node_id': 'str', 'address': 'str', - 'api_port': 'int', - 'snapshot': 'SystemDiagnosticsSnapshotDTO' - } +'api_port': 'int', +'node_id': 'str', +'snapshot': 'SystemDiagnosticsSnapshotDTO' } attribute_map = { - 'node_id': 'nodeId', 'address': 'address', - 'api_port': 'apiPort', - 'snapshot': 'snapshot' - } +'api_port': 'apiPort', +'node_id': 'nodeId', +'snapshot': 'snapshot' } - def __init__(self, node_id=None, address=None, api_port=None, snapshot=None): + def __init__(self, address=None, api_port=None, node_id=None, snapshot=None): """ NodeSystemDiagnosticsSnapshotDTO - a model defined in Swagger """ - self._node_id = None self._address = None self._api_port = None + self._node_id = None self._snapshot = None - if node_id is not None: - self.node_id = node_id if address is not None: self.address = address if api_port is not None: self.api_port = api_port + if node_id is not None: + self.node_id = node_id if snapshot is not None: self.snapshot = snapshot - @property - def node_id(self): - """ - Gets the node_id of this NodeSystemDiagnosticsSnapshotDTO. - The unique ID that identifies the node - - :return: The node_id of this NodeSystemDiagnosticsSnapshotDTO. - :rtype: str - """ - return self._node_id - - @node_id.setter - def node_id(self, node_id): - """ - Sets the node_id of this NodeSystemDiagnosticsSnapshotDTO. - The unique ID that identifies the node - - :param node_id: The node_id of this NodeSystemDiagnosticsSnapshotDTO. - :type: str - """ - - self._node_id = node_id - @property def address(self): """ @@ -129,11 +103,33 @@ def api_port(self, api_port): self._api_port = api_port + @property + def node_id(self): + """ + Gets the node_id of this NodeSystemDiagnosticsSnapshotDTO. + The unique ID that identifies the node + + :return: The node_id of this NodeSystemDiagnosticsSnapshotDTO. + :rtype: str + """ + return self._node_id + + @node_id.setter + def node_id(self, node_id): + """ + Sets the node_id of this NodeSystemDiagnosticsSnapshotDTO. + The unique ID that identifies the node + + :param node_id: The node_id of this NodeSystemDiagnosticsSnapshotDTO. + :type: str + """ + + self._node_id = node_id + @property def snapshot(self): """ Gets the snapshot of this NodeSystemDiagnosticsSnapshotDTO. - The System Diagnostics snapshot from the node. :return: The snapshot of this NodeSystemDiagnosticsSnapshotDTO. :rtype: SystemDiagnosticsSnapshotDTO @@ -144,7 +140,6 @@ def snapshot(self): def snapshot(self, snapshot): """ Sets the snapshot of this NodeSystemDiagnosticsSnapshotDTO. - The System Diagnostics snapshot from the node. :param snapshot: The snapshot of this NodeSystemDiagnosticsSnapshotDTO. :type: SystemDiagnosticsSnapshotDTO diff --git a/nipyapi/nifi/models/output_ports_entity.py b/nipyapi/nifi/models/output_ports_entity.py index d36a5e92..92bda5d3 100644 --- a/nipyapi/nifi/models/output_ports_entity.py +++ b/nipyapi/nifi/models/output_ports_entity.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,12 +27,10 @@ class OutputPortsEntity(object): and the value is json key in definition. """ swagger_types = { - 'output_ports': 'list[PortEntity]' - } + 'output_ports': 'list[PortEntity]' } attribute_map = { - 'output_ports': 'outputPorts' - } + 'output_ports': 'outputPorts' } def __init__(self, output_ports=None): """ diff --git a/nipyapi/nifi/models/parameter_context_dto.py b/nipyapi/nifi/models/parameter_context_dto.py index 7a7e9208..58651399 100644 --- a/nipyapi/nifi/models/parameter_context_dto.py +++ b/nipyapi/nifi/models/parameter_context_dto.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,75 +27,73 @@ class ParameterContextDTO(object): and the value is json key in definition. """ swagger_types = { - 'name': 'str', - 'description': 'str', - 'parameters': 'list[ParameterEntity]', 'bound_process_groups': 'list[ProcessGroupEntity]', - 'inherited_parameter_contexts': 'list[ParameterContextReferenceEntity]', - 'parameter_provider_configuration': 'ParameterProviderConfigurationEntity', - 'id': 'str' - } +'description': 'str', +'id': 'str', +'inherited_parameter_contexts': 'list[ParameterContextReferenceEntity]', +'name': 'str', +'parameter_provider_configuration': 'ParameterProviderConfigurationEntity', +'parameters': 'list[ParameterEntity]' } attribute_map = { - 'name': 'name', - 'description': 'description', - 'parameters': 'parameters', 'bound_process_groups': 'boundProcessGroups', - 'inherited_parameter_contexts': 'inheritedParameterContexts', - 'parameter_provider_configuration': 'parameterProviderConfiguration', - 'id': 'id' - } +'description': 'description', +'id': 'id', +'inherited_parameter_contexts': 'inheritedParameterContexts', +'name': 'name', +'parameter_provider_configuration': 'parameterProviderConfiguration', +'parameters': 'parameters' } - def __init__(self, name=None, description=None, parameters=None, bound_process_groups=None, inherited_parameter_contexts=None, parameter_provider_configuration=None, id=None): + def __init__(self, bound_process_groups=None, description=None, id=None, inherited_parameter_contexts=None, name=None, parameter_provider_configuration=None, parameters=None): """ ParameterContextDTO - a model defined in Swagger """ - self._name = None - self._description = None - self._parameters = None self._bound_process_groups = None + self._description = None + self._id = None self._inherited_parameter_contexts = None + self._name = None self._parameter_provider_configuration = None - self._id = None + self._parameters = None - if name is not None: - self.name = name - if description is not None: - self.description = description - if parameters is not None: - self.parameters = parameters if bound_process_groups is not None: self.bound_process_groups = bound_process_groups + if description is not None: + self.description = description + if id is not None: + self.id = id if inherited_parameter_contexts is not None: self.inherited_parameter_contexts = inherited_parameter_contexts + if name is not None: + self.name = name if parameter_provider_configuration is not None: self.parameter_provider_configuration = parameter_provider_configuration - if id is not None: - self.id = id + if parameters is not None: + self.parameters = parameters @property - def name(self): + def bound_process_groups(self): """ - Gets the name of this ParameterContextDTO. - The Name of the Parameter Context. + Gets the bound_process_groups of this ParameterContextDTO. + The Process Groups that are bound to this Parameter Context - :return: The name of this ParameterContextDTO. - :rtype: str + :return: The bound_process_groups of this ParameterContextDTO. + :rtype: list[ProcessGroupEntity] """ - return self._name + return self._bound_process_groups - @name.setter - def name(self, name): + @bound_process_groups.setter + def bound_process_groups(self, bound_process_groups): """ - Sets the name of this ParameterContextDTO. - The Name of the Parameter Context. + Sets the bound_process_groups of this ParameterContextDTO. + The Process Groups that are bound to this Parameter Context - :param name: The name of this ParameterContextDTO. - :type: str + :param bound_process_groups: The bound_process_groups of this ParameterContextDTO. + :type: list[ProcessGroupEntity] """ - self._name = name + self._bound_process_groups = bound_process_groups @property def description(self): @@ -122,50 +119,27 @@ def description(self, description): self._description = description @property - def parameters(self): - """ - Gets the parameters of this ParameterContextDTO. - The Parameters for the Parameter Context - - :return: The parameters of this ParameterContextDTO. - :rtype: list[ParameterEntity] - """ - return self._parameters - - @parameters.setter - def parameters(self, parameters): - """ - Sets the parameters of this ParameterContextDTO. - The Parameters for the Parameter Context - - :param parameters: The parameters of this ParameterContextDTO. - :type: list[ParameterEntity] - """ - - self._parameters = parameters - - @property - def bound_process_groups(self): + def id(self): """ - Gets the bound_process_groups of this ParameterContextDTO. - The Process Groups that are bound to this Parameter Context + Gets the id of this ParameterContextDTO. + The ID the Parameter Context. - :return: The bound_process_groups of this ParameterContextDTO. - :rtype: list[ProcessGroupEntity] + :return: The id of this ParameterContextDTO. + :rtype: str """ - return self._bound_process_groups + return self._id - @bound_process_groups.setter - def bound_process_groups(self, bound_process_groups): + @id.setter + def id(self, id): """ - Sets the bound_process_groups of this ParameterContextDTO. - The Process Groups that are bound to this Parameter Context + Sets the id of this ParameterContextDTO. + The ID the Parameter Context. - :param bound_process_groups: The bound_process_groups of this ParameterContextDTO. - :type: list[ProcessGroupEntity] + :param id: The id of this ParameterContextDTO. + :type: str """ - self._bound_process_groups = bound_process_groups + self._id = id @property def inherited_parameter_contexts(self): @@ -190,11 +164,33 @@ def inherited_parameter_contexts(self, inherited_parameter_contexts): self._inherited_parameter_contexts = inherited_parameter_contexts + @property + def name(self): + """ + Gets the name of this ParameterContextDTO. + The Name of the Parameter Context. + + :return: The name of this ParameterContextDTO. + :rtype: str + """ + return self._name + + @name.setter + def name(self, name): + """ + Sets the name of this ParameterContextDTO. + The Name of the Parameter Context. + + :param name: The name of this ParameterContextDTO. + :type: str + """ + + self._name = name + @property def parameter_provider_configuration(self): """ Gets the parameter_provider_configuration of this ParameterContextDTO. - Optional configuration for a Parameter Provider :return: The parameter_provider_configuration of this ParameterContextDTO. :rtype: ParameterProviderConfigurationEntity @@ -205,7 +201,6 @@ def parameter_provider_configuration(self): def parameter_provider_configuration(self, parameter_provider_configuration): """ Sets the parameter_provider_configuration of this ParameterContextDTO. - Optional configuration for a Parameter Provider :param parameter_provider_configuration: The parameter_provider_configuration of this ParameterContextDTO. :type: ParameterProviderConfigurationEntity @@ -214,27 +209,27 @@ def parameter_provider_configuration(self, parameter_provider_configuration): self._parameter_provider_configuration = parameter_provider_configuration @property - def id(self): + def parameters(self): """ - Gets the id of this ParameterContextDTO. - The ID the Parameter Context. + Gets the parameters of this ParameterContextDTO. + The Parameters for the Parameter Context - :return: The id of this ParameterContextDTO. - :rtype: str + :return: The parameters of this ParameterContextDTO. + :rtype: list[ParameterEntity] """ - return self._id + return self._parameters - @id.setter - def id(self, id): + @parameters.setter + def parameters(self, parameters): """ - Sets the id of this ParameterContextDTO. - The ID the Parameter Context. + Sets the parameters of this ParameterContextDTO. + The Parameters for the Parameter Context - :param id: The id of this ParameterContextDTO. - :type: str + :param parameters: The parameters of this ParameterContextDTO. + :type: list[ParameterEntity] """ - self._id = id + self._parameters = parameters def to_dict(self): """ diff --git a/nipyapi/nifi/models/parameter_context_entity.py b/nipyapi/nifi/models/parameter_context_entity.py index 046b5321..7a3920da 100644 --- a/nipyapi/nifi/models/parameter_context_entity.py +++ b/nipyapi/nifi/models/parameter_context_entity.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,155 +27,150 @@ class ParameterContextEntity(object): and the value is json key in definition. """ swagger_types = { - 'revision': 'RevisionDTO', - 'id': 'str', - 'uri': 'str', - 'position': 'PositionDTO', - 'permissions': 'PermissionsDTO', 'bulletins': 'list[BulletinEntity]', - 'disconnected_node_acknowledged': 'bool', - 'component': 'ParameterContextDTO' - } +'component': 'ParameterContextDTO', +'disconnected_node_acknowledged': 'bool', +'id': 'str', +'permissions': 'PermissionsDTO', +'position': 'PositionDTO', +'revision': 'RevisionDTO', +'uri': 'str' } attribute_map = { - 'revision': 'revision', - 'id': 'id', - 'uri': 'uri', - 'position': 'position', - 'permissions': 'permissions', 'bulletins': 'bulletins', - 'disconnected_node_acknowledged': 'disconnectedNodeAcknowledged', - 'component': 'component' - } +'component': 'component', +'disconnected_node_acknowledged': 'disconnectedNodeAcknowledged', +'id': 'id', +'permissions': 'permissions', +'position': 'position', +'revision': 'revision', +'uri': 'uri' } - def __init__(self, revision=None, id=None, uri=None, position=None, permissions=None, bulletins=None, disconnected_node_acknowledged=None, component=None): + def __init__(self, bulletins=None, component=None, disconnected_node_acknowledged=None, id=None, permissions=None, position=None, revision=None, uri=None): """ ParameterContextEntity - a model defined in Swagger """ - self._revision = None - self._id = None - self._uri = None - self._position = None - self._permissions = None self._bulletins = None - self._disconnected_node_acknowledged = None self._component = None + self._disconnected_node_acknowledged = None + self._id = None + self._permissions = None + self._position = None + self._revision = None + self._uri = None - if revision is not None: - self.revision = revision - if id is not None: - self.id = id - if uri is not None: - self.uri = uri - if position is not None: - self.position = position - if permissions is not None: - self.permissions = permissions if bulletins is not None: self.bulletins = bulletins - if disconnected_node_acknowledged is not None: - self.disconnected_node_acknowledged = disconnected_node_acknowledged if component is not None: self.component = component + if disconnected_node_acknowledged is not None: + self.disconnected_node_acknowledged = disconnected_node_acknowledged + if id is not None: + self.id = id + if permissions is not None: + self.permissions = permissions + if position is not None: + self.position = position + if revision is not None: + self.revision = revision + if uri is not None: + self.uri = uri @property - def revision(self): + def bulletins(self): """ - Gets the revision of this ParameterContextEntity. - The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses. + Gets the bulletins of this ParameterContextEntity. + The bulletins for this component. - :return: The revision of this ParameterContextEntity. - :rtype: RevisionDTO + :return: The bulletins of this ParameterContextEntity. + :rtype: list[BulletinEntity] """ - return self._revision + return self._bulletins - @revision.setter - def revision(self, revision): + @bulletins.setter + def bulletins(self, bulletins): """ - Sets the revision of this ParameterContextEntity. - The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses. + Sets the bulletins of this ParameterContextEntity. + The bulletins for this component. - :param revision: The revision of this ParameterContextEntity. - :type: RevisionDTO + :param bulletins: The bulletins of this ParameterContextEntity. + :type: list[BulletinEntity] """ - self._revision = revision + self._bulletins = bulletins @property - def id(self): + def component(self): """ - Gets the id of this ParameterContextEntity. - The id of the component. + Gets the component of this ParameterContextEntity. - :return: The id of this ParameterContextEntity. - :rtype: str + :return: The component of this ParameterContextEntity. + :rtype: ParameterContextDTO """ - return self._id + return self._component - @id.setter - def id(self, id): + @component.setter + def component(self, component): """ - Sets the id of this ParameterContextEntity. - The id of the component. + Sets the component of this ParameterContextEntity. - :param id: The id of this ParameterContextEntity. - :type: str + :param component: The component of this ParameterContextEntity. + :type: ParameterContextDTO """ - self._id = id + self._component = component @property - def uri(self): + def disconnected_node_acknowledged(self): """ - Gets the uri of this ParameterContextEntity. - The URI for futures requests to the component. + Gets the disconnected_node_acknowledged of this ParameterContextEntity. + Acknowledges that this node is disconnected to allow for mutable requests to proceed. - :return: The uri of this ParameterContextEntity. - :rtype: str + :return: The disconnected_node_acknowledged of this ParameterContextEntity. + :rtype: bool """ - return self._uri + return self._disconnected_node_acknowledged - @uri.setter - def uri(self, uri): + @disconnected_node_acknowledged.setter + def disconnected_node_acknowledged(self, disconnected_node_acknowledged): """ - Sets the uri of this ParameterContextEntity. - The URI for futures requests to the component. + Sets the disconnected_node_acknowledged of this ParameterContextEntity. + Acknowledges that this node is disconnected to allow for mutable requests to proceed. - :param uri: The uri of this ParameterContextEntity. - :type: str + :param disconnected_node_acknowledged: The disconnected_node_acknowledged of this ParameterContextEntity. + :type: bool """ - self._uri = uri + self._disconnected_node_acknowledged = disconnected_node_acknowledged @property - def position(self): + def id(self): """ - Gets the position of this ParameterContextEntity. - The position of this component in the UI if applicable. + Gets the id of this ParameterContextEntity. + The id of the component. - :return: The position of this ParameterContextEntity. - :rtype: PositionDTO + :return: The id of this ParameterContextEntity. + :rtype: str """ - return self._position + return self._id - @position.setter - def position(self, position): + @id.setter + def id(self, id): """ - Sets the position of this ParameterContextEntity. - The position of this component in the UI if applicable. + Sets the id of this ParameterContextEntity. + The id of the component. - :param position: The position of this ParameterContextEntity. - :type: PositionDTO + :param id: The id of this ParameterContextEntity. + :type: str """ - self._position = position + self._id = id @property def permissions(self): """ Gets the permissions of this ParameterContextEntity. - The permissions for this component. :return: The permissions of this ParameterContextEntity. :rtype: PermissionsDTO @@ -187,7 +181,6 @@ def permissions(self): def permissions(self, permissions): """ Sets the permissions of this ParameterContextEntity. - The permissions for this component. :param permissions: The permissions of this ParameterContextEntity. :type: PermissionsDTO @@ -196,73 +189,69 @@ def permissions(self, permissions): self._permissions = permissions @property - def bulletins(self): + def position(self): """ - Gets the bulletins of this ParameterContextEntity. - The bulletins for this component. + Gets the position of this ParameterContextEntity. - :return: The bulletins of this ParameterContextEntity. - :rtype: list[BulletinEntity] + :return: The position of this ParameterContextEntity. + :rtype: PositionDTO """ - return self._bulletins + return self._position - @bulletins.setter - def bulletins(self, bulletins): + @position.setter + def position(self, position): """ - Sets the bulletins of this ParameterContextEntity. - The bulletins for this component. + Sets the position of this ParameterContextEntity. - :param bulletins: The bulletins of this ParameterContextEntity. - :type: list[BulletinEntity] + :param position: The position of this ParameterContextEntity. + :type: PositionDTO """ - self._bulletins = bulletins + self._position = position @property - def disconnected_node_acknowledged(self): + def revision(self): """ - Gets the disconnected_node_acknowledged of this ParameterContextEntity. - Acknowledges that this node is disconnected to allow for mutable requests to proceed. + Gets the revision of this ParameterContextEntity. - :return: The disconnected_node_acknowledged of this ParameterContextEntity. - :rtype: bool + :return: The revision of this ParameterContextEntity. + :rtype: RevisionDTO """ - return self._disconnected_node_acknowledged + return self._revision - @disconnected_node_acknowledged.setter - def disconnected_node_acknowledged(self, disconnected_node_acknowledged): + @revision.setter + def revision(self, revision): """ - Sets the disconnected_node_acknowledged of this ParameterContextEntity. - Acknowledges that this node is disconnected to allow for mutable requests to proceed. + Sets the revision of this ParameterContextEntity. - :param disconnected_node_acknowledged: The disconnected_node_acknowledged of this ParameterContextEntity. - :type: bool + :param revision: The revision of this ParameterContextEntity. + :type: RevisionDTO """ - self._disconnected_node_acknowledged = disconnected_node_acknowledged + self._revision = revision @property - def component(self): + def uri(self): """ - Gets the component of this ParameterContextEntity. - The Parameter Context + Gets the uri of this ParameterContextEntity. + The URI for futures requests to the component. - :return: The component of this ParameterContextEntity. - :rtype: ParameterContextDTO + :return: The uri of this ParameterContextEntity. + :rtype: str """ - return self._component + return self._uri - @component.setter - def component(self, component): + @uri.setter + def uri(self, uri): """ - Sets the component of this ParameterContextEntity. - The Parameter Context + Sets the uri of this ParameterContextEntity. + The URI for futures requests to the component. - :param component: The component of this ParameterContextEntity. - :type: ParameterContextDTO + :param uri: The uri of this ParameterContextEntity. + :type: str """ - self._component = component + self._uri = uri def to_dict(self): """ diff --git a/nipyapi/nifi/models/parameter_context_reference_dto.py b/nipyapi/nifi/models/parameter_context_reference_dto.py index 4d8452a6..042d1168 100644 --- a/nipyapi/nifi/models/parameter_context_reference_dto.py +++ b/nipyapi/nifi/models/parameter_context_reference_dto.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -29,13 +28,11 @@ class ParameterContextReferenceDTO(object): """ swagger_types = { 'id': 'str', - 'name': 'str' - } +'name': 'str' } attribute_map = { 'id': 'id', - 'name': 'name' - } +'name': 'name' } def __init__(self, id=None, name=None): """ diff --git a/nipyapi/nifi/models/parameter_context_reference_entity.py b/nipyapi/nifi/models/parameter_context_reference_entity.py index 62f86064..1360f231 100644 --- a/nipyapi/nifi/models/parameter_context_reference_entity.py +++ b/nipyapi/nifi/models/parameter_context_reference_entity.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,32 +27,51 @@ class ParameterContextReferenceEntity(object): and the value is json key in definition. """ swagger_types = { - 'id': 'str', - 'permissions': 'PermissionsDTO', - 'component': 'ParameterContextReferenceDTO' - } + 'component': 'ParameterContextReferenceDTO', +'id': 'str', +'permissions': 'PermissionsDTO' } attribute_map = { - 'id': 'id', - 'permissions': 'permissions', - 'component': 'component' - } + 'component': 'component', +'id': 'id', +'permissions': 'permissions' } - def __init__(self, id=None, permissions=None, component=None): + def __init__(self, component=None, id=None, permissions=None): """ ParameterContextReferenceEntity - a model defined in Swagger """ + self._component = None self._id = None self._permissions = None - self._component = None + if component is not None: + self.component = component if id is not None: self.id = id if permissions is not None: self.permissions = permissions - if component is not None: - self.component = component + + @property + def component(self): + """ + Gets the component of this ParameterContextReferenceEntity. + + :return: The component of this ParameterContextReferenceEntity. + :rtype: ParameterContextReferenceDTO + """ + return self._component + + @component.setter + def component(self, component): + """ + Sets the component of this ParameterContextReferenceEntity. + + :param component: The component of this ParameterContextReferenceEntity. + :type: ParameterContextReferenceDTO + """ + + self._component = component @property def id(self): @@ -82,7 +100,6 @@ def id(self, id): def permissions(self): """ Gets the permissions of this ParameterContextReferenceEntity. - The permissions for this component. :return: The permissions of this ParameterContextReferenceEntity. :rtype: PermissionsDTO @@ -93,7 +110,6 @@ def permissions(self): def permissions(self, permissions): """ Sets the permissions of this ParameterContextReferenceEntity. - The permissions for this component. :param permissions: The permissions of this ParameterContextReferenceEntity. :type: PermissionsDTO @@ -101,27 +117,6 @@ def permissions(self, permissions): self._permissions = permissions - @property - def component(self): - """ - Gets the component of this ParameterContextReferenceEntity. - - :return: The component of this ParameterContextReferenceEntity. - :rtype: ParameterContextReferenceDTO - """ - return self._component - - @component.setter - def component(self, component): - """ - Sets the component of this ParameterContextReferenceEntity. - - :param component: The component of this ParameterContextReferenceEntity. - :type: ParameterContextReferenceDTO - """ - - self._component = component - def to_dict(self): """ Returns the model properties as a dict diff --git a/nipyapi/nifi/models/parameter_context_update_entity.py b/nipyapi/nifi/models/parameter_context_update_entity.py index e10b728a..58a3ff1d 100644 --- a/nipyapi/nifi/models/parameter_context_update_entity.py +++ b/nipyapi/nifi/models/parameter_context_update_entity.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,61 +27,35 @@ class ParameterContextUpdateEntity(object): and the value is json key in definition. """ swagger_types = { - 'parameter_context_revision': 'RevisionDTO', 'parameter_context': 'ParameterContextDTO', - 'referencing_components': 'list[AffectedComponentEntity]' - } +'parameter_context_revision': 'RevisionDTO', +'referencing_components': 'list[AffectedComponentEntity]' } attribute_map = { - 'parameter_context_revision': 'parameterContextRevision', 'parameter_context': 'parameterContext', - 'referencing_components': 'referencingComponents' - } +'parameter_context_revision': 'parameterContextRevision', +'referencing_components': 'referencingComponents' } - def __init__(self, parameter_context_revision=None, parameter_context=None, referencing_components=None): + def __init__(self, parameter_context=None, parameter_context_revision=None, referencing_components=None): """ ParameterContextUpdateEntity - a model defined in Swagger """ - self._parameter_context_revision = None self._parameter_context = None + self._parameter_context_revision = None self._referencing_components = None - if parameter_context_revision is not None: - self.parameter_context_revision = parameter_context_revision if parameter_context is not None: self.parameter_context = parameter_context + if parameter_context_revision is not None: + self.parameter_context_revision = parameter_context_revision if referencing_components is not None: self.referencing_components = referencing_components - @property - def parameter_context_revision(self): - """ - Gets the parameter_context_revision of this ParameterContextUpdateEntity. - The Revision of the Parameter Context - - :return: The parameter_context_revision of this ParameterContextUpdateEntity. - :rtype: RevisionDTO - """ - return self._parameter_context_revision - - @parameter_context_revision.setter - def parameter_context_revision(self, parameter_context_revision): - """ - Sets the parameter_context_revision of this ParameterContextUpdateEntity. - The Revision of the Parameter Context - - :param parameter_context_revision: The parameter_context_revision of this ParameterContextUpdateEntity. - :type: RevisionDTO - """ - - self._parameter_context_revision = parameter_context_revision - @property def parameter_context(self): """ Gets the parameter_context of this ParameterContextUpdateEntity. - The Parameter Context that is being operated on. This may not be populated until the request has successfully completed. :return: The parameter_context of this ParameterContextUpdateEntity. :rtype: ParameterContextDTO @@ -93,7 +66,6 @@ def parameter_context(self): def parameter_context(self, parameter_context): """ Sets the parameter_context of this ParameterContextUpdateEntity. - The Parameter Context that is being operated on. This may not be populated until the request has successfully completed. :param parameter_context: The parameter_context of this ParameterContextUpdateEntity. :type: ParameterContextDTO @@ -101,6 +73,27 @@ def parameter_context(self, parameter_context): self._parameter_context = parameter_context + @property + def parameter_context_revision(self): + """ + Gets the parameter_context_revision of this ParameterContextUpdateEntity. + + :return: The parameter_context_revision of this ParameterContextUpdateEntity. + :rtype: RevisionDTO + """ + return self._parameter_context_revision + + @parameter_context_revision.setter + def parameter_context_revision(self, parameter_context_revision): + """ + Sets the parameter_context_revision of this ParameterContextUpdateEntity. + + :param parameter_context_revision: The parameter_context_revision of this ParameterContextUpdateEntity. + :type: RevisionDTO + """ + + self._parameter_context_revision = parameter_context_revision + @property def referencing_components(self): """ diff --git a/nipyapi/nifi/models/parameter_context_update_request_dto.py b/nipyapi/nifi/models/parameter_context_update_request_dto.py index 46555aeb..c33cdc0a 100644 --- a/nipyapi/nifi/models/parameter_context_update_request_dto.py +++ b/nipyapi/nifi/models/parameter_context_update_request_dto.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,141 +27,116 @@ class ParameterContextUpdateRequestDTO(object): and the value is json key in definition. """ swagger_types = { - 'request_id': 'str', - 'uri': 'str', - 'submission_time': 'datetime', - 'last_updated': 'datetime', 'complete': 'bool', - 'failure_reason': 'str', - 'percent_completed': 'int', - 'state': 'str', - 'update_steps': 'list[ParameterContextUpdateStepDTO]', - 'parameter_context': 'ParameterContextDTO', - 'referencing_components': 'list[AffectedComponentEntity]' - } +'failure_reason': 'str', +'last_updated': 'datetime', +'parameter_context': 'ParameterContextDTO', +'percent_completed': 'int', +'referencing_components': 'list[AffectedComponentEntity]', +'request_id': 'str', +'state': 'str', +'submission_time': 'datetime', +'update_steps': 'list[ParameterContextUpdateStepDTO]', +'uri': 'str' } attribute_map = { - 'request_id': 'requestId', - 'uri': 'uri', - 'submission_time': 'submissionTime', - 'last_updated': 'lastUpdated', 'complete': 'complete', - 'failure_reason': 'failureReason', - 'percent_completed': 'percentCompleted', - 'state': 'state', - 'update_steps': 'updateSteps', - 'parameter_context': 'parameterContext', - 'referencing_components': 'referencingComponents' - } - - def __init__(self, request_id=None, uri=None, submission_time=None, last_updated=None, complete=None, failure_reason=None, percent_completed=None, state=None, update_steps=None, parameter_context=None, referencing_components=None): +'failure_reason': 'failureReason', +'last_updated': 'lastUpdated', +'parameter_context': 'parameterContext', +'percent_completed': 'percentCompleted', +'referencing_components': 'referencingComponents', +'request_id': 'requestId', +'state': 'state', +'submission_time': 'submissionTime', +'update_steps': 'updateSteps', +'uri': 'uri' } + + def __init__(self, complete=None, failure_reason=None, last_updated=None, parameter_context=None, percent_completed=None, referencing_components=None, request_id=None, state=None, submission_time=None, update_steps=None, uri=None): """ ParameterContextUpdateRequestDTO - a model defined in Swagger """ - self._request_id = None - self._uri = None - self._submission_time = None - self._last_updated = None self._complete = None self._failure_reason = None + self._last_updated = None + self._parameter_context = None self._percent_completed = None + self._referencing_components = None + self._request_id = None self._state = None + self._submission_time = None self._update_steps = None - self._parameter_context = None - self._referencing_components = None + self._uri = None - if request_id is not None: - self.request_id = request_id - if uri is not None: - self.uri = uri - if submission_time is not None: - self.submission_time = submission_time - if last_updated is not None: - self.last_updated = last_updated if complete is not None: self.complete = complete if failure_reason is not None: self.failure_reason = failure_reason + if last_updated is not None: + self.last_updated = last_updated + if parameter_context is not None: + self.parameter_context = parameter_context if percent_completed is not None: self.percent_completed = percent_completed + if referencing_components is not None: + self.referencing_components = referencing_components + 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 parameter_context is not None: - self.parameter_context = parameter_context - if referencing_components is not None: - self.referencing_components = referencing_components + if uri is not None: + self.uri = uri @property - def request_id(self): + def complete(self): """ - Gets the request_id of this ParameterContextUpdateRequestDTO. - The ID of the request + Gets the complete of this ParameterContextUpdateRequestDTO. + Whether or not the request is completed - :return: The request_id of this ParameterContextUpdateRequestDTO. - :rtype: str + :return: The complete of this ParameterContextUpdateRequestDTO. + :rtype: bool """ - return self._request_id + return self._complete - @request_id.setter - def request_id(self, request_id): + @complete.setter + def complete(self, complete): """ - Sets the request_id of this ParameterContextUpdateRequestDTO. - The ID of the request + Sets the complete of this ParameterContextUpdateRequestDTO. + Whether or not the request is completed - :param request_id: The request_id of this ParameterContextUpdateRequestDTO. - :type: str + :param complete: The complete of this ParameterContextUpdateRequestDTO. + :type: bool """ - self._request_id = request_id + self._complete = complete @property - def uri(self): + def failure_reason(self): """ - Gets the uri of this ParameterContextUpdateRequestDTO. - The URI for the request + Gets the failure_reason of this ParameterContextUpdateRequestDTO. + The reason for the request failing, or null if the request has not failed - :return: The uri of this ParameterContextUpdateRequestDTO. + :return: The failure_reason of this ParameterContextUpdateRequestDTO. :rtype: str """ - return self._uri + return self._failure_reason - @uri.setter - def uri(self, uri): + @failure_reason.setter + def failure_reason(self, failure_reason): """ - Sets the uri of this ParameterContextUpdateRequestDTO. - The URI for the request + Sets the failure_reason of this ParameterContextUpdateRequestDTO. + The reason for the request failing, or null if the request has not failed - :param uri: The uri of this ParameterContextUpdateRequestDTO. + :param failure_reason: The failure_reason of this ParameterContextUpdateRequestDTO. :type: str """ - self._uri = uri - - @property - def submission_time(self): - """ - Gets the submission_time of this ParameterContextUpdateRequestDTO. - The timestamp of when the request was submitted - - :return: The submission_time of this ParameterContextUpdateRequestDTO. - :rtype: datetime - """ - return self._submission_time - - @submission_time.setter - def submission_time(self, submission_time): - """ - Sets the submission_time of this ParameterContextUpdateRequestDTO. - The timestamp of when the request was submitted - - :param submission_time: The submission_time of this ParameterContextUpdateRequestDTO. - :type: datetime - """ - - self._submission_time = submission_time + self._failure_reason = failure_reason @property def last_updated(self): @@ -188,50 +162,25 @@ def last_updated(self, last_updated): self._last_updated = last_updated @property - def complete(self): - """ - Gets the complete of this ParameterContextUpdateRequestDTO. - Whether or not the request is completed - - :return: The complete of this ParameterContextUpdateRequestDTO. - :rtype: bool - """ - return self._complete - - @complete.setter - def complete(self, complete): - """ - Sets the complete of this ParameterContextUpdateRequestDTO. - Whether or not the request is completed - - :param complete: The complete of this ParameterContextUpdateRequestDTO. - :type: bool - """ - - self._complete = complete - - @property - def failure_reason(self): + def parameter_context(self): """ - Gets the failure_reason of this ParameterContextUpdateRequestDTO. - The reason for the request failing, or null if the request has not failed + Gets the parameter_context of this ParameterContextUpdateRequestDTO. - :return: The failure_reason of this ParameterContextUpdateRequestDTO. - :rtype: str + :return: The parameter_context of this ParameterContextUpdateRequestDTO. + :rtype: ParameterContextDTO """ - return self._failure_reason + return self._parameter_context - @failure_reason.setter - def failure_reason(self, failure_reason): + @parameter_context.setter + def parameter_context(self, parameter_context): """ - Sets the failure_reason of this ParameterContextUpdateRequestDTO. - The reason for the request failing, or null if the request has not failed + Sets the parameter_context of this ParameterContextUpdateRequestDTO. - :param failure_reason: The failure_reason of this ParameterContextUpdateRequestDTO. - :type: str + :param parameter_context: The parameter_context of this ParameterContextUpdateRequestDTO. + :type: ParameterContextDTO """ - self._failure_reason = failure_reason + self._parameter_context = parameter_context @property def percent_completed(self): @@ -256,6 +205,52 @@ def percent_completed(self, percent_completed): self._percent_completed = percent_completed + @property + def referencing_components(self): + """ + Gets the referencing_components of this ParameterContextUpdateRequestDTO. + The components that are referenced by the update. + + :return: The referencing_components of this ParameterContextUpdateRequestDTO. + :rtype: list[AffectedComponentEntity] + """ + return self._referencing_components + + @referencing_components.setter + def referencing_components(self, referencing_components): + """ + Sets the referencing_components of this ParameterContextUpdateRequestDTO. + The components that are referenced by the update. + + :param referencing_components: The referencing_components of this ParameterContextUpdateRequestDTO. + :type: list[AffectedComponentEntity] + """ + + self._referencing_components = referencing_components + + @property + def request_id(self): + """ + Gets the request_id of this ParameterContextUpdateRequestDTO. + The ID of the request + + :return: The request_id of this ParameterContextUpdateRequestDTO. + :rtype: str + """ + return self._request_id + + @request_id.setter + def request_id(self, request_id): + """ + Sets the request_id of this ParameterContextUpdateRequestDTO. + The ID of the request + + :param request_id: The request_id of this ParameterContextUpdateRequestDTO. + :type: str + """ + + self._request_id = request_id + @property def state(self): """ @@ -279,6 +274,29 @@ def state(self, state): self._state = state + @property + def submission_time(self): + """ + Gets the submission_time of this ParameterContextUpdateRequestDTO. + The timestamp of when the request was submitted + + :return: The submission_time of this ParameterContextUpdateRequestDTO. + :rtype: datetime + """ + return self._submission_time + + @submission_time.setter + def submission_time(self, submission_time): + """ + Sets the submission_time of this ParameterContextUpdateRequestDTO. + The timestamp of when the request was submitted + + :param submission_time: The submission_time of this ParameterContextUpdateRequestDTO. + :type: datetime + """ + + self._submission_time = submission_time + @property def update_steps(self): """ @@ -303,50 +321,27 @@ def update_steps(self, update_steps): self._update_steps = update_steps @property - def parameter_context(self): - """ - Gets the parameter_context of this ParameterContextUpdateRequestDTO. - The Parameter Context that is being operated on. This may not be populated until the request has successfully completed. - - :return: The parameter_context of this ParameterContextUpdateRequestDTO. - :rtype: ParameterContextDTO - """ - return self._parameter_context - - @parameter_context.setter - def parameter_context(self, parameter_context): - """ - Sets the parameter_context of this ParameterContextUpdateRequestDTO. - The Parameter Context that is being operated on. This may not be populated until the request has successfully completed. - - :param parameter_context: The parameter_context of this ParameterContextUpdateRequestDTO. - :type: ParameterContextDTO - """ - - self._parameter_context = parameter_context - - @property - def referencing_components(self): + def uri(self): """ - Gets the referencing_components of this ParameterContextUpdateRequestDTO. - The components that are referenced by the update. + Gets the uri of this ParameterContextUpdateRequestDTO. + The URI for the request - :return: The referencing_components of this ParameterContextUpdateRequestDTO. - :rtype: list[AffectedComponentEntity] + :return: The uri of this ParameterContextUpdateRequestDTO. + :rtype: str """ - return self._referencing_components + return self._uri - @referencing_components.setter - def referencing_components(self, referencing_components): + @uri.setter + def uri(self, uri): """ - Sets the referencing_components of this ParameterContextUpdateRequestDTO. - The components that are referenced by the update. + Sets the uri of this ParameterContextUpdateRequestDTO. + The URI for the request - :param referencing_components: The referencing_components of this ParameterContextUpdateRequestDTO. - :type: list[AffectedComponentEntity] + :param uri: The uri of this ParameterContextUpdateRequestDTO. + :type: str """ - self._referencing_components = referencing_components + self._uri = uri def to_dict(self): """ diff --git a/nipyapi/nifi/models/parameter_context_update_request_entity.py b/nipyapi/nifi/models/parameter_context_update_request_entity.py index 6569b184..95d85613 100644 --- a/nipyapi/nifi/models/parameter_context_update_request_entity.py +++ b/nipyapi/nifi/models/parameter_context_update_request_entity.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -29,13 +28,11 @@ class ParameterContextUpdateRequestEntity(object): """ swagger_types = { 'parameter_context_revision': 'RevisionDTO', - 'request': 'ParameterContextUpdateRequestDTO' - } +'request': 'ParameterContextUpdateRequestDTO' } attribute_map = { 'parameter_context_revision': 'parameterContextRevision', - 'request': 'request' - } +'request': 'request' } def __init__(self, parameter_context_revision=None, request=None): """ @@ -54,7 +51,6 @@ def __init__(self, parameter_context_revision=None, request=None): def parameter_context_revision(self): """ Gets the parameter_context_revision of this ParameterContextUpdateRequestEntity. - The Revision of the Parameter Context :return: The parameter_context_revision of this ParameterContextUpdateRequestEntity. :rtype: RevisionDTO @@ -65,7 +61,6 @@ def parameter_context_revision(self): def parameter_context_revision(self, parameter_context_revision): """ Sets the parameter_context_revision of this ParameterContextUpdateRequestEntity. - The Revision of the Parameter Context :param parameter_context_revision: The parameter_context_revision of this ParameterContextUpdateRequestEntity. :type: RevisionDTO @@ -77,7 +72,6 @@ def parameter_context_revision(self, parameter_context_revision): def request(self): """ Gets the request of this ParameterContextUpdateRequestEntity. - The Update Request :return: The request of this ParameterContextUpdateRequestEntity. :rtype: ParameterContextUpdateRequestDTO @@ -88,7 +82,6 @@ def request(self): def request(self, request): """ Sets the request of this ParameterContextUpdateRequestEntity. - The Update Request :param request: The request of this ParameterContextUpdateRequestEntity. :type: ParameterContextUpdateRequestDTO diff --git a/nipyapi/nifi/models/parameter_context_update_step_dto.py b/nipyapi/nifi/models/parameter_context_update_step_dto.py index 84d13b26..4e019a85 100644 --- a/nipyapi/nifi/models/parameter_context_update_step_dto.py +++ b/nipyapi/nifi/models/parameter_context_update_step_dto.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,56 +27,31 @@ class ParameterContextUpdateStepDTO(object): and the value is json key in definition. """ swagger_types = { - 'description': 'str', 'complete': 'bool', - 'failure_reason': 'str' - } +'description': 'str', +'failure_reason': 'str' } attribute_map = { - 'description': 'description', 'complete': 'complete', - 'failure_reason': 'failureReason' - } +'description': 'description', +'failure_reason': 'failureReason' } - def __init__(self, description=None, complete=None, failure_reason=None): + def __init__(self, complete=None, description=None, failure_reason=None): """ ParameterContextUpdateStepDTO - a model defined in Swagger """ - self._description = None self._complete = None + self._description = None self._failure_reason = None - if description is not None: - self.description = description 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 description(self): - """ - Gets the description of this ParameterContextUpdateStepDTO. - Explanation of what happens in this step - - :return: The description of this ParameterContextUpdateStepDTO. - :rtype: str - """ - return self._description - - @description.setter - def description(self, description): - """ - Sets the description of this ParameterContextUpdateStepDTO. - Explanation of what happens in this step - - :param description: The description of this ParameterContextUpdateStepDTO. - :type: str - """ - - self._description = description - @property def complete(self): """ @@ -101,6 +75,29 @@ def complete(self, complete): self._complete = complete + @property + def description(self): + """ + Gets the description of this ParameterContextUpdateStepDTO. + Explanation of what happens in this step + + :return: The description of this ParameterContextUpdateStepDTO. + :rtype: str + """ + return self._description + + @description.setter + def description(self, description): + """ + Sets the description of this ParameterContextUpdateStepDTO. + Explanation of what happens in this step + + :param description: The description of this ParameterContextUpdateStepDTO. + :type: str + """ + + self._description = description + @property def failure_reason(self): """ diff --git a/nipyapi/nifi/models/parameter_context_validation_request_dto.py b/nipyapi/nifi/models/parameter_context_validation_request_dto.py index c0b54ce5..e1e9cc4a 100644 --- a/nipyapi/nifi/models/parameter_context_validation_request_dto.py +++ b/nipyapi/nifi/models/parameter_context_validation_request_dto.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,141 +27,137 @@ class ParameterContextValidationRequestDTO(object): and the value is json key in definition. """ swagger_types = { - 'request_id': 'str', - 'uri': 'str', - 'submission_time': 'datetime', - 'last_updated': 'datetime', 'complete': 'bool', - 'failure_reason': 'str', - 'percent_completed': 'int', - 'state': 'str', - 'update_steps': 'list[ParameterContextValidationStepDTO]', - 'parameter_context': 'ParameterContextDTO', - 'component_validation_results': 'ComponentValidationResultsEntity' - } +'component_validation_results': 'ComponentValidationResultsEntity', +'failure_reason': 'str', +'last_updated': 'datetime', +'parameter_context': 'ParameterContextDTO', +'percent_completed': 'int', +'request_id': 'str', +'state': 'str', +'submission_time': 'datetime', +'update_steps': 'list[ParameterContextValidationStepDTO]', +'uri': 'str' } attribute_map = { - 'request_id': 'requestId', - 'uri': 'uri', - 'submission_time': 'submissionTime', - 'last_updated': 'lastUpdated', 'complete': 'complete', - 'failure_reason': 'failureReason', - 'percent_completed': 'percentCompleted', - 'state': 'state', - 'update_steps': 'updateSteps', - 'parameter_context': 'parameterContext', - 'component_validation_results': 'componentValidationResults' - } - - def __init__(self, request_id=None, uri=None, submission_time=None, last_updated=None, complete=None, failure_reason=None, percent_completed=None, state=None, update_steps=None, parameter_context=None, component_validation_results=None): +'component_validation_results': 'componentValidationResults', +'failure_reason': 'failureReason', +'last_updated': 'lastUpdated', +'parameter_context': 'parameterContext', +'percent_completed': 'percentCompleted', +'request_id': 'requestId', +'state': 'state', +'submission_time': 'submissionTime', +'update_steps': 'updateSteps', +'uri': 'uri' } + + def __init__(self, complete=None, component_validation_results=None, failure_reason=None, last_updated=None, parameter_context=None, percent_completed=None, request_id=None, state=None, submission_time=None, update_steps=None, uri=None): """ ParameterContextValidationRequestDTO - a model defined in Swagger """ - self._request_id = None - self._uri = None - self._submission_time = None - self._last_updated = None self._complete = None + self._component_validation_results = None self._failure_reason = None + self._last_updated = None + self._parameter_context = None self._percent_completed = None + self._request_id = None self._state = None + self._submission_time = None self._update_steps = None - self._parameter_context = None - self._component_validation_results = None + self._uri = None - if request_id is not None: - self.request_id = request_id - if uri is not None: - self.uri = uri - if submission_time is not None: - self.submission_time = submission_time - if last_updated is not None: - self.last_updated = last_updated if complete is not None: self.complete = complete + if component_validation_results is not None: + self.component_validation_results = component_validation_results if failure_reason is not None: self.failure_reason = failure_reason + if last_updated is not None: + self.last_updated = last_updated + if parameter_context is not None: + self.parameter_context = parameter_context 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 parameter_context is not None: - self.parameter_context = parameter_context - if component_validation_results is not None: - self.component_validation_results = component_validation_results + if uri is not None: + self.uri = uri @property - def request_id(self): + def complete(self): """ - Gets the request_id of this ParameterContextValidationRequestDTO. - The ID of the request + Gets the complete of this ParameterContextValidationRequestDTO. + Whether or not the request is completed - :return: The request_id of this ParameterContextValidationRequestDTO. - :rtype: str + :return: The complete of this ParameterContextValidationRequestDTO. + :rtype: bool """ - return self._request_id + return self._complete - @request_id.setter - def request_id(self, request_id): + @complete.setter + def complete(self, complete): """ - Sets the request_id of this ParameterContextValidationRequestDTO. - The ID of the request + Sets the complete of this ParameterContextValidationRequestDTO. + Whether or not the request is completed - :param request_id: The request_id of this ParameterContextValidationRequestDTO. - :type: str + :param complete: The complete of this ParameterContextValidationRequestDTO. + :type: bool """ - self._request_id = request_id + self._complete = complete @property - def uri(self): + def component_validation_results(self): """ - Gets the uri of this ParameterContextValidationRequestDTO. - The URI for the request + Gets the component_validation_results of this ParameterContextValidationRequestDTO. - :return: The uri of this ParameterContextValidationRequestDTO. - :rtype: str + :return: The component_validation_results of this ParameterContextValidationRequestDTO. + :rtype: ComponentValidationResultsEntity """ - return self._uri + return self._component_validation_results - @uri.setter - def uri(self, uri): + @component_validation_results.setter + def component_validation_results(self, component_validation_results): """ - Sets the uri of this ParameterContextValidationRequestDTO. - The URI for the request + Sets the component_validation_results of this ParameterContextValidationRequestDTO. - :param uri: The uri of this ParameterContextValidationRequestDTO. - :type: str + :param component_validation_results: The component_validation_results of this ParameterContextValidationRequestDTO. + :type: ComponentValidationResultsEntity """ - self._uri = uri + self._component_validation_results = component_validation_results @property - def submission_time(self): + def failure_reason(self): """ - Gets the submission_time of this ParameterContextValidationRequestDTO. - The timestamp of when the request was submitted + Gets the failure_reason of this ParameterContextValidationRequestDTO. + The reason for the request failing, or null if the request has not failed - :return: The submission_time of this ParameterContextValidationRequestDTO. - :rtype: datetime + :return: The failure_reason of this ParameterContextValidationRequestDTO. + :rtype: str """ - return self._submission_time + return self._failure_reason - @submission_time.setter - def submission_time(self, submission_time): + @failure_reason.setter + def failure_reason(self, failure_reason): """ - Sets the submission_time of this ParameterContextValidationRequestDTO. - The timestamp of when the request was submitted + Sets the failure_reason of this ParameterContextValidationRequestDTO. + The reason for the request failing, or null if the request has not failed - :param submission_time: The submission_time of this ParameterContextValidationRequestDTO. - :type: datetime + :param failure_reason: The failure_reason of this ParameterContextValidationRequestDTO. + :type: str """ - self._submission_time = submission_time + self._failure_reason = failure_reason @property def last_updated(self): @@ -188,50 +183,25 @@ def last_updated(self, last_updated): self._last_updated = last_updated @property - def complete(self): - """ - Gets the complete of this ParameterContextValidationRequestDTO. - Whether or not the request is completed - - :return: The complete of this ParameterContextValidationRequestDTO. - :rtype: bool - """ - return self._complete - - @complete.setter - def complete(self, complete): - """ - Sets the complete of this ParameterContextValidationRequestDTO. - Whether or not the request is completed - - :param complete: The complete of this ParameterContextValidationRequestDTO. - :type: bool - """ - - self._complete = complete - - @property - def failure_reason(self): + def parameter_context(self): """ - Gets the failure_reason of this ParameterContextValidationRequestDTO. - The reason for the request failing, or null if the request has not failed + Gets the parameter_context of this ParameterContextValidationRequestDTO. - :return: The failure_reason of this ParameterContextValidationRequestDTO. - :rtype: str + :return: The parameter_context of this ParameterContextValidationRequestDTO. + :rtype: ParameterContextDTO """ - return self._failure_reason + return self._parameter_context - @failure_reason.setter - def failure_reason(self, failure_reason): + @parameter_context.setter + def parameter_context(self, parameter_context): """ - Sets the failure_reason of this ParameterContextValidationRequestDTO. - The reason for the request failing, or null if the request has not failed + Sets the parameter_context of this ParameterContextValidationRequestDTO. - :param failure_reason: The failure_reason of this ParameterContextValidationRequestDTO. - :type: str + :param parameter_context: The parameter_context of this ParameterContextValidationRequestDTO. + :type: ParameterContextDTO """ - self._failure_reason = failure_reason + self._parameter_context = parameter_context @property def percent_completed(self): @@ -256,6 +226,29 @@ def percent_completed(self, percent_completed): self._percent_completed = percent_completed + @property + def request_id(self): + """ + Gets the request_id of this ParameterContextValidationRequestDTO. + The ID of the request + + :return: The request_id of this ParameterContextValidationRequestDTO. + :rtype: str + """ + return self._request_id + + @request_id.setter + def request_id(self, request_id): + """ + Sets the request_id of this ParameterContextValidationRequestDTO. + The ID of the request + + :param request_id: The request_id of this ParameterContextValidationRequestDTO. + :type: str + """ + + self._request_id = request_id + @property def state(self): """ @@ -279,6 +272,29 @@ def state(self, state): self._state = state + @property + def submission_time(self): + """ + Gets the submission_time of this ParameterContextValidationRequestDTO. + The timestamp of when the request was submitted + + :return: The submission_time of this ParameterContextValidationRequestDTO. + :rtype: datetime + """ + return self._submission_time + + @submission_time.setter + def submission_time(self, submission_time): + """ + Sets the submission_time of this ParameterContextValidationRequestDTO. + The timestamp of when the request was submitted + + :param submission_time: The submission_time of this ParameterContextValidationRequestDTO. + :type: datetime + """ + + self._submission_time = submission_time + @property def update_steps(self): """ @@ -303,50 +319,27 @@ def update_steps(self, update_steps): self._update_steps = update_steps @property - def parameter_context(self): - """ - Gets the parameter_context of this ParameterContextValidationRequestDTO. - The Parameter Context that is being operated on. - - :return: The parameter_context of this ParameterContextValidationRequestDTO. - :rtype: ParameterContextDTO - """ - return self._parameter_context - - @parameter_context.setter - def parameter_context(self, parameter_context): - """ - Sets the parameter_context of this ParameterContextValidationRequestDTO. - The Parameter Context that is being operated on. - - :param parameter_context: The parameter_context of this ParameterContextValidationRequestDTO. - :type: ParameterContextDTO - """ - - self._parameter_context = parameter_context - - @property - def component_validation_results(self): + def uri(self): """ - Gets the component_validation_results of this ParameterContextValidationRequestDTO. - The Validation Results that were calculated for each component. This value may not be set until the request completes. + Gets the uri of this ParameterContextValidationRequestDTO. + The URI for the request - :return: The component_validation_results of this ParameterContextValidationRequestDTO. - :rtype: ComponentValidationResultsEntity + :return: The uri of this ParameterContextValidationRequestDTO. + :rtype: str """ - return self._component_validation_results + return self._uri - @component_validation_results.setter - def component_validation_results(self, component_validation_results): + @uri.setter + def uri(self, uri): """ - Sets the component_validation_results of this ParameterContextValidationRequestDTO. - The Validation Results that were calculated for each component. This value may not be set until the request completes. + Sets the uri of this ParameterContextValidationRequestDTO. + The URI for the request - :param component_validation_results: The component_validation_results of this ParameterContextValidationRequestDTO. - :type: ComponentValidationResultsEntity + :param uri: The uri of this ParameterContextValidationRequestDTO. + :type: str """ - self._component_validation_results = component_validation_results + self._uri = uri def to_dict(self): """ diff --git a/nipyapi/nifi/models/parameter_context_validation_request_entity.py b/nipyapi/nifi/models/parameter_context_validation_request_entity.py index 8f6a007a..ab485bbf 100644 --- a/nipyapi/nifi/models/parameter_context_validation_request_entity.py +++ b/nipyapi/nifi/models/parameter_context_validation_request_entity.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,50 +27,25 @@ class ParameterContextValidationRequestEntity(object): and the value is json key in definition. """ swagger_types = { - 'request': 'ParameterContextValidationRequestDTO', - 'disconnected_node_acknowledged': 'bool' - } + 'disconnected_node_acknowledged': 'bool', +'request': 'ParameterContextValidationRequestDTO' } attribute_map = { - 'request': 'request', - 'disconnected_node_acknowledged': 'disconnectedNodeAcknowledged' - } + 'disconnected_node_acknowledged': 'disconnectedNodeAcknowledged', +'request': 'request' } - def __init__(self, request=None, disconnected_node_acknowledged=None): + def __init__(self, disconnected_node_acknowledged=None, request=None): """ ParameterContextValidationRequestEntity - a model defined in Swagger """ - self._request = None self._disconnected_node_acknowledged = None + self._request = None - if request is not None: - self.request = request if disconnected_node_acknowledged is not None: self.disconnected_node_acknowledged = disconnected_node_acknowledged - - @property - def request(self): - """ - Gets the request of this ParameterContextValidationRequestEntity. - The Update Request - - :return: The request of this ParameterContextValidationRequestEntity. - :rtype: ParameterContextValidationRequestDTO - """ - return self._request - - @request.setter - def request(self, request): - """ - Sets the request of this ParameterContextValidationRequestEntity. - The Update Request - - :param request: The request of this ParameterContextValidationRequestEntity. - :type: ParameterContextValidationRequestDTO - """ - - self._request = request + if request is not None: + self.request = request @property def disconnected_node_acknowledged(self): @@ -96,6 +70,27 @@ def disconnected_node_acknowledged(self, disconnected_node_acknowledged): self._disconnected_node_acknowledged = disconnected_node_acknowledged + @property + def request(self): + """ + Gets the request of this ParameterContextValidationRequestEntity. + + :return: The request of this ParameterContextValidationRequestEntity. + :rtype: ParameterContextValidationRequestDTO + """ + return self._request + + @request.setter + def request(self, request): + """ + Sets the request of this ParameterContextValidationRequestEntity. + + :param request: The request of this ParameterContextValidationRequestEntity. + :type: ParameterContextValidationRequestDTO + """ + + self._request = request + def to_dict(self): """ Returns the model properties as a dict diff --git a/nipyapi/nifi/models/parameter_context_validation_step_dto.py b/nipyapi/nifi/models/parameter_context_validation_step_dto.py index c585e43e..a85bfafc 100644 --- a/nipyapi/nifi/models/parameter_context_validation_step_dto.py +++ b/nipyapi/nifi/models/parameter_context_validation_step_dto.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,56 +27,31 @@ class ParameterContextValidationStepDTO(object): and the value is json key in definition. """ swagger_types = { - 'description': 'str', 'complete': 'bool', - 'failure_reason': 'str' - } +'description': 'str', +'failure_reason': 'str' } attribute_map = { - 'description': 'description', 'complete': 'complete', - 'failure_reason': 'failureReason' - } +'description': 'description', +'failure_reason': 'failureReason' } - def __init__(self, description=None, complete=None, failure_reason=None): + def __init__(self, complete=None, description=None, failure_reason=None): """ ParameterContextValidationStepDTO - a model defined in Swagger """ - self._description = None self._complete = None + self._description = None self._failure_reason = None - if description is not None: - self.description = description 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 description(self): - """ - Gets the description of this ParameterContextValidationStepDTO. - Explanation of what happens in this step - - :return: The description of this ParameterContextValidationStepDTO. - :rtype: str - """ - return self._description - - @description.setter - def description(self, description): - """ - Sets the description of this ParameterContextValidationStepDTO. - Explanation of what happens in this step - - :param description: The description of this ParameterContextValidationStepDTO. - :type: str - """ - - self._description = description - @property def complete(self): """ @@ -101,6 +75,29 @@ def complete(self, complete): self._complete = complete + @property + def description(self): + """ + Gets the description of this ParameterContextValidationStepDTO. + Explanation of what happens in this step + + :return: The description of this ParameterContextValidationStepDTO. + :rtype: str + """ + return self._description + + @description.setter + def description(self, description): + """ + Sets the description of this ParameterContextValidationStepDTO. + Explanation of what happens in this step + + :param description: The description of this ParameterContextValidationStepDTO. + :type: str + """ + + self._description = description + @property def failure_reason(self): """ diff --git a/nipyapi/nifi/models/parameter_contexts_entity.py b/nipyapi/nifi/models/parameter_contexts_entity.py index d9a48896..098c3b70 100644 --- a/nipyapi/nifi/models/parameter_contexts_entity.py +++ b/nipyapi/nifi/models/parameter_contexts_entity.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,50 +27,25 @@ class ParameterContextsEntity(object): and the value is json key in definition. """ swagger_types = { - 'parameter_contexts': 'list[ParameterContextEntity]', - 'current_time': 'str' - } + 'current_time': 'str', +'parameter_contexts': 'list[ParameterContextEntity]' } attribute_map = { - 'parameter_contexts': 'parameterContexts', - 'current_time': 'currentTime' - } + 'current_time': 'currentTime', +'parameter_contexts': 'parameterContexts' } - def __init__(self, parameter_contexts=None, current_time=None): + def __init__(self, current_time=None, parameter_contexts=None): """ ParameterContextsEntity - a model defined in Swagger """ - self._parameter_contexts = None self._current_time = None + self._parameter_contexts = None - if parameter_contexts is not None: - self.parameter_contexts = parameter_contexts if current_time is not None: self.current_time = current_time - - @property - def parameter_contexts(self): - """ - Gets the parameter_contexts of this ParameterContextsEntity. - The Parameter Contexts - - :return: The parameter_contexts of this ParameterContextsEntity. - :rtype: list[ParameterContextEntity] - """ - return self._parameter_contexts - - @parameter_contexts.setter - def parameter_contexts(self, parameter_contexts): - """ - Sets the parameter_contexts of this ParameterContextsEntity. - The Parameter Contexts - - :param parameter_contexts: The parameter_contexts of this ParameterContextsEntity. - :type: list[ParameterContextEntity] - """ - - self._parameter_contexts = parameter_contexts + if parameter_contexts is not None: + self.parameter_contexts = parameter_contexts @property def current_time(self): @@ -96,6 +70,29 @@ def current_time(self, current_time): self._current_time = current_time + @property + def parameter_contexts(self): + """ + Gets the parameter_contexts of this ParameterContextsEntity. + The Parameter Contexts + + :return: The parameter_contexts of this ParameterContextsEntity. + :rtype: list[ParameterContextEntity] + """ + return self._parameter_contexts + + @parameter_contexts.setter + def parameter_contexts(self, parameter_contexts): + """ + Sets the parameter_contexts of this ParameterContextsEntity. + The Parameter Contexts + + :param parameter_contexts: The parameter_contexts of this ParameterContextsEntity. + :type: list[ParameterContextEntity] + """ + + self._parameter_contexts = parameter_contexts + def to_dict(self): """ Returns the model properties as a dict diff --git a/nipyapi/nifi/models/parameter_dto.py b/nipyapi/nifi/models/parameter_dto.py index 7fb52191..351c7796 100644 --- a/nipyapi/nifi/models/parameter_dto.py +++ b/nipyapi/nifi/models/parameter_dto.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,85 +27,65 @@ class ParameterDTO(object): and the value is json key in definition. """ swagger_types = { - 'name': 'str', 'description': 'str', - 'sensitive': 'bool', - 'value': 'str', - 'value_removed': 'bool', - 'provided': 'bool', - 'referencing_components': 'list[AffectedComponentEntity]', - 'parameter_context': 'ParameterContextReferenceEntity', - 'inherited': 'bool' - } +'inherited': 'bool', +'name': 'str', +'parameter_context': 'ParameterContextReferenceEntity', +'provided': 'bool', +'referenced_assets': 'list[AssetReferenceDTO]', +'referencing_components': 'list[AffectedComponentEntity]', +'sensitive': 'bool', +'value': 'str', +'value_removed': 'bool' } attribute_map = { - 'name': 'name', 'description': 'description', - 'sensitive': 'sensitive', - 'value': 'value', - 'value_removed': 'valueRemoved', - 'provided': 'provided', - 'referencing_components': 'referencingComponents', - 'parameter_context': 'parameterContext', - 'inherited': 'inherited' - } - - def __init__(self, name=None, description=None, sensitive=None, value=None, value_removed=None, provided=None, referencing_components=None, parameter_context=None, inherited=None): +'inherited': 'inherited', +'name': 'name', +'parameter_context': 'parameterContext', +'provided': 'provided', +'referenced_assets': 'referencedAssets', +'referencing_components': 'referencingComponents', +'sensitive': 'sensitive', +'value': 'value', +'value_removed': 'valueRemoved' } + + def __init__(self, description=None, inherited=None, name=None, parameter_context=None, provided=None, referenced_assets=None, referencing_components=None, sensitive=None, value=None, value_removed=None): """ ParameterDTO - a model defined in Swagger """ - self._name = None self._description = None + self._inherited = None + self._name = None + self._parameter_context = None + self._provided = None + self._referenced_assets = None + self._referencing_components = None self._sensitive = None self._value = None self._value_removed = None - self._provided = None - self._referencing_components = None - self._parameter_context = None - self._inherited = None - if name is not None: - self.name = name if description is not None: self.description = description + if inherited is not None: + self.inherited = inherited + if name is not None: + self.name = name + if parameter_context is not None: + self.parameter_context = parameter_context + if provided is not None: + self.provided = provided + if referenced_assets is not None: + self.referenced_assets = referenced_assets + if referencing_components is not None: + self.referencing_components = referencing_components if sensitive is not None: self.sensitive = sensitive if value is not None: self.value = value if value_removed is not None: self.value_removed = value_removed - if provided is not None: - self.provided = provided - if referencing_components is not None: - self.referencing_components = referencing_components - if parameter_context is not None: - self.parameter_context = parameter_context - if inherited is not None: - self.inherited = inherited - - @property - def name(self): - """ - Gets the name of this ParameterDTO. - The name of the Parameter - - :return: The name of this ParameterDTO. - :rtype: str - """ - return self._name - - @name.setter - def name(self, name): - """ - Sets the name of this ParameterDTO. - The name of the Parameter - - :param name: The name of this ParameterDTO. - :type: str - """ - - self._name = name @property def description(self): @@ -132,73 +111,71 @@ def description(self, description): self._description = description @property - def sensitive(self): + def inherited(self): """ - Gets the sensitive of this ParameterDTO. - Whether or not the Parameter is sensitive + Gets the inherited of this ParameterDTO. + Whether or not the Parameter is inherited from another context - :return: The sensitive of this ParameterDTO. + :return: The inherited of this ParameterDTO. :rtype: bool """ - return self._sensitive + return self._inherited - @sensitive.setter - def sensitive(self, sensitive): + @inherited.setter + def inherited(self, inherited): """ - Sets the sensitive of this ParameterDTO. - Whether or not the Parameter is sensitive + Sets the inherited of this ParameterDTO. + Whether or not the Parameter is inherited from another context - :param sensitive: The sensitive of this ParameterDTO. + :param inherited: The inherited of this ParameterDTO. :type: bool """ - self._sensitive = sensitive + self._inherited = inherited @property - def value(self): + def name(self): """ - Gets the value of this ParameterDTO. - The value of the Parameter + Gets the name of this ParameterDTO. + The name of the Parameter - :return: The value of this ParameterDTO. + :return: The name of this ParameterDTO. :rtype: str """ - return self._value + return self._name - @value.setter - def value(self, value): + @name.setter + def name(self, name): """ - Sets the value of this ParameterDTO. - The value of the Parameter + Sets the name of this ParameterDTO. + The name of the Parameter - :param value: The value of this ParameterDTO. + :param name: The name of this ParameterDTO. :type: str """ - self._value = value + self._name = name @property - def value_removed(self): + def parameter_context(self): """ - Gets the value_removed of this ParameterDTO. - Whether or not the value of the Parameter was removed. When a request is made to change a parameter, the value may be null. The 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). This denotes which of the two scenarios is being encountered. + Gets the parameter_context of this ParameterDTO. - :return: The value_removed of this ParameterDTO. - :rtype: bool + :return: The parameter_context of this ParameterDTO. + :rtype: ParameterContextReferenceEntity """ - return self._value_removed + return self._parameter_context - @value_removed.setter - def value_removed(self, value_removed): + @parameter_context.setter + def parameter_context(self, parameter_context): """ - Sets the value_removed of this ParameterDTO. - Whether or not the value of the Parameter was removed. When a request is made to change a parameter, the value may be null. The 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). This denotes which of the two scenarios is being encountered. + Sets the parameter_context of this ParameterDTO. - :param value_removed: The value_removed of this ParameterDTO. - :type: bool + :param parameter_context: The parameter_context of this ParameterDTO. + :type: ParameterContextReferenceEntity """ - self._value_removed = value_removed + self._parameter_context = parameter_context @property def provided(self): @@ -223,6 +200,29 @@ def provided(self, provided): self._provided = provided + @property + def referenced_assets(self): + """ + Gets the referenced_assets of this ParameterDTO. + A list of identifiers of the assets that are referenced by the parameter + + :return: The referenced_assets of this ParameterDTO. + :rtype: list[AssetReferenceDTO] + """ + return self._referenced_assets + + @referenced_assets.setter + def referenced_assets(self, referenced_assets): + """ + Sets the referenced_assets of this ParameterDTO. + A list of identifiers of the assets that are referenced by the parameter + + :param referenced_assets: The referenced_assets of this ParameterDTO. + :type: list[AssetReferenceDTO] + """ + + self._referenced_assets = referenced_assets + @property def referencing_components(self): """ @@ -247,50 +247,73 @@ def referencing_components(self, referencing_components): self._referencing_components = referencing_components @property - def parameter_context(self): + def sensitive(self): """ - Gets the parameter_context of this ParameterDTO. - A reference to the Parameter Context that contains this one + Gets the sensitive of this ParameterDTO. + Whether or not the Parameter is sensitive - :return: The parameter_context of this ParameterDTO. - :rtype: ParameterContextReferenceEntity + :return: The sensitive of this ParameterDTO. + :rtype: bool """ - return self._parameter_context + return self._sensitive - @parameter_context.setter - def parameter_context(self, parameter_context): + @sensitive.setter + def sensitive(self, sensitive): """ - Sets the parameter_context of this ParameterDTO. - A reference to the Parameter Context that contains this one + Sets the sensitive of this ParameterDTO. + Whether or not the Parameter is sensitive - :param parameter_context: The parameter_context of this ParameterDTO. - :type: ParameterContextReferenceEntity + :param sensitive: The sensitive of this ParameterDTO. + :type: bool """ - self._parameter_context = parameter_context + self._sensitive = sensitive @property - def inherited(self): + def value(self): """ - Gets the inherited of this ParameterDTO. - Whether or not the Parameter is inherited from another context + Gets the value of this ParameterDTO. + The value of the Parameter - :return: The inherited of this ParameterDTO. + :return: The value of this ParameterDTO. + :rtype: str + """ + return self._value + + @value.setter + def value(self, value): + """ + Sets the value of this ParameterDTO. + The value of the Parameter + + :param value: The value of this ParameterDTO. + :type: str + """ + + self._value = value + + @property + def value_removed(self): + """ + Gets the value_removed of this ParameterDTO. + Whether or not the value of the Parameter was removed. When a request is made to change a parameter, the value may be null. The 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). This denotes which of the two scenarios is being encountered. + + :return: The value_removed of this ParameterDTO. :rtype: bool """ - return self._inherited + return self._value_removed - @inherited.setter - def inherited(self, inherited): + @value_removed.setter + def value_removed(self, value_removed): """ - Sets the inherited of this ParameterDTO. - Whether or not the Parameter is inherited from another context + Sets the value_removed of this ParameterDTO. + Whether or not the value of the Parameter was removed. When a request is made to change a parameter, the value may be null. The 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). This denotes which of the two scenarios is being encountered. - :param inherited: The inherited of this ParameterDTO. + :param value_removed: The value_removed of this ParameterDTO. :type: bool """ - self._inherited = inherited + self._value_removed = value_removed def to_dict(self): """ diff --git a/nipyapi/nifi/models/parameter_entity.py b/nipyapi/nifi/models/parameter_entity.py index 4aae3906..1aa85953 100644 --- a/nipyapi/nifi/models/parameter_entity.py +++ b/nipyapi/nifi/models/parameter_entity.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -29,13 +28,11 @@ class ParameterEntity(object): """ swagger_types = { 'can_write': 'bool', - 'parameter': 'ParameterDTO' - } +'parameter': 'ParameterDTO' } attribute_map = { 'can_write': 'canWrite', - 'parameter': 'parameter' - } +'parameter': 'parameter' } def __init__(self, can_write=None, parameter=None): """ @@ -77,7 +74,6 @@ def can_write(self, can_write): def parameter(self): """ Gets the parameter of this ParameterEntity. - The parameter information :return: The parameter of this ParameterEntity. :rtype: ParameterDTO @@ -88,7 +84,6 @@ def parameter(self): def parameter(self, parameter): """ Sets the parameter of this ParameterEntity. - The parameter information :param parameter: The parameter of this ParameterEntity. :type: ParameterDTO diff --git a/nipyapi/nifi/models/parameter_group_configuration_entity.py b/nipyapi/nifi/models/parameter_group_configuration_entity.py index f7657252..99ac6c2b 100644 --- a/nipyapi/nifi/models/parameter_group_configuration_entity.py +++ b/nipyapi/nifi/models/parameter_group_configuration_entity.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -29,17 +28,15 @@ class ParameterGroupConfigurationEntity(object): """ swagger_types = { 'group_name': 'str', - 'parameter_context_name': 'str', - 'parameter_sensitivities': 'dict(str, str)', - 'synchronized': 'bool' - } +'parameter_context_name': 'str', +'parameter_sensitivities': 'dict(str, str)', +'synchronized': 'bool' } attribute_map = { 'group_name': 'groupName', - 'parameter_context_name': 'parameterContextName', - 'parameter_sensitivities': 'parameterSensitivities', - 'synchronized': 'synchronized' - } +'parameter_context_name': 'parameterContextName', +'parameter_sensitivities': 'parameterSensitivities', +'synchronized': 'synchronized' } def __init__(self, group_name=None, parameter_context_name=None, parameter_sensitivities=None, synchronized=None): """ @@ -126,7 +123,7 @@ def parameter_sensitivities(self, parameter_sensitivities): :param parameter_sensitivities: The parameter_sensitivities of this ParameterGroupConfigurationEntity. :type: dict(str, str) """ - allowed_values = ["SENSITIVE", "NON_SENSITIVE"] + 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}]" 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 51ab7a64..a4a7c415 100644 --- a/nipyapi/nifi/models/parameter_provider_apply_parameters_request_dto.py +++ b/nipyapi/nifi/models/parameter_provider_apply_parameters_request_dto.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,146 +27,121 @@ class ParameterProviderApplyParametersRequestDTO(object): and the value is json key in definition. """ swagger_types = { - 'request_id': 'str', - 'uri': 'str', - 'submission_time': 'datetime', - 'last_updated': 'datetime', 'complete': 'bool', - 'failure_reason': 'str', - 'percent_completed': 'int', - 'state': 'str', - 'update_steps': 'list[ParameterProviderApplyParametersUpdateStepDTO]', - 'parameter_provider': 'ParameterProviderDTO', - 'parameter_context_updates': 'list[ParameterContextUpdateEntity]', - 'referencing_components': 'list[AffectedComponentEntity]' - } +'failure_reason': 'str', +'last_updated': 'datetime', +'parameter_context_updates': 'list[ParameterContextUpdateEntity]', +'parameter_provider': 'ParameterProviderDTO', +'percent_completed': 'int', +'referencing_components': 'list[AffectedComponentEntity]', +'request_id': 'str', +'state': 'str', +'submission_time': 'datetime', +'update_steps': 'list[ParameterProviderApplyParametersUpdateStepDTO]', +'uri': 'str' } attribute_map = { - 'request_id': 'requestId', - 'uri': 'uri', - 'submission_time': 'submissionTime', - 'last_updated': 'lastUpdated', 'complete': 'complete', - 'failure_reason': 'failureReason', - 'percent_completed': 'percentCompleted', - 'state': 'state', - 'update_steps': 'updateSteps', - 'parameter_provider': 'parameterProvider', - 'parameter_context_updates': 'parameterContextUpdates', - 'referencing_components': 'referencingComponents' - } - - def __init__(self, request_id=None, uri=None, submission_time=None, last_updated=None, complete=None, failure_reason=None, percent_completed=None, state=None, update_steps=None, parameter_provider=None, parameter_context_updates=None, referencing_components=None): +'failure_reason': 'failureReason', +'last_updated': 'lastUpdated', +'parameter_context_updates': 'parameterContextUpdates', +'parameter_provider': 'parameterProvider', +'percent_completed': 'percentCompleted', +'referencing_components': 'referencingComponents', +'request_id': 'requestId', +'state': 'state', +'submission_time': 'submissionTime', +'update_steps': 'updateSteps', +'uri': 'uri' } + + def __init__(self, complete=None, failure_reason=None, last_updated=None, parameter_context_updates=None, parameter_provider=None, percent_completed=None, referencing_components=None, request_id=None, state=None, submission_time=None, update_steps=None, uri=None): """ ParameterProviderApplyParametersRequestDTO - a model defined in Swagger """ - self._request_id = None - self._uri = None - self._submission_time = None - self._last_updated = None self._complete = None self._failure_reason = None + self._last_updated = None + self._parameter_context_updates = None + self._parameter_provider = None self._percent_completed = None + self._referencing_components = None + self._request_id = None self._state = None + self._submission_time = None self._update_steps = None - self._parameter_provider = None - self._parameter_context_updates = None - self._referencing_components = None + self._uri = None - if request_id is not None: - self.request_id = request_id - if uri is not None: - self.uri = uri - if submission_time is not None: - self.submission_time = submission_time - if last_updated is not None: - self.last_updated = last_updated if complete is not None: self.complete = complete if failure_reason is not None: self.failure_reason = failure_reason + if last_updated is not None: + self.last_updated = last_updated + if parameter_context_updates is not None: + self.parameter_context_updates = parameter_context_updates + if parameter_provider is not None: + self.parameter_provider = parameter_provider if percent_completed is not None: self.percent_completed = percent_completed + if referencing_components is not None: + self.referencing_components = referencing_components + 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 parameter_provider is not None: - self.parameter_provider = parameter_provider - if parameter_context_updates is not None: - self.parameter_context_updates = parameter_context_updates - if referencing_components is not None: - self.referencing_components = referencing_components + if uri is not None: + self.uri = uri @property - def request_id(self): + def complete(self): """ - Gets the request_id of this ParameterProviderApplyParametersRequestDTO. - The ID of the request + Gets the complete of this ParameterProviderApplyParametersRequestDTO. + Whether or not the request is completed - :return: The request_id of this ParameterProviderApplyParametersRequestDTO. - :rtype: str + :return: The complete of this ParameterProviderApplyParametersRequestDTO. + :rtype: bool """ - return self._request_id + return self._complete - @request_id.setter - def request_id(self, request_id): + @complete.setter + def complete(self, complete): """ - Sets the request_id of this ParameterProviderApplyParametersRequestDTO. - The ID of the request + Sets the complete of this ParameterProviderApplyParametersRequestDTO. + Whether or not the request is completed - :param request_id: The request_id of this ParameterProviderApplyParametersRequestDTO. - :type: str + :param complete: The complete of this ParameterProviderApplyParametersRequestDTO. + :type: bool """ - self._request_id = request_id + self._complete = complete @property - def uri(self): + def failure_reason(self): """ - Gets the uri of this ParameterProviderApplyParametersRequestDTO. - The URI for the request + Gets the failure_reason of this ParameterProviderApplyParametersRequestDTO. + The reason for the request failing, or null if the request has not failed - :return: The uri of this ParameterProviderApplyParametersRequestDTO. + :return: The failure_reason of this ParameterProviderApplyParametersRequestDTO. :rtype: str """ - return self._uri + return self._failure_reason - @uri.setter - def uri(self, uri): + @failure_reason.setter + def failure_reason(self, failure_reason): """ - Sets the uri of this ParameterProviderApplyParametersRequestDTO. - The URI for the request + Sets the failure_reason of this ParameterProviderApplyParametersRequestDTO. + The reason for the request failing, or null if the request has not failed - :param uri: The uri of this ParameterProviderApplyParametersRequestDTO. + :param failure_reason: The failure_reason of this ParameterProviderApplyParametersRequestDTO. :type: str """ - self._uri = uri - - @property - def submission_time(self): - """ - Gets the submission_time of this ParameterProviderApplyParametersRequestDTO. - The timestamp of when the request was submitted - - :return: The submission_time of this ParameterProviderApplyParametersRequestDTO. - :rtype: datetime - """ - return self._submission_time - - @submission_time.setter - def submission_time(self, submission_time): - """ - Sets the submission_time of this ParameterProviderApplyParametersRequestDTO. - The timestamp of when the request was submitted - - :param submission_time: The submission_time of this ParameterProviderApplyParametersRequestDTO. - :type: datetime - """ - - self._submission_time = submission_time + self._failure_reason = failure_reason @property def last_updated(self): @@ -193,50 +167,48 @@ def last_updated(self, last_updated): self._last_updated = last_updated @property - def complete(self): + def parameter_context_updates(self): """ - Gets the complete of this ParameterProviderApplyParametersRequestDTO. - Whether or not the request is completed + Gets the parameter_context_updates of this ParameterProviderApplyParametersRequestDTO. + The Parameter Contexts updated by this Parameter Provider. This may not be populated until the request has successfully completed. - :return: The complete of this ParameterProviderApplyParametersRequestDTO. - :rtype: bool + :return: The parameter_context_updates of this ParameterProviderApplyParametersRequestDTO. + :rtype: list[ParameterContextUpdateEntity] """ - return self._complete + return self._parameter_context_updates - @complete.setter - def complete(self, complete): + @parameter_context_updates.setter + def parameter_context_updates(self, parameter_context_updates): """ - Sets the complete of this ParameterProviderApplyParametersRequestDTO. - Whether or not the request is completed + Sets the parameter_context_updates of this ParameterProviderApplyParametersRequestDTO. + The Parameter Contexts updated by this Parameter Provider. This may not be populated until the request has successfully completed. - :param complete: The complete of this ParameterProviderApplyParametersRequestDTO. - :type: bool + :param parameter_context_updates: The parameter_context_updates of this ParameterProviderApplyParametersRequestDTO. + :type: list[ParameterContextUpdateEntity] """ - self._complete = complete + self._parameter_context_updates = parameter_context_updates @property - def failure_reason(self): + def parameter_provider(self): """ - Gets the failure_reason of this ParameterProviderApplyParametersRequestDTO. - The reason for the request failing, or null if the request has not failed + Gets the parameter_provider of this ParameterProviderApplyParametersRequestDTO. - :return: The failure_reason of this ParameterProviderApplyParametersRequestDTO. - :rtype: str + :return: The parameter_provider of this ParameterProviderApplyParametersRequestDTO. + :rtype: ParameterProviderDTO """ - return self._failure_reason + return self._parameter_provider - @failure_reason.setter - def failure_reason(self, failure_reason): + @parameter_provider.setter + def parameter_provider(self, parameter_provider): """ - Sets the failure_reason of this ParameterProviderApplyParametersRequestDTO. - The reason for the request failing, or null if the request has not failed + Sets the parameter_provider of this ParameterProviderApplyParametersRequestDTO. - :param failure_reason: The failure_reason of this ParameterProviderApplyParametersRequestDTO. - :type: str + :param parameter_provider: The parameter_provider of this ParameterProviderApplyParametersRequestDTO. + :type: ParameterProviderDTO """ - self._failure_reason = failure_reason + self._parameter_provider = parameter_provider @property def percent_completed(self): @@ -261,6 +233,52 @@ def percent_completed(self, percent_completed): self._percent_completed = percent_completed + @property + def referencing_components(self): + """ + Gets the referencing_components of this ParameterProviderApplyParametersRequestDTO. + The components that are referenced by the update. + + :return: The referencing_components of this ParameterProviderApplyParametersRequestDTO. + :rtype: list[AffectedComponentEntity] + """ + return self._referencing_components + + @referencing_components.setter + def referencing_components(self, referencing_components): + """ + Sets the referencing_components of this ParameterProviderApplyParametersRequestDTO. + The components that are referenced by the update. + + :param referencing_components: The referencing_components of this ParameterProviderApplyParametersRequestDTO. + :type: list[AffectedComponentEntity] + """ + + self._referencing_components = referencing_components + + @property + def request_id(self): + """ + Gets the request_id of this ParameterProviderApplyParametersRequestDTO. + The ID of the request + + :return: The request_id of this ParameterProviderApplyParametersRequestDTO. + :rtype: str + """ + return self._request_id + + @request_id.setter + def request_id(self, request_id): + """ + Sets the request_id of this ParameterProviderApplyParametersRequestDTO. + The ID of the request + + :param request_id: The request_id of this ParameterProviderApplyParametersRequestDTO. + :type: str + """ + + self._request_id = request_id + @property def state(self): """ @@ -284,6 +302,29 @@ def state(self, state): self._state = state + @property + def submission_time(self): + """ + Gets the submission_time of this ParameterProviderApplyParametersRequestDTO. + The timestamp of when the request was submitted + + :return: The submission_time of this ParameterProviderApplyParametersRequestDTO. + :rtype: datetime + """ + return self._submission_time + + @submission_time.setter + def submission_time(self, submission_time): + """ + Sets the submission_time of this ParameterProviderApplyParametersRequestDTO. + The timestamp of when the request was submitted + + :param submission_time: The submission_time of this ParameterProviderApplyParametersRequestDTO. + :type: datetime + """ + + self._submission_time = submission_time + @property def update_steps(self): """ @@ -308,73 +349,27 @@ def update_steps(self, update_steps): self._update_steps = update_steps @property - def parameter_provider(self): - """ - Gets the parameter_provider of this ParameterProviderApplyParametersRequestDTO. - The Parameter Provider that is being operated on. This may not be populated until the request has successfully completed. - - :return: The parameter_provider of this ParameterProviderApplyParametersRequestDTO. - :rtype: ParameterProviderDTO - """ - return self._parameter_provider - - @parameter_provider.setter - def parameter_provider(self, parameter_provider): - """ - Sets the parameter_provider of this ParameterProviderApplyParametersRequestDTO. - The Parameter Provider that is being operated on. This may not be populated until the request has successfully completed. - - :param parameter_provider: The parameter_provider of this ParameterProviderApplyParametersRequestDTO. - :type: ParameterProviderDTO - """ - - self._parameter_provider = parameter_provider - - @property - def parameter_context_updates(self): - """ - Gets the parameter_context_updates of this ParameterProviderApplyParametersRequestDTO. - The Parameter Contexts updated by this Parameter Provider. This may not be populated until the request has successfully completed. - - :return: The parameter_context_updates of this ParameterProviderApplyParametersRequestDTO. - :rtype: list[ParameterContextUpdateEntity] - """ - return self._parameter_context_updates - - @parameter_context_updates.setter - def parameter_context_updates(self, parameter_context_updates): - """ - Sets the parameter_context_updates of this ParameterProviderApplyParametersRequestDTO. - The Parameter Contexts updated by this Parameter Provider. This may not be populated until the request has successfully completed. - - :param parameter_context_updates: The parameter_context_updates of this ParameterProviderApplyParametersRequestDTO. - :type: list[ParameterContextUpdateEntity] - """ - - self._parameter_context_updates = parameter_context_updates - - @property - def referencing_components(self): + def uri(self): """ - Gets the referencing_components of this ParameterProviderApplyParametersRequestDTO. - The components that are referenced by the update. + Gets the uri of this ParameterProviderApplyParametersRequestDTO. + The URI for the request - :return: The referencing_components of this ParameterProviderApplyParametersRequestDTO. - :rtype: list[AffectedComponentEntity] + :return: The uri of this ParameterProviderApplyParametersRequestDTO. + :rtype: str """ - return self._referencing_components + return self._uri - @referencing_components.setter - def referencing_components(self, referencing_components): + @uri.setter + def uri(self, uri): """ - Sets the referencing_components of this ParameterProviderApplyParametersRequestDTO. - The components that are referenced by the update. + Sets the uri of this ParameterProviderApplyParametersRequestDTO. + The URI for the request - :param referencing_components: The referencing_components of this ParameterProviderApplyParametersRequestDTO. - :type: list[AffectedComponentEntity] + :param uri: The uri of this ParameterProviderApplyParametersRequestDTO. + :type: str """ - self._referencing_components = referencing_components + self._uri = uri def to_dict(self): """ 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 8575b5e8..6ecba445 100644 --- a/nipyapi/nifi/models/parameter_provider_apply_parameters_request_entity.py +++ b/nipyapi/nifi/models/parameter_provider_apply_parameters_request_entity.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,12 +27,10 @@ class ParameterProviderApplyParametersRequestEntity(object): and the value is json key in definition. """ swagger_types = { - 'request': 'ParameterProviderApplyParametersRequestDTO' - } + 'request': 'ParameterProviderApplyParametersRequestDTO' } attribute_map = { - 'request': 'request' - } + 'request': 'request' } def __init__(self, request=None): """ @@ -49,7 +46,6 @@ def __init__(self, request=None): def request(self): """ Gets the request of this ParameterProviderApplyParametersRequestEntity. - The Apply Parameters Request :return: The request of this ParameterProviderApplyParametersRequestEntity. :rtype: ParameterProviderApplyParametersRequestDTO @@ -60,7 +56,6 @@ def request(self): def request(self, request): """ Sets the request of this ParameterProviderApplyParametersRequestEntity. - The Apply Parameters Request :param request: The request of this ParameterProviderApplyParametersRequestEntity. :type: ParameterProviderApplyParametersRequestDTO 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 e88039c6..fe5f9eee 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 @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,56 +27,31 @@ class ParameterProviderApplyParametersUpdateStepDTO(object): and the value is json key in definition. """ swagger_types = { - 'description': 'str', 'complete': 'bool', - 'failure_reason': 'str' - } +'description': 'str', +'failure_reason': 'str' } attribute_map = { - 'description': 'description', 'complete': 'complete', - 'failure_reason': 'failureReason' - } +'description': 'description', +'failure_reason': 'failureReason' } - def __init__(self, description=None, complete=None, failure_reason=None): + def __init__(self, complete=None, description=None, failure_reason=None): """ ParameterProviderApplyParametersUpdateStepDTO - a model defined in Swagger """ - self._description = None self._complete = None + self._description = None self._failure_reason = None - if description is not None: - self.description = description 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 description(self): - """ - Gets the description of this ParameterProviderApplyParametersUpdateStepDTO. - Explanation of what happens in this step - - :return: The description of this ParameterProviderApplyParametersUpdateStepDTO. - :rtype: str - """ - return self._description - - @description.setter - def description(self, description): - """ - Sets the description of this ParameterProviderApplyParametersUpdateStepDTO. - Explanation of what happens in this step - - :param description: The description of this ParameterProviderApplyParametersUpdateStepDTO. - :type: str - """ - - self._description = description - @property def complete(self): """ @@ -101,6 +75,29 @@ def complete(self, complete): self._complete = complete + @property + def description(self): + """ + Gets the description of this ParameterProviderApplyParametersUpdateStepDTO. + Explanation of what happens in this step + + :return: The description of this ParameterProviderApplyParametersUpdateStepDTO. + :rtype: str + """ + return self._description + + @description.setter + def description(self, description): + """ + Sets the description of this ParameterProviderApplyParametersUpdateStepDTO. + Explanation of what happens in this step + + :param description: The description of this ParameterProviderApplyParametersUpdateStepDTO. + :type: str + """ + + self._description = description + @property def failure_reason(self): """ diff --git a/nipyapi/nifi/models/parameter_provider_configuration_dto.py b/nipyapi/nifi/models/parameter_provider_configuration_dto.py index c734c276..6f0378f0 100644 --- a/nipyapi/nifi/models/parameter_provider_configuration_dto.py +++ b/nipyapi/nifi/models/parameter_provider_configuration_dto.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,38 +27,59 @@ class ParameterProviderConfigurationDTO(object): and the value is json key in definition. """ swagger_types = { - 'parameter_provider_id': 'str', - 'parameter_provider_name': 'str', 'parameter_group_name': 'str', - 'synchronized': 'bool' - } +'parameter_provider_id': 'str', +'parameter_provider_name': 'str', +'synchronized': 'bool' } attribute_map = { - 'parameter_provider_id': 'parameterProviderId', - 'parameter_provider_name': 'parameterProviderName', 'parameter_group_name': 'parameterGroupName', - 'synchronized': 'synchronized' - } +'parameter_provider_id': 'parameterProviderId', +'parameter_provider_name': 'parameterProviderName', +'synchronized': 'synchronized' } - def __init__(self, parameter_provider_id=None, parameter_provider_name=None, parameter_group_name=None, synchronized=None): + def __init__(self, parameter_group_name=None, parameter_provider_id=None, parameter_provider_name=None, synchronized=None): """ ParameterProviderConfigurationDTO - a model defined in Swagger """ + self._parameter_group_name = None self._parameter_provider_id = None self._parameter_provider_name = None - self._parameter_group_name = None self._synchronized = None + if parameter_group_name is not None: + self.parameter_group_name = parameter_group_name if parameter_provider_id is not None: self.parameter_provider_id = parameter_provider_id if parameter_provider_name is not None: self.parameter_provider_name = parameter_provider_name - if parameter_group_name is not None: - self.parameter_group_name = parameter_group_name if synchronized is not None: self.synchronized = synchronized + @property + def parameter_group_name(self): + """ + Gets the parameter_group_name of this ParameterProviderConfigurationDTO. + The Parameter Group name that maps to the Parameter Context + + :return: The parameter_group_name of this ParameterProviderConfigurationDTO. + :rtype: str + """ + return self._parameter_group_name + + @parameter_group_name.setter + def parameter_group_name(self, parameter_group_name): + """ + Sets the parameter_group_name of this ParameterProviderConfigurationDTO. + The Parameter Group name that maps to the Parameter Context + + :param parameter_group_name: The parameter_group_name of this ParameterProviderConfigurationDTO. + :type: str + """ + + self._parameter_group_name = parameter_group_name + @property def parameter_provider_id(self): """ @@ -106,29 +126,6 @@ def parameter_provider_name(self, parameter_provider_name): self._parameter_provider_name = parameter_provider_name - @property - def parameter_group_name(self): - """ - Gets the parameter_group_name of this ParameterProviderConfigurationDTO. - The Parameter Group name that maps to the Parameter Context - - :return: The parameter_group_name of this ParameterProviderConfigurationDTO. - :rtype: str - """ - return self._parameter_group_name - - @parameter_group_name.setter - def parameter_group_name(self, parameter_group_name): - """ - Sets the parameter_group_name of this ParameterProviderConfigurationDTO. - The Parameter Group name that maps to the Parameter Context - - :param parameter_group_name: The parameter_group_name of this ParameterProviderConfigurationDTO. - :type: str - """ - - self._parameter_group_name = parameter_group_name - @property def synchronized(self): """ diff --git a/nipyapi/nifi/models/parameter_provider_configuration_entity.py b/nipyapi/nifi/models/parameter_provider_configuration_entity.py index 458f3ed4..f5819f29 100644 --- a/nipyapi/nifi/models/parameter_provider_configuration_entity.py +++ b/nipyapi/nifi/models/parameter_provider_configuration_entity.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,32 +27,51 @@ class ParameterProviderConfigurationEntity(object): and the value is json key in definition. """ swagger_types = { - 'id': 'str', - 'permissions': 'PermissionsDTO', - 'component': 'ParameterProviderConfigurationDTO' - } + 'component': 'ParameterProviderConfigurationDTO', +'id': 'str', +'permissions': 'PermissionsDTO' } attribute_map = { - 'id': 'id', - 'permissions': 'permissions', - 'component': 'component' - } + 'component': 'component', +'id': 'id', +'permissions': 'permissions' } - def __init__(self, id=None, permissions=None, component=None): + def __init__(self, component=None, id=None, permissions=None): """ ParameterProviderConfigurationEntity - a model defined in Swagger """ + self._component = None self._id = None self._permissions = None - self._component = None + if component is not None: + self.component = component if id is not None: self.id = id if permissions is not None: self.permissions = permissions - if component is not None: - self.component = component + + @property + def component(self): + """ + Gets the component of this ParameterProviderConfigurationEntity. + + :return: The component of this ParameterProviderConfigurationEntity. + :rtype: ParameterProviderConfigurationDTO + """ + return self._component + + @component.setter + def component(self, component): + """ + Sets the component of this ParameterProviderConfigurationEntity. + + :param component: The component of this ParameterProviderConfigurationEntity. + :type: ParameterProviderConfigurationDTO + """ + + self._component = component @property def id(self): @@ -82,7 +100,6 @@ def id(self, id): def permissions(self): """ Gets the permissions of this ParameterProviderConfigurationEntity. - The permissions for this component. :return: The permissions of this ParameterProviderConfigurationEntity. :rtype: PermissionsDTO @@ -93,7 +110,6 @@ def permissions(self): def permissions(self, permissions): """ Sets the permissions of this ParameterProviderConfigurationEntity. - The permissions for this component. :param permissions: The permissions of this ParameterProviderConfigurationEntity. :type: PermissionsDTO @@ -101,27 +117,6 @@ def permissions(self, permissions): self._permissions = permissions - @property - def component(self): - """ - Gets the component of this ParameterProviderConfigurationEntity. - - :return: The component of this ParameterProviderConfigurationEntity. - :rtype: ParameterProviderConfigurationDTO - """ - return self._component - - @component.setter - def component(self, component): - """ - Sets the component of this ParameterProviderConfigurationEntity. - - :param component: The component of this ParameterProviderConfigurationEntity. - :type: ParameterProviderConfigurationDTO - """ - - self._component = component - def to_dict(self): """ Returns the model properties as a dict diff --git a/nipyapi/nifi/models/parameter_provider_definition.py b/nipyapi/nifi/models/parameter_provider_definition.py new file mode 100644 index 00000000..38f2fc50 --- /dev/null +++ b/nipyapi/nifi/models/parameter_provider_definition.py @@ -0,0 +1,703 @@ +""" + Apache NiFi REST API + + REST API definition for Apache NiFi web services + + OpenAPI spec version: 2.5.0 + Contact: dev@nifi.apache.org + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from pprint import pformat +import re + + +class ParameterProviderDefinition(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 = { + 'additional_details': 'bool', +'artifact': 'str', +'build_info': 'BuildInfo', +'deprecated': 'bool', +'deprecation_alternatives': 'list[str]', +'deprecation_reason': 'str', +'dynamic_properties': 'list[DynamicProperty]', +'explicit_restrictions': 'list[Restriction]', +'group': 'str', +'property_descriptors': 'dict(str, PropertyDescriptor)', +'provided_api_implementations': 'list[DefinedType]', +'restricted': 'bool', +'restricted_explanation': 'str', +'see_also': 'list[str]', +'stateful': 'Stateful', +'supports_dynamic_properties': 'bool', +'supports_sensitive_dynamic_properties': 'bool', +'system_resource_considerations': 'list[SystemResourceConsideration]', +'tags': 'list[str]', +'type': 'str', +'type_description': 'str', +'version': 'str' } + + attribute_map = { + 'additional_details': 'additionalDetails', +'artifact': 'artifact', +'build_info': 'buildInfo', +'deprecated': 'deprecated', +'deprecation_alternatives': 'deprecationAlternatives', +'deprecation_reason': 'deprecationReason', +'dynamic_properties': 'dynamicProperties', +'explicit_restrictions': 'explicitRestrictions', +'group': 'group', +'property_descriptors': 'propertyDescriptors', +'provided_api_implementations': 'providedApiImplementations', +'restricted': 'restricted', +'restricted_explanation': 'restrictedExplanation', +'see_also': 'seeAlso', +'stateful': 'stateful', +'supports_dynamic_properties': 'supportsDynamicProperties', +'supports_sensitive_dynamic_properties': 'supportsSensitiveDynamicProperties', +'system_resource_considerations': 'systemResourceConsiderations', +'tags': 'tags', +'type': 'type', +'type_description': 'typeDescription', +'version': 'version' } + + def __init__(self, additional_details=None, artifact=None, build_info=None, deprecated=None, deprecation_alternatives=None, deprecation_reason=None, dynamic_properties=None, explicit_restrictions=None, group=None, property_descriptors=None, provided_api_implementations=None, restricted=None, restricted_explanation=None, see_also=None, stateful=None, supports_dynamic_properties=None, supports_sensitive_dynamic_properties=None, system_resource_considerations=None, tags=None, type=None, type_description=None, version=None): + """ + ParameterProviderDefinition - a model defined in Swagger + """ + + self._additional_details = None + self._artifact = None + self._build_info = None + self._deprecated = None + self._deprecation_alternatives = None + self._deprecation_reason = None + self._dynamic_properties = None + self._explicit_restrictions = None + self._group = None + self._property_descriptors = None + self._provided_api_implementations = None + self._restricted = None + self._restricted_explanation = None + self._see_also = None + self._stateful = None + self._supports_dynamic_properties = None + self._supports_sensitive_dynamic_properties = None + self._system_resource_considerations = None + self._tags = None + self._type = None + self._type_description = None + self._version = None + + if additional_details is not None: + self.additional_details = additional_details + if artifact is not None: + self.artifact = artifact + if build_info is not None: + self.build_info = build_info + if deprecated is not None: + self.deprecated = deprecated + if deprecation_alternatives is not None: + self.deprecation_alternatives = deprecation_alternatives + if deprecation_reason is not None: + self.deprecation_reason = deprecation_reason + if dynamic_properties is not None: + self.dynamic_properties = dynamic_properties + if explicit_restrictions is not None: + self.explicit_restrictions = explicit_restrictions + if group is not None: + self.group = group + if property_descriptors is not None: + self.property_descriptors = property_descriptors + if provided_api_implementations is not None: + self.provided_api_implementations = provided_api_implementations + if restricted is not None: + self.restricted = restricted + if restricted_explanation is not None: + self.restricted_explanation = restricted_explanation + if see_also is not None: + self.see_also = see_also + if stateful is not None: + self.stateful = stateful + if supports_dynamic_properties is not None: + self.supports_dynamic_properties = supports_dynamic_properties + if supports_sensitive_dynamic_properties is not None: + self.supports_sensitive_dynamic_properties = supports_sensitive_dynamic_properties + if system_resource_considerations is not None: + self.system_resource_considerations = system_resource_considerations + if tags is not None: + self.tags = tags + if type is not None: + self.type = type + if type_description is not None: + self.type_description = type_description + if version is not None: + self.version = version + + @property + def additional_details(self): + """ + Gets the additional_details of this ParameterProviderDefinition. + Indicates if the component has additional details documentation + + :return: The additional_details of this ParameterProviderDefinition. + :rtype: bool + """ + return self._additional_details + + @additional_details.setter + def additional_details(self, additional_details): + """ + Sets the additional_details of this ParameterProviderDefinition. + Indicates if the component has additional details documentation + + :param additional_details: The additional_details of this ParameterProviderDefinition. + :type: bool + """ + + self._additional_details = additional_details + + @property + def artifact(self): + """ + Gets the artifact of this ParameterProviderDefinition. + The artifact name of the bundle that provides the referenced type. + + :return: The artifact of this ParameterProviderDefinition. + :rtype: str + """ + return self._artifact + + @artifact.setter + def artifact(self, artifact): + """ + Sets the artifact of this ParameterProviderDefinition. + The artifact name of the bundle that provides the referenced type. + + :param artifact: The artifact of this ParameterProviderDefinition. + :type: str + """ + + self._artifact = artifact + + @property + def build_info(self): + """ + Gets the build_info of this ParameterProviderDefinition. + + :return: The build_info of this ParameterProviderDefinition. + :rtype: BuildInfo + """ + return self._build_info + + @build_info.setter + def build_info(self, build_info): + """ + Sets the build_info of this ParameterProviderDefinition. + + :param build_info: The build_info of this ParameterProviderDefinition. + :type: BuildInfo + """ + + self._build_info = build_info + + @property + def deprecated(self): + """ + Gets the deprecated of this ParameterProviderDefinition. + Whether or not the component has been deprecated + + :return: The deprecated of this ParameterProviderDefinition. + :rtype: bool + """ + return self._deprecated + + @deprecated.setter + def deprecated(self, deprecated): + """ + Sets the deprecated of this ParameterProviderDefinition. + Whether or not the component has been deprecated + + :param deprecated: The deprecated of this ParameterProviderDefinition. + :type: bool + """ + + self._deprecated = deprecated + + @property + def deprecation_alternatives(self): + """ + Gets the deprecation_alternatives of this ParameterProviderDefinition. + If this component has been deprecated, this optional field provides alternatives to use + + :return: The deprecation_alternatives of this ParameterProviderDefinition. + :rtype: list[str] + """ + return self._deprecation_alternatives + + @deprecation_alternatives.setter + def deprecation_alternatives(self, deprecation_alternatives): + """ + Sets the deprecation_alternatives of this ParameterProviderDefinition. + If this component has been deprecated, this optional field provides alternatives to use + + :param deprecation_alternatives: The deprecation_alternatives of this ParameterProviderDefinition. + :type: list[str] + """ + + self._deprecation_alternatives = deprecation_alternatives + + @property + def deprecation_reason(self): + """ + Gets the deprecation_reason of this ParameterProviderDefinition. + If this component has been deprecated, this optional field can be used to provide an explanation + + :return: The deprecation_reason of this ParameterProviderDefinition. + :rtype: str + """ + return self._deprecation_reason + + @deprecation_reason.setter + def deprecation_reason(self, deprecation_reason): + """ + Sets the deprecation_reason of this ParameterProviderDefinition. + If this component has been deprecated, this optional field can be used to provide an explanation + + :param deprecation_reason: The deprecation_reason of this ParameterProviderDefinition. + :type: str + """ + + self._deprecation_reason = deprecation_reason + + @property + def dynamic_properties(self): + """ + Gets the dynamic_properties of this ParameterProviderDefinition. + Describes the dynamic properties supported by this component + + :return: The dynamic_properties of this ParameterProviderDefinition. + :rtype: list[DynamicProperty] + """ + return self._dynamic_properties + + @dynamic_properties.setter + def dynamic_properties(self, dynamic_properties): + """ + Sets the dynamic_properties of this ParameterProviderDefinition. + Describes the dynamic properties supported by this component + + :param dynamic_properties: The dynamic_properties of this ParameterProviderDefinition. + :type: list[DynamicProperty] + """ + + self._dynamic_properties = dynamic_properties + + @property + def explicit_restrictions(self): + """ + Gets the explicit_restrictions of this ParameterProviderDefinition. + Explicit restrictions that indicate a require permission to use the component + + :return: The explicit_restrictions of this ParameterProviderDefinition. + :rtype: list[Restriction] + """ + return self._explicit_restrictions + + @explicit_restrictions.setter + def explicit_restrictions(self, explicit_restrictions): + """ + Sets the explicit_restrictions of this ParameterProviderDefinition. + Explicit restrictions that indicate a require permission to use the component + + :param explicit_restrictions: The explicit_restrictions of this ParameterProviderDefinition. + :type: list[Restriction] + """ + + self._explicit_restrictions = explicit_restrictions + + @property + def group(self): + """ + Gets the group of this ParameterProviderDefinition. + The group name of the bundle that provides the referenced type. + + :return: The group of this ParameterProviderDefinition. + :rtype: str + """ + return self._group + + @group.setter + def group(self, group): + """ + Sets the group of this ParameterProviderDefinition. + The group name of the bundle that provides the referenced type. + + :param group: The group of this ParameterProviderDefinition. + :type: str + """ + + self._group = group + + @property + def property_descriptors(self): + """ + Gets the property_descriptors of this ParameterProviderDefinition. + Descriptions of configuration properties applicable to this component. + + :return: The property_descriptors of this ParameterProviderDefinition. + :rtype: dict(str, PropertyDescriptor) + """ + return self._property_descriptors + + @property_descriptors.setter + def property_descriptors(self, property_descriptors): + """ + Sets the property_descriptors of this ParameterProviderDefinition. + Descriptions of configuration properties applicable to this component. + + :param property_descriptors: The property_descriptors of this ParameterProviderDefinition. + :type: dict(str, PropertyDescriptor) + """ + + self._property_descriptors = property_descriptors + + @property + def provided_api_implementations(self): + """ + Gets the provided_api_implementations of this ParameterProviderDefinition. + If this type represents a provider for an interface, this lists the APIs it implements + + :return: The provided_api_implementations of this ParameterProviderDefinition. + :rtype: list[DefinedType] + """ + return self._provided_api_implementations + + @provided_api_implementations.setter + def provided_api_implementations(self, provided_api_implementations): + """ + Sets the provided_api_implementations of this ParameterProviderDefinition. + If this type represents a provider for an interface, this lists the APIs it implements + + :param provided_api_implementations: The provided_api_implementations of this ParameterProviderDefinition. + :type: list[DefinedType] + """ + + self._provided_api_implementations = provided_api_implementations + + @property + def restricted(self): + """ + Gets the restricted of this ParameterProviderDefinition. + Whether or not the component has a general restriction + + :return: The restricted of this ParameterProviderDefinition. + :rtype: bool + """ + return self._restricted + + @restricted.setter + def restricted(self, restricted): + """ + Sets the restricted of this ParameterProviderDefinition. + Whether or not the component has a general restriction + + :param restricted: The restricted of this ParameterProviderDefinition. + :type: bool + """ + + self._restricted = restricted + + @property + def restricted_explanation(self): + """ + Gets the restricted_explanation of this ParameterProviderDefinition. + An optional description of the general restriction + + :return: The restricted_explanation of this ParameterProviderDefinition. + :rtype: str + """ + return self._restricted_explanation + + @restricted_explanation.setter + def restricted_explanation(self, restricted_explanation): + """ + Sets the restricted_explanation of this ParameterProviderDefinition. + An optional description of the general restriction + + :param restricted_explanation: The restricted_explanation of this ParameterProviderDefinition. + :type: str + """ + + self._restricted_explanation = restricted_explanation + + @property + def see_also(self): + """ + Gets the see_also of this ParameterProviderDefinition. + The names of other component types that may be related + + :return: The see_also of this ParameterProviderDefinition. + :rtype: list[str] + """ + return self._see_also + + @see_also.setter + def see_also(self, see_also): + """ + Sets the see_also of this ParameterProviderDefinition. + The names of other component types that may be related + + :param see_also: The see_also of this ParameterProviderDefinition. + :type: list[str] + """ + + self._see_also = see_also + + @property + def stateful(self): + """ + Gets the stateful of this ParameterProviderDefinition. + + :return: The stateful of this ParameterProviderDefinition. + :rtype: Stateful + """ + return self._stateful + + @stateful.setter + def stateful(self, stateful): + """ + Sets the stateful of this ParameterProviderDefinition. + + :param stateful: The stateful of this ParameterProviderDefinition. + :type: Stateful + """ + + self._stateful = stateful + + @property + def supports_dynamic_properties(self): + """ + Gets the supports_dynamic_properties of this ParameterProviderDefinition. + Whether or not this component makes use of dynamic (user-set) properties. + + :return: The supports_dynamic_properties of this ParameterProviderDefinition. + :rtype: bool + """ + return self._supports_dynamic_properties + + @supports_dynamic_properties.setter + def supports_dynamic_properties(self, supports_dynamic_properties): + """ + Sets the supports_dynamic_properties of this ParameterProviderDefinition. + Whether or not this component makes use of dynamic (user-set) properties. + + :param supports_dynamic_properties: The supports_dynamic_properties of this ParameterProviderDefinition. + :type: bool + """ + + self._supports_dynamic_properties = supports_dynamic_properties + + @property + def supports_sensitive_dynamic_properties(self): + """ + Gets the supports_sensitive_dynamic_properties of this ParameterProviderDefinition. + Whether or not this component makes use of sensitive dynamic (user-set) properties. + + :return: The supports_sensitive_dynamic_properties of this ParameterProviderDefinition. + :rtype: bool + """ + return self._supports_sensitive_dynamic_properties + + @supports_sensitive_dynamic_properties.setter + def supports_sensitive_dynamic_properties(self, supports_sensitive_dynamic_properties): + """ + Sets the supports_sensitive_dynamic_properties of this ParameterProviderDefinition. + Whether or not this component makes use of sensitive dynamic (user-set) properties. + + :param supports_sensitive_dynamic_properties: The supports_sensitive_dynamic_properties of this ParameterProviderDefinition. + :type: bool + """ + + self._supports_sensitive_dynamic_properties = supports_sensitive_dynamic_properties + + @property + def system_resource_considerations(self): + """ + Gets the system_resource_considerations of this ParameterProviderDefinition. + The system resource considerations for the given component + + :return: The system_resource_considerations of this ParameterProviderDefinition. + :rtype: list[SystemResourceConsideration] + """ + return self._system_resource_considerations + + @system_resource_considerations.setter + def system_resource_considerations(self, system_resource_considerations): + """ + Sets the system_resource_considerations of this ParameterProviderDefinition. + The system resource considerations for the given component + + :param system_resource_considerations: The system_resource_considerations of this ParameterProviderDefinition. + :type: list[SystemResourceConsideration] + """ + + self._system_resource_considerations = system_resource_considerations + + @property + def tags(self): + """ + Gets the tags of this ParameterProviderDefinition. + The tags associated with this type + + :return: The tags of this ParameterProviderDefinition. + :rtype: list[str] + """ + return self._tags + + @tags.setter + def tags(self, tags): + """ + Sets the tags of this ParameterProviderDefinition. + The tags associated with this type + + :param tags: The tags of this ParameterProviderDefinition. + :type: list[str] + """ + + self._tags = tags + + @property + def type(self): + """ + Gets the type of this ParameterProviderDefinition. + The fully-qualified class type + + :return: The type of this ParameterProviderDefinition. + :rtype: str + """ + return self._type + + @type.setter + def type(self, type): + """ + Sets the type of this ParameterProviderDefinition. + The fully-qualified class type + + :param type: The type of this ParameterProviderDefinition. + :type: str + """ + + self._type = type + + @property + def type_description(self): + """ + Gets the type_description of this ParameterProviderDefinition. + The description of the type. + + :return: The type_description of this ParameterProviderDefinition. + :rtype: str + """ + return self._type_description + + @type_description.setter + def type_description(self, type_description): + """ + Sets the type_description of this ParameterProviderDefinition. + The description of the type. + + :param type_description: The type_description of this ParameterProviderDefinition. + :type: str + """ + + self._type_description = type_description + + @property + def version(self): + """ + Gets the version of this ParameterProviderDefinition. + The version of the bundle that provides the referenced type. + + :return: The version of this ParameterProviderDefinition. + :rtype: str + """ + return self._version + + @version.setter + def version(self, version): + """ + Sets the version of this ParameterProviderDefinition. + The version of the bundle that provides the referenced type. + + :param version: The version of this ParameterProviderDefinition. + :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, ParameterProviderDefinition): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """ + Returns true if both objects are not equal + """ + return not self == other diff --git a/nipyapi/nifi/models/parameter_provider_dto.py b/nipyapi/nifi/models/parameter_provider_dto.py index 530c6fe6..6cd33dc6 100644 --- a/nipyapi/nifi/models/parameter_provider_dto.py +++ b/nipyapi/nifi/models/parameter_provider_dto.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,276 +27,181 @@ class ParameterProviderDTO(object): and the value is json key in definition. """ swagger_types = { - 'id': 'str', - 'versioned_component_id': 'str', - 'parent_group_id': 'str', - 'position': 'PositionDTO', - 'name': 'str', - 'type': 'str', - 'bundle': 'BundleDTO', - 'comments': 'str', - 'persists_state': 'bool', - 'restricted': 'bool', - 'deprecated': 'bool', - 'multiple_versions_available': 'bool', - 'properties': 'dict(str, str)', - 'descriptors': 'dict(str, PropertyDescriptorDTO)', - 'parameter_group_configurations': 'list[ParameterGroupConfigurationEntity]', 'affected_components': 'list[AffectedComponentEntity]', - 'parameter_status': 'list[ParameterStatusDTO]', - 'referencing_parameter_contexts': 'list[ParameterProviderReferencingComponentEntity]', - 'custom_ui_url': 'str', - 'annotation_data': 'str', - 'validation_errors': 'list[str]', - 'validation_status': 'str', - 'extension_missing': 'bool' - } +'annotation_data': 'str', +'bundle': 'BundleDTO', +'comments': 'str', +'custom_ui_url': 'str', +'deprecated': 'bool', +'descriptors': 'dict(str, PropertyDescriptorDTO)', +'extension_missing': 'bool', +'id': 'str', +'multiple_versions_available': 'bool', +'name': 'str', +'parameter_group_configurations': 'list[ParameterGroupConfigurationEntity]', +'parameter_status': 'list[ParameterStatusDTO]', +'parent_group_id': 'str', +'persists_state': 'bool', +'position': 'PositionDTO', +'properties': 'dict(str, str)', +'referencing_parameter_contexts': 'list[ParameterProviderReferencingComponentEntity]', +'restricted': 'bool', +'type': 'str', +'validation_errors': 'list[str]', +'validation_status': 'str', +'versioned_component_id': 'str' } attribute_map = { - 'id': 'id', - 'versioned_component_id': 'versionedComponentId', - 'parent_group_id': 'parentGroupId', - 'position': 'position', - 'name': 'name', - 'type': 'type', - 'bundle': 'bundle', - 'comments': 'comments', - 'persists_state': 'persistsState', - 'restricted': 'restricted', - 'deprecated': 'deprecated', - 'multiple_versions_available': 'multipleVersionsAvailable', - 'properties': 'properties', - 'descriptors': 'descriptors', - 'parameter_group_configurations': 'parameterGroupConfigurations', 'affected_components': 'affectedComponents', - 'parameter_status': 'parameterStatus', - 'referencing_parameter_contexts': 'referencingParameterContexts', - 'custom_ui_url': 'customUiUrl', - 'annotation_data': 'annotationData', - 'validation_errors': 'validationErrors', - 'validation_status': 'validationStatus', - 'extension_missing': 'extensionMissing' - } - - def __init__(self, id=None, versioned_component_id=None, parent_group_id=None, position=None, name=None, type=None, bundle=None, comments=None, persists_state=None, restricted=None, deprecated=None, multiple_versions_available=None, properties=None, descriptors=None, parameter_group_configurations=None, affected_components=None, parameter_status=None, referencing_parameter_contexts=None, custom_ui_url=None, annotation_data=None, validation_errors=None, validation_status=None, extension_missing=None): +'annotation_data': 'annotationData', +'bundle': 'bundle', +'comments': 'comments', +'custom_ui_url': 'customUiUrl', +'deprecated': 'deprecated', +'descriptors': 'descriptors', +'extension_missing': 'extensionMissing', +'id': 'id', +'multiple_versions_available': 'multipleVersionsAvailable', +'name': 'name', +'parameter_group_configurations': 'parameterGroupConfigurations', +'parameter_status': 'parameterStatus', +'parent_group_id': 'parentGroupId', +'persists_state': 'persistsState', +'position': 'position', +'properties': 'properties', +'referencing_parameter_contexts': 'referencingParameterContexts', +'restricted': 'restricted', +'type': 'type', +'validation_errors': 'validationErrors', +'validation_status': 'validationStatus', +'versioned_component_id': 'versionedComponentId' } + + def __init__(self, affected_components=None, annotation_data=None, bundle=None, comments=None, custom_ui_url=None, deprecated=None, descriptors=None, extension_missing=None, id=None, multiple_versions_available=None, name=None, parameter_group_configurations=None, parameter_status=None, parent_group_id=None, persists_state=None, position=None, properties=None, referencing_parameter_contexts=None, restricted=None, type=None, validation_errors=None, validation_status=None, versioned_component_id=None): """ ParameterProviderDTO - a model defined in Swagger """ - self._id = None - self._versioned_component_id = None - self._parent_group_id = None - self._position = None - self._name = None - self._type = None + self._affected_components = None + self._annotation_data = None self._bundle = None self._comments = None - self._persists_state = None - self._restricted = None + self._custom_ui_url = None self._deprecated = None - self._multiple_versions_available = None - self._properties = None self._descriptors = None + self._extension_missing = None + self._id = None + self._multiple_versions_available = None + self._name = None self._parameter_group_configurations = None - self._affected_components = None self._parameter_status = None + self._parent_group_id = None + self._persists_state = None + self._position = None + self._properties = None self._referencing_parameter_contexts = None - self._custom_ui_url = None - self._annotation_data = None + self._restricted = None + self._type = None self._validation_errors = None self._validation_status = None - self._extension_missing = None + self._versioned_component_id = None - if id is not None: - self.id = id - if versioned_component_id is not None: - self.versioned_component_id = versioned_component_id - if parent_group_id is not None: - self.parent_group_id = parent_group_id - if position is not None: - self.position = position - if name is not None: - self.name = name - if type is not None: - self.type = type + if affected_components is not None: + self.affected_components = affected_components + if annotation_data is not None: + self.annotation_data = annotation_data if bundle is not None: self.bundle = bundle if comments is not None: self.comments = comments - if persists_state is not None: - self.persists_state = persists_state - if restricted is not None: - self.restricted = restricted + if custom_ui_url is not None: + self.custom_ui_url = custom_ui_url if deprecated is not None: self.deprecated = deprecated - if multiple_versions_available is not None: - self.multiple_versions_available = multiple_versions_available - if properties is not None: - self.properties = properties if descriptors is not None: self.descriptors = descriptors + if extension_missing is not None: + self.extension_missing = extension_missing + if id is not None: + self.id = id + if multiple_versions_available is not None: + self.multiple_versions_available = multiple_versions_available + if name is not None: + self.name = name if parameter_group_configurations is not None: self.parameter_group_configurations = parameter_group_configurations - if affected_components is not None: - self.affected_components = affected_components if parameter_status is not None: self.parameter_status = parameter_status + if parent_group_id is not None: + self.parent_group_id = parent_group_id + if persists_state is not None: + self.persists_state = persists_state + if position is not None: + self.position = position + if properties is not None: + self.properties = properties if referencing_parameter_contexts is not None: self.referencing_parameter_contexts = referencing_parameter_contexts - if custom_ui_url is not None: - self.custom_ui_url = custom_ui_url - if annotation_data is not None: - self.annotation_data = annotation_data + if restricted is not None: + self.restricted = restricted + if type is not None: + self.type = type if validation_errors is not None: self.validation_errors = validation_errors if validation_status is not None: self.validation_status = validation_status - if extension_missing is not None: - self.extension_missing = extension_missing - - @property - def id(self): - """ - Gets the id of this ParameterProviderDTO. - The id of the component. - - :return: The id of this ParameterProviderDTO. - :rtype: str - """ - return self._id - - @id.setter - def id(self, id): - """ - Sets the id of this ParameterProviderDTO. - The id of the component. - - :param id: The id of this ParameterProviderDTO. - :type: str - """ - - self._id = id - - @property - def versioned_component_id(self): - """ - Gets the versioned_component_id of this ParameterProviderDTO. - The ID of the corresponding component that is under version control - - :return: The versioned_component_id of this ParameterProviderDTO. - :rtype: str - """ - return self._versioned_component_id - - @versioned_component_id.setter - def versioned_component_id(self, versioned_component_id): - """ - Sets the versioned_component_id of this ParameterProviderDTO. - The ID of the corresponding component that is under version control - - :param versioned_component_id: The versioned_component_id of this ParameterProviderDTO. - :type: str - """ - - self._versioned_component_id = versioned_component_id - - @property - def parent_group_id(self): - """ - Gets the parent_group_id of this ParameterProviderDTO. - The id of parent process group of this component if applicable. - - :return: The parent_group_id of this ParameterProviderDTO. - :rtype: str - """ - return self._parent_group_id - - @parent_group_id.setter - def parent_group_id(self, parent_group_id): - """ - Sets the parent_group_id of this ParameterProviderDTO. - The id of parent process group of this component if applicable. - - :param parent_group_id: The parent_group_id of this ParameterProviderDTO. - :type: str - """ - - self._parent_group_id = parent_group_id - - @property - def position(self): - """ - Gets the position of this ParameterProviderDTO. - The position of this component in the UI if applicable. - - :return: The position of this ParameterProviderDTO. - :rtype: PositionDTO - """ - return self._position - - @position.setter - def position(self, position): - """ - Sets the position of this ParameterProviderDTO. - The position of this component in the UI if applicable. - - :param position: The position of this ParameterProviderDTO. - :type: PositionDTO - """ - - self._position = position + if versioned_component_id is not None: + self.versioned_component_id = versioned_component_id @property - def name(self): + def affected_components(self): """ - Gets the name of this ParameterProviderDTO. - The name of the parameter provider. + Gets the affected_components of this ParameterProviderDTO. + The set of all components in the flow that are referencing Parameters provided by this provider - :return: The name of this ParameterProviderDTO. - :rtype: str + :return: The affected_components of this ParameterProviderDTO. + :rtype: list[AffectedComponentEntity] """ - return self._name + return self._affected_components - @name.setter - def name(self, name): + @affected_components.setter + def affected_components(self, affected_components): """ - Sets the name of this ParameterProviderDTO. - The name of the parameter provider. + Sets the affected_components of this ParameterProviderDTO. + The set of all components in the flow that are referencing Parameters provided by this provider - :param name: The name of this ParameterProviderDTO. - :type: str + :param affected_components: The affected_components of this ParameterProviderDTO. + :type: list[AffectedComponentEntity] """ - self._name = name + self._affected_components = affected_components @property - def type(self): + def annotation_data(self): """ - Gets the type of this ParameterProviderDTO. - The fully qualified type of the parameter provider. + Gets the annotation_data of this ParameterProviderDTO. + The annotation data for the parameter provider. This is how the custom UI relays configuration to the parameter provider. - :return: The type of this ParameterProviderDTO. + :return: The annotation_data of this ParameterProviderDTO. :rtype: str """ - return self._type + return self._annotation_data - @type.setter - def type(self, type): + @annotation_data.setter + def annotation_data(self, annotation_data): """ - Sets the type of this ParameterProviderDTO. - The fully qualified type of the parameter provider. + Sets the annotation_data of this ParameterProviderDTO. + The annotation data for the parameter provider. This is how the custom UI relays configuration to the parameter provider. - :param type: The type of this ParameterProviderDTO. + :param annotation_data: The annotation_data of this ParameterProviderDTO. :type: str """ - self._type = type + self._annotation_data = annotation_data @property def bundle(self): """ Gets the bundle of this ParameterProviderDTO. - The details of the artifact that bundled this parameter provider type. :return: The bundle of this ParameterProviderDTO. :rtype: BundleDTO @@ -308,7 +212,6 @@ def bundle(self): def bundle(self, bundle): """ Sets the bundle of this ParameterProviderDTO. - The details of the artifact that bundled this parameter provider type. :param bundle: The bundle of this ParameterProviderDTO. :type: BundleDTO @@ -340,73 +243,119 @@ def comments(self, comments): self._comments = comments @property - def persists_state(self): + def custom_ui_url(self): """ - Gets the persists_state of this ParameterProviderDTO. - Whether the parameter provider persists state. + Gets the custom_ui_url of this ParameterProviderDTO. + The URL for the custom configuration UI for the parameter provider. - :return: The persists_state of this ParameterProviderDTO. + :return: The custom_ui_url of this ParameterProviderDTO. + :rtype: str + """ + return self._custom_ui_url + + @custom_ui_url.setter + def custom_ui_url(self, custom_ui_url): + """ + Sets the custom_ui_url of this ParameterProviderDTO. + The URL for the custom configuration UI for the parameter provider. + + :param custom_ui_url: The custom_ui_url of this ParameterProviderDTO. + :type: str + """ + + self._custom_ui_url = custom_ui_url + + @property + def deprecated(self): + """ + Gets the deprecated of this ParameterProviderDTO. + Whether the parameter provider has been deprecated. + + :return: The deprecated of this ParameterProviderDTO. :rtype: bool """ - return self._persists_state + return self._deprecated - @persists_state.setter - def persists_state(self, persists_state): + @deprecated.setter + def deprecated(self, deprecated): """ - Sets the persists_state of this ParameterProviderDTO. - Whether the parameter provider persists state. + Sets the deprecated of this ParameterProviderDTO. + Whether the parameter provider has been deprecated. - :param persists_state: The persists_state of this ParameterProviderDTO. + :param deprecated: The deprecated of this ParameterProviderDTO. :type: bool """ - self._persists_state = persists_state + self._deprecated = deprecated @property - def restricted(self): + def descriptors(self): """ - Gets the restricted of this ParameterProviderDTO. - Whether the parameter provider requires elevated privileges. + Gets the descriptors of this ParameterProviderDTO. + The descriptors for the parameter providers properties. - :return: The restricted of this ParameterProviderDTO. + :return: The descriptors of this ParameterProviderDTO. + :rtype: dict(str, PropertyDescriptorDTO) + """ + return self._descriptors + + @descriptors.setter + def descriptors(self, descriptors): + """ + Sets the descriptors of this ParameterProviderDTO. + The descriptors for the parameter providers properties. + + :param descriptors: The descriptors of this ParameterProviderDTO. + :type: dict(str, PropertyDescriptorDTO) + """ + + self._descriptors = descriptors + + @property + def extension_missing(self): + """ + Gets the extension_missing of this ParameterProviderDTO. + Whether the underlying extension is missing. + + :return: The extension_missing of this ParameterProviderDTO. :rtype: bool """ - return self._restricted + return self._extension_missing - @restricted.setter - def restricted(self, restricted): + @extension_missing.setter + def extension_missing(self, extension_missing): """ - Sets the restricted of this ParameterProviderDTO. - Whether the parameter provider requires elevated privileges. + Sets the extension_missing of this ParameterProviderDTO. + Whether the underlying extension is missing. - :param restricted: The restricted of this ParameterProviderDTO. + :param extension_missing: The extension_missing of this ParameterProviderDTO. :type: bool """ - self._restricted = restricted + self._extension_missing = extension_missing @property - def deprecated(self): + def id(self): """ - Gets the deprecated of this ParameterProviderDTO. - Whether the parameter provider has been deprecated. + Gets the id of this ParameterProviderDTO. + The id of the component. - :return: The deprecated of this ParameterProviderDTO. - :rtype: bool + :return: The id of this ParameterProviderDTO. + :rtype: str """ - return self._deprecated + return self._id - @deprecated.setter - def deprecated(self, deprecated): + @id.setter + def id(self, id): """ - Sets the deprecated of this ParameterProviderDTO. - Whether the parameter provider has been deprecated. + Sets the id of this ParameterProviderDTO. + The id of the component. - :param deprecated: The deprecated of this ParameterProviderDTO. - :type: bool + :param id: The id of this ParameterProviderDTO. + :type: str """ - self._deprecated = deprecated + self._id = id @property def multiple_versions_available(self): @@ -432,50 +381,27 @@ def multiple_versions_available(self, multiple_versions_available): self._multiple_versions_available = multiple_versions_available @property - def properties(self): - """ - Gets the properties of this ParameterProviderDTO. - The properties of the parameter provider. - - :return: The properties of this ParameterProviderDTO. - :rtype: dict(str, str) - """ - return self._properties - - @properties.setter - def properties(self, properties): - """ - Sets the properties of this ParameterProviderDTO. - The properties of the parameter provider. - - :param properties: The properties of this ParameterProviderDTO. - :type: dict(str, str) - """ - - self._properties = properties - - @property - def descriptors(self): + def name(self): """ - Gets the descriptors of this ParameterProviderDTO. - The descriptors for the parameter providers properties. + Gets the name of this ParameterProviderDTO. + The name of the parameter provider. - :return: The descriptors of this ParameterProviderDTO. - :rtype: dict(str, PropertyDescriptorDTO) + :return: The name of this ParameterProviderDTO. + :rtype: str """ - return self._descriptors + return self._name - @descriptors.setter - def descriptors(self, descriptors): + @name.setter + def name(self, name): """ - Sets the descriptors of this ParameterProviderDTO. - The descriptors for the parameter providers properties. + Sets the name of this ParameterProviderDTO. + The name of the parameter provider. - :param descriptors: The descriptors of this ParameterProviderDTO. - :type: dict(str, PropertyDescriptorDTO) + :param name: The name of this ParameterProviderDTO. + :type: str """ - self._descriptors = descriptors + self._name = name @property def parameter_group_configurations(self): @@ -500,29 +426,6 @@ def parameter_group_configurations(self, parameter_group_configurations): self._parameter_group_configurations = parameter_group_configurations - @property - def affected_components(self): - """ - Gets the affected_components of this ParameterProviderDTO. - The set of all components in the flow that are referencing Parameters provided by this provider - - :return: The affected_components of this ParameterProviderDTO. - :rtype: list[AffectedComponentEntity] - """ - return self._affected_components - - @affected_components.setter - def affected_components(self, affected_components): - """ - Sets the affected_components of this ParameterProviderDTO. - The set of all components in the flow that are referencing Parameters provided by this provider - - :param affected_components: The affected_components of this ParameterProviderDTO. - :type: list[AffectedComponentEntity] - """ - - self._affected_components = affected_components - @property def parameter_status(self): """ @@ -546,6 +449,96 @@ def parameter_status(self, parameter_status): self._parameter_status = parameter_status + @property + def parent_group_id(self): + """ + Gets the parent_group_id of this ParameterProviderDTO. + The id of parent process group of this component if applicable. + + :return: The parent_group_id of this ParameterProviderDTO. + :rtype: str + """ + return self._parent_group_id + + @parent_group_id.setter + def parent_group_id(self, parent_group_id): + """ + Sets the parent_group_id of this ParameterProviderDTO. + The id of parent process group of this component if applicable. + + :param parent_group_id: The parent_group_id of this ParameterProviderDTO. + :type: str + """ + + self._parent_group_id = parent_group_id + + @property + def persists_state(self): + """ + Gets the persists_state of this ParameterProviderDTO. + Whether the parameter provider persists state. + + :return: The persists_state of this ParameterProviderDTO. + :rtype: bool + """ + return self._persists_state + + @persists_state.setter + def persists_state(self, persists_state): + """ + Sets the persists_state of this ParameterProviderDTO. + Whether the parameter provider persists state. + + :param persists_state: The persists_state of this ParameterProviderDTO. + :type: bool + """ + + self._persists_state = persists_state + + @property + def position(self): + """ + Gets the position of this ParameterProviderDTO. + + :return: The position of this ParameterProviderDTO. + :rtype: PositionDTO + """ + return self._position + + @position.setter + def position(self, position): + """ + Sets the position of this ParameterProviderDTO. + + :param position: The position of this ParameterProviderDTO. + :type: PositionDTO + """ + + self._position = position + + @property + def properties(self): + """ + Gets the properties of this ParameterProviderDTO. + The properties of the parameter provider. + + :return: The properties of this ParameterProviderDTO. + :rtype: dict(str, str) + """ + return self._properties + + @properties.setter + def properties(self, properties): + """ + Sets the properties of this ParameterProviderDTO. + The properties of the parameter provider. + + :param properties: The properties of this ParameterProviderDTO. + :type: dict(str, str) + """ + + self._properties = properties + @property def referencing_parameter_contexts(self): """ @@ -570,50 +563,50 @@ def referencing_parameter_contexts(self, referencing_parameter_contexts): self._referencing_parameter_contexts = referencing_parameter_contexts @property - def custom_ui_url(self): + def restricted(self): """ - Gets the custom_ui_url of this ParameterProviderDTO. - The URL for the custom configuration UI for the parameter provider. + Gets the restricted of this ParameterProviderDTO. + Whether the parameter provider requires elevated privileges. - :return: The custom_ui_url of this ParameterProviderDTO. - :rtype: str + :return: The restricted of this ParameterProviderDTO. + :rtype: bool """ - return self._custom_ui_url + return self._restricted - @custom_ui_url.setter - def custom_ui_url(self, custom_ui_url): + @restricted.setter + def restricted(self, restricted): """ - Sets the custom_ui_url of this ParameterProviderDTO. - The URL for the custom configuration UI for the parameter provider. + Sets the restricted of this ParameterProviderDTO. + Whether the parameter provider requires elevated privileges. - :param custom_ui_url: The custom_ui_url of this ParameterProviderDTO. - :type: str + :param restricted: The restricted of this ParameterProviderDTO. + :type: bool """ - self._custom_ui_url = custom_ui_url + self._restricted = restricted @property - def annotation_data(self): + def type(self): """ - Gets the annotation_data of this ParameterProviderDTO. - The annotation data for the parameter provider. This is how the custom UI relays configuration to the parameter provider. + Gets the type of this ParameterProviderDTO. + The fully qualified type of the parameter provider. - :return: The annotation_data of this ParameterProviderDTO. + :return: The type of this ParameterProviderDTO. :rtype: str """ - return self._annotation_data + return self._type - @annotation_data.setter - def annotation_data(self, annotation_data): + @type.setter + def type(self, type): """ - Sets the annotation_data of this ParameterProviderDTO. - The annotation data for the parameter provider. This is how the custom UI relays configuration to the parameter provider. + Sets the type of this ParameterProviderDTO. + The fully qualified type of the parameter provider. - :param annotation_data: The annotation_data of this ParameterProviderDTO. + :param type: The type of this ParameterProviderDTO. :type: str """ - self._annotation_data = annotation_data + self._type = type @property def validation_errors(self): @@ -658,7 +651,7 @@ def validation_status(self, validation_status): :param validation_status: The validation_status of this ParameterProviderDTO. :type: str """ - allowed_values = ["VALID", "INVALID", "VALIDATING"] + 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}" @@ -668,27 +661,27 @@ def validation_status(self, validation_status): self._validation_status = validation_status @property - def extension_missing(self): + def versioned_component_id(self): """ - Gets the extension_missing of this ParameterProviderDTO. - Whether the underlying extension is missing. + Gets the versioned_component_id of this ParameterProviderDTO. + The ID of the corresponding component that is under version control - :return: The extension_missing of this ParameterProviderDTO. - :rtype: bool + :return: The versioned_component_id of this ParameterProviderDTO. + :rtype: str """ - return self._extension_missing + return self._versioned_component_id - @extension_missing.setter - def extension_missing(self, extension_missing): + @versioned_component_id.setter + def versioned_component_id(self, versioned_component_id): """ - Sets the extension_missing of this ParameterProviderDTO. - Whether the underlying extension is missing. + Sets the versioned_component_id of this ParameterProviderDTO. + The ID of the corresponding component that is under version control - :param extension_missing: The extension_missing of this ParameterProviderDTO. - :type: bool + :param versioned_component_id: The versioned_component_id of this ParameterProviderDTO. + :type: str """ - self._extension_missing = extension_missing + self._versioned_component_id = versioned_component_id def to_dict(self): """ diff --git a/nipyapi/nifi/models/parameter_provider_entity.py b/nipyapi/nifi/models/parameter_provider_entity.py index e3cf1058..9d9d2f01 100644 --- a/nipyapi/nifi/models/parameter_provider_entity.py +++ b/nipyapi/nifi/models/parameter_provider_entity.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,155 +27,150 @@ class ParameterProviderEntity(object): and the value is json key in definition. """ swagger_types = { - 'revision': 'RevisionDTO', - 'id': 'str', - 'uri': 'str', - 'position': 'PositionDTO', - 'permissions': 'PermissionsDTO', 'bulletins': 'list[BulletinEntity]', - 'disconnected_node_acknowledged': 'bool', - 'component': 'ParameterProviderDTO' - } +'component': 'ParameterProviderDTO', +'disconnected_node_acknowledged': 'bool', +'id': 'str', +'permissions': 'PermissionsDTO', +'position': 'PositionDTO', +'revision': 'RevisionDTO', +'uri': 'str' } attribute_map = { - 'revision': 'revision', - 'id': 'id', - 'uri': 'uri', - 'position': 'position', - 'permissions': 'permissions', 'bulletins': 'bulletins', - 'disconnected_node_acknowledged': 'disconnectedNodeAcknowledged', - 'component': 'component' - } +'component': 'component', +'disconnected_node_acknowledged': 'disconnectedNodeAcknowledged', +'id': 'id', +'permissions': 'permissions', +'position': 'position', +'revision': 'revision', +'uri': 'uri' } - def __init__(self, revision=None, id=None, uri=None, position=None, permissions=None, bulletins=None, disconnected_node_acknowledged=None, component=None): + def __init__(self, bulletins=None, component=None, disconnected_node_acknowledged=None, id=None, permissions=None, position=None, revision=None, uri=None): """ ParameterProviderEntity - a model defined in Swagger """ - self._revision = None - self._id = None - self._uri = None - self._position = None - self._permissions = None self._bulletins = None - self._disconnected_node_acknowledged = None self._component = None + self._disconnected_node_acknowledged = None + self._id = None + self._permissions = None + self._position = None + self._revision = None + self._uri = None - if revision is not None: - self.revision = revision - if id is not None: - self.id = id - if uri is not None: - self.uri = uri - if position is not None: - self.position = position - if permissions is not None: - self.permissions = permissions if bulletins is not None: self.bulletins = bulletins - if disconnected_node_acknowledged is not None: - self.disconnected_node_acknowledged = disconnected_node_acknowledged if component is not None: self.component = component + if disconnected_node_acknowledged is not None: + self.disconnected_node_acknowledged = disconnected_node_acknowledged + if id is not None: + self.id = id + if permissions is not None: + self.permissions = permissions + if position is not None: + self.position = position + if revision is not None: + self.revision = revision + if uri is not None: + self.uri = uri @property - def revision(self): + def bulletins(self): """ - Gets the revision of this ParameterProviderEntity. - The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses. + Gets the bulletins of this ParameterProviderEntity. + The bulletins for this component. - :return: The revision of this ParameterProviderEntity. - :rtype: RevisionDTO + :return: The bulletins of this ParameterProviderEntity. + :rtype: list[BulletinEntity] """ - return self._revision + return self._bulletins - @revision.setter - def revision(self, revision): + @bulletins.setter + def bulletins(self, bulletins): """ - Sets the revision of this ParameterProviderEntity. - The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses. + Sets the bulletins of this ParameterProviderEntity. + The bulletins for this component. - :param revision: The revision of this ParameterProviderEntity. - :type: RevisionDTO + :param bulletins: The bulletins of this ParameterProviderEntity. + :type: list[BulletinEntity] """ - self._revision = revision + self._bulletins = bulletins @property - def id(self): + def component(self): """ - Gets the id of this ParameterProviderEntity. - The id of the component. + Gets the component of this ParameterProviderEntity. - :return: The id of this ParameterProviderEntity. - :rtype: str + :return: The component of this ParameterProviderEntity. + :rtype: ParameterProviderDTO """ - return self._id + return self._component - @id.setter - def id(self, id): + @component.setter + def component(self, component): """ - Sets the id of this ParameterProviderEntity. - The id of the component. + Sets the component of this ParameterProviderEntity. - :param id: The id of this ParameterProviderEntity. - :type: str + :param component: The component of this ParameterProviderEntity. + :type: ParameterProviderDTO """ - self._id = id + self._component = component @property - def uri(self): + def disconnected_node_acknowledged(self): """ - Gets the uri of this ParameterProviderEntity. - The URI for futures requests to the component. + Gets the disconnected_node_acknowledged of this ParameterProviderEntity. + Acknowledges that this node is disconnected to allow for mutable requests to proceed. - :return: The uri of this ParameterProviderEntity. - :rtype: str + :return: The disconnected_node_acknowledged of this ParameterProviderEntity. + :rtype: bool """ - return self._uri + return self._disconnected_node_acknowledged - @uri.setter - def uri(self, uri): + @disconnected_node_acknowledged.setter + def disconnected_node_acknowledged(self, disconnected_node_acknowledged): """ - Sets the uri of this ParameterProviderEntity. - The URI for futures requests to the component. + Sets the disconnected_node_acknowledged of this ParameterProviderEntity. + Acknowledges that this node is disconnected to allow for mutable requests to proceed. - :param uri: The uri of this ParameterProviderEntity. - :type: str + :param disconnected_node_acknowledged: The disconnected_node_acknowledged of this ParameterProviderEntity. + :type: bool """ - self._uri = uri + self._disconnected_node_acknowledged = disconnected_node_acknowledged @property - def position(self): + def id(self): """ - Gets the position of this ParameterProviderEntity. - The position of this component in the UI if applicable. + Gets the id of this ParameterProviderEntity. + The id of the component. - :return: The position of this ParameterProviderEntity. - :rtype: PositionDTO + :return: The id of this ParameterProviderEntity. + :rtype: str """ - return self._position + return self._id - @position.setter - def position(self, position): + @id.setter + def id(self, id): """ - Sets the position of this ParameterProviderEntity. - The position of this component in the UI if applicable. + Sets the id of this ParameterProviderEntity. + The id of the component. - :param position: The position of this ParameterProviderEntity. - :type: PositionDTO + :param id: The id of this ParameterProviderEntity. + :type: str """ - self._position = position + self._id = id @property def permissions(self): """ Gets the permissions of this ParameterProviderEntity. - The permissions for this component. :return: The permissions of this ParameterProviderEntity. :rtype: PermissionsDTO @@ -187,7 +181,6 @@ def permissions(self): def permissions(self, permissions): """ Sets the permissions of this ParameterProviderEntity. - The permissions for this component. :param permissions: The permissions of this ParameterProviderEntity. :type: PermissionsDTO @@ -196,71 +189,69 @@ def permissions(self, permissions): self._permissions = permissions @property - def bulletins(self): + def position(self): """ - Gets the bulletins of this ParameterProviderEntity. - The bulletins for this component. + Gets the position of this ParameterProviderEntity. - :return: The bulletins of this ParameterProviderEntity. - :rtype: list[BulletinEntity] + :return: The position of this ParameterProviderEntity. + :rtype: PositionDTO """ - return self._bulletins + return self._position - @bulletins.setter - def bulletins(self, bulletins): + @position.setter + def position(self, position): """ - Sets the bulletins of this ParameterProviderEntity. - The bulletins for this component. + Sets the position of this ParameterProviderEntity. - :param bulletins: The bulletins of this ParameterProviderEntity. - :type: list[BulletinEntity] + :param position: The position of this ParameterProviderEntity. + :type: PositionDTO """ - self._bulletins = bulletins + self._position = position @property - def disconnected_node_acknowledged(self): + def revision(self): """ - Gets the disconnected_node_acknowledged of this ParameterProviderEntity. - Acknowledges that this node is disconnected to allow for mutable requests to proceed. + Gets the revision of this ParameterProviderEntity. - :return: The disconnected_node_acknowledged of this ParameterProviderEntity. - :rtype: bool + :return: The revision of this ParameterProviderEntity. + :rtype: RevisionDTO """ - return self._disconnected_node_acknowledged + return self._revision - @disconnected_node_acknowledged.setter - def disconnected_node_acknowledged(self, disconnected_node_acknowledged): + @revision.setter + def revision(self, revision): """ - Sets the disconnected_node_acknowledged of this ParameterProviderEntity. - Acknowledges that this node is disconnected to allow for mutable requests to proceed. + Sets the revision of this ParameterProviderEntity. - :param disconnected_node_acknowledged: The disconnected_node_acknowledged of this ParameterProviderEntity. - :type: bool + :param revision: The revision of this ParameterProviderEntity. + :type: RevisionDTO """ - self._disconnected_node_acknowledged = disconnected_node_acknowledged + self._revision = revision @property - def component(self): + def uri(self): """ - Gets the component of this ParameterProviderEntity. + Gets the uri of this ParameterProviderEntity. + The URI for futures requests to the component. - :return: The component of this ParameterProviderEntity. - :rtype: ParameterProviderDTO + :return: The uri of this ParameterProviderEntity. + :rtype: str """ - return self._component + return self._uri - @component.setter - def component(self, component): + @uri.setter + def uri(self, uri): """ - Sets the component of this ParameterProviderEntity. + Sets the uri of this ParameterProviderEntity. + The URI for futures requests to the component. - :param component: The component of this ParameterProviderEntity. - :type: ParameterProviderDTO + :param uri: The uri of this ParameterProviderEntity. + :type: str """ - self._component = component + self._uri = uri def to_dict(self): """ diff --git a/nipyapi/nifi/models/parameter_provider_parameter_application_entity.py b/nipyapi/nifi/models/parameter_provider_parameter_application_entity.py index fde0a1cb..b8e05f45 100644 --- a/nipyapi/nifi/models/parameter_provider_parameter_application_entity.py +++ b/nipyapi/nifi/models/parameter_provider_parameter_application_entity.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,83 +27,35 @@ class ParameterProviderParameterApplicationEntity(object): and the value is json key in definition. """ swagger_types = { - 'id': 'str', - 'revision': 'RevisionDTO', 'disconnected_node_acknowledged': 'bool', - 'parameter_group_configurations': 'list[ParameterGroupConfigurationEntity]' - } +'id': 'str', +'parameter_group_configurations': 'list[ParameterGroupConfigurationEntity]', +'revision': 'RevisionDTO' } attribute_map = { - 'id': 'id', - 'revision': 'revision', 'disconnected_node_acknowledged': 'disconnectedNodeAcknowledged', - 'parameter_group_configurations': 'parameterGroupConfigurations' - } +'id': 'id', +'parameter_group_configurations': 'parameterGroupConfigurations', +'revision': 'revision' } - def __init__(self, id=None, revision=None, disconnected_node_acknowledged=None, parameter_group_configurations=None): + def __init__(self, disconnected_node_acknowledged=None, id=None, parameter_group_configurations=None, revision=None): """ ParameterProviderParameterApplicationEntity - a model defined in Swagger """ - self._id = None - self._revision = None self._disconnected_node_acknowledged = None + self._id = None self._parameter_group_configurations = None + self._revision = None - if id is not None: - self.id = id - if revision is not None: - self.revision = revision if disconnected_node_acknowledged is not None: self.disconnected_node_acknowledged = disconnected_node_acknowledged + if id is not None: + self.id = id if parameter_group_configurations is not None: self.parameter_group_configurations = parameter_group_configurations - - @property - def id(self): - """ - Gets the id of this ParameterProviderParameterApplicationEntity. - The id of the parameter provider. - - :return: The id of this ParameterProviderParameterApplicationEntity. - :rtype: str - """ - return self._id - - @id.setter - def id(self, id): - """ - Sets the id of this ParameterProviderParameterApplicationEntity. - The id of the parameter provider. - - :param id: The id of this ParameterProviderParameterApplicationEntity. - :type: str - """ - - self._id = id - - @property - def revision(self): - """ - Gets the revision of this ParameterProviderParameterApplicationEntity. - The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses. - - :return: The revision of this ParameterProviderParameterApplicationEntity. - :rtype: RevisionDTO - """ - return self._revision - - @revision.setter - def revision(self, revision): - """ - Sets the revision of this ParameterProviderParameterApplicationEntity. - The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses. - - :param revision: The revision of this ParameterProviderParameterApplicationEntity. - :type: RevisionDTO - """ - - self._revision = revision + if revision is not None: + self.revision = revision @property def disconnected_node_acknowledged(self): @@ -129,6 +80,29 @@ def disconnected_node_acknowledged(self, disconnected_node_acknowledged): self._disconnected_node_acknowledged = disconnected_node_acknowledged + @property + def id(self): + """ + Gets the id of this ParameterProviderParameterApplicationEntity. + The id of the parameter provider. + + :return: The id of this ParameterProviderParameterApplicationEntity. + :rtype: str + """ + return self._id + + @id.setter + def id(self, id): + """ + Sets the id of this ParameterProviderParameterApplicationEntity. + The id of the parameter provider. + + :param id: The id of this ParameterProviderParameterApplicationEntity. + :type: str + """ + + self._id = id + @property def parameter_group_configurations(self): """ @@ -152,6 +126,27 @@ def parameter_group_configurations(self, parameter_group_configurations): self._parameter_group_configurations = parameter_group_configurations + @property + def revision(self): + """ + Gets the revision of this ParameterProviderParameterApplicationEntity. + + :return: The revision of this ParameterProviderParameterApplicationEntity. + :rtype: RevisionDTO + """ + return self._revision + + @revision.setter + def revision(self, revision): + """ + Sets the revision of this ParameterProviderParameterApplicationEntity. + + :param revision: The revision of this ParameterProviderParameterApplicationEntity. + :type: RevisionDTO + """ + + self._revision = revision + def to_dict(self): """ Returns the model properties as a dict diff --git a/nipyapi/nifi/models/parameter_provider_parameter_fetch_entity.py b/nipyapi/nifi/models/parameter_provider_parameter_fetch_entity.py index b04dcb6f..5f3569db 100644 --- a/nipyapi/nifi/models/parameter_provider_parameter_fetch_entity.py +++ b/nipyapi/nifi/models/parameter_provider_parameter_fetch_entity.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,32 +27,53 @@ class ParameterProviderParameterFetchEntity(object): and the value is json key in definition. """ swagger_types = { - 'id': 'str', - 'revision': 'RevisionDTO', - 'disconnected_node_acknowledged': 'bool' - } + 'disconnected_node_acknowledged': 'bool', +'id': 'str', +'revision': 'RevisionDTO' } attribute_map = { - 'id': 'id', - 'revision': 'revision', - 'disconnected_node_acknowledged': 'disconnectedNodeAcknowledged' - } + 'disconnected_node_acknowledged': 'disconnectedNodeAcknowledged', +'id': 'id', +'revision': 'revision' } - def __init__(self, id=None, revision=None, disconnected_node_acknowledged=None): + def __init__(self, disconnected_node_acknowledged=None, id=None, revision=None): """ ParameterProviderParameterFetchEntity - a model defined in Swagger """ + self._disconnected_node_acknowledged = None self._id = None self._revision = None - self._disconnected_node_acknowledged = None + if disconnected_node_acknowledged is not None: + self.disconnected_node_acknowledged = disconnected_node_acknowledged if id is not None: self.id = id if revision is not None: self.revision = revision - if disconnected_node_acknowledged is not None: - self.disconnected_node_acknowledged = disconnected_node_acknowledged + + @property + def disconnected_node_acknowledged(self): + """ + Gets the disconnected_node_acknowledged of this ParameterProviderParameterFetchEntity. + Acknowledges that this node is disconnected to allow for mutable requests to proceed. + + :return: The disconnected_node_acknowledged of this ParameterProviderParameterFetchEntity. + :rtype: bool + """ + return self._disconnected_node_acknowledged + + @disconnected_node_acknowledged.setter + def disconnected_node_acknowledged(self, disconnected_node_acknowledged): + """ + Sets the disconnected_node_acknowledged of this ParameterProviderParameterFetchEntity. + Acknowledges that this node is disconnected to allow for mutable requests to proceed. + + :param disconnected_node_acknowledged: The disconnected_node_acknowledged of this ParameterProviderParameterFetchEntity. + :type: bool + """ + + self._disconnected_node_acknowledged = disconnected_node_acknowledged @property def id(self): @@ -82,7 +102,6 @@ def id(self, id): def revision(self): """ Gets the revision of this ParameterProviderParameterFetchEntity. - The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses. :return: The revision of this ParameterProviderParameterFetchEntity. :rtype: RevisionDTO @@ -93,7 +112,6 @@ def revision(self): def revision(self, revision): """ Sets the revision of this ParameterProviderParameterFetchEntity. - The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses. :param revision: The revision of this ParameterProviderParameterFetchEntity. :type: RevisionDTO @@ -101,29 +119,6 @@ def revision(self, revision): self._revision = revision - @property - def disconnected_node_acknowledged(self): - """ - Gets the disconnected_node_acknowledged of this ParameterProviderParameterFetchEntity. - Acknowledges that this node is disconnected to allow for mutable requests to proceed. - - :return: The disconnected_node_acknowledged of this ParameterProviderParameterFetchEntity. - :rtype: bool - """ - return self._disconnected_node_acknowledged - - @disconnected_node_acknowledged.setter - def disconnected_node_acknowledged(self, disconnected_node_acknowledged): - """ - Sets the disconnected_node_acknowledged of this ParameterProviderParameterFetchEntity. - Acknowledges that this node is disconnected to allow for mutable requests to proceed. - - :param disconnected_node_acknowledged: The disconnected_node_acknowledged of this ParameterProviderParameterFetchEntity. - :type: bool - """ - - self._disconnected_node_acknowledged = disconnected_node_acknowledged - def to_dict(self): """ Returns the model properties as a dict diff --git a/nipyapi/nifi/models/parameter_provider_reference.py b/nipyapi/nifi/models/parameter_provider_reference.py index 884a4a78..2bca1922 100644 --- a/nipyapi/nifi/models/parameter_provider_reference.py +++ b/nipyapi/nifi/models/parameter_provider_reference.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,37 +27,56 @@ class ParameterProviderReference(object): and the value is json key in definition. """ swagger_types = { - 'identifier': 'str', - 'name': 'str', - 'type': 'str', - 'bundle': 'Bundle' - } + 'bundle': 'Bundle', +'identifier': 'str', +'name': 'str', +'type': 'str' } attribute_map = { - 'identifier': 'identifier', - 'name': 'name', - 'type': 'type', - 'bundle': 'bundle' - } + 'bundle': 'bundle', +'identifier': 'identifier', +'name': 'name', +'type': 'type' } - def __init__(self, identifier=None, name=None, type=None, bundle=None): + def __init__(self, bundle=None, identifier=None, name=None, type=None): """ ParameterProviderReference - a model defined in Swagger """ + self._bundle = None self._identifier = None self._name = None self._type = None - self._bundle = None + if bundle is not None: + self.bundle = bundle if identifier is not None: self.identifier = identifier if name is not None: self.name = name if type is not None: self.type = type - if bundle is not None: - self.bundle = bundle + + @property + def bundle(self): + """ + Gets the bundle of this ParameterProviderReference. + + :return: The bundle of this ParameterProviderReference. + :rtype: Bundle + """ + return self._bundle + + @bundle.setter + def bundle(self, bundle): + """ + Sets the bundle of this ParameterProviderReference. + + :param bundle: The bundle of this ParameterProviderReference. + :type: Bundle + """ + + self._bundle = bundle @property def identifier(self): @@ -129,29 +147,6 @@ def type(self, type): self._type = type - @property - def bundle(self): - """ - Gets the bundle of this ParameterProviderReference. - The details of the artifact that bundled this parameter provider. - - :return: The bundle of this ParameterProviderReference. - :rtype: Bundle - """ - return self._bundle - - @bundle.setter - def bundle(self, bundle): - """ - Sets the bundle of this ParameterProviderReference. - The details of the artifact that bundled this parameter provider. - - :param bundle: The bundle of this ParameterProviderReference. - :type: Bundle - """ - - self._bundle = bundle - def to_dict(self): """ Returns the model properties as a dict diff --git a/nipyapi/nifi/models/parameter_provider_referencing_component_dto.py b/nipyapi/nifi/models/parameter_provider_referencing_component_dto.py index ef2cfaf4..eb682430 100644 --- a/nipyapi/nifi/models/parameter_provider_referencing_component_dto.py +++ b/nipyapi/nifi/models/parameter_provider_referencing_component_dto.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -29,13 +28,11 @@ class ParameterProviderReferencingComponentDTO(object): """ swagger_types = { 'id': 'str', - 'name': 'str' - } +'name': 'str' } attribute_map = { 'id': 'id', - 'name': 'name' - } +'name': 'name' } def __init__(self, id=None, name=None): """ diff --git a/nipyapi/nifi/models/parameter_provider_referencing_component_entity.py b/nipyapi/nifi/models/parameter_provider_referencing_component_entity.py index f3ccc291..7f778d31 100644 --- a/nipyapi/nifi/models/parameter_provider_referencing_component_entity.py +++ b/nipyapi/nifi/models/parameter_provider_referencing_component_entity.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,155 +27,150 @@ class ParameterProviderReferencingComponentEntity(object): and the value is json key in definition. """ swagger_types = { - 'revision': 'RevisionDTO', - 'id': 'str', - 'uri': 'str', - 'position': 'PositionDTO', - 'permissions': 'PermissionsDTO', 'bulletins': 'list[BulletinEntity]', - 'disconnected_node_acknowledged': 'bool', - 'component': 'ParameterProviderReferencingComponentDTO' - } +'component': 'ParameterProviderReferencingComponentDTO', +'disconnected_node_acknowledged': 'bool', +'id': 'str', +'permissions': 'PermissionsDTO', +'position': 'PositionDTO', +'revision': 'RevisionDTO', +'uri': 'str' } attribute_map = { - 'revision': 'revision', - 'id': 'id', - 'uri': 'uri', - 'position': 'position', - 'permissions': 'permissions', 'bulletins': 'bulletins', - 'disconnected_node_acknowledged': 'disconnectedNodeAcknowledged', - 'component': 'component' - } +'component': 'component', +'disconnected_node_acknowledged': 'disconnectedNodeAcknowledged', +'id': 'id', +'permissions': 'permissions', +'position': 'position', +'revision': 'revision', +'uri': 'uri' } - def __init__(self, revision=None, id=None, uri=None, position=None, permissions=None, bulletins=None, disconnected_node_acknowledged=None, component=None): + def __init__(self, bulletins=None, component=None, disconnected_node_acknowledged=None, id=None, permissions=None, position=None, revision=None, uri=None): """ ParameterProviderReferencingComponentEntity - a model defined in Swagger """ - self._revision = None - self._id = None - self._uri = None - self._position = None - self._permissions = None self._bulletins = None - self._disconnected_node_acknowledged = None self._component = None + self._disconnected_node_acknowledged = None + self._id = None + self._permissions = None + self._position = None + self._revision = None + self._uri = None - if revision is not None: - self.revision = revision - if id is not None: - self.id = id - if uri is not None: - self.uri = uri - if position is not None: - self.position = position - if permissions is not None: - self.permissions = permissions if bulletins is not None: self.bulletins = bulletins - if disconnected_node_acknowledged is not None: - self.disconnected_node_acknowledged = disconnected_node_acknowledged if component is not None: self.component = component + if disconnected_node_acknowledged is not None: + self.disconnected_node_acknowledged = disconnected_node_acknowledged + if id is not None: + self.id = id + if permissions is not None: + self.permissions = permissions + if position is not None: + self.position = position + if revision is not None: + self.revision = revision + if uri is not None: + self.uri = uri @property - def revision(self): + def bulletins(self): """ - Gets the revision of this ParameterProviderReferencingComponentEntity. - The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses. + Gets the bulletins of this ParameterProviderReferencingComponentEntity. + The bulletins for this component. - :return: The revision of this ParameterProviderReferencingComponentEntity. - :rtype: RevisionDTO + :return: The bulletins of this ParameterProviderReferencingComponentEntity. + :rtype: list[BulletinEntity] """ - return self._revision + return self._bulletins - @revision.setter - def revision(self, revision): + @bulletins.setter + def bulletins(self, bulletins): """ - Sets the revision of this ParameterProviderReferencingComponentEntity. - The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses. + Sets the bulletins of this ParameterProviderReferencingComponentEntity. + The bulletins for this component. - :param revision: The revision of this ParameterProviderReferencingComponentEntity. - :type: RevisionDTO + :param bulletins: The bulletins of this ParameterProviderReferencingComponentEntity. + :type: list[BulletinEntity] """ - self._revision = revision + self._bulletins = bulletins @property - def id(self): + def component(self): """ - Gets the id of this ParameterProviderReferencingComponentEntity. - The id of the component. + Gets the component of this ParameterProviderReferencingComponentEntity. - :return: The id of this ParameterProviderReferencingComponentEntity. - :rtype: str + :return: The component of this ParameterProviderReferencingComponentEntity. + :rtype: ParameterProviderReferencingComponentDTO """ - return self._id + return self._component - @id.setter - def id(self, id): + @component.setter + def component(self, component): """ - Sets the id of this ParameterProviderReferencingComponentEntity. - The id of the component. + Sets the component of this ParameterProviderReferencingComponentEntity. - :param id: The id of this ParameterProviderReferencingComponentEntity. - :type: str + :param component: The component of this ParameterProviderReferencingComponentEntity. + :type: ParameterProviderReferencingComponentDTO """ - self._id = id + self._component = component @property - def uri(self): + def disconnected_node_acknowledged(self): """ - Gets the uri of this ParameterProviderReferencingComponentEntity. - The URI for futures requests to the component. + Gets the disconnected_node_acknowledged of this ParameterProviderReferencingComponentEntity. + Acknowledges that this node is disconnected to allow for mutable requests to proceed. - :return: The uri of this ParameterProviderReferencingComponentEntity. - :rtype: str + :return: The disconnected_node_acknowledged of this ParameterProviderReferencingComponentEntity. + :rtype: bool """ - return self._uri + return self._disconnected_node_acknowledged - @uri.setter - def uri(self, uri): + @disconnected_node_acknowledged.setter + def disconnected_node_acknowledged(self, disconnected_node_acknowledged): """ - Sets the uri of this ParameterProviderReferencingComponentEntity. - The URI for futures requests to the component. + Sets the disconnected_node_acknowledged of this ParameterProviderReferencingComponentEntity. + Acknowledges that this node is disconnected to allow for mutable requests to proceed. - :param uri: The uri of this ParameterProviderReferencingComponentEntity. - :type: str + :param disconnected_node_acknowledged: The disconnected_node_acknowledged of this ParameterProviderReferencingComponentEntity. + :type: bool """ - self._uri = uri + self._disconnected_node_acknowledged = disconnected_node_acknowledged @property - def position(self): + def id(self): """ - Gets the position of this ParameterProviderReferencingComponentEntity. - The position of this component in the UI if applicable. + Gets the id of this ParameterProviderReferencingComponentEntity. + The id of the component. - :return: The position of this ParameterProviderReferencingComponentEntity. - :rtype: PositionDTO + :return: The id of this ParameterProviderReferencingComponentEntity. + :rtype: str """ - return self._position + return self._id - @position.setter - def position(self, position): + @id.setter + def id(self, id): """ - Sets the position of this ParameterProviderReferencingComponentEntity. - The position of this component in the UI if applicable. + Sets the id of this ParameterProviderReferencingComponentEntity. + The id of the component. - :param position: The position of this ParameterProviderReferencingComponentEntity. - :type: PositionDTO + :param id: The id of this ParameterProviderReferencingComponentEntity. + :type: str """ - self._position = position + self._id = id @property def permissions(self): """ Gets the permissions of this ParameterProviderReferencingComponentEntity. - The permissions for this component. :return: The permissions of this ParameterProviderReferencingComponentEntity. :rtype: PermissionsDTO @@ -187,7 +181,6 @@ def permissions(self): def permissions(self, permissions): """ Sets the permissions of this ParameterProviderReferencingComponentEntity. - The permissions for this component. :param permissions: The permissions of this ParameterProviderReferencingComponentEntity. :type: PermissionsDTO @@ -196,71 +189,69 @@ def permissions(self, permissions): self._permissions = permissions @property - def bulletins(self): + def position(self): """ - Gets the bulletins of this ParameterProviderReferencingComponentEntity. - The bulletins for this component. + Gets the position of this ParameterProviderReferencingComponentEntity. - :return: The bulletins of this ParameterProviderReferencingComponentEntity. - :rtype: list[BulletinEntity] + :return: The position of this ParameterProviderReferencingComponentEntity. + :rtype: PositionDTO """ - return self._bulletins + return self._position - @bulletins.setter - def bulletins(self, bulletins): + @position.setter + def position(self, position): """ - Sets the bulletins of this ParameterProviderReferencingComponentEntity. - The bulletins for this component. + Sets the position of this ParameterProviderReferencingComponentEntity. - :param bulletins: The bulletins of this ParameterProviderReferencingComponentEntity. - :type: list[BulletinEntity] + :param position: The position of this ParameterProviderReferencingComponentEntity. + :type: PositionDTO """ - self._bulletins = bulletins + self._position = position @property - def disconnected_node_acknowledged(self): + def revision(self): """ - Gets the disconnected_node_acknowledged of this ParameterProviderReferencingComponentEntity. - Acknowledges that this node is disconnected to allow for mutable requests to proceed. + Gets the revision of this ParameterProviderReferencingComponentEntity. - :return: The disconnected_node_acknowledged of this ParameterProviderReferencingComponentEntity. - :rtype: bool + :return: The revision of this ParameterProviderReferencingComponentEntity. + :rtype: RevisionDTO """ - return self._disconnected_node_acknowledged + return self._revision - @disconnected_node_acknowledged.setter - def disconnected_node_acknowledged(self, disconnected_node_acknowledged): + @revision.setter + def revision(self, revision): """ - Sets the disconnected_node_acknowledged of this ParameterProviderReferencingComponentEntity. - Acknowledges that this node is disconnected to allow for mutable requests to proceed. + Sets the revision of this ParameterProviderReferencingComponentEntity. - :param disconnected_node_acknowledged: The disconnected_node_acknowledged of this ParameterProviderReferencingComponentEntity. - :type: bool + :param revision: The revision of this ParameterProviderReferencingComponentEntity. + :type: RevisionDTO """ - self._disconnected_node_acknowledged = disconnected_node_acknowledged + self._revision = revision @property - def component(self): + def uri(self): """ - Gets the component of this ParameterProviderReferencingComponentEntity. + Gets the uri of this ParameterProviderReferencingComponentEntity. + The URI for futures requests to the component. - :return: The component of this ParameterProviderReferencingComponentEntity. - :rtype: ParameterProviderReferencingComponentDTO + :return: The uri of this ParameterProviderReferencingComponentEntity. + :rtype: str """ - return self._component + return self._uri - @component.setter - def component(self, component): + @uri.setter + def uri(self, uri): """ - Sets the component of this ParameterProviderReferencingComponentEntity. + Sets the uri of this ParameterProviderReferencingComponentEntity. + The URI for futures requests to the component. - :param component: The component of this ParameterProviderReferencingComponentEntity. - :type: ParameterProviderReferencingComponentDTO + :param uri: The uri of this ParameterProviderReferencingComponentEntity. + :type: str """ - self._component = component + self._uri = uri def to_dict(self): """ diff --git a/nipyapi/nifi/models/parameter_provider_referencing_components_entity.py b/nipyapi/nifi/models/parameter_provider_referencing_components_entity.py index 6cbfb35b..e271be05 100644 --- a/nipyapi/nifi/models/parameter_provider_referencing_components_entity.py +++ b/nipyapi/nifi/models/parameter_provider_referencing_components_entity.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,12 +27,10 @@ class ParameterProviderReferencingComponentsEntity(object): and the value is json key in definition. """ swagger_types = { - 'parameter_provider_referencing_components': 'list[ParameterProviderReferencingComponentEntity]' - } + 'parameter_provider_referencing_components': 'list[ParameterProviderReferencingComponentEntity]' } attribute_map = { - 'parameter_provider_referencing_components': 'parameterProviderReferencingComponents' - } + 'parameter_provider_referencing_components': 'parameterProviderReferencingComponents' } def __init__(self, parameter_provider_referencing_components=None): """ diff --git a/nipyapi/nifi/models/parameter_provider_types_entity.py b/nipyapi/nifi/models/parameter_provider_types_entity.py index 9def0c4a..7e414a2d 100644 --- a/nipyapi/nifi/models/parameter_provider_types_entity.py +++ b/nipyapi/nifi/models/parameter_provider_types_entity.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,12 +27,10 @@ class ParameterProviderTypesEntity(object): and the value is json key in definition. """ swagger_types = { - 'parameter_provider_types': 'list[DocumentedTypeDTO]' - } + 'parameter_provider_types': 'list[DocumentedTypeDTO]' } attribute_map = { - 'parameter_provider_types': 'parameterProviderTypes' - } + 'parameter_provider_types': 'parameterProviderTypes' } def __init__(self, parameter_provider_types=None): """ diff --git a/nipyapi/nifi/models/parameter_providers_entity.py b/nipyapi/nifi/models/parameter_providers_entity.py index a850d67e..6f00829e 100644 --- a/nipyapi/nifi/models/parameter_providers_entity.py +++ b/nipyapi/nifi/models/parameter_providers_entity.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,23 +27,49 @@ class ParameterProvidersEntity(object): and the value is json key in definition. """ swagger_types = { - 'parameter_providers': 'list[ParameterProviderEntity]' - } + 'current_time': 'str', +'parameter_providers': 'list[ParameterProviderEntity]' } attribute_map = { - 'parameter_providers': 'parameterProviders' - } + 'current_time': 'currentTime', +'parameter_providers': 'parameterProviders' } - def __init__(self, parameter_providers=None): + def __init__(self, current_time=None, parameter_providers=None): """ ParameterProvidersEntity - a model defined in Swagger """ + self._current_time = None self._parameter_providers = None + if current_time is not None: + self.current_time = current_time if parameter_providers is not None: self.parameter_providers = parameter_providers + @property + def current_time(self): + """ + Gets the current_time of this ParameterProvidersEntity. + The current time on the system. + + :return: The current_time of this ParameterProvidersEntity. + :rtype: str + """ + return self._current_time + + @current_time.setter + def current_time(self, current_time): + """ + Sets the current_time of this ParameterProvidersEntity. + The current time on the system. + + :param current_time: The current_time of this ParameterProvidersEntity. + :type: str + """ + + self._current_time = current_time + @property def parameter_providers(self): """ diff --git a/nipyapi/nifi/models/parameter_status_dto.py b/nipyapi/nifi/models/parameter_status_dto.py index b9e90507..c596b0e0 100644 --- a/nipyapi/nifi/models/parameter_status_dto.py +++ b/nipyapi/nifi/models/parameter_status_dto.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -29,13 +28,11 @@ class ParameterStatusDTO(object): """ swagger_types = { 'parameter': 'ParameterEntity', - 'status': 'str' - } +'status': 'str' } attribute_map = { 'parameter': 'parameter', - 'status': 'status' - } +'status': 'status' } def __init__(self, parameter=None, status=None): """ @@ -54,7 +51,6 @@ def __init__(self, parameter=None, status=None): def parameter(self): """ Gets the parameter of this ParameterStatusDTO. - The name of the Parameter :return: The parameter of this ParameterStatusDTO. :rtype: ParameterEntity @@ -65,7 +61,6 @@ def parameter(self): def parameter(self, parameter): """ Sets the parameter of this ParameterStatusDTO. - The name of the Parameter :param parameter: The parameter of this ParameterStatusDTO. :type: ParameterEntity @@ -93,7 +88,7 @@ def status(self, status): :param status: The status of this ParameterStatusDTO. :type: str """ - allowed_values = ["NEW", "CHANGED", "REMOVED", "MISSING_BUT_REFERENCED", "UNCHANGED"] + 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}" diff --git a/nipyapi/nifi/models/paste_request_entity.py b/nipyapi/nifi/models/paste_request_entity.py new file mode 100644 index 00000000..09f085fd --- /dev/null +++ b/nipyapi/nifi/models/paste_request_entity.py @@ -0,0 +1,169 @@ +""" + Apache NiFi REST API + + REST API definition for Apache NiFi web services + + OpenAPI spec version: 2.5.0 + Contact: dev@nifi.apache.org + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from pprint import pformat +import re + + +class PasteRequestEntity(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 = { + 'copy_response': 'CopyResponseEntity', +'disconnected_node_acknowledged': 'bool', +'revision': 'RevisionDTO' } + + attribute_map = { + 'copy_response': 'copyResponse', +'disconnected_node_acknowledged': 'disconnectedNodeAcknowledged', +'revision': 'revision' } + + def __init__(self, copy_response=None, disconnected_node_acknowledged=None, revision=None): + """ + PasteRequestEntity - a model defined in Swagger + """ + + self._copy_response = None + self._disconnected_node_acknowledged = None + self._revision = None + + if copy_response is not None: + self.copy_response = copy_response + if disconnected_node_acknowledged is not None: + self.disconnected_node_acknowledged = disconnected_node_acknowledged + if revision is not None: + self.revision = revision + + @property + def copy_response(self): + """ + Gets the copy_response of this PasteRequestEntity. + + :return: The copy_response of this PasteRequestEntity. + :rtype: CopyResponseEntity + """ + return self._copy_response + + @copy_response.setter + def copy_response(self, copy_response): + """ + Sets the copy_response of this PasteRequestEntity. + + :param copy_response: The copy_response of this PasteRequestEntity. + :type: CopyResponseEntity + """ + + self._copy_response = copy_response + + @property + def disconnected_node_acknowledged(self): + """ + Gets the disconnected_node_acknowledged of this PasteRequestEntity. + + :return: The disconnected_node_acknowledged of this PasteRequestEntity. + :rtype: bool + """ + return self._disconnected_node_acknowledged + + @disconnected_node_acknowledged.setter + def disconnected_node_acknowledged(self, disconnected_node_acknowledged): + """ + Sets the disconnected_node_acknowledged of this PasteRequestEntity. + + :param disconnected_node_acknowledged: The disconnected_node_acknowledged of this PasteRequestEntity. + :type: bool + """ + + self._disconnected_node_acknowledged = disconnected_node_acknowledged + + @property + def revision(self): + """ + Gets the revision of this PasteRequestEntity. + + :return: The revision of this PasteRequestEntity. + :rtype: RevisionDTO + """ + return self._revision + + @revision.setter + def revision(self, revision): + """ + Sets the revision of this PasteRequestEntity. + + :param revision: The revision of this PasteRequestEntity. + :type: RevisionDTO + """ + + self._revision = revision + + 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, PasteRequestEntity): + 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/paste_response_entity.py b/nipyapi/nifi/models/paste_response_entity.py new file mode 100644 index 00000000..e5fd0416 --- /dev/null +++ b/nipyapi/nifi/models/paste_response_entity.py @@ -0,0 +1,143 @@ +""" + Apache NiFi REST API + + REST API definition for Apache NiFi web services + + OpenAPI spec version: 2.5.0 + Contact: dev@nifi.apache.org + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from pprint import pformat +import re + + +class PasteResponseEntity(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 = { + 'flow': 'FlowDTO', +'revision': 'RevisionDTO' } + + attribute_map = { + 'flow': 'flow', +'revision': 'revision' } + + def __init__(self, flow=None, revision=None): + """ + PasteResponseEntity - a model defined in Swagger + """ + + self._flow = None + self._revision = None + + if flow is not None: + self.flow = flow + if revision is not None: + self.revision = revision + + @property + def flow(self): + """ + Gets the flow of this PasteResponseEntity. + + :return: The flow of this PasteResponseEntity. + :rtype: FlowDTO + """ + return self._flow + + @flow.setter + def flow(self, flow): + """ + Sets the flow of this PasteResponseEntity. + + :param flow: The flow of this PasteResponseEntity. + :type: FlowDTO + """ + + self._flow = flow + + @property + def revision(self): + """ + Gets the revision of this PasteResponseEntity. + + :return: The revision of this PasteResponseEntity. + :rtype: RevisionDTO + """ + return self._revision + + @revision.setter + def revision(self, revision): + """ + Sets the revision of this PasteResponseEntity. + + :param revision: The revision of this PasteResponseEntity. + :type: RevisionDTO + """ + + self._revision = revision + + 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, PasteResponseEntity): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """ + Returns true if both objects are not equal + """ + return not self == other diff --git a/nipyapi/nifi/models/peer_dto.py b/nipyapi/nifi/models/peer_dto.py index 8351fb97..ebd5e539 100644 --- a/nipyapi/nifi/models/peer_dto.py +++ b/nipyapi/nifi/models/peer_dto.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,37 +27,58 @@ class PeerDTO(object): and the value is json key in definition. """ swagger_types = { - 'hostname': 'str', - 'port': 'int', - 'secure': 'bool', - 'flow_file_count': 'int' - } + 'flow_file_count': 'int', +'hostname': 'str', +'port': 'int', +'secure': 'bool' } attribute_map = { - 'hostname': 'hostname', - 'port': 'port', - 'secure': 'secure', - 'flow_file_count': 'flowFileCount' - } + 'flow_file_count': 'flowFileCount', +'hostname': 'hostname', +'port': 'port', +'secure': 'secure' } - def __init__(self, hostname=None, port=None, secure=None, flow_file_count=None): + def __init__(self, flow_file_count=None, hostname=None, port=None, secure=None): """ PeerDTO - a model defined in Swagger """ + self._flow_file_count = None self._hostname = None self._port = None self._secure = None - self._flow_file_count = None + if flow_file_count is not None: + self.flow_file_count = flow_file_count if hostname is not None: self.hostname = hostname if port is not None: self.port = port if secure is not None: self.secure = secure - if flow_file_count is not None: - self.flow_file_count = flow_file_count + + @property + def flow_file_count(self): + """ + Gets the flow_file_count of this PeerDTO. + The number of flowFiles this peer holds. + + :return: The flow_file_count of this PeerDTO. + :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 PeerDTO. + The number of flowFiles this peer holds. + + :param flow_file_count: The flow_file_count of this PeerDTO. + :type: int + """ + + self._flow_file_count = flow_file_count @property def hostname(self): @@ -129,29 +149,6 @@ def secure(self, secure): self._secure = secure - @property - def flow_file_count(self): - """ - Gets the flow_file_count of this PeerDTO. - The number of flowFiles this peer holds. - - :return: The flow_file_count of this PeerDTO. - :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 PeerDTO. - The number of flowFiles this peer holds. - - :param flow_file_count: The flow_file_count of this PeerDTO. - :type: int - """ - - self._flow_file_count = flow_file_count - def to_dict(self): """ Returns the model properties as a dict diff --git a/nipyapi/nifi/models/peers_entity.py b/nipyapi/nifi/models/peers_entity.py index e8ba3409..e97b9771 100644 --- a/nipyapi/nifi/models/peers_entity.py +++ b/nipyapi/nifi/models/peers_entity.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,12 +27,10 @@ class PeersEntity(object): and the value is json key in definition. """ swagger_types = { - 'peers': 'list[PeerDTO]' - } + 'peers': 'list[PeerDTO]' } attribute_map = { - 'peers': 'peers' - } + 'peers': 'peers' } def __init__(self, peers=None): """ diff --git a/nipyapi/nifi/models/permissions_dto.py b/nipyapi/nifi/models/permissions_dto.py index 80eef042..f23db825 100644 --- a/nipyapi/nifi/models/permissions_dto.py +++ b/nipyapi/nifi/models/permissions_dto.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -29,13 +28,11 @@ class PermissionsDTO(object): """ swagger_types = { 'can_read': 'bool', - 'can_write': 'bool' - } +'can_write': 'bool' } attribute_map = { 'can_read': 'canRead', - 'can_write': 'canWrite' - } +'can_write': 'canWrite' } def __init__(self, can_read=None, can_write=None): """ diff --git a/nipyapi/nifi/models/port_dto.py b/nipyapi/nifi/models/port_dto.py index 2f55c4c6..9b4e9825 100644 --- a/nipyapi/nifi/models/port_dto.py +++ b/nipyapi/nifi/models/port_dto.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,87 +27,149 @@ class PortDTO(object): and the value is json key in definition. """ swagger_types = { - 'id': 'str', - 'versioned_component_id': 'str', - 'parent_group_id': 'str', - 'position': 'PositionDTO', - 'name': 'str', - 'comments': 'str', - 'state': 'str', - 'type': 'str', - 'transmitting': 'bool', - 'concurrently_schedulable_task_count': 'int', - 'user_access_control': 'list[str]', - 'group_access_control': 'list[str]', 'allow_remote_access': 'bool', - 'validation_errors': 'list[str]' - } +'comments': 'str', +'concurrently_schedulable_task_count': 'int', +'id': 'str', +'name': 'str', +'parent_group_id': 'str', +'port_function': 'str', +'position': 'PositionDTO', +'state': 'str', +'transmitting': 'bool', +'type': 'str', +'validation_errors': 'list[str]', +'versioned_component_id': 'str' } attribute_map = { - 'id': 'id', - 'versioned_component_id': 'versionedComponentId', - 'parent_group_id': 'parentGroupId', - 'position': 'position', - 'name': 'name', - 'comments': 'comments', - 'state': 'state', - 'type': 'type', - 'transmitting': 'transmitting', - 'concurrently_schedulable_task_count': 'concurrentlySchedulableTaskCount', - 'user_access_control': 'userAccessControl', - 'group_access_control': 'groupAccessControl', 'allow_remote_access': 'allowRemoteAccess', - 'validation_errors': 'validationErrors' - } - - def __init__(self, id=None, versioned_component_id=None, parent_group_id=None, position=None, name=None, comments=None, state=None, type=None, transmitting=None, concurrently_schedulable_task_count=None, user_access_control=None, group_access_control=None, allow_remote_access=None, validation_errors=None): +'comments': 'comments', +'concurrently_schedulable_task_count': 'concurrentlySchedulableTaskCount', +'id': 'id', +'name': 'name', +'parent_group_id': 'parentGroupId', +'port_function': 'portFunction', +'position': 'position', +'state': 'state', +'transmitting': 'transmitting', +'type': 'type', +'validation_errors': 'validationErrors', +'versioned_component_id': 'versionedComponentId' } + + def __init__(self, allow_remote_access=None, comments=None, concurrently_schedulable_task_count=None, id=None, name=None, parent_group_id=None, port_function=None, position=None, state=None, transmitting=None, type=None, validation_errors=None, versioned_component_id=None): """ PortDTO - a model defined in Swagger """ + self._allow_remote_access = None + self._comments = None + self._concurrently_schedulable_task_count = None self._id = None - self._versioned_component_id = None + self._name = None self._parent_group_id = None + self._port_function = None self._position = None - self._name = None - self._comments = None self._state = None - self._type = None self._transmitting = None - self._concurrently_schedulable_task_count = None - self._user_access_control = None - self._group_access_control = None - self._allow_remote_access = None + self._type = None self._validation_errors = None + self._versioned_component_id = None + if allow_remote_access is not None: + self.allow_remote_access = allow_remote_access + if comments is not None: + self.comments = comments + if concurrently_schedulable_task_count is not None: + self.concurrently_schedulable_task_count = concurrently_schedulable_task_count if id is not None: self.id = id - if versioned_component_id is not None: - self.versioned_component_id = versioned_component_id + if name is not None: + self.name = name if parent_group_id is not None: self.parent_group_id = parent_group_id + if port_function is not None: + self.port_function = port_function if position is not None: self.position = position - if name is not None: - self.name = name - if comments is not None: - self.comments = comments if state is not None: self.state = state - if type is not None: - self.type = type if transmitting is not None: self.transmitting = transmitting - if concurrently_schedulable_task_count is not None: - self.concurrently_schedulable_task_count = concurrently_schedulable_task_count - if user_access_control is not None: - self.user_access_control = user_access_control - if group_access_control is not None: - self.group_access_control = group_access_control - if allow_remote_access is not None: - self.allow_remote_access = allow_remote_access + if type is not None: + self.type = type if validation_errors is not None: self.validation_errors = validation_errors + if versioned_component_id is not None: + self.versioned_component_id = versioned_component_id + + @property + def allow_remote_access(self): + """ + Gets the allow_remote_access of this PortDTO. + Whether this port can be accessed remotely via Site-to-Site protocol. + + :return: The allow_remote_access of this PortDTO. + :rtype: bool + """ + return self._allow_remote_access + + @allow_remote_access.setter + def allow_remote_access(self, allow_remote_access): + """ + Sets the allow_remote_access of this PortDTO. + Whether this port can be accessed remotely via Site-to-Site protocol. + + :param allow_remote_access: The allow_remote_access of this PortDTO. + :type: bool + """ + + self._allow_remote_access = allow_remote_access + + @property + def comments(self): + """ + Gets the comments of this PortDTO. + The comments for the port. + + :return: The comments of this PortDTO. + :rtype: str + """ + return self._comments + + @comments.setter + def comments(self, comments): + """ + Sets the comments of this PortDTO. + The comments for the port. + + :param comments: The comments of this PortDTO. + :type: str + """ + + self._comments = comments + + @property + def concurrently_schedulable_task_count(self): + """ + Gets the concurrently_schedulable_task_count of this PortDTO. + The number of tasks that should be concurrently scheduled for the port. + + :return: The concurrently_schedulable_task_count of this PortDTO. + :rtype: int + """ + return self._concurrently_schedulable_task_count + + @concurrently_schedulable_task_count.setter + def concurrently_schedulable_task_count(self, concurrently_schedulable_task_count): + """ + Sets the concurrently_schedulable_task_count of this PortDTO. + The number of tasks that should be concurrently scheduled for the port. + + :param concurrently_schedulable_task_count: The concurrently_schedulable_task_count of this PortDTO. + :type: int + """ + + self._concurrently_schedulable_task_count = concurrently_schedulable_task_count @property def id(self): @@ -134,27 +195,27 @@ def id(self, id): self._id = id @property - def versioned_component_id(self): + def name(self): """ - Gets the versioned_component_id of this PortDTO. - The ID of the corresponding component that is under version control + Gets the name of this PortDTO. + The name of the port. - :return: The versioned_component_id of this PortDTO. + :return: The name of this PortDTO. :rtype: str """ - return self._versioned_component_id + return self._name - @versioned_component_id.setter - def versioned_component_id(self, versioned_component_id): + @name.setter + def name(self, name): """ - Sets the versioned_component_id of this PortDTO. - The ID of the corresponding component that is under version control + Sets the name of this PortDTO. + The name of the port. - :param versioned_component_id: The versioned_component_id of this PortDTO. + :param name: The name of this PortDTO. :type: str """ - self._versioned_component_id = versioned_component_id + self._name = name @property def parent_group_id(self): @@ -180,73 +241,54 @@ def parent_group_id(self, parent_group_id): self._parent_group_id = parent_group_id @property - def position(self): - """ - Gets the position of this PortDTO. - The position of this component in the UI if applicable. - - :return: The position of this PortDTO. - :rtype: PositionDTO + def port_function(self): """ - return self._position + Gets the port_function of this PortDTO. + Specifies how the Port functions - @position.setter - def position(self, position): - """ - Sets the position of this PortDTO. - The position of this component in the UI if applicable. - - :param position: The position of this PortDTO. - :type: PositionDTO - """ - - self._position = position - - @property - def name(self): - """ - Gets the name of this PortDTO. - The name of the port. - - :return: The name of this PortDTO. + :return: The port_function of this PortDTO. :rtype: str """ - return self._name + return self._port_function - @name.setter - def name(self, name): + @port_function.setter + def port_function(self, port_function): """ - Sets the name of this PortDTO. - The name of the port. + Sets the port_function of this PortDTO. + Specifies how the Port functions - :param name: The name of this PortDTO. + :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) + ) - self._name = name + self._port_function = port_function @property - def comments(self): + def position(self): """ - Gets the comments of this PortDTO. - The comments for the port. + Gets the position of this PortDTO. - :return: The comments of this PortDTO. - :rtype: str + :return: The position of this PortDTO. + :rtype: PositionDTO """ - return self._comments + return self._position - @comments.setter - def comments(self, comments): + @position.setter + def position(self, position): """ - Sets the comments of this PortDTO. - The comments for the port. + Sets the position of this PortDTO. - :param comments: The comments of this PortDTO. - :type: str + :param position: The position of this PortDTO. + :type: PositionDTO """ - self._comments = comments + self._position = position @property def state(self): @@ -268,7 +310,7 @@ def state(self, state): :param state: The state of this PortDTO. :type: str """ - allowed_values = ["RUNNING", "STOPPED", "DISABLED"] + allowed_values = ["RUNNING", "STOPPED", "DISABLED", ] if state not in allowed_values: raise ValueError( "Invalid value for `state` ({0}), must be one of {1}" @@ -277,35 +319,6 @@ def state(self, state): self._state = state - @property - def type(self): - """ - Gets the type of this PortDTO. - The type of port. - - :return: The type of this PortDTO. - :rtype: str - """ - return self._type - - @type.setter - def type(self, type): - """ - Sets the type of this PortDTO. - The type of port. - - :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) - ) - - self._type = type - @property def transmitting(self): """ @@ -330,96 +343,33 @@ def transmitting(self, transmitting): self._transmitting = transmitting @property - def concurrently_schedulable_task_count(self): - """ - Gets the concurrently_schedulable_task_count of this PortDTO. - The number of tasks that should be concurrently scheduled for the port. - - :return: The concurrently_schedulable_task_count of this PortDTO. - :rtype: int - """ - return self._concurrently_schedulable_task_count - - @concurrently_schedulable_task_count.setter - def concurrently_schedulable_task_count(self, concurrently_schedulable_task_count): - """ - Sets the concurrently_schedulable_task_count of this PortDTO. - The number of tasks that should be concurrently scheduled for the port. - - :param concurrently_schedulable_task_count: The concurrently_schedulable_task_count of this PortDTO. - :type: int - """ - - self._concurrently_schedulable_task_count = concurrently_schedulable_task_count - - @property - def user_access_control(self): - """ - Gets the user_access_control of this PortDTO. - The users that are allowed to access the port. - - :return: The user_access_control of this PortDTO. - :rtype: list[str] - """ - return self._user_access_control - - @user_access_control.setter - def user_access_control(self, user_access_control): - """ - Sets the user_access_control of this PortDTO. - The users that are allowed to access the port. - - :param user_access_control: The user_access_control of this PortDTO. - :type: list[str] - """ - - self._user_access_control = user_access_control - - @property - def group_access_control(self): - """ - Gets the group_access_control of this PortDTO. - The user groups that are allowed to access the port. - - :return: The group_access_control of this PortDTO. - :rtype: list[str] - """ - return self._group_access_control - - @group_access_control.setter - def group_access_control(self, group_access_control): - """ - Sets the group_access_control of this PortDTO. - The user groups that are allowed to access the port. - - :param group_access_control: The group_access_control of this PortDTO. - :type: list[str] - """ - - self._group_access_control = group_access_control - - @property - def allow_remote_access(self): + def type(self): """ - Gets the allow_remote_access of this PortDTO. - Whether this port can be accessed remotely via Site-to-Site protocol. + Gets the type of this PortDTO. + The type of port. - :return: The allow_remote_access of this PortDTO. - :rtype: bool + :return: The type of this PortDTO. + :rtype: str """ - return self._allow_remote_access + return self._type - @allow_remote_access.setter - def allow_remote_access(self, allow_remote_access): + @type.setter + def type(self, type): """ - Sets the allow_remote_access of this PortDTO. - Whether this port can be accessed remotely via Site-to-Site protocol. + Sets the type of this PortDTO. + The type of port. - :param allow_remote_access: The allow_remote_access of this PortDTO. - :type: bool + :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) + ) - self._allow_remote_access = allow_remote_access + self._type = type @property def validation_errors(self): @@ -444,6 +394,29 @@ def validation_errors(self, validation_errors): self._validation_errors = validation_errors + @property + def versioned_component_id(self): + """ + Gets the versioned_component_id of this PortDTO. + The ID of the corresponding component that is under version control + + :return: The versioned_component_id of this PortDTO. + :rtype: str + """ + return self._versioned_component_id + + @versioned_component_id.setter + def versioned_component_id(self, versioned_component_id): + """ + Sets the versioned_component_id of this PortDTO. + The ID of the corresponding component that is under version control + + :param versioned_component_id: The versioned_component_id of this PortDTO. + :type: str + """ + + self._versioned_component_id = versioned_component_id + def to_dict(self): """ Returns the model properties as a dict diff --git a/nipyapi/nifi/models/port_entity.py b/nipyapi/nifi/models/port_entity.py index b0bc416e..7f37c265 100644 --- a/nipyapi/nifi/models/port_entity.py +++ b/nipyapi/nifi/models/port_entity.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,100 +27,165 @@ class PortEntity(object): and the value is json key in definition. """ swagger_types = { - 'revision': 'RevisionDTO', - 'id': 'str', - 'uri': 'str', - 'position': 'PositionDTO', - 'permissions': 'PermissionsDTO', - 'bulletins': 'list[BulletinEntity]', - 'disconnected_node_acknowledged': 'bool', - 'component': 'PortDTO', - 'status': 'PortStatusDTO', - 'port_type': 'str', - 'operate_permissions': 'PermissionsDTO', - 'allow_remote_access': 'bool' - } + 'allow_remote_access': 'bool', +'bulletins': 'list[BulletinEntity]', +'component': 'PortDTO', +'disconnected_node_acknowledged': 'bool', +'id': 'str', +'operate_permissions': 'PermissionsDTO', +'permissions': 'PermissionsDTO', +'port_type': 'str', +'position': 'PositionDTO', +'revision': 'RevisionDTO', +'status': 'PortStatusDTO', +'uri': 'str' } attribute_map = { - 'revision': 'revision', - 'id': 'id', - 'uri': 'uri', - 'position': 'position', - 'permissions': 'permissions', - 'bulletins': 'bulletins', - 'disconnected_node_acknowledged': 'disconnectedNodeAcknowledged', - 'component': 'component', - 'status': 'status', - 'port_type': 'portType', - 'operate_permissions': 'operatePermissions', - 'allow_remote_access': 'allowRemoteAccess' - } - - def __init__(self, revision=None, id=None, uri=None, position=None, permissions=None, bulletins=None, disconnected_node_acknowledged=None, component=None, status=None, port_type=None, operate_permissions=None, allow_remote_access=None): + 'allow_remote_access': 'allowRemoteAccess', +'bulletins': 'bulletins', +'component': 'component', +'disconnected_node_acknowledged': 'disconnectedNodeAcknowledged', +'id': 'id', +'operate_permissions': 'operatePermissions', +'permissions': 'permissions', +'port_type': 'portType', +'position': 'position', +'revision': 'revision', +'status': 'status', +'uri': 'uri' } + + def __init__(self, allow_remote_access=None, bulletins=None, component=None, disconnected_node_acknowledged=None, id=None, operate_permissions=None, permissions=None, port_type=None, position=None, revision=None, status=None, uri=None): """ PortEntity - a model defined in Swagger """ - self._revision = None - self._id = None - self._uri = None - self._position = None - self._permissions = None + self._allow_remote_access = None self._bulletins = None - self._disconnected_node_acknowledged = None self._component = None - self._status = None - self._port_type = None + self._disconnected_node_acknowledged = None + self._id = None self._operate_permissions = None - self._allow_remote_access = None + self._permissions = None + self._port_type = None + self._position = None + self._revision = None + self._status = None + self._uri = None - if revision is not None: - self.revision = revision - if id is not None: - self.id = id - if uri is not None: - self.uri = uri - if position is not None: - self.position = position - if permissions is not None: - self.permissions = permissions + if allow_remote_access is not None: + self.allow_remote_access = allow_remote_access if bulletins is not None: self.bulletins = bulletins - if disconnected_node_acknowledged is not None: - self.disconnected_node_acknowledged = disconnected_node_acknowledged if component is not None: self.component = component - if status is not None: - self.status = status - if port_type is not None: - self.port_type = port_type + if disconnected_node_acknowledged is not None: + self.disconnected_node_acknowledged = disconnected_node_acknowledged + if id is not None: + self.id = id if operate_permissions is not None: self.operate_permissions = operate_permissions - if allow_remote_access is not None: - self.allow_remote_access = allow_remote_access + if permissions is not None: + self.permissions = permissions + if port_type is not None: + self.port_type = port_type + if position is not None: + self.position = position + if revision is not None: + self.revision = revision + if status is not None: + self.status = status + if uri is not None: + self.uri = uri @property - def revision(self): + def allow_remote_access(self): """ - Gets the revision of this PortEntity. - The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses. + Gets the allow_remote_access of this PortEntity. + Whether this port can be accessed remotely via Site-to-Site protocol. - :return: The revision of this PortEntity. - :rtype: RevisionDTO + :return: The allow_remote_access of this PortEntity. + :rtype: bool """ - return self._revision + return self._allow_remote_access - @revision.setter - def revision(self, revision): + @allow_remote_access.setter + def allow_remote_access(self, allow_remote_access): """ - Sets the revision of this PortEntity. - The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses. + Sets the allow_remote_access of this PortEntity. + Whether this port can be accessed remotely via Site-to-Site protocol. - :param revision: The revision of this PortEntity. - :type: RevisionDTO + :param allow_remote_access: The allow_remote_access of this PortEntity. + :type: bool """ - self._revision = revision + self._allow_remote_access = allow_remote_access + + @property + def bulletins(self): + """ + Gets the bulletins of this PortEntity. + The bulletins for this component. + + :return: The bulletins of this PortEntity. + :rtype: list[BulletinEntity] + """ + return self._bulletins + + @bulletins.setter + def bulletins(self, bulletins): + """ + Sets the bulletins of this PortEntity. + The bulletins for this component. + + :param bulletins: The bulletins of this PortEntity. + :type: list[BulletinEntity] + """ + + self._bulletins = bulletins + + @property + def component(self): + """ + Gets the component of this PortEntity. + + :return: The component of this PortEntity. + :rtype: PortDTO + """ + return self._component + + @component.setter + def component(self, component): + """ + Sets the component of this PortEntity. + + :param component: The component of this PortEntity. + :type: PortDTO + """ + + self._component = component + + @property + def disconnected_node_acknowledged(self): + """ + Gets the disconnected_node_acknowledged of this PortEntity. + Acknowledges that this node is disconnected to allow for mutable requests to proceed. + + :return: The disconnected_node_acknowledged of this PortEntity. + :rtype: bool + """ + return self._disconnected_node_acknowledged + + @disconnected_node_acknowledged.setter + def disconnected_node_acknowledged(self, disconnected_node_acknowledged): + """ + Sets the disconnected_node_acknowledged of this PortEntity. + Acknowledges that this node is disconnected to allow for mutable requests to proceed. + + :param disconnected_node_acknowledged: The disconnected_node_acknowledged of this PortEntity. + :type: bool + """ + + self._disconnected_node_acknowledged = disconnected_node_acknowledged @property def id(self): @@ -147,56 +211,30 @@ def id(self, id): self._id = id @property - def uri(self): - """ - Gets the uri of this PortEntity. - The URI for futures requests to the component. - - :return: The uri of this PortEntity. - :rtype: str - """ - return self._uri - - @uri.setter - def uri(self, uri): - """ - Sets the uri of this PortEntity. - The URI for futures requests to the component. - - :param uri: The uri of this PortEntity. - :type: str - """ - - self._uri = uri - - @property - def position(self): + def operate_permissions(self): """ - Gets the position of this PortEntity. - The position of this component in the UI if applicable. + Gets the operate_permissions of this PortEntity. - :return: The position of this PortEntity. - :rtype: PositionDTO + :return: The operate_permissions of this PortEntity. + :rtype: PermissionsDTO """ - return self._position + return self._operate_permissions - @position.setter - def position(self, position): + @operate_permissions.setter + def operate_permissions(self, operate_permissions): """ - Sets the position of this PortEntity. - The position of this component in the UI if applicable. + Sets the operate_permissions of this PortEntity. - :param position: The position of this PortEntity. - :type: PositionDTO + :param operate_permissions: The operate_permissions of this PortEntity. + :type: PermissionsDTO """ - self._position = position + self._operate_permissions = operate_permissions @property def permissions(self): """ Gets the permissions of this PortEntity. - The permissions for this component. :return: The permissions of this PortEntity. :rtype: PermissionsDTO @@ -207,7 +245,6 @@ def permissions(self): def permissions(self, permissions): """ Sets the permissions of this PortEntity. - The permissions for this component. :param permissions: The permissions of this PortEntity. :type: PermissionsDTO @@ -216,77 +253,72 @@ def permissions(self, permissions): self._permissions = permissions @property - def bulletins(self): + def port_type(self): """ - Gets the bulletins of this PortEntity. - The bulletins for this component. + Gets the port_type of this PortEntity. - :return: The bulletins of this PortEntity. - :rtype: list[BulletinEntity] + :return: The port_type of this PortEntity. + :rtype: str """ - return self._bulletins + return self._port_type - @bulletins.setter - def bulletins(self, bulletins): + @port_type.setter + def port_type(self, port_type): """ - Sets the bulletins of this PortEntity. - The bulletins for this component. + Sets the port_type of this PortEntity. - :param bulletins: The bulletins of this PortEntity. - :type: list[BulletinEntity] + :param port_type: The port_type of this PortEntity. + :type: str """ - self._bulletins = bulletins + self._port_type = port_type @property - def disconnected_node_acknowledged(self): + def position(self): """ - Gets the disconnected_node_acknowledged of this PortEntity. - Acknowledges that this node is disconnected to allow for mutable requests to proceed. + Gets the position of this PortEntity. - :return: The disconnected_node_acknowledged of this PortEntity. - :rtype: bool + :return: The position of this PortEntity. + :rtype: PositionDTO """ - return self._disconnected_node_acknowledged + return self._position - @disconnected_node_acknowledged.setter - def disconnected_node_acknowledged(self, disconnected_node_acknowledged): + @position.setter + def position(self, position): """ - Sets the disconnected_node_acknowledged of this PortEntity. - Acknowledges that this node is disconnected to allow for mutable requests to proceed. + Sets the position of this PortEntity. - :param disconnected_node_acknowledged: The disconnected_node_acknowledged of this PortEntity. - :type: bool + :param position: The position of this PortEntity. + :type: PositionDTO """ - self._disconnected_node_acknowledged = disconnected_node_acknowledged + self._position = position @property - def component(self): + def revision(self): """ - Gets the component of this PortEntity. + Gets the revision of this PortEntity. - :return: The component of this PortEntity. - :rtype: PortDTO + :return: The revision of this PortEntity. + :rtype: RevisionDTO """ - return self._component + return self._revision - @component.setter - def component(self, component): + @revision.setter + def revision(self, revision): """ - Sets the component of this PortEntity. + Sets the revision of this PortEntity. - :param component: The component of this PortEntity. - :type: PortDTO + :param revision: The revision of this PortEntity. + :type: RevisionDTO """ - self._component = component + self._revision = revision @property def status(self): """ Gets the status of this PortEntity. - The status of the port. :return: The status of this PortEntity. :rtype: PortStatusDTO @@ -297,7 +329,6 @@ def status(self): def status(self, status): """ Sets the status of this PortEntity. - The status of the port. :param status: The status of this PortEntity. :type: PortStatusDTO @@ -306,71 +337,27 @@ def status(self, status): self._status = status @property - def port_type(self): + def uri(self): """ - Gets the port_type of this PortEntity. + Gets the uri of this PortEntity. + The URI for futures requests to the component. - :return: The port_type of this PortEntity. + :return: The uri of this PortEntity. :rtype: str """ - return self._port_type + return self._uri - @port_type.setter - def port_type(self, port_type): + @uri.setter + def uri(self, uri): """ - Sets the port_type of this PortEntity. + Sets the uri of this PortEntity. + The URI for futures requests to the component. - :param port_type: The port_type of this PortEntity. + :param uri: The uri of this PortEntity. :type: str """ - self._port_type = port_type - - @property - def operate_permissions(self): - """ - Gets the operate_permissions of this PortEntity. - The permissions for this component operations. - - :return: The operate_permissions of this PortEntity. - :rtype: PermissionsDTO - """ - return self._operate_permissions - - @operate_permissions.setter - def operate_permissions(self, operate_permissions): - """ - Sets the operate_permissions of this PortEntity. - The permissions for this component operations. - - :param operate_permissions: The operate_permissions of this PortEntity. - :type: PermissionsDTO - """ - - self._operate_permissions = operate_permissions - - @property - def allow_remote_access(self): - """ - Gets the allow_remote_access of this PortEntity. - Whether this port can be accessed remotely via Site-to-Site protocol. - - :return: The allow_remote_access of this PortEntity. - :rtype: bool - """ - return self._allow_remote_access - - @allow_remote_access.setter - def allow_remote_access(self, allow_remote_access): - """ - Sets the allow_remote_access of this PortEntity. - Whether this port can be accessed remotely via Site-to-Site protocol. - - :param allow_remote_access: The allow_remote_access of this PortEntity. - :type: bool - """ - - self._allow_remote_access = allow_remote_access + self._uri = uri def to_dict(self): """ diff --git a/nipyapi/nifi/models/port_run_status_entity.py b/nipyapi/nifi/models/port_run_status_entity.py index a34e3103..6a7c3d7d 100644 --- a/nipyapi/nifi/models/port_run_status_entity.py +++ b/nipyapi/nifi/models/port_run_status_entity.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,38 +27,58 @@ class PortRunStatusEntity(object): and the value is json key in definition. """ swagger_types = { - 'revision': 'RevisionDTO', - 'state': 'str', - 'disconnected_node_acknowledged': 'bool' - } + 'disconnected_node_acknowledged': 'bool', +'revision': 'RevisionDTO', +'state': 'str' } attribute_map = { - 'revision': 'revision', - 'state': 'state', - 'disconnected_node_acknowledged': 'disconnectedNodeAcknowledged' - } + 'disconnected_node_acknowledged': 'disconnectedNodeAcknowledged', +'revision': 'revision', +'state': 'state' } - def __init__(self, revision=None, state=None, disconnected_node_acknowledged=None): + def __init__(self, disconnected_node_acknowledged=None, revision=None, state=None): """ PortRunStatusEntity - a model defined in Swagger """ + self._disconnected_node_acknowledged = None self._revision = None self._state = None - self._disconnected_node_acknowledged = None + if disconnected_node_acknowledged is not None: + self.disconnected_node_acknowledged = disconnected_node_acknowledged if revision is not None: self.revision = revision if state is not None: self.state = state - if disconnected_node_acknowledged is not None: - self.disconnected_node_acknowledged = disconnected_node_acknowledged + + @property + def disconnected_node_acknowledged(self): + """ + Gets the disconnected_node_acknowledged of this PortRunStatusEntity. + Acknowledges that this node is disconnected to allow for mutable requests to proceed. + + :return: The disconnected_node_acknowledged of this PortRunStatusEntity. + :rtype: bool + """ + return self._disconnected_node_acknowledged + + @disconnected_node_acknowledged.setter + def disconnected_node_acknowledged(self, disconnected_node_acknowledged): + """ + Sets the disconnected_node_acknowledged of this PortRunStatusEntity. + Acknowledges that this node is disconnected to allow for mutable requests to proceed. + + :param disconnected_node_acknowledged: The disconnected_node_acknowledged of this PortRunStatusEntity. + :type: bool + """ + + self._disconnected_node_acknowledged = disconnected_node_acknowledged @property def revision(self): """ Gets the revision of this PortRunStatusEntity. - The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses. :return: The revision of this PortRunStatusEntity. :rtype: RevisionDTO @@ -70,7 +89,6 @@ def revision(self): def revision(self, revision): """ Sets the revision of this PortRunStatusEntity. - The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses. :param revision: The revision of this PortRunStatusEntity. :type: RevisionDTO @@ -98,7 +116,7 @@ def state(self, state): :param state: The state of this PortRunStatusEntity. :type: str """ - allowed_values = ["RUNNING", "STOPPED", "DISABLED"] + allowed_values = ["RUNNING", "STOPPED", "DISABLED", ] if state not in allowed_values: raise ValueError( "Invalid value for `state` ({0}), must be one of {1}" @@ -107,29 +125,6 @@ def state(self, state): self._state = state - @property - def disconnected_node_acknowledged(self): - """ - Gets the disconnected_node_acknowledged of this PortRunStatusEntity. - Acknowledges that this node is disconnected to allow for mutable requests to proceed. - - :return: The disconnected_node_acknowledged of this PortRunStatusEntity. - :rtype: bool - """ - return self._disconnected_node_acknowledged - - @disconnected_node_acknowledged.setter - def disconnected_node_acknowledged(self, disconnected_node_acknowledged): - """ - Sets the disconnected_node_acknowledged of this PortRunStatusEntity. - Acknowledges that this node is disconnected to allow for mutable requests to proceed. - - :param disconnected_node_acknowledged: The disconnected_node_acknowledged of this PortRunStatusEntity. - :type: bool - """ - - self._disconnected_node_acknowledged = disconnected_node_acknowledged - def to_dict(self): """ Returns the model properties as a dict diff --git a/nipyapi/nifi/models/port_status_dto.py b/nipyapi/nifi/models/port_status_dto.py index 386639f5..53d85f5a 100644 --- a/nipyapi/nifi/models/port_status_dto.py +++ b/nipyapi/nifi/models/port_status_dto.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,80 +27,76 @@ class PortStatusDTO(object): and the value is json key in definition. """ swagger_types = { - 'id': 'str', - 'group_id': 'str', - 'name': 'str', - 'transmitting': 'bool', - 'run_status': 'str', - 'stats_last_refreshed': 'str', 'aggregate_snapshot': 'PortStatusSnapshotDTO', - 'node_snapshots': 'list[NodePortStatusSnapshotDTO]' - } +'group_id': 'str', +'id': 'str', +'name': 'str', +'node_snapshots': 'list[NodePortStatusSnapshotDTO]', +'run_status': 'str', +'stats_last_refreshed': 'str', +'transmitting': 'bool' } attribute_map = { - 'id': 'id', - 'group_id': 'groupId', - 'name': 'name', - 'transmitting': 'transmitting', - 'run_status': 'runStatus', - 'stats_last_refreshed': 'statsLastRefreshed', 'aggregate_snapshot': 'aggregateSnapshot', - 'node_snapshots': 'nodeSnapshots' - } +'group_id': 'groupId', +'id': 'id', +'name': 'name', +'node_snapshots': 'nodeSnapshots', +'run_status': 'runStatus', +'stats_last_refreshed': 'statsLastRefreshed', +'transmitting': 'transmitting' } - def __init__(self, id=None, group_id=None, name=None, transmitting=None, run_status=None, stats_last_refreshed=None, aggregate_snapshot=None, node_snapshots=None): + def __init__(self, aggregate_snapshot=None, group_id=None, id=None, name=None, node_snapshots=None, run_status=None, stats_last_refreshed=None, transmitting=None): """ PortStatusDTO - a model defined in Swagger """ - self._id = None + self._aggregate_snapshot = None self._group_id = None + self._id = None self._name = None - self._transmitting = None + self._node_snapshots = None self._run_status = None self._stats_last_refreshed = None - self._aggregate_snapshot = None - self._node_snapshots = None + self._transmitting = None - if id is not None: - self.id = id + if aggregate_snapshot is not None: + self.aggregate_snapshot = aggregate_snapshot if group_id is not None: self.group_id = group_id + if id is not None: + self.id = id if name is not None: self.name = name - if transmitting is not None: - self.transmitting = transmitting + if node_snapshots is not None: + self.node_snapshots = node_snapshots if run_status is not None: self.run_status = run_status if stats_last_refreshed is not None: self.stats_last_refreshed = stats_last_refreshed - if aggregate_snapshot is not None: - self.aggregate_snapshot = aggregate_snapshot - if node_snapshots is not None: - self.node_snapshots = node_snapshots + if transmitting is not None: + self.transmitting = transmitting @property - def id(self): + def aggregate_snapshot(self): """ - Gets the id of this PortStatusDTO. - The id of the port. + Gets the aggregate_snapshot of this PortStatusDTO. - :return: The id of this PortStatusDTO. - :rtype: str + :return: The aggregate_snapshot of this PortStatusDTO. + :rtype: PortStatusSnapshotDTO """ - return self._id + return self._aggregate_snapshot - @id.setter - def id(self, id): + @aggregate_snapshot.setter + def aggregate_snapshot(self, aggregate_snapshot): """ - Sets the id of this PortStatusDTO. - The id of the port. + Sets the aggregate_snapshot of this PortStatusDTO. - :param id: The id of this PortStatusDTO. - :type: str + :param aggregate_snapshot: The aggregate_snapshot of this PortStatusDTO. + :type: PortStatusSnapshotDTO """ - self._id = id + self._aggregate_snapshot = aggregate_snapshot @property def group_id(self): @@ -126,6 +121,29 @@ def group_id(self, group_id): self._group_id = group_id + @property + def id(self): + """ + Gets the id of this PortStatusDTO. + The id of the port. + + :return: The id of this PortStatusDTO. + :rtype: str + """ + return self._id + + @id.setter + def id(self, id): + """ + Sets the id of this PortStatusDTO. + The id of the port. + + :param id: The id of this PortStatusDTO. + :type: str + """ + + self._id = id + @property def name(self): """ @@ -150,27 +168,27 @@ def name(self, name): self._name = name @property - def transmitting(self): + def node_snapshots(self): """ - Gets the transmitting of this PortStatusDTO. - Whether the port has incoming or outgoing connections to a remote NiFi. + Gets the node_snapshots of this PortStatusDTO. + A status snapshot for each node in the cluster. If the NiFi instance is a standalone instance, rather than a cluster, this may be null. - :return: The transmitting of this PortStatusDTO. - :rtype: bool + :return: The node_snapshots of this PortStatusDTO. + :rtype: list[NodePortStatusSnapshotDTO] """ - return self._transmitting + return self._node_snapshots - @transmitting.setter - def transmitting(self, transmitting): + @node_snapshots.setter + def node_snapshots(self, node_snapshots): """ - Sets the transmitting of this PortStatusDTO. - Whether the port has incoming or outgoing connections to a remote NiFi. + Sets the node_snapshots of this PortStatusDTO. + A status snapshot for each node in the cluster. If the NiFi instance is a standalone instance, rather than a cluster, this may be null. - :param transmitting: The transmitting of this PortStatusDTO. - :type: bool + :param node_snapshots: The node_snapshots of this PortStatusDTO. + :type: list[NodePortStatusSnapshotDTO] """ - self._transmitting = transmitting + self._node_snapshots = node_snapshots @property def run_status(self): @@ -192,7 +210,7 @@ def run_status(self, run_status): :param run_status: The run_status of this PortStatusDTO. :type: str """ - allowed_values = ["Running", "Stopped", "Validating", "Disabled", "Invalid"] + 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}" @@ -225,50 +243,27 @@ def stats_last_refreshed(self, stats_last_refreshed): self._stats_last_refreshed = stats_last_refreshed @property - def aggregate_snapshot(self): - """ - Gets the aggregate_snapshot of this PortStatusDTO. - A status snapshot that represents the aggregate stats of all nodes in the cluster. If the NiFi instance is a standalone instance, rather than a cluster, this represents the stats of the single instance. - - :return: The aggregate_snapshot of this PortStatusDTO. - :rtype: PortStatusSnapshotDTO - """ - return self._aggregate_snapshot - - @aggregate_snapshot.setter - def aggregate_snapshot(self, aggregate_snapshot): - """ - Sets the aggregate_snapshot of this PortStatusDTO. - A status snapshot that represents the aggregate stats of all nodes in the cluster. If the NiFi instance is a standalone instance, rather than a cluster, this represents the stats of the single instance. - - :param aggregate_snapshot: The aggregate_snapshot of this PortStatusDTO. - :type: PortStatusSnapshotDTO - """ - - self._aggregate_snapshot = aggregate_snapshot - - @property - def node_snapshots(self): + def transmitting(self): """ - Gets the node_snapshots of this PortStatusDTO. - A status snapshot for each node in the cluster. If the NiFi instance is a standalone instance, rather than a cluster, this may be null. + Gets the transmitting of this PortStatusDTO. + Whether the port has incoming or outgoing connections to a remote NiFi. - :return: The node_snapshots of this PortStatusDTO. - :rtype: list[NodePortStatusSnapshotDTO] + :return: The transmitting of this PortStatusDTO. + :rtype: bool """ - return self._node_snapshots + return self._transmitting - @node_snapshots.setter - def node_snapshots(self, node_snapshots): + @transmitting.setter + def transmitting(self, transmitting): """ - Sets the node_snapshots of this PortStatusDTO. - A status snapshot for each node in the cluster. If the NiFi instance is a standalone instance, rather than a cluster, this may be null. + Sets the transmitting of this PortStatusDTO. + Whether the port has incoming or outgoing connections to a remote NiFi. - :param node_snapshots: The node_snapshots of this PortStatusDTO. - :type: list[NodePortStatusSnapshotDTO] + :param transmitting: The transmitting of this PortStatusDTO. + :type: bool """ - self._node_snapshots = node_snapshots + self._transmitting = transmitting def to_dict(self): """ diff --git a/nipyapi/nifi/models/port_status_entity.py b/nipyapi/nifi/models/port_status_entity.py index 2d657b4d..dda4bf3e 100644 --- a/nipyapi/nifi/models/port_status_entity.py +++ b/nipyapi/nifi/models/port_status_entity.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,48 +27,25 @@ class PortStatusEntity(object): and the value is json key in definition. """ swagger_types = { - 'port_status': 'PortStatusDTO', - 'can_read': 'bool' - } + 'can_read': 'bool', +'port_status': 'PortStatusDTO' } attribute_map = { - 'port_status': 'portStatus', - 'can_read': 'canRead' - } + 'can_read': 'canRead', +'port_status': 'portStatus' } - def __init__(self, port_status=None, can_read=None): + def __init__(self, can_read=None, port_status=None): """ PortStatusEntity - a model defined in Swagger """ - self._port_status = None self._can_read = None + self._port_status = None - if port_status is not None: - self.port_status = port_status if can_read is not None: self.can_read = can_read - - @property - def port_status(self): - """ - Gets the port_status of this PortStatusEntity. - - :return: The port_status of this PortStatusEntity. - :rtype: PortStatusDTO - """ - return self._port_status - - @port_status.setter - def port_status(self, port_status): - """ - Sets the port_status of this PortStatusEntity. - - :param port_status: The port_status of this PortStatusEntity. - :type: PortStatusDTO - """ - - self._port_status = port_status + if port_status is not None: + self.port_status = port_status @property def can_read(self): @@ -94,6 +70,27 @@ def can_read(self, can_read): self._can_read = can_read + @property + def port_status(self): + """ + Gets the port_status of this PortStatusEntity. + + :return: The port_status of this PortStatusEntity. + :rtype: PortStatusDTO + """ + return self._port_status + + @port_status.setter + def port_status(self, port_status): + """ + Sets the port_status of this PortStatusEntity. + + :param port_status: The port_status of this PortStatusEntity. + :type: PortStatusDTO + """ + + self._port_status = port_status + def to_dict(self): """ Returns the model properties as a dict diff --git a/nipyapi/nifi/models/port_status_snapshot_dto.py b/nipyapi/nifi/models/port_status_snapshot_dto.py index b92e63e1..7dd65007 100644 --- a/nipyapi/nifi/models/port_status_snapshot_dto.py +++ b/nipyapi/nifi/models/port_status_snapshot_dto.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,169 +27,144 @@ class PortStatusSnapshotDTO(object): and the value is json key in definition. """ swagger_types = { - 'id': 'str', - 'group_id': 'str', - 'name': 'str', 'active_thread_count': 'int', - 'flow_files_in': 'int', - 'bytes_in': 'int', - 'input': 'str', - 'flow_files_out': 'int', - 'bytes_out': 'int', - 'output': 'str', - 'transmitting': 'bool', - 'run_status': 'str' - } +'bytes_in': 'int', +'bytes_out': 'int', +'flow_files_in': 'int', +'flow_files_out': 'int', +'group_id': 'str', +'id': 'str', +'input': 'str', +'name': 'str', +'output': 'str', +'run_status': 'str', +'transmitting': 'bool' } attribute_map = { - 'id': 'id', - 'group_id': 'groupId', - 'name': 'name', 'active_thread_count': 'activeThreadCount', - 'flow_files_in': 'flowFilesIn', - 'bytes_in': 'bytesIn', - 'input': 'input', - 'flow_files_out': 'flowFilesOut', - 'bytes_out': 'bytesOut', - 'output': 'output', - 'transmitting': 'transmitting', - 'run_status': 'runStatus' - } - - def __init__(self, id=None, group_id=None, name=None, active_thread_count=None, flow_files_in=None, bytes_in=None, input=None, flow_files_out=None, bytes_out=None, output=None, transmitting=None, run_status=None): +'bytes_in': 'bytesIn', +'bytes_out': 'bytesOut', +'flow_files_in': 'flowFilesIn', +'flow_files_out': 'flowFilesOut', +'group_id': 'groupId', +'id': 'id', +'input': 'input', +'name': 'name', +'output': 'output', +'run_status': 'runStatus', +'transmitting': 'transmitting' } + + def __init__(self, active_thread_count=None, bytes_in=None, bytes_out=None, flow_files_in=None, flow_files_out=None, group_id=None, id=None, input=None, name=None, output=None, run_status=None, transmitting=None): """ PortStatusSnapshotDTO - a model defined in Swagger """ - self._id = None - self._group_id = None - self._name = None self._active_thread_count = None - self._flow_files_in = None self._bytes_in = None - self._input = None - self._flow_files_out = None self._bytes_out = None + self._flow_files_in = None + self._flow_files_out = None + self._group_id = None + self._id = None + self._input = None + self._name = None self._output = None - self._transmitting = None self._run_status = None + self._transmitting = None - if id is not None: - self.id = id - if group_id is not None: - self.group_id = group_id - if name is not None: - self.name = name if active_thread_count is not None: self.active_thread_count = active_thread_count - if flow_files_in is not None: - self.flow_files_in = flow_files_in if bytes_in is not None: self.bytes_in = bytes_in - if input is not None: - self.input = input - if flow_files_out is not None: - self.flow_files_out = flow_files_out if bytes_out is not None: self.bytes_out = bytes_out + if flow_files_in is not None: + self.flow_files_in = flow_files_in + if flow_files_out is not None: + self.flow_files_out = flow_files_out + if group_id is not None: + self.group_id = group_id + if id is not None: + self.id = id + if input is not None: + self.input = input + if name is not None: + self.name = name if output is not None: self.output = output - if transmitting is not None: - self.transmitting = transmitting if run_status is not None: self.run_status = run_status + if transmitting is not None: + self.transmitting = transmitting @property - def id(self): - """ - Gets the id of this PortStatusSnapshotDTO. - The id of the port. - - :return: The id of this PortStatusSnapshotDTO. - :rtype: str - """ - return self._id - - @id.setter - def id(self, id): - """ - Sets the id of this PortStatusSnapshotDTO. - The id of the port. - - :param id: The id of this PortStatusSnapshotDTO. - :type: str - """ - - self._id = id - - @property - def group_id(self): + def active_thread_count(self): """ - Gets the group_id of this PortStatusSnapshotDTO. - The id of the parent process group of the port. + Gets the active_thread_count of this PortStatusSnapshotDTO. + The active thread count for the port. - :return: The group_id of this PortStatusSnapshotDTO. - :rtype: str + :return: The active_thread_count of this PortStatusSnapshotDTO. + :rtype: int """ - return self._group_id + return self._active_thread_count - @group_id.setter - def group_id(self, group_id): + @active_thread_count.setter + def active_thread_count(self, active_thread_count): """ - Sets the group_id of this PortStatusSnapshotDTO. - The id of the parent process group of the port. + Sets the active_thread_count of this PortStatusSnapshotDTO. + The active thread count for the port. - :param group_id: The group_id of this PortStatusSnapshotDTO. - :type: str + :param active_thread_count: The active_thread_count of this PortStatusSnapshotDTO. + :type: int """ - self._group_id = group_id + self._active_thread_count = active_thread_count @property - def name(self): + def bytes_in(self): """ - Gets the name of this PortStatusSnapshotDTO. - The name of the port. + Gets the bytes_in of this PortStatusSnapshotDTO. + The size of hte FlowFiles that have been accepted in the last 5 minutes. - :return: The name of this PortStatusSnapshotDTO. - :rtype: str + :return: The bytes_in of this PortStatusSnapshotDTO. + :rtype: int """ - return self._name + return self._bytes_in - @name.setter - def name(self, name): + @bytes_in.setter + def bytes_in(self, bytes_in): """ - Sets the name of this PortStatusSnapshotDTO. - The name of the port. + Sets the bytes_in of this PortStatusSnapshotDTO. + The size of hte FlowFiles that have been accepted in the last 5 minutes. - :param name: The name of this PortStatusSnapshotDTO. - :type: str + :param bytes_in: The bytes_in of this PortStatusSnapshotDTO. + :type: int """ - self._name = name + self._bytes_in = bytes_in @property - def active_thread_count(self): + def bytes_out(self): """ - Gets the active_thread_count of this PortStatusSnapshotDTO. - The active thread count for the port. + Gets the bytes_out of this PortStatusSnapshotDTO. + The number of bytes that have been processed in the last 5 minutes. - :return: The active_thread_count of this PortStatusSnapshotDTO. + :return: The bytes_out of this PortStatusSnapshotDTO. :rtype: int """ - return self._active_thread_count + return self._bytes_out - @active_thread_count.setter - def active_thread_count(self, active_thread_count): + @bytes_out.setter + def bytes_out(self, bytes_out): """ - Sets the active_thread_count of this PortStatusSnapshotDTO. - The active thread count for the port. + Sets the bytes_out of this PortStatusSnapshotDTO. + The number of bytes that have been processed in the last 5 minutes. - :param active_thread_count: The active_thread_count of this PortStatusSnapshotDTO. + :param bytes_out: The bytes_out of this PortStatusSnapshotDTO. :type: int """ - self._active_thread_count = active_thread_count + self._bytes_out = bytes_out @property def flow_files_in(self): @@ -216,27 +190,73 @@ def flow_files_in(self, flow_files_in): self._flow_files_in = flow_files_in @property - def bytes_in(self): + def flow_files_out(self): """ - Gets the bytes_in of this PortStatusSnapshotDTO. - The size of hte FlowFiles that have been accepted in the last 5 minutes. + Gets the flow_files_out of this PortStatusSnapshotDTO. + The number of FlowFiles that have been processed in the last 5 minutes. - :return: The bytes_in of this PortStatusSnapshotDTO. + :return: The flow_files_out of this PortStatusSnapshotDTO. :rtype: int """ - return self._bytes_in + return self._flow_files_out - @bytes_in.setter - def bytes_in(self, bytes_in): + @flow_files_out.setter + def flow_files_out(self, flow_files_out): """ - Sets the bytes_in of this PortStatusSnapshotDTO. - The size of hte FlowFiles that have been accepted in the last 5 minutes. + Sets the flow_files_out of this PortStatusSnapshotDTO. + The number of FlowFiles that have been processed in the last 5 minutes. - :param bytes_in: The bytes_in of this PortStatusSnapshotDTO. + :param flow_files_out: The flow_files_out of this PortStatusSnapshotDTO. :type: int """ - self._bytes_in = bytes_in + self._flow_files_out = flow_files_out + + @property + def group_id(self): + """ + Gets the group_id of this PortStatusSnapshotDTO. + The id of the parent process group of the port. + + :return: The group_id of this PortStatusSnapshotDTO. + :rtype: str + """ + return self._group_id + + @group_id.setter + def group_id(self, group_id): + """ + Sets the group_id of this PortStatusSnapshotDTO. + The id of the parent process group of the port. + + :param group_id: The group_id of this PortStatusSnapshotDTO. + :type: str + """ + + self._group_id = group_id + + @property + def id(self): + """ + Gets the id of this PortStatusSnapshotDTO. + The id of the port. + + :return: The id of this PortStatusSnapshotDTO. + :rtype: str + """ + return self._id + + @id.setter + def id(self, id): + """ + Sets the id of this PortStatusSnapshotDTO. + The id of the port. + + :param id: The id of this PortStatusSnapshotDTO. + :type: str + """ + + self._id = id @property def input(self): @@ -262,50 +282,27 @@ def input(self, input): self._input = input @property - def flow_files_out(self): - """ - Gets the flow_files_out of this PortStatusSnapshotDTO. - The number of FlowFiles that have been processed in the last 5 minutes. - - :return: The flow_files_out of this PortStatusSnapshotDTO. - :rtype: int - """ - return self._flow_files_out - - @flow_files_out.setter - def flow_files_out(self, flow_files_out): - """ - Sets the flow_files_out of this PortStatusSnapshotDTO. - The number of FlowFiles that have been processed in the last 5 minutes. - - :param flow_files_out: The flow_files_out of this PortStatusSnapshotDTO. - :type: int - """ - - self._flow_files_out = flow_files_out - - @property - def bytes_out(self): + def name(self): """ - Gets the bytes_out of this PortStatusSnapshotDTO. - The number of bytes that have been processed in the last 5 minutes. + Gets the name of this PortStatusSnapshotDTO. + The name of the port. - :return: The bytes_out of this PortStatusSnapshotDTO. - :rtype: int + :return: The name of this PortStatusSnapshotDTO. + :rtype: str """ - return self._bytes_out + return self._name - @bytes_out.setter - def bytes_out(self, bytes_out): + @name.setter + def name(self, name): """ - Sets the bytes_out of this PortStatusSnapshotDTO. - The number of bytes that have been processed in the last 5 minutes. + Sets the name of this PortStatusSnapshotDTO. + The name of the port. - :param bytes_out: The bytes_out of this PortStatusSnapshotDTO. - :type: int + :param name: The name of this PortStatusSnapshotDTO. + :type: str """ - self._bytes_out = bytes_out + self._name = name @property def output(self): @@ -330,29 +327,6 @@ def output(self, output): self._output = output - @property - def transmitting(self): - """ - Gets the transmitting of this PortStatusSnapshotDTO. - Whether the port has incoming or outgoing connections to a remote NiFi. - - :return: The transmitting of this PortStatusSnapshotDTO. - :rtype: bool - """ - return self._transmitting - - @transmitting.setter - def transmitting(self, transmitting): - """ - Sets the transmitting of this PortStatusSnapshotDTO. - Whether the port has incoming or outgoing connections to a remote NiFi. - - :param transmitting: The transmitting of this PortStatusSnapshotDTO. - :type: bool - """ - - self._transmitting = transmitting - @property def run_status(self): """ @@ -373,7 +347,7 @@ def run_status(self, run_status): :param run_status: The run_status of this PortStatusSnapshotDTO. :type: str """ - allowed_values = ["Running", "Stopped", "Validating", "Disabled", "Invalid"] + 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}" @@ -382,6 +356,29 @@ def run_status(self, run_status): self._run_status = run_status + @property + def transmitting(self): + """ + Gets the transmitting of this PortStatusSnapshotDTO. + Whether the port has incoming or outgoing connections to a remote NiFi. + + :return: The transmitting of this PortStatusSnapshotDTO. + :rtype: bool + """ + return self._transmitting + + @transmitting.setter + def transmitting(self, transmitting): + """ + Sets the transmitting of this PortStatusSnapshotDTO. + Whether the port has incoming or outgoing connections to a remote NiFi. + + :param transmitting: The transmitting of this PortStatusSnapshotDTO. + :type: bool + """ + + self._transmitting = transmitting + def to_dict(self): """ Returns the model properties as a dict diff --git a/nipyapi/nifi/models/port_status_snapshot_entity.py b/nipyapi/nifi/models/port_status_snapshot_entity.py index 6ca73688..bf7c5364 100644 --- a/nipyapi/nifi/models/port_status_snapshot_entity.py +++ b/nipyapi/nifi/models/port_status_snapshot_entity.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,32 +27,53 @@ class PortStatusSnapshotEntity(object): and the value is json key in definition. """ swagger_types = { - 'id': 'str', - 'port_status_snapshot': 'PortStatusSnapshotDTO', - 'can_read': 'bool' - } + 'can_read': 'bool', +'id': 'str', +'port_status_snapshot': 'PortStatusSnapshotDTO' } attribute_map = { - 'id': 'id', - 'port_status_snapshot': 'portStatusSnapshot', - 'can_read': 'canRead' - } + 'can_read': 'canRead', +'id': 'id', +'port_status_snapshot': 'portStatusSnapshot' } - def __init__(self, id=None, port_status_snapshot=None, can_read=None): + def __init__(self, can_read=None, id=None, port_status_snapshot=None): """ PortStatusSnapshotEntity - a model defined in Swagger """ + self._can_read = None self._id = None self._port_status_snapshot = None - self._can_read = None + if can_read is not None: + self.can_read = can_read if id is not None: self.id = id if port_status_snapshot is not None: self.port_status_snapshot = port_status_snapshot - if can_read is not None: - self.can_read = can_read + + @property + def can_read(self): + """ + Gets the can_read of this PortStatusSnapshotEntity. + Indicates whether the user can read a given resource. + + :return: The can_read of this PortStatusSnapshotEntity. + :rtype: bool + """ + return self._can_read + + @can_read.setter + def can_read(self, can_read): + """ + Sets the can_read of this PortStatusSnapshotEntity. + Indicates whether the user can read a given resource. + + :param can_read: The can_read of this PortStatusSnapshotEntity. + :type: bool + """ + + self._can_read = can_read @property def id(self): @@ -99,29 +119,6 @@ def port_status_snapshot(self, port_status_snapshot): self._port_status_snapshot = port_status_snapshot - @property - def can_read(self): - """ - Gets the can_read of this PortStatusSnapshotEntity. - Indicates whether the user can read a given resource. - - :return: The can_read of this PortStatusSnapshotEntity. - :rtype: bool - """ - return self._can_read - - @can_read.setter - def can_read(self, can_read): - """ - Sets the can_read of this PortStatusSnapshotEntity. - Indicates whether the user can read a given resource. - - :param can_read: The can_read of this PortStatusSnapshotEntity. - :type: bool - """ - - self._can_read = can_read - def to_dict(self): """ Returns the model properties as a dict diff --git a/nipyapi/nifi/models/position.py b/nipyapi/nifi/models/position.py index 09509949..3839d801 100644 --- a/nipyapi/nifi/models/position.py +++ b/nipyapi/nifi/models/position.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -29,13 +28,11 @@ class Position(object): """ swagger_types = { 'x': 'float', - 'y': 'float' - } +'y': 'float' } attribute_map = { 'x': 'x', - 'y': 'y' - } +'y': 'y' } def __init__(self, x=None, y=None): """ diff --git a/nipyapi/nifi/models/position_dto.py b/nipyapi/nifi/models/position_dto.py index 3b6d85aa..37051730 100644 --- a/nipyapi/nifi/models/position_dto.py +++ b/nipyapi/nifi/models/position_dto.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -29,13 +28,11 @@ class PositionDTO(object): """ swagger_types = { 'x': 'float', - 'y': 'float' - } +'y': 'float' } attribute_map = { 'x': 'x', - 'y': 'y' - } +'y': 'y' } def __init__(self, x=None, y=None): """ diff --git a/nipyapi/nifi/models/previous_value_dto.py b/nipyapi/nifi/models/previous_value_dto.py index 05cacc73..c9e76e67 100644 --- a/nipyapi/nifi/models/previous_value_dto.py +++ b/nipyapi/nifi/models/previous_value_dto.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -29,15 +28,13 @@ class PreviousValueDTO(object): """ swagger_types = { 'previous_value': 'str', - 'timestamp': 'str', - 'user_identity': 'str' - } +'timestamp': 'str', +'user_identity': 'str' } attribute_map = { 'previous_value': 'previousValue', - 'timestamp': 'timestamp', - 'user_identity': 'userIdentity' - } +'timestamp': 'timestamp', +'user_identity': 'userIdentity' } def __init__(self, previous_value=None, timestamp=None, user_identity=None): """ diff --git a/nipyapi/nifi/models/prioritizer_types_entity.py b/nipyapi/nifi/models/prioritizer_types_entity.py index 3a3c7693..9ba4efdb 100644 --- a/nipyapi/nifi/models/prioritizer_types_entity.py +++ b/nipyapi/nifi/models/prioritizer_types_entity.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,12 +27,10 @@ class PrioritizerTypesEntity(object): and the value is json key in definition. """ swagger_types = { - 'prioritizer_types': 'list[DocumentedTypeDTO]' - } + 'prioritizer_types': 'list[DocumentedTypeDTO]' } attribute_map = { - 'prioritizer_types': 'prioritizerTypes' - } + 'prioritizer_types': 'prioritizerTypes' } def __init__(self, prioritizer_types=None): """ diff --git a/nipyapi/nifi/models/process_group_dto.py b/nipyapi/nifi/models/process_group_dto.py index e8f23b7e..912c7b10 100644 --- a/nipyapi/nifi/models/process_group_dto.py +++ b/nipyapi/nifi/models/process_group_dto.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,516 +27,625 @@ class ProcessGroupDTO(object): and the value is json key in definition. """ swagger_types = { - 'id': 'str', - 'versioned_component_id': 'str', - 'parent_group_id': 'str', - 'position': 'PositionDTO', - 'name': 'str', - 'comments': 'str', - 'variables': 'dict(str, str)', - 'version_control_information': 'VersionControlInformationDTO', - 'parameter_context': 'ParameterContextReferenceEntity', - 'flowfile_concurrency': 'str', - 'flowfile_outbound_policy': 'str', - 'default_flow_file_expiration': 'str', - 'default_back_pressure_object_threshold': 'int', - 'default_back_pressure_data_size_threshold': 'str', - 'log_file_suffix': 'str', - 'running_count': 'int', - 'stopped_count': 'int', - 'invalid_count': 'int', - 'disabled_count': 'int', 'active_remote_port_count': 'int', - 'inactive_remote_port_count': 'int', - 'up_to_date_count': 'int', - 'locally_modified_count': 'int', - 'stale_count': 'int', - 'locally_modified_and_stale_count': 'int', - 'sync_failure_count': 'int', - 'local_input_port_count': 'int', - 'local_output_port_count': 'int', - 'public_input_port_count': 'int', - 'public_output_port_count': 'int', - 'contents': 'FlowSnippetDTO', - 'input_port_count': 'int', - 'output_port_count': 'int' - } +'comments': 'str', +'contents': 'FlowSnippetDTO', +'default_back_pressure_data_size_threshold': 'str', +'default_back_pressure_object_threshold': 'int', +'default_flow_file_expiration': 'str', +'disabled_count': 'int', +'execution_engine': 'str', +'flowfile_concurrency': 'str', +'flowfile_outbound_policy': 'str', +'id': 'str', +'inactive_remote_port_count': 'int', +'input_port_count': 'int', +'invalid_count': 'int', +'local_input_port_count': 'int', +'local_output_port_count': 'int', +'locally_modified_and_stale_count': 'int', +'locally_modified_count': 'int', +'log_file_suffix': 'str', +'max_concurrent_tasks': 'int', +'name': 'str', +'output_port_count': 'int', +'parameter_context': 'ParameterContextReferenceEntity', +'parent_group_id': 'str', +'position': 'PositionDTO', +'public_input_port_count': 'int', +'public_output_port_count': 'int', +'running_count': 'int', +'stale_count': 'int', +'stateless_flow_timeout': 'str', +'stateless_group_scheduled_state': 'str', +'stopped_count': 'int', +'sync_failure_count': 'int', +'up_to_date_count': 'int', +'version_control_information': 'VersionControlInformationDTO', +'versioned_component_id': 'str' } attribute_map = { - 'id': 'id', - 'versioned_component_id': 'versionedComponentId', - 'parent_group_id': 'parentGroupId', - 'position': 'position', - 'name': 'name', - 'comments': 'comments', - 'variables': 'variables', - 'version_control_information': 'versionControlInformation', - 'parameter_context': 'parameterContext', - 'flowfile_concurrency': 'flowfileConcurrency', - 'flowfile_outbound_policy': 'flowfileOutboundPolicy', - 'default_flow_file_expiration': 'defaultFlowFileExpiration', - 'default_back_pressure_object_threshold': 'defaultBackPressureObjectThreshold', - 'default_back_pressure_data_size_threshold': 'defaultBackPressureDataSizeThreshold', - 'log_file_suffix': 'logFileSuffix', - 'running_count': 'runningCount', - 'stopped_count': 'stoppedCount', - 'invalid_count': 'invalidCount', - 'disabled_count': 'disabledCount', 'active_remote_port_count': 'activeRemotePortCount', - 'inactive_remote_port_count': 'inactiveRemotePortCount', - 'up_to_date_count': 'upToDateCount', - 'locally_modified_count': 'locallyModifiedCount', - 'stale_count': 'staleCount', - 'locally_modified_and_stale_count': 'locallyModifiedAndStaleCount', - 'sync_failure_count': 'syncFailureCount', - 'local_input_port_count': 'localInputPortCount', - 'local_output_port_count': 'localOutputPortCount', - 'public_input_port_count': 'publicInputPortCount', - 'public_output_port_count': 'publicOutputPortCount', - 'contents': 'contents', - 'input_port_count': 'inputPortCount', - 'output_port_count': 'outputPortCount' - } - - def __init__(self, id=None, versioned_component_id=None, parent_group_id=None, position=None, name=None, comments=None, variables=None, version_control_information=None, parameter_context=None, flowfile_concurrency=None, flowfile_outbound_policy=None, default_flow_file_expiration=None, default_back_pressure_object_threshold=None, default_back_pressure_data_size_threshold=None, log_file_suffix=None, running_count=None, stopped_count=None, invalid_count=None, disabled_count=None, active_remote_port_count=None, inactive_remote_port_count=None, up_to_date_count=None, locally_modified_count=None, stale_count=None, locally_modified_and_stale_count=None, sync_failure_count=None, local_input_port_count=None, local_output_port_count=None, public_input_port_count=None, public_output_port_count=None, contents=None, input_port_count=None, output_port_count=None): +'comments': 'comments', +'contents': 'contents', +'default_back_pressure_data_size_threshold': 'defaultBackPressureDataSizeThreshold', +'default_back_pressure_object_threshold': 'defaultBackPressureObjectThreshold', +'default_flow_file_expiration': 'defaultFlowFileExpiration', +'disabled_count': 'disabledCount', +'execution_engine': 'executionEngine', +'flowfile_concurrency': 'flowfileConcurrency', +'flowfile_outbound_policy': 'flowfileOutboundPolicy', +'id': 'id', +'inactive_remote_port_count': 'inactiveRemotePortCount', +'input_port_count': 'inputPortCount', +'invalid_count': 'invalidCount', +'local_input_port_count': 'localInputPortCount', +'local_output_port_count': 'localOutputPortCount', +'locally_modified_and_stale_count': 'locallyModifiedAndStaleCount', +'locally_modified_count': 'locallyModifiedCount', +'log_file_suffix': 'logFileSuffix', +'max_concurrent_tasks': 'maxConcurrentTasks', +'name': 'name', +'output_port_count': 'outputPortCount', +'parameter_context': 'parameterContext', +'parent_group_id': 'parentGroupId', +'position': 'position', +'public_input_port_count': 'publicInputPortCount', +'public_output_port_count': 'publicOutputPortCount', +'running_count': 'runningCount', +'stale_count': 'staleCount', +'stateless_flow_timeout': 'statelessFlowTimeout', +'stateless_group_scheduled_state': 'statelessGroupScheduledState', +'stopped_count': 'stoppedCount', +'sync_failure_count': 'syncFailureCount', +'up_to_date_count': 'upToDateCount', +'version_control_information': 'versionControlInformation', +'versioned_component_id': 'versionedComponentId' } + + def __init__(self, active_remote_port_count=None, comments=None, contents=None, default_back_pressure_data_size_threshold=None, default_back_pressure_object_threshold=None, default_flow_file_expiration=None, disabled_count=None, execution_engine=None, flowfile_concurrency=None, flowfile_outbound_policy=None, id=None, inactive_remote_port_count=None, input_port_count=None, invalid_count=None, local_input_port_count=None, local_output_port_count=None, locally_modified_and_stale_count=None, locally_modified_count=None, log_file_suffix=None, max_concurrent_tasks=None, name=None, output_port_count=None, parameter_context=None, parent_group_id=None, position=None, public_input_port_count=None, public_output_port_count=None, running_count=None, stale_count=None, stateless_flow_timeout=None, stateless_group_scheduled_state=None, stopped_count=None, sync_failure_count=None, up_to_date_count=None, version_control_information=None, versioned_component_id=None): """ ProcessGroupDTO - a model defined in Swagger """ - self._id = None - self._versioned_component_id = None - self._parent_group_id = None - self._position = None - self._name = None + self._active_remote_port_count = None self._comments = None - self._variables = None - self._version_control_information = None - self._parameter_context = None - self._flowfile_concurrency = None - self._flowfile_outbound_policy = None - self._default_flow_file_expiration = None - self._default_back_pressure_object_threshold = None + self._contents = None self._default_back_pressure_data_size_threshold = None - self._log_file_suffix = None - self._running_count = None - self._stopped_count = None - self._invalid_count = None + self._default_back_pressure_object_threshold = None + self._default_flow_file_expiration = None self._disabled_count = None - self._active_remote_port_count = None + self._execution_engine = None + self._flowfile_concurrency = None + self._flowfile_outbound_policy = None + self._id = None self._inactive_remote_port_count = None - self._up_to_date_count = None - self._locally_modified_count = None - self._stale_count = None - self._locally_modified_and_stale_count = None - self._sync_failure_count = None + self._input_port_count = None + self._invalid_count = None self._local_input_port_count = None self._local_output_port_count = None + self._locally_modified_and_stale_count = None + self._locally_modified_count = None + self._log_file_suffix = None + self._max_concurrent_tasks = None + self._name = None + self._output_port_count = None + self._parameter_context = None + self._parent_group_id = None + self._position = None self._public_input_port_count = None self._public_output_port_count = None - self._contents = None - self._input_port_count = None - self._output_port_count = None + self._running_count = None + self._stale_count = None + self._stateless_flow_timeout = None + self._stateless_group_scheduled_state = None + self._stopped_count = None + self._sync_failure_count = None + self._up_to_date_count = None + self._version_control_information = None + self._versioned_component_id = None - if id is not None: - self.id = id - if versioned_component_id is not None: - self.versioned_component_id = versioned_component_id - if parent_group_id is not None: - self.parent_group_id = parent_group_id - if position is not None: - self.position = position - if name is not None: - self.name = name + if active_remote_port_count is not None: + self.active_remote_port_count = active_remote_port_count if comments is not None: self.comments = comments - if variables is not None: - self.variables = variables - if version_control_information is not None: - self.version_control_information = version_control_information - if parameter_context is not None: - self.parameter_context = parameter_context - if flowfile_concurrency is not None: - self.flowfile_concurrency = flowfile_concurrency - if flowfile_outbound_policy is not None: - self.flowfile_outbound_policy = flowfile_outbound_policy - if default_flow_file_expiration is not None: - self.default_flow_file_expiration = default_flow_file_expiration - if default_back_pressure_object_threshold is not None: - self.default_back_pressure_object_threshold = default_back_pressure_object_threshold + if contents is not None: + self.contents = contents if default_back_pressure_data_size_threshold is not None: self.default_back_pressure_data_size_threshold = default_back_pressure_data_size_threshold - if log_file_suffix is not None: - self.log_file_suffix = log_file_suffix - if running_count is not None: - self.running_count = running_count - if stopped_count is not None: - self.stopped_count = stopped_count - if invalid_count is not None: - self.invalid_count = invalid_count + if default_back_pressure_object_threshold is not None: + self.default_back_pressure_object_threshold = default_back_pressure_object_threshold + if default_flow_file_expiration is not None: + self.default_flow_file_expiration = default_flow_file_expiration if disabled_count is not None: self.disabled_count = disabled_count - if active_remote_port_count is not None: - self.active_remote_port_count = active_remote_port_count + if execution_engine is not None: + self.execution_engine = execution_engine + if flowfile_concurrency is not None: + self.flowfile_concurrency = flowfile_concurrency + if flowfile_outbound_policy is not None: + self.flowfile_outbound_policy = flowfile_outbound_policy + if id is not None: + self.id = id if inactive_remote_port_count is not None: self.inactive_remote_port_count = inactive_remote_port_count - if up_to_date_count is not None: - self.up_to_date_count = up_to_date_count - if locally_modified_count is not None: - self.locally_modified_count = locally_modified_count - if stale_count is not None: - self.stale_count = stale_count - if locally_modified_and_stale_count is not None: - self.locally_modified_and_stale_count = locally_modified_and_stale_count - if sync_failure_count is not None: - self.sync_failure_count = sync_failure_count + if input_port_count is not None: + self.input_port_count = input_port_count + if invalid_count is not None: + self.invalid_count = invalid_count if local_input_port_count is not None: self.local_input_port_count = local_input_port_count if local_output_port_count is not None: self.local_output_port_count = local_output_port_count + if locally_modified_and_stale_count is not None: + self.locally_modified_and_stale_count = locally_modified_and_stale_count + if locally_modified_count is not None: + self.locally_modified_count = locally_modified_count + if log_file_suffix is not None: + self.log_file_suffix = log_file_suffix + if max_concurrent_tasks is not None: + self.max_concurrent_tasks = max_concurrent_tasks + if name is not None: + self.name = name + if output_port_count is not None: + self.output_port_count = output_port_count + if parameter_context is not None: + self.parameter_context = parameter_context + if parent_group_id is not None: + self.parent_group_id = parent_group_id + if position is not None: + self.position = position if public_input_port_count is not None: self.public_input_port_count = public_input_port_count if public_output_port_count is not None: self.public_output_port_count = public_output_port_count - if contents is not None: - self.contents = contents - if input_port_count is not None: - self.input_port_count = input_port_count - if output_port_count is not None: - self.output_port_count = output_port_count + if running_count is not None: + self.running_count = running_count + if stale_count is not None: + self.stale_count = stale_count + if stateless_flow_timeout is not None: + self.stateless_flow_timeout = stateless_flow_timeout + if stateless_group_scheduled_state is not None: + self.stateless_group_scheduled_state = stateless_group_scheduled_state + if stopped_count is not None: + self.stopped_count = stopped_count + if sync_failure_count is not None: + self.sync_failure_count = sync_failure_count + if up_to_date_count is not None: + self.up_to_date_count = up_to_date_count + if version_control_information is not None: + self.version_control_information = version_control_information + if versioned_component_id is not None: + self.versioned_component_id = versioned_component_id @property - def id(self): + def active_remote_port_count(self): """ - Gets the id of this ProcessGroupDTO. - The id of the component. + Gets the active_remote_port_count of this ProcessGroupDTO. + The number of active remote ports in the process group. - :return: The id of this ProcessGroupDTO. + :return: The active_remote_port_count of this ProcessGroupDTO. + :rtype: int + """ + return self._active_remote_port_count + + @active_remote_port_count.setter + def active_remote_port_count(self, active_remote_port_count): + """ + Sets the active_remote_port_count of this ProcessGroupDTO. + The number of active remote ports in the process group. + + :param active_remote_port_count: The active_remote_port_count of this ProcessGroupDTO. + :type: int + """ + + self._active_remote_port_count = active_remote_port_count + + @property + def comments(self): + """ + Gets the comments of this ProcessGroupDTO. + The comments for the process group. + + :return: The comments of this ProcessGroupDTO. :rtype: str """ - return self._id + return self._comments - @id.setter - def id(self, id): + @comments.setter + def comments(self, comments): """ - Sets the id of this ProcessGroupDTO. - The id of the component. + Sets the comments of this ProcessGroupDTO. + The comments for the process group. - :param id: The id of this ProcessGroupDTO. + :param comments: The comments of this ProcessGroupDTO. :type: str """ - self._id = id + self._comments = comments @property - def versioned_component_id(self): + def contents(self): """ - Gets the versioned_component_id of this ProcessGroupDTO. - The ID of the corresponding component that is under version control + Gets the contents of this ProcessGroupDTO. - :return: The versioned_component_id of this ProcessGroupDTO. + :return: The contents of this ProcessGroupDTO. + :rtype: FlowSnippetDTO + """ + return self._contents + + @contents.setter + def contents(self, contents): + """ + Sets the contents of this ProcessGroupDTO. + + :param contents: The contents of this ProcessGroupDTO. + :type: FlowSnippetDTO + """ + + self._contents = contents + + @property + def default_back_pressure_data_size_threshold(self): + """ + Gets the default_back_pressure_data_size_threshold of this ProcessGroupDTO. + Default value used in this Process Group for the maximum data size of objects that can be queued before back pressure is applied. + + :return: The default_back_pressure_data_size_threshold of this ProcessGroupDTO. :rtype: str """ - return self._versioned_component_id + return self._default_back_pressure_data_size_threshold - @versioned_component_id.setter - def versioned_component_id(self, versioned_component_id): + @default_back_pressure_data_size_threshold.setter + def default_back_pressure_data_size_threshold(self, default_back_pressure_data_size_threshold): """ - Sets the versioned_component_id of this ProcessGroupDTO. - The ID of the corresponding component that is under version control + Sets the default_back_pressure_data_size_threshold of this ProcessGroupDTO. + Default value used in this Process Group for the maximum data size of objects that can be queued before back pressure is applied. - :param versioned_component_id: The versioned_component_id of this ProcessGroupDTO. + :param default_back_pressure_data_size_threshold: The default_back_pressure_data_size_threshold of this ProcessGroupDTO. :type: str """ - self._versioned_component_id = versioned_component_id + self._default_back_pressure_data_size_threshold = default_back_pressure_data_size_threshold @property - def parent_group_id(self): + def default_back_pressure_object_threshold(self): """ - Gets the parent_group_id of this ProcessGroupDTO. - The id of parent process group of this component if applicable. + Gets the default_back_pressure_object_threshold of this ProcessGroupDTO. + Default value used in this Process Group for the maximum number of objects that can be queued before back pressure is applied. - :return: The parent_group_id of this ProcessGroupDTO. + :return: The default_back_pressure_object_threshold of this ProcessGroupDTO. + :rtype: int + """ + return self._default_back_pressure_object_threshold + + @default_back_pressure_object_threshold.setter + def default_back_pressure_object_threshold(self, default_back_pressure_object_threshold): + """ + Sets the default_back_pressure_object_threshold of this ProcessGroupDTO. + Default value used in this Process Group for the maximum number of objects that can be queued before back pressure is applied. + + :param default_back_pressure_object_threshold: The default_back_pressure_object_threshold of this ProcessGroupDTO. + :type: int + """ + + self._default_back_pressure_object_threshold = default_back_pressure_object_threshold + + @property + def default_flow_file_expiration(self): + """ + Gets the default_flow_file_expiration of this ProcessGroupDTO. + The default FlowFile Expiration for this Process Group. + + :return: The default_flow_file_expiration of this ProcessGroupDTO. :rtype: str """ - return self._parent_group_id + return self._default_flow_file_expiration - @parent_group_id.setter - def parent_group_id(self, parent_group_id): + @default_flow_file_expiration.setter + def default_flow_file_expiration(self, default_flow_file_expiration): """ - Sets the parent_group_id of this ProcessGroupDTO. - The id of parent process group of this component if applicable. + Sets the default_flow_file_expiration of this ProcessGroupDTO. + The default FlowFile Expiration for this Process Group. - :param parent_group_id: The parent_group_id of this ProcessGroupDTO. + :param default_flow_file_expiration: The default_flow_file_expiration of this ProcessGroupDTO. :type: str """ - self._parent_group_id = parent_group_id + self._default_flow_file_expiration = default_flow_file_expiration @property - def position(self): + def disabled_count(self): """ - Gets the position of this ProcessGroupDTO. - The position of this component in the UI if applicable. + Gets the disabled_count of this ProcessGroupDTO. + The number of disabled components in the process group. - :return: The position of this ProcessGroupDTO. - :rtype: PositionDTO + :return: The disabled_count of this ProcessGroupDTO. + :rtype: int """ - return self._position + return self._disabled_count - @position.setter - def position(self, position): + @disabled_count.setter + def disabled_count(self, disabled_count): """ - Sets the position of this ProcessGroupDTO. - The position of this component in the UI if applicable. + Sets the disabled_count of this ProcessGroupDTO. + The number of disabled components in the process group. - :param position: The position of this ProcessGroupDTO. - :type: PositionDTO + :param disabled_count: The disabled_count of this ProcessGroupDTO. + :type: int """ - self._position = position + self._disabled_count = disabled_count @property - def name(self): + def execution_engine(self): """ - Gets the name of this ProcessGroupDTO. - The name of the process group. + Gets the execution_engine of this ProcessGroupDTO. + The Execution Engine that should be used to run the flow represented by this Process Group. - :return: The name of this ProcessGroupDTO. + :return: The execution_engine of this ProcessGroupDTO. :rtype: str """ - return self._name + return self._execution_engine - @name.setter - def name(self, name): + @execution_engine.setter + def execution_engine(self, execution_engine): """ - Sets the name of this ProcessGroupDTO. - The name of the process group. + Sets the execution_engine of this ProcessGroupDTO. + The Execution Engine that should be used to run the flow represented by this Process Group. - :param name: The name of this ProcessGroupDTO. + :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) + ) - self._name = name + self._execution_engine = execution_engine @property - def comments(self): + def flowfile_concurrency(self): """ - Gets the comments of this ProcessGroupDTO. - The comments for the process group. + Gets the flowfile_concurrency of this ProcessGroupDTO. + The FlowFile Concurrency for this Process Group. - :return: The comments of this ProcessGroupDTO. + :return: The flowfile_concurrency of this ProcessGroupDTO. :rtype: str """ - return self._comments + return self._flowfile_concurrency - @comments.setter - def comments(self, comments): + @flowfile_concurrency.setter + def flowfile_concurrency(self, flowfile_concurrency): """ - Sets the comments of this ProcessGroupDTO. - The comments for the process group. + Sets the flowfile_concurrency of this ProcessGroupDTO. + The FlowFile Concurrency for this Process Group. - :param comments: The comments of this ProcessGroupDTO. + :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) + ) - self._comments = comments + self._flowfile_concurrency = flowfile_concurrency @property - def variables(self): + def flowfile_outbound_policy(self): """ - Gets the variables of this ProcessGroupDTO. - The variables that are configured for the Process Group. Note that this map contains only those variables that are defined on this Process Group and not any variables that are defined in the parent Process Group, etc. I.e., this Map will not contain all variables that are accessible by components in this Process Group by rather only the variables that are defined for this Process Group itself. + Gets the flowfile_outbound_policy of this ProcessGroupDTO. + The Outbound Policy that is used for determining how FlowFiles should be transferred out of the Process Group. - :return: The variables of this ProcessGroupDTO. - :rtype: dict(str, str) + :return: The flowfile_outbound_policy of this ProcessGroupDTO. + :rtype: str """ - return self._variables + return self._flowfile_outbound_policy - @variables.setter - def variables(self, variables): + @flowfile_outbound_policy.setter + def flowfile_outbound_policy(self, flowfile_outbound_policy): """ - Sets the variables of this ProcessGroupDTO. - The variables that are configured for the Process Group. Note that this map contains only those variables that are defined on this Process Group and not any variables that are defined in the parent Process Group, etc. I.e., this Map will not contain all variables that are accessible by components in this Process Group by rather only the variables that are defined for this Process Group itself. + Sets the flowfile_outbound_policy of this ProcessGroupDTO. + The Outbound Policy that is used for determining how FlowFiles should be transferred out of the Process Group. - :param variables: The variables of this ProcessGroupDTO. - :type: dict(str, str) + :param flowfile_outbound_policy: The flowfile_outbound_policy of this ProcessGroupDTO. + :type: str """ + allowed_values = ["STREAM_WHEN_AVAILABLE", "BATCH_OUTPUT", ] + if flowfile_outbound_policy not in allowed_values: + raise ValueError( + "Invalid value for `flowfile_outbound_policy` ({0}), must be one of {1}" + .format(flowfile_outbound_policy, allowed_values) + ) - self._variables = variables + self._flowfile_outbound_policy = flowfile_outbound_policy @property - def version_control_information(self): + def id(self): """ - Gets the version_control_information of this ProcessGroupDTO. - The Version Control information that indicates which Flow Registry, and where in the Flow Registry, this Process Group is tracking to; or null if this Process Group is not under version control + Gets the id of this ProcessGroupDTO. + The id of the component. - :return: The version_control_information of this ProcessGroupDTO. - :rtype: VersionControlInformationDTO + :return: The id of this ProcessGroupDTO. + :rtype: str """ - return self._version_control_information + return self._id - @version_control_information.setter - def version_control_information(self, version_control_information): + @id.setter + def id(self, id): """ - Sets the version_control_information of this ProcessGroupDTO. - The Version Control information that indicates which Flow Registry, and where in the Flow Registry, this Process Group is tracking to; or null if this Process Group is not under version control + Sets the id of this ProcessGroupDTO. + The id of the component. - :param version_control_information: The version_control_information of this ProcessGroupDTO. - :type: VersionControlInformationDTO + :param id: The id of this ProcessGroupDTO. + :type: str """ - self._version_control_information = version_control_information + self._id = id @property - def parameter_context(self): + def inactive_remote_port_count(self): """ - Gets the parameter_context of this ProcessGroupDTO. - The Parameter Context that this Process Group is bound to. + Gets the inactive_remote_port_count of this ProcessGroupDTO. + The number of inactive remote ports in the process group. - :return: The parameter_context of this ProcessGroupDTO. - :rtype: ParameterContextReferenceEntity + :return: The inactive_remote_port_count of this ProcessGroupDTO. + :rtype: int """ - return self._parameter_context + return self._inactive_remote_port_count - @parameter_context.setter - def parameter_context(self, parameter_context): + @inactive_remote_port_count.setter + def inactive_remote_port_count(self, inactive_remote_port_count): """ - Sets the parameter_context of this ProcessGroupDTO. - The Parameter Context that this Process Group is bound to. + Sets the inactive_remote_port_count of this ProcessGroupDTO. + The number of inactive remote ports in the process group. - :param parameter_context: The parameter_context of this ProcessGroupDTO. - :type: ParameterContextReferenceEntity + :param inactive_remote_port_count: The inactive_remote_port_count of this ProcessGroupDTO. + :type: int """ - self._parameter_context = parameter_context + self._inactive_remote_port_count = inactive_remote_port_count @property - def flowfile_concurrency(self): + def input_port_count(self): """ - Gets the flowfile_concurrency of this ProcessGroupDTO. - The FlowFile Concurrency for this Process Group. + Gets the input_port_count of this ProcessGroupDTO. + The number of input ports in the process group. - :return: The flowfile_concurrency of this ProcessGroupDTO. - :rtype: str + :return: The input_port_count of this ProcessGroupDTO. + :rtype: int """ - return self._flowfile_concurrency + return self._input_port_count + + @input_port_count.setter + def input_port_count(self, input_port_count): + """ + Sets the input_port_count of this ProcessGroupDTO. + The number of input ports in the process group. + + :param input_port_count: The input_port_count of this ProcessGroupDTO. + :type: int + """ + + self._input_port_count = input_port_count + + @property + def invalid_count(self): + """ + Gets the invalid_count of this ProcessGroupDTO. + The number of invalid components in the process group. + + :return: The invalid_count of this ProcessGroupDTO. + :rtype: int + """ + return self._invalid_count - @flowfile_concurrency.setter - def flowfile_concurrency(self, flowfile_concurrency): + @invalid_count.setter + def invalid_count(self, invalid_count): """ - Sets the flowfile_concurrency of this ProcessGroupDTO. - The FlowFile Concurrency for this Process Group. + Sets the invalid_count of this ProcessGroupDTO. + The number of invalid components in the process group. - :param flowfile_concurrency: The flowfile_concurrency of this ProcessGroupDTO. - :type: str + :param invalid_count: The invalid_count of this ProcessGroupDTO. + :type: int """ - 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 + self._invalid_count = invalid_count @property - def flowfile_outbound_policy(self): + def local_input_port_count(self): """ - Gets the flowfile_outbound_policy of this ProcessGroupDTO. - The Outbound Policy that is used for determining how FlowFiles should be transferred out of the Process Group. + Gets the local_input_port_count of this ProcessGroupDTO. + The number of local input ports in the process group. - :return: The flowfile_outbound_policy of this ProcessGroupDTO. - :rtype: str + :return: The local_input_port_count of this ProcessGroupDTO. + :rtype: int """ - return self._flowfile_outbound_policy + return self._local_input_port_count - @flowfile_outbound_policy.setter - def flowfile_outbound_policy(self, flowfile_outbound_policy): + @local_input_port_count.setter + def local_input_port_count(self, local_input_port_count): """ - Sets the flowfile_outbound_policy of this ProcessGroupDTO. - The Outbound Policy that is used for determining how FlowFiles should be transferred out of the Process Group. + Sets the local_input_port_count of this ProcessGroupDTO. + The number of local input ports in the process group. - :param flowfile_outbound_policy: The flowfile_outbound_policy of this ProcessGroupDTO. - :type: str + :param local_input_port_count: The local_input_port_count of this ProcessGroupDTO. + :type: int """ - 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 + self._local_input_port_count = local_input_port_count @property - def default_flow_file_expiration(self): + def local_output_port_count(self): """ - Gets the default_flow_file_expiration of this ProcessGroupDTO. - The default FlowFile Expiration for this Process Group. + Gets the local_output_port_count of this ProcessGroupDTO. + The number of local output ports in the process group. - :return: The default_flow_file_expiration of this ProcessGroupDTO. - :rtype: str + :return: The local_output_port_count of this ProcessGroupDTO. + :rtype: int """ - return self._default_flow_file_expiration + return self._local_output_port_count - @default_flow_file_expiration.setter - def default_flow_file_expiration(self, default_flow_file_expiration): + @local_output_port_count.setter + def local_output_port_count(self, local_output_port_count): """ - Sets the default_flow_file_expiration of this ProcessGroupDTO. - The default FlowFile Expiration for this Process Group. + Sets the local_output_port_count of this ProcessGroupDTO. + The number of local output ports in the process group. - :param default_flow_file_expiration: The default_flow_file_expiration of this ProcessGroupDTO. - :type: str + :param local_output_port_count: The local_output_port_count of this ProcessGroupDTO. + :type: int """ - self._default_flow_file_expiration = default_flow_file_expiration + self._local_output_port_count = local_output_port_count @property - def default_back_pressure_object_threshold(self): + def locally_modified_and_stale_count(self): """ - Gets the default_back_pressure_object_threshold of this ProcessGroupDTO. - Default value used in this Process Group for the maximum number of objects that can be queued before back pressure is applied. + Gets the locally_modified_and_stale_count of this ProcessGroupDTO. + The number of locally modified and stale versioned process groups in the process group. - :return: The default_back_pressure_object_threshold of this ProcessGroupDTO. + :return: The locally_modified_and_stale_count of this ProcessGroupDTO. :rtype: int """ - return self._default_back_pressure_object_threshold + return self._locally_modified_and_stale_count - @default_back_pressure_object_threshold.setter - def default_back_pressure_object_threshold(self, default_back_pressure_object_threshold): + @locally_modified_and_stale_count.setter + def locally_modified_and_stale_count(self, locally_modified_and_stale_count): """ - Sets the default_back_pressure_object_threshold of this ProcessGroupDTO. - Default value used in this Process Group for the maximum number of objects that can be queued before back pressure is applied. + Sets the locally_modified_and_stale_count of this ProcessGroupDTO. + The number of locally modified and stale versioned process groups in the process group. - :param default_back_pressure_object_threshold: The default_back_pressure_object_threshold of this ProcessGroupDTO. + :param locally_modified_and_stale_count: The locally_modified_and_stale_count of this ProcessGroupDTO. :type: int """ - self._default_back_pressure_object_threshold = default_back_pressure_object_threshold + self._locally_modified_and_stale_count = locally_modified_and_stale_count @property - def default_back_pressure_data_size_threshold(self): + def locally_modified_count(self): """ - Gets the default_back_pressure_data_size_threshold of this ProcessGroupDTO. - Default value used in this Process Group for the maximum data size of objects that can be queued before back pressure is applied. + Gets the locally_modified_count of this ProcessGroupDTO. + The number of locally modified versioned process groups in the process group. - :return: The default_back_pressure_data_size_threshold of this ProcessGroupDTO. - :rtype: str + :return: The locally_modified_count of this ProcessGroupDTO. + :rtype: int """ - return self._default_back_pressure_data_size_threshold + return self._locally_modified_count - @default_back_pressure_data_size_threshold.setter - def default_back_pressure_data_size_threshold(self, default_back_pressure_data_size_threshold): + @locally_modified_count.setter + def locally_modified_count(self, locally_modified_count): """ - Sets the default_back_pressure_data_size_threshold of this ProcessGroupDTO. - Default value used in this Process Group for the maximum data size of objects that can be queued before back pressure is applied. + Sets the locally_modified_count of this ProcessGroupDTO. + The number of locally modified versioned process groups in the process group. - :param default_back_pressure_data_size_threshold: The default_back_pressure_data_size_threshold of this ProcessGroupDTO. - :type: str + :param locally_modified_count: The locally_modified_count of this ProcessGroupDTO. + :type: int """ - self._default_back_pressure_data_size_threshold = default_back_pressure_data_size_threshold + self._locally_modified_count = locally_modified_count @property def log_file_suffix(self): @@ -563,188 +671,207 @@ def log_file_suffix(self, log_file_suffix): self._log_file_suffix = log_file_suffix @property - def running_count(self): + def max_concurrent_tasks(self): """ - Gets the running_count of this ProcessGroupDTO. - The number of running components in this process group. + Gets the max_concurrent_tasks of this ProcessGroupDTO. + The maximum number of concurrent tasks to use when running the flow using the Stateless Engine - :return: The running_count of this ProcessGroupDTO. + :return: The max_concurrent_tasks of this ProcessGroupDTO. :rtype: int """ - return self._running_count + return self._max_concurrent_tasks - @running_count.setter - def running_count(self, running_count): + @max_concurrent_tasks.setter + def max_concurrent_tasks(self, max_concurrent_tasks): """ - Sets the running_count of this ProcessGroupDTO. - The number of running components in this process group. + Sets the max_concurrent_tasks of this ProcessGroupDTO. + The maximum number of concurrent tasks to use when running the flow using the Stateless Engine - :param running_count: The running_count of this ProcessGroupDTO. + :param max_concurrent_tasks: The max_concurrent_tasks of this ProcessGroupDTO. :type: int """ - self._running_count = running_count + self._max_concurrent_tasks = max_concurrent_tasks @property - def stopped_count(self): + def name(self): """ - Gets the stopped_count of this ProcessGroupDTO. - The number of stopped components in the process group. + Gets the name of this ProcessGroupDTO. + The name of the process group. - :return: The stopped_count of this ProcessGroupDTO. - :rtype: int + :return: The name of this ProcessGroupDTO. + :rtype: str """ - return self._stopped_count + return self._name - @stopped_count.setter - def stopped_count(self, stopped_count): + @name.setter + def name(self, name): """ - Sets the stopped_count of this ProcessGroupDTO. - The number of stopped components in the process group. + Sets the name of this ProcessGroupDTO. + The name of the process group. - :param stopped_count: The stopped_count of this ProcessGroupDTO. - :type: int + :param name: The name of this ProcessGroupDTO. + :type: str """ - self._stopped_count = stopped_count + self._name = name @property - def invalid_count(self): + def output_port_count(self): """ - Gets the invalid_count of this ProcessGroupDTO. - The number of invalid components in the process group. + Gets the output_port_count of this ProcessGroupDTO. + The number of output ports in the process group. - :return: The invalid_count of this ProcessGroupDTO. + :return: The output_port_count of this ProcessGroupDTO. :rtype: int """ - return self._invalid_count + return self._output_port_count - @invalid_count.setter - def invalid_count(self, invalid_count): + @output_port_count.setter + def output_port_count(self, output_port_count): """ - Sets the invalid_count of this ProcessGroupDTO. - The number of invalid components in the process group. + Sets the output_port_count of this ProcessGroupDTO. + The number of output ports in the process group. - :param invalid_count: The invalid_count of this ProcessGroupDTO. + :param output_port_count: The output_port_count of this ProcessGroupDTO. :type: int """ - self._invalid_count = invalid_count + self._output_port_count = output_port_count @property - def disabled_count(self): + def parameter_context(self): """ - Gets the disabled_count of this ProcessGroupDTO. - The number of disabled components in the process group. + Gets the parameter_context of this ProcessGroupDTO. - :return: The disabled_count of this ProcessGroupDTO. - :rtype: int + :return: The parameter_context of this ProcessGroupDTO. + :rtype: ParameterContextReferenceEntity """ - return self._disabled_count + return self._parameter_context - @disabled_count.setter - def disabled_count(self, disabled_count): + @parameter_context.setter + def parameter_context(self, parameter_context): """ - Sets the disabled_count of this ProcessGroupDTO. - The number of disabled components in the process group. + Sets the parameter_context of this ProcessGroupDTO. - :param disabled_count: The disabled_count of this ProcessGroupDTO. - :type: int + :param parameter_context: The parameter_context of this ProcessGroupDTO. + :type: ParameterContextReferenceEntity """ - self._disabled_count = disabled_count + self._parameter_context = parameter_context @property - def active_remote_port_count(self): + def parent_group_id(self): """ - Gets the active_remote_port_count of this ProcessGroupDTO. - The number of active remote ports in the process group. + Gets the parent_group_id of this ProcessGroupDTO. + The id of parent process group of this component if applicable. - :return: The active_remote_port_count of this ProcessGroupDTO. - :rtype: int + :return: The parent_group_id of this ProcessGroupDTO. + :rtype: str """ - return self._active_remote_port_count + return self._parent_group_id - @active_remote_port_count.setter - def active_remote_port_count(self, active_remote_port_count): + @parent_group_id.setter + def parent_group_id(self, parent_group_id): """ - Sets the active_remote_port_count of this ProcessGroupDTO. - The number of active remote ports in the process group. + Sets the parent_group_id of this ProcessGroupDTO. + The id of parent process group of this component if applicable. - :param active_remote_port_count: The active_remote_port_count of this ProcessGroupDTO. - :type: int + :param parent_group_id: The parent_group_id of this ProcessGroupDTO. + :type: str """ - self._active_remote_port_count = active_remote_port_count + self._parent_group_id = parent_group_id @property - def inactive_remote_port_count(self): + def position(self): + """ + Gets the position of this ProcessGroupDTO. + + :return: The position of this ProcessGroupDTO. + :rtype: PositionDTO + """ + return self._position + + @position.setter + def position(self, position): + """ + Sets the position of this ProcessGroupDTO. + + :param position: The position of this ProcessGroupDTO. + :type: PositionDTO + """ + + self._position = position + + @property + def public_input_port_count(self): """ - Gets the inactive_remote_port_count of this ProcessGroupDTO. - The number of inactive remote ports in the process group. + Gets the public_input_port_count of this ProcessGroupDTO. + The number of public input ports in the process group. - :return: The inactive_remote_port_count of this ProcessGroupDTO. + :return: The public_input_port_count of this ProcessGroupDTO. :rtype: int """ - return self._inactive_remote_port_count + return self._public_input_port_count - @inactive_remote_port_count.setter - def inactive_remote_port_count(self, inactive_remote_port_count): + @public_input_port_count.setter + def public_input_port_count(self, public_input_port_count): """ - Sets the inactive_remote_port_count of this ProcessGroupDTO. - The number of inactive remote ports in the process group. + Sets the public_input_port_count of this ProcessGroupDTO. + The number of public input ports in the process group. - :param inactive_remote_port_count: The inactive_remote_port_count of this ProcessGroupDTO. + :param public_input_port_count: The public_input_port_count of this ProcessGroupDTO. :type: int """ - self._inactive_remote_port_count = inactive_remote_port_count + self._public_input_port_count = public_input_port_count @property - def up_to_date_count(self): + def public_output_port_count(self): """ - Gets the up_to_date_count of this ProcessGroupDTO. - The number of up to date versioned process groups in the process group. + Gets the public_output_port_count of this ProcessGroupDTO. + The number of public output ports in the process group. - :return: The up_to_date_count of this ProcessGroupDTO. + :return: The public_output_port_count of this ProcessGroupDTO. :rtype: int """ - return self._up_to_date_count + return self._public_output_port_count - @up_to_date_count.setter - def up_to_date_count(self, up_to_date_count): + @public_output_port_count.setter + def public_output_port_count(self, public_output_port_count): """ - Sets the up_to_date_count of this ProcessGroupDTO. - The number of up to date versioned process groups in the process group. + Sets the public_output_port_count of this ProcessGroupDTO. + The number of public output ports in the process group. - :param up_to_date_count: The up_to_date_count of this ProcessGroupDTO. + :param public_output_port_count: The public_output_port_count of this ProcessGroupDTO. :type: int """ - self._up_to_date_count = up_to_date_count + self._public_output_port_count = public_output_port_count @property - def locally_modified_count(self): + def running_count(self): """ - Gets the locally_modified_count of this ProcessGroupDTO. - The number of locally modified versioned process groups in the process group. + Gets the running_count of this ProcessGroupDTO. + The number of running components in this process group. - :return: The locally_modified_count of this ProcessGroupDTO. + :return: The running_count of this ProcessGroupDTO. :rtype: int """ - return self._locally_modified_count + return self._running_count - @locally_modified_count.setter - def locally_modified_count(self, locally_modified_count): + @running_count.setter + def running_count(self, running_count): """ - Sets the locally_modified_count of this ProcessGroupDTO. - The number of locally modified versioned process groups in the process group. + Sets the running_count of this ProcessGroupDTO. + The number of running components in this process group. - :param locally_modified_count: The locally_modified_count of this ProcessGroupDTO. + :param running_count: The running_count of this ProcessGroupDTO. :type: int """ - self._locally_modified_count = locally_modified_count + self._running_count = running_count @property def stale_count(self): @@ -770,211 +897,169 @@ def stale_count(self, stale_count): self._stale_count = stale_count @property - def locally_modified_and_stale_count(self): - """ - Gets the locally_modified_and_stale_count of this ProcessGroupDTO. - The number of locally modified and stale versioned process groups in the process group. - - :return: The locally_modified_and_stale_count of this ProcessGroupDTO. - :rtype: int - """ - return self._locally_modified_and_stale_count - - @locally_modified_and_stale_count.setter - def locally_modified_and_stale_count(self, locally_modified_and_stale_count): - """ - Sets the locally_modified_and_stale_count of this ProcessGroupDTO. - The number of locally modified and stale versioned process groups in the process group. - - :param locally_modified_and_stale_count: The locally_modified_and_stale_count of this ProcessGroupDTO. - :type: int - """ - - self._locally_modified_and_stale_count = locally_modified_and_stale_count - - @property - def sync_failure_count(self): + def stateless_flow_timeout(self): """ - Gets the sync_failure_count of this ProcessGroupDTO. - The number of versioned process groups in the process group that are unable to sync to a registry. + Gets the stateless_flow_timeout of this ProcessGroupDTO. + The maximum amount of time that the flow can be run using the Stateless Engine before the flow times out - :return: The sync_failure_count of this ProcessGroupDTO. - :rtype: int + :return: The stateless_flow_timeout of this ProcessGroupDTO. + :rtype: str """ - return self._sync_failure_count + return self._stateless_flow_timeout - @sync_failure_count.setter - def sync_failure_count(self, sync_failure_count): + @stateless_flow_timeout.setter + def stateless_flow_timeout(self, stateless_flow_timeout): """ - Sets the sync_failure_count of this ProcessGroupDTO. - The number of versioned process groups in the process group that are unable to sync to a registry. + Sets the stateless_flow_timeout of this ProcessGroupDTO. + The maximum amount of time that the flow can be run using the Stateless Engine before the flow times out - :param sync_failure_count: The sync_failure_count of this ProcessGroupDTO. - :type: int + :param stateless_flow_timeout: The stateless_flow_timeout of this ProcessGroupDTO. + :type: str """ - self._sync_failure_count = sync_failure_count + self._stateless_flow_timeout = stateless_flow_timeout @property - def local_input_port_count(self): + def stateless_group_scheduled_state(self): """ - Gets the local_input_port_count of this ProcessGroupDTO. - The number of local input ports in the process group. + Gets the stateless_group_scheduled_state of this ProcessGroupDTO. + If the Process Group is configured to run in using the Stateless Engine, represents the current state. Otherwise, will be STOPPED. - :return: The local_input_port_count of this ProcessGroupDTO. - :rtype: int + :return: The stateless_group_scheduled_state of this ProcessGroupDTO. + :rtype: str """ - return self._local_input_port_count + return self._stateless_group_scheduled_state - @local_input_port_count.setter - def local_input_port_count(self, local_input_port_count): + @stateless_group_scheduled_state.setter + def stateless_group_scheduled_state(self, stateless_group_scheduled_state): """ - Sets the local_input_port_count of this ProcessGroupDTO. - The number of local input ports in the process group. + Sets the stateless_group_scheduled_state of this ProcessGroupDTO. + If the Process Group is configured to run in using the Stateless Engine, represents the current state. Otherwise, will be STOPPED. - :param local_input_port_count: The local_input_port_count of this ProcessGroupDTO. - :type: int + :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) + ) - self._local_input_port_count = local_input_port_count + self._stateless_group_scheduled_state = stateless_group_scheduled_state @property - def local_output_port_count(self): + def stopped_count(self): """ - Gets the local_output_port_count of this ProcessGroupDTO. - The number of local output ports in the process group. + Gets the stopped_count of this ProcessGroupDTO. + The number of stopped components in the process group. - :return: The local_output_port_count of this ProcessGroupDTO. + :return: The stopped_count of this ProcessGroupDTO. :rtype: int """ - return self._local_output_port_count + return self._stopped_count - @local_output_port_count.setter - def local_output_port_count(self, local_output_port_count): + @stopped_count.setter + def stopped_count(self, stopped_count): """ - Sets the local_output_port_count of this ProcessGroupDTO. - The number of local output ports in the process group. + Sets the stopped_count of this ProcessGroupDTO. + The number of stopped components in the process group. - :param local_output_port_count: The local_output_port_count of this ProcessGroupDTO. + :param stopped_count: The stopped_count of this ProcessGroupDTO. :type: int """ - self._local_output_port_count = local_output_port_count + self._stopped_count = stopped_count @property - def public_input_port_count(self): + def sync_failure_count(self): """ - Gets the public_input_port_count of this ProcessGroupDTO. - The number of public input ports in the process group. + Gets the sync_failure_count of this ProcessGroupDTO. + The number of versioned process groups in the process group that are unable to sync to a registry. - :return: The public_input_port_count of this ProcessGroupDTO. + :return: The sync_failure_count of this ProcessGroupDTO. :rtype: int """ - return self._public_input_port_count + return self._sync_failure_count - @public_input_port_count.setter - def public_input_port_count(self, public_input_port_count): + @sync_failure_count.setter + def sync_failure_count(self, sync_failure_count): """ - Sets the public_input_port_count of this ProcessGroupDTO. - The number of public input ports in the process group. + Sets the sync_failure_count of this ProcessGroupDTO. + The number of versioned process groups in the process group that are unable to sync to a registry. - :param public_input_port_count: The public_input_port_count of this ProcessGroupDTO. + :param sync_failure_count: The sync_failure_count of this ProcessGroupDTO. :type: int """ - self._public_input_port_count = public_input_port_count + self._sync_failure_count = sync_failure_count @property - def public_output_port_count(self): + def up_to_date_count(self): """ - Gets the public_output_port_count of this ProcessGroupDTO. - The number of public output ports in the process group. + Gets the up_to_date_count of this ProcessGroupDTO. + The number of up to date versioned process groups in the process group. - :return: The public_output_port_count of this ProcessGroupDTO. + :return: The up_to_date_count of this ProcessGroupDTO. :rtype: int """ - return self._public_output_port_count + return self._up_to_date_count - @public_output_port_count.setter - def public_output_port_count(self, public_output_port_count): + @up_to_date_count.setter + def up_to_date_count(self, up_to_date_count): """ - Sets the public_output_port_count of this ProcessGroupDTO. - The number of public output ports in the process group. + Sets the up_to_date_count of this ProcessGroupDTO. + The number of up to date versioned process groups in the process group. - :param public_output_port_count: The public_output_port_count of this ProcessGroupDTO. + :param up_to_date_count: The up_to_date_count of this ProcessGroupDTO. :type: int """ - self._public_output_port_count = public_output_port_count - - @property - def contents(self): - """ - Gets the contents of this ProcessGroupDTO. - The contents of this process group. - - :return: The contents of this ProcessGroupDTO. - :rtype: FlowSnippetDTO - """ - return self._contents - - @contents.setter - def contents(self, contents): - """ - Sets the contents of this ProcessGroupDTO. - The contents of this process group. - - :param contents: The contents of this ProcessGroupDTO. - :type: FlowSnippetDTO - """ - - self._contents = contents + self._up_to_date_count = up_to_date_count @property - def input_port_count(self): + def version_control_information(self): """ - Gets the input_port_count of this ProcessGroupDTO. - The number of input ports in the process group. + Gets the version_control_information of this ProcessGroupDTO. - :return: The input_port_count of this ProcessGroupDTO. - :rtype: int + :return: The version_control_information of this ProcessGroupDTO. + :rtype: VersionControlInformationDTO """ - return self._input_port_count + return self._version_control_information - @input_port_count.setter - def input_port_count(self, input_port_count): + @version_control_information.setter + def version_control_information(self, version_control_information): """ - Sets the input_port_count of this ProcessGroupDTO. - The number of input ports in the process group. + Sets the version_control_information of this ProcessGroupDTO. - :param input_port_count: The input_port_count of this ProcessGroupDTO. - :type: int + :param version_control_information: The version_control_information of this ProcessGroupDTO. + :type: VersionControlInformationDTO """ - self._input_port_count = input_port_count + self._version_control_information = version_control_information @property - def output_port_count(self): + def versioned_component_id(self): """ - Gets the output_port_count of this ProcessGroupDTO. - The number of output ports in the process group. + Gets the versioned_component_id of this ProcessGroupDTO. + The ID of the corresponding component that is under version control - :return: The output_port_count of this ProcessGroupDTO. - :rtype: int + :return: The versioned_component_id of this ProcessGroupDTO. + :rtype: str """ - return self._output_port_count + return self._versioned_component_id - @output_port_count.setter - def output_port_count(self, output_port_count): + @versioned_component_id.setter + def versioned_component_id(self, versioned_component_id): """ - Sets the output_port_count of this ProcessGroupDTO. - The number of output ports in the process group. + Sets the versioned_component_id of this ProcessGroupDTO. + The ID of the corresponding component that is under version control - :param output_port_count: The output_port_count of this ProcessGroupDTO. - :type: int + :param versioned_component_id: The versioned_component_id of this ProcessGroupDTO. + :type: str """ - self._output_port_count = output_port_count + self._versioned_component_id = versioned_component_id def to_dict(self): """ diff --git a/nipyapi/nifi/models/process_group_entity.py b/nipyapi/nifi/models/process_group_entity.py index df4dc362..7b9b08d2 100644 --- a/nipyapi/nifi/models/process_group_entity.py +++ b/nipyapi/nifi/models/process_group_entity.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,867 +27,853 @@ class ProcessGroupEntity(object): and the value is json key in definition. """ swagger_types = { - 'revision': 'RevisionDTO', - 'id': 'str', - 'uri': 'str', - 'position': 'PositionDTO', - 'permissions': 'PermissionsDTO', - 'bulletins': 'list[BulletinEntity]', - 'disconnected_node_acknowledged': 'bool', - 'component': 'ProcessGroupDTO', - 'status': 'ProcessGroupStatusDTO', - 'versioned_flow_snapshot': 'RegisteredFlowSnapshot', - 'running_count': 'int', - 'stopped_count': 'int', - 'invalid_count': 'int', - 'disabled_count': 'int', 'active_remote_port_count': 'int', - 'inactive_remote_port_count': 'int', - 'versioned_flow_state': 'str', - 'up_to_date_count': 'int', - 'locally_modified_count': 'int', - 'stale_count': 'int', - 'locally_modified_and_stale_count': 'int', - 'sync_failure_count': 'int', - 'local_input_port_count': 'int', - 'local_output_port_count': 'int', - 'public_input_port_count': 'int', - 'public_output_port_count': 'int', - 'parameter_context': 'ParameterContextReferenceEntity', - 'process_group_update_strategy': 'str', - 'input_port_count': 'int', - 'output_port_count': 'int' - } +'bulletins': 'list[BulletinEntity]', +'component': 'ProcessGroupDTO', +'disabled_count': 'int', +'disconnected_node_acknowledged': 'bool', +'id': 'str', +'inactive_remote_port_count': 'int', +'input_port_count': 'int', +'invalid_count': 'int', +'local_input_port_count': 'int', +'local_output_port_count': 'int', +'locally_modified_and_stale_count': 'int', +'locally_modified_count': 'int', +'output_port_count': 'int', +'parameter_context': 'ParameterContextReferenceEntity', +'permissions': 'PermissionsDTO', +'position': 'PositionDTO', +'process_group_update_strategy': 'str', +'public_input_port_count': 'int', +'public_output_port_count': 'int', +'revision': 'RevisionDTO', +'running_count': 'int', +'stale_count': 'int', +'status': 'ProcessGroupStatusDTO', +'stopped_count': 'int', +'sync_failure_count': 'int', +'up_to_date_count': 'int', +'uri': 'str', +'versioned_flow_snapshot': 'RegisteredFlowSnapshot', +'versioned_flow_state': 'str' } attribute_map = { - 'revision': 'revision', - 'id': 'id', - 'uri': 'uri', - 'position': 'position', - 'permissions': 'permissions', - 'bulletins': 'bulletins', - 'disconnected_node_acknowledged': 'disconnectedNodeAcknowledged', - 'component': 'component', - 'status': 'status', - 'versioned_flow_snapshot': 'versionedFlowSnapshot', - 'running_count': 'runningCount', - 'stopped_count': 'stoppedCount', - 'invalid_count': 'invalidCount', - 'disabled_count': 'disabledCount', 'active_remote_port_count': 'activeRemotePortCount', - 'inactive_remote_port_count': 'inactiveRemotePortCount', - 'versioned_flow_state': 'versionedFlowState', - 'up_to_date_count': 'upToDateCount', - 'locally_modified_count': 'locallyModifiedCount', - 'stale_count': 'staleCount', - 'locally_modified_and_stale_count': 'locallyModifiedAndStaleCount', - 'sync_failure_count': 'syncFailureCount', - 'local_input_port_count': 'localInputPortCount', - 'local_output_port_count': 'localOutputPortCount', - 'public_input_port_count': 'publicInputPortCount', - 'public_output_port_count': 'publicOutputPortCount', - 'parameter_context': 'parameterContext', - 'process_group_update_strategy': 'processGroupUpdateStrategy', - 'input_port_count': 'inputPortCount', - 'output_port_count': 'outputPortCount' - } - - def __init__(self, revision=None, id=None, uri=None, position=None, permissions=None, bulletins=None, disconnected_node_acknowledged=None, component=None, status=None, versioned_flow_snapshot=None, running_count=None, stopped_count=None, invalid_count=None, disabled_count=None, active_remote_port_count=None, inactive_remote_port_count=None, versioned_flow_state=None, up_to_date_count=None, locally_modified_count=None, stale_count=None, locally_modified_and_stale_count=None, sync_failure_count=None, local_input_port_count=None, local_output_port_count=None, public_input_port_count=None, public_output_port_count=None, parameter_context=None, process_group_update_strategy=None, input_port_count=None, output_port_count=None): +'bulletins': 'bulletins', +'component': 'component', +'disabled_count': 'disabledCount', +'disconnected_node_acknowledged': 'disconnectedNodeAcknowledged', +'id': 'id', +'inactive_remote_port_count': 'inactiveRemotePortCount', +'input_port_count': 'inputPortCount', +'invalid_count': 'invalidCount', +'local_input_port_count': 'localInputPortCount', +'local_output_port_count': 'localOutputPortCount', +'locally_modified_and_stale_count': 'locallyModifiedAndStaleCount', +'locally_modified_count': 'locallyModifiedCount', +'output_port_count': 'outputPortCount', +'parameter_context': 'parameterContext', +'permissions': 'permissions', +'position': 'position', +'process_group_update_strategy': 'processGroupUpdateStrategy', +'public_input_port_count': 'publicInputPortCount', +'public_output_port_count': 'publicOutputPortCount', +'revision': 'revision', +'running_count': 'runningCount', +'stale_count': 'staleCount', +'status': 'status', +'stopped_count': 'stoppedCount', +'sync_failure_count': 'syncFailureCount', +'up_to_date_count': 'upToDateCount', +'uri': 'uri', +'versioned_flow_snapshot': 'versionedFlowSnapshot', +'versioned_flow_state': 'versionedFlowState' } + + def __init__(self, active_remote_port_count=None, bulletins=None, component=None, disabled_count=None, disconnected_node_acknowledged=None, id=None, inactive_remote_port_count=None, input_port_count=None, invalid_count=None, local_input_port_count=None, local_output_port_count=None, locally_modified_and_stale_count=None, locally_modified_count=None, output_port_count=None, parameter_context=None, permissions=None, position=None, process_group_update_strategy=None, public_input_port_count=None, public_output_port_count=None, revision=None, running_count=None, stale_count=None, status=None, stopped_count=None, sync_failure_count=None, up_to_date_count=None, uri=None, versioned_flow_snapshot=None, versioned_flow_state=None): """ ProcessGroupEntity - a model defined in Swagger """ - self._revision = None - self._id = None - self._uri = None - self._position = None - self._permissions = None + self._active_remote_port_count = None self._bulletins = None - self._disconnected_node_acknowledged = None self._component = None - self._status = None - self._versioned_flow_snapshot = None - self._running_count = None - self._stopped_count = None - self._invalid_count = None self._disabled_count = None - self._active_remote_port_count = None + self._disconnected_node_acknowledged = None + self._id = None self._inactive_remote_port_count = None - self._versioned_flow_state = None - self._up_to_date_count = None - self._locally_modified_count = None - self._stale_count = None - self._locally_modified_and_stale_count = None - self._sync_failure_count = None + self._input_port_count = None + self._invalid_count = None self._local_input_port_count = None self._local_output_port_count = None - self._public_input_port_count = None - self._public_output_port_count = None + self._locally_modified_and_stale_count = None + self._locally_modified_count = None + self._output_port_count = None self._parameter_context = None + self._permissions = None + self._position = None self._process_group_update_strategy = None - self._input_port_count = None - self._output_port_count = None + self._public_input_port_count = None + self._public_output_port_count = None + self._revision = None + self._running_count = None + self._stale_count = None + self._status = None + self._stopped_count = None + self._sync_failure_count = None + self._up_to_date_count = None + self._uri = None + self._versioned_flow_snapshot = None + self._versioned_flow_state = None - if revision is not None: - self.revision = revision - if id is not None: - self.id = id - if uri is not None: - self.uri = uri - if position is not None: - self.position = position - if permissions is not None: - self.permissions = permissions + if active_remote_port_count is not None: + self.active_remote_port_count = active_remote_port_count if bulletins is not None: self.bulletins = bulletins - if disconnected_node_acknowledged is not None: - self.disconnected_node_acknowledged = disconnected_node_acknowledged if component is not None: self.component = component - if status is not None: - self.status = status - if versioned_flow_snapshot is not None: - self.versioned_flow_snapshot = versioned_flow_snapshot - if running_count is not None: - self.running_count = running_count - if stopped_count is not None: - self.stopped_count = stopped_count - if invalid_count is not None: - self.invalid_count = invalid_count if disabled_count is not None: self.disabled_count = disabled_count - if active_remote_port_count is not None: - self.active_remote_port_count = active_remote_port_count + if disconnected_node_acknowledged is not None: + self.disconnected_node_acknowledged = disconnected_node_acknowledged + if id is not None: + self.id = id if inactive_remote_port_count is not None: self.inactive_remote_port_count = inactive_remote_port_count - if versioned_flow_state is not None: - self.versioned_flow_state = versioned_flow_state - if up_to_date_count is not None: - self.up_to_date_count = up_to_date_count - if locally_modified_count is not None: - self.locally_modified_count = locally_modified_count - if stale_count is not None: - self.stale_count = stale_count - if locally_modified_and_stale_count is not None: - self.locally_modified_and_stale_count = locally_modified_and_stale_count - if sync_failure_count is not None: - self.sync_failure_count = sync_failure_count + if input_port_count is not None: + self.input_port_count = input_port_count + if invalid_count is not None: + self.invalid_count = invalid_count if local_input_port_count is not None: self.local_input_port_count = local_input_port_count if local_output_port_count is not None: self.local_output_port_count = local_output_port_count - if public_input_port_count is not None: - self.public_input_port_count = public_input_port_count - if public_output_port_count is not None: - self.public_output_port_count = public_output_port_count + if locally_modified_and_stale_count is not None: + self.locally_modified_and_stale_count = locally_modified_and_stale_count + if locally_modified_count is not None: + self.locally_modified_count = locally_modified_count + if output_port_count is not None: + self.output_port_count = output_port_count if parameter_context is not None: self.parameter_context = parameter_context + if permissions is not None: + self.permissions = permissions + if position is not None: + self.position = position if process_group_update_strategy is not None: self.process_group_update_strategy = process_group_update_strategy - if input_port_count is not None: - self.input_port_count = input_port_count - if output_port_count is not None: - self.output_port_count = output_port_count + if public_input_port_count is not None: + self.public_input_port_count = public_input_port_count + if public_output_port_count is not None: + self.public_output_port_count = public_output_port_count + if revision is not None: + self.revision = revision + if running_count is not None: + self.running_count = running_count + if stale_count is not None: + self.stale_count = stale_count + if status is not None: + self.status = status + if stopped_count is not None: + self.stopped_count = stopped_count + if sync_failure_count is not None: + self.sync_failure_count = sync_failure_count + if up_to_date_count is not None: + self.up_to_date_count = up_to_date_count + if uri is not None: + self.uri = uri + if versioned_flow_snapshot is not None: + self.versioned_flow_snapshot = versioned_flow_snapshot + if versioned_flow_state is not None: + self.versioned_flow_state = versioned_flow_state @property - def revision(self): + def active_remote_port_count(self): """ - Gets the revision of this ProcessGroupEntity. - The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses. + Gets the active_remote_port_count of this ProcessGroupEntity. + The number of active remote ports in the process group. - :return: The revision of this ProcessGroupEntity. - :rtype: RevisionDTO + :return: The active_remote_port_count of this ProcessGroupEntity. + :rtype: int """ - return self._revision + return self._active_remote_port_count - @revision.setter - def revision(self, revision): + @active_remote_port_count.setter + def active_remote_port_count(self, active_remote_port_count): """ - Sets the revision of this ProcessGroupEntity. - The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses. + Sets the active_remote_port_count of this ProcessGroupEntity. + The number of active remote ports in the process group. - :param revision: The revision of this ProcessGroupEntity. - :type: RevisionDTO + :param active_remote_port_count: The active_remote_port_count of this ProcessGroupEntity. + :type: int """ - self._revision = revision + self._active_remote_port_count = active_remote_port_count @property - def id(self): + def bulletins(self): """ - Gets the id of this ProcessGroupEntity. - The id of the component. + Gets the bulletins of this ProcessGroupEntity. + The bulletins for this component. - :return: The id of this ProcessGroupEntity. - :rtype: str + :return: The bulletins of this ProcessGroupEntity. + :rtype: list[BulletinEntity] """ - return self._id + return self._bulletins - @id.setter - def id(self, id): + @bulletins.setter + def bulletins(self, bulletins): """ - Sets the id of this ProcessGroupEntity. - The id of the component. + Sets the bulletins of this ProcessGroupEntity. + The bulletins for this component. - :param id: The id of this ProcessGroupEntity. - :type: str + :param bulletins: The bulletins of this ProcessGroupEntity. + :type: list[BulletinEntity] """ - self._id = id + self._bulletins = bulletins @property - def uri(self): + def component(self): """ - Gets the uri of this ProcessGroupEntity. - The URI for futures requests to the component. + Gets the component of this ProcessGroupEntity. - :return: The uri of this ProcessGroupEntity. - :rtype: str + :return: The component of this ProcessGroupEntity. + :rtype: ProcessGroupDTO """ - return self._uri + return self._component - @uri.setter - def uri(self, uri): + @component.setter + def component(self, component): """ - Sets the uri of this ProcessGroupEntity. - The URI for futures requests to the component. + Sets the component of this ProcessGroupEntity. - :param uri: The uri of this ProcessGroupEntity. - :type: str + :param component: The component of this ProcessGroupEntity. + :type: ProcessGroupDTO """ - self._uri = uri + self._component = component @property - def position(self): + def disabled_count(self): """ - Gets the position of this ProcessGroupEntity. - The position of this component in the UI if applicable. + Gets the disabled_count of this ProcessGroupEntity. + The number of disabled components in the process group. - :return: The position of this ProcessGroupEntity. - :rtype: PositionDTO + :return: The disabled_count of this ProcessGroupEntity. + :rtype: int """ - return self._position + return self._disabled_count - @position.setter - def position(self, position): + @disabled_count.setter + def disabled_count(self, disabled_count): """ - Sets the position of this ProcessGroupEntity. - The position of this component in the UI if applicable. + Sets the disabled_count of this ProcessGroupEntity. + The number of disabled components in the process group. - :param position: The position of this ProcessGroupEntity. - :type: PositionDTO + :param disabled_count: The disabled_count of this ProcessGroupEntity. + :type: int """ - self._position = position + self._disabled_count = disabled_count @property - def permissions(self): + def disconnected_node_acknowledged(self): """ - Gets the permissions of this ProcessGroupEntity. - The permissions for this component. + Gets the disconnected_node_acknowledged of this ProcessGroupEntity. + Acknowledges that this node is disconnected to allow for mutable requests to proceed. - :return: The permissions of this ProcessGroupEntity. - :rtype: PermissionsDTO + :return: The disconnected_node_acknowledged of this ProcessGroupEntity. + :rtype: bool """ - return self._permissions + return self._disconnected_node_acknowledged - @permissions.setter - def permissions(self, permissions): + @disconnected_node_acknowledged.setter + def disconnected_node_acknowledged(self, disconnected_node_acknowledged): """ - Sets the permissions of this ProcessGroupEntity. - The permissions for this component. + Sets the disconnected_node_acknowledged of this ProcessGroupEntity. + Acknowledges that this node is disconnected to allow for mutable requests to proceed. - :param permissions: The permissions of this ProcessGroupEntity. - :type: PermissionsDTO + :param disconnected_node_acknowledged: The disconnected_node_acknowledged of this ProcessGroupEntity. + :type: bool """ - self._permissions = permissions + self._disconnected_node_acknowledged = disconnected_node_acknowledged @property - def bulletins(self): + def id(self): """ - Gets the bulletins of this ProcessGroupEntity. - The bulletins for this component. + Gets the id of this ProcessGroupEntity. + The id of the component. - :return: The bulletins of this ProcessGroupEntity. - :rtype: list[BulletinEntity] + :return: The id of this ProcessGroupEntity. + :rtype: str """ - return self._bulletins + return self._id - @bulletins.setter - def bulletins(self, bulletins): + @id.setter + def id(self, id): """ - Sets the bulletins of this ProcessGroupEntity. - The bulletins for this component. + Sets the id of this ProcessGroupEntity. + The id of the component. - :param bulletins: The bulletins of this ProcessGroupEntity. - :type: list[BulletinEntity] + :param id: The id of this ProcessGroupEntity. + :type: str """ - self._bulletins = bulletins + self._id = id @property - def disconnected_node_acknowledged(self): + def inactive_remote_port_count(self): """ - Gets the disconnected_node_acknowledged of this ProcessGroupEntity. - Acknowledges that this node is disconnected to allow for mutable requests to proceed. + Gets the inactive_remote_port_count of this ProcessGroupEntity. + The number of inactive remote ports in the process group. - :return: The disconnected_node_acknowledged of this ProcessGroupEntity. - :rtype: bool + :return: The inactive_remote_port_count of this ProcessGroupEntity. + :rtype: int """ - return self._disconnected_node_acknowledged + return self._inactive_remote_port_count - @disconnected_node_acknowledged.setter - def disconnected_node_acknowledged(self, disconnected_node_acknowledged): + @inactive_remote_port_count.setter + def inactive_remote_port_count(self, inactive_remote_port_count): """ - Sets the disconnected_node_acknowledged of this ProcessGroupEntity. - Acknowledges that this node is disconnected to allow for mutable requests to proceed. + Sets the inactive_remote_port_count of this ProcessGroupEntity. + The number of inactive remote ports in the process group. - :param disconnected_node_acknowledged: The disconnected_node_acknowledged of this ProcessGroupEntity. - :type: bool + :param inactive_remote_port_count: The inactive_remote_port_count of this ProcessGroupEntity. + :type: int """ - self._disconnected_node_acknowledged = disconnected_node_acknowledged + self._inactive_remote_port_count = inactive_remote_port_count @property - def component(self): + def input_port_count(self): """ - Gets the component of this ProcessGroupEntity. + Gets the input_port_count of this ProcessGroupEntity. + The number of input ports in the process group. - :return: The component of this ProcessGroupEntity. - :rtype: ProcessGroupDTO + :return: The input_port_count of this ProcessGroupEntity. + :rtype: int """ - return self._component + return self._input_port_count - @component.setter - def component(self, component): + @input_port_count.setter + def input_port_count(self, input_port_count): """ - Sets the component of this ProcessGroupEntity. + Sets the input_port_count of this ProcessGroupEntity. + The number of input ports in the process group. - :param component: The component of this ProcessGroupEntity. - :type: ProcessGroupDTO + :param input_port_count: The input_port_count of this ProcessGroupEntity. + :type: int """ - self._component = component + self._input_port_count = input_port_count @property - def status(self): + def invalid_count(self): """ - Gets the status of this ProcessGroupEntity. - The status of the process group. + Gets the invalid_count of this ProcessGroupEntity. + The number of invalid components in the process group. - :return: The status of this ProcessGroupEntity. - :rtype: ProcessGroupStatusDTO + :return: The invalid_count of this ProcessGroupEntity. + :rtype: int """ - return self._status + return self._invalid_count - @status.setter - def status(self, status): + @invalid_count.setter + def invalid_count(self, invalid_count): """ - Sets the status of this ProcessGroupEntity. - The status of the process group. + Sets the invalid_count of this ProcessGroupEntity. + The number of invalid components in the process group. - :param status: The status of this ProcessGroupEntity. - :type: ProcessGroupStatusDTO + :param invalid_count: The invalid_count of this ProcessGroupEntity. + :type: int """ - self._status = status + self._invalid_count = invalid_count @property - def versioned_flow_snapshot(self): + def local_input_port_count(self): """ - Gets the versioned_flow_snapshot of this ProcessGroupEntity. - Returns the Versioned Flow that describes the contents of the Versioned Flow to be imported + Gets the local_input_port_count of this ProcessGroupEntity. + The number of local input ports in the process group. - :return: The versioned_flow_snapshot of this ProcessGroupEntity. - :rtype: RegisteredFlowSnapshot + :return: The local_input_port_count of this ProcessGroupEntity. + :rtype: int """ - return self._versioned_flow_snapshot + return self._local_input_port_count - @versioned_flow_snapshot.setter - def versioned_flow_snapshot(self, versioned_flow_snapshot): + @local_input_port_count.setter + def local_input_port_count(self, local_input_port_count): """ - Sets the versioned_flow_snapshot of this ProcessGroupEntity. - Returns the Versioned Flow that describes the contents of the Versioned Flow to be imported + Sets the local_input_port_count of this ProcessGroupEntity. + The number of local input ports in the process group. - :param versioned_flow_snapshot: The versioned_flow_snapshot of this ProcessGroupEntity. - :type: RegisteredFlowSnapshot + :param local_input_port_count: The local_input_port_count of this ProcessGroupEntity. + :type: int """ - self._versioned_flow_snapshot = versioned_flow_snapshot + self._local_input_port_count = local_input_port_count @property - def running_count(self): + def local_output_port_count(self): """ - Gets the running_count of this ProcessGroupEntity. - The number of running components in this process group. + Gets the local_output_port_count of this ProcessGroupEntity. + The number of local output ports in the process group. - :return: The running_count of this ProcessGroupEntity. + :return: The local_output_port_count of this ProcessGroupEntity. :rtype: int """ - return self._running_count + return self._local_output_port_count - @running_count.setter - def running_count(self, running_count): + @local_output_port_count.setter + def local_output_port_count(self, local_output_port_count): """ - Sets the running_count of this ProcessGroupEntity. - The number of running components in this process group. + Sets the local_output_port_count of this ProcessGroupEntity. + The number of local output ports in the process group. - :param running_count: The running_count of this ProcessGroupEntity. + :param local_output_port_count: The local_output_port_count of this ProcessGroupEntity. :type: int """ - self._running_count = running_count + self._local_output_port_count = local_output_port_count @property - def stopped_count(self): + def locally_modified_and_stale_count(self): """ - Gets the stopped_count of this ProcessGroupEntity. - The number of stopped components in the process group. + Gets the locally_modified_and_stale_count of this ProcessGroupEntity. + The number of locally modified and stale versioned process groups in the process group. - :return: The stopped_count of this ProcessGroupEntity. + :return: The locally_modified_and_stale_count of this ProcessGroupEntity. :rtype: int """ - return self._stopped_count + return self._locally_modified_and_stale_count - @stopped_count.setter - def stopped_count(self, stopped_count): + @locally_modified_and_stale_count.setter + def locally_modified_and_stale_count(self, locally_modified_and_stale_count): """ - Sets the stopped_count of this ProcessGroupEntity. - The number of stopped components in the process group. + Sets the locally_modified_and_stale_count of this ProcessGroupEntity. + The number of locally modified and stale versioned process groups in the process group. - :param stopped_count: The stopped_count of this ProcessGroupEntity. + :param locally_modified_and_stale_count: The locally_modified_and_stale_count of this ProcessGroupEntity. :type: int """ - self._stopped_count = stopped_count + self._locally_modified_and_stale_count = locally_modified_and_stale_count @property - def invalid_count(self): + def locally_modified_count(self): """ - Gets the invalid_count of this ProcessGroupEntity. - The number of invalid components in the process group. + Gets the locally_modified_count of this ProcessGroupEntity. + The number of locally modified versioned process groups in the process group. - :return: The invalid_count of this ProcessGroupEntity. + :return: The locally_modified_count of this ProcessGroupEntity. :rtype: int """ - return self._invalid_count + return self._locally_modified_count - @invalid_count.setter - def invalid_count(self, invalid_count): + @locally_modified_count.setter + def locally_modified_count(self, locally_modified_count): """ - Sets the invalid_count of this ProcessGroupEntity. - The number of invalid components in the process group. + Sets the locally_modified_count of this ProcessGroupEntity. + The number of locally modified versioned process groups in the process group. - :param invalid_count: The invalid_count of this ProcessGroupEntity. + :param locally_modified_count: The locally_modified_count of this ProcessGroupEntity. :type: int """ - self._invalid_count = invalid_count + self._locally_modified_count = locally_modified_count @property - def disabled_count(self): + def output_port_count(self): """ - Gets the disabled_count of this ProcessGroupEntity. - The number of disabled components in the process group. + Gets the output_port_count of this ProcessGroupEntity. + The number of output ports in the process group. - :return: The disabled_count of this ProcessGroupEntity. + :return: The output_port_count of this ProcessGroupEntity. :rtype: int """ - return self._disabled_count + return self._output_port_count - @disabled_count.setter - def disabled_count(self, disabled_count): + @output_port_count.setter + def output_port_count(self, output_port_count): """ - Sets the disabled_count of this ProcessGroupEntity. - The number of disabled components in the process group. + Sets the output_port_count of this ProcessGroupEntity. + The number of output ports in the process group. - :param disabled_count: The disabled_count of this ProcessGroupEntity. + :param output_port_count: The output_port_count of this ProcessGroupEntity. :type: int """ - self._disabled_count = disabled_count + self._output_port_count = output_port_count @property - def active_remote_port_count(self): + def parameter_context(self): """ - Gets the active_remote_port_count of this ProcessGroupEntity. - The number of active remote ports in the process group. + Gets the parameter_context of this ProcessGroupEntity. - :return: The active_remote_port_count of this ProcessGroupEntity. - :rtype: int + :return: The parameter_context of this ProcessGroupEntity. + :rtype: ParameterContextReferenceEntity """ - return self._active_remote_port_count + return self._parameter_context - @active_remote_port_count.setter - def active_remote_port_count(self, active_remote_port_count): + @parameter_context.setter + def parameter_context(self, parameter_context): """ - Sets the active_remote_port_count of this ProcessGroupEntity. - The number of active remote ports in the process group. + Sets the parameter_context of this ProcessGroupEntity. - :param active_remote_port_count: The active_remote_port_count of this ProcessGroupEntity. - :type: int + :param parameter_context: The parameter_context of this ProcessGroupEntity. + :type: ParameterContextReferenceEntity """ - self._active_remote_port_count = active_remote_port_count + self._parameter_context = parameter_context @property - def inactive_remote_port_count(self): + def permissions(self): """ - Gets the inactive_remote_port_count of this ProcessGroupEntity. - The number of inactive remote ports in the process group. + Gets the permissions of this ProcessGroupEntity. - :return: The inactive_remote_port_count of this ProcessGroupEntity. - :rtype: int + :return: The permissions of this ProcessGroupEntity. + :rtype: PermissionsDTO """ - return self._inactive_remote_port_count + return self._permissions - @inactive_remote_port_count.setter - def inactive_remote_port_count(self, inactive_remote_port_count): + @permissions.setter + def permissions(self, permissions): """ - Sets the inactive_remote_port_count of this ProcessGroupEntity. - The number of inactive remote ports in the process group. + Sets the permissions of this ProcessGroupEntity. - :param inactive_remote_port_count: The inactive_remote_port_count of this ProcessGroupEntity. - :type: int + :param permissions: The permissions of this ProcessGroupEntity. + :type: PermissionsDTO """ - self._inactive_remote_port_count = inactive_remote_port_count + self._permissions = permissions @property - def versioned_flow_state(self): + def position(self): """ - Gets the versioned_flow_state of this ProcessGroupEntity. - The current state of the Process Group, as it relates to the Versioned Flow + Gets the position of this ProcessGroupEntity. - :return: The versioned_flow_state of this ProcessGroupEntity. - :rtype: str + :return: The position of this ProcessGroupEntity. + :rtype: PositionDTO """ - return self._versioned_flow_state + return self._position - @versioned_flow_state.setter - def versioned_flow_state(self, versioned_flow_state): + @position.setter + def position(self, position): """ - Sets the versioned_flow_state of this ProcessGroupEntity. - The current state of the Process Group, as it relates to the Versioned Flow + Sets the position of this ProcessGroupEntity. - :param versioned_flow_state: The versioned_flow_state of this ProcessGroupEntity. - :type: str + :param position: The position of this ProcessGroupEntity. + :type: PositionDTO """ - 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 + self._position = position @property - def up_to_date_count(self): + def process_group_update_strategy(self): """ - Gets the up_to_date_count of this ProcessGroupEntity. - The number of up to date versioned process groups in the process group. + Gets the process_group_update_strategy of this ProcessGroupEntity. + Determines the process group update strategy - :return: The up_to_date_count of this ProcessGroupEntity. - :rtype: int + :return: The process_group_update_strategy of this ProcessGroupEntity. + :rtype: str """ - return self._up_to_date_count + return self._process_group_update_strategy - @up_to_date_count.setter - def up_to_date_count(self, up_to_date_count): + @process_group_update_strategy.setter + def process_group_update_strategy(self, process_group_update_strategy): """ - Sets the up_to_date_count of this ProcessGroupEntity. - The number of up to date versioned process groups in the process group. + Sets the process_group_update_strategy of this ProcessGroupEntity. + Determines the process group update strategy - :param up_to_date_count: The up_to_date_count of this ProcessGroupEntity. - :type: int + :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) + ) - self._up_to_date_count = up_to_date_count + self._process_group_update_strategy = process_group_update_strategy @property - def locally_modified_count(self): + def public_input_port_count(self): """ - Gets the locally_modified_count of this ProcessGroupEntity. - The number of locally modified versioned process groups in the process group. + Gets the public_input_port_count of this ProcessGroupEntity. + The number of public input ports in the process group. - :return: The locally_modified_count of this ProcessGroupEntity. + :return: The public_input_port_count of this ProcessGroupEntity. :rtype: int """ - return self._locally_modified_count + return self._public_input_port_count - @locally_modified_count.setter - def locally_modified_count(self, locally_modified_count): + @public_input_port_count.setter + def public_input_port_count(self, public_input_port_count): """ - Sets the locally_modified_count of this ProcessGroupEntity. - The number of locally modified versioned process groups in the process group. + Sets the public_input_port_count of this ProcessGroupEntity. + The number of public input ports in the process group. - :param locally_modified_count: The locally_modified_count of this ProcessGroupEntity. + :param public_input_port_count: The public_input_port_count of this ProcessGroupEntity. :type: int """ - self._locally_modified_count = locally_modified_count + self._public_input_port_count = public_input_port_count @property - def stale_count(self): + def public_output_port_count(self): """ - Gets the stale_count of this ProcessGroupEntity. - The number of stale versioned process groups in the process group. + Gets the public_output_port_count of this ProcessGroupEntity. + The number of public output ports in the process group. - :return: The stale_count of this ProcessGroupEntity. + :return: The public_output_port_count of this ProcessGroupEntity. :rtype: int """ - return self._stale_count + return self._public_output_port_count - @stale_count.setter - def stale_count(self, stale_count): + @public_output_port_count.setter + def public_output_port_count(self, public_output_port_count): """ - Sets the stale_count of this ProcessGroupEntity. - The number of stale versioned process groups in the process group. + Sets the public_output_port_count of this ProcessGroupEntity. + The number of public output ports in the process group. - :param stale_count: The stale_count of this ProcessGroupEntity. + :param public_output_port_count: The public_output_port_count of this ProcessGroupEntity. :type: int """ - self._stale_count = stale_count + self._public_output_port_count = public_output_port_count @property - def locally_modified_and_stale_count(self): + def revision(self): """ - Gets the locally_modified_and_stale_count of this ProcessGroupEntity. - The number of locally modified and stale versioned process groups in the process group. + Gets the revision of this ProcessGroupEntity. - :return: The locally_modified_and_stale_count of this ProcessGroupEntity. - :rtype: int + :return: The revision of this ProcessGroupEntity. + :rtype: RevisionDTO """ - return self._locally_modified_and_stale_count + return self._revision - @locally_modified_and_stale_count.setter - def locally_modified_and_stale_count(self, locally_modified_and_stale_count): + @revision.setter + def revision(self, revision): """ - Sets the locally_modified_and_stale_count of this ProcessGroupEntity. - The number of locally modified and stale versioned process groups in the process group. + Sets the revision of this ProcessGroupEntity. - :param locally_modified_and_stale_count: The locally_modified_and_stale_count of this ProcessGroupEntity. - :type: int + :param revision: The revision of this ProcessGroupEntity. + :type: RevisionDTO """ - self._locally_modified_and_stale_count = locally_modified_and_stale_count + self._revision = revision @property - def sync_failure_count(self): + def running_count(self): """ - Gets the sync_failure_count of this ProcessGroupEntity. - The number of versioned process groups in the process group that are unable to sync to a registry. + Gets the running_count of this ProcessGroupEntity. + The number of running components in this process group. - :return: The sync_failure_count of this ProcessGroupEntity. + :return: The running_count of this ProcessGroupEntity. :rtype: int """ - return self._sync_failure_count + return self._running_count - @sync_failure_count.setter - def sync_failure_count(self, sync_failure_count): + @running_count.setter + def running_count(self, running_count): """ - Sets the sync_failure_count of this ProcessGroupEntity. - The number of versioned process groups in the process group that are unable to sync to a registry. + Sets the running_count of this ProcessGroupEntity. + The number of running components in this process group. - :param sync_failure_count: The sync_failure_count of this ProcessGroupEntity. + :param running_count: The running_count of this ProcessGroupEntity. :type: int """ - self._sync_failure_count = sync_failure_count + self._running_count = running_count @property - def local_input_port_count(self): + def stale_count(self): """ - Gets the local_input_port_count of this ProcessGroupEntity. - The number of local input ports in the process group. + Gets the stale_count of this ProcessGroupEntity. + The number of stale versioned process groups in the process group. - :return: The local_input_port_count of this ProcessGroupEntity. + :return: The stale_count of this ProcessGroupEntity. :rtype: int """ - return self._local_input_port_count + return self._stale_count - @local_input_port_count.setter - def local_input_port_count(self, local_input_port_count): + @stale_count.setter + def stale_count(self, stale_count): """ - Sets the local_input_port_count of this ProcessGroupEntity. - The number of local input ports in the process group. + Sets the stale_count of this ProcessGroupEntity. + The number of stale versioned process groups in the process group. - :param local_input_port_count: The local_input_port_count of this ProcessGroupEntity. + :param stale_count: The stale_count of this ProcessGroupEntity. :type: int """ - self._local_input_port_count = local_input_port_count + self._stale_count = stale_count @property - def local_output_port_count(self): + def status(self): """ - Gets the local_output_port_count of this ProcessGroupEntity. - The number of local output ports in the process group. + Gets the status of this ProcessGroupEntity. - :return: The local_output_port_count of this ProcessGroupEntity. - :rtype: int + :return: The status of this ProcessGroupEntity. + :rtype: ProcessGroupStatusDTO """ - return self._local_output_port_count + return self._status - @local_output_port_count.setter - def local_output_port_count(self, local_output_port_count): + @status.setter + def status(self, status): """ - Sets the local_output_port_count of this ProcessGroupEntity. - The number of local output ports in the process group. + Sets the status of this ProcessGroupEntity. - :param local_output_port_count: The local_output_port_count of this ProcessGroupEntity. - :type: int + :param status: The status of this ProcessGroupEntity. + :type: ProcessGroupStatusDTO """ - self._local_output_port_count = local_output_port_count + self._status = status @property - def public_input_port_count(self): + def stopped_count(self): """ - Gets the public_input_port_count of this ProcessGroupEntity. - The number of public input ports in the process group. + Gets the stopped_count of this ProcessGroupEntity. + The number of stopped components in the process group. - :return: The public_input_port_count of this ProcessGroupEntity. + :return: The stopped_count of this ProcessGroupEntity. :rtype: int """ - return self._public_input_port_count + return self._stopped_count - @public_input_port_count.setter - def public_input_port_count(self, public_input_port_count): + @stopped_count.setter + def stopped_count(self, stopped_count): """ - Sets the public_input_port_count of this ProcessGroupEntity. - The number of public input ports in the process group. + Sets the stopped_count of this ProcessGroupEntity. + The number of stopped components in the process group. - :param public_input_port_count: The public_input_port_count of this ProcessGroupEntity. + :param stopped_count: The stopped_count of this ProcessGroupEntity. :type: int """ - self._public_input_port_count = public_input_port_count + self._stopped_count = stopped_count @property - def public_output_port_count(self): + def sync_failure_count(self): """ - Gets the public_output_port_count of this ProcessGroupEntity. - The number of public output ports in the process group. + Gets the sync_failure_count of this ProcessGroupEntity. + The number of versioned process groups in the process group that are unable to sync to a registry. - :return: The public_output_port_count of this ProcessGroupEntity. + :return: The sync_failure_count of this ProcessGroupEntity. :rtype: int """ - return self._public_output_port_count + return self._sync_failure_count - @public_output_port_count.setter - def public_output_port_count(self, public_output_port_count): + @sync_failure_count.setter + def sync_failure_count(self, sync_failure_count): """ - Sets the public_output_port_count of this ProcessGroupEntity. - The number of public output ports in the process group. + Sets the sync_failure_count of this ProcessGroupEntity. + The number of versioned process groups in the process group that are unable to sync to a registry. - :param public_output_port_count: The public_output_port_count of this ProcessGroupEntity. + :param sync_failure_count: The sync_failure_count of this ProcessGroupEntity. :type: int """ - self._public_output_port_count = public_output_port_count + self._sync_failure_count = sync_failure_count @property - def parameter_context(self): + def up_to_date_count(self): """ - Gets the parameter_context of this ProcessGroupEntity. - The Parameter Context, or null if no Parameter Context has been bound to the Process Group + Gets the up_to_date_count of this ProcessGroupEntity. + The number of up to date versioned process groups in the process group. - :return: The parameter_context of this ProcessGroupEntity. - :rtype: ParameterContextReferenceEntity + :return: The up_to_date_count of this ProcessGroupEntity. + :rtype: int """ - return self._parameter_context + return self._up_to_date_count - @parameter_context.setter - def parameter_context(self, parameter_context): + @up_to_date_count.setter + def up_to_date_count(self, up_to_date_count): """ - Sets the parameter_context of this ProcessGroupEntity. - The Parameter Context, or null if no Parameter Context has been bound to the Process Group + Sets the up_to_date_count of this ProcessGroupEntity. + The number of up to date versioned process groups in the process group. - :param parameter_context: The parameter_context of this ProcessGroupEntity. - :type: ParameterContextReferenceEntity + :param up_to_date_count: The up_to_date_count of this ProcessGroupEntity. + :type: int """ - self._parameter_context = parameter_context + self._up_to_date_count = up_to_date_count @property - def process_group_update_strategy(self): + def uri(self): """ - Gets the process_group_update_strategy of this ProcessGroupEntity. - Determines the process group update strategy + Gets the uri of this ProcessGroupEntity. + The URI for futures requests to the component. - :return: The process_group_update_strategy of this ProcessGroupEntity. + :return: The uri of this ProcessGroupEntity. :rtype: str """ - return self._process_group_update_strategy + return self._uri - @process_group_update_strategy.setter - def process_group_update_strategy(self, process_group_update_strategy): + @uri.setter + def uri(self, uri): """ - Sets the process_group_update_strategy of this ProcessGroupEntity. - Determines the process group update strategy + Sets the uri of this ProcessGroupEntity. + The URI for futures requests to the component. - :param process_group_update_strategy: The process_group_update_strategy of this ProcessGroupEntity. + :param uri: The uri of this ProcessGroupEntity. :type: str """ - allowed_values = ["DIRECT_CHILDREN", "ALL_DESCENDANTS"] - 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 + self._uri = uri @property - def input_port_count(self): + def versioned_flow_snapshot(self): """ - Gets the input_port_count of this ProcessGroupEntity. - The number of input ports in the process group. + Gets the versioned_flow_snapshot of this ProcessGroupEntity. - :return: The input_port_count of this ProcessGroupEntity. - :rtype: int + :return: The versioned_flow_snapshot of this ProcessGroupEntity. + :rtype: RegisteredFlowSnapshot """ - return self._input_port_count + return self._versioned_flow_snapshot - @input_port_count.setter - def input_port_count(self, input_port_count): + @versioned_flow_snapshot.setter + def versioned_flow_snapshot(self, versioned_flow_snapshot): """ - Sets the input_port_count of this ProcessGroupEntity. - The number of input ports in the process group. + Sets the versioned_flow_snapshot of this ProcessGroupEntity. - :param input_port_count: The input_port_count of this ProcessGroupEntity. - :type: int + :param versioned_flow_snapshot: The versioned_flow_snapshot of this ProcessGroupEntity. + :type: RegisteredFlowSnapshot """ - self._input_port_count = input_port_count + self._versioned_flow_snapshot = versioned_flow_snapshot @property - def output_port_count(self): + def versioned_flow_state(self): """ - Gets the output_port_count of this ProcessGroupEntity. - The number of output ports in the process group. + Gets the versioned_flow_state of this ProcessGroupEntity. + The current state of the Process Group, as it relates to the Versioned Flow - :return: The output_port_count of this ProcessGroupEntity. - :rtype: int + :return: The versioned_flow_state of this ProcessGroupEntity. + :rtype: str """ - return self._output_port_count + return self._versioned_flow_state - @output_port_count.setter - def output_port_count(self, output_port_count): + @versioned_flow_state.setter + def versioned_flow_state(self, versioned_flow_state): """ - Sets the output_port_count of this ProcessGroupEntity. - The number of output ports in the process group. + Sets the versioned_flow_state of this ProcessGroupEntity. + The current state of the Process Group, as it relates to the Versioned Flow - :param output_port_count: The output_port_count of this ProcessGroupEntity. - :type: int + :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) + ) - self._output_port_count = output_port_count + self._versioned_flow_state = versioned_flow_state def to_dict(self): """ diff --git a/nipyapi/nifi/models/process_group_flow_dto.py b/nipyapi/nifi/models/process_group_flow_dto.py index eeb6dcf8..b29d5bd8 100644 --- a/nipyapi/nifi/models/process_group_flow_dto.py +++ b/nipyapi/nifi/models/process_group_flow_dto.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,52 +27,92 @@ class ProcessGroupFlowDTO(object): and the value is json key in definition. """ swagger_types = { - 'id': 'str', - 'uri': 'str', - 'parent_group_id': 'str', - 'parameter_context': 'ParameterContextReferenceEntity', 'breadcrumb': 'FlowBreadcrumbEntity', - 'flow': 'FlowDTO', - 'last_refreshed': 'str' - } +'flow': 'FlowDTO', +'id': 'str', +'last_refreshed': 'str', +'parameter_context': 'ParameterContextReferenceEntity', +'parent_group_id': 'str', +'uri': 'str' } attribute_map = { - 'id': 'id', - 'uri': 'uri', - 'parent_group_id': 'parentGroupId', - 'parameter_context': 'parameterContext', 'breadcrumb': 'breadcrumb', - 'flow': 'flow', - 'last_refreshed': 'lastRefreshed' - } +'flow': 'flow', +'id': 'id', +'last_refreshed': 'lastRefreshed', +'parameter_context': 'parameterContext', +'parent_group_id': 'parentGroupId', +'uri': 'uri' } - def __init__(self, id=None, uri=None, parent_group_id=None, parameter_context=None, breadcrumb=None, flow=None, last_refreshed=None): + def __init__(self, breadcrumb=None, flow=None, id=None, last_refreshed=None, parameter_context=None, parent_group_id=None, uri=None): """ ProcessGroupFlowDTO - a model defined in Swagger """ - self._id = None - self._uri = None - self._parent_group_id = None - self._parameter_context = None self._breadcrumb = None self._flow = None + self._id = None self._last_refreshed = None + self._parameter_context = None + self._parent_group_id = None + self._uri = None - if id is not None: - self.id = id - if uri is not None: - self.uri = uri - if parent_group_id is not None: - self.parent_group_id = parent_group_id - if parameter_context is not None: - self.parameter_context = parameter_context if breadcrumb is not None: self.breadcrumb = breadcrumb if flow is not None: self.flow = flow + if id is not None: + self.id = id if last_refreshed is not None: self.last_refreshed = last_refreshed + if parameter_context is not None: + self.parameter_context = parameter_context + if parent_group_id is not None: + self.parent_group_id = parent_group_id + if uri is not None: + self.uri = uri + + @property + def breadcrumb(self): + """ + Gets the breadcrumb of this ProcessGroupFlowDTO. + + :return: The breadcrumb of this ProcessGroupFlowDTO. + :rtype: FlowBreadcrumbEntity + """ + return self._breadcrumb + + @breadcrumb.setter + def breadcrumb(self, breadcrumb): + """ + Sets the breadcrumb of this ProcessGroupFlowDTO. + + :param breadcrumb: The breadcrumb of this ProcessGroupFlowDTO. + :type: FlowBreadcrumbEntity + """ + + self._breadcrumb = breadcrumb + + @property + def flow(self): + """ + Gets the flow of this ProcessGroupFlowDTO. + + :return: The flow of this ProcessGroupFlowDTO. + :rtype: FlowDTO + """ + return self._flow + + @flow.setter + def flow(self, flow): + """ + Sets the flow of this ProcessGroupFlowDTO. + + :param flow: The flow of this ProcessGroupFlowDTO. + :type: FlowDTO + """ + + self._flow = flow @property def id(self): @@ -99,56 +138,32 @@ def id(self, id): self._id = id @property - def uri(self): - """ - Gets the uri of this ProcessGroupFlowDTO. - The URI for futures requests to the component. - - :return: The uri of this ProcessGroupFlowDTO. - :rtype: str - """ - return self._uri - - @uri.setter - def uri(self, uri): - """ - Sets the uri of this ProcessGroupFlowDTO. - The URI for futures requests to the component. - - :param uri: The uri of this ProcessGroupFlowDTO. - :type: str - """ - - self._uri = uri - - @property - def parent_group_id(self): + def last_refreshed(self): """ - Gets the parent_group_id of this ProcessGroupFlowDTO. - The id of parent process group of this component if applicable. + Gets the last_refreshed of this ProcessGroupFlowDTO. + The time the flow for the process group was last refreshed. - :return: The parent_group_id of this ProcessGroupFlowDTO. + :return: The last_refreshed of this ProcessGroupFlowDTO. :rtype: str """ - return self._parent_group_id + return self._last_refreshed - @parent_group_id.setter - def parent_group_id(self, parent_group_id): + @last_refreshed.setter + def last_refreshed(self, last_refreshed): """ - Sets the parent_group_id of this ProcessGroupFlowDTO. - The id of parent process group of this component if applicable. + Sets the last_refreshed of this ProcessGroupFlowDTO. + The time the flow for the process group was last refreshed. - :param parent_group_id: The parent_group_id of this ProcessGroupFlowDTO. + :param last_refreshed: The last_refreshed of this ProcessGroupFlowDTO. :type: str """ - self._parent_group_id = parent_group_id + self._last_refreshed = last_refreshed @property def parameter_context(self): """ Gets the parameter_context of this ProcessGroupFlowDTO. - The Parameter Context, or null if no Parameter Context has been bound to the Process Group :return: The parameter_context of this ProcessGroupFlowDTO. :rtype: ParameterContextReferenceEntity @@ -159,7 +174,6 @@ def parameter_context(self): def parameter_context(self, parameter_context): """ Sets the parameter_context of this ProcessGroupFlowDTO. - The Parameter Context, or null if no Parameter Context has been bound to the Process Group :param parameter_context: The parameter_context of this ProcessGroupFlowDTO. :type: ParameterContextReferenceEntity @@ -168,73 +182,50 @@ def parameter_context(self, parameter_context): self._parameter_context = parameter_context @property - def breadcrumb(self): - """ - Gets the breadcrumb of this ProcessGroupFlowDTO. - The breadcrumb of the process group. - - :return: The breadcrumb of this ProcessGroupFlowDTO. - :rtype: FlowBreadcrumbEntity - """ - return self._breadcrumb - - @breadcrumb.setter - def breadcrumb(self, breadcrumb): - """ - Sets the breadcrumb of this ProcessGroupFlowDTO. - The breadcrumb of the process group. - - :param breadcrumb: The breadcrumb of this ProcessGroupFlowDTO. - :type: FlowBreadcrumbEntity - """ - - self._breadcrumb = breadcrumb - - @property - def flow(self): + def parent_group_id(self): """ - Gets the flow of this ProcessGroupFlowDTO. - The flow structure starting at this Process Group. + Gets the parent_group_id of this ProcessGroupFlowDTO. + The id of parent process group of this component if applicable. - :return: The flow of this ProcessGroupFlowDTO. - :rtype: FlowDTO + :return: The parent_group_id of this ProcessGroupFlowDTO. + :rtype: str """ - return self._flow + return self._parent_group_id - @flow.setter - def flow(self, flow): + @parent_group_id.setter + def parent_group_id(self, parent_group_id): """ - Sets the flow of this ProcessGroupFlowDTO. - The flow structure starting at this Process Group. + Sets the parent_group_id of this ProcessGroupFlowDTO. + The id of parent process group of this component if applicable. - :param flow: The flow of this ProcessGroupFlowDTO. - :type: FlowDTO + :param parent_group_id: The parent_group_id of this ProcessGroupFlowDTO. + :type: str """ - self._flow = flow + self._parent_group_id = parent_group_id @property - def last_refreshed(self): + def uri(self): """ - Gets the last_refreshed of this ProcessGroupFlowDTO. - The time the flow for the process group was last refreshed. + Gets the uri of this ProcessGroupFlowDTO. + The URI for futures requests to the component. - :return: The last_refreshed of this ProcessGroupFlowDTO. + :return: The uri of this ProcessGroupFlowDTO. :rtype: str """ - return self._last_refreshed + return self._uri - @last_refreshed.setter - def last_refreshed(self, last_refreshed): + @uri.setter + def uri(self, uri): """ - Sets the last_refreshed of this ProcessGroupFlowDTO. - The time the flow for the process group was last refreshed. + Sets the uri of this ProcessGroupFlowDTO. + The URI for futures requests to the component. - :param last_refreshed: The last_refreshed of this ProcessGroupFlowDTO. + :param uri: The uri of this ProcessGroupFlowDTO. :type: str """ - self._last_refreshed = last_refreshed + self._uri = uri def to_dict(self): """ diff --git a/nipyapi/nifi/models/process_group_flow_entity.py b/nipyapi/nifi/models/process_group_flow_entity.py index f1685b9a..2b18474b 100644 --- a/nipyapi/nifi/models/process_group_flow_entity.py +++ b/nipyapi/nifi/models/process_group_flow_entity.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -29,32 +28,34 @@ class ProcessGroupFlowEntity(object): """ swagger_types = { 'permissions': 'PermissionsDTO', - 'process_group_flow': 'ProcessGroupFlowDTO' - } +'process_group_flow': 'ProcessGroupFlowDTO', +'revision': 'RevisionDTO' } attribute_map = { 'permissions': 'permissions', - 'process_group_flow': 'processGroupFlow' - } +'process_group_flow': 'processGroupFlow', +'revision': 'revision' } - def __init__(self, permissions=None, process_group_flow=None): + def __init__(self, permissions=None, process_group_flow=None, revision=None): """ ProcessGroupFlowEntity - a model defined in Swagger """ self._permissions = None self._process_group_flow = None + self._revision = None if permissions is not None: self.permissions = permissions if process_group_flow is not None: self.process_group_flow = process_group_flow + if revision is not None: + self.revision = revision @property def permissions(self): """ Gets the permissions of this ProcessGroupFlowEntity. - The access policy for this process group. :return: The permissions of this ProcessGroupFlowEntity. :rtype: PermissionsDTO @@ -65,7 +66,6 @@ def permissions(self): def permissions(self, permissions): """ Sets the permissions of this ProcessGroupFlowEntity. - The access policy for this process group. :param permissions: The permissions of this ProcessGroupFlowEntity. :type: PermissionsDTO @@ -94,6 +94,27 @@ def process_group_flow(self, process_group_flow): self._process_group_flow = process_group_flow + @property + def revision(self): + """ + Gets the revision of this ProcessGroupFlowEntity. + + :return: The revision of this ProcessGroupFlowEntity. + :rtype: RevisionDTO + """ + return self._revision + + @revision.setter + def revision(self, revision): + """ + Sets the revision of this ProcessGroupFlowEntity. + + :param revision: The revision of this ProcessGroupFlowEntity. + :type: RevisionDTO + """ + + self._revision = revision + def to_dict(self): """ Returns the model properties as a dict diff --git a/nipyapi/nifi/models/process_group_import_entity.py b/nipyapi/nifi/models/process_group_import_entity.py index 32e3a161..f03409f6 100644 --- a/nipyapi/nifi/models/process_group_import_entity.py +++ b/nipyapi/nifi/models/process_group_import_entity.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,56 +27,31 @@ class ProcessGroupImportEntity(object): and the value is json key in definition. """ swagger_types = { - 'process_group_revision': 'RevisionDTO', 'disconnected_node_acknowledged': 'bool', - 'versioned_flow_snapshot': 'RegisteredFlowSnapshot' - } +'process_group_revision': 'RevisionDTO', +'versioned_flow_snapshot': 'RegisteredFlowSnapshot' } attribute_map = { - 'process_group_revision': 'processGroupRevision', 'disconnected_node_acknowledged': 'disconnectedNodeAcknowledged', - 'versioned_flow_snapshot': 'versionedFlowSnapshot' - } +'process_group_revision': 'processGroupRevision', +'versioned_flow_snapshot': 'versionedFlowSnapshot' } - def __init__(self, process_group_revision=None, disconnected_node_acknowledged=None, versioned_flow_snapshot=None): + def __init__(self, disconnected_node_acknowledged=None, process_group_revision=None, versioned_flow_snapshot=None): """ ProcessGroupImportEntity - a model defined in Swagger """ - self._process_group_revision = None self._disconnected_node_acknowledged = None + self._process_group_revision = None self._versioned_flow_snapshot = None - if process_group_revision is not None: - self.process_group_revision = process_group_revision if disconnected_node_acknowledged is not None: self.disconnected_node_acknowledged = disconnected_node_acknowledged + if process_group_revision is not None: + self.process_group_revision = process_group_revision if versioned_flow_snapshot is not None: self.versioned_flow_snapshot = versioned_flow_snapshot - @property - def process_group_revision(self): - """ - Gets the process_group_revision of this ProcessGroupImportEntity. - The Revision for the Process Group - - :return: The process_group_revision of this ProcessGroupImportEntity. - :rtype: RevisionDTO - """ - return self._process_group_revision - - @process_group_revision.setter - def process_group_revision(self, process_group_revision): - """ - Sets the process_group_revision of this ProcessGroupImportEntity. - The Revision for the Process Group - - :param process_group_revision: The process_group_revision of this ProcessGroupImportEntity. - :type: RevisionDTO - """ - - self._process_group_revision = process_group_revision - @property def disconnected_node_acknowledged(self): """ @@ -101,11 +75,31 @@ def disconnected_node_acknowledged(self, disconnected_node_acknowledged): self._disconnected_node_acknowledged = disconnected_node_acknowledged + @property + def process_group_revision(self): + """ + Gets the process_group_revision of this ProcessGroupImportEntity. + + :return: The process_group_revision of this ProcessGroupImportEntity. + :rtype: RevisionDTO + """ + return self._process_group_revision + + @process_group_revision.setter + def process_group_revision(self, process_group_revision): + """ + Sets the process_group_revision of this ProcessGroupImportEntity. + + :param process_group_revision: The process_group_revision of this ProcessGroupImportEntity. + :type: RevisionDTO + """ + + self._process_group_revision = process_group_revision + @property def versioned_flow_snapshot(self): """ Gets the versioned_flow_snapshot of this ProcessGroupImportEntity. - The Versioned Flow Snapshot to import :return: The versioned_flow_snapshot of this ProcessGroupImportEntity. :rtype: RegisteredFlowSnapshot @@ -116,7 +110,6 @@ def versioned_flow_snapshot(self): def versioned_flow_snapshot(self, versioned_flow_snapshot): """ Sets the versioned_flow_snapshot of this ProcessGroupImportEntity. - The Versioned Flow Snapshot to import :param versioned_flow_snapshot: The versioned_flow_snapshot of this ProcessGroupImportEntity. :type: RegisteredFlowSnapshot diff --git a/nipyapi/nifi/models/process_group_name_dto.py b/nipyapi/nifi/models/process_group_name_dto.py index dce9b44d..9bbb1e24 100644 --- a/nipyapi/nifi/models/process_group_name_dto.py +++ b/nipyapi/nifi/models/process_group_name_dto.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -29,13 +28,11 @@ class ProcessGroupNameDTO(object): """ swagger_types = { 'id': 'str', - 'name': 'str' - } +'name': 'str' } attribute_map = { 'id': 'id', - 'name': 'name' - } +'name': 'name' } def __init__(self, id=None, name=None): """ diff --git a/nipyapi/nifi/models/process_group_replace_request_dto.py b/nipyapi/nifi/models/process_group_replace_request_dto.py index 387fa018..379d1656 100644 --- a/nipyapi/nifi/models/process_group_replace_request_dto.py +++ b/nipyapi/nifi/models/process_group_replace_request_dto.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,126 +27,101 @@ class ProcessGroupReplaceRequestDTO(object): and the value is json key in definition. """ swagger_types = { - 'request_id': 'str', - 'process_group_id': 'str', - 'uri': 'str', - 'last_updated': 'str', 'complete': 'bool', - 'failure_reason': 'str', - 'percent_completed': 'int', - 'state': 'str' - } +'failure_reason': 'str', +'last_updated': 'str', +'percent_completed': 'int', +'process_group_id': 'str', +'request_id': 'str', +'state': 'str', +'uri': 'str' } attribute_map = { - 'request_id': 'requestId', - 'process_group_id': 'processGroupId', - 'uri': 'uri', - 'last_updated': 'lastUpdated', 'complete': 'complete', - 'failure_reason': 'failureReason', - 'percent_completed': 'percentCompleted', - 'state': 'state' - } +'failure_reason': 'failureReason', +'last_updated': 'lastUpdated', +'percent_completed': 'percentCompleted', +'process_group_id': 'processGroupId', +'request_id': 'requestId', +'state': 'state', +'uri': 'uri' } - def __init__(self, request_id=None, process_group_id=None, uri=None, last_updated=None, complete=None, failure_reason=None, percent_completed=None, state=None): + def __init__(self, complete=None, failure_reason=None, last_updated=None, percent_completed=None, process_group_id=None, request_id=None, state=None, uri=None): """ ProcessGroupReplaceRequestDTO - a model defined in Swagger """ - self._request_id = None - self._process_group_id = None - self._uri = None - self._last_updated = None self._complete = None self._failure_reason = None + self._last_updated = None self._percent_completed = None + self._process_group_id = None + self._request_id = None self._state = None + self._uri = None - if request_id is not None: - self.request_id = request_id - if process_group_id is not None: - self.process_group_id = process_group_id - if uri is not None: - self.uri = uri - if last_updated is not None: - self.last_updated = last_updated if complete is not None: self.complete = complete if failure_reason is not None: self.failure_reason = failure_reason + if last_updated is not None: + self.last_updated = last_updated if percent_completed is not None: self.percent_completed = percent_completed + if process_group_id is not None: + self.process_group_id = process_group_id + if request_id is not None: + self.request_id = request_id if state is not None: self.state = state + if uri is not None: + self.uri = uri @property - def request_id(self): - """ - Gets the request_id of this ProcessGroupReplaceRequestDTO. - The unique ID of this request. - - :return: The request_id of this ProcessGroupReplaceRequestDTO. - :rtype: str - """ - return self._request_id - - @request_id.setter - def request_id(self, request_id): - """ - Sets the request_id of this ProcessGroupReplaceRequestDTO. - The unique ID of this request. - - :param request_id: The request_id of this ProcessGroupReplaceRequestDTO. - :type: str - """ - - self._request_id = request_id - - @property - def process_group_id(self): + def complete(self): """ - Gets the process_group_id of this ProcessGroupReplaceRequestDTO. - The unique ID of the Process Group being updated + Gets the complete of this ProcessGroupReplaceRequestDTO. + Whether or not this request has completed - :return: The process_group_id of this ProcessGroupReplaceRequestDTO. - :rtype: str + :return: The complete of this ProcessGroupReplaceRequestDTO. + :rtype: bool """ - return self._process_group_id + return self._complete - @process_group_id.setter - def process_group_id(self, process_group_id): + @complete.setter + def complete(self, complete): """ - Sets the process_group_id of this ProcessGroupReplaceRequestDTO. - The unique ID of the Process Group being updated + Sets the complete of this ProcessGroupReplaceRequestDTO. + Whether or not this request has completed - :param process_group_id: The process_group_id of this ProcessGroupReplaceRequestDTO. - :type: str + :param complete: The complete of this ProcessGroupReplaceRequestDTO. + :type: bool """ - self._process_group_id = process_group_id + self._complete = complete @property - def uri(self): + def failure_reason(self): """ - Gets the uri of this ProcessGroupReplaceRequestDTO. - The URI for future requests to this drop request. + Gets the failure_reason of this ProcessGroupReplaceRequestDTO. + An explanation of why this request failed, or null if this request has not failed - :return: The uri of this ProcessGroupReplaceRequestDTO. + :return: The failure_reason of this ProcessGroupReplaceRequestDTO. :rtype: str """ - return self._uri + return self._failure_reason - @uri.setter - def uri(self, uri): + @failure_reason.setter + def failure_reason(self, failure_reason): """ - Sets the uri of this ProcessGroupReplaceRequestDTO. - The URI for future requests to this drop request. + Sets the failure_reason of this ProcessGroupReplaceRequestDTO. + An explanation of why this request failed, or null if this request has not failed - :param uri: The uri of this ProcessGroupReplaceRequestDTO. + :param failure_reason: The failure_reason of this ProcessGroupReplaceRequestDTO. :type: str """ - self._uri = uri + self._failure_reason = failure_reason @property def last_updated(self): @@ -173,73 +147,73 @@ def last_updated(self, last_updated): self._last_updated = last_updated @property - def complete(self): + def percent_completed(self): """ - Gets the complete of this ProcessGroupReplaceRequestDTO. - Whether or not this request has completed + Gets the percent_completed of this ProcessGroupReplaceRequestDTO. + The percentage complete for the request, between 0 and 100 - :return: The complete of this ProcessGroupReplaceRequestDTO. - :rtype: bool + :return: The percent_completed of this ProcessGroupReplaceRequestDTO. + :rtype: int """ - return self._complete + return self._percent_completed - @complete.setter - def complete(self, complete): + @percent_completed.setter + def percent_completed(self, percent_completed): """ - Sets the complete of this ProcessGroupReplaceRequestDTO. - Whether or not this request has completed + Sets the percent_completed of this ProcessGroupReplaceRequestDTO. + The percentage complete for the request, between 0 and 100 - :param complete: The complete of this ProcessGroupReplaceRequestDTO. - :type: bool + :param percent_completed: The percent_completed of this ProcessGroupReplaceRequestDTO. + :type: int """ - self._complete = complete + self._percent_completed = percent_completed @property - def failure_reason(self): + def process_group_id(self): """ - Gets the failure_reason of this ProcessGroupReplaceRequestDTO. - An explanation of why this request failed, or null if this request has not failed + Gets the process_group_id of this ProcessGroupReplaceRequestDTO. + The unique ID of the Process Group being updated - :return: The failure_reason of this ProcessGroupReplaceRequestDTO. + :return: The process_group_id of this ProcessGroupReplaceRequestDTO. :rtype: str """ - return self._failure_reason + return self._process_group_id - @failure_reason.setter - def failure_reason(self, failure_reason): + @process_group_id.setter + def process_group_id(self, process_group_id): """ - Sets the failure_reason of this ProcessGroupReplaceRequestDTO. - An explanation of why this request failed, or null if this request has not failed + Sets the process_group_id of this ProcessGroupReplaceRequestDTO. + The unique ID of the Process Group being updated - :param failure_reason: The failure_reason of this ProcessGroupReplaceRequestDTO. + :param process_group_id: The process_group_id of this ProcessGroupReplaceRequestDTO. :type: str """ - self._failure_reason = failure_reason + self._process_group_id = process_group_id @property - def percent_completed(self): + def request_id(self): """ - Gets the percent_completed of this ProcessGroupReplaceRequestDTO. - The percentage complete for the request, between 0 and 100 + Gets the request_id of this ProcessGroupReplaceRequestDTO. + The unique ID of this request. - :return: The percent_completed of this ProcessGroupReplaceRequestDTO. - :rtype: int + :return: The request_id of this ProcessGroupReplaceRequestDTO. + :rtype: str """ - return self._percent_completed + return self._request_id - @percent_completed.setter - def percent_completed(self, percent_completed): + @request_id.setter + def request_id(self, request_id): """ - Sets the percent_completed of this ProcessGroupReplaceRequestDTO. - The percentage complete for the request, between 0 and 100 + Sets the request_id of this ProcessGroupReplaceRequestDTO. + The unique ID of this request. - :param percent_completed: The percent_completed of this ProcessGroupReplaceRequestDTO. - :type: int + :param request_id: The request_id of this ProcessGroupReplaceRequestDTO. + :type: str """ - self._percent_completed = percent_completed + self._request_id = request_id @property def state(self): @@ -264,6 +238,29 @@ def state(self, state): self._state = state + @property + def uri(self): + """ + Gets the uri of this ProcessGroupReplaceRequestDTO. + The URI for future requests to this drop request. + + :return: The uri of this ProcessGroupReplaceRequestDTO. + :rtype: str + """ + return self._uri + + @uri.setter + def uri(self, uri): + """ + Sets the uri of this ProcessGroupReplaceRequestDTO. + The URI for future requests to this drop request. + + :param uri: The uri of this ProcessGroupReplaceRequestDTO. + :type: str + """ + + self._uri = uri + def to_dict(self): """ Returns the model properties as a dict diff --git a/nipyapi/nifi/models/process_group_replace_request_entity.py b/nipyapi/nifi/models/process_group_replace_request_entity.py index cb780265..0ff2d2b4 100644 --- a/nipyapi/nifi/models/process_group_replace_request_entity.py +++ b/nipyapi/nifi/models/process_group_replace_request_entity.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -29,15 +28,13 @@ class ProcessGroupReplaceRequestEntity(object): """ swagger_types = { 'process_group_revision': 'RevisionDTO', - 'request': 'ProcessGroupReplaceRequestDTO', - 'versioned_flow_snapshot': 'RegisteredFlowSnapshot' - } +'request': 'ProcessGroupReplaceRequestDTO', +'versioned_flow_snapshot': 'RegisteredFlowSnapshot' } attribute_map = { 'process_group_revision': 'processGroupRevision', - 'request': 'request', - 'versioned_flow_snapshot': 'versionedFlowSnapshot' - } +'request': 'request', +'versioned_flow_snapshot': 'versionedFlowSnapshot' } def __init__(self, process_group_revision=None, request=None, versioned_flow_snapshot=None): """ @@ -59,7 +56,6 @@ def __init__(self, process_group_revision=None, request=None, versioned_flow_sna def process_group_revision(self): """ Gets the process_group_revision of this ProcessGroupReplaceRequestEntity. - The revision for the Process Group being updated. :return: The process_group_revision of this ProcessGroupReplaceRequestEntity. :rtype: RevisionDTO @@ -70,7 +66,6 @@ def process_group_revision(self): def process_group_revision(self, process_group_revision): """ Sets the process_group_revision of this ProcessGroupReplaceRequestEntity. - The revision for the Process Group being updated. :param process_group_revision: The process_group_revision of this ProcessGroupReplaceRequestEntity. :type: RevisionDTO @@ -82,7 +77,6 @@ def process_group_revision(self, process_group_revision): def request(self): """ Gets the request of this ProcessGroupReplaceRequestEntity. - The Process Group Change Request :return: The request of this ProcessGroupReplaceRequestEntity. :rtype: ProcessGroupReplaceRequestDTO @@ -93,7 +87,6 @@ def request(self): def request(self, request): """ Sets the request of this ProcessGroupReplaceRequestEntity. - The Process Group Change Request :param request: The request of this ProcessGroupReplaceRequestEntity. :type: ProcessGroupReplaceRequestDTO @@ -105,7 +98,6 @@ def request(self, request): def versioned_flow_snapshot(self): """ Gets the versioned_flow_snapshot of this ProcessGroupReplaceRequestEntity. - Returns the Versioned Flow to replace with :return: The versioned_flow_snapshot of this ProcessGroupReplaceRequestEntity. :rtype: RegisteredFlowSnapshot @@ -116,7 +108,6 @@ def versioned_flow_snapshot(self): def versioned_flow_snapshot(self, versioned_flow_snapshot): """ Sets the versioned_flow_snapshot of this ProcessGroupReplaceRequestEntity. - Returns the Versioned Flow to replace with :param versioned_flow_snapshot: The versioned_flow_snapshot of this ProcessGroupReplaceRequestEntity. :type: RegisteredFlowSnapshot diff --git a/nipyapi/nifi/models/process_group_status_dto.py b/nipyapi/nifi/models/process_group_status_dto.py index a45b8ac1..69d3f3ac 100644 --- a/nipyapi/nifi/models/process_group_status_dto.py +++ b/nipyapi/nifi/models/process_group_status_dto.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,42 +27,61 @@ class ProcessGroupStatusDTO(object): and the value is json key in definition. """ swagger_types = { - 'id': 'str', - 'name': 'str', - 'stats_last_refreshed': 'str', 'aggregate_snapshot': 'ProcessGroupStatusSnapshotDTO', - 'node_snapshots': 'list[NodeProcessGroupStatusSnapshotDTO]' - } +'id': 'str', +'name': 'str', +'node_snapshots': 'list[NodeProcessGroupStatusSnapshotDTO]', +'stats_last_refreshed': 'str' } attribute_map = { - 'id': 'id', - 'name': 'name', - 'stats_last_refreshed': 'statsLastRefreshed', 'aggregate_snapshot': 'aggregateSnapshot', - 'node_snapshots': 'nodeSnapshots' - } +'id': 'id', +'name': 'name', +'node_snapshots': 'nodeSnapshots', +'stats_last_refreshed': 'statsLastRefreshed' } - def __init__(self, id=None, name=None, stats_last_refreshed=None, aggregate_snapshot=None, node_snapshots=None): + def __init__(self, aggregate_snapshot=None, id=None, name=None, node_snapshots=None, stats_last_refreshed=None): """ ProcessGroupStatusDTO - a model defined in Swagger """ + self._aggregate_snapshot = None self._id = None self._name = None - self._stats_last_refreshed = None - self._aggregate_snapshot = None self._node_snapshots = None + self._stats_last_refreshed = None + if aggregate_snapshot is not None: + self.aggregate_snapshot = aggregate_snapshot if id is not None: self.id = id if name is not None: self.name = name - if stats_last_refreshed is not None: - self.stats_last_refreshed = stats_last_refreshed - if aggregate_snapshot is not None: - self.aggregate_snapshot = aggregate_snapshot if node_snapshots is not None: self.node_snapshots = node_snapshots + if stats_last_refreshed is not None: + self.stats_last_refreshed = stats_last_refreshed + + @property + def aggregate_snapshot(self): + """ + Gets the aggregate_snapshot of this ProcessGroupStatusDTO. + + :return: The aggregate_snapshot of this ProcessGroupStatusDTO. + :rtype: ProcessGroupStatusSnapshotDTO + """ + return self._aggregate_snapshot + + @aggregate_snapshot.setter + def aggregate_snapshot(self, aggregate_snapshot): + """ + Sets the aggregate_snapshot of this ProcessGroupStatusDTO. + + :param aggregate_snapshot: The aggregate_snapshot of this ProcessGroupStatusDTO. + :type: ProcessGroupStatusSnapshotDTO + """ + + self._aggregate_snapshot = aggregate_snapshot @property def id(self): @@ -111,52 +129,6 @@ def name(self, name): self._name = name - @property - def stats_last_refreshed(self): - """ - Gets the stats_last_refreshed of this ProcessGroupStatusDTO. - The time the status for the process group was last refreshed. - - :return: The stats_last_refreshed of this ProcessGroupStatusDTO. - :rtype: str - """ - return self._stats_last_refreshed - - @stats_last_refreshed.setter - def stats_last_refreshed(self, stats_last_refreshed): - """ - Sets the stats_last_refreshed of this ProcessGroupStatusDTO. - The time the status for the process group was last refreshed. - - :param stats_last_refreshed: The stats_last_refreshed of this ProcessGroupStatusDTO. - :type: str - """ - - self._stats_last_refreshed = stats_last_refreshed - - @property - def aggregate_snapshot(self): - """ - Gets the aggregate_snapshot of this ProcessGroupStatusDTO. - The aggregate status of all nodes in the cluster - - :return: The aggregate_snapshot of this ProcessGroupStatusDTO. - :rtype: ProcessGroupStatusSnapshotDTO - """ - return self._aggregate_snapshot - - @aggregate_snapshot.setter - def aggregate_snapshot(self, aggregate_snapshot): - """ - Sets the aggregate_snapshot of this ProcessGroupStatusDTO. - The aggregate status of all nodes in the cluster - - :param aggregate_snapshot: The aggregate_snapshot of this ProcessGroupStatusDTO. - :type: ProcessGroupStatusSnapshotDTO - """ - - self._aggregate_snapshot = aggregate_snapshot - @property def node_snapshots(self): """ @@ -180,6 +152,29 @@ def node_snapshots(self, node_snapshots): self._node_snapshots = node_snapshots + @property + def stats_last_refreshed(self): + """ + Gets the stats_last_refreshed of this ProcessGroupStatusDTO. + The time the status for the process group was last refreshed. + + :return: The stats_last_refreshed of this ProcessGroupStatusDTO. + :rtype: str + """ + return self._stats_last_refreshed + + @stats_last_refreshed.setter + def stats_last_refreshed(self, stats_last_refreshed): + """ + Sets the stats_last_refreshed of this ProcessGroupStatusDTO. + The time the status for the process group was last refreshed. + + :param stats_last_refreshed: The stats_last_refreshed of this ProcessGroupStatusDTO. + :type: str + """ + + self._stats_last_refreshed = stats_last_refreshed + def to_dict(self): """ Returns the model properties as a dict diff --git a/nipyapi/nifi/models/process_group_status_entity.py b/nipyapi/nifi/models/process_group_status_entity.py index 6c4058e7..0bd2a064 100644 --- a/nipyapi/nifi/models/process_group_status_entity.py +++ b/nipyapi/nifi/models/process_group_status_entity.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,48 +27,25 @@ class ProcessGroupStatusEntity(object): and the value is json key in definition. """ swagger_types = { - 'process_group_status': 'ProcessGroupStatusDTO', - 'can_read': 'bool' - } + 'can_read': 'bool', +'process_group_status': 'ProcessGroupStatusDTO' } attribute_map = { - 'process_group_status': 'processGroupStatus', - 'can_read': 'canRead' - } + 'can_read': 'canRead', +'process_group_status': 'processGroupStatus' } - def __init__(self, process_group_status=None, can_read=None): + def __init__(self, can_read=None, process_group_status=None): """ ProcessGroupStatusEntity - a model defined in Swagger """ - self._process_group_status = None self._can_read = None + self._process_group_status = None - if process_group_status is not None: - self.process_group_status = process_group_status if can_read is not None: self.can_read = can_read - - @property - def process_group_status(self): - """ - Gets the process_group_status of this ProcessGroupStatusEntity. - - :return: The process_group_status of this ProcessGroupStatusEntity. - :rtype: ProcessGroupStatusDTO - """ - return self._process_group_status - - @process_group_status.setter - def process_group_status(self, process_group_status): - """ - Sets the process_group_status of this ProcessGroupStatusEntity. - - :param process_group_status: The process_group_status of this ProcessGroupStatusEntity. - :type: ProcessGroupStatusDTO - """ - - self._process_group_status = process_group_status + if process_group_status is not None: + self.process_group_status = process_group_status @property def can_read(self): @@ -94,6 +70,27 @@ def can_read(self, can_read): self._can_read = can_read + @property + def process_group_status(self): + """ + Gets the process_group_status of this ProcessGroupStatusEntity. + + :return: The process_group_status of this ProcessGroupStatusEntity. + :rtype: ProcessGroupStatusDTO + """ + return self._process_group_status + + @process_group_status.setter + def process_group_status(self, process_group_status): + """ + Sets the process_group_status of this ProcessGroupStatusEntity. + + :param process_group_status: The process_group_status of this ProcessGroupStatusEntity. + :type: ProcessGroupStatusDTO + """ + + self._process_group_status = process_group_status + def to_dict(self): """ Returns the model properties as a dict diff --git a/nipyapi/nifi/models/process_group_status_snapshot_dto.py b/nipyapi/nifi/models/process_group_status_snapshot_dto.py index 4c257752..2d06c3f2 100644 --- a/nipyapi/nifi/models/process_group_status_snapshot_dto.py +++ b/nipyapi/nifi/models/process_group_status_snapshot_dto.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,415 +27,435 @@ class ProcessGroupStatusSnapshotDTO(object): and the value is json key in definition. """ swagger_types = { - 'id': 'str', - 'name': 'str', - 'connection_status_snapshots': 'list[ConnectionStatusSnapshotEntity]', - 'processor_status_snapshots': 'list[ProcessorStatusSnapshotEntity]', - 'process_group_status_snapshots': 'list[ProcessGroupStatusSnapshotEntity]', - 'remote_process_group_status_snapshots': 'list[RemoteProcessGroupStatusSnapshotEntity]', - 'input_port_status_snapshots': 'list[PortStatusSnapshotEntity]', - 'output_port_status_snapshots': 'list[PortStatusSnapshotEntity]', - 'versioned_flow_state': 'str', - 'flow_files_in': 'int', - 'bytes_in': 'int', - 'input': 'str', - 'flow_files_queued': 'int', - 'bytes_queued': 'int', - 'queued': 'str', - 'queued_count': 'str', - 'queued_size': 'str', - 'bytes_read': 'int', - 'read': 'str', - 'bytes_written': 'int', - 'written': 'str', - 'flow_files_out': 'int', - 'bytes_out': 'int', - 'output': 'str', - 'flow_files_transferred': 'int', - 'bytes_transferred': 'int', - 'transferred': 'str', - 'bytes_received': 'int', - 'flow_files_received': 'int', - 'received': 'str', - 'bytes_sent': 'int', - 'flow_files_sent': 'int', - 'sent': 'str', 'active_thread_count': 'int', - 'terminated_thread_count': 'int', - 'processing_nanos': 'int', - 'processing_performance_status': 'ProcessingPerformanceStatusDTO' - } +'bytes_in': 'int', +'bytes_out': 'int', +'bytes_queued': 'int', +'bytes_read': 'int', +'bytes_received': 'int', +'bytes_sent': 'int', +'bytes_transferred': 'int', +'bytes_written': 'int', +'connection_status_snapshots': 'list[ConnectionStatusSnapshotEntity]', +'flow_files_in': 'int', +'flow_files_out': 'int', +'flow_files_queued': 'int', +'flow_files_received': 'int', +'flow_files_sent': 'int', +'flow_files_transferred': 'int', +'id': 'str', +'input': 'str', +'input_port_status_snapshots': 'list[PortStatusSnapshotEntity]', +'name': 'str', +'output': 'str', +'output_port_status_snapshots': 'list[PortStatusSnapshotEntity]', +'process_group_status_snapshots': 'list[ProcessGroupStatusSnapshotEntity]', +'processing_nanos': 'int', +'processing_performance_status': 'ProcessingPerformanceStatusDTO', +'processor_status_snapshots': 'list[ProcessorStatusSnapshotEntity]', +'queued': 'str', +'queued_count': 'str', +'queued_size': 'str', +'read': 'str', +'received': 'str', +'remote_process_group_status_snapshots': 'list[RemoteProcessGroupStatusSnapshotEntity]', +'sent': 'str', +'stateless_active_thread_count': 'int', +'terminated_thread_count': 'int', +'transferred': 'str', +'versioned_flow_state': 'str', +'written': 'str' } attribute_map = { - 'id': 'id', - 'name': 'name', - 'connection_status_snapshots': 'connectionStatusSnapshots', - 'processor_status_snapshots': 'processorStatusSnapshots', - 'process_group_status_snapshots': 'processGroupStatusSnapshots', - 'remote_process_group_status_snapshots': 'remoteProcessGroupStatusSnapshots', - 'input_port_status_snapshots': 'inputPortStatusSnapshots', - 'output_port_status_snapshots': 'outputPortStatusSnapshots', - 'versioned_flow_state': 'versionedFlowState', - 'flow_files_in': 'flowFilesIn', - 'bytes_in': 'bytesIn', - 'input': 'input', - 'flow_files_queued': 'flowFilesQueued', - 'bytes_queued': 'bytesQueued', - 'queued': 'queued', - 'queued_count': 'queuedCount', - 'queued_size': 'queuedSize', - 'bytes_read': 'bytesRead', - 'read': 'read', - 'bytes_written': 'bytesWritten', - 'written': 'written', - 'flow_files_out': 'flowFilesOut', - 'bytes_out': 'bytesOut', - 'output': 'output', - 'flow_files_transferred': 'flowFilesTransferred', - 'bytes_transferred': 'bytesTransferred', - 'transferred': 'transferred', - 'bytes_received': 'bytesReceived', - 'flow_files_received': 'flowFilesReceived', - 'received': 'received', - 'bytes_sent': 'bytesSent', - 'flow_files_sent': 'flowFilesSent', - 'sent': 'sent', 'active_thread_count': 'activeThreadCount', - 'terminated_thread_count': 'terminatedThreadCount', - 'processing_nanos': 'processingNanos', - 'processing_performance_status': 'processingPerformanceStatus' - } - - def __init__(self, id=None, name=None, connection_status_snapshots=None, processor_status_snapshots=None, process_group_status_snapshots=None, remote_process_group_status_snapshots=None, input_port_status_snapshots=None, output_port_status_snapshots=None, versioned_flow_state=None, flow_files_in=None, bytes_in=None, input=None, flow_files_queued=None, bytes_queued=None, queued=None, queued_count=None, queued_size=None, bytes_read=None, read=None, bytes_written=None, written=None, flow_files_out=None, bytes_out=None, output=None, flow_files_transferred=None, bytes_transferred=None, transferred=None, bytes_received=None, flow_files_received=None, received=None, bytes_sent=None, flow_files_sent=None, sent=None, active_thread_count=None, terminated_thread_count=None, processing_nanos=None, processing_performance_status=None): +'bytes_in': 'bytesIn', +'bytes_out': 'bytesOut', +'bytes_queued': 'bytesQueued', +'bytes_read': 'bytesRead', +'bytes_received': 'bytesReceived', +'bytes_sent': 'bytesSent', +'bytes_transferred': 'bytesTransferred', +'bytes_written': 'bytesWritten', +'connection_status_snapshots': 'connectionStatusSnapshots', +'flow_files_in': 'flowFilesIn', +'flow_files_out': 'flowFilesOut', +'flow_files_queued': 'flowFilesQueued', +'flow_files_received': 'flowFilesReceived', +'flow_files_sent': 'flowFilesSent', +'flow_files_transferred': 'flowFilesTransferred', +'id': 'id', +'input': 'input', +'input_port_status_snapshots': 'inputPortStatusSnapshots', +'name': 'name', +'output': 'output', +'output_port_status_snapshots': 'outputPortStatusSnapshots', +'process_group_status_snapshots': 'processGroupStatusSnapshots', +'processing_nanos': 'processingNanos', +'processing_performance_status': 'processingPerformanceStatus', +'processor_status_snapshots': 'processorStatusSnapshots', +'queued': 'queued', +'queued_count': 'queuedCount', +'queued_size': 'queuedSize', +'read': 'read', +'received': 'received', +'remote_process_group_status_snapshots': 'remoteProcessGroupStatusSnapshots', +'sent': 'sent', +'stateless_active_thread_count': 'statelessActiveThreadCount', +'terminated_thread_count': 'terminatedThreadCount', +'transferred': 'transferred', +'versioned_flow_state': 'versionedFlowState', +'written': 'written' } + + def __init__(self, active_thread_count=None, bytes_in=None, bytes_out=None, bytes_queued=None, bytes_read=None, bytes_received=None, bytes_sent=None, bytes_transferred=None, bytes_written=None, connection_status_snapshots=None, flow_files_in=None, flow_files_out=None, flow_files_queued=None, flow_files_received=None, flow_files_sent=None, flow_files_transferred=None, id=None, input=None, input_port_status_snapshots=None, name=None, output=None, output_port_status_snapshots=None, process_group_status_snapshots=None, processing_nanos=None, processing_performance_status=None, processor_status_snapshots=None, queued=None, queued_count=None, queued_size=None, read=None, received=None, remote_process_group_status_snapshots=None, sent=None, stateless_active_thread_count=None, terminated_thread_count=None, transferred=None, versioned_flow_state=None, written=None): """ ProcessGroupStatusSnapshotDTO - a model defined in Swagger """ - self._id = None - self._name = None + self._active_thread_count = None + self._bytes_in = None + self._bytes_out = None + self._bytes_queued = None + self._bytes_read = None + self._bytes_received = None + self._bytes_sent = None + self._bytes_transferred = None + self._bytes_written = None self._connection_status_snapshots = None - self._processor_status_snapshots = None - self._process_group_status_snapshots = None - self._remote_process_group_status_snapshots = None - self._input_port_status_snapshots = None - self._output_port_status_snapshots = None - self._versioned_flow_state = None self._flow_files_in = None - self._bytes_in = None - self._input = None + self._flow_files_out = None self._flow_files_queued = None - self._bytes_queued = None + self._flow_files_received = None + self._flow_files_sent = None + self._flow_files_transferred = None + self._id = None + self._input = None + self._input_port_status_snapshots = None + self._name = None + self._output = None + self._output_port_status_snapshots = None + self._process_group_status_snapshots = None + self._processing_nanos = None + self._processing_performance_status = None + self._processor_status_snapshots = None self._queued = None self._queued_count = None self._queued_size = None - self._bytes_read = None self._read = None - self._bytes_written = None - self._written = None - self._flow_files_out = None - self._bytes_out = None - self._output = None - self._flow_files_transferred = None - self._bytes_transferred = None - self._transferred = None - self._bytes_received = None - self._flow_files_received = None self._received = None - self._bytes_sent = None - self._flow_files_sent = None + self._remote_process_group_status_snapshots = None self._sent = None - self._active_thread_count = None + self._stateless_active_thread_count = None self._terminated_thread_count = None - self._processing_nanos = None - self._processing_performance_status = None + self._transferred = None + self._versioned_flow_state = None + self._written = None - if id is not None: - self.id = id - if name is not None: - self.name = name + if active_thread_count is not None: + self.active_thread_count = active_thread_count + if bytes_in is not None: + self.bytes_in = bytes_in + if bytes_out is not None: + self.bytes_out = bytes_out + if bytes_queued is not None: + self.bytes_queued = bytes_queued + if bytes_read is not None: + self.bytes_read = bytes_read + if bytes_received is not None: + self.bytes_received = bytes_received + if bytes_sent is not None: + self.bytes_sent = bytes_sent + if bytes_transferred is not None: + self.bytes_transferred = bytes_transferred + if bytes_written is not None: + self.bytes_written = bytes_written if connection_status_snapshots is not None: self.connection_status_snapshots = connection_status_snapshots - if processor_status_snapshots is not None: - self.processor_status_snapshots = processor_status_snapshots - if process_group_status_snapshots is not None: - self.process_group_status_snapshots = process_group_status_snapshots - if remote_process_group_status_snapshots is not None: - self.remote_process_group_status_snapshots = remote_process_group_status_snapshots - if input_port_status_snapshots is not None: - self.input_port_status_snapshots = input_port_status_snapshots - if output_port_status_snapshots is not None: - self.output_port_status_snapshots = output_port_status_snapshots - if versioned_flow_state is not None: - self.versioned_flow_state = versioned_flow_state if flow_files_in is not None: self.flow_files_in = flow_files_in - if bytes_in is not None: - self.bytes_in = bytes_in - if input is not None: - self.input = input + if flow_files_out is not None: + self.flow_files_out = flow_files_out if flow_files_queued is not None: self.flow_files_queued = flow_files_queued - if bytes_queued is not None: - self.bytes_queued = bytes_queued + if flow_files_received is not None: + self.flow_files_received = flow_files_received + if flow_files_sent is not None: + self.flow_files_sent = flow_files_sent + if flow_files_transferred is not None: + self.flow_files_transferred = flow_files_transferred + if id is not None: + self.id = id + if input is not None: + self.input = input + if input_port_status_snapshots is not None: + self.input_port_status_snapshots = input_port_status_snapshots + if name is not None: + self.name = name + if output is not None: + self.output = output + if output_port_status_snapshots is not None: + self.output_port_status_snapshots = output_port_status_snapshots + if process_group_status_snapshots is not None: + self.process_group_status_snapshots = process_group_status_snapshots + if processing_nanos is not None: + self.processing_nanos = processing_nanos + if processing_performance_status is not None: + self.processing_performance_status = processing_performance_status + if processor_status_snapshots is not None: + self.processor_status_snapshots = processor_status_snapshots if queued is not None: self.queued = queued if queued_count is not None: self.queued_count = queued_count if queued_size is not None: self.queued_size = queued_size - if bytes_read is not None: - self.bytes_read = bytes_read if read is not None: self.read = read - if bytes_written is not None: - self.bytes_written = bytes_written - if written is not None: - self.written = written - if flow_files_out is not None: - self.flow_files_out = flow_files_out - if bytes_out is not None: - self.bytes_out = bytes_out - if output is not None: - self.output = output - if flow_files_transferred is not None: - self.flow_files_transferred = flow_files_transferred - if bytes_transferred is not None: - self.bytes_transferred = bytes_transferred - if transferred is not None: - self.transferred = transferred - if bytes_received is not None: - self.bytes_received = bytes_received - if flow_files_received is not None: - self.flow_files_received = flow_files_received if received is not None: self.received = received - if bytes_sent is not None: - self.bytes_sent = bytes_sent - if flow_files_sent is not None: - self.flow_files_sent = flow_files_sent + if remote_process_group_status_snapshots is not None: + self.remote_process_group_status_snapshots = remote_process_group_status_snapshots if sent is not None: self.sent = sent - if active_thread_count is not None: - self.active_thread_count = active_thread_count + if stateless_active_thread_count is not None: + self.stateless_active_thread_count = stateless_active_thread_count if terminated_thread_count is not None: self.terminated_thread_count = terminated_thread_count - if processing_nanos is not None: - self.processing_nanos = processing_nanos - if processing_performance_status is not None: - self.processing_performance_status = processing_performance_status + if transferred is not None: + self.transferred = transferred + if versioned_flow_state is not None: + self.versioned_flow_state = versioned_flow_state + if written is not None: + self.written = written @property - def id(self): + def active_thread_count(self): """ - Gets the id of this ProcessGroupStatusSnapshotDTO. - The id of the process group. + Gets the active_thread_count of this ProcessGroupStatusSnapshotDTO. + The active thread count for this process group. - :return: The id of this ProcessGroupStatusSnapshotDTO. - :rtype: str + :return: The active_thread_count of this ProcessGroupStatusSnapshotDTO. + :rtype: int """ - return self._id + return self._active_thread_count - @id.setter - def id(self, id): + @active_thread_count.setter + def active_thread_count(self, active_thread_count): """ - Sets the id of this ProcessGroupStatusSnapshotDTO. - The id of the process group. + Sets the active_thread_count of this ProcessGroupStatusSnapshotDTO. + The active thread count for this process group. - :param id: The id of this ProcessGroupStatusSnapshotDTO. - :type: str + :param active_thread_count: The active_thread_count of this ProcessGroupStatusSnapshotDTO. + :type: int """ - self._id = id + self._active_thread_count = active_thread_count @property - def name(self): + def bytes_in(self): """ - Gets the name of this ProcessGroupStatusSnapshotDTO. - The name of this process group. + Gets the bytes_in of this ProcessGroupStatusSnapshotDTO. + The number of bytes that have come into this ProcessGroup in the last 5 minutes - :return: The name of this ProcessGroupStatusSnapshotDTO. - :rtype: str + :return: The bytes_in of this ProcessGroupStatusSnapshotDTO. + :rtype: int """ - return self._name + return self._bytes_in - @name.setter - def name(self, name): + @bytes_in.setter + def bytes_in(self, bytes_in): """ - Sets the name of this ProcessGroupStatusSnapshotDTO. - The name of this process group. + Sets the bytes_in of this ProcessGroupStatusSnapshotDTO. + The number of bytes that have come into this ProcessGroup in the last 5 minutes - :param name: The name of this ProcessGroupStatusSnapshotDTO. - :type: str + :param bytes_in: The bytes_in of this ProcessGroupStatusSnapshotDTO. + :type: int """ - self._name = name + self._bytes_in = bytes_in @property - def connection_status_snapshots(self): + def bytes_out(self): """ - Gets the connection_status_snapshots of this ProcessGroupStatusSnapshotDTO. - The status of all connections in the process group. + Gets the bytes_out of this ProcessGroupStatusSnapshotDTO. + The number of bytes transferred out of this ProcessGroup in the last 5 minutes - :return: The connection_status_snapshots of this ProcessGroupStatusSnapshotDTO. - :rtype: list[ConnectionStatusSnapshotEntity] + :return: The bytes_out of this ProcessGroupStatusSnapshotDTO. + :rtype: int """ - return self._connection_status_snapshots + return self._bytes_out - @connection_status_snapshots.setter - def connection_status_snapshots(self, connection_status_snapshots): + @bytes_out.setter + def bytes_out(self, bytes_out): """ - Sets the connection_status_snapshots of this ProcessGroupStatusSnapshotDTO. - The status of all connections in the process group. + Sets the bytes_out of this ProcessGroupStatusSnapshotDTO. + The number of bytes transferred out of this ProcessGroup in the last 5 minutes - :param connection_status_snapshots: The connection_status_snapshots of this ProcessGroupStatusSnapshotDTO. - :type: list[ConnectionStatusSnapshotEntity] + :param bytes_out: The bytes_out of this ProcessGroupStatusSnapshotDTO. + :type: int """ - self._connection_status_snapshots = connection_status_snapshots + self._bytes_out = bytes_out @property - def processor_status_snapshots(self): + def bytes_queued(self): """ - Gets the processor_status_snapshots of this ProcessGroupStatusSnapshotDTO. - The status of all processors in the process group. + Gets the bytes_queued of this ProcessGroupStatusSnapshotDTO. + The number of bytes that are queued up in this ProcessGroup right now - :return: The processor_status_snapshots of this ProcessGroupStatusSnapshotDTO. - :rtype: list[ProcessorStatusSnapshotEntity] + :return: The bytes_queued of this ProcessGroupStatusSnapshotDTO. + :rtype: int """ - return self._processor_status_snapshots + return self._bytes_queued - @processor_status_snapshots.setter - def processor_status_snapshots(self, processor_status_snapshots): + @bytes_queued.setter + def bytes_queued(self, bytes_queued): """ - Sets the processor_status_snapshots of this ProcessGroupStatusSnapshotDTO. - The status of all processors in the process group. + Sets the bytes_queued of this ProcessGroupStatusSnapshotDTO. + The number of bytes that are queued up in this ProcessGroup right now - :param processor_status_snapshots: The processor_status_snapshots of this ProcessGroupStatusSnapshotDTO. - :type: list[ProcessorStatusSnapshotEntity] + :param bytes_queued: The bytes_queued of this ProcessGroupStatusSnapshotDTO. + :type: int """ - self._processor_status_snapshots = processor_status_snapshots + self._bytes_queued = bytes_queued @property - def process_group_status_snapshots(self): + def bytes_read(self): """ - Gets the process_group_status_snapshots of this ProcessGroupStatusSnapshotDTO. - The status of all process groups in the process group. + Gets the bytes_read of this ProcessGroupStatusSnapshotDTO. + The number of bytes read by components in this ProcessGroup in the last 5 minutes - :return: The process_group_status_snapshots of this ProcessGroupStatusSnapshotDTO. - :rtype: list[ProcessGroupStatusSnapshotEntity] + :return: The bytes_read of this ProcessGroupStatusSnapshotDTO. + :rtype: int """ - return self._process_group_status_snapshots + return self._bytes_read - @process_group_status_snapshots.setter - def process_group_status_snapshots(self, process_group_status_snapshots): + @bytes_read.setter + def bytes_read(self, bytes_read): """ - Sets the process_group_status_snapshots of this ProcessGroupStatusSnapshotDTO. - The status of all process groups in the process group. + Sets the bytes_read of this ProcessGroupStatusSnapshotDTO. + The number of bytes read by components in this ProcessGroup in the last 5 minutes - :param process_group_status_snapshots: The process_group_status_snapshots of this ProcessGroupStatusSnapshotDTO. - :type: list[ProcessGroupStatusSnapshotEntity] + :param bytes_read: The bytes_read of this ProcessGroupStatusSnapshotDTO. + :type: int """ - self._process_group_status_snapshots = process_group_status_snapshots + self._bytes_read = bytes_read @property - def remote_process_group_status_snapshots(self): + def bytes_received(self): """ - Gets the remote_process_group_status_snapshots of this ProcessGroupStatusSnapshotDTO. - The status of all remote process groups in the process group. + Gets the bytes_received of this ProcessGroupStatusSnapshotDTO. + The number of bytes received from external sources by components within this ProcessGroup in the last 5 minutes - :return: The remote_process_group_status_snapshots of this ProcessGroupStatusSnapshotDTO. - :rtype: list[RemoteProcessGroupStatusSnapshotEntity] + :return: The bytes_received of this ProcessGroupStatusSnapshotDTO. + :rtype: int """ - return self._remote_process_group_status_snapshots + return self._bytes_received - @remote_process_group_status_snapshots.setter - def remote_process_group_status_snapshots(self, remote_process_group_status_snapshots): + @bytes_received.setter + def bytes_received(self, bytes_received): """ - Sets the remote_process_group_status_snapshots of this ProcessGroupStatusSnapshotDTO. - The status of all remote process groups in the process group. + Sets the bytes_received of this ProcessGroupStatusSnapshotDTO. + The number of bytes received from external sources by components within this ProcessGroup in the last 5 minutes - :param remote_process_group_status_snapshots: The remote_process_group_status_snapshots of this ProcessGroupStatusSnapshotDTO. - :type: list[RemoteProcessGroupStatusSnapshotEntity] + :param bytes_received: The bytes_received of this ProcessGroupStatusSnapshotDTO. + :type: int """ - self._remote_process_group_status_snapshots = remote_process_group_status_snapshots + self._bytes_received = bytes_received @property - def input_port_status_snapshots(self): + def bytes_sent(self): """ - Gets the input_port_status_snapshots of this ProcessGroupStatusSnapshotDTO. - The status of all input ports in the process group. + Gets the bytes_sent of this ProcessGroupStatusSnapshotDTO. + The number of bytes sent to an external sink by components within this ProcessGroup in the last 5 minutes - :return: The input_port_status_snapshots of this ProcessGroupStatusSnapshotDTO. - :rtype: list[PortStatusSnapshotEntity] + :return: The bytes_sent of this ProcessGroupStatusSnapshotDTO. + :rtype: int """ - return self._input_port_status_snapshots + return self._bytes_sent - @input_port_status_snapshots.setter - def input_port_status_snapshots(self, input_port_status_snapshots): + @bytes_sent.setter + def bytes_sent(self, bytes_sent): """ - Sets the input_port_status_snapshots of this ProcessGroupStatusSnapshotDTO. - The status of all input ports in the process group. + Sets the bytes_sent of this ProcessGroupStatusSnapshotDTO. + The number of bytes sent to an external sink by components within this ProcessGroup in the last 5 minutes - :param input_port_status_snapshots: The input_port_status_snapshots of this ProcessGroupStatusSnapshotDTO. - :type: list[PortStatusSnapshotEntity] + :param bytes_sent: The bytes_sent of this ProcessGroupStatusSnapshotDTO. + :type: int """ - self._input_port_status_snapshots = input_port_status_snapshots + self._bytes_sent = bytes_sent @property - def output_port_status_snapshots(self): + def bytes_transferred(self): """ - Gets the output_port_status_snapshots of this ProcessGroupStatusSnapshotDTO. - The status of all output ports in the process group. + Gets the bytes_transferred of this ProcessGroupStatusSnapshotDTO. + The number of bytes transferred in this ProcessGroup in the last 5 minutes - :return: The output_port_status_snapshots of this ProcessGroupStatusSnapshotDTO. - :rtype: list[PortStatusSnapshotEntity] + :return: The bytes_transferred of this ProcessGroupStatusSnapshotDTO. + :rtype: int """ - return self._output_port_status_snapshots + return self._bytes_transferred - @output_port_status_snapshots.setter - def output_port_status_snapshots(self, output_port_status_snapshots): + @bytes_transferred.setter + def bytes_transferred(self, bytes_transferred): """ - Sets the output_port_status_snapshots of this ProcessGroupStatusSnapshotDTO. - The status of all output ports in the process group. + Sets the bytes_transferred of this ProcessGroupStatusSnapshotDTO. + The number of bytes transferred in this ProcessGroup in the last 5 minutes - :param output_port_status_snapshots: The output_port_status_snapshots of this ProcessGroupStatusSnapshotDTO. - :type: list[PortStatusSnapshotEntity] + :param bytes_transferred: The bytes_transferred of this ProcessGroupStatusSnapshotDTO. + :type: int """ - self._output_port_status_snapshots = output_port_status_snapshots + self._bytes_transferred = bytes_transferred @property - def versioned_flow_state(self): + def bytes_written(self): """ - Gets the versioned_flow_state of this ProcessGroupStatusSnapshotDTO. - The current state of the Process Group, as it relates to the Versioned Flow + Gets the bytes_written of this ProcessGroupStatusSnapshotDTO. + The number of bytes written by components in this ProcessGroup in the last 5 minutes - :return: The versioned_flow_state of this ProcessGroupStatusSnapshotDTO. - :rtype: str + :return: The bytes_written of this ProcessGroupStatusSnapshotDTO. + :rtype: int """ - return self._versioned_flow_state + return self._bytes_written - @versioned_flow_state.setter - def versioned_flow_state(self, versioned_flow_state): + @bytes_written.setter + def bytes_written(self, bytes_written): """ - Sets the versioned_flow_state of this ProcessGroupStatusSnapshotDTO. - The current state of the Process Group, as it relates to the Versioned Flow + Sets the bytes_written of this ProcessGroupStatusSnapshotDTO. + The number of bytes written by components in this ProcessGroup in the last 5 minutes - :param versioned_flow_state: The versioned_flow_state of this ProcessGroupStatusSnapshotDTO. - :type: str + :param bytes_written: The bytes_written of this ProcessGroupStatusSnapshotDTO. + :type: int """ - 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 + self._bytes_written = bytes_written + + @property + def connection_status_snapshots(self): + """ + Gets the connection_status_snapshots of this ProcessGroupStatusSnapshotDTO. + The status of all connections in the process group. + + :return: The connection_status_snapshots of this ProcessGroupStatusSnapshotDTO. + :rtype: list[ConnectionStatusSnapshotEntity] + """ + return self._connection_status_snapshots + + @connection_status_snapshots.setter + def connection_status_snapshots(self, connection_status_snapshots): + """ + Sets the connection_status_snapshots of this ProcessGroupStatusSnapshotDTO. + The status of all connections in the process group. + + :param connection_status_snapshots: The connection_status_snapshots of this ProcessGroupStatusSnapshotDTO. + :type: list[ConnectionStatusSnapshotEntity] + """ + + self._connection_status_snapshots = connection_status_snapshots @property def flow_files_in(self): @@ -462,50 +481,27 @@ def flow_files_in(self, flow_files_in): self._flow_files_in = flow_files_in @property - def bytes_in(self): + def flow_files_out(self): """ - Gets the bytes_in of this ProcessGroupStatusSnapshotDTO. - The number of bytes that have come into this ProcessGroup in the last 5 minutes + Gets the flow_files_out of this ProcessGroupStatusSnapshotDTO. + The number of FlowFiles transferred out of this ProcessGroup in the last 5 minutes - :return: The bytes_in of this ProcessGroupStatusSnapshotDTO. + :return: The flow_files_out of this ProcessGroupStatusSnapshotDTO. :rtype: int """ - return self._bytes_in + return self._flow_files_out - @bytes_in.setter - def bytes_in(self, bytes_in): + @flow_files_out.setter + def flow_files_out(self, flow_files_out): """ - Sets the bytes_in of this ProcessGroupStatusSnapshotDTO. - The number of bytes that have come into this ProcessGroup in the last 5 minutes + Sets the flow_files_out of this ProcessGroupStatusSnapshotDTO. + The number of FlowFiles transferred out of this ProcessGroup in the last 5 minutes - :param bytes_in: The bytes_in of this ProcessGroupStatusSnapshotDTO. + :param flow_files_out: The flow_files_out of this ProcessGroupStatusSnapshotDTO. :type: int """ - self._bytes_in = bytes_in - - @property - def input(self): - """ - Gets the input of this ProcessGroupStatusSnapshotDTO. - The input count/size for the process group in the last 5 minutes (pretty printed). - - :return: The input of this ProcessGroupStatusSnapshotDTO. - :rtype: str - """ - return self._input - - @input.setter - def input(self, input): - """ - Sets the input of this ProcessGroupStatusSnapshotDTO. - The input count/size for the process group in the last 5 minutes (pretty printed). - - :param input: The input of this ProcessGroupStatusSnapshotDTO. - :type: str - """ - - self._input = input + self._flow_files_out = flow_files_out @property def flow_files_queued(self): @@ -531,372 +527,391 @@ def flow_files_queued(self, flow_files_queued): self._flow_files_queued = flow_files_queued @property - def bytes_queued(self): + def flow_files_received(self): """ - Gets the bytes_queued of this ProcessGroupStatusSnapshotDTO. - The number of bytes that are queued up in this ProcessGroup right now + Gets the flow_files_received of this ProcessGroupStatusSnapshotDTO. + The number of FlowFiles received from external sources by components within this ProcessGroup in the last 5 minutes - :return: The bytes_queued of this ProcessGroupStatusSnapshotDTO. + :return: The flow_files_received of this ProcessGroupStatusSnapshotDTO. :rtype: int """ - return self._bytes_queued + return self._flow_files_received - @bytes_queued.setter - def bytes_queued(self, bytes_queued): + @flow_files_received.setter + def flow_files_received(self, flow_files_received): + """ + Sets the flow_files_received of this ProcessGroupStatusSnapshotDTO. + The number of FlowFiles received from external sources by components within this ProcessGroup in the last 5 minutes + + :param flow_files_received: The flow_files_received of this ProcessGroupStatusSnapshotDTO. + :type: int + """ + + self._flow_files_received = flow_files_received + + @property + def flow_files_sent(self): + """ + Gets the flow_files_sent of this ProcessGroupStatusSnapshotDTO. + The number of FlowFiles sent to an external sink by components within this ProcessGroup in the last 5 minutes + + :return: The flow_files_sent of this ProcessGroupStatusSnapshotDTO. + :rtype: int + """ + return self._flow_files_sent + + @flow_files_sent.setter + def flow_files_sent(self, flow_files_sent): """ - Sets the bytes_queued of this ProcessGroupStatusSnapshotDTO. - The number of bytes that are queued up in this ProcessGroup right now + Sets the flow_files_sent of this ProcessGroupStatusSnapshotDTO. + The number of FlowFiles sent to an external sink by components within this ProcessGroup in the last 5 minutes - :param bytes_queued: The bytes_queued of this ProcessGroupStatusSnapshotDTO. + :param flow_files_sent: The flow_files_sent of this ProcessGroupStatusSnapshotDTO. :type: int """ - self._bytes_queued = bytes_queued + self._flow_files_sent = flow_files_sent @property - def queued(self): + def flow_files_transferred(self): """ - Gets the queued of this ProcessGroupStatusSnapshotDTO. - The count/size that is queued in the the process group. + Gets the flow_files_transferred of this ProcessGroupStatusSnapshotDTO. + The number of FlowFiles transferred in this ProcessGroup in the last 5 minutes - :return: The queued of this ProcessGroupStatusSnapshotDTO. - :rtype: str + :return: The flow_files_transferred of this ProcessGroupStatusSnapshotDTO. + :rtype: int """ - return self._queued + return self._flow_files_transferred - @queued.setter - def queued(self, queued): + @flow_files_transferred.setter + def flow_files_transferred(self, flow_files_transferred): """ - Sets the queued of this ProcessGroupStatusSnapshotDTO. - The count/size that is queued in the the process group. + Sets the flow_files_transferred of this ProcessGroupStatusSnapshotDTO. + The number of FlowFiles transferred in this ProcessGroup in the last 5 minutes - :param queued: The queued of this ProcessGroupStatusSnapshotDTO. - :type: str + :param flow_files_transferred: The flow_files_transferred of this ProcessGroupStatusSnapshotDTO. + :type: int """ - self._queued = queued + self._flow_files_transferred = flow_files_transferred @property - def queued_count(self): + def id(self): """ - Gets the queued_count of this ProcessGroupStatusSnapshotDTO. - The count that is queued for the process group. + Gets the id of this ProcessGroupStatusSnapshotDTO. + The id of the process group. - :return: The queued_count of this ProcessGroupStatusSnapshotDTO. + :return: The id of this ProcessGroupStatusSnapshotDTO. :rtype: str """ - return self._queued_count + return self._id - @queued_count.setter - def queued_count(self, queued_count): + @id.setter + def id(self, id): """ - Sets the queued_count of this ProcessGroupStatusSnapshotDTO. - The count that is queued for the process group. + Sets the id of this ProcessGroupStatusSnapshotDTO. + The id of the process group. - :param queued_count: The queued_count of this ProcessGroupStatusSnapshotDTO. + :param id: The id of this ProcessGroupStatusSnapshotDTO. :type: str """ - self._queued_count = queued_count + self._id = id @property - def queued_size(self): + def input(self): """ - Gets the queued_size of this ProcessGroupStatusSnapshotDTO. - The size that is queued for the process group. + Gets the input of this ProcessGroupStatusSnapshotDTO. + The input count/size for the process group in the last 5 minutes (pretty printed). - :return: The queued_size of this ProcessGroupStatusSnapshotDTO. + :return: The input of this ProcessGroupStatusSnapshotDTO. :rtype: str """ - return self._queued_size + return self._input - @queued_size.setter - def queued_size(self, queued_size): + @input.setter + def input(self, input): """ - Sets the queued_size of this ProcessGroupStatusSnapshotDTO. - The size that is queued for the process group. + Sets the input of this ProcessGroupStatusSnapshotDTO. + The input count/size for the process group in the last 5 minutes (pretty printed). - :param queued_size: The queued_size of this ProcessGroupStatusSnapshotDTO. + :param input: The input of this ProcessGroupStatusSnapshotDTO. :type: str """ - self._queued_size = queued_size + self._input = input @property - def bytes_read(self): + def input_port_status_snapshots(self): """ - Gets the bytes_read of this ProcessGroupStatusSnapshotDTO. - The number of bytes read by components in this ProcessGroup in the last 5 minutes + Gets the input_port_status_snapshots of this ProcessGroupStatusSnapshotDTO. + The status of all input ports in the process group. - :return: The bytes_read of this ProcessGroupStatusSnapshotDTO. - :rtype: int + :return: The input_port_status_snapshots of this ProcessGroupStatusSnapshotDTO. + :rtype: list[PortStatusSnapshotEntity] """ - return self._bytes_read + return self._input_port_status_snapshots - @bytes_read.setter - def bytes_read(self, bytes_read): + @input_port_status_snapshots.setter + def input_port_status_snapshots(self, input_port_status_snapshots): """ - Sets the bytes_read of this ProcessGroupStatusSnapshotDTO. - The number of bytes read by components in this ProcessGroup in the last 5 minutes + Sets the input_port_status_snapshots of this ProcessGroupStatusSnapshotDTO. + The status of all input ports in the process group. - :param bytes_read: The bytes_read of this ProcessGroupStatusSnapshotDTO. - :type: int + :param input_port_status_snapshots: The input_port_status_snapshots of this ProcessGroupStatusSnapshotDTO. + :type: list[PortStatusSnapshotEntity] """ - self._bytes_read = bytes_read + self._input_port_status_snapshots = input_port_status_snapshots @property - def read(self): + def name(self): """ - Gets the read of this ProcessGroupStatusSnapshotDTO. - The number of bytes read in the last 5 minutes. + Gets the name of this ProcessGroupStatusSnapshotDTO. + The name of this process group. - :return: The read of this ProcessGroupStatusSnapshotDTO. + :return: The name of this ProcessGroupStatusSnapshotDTO. :rtype: str """ - return self._read + return self._name - @read.setter - def read(self, read): + @name.setter + def name(self, name): """ - Sets the read of this ProcessGroupStatusSnapshotDTO. - The number of bytes read in the last 5 minutes. + Sets the name of this ProcessGroupStatusSnapshotDTO. + The name of this process group. - :param read: The read of this ProcessGroupStatusSnapshotDTO. + :param name: The name of this ProcessGroupStatusSnapshotDTO. :type: str """ - self._read = read + self._name = name @property - def bytes_written(self): + def output(self): """ - Gets the bytes_written of this ProcessGroupStatusSnapshotDTO. - The number of bytes written by components in this ProcessGroup in the last 5 minutes + Gets the output of this ProcessGroupStatusSnapshotDTO. + The output count/size for the process group in the last 5 minutes. - :return: The bytes_written of this ProcessGroupStatusSnapshotDTO. - :rtype: int + :return: The output of this ProcessGroupStatusSnapshotDTO. + :rtype: str """ - return self._bytes_written + return self._output - @bytes_written.setter - def bytes_written(self, bytes_written): + @output.setter + def output(self, output): """ - Sets the bytes_written of this ProcessGroupStatusSnapshotDTO. - The number of bytes written by components in this ProcessGroup in the last 5 minutes + Sets the output of this ProcessGroupStatusSnapshotDTO. + The output count/size for the process group in the last 5 minutes. - :param bytes_written: The bytes_written of this ProcessGroupStatusSnapshotDTO. - :type: int + :param output: The output of this ProcessGroupStatusSnapshotDTO. + :type: str """ - self._bytes_written = bytes_written + self._output = output @property - def written(self): + def output_port_status_snapshots(self): """ - Gets the written of this ProcessGroupStatusSnapshotDTO. - The number of bytes written in the last 5 minutes. + Gets the output_port_status_snapshots of this ProcessGroupStatusSnapshotDTO. + The status of all output ports in the process group. - :return: The written of this ProcessGroupStatusSnapshotDTO. - :rtype: str + :return: The output_port_status_snapshots of this ProcessGroupStatusSnapshotDTO. + :rtype: list[PortStatusSnapshotEntity] """ - return self._written + return self._output_port_status_snapshots - @written.setter - def written(self, written): + @output_port_status_snapshots.setter + def output_port_status_snapshots(self, output_port_status_snapshots): """ - Sets the written of this ProcessGroupStatusSnapshotDTO. - The number of bytes written in the last 5 minutes. + Sets the output_port_status_snapshots of this ProcessGroupStatusSnapshotDTO. + The status of all output ports in the process group. - :param written: The written of this ProcessGroupStatusSnapshotDTO. - :type: str + :param output_port_status_snapshots: The output_port_status_snapshots of this ProcessGroupStatusSnapshotDTO. + :type: list[PortStatusSnapshotEntity] """ - self._written = written + self._output_port_status_snapshots = output_port_status_snapshots @property - def flow_files_out(self): + def process_group_status_snapshots(self): """ - Gets the flow_files_out of this ProcessGroupStatusSnapshotDTO. - The number of FlowFiles transferred out of this ProcessGroup in the last 5 minutes + Gets the process_group_status_snapshots of this ProcessGroupStatusSnapshotDTO. + The status of all process groups in the process group. - :return: The flow_files_out of this ProcessGroupStatusSnapshotDTO. - :rtype: int + :return: The process_group_status_snapshots of this ProcessGroupStatusSnapshotDTO. + :rtype: list[ProcessGroupStatusSnapshotEntity] """ - return self._flow_files_out + return self._process_group_status_snapshots - @flow_files_out.setter - def flow_files_out(self, flow_files_out): + @process_group_status_snapshots.setter + def process_group_status_snapshots(self, process_group_status_snapshots): """ - Sets the flow_files_out of this ProcessGroupStatusSnapshotDTO. - The number of FlowFiles transferred out of this ProcessGroup in the last 5 minutes + Sets the process_group_status_snapshots of this ProcessGroupStatusSnapshotDTO. + The status of all process groups in the process group. - :param flow_files_out: The flow_files_out of this ProcessGroupStatusSnapshotDTO. - :type: int + :param process_group_status_snapshots: The process_group_status_snapshots of this ProcessGroupStatusSnapshotDTO. + :type: list[ProcessGroupStatusSnapshotEntity] """ - self._flow_files_out = flow_files_out + self._process_group_status_snapshots = process_group_status_snapshots @property - def bytes_out(self): + def processing_nanos(self): """ - Gets the bytes_out of this ProcessGroupStatusSnapshotDTO. - The number of bytes transferred out of this ProcessGroup in the last 5 minutes + Gets the processing_nanos of this ProcessGroupStatusSnapshotDTO. - :return: The bytes_out of this ProcessGroupStatusSnapshotDTO. + :return: The processing_nanos of this ProcessGroupStatusSnapshotDTO. :rtype: int """ - return self._bytes_out + return self._processing_nanos - @bytes_out.setter - def bytes_out(self, bytes_out): + @processing_nanos.setter + def processing_nanos(self, processing_nanos): """ - Sets the bytes_out of this ProcessGroupStatusSnapshotDTO. - The number of bytes transferred out of this ProcessGroup in the last 5 minutes + Sets the processing_nanos of this ProcessGroupStatusSnapshotDTO. - :param bytes_out: The bytes_out of this ProcessGroupStatusSnapshotDTO. + :param processing_nanos: The processing_nanos of this ProcessGroupStatusSnapshotDTO. :type: int """ - self._bytes_out = bytes_out + self._processing_nanos = processing_nanos @property - def output(self): + def processing_performance_status(self): """ - Gets the output of this ProcessGroupStatusSnapshotDTO. - The output count/size for the process group in the last 5 minutes. + Gets the processing_performance_status of this ProcessGroupStatusSnapshotDTO. - :return: The output of this ProcessGroupStatusSnapshotDTO. - :rtype: str + :return: The processing_performance_status of this ProcessGroupStatusSnapshotDTO. + :rtype: ProcessingPerformanceStatusDTO """ - return self._output + return self._processing_performance_status - @output.setter - def output(self, output): + @processing_performance_status.setter + def processing_performance_status(self, processing_performance_status): """ - Sets the output of this ProcessGroupStatusSnapshotDTO. - The output count/size for the process group in the last 5 minutes. + Sets the processing_performance_status of this ProcessGroupStatusSnapshotDTO. - :param output: The output of this ProcessGroupStatusSnapshotDTO. - :type: str + :param processing_performance_status: The processing_performance_status of this ProcessGroupStatusSnapshotDTO. + :type: ProcessingPerformanceStatusDTO """ - self._output = output + self._processing_performance_status = processing_performance_status @property - def flow_files_transferred(self): + def processor_status_snapshots(self): """ - Gets the flow_files_transferred of this ProcessGroupStatusSnapshotDTO. - The number of FlowFiles transferred in this ProcessGroup in the last 5 minutes + Gets the processor_status_snapshots of this ProcessGroupStatusSnapshotDTO. + The status of all processors in the process group. - :return: The flow_files_transferred of this ProcessGroupStatusSnapshotDTO. - :rtype: int + :return: The processor_status_snapshots of this ProcessGroupStatusSnapshotDTO. + :rtype: list[ProcessorStatusSnapshotEntity] """ - return self._flow_files_transferred + return self._processor_status_snapshots - @flow_files_transferred.setter - def flow_files_transferred(self, flow_files_transferred): + @processor_status_snapshots.setter + def processor_status_snapshots(self, processor_status_snapshots): """ - Sets the flow_files_transferred of this ProcessGroupStatusSnapshotDTO. - The number of FlowFiles transferred in this ProcessGroup in the last 5 minutes + Sets the processor_status_snapshots of this ProcessGroupStatusSnapshotDTO. + The status of all processors in the process group. - :param flow_files_transferred: The flow_files_transferred of this ProcessGroupStatusSnapshotDTO. - :type: int + :param processor_status_snapshots: The processor_status_snapshots of this ProcessGroupStatusSnapshotDTO. + :type: list[ProcessorStatusSnapshotEntity] """ - self._flow_files_transferred = flow_files_transferred + self._processor_status_snapshots = processor_status_snapshots @property - def bytes_transferred(self): + def queued(self): """ - Gets the bytes_transferred of this ProcessGroupStatusSnapshotDTO. - The number of bytes transferred in this ProcessGroup in the last 5 minutes + Gets the queued of this ProcessGroupStatusSnapshotDTO. + The count/size that is queued in the the process group. - :return: The bytes_transferred of this ProcessGroupStatusSnapshotDTO. - :rtype: int + :return: The queued of this ProcessGroupStatusSnapshotDTO. + :rtype: str """ - return self._bytes_transferred + return self._queued - @bytes_transferred.setter - def bytes_transferred(self, bytes_transferred): + @queued.setter + def queued(self, queued): """ - Sets the bytes_transferred of this ProcessGroupStatusSnapshotDTO. - The number of bytes transferred in this ProcessGroup in the last 5 minutes + Sets the queued of this ProcessGroupStatusSnapshotDTO. + The count/size that is queued in the the process group. - :param bytes_transferred: The bytes_transferred of this ProcessGroupStatusSnapshotDTO. - :type: int + :param queued: The queued of this ProcessGroupStatusSnapshotDTO. + :type: str """ - self._bytes_transferred = bytes_transferred + self._queued = queued @property - def transferred(self): + def queued_count(self): """ - Gets the transferred of this ProcessGroupStatusSnapshotDTO. - The count/size transferred to/from queues in the process group in the last 5 minutes. + Gets the queued_count of this ProcessGroupStatusSnapshotDTO. + The count that is queued for the process group. - :return: The transferred of this ProcessGroupStatusSnapshotDTO. + :return: The queued_count of this ProcessGroupStatusSnapshotDTO. :rtype: str """ - return self._transferred + return self._queued_count - @transferred.setter - def transferred(self, transferred): + @queued_count.setter + def queued_count(self, queued_count): """ - Sets the transferred of this ProcessGroupStatusSnapshotDTO. - The count/size transferred to/from queues in the process group in the last 5 minutes. + Sets the queued_count of this ProcessGroupStatusSnapshotDTO. + The count that is queued for the process group. - :param transferred: The transferred of this ProcessGroupStatusSnapshotDTO. + :param queued_count: The queued_count of this ProcessGroupStatusSnapshotDTO. :type: str """ - self._transferred = transferred + self._queued_count = queued_count @property - def bytes_received(self): + def queued_size(self): """ - Gets the bytes_received of this ProcessGroupStatusSnapshotDTO. - The number of bytes received from external sources by components within this ProcessGroup in the last 5 minutes + Gets the queued_size of this ProcessGroupStatusSnapshotDTO. + The size that is queued for the process group. - :return: The bytes_received of this ProcessGroupStatusSnapshotDTO. - :rtype: int + :return: The queued_size of this ProcessGroupStatusSnapshotDTO. + :rtype: str """ - return self._bytes_received + return self._queued_size - @bytes_received.setter - def bytes_received(self, bytes_received): + @queued_size.setter + def queued_size(self, queued_size): """ - Sets the bytes_received of this ProcessGroupStatusSnapshotDTO. - The number of bytes received from external sources by components within this ProcessGroup in the last 5 minutes + Sets the queued_size of this ProcessGroupStatusSnapshotDTO. + The size that is queued for the process group. - :param bytes_received: The bytes_received of this ProcessGroupStatusSnapshotDTO. - :type: int + :param queued_size: The queued_size of this ProcessGroupStatusSnapshotDTO. + :type: str """ - self._bytes_received = bytes_received + self._queued_size = queued_size @property - def flow_files_received(self): + def read(self): """ - Gets the flow_files_received of this ProcessGroupStatusSnapshotDTO. - The number of FlowFiles received from external sources by components within this ProcessGroup in the last 5 minutes + Gets the read of this ProcessGroupStatusSnapshotDTO. + The number of bytes read in the last 5 minutes. - :return: The flow_files_received of this ProcessGroupStatusSnapshotDTO. - :rtype: int + :return: The read of this ProcessGroupStatusSnapshotDTO. + :rtype: str """ - return self._flow_files_received + return self._read - @flow_files_received.setter - def flow_files_received(self, flow_files_received): + @read.setter + def read(self, read): """ - Sets the flow_files_received of this ProcessGroupStatusSnapshotDTO. - The number of FlowFiles received from external sources by components within this ProcessGroup in the last 5 minutes + Sets the read of this ProcessGroupStatusSnapshotDTO. + The number of bytes read in the last 5 minutes. - :param flow_files_received: The flow_files_received of this ProcessGroupStatusSnapshotDTO. - :type: int + :param read: The read of this ProcessGroupStatusSnapshotDTO. + :type: str """ - self._flow_files_received = flow_files_received + self._read = read @property def received(self): @@ -922,50 +937,27 @@ def received(self, received): self._received = received @property - def bytes_sent(self): - """ - Gets the bytes_sent of this ProcessGroupStatusSnapshotDTO. - The number of bytes sent to an external sink by components within this ProcessGroup in the last 5 minutes - - :return: The bytes_sent of this ProcessGroupStatusSnapshotDTO. - :rtype: int - """ - return self._bytes_sent - - @bytes_sent.setter - def bytes_sent(self, bytes_sent): - """ - Sets the bytes_sent of this ProcessGroupStatusSnapshotDTO. - The number of bytes sent to an external sink by components within this ProcessGroup in the last 5 minutes - - :param bytes_sent: The bytes_sent of this ProcessGroupStatusSnapshotDTO. - :type: int - """ - - self._bytes_sent = bytes_sent - - @property - def flow_files_sent(self): + def remote_process_group_status_snapshots(self): """ - Gets the flow_files_sent of this ProcessGroupStatusSnapshotDTO. - The number of FlowFiles sent to an external sink by components within this ProcessGroup in the last 5 minutes + Gets the remote_process_group_status_snapshots of this ProcessGroupStatusSnapshotDTO. + The status of all remote process groups in the process group. - :return: The flow_files_sent of this ProcessGroupStatusSnapshotDTO. - :rtype: int + :return: The remote_process_group_status_snapshots of this ProcessGroupStatusSnapshotDTO. + :rtype: list[RemoteProcessGroupStatusSnapshotEntity] """ - return self._flow_files_sent + return self._remote_process_group_status_snapshots - @flow_files_sent.setter - def flow_files_sent(self, flow_files_sent): + @remote_process_group_status_snapshots.setter + def remote_process_group_status_snapshots(self, remote_process_group_status_snapshots): """ - Sets the flow_files_sent of this ProcessGroupStatusSnapshotDTO. - The number of FlowFiles sent to an external sink by components within this ProcessGroup in the last 5 minutes + Sets the remote_process_group_status_snapshots of this ProcessGroupStatusSnapshotDTO. + The status of all remote process groups in the process group. - :param flow_files_sent: The flow_files_sent of this ProcessGroupStatusSnapshotDTO. - :type: int + :param remote_process_group_status_snapshots: The remote_process_group_status_snapshots of this ProcessGroupStatusSnapshotDTO. + :type: list[RemoteProcessGroupStatusSnapshotEntity] """ - self._flow_files_sent = flow_files_sent + self._remote_process_group_status_snapshots = remote_process_group_status_snapshots @property def sent(self): @@ -991,27 +983,27 @@ def sent(self, sent): self._sent = sent @property - def active_thread_count(self): + def stateless_active_thread_count(self): """ - Gets the active_thread_count of this ProcessGroupStatusSnapshotDTO. - The active thread count for this process group. + Gets the stateless_active_thread_count of this ProcessGroupStatusSnapshotDTO. + The current number of active threads for the Process Group, when running in Stateless mode. - :return: The active_thread_count of this ProcessGroupStatusSnapshotDTO. + :return: The stateless_active_thread_count of this ProcessGroupStatusSnapshotDTO. :rtype: int """ - return self._active_thread_count + return self._stateless_active_thread_count - @active_thread_count.setter - def active_thread_count(self, active_thread_count): + @stateless_active_thread_count.setter + def stateless_active_thread_count(self, stateless_active_thread_count): """ - Sets the active_thread_count of this ProcessGroupStatusSnapshotDTO. - The active thread count for this process group. + Sets the stateless_active_thread_count of this ProcessGroupStatusSnapshotDTO. + The current number of active threads for the Process Group, when running in Stateless mode. - :param active_thread_count: The active_thread_count of this ProcessGroupStatusSnapshotDTO. + :param stateless_active_thread_count: The stateless_active_thread_count of this ProcessGroupStatusSnapshotDTO. :type: int """ - self._active_thread_count = active_thread_count + self._stateless_active_thread_count = stateless_active_thread_count @property def terminated_thread_count(self): @@ -1037,48 +1029,79 @@ def terminated_thread_count(self, terminated_thread_count): self._terminated_thread_count = terminated_thread_count @property - def processing_nanos(self): + def transferred(self): """ - Gets the processing_nanos of this ProcessGroupStatusSnapshotDTO. + Gets the transferred of this ProcessGroupStatusSnapshotDTO. + The count/size transferred to/from queues in the process group in the last 5 minutes. - :return: The processing_nanos of this ProcessGroupStatusSnapshotDTO. - :rtype: int + :return: The transferred of this ProcessGroupStatusSnapshotDTO. + :rtype: str """ - return self._processing_nanos + return self._transferred - @processing_nanos.setter - def processing_nanos(self, processing_nanos): + @transferred.setter + def transferred(self, transferred): """ - Sets the processing_nanos of this ProcessGroupStatusSnapshotDTO. + Sets the transferred of this ProcessGroupStatusSnapshotDTO. + The count/size transferred to/from queues in the process group in the last 5 minutes. - :param processing_nanos: The processing_nanos of this ProcessGroupStatusSnapshotDTO. - :type: int + :param transferred: The transferred of this ProcessGroupStatusSnapshotDTO. + :type: str """ - self._processing_nanos = processing_nanos + self._transferred = transferred @property - def processing_performance_status(self): + def versioned_flow_state(self): """ - Gets the processing_performance_status of this ProcessGroupStatusSnapshotDTO. - Represents the processing performance for all the processors in the given process group. + Gets the versioned_flow_state of this ProcessGroupStatusSnapshotDTO. + The current state of the Process Group, as it relates to the Versioned Flow - :return: The processing_performance_status of this ProcessGroupStatusSnapshotDTO. - :rtype: ProcessingPerformanceStatusDTO + :return: The versioned_flow_state of this ProcessGroupStatusSnapshotDTO. + :rtype: str """ - return self._processing_performance_status + return self._versioned_flow_state - @processing_performance_status.setter - def processing_performance_status(self, processing_performance_status): + @versioned_flow_state.setter + def versioned_flow_state(self, versioned_flow_state): """ - Sets the processing_performance_status of this ProcessGroupStatusSnapshotDTO. - Represents the processing performance for all the processors in the given process group. + Sets the versioned_flow_state of this ProcessGroupStatusSnapshotDTO. + The current state of the Process Group, as it relates to the Versioned Flow - :param processing_performance_status: The processing_performance_status of this ProcessGroupStatusSnapshotDTO. - :type: ProcessingPerformanceStatusDTO + :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) + ) - self._processing_performance_status = processing_performance_status + self._versioned_flow_state = versioned_flow_state + + @property + def written(self): + """ + Gets the written of this ProcessGroupStatusSnapshotDTO. + The number of bytes written in the last 5 minutes. + + :return: The written of this ProcessGroupStatusSnapshotDTO. + :rtype: str + """ + return self._written + + @written.setter + def written(self, written): + """ + Sets the written of this ProcessGroupStatusSnapshotDTO. + The number of bytes written in the last 5 minutes. + + :param written: The written of this ProcessGroupStatusSnapshotDTO. + :type: str + """ + + self._written = written def to_dict(self): """ diff --git a/nipyapi/nifi/models/process_group_status_snapshot_entity.py b/nipyapi/nifi/models/process_group_status_snapshot_entity.py index e44575f9..dc65d4a9 100644 --- a/nipyapi/nifi/models/process_group_status_snapshot_entity.py +++ b/nipyapi/nifi/models/process_group_status_snapshot_entity.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,32 +27,53 @@ class ProcessGroupStatusSnapshotEntity(object): and the value is json key in definition. """ swagger_types = { - 'id': 'str', - 'process_group_status_snapshot': 'ProcessGroupStatusSnapshotDTO', - 'can_read': 'bool' - } + 'can_read': 'bool', +'id': 'str', +'process_group_status_snapshot': 'ProcessGroupStatusSnapshotDTO' } attribute_map = { - 'id': 'id', - 'process_group_status_snapshot': 'processGroupStatusSnapshot', - 'can_read': 'canRead' - } + 'can_read': 'canRead', +'id': 'id', +'process_group_status_snapshot': 'processGroupStatusSnapshot' } - def __init__(self, id=None, process_group_status_snapshot=None, can_read=None): + def __init__(self, can_read=None, id=None, process_group_status_snapshot=None): """ ProcessGroupStatusSnapshotEntity - a model defined in Swagger """ + self._can_read = None self._id = None self._process_group_status_snapshot = None - self._can_read = None + if can_read is not None: + self.can_read = can_read if id is not None: self.id = id if process_group_status_snapshot is not None: self.process_group_status_snapshot = process_group_status_snapshot - if can_read is not None: - self.can_read = can_read + + @property + def can_read(self): + """ + Gets the can_read of this ProcessGroupStatusSnapshotEntity. + Indicates whether the user can read a given resource. + + :return: The can_read of this ProcessGroupStatusSnapshotEntity. + :rtype: bool + """ + return self._can_read + + @can_read.setter + def can_read(self, can_read): + """ + Sets the can_read of this ProcessGroupStatusSnapshotEntity. + Indicates whether the user can read a given resource. + + :param can_read: The can_read of this ProcessGroupStatusSnapshotEntity. + :type: bool + """ + + self._can_read = can_read @property def id(self): @@ -99,29 +119,6 @@ def process_group_status_snapshot(self, process_group_status_snapshot): self._process_group_status_snapshot = process_group_status_snapshot - @property - def can_read(self): - """ - Gets the can_read of this ProcessGroupStatusSnapshotEntity. - Indicates whether the user can read a given resource. - - :return: The can_read of this ProcessGroupStatusSnapshotEntity. - :rtype: bool - """ - return self._can_read - - @can_read.setter - def can_read(self, can_read): - """ - Sets the can_read of this ProcessGroupStatusSnapshotEntity. - Indicates whether the user can read a given resource. - - :param can_read: The can_read of this ProcessGroupStatusSnapshotEntity. - :type: bool - """ - - self._can_read = can_read - def to_dict(self): """ Returns the model properties as a dict diff --git a/nipyapi/nifi/models/process_group_upload_entity.py b/nipyapi/nifi/models/process_group_upload_entity.py new file mode 100644 index 00000000..26b7a47a --- /dev/null +++ b/nipyapi/nifi/models/process_group_upload_entity.py @@ -0,0 +1,247 @@ +""" + Apache NiFi REST API + + REST API definition for Apache NiFi web services + + OpenAPI spec version: 2.5.0 + Contact: dev@nifi.apache.org + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from pprint import pformat +import re + + +class ProcessGroupUploadEntity(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 = { + 'disconnected_node_acknowledged': 'bool', +'flow_snapshot': 'RegisteredFlowSnapshot', +'group_id': 'str', +'group_name': 'str', +'position_dto': 'PositionDTO', +'revision_dto': 'RevisionDTO' } + + attribute_map = { + 'disconnected_node_acknowledged': 'disconnectedNodeAcknowledged', +'flow_snapshot': 'flowSnapshot', +'group_id': 'groupId', +'group_name': 'groupName', +'position_dto': 'positionDTO', +'revision_dto': 'revisionDTO' } + + def __init__(self, disconnected_node_acknowledged=None, flow_snapshot=None, group_id=None, group_name=None, position_dto=None, revision_dto=None): + """ + ProcessGroupUploadEntity - a model defined in Swagger + """ + + self._disconnected_node_acknowledged = None + self._flow_snapshot = None + self._group_id = None + self._group_name = None + self._position_dto = None + self._revision_dto = None + + if disconnected_node_acknowledged is not None: + self.disconnected_node_acknowledged = disconnected_node_acknowledged + if flow_snapshot is not None: + self.flow_snapshot = flow_snapshot + if group_id is not None: + self.group_id = group_id + if group_name is not None: + self.group_name = group_name + if position_dto is not None: + self.position_dto = position_dto + if revision_dto is not None: + self.revision_dto = revision_dto + + @property + def disconnected_node_acknowledged(self): + """ + Gets the disconnected_node_acknowledged of this ProcessGroupUploadEntity. + + :return: The disconnected_node_acknowledged of this ProcessGroupUploadEntity. + :rtype: bool + """ + return self._disconnected_node_acknowledged + + @disconnected_node_acknowledged.setter + def disconnected_node_acknowledged(self, disconnected_node_acknowledged): + """ + Sets the disconnected_node_acknowledged of this ProcessGroupUploadEntity. + + :param disconnected_node_acknowledged: The disconnected_node_acknowledged of this ProcessGroupUploadEntity. + :type: bool + """ + + self._disconnected_node_acknowledged = disconnected_node_acknowledged + + @property + def flow_snapshot(self): + """ + Gets the flow_snapshot of this ProcessGroupUploadEntity. + + :return: The flow_snapshot of this ProcessGroupUploadEntity. + :rtype: RegisteredFlowSnapshot + """ + return self._flow_snapshot + + @flow_snapshot.setter + def flow_snapshot(self, flow_snapshot): + """ + Sets the flow_snapshot of this ProcessGroupUploadEntity. + + :param flow_snapshot: The flow_snapshot of this ProcessGroupUploadEntity. + :type: RegisteredFlowSnapshot + """ + + self._flow_snapshot = flow_snapshot + + @property + def group_id(self): + """ + Gets the group_id of this ProcessGroupUploadEntity. + + :return: The group_id of this ProcessGroupUploadEntity. + :rtype: str + """ + return self._group_id + + @group_id.setter + def group_id(self, group_id): + """ + Sets the group_id of this ProcessGroupUploadEntity. + + :param group_id: The group_id of this ProcessGroupUploadEntity. + :type: str + """ + + self._group_id = group_id + + @property + def group_name(self): + """ + Gets the group_name of this ProcessGroupUploadEntity. + + :return: The group_name of this ProcessGroupUploadEntity. + :rtype: str + """ + return self._group_name + + @group_name.setter + def group_name(self, group_name): + """ + Sets the group_name of this ProcessGroupUploadEntity. + + :param group_name: The group_name of this ProcessGroupUploadEntity. + :type: str + """ + + self._group_name = group_name + + @property + def position_dto(self): + """ + Gets the position_dto of this ProcessGroupUploadEntity. + + :return: The position_dto of this ProcessGroupUploadEntity. + :rtype: PositionDTO + """ + return self._position_dto + + @position_dto.setter + def position_dto(self, position_dto): + """ + Sets the position_dto of this ProcessGroupUploadEntity. + + :param position_dto: The position_dto of this ProcessGroupUploadEntity. + :type: PositionDTO + """ + + self._position_dto = position_dto + + @property + def revision_dto(self): + """ + Gets the revision_dto of this ProcessGroupUploadEntity. + + :return: The revision_dto of this ProcessGroupUploadEntity. + :rtype: RevisionDTO + """ + return self._revision_dto + + @revision_dto.setter + def revision_dto(self, revision_dto): + """ + Sets the revision_dto of this ProcessGroupUploadEntity. + + :param revision_dto: The revision_dto of this ProcessGroupUploadEntity. + :type: RevisionDTO + """ + + self._revision_dto = revision_dto + + 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, ProcessGroupUploadEntity): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """ + Returns true if both objects are not equal + """ + return not self == other diff --git a/nipyapi/nifi/models/process_groups_entity.py b/nipyapi/nifi/models/process_groups_entity.py index e819dc5c..2d042f69 100644 --- a/nipyapi/nifi/models/process_groups_entity.py +++ b/nipyapi/nifi/models/process_groups_entity.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,12 +27,10 @@ class ProcessGroupsEntity(object): and the value is json key in definition. """ swagger_types = { - 'process_groups': 'list[ProcessGroupEntity]' - } + 'process_groups': 'list[ProcessGroupEntity]' } attribute_map = { - 'process_groups': 'processGroups' - } + 'process_groups': 'processGroups' } def __init__(self, process_groups=None): """ diff --git a/nipyapi/nifi/models/processgroups_upload_body.py b/nipyapi/nifi/models/processgroups_upload_body.py new file mode 100644 index 00000000..25e6634f --- /dev/null +++ b/nipyapi/nifi/models/processgroups_upload_body.py @@ -0,0 +1,261 @@ +""" + Apache NiFi REST API + + REST API definition for Apache NiFi web services + + OpenAPI spec version: 2.5.0 + Contact: dev@nifi.apache.org + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from pprint import pformat +import re + + +class ProcessgroupsUploadBody(object): + """ + NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. + """ + + + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'client_id': 'str', +'disconnected_node_acknowledged': 'bool', +'file': 'object', +'group_name': 'str', +'position_x': 'float', +'position_y': 'float' } + + attribute_map = { + 'client_id': 'clientId', +'disconnected_node_acknowledged': 'disconnectedNodeAcknowledged', +'file': 'file', +'group_name': 'groupName', +'position_x': 'positionX', +'position_y': 'positionY' } + + def __init__(self, client_id=None, disconnected_node_acknowledged=False, file=None, group_name=None, position_x=None, position_y=None): + """ + ProcessgroupsUploadBody - a model defined in Swagger + """ + + self._client_id = None + self._disconnected_node_acknowledged = None + self._file = None + self._group_name = None + self._position_x = None + self._position_y = None + + self.client_id = client_id + if disconnected_node_acknowledged is not None: + self.disconnected_node_acknowledged = disconnected_node_acknowledged + if file is not None: + self.file = file + self.group_name = group_name + self.position_x = position_x + self.position_y = position_y + + @property + def client_id(self): + """ + Gets the client_id of this ProcessgroupsUploadBody. + The client id. + + :return: The client_id of this ProcessgroupsUploadBody. + :rtype: str + """ + return self._client_id + + @client_id.setter + def client_id(self, client_id): + """ + Sets the client_id of this ProcessgroupsUploadBody. + The client id. + + :param client_id: The client_id of this ProcessgroupsUploadBody. + :type: str + """ + if client_id is None: + raise ValueError("Invalid value for `client_id`, must not be `None`") + + self._client_id = client_id + + @property + def disconnected_node_acknowledged(self): + """ + Gets the disconnected_node_acknowledged of this ProcessgroupsUploadBody. + Acknowledges that this node is disconnected to allow for mutable requests to proceed. + + :return: The disconnected_node_acknowledged of this ProcessgroupsUploadBody. + :rtype: bool + """ + return self._disconnected_node_acknowledged + + @disconnected_node_acknowledged.setter + def disconnected_node_acknowledged(self, disconnected_node_acknowledged): + """ + Sets the disconnected_node_acknowledged of this ProcessgroupsUploadBody. + Acknowledges that this node is disconnected to allow for mutable requests to proceed. + + :param disconnected_node_acknowledged: The disconnected_node_acknowledged of this ProcessgroupsUploadBody. + :type: bool + """ + + self._disconnected_node_acknowledged = disconnected_node_acknowledged + + @property + def file(self): + """ + Gets the file of this ProcessgroupsUploadBody. + + :return: The file of this ProcessgroupsUploadBody. + :rtype: object + """ + return self._file + + @file.setter + def file(self, file): + """ + Sets the file of this ProcessgroupsUploadBody. + + :param file: The file of this ProcessgroupsUploadBody. + :type: object + """ + + self._file = file + + @property + def group_name(self): + """ + Gets the group_name of this ProcessgroupsUploadBody. + The process group name. + + :return: The group_name of this ProcessgroupsUploadBody. + :rtype: str + """ + return self._group_name + + @group_name.setter + def group_name(self, group_name): + """ + Sets the group_name of this ProcessgroupsUploadBody. + The process group name. + + :param group_name: The group_name of this ProcessgroupsUploadBody. + :type: str + """ + if group_name is None: + raise ValueError("Invalid value for `group_name`, must not be `None`") + + self._group_name = group_name + + @property + def position_x(self): + """ + Gets the position_x of this ProcessgroupsUploadBody. + The process group X position. + + :return: The position_x of this ProcessgroupsUploadBody. + :rtype: float + """ + return self._position_x + + @position_x.setter + def position_x(self, position_x): + """ + Sets the position_x of this ProcessgroupsUploadBody. + The process group X position. + + :param position_x: The position_x of this ProcessgroupsUploadBody. + :type: float + """ + if position_x is None: + raise ValueError("Invalid value for `position_x`, must not be `None`") + + self._position_x = position_x + + @property + def position_y(self): + """ + Gets the position_y of this ProcessgroupsUploadBody. + The process group Y position. + + :return: The position_y of this ProcessgroupsUploadBody. + :rtype: float + """ + return self._position_y + + @position_y.setter + def position_y(self, position_y): + """ + Sets the position_y of this ProcessgroupsUploadBody. + The process group Y position. + + :param position_y: The position_y of this ProcessgroupsUploadBody. + :type: float + """ + if position_y is None: + raise ValueError("Invalid value for `position_y`, must not be `None`") + + self._position_y = position_y + + 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, ProcessgroupsUploadBody): + 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/processing_performance_status_dto.py b/nipyapi/nifi/models/processing_performance_status_dto.py index 5bfdc653..816a0309 100644 --- a/nipyapi/nifi/models/processing_performance_status_dto.py +++ b/nipyapi/nifi/models/processing_performance_status_dto.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,93 +27,45 @@ class ProcessingPerformanceStatusDTO(object): and the value is json key in definition. """ swagger_types = { - 'identifier': 'str', - 'cpu_duration': 'int', 'content_read_duration': 'int', - 'content_write_duration': 'int', - 'session_commit_duration': 'int', - 'garbage_collection_duration': 'int' - } +'content_write_duration': 'int', +'cpu_duration': 'int', +'garbage_collection_duration': 'int', +'identifier': 'str', +'session_commit_duration': 'int' } attribute_map = { - 'identifier': 'identifier', - 'cpu_duration': 'cpuDuration', 'content_read_duration': 'contentReadDuration', - 'content_write_duration': 'contentWriteDuration', - 'session_commit_duration': 'sessionCommitDuration', - 'garbage_collection_duration': 'garbageCollectionDuration' - } +'content_write_duration': 'contentWriteDuration', +'cpu_duration': 'cpuDuration', +'garbage_collection_duration': 'garbageCollectionDuration', +'identifier': 'identifier', +'session_commit_duration': 'sessionCommitDuration' } - def __init__(self, identifier=None, cpu_duration=None, content_read_duration=None, content_write_duration=None, session_commit_duration=None, garbage_collection_duration=None): + def __init__(self, content_read_duration=None, content_write_duration=None, cpu_duration=None, garbage_collection_duration=None, identifier=None, session_commit_duration=None): """ ProcessingPerformanceStatusDTO - a model defined in Swagger """ - self._identifier = None - self._cpu_duration = None self._content_read_duration = None self._content_write_duration = None - self._session_commit_duration = None + self._cpu_duration = None self._garbage_collection_duration = None + self._identifier = None + self._session_commit_duration = None - if identifier is not None: - self.identifier = identifier - if cpu_duration is not None: - self.cpu_duration = cpu_duration if content_read_duration is not None: self.content_read_duration = content_read_duration if content_write_duration is not None: self.content_write_duration = content_write_duration - if session_commit_duration is not None: - self.session_commit_duration = session_commit_duration + if cpu_duration is not None: + self.cpu_duration = cpu_duration if garbage_collection_duration is not None: self.garbage_collection_duration = garbage_collection_duration - - @property - def identifier(self): - """ - Gets the identifier of this ProcessingPerformanceStatusDTO. - The unique ID of the process group that the Processor belongs to - - :return: The identifier of this ProcessingPerformanceStatusDTO. - :rtype: str - """ - return self._identifier - - @identifier.setter - def identifier(self, identifier): - """ - Sets the identifier of this ProcessingPerformanceStatusDTO. - The unique ID of the process group that the Processor belongs to - - :param identifier: The identifier of this ProcessingPerformanceStatusDTO. - :type: str - """ - - self._identifier = identifier - - @property - def cpu_duration(self): - """ - Gets the cpu_duration of this ProcessingPerformanceStatusDTO. - The number of nanoseconds has spent on CPU usage in the last 5 minutes. - - :return: The cpu_duration of this ProcessingPerformanceStatusDTO. - :rtype: int - """ - return self._cpu_duration - - @cpu_duration.setter - def cpu_duration(self, cpu_duration): - """ - Sets the cpu_duration of this ProcessingPerformanceStatusDTO. - The number of nanoseconds has spent on CPU usage in the last 5 minutes. - - :param cpu_duration: The cpu_duration of this ProcessingPerformanceStatusDTO. - :type: int - """ - - self._cpu_duration = cpu_duration + if identifier is not None: + self.identifier = identifier + if session_commit_duration is not None: + self.session_commit_duration = session_commit_duration @property def content_read_duration(self): @@ -163,27 +114,27 @@ def content_write_duration(self, content_write_duration): self._content_write_duration = content_write_duration @property - def session_commit_duration(self): + def cpu_duration(self): """ - Gets the session_commit_duration of this ProcessingPerformanceStatusDTO. - The number of nanoseconds has spent running to commit sessions the last 5 minutes. + Gets the cpu_duration of this ProcessingPerformanceStatusDTO. + The number of nanoseconds has spent on CPU usage in the last 5 minutes. - :return: The session_commit_duration of this ProcessingPerformanceStatusDTO. + :return: The cpu_duration of this ProcessingPerformanceStatusDTO. :rtype: int """ - return self._session_commit_duration + return self._cpu_duration - @session_commit_duration.setter - def session_commit_duration(self, session_commit_duration): + @cpu_duration.setter + def cpu_duration(self, cpu_duration): """ - Sets the session_commit_duration of this ProcessingPerformanceStatusDTO. - The number of nanoseconds has spent running to commit sessions the last 5 minutes. + Sets the cpu_duration of this ProcessingPerformanceStatusDTO. + The number of nanoseconds has spent on CPU usage in the last 5 minutes. - :param session_commit_duration: The session_commit_duration of this ProcessingPerformanceStatusDTO. + :param cpu_duration: The cpu_duration of this ProcessingPerformanceStatusDTO. :type: int """ - self._session_commit_duration = session_commit_duration + self._cpu_duration = cpu_duration @property def garbage_collection_duration(self): @@ -208,6 +159,52 @@ def garbage_collection_duration(self, garbage_collection_duration): self._garbage_collection_duration = garbage_collection_duration + @property + def identifier(self): + """ + Gets the identifier of this ProcessingPerformanceStatusDTO. + The unique ID of the process group that the Processor belongs to + + :return: The identifier of this ProcessingPerformanceStatusDTO. + :rtype: str + """ + return self._identifier + + @identifier.setter + def identifier(self, identifier): + """ + Sets the identifier of this ProcessingPerformanceStatusDTO. + The unique ID of the process group that the Processor belongs to + + :param identifier: The identifier of this ProcessingPerformanceStatusDTO. + :type: str + """ + + self._identifier = identifier + + @property + def session_commit_duration(self): + """ + Gets the session_commit_duration of this ProcessingPerformanceStatusDTO. + The number of nanoseconds has spent running to commit sessions the last 5 minutes. + + :return: The session_commit_duration of this ProcessingPerformanceStatusDTO. + :rtype: int + """ + return self._session_commit_duration + + @session_commit_duration.setter + def session_commit_duration(self, session_commit_duration): + """ + Sets the session_commit_duration of this ProcessingPerformanceStatusDTO. + The number of nanoseconds has spent running to commit sessions the last 5 minutes. + + :param session_commit_duration: The session_commit_duration of this ProcessingPerformanceStatusDTO. + :type: int + """ + + self._session_commit_duration = session_commit_duration + def to_dict(self): """ Returns the model properties as a dict diff --git a/nipyapi/nifi/models/processor_config_dto.py b/nipyapi/nifi/models/processor_config_dto.py index bd9f461c..a307cf5c 100644 --- a/nipyapi/nifi/models/processor_config_dto.py +++ b/nipyapi/nifi/models/processor_config_dto.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,311 +27,200 @@ class ProcessorConfigDTO(object): and the value is json key in definition. """ swagger_types = { - 'properties': 'dict(str, str)', - 'descriptors': 'dict(str, PropertyDescriptorDTO)', - 'sensitive_dynamic_property_names': 'list[str]', - 'scheduling_period': 'str', - 'scheduling_strategy': 'str', - 'execution_node': 'str', - 'penalty_duration': 'str', - 'yield_duration': 'str', - 'bulletin_level': 'str', - 'run_duration_millis': 'int', - 'concurrently_schedulable_task_count': 'int', - 'auto_terminated_relationships': 'list[str]', - 'comments': 'str', - 'custom_ui_url': 'str', - 'loss_tolerant': 'bool', 'annotation_data': 'str', - 'default_concurrent_tasks': 'dict(str, str)', - 'default_scheduling_period': 'dict(str, str)', - 'retry_count': 'int', - 'retried_relationships': 'list[str]', - 'backoff_mechanism': 'str', - 'max_backoff_period': 'str' - } +'auto_terminated_relationships': 'list[str]', +'backoff_mechanism': 'str', +'bulletin_level': 'str', +'comments': 'str', +'concurrently_schedulable_task_count': 'int', +'custom_ui_url': 'str', +'default_concurrent_tasks': 'dict(str, str)', +'default_scheduling_period': 'dict(str, str)', +'descriptors': 'dict(str, PropertyDescriptorDTO)', +'execution_node': 'str', +'loss_tolerant': 'bool', +'max_backoff_period': 'str', +'penalty_duration': 'str', +'properties': 'dict(str, str)', +'retried_relationships': 'list[str]', +'retry_count': 'int', +'run_duration_millis': 'int', +'scheduling_period': 'str', +'scheduling_strategy': 'str', +'sensitive_dynamic_property_names': 'list[str]', +'yield_duration': 'str' } attribute_map = { - 'properties': 'properties', - 'descriptors': 'descriptors', - 'sensitive_dynamic_property_names': 'sensitiveDynamicPropertyNames', - 'scheduling_period': 'schedulingPeriod', - 'scheduling_strategy': 'schedulingStrategy', - 'execution_node': 'executionNode', - 'penalty_duration': 'penaltyDuration', - 'yield_duration': 'yieldDuration', - 'bulletin_level': 'bulletinLevel', - 'run_duration_millis': 'runDurationMillis', - 'concurrently_schedulable_task_count': 'concurrentlySchedulableTaskCount', - 'auto_terminated_relationships': 'autoTerminatedRelationships', - 'comments': 'comments', - 'custom_ui_url': 'customUiUrl', - 'loss_tolerant': 'lossTolerant', 'annotation_data': 'annotationData', - 'default_concurrent_tasks': 'defaultConcurrentTasks', - 'default_scheduling_period': 'defaultSchedulingPeriod', - 'retry_count': 'retryCount', - 'retried_relationships': 'retriedRelationships', - 'backoff_mechanism': 'backoffMechanism', - 'max_backoff_period': 'maxBackoffPeriod' - } - - def __init__(self, properties=None, descriptors=None, sensitive_dynamic_property_names=None, scheduling_period=None, scheduling_strategy=None, execution_node=None, penalty_duration=None, yield_duration=None, bulletin_level=None, run_duration_millis=None, concurrently_schedulable_task_count=None, auto_terminated_relationships=None, comments=None, custom_ui_url=None, loss_tolerant=None, annotation_data=None, default_concurrent_tasks=None, default_scheduling_period=None, retry_count=None, retried_relationships=None, backoff_mechanism=None, max_backoff_period=None): +'auto_terminated_relationships': 'autoTerminatedRelationships', +'backoff_mechanism': 'backoffMechanism', +'bulletin_level': 'bulletinLevel', +'comments': 'comments', +'concurrently_schedulable_task_count': 'concurrentlySchedulableTaskCount', +'custom_ui_url': 'customUiUrl', +'default_concurrent_tasks': 'defaultConcurrentTasks', +'default_scheduling_period': 'defaultSchedulingPeriod', +'descriptors': 'descriptors', +'execution_node': 'executionNode', +'loss_tolerant': 'lossTolerant', +'max_backoff_period': 'maxBackoffPeriod', +'penalty_duration': 'penaltyDuration', +'properties': 'properties', +'retried_relationships': 'retriedRelationships', +'retry_count': 'retryCount', +'run_duration_millis': 'runDurationMillis', +'scheduling_period': 'schedulingPeriod', +'scheduling_strategy': 'schedulingStrategy', +'sensitive_dynamic_property_names': 'sensitiveDynamicPropertyNames', +'yield_duration': 'yieldDuration' } + + def __init__(self, annotation_data=None, auto_terminated_relationships=None, backoff_mechanism=None, bulletin_level=None, comments=None, concurrently_schedulable_task_count=None, custom_ui_url=None, default_concurrent_tasks=None, default_scheduling_period=None, descriptors=None, execution_node=None, loss_tolerant=None, max_backoff_period=None, penalty_duration=None, properties=None, retried_relationships=None, retry_count=None, run_duration_millis=None, scheduling_period=None, scheduling_strategy=None, sensitive_dynamic_property_names=None, yield_duration=None): """ ProcessorConfigDTO - a model defined in Swagger """ - self._properties = None - self._descriptors = None - self._sensitive_dynamic_property_names = None - self._scheduling_period = None - self._scheduling_strategy = None - self._execution_node = None - self._penalty_duration = None - self._yield_duration = None - self._bulletin_level = None - self._run_duration_millis = None - self._concurrently_schedulable_task_count = None + self._annotation_data = None self._auto_terminated_relationships = None + self._backoff_mechanism = None + self._bulletin_level = None self._comments = None + self._concurrently_schedulable_task_count = None self._custom_ui_url = None - self._loss_tolerant = None - self._annotation_data = None self._default_concurrent_tasks = None self._default_scheduling_period = None - self._retry_count = None - self._retried_relationships = None - self._backoff_mechanism = None + self._descriptors = None + self._execution_node = None + self._loss_tolerant = None self._max_backoff_period = None + self._penalty_duration = None + self._properties = None + self._retried_relationships = None + self._retry_count = None + self._run_duration_millis = None + self._scheduling_period = None + self._scheduling_strategy = None + self._sensitive_dynamic_property_names = None + self._yield_duration = None - if properties is not None: - self.properties = properties - if descriptors is not None: - self.descriptors = descriptors - if sensitive_dynamic_property_names is not None: - self.sensitive_dynamic_property_names = sensitive_dynamic_property_names - if scheduling_period is not None: - self.scheduling_period = scheduling_period - if scheduling_strategy is not None: - self.scheduling_strategy = scheduling_strategy - if execution_node is not None: - self.execution_node = execution_node - if penalty_duration is not None: - self.penalty_duration = penalty_duration - if yield_duration is not None: - self.yield_duration = yield_duration - if bulletin_level is not None: - self.bulletin_level = bulletin_level - if run_duration_millis is not None: - self.run_duration_millis = run_duration_millis - if concurrently_schedulable_task_count is not None: - self.concurrently_schedulable_task_count = concurrently_schedulable_task_count + if annotation_data is not None: + self.annotation_data = annotation_data if auto_terminated_relationships is not None: self.auto_terminated_relationships = auto_terminated_relationships + if backoff_mechanism is not None: + self.backoff_mechanism = backoff_mechanism + if bulletin_level is not None: + self.bulletin_level = bulletin_level if comments is not None: self.comments = comments + if concurrently_schedulable_task_count is not None: + self.concurrently_schedulable_task_count = concurrently_schedulable_task_count if custom_ui_url is not None: self.custom_ui_url = custom_ui_url - if loss_tolerant is not None: - self.loss_tolerant = loss_tolerant - if annotation_data is not None: - self.annotation_data = annotation_data if default_concurrent_tasks is not None: self.default_concurrent_tasks = default_concurrent_tasks if default_scheduling_period is not None: self.default_scheduling_period = default_scheduling_period - if retry_count is not None: - self.retry_count = retry_count - if retried_relationships is not None: - self.retried_relationships = retried_relationships - if backoff_mechanism is not None: - self.backoff_mechanism = backoff_mechanism + if descriptors is not None: + self.descriptors = descriptors + if execution_node is not None: + self.execution_node = execution_node + if loss_tolerant is not None: + self.loss_tolerant = loss_tolerant if max_backoff_period is not None: self.max_backoff_period = max_backoff_period + if penalty_duration is not None: + self.penalty_duration = penalty_duration + if properties is not None: + self.properties = properties + if retried_relationships is not None: + self.retried_relationships = retried_relationships + if retry_count is not None: + self.retry_count = retry_count + if run_duration_millis is not None: + self.run_duration_millis = run_duration_millis + if scheduling_period is not None: + self.scheduling_period = scheduling_period + if scheduling_strategy is not None: + self.scheduling_strategy = scheduling_strategy + if sensitive_dynamic_property_names is not None: + self.sensitive_dynamic_property_names = sensitive_dynamic_property_names + if yield_duration is not None: + self.yield_duration = yield_duration @property - def properties(self): - """ - Gets the properties of this ProcessorConfigDTO. - The properties for the processor. Properties whose value is not set will only contain the property name. - - :return: The properties of this ProcessorConfigDTO. - :rtype: dict(str, str) - """ - return self._properties - - @properties.setter - def properties(self, properties): - """ - Sets the properties of this ProcessorConfigDTO. - The properties for the processor. Properties whose value is not set will only contain the property name. - - :param properties: The properties of this ProcessorConfigDTO. - :type: dict(str, str) - """ - - self._properties = properties - - @property - def descriptors(self): - """ - Gets the descriptors of this ProcessorConfigDTO. - Descriptors for the processor's properties. - - :return: The descriptors of this ProcessorConfigDTO. - :rtype: dict(str, PropertyDescriptorDTO) - """ - return self._descriptors - - @descriptors.setter - def descriptors(self, descriptors): - """ - Sets the descriptors of this ProcessorConfigDTO. - Descriptors for the processor's properties. - - :param descriptors: The descriptors of this ProcessorConfigDTO. - :type: dict(str, PropertyDescriptorDTO) - """ - - self._descriptors = descriptors - - @property - def sensitive_dynamic_property_names(self): - """ - Gets the sensitive_dynamic_property_names of this ProcessorConfigDTO. - Set of sensitive dynamic property names - - :return: The sensitive_dynamic_property_names of this ProcessorConfigDTO. - :rtype: list[str] - """ - return self._sensitive_dynamic_property_names - - @sensitive_dynamic_property_names.setter - def sensitive_dynamic_property_names(self, sensitive_dynamic_property_names): - """ - Sets the sensitive_dynamic_property_names of this ProcessorConfigDTO. - Set of sensitive dynamic property names - - :param sensitive_dynamic_property_names: The sensitive_dynamic_property_names of this ProcessorConfigDTO. - :type: list[str] - """ - - self._sensitive_dynamic_property_names = sensitive_dynamic_property_names - - @property - def scheduling_period(self): - """ - Gets the scheduling_period of this ProcessorConfigDTO. - The frequency with which to schedule the processor. The format of the value will depend on th value of schedulingStrategy. - - :return: The scheduling_period of this ProcessorConfigDTO. - :rtype: str - """ - return self._scheduling_period - - @scheduling_period.setter - def scheduling_period(self, scheduling_period): - """ - Sets the scheduling_period of this ProcessorConfigDTO. - The frequency with which to schedule the processor. The format of the value will depend on th value of schedulingStrategy. - - :param scheduling_period: The scheduling_period of this ProcessorConfigDTO. - :type: str - """ - - self._scheduling_period = scheduling_period - - @property - def scheduling_strategy(self): - """ - Gets the scheduling_strategy of this ProcessorConfigDTO. - Indcates whether the prcessor should be scheduled to run in event or timer driven mode. - - :return: The scheduling_strategy of this ProcessorConfigDTO. - :rtype: str - """ - return self._scheduling_strategy - - @scheduling_strategy.setter - def scheduling_strategy(self, scheduling_strategy): - """ - Sets the scheduling_strategy of this ProcessorConfigDTO. - Indcates whether the prcessor should be scheduled to run in event or timer driven mode. - - :param scheduling_strategy: The scheduling_strategy of this ProcessorConfigDTO. - :type: str - """ - - self._scheduling_strategy = scheduling_strategy - - @property - def execution_node(self): + def annotation_data(self): """ - Gets the execution_node of this ProcessorConfigDTO. - Indicates the node where the process will execute. + Gets the annotation_data of this ProcessorConfigDTO. + The annotation data for the processor used to relay configuration between a custom UI and the procesosr. - :return: The execution_node of this ProcessorConfigDTO. + :return: The annotation_data of this ProcessorConfigDTO. :rtype: str """ - return self._execution_node + return self._annotation_data - @execution_node.setter - def execution_node(self, execution_node): + @annotation_data.setter + def annotation_data(self, annotation_data): """ - Sets the execution_node of this ProcessorConfigDTO. - Indicates the node where the process will execute. + Sets the annotation_data of this ProcessorConfigDTO. + The annotation data for the processor used to relay configuration between a custom UI and the procesosr. - :param execution_node: The execution_node of this ProcessorConfigDTO. + :param annotation_data: The annotation_data of this ProcessorConfigDTO. :type: str """ - self._execution_node = execution_node + self._annotation_data = annotation_data @property - def penalty_duration(self): + def auto_terminated_relationships(self): """ - Gets the penalty_duration of this ProcessorConfigDTO. - The amount of time that is used when the process penalizes a flowfile. + Gets the auto_terminated_relationships of this ProcessorConfigDTO. + The names of all relationships that cause a flow file to be terminated if the relationship is not connected elsewhere. This property differs from the 'isAutoTerminate' property of the RelationshipDTO in that the RelationshipDTO is meant to depict the current configuration, whereas this property can be set in a DTO when updating a Processor in order to change which Relationships should be auto-terminated. - :return: The penalty_duration of this ProcessorConfigDTO. - :rtype: str + :return: The auto_terminated_relationships of this ProcessorConfigDTO. + :rtype: list[str] """ - return self._penalty_duration + return self._auto_terminated_relationships - @penalty_duration.setter - def penalty_duration(self, penalty_duration): + @auto_terminated_relationships.setter + def auto_terminated_relationships(self, auto_terminated_relationships): """ - Sets the penalty_duration of this ProcessorConfigDTO. - The amount of time that is used when the process penalizes a flowfile. + Sets the auto_terminated_relationships of this ProcessorConfigDTO. + The names of all relationships that cause a flow file to be terminated if the relationship is not connected elsewhere. This property differs from the 'isAutoTerminate' property of the RelationshipDTO in that the RelationshipDTO is meant to depict the current configuration, whereas this property can be set in a DTO when updating a Processor in order to change which Relationships should be auto-terminated. - :param penalty_duration: The penalty_duration of this ProcessorConfigDTO. - :type: str + :param auto_terminated_relationships: The auto_terminated_relationships of this ProcessorConfigDTO. + :type: list[str] """ - self._penalty_duration = penalty_duration + self._auto_terminated_relationships = auto_terminated_relationships @property - def yield_duration(self): + def backoff_mechanism(self): """ - Gets the yield_duration of this ProcessorConfigDTO. - The amount of time that must elapse before this processor is scheduled again after yielding. + Gets the backoff_mechanism of this ProcessorConfigDTO. + Determines whether the FlowFile should be penalized or the processor should be yielded between retries. - :return: The yield_duration of this ProcessorConfigDTO. + :return: The backoff_mechanism of this ProcessorConfigDTO. :rtype: str """ - return self._yield_duration + return self._backoff_mechanism - @yield_duration.setter - def yield_duration(self, yield_duration): + @backoff_mechanism.setter + def backoff_mechanism(self, backoff_mechanism): """ - Sets the yield_duration of this ProcessorConfigDTO. - The amount of time that must elapse before this processor is scheduled again after yielding. + Sets the backoff_mechanism of this ProcessorConfigDTO. + Determines whether the FlowFile should be penalized or the processor should be yielded between retries. - :param yield_duration: The yield_duration of this ProcessorConfigDTO. + :param backoff_mechanism: The backoff_mechanism of this ProcessorConfigDTO. :type: str """ + allowed_values = ["PENALIZE_FLOWFILE", "YIELD_PROCESSOR", ] + if backoff_mechanism not in allowed_values: + raise ValueError( + "Invalid value for `backoff_mechanism` ({0}), must be one of {1}" + .format(backoff_mechanism, allowed_values) + ) - self._yield_duration = yield_duration + self._backoff_mechanism = backoff_mechanism @property def bulletin_level(self): @@ -358,27 +246,27 @@ def bulletin_level(self, bulletin_level): self._bulletin_level = bulletin_level @property - def run_duration_millis(self): + def comments(self): """ - Gets the run_duration_millis of this ProcessorConfigDTO. - The run duration for the processor in milliseconds. + Gets the comments of this ProcessorConfigDTO. + The comments for the processor. - :return: The run_duration_millis of this ProcessorConfigDTO. - :rtype: int + :return: The comments of this ProcessorConfigDTO. + :rtype: str """ - return self._run_duration_millis + return self._comments - @run_duration_millis.setter - def run_duration_millis(self, run_duration_millis): + @comments.setter + def comments(self, comments): """ - Sets the run_duration_millis of this ProcessorConfigDTO. - The run duration for the processor in milliseconds. + Sets the comments of this ProcessorConfigDTO. + The comments for the processor. - :param run_duration_millis: The run_duration_millis of this ProcessorConfigDTO. - :type: int + :param comments: The comments of this ProcessorConfigDTO. + :type: str """ - self._run_duration_millis = run_duration_millis + self._comments = comments @property def concurrently_schedulable_task_count(self): @@ -404,73 +292,119 @@ def concurrently_schedulable_task_count(self, concurrently_schedulable_task_coun self._concurrently_schedulable_task_count = concurrently_schedulable_task_count @property - def auto_terminated_relationships(self): + def custom_ui_url(self): """ - Gets the auto_terminated_relationships of this ProcessorConfigDTO. - The names of all relationships that cause a flow file to be terminated if the relationship is not connected elsewhere. This property differs from the 'isAutoTerminate' property of the RelationshipDTO in that the RelationshipDTO is meant to depict the current configuration, whereas this property can be set in a DTO when updating a Processor in order to change which Relationships should be auto-terminated. + Gets the custom_ui_url of this ProcessorConfigDTO. + The URL for the processor's custom configuration UI if applicable. - :return: The auto_terminated_relationships of this ProcessorConfigDTO. - :rtype: list[str] + :return: The custom_ui_url of this ProcessorConfigDTO. + :rtype: str """ - return self._auto_terminated_relationships + return self._custom_ui_url - @auto_terminated_relationships.setter - def auto_terminated_relationships(self, auto_terminated_relationships): + @custom_ui_url.setter + def custom_ui_url(self, custom_ui_url): """ - Sets the auto_terminated_relationships of this ProcessorConfigDTO. - The names of all relationships that cause a flow file to be terminated if the relationship is not connected elsewhere. This property differs from the 'isAutoTerminate' property of the RelationshipDTO in that the RelationshipDTO is meant to depict the current configuration, whereas this property can be set in a DTO when updating a Processor in order to change which Relationships should be auto-terminated. + Sets the custom_ui_url of this ProcessorConfigDTO. + The URL for the processor's custom configuration UI if applicable. - :param auto_terminated_relationships: The auto_terminated_relationships of this ProcessorConfigDTO. - :type: list[str] + :param custom_ui_url: The custom_ui_url of this ProcessorConfigDTO. + :type: str """ - self._auto_terminated_relationships = auto_terminated_relationships + self._custom_ui_url = custom_ui_url @property - def comments(self): + def default_concurrent_tasks(self): """ - Gets the comments of this ProcessorConfigDTO. - The comments for the processor. + Gets the default_concurrent_tasks of this ProcessorConfigDTO. + Maps default values for concurrent tasks for each applicable scheduling strategy. + + :return: The default_concurrent_tasks of this ProcessorConfigDTO. + :rtype: dict(str, str) + """ + return self._default_concurrent_tasks + + @default_concurrent_tasks.setter + def default_concurrent_tasks(self, default_concurrent_tasks): + """ + Sets the default_concurrent_tasks of this ProcessorConfigDTO. + Maps default values for concurrent tasks for each applicable scheduling strategy. + + :param default_concurrent_tasks: The default_concurrent_tasks of this ProcessorConfigDTO. + :type: dict(str, str) + """ + + self._default_concurrent_tasks = default_concurrent_tasks + + @property + def default_scheduling_period(self): + """ + Gets the default_scheduling_period of this ProcessorConfigDTO. + Maps default values for scheduling period for each applicable scheduling strategy. + + :return: The default_scheduling_period of this ProcessorConfigDTO. + :rtype: dict(str, str) + """ + return self._default_scheduling_period + + @default_scheduling_period.setter + def default_scheduling_period(self, default_scheduling_period): + """ + Sets the default_scheduling_period of this ProcessorConfigDTO. + Maps default values for scheduling period for each applicable scheduling strategy. + + :param default_scheduling_period: The default_scheduling_period of this ProcessorConfigDTO. + :type: dict(str, str) + """ + + self._default_scheduling_period = default_scheduling_period + + @property + def descriptors(self): + """ + Gets the descriptors of this ProcessorConfigDTO. + Descriptors for the processor's properties. - :return: The comments of this ProcessorConfigDTO. - :rtype: str + :return: The descriptors of this ProcessorConfigDTO. + :rtype: dict(str, PropertyDescriptorDTO) """ - return self._comments + return self._descriptors - @comments.setter - def comments(self, comments): + @descriptors.setter + def descriptors(self, descriptors): """ - Sets the comments of this ProcessorConfigDTO. - The comments for the processor. + Sets the descriptors of this ProcessorConfigDTO. + Descriptors for the processor's properties. - :param comments: The comments of this ProcessorConfigDTO. - :type: str + :param descriptors: The descriptors of this ProcessorConfigDTO. + :type: dict(str, PropertyDescriptorDTO) """ - self._comments = comments + self._descriptors = descriptors @property - def custom_ui_url(self): + def execution_node(self): """ - Gets the custom_ui_url of this ProcessorConfigDTO. - The URL for the processor's custom configuration UI if applicable. + Gets the execution_node of this ProcessorConfigDTO. + Indicates the node where the process will execute. - :return: The custom_ui_url of this ProcessorConfigDTO. + :return: The execution_node of this ProcessorConfigDTO. :rtype: str """ - return self._custom_ui_url + return self._execution_node - @custom_ui_url.setter - def custom_ui_url(self, custom_ui_url): + @execution_node.setter + def execution_node(self, execution_node): """ - Sets the custom_ui_url of this ProcessorConfigDTO. - The URL for the processor's custom configuration UI if applicable. + Sets the execution_node of this ProcessorConfigDTO. + Indicates the node where the process will execute. - :param custom_ui_url: The custom_ui_url of this ProcessorConfigDTO. + :param execution_node: The execution_node of this ProcessorConfigDTO. :type: str """ - self._custom_ui_url = custom_ui_url + self._execution_node = execution_node @property def loss_tolerant(self): @@ -496,73 +430,96 @@ def loss_tolerant(self, loss_tolerant): self._loss_tolerant = loss_tolerant @property - def annotation_data(self): + def max_backoff_period(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. + Gets the max_backoff_period of this ProcessorConfigDTO. + Maximum amount of time to be waited during a retry period. - :return: The annotation_data of this ProcessorConfigDTO. + :return: The max_backoff_period of this ProcessorConfigDTO. :rtype: str """ - return self._annotation_data + return self._max_backoff_period - @annotation_data.setter - def annotation_data(self, annotation_data): + @max_backoff_period.setter + def max_backoff_period(self, max_backoff_period): """ - Sets the annotation_data of this ProcessorConfigDTO. - The annotation data for the processor used to relay configuration between a custom UI and the procesosr. + Sets the max_backoff_period of this ProcessorConfigDTO. + Maximum amount of time to be waited during a retry period. - :param annotation_data: The annotation_data of this ProcessorConfigDTO. + :param max_backoff_period: The max_backoff_period of this ProcessorConfigDTO. :type: str """ - self._annotation_data = annotation_data + self._max_backoff_period = max_backoff_period @property - def default_concurrent_tasks(self): + def penalty_duration(self): """ - Gets the default_concurrent_tasks of this ProcessorConfigDTO. - Maps default values for concurrent tasks for each applicable scheduling strategy. + Gets the penalty_duration of this ProcessorConfigDTO. + The amount of time that is used when the process penalizes a flowfile. - :return: The default_concurrent_tasks of this ProcessorConfigDTO. - :rtype: dict(str, str) + :return: The penalty_duration of this ProcessorConfigDTO. + :rtype: str """ - return self._default_concurrent_tasks + return self._penalty_duration - @default_concurrent_tasks.setter - def default_concurrent_tasks(self, default_concurrent_tasks): + @penalty_duration.setter + def penalty_duration(self, penalty_duration): """ - Sets the default_concurrent_tasks of this ProcessorConfigDTO. - Maps default values for concurrent tasks for each applicable scheduling strategy. + Sets the penalty_duration of this ProcessorConfigDTO. + The amount of time that is used when the process penalizes a flowfile. - :param default_concurrent_tasks: The default_concurrent_tasks of this ProcessorConfigDTO. - :type: dict(str, str) + :param penalty_duration: The penalty_duration of this ProcessorConfigDTO. + :type: str """ - self._default_concurrent_tasks = default_concurrent_tasks + self._penalty_duration = penalty_duration @property - def default_scheduling_period(self): + def properties(self): """ - Gets the default_scheduling_period of this ProcessorConfigDTO. - Maps default values for scheduling period for each applicable scheduling strategy. + Gets the properties of this ProcessorConfigDTO. + The properties for the processor. Properties whose value is not set will only contain the property name. - :return: The default_scheduling_period of this ProcessorConfigDTO. + :return: The properties of this ProcessorConfigDTO. :rtype: dict(str, str) """ - return self._default_scheduling_period + return self._properties - @default_scheduling_period.setter - def default_scheduling_period(self, default_scheduling_period): + @properties.setter + def properties(self, properties): """ - Sets the default_scheduling_period of this ProcessorConfigDTO. - Maps default values for scheduling period for each applicable scheduling strategy. + Sets the properties of this ProcessorConfigDTO. + The properties for the processor. Properties whose value is not set will only contain the property name. - :param default_scheduling_period: The default_scheduling_period of this ProcessorConfigDTO. + :param properties: The properties of this ProcessorConfigDTO. :type: dict(str, str) """ - self._default_scheduling_period = default_scheduling_period + self._properties = properties + + @property + def retried_relationships(self): + """ + Gets the retried_relationships of this ProcessorConfigDTO. + All the relationships should be retried. + + :return: The retried_relationships of this ProcessorConfigDTO. + :rtype: list[str] + """ + return self._retried_relationships + + @retried_relationships.setter + def retried_relationships(self, retried_relationships): + """ + Sets the retried_relationships of this ProcessorConfigDTO. + All the relationships should be retried. + + :param retried_relationships: The retried_relationships of this ProcessorConfigDTO. + :type: list[str] + """ + + self._retried_relationships = retried_relationships @property def retry_count(self): @@ -588,79 +545,119 @@ def retry_count(self, retry_count): self._retry_count = retry_count @property - def retried_relationships(self): + def run_duration_millis(self): """ - Gets the retried_relationships of this ProcessorConfigDTO. - All the relationships should be retried. + Gets the run_duration_millis of this ProcessorConfigDTO. + The run duration for the processor in milliseconds. - :return: The retried_relationships of this ProcessorConfigDTO. - :rtype: list[str] + :return: The run_duration_millis of this ProcessorConfigDTO. + :rtype: int """ - return self._retried_relationships + return self._run_duration_millis - @retried_relationships.setter - def retried_relationships(self, retried_relationships): + @run_duration_millis.setter + def run_duration_millis(self, run_duration_millis): """ - Sets the retried_relationships of this ProcessorConfigDTO. - All the relationships should be retried. + Sets the run_duration_millis of this ProcessorConfigDTO. + The run duration for the processor in milliseconds. - :param retried_relationships: The retried_relationships of this ProcessorConfigDTO. - :type: list[str] + :param run_duration_millis: The run_duration_millis of this ProcessorConfigDTO. + :type: int """ - self._retried_relationships = retried_relationships + self._run_duration_millis = run_duration_millis @property - def backoff_mechanism(self): + def scheduling_period(self): """ - Gets the backoff_mechanism of this ProcessorConfigDTO. - Determines whether the FlowFile should be penalized or the processor should be yielded between retries. + Gets the scheduling_period of this ProcessorConfigDTO. + The frequency with which to schedule the processor. The format of the value will depend on th value of schedulingStrategy. - :return: The backoff_mechanism of this ProcessorConfigDTO. + :return: The scheduling_period of this ProcessorConfigDTO. :rtype: str """ - return self._backoff_mechanism + return self._scheduling_period - @backoff_mechanism.setter - def backoff_mechanism(self, backoff_mechanism): + @scheduling_period.setter + def scheduling_period(self, scheduling_period): """ - Sets the backoff_mechanism of this ProcessorConfigDTO. - Determines whether the FlowFile should be penalized or the processor should be yielded between retries. + Sets the scheduling_period of this ProcessorConfigDTO. + The frequency with which to schedule the processor. The format of the value will depend on th value of schedulingStrategy. - :param backoff_mechanism: The backoff_mechanism of this ProcessorConfigDTO. + :param scheduling_period: The scheduling_period of this ProcessorConfigDTO. :type: str """ - allowed_values = ["PENALIZE_FLOWFILE", "YIELD_PROCESSOR"] - if backoff_mechanism not in allowed_values: - raise ValueError( - "Invalid value for `backoff_mechanism` ({0}), must be one of {1}" - .format(backoff_mechanism, allowed_values) - ) - self._backoff_mechanism = backoff_mechanism + self._scheduling_period = scheduling_period @property - def max_backoff_period(self): + def scheduling_strategy(self): """ - Gets the max_backoff_period of this ProcessorConfigDTO. - Maximum amount of time to be waited during a retry period. + Gets the scheduling_strategy of this ProcessorConfigDTO. + Indicates how the processor should be scheduled to run. - :return: The max_backoff_period of this ProcessorConfigDTO. + :return: The scheduling_strategy of this ProcessorConfigDTO. :rtype: str """ - return self._max_backoff_period + return self._scheduling_strategy - @max_backoff_period.setter - def max_backoff_period(self, max_backoff_period): + @scheduling_strategy.setter + def scheduling_strategy(self, scheduling_strategy): """ - Sets the max_backoff_period of this ProcessorConfigDTO. - Maximum amount of time to be waited during a retry period. + Sets the scheduling_strategy of this ProcessorConfigDTO. + Indicates how the processor should be scheduled to run. - :param max_backoff_period: The max_backoff_period of this ProcessorConfigDTO. + :param scheduling_strategy: The scheduling_strategy of this ProcessorConfigDTO. :type: str """ - self._max_backoff_period = max_backoff_period + self._scheduling_strategy = scheduling_strategy + + @property + def sensitive_dynamic_property_names(self): + """ + Gets the sensitive_dynamic_property_names of this ProcessorConfigDTO. + Set of sensitive dynamic property names + + :return: The sensitive_dynamic_property_names of this ProcessorConfigDTO. + :rtype: list[str] + """ + return self._sensitive_dynamic_property_names + + @sensitive_dynamic_property_names.setter + def sensitive_dynamic_property_names(self, sensitive_dynamic_property_names): + """ + Sets the sensitive_dynamic_property_names of this ProcessorConfigDTO. + Set of sensitive dynamic property names + + :param sensitive_dynamic_property_names: The sensitive_dynamic_property_names of this ProcessorConfigDTO. + :type: list[str] + """ + + self._sensitive_dynamic_property_names = sensitive_dynamic_property_names + + @property + def yield_duration(self): + """ + Gets the yield_duration of this ProcessorConfigDTO. + The amount of time that must elapse before this processor is scheduled again after yielding. + + :return: The yield_duration of this ProcessorConfigDTO. + :rtype: str + """ + return self._yield_duration + + @yield_duration.setter + def yield_duration(self, yield_duration): + """ + Sets the yield_duration of this ProcessorConfigDTO. + The amount of time that must elapse before this processor is scheduled again after yielding. + + :param yield_duration: The yield_duration of this ProcessorConfigDTO. + :type: str + """ + + self._yield_duration = yield_duration def to_dict(self): """ diff --git a/nipyapi/nifi/models/processor_configuration.py b/nipyapi/nifi/models/processor_configuration.py new file mode 100644 index 00000000..d3312229 --- /dev/null +++ b/nipyapi/nifi/models/processor_configuration.py @@ -0,0 +1,147 @@ +""" + Apache NiFi REST API + + REST API definition for Apache NiFi web services + + OpenAPI spec version: 2.5.0 + Contact: dev@nifi.apache.org + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from pprint import pformat +import re + + +class ProcessorConfiguration(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 = { + 'configuration': 'str', +'processor_class_name': 'str' } + + attribute_map = { + 'configuration': 'configuration', +'processor_class_name': 'processorClassName' } + + def __init__(self, configuration=None, processor_class_name=None): + """ + ProcessorConfiguration - a model defined in Swagger + """ + + self._configuration = None + self._processor_class_name = None + + if configuration is not None: + self.configuration = configuration + if processor_class_name is not None: + self.processor_class_name = processor_class_name + + @property + def configuration(self): + """ + Gets the configuration of this ProcessorConfiguration. + A description of how the Processor should be configured in order to accomplish the use case + + :return: The configuration of this ProcessorConfiguration. + :rtype: str + """ + return self._configuration + + @configuration.setter + def configuration(self, configuration): + """ + Sets the configuration of this ProcessorConfiguration. + A description of how the Processor should be configured in order to accomplish the use case + + :param configuration: The configuration of this ProcessorConfiguration. + :type: str + """ + + self._configuration = configuration + + @property + def processor_class_name(self): + """ + Gets the processor_class_name of this ProcessorConfiguration. + The fully qualified classname of the Processor that should be used to accomplish the use case + + :return: The processor_class_name of this ProcessorConfiguration. + :rtype: str + """ + return self._processor_class_name + + @processor_class_name.setter + def processor_class_name(self, processor_class_name): + """ + Sets the processor_class_name of this ProcessorConfiguration. + The fully qualified classname of the Processor that should be used to accomplish the use case + + :param processor_class_name: The processor_class_name of this ProcessorConfiguration. + :type: str + """ + + self._processor_class_name = processor_class_name + + 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, ProcessorConfiguration): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """ + Returns true if both objects are not equal + """ + return not self == other diff --git a/nipyapi/nifi/models/processor_definition.py b/nipyapi/nifi/models/processor_definition.py index 8015a21a..d52ae958 100644 --- a/nipyapi/nifi/models/processor_definition.py +++ b/nipyapi/nifi/models/processor_definition.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,249 +27,253 @@ class ProcessorDefinition(object): and the value is json key in definition. """ swagger_types = { - 'group': 'str', - 'artifact': 'str', - 'version': 'str', - 'type': 'str', - 'type_description': 'str', - 'build_info': 'BuildInfo', - 'provided_api_implementations': 'list[DefinedType]', - 'tags': 'list[str]', - 'see_also': 'list[str]', - 'deprecated': 'bool', - 'deprecation_reason': 'str', - 'deprecation_alternatives': 'list[str]', - 'restricted': 'bool', - 'restricted_explanation': 'str', - 'explicit_restrictions': 'list[Restriction]', - 'stateful': 'Stateful', - 'system_resource_considerations': 'list[SystemResourceConsideration]', 'additional_details': 'bool', - 'property_descriptors': 'dict(str, PropertyDescriptor)', - 'supports_dynamic_properties': 'bool', - 'supports_sensitive_dynamic_properties': 'bool', - 'dynamic_properties': 'list[DynamicProperty]', - 'input_requirement': 'str', - 'supported_relationships': 'list[Relationship]', - 'supports_dynamic_relationships': 'bool', - 'dynamic_relationship': 'DynamicRelationship', - 'trigger_serially': 'bool', - 'trigger_when_empty': 'bool', - 'trigger_when_any_destination_available': 'bool', - 'supports_batching': 'bool', - 'supports_event_driven': 'bool', - 'primary_node_only': 'bool', - 'side_effect_free': 'bool', - 'supported_scheduling_strategies': 'list[str]', - 'default_scheduling_strategy': 'str', - 'default_concurrent_tasks_by_scheduling_strategy': 'dict(str, int)', - 'default_scheduling_period_by_scheduling_strategy': 'dict(str, str)', - 'default_penalty_duration': 'str', - 'default_yield_duration': 'str', - 'default_bulletin_level': 'str', - 'reads_attributes': 'list[Attribute]', - 'writes_attributes': 'list[Attribute]' - } +'artifact': 'str', +'build_info': 'BuildInfo', +'default_bulletin_level': 'str', +'default_concurrent_tasks_by_scheduling_strategy': 'dict(str, int)', +'default_penalty_duration': 'str', +'default_scheduling_period_by_scheduling_strategy': 'dict(str, str)', +'default_scheduling_strategy': 'str', +'default_yield_duration': 'str', +'deprecated': 'bool', +'deprecation_alternatives': 'list[str]', +'deprecation_reason': 'str', +'dynamic_properties': 'list[DynamicProperty]', +'dynamic_relationship': 'DynamicRelationship', +'explicit_restrictions': 'list[Restriction]', +'group': 'str', +'input_requirement': 'str', +'multi_processor_use_cases': 'list[MultiProcessorUseCase]', +'primary_node_only': 'bool', +'property_descriptors': 'dict(str, PropertyDescriptor)', +'provided_api_implementations': 'list[DefinedType]', +'reads_attributes': 'list[Attribute]', +'restricted': 'bool', +'restricted_explanation': 'str', +'see_also': 'list[str]', +'side_effect_free': 'bool', +'stateful': 'Stateful', +'supported_relationships': 'list[Relationship]', +'supported_scheduling_strategies': 'list[str]', +'supports_batching': 'bool', +'supports_dynamic_properties': 'bool', +'supports_dynamic_relationships': 'bool', +'supports_sensitive_dynamic_properties': 'bool', +'system_resource_considerations': 'list[SystemResourceConsideration]', +'tags': 'list[str]', +'trigger_serially': 'bool', +'trigger_when_any_destination_available': 'bool', +'trigger_when_empty': 'bool', +'type': 'str', +'type_description': 'str', +'use_cases': 'list[UseCase]', +'version': 'str', +'writes_attributes': 'list[Attribute]' } attribute_map = { - 'group': 'group', - 'artifact': 'artifact', - 'version': 'version', - 'type': 'type', - 'type_description': 'typeDescription', - 'build_info': 'buildInfo', - 'provided_api_implementations': 'providedApiImplementations', - 'tags': 'tags', - 'see_also': 'seeAlso', - 'deprecated': 'deprecated', - 'deprecation_reason': 'deprecationReason', - 'deprecation_alternatives': 'deprecationAlternatives', - 'restricted': 'restricted', - 'restricted_explanation': 'restrictedExplanation', - 'explicit_restrictions': 'explicitRestrictions', - 'stateful': 'stateful', - 'system_resource_considerations': 'systemResourceConsiderations', 'additional_details': 'additionalDetails', - 'property_descriptors': 'propertyDescriptors', - 'supports_dynamic_properties': 'supportsDynamicProperties', - 'supports_sensitive_dynamic_properties': 'supportsSensitiveDynamicProperties', - 'dynamic_properties': 'dynamicProperties', - 'input_requirement': 'inputRequirement', - 'supported_relationships': 'supportedRelationships', - 'supports_dynamic_relationships': 'supportsDynamicRelationships', - 'dynamic_relationship': 'dynamicRelationship', - 'trigger_serially': 'triggerSerially', - 'trigger_when_empty': 'triggerWhenEmpty', - 'trigger_when_any_destination_available': 'triggerWhenAnyDestinationAvailable', - 'supports_batching': 'supportsBatching', - 'supports_event_driven': 'supportsEventDriven', - 'primary_node_only': 'primaryNodeOnly', - 'side_effect_free': 'sideEffectFree', - 'supported_scheduling_strategies': 'supportedSchedulingStrategies', - 'default_scheduling_strategy': 'defaultSchedulingStrategy', - 'default_concurrent_tasks_by_scheduling_strategy': 'defaultConcurrentTasksBySchedulingStrategy', - 'default_scheduling_period_by_scheduling_strategy': 'defaultSchedulingPeriodBySchedulingStrategy', - 'default_penalty_duration': 'defaultPenaltyDuration', - 'default_yield_duration': 'defaultYieldDuration', - 'default_bulletin_level': 'defaultBulletinLevel', - 'reads_attributes': 'readsAttributes', - 'writes_attributes': 'writesAttributes' - } - - def __init__(self, group=None, artifact=None, version=None, type=None, type_description=None, build_info=None, provided_api_implementations=None, tags=None, see_also=None, deprecated=None, deprecation_reason=None, deprecation_alternatives=None, restricted=None, restricted_explanation=None, explicit_restrictions=None, stateful=None, system_resource_considerations=None, additional_details=None, property_descriptors=None, supports_dynamic_properties=None, supports_sensitive_dynamic_properties=None, dynamic_properties=None, input_requirement=None, supported_relationships=None, supports_dynamic_relationships=None, dynamic_relationship=None, trigger_serially=None, trigger_when_empty=None, trigger_when_any_destination_available=None, supports_batching=None, supports_event_driven=None, primary_node_only=None, side_effect_free=None, supported_scheduling_strategies=None, default_scheduling_strategy=None, default_concurrent_tasks_by_scheduling_strategy=None, default_scheduling_period_by_scheduling_strategy=None, default_penalty_duration=None, default_yield_duration=None, default_bulletin_level=None, reads_attributes=None, writes_attributes=None): +'artifact': 'artifact', +'build_info': 'buildInfo', +'default_bulletin_level': 'defaultBulletinLevel', +'default_concurrent_tasks_by_scheduling_strategy': 'defaultConcurrentTasksBySchedulingStrategy', +'default_penalty_duration': 'defaultPenaltyDuration', +'default_scheduling_period_by_scheduling_strategy': 'defaultSchedulingPeriodBySchedulingStrategy', +'default_scheduling_strategy': 'defaultSchedulingStrategy', +'default_yield_duration': 'defaultYieldDuration', +'deprecated': 'deprecated', +'deprecation_alternatives': 'deprecationAlternatives', +'deprecation_reason': 'deprecationReason', +'dynamic_properties': 'dynamicProperties', +'dynamic_relationship': 'dynamicRelationship', +'explicit_restrictions': 'explicitRestrictions', +'group': 'group', +'input_requirement': 'inputRequirement', +'multi_processor_use_cases': 'multiProcessorUseCases', +'primary_node_only': 'primaryNodeOnly', +'property_descriptors': 'propertyDescriptors', +'provided_api_implementations': 'providedApiImplementations', +'reads_attributes': 'readsAttributes', +'restricted': 'restricted', +'restricted_explanation': 'restrictedExplanation', +'see_also': 'seeAlso', +'side_effect_free': 'sideEffectFree', +'stateful': 'stateful', +'supported_relationships': 'supportedRelationships', +'supported_scheduling_strategies': 'supportedSchedulingStrategies', +'supports_batching': 'supportsBatching', +'supports_dynamic_properties': 'supportsDynamicProperties', +'supports_dynamic_relationships': 'supportsDynamicRelationships', +'supports_sensitive_dynamic_properties': 'supportsSensitiveDynamicProperties', +'system_resource_considerations': 'systemResourceConsiderations', +'tags': 'tags', +'trigger_serially': 'triggerSerially', +'trigger_when_any_destination_available': 'triggerWhenAnyDestinationAvailable', +'trigger_when_empty': 'triggerWhenEmpty', +'type': 'type', +'type_description': 'typeDescription', +'use_cases': 'useCases', +'version': 'version', +'writes_attributes': 'writesAttributes' } + + def __init__(self, additional_details=None, artifact=None, build_info=None, default_bulletin_level=None, default_concurrent_tasks_by_scheduling_strategy=None, default_penalty_duration=None, default_scheduling_period_by_scheduling_strategy=None, default_scheduling_strategy=None, default_yield_duration=None, deprecated=None, deprecation_alternatives=None, deprecation_reason=None, dynamic_properties=None, dynamic_relationship=None, explicit_restrictions=None, group=None, input_requirement=None, multi_processor_use_cases=None, primary_node_only=None, property_descriptors=None, provided_api_implementations=None, reads_attributes=None, restricted=None, restricted_explanation=None, see_also=None, side_effect_free=None, stateful=None, supported_relationships=None, supported_scheduling_strategies=None, supports_batching=None, supports_dynamic_properties=None, supports_dynamic_relationships=None, supports_sensitive_dynamic_properties=None, system_resource_considerations=None, tags=None, trigger_serially=None, trigger_when_any_destination_available=None, trigger_when_empty=None, type=None, type_description=None, use_cases=None, version=None, writes_attributes=None): """ ProcessorDefinition - a model defined in Swagger """ - self._group = None + self._additional_details = None self._artifact = None - self._version = None - self._type = None - self._type_description = None self._build_info = None - self._provided_api_implementations = None - self._tags = None - self._see_also = None + self._default_bulletin_level = None + self._default_concurrent_tasks_by_scheduling_strategy = None + self._default_penalty_duration = None + self._default_scheduling_period_by_scheduling_strategy = None + self._default_scheduling_strategy = None + self._default_yield_duration = None self._deprecated = None - self._deprecation_reason = None self._deprecation_alternatives = None + self._deprecation_reason = None + self._dynamic_properties = None + self._dynamic_relationship = None + self._explicit_restrictions = None + self._group = None + self._input_requirement = None + self._multi_processor_use_cases = None + self._primary_node_only = None + self._property_descriptors = None + self._provided_api_implementations = None + self._reads_attributes = None self._restricted = None self._restricted_explanation = None - self._explicit_restrictions = None + self._see_also = None + self._side_effect_free = None self._stateful = None - self._system_resource_considerations = None - self._additional_details = None - self._property_descriptors = None - self._supports_dynamic_properties = None - self._supports_sensitive_dynamic_properties = None - self._dynamic_properties = None - self._input_requirement = None self._supported_relationships = None + self._supported_scheduling_strategies = None + self._supports_batching = None + self._supports_dynamic_properties = None self._supports_dynamic_relationships = None - self._dynamic_relationship = None + self._supports_sensitive_dynamic_properties = None + self._system_resource_considerations = None + self._tags = None self._trigger_serially = None - self._trigger_when_empty = None self._trigger_when_any_destination_available = None - self._supports_batching = None - self._supports_event_driven = None - self._primary_node_only = None - self._side_effect_free = None - self._supported_scheduling_strategies = None - self._default_scheduling_strategy = None - self._default_concurrent_tasks_by_scheduling_strategy = None - self._default_scheduling_period_by_scheduling_strategy = None - self._default_penalty_duration = None - self._default_yield_duration = None - self._default_bulletin_level = None - self._reads_attributes = None + self._trigger_when_empty = None + self._type = None + self._type_description = None + self._use_cases = None + self._version = None self._writes_attributes = None - if group is not None: - self.group = group + if additional_details is not None: + self.additional_details = additional_details if artifact is not None: self.artifact = artifact - if version is not None: - self.version = version - self.type = type - if type_description is not None: - self.type_description = type_description if build_info is not None: self.build_info = build_info - if provided_api_implementations is not None: - self.provided_api_implementations = provided_api_implementations - if tags is not None: - self.tags = tags - if see_also is not None: - self.see_also = see_also + if default_bulletin_level is not None: + self.default_bulletin_level = default_bulletin_level + if default_concurrent_tasks_by_scheduling_strategy is not None: + self.default_concurrent_tasks_by_scheduling_strategy = default_concurrent_tasks_by_scheduling_strategy + if default_penalty_duration is not None: + self.default_penalty_duration = default_penalty_duration + if default_scheduling_period_by_scheduling_strategy is not None: + self.default_scheduling_period_by_scheduling_strategy = default_scheduling_period_by_scheduling_strategy + if default_scheduling_strategy is not None: + self.default_scheduling_strategy = default_scheduling_strategy + if default_yield_duration is not None: + self.default_yield_duration = default_yield_duration if deprecated is not None: self.deprecated = deprecated - if deprecation_reason is not None: - self.deprecation_reason = deprecation_reason if deprecation_alternatives is not None: self.deprecation_alternatives = deprecation_alternatives + if deprecation_reason is not None: + self.deprecation_reason = deprecation_reason + if dynamic_properties is not None: + self.dynamic_properties = dynamic_properties + if dynamic_relationship is not None: + self.dynamic_relationship = dynamic_relationship + if explicit_restrictions is not None: + self.explicit_restrictions = explicit_restrictions + if group is not None: + self.group = group + if input_requirement is not None: + self.input_requirement = input_requirement + if multi_processor_use_cases is not None: + self.multi_processor_use_cases = multi_processor_use_cases + if primary_node_only is not None: + self.primary_node_only = primary_node_only + if property_descriptors is not None: + self.property_descriptors = property_descriptors + if provided_api_implementations is not None: + self.provided_api_implementations = provided_api_implementations + if reads_attributes is not None: + self.reads_attributes = reads_attributes if restricted is not None: self.restricted = restricted if restricted_explanation is not None: self.restricted_explanation = restricted_explanation - if explicit_restrictions is not None: - self.explicit_restrictions = explicit_restrictions + if see_also is not None: + self.see_also = see_also + if side_effect_free is not None: + self.side_effect_free = side_effect_free if stateful is not None: self.stateful = stateful - if system_resource_considerations is not None: - self.system_resource_considerations = system_resource_considerations - if additional_details is not None: - self.additional_details = additional_details - if property_descriptors is not None: - self.property_descriptors = property_descriptors - if supports_dynamic_properties is not None: - self.supports_dynamic_properties = supports_dynamic_properties - if supports_sensitive_dynamic_properties is not None: - self.supports_sensitive_dynamic_properties = supports_sensitive_dynamic_properties - if dynamic_properties is not None: - self.dynamic_properties = dynamic_properties - if input_requirement is not None: - self.input_requirement = input_requirement if supported_relationships is not None: self.supported_relationships = supported_relationships + if supported_scheduling_strategies is not None: + self.supported_scheduling_strategies = supported_scheduling_strategies + if supports_batching is not None: + self.supports_batching = supports_batching + if supports_dynamic_properties is not None: + self.supports_dynamic_properties = supports_dynamic_properties if supports_dynamic_relationships is not None: self.supports_dynamic_relationships = supports_dynamic_relationships - if dynamic_relationship is not None: - self.dynamic_relationship = dynamic_relationship + if supports_sensitive_dynamic_properties is not None: + self.supports_sensitive_dynamic_properties = supports_sensitive_dynamic_properties + if system_resource_considerations is not None: + self.system_resource_considerations = system_resource_considerations + if tags is not None: + self.tags = tags if trigger_serially is not None: self.trigger_serially = trigger_serially - if trigger_when_empty is not None: - self.trigger_when_empty = trigger_when_empty if trigger_when_any_destination_available is not None: self.trigger_when_any_destination_available = trigger_when_any_destination_available - if supports_batching is not None: - self.supports_batching = supports_batching - if supports_event_driven is not None: - self.supports_event_driven = supports_event_driven - if primary_node_only is not None: - self.primary_node_only = primary_node_only - if side_effect_free is not None: - self.side_effect_free = side_effect_free - if supported_scheduling_strategies is not None: - self.supported_scheduling_strategies = supported_scheduling_strategies - if default_scheduling_strategy is not None: - self.default_scheduling_strategy = default_scheduling_strategy - if default_concurrent_tasks_by_scheduling_strategy is not None: - self.default_concurrent_tasks_by_scheduling_strategy = default_concurrent_tasks_by_scheduling_strategy - if default_scheduling_period_by_scheduling_strategy is not None: - self.default_scheduling_period_by_scheduling_strategy = default_scheduling_period_by_scheduling_strategy - if default_penalty_duration is not None: - self.default_penalty_duration = default_penalty_duration - if default_yield_duration is not None: - self.default_yield_duration = default_yield_duration - if default_bulletin_level is not None: - self.default_bulletin_level = default_bulletin_level - if reads_attributes is not None: - self.reads_attributes = reads_attributes + if trigger_when_empty is not None: + self.trigger_when_empty = trigger_when_empty + if type is not None: + self.type = type + if type_description is not None: + self.type_description = type_description + if use_cases is not None: + self.use_cases = use_cases + if version is not None: + self.version = version if writes_attributes is not None: self.writes_attributes = writes_attributes @property - def group(self): + def additional_details(self): """ - Gets the group of this ProcessorDefinition. - The group name of the bundle that provides the referenced type. + Gets the additional_details of this ProcessorDefinition. + Indicates if the component has additional details documentation - :return: The group of this ProcessorDefinition. - :rtype: str + :return: The additional_details of this ProcessorDefinition. + :rtype: bool """ - return self._group + return self._additional_details - @group.setter - def group(self, group): + @additional_details.setter + def additional_details(self, additional_details): """ - Sets the group of this ProcessorDefinition. - The group name of the bundle that provides the referenced type. + Sets the additional_details of this ProcessorDefinition. + Indicates if the component has additional details documentation - :param group: The group of this ProcessorDefinition. - :type: str + :param additional_details: The additional_details of this ProcessorDefinition. + :type: bool """ - self._group = group + self._additional_details = additional_details @property def artifact(self): @@ -296,167 +299,163 @@ def artifact(self, artifact): self._artifact = artifact @property - def version(self): + def build_info(self): """ - Gets the version of this ProcessorDefinition. - The version of the bundle that provides the referenced type. + Gets the build_info of this ProcessorDefinition. - :return: The version of this ProcessorDefinition. - :rtype: str + :return: The build_info of this ProcessorDefinition. + :rtype: BuildInfo """ - return self._version + return self._build_info - @version.setter - def version(self, version): + @build_info.setter + def build_info(self, build_info): """ - Sets the version of this ProcessorDefinition. - The version of the bundle that provides the referenced type. + Sets the build_info of this ProcessorDefinition. - :param version: The version of this ProcessorDefinition. - :type: str + :param build_info: The build_info of this ProcessorDefinition. + :type: BuildInfo """ - self._version = version + self._build_info = build_info @property - def type(self): + def default_bulletin_level(self): """ - Gets the type of this ProcessorDefinition. - The fully-qualified class type + Gets the default_bulletin_level of this ProcessorDefinition. + The default bulletin level, such as WARN, INFO, DEBUG, etc. - :return: The type of this ProcessorDefinition. + :return: The default_bulletin_level of this ProcessorDefinition. :rtype: str """ - return self._type + return self._default_bulletin_level - @type.setter - def type(self, type): + @default_bulletin_level.setter + def default_bulletin_level(self, default_bulletin_level): """ - Sets the type of this ProcessorDefinition. - The fully-qualified class type + Sets the default_bulletin_level of this ProcessorDefinition. + The default bulletin level, such as WARN, INFO, DEBUG, etc. - :param type: The type of this ProcessorDefinition. + :param default_bulletin_level: The default_bulletin_level of this ProcessorDefinition. :type: str """ - if type is None: - raise ValueError("Invalid value for `type`, must not be `None`") - self._type = type + self._default_bulletin_level = default_bulletin_level @property - def type_description(self): + def default_concurrent_tasks_by_scheduling_strategy(self): """ - Gets the type_description of this ProcessorDefinition. - The description of the type. + Gets the default_concurrent_tasks_by_scheduling_strategy of this ProcessorDefinition. + The default concurrent tasks for each scheduling strategy. - :return: The type_description of this ProcessorDefinition. - :rtype: str + :return: The default_concurrent_tasks_by_scheduling_strategy of this ProcessorDefinition. + :rtype: dict(str, int) """ - return self._type_description + return self._default_concurrent_tasks_by_scheduling_strategy - @type_description.setter - def type_description(self, type_description): + @default_concurrent_tasks_by_scheduling_strategy.setter + def default_concurrent_tasks_by_scheduling_strategy(self, default_concurrent_tasks_by_scheduling_strategy): """ - Sets the type_description of this ProcessorDefinition. - The description of the type. + Sets the default_concurrent_tasks_by_scheduling_strategy of this ProcessorDefinition. + The default concurrent tasks for each scheduling strategy. - :param type_description: The type_description of this ProcessorDefinition. - :type: str + :param default_concurrent_tasks_by_scheduling_strategy: The default_concurrent_tasks_by_scheduling_strategy of this ProcessorDefinition. + :type: dict(str, int) """ - self._type_description = type_description + self._default_concurrent_tasks_by_scheduling_strategy = default_concurrent_tasks_by_scheduling_strategy @property - def build_info(self): + def default_penalty_duration(self): """ - Gets the build_info of this ProcessorDefinition. - The build metadata for this component + Gets the default_penalty_duration of this ProcessorDefinition. + The default penalty duration as a time period, such as \"30 sec\". - :return: The build_info of this ProcessorDefinition. - :rtype: BuildInfo + :return: The default_penalty_duration of this ProcessorDefinition. + :rtype: str """ - return self._build_info + return self._default_penalty_duration - @build_info.setter - def build_info(self, build_info): + @default_penalty_duration.setter + def default_penalty_duration(self, default_penalty_duration): """ - Sets the build_info of this ProcessorDefinition. - The build metadata for this component + Sets the default_penalty_duration of this ProcessorDefinition. + The default penalty duration as a time period, such as \"30 sec\". - :param build_info: The build_info of this ProcessorDefinition. - :type: BuildInfo + :param default_penalty_duration: The default_penalty_duration of this ProcessorDefinition. + :type: str """ - self._build_info = build_info + self._default_penalty_duration = default_penalty_duration @property - def provided_api_implementations(self): + def default_scheduling_period_by_scheduling_strategy(self): """ - Gets the provided_api_implementations of this ProcessorDefinition. - If this type represents a provider for an interface, this lists the APIs it implements + Gets the default_scheduling_period_by_scheduling_strategy of this ProcessorDefinition. + The default scheduling period for each scheduling strategy. The scheduling period is expected to be a time period, such as \"30 sec\". - :return: The provided_api_implementations of this ProcessorDefinition. - :rtype: list[DefinedType] + :return: The default_scheduling_period_by_scheduling_strategy of this ProcessorDefinition. + :rtype: dict(str, str) """ - return self._provided_api_implementations + return self._default_scheduling_period_by_scheduling_strategy - @provided_api_implementations.setter - def provided_api_implementations(self, provided_api_implementations): + @default_scheduling_period_by_scheduling_strategy.setter + def default_scheduling_period_by_scheduling_strategy(self, default_scheduling_period_by_scheduling_strategy): """ - Sets the provided_api_implementations of this ProcessorDefinition. - If this type represents a provider for an interface, this lists the APIs it implements + Sets the default_scheduling_period_by_scheduling_strategy of this ProcessorDefinition. + The default scheduling period for each scheduling strategy. The scheduling period is expected to be a time period, such as \"30 sec\". - :param provided_api_implementations: The provided_api_implementations of this ProcessorDefinition. - :type: list[DefinedType] + :param default_scheduling_period_by_scheduling_strategy: The default_scheduling_period_by_scheduling_strategy of this ProcessorDefinition. + :type: dict(str, str) """ - self._provided_api_implementations = provided_api_implementations + self._default_scheduling_period_by_scheduling_strategy = default_scheduling_period_by_scheduling_strategy @property - def tags(self): + def default_scheduling_strategy(self): """ - Gets the tags of this ProcessorDefinition. - The tags associated with this type + Gets the default_scheduling_strategy of this ProcessorDefinition. + The default scheduling strategy for the processor. - :return: The tags of this ProcessorDefinition. - :rtype: list[str] + :return: The default_scheduling_strategy of this ProcessorDefinition. + :rtype: str """ - return self._tags + return self._default_scheduling_strategy - @tags.setter - def tags(self, tags): + @default_scheduling_strategy.setter + def default_scheduling_strategy(self, default_scheduling_strategy): """ - Sets the tags of this ProcessorDefinition. - The tags associated with this type + Sets the default_scheduling_strategy of this ProcessorDefinition. + The default scheduling strategy for the processor. - :param tags: The tags of this ProcessorDefinition. - :type: list[str] + :param default_scheduling_strategy: The default_scheduling_strategy of this ProcessorDefinition. + :type: str """ - self._tags = tags + self._default_scheduling_strategy = default_scheduling_strategy @property - def see_also(self): + def default_yield_duration(self): """ - Gets the see_also of this ProcessorDefinition. - The names of other component types that may be related + Gets the default_yield_duration of this ProcessorDefinition. + The default yield duration as a time period, such as \"1 sec\". - :return: The see_also of this ProcessorDefinition. - :rtype: list[str] + :return: The default_yield_duration of this ProcessorDefinition. + :rtype: str """ - return self._see_also + return self._default_yield_duration - @see_also.setter - def see_also(self, see_also): + @default_yield_duration.setter + def default_yield_duration(self, default_yield_duration): """ - Sets the see_also of this ProcessorDefinition. - The names of other component types that may be related + Sets the default_yield_duration of this ProcessorDefinition. + The default yield duration as a time period, such as \"1 sec\". - :param see_also: The see_also of this ProcessorDefinition. - :type: list[str] + :param default_yield_duration: The default_yield_duration of this ProcessorDefinition. + :type: str """ - self._see_also = see_also + self._default_yield_duration = default_yield_duration @property def deprecated(self): @@ -481,29 +480,6 @@ def deprecated(self, deprecated): self._deprecated = deprecated - @property - def deprecation_reason(self): - """ - Gets the deprecation_reason of this ProcessorDefinition. - If this component has been deprecated, this optional field can be used to provide an explanation - - :return: The deprecation_reason of this ProcessorDefinition. - :rtype: str - """ - return self._deprecation_reason - - @deprecation_reason.setter - def deprecation_reason(self, deprecation_reason): - """ - Sets the deprecation_reason of this ProcessorDefinition. - If this component has been deprecated, this optional field can be used to provide an explanation - - :param deprecation_reason: The deprecation_reason of this ProcessorDefinition. - :type: str - """ - - self._deprecation_reason = deprecation_reason - @property def deprecation_alternatives(self): """ @@ -528,50 +504,71 @@ def deprecation_alternatives(self, deprecation_alternatives): self._deprecation_alternatives = deprecation_alternatives @property - def restricted(self): + def deprecation_reason(self): """ - Gets the restricted of this ProcessorDefinition. - Whether or not the component has a general restriction + Gets the deprecation_reason of this ProcessorDefinition. + If this component has been deprecated, this optional field can be used to provide an explanation - :return: The restricted of this ProcessorDefinition. - :rtype: bool + :return: The deprecation_reason of this ProcessorDefinition. + :rtype: str """ - return self._restricted + return self._deprecation_reason - @restricted.setter - def restricted(self, restricted): + @deprecation_reason.setter + def deprecation_reason(self, deprecation_reason): """ - Sets the restricted of this ProcessorDefinition. - Whether or not the component has a general restriction + Sets the deprecation_reason of this ProcessorDefinition. + If this component has been deprecated, this optional field can be used to provide an explanation - :param restricted: The restricted of this ProcessorDefinition. - :type: bool + :param deprecation_reason: The deprecation_reason of this ProcessorDefinition. + :type: str """ - self._restricted = restricted + self._deprecation_reason = deprecation_reason @property - def restricted_explanation(self): + def dynamic_properties(self): """ - Gets the restricted_explanation of this ProcessorDefinition. - An optional description of the general restriction + Gets the dynamic_properties of this ProcessorDefinition. + Describes the dynamic properties supported by this component - :return: The restricted_explanation of this ProcessorDefinition. - :rtype: str + :return: The dynamic_properties of this ProcessorDefinition. + :rtype: list[DynamicProperty] """ - return self._restricted_explanation + return self._dynamic_properties - @restricted_explanation.setter - def restricted_explanation(self, restricted_explanation): + @dynamic_properties.setter + def dynamic_properties(self, dynamic_properties): """ - Sets the restricted_explanation of this ProcessorDefinition. - An optional description of the general restriction + Sets the dynamic_properties of this ProcessorDefinition. + Describes the dynamic properties supported by this component - :param restricted_explanation: The restricted_explanation of this ProcessorDefinition. - :type: str + :param dynamic_properties: The dynamic_properties of this ProcessorDefinition. + :type: list[DynamicProperty] """ - self._restricted_explanation = restricted_explanation + self._dynamic_properties = dynamic_properties + + @property + def dynamic_relationship(self): + """ + Gets the dynamic_relationship of this ProcessorDefinition. + + :return: The dynamic_relationship of this ProcessorDefinition. + :rtype: DynamicRelationship + """ + return self._dynamic_relationship + + @dynamic_relationship.setter + def dynamic_relationship(self, dynamic_relationship): + """ + Sets the dynamic_relationship of this ProcessorDefinition. + + :param dynamic_relationship: The dynamic_relationship of this ProcessorDefinition. + :type: DynamicRelationship + """ + + self._dynamic_relationship = dynamic_relationship @property def explicit_restrictions(self): @@ -597,73 +594,102 @@ def explicit_restrictions(self, explicit_restrictions): self._explicit_restrictions = explicit_restrictions @property - def stateful(self): + def group(self): """ - Gets the stateful of this ProcessorDefinition. - Indicates if the component stores state + Gets the group of this ProcessorDefinition. + The group name of the bundle that provides the referenced type. - :return: The stateful of this ProcessorDefinition. - :rtype: Stateful + :return: The group of this ProcessorDefinition. + :rtype: str """ - return self._stateful + return self._group - @stateful.setter - def stateful(self, stateful): + @group.setter + def group(self, group): """ - Sets the stateful of this ProcessorDefinition. - Indicates if the component stores state + Sets the group of this ProcessorDefinition. + The group name of the bundle that provides the referenced type. - :param stateful: The stateful of this ProcessorDefinition. - :type: Stateful + :param group: The group of this ProcessorDefinition. + :type: str """ - self._stateful = stateful + self._group = group @property - def system_resource_considerations(self): + def input_requirement(self): """ - Gets the system_resource_considerations of this ProcessorDefinition. - The system resource considerations for the given component + Gets the input_requirement of this ProcessorDefinition. + Any input requirements this processor has. - :return: The system_resource_considerations of this ProcessorDefinition. - :rtype: list[SystemResourceConsideration] + :return: The input_requirement of this ProcessorDefinition. + :rtype: str """ - return self._system_resource_considerations + return self._input_requirement - @system_resource_considerations.setter - def system_resource_considerations(self, system_resource_considerations): + @input_requirement.setter + def input_requirement(self, input_requirement): """ - Sets the system_resource_considerations of this ProcessorDefinition. - The system resource considerations for the given component + Sets the input_requirement of this ProcessorDefinition. + Any input requirements this processor has. - :param system_resource_considerations: The system_resource_considerations of this ProcessorDefinition. - :type: list[SystemResourceConsideration] + :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) + ) - self._system_resource_considerations = system_resource_considerations + self._input_requirement = input_requirement @property - def additional_details(self): + def multi_processor_use_cases(self): """ - Gets the additional_details of this ProcessorDefinition. - Indicates if the component has additional details documentation + Gets the multi_processor_use_cases of this ProcessorDefinition. + A list of use cases that have been documented that involve this Processor in conjunction with other Processors - :return: The additional_details of this ProcessorDefinition. + :return: The multi_processor_use_cases of this ProcessorDefinition. + :rtype: list[MultiProcessorUseCase] + """ + return self._multi_processor_use_cases + + @multi_processor_use_cases.setter + def multi_processor_use_cases(self, multi_processor_use_cases): + """ + Sets the multi_processor_use_cases of this ProcessorDefinition. + A list of use cases that have been documented that involve this Processor in conjunction with other Processors + + :param multi_processor_use_cases: The multi_processor_use_cases of this ProcessorDefinition. + :type: list[MultiProcessorUseCase] + """ + + self._multi_processor_use_cases = multi_processor_use_cases + + @property + def primary_node_only(self): + """ + Gets the primary_node_only of this ProcessorDefinition. + Whether or not this processor should be scheduled only on the primary node in a cluster. + + :return: The primary_node_only of this ProcessorDefinition. :rtype: bool """ - return self._additional_details + return self._primary_node_only - @additional_details.setter - def additional_details(self, additional_details): + @primary_node_only.setter + def primary_node_only(self, primary_node_only): """ - Sets the additional_details of this ProcessorDefinition. - Indicates if the component has additional details documentation + Sets the primary_node_only of this ProcessorDefinition. + Whether or not this processor should be scheduled only on the primary node in a cluster. - :param additional_details: The additional_details of this ProcessorDefinition. + :param primary_node_only: The primary_node_only of this ProcessorDefinition. :type: bool """ - self._additional_details = additional_details + self._primary_node_only = primary_node_only @property def property_descriptors(self): @@ -689,516 +715,508 @@ def property_descriptors(self, property_descriptors): self._property_descriptors = property_descriptors @property - def supports_dynamic_properties(self): + def provided_api_implementations(self): """ - Gets the supports_dynamic_properties of this ProcessorDefinition. - Whether or not this component makes use of dynamic (user-set) properties. + Gets the provided_api_implementations of this ProcessorDefinition. + If this type represents a provider for an interface, this lists the APIs it implements - :return: The supports_dynamic_properties of this ProcessorDefinition. - :rtype: bool + :return: The provided_api_implementations of this ProcessorDefinition. + :rtype: list[DefinedType] """ - return self._supports_dynamic_properties + return self._provided_api_implementations - @supports_dynamic_properties.setter - def supports_dynamic_properties(self, supports_dynamic_properties): + @provided_api_implementations.setter + def provided_api_implementations(self, provided_api_implementations): """ - Sets the supports_dynamic_properties of this ProcessorDefinition. - Whether or not this component makes use of dynamic (user-set) properties. + Sets the provided_api_implementations of this ProcessorDefinition. + If this type represents a provider for an interface, this lists the APIs it implements - :param supports_dynamic_properties: The supports_dynamic_properties of this ProcessorDefinition. - :type: bool + :param provided_api_implementations: The provided_api_implementations of this ProcessorDefinition. + :type: list[DefinedType] """ - self._supports_dynamic_properties = supports_dynamic_properties + self._provided_api_implementations = provided_api_implementations @property - def supports_sensitive_dynamic_properties(self): + def reads_attributes(self): """ - Gets the supports_sensitive_dynamic_properties of this ProcessorDefinition. - Whether or not this component makes use of sensitive dynamic (user-set) properties. + Gets the reads_attributes of this ProcessorDefinition. + The FlowFile attributes this processor reads - :return: The supports_sensitive_dynamic_properties of this ProcessorDefinition. - :rtype: bool + :return: The reads_attributes of this ProcessorDefinition. + :rtype: list[Attribute] """ - return self._supports_sensitive_dynamic_properties + return self._reads_attributes - @supports_sensitive_dynamic_properties.setter - def supports_sensitive_dynamic_properties(self, supports_sensitive_dynamic_properties): + @reads_attributes.setter + def reads_attributes(self, reads_attributes): """ - Sets the supports_sensitive_dynamic_properties of this ProcessorDefinition. - Whether or not this component makes use of sensitive dynamic (user-set) properties. + Sets the reads_attributes of this ProcessorDefinition. + The FlowFile attributes this processor reads - :param supports_sensitive_dynamic_properties: The supports_sensitive_dynamic_properties of this ProcessorDefinition. - :type: bool + :param reads_attributes: The reads_attributes of this ProcessorDefinition. + :type: list[Attribute] """ - self._supports_sensitive_dynamic_properties = supports_sensitive_dynamic_properties + self._reads_attributes = reads_attributes @property - def dynamic_properties(self): + def restricted(self): """ - Gets the dynamic_properties of this ProcessorDefinition. - Describes the dynamic properties supported by this component + Gets the restricted of this ProcessorDefinition. + Whether or not the component has a general restriction - :return: The dynamic_properties of this ProcessorDefinition. - :rtype: list[DynamicProperty] + :return: The restricted of this ProcessorDefinition. + :rtype: bool """ - return self._dynamic_properties + return self._restricted - @dynamic_properties.setter - def dynamic_properties(self, dynamic_properties): + @restricted.setter + def restricted(self, restricted): """ - Sets the dynamic_properties of this ProcessorDefinition. - Describes the dynamic properties supported by this component + Sets the restricted of this ProcessorDefinition. + Whether or not the component has a general restriction - :param dynamic_properties: The dynamic_properties of this ProcessorDefinition. - :type: list[DynamicProperty] + :param restricted: The restricted of this ProcessorDefinition. + :type: bool """ - self._dynamic_properties = dynamic_properties + self._restricted = restricted @property - def input_requirement(self): + def restricted_explanation(self): """ - Gets the input_requirement of this ProcessorDefinition. - Any input requirements this processor has. + Gets the restricted_explanation of this ProcessorDefinition. + An optional description of the general restriction - :return: The input_requirement of this ProcessorDefinition. + :return: The restricted_explanation of this ProcessorDefinition. :rtype: str """ - return self._input_requirement + return self._restricted_explanation - @input_requirement.setter - def input_requirement(self, input_requirement): + @restricted_explanation.setter + def restricted_explanation(self, restricted_explanation): """ - Sets the input_requirement of this ProcessorDefinition. - Any input requirements this processor has. + Sets the restricted_explanation of this ProcessorDefinition. + An optional description of the general restriction - :param input_requirement: The input_requirement of this ProcessorDefinition. + :param restricted_explanation: The restricted_explanation 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) - ) - self._input_requirement = input_requirement + self._restricted_explanation = restricted_explanation @property - def supported_relationships(self): + def see_also(self): """ - Gets the supported_relationships of this ProcessorDefinition. - The supported relationships for this processor. + Gets the see_also of this ProcessorDefinition. + The names of other component types that may be related - :return: The supported_relationships of this ProcessorDefinition. - :rtype: list[Relationship] + :return: The see_also of this ProcessorDefinition. + :rtype: list[str] """ - return self._supported_relationships + return self._see_also - @supported_relationships.setter - def supported_relationships(self, supported_relationships): + @see_also.setter + def see_also(self, see_also): """ - Sets the supported_relationships of this ProcessorDefinition. - The supported relationships for this processor. + Sets the see_also of this ProcessorDefinition. + The names of other component types that may be related - :param supported_relationships: The supported_relationships of this ProcessorDefinition. - :type: list[Relationship] + :param see_also: The see_also of this ProcessorDefinition. + :type: list[str] """ - self._supported_relationships = supported_relationships + self._see_also = see_also @property - def supports_dynamic_relationships(self): + def side_effect_free(self): """ - Gets the supports_dynamic_relationships of this ProcessorDefinition. - Whether or not this processor supports dynamic relationships. + Gets the side_effect_free of this ProcessorDefinition. + 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. - :return: The supports_dynamic_relationships of this ProcessorDefinition. + :return: The side_effect_free of this ProcessorDefinition. :rtype: bool """ - return self._supports_dynamic_relationships + return self._side_effect_free - @supports_dynamic_relationships.setter - def supports_dynamic_relationships(self, supports_dynamic_relationships): + @side_effect_free.setter + def side_effect_free(self, side_effect_free): """ - Sets the supports_dynamic_relationships of this ProcessorDefinition. - Whether or not this processor supports dynamic relationships. + Sets the side_effect_free of this ProcessorDefinition. + 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. - :param supports_dynamic_relationships: The supports_dynamic_relationships of this ProcessorDefinition. + :param side_effect_free: The side_effect_free of this ProcessorDefinition. :type: bool """ - self._supports_dynamic_relationships = supports_dynamic_relationships + self._side_effect_free = side_effect_free @property - def dynamic_relationship(self): + def stateful(self): """ - Gets the dynamic_relationship of this ProcessorDefinition. - If the processor supports dynamic relationships, this describes the dynamic relationship + Gets the stateful of this ProcessorDefinition. - :return: The dynamic_relationship of this ProcessorDefinition. - :rtype: DynamicRelationship + :return: The stateful of this ProcessorDefinition. + :rtype: Stateful """ - return self._dynamic_relationship + return self._stateful - @dynamic_relationship.setter - def dynamic_relationship(self, dynamic_relationship): + @stateful.setter + def stateful(self, stateful): """ - Sets the dynamic_relationship of this ProcessorDefinition. - If the processor supports dynamic relationships, this describes the dynamic relationship + Sets the stateful of this ProcessorDefinition. - :param dynamic_relationship: The dynamic_relationship of this ProcessorDefinition. - :type: DynamicRelationship + :param stateful: The stateful of this ProcessorDefinition. + :type: Stateful """ - self._dynamic_relationship = dynamic_relationship + self._stateful = stateful @property - def trigger_serially(self): + def supported_relationships(self): """ - Gets the trigger_serially of this ProcessorDefinition. - Whether or not this processor should be triggered serially (i.e. no concurrent execution). + Gets the supported_relationships of this ProcessorDefinition. + The supported relationships for this processor. - :return: The trigger_serially of this ProcessorDefinition. - :rtype: bool + :return: The supported_relationships of this ProcessorDefinition. + :rtype: list[Relationship] """ - return self._trigger_serially + return self._supported_relationships - @trigger_serially.setter - def trigger_serially(self, trigger_serially): + @supported_relationships.setter + def supported_relationships(self, supported_relationships): """ - Sets the trigger_serially of this ProcessorDefinition. - Whether or not this processor should be triggered serially (i.e. no concurrent execution). + Sets the supported_relationships of this ProcessorDefinition. + The supported relationships for this processor. - :param trigger_serially: The trigger_serially of this ProcessorDefinition. - :type: bool + :param supported_relationships: The supported_relationships of this ProcessorDefinition. + :type: list[Relationship] """ - self._trigger_serially = trigger_serially + self._supported_relationships = supported_relationships @property - def trigger_when_empty(self): + def supported_scheduling_strategies(self): """ - Gets the trigger_when_empty of this ProcessorDefinition. - Whether or not this processor should be triggered when incoming queues are empty. + Gets the supported_scheduling_strategies of this ProcessorDefinition. + The supported scheduling strategies, such as TIME_DRIVER, CRON, or EVENT_DRIVEN. - :return: The trigger_when_empty of this ProcessorDefinition. - :rtype: bool + :return: The supported_scheduling_strategies of this ProcessorDefinition. + :rtype: list[str] """ - return self._trigger_when_empty + return self._supported_scheduling_strategies - @trigger_when_empty.setter - def trigger_when_empty(self, trigger_when_empty): + @supported_scheduling_strategies.setter + def supported_scheduling_strategies(self, supported_scheduling_strategies): """ - Sets the trigger_when_empty of this ProcessorDefinition. - Whether or not this processor should be triggered when incoming queues are empty. + Sets the supported_scheduling_strategies of this ProcessorDefinition. + The supported scheduling strategies, such as TIME_DRIVER, CRON, or EVENT_DRIVEN. - :param trigger_when_empty: The trigger_when_empty of this ProcessorDefinition. - :type: bool + :param supported_scheduling_strategies: The supported_scheduling_strategies of this ProcessorDefinition. + :type: list[str] """ - self._trigger_when_empty = trigger_when_empty + self._supported_scheduling_strategies = supported_scheduling_strategies @property - def trigger_when_any_destination_available(self): + def supports_batching(self): """ - Gets the trigger_when_any_destination_available of this ProcessorDefinition. - Whether or not this processor should be triggered when any destination queue has room. + Gets the supports_batching of this ProcessorDefinition. + 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. - :return: The trigger_when_any_destination_available of this ProcessorDefinition. + :return: The supports_batching of this ProcessorDefinition. :rtype: bool """ - return self._trigger_when_any_destination_available + return self._supports_batching - @trigger_when_any_destination_available.setter - def trigger_when_any_destination_available(self, trigger_when_any_destination_available): + @supports_batching.setter + def supports_batching(self, supports_batching): """ - Sets the trigger_when_any_destination_available of this ProcessorDefinition. - Whether or not this processor should be triggered when any destination queue has room. + Sets the supports_batching of this ProcessorDefinition. + 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. - :param trigger_when_any_destination_available: The trigger_when_any_destination_available of this ProcessorDefinition. + :param supports_batching: The supports_batching of this ProcessorDefinition. :type: bool """ - self._trigger_when_any_destination_available = trigger_when_any_destination_available + self._supports_batching = supports_batching @property - def supports_batching(self): + def supports_dynamic_properties(self): """ - Gets the supports_batching of this ProcessorDefinition. - 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. + Gets the supports_dynamic_properties of this ProcessorDefinition. + Whether or not this component makes use of dynamic (user-set) properties. - :return: The supports_batching of this ProcessorDefinition. + :return: The supports_dynamic_properties of this ProcessorDefinition. :rtype: bool """ - return self._supports_batching + return self._supports_dynamic_properties - @supports_batching.setter - def supports_batching(self, supports_batching): + @supports_dynamic_properties.setter + def supports_dynamic_properties(self, supports_dynamic_properties): """ - Sets the supports_batching of this ProcessorDefinition. - 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. + Sets the supports_dynamic_properties of this ProcessorDefinition. + Whether or not this component makes use of dynamic (user-set) properties. - :param supports_batching: The supports_batching of this ProcessorDefinition. + :param supports_dynamic_properties: The supports_dynamic_properties of this ProcessorDefinition. :type: bool """ - self._supports_batching = supports_batching + self._supports_dynamic_properties = supports_dynamic_properties @property - def supports_event_driven(self): + def supports_dynamic_relationships(self): """ - Gets the supports_event_driven of this ProcessorDefinition. - Whether or not this processor supports event driven scheduling. Indicates to the framework that the Processor is eligible to be scheduled to run based on the occurrence of an \"Event\" (e.g., when a FlowFile is enqueued in an incoming Connection), rather than being triggered periodically. + Gets the supports_dynamic_relationships of this ProcessorDefinition. + Whether or not this processor supports dynamic relationships. - :return: The supports_event_driven of this ProcessorDefinition. + :return: The supports_dynamic_relationships of this ProcessorDefinition. :rtype: bool """ - return self._supports_event_driven + return self._supports_dynamic_relationships - @supports_event_driven.setter - def supports_event_driven(self, supports_event_driven): + @supports_dynamic_relationships.setter + def supports_dynamic_relationships(self, supports_dynamic_relationships): """ - Sets the supports_event_driven of this ProcessorDefinition. - Whether or not this processor supports event driven scheduling. Indicates to the framework that the Processor is eligible to be scheduled to run based on the occurrence of an \"Event\" (e.g., when a FlowFile is enqueued in an incoming Connection), rather than being triggered periodically. + Sets the supports_dynamic_relationships of this ProcessorDefinition. + Whether or not this processor supports dynamic relationships. - :param supports_event_driven: The supports_event_driven of this ProcessorDefinition. + :param supports_dynamic_relationships: The supports_dynamic_relationships of this ProcessorDefinition. :type: bool """ - self._supports_event_driven = supports_event_driven + self._supports_dynamic_relationships = supports_dynamic_relationships @property - def primary_node_only(self): + def supports_sensitive_dynamic_properties(self): """ - Gets the primary_node_only of this ProcessorDefinition. - Whether or not this processor should be scheduled only on the primary node in a cluster. + Gets the supports_sensitive_dynamic_properties of this ProcessorDefinition. + Whether or not this component makes use of sensitive dynamic (user-set) properties. - :return: The primary_node_only of this ProcessorDefinition. + :return: The supports_sensitive_dynamic_properties of this ProcessorDefinition. :rtype: bool """ - return self._primary_node_only + return self._supports_sensitive_dynamic_properties - @primary_node_only.setter - def primary_node_only(self, primary_node_only): + @supports_sensitive_dynamic_properties.setter + def supports_sensitive_dynamic_properties(self, supports_sensitive_dynamic_properties): """ - Sets the primary_node_only of this ProcessorDefinition. - Whether or not this processor should be scheduled only on the primary node in a cluster. + Sets the supports_sensitive_dynamic_properties of this ProcessorDefinition. + Whether or not this component makes use of sensitive dynamic (user-set) properties. - :param primary_node_only: The primary_node_only of this ProcessorDefinition. + :param supports_sensitive_dynamic_properties: The supports_sensitive_dynamic_properties of this ProcessorDefinition. :type: bool """ - self._primary_node_only = primary_node_only + self._supports_sensitive_dynamic_properties = supports_sensitive_dynamic_properties @property - def side_effect_free(self): + def system_resource_considerations(self): """ - Gets the side_effect_free of this ProcessorDefinition. - 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. + Gets the system_resource_considerations of this ProcessorDefinition. + The system resource considerations for the given component - :return: The side_effect_free of this ProcessorDefinition. - :rtype: bool + :return: The system_resource_considerations of this ProcessorDefinition. + :rtype: list[SystemResourceConsideration] """ - return self._side_effect_free + return self._system_resource_considerations - @side_effect_free.setter - def side_effect_free(self, side_effect_free): + @system_resource_considerations.setter + def system_resource_considerations(self, system_resource_considerations): """ - Sets the side_effect_free of this ProcessorDefinition. - 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. + Sets the system_resource_considerations of this ProcessorDefinition. + The system resource considerations for the given component - :param side_effect_free: The side_effect_free of this ProcessorDefinition. - :type: bool + :param system_resource_considerations: The system_resource_considerations of this ProcessorDefinition. + :type: list[SystemResourceConsideration] """ - self._side_effect_free = side_effect_free + self._system_resource_considerations = system_resource_considerations @property - def supported_scheduling_strategies(self): + def tags(self): """ - Gets the supported_scheduling_strategies of this ProcessorDefinition. - The supported scheduling strategies, such as TIME_DRIVER, CRON, or EVENT_DRIVEN. + Gets the tags of this ProcessorDefinition. + The tags associated with this type - :return: The supported_scheduling_strategies of this ProcessorDefinition. + :return: The tags of this ProcessorDefinition. :rtype: list[str] """ - return self._supported_scheduling_strategies + return self._tags - @supported_scheduling_strategies.setter - def supported_scheduling_strategies(self, supported_scheduling_strategies): + @tags.setter + def tags(self, tags): """ - Sets the supported_scheduling_strategies of this ProcessorDefinition. - The supported scheduling strategies, such as TIME_DRIVER, CRON, or EVENT_DRIVEN. + Sets the tags of this ProcessorDefinition. + The tags associated with this type - :param supported_scheduling_strategies: The supported_scheduling_strategies of this ProcessorDefinition. + :param tags: The tags of this ProcessorDefinition. :type: list[str] """ - self._supported_scheduling_strategies = supported_scheduling_strategies + self._tags = tags @property - def default_scheduling_strategy(self): + def trigger_serially(self): """ - Gets the default_scheduling_strategy of this ProcessorDefinition. - The default scheduling strategy for the processor. + Gets the trigger_serially of this ProcessorDefinition. + Whether or not this processor should be triggered serially (i.e. no concurrent execution). - :return: The default_scheduling_strategy of this ProcessorDefinition. - :rtype: str + :return: The trigger_serially of this ProcessorDefinition. + :rtype: bool """ - return self._default_scheduling_strategy + return self._trigger_serially - @default_scheduling_strategy.setter - def default_scheduling_strategy(self, default_scheduling_strategy): + @trigger_serially.setter + def trigger_serially(self, trigger_serially): """ - Sets the default_scheduling_strategy of this ProcessorDefinition. - The default scheduling strategy for the processor. + Sets the trigger_serially of this ProcessorDefinition. + Whether or not this processor should be triggered serially (i.e. no concurrent execution). - :param default_scheduling_strategy: The default_scheduling_strategy of this ProcessorDefinition. - :type: str + :param trigger_serially: The trigger_serially of this ProcessorDefinition. + :type: bool """ - self._default_scheduling_strategy = default_scheduling_strategy + self._trigger_serially = trigger_serially @property - def default_concurrent_tasks_by_scheduling_strategy(self): + def trigger_when_any_destination_available(self): """ - Gets the default_concurrent_tasks_by_scheduling_strategy of this ProcessorDefinition. - The default concurrent tasks for each scheduling strategy. + Gets the trigger_when_any_destination_available of this ProcessorDefinition. + Whether or not this processor should be triggered when any destination queue has room. - :return: The default_concurrent_tasks_by_scheduling_strategy of this ProcessorDefinition. - :rtype: dict(str, int) + :return: The trigger_when_any_destination_available of this ProcessorDefinition. + :rtype: bool """ - return self._default_concurrent_tasks_by_scheduling_strategy + return self._trigger_when_any_destination_available - @default_concurrent_tasks_by_scheduling_strategy.setter - def default_concurrent_tasks_by_scheduling_strategy(self, default_concurrent_tasks_by_scheduling_strategy): + @trigger_when_any_destination_available.setter + def trigger_when_any_destination_available(self, trigger_when_any_destination_available): """ - Sets the default_concurrent_tasks_by_scheduling_strategy of this ProcessorDefinition. - The default concurrent tasks for each scheduling strategy. + Sets the trigger_when_any_destination_available of this ProcessorDefinition. + Whether or not this processor should be triggered when any destination queue has room. - :param default_concurrent_tasks_by_scheduling_strategy: The default_concurrent_tasks_by_scheduling_strategy of this ProcessorDefinition. - :type: dict(str, int) + :param trigger_when_any_destination_available: The trigger_when_any_destination_available of this ProcessorDefinition. + :type: bool """ - self._default_concurrent_tasks_by_scheduling_strategy = default_concurrent_tasks_by_scheduling_strategy + self._trigger_when_any_destination_available = trigger_when_any_destination_available @property - def default_scheduling_period_by_scheduling_strategy(self): + def trigger_when_empty(self): """ - Gets the default_scheduling_period_by_scheduling_strategy of this ProcessorDefinition. - The default scheduling period for each scheduling strategy. The scheduling period is expected to be a time period, such as \"30 sec\". + Gets the trigger_when_empty of this ProcessorDefinition. + Whether or not this processor should be triggered when incoming queues are empty. - :return: The default_scheduling_period_by_scheduling_strategy of this ProcessorDefinition. - :rtype: dict(str, str) + :return: The trigger_when_empty of this ProcessorDefinition. + :rtype: bool """ - return self._default_scheduling_period_by_scheduling_strategy + return self._trigger_when_empty - @default_scheduling_period_by_scheduling_strategy.setter - def default_scheduling_period_by_scheduling_strategy(self, default_scheduling_period_by_scheduling_strategy): + @trigger_when_empty.setter + def trigger_when_empty(self, trigger_when_empty): """ - Sets the default_scheduling_period_by_scheduling_strategy of this ProcessorDefinition. - The default scheduling period for each scheduling strategy. The scheduling period is expected to be a time period, such as \"30 sec\". + Sets the trigger_when_empty of this ProcessorDefinition. + Whether or not this processor should be triggered when incoming queues are empty. - :param default_scheduling_period_by_scheduling_strategy: The default_scheduling_period_by_scheduling_strategy of this ProcessorDefinition. - :type: dict(str, str) + :param trigger_when_empty: The trigger_when_empty of this ProcessorDefinition. + :type: bool """ - self._default_scheduling_period_by_scheduling_strategy = default_scheduling_period_by_scheduling_strategy + self._trigger_when_empty = trigger_when_empty @property - def default_penalty_duration(self): + def type(self): """ - Gets the default_penalty_duration of this ProcessorDefinition. - The default penalty duration as a time period, such as \"30 sec\". + Gets the type of this ProcessorDefinition. + The fully-qualified class type - :return: The default_penalty_duration of this ProcessorDefinition. + :return: The type of this ProcessorDefinition. :rtype: str """ - return self._default_penalty_duration + return self._type - @default_penalty_duration.setter - def default_penalty_duration(self, default_penalty_duration): + @type.setter + def type(self, type): """ - Sets the default_penalty_duration of this ProcessorDefinition. - The default penalty duration as a time period, such as \"30 sec\". + Sets the type of this ProcessorDefinition. + The fully-qualified class type - :param default_penalty_duration: The default_penalty_duration of this ProcessorDefinition. + :param type: The type of this ProcessorDefinition. :type: str """ - self._default_penalty_duration = default_penalty_duration + self._type = type @property - def default_yield_duration(self): + def type_description(self): """ - Gets the default_yield_duration of this ProcessorDefinition. - The default yield duration as a time period, such as \"1 sec\". + Gets the type_description of this ProcessorDefinition. + The description of the type. - :return: The default_yield_duration of this ProcessorDefinition. + :return: The type_description of this ProcessorDefinition. :rtype: str """ - return self._default_yield_duration + return self._type_description - @default_yield_duration.setter - def default_yield_duration(self, default_yield_duration): + @type_description.setter + def type_description(self, type_description): """ - Sets the default_yield_duration of this ProcessorDefinition. - The default yield duration as a time period, such as \"1 sec\". + Sets the type_description of this ProcessorDefinition. + The description of the type. - :param default_yield_duration: The default_yield_duration of this ProcessorDefinition. + :param type_description: The type_description of this ProcessorDefinition. :type: str """ - self._default_yield_duration = default_yield_duration + self._type_description = type_description @property - def default_bulletin_level(self): + def use_cases(self): """ - Gets the default_bulletin_level of this ProcessorDefinition. - The default bulletin level, such as WARN, INFO, DEBUG, etc. + Gets the use_cases of this ProcessorDefinition. + A list of use cases that have been documented for this Processor - :return: The default_bulletin_level of this ProcessorDefinition. - :rtype: str + :return: The use_cases of this ProcessorDefinition. + :rtype: list[UseCase] """ - return self._default_bulletin_level + return self._use_cases - @default_bulletin_level.setter - def default_bulletin_level(self, default_bulletin_level): + @use_cases.setter + def use_cases(self, use_cases): """ - Sets the default_bulletin_level of this ProcessorDefinition. - The default bulletin level, such as WARN, INFO, DEBUG, etc. + Sets the use_cases of this ProcessorDefinition. + A list of use cases that have been documented for this Processor - :param default_bulletin_level: The default_bulletin_level of this ProcessorDefinition. - :type: str + :param use_cases: The use_cases of this ProcessorDefinition. + :type: list[UseCase] """ - self._default_bulletin_level = default_bulletin_level + self._use_cases = use_cases @property - def reads_attributes(self): + def version(self): """ - Gets the reads_attributes of this ProcessorDefinition. - The FlowFile attributes this processor reads + Gets the version of this ProcessorDefinition. + The version of the bundle that provides the referenced type. - :return: The reads_attributes of this ProcessorDefinition. - :rtype: list[Attribute] + :return: The version of this ProcessorDefinition. + :rtype: str """ - return self._reads_attributes + return self._version - @reads_attributes.setter - def reads_attributes(self, reads_attributes): + @version.setter + def version(self, version): """ - Sets the reads_attributes of this ProcessorDefinition. - The FlowFile attributes this processor reads + Sets the version of this ProcessorDefinition. + The version of the bundle that provides the referenced type. - :param reads_attributes: The reads_attributes of this ProcessorDefinition. - :type: list[Attribute] + :param version: The version of this ProcessorDefinition. + :type: str """ - self._reads_attributes = reads_attributes + self._version = version @property def writes_attributes(self): diff --git a/nipyapi/nifi/models/processor_diagnostics_dto.py b/nipyapi/nifi/models/processor_diagnostics_dto.py deleted file mode 100644 index 20615e2a..00000000 --- a/nipyapi/nifi/models/processor_diagnostics_dto.py +++ /dev/null @@ -1,318 +0,0 @@ -""" - NiFi Rest API - - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - - OpenAPI spec version: 1.28.1 - Contact: dev@nifi.apache.org - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - - -from pprint import pformat -import re - - -class ProcessorDiagnosticsDTO(object): - """ - NOTE: This class is auto generated by the swagger code generator program. - Do not edit the class manually. - """ - - - """ - Attributes: - swagger_types (dict): The key is attribute name - and the value is attribute type. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - """ - swagger_types = { - 'processor': 'ProcessorDTO', - 'processor_status': 'ProcessorStatusDTO', - 'referenced_controller_services': 'list[ControllerServiceDiagnosticsDTO]', - 'incoming_connections': 'list[ConnectionDiagnosticsDTO]', - 'outgoing_connections': 'list[ConnectionDiagnosticsDTO]', - 'jvm_diagnostics': 'JVMDiagnosticsDTO', - 'thread_dumps': 'list[ThreadDumpDTO]', - 'class_loader_diagnostics': 'ClassLoaderDiagnosticsDTO' - } - - attribute_map = { - 'processor': 'processor', - 'processor_status': 'processorStatus', - 'referenced_controller_services': 'referencedControllerServices', - 'incoming_connections': 'incomingConnections', - 'outgoing_connections': 'outgoingConnections', - 'jvm_diagnostics': 'jvmDiagnostics', - 'thread_dumps': 'threadDumps', - 'class_loader_diagnostics': 'classLoaderDiagnostics' - } - - def __init__(self, processor=None, processor_status=None, referenced_controller_services=None, incoming_connections=None, outgoing_connections=None, jvm_diagnostics=None, thread_dumps=None, class_loader_diagnostics=None): - """ - ProcessorDiagnosticsDTO - a model defined in Swagger - """ - - self._processor = None - self._processor_status = None - self._referenced_controller_services = None - self._incoming_connections = None - self._outgoing_connections = None - self._jvm_diagnostics = None - self._thread_dumps = None - self._class_loader_diagnostics = None - - if processor is not None: - self.processor = processor - if processor_status is not None: - self.processor_status = processor_status - if referenced_controller_services is not None: - self.referenced_controller_services = referenced_controller_services - if incoming_connections is not None: - self.incoming_connections = incoming_connections - if outgoing_connections is not None: - self.outgoing_connections = outgoing_connections - if jvm_diagnostics is not None: - self.jvm_diagnostics = jvm_diagnostics - if thread_dumps is not None: - self.thread_dumps = thread_dumps - if class_loader_diagnostics is not None: - self.class_loader_diagnostics = class_loader_diagnostics - - @property - def processor(self): - """ - Gets the processor of this ProcessorDiagnosticsDTO. - Information about the Processor for which the Diagnostic Report is generated - - :return: The processor of this ProcessorDiagnosticsDTO. - :rtype: ProcessorDTO - """ - return self._processor - - @processor.setter - def processor(self, processor): - """ - Sets the processor of this ProcessorDiagnosticsDTO. - Information about the Processor for which the Diagnostic Report is generated - - :param processor: The processor of this ProcessorDiagnosticsDTO. - :type: ProcessorDTO - """ - - self._processor = processor - - @property - def processor_status(self): - """ - Gets the processor_status of this ProcessorDiagnosticsDTO. - The Status for the Processor for which the Diagnostic Report is generated - - :return: The processor_status of this ProcessorDiagnosticsDTO. - :rtype: ProcessorStatusDTO - """ - return self._processor_status - - @processor_status.setter - def processor_status(self, processor_status): - """ - Sets the processor_status of this ProcessorDiagnosticsDTO. - The Status for the Processor for which the Diagnostic Report is generated - - :param processor_status: The processor_status of this ProcessorDiagnosticsDTO. - :type: ProcessorStatusDTO - """ - - self._processor_status = processor_status - - @property - def referenced_controller_services(self): - """ - Gets the referenced_controller_services of this ProcessorDiagnosticsDTO. - Diagnostic Information about all Controller Services that the Processor is referencing - - :return: The referenced_controller_services of this ProcessorDiagnosticsDTO. - :rtype: list[ControllerServiceDiagnosticsDTO] - """ - return self._referenced_controller_services - - @referenced_controller_services.setter - def referenced_controller_services(self, referenced_controller_services): - """ - Sets the referenced_controller_services of this ProcessorDiagnosticsDTO. - Diagnostic Information about all Controller Services that the Processor is referencing - - :param referenced_controller_services: The referenced_controller_services of this ProcessorDiagnosticsDTO. - :type: list[ControllerServiceDiagnosticsDTO] - """ - - self._referenced_controller_services = referenced_controller_services - - @property - def incoming_connections(self): - """ - Gets the incoming_connections of this ProcessorDiagnosticsDTO. - Diagnostic Information about all incoming Connections - - :return: The incoming_connections of this ProcessorDiagnosticsDTO. - :rtype: list[ConnectionDiagnosticsDTO] - """ - return self._incoming_connections - - @incoming_connections.setter - def incoming_connections(self, incoming_connections): - """ - Sets the incoming_connections of this ProcessorDiagnosticsDTO. - Diagnostic Information about all incoming Connections - - :param incoming_connections: The incoming_connections of this ProcessorDiagnosticsDTO. - :type: list[ConnectionDiagnosticsDTO] - """ - - self._incoming_connections = incoming_connections - - @property - def outgoing_connections(self): - """ - Gets the outgoing_connections of this ProcessorDiagnosticsDTO. - Diagnostic Information about all outgoing Connections - - :return: The outgoing_connections of this ProcessorDiagnosticsDTO. - :rtype: list[ConnectionDiagnosticsDTO] - """ - return self._outgoing_connections - - @outgoing_connections.setter - def outgoing_connections(self, outgoing_connections): - """ - Sets the outgoing_connections of this ProcessorDiagnosticsDTO. - Diagnostic Information about all outgoing Connections - - :param outgoing_connections: The outgoing_connections of this ProcessorDiagnosticsDTO. - :type: list[ConnectionDiagnosticsDTO] - """ - - self._outgoing_connections = outgoing_connections - - @property - def jvm_diagnostics(self): - """ - Gets the jvm_diagnostics of this ProcessorDiagnosticsDTO. - Diagnostic Information about the JVM and system-level diagnostics - - :return: The jvm_diagnostics of this ProcessorDiagnosticsDTO. - :rtype: JVMDiagnosticsDTO - """ - return self._jvm_diagnostics - - @jvm_diagnostics.setter - def jvm_diagnostics(self, jvm_diagnostics): - """ - Sets the jvm_diagnostics of this ProcessorDiagnosticsDTO. - Diagnostic Information about the JVM and system-level diagnostics - - :param jvm_diagnostics: The jvm_diagnostics of this ProcessorDiagnosticsDTO. - :type: JVMDiagnosticsDTO - """ - - self._jvm_diagnostics = jvm_diagnostics - - @property - def thread_dumps(self): - """ - Gets the thread_dumps of this ProcessorDiagnosticsDTO. - Thread Dumps that were taken of the threads that are active in the Processor - - :return: The thread_dumps of this ProcessorDiagnosticsDTO. - :rtype: list[ThreadDumpDTO] - """ - return self._thread_dumps - - @thread_dumps.setter - def thread_dumps(self, thread_dumps): - """ - Sets the thread_dumps of this ProcessorDiagnosticsDTO. - Thread Dumps that were taken of the threads that are active in the Processor - - :param thread_dumps: The thread_dumps of this ProcessorDiagnosticsDTO. - :type: list[ThreadDumpDTO] - """ - - self._thread_dumps = thread_dumps - - @property - def class_loader_diagnostics(self): - """ - Gets the class_loader_diagnostics of this ProcessorDiagnosticsDTO. - Information about the Controller Service's Class Loader - - :return: The class_loader_diagnostics of this ProcessorDiagnosticsDTO. - :rtype: ClassLoaderDiagnosticsDTO - """ - return self._class_loader_diagnostics - - @class_loader_diagnostics.setter - def class_loader_diagnostics(self, class_loader_diagnostics): - """ - Sets the class_loader_diagnostics of this ProcessorDiagnosticsDTO. - Information about the Controller Service's Class Loader - - :param class_loader_diagnostics: The class_loader_diagnostics of this ProcessorDiagnosticsDTO. - :type: ClassLoaderDiagnosticsDTO - """ - - self._class_loader_diagnostics = class_loader_diagnostics - - 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, ProcessorDiagnosticsDTO): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other): - """ - Returns true if both objects are not equal - """ - return not self == other diff --git a/nipyapi/nifi/models/processor_dto.py b/nipyapi/nifi/models/processor_dto.py index f80e5453..1a9ec7bc 100644 --- a/nipyapi/nifi/models/processor_dto.py +++ b/nipyapi/nifi/models/processor_dto.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,516 +27,451 @@ class ProcessorDTO(object): and the value is json key in definition. """ swagger_types = { - 'id': 'str', - 'versioned_component_id': 'str', - 'parent_group_id': 'str', - 'position': 'PositionDTO', - 'name': 'str', - 'type': 'str', 'bundle': 'BundleDTO', - 'state': 'str', - 'style': 'dict(str, str)', - 'relationships': 'list[RelationshipDTO]', - 'description': 'str', - 'supports_parallel_processing': 'bool', - 'supports_event_driven': 'bool', - 'supports_batching': 'bool', - 'supports_sensitive_dynamic_properties': 'bool', - 'persists_state': 'bool', - 'restricted': 'bool', - 'deprecated': 'bool', - 'execution_node_restricted': 'bool', - 'multiple_versions_available': 'bool', - 'input_requirement': 'str', - 'config': 'ProcessorConfigDTO', - 'validation_errors': 'list[str]', - 'validation_status': 'str', - 'extension_missing': 'bool' - } +'config': 'ProcessorConfigDTO', +'deprecated': 'bool', +'description': 'str', +'execution_node_restricted': 'bool', +'extension_missing': 'bool', +'id': 'str', +'input_requirement': 'str', +'multiple_versions_available': 'bool', +'name': 'str', +'parent_group_id': 'str', +'persists_state': 'bool', +'position': 'PositionDTO', +'relationships': 'list[RelationshipDTO]', +'restricted': 'bool', +'state': 'str', +'style': 'dict(str, str)', +'supports_batching': 'bool', +'supports_parallel_processing': 'bool', +'supports_sensitive_dynamic_properties': 'bool', +'type': 'str', +'validation_errors': 'list[str]', +'validation_status': 'str', +'versioned_component_id': 'str' } attribute_map = { - 'id': 'id', - 'versioned_component_id': 'versionedComponentId', - 'parent_group_id': 'parentGroupId', - 'position': 'position', - 'name': 'name', - 'type': 'type', 'bundle': 'bundle', - 'state': 'state', - 'style': 'style', - 'relationships': 'relationships', - 'description': 'description', - 'supports_parallel_processing': 'supportsParallelProcessing', - 'supports_event_driven': 'supportsEventDriven', - 'supports_batching': 'supportsBatching', - 'supports_sensitive_dynamic_properties': 'supportsSensitiveDynamicProperties', - 'persists_state': 'persistsState', - 'restricted': 'restricted', - 'deprecated': 'deprecated', - 'execution_node_restricted': 'executionNodeRestricted', - 'multiple_versions_available': 'multipleVersionsAvailable', - 'input_requirement': 'inputRequirement', - 'config': 'config', - 'validation_errors': 'validationErrors', - 'validation_status': 'validationStatus', - 'extension_missing': 'extensionMissing' - } - - def __init__(self, id=None, versioned_component_id=None, parent_group_id=None, position=None, name=None, type=None, bundle=None, state=None, style=None, relationships=None, description=None, supports_parallel_processing=None, supports_event_driven=None, supports_batching=None, supports_sensitive_dynamic_properties=None, persists_state=None, restricted=None, deprecated=None, execution_node_restricted=None, multiple_versions_available=None, input_requirement=None, config=None, validation_errors=None, validation_status=None, extension_missing=None): +'config': 'config', +'deprecated': 'deprecated', +'description': 'description', +'execution_node_restricted': 'executionNodeRestricted', +'extension_missing': 'extensionMissing', +'id': 'id', +'input_requirement': 'inputRequirement', +'multiple_versions_available': 'multipleVersionsAvailable', +'name': 'name', +'parent_group_id': 'parentGroupId', +'persists_state': 'persistsState', +'position': 'position', +'relationships': 'relationships', +'restricted': 'restricted', +'state': 'state', +'style': 'style', +'supports_batching': 'supportsBatching', +'supports_parallel_processing': 'supportsParallelProcessing', +'supports_sensitive_dynamic_properties': 'supportsSensitiveDynamicProperties', +'type': 'type', +'validation_errors': 'validationErrors', +'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, 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): """ ProcessorDTO - a model defined in Swagger """ + self._bundle = None + self._config = None + self._deprecated = None + self._description = None + self._execution_node_restricted = None + self._extension_missing = None self._id = None - self._versioned_component_id = None + self._input_requirement = None + self._multiple_versions_available = None + self._name = None self._parent_group_id = None + self._persists_state = None self._position = None - self._name = None - self._type = None - self._bundle = None + self._relationships = None + self._restricted = None self._state = None self._style = None - self._relationships = None - self._description = None - self._supports_parallel_processing = None - self._supports_event_driven = None self._supports_batching = None + self._supports_parallel_processing = None self._supports_sensitive_dynamic_properties = None - self._persists_state = None - self._restricted = None - self._deprecated = None - self._execution_node_restricted = None - self._multiple_versions_available = None - self._input_requirement = None - self._config = None + self._type = None self._validation_errors = None self._validation_status = None - self._extension_missing = None + self._versioned_component_id = None + if bundle is not None: + self.bundle = bundle + if config is not None: + self.config = config + if deprecated is not None: + self.deprecated = deprecated + if description is not None: + self.description = description + if execution_node_restricted is not None: + self.execution_node_restricted = execution_node_restricted + if extension_missing is not None: + self.extension_missing = extension_missing if id is not None: self.id = id - if versioned_component_id is not None: - self.versioned_component_id = versioned_component_id + if input_requirement is not None: + self.input_requirement = input_requirement + if multiple_versions_available is not None: + self.multiple_versions_available = multiple_versions_available + if name is not None: + self.name = name if parent_group_id is not None: self.parent_group_id = parent_group_id + if persists_state is not None: + self.persists_state = persists_state if position is not None: self.position = position - if name is not None: - self.name = name - if type is not None: - self.type = type - if bundle is not None: - self.bundle = bundle + if relationships is not None: + self.relationships = relationships + if restricted is not None: + self.restricted = restricted if state is not None: self.state = state if style is not None: self.style = style - if relationships is not None: - self.relationships = relationships - if description is not None: - self.description = description - if supports_parallel_processing is not None: - self.supports_parallel_processing = supports_parallel_processing - if supports_event_driven is not None: - self.supports_event_driven = supports_event_driven if supports_batching is not None: self.supports_batching = supports_batching + if supports_parallel_processing is not None: + self.supports_parallel_processing = supports_parallel_processing if supports_sensitive_dynamic_properties is not None: self.supports_sensitive_dynamic_properties = supports_sensitive_dynamic_properties - if persists_state is not None: - self.persists_state = persists_state - if restricted is not None: - self.restricted = restricted - if deprecated is not None: - self.deprecated = deprecated - if execution_node_restricted is not None: - self.execution_node_restricted = execution_node_restricted - if multiple_versions_available is not None: - self.multiple_versions_available = multiple_versions_available - if input_requirement is not None: - self.input_requirement = input_requirement - if config is not None: - self.config = config + if type is not None: + self.type = type if validation_errors is not None: self.validation_errors = validation_errors if validation_status is not None: self.validation_status = validation_status - if extension_missing is not None: - self.extension_missing = extension_missing - - @property - def id(self): - """ - Gets the id of this ProcessorDTO. - The id of the component. - - :return: The id of this ProcessorDTO. - :rtype: str - """ - return self._id - - @id.setter - def id(self, id): - """ - Sets the id of this ProcessorDTO. - The id of the component. - - :param id: The id of this ProcessorDTO. - :type: str - """ - - self._id = id + if versioned_component_id is not None: + self.versioned_component_id = versioned_component_id @property - def versioned_component_id(self): + def bundle(self): """ - Gets the versioned_component_id of this ProcessorDTO. - The ID of the corresponding component that is under version control + Gets the bundle of this ProcessorDTO. - :return: The versioned_component_id of this ProcessorDTO. - :rtype: str + :return: The bundle of this ProcessorDTO. + :rtype: BundleDTO """ - return self._versioned_component_id + return self._bundle - @versioned_component_id.setter - def versioned_component_id(self, versioned_component_id): + @bundle.setter + def bundle(self, bundle): """ - Sets the versioned_component_id of this ProcessorDTO. - The ID of the corresponding component that is under version control + Sets the bundle of this ProcessorDTO. - :param versioned_component_id: The versioned_component_id of this ProcessorDTO. - :type: str + :param bundle: The bundle of this ProcessorDTO. + :type: BundleDTO """ - self._versioned_component_id = versioned_component_id + self._bundle = bundle @property - def parent_group_id(self): + def config(self): """ - Gets the parent_group_id of this ProcessorDTO. - The id of parent process group of this component if applicable. + Gets the config of this ProcessorDTO. - :return: The parent_group_id of this ProcessorDTO. - :rtype: str + :return: The config of this ProcessorDTO. + :rtype: ProcessorConfigDTO """ - return self._parent_group_id + return self._config - @parent_group_id.setter - def parent_group_id(self, parent_group_id): + @config.setter + def config(self, config): """ - Sets the parent_group_id of this ProcessorDTO. - The id of parent process group of this component if applicable. + Sets the config of this ProcessorDTO. - :param parent_group_id: The parent_group_id of this ProcessorDTO. - :type: str + :param config: The config of this ProcessorDTO. + :type: ProcessorConfigDTO """ - self._parent_group_id = parent_group_id + self._config = config @property - def position(self): + def deprecated(self): """ - Gets the position of this ProcessorDTO. - The position of this component in the UI if applicable. + Gets the deprecated of this ProcessorDTO. + Whether the processor has been deprecated. - :return: The position of this ProcessorDTO. - :rtype: PositionDTO + :return: The deprecated of this ProcessorDTO. + :rtype: bool """ - return self._position + return self._deprecated - @position.setter - def position(self, position): + @deprecated.setter + def deprecated(self, deprecated): """ - Sets the position of this ProcessorDTO. - The position of this component in the UI if applicable. + Sets the deprecated of this ProcessorDTO. + Whether the processor has been deprecated. - :param position: The position of this ProcessorDTO. - :type: PositionDTO + :param deprecated: The deprecated of this ProcessorDTO. + :type: bool """ - self._position = position + self._deprecated = deprecated @property - def name(self): + def description(self): """ - Gets the name of this ProcessorDTO. - The name of the processor. + Gets the description of this ProcessorDTO. + The description of the processor. - :return: The name of this ProcessorDTO. + :return: The description of this ProcessorDTO. :rtype: str """ - return self._name + return self._description - @name.setter - def name(self, name): + @description.setter + def description(self, description): """ - Sets the name of this ProcessorDTO. - The name of the processor. + Sets the description of this ProcessorDTO. + The description of the processor. - :param name: The name of this ProcessorDTO. + :param description: The description of this ProcessorDTO. :type: str """ - self._name = name + self._description = description @property - def type(self): + def execution_node_restricted(self): """ - Gets the type of this ProcessorDTO. - The type of the processor. + Gets the execution_node_restricted of this ProcessorDTO. + Indicates if the execution node of a processor is restricted to run only on the primary node - :return: The type of this ProcessorDTO. - :rtype: str + :return: The execution_node_restricted of this ProcessorDTO. + :rtype: bool """ - return self._type + return self._execution_node_restricted - @type.setter - def type(self, type): + @execution_node_restricted.setter + def execution_node_restricted(self, execution_node_restricted): """ - Sets the type of this ProcessorDTO. - The type of the processor. + Sets the execution_node_restricted of this ProcessorDTO. + Indicates if the execution node of a processor is restricted to run only on the primary node - :param type: The type of this ProcessorDTO. - :type: str + :param execution_node_restricted: The execution_node_restricted of this ProcessorDTO. + :type: bool """ - self._type = type + self._execution_node_restricted = execution_node_restricted @property - def bundle(self): + def extension_missing(self): """ - Gets the bundle of this ProcessorDTO. - The details of the artifact that bundled this processor type. + Gets the extension_missing of this ProcessorDTO. + Whether the underlying extension is missing. - :return: The bundle of this ProcessorDTO. - :rtype: BundleDTO + :return: The extension_missing of this ProcessorDTO. + :rtype: bool """ - return self._bundle + return self._extension_missing - @bundle.setter - def bundle(self, bundle): + @extension_missing.setter + def extension_missing(self, extension_missing): """ - Sets the bundle of this ProcessorDTO. - The details of the artifact that bundled this processor type. + Sets the extension_missing of this ProcessorDTO. + Whether the underlying extension is missing. - :param bundle: The bundle of this ProcessorDTO. - :type: BundleDTO + :param extension_missing: The extension_missing of this ProcessorDTO. + :type: bool """ - self._bundle = bundle + self._extension_missing = extension_missing @property - def state(self): + def id(self): """ - Gets the state of this ProcessorDTO. - The state of the processor + Gets the id of this ProcessorDTO. + The id of the component. - :return: The state of this ProcessorDTO. + :return: The id of this ProcessorDTO. :rtype: str """ - return self._state + return self._id - @state.setter - def state(self, state): + @id.setter + def id(self, id): """ - Sets the state of this ProcessorDTO. - The state of the processor + Sets the id of this ProcessorDTO. + The id of the component. - :param state: The state of this ProcessorDTO. + :param id: The id of this ProcessorDTO. :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) - ) - self._state = state + self._id = id @property - def style(self): + def input_requirement(self): """ - Gets the style of this ProcessorDTO. - Styles for the processor (background-color : #eee). + Gets the input_requirement of this ProcessorDTO. + The input requirement for this processor. - :return: The style of this ProcessorDTO. - :rtype: dict(str, str) + :return: The input_requirement of this ProcessorDTO. + :rtype: str """ - return self._style + return self._input_requirement - @style.setter - def style(self, style): + @input_requirement.setter + def input_requirement(self, input_requirement): """ - Sets the style of this ProcessorDTO. - Styles for the processor (background-color : #eee). + Sets the input_requirement of this ProcessorDTO. + The input requirement for this processor. - :param style: The style of this ProcessorDTO. - :type: dict(str, str) + :param input_requirement: The input_requirement of this ProcessorDTO. + :type: str """ - self._style = style + self._input_requirement = input_requirement @property - def relationships(self): + def multiple_versions_available(self): """ - Gets the relationships of this ProcessorDTO. - The available relationships that the processor currently supports. + Gets the multiple_versions_available of this ProcessorDTO. + Whether the processor has multiple versions available. - :return: The relationships of this ProcessorDTO. - :rtype: list[RelationshipDTO] + :return: The multiple_versions_available of this ProcessorDTO. + :rtype: bool """ - return self._relationships + return self._multiple_versions_available - @relationships.setter - def relationships(self, relationships): + @multiple_versions_available.setter + def multiple_versions_available(self, multiple_versions_available): """ - Sets the relationships of this ProcessorDTO. - The available relationships that the processor currently supports. + Sets the multiple_versions_available of this ProcessorDTO. + Whether the processor has multiple versions available. - :param relationships: The relationships of this ProcessorDTO. - :type: list[RelationshipDTO] + :param multiple_versions_available: The multiple_versions_available of this ProcessorDTO. + :type: bool """ - self._relationships = relationships + self._multiple_versions_available = multiple_versions_available @property - def description(self): + def name(self): """ - Gets the description of this ProcessorDTO. - The description of the processor. + Gets the name of this ProcessorDTO. + The name of the processor. - :return: The description of this ProcessorDTO. + :return: The name of this ProcessorDTO. :rtype: str """ - return self._description + return self._name - @description.setter - def description(self, description): + @name.setter + def name(self, name): """ - Sets the description of this ProcessorDTO. - The description of the processor. + Sets the name of this ProcessorDTO. + The name of the processor. - :param description: The description of this ProcessorDTO. + :param name: The name of this ProcessorDTO. :type: str """ - self._description = description - - @property - def supports_parallel_processing(self): - """ - Gets the supports_parallel_processing of this ProcessorDTO. - Whether the processor supports parallel processing. - - :return: The supports_parallel_processing of this ProcessorDTO. - :rtype: bool - """ - return self._supports_parallel_processing - - @supports_parallel_processing.setter - def supports_parallel_processing(self, supports_parallel_processing): - """ - Sets the supports_parallel_processing of this ProcessorDTO. - Whether the processor supports parallel processing. - - :param supports_parallel_processing: The supports_parallel_processing of this ProcessorDTO. - :type: bool - """ - - self._supports_parallel_processing = supports_parallel_processing + self._name = name @property - def supports_event_driven(self): + def parent_group_id(self): """ - Gets the supports_event_driven of this ProcessorDTO. - Whether the processor supports event driven scheduling. + Gets the parent_group_id of this ProcessorDTO. + The id of parent process group of this component if applicable. - :return: The supports_event_driven of this ProcessorDTO. - :rtype: bool + :return: The parent_group_id of this ProcessorDTO. + :rtype: str """ - return self._supports_event_driven + return self._parent_group_id - @supports_event_driven.setter - def supports_event_driven(self, supports_event_driven): + @parent_group_id.setter + def parent_group_id(self, parent_group_id): """ - Sets the supports_event_driven of this ProcessorDTO. - Whether the processor supports event driven scheduling. + Sets the parent_group_id of this ProcessorDTO. + The id of parent process group of this component if applicable. - :param supports_event_driven: The supports_event_driven of this ProcessorDTO. - :type: bool + :param parent_group_id: The parent_group_id of this ProcessorDTO. + :type: str """ - self._supports_event_driven = supports_event_driven + self._parent_group_id = parent_group_id @property - def supports_batching(self): + def persists_state(self): """ - Gets the supports_batching of this ProcessorDTO. - Whether the processor supports batching. This makes the run duration settings available. + Gets the persists_state of this ProcessorDTO. + Whether the processor persists state. - :return: The supports_batching of this ProcessorDTO. + :return: The persists_state of this ProcessorDTO. :rtype: bool """ - return self._supports_batching + return self._persists_state - @supports_batching.setter - def supports_batching(self, supports_batching): + @persists_state.setter + def persists_state(self, persists_state): """ - Sets the supports_batching of this ProcessorDTO. - Whether the processor supports batching. This makes the run duration settings available. + Sets the persists_state of this ProcessorDTO. + Whether the processor persists state. - :param supports_batching: The supports_batching of this ProcessorDTO. + :param persists_state: The persists_state of this ProcessorDTO. :type: bool """ - self._supports_batching = supports_batching + self._persists_state = persists_state @property - def supports_sensitive_dynamic_properties(self): + def position(self): """ - Gets the supports_sensitive_dynamic_properties of this ProcessorDTO. - Whether the processor supports sensitive dynamic properties. + Gets the position of this ProcessorDTO. - :return: The supports_sensitive_dynamic_properties of this ProcessorDTO. - :rtype: bool + :return: The position of this ProcessorDTO. + :rtype: PositionDTO """ - return self._supports_sensitive_dynamic_properties + return self._position - @supports_sensitive_dynamic_properties.setter - def supports_sensitive_dynamic_properties(self, supports_sensitive_dynamic_properties): + @position.setter + def position(self, position): """ - Sets the supports_sensitive_dynamic_properties of this ProcessorDTO. - Whether the processor supports sensitive dynamic properties. + Sets the position of this ProcessorDTO. - :param supports_sensitive_dynamic_properties: The supports_sensitive_dynamic_properties of this ProcessorDTO. - :type: bool + :param position: The position of this ProcessorDTO. + :type: PositionDTO """ - self._supports_sensitive_dynamic_properties = supports_sensitive_dynamic_properties + self._position = position @property - def persists_state(self): + def relationships(self): """ - Gets the persists_state of this ProcessorDTO. - Whether the processor persists state. + Gets the relationships of this ProcessorDTO. + The available relationships that the processor currently supports. - :return: The persists_state of this ProcessorDTO. - :rtype: bool + :return: The relationships of this ProcessorDTO. + :rtype: list[RelationshipDTO] """ - return self._persists_state + return self._relationships - @persists_state.setter - def persists_state(self, persists_state): + @relationships.setter + def relationships(self, relationships): """ - Sets the persists_state of this ProcessorDTO. - Whether the processor persists state. + Sets the relationships of this ProcessorDTO. + The available relationships that the processor currently supports. - :param persists_state: The persists_state of this ProcessorDTO. - :type: bool + :param relationships: The relationships of this ProcessorDTO. + :type: list[RelationshipDTO] """ - self._persists_state = persists_state + self._relationships = relationships @property def restricted(self): @@ -563,119 +497,148 @@ def restricted(self, restricted): self._restricted = restricted @property - def deprecated(self): + def state(self): """ - Gets the deprecated of this ProcessorDTO. - Whether the processor has been deprecated. + Gets the state of this ProcessorDTO. + The state of the processor - :return: The deprecated of this ProcessorDTO. - :rtype: bool + :return: The state of this ProcessorDTO. + :rtype: str """ - return self._deprecated + return self._state - @deprecated.setter - def deprecated(self, deprecated): + @state.setter + def state(self, state): """ - Sets the deprecated of this ProcessorDTO. - Whether the processor has been deprecated. + Sets the state of this ProcessorDTO. + The state of the processor - :param deprecated: The deprecated of this ProcessorDTO. - :type: bool + :param state: The state of this ProcessorDTO. + :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) + ) - self._deprecated = deprecated + self._state = state @property - def execution_node_restricted(self): + def style(self): """ - Gets the execution_node_restricted of this ProcessorDTO. - Indicates if the execution node of a processor is restricted to run only on the primary node + Gets the style of this ProcessorDTO. + Styles for the processor (background-color : #eee). - :return: The execution_node_restricted of this ProcessorDTO. + :return: The style of this ProcessorDTO. + :rtype: dict(str, str) + """ + return self._style + + @style.setter + def style(self, style): + """ + Sets the style of this ProcessorDTO. + Styles for the processor (background-color : #eee). + + :param style: The style of this ProcessorDTO. + :type: dict(str, str) + """ + + self._style = style + + @property + def supports_batching(self): + """ + Gets the supports_batching of this ProcessorDTO. + Whether the processor supports batching. This makes the run duration settings available. + + :return: The supports_batching of this ProcessorDTO. :rtype: bool """ - return self._execution_node_restricted + return self._supports_batching - @execution_node_restricted.setter - def execution_node_restricted(self, execution_node_restricted): + @supports_batching.setter + def supports_batching(self, supports_batching): """ - Sets the execution_node_restricted of this ProcessorDTO. - Indicates if the execution node of a processor is restricted to run only on the primary node + Sets the supports_batching of this ProcessorDTO. + Whether the processor supports batching. This makes the run duration settings available. - :param execution_node_restricted: The execution_node_restricted of this ProcessorDTO. + :param supports_batching: The supports_batching of this ProcessorDTO. :type: bool """ - self._execution_node_restricted = execution_node_restricted + self._supports_batching = supports_batching @property - def multiple_versions_available(self): + def supports_parallel_processing(self): """ - Gets the multiple_versions_available of this ProcessorDTO. - Whether the processor has multiple versions available. + Gets the supports_parallel_processing of this ProcessorDTO. + Whether the processor supports parallel processing. - :return: The multiple_versions_available of this ProcessorDTO. + :return: The supports_parallel_processing of this ProcessorDTO. :rtype: bool """ - return self._multiple_versions_available + return self._supports_parallel_processing - @multiple_versions_available.setter - def multiple_versions_available(self, multiple_versions_available): + @supports_parallel_processing.setter + def supports_parallel_processing(self, supports_parallel_processing): """ - Sets the multiple_versions_available of this ProcessorDTO. - Whether the processor has multiple versions available. + Sets the supports_parallel_processing of this ProcessorDTO. + Whether the processor supports parallel processing. - :param multiple_versions_available: The multiple_versions_available of this ProcessorDTO. + :param supports_parallel_processing: The supports_parallel_processing of this ProcessorDTO. :type: bool """ - self._multiple_versions_available = multiple_versions_available + self._supports_parallel_processing = supports_parallel_processing @property - def input_requirement(self): + def supports_sensitive_dynamic_properties(self): """ - Gets the input_requirement of this ProcessorDTO. - The input requirement for this processor. + Gets the supports_sensitive_dynamic_properties of this ProcessorDTO. + Whether the processor supports sensitive dynamic properties. - :return: The input_requirement of this ProcessorDTO. - :rtype: str + :return: The supports_sensitive_dynamic_properties of this ProcessorDTO. + :rtype: bool """ - return self._input_requirement + return self._supports_sensitive_dynamic_properties - @input_requirement.setter - def input_requirement(self, input_requirement): + @supports_sensitive_dynamic_properties.setter + def supports_sensitive_dynamic_properties(self, supports_sensitive_dynamic_properties): """ - Sets the input_requirement of this ProcessorDTO. - The input requirement for this processor. + Sets the supports_sensitive_dynamic_properties of this ProcessorDTO. + Whether the processor supports sensitive dynamic properties. - :param input_requirement: The input_requirement of this ProcessorDTO. - :type: str + :param supports_sensitive_dynamic_properties: The supports_sensitive_dynamic_properties of this ProcessorDTO. + :type: bool """ - self._input_requirement = input_requirement + self._supports_sensitive_dynamic_properties = supports_sensitive_dynamic_properties @property - def config(self): + def type(self): """ - Gets the config of this ProcessorDTO. - The configuration details for the processor. These details will be included in a response if the verbose flag is included in a request. + Gets the type of this ProcessorDTO. + The type of the processor. - :return: The config of this ProcessorDTO. - :rtype: ProcessorConfigDTO + :return: The type of this ProcessorDTO. + :rtype: str """ - return self._config + return self._type - @config.setter - def config(self, config): + @type.setter + def type(self, type): """ - Sets the config of this ProcessorDTO. - The configuration details for the processor. These details will be included in a response if the verbose flag is included in a request. + Sets the type of this ProcessorDTO. + The type of the processor. - :param config: The config of this ProcessorDTO. - :type: ProcessorConfigDTO + :param type: The type of this ProcessorDTO. + :type: str """ - self._config = config + self._type = type @property def validation_errors(self): @@ -720,7 +683,7 @@ def validation_status(self, validation_status): :param validation_status: The validation_status of this ProcessorDTO. :type: str """ - allowed_values = ["VALID", "INVALID", "VALIDATING"] + 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}" @@ -730,27 +693,27 @@ def validation_status(self, validation_status): self._validation_status = validation_status @property - def extension_missing(self): + def versioned_component_id(self): """ - Gets the extension_missing of this ProcessorDTO. - Whether the underlying extension is missing. + Gets the versioned_component_id of this ProcessorDTO. + The ID of the corresponding component that is under version control - :return: The extension_missing of this ProcessorDTO. - :rtype: bool + :return: The versioned_component_id of this ProcessorDTO. + :rtype: str """ - return self._extension_missing + return self._versioned_component_id - @extension_missing.setter - def extension_missing(self, extension_missing): + @versioned_component_id.setter + def versioned_component_id(self, versioned_component_id): """ - Sets the extension_missing of this ProcessorDTO. - Whether the underlying extension is missing. + Sets the versioned_component_id of this ProcessorDTO. + The ID of the corresponding component that is under version control - :param extension_missing: The extension_missing of this ProcessorDTO. - :type: bool + :param versioned_component_id: The versioned_component_id of this ProcessorDTO. + :type: str """ - self._extension_missing = extension_missing + self._versioned_component_id = versioned_component_id def to_dict(self): """ diff --git a/nipyapi/nifi/models/processor_entity.py b/nipyapi/nifi/models/processor_entity.py index d1368aca..4ab05058 100644 --- a/nipyapi/nifi/models/processor_entity.py +++ b/nipyapi/nifi/models/processor_entity.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,95 +27,137 @@ class ProcessorEntity(object): and the value is json key in definition. """ swagger_types = { - 'revision': 'RevisionDTO', - 'id': 'str', - 'uri': 'str', - 'position': 'PositionDTO', - 'permissions': 'PermissionsDTO', 'bulletins': 'list[BulletinEntity]', - 'disconnected_node_acknowledged': 'bool', - 'component': 'ProcessorDTO', - 'input_requirement': 'str', - 'status': 'ProcessorStatusDTO', - 'operate_permissions': 'PermissionsDTO' - } +'component': 'ProcessorDTO', +'disconnected_node_acknowledged': 'bool', +'id': 'str', +'input_requirement': 'str', +'operate_permissions': 'PermissionsDTO', +'permissions': 'PermissionsDTO', +'position': 'PositionDTO', +'revision': 'RevisionDTO', +'status': 'ProcessorStatusDTO', +'uri': 'str' } attribute_map = { - 'revision': 'revision', - 'id': 'id', - 'uri': 'uri', - 'position': 'position', - 'permissions': 'permissions', 'bulletins': 'bulletins', - 'disconnected_node_acknowledged': 'disconnectedNodeAcknowledged', - 'component': 'component', - 'input_requirement': 'inputRequirement', - 'status': 'status', - 'operate_permissions': 'operatePermissions' - } - - def __init__(self, revision=None, id=None, uri=None, position=None, permissions=None, bulletins=None, disconnected_node_acknowledged=None, component=None, input_requirement=None, status=None, operate_permissions=None): +'component': 'component', +'disconnected_node_acknowledged': 'disconnectedNodeAcknowledged', +'id': 'id', +'input_requirement': 'inputRequirement', +'operate_permissions': 'operatePermissions', +'permissions': 'permissions', +'position': 'position', +'revision': 'revision', +'status': 'status', +'uri': 'uri' } + + def __init__(self, bulletins=None, component=None, disconnected_node_acknowledged=None, id=None, input_requirement=None, operate_permissions=None, permissions=None, position=None, revision=None, status=None, uri=None): """ ProcessorEntity - a model defined in Swagger """ - self._revision = None - self._id = None - self._uri = None - self._position = None - self._permissions = None self._bulletins = None - self._disconnected_node_acknowledged = None self._component = None + self._disconnected_node_acknowledged = None + self._id = None self._input_requirement = None - self._status = None self._operate_permissions = None + self._permissions = None + self._position = None + self._revision = None + self._status = None + self._uri = None - if revision is not None: - self.revision = revision - if id is not None: - self.id = id - if uri is not None: - self.uri = uri - if position is not None: - self.position = position - if permissions is not None: - self.permissions = permissions if bulletins is not None: self.bulletins = bulletins - if disconnected_node_acknowledged is not None: - self.disconnected_node_acknowledged = disconnected_node_acknowledged if component is not None: self.component = component + if disconnected_node_acknowledged is not None: + self.disconnected_node_acknowledged = disconnected_node_acknowledged + if id is not None: + self.id = id if input_requirement is not None: self.input_requirement = input_requirement - if status is not None: - self.status = status if operate_permissions is not None: self.operate_permissions = operate_permissions + if permissions is not None: + self.permissions = permissions + if position is not None: + self.position = position + if revision is not None: + self.revision = revision + if status is not None: + self.status = status + if uri is not None: + self.uri = uri @property - def revision(self): + def bulletins(self): """ - Gets the revision of this ProcessorEntity. - The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses. + Gets the bulletins of this ProcessorEntity. + The bulletins for this component. - :return: The revision of this ProcessorEntity. - :rtype: RevisionDTO + :return: The bulletins of this ProcessorEntity. + :rtype: list[BulletinEntity] """ - return self._revision + return self._bulletins - @revision.setter - def revision(self, revision): + @bulletins.setter + def bulletins(self, bulletins): """ - Sets the revision of this ProcessorEntity. - The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses. + Sets the bulletins of this ProcessorEntity. + The bulletins for this component. - :param revision: The revision of this ProcessorEntity. - :type: RevisionDTO + :param bulletins: The bulletins of this ProcessorEntity. + :type: list[BulletinEntity] """ - self._revision = revision + self._bulletins = bulletins + + @property + def component(self): + """ + Gets the component of this ProcessorEntity. + + :return: The component of this ProcessorEntity. + :rtype: ProcessorDTO + """ + return self._component + + @component.setter + def component(self, component): + """ + Sets the component of this ProcessorEntity. + + :param component: The component of this ProcessorEntity. + :type: ProcessorDTO + """ + + self._component = component + + @property + def disconnected_node_acknowledged(self): + """ + Gets the disconnected_node_acknowledged of this ProcessorEntity. + Acknowledges that this node is disconnected to allow for mutable requests to proceed. + + :return: The disconnected_node_acknowledged of this ProcessorEntity. + :rtype: bool + """ + return self._disconnected_node_acknowledged + + @disconnected_node_acknowledged.setter + def disconnected_node_acknowledged(self, disconnected_node_acknowledged): + """ + Sets the disconnected_node_acknowledged of this ProcessorEntity. + Acknowledges that this node is disconnected to allow for mutable requests to proceed. + + :param disconnected_node_acknowledged: The disconnected_node_acknowledged of this ProcessorEntity. + :type: bool + """ + + self._disconnected_node_acknowledged = disconnected_node_acknowledged @property def id(self): @@ -142,56 +183,53 @@ def id(self, id): self._id = id @property - def uri(self): + def input_requirement(self): """ - Gets the uri of this ProcessorEntity. - The URI for futures requests to the component. + Gets the input_requirement of this ProcessorEntity. + The input requirement for this processor. - :return: The uri of this ProcessorEntity. + :return: The input_requirement of this ProcessorEntity. :rtype: str """ - return self._uri + return self._input_requirement - @uri.setter - def uri(self, uri): + @input_requirement.setter + def input_requirement(self, input_requirement): """ - Sets the uri of this ProcessorEntity. - The URI for futures requests to the component. + Sets the input_requirement of this ProcessorEntity. + The input requirement for this processor. - :param uri: The uri of this ProcessorEntity. + :param input_requirement: The input_requirement of this ProcessorEntity. :type: str """ - self._uri = uri + self._input_requirement = input_requirement @property - def position(self): + def operate_permissions(self): """ - Gets the position of this ProcessorEntity. - The position of this component in the UI if applicable. + Gets the operate_permissions of this ProcessorEntity. - :return: The position of this ProcessorEntity. - :rtype: PositionDTO + :return: The operate_permissions of this ProcessorEntity. + :rtype: PermissionsDTO """ - return self._position + return self._operate_permissions - @position.setter - def position(self, position): + @operate_permissions.setter + def operate_permissions(self, operate_permissions): """ - Sets the position of this ProcessorEntity. - The position of this component in the UI if applicable. + Sets the operate_permissions of this ProcessorEntity. - :param position: The position of this ProcessorEntity. - :type: PositionDTO + :param operate_permissions: The operate_permissions of this ProcessorEntity. + :type: PermissionsDTO """ - self._position = position + self._operate_permissions = operate_permissions @property def permissions(self): """ Gets the permissions of this ProcessorEntity. - The permissions for this component. :return: The permissions of this ProcessorEntity. :rtype: PermissionsDTO @@ -202,7 +240,6 @@ def permissions(self): def permissions(self, permissions): """ Sets the permissions of this ProcessorEntity. - The permissions for this component. :param permissions: The permissions of this ProcessorEntity. :type: PermissionsDTO @@ -211,94 +248,46 @@ def permissions(self, permissions): self._permissions = permissions @property - def bulletins(self): - """ - Gets the bulletins of this ProcessorEntity. - The bulletins for this component. - - :return: The bulletins of this ProcessorEntity. - :rtype: list[BulletinEntity] - """ - return self._bulletins - - @bulletins.setter - def bulletins(self, bulletins): - """ - Sets the bulletins of this ProcessorEntity. - The bulletins for this component. - - :param bulletins: The bulletins of this ProcessorEntity. - :type: list[BulletinEntity] - """ - - self._bulletins = bulletins - - @property - def disconnected_node_acknowledged(self): - """ - Gets the disconnected_node_acknowledged of this ProcessorEntity. - Acknowledges that this node is disconnected to allow for mutable requests to proceed. - - :return: The disconnected_node_acknowledged of this ProcessorEntity. - :rtype: bool - """ - return self._disconnected_node_acknowledged - - @disconnected_node_acknowledged.setter - def disconnected_node_acknowledged(self, disconnected_node_acknowledged): - """ - Sets the disconnected_node_acknowledged of this ProcessorEntity. - Acknowledges that this node is disconnected to allow for mutable requests to proceed. - - :param disconnected_node_acknowledged: The disconnected_node_acknowledged of this ProcessorEntity. - :type: bool - """ - - self._disconnected_node_acknowledged = disconnected_node_acknowledged - - @property - def component(self): + def position(self): """ - Gets the component of this ProcessorEntity. + Gets the position of this ProcessorEntity. - :return: The component of this ProcessorEntity. - :rtype: ProcessorDTO + :return: The position of this ProcessorEntity. + :rtype: PositionDTO """ - return self._component + return self._position - @component.setter - def component(self, component): + @position.setter + def position(self, position): """ - Sets the component of this ProcessorEntity. + Sets the position of this ProcessorEntity. - :param component: The component of this ProcessorEntity. - :type: ProcessorDTO + :param position: The position of this ProcessorEntity. + :type: PositionDTO """ - self._component = component + self._position = position @property - def input_requirement(self): + def revision(self): """ - Gets the input_requirement of this ProcessorEntity. - The input requirement for this processor. + Gets the revision of this ProcessorEntity. - :return: The input_requirement of this ProcessorEntity. - :rtype: str + :return: The revision of this ProcessorEntity. + :rtype: RevisionDTO """ - return self._input_requirement + return self._revision - @input_requirement.setter - def input_requirement(self, input_requirement): + @revision.setter + def revision(self, revision): """ - Sets the input_requirement of this ProcessorEntity. - The input requirement for this processor. + Sets the revision of this ProcessorEntity. - :param input_requirement: The input_requirement of this ProcessorEntity. - :type: str + :param revision: The revision of this ProcessorEntity. + :type: RevisionDTO """ - self._input_requirement = input_requirement + self._revision = revision @property def status(self): @@ -322,27 +311,27 @@ def status(self, status): self._status = status @property - def operate_permissions(self): + def uri(self): """ - Gets the operate_permissions of this ProcessorEntity. - The permissions for this component operations. + Gets the uri of this ProcessorEntity. + The URI for futures requests to the component. - :return: The operate_permissions of this ProcessorEntity. - :rtype: PermissionsDTO + :return: The uri of this ProcessorEntity. + :rtype: str """ - return self._operate_permissions + return self._uri - @operate_permissions.setter - def operate_permissions(self, operate_permissions): + @uri.setter + def uri(self, uri): """ - Sets the operate_permissions of this ProcessorEntity. - The permissions for this component operations. + Sets the uri of this ProcessorEntity. + The URI for futures requests to the component. - :param operate_permissions: The operate_permissions of this ProcessorEntity. - :type: PermissionsDTO + :param uri: The uri of this ProcessorEntity. + :type: str """ - self._operate_permissions = operate_permissions + self._uri = uri def to_dict(self): """ diff --git a/nipyapi/nifi/models/processor_run_status_details_dto.py b/nipyapi/nifi/models/processor_run_status_details_dto.py index bea0ba34..918c58c8 100644 --- a/nipyapi/nifi/models/processor_run_status_details_dto.py +++ b/nipyapi/nifi/models/processor_run_status_details_dto.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,32 +27,32 @@ class ProcessorRunStatusDetailsDTO(object): and the value is json key in definition. """ swagger_types = { - 'id': 'str', - 'name': 'str', - 'run_status': 'str', - 'validation_errors': 'list[str]', - 'active_thread_count': 'int' - } + 'active_thread_count': 'int', +'id': 'str', +'name': 'str', +'run_status': 'str', +'validation_errors': 'list[str]' } attribute_map = { - 'id': 'id', - 'name': 'name', - 'run_status': 'runStatus', - 'validation_errors': 'validationErrors', - 'active_thread_count': 'activeThreadCount' - } + 'active_thread_count': 'activeThreadCount', +'id': 'id', +'name': 'name', +'run_status': 'runStatus', +'validation_errors': 'validationErrors' } - def __init__(self, id=None, name=None, run_status=None, validation_errors=None, active_thread_count=None): + def __init__(self, active_thread_count=None, id=None, name=None, run_status=None, validation_errors=None): """ ProcessorRunStatusDetailsDTO - a model defined in Swagger """ + self._active_thread_count = None self._id = None self._name = None self._run_status = None self._validation_errors = None - self._active_thread_count = None + if active_thread_count is not None: + self.active_thread_count = active_thread_count if id is not None: self.id = id if name is not None: @@ -62,8 +61,29 @@ def __init__(self, id=None, name=None, run_status=None, validation_errors=None, self.run_status = run_status if validation_errors is not None: self.validation_errors = validation_errors - if active_thread_count is not None: - self.active_thread_count = active_thread_count + + @property + def active_thread_count(self): + """ + Gets the active_thread_count of this ProcessorRunStatusDetailsDTO. + The current number of threads that the processor is currently using + + :return: The active_thread_count of this ProcessorRunStatusDetailsDTO. + :rtype: int + """ + return self._active_thread_count + + @active_thread_count.setter + def active_thread_count(self, active_thread_count): + """ + Sets the active_thread_count of this ProcessorRunStatusDetailsDTO. + The current number of threads that the processor is currently using + + :param active_thread_count: The active_thread_count of this ProcessorRunStatusDetailsDTO. + :type: int + """ + + self._active_thread_count = active_thread_count @property def id(self): @@ -131,7 +151,7 @@ def run_status(self, run_status): :param run_status: The run_status of this ProcessorRunStatusDetailsDTO. :type: str """ - allowed_values = ["Running", "Stopped", "Invalid", "Validating", "Disabled"] + 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}" @@ -163,29 +183,6 @@ def validation_errors(self, validation_errors): self._validation_errors = validation_errors - @property - def active_thread_count(self): - """ - Gets the active_thread_count of this ProcessorRunStatusDetailsDTO. - The current number of threads that the processor is currently using - - :return: The active_thread_count of this ProcessorRunStatusDetailsDTO. - :rtype: int - """ - return self._active_thread_count - - @active_thread_count.setter - def active_thread_count(self, active_thread_count): - """ - Sets the active_thread_count of this ProcessorRunStatusDetailsDTO. - The current number of threads that the processor is currently using - - :param active_thread_count: The active_thread_count of this ProcessorRunStatusDetailsDTO. - :type: int - """ - - self._active_thread_count = active_thread_count - def to_dict(self): """ Returns the model properties as a dict diff --git a/nipyapi/nifi/models/processor_run_status_details_entity.py b/nipyapi/nifi/models/processor_run_status_details_entity.py index b6d4adfa..9f0ae3c8 100644 --- a/nipyapi/nifi/models/processor_run_status_details_entity.py +++ b/nipyapi/nifi/models/processor_run_status_details_entity.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,61 +27,35 @@ class ProcessorRunStatusDetailsEntity(object): and the value is json key in definition. """ swagger_types = { - 'revision': 'RevisionDTO', 'permissions': 'PermissionsDTO', - 'run_status_details': 'ProcessorRunStatusDetailsDTO' - } +'revision': 'RevisionDTO', +'run_status_details': 'ProcessorRunStatusDetailsDTO' } attribute_map = { - 'revision': 'revision', 'permissions': 'permissions', - 'run_status_details': 'runStatusDetails' - } +'revision': 'revision', +'run_status_details': 'runStatusDetails' } - def __init__(self, revision=None, permissions=None, run_status_details=None): + def __init__(self, permissions=None, revision=None, run_status_details=None): """ ProcessorRunStatusDetailsEntity - a model defined in Swagger """ - self._revision = None self._permissions = None + self._revision = None self._run_status_details = None - if revision is not None: - self.revision = revision if permissions is not None: self.permissions = permissions + if revision is not None: + self.revision = revision if run_status_details is not None: self.run_status_details = run_status_details - @property - def revision(self): - """ - Gets the revision of this ProcessorRunStatusDetailsEntity. - The revision for the Processor. - - :return: The revision of this ProcessorRunStatusDetailsEntity. - :rtype: RevisionDTO - """ - return self._revision - - @revision.setter - def revision(self, revision): - """ - Sets the revision of this ProcessorRunStatusDetailsEntity. - The revision for the Processor. - - :param revision: The revision of this ProcessorRunStatusDetailsEntity. - :type: RevisionDTO - """ - - self._revision = revision - @property def permissions(self): """ Gets the permissions of this ProcessorRunStatusDetailsEntity. - The permissions for the Processor. :return: The permissions of this ProcessorRunStatusDetailsEntity. :rtype: PermissionsDTO @@ -93,7 +66,6 @@ def permissions(self): def permissions(self, permissions): """ Sets the permissions of this ProcessorRunStatusDetailsEntity. - The permissions for the Processor. :param permissions: The permissions of this ProcessorRunStatusDetailsEntity. :type: PermissionsDTO @@ -101,11 +73,31 @@ def permissions(self, permissions): self._permissions = permissions + @property + def revision(self): + """ + Gets the revision of this ProcessorRunStatusDetailsEntity. + + :return: The revision of this ProcessorRunStatusDetailsEntity. + :rtype: RevisionDTO + """ + return self._revision + + @revision.setter + def revision(self, revision): + """ + Sets the revision of this ProcessorRunStatusDetailsEntity. + + :param revision: The revision of this ProcessorRunStatusDetailsEntity. + :type: RevisionDTO + """ + + self._revision = revision + @property def run_status_details(self): """ Gets the run_status_details of this ProcessorRunStatusDetailsEntity. - The details of a Processor's run status :return: The run_status_details of this ProcessorRunStatusDetailsEntity. :rtype: ProcessorRunStatusDetailsDTO @@ -116,7 +108,6 @@ def run_status_details(self): def run_status_details(self, run_status_details): """ Sets the run_status_details of this ProcessorRunStatusDetailsEntity. - The details of a Processor's run status :param run_status_details: The run_status_details of this ProcessorRunStatusDetailsEntity. :type: ProcessorRunStatusDetailsDTO diff --git a/nipyapi/nifi/models/processor_run_status_entity.py b/nipyapi/nifi/models/processor_run_status_entity.py index 0a97db89..d7af6d82 100644 --- a/nipyapi/nifi/models/processor_run_status_entity.py +++ b/nipyapi/nifi/models/processor_run_status_entity.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,38 +27,58 @@ class ProcessorRunStatusEntity(object): and the value is json key in definition. """ swagger_types = { - 'revision': 'RevisionDTO', - 'state': 'str', - 'disconnected_node_acknowledged': 'bool' - } + 'disconnected_node_acknowledged': 'bool', +'revision': 'RevisionDTO', +'state': 'str' } attribute_map = { - 'revision': 'revision', - 'state': 'state', - 'disconnected_node_acknowledged': 'disconnectedNodeAcknowledged' - } + 'disconnected_node_acknowledged': 'disconnectedNodeAcknowledged', +'revision': 'revision', +'state': 'state' } - def __init__(self, revision=None, state=None, disconnected_node_acknowledged=None): + def __init__(self, disconnected_node_acknowledged=None, revision=None, state=None): """ ProcessorRunStatusEntity - a model defined in Swagger """ + self._disconnected_node_acknowledged = None self._revision = None self._state = None - self._disconnected_node_acknowledged = None + if disconnected_node_acknowledged is not None: + self.disconnected_node_acknowledged = disconnected_node_acknowledged if revision is not None: self.revision = revision if state is not None: self.state = state - if disconnected_node_acknowledged is not None: - self.disconnected_node_acknowledged = disconnected_node_acknowledged + + @property + def disconnected_node_acknowledged(self): + """ + Gets the disconnected_node_acknowledged of this ProcessorRunStatusEntity. + Acknowledges that this node is disconnected to allow for mutable requests to proceed. + + :return: The disconnected_node_acknowledged of this ProcessorRunStatusEntity. + :rtype: bool + """ + return self._disconnected_node_acknowledged + + @disconnected_node_acknowledged.setter + def disconnected_node_acknowledged(self, disconnected_node_acknowledged): + """ + Sets the disconnected_node_acknowledged of this ProcessorRunStatusEntity. + Acknowledges that this node is disconnected to allow for mutable requests to proceed. + + :param disconnected_node_acknowledged: The disconnected_node_acknowledged of this ProcessorRunStatusEntity. + :type: bool + """ + + self._disconnected_node_acknowledged = disconnected_node_acknowledged @property def revision(self): """ Gets the revision of this ProcessorRunStatusEntity. - The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses. :return: The revision of this ProcessorRunStatusEntity. :rtype: RevisionDTO @@ -70,7 +89,6 @@ def revision(self): def revision(self, revision): """ Sets the revision of this ProcessorRunStatusEntity. - The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses. :param revision: The revision of this ProcessorRunStatusEntity. :type: RevisionDTO @@ -98,7 +116,7 @@ def state(self, state): :param state: The state of this ProcessorRunStatusEntity. :type: str """ - allowed_values = ["RUNNING", "STOPPED", "DISABLED", "RUN_ONCE"] + 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}" @@ -107,29 +125,6 @@ def state(self, state): self._state = state - @property - def disconnected_node_acknowledged(self): - """ - Gets the disconnected_node_acknowledged of this ProcessorRunStatusEntity. - Acknowledges that this node is disconnected to allow for mutable requests to proceed. - - :return: The disconnected_node_acknowledged of this ProcessorRunStatusEntity. - :rtype: bool - """ - return self._disconnected_node_acknowledged - - @disconnected_node_acknowledged.setter - def disconnected_node_acknowledged(self, disconnected_node_acknowledged): - """ - Sets the disconnected_node_acknowledged of this ProcessorRunStatusEntity. - Acknowledges that this node is disconnected to allow for mutable requests to proceed. - - :param disconnected_node_acknowledged: The disconnected_node_acknowledged of this ProcessorRunStatusEntity. - :type: bool - """ - - self._disconnected_node_acknowledged = disconnected_node_acknowledged - def to_dict(self): """ Returns the model properties as a dict diff --git a/nipyapi/nifi/models/processor_status_dto.py b/nipyapi/nifi/models/processor_status_dto.py index a9cb5b11..2fe8e09d 100644 --- a/nipyapi/nifi/models/processor_status_dto.py +++ b/nipyapi/nifi/models/processor_status_dto.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,57 +27,76 @@ class ProcessorStatusDTO(object): and the value is json key in definition. """ swagger_types = { - 'group_id': 'str', - 'id': 'str', - 'name': 'str', - 'type': 'str', - 'run_status': 'str', - 'stats_last_refreshed': 'str', 'aggregate_snapshot': 'ProcessorStatusSnapshotDTO', - 'node_snapshots': 'list[NodeProcessorStatusSnapshotDTO]' - } +'group_id': 'str', +'id': 'str', +'name': 'str', +'node_snapshots': 'list[NodeProcessorStatusSnapshotDTO]', +'run_status': 'str', +'stats_last_refreshed': 'str', +'type': 'str' } attribute_map = { - 'group_id': 'groupId', - 'id': 'id', - 'name': 'name', - 'type': 'type', - 'run_status': 'runStatus', - 'stats_last_refreshed': 'statsLastRefreshed', 'aggregate_snapshot': 'aggregateSnapshot', - 'node_snapshots': 'nodeSnapshots' - } +'group_id': 'groupId', +'id': 'id', +'name': 'name', +'node_snapshots': 'nodeSnapshots', +'run_status': 'runStatus', +'stats_last_refreshed': 'statsLastRefreshed', +'type': 'type' } - def __init__(self, group_id=None, id=None, name=None, type=None, run_status=None, stats_last_refreshed=None, aggregate_snapshot=None, node_snapshots=None): + def __init__(self, aggregate_snapshot=None, group_id=None, id=None, name=None, node_snapshots=None, run_status=None, stats_last_refreshed=None, type=None): """ ProcessorStatusDTO - a model defined in Swagger """ + self._aggregate_snapshot = None self._group_id = None self._id = None self._name = None - self._type = None + self._node_snapshots = None self._run_status = None self._stats_last_refreshed = None - self._aggregate_snapshot = None - self._node_snapshots = None + self._type = None + if aggregate_snapshot is not None: + self.aggregate_snapshot = aggregate_snapshot if group_id is not None: self.group_id = group_id if id is not None: self.id = id if name is not None: self.name = name - if type is not None: - self.type = type + if node_snapshots is not None: + self.node_snapshots = node_snapshots if run_status is not None: self.run_status = run_status if stats_last_refreshed is not None: self.stats_last_refreshed = stats_last_refreshed - if aggregate_snapshot is not None: - self.aggregate_snapshot = aggregate_snapshot - if node_snapshots is not None: - self.node_snapshots = node_snapshots + if type is not None: + self.type = type + + @property + def aggregate_snapshot(self): + """ + Gets the aggregate_snapshot of this ProcessorStatusDTO. + + :return: The aggregate_snapshot of this ProcessorStatusDTO. + :rtype: ProcessorStatusSnapshotDTO + """ + return self._aggregate_snapshot + + @aggregate_snapshot.setter + def aggregate_snapshot(self, aggregate_snapshot): + """ + Sets the aggregate_snapshot of this ProcessorStatusDTO. + + :param aggregate_snapshot: The aggregate_snapshot of this ProcessorStatusDTO. + :type: ProcessorStatusSnapshotDTO + """ + + self._aggregate_snapshot = aggregate_snapshot @property def group_id(self): @@ -150,27 +168,27 @@ def name(self, name): self._name = name @property - def type(self): + def node_snapshots(self): """ - Gets the type of this ProcessorStatusDTO. - The type of the Processor + Gets the node_snapshots of this ProcessorStatusDTO. + A status snapshot for each node in the cluster. If the NiFi instance is a standalone instance, rather than a cluster, this may be null. - :return: The type of this ProcessorStatusDTO. - :rtype: str + :return: The node_snapshots of this ProcessorStatusDTO. + :rtype: list[NodeProcessorStatusSnapshotDTO] """ - return self._type + return self._node_snapshots - @type.setter - def type(self, type): + @node_snapshots.setter + def node_snapshots(self, node_snapshots): """ - Sets the type of this ProcessorStatusDTO. - The type of the Processor + Sets the node_snapshots of this ProcessorStatusDTO. + A status snapshot for each node in the cluster. If the NiFi instance is a standalone instance, rather than a cluster, this may be null. - :param type: The type of this ProcessorStatusDTO. - :type: str + :param node_snapshots: The node_snapshots of this ProcessorStatusDTO. + :type: list[NodeProcessorStatusSnapshotDTO] """ - self._type = type + self._node_snapshots = node_snapshots @property def run_status(self): @@ -192,7 +210,7 @@ def run_status(self, run_status): :param run_status: The run_status of this ProcessorStatusDTO. :type: str """ - allowed_values = ["Running", "Stopped", "Validating", "Disabled", "Invalid"] + 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}" @@ -225,50 +243,27 @@ def stats_last_refreshed(self, stats_last_refreshed): self._stats_last_refreshed = stats_last_refreshed @property - def aggregate_snapshot(self): - """ - Gets the aggregate_snapshot of this ProcessorStatusDTO. - A status snapshot that represents the aggregate stats of all nodes in the cluster. If the NiFi instance is a standalone instance, rather than a cluster, this represents the stats of the single instance. - - :return: The aggregate_snapshot of this ProcessorStatusDTO. - :rtype: ProcessorStatusSnapshotDTO - """ - return self._aggregate_snapshot - - @aggregate_snapshot.setter - def aggregate_snapshot(self, aggregate_snapshot): - """ - Sets the aggregate_snapshot of this ProcessorStatusDTO. - A status snapshot that represents the aggregate stats of all nodes in the cluster. If the NiFi instance is a standalone instance, rather than a cluster, this represents the stats of the single instance. - - :param aggregate_snapshot: The aggregate_snapshot of this ProcessorStatusDTO. - :type: ProcessorStatusSnapshotDTO - """ - - self._aggregate_snapshot = aggregate_snapshot - - @property - def node_snapshots(self): + def type(self): """ - Gets the node_snapshots of this ProcessorStatusDTO. - A status snapshot for each node in the cluster. If the NiFi instance is a standalone instance, rather than a cluster, this may be null. + Gets the type of this ProcessorStatusDTO. + The type of the Processor - :return: The node_snapshots of this ProcessorStatusDTO. - :rtype: list[NodeProcessorStatusSnapshotDTO] + :return: The type of this ProcessorStatusDTO. + :rtype: str """ - return self._node_snapshots + return self._type - @node_snapshots.setter - def node_snapshots(self, node_snapshots): + @type.setter + def type(self, type): """ - Sets the node_snapshots of this ProcessorStatusDTO. - A status snapshot for each node in the cluster. If the NiFi instance is a standalone instance, rather than a cluster, this may be null. + Sets the type of this ProcessorStatusDTO. + The type of the Processor - :param node_snapshots: The node_snapshots of this ProcessorStatusDTO. - :type: list[NodeProcessorStatusSnapshotDTO] + :param type: The type of this ProcessorStatusDTO. + :type: str """ - self._node_snapshots = node_snapshots + self._type = type def to_dict(self): """ diff --git a/nipyapi/nifi/models/processor_status_entity.py b/nipyapi/nifi/models/processor_status_entity.py index 4ea60fc5..7477eacd 100644 --- a/nipyapi/nifi/models/processor_status_entity.py +++ b/nipyapi/nifi/models/processor_status_entity.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,48 +27,25 @@ class ProcessorStatusEntity(object): and the value is json key in definition. """ swagger_types = { - 'processor_status': 'ProcessorStatusDTO', - 'can_read': 'bool' - } + 'can_read': 'bool', +'processor_status': 'ProcessorStatusDTO' } attribute_map = { - 'processor_status': 'processorStatus', - 'can_read': 'canRead' - } + 'can_read': 'canRead', +'processor_status': 'processorStatus' } - def __init__(self, processor_status=None, can_read=None): + def __init__(self, can_read=None, processor_status=None): """ ProcessorStatusEntity - a model defined in Swagger """ - self._processor_status = None self._can_read = None + self._processor_status = None - if processor_status is not None: - self.processor_status = processor_status if can_read is not None: self.can_read = can_read - - @property - def processor_status(self): - """ - Gets the processor_status of this ProcessorStatusEntity. - - :return: The processor_status of this ProcessorStatusEntity. - :rtype: ProcessorStatusDTO - """ - return self._processor_status - - @processor_status.setter - def processor_status(self, processor_status): - """ - Sets the processor_status of this ProcessorStatusEntity. - - :param processor_status: The processor_status of this ProcessorStatusEntity. - :type: ProcessorStatusDTO - """ - - self._processor_status = processor_status + if processor_status is not None: + self.processor_status = processor_status @property def can_read(self): @@ -94,6 +70,27 @@ def can_read(self, can_read): self._can_read = can_read + @property + def processor_status(self): + """ + Gets the processor_status of this ProcessorStatusEntity. + + :return: The processor_status of this ProcessorStatusEntity. + :rtype: ProcessorStatusDTO + """ + return self._processor_status + + @processor_status.setter + def processor_status(self, processor_status): + """ + Sets the processor_status of this ProcessorStatusEntity. + + :param processor_status: The processor_status of this ProcessorStatusEntity. + :type: ProcessorStatusDTO + """ + + self._processor_status = processor_status + def to_dict(self): """ Returns the model properties as a dict diff --git a/nipyapi/nifi/models/processor_status_snapshot_dto.py b/nipyapi/nifi/models/processor_status_snapshot_dto.py index 4e4a0322..d9d72b16 100644 --- a/nipyapi/nifi/models/processor_status_snapshot_dto.py +++ b/nipyapi/nifi/models/processor_status_snapshot_dto.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,253 +27,245 @@ class ProcessorStatusSnapshotDTO(object): and the value is json key in definition. """ swagger_types = { - 'id': 'str', - 'group_id': 'str', - 'name': 'str', - 'type': 'str', - 'run_status': 'str', - 'execution_node': 'str', - 'bytes_read': 'int', - 'bytes_written': 'int', - 'read': 'str', - 'written': 'str', - 'flow_files_in': 'int', - 'bytes_in': 'int', - 'input': 'str', - 'flow_files_out': 'int', - 'bytes_out': 'int', - 'output': 'str', - 'task_count': 'int', - 'tasks_duration_nanos': 'int', - 'tasks': 'str', - 'tasks_duration': 'str', 'active_thread_count': 'int', - 'terminated_thread_count': 'int', - 'processing_performance_status': 'ProcessingPerformanceStatusDTO' - } +'bytes_in': 'int', +'bytes_out': 'int', +'bytes_read': 'int', +'bytes_written': 'int', +'execution_node': 'str', +'flow_files_in': 'int', +'flow_files_out': 'int', +'group_id': 'str', +'id': 'str', +'input': 'str', +'name': 'str', +'output': 'str', +'processing_performance_status': 'ProcessingPerformanceStatusDTO', +'read': 'str', +'run_status': 'str', +'task_count': 'int', +'tasks': 'str', +'tasks_duration': 'str', +'tasks_duration_nanos': 'int', +'terminated_thread_count': 'int', +'type': 'str', +'written': 'str' } attribute_map = { - 'id': 'id', - 'group_id': 'groupId', - 'name': 'name', - 'type': 'type', - 'run_status': 'runStatus', - 'execution_node': 'executionNode', - 'bytes_read': 'bytesRead', - 'bytes_written': 'bytesWritten', - 'read': 'read', - 'written': 'written', - 'flow_files_in': 'flowFilesIn', - 'bytes_in': 'bytesIn', - 'input': 'input', - 'flow_files_out': 'flowFilesOut', - 'bytes_out': 'bytesOut', - 'output': 'output', - 'task_count': 'taskCount', - 'tasks_duration_nanos': 'tasksDurationNanos', - 'tasks': 'tasks', - 'tasks_duration': 'tasksDuration', 'active_thread_count': 'activeThreadCount', - 'terminated_thread_count': 'terminatedThreadCount', - 'processing_performance_status': 'processingPerformanceStatus' - } - - def __init__(self, id=None, group_id=None, name=None, type=None, run_status=None, execution_node=None, bytes_read=None, bytes_written=None, read=None, written=None, flow_files_in=None, bytes_in=None, input=None, flow_files_out=None, bytes_out=None, output=None, task_count=None, tasks_duration_nanos=None, tasks=None, tasks_duration=None, active_thread_count=None, terminated_thread_count=None, processing_performance_status=None): +'bytes_in': 'bytesIn', +'bytes_out': 'bytesOut', +'bytes_read': 'bytesRead', +'bytes_written': 'bytesWritten', +'execution_node': 'executionNode', +'flow_files_in': 'flowFilesIn', +'flow_files_out': 'flowFilesOut', +'group_id': 'groupId', +'id': 'id', +'input': 'input', +'name': 'name', +'output': 'output', +'processing_performance_status': 'processingPerformanceStatus', +'read': 'read', +'run_status': 'runStatus', +'task_count': 'taskCount', +'tasks': 'tasks', +'tasks_duration': 'tasksDuration', +'tasks_duration_nanos': 'tasksDurationNanos', +'terminated_thread_count': 'terminatedThreadCount', +'type': 'type', +'written': 'written' } + + def __init__(self, active_thread_count=None, bytes_in=None, bytes_out=None, bytes_read=None, bytes_written=None, execution_node=None, flow_files_in=None, flow_files_out=None, group_id=None, id=None, input=None, name=None, output=None, processing_performance_status=None, read=None, run_status=None, task_count=None, tasks=None, tasks_duration=None, tasks_duration_nanos=None, terminated_thread_count=None, type=None, written=None): """ ProcessorStatusSnapshotDTO - a model defined in Swagger """ - self._id = None - self._group_id = None - self._name = None - self._type = None - self._run_status = None - self._execution_node = None + self._active_thread_count = None + self._bytes_in = None + self._bytes_out = None self._bytes_read = None self._bytes_written = None - self._read = None - self._written = None + self._execution_node = None self._flow_files_in = None - self._bytes_in = None - self._input = None self._flow_files_out = None - self._bytes_out = None + self._group_id = None + self._id = None + self._input = None + self._name = None self._output = None + self._processing_performance_status = None + self._read = None + self._run_status = None self._task_count = None - self._tasks_duration_nanos = None self._tasks = None self._tasks_duration = None - self._active_thread_count = None + self._tasks_duration_nanos = None self._terminated_thread_count = None - self._processing_performance_status = None + self._type = None + self._written = None - if id is not None: - self.id = id - if group_id is not None: - self.group_id = group_id - if name is not None: - self.name = name - if type is not None: - self.type = type - if run_status is not None: - self.run_status = run_status - if execution_node is not None: - self.execution_node = execution_node + if active_thread_count is not None: + self.active_thread_count = active_thread_count + if bytes_in is not None: + self.bytes_in = bytes_in + if bytes_out is not None: + self.bytes_out = bytes_out if bytes_read is not None: self.bytes_read = bytes_read if bytes_written is not None: self.bytes_written = bytes_written - if read is not None: - self.read = read - if written is not None: - self.written = written + if execution_node is not None: + self.execution_node = execution_node if flow_files_in is not None: self.flow_files_in = flow_files_in - if bytes_in is not None: - self.bytes_in = bytes_in - if input is not None: - self.input = input if flow_files_out is not None: self.flow_files_out = flow_files_out - if bytes_out is not None: - self.bytes_out = bytes_out + if group_id is not None: + self.group_id = group_id + if id is not None: + self.id = id + if input is not None: + self.input = input + if name is not None: + self.name = name if output is not None: self.output = output + if processing_performance_status is not None: + self.processing_performance_status = processing_performance_status + if read is not None: + self.read = read + if run_status is not None: + self.run_status = run_status if task_count is not None: self.task_count = task_count - if tasks_duration_nanos is not None: - self.tasks_duration_nanos = tasks_duration_nanos if tasks is not None: self.tasks = tasks if tasks_duration is not None: self.tasks_duration = tasks_duration - if active_thread_count is not None: - self.active_thread_count = active_thread_count + if tasks_duration_nanos is not None: + self.tasks_duration_nanos = tasks_duration_nanos if terminated_thread_count is not None: self.terminated_thread_count = terminated_thread_count - if processing_performance_status is not None: - self.processing_performance_status = processing_performance_status + if type is not None: + self.type = type + if written is not None: + self.written = written @property - def id(self): + def active_thread_count(self): """ - Gets the id of this ProcessorStatusSnapshotDTO. - The id of the processor. + Gets the active_thread_count of this ProcessorStatusSnapshotDTO. + The number of threads currently executing in the processor. - :return: The id of this ProcessorStatusSnapshotDTO. - :rtype: str + :return: The active_thread_count of this ProcessorStatusSnapshotDTO. + :rtype: int """ - return self._id + return self._active_thread_count - @id.setter - def id(self, id): + @active_thread_count.setter + def active_thread_count(self, active_thread_count): """ - Sets the id of this ProcessorStatusSnapshotDTO. - The id of the processor. + Sets the active_thread_count of this ProcessorStatusSnapshotDTO. + The number of threads currently executing in the processor. - :param id: The id of this ProcessorStatusSnapshotDTO. - :type: str + :param active_thread_count: The active_thread_count of this ProcessorStatusSnapshotDTO. + :type: int """ - self._id = id + self._active_thread_count = active_thread_count @property - def group_id(self): + def bytes_in(self): """ - Gets the group_id of this ProcessorStatusSnapshotDTO. - The id of the parent process group to which the processor belongs. + Gets the bytes_in of this ProcessorStatusSnapshotDTO. + The size of the FlowFiles that have been accepted in the last 5 minutes - :return: The group_id of this ProcessorStatusSnapshotDTO. - :rtype: str + :return: The bytes_in of this ProcessorStatusSnapshotDTO. + :rtype: int """ - return self._group_id + return self._bytes_in - @group_id.setter - def group_id(self, group_id): + @bytes_in.setter + def bytes_in(self, bytes_in): """ - Sets the group_id of this ProcessorStatusSnapshotDTO. - The id of the parent process group to which the processor belongs. + Sets the bytes_in of this ProcessorStatusSnapshotDTO. + The size of the FlowFiles that have been accepted in the last 5 minutes - :param group_id: The group_id of this ProcessorStatusSnapshotDTO. - :type: str + :param bytes_in: The bytes_in of this ProcessorStatusSnapshotDTO. + :type: int """ - self._group_id = group_id + self._bytes_in = bytes_in @property - def name(self): + def bytes_out(self): """ - Gets the name of this ProcessorStatusSnapshotDTO. - The name of the prcessor. + Gets the bytes_out of this ProcessorStatusSnapshotDTO. + The size of the FlowFiles transferred to a Connection in the last 5 minutes - :return: The name of this ProcessorStatusSnapshotDTO. - :rtype: str + :return: The bytes_out of this ProcessorStatusSnapshotDTO. + :rtype: int """ - return self._name + return self._bytes_out - @name.setter - def name(self, name): + @bytes_out.setter + def bytes_out(self, bytes_out): """ - Sets the name of this ProcessorStatusSnapshotDTO. - The name of the prcessor. + Sets the bytes_out of this ProcessorStatusSnapshotDTO. + The size of the FlowFiles transferred to a Connection in the last 5 minutes - :param name: The name of this ProcessorStatusSnapshotDTO. - :type: str + :param bytes_out: The bytes_out of this ProcessorStatusSnapshotDTO. + :type: int """ - self._name = name + self._bytes_out = bytes_out @property - def type(self): + def bytes_read(self): """ - Gets the type of this ProcessorStatusSnapshotDTO. - The type of the processor. + Gets the bytes_read of this ProcessorStatusSnapshotDTO. + The number of bytes read by this Processor in the last 5 mintues - :return: The type of this ProcessorStatusSnapshotDTO. - :rtype: str + :return: The bytes_read of this ProcessorStatusSnapshotDTO. + :rtype: int """ - return self._type + return self._bytes_read - @type.setter - def type(self, type): + @bytes_read.setter + def bytes_read(self, bytes_read): """ - Sets the type of this ProcessorStatusSnapshotDTO. - The type of the processor. + Sets the bytes_read of this ProcessorStatusSnapshotDTO. + The number of bytes read by this Processor in the last 5 mintues - :param type: The type of this ProcessorStatusSnapshotDTO. - :type: str + :param bytes_read: The bytes_read of this ProcessorStatusSnapshotDTO. + :type: int """ - self._type = type + self._bytes_read = bytes_read @property - def run_status(self): + def bytes_written(self): """ - Gets the run_status of this ProcessorStatusSnapshotDTO. - The state of the processor. + Gets the bytes_written of this ProcessorStatusSnapshotDTO. + The number of bytes written by this Processor in the last 5 minutes - :return: The run_status of this ProcessorStatusSnapshotDTO. - :rtype: str + :return: The bytes_written of this ProcessorStatusSnapshotDTO. + :rtype: int """ - return self._run_status + return self._bytes_written - @run_status.setter - def run_status(self, run_status): + @bytes_written.setter + def bytes_written(self, bytes_written): """ - Sets the run_status of this ProcessorStatusSnapshotDTO. - The state of the processor. + Sets the bytes_written of this ProcessorStatusSnapshotDTO. + The number of bytes written by this Processor in the last 5 minutes - :param run_status: The run_status of this ProcessorStatusSnapshotDTO. - :type: str + :param bytes_written: The bytes_written of this ProcessorStatusSnapshotDTO. + :type: int """ - 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 + self._bytes_written = bytes_written @property def execution_node(self): @@ -296,7 +287,7 @@ def execution_node(self, execution_node): :param execution_node: The execution_node of this ProcessorStatusSnapshotDTO. :type: str """ - allowed_values = ["ALL", "PRIMARY"] + allowed_values = ["ALL", "PRIMARY", ] if execution_node not in allowed_values: raise ValueError( "Invalid value for `execution_node` ({0}), must be one of {1}" @@ -306,142 +297,96 @@ def execution_node(self, execution_node): self._execution_node = execution_node @property - def bytes_read(self): + def flow_files_in(self): """ - Gets the bytes_read of this ProcessorStatusSnapshotDTO. - The number of bytes read by this Processor in the last 5 mintues + Gets the flow_files_in of this ProcessorStatusSnapshotDTO. + The number of FlowFiles that have been accepted in the last 5 minutes - :return: The bytes_read of this ProcessorStatusSnapshotDTO. + :return: The flow_files_in of this ProcessorStatusSnapshotDTO. :rtype: int """ - return self._bytes_read + return self._flow_files_in - @bytes_read.setter - def bytes_read(self, bytes_read): + @flow_files_in.setter + def flow_files_in(self, flow_files_in): """ - Sets the bytes_read of this ProcessorStatusSnapshotDTO. - The number of bytes read by this Processor in the last 5 mintues + Sets the flow_files_in of this ProcessorStatusSnapshotDTO. + The number of FlowFiles that have been accepted in the last 5 minutes - :param bytes_read: The bytes_read of this ProcessorStatusSnapshotDTO. + :param flow_files_in: The flow_files_in of this ProcessorStatusSnapshotDTO. :type: int """ - self._bytes_read = bytes_read + self._flow_files_in = flow_files_in @property - def bytes_written(self): + def flow_files_out(self): """ - Gets the bytes_written of this ProcessorStatusSnapshotDTO. - The number of bytes written by this Processor in the last 5 minutes + Gets the flow_files_out of this ProcessorStatusSnapshotDTO. + The number of FlowFiles transferred to a Connection in the last 5 minutes - :return: The bytes_written of this ProcessorStatusSnapshotDTO. + :return: The flow_files_out of this ProcessorStatusSnapshotDTO. :rtype: int """ - return self._bytes_written + return self._flow_files_out - @bytes_written.setter - def bytes_written(self, bytes_written): + @flow_files_out.setter + def flow_files_out(self, flow_files_out): """ - Sets the bytes_written of this ProcessorStatusSnapshotDTO. - The number of bytes written by this Processor in the last 5 minutes + Sets the flow_files_out of this ProcessorStatusSnapshotDTO. + The number of FlowFiles transferred to a Connection in the last 5 minutes - :param bytes_written: The bytes_written of this ProcessorStatusSnapshotDTO. + :param flow_files_out: The flow_files_out of this ProcessorStatusSnapshotDTO. :type: int """ - self._bytes_written = bytes_written - - @property - def read(self): - """ - Gets the read of this ProcessorStatusSnapshotDTO. - The number of bytes read in the last 5 minutes. - - :return: The read of this ProcessorStatusSnapshotDTO. - :rtype: str - """ - return self._read - - @read.setter - def read(self, read): - """ - Sets the read of this ProcessorStatusSnapshotDTO. - The number of bytes read in the last 5 minutes. - - :param read: The read of this ProcessorStatusSnapshotDTO. - :type: str - """ - - self._read = read - - @property - def written(self): - """ - Gets the written of this ProcessorStatusSnapshotDTO. - The number of bytes written in the last 5 minutes. - - :return: The written of this ProcessorStatusSnapshotDTO. - :rtype: str - """ - return self._written - - @written.setter - def written(self, written): - """ - Sets the written of this ProcessorStatusSnapshotDTO. - The number of bytes written in the last 5 minutes. - - :param written: The written of this ProcessorStatusSnapshotDTO. - :type: str - """ - - self._written = written + self._flow_files_out = flow_files_out @property - def flow_files_in(self): + def group_id(self): """ - Gets the flow_files_in of this ProcessorStatusSnapshotDTO. - The number of FlowFiles that have been accepted in the last 5 minutes + Gets the group_id of this ProcessorStatusSnapshotDTO. + The id of the parent process group to which the processor belongs. - :return: The flow_files_in of this ProcessorStatusSnapshotDTO. - :rtype: int + :return: The group_id of this ProcessorStatusSnapshotDTO. + :rtype: str """ - return self._flow_files_in + return self._group_id - @flow_files_in.setter - def flow_files_in(self, flow_files_in): + @group_id.setter + def group_id(self, group_id): """ - Sets the flow_files_in of this ProcessorStatusSnapshotDTO. - The number of FlowFiles that have been accepted in the last 5 minutes + Sets the group_id of this ProcessorStatusSnapshotDTO. + The id of the parent process group to which the processor belongs. - :param flow_files_in: The flow_files_in of this ProcessorStatusSnapshotDTO. - :type: int + :param group_id: The group_id of this ProcessorStatusSnapshotDTO. + :type: str """ - self._flow_files_in = flow_files_in + self._group_id = group_id @property - def bytes_in(self): + def id(self): """ - Gets the bytes_in of this ProcessorStatusSnapshotDTO. - The size of the FlowFiles that have been accepted in the last 5 minutes + Gets the id of this ProcessorStatusSnapshotDTO. + The id of the processor. - :return: The bytes_in of this ProcessorStatusSnapshotDTO. - :rtype: int + :return: The id of this ProcessorStatusSnapshotDTO. + :rtype: str """ - return self._bytes_in + return self._id - @bytes_in.setter - def bytes_in(self, bytes_in): + @id.setter + def id(self, id): """ - Sets the bytes_in of this ProcessorStatusSnapshotDTO. - The size of the FlowFiles that have been accepted in the last 5 minutes + Sets the id of this ProcessorStatusSnapshotDTO. + The id of the processor. - :param bytes_in: The bytes_in of this ProcessorStatusSnapshotDTO. - :type: int + :param id: The id of this ProcessorStatusSnapshotDTO. + :type: str """ - self._bytes_in = bytes_in + self._id = id @property def input(self): @@ -467,50 +412,27 @@ def input(self, input): self._input = input @property - def flow_files_out(self): - """ - Gets the flow_files_out of this ProcessorStatusSnapshotDTO. - The number of FlowFiles transferred to a Connection in the last 5 minutes - - :return: The flow_files_out of this ProcessorStatusSnapshotDTO. - :rtype: int - """ - return self._flow_files_out - - @flow_files_out.setter - def flow_files_out(self, flow_files_out): - """ - Sets the flow_files_out of this ProcessorStatusSnapshotDTO. - The number of FlowFiles transferred to a Connection in the last 5 minutes - - :param flow_files_out: The flow_files_out of this ProcessorStatusSnapshotDTO. - :type: int - """ - - self._flow_files_out = flow_files_out - - @property - def bytes_out(self): + def name(self): """ - Gets the bytes_out of this ProcessorStatusSnapshotDTO. - The size of the FlowFiles transferred to a Connection in the last 5 minutes + Gets the name of this ProcessorStatusSnapshotDTO. + The name of the prcessor. - :return: The bytes_out of this ProcessorStatusSnapshotDTO. - :rtype: int + :return: The name of this ProcessorStatusSnapshotDTO. + :rtype: str """ - return self._bytes_out + return self._name - @bytes_out.setter - def bytes_out(self, bytes_out): + @name.setter + def name(self, name): """ - Sets the bytes_out of this ProcessorStatusSnapshotDTO. - The size of the FlowFiles transferred to a Connection in the last 5 minutes + Sets the name of this ProcessorStatusSnapshotDTO. + The name of the prcessor. - :param bytes_out: The bytes_out of this ProcessorStatusSnapshotDTO. - :type: int + :param name: The name of this ProcessorStatusSnapshotDTO. + :type: str """ - self._bytes_out = bytes_out + self._name = name @property def output(self): @@ -535,6 +457,79 @@ def output(self, output): self._output = output + @property + def processing_performance_status(self): + """ + Gets the processing_performance_status of this ProcessorStatusSnapshotDTO. + + :return: The processing_performance_status of this ProcessorStatusSnapshotDTO. + :rtype: ProcessingPerformanceStatusDTO + """ + return self._processing_performance_status + + @processing_performance_status.setter + def processing_performance_status(self, processing_performance_status): + """ + Sets the processing_performance_status of this ProcessorStatusSnapshotDTO. + + :param processing_performance_status: The processing_performance_status of this ProcessorStatusSnapshotDTO. + :type: ProcessingPerformanceStatusDTO + """ + + self._processing_performance_status = processing_performance_status + + @property + def read(self): + """ + Gets the read of this ProcessorStatusSnapshotDTO. + The number of bytes read in the last 5 minutes. + + :return: The read of this ProcessorStatusSnapshotDTO. + :rtype: str + """ + return self._read + + @read.setter + def read(self, read): + """ + Sets the read of this ProcessorStatusSnapshotDTO. + The number of bytes read in the last 5 minutes. + + :param read: The read of this ProcessorStatusSnapshotDTO. + :type: str + """ + + self._read = read + + @property + def run_status(self): + """ + Gets the run_status of this ProcessorStatusSnapshotDTO. + The state of the processor. + + :return: The run_status of this ProcessorStatusSnapshotDTO. + :rtype: str + """ + return self._run_status + + @run_status.setter + def run_status(self, run_status): + """ + Sets the run_status of this ProcessorStatusSnapshotDTO. + The state of the processor. + + :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) + ) + + self._run_status = run_status + @property def task_count(self): """ @@ -558,29 +553,6 @@ def task_count(self, task_count): self._task_count = task_count - @property - def tasks_duration_nanos(self): - """ - Gets the tasks_duration_nanos of this ProcessorStatusSnapshotDTO. - The number of nanoseconds that this Processor has spent running in the last 5 minutes - - :return: The tasks_duration_nanos of this ProcessorStatusSnapshotDTO. - :rtype: int - """ - return self._tasks_duration_nanos - - @tasks_duration_nanos.setter - def tasks_duration_nanos(self, tasks_duration_nanos): - """ - Sets the tasks_duration_nanos of this ProcessorStatusSnapshotDTO. - The number of nanoseconds that this Processor has spent running in the last 5 minutes - - :param tasks_duration_nanos: The tasks_duration_nanos of this ProcessorStatusSnapshotDTO. - :type: int - """ - - self._tasks_duration_nanos = tasks_duration_nanos - @property def tasks(self): """ @@ -628,27 +600,27 @@ def tasks_duration(self, tasks_duration): self._tasks_duration = tasks_duration @property - def active_thread_count(self): + def tasks_duration_nanos(self): """ - Gets the active_thread_count of this ProcessorStatusSnapshotDTO. - The number of threads currently executing in the processor. + Gets the tasks_duration_nanos of this ProcessorStatusSnapshotDTO. + The number of nanoseconds that this Processor has spent running in the last 5 minutes - :return: The active_thread_count of this ProcessorStatusSnapshotDTO. + :return: The tasks_duration_nanos of this ProcessorStatusSnapshotDTO. :rtype: int """ - return self._active_thread_count + return self._tasks_duration_nanos - @active_thread_count.setter - def active_thread_count(self, active_thread_count): + @tasks_duration_nanos.setter + def tasks_duration_nanos(self, tasks_duration_nanos): """ - Sets the active_thread_count of this ProcessorStatusSnapshotDTO. - The number of threads currently executing in the processor. + Sets the tasks_duration_nanos of this ProcessorStatusSnapshotDTO. + The number of nanoseconds that this Processor has spent running in the last 5 minutes - :param active_thread_count: The active_thread_count of this ProcessorStatusSnapshotDTO. + :param tasks_duration_nanos: The tasks_duration_nanos of this ProcessorStatusSnapshotDTO. :type: int """ - self._active_thread_count = active_thread_count + self._tasks_duration_nanos = tasks_duration_nanos @property def terminated_thread_count(self): @@ -674,27 +646,50 @@ def terminated_thread_count(self, terminated_thread_count): self._terminated_thread_count = terminated_thread_count @property - def processing_performance_status(self): + def type(self): """ - Gets the processing_performance_status of this ProcessorStatusSnapshotDTO. - Represents the processor's processing performance. + Gets the type of this ProcessorStatusSnapshotDTO. + The type of the processor. - :return: The processing_performance_status of this ProcessorStatusSnapshotDTO. - :rtype: ProcessingPerformanceStatusDTO + :return: The type of this ProcessorStatusSnapshotDTO. + :rtype: str """ - return self._processing_performance_status + return self._type - @processing_performance_status.setter - def processing_performance_status(self, processing_performance_status): + @type.setter + def type(self, type): """ - Sets the processing_performance_status of this ProcessorStatusSnapshotDTO. - Represents the processor's processing performance. + Sets the type of this ProcessorStatusSnapshotDTO. + The type of the processor. - :param processing_performance_status: The processing_performance_status of this ProcessorStatusSnapshotDTO. - :type: ProcessingPerformanceStatusDTO + :param type: The type of this ProcessorStatusSnapshotDTO. + :type: str """ - self._processing_performance_status = processing_performance_status + self._type = type + + @property + def written(self): + """ + Gets the written of this ProcessorStatusSnapshotDTO. + The number of bytes written in the last 5 minutes. + + :return: The written of this ProcessorStatusSnapshotDTO. + :rtype: str + """ + return self._written + + @written.setter + def written(self, written): + """ + Sets the written of this ProcessorStatusSnapshotDTO. + The number of bytes written in the last 5 minutes. + + :param written: The written of this ProcessorStatusSnapshotDTO. + :type: str + """ + + self._written = written def to_dict(self): """ diff --git a/nipyapi/nifi/models/processor_status_snapshot_entity.py b/nipyapi/nifi/models/processor_status_snapshot_entity.py index a6e3fa87..31b1eb61 100644 --- a/nipyapi/nifi/models/processor_status_snapshot_entity.py +++ b/nipyapi/nifi/models/processor_status_snapshot_entity.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,32 +27,53 @@ class ProcessorStatusSnapshotEntity(object): and the value is json key in definition. """ swagger_types = { - 'id': 'str', - 'processor_status_snapshot': 'ProcessorStatusSnapshotDTO', - 'can_read': 'bool' - } + 'can_read': 'bool', +'id': 'str', +'processor_status_snapshot': 'ProcessorStatusSnapshotDTO' } attribute_map = { - 'id': 'id', - 'processor_status_snapshot': 'processorStatusSnapshot', - 'can_read': 'canRead' - } + 'can_read': 'canRead', +'id': 'id', +'processor_status_snapshot': 'processorStatusSnapshot' } - def __init__(self, id=None, processor_status_snapshot=None, can_read=None): + def __init__(self, can_read=None, id=None, processor_status_snapshot=None): """ ProcessorStatusSnapshotEntity - a model defined in Swagger """ + self._can_read = None self._id = None self._processor_status_snapshot = None - self._can_read = None + if can_read is not None: + self.can_read = can_read if id is not None: self.id = id if processor_status_snapshot is not None: self.processor_status_snapshot = processor_status_snapshot - if can_read is not None: - self.can_read = can_read + + @property + def can_read(self): + """ + Gets the can_read of this ProcessorStatusSnapshotEntity. + Indicates whether the user can read a given resource. + + :return: The can_read of this ProcessorStatusSnapshotEntity. + :rtype: bool + """ + return self._can_read + + @can_read.setter + def can_read(self, can_read): + """ + Sets the can_read of this ProcessorStatusSnapshotEntity. + Indicates whether the user can read a given resource. + + :param can_read: The can_read of this ProcessorStatusSnapshotEntity. + :type: bool + """ + + self._can_read = can_read @property def id(self): @@ -99,29 +119,6 @@ def processor_status_snapshot(self, processor_status_snapshot): self._processor_status_snapshot = processor_status_snapshot - @property - def can_read(self): - """ - Gets the can_read of this ProcessorStatusSnapshotEntity. - Indicates whether the user can read a given resource. - - :return: The can_read of this ProcessorStatusSnapshotEntity. - :rtype: bool - """ - return self._can_read - - @can_read.setter - def can_read(self, can_read): - """ - Sets the can_read of this ProcessorStatusSnapshotEntity. - Indicates whether the user can read a given resource. - - :param can_read: The can_read of this ProcessorStatusSnapshotEntity. - :type: bool - """ - - self._can_read = can_read - def to_dict(self): """ Returns the model properties as a dict diff --git a/nipyapi/nifi/models/processor_types_entity.py b/nipyapi/nifi/models/processor_types_entity.py index 51407cd6..5b901285 100644 --- a/nipyapi/nifi/models/processor_types_entity.py +++ b/nipyapi/nifi/models/processor_types_entity.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,12 +27,10 @@ class ProcessorTypesEntity(object): and the value is json key in definition. """ swagger_types = { - 'processor_types': 'list[DocumentedTypeDTO]' - } + 'processor_types': 'list[DocumentedTypeDTO]' } attribute_map = { - 'processor_types': 'processorTypes' - } + 'processor_types': 'processorTypes' } def __init__(self, processor_types=None): """ diff --git a/nipyapi/nifi/models/processors_entity.py b/nipyapi/nifi/models/processors_entity.py index b96355a7..f7048b62 100644 --- a/nipyapi/nifi/models/processors_entity.py +++ b/nipyapi/nifi/models/processors_entity.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,12 +27,10 @@ class ProcessorsEntity(object): and the value is json key in definition. """ swagger_types = { - 'processors': 'list[ProcessorEntity]' - } + 'processors': 'list[ProcessorEntity]' } attribute_map = { - 'processors': 'processors' - } + 'processors': 'processors' } def __init__(self, processors=None): """ diff --git a/nipyapi/nifi/models/processors_run_status_details_entity.py b/nipyapi/nifi/models/processors_run_status_details_entity.py index 1a98da57..b5c08679 100644 --- a/nipyapi/nifi/models/processors_run_status_details_entity.py +++ b/nipyapi/nifi/models/processors_run_status_details_entity.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,12 +27,10 @@ class ProcessorsRunStatusDetailsEntity(object): and the value is json key in definition. """ swagger_types = { - 'run_status_details': 'list[ProcessorRunStatusDetailsEntity]' - } + 'run_status_details': 'list[ProcessorRunStatusDetailsEntity]' } attribute_map = { - 'run_status_details': 'runStatusDetails' - } + 'run_status_details': 'runStatusDetails' } def __init__(self, run_status_details=None): """ diff --git a/nipyapi/nifi/models/property_allowable_value.py b/nipyapi/nifi/models/property_allowable_value.py index bdeaa236..f96e5f23 100644 --- a/nipyapi/nifi/models/property_allowable_value.py +++ b/nipyapi/nifi/models/property_allowable_value.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,56 +27,53 @@ class PropertyAllowableValue(object): and the value is json key in definition. """ swagger_types = { - 'value': 'str', - 'display_name': 'str', - 'description': 'str' - } + 'description': 'str', +'display_name': 'str', +'value': 'str' } attribute_map = { - 'value': 'value', - 'display_name': 'displayName', - 'description': 'description' - } + 'description': 'description', +'display_name': 'displayName', +'value': 'value' } - def __init__(self, value=None, display_name=None, description=None): + def __init__(self, description=None, display_name=None, value=None): """ PropertyAllowableValue - a model defined in Swagger """ - self._value = None - self._display_name = None self._description = None + self._display_name = None + self._value = None - self.value = value - if display_name is not None: - self.display_name = display_name if description is not None: self.description = description + if display_name is not None: + self.display_name = display_name + if value is not None: + self.value = value @property - def value(self): + def description(self): """ - Gets the value of this PropertyAllowableValue. - The internal value + Gets the description of this PropertyAllowableValue. + The description of the value, e.g., the behavior it produces. - :return: The value of this PropertyAllowableValue. + :return: The description of this PropertyAllowableValue. :rtype: str """ - return self._value + return self._description - @value.setter - def value(self, value): + @description.setter + def description(self, description): """ - Sets the value of this PropertyAllowableValue. - The internal value + Sets the description of this PropertyAllowableValue. + The description of the value, e.g., the behavior it produces. - :param value: The value of this PropertyAllowableValue. + :param description: The description of this PropertyAllowableValue. :type: str """ - if value is None: - raise ValueError("Invalid value for `value`, must not be `None`") - self._value = value + self._description = description @property def display_name(self): @@ -103,27 +99,27 @@ def display_name(self, display_name): self._display_name = display_name @property - def description(self): + def value(self): """ - Gets the description of this PropertyAllowableValue. - The description of the value, e.g., the behavior it produces. + Gets the value of this PropertyAllowableValue. + The internal value - :return: The description of this PropertyAllowableValue. + :return: The value of this PropertyAllowableValue. :rtype: str """ - return self._description + return self._value - @description.setter - def description(self, description): + @value.setter + def value(self, value): """ - Sets the description of this PropertyAllowableValue. - The description of the value, e.g., the behavior it produces. + Sets the value of this PropertyAllowableValue. + The internal value - :param description: The description of this PropertyAllowableValue. + :param value: The value of this PropertyAllowableValue. :type: str """ - self._description = description + self._value = value def to_dict(self): """ diff --git a/nipyapi/nifi/models/property_dependency.py b/nipyapi/nifi/models/property_dependency.py index b1bdc664..6a3ccbcc 100644 --- a/nipyapi/nifi/models/property_dependency.py +++ b/nipyapi/nifi/models/property_dependency.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,55 +27,53 @@ class PropertyDependency(object): and the value is json key in definition. """ swagger_types = { - 'property_name': 'str', - 'property_display_name': 'str', - 'dependent_values': 'list[str]' - } + 'dependent_values': 'list[str]', +'property_display_name': 'str', +'property_name': 'str' } attribute_map = { - 'property_name': 'propertyName', - 'property_display_name': 'propertyDisplayName', - 'dependent_values': 'dependentValues' - } + 'dependent_values': 'dependentValues', +'property_display_name': 'propertyDisplayName', +'property_name': 'propertyName' } - def __init__(self, property_name=None, property_display_name=None, dependent_values=None): + def __init__(self, dependent_values=None, property_display_name=None, property_name=None): """ PropertyDependency - a model defined in Swagger """ - self._property_name = None - self._property_display_name = None self._dependent_values = None + self._property_display_name = None + self._property_name = None - if property_name is not None: - self.property_name = property_name - if property_display_name is not None: - self.property_display_name = property_display_name if dependent_values is not None: self.dependent_values = dependent_values + if property_display_name is not None: + self.property_display_name = property_display_name + if property_name is not None: + self.property_name = property_name @property - def property_name(self): + def dependent_values(self): """ - Gets the property_name of this PropertyDependency. - The name of the property that is depended upon + Gets the dependent_values of this PropertyDependency. + The values that satisfy the dependency - :return: The property_name of this PropertyDependency. - :rtype: str + :return: The dependent_values of this PropertyDependency. + :rtype: list[str] """ - return self._property_name + return self._dependent_values - @property_name.setter - def property_name(self, property_name): + @dependent_values.setter + def dependent_values(self, dependent_values): """ - Sets the property_name of this PropertyDependency. - The name of the property that is depended upon + Sets the dependent_values of this PropertyDependency. + The values that satisfy the dependency - :param property_name: The property_name of this PropertyDependency. - :type: str + :param dependent_values: The dependent_values of this PropertyDependency. + :type: list[str] """ - self._property_name = property_name + self._dependent_values = dependent_values @property def property_display_name(self): @@ -102,27 +99,27 @@ def property_display_name(self, property_display_name): self._property_display_name = property_display_name @property - def dependent_values(self): + def property_name(self): """ - Gets the dependent_values of this PropertyDependency. - The values that satisfy the dependency + Gets the property_name of this PropertyDependency. + The name of the property that is depended upon - :return: The dependent_values of this PropertyDependency. - :rtype: list[str] + :return: The property_name of this PropertyDependency. + :rtype: str """ - return self._dependent_values + return self._property_name - @dependent_values.setter - def dependent_values(self, dependent_values): + @property_name.setter + def property_name(self, property_name): """ - Sets the dependent_values of this PropertyDependency. - The values that satisfy the dependency + Sets the property_name of this PropertyDependency. + The name of the property that is depended upon - :param dependent_values: The dependent_values of this PropertyDependency. - :type: list[str] + :param property_name: The property_name of this PropertyDependency. + :type: str """ - self._dependent_values = dependent_values + self._property_name = property_name def to_dict(self): """ diff --git a/nipyapi/nifi/models/property_dependency_dto.py b/nipyapi/nifi/models/property_dependency_dto.py index 021222ff..087b5a5b 100644 --- a/nipyapi/nifi/models/property_dependency_dto.py +++ b/nipyapi/nifi/models/property_dependency_dto.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,50 +27,25 @@ class PropertyDependencyDTO(object): and the value is json key in definition. """ swagger_types = { - 'property_name': 'str', - 'dependent_values': 'list[str]' - } + 'dependent_values': 'list[str]', +'property_name': 'str' } attribute_map = { - 'property_name': 'propertyName', - 'dependent_values': 'dependentValues' - } + 'dependent_values': 'dependentValues', +'property_name': 'propertyName' } - def __init__(self, property_name=None, dependent_values=None): + def __init__(self, dependent_values=None, property_name=None): """ PropertyDependencyDTO - a model defined in Swagger """ - self._property_name = None self._dependent_values = None + self._property_name = None - if property_name is not None: - self.property_name = property_name if dependent_values is not None: self.dependent_values = dependent_values - - @property - def property_name(self): - """ - Gets the property_name of this PropertyDependencyDTO. - The name of the property that is being depended upon - - :return: The property_name of this PropertyDependencyDTO. - :rtype: str - """ - return self._property_name - - @property_name.setter - def property_name(self, property_name): - """ - Sets the property_name of this PropertyDependencyDTO. - The name of the property that is being depended upon - - :param property_name: The property_name of this PropertyDependencyDTO. - :type: str - """ - - self._property_name = property_name + if property_name is not None: + self.property_name = property_name @property def dependent_values(self): @@ -96,6 +70,29 @@ def dependent_values(self, dependent_values): self._dependent_values = dependent_values + @property + def property_name(self): + """ + Gets the property_name of this PropertyDependencyDTO. + The name of the property that is being depended upon + + :return: The property_name of this PropertyDependencyDTO. + :rtype: str + """ + return self._property_name + + @property_name.setter + def property_name(self, property_name): + """ + Sets the property_name of this PropertyDependencyDTO. + The name of the property that is being depended upon + + :param property_name: The property_name of this PropertyDependencyDTO. + :type: str + """ + + self._property_name = property_name + def to_dict(self): """ Returns the model properties as a dict diff --git a/nipyapi/nifi/models/property_descriptor.py b/nipyapi/nifi/models/property_descriptor.py index 6d640690..1506a62e 100644 --- a/nipyapi/nifi/models/property_descriptor.py +++ b/nipyapi/nifi/models/property_descriptor.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,139 +27,159 @@ class PropertyDescriptor(object): and the value is json key in definition. """ swagger_types = { - 'name': 'str', - 'display_name': 'str', - 'description': 'str', 'allowable_values': 'list[PropertyAllowableValue]', - 'default_value': 'str', - 'required': 'bool', - 'sensitive': 'bool', - 'expression_language_scope': 'str', - 'expression_language_scope_description': 'str', - 'type_provided_by_value': 'DefinedType', - 'valid_regex': 'str', - 'validator': 'str', - 'dynamic': 'bool', - 'resource_definition': 'PropertyResourceDefinition', - 'dependencies': 'list[PropertyDependency]' - } +'default_value': 'str', +'dependencies': 'list[PropertyDependency]', +'description': 'str', +'display_name': 'str', +'dynamic': 'bool', +'expression_language_scope': 'str', +'expression_language_scope_description': 'str', +'name': 'str', +'required': 'bool', +'resource_definition': 'PropertyResourceDefinition', +'sensitive': 'bool', +'type_provided_by_value': 'DefinedType', +'valid_regex': 'str', +'validator': 'str' } attribute_map = { - 'name': 'name', - 'display_name': 'displayName', - 'description': 'description', 'allowable_values': 'allowableValues', - 'default_value': 'defaultValue', - 'required': 'required', - 'sensitive': 'sensitive', - 'expression_language_scope': 'expressionLanguageScope', - 'expression_language_scope_description': 'expressionLanguageScopeDescription', - 'type_provided_by_value': 'typeProvidedByValue', - 'valid_regex': 'validRegex', - 'validator': 'validator', - 'dynamic': 'dynamic', - 'resource_definition': 'resourceDefinition', - 'dependencies': 'dependencies' - } - - def __init__(self, name=None, display_name=None, description=None, allowable_values=None, default_value=None, required=None, sensitive=None, expression_language_scope=None, expression_language_scope_description=None, type_provided_by_value=None, valid_regex=None, validator=None, dynamic=None, resource_definition=None, dependencies=None): +'default_value': 'defaultValue', +'dependencies': 'dependencies', +'description': 'description', +'display_name': 'displayName', +'dynamic': 'dynamic', +'expression_language_scope': 'expressionLanguageScope', +'expression_language_scope_description': 'expressionLanguageScopeDescription', +'name': 'name', +'required': 'required', +'resource_definition': 'resourceDefinition', +'sensitive': 'sensitive', +'type_provided_by_value': 'typeProvidedByValue', +'valid_regex': 'validRegex', +'validator': 'validator' } + + def __init__(self, allowable_values=None, default_value=None, dependencies=None, description=None, display_name=None, dynamic=None, expression_language_scope=None, expression_language_scope_description=None, name=None, required=None, resource_definition=None, sensitive=None, type_provided_by_value=None, valid_regex=None, validator=None): """ PropertyDescriptor - a model defined in Swagger """ - self._name = None - self._display_name = None - self._description = None self._allowable_values = None self._default_value = None - self._required = None - self._sensitive = None + self._dependencies = None + self._description = None + self._display_name = None + self._dynamic = None self._expression_language_scope = None self._expression_language_scope_description = None + self._name = None + self._required = None + self._resource_definition = None + self._sensitive = None self._type_provided_by_value = None self._valid_regex = None self._validator = None - self._dynamic = None - self._resource_definition = None - self._dependencies = None - self.name = name - if display_name is not None: - self.display_name = display_name - if description is not None: - self.description = description if allowable_values is not None: self.allowable_values = allowable_values if default_value is not None: self.default_value = default_value - if required is not None: - self.required = required - if sensitive is not None: - self.sensitive = sensitive + if dependencies is not None: + self.dependencies = dependencies + if description is not None: + self.description = description + if display_name is not None: + self.display_name = display_name + if dynamic is not None: + self.dynamic = dynamic if expression_language_scope is not None: self.expression_language_scope = expression_language_scope if expression_language_scope_description is not None: self.expression_language_scope_description = expression_language_scope_description + if name is not None: + self.name = name + if required is not None: + self.required = required + if resource_definition is not None: + self.resource_definition = resource_definition + if sensitive is not None: + self.sensitive = sensitive if type_provided_by_value is not None: self.type_provided_by_value = type_provided_by_value if valid_regex is not None: self.valid_regex = valid_regex if validator is not None: self.validator = validator - if dynamic is not None: - self.dynamic = dynamic - if resource_definition is not None: - self.resource_definition = resource_definition - if dependencies is not None: - self.dependencies = dependencies @property - def name(self): + def allowable_values(self): """ - Gets the name of this PropertyDescriptor. - The name of the property key + Gets the allowable_values of this PropertyDescriptor. + A list of the allowable values for the property - :return: The name of this PropertyDescriptor. - :rtype: str + :return: The allowable_values of this PropertyDescriptor. + :rtype: list[PropertyAllowableValue] """ - return self._name + return self._allowable_values - @name.setter - def name(self, name): + @allowable_values.setter + def allowable_values(self, allowable_values): """ - Sets the name of this PropertyDescriptor. - The name of the property key + Sets the allowable_values of this PropertyDescriptor. + A list of the allowable values for the property - :param name: The name of this PropertyDescriptor. - :type: str + :param allowable_values: The allowable_values of this PropertyDescriptor. + :type: list[PropertyAllowableValue] """ - if name is None: - raise ValueError("Invalid value for `name`, must not be `None`") - self._name = name + self._allowable_values = allowable_values @property - def display_name(self): + def default_value(self): """ - Gets the display_name of this PropertyDescriptor. - The display name of the property key, if different from the name + Gets the default_value of this PropertyDescriptor. + The default value if a user-set value is not specified - :return: The display_name of this PropertyDescriptor. + :return: The default_value of this PropertyDescriptor. :rtype: str """ - return self._display_name + return self._default_value - @display_name.setter - def display_name(self, display_name): + @default_value.setter + def default_value(self, default_value): """ - Sets the display_name of this PropertyDescriptor. - The display name of the property key, if different from the name + Sets the default_value of this PropertyDescriptor. + The default value if a user-set value is not specified - :param display_name: The display_name of this PropertyDescriptor. + :param default_value: The default_value of this PropertyDescriptor. :type: str """ - self._display_name = display_name + self._default_value = default_value + + @property + def dependencies(self): + """ + Gets the dependencies of this PropertyDescriptor. + The dependencies that this property has on other properties + + :return: The dependencies of this PropertyDescriptor. + :rtype: list[PropertyDependency] + """ + return self._dependencies + + @dependencies.setter + def dependencies(self, dependencies): + """ + Sets the dependencies of this PropertyDescriptor. + The dependencies that this property has on other properties + + :param dependencies: The dependencies of this PropertyDescriptor. + :type: list[PropertyDependency] + """ + + self._dependencies = dependencies @property def description(self): @@ -186,96 +205,50 @@ def description(self, description): self._description = description @property - def allowable_values(self): - """ - Gets the allowable_values of this PropertyDescriptor. - A list of the allowable values for the property - - :return: The allowable_values of this PropertyDescriptor. - :rtype: list[PropertyAllowableValue] - """ - return self._allowable_values - - @allowable_values.setter - def allowable_values(self, allowable_values): - """ - Sets the allowable_values of this PropertyDescriptor. - A list of the allowable values for the property - - :param allowable_values: The allowable_values of this PropertyDescriptor. - :type: list[PropertyAllowableValue] - """ - - self._allowable_values = allowable_values - - @property - def default_value(self): + def display_name(self): """ - Gets the default_value of this PropertyDescriptor. - The default value if a user-set value is not specified + Gets the display_name of this PropertyDescriptor. + The display name of the property key, if different from the name - :return: The default_value of this PropertyDescriptor. + :return: The display_name of this PropertyDescriptor. :rtype: str """ - return self._default_value + return self._display_name - @default_value.setter - def default_value(self, default_value): + @display_name.setter + def display_name(self, display_name): """ - Sets the default_value of this PropertyDescriptor. - The default value if a user-set value is not specified + Sets the display_name of this PropertyDescriptor. + The display name of the property key, if different from the name - :param default_value: The default_value of this PropertyDescriptor. + :param display_name: The display_name of this PropertyDescriptor. :type: str """ - self._default_value = default_value - - @property - def required(self): - """ - Gets the required of this PropertyDescriptor. - Whether or not the property is required for the component - - :return: The required of this PropertyDescriptor. - :rtype: bool - """ - return self._required - - @required.setter - def required(self, required): - """ - Sets the required of this PropertyDescriptor. - Whether or not the property is required for the component - - :param required: The required of this PropertyDescriptor. - :type: bool - """ - - self._required = required + self._display_name = display_name @property - def sensitive(self): + def dynamic(self): """ - Gets the sensitive of this PropertyDescriptor. - Whether or not the value of the property is considered sensitive (e.g., passwords and keys) + Gets the dynamic of this PropertyDescriptor. + Whether or not the descriptor is for a dynamically added property - :return: The sensitive of this PropertyDescriptor. + :return: The dynamic of this PropertyDescriptor. :rtype: bool """ - return self._sensitive + return self._dynamic - @sensitive.setter - def sensitive(self, sensitive): + @dynamic.setter + def dynamic(self, dynamic): """ - Sets the sensitive of this PropertyDescriptor. - Whether or not the value of the property is considered sensitive (e.g., passwords and keys) + Sets the dynamic of this PropertyDescriptor. + Whether or not the descriptor is for a dynamically added property - :param sensitive: The sensitive of this PropertyDescriptor. + :param dynamic: The dynamic of this PropertyDescriptor. :type: bool """ - self._sensitive = sensitive + self._dynamic = dynamic @property def expression_language_scope(self): @@ -297,7 +270,7 @@ def expression_language_scope(self, expression_language_scope): :param expression_language_scope: The expression_language_scope of this PropertyDescriptor. :type: str """ - allowed_values = ["NONE", "VARIABLE_REGISTRY", "FLOWFILE_ATTRIBUTES"] + 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}" @@ -329,11 +302,100 @@ def expression_language_scope_description(self, expression_language_scope_descri self._expression_language_scope_description = expression_language_scope_description + @property + def name(self): + """ + Gets the name of this PropertyDescriptor. + The name of the property key + + :return: The name of this PropertyDescriptor. + :rtype: str + """ + return self._name + + @name.setter + def name(self, name): + """ + Sets the name of this PropertyDescriptor. + The name of the property key + + :param name: The name of this PropertyDescriptor. + :type: str + """ + + self._name = name + + @property + def required(self): + """ + Gets the required of this PropertyDescriptor. + Whether or not the property is required for the component + + :return: The required of this PropertyDescriptor. + :rtype: bool + """ + return self._required + + @required.setter + def required(self, required): + """ + Sets the required of this PropertyDescriptor. + Whether or not the property is required for the component + + :param required: The required of this PropertyDescriptor. + :type: bool + """ + + self._required = required + + @property + def resource_definition(self): + """ + Gets the resource_definition of this PropertyDescriptor. + + :return: The resource_definition of this PropertyDescriptor. + :rtype: PropertyResourceDefinition + """ + return self._resource_definition + + @resource_definition.setter + def resource_definition(self, resource_definition): + """ + Sets the resource_definition of this PropertyDescriptor. + + :param resource_definition: The resource_definition of this PropertyDescriptor. + :type: PropertyResourceDefinition + """ + + self._resource_definition = resource_definition + + @property + def sensitive(self): + """ + Gets the sensitive of this PropertyDescriptor. + Whether or not the value of the property is considered sensitive (e.g., passwords and keys) + + :return: The sensitive of this PropertyDescriptor. + :rtype: bool + """ + return self._sensitive + + @sensitive.setter + def sensitive(self, sensitive): + """ + Sets the sensitive of this PropertyDescriptor. + Whether or not the value of the property is considered sensitive (e.g., passwords and keys) + + :param sensitive: The sensitive of this PropertyDescriptor. + :type: bool + """ + + self._sensitive = sensitive + @property def type_provided_by_value(self): """ Gets the type_provided_by_value of this PropertyDescriptor. - Indicates that this property is for selecting a controller service of the specified type :return: The type_provided_by_value of this PropertyDescriptor. :rtype: DefinedType @@ -344,7 +406,6 @@ def type_provided_by_value(self): def type_provided_by_value(self, type_provided_by_value): """ Sets the type_provided_by_value of this PropertyDescriptor. - Indicates that this property is for selecting a controller service of the specified type :param type_provided_by_value: The type_provided_by_value of this PropertyDescriptor. :type: DefinedType @@ -398,75 +459,6 @@ def validator(self, validator): self._validator = validator - @property - def dynamic(self): - """ - Gets the dynamic of this PropertyDescriptor. - Whether or not the descriptor is for a dynamically added property - - :return: The dynamic of this PropertyDescriptor. - :rtype: bool - """ - return self._dynamic - - @dynamic.setter - def dynamic(self, dynamic): - """ - Sets the dynamic of this PropertyDescriptor. - Whether or not the descriptor is for a dynamically added property - - :param dynamic: The dynamic of this PropertyDescriptor. - :type: bool - """ - - self._dynamic = dynamic - - @property - def resource_definition(self): - """ - Gets the resource_definition of this PropertyDescriptor. - Indicates that this property references external resources - - :return: The resource_definition of this PropertyDescriptor. - :rtype: PropertyResourceDefinition - """ - return self._resource_definition - - @resource_definition.setter - def resource_definition(self, resource_definition): - """ - Sets the resource_definition of this PropertyDescriptor. - Indicates that this property references external resources - - :param resource_definition: The resource_definition of this PropertyDescriptor. - :type: PropertyResourceDefinition - """ - - self._resource_definition = resource_definition - - @property - def dependencies(self): - """ - Gets the dependencies of this PropertyDescriptor. - The dependencies that this property has on other properties - - :return: The dependencies of this PropertyDescriptor. - :rtype: list[PropertyDependency] - """ - return self._dependencies - - @dependencies.setter - def dependencies(self, dependencies): - """ - Sets the dependencies of this PropertyDescriptor. - The dependencies that this property has on other properties - - :param dependencies: The dependencies of this PropertyDescriptor. - :type: list[PropertyDependency] - """ - - self._dependencies = dependencies - def to_dict(self): """ Returns the model properties as a dict diff --git a/nipyapi/nifi/models/property_descriptor_dto.py b/nipyapi/nifi/models/property_descriptor_dto.py index c04ab0f9..8706f333 100644 --- a/nipyapi/nifi/models/property_descriptor_dto.py +++ b/nipyapi/nifi/models/property_descriptor_dto.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,151 +27,103 @@ class PropertyDescriptorDTO(object): and the value is json key in definition. """ swagger_types = { - 'name': 'str', - 'display_name': 'str', - 'description': 'str', - 'default_value': 'str', 'allowable_values': 'list[AllowableValueEntity]', - 'required': 'bool', - 'sensitive': 'bool', - 'dynamic': 'bool', - 'supports_el': 'bool', - 'expression_language_scope': 'str', - 'identifies_controller_service': 'str', - 'identifies_controller_service_bundle': 'BundleDTO', - 'dependencies': 'list[PropertyDependencyDTO]' - } +'default_value': 'str', +'dependencies': 'list[PropertyDependencyDTO]', +'description': 'str', +'display_name': 'str', +'dynamic': 'bool', +'expression_language_scope': 'str', +'identifies_controller_service': 'str', +'identifies_controller_service_bundle': 'BundleDTO', +'name': 'str', +'required': 'bool', +'sensitive': 'bool', +'supports_el': 'bool' } attribute_map = { - 'name': 'name', - 'display_name': 'displayName', - 'description': 'description', - 'default_value': 'defaultValue', 'allowable_values': 'allowableValues', - 'required': 'required', - 'sensitive': 'sensitive', - 'dynamic': 'dynamic', - 'supports_el': 'supportsEl', - 'expression_language_scope': 'expressionLanguageScope', - 'identifies_controller_service': 'identifiesControllerService', - 'identifies_controller_service_bundle': 'identifiesControllerServiceBundle', - 'dependencies': 'dependencies' - } - - def __init__(self, name=None, display_name=None, description=None, default_value=None, allowable_values=None, required=None, sensitive=None, dynamic=None, supports_el=None, expression_language_scope=None, identifies_controller_service=None, identifies_controller_service_bundle=None, dependencies=None): +'default_value': 'defaultValue', +'dependencies': 'dependencies', +'description': 'description', +'display_name': 'displayName', +'dynamic': 'dynamic', +'expression_language_scope': 'expressionLanguageScope', +'identifies_controller_service': 'identifiesControllerService', +'identifies_controller_service_bundle': 'identifiesControllerServiceBundle', +'name': 'name', +'required': 'required', +'sensitive': 'sensitive', +'supports_el': 'supportsEl' } + + def __init__(self, allowable_values=None, default_value=None, dependencies=None, description=None, display_name=None, dynamic=None, expression_language_scope=None, identifies_controller_service=None, identifies_controller_service_bundle=None, name=None, required=None, sensitive=None, supports_el=None): """ PropertyDescriptorDTO - a model defined in Swagger """ - self._name = None - self._display_name = None - self._description = None - self._default_value = None self._allowable_values = None - self._required = None - self._sensitive = None + self._default_value = None + self._dependencies = None + self._description = None + self._display_name = None self._dynamic = None - self._supports_el = None self._expression_language_scope = None self._identifies_controller_service = None self._identifies_controller_service_bundle = None - self._dependencies = None + self._name = None + self._required = None + self._sensitive = None + self._supports_el = None - if name is not None: - self.name = name - if display_name is not None: - self.display_name = display_name - if description is not None: - self.description = description - if default_value is not None: - self.default_value = default_value if allowable_values is not None: self.allowable_values = allowable_values - if required is not None: - self.required = required - if sensitive is not None: - self.sensitive = sensitive + if default_value is not None: + self.default_value = default_value + if dependencies is not None: + self.dependencies = dependencies + if description is not None: + self.description = description + if display_name is not None: + self.display_name = display_name if dynamic is not None: self.dynamic = dynamic - if supports_el is not None: - self.supports_el = supports_el if expression_language_scope is not None: self.expression_language_scope = expression_language_scope if identifies_controller_service is not None: self.identifies_controller_service = identifies_controller_service if identifies_controller_service_bundle is not None: self.identifies_controller_service_bundle = identifies_controller_service_bundle - if dependencies is not None: - self.dependencies = dependencies - - @property - def name(self): - """ - Gets the name of this PropertyDescriptorDTO. - The name for the property. - - :return: The name of this PropertyDescriptorDTO. - :rtype: str - """ - return self._name - - @name.setter - def name(self, name): - """ - Sets the name of this PropertyDescriptorDTO. - The name for the property. - - :param name: The name of this PropertyDescriptorDTO. - :type: str - """ - - self._name = name - - @property - def display_name(self): - """ - Gets the display_name of this PropertyDescriptorDTO. - The human readable name for the property. - - :return: The display_name of this PropertyDescriptorDTO. - :rtype: str - """ - return self._display_name - - @display_name.setter - def display_name(self, display_name): - """ - Sets the display_name of this PropertyDescriptorDTO. - The human readable name for the property. - - :param display_name: The display_name of this PropertyDescriptorDTO. - :type: str - """ - - self._display_name = display_name + if name is not None: + self.name = name + if required is not None: + self.required = required + if sensitive is not None: + self.sensitive = sensitive + if supports_el is not None: + self.supports_el = supports_el @property - def description(self): + def allowable_values(self): """ - Gets the description of this PropertyDescriptorDTO. - The description for the property. Used to relay additional details to a user or provide a mechanism of documenting intent. + Gets the allowable_values of this PropertyDescriptorDTO. + Allowable values for the property. If empty then the allowed values are not constrained. - :return: The description of this PropertyDescriptorDTO. - :rtype: str + :return: The allowable_values of this PropertyDescriptorDTO. + :rtype: list[AllowableValueEntity] """ - return self._description + return self._allowable_values - @description.setter - def description(self, description): + @allowable_values.setter + def allowable_values(self, allowable_values): """ - Sets the description of this PropertyDescriptorDTO. - The description for the property. Used to relay additional details to a user or provide a mechanism of documenting intent. + Sets the allowable_values of this PropertyDescriptorDTO. + Allowable values for the property. If empty then the allowed values are not constrained. - :param description: The description of this PropertyDescriptorDTO. - :type: str + :param allowable_values: The allowable_values of this PropertyDescriptorDTO. + :type: list[AllowableValueEntity] """ - self._description = description + self._allowable_values = allowable_values @property def default_value(self): @@ -198,73 +149,73 @@ def default_value(self, default_value): self._default_value = default_value @property - def allowable_values(self): + def dependencies(self): """ - Gets the allowable_values of this PropertyDescriptorDTO. - Allowable values for the property. If empty then the allowed values are not constrained. + Gets the dependencies of this PropertyDescriptorDTO. + A list of dependencies that must be met in order for this Property to be relevant. If any of these dependencies is not met, the property described by this Property Descriptor is not relevant. - :return: The allowable_values of this PropertyDescriptorDTO. - :rtype: list[AllowableValueEntity] + :return: The dependencies of this PropertyDescriptorDTO. + :rtype: list[PropertyDependencyDTO] """ - return self._allowable_values + return self._dependencies - @allowable_values.setter - def allowable_values(self, allowable_values): + @dependencies.setter + def dependencies(self, dependencies): """ - Sets the allowable_values of this PropertyDescriptorDTO. - Allowable values for the property. If empty then the allowed values are not constrained. + Sets the dependencies of this PropertyDescriptorDTO. + A list of dependencies that must be met in order for this Property to be relevant. If any of these dependencies is not met, the property described by this Property Descriptor is not relevant. - :param allowable_values: The allowable_values of this PropertyDescriptorDTO. - :type: list[AllowableValueEntity] + :param dependencies: The dependencies of this PropertyDescriptorDTO. + :type: list[PropertyDependencyDTO] """ - self._allowable_values = allowable_values + self._dependencies = dependencies @property - def required(self): + def description(self): """ - Gets the required of this PropertyDescriptorDTO. - Whether the property is required. + Gets the description of this PropertyDescriptorDTO. + The description for the property. Used to relay additional details to a user or provide a mechanism of documenting intent. - :return: The required of this PropertyDescriptorDTO. - :rtype: bool + :return: The description of this PropertyDescriptorDTO. + :rtype: str """ - return self._required + return self._description - @required.setter - def required(self, required): + @description.setter + def description(self, description): """ - Sets the required of this PropertyDescriptorDTO. - Whether the property is required. + Sets the description of this PropertyDescriptorDTO. + The description for the property. Used to relay additional details to a user or provide a mechanism of documenting intent. - :param required: The required of this PropertyDescriptorDTO. - :type: bool + :param description: The description of this PropertyDescriptorDTO. + :type: str """ - self._required = required + self._description = description @property - def sensitive(self): + def display_name(self): """ - Gets the sensitive of this PropertyDescriptorDTO. - Whether the property is sensitive and protected whenever stored or represented. + Gets the display_name of this PropertyDescriptorDTO. + The human readable name for the property. - :return: The sensitive of this PropertyDescriptorDTO. - :rtype: bool + :return: The display_name of this PropertyDescriptorDTO. + :rtype: str """ - return self._sensitive + return self._display_name - @sensitive.setter - def sensitive(self, sensitive): + @display_name.setter + def display_name(self, display_name): """ - Sets the sensitive of this PropertyDescriptorDTO. - Whether the property is sensitive and protected whenever stored or represented. + Sets the display_name of this PropertyDescriptorDTO. + The human readable name for the property. - :param sensitive: The sensitive of this PropertyDescriptorDTO. - :type: bool + :param display_name: The display_name of this PropertyDescriptorDTO. + :type: str """ - self._sensitive = sensitive + self._display_name = display_name @property def dynamic(self): @@ -289,29 +240,6 @@ def dynamic(self, dynamic): self._dynamic = dynamic - @property - def supports_el(self): - """ - Gets the supports_el of this PropertyDescriptorDTO. - Whether the property supports expression language. - - :return: The supports_el of this PropertyDescriptorDTO. - :rtype: bool - """ - return self._supports_el - - @supports_el.setter - def supports_el(self, supports_el): - """ - Sets the supports_el of this PropertyDescriptorDTO. - Whether the property supports expression language. - - :param supports_el: The supports_el of this PropertyDescriptorDTO. - :type: bool - """ - - self._supports_el = supports_el - @property def expression_language_scope(self): """ @@ -362,7 +290,6 @@ def identifies_controller_service(self, identifies_controller_service): def identifies_controller_service_bundle(self): """ Gets the identifies_controller_service_bundle of this PropertyDescriptorDTO. - If the property identifies a controller service this returns the bundle of the type, null otherwise. :return: The identifies_controller_service_bundle of this PropertyDescriptorDTO. :rtype: BundleDTO @@ -373,7 +300,6 @@ def identifies_controller_service_bundle(self): def identifies_controller_service_bundle(self, identifies_controller_service_bundle): """ Sets the identifies_controller_service_bundle of this PropertyDescriptorDTO. - If the property identifies a controller service this returns the bundle of the type, null otherwise. :param identifies_controller_service_bundle: The identifies_controller_service_bundle of this PropertyDescriptorDTO. :type: BundleDTO @@ -382,27 +308,96 @@ def identifies_controller_service_bundle(self, identifies_controller_service_bun self._identifies_controller_service_bundle = identifies_controller_service_bundle @property - def dependencies(self): + def name(self): """ - Gets the dependencies of this PropertyDescriptorDTO. - A list of dependencies that must be met in order for this Property to be relevant. If any of these dependencies is not met, the property described by this Property Descriptor is not relevant. + Gets the name of this PropertyDescriptorDTO. + The name for the property. - :return: The dependencies of this PropertyDescriptorDTO. - :rtype: list[PropertyDependencyDTO] + :return: The name of this PropertyDescriptorDTO. + :rtype: str """ - return self._dependencies + return self._name - @dependencies.setter - def dependencies(self, dependencies): + @name.setter + def name(self, name): """ - Sets the dependencies of this PropertyDescriptorDTO. - A list of dependencies that must be met in order for this Property to be relevant. If any of these dependencies is not met, the property described by this Property Descriptor is not relevant. + Sets the name of this PropertyDescriptorDTO. + The name for the property. - :param dependencies: The dependencies of this PropertyDescriptorDTO. - :type: list[PropertyDependencyDTO] + :param name: The name of this PropertyDescriptorDTO. + :type: str """ - self._dependencies = dependencies + self._name = name + + @property + def required(self): + """ + Gets the required of this PropertyDescriptorDTO. + Whether the property is required. + + :return: The required of this PropertyDescriptorDTO. + :rtype: bool + """ + return self._required + + @required.setter + def required(self, required): + """ + Sets the required of this PropertyDescriptorDTO. + Whether the property is required. + + :param required: The required of this PropertyDescriptorDTO. + :type: bool + """ + + self._required = required + + @property + def sensitive(self): + """ + Gets the sensitive of this PropertyDescriptorDTO. + Whether the property is sensitive and protected whenever stored or represented. + + :return: The sensitive of this PropertyDescriptorDTO. + :rtype: bool + """ + return self._sensitive + + @sensitive.setter + def sensitive(self, sensitive): + """ + Sets the sensitive of this PropertyDescriptorDTO. + Whether the property is sensitive and protected whenever stored or represented. + + :param sensitive: The sensitive of this PropertyDescriptorDTO. + :type: bool + """ + + self._sensitive = sensitive + + @property + def supports_el(self): + """ + Gets the supports_el of this PropertyDescriptorDTO. + Whether the property supports expression language. + + :return: The supports_el of this PropertyDescriptorDTO. + :rtype: bool + """ + return self._supports_el + + @supports_el.setter + def supports_el(self, supports_el): + """ + Sets the supports_el of this PropertyDescriptorDTO. + Whether the property supports expression language. + + :param supports_el: The supports_el of this PropertyDescriptorDTO. + :type: bool + """ + + self._supports_el = supports_el def to_dict(self): """ diff --git a/nipyapi/nifi/models/property_descriptor_entity.py b/nipyapi/nifi/models/property_descriptor_entity.py index b59fa521..045a5ae3 100644 --- a/nipyapi/nifi/models/property_descriptor_entity.py +++ b/nipyapi/nifi/models/property_descriptor_entity.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,12 +27,10 @@ class PropertyDescriptorEntity(object): and the value is json key in definition. """ swagger_types = { - 'property_descriptor': 'PropertyDescriptorDTO' - } + 'property_descriptor': 'PropertyDescriptorDTO' } attribute_map = { - 'property_descriptor': 'propertyDescriptor' - } + 'property_descriptor': 'propertyDescriptor' } def __init__(self, property_descriptor=None): """ diff --git a/nipyapi/nifi/models/property_history_dto.py b/nipyapi/nifi/models/property_history_dto.py index c8c8a822..81787ce5 100644 --- a/nipyapi/nifi/models/property_history_dto.py +++ b/nipyapi/nifi/models/property_history_dto.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,12 +27,10 @@ class PropertyHistoryDTO(object): and the value is json key in definition. """ swagger_types = { - 'previous_values': 'list[PreviousValueDTO]' - } + 'previous_values': 'list[PreviousValueDTO]' } attribute_map = { - 'previous_values': 'previousValues' - } + 'previous_values': 'previousValues' } def __init__(self, previous_values=None): """ diff --git a/nipyapi/nifi/models/property_resource_definition.py b/nipyapi/nifi/models/property_resource_definition.py index c91bed94..128d52d9 100644 --- a/nipyapi/nifi/models/property_resource_definition.py +++ b/nipyapi/nifi/models/property_resource_definition.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -29,13 +28,11 @@ class PropertyResourceDefinition(object): """ swagger_types = { 'cardinality': 'str', - 'resource_types': 'list[str]' - } +'resource_types': 'list[str]' } attribute_map = { 'cardinality': 'cardinality', - 'resource_types': 'resourceTypes' - } +'resource_types': 'resourceTypes' } def __init__(self, cardinality=None, resource_types=None): """ @@ -70,7 +67,7 @@ def cardinality(self, cardinality): :param cardinality: The cardinality of this PropertyResourceDefinition. :type: str """ - allowed_values = ["SINGLE", "MULTIPLE"] + allowed_values = ["SINGLE", "MULTIPLE", ] if cardinality not in allowed_values: raise ValueError( "Invalid value for `cardinality` ({0}), must be one of {1}" @@ -99,7 +96,7 @@ def resource_types(self, resource_types): :param resource_types: The resource_types of this PropertyResourceDefinition. :type: list[str] """ - allowed_values = ["FILE", "DIRECTORY", "TEXT", "URL"] + 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}]" diff --git a/nipyapi/nifi/models/provenance_dto.py b/nipyapi/nifi/models/provenance_dto.py index 4f17f5b1..22d8767c 100644 --- a/nipyapi/nifi/models/provenance_dto.py +++ b/nipyapi/nifi/models/provenance_dto.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,149 +27,124 @@ class ProvenanceDTO(object): and the value is json key in definition. """ swagger_types = { - 'id': 'str', - 'uri': 'str', - 'submission_time': 'str', 'expiration': 'str', - 'percent_completed': 'int', - 'finished': 'bool', - 'request': 'ProvenanceRequestDTO', - 'results': 'ProvenanceResultsDTO' - } +'finished': 'bool', +'id': 'str', +'percent_completed': 'int', +'request': 'ProvenanceRequestDTO', +'results': 'ProvenanceResultsDTO', +'submission_time': 'str', +'uri': 'str' } attribute_map = { - 'id': 'id', - 'uri': 'uri', - 'submission_time': 'submissionTime', 'expiration': 'expiration', - 'percent_completed': 'percentCompleted', - 'finished': 'finished', - 'request': 'request', - 'results': 'results' - } +'finished': 'finished', +'id': 'id', +'percent_completed': 'percentCompleted', +'request': 'request', +'results': 'results', +'submission_time': 'submissionTime', +'uri': 'uri' } - def __init__(self, id=None, uri=None, submission_time=None, expiration=None, percent_completed=None, finished=None, request=None, results=None): + def __init__(self, expiration=None, finished=None, id=None, percent_completed=None, request=None, results=None, submission_time=None, uri=None): """ ProvenanceDTO - a model defined in Swagger """ - self._id = None - self._uri = None - self._submission_time = None self._expiration = None - self._percent_completed = None self._finished = None + self._id = None + self._percent_completed = None self._request = None self._results = None + self._submission_time = None + self._uri = None - if id is not None: - self.id = id - if uri is not None: - self.uri = uri - if submission_time is not None: - self.submission_time = submission_time if expiration is not None: self.expiration = expiration - if percent_completed is not None: - self.percent_completed = percent_completed if finished is not None: self.finished = finished + if id is not None: + self.id = id + if percent_completed is not None: + self.percent_completed = percent_completed if request is not None: self.request = request if results is not None: self.results = results + if submission_time is not None: + self.submission_time = submission_time + if uri is not None: + self.uri = uri @property - def id(self): - """ - Gets the id of this ProvenanceDTO. - The id of the provenance query. - - :return: The id of this ProvenanceDTO. - :rtype: str - """ - return self._id - - @id.setter - def id(self, id): - """ - Sets the id of this ProvenanceDTO. - The id of the provenance query. - - :param id: The id of this ProvenanceDTO. - :type: str - """ - - self._id = id - - @property - def uri(self): + def expiration(self): """ - Gets the uri of this ProvenanceDTO. - The URI for this query. Used for obtaining/deleting the request at a later time + Gets the expiration of this ProvenanceDTO. + The timestamp when the query will expire. - :return: The uri of this ProvenanceDTO. + :return: The expiration of this ProvenanceDTO. :rtype: str """ - return self._uri + return self._expiration - @uri.setter - def uri(self, uri): + @expiration.setter + def expiration(self, expiration): """ - Sets the uri of this ProvenanceDTO. - The URI for this query. Used for obtaining/deleting the request at a later time + Sets the expiration of this ProvenanceDTO. + The timestamp when the query will expire. - :param uri: The uri of this ProvenanceDTO. + :param expiration: The expiration of this ProvenanceDTO. :type: str """ - self._uri = uri + self._expiration = expiration @property - def submission_time(self): + def finished(self): """ - Gets the submission_time of this ProvenanceDTO. - The timestamp when the query was submitted. + Gets the finished of this ProvenanceDTO. + Whether the query has finished. - :return: The submission_time of this ProvenanceDTO. - :rtype: str + :return: The finished of this ProvenanceDTO. + :rtype: bool """ - return self._submission_time + return self._finished - @submission_time.setter - def submission_time(self, submission_time): + @finished.setter + def finished(self, finished): """ - Sets the submission_time of this ProvenanceDTO. - The timestamp when the query was submitted. + Sets the finished of this ProvenanceDTO. + Whether the query has finished. - :param submission_time: The submission_time of this ProvenanceDTO. - :type: str + :param finished: The finished of this ProvenanceDTO. + :type: bool """ - self._submission_time = submission_time + self._finished = finished @property - def expiration(self): + def id(self): """ - Gets the expiration of this ProvenanceDTO. - The timestamp when the query will expire. + Gets the id of this ProvenanceDTO. + The id of the provenance query. - :return: The expiration of this ProvenanceDTO. + :return: The id of this ProvenanceDTO. :rtype: str """ - return self._expiration + return self._id - @expiration.setter - def expiration(self, expiration): + @id.setter + def id(self, id): """ - Sets the expiration of this ProvenanceDTO. - The timestamp when the query will expire. + Sets the id of this ProvenanceDTO. + The id of the provenance query. - :param expiration: The expiration of this ProvenanceDTO. + :param id: The id of this ProvenanceDTO. :type: str """ - self._expiration = expiration + self._id = id @property def percent_completed(self): @@ -195,34 +169,10 @@ def percent_completed(self, percent_completed): self._percent_completed = percent_completed - @property - def finished(self): - """ - Gets the finished of this ProvenanceDTO. - Whether the query has finished. - - :return: The finished of this ProvenanceDTO. - :rtype: bool - """ - return self._finished - - @finished.setter - def finished(self, finished): - """ - Sets the finished of this ProvenanceDTO. - Whether the query has finished. - - :param finished: The finished of this ProvenanceDTO. - :type: bool - """ - - self._finished = finished - @property def request(self): """ Gets the request of this ProvenanceDTO. - The provenance request. :return: The request of this ProvenanceDTO. :rtype: ProvenanceRequestDTO @@ -233,7 +183,6 @@ def request(self): def request(self, request): """ Sets the request of this ProvenanceDTO. - The provenance request. :param request: The request of this ProvenanceDTO. :type: ProvenanceRequestDTO @@ -245,7 +194,6 @@ def request(self, request): def results(self): """ Gets the results of this ProvenanceDTO. - The provenance results. :return: The results of this ProvenanceDTO. :rtype: ProvenanceResultsDTO @@ -256,7 +204,6 @@ def results(self): def results(self, results): """ Sets the results of this ProvenanceDTO. - The provenance results. :param results: The results of this ProvenanceDTO. :type: ProvenanceResultsDTO @@ -264,6 +211,52 @@ def results(self, results): self._results = results + @property + def submission_time(self): + """ + Gets the submission_time of this ProvenanceDTO. + The timestamp when the query was submitted. + + :return: The submission_time of this ProvenanceDTO. + :rtype: str + """ + return self._submission_time + + @submission_time.setter + def submission_time(self, submission_time): + """ + Sets the submission_time of this ProvenanceDTO. + The timestamp when the query was submitted. + + :param submission_time: The submission_time of this ProvenanceDTO. + :type: str + """ + + self._submission_time = submission_time + + @property + def uri(self): + """ + Gets the uri of this ProvenanceDTO. + The URI for this query. Used for obtaining/deleting the request at a later time + + :return: The uri of this ProvenanceDTO. + :rtype: str + """ + return self._uri + + @uri.setter + def uri(self, uri): + """ + Sets the uri of this ProvenanceDTO. + The URI for this query. Used for obtaining/deleting the request at a later time + + :param uri: The uri of this ProvenanceDTO. + :type: str + """ + + self._uri = uri + def to_dict(self): """ Returns the model properties as a dict diff --git a/nipyapi/nifi/models/provenance_entity.py b/nipyapi/nifi/models/provenance_entity.py index 0368b02e..c80183db 100644 --- a/nipyapi/nifi/models/provenance_entity.py +++ b/nipyapi/nifi/models/provenance_entity.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,12 +27,10 @@ class ProvenanceEntity(object): and the value is json key in definition. """ swagger_types = { - 'provenance': 'ProvenanceDTO' - } + 'provenance': 'ProvenanceDTO' } attribute_map = { - 'provenance': 'provenance' - } + 'provenance': 'provenance' } def __init__(self, provenance=None): """ diff --git a/nipyapi/nifi/models/provenance_event_dto.py b/nipyapi/nifi/models/provenance_event_dto.py index 3b4339d1..3c5d36ad 100644 --- a/nipyapi/nifi/models/provenance_event_dto.py +++ b/nipyapi/nifi/models/provenance_event_dto.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,438 +27,321 @@ class ProvenanceEventDTO(object): and the value is json key in definition. """ swagger_types = { - 'id': 'str', - 'event_id': 'int', - 'event_time': 'str', - 'event_duration': 'int', - 'lineage_duration': 'int', - 'event_type': 'str', - 'flow_file_uuid': 'str', - 'file_size': 'str', - 'file_size_bytes': 'int', - 'cluster_node_id': 'str', - 'cluster_node_address': 'str', - 'group_id': 'str', - 'component_id': 'str', - 'component_type': 'str', - 'component_name': 'str', - 'source_system_flow_file_id': 'str', 'alternate_identifier_uri': 'str', - 'attributes': 'list[AttributeDTO]', - 'parent_uuids': 'list[str]', - 'child_uuids': 'list[str]', - 'transit_uri': 'str', - 'relationship': 'str', - 'details': 'str', - 'content_equal': 'bool', - 'input_content_available': 'bool', - 'input_content_claim_section': 'str', - 'input_content_claim_container': 'str', - 'input_content_claim_identifier': 'str', - 'input_content_claim_offset': 'int', - 'input_content_claim_file_size': 'str', - 'input_content_claim_file_size_bytes': 'int', - 'output_content_available': 'bool', - 'output_content_claim_section': 'str', - 'output_content_claim_container': 'str', - 'output_content_claim_identifier': 'str', - 'output_content_claim_offset': 'int', - 'output_content_claim_file_size': 'str', - 'output_content_claim_file_size_bytes': 'int', - 'replay_available': 'bool', - 'replay_explanation': 'str', - 'source_connection_identifier': 'str' - } +'attributes': 'list[AttributeDTO]', +'child_uuids': 'list[str]', +'cluster_node_address': 'str', +'cluster_node_id': 'str', +'component_id': 'str', +'component_name': 'str', +'component_type': 'str', +'content_equal': 'bool', +'details': 'str', +'event_duration': 'int', +'event_id': 'int', +'event_time': 'str', +'event_type': 'str', +'file_size': 'str', +'file_size_bytes': 'int', +'flow_file_uuid': 'str', +'group_id': 'str', +'id': 'str', +'input_content_available': 'bool', +'input_content_claim_container': 'str', +'input_content_claim_file_size': 'str', +'input_content_claim_file_size_bytes': 'int', +'input_content_claim_identifier': 'str', +'input_content_claim_offset': 'int', +'input_content_claim_section': 'str', +'lineage_duration': 'int', +'output_content_available': 'bool', +'output_content_claim_container': 'str', +'output_content_claim_file_size': 'str', +'output_content_claim_file_size_bytes': 'int', +'output_content_claim_identifier': 'str', +'output_content_claim_offset': 'int', +'output_content_claim_section': 'str', +'parent_uuids': 'list[str]', +'relationship': 'str', +'replay_available': 'bool', +'replay_explanation': 'str', +'source_connection_identifier': 'str', +'source_system_flow_file_id': 'str', +'transit_uri': 'str' } attribute_map = { - 'id': 'id', - 'event_id': 'eventId', - 'event_time': 'eventTime', - 'event_duration': 'eventDuration', - 'lineage_duration': 'lineageDuration', - 'event_type': 'eventType', - 'flow_file_uuid': 'flowFileUuid', - 'file_size': 'fileSize', - 'file_size_bytes': 'fileSizeBytes', - 'cluster_node_id': 'clusterNodeId', - 'cluster_node_address': 'clusterNodeAddress', - 'group_id': 'groupId', - 'component_id': 'componentId', - 'component_type': 'componentType', - 'component_name': 'componentName', - 'source_system_flow_file_id': 'sourceSystemFlowFileId', 'alternate_identifier_uri': 'alternateIdentifierUri', - 'attributes': 'attributes', - 'parent_uuids': 'parentUuids', - 'child_uuids': 'childUuids', - 'transit_uri': 'transitUri', - 'relationship': 'relationship', - 'details': 'details', - 'content_equal': 'contentEqual', - 'input_content_available': 'inputContentAvailable', - 'input_content_claim_section': 'inputContentClaimSection', - 'input_content_claim_container': 'inputContentClaimContainer', - 'input_content_claim_identifier': 'inputContentClaimIdentifier', - 'input_content_claim_offset': 'inputContentClaimOffset', - 'input_content_claim_file_size': 'inputContentClaimFileSize', - 'input_content_claim_file_size_bytes': 'inputContentClaimFileSizeBytes', - 'output_content_available': 'outputContentAvailable', - 'output_content_claim_section': 'outputContentClaimSection', - 'output_content_claim_container': 'outputContentClaimContainer', - 'output_content_claim_identifier': 'outputContentClaimIdentifier', - 'output_content_claim_offset': 'outputContentClaimOffset', - 'output_content_claim_file_size': 'outputContentClaimFileSize', - 'output_content_claim_file_size_bytes': 'outputContentClaimFileSizeBytes', - 'replay_available': 'replayAvailable', - 'replay_explanation': 'replayExplanation', - 'source_connection_identifier': 'sourceConnectionIdentifier' - } - - def __init__(self, id=None, event_id=None, event_time=None, event_duration=None, lineage_duration=None, event_type=None, flow_file_uuid=None, file_size=None, file_size_bytes=None, cluster_node_id=None, cluster_node_address=None, group_id=None, component_id=None, component_type=None, component_name=None, source_system_flow_file_id=None, alternate_identifier_uri=None, attributes=None, parent_uuids=None, child_uuids=None, transit_uri=None, relationship=None, details=None, content_equal=None, input_content_available=None, input_content_claim_section=None, input_content_claim_container=None, input_content_claim_identifier=None, input_content_claim_offset=None, input_content_claim_file_size=None, input_content_claim_file_size_bytes=None, output_content_available=None, output_content_claim_section=None, output_content_claim_container=None, output_content_claim_identifier=None, output_content_claim_offset=None, output_content_claim_file_size=None, output_content_claim_file_size_bytes=None, replay_available=None, replay_explanation=None, source_connection_identifier=None): +'attributes': 'attributes', +'child_uuids': 'childUuids', +'cluster_node_address': 'clusterNodeAddress', +'cluster_node_id': 'clusterNodeId', +'component_id': 'componentId', +'component_name': 'componentName', +'component_type': 'componentType', +'content_equal': 'contentEqual', +'details': 'details', +'event_duration': 'eventDuration', +'event_id': 'eventId', +'event_time': 'eventTime', +'event_type': 'eventType', +'file_size': 'fileSize', +'file_size_bytes': 'fileSizeBytes', +'flow_file_uuid': 'flowFileUuid', +'group_id': 'groupId', +'id': 'id', +'input_content_available': 'inputContentAvailable', +'input_content_claim_container': 'inputContentClaimContainer', +'input_content_claim_file_size': 'inputContentClaimFileSize', +'input_content_claim_file_size_bytes': 'inputContentClaimFileSizeBytes', +'input_content_claim_identifier': 'inputContentClaimIdentifier', +'input_content_claim_offset': 'inputContentClaimOffset', +'input_content_claim_section': 'inputContentClaimSection', +'lineage_duration': 'lineageDuration', +'output_content_available': 'outputContentAvailable', +'output_content_claim_container': 'outputContentClaimContainer', +'output_content_claim_file_size': 'outputContentClaimFileSize', +'output_content_claim_file_size_bytes': 'outputContentClaimFileSizeBytes', +'output_content_claim_identifier': 'outputContentClaimIdentifier', +'output_content_claim_offset': 'outputContentClaimOffset', +'output_content_claim_section': 'outputContentClaimSection', +'parent_uuids': 'parentUuids', +'relationship': 'relationship', +'replay_available': 'replayAvailable', +'replay_explanation': 'replayExplanation', +'source_connection_identifier': 'sourceConnectionIdentifier', +'source_system_flow_file_id': 'sourceSystemFlowFileId', +'transit_uri': 'transitUri' } + + def __init__(self, alternate_identifier_uri=None, attributes=None, child_uuids=None, cluster_node_address=None, cluster_node_id=None, component_id=None, component_name=None, component_type=None, content_equal=None, details=None, event_duration=None, event_id=None, event_time=None, event_type=None, file_size=None, file_size_bytes=None, flow_file_uuid=None, group_id=None, id=None, input_content_available=None, input_content_claim_container=None, input_content_claim_file_size=None, input_content_claim_file_size_bytes=None, input_content_claim_identifier=None, input_content_claim_offset=None, input_content_claim_section=None, lineage_duration=None, output_content_available=None, output_content_claim_container=None, output_content_claim_file_size=None, output_content_claim_file_size_bytes=None, output_content_claim_identifier=None, output_content_claim_offset=None, output_content_claim_section=None, parent_uuids=None, relationship=None, replay_available=None, replay_explanation=None, source_connection_identifier=None, source_system_flow_file_id=None, transit_uri=None): """ ProvenanceEventDTO - a model defined in Swagger """ - self._id = None + self._alternate_identifier_uri = None + self._attributes = None + self._child_uuids = None + self._cluster_node_address = None + self._cluster_node_id = None + self._component_id = None + self._component_name = None + self._component_type = None + self._content_equal = None + self._details = None + self._event_duration = None self._event_id = None self._event_time = None - self._event_duration = None - self._lineage_duration = None self._event_type = None - self._flow_file_uuid = None self._file_size = None self._file_size_bytes = None - self._cluster_node_id = None - self._cluster_node_address = None + self._flow_file_uuid = None self._group_id = None - self._component_id = None - self._component_type = None - self._component_name = None - self._source_system_flow_file_id = None - self._alternate_identifier_uri = None - self._attributes = None - self._parent_uuids = None - self._child_uuids = None - self._transit_uri = None - self._relationship = None - self._details = None - self._content_equal = None + self._id = None self._input_content_available = None - self._input_content_claim_section = None self._input_content_claim_container = None - self._input_content_claim_identifier = None - self._input_content_claim_offset = None self._input_content_claim_file_size = None self._input_content_claim_file_size_bytes = None + self._input_content_claim_identifier = None + self._input_content_claim_offset = None + self._input_content_claim_section = None + self._lineage_duration = None self._output_content_available = None - self._output_content_claim_section = None self._output_content_claim_container = None - self._output_content_claim_identifier = None - self._output_content_claim_offset = None self._output_content_claim_file_size = None self._output_content_claim_file_size_bytes = None + self._output_content_claim_identifier = None + self._output_content_claim_offset = None + self._output_content_claim_section = None + self._parent_uuids = None + self._relationship = None self._replay_available = None self._replay_explanation = None self._source_connection_identifier = None + self._source_system_flow_file_id = None + self._transit_uri = None - if id is not None: - self.id = id + if alternate_identifier_uri is not None: + self.alternate_identifier_uri = alternate_identifier_uri + if attributes is not None: + self.attributes = attributes + if child_uuids is not None: + self.child_uuids = child_uuids + if cluster_node_address is not None: + self.cluster_node_address = cluster_node_address + if cluster_node_id is not None: + self.cluster_node_id = cluster_node_id + 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 content_equal is not None: + self.content_equal = content_equal + if details is not None: + self.details = details + if event_duration is not None: + self.event_duration = event_duration if event_id is not None: self.event_id = event_id if event_time is not None: self.event_time = event_time - if event_duration is not None: - self.event_duration = event_duration - if lineage_duration is not None: - self.lineage_duration = lineage_duration if event_type is not None: self.event_type = event_type - if flow_file_uuid is not None: - self.flow_file_uuid = flow_file_uuid if file_size is not None: self.file_size = file_size if file_size_bytes is not None: self.file_size_bytes = file_size_bytes - if cluster_node_id is not None: - self.cluster_node_id = cluster_node_id - if cluster_node_address is not None: - self.cluster_node_address = cluster_node_address + if flow_file_uuid is not None: + self.flow_file_uuid = flow_file_uuid if group_id is not None: self.group_id = group_id - if component_id is not None: - self.component_id = component_id - if component_type is not None: - self.component_type = component_type - if component_name is not None: - self.component_name = component_name - if source_system_flow_file_id is not None: - self.source_system_flow_file_id = source_system_flow_file_id - if alternate_identifier_uri is not None: - self.alternate_identifier_uri = alternate_identifier_uri - if attributes is not None: - self.attributes = attributes - if parent_uuids is not None: - self.parent_uuids = parent_uuids - if child_uuids is not None: - self.child_uuids = child_uuids - if transit_uri is not None: - self.transit_uri = transit_uri - if relationship is not None: - self.relationship = relationship - if details is not None: - self.details = details - if content_equal is not None: - self.content_equal = content_equal + if id is not None: + self.id = id if input_content_available is not None: self.input_content_available = input_content_available - if input_content_claim_section is not None: - self.input_content_claim_section = input_content_claim_section if input_content_claim_container is not None: self.input_content_claim_container = input_content_claim_container - if input_content_claim_identifier is not None: - self.input_content_claim_identifier = input_content_claim_identifier - if input_content_claim_offset is not None: - self.input_content_claim_offset = input_content_claim_offset if input_content_claim_file_size is not None: self.input_content_claim_file_size = input_content_claim_file_size if input_content_claim_file_size_bytes is not None: self.input_content_claim_file_size_bytes = input_content_claim_file_size_bytes + if input_content_claim_identifier is not None: + self.input_content_claim_identifier = input_content_claim_identifier + if input_content_claim_offset is not None: + self.input_content_claim_offset = input_content_claim_offset + if input_content_claim_section is not None: + self.input_content_claim_section = input_content_claim_section + if lineage_duration is not None: + self.lineage_duration = lineage_duration if output_content_available is not None: self.output_content_available = output_content_available - if output_content_claim_section is not None: - self.output_content_claim_section = output_content_claim_section if output_content_claim_container is not None: self.output_content_claim_container = output_content_claim_container - if output_content_claim_identifier is not None: - self.output_content_claim_identifier = output_content_claim_identifier - if output_content_claim_offset is not None: - self.output_content_claim_offset = output_content_claim_offset if output_content_claim_file_size is not None: self.output_content_claim_file_size = output_content_claim_file_size if output_content_claim_file_size_bytes is not None: self.output_content_claim_file_size_bytes = output_content_claim_file_size_bytes + if output_content_claim_identifier is not None: + self.output_content_claim_identifier = output_content_claim_identifier + if output_content_claim_offset is not None: + self.output_content_claim_offset = output_content_claim_offset + if output_content_claim_section is not None: + self.output_content_claim_section = output_content_claim_section + if parent_uuids is not None: + self.parent_uuids = parent_uuids + if relationship is not None: + self.relationship = relationship if replay_available is not None: self.replay_available = replay_available if replay_explanation is not None: self.replay_explanation = replay_explanation if source_connection_identifier is not None: self.source_connection_identifier = source_connection_identifier + if source_system_flow_file_id is not None: + self.source_system_flow_file_id = source_system_flow_file_id + if transit_uri is not None: + self.transit_uri = transit_uri @property - def id(self): + def alternate_identifier_uri(self): """ - Gets the id of this ProvenanceEventDTO. - The event uuid. + Gets the alternate_identifier_uri of this ProvenanceEventDTO. + The alternate identifier uri for the fileflow for the event. - :return: The id of this ProvenanceEventDTO. + :return: The alternate_identifier_uri of this ProvenanceEventDTO. :rtype: str """ - return self._id + return self._alternate_identifier_uri - @id.setter - def id(self, id): + @alternate_identifier_uri.setter + def alternate_identifier_uri(self, alternate_identifier_uri): """ - Sets the id of this ProvenanceEventDTO. - The event uuid. + Sets the alternate_identifier_uri of this ProvenanceEventDTO. + The alternate identifier uri for the fileflow for the event. - :param id: The id of this ProvenanceEventDTO. + :param alternate_identifier_uri: The alternate_identifier_uri of this ProvenanceEventDTO. :type: str """ - self._id = id + self._alternate_identifier_uri = alternate_identifier_uri @property - def event_id(self): + def attributes(self): """ - Gets the event_id of this ProvenanceEventDTO. - The event id. This is a one up number thats unique per node. + Gets the attributes of this ProvenanceEventDTO. + The attributes of the flowfile for the event. - :return: The event_id of this ProvenanceEventDTO. - :rtype: int + :return: The attributes of this ProvenanceEventDTO. + :rtype: list[AttributeDTO] """ - return self._event_id + return self._attributes - @event_id.setter - def event_id(self, event_id): + @attributes.setter + def attributes(self, attributes): """ - Sets the event_id of this ProvenanceEventDTO. - The event id. This is a one up number thats unique per node. + Sets the attributes of this ProvenanceEventDTO. + The attributes of the flowfile for the event. - :param event_id: The event_id of this ProvenanceEventDTO. - :type: int + :param attributes: The attributes of this ProvenanceEventDTO. + :type: list[AttributeDTO] """ - self._event_id = event_id + self._attributes = attributes @property - def event_time(self): + def child_uuids(self): """ - Gets the event_time of this ProvenanceEventDTO. - The timestamp of the event. + Gets the child_uuids of this ProvenanceEventDTO. + The child uuids for the event. - :return: The event_time of this ProvenanceEventDTO. - :rtype: str + :return: The child_uuids of this ProvenanceEventDTO. + :rtype: list[str] """ - return self._event_time + return self._child_uuids - @event_time.setter - def event_time(self, event_time): + @child_uuids.setter + def child_uuids(self, child_uuids): """ - Sets the event_time of this ProvenanceEventDTO. - The timestamp of the event. + Sets the child_uuids of this ProvenanceEventDTO. + The child uuids for the event. - :param event_time: The event_time of this ProvenanceEventDTO. - :type: str + :param child_uuids: The child_uuids of this ProvenanceEventDTO. + :type: list[str] """ - self._event_time = event_time + self._child_uuids = child_uuids @property - def event_duration(self): + def cluster_node_address(self): """ - Gets the event_duration of this ProvenanceEventDTO. - The event duration in milliseconds. + Gets the cluster_node_address of this ProvenanceEventDTO. + The label for the node where the event originated. - :return: The event_duration of this ProvenanceEventDTO. - :rtype: int + :return: The cluster_node_address of this ProvenanceEventDTO. + :rtype: str """ - return self._event_duration + return self._cluster_node_address - @event_duration.setter - def event_duration(self, event_duration): + @cluster_node_address.setter + def cluster_node_address(self, cluster_node_address): """ - Sets the event_duration of this ProvenanceEventDTO. - The event duration in milliseconds. + Sets the cluster_node_address of this ProvenanceEventDTO. + The label for the node where the event originated. - :param event_duration: The event_duration of this ProvenanceEventDTO. - :type: int + :param cluster_node_address: The cluster_node_address of this ProvenanceEventDTO. + :type: str """ - self._event_duration = event_duration + self._cluster_node_address = cluster_node_address @property - def lineage_duration(self): + def cluster_node_id(self): """ - Gets the lineage_duration of this ProvenanceEventDTO. - The duration since the lineage began, in milliseconds. + Gets the cluster_node_id of this ProvenanceEventDTO. + The identifier for the node where the event originated. - :return: The lineage_duration of this ProvenanceEventDTO. - :rtype: int - """ - return self._lineage_duration - - @lineage_duration.setter - def lineage_duration(self, lineage_duration): - """ - Sets the lineage_duration of this ProvenanceEventDTO. - The duration since the lineage began, in milliseconds. - - :param lineage_duration: The lineage_duration of this ProvenanceEventDTO. - :type: int - """ - - self._lineage_duration = lineage_duration - - @property - def event_type(self): - """ - Gets the event_type of this ProvenanceEventDTO. - The type of the event. - - :return: The event_type of this ProvenanceEventDTO. - :rtype: str - """ - return self._event_type - - @event_type.setter - def event_type(self, event_type): - """ - Sets the event_type of this ProvenanceEventDTO. - The type of the event. - - :param event_type: The event_type of this ProvenanceEventDTO. - :type: str - """ - - self._event_type = event_type - - @property - def flow_file_uuid(self): - """ - Gets the flow_file_uuid of this ProvenanceEventDTO. - The uuid of the flowfile for the event. - - :return: The flow_file_uuid of this ProvenanceEventDTO. - :rtype: str - """ - return self._flow_file_uuid - - @flow_file_uuid.setter - def flow_file_uuid(self, flow_file_uuid): - """ - Sets the flow_file_uuid of this ProvenanceEventDTO. - The uuid of the flowfile for the event. - - :param flow_file_uuid: The flow_file_uuid of this ProvenanceEventDTO. - :type: str - """ - - self._flow_file_uuid = flow_file_uuid - - @property - def file_size(self): - """ - Gets the file_size of this ProvenanceEventDTO. - The size of the flowfile for the event. - - :return: The file_size of this ProvenanceEventDTO. - :rtype: str - """ - return self._file_size - - @file_size.setter - def file_size(self, file_size): - """ - Sets the file_size of this ProvenanceEventDTO. - The size of the flowfile for the event. - - :param file_size: The file_size of this ProvenanceEventDTO. - :type: str - """ - - self._file_size = file_size - - @property - def file_size_bytes(self): - """ - Gets the file_size_bytes of this ProvenanceEventDTO. - The size of the flowfile in bytes for the event. - - :return: The file_size_bytes of this ProvenanceEventDTO. - :rtype: int - """ - return self._file_size_bytes - - @file_size_bytes.setter - def file_size_bytes(self, file_size_bytes): - """ - Sets the file_size_bytes of this ProvenanceEventDTO. - The size of the flowfile in bytes for the event. - - :param file_size_bytes: The file_size_bytes of this ProvenanceEventDTO. - :type: int - """ - - self._file_size_bytes = file_size_bytes - - @property - def cluster_node_id(self): - """ - Gets the cluster_node_id of this ProvenanceEventDTO. - The identifier for the node where the event originated. - - :return: The cluster_node_id of this ProvenanceEventDTO. - :rtype: str + :return: The cluster_node_id of this ProvenanceEventDTO. + :rtype: str """ return self._cluster_node_id @@ -476,73 +358,50 @@ def cluster_node_id(self, cluster_node_id): self._cluster_node_id = cluster_node_id @property - def cluster_node_address(self): - """ - Gets the cluster_node_address of this ProvenanceEventDTO. - The label for the node where the event originated. - - :return: The cluster_node_address of this ProvenanceEventDTO. - :rtype: str - """ - return self._cluster_node_address - - @cluster_node_address.setter - def cluster_node_address(self, cluster_node_address): - """ - Sets the cluster_node_address of this ProvenanceEventDTO. - The label for the node where the event originated. - - :param cluster_node_address: The cluster_node_address of this ProvenanceEventDTO. - :type: str - """ - - self._cluster_node_address = cluster_node_address - - @property - def group_id(self): + def component_id(self): """ - Gets the group_id of this ProvenanceEventDTO. - The id of the group that the component resides in. If the component is no longer in the flow, the group id will not be set. + Gets the component_id of this ProvenanceEventDTO. + The id of the component that generated the event. - :return: The group_id of this ProvenanceEventDTO. + :return: The component_id of this ProvenanceEventDTO. :rtype: str """ - return self._group_id + return self._component_id - @group_id.setter - def group_id(self, group_id): + @component_id.setter + def component_id(self, component_id): """ - Sets the group_id of this ProvenanceEventDTO. - The id of the group that the component resides in. If the component is no longer in the flow, the group id will not be set. + Sets the component_id of this ProvenanceEventDTO. + The id of the component that generated the event. - :param group_id: The group_id of this ProvenanceEventDTO. + :param component_id: The component_id of this ProvenanceEventDTO. :type: str """ - self._group_id = group_id + self._component_id = component_id @property - def component_id(self): + def component_name(self): """ - Gets the component_id of this ProvenanceEventDTO. - The id of the component that generated the event. + Gets the component_name of this ProvenanceEventDTO. + The name of the component that generated the event. - :return: The component_id of this ProvenanceEventDTO. + :return: The component_name of this ProvenanceEventDTO. :rtype: str """ - return self._component_id + return self._component_name - @component_id.setter - def component_id(self, component_id): + @component_name.setter + def component_name(self, component_name): """ - Sets the component_id of this ProvenanceEventDTO. - The id of the component that generated the event. + Sets the component_name of this ProvenanceEventDTO. + The name of the component that generated the event. - :param component_id: The component_id of this ProvenanceEventDTO. + :param component_name: The component_name of this ProvenanceEventDTO. :type: str """ - self._component_id = component_id + self._component_name = component_name @property def component_type(self): @@ -568,234 +427,257 @@ def component_type(self, component_type): self._component_type = component_type @property - def component_name(self): + def content_equal(self): """ - Gets the component_name of this ProvenanceEventDTO. - The name of the component that generated the event. + Gets the content_equal of this ProvenanceEventDTO. + Whether the input and output content claim is the same. - :return: The component_name of this ProvenanceEventDTO. - :rtype: str + :return: The content_equal of this ProvenanceEventDTO. + :rtype: bool """ - return self._component_name + return self._content_equal - @component_name.setter - def component_name(self, component_name): + @content_equal.setter + def content_equal(self, content_equal): """ - Sets the component_name of this ProvenanceEventDTO. - The name of the component that generated the event. + Sets the content_equal of this ProvenanceEventDTO. + Whether the input and output content claim is the same. - :param component_name: The component_name of this ProvenanceEventDTO. - :type: str + :param content_equal: The content_equal of this ProvenanceEventDTO. + :type: bool """ - self._component_name = component_name + self._content_equal = content_equal @property - def source_system_flow_file_id(self): + def details(self): """ - Gets the source_system_flow_file_id of this ProvenanceEventDTO. - The source system flowfile id. + Gets the details of this ProvenanceEventDTO. + The event details. - :return: The source_system_flow_file_id of this ProvenanceEventDTO. + :return: The details of this ProvenanceEventDTO. :rtype: str """ - return self._source_system_flow_file_id + return self._details - @source_system_flow_file_id.setter - def source_system_flow_file_id(self, source_system_flow_file_id): + @details.setter + def details(self, details): """ - Sets the source_system_flow_file_id of this ProvenanceEventDTO. - The source system flowfile id. + Sets the details of this ProvenanceEventDTO. + The event details. - :param source_system_flow_file_id: The source_system_flow_file_id of this ProvenanceEventDTO. + :param details: The details of this ProvenanceEventDTO. :type: str """ - self._source_system_flow_file_id = source_system_flow_file_id + self._details = details @property - def alternate_identifier_uri(self): + def event_duration(self): """ - Gets the alternate_identifier_uri of this ProvenanceEventDTO. - The alternate identifier uri for the fileflow for the event. + Gets the event_duration of this ProvenanceEventDTO. + The event duration in milliseconds. - :return: The alternate_identifier_uri of this ProvenanceEventDTO. - :rtype: str + :return: The event_duration of this ProvenanceEventDTO. + :rtype: int """ - return self._alternate_identifier_uri + return self._event_duration - @alternate_identifier_uri.setter - def alternate_identifier_uri(self, alternate_identifier_uri): + @event_duration.setter + def event_duration(self, event_duration): """ - Sets the alternate_identifier_uri of this ProvenanceEventDTO. - The alternate identifier uri for the fileflow for the event. + Sets the event_duration of this ProvenanceEventDTO. + The event duration in milliseconds. - :param alternate_identifier_uri: The alternate_identifier_uri of this ProvenanceEventDTO. - :type: str + :param event_duration: The event_duration of this ProvenanceEventDTO. + :type: int """ - self._alternate_identifier_uri = alternate_identifier_uri + self._event_duration = event_duration @property - def attributes(self): + def event_id(self): """ - Gets the attributes of this ProvenanceEventDTO. - The attributes of the flowfile for the event. + Gets the event_id of this ProvenanceEventDTO. + The event id. This is a one up number thats unique per node. - :return: The attributes of this ProvenanceEventDTO. - :rtype: list[AttributeDTO] + :return: The event_id of this ProvenanceEventDTO. + :rtype: int """ - return self._attributes + return self._event_id - @attributes.setter - def attributes(self, attributes): + @event_id.setter + def event_id(self, event_id): """ - Sets the attributes of this ProvenanceEventDTO. - The attributes of the flowfile for the event. + Sets the event_id of this ProvenanceEventDTO. + The event id. This is a one up number thats unique per node. - :param attributes: The attributes of this ProvenanceEventDTO. - :type: list[AttributeDTO] + :param event_id: The event_id of this ProvenanceEventDTO. + :type: int """ - self._attributes = attributes + self._event_id = event_id @property - def parent_uuids(self): + def event_time(self): """ - Gets the parent_uuids of this ProvenanceEventDTO. - The parent uuids for the event. + Gets the event_time of this ProvenanceEventDTO. + The timestamp of the event. - :return: The parent_uuids of this ProvenanceEventDTO. - :rtype: list[str] + :return: The event_time of this ProvenanceEventDTO. + :rtype: str """ - return self._parent_uuids + return self._event_time - @parent_uuids.setter - def parent_uuids(self, parent_uuids): + @event_time.setter + def event_time(self, event_time): """ - Sets the parent_uuids of this ProvenanceEventDTO. - The parent uuids for the event. + Sets the event_time of this ProvenanceEventDTO. + The timestamp of the event. - :param parent_uuids: The parent_uuids of this ProvenanceEventDTO. - :type: list[str] + :param event_time: The event_time of this ProvenanceEventDTO. + :type: str """ - self._parent_uuids = parent_uuids + self._event_time = event_time @property - def child_uuids(self): + def event_type(self): """ - Gets the child_uuids of this ProvenanceEventDTO. - The child uuids for the event. + Gets the event_type of this ProvenanceEventDTO. + The type of the event. - :return: The child_uuids of this ProvenanceEventDTO. - :rtype: list[str] + :return: The event_type of this ProvenanceEventDTO. + :rtype: str """ - return self._child_uuids + return self._event_type - @child_uuids.setter - def child_uuids(self, child_uuids): + @event_type.setter + def event_type(self, event_type): """ - Sets the child_uuids of this ProvenanceEventDTO. - The child uuids for the event. + Sets the event_type of this ProvenanceEventDTO. + The type of the event. - :param child_uuids: The child_uuids of this ProvenanceEventDTO. - :type: list[str] + :param event_type: The event_type of this ProvenanceEventDTO. + :type: str """ - self._child_uuids = child_uuids + self._event_type = event_type @property - def transit_uri(self): + def file_size(self): """ - Gets the transit_uri of this ProvenanceEventDTO. - The source/destination system uri if the event was a RECEIVE/SEND. + Gets the file_size of this ProvenanceEventDTO. + The size of the flowfile for the event. - :return: The transit_uri of this ProvenanceEventDTO. + :return: The file_size of this ProvenanceEventDTO. :rtype: str """ - return self._transit_uri + return self._file_size - @transit_uri.setter - def transit_uri(self, transit_uri): + @file_size.setter + def file_size(self, file_size): """ - Sets the transit_uri of this ProvenanceEventDTO. - The source/destination system uri if the event was a RECEIVE/SEND. + Sets the file_size of this ProvenanceEventDTO. + The size of the flowfile for the event. - :param transit_uri: The transit_uri of this ProvenanceEventDTO. + :param file_size: The file_size of this ProvenanceEventDTO. :type: str """ - self._transit_uri = transit_uri + self._file_size = file_size @property - def relationship(self): + def file_size_bytes(self): """ - Gets the relationship of this ProvenanceEventDTO. - The relationship to which the flowfile was routed if the event is of type ROUTE. + Gets the file_size_bytes of this ProvenanceEventDTO. + The size of the flowfile in bytes for the event. - :return: The relationship of this ProvenanceEventDTO. + :return: The file_size_bytes of this ProvenanceEventDTO. + :rtype: int + """ + return self._file_size_bytes + + @file_size_bytes.setter + def file_size_bytes(self, file_size_bytes): + """ + Sets the file_size_bytes of this ProvenanceEventDTO. + The size of the flowfile in bytes for the event. + + :param file_size_bytes: The file_size_bytes of this ProvenanceEventDTO. + :type: int + """ + + self._file_size_bytes = file_size_bytes + + @property + def flow_file_uuid(self): + """ + Gets the flow_file_uuid of this ProvenanceEventDTO. + The uuid of the flowfile for the event. + + :return: The flow_file_uuid of this ProvenanceEventDTO. :rtype: str """ - return self._relationship + return self._flow_file_uuid - @relationship.setter - def relationship(self, relationship): + @flow_file_uuid.setter + def flow_file_uuid(self, flow_file_uuid): """ - Sets the relationship of this ProvenanceEventDTO. - The relationship to which the flowfile was routed if the event is of type ROUTE. + Sets the flow_file_uuid of this ProvenanceEventDTO. + The uuid of the flowfile for the event. - :param relationship: The relationship of this ProvenanceEventDTO. + :param flow_file_uuid: The flow_file_uuid of this ProvenanceEventDTO. :type: str """ - self._relationship = relationship + self._flow_file_uuid = flow_file_uuid @property - def details(self): + def group_id(self): """ - Gets the details of this ProvenanceEventDTO. - The event details. + Gets the group_id of this ProvenanceEventDTO. + The id of the group that the component resides in. If the component is no longer in the flow, the group id will not be set. - :return: The details of this ProvenanceEventDTO. + :return: The group_id of this ProvenanceEventDTO. :rtype: str """ - return self._details + return self._group_id - @details.setter - def details(self, details): + @group_id.setter + def group_id(self, group_id): """ - Sets the details of this ProvenanceEventDTO. - The event details. + Sets the group_id of this ProvenanceEventDTO. + The id of the group that the component resides in. If the component is no longer in the flow, the group id will not be set. - :param details: The details of this ProvenanceEventDTO. + :param group_id: The group_id of this ProvenanceEventDTO. :type: str """ - self._details = details + self._group_id = group_id @property - def content_equal(self): + def id(self): """ - Gets the content_equal of this ProvenanceEventDTO. - Whether the input and output content claim is the same. + Gets the id of this ProvenanceEventDTO. + The event uuid. - :return: The content_equal of this ProvenanceEventDTO. - :rtype: bool + :return: The id of this ProvenanceEventDTO. + :rtype: str """ - return self._content_equal + return self._id - @content_equal.setter - def content_equal(self, content_equal): + @id.setter + def id(self, id): """ - Sets the content_equal of this ProvenanceEventDTO. - Whether the input and output content claim is the same. + Sets the id of this ProvenanceEventDTO. + The event uuid. - :param content_equal: The content_equal of this ProvenanceEventDTO. - :type: bool + :param id: The id of this ProvenanceEventDTO. + :type: str """ - self._content_equal = content_equal + self._id = id @property def input_content_available(self): @@ -821,50 +703,73 @@ def input_content_available(self, input_content_available): self._input_content_available = input_content_available @property - def input_content_claim_section(self): + def input_content_claim_container(self): """ - Gets the input_content_claim_section of this ProvenanceEventDTO. - The section in which the input content claim lives. + Gets the input_content_claim_container of this ProvenanceEventDTO. + The container in which the input content claim lives. - :return: The input_content_claim_section of this ProvenanceEventDTO. + :return: The input_content_claim_container of this ProvenanceEventDTO. :rtype: str """ - return self._input_content_claim_section + return self._input_content_claim_container - @input_content_claim_section.setter - def input_content_claim_section(self, input_content_claim_section): + @input_content_claim_container.setter + def input_content_claim_container(self, input_content_claim_container): """ - Sets the input_content_claim_section of this ProvenanceEventDTO. - The section in which the input content claim lives. + Sets the input_content_claim_container of this ProvenanceEventDTO. + The container in which the input content claim lives. - :param input_content_claim_section: The input_content_claim_section of this ProvenanceEventDTO. + :param input_content_claim_container: The input_content_claim_container of this ProvenanceEventDTO. + :type: str + """ + + self._input_content_claim_container = input_content_claim_container + + @property + def input_content_claim_file_size(self): + """ + Gets the input_content_claim_file_size of this ProvenanceEventDTO. + The file size of the input content claim formatted. + + :return: The input_content_claim_file_size of this ProvenanceEventDTO. + :rtype: str + """ + return self._input_content_claim_file_size + + @input_content_claim_file_size.setter + def input_content_claim_file_size(self, input_content_claim_file_size): + """ + Sets the input_content_claim_file_size of this ProvenanceEventDTO. + The file size of the input content claim formatted. + + :param input_content_claim_file_size: The input_content_claim_file_size of this ProvenanceEventDTO. :type: str """ - self._input_content_claim_section = input_content_claim_section + self._input_content_claim_file_size = input_content_claim_file_size @property - def input_content_claim_container(self): + def input_content_claim_file_size_bytes(self): """ - Gets the input_content_claim_container of this ProvenanceEventDTO. - The container in which the input content claim lives. + Gets the input_content_claim_file_size_bytes of this ProvenanceEventDTO. + The file size of the intput content claim in bytes. - :return: The input_content_claim_container of this ProvenanceEventDTO. - :rtype: str + :return: The input_content_claim_file_size_bytes of this ProvenanceEventDTO. + :rtype: int """ - return self._input_content_claim_container + return self._input_content_claim_file_size_bytes - @input_content_claim_container.setter - def input_content_claim_container(self, input_content_claim_container): + @input_content_claim_file_size_bytes.setter + def input_content_claim_file_size_bytes(self, input_content_claim_file_size_bytes): """ - Sets the input_content_claim_container of this ProvenanceEventDTO. - The container in which the input content claim lives. + Sets the input_content_claim_file_size_bytes of this ProvenanceEventDTO. + The file size of the intput content claim in bytes. - :param input_content_claim_container: The input_content_claim_container of this ProvenanceEventDTO. - :type: str + :param input_content_claim_file_size_bytes: The input_content_claim_file_size_bytes of this ProvenanceEventDTO. + :type: int """ - self._input_content_claim_container = input_content_claim_container + self._input_content_claim_file_size_bytes = input_content_claim_file_size_bytes @property def input_content_claim_identifier(self): @@ -913,50 +818,50 @@ def input_content_claim_offset(self, input_content_claim_offset): self._input_content_claim_offset = input_content_claim_offset @property - def input_content_claim_file_size(self): + def input_content_claim_section(self): """ - Gets the input_content_claim_file_size of this ProvenanceEventDTO. - The file size of the input content claim formatted. + Gets the input_content_claim_section of this ProvenanceEventDTO. + The section in which the input content claim lives. - :return: The input_content_claim_file_size of this ProvenanceEventDTO. + :return: The input_content_claim_section of this ProvenanceEventDTO. :rtype: str """ - return self._input_content_claim_file_size + return self._input_content_claim_section - @input_content_claim_file_size.setter - def input_content_claim_file_size(self, input_content_claim_file_size): + @input_content_claim_section.setter + def input_content_claim_section(self, input_content_claim_section): """ - Sets the input_content_claim_file_size of this ProvenanceEventDTO. - The file size of the input content claim formatted. + Sets the input_content_claim_section of this ProvenanceEventDTO. + The section in which the input content claim lives. - :param input_content_claim_file_size: The input_content_claim_file_size of this ProvenanceEventDTO. + :param input_content_claim_section: The input_content_claim_section of this ProvenanceEventDTO. :type: str """ - self._input_content_claim_file_size = input_content_claim_file_size + self._input_content_claim_section = input_content_claim_section @property - def input_content_claim_file_size_bytes(self): + def lineage_duration(self): """ - Gets the input_content_claim_file_size_bytes of this ProvenanceEventDTO. - The file size of the intput content claim in bytes. + Gets the lineage_duration of this ProvenanceEventDTO. + The duration since the lineage began, in milliseconds. - :return: The input_content_claim_file_size_bytes of this ProvenanceEventDTO. + :return: The lineage_duration of this ProvenanceEventDTO. :rtype: int """ - return self._input_content_claim_file_size_bytes + return self._lineage_duration - @input_content_claim_file_size_bytes.setter - def input_content_claim_file_size_bytes(self, input_content_claim_file_size_bytes): + @lineage_duration.setter + def lineage_duration(self, lineage_duration): """ - Sets the input_content_claim_file_size_bytes of this ProvenanceEventDTO. - The file size of the intput content claim in bytes. + Sets the lineage_duration of this ProvenanceEventDTO. + The duration since the lineage began, in milliseconds. - :param input_content_claim_file_size_bytes: The input_content_claim_file_size_bytes of this ProvenanceEventDTO. + :param lineage_duration: The lineage_duration of this ProvenanceEventDTO. :type: int """ - self._input_content_claim_file_size_bytes = input_content_claim_file_size_bytes + self._lineage_duration = lineage_duration @property def output_content_available(self): @@ -982,50 +887,73 @@ def output_content_available(self, output_content_available): self._output_content_available = output_content_available @property - def output_content_claim_section(self): + def output_content_claim_container(self): """ - Gets the output_content_claim_section of this ProvenanceEventDTO. - The section in which the output content claim lives. + Gets the output_content_claim_container of this ProvenanceEventDTO. + The container in which the output content claim lives. - :return: The output_content_claim_section of this ProvenanceEventDTO. + :return: The output_content_claim_container of this ProvenanceEventDTO. :rtype: str """ - return self._output_content_claim_section + return self._output_content_claim_container - @output_content_claim_section.setter - def output_content_claim_section(self, output_content_claim_section): + @output_content_claim_container.setter + def output_content_claim_container(self, output_content_claim_container): """ - Sets the output_content_claim_section of this ProvenanceEventDTO. - The section in which the output content claim lives. + Sets the output_content_claim_container of this ProvenanceEventDTO. + The container in which the output content claim lives. - :param output_content_claim_section: The output_content_claim_section of this ProvenanceEventDTO. + :param output_content_claim_container: The output_content_claim_container of this ProvenanceEventDTO. :type: str """ - self._output_content_claim_section = output_content_claim_section + self._output_content_claim_container = output_content_claim_container @property - def output_content_claim_container(self): + def output_content_claim_file_size(self): """ - Gets the output_content_claim_container of this ProvenanceEventDTO. - The container in which the output content claim lives. + Gets the output_content_claim_file_size of this ProvenanceEventDTO. + The file size of the output content claim formatted. - :return: The output_content_claim_container of this ProvenanceEventDTO. + :return: The output_content_claim_file_size of this ProvenanceEventDTO. :rtype: str """ - return self._output_content_claim_container + return self._output_content_claim_file_size - @output_content_claim_container.setter - def output_content_claim_container(self, output_content_claim_container): + @output_content_claim_file_size.setter + def output_content_claim_file_size(self, output_content_claim_file_size): """ - Sets the output_content_claim_container of this ProvenanceEventDTO. - The container in which the output content claim lives. + Sets the output_content_claim_file_size of this ProvenanceEventDTO. + The file size of the output content claim formatted. - :param output_content_claim_container: The output_content_claim_container of this ProvenanceEventDTO. + :param output_content_claim_file_size: The output_content_claim_file_size of this ProvenanceEventDTO. :type: str """ - self._output_content_claim_container = output_content_claim_container + self._output_content_claim_file_size = output_content_claim_file_size + + @property + def output_content_claim_file_size_bytes(self): + """ + Gets the output_content_claim_file_size_bytes of this ProvenanceEventDTO. + The file size of the output content claim in bytes. + + :return: The output_content_claim_file_size_bytes of this ProvenanceEventDTO. + :rtype: int + """ + return self._output_content_claim_file_size_bytes + + @output_content_claim_file_size_bytes.setter + def output_content_claim_file_size_bytes(self, output_content_claim_file_size_bytes): + """ + Sets the output_content_claim_file_size_bytes of this ProvenanceEventDTO. + The file size of the output content claim in bytes. + + :param output_content_claim_file_size_bytes: The output_content_claim_file_size_bytes of this ProvenanceEventDTO. + :type: int + """ + + self._output_content_claim_file_size_bytes = output_content_claim_file_size_bytes @property def output_content_claim_identifier(self): @@ -1074,50 +1002,73 @@ def output_content_claim_offset(self, output_content_claim_offset): self._output_content_claim_offset = output_content_claim_offset @property - def output_content_claim_file_size(self): + def output_content_claim_section(self): """ - Gets the output_content_claim_file_size of this ProvenanceEventDTO. - The file size of the output content claim formatted. + Gets the output_content_claim_section of this ProvenanceEventDTO. + The section in which the output content claim lives. - :return: The output_content_claim_file_size of this ProvenanceEventDTO. + :return: The output_content_claim_section of this ProvenanceEventDTO. :rtype: str """ - return self._output_content_claim_file_size + return self._output_content_claim_section - @output_content_claim_file_size.setter - def output_content_claim_file_size(self, output_content_claim_file_size): + @output_content_claim_section.setter + def output_content_claim_section(self, output_content_claim_section): """ - Sets the output_content_claim_file_size of this ProvenanceEventDTO. - The file size of the output content claim formatted. + Sets the output_content_claim_section of this ProvenanceEventDTO. + The section in which the output content claim lives. - :param output_content_claim_file_size: The output_content_claim_file_size of this ProvenanceEventDTO. + :param output_content_claim_section: The output_content_claim_section of this ProvenanceEventDTO. :type: str """ - self._output_content_claim_file_size = output_content_claim_file_size + self._output_content_claim_section = output_content_claim_section @property - def output_content_claim_file_size_bytes(self): + def parent_uuids(self): """ - Gets the output_content_claim_file_size_bytes of this ProvenanceEventDTO. - The file size of the output content claim in bytes. + Gets the parent_uuids of this ProvenanceEventDTO. + The parent uuids for the event. - :return: The output_content_claim_file_size_bytes of this ProvenanceEventDTO. - :rtype: int + :return: The parent_uuids of this ProvenanceEventDTO. + :rtype: list[str] """ - return self._output_content_claim_file_size_bytes + return self._parent_uuids - @output_content_claim_file_size_bytes.setter - def output_content_claim_file_size_bytes(self, output_content_claim_file_size_bytes): + @parent_uuids.setter + def parent_uuids(self, parent_uuids): """ - Sets the output_content_claim_file_size_bytes of this ProvenanceEventDTO. - The file size of the output content claim in bytes. + Sets the parent_uuids of this ProvenanceEventDTO. + The parent uuids for the event. - :param output_content_claim_file_size_bytes: The output_content_claim_file_size_bytes of this ProvenanceEventDTO. - :type: int + :param parent_uuids: The parent_uuids of this ProvenanceEventDTO. + :type: list[str] """ - self._output_content_claim_file_size_bytes = output_content_claim_file_size_bytes + self._parent_uuids = parent_uuids + + @property + def relationship(self): + """ + Gets the relationship of this ProvenanceEventDTO. + The relationship to which the flowfile was routed if the event is of type ROUTE. + + :return: The relationship of this ProvenanceEventDTO. + :rtype: str + """ + return self._relationship + + @relationship.setter + def relationship(self, relationship): + """ + Sets the relationship of this ProvenanceEventDTO. + The relationship to which the flowfile was routed if the event is of type ROUTE. + + :param relationship: The relationship of this ProvenanceEventDTO. + :type: str + """ + + self._relationship = relationship @property def replay_available(self): @@ -1188,6 +1139,52 @@ def source_connection_identifier(self, source_connection_identifier): self._source_connection_identifier = source_connection_identifier + @property + def source_system_flow_file_id(self): + """ + Gets the source_system_flow_file_id of this ProvenanceEventDTO. + The source system flowfile id. + + :return: The source_system_flow_file_id of this ProvenanceEventDTO. + :rtype: str + """ + return self._source_system_flow_file_id + + @source_system_flow_file_id.setter + def source_system_flow_file_id(self, source_system_flow_file_id): + """ + Sets the source_system_flow_file_id of this ProvenanceEventDTO. + The source system flowfile id. + + :param source_system_flow_file_id: The source_system_flow_file_id of this ProvenanceEventDTO. + :type: str + """ + + self._source_system_flow_file_id = source_system_flow_file_id + + @property + def transit_uri(self): + """ + Gets the transit_uri of this ProvenanceEventDTO. + The source/destination system uri if the event was a RECEIVE/SEND. + + :return: The transit_uri of this ProvenanceEventDTO. + :rtype: str + """ + return self._transit_uri + + @transit_uri.setter + def transit_uri(self, transit_uri): + """ + Sets the transit_uri of this ProvenanceEventDTO. + The source/destination system uri if the event was a RECEIVE/SEND. + + :param transit_uri: The transit_uri of this ProvenanceEventDTO. + :type: str + """ + + self._transit_uri = transit_uri + def to_dict(self): """ Returns the model properties as a dict diff --git a/nipyapi/nifi/models/provenance_event_entity.py b/nipyapi/nifi/models/provenance_event_entity.py index e26cec8c..3b9d194f 100644 --- a/nipyapi/nifi/models/provenance_event_entity.py +++ b/nipyapi/nifi/models/provenance_event_entity.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,12 +27,10 @@ class ProvenanceEventEntity(object): and the value is json key in definition. """ swagger_types = { - 'provenance_event': 'ProvenanceEventDTO' - } + 'provenance_event': 'ProvenanceEventDTO' } attribute_map = { - 'provenance_event': 'provenanceEvent' - } + 'provenance_event': 'provenanceEvent' } def __init__(self, provenance_event=None): """ diff --git a/nipyapi/nifi/models/provenance_link_dto.py b/nipyapi/nifi/models/provenance_link_dto.py index bdd35fa9..4b025b9a 100644 --- a/nipyapi/nifi/models/provenance_link_dto.py +++ b/nipyapi/nifi/models/provenance_link_dto.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,42 +27,86 @@ class ProvenanceLinkDTO(object): and the value is json key in definition. """ swagger_types = { - 'source_id': 'str', - 'target_id': 'str', 'flow_file_uuid': 'str', - 'timestamp': 'str', - 'millis': 'int' - } +'millis': 'int', +'source_id': 'str', +'target_id': 'str', +'timestamp': 'str' } attribute_map = { - 'source_id': 'sourceId', - 'target_id': 'targetId', 'flow_file_uuid': 'flowFileUuid', - 'timestamp': 'timestamp', - 'millis': 'millis' - } +'millis': 'millis', +'source_id': 'sourceId', +'target_id': 'targetId', +'timestamp': 'timestamp' } - def __init__(self, source_id=None, target_id=None, flow_file_uuid=None, timestamp=None, millis=None): + def __init__(self, flow_file_uuid=None, millis=None, source_id=None, target_id=None, timestamp=None): """ ProvenanceLinkDTO - a model defined in Swagger """ + self._flow_file_uuid = None + self._millis = None self._source_id = None self._target_id = None - self._flow_file_uuid = None self._timestamp = None - self._millis = None + if flow_file_uuid is not None: + self.flow_file_uuid = flow_file_uuid + if millis is not None: + self.millis = millis if source_id is not None: self.source_id = source_id if target_id is not None: self.target_id = target_id - if flow_file_uuid is not None: - self.flow_file_uuid = flow_file_uuid if timestamp is not None: self.timestamp = timestamp - if millis is not None: - self.millis = millis + + @property + def flow_file_uuid(self): + """ + Gets the flow_file_uuid of this ProvenanceLinkDTO. + The flowfile uuid that traversed the link. + + :return: The flow_file_uuid of this ProvenanceLinkDTO. + :rtype: str + """ + return self._flow_file_uuid + + @flow_file_uuid.setter + def flow_file_uuid(self, flow_file_uuid): + """ + Sets the flow_file_uuid of this ProvenanceLinkDTO. + The flowfile uuid that traversed the link. + + :param flow_file_uuid: The flow_file_uuid of this ProvenanceLinkDTO. + :type: str + """ + + self._flow_file_uuid = flow_file_uuid + + @property + def millis(self): + """ + Gets the millis of this ProvenanceLinkDTO. + The timestamp of this link in milliseconds. + + :return: The millis of this ProvenanceLinkDTO. + :rtype: int + """ + return self._millis + + @millis.setter + def millis(self, millis): + """ + Sets the millis of this ProvenanceLinkDTO. + The timestamp of this link in milliseconds. + + :param millis: The millis of this ProvenanceLinkDTO. + :type: int + """ + + self._millis = millis @property def source_id(self): @@ -111,29 +154,6 @@ def target_id(self, target_id): self._target_id = target_id - @property - def flow_file_uuid(self): - """ - Gets the flow_file_uuid of this ProvenanceLinkDTO. - The flowfile uuid that traversed the link. - - :return: The flow_file_uuid of this ProvenanceLinkDTO. - :rtype: str - """ - return self._flow_file_uuid - - @flow_file_uuid.setter - def flow_file_uuid(self, flow_file_uuid): - """ - Sets the flow_file_uuid of this ProvenanceLinkDTO. - The flowfile uuid that traversed the link. - - :param flow_file_uuid: The flow_file_uuid of this ProvenanceLinkDTO. - :type: str - """ - - self._flow_file_uuid = flow_file_uuid - @property def timestamp(self): """ @@ -157,29 +177,6 @@ def timestamp(self, timestamp): self._timestamp = timestamp - @property - def millis(self): - """ - Gets the millis of this ProvenanceLinkDTO. - The timestamp of this link in milliseconds. - - :return: The millis of this ProvenanceLinkDTO. - :rtype: int - """ - return self._millis - - @millis.setter - def millis(self, millis): - """ - Sets the millis of this ProvenanceLinkDTO. - The timestamp of this link in milliseconds. - - :param millis: The millis of this ProvenanceLinkDTO. - :type: int - """ - - self._millis = millis - def to_dict(self): """ Returns the model properties as a dict diff --git a/nipyapi/nifi/models/provenance_node_dto.py b/nipyapi/nifi/models/provenance_node_dto.py index c79d1472..a2e527e5 100644 --- a/nipyapi/nifi/models/provenance_node_dto.py +++ b/nipyapi/nifi/models/provenance_node_dto.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,131 +27,60 @@ class ProvenanceNodeDTO(object): and the value is json key in definition. """ swagger_types = { - 'id': 'str', - 'flow_file_uuid': 'str', - 'parent_uuids': 'list[str]', 'child_uuids': 'list[str]', - 'cluster_node_identifier': 'str', - 'type': 'str', - 'event_type': 'str', - 'millis': 'int', - 'timestamp': 'str' - } +'cluster_node_identifier': 'str', +'event_type': 'str', +'flow_file_uuid': 'str', +'id': 'str', +'millis': 'int', +'parent_uuids': 'list[str]', +'timestamp': 'str', +'type': 'str' } attribute_map = { - 'id': 'id', - 'flow_file_uuid': 'flowFileUuid', - 'parent_uuids': 'parentUuids', 'child_uuids': 'childUuids', - 'cluster_node_identifier': 'clusterNodeIdentifier', - 'type': 'type', - 'event_type': 'eventType', - 'millis': 'millis', - 'timestamp': 'timestamp' - } +'cluster_node_identifier': 'clusterNodeIdentifier', +'event_type': 'eventType', +'flow_file_uuid': 'flowFileUuid', +'id': 'id', +'millis': 'millis', +'parent_uuids': 'parentUuids', +'timestamp': 'timestamp', +'type': 'type' } - def __init__(self, id=None, flow_file_uuid=None, parent_uuids=None, child_uuids=None, cluster_node_identifier=None, type=None, event_type=None, millis=None, timestamp=None): + def __init__(self, child_uuids=None, cluster_node_identifier=None, event_type=None, flow_file_uuid=None, id=None, millis=None, parent_uuids=None, timestamp=None, type=None): """ ProvenanceNodeDTO - a model defined in Swagger """ - self._id = None - self._flow_file_uuid = None - self._parent_uuids = None self._child_uuids = None self._cluster_node_identifier = None - self._type = None self._event_type = None + self._flow_file_uuid = None + self._id = None self._millis = None + self._parent_uuids = None self._timestamp = None + self._type = None - if id is not None: - self.id = id - if flow_file_uuid is not None: - self.flow_file_uuid = flow_file_uuid - if parent_uuids is not None: - self.parent_uuids = parent_uuids if child_uuids is not None: self.child_uuids = child_uuids if cluster_node_identifier is not None: self.cluster_node_identifier = cluster_node_identifier - if type is not None: - self.type = type if event_type is not None: self.event_type = event_type + if flow_file_uuid is not None: + self.flow_file_uuid = flow_file_uuid + if id is not None: + self.id = id if millis is not None: self.millis = millis + if parent_uuids is not None: + self.parent_uuids = parent_uuids if timestamp is not None: self.timestamp = timestamp - - @property - def id(self): - """ - Gets the id of this ProvenanceNodeDTO. - The id of the node. - - :return: The id of this ProvenanceNodeDTO. - :rtype: str - """ - return self._id - - @id.setter - def id(self, id): - """ - Sets the id of this ProvenanceNodeDTO. - The id of the node. - - :param id: The id of this ProvenanceNodeDTO. - :type: str - """ - - self._id = id - - @property - def flow_file_uuid(self): - """ - Gets the flow_file_uuid of this ProvenanceNodeDTO. - The uuid of the flowfile associated with the provenance event. - - :return: The flow_file_uuid of this ProvenanceNodeDTO. - :rtype: str - """ - return self._flow_file_uuid - - @flow_file_uuid.setter - def flow_file_uuid(self, flow_file_uuid): - """ - Sets the flow_file_uuid of this ProvenanceNodeDTO. - The uuid of the flowfile associated with the provenance event. - - :param flow_file_uuid: The flow_file_uuid of this ProvenanceNodeDTO. - :type: str - """ - - self._flow_file_uuid = flow_file_uuid - - @property - def parent_uuids(self): - """ - Gets the parent_uuids of this ProvenanceNodeDTO. - The uuid of the parent flowfiles of the provenance event. - - :return: The parent_uuids of this ProvenanceNodeDTO. - :rtype: list[str] - """ - return self._parent_uuids - - @parent_uuids.setter - def parent_uuids(self, parent_uuids): - """ - Sets the parent_uuids of this ProvenanceNodeDTO. - The uuid of the parent flowfiles of the provenance event. - - :param parent_uuids: The parent_uuids of this ProvenanceNodeDTO. - :type: list[str] - """ - - self._parent_uuids = parent_uuids + if type is not None: + self.type = type @property def child_uuids(self): @@ -201,56 +129,73 @@ def cluster_node_identifier(self, cluster_node_identifier): self._cluster_node_identifier = cluster_node_identifier @property - def type(self): + def event_type(self): """ - Gets the type of this ProvenanceNodeDTO. - The type of the node. + Gets the event_type of this ProvenanceNodeDTO. + If the type is EVENT, this is the type of event. - :return: The type of this ProvenanceNodeDTO. + :return: The event_type of this ProvenanceNodeDTO. :rtype: str """ - return self._type + return self._event_type - @type.setter - def type(self, type): + @event_type.setter + def event_type(self, event_type): """ - Sets the type of this ProvenanceNodeDTO. - The type of the node. + Sets the event_type of this ProvenanceNodeDTO. + If the type is EVENT, this is the type of event. - :param type: The type of this ProvenanceNodeDTO. + :param event_type: The event_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) - ) - self._type = type + self._event_type = event_type @property - def event_type(self): + def flow_file_uuid(self): """ - Gets the event_type of this ProvenanceNodeDTO. - If the type is EVENT, this is the type of event. + Gets the flow_file_uuid of this ProvenanceNodeDTO. + The uuid of the flowfile associated with the provenance event. - :return: The event_type of this ProvenanceNodeDTO. + :return: The flow_file_uuid of this ProvenanceNodeDTO. :rtype: str """ - return self._event_type + return self._flow_file_uuid - @event_type.setter - def event_type(self, event_type): + @flow_file_uuid.setter + def flow_file_uuid(self, flow_file_uuid): """ - Sets the event_type of this ProvenanceNodeDTO. - If the type is EVENT, this is the type of event. + Sets the flow_file_uuid of this ProvenanceNodeDTO. + The uuid of the flowfile associated with the provenance event. - :param event_type: The event_type of this ProvenanceNodeDTO. + :param flow_file_uuid: The flow_file_uuid of this ProvenanceNodeDTO. :type: str """ - self._event_type = event_type + self._flow_file_uuid = flow_file_uuid + + @property + def id(self): + """ + Gets the id of this ProvenanceNodeDTO. + The id of the node. + + :return: The id of this ProvenanceNodeDTO. + :rtype: str + """ + return self._id + + @id.setter + def id(self, id): + """ + Sets the id of this ProvenanceNodeDTO. + The id of the node. + + :param id: The id of this ProvenanceNodeDTO. + :type: str + """ + + self._id = id @property def millis(self): @@ -275,6 +220,29 @@ def millis(self, millis): self._millis = millis + @property + def parent_uuids(self): + """ + Gets the parent_uuids of this ProvenanceNodeDTO. + The uuid of the parent flowfiles of the provenance event. + + :return: The parent_uuids of this ProvenanceNodeDTO. + :rtype: list[str] + """ + return self._parent_uuids + + @parent_uuids.setter + def parent_uuids(self, parent_uuids): + """ + Sets the parent_uuids of this ProvenanceNodeDTO. + The uuid of the parent flowfiles of the provenance event. + + :param parent_uuids: The parent_uuids of this ProvenanceNodeDTO. + :type: list[str] + """ + + self._parent_uuids = parent_uuids + @property def timestamp(self): """ @@ -298,6 +266,35 @@ def timestamp(self, timestamp): self._timestamp = timestamp + @property + def type(self): + """ + Gets the type of this ProvenanceNodeDTO. + The type of the node. + + :return: The type of this ProvenanceNodeDTO. + :rtype: str + """ + return self._type + + @type.setter + def type(self, type): + """ + Sets the type of this ProvenanceNodeDTO. + The type of the node. + + :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) + ) + + self._type = type + def to_dict(self): """ Returns the model properties as a dict diff --git a/nipyapi/nifi/models/provenance_options_dto.py b/nipyapi/nifi/models/provenance_options_dto.py index a343c196..541e6cd5 100644 --- a/nipyapi/nifi/models/provenance_options_dto.py +++ b/nipyapi/nifi/models/provenance_options_dto.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,12 +27,10 @@ class ProvenanceOptionsDTO(object): and the value is json key in definition. """ swagger_types = { - 'searchable_fields': 'list[ProvenanceSearchableFieldDTO]' - } + 'searchable_fields': 'list[ProvenanceSearchableFieldDTO]' } attribute_map = { - 'searchable_fields': 'searchableFields' - } + 'searchable_fields': 'searchableFields' } def __init__(self, searchable_fields=None): """ diff --git a/nipyapi/nifi/models/provenance_options_entity.py b/nipyapi/nifi/models/provenance_options_entity.py index ea353c0a..4bb257a9 100644 --- a/nipyapi/nifi/models/provenance_options_entity.py +++ b/nipyapi/nifi/models/provenance_options_entity.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,12 +27,10 @@ class ProvenanceOptionsEntity(object): and the value is json key in definition. """ swagger_types = { - 'provenance_options': 'ProvenanceOptionsDTO' - } + 'provenance_options': 'ProvenanceOptionsDTO' } attribute_map = { - 'provenance_options': 'provenanceOptions' - } + 'provenance_options': 'provenanceOptions' } def __init__(self, provenance_options=None): """ diff --git a/nipyapi/nifi/models/provenance_request_dto.py b/nipyapi/nifi/models/provenance_request_dto.py index a57faa62..b407a1dd 100644 --- a/nipyapi/nifi/models/provenance_request_dto.py +++ b/nipyapi/nifi/models/provenance_request_dto.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,85 +27,60 @@ class ProvenanceRequestDTO(object): and the value is json key in definition. """ swagger_types = { - 'search_terms': 'dict(str, ProvenanceSearchValueDTO)', 'cluster_node_id': 'str', - 'start_date': 'str', - 'end_date': 'str', - 'minimum_file_size': 'str', - 'maximum_file_size': 'str', - 'max_results': 'int', - 'summarize': 'bool', - 'incremental_results': 'bool' - } +'end_date': 'str', +'incremental_results': 'bool', +'max_results': 'int', +'maximum_file_size': 'str', +'minimum_file_size': 'str', +'search_terms': 'dict(str, ProvenanceSearchValueDTO)', +'start_date': 'str', +'summarize': 'bool' } attribute_map = { - 'search_terms': 'searchTerms', 'cluster_node_id': 'clusterNodeId', - 'start_date': 'startDate', - 'end_date': 'endDate', - 'minimum_file_size': 'minimumFileSize', - 'maximum_file_size': 'maximumFileSize', - 'max_results': 'maxResults', - 'summarize': 'summarize', - 'incremental_results': 'incrementalResults' - } +'end_date': 'endDate', +'incremental_results': 'incrementalResults', +'max_results': 'maxResults', +'maximum_file_size': 'maximumFileSize', +'minimum_file_size': 'minimumFileSize', +'search_terms': 'searchTerms', +'start_date': 'startDate', +'summarize': 'summarize' } - def __init__(self, search_terms=None, cluster_node_id=None, start_date=None, end_date=None, minimum_file_size=None, maximum_file_size=None, max_results=None, summarize=None, incremental_results=None): + def __init__(self, cluster_node_id=None, end_date=None, incremental_results=None, max_results=None, maximum_file_size=None, minimum_file_size=None, search_terms=None, start_date=None, summarize=None): """ ProvenanceRequestDTO - a model defined in Swagger """ - self._search_terms = None self._cluster_node_id = None - self._start_date = None self._end_date = None - self._minimum_file_size = None - self._maximum_file_size = None + self._incremental_results = None self._max_results = None + self._maximum_file_size = None + self._minimum_file_size = None + self._search_terms = None + self._start_date = None self._summarize = None - self._incremental_results = None - if search_terms is not None: - self.search_terms = search_terms if cluster_node_id is not None: self.cluster_node_id = cluster_node_id - if start_date is not None: - self.start_date = start_date if end_date is not None: self.end_date = end_date - if minimum_file_size is not None: - self.minimum_file_size = minimum_file_size - if maximum_file_size is not None: - self.maximum_file_size = maximum_file_size + if incremental_results is not None: + self.incremental_results = incremental_results if max_results is not None: self.max_results = max_results + if maximum_file_size is not None: + self.maximum_file_size = maximum_file_size + if minimum_file_size is not None: + self.minimum_file_size = minimum_file_size + if search_terms is not None: + self.search_terms = search_terms + if start_date is not None: + self.start_date = start_date if summarize is not None: self.summarize = summarize - if incremental_results is not None: - self.incremental_results = incremental_results - - @property - def search_terms(self): - """ - Gets the search_terms of this ProvenanceRequestDTO. - The search terms used to perform the search. - - :return: The search_terms of this ProvenanceRequestDTO. - :rtype: dict(str, ProvenanceSearchValueDTO) - """ - return self._search_terms - - @search_terms.setter - def search_terms(self, search_terms): - """ - Sets the search_terms of this ProvenanceRequestDTO. - The search terms used to perform the search. - - :param search_terms: The search_terms of this ProvenanceRequestDTO. - :type: dict(str, ProvenanceSearchValueDTO) - """ - - self._search_terms = search_terms @property def cluster_node_id(self): @@ -132,50 +106,96 @@ def cluster_node_id(self, cluster_node_id): self._cluster_node_id = cluster_node_id @property - def start_date(self): + def end_date(self): """ - Gets the start_date of this ProvenanceRequestDTO. - The earliest event time to include in the query. + Gets the end_date of this ProvenanceRequestDTO. + The latest event time to include in the query. - :return: The start_date of this ProvenanceRequestDTO. + :return: The end_date of this ProvenanceRequestDTO. :rtype: str """ - return self._start_date + return self._end_date - @start_date.setter - def start_date(self, start_date): + @end_date.setter + def end_date(self, end_date): """ - Sets the start_date of this ProvenanceRequestDTO. - The earliest event time to include in the query. + Sets the end_date of this ProvenanceRequestDTO. + The latest event time to include in the query. - :param start_date: The start_date of this ProvenanceRequestDTO. + :param end_date: The end_date of this ProvenanceRequestDTO. :type: str """ - self._start_date = start_date + self._end_date = end_date @property - def end_date(self): + def incremental_results(self): """ - Gets the end_date of this ProvenanceRequestDTO. - The latest event time to include in the query. + Gets the incremental_results of this ProvenanceRequestDTO. + Whether or not incremental results are returned. If false, provenance events are only returned once the query completes. This property is true by default. - :return: The end_date of this ProvenanceRequestDTO. + :return: The incremental_results of this ProvenanceRequestDTO. + :rtype: bool + """ + return self._incremental_results + + @incremental_results.setter + def incremental_results(self, incremental_results): + """ + Sets the incremental_results of this ProvenanceRequestDTO. + Whether or not incremental results are returned. If false, provenance events are only returned once the query completes. This property is true by default. + + :param incremental_results: The incremental_results of this ProvenanceRequestDTO. + :type: bool + """ + + self._incremental_results = incremental_results + + @property + def max_results(self): + """ + Gets the max_results of this ProvenanceRequestDTO. + The maximum number of results to include. + + :return: The max_results of this ProvenanceRequestDTO. + :rtype: int + """ + return self._max_results + + @max_results.setter + def max_results(self, max_results): + """ + Sets the max_results of this ProvenanceRequestDTO. + The maximum number of results to include. + + :param max_results: The max_results of this ProvenanceRequestDTO. + :type: int + """ + + self._max_results = max_results + + @property + def maximum_file_size(self): + """ + Gets the maximum_file_size of this ProvenanceRequestDTO. + The maximum file size to include in the query. + + :return: The maximum_file_size of this ProvenanceRequestDTO. :rtype: str """ - return self._end_date + return self._maximum_file_size - @end_date.setter - def end_date(self, end_date): + @maximum_file_size.setter + def maximum_file_size(self, maximum_file_size): """ - Sets the end_date of this ProvenanceRequestDTO. - The latest event time to include in the query. + Sets the maximum_file_size of this ProvenanceRequestDTO. + The maximum file size to include in the query. - :param end_date: The end_date of this ProvenanceRequestDTO. + :param maximum_file_size: The maximum_file_size of this ProvenanceRequestDTO. :type: str """ - self._end_date = end_date + self._maximum_file_size = maximum_file_size @property def minimum_file_size(self): @@ -201,50 +221,50 @@ def minimum_file_size(self, minimum_file_size): self._minimum_file_size = minimum_file_size @property - def maximum_file_size(self): + def search_terms(self): """ - Gets the maximum_file_size of this ProvenanceRequestDTO. - The maximum file size to include in the query. + Gets the search_terms of this ProvenanceRequestDTO. + The search terms used to perform the search. - :return: The maximum_file_size of this ProvenanceRequestDTO. - :rtype: str + :return: The search_terms of this ProvenanceRequestDTO. + :rtype: dict(str, ProvenanceSearchValueDTO) """ - return self._maximum_file_size + return self._search_terms - @maximum_file_size.setter - def maximum_file_size(self, maximum_file_size): + @search_terms.setter + def search_terms(self, search_terms): """ - Sets the maximum_file_size of this ProvenanceRequestDTO. - The maximum file size to include in the query. + Sets the search_terms of this ProvenanceRequestDTO. + The search terms used to perform the search. - :param maximum_file_size: The maximum_file_size of this ProvenanceRequestDTO. - :type: str + :param search_terms: The search_terms of this ProvenanceRequestDTO. + :type: dict(str, ProvenanceSearchValueDTO) """ - self._maximum_file_size = maximum_file_size + self._search_terms = search_terms @property - def max_results(self): + def start_date(self): """ - Gets the max_results of this ProvenanceRequestDTO. - The maximum number of results to include. + Gets the start_date of this ProvenanceRequestDTO. + The earliest event time to include in the query. - :return: The max_results of this ProvenanceRequestDTO. - :rtype: int + :return: The start_date of this ProvenanceRequestDTO. + :rtype: str """ - return self._max_results + return self._start_date - @max_results.setter - def max_results(self, max_results): + @start_date.setter + def start_date(self, start_date): """ - Sets the max_results of this ProvenanceRequestDTO. - The maximum number of results to include. + Sets the start_date of this ProvenanceRequestDTO. + The earliest event time to include in the query. - :param max_results: The max_results of this ProvenanceRequestDTO. - :type: int + :param start_date: The start_date of this ProvenanceRequestDTO. + :type: str """ - self._max_results = max_results + self._start_date = start_date @property def summarize(self): @@ -269,29 +289,6 @@ def summarize(self, summarize): self._summarize = summarize - @property - def incremental_results(self): - """ - Gets the incremental_results of this ProvenanceRequestDTO. - Whether or not incremental results are returned. If false, provenance events are only returned once the query completes. This property is true by default. - - :return: The incremental_results of this ProvenanceRequestDTO. - :rtype: bool - """ - return self._incremental_results - - @incremental_results.setter - def incremental_results(self, incremental_results): - """ - Sets the incremental_results of this ProvenanceRequestDTO. - Whether or not incremental results are returned. If false, provenance events are only returned once the query completes. This property is true by default. - - :param incremental_results: The incremental_results of this ProvenanceRequestDTO. - :type: bool - """ - - self._incremental_results = incremental_results - def to_dict(self): """ Returns the model properties as a dict diff --git a/nipyapi/nifi/models/provenance_results_dto.py b/nipyapi/nifi/models/provenance_results_dto.py index f106958e..9f1d36ca 100644 --- a/nipyapi/nifi/models/provenance_results_dto.py +++ b/nipyapi/nifi/models/provenance_results_dto.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,121 +27,73 @@ class ProvenanceResultsDTO(object): and the value is json key in definition. """ swagger_types = { - 'provenance_events': 'list[ProvenanceEventDTO]', - 'total': 'str', - 'total_count': 'int', - 'generated': 'str', - 'oldest_event': 'str', - 'time_offset': 'int', - 'errors': 'list[str]' - } + 'errors': 'list[str]', +'generated': 'str', +'oldest_event': 'str', +'provenance_events': 'list[ProvenanceEventDTO]', +'time_offset': 'int', +'total': 'str', +'total_count': 'int' } attribute_map = { - 'provenance_events': 'provenanceEvents', - 'total': 'total', - 'total_count': 'totalCount', - 'generated': 'generated', - 'oldest_event': 'oldestEvent', - 'time_offset': 'timeOffset', - 'errors': 'errors' - } + 'errors': 'errors', +'generated': 'generated', +'oldest_event': 'oldestEvent', +'provenance_events': 'provenanceEvents', +'time_offset': 'timeOffset', +'total': 'total', +'total_count': 'totalCount' } - def __init__(self, provenance_events=None, total=None, total_count=None, generated=None, oldest_event=None, time_offset=None, errors=None): + def __init__(self, errors=None, generated=None, oldest_event=None, provenance_events=None, time_offset=None, total=None, total_count=None): """ ProvenanceResultsDTO - a model defined in Swagger """ - self._provenance_events = None - self._total = None - self._total_count = None + self._errors = None self._generated = None self._oldest_event = None + self._provenance_events = None self._time_offset = None - self._errors = None + self._total = None + self._total_count = None - if provenance_events is not None: - self.provenance_events = provenance_events - if total is not None: - self.total = total - if total_count is not None: - self.total_count = total_count + if errors is not None: + self.errors = errors if generated is not None: self.generated = generated if oldest_event is not None: self.oldest_event = oldest_event + if provenance_events is not None: + self.provenance_events = provenance_events if time_offset is not None: self.time_offset = time_offset - if errors is not None: - self.errors = errors - - @property - def provenance_events(self): - """ - Gets the provenance_events of this ProvenanceResultsDTO. - The provenance events that matched the search criteria. - - :return: The provenance_events of this ProvenanceResultsDTO. - :rtype: list[ProvenanceEventDTO] - """ - return self._provenance_events - - @provenance_events.setter - def provenance_events(self, provenance_events): - """ - Sets the provenance_events of this ProvenanceResultsDTO. - The provenance events that matched the search criteria. - - :param provenance_events: The provenance_events of this ProvenanceResultsDTO. - :type: list[ProvenanceEventDTO] - """ - - self._provenance_events = provenance_events - - @property - def total(self): - """ - Gets the total of this ProvenanceResultsDTO. - The total number of results formatted. - - :return: The total of this ProvenanceResultsDTO. - :rtype: str - """ - return self._total - - @total.setter - def total(self, total): - """ - Sets the total of this ProvenanceResultsDTO. - The total number of results formatted. - - :param total: The total of this ProvenanceResultsDTO. - :type: str - """ - - self._total = total + if total is not None: + self.total = total + if total_count is not None: + self.total_count = total_count @property - def total_count(self): + def errors(self): """ - Gets the total_count of this ProvenanceResultsDTO. - The total number of results. + Gets the errors of this ProvenanceResultsDTO. + Any errors that occurred while performing the provenance request. - :return: The total_count of this ProvenanceResultsDTO. - :rtype: int + :return: The errors of this ProvenanceResultsDTO. + :rtype: list[str] """ - return self._total_count + return self._errors - @total_count.setter - def total_count(self, total_count): + @errors.setter + def errors(self, errors): """ - Sets the total_count of this ProvenanceResultsDTO. - The total number of results. + Sets the errors of this ProvenanceResultsDTO. + Any errors that occurred while performing the provenance request. - :param total_count: The total_count of this ProvenanceResultsDTO. - :type: int + :param errors: The errors of this ProvenanceResultsDTO. + :type: list[str] """ - self._total_count = total_count + self._errors = errors @property def generated(self): @@ -190,6 +141,29 @@ def oldest_event(self, oldest_event): self._oldest_event = oldest_event + @property + def provenance_events(self): + """ + Gets the provenance_events of this ProvenanceResultsDTO. + The provenance events that matched the search criteria. + + :return: The provenance_events of this ProvenanceResultsDTO. + :rtype: list[ProvenanceEventDTO] + """ + return self._provenance_events + + @provenance_events.setter + def provenance_events(self, provenance_events): + """ + Sets the provenance_events of this ProvenanceResultsDTO. + The provenance events that matched the search criteria. + + :param provenance_events: The provenance_events of this ProvenanceResultsDTO. + :type: list[ProvenanceEventDTO] + """ + + self._provenance_events = provenance_events + @property def time_offset(self): """ @@ -214,27 +188,50 @@ def time_offset(self, time_offset): self._time_offset = time_offset @property - def errors(self): + def total(self): """ - Gets the errors of this ProvenanceResultsDTO. - Any errors that occurred while performing the provenance request. + Gets the total of this ProvenanceResultsDTO. + The total number of results formatted. - :return: The errors of this ProvenanceResultsDTO. - :rtype: list[str] + :return: The total of this ProvenanceResultsDTO. + :rtype: str """ - return self._errors + return self._total - @errors.setter - def errors(self, errors): + @total.setter + def total(self, total): """ - Sets the errors of this ProvenanceResultsDTO. - Any errors that occurred while performing the provenance request. + Sets the total of this ProvenanceResultsDTO. + The total number of results formatted. - :param errors: The errors of this ProvenanceResultsDTO. - :type: list[str] + :param total: The total of this ProvenanceResultsDTO. + :type: str """ - self._errors = errors + self._total = total + + @property + def total_count(self): + """ + Gets the total_count of this ProvenanceResultsDTO. + The total number of results. + + :return: The total_count of this ProvenanceResultsDTO. + :rtype: int + """ + return self._total_count + + @total_count.setter + def total_count(self, total_count): + """ + Sets the total_count of this ProvenanceResultsDTO. + The total number of results. + + :param total_count: The total_count of this ProvenanceResultsDTO. + :type: int + """ + + self._total_count = total_count def to_dict(self): """ diff --git a/nipyapi/nifi/models/provenance_search_value_dto.py b/nipyapi/nifi/models/provenance_search_value_dto.py index 01d0eaa2..f37d5928 100644 --- a/nipyapi/nifi/models/provenance_search_value_dto.py +++ b/nipyapi/nifi/models/provenance_search_value_dto.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,50 +27,25 @@ class ProvenanceSearchValueDTO(object): and the value is json key in definition. """ swagger_types = { - 'value': 'str', - 'inverse': 'bool' - } + 'inverse': 'bool', +'value': 'str' } attribute_map = { - 'value': 'value', - 'inverse': 'inverse' - } + 'inverse': 'inverse', +'value': 'value' } - def __init__(self, value=None, inverse=None): + def __init__(self, inverse=None, value=None): """ ProvenanceSearchValueDTO - a model defined in Swagger """ - self._value = None self._inverse = None + self._value = None - if value is not None: - self.value = value if inverse is not None: self.inverse = inverse - - @property - def value(self): - """ - Gets the value of this ProvenanceSearchValueDTO. - The search value. - - :return: The value of this ProvenanceSearchValueDTO. - :rtype: str - """ - return self._value - - @value.setter - def value(self, value): - """ - Sets the value of this ProvenanceSearchValueDTO. - The search value. - - :param value: The value of this ProvenanceSearchValueDTO. - :type: str - """ - - self._value = value + if value is not None: + self.value = value @property def inverse(self): @@ -96,6 +70,29 @@ def inverse(self, inverse): self._inverse = inverse + @property + def value(self): + """ + Gets the value of this ProvenanceSearchValueDTO. + The search value. + + :return: The value of this ProvenanceSearchValueDTO. + :rtype: str + """ + return self._value + + @value.setter + def value(self, value): + """ + Sets the value of this ProvenanceSearchValueDTO. + The search value. + + :param value: The value of this ProvenanceSearchValueDTO. + :type: str + """ + + self._value = value + def to_dict(self): """ Returns the model properties as a dict diff --git a/nipyapi/nifi/models/provenance_searchable_field_dto.py b/nipyapi/nifi/models/provenance_searchable_field_dto.py index 7f3f65bb..30310cff 100644 --- a/nipyapi/nifi/models/provenance_searchable_field_dto.py +++ b/nipyapi/nifi/models/provenance_searchable_field_dto.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,83 +27,81 @@ class ProvenanceSearchableFieldDTO(object): and the value is json key in definition. """ swagger_types = { - 'id': 'str', 'field': 'str', - 'label': 'str', - 'type': 'str' - } +'id': 'str', +'label': 'str', +'type': 'str' } attribute_map = { - 'id': 'id', 'field': 'field', - 'label': 'label', - 'type': 'type' - } +'id': 'id', +'label': 'label', +'type': 'type' } - def __init__(self, id=None, field=None, label=None, type=None): + def __init__(self, field=None, id=None, label=None, type=None): """ ProvenanceSearchableFieldDTO - a model defined in Swagger """ - self._id = None self._field = None + self._id = None self._label = None self._type = None - if id is not None: - self.id = id if field is not None: self.field = field + if id is not None: + self.id = id if label is not None: self.label = label if type is not None: self.type = type @property - def id(self): + def field(self): """ - Gets the id of this ProvenanceSearchableFieldDTO. - The id of the searchable field. + Gets the field of this ProvenanceSearchableFieldDTO. + The searchable field. - :return: The id of this ProvenanceSearchableFieldDTO. + :return: The field of this ProvenanceSearchableFieldDTO. :rtype: str """ - return self._id + return self._field - @id.setter - def id(self, id): + @field.setter + def field(self, field): """ - Sets the id of this ProvenanceSearchableFieldDTO. - The id of the searchable field. + Sets the field of this ProvenanceSearchableFieldDTO. + The searchable field. - :param id: The id of this ProvenanceSearchableFieldDTO. + :param field: The field of this ProvenanceSearchableFieldDTO. :type: str """ - self._id = id + self._field = field @property - def field(self): + def id(self): """ - Gets the field of this ProvenanceSearchableFieldDTO. - The searchable field. + Gets the id of this ProvenanceSearchableFieldDTO. + The id of the searchable field. - :return: The field of this ProvenanceSearchableFieldDTO. + :return: The id of this ProvenanceSearchableFieldDTO. :rtype: str """ - return self._field + return self._id - @field.setter - def field(self, field): + @id.setter + def id(self, id): """ - Sets the field of this ProvenanceSearchableFieldDTO. - The searchable field. + Sets the id of this ProvenanceSearchableFieldDTO. + The id of the searchable field. - :param field: The field of this ProvenanceSearchableFieldDTO. + :param id: The id of this ProvenanceSearchableFieldDTO. :type: str """ - self._field = field + self._id = id @property def label(self): diff --git a/nipyapi/nifi/models/queue_size_dto.py b/nipyapi/nifi/models/queue_size_dto.py index 041a4ad3..041b50ed 100644 --- a/nipyapi/nifi/models/queue_size_dto.py +++ b/nipyapi/nifi/models/queue_size_dto.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -29,13 +28,11 @@ class QueueSizeDTO(object): """ swagger_types = { 'byte_count': 'int', - 'object_count': 'int' - } +'object_count': 'int' } attribute_map = { 'byte_count': 'byteCount', - 'object_count': 'objectCount' - } +'object_count': 'objectCount' } def __init__(self, byte_count=None, object_count=None): """ diff --git a/nipyapi/nifi/models/registered_flow.py b/nipyapi/nifi/models/registered_flow.py index a24ab790..c152c2fb 100644 --- a/nipyapi/nifi/models/registered_flow.py +++ b/nipyapi/nifi/models/registered_flow.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,61 +27,64 @@ class RegisteredFlow(object): and the value is json key in definition. """ swagger_types = { - 'identifier': 'str', - 'name': 'str', - 'description': 'str', - 'bucket_identifier': 'str', - 'bucket_name': 'str', - 'created_timestamp': 'int', - 'last_modified_timestamp': 'int', - 'permissions': 'FlowRegistryPermissions', - 'version_count': 'int', - 'version_info': 'RegisteredFlowVersionInfo' - } + 'branch': 'str', +'bucket_identifier': 'str', +'bucket_name': 'str', +'created_timestamp': 'int', +'description': 'str', +'identifier': 'str', +'last_modified_timestamp': 'int', +'name': 'str', +'permissions': 'FlowRegistryPermissions', +'version_count': 'int', +'version_info': 'RegisteredFlowVersionInfo' } attribute_map = { - 'identifier': 'identifier', - 'name': 'name', - 'description': 'description', - 'bucket_identifier': 'bucketIdentifier', - 'bucket_name': 'bucketName', - 'created_timestamp': 'createdTimestamp', - 'last_modified_timestamp': 'lastModifiedTimestamp', - 'permissions': 'permissions', - 'version_count': 'versionCount', - 'version_info': 'versionInfo' - } - - def __init__(self, identifier=None, name=None, description=None, bucket_identifier=None, bucket_name=None, created_timestamp=None, last_modified_timestamp=None, permissions=None, version_count=None, version_info=None): + 'branch': 'branch', +'bucket_identifier': 'bucketIdentifier', +'bucket_name': 'bucketName', +'created_timestamp': 'createdTimestamp', +'description': 'description', +'identifier': 'identifier', +'last_modified_timestamp': 'lastModifiedTimestamp', +'name': 'name', +'permissions': 'permissions', +'version_count': 'versionCount', +'version_info': 'versionInfo' } + + def __init__(self, branch=None, bucket_identifier=None, bucket_name=None, created_timestamp=None, description=None, identifier=None, last_modified_timestamp=None, name=None, permissions=None, version_count=None, version_info=None): """ RegisteredFlow - a model defined in Swagger """ - self._identifier = None - self._name = None - self._description = None + self._branch = None self._bucket_identifier = None self._bucket_name = None self._created_timestamp = None + self._description = None + self._identifier = None self._last_modified_timestamp = None + self._name = None self._permissions = None self._version_count = None self._version_info = None - if identifier is not None: - self.identifier = identifier - if name is not None: - self.name = name - if description is not None: - self.description = description + if branch is not None: + self.branch = branch if bucket_identifier is not None: self.bucket_identifier = bucket_identifier if bucket_name is not None: self.bucket_name = bucket_name if created_timestamp is not None: self.created_timestamp = created_timestamp + if description is not None: + self.description = description + if identifier is not None: + self.identifier = identifier if last_modified_timestamp is not None: self.last_modified_timestamp = last_modified_timestamp + if name is not None: + self.name = name if permissions is not None: self.permissions = permissions if version_count is not None: @@ -91,67 +93,25 @@ def __init__(self, identifier=None, name=None, description=None, bucket_identifi self.version_info = version_info @property - def identifier(self): + def branch(self): """ - Gets the identifier of this RegisteredFlow. + Gets the branch of this RegisteredFlow. - :return: The identifier of this RegisteredFlow. + :return: The branch of this RegisteredFlow. :rtype: str """ - return self._identifier + return self._branch - @identifier.setter - def identifier(self, identifier): + @branch.setter + def branch(self, branch): """ - Sets the identifier of this RegisteredFlow. + Sets the branch of this RegisteredFlow. - :param identifier: The identifier of this RegisteredFlow. + :param branch: The branch of this RegisteredFlow. :type: str """ - self._identifier = identifier - - @property - def name(self): - """ - Gets the name of this RegisteredFlow. - - :return: The name of this RegisteredFlow. - :rtype: str - """ - return self._name - - @name.setter - def name(self, name): - """ - Sets the name of this RegisteredFlow. - - :param name: The name of this RegisteredFlow. - :type: str - """ - - self._name = name - - @property - def description(self): - """ - Gets the description of this RegisteredFlow. - - :return: The description of this RegisteredFlow. - :rtype: str - """ - return self._description - - @description.setter - def description(self, description): - """ - Sets the description of this RegisteredFlow. - - :param description: The description of this RegisteredFlow. - :type: str - """ - - self._description = description + self._branch = branch @property def bucket_identifier(self): @@ -216,6 +176,48 @@ def created_timestamp(self, created_timestamp): self._created_timestamp = created_timestamp + @property + def description(self): + """ + Gets the description of this RegisteredFlow. + + :return: The description of this RegisteredFlow. + :rtype: str + """ + return self._description + + @description.setter + def description(self, description): + """ + Sets the description of this RegisteredFlow. + + :param description: The description of this RegisteredFlow. + :type: str + """ + + self._description = description + + @property + def identifier(self): + """ + Gets the identifier of this RegisteredFlow. + + :return: The identifier of this RegisteredFlow. + :rtype: str + """ + return self._identifier + + @identifier.setter + def identifier(self, identifier): + """ + Sets the identifier of this RegisteredFlow. + + :param identifier: The identifier of this RegisteredFlow. + :type: str + """ + + self._identifier = identifier + @property def last_modified_timestamp(self): """ @@ -237,6 +239,27 @@ def last_modified_timestamp(self, last_modified_timestamp): self._last_modified_timestamp = last_modified_timestamp + @property + def name(self): + """ + Gets the name of this RegisteredFlow. + + :return: The name of this RegisteredFlow. + :rtype: str + """ + return self._name + + @name.setter + def name(self, name): + """ + Sets the name of this RegisteredFlow. + + :param name: The name of this RegisteredFlow. + :type: str + """ + + self._name = name + @property def permissions(self): """ diff --git a/nipyapi/nifi/models/registered_flow_snapshot.py b/nipyapi/nifi/models/registered_flow_snapshot.py index 19d462de..23a63412 100644 --- a/nipyapi/nifi/models/registered_flow_snapshot.py +++ b/nipyapi/nifi/models/registered_flow_snapshot.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,83 +27,102 @@ class RegisteredFlowSnapshot(object): and the value is json key in definition. """ swagger_types = { - 'snapshot_metadata': 'RegisteredFlowSnapshotMetadata', - 'flow': 'RegisteredFlow', 'bucket': 'FlowRegistryBucket', - 'flow_contents': 'VersionedProcessGroup', - 'external_controller_services': 'dict(str, ExternalControllerServiceReference)', - 'parameter_contexts': 'dict(str, VersionedParameterContext)', - 'flow_encoding_version': 'str', - 'parameter_providers': 'dict(str, ParameterProviderReference)', - 'latest': 'bool' - } +'external_controller_services': 'dict(str, ExternalControllerServiceReference)', +'flow': 'RegisteredFlow', +'flow_contents': 'VersionedProcessGroup', +'flow_encoding_version': 'str', +'latest': 'bool', +'parameter_contexts': 'dict(str, VersionedParameterContext)', +'parameter_providers': 'dict(str, ParameterProviderReference)', +'snapshot_metadata': 'RegisteredFlowSnapshotMetadata' } attribute_map = { - 'snapshot_metadata': 'snapshotMetadata', - 'flow': 'flow', 'bucket': 'bucket', - 'flow_contents': 'flowContents', - 'external_controller_services': 'externalControllerServices', - 'parameter_contexts': 'parameterContexts', - 'flow_encoding_version': 'flowEncodingVersion', - 'parameter_providers': 'parameterProviders', - 'latest': 'latest' - } +'external_controller_services': 'externalControllerServices', +'flow': 'flow', +'flow_contents': 'flowContents', +'flow_encoding_version': 'flowEncodingVersion', +'latest': 'latest', +'parameter_contexts': 'parameterContexts', +'parameter_providers': 'parameterProviders', +'snapshot_metadata': 'snapshotMetadata' } - def __init__(self, snapshot_metadata=None, flow=None, bucket=None, flow_contents=None, external_controller_services=None, parameter_contexts=None, flow_encoding_version=None, parameter_providers=None, latest=None): + def __init__(self, bucket=None, external_controller_services=None, flow=None, flow_contents=None, flow_encoding_version=None, latest=None, parameter_contexts=None, parameter_providers=None, snapshot_metadata=None): """ RegisteredFlowSnapshot - a model defined in Swagger """ - self._snapshot_metadata = None - self._flow = None self._bucket = None - self._flow_contents = None self._external_controller_services = None - self._parameter_contexts = None + self._flow = None + self._flow_contents = None self._flow_encoding_version = None - self._parameter_providers = None self._latest = None + self._parameter_contexts = None + self._parameter_providers = None + self._snapshot_metadata = None - if snapshot_metadata is not None: - self.snapshot_metadata = snapshot_metadata - if flow is not None: - self.flow = flow if bucket is not None: self.bucket = bucket - if flow_contents is not None: - self.flow_contents = flow_contents if external_controller_services is not None: self.external_controller_services = external_controller_services - if parameter_contexts is not None: - self.parameter_contexts = parameter_contexts + if flow is not None: + self.flow = flow + if flow_contents is not None: + self.flow_contents = flow_contents if flow_encoding_version is not None: self.flow_encoding_version = flow_encoding_version - if parameter_providers is not None: - self.parameter_providers = parameter_providers if latest is not None: self.latest = latest + if parameter_contexts is not None: + self.parameter_contexts = parameter_contexts + if parameter_providers is not None: + self.parameter_providers = parameter_providers + if snapshot_metadata is not None: + self.snapshot_metadata = snapshot_metadata @property - def snapshot_metadata(self): + def bucket(self): """ - Gets the snapshot_metadata of this RegisteredFlowSnapshot. + Gets the bucket of this RegisteredFlowSnapshot. - :return: The snapshot_metadata of this RegisteredFlowSnapshot. - :rtype: RegisteredFlowSnapshotMetadata + :return: The bucket of this RegisteredFlowSnapshot. + :rtype: FlowRegistryBucket """ - return self._snapshot_metadata + return self._bucket - @snapshot_metadata.setter - def snapshot_metadata(self, snapshot_metadata): + @bucket.setter + def bucket(self, bucket): """ - Sets the snapshot_metadata of this RegisteredFlowSnapshot. + Sets the bucket of this RegisteredFlowSnapshot. - :param snapshot_metadata: The snapshot_metadata of this RegisteredFlowSnapshot. - :type: RegisteredFlowSnapshotMetadata + :param bucket: The bucket of this RegisteredFlowSnapshot. + :type: FlowRegistryBucket """ - self._snapshot_metadata = snapshot_metadata + self._bucket = bucket + + @property + def external_controller_services(self): + """ + Gets the external_controller_services of this RegisteredFlowSnapshot. + + :return: The external_controller_services of this RegisteredFlowSnapshot. + :rtype: dict(str, ExternalControllerServiceReference) + """ + return self._external_controller_services + + @external_controller_services.setter + def external_controller_services(self, external_controller_services): + """ + Sets the external_controller_services of this RegisteredFlowSnapshot. + + :param external_controller_services: The external_controller_services of this RegisteredFlowSnapshot. + :type: dict(str, ExternalControllerServiceReference) + """ + + self._external_controller_services = external_controller_services @property def flow(self): @@ -127,27 +145,6 @@ def flow(self, flow): self._flow = flow - @property - def bucket(self): - """ - Gets the bucket of this RegisteredFlowSnapshot. - - :return: The bucket of this RegisteredFlowSnapshot. - :rtype: FlowRegistryBucket - """ - return self._bucket - - @bucket.setter - def bucket(self, bucket): - """ - Sets the bucket of this RegisteredFlowSnapshot. - - :param bucket: The bucket of this RegisteredFlowSnapshot. - :type: FlowRegistryBucket - """ - - self._bucket = bucket - @property def flow_contents(self): """ @@ -170,25 +167,46 @@ def flow_contents(self, flow_contents): self._flow_contents = flow_contents @property - def external_controller_services(self): + def flow_encoding_version(self): """ - Gets the external_controller_services of this RegisteredFlowSnapshot. + Gets the flow_encoding_version of this RegisteredFlowSnapshot. - :return: The external_controller_services of this RegisteredFlowSnapshot. - :rtype: dict(str, ExternalControllerServiceReference) + :return: The flow_encoding_version of this RegisteredFlowSnapshot. + :rtype: str """ - return self._external_controller_services + return self._flow_encoding_version - @external_controller_services.setter - def external_controller_services(self, external_controller_services): + @flow_encoding_version.setter + def flow_encoding_version(self, flow_encoding_version): """ - Sets the external_controller_services of this RegisteredFlowSnapshot. + Sets the flow_encoding_version of this RegisteredFlowSnapshot. - :param external_controller_services: The external_controller_services of this RegisteredFlowSnapshot. - :type: dict(str, ExternalControllerServiceReference) + :param flow_encoding_version: The flow_encoding_version of this RegisteredFlowSnapshot. + :type: str """ - self._external_controller_services = external_controller_services + self._flow_encoding_version = flow_encoding_version + + @property + def latest(self): + """ + Gets the latest of this RegisteredFlowSnapshot. + + :return: The latest of this RegisteredFlowSnapshot. + :rtype: bool + """ + return self._latest + + @latest.setter + def latest(self, latest): + """ + Sets the latest of this RegisteredFlowSnapshot. + + :param latest: The latest of this RegisteredFlowSnapshot. + :type: bool + """ + + self._latest = latest @property def parameter_contexts(self): @@ -211,27 +229,6 @@ def parameter_contexts(self, parameter_contexts): self._parameter_contexts = parameter_contexts - @property - def flow_encoding_version(self): - """ - Gets the flow_encoding_version of this RegisteredFlowSnapshot. - - :return: The flow_encoding_version of this RegisteredFlowSnapshot. - :rtype: str - """ - return self._flow_encoding_version - - @flow_encoding_version.setter - def flow_encoding_version(self, flow_encoding_version): - """ - Sets the flow_encoding_version of this RegisteredFlowSnapshot. - - :param flow_encoding_version: The flow_encoding_version of this RegisteredFlowSnapshot. - :type: str - """ - - self._flow_encoding_version = flow_encoding_version - @property def parameter_providers(self): """ @@ -254,25 +251,25 @@ def parameter_providers(self, parameter_providers): self._parameter_providers = parameter_providers @property - def latest(self): + def snapshot_metadata(self): """ - Gets the latest of this RegisteredFlowSnapshot. + Gets the snapshot_metadata of this RegisteredFlowSnapshot. - :return: The latest of this RegisteredFlowSnapshot. - :rtype: bool + :return: The snapshot_metadata of this RegisteredFlowSnapshot. + :rtype: RegisteredFlowSnapshotMetadata """ - return self._latest + return self._snapshot_metadata - @latest.setter - def latest(self, latest): + @snapshot_metadata.setter + def snapshot_metadata(self, snapshot_metadata): """ - Sets the latest of this RegisteredFlowSnapshot. + Sets the snapshot_metadata of this RegisteredFlowSnapshot. - :param latest: The latest of this RegisteredFlowSnapshot. - :type: bool + :param snapshot_metadata: The snapshot_metadata of this RegisteredFlowSnapshot. + :type: RegisteredFlowSnapshotMetadata """ - self._latest = latest + self._snapshot_metadata = snapshot_metadata def to_dict(self): """ diff --git a/nipyapi/nifi/models/registered_flow_snapshot_metadata.py b/nipyapi/nifi/models/registered_flow_snapshot_metadata.py index e1e07f80..4f9bba5a 100644 --- a/nipyapi/nifi/models/registered_flow_snapshot_metadata.py +++ b/nipyapi/nifi/models/registered_flow_snapshot_metadata.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,47 +27,92 @@ class RegisteredFlowSnapshotMetadata(object): and the value is json key in definition. """ swagger_types = { - 'bucket_identifier': 'str', - 'flow_identifier': 'str', - 'version': 'int', - 'timestamp': 'int', 'author': 'str', - 'comments': 'str' - } +'branch': 'str', +'bucket_identifier': 'str', +'comments': 'str', +'flow_identifier': 'str', +'timestamp': 'int', +'version': 'str' } attribute_map = { - 'bucket_identifier': 'bucketIdentifier', - 'flow_identifier': 'flowIdentifier', - 'version': 'version', - 'timestamp': 'timestamp', 'author': 'author', - 'comments': 'comments' - } +'branch': 'branch', +'bucket_identifier': 'bucketIdentifier', +'comments': 'comments', +'flow_identifier': 'flowIdentifier', +'timestamp': 'timestamp', +'version': 'version' } - def __init__(self, bucket_identifier=None, flow_identifier=None, version=None, timestamp=None, author=None, comments=None): + def __init__(self, author=None, branch=None, bucket_identifier=None, comments=None, flow_identifier=None, timestamp=None, version=None): """ RegisteredFlowSnapshotMetadata - a model defined in Swagger """ + self._author = None + self._branch = None self._bucket_identifier = None + self._comments = None self._flow_identifier = None - self._version = None self._timestamp = None - self._author = None - self._comments = None + self._version = None + if author is not None: + self.author = author + if branch is not None: + self.branch = branch if bucket_identifier is not None: self.bucket_identifier = bucket_identifier + if comments is not None: + self.comments = comments if flow_identifier is not None: self.flow_identifier = flow_identifier - if version is not None: - self.version = version if timestamp is not None: self.timestamp = timestamp - if author is not None: - self.author = author - if comments is not None: - self.comments = comments + if version is not None: + self.version = version + + @property + def author(self): + """ + Gets the author of this RegisteredFlowSnapshotMetadata. + + :return: The author of this RegisteredFlowSnapshotMetadata. + :rtype: str + """ + return self._author + + @author.setter + def author(self, author): + """ + Sets the author of this RegisteredFlowSnapshotMetadata. + + :param author: The author of this RegisteredFlowSnapshotMetadata. + :type: str + """ + + self._author = author + + @property + def branch(self): + """ + Gets the branch of this RegisteredFlowSnapshotMetadata. + + :return: The branch of this RegisteredFlowSnapshotMetadata. + :rtype: str + """ + return self._branch + + @branch.setter + def branch(self, branch): + """ + Sets the branch of this RegisteredFlowSnapshotMetadata. + + :param branch: The branch of this RegisteredFlowSnapshotMetadata. + :type: str + """ + + self._branch = branch @property def bucket_identifier(self): @@ -92,46 +136,46 @@ def bucket_identifier(self, bucket_identifier): self._bucket_identifier = bucket_identifier @property - def flow_identifier(self): + def comments(self): """ - Gets the flow_identifier of this RegisteredFlowSnapshotMetadata. + Gets the comments of this RegisteredFlowSnapshotMetadata. - :return: The flow_identifier of this RegisteredFlowSnapshotMetadata. + :return: The comments of this RegisteredFlowSnapshotMetadata. :rtype: str """ - return self._flow_identifier + return self._comments - @flow_identifier.setter - def flow_identifier(self, flow_identifier): + @comments.setter + def comments(self, comments): """ - Sets the flow_identifier of this RegisteredFlowSnapshotMetadata. + Sets the comments of this RegisteredFlowSnapshotMetadata. - :param flow_identifier: The flow_identifier of this RegisteredFlowSnapshotMetadata. + :param comments: The comments of this RegisteredFlowSnapshotMetadata. :type: str """ - self._flow_identifier = flow_identifier + self._comments = comments @property - def version(self): + def flow_identifier(self): """ - Gets the version of this RegisteredFlowSnapshotMetadata. + Gets the flow_identifier of this RegisteredFlowSnapshotMetadata. - :return: The version of this RegisteredFlowSnapshotMetadata. - :rtype: int + :return: The flow_identifier of this RegisteredFlowSnapshotMetadata. + :rtype: str """ - return self._version + return self._flow_identifier - @version.setter - def version(self, version): + @flow_identifier.setter + def flow_identifier(self, flow_identifier): """ - Sets the version of this RegisteredFlowSnapshotMetadata. + Sets the flow_identifier of this RegisteredFlowSnapshotMetadata. - :param version: The version of this RegisteredFlowSnapshotMetadata. - :type: int + :param flow_identifier: The flow_identifier of this RegisteredFlowSnapshotMetadata. + :type: str """ - self._version = version + self._flow_identifier = flow_identifier @property def timestamp(self): @@ -155,46 +199,25 @@ def timestamp(self, timestamp): self._timestamp = timestamp @property - def author(self): - """ - Gets the author of this RegisteredFlowSnapshotMetadata. - - :return: The author of this RegisteredFlowSnapshotMetadata. - :rtype: str - """ - return self._author - - @author.setter - def author(self, author): - """ - Sets the author of this RegisteredFlowSnapshotMetadata. - - :param author: The author of this RegisteredFlowSnapshotMetadata. - :type: str - """ - - self._author = author - - @property - def comments(self): + def version(self): """ - Gets the comments of this RegisteredFlowSnapshotMetadata. + Gets the version of this RegisteredFlowSnapshotMetadata. - :return: The comments of this RegisteredFlowSnapshotMetadata. + :return: The version of this RegisteredFlowSnapshotMetadata. :rtype: str """ - return self._comments + return self._version - @comments.setter - def comments(self, comments): + @version.setter + def version(self, version): """ - Sets the comments of this RegisteredFlowSnapshotMetadata. + Sets the version of this RegisteredFlowSnapshotMetadata. - :param comments: The comments of this RegisteredFlowSnapshotMetadata. + :param version: The version of this RegisteredFlowSnapshotMetadata. :type: str """ - self._comments = comments + self._version = version def to_dict(self): """ diff --git a/nipyapi/nifi/models/registered_flow_version_info.py b/nipyapi/nifi/models/registered_flow_version_info.py index 6115416c..afd27e87 100644 --- a/nipyapi/nifi/models/registered_flow_version_info.py +++ b/nipyapi/nifi/models/registered_flow_version_info.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,12 +27,10 @@ class RegisteredFlowVersionInfo(object): and the value is json key in definition. """ swagger_types = { - 'version': 'int' - } + 'version': 'int' } attribute_map = { - 'version': 'version' - } + 'version': 'version' } def __init__(self, version=None): """ diff --git a/nipyapi/nifi/models/relationship.py b/nipyapi/nifi/models/relationship.py index 7ffea704..1f584901 100644 --- a/nipyapi/nifi/models/relationship.py +++ b/nipyapi/nifi/models/relationship.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,73 +27,71 @@ class Relationship(object): and the value is json key in definition. """ swagger_types = { - 'name': 'str', - 'description': 'str' - } + 'description': 'str', +'name': 'str' } attribute_map = { - 'name': 'name', - 'description': 'description' - } + 'description': 'description', +'name': 'name' } - def __init__(self, name=None, description=None): + def __init__(self, description=None, name=None): """ Relationship - a model defined in Swagger """ - self._name = None self._description = None + self._name = None - if name is not None: - self.name = name if description is not None: self.description = description + if name is not None: + self.name = name @property - def name(self): + def description(self): """ - Gets the name of this Relationship. - The name of the relationship + Gets the description of this Relationship. + The description of the relationship - :return: The name of this Relationship. + :return: The description of this Relationship. :rtype: str """ - return self._name + return self._description - @name.setter - def name(self, name): + @description.setter + def description(self, description): """ - Sets the name of this Relationship. - The name of the relationship + Sets the description of this Relationship. + The description of the relationship - :param name: The name of this Relationship. + :param description: The description of this Relationship. :type: str """ - self._name = name + self._description = description @property - def description(self): + def name(self): """ - Gets the description of this Relationship. - The description of the relationship + Gets the name of this Relationship. + The name of the relationship - :return: The description of this Relationship. + :return: The name of this Relationship. :rtype: str """ - return self._description + return self._name - @description.setter - def description(self, description): + @name.setter + def name(self, name): """ - Sets the description of this Relationship. - The description of the relationship + Sets the name of this Relationship. + The name of the relationship - :param description: The description of this Relationship. + :param name: The name of this Relationship. :type: str """ - self._description = description + self._name = name def to_dict(self): """ diff --git a/nipyapi/nifi/models/relationship_dto.py b/nipyapi/nifi/models/relationship_dto.py index 89cccbfe..762e3581 100644 --- a/nipyapi/nifi/models/relationship_dto.py +++ b/nipyapi/nifi/models/relationship_dto.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,60 +27,58 @@ class RelationshipDTO(object): and the value is json key in definition. """ swagger_types = { - 'name': 'str', - 'description': 'str', 'auto_terminate': 'bool', - 'retry': 'bool' - } +'description': 'str', +'name': 'str', +'retry': 'bool' } attribute_map = { - 'name': 'name', - 'description': 'description', 'auto_terminate': 'autoTerminate', - 'retry': 'retry' - } +'description': 'description', +'name': 'name', +'retry': 'retry' } - def __init__(self, name=None, description=None, auto_terminate=None, retry=None): + def __init__(self, auto_terminate=None, description=None, name=None, retry=None): """ RelationshipDTO - a model defined in Swagger """ - self._name = None - self._description = None self._auto_terminate = None + self._description = None + self._name = None self._retry = None - if name is not None: - self.name = name - if description is not None: - self.description = description if auto_terminate is not None: self.auto_terminate = auto_terminate + if description is not None: + self.description = description + if name is not None: + self.name = name if retry is not None: self.retry = retry @property - def name(self): + def auto_terminate(self): """ - Gets the name of this RelationshipDTO. - The relationship name. + Gets the auto_terminate of this RelationshipDTO. + Whether or not flowfiles sent to this relationship should auto terminate. - :return: The name of this RelationshipDTO. - :rtype: str + :return: The auto_terminate of this RelationshipDTO. + :rtype: bool """ - return self._name + return self._auto_terminate - @name.setter - def name(self, name): + @auto_terminate.setter + def auto_terminate(self, auto_terminate): """ - Sets the name of this RelationshipDTO. - The relationship name. + Sets the auto_terminate of this RelationshipDTO. + Whether or not flowfiles sent to this relationship should auto terminate. - :param name: The name of this RelationshipDTO. - :type: str + :param auto_terminate: The auto_terminate of this RelationshipDTO. + :type: bool """ - self._name = name + self._auto_terminate = auto_terminate @property def description(self): @@ -107,27 +104,27 @@ def description(self, description): self._description = description @property - def auto_terminate(self): + def name(self): """ - Gets the auto_terminate of this RelationshipDTO. - Whether or not flowfiles sent to this relationship should auto terminate. + Gets the name of this RelationshipDTO. + The relationship name. - :return: The auto_terminate of this RelationshipDTO. - :rtype: bool + :return: The name of this RelationshipDTO. + :rtype: str """ - return self._auto_terminate + return self._name - @auto_terminate.setter - def auto_terminate(self, auto_terminate): + @name.setter + def name(self, name): """ - Sets the auto_terminate of this RelationshipDTO. - Whether or not flowfiles sent to this relationship should auto terminate. + Sets the name of this RelationshipDTO. + The relationship name. - :param auto_terminate: The auto_terminate of this RelationshipDTO. - :type: bool + :param name: The name of this RelationshipDTO. + :type: str """ - self._auto_terminate = auto_terminate + self._name = name @property def retry(self): diff --git a/nipyapi/nifi/models/remote_port_run_status_entity.py b/nipyapi/nifi/models/remote_port_run_status_entity.py index e7470ace..751301c8 100644 --- a/nipyapi/nifi/models/remote_port_run_status_entity.py +++ b/nipyapi/nifi/models/remote_port_run_status_entity.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,38 +27,58 @@ class RemotePortRunStatusEntity(object): and the value is json key in definition. """ swagger_types = { - 'revision': 'RevisionDTO', - 'state': 'str', - 'disconnected_node_acknowledged': 'bool' - } + 'disconnected_node_acknowledged': 'bool', +'revision': 'RevisionDTO', +'state': 'str' } attribute_map = { - 'revision': 'revision', - 'state': 'state', - 'disconnected_node_acknowledged': 'disconnectedNodeAcknowledged' - } + 'disconnected_node_acknowledged': 'disconnectedNodeAcknowledged', +'revision': 'revision', +'state': 'state' } - def __init__(self, revision=None, state=None, disconnected_node_acknowledged=None): + def __init__(self, disconnected_node_acknowledged=None, revision=None, state=None): """ RemotePortRunStatusEntity - a model defined in Swagger """ + self._disconnected_node_acknowledged = None self._revision = None self._state = None - self._disconnected_node_acknowledged = None + if disconnected_node_acknowledged is not None: + self.disconnected_node_acknowledged = disconnected_node_acknowledged if revision is not None: self.revision = revision if state is not None: self.state = state - if disconnected_node_acknowledged is not None: - self.disconnected_node_acknowledged = disconnected_node_acknowledged + + @property + def disconnected_node_acknowledged(self): + """ + Gets the disconnected_node_acknowledged of this RemotePortRunStatusEntity. + Acknowledges that this node is disconnected to allow for mutable requests to proceed. + + :return: The disconnected_node_acknowledged of this RemotePortRunStatusEntity. + :rtype: bool + """ + return self._disconnected_node_acknowledged + + @disconnected_node_acknowledged.setter + def disconnected_node_acknowledged(self, disconnected_node_acknowledged): + """ + Sets the disconnected_node_acknowledged of this RemotePortRunStatusEntity. + Acknowledges that this node is disconnected to allow for mutable requests to proceed. + + :param disconnected_node_acknowledged: The disconnected_node_acknowledged of this RemotePortRunStatusEntity. + :type: bool + """ + + self._disconnected_node_acknowledged = disconnected_node_acknowledged @property def revision(self): """ Gets the revision of this RemotePortRunStatusEntity. - The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses. :return: The revision of this RemotePortRunStatusEntity. :rtype: RevisionDTO @@ -70,7 +89,6 @@ def revision(self): def revision(self, revision): """ Sets the revision of this RemotePortRunStatusEntity. - The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses. :param revision: The revision of this RemotePortRunStatusEntity. :type: RevisionDTO @@ -98,7 +116,7 @@ def state(self, state): :param state: The state of this RemotePortRunStatusEntity. :type: str """ - allowed_values = ["TRANSMITTING", "STOPPED"] + allowed_values = ["TRANSMITTING", "STOPPED", ] if state not in allowed_values: raise ValueError( "Invalid value for `state` ({0}), must be one of {1}" @@ -107,29 +125,6 @@ def state(self, state): self._state = state - @property - def disconnected_node_acknowledged(self): - """ - Gets the disconnected_node_acknowledged of this RemotePortRunStatusEntity. - Acknowledges that this node is disconnected to allow for mutable requests to proceed. - - :return: The disconnected_node_acknowledged of this RemotePortRunStatusEntity. - :rtype: bool - """ - return self._disconnected_node_acknowledged - - @disconnected_node_acknowledged.setter - def disconnected_node_acknowledged(self, disconnected_node_acknowledged): - """ - Sets the disconnected_node_acknowledged of this RemotePortRunStatusEntity. - Acknowledges that this node is disconnected to allow for mutable requests to proceed. - - :param disconnected_node_acknowledged: The disconnected_node_acknowledged of this RemotePortRunStatusEntity. - :type: bool - """ - - self._disconnected_node_acknowledged = disconnected_node_acknowledged - def to_dict(self): """ Returns the model properties as a dict diff --git a/nipyapi/nifi/models/remote_process_group_contents_dto.py b/nipyapi/nifi/models/remote_process_group_contents_dto.py index 11eb8f8a..e8619c0c 100644 --- a/nipyapi/nifi/models/remote_process_group_contents_dto.py +++ b/nipyapi/nifi/models/remote_process_group_contents_dto.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -29,13 +28,11 @@ class RemoteProcessGroupContentsDTO(object): """ swagger_types = { 'input_ports': 'list[RemoteProcessGroupPortDTO]', - 'output_ports': 'list[RemoteProcessGroupPortDTO]' - } +'output_ports': 'list[RemoteProcessGroupPortDTO]' } attribute_map = { 'input_ports': 'inputPorts', - 'output_ports': 'outputPorts' - } +'output_ports': 'outputPorts' } def __init__(self, input_ports=None, output_ports=None): """ diff --git a/nipyapi/nifi/models/remote_process_group_dto.py b/nipyapi/nifi/models/remote_process_group_dto.py index f4c7115c..f5fc1ad6 100644 --- a/nipyapi/nifi/models/remote_process_group_dto.py +++ b/nipyapi/nifi/models/remote_process_group_dto.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,341 +27,224 @@ class RemoteProcessGroupDTO(object): and the value is json key in definition. """ swagger_types = { - 'id': 'str', - 'versioned_component_id': 'str', - 'parent_group_id': 'str', - 'position': 'PositionDTO', - 'target_uri': 'str', - 'target_uris': 'str', - 'target_secure': 'bool', - 'name': 'str', - 'comments': 'str', - 'communications_timeout': 'str', - 'yield_duration': 'str', - 'transport_protocol': 'str', - 'local_network_interface': 'str', - 'proxy_host': 'str', - 'proxy_port': 'int', - 'proxy_user': 'str', - 'proxy_password': 'str', - 'authorization_issues': 'list[str]', - 'validation_errors': 'list[str]', - 'transmitting': 'bool', - 'input_port_count': 'int', - 'output_port_count': 'int', 'active_remote_input_port_count': 'int', - 'inactive_remote_input_port_count': 'int', - 'active_remote_output_port_count': 'int', - 'inactive_remote_output_port_count': 'int', - 'flow_refreshed': 'str', - 'contents': 'RemoteProcessGroupContentsDTO' - } +'active_remote_output_port_count': 'int', +'authorization_issues': 'list[str]', +'comments': 'str', +'communications_timeout': 'str', +'contents': 'RemoteProcessGroupContentsDTO', +'flow_refreshed': 'str', +'id': 'str', +'inactive_remote_input_port_count': 'int', +'inactive_remote_output_port_count': 'int', +'input_port_count': 'int', +'local_network_interface': 'str', +'name': 'str', +'output_port_count': 'int', +'parent_group_id': 'str', +'position': 'PositionDTO', +'proxy_host': 'str', +'proxy_password': 'str', +'proxy_port': 'int', +'proxy_user': 'str', +'target_secure': 'bool', +'target_uri': 'str', +'target_uris': 'str', +'transmitting': 'bool', +'transport_protocol': 'str', +'validation_errors': 'list[str]', +'versioned_component_id': 'str', +'yield_duration': 'str' } attribute_map = { - 'id': 'id', - 'versioned_component_id': 'versionedComponentId', - 'parent_group_id': 'parentGroupId', - 'position': 'position', - 'target_uri': 'targetUri', - 'target_uris': 'targetUris', - 'target_secure': 'targetSecure', - 'name': 'name', - 'comments': 'comments', - 'communications_timeout': 'communicationsTimeout', - 'yield_duration': 'yieldDuration', - 'transport_protocol': 'transportProtocol', - 'local_network_interface': 'localNetworkInterface', - 'proxy_host': 'proxyHost', - 'proxy_port': 'proxyPort', - 'proxy_user': 'proxyUser', - 'proxy_password': 'proxyPassword', - 'authorization_issues': 'authorizationIssues', - 'validation_errors': 'validationErrors', - 'transmitting': 'transmitting', - 'input_port_count': 'inputPortCount', - 'output_port_count': 'outputPortCount', 'active_remote_input_port_count': 'activeRemoteInputPortCount', - 'inactive_remote_input_port_count': 'inactiveRemoteInputPortCount', - 'active_remote_output_port_count': 'activeRemoteOutputPortCount', - 'inactive_remote_output_port_count': 'inactiveRemoteOutputPortCount', - 'flow_refreshed': 'flowRefreshed', - 'contents': 'contents' - } - - def __init__(self, id=None, versioned_component_id=None, parent_group_id=None, position=None, target_uri=None, target_uris=None, target_secure=None, name=None, comments=None, communications_timeout=None, yield_duration=None, transport_protocol=None, local_network_interface=None, proxy_host=None, proxy_port=None, proxy_user=None, proxy_password=None, authorization_issues=None, validation_errors=None, transmitting=None, input_port_count=None, output_port_count=None, active_remote_input_port_count=None, inactive_remote_input_port_count=None, active_remote_output_port_count=None, inactive_remote_output_port_count=None, flow_refreshed=None, contents=None): +'active_remote_output_port_count': 'activeRemoteOutputPortCount', +'authorization_issues': 'authorizationIssues', +'comments': 'comments', +'communications_timeout': 'communicationsTimeout', +'contents': 'contents', +'flow_refreshed': 'flowRefreshed', +'id': 'id', +'inactive_remote_input_port_count': 'inactiveRemoteInputPortCount', +'inactive_remote_output_port_count': 'inactiveRemoteOutputPortCount', +'input_port_count': 'inputPortCount', +'local_network_interface': 'localNetworkInterface', +'name': 'name', +'output_port_count': 'outputPortCount', +'parent_group_id': 'parentGroupId', +'position': 'position', +'proxy_host': 'proxyHost', +'proxy_password': 'proxyPassword', +'proxy_port': 'proxyPort', +'proxy_user': 'proxyUser', +'target_secure': 'targetSecure', +'target_uri': 'targetUri', +'target_uris': 'targetUris', +'transmitting': 'transmitting', +'transport_protocol': 'transportProtocol', +'validation_errors': 'validationErrors', +'versioned_component_id': 'versionedComponentId', +'yield_duration': 'yieldDuration' } + + def __init__(self, active_remote_input_port_count=None, active_remote_output_port_count=None, authorization_issues=None, comments=None, communications_timeout=None, contents=None, flow_refreshed=None, id=None, inactive_remote_input_port_count=None, inactive_remote_output_port_count=None, input_port_count=None, local_network_interface=None, name=None, output_port_count=None, parent_group_id=None, position=None, proxy_host=None, proxy_password=None, proxy_port=None, proxy_user=None, target_secure=None, target_uri=None, target_uris=None, transmitting=None, transport_protocol=None, validation_errors=None, versioned_component_id=None, yield_duration=None): """ RemoteProcessGroupDTO - a model defined in Swagger """ - self._id = None - self._versioned_component_id = None - self._parent_group_id = None - self._position = None - self._target_uri = None - self._target_uris = None - self._target_secure = None - self._name = None + self._active_remote_input_port_count = None + self._active_remote_output_port_count = None + self._authorization_issues = None self._comments = None self._communications_timeout = None - self._yield_duration = None - self._transport_protocol = None + self._contents = None + self._flow_refreshed = None + self._id = None + self._inactive_remote_input_port_count = None + self._inactive_remote_output_port_count = None + self._input_port_count = None self._local_network_interface = None + self._name = None + self._output_port_count = None + self._parent_group_id = None + self._position = None self._proxy_host = None + self._proxy_password = None self._proxy_port = None self._proxy_user = None - self._proxy_password = None - self._authorization_issues = None - self._validation_errors = None + self._target_secure = None + self._target_uri = None + self._target_uris = None self._transmitting = None - self._input_port_count = None - self._output_port_count = None - self._active_remote_input_port_count = None - self._inactive_remote_input_port_count = None - self._active_remote_output_port_count = None - self._inactive_remote_output_port_count = None - self._flow_refreshed = None - self._contents = None + self._transport_protocol = None + self._validation_errors = None + self._versioned_component_id = None + self._yield_duration = None - if id is not None: - self.id = id - if versioned_component_id is not None: - self.versioned_component_id = versioned_component_id - if parent_group_id is not None: - self.parent_group_id = parent_group_id - if position is not None: - self.position = position - if target_uri is not None: - self.target_uri = target_uri - if target_uris is not None: - self.target_uris = target_uris - if target_secure is not None: - self.target_secure = target_secure - if name is not None: - self.name = name + if active_remote_input_port_count is not None: + self.active_remote_input_port_count = active_remote_input_port_count + if active_remote_output_port_count is not None: + self.active_remote_output_port_count = active_remote_output_port_count + if authorization_issues is not None: + self.authorization_issues = authorization_issues if comments is not None: self.comments = comments if communications_timeout is not None: self.communications_timeout = communications_timeout - if yield_duration is not None: - self.yield_duration = yield_duration - if transport_protocol is not None: - self.transport_protocol = transport_protocol + if contents is not None: + self.contents = contents + if flow_refreshed is not None: + self.flow_refreshed = flow_refreshed + if id is not None: + self.id = id + if inactive_remote_input_port_count is not None: + self.inactive_remote_input_port_count = inactive_remote_input_port_count + if inactive_remote_output_port_count is not None: + self.inactive_remote_output_port_count = inactive_remote_output_port_count + if input_port_count is not None: + self.input_port_count = input_port_count if local_network_interface is not None: self.local_network_interface = local_network_interface + if name is not None: + self.name = name + if output_port_count is not None: + self.output_port_count = output_port_count + if parent_group_id is not None: + self.parent_group_id = parent_group_id + if position is not None: + self.position = position if proxy_host is not None: self.proxy_host = proxy_host + if proxy_password is not None: + self.proxy_password = proxy_password if proxy_port is not None: self.proxy_port = proxy_port if proxy_user is not None: self.proxy_user = proxy_user - if proxy_password is not None: - self.proxy_password = proxy_password - if authorization_issues is not None: - self.authorization_issues = authorization_issues - if validation_errors is not None: - self.validation_errors = validation_errors + if target_secure is not None: + self.target_secure = target_secure + if target_uri is not None: + self.target_uri = target_uri + if target_uris is not None: + self.target_uris = target_uris if transmitting is not None: self.transmitting = transmitting - if input_port_count is not None: - self.input_port_count = input_port_count - if output_port_count is not None: - self.output_port_count = output_port_count - if active_remote_input_port_count is not None: - self.active_remote_input_port_count = active_remote_input_port_count - if inactive_remote_input_port_count is not None: - self.inactive_remote_input_port_count = inactive_remote_input_port_count - if active_remote_output_port_count is not None: - self.active_remote_output_port_count = active_remote_output_port_count - if inactive_remote_output_port_count is not None: - self.inactive_remote_output_port_count = inactive_remote_output_port_count - if flow_refreshed is not None: - self.flow_refreshed = flow_refreshed - if contents is not None: - self.contents = contents - - @property - def id(self): - """ - Gets the id of this RemoteProcessGroupDTO. - The id of the component. - - :return: The id of this RemoteProcessGroupDTO. - :rtype: str - """ - return self._id - - @id.setter - def id(self, id): - """ - Sets the id of this RemoteProcessGroupDTO. - The id of the component. - - :param id: The id of this RemoteProcessGroupDTO. - :type: str - """ - - self._id = id - - @property - def versioned_component_id(self): - """ - Gets the versioned_component_id of this RemoteProcessGroupDTO. - The ID of the corresponding component that is under version control - - :return: The versioned_component_id of this RemoteProcessGroupDTO. - :rtype: str - """ - return self._versioned_component_id - - @versioned_component_id.setter - def versioned_component_id(self, versioned_component_id): - """ - Sets the versioned_component_id of this RemoteProcessGroupDTO. - The ID of the corresponding component that is under version control - - :param versioned_component_id: The versioned_component_id of this RemoteProcessGroupDTO. - :type: str - """ - - self._versioned_component_id = versioned_component_id - - @property - def parent_group_id(self): - """ - Gets the parent_group_id of this RemoteProcessGroupDTO. - The id of parent process group of this component if applicable. - - :return: The parent_group_id of this RemoteProcessGroupDTO. - :rtype: str - """ - return self._parent_group_id - - @parent_group_id.setter - def parent_group_id(self, parent_group_id): - """ - Sets the parent_group_id of this RemoteProcessGroupDTO. - The id of parent process group of this component if applicable. - - :param parent_group_id: The parent_group_id of this RemoteProcessGroupDTO. - :type: str - """ - - self._parent_group_id = parent_group_id - - @property - def position(self): - """ - Gets the position of this RemoteProcessGroupDTO. - The position of this component in the UI if applicable. - - :return: The position of this RemoteProcessGroupDTO. - :rtype: PositionDTO - """ - return self._position - - @position.setter - def position(self, position): - """ - Sets the position of this RemoteProcessGroupDTO. - The position of this component in the UI if applicable. - - :param position: The position of this RemoteProcessGroupDTO. - :type: PositionDTO - """ - - self._position = position - - @property - def target_uri(self): - """ - Gets the target_uri of this RemoteProcessGroupDTO. - The target URI of the remote process group. If target uri is not set, but uris are set, then returns the first url in the urls. If neither target uri nor uris are set, then returns null. - - :return: The target_uri of this RemoteProcessGroupDTO. - :rtype: str - """ - return self._target_uri - - @target_uri.setter - def target_uri(self, target_uri): - """ - Sets the target_uri of this RemoteProcessGroupDTO. - The target URI of the remote process group. If target uri is not set, but uris are set, then returns the first url in the urls. If neither target uri nor uris are set, then returns null. - - :param target_uri: The target_uri of this RemoteProcessGroupDTO. - :type: str - """ - - self._target_uri = target_uri + if transport_protocol is not None: + self.transport_protocol = transport_protocol + if validation_errors is not None: + self.validation_errors = validation_errors + if versioned_component_id is not None: + self.versioned_component_id = versioned_component_id + if yield_duration is not None: + self.yield_duration = yield_duration @property - def target_uris(self): + def active_remote_input_port_count(self): """ - Gets the target_uris of this RemoteProcessGroupDTO. - The target URI of the remote process group. If target uris is not set but target uri is set, then returns a collection containing the single target uri. If neither target uris nor uris are set, then returns null. + Gets the active_remote_input_port_count of this RemoteProcessGroupDTO. + The number of active remote input ports. - :return: The target_uris of this RemoteProcessGroupDTO. - :rtype: str + :return: The active_remote_input_port_count of this RemoteProcessGroupDTO. + :rtype: int """ - return self._target_uris + return self._active_remote_input_port_count - @target_uris.setter - def target_uris(self, target_uris): + @active_remote_input_port_count.setter + def active_remote_input_port_count(self, active_remote_input_port_count): """ - Sets the target_uris of this RemoteProcessGroupDTO. - The target URI of the remote process group. If target uris is not set but target uri is set, then returns a collection containing the single target uri. If neither target uris nor uris are set, then returns null. + Sets the active_remote_input_port_count of this RemoteProcessGroupDTO. + The number of active remote input ports. - :param target_uris: The target_uris of this RemoteProcessGroupDTO. - :type: str + :param active_remote_input_port_count: The active_remote_input_port_count of this RemoteProcessGroupDTO. + :type: int """ - self._target_uris = target_uris + self._active_remote_input_port_count = active_remote_input_port_count @property - def target_secure(self): + def active_remote_output_port_count(self): """ - Gets the target_secure of this RemoteProcessGroupDTO. - Whether the target is running securely. + Gets the active_remote_output_port_count of this RemoteProcessGroupDTO. + The number of active remote output ports. - :return: The target_secure of this RemoteProcessGroupDTO. - :rtype: bool + :return: The active_remote_output_port_count of this RemoteProcessGroupDTO. + :rtype: int """ - return self._target_secure + return self._active_remote_output_port_count - @target_secure.setter - def target_secure(self, target_secure): + @active_remote_output_port_count.setter + def active_remote_output_port_count(self, active_remote_output_port_count): """ - Sets the target_secure of this RemoteProcessGroupDTO. - Whether the target is running securely. + Sets the active_remote_output_port_count of this RemoteProcessGroupDTO. + The number of active remote output ports. - :param target_secure: The target_secure of this RemoteProcessGroupDTO. - :type: bool + :param active_remote_output_port_count: The active_remote_output_port_count of this RemoteProcessGroupDTO. + :type: int """ - self._target_secure = target_secure + self._active_remote_output_port_count = active_remote_output_port_count @property - def name(self): + def authorization_issues(self): """ - Gets the name of this RemoteProcessGroupDTO. - The name of the remote process group. + Gets the authorization_issues of this RemoteProcessGroupDTO. + Any remote authorization issues for the remote process group. - :return: The name of this RemoteProcessGroupDTO. - :rtype: str + :return: The authorization_issues of this RemoteProcessGroupDTO. + :rtype: list[str] """ - return self._name + return self._authorization_issues - @name.setter - def name(self, name): + @authorization_issues.setter + def authorization_issues(self, authorization_issues): """ - Sets the name of this RemoteProcessGroupDTO. - The name of the remote process group. + Sets the authorization_issues of this RemoteProcessGroupDTO. + Any remote authorization issues for the remote process group. - :param name: The name of this RemoteProcessGroupDTO. - :type: str + :param authorization_issues: The authorization_issues of this RemoteProcessGroupDTO. + :type: list[str] """ - self._name = name + self._authorization_issues = authorization_issues @property def comments(self): @@ -411,48 +293,140 @@ def communications_timeout(self, communications_timeout): self._communications_timeout = communications_timeout @property - def yield_duration(self): + def contents(self): """ - Gets the yield_duration of this RemoteProcessGroupDTO. - When yielding, this amount of time must elapse before the remote process group is scheduled again. + Gets the contents of this RemoteProcessGroupDTO. - :return: The yield_duration of this RemoteProcessGroupDTO. + :return: The contents of this RemoteProcessGroupDTO. + :rtype: RemoteProcessGroupContentsDTO + """ + return self._contents + + @contents.setter + def contents(self, contents): + """ + Sets the contents of this RemoteProcessGroupDTO. + + :param contents: The contents of this RemoteProcessGroupDTO. + :type: RemoteProcessGroupContentsDTO + """ + + self._contents = contents + + @property + def flow_refreshed(self): + """ + Gets the flow_refreshed of this RemoteProcessGroupDTO. + The timestamp when this remote process group was last refreshed. + + :return: The flow_refreshed of this RemoteProcessGroupDTO. :rtype: str """ - return self._yield_duration + return self._flow_refreshed - @yield_duration.setter - def yield_duration(self, yield_duration): + @flow_refreshed.setter + def flow_refreshed(self, flow_refreshed): """ - Sets the yield_duration of this RemoteProcessGroupDTO. - When yielding, this amount of time must elapse before the remote process group is scheduled again. + Sets the flow_refreshed of this RemoteProcessGroupDTO. + The timestamp when this remote process group was last refreshed. - :param yield_duration: The yield_duration of this RemoteProcessGroupDTO. + :param flow_refreshed: The flow_refreshed of this RemoteProcessGroupDTO. :type: str """ - self._yield_duration = yield_duration + self._flow_refreshed = flow_refreshed @property - def transport_protocol(self): + def id(self): """ - Gets the transport_protocol of this RemoteProcessGroupDTO. + Gets the id of this RemoteProcessGroupDTO. + The id of the component. - :return: The transport_protocol of this RemoteProcessGroupDTO. + :return: The id of this RemoteProcessGroupDTO. :rtype: str """ - return self._transport_protocol + return self._id - @transport_protocol.setter - def transport_protocol(self, transport_protocol): + @id.setter + def id(self, id): """ - Sets the transport_protocol of this RemoteProcessGroupDTO. + Sets the id of this RemoteProcessGroupDTO. + The id of the component. - :param transport_protocol: The transport_protocol of this RemoteProcessGroupDTO. + :param id: The id of this RemoteProcessGroupDTO. :type: str """ - self._transport_protocol = transport_protocol + self._id = id + + @property + def inactive_remote_input_port_count(self): + """ + Gets the inactive_remote_input_port_count of this RemoteProcessGroupDTO. + The number of inactive remote input ports. + + :return: The inactive_remote_input_port_count of this RemoteProcessGroupDTO. + :rtype: int + """ + return self._inactive_remote_input_port_count + + @inactive_remote_input_port_count.setter + def inactive_remote_input_port_count(self, inactive_remote_input_port_count): + """ + Sets the inactive_remote_input_port_count of this RemoteProcessGroupDTO. + The number of inactive remote input ports. + + :param inactive_remote_input_port_count: The inactive_remote_input_port_count of this RemoteProcessGroupDTO. + :type: int + """ + + self._inactive_remote_input_port_count = inactive_remote_input_port_count + + @property + def inactive_remote_output_port_count(self): + """ + Gets the inactive_remote_output_port_count of this RemoteProcessGroupDTO. + The number of inactive remote output ports. + + :return: The inactive_remote_output_port_count of this RemoteProcessGroupDTO. + :rtype: int + """ + return self._inactive_remote_output_port_count + + @inactive_remote_output_port_count.setter + def inactive_remote_output_port_count(self, inactive_remote_output_port_count): + """ + Sets the inactive_remote_output_port_count of this RemoteProcessGroupDTO. + The number of inactive remote output ports. + + :param inactive_remote_output_port_count: The inactive_remote_output_port_count of this RemoteProcessGroupDTO. + :type: int + """ + + self._inactive_remote_output_port_count = inactive_remote_output_port_count + + @property + def input_port_count(self): + """ + Gets the input_port_count of this RemoteProcessGroupDTO. + The number of remote input ports currently available on the target. + + :return: The input_port_count of this RemoteProcessGroupDTO. + :rtype: int + """ + return self._input_port_count + + @input_port_count.setter + def input_port_count(self, input_port_count): + """ + Sets the input_port_count of this RemoteProcessGroupDTO. + The number of remote input ports currently available on the target. + + :param input_port_count: The input_port_count of this RemoteProcessGroupDTO. + :type: int + """ + + self._input_port_count = input_port_count @property def local_network_interface(self): @@ -478,341 +452,360 @@ def local_network_interface(self, local_network_interface): self._local_network_interface = local_network_interface @property - def proxy_host(self): + def name(self): """ - Gets the proxy_host of this RemoteProcessGroupDTO. + Gets the name of this RemoteProcessGroupDTO. + The name of the remote process group. - :return: The proxy_host of this RemoteProcessGroupDTO. + :return: The name of this RemoteProcessGroupDTO. :rtype: str """ - return self._proxy_host + return self._name - @proxy_host.setter - def proxy_host(self, proxy_host): + @name.setter + def name(self, name): """ - Sets the proxy_host of this RemoteProcessGroupDTO. + Sets the name of this RemoteProcessGroupDTO. + The name of the remote process group. - :param proxy_host: The proxy_host of this RemoteProcessGroupDTO. + :param name: The name of this RemoteProcessGroupDTO. :type: str """ - self._proxy_host = proxy_host + self._name = name @property - def proxy_port(self): + def output_port_count(self): """ - Gets the proxy_port of this RemoteProcessGroupDTO. + Gets the output_port_count of this RemoteProcessGroupDTO. + The number of remote output ports currently available on the target. - :return: The proxy_port of this RemoteProcessGroupDTO. + :return: The output_port_count of this RemoteProcessGroupDTO. :rtype: int """ - return self._proxy_port + return self._output_port_count - @proxy_port.setter - def proxy_port(self, proxy_port): + @output_port_count.setter + def output_port_count(self, output_port_count): """ - Sets the proxy_port of this RemoteProcessGroupDTO. + Sets the output_port_count of this RemoteProcessGroupDTO. + The number of remote output ports currently available on the target. - :param proxy_port: The proxy_port of this RemoteProcessGroupDTO. + :param output_port_count: The output_port_count of this RemoteProcessGroupDTO. :type: int """ - self._proxy_port = proxy_port + self._output_port_count = output_port_count @property - def proxy_user(self): + def parent_group_id(self): """ - Gets the proxy_user of this RemoteProcessGroupDTO. + Gets the parent_group_id of this RemoteProcessGroupDTO. + The id of parent process group of this component if applicable. - :return: The proxy_user of this RemoteProcessGroupDTO. + :return: The parent_group_id of this RemoteProcessGroupDTO. :rtype: str """ - return self._proxy_user + return self._parent_group_id - @proxy_user.setter - def proxy_user(self, proxy_user): + @parent_group_id.setter + def parent_group_id(self, parent_group_id): """ - Sets the proxy_user of this RemoteProcessGroupDTO. + Sets the parent_group_id of this RemoteProcessGroupDTO. + The id of parent process group of this component if applicable. - :param proxy_user: The proxy_user of this RemoteProcessGroupDTO. + :param parent_group_id: The parent_group_id of this RemoteProcessGroupDTO. :type: str """ - self._proxy_user = proxy_user + self._parent_group_id = parent_group_id @property - def proxy_password(self): + def position(self): """ - Gets the proxy_password of this RemoteProcessGroupDTO. + Gets the position of this RemoteProcessGroupDTO. - :return: The proxy_password of this RemoteProcessGroupDTO. + :return: The position of this RemoteProcessGroupDTO. + :rtype: PositionDTO + """ + return self._position + + @position.setter + def position(self, position): + """ + Sets the position of this RemoteProcessGroupDTO. + + :param position: The position of this RemoteProcessGroupDTO. + :type: PositionDTO + """ + + self._position = position + + @property + def proxy_host(self): + """ + Gets the proxy_host of this RemoteProcessGroupDTO. + + :return: The proxy_host of this RemoteProcessGroupDTO. :rtype: str """ - return self._proxy_password + return self._proxy_host - @proxy_password.setter - def proxy_password(self, proxy_password): + @proxy_host.setter + def proxy_host(self, proxy_host): """ - Sets the proxy_password of this RemoteProcessGroupDTO. + Sets the proxy_host of this RemoteProcessGroupDTO. - :param proxy_password: The proxy_password of this RemoteProcessGroupDTO. + :param proxy_host: The proxy_host of this RemoteProcessGroupDTO. :type: str """ - self._proxy_password = proxy_password + self._proxy_host = proxy_host @property - def authorization_issues(self): + def proxy_password(self): """ - Gets the authorization_issues of this RemoteProcessGroupDTO. - Any remote authorization issues for the remote process group. + Gets the proxy_password of this RemoteProcessGroupDTO. - :return: The authorization_issues of this RemoteProcessGroupDTO. - :rtype: list[str] + :return: The proxy_password of this RemoteProcessGroupDTO. + :rtype: str """ - return self._authorization_issues - - @authorization_issues.setter - def authorization_issues(self, authorization_issues): + return self._proxy_password + + @proxy_password.setter + def proxy_password(self, proxy_password): """ - Sets the authorization_issues of this RemoteProcessGroupDTO. - Any remote authorization issues for the remote process group. + Sets the proxy_password of this RemoteProcessGroupDTO. - :param authorization_issues: The authorization_issues of this RemoteProcessGroupDTO. - :type: list[str] + :param proxy_password: The proxy_password of this RemoteProcessGroupDTO. + :type: str """ - self._authorization_issues = authorization_issues + self._proxy_password = proxy_password @property - def validation_errors(self): + def proxy_port(self): """ - Gets the validation_errors of this RemoteProcessGroupDTO. - The validation errors for the remote process group. These validation errors represent the problems with the remote process group that must be resolved before it can transmit. + Gets the proxy_port of this RemoteProcessGroupDTO. - :return: The validation_errors of this RemoteProcessGroupDTO. - :rtype: list[str] + :return: The proxy_port of this RemoteProcessGroupDTO. + :rtype: int """ - return self._validation_errors + return self._proxy_port - @validation_errors.setter - def validation_errors(self, validation_errors): + @proxy_port.setter + def proxy_port(self, proxy_port): """ - Sets the validation_errors of this RemoteProcessGroupDTO. - The validation errors for the remote process group. These validation errors represent the problems with the remote process group that must be resolved before it can transmit. + Sets the proxy_port of this RemoteProcessGroupDTO. - :param validation_errors: The validation_errors of this RemoteProcessGroupDTO. - :type: list[str] + :param proxy_port: The proxy_port of this RemoteProcessGroupDTO. + :type: int """ - self._validation_errors = validation_errors + self._proxy_port = proxy_port @property - def transmitting(self): + def proxy_user(self): """ - Gets the transmitting of this RemoteProcessGroupDTO. - Whether the remote process group is actively transmitting. + Gets the proxy_user of this RemoteProcessGroupDTO. - :return: The transmitting of this RemoteProcessGroupDTO. - :rtype: bool + :return: The proxy_user of this RemoteProcessGroupDTO. + :rtype: str """ - return self._transmitting + return self._proxy_user - @transmitting.setter - def transmitting(self, transmitting): + @proxy_user.setter + def proxy_user(self, proxy_user): """ - Sets the transmitting of this RemoteProcessGroupDTO. - Whether the remote process group is actively transmitting. + Sets the proxy_user of this RemoteProcessGroupDTO. - :param transmitting: The transmitting of this RemoteProcessGroupDTO. - :type: bool + :param proxy_user: The proxy_user of this RemoteProcessGroupDTO. + :type: str """ - self._transmitting = transmitting + self._proxy_user = proxy_user @property - def input_port_count(self): + def target_secure(self): """ - Gets the input_port_count of this RemoteProcessGroupDTO. - The number of remote input ports currently available on the target. + Gets the target_secure of this RemoteProcessGroupDTO. + Whether the target is running securely. - :return: The input_port_count of this RemoteProcessGroupDTO. - :rtype: int + :return: The target_secure of this RemoteProcessGroupDTO. + :rtype: bool """ - return self._input_port_count + return self._target_secure - @input_port_count.setter - def input_port_count(self, input_port_count): + @target_secure.setter + def target_secure(self, target_secure): """ - Sets the input_port_count of this RemoteProcessGroupDTO. - The number of remote input ports currently available on the target. + Sets the target_secure of this RemoteProcessGroupDTO. + Whether the target is running securely. - :param input_port_count: The input_port_count of this RemoteProcessGroupDTO. - :type: int + :param target_secure: The target_secure of this RemoteProcessGroupDTO. + :type: bool """ - self._input_port_count = input_port_count + self._target_secure = target_secure @property - def output_port_count(self): + def target_uri(self): """ - Gets the output_port_count of this RemoteProcessGroupDTO. - The number of remote output ports currently available on the target. + Gets the target_uri of this RemoteProcessGroupDTO. + The target URI of the remote process group. If target uri is not set, but uris are set, then returns the first url in the urls. If neither target uri nor uris are set, then returns null. - :return: The output_port_count of this RemoteProcessGroupDTO. - :rtype: int + :return: The target_uri of this RemoteProcessGroupDTO. + :rtype: str """ - return self._output_port_count + return self._target_uri - @output_port_count.setter - def output_port_count(self, output_port_count): + @target_uri.setter + def target_uri(self, target_uri): """ - Sets the output_port_count of this RemoteProcessGroupDTO. - The number of remote output ports currently available on the target. + Sets the target_uri of this RemoteProcessGroupDTO. + The target URI of the remote process group. If target uri is not set, but uris are set, then returns the first url in the urls. If neither target uri nor uris are set, then returns null. - :param output_port_count: The output_port_count of this RemoteProcessGroupDTO. - :type: int + :param target_uri: The target_uri of this RemoteProcessGroupDTO. + :type: str """ - self._output_port_count = output_port_count + self._target_uri = target_uri @property - def active_remote_input_port_count(self): + def target_uris(self): """ - Gets the active_remote_input_port_count of this RemoteProcessGroupDTO. - The number of active remote input ports. + Gets the target_uris of this RemoteProcessGroupDTO. + The target URI of the remote process group. If target uris is not set but target uri is set, then returns a collection containing the single target uri. If neither target uris nor uris are set, then returns null. - :return: The active_remote_input_port_count of this RemoteProcessGroupDTO. - :rtype: int + :return: The target_uris of this RemoteProcessGroupDTO. + :rtype: str """ - return self._active_remote_input_port_count + return self._target_uris - @active_remote_input_port_count.setter - def active_remote_input_port_count(self, active_remote_input_port_count): + @target_uris.setter + def target_uris(self, target_uris): """ - Sets the active_remote_input_port_count of this RemoteProcessGroupDTO. - The number of active remote input ports. + Sets the target_uris of this RemoteProcessGroupDTO. + The target URI of the remote process group. If target uris is not set but target uri is set, then returns a collection containing the single target uri. If neither target uris nor uris are set, then returns null. - :param active_remote_input_port_count: The active_remote_input_port_count of this RemoteProcessGroupDTO. - :type: int + :param target_uris: The target_uris of this RemoteProcessGroupDTO. + :type: str """ - self._active_remote_input_port_count = active_remote_input_port_count + self._target_uris = target_uris @property - def inactive_remote_input_port_count(self): + def transmitting(self): """ - Gets the inactive_remote_input_port_count of this RemoteProcessGroupDTO. - The number of inactive remote input ports. + Gets the transmitting of this RemoteProcessGroupDTO. + Whether the remote process group is actively transmitting. - :return: The inactive_remote_input_port_count of this RemoteProcessGroupDTO. - :rtype: int + :return: The transmitting of this RemoteProcessGroupDTO. + :rtype: bool """ - return self._inactive_remote_input_port_count + return self._transmitting - @inactive_remote_input_port_count.setter - def inactive_remote_input_port_count(self, inactive_remote_input_port_count): + @transmitting.setter + def transmitting(self, transmitting): """ - Sets the inactive_remote_input_port_count of this RemoteProcessGroupDTO. - The number of inactive remote input ports. + Sets the transmitting of this RemoteProcessGroupDTO. + Whether the remote process group is actively transmitting. - :param inactive_remote_input_port_count: The inactive_remote_input_port_count of this RemoteProcessGroupDTO. - :type: int + :param transmitting: The transmitting of this RemoteProcessGroupDTO. + :type: bool """ - self._inactive_remote_input_port_count = inactive_remote_input_port_count + self._transmitting = transmitting @property - def active_remote_output_port_count(self): + def transport_protocol(self): """ - Gets the active_remote_output_port_count of this RemoteProcessGroupDTO. - The number of active remote output ports. + Gets the transport_protocol of this RemoteProcessGroupDTO. - :return: The active_remote_output_port_count of this RemoteProcessGroupDTO. - :rtype: int + :return: The transport_protocol of this RemoteProcessGroupDTO. + :rtype: str """ - return self._active_remote_output_port_count + return self._transport_protocol - @active_remote_output_port_count.setter - def active_remote_output_port_count(self, active_remote_output_port_count): + @transport_protocol.setter + def transport_protocol(self, transport_protocol): """ - Sets the active_remote_output_port_count of this RemoteProcessGroupDTO. - The number of active remote output ports. + Sets the transport_protocol of this RemoteProcessGroupDTO. - :param active_remote_output_port_count: The active_remote_output_port_count of this RemoteProcessGroupDTO. - :type: int + :param transport_protocol: The transport_protocol of this RemoteProcessGroupDTO. + :type: str """ - self._active_remote_output_port_count = active_remote_output_port_count + self._transport_protocol = transport_protocol @property - def inactive_remote_output_port_count(self): + def validation_errors(self): """ - Gets the inactive_remote_output_port_count of this RemoteProcessGroupDTO. - The number of inactive remote output ports. + Gets the validation_errors of this RemoteProcessGroupDTO. + The validation errors for the remote process group. These validation errors represent the problems with the remote process group that must be resolved before it can transmit. - :return: The inactive_remote_output_port_count of this RemoteProcessGroupDTO. - :rtype: int + :return: The validation_errors of this RemoteProcessGroupDTO. + :rtype: list[str] """ - return self._inactive_remote_output_port_count + return self._validation_errors - @inactive_remote_output_port_count.setter - def inactive_remote_output_port_count(self, inactive_remote_output_port_count): + @validation_errors.setter + def validation_errors(self, validation_errors): """ - Sets the inactive_remote_output_port_count of this RemoteProcessGroupDTO. - The number of inactive remote output ports. + Sets the validation_errors of this RemoteProcessGroupDTO. + The validation errors for the remote process group. These validation errors represent the problems with the remote process group that must be resolved before it can transmit. - :param inactive_remote_output_port_count: The inactive_remote_output_port_count of this RemoteProcessGroupDTO. - :type: int + :param validation_errors: The validation_errors of this RemoteProcessGroupDTO. + :type: list[str] """ - self._inactive_remote_output_port_count = inactive_remote_output_port_count + self._validation_errors = validation_errors @property - def flow_refreshed(self): + def versioned_component_id(self): """ - Gets the flow_refreshed of this RemoteProcessGroupDTO. - The timestamp when this remote process group was last refreshed. + Gets the versioned_component_id of this RemoteProcessGroupDTO. + The ID of the corresponding component that is under version control - :return: The flow_refreshed of this RemoteProcessGroupDTO. + :return: The versioned_component_id of this RemoteProcessGroupDTO. :rtype: str """ - return self._flow_refreshed + return self._versioned_component_id - @flow_refreshed.setter - def flow_refreshed(self, flow_refreshed): + @versioned_component_id.setter + def versioned_component_id(self, versioned_component_id): """ - Sets the flow_refreshed of this RemoteProcessGroupDTO. - The timestamp when this remote process group was last refreshed. + Sets the versioned_component_id of this RemoteProcessGroupDTO. + The ID of the corresponding component that is under version control - :param flow_refreshed: The flow_refreshed of this RemoteProcessGroupDTO. + :param versioned_component_id: The versioned_component_id of this RemoteProcessGroupDTO. :type: str """ - self._flow_refreshed = flow_refreshed + self._versioned_component_id = versioned_component_id @property - def contents(self): + def yield_duration(self): """ - Gets the contents of this RemoteProcessGroupDTO. - The contents of the remote process group. Will contain available input/output ports. + Gets the yield_duration of this RemoteProcessGroupDTO. + When yielding, this amount of time must elapse before the remote process group is scheduled again. - :return: The contents of this RemoteProcessGroupDTO. - :rtype: RemoteProcessGroupContentsDTO + :return: The yield_duration of this RemoteProcessGroupDTO. + :rtype: str """ - return self._contents + return self._yield_duration - @contents.setter - def contents(self, contents): + @yield_duration.setter + def yield_duration(self, yield_duration): """ - Sets the contents of this RemoteProcessGroupDTO. - The contents of the remote process group. Will contain available input/output ports. + Sets the yield_duration of this RemoteProcessGroupDTO. + When yielding, this amount of time must elapse before the remote process group is scheduled again. - :param contents: The contents of this RemoteProcessGroupDTO. - :type: RemoteProcessGroupContentsDTO + :param yield_duration: The yield_duration of this RemoteProcessGroupDTO. + :type: str """ - self._contents = contents + self._yield_duration = yield_duration def to_dict(self): """ diff --git a/nipyapi/nifi/models/remote_process_group_entity.py b/nipyapi/nifi/models/remote_process_group_entity.py index d8934a6e..d0923df8 100644 --- a/nipyapi/nifi/models/remote_process_group_entity.py +++ b/nipyapi/nifi/models/remote_process_group_entity.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,100 +27,142 @@ class RemoteProcessGroupEntity(object): and the value is json key in definition. """ swagger_types = { - 'revision': 'RevisionDTO', - 'id': 'str', - 'uri': 'str', - 'position': 'PositionDTO', - 'permissions': 'PermissionsDTO', 'bulletins': 'list[BulletinEntity]', - 'disconnected_node_acknowledged': 'bool', - 'component': 'RemoteProcessGroupDTO', - 'status': 'RemoteProcessGroupStatusDTO', - 'input_port_count': 'int', - 'output_port_count': 'int', - 'operate_permissions': 'PermissionsDTO' - } +'component': 'RemoteProcessGroupDTO', +'disconnected_node_acknowledged': 'bool', +'id': 'str', +'input_port_count': 'int', +'operate_permissions': 'PermissionsDTO', +'output_port_count': 'int', +'permissions': 'PermissionsDTO', +'position': 'PositionDTO', +'revision': 'RevisionDTO', +'status': 'RemoteProcessGroupStatusDTO', +'uri': 'str' } attribute_map = { - 'revision': 'revision', - 'id': 'id', - 'uri': 'uri', - 'position': 'position', - 'permissions': 'permissions', 'bulletins': 'bulletins', - 'disconnected_node_acknowledged': 'disconnectedNodeAcknowledged', - 'component': 'component', - 'status': 'status', - 'input_port_count': 'inputPortCount', - 'output_port_count': 'outputPortCount', - 'operate_permissions': 'operatePermissions' - } - - def __init__(self, revision=None, id=None, uri=None, position=None, permissions=None, bulletins=None, disconnected_node_acknowledged=None, component=None, status=None, input_port_count=None, output_port_count=None, operate_permissions=None): +'component': 'component', +'disconnected_node_acknowledged': 'disconnectedNodeAcknowledged', +'id': 'id', +'input_port_count': 'inputPortCount', +'operate_permissions': 'operatePermissions', +'output_port_count': 'outputPortCount', +'permissions': 'permissions', +'position': 'position', +'revision': 'revision', +'status': 'status', +'uri': 'uri' } + + def __init__(self, bulletins=None, component=None, disconnected_node_acknowledged=None, id=None, input_port_count=None, operate_permissions=None, output_port_count=None, permissions=None, position=None, revision=None, status=None, uri=None): """ RemoteProcessGroupEntity - a model defined in Swagger """ - self._revision = None - self._id = None - self._uri = None - self._position = None - self._permissions = None self._bulletins = None - self._disconnected_node_acknowledged = None self._component = None - self._status = None + self._disconnected_node_acknowledged = None + self._id = None self._input_port_count = None - self._output_port_count = None self._operate_permissions = None + self._output_port_count = None + self._permissions = None + self._position = None + self._revision = None + self._status = None + self._uri = None - if revision is not None: - self.revision = revision - if id is not None: - self.id = id - if uri is not None: - self.uri = uri - if position is not None: - self.position = position - if permissions is not None: - self.permissions = permissions if bulletins is not None: self.bulletins = bulletins - if disconnected_node_acknowledged is not None: - self.disconnected_node_acknowledged = disconnected_node_acknowledged if component is not None: self.component = component - if status is not None: - self.status = status + if disconnected_node_acknowledged is not None: + self.disconnected_node_acknowledged = disconnected_node_acknowledged + if id is not None: + self.id = id if input_port_count is not None: self.input_port_count = input_port_count - if output_port_count is not None: - self.output_port_count = output_port_count if operate_permissions is not None: self.operate_permissions = operate_permissions + if output_port_count is not None: + self.output_port_count = output_port_count + if permissions is not None: + self.permissions = permissions + if position is not None: + self.position = position + if revision is not None: + self.revision = revision + if status is not None: + self.status = status + if uri is not None: + self.uri = uri @property - def revision(self): + def bulletins(self): """ - Gets the revision of this RemoteProcessGroupEntity. - The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses. + Gets the bulletins of this RemoteProcessGroupEntity. + The bulletins for this component. - :return: The revision of this RemoteProcessGroupEntity. - :rtype: RevisionDTO + :return: The bulletins of this RemoteProcessGroupEntity. + :rtype: list[BulletinEntity] """ - return self._revision + return self._bulletins - @revision.setter - def revision(self, revision): + @bulletins.setter + def bulletins(self, bulletins): """ - Sets the revision of this RemoteProcessGroupEntity. - The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses. + Sets the bulletins of this RemoteProcessGroupEntity. + The bulletins for this component. - :param revision: The revision of this RemoteProcessGroupEntity. - :type: RevisionDTO + :param bulletins: The bulletins of this RemoteProcessGroupEntity. + :type: list[BulletinEntity] """ - self._revision = revision + self._bulletins = bulletins + + @property + def component(self): + """ + Gets the component of this RemoteProcessGroupEntity. + + :return: The component of this RemoteProcessGroupEntity. + :rtype: RemoteProcessGroupDTO + """ + return self._component + + @component.setter + def component(self, component): + """ + Sets the component of this RemoteProcessGroupEntity. + + :param component: The component of this RemoteProcessGroupEntity. + :type: RemoteProcessGroupDTO + """ + + self._component = component + + @property + def disconnected_node_acknowledged(self): + """ + Gets the disconnected_node_acknowledged of this RemoteProcessGroupEntity. + Acknowledges that this node is disconnected to allow for mutable requests to proceed. + + :return: The disconnected_node_acknowledged of this RemoteProcessGroupEntity. + :rtype: bool + """ + return self._disconnected_node_acknowledged + + @disconnected_node_acknowledged.setter + def disconnected_node_acknowledged(self, disconnected_node_acknowledged): + """ + Sets the disconnected_node_acknowledged of this RemoteProcessGroupEntity. + Acknowledges that this node is disconnected to allow for mutable requests to proceed. + + :param disconnected_node_acknowledged: The disconnected_node_acknowledged of this RemoteProcessGroupEntity. + :type: bool + """ + + self._disconnected_node_acknowledged = disconnected_node_acknowledged @property def id(self): @@ -147,56 +188,76 @@ def id(self, id): self._id = id @property - def uri(self): + def input_port_count(self): """ - Gets the uri of this RemoteProcessGroupEntity. - The URI for futures requests to the component. + Gets the input_port_count of this RemoteProcessGroupEntity. + The number of remote input ports currently available on the target. - :return: The uri of this RemoteProcessGroupEntity. - :rtype: str + :return: The input_port_count of this RemoteProcessGroupEntity. + :rtype: int """ - return self._uri + return self._input_port_count - @uri.setter - def uri(self, uri): + @input_port_count.setter + def input_port_count(self, input_port_count): """ - Sets the uri of this RemoteProcessGroupEntity. - The URI for futures requests to the component. + Sets the input_port_count of this RemoteProcessGroupEntity. + The number of remote input ports currently available on the target. - :param uri: The uri of this RemoteProcessGroupEntity. - :type: str + :param input_port_count: The input_port_count of this RemoteProcessGroupEntity. + :type: int """ - self._uri = uri + self._input_port_count = input_port_count @property - def position(self): + def operate_permissions(self): """ - Gets the position of this RemoteProcessGroupEntity. - The position of this component in the UI if applicable. + Gets the operate_permissions of this RemoteProcessGroupEntity. - :return: The position of this RemoteProcessGroupEntity. - :rtype: PositionDTO + :return: The operate_permissions of this RemoteProcessGroupEntity. + :rtype: PermissionsDTO """ - return self._position + return self._operate_permissions - @position.setter - def position(self, position): + @operate_permissions.setter + def operate_permissions(self, operate_permissions): """ - Sets the position of this RemoteProcessGroupEntity. - The position of this component in the UI if applicable. + Sets the operate_permissions of this RemoteProcessGroupEntity. - :param position: The position of this RemoteProcessGroupEntity. - :type: PositionDTO + :param operate_permissions: The operate_permissions of this RemoteProcessGroupEntity. + :type: PermissionsDTO """ - self._position = position + self._operate_permissions = operate_permissions + + @property + def output_port_count(self): + """ + Gets the output_port_count of this RemoteProcessGroupEntity. + The number of remote output ports currently available on the target. + + :return: The output_port_count of this RemoteProcessGroupEntity. + :rtype: int + """ + return self._output_port_count + + @output_port_count.setter + def output_port_count(self, output_port_count): + """ + Sets the output_port_count of this RemoteProcessGroupEntity. + The number of remote output ports currently available on the target. + + :param output_port_count: The output_port_count of this RemoteProcessGroupEntity. + :type: int + """ + + self._output_port_count = output_port_count @property def permissions(self): """ Gets the permissions of this RemoteProcessGroupEntity. - The permissions for this component. :return: The permissions of this RemoteProcessGroupEntity. :rtype: PermissionsDTO @@ -207,7 +268,6 @@ def permissions(self): def permissions(self, permissions): """ Sets the permissions of this RemoteProcessGroupEntity. - The permissions for this component. :param permissions: The permissions of this RemoteProcessGroupEntity. :type: PermissionsDTO @@ -216,77 +276,51 @@ def permissions(self, permissions): self._permissions = permissions @property - def bulletins(self): - """ - Gets the bulletins of this RemoteProcessGroupEntity. - The bulletins for this component. - - :return: The bulletins of this RemoteProcessGroupEntity. - :rtype: list[BulletinEntity] - """ - return self._bulletins - - @bulletins.setter - def bulletins(self, bulletins): - """ - Sets the bulletins of this RemoteProcessGroupEntity. - The bulletins for this component. - - :param bulletins: The bulletins of this RemoteProcessGroupEntity. - :type: list[BulletinEntity] - """ - - self._bulletins = bulletins - - @property - def disconnected_node_acknowledged(self): + def position(self): """ - Gets the disconnected_node_acknowledged of this RemoteProcessGroupEntity. - Acknowledges that this node is disconnected to allow for mutable requests to proceed. + Gets the position of this RemoteProcessGroupEntity. - :return: The disconnected_node_acknowledged of this RemoteProcessGroupEntity. - :rtype: bool + :return: The position of this RemoteProcessGroupEntity. + :rtype: PositionDTO """ - return self._disconnected_node_acknowledged + return self._position - @disconnected_node_acknowledged.setter - def disconnected_node_acknowledged(self, disconnected_node_acknowledged): + @position.setter + def position(self, position): """ - Sets the disconnected_node_acknowledged of this RemoteProcessGroupEntity. - Acknowledges that this node is disconnected to allow for mutable requests to proceed. + Sets the position of this RemoteProcessGroupEntity. - :param disconnected_node_acknowledged: The disconnected_node_acknowledged of this RemoteProcessGroupEntity. - :type: bool + :param position: The position of this RemoteProcessGroupEntity. + :type: PositionDTO """ - self._disconnected_node_acknowledged = disconnected_node_acknowledged + self._position = position @property - def component(self): + def revision(self): """ - Gets the component of this RemoteProcessGroupEntity. + Gets the revision of this RemoteProcessGroupEntity. - :return: The component of this RemoteProcessGroupEntity. - :rtype: RemoteProcessGroupDTO + :return: The revision of this RemoteProcessGroupEntity. + :rtype: RevisionDTO """ - return self._component + return self._revision - @component.setter - def component(self, component): + @revision.setter + def revision(self, revision): """ - Sets the component of this RemoteProcessGroupEntity. + Sets the revision of this RemoteProcessGroupEntity. - :param component: The component of this RemoteProcessGroupEntity. - :type: RemoteProcessGroupDTO + :param revision: The revision of this RemoteProcessGroupEntity. + :type: RevisionDTO """ - self._component = component + self._revision = revision @property def status(self): """ Gets the status of this RemoteProcessGroupEntity. - The status of the remote process group. :return: The status of this RemoteProcessGroupEntity. :rtype: RemoteProcessGroupStatusDTO @@ -297,7 +331,6 @@ def status(self): def status(self, status): """ Sets the status of this RemoteProcessGroupEntity. - The status of the remote process group. :param status: The status of this RemoteProcessGroupEntity. :type: RemoteProcessGroupStatusDTO @@ -306,73 +339,27 @@ def status(self, status): self._status = status @property - def input_port_count(self): - """ - Gets the input_port_count of this RemoteProcessGroupEntity. - The number of remote input ports currently available on the target. - - :return: The input_port_count of this RemoteProcessGroupEntity. - :rtype: int - """ - return self._input_port_count - - @input_port_count.setter - def input_port_count(self, input_port_count): - """ - Sets the input_port_count of this RemoteProcessGroupEntity. - The number of remote input ports currently available on the target. - - :param input_port_count: The input_port_count of this RemoteProcessGroupEntity. - :type: int - """ - - self._input_port_count = input_port_count - - @property - def output_port_count(self): - """ - Gets the output_port_count of this RemoteProcessGroupEntity. - The number of remote output ports currently available on the target. - - :return: The output_port_count of this RemoteProcessGroupEntity. - :rtype: int - """ - return self._output_port_count - - @output_port_count.setter - def output_port_count(self, output_port_count): - """ - Sets the output_port_count of this RemoteProcessGroupEntity. - The number of remote output ports currently available on the target. - - :param output_port_count: The output_port_count of this RemoteProcessGroupEntity. - :type: int - """ - - self._output_port_count = output_port_count - - @property - def operate_permissions(self): + def uri(self): """ - Gets the operate_permissions of this RemoteProcessGroupEntity. - The permissions for this component operations. + Gets the uri of this RemoteProcessGroupEntity. + The URI for futures requests to the component. - :return: The operate_permissions of this RemoteProcessGroupEntity. - :rtype: PermissionsDTO + :return: The uri of this RemoteProcessGroupEntity. + :rtype: str """ - return self._operate_permissions + return self._uri - @operate_permissions.setter - def operate_permissions(self, operate_permissions): + @uri.setter + def uri(self, uri): """ - Sets the operate_permissions of this RemoteProcessGroupEntity. - The permissions for this component operations. + Sets the uri of this RemoteProcessGroupEntity. + The URI for futures requests to the component. - :param operate_permissions: The operate_permissions of this RemoteProcessGroupEntity. - :type: PermissionsDTO + :param uri: The uri of this RemoteProcessGroupEntity. + :type: str """ - self._operate_permissions = operate_permissions + self._uri = uri def to_dict(self): """ diff --git a/nipyapi/nifi/models/remote_process_group_port_dto.py b/nipyapi/nifi/models/remote_process_group_port_dto.py index 49931d0f..ba15f163 100644 --- a/nipyapi/nifi/models/remote_process_group_port_dto.py +++ b/nipyapi/nifi/models/remote_process_group_port_dto.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,151 +27,193 @@ class RemoteProcessGroupPortDTO(object): and the value is json key in definition. """ swagger_types = { - 'id': 'str', - 'target_id': 'str', - 'versioned_component_id': 'str', - 'group_id': 'str', - 'name': 'str', - 'comments': 'str', - 'concurrently_schedulable_task_count': 'int', - 'transmitting': 'bool', - 'use_compression': 'bool', - 'exists': 'bool', - 'target_running': 'bool', - 'connected': 'bool', - 'batch_settings': 'BatchSettingsDTO' - } + 'batch_settings': 'BatchSettingsDTO', +'comments': 'str', +'concurrently_schedulable_task_count': 'int', +'connected': 'bool', +'exists': 'bool', +'group_id': 'str', +'id': 'str', +'name': 'str', +'target_id': 'str', +'target_running': 'bool', +'transmitting': 'bool', +'use_compression': 'bool', +'versioned_component_id': 'str' } attribute_map = { - 'id': 'id', - 'target_id': 'targetId', - 'versioned_component_id': 'versionedComponentId', - 'group_id': 'groupId', - 'name': 'name', - 'comments': 'comments', - 'concurrently_schedulable_task_count': 'concurrentlySchedulableTaskCount', - 'transmitting': 'transmitting', - 'use_compression': 'useCompression', - 'exists': 'exists', - 'target_running': 'targetRunning', - 'connected': 'connected', - 'batch_settings': 'batchSettings' - } - - def __init__(self, id=None, target_id=None, versioned_component_id=None, group_id=None, name=None, comments=None, concurrently_schedulable_task_count=None, transmitting=None, use_compression=None, exists=None, target_running=None, connected=None, batch_settings=None): + 'batch_settings': 'batchSettings', +'comments': 'comments', +'concurrently_schedulable_task_count': 'concurrentlySchedulableTaskCount', +'connected': 'connected', +'exists': 'exists', +'group_id': 'groupId', +'id': 'id', +'name': 'name', +'target_id': 'targetId', +'target_running': 'targetRunning', +'transmitting': 'transmitting', +'use_compression': 'useCompression', +'versioned_component_id': 'versionedComponentId' } + + def __init__(self, batch_settings=None, comments=None, concurrently_schedulable_task_count=None, connected=None, exists=None, group_id=None, id=None, name=None, target_id=None, target_running=None, transmitting=None, use_compression=None, versioned_component_id=None): """ RemoteProcessGroupPortDTO - a model defined in Swagger """ - self._id = None - self._target_id = None - self._versioned_component_id = None - self._group_id = None - self._name = None + self._batch_settings = None self._comments = None self._concurrently_schedulable_task_count = None - self._transmitting = None - self._use_compression = None + self._connected = None self._exists = None + self._group_id = None + self._id = None + self._name = None + self._target_id = None self._target_running = None - self._connected = None - self._batch_settings = None + self._transmitting = None + self._use_compression = None + self._versioned_component_id = None - if id is not None: - self.id = id - if target_id is not None: - self.target_id = target_id - if versioned_component_id is not None: - self.versioned_component_id = versioned_component_id - if group_id is not None: - self.group_id = group_id - if name is not None: - self.name = name + if batch_settings is not None: + self.batch_settings = batch_settings if comments is not None: self.comments = comments if concurrently_schedulable_task_count is not None: self.concurrently_schedulable_task_count = concurrently_schedulable_task_count - if transmitting is not None: - self.transmitting = transmitting - if use_compression is not None: - self.use_compression = use_compression + if connected is not None: + self.connected = connected if exists is not None: self.exists = exists + if group_id is not None: + self.group_id = group_id + if id is not None: + self.id = id + if name is not None: + self.name = name + if target_id is not None: + self.target_id = target_id if target_running is not None: self.target_running = target_running - if connected is not None: - self.connected = connected - if batch_settings is not None: - self.batch_settings = batch_settings + if transmitting is not None: + self.transmitting = transmitting + if use_compression is not None: + self.use_compression = use_compression + if versioned_component_id is not None: + self.versioned_component_id = versioned_component_id @property - def id(self): + def batch_settings(self): """ - Gets the id of this RemoteProcessGroupPortDTO. - The id of the port. + Gets the batch_settings of this RemoteProcessGroupPortDTO. - :return: The id of this RemoteProcessGroupPortDTO. - :rtype: str + :return: The batch_settings of this RemoteProcessGroupPortDTO. + :rtype: BatchSettingsDTO """ - return self._id + return self._batch_settings - @id.setter - def id(self, id): + @batch_settings.setter + def batch_settings(self, batch_settings): """ - Sets the id of this RemoteProcessGroupPortDTO. - The id of the port. + Sets the batch_settings of this RemoteProcessGroupPortDTO. - :param id: The id of this RemoteProcessGroupPortDTO. - :type: str + :param batch_settings: The batch_settings of this RemoteProcessGroupPortDTO. + :type: BatchSettingsDTO """ - self._id = id + self._batch_settings = batch_settings @property - def target_id(self): + def comments(self): """ - Gets the target_id of this RemoteProcessGroupPortDTO. - The id of the target port. + Gets the comments of this RemoteProcessGroupPortDTO. + The comments as configured on the target port. - :return: The target_id of this RemoteProcessGroupPortDTO. + :return: The comments of this RemoteProcessGroupPortDTO. :rtype: str """ - return self._target_id + return self._comments - @target_id.setter - def target_id(self, target_id): + @comments.setter + def comments(self, comments): """ - Sets the target_id of this RemoteProcessGroupPortDTO. - The id of the target port. + Sets the comments of this RemoteProcessGroupPortDTO. + The comments as configured on the target port. - :param target_id: The target_id of this RemoteProcessGroupPortDTO. + :param comments: The comments of this RemoteProcessGroupPortDTO. :type: str """ - self._target_id = target_id + self._comments = comments @property - def versioned_component_id(self): + def concurrently_schedulable_task_count(self): """ - Gets the versioned_component_id of this RemoteProcessGroupPortDTO. - The ID of the corresponding component that is under version control + Gets the concurrently_schedulable_task_count of this RemoteProcessGroupPortDTO. + The number of task that may transmit flowfiles to the target port concurrently. - :return: The versioned_component_id of this RemoteProcessGroupPortDTO. - :rtype: str + :return: The concurrently_schedulable_task_count of this RemoteProcessGroupPortDTO. + :rtype: int """ - return self._versioned_component_id + return self._concurrently_schedulable_task_count - @versioned_component_id.setter - def versioned_component_id(self, versioned_component_id): + @concurrently_schedulable_task_count.setter + def concurrently_schedulable_task_count(self, concurrently_schedulable_task_count): """ - Sets the versioned_component_id of this RemoteProcessGroupPortDTO. - The ID of the corresponding component that is under version control + Sets the concurrently_schedulable_task_count of this RemoteProcessGroupPortDTO. + The number of task that may transmit flowfiles to the target port concurrently. - :param versioned_component_id: The versioned_component_id of this RemoteProcessGroupPortDTO. - :type: str + :param concurrently_schedulable_task_count: The concurrently_schedulable_task_count of this RemoteProcessGroupPortDTO. + :type: int """ - self._versioned_component_id = versioned_component_id + self._concurrently_schedulable_task_count = concurrently_schedulable_task_count + + @property + def connected(self): + """ + Gets the connected of this RemoteProcessGroupPortDTO. + Whether the port has either an incoming or outgoing connection. + + :return: The connected of this RemoteProcessGroupPortDTO. + :rtype: bool + """ + return self._connected + + @connected.setter + def connected(self, connected): + """ + Sets the connected of this RemoteProcessGroupPortDTO. + Whether the port has either an incoming or outgoing connection. + + :param connected: The connected of this RemoteProcessGroupPortDTO. + :type: bool + """ + + self._connected = connected + + @property + def exists(self): + """ + Gets the exists of this RemoteProcessGroupPortDTO. + Whether the target port exists. + + :return: The exists of this RemoteProcessGroupPortDTO. + :rtype: bool + """ + return self._exists + + @exists.setter + def exists(self, exists): + """ + Sets the exists of this RemoteProcessGroupPortDTO. + Whether the target port exists. + + :param exists: The exists of this RemoteProcessGroupPortDTO. + :type: bool + """ + + self._exists = exists @property def group_id(self): @@ -197,6 +238,29 @@ def group_id(self, group_id): self._group_id = group_id + @property + def id(self): + """ + Gets the id of this RemoteProcessGroupPortDTO. + The id of the port. + + :return: The id of this RemoteProcessGroupPortDTO. + :rtype: str + """ + return self._id + + @id.setter + def id(self, id): + """ + Sets the id of this RemoteProcessGroupPortDTO. + The id of the port. + + :param id: The id of this RemoteProcessGroupPortDTO. + :type: str + """ + + self._id = id + @property def name(self): """ @@ -221,50 +285,50 @@ def name(self, name): self._name = name @property - def comments(self): + def target_id(self): """ - Gets the comments of this RemoteProcessGroupPortDTO. - The comments as configured on the target port. + Gets the target_id of this RemoteProcessGroupPortDTO. + The id of the target port. - :return: The comments of this RemoteProcessGroupPortDTO. + :return: The target_id of this RemoteProcessGroupPortDTO. :rtype: str """ - return self._comments + return self._target_id - @comments.setter - def comments(self, comments): + @target_id.setter + def target_id(self, target_id): """ - Sets the comments of this RemoteProcessGroupPortDTO. - The comments as configured on the target port. + Sets the target_id of this RemoteProcessGroupPortDTO. + The id of the target port. - :param comments: The comments of this RemoteProcessGroupPortDTO. + :param target_id: The target_id of this RemoteProcessGroupPortDTO. :type: str """ - self._comments = comments + self._target_id = target_id @property - def concurrently_schedulable_task_count(self): + def target_running(self): """ - Gets the concurrently_schedulable_task_count of this RemoteProcessGroupPortDTO. - The number of task that may transmit flowfiles to the target port concurrently. + Gets the target_running of this RemoteProcessGroupPortDTO. + Whether the target port is running. - :return: The concurrently_schedulable_task_count of this RemoteProcessGroupPortDTO. - :rtype: int + :return: The target_running of this RemoteProcessGroupPortDTO. + :rtype: bool """ - return self._concurrently_schedulable_task_count + return self._target_running - @concurrently_schedulable_task_count.setter - def concurrently_schedulable_task_count(self, concurrently_schedulable_task_count): + @target_running.setter + def target_running(self, target_running): """ - Sets the concurrently_schedulable_task_count of this RemoteProcessGroupPortDTO. - The number of task that may transmit flowfiles to the target port concurrently. + Sets the target_running of this RemoteProcessGroupPortDTO. + Whether the target port is running. - :param concurrently_schedulable_task_count: The concurrently_schedulable_task_count of this RemoteProcessGroupPortDTO. - :type: int + :param target_running: The target_running of this RemoteProcessGroupPortDTO. + :type: bool """ - self._concurrently_schedulable_task_count = concurrently_schedulable_task_count + self._target_running = target_running @property def transmitting(self): @@ -313,96 +377,27 @@ def use_compression(self, use_compression): self._use_compression = use_compression @property - def exists(self): - """ - Gets the exists of this RemoteProcessGroupPortDTO. - Whether the target port exists. - - :return: The exists of this RemoteProcessGroupPortDTO. - :rtype: bool - """ - return self._exists - - @exists.setter - def exists(self, exists): - """ - Sets the exists of this RemoteProcessGroupPortDTO. - Whether the target port exists. - - :param exists: The exists of this RemoteProcessGroupPortDTO. - :type: bool - """ - - self._exists = exists - - @property - def target_running(self): - """ - Gets the target_running of this RemoteProcessGroupPortDTO. - Whether the target port is running. - - :return: The target_running of this RemoteProcessGroupPortDTO. - :rtype: bool - """ - return self._target_running - - @target_running.setter - def target_running(self, target_running): - """ - Sets the target_running of this RemoteProcessGroupPortDTO. - Whether the target port is running. - - :param target_running: The target_running of this RemoteProcessGroupPortDTO. - :type: bool - """ - - self._target_running = target_running - - @property - def connected(self): - """ - Gets the connected of this RemoteProcessGroupPortDTO. - Whether the port has either an incoming or outgoing connection. - - :return: The connected of this RemoteProcessGroupPortDTO. - :rtype: bool - """ - return self._connected - - @connected.setter - def connected(self, connected): - """ - Sets the connected of this RemoteProcessGroupPortDTO. - Whether the port has either an incoming or outgoing connection. - - :param connected: The connected of this RemoteProcessGroupPortDTO. - :type: bool - """ - - self._connected = connected - - @property - def batch_settings(self): + def versioned_component_id(self): """ - Gets the batch_settings of this RemoteProcessGroupPortDTO. - The batch settings for data transmission. + Gets the versioned_component_id of this RemoteProcessGroupPortDTO. + The ID of the corresponding component that is under version control - :return: The batch_settings of this RemoteProcessGroupPortDTO. - :rtype: BatchSettingsDTO + :return: The versioned_component_id of this RemoteProcessGroupPortDTO. + :rtype: str """ - return self._batch_settings + return self._versioned_component_id - @batch_settings.setter - def batch_settings(self, batch_settings): + @versioned_component_id.setter + def versioned_component_id(self, versioned_component_id): """ - Sets the batch_settings of this RemoteProcessGroupPortDTO. - The batch settings for data transmission. + Sets the versioned_component_id of this RemoteProcessGroupPortDTO. + The ID of the corresponding component that is under version control - :param batch_settings: The batch_settings of this RemoteProcessGroupPortDTO. - :type: BatchSettingsDTO + :param versioned_component_id: The versioned_component_id of this RemoteProcessGroupPortDTO. + :type: str """ - self._batch_settings = batch_settings + self._versioned_component_id = versioned_component_id def to_dict(self): """ diff --git a/nipyapi/nifi/models/remote_process_group_port_entity.py b/nipyapi/nifi/models/remote_process_group_port_entity.py index 5ad51369..07c412a8 100644 --- a/nipyapi/nifi/models/remote_process_group_port_entity.py +++ b/nipyapi/nifi/models/remote_process_group_port_entity.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,85 +27,106 @@ class RemoteProcessGroupPortEntity(object): and the value is json key in definition. """ swagger_types = { - 'revision': 'RevisionDTO', - 'id': 'str', - 'uri': 'str', - 'position': 'PositionDTO', - 'permissions': 'PermissionsDTO', 'bulletins': 'list[BulletinEntity]', - 'disconnected_node_acknowledged': 'bool', - 'remote_process_group_port': 'RemoteProcessGroupPortDTO', - 'operate_permissions': 'PermissionsDTO' - } +'disconnected_node_acknowledged': 'bool', +'id': 'str', +'operate_permissions': 'PermissionsDTO', +'permissions': 'PermissionsDTO', +'position': 'PositionDTO', +'remote_process_group_port': 'RemoteProcessGroupPortDTO', +'revision': 'RevisionDTO', +'uri': 'str' } attribute_map = { - 'revision': 'revision', - 'id': 'id', - 'uri': 'uri', - 'position': 'position', - 'permissions': 'permissions', 'bulletins': 'bulletins', - 'disconnected_node_acknowledged': 'disconnectedNodeAcknowledged', - 'remote_process_group_port': 'remoteProcessGroupPort', - 'operate_permissions': 'operatePermissions' - } +'disconnected_node_acknowledged': 'disconnectedNodeAcknowledged', +'id': 'id', +'operate_permissions': 'operatePermissions', +'permissions': 'permissions', +'position': 'position', +'remote_process_group_port': 'remoteProcessGroupPort', +'revision': 'revision', +'uri': 'uri' } - def __init__(self, revision=None, id=None, uri=None, position=None, permissions=None, bulletins=None, disconnected_node_acknowledged=None, remote_process_group_port=None, operate_permissions=None): + def __init__(self, bulletins=None, disconnected_node_acknowledged=None, id=None, operate_permissions=None, permissions=None, position=None, remote_process_group_port=None, revision=None, uri=None): """ RemoteProcessGroupPortEntity - a model defined in Swagger """ - self._revision = None - self._id = None - self._uri = None - self._position = None - self._permissions = None self._bulletins = None self._disconnected_node_acknowledged = None - self._remote_process_group_port = None + self._id = None self._operate_permissions = None + self._permissions = None + self._position = None + self._remote_process_group_port = None + self._revision = None + self._uri = None - if revision is not None: - self.revision = revision - if id is not None: - self.id = id - if uri is not None: - self.uri = uri - if position is not None: - self.position = position - if permissions is not None: - self.permissions = permissions if bulletins is not None: self.bulletins = bulletins if disconnected_node_acknowledged is not None: self.disconnected_node_acknowledged = disconnected_node_acknowledged - if remote_process_group_port is not None: - self.remote_process_group_port = remote_process_group_port + if id is not None: + self.id = id if operate_permissions is not None: self.operate_permissions = operate_permissions + if permissions is not None: + self.permissions = permissions + if position is not None: + self.position = position + if remote_process_group_port is not None: + self.remote_process_group_port = remote_process_group_port + if revision is not None: + self.revision = revision + if uri is not None: + self.uri = uri @property - def revision(self): + def bulletins(self): """ - Gets the revision of this RemoteProcessGroupPortEntity. - The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses. + Gets the bulletins of this RemoteProcessGroupPortEntity. + The bulletins for this component. - :return: The revision of this RemoteProcessGroupPortEntity. - :rtype: RevisionDTO + :return: The bulletins of this RemoteProcessGroupPortEntity. + :rtype: list[BulletinEntity] """ - return self._revision + return self._bulletins - @revision.setter - def revision(self, revision): + @bulletins.setter + def bulletins(self, bulletins): """ - Sets the revision of this RemoteProcessGroupPortEntity. - The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses. + Sets the bulletins of this RemoteProcessGroupPortEntity. + The bulletins for this component. - :param revision: The revision of this RemoteProcessGroupPortEntity. - :type: RevisionDTO + :param bulletins: The bulletins of this RemoteProcessGroupPortEntity. + :type: list[BulletinEntity] """ - self._revision = revision + self._bulletins = bulletins + + @property + def disconnected_node_acknowledged(self): + """ + Gets the disconnected_node_acknowledged of this RemoteProcessGroupPortEntity. + Acknowledges that this node is disconnected to allow for mutable requests to proceed. + + :return: The disconnected_node_acknowledged of this RemoteProcessGroupPortEntity. + :rtype: bool + """ + return self._disconnected_node_acknowledged + + @disconnected_node_acknowledged.setter + def disconnected_node_acknowledged(self, disconnected_node_acknowledged): + """ + Sets the disconnected_node_acknowledged of this RemoteProcessGroupPortEntity. + Acknowledges that this node is disconnected to allow for mutable requests to proceed. + + :param disconnected_node_acknowledged: The disconnected_node_acknowledged of this RemoteProcessGroupPortEntity. + :type: bool + """ + + self._disconnected_node_acknowledged = disconnected_node_acknowledged @property def id(self): @@ -132,56 +152,30 @@ def id(self, id): self._id = id @property - def uri(self): - """ - Gets the uri of this RemoteProcessGroupPortEntity. - The URI for futures requests to the component. - - :return: The uri of this RemoteProcessGroupPortEntity. - :rtype: str - """ - return self._uri - - @uri.setter - def uri(self, uri): - """ - Sets the uri of this RemoteProcessGroupPortEntity. - The URI for futures requests to the component. - - :param uri: The uri of this RemoteProcessGroupPortEntity. - :type: str - """ - - self._uri = uri - - @property - def position(self): + def operate_permissions(self): """ - Gets the position of this RemoteProcessGroupPortEntity. - The position of this component in the UI if applicable. + Gets the operate_permissions of this RemoteProcessGroupPortEntity. - :return: The position of this RemoteProcessGroupPortEntity. - :rtype: PositionDTO + :return: The operate_permissions of this RemoteProcessGroupPortEntity. + :rtype: PermissionsDTO """ - return self._position + return self._operate_permissions - @position.setter - def position(self, position): + @operate_permissions.setter + def operate_permissions(self, operate_permissions): """ - Sets the position of this RemoteProcessGroupPortEntity. - The position of this component in the UI if applicable. + Sets the operate_permissions of this RemoteProcessGroupPortEntity. - :param position: The position of this RemoteProcessGroupPortEntity. - :type: PositionDTO + :param operate_permissions: The operate_permissions of this RemoteProcessGroupPortEntity. + :type: PermissionsDTO """ - self._position = position + self._operate_permissions = operate_permissions @property def permissions(self): """ Gets the permissions of this RemoteProcessGroupPortEntity. - The permissions for this component. :return: The permissions of this RemoteProcessGroupPortEntity. :rtype: PermissionsDTO @@ -192,7 +186,6 @@ def permissions(self): def permissions(self, permissions): """ Sets the permissions of this RemoteProcessGroupPortEntity. - The permissions for this component. :param permissions: The permissions of this RemoteProcessGroupPortEntity. :type: PermissionsDTO @@ -201,50 +194,25 @@ def permissions(self, permissions): self._permissions = permissions @property - def bulletins(self): - """ - Gets the bulletins of this RemoteProcessGroupPortEntity. - The bulletins for this component. - - :return: The bulletins of this RemoteProcessGroupPortEntity. - :rtype: list[BulletinEntity] - """ - return self._bulletins - - @bulletins.setter - def bulletins(self, bulletins): - """ - Sets the bulletins of this RemoteProcessGroupPortEntity. - The bulletins for this component. - - :param bulletins: The bulletins of this RemoteProcessGroupPortEntity. - :type: list[BulletinEntity] - """ - - self._bulletins = bulletins - - @property - def disconnected_node_acknowledged(self): + def position(self): """ - Gets the disconnected_node_acknowledged of this RemoteProcessGroupPortEntity. - Acknowledges that this node is disconnected to allow for mutable requests to proceed. + Gets the position of this RemoteProcessGroupPortEntity. - :return: The disconnected_node_acknowledged of this RemoteProcessGroupPortEntity. - :rtype: bool + :return: The position of this RemoteProcessGroupPortEntity. + :rtype: PositionDTO """ - return self._disconnected_node_acknowledged + return self._position - @disconnected_node_acknowledged.setter - def disconnected_node_acknowledged(self, disconnected_node_acknowledged): + @position.setter + def position(self, position): """ - Sets the disconnected_node_acknowledged of this RemoteProcessGroupPortEntity. - Acknowledges that this node is disconnected to allow for mutable requests to proceed. + Sets the position of this RemoteProcessGroupPortEntity. - :param disconnected_node_acknowledged: The disconnected_node_acknowledged of this RemoteProcessGroupPortEntity. - :type: bool + :param position: The position of this RemoteProcessGroupPortEntity. + :type: PositionDTO """ - self._disconnected_node_acknowledged = disconnected_node_acknowledged + self._position = position @property def remote_process_group_port(self): @@ -268,27 +236,48 @@ def remote_process_group_port(self, remote_process_group_port): self._remote_process_group_port = remote_process_group_port @property - def operate_permissions(self): + def revision(self): """ - Gets the operate_permissions of this RemoteProcessGroupPortEntity. - The permissions for this component operations. + Gets the revision of this RemoteProcessGroupPortEntity. - :return: The operate_permissions of this RemoteProcessGroupPortEntity. - :rtype: PermissionsDTO + :return: The revision of this RemoteProcessGroupPortEntity. + :rtype: RevisionDTO """ - return self._operate_permissions + return self._revision - @operate_permissions.setter - def operate_permissions(self, operate_permissions): + @revision.setter + def revision(self, revision): """ - Sets the operate_permissions of this RemoteProcessGroupPortEntity. - The permissions for this component operations. + Sets the revision of this RemoteProcessGroupPortEntity. - :param operate_permissions: The operate_permissions of this RemoteProcessGroupPortEntity. - :type: PermissionsDTO + :param revision: The revision of this RemoteProcessGroupPortEntity. + :type: RevisionDTO """ - self._operate_permissions = operate_permissions + self._revision = revision + + @property + def uri(self): + """ + Gets the uri of this RemoteProcessGroupPortEntity. + The URI for futures requests to the component. + + :return: The uri of this RemoteProcessGroupPortEntity. + :rtype: str + """ + return self._uri + + @uri.setter + def uri(self, uri): + """ + Sets the uri of this RemoteProcessGroupPortEntity. + The URI for futures requests to the component. + + :param uri: The uri of this RemoteProcessGroupPortEntity. + :type: str + """ + + self._uri = uri def to_dict(self): """ diff --git a/nipyapi/nifi/models/remote_process_group_status_dto.py b/nipyapi/nifi/models/remote_process_group_status_dto.py index 3c267faf..f3c1efc2 100644 --- a/nipyapi/nifi/models/remote_process_group_status_dto.py +++ b/nipyapi/nifi/models/remote_process_group_status_dto.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,62 +27,81 @@ class RemoteProcessGroupStatusDTO(object): and the value is json key in definition. """ swagger_types = { - 'group_id': 'str', - 'id': 'str', - 'name': 'str', - 'target_uri': 'str', - 'transmission_status': 'str', - 'stats_last_refreshed': 'str', - 'validation_status': 'str', 'aggregate_snapshot': 'RemoteProcessGroupStatusSnapshotDTO', - 'node_snapshots': 'list[NodeRemoteProcessGroupStatusSnapshotDTO]' - } +'group_id': 'str', +'id': 'str', +'name': 'str', +'node_snapshots': 'list[NodeRemoteProcessGroupStatusSnapshotDTO]', +'stats_last_refreshed': 'str', +'target_uri': 'str', +'transmission_status': 'str', +'validation_status': 'str' } attribute_map = { - 'group_id': 'groupId', - 'id': 'id', - 'name': 'name', - 'target_uri': 'targetUri', - 'transmission_status': 'transmissionStatus', - 'stats_last_refreshed': 'statsLastRefreshed', - 'validation_status': 'validationStatus', 'aggregate_snapshot': 'aggregateSnapshot', - 'node_snapshots': 'nodeSnapshots' - } +'group_id': 'groupId', +'id': 'id', +'name': 'name', +'node_snapshots': 'nodeSnapshots', +'stats_last_refreshed': 'statsLastRefreshed', +'target_uri': 'targetUri', +'transmission_status': 'transmissionStatus', +'validation_status': 'validationStatus' } - def __init__(self, group_id=None, id=None, name=None, target_uri=None, transmission_status=None, stats_last_refreshed=None, validation_status=None, aggregate_snapshot=None, node_snapshots=None): + def __init__(self, aggregate_snapshot=None, group_id=None, id=None, name=None, node_snapshots=None, stats_last_refreshed=None, target_uri=None, transmission_status=None, validation_status=None): """ RemoteProcessGroupStatusDTO - a model defined in Swagger """ + self._aggregate_snapshot = None self._group_id = None self._id = None self._name = None + self._node_snapshots = None + self._stats_last_refreshed = None self._target_uri = None self._transmission_status = None - self._stats_last_refreshed = None self._validation_status = None - self._aggregate_snapshot = None - self._node_snapshots = None + if aggregate_snapshot is not None: + self.aggregate_snapshot = aggregate_snapshot if group_id is not None: self.group_id = group_id if id is not None: self.id = id if name is not None: self.name = name + if node_snapshots is not None: + self.node_snapshots = node_snapshots + if stats_last_refreshed is not None: + self.stats_last_refreshed = stats_last_refreshed if target_uri is not None: self.target_uri = target_uri if transmission_status is not None: self.transmission_status = transmission_status - if stats_last_refreshed is not None: - self.stats_last_refreshed = stats_last_refreshed if validation_status is not None: self.validation_status = validation_status - if aggregate_snapshot is not None: - self.aggregate_snapshot = aggregate_snapshot - if node_snapshots is not None: - self.node_snapshots = node_snapshots + + @property + def aggregate_snapshot(self): + """ + Gets the aggregate_snapshot of this RemoteProcessGroupStatusDTO. + + :return: The aggregate_snapshot of this RemoteProcessGroupStatusDTO. + :rtype: RemoteProcessGroupStatusSnapshotDTO + """ + return self._aggregate_snapshot + + @aggregate_snapshot.setter + def aggregate_snapshot(self, aggregate_snapshot): + """ + Sets the aggregate_snapshot of this RemoteProcessGroupStatusDTO. + + :param aggregate_snapshot: The aggregate_snapshot of this RemoteProcessGroupStatusDTO. + :type: RemoteProcessGroupStatusSnapshotDTO + """ + + self._aggregate_snapshot = aggregate_snapshot @property def group_id(self): @@ -154,6 +172,52 @@ def name(self, name): self._name = name + @property + def node_snapshots(self): + """ + Gets the node_snapshots of this RemoteProcessGroupStatusDTO. + A status snapshot for each node in the cluster. If the NiFi instance is a standalone instance, rather than a cluster, this may be null. + + :return: The node_snapshots of this RemoteProcessGroupStatusDTO. + :rtype: list[NodeRemoteProcessGroupStatusSnapshotDTO] + """ + return self._node_snapshots + + @node_snapshots.setter + def node_snapshots(self, node_snapshots): + """ + Sets the node_snapshots of this RemoteProcessGroupStatusDTO. + A status snapshot for each node in the cluster. If the NiFi instance is a standalone instance, rather than a cluster, this may be null. + + :param node_snapshots: The node_snapshots of this RemoteProcessGroupStatusDTO. + :type: list[NodeRemoteProcessGroupStatusSnapshotDTO] + """ + + self._node_snapshots = node_snapshots + + @property + def stats_last_refreshed(self): + """ + Gets the stats_last_refreshed of this RemoteProcessGroupStatusDTO. + The time the status for the process group was last refreshed. + + :return: The stats_last_refreshed of this RemoteProcessGroupStatusDTO. + :rtype: str + """ + return self._stats_last_refreshed + + @stats_last_refreshed.setter + def stats_last_refreshed(self, stats_last_refreshed): + """ + Sets the stats_last_refreshed of this RemoteProcessGroupStatusDTO. + The time the status for the process group was last refreshed. + + :param stats_last_refreshed: The stats_last_refreshed of this RemoteProcessGroupStatusDTO. + :type: str + """ + + self._stats_last_refreshed = stats_last_refreshed + @property def target_uri(self): """ @@ -200,29 +264,6 @@ def transmission_status(self, transmission_status): self._transmission_status = transmission_status - @property - def stats_last_refreshed(self): - """ - Gets the stats_last_refreshed of this RemoteProcessGroupStatusDTO. - The time the status for the process group was last refreshed. - - :return: The stats_last_refreshed of this RemoteProcessGroupStatusDTO. - :rtype: str - """ - return self._stats_last_refreshed - - @stats_last_refreshed.setter - def stats_last_refreshed(self, stats_last_refreshed): - """ - Sets the stats_last_refreshed of this RemoteProcessGroupStatusDTO. - The time the status for the process group was last refreshed. - - :param stats_last_refreshed: The stats_last_refreshed of this RemoteProcessGroupStatusDTO. - :type: str - """ - - self._stats_last_refreshed = stats_last_refreshed - @property def validation_status(self): """ @@ -243,7 +284,7 @@ def validation_status(self, validation_status): :param validation_status: The validation_status of this RemoteProcessGroupStatusDTO. :type: str """ - allowed_values = ["VALID", "INVALID", "VALIDATING"] + 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}" @@ -252,52 +293,6 @@ def validation_status(self, validation_status): self._validation_status = validation_status - @property - def aggregate_snapshot(self): - """ - Gets the aggregate_snapshot of this RemoteProcessGroupStatusDTO. - A status snapshot that represents the aggregate stats of all nodes in the cluster. If the NiFi instance is a standalone instance, rather than a cluster, this represents the stats of the single instance. - - :return: The aggregate_snapshot of this RemoteProcessGroupStatusDTO. - :rtype: RemoteProcessGroupStatusSnapshotDTO - """ - return self._aggregate_snapshot - - @aggregate_snapshot.setter - def aggregate_snapshot(self, aggregate_snapshot): - """ - Sets the aggregate_snapshot of this RemoteProcessGroupStatusDTO. - A status snapshot that represents the aggregate stats of all nodes in the cluster. If the NiFi instance is a standalone instance, rather than a cluster, this represents the stats of the single instance. - - :param aggregate_snapshot: The aggregate_snapshot of this RemoteProcessGroupStatusDTO. - :type: RemoteProcessGroupStatusSnapshotDTO - """ - - self._aggregate_snapshot = aggregate_snapshot - - @property - def node_snapshots(self): - """ - Gets the node_snapshots of this RemoteProcessGroupStatusDTO. - A status snapshot for each node in the cluster. If the NiFi instance is a standalone instance, rather than a cluster, this may be null. - - :return: The node_snapshots of this RemoteProcessGroupStatusDTO. - :rtype: list[NodeRemoteProcessGroupStatusSnapshotDTO] - """ - return self._node_snapshots - - @node_snapshots.setter - def node_snapshots(self, node_snapshots): - """ - Sets the node_snapshots of this RemoteProcessGroupStatusDTO. - A status snapshot for each node in the cluster. If the NiFi instance is a standalone instance, rather than a cluster, this may be null. - - :param node_snapshots: The node_snapshots of this RemoteProcessGroupStatusDTO. - :type: list[NodeRemoteProcessGroupStatusSnapshotDTO] - """ - - self._node_snapshots = node_snapshots - def to_dict(self): """ Returns the model properties as a dict diff --git a/nipyapi/nifi/models/remote_process_group_status_entity.py b/nipyapi/nifi/models/remote_process_group_status_entity.py index 01caf5bd..33382a79 100644 --- a/nipyapi/nifi/models/remote_process_group_status_entity.py +++ b/nipyapi/nifi/models/remote_process_group_status_entity.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,48 +27,25 @@ class RemoteProcessGroupStatusEntity(object): and the value is json key in definition. """ swagger_types = { - 'remote_process_group_status': 'RemoteProcessGroupStatusDTO', - 'can_read': 'bool' - } + 'can_read': 'bool', +'remote_process_group_status': 'RemoteProcessGroupStatusDTO' } attribute_map = { - 'remote_process_group_status': 'remoteProcessGroupStatus', - 'can_read': 'canRead' - } + 'can_read': 'canRead', +'remote_process_group_status': 'remoteProcessGroupStatus' } - def __init__(self, remote_process_group_status=None, can_read=None): + def __init__(self, can_read=None, remote_process_group_status=None): """ RemoteProcessGroupStatusEntity - a model defined in Swagger """ - self._remote_process_group_status = None self._can_read = None + self._remote_process_group_status = None - if remote_process_group_status is not None: - self.remote_process_group_status = remote_process_group_status if can_read is not None: self.can_read = can_read - - @property - def remote_process_group_status(self): - """ - Gets the remote_process_group_status of this RemoteProcessGroupStatusEntity. - - :return: The remote_process_group_status of this RemoteProcessGroupStatusEntity. - :rtype: RemoteProcessGroupStatusDTO - """ - return self._remote_process_group_status - - @remote_process_group_status.setter - def remote_process_group_status(self, remote_process_group_status): - """ - Sets the remote_process_group_status of this RemoteProcessGroupStatusEntity. - - :param remote_process_group_status: The remote_process_group_status of this RemoteProcessGroupStatusEntity. - :type: RemoteProcessGroupStatusDTO - """ - - self._remote_process_group_status = remote_process_group_status + if remote_process_group_status is not None: + self.remote_process_group_status = remote_process_group_status @property def can_read(self): @@ -94,6 +70,27 @@ def can_read(self, can_read): self._can_read = can_read + @property + def remote_process_group_status(self): + """ + Gets the remote_process_group_status of this RemoteProcessGroupStatusEntity. + + :return: The remote_process_group_status of this RemoteProcessGroupStatusEntity. + :rtype: RemoteProcessGroupStatusDTO + """ + return self._remote_process_group_status + + @remote_process_group_status.setter + def remote_process_group_status(self, remote_process_group_status): + """ + Sets the remote_process_group_status of this RemoteProcessGroupStatusEntity. + + :param remote_process_group_status: The remote_process_group_status of this RemoteProcessGroupStatusEntity. + :type: RemoteProcessGroupStatusDTO + """ + + self._remote_process_group_status = remote_process_group_status + def to_dict(self): """ Returns the model properties as a dict 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 c9053da8..4b5bcd3e 100644 --- a/nipyapi/nifi/models/remote_process_group_status_snapshot_dto.py +++ b/nipyapi/nifi/models/remote_process_group_status_snapshot_dto.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,261 +27,282 @@ class RemoteProcessGroupStatusSnapshotDTO(object): and the value is json key in definition. """ swagger_types = { - 'id': 'str', - 'group_id': 'str', - 'name': 'str', - 'target_uri': 'str', - 'transmission_status': 'str', 'active_thread_count': 'int', - 'flow_files_sent': 'int', - 'bytes_sent': 'int', - 'sent': 'str', - 'flow_files_received': 'int', - 'bytes_received': 'int', - 'received': 'str' - } +'bytes_received': 'int', +'bytes_sent': 'int', +'flow_files_received': 'int', +'flow_files_sent': 'int', +'group_id': 'str', +'id': 'str', +'name': 'str', +'received': 'str', +'sent': 'str', +'target_uri': 'str', +'transmission_status': 'str' } attribute_map = { - 'id': 'id', - 'group_id': 'groupId', - 'name': 'name', - 'target_uri': 'targetUri', - 'transmission_status': 'transmissionStatus', 'active_thread_count': 'activeThreadCount', - 'flow_files_sent': 'flowFilesSent', - 'bytes_sent': 'bytesSent', - 'sent': 'sent', - 'flow_files_received': 'flowFilesReceived', - 'bytes_received': 'bytesReceived', - 'received': 'received' - } - - def __init__(self, id=None, group_id=None, name=None, target_uri=None, transmission_status=None, active_thread_count=None, flow_files_sent=None, bytes_sent=None, sent=None, flow_files_received=None, bytes_received=None, received=None): +'bytes_received': 'bytesReceived', +'bytes_sent': 'bytesSent', +'flow_files_received': 'flowFilesReceived', +'flow_files_sent': 'flowFilesSent', +'group_id': 'groupId', +'id': 'id', +'name': 'name', +'received': 'received', +'sent': 'sent', +'target_uri': 'targetUri', +'transmission_status': 'transmissionStatus' } + + def __init__(self, active_thread_count=None, bytes_received=None, bytes_sent=None, flow_files_received=None, flow_files_sent=None, group_id=None, id=None, name=None, received=None, sent=None, target_uri=None, transmission_status=None): """ RemoteProcessGroupStatusSnapshotDTO - a model defined in Swagger """ - self._id = None - self._group_id = None - self._name = None - self._target_uri = None - self._transmission_status = None self._active_thread_count = None - self._flow_files_sent = None + self._bytes_received = None self._bytes_sent = None - self._sent = None self._flow_files_received = None - self._bytes_received = None + self._flow_files_sent = None + self._group_id = None + self._id = None + self._name = None self._received = None + self._sent = None + self._target_uri = None + self._transmission_status = None - if id is not None: - self.id = id - if group_id is not None: - self.group_id = group_id - if name is not None: - self.name = name - if target_uri is not None: - self.target_uri = target_uri - if transmission_status is not None: - self.transmission_status = transmission_status if active_thread_count is not None: self.active_thread_count = active_thread_count - if flow_files_sent is not None: - self.flow_files_sent = flow_files_sent + if bytes_received is not None: + self.bytes_received = bytes_received if bytes_sent is not None: self.bytes_sent = bytes_sent - if sent is not None: - self.sent = sent if flow_files_received is not None: self.flow_files_received = flow_files_received - if bytes_received is not None: - self.bytes_received = bytes_received + if flow_files_sent is not None: + self.flow_files_sent = flow_files_sent + if group_id is not None: + self.group_id = group_id + if id is not None: + self.id = id + if name is not None: + self.name = name if received is not None: self.received = received + if sent is not None: + self.sent = sent + if target_uri is not None: + self.target_uri = target_uri + if transmission_status is not None: + self.transmission_status = transmission_status @property - def id(self): + def active_thread_count(self): """ - Gets the id of this RemoteProcessGroupStatusSnapshotDTO. - The id of the remote process group. + Gets the active_thread_count of this RemoteProcessGroupStatusSnapshotDTO. + The number of active threads for the remote process group. - :return: The id of this RemoteProcessGroupStatusSnapshotDTO. - :rtype: str + :return: The active_thread_count of this RemoteProcessGroupStatusSnapshotDTO. + :rtype: int """ - return self._id + return self._active_thread_count - @id.setter - def id(self, id): + @active_thread_count.setter + def active_thread_count(self, active_thread_count): """ - Sets the id of this RemoteProcessGroupStatusSnapshotDTO. - The id of the remote process group. + Sets the active_thread_count of this RemoteProcessGroupStatusSnapshotDTO. + The number of active threads for the remote process group. - :param id: The id of this RemoteProcessGroupStatusSnapshotDTO. - :type: str + :param active_thread_count: The active_thread_count of this RemoteProcessGroupStatusSnapshotDTO. + :type: int """ - self._id = id + self._active_thread_count = active_thread_count @property - def group_id(self): + def bytes_received(self): """ - Gets the group_id of this RemoteProcessGroupStatusSnapshotDTO. - The id of the parent process group the remote process group resides in. + Gets the bytes_received of this RemoteProcessGroupStatusSnapshotDTO. + The size of the FlowFiles received from the remote process group in the last 5 minutes. - :return: The group_id of this RemoteProcessGroupStatusSnapshotDTO. - :rtype: str + :return: The bytes_received of this RemoteProcessGroupStatusSnapshotDTO. + :rtype: int """ - return self._group_id + return self._bytes_received - @group_id.setter - def group_id(self, group_id): + @bytes_received.setter + def bytes_received(self, bytes_received): """ - Sets the group_id of this RemoteProcessGroupStatusSnapshotDTO. - The id of the parent process group the remote process group resides in. + Sets the bytes_received of this RemoteProcessGroupStatusSnapshotDTO. + The size of the FlowFiles received from the remote process group in the last 5 minutes. - :param group_id: The group_id of this RemoteProcessGroupStatusSnapshotDTO. - :type: str + :param bytes_received: The bytes_received of this RemoteProcessGroupStatusSnapshotDTO. + :type: int """ - self._group_id = group_id + self._bytes_received = bytes_received @property - def name(self): + def bytes_sent(self): """ - Gets the name of this RemoteProcessGroupStatusSnapshotDTO. - The name of the remote process group. + Gets the bytes_sent of this RemoteProcessGroupStatusSnapshotDTO. + The size of the FlowFiles sent to the remote process group in the last 5 minutes. - :return: The name of this RemoteProcessGroupStatusSnapshotDTO. - :rtype: str + :return: The bytes_sent of this RemoteProcessGroupStatusSnapshotDTO. + :rtype: int """ - return self._name + return self._bytes_sent - @name.setter - def name(self, name): + @bytes_sent.setter + def bytes_sent(self, bytes_sent): """ - Sets the name of this RemoteProcessGroupStatusSnapshotDTO. - The name of the remote process group. + Sets the bytes_sent of this RemoteProcessGroupStatusSnapshotDTO. + The size of the FlowFiles sent to the remote process group in the last 5 minutes. - :param name: The name of this RemoteProcessGroupStatusSnapshotDTO. - :type: str + :param bytes_sent: The bytes_sent of this RemoteProcessGroupStatusSnapshotDTO. + :type: int """ - self._name = name + self._bytes_sent = bytes_sent @property - def target_uri(self): + def flow_files_received(self): """ - Gets the target_uri of this RemoteProcessGroupStatusSnapshotDTO. - The URI of the target system. + Gets the flow_files_received of this RemoteProcessGroupStatusSnapshotDTO. + The number of FlowFiles received from the remote process group in the last 5 minutes. - :return: The target_uri of this RemoteProcessGroupStatusSnapshotDTO. - :rtype: str + :return: The flow_files_received of this RemoteProcessGroupStatusSnapshotDTO. + :rtype: int """ - return self._target_uri + return self._flow_files_received - @target_uri.setter - def target_uri(self, target_uri): + @flow_files_received.setter + def flow_files_received(self, flow_files_received): """ - Sets the target_uri of this RemoteProcessGroupStatusSnapshotDTO. - The URI of the target system. + Sets the flow_files_received of this RemoteProcessGroupStatusSnapshotDTO. + The number of FlowFiles received from the remote process group in the last 5 minutes. - :param target_uri: The target_uri of this RemoteProcessGroupStatusSnapshotDTO. - :type: str + :param flow_files_received: The flow_files_received of this RemoteProcessGroupStatusSnapshotDTO. + :type: int """ - self._target_uri = target_uri + self._flow_files_received = flow_files_received @property - def transmission_status(self): + def flow_files_sent(self): """ - Gets the transmission_status of this RemoteProcessGroupStatusSnapshotDTO. - The transmission status of the remote process group. + Gets the flow_files_sent of this RemoteProcessGroupStatusSnapshotDTO. + The number of FlowFiles sent to the remote process group in the last 5 minutes. - :return: The transmission_status of this RemoteProcessGroupStatusSnapshotDTO. + :return: The flow_files_sent of this RemoteProcessGroupStatusSnapshotDTO. + :rtype: int + """ + return self._flow_files_sent + + @flow_files_sent.setter + def flow_files_sent(self, flow_files_sent): + """ + Sets the flow_files_sent of this RemoteProcessGroupStatusSnapshotDTO. + The number of FlowFiles sent to the remote process group in the last 5 minutes. + + :param flow_files_sent: The flow_files_sent of this RemoteProcessGroupStatusSnapshotDTO. + :type: int + """ + + self._flow_files_sent = flow_files_sent + + @property + def group_id(self): + """ + Gets the group_id of this RemoteProcessGroupStatusSnapshotDTO. + The id of the parent process group the remote process group resides in. + + :return: The group_id of this RemoteProcessGroupStatusSnapshotDTO. :rtype: str """ - return self._transmission_status + return self._group_id - @transmission_status.setter - def transmission_status(self, transmission_status): + @group_id.setter + def group_id(self, group_id): """ - Sets the transmission_status of this RemoteProcessGroupStatusSnapshotDTO. - The transmission status of the remote process group. + Sets the group_id of this RemoteProcessGroupStatusSnapshotDTO. + The id of the parent process group the remote process group resides in. - :param transmission_status: The transmission_status of this RemoteProcessGroupStatusSnapshotDTO. + :param group_id: The group_id of this RemoteProcessGroupStatusSnapshotDTO. :type: str """ - self._transmission_status = transmission_status + self._group_id = group_id @property - def active_thread_count(self): + def id(self): """ - Gets the active_thread_count of this RemoteProcessGroupStatusSnapshotDTO. - The number of active threads for the remote process group. + Gets the id of this RemoteProcessGroupStatusSnapshotDTO. + The id of the remote process group. - :return: The active_thread_count of this RemoteProcessGroupStatusSnapshotDTO. - :rtype: int + :return: The id of this RemoteProcessGroupStatusSnapshotDTO. + :rtype: str """ - return self._active_thread_count + return self._id - @active_thread_count.setter - def active_thread_count(self, active_thread_count): + @id.setter + def id(self, id): """ - Sets the active_thread_count of this RemoteProcessGroupStatusSnapshotDTO. - The number of active threads for the remote process group. + Sets the id of this RemoteProcessGroupStatusSnapshotDTO. + The id of the remote process group. - :param active_thread_count: The active_thread_count of this RemoteProcessGroupStatusSnapshotDTO. - :type: int + :param id: The id of this RemoteProcessGroupStatusSnapshotDTO. + :type: str """ - self._active_thread_count = active_thread_count + self._id = id @property - def flow_files_sent(self): + def name(self): """ - Gets the flow_files_sent of this RemoteProcessGroupStatusSnapshotDTO. - The number of FlowFiles sent to the remote process group in the last 5 minutes. + Gets the name of this RemoteProcessGroupStatusSnapshotDTO. + The name of the remote process group. - :return: The flow_files_sent of this RemoteProcessGroupStatusSnapshotDTO. - :rtype: int + :return: The name of this RemoteProcessGroupStatusSnapshotDTO. + :rtype: str """ - return self._flow_files_sent + return self._name - @flow_files_sent.setter - def flow_files_sent(self, flow_files_sent): + @name.setter + def name(self, name): """ - Sets the flow_files_sent of this RemoteProcessGroupStatusSnapshotDTO. - The number of FlowFiles sent to the remote process group in the last 5 minutes. + Sets the name of this RemoteProcessGroupStatusSnapshotDTO. + The name of the remote process group. - :param flow_files_sent: The flow_files_sent of this RemoteProcessGroupStatusSnapshotDTO. - :type: int + :param name: The name of this RemoteProcessGroupStatusSnapshotDTO. + :type: str """ - self._flow_files_sent = flow_files_sent + self._name = name @property - def bytes_sent(self): + def received(self): """ - Gets the bytes_sent of this RemoteProcessGroupStatusSnapshotDTO. - The size of the FlowFiles sent to the remote process group in the last 5 minutes. + Gets the received of this RemoteProcessGroupStatusSnapshotDTO. + The count/size of the flowfiles received from the remote process group in the last 5 minutes. - :return: The bytes_sent of this RemoteProcessGroupStatusSnapshotDTO. - :rtype: int + :return: The received of this RemoteProcessGroupStatusSnapshotDTO. + :rtype: str """ - return self._bytes_sent + return self._received - @bytes_sent.setter - def bytes_sent(self, bytes_sent): + @received.setter + def received(self, received): """ - Sets the bytes_sent of this RemoteProcessGroupStatusSnapshotDTO. - The size of the FlowFiles sent to the remote process group in the last 5 minutes. + Sets the received of this RemoteProcessGroupStatusSnapshotDTO. + The count/size of the flowfiles received from the remote process group in the last 5 minutes. - :param bytes_sent: The bytes_sent of this RemoteProcessGroupStatusSnapshotDTO. - :type: int + :param received: The received of this RemoteProcessGroupStatusSnapshotDTO. + :type: str """ - self._bytes_sent = bytes_sent + self._received = received @property def sent(self): @@ -308,73 +328,50 @@ def sent(self, sent): self._sent = sent @property - def flow_files_received(self): - """ - Gets the flow_files_received of this RemoteProcessGroupStatusSnapshotDTO. - The number of FlowFiles received from the remote process group in the last 5 minutes. - - :return: The flow_files_received of this RemoteProcessGroupStatusSnapshotDTO. - :rtype: int - """ - return self._flow_files_received - - @flow_files_received.setter - def flow_files_received(self, flow_files_received): - """ - Sets the flow_files_received of this RemoteProcessGroupStatusSnapshotDTO. - The number of FlowFiles received from the remote process group in the last 5 minutes. - - :param flow_files_received: The flow_files_received of this RemoteProcessGroupStatusSnapshotDTO. - :type: int - """ - - self._flow_files_received = flow_files_received - - @property - def bytes_received(self): + def target_uri(self): """ - Gets the bytes_received of this RemoteProcessGroupStatusSnapshotDTO. - The size of the FlowFiles received from the remote process group in the last 5 minutes. + Gets the target_uri of this RemoteProcessGroupStatusSnapshotDTO. + The URI of the target system. - :return: The bytes_received of this RemoteProcessGroupStatusSnapshotDTO. - :rtype: int + :return: The target_uri of this RemoteProcessGroupStatusSnapshotDTO. + :rtype: str """ - return self._bytes_received + return self._target_uri - @bytes_received.setter - def bytes_received(self, bytes_received): + @target_uri.setter + def target_uri(self, target_uri): """ - Sets the bytes_received of this RemoteProcessGroupStatusSnapshotDTO. - The size of the FlowFiles received from the remote process group in the last 5 minutes. + Sets the target_uri of this RemoteProcessGroupStatusSnapshotDTO. + The URI of the target system. - :param bytes_received: The bytes_received of this RemoteProcessGroupStatusSnapshotDTO. - :type: int + :param target_uri: The target_uri of this RemoteProcessGroupStatusSnapshotDTO. + :type: str """ - self._bytes_received = bytes_received + self._target_uri = target_uri @property - def received(self): + def transmission_status(self): """ - Gets the received of this RemoteProcessGroupStatusSnapshotDTO. - The count/size of the flowfiles received from the remote process group in the last 5 minutes. + Gets the transmission_status of this RemoteProcessGroupStatusSnapshotDTO. + The transmission status of the remote process group. - :return: The received of this RemoteProcessGroupStatusSnapshotDTO. + :return: The transmission_status of this RemoteProcessGroupStatusSnapshotDTO. :rtype: str """ - return self._received + return self._transmission_status - @received.setter - def received(self, received): + @transmission_status.setter + def transmission_status(self, transmission_status): """ - Sets the received of this RemoteProcessGroupStatusSnapshotDTO. - The count/size of the flowfiles received from the remote process group in the last 5 minutes. + Sets the transmission_status of this RemoteProcessGroupStatusSnapshotDTO. + The transmission status of the remote process group. - :param received: The received of this RemoteProcessGroupStatusSnapshotDTO. + :param transmission_status: The transmission_status of this RemoteProcessGroupStatusSnapshotDTO. :type: str """ - self._received = received + self._transmission_status = transmission_status def to_dict(self): """ 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 290648ab..47dff860 100644 --- a/nipyapi/nifi/models/remote_process_group_status_snapshot_entity.py +++ b/nipyapi/nifi/models/remote_process_group_status_snapshot_entity.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,32 +27,53 @@ class RemoteProcessGroupStatusSnapshotEntity(object): and the value is json key in definition. """ swagger_types = { - 'id': 'str', - 'remote_process_group_status_snapshot': 'RemoteProcessGroupStatusSnapshotDTO', - 'can_read': 'bool' - } + 'can_read': 'bool', +'id': 'str', +'remote_process_group_status_snapshot': 'RemoteProcessGroupStatusSnapshotDTO' } attribute_map = { - 'id': 'id', - 'remote_process_group_status_snapshot': 'remoteProcessGroupStatusSnapshot', - 'can_read': 'canRead' - } + 'can_read': 'canRead', +'id': 'id', +'remote_process_group_status_snapshot': 'remoteProcessGroupStatusSnapshot' } - def __init__(self, id=None, remote_process_group_status_snapshot=None, can_read=None): + def __init__(self, can_read=None, id=None, remote_process_group_status_snapshot=None): """ RemoteProcessGroupStatusSnapshotEntity - a model defined in Swagger """ + self._can_read = None self._id = None self._remote_process_group_status_snapshot = None - self._can_read = None + if can_read is not None: + self.can_read = can_read if id is not None: self.id = id if remote_process_group_status_snapshot is not None: self.remote_process_group_status_snapshot = remote_process_group_status_snapshot - if can_read is not None: - self.can_read = can_read + + @property + def can_read(self): + """ + Gets the can_read of this RemoteProcessGroupStatusSnapshotEntity. + Indicates whether the user can read a given resource. + + :return: The can_read of this RemoteProcessGroupStatusSnapshotEntity. + :rtype: bool + """ + return self._can_read + + @can_read.setter + def can_read(self, can_read): + """ + Sets the can_read of this RemoteProcessGroupStatusSnapshotEntity. + Indicates whether the user can read a given resource. + + :param can_read: The can_read of this RemoteProcessGroupStatusSnapshotEntity. + :type: bool + """ + + self._can_read = can_read @property def id(self): @@ -99,29 +119,6 @@ def remote_process_group_status_snapshot(self, remote_process_group_status_snaps self._remote_process_group_status_snapshot = remote_process_group_status_snapshot - @property - def can_read(self): - """ - Gets the can_read of this RemoteProcessGroupStatusSnapshotEntity. - Indicates whether the user can read a given resource. - - :return: The can_read of this RemoteProcessGroupStatusSnapshotEntity. - :rtype: bool - """ - return self._can_read - - @can_read.setter - def can_read(self, can_read): - """ - Sets the can_read of this RemoteProcessGroupStatusSnapshotEntity. - Indicates whether the user can read a given resource. - - :param can_read: The can_read of this RemoteProcessGroupStatusSnapshotEntity. - :type: bool - """ - - self._can_read = can_read - def to_dict(self): """ Returns the model properties as a dict diff --git a/nipyapi/nifi/models/remote_process_groups_entity.py b/nipyapi/nifi/models/remote_process_groups_entity.py index 013f325d..3b971ad1 100644 --- a/nipyapi/nifi/models/remote_process_groups_entity.py +++ b/nipyapi/nifi/models/remote_process_groups_entity.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,12 +27,10 @@ class RemoteProcessGroupsEntity(object): and the value is json key in definition. """ swagger_types = { - 'remote_process_groups': 'list[RemoteProcessGroupEntity]' - } + 'remote_process_groups': 'list[RemoteProcessGroupEntity]' } attribute_map = { - 'remote_process_groups': 'remoteProcessGroups' - } + 'remote_process_groups': 'remoteProcessGroups' } def __init__(self, remote_process_groups=None): """ diff --git a/nipyapi/nifi/models/remote_queue_partition_dto.py b/nipyapi/nifi/models/remote_queue_partition_dto.py deleted file mode 100644 index 937de78f..00000000 --- a/nipyapi/nifi/models/remote_queue_partition_dto.py +++ /dev/null @@ -1,374 +0,0 @@ -""" - NiFi Rest API - - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - - OpenAPI spec version: 1.28.1 - Contact: dev@nifi.apache.org - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - - -from pprint import pformat -import re - - -class RemoteQueuePartitionDTO(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 = { - 'total_flow_file_count': 'int', - 'total_byte_count': 'int', - 'active_queue_flow_file_count': 'int', - 'active_queue_byte_count': 'int', - 'swap_flow_file_count': 'int', - 'swap_byte_count': 'int', - 'swap_files': 'int', - 'in_flight_flow_file_count': 'int', - 'in_flight_byte_count': 'int', - 'node_identifier': 'str' - } - - attribute_map = { - 'total_flow_file_count': 'totalFlowFileCount', - 'total_byte_count': 'totalByteCount', - 'active_queue_flow_file_count': 'activeQueueFlowFileCount', - 'active_queue_byte_count': 'activeQueueByteCount', - 'swap_flow_file_count': 'swapFlowFileCount', - 'swap_byte_count': 'swapByteCount', - 'swap_files': 'swapFiles', - 'in_flight_flow_file_count': 'inFlightFlowFileCount', - 'in_flight_byte_count': 'inFlightByteCount', - 'node_identifier': 'nodeIdentifier' - } - - def __init__(self, total_flow_file_count=None, total_byte_count=None, active_queue_flow_file_count=None, active_queue_byte_count=None, swap_flow_file_count=None, swap_byte_count=None, swap_files=None, in_flight_flow_file_count=None, in_flight_byte_count=None, node_identifier=None): - """ - RemoteQueuePartitionDTO - a model defined in Swagger - """ - - self._total_flow_file_count = None - self._total_byte_count = None - self._active_queue_flow_file_count = None - self._active_queue_byte_count = None - self._swap_flow_file_count = None - self._swap_byte_count = None - self._swap_files = None - self._in_flight_flow_file_count = None - self._in_flight_byte_count = None - self._node_identifier = None - - if total_flow_file_count is not None: - self.total_flow_file_count = total_flow_file_count - if total_byte_count is not None: - self.total_byte_count = total_byte_count - if active_queue_flow_file_count is not None: - self.active_queue_flow_file_count = active_queue_flow_file_count - if active_queue_byte_count is not None: - self.active_queue_byte_count = active_queue_byte_count - if swap_flow_file_count is not None: - self.swap_flow_file_count = swap_flow_file_count - if swap_byte_count is not None: - self.swap_byte_count = swap_byte_count - if swap_files is not None: - self.swap_files = swap_files - if in_flight_flow_file_count is not None: - self.in_flight_flow_file_count = in_flight_flow_file_count - if in_flight_byte_count is not None: - self.in_flight_byte_count = in_flight_byte_count - if node_identifier is not None: - self.node_identifier = node_identifier - - @property - def total_flow_file_count(self): - """ - Gets the total_flow_file_count of this RemoteQueuePartitionDTO. - Total number of FlowFiles owned by the Connection - - :return: The total_flow_file_count of this RemoteQueuePartitionDTO. - :rtype: int - """ - return self._total_flow_file_count - - @total_flow_file_count.setter - def total_flow_file_count(self, total_flow_file_count): - """ - Sets the total_flow_file_count of this RemoteQueuePartitionDTO. - Total number of FlowFiles owned by the Connection - - :param total_flow_file_count: The total_flow_file_count of this RemoteQueuePartitionDTO. - :type: int - """ - - self._total_flow_file_count = total_flow_file_count - - @property - def total_byte_count(self): - """ - Gets the total_byte_count of this RemoteQueuePartitionDTO. - Total number of bytes that make up the content for the FlowFiles owned by this Connection - - :return: The total_byte_count of this RemoteQueuePartitionDTO. - :rtype: int - """ - return self._total_byte_count - - @total_byte_count.setter - def total_byte_count(self, total_byte_count): - """ - Sets the total_byte_count of this RemoteQueuePartitionDTO. - Total number of bytes that make up the content for the FlowFiles owned by this Connection - - :param total_byte_count: The total_byte_count of this RemoteQueuePartitionDTO. - :type: int - """ - - self._total_byte_count = total_byte_count - - @property - def active_queue_flow_file_count(self): - """ - Gets the active_queue_flow_file_count of this RemoteQueuePartitionDTO. - Total number of FlowFiles that exist in the Connection's Active Queue, immediately available to be offered up to a component - - :return: The active_queue_flow_file_count of this RemoteQueuePartitionDTO. - :rtype: int - """ - return self._active_queue_flow_file_count - - @active_queue_flow_file_count.setter - def active_queue_flow_file_count(self, active_queue_flow_file_count): - """ - Sets the active_queue_flow_file_count of this RemoteQueuePartitionDTO. - Total number of FlowFiles that exist in the Connection's Active Queue, immediately available to be offered up to a component - - :param active_queue_flow_file_count: The active_queue_flow_file_count of this RemoteQueuePartitionDTO. - :type: int - """ - - self._active_queue_flow_file_count = active_queue_flow_file_count - - @property - def active_queue_byte_count(self): - """ - Gets the active_queue_byte_count of this RemoteQueuePartitionDTO. - Total number of bytes that make up the content for the FlowFiles that are present in the Connection's Active Queue - - :return: The active_queue_byte_count of this RemoteQueuePartitionDTO. - :rtype: int - """ - return self._active_queue_byte_count - - @active_queue_byte_count.setter - def active_queue_byte_count(self, active_queue_byte_count): - """ - Sets the active_queue_byte_count of this RemoteQueuePartitionDTO. - Total number of bytes that make up the content for the FlowFiles that are present in the Connection's Active Queue - - :param active_queue_byte_count: The active_queue_byte_count of this RemoteQueuePartitionDTO. - :type: int - """ - - self._active_queue_byte_count = active_queue_byte_count - - @property - def swap_flow_file_count(self): - """ - Gets the swap_flow_file_count of this RemoteQueuePartitionDTO. - The total number of FlowFiles that are swapped out for this Connection - - :return: The swap_flow_file_count of this RemoteQueuePartitionDTO. - :rtype: int - """ - return self._swap_flow_file_count - - @swap_flow_file_count.setter - def swap_flow_file_count(self, swap_flow_file_count): - """ - Sets the swap_flow_file_count of this RemoteQueuePartitionDTO. - The total number of FlowFiles that are swapped out for this Connection - - :param swap_flow_file_count: The swap_flow_file_count of this RemoteQueuePartitionDTO. - :type: int - """ - - self._swap_flow_file_count = swap_flow_file_count - - @property - def swap_byte_count(self): - """ - Gets the swap_byte_count of this RemoteQueuePartitionDTO. - Total number of bytes that make up the content for the FlowFiles that are swapped out to disk for the Connection - - :return: The swap_byte_count of this RemoteQueuePartitionDTO. - :rtype: int - """ - return self._swap_byte_count - - @swap_byte_count.setter - def swap_byte_count(self, swap_byte_count): - """ - Sets the swap_byte_count of this RemoteQueuePartitionDTO. - Total number of bytes that make up the content for the FlowFiles that are swapped out to disk for the Connection - - :param swap_byte_count: The swap_byte_count of this RemoteQueuePartitionDTO. - :type: int - """ - - self._swap_byte_count = swap_byte_count - - @property - def swap_files(self): - """ - Gets the swap_files of this RemoteQueuePartitionDTO. - The number of Swap Files that exist for this Connection - - :return: The swap_files of this RemoteQueuePartitionDTO. - :rtype: int - """ - return self._swap_files - - @swap_files.setter - def swap_files(self, swap_files): - """ - Sets the swap_files of this RemoteQueuePartitionDTO. - The number of Swap Files that exist for this Connection - - :param swap_files: The swap_files of this RemoteQueuePartitionDTO. - :type: int - """ - - self._swap_files = swap_files - - @property - def in_flight_flow_file_count(self): - """ - Gets the in_flight_flow_file_count of this RemoteQueuePartitionDTO. - The number of In-Flight FlowFiles for this Connection. These are FlowFiles that belong to the connection but are currently being operated on by a Processor, Port, etc. - - :return: The in_flight_flow_file_count of this RemoteQueuePartitionDTO. - :rtype: int - """ - return self._in_flight_flow_file_count - - @in_flight_flow_file_count.setter - def in_flight_flow_file_count(self, in_flight_flow_file_count): - """ - Sets the in_flight_flow_file_count of this RemoteQueuePartitionDTO. - The number of In-Flight FlowFiles for this Connection. These are FlowFiles that belong to the connection but are currently being operated on by a Processor, Port, etc. - - :param in_flight_flow_file_count: The in_flight_flow_file_count of this RemoteQueuePartitionDTO. - :type: int - """ - - self._in_flight_flow_file_count = in_flight_flow_file_count - - @property - def in_flight_byte_count(self): - """ - Gets the in_flight_byte_count of this RemoteQueuePartitionDTO. - The number bytes that make up the content of the FlowFiles that are In-Flight - - :return: The in_flight_byte_count of this RemoteQueuePartitionDTO. - :rtype: int - """ - return self._in_flight_byte_count - - @in_flight_byte_count.setter - def in_flight_byte_count(self, in_flight_byte_count): - """ - Sets the in_flight_byte_count of this RemoteQueuePartitionDTO. - The number bytes that make up the content of the FlowFiles that are In-Flight - - :param in_flight_byte_count: The in_flight_byte_count of this RemoteQueuePartitionDTO. - :type: int - """ - - self._in_flight_byte_count = in_flight_byte_count - - @property - def node_identifier(self): - """ - Gets the node_identifier of this RemoteQueuePartitionDTO. - The Node Identifier that this queue partition is sending to - - :return: The node_identifier of this RemoteQueuePartitionDTO. - :rtype: str - """ - return self._node_identifier - - @node_identifier.setter - def node_identifier(self, node_identifier): - """ - Sets the node_identifier of this RemoteQueuePartitionDTO. - The Node Identifier that this queue partition is sending to - - :param node_identifier: The node_identifier of this RemoteQueuePartitionDTO. - :type: str - """ - - self._node_identifier = node_identifier - - 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, RemoteQueuePartitionDTO): - 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/replay_last_event_request_entity.py b/nipyapi/nifi/models/replay_last_event_request_entity.py index efe03d5a..84d72edf 100644 --- a/nipyapi/nifi/models/replay_last_event_request_entity.py +++ b/nipyapi/nifi/models/replay_last_event_request_entity.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -29,13 +28,11 @@ class ReplayLastEventRequestEntity(object): """ swagger_types = { 'component_id': 'str', - 'nodes': 'str' - } +'nodes': 'str' } attribute_map = { 'component_id': 'componentId', - 'nodes': 'nodes' - } +'nodes': 'nodes' } def __init__(self, component_id=None, nodes=None): """ @@ -93,7 +90,7 @@ def nodes(self, nodes): :param nodes: The nodes of this ReplayLastEventRequestEntity. :type: str """ - allowed_values = ["ALL", "PRIMARY"] + allowed_values = ["ALL", "PRIMARY", ] if nodes not in allowed_values: raise ValueError( "Invalid value for `nodes` ({0}), must be one of {1}" diff --git a/nipyapi/nifi/models/replay_last_event_response_entity.py b/nipyapi/nifi/models/replay_last_event_response_entity.py index 5a9cdbf2..3ea7db38 100644 --- a/nipyapi/nifi/models/replay_last_event_response_entity.py +++ b/nipyapi/nifi/models/replay_last_event_response_entity.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,37 +27,56 @@ class ReplayLastEventResponseEntity(object): and the value is json key in definition. """ swagger_types = { - 'component_id': 'str', - 'nodes': 'str', 'aggregate_snapshot': 'ReplayLastEventSnapshotDTO', - 'node_snapshots': 'list[NodeReplayLastEventSnapshotDTO]' - } +'component_id': 'str', +'node_snapshots': 'list[NodeReplayLastEventSnapshotDTO]', +'nodes': 'str' } attribute_map = { - 'component_id': 'componentId', - 'nodes': 'nodes', 'aggregate_snapshot': 'aggregateSnapshot', - 'node_snapshots': 'nodeSnapshots' - } +'component_id': 'componentId', +'node_snapshots': 'nodeSnapshots', +'nodes': 'nodes' } - def __init__(self, component_id=None, nodes=None, aggregate_snapshot=None, node_snapshots=None): + def __init__(self, aggregate_snapshot=None, component_id=None, node_snapshots=None, nodes=None): """ ReplayLastEventResponseEntity - a model defined in Swagger """ - self._component_id = None - self._nodes = None self._aggregate_snapshot = None + self._component_id = None self._node_snapshots = None + self._nodes = None - if component_id is not None: - self.component_id = component_id - if nodes is not None: - self.nodes = nodes if aggregate_snapshot is not None: self.aggregate_snapshot = aggregate_snapshot + if component_id is not None: + self.component_id = component_id if node_snapshots is not None: self.node_snapshots = node_snapshots + if nodes is not None: + self.nodes = nodes + + @property + def aggregate_snapshot(self): + """ + Gets the aggregate_snapshot of this ReplayLastEventResponseEntity. + + :return: The aggregate_snapshot of this ReplayLastEventResponseEntity. + :rtype: ReplayLastEventSnapshotDTO + """ + return self._aggregate_snapshot + + @aggregate_snapshot.setter + def aggregate_snapshot(self, aggregate_snapshot): + """ + Sets the aggregate_snapshot of this ReplayLastEventResponseEntity. + + :param aggregate_snapshot: The aggregate_snapshot of this ReplayLastEventResponseEntity. + :type: ReplayLastEventSnapshotDTO + """ + + self._aggregate_snapshot = aggregate_snapshot @property def component_id(self): @@ -83,6 +101,29 @@ def component_id(self, component_id): self._component_id = component_id + @property + def node_snapshots(self): + """ + Gets the node_snapshots of this ReplayLastEventResponseEntity. + The node-wise results + + :return: The node_snapshots of this ReplayLastEventResponseEntity. + :rtype: list[NodeReplayLastEventSnapshotDTO] + """ + return self._node_snapshots + + @node_snapshots.setter + def node_snapshots(self, node_snapshots): + """ + Sets the node_snapshots of this ReplayLastEventResponseEntity. + The node-wise results + + :param node_snapshots: The node_snapshots of this ReplayLastEventResponseEntity. + :type: list[NodeReplayLastEventSnapshotDTO] + """ + + self._node_snapshots = node_snapshots + @property def nodes(self): """ @@ -103,7 +144,7 @@ def nodes(self, nodes): :param nodes: The nodes of this ReplayLastEventResponseEntity. :type: str """ - allowed_values = ["ALL", "PRIMARY"] + allowed_values = ["ALL", "PRIMARY", ] if nodes not in allowed_values: raise ValueError( "Invalid value for `nodes` ({0}), must be one of {1}" @@ -112,52 +153,6 @@ def nodes(self, nodes): self._nodes = nodes - @property - def aggregate_snapshot(self): - """ - Gets the aggregate_snapshot of this ReplayLastEventResponseEntity. - The aggregate result of all nodes' responses - - :return: The aggregate_snapshot of this ReplayLastEventResponseEntity. - :rtype: ReplayLastEventSnapshotDTO - """ - return self._aggregate_snapshot - - @aggregate_snapshot.setter - def aggregate_snapshot(self, aggregate_snapshot): - """ - Sets the aggregate_snapshot of this ReplayLastEventResponseEntity. - The aggregate result of all nodes' responses - - :param aggregate_snapshot: The aggregate_snapshot of this ReplayLastEventResponseEntity. - :type: ReplayLastEventSnapshotDTO - """ - - self._aggregate_snapshot = aggregate_snapshot - - @property - def node_snapshots(self): - """ - Gets the node_snapshots of this ReplayLastEventResponseEntity. - The node-wise results - - :return: The node_snapshots of this ReplayLastEventResponseEntity. - :rtype: list[NodeReplayLastEventSnapshotDTO] - """ - return self._node_snapshots - - @node_snapshots.setter - def node_snapshots(self, node_snapshots): - """ - Sets the node_snapshots of this ReplayLastEventResponseEntity. - The node-wise results - - :param node_snapshots: The node_snapshots of this ReplayLastEventResponseEntity. - :type: list[NodeReplayLastEventSnapshotDTO] - """ - - self._node_snapshots = node_snapshots - def to_dict(self): """ Returns the model properties as a dict diff --git a/nipyapi/nifi/models/replay_last_event_snapshot_dto.py b/nipyapi/nifi/models/replay_last_event_snapshot_dto.py index 1da13341..f8891df2 100644 --- a/nipyapi/nifi/models/replay_last_event_snapshot_dto.py +++ b/nipyapi/nifi/models/replay_last_event_snapshot_dto.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,32 +27,53 @@ class ReplayLastEventSnapshotDTO(object): and the value is json key in definition. """ swagger_types = { - 'events_replayed': 'list[int]', - 'failure_explanation': 'str', - 'event_available': 'bool' - } + 'event_available': 'bool', +'events_replayed': 'list[int]', +'failure_explanation': 'str' } attribute_map = { - 'events_replayed': 'eventsReplayed', - 'failure_explanation': 'failureExplanation', - 'event_available': 'eventAvailable' - } + 'event_available': 'eventAvailable', +'events_replayed': 'eventsReplayed', +'failure_explanation': 'failureExplanation' } - def __init__(self, events_replayed=None, failure_explanation=None, event_available=None): + def __init__(self, event_available=None, events_replayed=None, failure_explanation=None): """ ReplayLastEventSnapshotDTO - a model defined in Swagger """ + self._event_available = None self._events_replayed = None self._failure_explanation = None - self._event_available = None + if event_available is not None: + self.event_available = event_available if events_replayed is not None: self.events_replayed = events_replayed if failure_explanation is not None: self.failure_explanation = failure_explanation - if event_available is not None: - self.event_available = event_available + + @property + def event_available(self): + """ + Gets the event_available of this ReplayLastEventSnapshotDTO. + Whether or not an event was available. This may not be populated if there was a failure. + + :return: The event_available of this ReplayLastEventSnapshotDTO. + :rtype: bool + """ + return self._event_available + + @event_available.setter + def event_available(self, event_available): + """ + Sets the event_available of this ReplayLastEventSnapshotDTO. + Whether or not an event was available. This may not be populated if there was a failure. + + :param event_available: The event_available of this ReplayLastEventSnapshotDTO. + :type: bool + """ + + self._event_available = event_available @property def events_replayed(self): @@ -101,29 +121,6 @@ def failure_explanation(self, failure_explanation): self._failure_explanation = failure_explanation - @property - def event_available(self): - """ - Gets the event_available of this ReplayLastEventSnapshotDTO. - Whether or not an event was available. This may not be populated if there was a failure. - - :return: The event_available of this ReplayLastEventSnapshotDTO. - :rtype: bool - """ - return self._event_available - - @event_available.setter - def event_available(self, event_available): - """ - Sets the event_available of this ReplayLastEventSnapshotDTO. - Whether or not an event was available. This may not be populated if there was a failure. - - :param event_available: The event_available of this ReplayLastEventSnapshotDTO. - :type: bool - """ - - self._event_available = event_available - def to_dict(self): """ Returns the model properties as a dict diff --git a/nipyapi/nifi/models/reporting_task_definition.py b/nipyapi/nifi/models/reporting_task_definition.py index ab22cb00..e9cedf9a 100644 --- a/nipyapi/nifi/models/reporting_task_definition.py +++ b/nipyapi/nifi/models/reporting_task_definition.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,164 +27,163 @@ class ReportingTaskDefinition(object): and the value is json key in definition. """ swagger_types = { - 'group': 'str', - 'artifact': 'str', - 'version': 'str', - 'type': 'str', - 'type_description': 'str', - 'build_info': 'BuildInfo', - 'provided_api_implementations': 'list[DefinedType]', - 'tags': 'list[str]', - 'see_also': 'list[str]', - 'deprecated': 'bool', - 'deprecation_reason': 'str', - 'deprecation_alternatives': 'list[str]', - 'restricted': 'bool', - 'restricted_explanation': 'str', - 'explicit_restrictions': 'list[Restriction]', - 'stateful': 'Stateful', - 'system_resource_considerations': 'list[SystemResourceConsideration]', 'additional_details': 'bool', - 'property_descriptors': 'dict(str, PropertyDescriptor)', - 'supports_dynamic_properties': 'bool', - 'supports_sensitive_dynamic_properties': 'bool', - 'dynamic_properties': 'list[DynamicProperty]', - 'supported_scheduling_strategies': 'list[str]', - 'default_scheduling_strategy': 'str', - 'default_scheduling_period_by_scheduling_strategy': 'dict(str, str)' - } +'artifact': 'str', +'build_info': 'BuildInfo', +'default_scheduling_period_by_scheduling_strategy': 'dict(str, str)', +'default_scheduling_strategy': 'str', +'deprecated': 'bool', +'deprecation_alternatives': 'list[str]', +'deprecation_reason': 'str', +'dynamic_properties': 'list[DynamicProperty]', +'explicit_restrictions': 'list[Restriction]', +'group': 'str', +'property_descriptors': 'dict(str, PropertyDescriptor)', +'provided_api_implementations': 'list[DefinedType]', +'restricted': 'bool', +'restricted_explanation': 'str', +'see_also': 'list[str]', +'stateful': 'Stateful', +'supported_scheduling_strategies': 'list[str]', +'supports_dynamic_properties': 'bool', +'supports_sensitive_dynamic_properties': 'bool', +'system_resource_considerations': 'list[SystemResourceConsideration]', +'tags': 'list[str]', +'type': 'str', +'type_description': 'str', +'version': 'str' } attribute_map = { - 'group': 'group', - 'artifact': 'artifact', - 'version': 'version', - 'type': 'type', - 'type_description': 'typeDescription', - 'build_info': 'buildInfo', - 'provided_api_implementations': 'providedApiImplementations', - 'tags': 'tags', - 'see_also': 'seeAlso', - 'deprecated': 'deprecated', - 'deprecation_reason': 'deprecationReason', - 'deprecation_alternatives': 'deprecationAlternatives', - 'restricted': 'restricted', - 'restricted_explanation': 'restrictedExplanation', - 'explicit_restrictions': 'explicitRestrictions', - 'stateful': 'stateful', - 'system_resource_considerations': 'systemResourceConsiderations', 'additional_details': 'additionalDetails', - 'property_descriptors': 'propertyDescriptors', - 'supports_dynamic_properties': 'supportsDynamicProperties', - 'supports_sensitive_dynamic_properties': 'supportsSensitiveDynamicProperties', - 'dynamic_properties': 'dynamicProperties', - 'supported_scheduling_strategies': 'supportedSchedulingStrategies', - 'default_scheduling_strategy': 'defaultSchedulingStrategy', - 'default_scheduling_period_by_scheduling_strategy': 'defaultSchedulingPeriodBySchedulingStrategy' - } - - def __init__(self, group=None, artifact=None, version=None, type=None, type_description=None, build_info=None, provided_api_implementations=None, tags=None, see_also=None, deprecated=None, deprecation_reason=None, deprecation_alternatives=None, restricted=None, restricted_explanation=None, explicit_restrictions=None, stateful=None, system_resource_considerations=None, additional_details=None, property_descriptors=None, supports_dynamic_properties=None, supports_sensitive_dynamic_properties=None, dynamic_properties=None, supported_scheduling_strategies=None, default_scheduling_strategy=None, default_scheduling_period_by_scheduling_strategy=None): +'artifact': 'artifact', +'build_info': 'buildInfo', +'default_scheduling_period_by_scheduling_strategy': 'defaultSchedulingPeriodBySchedulingStrategy', +'default_scheduling_strategy': 'defaultSchedulingStrategy', +'deprecated': 'deprecated', +'deprecation_alternatives': 'deprecationAlternatives', +'deprecation_reason': 'deprecationReason', +'dynamic_properties': 'dynamicProperties', +'explicit_restrictions': 'explicitRestrictions', +'group': 'group', +'property_descriptors': 'propertyDescriptors', +'provided_api_implementations': 'providedApiImplementations', +'restricted': 'restricted', +'restricted_explanation': 'restrictedExplanation', +'see_also': 'seeAlso', +'stateful': 'stateful', +'supported_scheduling_strategies': 'supportedSchedulingStrategies', +'supports_dynamic_properties': 'supportsDynamicProperties', +'supports_sensitive_dynamic_properties': 'supportsSensitiveDynamicProperties', +'system_resource_considerations': 'systemResourceConsiderations', +'tags': 'tags', +'type': 'type', +'type_description': 'typeDescription', +'version': 'version' } + + def __init__(self, additional_details=None, artifact=None, build_info=None, default_scheduling_period_by_scheduling_strategy=None, default_scheduling_strategy=None, deprecated=None, deprecation_alternatives=None, deprecation_reason=None, dynamic_properties=None, explicit_restrictions=None, group=None, property_descriptors=None, provided_api_implementations=None, restricted=None, restricted_explanation=None, see_also=None, stateful=None, supported_scheduling_strategies=None, supports_dynamic_properties=None, supports_sensitive_dynamic_properties=None, system_resource_considerations=None, tags=None, type=None, type_description=None, version=None): """ ReportingTaskDefinition - a model defined in Swagger """ - self._group = None + self._additional_details = None self._artifact = None - self._version = None - self._type = None - self._type_description = None self._build_info = None - self._provided_api_implementations = None - self._tags = None - self._see_also = None + self._default_scheduling_period_by_scheduling_strategy = None + self._default_scheduling_strategy = None self._deprecated = None - self._deprecation_reason = None self._deprecation_alternatives = None + self._deprecation_reason = None + self._dynamic_properties = None + self._explicit_restrictions = None + self._group = None + self._property_descriptors = None + self._provided_api_implementations = None self._restricted = None self._restricted_explanation = None - self._explicit_restrictions = None + self._see_also = None self._stateful = None - self._system_resource_considerations = None - self._additional_details = None - self._property_descriptors = None + self._supported_scheduling_strategies = None self._supports_dynamic_properties = None self._supports_sensitive_dynamic_properties = None - self._dynamic_properties = None - self._supported_scheduling_strategies = None - self._default_scheduling_strategy = None - self._default_scheduling_period_by_scheduling_strategy = None + self._system_resource_considerations = None + self._tags = None + self._type = None + self._type_description = None + self._version = None - if group is not None: - self.group = group + if additional_details is not None: + self.additional_details = additional_details if artifact is not None: self.artifact = artifact - if version is not None: - self.version = version - self.type = type - if type_description is not None: - self.type_description = type_description if build_info is not None: self.build_info = build_info - if provided_api_implementations is not None: - self.provided_api_implementations = provided_api_implementations - if tags is not None: - self.tags = tags - if see_also is not None: - self.see_also = see_also + if default_scheduling_period_by_scheduling_strategy is not None: + self.default_scheduling_period_by_scheduling_strategy = default_scheduling_period_by_scheduling_strategy + if default_scheduling_strategy is not None: + self.default_scheduling_strategy = default_scheduling_strategy if deprecated is not None: self.deprecated = deprecated - if deprecation_reason is not None: - self.deprecation_reason = deprecation_reason if deprecation_alternatives is not None: self.deprecation_alternatives = deprecation_alternatives + if deprecation_reason is not None: + self.deprecation_reason = deprecation_reason + if dynamic_properties is not None: + self.dynamic_properties = dynamic_properties + if explicit_restrictions is not None: + self.explicit_restrictions = explicit_restrictions + if group is not None: + self.group = group + if property_descriptors is not None: + self.property_descriptors = property_descriptors + if provided_api_implementations is not None: + self.provided_api_implementations = provided_api_implementations if restricted is not None: self.restricted = restricted if restricted_explanation is not None: self.restricted_explanation = restricted_explanation - if explicit_restrictions is not None: - self.explicit_restrictions = explicit_restrictions + if see_also is not None: + self.see_also = see_also if stateful is not None: self.stateful = stateful - if system_resource_considerations is not None: - self.system_resource_considerations = system_resource_considerations - if additional_details is not None: - self.additional_details = additional_details - if property_descriptors is not None: - self.property_descriptors = property_descriptors + if supported_scheduling_strategies is not None: + self.supported_scheduling_strategies = supported_scheduling_strategies if supports_dynamic_properties is not None: self.supports_dynamic_properties = supports_dynamic_properties if supports_sensitive_dynamic_properties is not None: self.supports_sensitive_dynamic_properties = supports_sensitive_dynamic_properties - if dynamic_properties is not None: - self.dynamic_properties = dynamic_properties - if supported_scheduling_strategies is not None: - self.supported_scheduling_strategies = supported_scheduling_strategies - if default_scheduling_strategy is not None: - self.default_scheduling_strategy = default_scheduling_strategy - if default_scheduling_period_by_scheduling_strategy is not None: - self.default_scheduling_period_by_scheduling_strategy = default_scheduling_period_by_scheduling_strategy + if system_resource_considerations is not None: + self.system_resource_considerations = system_resource_considerations + if tags is not None: + self.tags = tags + if type is not None: + self.type = type + if type_description is not None: + self.type_description = type_description + if version is not None: + self.version = version @property - def group(self): + def additional_details(self): """ - Gets the group of this ReportingTaskDefinition. - The group name of the bundle that provides the referenced type. + Gets the additional_details of this ReportingTaskDefinition. + Indicates if the component has additional details documentation - :return: The group of this ReportingTaskDefinition. - :rtype: str + :return: The additional_details of this ReportingTaskDefinition. + :rtype: bool """ - return self._group + return self._additional_details - @group.setter - def group(self, group): + @additional_details.setter + def additional_details(self, additional_details): """ - Sets the group of this ReportingTaskDefinition. - The group name of the bundle that provides the referenced type. + Sets the additional_details of this ReportingTaskDefinition. + Indicates if the component has additional details documentation - :param group: The group of this ReportingTaskDefinition. - :type: str + :param additional_details: The additional_details of this ReportingTaskDefinition. + :type: bool """ - self._group = group + self._additional_details = additional_details @property def artifact(self): @@ -211,236 +209,255 @@ def artifact(self, artifact): self._artifact = artifact @property - def version(self): + def build_info(self): """ - Gets the version of this ReportingTaskDefinition. - The version of the bundle that provides the referenced type. + Gets the build_info of this ReportingTaskDefinition. - :return: The version of this ReportingTaskDefinition. - :rtype: str + :return: The build_info of this ReportingTaskDefinition. + :rtype: BuildInfo """ - return self._version + return self._build_info - @version.setter - def version(self, version): + @build_info.setter + def build_info(self, build_info): """ - Sets the version of this ReportingTaskDefinition. - The version of the bundle that provides the referenced type. + Sets the build_info of this ReportingTaskDefinition. - :param version: The version of this ReportingTaskDefinition. - :type: str + :param build_info: The build_info of this ReportingTaskDefinition. + :type: BuildInfo """ - self._version = version + self._build_info = build_info @property - def type(self): + def default_scheduling_period_by_scheduling_strategy(self): """ - Gets the type of this ReportingTaskDefinition. - The fully-qualified class type + Gets the default_scheduling_period_by_scheduling_strategy of this ReportingTaskDefinition. + The default scheduling period for each scheduling strategy. The scheduling period is expected to be a time period, such as \"30 sec\". - :return: The type of this ReportingTaskDefinition. - :rtype: str + :return: The default_scheduling_period_by_scheduling_strategy of this ReportingTaskDefinition. + :rtype: dict(str, str) """ - return self._type + return self._default_scheduling_period_by_scheduling_strategy - @type.setter - def type(self, type): + @default_scheduling_period_by_scheduling_strategy.setter + def default_scheduling_period_by_scheduling_strategy(self, default_scheduling_period_by_scheduling_strategy): """ - Sets the type of this ReportingTaskDefinition. - The fully-qualified class type + Sets the default_scheduling_period_by_scheduling_strategy of this ReportingTaskDefinition. + The default scheduling period for each scheduling strategy. The scheduling period is expected to be a time period, such as \"30 sec\". - :param type: The type of this ReportingTaskDefinition. - :type: str + :param default_scheduling_period_by_scheduling_strategy: The default_scheduling_period_by_scheduling_strategy of this ReportingTaskDefinition. + :type: dict(str, str) """ - if type is None: - raise ValueError("Invalid value for `type`, must not be `None`") - self._type = type + self._default_scheduling_period_by_scheduling_strategy = default_scheduling_period_by_scheduling_strategy @property - def type_description(self): + def default_scheduling_strategy(self): """ - Gets the type_description of this ReportingTaskDefinition. - The description of the type. + Gets the default_scheduling_strategy of this ReportingTaskDefinition. + The default scheduling strategy for the reporting task. - :return: The type_description of this ReportingTaskDefinition. + :return: The default_scheduling_strategy of this ReportingTaskDefinition. :rtype: str """ - return self._type_description + return self._default_scheduling_strategy - @type_description.setter - def type_description(self, type_description): + @default_scheduling_strategy.setter + def default_scheduling_strategy(self, default_scheduling_strategy): """ - Sets the type_description of this ReportingTaskDefinition. - The description of the type. + Sets the default_scheduling_strategy of this ReportingTaskDefinition. + The default scheduling strategy for the reporting task. - :param type_description: The type_description of this ReportingTaskDefinition. + :param default_scheduling_strategy: The default_scheduling_strategy of this ReportingTaskDefinition. :type: str """ - self._type_description = type_description + self._default_scheduling_strategy = default_scheduling_strategy @property - def build_info(self): + def deprecated(self): """ - Gets the build_info of this ReportingTaskDefinition. - The build metadata for this component + Gets the deprecated of this ReportingTaskDefinition. + Whether or not the component has been deprecated - :return: The build_info of this ReportingTaskDefinition. - :rtype: BuildInfo + :return: The deprecated of this ReportingTaskDefinition. + :rtype: bool """ - return self._build_info + return self._deprecated - @build_info.setter - def build_info(self, build_info): + @deprecated.setter + def deprecated(self, deprecated): """ - Sets the build_info of this ReportingTaskDefinition. - The build metadata for this component + Sets the deprecated of this ReportingTaskDefinition. + Whether or not the component has been deprecated - :param build_info: The build_info of this ReportingTaskDefinition. - :type: BuildInfo + :param deprecated: The deprecated of this ReportingTaskDefinition. + :type: bool """ - self._build_info = build_info + self._deprecated = deprecated @property - def provided_api_implementations(self): + def deprecation_alternatives(self): """ - Gets the provided_api_implementations of this ReportingTaskDefinition. - If this type represents a provider for an interface, this lists the APIs it implements + Gets the deprecation_alternatives of this ReportingTaskDefinition. + If this component has been deprecated, this optional field provides alternatives to use - :return: The provided_api_implementations of this ReportingTaskDefinition. - :rtype: list[DefinedType] + :return: The deprecation_alternatives of this ReportingTaskDefinition. + :rtype: list[str] """ - return self._provided_api_implementations + return self._deprecation_alternatives - @provided_api_implementations.setter - def provided_api_implementations(self, provided_api_implementations): + @deprecation_alternatives.setter + def deprecation_alternatives(self, deprecation_alternatives): """ - Sets the provided_api_implementations of this ReportingTaskDefinition. - If this type represents a provider for an interface, this lists the APIs it implements + Sets the deprecation_alternatives of this ReportingTaskDefinition. + If this component has been deprecated, this optional field provides alternatives to use - :param provided_api_implementations: The provided_api_implementations of this ReportingTaskDefinition. - :type: list[DefinedType] + :param deprecation_alternatives: The deprecation_alternatives of this ReportingTaskDefinition. + :type: list[str] """ - self._provided_api_implementations = provided_api_implementations + self._deprecation_alternatives = deprecation_alternatives @property - def tags(self): + def deprecation_reason(self): """ - Gets the tags of this ReportingTaskDefinition. - The tags associated with this type + Gets the deprecation_reason of this ReportingTaskDefinition. + If this component has been deprecated, this optional field can be used to provide an explanation - :return: The tags of this ReportingTaskDefinition. - :rtype: list[str] + :return: The deprecation_reason of this ReportingTaskDefinition. + :rtype: str """ - return self._tags + return self._deprecation_reason - @tags.setter - def tags(self, tags): + @deprecation_reason.setter + def deprecation_reason(self, deprecation_reason): """ - Sets the tags of this ReportingTaskDefinition. - The tags associated with this type + Sets the deprecation_reason of this ReportingTaskDefinition. + If this component has been deprecated, this optional field can be used to provide an explanation - :param tags: The tags of this ReportingTaskDefinition. - :type: list[str] + :param deprecation_reason: The deprecation_reason of this ReportingTaskDefinition. + :type: str """ - self._tags = tags + self._deprecation_reason = deprecation_reason @property - def see_also(self): + def dynamic_properties(self): """ - Gets the see_also of this ReportingTaskDefinition. - The names of other component types that may be related + Gets the dynamic_properties of this ReportingTaskDefinition. + Describes the dynamic properties supported by this component - :return: The see_also of this ReportingTaskDefinition. - :rtype: list[str] + :return: The dynamic_properties of this ReportingTaskDefinition. + :rtype: list[DynamicProperty] """ - return self._see_also + return self._dynamic_properties - @see_also.setter - def see_also(self, see_also): + @dynamic_properties.setter + def dynamic_properties(self, dynamic_properties): """ - Sets the see_also of this ReportingTaskDefinition. - The names of other component types that may be related + Sets the dynamic_properties of this ReportingTaskDefinition. + Describes the dynamic properties supported by this component - :param see_also: The see_also of this ReportingTaskDefinition. - :type: list[str] + :param dynamic_properties: The dynamic_properties of this ReportingTaskDefinition. + :type: list[DynamicProperty] """ - self._see_also = see_also + self._dynamic_properties = dynamic_properties @property - def deprecated(self): + def explicit_restrictions(self): """ - Gets the deprecated of this ReportingTaskDefinition. - Whether or not the component has been deprecated + Gets the explicit_restrictions of this ReportingTaskDefinition. + Explicit restrictions that indicate a require permission to use the component - :return: The deprecated of this ReportingTaskDefinition. - :rtype: bool + :return: The explicit_restrictions of this ReportingTaskDefinition. + :rtype: list[Restriction] """ - return self._deprecated + return self._explicit_restrictions - @deprecated.setter - def deprecated(self, deprecated): + @explicit_restrictions.setter + def explicit_restrictions(self, explicit_restrictions): """ - Sets the deprecated of this ReportingTaskDefinition. - Whether or not the component has been deprecated + Sets the explicit_restrictions of this ReportingTaskDefinition. + Explicit restrictions that indicate a require permission to use the component - :param deprecated: The deprecated of this ReportingTaskDefinition. - :type: bool + :param explicit_restrictions: The explicit_restrictions of this ReportingTaskDefinition. + :type: list[Restriction] """ - self._deprecated = deprecated + self._explicit_restrictions = explicit_restrictions @property - def deprecation_reason(self): + def group(self): """ - Gets the deprecation_reason of this ReportingTaskDefinition. - If this component has been deprecated, this optional field can be used to provide an explanation + Gets the group of this ReportingTaskDefinition. + The group name of the bundle that provides the referenced type. - :return: The deprecation_reason of this ReportingTaskDefinition. + :return: The group of this ReportingTaskDefinition. :rtype: str """ - return self._deprecation_reason + return self._group - @deprecation_reason.setter - def deprecation_reason(self, deprecation_reason): + @group.setter + def group(self, group): + """ + Sets the group of this ReportingTaskDefinition. + The group name of the bundle that provides the referenced type. + + :param group: The group of this ReportingTaskDefinition. + :type: str + """ + + self._group = group + + @property + def property_descriptors(self): + """ + Gets the property_descriptors of this ReportingTaskDefinition. + Descriptions of configuration properties applicable to this component. + + :return: The property_descriptors of this ReportingTaskDefinition. + :rtype: dict(str, PropertyDescriptor) + """ + return self._property_descriptors + + @property_descriptors.setter + def property_descriptors(self, property_descriptors): """ - Sets the deprecation_reason of this ReportingTaskDefinition. - If this component has been deprecated, this optional field can be used to provide an explanation + Sets the property_descriptors of this ReportingTaskDefinition. + Descriptions of configuration properties applicable to this component. - :param deprecation_reason: The deprecation_reason of this ReportingTaskDefinition. - :type: str + :param property_descriptors: The property_descriptors of this ReportingTaskDefinition. + :type: dict(str, PropertyDescriptor) """ - self._deprecation_reason = deprecation_reason + self._property_descriptors = property_descriptors @property - def deprecation_alternatives(self): + def provided_api_implementations(self): """ - Gets the deprecation_alternatives of this ReportingTaskDefinition. - If this component has been deprecated, this optional field provides alternatives to use + Gets the provided_api_implementations of this ReportingTaskDefinition. + If this type represents a provider for an interface, this lists the APIs it implements - :return: The deprecation_alternatives of this ReportingTaskDefinition. - :rtype: list[str] + :return: The provided_api_implementations of this ReportingTaskDefinition. + :rtype: list[DefinedType] """ - return self._deprecation_alternatives + return self._provided_api_implementations - @deprecation_alternatives.setter - def deprecation_alternatives(self, deprecation_alternatives): + @provided_api_implementations.setter + def provided_api_implementations(self, provided_api_implementations): """ - Sets the deprecation_alternatives of this ReportingTaskDefinition. - If this component has been deprecated, this optional field provides alternatives to use + Sets the provided_api_implementations of this ReportingTaskDefinition. + If this type represents a provider for an interface, this lists the APIs it implements - :param deprecation_alternatives: The deprecation_alternatives of this ReportingTaskDefinition. - :type: list[str] + :param provided_api_implementations: The provided_api_implementations of this ReportingTaskDefinition. + :type: list[DefinedType] """ - self._deprecation_alternatives = deprecation_alternatives + self._provided_api_implementations = provided_api_implementations @property def restricted(self): @@ -489,33 +506,32 @@ def restricted_explanation(self, restricted_explanation): self._restricted_explanation = restricted_explanation @property - def explicit_restrictions(self): + def see_also(self): """ - Gets the explicit_restrictions of this ReportingTaskDefinition. - Explicit restrictions that indicate a require permission to use the component + Gets the see_also of this ReportingTaskDefinition. + The names of other component types that may be related - :return: The explicit_restrictions of this ReportingTaskDefinition. - :rtype: list[Restriction] + :return: The see_also of this ReportingTaskDefinition. + :rtype: list[str] """ - return self._explicit_restrictions + return self._see_also - @explicit_restrictions.setter - def explicit_restrictions(self, explicit_restrictions): + @see_also.setter + def see_also(self, see_also): """ - Sets the explicit_restrictions of this ReportingTaskDefinition. - Explicit restrictions that indicate a require permission to use the component + Sets the see_also of this ReportingTaskDefinition. + The names of other component types that may be related - :param explicit_restrictions: The explicit_restrictions of this ReportingTaskDefinition. - :type: list[Restriction] + :param see_also: The see_also of this ReportingTaskDefinition. + :type: list[str] """ - self._explicit_restrictions = explicit_restrictions + self._see_also = see_also @property def stateful(self): """ Gets the stateful of this ReportingTaskDefinition. - Indicates if the component stores state :return: The stateful of this ReportingTaskDefinition. :rtype: Stateful @@ -526,7 +542,6 @@ def stateful(self): def stateful(self, stateful): """ Sets the stateful of this ReportingTaskDefinition. - Indicates if the component stores state :param stateful: The stateful of this ReportingTaskDefinition. :type: Stateful @@ -535,73 +550,27 @@ def stateful(self, stateful): self._stateful = stateful @property - def system_resource_considerations(self): - """ - Gets the system_resource_considerations of this ReportingTaskDefinition. - The system resource considerations for the given component - - :return: The system_resource_considerations of this ReportingTaskDefinition. - :rtype: list[SystemResourceConsideration] - """ - return self._system_resource_considerations - - @system_resource_considerations.setter - def system_resource_considerations(self, system_resource_considerations): - """ - Sets the system_resource_considerations of this ReportingTaskDefinition. - The system resource considerations for the given component - - :param system_resource_considerations: The system_resource_considerations of this ReportingTaskDefinition. - :type: list[SystemResourceConsideration] - """ - - self._system_resource_considerations = system_resource_considerations - - @property - def additional_details(self): - """ - Gets the additional_details of this ReportingTaskDefinition. - Indicates if the component has additional details documentation - - :return: The additional_details of this ReportingTaskDefinition. - :rtype: bool - """ - return self._additional_details - - @additional_details.setter - def additional_details(self, additional_details): - """ - Sets the additional_details of this ReportingTaskDefinition. - Indicates if the component has additional details documentation - - :param additional_details: The additional_details of this ReportingTaskDefinition. - :type: bool - """ - - self._additional_details = additional_details - - @property - def property_descriptors(self): + def supported_scheduling_strategies(self): """ - Gets the property_descriptors of this ReportingTaskDefinition. - Descriptions of configuration properties applicable to this component. + Gets the supported_scheduling_strategies of this ReportingTaskDefinition. + The supported scheduling strategies, such as TIME_DRIVER or CRON. - :return: The property_descriptors of this ReportingTaskDefinition. - :rtype: dict(str, PropertyDescriptor) + :return: The supported_scheduling_strategies of this ReportingTaskDefinition. + :rtype: list[str] """ - return self._property_descriptors + return self._supported_scheduling_strategies - @property_descriptors.setter - def property_descriptors(self, property_descriptors): + @supported_scheduling_strategies.setter + def supported_scheduling_strategies(self, supported_scheduling_strategies): """ - Sets the property_descriptors of this ReportingTaskDefinition. - Descriptions of configuration properties applicable to this component. + Sets the supported_scheduling_strategies of this ReportingTaskDefinition. + The supported scheduling strategies, such as TIME_DRIVER or CRON. - :param property_descriptors: The property_descriptors of this ReportingTaskDefinition. - :type: dict(str, PropertyDescriptor) + :param supported_scheduling_strategies: The supported_scheduling_strategies of this ReportingTaskDefinition. + :type: list[str] """ - self._property_descriptors = property_descriptors + self._supported_scheduling_strategies = supported_scheduling_strategies @property def supports_dynamic_properties(self): @@ -650,96 +619,119 @@ def supports_sensitive_dynamic_properties(self, supports_sensitive_dynamic_prope self._supports_sensitive_dynamic_properties = supports_sensitive_dynamic_properties @property - def dynamic_properties(self): + def system_resource_considerations(self): """ - Gets the dynamic_properties of this ReportingTaskDefinition. - Describes the dynamic properties supported by this component + Gets the system_resource_considerations of this ReportingTaskDefinition. + The system resource considerations for the given component - :return: The dynamic_properties of this ReportingTaskDefinition. - :rtype: list[DynamicProperty] + :return: The system_resource_considerations of this ReportingTaskDefinition. + :rtype: list[SystemResourceConsideration] """ - return self._dynamic_properties + return self._system_resource_considerations - @dynamic_properties.setter - def dynamic_properties(self, dynamic_properties): + @system_resource_considerations.setter + def system_resource_considerations(self, system_resource_considerations): """ - Sets the dynamic_properties of this ReportingTaskDefinition. - Describes the dynamic properties supported by this component + Sets the system_resource_considerations of this ReportingTaskDefinition. + The system resource considerations for the given component - :param dynamic_properties: The dynamic_properties of this ReportingTaskDefinition. - :type: list[DynamicProperty] + :param system_resource_considerations: The system_resource_considerations of this ReportingTaskDefinition. + :type: list[SystemResourceConsideration] """ - self._dynamic_properties = dynamic_properties + self._system_resource_considerations = system_resource_considerations @property - def supported_scheduling_strategies(self): + def tags(self): """ - Gets the supported_scheduling_strategies of this ReportingTaskDefinition. - The supported scheduling strategies, such as TIME_DRIVER or CRON. + Gets the tags of this ReportingTaskDefinition. + The tags associated with this type - :return: The supported_scheduling_strategies of this ReportingTaskDefinition. + :return: The tags of this ReportingTaskDefinition. :rtype: list[str] """ - return self._supported_scheduling_strategies + return self._tags - @supported_scheduling_strategies.setter - def supported_scheduling_strategies(self, supported_scheduling_strategies): + @tags.setter + def tags(self, tags): """ - Sets the supported_scheduling_strategies of this ReportingTaskDefinition. - The supported scheduling strategies, such as TIME_DRIVER or CRON. + Sets the tags of this ReportingTaskDefinition. + The tags associated with this type - :param supported_scheduling_strategies: The supported_scheduling_strategies of this ReportingTaskDefinition. + :param tags: The tags of this ReportingTaskDefinition. :type: list[str] """ - self._supported_scheduling_strategies = supported_scheduling_strategies + self._tags = tags @property - def default_scheduling_strategy(self): + def type(self): """ - Gets the default_scheduling_strategy of this ReportingTaskDefinition. - The default scheduling strategy for the reporting task. + Gets the type of this ReportingTaskDefinition. + The fully-qualified class type - :return: The default_scheduling_strategy of this ReportingTaskDefinition. + :return: The type of this ReportingTaskDefinition. :rtype: str """ - return self._default_scheduling_strategy + return self._type - @default_scheduling_strategy.setter - def default_scheduling_strategy(self, default_scheduling_strategy): + @type.setter + def type(self, type): """ - Sets the default_scheduling_strategy of this ReportingTaskDefinition. - The default scheduling strategy for the reporting task. + Sets the type of this ReportingTaskDefinition. + The fully-qualified class type - :param default_scheduling_strategy: The default_scheduling_strategy of this ReportingTaskDefinition. + :param type: The type of this ReportingTaskDefinition. :type: str """ - self._default_scheduling_strategy = default_scheduling_strategy + self._type = type @property - def default_scheduling_period_by_scheduling_strategy(self): + def type_description(self): """ - Gets the default_scheduling_period_by_scheduling_strategy of this ReportingTaskDefinition. - The default scheduling period for each scheduling strategy. The scheduling period is expected to be a time period, such as \"30 sec\". + Gets the type_description of this ReportingTaskDefinition. + The description of the type. - :return: The default_scheduling_period_by_scheduling_strategy of this ReportingTaskDefinition. - :rtype: dict(str, str) + :return: The type_description of this ReportingTaskDefinition. + :rtype: str """ - return self._default_scheduling_period_by_scheduling_strategy + return self._type_description - @default_scheduling_period_by_scheduling_strategy.setter - def default_scheduling_period_by_scheduling_strategy(self, default_scheduling_period_by_scheduling_strategy): + @type_description.setter + def type_description(self, type_description): """ - Sets the default_scheduling_period_by_scheduling_strategy of this ReportingTaskDefinition. - The default scheduling period for each scheduling strategy. The scheduling period is expected to be a time period, such as \"30 sec\". + Sets the type_description of this ReportingTaskDefinition. + The description of the type. - :param default_scheduling_period_by_scheduling_strategy: The default_scheduling_period_by_scheduling_strategy of this ReportingTaskDefinition. - :type: dict(str, str) + :param type_description: The type_description of this ReportingTaskDefinition. + :type: str """ - self._default_scheduling_period_by_scheduling_strategy = default_scheduling_period_by_scheduling_strategy + self._type_description = type_description + + @property + def version(self): + """ + Gets the version of this ReportingTaskDefinition. + The version of the bundle that provides the referenced type. + + :return: The version of this ReportingTaskDefinition. + :rtype: str + """ + return self._version + + @version.setter + def version(self, version): + """ + Sets the version of this ReportingTaskDefinition. + The version of the bundle that provides the referenced type. + + :param version: The version of this ReportingTaskDefinition. + :type: str + """ + + self._version = version def to_dict(self): """ diff --git a/nipyapi/nifi/models/reporting_task_dto.py b/nipyapi/nifi/models/reporting_task_dto.py index 711b9b70..5f9bbd88 100644 --- a/nipyapi/nifi/models/reporting_task_dto.py +++ b/nipyapi/nifi/models/reporting_task_dto.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,360 +27,442 @@ class ReportingTaskDTO(object): and the value is json key in definition. """ swagger_types = { - 'id': 'str', - 'versioned_component_id': 'str', - 'parent_group_id': 'str', - 'position': 'PositionDTO', - 'name': 'str', - 'type': 'str', - 'bundle': 'BundleDTO', - 'state': 'str', - 'comments': 'str', - 'persists_state': 'bool', - 'restricted': 'bool', - 'deprecated': 'bool', - 'multiple_versions_available': 'bool', - 'supports_sensitive_dynamic_properties': 'bool', - 'scheduling_period': 'str', - 'scheduling_strategy': 'str', - 'default_scheduling_period': 'dict(str, str)', - 'properties': 'dict(str, str)', - 'descriptors': 'dict(str, PropertyDescriptorDTO)', - 'sensitive_dynamic_property_names': 'list[str]', - 'custom_ui_url': 'str', - 'annotation_data': 'str', - 'validation_errors': 'list[str]', - 'validation_status': 'str', 'active_thread_count': 'int', - 'extension_missing': 'bool' - } +'annotation_data': 'str', +'bundle': 'BundleDTO', +'comments': 'str', +'custom_ui_url': 'str', +'default_scheduling_period': 'dict(str, str)', +'deprecated': 'bool', +'descriptors': 'dict(str, PropertyDescriptorDTO)', +'extension_missing': 'bool', +'id': 'str', +'multiple_versions_available': 'bool', +'name': 'str', +'parent_group_id': 'str', +'persists_state': 'bool', +'position': 'PositionDTO', +'properties': 'dict(str, str)', +'restricted': 'bool', +'scheduling_period': 'str', +'scheduling_strategy': 'str', +'sensitive_dynamic_property_names': 'list[str]', +'state': 'str', +'supports_sensitive_dynamic_properties': 'bool', +'type': 'str', +'validation_errors': 'list[str]', +'validation_status': 'str', +'versioned_component_id': 'str' } attribute_map = { - 'id': 'id', - 'versioned_component_id': 'versionedComponentId', - 'parent_group_id': 'parentGroupId', - 'position': 'position', - 'name': 'name', - 'type': 'type', - 'bundle': 'bundle', - 'state': 'state', - 'comments': 'comments', - 'persists_state': 'persistsState', - 'restricted': 'restricted', - 'deprecated': 'deprecated', - 'multiple_versions_available': 'multipleVersionsAvailable', - 'supports_sensitive_dynamic_properties': 'supportsSensitiveDynamicProperties', - 'scheduling_period': 'schedulingPeriod', - 'scheduling_strategy': 'schedulingStrategy', - 'default_scheduling_period': 'defaultSchedulingPeriod', - 'properties': 'properties', - 'descriptors': 'descriptors', - 'sensitive_dynamic_property_names': 'sensitiveDynamicPropertyNames', - 'custom_ui_url': 'customUiUrl', - 'annotation_data': 'annotationData', - 'validation_errors': 'validationErrors', - 'validation_status': 'validationStatus', 'active_thread_count': 'activeThreadCount', - 'extension_missing': 'extensionMissing' - } - - def __init__(self, id=None, versioned_component_id=None, parent_group_id=None, position=None, name=None, type=None, bundle=None, state=None, comments=None, persists_state=None, restricted=None, deprecated=None, multiple_versions_available=None, supports_sensitive_dynamic_properties=None, scheduling_period=None, scheduling_strategy=None, default_scheduling_period=None, properties=None, descriptors=None, sensitive_dynamic_property_names=None, custom_ui_url=None, annotation_data=None, validation_errors=None, validation_status=None, active_thread_count=None, extension_missing=None): +'annotation_data': 'annotationData', +'bundle': 'bundle', +'comments': 'comments', +'custom_ui_url': 'customUiUrl', +'default_scheduling_period': 'defaultSchedulingPeriod', +'deprecated': 'deprecated', +'descriptors': 'descriptors', +'extension_missing': 'extensionMissing', +'id': 'id', +'multiple_versions_available': 'multipleVersionsAvailable', +'name': 'name', +'parent_group_id': 'parentGroupId', +'persists_state': 'persistsState', +'position': 'position', +'properties': 'properties', +'restricted': 'restricted', +'scheduling_period': 'schedulingPeriod', +'scheduling_strategy': 'schedulingStrategy', +'sensitive_dynamic_property_names': 'sensitiveDynamicPropertyNames', +'state': 'state', +'supports_sensitive_dynamic_properties': 'supportsSensitiveDynamicProperties', +'type': 'type', +'validation_errors': 'validationErrors', +'validation_status': 'validationStatus', +'versioned_component_id': 'versionedComponentId' } + + def __init__(self, active_thread_count=None, annotation_data=None, bundle=None, comments=None, custom_ui_url=None, default_scheduling_period=None, deprecated=None, descriptors=None, extension_missing=None, id=None, multiple_versions_available=None, name=None, parent_group_id=None, persists_state=None, position=None, properties=None, restricted=None, scheduling_period=None, scheduling_strategy=None, sensitive_dynamic_property_names=None, state=None, supports_sensitive_dynamic_properties=None, type=None, validation_errors=None, validation_status=None, versioned_component_id=None): """ ReportingTaskDTO - a model defined in Swagger """ - self._id = None - self._versioned_component_id = None - self._parent_group_id = None - self._position = None - self._name = None - self._type = None + self._active_thread_count = None + self._annotation_data = None self._bundle = None - self._state = None self._comments = None - self._persists_state = None - self._restricted = None + self._custom_ui_url = None + self._default_scheduling_period = None self._deprecated = None + self._descriptors = None + self._extension_missing = None + self._id = None self._multiple_versions_available = None - self._supports_sensitive_dynamic_properties = None + self._name = None + self._parent_group_id = None + self._persists_state = None + self._position = None + self._properties = None + self._restricted = None self._scheduling_period = None self._scheduling_strategy = None - self._default_scheduling_period = None - self._properties = None - self._descriptors = None self._sensitive_dynamic_property_names = None - self._custom_ui_url = None - self._annotation_data = None + self._state = None + self._supports_sensitive_dynamic_properties = None + self._type = None self._validation_errors = None self._validation_status = None - self._active_thread_count = None - self._extension_missing = None + self._versioned_component_id = None - if id is not None: - self.id = id - if versioned_component_id is not None: - self.versioned_component_id = versioned_component_id - if parent_group_id is not None: - self.parent_group_id = parent_group_id - if position is not None: - self.position = position - if name is not None: - self.name = name - if type is not None: - self.type = type + if active_thread_count is not None: + self.active_thread_count = active_thread_count + if annotation_data is not None: + self.annotation_data = annotation_data if bundle is not None: self.bundle = bundle - if state is not None: - self.state = state if comments is not None: self.comments = comments - if persists_state is not None: - self.persists_state = persists_state - if restricted is not None: - self.restricted = restricted + if custom_ui_url is not None: + self.custom_ui_url = custom_ui_url + if default_scheduling_period is not None: + self.default_scheduling_period = default_scheduling_period if deprecated is not None: self.deprecated = deprecated + if descriptors is not None: + self.descriptors = descriptors + if extension_missing is not None: + self.extension_missing = extension_missing + if id is not None: + self.id = id if multiple_versions_available is not None: self.multiple_versions_available = multiple_versions_available - if supports_sensitive_dynamic_properties is not None: - self.supports_sensitive_dynamic_properties = supports_sensitive_dynamic_properties + if name is not None: + self.name = name + if parent_group_id is not None: + self.parent_group_id = parent_group_id + if persists_state is not None: + self.persists_state = persists_state + if position is not None: + self.position = position + if properties is not None: + self.properties = properties + if restricted is not None: + self.restricted = restricted if scheduling_period is not None: self.scheduling_period = scheduling_period if scheduling_strategy is not None: self.scheduling_strategy = scheduling_strategy - if default_scheduling_period is not None: - self.default_scheduling_period = default_scheduling_period - if properties is not None: - self.properties = properties - if descriptors is not None: - self.descriptors = descriptors if sensitive_dynamic_property_names is not None: self.sensitive_dynamic_property_names = sensitive_dynamic_property_names - if custom_ui_url is not None: - self.custom_ui_url = custom_ui_url - if annotation_data is not None: - self.annotation_data = annotation_data + if state is not None: + self.state = state + if supports_sensitive_dynamic_properties is not None: + self.supports_sensitive_dynamic_properties = supports_sensitive_dynamic_properties + if type is not None: + self.type = type if validation_errors is not None: self.validation_errors = validation_errors if validation_status is not None: self.validation_status = validation_status - if active_thread_count is not None: - self.active_thread_count = active_thread_count - if extension_missing is not None: - self.extension_missing = extension_missing + if versioned_component_id is not None: + self.versioned_component_id = versioned_component_id @property - def id(self): + def active_thread_count(self): """ - Gets the id of this ReportingTaskDTO. - The id of the component. + Gets the active_thread_count of this ReportingTaskDTO. + The number of active threads for the reporting task. - :return: The id of this ReportingTaskDTO. + :return: The active_thread_count of this ReportingTaskDTO. + :rtype: int + """ + return self._active_thread_count + + @active_thread_count.setter + def active_thread_count(self, active_thread_count): + """ + Sets the active_thread_count of this ReportingTaskDTO. + The number of active threads for the reporting task. + + :param active_thread_count: The active_thread_count of this ReportingTaskDTO. + :type: int + """ + + self._active_thread_count = active_thread_count + + @property + 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. + + :return: The annotation_data of this ReportingTaskDTO. :rtype: str """ - return self._id + return self._annotation_data - @id.setter - def id(self, id): + @annotation_data.setter + def annotation_data(self, annotation_data): """ - Sets the id of this ReportingTaskDTO. - The id of the component. + 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. - :param id: The id of this ReportingTaskDTO. + :param annotation_data: The annotation_data of this ReportingTaskDTO. :type: str """ - self._id = id + self._annotation_data = annotation_data @property - def versioned_component_id(self): + def bundle(self): """ - Gets the versioned_component_id of this ReportingTaskDTO. - The ID of the corresponding component that is under version control + Gets the bundle of this ReportingTaskDTO. - :return: The versioned_component_id of this ReportingTaskDTO. + :return: The bundle of this ReportingTaskDTO. + :rtype: BundleDTO + """ + return self._bundle + + @bundle.setter + def bundle(self, bundle): + """ + Sets the bundle of this ReportingTaskDTO. + + :param bundle: The bundle of this ReportingTaskDTO. + :type: BundleDTO + """ + + self._bundle = bundle + + @property + def comments(self): + """ + Gets the comments of this ReportingTaskDTO. + The comments of the reporting task. + + :return: The comments of this ReportingTaskDTO. :rtype: str """ - return self._versioned_component_id + return self._comments - @versioned_component_id.setter - def versioned_component_id(self, versioned_component_id): + @comments.setter + def comments(self, comments): """ - Sets the versioned_component_id of this ReportingTaskDTO. - The ID of the corresponding component that is under version control + Sets the comments of this ReportingTaskDTO. + The comments of the reporting task. - :param versioned_component_id: The versioned_component_id of this ReportingTaskDTO. + :param comments: The comments of this ReportingTaskDTO. :type: str """ - self._versioned_component_id = versioned_component_id + self._comments = comments @property - def parent_group_id(self): + def custom_ui_url(self): """ - Gets the parent_group_id of this ReportingTaskDTO. - The id of parent process group of this component if applicable. + Gets the custom_ui_url of this ReportingTaskDTO. + The URL for the custom configuration UI for the reporting task. - :return: The parent_group_id of this ReportingTaskDTO. + :return: The custom_ui_url of this ReportingTaskDTO. :rtype: str """ - return self._parent_group_id + return self._custom_ui_url - @parent_group_id.setter - def parent_group_id(self, parent_group_id): + @custom_ui_url.setter + def custom_ui_url(self, custom_ui_url): """ - Sets the parent_group_id of this ReportingTaskDTO. - The id of parent process group of this component if applicable. + Sets the custom_ui_url of this ReportingTaskDTO. + The URL for the custom configuration UI for the reporting task. - :param parent_group_id: The parent_group_id of this ReportingTaskDTO. + :param custom_ui_url: The custom_ui_url of this ReportingTaskDTO. :type: str """ - self._parent_group_id = parent_group_id + self._custom_ui_url = custom_ui_url @property - def position(self): + def default_scheduling_period(self): """ - Gets the position of this ReportingTaskDTO. - The position of this component in the UI if applicable. + Gets the default_scheduling_period of this ReportingTaskDTO. + The default scheduling period for the different scheduling strategies. - :return: The position of this ReportingTaskDTO. - :rtype: PositionDTO + :return: The default_scheduling_period of this ReportingTaskDTO. + :rtype: dict(str, str) """ - return self._position + return self._default_scheduling_period - @position.setter - def position(self, position): + @default_scheduling_period.setter + def default_scheduling_period(self, default_scheduling_period): """ - Sets the position of this ReportingTaskDTO. - The position of this component in the UI if applicable. + Sets the default_scheduling_period of this ReportingTaskDTO. + The default scheduling period for the different scheduling strategies. - :param position: The position of this ReportingTaskDTO. - :type: PositionDTO + :param default_scheduling_period: The default_scheduling_period of this ReportingTaskDTO. + :type: dict(str, str) """ - self._position = position + self._default_scheduling_period = default_scheduling_period @property - def name(self): + def deprecated(self): """ - Gets the name of this ReportingTaskDTO. - The name of the reporting task. + Gets the deprecated of this ReportingTaskDTO. + Whether the reporting task has been deprecated. - :return: The name of this ReportingTaskDTO. - :rtype: str + :return: The deprecated of this ReportingTaskDTO. + :rtype: bool """ - return self._name + return self._deprecated - @name.setter - def name(self, name): + @deprecated.setter + def deprecated(self, deprecated): """ - Sets the name of this ReportingTaskDTO. - The name of the reporting task. + Sets the deprecated of this ReportingTaskDTO. + Whether the reporting task has been deprecated. - :param name: The name of this ReportingTaskDTO. - :type: str + :param deprecated: The deprecated of this ReportingTaskDTO. + :type: bool """ - self._name = name + self._deprecated = deprecated @property - def type(self): + def descriptors(self): """ - Gets the type of this ReportingTaskDTO. - The fully qualified type of the reporting task. + Gets the descriptors of this ReportingTaskDTO. + The descriptors for the reporting tasks properties. - :return: The type of this ReportingTaskDTO. + :return: The descriptors of this ReportingTaskDTO. + :rtype: dict(str, PropertyDescriptorDTO) + """ + return self._descriptors + + @descriptors.setter + def descriptors(self, descriptors): + """ + Sets the descriptors of this ReportingTaskDTO. + The descriptors for the reporting tasks properties. + + :param descriptors: The descriptors of this ReportingTaskDTO. + :type: dict(str, PropertyDescriptorDTO) + """ + + self._descriptors = descriptors + + @property + def extension_missing(self): + """ + Gets the extension_missing of this ReportingTaskDTO. + Whether the underlying extension is missing. + + :return: The extension_missing of this ReportingTaskDTO. + :rtype: bool + """ + return self._extension_missing + + @extension_missing.setter + def extension_missing(self, extension_missing): + """ + Sets the extension_missing of this ReportingTaskDTO. + Whether the underlying extension is missing. + + :param extension_missing: The extension_missing of this ReportingTaskDTO. + :type: bool + """ + + self._extension_missing = extension_missing + + @property + def id(self): + """ + Gets the id of this ReportingTaskDTO. + The id of the component. + + :return: The id of this ReportingTaskDTO. :rtype: str """ - return self._type + return self._id - @type.setter - def type(self, type): + @id.setter + def id(self, id): """ - Sets the type of this ReportingTaskDTO. - The fully qualified type of the reporting task. + Sets the id of this ReportingTaskDTO. + The id of the component. - :param type: The type of this ReportingTaskDTO. + :param id: The id of this ReportingTaskDTO. :type: str """ - self._type = type + self._id = id @property - def bundle(self): + def multiple_versions_available(self): """ - Gets the bundle of this ReportingTaskDTO. - The details of the artifact that bundled this reporting task type. + Gets the multiple_versions_available of this ReportingTaskDTO. + Whether the reporting task has multiple versions available. - :return: The bundle of this ReportingTaskDTO. - :rtype: BundleDTO + :return: The multiple_versions_available of this ReportingTaskDTO. + :rtype: bool """ - return self._bundle + return self._multiple_versions_available - @bundle.setter - def bundle(self, bundle): + @multiple_versions_available.setter + def multiple_versions_available(self, multiple_versions_available): """ - Sets the bundle of this ReportingTaskDTO. - The details of the artifact that bundled this reporting task type. + Sets the multiple_versions_available of this ReportingTaskDTO. + Whether the reporting task has multiple versions available. - :param bundle: The bundle of this ReportingTaskDTO. - :type: BundleDTO + :param multiple_versions_available: The multiple_versions_available of this ReportingTaskDTO. + :type: bool """ - self._bundle = bundle + self._multiple_versions_available = multiple_versions_available @property - def state(self): + def name(self): """ - Gets the state of this ReportingTaskDTO. - The state of the reporting task. + Gets the name of this ReportingTaskDTO. + The name of the reporting task. - :return: The state of this ReportingTaskDTO. + :return: The name of this ReportingTaskDTO. :rtype: str """ - return self._state + return self._name - @state.setter - def state(self, state): + @name.setter + def name(self, name): """ - Sets the state of this ReportingTaskDTO. - The state of the reporting task. + Sets the name of this ReportingTaskDTO. + The name of the reporting task. - :param state: The state of this ReportingTaskDTO. + :param name: The name 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) - ) - self._state = state + self._name = name @property - def comments(self): + def parent_group_id(self): """ - Gets the comments of this ReportingTaskDTO. - The comments of the reporting task. + Gets the parent_group_id of this ReportingTaskDTO. + The id of parent process group of this component if applicable. - :return: The comments of this ReportingTaskDTO. + :return: The parent_group_id of this ReportingTaskDTO. :rtype: str """ - return self._comments + return self._parent_group_id - @comments.setter - def comments(self, comments): + @parent_group_id.setter + def parent_group_id(self, parent_group_id): """ - Sets the comments of this ReportingTaskDTO. - The comments of the reporting task. + Sets the parent_group_id of this ReportingTaskDTO. + The id of parent process group of this component if applicable. - :param comments: The comments of this ReportingTaskDTO. + :param parent_group_id: The parent_group_id of this ReportingTaskDTO. :type: str """ - self._comments = comments + self._parent_group_id = parent_group_id @property def persists_state(self): @@ -407,96 +488,71 @@ def persists_state(self, persists_state): self._persists_state = persists_state @property - def restricted(self): - """ - Gets the restricted of this ReportingTaskDTO. - Whether the reporting task requires elevated privileges. - - :return: The restricted of this ReportingTaskDTO. - :rtype: bool - """ - return self._restricted - - @restricted.setter - def restricted(self, restricted): - """ - Sets the restricted of this ReportingTaskDTO. - Whether the reporting task requires elevated privileges. - - :param restricted: The restricted of this ReportingTaskDTO. - :type: bool - """ - - self._restricted = restricted - - @property - def deprecated(self): + def position(self): """ - Gets the deprecated of this ReportingTaskDTO. - Whether the reporting task has been deprecated. - - :return: The deprecated of this ReportingTaskDTO. - :rtype: bool + Gets the position of this ReportingTaskDTO. + + :return: The position of this ReportingTaskDTO. + :rtype: PositionDTO """ - return self._deprecated + return self._position - @deprecated.setter - def deprecated(self, deprecated): + @position.setter + def position(self, position): """ - Sets the deprecated of this ReportingTaskDTO. - Whether the reporting task has been deprecated. + Sets the position of this ReportingTaskDTO. - :param deprecated: The deprecated of this ReportingTaskDTO. - :type: bool + :param position: The position of this ReportingTaskDTO. + :type: PositionDTO """ - self._deprecated = deprecated + self._position = position @property - def multiple_versions_available(self): + def properties(self): """ - Gets the multiple_versions_available of this ReportingTaskDTO. - Whether the reporting task has multiple versions available. + Gets the properties of this ReportingTaskDTO. + The properties of the reporting task. - :return: The multiple_versions_available of this ReportingTaskDTO. - :rtype: bool + :return: The properties of this ReportingTaskDTO. + :rtype: dict(str, str) """ - return self._multiple_versions_available + return self._properties - @multiple_versions_available.setter - def multiple_versions_available(self, multiple_versions_available): + @properties.setter + def properties(self, properties): """ - Sets the multiple_versions_available of this ReportingTaskDTO. - Whether the reporting task has multiple versions available. + Sets the properties of this ReportingTaskDTO. + The properties of the reporting task. - :param multiple_versions_available: The multiple_versions_available of this ReportingTaskDTO. - :type: bool + :param properties: The properties of this ReportingTaskDTO. + :type: dict(str, str) """ - self._multiple_versions_available = multiple_versions_available + self._properties = properties @property - def supports_sensitive_dynamic_properties(self): + def restricted(self): """ - Gets the supports_sensitive_dynamic_properties of this ReportingTaskDTO. - Whether the reporting task supports sensitive dynamic properties. + Gets the restricted of this ReportingTaskDTO. + Whether the reporting task requires elevated privileges. - :return: The supports_sensitive_dynamic_properties of this ReportingTaskDTO. + :return: The restricted of this ReportingTaskDTO. :rtype: bool """ - return self._supports_sensitive_dynamic_properties + return self._restricted - @supports_sensitive_dynamic_properties.setter - def supports_sensitive_dynamic_properties(self, supports_sensitive_dynamic_properties): + @restricted.setter + def restricted(self, restricted): """ - Sets the supports_sensitive_dynamic_properties of this ReportingTaskDTO. - Whether the reporting task supports sensitive dynamic properties. + Sets the restricted of this ReportingTaskDTO. + Whether the reporting task requires elevated privileges. - :param supports_sensitive_dynamic_properties: The supports_sensitive_dynamic_properties of this ReportingTaskDTO. + :param restricted: The restricted of this ReportingTaskDTO. :type: bool """ - self._supports_sensitive_dynamic_properties = supports_sensitive_dynamic_properties + self._restricted = restricted @property def scheduling_period(self): @@ -544,75 +600,6 @@ def scheduling_strategy(self, scheduling_strategy): self._scheduling_strategy = scheduling_strategy - @property - def default_scheduling_period(self): - """ - Gets the default_scheduling_period of this ReportingTaskDTO. - The default scheduling period for the different scheduling strategies. - - :return: The default_scheduling_period of this ReportingTaskDTO. - :rtype: dict(str, str) - """ - return self._default_scheduling_period - - @default_scheduling_period.setter - def default_scheduling_period(self, default_scheduling_period): - """ - Sets the default_scheduling_period of this ReportingTaskDTO. - The default scheduling period for the different scheduling strategies. - - :param default_scheduling_period: The default_scheduling_period of this ReportingTaskDTO. - :type: dict(str, str) - """ - - self._default_scheduling_period = default_scheduling_period - - @property - def properties(self): - """ - Gets the properties of this ReportingTaskDTO. - The properties of the reporting task. - - :return: The properties of this ReportingTaskDTO. - :rtype: dict(str, str) - """ - return self._properties - - @properties.setter - def properties(self, properties): - """ - Sets the properties of this ReportingTaskDTO. - The properties of the reporting task. - - :param properties: The properties of this ReportingTaskDTO. - :type: dict(str, str) - """ - - self._properties = properties - - @property - def descriptors(self): - """ - Gets the descriptors of this ReportingTaskDTO. - The descriptors for the reporting tasks properties. - - :return: The descriptors of this ReportingTaskDTO. - :rtype: dict(str, PropertyDescriptorDTO) - """ - return self._descriptors - - @descriptors.setter - def descriptors(self, descriptors): - """ - Sets the descriptors of this ReportingTaskDTO. - The descriptors for the reporting tasks properties. - - :param descriptors: The descriptors of this ReportingTaskDTO. - :type: dict(str, PropertyDescriptorDTO) - """ - - self._descriptors = descriptors - @property def sensitive_dynamic_property_names(self): """ @@ -637,50 +624,79 @@ def sensitive_dynamic_property_names(self, sensitive_dynamic_property_names): self._sensitive_dynamic_property_names = sensitive_dynamic_property_names @property - def custom_ui_url(self): + def state(self): """ - Gets the custom_ui_url of this ReportingTaskDTO. - The URL for the custom configuration UI for the reporting task. + Gets the state of this ReportingTaskDTO. + The state of the reporting task. - :return: The custom_ui_url of this ReportingTaskDTO. + :return: The state of this ReportingTaskDTO. :rtype: str """ - return self._custom_ui_url + return self._state - @custom_ui_url.setter - def custom_ui_url(self, custom_ui_url): + @state.setter + def state(self, state): """ - Sets the custom_ui_url of this ReportingTaskDTO. - The URL for the custom configuration UI for the reporting task. + Sets the state of this ReportingTaskDTO. + The state of the reporting task. - :param custom_ui_url: The custom_ui_url of this ReportingTaskDTO. + :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) + ) + + self._state = state + + @property + def supports_sensitive_dynamic_properties(self): + """ + Gets the supports_sensitive_dynamic_properties of this ReportingTaskDTO. + Whether the reporting task supports sensitive dynamic properties. + + :return: The supports_sensitive_dynamic_properties of this ReportingTaskDTO. + :rtype: bool + """ + return self._supports_sensitive_dynamic_properties - self._custom_ui_url = custom_ui_url + @supports_sensitive_dynamic_properties.setter + def supports_sensitive_dynamic_properties(self, supports_sensitive_dynamic_properties): + """ + Sets the supports_sensitive_dynamic_properties of this ReportingTaskDTO. + Whether the reporting task supports sensitive dynamic properties. + + :param supports_sensitive_dynamic_properties: The supports_sensitive_dynamic_properties of this ReportingTaskDTO. + :type: bool + """ + + self._supports_sensitive_dynamic_properties = supports_sensitive_dynamic_properties @property - def annotation_data(self): + def type(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. + Gets the type of this ReportingTaskDTO. + The fully qualified type of the reporting task. - :return: The annotation_data of this ReportingTaskDTO. + :return: The type of this ReportingTaskDTO. :rtype: str """ - return self._annotation_data + return self._type - @annotation_data.setter - def annotation_data(self, annotation_data): + @type.setter + def type(self, type): """ - 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. + Sets the type of this ReportingTaskDTO. + The fully qualified type of the reporting task. - :param annotation_data: The annotation_data of this ReportingTaskDTO. + :param type: The type of this ReportingTaskDTO. :type: str """ - self._annotation_data = annotation_data + self._type = type @property def validation_errors(self): @@ -725,7 +741,7 @@ def validation_status(self, validation_status): :param validation_status: The validation_status of this ReportingTaskDTO. :type: str """ - allowed_values = ["VALID", "INVALID", "VALIDATING"] + 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}" @@ -735,50 +751,27 @@ def validation_status(self, validation_status): self._validation_status = validation_status @property - def active_thread_count(self): - """ - Gets the active_thread_count of this ReportingTaskDTO. - The number of active threads for the reporting task. - - :return: The active_thread_count of this ReportingTaskDTO. - :rtype: int - """ - return self._active_thread_count - - @active_thread_count.setter - def active_thread_count(self, active_thread_count): - """ - Sets the active_thread_count of this ReportingTaskDTO. - The number of active threads for the reporting task. - - :param active_thread_count: The active_thread_count of this ReportingTaskDTO. - :type: int - """ - - self._active_thread_count = active_thread_count - - @property - def extension_missing(self): + def versioned_component_id(self): """ - Gets the extension_missing of this ReportingTaskDTO. - Whether the underlying extension is missing. + Gets the versioned_component_id of this ReportingTaskDTO. + The ID of the corresponding component that is under version control - :return: The extension_missing of this ReportingTaskDTO. - :rtype: bool + :return: The versioned_component_id of this ReportingTaskDTO. + :rtype: str """ - return self._extension_missing + return self._versioned_component_id - @extension_missing.setter - def extension_missing(self, extension_missing): + @versioned_component_id.setter + def versioned_component_id(self, versioned_component_id): """ - Sets the extension_missing of this ReportingTaskDTO. - Whether the underlying extension is missing. + Sets the versioned_component_id of this ReportingTaskDTO. + The ID of the corresponding component that is under version control - :param extension_missing: The extension_missing of this ReportingTaskDTO. - :type: bool + :param versioned_component_id: The versioned_component_id of this ReportingTaskDTO. + :type: str """ - self._extension_missing = extension_missing + self._versioned_component_id = versioned_component_id def to_dict(self): """ diff --git a/nipyapi/nifi/models/reporting_task_entity.py b/nipyapi/nifi/models/reporting_task_entity.py index 1a148d2e..7149da61 100644 --- a/nipyapi/nifi/models/reporting_task_entity.py +++ b/nipyapi/nifi/models/reporting_task_entity.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,90 +27,132 @@ class ReportingTaskEntity(object): and the value is json key in definition. """ swagger_types = { - 'revision': 'RevisionDTO', - 'id': 'str', - 'uri': 'str', - 'position': 'PositionDTO', - 'permissions': 'PermissionsDTO', 'bulletins': 'list[BulletinEntity]', - 'disconnected_node_acknowledged': 'bool', - 'component': 'ReportingTaskDTO', - 'operate_permissions': 'PermissionsDTO', - 'status': 'ReportingTaskStatusDTO' - } +'component': 'ReportingTaskDTO', +'disconnected_node_acknowledged': 'bool', +'id': 'str', +'operate_permissions': 'PermissionsDTO', +'permissions': 'PermissionsDTO', +'position': 'PositionDTO', +'revision': 'RevisionDTO', +'status': 'ReportingTaskStatusDTO', +'uri': 'str' } attribute_map = { - 'revision': 'revision', - 'id': 'id', - 'uri': 'uri', - 'position': 'position', - 'permissions': 'permissions', 'bulletins': 'bulletins', - 'disconnected_node_acknowledged': 'disconnectedNodeAcknowledged', - 'component': 'component', - 'operate_permissions': 'operatePermissions', - 'status': 'status' - } - - def __init__(self, revision=None, id=None, uri=None, position=None, permissions=None, bulletins=None, disconnected_node_acknowledged=None, component=None, operate_permissions=None, status=None): +'component': 'component', +'disconnected_node_acknowledged': 'disconnectedNodeAcknowledged', +'id': 'id', +'operate_permissions': 'operatePermissions', +'permissions': 'permissions', +'position': 'position', +'revision': 'revision', +'status': 'status', +'uri': 'uri' } + + def __init__(self, bulletins=None, component=None, disconnected_node_acknowledged=None, id=None, operate_permissions=None, permissions=None, position=None, revision=None, status=None, uri=None): """ ReportingTaskEntity - a model defined in Swagger """ - self._revision = None - self._id = None - self._uri = None - self._position = None - self._permissions = None self._bulletins = None - self._disconnected_node_acknowledged = None self._component = None + self._disconnected_node_acknowledged = None + self._id = None self._operate_permissions = None + self._permissions = None + self._position = None + self._revision = None self._status = None + self._uri = None - if revision is not None: - self.revision = revision - if id is not None: - self.id = id - if uri is not None: - self.uri = uri - if position is not None: - self.position = position - if permissions is not None: - self.permissions = permissions if bulletins is not None: self.bulletins = bulletins - if disconnected_node_acknowledged is not None: - self.disconnected_node_acknowledged = disconnected_node_acknowledged if component is not None: self.component = component + if disconnected_node_acknowledged is not None: + self.disconnected_node_acknowledged = disconnected_node_acknowledged + if id is not None: + self.id = id if operate_permissions is not None: self.operate_permissions = operate_permissions + if permissions is not None: + self.permissions = permissions + if position is not None: + self.position = position + if revision is not None: + self.revision = revision if status is not None: self.status = status + if uri is not None: + self.uri = uri @property - def revision(self): + def bulletins(self): """ - Gets the revision of this ReportingTaskEntity. - The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses. + Gets the bulletins of this ReportingTaskEntity. + The bulletins for this component. - :return: The revision of this ReportingTaskEntity. - :rtype: RevisionDTO + :return: The bulletins of this ReportingTaskEntity. + :rtype: list[BulletinEntity] """ - return self._revision + return self._bulletins - @revision.setter - def revision(self, revision): + @bulletins.setter + def bulletins(self, bulletins): """ - Sets the revision of this ReportingTaskEntity. - The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses. + Sets the bulletins of this ReportingTaskEntity. + The bulletins for this component. - :param revision: The revision of this ReportingTaskEntity. - :type: RevisionDTO + :param bulletins: The bulletins of this ReportingTaskEntity. + :type: list[BulletinEntity] """ - self._revision = revision + self._bulletins = bulletins + + @property + def component(self): + """ + Gets the component of this ReportingTaskEntity. + + :return: The component of this ReportingTaskEntity. + :rtype: ReportingTaskDTO + """ + return self._component + + @component.setter + def component(self, component): + """ + Sets the component of this ReportingTaskEntity. + + :param component: The component of this ReportingTaskEntity. + :type: ReportingTaskDTO + """ + + self._component = component + + @property + def disconnected_node_acknowledged(self): + """ + Gets the disconnected_node_acknowledged of this ReportingTaskEntity. + Acknowledges that this node is disconnected to allow for mutable requests to proceed. + + :return: The disconnected_node_acknowledged of this ReportingTaskEntity. + :rtype: bool + """ + return self._disconnected_node_acknowledged + + @disconnected_node_acknowledged.setter + def disconnected_node_acknowledged(self, disconnected_node_acknowledged): + """ + Sets the disconnected_node_acknowledged of this ReportingTaskEntity. + Acknowledges that this node is disconnected to allow for mutable requests to proceed. + + :param disconnected_node_acknowledged: The disconnected_node_acknowledged of this ReportingTaskEntity. + :type: bool + """ + + self._disconnected_node_acknowledged = disconnected_node_acknowledged @property def id(self): @@ -137,56 +178,30 @@ def id(self, id): self._id = id @property - def uri(self): - """ - Gets the uri of this ReportingTaskEntity. - The URI for futures requests to the component. - - :return: The uri of this ReportingTaskEntity. - :rtype: str - """ - return self._uri - - @uri.setter - def uri(self, uri): - """ - Sets the uri of this ReportingTaskEntity. - The URI for futures requests to the component. - - :param uri: The uri of this ReportingTaskEntity. - :type: str - """ - - self._uri = uri - - @property - def position(self): + def operate_permissions(self): """ - Gets the position of this ReportingTaskEntity. - The position of this component in the UI if applicable. + Gets the operate_permissions of this ReportingTaskEntity. - :return: The position of this ReportingTaskEntity. - :rtype: PositionDTO + :return: The operate_permissions of this ReportingTaskEntity. + :rtype: PermissionsDTO """ - return self._position + return self._operate_permissions - @position.setter - def position(self, position): + @operate_permissions.setter + def operate_permissions(self, operate_permissions): """ - Sets the position of this ReportingTaskEntity. - The position of this component in the UI if applicable. + Sets the operate_permissions of this ReportingTaskEntity. - :param position: The position of this ReportingTaskEntity. - :type: PositionDTO + :param operate_permissions: The operate_permissions of this ReportingTaskEntity. + :type: PermissionsDTO """ - self._position = position + self._operate_permissions = operate_permissions @property def permissions(self): """ Gets the permissions of this ReportingTaskEntity. - The permissions for this component. :return: The permissions of this ReportingTaskEntity. :rtype: PermissionsDTO @@ -197,7 +212,6 @@ def permissions(self): def permissions(self, permissions): """ Sets the permissions of this ReportingTaskEntity. - The permissions for this component. :param permissions: The permissions of this ReportingTaskEntity. :type: PermissionsDTO @@ -206,100 +220,51 @@ def permissions(self, permissions): self._permissions = permissions @property - def bulletins(self): - """ - Gets the bulletins of this ReportingTaskEntity. - The bulletins for this component. - - :return: The bulletins of this ReportingTaskEntity. - :rtype: list[BulletinEntity] - """ - return self._bulletins - - @bulletins.setter - def bulletins(self, bulletins): - """ - Sets the bulletins of this ReportingTaskEntity. - The bulletins for this component. - - :param bulletins: The bulletins of this ReportingTaskEntity. - :type: list[BulletinEntity] - """ - - self._bulletins = bulletins - - @property - def disconnected_node_acknowledged(self): - """ - Gets the disconnected_node_acknowledged of this ReportingTaskEntity. - Acknowledges that this node is disconnected to allow for mutable requests to proceed. - - :return: The disconnected_node_acknowledged of this ReportingTaskEntity. - :rtype: bool - """ - return self._disconnected_node_acknowledged - - @disconnected_node_acknowledged.setter - def disconnected_node_acknowledged(self, disconnected_node_acknowledged): - """ - Sets the disconnected_node_acknowledged of this ReportingTaskEntity. - Acknowledges that this node is disconnected to allow for mutable requests to proceed. - - :param disconnected_node_acknowledged: The disconnected_node_acknowledged of this ReportingTaskEntity. - :type: bool - """ - - self._disconnected_node_acknowledged = disconnected_node_acknowledged - - @property - def component(self): + def position(self): """ - Gets the component of this ReportingTaskEntity. + Gets the position of this ReportingTaskEntity. - :return: The component of this ReportingTaskEntity. - :rtype: ReportingTaskDTO + :return: The position of this ReportingTaskEntity. + :rtype: PositionDTO """ - return self._component + return self._position - @component.setter - def component(self, component): + @position.setter + def position(self, position): """ - Sets the component of this ReportingTaskEntity. + Sets the position of this ReportingTaskEntity. - :param component: The component of this ReportingTaskEntity. - :type: ReportingTaskDTO + :param position: The position of this ReportingTaskEntity. + :type: PositionDTO """ - self._component = component + self._position = position @property - def operate_permissions(self): + def revision(self): """ - Gets the operate_permissions of this ReportingTaskEntity. - The permissions for this component operations. + Gets the revision of this ReportingTaskEntity. - :return: The operate_permissions of this ReportingTaskEntity. - :rtype: PermissionsDTO + :return: The revision of this ReportingTaskEntity. + :rtype: RevisionDTO """ - return self._operate_permissions + return self._revision - @operate_permissions.setter - def operate_permissions(self, operate_permissions): + @revision.setter + def revision(self, revision): """ - Sets the operate_permissions of this ReportingTaskEntity. - The permissions for this component operations. + Sets the revision of this ReportingTaskEntity. - :param operate_permissions: The operate_permissions of this ReportingTaskEntity. - :type: PermissionsDTO + :param revision: The revision of this ReportingTaskEntity. + :type: RevisionDTO """ - self._operate_permissions = operate_permissions + self._revision = revision @property def status(self): """ Gets the status of this ReportingTaskEntity. - The status for this ReportingTask. :return: The status of this ReportingTaskEntity. :rtype: ReportingTaskStatusDTO @@ -310,7 +275,6 @@ def status(self): def status(self, status): """ Sets the status of this ReportingTaskEntity. - The status for this ReportingTask. :param status: The status of this ReportingTaskEntity. :type: ReportingTaskStatusDTO @@ -318,6 +282,29 @@ def status(self, status): self._status = status + @property + def uri(self): + """ + Gets the uri of this ReportingTaskEntity. + The URI for futures requests to the component. + + :return: The uri of this ReportingTaskEntity. + :rtype: str + """ + return self._uri + + @uri.setter + def uri(self, uri): + """ + Sets the uri of this ReportingTaskEntity. + The URI for futures requests to the component. + + :param uri: The uri of this ReportingTaskEntity. + :type: str + """ + + self._uri = uri + def to_dict(self): """ Returns the model properties as a dict diff --git a/nipyapi/nifi/models/reporting_task_run_status_entity.py b/nipyapi/nifi/models/reporting_task_run_status_entity.py index ff38a1cb..8534a336 100644 --- a/nipyapi/nifi/models/reporting_task_run_status_entity.py +++ b/nipyapi/nifi/models/reporting_task_run_status_entity.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,38 +27,58 @@ class ReportingTaskRunStatusEntity(object): and the value is json key in definition. """ swagger_types = { - 'revision': 'RevisionDTO', - 'state': 'str', - 'disconnected_node_acknowledged': 'bool' - } + 'disconnected_node_acknowledged': 'bool', +'revision': 'RevisionDTO', +'state': 'str' } attribute_map = { - 'revision': 'revision', - 'state': 'state', - 'disconnected_node_acknowledged': 'disconnectedNodeAcknowledged' - } + 'disconnected_node_acknowledged': 'disconnectedNodeAcknowledged', +'revision': 'revision', +'state': 'state' } - def __init__(self, revision=None, state=None, disconnected_node_acknowledged=None): + def __init__(self, disconnected_node_acknowledged=None, revision=None, state=None): """ ReportingTaskRunStatusEntity - a model defined in Swagger """ + self._disconnected_node_acknowledged = None self._revision = None self._state = None - self._disconnected_node_acknowledged = None + if disconnected_node_acknowledged is not None: + self.disconnected_node_acknowledged = disconnected_node_acknowledged if revision is not None: self.revision = revision if state is not None: self.state = state - if disconnected_node_acknowledged is not None: - self.disconnected_node_acknowledged = disconnected_node_acknowledged + + @property + def disconnected_node_acknowledged(self): + """ + Gets the disconnected_node_acknowledged of this ReportingTaskRunStatusEntity. + Acknowledges that this node is disconnected to allow for mutable requests to proceed. + + :return: The disconnected_node_acknowledged of this ReportingTaskRunStatusEntity. + :rtype: bool + """ + return self._disconnected_node_acknowledged + + @disconnected_node_acknowledged.setter + def disconnected_node_acknowledged(self, disconnected_node_acknowledged): + """ + Sets the disconnected_node_acknowledged of this ReportingTaskRunStatusEntity. + Acknowledges that this node is disconnected to allow for mutable requests to proceed. + + :param disconnected_node_acknowledged: The disconnected_node_acknowledged of this ReportingTaskRunStatusEntity. + :type: bool + """ + + self._disconnected_node_acknowledged = disconnected_node_acknowledged @property def revision(self): """ Gets the revision of this ReportingTaskRunStatusEntity. - The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses. :return: The revision of this ReportingTaskRunStatusEntity. :rtype: RevisionDTO @@ -70,7 +89,6 @@ def revision(self): def revision(self, revision): """ Sets the revision of this ReportingTaskRunStatusEntity. - The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses. :param revision: The revision of this ReportingTaskRunStatusEntity. :type: RevisionDTO @@ -98,7 +116,7 @@ def state(self, state): :param state: The state of this ReportingTaskRunStatusEntity. :type: str """ - allowed_values = ["RUNNING", "STOPPED"] + allowed_values = ["RUNNING", "STOPPED", ] if state not in allowed_values: raise ValueError( "Invalid value for `state` ({0}), must be one of {1}" @@ -107,29 +125,6 @@ def state(self, state): self._state = state - @property - def disconnected_node_acknowledged(self): - """ - Gets the disconnected_node_acknowledged of this ReportingTaskRunStatusEntity. - Acknowledges that this node is disconnected to allow for mutable requests to proceed. - - :return: The disconnected_node_acknowledged of this ReportingTaskRunStatusEntity. - :rtype: bool - """ - return self._disconnected_node_acknowledged - - @disconnected_node_acknowledged.setter - def disconnected_node_acknowledged(self, disconnected_node_acknowledged): - """ - Sets the disconnected_node_acknowledged of this ReportingTaskRunStatusEntity. - Acknowledges that this node is disconnected to allow for mutable requests to proceed. - - :param disconnected_node_acknowledged: The disconnected_node_acknowledged of this ReportingTaskRunStatusEntity. - :type: bool - """ - - self._disconnected_node_acknowledged = disconnected_node_acknowledged - def to_dict(self): """ Returns the model properties as a dict diff --git a/nipyapi/nifi/models/reporting_task_status_dto.py b/nipyapi/nifi/models/reporting_task_status_dto.py index bca66758..06289b96 100644 --- a/nipyapi/nifi/models/reporting_task_status_dto.py +++ b/nipyapi/nifi/models/reporting_task_status_dto.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,32 +27,53 @@ class ReportingTaskStatusDTO(object): and the value is json key in definition. """ swagger_types = { - 'run_status': 'str', - 'validation_status': 'str', - 'active_thread_count': 'int' - } + 'active_thread_count': 'int', +'run_status': 'str', +'validation_status': 'str' } attribute_map = { - 'run_status': 'runStatus', - 'validation_status': 'validationStatus', - 'active_thread_count': 'activeThreadCount' - } + 'active_thread_count': 'activeThreadCount', +'run_status': 'runStatus', +'validation_status': 'validationStatus' } - def __init__(self, run_status=None, validation_status=None, active_thread_count=None): + def __init__(self, active_thread_count=None, run_status=None, validation_status=None): """ ReportingTaskStatusDTO - a model defined in Swagger """ + self._active_thread_count = None self._run_status = None self._validation_status = None - self._active_thread_count = None + if active_thread_count is not None: + self.active_thread_count = active_thread_count if run_status is not None: self.run_status = run_status if validation_status is not None: self.validation_status = validation_status - if active_thread_count is not None: - self.active_thread_count = active_thread_count + + @property + def active_thread_count(self): + """ + Gets the active_thread_count of this ReportingTaskStatusDTO. + The number of active threads for the component. + + :return: The active_thread_count of this ReportingTaskStatusDTO. + :rtype: int + """ + return self._active_thread_count + + @active_thread_count.setter + def active_thread_count(self, active_thread_count): + """ + Sets the active_thread_count of this ReportingTaskStatusDTO. + The number of active threads for the component. + + :param active_thread_count: The active_thread_count of this ReportingTaskStatusDTO. + :type: int + """ + + self._active_thread_count = active_thread_count @property def run_status(self): @@ -75,7 +95,7 @@ def run_status(self, run_status): :param run_status: The run_status of this ReportingTaskStatusDTO. :type: str """ - allowed_values = ["RUNNING", "STOPPED", "DISABLED"] + 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}" @@ -104,7 +124,7 @@ def validation_status(self, validation_status): :param validation_status: The validation_status of this ReportingTaskStatusDTO. :type: str """ - allowed_values = ["VALID", "INVALID", "VALIDATING"] + 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}" @@ -113,29 +133,6 @@ def validation_status(self, validation_status): self._validation_status = validation_status - @property - def active_thread_count(self): - """ - Gets the active_thread_count of this ReportingTaskStatusDTO. - The number of active threads for the component. - - :return: The active_thread_count of this ReportingTaskStatusDTO. - :rtype: int - """ - return self._active_thread_count - - @active_thread_count.setter - def active_thread_count(self, active_thread_count): - """ - Sets the active_thread_count of this ReportingTaskStatusDTO. - The number of active threads for the component. - - :param active_thread_count: The active_thread_count of this ReportingTaskStatusDTO. - :type: int - """ - - self._active_thread_count = active_thread_count - def to_dict(self): """ Returns the model properties as a dict diff --git a/nipyapi/nifi/models/reporting_task_types_entity.py b/nipyapi/nifi/models/reporting_task_types_entity.py index 113a042c..d644f528 100644 --- a/nipyapi/nifi/models/reporting_task_types_entity.py +++ b/nipyapi/nifi/models/reporting_task_types_entity.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,12 +27,10 @@ class ReportingTaskTypesEntity(object): and the value is json key in definition. """ swagger_types = { - 'reporting_task_types': 'list[DocumentedTypeDTO]' - } + 'reporting_task_types': 'list[DocumentedTypeDTO]' } attribute_map = { - 'reporting_task_types': 'reportingTaskTypes' - } + 'reporting_task_types': 'reportingTaskTypes' } def __init__(self, reporting_task_types=None): """ diff --git a/nipyapi/nifi/models/reporting_tasks_entity.py b/nipyapi/nifi/models/reporting_tasks_entity.py index be75dc81..44a6d6db 100644 --- a/nipyapi/nifi/models/reporting_tasks_entity.py +++ b/nipyapi/nifi/models/reporting_tasks_entity.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,23 +27,49 @@ class ReportingTasksEntity(object): and the value is json key in definition. """ swagger_types = { - 'reporting_tasks': 'list[ReportingTaskEntity]' - } + 'current_time': 'str', +'reporting_tasks': 'list[ReportingTaskEntity]' } attribute_map = { - 'reporting_tasks': 'reportingTasks' - } + 'current_time': 'currentTime', +'reporting_tasks': 'reportingTasks' } - def __init__(self, reporting_tasks=None): + def __init__(self, current_time=None, reporting_tasks=None): """ ReportingTasksEntity - a model defined in Swagger """ + self._current_time = None self._reporting_tasks = None + if current_time is not None: + self.current_time = current_time if reporting_tasks is not None: self.reporting_tasks = reporting_tasks + @property + def current_time(self): + """ + Gets the current_time of this ReportingTasksEntity. + The current time on the system. + + :return: The current_time of this ReportingTasksEntity. + :rtype: str + """ + return self._current_time + + @current_time.setter + def current_time(self, current_time): + """ + Sets the current_time of this ReportingTasksEntity. + The current time on the system. + + :param current_time: The current_time of this ReportingTasksEntity. + :type: str + """ + + self._current_time = current_time + @property def reporting_tasks(self): """ diff --git a/nipyapi/nifi/models/repository_usage_dto.py b/nipyapi/nifi/models/repository_usage_dto.py deleted file mode 100644 index 75d5e83f..00000000 --- a/nipyapi/nifi/models/repository_usage_dto.py +++ /dev/null @@ -1,290 +0,0 @@ -""" - NiFi Rest API - - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - - OpenAPI spec version: 1.28.1 - Contact: dev@nifi.apache.org - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - - -from pprint import pformat -import re - - -class RepositoryUsageDTO(object): - """ - NOTE: This class is auto generated by the swagger code generator program. - Do not edit the class manually. - """ - - - """ - Attributes: - swagger_types (dict): The key is attribute name - and the value is attribute type. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - """ - swagger_types = { - 'name': 'str', - 'file_store_hash': 'str', - 'free_space': 'str', - 'total_space': 'str', - 'free_space_bytes': 'int', - 'total_space_bytes': 'int', - 'utilization': 'str' - } - - attribute_map = { - 'name': 'name', - 'file_store_hash': 'fileStoreHash', - 'free_space': 'freeSpace', - 'total_space': 'totalSpace', - 'free_space_bytes': 'freeSpaceBytes', - 'total_space_bytes': 'totalSpaceBytes', - 'utilization': 'utilization' - } - - def __init__(self, name=None, file_store_hash=None, free_space=None, total_space=None, free_space_bytes=None, total_space_bytes=None, utilization=None): - """ - RepositoryUsageDTO - a model defined in Swagger - """ - - self._name = None - self._file_store_hash = None - self._free_space = None - self._total_space = None - self._free_space_bytes = None - self._total_space_bytes = None - self._utilization = None - - if name is not None: - self.name = name - if file_store_hash is not None: - self.file_store_hash = file_store_hash - if free_space is not None: - self.free_space = free_space - if total_space is not None: - self.total_space = total_space - if free_space_bytes is not None: - self.free_space_bytes = free_space_bytes - if total_space_bytes is not None: - self.total_space_bytes = total_space_bytes - if utilization is not None: - self.utilization = utilization - - @property - def name(self): - """ - Gets the name of this RepositoryUsageDTO. - The name of the repository - - :return: The name of this RepositoryUsageDTO. - :rtype: str - """ - return self._name - - @name.setter - def name(self, name): - """ - Sets the name of this RepositoryUsageDTO. - The name of the repository - - :param name: The name of this RepositoryUsageDTO. - :type: str - """ - - self._name = name - - @property - def file_store_hash(self): - """ - Gets the file_store_hash of this RepositoryUsageDTO. - A SHA-256 hash of the File Store name/path that is used to store the repository's data. This information is exposed as a hash in order to avoid exposing potentially sensitive information that is not generally relevant. What is typically relevant is whether or not multiple repositories on the same node are using the same File Store, as this indicates that the repositories are competing for the resources of the backing disk/storage mechanism. - - :return: The file_store_hash of this RepositoryUsageDTO. - :rtype: str - """ - return self._file_store_hash - - @file_store_hash.setter - def file_store_hash(self, file_store_hash): - """ - Sets the file_store_hash of this RepositoryUsageDTO. - A SHA-256 hash of the File Store name/path that is used to store the repository's data. This information is exposed as a hash in order to avoid exposing potentially sensitive information that is not generally relevant. What is typically relevant is whether or not multiple repositories on the same node are using the same File Store, as this indicates that the repositories are competing for the resources of the backing disk/storage mechanism. - - :param file_store_hash: The file_store_hash of this RepositoryUsageDTO. - :type: str - """ - - self._file_store_hash = file_store_hash - - @property - def free_space(self): - """ - Gets the free_space of this RepositoryUsageDTO. - Amount of free space. - - :return: The free_space of this RepositoryUsageDTO. - :rtype: str - """ - return self._free_space - - @free_space.setter - def free_space(self, free_space): - """ - Sets the free_space of this RepositoryUsageDTO. - Amount of free space. - - :param free_space: The free_space of this RepositoryUsageDTO. - :type: str - """ - - self._free_space = free_space - - @property - def total_space(self): - """ - Gets the total_space of this RepositoryUsageDTO. - Amount of total space. - - :return: The total_space of this RepositoryUsageDTO. - :rtype: str - """ - return self._total_space - - @total_space.setter - def total_space(self, total_space): - """ - Sets the total_space of this RepositoryUsageDTO. - Amount of total space. - - :param total_space: The total_space of this RepositoryUsageDTO. - :type: str - """ - - self._total_space = total_space - - @property - def free_space_bytes(self): - """ - Gets the free_space_bytes of this RepositoryUsageDTO. - The number of bytes of free space. - - :return: The free_space_bytes of this RepositoryUsageDTO. - :rtype: int - """ - return self._free_space_bytes - - @free_space_bytes.setter - def free_space_bytes(self, free_space_bytes): - """ - Sets the free_space_bytes of this RepositoryUsageDTO. - The number of bytes of free space. - - :param free_space_bytes: The free_space_bytes of this RepositoryUsageDTO. - :type: int - """ - - self._free_space_bytes = free_space_bytes - - @property - def total_space_bytes(self): - """ - Gets the total_space_bytes of this RepositoryUsageDTO. - The number of bytes of total space. - - :return: The total_space_bytes of this RepositoryUsageDTO. - :rtype: int - """ - return self._total_space_bytes - - @total_space_bytes.setter - def total_space_bytes(self, total_space_bytes): - """ - Sets the total_space_bytes of this RepositoryUsageDTO. - The number of bytes of total space. - - :param total_space_bytes: The total_space_bytes of this RepositoryUsageDTO. - :type: int - """ - - self._total_space_bytes = total_space_bytes - - @property - def utilization(self): - """ - Gets the utilization of this RepositoryUsageDTO. - Utilization of this storage location. - - :return: The utilization of this RepositoryUsageDTO. - :rtype: str - """ - return self._utilization - - @utilization.setter - def utilization(self, utilization): - """ - Sets the utilization of this RepositoryUsageDTO. - Utilization of this storage location. - - :param utilization: The utilization of this RepositoryUsageDTO. - :type: str - """ - - self._utilization = utilization - - 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, RepositoryUsageDTO): - 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/required_permission_dto.py b/nipyapi/nifi/models/required_permission_dto.py index af8ac065..65ad7534 100644 --- a/nipyapi/nifi/models/required_permission_dto.py +++ b/nipyapi/nifi/models/required_permission_dto.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -29,13 +28,11 @@ class RequiredPermissionDTO(object): """ swagger_types = { 'id': 'str', - 'label': 'str' - } +'label': 'str' } attribute_map = { 'id': 'id', - 'label': 'label' - } +'label': 'label' } def __init__(self, id=None, label=None): """ diff --git a/nipyapi/nifi/models/resource_claim_details_dto.py b/nipyapi/nifi/models/resource_claim_details_dto.py new file mode 100644 index 00000000..3086adb0 --- /dev/null +++ b/nipyapi/nifi/models/resource_claim_details_dto.py @@ -0,0 +1,287 @@ +""" + Apache NiFi REST API + + REST API definition for Apache NiFi web services + + OpenAPI spec version: 2.5.0 + Contact: dev@nifi.apache.org + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from pprint import pformat +import re + + +class ResourceClaimDetailsDTO(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 = { + 'awaiting_destruction': 'bool', +'claimant_count': 'int', +'container': 'str', +'identifier': 'str', +'in_use': 'bool', +'section': 'str', +'writable': 'bool' } + + attribute_map = { + 'awaiting_destruction': 'awaitingDestruction', +'claimant_count': 'claimantCount', +'container': 'container', +'identifier': 'identifier', +'in_use': 'inUse', +'section': 'section', +'writable': 'writable' } + + def __init__(self, awaiting_destruction=None, claimant_count=None, container=None, identifier=None, in_use=None, section=None, writable=None): + """ + ResourceClaimDetailsDTO - a model defined in Swagger + """ + + self._awaiting_destruction = None + self._claimant_count = None + self._container = None + self._identifier = None + self._in_use = None + self._section = None + self._writable = None + + if awaiting_destruction is not None: + self.awaiting_destruction = awaiting_destruction + if claimant_count is not None: + self.claimant_count = claimant_count + if container is not None: + self.container = container + if identifier is not None: + self.identifier = identifier + if in_use is not None: + self.in_use = in_use + if section is not None: + self.section = section + if writable is not None: + self.writable = writable + + @property + def awaiting_destruction(self): + """ + Gets the awaiting_destruction of this ResourceClaimDetailsDTO. + Whether or not the Resource Claim is awaiting destruction + + :return: The awaiting_destruction of this ResourceClaimDetailsDTO. + :rtype: bool + """ + return self._awaiting_destruction + + @awaiting_destruction.setter + def awaiting_destruction(self, awaiting_destruction): + """ + Sets the awaiting_destruction of this ResourceClaimDetailsDTO. + Whether or not the Resource Claim is awaiting destruction + + :param awaiting_destruction: The awaiting_destruction of this ResourceClaimDetailsDTO. + :type: bool + """ + + self._awaiting_destruction = awaiting_destruction + + @property + def claimant_count(self): + """ + Gets the claimant_count of this ResourceClaimDetailsDTO. + The number of FlowFiles that have a claim to the Resource + + :return: The claimant_count of this ResourceClaimDetailsDTO. + :rtype: int + """ + return self._claimant_count + + @claimant_count.setter + def claimant_count(self, claimant_count): + """ + Sets the claimant_count of this ResourceClaimDetailsDTO. + The number of FlowFiles that have a claim to the Resource + + :param claimant_count: The claimant_count of this ResourceClaimDetailsDTO. + :type: int + """ + + self._claimant_count = claimant_count + + @property + def container(self): + """ + Gets the container of this ResourceClaimDetailsDTO. + The container of the Content Repository in which the Resource Claim exists + + :return: The container of this ResourceClaimDetailsDTO. + :rtype: str + """ + return self._container + + @container.setter + def container(self, container): + """ + Sets the container of this ResourceClaimDetailsDTO. + The container of the Content Repository in which the Resource Claim exists + + :param container: The container of this ResourceClaimDetailsDTO. + :type: str + """ + + self._container = container + + @property + def identifier(self): + """ + Gets the identifier of this ResourceClaimDetailsDTO. + The identifier of the Resource Claim + + :return: The identifier of this ResourceClaimDetailsDTO. + :rtype: str + """ + return self._identifier + + @identifier.setter + def identifier(self, identifier): + """ + Sets the identifier of this ResourceClaimDetailsDTO. + The identifier of the Resource Claim + + :param identifier: The identifier of this ResourceClaimDetailsDTO. + :type: str + """ + + self._identifier = identifier + + @property + def in_use(self): + """ + Gets the in_use of this ResourceClaimDetailsDTO. + Whether or not the Resource Claim is in use + + :return: The in_use of this ResourceClaimDetailsDTO. + :rtype: bool + """ + return self._in_use + + @in_use.setter + def in_use(self, in_use): + """ + Sets the in_use of this ResourceClaimDetailsDTO. + Whether or not the Resource Claim is in use + + :param in_use: The in_use of this ResourceClaimDetailsDTO. + :type: bool + """ + + self._in_use = in_use + + @property + def section(self): + """ + Gets the section of this ResourceClaimDetailsDTO. + The section of the Content Repository in which the Resource Claim exists + + :return: The section of this ResourceClaimDetailsDTO. + :rtype: str + """ + return self._section + + @section.setter + def section(self, section): + """ + Sets the section of this ResourceClaimDetailsDTO. + The section of the Content Repository in which the Resource Claim exists + + :param section: The section of this ResourceClaimDetailsDTO. + :type: str + """ + + self._section = section + + @property + def writable(self): + """ + Gets the writable of this ResourceClaimDetailsDTO. + Whether or not the Resource Claim can still have more data written to it + + :return: The writable of this ResourceClaimDetailsDTO. + :rtype: bool + """ + return self._writable + + @writable.setter + def writable(self, writable): + """ + Sets the writable of this ResourceClaimDetailsDTO. + Whether or not the Resource Claim can still have more data written to it + + :param writable: The writable of this ResourceClaimDetailsDTO. + :type: bool + """ + + self._writable = writable + + 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, ResourceClaimDetailsDTO): + 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/resource_dto.py b/nipyapi/nifi/models/resource_dto.py index 7005ac57..e84ba61a 100644 --- a/nipyapi/nifi/models/resource_dto.py +++ b/nipyapi/nifi/models/resource_dto.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -29,13 +28,11 @@ class ResourceDTO(object): """ swagger_types = { 'identifier': 'str', - 'name': 'str' - } +'name': 'str' } attribute_map = { 'identifier': 'identifier', - 'name': 'name' - } +'name': 'name' } def __init__(self, identifier=None, name=None): """ diff --git a/nipyapi/nifi/models/resources_entity.py b/nipyapi/nifi/models/resources_entity.py index 59fee02e..4a7b22de 100644 --- a/nipyapi/nifi/models/resources_entity.py +++ b/nipyapi/nifi/models/resources_entity.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,12 +27,10 @@ class ResourcesEntity(object): and the value is json key in definition. """ swagger_types = { - 'resources': 'list[ResourceDTO]' - } + 'resources': 'list[ResourceDTO]' } attribute_map = { - 'resources': 'resources' - } + 'resources': 'resources' } def __init__(self, resources=None): """ diff --git a/nipyapi/nifi/models/response.py b/nipyapi/nifi/models/response.py deleted file mode 100644 index cfed9291..00000000 --- a/nipyapi/nifi/models/response.py +++ /dev/null @@ -1,172 +0,0 @@ -""" - NiFi Rest API - - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - - OpenAPI spec version: 1.28.1 - Contact: dev@nifi.apache.org - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - - -from pprint import pformat -import re - - -class Response(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 = { - 'status': 'int', - 'metadata': 'dict(str, list[object])', - 'entity': 'object' - } - - attribute_map = { - 'status': 'status', - 'metadata': 'metadata', - 'entity': 'entity' - } - - def __init__(self, status=None, metadata=None, entity=None): - """ - Response - a model defined in Swagger - """ - - self._status = None - self._metadata = None - self._entity = None - - if status is not None: - self.status = status - if metadata is not None: - self.metadata = metadata - if entity is not None: - self.entity = entity - - @property - def status(self): - """ - Gets the status of this Response. - - :return: The status of this Response. - :rtype: int - """ - return self._status - - @status.setter - def status(self, status): - """ - Sets the status of this Response. - - :param status: The status of this Response. - :type: int - """ - - self._status = status - - @property - def metadata(self): - """ - Gets the metadata of this Response. - - :return: The metadata of this Response. - :rtype: dict(str, list[object]) - """ - return self._metadata - - @metadata.setter - def metadata(self, metadata): - """ - Sets the metadata of this Response. - - :param metadata: The metadata of this Response. - :type: dict(str, list[object]) - """ - - self._metadata = metadata - - @property - def entity(self): - """ - Gets the entity of this Response. - - :return: The entity of this Response. - :rtype: object - """ - return self._entity - - @entity.setter - def entity(self, entity): - """ - Sets the entity of this Response. - - :param entity: The entity of this Response. - :type: object - """ - - self._entity = 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, Response): - 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/restriction.py b/nipyapi/nifi/models/restriction.py index daa5aba7..ea721efe 100644 --- a/nipyapi/nifi/models/restriction.py +++ b/nipyapi/nifi/models/restriction.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,73 +27,71 @@ class Restriction(object): and the value is json key in definition. """ swagger_types = { - 'required_permission': 'str', - 'explanation': 'str' - } + 'explanation': 'str', +'required_permission': 'str' } attribute_map = { - 'required_permission': 'requiredPermission', - 'explanation': 'explanation' - } + 'explanation': 'explanation', +'required_permission': 'requiredPermission' } - def __init__(self, required_permission=None, explanation=None): + def __init__(self, explanation=None, required_permission=None): """ Restriction - a model defined in Swagger """ - self._required_permission = None self._explanation = None + self._required_permission = None - if required_permission is not None: - self.required_permission = required_permission if explanation is not None: self.explanation = explanation + if required_permission is not None: + self.required_permission = required_permission @property - def required_permission(self): + def explanation(self): """ - Gets the required_permission of this Restriction. - The permission required for this restriction + Gets the explanation of this Restriction. + The explanation of this restriction - :return: The required_permission of this Restriction. + :return: The explanation of this Restriction. :rtype: str """ - return self._required_permission + return self._explanation - @required_permission.setter - def required_permission(self, required_permission): + @explanation.setter + def explanation(self, explanation): """ - Sets the required_permission of this Restriction. - The permission required for this restriction + Sets the explanation of this Restriction. + The explanation of this restriction - :param required_permission: The required_permission of this Restriction. + :param explanation: The explanation of this Restriction. :type: str """ - self._required_permission = required_permission + self._explanation = explanation @property - def explanation(self): + def required_permission(self): """ - Gets the explanation of this Restriction. - The explanation of this restriction + Gets the required_permission of this Restriction. + The permission required for this restriction - :return: The explanation of this Restriction. + :return: The required_permission of this Restriction. :rtype: str """ - return self._explanation + return self._required_permission - @explanation.setter - def explanation(self, explanation): + @required_permission.setter + def required_permission(self, required_permission): """ - Sets the explanation of this Restriction. - The explanation of this restriction + Sets the required_permission of this Restriction. + The permission required for this restriction - :param explanation: The explanation of this Restriction. + :param required_permission: The required_permission of this Restriction. :type: str """ - self._explanation = explanation + self._required_permission = required_permission def to_dict(self): """ diff --git a/nipyapi/nifi/models/revision_dto.py b/nipyapi/nifi/models/revision_dto.py index bfee3b91..d4169215 100644 --- a/nipyapi/nifi/models/revision_dto.py +++ b/nipyapi/nifi/models/revision_dto.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -29,37 +28,35 @@ class RevisionDTO(object): """ swagger_types = { 'client_id': 'str', - 'version': 'int', - 'last_modifier': 'str' - } +'last_modifier': 'str', +'version': 'int' } attribute_map = { 'client_id': 'clientId', - 'version': 'version', - 'last_modifier': 'lastModifier' - } +'last_modifier': 'lastModifier', +'version': 'version' } - def __init__(self, client_id=None, version=None, last_modifier=None): + def __init__(self, client_id=None, last_modifier=None, version=None): """ RevisionDTO - a model defined in Swagger """ self._client_id = None - self._version = None self._last_modifier = None + self._version = None if client_id is not None: self.client_id = client_id - if version is not None: - self.version = version if last_modifier is not None: self.last_modifier = last_modifier + if version is not None: + self.version = version @property def client_id(self): """ Gets the client_id of this RevisionDTO. - A client identifier used to make a request. By including a client identifier, the API can allow multiple requests without needing the current revision. Due to the asynchronous nature of requests/responses this was implemented to allow the client to make numerous requests without having to wait for the previous response to come back + A client identifier used to make a request. By including a client identifier, the API can allow multiple requests without needing the current revision. Due to the asynchronous nature of requests/responses this was implemented to allow the client to make numerous requests without having to wait for the previous response to come back :return: The client_id of this RevisionDTO. :rtype: str @@ -70,7 +67,7 @@ def client_id(self): def client_id(self, client_id): """ Sets the client_id of this RevisionDTO. - A client identifier used to make a request. By including a client identifier, the API can allow multiple requests without needing the current revision. Due to the asynchronous nature of requests/responses this was implemented to allow the client to make numerous requests without having to wait for the previous response to come back + A client identifier used to make a request. By including a client identifier, the API can allow multiple requests without needing the current revision. Due to the asynchronous nature of requests/responses this was implemented to allow the client to make numerous requests without having to wait for the previous response to come back :param client_id: The client_id of this RevisionDTO. :type: str @@ -78,29 +75,6 @@ def client_id(self, client_id): self._client_id = client_id - @property - def version(self): - """ - Gets the version of this RevisionDTO. - NiFi employs an optimistic locking strategy where the client must include a revision in their request when performing an update. In a response to a mutable flow request, this field represents the updated base version. - - :return: The version of this RevisionDTO. - :rtype: int - """ - return self._version - - @version.setter - def version(self, version): - """ - Sets the version of this RevisionDTO. - NiFi employs an optimistic locking strategy where the client must include a revision in their request when performing an update. In a response to a mutable flow request, this field represents the updated base version. - - :param version: The version of this RevisionDTO. - :type: int - """ - - self._version = version - @property def last_modifier(self): """ @@ -124,6 +98,29 @@ def last_modifier(self, last_modifier): self._last_modifier = last_modifier + @property + def version(self): + """ + Gets the version of this RevisionDTO. + NiFi employs an optimistic locking strategy where the client must include a revision in their request when performing an update. In a response to a mutable flow request, this field represents the updated base version. + + :return: The version of this RevisionDTO. + :rtype: int + """ + return self._version + + @version.setter + def version(self, version): + """ + Sets the version of this RevisionDTO. + NiFi employs an optimistic locking strategy where the client must include a revision in their request when performing an update. In a response to a mutable flow request, this field represents the updated base version. + + :param version: The version of this RevisionDTO. + :type: int + """ + + self._version = version + def to_dict(self): """ Returns the model properties as a dict diff --git a/nipyapi/nifi/models/run_status_details_request_entity.py b/nipyapi/nifi/models/run_status_details_request_entity.py index 73e1603d..818adc95 100644 --- a/nipyapi/nifi/models/run_status_details_request_entity.py +++ b/nipyapi/nifi/models/run_status_details_request_entity.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,12 +27,10 @@ class RunStatusDetailsRequestEntity(object): and the value is json key in definition. """ swagger_types = { - 'processor_ids': 'list[str]' - } + 'processor_ids': 'list[str]' } attribute_map = { - 'processor_ids': 'processorIds' - } + 'processor_ids': 'processorIds' } def __init__(self, processor_ids=None): """ diff --git a/nipyapi/nifi/models/runtime_manifest.py b/nipyapi/nifi/models/runtime_manifest.py index 1a7ddb68..54704962 100644 --- a/nipyapi/nifi/models/runtime_manifest.py +++ b/nipyapi/nifi/models/runtime_manifest.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,70 +27,45 @@ class RuntimeManifest(object): and the value is json key in definition. """ swagger_types = { - 'identifier': 'str', 'agent_type': 'str', - 'version': 'str', - 'build_info': 'BuildInfo', - 'bundles': 'list[Bundle]', - 'scheduling_defaults': 'SchedulingDefaults' - } +'build_info': 'BuildInfo', +'bundles': 'list[Bundle]', +'identifier': 'str', +'scheduling_defaults': 'SchedulingDefaults', +'version': 'str' } attribute_map = { - 'identifier': 'identifier', 'agent_type': 'agentType', - 'version': 'version', - 'build_info': 'buildInfo', - 'bundles': 'bundles', - 'scheduling_defaults': 'schedulingDefaults' - } +'build_info': 'buildInfo', +'bundles': 'bundles', +'identifier': 'identifier', +'scheduling_defaults': 'schedulingDefaults', +'version': 'version' } - def __init__(self, identifier=None, agent_type=None, version=None, build_info=None, bundles=None, scheduling_defaults=None): + def __init__(self, agent_type=None, build_info=None, bundles=None, identifier=None, scheduling_defaults=None, version=None): """ RuntimeManifest - a model defined in Swagger """ - self._identifier = None self._agent_type = None - self._version = None self._build_info = None self._bundles = None + self._identifier = None self._scheduling_defaults = None + self._version = None - if identifier is not None: - self.identifier = identifier if agent_type is not None: self.agent_type = agent_type - if version is not None: - self.version = version if build_info is not None: self.build_info = build_info if bundles is not None: self.bundles = bundles + if identifier is not None: + self.identifier = identifier if scheduling_defaults is not None: self.scheduling_defaults = scheduling_defaults - - @property - def identifier(self): - """ - Gets the identifier of this RuntimeManifest. - A unique identifier for the manifest - - :return: The identifier of this RuntimeManifest. - :rtype: str - """ - return self._identifier - - @identifier.setter - def identifier(self, identifier): - """ - Sets the identifier of this RuntimeManifest. - A unique identifier for the manifest - - :param identifier: The identifier of this RuntimeManifest. - :type: str - """ - - self._identifier = identifier + if version is not None: + self.version = version @property def agent_type(self): @@ -116,34 +90,10 @@ def agent_type(self, agent_type): self._agent_type = agent_type - @property - def version(self): - """ - Gets the version of this RuntimeManifest. - The version of the runtime binary, e.g., '1.0.1' - - :return: The version of this RuntimeManifest. - :rtype: str - """ - return self._version - - @version.setter - def version(self, version): - """ - Sets the version of this RuntimeManifest. - The version of the runtime binary, e.g., '1.0.1' - - :param version: The version of this RuntimeManifest. - :type: str - """ - - self._version = version - @property def build_info(self): """ Gets the build_info of this RuntimeManifest. - Build summary for this runtime binary :return: The build_info of this RuntimeManifest. :rtype: BuildInfo @@ -154,7 +104,6 @@ def build_info(self): def build_info(self, build_info): """ Sets the build_info of this RuntimeManifest. - Build summary for this runtime binary :param build_info: The build_info of this RuntimeManifest. :type: BuildInfo @@ -185,11 +134,33 @@ def bundles(self, bundles): self._bundles = bundles + @property + def identifier(self): + """ + Gets the identifier of this RuntimeManifest. + A unique identifier for the manifest + + :return: The identifier of this RuntimeManifest. + :rtype: str + """ + return self._identifier + + @identifier.setter + def identifier(self, identifier): + """ + Sets the identifier of this RuntimeManifest. + A unique identifier for the manifest + + :param identifier: The identifier of this RuntimeManifest. + :type: str + """ + + self._identifier = identifier + @property def scheduling_defaults(self): """ Gets the scheduling_defaults of this RuntimeManifest. - Scheduling defaults for components defined in this manifest :return: The scheduling_defaults of this RuntimeManifest. :rtype: SchedulingDefaults @@ -200,7 +171,6 @@ def scheduling_defaults(self): def scheduling_defaults(self, scheduling_defaults): """ Sets the scheduling_defaults of this RuntimeManifest. - Scheduling defaults for components defined in this manifest :param scheduling_defaults: The scheduling_defaults of this RuntimeManifest. :type: SchedulingDefaults @@ -208,6 +178,29 @@ def scheduling_defaults(self, scheduling_defaults): self._scheduling_defaults = scheduling_defaults + @property + def version(self): + """ + Gets the version of this RuntimeManifest. + The version of the runtime binary, e.g., '1.0.1' + + :return: The version of this RuntimeManifest. + :rtype: str + """ + return self._version + + @version.setter + def version(self, version): + """ + Sets the version of this RuntimeManifest. + The version of the runtime binary, e.g., '1.0.1' + + :param version: The version of this RuntimeManifest. + :type: str + """ + + self._version = version + def to_dict(self): """ Returns the model properties as a dict diff --git a/nipyapi/nifi/models/runtime_manifest_entity.py b/nipyapi/nifi/models/runtime_manifest_entity.py index 19490f3c..142aa98b 100644 --- a/nipyapi/nifi/models/runtime_manifest_entity.py +++ b/nipyapi/nifi/models/runtime_manifest_entity.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,12 +27,10 @@ class RuntimeManifestEntity(object): and the value is json key in definition. """ swagger_types = { - 'runtime_manifest': 'RuntimeManifest' - } + 'runtime_manifest': 'RuntimeManifest' } attribute_map = { - 'runtime_manifest': 'runtimeManifest' - } + 'runtime_manifest': 'runtimeManifest' } def __init__(self, runtime_manifest=None): """ diff --git a/nipyapi/nifi/models/schedule_components_entity.py b/nipyapi/nifi/models/schedule_components_entity.py index 60b2e23e..9f57a4bb 100644 --- a/nipyapi/nifi/models/schedule_components_entity.py +++ b/nipyapi/nifi/models/schedule_components_entity.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,37 +27,81 @@ class ScheduleComponentsEntity(object): and the value is json key in definition. """ swagger_types = { - 'id': 'str', - 'state': 'str', 'components': 'dict(str, RevisionDTO)', - 'disconnected_node_acknowledged': 'bool' - } +'disconnected_node_acknowledged': 'bool', +'id': 'str', +'state': 'str' } attribute_map = { - 'id': 'id', - 'state': 'state', 'components': 'components', - 'disconnected_node_acknowledged': 'disconnectedNodeAcknowledged' - } +'disconnected_node_acknowledged': 'disconnectedNodeAcknowledged', +'id': 'id', +'state': 'state' } - def __init__(self, id=None, state=None, components=None, disconnected_node_acknowledged=None): + def __init__(self, components=None, disconnected_node_acknowledged=None, id=None, state=None): """ ScheduleComponentsEntity - a model defined in Swagger """ - self._id = None - self._state = None self._components = None self._disconnected_node_acknowledged = None + self._id = None + self._state = None - if id is not None: - self.id = id - if state is not None: - self.state = state if components is not None: self.components = components if disconnected_node_acknowledged is not None: self.disconnected_node_acknowledged = disconnected_node_acknowledged + if id is not None: + self.id = id + if state is not None: + self.state = state + + @property + def components(self): + """ + Gets the components of this ScheduleComponentsEntity. + Optional components to schedule. If not specified, all authorized descendant components will be used. + + :return: The components of this ScheduleComponentsEntity. + :rtype: dict(str, RevisionDTO) + """ + return self._components + + @components.setter + def components(self, components): + """ + Sets the components of this ScheduleComponentsEntity. + Optional components to schedule. If not specified, all authorized descendant components will be used. + + :param components: The components of this ScheduleComponentsEntity. + :type: dict(str, RevisionDTO) + """ + + self._components = components + + @property + def disconnected_node_acknowledged(self): + """ + Gets the disconnected_node_acknowledged of this ScheduleComponentsEntity. + Acknowledges that this node is disconnected to allow for mutable requests to proceed. + + :return: The disconnected_node_acknowledged of this ScheduleComponentsEntity. + :rtype: bool + """ + return self._disconnected_node_acknowledged + + @disconnected_node_acknowledged.setter + def disconnected_node_acknowledged(self, disconnected_node_acknowledged): + """ + Sets the disconnected_node_acknowledged of this ScheduleComponentsEntity. + Acknowledges that this node is disconnected to allow for mutable requests to proceed. + + :param disconnected_node_acknowledged: The disconnected_node_acknowledged of this ScheduleComponentsEntity. + :type: bool + """ + + self._disconnected_node_acknowledged = disconnected_node_acknowledged @property def id(self): @@ -103,7 +146,7 @@ def state(self, state): :param state: The state of this ScheduleComponentsEntity. :type: str """ - allowed_values = ["RUNNING", "STOPPED", "ENABLED", "DISABLED"] + allowed_values = ["RUNNING", "STOPPED", "ENABLED", "DISABLED", ] if state not in allowed_values: raise ValueError( "Invalid value for `state` ({0}), must be one of {1}" @@ -112,52 +155,6 @@ def state(self, state): self._state = state - @property - def components(self): - """ - Gets the components of this ScheduleComponentsEntity. - Optional components to schedule. If not specified, all authorized descendant components will be used. - - :return: The components of this ScheduleComponentsEntity. - :rtype: dict(str, RevisionDTO) - """ - return self._components - - @components.setter - def components(self, components): - """ - Sets the components of this ScheduleComponentsEntity. - Optional components to schedule. If not specified, all authorized descendant components will be used. - - :param components: The components of this ScheduleComponentsEntity. - :type: dict(str, RevisionDTO) - """ - - self._components = components - - @property - def disconnected_node_acknowledged(self): - """ - Gets the disconnected_node_acknowledged of this ScheduleComponentsEntity. - Acknowledges that this node is disconnected to allow for mutable requests to proceed. - - :return: The disconnected_node_acknowledged of this ScheduleComponentsEntity. - :rtype: bool - """ - return self._disconnected_node_acknowledged - - @disconnected_node_acknowledged.setter - def disconnected_node_acknowledged(self, disconnected_node_acknowledged): - """ - Sets the disconnected_node_acknowledged of this ScheduleComponentsEntity. - Acknowledges that this node is disconnected to allow for mutable requests to proceed. - - :param disconnected_node_acknowledged: The disconnected_node_acknowledged of this ScheduleComponentsEntity. - :type: bool - """ - - self._disconnected_node_acknowledged = disconnected_node_acknowledged - def to_dict(self): """ Returns the model properties as a dict diff --git a/nipyapi/nifi/models/scheduling_defaults.py b/nipyapi/nifi/models/scheduling_defaults.py index 20281614..418c3d4c 100644 --- a/nipyapi/nifi/models/scheduling_defaults.py +++ b/nipyapi/nifi/models/scheduling_defaults.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,247 +27,245 @@ class SchedulingDefaults(object): and the value is json key in definition. """ swagger_types = { - 'default_scheduling_strategy': 'str', - 'default_scheduling_period_millis': 'int', - 'penalization_period_millis': 'int', - 'yield_duration_millis': 'int', - 'default_run_duration_nanos': 'int', - 'default_max_concurrent_tasks': 'str', 'default_concurrent_tasks_by_scheduling_strategy': 'dict(str, int)', - 'default_scheduling_periods_by_scheduling_strategy': 'dict(str, str)' - } +'default_max_concurrent_tasks': 'str', +'default_run_duration_nanos': 'int', +'default_scheduling_period_millis': 'int', +'default_scheduling_periods_by_scheduling_strategy': 'dict(str, str)', +'default_scheduling_strategy': 'str', +'penalization_period_millis': 'int', +'yield_duration_millis': 'int' } attribute_map = { - 'default_scheduling_strategy': 'defaultSchedulingStrategy', - 'default_scheduling_period_millis': 'defaultSchedulingPeriodMillis', - 'penalization_period_millis': 'penalizationPeriodMillis', - 'yield_duration_millis': 'yieldDurationMillis', - 'default_run_duration_nanos': 'defaultRunDurationNanos', - 'default_max_concurrent_tasks': 'defaultMaxConcurrentTasks', 'default_concurrent_tasks_by_scheduling_strategy': 'defaultConcurrentTasksBySchedulingStrategy', - 'default_scheduling_periods_by_scheduling_strategy': 'defaultSchedulingPeriodsBySchedulingStrategy' - } +'default_max_concurrent_tasks': 'defaultMaxConcurrentTasks', +'default_run_duration_nanos': 'defaultRunDurationNanos', +'default_scheduling_period_millis': 'defaultSchedulingPeriodMillis', +'default_scheduling_periods_by_scheduling_strategy': 'defaultSchedulingPeriodsBySchedulingStrategy', +'default_scheduling_strategy': 'defaultSchedulingStrategy', +'penalization_period_millis': 'penalizationPeriodMillis', +'yield_duration_millis': 'yieldDurationMillis' } - def __init__(self, default_scheduling_strategy=None, default_scheduling_period_millis=None, penalization_period_millis=None, yield_duration_millis=None, default_run_duration_nanos=None, default_max_concurrent_tasks=None, default_concurrent_tasks_by_scheduling_strategy=None, default_scheduling_periods_by_scheduling_strategy=None): + def __init__(self, default_concurrent_tasks_by_scheduling_strategy=None, default_max_concurrent_tasks=None, default_run_duration_nanos=None, default_scheduling_period_millis=None, default_scheduling_periods_by_scheduling_strategy=None, default_scheduling_strategy=None, penalization_period_millis=None, yield_duration_millis=None): """ SchedulingDefaults - a model defined in Swagger """ - self._default_scheduling_strategy = None + self._default_concurrent_tasks_by_scheduling_strategy = None + self._default_max_concurrent_tasks = None + self._default_run_duration_nanos = None self._default_scheduling_period_millis = None + self._default_scheduling_periods_by_scheduling_strategy = None + self._default_scheduling_strategy = None self._penalization_period_millis = None self._yield_duration_millis = None - self._default_run_duration_nanos = None - self._default_max_concurrent_tasks = None - self._default_concurrent_tasks_by_scheduling_strategy = None - self._default_scheduling_periods_by_scheduling_strategy = None - if default_scheduling_strategy is not None: - self.default_scheduling_strategy = default_scheduling_strategy + if default_concurrent_tasks_by_scheduling_strategy is not None: + self.default_concurrent_tasks_by_scheduling_strategy = default_concurrent_tasks_by_scheduling_strategy + if default_max_concurrent_tasks is not None: + self.default_max_concurrent_tasks = default_max_concurrent_tasks + if default_run_duration_nanos is not None: + self.default_run_duration_nanos = default_run_duration_nanos if default_scheduling_period_millis is not None: self.default_scheduling_period_millis = default_scheduling_period_millis + if default_scheduling_periods_by_scheduling_strategy is not None: + self.default_scheduling_periods_by_scheduling_strategy = default_scheduling_periods_by_scheduling_strategy + if default_scheduling_strategy is not None: + self.default_scheduling_strategy = default_scheduling_strategy if penalization_period_millis is not None: self.penalization_period_millis = penalization_period_millis if yield_duration_millis is not None: self.yield_duration_millis = yield_duration_millis - if default_run_duration_nanos is not None: - self.default_run_duration_nanos = default_run_duration_nanos - if default_max_concurrent_tasks is not None: - self.default_max_concurrent_tasks = default_max_concurrent_tasks - if default_concurrent_tasks_by_scheduling_strategy is not None: - self.default_concurrent_tasks_by_scheduling_strategy = default_concurrent_tasks_by_scheduling_strategy - if default_scheduling_periods_by_scheduling_strategy is not None: - self.default_scheduling_periods_by_scheduling_strategy = default_scheduling_periods_by_scheduling_strategy @property - def default_scheduling_strategy(self): + def default_concurrent_tasks_by_scheduling_strategy(self): """ - Gets the default_scheduling_strategy of this SchedulingDefaults. - The name of the default scheduling strategy + Gets the default_concurrent_tasks_by_scheduling_strategy of this SchedulingDefaults. + The default concurrent tasks for each scheduling strategy - :return: The default_scheduling_strategy of this SchedulingDefaults. - :rtype: str + :return: The default_concurrent_tasks_by_scheduling_strategy of this SchedulingDefaults. + :rtype: dict(str, int) """ - return self._default_scheduling_strategy + return self._default_concurrent_tasks_by_scheduling_strategy - @default_scheduling_strategy.setter - def default_scheduling_strategy(self, default_scheduling_strategy): + @default_concurrent_tasks_by_scheduling_strategy.setter + def default_concurrent_tasks_by_scheduling_strategy(self, default_concurrent_tasks_by_scheduling_strategy): """ - Sets the default_scheduling_strategy of this SchedulingDefaults. - The name of the default scheduling strategy + Sets the default_concurrent_tasks_by_scheduling_strategy of this SchedulingDefaults. + The default concurrent tasks for each scheduling strategy - :param default_scheduling_strategy: The default_scheduling_strategy of this SchedulingDefaults. - :type: str + :param default_concurrent_tasks_by_scheduling_strategy: The default_concurrent_tasks_by_scheduling_strategy of this SchedulingDefaults. + :type: dict(str, int) """ - allowed_values = ["EVENT_DRIVEN", "TIMER_DRIVEN", "PRIMARY_NODE_ONLY", "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 + self._default_concurrent_tasks_by_scheduling_strategy = default_concurrent_tasks_by_scheduling_strategy @property - def default_scheduling_period_millis(self): + def default_max_concurrent_tasks(self): """ - Gets the default_scheduling_period_millis of this SchedulingDefaults. - The default scheduling period in milliseconds + Gets the default_max_concurrent_tasks of this SchedulingDefaults. + The default concurrent tasks - :return: The default_scheduling_period_millis of this SchedulingDefaults. - :rtype: int + :return: The default_max_concurrent_tasks of this SchedulingDefaults. + :rtype: str """ - return self._default_scheduling_period_millis + return self._default_max_concurrent_tasks - @default_scheduling_period_millis.setter - def default_scheduling_period_millis(self, default_scheduling_period_millis): + @default_max_concurrent_tasks.setter + def default_max_concurrent_tasks(self, default_max_concurrent_tasks): """ - Sets the default_scheduling_period_millis of this SchedulingDefaults. - The default scheduling period in milliseconds + Sets the default_max_concurrent_tasks of this SchedulingDefaults. + The default concurrent tasks - :param default_scheduling_period_millis: The default_scheduling_period_millis of this SchedulingDefaults. - :type: int + :param default_max_concurrent_tasks: The default_max_concurrent_tasks of this SchedulingDefaults. + :type: str """ - self._default_scheduling_period_millis = default_scheduling_period_millis + self._default_max_concurrent_tasks = default_max_concurrent_tasks @property - def penalization_period_millis(self): + def default_run_duration_nanos(self): """ - Gets the penalization_period_millis of this SchedulingDefaults. - The default penalization period in milliseconds + Gets the default_run_duration_nanos of this SchedulingDefaults. + The default run duration in nano-seconds - :return: The penalization_period_millis of this SchedulingDefaults. + :return: The default_run_duration_nanos of this SchedulingDefaults. :rtype: int """ - return self._penalization_period_millis + return self._default_run_duration_nanos - @penalization_period_millis.setter - def penalization_period_millis(self, penalization_period_millis): + @default_run_duration_nanos.setter + def default_run_duration_nanos(self, default_run_duration_nanos): """ - Sets the penalization_period_millis of this SchedulingDefaults. - The default penalization period in milliseconds + Sets the default_run_duration_nanos of this SchedulingDefaults. + The default run duration in nano-seconds - :param penalization_period_millis: The penalization_period_millis of this SchedulingDefaults. + :param default_run_duration_nanos: The default_run_duration_nanos of this SchedulingDefaults. :type: int """ - self._penalization_period_millis = penalization_period_millis + self._default_run_duration_nanos = default_run_duration_nanos @property - def yield_duration_millis(self): + def default_scheduling_period_millis(self): """ - Gets the yield_duration_millis of this SchedulingDefaults. - The default yield duration in milliseconds + Gets the default_scheduling_period_millis of this SchedulingDefaults. + The default scheduling period in milliseconds - :return: The yield_duration_millis of this SchedulingDefaults. + :return: The default_scheduling_period_millis of this SchedulingDefaults. :rtype: int """ - return self._yield_duration_millis + return self._default_scheduling_period_millis - @yield_duration_millis.setter - def yield_duration_millis(self, yield_duration_millis): + @default_scheduling_period_millis.setter + def default_scheduling_period_millis(self, default_scheduling_period_millis): """ - Sets the yield_duration_millis of this SchedulingDefaults. - The default yield duration in milliseconds + Sets the default_scheduling_period_millis of this SchedulingDefaults. + The default scheduling period in milliseconds - :param yield_duration_millis: The yield_duration_millis of this SchedulingDefaults. + :param default_scheduling_period_millis: The default_scheduling_period_millis of this SchedulingDefaults. :type: int """ - self._yield_duration_millis = yield_duration_millis + self._default_scheduling_period_millis = default_scheduling_period_millis @property - def default_run_duration_nanos(self): + def default_scheduling_periods_by_scheduling_strategy(self): """ - Gets the default_run_duration_nanos of this SchedulingDefaults. - The default run duration in nano-seconds + Gets the default_scheduling_periods_by_scheduling_strategy of this SchedulingDefaults. + The default scheduling period for each scheduling strategy - :return: The default_run_duration_nanos of this SchedulingDefaults. - :rtype: int + :return: The default_scheduling_periods_by_scheduling_strategy of this SchedulingDefaults. + :rtype: dict(str, str) """ - return self._default_run_duration_nanos + return self._default_scheduling_periods_by_scheduling_strategy - @default_run_duration_nanos.setter - def default_run_duration_nanos(self, default_run_duration_nanos): + @default_scheduling_periods_by_scheduling_strategy.setter + def default_scheduling_periods_by_scheduling_strategy(self, default_scheduling_periods_by_scheduling_strategy): """ - Sets the default_run_duration_nanos of this SchedulingDefaults. - The default run duration in nano-seconds + Sets the default_scheduling_periods_by_scheduling_strategy of this SchedulingDefaults. + The default scheduling period for each scheduling strategy - :param default_run_duration_nanos: The default_run_duration_nanos of this SchedulingDefaults. - :type: int + :param default_scheduling_periods_by_scheduling_strategy: The default_scheduling_periods_by_scheduling_strategy of this SchedulingDefaults. + :type: dict(str, str) """ - self._default_run_duration_nanos = default_run_duration_nanos + self._default_scheduling_periods_by_scheduling_strategy = default_scheduling_periods_by_scheduling_strategy @property - def default_max_concurrent_tasks(self): + def default_scheduling_strategy(self): """ - Gets the default_max_concurrent_tasks of this SchedulingDefaults. - The default concurrent tasks + Gets the default_scheduling_strategy of this SchedulingDefaults. + The name of the default scheduling strategy - :return: The default_max_concurrent_tasks of this SchedulingDefaults. + :return: The default_scheduling_strategy of this SchedulingDefaults. :rtype: str """ - return self._default_max_concurrent_tasks + return self._default_scheduling_strategy - @default_max_concurrent_tasks.setter - def default_max_concurrent_tasks(self, default_max_concurrent_tasks): + @default_scheduling_strategy.setter + def default_scheduling_strategy(self, default_scheduling_strategy): """ - Sets the default_max_concurrent_tasks of this SchedulingDefaults. - The default concurrent tasks + Sets the default_scheduling_strategy of this SchedulingDefaults. + The name of the default scheduling strategy - :param default_max_concurrent_tasks: The default_max_concurrent_tasks of this SchedulingDefaults. + :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) + ) - self._default_max_concurrent_tasks = default_max_concurrent_tasks + self._default_scheduling_strategy = default_scheduling_strategy @property - def default_concurrent_tasks_by_scheduling_strategy(self): + def penalization_period_millis(self): """ - Gets the default_concurrent_tasks_by_scheduling_strategy of this SchedulingDefaults. - The default concurrent tasks for each scheduling strategy + Gets the penalization_period_millis of this SchedulingDefaults. + The default penalization period in milliseconds - :return: The default_concurrent_tasks_by_scheduling_strategy of this SchedulingDefaults. - :rtype: dict(str, int) + :return: The penalization_period_millis of this SchedulingDefaults. + :rtype: int """ - return self._default_concurrent_tasks_by_scheduling_strategy + return self._penalization_period_millis - @default_concurrent_tasks_by_scheduling_strategy.setter - def default_concurrent_tasks_by_scheduling_strategy(self, default_concurrent_tasks_by_scheduling_strategy): + @penalization_period_millis.setter + def penalization_period_millis(self, penalization_period_millis): """ - Sets the default_concurrent_tasks_by_scheduling_strategy of this SchedulingDefaults. - The default concurrent tasks for each scheduling strategy + Sets the penalization_period_millis of this SchedulingDefaults. + The default penalization period in milliseconds - :param default_concurrent_tasks_by_scheduling_strategy: The default_concurrent_tasks_by_scheduling_strategy of this SchedulingDefaults. - :type: dict(str, int) + :param penalization_period_millis: The penalization_period_millis of this SchedulingDefaults. + :type: int """ - self._default_concurrent_tasks_by_scheduling_strategy = default_concurrent_tasks_by_scheduling_strategy + self._penalization_period_millis = penalization_period_millis @property - def default_scheduling_periods_by_scheduling_strategy(self): + def yield_duration_millis(self): """ - Gets the default_scheduling_periods_by_scheduling_strategy of this SchedulingDefaults. - The default scheduling period for each scheduling strategy + Gets the yield_duration_millis of this SchedulingDefaults. + The default yield duration in milliseconds - :return: The default_scheduling_periods_by_scheduling_strategy of this SchedulingDefaults. - :rtype: dict(str, str) + :return: The yield_duration_millis of this SchedulingDefaults. + :rtype: int """ - return self._default_scheduling_periods_by_scheduling_strategy + return self._yield_duration_millis - @default_scheduling_periods_by_scheduling_strategy.setter - def default_scheduling_periods_by_scheduling_strategy(self, default_scheduling_periods_by_scheduling_strategy): + @yield_duration_millis.setter + def yield_duration_millis(self, yield_duration_millis): """ - Sets the default_scheduling_periods_by_scheduling_strategy of this SchedulingDefaults. - The default scheduling period for each scheduling strategy + Sets the yield_duration_millis of this SchedulingDefaults. + The default yield duration in milliseconds - :param default_scheduling_periods_by_scheduling_strategy: The default_scheduling_periods_by_scheduling_strategy of this SchedulingDefaults. - :type: dict(str, str) + :param yield_duration_millis: The yield_duration_millis of this SchedulingDefaults. + :type: int """ - self._default_scheduling_periods_by_scheduling_strategy = default_scheduling_periods_by_scheduling_strategy + self._yield_duration_millis = yield_duration_millis def to_dict(self): """ diff --git a/nipyapi/nifi/models/search_result_group_dto.py b/nipyapi/nifi/models/search_result_group_dto.py index 90a98b5c..387d3b66 100644 --- a/nipyapi/nifi/models/search_result_group_dto.py +++ b/nipyapi/nifi/models/search_result_group_dto.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -29,13 +28,11 @@ class SearchResultGroupDTO(object): """ swagger_types = { 'id': 'str', - 'name': 'str' - } +'name': 'str' } attribute_map = { 'id': 'id', - 'name': 'name' - } +'name': 'name' } def __init__(self, id=None, name=None): """ diff --git a/nipyapi/nifi/models/search_results_dto.py b/nipyapi/nifi/models/search_results_dto.py index bc29e12b..eda0c2e9 100644 --- a/nipyapi/nifi/models/search_results_dto.py +++ b/nipyapi/nifi/models/search_results_dto.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,100 +27,75 @@ class SearchResultsDTO(object): and the value is json key in definition. """ swagger_types = { - 'processor_results': 'list[ComponentSearchResultDTO]', 'connection_results': 'list[ComponentSearchResultDTO]', - 'process_group_results': 'list[ComponentSearchResultDTO]', - 'input_port_results': 'list[ComponentSearchResultDTO]', - 'output_port_results': 'list[ComponentSearchResultDTO]', - 'remote_process_group_results': 'list[ComponentSearchResultDTO]', - 'funnel_results': 'list[ComponentSearchResultDTO]', - 'label_results': 'list[ComponentSearchResultDTO]', - 'controller_service_node_results': 'list[ComponentSearchResultDTO]', - 'parameter_context_results': 'list[ComponentSearchResultDTO]', - 'parameter_provider_node_results': 'list[ComponentSearchResultDTO]', - 'parameter_results': 'list[ComponentSearchResultDTO]' - } +'controller_service_node_results': 'list[ComponentSearchResultDTO]', +'funnel_results': 'list[ComponentSearchResultDTO]', +'input_port_results': 'list[ComponentSearchResultDTO]', +'label_results': 'list[ComponentSearchResultDTO]', +'output_port_results': 'list[ComponentSearchResultDTO]', +'parameter_context_results': 'list[ComponentSearchResultDTO]', +'parameter_provider_node_results': 'list[ComponentSearchResultDTO]', +'parameter_results': 'list[ComponentSearchResultDTO]', +'process_group_results': 'list[ComponentSearchResultDTO]', +'processor_results': 'list[ComponentSearchResultDTO]', +'remote_process_group_results': 'list[ComponentSearchResultDTO]' } attribute_map = { - 'processor_results': 'processorResults', 'connection_results': 'connectionResults', - 'process_group_results': 'processGroupResults', - 'input_port_results': 'inputPortResults', - 'output_port_results': 'outputPortResults', - 'remote_process_group_results': 'remoteProcessGroupResults', - 'funnel_results': 'funnelResults', - 'label_results': 'labelResults', - 'controller_service_node_results': 'controllerServiceNodeResults', - 'parameter_context_results': 'parameterContextResults', - 'parameter_provider_node_results': 'parameterProviderNodeResults', - 'parameter_results': 'parameterResults' - } - - def __init__(self, processor_results=None, connection_results=None, process_group_results=None, input_port_results=None, output_port_results=None, remote_process_group_results=None, funnel_results=None, label_results=None, controller_service_node_results=None, parameter_context_results=None, parameter_provider_node_results=None, parameter_results=None): +'controller_service_node_results': 'controllerServiceNodeResults', +'funnel_results': 'funnelResults', +'input_port_results': 'inputPortResults', +'label_results': 'labelResults', +'output_port_results': 'outputPortResults', +'parameter_context_results': 'parameterContextResults', +'parameter_provider_node_results': 'parameterProviderNodeResults', +'parameter_results': 'parameterResults', +'process_group_results': 'processGroupResults', +'processor_results': 'processorResults', +'remote_process_group_results': 'remoteProcessGroupResults' } + + def __init__(self, connection_results=None, controller_service_node_results=None, funnel_results=None, input_port_results=None, label_results=None, output_port_results=None, parameter_context_results=None, parameter_provider_node_results=None, parameter_results=None, process_group_results=None, processor_results=None, remote_process_group_results=None): """ SearchResultsDTO - a model defined in Swagger """ - self._processor_results = None self._connection_results = None - self._process_group_results = None - self._input_port_results = None - self._output_port_results = None - self._remote_process_group_results = None + self._controller_service_node_results = None self._funnel_results = None + self._input_port_results = None self._label_results = None - self._controller_service_node_results = None + self._output_port_results = None self._parameter_context_results = None self._parameter_provider_node_results = None self._parameter_results = None + self._process_group_results = None + self._processor_results = None + self._remote_process_group_results = None - if processor_results is not None: - self.processor_results = processor_results if connection_results is not None: self.connection_results = connection_results - if process_group_results is not None: - self.process_group_results = process_group_results - if input_port_results is not None: - self.input_port_results = input_port_results - if output_port_results is not None: - self.output_port_results = output_port_results - if remote_process_group_results is not None: - self.remote_process_group_results = remote_process_group_results + if controller_service_node_results is not None: + self.controller_service_node_results = controller_service_node_results if funnel_results is not None: self.funnel_results = funnel_results + if input_port_results is not None: + self.input_port_results = input_port_results if label_results is not None: self.label_results = label_results - if controller_service_node_results is not None: - self.controller_service_node_results = controller_service_node_results + if output_port_results is not None: + self.output_port_results = output_port_results if parameter_context_results is not None: self.parameter_context_results = parameter_context_results if parameter_provider_node_results is not None: self.parameter_provider_node_results = parameter_provider_node_results if parameter_results is not None: self.parameter_results = parameter_results - - @property - def processor_results(self): - """ - Gets the processor_results of this SearchResultsDTO. - The processors that matched the search. - - :return: The processor_results of this SearchResultsDTO. - :rtype: list[ComponentSearchResultDTO] - """ - return self._processor_results - - @processor_results.setter - def processor_results(self, processor_results): - """ - Sets the processor_results of this SearchResultsDTO. - The processors that matched the search. - - :param processor_results: The processor_results of this SearchResultsDTO. - :type: list[ComponentSearchResultDTO] - """ - - self._processor_results = processor_results + if process_group_results is not None: + self.process_group_results = process_group_results + if processor_results is not None: + self.processor_results = processor_results + if remote_process_group_results is not None: + self.remote_process_group_results = remote_process_group_results @property def connection_results(self): @@ -147,119 +121,73 @@ def connection_results(self, connection_results): self._connection_results = connection_results @property - def process_group_results(self): - """ - Gets the process_group_results of this SearchResultsDTO. - The process groups that matched the search. - - :return: The process_group_results of this SearchResultsDTO. - :rtype: list[ComponentSearchResultDTO] - """ - return self._process_group_results - - @process_group_results.setter - def process_group_results(self, process_group_results): - """ - Sets the process_group_results of this SearchResultsDTO. - The process groups that matched the search. - - :param process_group_results: The process_group_results of this SearchResultsDTO. - :type: list[ComponentSearchResultDTO] - """ - - self._process_group_results = process_group_results - - @property - def input_port_results(self): - """ - Gets the input_port_results of this SearchResultsDTO. - The input ports that matched the search. - - :return: The input_port_results of this SearchResultsDTO. - :rtype: list[ComponentSearchResultDTO] - """ - return self._input_port_results - - @input_port_results.setter - def input_port_results(self, input_port_results): - """ - Sets the input_port_results of this SearchResultsDTO. - The input ports that matched the search. - - :param input_port_results: The input_port_results of this SearchResultsDTO. - :type: list[ComponentSearchResultDTO] - """ - - self._input_port_results = input_port_results - - @property - def output_port_results(self): + def controller_service_node_results(self): """ - Gets the output_port_results of this SearchResultsDTO. - The output ports that matched the search. + Gets the controller_service_node_results of this SearchResultsDTO. + The controller service nodes that matched the search - :return: The output_port_results of this SearchResultsDTO. + :return: The controller_service_node_results of this SearchResultsDTO. :rtype: list[ComponentSearchResultDTO] """ - return self._output_port_results + return self._controller_service_node_results - @output_port_results.setter - def output_port_results(self, output_port_results): + @controller_service_node_results.setter + def controller_service_node_results(self, controller_service_node_results): """ - Sets the output_port_results of this SearchResultsDTO. - The output ports that matched the search. + Sets the controller_service_node_results of this SearchResultsDTO. + The controller service nodes that matched the search - :param output_port_results: The output_port_results of this SearchResultsDTO. + :param controller_service_node_results: The controller_service_node_results of this SearchResultsDTO. :type: list[ComponentSearchResultDTO] """ - self._output_port_results = output_port_results + self._controller_service_node_results = controller_service_node_results @property - def remote_process_group_results(self): + def funnel_results(self): """ - Gets the remote_process_group_results of this SearchResultsDTO. - The remote process groups that matched the search. + Gets the funnel_results of this SearchResultsDTO. + The funnels that matched the search. - :return: The remote_process_group_results of this SearchResultsDTO. + :return: The funnel_results of this SearchResultsDTO. :rtype: list[ComponentSearchResultDTO] """ - return self._remote_process_group_results + return self._funnel_results - @remote_process_group_results.setter - def remote_process_group_results(self, remote_process_group_results): + @funnel_results.setter + def funnel_results(self, funnel_results): """ - Sets the remote_process_group_results of this SearchResultsDTO. - The remote process groups that matched the search. + Sets the funnel_results of this SearchResultsDTO. + The funnels that matched the search. - :param remote_process_group_results: The remote_process_group_results of this SearchResultsDTO. + :param funnel_results: The funnel_results of this SearchResultsDTO. :type: list[ComponentSearchResultDTO] """ - self._remote_process_group_results = remote_process_group_results + self._funnel_results = funnel_results @property - def funnel_results(self): + def input_port_results(self): """ - Gets the funnel_results of this SearchResultsDTO. - The funnels that matched the search. + Gets the input_port_results of this SearchResultsDTO. + The input ports that matched the search. - :return: The funnel_results of this SearchResultsDTO. + :return: The input_port_results of this SearchResultsDTO. :rtype: list[ComponentSearchResultDTO] """ - return self._funnel_results + return self._input_port_results - @funnel_results.setter - def funnel_results(self, funnel_results): + @input_port_results.setter + def input_port_results(self, input_port_results): """ - Sets the funnel_results of this SearchResultsDTO. - The funnels that matched the search. + Sets the input_port_results of this SearchResultsDTO. + The input ports that matched the search. - :param funnel_results: The funnel_results of this SearchResultsDTO. + :param input_port_results: The input_port_results of this SearchResultsDTO. :type: list[ComponentSearchResultDTO] """ - self._funnel_results = funnel_results + self._input_port_results = input_port_results @property def label_results(self): @@ -285,27 +213,27 @@ def label_results(self, label_results): self._label_results = label_results @property - def controller_service_node_results(self): + def output_port_results(self): """ - Gets the controller_service_node_results of this SearchResultsDTO. - The controller service nodes that matched the search + Gets the output_port_results of this SearchResultsDTO. + The output ports that matched the search. - :return: The controller_service_node_results of this SearchResultsDTO. + :return: The output_port_results of this SearchResultsDTO. :rtype: list[ComponentSearchResultDTO] """ - return self._controller_service_node_results + return self._output_port_results - @controller_service_node_results.setter - def controller_service_node_results(self, controller_service_node_results): + @output_port_results.setter + def output_port_results(self, output_port_results): """ - Sets the controller_service_node_results of this SearchResultsDTO. - The controller service nodes that matched the search + Sets the output_port_results of this SearchResultsDTO. + The output ports that matched the search. - :param controller_service_node_results: The controller_service_node_results of this SearchResultsDTO. + :param output_port_results: The output_port_results of this SearchResultsDTO. :type: list[ComponentSearchResultDTO] """ - self._controller_service_node_results = controller_service_node_results + self._output_port_results = output_port_results @property def parameter_context_results(self): @@ -376,6 +304,75 @@ def parameter_results(self, parameter_results): self._parameter_results = parameter_results + @property + def process_group_results(self): + """ + Gets the process_group_results of this SearchResultsDTO. + The process groups that matched the search. + + :return: The process_group_results of this SearchResultsDTO. + :rtype: list[ComponentSearchResultDTO] + """ + return self._process_group_results + + @process_group_results.setter + def process_group_results(self, process_group_results): + """ + Sets the process_group_results of this SearchResultsDTO. + The process groups that matched the search. + + :param process_group_results: The process_group_results of this SearchResultsDTO. + :type: list[ComponentSearchResultDTO] + """ + + self._process_group_results = process_group_results + + @property + def processor_results(self): + """ + Gets the processor_results of this SearchResultsDTO. + The processors that matched the search. + + :return: The processor_results of this SearchResultsDTO. + :rtype: list[ComponentSearchResultDTO] + """ + return self._processor_results + + @processor_results.setter + def processor_results(self, processor_results): + """ + Sets the processor_results of this SearchResultsDTO. + The processors that matched the search. + + :param processor_results: The processor_results of this SearchResultsDTO. + :type: list[ComponentSearchResultDTO] + """ + + self._processor_results = processor_results + + @property + def remote_process_group_results(self): + """ + Gets the remote_process_group_results of this SearchResultsDTO. + The remote process groups that matched the search. + + :return: The remote_process_group_results of this SearchResultsDTO. + :rtype: list[ComponentSearchResultDTO] + """ + return self._remote_process_group_results + + @remote_process_group_results.setter + def remote_process_group_results(self, remote_process_group_results): + """ + Sets the remote_process_group_results of this SearchResultsDTO. + The remote process groups that matched the search. + + :param remote_process_group_results: The remote_process_group_results of this SearchResultsDTO. + :type: list[ComponentSearchResultDTO] + """ + + self._remote_process_group_results = remote_process_group_results + def to_dict(self): """ Returns the model properties as a dict diff --git a/nipyapi/nifi/models/search_results_entity.py b/nipyapi/nifi/models/search_results_entity.py index e886217b..39fdecd6 100644 --- a/nipyapi/nifi/models/search_results_entity.py +++ b/nipyapi/nifi/models/search_results_entity.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,12 +27,10 @@ class SearchResultsEntity(object): and the value is json key in definition. """ swagger_types = { - 'search_results_dto': 'SearchResultsDTO' - } + 'search_results_dto': 'SearchResultsDTO' } attribute_map = { - 'search_results_dto': 'searchResultsDTO' - } + 'search_results_dto': 'searchResultsDTO' } def __init__(self, search_results_dto=None): """ diff --git a/nipyapi/nifi/models/snippet_dto.py b/nipyapi/nifi/models/snippet_dto.py index a0edc407..86c3386d 100644 --- a/nipyapi/nifi/models/snippet_dto.py +++ b/nipyapi/nifi/models/snippet_dto.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,325 +27,323 @@ class SnippetDTO(object): and the value is json key in definition. """ swagger_types = { - 'id': 'str', - 'uri': 'str', - 'parent_group_id': 'str', - 'process_groups': 'dict(str, RevisionDTO)', - 'remote_process_groups': 'dict(str, RevisionDTO)', - 'processors': 'dict(str, RevisionDTO)', - 'input_ports': 'dict(str, RevisionDTO)', - 'output_ports': 'dict(str, RevisionDTO)', 'connections': 'dict(str, RevisionDTO)', - 'labels': 'dict(str, RevisionDTO)', - 'funnels': 'dict(str, RevisionDTO)' - } +'funnels': 'dict(str, RevisionDTO)', +'id': 'str', +'input_ports': 'dict(str, RevisionDTO)', +'labels': 'dict(str, RevisionDTO)', +'output_ports': 'dict(str, RevisionDTO)', +'parent_group_id': 'str', +'process_groups': 'dict(str, RevisionDTO)', +'processors': 'dict(str, RevisionDTO)', +'remote_process_groups': 'dict(str, RevisionDTO)', +'uri': 'str' } attribute_map = { - 'id': 'id', - 'uri': 'uri', - 'parent_group_id': 'parentGroupId', - 'process_groups': 'processGroups', - 'remote_process_groups': 'remoteProcessGroups', - 'processors': 'processors', - 'input_ports': 'inputPorts', - 'output_ports': 'outputPorts', 'connections': 'connections', - 'labels': 'labels', - 'funnels': 'funnels' - } - - def __init__(self, id=None, uri=None, parent_group_id=None, process_groups=None, remote_process_groups=None, processors=None, input_ports=None, output_ports=None, connections=None, labels=None, funnels=None): +'funnels': 'funnels', +'id': 'id', +'input_ports': 'inputPorts', +'labels': 'labels', +'output_ports': 'outputPorts', +'parent_group_id': 'parentGroupId', +'process_groups': 'processGroups', +'processors': 'processors', +'remote_process_groups': 'remoteProcessGroups', +'uri': 'uri' } + + def __init__(self, connections=None, funnels=None, id=None, input_ports=None, labels=None, output_ports=None, parent_group_id=None, process_groups=None, processors=None, remote_process_groups=None, uri=None): """ SnippetDTO - a model defined in Swagger """ + self._connections = None + self._funnels = None self._id = None - self._uri = None + self._input_ports = None + self._labels = None + self._output_ports = None self._parent_group_id = None self._process_groups = None - self._remote_process_groups = None self._processors = None - self._input_ports = None - self._output_ports = None - self._connections = None - self._labels = None - self._funnels = None + self._remote_process_groups = None + self._uri = None + if connections is not None: + self.connections = connections + if funnels is not None: + self.funnels = funnels if id is not None: self.id = id - if uri is not None: - self.uri = uri + if input_ports is not None: + self.input_ports = input_ports + if labels is not None: + self.labels = labels + if output_ports is not None: + self.output_ports = output_ports if parent_group_id is not None: self.parent_group_id = parent_group_id if process_groups is not None: self.process_groups = process_groups - if remote_process_groups is not None: - self.remote_process_groups = remote_process_groups if processors is not None: self.processors = processors - if input_ports is not None: - self.input_ports = input_ports - if output_ports is not None: - self.output_ports = output_ports - if connections is not None: - self.connections = connections - if labels is not None: - self.labels = labels - if funnels is not None: - self.funnels = funnels + if remote_process_groups is not None: + self.remote_process_groups = remote_process_groups + if uri is not None: + self.uri = uri @property - def id(self): + def connections(self): """ - Gets the id of this SnippetDTO. - The id of the snippet. + Gets the connections of this SnippetDTO. + The ids of the connections in this snippet. These ids will be populated within each response. They can be specified when creating a snippet. However, once a snippet has been created its contents cannot be modified (these ids are ignored during update requests). - :return: The id of this SnippetDTO. - :rtype: str + :return: The connections of this SnippetDTO. + :rtype: dict(str, RevisionDTO) """ - return self._id + return self._connections - @id.setter - def id(self, id): + @connections.setter + def connections(self, connections): """ - Sets the id of this SnippetDTO. - The id of the snippet. + Sets the connections of this SnippetDTO. + The ids of the connections in this snippet. These ids will be populated within each response. They can be specified when creating a snippet. However, once a snippet has been created its contents cannot be modified (these ids are ignored during update requests). - :param id: The id of this SnippetDTO. - :type: str + :param connections: The connections of this SnippetDTO. + :type: dict(str, RevisionDTO) """ - self._id = id + self._connections = connections @property - def uri(self): + def funnels(self): """ - Gets the uri of this SnippetDTO. - The URI of the snippet. + Gets the funnels of this SnippetDTO. + The ids of the funnels in this snippet. These ids will be populated within each response. They can be specified when creating a snippet. However, once a snippet has been created its contents cannot be modified (these ids are ignored during update requests). - :return: The uri of this SnippetDTO. - :rtype: str + :return: The funnels of this SnippetDTO. + :rtype: dict(str, RevisionDTO) """ - return self._uri + return self._funnels - @uri.setter - def uri(self, uri): + @funnels.setter + def funnels(self, funnels): """ - Sets the uri of this SnippetDTO. - The URI of the snippet. + Sets the funnels of this SnippetDTO. + The ids of the funnels in this snippet. These ids will be populated within each response. They can be specified when creating a snippet. However, once a snippet has been created its contents cannot be modified (these ids are ignored during update requests). - :param uri: The uri of this SnippetDTO. - :type: str + :param funnels: The funnels of this SnippetDTO. + :type: dict(str, RevisionDTO) """ - self._uri = uri + self._funnels = funnels @property - def parent_group_id(self): + def id(self): """ - Gets the parent_group_id of this SnippetDTO. - The group id for the components in the snippet. + Gets the id of this SnippetDTO. + The id of the snippet. - :return: The parent_group_id of this SnippetDTO. + :return: The id of this SnippetDTO. :rtype: str """ - return self._parent_group_id + return self._id - @parent_group_id.setter - def parent_group_id(self, parent_group_id): + @id.setter + def id(self, id): """ - Sets the parent_group_id of this SnippetDTO. - The group id for the components in the snippet. + Sets the id of this SnippetDTO. + The id of the snippet. - :param parent_group_id: The parent_group_id of this SnippetDTO. + :param id: The id of this SnippetDTO. :type: str """ - self._parent_group_id = parent_group_id + self._id = id @property - def process_groups(self): + def input_ports(self): """ - Gets the process_groups of this SnippetDTO. - The ids of the process groups in this snippet. These ids will be populated within each response. They can be specified when creating a snippet. However, once a snippet has been created its contents cannot be modified (these ids are ignored during update requests). + Gets the input_ports of this SnippetDTO. + The ids of the input ports in this snippet. These ids will be populated within each response. They can be specified when creating a snippet. However, once a snippet has been created its contents cannot be modified (these ids are ignored during update requests). - :return: The process_groups of this SnippetDTO. + :return: The input_ports of this SnippetDTO. :rtype: dict(str, RevisionDTO) """ - return self._process_groups + return self._input_ports - @process_groups.setter - def process_groups(self, process_groups): + @input_ports.setter + def input_ports(self, input_ports): """ - Sets the process_groups of this SnippetDTO. - The ids of the process groups in this snippet. These ids will be populated within each response. They can be specified when creating a snippet. However, once a snippet has been created its contents cannot be modified (these ids are ignored during update requests). + Sets the input_ports of this SnippetDTO. + The ids of the input ports in this snippet. These ids will be populated within each response. They can be specified when creating a snippet. However, once a snippet has been created its contents cannot be modified (these ids are ignored during update requests). - :param process_groups: The process_groups of this SnippetDTO. + :param input_ports: The input_ports of this SnippetDTO. :type: dict(str, RevisionDTO) """ - self._process_groups = process_groups + self._input_ports = input_ports @property - def remote_process_groups(self): + def labels(self): """ - Gets the remote_process_groups of this SnippetDTO. - The ids of the remote process groups in this snippet. These ids will be populated within each response. They can be specified when creating a snippet. However, once a snippet has been created its contents cannot be modified (these ids are ignored during update requests). + Gets the labels of this SnippetDTO. + The ids of the labels in this snippet. These ids will be populated within each response. They can be specified when creating a snippet. However, once a snippet has been created its contents cannot be modified (these ids are ignored during update requests). - :return: The remote_process_groups of this SnippetDTO. + :return: The labels of this SnippetDTO. :rtype: dict(str, RevisionDTO) """ - return self._remote_process_groups + return self._labels - @remote_process_groups.setter - def remote_process_groups(self, remote_process_groups): + @labels.setter + def labels(self, labels): """ - Sets the remote_process_groups of this SnippetDTO. - The ids of the remote process groups in this snippet. These ids will be populated within each response. They can be specified when creating a snippet. However, once a snippet has been created its contents cannot be modified (these ids are ignored during update requests). + Sets the labels of this SnippetDTO. + The ids of the labels in this snippet. These ids will be populated within each response. They can be specified when creating a snippet. However, once a snippet has been created its contents cannot be modified (these ids are ignored during update requests). - :param remote_process_groups: The remote_process_groups of this SnippetDTO. + :param labels: The labels of this SnippetDTO. :type: dict(str, RevisionDTO) """ - self._remote_process_groups = remote_process_groups + self._labels = labels @property - def processors(self): + def output_ports(self): """ - Gets the processors of this SnippetDTO. - The ids of the processors in this snippet. These ids will be populated within each response. They can be specified when creating a snippet. However, once a snippet has been created its contents cannot be modified (these ids are ignored during update requests). + Gets the output_ports of this SnippetDTO. + The ids of the output ports in this snippet. These ids will be populated within each response. They can be specified when creating a snippet. However, once a snippet has been created its contents cannot be modified (these ids are ignored during update requests). - :return: The processors of this SnippetDTO. + :return: The output_ports of this SnippetDTO. :rtype: dict(str, RevisionDTO) """ - return self._processors + return self._output_ports - @processors.setter - def processors(self, processors): + @output_ports.setter + def output_ports(self, output_ports): """ - Sets the processors of this SnippetDTO. - The ids of the processors in this snippet. These ids will be populated within each response. They can be specified when creating a snippet. However, once a snippet has been created its contents cannot be modified (these ids are ignored during update requests). + Sets the output_ports of this SnippetDTO. + The ids of the output ports in this snippet. These ids will be populated within each response. They can be specified when creating a snippet. However, once a snippet has been created its contents cannot be modified (these ids are ignored during update requests). - :param processors: The processors of this SnippetDTO. + :param output_ports: The output_ports of this SnippetDTO. :type: dict(str, RevisionDTO) """ - self._processors = processors + self._output_ports = output_ports @property - def input_ports(self): + def parent_group_id(self): """ - Gets the input_ports of this SnippetDTO. - The ids of the input ports in this snippet. These ids will be populated within each response. They can be specified when creating a snippet. However, once a snippet has been created its contents cannot be modified (these ids are ignored during update requests). + Gets the parent_group_id of this SnippetDTO. + The group id for the components in the snippet. - :return: The input_ports of this SnippetDTO. - :rtype: dict(str, RevisionDTO) + :return: The parent_group_id of this SnippetDTO. + :rtype: str """ - return self._input_ports + return self._parent_group_id - @input_ports.setter - def input_ports(self, input_ports): + @parent_group_id.setter + def parent_group_id(self, parent_group_id): """ - Sets the input_ports of this SnippetDTO. - The ids of the input ports in this snippet. These ids will be populated within each response. They can be specified when creating a snippet. However, once a snippet has been created its contents cannot be modified (these ids are ignored during update requests). + Sets the parent_group_id of this SnippetDTO. + The group id for the components in the snippet. - :param input_ports: The input_ports of this SnippetDTO. - :type: dict(str, RevisionDTO) + :param parent_group_id: The parent_group_id of this SnippetDTO. + :type: str """ - self._input_ports = input_ports + self._parent_group_id = parent_group_id @property - def output_ports(self): + def process_groups(self): """ - Gets the output_ports of this SnippetDTO. - The ids of the output ports in this snippet. These ids will be populated within each response. They can be specified when creating a snippet. However, once a snippet has been created its contents cannot be modified (these ids are ignored during update requests). + Gets the process_groups of this SnippetDTO. + The ids of the process groups in this snippet. These ids will be populated within each response. They can be specified when creating a snippet. However, once a snippet has been created its contents cannot be modified (these ids are ignored during update requests). - :return: The output_ports of this SnippetDTO. + :return: The process_groups of this SnippetDTO. :rtype: dict(str, RevisionDTO) """ - return self._output_ports + return self._process_groups - @output_ports.setter - def output_ports(self, output_ports): + @process_groups.setter + def process_groups(self, process_groups): """ - Sets the output_ports of this SnippetDTO. - The ids of the output ports in this snippet. These ids will be populated within each response. They can be specified when creating a snippet. However, once a snippet has been created its contents cannot be modified (these ids are ignored during update requests). + Sets the process_groups of this SnippetDTO. + The ids of the process groups in this snippet. These ids will be populated within each response. They can be specified when creating a snippet. However, once a snippet has been created its contents cannot be modified (these ids are ignored during update requests). - :param output_ports: The output_ports of this SnippetDTO. + :param process_groups: The process_groups of this SnippetDTO. :type: dict(str, RevisionDTO) """ - self._output_ports = output_ports + self._process_groups = process_groups @property - def connections(self): + def processors(self): """ - Gets the connections of this SnippetDTO. - The ids of the connections in this snippet. These ids will be populated within each response. They can be specified when creating a snippet. However, once a snippet has been created its contents cannot be modified (these ids are ignored during update requests). + Gets the processors of this SnippetDTO. + The ids of the processors in this snippet. These ids will be populated within each response. They can be specified when creating a snippet. However, once a snippet has been created its contents cannot be modified (these ids are ignored during update requests). - :return: The connections of this SnippetDTO. + :return: The processors of this SnippetDTO. :rtype: dict(str, RevisionDTO) """ - return self._connections + return self._processors - @connections.setter - def connections(self, connections): + @processors.setter + def processors(self, processors): """ - Sets the connections of this SnippetDTO. - The ids of the connections in this snippet. These ids will be populated within each response. They can be specified when creating a snippet. However, once a snippet has been created its contents cannot be modified (these ids are ignored during update requests). + Sets the processors of this SnippetDTO. + The ids of the processors in this snippet. These ids will be populated within each response. They can be specified when creating a snippet. However, once a snippet has been created its contents cannot be modified (these ids are ignored during update requests). - :param connections: The connections of this SnippetDTO. + :param processors: The processors of this SnippetDTO. :type: dict(str, RevisionDTO) """ - self._connections = connections + self._processors = processors @property - def labels(self): + def remote_process_groups(self): """ - Gets the labels of this SnippetDTO. - The ids of the labels in this snippet. These ids will be populated within each response. They can be specified when creating a snippet. However, once a snippet has been created its contents cannot be modified (these ids are ignored during update requests). + Gets the remote_process_groups of this SnippetDTO. + The ids of the remote process groups in this snippet. These ids will be populated within each response. They can be specified when creating a snippet. However, once a snippet has been created its contents cannot be modified (these ids are ignored during update requests). - :return: The labels of this SnippetDTO. + :return: The remote_process_groups of this SnippetDTO. :rtype: dict(str, RevisionDTO) """ - return self._labels + return self._remote_process_groups - @labels.setter - def labels(self, labels): + @remote_process_groups.setter + def remote_process_groups(self, remote_process_groups): """ - Sets the labels of this SnippetDTO. - The ids of the labels in this snippet. These ids will be populated within each response. They can be specified when creating a snippet. However, once a snippet has been created its contents cannot be modified (these ids are ignored during update requests). + Sets the remote_process_groups of this SnippetDTO. + The ids of the remote process groups in this snippet. These ids will be populated within each response. They can be specified when creating a snippet. However, once a snippet has been created its contents cannot be modified (these ids are ignored during update requests). - :param labels: The labels of this SnippetDTO. + :param remote_process_groups: The remote_process_groups of this SnippetDTO. :type: dict(str, RevisionDTO) """ - self._labels = labels + self._remote_process_groups = remote_process_groups @property - def funnels(self): + def uri(self): """ - Gets the funnels of this SnippetDTO. - The ids of the funnels in this snippet. These ids will be populated within each response. They can be specified when creating a snippet. However, once a snippet has been created its contents cannot be modified (these ids are ignored during update requests). + Gets the uri of this SnippetDTO. + The URI of the snippet. - :return: The funnels of this SnippetDTO. - :rtype: dict(str, RevisionDTO) + :return: The uri of this SnippetDTO. + :rtype: str """ - return self._funnels + return self._uri - @funnels.setter - def funnels(self, funnels): + @uri.setter + def uri(self, uri): """ - Sets the funnels of this SnippetDTO. - The ids of the funnels in this snippet. These ids will be populated within each response. They can be specified when creating a snippet. However, once a snippet has been created its contents cannot be modified (these ids are ignored during update requests). + Sets the uri of this SnippetDTO. + The URI of the snippet. - :param funnels: The funnels of this SnippetDTO. - :type: dict(str, RevisionDTO) + :param uri: The uri of this SnippetDTO. + :type: str """ - self._funnels = funnels + self._uri = uri def to_dict(self): """ diff --git a/nipyapi/nifi/models/snippet_entity.py b/nipyapi/nifi/models/snippet_entity.py index 68ac803f..0d7be9c9 100644 --- a/nipyapi/nifi/models/snippet_entity.py +++ b/nipyapi/nifi/models/snippet_entity.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,50 +27,25 @@ class SnippetEntity(object): and the value is json key in definition. """ swagger_types = { - 'snippet': 'SnippetDTO', - 'disconnected_node_acknowledged': 'bool' - } + 'disconnected_node_acknowledged': 'bool', +'snippet': 'SnippetDTO' } attribute_map = { - 'snippet': 'snippet', - 'disconnected_node_acknowledged': 'disconnectedNodeAcknowledged' - } + 'disconnected_node_acknowledged': 'disconnectedNodeAcknowledged', +'snippet': 'snippet' } - def __init__(self, snippet=None, disconnected_node_acknowledged=None): + def __init__(self, disconnected_node_acknowledged=None, snippet=None): """ SnippetEntity - a model defined in Swagger """ - self._snippet = None self._disconnected_node_acknowledged = None + self._snippet = None - if snippet is not None: - self.snippet = snippet if disconnected_node_acknowledged is not None: self.disconnected_node_acknowledged = disconnected_node_acknowledged - - @property - def snippet(self): - """ - Gets the snippet of this SnippetEntity. - The snippet. - - :return: The snippet of this SnippetEntity. - :rtype: SnippetDTO - """ - return self._snippet - - @snippet.setter - def snippet(self, snippet): - """ - Sets the snippet of this SnippetEntity. - The snippet. - - :param snippet: The snippet of this SnippetEntity. - :type: SnippetDTO - """ - - self._snippet = snippet + if snippet is not None: + self.snippet = snippet @property def disconnected_node_acknowledged(self): @@ -96,6 +70,27 @@ def disconnected_node_acknowledged(self, disconnected_node_acknowledged): self._disconnected_node_acknowledged = disconnected_node_acknowledged + @property + def snippet(self): + """ + Gets the snippet of this SnippetEntity. + + :return: The snippet of this SnippetEntity. + :rtype: SnippetDTO + """ + return self._snippet + + @snippet.setter + def snippet(self, snippet): + """ + Sets the snippet of this SnippetEntity. + + :param snippet: The snippet of this SnippetEntity. + :type: SnippetDTO + """ + + self._snippet = snippet + def to_dict(self): """ Returns the model properties as a dict diff --git a/nipyapi/nifi/models/stack_trace_element.py b/nipyapi/nifi/models/stack_trace_element.py deleted file mode 100644 index 45dd9ded..00000000 --- a/nipyapi/nifi/models/stack_trace_element.py +++ /dev/null @@ -1,302 +0,0 @@ -""" - NiFi Rest API - - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - - OpenAPI spec version: 1.28.1 - Contact: dev@nifi.apache.org - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - - -from pprint import pformat -import re - - -class StackTraceElement(object): - """ - NOTE: This class is auto generated by the swagger code generator program. - Do not edit the class manually. - """ - - - """ - Attributes: - swagger_types (dict): The key is attribute name - and the value is attribute type. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - """ - swagger_types = { - 'class_loader_name': 'str', - 'module_name': 'str', - 'module_version': 'str', - 'method_name': 'str', - 'file_name': 'str', - 'line_number': 'int', - 'native_method': 'bool', - 'class_name': 'str' - } - - attribute_map = { - 'class_loader_name': 'classLoaderName', - 'module_name': 'moduleName', - 'module_version': 'moduleVersion', - 'method_name': 'methodName', - 'file_name': 'fileName', - 'line_number': 'lineNumber', - 'native_method': 'nativeMethod', - 'class_name': 'className' - } - - def __init__(self, class_loader_name=None, module_name=None, module_version=None, method_name=None, file_name=None, line_number=None, native_method=None, class_name=None): - """ - StackTraceElement - a model defined in Swagger - """ - - self._class_loader_name = None - self._module_name = None - self._module_version = None - self._method_name = None - self._file_name = None - self._line_number = None - self._native_method = None - self._class_name = None - - if class_loader_name is not None: - self.class_loader_name = class_loader_name - if module_name is not None: - self.module_name = module_name - if module_version is not None: - self.module_version = module_version - if method_name is not None: - self.method_name = method_name - if file_name is not None: - self.file_name = file_name - if line_number is not None: - self.line_number = line_number - if native_method is not None: - self.native_method = native_method - if class_name is not None: - self.class_name = class_name - - @property - def class_loader_name(self): - """ - Gets the class_loader_name of this StackTraceElement. - - :return: The class_loader_name of this StackTraceElement. - :rtype: str - """ - return self._class_loader_name - - @class_loader_name.setter - def class_loader_name(self, class_loader_name): - """ - Sets the class_loader_name of this StackTraceElement. - - :param class_loader_name: The class_loader_name of this StackTraceElement. - :type: str - """ - - self._class_loader_name = class_loader_name - - @property - def module_name(self): - """ - Gets the module_name of this StackTraceElement. - - :return: The module_name of this StackTraceElement. - :rtype: str - """ - return self._module_name - - @module_name.setter - def module_name(self, module_name): - """ - Sets the module_name of this StackTraceElement. - - :param module_name: The module_name of this StackTraceElement. - :type: str - """ - - self._module_name = module_name - - @property - def module_version(self): - """ - Gets the module_version of this StackTraceElement. - - :return: The module_version of this StackTraceElement. - :rtype: str - """ - return self._module_version - - @module_version.setter - def module_version(self, module_version): - """ - Sets the module_version of this StackTraceElement. - - :param module_version: The module_version of this StackTraceElement. - :type: str - """ - - self._module_version = module_version - - @property - def method_name(self): - """ - Gets the method_name of this StackTraceElement. - - :return: The method_name of this StackTraceElement. - :rtype: str - """ - return self._method_name - - @method_name.setter - def method_name(self, method_name): - """ - Sets the method_name of this StackTraceElement. - - :param method_name: The method_name of this StackTraceElement. - :type: str - """ - - self._method_name = method_name - - @property - def file_name(self): - """ - Gets the file_name of this StackTraceElement. - - :return: The file_name of this StackTraceElement. - :rtype: str - """ - return self._file_name - - @file_name.setter - def file_name(self, file_name): - """ - Sets the file_name of this StackTraceElement. - - :param file_name: The file_name of this StackTraceElement. - :type: str - """ - - self._file_name = file_name - - @property - def line_number(self): - """ - Gets the line_number of this StackTraceElement. - - :return: The line_number of this StackTraceElement. - :rtype: int - """ - return self._line_number - - @line_number.setter - def line_number(self, line_number): - """ - Sets the line_number of this StackTraceElement. - - :param line_number: The line_number of this StackTraceElement. - :type: int - """ - - self._line_number = line_number - - @property - def native_method(self): - """ - Gets the native_method of this StackTraceElement. - - :return: The native_method of this StackTraceElement. - :rtype: bool - """ - return self._native_method - - @native_method.setter - def native_method(self, native_method): - """ - Sets the native_method of this StackTraceElement. - - :param native_method: The native_method of this StackTraceElement. - :type: bool - """ - - self._native_method = native_method - - @property - def class_name(self): - """ - Gets the class_name of this StackTraceElement. - - :return: The class_name of this StackTraceElement. - :rtype: str - """ - return self._class_name - - @class_name.setter - def class_name(self, class_name): - """ - Sets the class_name of this StackTraceElement. - - :param class_name: The class_name of this StackTraceElement. - :type: str - """ - - self._class_name = class_name - - 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, StackTraceElement): - 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/start_version_control_request_entity.py b/nipyapi/nifi/models/start_version_control_request_entity.py index 29e90370..3962edee 100644 --- a/nipyapi/nifi/models/start_version_control_request_entity.py +++ b/nipyapi/nifi/models/start_version_control_request_entity.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,61 +27,58 @@ class StartVersionControlRequestEntity(object): and the value is json key in definition. """ swagger_types = { - 'versioned_flow': 'VersionedFlowDTO', - 'process_group_revision': 'RevisionDTO', - 'disconnected_node_acknowledged': 'bool' - } + 'disconnected_node_acknowledged': 'bool', +'process_group_revision': 'RevisionDTO', +'versioned_flow': 'VersionedFlowDTO' } attribute_map = { - 'versioned_flow': 'versionedFlow', - 'process_group_revision': 'processGroupRevision', - 'disconnected_node_acknowledged': 'disconnectedNodeAcknowledged' - } + 'disconnected_node_acknowledged': 'disconnectedNodeAcknowledged', +'process_group_revision': 'processGroupRevision', +'versioned_flow': 'versionedFlow' } - def __init__(self, versioned_flow=None, process_group_revision=None, disconnected_node_acknowledged=None): + def __init__(self, disconnected_node_acknowledged=None, process_group_revision=None, versioned_flow=None): """ StartVersionControlRequestEntity - a model defined in Swagger """ - self._versioned_flow = None - self._process_group_revision = None self._disconnected_node_acknowledged = None + self._process_group_revision = None + self._versioned_flow = None - if versioned_flow is not None: - self.versioned_flow = versioned_flow - if process_group_revision is not None: - self.process_group_revision = process_group_revision if disconnected_node_acknowledged is not None: self.disconnected_node_acknowledged = disconnected_node_acknowledged + if process_group_revision is not None: + self.process_group_revision = process_group_revision + if versioned_flow is not None: + self.versioned_flow = versioned_flow @property - def versioned_flow(self): + def disconnected_node_acknowledged(self): """ - Gets the versioned_flow of this StartVersionControlRequestEntity. - The versioned flow + Gets the disconnected_node_acknowledged of this StartVersionControlRequestEntity. + Acknowledges that this node is disconnected to allow for mutable requests to proceed. - :return: The versioned_flow of this StartVersionControlRequestEntity. - :rtype: VersionedFlowDTO + :return: The disconnected_node_acknowledged of this StartVersionControlRequestEntity. + :rtype: bool """ - return self._versioned_flow + return self._disconnected_node_acknowledged - @versioned_flow.setter - def versioned_flow(self, versioned_flow): + @disconnected_node_acknowledged.setter + def disconnected_node_acknowledged(self, disconnected_node_acknowledged): """ - Sets the versioned_flow of this StartVersionControlRequestEntity. - The versioned flow + Sets the disconnected_node_acknowledged of this StartVersionControlRequestEntity. + Acknowledges that this node is disconnected to allow for mutable requests to proceed. - :param versioned_flow: The versioned_flow of this StartVersionControlRequestEntity. - :type: VersionedFlowDTO + :param disconnected_node_acknowledged: The disconnected_node_acknowledged of this StartVersionControlRequestEntity. + :type: bool """ - self._versioned_flow = versioned_flow + self._disconnected_node_acknowledged = disconnected_node_acknowledged @property def process_group_revision(self): """ Gets the process_group_revision of this StartVersionControlRequestEntity. - The Revision of the Process Group under Version Control :return: The process_group_revision of this StartVersionControlRequestEntity. :rtype: RevisionDTO @@ -93,7 +89,6 @@ def process_group_revision(self): def process_group_revision(self, process_group_revision): """ Sets the process_group_revision of this StartVersionControlRequestEntity. - The Revision of the Process Group under Version Control :param process_group_revision: The process_group_revision of this StartVersionControlRequestEntity. :type: RevisionDTO @@ -102,27 +97,25 @@ def process_group_revision(self, process_group_revision): self._process_group_revision = process_group_revision @property - def disconnected_node_acknowledged(self): + def versioned_flow(self): """ - Gets the disconnected_node_acknowledged of this StartVersionControlRequestEntity. - Acknowledges that this node is disconnected to allow for mutable requests to proceed. + Gets the versioned_flow of this StartVersionControlRequestEntity. - :return: The disconnected_node_acknowledged of this StartVersionControlRequestEntity. - :rtype: bool + :return: The versioned_flow of this StartVersionControlRequestEntity. + :rtype: VersionedFlowDTO """ - return self._disconnected_node_acknowledged + return self._versioned_flow - @disconnected_node_acknowledged.setter - def disconnected_node_acknowledged(self, disconnected_node_acknowledged): + @versioned_flow.setter + def versioned_flow(self, versioned_flow): """ - Sets the disconnected_node_acknowledged of this StartVersionControlRequestEntity. - Acknowledges that this node is disconnected to allow for mutable requests to proceed. + Sets the versioned_flow of this StartVersionControlRequestEntity. - :param disconnected_node_acknowledged: The disconnected_node_acknowledged of this StartVersionControlRequestEntity. - :type: bool + :param versioned_flow: The versioned_flow of this StartVersionControlRequestEntity. + :type: VersionedFlowDTO """ - self._disconnected_node_acknowledged = disconnected_node_acknowledged + self._versioned_flow = versioned_flow def to_dict(self): """ diff --git a/nipyapi/nifi/models/state_entry_dto.py b/nipyapi/nifi/models/state_entry_dto.py index 98c328d6..8c00d78f 100644 --- a/nipyapi/nifi/models/state_entry_dto.py +++ b/nipyapi/nifi/models/state_entry_dto.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,129 +27,127 @@ class StateEntryDTO(object): and the value is json key in definition. """ swagger_types = { - 'key': 'str', - 'value': 'str', - 'cluster_node_id': 'str', - 'cluster_node_address': 'str' - } + 'cluster_node_address': 'str', +'cluster_node_id': 'str', +'key': 'str', +'value': 'str' } attribute_map = { - 'key': 'key', - 'value': 'value', - 'cluster_node_id': 'clusterNodeId', - 'cluster_node_address': 'clusterNodeAddress' - } + 'cluster_node_address': 'clusterNodeAddress', +'cluster_node_id': 'clusterNodeId', +'key': 'key', +'value': 'value' } - def __init__(self, key=None, value=None, cluster_node_id=None, cluster_node_address=None): + def __init__(self, cluster_node_address=None, cluster_node_id=None, key=None, value=None): """ StateEntryDTO - a model defined in Swagger """ + self._cluster_node_address = None + self._cluster_node_id = None self._key = None self._value = None - self._cluster_node_id = None - self._cluster_node_address = None + if cluster_node_address is not None: + self.cluster_node_address = cluster_node_address + if cluster_node_id is not None: + self.cluster_node_id = cluster_node_id if key is not None: self.key = key if value is not None: self.value = value - if cluster_node_id is not None: - self.cluster_node_id = cluster_node_id - if cluster_node_address is not None: - self.cluster_node_address = cluster_node_address @property - def key(self): + def cluster_node_address(self): """ - Gets the key of this StateEntryDTO. - The key for this state. + Gets the cluster_node_address of this StateEntryDTO. + The label for the node where the state originated. - :return: The key of this StateEntryDTO. + :return: The cluster_node_address of this StateEntryDTO. :rtype: str """ - return self._key + return self._cluster_node_address - @key.setter - def key(self, key): + @cluster_node_address.setter + def cluster_node_address(self, cluster_node_address): """ - Sets the key of this StateEntryDTO. - The key for this state. + Sets the cluster_node_address of this StateEntryDTO. + The label for the node where the state originated. - :param key: The key of this StateEntryDTO. + :param cluster_node_address: The cluster_node_address of this StateEntryDTO. :type: str """ - self._key = key + self._cluster_node_address = cluster_node_address @property - def value(self): + def cluster_node_id(self): """ - Gets the value of this StateEntryDTO. - The value for this state. + Gets the cluster_node_id of this StateEntryDTO. + The identifier for the node where the state originated. - :return: The value of this StateEntryDTO. + :return: The cluster_node_id of this StateEntryDTO. :rtype: str """ - return self._value + return self._cluster_node_id - @value.setter - def value(self, value): + @cluster_node_id.setter + def cluster_node_id(self, cluster_node_id): """ - Sets the value of this StateEntryDTO. - The value for this state. + Sets the cluster_node_id of this StateEntryDTO. + The identifier for the node where the state originated. - :param value: The value of this StateEntryDTO. + :param cluster_node_id: The cluster_node_id of this StateEntryDTO. :type: str """ - self._value = value + self._cluster_node_id = cluster_node_id @property - def cluster_node_id(self): + def key(self): """ - Gets the cluster_node_id of this StateEntryDTO. - The identifier for the node where the state originated. + Gets the key of this StateEntryDTO. + The key for this state. - :return: The cluster_node_id of this StateEntryDTO. + :return: The key of this StateEntryDTO. :rtype: str """ - return self._cluster_node_id + return self._key - @cluster_node_id.setter - def cluster_node_id(self, cluster_node_id): + @key.setter + def key(self, key): """ - Sets the cluster_node_id of this StateEntryDTO. - The identifier for the node where the state originated. + Sets the key of this StateEntryDTO. + The key for this state. - :param cluster_node_id: The cluster_node_id of this StateEntryDTO. + :param key: The key of this StateEntryDTO. :type: str """ - self._cluster_node_id = cluster_node_id + self._key = key @property - def cluster_node_address(self): + def value(self): """ - Gets the cluster_node_address of this StateEntryDTO. - The label for the node where the state originated. + Gets the value of this StateEntryDTO. + The value for this state. - :return: The cluster_node_address of this StateEntryDTO. + :return: The value of this StateEntryDTO. :rtype: str """ - return self._cluster_node_address + return self._value - @cluster_node_address.setter - def cluster_node_address(self, cluster_node_address): + @value.setter + def value(self, value): """ - Sets the cluster_node_address of this StateEntryDTO. - The label for the node where the state originated. + Sets the value of this StateEntryDTO. + The value for this state. - :param cluster_node_address: The cluster_node_address of this StateEntryDTO. + :param value: The value of this StateEntryDTO. :type: str """ - self._cluster_node_address = cluster_node_address + self._value = value def to_dict(self): """ diff --git a/nipyapi/nifi/models/state_map_dto.py b/nipyapi/nifi/models/state_map_dto.py index f5365e50..3531ab0f 100644 --- a/nipyapi/nifi/models/state_map_dto.py +++ b/nipyapi/nifi/models/state_map_dto.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -29,31 +28,29 @@ class StateMapDTO(object): """ swagger_types = { 'scope': 'str', - 'total_entry_count': 'int', - 'state': 'list[StateEntryDTO]' - } +'state': 'list[StateEntryDTO]', +'total_entry_count': 'int' } attribute_map = { 'scope': 'scope', - 'total_entry_count': 'totalEntryCount', - 'state': 'state' - } +'state': 'state', +'total_entry_count': 'totalEntryCount' } - def __init__(self, scope=None, total_entry_count=None, state=None): + def __init__(self, scope=None, state=None, total_entry_count=None): """ StateMapDTO - a model defined in Swagger """ self._scope = None - self._total_entry_count = None self._state = None + self._total_entry_count = None if scope is not None: self.scope = scope - if total_entry_count is not None: - self.total_entry_count = total_entry_count if state is not None: self.state = state + if total_entry_count is not None: + self.total_entry_count = total_entry_count @property def scope(self): @@ -78,29 +75,6 @@ def scope(self, scope): self._scope = scope - @property - def total_entry_count(self): - """ - Gets the total_entry_count of this StateMapDTO. - The total number of state entries. When the state map is lengthy, only of portion of the entries are returned. - - :return: The total_entry_count of this StateMapDTO. - :rtype: int - """ - return self._total_entry_count - - @total_entry_count.setter - def total_entry_count(self, total_entry_count): - """ - Sets the total_entry_count of this StateMapDTO. - The total number of state entries. When the state map is lengthy, only of portion of the entries are returned. - - :param total_entry_count: The total_entry_count of this StateMapDTO. - :type: int - """ - - self._total_entry_count = total_entry_count - @property def state(self): """ @@ -124,6 +98,29 @@ def state(self, state): self._state = state + @property + def total_entry_count(self): + """ + Gets the total_entry_count of this StateMapDTO. + The total number of state entries. When the state map is lengthy, only of portion of the entries are returned. + + :return: The total_entry_count of this StateMapDTO. + :rtype: int + """ + return self._total_entry_count + + @total_entry_count.setter + def total_entry_count(self, total_entry_count): + """ + Sets the total_entry_count of this StateMapDTO. + The total number of state entries. When the state map is lengthy, only of portion of the entries are returned. + + :param total_entry_count: The total_entry_count of this StateMapDTO. + :type: int + """ + + self._total_entry_count = total_entry_count + def to_dict(self): """ Returns the model properties as a dict diff --git a/nipyapi/nifi/models/stateful.py b/nipyapi/nifi/models/stateful.py index a4a083cc..2aab5f27 100644 --- a/nipyapi/nifi/models/stateful.py +++ b/nipyapi/nifi/models/stateful.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -29,13 +28,11 @@ class Stateful(object): """ swagger_types = { 'description': 'str', - 'scopes': 'list[str]' - } +'scopes': 'list[str]' } attribute_map = { 'description': 'description', - 'scopes': 'scopes' - } +'scopes': 'scopes' } def __init__(self, description=None, scopes=None): """ @@ -93,7 +90,7 @@ def scopes(self, scopes): :param scopes: The scopes of this Stateful. :type: list[str] """ - allowed_values = ["CLUSTER", "LOCAL"] + 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}]" diff --git a/nipyapi/nifi/models/status_descriptor_dto.py b/nipyapi/nifi/models/status_descriptor_dto.py index 91195fe0..97a792d9 100644 --- a/nipyapi/nifi/models/status_descriptor_dto.py +++ b/nipyapi/nifi/models/status_descriptor_dto.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,129 +27,127 @@ class StatusDescriptorDTO(object): and the value is json key in definition. """ swagger_types = { - 'field': 'str', - 'label': 'str', 'description': 'str', - 'formatter': 'str' - } +'field': 'str', +'formatter': 'str', +'label': 'str' } attribute_map = { - 'field': 'field', - 'label': 'label', 'description': 'description', - 'formatter': 'formatter' - } +'field': 'field', +'formatter': 'formatter', +'label': 'label' } - def __init__(self, field=None, label=None, description=None, formatter=None): + def __init__(self, description=None, field=None, formatter=None, label=None): """ StatusDescriptorDTO - a model defined in Swagger """ - self._field = None - self._label = None self._description = None + self._field = None self._formatter = None + self._label = None - if field is not None: - self.field = field - if label is not None: - self.label = label if description is not None: self.description = description + if field is not None: + self.field = field if formatter is not None: self.formatter = formatter + if label is not None: + self.label = label @property - def field(self): + def description(self): """ - Gets the field of this StatusDescriptorDTO. - The name of the status field. + Gets the description of this StatusDescriptorDTO. + The description of the status field. - :return: The field of this StatusDescriptorDTO. + :return: The description of this StatusDescriptorDTO. :rtype: str """ - return self._field + return self._description - @field.setter - def field(self, field): + @description.setter + def description(self, description): """ - Sets the field of this StatusDescriptorDTO. - The name of the status field. + Sets the description of this StatusDescriptorDTO. + The description of the status field. - :param field: The field of this StatusDescriptorDTO. + :param description: The description of this StatusDescriptorDTO. :type: str """ - self._field = field + self._description = description @property - def label(self): + def field(self): """ - Gets the label of this StatusDescriptorDTO. - The label for the status field. + Gets the field of this StatusDescriptorDTO. + The name of the status field. - :return: The label of this StatusDescriptorDTO. + :return: The field of this StatusDescriptorDTO. :rtype: str """ - return self._label + return self._field - @label.setter - def label(self, label): + @field.setter + def field(self, field): """ - Sets the label of this StatusDescriptorDTO. - The label for the status field. + Sets the field of this StatusDescriptorDTO. + The name of the status field. - :param label: The label of this StatusDescriptorDTO. + :param field: The field of this StatusDescriptorDTO. :type: str """ - self._label = label + self._field = field @property - def description(self): + def formatter(self): """ - Gets the description of this StatusDescriptorDTO. - The description of the status field. + Gets the formatter of this StatusDescriptorDTO. + The formatter for the status descriptor. - :return: The description of this StatusDescriptorDTO. + :return: The formatter of this StatusDescriptorDTO. :rtype: str """ - return self._description + return self._formatter - @description.setter - def description(self, description): + @formatter.setter + def formatter(self, formatter): """ - Sets the description of this StatusDescriptorDTO. - The description of the status field. + Sets the formatter of this StatusDescriptorDTO. + The formatter for the status descriptor. - :param description: The description of this StatusDescriptorDTO. + :param formatter: The formatter of this StatusDescriptorDTO. :type: str """ - self._description = description + self._formatter = formatter @property - def formatter(self): + def label(self): """ - Gets the formatter of this StatusDescriptorDTO. - The formatter for the status descriptor. + Gets the label of this StatusDescriptorDTO. + The label for the status field. - :return: The formatter of this StatusDescriptorDTO. + :return: The label of this StatusDescriptorDTO. :rtype: str """ - return self._formatter + return self._label - @formatter.setter - def formatter(self, formatter): + @label.setter + def label(self, label): """ - Sets the formatter of this StatusDescriptorDTO. - The formatter for the status descriptor. + Sets the label of this StatusDescriptorDTO. + The label for the status field. - :param formatter: The formatter of this StatusDescriptorDTO. + :param label: The label of this StatusDescriptorDTO. :type: str """ - self._formatter = formatter + self._label = label def to_dict(self): """ diff --git a/nipyapi/nifi/models/status_history_dto.py b/nipyapi/nifi/models/status_history_dto.py index 9895382c..c7cd034d 100644 --- a/nipyapi/nifi/models/status_history_dto.py +++ b/nipyapi/nifi/models/status_history_dto.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,65 +27,63 @@ class StatusHistoryDTO(object): and the value is json key in definition. """ swagger_types = { - 'generated': 'str', - 'component_details': 'dict(str, str)', - 'field_descriptors': 'list[StatusDescriptorDTO]', 'aggregate_snapshots': 'list[StatusSnapshotDTO]', - 'node_snapshots': 'list[NodeStatusSnapshotsDTO]' - } +'component_details': 'dict(str, str)', +'field_descriptors': 'list[StatusDescriptorDTO]', +'generated': 'str', +'node_snapshots': 'list[NodeStatusSnapshotsDTO]' } attribute_map = { - 'generated': 'generated', - 'component_details': 'componentDetails', - 'field_descriptors': 'fieldDescriptors', 'aggregate_snapshots': 'aggregateSnapshots', - 'node_snapshots': 'nodeSnapshots' - } +'component_details': 'componentDetails', +'field_descriptors': 'fieldDescriptors', +'generated': 'generated', +'node_snapshots': 'nodeSnapshots' } - def __init__(self, generated=None, component_details=None, field_descriptors=None, aggregate_snapshots=None, node_snapshots=None): + def __init__(self, aggregate_snapshots=None, component_details=None, field_descriptors=None, generated=None, node_snapshots=None): """ StatusHistoryDTO - a model defined in Swagger """ - self._generated = None + self._aggregate_snapshots = None self._component_details = None self._field_descriptors = None - self._aggregate_snapshots = None + self._generated = None self._node_snapshots = None - if generated is not None: - self.generated = generated + if aggregate_snapshots is not None: + self.aggregate_snapshots = aggregate_snapshots if component_details is not None: self.component_details = component_details if field_descriptors is not None: self.field_descriptors = field_descriptors - if aggregate_snapshots is not None: - self.aggregate_snapshots = aggregate_snapshots + if generated is not None: + self.generated = generated if node_snapshots is not None: self.node_snapshots = node_snapshots @property - def generated(self): + def aggregate_snapshots(self): """ - Gets the generated of this StatusHistoryDTO. - When the status history was generated. + Gets the aggregate_snapshots of this StatusHistoryDTO. + A list of StatusSnapshotDTO objects that provide the actual metric values for the component. If the NiFi instance is clustered, this will represent the aggregate status across all nodes. If the NiFi instance is not clustered, this will represent the status of the entire NiFi instance. - :return: The generated of this StatusHistoryDTO. - :rtype: str + :return: The aggregate_snapshots of this StatusHistoryDTO. + :rtype: list[StatusSnapshotDTO] """ - return self._generated + return self._aggregate_snapshots - @generated.setter - def generated(self, generated): + @aggregate_snapshots.setter + def aggregate_snapshots(self, aggregate_snapshots): """ - Sets the generated of this StatusHistoryDTO. - When the status history was generated. + Sets the aggregate_snapshots of this StatusHistoryDTO. + A list of StatusSnapshotDTO objects that provide the actual metric values for the component. If the NiFi instance is clustered, this will represent the aggregate status across all nodes. If the NiFi instance is not clustered, this will represent the status of the entire NiFi instance. - :param generated: The generated of this StatusHistoryDTO. - :type: str + :param aggregate_snapshots: The aggregate_snapshots of this StatusHistoryDTO. + :type: list[StatusSnapshotDTO] """ - self._generated = generated + self._aggregate_snapshots = aggregate_snapshots @property def component_details(self): @@ -135,27 +132,27 @@ def field_descriptors(self, field_descriptors): self._field_descriptors = field_descriptors @property - def aggregate_snapshots(self): + def generated(self): """ - Gets the aggregate_snapshots of this StatusHistoryDTO. - A list of StatusSnapshotDTO objects that provide the actual metric values for the component. If the NiFi instance is clustered, this will represent the aggregate status across all nodes. If the NiFi instance is not clustered, this will represent the status of the entire NiFi instance. + Gets the generated of this StatusHistoryDTO. + When the status history was generated. - :return: The aggregate_snapshots of this StatusHistoryDTO. - :rtype: list[StatusSnapshotDTO] + :return: The generated of this StatusHistoryDTO. + :rtype: str """ - return self._aggregate_snapshots + return self._generated - @aggregate_snapshots.setter - def aggregate_snapshots(self, aggregate_snapshots): + @generated.setter + def generated(self, generated): """ - Sets the aggregate_snapshots of this StatusHistoryDTO. - A list of StatusSnapshotDTO objects that provide the actual metric values for the component. If the NiFi instance is clustered, this will represent the aggregate status across all nodes. If the NiFi instance is not clustered, this will represent the status of the entire NiFi instance. + Sets the generated of this StatusHistoryDTO. + When the status history was generated. - :param aggregate_snapshots: The aggregate_snapshots of this StatusHistoryDTO. - :type: list[StatusSnapshotDTO] + :param generated: The generated of this StatusHistoryDTO. + :type: str """ - self._aggregate_snapshots = aggregate_snapshots + self._generated = generated @property def node_snapshots(self): diff --git a/nipyapi/nifi/models/status_history_entity.py b/nipyapi/nifi/models/status_history_entity.py index b8f2f2b8..a33a4d4e 100644 --- a/nipyapi/nifi/models/status_history_entity.py +++ b/nipyapi/nifi/models/status_history_entity.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,48 +27,25 @@ class StatusHistoryEntity(object): and the value is json key in definition. """ swagger_types = { - 'status_history': 'StatusHistoryDTO', - 'can_read': 'bool' - } + 'can_read': 'bool', +'status_history': 'StatusHistoryDTO' } attribute_map = { - 'status_history': 'statusHistory', - 'can_read': 'canRead' - } + 'can_read': 'canRead', +'status_history': 'statusHistory' } - def __init__(self, status_history=None, can_read=None): + def __init__(self, can_read=None, status_history=None): """ StatusHistoryEntity - a model defined in Swagger """ - self._status_history = None self._can_read = None + self._status_history = None - if status_history is not None: - self.status_history = status_history if can_read is not None: self.can_read = can_read - - @property - def status_history(self): - """ - Gets the status_history of this StatusHistoryEntity. - - :return: The status_history of this StatusHistoryEntity. - :rtype: StatusHistoryDTO - """ - return self._status_history - - @status_history.setter - def status_history(self, status_history): - """ - Sets the status_history of this StatusHistoryEntity. - - :param status_history: The status_history of this StatusHistoryEntity. - :type: StatusHistoryDTO - """ - - self._status_history = status_history + if status_history is not None: + self.status_history = status_history @property def can_read(self): @@ -94,6 +70,27 @@ def can_read(self, can_read): self._can_read = can_read + @property + def status_history(self): + """ + Gets the status_history of this StatusHistoryEntity. + + :return: The status_history of this StatusHistoryEntity. + :rtype: StatusHistoryDTO + """ + return self._status_history + + @status_history.setter + def status_history(self, status_history): + """ + Sets the status_history of this StatusHistoryEntity. + + :param status_history: The status_history of this StatusHistoryEntity. + :type: StatusHistoryDTO + """ + + self._status_history = status_history + def to_dict(self): """ Returns the model properties as a dict diff --git a/nipyapi/nifi/models/status_snapshot_dto.py b/nipyapi/nifi/models/status_snapshot_dto.py index a9567a53..c2d00889 100644 --- a/nipyapi/nifi/models/status_snapshot_dto.py +++ b/nipyapi/nifi/models/status_snapshot_dto.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,50 +27,25 @@ class StatusSnapshotDTO(object): and the value is json key in definition. """ swagger_types = { - 'timestamp': 'datetime', - 'status_metrics': 'dict(str, int)' - } + 'status_metrics': 'dict(str, int)', +'timestamp': 'datetime' } attribute_map = { - 'timestamp': 'timestamp', - 'status_metrics': 'statusMetrics' - } + 'status_metrics': 'statusMetrics', +'timestamp': 'timestamp' } - def __init__(self, timestamp=None, status_metrics=None): + def __init__(self, status_metrics=None, timestamp=None): """ StatusSnapshotDTO - a model defined in Swagger """ - self._timestamp = None self._status_metrics = None + self._timestamp = None - if timestamp is not None: - self.timestamp = timestamp if status_metrics is not None: self.status_metrics = status_metrics - - @property - def timestamp(self): - """ - Gets the timestamp of this StatusSnapshotDTO. - The timestamp of the snapshot. - - :return: The timestamp of this StatusSnapshotDTO. - :rtype: datetime - """ - return self._timestamp - - @timestamp.setter - def timestamp(self, timestamp): - """ - Sets the timestamp of this StatusSnapshotDTO. - The timestamp of the snapshot. - - :param timestamp: The timestamp of this StatusSnapshotDTO. - :type: datetime - """ - - self._timestamp = timestamp + if timestamp is not None: + self.timestamp = timestamp @property def status_metrics(self): @@ -96,6 +70,29 @@ def status_metrics(self, status_metrics): self._status_metrics = status_metrics + @property + def timestamp(self): + """ + Gets the timestamp of this StatusSnapshotDTO. + The timestamp of the snapshot. + + :return: The timestamp of this StatusSnapshotDTO. + :rtype: datetime + """ + return self._timestamp + + @timestamp.setter + def timestamp(self, timestamp): + """ + Sets the timestamp of this StatusSnapshotDTO. + The timestamp of the snapshot. + + :param timestamp: The timestamp of this StatusSnapshotDTO. + :type: datetime + """ + + self._timestamp = timestamp + def to_dict(self): """ Returns the model properties as a dict diff --git a/nipyapi/nifi/models/storage_usage_dto.py b/nipyapi/nifi/models/storage_usage_dto.py index 51a944c8..cfa58d35 100644 --- a/nipyapi/nifi/models/storage_usage_dto.py +++ b/nipyapi/nifi/models/storage_usage_dto.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,81 +27,56 @@ class StorageUsageDTO(object): and the value is json key in definition. """ swagger_types = { - 'identifier': 'str', 'free_space': 'str', - 'total_space': 'str', - 'used_space': 'str', - 'free_space_bytes': 'int', - 'total_space_bytes': 'int', - 'used_space_bytes': 'int', - 'utilization': 'str' - } +'free_space_bytes': 'int', +'identifier': 'str', +'total_space': 'str', +'total_space_bytes': 'int', +'used_space': 'str', +'used_space_bytes': 'int', +'utilization': 'str' } attribute_map = { - 'identifier': 'identifier', 'free_space': 'freeSpace', - 'total_space': 'totalSpace', - 'used_space': 'usedSpace', - 'free_space_bytes': 'freeSpaceBytes', - 'total_space_bytes': 'totalSpaceBytes', - 'used_space_bytes': 'usedSpaceBytes', - 'utilization': 'utilization' - } +'free_space_bytes': 'freeSpaceBytes', +'identifier': 'identifier', +'total_space': 'totalSpace', +'total_space_bytes': 'totalSpaceBytes', +'used_space': 'usedSpace', +'used_space_bytes': 'usedSpaceBytes', +'utilization': 'utilization' } - def __init__(self, identifier=None, free_space=None, total_space=None, used_space=None, free_space_bytes=None, total_space_bytes=None, used_space_bytes=None, utilization=None): + def __init__(self, free_space=None, free_space_bytes=None, identifier=None, total_space=None, total_space_bytes=None, used_space=None, used_space_bytes=None, utilization=None): """ StorageUsageDTO - a model defined in Swagger """ - self._identifier = None self._free_space = None - self._total_space = None - self._used_space = None self._free_space_bytes = None + self._identifier = None + self._total_space = None self._total_space_bytes = None + self._used_space = None self._used_space_bytes = None self._utilization = None - if identifier is not None: - self.identifier = identifier if free_space is not None: self.free_space = free_space - if total_space is not None: - self.total_space = total_space - if used_space is not None: - self.used_space = used_space if free_space_bytes is not None: self.free_space_bytes = free_space_bytes + if identifier is not None: + self.identifier = identifier + if total_space is not None: + self.total_space = total_space if total_space_bytes is not None: self.total_space_bytes = total_space_bytes + if used_space is not None: + self.used_space = used_space if used_space_bytes is not None: self.used_space_bytes = used_space_bytes if utilization is not None: self.utilization = utilization - @property - def identifier(self): - """ - Gets the identifier of this StorageUsageDTO. - The identifier of this storage location. The identifier will correspond to the identifier keyed in the storage configuration. - - :return: The identifier of this StorageUsageDTO. - :rtype: str - """ - return self._identifier - - @identifier.setter - def identifier(self, identifier): - """ - Sets the identifier of this StorageUsageDTO. - The identifier of this storage location. The identifier will correspond to the identifier keyed in the storage configuration. - - :param identifier: The identifier of this StorageUsageDTO. - :type: str - """ - - self._identifier = identifier - @property def free_space(self): """ @@ -127,73 +101,73 @@ def free_space(self, free_space): self._free_space = free_space @property - def total_space(self): + def free_space_bytes(self): """ - Gets the total_space of this StorageUsageDTO. - Amount of total space. + Gets the free_space_bytes of this StorageUsageDTO. + The number of bytes of free space. - :return: The total_space of this StorageUsageDTO. - :rtype: str + :return: The free_space_bytes of this StorageUsageDTO. + :rtype: int """ - return self._total_space + return self._free_space_bytes - @total_space.setter - def total_space(self, total_space): + @free_space_bytes.setter + def free_space_bytes(self, free_space_bytes): """ - Sets the total_space of this StorageUsageDTO. - Amount of total space. + Sets the free_space_bytes of this StorageUsageDTO. + The number of bytes of free space. - :param total_space: The total_space of this StorageUsageDTO. - :type: str + :param free_space_bytes: The free_space_bytes of this StorageUsageDTO. + :type: int """ - self._total_space = total_space + self._free_space_bytes = free_space_bytes @property - def used_space(self): + def identifier(self): """ - Gets the used_space of this StorageUsageDTO. - Amount of used space. + Gets the identifier of this StorageUsageDTO. + The identifier of this storage location. The identifier will correspond to the identifier keyed in the storage configuration. - :return: The used_space of this StorageUsageDTO. + :return: The identifier of this StorageUsageDTO. :rtype: str """ - return self._used_space + return self._identifier - @used_space.setter - def used_space(self, used_space): + @identifier.setter + def identifier(self, identifier): """ - Sets the used_space of this StorageUsageDTO. - Amount of used space. + Sets the identifier of this StorageUsageDTO. + The identifier of this storage location. The identifier will correspond to the identifier keyed in the storage configuration. - :param used_space: The used_space of this StorageUsageDTO. + :param identifier: The identifier of this StorageUsageDTO. :type: str """ - self._used_space = used_space + self._identifier = identifier @property - def free_space_bytes(self): + def total_space(self): """ - Gets the free_space_bytes of this StorageUsageDTO. - The number of bytes of free space. + Gets the total_space of this StorageUsageDTO. + Amount of total space. - :return: The free_space_bytes of this StorageUsageDTO. - :rtype: int + :return: The total_space of this StorageUsageDTO. + :rtype: str """ - return self._free_space_bytes + return self._total_space - @free_space_bytes.setter - def free_space_bytes(self, free_space_bytes): + @total_space.setter + def total_space(self, total_space): """ - Sets the free_space_bytes of this StorageUsageDTO. - The number of bytes of free space. + Sets the total_space of this StorageUsageDTO. + Amount of total space. - :param free_space_bytes: The free_space_bytes of this StorageUsageDTO. - :type: int + :param total_space: The total_space of this StorageUsageDTO. + :type: str """ - self._free_space_bytes = free_space_bytes + self._total_space = total_space @property def total_space_bytes(self): @@ -218,6 +192,29 @@ def total_space_bytes(self, total_space_bytes): self._total_space_bytes = total_space_bytes + @property + def used_space(self): + """ + Gets the used_space of this StorageUsageDTO. + Amount of used space. + + :return: The used_space of this StorageUsageDTO. + :rtype: str + """ + return self._used_space + + @used_space.setter + def used_space(self, used_space): + """ + Sets the used_space of this StorageUsageDTO. + Amount of used space. + + :param used_space: The used_space of this StorageUsageDTO. + :type: str + """ + + self._used_space = used_space + @property def used_space_bytes(self): """ diff --git a/nipyapi/nifi/models/streaming_output.py b/nipyapi/nifi/models/streaming_output.py index c5533ba0..9ab4b143 100644 --- a/nipyapi/nifi/models/streaming_output.py +++ b/nipyapi/nifi/models/streaming_output.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,12 +27,10 @@ class StreamingOutput(object): and the value is json key in definition. """ swagger_types = { - - } + } attribute_map = { - - } + } def __init__(self): """ diff --git a/nipyapi/nifi/models/submit_replay_request_entity.py b/nipyapi/nifi/models/submit_replay_request_entity.py index dc79aeef..b6aa09d2 100644 --- a/nipyapi/nifi/models/submit_replay_request_entity.py +++ b/nipyapi/nifi/models/submit_replay_request_entity.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,50 +27,25 @@ class SubmitReplayRequestEntity(object): and the value is json key in definition. """ swagger_types = { - 'event_id': 'int', - 'cluster_node_id': 'str' - } + 'cluster_node_id': 'str', +'event_id': 'int' } attribute_map = { - 'event_id': 'eventId', - 'cluster_node_id': 'clusterNodeId' - } + 'cluster_node_id': 'clusterNodeId', +'event_id': 'eventId' } - def __init__(self, event_id=None, cluster_node_id=None): + def __init__(self, cluster_node_id=None, event_id=None): """ SubmitReplayRequestEntity - a model defined in Swagger """ - self._event_id = None self._cluster_node_id = None + self._event_id = None - if event_id is not None: - self.event_id = event_id if cluster_node_id is not None: self.cluster_node_id = cluster_node_id - - @property - def event_id(self): - """ - Gets the event_id of this SubmitReplayRequestEntity. - The event identifier - - :return: The event_id of this SubmitReplayRequestEntity. - :rtype: int - """ - return self._event_id - - @event_id.setter - def event_id(self, event_id): - """ - Sets the event_id of this SubmitReplayRequestEntity. - The event identifier - - :param event_id: The event_id of this SubmitReplayRequestEntity. - :type: int - """ - - self._event_id = event_id + if event_id is not None: + self.event_id = event_id @property def cluster_node_id(self): @@ -96,6 +70,29 @@ def cluster_node_id(self, cluster_node_id): self._cluster_node_id = cluster_node_id + @property + def event_id(self): + """ + Gets the event_id of this SubmitReplayRequestEntity. + The event identifier + + :return: The event_id of this SubmitReplayRequestEntity. + :rtype: int + """ + return self._event_id + + @event_id.setter + def event_id(self, event_id): + """ + Sets the event_id of this SubmitReplayRequestEntity. + The event identifier + + :param event_id: The event_id of this SubmitReplayRequestEntity. + :type: int + """ + + self._event_id = event_id + def to_dict(self): """ Returns the model properties as a dict diff --git a/nipyapi/nifi/models/access_token_expiration_entity.py b/nipyapi/nifi/models/supported_mime_types_dto.py similarity index 52% rename from nipyapi/nifi/models/access_token_expiration_entity.py rename to nipyapi/nifi/models/supported_mime_types_dto.py index f6df931c..d1b87b0f 100644 --- a/nipyapi/nifi/models/access_token_expiration_entity.py +++ b/nipyapi/nifi/models/supported_mime_types_dto.py @@ -1,19 +1,18 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re -class AccessTokenExpirationEntity(object): +class SupportedMimeTypesDTO(object): """ NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually. @@ -28,43 +27,71 @@ class AccessTokenExpirationEntity(object): and the value is json key in definition. """ swagger_types = { - 'access_token_expiration': 'AccessTokenExpirationDTO' - } + 'display_name': 'str', +'mime_types': 'list[str]' } attribute_map = { - 'access_token_expiration': 'accessTokenExpiration' - } + 'display_name': 'displayName', +'mime_types': 'mimeTypes' } - def __init__(self, access_token_expiration=None): + def __init__(self, display_name=None, mime_types=None): + """ + SupportedMimeTypesDTO - a model defined in Swagger """ - AccessTokenExpirationEntity - a model defined in Swagger + + self._display_name = None + self._mime_types = None + + if display_name is not None: + self.display_name = display_name + if mime_types is not None: + self.mime_types = mime_types + + @property + def display_name(self): """ + Gets the display_name of this SupportedMimeTypesDTO. + The display name of the mime types. - self._access_token_expiration = None + :return: The display_name of this SupportedMimeTypesDTO. + :rtype: str + """ + return self._display_name + + @display_name.setter + def display_name(self, display_name): + """ + Sets the display_name of this SupportedMimeTypesDTO. + The display name of the mime types. + + :param display_name: The display_name of this SupportedMimeTypesDTO. + :type: str + """ - if access_token_expiration is not None: - self.access_token_expiration = access_token_expiration + self._display_name = display_name @property - def access_token_expiration(self): + def mime_types(self): """ - Gets the access_token_expiration of this AccessTokenExpirationEntity. + Gets the mime_types of this SupportedMimeTypesDTO. + The mime types this Content Viewer supports. - :return: The access_token_expiration of this AccessTokenExpirationEntity. - :rtype: AccessTokenExpirationDTO + :return: The mime_types of this SupportedMimeTypesDTO. + :rtype: list[str] """ - return self._access_token_expiration + return self._mime_types - @access_token_expiration.setter - def access_token_expiration(self, access_token_expiration): + @mime_types.setter + def mime_types(self, mime_types): """ - Sets the access_token_expiration of this AccessTokenExpirationEntity. + Sets the mime_types of this SupportedMimeTypesDTO. + The mime types this Content Viewer supports. - :param access_token_expiration: The access_token_expiration of this AccessTokenExpirationEntity. - :type: AccessTokenExpirationDTO + :param mime_types: The mime_types of this SupportedMimeTypesDTO. + :type: list[str] """ - self._access_token_expiration = access_token_expiration + self._mime_types = mime_types def to_dict(self): """ @@ -108,7 +135,7 @@ def __eq__(self, other): """ Returns true if both objects are equal """ - if not isinstance(other, AccessTokenExpirationEntity): + if not isinstance(other, SupportedMimeTypesDTO): return False return self.__dict__ == other.__dict__ diff --git a/nipyapi/nifi/models/system_diagnostics_dto.py b/nipyapi/nifi/models/system_diagnostics_dto.py index 5f8f4d95..41839941 100644 --- a/nipyapi/nifi/models/system_diagnostics_dto.py +++ b/nipyapi/nifi/models/system_diagnostics_dto.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -29,13 +28,11 @@ class SystemDiagnosticsDTO(object): """ swagger_types = { 'aggregate_snapshot': 'SystemDiagnosticsSnapshotDTO', - 'node_snapshots': 'list[NodeSystemDiagnosticsSnapshotDTO]' - } +'node_snapshots': 'list[NodeSystemDiagnosticsSnapshotDTO]' } attribute_map = { 'aggregate_snapshot': 'aggregateSnapshot', - 'node_snapshots': 'nodeSnapshots' - } +'node_snapshots': 'nodeSnapshots' } def __init__(self, aggregate_snapshot=None, node_snapshots=None): """ @@ -54,7 +51,6 @@ def __init__(self, aggregate_snapshot=None, node_snapshots=None): def aggregate_snapshot(self): """ Gets the aggregate_snapshot of this SystemDiagnosticsDTO. - A systems diagnostic snapshot that represents the aggregate values of all nodes in the cluster. If the NiFi instance is a standalone instance, rather than a cluster, this represents the stats of the single instance. :return: The aggregate_snapshot of this SystemDiagnosticsDTO. :rtype: SystemDiagnosticsSnapshotDTO @@ -65,7 +61,6 @@ def aggregate_snapshot(self): def aggregate_snapshot(self, aggregate_snapshot): """ Sets the aggregate_snapshot of this SystemDiagnosticsDTO. - A systems diagnostic snapshot that represents the aggregate values of all nodes in the cluster. If the NiFi instance is a standalone instance, rather than a cluster, this represents the stats of the single instance. :param aggregate_snapshot: The aggregate_snapshot of this SystemDiagnosticsDTO. :type: SystemDiagnosticsSnapshotDTO diff --git a/nipyapi/nifi/models/system_diagnostics_entity.py b/nipyapi/nifi/models/system_diagnostics_entity.py index bfa8620b..60b847b5 100644 --- a/nipyapi/nifi/models/system_diagnostics_entity.py +++ b/nipyapi/nifi/models/system_diagnostics_entity.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,12 +27,10 @@ class SystemDiagnosticsEntity(object): and the value is json key in definition. """ swagger_types = { - 'system_diagnostics': 'SystemDiagnosticsDTO' - } + 'system_diagnostics': 'SystemDiagnosticsDTO' } attribute_map = { - 'system_diagnostics': 'systemDiagnostics' - } + 'system_diagnostics': 'systemDiagnostics' } def __init__(self, system_diagnostics=None): """ diff --git a/nipyapi/nifi/models/system_diagnostics_snapshot_dto.py b/nipyapi/nifi/models/system_diagnostics_snapshot_dto.py index a1f63df6..188050d4 100644 --- a/nipyapi/nifi/models/system_diagnostics_snapshot_dto.py +++ b/nipyapi/nifi/models/system_diagnostics_snapshot_dto.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,254 +27,301 @@ class SystemDiagnosticsSnapshotDTO(object): and the value is json key in definition. """ swagger_types = { - 'total_non_heap': 'str', - 'total_non_heap_bytes': 'int', - 'used_non_heap': 'str', - 'used_non_heap_bytes': 'int', - 'free_non_heap': 'str', - 'free_non_heap_bytes': 'int', - 'max_non_heap': 'str', - 'max_non_heap_bytes': 'int', - 'non_heap_utilization': 'str', - 'total_heap': 'str', - 'total_heap_bytes': 'int', - 'used_heap': 'str', - 'used_heap_bytes': 'int', - 'free_heap': 'str', - 'free_heap_bytes': 'int', - 'max_heap': 'str', - 'max_heap_bytes': 'int', - 'heap_utilization': 'str', 'available_processors': 'int', - 'processor_load_average': 'float', - 'total_threads': 'int', - 'daemon_threads': 'int', - 'uptime': 'str', - 'flow_file_repository_storage_usage': 'StorageUsageDTO', - 'content_repository_storage_usage': 'list[StorageUsageDTO]', - 'provenance_repository_storage_usage': 'list[StorageUsageDTO]', - 'garbage_collection': 'list[GarbageCollectionDTO]', - 'stats_last_refreshed': 'str', - 'version_info': 'VersionInfoDTO' - } +'content_repository_storage_usage': 'list[StorageUsageDTO]', +'daemon_threads': 'int', +'flow_file_repository_storage_usage': 'StorageUsageDTO', +'free_heap': 'str', +'free_heap_bytes': 'int', +'free_non_heap': 'str', +'free_non_heap_bytes': 'int', +'garbage_collection': 'list[GarbageCollectionDTO]', +'heap_utilization': 'str', +'max_heap': 'str', +'max_heap_bytes': 'int', +'max_non_heap': 'str', +'max_non_heap_bytes': 'int', +'non_heap_utilization': 'str', +'processor_load_average': 'float', +'provenance_repository_storage_usage': 'list[StorageUsageDTO]', +'resource_claim_details': 'list[ResourceClaimDetailsDTO]', +'stats_last_refreshed': 'str', +'total_heap': 'str', +'total_heap_bytes': 'int', +'total_non_heap': 'str', +'total_non_heap_bytes': 'int', +'total_threads': 'int', +'uptime': 'str', +'used_heap': 'str', +'used_heap_bytes': 'int', +'used_non_heap': 'str', +'used_non_heap_bytes': 'int', +'version_info': 'VersionInfoDTO' } attribute_map = { - 'total_non_heap': 'totalNonHeap', - 'total_non_heap_bytes': 'totalNonHeapBytes', - 'used_non_heap': 'usedNonHeap', - 'used_non_heap_bytes': 'usedNonHeapBytes', - 'free_non_heap': 'freeNonHeap', - 'free_non_heap_bytes': 'freeNonHeapBytes', - 'max_non_heap': 'maxNonHeap', - 'max_non_heap_bytes': 'maxNonHeapBytes', - 'non_heap_utilization': 'nonHeapUtilization', - 'total_heap': 'totalHeap', - 'total_heap_bytes': 'totalHeapBytes', - 'used_heap': 'usedHeap', - 'used_heap_bytes': 'usedHeapBytes', - 'free_heap': 'freeHeap', - 'free_heap_bytes': 'freeHeapBytes', - 'max_heap': 'maxHeap', - 'max_heap_bytes': 'maxHeapBytes', - 'heap_utilization': 'heapUtilization', 'available_processors': 'availableProcessors', - 'processor_load_average': 'processorLoadAverage', - 'total_threads': 'totalThreads', - 'daemon_threads': 'daemonThreads', - 'uptime': 'uptime', - 'flow_file_repository_storage_usage': 'flowFileRepositoryStorageUsage', - 'content_repository_storage_usage': 'contentRepositoryStorageUsage', - 'provenance_repository_storage_usage': 'provenanceRepositoryStorageUsage', - 'garbage_collection': 'garbageCollection', - 'stats_last_refreshed': 'statsLastRefreshed', - 'version_info': 'versionInfo' - } - - def __init__(self, total_non_heap=None, total_non_heap_bytes=None, used_non_heap=None, used_non_heap_bytes=None, free_non_heap=None, free_non_heap_bytes=None, max_non_heap=None, max_non_heap_bytes=None, non_heap_utilization=None, total_heap=None, total_heap_bytes=None, used_heap=None, used_heap_bytes=None, free_heap=None, free_heap_bytes=None, max_heap=None, max_heap_bytes=None, heap_utilization=None, available_processors=None, processor_load_average=None, total_threads=None, daemon_threads=None, uptime=None, flow_file_repository_storage_usage=None, content_repository_storage_usage=None, provenance_repository_storage_usage=None, garbage_collection=None, stats_last_refreshed=None, version_info=None): +'content_repository_storage_usage': 'contentRepositoryStorageUsage', +'daemon_threads': 'daemonThreads', +'flow_file_repository_storage_usage': 'flowFileRepositoryStorageUsage', +'free_heap': 'freeHeap', +'free_heap_bytes': 'freeHeapBytes', +'free_non_heap': 'freeNonHeap', +'free_non_heap_bytes': 'freeNonHeapBytes', +'garbage_collection': 'garbageCollection', +'heap_utilization': 'heapUtilization', +'max_heap': 'maxHeap', +'max_heap_bytes': 'maxHeapBytes', +'max_non_heap': 'maxNonHeap', +'max_non_heap_bytes': 'maxNonHeapBytes', +'non_heap_utilization': 'nonHeapUtilization', +'processor_load_average': 'processorLoadAverage', +'provenance_repository_storage_usage': 'provenanceRepositoryStorageUsage', +'resource_claim_details': 'resourceClaimDetails', +'stats_last_refreshed': 'statsLastRefreshed', +'total_heap': 'totalHeap', +'total_heap_bytes': 'totalHeapBytes', +'total_non_heap': 'totalNonHeap', +'total_non_heap_bytes': 'totalNonHeapBytes', +'total_threads': 'totalThreads', +'uptime': 'uptime', +'used_heap': 'usedHeap', +'used_heap_bytes': 'usedHeapBytes', +'used_non_heap': 'usedNonHeap', +'used_non_heap_bytes': 'usedNonHeapBytes', +'version_info': 'versionInfo' } + + def __init__(self, available_processors=None, content_repository_storage_usage=None, daemon_threads=None, flow_file_repository_storage_usage=None, free_heap=None, free_heap_bytes=None, free_non_heap=None, free_non_heap_bytes=None, garbage_collection=None, heap_utilization=None, max_heap=None, max_heap_bytes=None, max_non_heap=None, max_non_heap_bytes=None, non_heap_utilization=None, processor_load_average=None, provenance_repository_storage_usage=None, resource_claim_details=None, stats_last_refreshed=None, total_heap=None, total_heap_bytes=None, total_non_heap=None, total_non_heap_bytes=None, total_threads=None, uptime=None, used_heap=None, used_heap_bytes=None, used_non_heap=None, used_non_heap_bytes=None, version_info=None): """ SystemDiagnosticsSnapshotDTO - a model defined in Swagger """ - self._total_non_heap = None - self._total_non_heap_bytes = None - self._used_non_heap = None - self._used_non_heap_bytes = None + self._available_processors = None + self._content_repository_storage_usage = None + self._daemon_threads = None + self._flow_file_repository_storage_usage = None + self._free_heap = None + self._free_heap_bytes = None self._free_non_heap = None self._free_non_heap_bytes = None + self._garbage_collection = None + self._heap_utilization = None + self._max_heap = None + self._max_heap_bytes = None self._max_non_heap = None self._max_non_heap_bytes = None self._non_heap_utilization = None + self._processor_load_average = None + self._provenance_repository_storage_usage = None + self._resource_claim_details = None + self._stats_last_refreshed = None self._total_heap = None self._total_heap_bytes = None - self._used_heap = None - self._used_heap_bytes = None - self._free_heap = None - self._free_heap_bytes = None - self._max_heap = None - self._max_heap_bytes = None - self._heap_utilization = None - self._available_processors = None - self._processor_load_average = None + self._total_non_heap = None + self._total_non_heap_bytes = None self._total_threads = None - self._daemon_threads = None self._uptime = None - self._flow_file_repository_storage_usage = None - self._content_repository_storage_usage = None - self._provenance_repository_storage_usage = None - self._garbage_collection = None - self._stats_last_refreshed = None + self._used_heap = None + self._used_heap_bytes = None + self._used_non_heap = None + self._used_non_heap_bytes = None self._version_info = None - if total_non_heap is not None: - self.total_non_heap = total_non_heap - if total_non_heap_bytes is not None: - self.total_non_heap_bytes = total_non_heap_bytes - if used_non_heap is not None: - self.used_non_heap = used_non_heap - if used_non_heap_bytes is not None: - self.used_non_heap_bytes = used_non_heap_bytes + if available_processors is not None: + self.available_processors = available_processors + if content_repository_storage_usage is not None: + self.content_repository_storage_usage = content_repository_storage_usage + if daemon_threads is not None: + self.daemon_threads = daemon_threads + if flow_file_repository_storage_usage is not None: + self.flow_file_repository_storage_usage = flow_file_repository_storage_usage + if free_heap is not None: + self.free_heap = free_heap + if free_heap_bytes is not None: + self.free_heap_bytes = free_heap_bytes if free_non_heap is not None: self.free_non_heap = free_non_heap if free_non_heap_bytes is not None: self.free_non_heap_bytes = free_non_heap_bytes + if garbage_collection is not None: + self.garbage_collection = garbage_collection + if heap_utilization is not None: + self.heap_utilization = heap_utilization + if max_heap is not None: + self.max_heap = max_heap + if max_heap_bytes is not None: + self.max_heap_bytes = max_heap_bytes if max_non_heap is not None: self.max_non_heap = max_non_heap if max_non_heap_bytes is not None: self.max_non_heap_bytes = max_non_heap_bytes if non_heap_utilization is not None: self.non_heap_utilization = non_heap_utilization + if processor_load_average is not None: + self.processor_load_average = processor_load_average + if provenance_repository_storage_usage is not None: + self.provenance_repository_storage_usage = provenance_repository_storage_usage + if resource_claim_details is not None: + self.resource_claim_details = resource_claim_details + if stats_last_refreshed is not None: + self.stats_last_refreshed = stats_last_refreshed if total_heap is not None: self.total_heap = total_heap if total_heap_bytes is not None: self.total_heap_bytes = total_heap_bytes - if used_heap is not None: - self.used_heap = used_heap - if used_heap_bytes is not None: - self.used_heap_bytes = used_heap_bytes - if free_heap is not None: - self.free_heap = free_heap - if free_heap_bytes is not None: - self.free_heap_bytes = free_heap_bytes - if max_heap is not None: - self.max_heap = max_heap - if max_heap_bytes is not None: - self.max_heap_bytes = max_heap_bytes - if heap_utilization is not None: - self.heap_utilization = heap_utilization - if available_processors is not None: - self.available_processors = available_processors - if processor_load_average is not None: - self.processor_load_average = processor_load_average + if total_non_heap is not None: + self.total_non_heap = total_non_heap + if total_non_heap_bytes is not None: + self.total_non_heap_bytes = total_non_heap_bytes if total_threads is not None: self.total_threads = total_threads - if daemon_threads is not None: - self.daemon_threads = daemon_threads if uptime is not None: self.uptime = uptime - if flow_file_repository_storage_usage is not None: - self.flow_file_repository_storage_usage = flow_file_repository_storage_usage - if content_repository_storage_usage is not None: - self.content_repository_storage_usage = content_repository_storage_usage - if provenance_repository_storage_usage is not None: - self.provenance_repository_storage_usage = provenance_repository_storage_usage - if garbage_collection is not None: - self.garbage_collection = garbage_collection - if stats_last_refreshed is not None: - self.stats_last_refreshed = stats_last_refreshed + if used_heap is not None: + self.used_heap = used_heap + if used_heap_bytes is not None: + self.used_heap_bytes = used_heap_bytes + if used_non_heap is not None: + self.used_non_heap = used_non_heap + if used_non_heap_bytes is not None: + self.used_non_heap_bytes = used_non_heap_bytes if version_info is not None: self.version_info = version_info @property - def total_non_heap(self): + def available_processors(self): """ - Gets the total_non_heap of this SystemDiagnosticsSnapshotDTO. - Total size of non heap. + Gets the available_processors of this SystemDiagnosticsSnapshotDTO. + Number of available processors if supported by the underlying system. - :return: The total_non_heap of this SystemDiagnosticsSnapshotDTO. - :rtype: str + :return: The available_processors of this SystemDiagnosticsSnapshotDTO. + :rtype: int """ - return self._total_non_heap + return self._available_processors - @total_non_heap.setter - def total_non_heap(self, total_non_heap): + @available_processors.setter + def available_processors(self, available_processors): """ - Sets the total_non_heap of this SystemDiagnosticsSnapshotDTO. - Total size of non heap. + Sets the available_processors of this SystemDiagnosticsSnapshotDTO. + Number of available processors if supported by the underlying system. - :param total_non_heap: The total_non_heap of this SystemDiagnosticsSnapshotDTO. - :type: str + :param available_processors: The available_processors of this SystemDiagnosticsSnapshotDTO. + :type: int """ - self._total_non_heap = total_non_heap + self._available_processors = available_processors @property - def total_non_heap_bytes(self): + def content_repository_storage_usage(self): """ - Gets the total_non_heap_bytes of this SystemDiagnosticsSnapshotDTO. - Total number of bytes allocated to the JVM not used for heap + Gets the content_repository_storage_usage of this SystemDiagnosticsSnapshotDTO. + The content repository storage usage. - :return: The total_non_heap_bytes of this SystemDiagnosticsSnapshotDTO. + :return: The content_repository_storage_usage of this SystemDiagnosticsSnapshotDTO. + :rtype: list[StorageUsageDTO] + """ + return self._content_repository_storage_usage + + @content_repository_storage_usage.setter + def content_repository_storage_usage(self, content_repository_storage_usage): + """ + Sets the content_repository_storage_usage of this SystemDiagnosticsSnapshotDTO. + The content repository storage usage. + + :param content_repository_storage_usage: The content_repository_storage_usage of this SystemDiagnosticsSnapshotDTO. + :type: list[StorageUsageDTO] + """ + + self._content_repository_storage_usage = content_repository_storage_usage + + @property + def daemon_threads(self): + """ + Gets the daemon_threads of this SystemDiagnosticsSnapshotDTO. + Number of daemon threads. + + :return: The daemon_threads of this SystemDiagnosticsSnapshotDTO. :rtype: int """ - return self._total_non_heap_bytes + return self._daemon_threads - @total_non_heap_bytes.setter - def total_non_heap_bytes(self, total_non_heap_bytes): + @daemon_threads.setter + def daemon_threads(self, daemon_threads): """ - Sets the total_non_heap_bytes of this SystemDiagnosticsSnapshotDTO. - Total number of bytes allocated to the JVM not used for heap + Sets the daemon_threads of this SystemDiagnosticsSnapshotDTO. + Number of daemon threads. - :param total_non_heap_bytes: The total_non_heap_bytes of this SystemDiagnosticsSnapshotDTO. + :param daemon_threads: The daemon_threads of this SystemDiagnosticsSnapshotDTO. :type: int """ - self._total_non_heap_bytes = total_non_heap_bytes + self._daemon_threads = daemon_threads @property - def used_non_heap(self): + def flow_file_repository_storage_usage(self): """ - Gets the used_non_heap of this SystemDiagnosticsSnapshotDTO. - Amount of use non heap. + Gets the flow_file_repository_storage_usage of this SystemDiagnosticsSnapshotDTO. - :return: The used_non_heap of this SystemDiagnosticsSnapshotDTO. + :return: The flow_file_repository_storage_usage of this SystemDiagnosticsSnapshotDTO. + :rtype: StorageUsageDTO + """ + return self._flow_file_repository_storage_usage + + @flow_file_repository_storage_usage.setter + def flow_file_repository_storage_usage(self, flow_file_repository_storage_usage): + """ + Sets the flow_file_repository_storage_usage of this SystemDiagnosticsSnapshotDTO. + + :param flow_file_repository_storage_usage: The flow_file_repository_storage_usage of this SystemDiagnosticsSnapshotDTO. + :type: StorageUsageDTO + """ + + self._flow_file_repository_storage_usage = flow_file_repository_storage_usage + + @property + def free_heap(self): + """ + Gets the free_heap of this SystemDiagnosticsSnapshotDTO. + Amount of free heap. + + :return: The free_heap of this SystemDiagnosticsSnapshotDTO. :rtype: str """ - return self._used_non_heap + return self._free_heap - @used_non_heap.setter - def used_non_heap(self, used_non_heap): + @free_heap.setter + def free_heap(self, free_heap): """ - Sets the used_non_heap of this SystemDiagnosticsSnapshotDTO. - Amount of use non heap. + Sets the free_heap of this SystemDiagnosticsSnapshotDTO. + Amount of free heap. - :param used_non_heap: The used_non_heap of this SystemDiagnosticsSnapshotDTO. + :param free_heap: The free_heap of this SystemDiagnosticsSnapshotDTO. :type: str """ - self._used_non_heap = used_non_heap + self._free_heap = free_heap @property - def used_non_heap_bytes(self): + def free_heap_bytes(self): """ - Gets the used_non_heap_bytes of this SystemDiagnosticsSnapshotDTO. - Total number of bytes used by the JVM not in the heap space + Gets the free_heap_bytes of this SystemDiagnosticsSnapshotDTO. + The number of bytes that are allocated to the JVM heap but not currently being used - :return: The used_non_heap_bytes of this SystemDiagnosticsSnapshotDTO. + :return: The free_heap_bytes of this SystemDiagnosticsSnapshotDTO. :rtype: int """ - return self._used_non_heap_bytes + return self._free_heap_bytes - @used_non_heap_bytes.setter - def used_non_heap_bytes(self, used_non_heap_bytes): + @free_heap_bytes.setter + def free_heap_bytes(self, free_heap_bytes): """ - Sets the used_non_heap_bytes of this SystemDiagnosticsSnapshotDTO. - Total number of bytes used by the JVM not in the heap space + Sets the free_heap_bytes of this SystemDiagnosticsSnapshotDTO. + The number of bytes that are allocated to the JVM heap but not currently being used - :param used_non_heap_bytes: The used_non_heap_bytes of this SystemDiagnosticsSnapshotDTO. + :param free_heap_bytes: The free_heap_bytes of this SystemDiagnosticsSnapshotDTO. :type: int """ - self._used_non_heap_bytes = used_non_heap_bytes + self._free_heap_bytes = free_heap_bytes @property def free_non_heap(self): @@ -324,11 +370,103 @@ def free_non_heap_bytes(self, free_non_heap_bytes): self._free_non_heap_bytes = free_non_heap_bytes @property - def max_non_heap(self): + def garbage_collection(self): """ - Gets the max_non_heap of this SystemDiagnosticsSnapshotDTO. - Maximum size of non heap. - + Gets the garbage_collection of this SystemDiagnosticsSnapshotDTO. + The garbage collection details. + + :return: The garbage_collection of this SystemDiagnosticsSnapshotDTO. + :rtype: list[GarbageCollectionDTO] + """ + return self._garbage_collection + + @garbage_collection.setter + def garbage_collection(self, garbage_collection): + """ + Sets the garbage_collection of this SystemDiagnosticsSnapshotDTO. + The garbage collection details. + + :param garbage_collection: The garbage_collection of this SystemDiagnosticsSnapshotDTO. + :type: list[GarbageCollectionDTO] + """ + + self._garbage_collection = garbage_collection + + @property + def heap_utilization(self): + """ + Gets the heap_utilization of this SystemDiagnosticsSnapshotDTO. + Utilization of heap. + + :return: The heap_utilization of this SystemDiagnosticsSnapshotDTO. + :rtype: str + """ + return self._heap_utilization + + @heap_utilization.setter + def heap_utilization(self, heap_utilization): + """ + Sets the heap_utilization of this SystemDiagnosticsSnapshotDTO. + Utilization of heap. + + :param heap_utilization: The heap_utilization of this SystemDiagnosticsSnapshotDTO. + :type: str + """ + + self._heap_utilization = heap_utilization + + @property + def max_heap(self): + """ + Gets the max_heap of this SystemDiagnosticsSnapshotDTO. + Maximum size of heap. + + :return: The max_heap of this SystemDiagnosticsSnapshotDTO. + :rtype: str + """ + return self._max_heap + + @max_heap.setter + def max_heap(self, max_heap): + """ + Sets the max_heap of this SystemDiagnosticsSnapshotDTO. + Maximum size of heap. + + :param max_heap: The max_heap of this SystemDiagnosticsSnapshotDTO. + :type: str + """ + + self._max_heap = max_heap + + @property + def max_heap_bytes(self): + """ + Gets the max_heap_bytes of this SystemDiagnosticsSnapshotDTO. + The maximum number of bytes that can be used by the JVM + + :return: The max_heap_bytes of this SystemDiagnosticsSnapshotDTO. + :rtype: int + """ + return self._max_heap_bytes + + @max_heap_bytes.setter + def max_heap_bytes(self, max_heap_bytes): + """ + Sets the max_heap_bytes of this SystemDiagnosticsSnapshotDTO. + The maximum number of bytes that can be used by the JVM + + :param max_heap_bytes: The max_heap_bytes of this SystemDiagnosticsSnapshotDTO. + :type: int + """ + + self._max_heap_bytes = max_heap_bytes + + @property + def max_non_heap(self): + """ + Gets the max_non_heap of this SystemDiagnosticsSnapshotDTO. + Maximum size of non heap. + :return: The max_non_heap of this SystemDiagnosticsSnapshotDTO. :rtype: str """ @@ -393,257 +531,186 @@ def non_heap_utilization(self, non_heap_utilization): self._non_heap_utilization = non_heap_utilization @property - def total_heap(self): - """ - Gets the total_heap of this SystemDiagnosticsSnapshotDTO. - Total size of heap. - - :return: The total_heap of this SystemDiagnosticsSnapshotDTO. - :rtype: str - """ - return self._total_heap - - @total_heap.setter - def total_heap(self, total_heap): - """ - Sets the total_heap of this SystemDiagnosticsSnapshotDTO. - Total size of heap. - - :param total_heap: The total_heap of this SystemDiagnosticsSnapshotDTO. - :type: str - """ - - self._total_heap = total_heap - - @property - def total_heap_bytes(self): + def processor_load_average(self): """ - Gets the total_heap_bytes of this SystemDiagnosticsSnapshotDTO. - The total number of bytes that are available for the JVM heap to use + Gets the processor_load_average of this SystemDiagnosticsSnapshotDTO. + The processor load average if supported by the underlying system. - :return: The total_heap_bytes of this SystemDiagnosticsSnapshotDTO. - :rtype: int + :return: The processor_load_average of this SystemDiagnosticsSnapshotDTO. + :rtype: float """ - return self._total_heap_bytes + return self._processor_load_average - @total_heap_bytes.setter - def total_heap_bytes(self, total_heap_bytes): + @processor_load_average.setter + def processor_load_average(self, processor_load_average): """ - Sets the total_heap_bytes of this SystemDiagnosticsSnapshotDTO. - The total number of bytes that are available for the JVM heap to use + Sets the processor_load_average of this SystemDiagnosticsSnapshotDTO. + The processor load average if supported by the underlying system. - :param total_heap_bytes: The total_heap_bytes of this SystemDiagnosticsSnapshotDTO. - :type: int + :param processor_load_average: The processor_load_average of this SystemDiagnosticsSnapshotDTO. + :type: float """ - self._total_heap_bytes = total_heap_bytes + self._processor_load_average = processor_load_average @property - def used_heap(self): + def provenance_repository_storage_usage(self): """ - Gets the used_heap of this SystemDiagnosticsSnapshotDTO. - Amount of used heap. + Gets the provenance_repository_storage_usage of this SystemDiagnosticsSnapshotDTO. + The provenance repository storage usage. - :return: The used_heap of this SystemDiagnosticsSnapshotDTO. - :rtype: str + :return: The provenance_repository_storage_usage of this SystemDiagnosticsSnapshotDTO. + :rtype: list[StorageUsageDTO] """ - return self._used_heap + return self._provenance_repository_storage_usage - @used_heap.setter - def used_heap(self, used_heap): + @provenance_repository_storage_usage.setter + def provenance_repository_storage_usage(self, provenance_repository_storage_usage): """ - Sets the used_heap of this SystemDiagnosticsSnapshotDTO. - Amount of used heap. + Sets the provenance_repository_storage_usage of this SystemDiagnosticsSnapshotDTO. + The provenance repository storage usage. - :param used_heap: The used_heap of this SystemDiagnosticsSnapshotDTO. - :type: str + :param provenance_repository_storage_usage: The provenance_repository_storage_usage of this SystemDiagnosticsSnapshotDTO. + :type: list[StorageUsageDTO] """ - self._used_heap = used_heap + self._provenance_repository_storage_usage = provenance_repository_storage_usage @property - def used_heap_bytes(self): + def resource_claim_details(self): """ - Gets the used_heap_bytes of this SystemDiagnosticsSnapshotDTO. - The number of bytes of JVM heap that are currently being used + Gets the resource_claim_details of this SystemDiagnosticsSnapshotDTO. - :return: The used_heap_bytes of this SystemDiagnosticsSnapshotDTO. - :rtype: int + :return: The resource_claim_details of this SystemDiagnosticsSnapshotDTO. + :rtype: list[ResourceClaimDetailsDTO] """ - return self._used_heap_bytes + return self._resource_claim_details - @used_heap_bytes.setter - def used_heap_bytes(self, used_heap_bytes): + @resource_claim_details.setter + def resource_claim_details(self, resource_claim_details): """ - Sets the used_heap_bytes of this SystemDiagnosticsSnapshotDTO. - The number of bytes of JVM heap that are currently being used + Sets the resource_claim_details of this SystemDiagnosticsSnapshotDTO. - :param used_heap_bytes: The used_heap_bytes of this SystemDiagnosticsSnapshotDTO. - :type: int + :param resource_claim_details: The resource_claim_details of this SystemDiagnosticsSnapshotDTO. + :type: list[ResourceClaimDetailsDTO] """ - self._used_heap_bytes = used_heap_bytes + self._resource_claim_details = resource_claim_details @property - def free_heap(self): + def stats_last_refreshed(self): """ - Gets the free_heap of this SystemDiagnosticsSnapshotDTO. - Amount of free heap. + Gets the stats_last_refreshed of this SystemDiagnosticsSnapshotDTO. + When the diagnostics were generated. - :return: The free_heap of this SystemDiagnosticsSnapshotDTO. + :return: The stats_last_refreshed of this SystemDiagnosticsSnapshotDTO. :rtype: str """ - return self._free_heap + return self._stats_last_refreshed - @free_heap.setter - def free_heap(self, free_heap): + @stats_last_refreshed.setter + def stats_last_refreshed(self, stats_last_refreshed): """ - Sets the free_heap of this SystemDiagnosticsSnapshotDTO. - Amount of free heap. + Sets the stats_last_refreshed of this SystemDiagnosticsSnapshotDTO. + When the diagnostics were generated. - :param free_heap: The free_heap of this SystemDiagnosticsSnapshotDTO. + :param stats_last_refreshed: The stats_last_refreshed of this SystemDiagnosticsSnapshotDTO. :type: str """ - self._free_heap = free_heap - - @property - def free_heap_bytes(self): - """ - Gets the free_heap_bytes of this SystemDiagnosticsSnapshotDTO. - The number of bytes that are allocated to the JVM heap but not currently being used - - :return: The free_heap_bytes of this SystemDiagnosticsSnapshotDTO. - :rtype: int - """ - return self._free_heap_bytes - - @free_heap_bytes.setter - def free_heap_bytes(self, free_heap_bytes): - """ - Sets the free_heap_bytes of this SystemDiagnosticsSnapshotDTO. - The number of bytes that are allocated to the JVM heap but not currently being used - - :param free_heap_bytes: The free_heap_bytes of this SystemDiagnosticsSnapshotDTO. - :type: int - """ - - self._free_heap_bytes = free_heap_bytes + self._stats_last_refreshed = stats_last_refreshed @property - def max_heap(self): + def total_heap(self): """ - Gets the max_heap of this SystemDiagnosticsSnapshotDTO. - Maximum size of heap. + Gets the total_heap of this SystemDiagnosticsSnapshotDTO. + Total size of heap. - :return: The max_heap of this SystemDiagnosticsSnapshotDTO. + :return: The total_heap of this SystemDiagnosticsSnapshotDTO. :rtype: str """ - return self._max_heap + return self._total_heap - @max_heap.setter - def max_heap(self, max_heap): + @total_heap.setter + def total_heap(self, total_heap): """ - Sets the max_heap of this SystemDiagnosticsSnapshotDTO. - Maximum size of heap. + Sets the total_heap of this SystemDiagnosticsSnapshotDTO. + Total size of heap. - :param max_heap: The max_heap of this SystemDiagnosticsSnapshotDTO. + :param total_heap: The total_heap of this SystemDiagnosticsSnapshotDTO. :type: str """ - self._max_heap = max_heap + self._total_heap = total_heap @property - def max_heap_bytes(self): + def total_heap_bytes(self): """ - Gets the max_heap_bytes of this SystemDiagnosticsSnapshotDTO. - The maximum number of bytes that can be used by the JVM + Gets the total_heap_bytes of this SystemDiagnosticsSnapshotDTO. + The total number of bytes that are available for the JVM heap to use - :return: The max_heap_bytes of this SystemDiagnosticsSnapshotDTO. + :return: The total_heap_bytes of this SystemDiagnosticsSnapshotDTO. :rtype: int """ - return self._max_heap_bytes + return self._total_heap_bytes - @max_heap_bytes.setter - def max_heap_bytes(self, max_heap_bytes): + @total_heap_bytes.setter + def total_heap_bytes(self, total_heap_bytes): """ - Sets the max_heap_bytes of this SystemDiagnosticsSnapshotDTO. - The maximum number of bytes that can be used by the JVM + Sets the total_heap_bytes of this SystemDiagnosticsSnapshotDTO. + The total number of bytes that are available for the JVM heap to use - :param max_heap_bytes: The max_heap_bytes of this SystemDiagnosticsSnapshotDTO. + :param total_heap_bytes: The total_heap_bytes of this SystemDiagnosticsSnapshotDTO. :type: int """ - self._max_heap_bytes = max_heap_bytes + self._total_heap_bytes = total_heap_bytes @property - def heap_utilization(self): + def total_non_heap(self): """ - Gets the heap_utilization of this SystemDiagnosticsSnapshotDTO. - Utilization of heap. + Gets the total_non_heap of this SystemDiagnosticsSnapshotDTO. + Total size of non heap. - :return: The heap_utilization of this SystemDiagnosticsSnapshotDTO. + :return: The total_non_heap of this SystemDiagnosticsSnapshotDTO. :rtype: str """ - return self._heap_utilization + return self._total_non_heap - @heap_utilization.setter - def heap_utilization(self, heap_utilization): + @total_non_heap.setter + def total_non_heap(self, total_non_heap): """ - Sets the heap_utilization of this SystemDiagnosticsSnapshotDTO. - Utilization of heap. + Sets the total_non_heap of this SystemDiagnosticsSnapshotDTO. + Total size of non heap. - :param heap_utilization: The heap_utilization of this SystemDiagnosticsSnapshotDTO. + :param total_non_heap: The total_non_heap of this SystemDiagnosticsSnapshotDTO. :type: str """ - self._heap_utilization = heap_utilization + self._total_non_heap = total_non_heap @property - def available_processors(self): + def total_non_heap_bytes(self): """ - Gets the available_processors of this SystemDiagnosticsSnapshotDTO. - Number of available processors if supported by the underlying system. + Gets the total_non_heap_bytes of this SystemDiagnosticsSnapshotDTO. + Total number of bytes allocated to the JVM not used for heap - :return: The available_processors of this SystemDiagnosticsSnapshotDTO. + :return: The total_non_heap_bytes of this SystemDiagnosticsSnapshotDTO. :rtype: int """ - return self._available_processors + return self._total_non_heap_bytes - @available_processors.setter - def available_processors(self, available_processors): + @total_non_heap_bytes.setter + def total_non_heap_bytes(self, total_non_heap_bytes): """ - Sets the available_processors of this SystemDiagnosticsSnapshotDTO. - Number of available processors if supported by the underlying system. + Sets the total_non_heap_bytes of this SystemDiagnosticsSnapshotDTO. + Total number of bytes allocated to the JVM not used for heap - :param available_processors: The available_processors of this SystemDiagnosticsSnapshotDTO. + :param total_non_heap_bytes: The total_non_heap_bytes of this SystemDiagnosticsSnapshotDTO. :type: int """ - self._available_processors = available_processors - - @property - def processor_load_average(self): - """ - Gets the processor_load_average of this SystemDiagnosticsSnapshotDTO. - The processor load average if supported by the underlying system. - - :return: The processor_load_average of this SystemDiagnosticsSnapshotDTO. - :rtype: float - """ - return self._processor_load_average - - @processor_load_average.setter - def processor_load_average(self, processor_load_average): - """ - Sets the processor_load_average of this SystemDiagnosticsSnapshotDTO. - The processor load average if supported by the underlying system. - - :param processor_load_average: The processor_load_average of this SystemDiagnosticsSnapshotDTO. - :type: float - """ - - self._processor_load_average = processor_load_average + self._total_non_heap_bytes = total_non_heap_bytes @property def total_threads(self): @@ -668,29 +735,6 @@ def total_threads(self, total_threads): self._total_threads = total_threads - @property - def daemon_threads(self): - """ - Gets the daemon_threads of this SystemDiagnosticsSnapshotDTO. - Number of daemon threads. - - :return: The daemon_threads of this SystemDiagnosticsSnapshotDTO. - :rtype: int - """ - return self._daemon_threads - - @daemon_threads.setter - def daemon_threads(self, daemon_threads): - """ - Sets the daemon_threads of this SystemDiagnosticsSnapshotDTO. - Number of daemon threads. - - :param daemon_threads: The daemon_threads of this SystemDiagnosticsSnapshotDTO. - :type: int - """ - - self._daemon_threads = daemon_threads - @property def uptime(self): """ @@ -715,125 +759,101 @@ def uptime(self, uptime): self._uptime = uptime @property - def flow_file_repository_storage_usage(self): - """ - Gets the flow_file_repository_storage_usage of this SystemDiagnosticsSnapshotDTO. - The flowfile repository storage usage. - - :return: The flow_file_repository_storage_usage of this SystemDiagnosticsSnapshotDTO. - :rtype: StorageUsageDTO - """ - return self._flow_file_repository_storage_usage - - @flow_file_repository_storage_usage.setter - def flow_file_repository_storage_usage(self, flow_file_repository_storage_usage): - """ - Sets the flow_file_repository_storage_usage of this SystemDiagnosticsSnapshotDTO. - The flowfile repository storage usage. - - :param flow_file_repository_storage_usage: The flow_file_repository_storage_usage of this SystemDiagnosticsSnapshotDTO. - :type: StorageUsageDTO - """ - - self._flow_file_repository_storage_usage = flow_file_repository_storage_usage - - @property - def content_repository_storage_usage(self): + def used_heap(self): """ - Gets the content_repository_storage_usage of this SystemDiagnosticsSnapshotDTO. - The content repository storage usage. + Gets the used_heap of this SystemDiagnosticsSnapshotDTO. + Amount of used heap. - :return: The content_repository_storage_usage of this SystemDiagnosticsSnapshotDTO. - :rtype: list[StorageUsageDTO] + :return: The used_heap of this SystemDiagnosticsSnapshotDTO. + :rtype: str """ - return self._content_repository_storage_usage + return self._used_heap - @content_repository_storage_usage.setter - def content_repository_storage_usage(self, content_repository_storage_usage): + @used_heap.setter + def used_heap(self, used_heap): """ - Sets the content_repository_storage_usage of this SystemDiagnosticsSnapshotDTO. - The content repository storage usage. + Sets the used_heap of this SystemDiagnosticsSnapshotDTO. + Amount of used heap. - :param content_repository_storage_usage: The content_repository_storage_usage of this SystemDiagnosticsSnapshotDTO. - :type: list[StorageUsageDTO] + :param used_heap: The used_heap of this SystemDiagnosticsSnapshotDTO. + :type: str """ - self._content_repository_storage_usage = content_repository_storage_usage + self._used_heap = used_heap @property - def provenance_repository_storage_usage(self): + def used_heap_bytes(self): """ - Gets the provenance_repository_storage_usage of this SystemDiagnosticsSnapshotDTO. - The provenance repository storage usage. + Gets the used_heap_bytes of this SystemDiagnosticsSnapshotDTO. + The number of bytes of JVM heap that are currently being used - :return: The provenance_repository_storage_usage of this SystemDiagnosticsSnapshotDTO. - :rtype: list[StorageUsageDTO] + :return: The used_heap_bytes of this SystemDiagnosticsSnapshotDTO. + :rtype: int """ - return self._provenance_repository_storage_usage + return self._used_heap_bytes - @provenance_repository_storage_usage.setter - def provenance_repository_storage_usage(self, provenance_repository_storage_usage): + @used_heap_bytes.setter + def used_heap_bytes(self, used_heap_bytes): """ - Sets the provenance_repository_storage_usage of this SystemDiagnosticsSnapshotDTO. - The provenance repository storage usage. + Sets the used_heap_bytes of this SystemDiagnosticsSnapshotDTO. + The number of bytes of JVM heap that are currently being used - :param provenance_repository_storage_usage: The provenance_repository_storage_usage of this SystemDiagnosticsSnapshotDTO. - :type: list[StorageUsageDTO] + :param used_heap_bytes: The used_heap_bytes of this SystemDiagnosticsSnapshotDTO. + :type: int """ - self._provenance_repository_storage_usage = provenance_repository_storage_usage + self._used_heap_bytes = used_heap_bytes @property - def garbage_collection(self): + def used_non_heap(self): """ - Gets the garbage_collection of this SystemDiagnosticsSnapshotDTO. - The garbage collection details. + Gets the used_non_heap of this SystemDiagnosticsSnapshotDTO. + Amount of use non heap. - :return: The garbage_collection of this SystemDiagnosticsSnapshotDTO. - :rtype: list[GarbageCollectionDTO] + :return: The used_non_heap of this SystemDiagnosticsSnapshotDTO. + :rtype: str """ - return self._garbage_collection + return self._used_non_heap - @garbage_collection.setter - def garbage_collection(self, garbage_collection): + @used_non_heap.setter + def used_non_heap(self, used_non_heap): """ - Sets the garbage_collection of this SystemDiagnosticsSnapshotDTO. - The garbage collection details. + Sets the used_non_heap of this SystemDiagnosticsSnapshotDTO. + Amount of use non heap. - :param garbage_collection: The garbage_collection of this SystemDiagnosticsSnapshotDTO. - :type: list[GarbageCollectionDTO] + :param used_non_heap: The used_non_heap of this SystemDiagnosticsSnapshotDTO. + :type: str """ - self._garbage_collection = garbage_collection + self._used_non_heap = used_non_heap @property - def stats_last_refreshed(self): + def used_non_heap_bytes(self): """ - Gets the stats_last_refreshed of this SystemDiagnosticsSnapshotDTO. - When the diagnostics were generated. + Gets the used_non_heap_bytes of this SystemDiagnosticsSnapshotDTO. + Total number of bytes used by the JVM not in the heap space - :return: The stats_last_refreshed of this SystemDiagnosticsSnapshotDTO. - :rtype: str + :return: The used_non_heap_bytes of this SystemDiagnosticsSnapshotDTO. + :rtype: int """ - return self._stats_last_refreshed + return self._used_non_heap_bytes - @stats_last_refreshed.setter - def stats_last_refreshed(self, stats_last_refreshed): + @used_non_heap_bytes.setter + def used_non_heap_bytes(self, used_non_heap_bytes): """ - Sets the stats_last_refreshed of this SystemDiagnosticsSnapshotDTO. - When the diagnostics were generated. + Sets the used_non_heap_bytes of this SystemDiagnosticsSnapshotDTO. + Total number of bytes used by the JVM not in the heap space - :param stats_last_refreshed: The stats_last_refreshed of this SystemDiagnosticsSnapshotDTO. - :type: str + :param used_non_heap_bytes: The used_non_heap_bytes of this SystemDiagnosticsSnapshotDTO. + :type: int """ - self._stats_last_refreshed = stats_last_refreshed + self._used_non_heap_bytes = used_non_heap_bytes @property def version_info(self): """ Gets the version_info of this SystemDiagnosticsSnapshotDTO. - The nifi, os, java, and build version information :return: The version_info of this SystemDiagnosticsSnapshotDTO. :rtype: VersionInfoDTO @@ -844,7 +864,6 @@ def version_info(self): def version_info(self, version_info): """ Sets the version_info of this SystemDiagnosticsSnapshotDTO. - The nifi, os, java, and build version information :param version_info: The version_info of this SystemDiagnosticsSnapshotDTO. :type: VersionInfoDTO diff --git a/nipyapi/nifi/models/system_resource_consideration.py b/nipyapi/nifi/models/system_resource_consideration.py index 420c2670..5252a82a 100644 --- a/nipyapi/nifi/models/system_resource_consideration.py +++ b/nipyapi/nifi/models/system_resource_consideration.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,73 +27,71 @@ class SystemResourceConsideration(object): and the value is json key in definition. """ swagger_types = { - 'resource': 'str', - 'description': 'str' - } + 'description': 'str', +'resource': 'str' } attribute_map = { - 'resource': 'resource', - 'description': 'description' - } + 'description': 'description', +'resource': 'resource' } - def __init__(self, resource=None, description=None): + def __init__(self, description=None, resource=None): """ SystemResourceConsideration - a model defined in Swagger """ - self._resource = None self._description = None + self._resource = None - if resource is not None: - self.resource = resource if description is not None: self.description = description + if resource is not None: + self.resource = resource @property - def resource(self): + def description(self): """ - Gets the resource of this SystemResourceConsideration. - The resource to consider + Gets the description of this SystemResourceConsideration. + The description of how the resource is affected - :return: The resource of this SystemResourceConsideration. + :return: The description of this SystemResourceConsideration. :rtype: str """ - return self._resource + return self._description - @resource.setter - def resource(self, resource): + @description.setter + def description(self, description): """ - Sets the resource of this SystemResourceConsideration. - The resource to consider + Sets the description of this SystemResourceConsideration. + The description of how the resource is affected - :param resource: The resource of this SystemResourceConsideration. + :param description: The description of this SystemResourceConsideration. :type: str """ - self._resource = resource + self._description = description @property - def description(self): + def resource(self): """ - Gets the description of this SystemResourceConsideration. - The description of how the resource is affected + Gets the resource of this SystemResourceConsideration. + The resource to consider - :return: The description of this SystemResourceConsideration. + :return: The resource of this SystemResourceConsideration. :rtype: str """ - return self._description + return self._resource - @description.setter - def description(self, description): + @resource.setter + def resource(self, resource): """ - Sets the description of this SystemResourceConsideration. - The description of how the resource is affected + Sets the resource of this SystemResourceConsideration. + The resource to consider - :param description: The description of this SystemResourceConsideration. + :param resource: The resource of this SystemResourceConsideration. :type: str """ - self._description = description + self._resource = resource def to_dict(self): """ diff --git a/nipyapi/nifi/models/template_dto.py b/nipyapi/nifi/models/template_dto.py deleted file mode 100644 index f5688d02..00000000 --- a/nipyapi/nifi/models/template_dto.py +++ /dev/null @@ -1,318 +0,0 @@ -""" - NiFi Rest API - - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - - OpenAPI spec version: 1.28.1 - Contact: dev@nifi.apache.org - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - - -from pprint import pformat -import re - - -class TemplateDTO(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 = { - 'uri': 'str', - 'id': 'str', - 'group_id': 'str', - 'name': 'str', - 'description': 'str', - 'timestamp': 'str', - 'encoding_version': 'str', - 'snippet': 'FlowSnippetDTO' - } - - attribute_map = { - 'uri': 'uri', - 'id': 'id', - 'group_id': 'groupId', - 'name': 'name', - 'description': 'description', - 'timestamp': 'timestamp', - 'encoding_version': 'encodingVersion', - 'snippet': 'snippet' - } - - def __init__(self, uri=None, id=None, group_id=None, name=None, description=None, timestamp=None, encoding_version=None, snippet=None): - """ - TemplateDTO - a model defined in Swagger - """ - - self._uri = None - self._id = None - self._group_id = None - self._name = None - self._description = None - self._timestamp = None - self._encoding_version = None - self._snippet = None - - if uri is not None: - self.uri = uri - if id is not None: - self.id = id - if group_id is not None: - self.group_id = group_id - if name is not None: - self.name = name - if description is not None: - self.description = description - if timestamp is not None: - self.timestamp = timestamp - if encoding_version is not None: - self.encoding_version = encoding_version - if snippet is not None: - self.snippet = snippet - - @property - def uri(self): - """ - Gets the uri of this TemplateDTO. - The URI for the template. - - :return: The uri of this TemplateDTO. - :rtype: str - """ - return self._uri - - @uri.setter - def uri(self, uri): - """ - Sets the uri of this TemplateDTO. - The URI for the template. - - :param uri: The uri of this TemplateDTO. - :type: str - """ - - self._uri = uri - - @property - def id(self): - """ - Gets the id of this TemplateDTO. - The id of the template. - - :return: The id of this TemplateDTO. - :rtype: str - """ - return self._id - - @id.setter - def id(self, id): - """ - Sets the id of this TemplateDTO. - The id of the template. - - :param id: The id of this TemplateDTO. - :type: str - """ - - self._id = id - - @property - def group_id(self): - """ - Gets the group_id of this TemplateDTO. - The id of the Process Group that the template belongs to. - - :return: The group_id of this TemplateDTO. - :rtype: str - """ - return self._group_id - - @group_id.setter - def group_id(self, group_id): - """ - Sets the group_id of this TemplateDTO. - The id of the Process Group that the template belongs to. - - :param group_id: The group_id of this TemplateDTO. - :type: str - """ - - self._group_id = group_id - - @property - def name(self): - """ - Gets the name of this TemplateDTO. - The name of the template. - - :return: The name of this TemplateDTO. - :rtype: str - """ - return self._name - - @name.setter - def name(self, name): - """ - Sets the name of this TemplateDTO. - The name of the template. - - :param name: The name of this TemplateDTO. - :type: str - """ - - self._name = name - - @property - def description(self): - """ - Gets the description of this TemplateDTO. - The description of the template. - - :return: The description of this TemplateDTO. - :rtype: str - """ - return self._description - - @description.setter - def description(self, description): - """ - Sets the description of this TemplateDTO. - The description of the template. - - :param description: The description of this TemplateDTO. - :type: str - """ - - self._description = description - - @property - def timestamp(self): - """ - Gets the timestamp of this TemplateDTO. - The timestamp when this template was created. - - :return: The timestamp of this TemplateDTO. - :rtype: str - """ - return self._timestamp - - @timestamp.setter - def timestamp(self, timestamp): - """ - Sets the timestamp of this TemplateDTO. - The timestamp when this template was created. - - :param timestamp: The timestamp of this TemplateDTO. - :type: str - """ - - self._timestamp = timestamp - - @property - def encoding_version(self): - """ - Gets the encoding_version of this TemplateDTO. - The encoding version of this template. - - :return: The encoding_version of this TemplateDTO. - :rtype: str - """ - return self._encoding_version - - @encoding_version.setter - def encoding_version(self, encoding_version): - """ - Sets the encoding_version of this TemplateDTO. - The encoding version of this template. - - :param encoding_version: The encoding_version of this TemplateDTO. - :type: str - """ - - self._encoding_version = encoding_version - - @property - def snippet(self): - """ - Gets the snippet of this TemplateDTO. - The contents of the template. - - :return: The snippet of this TemplateDTO. - :rtype: FlowSnippetDTO - """ - return self._snippet - - @snippet.setter - def snippet(self, snippet): - """ - Sets the snippet of this TemplateDTO. - The contents of the template. - - :param snippet: The snippet of this TemplateDTO. - :type: FlowSnippetDTO - """ - - self._snippet = snippet - - 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, TemplateDTO): - 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/template_entity.py b/nipyapi/nifi/models/template_entity.py deleted file mode 100644 index cd80b239..00000000 --- a/nipyapi/nifi/models/template_entity.py +++ /dev/null @@ -1,316 +0,0 @@ -""" - NiFi Rest API - - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - - OpenAPI spec version: 1.28.1 - Contact: dev@nifi.apache.org - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - - -from pprint import pformat -import re - - -class TemplateEntity(object): - """ - NOTE: This class is auto generated by the swagger code generator program. - Do not edit the class manually. - """ - - - """ - Attributes: - swagger_types (dict): The key is attribute name - and the value is attribute type. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - """ - swagger_types = { - 'revision': 'RevisionDTO', - 'id': 'str', - 'uri': 'str', - 'position': 'PositionDTO', - 'permissions': 'PermissionsDTO', - 'bulletins': 'list[BulletinEntity]', - 'disconnected_node_acknowledged': 'bool', - 'template': 'TemplateDTO' - } - - attribute_map = { - 'revision': 'revision', - 'id': 'id', - 'uri': 'uri', - 'position': 'position', - 'permissions': 'permissions', - 'bulletins': 'bulletins', - 'disconnected_node_acknowledged': 'disconnectedNodeAcknowledged', - 'template': 'template' - } - - def __init__(self, revision=None, id=None, uri=None, position=None, permissions=None, bulletins=None, disconnected_node_acknowledged=None, template=None): - """ - TemplateEntity - a model defined in Swagger - """ - - self._revision = None - self._id = None - self._uri = None - self._position = None - self._permissions = None - self._bulletins = None - self._disconnected_node_acknowledged = None - self._template = None - - if revision is not None: - self.revision = revision - if id is not None: - self.id = id - if uri is not None: - self.uri = uri - if position is not None: - self.position = position - if permissions is not None: - self.permissions = permissions - if bulletins is not None: - self.bulletins = bulletins - if disconnected_node_acknowledged is not None: - self.disconnected_node_acknowledged = disconnected_node_acknowledged - if template is not None: - self.template = template - - @property - def revision(self): - """ - Gets the revision of this TemplateEntity. - The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses. - - :return: The revision of this TemplateEntity. - :rtype: RevisionDTO - """ - return self._revision - - @revision.setter - def revision(self, revision): - """ - Sets the revision of this TemplateEntity. - The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses. - - :param revision: The revision of this TemplateEntity. - :type: RevisionDTO - """ - - self._revision = revision - - @property - def id(self): - """ - Gets the id of this TemplateEntity. - The id of the component. - - :return: The id of this TemplateEntity. - :rtype: str - """ - return self._id - - @id.setter - def id(self, id): - """ - Sets the id of this TemplateEntity. - The id of the component. - - :param id: The id of this TemplateEntity. - :type: str - """ - - self._id = id - - @property - def uri(self): - """ - Gets the uri of this TemplateEntity. - The URI for futures requests to the component. - - :return: The uri of this TemplateEntity. - :rtype: str - """ - return self._uri - - @uri.setter - def uri(self, uri): - """ - Sets the uri of this TemplateEntity. - The URI for futures requests to the component. - - :param uri: The uri of this TemplateEntity. - :type: str - """ - - self._uri = uri - - @property - def position(self): - """ - Gets the position of this TemplateEntity. - The position of this component in the UI if applicable. - - :return: The position of this TemplateEntity. - :rtype: PositionDTO - """ - return self._position - - @position.setter - def position(self, position): - """ - Sets the position of this TemplateEntity. - The position of this component in the UI if applicable. - - :param position: The position of this TemplateEntity. - :type: PositionDTO - """ - - self._position = position - - @property - def permissions(self): - """ - Gets the permissions of this TemplateEntity. - The permissions for this component. - - :return: The permissions of this TemplateEntity. - :rtype: PermissionsDTO - """ - return self._permissions - - @permissions.setter - def permissions(self, permissions): - """ - Sets the permissions of this TemplateEntity. - The permissions for this component. - - :param permissions: The permissions of this TemplateEntity. - :type: PermissionsDTO - """ - - self._permissions = permissions - - @property - def bulletins(self): - """ - Gets the bulletins of this TemplateEntity. - The bulletins for this component. - - :return: The bulletins of this TemplateEntity. - :rtype: list[BulletinEntity] - """ - return self._bulletins - - @bulletins.setter - def bulletins(self, bulletins): - """ - Sets the bulletins of this TemplateEntity. - The bulletins for this component. - - :param bulletins: The bulletins of this TemplateEntity. - :type: list[BulletinEntity] - """ - - self._bulletins = bulletins - - @property - def disconnected_node_acknowledged(self): - """ - Gets the disconnected_node_acknowledged of this TemplateEntity. - Acknowledges that this node is disconnected to allow for mutable requests to proceed. - - :return: The disconnected_node_acknowledged of this TemplateEntity. - :rtype: bool - """ - return self._disconnected_node_acknowledged - - @disconnected_node_acknowledged.setter - def disconnected_node_acknowledged(self, disconnected_node_acknowledged): - """ - Sets the disconnected_node_acknowledged of this TemplateEntity. - Acknowledges that this node is disconnected to allow for mutable requests to proceed. - - :param disconnected_node_acknowledged: The disconnected_node_acknowledged of this TemplateEntity. - :type: bool - """ - - self._disconnected_node_acknowledged = disconnected_node_acknowledged - - @property - def template(self): - """ - Gets the template of this TemplateEntity. - - :return: The template of this TemplateEntity. - :rtype: TemplateDTO - """ - return self._template - - @template.setter - def template(self, template): - """ - Sets the template of this TemplateEntity. - - :param template: The template of this TemplateEntity. - :type: TemplateDTO - """ - - self._template = template - - 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, TemplateEntity): - 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/tenant_dto.py b/nipyapi/nifi/models/tenant_dto.py index 33ba4095..8b1300af 100644 --- a/nipyapi/nifi/models/tenant_dto.py +++ b/nipyapi/nifi/models/tenant_dto.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,47 +27,68 @@ class TenantDTO(object): and the value is json key in definition. """ swagger_types = { - 'id': 'str', - 'versioned_component_id': 'str', - 'parent_group_id': 'str', - 'position': 'PositionDTO', - 'identity': 'str', - 'configurable': 'bool' - } + 'configurable': 'bool', +'id': 'str', +'identity': 'str', +'parent_group_id': 'str', +'position': 'PositionDTO', +'versioned_component_id': 'str' } attribute_map = { - 'id': 'id', - 'versioned_component_id': 'versionedComponentId', - 'parent_group_id': 'parentGroupId', - 'position': 'position', - 'identity': 'identity', - 'configurable': 'configurable' - } + 'configurable': 'configurable', +'id': 'id', +'identity': 'identity', +'parent_group_id': 'parentGroupId', +'position': 'position', +'versioned_component_id': 'versionedComponentId' } - def __init__(self, id=None, versioned_component_id=None, parent_group_id=None, position=None, identity=None, configurable=None): + def __init__(self, configurable=None, id=None, identity=None, parent_group_id=None, position=None, versioned_component_id=None): """ TenantDTO - a model defined in Swagger """ + self._configurable = None self._id = None - self._versioned_component_id = None + self._identity = None self._parent_group_id = None self._position = None - self._identity = None - self._configurable = None + self._versioned_component_id = None + if configurable is not None: + self.configurable = configurable if id is not None: self.id = id - if versioned_component_id is not None: - self.versioned_component_id = versioned_component_id + if identity is not None: + self.identity = identity if parent_group_id is not None: self.parent_group_id = parent_group_id if position is not None: self.position = position - if identity is not None: - self.identity = identity - if configurable is not None: - self.configurable = configurable + if versioned_component_id is not None: + self.versioned_component_id = versioned_component_id + + @property + def configurable(self): + """ + Gets the configurable of this TenantDTO. + Whether this tenant is configurable. + + :return: The configurable of this TenantDTO. + :rtype: bool + """ + return self._configurable + + @configurable.setter + def configurable(self, configurable): + """ + Sets the configurable of this TenantDTO. + Whether this tenant is configurable. + + :param configurable: The configurable of this TenantDTO. + :type: bool + """ + + self._configurable = configurable @property def id(self): @@ -94,27 +114,27 @@ def id(self, id): self._id = id @property - def versioned_component_id(self): + def identity(self): """ - Gets the versioned_component_id of this TenantDTO. - The ID of the corresponding component that is under version control + Gets the identity of this TenantDTO. + The identity of the tenant. - :return: The versioned_component_id of this TenantDTO. + :return: The identity of this TenantDTO. :rtype: str """ - return self._versioned_component_id + return self._identity - @versioned_component_id.setter - def versioned_component_id(self, versioned_component_id): + @identity.setter + def identity(self, identity): """ - Sets the versioned_component_id of this TenantDTO. - The ID of the corresponding component that is under version control + Sets the identity of this TenantDTO. + The identity of the tenant. - :param versioned_component_id: The versioned_component_id of this TenantDTO. + :param identity: The identity of this TenantDTO. :type: str """ - self._versioned_component_id = versioned_component_id + self._identity = identity @property def parent_group_id(self): @@ -143,7 +163,6 @@ def parent_group_id(self, parent_group_id): def position(self): """ Gets the position of this TenantDTO. - The position of this component in the UI if applicable. :return: The position of this TenantDTO. :rtype: PositionDTO @@ -154,7 +173,6 @@ def position(self): def position(self, position): """ Sets the position of this TenantDTO. - The position of this component in the UI if applicable. :param position: The position of this TenantDTO. :type: PositionDTO @@ -163,50 +181,27 @@ def position(self, position): self._position = position @property - def identity(self): + def versioned_component_id(self): """ - Gets the identity of this TenantDTO. - The identity of the tenant. + Gets the versioned_component_id of this TenantDTO. + The ID of the corresponding component that is under version control - :return: The identity of this TenantDTO. + :return: The versioned_component_id of this TenantDTO. :rtype: str """ - return self._identity + return self._versioned_component_id - @identity.setter - def identity(self, identity): + @versioned_component_id.setter + def versioned_component_id(self, versioned_component_id): """ - Sets the identity of this TenantDTO. - The identity of the tenant. + Sets the versioned_component_id of this TenantDTO. + The ID of the corresponding component that is under version control - :param identity: The identity of this TenantDTO. + :param versioned_component_id: The versioned_component_id of this TenantDTO. :type: str """ - self._identity = identity - - @property - def configurable(self): - """ - Gets the configurable of this TenantDTO. - Whether this tenant is configurable. - - :return: The configurable of this TenantDTO. - :rtype: bool - """ - return self._configurable - - @configurable.setter - def configurable(self, configurable): - """ - Sets the configurable of this TenantDTO. - Whether this tenant is configurable. - - :param configurable: The configurable of this TenantDTO. - :type: bool - """ - - self._configurable = configurable + self._versioned_component_id = versioned_component_id def to_dict(self): """ diff --git a/nipyapi/nifi/models/tenant_entity.py b/nipyapi/nifi/models/tenant_entity.py index dc0c9294..fd0a01d2 100644 --- a/nipyapi/nifi/models/tenant_entity.py +++ b/nipyapi/nifi/models/tenant_entity.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,155 +27,150 @@ class TenantEntity(object): and the value is json key in definition. """ swagger_types = { - 'revision': 'RevisionDTO', - 'id': 'str', - 'uri': 'str', - 'position': 'PositionDTO', - 'permissions': 'PermissionsDTO', 'bulletins': 'list[BulletinEntity]', - 'disconnected_node_acknowledged': 'bool', - 'component': 'TenantDTO' - } +'component': 'TenantDTO', +'disconnected_node_acknowledged': 'bool', +'id': 'str', +'permissions': 'PermissionsDTO', +'position': 'PositionDTO', +'revision': 'RevisionDTO', +'uri': 'str' } attribute_map = { - 'revision': 'revision', - 'id': 'id', - 'uri': 'uri', - 'position': 'position', - 'permissions': 'permissions', 'bulletins': 'bulletins', - 'disconnected_node_acknowledged': 'disconnectedNodeAcknowledged', - 'component': 'component' - } +'component': 'component', +'disconnected_node_acknowledged': 'disconnectedNodeAcknowledged', +'id': 'id', +'permissions': 'permissions', +'position': 'position', +'revision': 'revision', +'uri': 'uri' } - def __init__(self, revision=None, id=None, uri=None, position=None, permissions=None, bulletins=None, disconnected_node_acknowledged=None, component=None): + def __init__(self, bulletins=None, component=None, disconnected_node_acknowledged=None, id=None, permissions=None, position=None, revision=None, uri=None): """ TenantEntity - a model defined in Swagger """ - self._revision = None - self._id = None - self._uri = None - self._position = None - self._permissions = None self._bulletins = None - self._disconnected_node_acknowledged = None self._component = None + self._disconnected_node_acknowledged = None + self._id = None + self._permissions = None + self._position = None + self._revision = None + self._uri = None - if revision is not None: - self.revision = revision - if id is not None: - self.id = id - if uri is not None: - self.uri = uri - if position is not None: - self.position = position - if permissions is not None: - self.permissions = permissions if bulletins is not None: self.bulletins = bulletins - if disconnected_node_acknowledged is not None: - self.disconnected_node_acknowledged = disconnected_node_acknowledged if component is not None: self.component = component + if disconnected_node_acknowledged is not None: + self.disconnected_node_acknowledged = disconnected_node_acknowledged + if id is not None: + self.id = id + if permissions is not None: + self.permissions = permissions + if position is not None: + self.position = position + if revision is not None: + self.revision = revision + if uri is not None: + self.uri = uri @property - def revision(self): + def bulletins(self): """ - Gets the revision of this TenantEntity. - The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses. + Gets the bulletins of this TenantEntity. + The bulletins for this component. - :return: The revision of this TenantEntity. - :rtype: RevisionDTO + :return: The bulletins of this TenantEntity. + :rtype: list[BulletinEntity] """ - return self._revision + return self._bulletins - @revision.setter - def revision(self, revision): + @bulletins.setter + def bulletins(self, bulletins): """ - Sets the revision of this TenantEntity. - The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses. + Sets the bulletins of this TenantEntity. + The bulletins for this component. - :param revision: The revision of this TenantEntity. - :type: RevisionDTO + :param bulletins: The bulletins of this TenantEntity. + :type: list[BulletinEntity] """ - self._revision = revision + self._bulletins = bulletins @property - def id(self): + def component(self): """ - Gets the id of this TenantEntity. - The id of the component. + Gets the component of this TenantEntity. - :return: The id of this TenantEntity. - :rtype: str + :return: The component of this TenantEntity. + :rtype: TenantDTO """ - return self._id + return self._component - @id.setter - def id(self, id): + @component.setter + def component(self, component): """ - Sets the id of this TenantEntity. - The id of the component. + Sets the component of this TenantEntity. - :param id: The id of this TenantEntity. - :type: str + :param component: The component of this TenantEntity. + :type: TenantDTO """ - self._id = id + self._component = component @property - def uri(self): + def disconnected_node_acknowledged(self): """ - Gets the uri of this TenantEntity. - The URI for futures requests to the component. + Gets the disconnected_node_acknowledged of this TenantEntity. + Acknowledges that this node is disconnected to allow for mutable requests to proceed. - :return: The uri of this TenantEntity. - :rtype: str + :return: The disconnected_node_acknowledged of this TenantEntity. + :rtype: bool """ - return self._uri + return self._disconnected_node_acknowledged - @uri.setter - def uri(self, uri): + @disconnected_node_acknowledged.setter + def disconnected_node_acknowledged(self, disconnected_node_acknowledged): """ - Sets the uri of this TenantEntity. - The URI for futures requests to the component. + Sets the disconnected_node_acknowledged of this TenantEntity. + Acknowledges that this node is disconnected to allow for mutable requests to proceed. - :param uri: The uri of this TenantEntity. - :type: str + :param disconnected_node_acknowledged: The disconnected_node_acknowledged of this TenantEntity. + :type: bool """ - self._uri = uri + self._disconnected_node_acknowledged = disconnected_node_acknowledged @property - def position(self): + def id(self): """ - Gets the position of this TenantEntity. - The position of this component in the UI if applicable. + Gets the id of this TenantEntity. + The id of the component. - :return: The position of this TenantEntity. - :rtype: PositionDTO + :return: The id of this TenantEntity. + :rtype: str """ - return self._position + return self._id - @position.setter - def position(self, position): + @id.setter + def id(self, id): """ - Sets the position of this TenantEntity. - The position of this component in the UI if applicable. + Sets the id of this TenantEntity. + The id of the component. - :param position: The position of this TenantEntity. - :type: PositionDTO + :param id: The id of this TenantEntity. + :type: str """ - self._position = position + self._id = id @property def permissions(self): """ Gets the permissions of this TenantEntity. - The permissions for this component. :return: The permissions of this TenantEntity. :rtype: PermissionsDTO @@ -187,7 +181,6 @@ def permissions(self): def permissions(self, permissions): """ Sets the permissions of this TenantEntity. - The permissions for this component. :param permissions: The permissions of this TenantEntity. :type: PermissionsDTO @@ -196,71 +189,69 @@ def permissions(self, permissions): self._permissions = permissions @property - def bulletins(self): + def position(self): """ - Gets the bulletins of this TenantEntity. - The bulletins for this component. + Gets the position of this TenantEntity. - :return: The bulletins of this TenantEntity. - :rtype: list[BulletinEntity] + :return: The position of this TenantEntity. + :rtype: PositionDTO """ - return self._bulletins + return self._position - @bulletins.setter - def bulletins(self, bulletins): + @position.setter + def position(self, position): """ - Sets the bulletins of this TenantEntity. - The bulletins for this component. + Sets the position of this TenantEntity. - :param bulletins: The bulletins of this TenantEntity. - :type: list[BulletinEntity] + :param position: The position of this TenantEntity. + :type: PositionDTO """ - self._bulletins = bulletins + self._position = position @property - def disconnected_node_acknowledged(self): + def revision(self): """ - Gets the disconnected_node_acknowledged of this TenantEntity. - Acknowledges that this node is disconnected to allow for mutable requests to proceed. + Gets the revision of this TenantEntity. - :return: The disconnected_node_acknowledged of this TenantEntity. - :rtype: bool + :return: The revision of this TenantEntity. + :rtype: RevisionDTO """ - return self._disconnected_node_acknowledged + return self._revision - @disconnected_node_acknowledged.setter - def disconnected_node_acknowledged(self, disconnected_node_acknowledged): + @revision.setter + def revision(self, revision): """ - Sets the disconnected_node_acknowledged of this TenantEntity. - Acknowledges that this node is disconnected to allow for mutable requests to proceed. + Sets the revision of this TenantEntity. - :param disconnected_node_acknowledged: The disconnected_node_acknowledged of this TenantEntity. - :type: bool + :param revision: The revision of this TenantEntity. + :type: RevisionDTO """ - self._disconnected_node_acknowledged = disconnected_node_acknowledged + self._revision = revision @property - def component(self): + def uri(self): """ - Gets the component of this TenantEntity. + Gets the uri of this TenantEntity. + The URI for futures requests to the component. - :return: The component of this TenantEntity. - :rtype: TenantDTO + :return: The uri of this TenantEntity. + :rtype: str """ - return self._component + return self._uri - @component.setter - def component(self, component): + @uri.setter + def uri(self, uri): """ - Sets the component of this TenantEntity. + Sets the uri of this TenantEntity. + The URI for futures requests to the component. - :param component: The component of this TenantEntity. - :type: TenantDTO + :param uri: The uri of this TenantEntity. + :type: str """ - self._component = component + self._uri = uri def to_dict(self): """ diff --git a/nipyapi/nifi/models/tenants_entity.py b/nipyapi/nifi/models/tenants_entity.py index 5ba81706..37d5f092 100644 --- a/nipyapi/nifi/models/tenants_entity.py +++ b/nipyapi/nifi/models/tenants_entity.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,69 +27,67 @@ class TenantsEntity(object): and the value is json key in definition. """ swagger_types = { - 'users': 'list[TenantEntity]', - 'user_groups': 'list[TenantEntity]' - } + 'user_groups': 'list[TenantEntity]', +'users': 'list[TenantEntity]' } attribute_map = { - 'users': 'users', - 'user_groups': 'userGroups' - } + 'user_groups': 'userGroups', +'users': 'users' } - def __init__(self, users=None, user_groups=None): + def __init__(self, user_groups=None, users=None): """ TenantsEntity - a model defined in Swagger """ - self._users = None self._user_groups = None + self._users = None - if users is not None: - self.users = users if user_groups is not None: self.user_groups = user_groups + if users is not None: + self.users = users @property - def users(self): + def user_groups(self): """ - Gets the users of this TenantsEntity. + Gets the user_groups of this TenantsEntity. - :return: The users of this TenantsEntity. + :return: The user_groups of this TenantsEntity. :rtype: list[TenantEntity] """ - return self._users + return self._user_groups - @users.setter - def users(self, users): + @user_groups.setter + def user_groups(self, user_groups): """ - Sets the users of this TenantsEntity. + Sets the user_groups of this TenantsEntity. - :param users: The users of this TenantsEntity. + :param user_groups: The user_groups of this TenantsEntity. :type: list[TenantEntity] """ - self._users = users + self._user_groups = user_groups @property - def user_groups(self): + def users(self): """ - Gets the user_groups of this TenantsEntity. + Gets the users of this TenantsEntity. - :return: The user_groups of this TenantsEntity. + :return: The users of this TenantsEntity. :rtype: list[TenantEntity] """ - return self._user_groups + return self._users - @user_groups.setter - def user_groups(self, user_groups): + @users.setter + def users(self, users): """ - Sets the user_groups of this TenantsEntity. + Sets the users of this TenantsEntity. - :param user_groups: The user_groups of this TenantsEntity. + :param users: The users of this TenantsEntity. :type: list[TenantEntity] """ - self._user_groups = user_groups + self._users = users def to_dict(self): """ diff --git a/nipyapi/nifi/models/thread_dump_dto.py b/nipyapi/nifi/models/thread_dump_dto.py deleted file mode 100644 index 006db0b6..00000000 --- a/nipyapi/nifi/models/thread_dump_dto.py +++ /dev/null @@ -1,290 +0,0 @@ -""" - NiFi Rest API - - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - - OpenAPI spec version: 1.28.1 - Contact: dev@nifi.apache.org - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - - -from pprint import pformat -import re - - -class ThreadDumpDTO(object): - """ - NOTE: This class is auto generated by the swagger code generator program. - Do not edit the class manually. - """ - - - """ - Attributes: - swagger_types (dict): The key is attribute name - and the value is attribute type. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - """ - swagger_types = { - 'node_id': 'str', - 'node_address': 'str', - 'api_port': 'int', - 'stack_trace': 'str', - 'thread_name': 'str', - 'thread_active_millis': 'int', - 'task_terminated': 'bool' - } - - attribute_map = { - 'node_id': 'nodeId', - 'node_address': 'nodeAddress', - 'api_port': 'apiPort', - 'stack_trace': 'stackTrace', - 'thread_name': 'threadName', - 'thread_active_millis': 'threadActiveMillis', - 'task_terminated': 'taskTerminated' - } - - def __init__(self, node_id=None, node_address=None, api_port=None, stack_trace=None, thread_name=None, thread_active_millis=None, task_terminated=None): - """ - ThreadDumpDTO - a model defined in Swagger - """ - - self._node_id = None - self._node_address = None - self._api_port = None - self._stack_trace = None - self._thread_name = None - self._thread_active_millis = None - self._task_terminated = None - - if node_id is not None: - self.node_id = node_id - if node_address is not None: - self.node_address = node_address - if api_port is not None: - self.api_port = api_port - if stack_trace is not None: - self.stack_trace = stack_trace - if thread_name is not None: - self.thread_name = thread_name - if thread_active_millis is not None: - self.thread_active_millis = thread_active_millis - if task_terminated is not None: - self.task_terminated = task_terminated - - @property - def node_id(self): - """ - Gets the node_id of this ThreadDumpDTO. - The ID of the node in the cluster - - :return: The node_id of this ThreadDumpDTO. - :rtype: str - """ - return self._node_id - - @node_id.setter - def node_id(self, node_id): - """ - Sets the node_id of this ThreadDumpDTO. - The ID of the node in the cluster - - :param node_id: The node_id of this ThreadDumpDTO. - :type: str - """ - - self._node_id = node_id - - @property - def node_address(self): - """ - Gets the node_address of this ThreadDumpDTO. - The address of the node in the cluster - - :return: The node_address of this ThreadDumpDTO. - :rtype: str - """ - return self._node_address - - @node_address.setter - def node_address(self, node_address): - """ - Sets the node_address of this ThreadDumpDTO. - The address of the node in the cluster - - :param node_address: The node_address of this ThreadDumpDTO. - :type: str - """ - - self._node_address = node_address - - @property - def api_port(self): - """ - Gets the api_port of this ThreadDumpDTO. - The port the node is listening for API requests. - - :return: The api_port of this ThreadDumpDTO. - :rtype: int - """ - return self._api_port - - @api_port.setter - def api_port(self, api_port): - """ - Sets the api_port of this ThreadDumpDTO. - The port the node is listening for API requests. - - :param api_port: The api_port of this ThreadDumpDTO. - :type: int - """ - - self._api_port = api_port - - @property - def stack_trace(self): - """ - Gets the stack_trace of this ThreadDumpDTO. - The stack trace for the thread - - :return: The stack_trace of this ThreadDumpDTO. - :rtype: str - """ - return self._stack_trace - - @stack_trace.setter - def stack_trace(self, stack_trace): - """ - Sets the stack_trace of this ThreadDumpDTO. - The stack trace for the thread - - :param stack_trace: The stack_trace of this ThreadDumpDTO. - :type: str - """ - - self._stack_trace = stack_trace - - @property - def thread_name(self): - """ - Gets the thread_name of this ThreadDumpDTO. - The name of the thread - - :return: The thread_name of this ThreadDumpDTO. - :rtype: str - """ - return self._thread_name - - @thread_name.setter - def thread_name(self, thread_name): - """ - Sets the thread_name of this ThreadDumpDTO. - The name of the thread - - :param thread_name: The thread_name of this ThreadDumpDTO. - :type: str - """ - - self._thread_name = thread_name - - @property - def thread_active_millis(self): - """ - Gets the thread_active_millis of this ThreadDumpDTO. - The number of milliseconds that the thread has been executing in the Processor - - :return: The thread_active_millis of this ThreadDumpDTO. - :rtype: int - """ - return self._thread_active_millis - - @thread_active_millis.setter - def thread_active_millis(self, thread_active_millis): - """ - Sets the thread_active_millis of this ThreadDumpDTO. - The number of milliseconds that the thread has been executing in the Processor - - :param thread_active_millis: The thread_active_millis of this ThreadDumpDTO. - :type: int - """ - - self._thread_active_millis = thread_active_millis - - @property - def task_terminated(self): - """ - Gets the task_terminated of this ThreadDumpDTO. - Indicates whether or not the user has requested that the task be terminated. If this is true, it may indicate that the thread is in a state where it will continue running indefinitely without returning. - - :return: The task_terminated of this ThreadDumpDTO. - :rtype: bool - """ - return self._task_terminated - - @task_terminated.setter - def task_terminated(self, task_terminated): - """ - Sets the task_terminated of this ThreadDumpDTO. - Indicates whether or not the user has requested that the task be terminated. If this is true, it may indicate that the thread is in a state where it will continue running indefinitely without returning. - - :param task_terminated: The task_terminated of this ThreadDumpDTO. - :type: bool - """ - - self._task_terminated = task_terminated - - 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, ThreadDumpDTO): - 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/throwable.py b/nipyapi/nifi/models/throwable.py deleted file mode 100644 index 2093244c..00000000 --- a/nipyapi/nifi/models/throwable.py +++ /dev/null @@ -1,224 +0,0 @@ -""" - NiFi Rest API - - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - - OpenAPI spec version: 1.28.1 - Contact: dev@nifi.apache.org - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - - -from pprint import pformat -import re - - -class Throwable(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 = { - 'cause': 'Throwable', - 'stack_trace': 'list[StackTraceElement]', - 'message': 'str', - 'suppressed': 'list[Throwable]', - 'localized_message': 'str' - } - - attribute_map = { - 'cause': 'cause', - 'stack_trace': 'stackTrace', - 'message': 'message', - 'suppressed': 'suppressed', - 'localized_message': 'localizedMessage' - } - - def __init__(self, cause=None, stack_trace=None, message=None, suppressed=None, localized_message=None): - """ - Throwable - a model defined in Swagger - """ - - self._cause = None - self._stack_trace = None - self._message = None - self._suppressed = None - self._localized_message = None - - if cause is not None: - self.cause = cause - if stack_trace is not None: - self.stack_trace = stack_trace - if message is not None: - self.message = message - if suppressed is not None: - self.suppressed = suppressed - if localized_message is not None: - self.localized_message = localized_message - - @property - def cause(self): - """ - Gets the cause of this Throwable. - - :return: The cause of this Throwable. - :rtype: Throwable - """ - return self._cause - - @cause.setter - def cause(self, cause): - """ - Sets the cause of this Throwable. - - :param cause: The cause of this Throwable. - :type: Throwable - """ - - self._cause = cause - - @property - def stack_trace(self): - """ - Gets the stack_trace of this Throwable. - - :return: The stack_trace of this Throwable. - :rtype: list[StackTraceElement] - """ - return self._stack_trace - - @stack_trace.setter - def stack_trace(self, stack_trace): - """ - Sets the stack_trace of this Throwable. - - :param stack_trace: The stack_trace of this Throwable. - :type: list[StackTraceElement] - """ - - self._stack_trace = stack_trace - - @property - def message(self): - """ - Gets the message of this Throwable. - - :return: The message of this Throwable. - :rtype: str - """ - return self._message - - @message.setter - def message(self, message): - """ - Sets the message of this Throwable. - - :param message: The message of this Throwable. - :type: str - """ - - self._message = message - - @property - def suppressed(self): - """ - Gets the suppressed of this Throwable. - - :return: The suppressed of this Throwable. - :rtype: list[Throwable] - """ - return self._suppressed - - @suppressed.setter - def suppressed(self, suppressed): - """ - Sets the suppressed of this Throwable. - - :param suppressed: The suppressed of this Throwable. - :type: list[Throwable] - """ - - self._suppressed = suppressed - - @property - def localized_message(self): - """ - Gets the localized_message of this Throwable. - - :return: The localized_message of this Throwable. - :rtype: str - """ - return self._localized_message - - @localized_message.setter - def localized_message(self, localized_message): - """ - Sets the localized_message of this Throwable. - - :param localized_message: The localized_message of this Throwable. - :type: str - """ - - self._localized_message = localized_message - - 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, Throwable): - 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/transaction_result_entity.py b/nipyapi/nifi/models/transaction_result_entity.py index d8d9a85e..36c4d516 100644 --- a/nipyapi/nifi/models/transaction_result_entity.py +++ b/nipyapi/nifi/models/transaction_result_entity.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -29,31 +28,29 @@ class TransactionResultEntity(object): """ swagger_types = { 'flow_file_sent': 'int', - 'response_code': 'int', - 'message': 'str' - } +'message': 'str', +'response_code': 'int' } attribute_map = { 'flow_file_sent': 'flowFileSent', - 'response_code': 'responseCode', - 'message': 'message' - } +'message': 'message', +'response_code': 'responseCode' } - def __init__(self, flow_file_sent=None, response_code=None, message=None): + def __init__(self, flow_file_sent=None, message=None, response_code=None): """ TransactionResultEntity - a model defined in Swagger """ self._flow_file_sent = None - self._response_code = None self._message = None + self._response_code = None if flow_file_sent is not None: self.flow_file_sent = flow_file_sent - if response_code is not None: - self.response_code = response_code if message is not None: self.message = message + if response_code is not None: + self.response_code = response_code @property def flow_file_sent(self): @@ -76,27 +73,6 @@ def flow_file_sent(self, flow_file_sent): self._flow_file_sent = flow_file_sent - @property - def response_code(self): - """ - Gets the response_code of this TransactionResultEntity. - - :return: The response_code of this TransactionResultEntity. - :rtype: int - """ - return self._response_code - - @response_code.setter - def response_code(self, response_code): - """ - Sets the response_code of this TransactionResultEntity. - - :param response_code: The response_code of this TransactionResultEntity. - :type: int - """ - - self._response_code = response_code - @property def message(self): """ @@ -118,6 +94,27 @@ def message(self, message): self._message = message + @property + def response_code(self): + """ + Gets the response_code of this TransactionResultEntity. + + :return: The response_code of this TransactionResultEntity. + :rtype: int + """ + return self._response_code + + @response_code.setter + def response_code(self, response_code): + """ + Sets the response_code of this TransactionResultEntity. + + :param response_code: The response_code of this TransactionResultEntity. + :type: int + """ + + self._response_code = response_code + def to_dict(self): """ Returns the model properties as a dict 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 7a2fc250..355f411c 100644 --- a/nipyapi/nifi/models/update_controller_service_reference_request_entity.py +++ b/nipyapi/nifi/models/update_controller_service_reference_request_entity.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,43 +27,64 @@ class UpdateControllerServiceReferenceRequestEntity(object): and the value is json key in definition. """ swagger_types = { - 'id': 'str', - 'state': 'str', - 'referencing_component_revisions': 'dict(str, RevisionDTO)', 'disconnected_node_acknowledged': 'bool', - 'ui_only': 'bool' - } +'id': 'str', +'referencing_component_revisions': 'dict(str, RevisionDTO)', +'state': 'str', +'ui_only': 'bool' } attribute_map = { - 'id': 'id', - 'state': 'state', - 'referencing_component_revisions': 'referencingComponentRevisions', 'disconnected_node_acknowledged': 'disconnectedNodeAcknowledged', - 'ui_only': 'uiOnly' - } +'id': 'id', +'referencing_component_revisions': 'referencingComponentRevisions', +'state': 'state', +'ui_only': 'uiOnly' } - def __init__(self, id=None, state=None, referencing_component_revisions=None, disconnected_node_acknowledged=None, ui_only=None): + def __init__(self, disconnected_node_acknowledged=None, id=None, referencing_component_revisions=None, state=None, ui_only=None): """ UpdateControllerServiceReferenceRequestEntity - a model defined in Swagger """ + self._disconnected_node_acknowledged = None self._id = None - self._state = None self._referencing_component_revisions = None - self._disconnected_node_acknowledged = None + self._state = None self._ui_only = None + if disconnected_node_acknowledged is not None: + self.disconnected_node_acknowledged = disconnected_node_acknowledged if id is not None: self.id = id - if state is not None: - self.state = state if referencing_component_revisions is not None: self.referencing_component_revisions = referencing_component_revisions - if disconnected_node_acknowledged is not None: - self.disconnected_node_acknowledged = disconnected_node_acknowledged + if state is not None: + self.state = state if ui_only is not None: self.ui_only = ui_only + @property + def disconnected_node_acknowledged(self): + """ + Gets the disconnected_node_acknowledged of this UpdateControllerServiceReferenceRequestEntity. + Acknowledges that this node is disconnected to allow for mutable requests to proceed. + + :return: The disconnected_node_acknowledged of this UpdateControllerServiceReferenceRequestEntity. + :rtype: bool + """ + return self._disconnected_node_acknowledged + + @disconnected_node_acknowledged.setter + def disconnected_node_acknowledged(self, disconnected_node_acknowledged): + """ + Sets the disconnected_node_acknowledged of this UpdateControllerServiceReferenceRequestEntity. + Acknowledges that this node is disconnected to allow for mutable requests to proceed. + + :param disconnected_node_acknowledged: The disconnected_node_acknowledged of this UpdateControllerServiceReferenceRequestEntity. + :type: bool + """ + + self._disconnected_node_acknowledged = disconnected_node_acknowledged + @property def id(self): """ @@ -88,35 +108,6 @@ def id(self, id): self._id = id - @property - def state(self): - """ - Gets the state of this UpdateControllerServiceReferenceRequestEntity. - The new state of the references for the controller service. - - :return: The state of this UpdateControllerServiceReferenceRequestEntity. - :rtype: str - """ - return self._state - - @state.setter - def state(self, state): - """ - Sets the state of this UpdateControllerServiceReferenceRequestEntity. - The new state of the references for the controller service. - - :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) - ) - - self._state = state - @property def referencing_component_revisions(self): """ @@ -141,33 +132,39 @@ def referencing_component_revisions(self, referencing_component_revisions): self._referencing_component_revisions = referencing_component_revisions @property - def disconnected_node_acknowledged(self): + def state(self): """ - Gets the disconnected_node_acknowledged of this UpdateControllerServiceReferenceRequestEntity. - Acknowledges that this node is disconnected to allow for mutable requests to proceed. + Gets the state of this UpdateControllerServiceReferenceRequestEntity. + The new state of the references for the controller service. - :return: The disconnected_node_acknowledged of this UpdateControllerServiceReferenceRequestEntity. - :rtype: bool + :return: The state of this UpdateControllerServiceReferenceRequestEntity. + :rtype: str """ - return self._disconnected_node_acknowledged + return self._state - @disconnected_node_acknowledged.setter - def disconnected_node_acknowledged(self, disconnected_node_acknowledged): + @state.setter + def state(self, state): """ - Sets the disconnected_node_acknowledged of this UpdateControllerServiceReferenceRequestEntity. - Acknowledges that this node is disconnected to allow for mutable requests to proceed. + Sets the state of this UpdateControllerServiceReferenceRequestEntity. + The new state of the references for the controller service. - :param disconnected_node_acknowledged: The disconnected_node_acknowledged of this UpdateControllerServiceReferenceRequestEntity. - :type: bool + :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) + ) - self._disconnected_node_acknowledged = disconnected_node_acknowledged + self._state = state @property def ui_only(self): """ Gets the ui_only of this UpdateControllerServiceReferenceRequestEntity. - Indicates whether or not the response should only include fields necessary for rendering the NiFi User Interface. As such, when this value is set to true, some fields may be returned as null values, and the selected fields may change at any time without notice. As a result, this value should not be set to true by any client other than the UI. + Indicates whether or not the response should only include fields necessary for rendering the NiFi User Interface. As such, when this value is set to true, some fields may be returned as null values, and the selected fields may change at any time without notice. As a result, this value should not be set to true by any client other than the UI. :return: The ui_only of this UpdateControllerServiceReferenceRequestEntity. :rtype: bool @@ -178,7 +175,7 @@ def ui_only(self): def ui_only(self, ui_only): """ Sets the ui_only of this UpdateControllerServiceReferenceRequestEntity. - Indicates whether or not the response should only include fields necessary for rendering the NiFi User Interface. As such, when this value is set to true, some fields may be returned as null values, and the selected fields may change at any time without notice. As a result, this value should not be set to true by any client other than the UI. + Indicates whether or not the response should only include fields necessary for rendering the NiFi User Interface. As such, when this value is set to true, some fields may be returned as null values, and the selected fields may change at any time without notice. As a result, this value should not be set to true by any client other than the UI. :param ui_only: The ui_only of this UpdateControllerServiceReferenceRequestEntity. :type: bool diff --git a/nipyapi/nifi/models/use_case.py b/nipyapi/nifi/models/use_case.py new file mode 100644 index 00000000..00c158e1 --- /dev/null +++ b/nipyapi/nifi/models/use_case.py @@ -0,0 +1,237 @@ +""" + Apache NiFi REST API + + REST API definition for Apache NiFi web services + + OpenAPI spec version: 2.5.0 + Contact: dev@nifi.apache.org + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from pprint import pformat +import re + + +class UseCase(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 = { + 'configuration': 'str', +'description': 'str', +'input_requirement': 'str', +'keywords': 'list[str]', +'notes': 'str' } + + attribute_map = { + 'configuration': 'configuration', +'description': 'description', +'input_requirement': 'inputRequirement', +'keywords': 'keywords', +'notes': 'notes' } + + def __init__(self, configuration=None, description=None, input_requirement=None, keywords=None, notes=None): + """ + UseCase - a model defined in Swagger + """ + + self._configuration = None + self._description = None + self._input_requirement = None + self._keywords = None + self._notes = None + + if configuration is not None: + self.configuration = configuration + if description is not None: + self.description = description + if input_requirement is not None: + self.input_requirement = input_requirement + if keywords is not None: + self.keywords = keywords + if notes is not None: + self.notes = notes + + @property + def configuration(self): + """ + Gets the configuration of this UseCase. + A description of how to configure the Processor to perform the task described in the use case + + :return: The configuration of this UseCase. + :rtype: str + """ + return self._configuration + + @configuration.setter + def configuration(self, configuration): + """ + Sets the configuration of this UseCase. + A description of how to configure the Processor to perform the task described in the use case + + :param configuration: The configuration of this UseCase. + :type: str + """ + + self._configuration = configuration + + @property + def description(self): + """ + Gets the description of this UseCase. + A description of the use case + + :return: The description of this UseCase. + :rtype: str + """ + return self._description + + @description.setter + def description(self, description): + """ + Sets the description of this UseCase. + A description of the use case + + :param description: The description of this UseCase. + :type: str + """ + + self._description = description + + @property + def input_requirement(self): + """ + Gets the input_requirement of this UseCase. + Specifies whether an incoming FlowFile is expected for this use case + + :return: The input_requirement of this UseCase. + :rtype: str + """ + return self._input_requirement + + @input_requirement.setter + def input_requirement(self, input_requirement): + """ + Sets the input_requirement of this UseCase. + Specifies whether an incoming FlowFile is expected for this use case + + :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) + ) + + self._input_requirement = input_requirement + + @property + def keywords(self): + """ + Gets the keywords of this UseCase. + Keywords that pertain to the use case + + :return: The keywords of this UseCase. + :rtype: list[str] + """ + return self._keywords + + @keywords.setter + def keywords(self, keywords): + """ + Sets the keywords of this UseCase. + Keywords that pertain to the use case + + :param keywords: The keywords of this UseCase. + :type: list[str] + """ + + self._keywords = keywords + + @property + def notes(self): + """ + Gets the notes of this UseCase. + Any pertinent notes about the use case + + :return: The notes of this UseCase. + :rtype: str + """ + return self._notes + + @notes.setter + def notes(self, notes): + """ + Sets the notes of this UseCase. + Any pertinent notes about the use case + + :param notes: The notes of this UseCase. + :type: str + """ + + self._notes = notes + + 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, UseCase): + 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/user_dto.py b/nipyapi/nifi/models/user_dto.py index 1796e5c3..a17af057 100644 --- a/nipyapi/nifi/models/user_dto.py +++ b/nipyapi/nifi/models/user_dto.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,57 +27,101 @@ class UserDTO(object): and the value is json key in definition. """ swagger_types = { - 'id': 'str', - 'versioned_component_id': 'str', - 'parent_group_id': 'str', - 'position': 'PositionDTO', - 'identity': 'str', - 'configurable': 'bool', - 'user_groups': 'list[TenantEntity]', - 'access_policies': 'list[AccessPolicySummaryEntity]' - } + 'access_policies': 'list[AccessPolicySummaryEntity]', +'configurable': 'bool', +'id': 'str', +'identity': 'str', +'parent_group_id': 'str', +'position': 'PositionDTO', +'user_groups': 'list[TenantEntity]', +'versioned_component_id': 'str' } attribute_map = { - 'id': 'id', - 'versioned_component_id': 'versionedComponentId', - 'parent_group_id': 'parentGroupId', - 'position': 'position', - 'identity': 'identity', - 'configurable': 'configurable', - 'user_groups': 'userGroups', - 'access_policies': 'accessPolicies' - } - - def __init__(self, id=None, versioned_component_id=None, parent_group_id=None, position=None, identity=None, configurable=None, user_groups=None, access_policies=None): + 'access_policies': 'accessPolicies', +'configurable': 'configurable', +'id': 'id', +'identity': 'identity', +'parent_group_id': 'parentGroupId', +'position': 'position', +'user_groups': 'userGroups', +'versioned_component_id': 'versionedComponentId' } + + def __init__(self, access_policies=None, configurable=None, id=None, identity=None, parent_group_id=None, position=None, user_groups=None, versioned_component_id=None): """ UserDTO - a model defined in Swagger """ + self._access_policies = None + self._configurable = None self._id = None - self._versioned_component_id = None + self._identity = None self._parent_group_id = None self._position = None - self._identity = None - self._configurable = None self._user_groups = None - self._access_policies = None + self._versioned_component_id = None + if access_policies is not None: + self.access_policies = access_policies + if configurable is not None: + self.configurable = configurable if id is not None: self.id = id - if versioned_component_id is not None: - self.versioned_component_id = versioned_component_id + if identity is not None: + self.identity = identity if parent_group_id is not None: self.parent_group_id = parent_group_id if position is not None: self.position = position - if identity is not None: - self.identity = identity - if configurable is not None: - self.configurable = configurable if user_groups is not None: self.user_groups = user_groups - if access_policies is not None: - self.access_policies = access_policies + if versioned_component_id is not None: + self.versioned_component_id = versioned_component_id + + @property + def access_policies(self): + """ + Gets the access_policies of this UserDTO. + The access policies this user belongs to. + + :return: The access_policies of this UserDTO. + :rtype: list[AccessPolicySummaryEntity] + """ + return self._access_policies + + @access_policies.setter + def access_policies(self, access_policies): + """ + Sets the access_policies of this UserDTO. + The access policies this user belongs to. + + :param access_policies: The access_policies of this UserDTO. + :type: list[AccessPolicySummaryEntity] + """ + + self._access_policies = access_policies + + @property + def configurable(self): + """ + Gets the configurable of this UserDTO. + Whether this tenant is configurable. + + :return: The configurable of this UserDTO. + :rtype: bool + """ + return self._configurable + + @configurable.setter + def configurable(self, configurable): + """ + Sets the configurable of this UserDTO. + Whether this tenant is configurable. + + :param configurable: The configurable of this UserDTO. + :type: bool + """ + + self._configurable = configurable @property def id(self): @@ -104,27 +147,27 @@ def id(self, id): self._id = id @property - def versioned_component_id(self): + def identity(self): """ - Gets the versioned_component_id of this UserDTO. - The ID of the corresponding component that is under version control + Gets the identity of this UserDTO. + The identity of the tenant. - :return: The versioned_component_id of this UserDTO. + :return: The identity of this UserDTO. :rtype: str """ - return self._versioned_component_id + return self._identity - @versioned_component_id.setter - def versioned_component_id(self, versioned_component_id): + @identity.setter + def identity(self, identity): """ - Sets the versioned_component_id of this UserDTO. - The ID of the corresponding component that is under version control + Sets the identity of this UserDTO. + The identity of the tenant. - :param versioned_component_id: The versioned_component_id of this UserDTO. + :param identity: The identity of this UserDTO. :type: str """ - self._versioned_component_id = versioned_component_id + self._identity = identity @property def parent_group_id(self): @@ -153,7 +196,6 @@ def parent_group_id(self, parent_group_id): def position(self): """ Gets the position of this UserDTO. - The position of this component in the UI if applicable. :return: The position of this UserDTO. :rtype: PositionDTO @@ -164,7 +206,6 @@ def position(self): def position(self, position): """ Sets the position of this UserDTO. - The position of this component in the UI if applicable. :param position: The position of this UserDTO. :type: PositionDTO @@ -172,52 +213,6 @@ def position(self, position): self._position = position - @property - def identity(self): - """ - Gets the identity of this UserDTO. - The identity of the tenant. - - :return: The identity of this UserDTO. - :rtype: str - """ - return self._identity - - @identity.setter - def identity(self, identity): - """ - Sets the identity of this UserDTO. - The identity of the tenant. - - :param identity: The identity of this UserDTO. - :type: str - """ - - self._identity = identity - - @property - def configurable(self): - """ - Gets the configurable of this UserDTO. - Whether this tenant is configurable. - - :return: The configurable of this UserDTO. - :rtype: bool - """ - return self._configurable - - @configurable.setter - def configurable(self, configurable): - """ - Sets the configurable of this UserDTO. - Whether this tenant is configurable. - - :param configurable: The configurable of this UserDTO. - :type: bool - """ - - self._configurable = configurable - @property def user_groups(self): """ @@ -242,27 +237,27 @@ def user_groups(self, user_groups): self._user_groups = user_groups @property - def access_policies(self): + def versioned_component_id(self): """ - Gets the access_policies of this UserDTO. - The access policies this user belongs to. + Gets the versioned_component_id of this UserDTO. + The ID of the corresponding component that is under version control - :return: The access_policies of this UserDTO. - :rtype: list[AccessPolicySummaryEntity] + :return: The versioned_component_id of this UserDTO. + :rtype: str """ - return self._access_policies + return self._versioned_component_id - @access_policies.setter - def access_policies(self, access_policies): + @versioned_component_id.setter + def versioned_component_id(self, versioned_component_id): """ - Sets the access_policies of this UserDTO. - The access policies this user belongs to. + Sets the versioned_component_id of this UserDTO. + The ID of the corresponding component that is under version control - :param access_policies: The access_policies of this UserDTO. - :type: list[AccessPolicySummaryEntity] + :param versioned_component_id: The versioned_component_id of this UserDTO. + :type: str """ - self._access_policies = access_policies + self._versioned_component_id = versioned_component_id def to_dict(self): """ diff --git a/nipyapi/nifi/models/user_entity.py b/nipyapi/nifi/models/user_entity.py index 5185cdea..f5657d4d 100644 --- a/nipyapi/nifi/models/user_entity.py +++ b/nipyapi/nifi/models/user_entity.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,155 +27,150 @@ class UserEntity(object): and the value is json key in definition. """ swagger_types = { - 'revision': 'RevisionDTO', - 'id': 'str', - 'uri': 'str', - 'position': 'PositionDTO', - 'permissions': 'PermissionsDTO', 'bulletins': 'list[BulletinEntity]', - 'disconnected_node_acknowledged': 'bool', - 'component': 'UserDTO' - } +'component': 'UserDTO', +'disconnected_node_acknowledged': 'bool', +'id': 'str', +'permissions': 'PermissionsDTO', +'position': 'PositionDTO', +'revision': 'RevisionDTO', +'uri': 'str' } attribute_map = { - 'revision': 'revision', - 'id': 'id', - 'uri': 'uri', - 'position': 'position', - 'permissions': 'permissions', 'bulletins': 'bulletins', - 'disconnected_node_acknowledged': 'disconnectedNodeAcknowledged', - 'component': 'component' - } +'component': 'component', +'disconnected_node_acknowledged': 'disconnectedNodeAcknowledged', +'id': 'id', +'permissions': 'permissions', +'position': 'position', +'revision': 'revision', +'uri': 'uri' } - def __init__(self, revision=None, id=None, uri=None, position=None, permissions=None, bulletins=None, disconnected_node_acknowledged=None, component=None): + def __init__(self, bulletins=None, component=None, disconnected_node_acknowledged=None, id=None, permissions=None, position=None, revision=None, uri=None): """ UserEntity - a model defined in Swagger """ - self._revision = None - self._id = None - self._uri = None - self._position = None - self._permissions = None self._bulletins = None - self._disconnected_node_acknowledged = None self._component = None + self._disconnected_node_acknowledged = None + self._id = None + self._permissions = None + self._position = None + self._revision = None + self._uri = None - if revision is not None: - self.revision = revision - if id is not None: - self.id = id - if uri is not None: - self.uri = uri - if position is not None: - self.position = position - if permissions is not None: - self.permissions = permissions if bulletins is not None: self.bulletins = bulletins - if disconnected_node_acknowledged is not None: - self.disconnected_node_acknowledged = disconnected_node_acknowledged if component is not None: self.component = component + if disconnected_node_acknowledged is not None: + self.disconnected_node_acknowledged = disconnected_node_acknowledged + if id is not None: + self.id = id + if permissions is not None: + self.permissions = permissions + if position is not None: + self.position = position + if revision is not None: + self.revision = revision + if uri is not None: + self.uri = uri @property - def revision(self): + def bulletins(self): """ - Gets the revision of this UserEntity. - The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses. + Gets the bulletins of this UserEntity. + The bulletins for this component. - :return: The revision of this UserEntity. - :rtype: RevisionDTO + :return: The bulletins of this UserEntity. + :rtype: list[BulletinEntity] """ - return self._revision + return self._bulletins - @revision.setter - def revision(self, revision): + @bulletins.setter + def bulletins(self, bulletins): """ - Sets the revision of this UserEntity. - The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses. + Sets the bulletins of this UserEntity. + The bulletins for this component. - :param revision: The revision of this UserEntity. - :type: RevisionDTO + :param bulletins: The bulletins of this UserEntity. + :type: list[BulletinEntity] """ - self._revision = revision + self._bulletins = bulletins @property - def id(self): + def component(self): """ - Gets the id of this UserEntity. - The id of the component. + Gets the component of this UserEntity. - :return: The id of this UserEntity. - :rtype: str + :return: The component of this UserEntity. + :rtype: UserDTO """ - return self._id + return self._component - @id.setter - def id(self, id): + @component.setter + def component(self, component): """ - Sets the id of this UserEntity. - The id of the component. + Sets the component of this UserEntity. - :param id: The id of this UserEntity. - :type: str + :param component: The component of this UserEntity. + :type: UserDTO """ - self._id = id + self._component = component @property - def uri(self): + def disconnected_node_acknowledged(self): """ - Gets the uri of this UserEntity. - The URI for futures requests to the component. + Gets the disconnected_node_acknowledged of this UserEntity. + Acknowledges that this node is disconnected to allow for mutable requests to proceed. - :return: The uri of this UserEntity. - :rtype: str + :return: The disconnected_node_acknowledged of this UserEntity. + :rtype: bool """ - return self._uri + return self._disconnected_node_acknowledged - @uri.setter - def uri(self, uri): + @disconnected_node_acknowledged.setter + def disconnected_node_acknowledged(self, disconnected_node_acknowledged): """ - Sets the uri of this UserEntity. - The URI for futures requests to the component. + Sets the disconnected_node_acknowledged of this UserEntity. + Acknowledges that this node is disconnected to allow for mutable requests to proceed. - :param uri: The uri of this UserEntity. - :type: str + :param disconnected_node_acknowledged: The disconnected_node_acknowledged of this UserEntity. + :type: bool """ - self._uri = uri + self._disconnected_node_acknowledged = disconnected_node_acknowledged @property - def position(self): + def id(self): """ - Gets the position of this UserEntity. - The position of this component in the UI if applicable. + Gets the id of this UserEntity. + The id of the component. - :return: The position of this UserEntity. - :rtype: PositionDTO + :return: The id of this UserEntity. + :rtype: str """ - return self._position + return self._id - @position.setter - def position(self, position): + @id.setter + def id(self, id): """ - Sets the position of this UserEntity. - The position of this component in the UI if applicable. + Sets the id of this UserEntity. + The id of the component. - :param position: The position of this UserEntity. - :type: PositionDTO + :param id: The id of this UserEntity. + :type: str """ - self._position = position + self._id = id @property def permissions(self): """ Gets the permissions of this UserEntity. - The permissions for this component. :return: The permissions of this UserEntity. :rtype: PermissionsDTO @@ -187,7 +181,6 @@ def permissions(self): def permissions(self, permissions): """ Sets the permissions of this UserEntity. - The permissions for this component. :param permissions: The permissions of this UserEntity. :type: PermissionsDTO @@ -196,71 +189,69 @@ def permissions(self, permissions): self._permissions = permissions @property - def bulletins(self): + def position(self): """ - Gets the bulletins of this UserEntity. - The bulletins for this component. + Gets the position of this UserEntity. - :return: The bulletins of this UserEntity. - :rtype: list[BulletinEntity] + :return: The position of this UserEntity. + :rtype: PositionDTO """ - return self._bulletins + return self._position - @bulletins.setter - def bulletins(self, bulletins): + @position.setter + def position(self, position): """ - Sets the bulletins of this UserEntity. - The bulletins for this component. + Sets the position of this UserEntity. - :param bulletins: The bulletins of this UserEntity. - :type: list[BulletinEntity] + :param position: The position of this UserEntity. + :type: PositionDTO """ - self._bulletins = bulletins + self._position = position @property - def disconnected_node_acknowledged(self): + def revision(self): """ - Gets the disconnected_node_acknowledged of this UserEntity. - Acknowledges that this node is disconnected to allow for mutable requests to proceed. + Gets the revision of this UserEntity. - :return: The disconnected_node_acknowledged of this UserEntity. - :rtype: bool + :return: The revision of this UserEntity. + :rtype: RevisionDTO """ - return self._disconnected_node_acknowledged + return self._revision - @disconnected_node_acknowledged.setter - def disconnected_node_acknowledged(self, disconnected_node_acknowledged): + @revision.setter + def revision(self, revision): """ - Sets the disconnected_node_acknowledged of this UserEntity. - Acknowledges that this node is disconnected to allow for mutable requests to proceed. + Sets the revision of this UserEntity. - :param disconnected_node_acknowledged: The disconnected_node_acknowledged of this UserEntity. - :type: bool + :param revision: The revision of this UserEntity. + :type: RevisionDTO """ - self._disconnected_node_acknowledged = disconnected_node_acknowledged + self._revision = revision @property - def component(self): + def uri(self): """ - Gets the component of this UserEntity. + Gets the uri of this UserEntity. + The URI for futures requests to the component. - :return: The component of this UserEntity. - :rtype: UserDTO + :return: The uri of this UserEntity. + :rtype: str """ - return self._component + return self._uri - @component.setter - def component(self, component): + @uri.setter + def uri(self, uri): """ - Sets the component of this UserEntity. + Sets the uri of this UserEntity. + The URI for futures requests to the component. - :param component: The component of this UserEntity. - :type: UserDTO + :param uri: The uri of this UserEntity. + :type: str """ - self._component = component + self._uri = uri def to_dict(self): """ diff --git a/nipyapi/nifi/models/user_group_dto.py b/nipyapi/nifi/models/user_group_dto.py index 718ff184..ae09d7da 100644 --- a/nipyapi/nifi/models/user_group_dto.py +++ b/nipyapi/nifi/models/user_group_dto.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,57 +27,101 @@ class UserGroupDTO(object): and the value is json key in definition. """ swagger_types = { - 'id': 'str', - 'versioned_component_id': 'str', - 'parent_group_id': 'str', - 'position': 'PositionDTO', - 'identity': 'str', - 'configurable': 'bool', - 'users': 'list[TenantEntity]', - 'access_policies': 'list[AccessPolicyEntity]' - } + 'access_policies': 'list[AccessPolicyEntity]', +'configurable': 'bool', +'id': 'str', +'identity': 'str', +'parent_group_id': 'str', +'position': 'PositionDTO', +'users': 'list[TenantEntity]', +'versioned_component_id': 'str' } attribute_map = { - 'id': 'id', - 'versioned_component_id': 'versionedComponentId', - 'parent_group_id': 'parentGroupId', - 'position': 'position', - 'identity': 'identity', - 'configurable': 'configurable', - 'users': 'users', - 'access_policies': 'accessPolicies' - } - - def __init__(self, id=None, versioned_component_id=None, parent_group_id=None, position=None, identity=None, configurable=None, users=None, access_policies=None): + 'access_policies': 'accessPolicies', +'configurable': 'configurable', +'id': 'id', +'identity': 'identity', +'parent_group_id': 'parentGroupId', +'position': 'position', +'users': 'users', +'versioned_component_id': 'versionedComponentId' } + + def __init__(self, access_policies=None, configurable=None, id=None, identity=None, parent_group_id=None, position=None, users=None, versioned_component_id=None): """ UserGroupDTO - a model defined in Swagger """ + self._access_policies = None + self._configurable = None self._id = None - self._versioned_component_id = None + self._identity = None self._parent_group_id = None self._position = None - self._identity = None - self._configurable = None self._users = None - self._access_policies = None + self._versioned_component_id = None + if access_policies is not None: + self.access_policies = access_policies + if configurable is not None: + self.configurable = configurable if id is not None: self.id = id - if versioned_component_id is not None: - self.versioned_component_id = versioned_component_id + if identity is not None: + self.identity = identity if parent_group_id is not None: self.parent_group_id = parent_group_id if position is not None: self.position = position - if identity is not None: - self.identity = identity - if configurable is not None: - self.configurable = configurable if users is not None: self.users = users - if access_policies is not None: - self.access_policies = access_policies + if versioned_component_id is not None: + self.versioned_component_id = versioned_component_id + + @property + def access_policies(self): + """ + Gets the access_policies of this UserGroupDTO. + The access policies this user group belongs to. This field was incorrectly defined as an AccessPolicyEntity. For compatibility reasons the field will remain of this type, however only the fields that are present in the AccessPolicySummaryEntity will be populated here. + + :return: The access_policies of this UserGroupDTO. + :rtype: list[AccessPolicyEntity] + """ + return self._access_policies + + @access_policies.setter + def access_policies(self, access_policies): + """ + Sets the access_policies of this UserGroupDTO. + The access policies this user group belongs to. This field was incorrectly defined as an AccessPolicyEntity. For compatibility reasons the field will remain of this type, however only the fields that are present in the AccessPolicySummaryEntity will be populated here. + + :param access_policies: The access_policies of this UserGroupDTO. + :type: list[AccessPolicyEntity] + """ + + self._access_policies = access_policies + + @property + def configurable(self): + """ + Gets the configurable of this UserGroupDTO. + Whether this tenant is configurable. + + :return: The configurable of this UserGroupDTO. + :rtype: bool + """ + return self._configurable + + @configurable.setter + def configurable(self, configurable): + """ + Sets the configurable of this UserGroupDTO. + Whether this tenant is configurable. + + :param configurable: The configurable of this UserGroupDTO. + :type: bool + """ + + self._configurable = configurable @property def id(self): @@ -104,27 +147,27 @@ def id(self, id): self._id = id @property - def versioned_component_id(self): + def identity(self): """ - Gets the versioned_component_id of this UserGroupDTO. - The ID of the corresponding component that is under version control + Gets the identity of this UserGroupDTO. + The identity of the tenant. - :return: The versioned_component_id of this UserGroupDTO. + :return: The identity of this UserGroupDTO. :rtype: str """ - return self._versioned_component_id + return self._identity - @versioned_component_id.setter - def versioned_component_id(self, versioned_component_id): + @identity.setter + def identity(self, identity): """ - Sets the versioned_component_id of this UserGroupDTO. - The ID of the corresponding component that is under version control + Sets the identity of this UserGroupDTO. + The identity of the tenant. - :param versioned_component_id: The versioned_component_id of this UserGroupDTO. + :param identity: The identity of this UserGroupDTO. :type: str """ - self._versioned_component_id = versioned_component_id + self._identity = identity @property def parent_group_id(self): @@ -153,7 +196,6 @@ def parent_group_id(self, parent_group_id): def position(self): """ Gets the position of this UserGroupDTO. - The position of this component in the UI if applicable. :return: The position of this UserGroupDTO. :rtype: PositionDTO @@ -164,7 +206,6 @@ def position(self): def position(self, position): """ Sets the position of this UserGroupDTO. - The position of this component in the UI if applicable. :param position: The position of this UserGroupDTO. :type: PositionDTO @@ -172,52 +213,6 @@ def position(self, position): self._position = position - @property - def identity(self): - """ - Gets the identity of this UserGroupDTO. - The identity of the tenant. - - :return: The identity of this UserGroupDTO. - :rtype: str - """ - return self._identity - - @identity.setter - def identity(self, identity): - """ - Sets the identity of this UserGroupDTO. - The identity of the tenant. - - :param identity: The identity of this UserGroupDTO. - :type: str - """ - - self._identity = identity - - @property - def configurable(self): - """ - Gets the configurable of this UserGroupDTO. - Whether this tenant is configurable. - - :return: The configurable of this UserGroupDTO. - :rtype: bool - """ - return self._configurable - - @configurable.setter - def configurable(self, configurable): - """ - Sets the configurable of this UserGroupDTO. - Whether this tenant is configurable. - - :param configurable: The configurable of this UserGroupDTO. - :type: bool - """ - - self._configurable = configurable - @property def users(self): """ @@ -242,27 +237,27 @@ def users(self, users): self._users = users @property - def access_policies(self): + def versioned_component_id(self): """ - Gets the access_policies of this UserGroupDTO. - The access policies this user group belongs to. This field was incorrectly defined as an AccessPolicyEntity. For compatibility reasons the field will remain of this type, however only the fields that are present in the AccessPolicySummaryEntity will be populated here. + Gets the versioned_component_id of this UserGroupDTO. + The ID of the corresponding component that is under version control - :return: The access_policies of this UserGroupDTO. - :rtype: list[AccessPolicyEntity] + :return: The versioned_component_id of this UserGroupDTO. + :rtype: str """ - return self._access_policies + return self._versioned_component_id - @access_policies.setter - def access_policies(self, access_policies): + @versioned_component_id.setter + def versioned_component_id(self, versioned_component_id): """ - Sets the access_policies of this UserGroupDTO. - The access policies this user group belongs to. This field was incorrectly defined as an AccessPolicyEntity. For compatibility reasons the field will remain of this type, however only the fields that are present in the AccessPolicySummaryEntity will be populated here. + Sets the versioned_component_id of this UserGroupDTO. + The ID of the corresponding component that is under version control - :param access_policies: The access_policies of this UserGroupDTO. - :type: list[AccessPolicyEntity] + :param versioned_component_id: The versioned_component_id of this UserGroupDTO. + :type: str """ - self._access_policies = access_policies + self._versioned_component_id = versioned_component_id def to_dict(self): """ diff --git a/nipyapi/nifi/models/user_group_entity.py b/nipyapi/nifi/models/user_group_entity.py index f1bafd8c..d7ff6753 100644 --- a/nipyapi/nifi/models/user_group_entity.py +++ b/nipyapi/nifi/models/user_group_entity.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,155 +27,150 @@ class UserGroupEntity(object): and the value is json key in definition. """ swagger_types = { - 'revision': 'RevisionDTO', - 'id': 'str', - 'uri': 'str', - 'position': 'PositionDTO', - 'permissions': 'PermissionsDTO', 'bulletins': 'list[BulletinEntity]', - 'disconnected_node_acknowledged': 'bool', - 'component': 'UserGroupDTO' - } +'component': 'UserGroupDTO', +'disconnected_node_acknowledged': 'bool', +'id': 'str', +'permissions': 'PermissionsDTO', +'position': 'PositionDTO', +'revision': 'RevisionDTO', +'uri': 'str' } attribute_map = { - 'revision': 'revision', - 'id': 'id', - 'uri': 'uri', - 'position': 'position', - 'permissions': 'permissions', 'bulletins': 'bulletins', - 'disconnected_node_acknowledged': 'disconnectedNodeAcknowledged', - 'component': 'component' - } +'component': 'component', +'disconnected_node_acknowledged': 'disconnectedNodeAcknowledged', +'id': 'id', +'permissions': 'permissions', +'position': 'position', +'revision': 'revision', +'uri': 'uri' } - def __init__(self, revision=None, id=None, uri=None, position=None, permissions=None, bulletins=None, disconnected_node_acknowledged=None, component=None): + def __init__(self, bulletins=None, component=None, disconnected_node_acknowledged=None, id=None, permissions=None, position=None, revision=None, uri=None): """ UserGroupEntity - a model defined in Swagger """ - self._revision = None - self._id = None - self._uri = None - self._position = None - self._permissions = None self._bulletins = None - self._disconnected_node_acknowledged = None self._component = None + self._disconnected_node_acknowledged = None + self._id = None + self._permissions = None + self._position = None + self._revision = None + self._uri = None - if revision is not None: - self.revision = revision - if id is not None: - self.id = id - if uri is not None: - self.uri = uri - if position is not None: - self.position = position - if permissions is not None: - self.permissions = permissions if bulletins is not None: self.bulletins = bulletins - if disconnected_node_acknowledged is not None: - self.disconnected_node_acknowledged = disconnected_node_acknowledged if component is not None: self.component = component + if disconnected_node_acknowledged is not None: + self.disconnected_node_acknowledged = disconnected_node_acknowledged + if id is not None: + self.id = id + if permissions is not None: + self.permissions = permissions + if position is not None: + self.position = position + if revision is not None: + self.revision = revision + if uri is not None: + self.uri = uri @property - def revision(self): + def bulletins(self): """ - Gets the revision of this UserGroupEntity. - The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses. + Gets the bulletins of this UserGroupEntity. + The bulletins for this component. - :return: The revision of this UserGroupEntity. - :rtype: RevisionDTO + :return: The bulletins of this UserGroupEntity. + :rtype: list[BulletinEntity] """ - return self._revision + return self._bulletins - @revision.setter - def revision(self, revision): + @bulletins.setter + def bulletins(self, bulletins): """ - Sets the revision of this UserGroupEntity. - The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses. + Sets the bulletins of this UserGroupEntity. + The bulletins for this component. - :param revision: The revision of this UserGroupEntity. - :type: RevisionDTO + :param bulletins: The bulletins of this UserGroupEntity. + :type: list[BulletinEntity] """ - self._revision = revision + self._bulletins = bulletins @property - def id(self): + def component(self): """ - Gets the id of this UserGroupEntity. - The id of the component. + Gets the component of this UserGroupEntity. - :return: The id of this UserGroupEntity. - :rtype: str + :return: The component of this UserGroupEntity. + :rtype: UserGroupDTO """ - return self._id + return self._component - @id.setter - def id(self, id): + @component.setter + def component(self, component): """ - Sets the id of this UserGroupEntity. - The id of the component. + Sets the component of this UserGroupEntity. - :param id: The id of this UserGroupEntity. - :type: str + :param component: The component of this UserGroupEntity. + :type: UserGroupDTO """ - self._id = id + self._component = component @property - def uri(self): + def disconnected_node_acknowledged(self): """ - Gets the uri of this UserGroupEntity. - The URI for futures requests to the component. + Gets the disconnected_node_acknowledged of this UserGroupEntity. + Acknowledges that this node is disconnected to allow for mutable requests to proceed. - :return: The uri of this UserGroupEntity. - :rtype: str + :return: The disconnected_node_acknowledged of this UserGroupEntity. + :rtype: bool """ - return self._uri + return self._disconnected_node_acknowledged - @uri.setter - def uri(self, uri): + @disconnected_node_acknowledged.setter + def disconnected_node_acknowledged(self, disconnected_node_acknowledged): """ - Sets the uri of this UserGroupEntity. - The URI for futures requests to the component. + Sets the disconnected_node_acknowledged of this UserGroupEntity. + Acknowledges that this node is disconnected to allow for mutable requests to proceed. - :param uri: The uri of this UserGroupEntity. - :type: str + :param disconnected_node_acknowledged: The disconnected_node_acknowledged of this UserGroupEntity. + :type: bool """ - self._uri = uri + self._disconnected_node_acknowledged = disconnected_node_acknowledged @property - def position(self): + def id(self): """ - Gets the position of this UserGroupEntity. - The position of this component in the UI if applicable. + Gets the id of this UserGroupEntity. + The id of the component. - :return: The position of this UserGroupEntity. - :rtype: PositionDTO + :return: The id of this UserGroupEntity. + :rtype: str """ - return self._position + return self._id - @position.setter - def position(self, position): + @id.setter + def id(self, id): """ - Sets the position of this UserGroupEntity. - The position of this component in the UI if applicable. + Sets the id of this UserGroupEntity. + The id of the component. - :param position: The position of this UserGroupEntity. - :type: PositionDTO + :param id: The id of this UserGroupEntity. + :type: str """ - self._position = position + self._id = id @property def permissions(self): """ Gets the permissions of this UserGroupEntity. - The permissions for this component. :return: The permissions of this UserGroupEntity. :rtype: PermissionsDTO @@ -187,7 +181,6 @@ def permissions(self): def permissions(self, permissions): """ Sets the permissions of this UserGroupEntity. - The permissions for this component. :param permissions: The permissions of this UserGroupEntity. :type: PermissionsDTO @@ -196,71 +189,69 @@ def permissions(self, permissions): self._permissions = permissions @property - def bulletins(self): + def position(self): """ - Gets the bulletins of this UserGroupEntity. - The bulletins for this component. + Gets the position of this UserGroupEntity. - :return: The bulletins of this UserGroupEntity. - :rtype: list[BulletinEntity] + :return: The position of this UserGroupEntity. + :rtype: PositionDTO """ - return self._bulletins + return self._position - @bulletins.setter - def bulletins(self, bulletins): + @position.setter + def position(self, position): """ - Sets the bulletins of this UserGroupEntity. - The bulletins for this component. + Sets the position of this UserGroupEntity. - :param bulletins: The bulletins of this UserGroupEntity. - :type: list[BulletinEntity] + :param position: The position of this UserGroupEntity. + :type: PositionDTO """ - self._bulletins = bulletins + self._position = position @property - def disconnected_node_acknowledged(self): + def revision(self): """ - Gets the disconnected_node_acknowledged of this UserGroupEntity. - Acknowledges that this node is disconnected to allow for mutable requests to proceed. + Gets the revision of this UserGroupEntity. - :return: The disconnected_node_acknowledged of this UserGroupEntity. - :rtype: bool + :return: The revision of this UserGroupEntity. + :rtype: RevisionDTO """ - return self._disconnected_node_acknowledged + return self._revision - @disconnected_node_acknowledged.setter - def disconnected_node_acknowledged(self, disconnected_node_acknowledged): + @revision.setter + def revision(self, revision): """ - Sets the disconnected_node_acknowledged of this UserGroupEntity. - Acknowledges that this node is disconnected to allow for mutable requests to proceed. + Sets the revision of this UserGroupEntity. - :param disconnected_node_acknowledged: The disconnected_node_acknowledged of this UserGroupEntity. - :type: bool + :param revision: The revision of this UserGroupEntity. + :type: RevisionDTO """ - self._disconnected_node_acknowledged = disconnected_node_acknowledged + self._revision = revision @property - def component(self): + def uri(self): """ - Gets the component of this UserGroupEntity. + Gets the uri of this UserGroupEntity. + The URI for futures requests to the component. - :return: The component of this UserGroupEntity. - :rtype: UserGroupDTO + :return: The uri of this UserGroupEntity. + :rtype: str """ - return self._component + return self._uri - @component.setter - def component(self, component): + @uri.setter + def uri(self, uri): """ - Sets the component of this UserGroupEntity. + Sets the uri of this UserGroupEntity. + The URI for futures requests to the component. - :param component: The component of this UserGroupEntity. - :type: UserGroupDTO + :param uri: The uri of this UserGroupEntity. + :type: str """ - self._component = component + self._uri = uri def to_dict(self): """ diff --git a/nipyapi/nifi/models/user_groups_entity.py b/nipyapi/nifi/models/user_groups_entity.py index 9a2cb177..3b430c2f 100644 --- a/nipyapi/nifi/models/user_groups_entity.py +++ b/nipyapi/nifi/models/user_groups_entity.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,12 +27,10 @@ class UserGroupsEntity(object): and the value is json key in definition. """ swagger_types = { - 'user_groups': 'list[UserGroupEntity]' - } + 'user_groups': 'list[UserGroupEntity]' } attribute_map = { - 'user_groups': 'userGroups' - } + 'user_groups': 'userGroups' } def __init__(self, user_groups=None): """ diff --git a/nipyapi/nifi/models/users_entity.py b/nipyapi/nifi/models/users_entity.py index cfb43217..50d4e9f1 100644 --- a/nipyapi/nifi/models/users_entity.py +++ b/nipyapi/nifi/models/users_entity.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -29,13 +28,11 @@ class UsersEntity(object): """ swagger_types = { 'generated': 'str', - 'users': 'list[UserEntity]' - } +'users': 'list[UserEntity]' } attribute_map = { 'generated': 'generated', - 'users': 'users' - } +'users': 'users' } def __init__(self, generated=None, users=None): """ diff --git a/nipyapi/nifi/models/variable_dto.py b/nipyapi/nifi/models/variable_dto.py deleted file mode 100644 index 2eca5854..00000000 --- a/nipyapi/nifi/models/variable_dto.py +++ /dev/null @@ -1,206 +0,0 @@ -""" - NiFi Rest API - - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - - OpenAPI spec version: 1.28.1 - Contact: dev@nifi.apache.org - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - - -from pprint import pformat -import re - - -class VariableDTO(object): - """ - NOTE: This class is auto generated by the swagger code generator program. - Do not edit the class manually. - """ - - - """ - Attributes: - swagger_types (dict): The key is attribute name - and the value is attribute type. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - """ - swagger_types = { - 'name': 'str', - 'value': 'str', - 'process_group_id': 'str', - 'affected_components': 'list[AffectedComponentEntity]' - } - - attribute_map = { - 'name': 'name', - 'value': 'value', - 'process_group_id': 'processGroupId', - 'affected_components': 'affectedComponents' - } - - def __init__(self, name=None, value=None, process_group_id=None, affected_components=None): - """ - VariableDTO - a model defined in Swagger - """ - - self._name = None - self._value = None - self._process_group_id = None - self._affected_components = None - - if name is not None: - self.name = name - if value is not None: - self.value = value - if process_group_id is not None: - self.process_group_id = process_group_id - if affected_components is not None: - self.affected_components = affected_components - - @property - def name(self): - """ - Gets the name of this VariableDTO. - The name of the variable - - :return: The name of this VariableDTO. - :rtype: str - """ - return self._name - - @name.setter - def name(self, name): - """ - Sets the name of this VariableDTO. - The name of the variable - - :param name: The name of this VariableDTO. - :type: str - """ - - self._name = name - - @property - def value(self): - """ - Gets the value of this VariableDTO. - The value of the variable - - :return: The value of this VariableDTO. - :rtype: str - """ - return self._value - - @value.setter - def value(self, value): - """ - Sets the value of this VariableDTO. - The value of the variable - - :param value: The value of this VariableDTO. - :type: str - """ - - self._value = value - - @property - def process_group_id(self): - """ - Gets the process_group_id of this VariableDTO. - The ID of the Process Group where this Variable is defined - - :return: The process_group_id of this VariableDTO. - :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 VariableDTO. - The ID of the Process Group where this Variable is defined - - :param process_group_id: The process_group_id of this VariableDTO. - :type: str - """ - - self._process_group_id = process_group_id - - @property - def affected_components(self): - """ - Gets the affected_components of this VariableDTO. - A set of all components that will be affected if the value of this variable is changed - - :return: The affected_components of this VariableDTO. - :rtype: list[AffectedComponentEntity] - """ - return self._affected_components - - @affected_components.setter - def affected_components(self, affected_components): - """ - Sets the affected_components of this VariableDTO. - A set of all components that will be affected if the value of this variable is changed - - :param affected_components: The affected_components of this VariableDTO. - :type: list[AffectedComponentEntity] - """ - - self._affected_components = affected_components - - 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, VariableDTO): - 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/variable_entity.py b/nipyapi/nifi/models/variable_entity.py deleted file mode 100644 index 7142a1e9..00000000 --- a/nipyapi/nifi/models/variable_entity.py +++ /dev/null @@ -1,150 +0,0 @@ -""" - NiFi Rest API - - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - - OpenAPI spec version: 1.28.1 - Contact: dev@nifi.apache.org - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - - -from pprint import pformat -import re - - -class VariableEntity(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 = { - 'variable': 'VariableDTO', - 'can_write': 'bool' - } - - attribute_map = { - 'variable': 'variable', - 'can_write': 'canWrite' - } - - def __init__(self, variable=None, can_write=None): - """ - VariableEntity - a model defined in Swagger - """ - - self._variable = None - self._can_write = None - - if variable is not None: - self.variable = variable - if can_write is not None: - self.can_write = can_write - - @property - def variable(self): - """ - Gets the variable of this VariableEntity. - The variable information - - :return: The variable of this VariableEntity. - :rtype: VariableDTO - """ - return self._variable - - @variable.setter - def variable(self, variable): - """ - Sets the variable of this VariableEntity. - The variable information - - :param variable: The variable of this VariableEntity. - :type: VariableDTO - """ - - self._variable = variable - - @property - def can_write(self): - """ - Gets the can_write of this VariableEntity. - Indicates whether the user can write a given resource. - - :return: The can_write of this VariableEntity. - :rtype: bool - """ - return self._can_write - - @can_write.setter - def can_write(self, can_write): - """ - Sets the can_write of this VariableEntity. - Indicates whether the user can write a given resource. - - :param can_write: The can_write of this VariableEntity. - :type: bool - """ - - self._can_write = can_write - - 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, VariableEntity): - 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/variable_registry_dto.py b/nipyapi/nifi/models/variable_registry_dto.py deleted file mode 100644 index c6143393..00000000 --- a/nipyapi/nifi/models/variable_registry_dto.py +++ /dev/null @@ -1,150 +0,0 @@ -""" - NiFi Rest API - - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - - OpenAPI spec version: 1.28.1 - Contact: dev@nifi.apache.org - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - - -from pprint import pformat -import re - - -class VariableRegistryDTO(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 = { - 'variables': 'list[VariableEntity]', - 'process_group_id': 'str' - } - - attribute_map = { - 'variables': 'variables', - 'process_group_id': 'processGroupId' - } - - def __init__(self, variables=None, process_group_id=None): - """ - VariableRegistryDTO - a model defined in Swagger - """ - - self._variables = None - self._process_group_id = None - - if variables is not None: - self.variables = variables - if process_group_id is not None: - self.process_group_id = process_group_id - - @property - def variables(self): - """ - Gets the variables of this VariableRegistryDTO. - The variables that are available in this Variable Registry - - :return: The variables of this VariableRegistryDTO. - :rtype: list[VariableEntity] - """ - return self._variables - - @variables.setter - def variables(self, variables): - """ - Sets the variables of this VariableRegistryDTO. - The variables that are available in this Variable Registry - - :param variables: The variables of this VariableRegistryDTO. - :type: list[VariableEntity] - """ - - self._variables = variables - - @property - def process_group_id(self): - """ - Gets the process_group_id of this VariableRegistryDTO. - The UUID of the Process Group that this Variable Registry belongs to - - :return: The process_group_id of this VariableRegistryDTO. - :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 VariableRegistryDTO. - The UUID of the Process Group that this Variable Registry belongs to - - :param process_group_id: The process_group_id of this VariableRegistryDTO. - :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, VariableRegistryDTO): - 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/variable_registry_update_request_dto.py b/nipyapi/nifi/models/variable_registry_update_request_dto.py deleted file mode 100644 index 811b9587..00000000 --- a/nipyapi/nifi/models/variable_registry_update_request_dto.py +++ /dev/null @@ -1,402 +0,0 @@ -""" - NiFi Rest API - - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - - OpenAPI spec version: 1.28.1 - Contact: dev@nifi.apache.org - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - - -from pprint import pformat -import re - - -class VariableRegistryUpdateRequestDTO(object): - """ - NOTE: This class is auto generated by the swagger code generator program. - Do not edit the class manually. - """ - - - """ - Attributes: - swagger_types (dict): The key is attribute name - and the value is attribute type. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - """ - swagger_types = { - 'request_id': 'str', - 'uri': 'str', - 'submission_time': 'datetime', - 'last_updated': 'datetime', - 'complete': 'bool', - 'failure_reason': 'str', - 'percent_completed': 'int', - 'state': 'str', - 'update_steps': 'list[VariableRegistryUpdateStepDTO]', - 'process_group_id': 'str', - 'affected_components': 'list[AffectedComponentEntity]' - } - - attribute_map = { - 'request_id': 'requestId', - 'uri': 'uri', - 'submission_time': 'submissionTime', - 'last_updated': 'lastUpdated', - 'complete': 'complete', - 'failure_reason': 'failureReason', - 'percent_completed': 'percentCompleted', - 'state': 'state', - 'update_steps': 'updateSteps', - 'process_group_id': 'processGroupId', - 'affected_components': 'affectedComponents' - } - - def __init__(self, request_id=None, uri=None, submission_time=None, last_updated=None, complete=None, failure_reason=None, percent_completed=None, state=None, update_steps=None, process_group_id=None, affected_components=None): - """ - VariableRegistryUpdateRequestDTO - a model defined in Swagger - """ - - self._request_id = None - self._uri = None - self._submission_time = None - self._last_updated = None - self._complete = None - self._failure_reason = None - self._percent_completed = None - self._state = None - self._update_steps = None - self._process_group_id = None - self._affected_components = None - - if request_id is not None: - self.request_id = request_id - if uri is not None: - self.uri = uri - if submission_time is not None: - self.submission_time = submission_time - if last_updated is not None: - self.last_updated = last_updated - if complete is not None: - self.complete = complete - if failure_reason is not None: - self.failure_reason = failure_reason - if percent_completed is not None: - self.percent_completed = percent_completed - if state is not None: - self.state = state - if update_steps is not None: - self.update_steps = update_steps - if process_group_id is not None: - self.process_group_id = process_group_id - if affected_components is not None: - self.affected_components = affected_components - - @property - def request_id(self): - """ - Gets the request_id of this VariableRegistryUpdateRequestDTO. - The ID of the request - - :return: The request_id of this VariableRegistryUpdateRequestDTO. - :rtype: str - """ - return self._request_id - - @request_id.setter - def request_id(self, request_id): - """ - Sets the request_id of this VariableRegistryUpdateRequestDTO. - The ID of the request - - :param request_id: The request_id of this VariableRegistryUpdateRequestDTO. - :type: str - """ - - self._request_id = request_id - - @property - def uri(self): - """ - Gets the uri of this VariableRegistryUpdateRequestDTO. - The URI for the request - - :return: The uri of this VariableRegistryUpdateRequestDTO. - :rtype: str - """ - return self._uri - - @uri.setter - def uri(self, uri): - """ - Sets the uri of this VariableRegistryUpdateRequestDTO. - The URI for the request - - :param uri: The uri of this VariableRegistryUpdateRequestDTO. - :type: str - """ - - self._uri = uri - - @property - def submission_time(self): - """ - Gets the submission_time of this VariableRegistryUpdateRequestDTO. - The timestamp of when the request was submitted - - :return: The submission_time of this VariableRegistryUpdateRequestDTO. - :rtype: datetime - """ - return self._submission_time - - @submission_time.setter - def submission_time(self, submission_time): - """ - Sets the submission_time of this VariableRegistryUpdateRequestDTO. - The timestamp of when the request was submitted - - :param submission_time: The submission_time of this VariableRegistryUpdateRequestDTO. - :type: datetime - """ - - self._submission_time = submission_time - - @property - def last_updated(self): - """ - Gets the last_updated of this VariableRegistryUpdateRequestDTO. - The timestamp of when the request was last updated - - :return: The last_updated of this VariableRegistryUpdateRequestDTO. - :rtype: datetime - """ - return self._last_updated - - @last_updated.setter - def last_updated(self, last_updated): - """ - Sets the last_updated of this VariableRegistryUpdateRequestDTO. - The timestamp of when the request was last updated - - :param last_updated: The last_updated of this VariableRegistryUpdateRequestDTO. - :type: datetime - """ - - self._last_updated = last_updated - - @property - def complete(self): - """ - Gets the complete of this VariableRegistryUpdateRequestDTO. - Whether or not the request is completed - - :return: The complete of this VariableRegistryUpdateRequestDTO. - :rtype: bool - """ - return self._complete - - @complete.setter - def complete(self, complete): - """ - Sets the complete of this VariableRegistryUpdateRequestDTO. - Whether or not the request is completed - - :param complete: The complete of this VariableRegistryUpdateRequestDTO. - :type: bool - """ - - self._complete = complete - - @property - def failure_reason(self): - """ - Gets the failure_reason of this VariableRegistryUpdateRequestDTO. - The reason for the request failing, or null if the request has not failed - - :return: The failure_reason of this VariableRegistryUpdateRequestDTO. - :rtype: str - """ - return self._failure_reason - - @failure_reason.setter - def failure_reason(self, failure_reason): - """ - Sets the failure_reason of this VariableRegistryUpdateRequestDTO. - The reason for the request failing, or null if the request has not failed - - :param failure_reason: The failure_reason of this VariableRegistryUpdateRequestDTO. - :type: str - """ - - self._failure_reason = failure_reason - - @property - def percent_completed(self): - """ - Gets the percent_completed of this VariableRegistryUpdateRequestDTO. - A value between 0 and 100 (inclusive) indicating how close the request is to completion - - :return: The percent_completed of this VariableRegistryUpdateRequestDTO. - :rtype: int - """ - return self._percent_completed - - @percent_completed.setter - def percent_completed(self, percent_completed): - """ - Sets the percent_completed of this VariableRegistryUpdateRequestDTO. - A value between 0 and 100 (inclusive) indicating how close the request is to completion - - :param percent_completed: The percent_completed of this VariableRegistryUpdateRequestDTO. - :type: int - """ - - self._percent_completed = percent_completed - - @property - def state(self): - """ - Gets the state of this VariableRegistryUpdateRequestDTO. - A description of the current state of the request - - :return: The state of this VariableRegistryUpdateRequestDTO. - :rtype: str - """ - return self._state - - @state.setter - def state(self, state): - """ - Sets the state of this VariableRegistryUpdateRequestDTO. - A description of the current state of the request - - :param state: The state of this VariableRegistryUpdateRequestDTO. - :type: str - """ - - self._state = state - - @property - def update_steps(self): - """ - Gets the update_steps of this VariableRegistryUpdateRequestDTO. - The steps that are required in order to complete the request, along with the status of each - - :return: The update_steps of this VariableRegistryUpdateRequestDTO. - :rtype: list[VariableRegistryUpdateStepDTO] - """ - return self._update_steps - - @update_steps.setter - def update_steps(self, update_steps): - """ - Sets the update_steps of this VariableRegistryUpdateRequestDTO. - 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 VariableRegistryUpdateRequestDTO. - :type: list[VariableRegistryUpdateStepDTO] - """ - - self._update_steps = update_steps - - @property - def process_group_id(self): - """ - Gets the process_group_id of this VariableRegistryUpdateRequestDTO. - The unique ID of the Process Group that the variable registry belongs to - - :return: The process_group_id of this VariableRegistryUpdateRequestDTO. - :rtype: str - """ - return self._process_group_id - - @process_group_id.setter - def process_group_id(self, process_group_id): - """ - Sets the process_group_id of this VariableRegistryUpdateRequestDTO. - The unique ID of the Process Group that the variable registry belongs to - - :param process_group_id: The process_group_id of this VariableRegistryUpdateRequestDTO. - :type: str - """ - - self._process_group_id = process_group_id - - @property - def affected_components(self): - """ - Gets the affected_components of this VariableRegistryUpdateRequestDTO. - A set of all components that will be affected if the value of this variable is changed - - :return: The affected_components of this VariableRegistryUpdateRequestDTO. - :rtype: list[AffectedComponentEntity] - """ - return self._affected_components - - @affected_components.setter - def affected_components(self, affected_components): - """ - Sets the affected_components of this VariableRegistryUpdateRequestDTO. - A set of all components that will be affected if the value of this variable is changed - - :param affected_components: The affected_components of this VariableRegistryUpdateRequestDTO. - :type: list[AffectedComponentEntity] - """ - - self._affected_components = affected_components - - 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, VariableRegistryUpdateRequestDTO): - 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/variable_registry_update_request_entity.py b/nipyapi/nifi/models/variable_registry_update_request_entity.py deleted file mode 100644 index f5dad3da..00000000 --- a/nipyapi/nifi/models/variable_registry_update_request_entity.py +++ /dev/null @@ -1,150 +0,0 @@ -""" - NiFi Rest API - - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - - OpenAPI spec version: 1.28.1 - Contact: dev@nifi.apache.org - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - - -from pprint import pformat -import re - - -class VariableRegistryUpdateRequestEntity(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': 'VariableRegistryUpdateRequestDTO', - 'process_group_revision': 'RevisionDTO' - } - - attribute_map = { - 'request': 'request', - 'process_group_revision': 'processGroupRevision' - } - - def __init__(self, request=None, process_group_revision=None): - """ - VariableRegistryUpdateRequestEntity - a model defined in Swagger - """ - - self._request = None - self._process_group_revision = None - - if request is not None: - self.request = request - if process_group_revision is not None: - self.process_group_revision = process_group_revision - - @property - def request(self): - """ - Gets the request of this VariableRegistryUpdateRequestEntity. - The Variable Registry Update Request - - :return: The request of this VariableRegistryUpdateRequestEntity. - :rtype: VariableRegistryUpdateRequestDTO - """ - return self._request - - @request.setter - def request(self, request): - """ - Sets the request of this VariableRegistryUpdateRequestEntity. - The Variable Registry Update Request - - :param request: The request of this VariableRegistryUpdateRequestEntity. - :type: VariableRegistryUpdateRequestDTO - """ - - self._request = request - - @property - def process_group_revision(self): - """ - Gets the process_group_revision of this VariableRegistryUpdateRequestEntity. - The revision for the Process Group that owns this variable registry. - - :return: The process_group_revision of this VariableRegistryUpdateRequestEntity. - :rtype: RevisionDTO - """ - return self._process_group_revision - - @process_group_revision.setter - def process_group_revision(self, process_group_revision): - """ - Sets the process_group_revision of this VariableRegistryUpdateRequestEntity. - The revision for the Process Group that owns this variable registry. - - :param process_group_revision: The process_group_revision of this VariableRegistryUpdateRequestEntity. - :type: RevisionDTO - """ - - self._process_group_revision = process_group_revision - - 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, VariableRegistryUpdateRequestEntity): - 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/variable_registry_update_step_dto.py b/nipyapi/nifi/models/variable_registry_update_step_dto.py deleted file mode 100644 index 2ef5314c..00000000 --- a/nipyapi/nifi/models/variable_registry_update_step_dto.py +++ /dev/null @@ -1,178 +0,0 @@ -""" - NiFi Rest API - - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - - OpenAPI spec version: 1.28.1 - Contact: dev@nifi.apache.org - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - - -from pprint import pformat -import re - - -class VariableRegistryUpdateStepDTO(object): - """ - NOTE: This class is auto generated by the swagger code generator program. - Do not edit the class manually. - """ - - - """ - Attributes: - swagger_types (dict): The key is attribute name - and the value is attribute type. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - """ - swagger_types = { - 'description': 'str', - 'complete': 'bool', - 'failure_reason': 'str' - } - - attribute_map = { - 'description': 'description', - 'complete': 'complete', - 'failure_reason': 'failureReason' - } - - def __init__(self, description=None, complete=None, failure_reason=None): - """ - VariableRegistryUpdateStepDTO - a model defined in Swagger - """ - - self._description = None - self._complete = None - self._failure_reason = None - - if description is not None: - self.description = description - if complete is not None: - self.complete = complete - if failure_reason is not None: - self.failure_reason = failure_reason - - @property - def description(self): - """ - Gets the description of this VariableRegistryUpdateStepDTO. - Explanation of what happens in this step - - :return: The description of this VariableRegistryUpdateStepDTO. - :rtype: str - """ - return self._description - - @description.setter - def description(self, description): - """ - Sets the description of this VariableRegistryUpdateStepDTO. - Explanation of what happens in this step - - :param description: The description of this VariableRegistryUpdateStepDTO. - :type: str - """ - - self._description = description - - @property - def complete(self): - """ - Gets the complete of this VariableRegistryUpdateStepDTO. - Whether or not this step has completed - - :return: The complete of this VariableRegistryUpdateStepDTO. - :rtype: bool - """ - return self._complete - - @complete.setter - def complete(self, complete): - """ - Sets the complete of this VariableRegistryUpdateStepDTO. - Whether or not this step has completed - - :param complete: The complete of this VariableRegistryUpdateStepDTO. - :type: bool - """ - - self._complete = complete - - @property - def failure_reason(self): - """ - Gets the failure_reason of this VariableRegistryUpdateStepDTO. - An explanation of why this step failed, or null if this step did not fail - - :return: The failure_reason of this VariableRegistryUpdateStepDTO. - :rtype: str - """ - return self._failure_reason - - @failure_reason.setter - def failure_reason(self, failure_reason): - """ - Sets the failure_reason of this VariableRegistryUpdateStepDTO. - An explanation of why this step failed, or null if this step did not fail - - :param failure_reason: The failure_reason of this VariableRegistryUpdateStepDTO. - :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, VariableRegistryUpdateStepDTO): - 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/verify_config_request_dto.py b/nipyapi/nifi/models/verify_config_request_dto.py index 21087089..bcaf01b6 100644 --- a/nipyapi/nifi/models/verify_config_request_dto.py +++ b/nipyapi/nifi/models/verify_config_request_dto.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,151 +27,172 @@ class VerifyConfigRequestDTO(object): and the value is json key in definition. """ swagger_types = { - 'request_id': 'str', - 'uri': 'str', - 'submission_time': 'datetime', - 'last_updated': 'datetime', - 'complete': 'bool', - 'failure_reason': 'str', - 'percent_completed': 'int', - 'state': 'str', - 'update_steps': 'list[VerifyConfigUpdateStepDTO]', - 'component_id': 'str', - 'properties': 'dict(str, str)', 'attributes': 'dict(str, str)', - 'results': 'list[ConfigVerificationResultDTO]' - } +'complete': 'bool', +'component_id': 'str', +'failure_reason': 'str', +'last_updated': 'datetime', +'percent_completed': 'int', +'properties': 'dict(str, str)', +'request_id': 'str', +'results': 'list[ConfigVerificationResultDTO]', +'state': 'str', +'submission_time': 'datetime', +'update_steps': 'list[VerifyConfigUpdateStepDTO]', +'uri': 'str' } attribute_map = { - 'request_id': 'requestId', - 'uri': 'uri', - 'submission_time': 'submissionTime', - 'last_updated': 'lastUpdated', - 'complete': 'complete', - 'failure_reason': 'failureReason', - 'percent_completed': 'percentCompleted', - 'state': 'state', - 'update_steps': 'updateSteps', - 'component_id': 'componentId', - 'properties': 'properties', 'attributes': 'attributes', - 'results': 'results' - } - - def __init__(self, request_id=None, uri=None, submission_time=None, last_updated=None, complete=None, failure_reason=None, percent_completed=None, state=None, update_steps=None, component_id=None, properties=None, attributes=None, results=None): +'complete': 'complete', +'component_id': 'componentId', +'failure_reason': 'failureReason', +'last_updated': 'lastUpdated', +'percent_completed': 'percentCompleted', +'properties': 'properties', +'request_id': 'requestId', +'results': 'results', +'state': 'state', +'submission_time': 'submissionTime', +'update_steps': 'updateSteps', +'uri': 'uri' } + + def __init__(self, attributes=None, complete=None, component_id=None, failure_reason=None, last_updated=None, percent_completed=None, properties=None, request_id=None, results=None, state=None, submission_time=None, update_steps=None, uri=None): """ VerifyConfigRequestDTO - a model defined in Swagger """ - self._request_id = None - self._uri = None - self._submission_time = None - self._last_updated = None + self._attributes = None self._complete = None + self._component_id = None self._failure_reason = None + self._last_updated = None self._percent_completed = None - self._state = None - self._update_steps = None - self._component_id = None self._properties = None - self._attributes = None + self._request_id = None self._results = None + self._state = None + self._submission_time = None + self._update_steps = None + self._uri = None - if request_id is not None: - self.request_id = request_id - if uri is not None: - self.uri = uri - if submission_time is not None: - self.submission_time = submission_time - if last_updated is not None: - self.last_updated = last_updated + if attributes is not None: + self.attributes = attributes 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 state is not None: - self.state = state - if update_steps is not None: - self.update_steps = update_steps - if component_id is not None: - self.component_id = component_id if properties is not None: self.properties = properties - if attributes is not None: - self.attributes = attributes + if request_id is not None: + self.request_id = request_id if results is not None: self.results = results + 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 request_id(self): + def attributes(self): """ - Gets the request_id of this VerifyConfigRequestDTO. - The ID of the request + Gets the attributes of this VerifyConfigRequestDTO. + FlowFile Attributes that should be used to evaluate Expression Language for resolving property values - :return: The request_id of this VerifyConfigRequestDTO. - :rtype: str + :return: The attributes of this VerifyConfigRequestDTO. + :rtype: dict(str, str) """ - return self._request_id + return self._attributes - @request_id.setter - def request_id(self, request_id): + @attributes.setter + def attributes(self, attributes): """ - Sets the request_id of this VerifyConfigRequestDTO. - The ID of the request + Sets the attributes of this VerifyConfigRequestDTO. + FlowFile Attributes that should be used to evaluate Expression Language for resolving property values - :param request_id: The request_id of this VerifyConfigRequestDTO. - :type: str + :param attributes: The attributes of this VerifyConfigRequestDTO. + :type: dict(str, str) """ - self._request_id = request_id + self._attributes = attributes @property - def uri(self): + def complete(self): """ - Gets the uri of this VerifyConfigRequestDTO. - The URI for the request + Gets the complete of this VerifyConfigRequestDTO. + Whether or not the request is completed - :return: The uri of this VerifyConfigRequestDTO. + :return: The complete of this VerifyConfigRequestDTO. + :rtype: bool + """ + return self._complete + + @complete.setter + def complete(self, complete): + """ + Sets the complete of this VerifyConfigRequestDTO. + Whether or not the request is completed + + :param complete: The complete of this VerifyConfigRequestDTO. + :type: bool + """ + + self._complete = complete + + @property + def component_id(self): + """ + Gets the component_id of this VerifyConfigRequestDTO. + The ID of the component whose configuration was verified + + :return: The component_id of this VerifyConfigRequestDTO. :rtype: str """ - return self._uri + return self._component_id - @uri.setter - def uri(self, uri): + @component_id.setter + def component_id(self, component_id): """ - Sets the uri of this VerifyConfigRequestDTO. - The URI for the request + Sets the component_id of this VerifyConfigRequestDTO. + The ID of the component whose configuration was verified - :param uri: The uri of this VerifyConfigRequestDTO. + :param component_id: The component_id of this VerifyConfigRequestDTO. :type: str """ - self._uri = uri + self._component_id = component_id @property - def submission_time(self): + def failure_reason(self): """ - Gets the submission_time of this VerifyConfigRequestDTO. - The timestamp of when the request was submitted + Gets the failure_reason of this VerifyConfigRequestDTO. + The reason for the request failing, or null if the request has not failed - :return: The submission_time of this VerifyConfigRequestDTO. - :rtype: datetime + :return: The failure_reason of this VerifyConfigRequestDTO. + :rtype: str """ - return self._submission_time + return self._failure_reason - @submission_time.setter - def submission_time(self, submission_time): + @failure_reason.setter + def failure_reason(self, failure_reason): """ - Sets the submission_time of this VerifyConfigRequestDTO. - The timestamp of when the request was submitted + Sets the failure_reason of this VerifyConfigRequestDTO. + The reason for the request failing, or null if the request has not failed - :param submission_time: The submission_time of this VerifyConfigRequestDTO. - :type: datetime + :param failure_reason: The failure_reason of this VerifyConfigRequestDTO. + :type: str """ - self._submission_time = submission_time + self._failure_reason = failure_reason @property def last_updated(self): @@ -198,73 +218,96 @@ def last_updated(self, last_updated): self._last_updated = last_updated @property - def complete(self): + def percent_completed(self): """ - Gets the complete of this VerifyConfigRequestDTO. - Whether or not the request is completed + Gets the percent_completed of this VerifyConfigRequestDTO. + A value between 0 and 100 (inclusive) indicating how close the request is to completion - :return: The complete of this VerifyConfigRequestDTO. - :rtype: bool + :return: The percent_completed of this VerifyConfigRequestDTO. + :rtype: int """ - return self._complete + return self._percent_completed - @complete.setter - def complete(self, complete): + @percent_completed.setter + def percent_completed(self, percent_completed): """ - Sets the complete of this VerifyConfigRequestDTO. - Whether or not the request is completed + Sets the percent_completed of this VerifyConfigRequestDTO. + A value between 0 and 100 (inclusive) indicating how close the request is to completion - :param complete: The complete of this VerifyConfigRequestDTO. - :type: bool + :param percent_completed: The percent_completed of this VerifyConfigRequestDTO. + :type: int """ - self._complete = complete + self._percent_completed = percent_completed @property - def failure_reason(self): + def properties(self): """ - Gets the failure_reason of this VerifyConfigRequestDTO. - The reason for the request failing, or null if the request has not failed + Gets the properties of this VerifyConfigRequestDTO. + The configured component properties - :return: The failure_reason of this VerifyConfigRequestDTO. + :return: The properties of this VerifyConfigRequestDTO. + :rtype: dict(str, str) + """ + return self._properties + + @properties.setter + def properties(self, properties): + """ + Sets the properties of this VerifyConfigRequestDTO. + The configured component properties + + :param properties: The properties of this VerifyConfigRequestDTO. + :type: dict(str, str) + """ + + self._properties = properties + + @property + def request_id(self): + """ + Gets the request_id of this VerifyConfigRequestDTO. + The ID of the request + + :return: The request_id of this VerifyConfigRequestDTO. :rtype: str """ - return self._failure_reason + return self._request_id - @failure_reason.setter - def failure_reason(self, failure_reason): + @request_id.setter + def request_id(self, request_id): """ - Sets the failure_reason of this VerifyConfigRequestDTO. - The reason for the request failing, or null if the request has not failed + Sets the request_id of this VerifyConfigRequestDTO. + The ID of the request - :param failure_reason: The failure_reason of this VerifyConfigRequestDTO. + :param request_id: The request_id of this VerifyConfigRequestDTO. :type: str """ - self._failure_reason = failure_reason + self._request_id = request_id @property - def percent_completed(self): + def results(self): """ - Gets the percent_completed of this VerifyConfigRequestDTO. - A value between 0 and 100 (inclusive) indicating how close the request is to completion + Gets the results of this VerifyConfigRequestDTO. + The Results of the verification - :return: The percent_completed of this VerifyConfigRequestDTO. - :rtype: int + :return: The results of this VerifyConfigRequestDTO. + :rtype: list[ConfigVerificationResultDTO] """ - return self._percent_completed + return self._results - @percent_completed.setter - def percent_completed(self, percent_completed): + @results.setter + def results(self, results): """ - Sets the percent_completed of this VerifyConfigRequestDTO. - A value between 0 and 100 (inclusive) indicating how close the request is to completion + Sets the results of this VerifyConfigRequestDTO. + The Results of the verification - :param percent_completed: The percent_completed of this VerifyConfigRequestDTO. - :type: int + :param results: The results of this VerifyConfigRequestDTO. + :type: list[ConfigVerificationResultDTO] """ - self._percent_completed = percent_completed + self._results = results @property def state(self): @@ -289,6 +332,29 @@ def state(self, state): self._state = state + @property + def submission_time(self): + """ + Gets the submission_time of this VerifyConfigRequestDTO. + The timestamp of when the request was submitted + + :return: The submission_time of this VerifyConfigRequestDTO. + :rtype: datetime + """ + return self._submission_time + + @submission_time.setter + def submission_time(self, submission_time): + """ + Sets the submission_time of this VerifyConfigRequestDTO. + The timestamp of when the request was submitted + + :param submission_time: The submission_time of this VerifyConfigRequestDTO. + :type: datetime + """ + + self._submission_time = submission_time + @property def update_steps(self): """ @@ -313,96 +379,27 @@ def update_steps(self, update_steps): self._update_steps = update_steps @property - def component_id(self): + def uri(self): """ - Gets the component_id of this VerifyConfigRequestDTO. - The ID of the component whose configuration was verified + Gets the uri of this VerifyConfigRequestDTO. + The URI for the request - :return: The component_id of this VerifyConfigRequestDTO. + :return: The uri of this VerifyConfigRequestDTO. :rtype: str """ - return self._component_id + return self._uri - @component_id.setter - def component_id(self, component_id): + @uri.setter + def uri(self, uri): """ - Sets the component_id of this VerifyConfigRequestDTO. - The ID of the component whose configuration was verified + Sets the uri of this VerifyConfigRequestDTO. + The URI for the request - :param component_id: The component_id of this VerifyConfigRequestDTO. + :param uri: The uri of this VerifyConfigRequestDTO. :type: str """ - self._component_id = component_id - - @property - def properties(self): - """ - Gets the properties of this VerifyConfigRequestDTO. - The configured component properties - - :return: The properties of this VerifyConfigRequestDTO. - :rtype: dict(str, str) - """ - return self._properties - - @properties.setter - def properties(self, properties): - """ - Sets the properties of this VerifyConfigRequestDTO. - The configured component properties - - :param properties: The properties of this VerifyConfigRequestDTO. - :type: dict(str, str) - """ - - self._properties = properties - - @property - def attributes(self): - """ - Gets the attributes of this VerifyConfigRequestDTO. - FlowFile Attributes that should be used to evaluate Expression Language for resolving property values - - :return: The attributes of this VerifyConfigRequestDTO. - :rtype: dict(str, str) - """ - return self._attributes - - @attributes.setter - def attributes(self, attributes): - """ - Sets the attributes of this VerifyConfigRequestDTO. - FlowFile Attributes that should be used to evaluate Expression Language for resolving property values - - :param attributes: The attributes of this VerifyConfigRequestDTO. - :type: dict(str, str) - """ - - self._attributes = attributes - - @property - def results(self): - """ - Gets the results of this VerifyConfigRequestDTO. - The Results of the verification - - :return: The results of this VerifyConfigRequestDTO. - :rtype: list[ConfigVerificationResultDTO] - """ - return self._results - - @results.setter - def results(self, results): - """ - Sets the results of this VerifyConfigRequestDTO. - The Results of the verification - - :param results: The results of this VerifyConfigRequestDTO. - :type: list[ConfigVerificationResultDTO] - """ - - self._results = results + self._uri = uri def to_dict(self): """ diff --git a/nipyapi/nifi/models/verify_config_request_entity.py b/nipyapi/nifi/models/verify_config_request_entity.py index f7eaead0..aa2cf3da 100644 --- a/nipyapi/nifi/models/verify_config_request_entity.py +++ b/nipyapi/nifi/models/verify_config_request_entity.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,12 +27,10 @@ class VerifyConfigRequestEntity(object): and the value is json key in definition. """ swagger_types = { - 'request': 'VerifyConfigRequestDTO' - } + 'request': 'VerifyConfigRequestDTO' } attribute_map = { - 'request': 'request' - } + 'request': 'request' } def __init__(self, request=None): """ @@ -49,7 +46,6 @@ def __init__(self, request=None): def request(self): """ Gets the request of this VerifyConfigRequestEntity. - The request :return: The request of this VerifyConfigRequestEntity. :rtype: VerifyConfigRequestDTO @@ -60,7 +56,6 @@ def request(self): def request(self, request): """ Sets the request of this VerifyConfigRequestEntity. - The request :param request: The request of this VerifyConfigRequestEntity. :type: VerifyConfigRequestDTO diff --git a/nipyapi/nifi/models/verify_config_update_step_dto.py b/nipyapi/nifi/models/verify_config_update_step_dto.py index d46ac189..28c39535 100644 --- a/nipyapi/nifi/models/verify_config_update_step_dto.py +++ b/nipyapi/nifi/models/verify_config_update_step_dto.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,56 +27,31 @@ class VerifyConfigUpdateStepDTO(object): and the value is json key in definition. """ swagger_types = { - 'description': 'str', 'complete': 'bool', - 'failure_reason': 'str' - } +'description': 'str', +'failure_reason': 'str' } attribute_map = { - 'description': 'description', 'complete': 'complete', - 'failure_reason': 'failureReason' - } +'description': 'description', +'failure_reason': 'failureReason' } - def __init__(self, description=None, complete=None, failure_reason=None): + def __init__(self, complete=None, description=None, failure_reason=None): """ VerifyConfigUpdateStepDTO - a model defined in Swagger """ - self._description = None self._complete = None + self._description = None self._failure_reason = None - if description is not None: - self.description = description 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 description(self): - """ - Gets the description of this VerifyConfigUpdateStepDTO. - Explanation of what happens in this step - - :return: The description of this VerifyConfigUpdateStepDTO. - :rtype: str - """ - return self._description - - @description.setter - def description(self, description): - """ - Sets the description of this VerifyConfigUpdateStepDTO. - Explanation of what happens in this step - - :param description: The description of this VerifyConfigUpdateStepDTO. - :type: str - """ - - self._description = description - @property def complete(self): """ @@ -101,6 +75,29 @@ def complete(self, complete): self._complete = complete + @property + def description(self): + """ + Gets the description of this VerifyConfigUpdateStepDTO. + Explanation of what happens in this step + + :return: The description of this VerifyConfigUpdateStepDTO. + :rtype: str + """ + return self._description + + @description.setter + def description(self, description): + """ + Sets the description of this VerifyConfigUpdateStepDTO. + Explanation of what happens in this step + + :param description: The description of this VerifyConfigUpdateStepDTO. + :type: str + """ + + self._description = description + @property def failure_reason(self): """ diff --git a/nipyapi/nifi/models/version_control_component_mapping_entity.py b/nipyapi/nifi/models/version_control_component_mapping_entity.py index 3d041b6e..b8de7fdc 100644 --- a/nipyapi/nifi/models/version_control_component_mapping_entity.py +++ b/nipyapi/nifi/models/version_control_component_mapping_entity.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,66 +27,63 @@ class VersionControlComponentMappingEntity(object): and the value is json key in definition. """ swagger_types = { - 'version_control_component_mapping': 'dict(str, str)', - 'process_group_revision': 'RevisionDTO', 'disconnected_node_acknowledged': 'bool', - 'version_control_information': 'VersionControlInformationDTO' - } +'process_group_revision': 'RevisionDTO', +'version_control_component_mapping': 'dict(str, str)', +'version_control_information': 'VersionControlInformationDTO' } attribute_map = { - 'version_control_component_mapping': 'versionControlComponentMapping', - 'process_group_revision': 'processGroupRevision', 'disconnected_node_acknowledged': 'disconnectedNodeAcknowledged', - 'version_control_information': 'versionControlInformation' - } +'process_group_revision': 'processGroupRevision', +'version_control_component_mapping': 'versionControlComponentMapping', +'version_control_information': 'versionControlInformation' } - def __init__(self, version_control_component_mapping=None, process_group_revision=None, disconnected_node_acknowledged=None, version_control_information=None): + def __init__(self, disconnected_node_acknowledged=None, process_group_revision=None, version_control_component_mapping=None, version_control_information=None): """ VersionControlComponentMappingEntity - a model defined in Swagger """ - self._version_control_component_mapping = None - self._process_group_revision = None self._disconnected_node_acknowledged = None + self._process_group_revision = None + self._version_control_component_mapping = None self._version_control_information = None - if version_control_component_mapping is not None: - self.version_control_component_mapping = version_control_component_mapping - if process_group_revision is not None: - self.process_group_revision = process_group_revision if disconnected_node_acknowledged is not None: self.disconnected_node_acknowledged = disconnected_node_acknowledged + if process_group_revision is not None: + self.process_group_revision = process_group_revision + if version_control_component_mapping is not None: + self.version_control_component_mapping = version_control_component_mapping if version_control_information is not None: self.version_control_information = version_control_information @property - def version_control_component_mapping(self): + def disconnected_node_acknowledged(self): """ - Gets the version_control_component_mapping of this VersionControlComponentMappingEntity. - The mapping of Versioned Component Identifiers to instance ID's + Gets the disconnected_node_acknowledged of this VersionControlComponentMappingEntity. + Acknowledges that this node is disconnected to allow for mutable requests to proceed. - :return: The version_control_component_mapping of this VersionControlComponentMappingEntity. - :rtype: dict(str, str) + :return: The disconnected_node_acknowledged of this VersionControlComponentMappingEntity. + :rtype: bool """ - return self._version_control_component_mapping + return self._disconnected_node_acknowledged - @version_control_component_mapping.setter - def version_control_component_mapping(self, version_control_component_mapping): + @disconnected_node_acknowledged.setter + def disconnected_node_acknowledged(self, disconnected_node_acknowledged): """ - Sets the version_control_component_mapping of this VersionControlComponentMappingEntity. - The mapping of Versioned Component Identifiers to instance ID's + Sets the disconnected_node_acknowledged of this VersionControlComponentMappingEntity. + Acknowledges that this node is disconnected to allow for mutable requests to proceed. - :param version_control_component_mapping: The version_control_component_mapping of this VersionControlComponentMappingEntity. - :type: dict(str, str) + :param disconnected_node_acknowledged: The disconnected_node_acknowledged of this VersionControlComponentMappingEntity. + :type: bool """ - self._version_control_component_mapping = version_control_component_mapping + self._disconnected_node_acknowledged = disconnected_node_acknowledged @property def process_group_revision(self): """ Gets the process_group_revision of this VersionControlComponentMappingEntity. - The revision of the Process Group :return: The process_group_revision of this VersionControlComponentMappingEntity. :rtype: RevisionDTO @@ -98,7 +94,6 @@ def process_group_revision(self): def process_group_revision(self, process_group_revision): """ Sets the process_group_revision of this VersionControlComponentMappingEntity. - The revision of the Process Group :param process_group_revision: The process_group_revision of this VersionControlComponentMappingEntity. :type: RevisionDTO @@ -107,33 +102,32 @@ def process_group_revision(self, process_group_revision): self._process_group_revision = process_group_revision @property - def disconnected_node_acknowledged(self): + def version_control_component_mapping(self): """ - Gets the disconnected_node_acknowledged of this VersionControlComponentMappingEntity. - Acknowledges that this node is disconnected to allow for mutable requests to proceed. + Gets the version_control_component_mapping of this VersionControlComponentMappingEntity. + The mapping of Versioned Component Identifiers to instance ID's - :return: The disconnected_node_acknowledged of this VersionControlComponentMappingEntity. - :rtype: bool + :return: The version_control_component_mapping of this VersionControlComponentMappingEntity. + :rtype: dict(str, str) """ - return self._disconnected_node_acknowledged + return self._version_control_component_mapping - @disconnected_node_acknowledged.setter - def disconnected_node_acknowledged(self, disconnected_node_acknowledged): + @version_control_component_mapping.setter + def version_control_component_mapping(self, version_control_component_mapping): """ - Sets the disconnected_node_acknowledged of this VersionControlComponentMappingEntity. - Acknowledges that this node is disconnected to allow for mutable requests to proceed. + Sets the version_control_component_mapping of this VersionControlComponentMappingEntity. + The mapping of Versioned Component Identifiers to instance ID's - :param disconnected_node_acknowledged: The disconnected_node_acknowledged of this VersionControlComponentMappingEntity. - :type: bool + :param version_control_component_mapping: The version_control_component_mapping of this VersionControlComponentMappingEntity. + :type: dict(str, str) """ - self._disconnected_node_acknowledged = disconnected_node_acknowledged + self._version_control_component_mapping = version_control_component_mapping @property def version_control_information(self): """ Gets the version_control_information of this VersionControlComponentMappingEntity. - The Version Control information :return: The version_control_information of this VersionControlComponentMappingEntity. :rtype: VersionControlInformationDTO @@ -144,7 +138,6 @@ def version_control_information(self): def version_control_information(self, version_control_information): """ Sets the version_control_information of this VersionControlComponentMappingEntity. - The Version Control information :param version_control_information: The version_control_information of this VersionControlComponentMappingEntity. :type: VersionControlInformationDTO diff --git a/nipyapi/nifi/models/version_control_information_dto.py b/nipyapi/nifi/models/version_control_information_dto.py index d7edd124..475d063a 100644 --- a/nipyapi/nifi/models/version_control_information_dto.py +++ b/nipyapi/nifi/models/version_control_information_dto.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,146 +27,103 @@ class VersionControlInformationDTO(object): and the value is json key in definition. """ swagger_types = { - 'group_id': 'str', - 'registry_id': 'str', - 'registry_name': 'str', - 'bucket_id': 'str', - 'bucket_name': 'str', - 'flow_id': 'str', - 'flow_name': 'str', - 'flow_description': 'str', - 'version': 'int', - 'storage_location': 'str', - 'state': 'str', - 'state_explanation': 'str' - } + 'branch': 'str', +'bucket_id': 'str', +'bucket_name': 'str', +'flow_description': 'str', +'flow_id': 'str', +'flow_name': 'str', +'group_id': 'str', +'registry_id': 'str', +'registry_name': 'str', +'state': 'str', +'state_explanation': 'str', +'storage_location': 'str', +'version': 'str' } attribute_map = { - 'group_id': 'groupId', - 'registry_id': 'registryId', - 'registry_name': 'registryName', - 'bucket_id': 'bucketId', - 'bucket_name': 'bucketName', - 'flow_id': 'flowId', - 'flow_name': 'flowName', - 'flow_description': 'flowDescription', - 'version': 'version', - 'storage_location': 'storageLocation', - 'state': 'state', - 'state_explanation': 'stateExplanation' - } - - def __init__(self, group_id=None, registry_id=None, registry_name=None, bucket_id=None, bucket_name=None, flow_id=None, flow_name=None, flow_description=None, version=None, storage_location=None, state=None, state_explanation=None): + 'branch': 'branch', +'bucket_id': 'bucketId', +'bucket_name': 'bucketName', +'flow_description': 'flowDescription', +'flow_id': 'flowId', +'flow_name': 'flowName', +'group_id': 'groupId', +'registry_id': 'registryId', +'registry_name': 'registryName', +'state': 'state', +'state_explanation': 'stateExplanation', +'storage_location': 'storageLocation', +'version': 'version' } + + def __init__(self, branch=None, bucket_id=None, bucket_name=None, flow_description=None, flow_id=None, flow_name=None, group_id=None, registry_id=None, registry_name=None, state=None, state_explanation=None, storage_location=None, version=None): """ VersionControlInformationDTO - a model defined in Swagger """ - self._group_id = None - self._registry_id = None - self._registry_name = None + self._branch = None self._bucket_id = None self._bucket_name = None + self._flow_description = None self._flow_id = None self._flow_name = None - self._flow_description = None - self._version = None - self._storage_location = None + self._group_id = None + self._registry_id = None + self._registry_name = None self._state = None self._state_explanation = None + self._storage_location = None + self._version = None - if group_id is not None: - self.group_id = group_id - if registry_id is not None: - self.registry_id = registry_id - if registry_name is not None: - self.registry_name = registry_name + if branch is not None: + self.branch = branch if bucket_id is not None: self.bucket_id = bucket_id if bucket_name is not None: self.bucket_name = bucket_name + if flow_description is not None: + self.flow_description = flow_description if flow_id is not None: self.flow_id = flow_id if flow_name is not None: self.flow_name = flow_name - if flow_description is not None: - self.flow_description = flow_description - if version is not None: - self.version = version - if storage_location is not None: - self.storage_location = storage_location + if group_id is not None: + self.group_id = group_id + if registry_id is not None: + self.registry_id = registry_id + if registry_name is not None: + self.registry_name = registry_name if state is not None: self.state = state if state_explanation is not None: self.state_explanation = state_explanation + if storage_location is not None: + self.storage_location = storage_location + if version is not None: + self.version = version @property - def group_id(self): - """ - Gets the group_id of this VersionControlInformationDTO. - The ID of the Process Group that is under version control - - :return: The group_id of this VersionControlInformationDTO. - :rtype: str - """ - return self._group_id - - @group_id.setter - def group_id(self, group_id): - """ - Sets the group_id of this VersionControlInformationDTO. - The ID of the Process Group that is under version control - - :param group_id: The group_id of this VersionControlInformationDTO. - :type: str - """ - - self._group_id = group_id - - @property - def registry_id(self): - """ - Gets the registry_id of this VersionControlInformationDTO. - The ID of the registry that the flow is stored in - - :return: The registry_id of this VersionControlInformationDTO. - :rtype: str - """ - return self._registry_id - - @registry_id.setter - def registry_id(self, registry_id): - """ - Sets the registry_id of this VersionControlInformationDTO. - The ID of the registry that the flow is stored in - - :param registry_id: The registry_id of this VersionControlInformationDTO. - :type: str - """ - - self._registry_id = registry_id - - @property - def registry_name(self): + def branch(self): """ - Gets the registry_name of this VersionControlInformationDTO. - The name of the registry that the flow is stored in + Gets the branch of this VersionControlInformationDTO. + The ID of the branch that the flow is stored in - :return: The registry_name of this VersionControlInformationDTO. + :return: The branch of this VersionControlInformationDTO. :rtype: str """ - return self._registry_name + return self._branch - @registry_name.setter - def registry_name(self, registry_name): + @branch.setter + def branch(self, branch): """ - Sets the registry_name of this VersionControlInformationDTO. - The name of the registry that the flow is stored in + Sets the branch of this VersionControlInformationDTO. + The ID of the branch that the flow is stored in - :param registry_name: The registry_name of this VersionControlInformationDTO. + :param branch: The branch of this VersionControlInformationDTO. :type: str """ - self._registry_name = registry_name + self._branch = branch @property def bucket_id(self): @@ -215,6 +171,29 @@ def bucket_name(self, bucket_name): self._bucket_name = bucket_name + @property + def flow_description(self): + """ + Gets the flow_description of this VersionControlInformationDTO. + The description of the flow + + :return: The flow_description of this VersionControlInformationDTO. + :rtype: str + """ + return self._flow_description + + @flow_description.setter + def flow_description(self, flow_description): + """ + Sets the flow_description of this VersionControlInformationDTO. + The description of the flow + + :param flow_description: The flow_description of this VersionControlInformationDTO. + :type: str + """ + + self._flow_description = flow_description + @property def flow_id(self): """ @@ -262,73 +241,73 @@ def flow_name(self, flow_name): self._flow_name = flow_name @property - def flow_description(self): + def group_id(self): """ - Gets the flow_description of this VersionControlInformationDTO. - The description of the flow + Gets the group_id of this VersionControlInformationDTO. + The ID of the Process Group that is under version control - :return: The flow_description of this VersionControlInformationDTO. + :return: The group_id of this VersionControlInformationDTO. :rtype: str """ - return self._flow_description + return self._group_id - @flow_description.setter - def flow_description(self, flow_description): + @group_id.setter + def group_id(self, group_id): """ - Sets the flow_description of this VersionControlInformationDTO. - The description of the flow + Sets the group_id of this VersionControlInformationDTO. + The ID of the Process Group that is under version control - :param flow_description: The flow_description of this VersionControlInformationDTO. + :param group_id: The group_id of this VersionControlInformationDTO. :type: str """ - self._flow_description = flow_description + self._group_id = group_id @property - def version(self): + def registry_id(self): """ - Gets the version of this VersionControlInformationDTO. - The version of the flow + Gets the registry_id of this VersionControlInformationDTO. + The ID of the registry that the flow is stored in - :return: The version of this VersionControlInformationDTO. - :rtype: int + :return: The registry_id of this VersionControlInformationDTO. + :rtype: str """ - return self._version + return self._registry_id - @version.setter - def version(self, version): + @registry_id.setter + def registry_id(self, registry_id): """ - Sets the version of this VersionControlInformationDTO. - The version of the flow + Sets the registry_id of this VersionControlInformationDTO. + The ID of the registry that the flow is stored in - :param version: The version of this VersionControlInformationDTO. - :type: int + :param registry_id: The registry_id of this VersionControlInformationDTO. + :type: str """ - self._version = version + self._registry_id = registry_id @property - def storage_location(self): + def registry_name(self): """ - Gets the storage_location of this VersionControlInformationDTO. - The storage location + Gets the registry_name of this VersionControlInformationDTO. + The name of the registry that the flow is stored in - :return: The storage_location of this VersionControlInformationDTO. + :return: The registry_name of this VersionControlInformationDTO. :rtype: str """ - return self._storage_location + return self._registry_name - @storage_location.setter - def storage_location(self, storage_location): + @registry_name.setter + def registry_name(self, registry_name): """ - Sets the storage_location of this VersionControlInformationDTO. - The storage location + Sets the registry_name of this VersionControlInformationDTO. + The name of the registry that the flow is stored in - :param storage_location: The storage_location of this VersionControlInformationDTO. + :param registry_name: The registry_name of this VersionControlInformationDTO. :type: str """ - self._storage_location = storage_location + self._registry_name = registry_name @property def state(self): @@ -350,7 +329,7 @@ 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"] + 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}" @@ -382,6 +361,52 @@ def state_explanation(self, state_explanation): self._state_explanation = state_explanation + @property + def storage_location(self): + """ + Gets the storage_location of this VersionControlInformationDTO. + The storage location + + :return: The storage_location of this VersionControlInformationDTO. + :rtype: str + """ + return self._storage_location + + @storage_location.setter + def storage_location(self, storage_location): + """ + Sets the storage_location of this VersionControlInformationDTO. + The storage location + + :param storage_location: The storage_location of this VersionControlInformationDTO. + :type: str + """ + + self._storage_location = storage_location + + @property + def version(self): + """ + Gets the version of this VersionControlInformationDTO. + The version of the flow + + :return: The version of this VersionControlInformationDTO. + :rtype: str + """ + return self._version + + @version.setter + def version(self, version): + """ + Sets the version of this VersionControlInformationDTO. + The version of the flow + + :param version: The version of this VersionControlInformationDTO. + :type: str + """ + + self._version = version + def to_dict(self): """ Returns the model properties as a dict diff --git a/nipyapi/nifi/models/version_control_information_entity.py b/nipyapi/nifi/models/version_control_information_entity.py index 51b7e5e8..455871a6 100644 --- a/nipyapi/nifi/models/version_control_information_entity.py +++ b/nipyapi/nifi/models/version_control_information_entity.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,56 +27,31 @@ class VersionControlInformationEntity(object): and the value is json key in definition. """ swagger_types = { - 'process_group_revision': 'RevisionDTO', 'disconnected_node_acknowledged': 'bool', - 'version_control_information': 'VersionControlInformationDTO' - } +'process_group_revision': 'RevisionDTO', +'version_control_information': 'VersionControlInformationDTO' } attribute_map = { - 'process_group_revision': 'processGroupRevision', 'disconnected_node_acknowledged': 'disconnectedNodeAcknowledged', - 'version_control_information': 'versionControlInformation' - } +'process_group_revision': 'processGroupRevision', +'version_control_information': 'versionControlInformation' } - def __init__(self, process_group_revision=None, disconnected_node_acknowledged=None, version_control_information=None): + def __init__(self, disconnected_node_acknowledged=None, process_group_revision=None, version_control_information=None): """ VersionControlInformationEntity - a model defined in Swagger """ - self._process_group_revision = None self._disconnected_node_acknowledged = None + self._process_group_revision = None self._version_control_information = None - if process_group_revision is not None: - self.process_group_revision = process_group_revision if disconnected_node_acknowledged is not None: self.disconnected_node_acknowledged = disconnected_node_acknowledged + if process_group_revision is not None: + self.process_group_revision = process_group_revision if version_control_information is not None: self.version_control_information = version_control_information - @property - def process_group_revision(self): - """ - Gets the process_group_revision of this VersionControlInformationEntity. - The Revision for the Process Group - - :return: The process_group_revision of this VersionControlInformationEntity. - :rtype: RevisionDTO - """ - return self._process_group_revision - - @process_group_revision.setter - def process_group_revision(self, process_group_revision): - """ - Sets the process_group_revision of this VersionControlInformationEntity. - The Revision for the Process Group - - :param process_group_revision: The process_group_revision of this VersionControlInformationEntity. - :type: RevisionDTO - """ - - self._process_group_revision = process_group_revision - @property def disconnected_node_acknowledged(self): """ @@ -101,11 +75,31 @@ def disconnected_node_acknowledged(self, disconnected_node_acknowledged): self._disconnected_node_acknowledged = disconnected_node_acknowledged + @property + def process_group_revision(self): + """ + Gets the process_group_revision of this VersionControlInformationEntity. + + :return: The process_group_revision of this VersionControlInformationEntity. + :rtype: RevisionDTO + """ + return self._process_group_revision + + @process_group_revision.setter + def process_group_revision(self, process_group_revision): + """ + Sets the process_group_revision of this VersionControlInformationEntity. + + :param process_group_revision: The process_group_revision of this VersionControlInformationEntity. + :type: RevisionDTO + """ + + self._process_group_revision = process_group_revision + @property def version_control_information(self): """ Gets the version_control_information of this VersionControlInformationEntity. - The Version Control information :return: The version_control_information of this VersionControlInformationEntity. :rtype: VersionControlInformationDTO @@ -116,7 +110,6 @@ def version_control_information(self): def version_control_information(self, version_control_information): """ Sets the version_control_information of this VersionControlInformationEntity. - The Version Control information :param version_control_information: The version_control_information of this VersionControlInformationEntity. :type: VersionControlInformationDTO diff --git a/nipyapi/nifi/models/version_info_dto.py b/nipyapi/nifi/models/version_info_dto.py index 56059043..1284df24 100644 --- a/nipyapi/nifi/models/version_info_dto.py +++ b/nipyapi/nifi/models/version_info_dto.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,90 +27,157 @@ class VersionInfoDTO(object): and the value is json key in definition. """ swagger_types = { - 'ni_fi_version': 'str', - 'java_vendor': 'str', - 'java_version': 'str', - 'os_name': 'str', - 'os_version': 'str', - 'os_architecture': 'str', - 'build_tag': 'str', - 'build_revision': 'str', 'build_branch': 'str', - 'build_timestamp': 'datetime' - } +'build_revision': 'str', +'build_tag': 'str', +'build_timestamp': 'datetime', +'java_vendor': 'str', +'java_version': 'str', +'ni_fi_version': 'str', +'os_architecture': 'str', +'os_name': 'str', +'os_version': 'str' } attribute_map = { - 'ni_fi_version': 'niFiVersion', - 'java_vendor': 'javaVendor', - 'java_version': 'javaVersion', - 'os_name': 'osName', - 'os_version': 'osVersion', - 'os_architecture': 'osArchitecture', - 'build_tag': 'buildTag', - 'build_revision': 'buildRevision', 'build_branch': 'buildBranch', - 'build_timestamp': 'buildTimestamp' - } - - def __init__(self, ni_fi_version=None, java_vendor=None, java_version=None, os_name=None, os_version=None, os_architecture=None, build_tag=None, build_revision=None, build_branch=None, build_timestamp=None): +'build_revision': 'buildRevision', +'build_tag': 'buildTag', +'build_timestamp': 'buildTimestamp', +'java_vendor': 'javaVendor', +'java_version': 'javaVersion', +'ni_fi_version': 'niFiVersion', +'os_architecture': 'osArchitecture', +'os_name': 'osName', +'os_version': 'osVersion' } + + def __init__(self, build_branch=None, build_revision=None, build_tag=None, build_timestamp=None, java_vendor=None, java_version=None, ni_fi_version=None, os_architecture=None, os_name=None, os_version=None): """ VersionInfoDTO - a model defined in Swagger """ - self._ni_fi_version = None + self._build_branch = None + self._build_revision = None + self._build_tag = None + self._build_timestamp = None self._java_vendor = None self._java_version = None + self._ni_fi_version = None + self._os_architecture = None self._os_name = None self._os_version = None - self._os_architecture = None - self._build_tag = None - self._build_revision = None - self._build_branch = None - self._build_timestamp = None - if ni_fi_version is not None: - self.ni_fi_version = ni_fi_version + if build_branch is not None: + self.build_branch = build_branch + if build_revision is not None: + self.build_revision = build_revision + if build_tag is not None: + self.build_tag = build_tag + if build_timestamp is not None: + self.build_timestamp = build_timestamp if java_vendor is not None: self.java_vendor = java_vendor if java_version is not None: self.java_version = java_version + if ni_fi_version is not None: + self.ni_fi_version = ni_fi_version + if os_architecture is not None: + self.os_architecture = os_architecture if os_name is not None: self.os_name = os_name if os_version is not None: self.os_version = os_version - if os_architecture is not None: - self.os_architecture = os_architecture - if build_tag is not None: - self.build_tag = build_tag - if build_revision is not None: - self.build_revision = build_revision - if build_branch is not None: - self.build_branch = build_branch - if build_timestamp is not None: - self.build_timestamp = build_timestamp @property - def ni_fi_version(self): + def build_branch(self): """ - Gets the ni_fi_version of this VersionInfoDTO. - The version of this NiFi. + Gets the build_branch of this VersionInfoDTO. + Build branch - :return: The ni_fi_version of this VersionInfoDTO. + :return: The build_branch of this VersionInfoDTO. :rtype: str """ - return self._ni_fi_version + return self._build_branch - @ni_fi_version.setter - def ni_fi_version(self, ni_fi_version): + @build_branch.setter + def build_branch(self, build_branch): """ - Sets the ni_fi_version of this VersionInfoDTO. - The version of this NiFi. + Sets the build_branch of this VersionInfoDTO. + Build branch - :param ni_fi_version: The ni_fi_version of this VersionInfoDTO. + :param build_branch: The build_branch of this VersionInfoDTO. :type: str """ - self._ni_fi_version = ni_fi_version + self._build_branch = build_branch + + @property + def build_revision(self): + """ + Gets the build_revision of this VersionInfoDTO. + Build revision or commit hash + + :return: The build_revision of this VersionInfoDTO. + :rtype: str + """ + return self._build_revision + + @build_revision.setter + def build_revision(self, build_revision): + """ + Sets the build_revision of this VersionInfoDTO. + Build revision or commit hash + + :param build_revision: The build_revision of this VersionInfoDTO. + :type: str + """ + + self._build_revision = build_revision + + @property + def build_tag(self): + """ + Gets the build_tag of this VersionInfoDTO. + Build tag + + :return: The build_tag of this VersionInfoDTO. + :rtype: str + """ + return self._build_tag + + @build_tag.setter + def build_tag(self, build_tag): + """ + Sets the build_tag of this VersionInfoDTO. + Build tag + + :param build_tag: The build_tag of this VersionInfoDTO. + :type: str + """ + + self._build_tag = build_tag + + @property + def build_timestamp(self): + """ + Gets the build_timestamp of this VersionInfoDTO. + Build timestamp + + :return: The build_timestamp of this VersionInfoDTO. + :rtype: datetime + """ + return self._build_timestamp + + @build_timestamp.setter + def build_timestamp(self, build_timestamp): + """ + Sets the build_timestamp of this VersionInfoDTO. + Build timestamp + + :param build_timestamp: The build_timestamp of this VersionInfoDTO. + :type: datetime + """ + + self._build_timestamp = build_timestamp @property def java_vendor(self): @@ -160,50 +226,27 @@ def java_version(self, java_version): self._java_version = java_version @property - def os_name(self): - """ - Gets the os_name of this VersionInfoDTO. - Host operating system name - - :return: The os_name of this VersionInfoDTO. - :rtype: str - """ - return self._os_name - - @os_name.setter - def os_name(self, os_name): - """ - Sets the os_name of this VersionInfoDTO. - Host operating system name - - :param os_name: The os_name of this VersionInfoDTO. - :type: str - """ - - self._os_name = os_name - - @property - def os_version(self): + def ni_fi_version(self): """ - Gets the os_version of this VersionInfoDTO. - Host operating system version + Gets the ni_fi_version of this VersionInfoDTO. + The version of this NiFi. - :return: The os_version of this VersionInfoDTO. + :return: The ni_fi_version of this VersionInfoDTO. :rtype: str """ - return self._os_version + return self._ni_fi_version - @os_version.setter - def os_version(self, os_version): + @ni_fi_version.setter + def ni_fi_version(self, ni_fi_version): """ - Sets the os_version of this VersionInfoDTO. - Host operating system version + Sets the ni_fi_version of this VersionInfoDTO. + The version of this NiFi. - :param os_version: The os_version of this VersionInfoDTO. + :param ni_fi_version: The ni_fi_version of this VersionInfoDTO. :type: str """ - self._os_version = os_version + self._ni_fi_version = ni_fi_version @property def os_architecture(self): @@ -229,96 +272,50 @@ def os_architecture(self, os_architecture): self._os_architecture = os_architecture @property - def build_tag(self): - """ - Gets the build_tag of this VersionInfoDTO. - Build tag - - :return: The build_tag of this VersionInfoDTO. - :rtype: str - """ - return self._build_tag - - @build_tag.setter - def build_tag(self, build_tag): - """ - Sets the build_tag of this VersionInfoDTO. - Build tag - - :param build_tag: The build_tag of this VersionInfoDTO. - :type: str - """ - - self._build_tag = build_tag - - @property - def build_revision(self): + def os_name(self): """ - Gets the build_revision of this VersionInfoDTO. - Build revision or commit hash + Gets the os_name of this VersionInfoDTO. + Host operating system name - :return: The build_revision of this VersionInfoDTO. + :return: The os_name of this VersionInfoDTO. :rtype: str """ - return self._build_revision + return self._os_name - @build_revision.setter - def build_revision(self, build_revision): + @os_name.setter + def os_name(self, os_name): """ - Sets the build_revision of this VersionInfoDTO. - Build revision or commit hash + Sets the os_name of this VersionInfoDTO. + Host operating system name - :param build_revision: The build_revision of this VersionInfoDTO. + :param os_name: The os_name of this VersionInfoDTO. :type: str """ - self._build_revision = build_revision + self._os_name = os_name @property - def build_branch(self): + def os_version(self): """ - Gets the build_branch of this VersionInfoDTO. - Build branch + Gets the os_version of this VersionInfoDTO. + Host operating system version - :return: The build_branch of this VersionInfoDTO. + :return: The os_version of this VersionInfoDTO. :rtype: str """ - return self._build_branch + return self._os_version - @build_branch.setter - def build_branch(self, build_branch): + @os_version.setter + def os_version(self, os_version): """ - Sets the build_branch of this VersionInfoDTO. - Build branch + Sets the os_version of this VersionInfoDTO. + Host operating system version - :param build_branch: The build_branch of this VersionInfoDTO. + :param os_version: The os_version of this VersionInfoDTO. :type: str """ - self._build_branch = build_branch - - @property - def build_timestamp(self): - """ - Gets the build_timestamp of this VersionInfoDTO. - Build timestamp - - :return: The build_timestamp of this VersionInfoDTO. - :rtype: datetime - """ - return self._build_timestamp - - @build_timestamp.setter - def build_timestamp(self, build_timestamp): - """ - Sets the build_timestamp of this VersionInfoDTO. - Build timestamp - - :param build_timestamp: The build_timestamp of this VersionInfoDTO. - :type: datetime - """ - - self._build_timestamp = build_timestamp + self._os_version = os_version def to_dict(self): """ diff --git a/nipyapi/nifi/models/versioned_asset.py b/nipyapi/nifi/models/versioned_asset.py new file mode 100644 index 00000000..dede58ce --- /dev/null +++ b/nipyapi/nifi/models/versioned_asset.py @@ -0,0 +1,147 @@ +""" + Apache NiFi REST API + + REST API definition for Apache NiFi web services + + OpenAPI spec version: 2.5.0 + Contact: dev@nifi.apache.org + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from pprint import pformat +import re + + +class VersionedAsset(object): + """ + NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. + """ + + + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'identifier': 'str', +'name': 'str' } + + attribute_map = { + 'identifier': 'identifier', +'name': 'name' } + + def __init__(self, identifier=None, name=None): + """ + VersionedAsset - a model defined in Swagger + """ + + self._identifier = None + self._name = None + + if identifier is not None: + self.identifier = identifier + if name is not None: + self.name = name + + @property + def identifier(self): + """ + Gets the identifier of this VersionedAsset. + The identifier of the asset + + :return: The identifier of this VersionedAsset. + :rtype: str + """ + return self._identifier + + @identifier.setter + def identifier(self, identifier): + """ + Sets the identifier of this VersionedAsset. + The identifier of the asset + + :param identifier: The identifier of this VersionedAsset. + :type: str + """ + + self._identifier = identifier + + @property + def name(self): + """ + Gets the name of this VersionedAsset. + The name of the asset + + :return: The name of this VersionedAsset. + :rtype: str + """ + return self._name + + @name.setter + def name(self, name): + """ + Sets the name of this VersionedAsset. + The name of the asset + + :param name: The name of this VersionedAsset. + :type: str + """ + + self._name = name + + 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, VersionedAsset): + 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_connection.py b/nipyapi/nifi/models/versioned_connection.py index 3d25ae66..2235a630 100644 --- a/nipyapi/nifi/models/versioned_connection.py +++ b/nipyapi/nifi/models/versioned_connection.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,186 +27,184 @@ class VersionedConnection(object): and the value is json key in definition. """ swagger_types = { - 'identifier': 'str', - 'instance_identifier': 'str', - 'name': 'str', - 'comments': 'str', - 'position': 'Position', - 'source': 'ConnectableComponent', - 'destination': 'ConnectableComponent', - 'label_index': 'int', - 'z_index': 'int', - 'selected_relationships': 'list[str]', - 'back_pressure_object_threshold': 'int', 'back_pressure_data_size_threshold': 'str', - 'flow_file_expiration': 'str', - 'prioritizers': 'list[str]', - 'bends': 'list[Position]', - 'load_balance_strategy': 'str', - 'partitioning_attribute': 'str', - 'load_balance_compression': 'str', - 'component_type': 'str', - 'group_identifier': 'str' - } +'back_pressure_object_threshold': 'int', +'bends': 'list[Position]', +'comments': 'str', +'component_type': 'str', +'destination': 'ConnectableComponent', +'flow_file_expiration': 'str', +'group_identifier': 'str', +'identifier': 'str', +'instance_identifier': 'str', +'label_index': 'int', +'load_balance_compression': 'str', +'load_balance_strategy': 'str', +'name': 'str', +'partitioning_attribute': 'str', +'position': 'Position', +'prioritizers': 'list[str]', +'selected_relationships': 'list[str]', +'source': 'ConnectableComponent', +'z_index': 'int' } attribute_map = { - 'identifier': 'identifier', - 'instance_identifier': 'instanceIdentifier', - 'name': 'name', - 'comments': 'comments', - 'position': 'position', - 'source': 'source', - 'destination': 'destination', - 'label_index': 'labelIndex', - 'z_index': 'zIndex', - 'selected_relationships': 'selectedRelationships', - 'back_pressure_object_threshold': 'backPressureObjectThreshold', 'back_pressure_data_size_threshold': 'backPressureDataSizeThreshold', - 'flow_file_expiration': 'flowFileExpiration', - 'prioritizers': 'prioritizers', - 'bends': 'bends', - 'load_balance_strategy': 'loadBalanceStrategy', - 'partitioning_attribute': 'partitioningAttribute', - 'load_balance_compression': 'loadBalanceCompression', - 'component_type': 'componentType', - 'group_identifier': 'groupIdentifier' - } - - def __init__(self, identifier=None, instance_identifier=None, name=None, comments=None, position=None, source=None, destination=None, label_index=None, z_index=None, selected_relationships=None, back_pressure_object_threshold=None, back_pressure_data_size_threshold=None, flow_file_expiration=None, prioritizers=None, bends=None, load_balance_strategy=None, partitioning_attribute=None, load_balance_compression=None, component_type=None, group_identifier=None): +'back_pressure_object_threshold': 'backPressureObjectThreshold', +'bends': 'bends', +'comments': 'comments', +'component_type': 'componentType', +'destination': 'destination', +'flow_file_expiration': 'flowFileExpiration', +'group_identifier': 'groupIdentifier', +'identifier': 'identifier', +'instance_identifier': 'instanceIdentifier', +'label_index': 'labelIndex', +'load_balance_compression': 'loadBalanceCompression', +'load_balance_strategy': 'loadBalanceStrategy', +'name': 'name', +'partitioning_attribute': 'partitioningAttribute', +'position': 'position', +'prioritizers': 'prioritizers', +'selected_relationships': 'selectedRelationships', +'source': 'source', +'z_index': 'zIndex' } + + def __init__(self, back_pressure_data_size_threshold=None, back_pressure_object_threshold=None, bends=None, comments=None, component_type=None, destination=None, flow_file_expiration=None, group_identifier=None, identifier=None, instance_identifier=None, label_index=None, load_balance_compression=None, load_balance_strategy=None, name=None, partitioning_attribute=None, position=None, prioritizers=None, selected_relationships=None, source=None, z_index=None): """ VersionedConnection - a model defined in Swagger """ + self._back_pressure_data_size_threshold = None + self._back_pressure_object_threshold = None + self._bends = None + self._comments = None + self._component_type = None + self._destination = None + self._flow_file_expiration = None + self._group_identifier = None self._identifier = None self._instance_identifier = None + self._label_index = None + self._load_balance_compression = None + self._load_balance_strategy = None self._name = None - self._comments = None + self._partitioning_attribute = None self._position = None + self._prioritizers = None + self._selected_relationships = None self._source = None - self._destination = None - self._label_index = None self._z_index = None - self._selected_relationships = None - self._back_pressure_object_threshold = None - self._back_pressure_data_size_threshold = None - self._flow_file_expiration = None - self._prioritizers = None - self._bends = None - self._load_balance_strategy = None - self._partitioning_attribute = None - self._load_balance_compression = None - self._component_type = None - self._group_identifier = None + if back_pressure_data_size_threshold is not None: + self.back_pressure_data_size_threshold = back_pressure_data_size_threshold + if back_pressure_object_threshold is not None: + self.back_pressure_object_threshold = back_pressure_object_threshold + if bends is not None: + self.bends = bends + if comments is not None: + self.comments = comments + if component_type is not None: + self.component_type = component_type + if destination is not None: + self.destination = destination + if flow_file_expiration is not None: + self.flow_file_expiration = flow_file_expiration + if group_identifier is not None: + self.group_identifier = group_identifier if identifier is not None: self.identifier = identifier if instance_identifier is not None: self.instance_identifier = instance_identifier + if label_index is not None: + self.label_index = label_index + if load_balance_compression is not None: + self.load_balance_compression = load_balance_compression + if load_balance_strategy is not None: + self.load_balance_strategy = load_balance_strategy if name is not None: self.name = name - if comments is not None: - self.comments = comments + if partitioning_attribute is not None: + self.partitioning_attribute = partitioning_attribute if position is not None: self.position = position + if prioritizers is not None: + self.prioritizers = prioritizers + if selected_relationships is not None: + self.selected_relationships = selected_relationships if source is not None: self.source = source - if destination is not None: - self.destination = destination - if label_index is not None: - self.label_index = label_index if z_index is not None: self.z_index = z_index - if selected_relationships is not None: - self.selected_relationships = selected_relationships - if back_pressure_object_threshold is not None: - self.back_pressure_object_threshold = back_pressure_object_threshold - if back_pressure_data_size_threshold is not None: - self.back_pressure_data_size_threshold = back_pressure_data_size_threshold - if flow_file_expiration is not None: - self.flow_file_expiration = flow_file_expiration - if prioritizers is not None: - self.prioritizers = prioritizers - if bends is not None: - self.bends = bends - if load_balance_strategy is not None: - self.load_balance_strategy = load_balance_strategy - if partitioning_attribute is not None: - self.partitioning_attribute = partitioning_attribute - if load_balance_compression is not None: - self.load_balance_compression = load_balance_compression - if component_type is not None: - self.component_type = component_type - if group_identifier is not None: - self.group_identifier = group_identifier @property - def identifier(self): + def back_pressure_data_size_threshold(self): """ - Gets the identifier of this VersionedConnection. - The component's unique identifier + Gets the back_pressure_data_size_threshold of this VersionedConnection. + The object data size threshold for determining when back pressure is applied. Updating this value is a passive change in the sense that it won't impact whether existing files over the limit are affected but it does help feeder processors to stop pushing too much into this work queue. - :return: The identifier of this VersionedConnection. + :return: The back_pressure_data_size_threshold of this VersionedConnection. :rtype: str """ - return self._identifier + return self._back_pressure_data_size_threshold - @identifier.setter - def identifier(self, identifier): + @back_pressure_data_size_threshold.setter + def back_pressure_data_size_threshold(self, back_pressure_data_size_threshold): """ - Sets the identifier of this VersionedConnection. - The component's unique identifier + Sets the back_pressure_data_size_threshold of this VersionedConnection. + The object data size threshold for determining when back pressure is applied. Updating this value is a passive change in the sense that it won't impact whether existing files over the limit are affected but it does help feeder processors to stop pushing too much into this work queue. - :param identifier: The identifier of this VersionedConnection. + :param back_pressure_data_size_threshold: The back_pressure_data_size_threshold of this VersionedConnection. :type: str """ - self._identifier = identifier + self._back_pressure_data_size_threshold = back_pressure_data_size_threshold @property - def instance_identifier(self): + def back_pressure_object_threshold(self): """ - Gets the instance_identifier of this VersionedConnection. - The instance ID of an existing component that is described by this VersionedComponent, or null if this is not mapped to an instantiated component + Gets the back_pressure_object_threshold of this VersionedConnection. + The object count threshold for determining when back pressure is applied. Updating this value is a passive change in the sense that it won't impact whether existing files over the limit are affected but it does help feeder processors to stop pushing too much into this work queue. - :return: The instance_identifier of this VersionedConnection. - :rtype: str + :return: The back_pressure_object_threshold of this VersionedConnection. + :rtype: int """ - return self._instance_identifier + return self._back_pressure_object_threshold - @instance_identifier.setter - def instance_identifier(self, instance_identifier): + @back_pressure_object_threshold.setter + def back_pressure_object_threshold(self, back_pressure_object_threshold): """ - Sets the instance_identifier of this VersionedConnection. - The instance ID of an existing component that is described by this VersionedComponent, or null if this is not mapped to an instantiated component + Sets the back_pressure_object_threshold of this VersionedConnection. + The object count threshold for determining when back pressure is applied. Updating this value is a passive change in the sense that it won't impact whether existing files over the limit are affected but it does help feeder processors to stop pushing too much into this work queue. - :param instance_identifier: The instance_identifier of this VersionedConnection. - :type: str + :param back_pressure_object_threshold: The back_pressure_object_threshold of this VersionedConnection. + :type: int """ - self._instance_identifier = instance_identifier + self._back_pressure_object_threshold = back_pressure_object_threshold @property - def name(self): + def bends(self): """ - Gets the name of this VersionedConnection. - The component's name + Gets the bends of this VersionedConnection. + The bend points on the connection. - :return: The name of this VersionedConnection. - :rtype: str + :return: The bends of this VersionedConnection. + :rtype: list[Position] """ - return self._name + return self._bends - @name.setter - def name(self, name): + @bends.setter + def bends(self, bends): """ - Sets the name of this VersionedConnection. - The component's name + Sets the bends of this VersionedConnection. + The bend points on the connection. - :param name: The name of this VersionedConnection. - :type: str + :param bends: The bends of this VersionedConnection. + :type: list[Position] """ - self._name = name + self._bends = bends @property def comments(self): @@ -233,56 +230,36 @@ def comments(self, comments): self._comments = comments @property - def position(self): - """ - Gets the position of this VersionedConnection. - The component's position on the graph - - :return: The position of this VersionedConnection. - :rtype: Position - """ - return self._position - - @position.setter - def position(self, position): - """ - Sets the position of this VersionedConnection. - The component's position on the graph - - :param position: The position of this VersionedConnection. - :type: Position - """ - - self._position = position - - @property - def source(self): + def component_type(self): """ - Gets the source of this VersionedConnection. - The source of the connection. + Gets the component_type of this VersionedConnection. - :return: The source of this VersionedConnection. - :rtype: ConnectableComponent + :return: The component_type of this VersionedConnection. + :rtype: str """ - return self._source + return self._component_type - @source.setter - def source(self, source): + @component_type.setter + def component_type(self, component_type): """ - Sets the source of this VersionedConnection. - The source of the connection. + Sets the component_type of this VersionedConnection. - :param source: The source of this VersionedConnection. - :type: ConnectableComponent + :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", ] + 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._source = source + self._component_type = component_type @property def destination(self): """ Gets the destination of this VersionedConnection. - The destination of the connection. :return: The destination of this VersionedConnection. :rtype: ConnectableComponent @@ -293,7 +270,6 @@ def destination(self): def destination(self, destination): """ Sets the destination of this VersionedConnection. - The destination of the connection. :param destination: The destination of this VersionedConnection. :type: ConnectableComponent @@ -302,188 +278,148 @@ def destination(self, destination): self._destination = destination @property - def label_index(self): + def flow_file_expiration(self): """ - Gets the label_index of this VersionedConnection. - The index of the bend point where to place the connection label. + Gets the flow_file_expiration of this VersionedConnection. + The amount of time a flow file may be in the flow before it will be automatically aged out of the flow. Once a flow file reaches this age it will be terminated from the flow the next time a processor attempts to start work on it. - :return: The label_index of this VersionedConnection. - :rtype: int + :return: The flow_file_expiration of this VersionedConnection. + :rtype: str """ - return self._label_index + return self._flow_file_expiration - @label_index.setter - def label_index(self, label_index): + @flow_file_expiration.setter + def flow_file_expiration(self, flow_file_expiration): """ - Sets the label_index of this VersionedConnection. - The index of the bend point where to place the connection label. + Sets the flow_file_expiration of this VersionedConnection. + The amount of time a flow file may be in the flow before it will be automatically aged out of the flow. Once a flow file reaches this age it will be terminated from the flow the next time a processor attempts to start work on it. - :param label_index: The label_index of this VersionedConnection. - :type: int + :param flow_file_expiration: The flow_file_expiration of this VersionedConnection. + :type: str """ - self._label_index = label_index + self._flow_file_expiration = flow_file_expiration @property - def z_index(self): + def group_identifier(self): """ - Gets the z_index of this VersionedConnection. - The z index of the connection. + Gets the group_identifier of this VersionedConnection. + The ID of the Process Group that this component belongs to - :return: The z_index of this VersionedConnection. - :rtype: int + :return: The group_identifier of this VersionedConnection. + :rtype: str """ - return self._z_index + return self._group_identifier - @z_index.setter - def z_index(self, z_index): + @group_identifier.setter + def group_identifier(self, group_identifier): """ - Sets the z_index of this VersionedConnection. - The z index of the connection. + Sets the group_identifier of this VersionedConnection. + The ID of the Process Group that this component belongs to - :param z_index: The z_index of this VersionedConnection. - :type: int - """ - - self._z_index = z_index - - @property - def selected_relationships(self): - """ - Gets the selected_relationships of this VersionedConnection. - The selected relationship that comprise the connection. - - :return: The selected_relationships of this VersionedConnection. - :rtype: list[str] - """ - return self._selected_relationships - - @selected_relationships.setter - def selected_relationships(self, selected_relationships): - """ - Sets the selected_relationships of this VersionedConnection. - The selected relationship that comprise the connection. - - :param selected_relationships: The selected_relationships of this VersionedConnection. - :type: list[str] - """ - - self._selected_relationships = selected_relationships - - @property - def back_pressure_object_threshold(self): - """ - Gets the back_pressure_object_threshold of this VersionedConnection. - The object count threshold for determining when back pressure is applied. Updating this value is a passive change in the sense that it won't impact whether existing files over the limit are affected but it does help feeder processors to stop pushing too much into this work queue. - - :return: The back_pressure_object_threshold of this VersionedConnection. - :rtype: int - """ - return self._back_pressure_object_threshold - - @back_pressure_object_threshold.setter - def back_pressure_object_threshold(self, back_pressure_object_threshold): - """ - Sets the back_pressure_object_threshold of this VersionedConnection. - The object count threshold for determining when back pressure is applied. Updating this value is a passive change in the sense that it won't impact whether existing files over the limit are affected but it does help feeder processors to stop pushing too much into this work queue. - - :param back_pressure_object_threshold: The back_pressure_object_threshold of this VersionedConnection. - :type: int + :param group_identifier: The group_identifier of this VersionedConnection. + :type: str """ - self._back_pressure_object_threshold = back_pressure_object_threshold + self._group_identifier = group_identifier @property - def back_pressure_data_size_threshold(self): + def identifier(self): """ - Gets the back_pressure_data_size_threshold of this VersionedConnection. - The object data size threshold for determining when back pressure is applied. Updating this value is a passive change in the sense that it won't impact whether existing files over the limit are affected but it does help feeder processors to stop pushing too much into this work queue. + Gets the identifier of this VersionedConnection. + The component's unique identifier - :return: The back_pressure_data_size_threshold of this VersionedConnection. + :return: The identifier of this VersionedConnection. :rtype: str """ - return self._back_pressure_data_size_threshold + return self._identifier - @back_pressure_data_size_threshold.setter - def back_pressure_data_size_threshold(self, back_pressure_data_size_threshold): + @identifier.setter + def identifier(self, identifier): """ - Sets the back_pressure_data_size_threshold of this VersionedConnection. - The object data size threshold for determining when back pressure is applied. Updating this value is a passive change in the sense that it won't impact whether existing files over the limit are affected but it does help feeder processors to stop pushing too much into this work queue. + Sets the identifier of this VersionedConnection. + The component's unique identifier - :param back_pressure_data_size_threshold: The back_pressure_data_size_threshold of this VersionedConnection. + :param identifier: The identifier of this VersionedConnection. :type: str """ - self._back_pressure_data_size_threshold = back_pressure_data_size_threshold + self._identifier = identifier @property - def flow_file_expiration(self): + def instance_identifier(self): """ - Gets the flow_file_expiration of this VersionedConnection. - The amount of time a flow file may be in the flow before it will be automatically aged out of the flow. Once a flow file reaches this age it will be terminated from the flow the next time a processor attempts to start work on it. + Gets the instance_identifier of this VersionedConnection. + The instance ID of an existing component that is described by this VersionedComponent, or null if this is not mapped to an instantiated component - :return: The flow_file_expiration of this VersionedConnection. + :return: The instance_identifier of this VersionedConnection. :rtype: str """ - return self._flow_file_expiration + return self._instance_identifier - @flow_file_expiration.setter - def flow_file_expiration(self, flow_file_expiration): + @instance_identifier.setter + def instance_identifier(self, instance_identifier): """ - Sets the flow_file_expiration of this VersionedConnection. - The amount of time a flow file may be in the flow before it will be automatically aged out of the flow. Once a flow file reaches this age it will be terminated from the flow the next time a processor attempts to start work on it. + Sets the instance_identifier of this VersionedConnection. + The instance ID of an existing component that is described by this VersionedComponent, or null if this is not mapped to an instantiated component - :param flow_file_expiration: The flow_file_expiration of this VersionedConnection. + :param instance_identifier: The instance_identifier of this VersionedConnection. :type: str """ - self._flow_file_expiration = flow_file_expiration + self._instance_identifier = instance_identifier @property - def prioritizers(self): + def label_index(self): """ - Gets the prioritizers of this VersionedConnection. - The comparators used to prioritize the queue. + Gets the label_index of this VersionedConnection. + The index of the bend point where to place the connection label. - :return: The prioritizers of this VersionedConnection. - :rtype: list[str] + :return: The label_index of this VersionedConnection. + :rtype: int """ - return self._prioritizers + return self._label_index - @prioritizers.setter - def prioritizers(self, prioritizers): + @label_index.setter + def label_index(self, label_index): """ - Sets the prioritizers of this VersionedConnection. - The comparators used to prioritize the queue. + Sets the label_index of this VersionedConnection. + The index of the bend point where to place the connection label. - :param prioritizers: The prioritizers of this VersionedConnection. - :type: list[str] + :param label_index: The label_index of this VersionedConnection. + :type: int """ - self._prioritizers = prioritizers + self._label_index = label_index @property - def bends(self): + def load_balance_compression(self): """ - Gets the bends of this VersionedConnection. - The bend points on the connection. + Gets the load_balance_compression of this VersionedConnection. + Whether or not compression should be used when transferring FlowFiles between nodes - :return: The bends of this VersionedConnection. - :rtype: list[Position] + :return: The load_balance_compression of this VersionedConnection. + :rtype: str """ - return self._bends + return self._load_balance_compression - @bends.setter - def bends(self, bends): + @load_balance_compression.setter + def load_balance_compression(self, load_balance_compression): """ - Sets the bends of this VersionedConnection. - The bend points on the connection. + Sets the load_balance_compression of this VersionedConnection. + Whether or not compression should be used when transferring FlowFiles between nodes - :param bends: The bends of this VersionedConnection. - :type: list[Position] + :param load_balance_compression: The load_balance_compression of this VersionedConnection. + :type: str """ + allowed_values = ["DO_NOT_COMPRESS", "COMPRESS_ATTRIBUTES_ONLY", "COMPRESS_ATTRIBUTES_AND_CONTENT", ] + if load_balance_compression not in allowed_values: + raise ValueError( + "Invalid value for `load_balance_compression` ({0}), must be one of {1}" + .format(load_balance_compression, allowed_values) + ) - self._bends = bends + self._load_balance_compression = load_balance_compression @property def load_balance_strategy(self): @@ -505,7 +441,7 @@ def load_balance_strategy(self, load_balance_strategy): :param load_balance_strategy: The load_balance_strategy of this VersionedConnection. :type: str """ - allowed_values = ["DO_NOT_LOAD_BALANCE", "PARTITION_BY_ATTRIBUTE", "ROUND_ROBIN", "SINGLE_NODE"] + allowed_values = ["DO_NOT_LOAD_BALANCE", "PARTITION_BY_ATTRIBUTE", "ROUND_ROBIN", "SINGLE_NODE", ] if load_balance_strategy not in allowed_values: raise ValueError( "Invalid value for `load_balance_strategy` ({0}), must be one of {1}" @@ -514,6 +450,29 @@ def load_balance_strategy(self, load_balance_strategy): self._load_balance_strategy = load_balance_strategy + @property + def name(self): + """ + Gets the name of this VersionedConnection. + The component's name + + :return: The name of this VersionedConnection. + :rtype: str + """ + return self._name + + @name.setter + def name(self, name): + """ + Sets the name of this VersionedConnection. + The component's name + + :param name: The name of this VersionedConnection. + :type: str + """ + + self._name = name + @property def partitioning_attribute(self): """ @@ -538,83 +497,115 @@ def partitioning_attribute(self, partitioning_attribute): self._partitioning_attribute = partitioning_attribute @property - def load_balance_compression(self): + def position(self): """ - Gets the load_balance_compression of this VersionedConnection. - Whether or not compression should be used when transferring FlowFiles between nodes + Gets the position of this VersionedConnection. - :return: The load_balance_compression of this VersionedConnection. - :rtype: str + :return: The position of this VersionedConnection. + :rtype: Position """ - return self._load_balance_compression + return self._position - @load_balance_compression.setter - def load_balance_compression(self, load_balance_compression): + @position.setter + def position(self, position): """ - Sets the load_balance_compression of this VersionedConnection. - Whether or not compression should be used when transferring FlowFiles between nodes + Sets the position of this VersionedConnection. - :param load_balance_compression: The load_balance_compression of this VersionedConnection. - :type: str + :param position: The position of this VersionedConnection. + :type: Position """ - allowed_values = ["DO_NOT_COMPRESS", "COMPRESS_ATTRIBUTES_ONLY", "COMPRESS_ATTRIBUTES_AND_CONTENT"] - if load_balance_compression not in allowed_values: - raise ValueError( - "Invalid value for `load_balance_compression` ({0}), must be one of {1}" - .format(load_balance_compression, allowed_values) - ) - self._load_balance_compression = load_balance_compression + self._position = position @property - def component_type(self): + def prioritizers(self): """ - Gets the component_type of this VersionedConnection. + Gets the prioritizers of this VersionedConnection. + The comparators used to prioritize the queue. - :return: The component_type of this VersionedConnection. - :rtype: str + :return: The prioritizers of this VersionedConnection. + :rtype: list[str] """ - return self._component_type + return self._prioritizers - @component_type.setter - def component_type(self, component_type): + @prioritizers.setter + def prioritizers(self, prioritizers): """ - Sets the component_type of this VersionedConnection. + Sets the prioritizers of this VersionedConnection. + The comparators used to prioritize the queue. - :param component_type: The component_type of this VersionedConnection. - :type: str + :param prioritizers: The prioritizers of this VersionedConnection. + :type: list[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", "PARAMETER_CONTEXT", "PARAMETER_PROVIDER", "TEMPLATE", "FLOW_REGISTRY_CLIENT"] - 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 + self._prioritizers = prioritizers @property - def group_identifier(self): + def selected_relationships(self): """ - Gets the group_identifier of this VersionedConnection. - The ID of the Process Group that this component belongs to + Gets the selected_relationships of this VersionedConnection. + The selected relationship that comprise the connection. - :return: The group_identifier of this VersionedConnection. - :rtype: str + :return: The selected_relationships of this VersionedConnection. + :rtype: list[str] """ - return self._group_identifier + return self._selected_relationships - @group_identifier.setter - def group_identifier(self, group_identifier): + @selected_relationships.setter + def selected_relationships(self, selected_relationships): """ - Sets the group_identifier of this VersionedConnection. - The ID of the Process Group that this component belongs to + Sets the selected_relationships of this VersionedConnection. + The selected relationship that comprise the connection. - :param group_identifier: The group_identifier of this VersionedConnection. - :type: str + :param selected_relationships: The selected_relationships of this VersionedConnection. + :type: list[str] """ - self._group_identifier = group_identifier + self._selected_relationships = selected_relationships + + @property + def source(self): + """ + Gets the source of this VersionedConnection. + + :return: The source of this VersionedConnection. + :rtype: ConnectableComponent + """ + return self._source + + @source.setter + def source(self, source): + """ + Sets the source of this VersionedConnection. + + :param source: The source of this VersionedConnection. + :type: ConnectableComponent + """ + + self._source = source + + @property + def z_index(self): + """ + Gets the z_index of this VersionedConnection. + The z index of the connection. + + :return: The z_index of this VersionedConnection. + :rtype: int + """ + return self._z_index + + @z_index.setter + def z_index(self, z_index): + """ + Sets the z_index of this VersionedConnection. + The z index of the connection. + + :param z_index: The z_index of this VersionedConnection. + :type: int + """ + + self._z_index = z_index def to_dict(self): """ diff --git a/nipyapi/nifi/models/versioned_controller_service.py b/nipyapi/nifi/models/versioned_controller_service.py index 262b816b..64c8c1fc 100644 --- a/nipyapi/nifi/models/versioned_controller_service.py +++ b/nipyapi/nifi/models/versioned_controller_service.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,92 +27,253 @@ class VersionedControllerService(object): and the value is json key in definition. """ swagger_types = { - 'identifier': 'str', - 'instance_identifier': 'str', - 'name': 'str', - 'comments': 'str', - 'position': 'Position', - 'type': 'str', - 'bundle': 'Bundle', - 'properties': 'dict(str, str)', - 'property_descriptors': 'dict(str, VersionedPropertyDescriptor)', - 'controller_service_apis': 'list[ControllerServiceAPI]', 'annotation_data': 'str', - 'scheduled_state': 'str', - 'bulletin_level': 'str', - 'component_type': 'str', - 'group_identifier': 'str' - } +'bulletin_level': 'str', +'bundle': 'Bundle', +'comments': 'str', +'component_type': 'str', +'controller_service_apis': 'list[ControllerServiceAPI]', +'group_identifier': 'str', +'identifier': 'str', +'instance_identifier': 'str', +'name': 'str', +'position': 'Position', +'properties': 'dict(str, str)', +'property_descriptors': 'dict(str, VersionedPropertyDescriptor)', +'scheduled_state': 'str', +'type': 'str' } attribute_map = { - 'identifier': 'identifier', - 'instance_identifier': 'instanceIdentifier', - 'name': 'name', - 'comments': 'comments', - 'position': 'position', - 'type': 'type', - 'bundle': 'bundle', - 'properties': 'properties', - 'property_descriptors': 'propertyDescriptors', - 'controller_service_apis': 'controllerServiceApis', 'annotation_data': 'annotationData', - 'scheduled_state': 'scheduledState', - 'bulletin_level': 'bulletinLevel', - 'component_type': 'componentType', - 'group_identifier': 'groupIdentifier' - } - - def __init__(self, identifier=None, instance_identifier=None, name=None, comments=None, position=None, type=None, bundle=None, properties=None, property_descriptors=None, controller_service_apis=None, annotation_data=None, scheduled_state=None, bulletin_level=None, component_type=None, group_identifier=None): +'bulletin_level': 'bulletinLevel', +'bundle': 'bundle', +'comments': 'comments', +'component_type': 'componentType', +'controller_service_apis': 'controllerServiceApis', +'group_identifier': 'groupIdentifier', +'identifier': 'identifier', +'instance_identifier': 'instanceIdentifier', +'name': 'name', +'position': 'position', +'properties': 'properties', +'property_descriptors': 'propertyDescriptors', +'scheduled_state': 'scheduledState', +'type': 'type' } + + def __init__(self, annotation_data=None, bulletin_level=None, bundle=None, comments=None, component_type=None, controller_service_apis=None, group_identifier=None, identifier=None, instance_identifier=None, name=None, position=None, properties=None, property_descriptors=None, scheduled_state=None, type=None): """ VersionedControllerService - a model defined in Swagger """ + self._annotation_data = None + self._bulletin_level = None + self._bundle = None + self._comments = None + self._component_type = None + self._controller_service_apis = None + self._group_identifier = None self._identifier = None self._instance_identifier = None self._name = None - self._comments = None self._position = None - self._type = None - self._bundle = None self._properties = None self._property_descriptors = None - self._controller_service_apis = None - self._annotation_data = None self._scheduled_state = None - self._bulletin_level = None - self._component_type = None - self._group_identifier = None + self._type = None + if annotation_data is not None: + self.annotation_data = annotation_data + if bulletin_level is not None: + self.bulletin_level = bulletin_level + if bundle is not None: + self.bundle = bundle + if comments is not None: + self.comments = comments + if component_type is not None: + self.component_type = component_type + if controller_service_apis is not None: + self.controller_service_apis = controller_service_apis + if group_identifier is not None: + self.group_identifier = group_identifier if identifier is not None: self.identifier = identifier if instance_identifier is not None: self.instance_identifier = instance_identifier if name is not None: self.name = name - if comments is not None: - self.comments = comments if position is not None: self.position = position - if type is not None: - self.type = type - if bundle is not None: - self.bundle = bundle if properties is not None: self.properties = properties if property_descriptors is not None: self.property_descriptors = property_descriptors - if controller_service_apis is not None: - self.controller_service_apis = controller_service_apis - if annotation_data is not None: - self.annotation_data = annotation_data if scheduled_state is not None: self.scheduled_state = scheduled_state - if bulletin_level is not None: - self.bulletin_level = bulletin_level - if component_type is not None: - self.component_type = component_type - if group_identifier is not None: - self.group_identifier = group_identifier + if type is not None: + self.type = type + + @property + def annotation_data(self): + """ + Gets the annotation_data of this VersionedControllerService. + The annotation for the controller service. This is how the custom UI relays configuration to the controller service. + + :return: The annotation_data of this VersionedControllerService. + :rtype: str + """ + return self._annotation_data + + @annotation_data.setter + def annotation_data(self, annotation_data): + """ + Sets the annotation_data of this VersionedControllerService. + The annotation for the controller service. This is how the custom UI relays configuration to the controller service. + + :param annotation_data: The annotation_data of this VersionedControllerService. + :type: str + """ + + self._annotation_data = annotation_data + + @property + def bulletin_level(self): + """ + Gets the bulletin_level of this VersionedControllerService. + The level at which the controller service will report bulletins. + + :return: The bulletin_level of this VersionedControllerService. + :rtype: str + """ + return self._bulletin_level + + @bulletin_level.setter + def bulletin_level(self, bulletin_level): + """ + Sets the bulletin_level of this VersionedControllerService. + The level at which the controller service will report bulletins. + + :param bulletin_level: The bulletin_level of this VersionedControllerService. + :type: str + """ + + self._bulletin_level = bulletin_level + + @property + def bundle(self): + """ + Gets the bundle of this VersionedControllerService. + + :return: The bundle of this VersionedControllerService. + :rtype: Bundle + """ + return self._bundle + + @bundle.setter + def bundle(self, bundle): + """ + Sets the bundle of this VersionedControllerService. + + :param bundle: The bundle of this VersionedControllerService. + :type: Bundle + """ + + self._bundle = bundle + + @property + def comments(self): + """ + Gets the comments of this VersionedControllerService. + The user-supplied comments for the component + + :return: The comments of this VersionedControllerService. + :rtype: str + """ + return self._comments + + @comments.setter + def comments(self, comments): + """ + Sets the comments of this VersionedControllerService. + The user-supplied comments for the component + + :param comments: The comments of this VersionedControllerService. + :type: str + """ + + self._comments = comments + + @property + def component_type(self): + """ + Gets the component_type of this VersionedControllerService. + + :return: The component_type of this VersionedControllerService. + :rtype: str + """ + return self._component_type + + @component_type.setter + def component_type(self, component_type): + """ + Sets the component_type of this VersionedControllerService. + + :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", ] + 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 + + @property + def controller_service_apis(self): + """ + Gets the controller_service_apis of this VersionedControllerService. + Lists the APIs this Controller Service implements. + + :return: The controller_service_apis of this VersionedControllerService. + :rtype: list[ControllerServiceAPI] + """ + return self._controller_service_apis + + @controller_service_apis.setter + def controller_service_apis(self, controller_service_apis): + """ + Sets the controller_service_apis of this VersionedControllerService. + Lists the APIs this Controller Service implements. + + :param controller_service_apis: The controller_service_apis of this VersionedControllerService. + :type: list[ControllerServiceAPI] + """ + + self._controller_service_apis = controller_service_apis + + @property + def group_identifier(self): + """ + Gets the group_identifier of this VersionedControllerService. + The ID of the Process Group that this component belongs to + + :return: The group_identifier of this VersionedControllerService. + :rtype: str + """ + return self._group_identifier + + @group_identifier.setter + def group_identifier(self, group_identifier): + """ + Sets the group_identifier of this VersionedControllerService. + The ID of the Process Group that this component belongs to + + :param group_identifier: The group_identifier of this VersionedControllerService. + :type: str + """ + + self._group_identifier = group_identifier @property def identifier(self): @@ -184,34 +344,10 @@ def name(self, name): self._name = name - @property - def comments(self): - """ - Gets the comments of this VersionedControllerService. - The user-supplied comments for the component - - :return: The comments of this VersionedControllerService. - :rtype: str - """ - return self._comments - - @comments.setter - def comments(self, comments): - """ - Sets the comments of this VersionedControllerService. - The user-supplied comments for the component - - :param comments: The comments of this VersionedControllerService. - :type: str - """ - - self._comments = comments - @property def position(self): """ Gets the position of this VersionedControllerService. - The component's position on the graph :return: The position of this VersionedControllerService. :rtype: Position @@ -222,7 +358,6 @@ def position(self): def position(self, position): """ Sets the position of this VersionedControllerService. - The component's position on the graph :param position: The position of this VersionedControllerService. :type: Position @@ -230,52 +365,6 @@ def position(self, position): self._position = position - @property - def type(self): - """ - Gets the type of this VersionedControllerService. - The type of the extension component - - :return: The type of this VersionedControllerService. - :rtype: str - """ - return self._type - - @type.setter - def type(self, type): - """ - Sets the type of this VersionedControllerService. - The type of the extension component - - :param type: The type of this VersionedControllerService. - :type: str - """ - - self._type = type - - @property - def bundle(self): - """ - Gets the bundle of this VersionedControllerService. - Information about the bundle from which the component came - - :return: The bundle of this VersionedControllerService. - :rtype: Bundle - """ - return self._bundle - - @bundle.setter - def bundle(self, bundle): - """ - Sets the bundle of this VersionedControllerService. - Information about the bundle from which the component came - - :param bundle: The bundle of this VersionedControllerService. - :type: Bundle - """ - - self._bundle = bundle - @property def properties(self): """ @@ -322,52 +411,6 @@ def property_descriptors(self, property_descriptors): self._property_descriptors = property_descriptors - @property - def controller_service_apis(self): - """ - Gets the controller_service_apis of this VersionedControllerService. - Lists the APIs this Controller Service implements. - - :return: The controller_service_apis of this VersionedControllerService. - :rtype: list[ControllerServiceAPI] - """ - return self._controller_service_apis - - @controller_service_apis.setter - def controller_service_apis(self, controller_service_apis): - """ - Sets the controller_service_apis of this VersionedControllerService. - Lists the APIs this Controller Service implements. - - :param controller_service_apis: The controller_service_apis of this VersionedControllerService. - :type: list[ControllerServiceAPI] - """ - - self._controller_service_apis = controller_service_apis - - @property - def annotation_data(self): - """ - Gets the annotation_data of this VersionedControllerService. - The annotation for the controller service. This is how the custom UI relays configuration to the controller service. - - :return: The annotation_data of this VersionedControllerService. - :rtype: str - """ - return self._annotation_data - - @annotation_data.setter - def annotation_data(self, annotation_data): - """ - Sets the annotation_data of this VersionedControllerService. - The annotation for the controller service. This is how the custom UI relays configuration to the controller service. - - :param annotation_data: The annotation_data of this VersionedControllerService. - :type: str - """ - - self._annotation_data = annotation_data - @property def scheduled_state(self): """ @@ -388,7 +431,7 @@ def scheduled_state(self, scheduled_state): :param scheduled_state: The scheduled_state of this VersionedControllerService. :type: str """ - allowed_values = ["ENABLED", "DISABLED", "RUNNING"] + 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}" @@ -398,77 +441,27 @@ def scheduled_state(self, scheduled_state): self._scheduled_state = scheduled_state @property - def bulletin_level(self): - """ - Gets the bulletin_level of this VersionedControllerService. - The level at which the controller service will report bulletins. - - :return: The bulletin_level of this VersionedControllerService. - :rtype: str - """ - return self._bulletin_level - - @bulletin_level.setter - def bulletin_level(self, bulletin_level): - """ - Sets the bulletin_level of this VersionedControllerService. - The level at which the controller service will report bulletins. - - :param bulletin_level: The bulletin_level of this VersionedControllerService. - :type: str - """ - - self._bulletin_level = bulletin_level - - @property - def component_type(self): - """ - Gets the component_type of this VersionedControllerService. - - :return: The component_type of this VersionedControllerService. - :rtype: str - """ - return self._component_type - - @component_type.setter - def component_type(self, component_type): - """ - Sets the component_type of this VersionedControllerService. - - :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", "PARAMETER_CONTEXT", "PARAMETER_PROVIDER", "TEMPLATE", "FLOW_REGISTRY_CLIENT"] - 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 - - @property - def group_identifier(self): + def type(self): """ - Gets the group_identifier of this VersionedControllerService. - The ID of the Process Group that this component belongs to + Gets the type of this VersionedControllerService. + The type of the extension component - :return: The group_identifier of this VersionedControllerService. + :return: The type of this VersionedControllerService. :rtype: str """ - return self._group_identifier + return self._type - @group_identifier.setter - def group_identifier(self, group_identifier): + @type.setter + def type(self, type): """ - Sets the group_identifier of this VersionedControllerService. - The ID of the Process Group that this component belongs to + Sets the type of this VersionedControllerService. + The type of the extension component - :param group_identifier: The group_identifier of this VersionedControllerService. + :param type: The type of this VersionedControllerService. :type: str """ - self._group_identifier = group_identifier + self._type = type def to_dict(self): """ diff --git a/nipyapi/nifi/models/versioned_flow_coordinates.py b/nipyapi/nifi/models/versioned_flow_coordinates.py index 8387e009..05f12440 100644 --- a/nipyapi/nifi/models/versioned_flow_coordinates.py +++ b/nipyapi/nifi/models/versioned_flow_coordinates.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,121 +27,73 @@ class VersionedFlowCoordinates(object): and the value is json key in definition. """ swagger_types = { - 'registry_id': 'str', - 'storage_location': 'str', - 'registry_url': 'str', - 'bucket_id': 'str', - 'flow_id': 'str', - 'version': 'int', - 'latest': 'bool' - } + 'branch': 'str', +'bucket_id': 'str', +'flow_id': 'str', +'latest': 'bool', +'registry_id': 'str', +'storage_location': 'str', +'version': 'str' } attribute_map = { - 'registry_id': 'registryId', - 'storage_location': 'storageLocation', - 'registry_url': 'registryUrl', - 'bucket_id': 'bucketId', - 'flow_id': 'flowId', - 'version': 'version', - 'latest': 'latest' - } + 'branch': 'branch', +'bucket_id': 'bucketId', +'flow_id': 'flowId', +'latest': 'latest', +'registry_id': 'registryId', +'storage_location': 'storageLocation', +'version': 'version' } - def __init__(self, registry_id=None, storage_location=None, registry_url=None, bucket_id=None, flow_id=None, version=None, latest=None): + def __init__(self, branch=None, bucket_id=None, flow_id=None, latest=None, registry_id=None, storage_location=None, version=None): """ VersionedFlowCoordinates - a model defined in Swagger """ - self._registry_id = None - self._storage_location = None - self._registry_url = None + self._branch = None self._bucket_id = None self._flow_id = None - self._version = None self._latest = None + self._registry_id = None + self._storage_location = None + self._version = None - if registry_id is not None: - self.registry_id = registry_id - if storage_location is not None: - self.storage_location = storage_location - if registry_url is not None: - self.registry_url = registry_url + if branch is not None: + self.branch = branch if bucket_id is not None: self.bucket_id = bucket_id if flow_id is not None: self.flow_id = flow_id - if version is not None: - self.version = version if latest is not None: self.latest = latest + if registry_id is not None: + self.registry_id = registry_id + if storage_location is not None: + self.storage_location = storage_location + if version is not None: + self.version = version @property - def registry_id(self): - """ - Gets the registry_id of this VersionedFlowCoordinates. - The identifier of the Flow Registry that contains the flow - - :return: The registry_id of this VersionedFlowCoordinates. - :rtype: str - """ - return self._registry_id - - @registry_id.setter - def registry_id(self, registry_id): - """ - Sets the registry_id of this VersionedFlowCoordinates. - The identifier of the Flow Registry that contains the flow - - :param registry_id: The registry_id of this VersionedFlowCoordinates. - :type: str - """ - - self._registry_id = registry_id - - @property - def storage_location(self): - """ - Gets the storage_location of this VersionedFlowCoordinates. - The location of the Flow Registry that stores the flow - - :return: The storage_location of this VersionedFlowCoordinates. - :rtype: str - """ - return self._storage_location - - @storage_location.setter - def storage_location(self, storage_location): - """ - Sets the storage_location of this VersionedFlowCoordinates. - The location of the Flow Registry that stores the flow - - :param storage_location: The storage_location of this VersionedFlowCoordinates. - :type: str - """ - - self._storage_location = storage_location - - @property - def registry_url(self): + def branch(self): """ - Gets the registry_url of this VersionedFlowCoordinates. - The URL of the Flow Registry that contains the flow + Gets the branch of this VersionedFlowCoordinates. + The name of the branch that the flow resides in - :return: The registry_url of this VersionedFlowCoordinates. + :return: The branch of this VersionedFlowCoordinates. :rtype: str """ - return self._registry_url + return self._branch - @registry_url.setter - def registry_url(self, registry_url): + @branch.setter + def branch(self, branch): """ - Sets the registry_url of this VersionedFlowCoordinates. - The URL of the Flow Registry that contains the flow + Sets the branch of this VersionedFlowCoordinates. + The name of the branch that the flow resides in - :param registry_url: The registry_url of this VersionedFlowCoordinates. + :param branch: The branch of this VersionedFlowCoordinates. :type: str """ - self._registry_url = registry_url + self._branch = branch @property def bucket_id(self): @@ -190,29 +141,6 @@ def flow_id(self, flow_id): self._flow_id = flow_id - @property - def version(self): - """ - Gets the version of this VersionedFlowCoordinates. - The version of the flow - - :return: The version of this VersionedFlowCoordinates. - :rtype: int - """ - return self._version - - @version.setter - def version(self, version): - """ - Sets the version of this VersionedFlowCoordinates. - The version of the flow - - :param version: The version of this VersionedFlowCoordinates. - :type: int - """ - - self._version = version - @property def latest(self): """ @@ -236,6 +164,75 @@ def latest(self, latest): self._latest = latest + @property + def registry_id(self): + """ + Gets the registry_id of this VersionedFlowCoordinates. + The identifier of the Flow Registry that contains the flow + + :return: The registry_id of this VersionedFlowCoordinates. + :rtype: str + """ + return self._registry_id + + @registry_id.setter + def registry_id(self, registry_id): + """ + Sets the registry_id of this VersionedFlowCoordinates. + The identifier of the Flow Registry that contains the flow + + :param registry_id: The registry_id of this VersionedFlowCoordinates. + :type: str + """ + + self._registry_id = registry_id + + @property + def storage_location(self): + """ + Gets the storage_location of this VersionedFlowCoordinates. + The location of the Flow Registry that stores the flow + + :return: The storage_location of this VersionedFlowCoordinates. + :rtype: str + """ + return self._storage_location + + @storage_location.setter + def storage_location(self, storage_location): + """ + Sets the storage_location of this VersionedFlowCoordinates. + The location of the Flow Registry that stores the flow + + :param storage_location: The storage_location of this VersionedFlowCoordinates. + :type: str + """ + + self._storage_location = storage_location + + @property + def version(self): + """ + Gets the version of this VersionedFlowCoordinates. + The version of the flow + + :return: The version of this VersionedFlowCoordinates. + :rtype: str + """ + return self._version + + @version.setter + def version(self, version): + """ + Sets the version of this VersionedFlowCoordinates. + The version of the flow + + :param version: The version of this VersionedFlowCoordinates. + :type: str + """ + + self._version = version + def to_dict(self): """ Returns the model properties as a dict diff --git a/nipyapi/nifi/models/versioned_flow_dto.py b/nipyapi/nifi/models/versioned_flow_dto.py index 0090adb5..0e38d971 100644 --- a/nipyapi/nifi/models/versioned_flow_dto.py +++ b/nipyapi/nifi/models/versioned_flow_dto.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,144 +27,153 @@ class VersionedFlowDTO(object): and the value is json key in definition. """ swagger_types = { - 'registry_id': 'str', - 'bucket_id': 'str', - 'flow_id': 'str', - 'flow_name': 'str', - 'description': 'str', - 'comments': 'str', - 'action': 'str' - } + 'action': 'str', +'branch': 'str', +'bucket_id': 'str', +'comments': 'str', +'description': 'str', +'flow_id': 'str', +'flow_name': 'str', +'registry_id': 'str' } attribute_map = { - 'registry_id': 'registryId', - 'bucket_id': 'bucketId', - 'flow_id': 'flowId', - 'flow_name': 'flowName', - 'description': 'description', - 'comments': 'comments', - 'action': 'action' - } + 'action': 'action', +'branch': 'branch', +'bucket_id': 'bucketId', +'comments': 'comments', +'description': 'description', +'flow_id': 'flowId', +'flow_name': 'flowName', +'registry_id': 'registryId' } - def __init__(self, registry_id=None, bucket_id=None, flow_id=None, flow_name=None, description=None, comments=None, action=None): + def __init__(self, action=None, branch=None, bucket_id=None, comments=None, description=None, flow_id=None, flow_name=None, registry_id=None): """ VersionedFlowDTO - a model defined in Swagger """ - self._registry_id = None + self._action = None + self._branch = None self._bucket_id = None + self._comments = None + self._description = None self._flow_id = None self._flow_name = None - self._description = None - self._comments = None - self._action = None + self._registry_id = None - if registry_id is not None: - self.registry_id = registry_id + if action is not None: + self.action = action + if branch is not None: + self.branch = branch if bucket_id is not None: self.bucket_id = bucket_id + if comments is not None: + self.comments = comments + if description is not None: + self.description = description if flow_id is not None: self.flow_id = flow_id if flow_name is not None: self.flow_name = flow_name - if description is not None: - self.description = description - if comments is not None: - self.comments = comments - if action is not None: - self.action = action + if registry_id is not None: + self.registry_id = registry_id @property - def registry_id(self): + def action(self): """ - Gets the registry_id of this VersionedFlowDTO. - The ID of the registry that the flow is tracked to + Gets the action of this VersionedFlowDTO. + The action being performed - :return: The registry_id of this VersionedFlowDTO. + :return: The action of this VersionedFlowDTO. :rtype: str """ - return self._registry_id + return self._action - @registry_id.setter - def registry_id(self, registry_id): + @action.setter + def action(self, action): """ - Sets the registry_id of this VersionedFlowDTO. - The ID of the registry that the flow is tracked to + Sets the action of this VersionedFlowDTO. + The action being performed - :param registry_id: The registry_id of this VersionedFlowDTO. + :param action: The action of this VersionedFlowDTO. :type: str """ + allowed_values = ["COMMIT", "FORCE_COMMIT", ] + if action not in allowed_values: + raise ValueError( + "Invalid value for `action` ({0}), must be one of {1}" + .format(action, allowed_values) + ) - self._registry_id = registry_id + self._action = action @property - def bucket_id(self): + def branch(self): """ - Gets the bucket_id of this VersionedFlowDTO. - The ID of the bucket where the flow is stored + Gets the branch of this VersionedFlowDTO. + The branch where the flow is stored - :return: The bucket_id of this VersionedFlowDTO. + :return: The branch of this VersionedFlowDTO. :rtype: str """ - return self._bucket_id + return self._branch - @bucket_id.setter - def bucket_id(self, bucket_id): + @branch.setter + def branch(self, branch): """ - Sets the bucket_id of this VersionedFlowDTO. - The ID of the bucket where the flow is stored + Sets the branch of this VersionedFlowDTO. + The branch where the flow is stored - :param bucket_id: The bucket_id of this VersionedFlowDTO. + :param branch: The branch of this VersionedFlowDTO. :type: str """ - self._bucket_id = bucket_id + self._branch = branch @property - def flow_id(self): + def bucket_id(self): """ - Gets the flow_id of this VersionedFlowDTO. - The ID of the flow + Gets the bucket_id of this VersionedFlowDTO. + The ID of the bucket where the flow is stored - :return: The flow_id of this VersionedFlowDTO. + :return: The bucket_id of this VersionedFlowDTO. :rtype: str """ - return self._flow_id + return self._bucket_id - @flow_id.setter - def flow_id(self, flow_id): + @bucket_id.setter + def bucket_id(self, bucket_id): """ - Sets the flow_id of this VersionedFlowDTO. - The ID of the flow + Sets the bucket_id of this VersionedFlowDTO. + The ID of the bucket where the flow is stored - :param flow_id: The flow_id of this VersionedFlowDTO. + :param bucket_id: The bucket_id of this VersionedFlowDTO. :type: str """ - self._flow_id = flow_id + self._bucket_id = bucket_id @property - def flow_name(self): + def comments(self): """ - Gets the flow_name of this VersionedFlowDTO. - The name of the flow + Gets the comments of this VersionedFlowDTO. + Comments for the changeset - :return: The flow_name of this VersionedFlowDTO. + :return: The comments of this VersionedFlowDTO. :rtype: str """ - return self._flow_name + return self._comments - @flow_name.setter - def flow_name(self, flow_name): + @comments.setter + def comments(self, comments): """ - Sets the flow_name of this VersionedFlowDTO. - The name of the flow + Sets the comments of this VersionedFlowDTO. + Comments for the changeset - :param flow_name: The flow_name of this VersionedFlowDTO. + :param comments: The comments of this VersionedFlowDTO. :type: str """ - self._flow_name = flow_name + self._comments = comments @property def description(self): @@ -191,56 +199,73 @@ def description(self, description): self._description = description @property - def comments(self): + def flow_id(self): """ - Gets the comments of this VersionedFlowDTO. - Comments for the changeset + Gets the flow_id of this VersionedFlowDTO. + The ID of the flow - :return: The comments of this VersionedFlowDTO. + :return: The flow_id of this VersionedFlowDTO. :rtype: str """ - return self._comments + return self._flow_id - @comments.setter - def comments(self, comments): + @flow_id.setter + def flow_id(self, flow_id): """ - Sets the comments of this VersionedFlowDTO. - Comments for the changeset + Sets the flow_id of this VersionedFlowDTO. + The ID of the flow - :param comments: The comments of this VersionedFlowDTO. + :param flow_id: The flow_id of this VersionedFlowDTO. :type: str """ - self._comments = comments + self._flow_id = flow_id @property - def action(self): + def flow_name(self): """ - Gets the action of this VersionedFlowDTO. - The action being performed + Gets the flow_name of this VersionedFlowDTO. + The name of the flow - :return: The action of this VersionedFlowDTO. + :return: The flow_name of this VersionedFlowDTO. :rtype: str """ - return self._action + return self._flow_name - @action.setter - def action(self, action): + @flow_name.setter + def flow_name(self, flow_name): """ - Sets the action of this VersionedFlowDTO. - The action being performed + Sets the flow_name of this VersionedFlowDTO. + The name of the flow - :param action: The action of this VersionedFlowDTO. + :param flow_name: The flow_name of this VersionedFlowDTO. :type: str """ - allowed_values = ["COMMIT", "FORCE_COMMIT"] - if action not in allowed_values: - raise ValueError( - "Invalid value for `action` ({0}), must be one of {1}" - .format(action, allowed_values) - ) - self._action = action + self._flow_name = flow_name + + @property + def registry_id(self): + """ + Gets the registry_id of this VersionedFlowDTO. + The ID of the registry that the flow is tracked to + + :return: The registry_id of this VersionedFlowDTO. + :rtype: str + """ + return self._registry_id + + @registry_id.setter + def registry_id(self, registry_id): + """ + Sets the registry_id of this VersionedFlowDTO. + The ID of the registry that the flow is tracked to + + :param registry_id: The registry_id of this VersionedFlowDTO. + :type: str + """ + + self._registry_id = registry_id def to_dict(self): """ diff --git a/nipyapi/nifi/models/versioned_flow_entity.py b/nipyapi/nifi/models/versioned_flow_entity.py index f619404f..9fa53016 100644 --- a/nipyapi/nifi/models/versioned_flow_entity.py +++ b/nipyapi/nifi/models/versioned_flow_entity.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,12 +27,10 @@ class VersionedFlowEntity(object): and the value is json key in definition. """ swagger_types = { - 'versioned_flow': 'VersionedFlowDTO' - } + 'versioned_flow': 'VersionedFlowDTO' } attribute_map = { - 'versioned_flow': 'versionedFlow' - } + 'versioned_flow': 'versionedFlow' } def __init__(self, versioned_flow=None): """ @@ -49,7 +46,6 @@ def __init__(self, versioned_flow=None): def versioned_flow(self): """ Gets the versioned_flow of this VersionedFlowEntity. - The versioned flow :return: The versioned_flow of this VersionedFlowEntity. :rtype: VersionedFlowDTO @@ -60,7 +56,6 @@ def versioned_flow(self): def versioned_flow(self, versioned_flow): """ Sets the versioned_flow of this VersionedFlowEntity. - The versioned flow :param versioned_flow: The versioned_flow of this VersionedFlowEntity. :type: VersionedFlowDTO diff --git a/nipyapi/nifi/models/versioned_flow_snapshot_entity.py b/nipyapi/nifi/models/versioned_flow_snapshot_entity.py index 6e9ef3ea..a0774258 100644 --- a/nipyapi/nifi/models/versioned_flow_snapshot_entity.py +++ b/nipyapi/nifi/models/versioned_flow_snapshot_entity.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,71 +27,73 @@ class VersionedFlowSnapshotEntity(object): and the value is json key in definition. """ swagger_types = { - 'versioned_flow_snapshot': 'RegisteredFlowSnapshot', - 'process_group_revision': 'RevisionDTO', - 'registry_id': 'str', - 'update_descendant_versioned_flows': 'bool', - 'disconnected_node_acknowledged': 'bool' - } + 'disconnected_node_acknowledged': 'bool', +'process_group_revision': 'RevisionDTO', +'registry_id': 'str', +'update_descendant_versioned_flows': 'bool', +'versioned_flow': 'RegisteredFlowSnapshot', +'versioned_flow_snapshot': 'RegisteredFlowSnapshot' } attribute_map = { - 'versioned_flow_snapshot': 'versionedFlowSnapshot', - 'process_group_revision': 'processGroupRevision', - 'registry_id': 'registryId', - 'update_descendant_versioned_flows': 'updateDescendantVersionedFlows', - 'disconnected_node_acknowledged': 'disconnectedNodeAcknowledged' - } + 'disconnected_node_acknowledged': 'disconnectedNodeAcknowledged', +'process_group_revision': 'processGroupRevision', +'registry_id': 'registryId', +'update_descendant_versioned_flows': 'updateDescendantVersionedFlows', +'versioned_flow': 'versionedFlow', +'versioned_flow_snapshot': 'versionedFlowSnapshot' } - def __init__(self, versioned_flow_snapshot=None, process_group_revision=None, registry_id=None, update_descendant_versioned_flows=None, disconnected_node_acknowledged=None): + def __init__(self, disconnected_node_acknowledged=None, process_group_revision=None, registry_id=None, update_descendant_versioned_flows=None, versioned_flow=None, versioned_flow_snapshot=None): """ VersionedFlowSnapshotEntity - a model defined in Swagger """ - self._versioned_flow_snapshot = None + self._disconnected_node_acknowledged = None self._process_group_revision = None self._registry_id = None self._update_descendant_versioned_flows = None - self._disconnected_node_acknowledged = None + self._versioned_flow = None + self._versioned_flow_snapshot = None - if versioned_flow_snapshot is not None: - self.versioned_flow_snapshot = versioned_flow_snapshot + if disconnected_node_acknowledged is not None: + self.disconnected_node_acknowledged = disconnected_node_acknowledged if process_group_revision is not None: self.process_group_revision = process_group_revision if registry_id is not None: self.registry_id = registry_id if update_descendant_versioned_flows is not None: self.update_descendant_versioned_flows = update_descendant_versioned_flows - if disconnected_node_acknowledged is not None: - self.disconnected_node_acknowledged = disconnected_node_acknowledged + if versioned_flow is not None: + self.versioned_flow = versioned_flow + if versioned_flow_snapshot is not None: + self.versioned_flow_snapshot = versioned_flow_snapshot @property - def versioned_flow_snapshot(self): + def disconnected_node_acknowledged(self): """ - Gets the versioned_flow_snapshot of this VersionedFlowSnapshotEntity. - The versioned flow snapshot + Gets the disconnected_node_acknowledged of this VersionedFlowSnapshotEntity. + Acknowledges that this node is disconnected to allow for mutable requests to proceed. - :return: The versioned_flow_snapshot of this VersionedFlowSnapshotEntity. - :rtype: RegisteredFlowSnapshot + :return: The disconnected_node_acknowledged of this VersionedFlowSnapshotEntity. + :rtype: bool """ - return self._versioned_flow_snapshot + return self._disconnected_node_acknowledged - @versioned_flow_snapshot.setter - def versioned_flow_snapshot(self, versioned_flow_snapshot): + @disconnected_node_acknowledged.setter + def disconnected_node_acknowledged(self, disconnected_node_acknowledged): """ - Sets the versioned_flow_snapshot of this VersionedFlowSnapshotEntity. - The versioned flow snapshot + Sets the disconnected_node_acknowledged of this VersionedFlowSnapshotEntity. + Acknowledges that this node is disconnected to allow for mutable requests to proceed. - :param versioned_flow_snapshot: The versioned_flow_snapshot of this VersionedFlowSnapshotEntity. - :type: RegisteredFlowSnapshot + :param disconnected_node_acknowledged: The disconnected_node_acknowledged of this VersionedFlowSnapshotEntity. + :type: bool """ - self._versioned_flow_snapshot = versioned_flow_snapshot + self._disconnected_node_acknowledged = disconnected_node_acknowledged @property def process_group_revision(self): """ Gets the process_group_revision of this VersionedFlowSnapshotEntity. - The Revision of the Process Group under Version Control :return: The process_group_revision of this VersionedFlowSnapshotEntity. :rtype: RevisionDTO @@ -103,7 +104,6 @@ def process_group_revision(self): def process_group_revision(self, process_group_revision): """ Sets the process_group_revision of this VersionedFlowSnapshotEntity. - The Revision of the Process Group under Version Control :param process_group_revision: The process_group_revision of this VersionedFlowSnapshotEntity. :type: RevisionDTO @@ -158,27 +158,46 @@ def update_descendant_versioned_flows(self, update_descendant_versioned_flows): self._update_descendant_versioned_flows = update_descendant_versioned_flows @property - def disconnected_node_acknowledged(self): + def versioned_flow(self): """ - Gets the disconnected_node_acknowledged of this VersionedFlowSnapshotEntity. - Acknowledges that this node is disconnected to allow for mutable requests to proceed. + Gets the versioned_flow of this VersionedFlowSnapshotEntity. - :return: The disconnected_node_acknowledged of this VersionedFlowSnapshotEntity. - :rtype: bool + :return: The versioned_flow of this VersionedFlowSnapshotEntity. + :rtype: RegisteredFlowSnapshot """ - return self._disconnected_node_acknowledged + return self._versioned_flow - @disconnected_node_acknowledged.setter - def disconnected_node_acknowledged(self, disconnected_node_acknowledged): + @versioned_flow.setter + def versioned_flow(self, versioned_flow): """ - Sets the disconnected_node_acknowledged of this VersionedFlowSnapshotEntity. - Acknowledges that this node is disconnected to allow for mutable requests to proceed. + Sets the versioned_flow of this VersionedFlowSnapshotEntity. - :param disconnected_node_acknowledged: The disconnected_node_acknowledged of this VersionedFlowSnapshotEntity. - :type: bool + :param versioned_flow: The versioned_flow of this VersionedFlowSnapshotEntity. + :type: RegisteredFlowSnapshot """ - self._disconnected_node_acknowledged = disconnected_node_acknowledged + self._versioned_flow = versioned_flow + + @property + def versioned_flow_snapshot(self): + """ + Gets the versioned_flow_snapshot of this VersionedFlowSnapshotEntity. + + :return: The versioned_flow_snapshot of this VersionedFlowSnapshotEntity. + :rtype: RegisteredFlowSnapshot + """ + return self._versioned_flow_snapshot + + @versioned_flow_snapshot.setter + def versioned_flow_snapshot(self, versioned_flow_snapshot): + """ + Sets the versioned_flow_snapshot of this VersionedFlowSnapshotEntity. + + :param versioned_flow_snapshot: The versioned_flow_snapshot of this VersionedFlowSnapshotEntity. + :type: RegisteredFlowSnapshot + """ + + self._versioned_flow_snapshot = versioned_flow_snapshot def to_dict(self): """ diff --git a/nipyapi/nifi/models/versioned_flow_snapshot_metadata_entity.py b/nipyapi/nifi/models/versioned_flow_snapshot_metadata_entity.py index c39ea1ea..05b777f2 100644 --- a/nipyapi/nifi/models/versioned_flow_snapshot_metadata_entity.py +++ b/nipyapi/nifi/models/versioned_flow_snapshot_metadata_entity.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,50 +27,25 @@ class VersionedFlowSnapshotMetadataEntity(object): and the value is json key in definition. """ swagger_types = { - 'versioned_flow_snapshot_metadata': 'RegisteredFlowSnapshotMetadata', - 'registry_id': 'str' - } + 'registry_id': 'str', +'versioned_flow_snapshot_metadata': 'RegisteredFlowSnapshotMetadata' } attribute_map = { - 'versioned_flow_snapshot_metadata': 'versionedFlowSnapshotMetadata', - 'registry_id': 'registryId' - } + 'registry_id': 'registryId', +'versioned_flow_snapshot_metadata': 'versionedFlowSnapshotMetadata' } - def __init__(self, versioned_flow_snapshot_metadata=None, registry_id=None): + def __init__(self, registry_id=None, versioned_flow_snapshot_metadata=None): """ VersionedFlowSnapshotMetadataEntity - a model defined in Swagger """ - self._versioned_flow_snapshot_metadata = None self._registry_id = None + self._versioned_flow_snapshot_metadata = None - if versioned_flow_snapshot_metadata is not None: - self.versioned_flow_snapshot_metadata = versioned_flow_snapshot_metadata if registry_id is not None: self.registry_id = registry_id - - @property - def versioned_flow_snapshot_metadata(self): - """ - Gets the versioned_flow_snapshot_metadata of this VersionedFlowSnapshotMetadataEntity. - The collection of registered flow snapshot metadata - - :return: The versioned_flow_snapshot_metadata of this VersionedFlowSnapshotMetadataEntity. - :rtype: RegisteredFlowSnapshotMetadata - """ - return self._versioned_flow_snapshot_metadata - - @versioned_flow_snapshot_metadata.setter - def versioned_flow_snapshot_metadata(self, versioned_flow_snapshot_metadata): - """ - Sets the versioned_flow_snapshot_metadata of this VersionedFlowSnapshotMetadataEntity. - The collection of registered flow snapshot metadata - - :param versioned_flow_snapshot_metadata: The versioned_flow_snapshot_metadata of this VersionedFlowSnapshotMetadataEntity. - :type: RegisteredFlowSnapshotMetadata - """ - - self._versioned_flow_snapshot_metadata = versioned_flow_snapshot_metadata + if versioned_flow_snapshot_metadata is not None: + self.versioned_flow_snapshot_metadata = versioned_flow_snapshot_metadata @property def registry_id(self): @@ -96,6 +70,27 @@ def registry_id(self, registry_id): self._registry_id = registry_id + @property + def versioned_flow_snapshot_metadata(self): + """ + Gets the versioned_flow_snapshot_metadata of this VersionedFlowSnapshotMetadataEntity. + + :return: The versioned_flow_snapshot_metadata of this VersionedFlowSnapshotMetadataEntity. + :rtype: RegisteredFlowSnapshotMetadata + """ + return self._versioned_flow_snapshot_metadata + + @versioned_flow_snapshot_metadata.setter + def versioned_flow_snapshot_metadata(self, versioned_flow_snapshot_metadata): + """ + Sets the versioned_flow_snapshot_metadata of this VersionedFlowSnapshotMetadataEntity. + + :param versioned_flow_snapshot_metadata: The versioned_flow_snapshot_metadata of this VersionedFlowSnapshotMetadataEntity. + :type: RegisteredFlowSnapshotMetadata + """ + + self._versioned_flow_snapshot_metadata = versioned_flow_snapshot_metadata + def to_dict(self): """ Returns the model properties as a dict 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 fbee25a8..5f180dd9 100644 --- a/nipyapi/nifi/models/versioned_flow_snapshot_metadata_set_entity.py +++ b/nipyapi/nifi/models/versioned_flow_snapshot_metadata_set_entity.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,12 +27,10 @@ class VersionedFlowSnapshotMetadataSetEntity(object): and the value is json key in definition. """ swagger_types = { - 'versioned_flow_snapshot_metadata_set': 'list[VersionedFlowSnapshotMetadataEntity]' - } + 'versioned_flow_snapshot_metadata_set': 'list[VersionedFlowSnapshotMetadataEntity]' } attribute_map = { - 'versioned_flow_snapshot_metadata_set': 'versionedFlowSnapshotMetadataSet' - } + 'versioned_flow_snapshot_metadata_set': 'versionedFlowSnapshotMetadataSet' } def __init__(self, versioned_flow_snapshot_metadata_set=None): """ diff --git a/nipyapi/nifi/models/versioned_flow_update_request_dto.py b/nipyapi/nifi/models/versioned_flow_update_request_dto.py index 0e84523a..4c2e3098 100644 --- a/nipyapi/nifi/models/versioned_flow_update_request_dto.py +++ b/nipyapi/nifi/models/versioned_flow_update_request_dto.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,131 +27,106 @@ class VersionedFlowUpdateRequestDTO(object): and the value is json key in definition. """ swagger_types = { - 'request_id': 'str', - 'process_group_id': 'str', - 'uri': 'str', - 'last_updated': 'str', 'complete': 'bool', - 'failure_reason': 'str', - 'percent_completed': 'int', - 'state': 'str', - 'version_control_information': 'VersionControlInformationDTO' - } +'failure_reason': 'str', +'last_updated': 'str', +'percent_completed': 'int', +'process_group_id': 'str', +'request_id': 'str', +'state': 'str', +'uri': 'str', +'version_control_information': 'VersionControlInformationDTO' } attribute_map = { - 'request_id': 'requestId', - 'process_group_id': 'processGroupId', - 'uri': 'uri', - 'last_updated': 'lastUpdated', 'complete': 'complete', - 'failure_reason': 'failureReason', - 'percent_completed': 'percentCompleted', - 'state': 'state', - 'version_control_information': 'versionControlInformation' - } +'failure_reason': 'failureReason', +'last_updated': 'lastUpdated', +'percent_completed': 'percentCompleted', +'process_group_id': 'processGroupId', +'request_id': 'requestId', +'state': 'state', +'uri': 'uri', +'version_control_information': 'versionControlInformation' } - def __init__(self, request_id=None, process_group_id=None, uri=None, last_updated=None, complete=None, failure_reason=None, percent_completed=None, state=None, version_control_information=None): + def __init__(self, complete=None, failure_reason=None, last_updated=None, percent_completed=None, process_group_id=None, request_id=None, state=None, uri=None, version_control_information=None): """ VersionedFlowUpdateRequestDTO - a model defined in Swagger """ - self._request_id = None - self._process_group_id = None - self._uri = None - self._last_updated = None self._complete = None self._failure_reason = None + self._last_updated = None self._percent_completed = None + self._process_group_id = None + self._request_id = None self._state = None + self._uri = None self._version_control_information = None - if request_id is not None: - self.request_id = request_id - if process_group_id is not None: - self.process_group_id = process_group_id - if uri is not None: - self.uri = uri - if last_updated is not None: - self.last_updated = last_updated if complete is not None: self.complete = complete if failure_reason is not None: self.failure_reason = failure_reason + if last_updated is not None: + self.last_updated = last_updated if percent_completed is not None: self.percent_completed = percent_completed + if process_group_id is not None: + self.process_group_id = process_group_id + if request_id is not None: + self.request_id = request_id if state is not None: self.state = state + if uri is not None: + self.uri = uri if version_control_information is not None: self.version_control_information = version_control_information @property - def request_id(self): - """ - Gets the request_id of this VersionedFlowUpdateRequestDTO. - The unique ID of this request. - - :return: The request_id of this VersionedFlowUpdateRequestDTO. - :rtype: str - """ - return self._request_id - - @request_id.setter - def request_id(self, request_id): - """ - Sets the request_id of this VersionedFlowUpdateRequestDTO. - The unique ID of this request. - - :param request_id: The request_id of this VersionedFlowUpdateRequestDTO. - :type: str - """ - - self._request_id = request_id - - @property - def process_group_id(self): + def complete(self): """ - Gets the process_group_id of this VersionedFlowUpdateRequestDTO. - The unique ID of the Process Group being updated + Gets the complete of this VersionedFlowUpdateRequestDTO. + Whether or not this request has completed - :return: The process_group_id of this VersionedFlowUpdateRequestDTO. - :rtype: str + :return: The complete of this VersionedFlowUpdateRequestDTO. + :rtype: bool """ - return self._process_group_id + return self._complete - @process_group_id.setter - def process_group_id(self, process_group_id): + @complete.setter + def complete(self, complete): """ - Sets the process_group_id of this VersionedFlowUpdateRequestDTO. - The unique ID of the Process Group being updated + Sets the complete of this VersionedFlowUpdateRequestDTO. + Whether or not this request has completed - :param process_group_id: The process_group_id of this VersionedFlowUpdateRequestDTO. - :type: str + :param complete: The complete of this VersionedFlowUpdateRequestDTO. + :type: bool """ - self._process_group_id = process_group_id + self._complete = complete @property - def uri(self): + def failure_reason(self): """ - Gets the uri of this VersionedFlowUpdateRequestDTO. - The URI for future requests to this drop request. + Gets the failure_reason of this VersionedFlowUpdateRequestDTO. + An explanation of why this request failed, or null if this request has not failed - :return: The uri of this VersionedFlowUpdateRequestDTO. + :return: The failure_reason of this VersionedFlowUpdateRequestDTO. :rtype: str """ - return self._uri + return self._failure_reason - @uri.setter - def uri(self, uri): + @failure_reason.setter + def failure_reason(self, failure_reason): """ - Sets the uri of this VersionedFlowUpdateRequestDTO. - The URI for future requests to this drop request. + Sets the failure_reason of this VersionedFlowUpdateRequestDTO. + An explanation of why this request failed, or null if this request has not failed - :param uri: The uri of this VersionedFlowUpdateRequestDTO. + :param failure_reason: The failure_reason of this VersionedFlowUpdateRequestDTO. :type: str """ - self._uri = uri + self._failure_reason = failure_reason @property def last_updated(self): @@ -178,73 +152,73 @@ def last_updated(self, last_updated): self._last_updated = last_updated @property - def complete(self): + def percent_completed(self): """ - Gets the complete of this VersionedFlowUpdateRequestDTO. - Whether or not this request has completed + Gets the percent_completed of this VersionedFlowUpdateRequestDTO. + The percentage complete for the request, between 0 and 100 - :return: The complete of this VersionedFlowUpdateRequestDTO. - :rtype: bool + :return: The percent_completed of this VersionedFlowUpdateRequestDTO. + :rtype: int """ - return self._complete + return self._percent_completed - @complete.setter - def complete(self, complete): + @percent_completed.setter + def percent_completed(self, percent_completed): """ - Sets the complete of this VersionedFlowUpdateRequestDTO. - Whether or not this request has completed + Sets the percent_completed of this VersionedFlowUpdateRequestDTO. + The percentage complete for the request, between 0 and 100 - :param complete: The complete of this VersionedFlowUpdateRequestDTO. - :type: bool + :param percent_completed: The percent_completed of this VersionedFlowUpdateRequestDTO. + :type: int """ - self._complete = complete + self._percent_completed = percent_completed @property - def failure_reason(self): + def process_group_id(self): """ - Gets the failure_reason of this VersionedFlowUpdateRequestDTO. - An explanation of why this request failed, or null if this request has not failed + Gets the process_group_id of this VersionedFlowUpdateRequestDTO. + The unique ID of the Process Group being updated - :return: The failure_reason of this VersionedFlowUpdateRequestDTO. + :return: The process_group_id of this VersionedFlowUpdateRequestDTO. :rtype: str """ - return self._failure_reason + return self._process_group_id - @failure_reason.setter - def failure_reason(self, failure_reason): + @process_group_id.setter + def process_group_id(self, process_group_id): """ - Sets the failure_reason of this VersionedFlowUpdateRequestDTO. - An explanation of why this request failed, or null if this request has not failed + Sets the process_group_id of this VersionedFlowUpdateRequestDTO. + The unique ID of the Process Group being updated - :param failure_reason: The failure_reason of this VersionedFlowUpdateRequestDTO. + :param process_group_id: The process_group_id of this VersionedFlowUpdateRequestDTO. :type: str """ - self._failure_reason = failure_reason + self._process_group_id = process_group_id @property - def percent_completed(self): + def request_id(self): """ - Gets the percent_completed of this VersionedFlowUpdateRequestDTO. - The percentage complete for the request, between 0 and 100 + Gets the request_id of this VersionedFlowUpdateRequestDTO. + The unique ID of this request. - :return: The percent_completed of this VersionedFlowUpdateRequestDTO. - :rtype: int + :return: The request_id of this VersionedFlowUpdateRequestDTO. + :rtype: str """ - return self._percent_completed + return self._request_id - @percent_completed.setter - def percent_completed(self, percent_completed): + @request_id.setter + def request_id(self, request_id): """ - Sets the percent_completed of this VersionedFlowUpdateRequestDTO. - The percentage complete for the request, between 0 and 100 + Sets the request_id of this VersionedFlowUpdateRequestDTO. + The unique ID of this request. - :param percent_completed: The percent_completed of this VersionedFlowUpdateRequestDTO. - :type: int + :param request_id: The request_id of this VersionedFlowUpdateRequestDTO. + :type: str """ - self._percent_completed = percent_completed + self._request_id = request_id @property def state(self): @@ -269,11 +243,33 @@ def state(self, state): self._state = state + @property + def uri(self): + """ + Gets the uri of this VersionedFlowUpdateRequestDTO. + The URI for future requests to this drop request. + + :return: The uri of this VersionedFlowUpdateRequestDTO. + :rtype: str + """ + return self._uri + + @uri.setter + def uri(self, uri): + """ + Sets the uri of this VersionedFlowUpdateRequestDTO. + The URI for future requests to this drop request. + + :param uri: The uri of this VersionedFlowUpdateRequestDTO. + :type: str + """ + + self._uri = uri + @property def version_control_information(self): """ Gets the version_control_information of this VersionedFlowUpdateRequestDTO. - The VersionControlInformation that describes where the Versioned Flow is located; this may not be populated until the request is completed. :return: The version_control_information of this VersionedFlowUpdateRequestDTO. :rtype: VersionControlInformationDTO @@ -284,7 +280,6 @@ def version_control_information(self): def version_control_information(self, version_control_information): """ Sets the version_control_information of this VersionedFlowUpdateRequestDTO. - The VersionControlInformation that describes where the Versioned Flow is located; this may not be populated until the request is completed. :param version_control_information: The version_control_information of this VersionedFlowUpdateRequestDTO. :type: VersionControlInformationDTO diff --git a/nipyapi/nifi/models/versioned_flow_update_request_entity.py b/nipyapi/nifi/models/versioned_flow_update_request_entity.py index dca446c8..606c71ba 100644 --- a/nipyapi/nifi/models/versioned_flow_update_request_entity.py +++ b/nipyapi/nifi/models/versioned_flow_update_request_entity.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -29,13 +28,11 @@ class VersionedFlowUpdateRequestEntity(object): """ swagger_types = { 'process_group_revision': 'RevisionDTO', - 'request': 'VersionedFlowUpdateRequestDTO' - } +'request': 'VersionedFlowUpdateRequestDTO' } attribute_map = { 'process_group_revision': 'processGroupRevision', - 'request': 'request' - } +'request': 'request' } def __init__(self, process_group_revision=None, request=None): """ @@ -54,7 +51,6 @@ def __init__(self, process_group_revision=None, request=None): def process_group_revision(self): """ Gets the process_group_revision of this VersionedFlowUpdateRequestEntity. - The revision for the Process Group being updated. :return: The process_group_revision of this VersionedFlowUpdateRequestEntity. :rtype: RevisionDTO @@ -65,7 +61,6 @@ def process_group_revision(self): def process_group_revision(self, process_group_revision): """ Sets the process_group_revision of this VersionedFlowUpdateRequestEntity. - The revision for the Process Group being updated. :param process_group_revision: The process_group_revision of this VersionedFlowUpdateRequestEntity. :type: RevisionDTO @@ -77,7 +72,6 @@ def process_group_revision(self, process_group_revision): def request(self): """ Gets the request of this VersionedFlowUpdateRequestEntity. - The Flow Update Request :return: The request of this VersionedFlowUpdateRequestEntity. :rtype: VersionedFlowUpdateRequestDTO @@ -88,7 +82,6 @@ def request(self): def request(self, request): """ Sets the request of this VersionedFlowUpdateRequestEntity. - The Flow Update Request :param request: The request of this VersionedFlowUpdateRequestEntity. :type: VersionedFlowUpdateRequestDTO diff --git a/nipyapi/nifi/models/versioned_flows_entity.py b/nipyapi/nifi/models/versioned_flows_entity.py index 10c81d55..959a34de 100644 --- a/nipyapi/nifi/models/versioned_flows_entity.py +++ b/nipyapi/nifi/models/versioned_flows_entity.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,12 +27,10 @@ class VersionedFlowsEntity(object): and the value is json key in definition. """ swagger_types = { - 'versioned_flows': 'list[VersionedFlowEntity]' - } + 'versioned_flows': 'list[VersionedFlowEntity]' } attribute_map = { - 'versioned_flows': 'versionedFlows' - } + 'versioned_flows': 'versionedFlows' } def __init__(self, versioned_flows=None): """ diff --git a/nipyapi/nifi/models/versioned_funnel.py b/nipyapi/nifi/models/versioned_funnel.py index 1c9485c5..6d9b4582 100644 --- a/nipyapi/nifi/models/versioned_funnel.py +++ b/nipyapi/nifi/models/versioned_funnel.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,52 +27,123 @@ class VersionedFunnel(object): and the value is json key in definition. """ swagger_types = { - 'identifier': 'str', - 'instance_identifier': 'str', - 'name': 'str', 'comments': 'str', - 'position': 'Position', - 'component_type': 'str', - 'group_identifier': 'str' - } +'component_type': 'str', +'group_identifier': 'str', +'identifier': 'str', +'instance_identifier': 'str', +'name': 'str', +'position': 'Position' } attribute_map = { - 'identifier': 'identifier', - 'instance_identifier': 'instanceIdentifier', - 'name': 'name', 'comments': 'comments', - 'position': 'position', - 'component_type': 'componentType', - 'group_identifier': 'groupIdentifier' - } +'component_type': 'componentType', +'group_identifier': 'groupIdentifier', +'identifier': 'identifier', +'instance_identifier': 'instanceIdentifier', +'name': 'name', +'position': 'position' } - def __init__(self, identifier=None, instance_identifier=None, name=None, comments=None, position=None, component_type=None, group_identifier=None): + def __init__(self, comments=None, component_type=None, group_identifier=None, identifier=None, instance_identifier=None, name=None, position=None): """ VersionedFunnel - a model defined in Swagger """ + self._comments = None + self._component_type = None + self._group_identifier = None self._identifier = None self._instance_identifier = None self._name = None - self._comments = None self._position = None - self._component_type = None - self._group_identifier = None + if comments is not None: + self.comments = comments + if component_type is not None: + self.component_type = component_type + if group_identifier is not None: + self.group_identifier = group_identifier if identifier is not None: self.identifier = identifier if instance_identifier is not None: self.instance_identifier = instance_identifier if name is not None: self.name = name - if comments is not None: - self.comments = comments if position is not None: self.position = position - if component_type is not None: - self.component_type = component_type - if group_identifier is not None: - self.group_identifier = group_identifier + + @property + def comments(self): + """ + Gets the comments of this VersionedFunnel. + The user-supplied comments for the component + + :return: The comments of this VersionedFunnel. + :rtype: str + """ + return self._comments + + @comments.setter + def comments(self, comments): + """ + Sets the comments of this VersionedFunnel. + The user-supplied comments for the component + + :param comments: The comments of this VersionedFunnel. + :type: str + """ + + self._comments = comments + + @property + def component_type(self): + """ + Gets the component_type of this VersionedFunnel. + + :return: The component_type of this VersionedFunnel. + :rtype: str + """ + return self._component_type + + @component_type.setter + def component_type(self, component_type): + """ + Sets the component_type of this VersionedFunnel. + + :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", ] + 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 + + @property + def group_identifier(self): + """ + Gets the group_identifier of this VersionedFunnel. + The ID of the Process Group that this component belongs to + + :return: The group_identifier of this VersionedFunnel. + :rtype: str + """ + return self._group_identifier + + @group_identifier.setter + def group_identifier(self, group_identifier): + """ + Sets the group_identifier of this VersionedFunnel. + The ID of the Process Group that this component belongs to + + :param group_identifier: The group_identifier of this VersionedFunnel. + :type: str + """ + + self._group_identifier = group_identifier @property def identifier(self): @@ -144,34 +214,10 @@ def name(self, name): self._name = name - @property - def comments(self): - """ - Gets the comments of this VersionedFunnel. - The user-supplied comments for the component - - :return: The comments of this VersionedFunnel. - :rtype: str - """ - return self._comments - - @comments.setter - def comments(self, comments): - """ - Sets the comments of this VersionedFunnel. - The user-supplied comments for the component - - :param comments: The comments of this VersionedFunnel. - :type: str - """ - - self._comments = comments - @property def position(self): """ Gets the position of this VersionedFunnel. - The component's position on the graph :return: The position of this VersionedFunnel. :rtype: Position @@ -182,7 +228,6 @@ def position(self): def position(self, position): """ Sets the position of this VersionedFunnel. - The component's position on the graph :param position: The position of this VersionedFunnel. :type: Position @@ -190,56 +235,6 @@ def position(self, position): self._position = position - @property - def component_type(self): - """ - Gets the component_type of this VersionedFunnel. - - :return: The component_type of this VersionedFunnel. - :rtype: str - """ - return self._component_type - - @component_type.setter - def component_type(self, component_type): - """ - Sets the component_type of this VersionedFunnel. - - :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", "PARAMETER_CONTEXT", "PARAMETER_PROVIDER", "TEMPLATE", "FLOW_REGISTRY_CLIENT"] - 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 - - @property - def group_identifier(self): - """ - Gets the group_identifier of this VersionedFunnel. - The ID of the Process Group that this component belongs to - - :return: The group_identifier of this VersionedFunnel. - :rtype: str - """ - return self._group_identifier - - @group_identifier.setter - def group_identifier(self, group_identifier): - """ - Sets the group_identifier of this VersionedFunnel. - The ID of the Process Group that this component belongs to - - :param group_identifier: The group_identifier of this VersionedFunnel. - :type: str - """ - - self._group_identifier = group_identifier - def to_dict(self): """ Returns the model properties as a dict diff --git a/nipyapi/nifi/models/versioned_label.py b/nipyapi/nifi/models/versioned_label.py index 8ca43bb9..fd4e8334 100644 --- a/nipyapi/nifi/models/versioned_label.py +++ b/nipyapi/nifi/models/versioned_label.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,192 +27,217 @@ class VersionedLabel(object): and the value is json key in definition. """ swagger_types = { - 'identifier': 'str', - 'instance_identifier': 'str', - 'name': 'str', 'comments': 'str', - 'position': 'Position', - 'label': 'str', - 'z_index': 'int', - 'width': 'float', - 'height': 'float', - 'style': 'dict(str, str)', - 'component_type': 'str', - 'group_identifier': 'str' - } +'component_type': 'str', +'group_identifier': 'str', +'height': 'float', +'identifier': 'str', +'instance_identifier': 'str', +'label': 'str', +'name': 'str', +'position': 'Position', +'style': 'dict(str, str)', +'width': 'float', +'z_index': 'int' } attribute_map = { - 'identifier': 'identifier', - 'instance_identifier': 'instanceIdentifier', - 'name': 'name', 'comments': 'comments', - 'position': 'position', - 'label': 'label', - 'z_index': 'zIndex', - 'width': 'width', - 'height': 'height', - 'style': 'style', - 'component_type': 'componentType', - 'group_identifier': 'groupIdentifier' - } - - def __init__(self, identifier=None, instance_identifier=None, name=None, comments=None, position=None, label=None, z_index=None, width=None, height=None, style=None, component_type=None, group_identifier=None): +'component_type': 'componentType', +'group_identifier': 'groupIdentifier', +'height': 'height', +'identifier': 'identifier', +'instance_identifier': 'instanceIdentifier', +'label': 'label', +'name': 'name', +'position': 'position', +'style': 'style', +'width': 'width', +'z_index': 'zIndex' } + + def __init__(self, comments=None, component_type=None, group_identifier=None, height=None, identifier=None, instance_identifier=None, label=None, name=None, position=None, style=None, width=None, z_index=None): """ VersionedLabel - a model defined in Swagger """ + self._comments = None + self._component_type = None + self._group_identifier = None + self._height = None self._identifier = None self._instance_identifier = None + self._label = None self._name = None - self._comments = None self._position = None - self._label = None - self._z_index = None - self._width = None - self._height = None self._style = None - self._component_type = None - self._group_identifier = None + self._width = None + self._z_index = None + if comments is not None: + self.comments = comments + if component_type is not None: + self.component_type = component_type + if group_identifier is not None: + self.group_identifier = group_identifier + if height is not None: + self.height = height if identifier is not None: self.identifier = identifier if instance_identifier is not None: self.instance_identifier = instance_identifier + if label is not None: + self.label = label if name is not None: self.name = name - if comments is not None: - self.comments = comments if position is not None: self.position = position - if label is not None: - self.label = label - if z_index is not None: - self.z_index = z_index - if width is not None: - self.width = width - if height is not None: - self.height = height if style is not None: self.style = style - if component_type is not None: - self.component_type = component_type - if group_identifier is not None: - self.group_identifier = group_identifier + if width is not None: + self.width = width + if z_index is not None: + self.z_index = z_index @property - def identifier(self): + def comments(self): """ - Gets the identifier of this VersionedLabel. - The component's unique identifier + Gets the comments of this VersionedLabel. + The user-supplied comments for the component - :return: The identifier of this VersionedLabel. + :return: The comments of this VersionedLabel. :rtype: str """ - return self._identifier + return self._comments - @identifier.setter - def identifier(self, identifier): + @comments.setter + def comments(self, comments): """ - Sets the identifier of this VersionedLabel. - The component's unique identifier + Sets the comments of this VersionedLabel. + The user-supplied comments for the component - :param identifier: The identifier of this VersionedLabel. + :param comments: The comments of this VersionedLabel. :type: str """ - self._identifier = identifier + self._comments = comments @property - def instance_identifier(self): + def component_type(self): """ - Gets the instance_identifier of this VersionedLabel. - The instance ID of an existing component that is described by this VersionedComponent, or null if this is not mapped to an instantiated component + Gets the component_type of this VersionedLabel. - :return: The instance_identifier of this VersionedLabel. + :return: The component_type of this VersionedLabel. :rtype: str """ - return self._instance_identifier + return self._component_type - @instance_identifier.setter - def instance_identifier(self, instance_identifier): + @component_type.setter + def component_type(self, component_type): """ - Sets the instance_identifier of this VersionedLabel. - The instance ID of an existing component that is described by this VersionedComponent, or null if this is not mapped to an instantiated component + Sets the component_type of this VersionedLabel. - :param instance_identifier: The instance_identifier of this VersionedLabel. + :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", ] + 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._instance_identifier = instance_identifier + self._component_type = component_type @property - def name(self): + def group_identifier(self): """ - Gets the name of this VersionedLabel. - The component's name + Gets the group_identifier of this VersionedLabel. + The ID of the Process Group that this component belongs to - :return: The name of this VersionedLabel. + :return: The group_identifier of this VersionedLabel. :rtype: str """ - return self._name + return self._group_identifier - @name.setter - def name(self, name): + @group_identifier.setter + def group_identifier(self, group_identifier): """ - Sets the name of this VersionedLabel. - The component's name + Sets the group_identifier of this VersionedLabel. + The ID of the Process Group that this component belongs to - :param name: The name of this VersionedLabel. + :param group_identifier: The group_identifier of this VersionedLabel. :type: str """ - self._name = name + self._group_identifier = group_identifier @property - def comments(self): + def height(self): """ - Gets the comments of this VersionedLabel. - The user-supplied comments for the component + Gets the height of this VersionedLabel. + The height of the label in pixels when at a 1:1 scale. - :return: The comments of this VersionedLabel. + :return: The height of this VersionedLabel. + :rtype: float + """ + return self._height + + @height.setter + def height(self, height): + """ + Sets the height of this VersionedLabel. + The height of the label in pixels when at a 1:1 scale. + + :param height: The height of this VersionedLabel. + :type: float + """ + + self._height = height + + @property + def identifier(self): + """ + Gets the identifier of this VersionedLabel. + The component's unique identifier + + :return: The identifier of this VersionedLabel. :rtype: str """ - return self._comments + return self._identifier - @comments.setter - def comments(self, comments): + @identifier.setter + def identifier(self, identifier): """ - Sets the comments of this VersionedLabel. - The user-supplied comments for the component + Sets the identifier of this VersionedLabel. + The component's unique identifier - :param comments: The comments of this VersionedLabel. + :param identifier: The identifier of this VersionedLabel. :type: str """ - self._comments = comments + self._identifier = identifier @property - def position(self): + def instance_identifier(self): """ - Gets the position of this VersionedLabel. - The component's position on the graph + Gets the instance_identifier of this VersionedLabel. + The instance ID of an existing component that is described by this VersionedComponent, or null if this is not mapped to an instantiated component - :return: The position of this VersionedLabel. - :rtype: Position + :return: The instance_identifier of this VersionedLabel. + :rtype: str """ - return self._position + return self._instance_identifier - @position.setter - def position(self, position): + @instance_identifier.setter + def instance_identifier(self, instance_identifier): """ - Sets the position of this VersionedLabel. - The component's position on the graph + Sets the instance_identifier of this VersionedLabel. + The instance ID of an existing component that is described by this VersionedComponent, or null if this is not mapped to an instantiated component - :param position: The position of this VersionedLabel. - :type: Position + :param instance_identifier: The instance_identifier of this VersionedLabel. + :type: str """ - self._position = position + self._instance_identifier = instance_identifier @property def label(self): @@ -239,73 +263,48 @@ def label(self, label): self._label = label @property - def z_index(self): - """ - Gets the z_index of this VersionedLabel. - The z index of the connection. - - :return: The z_index of this VersionedLabel. - :rtype: int - """ - return self._z_index - - @z_index.setter - def z_index(self, z_index): - """ - Sets the z_index of this VersionedLabel. - The z index of the connection. - - :param z_index: The z_index of this VersionedLabel. - :type: int - """ - - self._z_index = z_index - - @property - def width(self): + def name(self): """ - Gets the width of this VersionedLabel. - The width of the label in pixels when at a 1:1 scale. + Gets the name of this VersionedLabel. + The component's name - :return: The width of this VersionedLabel. - :rtype: float + :return: The name of this VersionedLabel. + :rtype: str """ - return self._width + return self._name - @width.setter - def width(self, width): + @name.setter + def name(self, name): """ - Sets the width of this VersionedLabel. - The width of the label in pixels when at a 1:1 scale. + Sets the name of this VersionedLabel. + The component's name - :param width: The width of this VersionedLabel. - :type: float + :param name: The name of this VersionedLabel. + :type: str """ - self._width = width + self._name = name @property - def height(self): + def position(self): """ - Gets the height of this VersionedLabel. - The height of the label in pixels when at a 1:1 scale. + Gets the position of this VersionedLabel. - :return: The height of this VersionedLabel. - :rtype: float + :return: The position of this VersionedLabel. + :rtype: Position """ - return self._height + return self._position - @height.setter - def height(self, height): + @position.setter + def position(self, position): """ - Sets the height of this VersionedLabel. - The height of the label in pixels when at a 1:1 scale. + Sets the position of this VersionedLabel. - :param height: The height of this VersionedLabel. - :type: float + :param position: The position of this VersionedLabel. + :type: Position """ - self._height = height + self._position = position @property def style(self): @@ -331,54 +330,50 @@ def style(self, style): self._style = style @property - def component_type(self): + def width(self): """ - Gets the component_type of this VersionedLabel. + Gets the width of this VersionedLabel. + The width of the label in pixels when at a 1:1 scale. - :return: The component_type of this VersionedLabel. - :rtype: str + :return: The width of this VersionedLabel. + :rtype: float """ - return self._component_type + return self._width - @component_type.setter - def component_type(self, component_type): + @width.setter + def width(self, width): """ - Sets the component_type of this VersionedLabel. + Sets the width of this VersionedLabel. + The width of the label in pixels when at a 1:1 scale. - :param component_type: The component_type of this VersionedLabel. - :type: str + :param width: The width of this VersionedLabel. + :type: float """ - 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", "PARAMETER_CONTEXT", "PARAMETER_PROVIDER", "TEMPLATE", "FLOW_REGISTRY_CLIENT"] - 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 + self._width = width @property - def group_identifier(self): + def z_index(self): """ - Gets the group_identifier of this VersionedLabel. - The ID of the Process Group that this component belongs to + Gets the z_index of this VersionedLabel. + The z index of the connection. - :return: The group_identifier of this VersionedLabel. - :rtype: str + :return: The z_index of this VersionedLabel. + :rtype: int """ - return self._group_identifier + return self._z_index - @group_identifier.setter - def group_identifier(self, group_identifier): + @z_index.setter + def z_index(self, z_index): """ - Sets the group_identifier of this VersionedLabel. - The ID of the Process Group that this component belongs to + Sets the z_index of this VersionedLabel. + The z index of the connection. - :param group_identifier: The group_identifier of this VersionedLabel. - :type: str + :param z_index: The z_index of this VersionedLabel. + :type: int """ - self._group_identifier = group_identifier + self._z_index = z_index def to_dict(self): """ diff --git a/nipyapi/nifi/models/versioned_parameter.py b/nipyapi/nifi/models/versioned_parameter.py index 8938d7e7..f3c03209 100644 --- a/nipyapi/nifi/models/versioned_parameter.py +++ b/nipyapi/nifi/models/versioned_parameter.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,66 +27,46 @@ class VersionedParameter(object): and the value is json key in definition. """ swagger_types = { - 'name': 'str', 'description': 'str', - 'sensitive': 'bool', - 'provided': 'bool', - 'value': 'str' - } +'name': 'str', +'provided': 'bool', +'referenced_assets': 'list[VersionedAsset]', +'sensitive': 'bool', +'value': 'str' } attribute_map = { - 'name': 'name', 'description': 'description', - 'sensitive': 'sensitive', - 'provided': 'provided', - 'value': 'value' - } +'name': 'name', +'provided': 'provided', +'referenced_assets': 'referencedAssets', +'sensitive': 'sensitive', +'value': 'value' } - def __init__(self, name=None, description=None, sensitive=None, provided=None, value=None): + def __init__(self, description=None, name=None, provided=None, referenced_assets=None, sensitive=None, value=None): """ VersionedParameter - a model defined in Swagger """ - self._name = None self._description = None - self._sensitive = None + self._name = None self._provided = None + self._referenced_assets = None + self._sensitive = None self._value = None - if name is not None: - self.name = name if description is not None: self.description = description - if sensitive is not None: - self.sensitive = sensitive + if name is not None: + self.name = name if provided is not None: self.provided = provided + if referenced_assets is not None: + self.referenced_assets = referenced_assets + if sensitive is not None: + self.sensitive = sensitive if value is not None: self.value = value - @property - def name(self): - """ - Gets the name of this VersionedParameter. - The name of the parameter - - :return: The name of this VersionedParameter. - :rtype: str - """ - return self._name - - @name.setter - def name(self, name): - """ - Sets the name of this VersionedParameter. - The name of the parameter - - :param name: The name of this VersionedParameter. - :type: str - """ - - self._name = name - @property def description(self): """ @@ -112,27 +91,27 @@ def description(self, description): self._description = description @property - def sensitive(self): + def name(self): """ - Gets the sensitive of this VersionedParameter. - Whether or not the parameter value is sensitive + Gets the name of this VersionedParameter. + The name of the parameter - :return: The sensitive of this VersionedParameter. - :rtype: bool + :return: The name of this VersionedParameter. + :rtype: str """ - return self._sensitive + return self._name - @sensitive.setter - def sensitive(self, sensitive): + @name.setter + def name(self, name): """ - Sets the sensitive of this VersionedParameter. - Whether or not the parameter value is sensitive + Sets the name of this VersionedParameter. + The name of the parameter - :param sensitive: The sensitive of this VersionedParameter. - :type: bool + :param name: The name of this VersionedParameter. + :type: str """ - self._sensitive = sensitive + self._name = name @property def provided(self): @@ -157,6 +136,52 @@ def provided(self, provided): self._provided = provided + @property + def referenced_assets(self): + """ + Gets the referenced_assets of this VersionedParameter. + The assets that are referenced by this parameter + + :return: The referenced_assets of this VersionedParameter. + :rtype: list[VersionedAsset] + """ + return self._referenced_assets + + @referenced_assets.setter + def referenced_assets(self, referenced_assets): + """ + Sets the referenced_assets of this VersionedParameter. + The assets that are referenced by this parameter + + :param referenced_assets: The referenced_assets of this VersionedParameter. + :type: list[VersionedAsset] + """ + + self._referenced_assets = referenced_assets + + @property + def sensitive(self): + """ + Gets the sensitive of this VersionedParameter. + Whether or not the parameter value is sensitive + + :return: The sensitive of this VersionedParameter. + :rtype: bool + """ + return self._sensitive + + @sensitive.setter + def sensitive(self, sensitive): + """ + Sets the sensitive of this VersionedParameter. + Whether or not the parameter value is sensitive + + :param sensitive: The sensitive of this VersionedParameter. + :type: bool + """ + + self._sensitive = sensitive + @property def value(self): """ diff --git a/nipyapi/nifi/models/versioned_parameter_context.py b/nipyapi/nifi/models/versioned_parameter_context.py index 667163a0..91e27477 100644 --- a/nipyapi/nifi/models/versioned_parameter_context.py +++ b/nipyapi/nifi/models/versioned_parameter_context.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,220 +27,199 @@ class VersionedParameterContext(object): and the value is json key in definition. """ swagger_types = { - 'identifier': 'str', - 'instance_identifier': 'str', - 'name': 'str', 'comments': 'str', - 'position': 'Position', - 'parameters': 'list[VersionedParameter]', - 'inherited_parameter_contexts': 'list[str]', - 'description': 'str', - 'parameter_provider': 'str', - 'parameter_group_name': 'str', - 'component_type': 'str', - 'synchronized': 'bool', - 'group_identifier': 'str' - } +'component_type': 'str', +'description': 'str', +'group_identifier': 'str', +'identifier': 'str', +'inherited_parameter_contexts': 'list[str]', +'instance_identifier': 'str', +'name': 'str', +'parameter_group_name': 'str', +'parameter_provider': 'str', +'parameters': 'list[VersionedParameter]', +'position': 'Position', +'synchronized': 'bool' } attribute_map = { - 'identifier': 'identifier', - 'instance_identifier': 'instanceIdentifier', - 'name': 'name', 'comments': 'comments', - 'position': 'position', - 'parameters': 'parameters', - 'inherited_parameter_contexts': 'inheritedParameterContexts', - 'description': 'description', - 'parameter_provider': 'parameterProvider', - 'parameter_group_name': 'parameterGroupName', - 'component_type': 'componentType', - 'synchronized': 'synchronized', - 'group_identifier': 'groupIdentifier' - } - - def __init__(self, identifier=None, instance_identifier=None, name=None, comments=None, position=None, parameters=None, inherited_parameter_contexts=None, description=None, parameter_provider=None, parameter_group_name=None, component_type=None, synchronized=None, group_identifier=None): +'component_type': 'componentType', +'description': 'description', +'group_identifier': 'groupIdentifier', +'identifier': 'identifier', +'inherited_parameter_contexts': 'inheritedParameterContexts', +'instance_identifier': 'instanceIdentifier', +'name': 'name', +'parameter_group_name': 'parameterGroupName', +'parameter_provider': 'parameterProvider', +'parameters': 'parameters', +'position': 'position', +'synchronized': 'synchronized' } + + def __init__(self, comments=None, component_type=None, description=None, group_identifier=None, identifier=None, inherited_parameter_contexts=None, instance_identifier=None, name=None, parameter_group_name=None, parameter_provider=None, parameters=None, position=None, synchronized=None): """ VersionedParameterContext - a model defined in Swagger """ + self._comments = None + self._component_type = None + self._description = None + self._group_identifier = None self._identifier = None + self._inherited_parameter_contexts = None self._instance_identifier = None self._name = None - self._comments = None - self._position = None - self._parameters = None - self._inherited_parameter_contexts = None - self._description = None - self._parameter_provider = None self._parameter_group_name = None - self._component_type = None + self._parameter_provider = None + self._parameters = None + self._position = None self._synchronized = None - self._group_identifier = None + if comments is not None: + self.comments = comments + if component_type is not None: + self.component_type = component_type + if description is not None: + self.description = description + if group_identifier is not None: + self.group_identifier = group_identifier if identifier is not None: self.identifier = identifier + if inherited_parameter_contexts is not None: + self.inherited_parameter_contexts = inherited_parameter_contexts if instance_identifier is not None: self.instance_identifier = instance_identifier if name is not None: self.name = name - if comments is not None: - self.comments = comments - if position is not None: - self.position = position - if parameters is not None: - self.parameters = parameters - if inherited_parameter_contexts is not None: - self.inherited_parameter_contexts = inherited_parameter_contexts - if description is not None: - self.description = description - if parameter_provider is not None: - self.parameter_provider = parameter_provider if parameter_group_name is not None: self.parameter_group_name = parameter_group_name - if component_type is not None: - self.component_type = component_type + if parameter_provider is not None: + self.parameter_provider = parameter_provider + if parameters is not None: + self.parameters = parameters + if position is not None: + self.position = position if synchronized is not None: self.synchronized = synchronized - if group_identifier is not None: - self.group_identifier = group_identifier @property - def identifier(self): + def comments(self): """ - Gets the identifier of this VersionedParameterContext. - The component's unique identifier + Gets the comments of this VersionedParameterContext. + The user-supplied comments for the component - :return: The identifier of this VersionedParameterContext. + :return: The comments of this VersionedParameterContext. :rtype: str """ - return self._identifier + return self._comments - @identifier.setter - def identifier(self, identifier): + @comments.setter + def comments(self, comments): """ - Sets the identifier of this VersionedParameterContext. - The component's unique identifier + Sets the comments of this VersionedParameterContext. + The user-supplied comments for the component - :param identifier: The identifier of this VersionedParameterContext. + :param comments: The comments of this VersionedParameterContext. :type: str """ - self._identifier = identifier + self._comments = comments @property - def instance_identifier(self): + def component_type(self): """ - Gets the instance_identifier of this VersionedParameterContext. - The instance ID of an existing component that is described by this VersionedComponent, or null if this is not mapped to an instantiated component + Gets the component_type of this VersionedParameterContext. - :return: The instance_identifier of this VersionedParameterContext. + :return: The component_type of this VersionedParameterContext. :rtype: str """ - return self._instance_identifier + return self._component_type - @instance_identifier.setter - def instance_identifier(self, instance_identifier): + @component_type.setter + def component_type(self, component_type): """ - Sets the instance_identifier of this VersionedParameterContext. - The instance ID of an existing component that is described by this VersionedComponent, or null if this is not mapped to an instantiated component + Sets the component_type of this VersionedParameterContext. - :param instance_identifier: The instance_identifier of this VersionedParameterContext. + :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", ] + 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._instance_identifier = instance_identifier + self._component_type = component_type @property - def name(self): + def description(self): """ - Gets the name of this VersionedParameterContext. - The component's name + Gets the description of this VersionedParameterContext. + The description of the parameter context - :return: The name of this VersionedParameterContext. + :return: The description of this VersionedParameterContext. :rtype: str """ - return self._name + return self._description - @name.setter - def name(self, name): + @description.setter + def description(self, description): """ - Sets the name of this VersionedParameterContext. - The component's name + Sets the description of this VersionedParameterContext. + The description of the parameter context - :param name: The name of this VersionedParameterContext. + :param description: The description of this VersionedParameterContext. :type: str """ - self._name = name + self._description = description @property - def comments(self): + def group_identifier(self): """ - Gets the comments of this VersionedParameterContext. - The user-supplied comments for the component + Gets the group_identifier of this VersionedParameterContext. + The ID of the Process Group that this component belongs to - :return: The comments of this VersionedParameterContext. + :return: The group_identifier of this VersionedParameterContext. :rtype: str """ - return self._comments + return self._group_identifier - @comments.setter - def comments(self, comments): + @group_identifier.setter + def group_identifier(self, group_identifier): """ - Sets the comments of this VersionedParameterContext. - The user-supplied comments for the component + Sets the group_identifier of this VersionedParameterContext. + The ID of the Process Group that this component belongs to - :param comments: The comments of this VersionedParameterContext. + :param group_identifier: The group_identifier of this VersionedParameterContext. :type: str """ - self._comments = comments - - @property - def position(self): - """ - Gets the position of this VersionedParameterContext. - The component's position on the graph - - :return: The position of this VersionedParameterContext. - :rtype: Position - """ - return self._position - - @position.setter - def position(self, position): - """ - Sets the position of this VersionedParameterContext. - The component's position on the graph - - :param position: The position of this VersionedParameterContext. - :type: Position - """ - - self._position = position + self._group_identifier = group_identifier @property - def parameters(self): + def identifier(self): """ - Gets the parameters of this VersionedParameterContext. - The parameters in the context + Gets the identifier of this VersionedParameterContext. + The component's unique identifier - :return: The parameters of this VersionedParameterContext. - :rtype: list[VersionedParameter] + :return: The identifier of this VersionedParameterContext. + :rtype: str """ - return self._parameters + return self._identifier - @parameters.setter - def parameters(self, parameters): + @identifier.setter + def identifier(self, identifier): """ - Sets the parameters of this VersionedParameterContext. - The parameters in the context + Sets the identifier of this VersionedParameterContext. + The component's unique identifier - :param parameters: The parameters of this VersionedParameterContext. - :type: list[VersionedParameter] + :param identifier: The identifier of this VersionedParameterContext. + :type: str """ - self._parameters = parameters + self._identifier = identifier @property def inherited_parameter_contexts(self): @@ -267,50 +245,50 @@ def inherited_parameter_contexts(self, inherited_parameter_contexts): self._inherited_parameter_contexts = inherited_parameter_contexts @property - def description(self): + def instance_identifier(self): """ - Gets the description of this VersionedParameterContext. - The description of the parameter context + Gets the instance_identifier of this VersionedParameterContext. + The instance ID of an existing component that is described by this VersionedComponent, or null if this is not mapped to an instantiated component - :return: The description of this VersionedParameterContext. + :return: The instance_identifier of this VersionedParameterContext. :rtype: str """ - return self._description + return self._instance_identifier - @description.setter - def description(self, description): + @instance_identifier.setter + def instance_identifier(self, instance_identifier): """ - Sets the description of this VersionedParameterContext. - The description of the parameter context + Sets the instance_identifier of this VersionedParameterContext. + The instance ID of an existing component that is described by this VersionedComponent, or null if this is not mapped to an instantiated component - :param description: The description of this VersionedParameterContext. + :param instance_identifier: The instance_identifier of this VersionedParameterContext. :type: str """ - self._description = description + self._instance_identifier = instance_identifier @property - def parameter_provider(self): + def name(self): """ - Gets the parameter_provider of this VersionedParameterContext. - The identifier of an optional parameter provider + Gets the name of this VersionedParameterContext. + The component's name - :return: The parameter_provider of this VersionedParameterContext. + :return: The name of this VersionedParameterContext. :rtype: str """ - return self._parameter_provider + return self._name - @parameter_provider.setter - def parameter_provider(self, parameter_provider): + @name.setter + def name(self, name): """ - Sets the parameter_provider of this VersionedParameterContext. - The identifier of an optional parameter provider + Sets the name of this VersionedParameterContext. + The component's name - :param parameter_provider: The parameter_provider of this VersionedParameterContext. + :param name: The name of this VersionedParameterContext. :type: str """ - self._parameter_provider = parameter_provider + self._name = name @property def parameter_group_name(self): @@ -336,31 +314,71 @@ def parameter_group_name(self, parameter_group_name): self._parameter_group_name = parameter_group_name @property - def component_type(self): + def parameter_provider(self): """ - Gets the component_type of this VersionedParameterContext. + Gets the parameter_provider of this VersionedParameterContext. + The identifier of an optional parameter provider - :return: The component_type of this VersionedParameterContext. + :return: The parameter_provider of this VersionedParameterContext. :rtype: str """ - return self._component_type + return self._parameter_provider - @component_type.setter - def component_type(self, component_type): + @parameter_provider.setter + def parameter_provider(self, parameter_provider): """ - Sets the component_type of this VersionedParameterContext. + Sets the parameter_provider of this VersionedParameterContext. + The identifier of an optional parameter provider - :param component_type: The component_type of this VersionedParameterContext. + :param parameter_provider: The parameter_provider 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", "PARAMETER_CONTEXT", "PARAMETER_PROVIDER", "TEMPLATE", "FLOW_REGISTRY_CLIENT"] - 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 + self._parameter_provider = parameter_provider + + @property + def parameters(self): + """ + Gets the parameters of this VersionedParameterContext. + The parameters in the context + + :return: The parameters of this VersionedParameterContext. + :rtype: list[VersionedParameter] + """ + return self._parameters + + @parameters.setter + def parameters(self, parameters): + """ + Sets the parameters of this VersionedParameterContext. + The parameters in the context + + :param parameters: The parameters of this VersionedParameterContext. + :type: list[VersionedParameter] + """ + + self._parameters = parameters + + @property + def position(self): + """ + Gets the position of this VersionedParameterContext. + + :return: The position of this VersionedParameterContext. + :rtype: Position + """ + return self._position + + @position.setter + def position(self, position): + """ + Sets the position of this VersionedParameterContext. + + :param position: The position of this VersionedParameterContext. + :type: Position + """ + + self._position = position @property def synchronized(self): @@ -385,29 +403,6 @@ def synchronized(self, synchronized): self._synchronized = synchronized - @property - def group_identifier(self): - """ - Gets the group_identifier of this VersionedParameterContext. - The ID of the Process Group that this component belongs to - - :return: The group_identifier of this VersionedParameterContext. - :rtype: str - """ - return self._group_identifier - - @group_identifier.setter - def group_identifier(self, group_identifier): - """ - Sets the group_identifier of this VersionedParameterContext. - The ID of the Process Group that this component belongs to - - :param group_identifier: The group_identifier of this VersionedParameterContext. - :type: str - """ - - self._group_identifier = group_identifier - def to_dict(self): """ Returns the model properties as a dict diff --git a/nipyapi/nifi/models/versioned_port.py b/nipyapi/nifi/models/versioned_port.py index a445936d..3054c722 100644 --- a/nipyapi/nifi/models/versioned_port.py +++ b/nipyapi/nifi/models/versioned_port.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,72 +27,194 @@ class VersionedPort(object): and the value is json key in definition. """ swagger_types = { - 'identifier': 'str', - 'instance_identifier': 'str', - 'name': 'str', - 'comments': 'str', - 'position': 'Position', - 'type': 'str', - 'concurrently_schedulable_task_count': 'int', - 'scheduled_state': 'str', 'allow_remote_access': 'bool', - 'component_type': 'str', - 'group_identifier': 'str' - } +'comments': 'str', +'component_type': 'str', +'concurrently_schedulable_task_count': 'int', +'group_identifier': 'str', +'identifier': 'str', +'instance_identifier': 'str', +'name': 'str', +'port_function': 'str', +'position': 'Position', +'scheduled_state': 'str', +'type': 'str' } attribute_map = { - 'identifier': 'identifier', - 'instance_identifier': 'instanceIdentifier', - 'name': 'name', - 'comments': 'comments', - 'position': 'position', - 'type': 'type', - 'concurrently_schedulable_task_count': 'concurrentlySchedulableTaskCount', - 'scheduled_state': 'scheduledState', 'allow_remote_access': 'allowRemoteAccess', - 'component_type': 'componentType', - 'group_identifier': 'groupIdentifier' - } - - def __init__(self, identifier=None, instance_identifier=None, name=None, comments=None, position=None, type=None, concurrently_schedulable_task_count=None, scheduled_state=None, allow_remote_access=None, component_type=None, group_identifier=None): +'comments': 'comments', +'component_type': 'componentType', +'concurrently_schedulable_task_count': 'concurrentlySchedulableTaskCount', +'group_identifier': 'groupIdentifier', +'identifier': 'identifier', +'instance_identifier': 'instanceIdentifier', +'name': 'name', +'port_function': 'portFunction', +'position': 'position', +'scheduled_state': 'scheduledState', +'type': 'type' } + + def __init__(self, allow_remote_access=None, comments=None, component_type=None, concurrently_schedulable_task_count=None, group_identifier=None, identifier=None, instance_identifier=None, name=None, port_function=None, position=None, scheduled_state=None, type=None): """ VersionedPort - a model defined in Swagger """ + self._allow_remote_access = None + self._comments = None + self._component_type = None + self._concurrently_schedulable_task_count = None + self._group_identifier = None self._identifier = None self._instance_identifier = None self._name = None - self._comments = None + self._port_function = None self._position = None - self._type = None - self._concurrently_schedulable_task_count = None self._scheduled_state = None - self._allow_remote_access = None - self._component_type = None - self._group_identifier = None + self._type = None + if allow_remote_access is not None: + self.allow_remote_access = allow_remote_access + if comments is not None: + self.comments = comments + if component_type is not None: + self.component_type = component_type + if concurrently_schedulable_task_count is not None: + self.concurrently_schedulable_task_count = concurrently_schedulable_task_count + if group_identifier is not None: + self.group_identifier = group_identifier if identifier is not None: self.identifier = identifier if instance_identifier is not None: self.instance_identifier = instance_identifier if name is not None: self.name = name - if comments is not None: - self.comments = comments + if port_function is not None: + self.port_function = port_function if position is not None: self.position = position - if type is not None: - self.type = type - if concurrently_schedulable_task_count is not None: - self.concurrently_schedulable_task_count = concurrently_schedulable_task_count if scheduled_state is not None: self.scheduled_state = scheduled_state - if allow_remote_access is not None: - self.allow_remote_access = allow_remote_access - if component_type is not None: - self.component_type = component_type - if group_identifier is not None: - self.group_identifier = group_identifier + if type is not None: + self.type = type + + @property + def allow_remote_access(self): + """ + Gets the allow_remote_access of this VersionedPort. + Whether or not this port allows remote access for site-to-site + + :return: The allow_remote_access of this VersionedPort. + :rtype: bool + """ + return self._allow_remote_access + + @allow_remote_access.setter + def allow_remote_access(self, allow_remote_access): + """ + Sets the allow_remote_access of this VersionedPort. + Whether or not this port allows remote access for site-to-site + + :param allow_remote_access: The allow_remote_access of this VersionedPort. + :type: bool + """ + + self._allow_remote_access = allow_remote_access + + @property + def comments(self): + """ + Gets the comments of this VersionedPort. + The user-supplied comments for the component + + :return: The comments of this VersionedPort. + :rtype: str + """ + return self._comments + + @comments.setter + def comments(self, comments): + """ + Sets the comments of this VersionedPort. + The user-supplied comments for the component + + :param comments: The comments of this VersionedPort. + :type: str + """ + + self._comments = comments + + @property + def component_type(self): + """ + Gets the component_type of this VersionedPort. + + :return: The component_type of this VersionedPort. + :rtype: str + """ + return self._component_type + + @component_type.setter + def component_type(self, component_type): + """ + Sets the component_type of this VersionedPort. + + :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", ] + 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 + + @property + def concurrently_schedulable_task_count(self): + """ + Gets the concurrently_schedulable_task_count of this VersionedPort. + The number of tasks that should be concurrently scheduled for the port. + + :return: The concurrently_schedulable_task_count of this VersionedPort. + :rtype: int + """ + return self._concurrently_schedulable_task_count + + @concurrently_schedulable_task_count.setter + def concurrently_schedulable_task_count(self, concurrently_schedulable_task_count): + """ + Sets the concurrently_schedulable_task_count of this VersionedPort. + The number of tasks that should be concurrently scheduled for the port. + + :param concurrently_schedulable_task_count: The concurrently_schedulable_task_count of this VersionedPort. + :type: int + """ + + self._concurrently_schedulable_task_count = concurrently_schedulable_task_count + + @property + def group_identifier(self): + """ + Gets the group_identifier of this VersionedPort. + The ID of the Process Group that this component belongs to + + :return: The group_identifier of this VersionedPort. + :rtype: str + """ + return self._group_identifier + + @group_identifier.setter + def group_identifier(self, group_identifier): + """ + Sets the group_identifier of this VersionedPort. + The ID of the Process Group that this component belongs to + + :param group_identifier: The group_identifier of this VersionedPort. + :type: str + """ + + self._group_identifier = group_identifier @property def identifier(self): @@ -165,33 +286,38 @@ def name(self, name): self._name = name @property - def comments(self): + def port_function(self): """ - Gets the comments of this VersionedPort. - The user-supplied comments for the component + Gets the port_function of this VersionedPort. + Specifies how the Port should function - :return: The comments of this VersionedPort. + :return: The port_function of this VersionedPort. :rtype: str """ - return self._comments + return self._port_function - @comments.setter - def comments(self, comments): + @port_function.setter + def port_function(self, port_function): """ - Sets the comments of this VersionedPort. - The user-supplied comments for the component + Sets the port_function of this VersionedPort. + Specifies how the Port should function - :param comments: The comments of this VersionedPort. + :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) + ) - self._comments = comments + self._port_function = port_function @property def position(self): """ Gets the position of this VersionedPort. - The component's position on the graph :return: The position of this VersionedPort. :rtype: Position @@ -202,7 +328,6 @@ def position(self): def position(self, position): """ Sets the position of this VersionedPort. - The component's position on the graph :param position: The position of this VersionedPort. :type: Position @@ -210,58 +335,6 @@ def position(self, position): self._position = position - @property - def type(self): - """ - Gets the type of this VersionedPort. - The type of port. - - :return: The type of this VersionedPort. - :rtype: str - """ - return self._type - - @type.setter - def type(self, type): - """ - Sets the type of this VersionedPort. - The type of port. - - :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) - ) - - self._type = type - - @property - def concurrently_schedulable_task_count(self): - """ - Gets the concurrently_schedulable_task_count of this VersionedPort. - The number of tasks that should be concurrently scheduled for the port. - - :return: The concurrently_schedulable_task_count of this VersionedPort. - :rtype: int - """ - return self._concurrently_schedulable_task_count - - @concurrently_schedulable_task_count.setter - def concurrently_schedulable_task_count(self, concurrently_schedulable_task_count): - """ - Sets the concurrently_schedulable_task_count of this VersionedPort. - The number of tasks that should be concurrently scheduled for the port. - - :param concurrently_schedulable_task_count: The concurrently_schedulable_task_count of this VersionedPort. - :type: int - """ - - self._concurrently_schedulable_task_count = concurrently_schedulable_task_count - @property def scheduled_state(self): """ @@ -282,7 +355,7 @@ def scheduled_state(self, scheduled_state): :param scheduled_state: The scheduled_state of this VersionedPort. :type: str """ - allowed_values = ["ENABLED", "DISABLED", "RUNNING"] + 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}" @@ -292,77 +365,33 @@ def scheduled_state(self, scheduled_state): self._scheduled_state = scheduled_state @property - def allow_remote_access(self): - """ - Gets the allow_remote_access of this VersionedPort. - Whether or not this port allows remote access for site-to-site - - :return: The allow_remote_access of this VersionedPort. - :rtype: bool - """ - return self._allow_remote_access - - @allow_remote_access.setter - def allow_remote_access(self, allow_remote_access): - """ - Sets the allow_remote_access of this VersionedPort. - Whether or not this port allows remote access for site-to-site - - :param allow_remote_access: The allow_remote_access of this VersionedPort. - :type: bool - """ - - self._allow_remote_access = allow_remote_access - - @property - def component_type(self): + def type(self): """ - Gets the component_type of this VersionedPort. + Gets the type of this VersionedPort. + The type of port. - :return: The component_type of this VersionedPort. + :return: The type of this VersionedPort. :rtype: str """ - return self._component_type + return self._type - @component_type.setter - def component_type(self, component_type): + @type.setter + def type(self, type): """ - Sets the component_type of this VersionedPort. + Sets the type of this VersionedPort. + The type of port. - :param component_type: The component_type of this VersionedPort. + :param type: The 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", "PARAMETER_CONTEXT", "PARAMETER_PROVIDER", "TEMPLATE", "FLOW_REGISTRY_CLIENT"] - if component_type not in allowed_values: + allowed_values = ["INPUT_PORT", "OUTPUT_PORT", ] + if type not in allowed_values: raise ValueError( - "Invalid value for `component_type` ({0}), must be one of {1}" - .format(component_type, allowed_values) + "Invalid value for `type` ({0}), must be one of {1}" + .format(type, allowed_values) ) - self._component_type = component_type - - @property - def group_identifier(self): - """ - Gets the group_identifier of this VersionedPort. - The ID of the Process Group that this component belongs to - - :return: The group_identifier of this VersionedPort. - :rtype: str - """ - return self._group_identifier - - @group_identifier.setter - def group_identifier(self, group_identifier): - """ - Sets the group_identifier of this VersionedPort. - The ID of the Process Group that this component belongs to - - :param group_identifier: The group_identifier of this VersionedPort. - :type: str - """ - - self._group_identifier = group_identifier + self._type = type def to_dict(self): """ diff --git a/nipyapi/nifi/models/versioned_process_group.py b/nipyapi/nifi/models/versioned_process_group.py index 08e32994..6accc9d8 100644 --- a/nipyapi/nifi/models/versioned_process_group.py +++ b/nipyapi/nifi/models/versioned_process_group.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,326 +27,464 @@ class VersionedProcessGroup(object): and the value is json key in definition. """ swagger_types = { - 'identifier': 'str', - 'instance_identifier': 'str', - 'name': 'str', 'comments': 'str', - 'position': 'Position', - 'process_groups': 'list[VersionedProcessGroup]', - 'remote_process_groups': 'list[VersionedRemoteProcessGroup]', - 'processors': 'list[VersionedProcessor]', - 'input_ports': 'list[VersionedPort]', - 'output_ports': 'list[VersionedPort]', - 'connections': 'list[VersionedConnection]', - 'labels': 'list[VersionedLabel]', - 'funnels': 'list[VersionedFunnel]', - 'controller_services': 'list[VersionedControllerService]', - 'versioned_flow_coordinates': 'VersionedFlowCoordinates', - 'variables': 'dict(str, str)', - 'parameter_context_name': 'str', - 'default_flow_file_expiration': 'str', - 'default_back_pressure_object_threshold': 'int', - 'default_back_pressure_data_size_threshold': 'str', - 'log_file_suffix': 'str', - 'component_type': 'str', - 'flow_file_concurrency': 'str', - 'flow_file_outbound_policy': 'str', - 'group_identifier': 'str' - } +'component_type': 'str', +'connections': 'list[VersionedConnection]', +'controller_services': 'list[VersionedControllerService]', +'default_back_pressure_data_size_threshold': 'str', +'default_back_pressure_object_threshold': 'int', +'default_flow_file_expiration': 'str', +'execution_engine': 'str', +'flow_file_concurrency': 'str', +'flow_file_outbound_policy': 'str', +'funnels': 'list[VersionedFunnel]', +'group_identifier': 'str', +'identifier': 'str', +'input_ports': 'list[VersionedPort]', +'instance_identifier': 'str', +'labels': 'list[VersionedLabel]', +'log_file_suffix': 'str', +'max_concurrent_tasks': 'int', +'name': 'str', +'output_ports': 'list[VersionedPort]', +'parameter_context_name': 'str', +'position': 'Position', +'process_groups': 'list[VersionedProcessGroup]', +'processors': 'list[VersionedProcessor]', +'remote_process_groups': 'list[VersionedRemoteProcessGroup]', +'scheduled_state': 'str', +'stateless_flow_timeout': 'str', +'versioned_flow_coordinates': 'VersionedFlowCoordinates' } attribute_map = { - 'identifier': 'identifier', - 'instance_identifier': 'instanceIdentifier', - 'name': 'name', 'comments': 'comments', - 'position': 'position', - 'process_groups': 'processGroups', - 'remote_process_groups': 'remoteProcessGroups', - 'processors': 'processors', - 'input_ports': 'inputPorts', - 'output_ports': 'outputPorts', - 'connections': 'connections', - 'labels': 'labels', - 'funnels': 'funnels', - 'controller_services': 'controllerServices', - 'versioned_flow_coordinates': 'versionedFlowCoordinates', - 'variables': 'variables', - 'parameter_context_name': 'parameterContextName', - 'default_flow_file_expiration': 'defaultFlowFileExpiration', - 'default_back_pressure_object_threshold': 'defaultBackPressureObjectThreshold', - 'default_back_pressure_data_size_threshold': 'defaultBackPressureDataSizeThreshold', - 'log_file_suffix': 'logFileSuffix', - 'component_type': 'componentType', - 'flow_file_concurrency': 'flowFileConcurrency', - 'flow_file_outbound_policy': 'flowFileOutboundPolicy', - 'group_identifier': 'groupIdentifier' - } - - def __init__(self, identifier=None, instance_identifier=None, name=None, comments=None, position=None, process_groups=None, remote_process_groups=None, processors=None, input_ports=None, output_ports=None, connections=None, labels=None, funnels=None, controller_services=None, versioned_flow_coordinates=None, variables=None, parameter_context_name=None, default_flow_file_expiration=None, default_back_pressure_object_threshold=None, default_back_pressure_data_size_threshold=None, log_file_suffix=None, component_type=None, flow_file_concurrency=None, flow_file_outbound_policy=None, group_identifier=None): +'component_type': 'componentType', +'connections': 'connections', +'controller_services': 'controllerServices', +'default_back_pressure_data_size_threshold': 'defaultBackPressureDataSizeThreshold', +'default_back_pressure_object_threshold': 'defaultBackPressureObjectThreshold', +'default_flow_file_expiration': 'defaultFlowFileExpiration', +'execution_engine': 'executionEngine', +'flow_file_concurrency': 'flowFileConcurrency', +'flow_file_outbound_policy': 'flowFileOutboundPolicy', +'funnels': 'funnels', +'group_identifier': 'groupIdentifier', +'identifier': 'identifier', +'input_ports': 'inputPorts', +'instance_identifier': 'instanceIdentifier', +'labels': 'labels', +'log_file_suffix': 'logFileSuffix', +'max_concurrent_tasks': 'maxConcurrentTasks', +'name': 'name', +'output_ports': 'outputPorts', +'parameter_context_name': 'parameterContextName', +'position': 'position', +'process_groups': 'processGroups', +'processors': 'processors', +'remote_process_groups': 'remoteProcessGroups', +'scheduled_state': 'scheduledState', +'stateless_flow_timeout': 'statelessFlowTimeout', +'versioned_flow_coordinates': 'versionedFlowCoordinates' } + + def __init__(self, comments=None, component_type=None, connections=None, controller_services=None, default_back_pressure_data_size_threshold=None, default_back_pressure_object_threshold=None, default_flow_file_expiration=None, execution_engine=None, flow_file_concurrency=None, flow_file_outbound_policy=None, funnels=None, group_identifier=None, identifier=None, input_ports=None, instance_identifier=None, labels=None, log_file_suffix=None, max_concurrent_tasks=None, name=None, output_ports=None, parameter_context_name=None, position=None, process_groups=None, processors=None, remote_process_groups=None, scheduled_state=None, stateless_flow_timeout=None, versioned_flow_coordinates=None): """ VersionedProcessGroup - a model defined in Swagger """ - self._identifier = None - self._instance_identifier = None - self._name = None self._comments = None - self._position = None - self._process_groups = None - self._remote_process_groups = None - self._processors = None - self._input_ports = None - self._output_ports = None + self._component_type = None self._connections = None - self._labels = None - self._funnels = None self._controller_services = None - self._versioned_flow_coordinates = None - self._variables = None - self._parameter_context_name = None - self._default_flow_file_expiration = None - self._default_back_pressure_object_threshold = None self._default_back_pressure_data_size_threshold = None - self._log_file_suffix = None - self._component_type = None + self._default_back_pressure_object_threshold = None + self._default_flow_file_expiration = None + self._execution_engine = None self._flow_file_concurrency = None self._flow_file_outbound_policy = None + self._funnels = None self._group_identifier = None + self._identifier = None + self._input_ports = None + self._instance_identifier = None + self._labels = None + self._log_file_suffix = None + self._max_concurrent_tasks = None + self._name = None + self._output_ports = None + self._parameter_context_name = None + self._position = None + self._process_groups = None + self._processors = None + self._remote_process_groups = None + self._scheduled_state = None + self._stateless_flow_timeout = None + self._versioned_flow_coordinates = None - if identifier is not None: - self.identifier = identifier - if instance_identifier is not None: - self.instance_identifier = instance_identifier - if name is not None: - self.name = name if comments is not None: self.comments = comments - if position is not None: - self.position = position - if process_groups is not None: - self.process_groups = process_groups - if remote_process_groups is not None: - self.remote_process_groups = remote_process_groups - if processors is not None: - self.processors = processors - if input_ports is not None: - self.input_ports = input_ports - if output_ports is not None: - self.output_ports = output_ports + if component_type is not None: + self.component_type = component_type if connections is not None: self.connections = connections - if labels is not None: - self.labels = labels - if funnels is not None: - self.funnels = funnels if controller_services is not None: self.controller_services = controller_services - if versioned_flow_coordinates is not None: - self.versioned_flow_coordinates = versioned_flow_coordinates - if variables is not None: - self.variables = variables - if parameter_context_name is not None: - self.parameter_context_name = parameter_context_name - if default_flow_file_expiration is not None: - self.default_flow_file_expiration = default_flow_file_expiration - if default_back_pressure_object_threshold is not None: - self.default_back_pressure_object_threshold = default_back_pressure_object_threshold if default_back_pressure_data_size_threshold is not None: self.default_back_pressure_data_size_threshold = default_back_pressure_data_size_threshold - if log_file_suffix is not None: - self.log_file_suffix = log_file_suffix - if component_type is not None: - self.component_type = component_type + if default_back_pressure_object_threshold is not None: + self.default_back_pressure_object_threshold = default_back_pressure_object_threshold + if default_flow_file_expiration is not None: + self.default_flow_file_expiration = default_flow_file_expiration + if execution_engine is not None: + self.execution_engine = execution_engine if flow_file_concurrency is not None: self.flow_file_concurrency = flow_file_concurrency if flow_file_outbound_policy is not None: self.flow_file_outbound_policy = flow_file_outbound_policy + if funnels is not None: + self.funnels = funnels if group_identifier is not None: self.group_identifier = group_identifier + if identifier is not None: + self.identifier = identifier + if input_ports is not None: + self.input_ports = input_ports + if instance_identifier is not None: + self.instance_identifier = instance_identifier + if labels is not None: + self.labels = labels + if log_file_suffix is not None: + self.log_file_suffix = log_file_suffix + if max_concurrent_tasks is not None: + self.max_concurrent_tasks = max_concurrent_tasks + if name is not None: + self.name = name + if output_ports is not None: + self.output_ports = output_ports + if parameter_context_name is not None: + self.parameter_context_name = parameter_context_name + if position is not None: + self.position = position + if process_groups is not None: + self.process_groups = process_groups + if processors is not None: + self.processors = processors + if remote_process_groups is not None: + self.remote_process_groups = remote_process_groups + if scheduled_state is not None: + self.scheduled_state = scheduled_state + if stateless_flow_timeout is not None: + self.stateless_flow_timeout = stateless_flow_timeout + if versioned_flow_coordinates is not None: + self.versioned_flow_coordinates = versioned_flow_coordinates @property - def identifier(self): + def comments(self): """ - Gets the identifier of this VersionedProcessGroup. - The component's unique identifier + Gets the comments of this VersionedProcessGroup. + The user-supplied comments for the component - :return: The identifier of this VersionedProcessGroup. + :return: The comments of this VersionedProcessGroup. :rtype: str """ - return self._identifier + return self._comments - @identifier.setter - def identifier(self, identifier): + @comments.setter + def comments(self, comments): """ - Sets the identifier of this VersionedProcessGroup. - The component's unique identifier + Sets the comments of this VersionedProcessGroup. + The user-supplied comments for the component - :param identifier: The identifier of this VersionedProcessGroup. + :param comments: The comments of this VersionedProcessGroup. :type: str """ - self._identifier = identifier + self._comments = comments @property - def instance_identifier(self): + def component_type(self): """ - Gets the instance_identifier of this VersionedProcessGroup. - The instance ID of an existing component that is described by this VersionedComponent, or null if this is not mapped to an instantiated component + Gets the component_type of this VersionedProcessGroup. - :return: The instance_identifier of this VersionedProcessGroup. + :return: The component_type of this VersionedProcessGroup. :rtype: str """ - return self._instance_identifier + return self._component_type - @instance_identifier.setter - def instance_identifier(self, instance_identifier): + @component_type.setter + def component_type(self, component_type): """ - Sets the instance_identifier of this VersionedProcessGroup. - The instance ID of an existing component that is described by this VersionedComponent, or null if this is not mapped to an instantiated component + Sets the component_type of this VersionedProcessGroup. - :param instance_identifier: The instance_identifier of this VersionedProcessGroup. + :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", ] + 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._instance_identifier = instance_identifier + self._component_type = component_type @property - def name(self): + def connections(self): """ - Gets the name of this VersionedProcessGroup. - The component's name + Gets the connections of this VersionedProcessGroup. + The Connections - :return: The name of this VersionedProcessGroup. + :return: The connections of this VersionedProcessGroup. + :rtype: list[VersionedConnection] + """ + return self._connections + + @connections.setter + def connections(self, connections): + """ + Sets the connections of this VersionedProcessGroup. + The Connections + + :param connections: The connections of this VersionedProcessGroup. + :type: list[VersionedConnection] + """ + + self._connections = connections + + @property + def controller_services(self): + """ + Gets the controller_services of this VersionedProcessGroup. + The Controller Services + + :return: The controller_services of this VersionedProcessGroup. + :rtype: list[VersionedControllerService] + """ + return self._controller_services + + @controller_services.setter + def controller_services(self, controller_services): + """ + Sets the controller_services of this VersionedProcessGroup. + The Controller Services + + :param controller_services: The controller_services of this VersionedProcessGroup. + :type: list[VersionedControllerService] + """ + + self._controller_services = controller_services + + @property + def default_back_pressure_data_size_threshold(self): + """ + Gets the default_back_pressure_data_size_threshold of this VersionedProcessGroup. + Default value used in this Process Group for the maximum data size of objects that can be queued before back pressure is applied. + + :return: The default_back_pressure_data_size_threshold of this VersionedProcessGroup. :rtype: str """ - return self._name + return self._default_back_pressure_data_size_threshold - @name.setter - def name(self, name): + @default_back_pressure_data_size_threshold.setter + def default_back_pressure_data_size_threshold(self, default_back_pressure_data_size_threshold): """ - Sets the name of this VersionedProcessGroup. - The component's name + Sets the default_back_pressure_data_size_threshold of this VersionedProcessGroup. + Default value used in this Process Group for the maximum data size of objects that can be queued before back pressure is applied. - :param name: The name of this VersionedProcessGroup. + :param default_back_pressure_data_size_threshold: The default_back_pressure_data_size_threshold of this VersionedProcessGroup. :type: str """ - self._name = name + self._default_back_pressure_data_size_threshold = default_back_pressure_data_size_threshold @property - def comments(self): + def default_back_pressure_object_threshold(self): """ - Gets the comments of this VersionedProcessGroup. - The user-supplied comments for the component + Gets the default_back_pressure_object_threshold of this VersionedProcessGroup. + Default value used in this Process Group for the maximum number of objects that can be queued before back pressure is applied. - :return: The comments of this VersionedProcessGroup. + :return: The default_back_pressure_object_threshold of this VersionedProcessGroup. + :rtype: int + """ + return self._default_back_pressure_object_threshold + + @default_back_pressure_object_threshold.setter + def default_back_pressure_object_threshold(self, default_back_pressure_object_threshold): + """ + Sets the default_back_pressure_object_threshold of this VersionedProcessGroup. + Default value used in this Process Group for the maximum number of objects that can be queued before back pressure is applied. + + :param default_back_pressure_object_threshold: The default_back_pressure_object_threshold of this VersionedProcessGroup. + :type: int + """ + + self._default_back_pressure_object_threshold = default_back_pressure_object_threshold + + @property + def default_flow_file_expiration(self): + """ + Gets the default_flow_file_expiration of this VersionedProcessGroup. + The default FlowFile Expiration for this Process Group. + + :return: The default_flow_file_expiration of this VersionedProcessGroup. :rtype: str """ - return self._comments + return self._default_flow_file_expiration - @comments.setter - def comments(self, comments): + @default_flow_file_expiration.setter + def default_flow_file_expiration(self, default_flow_file_expiration): """ - Sets the comments of this VersionedProcessGroup. - The user-supplied comments for the component + Sets the default_flow_file_expiration of this VersionedProcessGroup. + The default FlowFile Expiration for this Process Group. - :param comments: The comments of this VersionedProcessGroup. + :param default_flow_file_expiration: The default_flow_file_expiration of this VersionedProcessGroup. :type: str """ - self._comments = comments + self._default_flow_file_expiration = default_flow_file_expiration @property - def position(self): + def execution_engine(self): """ - Gets the position of this VersionedProcessGroup. - The component's position on the graph + Gets the execution_engine of this VersionedProcessGroup. + The Execution Engine that should be used to run the components within the group. - :return: The position of this VersionedProcessGroup. - :rtype: Position + :return: The execution_engine of this VersionedProcessGroup. + :rtype: str """ - return self._position + return self._execution_engine - @position.setter - def position(self, position): + @execution_engine.setter + def execution_engine(self, execution_engine): """ - Sets the position of this VersionedProcessGroup. - The component's position on the graph + Sets the execution_engine of this VersionedProcessGroup. + The Execution Engine that should be used to run the components within the group. - :param position: The position of this VersionedProcessGroup. - :type: Position + :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) + ) - self._position = position + self._execution_engine = execution_engine @property - def process_groups(self): + def flow_file_concurrency(self): """ - Gets the process_groups of this VersionedProcessGroup. - The child Process Groups + Gets the flow_file_concurrency of this VersionedProcessGroup. + The configured FlowFile Concurrency for the Process Group - :return: The process_groups of this VersionedProcessGroup. - :rtype: list[VersionedProcessGroup] + :return: The flow_file_concurrency of this VersionedProcessGroup. + :rtype: str """ - return self._process_groups + return self._flow_file_concurrency - @process_groups.setter - def process_groups(self, process_groups): + @flow_file_concurrency.setter + def flow_file_concurrency(self, flow_file_concurrency): """ - Sets the process_groups of this VersionedProcessGroup. - The child Process Groups + Sets the flow_file_concurrency of this VersionedProcessGroup. + The configured FlowFile Concurrency for the Process Group - :param process_groups: The process_groups of this VersionedProcessGroup. - :type: list[VersionedProcessGroup] + :param flow_file_concurrency: The flow_file_concurrency of this VersionedProcessGroup. + :type: str """ - self._process_groups = process_groups + self._flow_file_concurrency = flow_file_concurrency @property - def remote_process_groups(self): + def flow_file_outbound_policy(self): """ - Gets the remote_process_groups of this VersionedProcessGroup. - The Remote Process Groups + Gets the flow_file_outbound_policy of this VersionedProcessGroup. + The FlowFile Outbound Policy for the Process Group - :return: The remote_process_groups of this VersionedProcessGroup. - :rtype: list[VersionedRemoteProcessGroup] + :return: The flow_file_outbound_policy of this VersionedProcessGroup. + :rtype: str """ - return self._remote_process_groups + return self._flow_file_outbound_policy - @remote_process_groups.setter - def remote_process_groups(self, remote_process_groups): + @flow_file_outbound_policy.setter + def flow_file_outbound_policy(self, flow_file_outbound_policy): """ - Sets the remote_process_groups of this VersionedProcessGroup. - The Remote Process Groups + Sets the flow_file_outbound_policy of this VersionedProcessGroup. + The FlowFile Outbound Policy for the Process Group - :param remote_process_groups: The remote_process_groups of this VersionedProcessGroup. - :type: list[VersionedRemoteProcessGroup] + :param flow_file_outbound_policy: The flow_file_outbound_policy of this VersionedProcessGroup. + :type: str """ - self._remote_process_groups = remote_process_groups + self._flow_file_outbound_policy = flow_file_outbound_policy @property - def processors(self): + def funnels(self): """ - Gets the processors of this VersionedProcessGroup. - The Processors + Gets the funnels of this VersionedProcessGroup. + The Funnels - :return: The processors of this VersionedProcessGroup. - :rtype: list[VersionedProcessor] + :return: The funnels of this VersionedProcessGroup. + :rtype: list[VersionedFunnel] """ - return self._processors + return self._funnels - @processors.setter - def processors(self, processors): + @funnels.setter + def funnels(self, funnels): """ - Sets the processors of this VersionedProcessGroup. - The Processors + Sets the funnels of this VersionedProcessGroup. + The Funnels - :param processors: The processors of this VersionedProcessGroup. - :type: list[VersionedProcessor] + :param funnels: The funnels of this VersionedProcessGroup. + :type: list[VersionedFunnel] """ - self._processors = processors + self._funnels = funnels + + @property + def group_identifier(self): + """ + Gets the group_identifier of this VersionedProcessGroup. + The ID of the Process Group that this component belongs to + + :return: The group_identifier of this VersionedProcessGroup. + :rtype: str + """ + return self._group_identifier + + @group_identifier.setter + def group_identifier(self, group_identifier): + """ + Sets the group_identifier of this VersionedProcessGroup. + The ID of the Process Group that this component belongs to + + :param group_identifier: The group_identifier of this VersionedProcessGroup. + :type: str + """ + + self._group_identifier = group_identifier + + @property + def identifier(self): + """ + Gets the identifier of this VersionedProcessGroup. + The component's unique identifier + + :return: The identifier of this VersionedProcessGroup. + :rtype: str + """ + return self._identifier + + @identifier.setter + def identifier(self, identifier): + """ + Sets the identifier of this VersionedProcessGroup. + The component's unique identifier + + :param identifier: The identifier of this VersionedProcessGroup. + :type: str + """ + + self._identifier = identifier @property def input_ports(self): @@ -373,50 +510,27 @@ def input_ports(self, input_ports): self._input_ports = input_ports @property - def output_ports(self): - """ - Gets the output_ports of this VersionedProcessGroup. - The Output Ports - - :return: The output_ports of this VersionedProcessGroup. - :rtype: list[VersionedPort] - """ - return self._output_ports - - @output_ports.setter - def output_ports(self, output_ports): - """ - Sets the output_ports of this VersionedProcessGroup. - The Output Ports - - :param output_ports: The output_ports of this VersionedProcessGroup. - :type: list[VersionedPort] - """ - - self._output_ports = output_ports - - @property - def connections(self): + def instance_identifier(self): """ - Gets the connections of this VersionedProcessGroup. - The Connections + Gets the instance_identifier of this VersionedProcessGroup. + The instance ID of an existing component that is described by this VersionedComponent, or null if this is not mapped to an instantiated component - :return: The connections of this VersionedProcessGroup. - :rtype: list[VersionedConnection] + :return: The instance_identifier of this VersionedProcessGroup. + :rtype: str """ - return self._connections + return self._instance_identifier - @connections.setter - def connections(self, connections): + @instance_identifier.setter + def instance_identifier(self, instance_identifier): """ - Sets the connections of this VersionedProcessGroup. - The Connections + Sets the instance_identifier of this VersionedProcessGroup. + The instance ID of an existing component that is described by this VersionedComponent, or null if this is not mapped to an instantiated component - :param connections: The connections of this VersionedProcessGroup. - :type: list[VersionedConnection] + :param instance_identifier: The instance_identifier of this VersionedProcessGroup. + :type: str """ - self._connections = connections + self._instance_identifier = instance_identifier @property def labels(self): @@ -442,96 +556,96 @@ def labels(self, labels): self._labels = labels @property - def funnels(self): + def log_file_suffix(self): """ - Gets the funnels of this VersionedProcessGroup. - The Funnels + Gets the log_file_suffix of this VersionedProcessGroup. + The log file suffix for this Process Group for dedicated logging. - :return: The funnels of this VersionedProcessGroup. - :rtype: list[VersionedFunnel] + :return: The log_file_suffix of this VersionedProcessGroup. + :rtype: str """ - return self._funnels + return self._log_file_suffix - @funnels.setter - def funnels(self, funnels): + @log_file_suffix.setter + def log_file_suffix(self, log_file_suffix): """ - Sets the funnels of this VersionedProcessGroup. - The Funnels + Sets the log_file_suffix of this VersionedProcessGroup. + The log file suffix for this Process Group for dedicated logging. - :param funnels: The funnels of this VersionedProcessGroup. - :type: list[VersionedFunnel] + :param log_file_suffix: The log_file_suffix of this VersionedProcessGroup. + :type: str """ - self._funnels = funnels + self._log_file_suffix = log_file_suffix @property - def controller_services(self): + def max_concurrent_tasks(self): """ - Gets the controller_services of this VersionedProcessGroup. - The Controller Services + Gets the max_concurrent_tasks of this VersionedProcessGroup. + The maximum number of concurrent tasks that should be scheduled for this Process Group when using the Stateless Engine - :return: The controller_services of this VersionedProcessGroup. - :rtype: list[VersionedControllerService] + :return: The max_concurrent_tasks of this VersionedProcessGroup. + :rtype: int """ - return self._controller_services + return self._max_concurrent_tasks - @controller_services.setter - def controller_services(self, controller_services): + @max_concurrent_tasks.setter + def max_concurrent_tasks(self, max_concurrent_tasks): """ - Sets the controller_services of this VersionedProcessGroup. - The Controller Services + Sets the max_concurrent_tasks of this VersionedProcessGroup. + The maximum number of concurrent tasks that should be scheduled for this Process Group when using the Stateless Engine - :param controller_services: The controller_services of this VersionedProcessGroup. - :type: list[VersionedControllerService] + :param max_concurrent_tasks: The max_concurrent_tasks of this VersionedProcessGroup. + :type: int """ - self._controller_services = controller_services + self._max_concurrent_tasks = max_concurrent_tasks @property - def versioned_flow_coordinates(self): + def name(self): """ - Gets the versioned_flow_coordinates of this VersionedProcessGroup. - The coordinates where the remote flow is stored, or null if the Process Group is not directly under Version Control + Gets the name of this VersionedProcessGroup. + The component's name - :return: The versioned_flow_coordinates of this VersionedProcessGroup. - :rtype: VersionedFlowCoordinates + :return: The name of this VersionedProcessGroup. + :rtype: str """ - return self._versioned_flow_coordinates + return self._name - @versioned_flow_coordinates.setter - def versioned_flow_coordinates(self, versioned_flow_coordinates): + @name.setter + def name(self, name): """ - Sets the versioned_flow_coordinates of this VersionedProcessGroup. - The coordinates where the remote flow is stored, or null if the Process Group is not directly under Version Control + Sets the name of this VersionedProcessGroup. + The component's name - :param versioned_flow_coordinates: The versioned_flow_coordinates of this VersionedProcessGroup. - :type: VersionedFlowCoordinates + :param name: The name of this VersionedProcessGroup. + :type: str """ - self._versioned_flow_coordinates = versioned_flow_coordinates + self._name = name @property - def variables(self): + def output_ports(self): """ - Gets the variables of this VersionedProcessGroup. - The Variables in the Variable Registry for this Process Group (not including any ancestor or descendant Process Groups) + Gets the output_ports of this VersionedProcessGroup. + The Output Ports - :return: The variables of this VersionedProcessGroup. - :rtype: dict(str, str) + :return: The output_ports of this VersionedProcessGroup. + :rtype: list[VersionedPort] """ - return self._variables + return self._output_ports - @variables.setter - def variables(self, variables): + @output_ports.setter + def output_ports(self, output_ports): """ - Sets the variables of this VersionedProcessGroup. - The Variables in the Variable Registry for this Process Group (not including any ancestor or descendant Process Groups) + Sets the output_ports of this VersionedProcessGroup. + The Output Ports - :param variables: The variables of this VersionedProcessGroup. - :type: dict(str, str) + :param output_ports: The output_ports of this VersionedProcessGroup. + :type: list[VersionedPort] """ - self._variables = variables + self._output_ports = output_ports @property def parameter_context_name(self): @@ -557,192 +671,167 @@ def parameter_context_name(self, parameter_context_name): self._parameter_context_name = parameter_context_name @property - def default_flow_file_expiration(self): + def position(self): """ - Gets the default_flow_file_expiration of this VersionedProcessGroup. - The default FlowFile Expiration for this Process Group. + Gets the position of this VersionedProcessGroup. - :return: The default_flow_file_expiration of this VersionedProcessGroup. - :rtype: str + :return: The position of this VersionedProcessGroup. + :rtype: Position """ - return self._default_flow_file_expiration + return self._position - @default_flow_file_expiration.setter - def default_flow_file_expiration(self, default_flow_file_expiration): + @position.setter + def position(self, position): """ - Sets the default_flow_file_expiration of this VersionedProcessGroup. - The default FlowFile Expiration for this Process Group. + Sets the position of this VersionedProcessGroup. - :param default_flow_file_expiration: The default_flow_file_expiration of this VersionedProcessGroup. - :type: str + :param position: The position of this VersionedProcessGroup. + :type: Position """ - self._default_flow_file_expiration = default_flow_file_expiration + self._position = position @property - def default_back_pressure_object_threshold(self): + def process_groups(self): """ - Gets the default_back_pressure_object_threshold of this VersionedProcessGroup. - Default value used in this Process Group for the maximum number of objects that can be queued before back pressure is applied. + Gets the process_groups of this VersionedProcessGroup. + The child Process Groups - :return: The default_back_pressure_object_threshold of this VersionedProcessGroup. - :rtype: int + :return: The process_groups of this VersionedProcessGroup. + :rtype: list[VersionedProcessGroup] """ - return self._default_back_pressure_object_threshold + return self._process_groups - @default_back_pressure_object_threshold.setter - def default_back_pressure_object_threshold(self, default_back_pressure_object_threshold): + @process_groups.setter + def process_groups(self, process_groups): """ - Sets the default_back_pressure_object_threshold of this VersionedProcessGroup. - Default value used in this Process Group for the maximum number of objects that can be queued before back pressure is applied. + Sets the process_groups of this VersionedProcessGroup. + The child Process Groups - :param default_back_pressure_object_threshold: The default_back_pressure_object_threshold of this VersionedProcessGroup. - :type: int + :param process_groups: The process_groups of this VersionedProcessGroup. + :type: list[VersionedProcessGroup] """ - self._default_back_pressure_object_threshold = default_back_pressure_object_threshold + self._process_groups = process_groups @property - def default_back_pressure_data_size_threshold(self): + def processors(self): """ - Gets the default_back_pressure_data_size_threshold of this VersionedProcessGroup. - Default value used in this Process Group for the maximum data size of objects that can be queued before back pressure is applied. + Gets the processors of this VersionedProcessGroup. + The Processors - :return: The default_back_pressure_data_size_threshold of this VersionedProcessGroup. - :rtype: str + :return: The processors of this VersionedProcessGroup. + :rtype: list[VersionedProcessor] """ - return self._default_back_pressure_data_size_threshold + return self._processors - @default_back_pressure_data_size_threshold.setter - def default_back_pressure_data_size_threshold(self, default_back_pressure_data_size_threshold): + @processors.setter + def processors(self, processors): """ - Sets the default_back_pressure_data_size_threshold of this VersionedProcessGroup. - Default value used in this Process Group for the maximum data size of objects that can be queued before back pressure is applied. + Sets the processors of this VersionedProcessGroup. + The Processors - :param default_back_pressure_data_size_threshold: The default_back_pressure_data_size_threshold of this VersionedProcessGroup. - :type: str + :param processors: The processors of this VersionedProcessGroup. + :type: list[VersionedProcessor] """ - self._default_back_pressure_data_size_threshold = default_back_pressure_data_size_threshold + self._processors = processors @property - def log_file_suffix(self): + def remote_process_groups(self): """ - Gets the log_file_suffix of this VersionedProcessGroup. - The log file suffix for this Process Group for dedicated logging. + Gets the remote_process_groups of this VersionedProcessGroup. + The Remote Process Groups - :return: The log_file_suffix of this VersionedProcessGroup. - :rtype: str + :return: The remote_process_groups of this VersionedProcessGroup. + :rtype: list[VersionedRemoteProcessGroup] """ - return self._log_file_suffix + return self._remote_process_groups - @log_file_suffix.setter - def log_file_suffix(self, log_file_suffix): + @remote_process_groups.setter + def remote_process_groups(self, remote_process_groups): """ - Sets the log_file_suffix of this VersionedProcessGroup. - The log file suffix for this Process Group for dedicated logging. + Sets the remote_process_groups of this VersionedProcessGroup. + The Remote Process Groups - :param log_file_suffix: The log_file_suffix of this VersionedProcessGroup. - :type: str + :param remote_process_groups: The remote_process_groups of this VersionedProcessGroup. + :type: list[VersionedRemoteProcessGroup] """ - self._log_file_suffix = log_file_suffix + self._remote_process_groups = remote_process_groups @property - def component_type(self): + def scheduled_state(self): """ - Gets the component_type of this VersionedProcessGroup. + Gets the scheduled_state of this VersionedProcessGroup. + The Scheduled State of the Process Group, if the group is configured to use the Stateless Execution Engine. Otherwise, this value has no relevance. - :return: The component_type of this VersionedProcessGroup. + :return: The scheduled_state of this VersionedProcessGroup. :rtype: str """ - return self._component_type + return self._scheduled_state - @component_type.setter - def component_type(self, component_type): + @scheduled_state.setter + def scheduled_state(self, scheduled_state): """ - Sets the component_type of this VersionedProcessGroup. + Sets the scheduled_state of this VersionedProcessGroup. + The Scheduled State of the Process Group, if the group is configured to use the Stateless Execution Engine. Otherwise, this value has no relevance. - :param component_type: The component_type of this VersionedProcessGroup. + :param scheduled_state: The scheduled_state 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", "PARAMETER_CONTEXT", "PARAMETER_PROVIDER", "TEMPLATE", "FLOW_REGISTRY_CLIENT"] - if component_type not in allowed_values: + allowed_values = ["ENABLED", "DISABLED", "RUNNING", ] + if scheduled_state not in allowed_values: raise ValueError( - "Invalid value for `component_type` ({0}), must be one of {1}" - .format(component_type, allowed_values) + "Invalid value for `scheduled_state` ({0}), must be one of {1}" + .format(scheduled_state, allowed_values) ) - self._component_type = component_type - - @property - def flow_file_concurrency(self): - """ - Gets the flow_file_concurrency of this VersionedProcessGroup. - The configured FlowFile Concurrency for the Process Group - - :return: The flow_file_concurrency of this VersionedProcessGroup. - :rtype: str - """ - return self._flow_file_concurrency - - @flow_file_concurrency.setter - def flow_file_concurrency(self, flow_file_concurrency): - """ - Sets the flow_file_concurrency of this VersionedProcessGroup. - The configured FlowFile Concurrency for the Process Group - - :param flow_file_concurrency: The flow_file_concurrency of this VersionedProcessGroup. - :type: str - """ - - self._flow_file_concurrency = flow_file_concurrency + self._scheduled_state = scheduled_state @property - def flow_file_outbound_policy(self): + def stateless_flow_timeout(self): """ - Gets the flow_file_outbound_policy of this VersionedProcessGroup. - The FlowFile Outbound Policy for the Process Group + Gets the stateless_flow_timeout of this VersionedProcessGroup. + 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 - :return: The flow_file_outbound_policy of this VersionedProcessGroup. + :return: The stateless_flow_timeout of this VersionedProcessGroup. :rtype: str """ - return self._flow_file_outbound_policy + return self._stateless_flow_timeout - @flow_file_outbound_policy.setter - def flow_file_outbound_policy(self, flow_file_outbound_policy): + @stateless_flow_timeout.setter + def stateless_flow_timeout(self, stateless_flow_timeout): """ - Sets the flow_file_outbound_policy of this VersionedProcessGroup. - The FlowFile Outbound Policy for the Process Group + Sets the stateless_flow_timeout of this VersionedProcessGroup. + 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 - :param flow_file_outbound_policy: The flow_file_outbound_policy of this VersionedProcessGroup. + :param stateless_flow_timeout: The stateless_flow_timeout of this VersionedProcessGroup. :type: str """ - self._flow_file_outbound_policy = flow_file_outbound_policy + self._stateless_flow_timeout = stateless_flow_timeout @property - def group_identifier(self): + def versioned_flow_coordinates(self): """ - Gets the group_identifier of this VersionedProcessGroup. - The ID of the Process Group that this component belongs to + Gets the versioned_flow_coordinates of this VersionedProcessGroup. - :return: The group_identifier of this VersionedProcessGroup. - :rtype: str + :return: The versioned_flow_coordinates of this VersionedProcessGroup. + :rtype: VersionedFlowCoordinates """ - return self._group_identifier + return self._versioned_flow_coordinates - @group_identifier.setter - def group_identifier(self, group_identifier): + @versioned_flow_coordinates.setter + def versioned_flow_coordinates(self, versioned_flow_coordinates): """ - Sets the group_identifier of this VersionedProcessGroup. - The ID of the Process Group that this component belongs to + Sets the versioned_flow_coordinates of this VersionedProcessGroup. - :param group_identifier: The group_identifier of this VersionedProcessGroup. - :type: str + :param versioned_flow_coordinates: The versioned_flow_coordinates of this VersionedProcessGroup. + :type: VersionedFlowCoordinates """ - self._group_identifier = group_identifier + self._versioned_flow_coordinates = versioned_flow_coordinates def to_dict(self): """ diff --git a/nipyapi/nifi/models/versioned_processor.py b/nipyapi/nifi/models/versioned_processor.py index c06e4aa4..8eacff16 100644 --- a/nipyapi/nifi/models/versioned_processor.py +++ b/nipyapi/nifi/models/versioned_processor.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,221 +27,269 @@ class VersionedProcessor(object): and the value is json key in definition. """ swagger_types = { - 'identifier': 'str', - 'instance_identifier': 'str', - 'name': 'str', - 'comments': 'str', - 'position': 'Position', - 'type': 'str', - 'bundle': 'Bundle', - 'properties': 'dict(str, str)', - 'property_descriptors': 'dict(str, VersionedPropertyDescriptor)', - 'style': 'dict(str, str)', 'annotation_data': 'str', - 'scheduling_period': 'str', - 'scheduling_strategy': 'str', - 'execution_node': 'str', - 'penalty_duration': 'str', - 'yield_duration': 'str', - 'bulletin_level': 'str', - 'run_duration_millis': 'int', - 'concurrently_schedulable_task_count': 'int', - 'auto_terminated_relationships': 'list[str]', - 'scheduled_state': 'str', - 'retry_count': 'int', - 'retried_relationships': 'list[str]', - 'backoff_mechanism': 'str', - 'max_backoff_period': 'str', - 'component_type': 'str', - 'group_identifier': 'str' - } +'auto_terminated_relationships': 'list[str]', +'backoff_mechanism': 'str', +'bulletin_level': 'str', +'bundle': 'Bundle', +'comments': 'str', +'component_type': 'str', +'concurrently_schedulable_task_count': 'int', +'execution_node': 'str', +'group_identifier': 'str', +'identifier': 'str', +'instance_identifier': 'str', +'max_backoff_period': 'str', +'name': 'str', +'penalty_duration': 'str', +'position': 'Position', +'properties': 'dict(str, str)', +'property_descriptors': 'dict(str, VersionedPropertyDescriptor)', +'retried_relationships': 'list[str]', +'retry_count': 'int', +'run_duration_millis': 'int', +'scheduled_state': 'str', +'scheduling_period': 'str', +'scheduling_strategy': 'str', +'style': 'dict(str, str)', +'type': 'str', +'yield_duration': 'str' } attribute_map = { - 'identifier': 'identifier', - 'instance_identifier': 'instanceIdentifier', - 'name': 'name', - 'comments': 'comments', - 'position': 'position', - 'type': 'type', - 'bundle': 'bundle', - 'properties': 'properties', - 'property_descriptors': 'propertyDescriptors', - 'style': 'style', 'annotation_data': 'annotationData', - 'scheduling_period': 'schedulingPeriod', - 'scheduling_strategy': 'schedulingStrategy', - 'execution_node': 'executionNode', - 'penalty_duration': 'penaltyDuration', - 'yield_duration': 'yieldDuration', - 'bulletin_level': 'bulletinLevel', - 'run_duration_millis': 'runDurationMillis', - 'concurrently_schedulable_task_count': 'concurrentlySchedulableTaskCount', - 'auto_terminated_relationships': 'autoTerminatedRelationships', - 'scheduled_state': 'scheduledState', - 'retry_count': 'retryCount', - 'retried_relationships': 'retriedRelationships', - 'backoff_mechanism': 'backoffMechanism', - 'max_backoff_period': 'maxBackoffPeriod', - 'component_type': 'componentType', - 'group_identifier': 'groupIdentifier' - } - - def __init__(self, identifier=None, instance_identifier=None, name=None, comments=None, position=None, type=None, bundle=None, properties=None, property_descriptors=None, style=None, annotation_data=None, scheduling_period=None, scheduling_strategy=None, execution_node=None, penalty_duration=None, yield_duration=None, bulletin_level=None, run_duration_millis=None, concurrently_schedulable_task_count=None, auto_terminated_relationships=None, scheduled_state=None, retry_count=None, retried_relationships=None, backoff_mechanism=None, max_backoff_period=None, component_type=None, group_identifier=None): +'auto_terminated_relationships': 'autoTerminatedRelationships', +'backoff_mechanism': 'backoffMechanism', +'bulletin_level': 'bulletinLevel', +'bundle': 'bundle', +'comments': 'comments', +'component_type': 'componentType', +'concurrently_schedulable_task_count': 'concurrentlySchedulableTaskCount', +'execution_node': 'executionNode', +'group_identifier': 'groupIdentifier', +'identifier': 'identifier', +'instance_identifier': 'instanceIdentifier', +'max_backoff_period': 'maxBackoffPeriod', +'name': 'name', +'penalty_duration': 'penaltyDuration', +'position': 'position', +'properties': 'properties', +'property_descriptors': 'propertyDescriptors', +'retried_relationships': 'retriedRelationships', +'retry_count': 'retryCount', +'run_duration_millis': 'runDurationMillis', +'scheduled_state': 'scheduledState', +'scheduling_period': 'schedulingPeriod', +'scheduling_strategy': 'schedulingStrategy', +'style': 'style', +'type': 'type', +'yield_duration': 'yieldDuration' } + + def __init__(self, annotation_data=None, auto_terminated_relationships=None, backoff_mechanism=None, bulletin_level=None, bundle=None, comments=None, component_type=None, concurrently_schedulable_task_count=None, execution_node=None, group_identifier=None, identifier=None, instance_identifier=None, max_backoff_period=None, name=None, penalty_duration=None, position=None, properties=None, property_descriptors=None, retried_relationships=None, retry_count=None, run_duration_millis=None, scheduled_state=None, scheduling_period=None, scheduling_strategy=None, style=None, type=None, yield_duration=None): """ VersionedProcessor - a model defined in Swagger """ + self._annotation_data = None + self._auto_terminated_relationships = None + self._backoff_mechanism = None + self._bulletin_level = None + self._bundle = None + self._comments = None + self._component_type = None + self._concurrently_schedulable_task_count = None + self._execution_node = None + self._group_identifier = None self._identifier = None self._instance_identifier = None + self._max_backoff_period = None self._name = None - self._comments = None + self._penalty_duration = None self._position = None - self._type = None - self._bundle = None self._properties = None self._property_descriptors = None - self._style = None - self._annotation_data = None + self._retried_relationships = None + self._retry_count = None + self._run_duration_millis = None + self._scheduled_state = None self._scheduling_period = None self._scheduling_strategy = None - self._execution_node = None - self._penalty_duration = None + self._style = None + self._type = None self._yield_duration = None - self._bulletin_level = None - self._run_duration_millis = None - self._concurrently_schedulable_task_count = None - self._auto_terminated_relationships = None - self._scheduled_state = None - self._retry_count = None - self._retried_relationships = None - self._backoff_mechanism = None - self._max_backoff_period = None - self._component_type = None - self._group_identifier = None + if annotation_data is not None: + self.annotation_data = annotation_data + if auto_terminated_relationships is not None: + self.auto_terminated_relationships = auto_terminated_relationships + if backoff_mechanism is not None: + self.backoff_mechanism = backoff_mechanism + if bulletin_level is not None: + self.bulletin_level = bulletin_level + if bundle is not None: + self.bundle = bundle + if comments is not None: + self.comments = comments + if component_type is not None: + self.component_type = component_type + if concurrently_schedulable_task_count is not None: + self.concurrently_schedulable_task_count = concurrently_schedulable_task_count + if execution_node is not None: + self.execution_node = execution_node + if group_identifier is not None: + self.group_identifier = group_identifier if identifier is not None: self.identifier = identifier if instance_identifier is not None: self.instance_identifier = instance_identifier + if max_backoff_period is not None: + self.max_backoff_period = max_backoff_period if name is not None: self.name = name - if comments is not None: - self.comments = comments + if penalty_duration is not None: + self.penalty_duration = penalty_duration if position is not None: self.position = position - if type is not None: - self.type = type - if bundle is not None: - self.bundle = bundle if properties is not None: self.properties = properties if property_descriptors is not None: self.property_descriptors = property_descriptors - if style is not None: - self.style = style - if annotation_data is not None: - self.annotation_data = annotation_data + if retried_relationships is not None: + self.retried_relationships = retried_relationships + if retry_count is not None: + self.retry_count = retry_count + if run_duration_millis is not None: + self.run_duration_millis = run_duration_millis + if scheduled_state is not None: + self.scheduled_state = scheduled_state if scheduling_period is not None: self.scheduling_period = scheduling_period if scheduling_strategy is not None: self.scheduling_strategy = scheduling_strategy - if execution_node is not None: - self.execution_node = execution_node - if penalty_duration is not None: - self.penalty_duration = penalty_duration + if style is not None: + self.style = style + if type is not None: + self.type = type if yield_duration is not None: self.yield_duration = yield_duration - if bulletin_level is not None: - self.bulletin_level = bulletin_level - if run_duration_millis is not None: - self.run_duration_millis = run_duration_millis - if concurrently_schedulable_task_count is not None: - self.concurrently_schedulable_task_count = concurrently_schedulable_task_count - if auto_terminated_relationships is not None: - self.auto_terminated_relationships = auto_terminated_relationships - if scheduled_state is not None: - self.scheduled_state = scheduled_state - if retry_count is not None: - self.retry_count = retry_count - if retried_relationships is not None: - self.retried_relationships = retried_relationships - if backoff_mechanism is not None: - self.backoff_mechanism = backoff_mechanism - if max_backoff_period is not None: - self.max_backoff_period = max_backoff_period - if component_type is not None: - self.component_type = component_type - if group_identifier is not None: - self.group_identifier = group_identifier @property - def identifier(self): + def annotation_data(self): """ - Gets the identifier of this VersionedProcessor. - The component's unique identifier + Gets the annotation_data of this VersionedProcessor. + The annotation data for the processor used to relay configuration between a custom UI and the procesosr. - :return: The identifier of this VersionedProcessor. + :return: The annotation_data of this VersionedProcessor. :rtype: str """ - return self._identifier + return self._annotation_data - @identifier.setter - def identifier(self, identifier): + @annotation_data.setter + def annotation_data(self, annotation_data): """ - Sets the identifier of this VersionedProcessor. - The component's unique identifier + Sets the annotation_data of this VersionedProcessor. + The annotation data for the processor used to relay configuration between a custom UI and the procesosr. - :param identifier: The identifier of this VersionedProcessor. + :param annotation_data: The annotation_data of this VersionedProcessor. :type: str """ - self._identifier = identifier + self._annotation_data = annotation_data @property - def instance_identifier(self): + def auto_terminated_relationships(self): """ - Gets the instance_identifier of this VersionedProcessor. - The instance ID of an existing component that is described by this VersionedComponent, or null if this is not mapped to an instantiated component + Gets the auto_terminated_relationships of this VersionedProcessor. + The names of all relationships that cause a flow file to be terminated if the relationship is not connected elsewhere. This property differs from the 'isAutoTerminate' property of the RelationshipDTO in that the RelationshipDTO is meant to depict the current configuration, whereas this property can be set in a DTO when updating a Processor in order to change which Relationships should be auto-terminated. - :return: The instance_identifier of this VersionedProcessor. + :return: The auto_terminated_relationships of this VersionedProcessor. + :rtype: list[str] + """ + return self._auto_terminated_relationships + + @auto_terminated_relationships.setter + def auto_terminated_relationships(self, auto_terminated_relationships): + """ + Sets the auto_terminated_relationships of this VersionedProcessor. + The names of all relationships that cause a flow file to be terminated if the relationship is not connected elsewhere. This property differs from the 'isAutoTerminate' property of the RelationshipDTO in that the RelationshipDTO is meant to depict the current configuration, whereas this property can be set in a DTO when updating a Processor in order to change which Relationships should be auto-terminated. + + :param auto_terminated_relationships: The auto_terminated_relationships of this VersionedProcessor. + :type: list[str] + """ + + self._auto_terminated_relationships = auto_terminated_relationships + + @property + def backoff_mechanism(self): + """ + Gets the backoff_mechanism of this VersionedProcessor. + Determines whether the FlowFile should be penalized or the processor should be yielded between retries. + + :return: The backoff_mechanism of this VersionedProcessor. :rtype: str """ - return self._instance_identifier + return self._backoff_mechanism - @instance_identifier.setter - def instance_identifier(self, instance_identifier): + @backoff_mechanism.setter + def backoff_mechanism(self, backoff_mechanism): """ - Sets the instance_identifier of this VersionedProcessor. - The instance ID of an existing component that is described by this VersionedComponent, or null if this is not mapped to an instantiated component + Sets the backoff_mechanism of this VersionedProcessor. + Determines whether the FlowFile should be penalized or the processor should be yielded between retries. - :param instance_identifier: The instance_identifier of this VersionedProcessor. + :param backoff_mechanism: The backoff_mechanism of this VersionedProcessor. :type: str """ + allowed_values = ["PENALIZE_FLOWFILE", "YIELD_PROCESSOR", ] + if backoff_mechanism not in allowed_values: + raise ValueError( + "Invalid value for `backoff_mechanism` ({0}), must be one of {1}" + .format(backoff_mechanism, allowed_values) + ) - self._instance_identifier = instance_identifier + self._backoff_mechanism = backoff_mechanism @property - def name(self): + def bulletin_level(self): """ - Gets the name of this VersionedProcessor. - The component's name + Gets the bulletin_level of this VersionedProcessor. + The level at which the processor will report bulletins. - :return: The name of this VersionedProcessor. + :return: The bulletin_level of this VersionedProcessor. :rtype: str """ - return self._name + return self._bulletin_level - @name.setter - def name(self, name): + @bulletin_level.setter + def bulletin_level(self, bulletin_level): """ - Sets the name of this VersionedProcessor. - The component's name + Sets the bulletin_level of this VersionedProcessor. + The level at which the processor will report bulletins. - :param name: The name of this VersionedProcessor. + :param bulletin_level: The bulletin_level of this VersionedProcessor. :type: str """ - self._name = name + self._bulletin_level = bulletin_level + + @property + def bundle(self): + """ + Gets the bundle of this VersionedProcessor. + + :return: The bundle of this VersionedProcessor. + :rtype: Bundle + """ + return self._bundle + + @bundle.setter + def bundle(self, bundle): + """ + Sets the bundle of this VersionedProcessor. + + :param bundle: The bundle of this VersionedProcessor. + :type: Bundle + """ + + self._bundle = bundle @property def comments(self): @@ -268,303 +315,328 @@ def comments(self, comments): self._comments = comments @property - def position(self): + def component_type(self): """ - Gets the position of this VersionedProcessor. - The component's position on the graph + Gets the component_type of this VersionedProcessor. - :return: The position of this VersionedProcessor. - :rtype: Position + :return: The component_type of this VersionedProcessor. + :rtype: str """ - return self._position + return self._component_type - @position.setter - def position(self, position): + @component_type.setter + def component_type(self, component_type): """ - Sets the position of this VersionedProcessor. - The component's position on the graph + Sets the component_type of this VersionedProcessor. - :param position: The position of this VersionedProcessor. - :type: Position + :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", ] + 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._position = position + self._component_type = component_type @property - def type(self): + def concurrently_schedulable_task_count(self): """ - Gets the type of this VersionedProcessor. - The type of the extension component + Gets the concurrently_schedulable_task_count of this VersionedProcessor. + The number of tasks that should be concurrently schedule for the processor. If the processor doesn't allow parallol processing then any positive input will be ignored. - :return: The type of this VersionedProcessor. - :rtype: str + :return: The concurrently_schedulable_task_count of this VersionedProcessor. + :rtype: int """ - return self._type + return self._concurrently_schedulable_task_count - @type.setter - def type(self, type): + @concurrently_schedulable_task_count.setter + def concurrently_schedulable_task_count(self, concurrently_schedulable_task_count): """ - Sets the type of this VersionedProcessor. - The type of the extension component + Sets the concurrently_schedulable_task_count of this VersionedProcessor. + The number of tasks that should be concurrently schedule for the processor. If the processor doesn't allow parallol processing then any positive input will be ignored. - :param type: The type of this VersionedProcessor. - :type: str + :param concurrently_schedulable_task_count: The concurrently_schedulable_task_count of this VersionedProcessor. + :type: int """ - self._type = type + self._concurrently_schedulable_task_count = concurrently_schedulable_task_count @property - def bundle(self): + def execution_node(self): """ - Gets the bundle of this VersionedProcessor. - Information about the bundle from which the component came + Gets the execution_node of this VersionedProcessor. + Indicates the node where the process will execute. - :return: The bundle of this VersionedProcessor. - :rtype: Bundle + :return: The execution_node of this VersionedProcessor. + :rtype: str """ - return self._bundle + return self._execution_node - @bundle.setter - def bundle(self, bundle): + @execution_node.setter + def execution_node(self, execution_node): """ - Sets the bundle of this VersionedProcessor. - Information about the bundle from which the component came + Sets the execution_node of this VersionedProcessor. + Indicates the node where the process will execute. - :param bundle: The bundle of this VersionedProcessor. - :type: Bundle + :param execution_node: The execution_node of this VersionedProcessor. + :type: str """ - self._bundle = bundle + self._execution_node = execution_node @property - def properties(self): + def group_identifier(self): """ - Gets the properties of this VersionedProcessor. - The properties for the component. Properties whose value is not set will only contain the property name. + Gets the group_identifier of this VersionedProcessor. + The ID of the Process Group that this component belongs to - :return: The properties of this VersionedProcessor. - :rtype: dict(str, str) + :return: The group_identifier of this VersionedProcessor. + :rtype: str """ - return self._properties + return self._group_identifier - @properties.setter - def properties(self, properties): + @group_identifier.setter + def group_identifier(self, group_identifier): """ - Sets the properties of this VersionedProcessor. - The properties for the component. Properties whose value is not set will only contain the property name. + Sets the group_identifier of this VersionedProcessor. + The ID of the Process Group that this component belongs to - :param properties: The properties of this VersionedProcessor. - :type: dict(str, str) + :param group_identifier: The group_identifier of this VersionedProcessor. + :type: str """ - self._properties = properties + self._group_identifier = group_identifier @property - def property_descriptors(self): + def identifier(self): """ - Gets the property_descriptors of this VersionedProcessor. - The property descriptors for the component. + Gets the identifier of this VersionedProcessor. + The component's unique identifier - :return: The property_descriptors of this VersionedProcessor. - :rtype: dict(str, VersionedPropertyDescriptor) + :return: The identifier of this VersionedProcessor. + :rtype: str """ - return self._property_descriptors + return self._identifier - @property_descriptors.setter - def property_descriptors(self, property_descriptors): + @identifier.setter + def identifier(self, identifier): """ - Sets the property_descriptors of this VersionedProcessor. - The property descriptors for the component. + Sets the identifier of this VersionedProcessor. + The component's unique identifier - :param property_descriptors: The property_descriptors of this VersionedProcessor. - :type: dict(str, VersionedPropertyDescriptor) + :param identifier: The identifier of this VersionedProcessor. + :type: str """ - self._property_descriptors = property_descriptors + self._identifier = identifier @property - def style(self): + def instance_identifier(self): """ - Gets the style of this VersionedProcessor. - Stylistic data for rendering in a UI + Gets the instance_identifier of this VersionedProcessor. + The instance ID of an existing component that is described by this VersionedComponent, or null if this is not mapped to an instantiated component - :return: The style of this VersionedProcessor. - :rtype: dict(str, str) + :return: The instance_identifier of this VersionedProcessor. + :rtype: str """ - return self._style + return self._instance_identifier - @style.setter - def style(self, style): + @instance_identifier.setter + def instance_identifier(self, instance_identifier): """ - Sets the style of this VersionedProcessor. - Stylistic data for rendering in a UI + Sets the instance_identifier of this VersionedProcessor. + The instance ID of an existing component that is described by this VersionedComponent, or null if this is not mapped to an instantiated component - :param style: The style of this VersionedProcessor. - :type: dict(str, str) + :param instance_identifier: The instance_identifier of this VersionedProcessor. + :type: str """ - self._style = style + self._instance_identifier = instance_identifier @property - def annotation_data(self): + def max_backoff_period(self): """ - Gets the annotation_data of this VersionedProcessor. - The annotation data for the processor used to relay configuration between a custom UI and the procesosr. + Gets the max_backoff_period of this VersionedProcessor. + Maximum amount of time to be waited during a retry period. - :return: The annotation_data of this VersionedProcessor. + :return: The max_backoff_period of this VersionedProcessor. :rtype: str """ - return self._annotation_data + return self._max_backoff_period - @annotation_data.setter - def annotation_data(self, annotation_data): + @max_backoff_period.setter + def max_backoff_period(self, max_backoff_period): """ - Sets the annotation_data of this VersionedProcessor. - The annotation data for the processor used to relay configuration between a custom UI and the procesosr. + Sets the max_backoff_period of this VersionedProcessor. + Maximum amount of time to be waited during a retry period. - :param annotation_data: The annotation_data of this VersionedProcessor. + :param max_backoff_period: The max_backoff_period of this VersionedProcessor. :type: str """ - self._annotation_data = annotation_data + self._max_backoff_period = max_backoff_period @property - def scheduling_period(self): + def name(self): """ - Gets the scheduling_period of this VersionedProcessor. - The frequency with which to schedule the processor. The format of the value will depend on th value of schedulingStrategy. + Gets the name of this VersionedProcessor. + The component's name - :return: The scheduling_period of this VersionedProcessor. + :return: The name of this VersionedProcessor. :rtype: str """ - return self._scheduling_period + return self._name - @scheduling_period.setter - def scheduling_period(self, scheduling_period): + @name.setter + def name(self, name): """ - Sets the scheduling_period of this VersionedProcessor. - The frequency with which to schedule the processor. The format of the value will depend on th value of schedulingStrategy. + Sets the name of this VersionedProcessor. + The component's name - :param scheduling_period: The scheduling_period of this VersionedProcessor. + :param name: The name of this VersionedProcessor. :type: str """ - self._scheduling_period = scheduling_period + self._name = name @property - def scheduling_strategy(self): + def penalty_duration(self): """ - Gets the scheduling_strategy of this VersionedProcessor. - Indicates whether the processor should be scheduled to run in event or timer driven mode. + Gets the penalty_duration of this VersionedProcessor. + The amout of time that is used when the process penalizes a flowfile. - :return: The scheduling_strategy of this VersionedProcessor. + :return: The penalty_duration of this VersionedProcessor. :rtype: str """ - return self._scheduling_strategy + return self._penalty_duration - @scheduling_strategy.setter - def scheduling_strategy(self, scheduling_strategy): + @penalty_duration.setter + def penalty_duration(self, penalty_duration): """ - Sets the scheduling_strategy of this VersionedProcessor. - Indicates whether the processor should be scheduled to run in event or timer driven mode. + Sets the penalty_duration of this VersionedProcessor. + The amout of time that is used when the process penalizes a flowfile. - :param scheduling_strategy: The scheduling_strategy of this VersionedProcessor. + :param penalty_duration: The penalty_duration of this VersionedProcessor. :type: str """ - self._scheduling_strategy = scheduling_strategy + self._penalty_duration = penalty_duration @property - def execution_node(self): + def position(self): """ - Gets the execution_node of this VersionedProcessor. - Indicates the node where the process will execute. + Gets the position of this VersionedProcessor. - :return: The execution_node of this VersionedProcessor. - :rtype: str + :return: The position of this VersionedProcessor. + :rtype: Position """ - return self._execution_node + return self._position - @execution_node.setter - def execution_node(self, execution_node): + @position.setter + def position(self, position): """ - Sets the execution_node of this VersionedProcessor. - Indicates the node where the process will execute. + Sets the position of this VersionedProcessor. - :param execution_node: The execution_node of this VersionedProcessor. - :type: str + :param position: The position of this VersionedProcessor. + :type: Position """ - self._execution_node = execution_node + self._position = position @property - def penalty_duration(self): + def properties(self): """ - Gets the penalty_duration of this VersionedProcessor. - The amout of time that is used when the process penalizes a flowfile. + Gets the properties of this VersionedProcessor. + The properties for the component. Properties whose value is not set will only contain the property name. - :return: The penalty_duration of this VersionedProcessor. - :rtype: str + :return: The properties of this VersionedProcessor. + :rtype: dict(str, str) """ - return self._penalty_duration + return self._properties - @penalty_duration.setter - def penalty_duration(self, penalty_duration): + @properties.setter + def properties(self, properties): + """ + Sets the properties of this VersionedProcessor. + The properties for the component. Properties whose value is not set will only contain the property name. + + :param properties: The properties of this VersionedProcessor. + :type: dict(str, str) + """ + + self._properties = properties + + @property + def property_descriptors(self): + """ + Gets the property_descriptors of this VersionedProcessor. + The property descriptors for the component. + + :return: The property_descriptors of this VersionedProcessor. + :rtype: dict(str, VersionedPropertyDescriptor) + """ + return self._property_descriptors + + @property_descriptors.setter + def property_descriptors(self, property_descriptors): """ - Sets the penalty_duration of this VersionedProcessor. - The amout of time that is used when the process penalizes a flowfile. + Sets the property_descriptors of this VersionedProcessor. + The property descriptors for the component. - :param penalty_duration: The penalty_duration of this VersionedProcessor. - :type: str + :param property_descriptors: The property_descriptors of this VersionedProcessor. + :type: dict(str, VersionedPropertyDescriptor) """ - self._penalty_duration = penalty_duration + self._property_descriptors = property_descriptors @property - def yield_duration(self): + def retried_relationships(self): """ - Gets the yield_duration of this VersionedProcessor. - The amount of time that must elapse before this processor is scheduled again after yielding. + Gets the retried_relationships of this VersionedProcessor. + All the relationships should be retried. - :return: The yield_duration of this VersionedProcessor. - :rtype: str + :return: The retried_relationships of this VersionedProcessor. + :rtype: list[str] """ - return self._yield_duration + return self._retried_relationships - @yield_duration.setter - def yield_duration(self, yield_duration): + @retried_relationships.setter + def retried_relationships(self, retried_relationships): """ - Sets the yield_duration of this VersionedProcessor. - The amount of time that must elapse before this processor is scheduled again after yielding. + Sets the retried_relationships of this VersionedProcessor. + All the relationships should be retried. - :param yield_duration: The yield_duration of this VersionedProcessor. - :type: str + :param retried_relationships: The retried_relationships of this VersionedProcessor. + :type: list[str] """ - self._yield_duration = yield_duration + self._retried_relationships = retried_relationships @property - def bulletin_level(self): + def retry_count(self): """ - Gets the bulletin_level of this VersionedProcessor. - The level at which the processor will report bulletins. + Gets the retry_count of this VersionedProcessor. + Overall number of retries. - :return: The bulletin_level of this VersionedProcessor. - :rtype: str + :return: The retry_count of this VersionedProcessor. + :rtype: int """ - return self._bulletin_level + return self._retry_count - @bulletin_level.setter - def bulletin_level(self, bulletin_level): + @retry_count.setter + def retry_count(self, retry_count): """ - Sets the bulletin_level of this VersionedProcessor. - The level at which the processor will report bulletins. + Sets the retry_count of this VersionedProcessor. + Overall number of retries. - :param bulletin_level: The bulletin_level of this VersionedProcessor. - :type: str + :param retry_count: The retry_count of this VersionedProcessor. + :type: int """ - self._bulletin_level = bulletin_level + self._retry_count = retry_count @property def run_duration_millis(self): @@ -589,52 +661,6 @@ def run_duration_millis(self, run_duration_millis): self._run_duration_millis = run_duration_millis - @property - def concurrently_schedulable_task_count(self): - """ - Gets the concurrently_schedulable_task_count of this VersionedProcessor. - The number of tasks that should be concurrently schedule for the processor. If the processor doesn't allow parallol processing then any positive input will be ignored. - - :return: The concurrently_schedulable_task_count of this VersionedProcessor. - :rtype: int - """ - return self._concurrently_schedulable_task_count - - @concurrently_schedulable_task_count.setter - def concurrently_schedulable_task_count(self, concurrently_schedulable_task_count): - """ - Sets the concurrently_schedulable_task_count of this VersionedProcessor. - The number of tasks that should be concurrently schedule for the processor. If the processor doesn't allow parallol processing then any positive input will be ignored. - - :param concurrently_schedulable_task_count: The concurrently_schedulable_task_count of this VersionedProcessor. - :type: int - """ - - self._concurrently_schedulable_task_count = concurrently_schedulable_task_count - - @property - def auto_terminated_relationships(self): - """ - Gets the auto_terminated_relationships of this VersionedProcessor. - The names of all relationships that cause a flow file to be terminated if the relationship is not connected elsewhere. This property differs from the 'isAutoTerminate' property of the RelationshipDTO in that the RelationshipDTO is meant to depict the current configuration, whereas this property can be set in a DTO when updating a Processor in order to change which Relationships should be auto-terminated. - - :return: The auto_terminated_relationships of this VersionedProcessor. - :rtype: list[str] - """ - return self._auto_terminated_relationships - - @auto_terminated_relationships.setter - def auto_terminated_relationships(self, auto_terminated_relationships): - """ - Sets the auto_terminated_relationships of this VersionedProcessor. - The names of all relationships that cause a flow file to be terminated if the relationship is not connected elsewhere. This property differs from the 'isAutoTerminate' property of the RelationshipDTO in that the RelationshipDTO is meant to depict the current configuration, whereas this property can be set in a DTO when updating a Processor in order to change which Relationships should be auto-terminated. - - :param auto_terminated_relationships: The auto_terminated_relationships of this VersionedProcessor. - :type: list[str] - """ - - self._auto_terminated_relationships = auto_terminated_relationships - @property def scheduled_state(self): """ @@ -655,7 +681,7 @@ def scheduled_state(self, scheduled_state): :param scheduled_state: The scheduled_state of this VersionedProcessor. :type: str """ - allowed_values = ["ENABLED", "DISABLED", "RUNNING"] + 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}" @@ -665,152 +691,119 @@ def scheduled_state(self, scheduled_state): self._scheduled_state = scheduled_state @property - def retry_count(self): - """ - Gets the retry_count of this VersionedProcessor. - Overall number of retries. - - :return: The retry_count of this VersionedProcessor. - :rtype: int - """ - return self._retry_count - - @retry_count.setter - def retry_count(self, retry_count): - """ - Sets the retry_count of this VersionedProcessor. - Overall number of retries. - - :param retry_count: The retry_count of this VersionedProcessor. - :type: int - """ - - self._retry_count = retry_count - - @property - def retried_relationships(self): + def scheduling_period(self): """ - Gets the retried_relationships of this VersionedProcessor. - All the relationships should be retried. + Gets the scheduling_period of this VersionedProcessor. + The frequency with which to schedule the processor. The format of the value will depend on th value of schedulingStrategy. - :return: The retried_relationships of this VersionedProcessor. - :rtype: list[str] + :return: The scheduling_period of this VersionedProcessor. + :rtype: str """ - return self._retried_relationships + return self._scheduling_period - @retried_relationships.setter - def retried_relationships(self, retried_relationships): + @scheduling_period.setter + def scheduling_period(self, scheduling_period): """ - Sets the retried_relationships of this VersionedProcessor. - All the relationships should be retried. + Sets the scheduling_period of this VersionedProcessor. + The frequency with which to schedule the processor. The format of the value will depend on th value of schedulingStrategy. - :param retried_relationships: The retried_relationships of this VersionedProcessor. - :type: list[str] + :param scheduling_period: The scheduling_period of this VersionedProcessor. + :type: str """ - self._retried_relationships = retried_relationships + self._scheduling_period = scheduling_period @property - def backoff_mechanism(self): + def scheduling_strategy(self): """ - Gets the backoff_mechanism of this VersionedProcessor. - Determines whether the FlowFile should be penalized or the processor should be yielded between retries. + Gets the scheduling_strategy of this VersionedProcessor. + Indicates how the processor should be scheduled to run. - :return: The backoff_mechanism of this VersionedProcessor. + :return: The scheduling_strategy of this VersionedProcessor. :rtype: str """ - return self._backoff_mechanism + return self._scheduling_strategy - @backoff_mechanism.setter - def backoff_mechanism(self, backoff_mechanism): + @scheduling_strategy.setter + def scheduling_strategy(self, scheduling_strategy): """ - Sets the backoff_mechanism of this VersionedProcessor. - Determines whether the FlowFile should be penalized or the processor should be yielded between retries. + Sets the scheduling_strategy of this VersionedProcessor. + Indicates how the processor should be scheduled to run. - :param backoff_mechanism: The backoff_mechanism of this VersionedProcessor. + :param scheduling_strategy: The scheduling_strategy of this VersionedProcessor. :type: str """ - allowed_values = ["PENALIZE_FLOWFILE", "YIELD_PROCESSOR"] - if backoff_mechanism not in allowed_values: - raise ValueError( - "Invalid value for `backoff_mechanism` ({0}), must be one of {1}" - .format(backoff_mechanism, allowed_values) - ) - self._backoff_mechanism = backoff_mechanism + self._scheduling_strategy = scheduling_strategy @property - def max_backoff_period(self): + def style(self): """ - Gets the max_backoff_period of this VersionedProcessor. - Maximum amount of time to be waited during a retry period. + Gets the style of this VersionedProcessor. + Stylistic data for rendering in a UI - :return: The max_backoff_period of this VersionedProcessor. - :rtype: str + :return: The style of this VersionedProcessor. + :rtype: dict(str, str) """ - return self._max_backoff_period + return self._style - @max_backoff_period.setter - def max_backoff_period(self, max_backoff_period): + @style.setter + def style(self, style): """ - Sets the max_backoff_period of this VersionedProcessor. - Maximum amount of time to be waited during a retry period. + Sets the style of this VersionedProcessor. + Stylistic data for rendering in a UI - :param max_backoff_period: The max_backoff_period of this VersionedProcessor. - :type: str + :param style: The style of this VersionedProcessor. + :type: dict(str, str) """ - self._max_backoff_period = max_backoff_period + self._style = style @property - def component_type(self): + def type(self): """ - Gets the component_type of this VersionedProcessor. + Gets the type of this VersionedProcessor. + The type of the extension component - :return: The component_type of this VersionedProcessor. + :return: The type of this VersionedProcessor. :rtype: str """ - return self._component_type + return self._type - @component_type.setter - def component_type(self, component_type): + @type.setter + def type(self, type): """ - Sets the component_type of this VersionedProcessor. + Sets the type of this VersionedProcessor. + The type of the extension component - :param component_type: The component_type of this VersionedProcessor. + :param type: The 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", "PARAMETER_CONTEXT", "PARAMETER_PROVIDER", "TEMPLATE", "FLOW_REGISTRY_CLIENT"] - 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 + self._type = type @property - def group_identifier(self): + def yield_duration(self): """ - Gets the group_identifier of this VersionedProcessor. - The ID of the Process Group that this component belongs to + Gets the yield_duration of this VersionedProcessor. + The amount of time that must elapse before this processor is scheduled again after yielding. - :return: The group_identifier of this VersionedProcessor. + :return: The yield_duration of this VersionedProcessor. :rtype: str """ - return self._group_identifier + return self._yield_duration - @group_identifier.setter - def group_identifier(self, group_identifier): + @yield_duration.setter + def yield_duration(self, yield_duration): """ - Sets the group_identifier of this VersionedProcessor. - The ID of the Process Group that this component belongs to + Sets the yield_duration of this VersionedProcessor. + The amount of time that must elapse before this processor is scheduled again after yielding. - :param group_identifier: The group_identifier of this VersionedProcessor. + :param yield_duration: The yield_duration of this VersionedProcessor. :type: str """ - self._group_identifier = group_identifier + self._yield_duration = yield_duration def to_dict(self): """ diff --git a/nipyapi/nifi/models/versioned_property_descriptor.py b/nipyapi/nifi/models/versioned_property_descriptor.py index 63347b28..3c445d18 100644 --- a/nipyapi/nifi/models/versioned_property_descriptor.py +++ b/nipyapi/nifi/models/versioned_property_descriptor.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,65 +27,45 @@ class VersionedPropertyDescriptor(object): and the value is json key in definition. """ swagger_types = { - 'name': 'str', 'display_name': 'str', - 'identifies_controller_service': 'bool', - 'sensitive': 'bool', - 'resource_definition': 'VersionedResourceDefinition' - } +'dynamic': 'bool', +'identifies_controller_service': 'bool', +'name': 'str', +'resource_definition': 'VersionedResourceDefinition', +'sensitive': 'bool' } attribute_map = { - 'name': 'name', 'display_name': 'displayName', - 'identifies_controller_service': 'identifiesControllerService', - 'sensitive': 'sensitive', - 'resource_definition': 'resourceDefinition' - } +'dynamic': 'dynamic', +'identifies_controller_service': 'identifiesControllerService', +'name': 'name', +'resource_definition': 'resourceDefinition', +'sensitive': 'sensitive' } - def __init__(self, name=None, display_name=None, identifies_controller_service=None, sensitive=None, resource_definition=None): + def __init__(self, display_name=None, dynamic=None, identifies_controller_service=None, name=None, resource_definition=None, sensitive=None): """ VersionedPropertyDescriptor - a model defined in Swagger """ - self._name = None self._display_name = None + self._dynamic = None self._identifies_controller_service = None - self._sensitive = None + self._name = None self._resource_definition = None + self._sensitive = None - if name is not None: - self.name = name if display_name is not None: self.display_name = display_name + if dynamic is not None: + self.dynamic = dynamic if identifies_controller_service is not None: self.identifies_controller_service = identifies_controller_service - if sensitive is not None: - self.sensitive = sensitive + if name is not None: + self.name = name if resource_definition is not None: self.resource_definition = resource_definition - - @property - def name(self): - """ - Gets the name of this VersionedPropertyDescriptor. - The name of the property - - :return: The name of this VersionedPropertyDescriptor. - :rtype: str - """ - return self._name - - @name.setter - def name(self, name): - """ - Sets the name of this VersionedPropertyDescriptor. - The name of the property - - :param name: The name of this VersionedPropertyDescriptor. - :type: str - """ - - self._name = name + if sensitive is not None: + self.sensitive = sensitive @property def display_name(self): @@ -111,6 +90,29 @@ def display_name(self, display_name): self._display_name = display_name + @property + def dynamic(self): + """ + Gets the dynamic of this VersionedPropertyDescriptor. + Whether or not the property is user-defined + + :return: The dynamic of this VersionedPropertyDescriptor. + :rtype: bool + """ + return self._dynamic + + @dynamic.setter + def dynamic(self, dynamic): + """ + Sets the dynamic of this VersionedPropertyDescriptor. + Whether or not the property is user-defined + + :param dynamic: The dynamic of this VersionedPropertyDescriptor. + :type: bool + """ + + self._dynamic = dynamic + @property def identifies_controller_service(self): """ @@ -135,33 +137,32 @@ def identifies_controller_service(self, identifies_controller_service): self._identifies_controller_service = identifies_controller_service @property - def sensitive(self): + def name(self): """ - Gets the sensitive of this VersionedPropertyDescriptor. - Whether or not the property is considered sensitive + Gets the name of this VersionedPropertyDescriptor. + The name of the property - :return: The sensitive of this VersionedPropertyDescriptor. - :rtype: bool + :return: The name of this VersionedPropertyDescriptor. + :rtype: str """ - return self._sensitive + return self._name - @sensitive.setter - def sensitive(self, sensitive): + @name.setter + def name(self, name): """ - Sets the sensitive of this VersionedPropertyDescriptor. - Whether or not the property is considered sensitive + Sets the name of this VersionedPropertyDescriptor. + The name of the property - :param sensitive: The sensitive of this VersionedPropertyDescriptor. - :type: bool + :param name: The name of this VersionedPropertyDescriptor. + :type: str """ - self._sensitive = sensitive + self._name = name @property def resource_definition(self): """ Gets the resource_definition of this VersionedPropertyDescriptor. - Returns the Resource Definition that defines which type(s) of resource(s) this property references, if any :return: The resource_definition of this VersionedPropertyDescriptor. :rtype: VersionedResourceDefinition @@ -172,7 +173,6 @@ def resource_definition(self): def resource_definition(self, resource_definition): """ Sets the resource_definition of this VersionedPropertyDescriptor. - Returns the Resource Definition that defines which type(s) of resource(s) this property references, if any :param resource_definition: The resource_definition of this VersionedPropertyDescriptor. :type: VersionedResourceDefinition @@ -180,6 +180,29 @@ def resource_definition(self, resource_definition): self._resource_definition = resource_definition + @property + def sensitive(self): + """ + Gets the sensitive of this VersionedPropertyDescriptor. + Whether or not the property is considered sensitive + + :return: The sensitive of this VersionedPropertyDescriptor. + :rtype: bool + """ + return self._sensitive + + @sensitive.setter + def sensitive(self, sensitive): + """ + Sets the sensitive of this VersionedPropertyDescriptor. + Whether or not the property is considered sensitive + + :param sensitive: The sensitive of this VersionedPropertyDescriptor. + :type: bool + """ + + self._sensitive = sensitive + def to_dict(self): """ Returns the model properties as a dict diff --git a/nipyapi/nifi/models/versioned_remote_group_port.py b/nipyapi/nifi/models/versioned_remote_group_port.py index d4448817..bbae9fde 100644 --- a/nipyapi/nifi/models/versioned_remote_group_port.py +++ b/nipyapi/nifi/models/versioned_remote_group_port.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,82 +27,197 @@ class VersionedRemoteGroupPort(object): and the value is json key in definition. """ swagger_types = { - 'identifier': 'str', - 'instance_identifier': 'str', - 'name': 'str', - 'comments': 'str', - 'position': 'Position', - 'remote_group_id': 'str', - 'concurrently_schedulable_task_count': 'int', - 'use_compression': 'bool', 'batch_size': 'BatchSize', - 'component_type': 'str', - 'target_id': 'str', - 'scheduled_state': 'str', - 'group_identifier': 'str' - } +'comments': 'str', +'component_type': 'str', +'concurrently_schedulable_task_count': 'int', +'group_identifier': 'str', +'identifier': 'str', +'instance_identifier': 'str', +'name': 'str', +'position': 'Position', +'remote_group_id': 'str', +'scheduled_state': 'str', +'target_id': 'str', +'use_compression': 'bool' } attribute_map = { - 'identifier': 'identifier', - 'instance_identifier': 'instanceIdentifier', - 'name': 'name', - 'comments': 'comments', - 'position': 'position', - 'remote_group_id': 'remoteGroupId', - 'concurrently_schedulable_task_count': 'concurrentlySchedulableTaskCount', - 'use_compression': 'useCompression', 'batch_size': 'batchSize', - 'component_type': 'componentType', - 'target_id': 'targetId', - 'scheduled_state': 'scheduledState', - 'group_identifier': 'groupIdentifier' - } - - def __init__(self, identifier=None, instance_identifier=None, name=None, comments=None, position=None, remote_group_id=None, concurrently_schedulable_task_count=None, use_compression=None, batch_size=None, component_type=None, target_id=None, scheduled_state=None, group_identifier=None): +'comments': 'comments', +'component_type': 'componentType', +'concurrently_schedulable_task_count': 'concurrentlySchedulableTaskCount', +'group_identifier': 'groupIdentifier', +'identifier': 'identifier', +'instance_identifier': 'instanceIdentifier', +'name': 'name', +'position': 'position', +'remote_group_id': 'remoteGroupId', +'scheduled_state': 'scheduledState', +'target_id': 'targetId', +'use_compression': 'useCompression' } + + def __init__(self, batch_size=None, comments=None, component_type=None, concurrently_schedulable_task_count=None, group_identifier=None, identifier=None, instance_identifier=None, name=None, position=None, remote_group_id=None, scheduled_state=None, target_id=None, use_compression=None): """ VersionedRemoteGroupPort - a model defined in Swagger """ + self._batch_size = None + self._comments = None + self._component_type = None + self._concurrently_schedulable_task_count = None + self._group_identifier = None self._identifier = None self._instance_identifier = None self._name = None - self._comments = None self._position = None self._remote_group_id = None - self._concurrently_schedulable_task_count = None - self._use_compression = None - self._batch_size = None - self._component_type = None - self._target_id = None self._scheduled_state = None - self._group_identifier = None + self._target_id = None + self._use_compression = None + if batch_size is not None: + self.batch_size = batch_size + if comments is not None: + self.comments = comments + if component_type is not None: + self.component_type = component_type + if concurrently_schedulable_task_count is not None: + self.concurrently_schedulable_task_count = concurrently_schedulable_task_count + if group_identifier is not None: + self.group_identifier = group_identifier if identifier is not None: self.identifier = identifier if instance_identifier is not None: self.instance_identifier = instance_identifier if name is not None: self.name = name - if comments is not None: - self.comments = comments if position is not None: self.position = position if remote_group_id is not None: self.remote_group_id = remote_group_id - if concurrently_schedulable_task_count is not None: - self.concurrently_schedulable_task_count = concurrently_schedulable_task_count - if use_compression is not None: - self.use_compression = use_compression - if batch_size is not None: - self.batch_size = batch_size - if component_type is not None: - self.component_type = component_type - if target_id is not None: - self.target_id = target_id if scheduled_state is not None: self.scheduled_state = scheduled_state - if group_identifier is not None: - self.group_identifier = group_identifier + if target_id is not None: + self.target_id = target_id + if use_compression is not None: + self.use_compression = use_compression + + @property + def batch_size(self): + """ + Gets the batch_size of this VersionedRemoteGroupPort. + + :return: The batch_size of this VersionedRemoteGroupPort. + :rtype: BatchSize + """ + return self._batch_size + + @batch_size.setter + def batch_size(self, batch_size): + """ + Sets the batch_size of this VersionedRemoteGroupPort. + + :param batch_size: The batch_size of this VersionedRemoteGroupPort. + :type: BatchSize + """ + + self._batch_size = batch_size + + @property + def comments(self): + """ + Gets the comments of this VersionedRemoteGroupPort. + The user-supplied comments for the component + + :return: The comments of this VersionedRemoteGroupPort. + :rtype: str + """ + return self._comments + + @comments.setter + def comments(self, comments): + """ + Sets the comments of this VersionedRemoteGroupPort. + The user-supplied comments for the component + + :param comments: The comments of this VersionedRemoteGroupPort. + :type: str + """ + + self._comments = comments + + @property + def component_type(self): + """ + Gets the component_type of this VersionedRemoteGroupPort. + + :return: The component_type of this VersionedRemoteGroupPort. + :rtype: str + """ + return self._component_type + + @component_type.setter + def component_type(self, component_type): + """ + Sets the component_type of this VersionedRemoteGroupPort. + + :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", ] + 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 + + @property + def concurrently_schedulable_task_count(self): + """ + Gets the concurrently_schedulable_task_count of this VersionedRemoteGroupPort. + The number of task that may transmit flowfiles to the target port concurrently. + + :return: The concurrently_schedulable_task_count of this VersionedRemoteGroupPort. + :rtype: int + """ + return self._concurrently_schedulable_task_count + + @concurrently_schedulable_task_count.setter + def concurrently_schedulable_task_count(self, concurrently_schedulable_task_count): + """ + Sets the concurrently_schedulable_task_count of this VersionedRemoteGroupPort. + The number of task that may transmit flowfiles to the target port concurrently. + + :param concurrently_schedulable_task_count: The concurrently_schedulable_task_count of this VersionedRemoteGroupPort. + :type: int + """ + + self._concurrently_schedulable_task_count = concurrently_schedulable_task_count + + @property + def group_identifier(self): + """ + Gets the group_identifier of this VersionedRemoteGroupPort. + The ID of the Process Group that this component belongs to + + :return: The group_identifier of this VersionedRemoteGroupPort. + :rtype: str + """ + return self._group_identifier + + @group_identifier.setter + def group_identifier(self, group_identifier): + """ + Sets the group_identifier of this VersionedRemoteGroupPort. + The ID of the Process Group that this component belongs to + + :param group_identifier: The group_identifier of this VersionedRemoteGroupPort. + :type: str + """ + + self._group_identifier = group_identifier @property def identifier(self): @@ -174,34 +288,10 @@ def name(self, name): self._name = name - @property - def comments(self): - """ - Gets the comments of this VersionedRemoteGroupPort. - The user-supplied comments for the component - - :return: The comments of this VersionedRemoteGroupPort. - :rtype: str - """ - return self._comments - - @comments.setter - def comments(self, comments): - """ - Sets the comments of this VersionedRemoteGroupPort. - The user-supplied comments for the component - - :param comments: The comments of this VersionedRemoteGroupPort. - :type: str - """ - - self._comments = comments - @property def position(self): """ Gets the position of this VersionedRemoteGroupPort. - The component's position on the graph :return: The position of this VersionedRemoteGroupPort. :rtype: Position @@ -212,7 +302,6 @@ def position(self): def position(self, position): """ Sets the position of this VersionedRemoteGroupPort. - The component's position on the graph :param position: The position of this VersionedRemoteGroupPort. :type: Position @@ -244,100 +333,33 @@ def remote_group_id(self, remote_group_id): self._remote_group_id = remote_group_id @property - def concurrently_schedulable_task_count(self): - """ - Gets the concurrently_schedulable_task_count of this VersionedRemoteGroupPort. - The number of task that may transmit flowfiles to the target port concurrently. - - :return: The concurrently_schedulable_task_count of this VersionedRemoteGroupPort. - :rtype: int - """ - return self._concurrently_schedulable_task_count - - @concurrently_schedulable_task_count.setter - def concurrently_schedulable_task_count(self, concurrently_schedulable_task_count): - """ - Sets the concurrently_schedulable_task_count of this VersionedRemoteGroupPort. - The number of task that may transmit flowfiles to the target port concurrently. - - :param concurrently_schedulable_task_count: The concurrently_schedulable_task_count of this VersionedRemoteGroupPort. - :type: int - """ - - self._concurrently_schedulable_task_count = concurrently_schedulable_task_count - - @property - def use_compression(self): - """ - Gets the use_compression of this VersionedRemoteGroupPort. - Whether the flowfiles are compressed when sent to the target port. - - :return: The use_compression of this VersionedRemoteGroupPort. - :rtype: bool - """ - return self._use_compression - - @use_compression.setter - def use_compression(self, use_compression): - """ - Sets the use_compression of this VersionedRemoteGroupPort. - Whether the flowfiles are compressed when sent to the target port. - - :param use_compression: The use_compression of this VersionedRemoteGroupPort. - :type: bool - """ - - self._use_compression = use_compression - - @property - def batch_size(self): - """ - Gets the batch_size of this VersionedRemoteGroupPort. - The batch settings for data transmission. - - :return: The batch_size of this VersionedRemoteGroupPort. - :rtype: BatchSize - """ - return self._batch_size - - @batch_size.setter - def batch_size(self, batch_size): - """ - Sets the batch_size of this VersionedRemoteGroupPort. - The batch settings for data transmission. - - :param batch_size: The batch_size of this VersionedRemoteGroupPort. - :type: BatchSize - """ - - self._batch_size = batch_size - - @property - def component_type(self): + def scheduled_state(self): """ - Gets the component_type of this VersionedRemoteGroupPort. + Gets the scheduled_state of this VersionedRemoteGroupPort. + The scheduled state of the component - :return: The component_type of this VersionedRemoteGroupPort. + :return: The scheduled_state of this VersionedRemoteGroupPort. :rtype: str """ - return self._component_type + return self._scheduled_state - @component_type.setter - def component_type(self, component_type): + @scheduled_state.setter + def scheduled_state(self, scheduled_state): """ - Sets the component_type of this VersionedRemoteGroupPort. + Sets the scheduled_state of this VersionedRemoteGroupPort. + The scheduled state of the component - :param component_type: The component_type of this VersionedRemoteGroupPort. + :param scheduled_state: The scheduled_state 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", "PARAMETER_CONTEXT", "PARAMETER_PROVIDER", "TEMPLATE", "FLOW_REGISTRY_CLIENT"] - if component_type not in allowed_values: + allowed_values = ["ENABLED", "DISABLED", "RUNNING", ] + if scheduled_state not in allowed_values: raise ValueError( - "Invalid value for `component_type` ({0}), must be one of {1}" - .format(component_type, allowed_values) + "Invalid value for `scheduled_state` ({0}), must be one of {1}" + .format(scheduled_state, allowed_values) ) - self._component_type = component_type + self._scheduled_state = scheduled_state @property def target_id(self): @@ -363,56 +385,27 @@ def target_id(self, target_id): self._target_id = target_id @property - def scheduled_state(self): - """ - Gets the scheduled_state of this VersionedRemoteGroupPort. - The scheduled state of the component - - :return: The scheduled_state of this VersionedRemoteGroupPort. - :rtype: str - """ - return self._scheduled_state - - @scheduled_state.setter - def scheduled_state(self, scheduled_state): - """ - Sets the scheduled_state of this VersionedRemoteGroupPort. - The scheduled state of the component - - :param scheduled_state: The scheduled_state of this VersionedRemoteGroupPort. - :type: str - """ - allowed_values = ["ENABLED", "DISABLED", "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 - - @property - def group_identifier(self): + def use_compression(self): """ - Gets the group_identifier of this VersionedRemoteGroupPort. - The ID of the Process Group that this component belongs to + Gets the use_compression of this VersionedRemoteGroupPort. + Whether the flowfiles are compressed when sent to the target port. - :return: The group_identifier of this VersionedRemoteGroupPort. - :rtype: str + :return: The use_compression of this VersionedRemoteGroupPort. + :rtype: bool """ - return self._group_identifier + return self._use_compression - @group_identifier.setter - def group_identifier(self, group_identifier): + @use_compression.setter + def use_compression(self, use_compression): """ - Sets the group_identifier of this VersionedRemoteGroupPort. - The ID of the Process Group that this component belongs to + Sets the use_compression of this VersionedRemoteGroupPort. + Whether the flowfiles are compressed when sent to the target port. - :param group_identifier: The group_identifier of this VersionedRemoteGroupPort. - :type: str + :param use_compression: The use_compression of this VersionedRemoteGroupPort. + :type: bool """ - self._group_identifier = group_identifier + self._use_compression = use_compression def to_dict(self): """ diff --git a/nipyapi/nifi/models/versioned_remote_process_group.py b/nipyapi/nifi/models/versioned_remote_process_group.py index 7b70480a..b9ef3379 100644 --- a/nipyapi/nifi/models/versioned_remote_process_group.py +++ b/nipyapi/nifi/models/versioned_remote_process_group.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,371 +27,360 @@ class VersionedRemoteProcessGroup(object): and the value is json key in definition. """ swagger_types = { - 'identifier': 'str', - 'instance_identifier': 'str', - 'name': 'str', 'comments': 'str', - 'position': 'Position', - 'target_uri': 'str', - 'target_uris': 'str', - 'communications_timeout': 'str', - 'yield_duration': 'str', - 'transport_protocol': 'str', - 'local_network_interface': 'str', - 'proxy_host': 'str', - 'proxy_port': 'int', - 'proxy_user': 'str', - 'proxy_password': 'str', - 'input_ports': 'list[VersionedRemoteGroupPort]', - 'output_ports': 'list[VersionedRemoteGroupPort]', - 'component_type': 'str', - 'group_identifier': 'str' - } +'communications_timeout': 'str', +'component_type': 'str', +'group_identifier': 'str', +'identifier': 'str', +'input_ports': 'list[VersionedRemoteGroupPort]', +'instance_identifier': 'str', +'local_network_interface': 'str', +'name': 'str', +'output_ports': 'list[VersionedRemoteGroupPort]', +'position': 'Position', +'proxy_host': 'str', +'proxy_password': 'str', +'proxy_port': 'int', +'proxy_user': 'str', +'target_uris': 'str', +'transport_protocol': 'str', +'yield_duration': 'str' } attribute_map = { - 'identifier': 'identifier', - 'instance_identifier': 'instanceIdentifier', - 'name': 'name', 'comments': 'comments', - 'position': 'position', - 'target_uri': 'targetUri', - 'target_uris': 'targetUris', - 'communications_timeout': 'communicationsTimeout', - 'yield_duration': 'yieldDuration', - 'transport_protocol': 'transportProtocol', - 'local_network_interface': 'localNetworkInterface', - 'proxy_host': 'proxyHost', - 'proxy_port': 'proxyPort', - 'proxy_user': 'proxyUser', - 'proxy_password': 'proxyPassword', - 'input_ports': 'inputPorts', - 'output_ports': 'outputPorts', - 'component_type': 'componentType', - 'group_identifier': 'groupIdentifier' - } - - def __init__(self, identifier=None, instance_identifier=None, name=None, comments=None, position=None, target_uri=None, target_uris=None, communications_timeout=None, yield_duration=None, transport_protocol=None, local_network_interface=None, proxy_host=None, proxy_port=None, proxy_user=None, proxy_password=None, input_ports=None, output_ports=None, component_type=None, group_identifier=None): +'communications_timeout': 'communicationsTimeout', +'component_type': 'componentType', +'group_identifier': 'groupIdentifier', +'identifier': 'identifier', +'input_ports': 'inputPorts', +'instance_identifier': 'instanceIdentifier', +'local_network_interface': 'localNetworkInterface', +'name': 'name', +'output_ports': 'outputPorts', +'position': 'position', +'proxy_host': 'proxyHost', +'proxy_password': 'proxyPassword', +'proxy_port': 'proxyPort', +'proxy_user': 'proxyUser', +'target_uris': 'targetUris', +'transport_protocol': 'transportProtocol', +'yield_duration': 'yieldDuration' } + + def __init__(self, comments=None, communications_timeout=None, component_type=None, group_identifier=None, identifier=None, input_ports=None, instance_identifier=None, local_network_interface=None, name=None, output_ports=None, position=None, proxy_host=None, proxy_password=None, proxy_port=None, proxy_user=None, target_uris=None, transport_protocol=None, yield_duration=None): """ VersionedRemoteProcessGroup - a model defined in Swagger """ + self._comments = None + self._communications_timeout = None + self._component_type = None + self._group_identifier = None self._identifier = None + self._input_ports = None self._instance_identifier = None + self._local_network_interface = None self._name = None - self._comments = None + self._output_ports = None self._position = None - self._target_uri = None - self._target_uris = None - self._communications_timeout = None - self._yield_duration = None - self._transport_protocol = None - self._local_network_interface = None self._proxy_host = None + self._proxy_password = None self._proxy_port = None self._proxy_user = None - self._proxy_password = None - self._input_ports = None - self._output_ports = None - self._component_type = None - self._group_identifier = None + self._target_uris = None + self._transport_protocol = None + self._yield_duration = None + if comments is not None: + self.comments = comments + if communications_timeout is not None: + self.communications_timeout = communications_timeout + if component_type is not None: + self.component_type = component_type + if group_identifier is not None: + self.group_identifier = group_identifier if identifier is not None: self.identifier = identifier + if input_ports is not None: + self.input_ports = input_ports if instance_identifier is not None: self.instance_identifier = instance_identifier + if local_network_interface is not None: + self.local_network_interface = local_network_interface if name is not None: self.name = name - if comments is not None: - self.comments = comments + if output_ports is not None: + self.output_ports = output_ports if position is not None: self.position = position - if target_uri is not None: - self.target_uri = target_uri - if target_uris is not None: - self.target_uris = target_uris - if communications_timeout is not None: - self.communications_timeout = communications_timeout - if yield_duration is not None: - self.yield_duration = yield_duration - if transport_protocol is not None: - self.transport_protocol = transport_protocol - if local_network_interface is not None: - self.local_network_interface = local_network_interface if proxy_host is not None: self.proxy_host = proxy_host + if proxy_password is not None: + self.proxy_password = proxy_password if proxy_port is not None: self.proxy_port = proxy_port if proxy_user is not None: self.proxy_user = proxy_user - if proxy_password is not None: - self.proxy_password = proxy_password - if input_ports is not None: - self.input_ports = input_ports - if output_ports is not None: - self.output_ports = output_ports - if component_type is not None: - self.component_type = component_type - if group_identifier is not None: - self.group_identifier = group_identifier + if target_uris is not None: + self.target_uris = target_uris + if transport_protocol is not None: + self.transport_protocol = transport_protocol + if yield_duration is not None: + self.yield_duration = yield_duration @property - def identifier(self): + def comments(self): """ - Gets the identifier of this VersionedRemoteProcessGroup. - The component's unique identifier + Gets the comments of this VersionedRemoteProcessGroup. + The user-supplied comments for the component - :return: The identifier of this VersionedRemoteProcessGroup. + :return: The comments of this VersionedRemoteProcessGroup. :rtype: str """ - return self._identifier + return self._comments - @identifier.setter - def identifier(self, identifier): + @comments.setter + def comments(self, comments): """ - Sets the identifier of this VersionedRemoteProcessGroup. - The component's unique identifier + Sets the comments of this VersionedRemoteProcessGroup. + The user-supplied comments for the component - :param identifier: The identifier of this VersionedRemoteProcessGroup. + :param comments: The comments of this VersionedRemoteProcessGroup. :type: str """ - self._identifier = identifier + self._comments = comments @property - def instance_identifier(self): + def communications_timeout(self): """ - Gets the instance_identifier of this VersionedRemoteProcessGroup. - The instance ID of an existing component that is described by this VersionedComponent, or null if this is not mapped to an instantiated component + Gets the communications_timeout of this VersionedRemoteProcessGroup. + The time period used for the timeout when communicating with the target. - :return: The instance_identifier of this VersionedRemoteProcessGroup. + :return: The communications_timeout of this VersionedRemoteProcessGroup. :rtype: str """ - return self._instance_identifier + return self._communications_timeout - @instance_identifier.setter - def instance_identifier(self, instance_identifier): + @communications_timeout.setter + def communications_timeout(self, communications_timeout): """ - Sets the instance_identifier of this VersionedRemoteProcessGroup. - The instance ID of an existing component that is described by this VersionedComponent, or null if this is not mapped to an instantiated component + Sets the communications_timeout of this VersionedRemoteProcessGroup. + The time period used for the timeout when communicating with the target. - :param instance_identifier: The instance_identifier of this VersionedRemoteProcessGroup. + :param communications_timeout: The communications_timeout of this VersionedRemoteProcessGroup. :type: str """ - self._instance_identifier = instance_identifier + self._communications_timeout = communications_timeout @property - def name(self): + def component_type(self): """ - Gets the name of this VersionedRemoteProcessGroup. - The component's name + Gets the component_type of this VersionedRemoteProcessGroup. - :return: The name of this VersionedRemoteProcessGroup. + :return: The component_type of this VersionedRemoteProcessGroup. :rtype: str """ - return self._name + return self._component_type - @name.setter - def name(self, name): + @component_type.setter + def component_type(self, component_type): """ - Sets the name of this VersionedRemoteProcessGroup. - The component's name + Sets the component_type of this VersionedRemoteProcessGroup. - :param name: The name of this VersionedRemoteProcessGroup. + :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", ] + 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._name = name + self._component_type = component_type @property - def comments(self): + def group_identifier(self): """ - Gets the comments of this VersionedRemoteProcessGroup. - The user-supplied comments for the component + Gets the group_identifier of this VersionedRemoteProcessGroup. + The ID of the Process Group that this component belongs to - :return: The comments of this VersionedRemoteProcessGroup. + :return: The group_identifier of this VersionedRemoteProcessGroup. :rtype: str """ - return self._comments + return self._group_identifier - @comments.setter - def comments(self, comments): + @group_identifier.setter + def group_identifier(self, group_identifier): """ - Sets the comments of this VersionedRemoteProcessGroup. - The user-supplied comments for the component + Sets the group_identifier of this VersionedRemoteProcessGroup. + The ID of the Process Group that this component belongs to - :param comments: The comments of this VersionedRemoteProcessGroup. + :param group_identifier: The group_identifier of this VersionedRemoteProcessGroup. :type: str """ - self._comments = comments + self._group_identifier = group_identifier @property - def position(self): + def identifier(self): """ - Gets the position of this VersionedRemoteProcessGroup. - The component's position on the graph + Gets the identifier of this VersionedRemoteProcessGroup. + The component's unique identifier - :return: The position of this VersionedRemoteProcessGroup. - :rtype: Position + :return: The identifier of this VersionedRemoteProcessGroup. + :rtype: str """ - return self._position + return self._identifier - @position.setter - def position(self, position): + @identifier.setter + def identifier(self, identifier): """ - Sets the position of this VersionedRemoteProcessGroup. - The component's position on the graph + Sets the identifier of this VersionedRemoteProcessGroup. + The component's unique identifier - :param position: The position of this VersionedRemoteProcessGroup. - :type: Position + :param identifier: The identifier of this VersionedRemoteProcessGroup. + :type: str """ - self._position = position + self._identifier = identifier @property - def target_uri(self): + def input_ports(self): """ - Gets the target_uri of this VersionedRemoteProcessGroup. - [DEPRECATED] The target URI of the remote process group. If target uri is not set, but uris are set, then returns the first uri in the uris. If neither target uri nor uris are set, then returns null. + Gets the input_ports of this VersionedRemoteProcessGroup. + A Set of Input Ports that can be connected to, in order to send data to the remote NiFi instance - :return: The target_uri of this VersionedRemoteProcessGroup. - :rtype: str + :return: The input_ports of this VersionedRemoteProcessGroup. + :rtype: list[VersionedRemoteGroupPort] """ - return self._target_uri + return self._input_ports - @target_uri.setter - def target_uri(self, target_uri): + @input_ports.setter + def input_ports(self, input_ports): """ - Sets the target_uri of this VersionedRemoteProcessGroup. - [DEPRECATED] The target URI of the remote process group. If target uri is not set, but uris are set, then returns the first uri in the uris. If neither target uri nor uris are set, then returns null. + Sets the input_ports of this VersionedRemoteProcessGroup. + A Set of Input Ports that can be connected to, in order to send data to the remote NiFi instance - :param target_uri: The target_uri of this VersionedRemoteProcessGroup. - :type: str + :param input_ports: The input_ports of this VersionedRemoteProcessGroup. + :type: list[VersionedRemoteGroupPort] """ - self._target_uri = target_uri + self._input_ports = input_ports @property - def target_uris(self): + def instance_identifier(self): """ - Gets the target_uris of this VersionedRemoteProcessGroup. - The target URIs of the remote process group. If target uris is not set but target uri is set, then returns the single target uri. If neither target uris nor target uri is set, then returns null. + Gets the instance_identifier of this VersionedRemoteProcessGroup. + The instance ID of an existing component that is described by this VersionedComponent, or null if this is not mapped to an instantiated component - :return: The target_uris of this VersionedRemoteProcessGroup. + :return: The instance_identifier of this VersionedRemoteProcessGroup. :rtype: str """ - return self._target_uris + return self._instance_identifier - @target_uris.setter - def target_uris(self, target_uris): + @instance_identifier.setter + def instance_identifier(self, instance_identifier): """ - Sets the target_uris of this VersionedRemoteProcessGroup. - The target URIs of the remote process group. If target uris is not set but target uri is set, then returns the single target uri. If neither target uris nor target uri is set, then returns null. + Sets the instance_identifier of this VersionedRemoteProcessGroup. + The instance ID of an existing component that is described by this VersionedComponent, or null if this is not mapped to an instantiated component - :param target_uris: The target_uris of this VersionedRemoteProcessGroup. + :param instance_identifier: The instance_identifier of this VersionedRemoteProcessGroup. :type: str """ - self._target_uris = target_uris + self._instance_identifier = instance_identifier @property - def communications_timeout(self): + def local_network_interface(self): """ - Gets the communications_timeout of this VersionedRemoteProcessGroup. - The time period used for the timeout when communicating with the target. + Gets the local_network_interface of this VersionedRemoteProcessGroup. + The local network interface to send/receive data. If not specified, any local address is used. If clustered, all nodes must have an interface with this identifier. - :return: The communications_timeout of this VersionedRemoteProcessGroup. + :return: The local_network_interface of this VersionedRemoteProcessGroup. :rtype: str """ - return self._communications_timeout + return self._local_network_interface - @communications_timeout.setter - def communications_timeout(self, communications_timeout): + @local_network_interface.setter + def local_network_interface(self, local_network_interface): """ - Sets the communications_timeout of this VersionedRemoteProcessGroup. - The time period used for the timeout when communicating with the target. + Sets the local_network_interface of this VersionedRemoteProcessGroup. + The local network interface to send/receive data. If not specified, any local address is used. If clustered, all nodes must have an interface with this identifier. - :param communications_timeout: The communications_timeout of this VersionedRemoteProcessGroup. + :param local_network_interface: The local_network_interface of this VersionedRemoteProcessGroup. :type: str """ - self._communications_timeout = communications_timeout + self._local_network_interface = local_network_interface @property - def yield_duration(self): + def name(self): """ - Gets the yield_duration of this VersionedRemoteProcessGroup. - When yielding, this amount of time must elapse before the remote process group is scheduled again. + Gets the name of this VersionedRemoteProcessGroup. + The component's name - :return: The yield_duration of this VersionedRemoteProcessGroup. + :return: The name of this VersionedRemoteProcessGroup. :rtype: str """ - return self._yield_duration + return self._name - @yield_duration.setter - def yield_duration(self, yield_duration): + @name.setter + def name(self, name): """ - Sets the yield_duration of this VersionedRemoteProcessGroup. - When yielding, this amount of time must elapse before the remote process group is scheduled again. + Sets the name of this VersionedRemoteProcessGroup. + The component's name - :param yield_duration: The yield_duration of this VersionedRemoteProcessGroup. + :param name: The name of this VersionedRemoteProcessGroup. :type: str """ - self._yield_duration = yield_duration + self._name = name @property - def transport_protocol(self): + def output_ports(self): """ - Gets the transport_protocol of this VersionedRemoteProcessGroup. - The Transport Protocol that is used for Site-to-Site communications + Gets the output_ports of this VersionedRemoteProcessGroup. + A Set of Output Ports that can be connected to, in order to pull data from the remote NiFi instance - :return: The transport_protocol of this VersionedRemoteProcessGroup. - :rtype: str + :return: The output_ports of this VersionedRemoteProcessGroup. + :rtype: list[VersionedRemoteGroupPort] """ - return self._transport_protocol + return self._output_ports - @transport_protocol.setter - def transport_protocol(self, transport_protocol): + @output_ports.setter + def output_ports(self, output_ports): """ - Sets the transport_protocol of this VersionedRemoteProcessGroup. - The Transport Protocol that is used for Site-to-Site communications + Sets the output_ports of this VersionedRemoteProcessGroup. + A Set of Output Ports that can be connected to, in order to pull data from the remote NiFi instance - :param transport_protocol: The transport_protocol of this VersionedRemoteProcessGroup. - :type: str + :param output_ports: The output_ports of this VersionedRemoteProcessGroup. + :type: list[VersionedRemoteGroupPort] """ - allowed_values = ["RAW", "HTTP"] - 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 + self._output_ports = output_ports @property - def local_network_interface(self): + def position(self): """ - Gets the local_network_interface of this VersionedRemoteProcessGroup. - The local network interface to send/receive data. If not specified, any local address is used. If clustered, all nodes must have an interface with this identifier. + Gets the position of this VersionedRemoteProcessGroup. - :return: The local_network_interface of this VersionedRemoteProcessGroup. - :rtype: str + :return: The position of this VersionedRemoteProcessGroup. + :rtype: Position """ - return self._local_network_interface + return self._position - @local_network_interface.setter - def local_network_interface(self, local_network_interface): + @position.setter + def position(self, position): """ - Sets the local_network_interface of this VersionedRemoteProcessGroup. - The local network interface to send/receive data. If not specified, any local address is used. If clustered, all nodes must have an interface with this identifier. + Sets the position of this VersionedRemoteProcessGroup. - :param local_network_interface: The local_network_interface of this VersionedRemoteProcessGroup. - :type: str + :param position: The position of this VersionedRemoteProcessGroup. + :type: Position """ - self._local_network_interface = local_network_interface + self._position = position @property def proxy_host(self): @@ -415,6 +403,27 @@ def proxy_host(self, proxy_host): self._proxy_host = proxy_host + @property + def proxy_password(self): + """ + Gets the proxy_password of this VersionedRemoteProcessGroup. + + :return: The proxy_password of this VersionedRemoteProcessGroup. + :rtype: str + """ + return self._proxy_password + + @proxy_password.setter + def proxy_password(self, proxy_password): + """ + Sets the proxy_password of this VersionedRemoteProcessGroup. + + :param proxy_password: The proxy_password of this VersionedRemoteProcessGroup. + :type: str + """ + + self._proxy_password = proxy_password + @property def proxy_port(self): """ @@ -458,121 +467,79 @@ def proxy_user(self, proxy_user): self._proxy_user = proxy_user @property - def proxy_password(self): + def target_uris(self): """ - Gets the proxy_password of this VersionedRemoteProcessGroup. + Gets the target_uris of this VersionedRemoteProcessGroup. + The target URIs of the remote process group. If target uris is not set but target uri is set, then returns the single target uri. If neither target uris nor target uri is set, then returns null. - :return: The proxy_password of this VersionedRemoteProcessGroup. + :return: The target_uris of this VersionedRemoteProcessGroup. :rtype: str """ - return self._proxy_password + return self._target_uris - @proxy_password.setter - def proxy_password(self, proxy_password): + @target_uris.setter + def target_uris(self, target_uris): """ - Sets the proxy_password of this VersionedRemoteProcessGroup. + Sets the target_uris of this VersionedRemoteProcessGroup. + The target URIs of the remote process group. If target uris is not set but target uri is set, then returns the single target uri. If neither target uris nor target uri is set, then returns null. - :param proxy_password: The proxy_password of this VersionedRemoteProcessGroup. + :param target_uris: The target_uris of this VersionedRemoteProcessGroup. :type: str """ - self._proxy_password = proxy_password - - @property - def input_ports(self): - """ - Gets the input_ports of this VersionedRemoteProcessGroup. - A Set of Input Ports that can be connected to, in order to send data to the remote NiFi instance - - :return: The input_ports of this VersionedRemoteProcessGroup. - :rtype: list[VersionedRemoteGroupPort] - """ - return self._input_ports - - @input_ports.setter - def input_ports(self, input_ports): - """ - Sets the input_ports of this VersionedRemoteProcessGroup. - A Set of Input Ports that can be connected to, in order to send data to the remote NiFi instance - - :param input_ports: The input_ports of this VersionedRemoteProcessGroup. - :type: list[VersionedRemoteGroupPort] - """ - - self._input_ports = input_ports - - @property - def output_ports(self): - """ - Gets the output_ports of this VersionedRemoteProcessGroup. - A Set of Output Ports that can be connected to, in order to pull data from the remote NiFi instance - - :return: The output_ports of this VersionedRemoteProcessGroup. - :rtype: list[VersionedRemoteGroupPort] - """ - return self._output_ports - - @output_ports.setter - def output_ports(self, output_ports): - """ - Sets the output_ports of this VersionedRemoteProcessGroup. - A Set of Output Ports that can be connected to, in order to pull data from the remote NiFi instance - - :param output_ports: The output_ports of this VersionedRemoteProcessGroup. - :type: list[VersionedRemoteGroupPort] - """ - - self._output_ports = output_ports + self._target_uris = target_uris @property - def component_type(self): + def transport_protocol(self): """ - Gets the component_type of this VersionedRemoteProcessGroup. + Gets the transport_protocol of this VersionedRemoteProcessGroup. + The Transport Protocol that is used for Site-to-Site communications - :return: The component_type of this VersionedRemoteProcessGroup. + :return: The transport_protocol of this VersionedRemoteProcessGroup. :rtype: str """ - return self._component_type + return self._transport_protocol - @component_type.setter - def component_type(self, component_type): + @transport_protocol.setter + def transport_protocol(self, transport_protocol): """ - Sets the component_type of this VersionedRemoteProcessGroup. + Sets the transport_protocol of this VersionedRemoteProcessGroup. + The Transport Protocol that is used for Site-to-Site communications - :param component_type: The component_type of this VersionedRemoteProcessGroup. + :param transport_protocol: The transport_protocol 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", "PARAMETER_CONTEXT", "PARAMETER_PROVIDER", "TEMPLATE", "FLOW_REGISTRY_CLIENT"] - if component_type not in allowed_values: + allowed_values = ["RAW", "HTTP", ] + if transport_protocol not in allowed_values: raise ValueError( - "Invalid value for `component_type` ({0}), must be one of {1}" - .format(component_type, allowed_values) + "Invalid value for `transport_protocol` ({0}), must be one of {1}" + .format(transport_protocol, allowed_values) ) - self._component_type = component_type + self._transport_protocol = transport_protocol @property - def group_identifier(self): + def yield_duration(self): """ - Gets the group_identifier of this VersionedRemoteProcessGroup. - The ID of the Process Group that this component belongs to + Gets the yield_duration of this VersionedRemoteProcessGroup. + When yielding, this amount of time must elapse before the remote process group is scheduled again. - :return: The group_identifier of this VersionedRemoteProcessGroup. + :return: The yield_duration of this VersionedRemoteProcessGroup. :rtype: str """ - return self._group_identifier + return self._yield_duration - @group_identifier.setter - def group_identifier(self, group_identifier): + @yield_duration.setter + def yield_duration(self, yield_duration): """ - Sets the group_identifier of this VersionedRemoteProcessGroup. - The ID of the Process Group that this component belongs to + Sets the yield_duration of this VersionedRemoteProcessGroup. + When yielding, this amount of time must elapse before the remote process group is scheduled again. - :param group_identifier: The group_identifier of this VersionedRemoteProcessGroup. + :param yield_duration: The yield_duration of this VersionedRemoteProcessGroup. :type: str """ - self._group_identifier = group_identifier + self._yield_duration = yield_duration def to_dict(self): """ diff --git a/nipyapi/nifi/models/versioned_reporting_task.py b/nipyapi/nifi/models/versioned_reporting_task.py index c988341a..0bf36e6d 100644 --- a/nipyapi/nifi/models/versioned_reporting_task.py +++ b/nipyapi/nifi/models/versioned_reporting_task.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,92 +27,207 @@ class VersionedReportingTask(object): and the value is json key in definition. """ swagger_types = { - 'identifier': 'str', - 'instance_identifier': 'str', - 'name': 'str', - 'comments': 'str', - 'position': 'Position', - 'type': 'str', - 'bundle': 'Bundle', - 'properties': 'dict(str, str)', - 'property_descriptors': 'dict(str, VersionedPropertyDescriptor)', 'annotation_data': 'str', - 'scheduled_state': 'str', - 'scheduling_period': 'str', - 'scheduling_strategy': 'str', - 'component_type': 'str', - 'group_identifier': 'str' - } +'bundle': 'Bundle', +'comments': 'str', +'component_type': 'str', +'group_identifier': 'str', +'identifier': 'str', +'instance_identifier': 'str', +'name': 'str', +'position': 'Position', +'properties': 'dict(str, str)', +'property_descriptors': 'dict(str, VersionedPropertyDescriptor)', +'scheduled_state': 'str', +'scheduling_period': 'str', +'scheduling_strategy': 'str', +'type': 'str' } attribute_map = { - 'identifier': 'identifier', - 'instance_identifier': 'instanceIdentifier', - 'name': 'name', - 'comments': 'comments', - 'position': 'position', - 'type': 'type', - 'bundle': 'bundle', - 'properties': 'properties', - 'property_descriptors': 'propertyDescriptors', 'annotation_data': 'annotationData', - 'scheduled_state': 'scheduledState', - 'scheduling_period': 'schedulingPeriod', - 'scheduling_strategy': 'schedulingStrategy', - 'component_type': 'componentType', - 'group_identifier': 'groupIdentifier' - } - - def __init__(self, identifier=None, instance_identifier=None, name=None, comments=None, position=None, type=None, bundle=None, properties=None, property_descriptors=None, annotation_data=None, scheduled_state=None, scheduling_period=None, scheduling_strategy=None, component_type=None, group_identifier=None): +'bundle': 'bundle', +'comments': 'comments', +'component_type': 'componentType', +'group_identifier': 'groupIdentifier', +'identifier': 'identifier', +'instance_identifier': 'instanceIdentifier', +'name': 'name', +'position': 'position', +'properties': 'properties', +'property_descriptors': 'propertyDescriptors', +'scheduled_state': 'scheduledState', +'scheduling_period': 'schedulingPeriod', +'scheduling_strategy': 'schedulingStrategy', +'type': 'type' } + + def __init__(self, annotation_data=None, bundle=None, comments=None, component_type=None, group_identifier=None, identifier=None, instance_identifier=None, name=None, position=None, properties=None, property_descriptors=None, scheduled_state=None, scheduling_period=None, scheduling_strategy=None, type=None): """ VersionedReportingTask - a model defined in Swagger """ + self._annotation_data = None + self._bundle = None + self._comments = None + self._component_type = None + self._group_identifier = None self._identifier = None self._instance_identifier = None self._name = None - self._comments = None self._position = None - self._type = None - self._bundle = None self._properties = None self._property_descriptors = None - self._annotation_data = None self._scheduled_state = None self._scheduling_period = None self._scheduling_strategy = None - self._component_type = None - self._group_identifier = None + self._type = None + if annotation_data is not None: + self.annotation_data = annotation_data + if bundle is not None: + self.bundle = bundle + if comments is not None: + self.comments = comments + if component_type is not None: + self.component_type = component_type + if group_identifier is not None: + self.group_identifier = group_identifier if identifier is not None: self.identifier = identifier if instance_identifier is not None: self.instance_identifier = instance_identifier if name is not None: self.name = name - if comments is not None: - self.comments = comments if position is not None: self.position = position - if type is not None: - self.type = type - if bundle is not None: - self.bundle = bundle if properties is not None: self.properties = properties if property_descriptors is not None: self.property_descriptors = property_descriptors - if annotation_data is not None: - self.annotation_data = annotation_data if scheduled_state is not None: self.scheduled_state = scheduled_state if scheduling_period is not None: self.scheduling_period = scheduling_period if scheduling_strategy is not None: self.scheduling_strategy = scheduling_strategy - if component_type is not None: - self.component_type = component_type - if group_identifier is not None: - self.group_identifier = group_identifier + if type is not None: + self.type = type + + @property + def annotation_data(self): + """ + Gets the annotation_data of this VersionedReportingTask. + The annotation for the reporting task. This is how the custom UI relays configuration to the reporting task. + + :return: The annotation_data of this VersionedReportingTask. + :rtype: str + """ + return self._annotation_data + + @annotation_data.setter + def annotation_data(self, annotation_data): + """ + Sets the annotation_data of this VersionedReportingTask. + The annotation for the reporting task. This is how the custom UI relays configuration to the reporting task. + + :param annotation_data: The annotation_data of this VersionedReportingTask. + :type: str + """ + + self._annotation_data = annotation_data + + @property + def bundle(self): + """ + Gets the bundle of this VersionedReportingTask. + + :return: The bundle of this VersionedReportingTask. + :rtype: Bundle + """ + return self._bundle + + @bundle.setter + def bundle(self, bundle): + """ + Sets the bundle of this VersionedReportingTask. + + :param bundle: The bundle of this VersionedReportingTask. + :type: Bundle + """ + + self._bundle = bundle + + @property + def comments(self): + """ + Gets the comments of this VersionedReportingTask. + The user-supplied comments for the component + + :return: The comments of this VersionedReportingTask. + :rtype: str + """ + return self._comments + + @comments.setter + def comments(self, comments): + """ + Sets the comments of this VersionedReportingTask. + The user-supplied comments for the component + + :param comments: The comments of this VersionedReportingTask. + :type: str + """ + + self._comments = comments + + @property + def component_type(self): + """ + Gets the component_type of this VersionedReportingTask. + + :return: The component_type of this VersionedReportingTask. + :rtype: str + """ + return self._component_type + + @component_type.setter + def component_type(self, component_type): + """ + Sets the component_type of this VersionedReportingTask. + + :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", ] + 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 + + @property + def group_identifier(self): + """ + Gets the group_identifier of this VersionedReportingTask. + The ID of the Process Group that this component belongs to + + :return: The group_identifier of this VersionedReportingTask. + :rtype: str + """ + return self._group_identifier + + @group_identifier.setter + def group_identifier(self, group_identifier): + """ + Sets the group_identifier of this VersionedReportingTask. + The ID of the Process Group that this component belongs to + + :param group_identifier: The group_identifier of this VersionedReportingTask. + :type: str + """ + + self._group_identifier = group_identifier @property def identifier(self): @@ -184,34 +298,10 @@ def name(self, name): self._name = name - @property - def comments(self): - """ - Gets the comments of this VersionedReportingTask. - The user-supplied comments for the component - - :return: The comments of this VersionedReportingTask. - :rtype: str - """ - return self._comments - - @comments.setter - def comments(self, comments): - """ - Sets the comments of this VersionedReportingTask. - The user-supplied comments for the component - - :param comments: The comments of this VersionedReportingTask. - :type: str - """ - - self._comments = comments - @property def position(self): """ Gets the position of this VersionedReportingTask. - The component's position on the graph :return: The position of this VersionedReportingTask. :rtype: Position @@ -222,7 +312,6 @@ def position(self): def position(self, position): """ Sets the position of this VersionedReportingTask. - The component's position on the graph :param position: The position of this VersionedReportingTask. :type: Position @@ -230,52 +319,6 @@ def position(self, position): self._position = position - @property - def type(self): - """ - Gets the type of this VersionedReportingTask. - The type of the extension component - - :return: The type of this VersionedReportingTask. - :rtype: str - """ - return self._type - - @type.setter - def type(self, type): - """ - Sets the type of this VersionedReportingTask. - The type of the extension component - - :param type: The type of this VersionedReportingTask. - :type: str - """ - - self._type = type - - @property - def bundle(self): - """ - Gets the bundle of this VersionedReportingTask. - Information about the bundle from which the component came - - :return: The bundle of this VersionedReportingTask. - :rtype: Bundle - """ - return self._bundle - - @bundle.setter - def bundle(self, bundle): - """ - Sets the bundle of this VersionedReportingTask. - Information about the bundle from which the component came - - :param bundle: The bundle of this VersionedReportingTask. - :type: Bundle - """ - - self._bundle = bundle - @property def properties(self): """ @@ -322,29 +365,6 @@ def property_descriptors(self, property_descriptors): self._property_descriptors = property_descriptors - @property - def annotation_data(self): - """ - Gets the annotation_data of this VersionedReportingTask. - The annotation for the reporting task. This is how the custom UI relays configuration to the reporting task. - - :return: The annotation_data of this VersionedReportingTask. - :rtype: str - """ - return self._annotation_data - - @annotation_data.setter - def annotation_data(self, annotation_data): - """ - Sets the annotation_data of this VersionedReportingTask. - The annotation for the reporting task. This is how the custom UI relays configuration to the reporting task. - - :param annotation_data: The annotation_data of this VersionedReportingTask. - :type: str - """ - - self._annotation_data = annotation_data - @property def scheduled_state(self): """ @@ -365,7 +385,7 @@ def scheduled_state(self, scheduled_state): :param scheduled_state: The scheduled_state of this VersionedReportingTask. :type: str """ - allowed_values = ["ENABLED", "DISABLED", "RUNNING"] + 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}" @@ -421,54 +441,27 @@ def scheduling_strategy(self, scheduling_strategy): self._scheduling_strategy = scheduling_strategy @property - def component_type(self): - """ - Gets the component_type of this VersionedReportingTask. - - :return: The component_type of this VersionedReportingTask. - :rtype: str - """ - return self._component_type - - @component_type.setter - def component_type(self, component_type): - """ - Sets the component_type of this VersionedReportingTask. - - :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", "PARAMETER_CONTEXT", "PARAMETER_PROVIDER", "TEMPLATE", "FLOW_REGISTRY_CLIENT"] - 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 - - @property - def group_identifier(self): + def type(self): """ - Gets the group_identifier of this VersionedReportingTask. - The ID of the Process Group that this component belongs to + Gets the type of this VersionedReportingTask. + The type of the extension component - :return: The group_identifier of this VersionedReportingTask. + :return: The type of this VersionedReportingTask. :rtype: str """ - return self._group_identifier + return self._type - @group_identifier.setter - def group_identifier(self, group_identifier): + @type.setter + def type(self, type): """ - Sets the group_identifier of this VersionedReportingTask. - The ID of the Process Group that this component belongs to + Sets the type of this VersionedReportingTask. + The type of the extension component - :param group_identifier: The group_identifier of this VersionedReportingTask. + :param type: The type of this VersionedReportingTask. :type: str """ - self._group_identifier = group_identifier + self._type = type def to_dict(self): """ diff --git a/nipyapi/nifi/models/versioned_reporting_task_import_request_entity.py b/nipyapi/nifi/models/versioned_reporting_task_import_request_entity.py new file mode 100644 index 00000000..b64f3a20 --- /dev/null +++ b/nipyapi/nifi/models/versioned_reporting_task_import_request_entity.py @@ -0,0 +1,145 @@ +""" + Apache NiFi REST API + + REST API definition for Apache NiFi web services + + OpenAPI spec version: 2.5.0 + Contact: dev@nifi.apache.org + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from pprint import pformat +import re + + +class VersionedReportingTaskImportRequestEntity(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 = { + 'disconnected_node_acknowledged': 'bool', +'reporting_task_snapshot': 'VersionedReportingTaskSnapshot' } + + attribute_map = { + 'disconnected_node_acknowledged': 'disconnectedNodeAcknowledged', +'reporting_task_snapshot': 'reportingTaskSnapshot' } + + def __init__(self, disconnected_node_acknowledged=None, reporting_task_snapshot=None): + """ + VersionedReportingTaskImportRequestEntity - a model defined in Swagger + """ + + self._disconnected_node_acknowledged = None + self._reporting_task_snapshot = None + + if disconnected_node_acknowledged is not None: + self.disconnected_node_acknowledged = disconnected_node_acknowledged + if reporting_task_snapshot is not None: + self.reporting_task_snapshot = reporting_task_snapshot + + @property + def disconnected_node_acknowledged(self): + """ + Gets the disconnected_node_acknowledged of this VersionedReportingTaskImportRequestEntity. + The disconnected node acknowledged flag + + :return: The disconnected_node_acknowledged of this VersionedReportingTaskImportRequestEntity. + :rtype: bool + """ + return self._disconnected_node_acknowledged + + @disconnected_node_acknowledged.setter + def disconnected_node_acknowledged(self, disconnected_node_acknowledged): + """ + Sets the disconnected_node_acknowledged of this VersionedReportingTaskImportRequestEntity. + The disconnected node acknowledged flag + + :param disconnected_node_acknowledged: The disconnected_node_acknowledged of this VersionedReportingTaskImportRequestEntity. + :type: bool + """ + + self._disconnected_node_acknowledged = disconnected_node_acknowledged + + @property + def reporting_task_snapshot(self): + """ + Gets the reporting_task_snapshot of this VersionedReportingTaskImportRequestEntity. + + :return: The reporting_task_snapshot of this VersionedReportingTaskImportRequestEntity. + :rtype: VersionedReportingTaskSnapshot + """ + return self._reporting_task_snapshot + + @reporting_task_snapshot.setter + def reporting_task_snapshot(self, reporting_task_snapshot): + """ + Sets the reporting_task_snapshot of this VersionedReportingTaskImportRequestEntity. + + :param reporting_task_snapshot: The reporting_task_snapshot of this VersionedReportingTaskImportRequestEntity. + :type: VersionedReportingTaskSnapshot + """ + + self._reporting_task_snapshot = reporting_task_snapshot + + 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, VersionedReportingTaskImportRequestEntity): + 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_reporting_task_import_response_entity.py b/nipyapi/nifi/models/versioned_reporting_task_import_response_entity.py new file mode 100644 index 00000000..de0a3b32 --- /dev/null +++ b/nipyapi/nifi/models/versioned_reporting_task_import_response_entity.py @@ -0,0 +1,147 @@ +""" + Apache NiFi REST API + + REST API definition for Apache NiFi web services + + OpenAPI spec version: 2.5.0 + Contact: dev@nifi.apache.org + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from pprint import pformat +import re + + +class VersionedReportingTaskImportResponseEntity(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 = { + 'controller_services': 'list[ControllerServiceEntity]', +'reporting_tasks': 'list[ReportingTaskEntity]' } + + attribute_map = { + 'controller_services': 'controllerServices', +'reporting_tasks': 'reportingTasks' } + + def __init__(self, controller_services=None, reporting_tasks=None): + """ + VersionedReportingTaskImportResponseEntity - a model defined in Swagger + """ + + self._controller_services = None + self._reporting_tasks = None + + if controller_services is not None: + self.controller_services = controller_services + if reporting_tasks is not None: + self.reporting_tasks = reporting_tasks + + @property + def controller_services(self): + """ + Gets the controller_services of this VersionedReportingTaskImportResponseEntity. + The controller services created by the import + + :return: The controller_services of this VersionedReportingTaskImportResponseEntity. + :rtype: list[ControllerServiceEntity] + """ + return self._controller_services + + @controller_services.setter + def controller_services(self, controller_services): + """ + Sets the controller_services of this VersionedReportingTaskImportResponseEntity. + The controller services created by the import + + :param controller_services: The controller_services of this VersionedReportingTaskImportResponseEntity. + :type: list[ControllerServiceEntity] + """ + + self._controller_services = controller_services + + @property + def reporting_tasks(self): + """ + Gets the reporting_tasks of this VersionedReportingTaskImportResponseEntity. + The reporting tasks created by the import + + :return: The reporting_tasks of this VersionedReportingTaskImportResponseEntity. + :rtype: list[ReportingTaskEntity] + """ + return self._reporting_tasks + + @reporting_tasks.setter + def reporting_tasks(self, reporting_tasks): + """ + Sets the reporting_tasks of this VersionedReportingTaskImportResponseEntity. + The reporting tasks created by the import + + :param reporting_tasks: The reporting_tasks of this VersionedReportingTaskImportResponseEntity. + :type: list[ReportingTaskEntity] + """ + + self._reporting_tasks = reporting_tasks + + 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, VersionedReportingTaskImportResponseEntity): + 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_reporting_task_snapshot.py b/nipyapi/nifi/models/versioned_reporting_task_snapshot.py index efc2a6d3..41243d8f 100644 --- a/nipyapi/nifi/models/versioned_reporting_task_snapshot.py +++ b/nipyapi/nifi/models/versioned_reporting_task_snapshot.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,50 +27,25 @@ class VersionedReportingTaskSnapshot(object): and the value is json key in definition. """ swagger_types = { - 'reporting_tasks': 'list[VersionedReportingTask]', - 'controller_services': 'list[VersionedControllerService]' - } + 'controller_services': 'list[VersionedControllerService]', +'reporting_tasks': 'list[VersionedReportingTask]' } attribute_map = { - 'reporting_tasks': 'reportingTasks', - 'controller_services': 'controllerServices' - } + 'controller_services': 'controllerServices', +'reporting_tasks': 'reportingTasks' } - def __init__(self, reporting_tasks=None, controller_services=None): + def __init__(self, controller_services=None, reporting_tasks=None): """ VersionedReportingTaskSnapshot - a model defined in Swagger """ - self._reporting_tasks = None self._controller_services = None + self._reporting_tasks = None - if reporting_tasks is not None: - self.reporting_tasks = reporting_tasks if controller_services is not None: self.controller_services = controller_services - - @property - def reporting_tasks(self): - """ - Gets the reporting_tasks of this VersionedReportingTaskSnapshot. - The reporting tasks - - :return: The reporting_tasks of this VersionedReportingTaskSnapshot. - :rtype: list[VersionedReportingTask] - """ - return self._reporting_tasks - - @reporting_tasks.setter - def reporting_tasks(self, reporting_tasks): - """ - Sets the reporting_tasks of this VersionedReportingTaskSnapshot. - The reporting tasks - - :param reporting_tasks: The reporting_tasks of this VersionedReportingTaskSnapshot. - :type: list[VersionedReportingTask] - """ - - self._reporting_tasks = reporting_tasks + if reporting_tasks is not None: + self.reporting_tasks = reporting_tasks @property def controller_services(self): @@ -96,6 +70,29 @@ def controller_services(self, controller_services): self._controller_services = controller_services + @property + def reporting_tasks(self): + """ + Gets the reporting_tasks of this VersionedReportingTaskSnapshot. + The reporting tasks + + :return: The reporting_tasks of this VersionedReportingTaskSnapshot. + :rtype: list[VersionedReportingTask] + """ + return self._reporting_tasks + + @reporting_tasks.setter + def reporting_tasks(self, reporting_tasks): + """ + Sets the reporting_tasks of this VersionedReportingTaskSnapshot. + The reporting tasks + + :param reporting_tasks: The reporting_tasks of this VersionedReportingTaskSnapshot. + :type: list[VersionedReportingTask] + """ + + self._reporting_tasks = reporting_tasks + def to_dict(self): """ Returns the model properties as a dict diff --git a/nipyapi/nifi/models/versioned_resource_definition.py b/nipyapi/nifi/models/versioned_resource_definition.py index 19d33184..7b0fee7f 100644 --- a/nipyapi/nifi/models/versioned_resource_definition.py +++ b/nipyapi/nifi/models/versioned_resource_definition.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -29,13 +28,11 @@ class VersionedResourceDefinition(object): """ swagger_types = { 'cardinality': 'str', - 'resource_types': 'list[str]' - } +'resource_types': 'list[str]' } attribute_map = { 'cardinality': 'cardinality', - 'resource_types': 'resourceTypes' - } +'resource_types': 'resourceTypes' } def __init__(self, cardinality=None, resource_types=None): """ @@ -70,7 +67,7 @@ def cardinality(self, cardinality): :param cardinality: The cardinality of this VersionedResourceDefinition. :type: str """ - allowed_values = ["SINGLE", "MULTIPLE"] + allowed_values = ["SINGLE", "MULTIPLE", ] if cardinality not in allowed_values: raise ValueError( "Invalid value for `cardinality` ({0}), must be one of {1}" @@ -99,7 +96,7 @@ def resource_types(self, resource_types): :param resource_types: The resource_types of this VersionedResourceDefinition. :type: list[str] """ - allowed_values = ["FILE", "DIRECTORY", "TEXT", "URL"] + 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}]" diff --git a/nipyapi/nifi/rest.py b/nipyapi/nifi/rest.py index 32d4ce3f..bb9426e4 100644 --- a/nipyapi/nifi/rest.py +++ b/nipyapi/nifi/rest.py @@ -1,14 +1,13 @@ """ - NiFi Rest API + Apache NiFi REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - import io import json import ssl @@ -65,7 +64,7 @@ def __init__(self, pools_size=4, maxsize=4): cert_reqs = ssl.CERT_REQUIRED if config.verify_ssl else ssl.CERT_NONE # ca_certs - ca_certs = (config.ssl_ca_cert if config.ssl_ca_cert + ca_certs = (config.ssl_ca_cert if config.ssl_ca_cert else certifi.where()) # cert_file @@ -83,42 +82,30 @@ def __init__(self, pools_size=4, maxsize=4): # proxy proxy = config.proxy - # https pool manager + # Common pool manager parameters + pool_kwargs = { + 'num_pools': pools_size, + 'maxsize': maxsize, + 'cert_reqs': cert_reqs, + 'ca_certs': ca_certs, + 'cert_file': cert_file, + 'key_file': key_file, + 'key_password': key_password, + 'ssl_context': ssl_context, + } + + # Only override hostname checking when user explicitly disables it + # Default urllib3 behavior (secure hostname checking) is used otherwise + if config.disable_host_check is True: + pool_kwargs['assert_hostname'] = False + + # Create appropriate pool manager based on proxy configuration if proxy and "socks" not in str(proxy): - self.pool_manager = urllib3.ProxyManager( - num_pools=pools_size, - maxsize=maxsize, - cert_reqs=cert_reqs, - ca_certs=ca_certs, - cert_file=cert_file, - key_file=key_file, - key_password=key_password, - ssl_context=ssl_context, - proxy_url=proxy - ) + self.pool_manager = urllib3.ProxyManager(proxy_url=proxy, **pool_kwargs) elif proxy and "socks" in str(proxy): - self.pool_manager = urllib3.contrib.socks.SOCKSProxyManager( - num_pools=pools_size, - maxsize=maxsize, - cert_reqs=cert_reqs, - ca_certs=ca_certs, - cert_file=cert_file, - key_file=key_file, - key_password=key_password, - ssl_context=ssl_context, - proxy_url=proxy - ) + self.pool_manager = urllib3.contrib.socks.SOCKSProxyManager(proxy_url=proxy, **pool_kwargs) else: - self.pool_manager = urllib3.PoolManager( - num_pools=pools_size, - maxsize=maxsize, - cert_reqs=cert_reqs, - ca_certs=ca_certs, - cert_file=cert_file, - key_file=key_file, - key_password=key_password, - ssl_context=ssl_context - ) + self.pool_manager = urllib3.PoolManager(**pool_kwargs) def request(self, method, url, query_params=None, headers=None, @@ -300,7 +287,7 @@ def __init__(self, status=None, reason=None, http_resp=None): self.status = http_resp.status self.reason = http_resp.reason self.body = http_resp.data - self.headers = (http_resp.headers if hasattr(http_resp, 'headers') + self.headers = (http_resp.headers if hasattr(http_resp, 'headers') else http_resp.getheaders()) else: self.status = status diff --git a/nipyapi/parameters.py b/nipyapi/parameters.py index 4d47989d..28dbd68b 100644 --- a/nipyapi/parameters.py +++ b/nipyapi/parameters.py @@ -3,20 +3,24 @@ """ import logging + import nipyapi -from nipyapi.utils import exception_handler, enforce_min_ver -from nipyapi.nifi import ParameterContextEntity, ParameterDTO, \ - ParameterEntity, ParameterContextDTO +from nipyapi.nifi import ParameterContextDTO, ParameterContextEntity, ParameterDTO, ParameterEntity +from nipyapi.utils import enforce_min_ver, exception_handler log = logging.getLogger(__name__) __all__ = [ - "list_all_parameter_contexts", "create_parameter_context", - "delete_parameter_context", "get_parameter_context", - "update_parameter_context", "prepare_parameter", - "delete_parameter_from_context", "upsert_parameter_to_context", + "list_all_parameter_contexts", + "create_parameter_context", + "delete_parameter_context", + "get_parameter_context", + "update_parameter_context", + "prepare_parameter", + "delete_parameter_from_context", + "upsert_parameter_to_context", "assign_context_to_process_group", - "remove_context_from_process_group" + "remove_context_from_process_group", ] @@ -27,13 +31,13 @@ def list_all_parameter_contexts(): Returns: list(ParameterContextEntity) """ - enforce_min_ver('1.10.0') + enforce_min_ver("1.10.0") handle = nipyapi.nifi.FlowApi() return handle.get_parameter_contexts().parameter_contexts @exception_handler(404, None) -def get_parameter_context(identifier, identifier_type='name', greedy=True): +def get_parameter_context(identifier, identifier_type="name", greedy=True): """ Gets one or more Parameter Contexts matching a given identifier @@ -47,22 +51,19 @@ def get_parameter_context(identifier, identifier_type='name', greedy=True): list(Objects) for multiple matches """ - enforce_min_ver('1.10.0') + enforce_min_ver("1.10.0") assert isinstance(identifier, str) - assert identifier_type in ['name', 'id'] - if identifier_type == 'id': + assert identifier_type in ["name", "id"] + if identifier_type == "id": handle = nipyapi.nifi.ParameterContextsApi() out = handle.get_parameter_context(identifier) else: obj = list_all_parameter_contexts() - out = nipyapi.utils.filter_obj( - obj, identifier, identifier_type, greedy=greedy - ) + out = nipyapi.utils.filter_obj(obj, identifier, identifier_type, greedy=greedy) return out -def create_parameter_context(name, description=None, parameters=None, - inherited_contexts=None): +def create_parameter_context(name, description=None, parameters=None, inherited_contexts=None): """ Create a new Parameter Context with optional description and initial Parameters @@ -75,10 +76,10 @@ def create_parameter_context(name, description=None, parameters=None, inherited Parameter Contexts Returns: - (ParameterContextEntity) The New Parameter Context + :class:`~nipyapi.nifi.models.ParameterContextEntity`: The New Parameter Context """ - enforce_min_ver('1.10.0') + enforce_min_ver("1.10.0") assert isinstance(name, str) assert description is None or isinstance(description, str) handle = nipyapi.nifi.ParameterContextsApi() @@ -91,9 +92,9 @@ def create_parameter_context(name, description=None, parameters=None, description=description, parameters=parameters if parameters else [], # list() per NiFi Jira 7995 - inherited_parameter_contexts=inherited + inherited_parameter_contexts=inherited, # requires empty list per NiFi Jira 9470 - ) + ), ) ) return out @@ -109,39 +110,41 @@ def update_parameter_context(context): refresh (bool): Whether to refresh the object before Updating Returns: - (ParameterContextEntity) The updated Parameter Context + :class:`~nipyapi.nifi.models.ParameterContextEntity`: The updated Parameter Context """ - enforce_min_ver('1.10.0') + 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)\ + return ( + nipyapi.nifi.ParameterContextsApi() + .get_parameter_context_update(context_id, request_id) .request.complete + ) if not isinstance(context, ParameterContextEntity): - raise ValueError("Supplied Parameter Context update should " - "be an instance of nipyapi.nifi.ParameterContextDTO") + raise ValueError( + "Supplied Parameter Context update should " + "be an instance of nipyapi.nifi.ParameterContextDTO" + ) handle = nipyapi.nifi.ParameterContextsApi() - target = get_parameter_context(context.id, identifier_type='id') + target = get_parameter_context(context.id, identifier_type="id") update_request = handle.submit_parameter_context_update( context_id=target.id, body=ParameterContextEntity( - id=target.id, - revision=target.revision, - component=context.component - - ) + id=target.id, revision=target.revision, component=context.component + ), ) nipyapi.utils.wait_to_complete( - _update_complete, target.id, update_request.request.request_id, - nipyapi_delay=1, nipyapi_max_wait=10 + _update_complete, + target.id, + update_request.request.request_id, + nipyapi_delay=1, + nipyapi_max_wait=10, ) _ = handle.delete_update_request( - context_id=target.id, - request_id=update_request.request.request_id + context_id=target.id, request_id=update_request.request.request_id ) - return get_parameter_context(context.id, identifier_type='id') + return get_parameter_context(context.id, identifier_type="id") def delete_parameter_context(context, refresh=True): @@ -153,17 +156,14 @@ def delete_parameter_context(context, refresh=True): refresh (bool): Whether to refresh the Context before Deletion Returns: - (ParameterContextEntity) The removed Parameter Context + :class:`~nipyapi.nifi.models.ParameterContextEntity`: The removed Parameter Context """ - enforce_min_ver('1.10.0') + enforce_min_ver("1.10.0") assert isinstance(context, nipyapi.nifi.ParameterContextEntity) handle = nipyapi.nifi.ParameterContextsApi() if refresh: context = handle.get_parameter_context(context.id) - return handle.delete_parameter_context( - id=context.id, - version=context.revision.version - ) + return handle.delete_parameter_context(id=context.id, version=context.revision.version) def prepare_parameter(name, value, description=None, sensitive=False): @@ -177,17 +177,12 @@ def prepare_parameter(name, value, description=None, sensitive=False): sensitive (bool): Whether to mark the Parameter Value as sensitive Returns: - (ParameterEntity) The ParameterEntity ready for use + :class:`~nipyapi.nifi.models.ParameterEntity`: The ParameterEntity ready for use """ - enforce_min_ver('1.10.0') + enforce_min_ver("1.10.0") assert all(x is None or isinstance(x, str) for x in [name, description]) out = ParameterEntity( - parameter=ParameterDTO( - name=name, - value=value, - description=description, - sensitive=sensitive - ) + parameter=ParameterDTO(name=name, value=value, description=description, sensitive=sensitive) ) return out @@ -200,19 +195,11 @@ def delete_parameter_from_context(context, parameter_name): parameter_name (str): The Parameter to delete Returns: - (ParameterContextEntity) The updated Parameter Context + :class:`~nipyapi.nifi.models.ParameterContextEntity`: The updated Parameter Context """ - enforce_min_ver('1.10.0') - context.component.parameters = [ - ParameterEntity( - parameter=ParameterDTO( - name=parameter_name - ) - ) - ] - return update_parameter_context( - context=context - ) + enforce_min_ver("1.10.0") + context.component.parameters = [ParameterEntity(parameter=ParameterDTO(name=parameter_name))] + return update_parameter_context(context=context) def upsert_parameter_to_context(context, parameter): @@ -224,9 +211,9 @@ def upsert_parameter_to_context(context, parameter): parameter(ParameterEntity): The ParameterEntity to insert or update Returns: - (ParameterContextEntity) The updated Parameter Context + :class:`~nipyapi.nifi.models.ParameterContextEntity`: The updated Parameter Context """ - enforce_min_ver('1.10.0') + enforce_min_ver("1.10.0") context.component.parameters = [parameter] return update_parameter_context(context=context) @@ -242,7 +229,7 @@ def assign_context_to_process_group(pg, context_id, cascade=False): cascade (bool): Cascade Parameter Context down to child Process Groups? Returns: - (ProcessGroupEntity) The updated Process Group + :class:`~nipyapi.nifi.models.ProcessGroupEntity`: The updated Process Group """ assert isinstance(context_id, str) if cascade: @@ -250,20 +237,10 @@ def assign_context_to_process_group(pg, context_id, cascade=False): child_pgs = nipyapi.canvas.list_all_process_groups(pg_id=pg.id) for child_pg in child_pgs: nipyapi.canvas.update_process_group( - pg=child_pg, - update={ - 'parameter_context': { - 'id': context_id - } - } + pg=child_pg, update={"parameter_context": {"id": context_id}} ) return nipyapi.canvas.update_process_group( - pg=pg, - update={ - 'parameter_context': { - 'id': context_id - } - } + pg=pg, update={"parameter_context": {"id": context_id}} ) @@ -275,13 +252,6 @@ def remove_context_from_process_group(pg): pg (ProcessGroupEntity): The Process Group to target Returns: - (ProcessGroupEntity) The updated Process Group + :class:`~nipyapi.nifi.models.ProcessGroupEntity`: The updated Process Group """ - return nipyapi.canvas.update_process_group( - pg=pg, - update={ - 'parameter_context': { - 'id': None - } - } - ) + return nipyapi.canvas.update_process_group(pg=pg, update={"parameter_context": {"id": None}}) diff --git a/nipyapi/profiles.py b/nipyapi/profiles.py new file mode 100644 index 00000000..45a8d62b --- /dev/null +++ b/nipyapi/profiles.py @@ -0,0 +1,534 @@ +""" +Simple profile management for NiPyAPI development configurations. +""" + +import logging + +from nipyapi import config as nipy_config +from nipyapi import security, utils + +log = logging.getLogger(__name__) + +# Default profile configuration - all possible keys with null defaults (supports sparse profiles) +DEFAULT_PROFILE_CONFIG = { + "nifi_url": None, + "registry_url": None, + "registry_internal_url": None, + "nifi_user": None, + "nifi_pass": None, + "registry_user": None, + "registry_pass": None, + "ca_path": None, + "client_cert": None, + "client_key": None, + "client_key_password": None, + "nifi_ca_path": None, + "registry_ca_path": None, + "nifi_client_cert": None, + "registry_client_cert": None, + "nifi_client_key": None, + "registry_client_key": None, + "nifi_client_key_password": None, + "registry_client_key_password": None, + "nifi_proxy_identity": None, + "nifi_verify_ssl": None, + "registry_verify_ssl": None, + "nifi_disable_host_check": None, + "registry_disable_host_check": None, + "suppress_ssl_warnings": None, + "oidc_token_endpoint": None, + "oidc_client_id": None, + "oidc_client_secret": None, +} + +# Environment variable mappings - maps config keys to their env var names +ENV_VAR_MAPPINGS = [ + # URLs and credentials + ("nifi_url", "NIFI_API_ENDPOINT"), + ("registry_url", "REGISTRY_API_ENDPOINT"), + ("nifi_user", "NIFI_USERNAME"), + ("nifi_pass", "NIFI_PASSWORD"), + ("registry_user", "REGISTRY_USERNAME"), + ("registry_pass", "REGISTRY_PASSWORD"), + # Basic certificate paths and security config + ("ca_path", "TLS_CA_CERT_PATH"), + ("client_cert", "MTLS_CLIENT_CERT"), + ("client_key", "MTLS_CLIENT_KEY"), + ("client_key_password", "MTLS_CLIENT_KEY_PASSWORD"), + ("nifi_proxy_identity", "NIFI_PROXY_IDENTITY"), + # SSL verification control + ("nifi_verify_ssl", "NIFI_VERIFY_SSL"), + ("registry_verify_ssl", "REGISTRY_VERIFY_SSL"), + # SSL hostname checking control + ("nifi_disable_host_check", "NIFI_DISABLE_HOST_CHECK"), + ("registry_disable_host_check", "REGISTRY_DISABLE_HOST_CHECK"), + # SSL warning suppression + ("suppress_ssl_warnings", "NIPYAPI_SUPPRESS_SSL_WARNINGS"), + # OIDC configuration + ("oidc_token_endpoint", "OIDC_TOKEN_ENDPOINT"), + ("oidc_client_id", "OIDC_CLIENT_ID"), + ("oidc_client_secret", "OIDC_CLIENT_SECRET"), + # Per-service certificate overrides (complex PKI environments) + ("nifi_ca_path", "NIFI_CA_CERT_PATH"), + ("registry_ca_path", "REGISTRY_CA_CERT_PATH"), + ("nifi_client_cert", "NIFI_CLIENT_CERT"), + ("registry_client_cert", "REGISTRY_CLIENT_CERT"), + ("nifi_client_key", "NIFI_CLIENT_KEY"), + ("registry_client_key", "REGISTRY_CLIENT_KEY"), + ("nifi_client_key_password", "NIFI_CLIENT_KEY_PASSWORD"), + ("registry_client_key_password", "REGISTRY_CLIENT_KEY_PASSWORD"), +] + +# Certificate management configuration +CERTIFICATE_SERVICES = ["nifi", "registry"] +CERTIFICATE_TYPES = ["ca_path", "client_cert", "client_key", "client_key_password"] + +# Path resolution keys for SSL libraries (require absolute paths) +PATH_RESOLUTION_KEYS = [ + "ca_path", + "client_cert", + "client_key", + "nifi_ca_path", + "registry_ca_path", + "nifi_client_cert", + "registry_client_cert", + "nifi_client_key", + "registry_client_key", + "resolved_nifi_ca_path", + "resolved_registry_ca_path", + "resolved_nifi_client_cert", + "resolved_registry_client_cert", + "resolved_nifi_client_key", + "resolved_registry_client_key", +] + +# Authentication method definitions - data-driven approach for extensibility +NIFI_AUTH_METHODS = { + "oidc": { + "detection_keys": ["oidc_token_endpoint"], + "required_keys": [ + "oidc_token_endpoint", + "oidc_client_id", + "oidc_client_secret", + "nifi_user", + "nifi_pass", + ], + "optional_keys": [], + }, + "mtls": { + "detection_keys": ["client_cert", "client_key"], + "required_keys": ["client_cert", "client_key"], + "optional_keys": ["client_key_password"], + }, + "basic": { + "detection_keys": ["nifi_user", "nifi_pass"], + "required_keys": ["nifi_user", "nifi_pass"], + "optional_keys": [], + }, +} + +REGISTRY_AUTH_METHODS = { + "mtls": { + "detection_keys": ["client_cert", "client_key"], + "required_keys": ["client_cert", "client_key"], + "optional_keys": ["client_key_password"], + }, + "basic": { + "detection_keys": ["registry_user", "registry_pass"], + "required_keys": ["registry_user", "registry_pass"], + "optional_keys": [], + }, +} + + +def _detect_and_validate_auth(config, auth_methods, service_name): + """ + Generic authentication detection and validation. + + Detects the appropriate authentication method based on available configuration + and validates that all required parameters are present. + + Args: + config (dict): Configuration dictionary + auth_methods (dict): Dict of method definitions (e.g., NIFI_AUTH_METHODS) + service_name (str): Service name for error messages ('nifi' or 'registry') + + Returns: + tuple: (auth_method, validated_params) + + Raises: + ValueError: If no valid authentication method is detected or required parameters + are missing + """ + # Try each method in priority order (OIDC first, then mTLS, then password) + for method_name, method_def in auth_methods.items(): + # Check if all detection keys are present and non-empty + if all(config.get(key) for key in method_def["detection_keys"]): + # Validate all required keys are present + missing = [k for k in method_def["required_keys"] if not config.get(k)] + if missing: + raise ValueError(f"{service_name} {method_name} authentication requires: {missing}") + + # Collect validated parameters (required + any present optional) + params = {k: config[k] for k in method_def["required_keys"]} + for k in method_def["optional_keys"]: + if config.get(k): + params[k] = config[k] + + return method_name, params + + # No method detected + available_keys = [ + k for method in auth_methods.values() for k in method["detection_keys"] if config.get(k) + ] + raise ValueError( + f"No valid {service_name} authentication method detected. " + f"Available params: {available_keys}" + ) + + +def load_profiles_from_file(file_path=None): + """ + Load profile configurations from a YAML or JSON file. + + Supports both YAML and JSON formats since JSON is a subset of YAML syntax. + + Args: + file_path (str, optional): Path to YAML or JSON file containing profile definitions. + If None, resolves using: + 1. NIPYAPI_PROFILES_FILE environment variable + 2. nipyapi.config.default_profiles_file + + Returns: + dict: Profile configurations + """ + if file_path is None: + file_path = utils.getenv("NIPYAPI_PROFILES_FILE") or nipy_config.default_profiles_file + + file_content = utils.fs_read(file_path) + return utils.load(file_content) + + +def resolve_profile_config(profile_name, profiles_file_path=None): + # pylint: disable=too-many-branches + """ + Complete profile configuration resolution with environment overrides and absolute paths. + + Supports both simple shared certificates and complex per-service PKI configurations. + Accepts both YAML and JSON profile files. + + Args: + profile_name (str): Name of profile to resolve + profiles_file_path (str, optional): Path to profiles YAML or JSON file. + Default resolution handled by + load_profiles_from_file() + + Returns: + dict: Fully resolved configuration with all paths and overrides applied + """ + # Load profiles from file (handles default resolution) + all_profiles = load_profiles_from_file(profiles_file_path) + + if profile_name not in all_profiles: + raise ValueError( + f"Profile '{profile_name}' not found. Available: {list(all_profiles.keys())}" + ) + + # Start with defaults, then apply profile values + config = DEFAULT_PROFILE_CONFIG.copy() + config.update(all_profiles[profile_name]) + + # Apply all environment variable overrides + for config_key, env_var in ENV_VAR_MAPPINGS: + # Use boolean parsing for SSL and warning flags + if config_key in ( + "nifi_verify_ssl", + "registry_verify_ssl", + "nifi_disable_host_check", + "registry_disable_host_check", + "suppress_ssl_warnings", + ): + env_value = utils.getenv_bool(env_var) + if env_value is not None: + config[config_key] = env_value + else: + config[config_key] = utils.getenv(env_var) or config[config_key] + + # Apply smart defaults for SSL settings based on URL protocol + if config.get("nifi_url") and config.get("nifi_verify_ssl") is None: + config["nifi_verify_ssl"] = config["nifi_url"].startswith("https://") + + if config.get("registry_url") and config.get("registry_verify_ssl") is None: + config["registry_verify_ssl"] = config["registry_url"].startswith("https://") + + # Apply SSL constraints and URL-based logic with proper precedence + # Rule 1: For HTTP URLs, hostname checking is not applicable (force None) + # Rule 2: For HTTPS URLs with verify_ssl=False, hostname checking must be disabled (force True) + # Rule 3: For HTTPS URLs with verify_ssl=True, respect user config (None = secure default) + # This works around urllib3 not filtering host check settings for HTTP Schemes + + if config.get("nifi_url"): + if not config["nifi_url"].startswith("https://"): + # HTTP: hostname checking not applicable + config["nifi_disable_host_check"] = None + elif ( + config.get("nifi_verify_ssl") is False and config.get("nifi_disable_host_check") is None + ): + # HTTPS + no SSL verification: must disable hostname checking to avoid SSL errors + config["nifi_disable_host_check"] = True + # HTTPS + SSL verification: respect user setting (None = secure default) + + if config.get("registry_url"): + if not config["registry_url"].startswith("https://"): + # HTTP: hostname checking not applicable + config["registry_disable_host_check"] = None + elif ( + config.get("registry_verify_ssl") is False + and config.get("registry_disable_host_check") is None + ): + # HTTPS + no SSL verification: must disable hostname checking to avoid SSL errors + config["registry_disable_host_check"] = True + # HTTPS + SSL verification: respect user setting (None = secure default) + + # Normalize URLs by removing trailing slashes (standard REST API practice) + for url_field in ["nifi_url", "registry_url", "registry_internal_url", "oidc_token_endpoint"]: + if config.get(url_field): + config[url_field] = config[url_field].rstrip("/") + + # Resolve final certificate paths: per-service takes precedence over shared + # Generate resolved_{service}_{cert_type} = {service}_{cert_type} or {cert_type} + for service in CERTIFICATE_SERVICES: + for cert_type in CERTIFICATE_TYPES: + config[f"resolved_{service}_{cert_type}"] = ( + config[f"{service}_{cert_type}"] or config[cert_type] + ) + + # Convert relative paths to absolute using utility function + # SSL libraries generally require absolute paths for certificate files + # Check for environment variable override of root path + cert_root = utils.getenv("NIPYAPI_CERTS_ROOT_PATH") + for path_key in PATH_RESOLUTION_KEYS: + config[path_key] = utils.resolve_relative_paths(config[path_key], cert_root) + + # Add profile name for reference + config["profile"] = profile_name + + return config + + +def switch(profile_name, profiles_file=None, login=True): + # pylint: disable=too-many-branches,too-many-statements + """ + Switch to a different profile at runtime using configuration-driven authentication. + + Automatically detects authentication methods based on available configuration + parameters rather than profile names, making it flexible for custom profiles. + + Supported authentication methods: + + - OIDC: Requires oidc_token_endpoint, oidc_client_id, oidc_client_secret, + nifi_user, nifi_pass + - mTLS: Requires client_cert, client_key (+ optional client_key_password) + - Basic: Requires nifi_user/nifi_pass for NiFi, registry_user/registry_pass for Registry + + Args: + profile_name (str): Name of the profile to switch to + profiles_file (str, optional): Path to profiles file. Resolution order: + 1. Explicit profiles_file parameter + 2. NIPYAPI_PROFILES_FILE environment variable + 3. nipyapi.config.default_profiles_file + login (bool, optional): Whether to attempt authentication. Defaults to True. + If False, configures SSL/endpoints but skips login attempts. + Useful for readiness checks where you don't want to + send credentials. + + Returns: + tuple: (profile_name, metadata) where metadata varies by authentication method: + - OIDC: token_data dict containing JWT token info for UUID extraction (login=True) + - Basic: username string of the logged-in user (login=True) + - mTLS: None (no metadata extracted) + - Any method with login=False: None + + Raises: + ValueError: If profile not found or required authentication parameters are missing + + Example: + >>> import nipyapi.profiles + >>> nipyapi.profiles.switch('single-user') # Uses basic auth (nifi_user/nifi_pass) + >>> nipyapi.profiles.switch('secure-mtls') # Uses mTLS auth (client_cert/client_key) + >>> nipyapi.profiles.switch('secure-oidc') # Uses OIDC auth (oidc_* params) + >>> nipyapi.profiles.switch('my-custom') # Uses whatever auth method is configured + >>> + >>> # Custom profiles file + >>> nipyapi.profiles.switch('production', + ... profiles_file='/home/user/.nipyapi/profiles.yml') + + """ + + # 1. Resolve target profile configuration + # Default file resolution is handled by load_profiles_from_file() + config = resolve_profile_config(profile_name, profiles_file) + + log.info("Switching to profile: %s", profile_name) + + # Initialize metadata tracking for different auth methods + auth_metadata = None + + # 2. Determine what services to connect to + connect_to_nifi = bool(config.get("nifi_url")) + connect_to_registry = bool(config.get("registry_url")) + + log.debug("Service connections: NiFi=%s Registry=%s", connect_to_nifi, connect_to_registry) + + if not connect_to_nifi and not connect_to_registry: + raise ValueError( + f"Profile '{profile_name}' has no nifi_url or registry_url - nothing to connect to" + ) + + # 3. Clean teardown of existing connections (best effort) + if connect_to_nifi and connect_to_registry: + security.reset_service_connections() # Reset both services + elif connect_to_nifi: + security.reset_service_connections("nifi") # Reset only NiFi + elif connect_to_registry: + security.reset_service_connections("registry") # Reset only Registry + + # 4. Apply SSL configuration (exactly matching conftest.py pattern) + # Apply CA certificate first if provided + if config.get("ca_path"): + security.set_shared_ca_cert(config["ca_path"]) + + # Set SSL verification and hostname checking from resolved config + if connect_to_nifi: + nipy_config.nifi_config.verify_ssl = config["nifi_verify_ssl"] + nipy_config.nifi_config.disable_host_check = config["nifi_disable_host_check"] + + if connect_to_registry: + nipy_config.registry_config.verify_ssl = config["registry_verify_ssl"] + nipy_config.registry_config.disable_host_check = config["registry_disable_host_check"] + + # Apply SSL warning suppression from profile config + if config.get("suppress_ssl_warnings") is not None: + security.set_ssl_warning_suppression(config["suppress_ssl_warnings"]) + + # 5. Configuration-driven NiFi setup + if connect_to_nifi: + log.debug("Detecting NiFi authentication method...") + log.debug( + "Available auths: nifi_user=%s, nifi_pass=%s, client_cert=%s, oidc_token=%s", + bool(config.get("nifi_user")), + bool(config.get("nifi_pass")), + bool(config.get("client_cert")), + bool(config.get("oidc_token_endpoint")), + ) + + nifi_auth_method, nifi_auth_params = _detect_and_validate_auth( + config, NIFI_AUTH_METHODS, "NiFi" + ) + + log.info("Using NiFi authentication method: %s", nifi_auth_method) + log.debug("Auth params: %s", list(nifi_auth_params.keys())) + + if nifi_auth_method == "oidc": + log.debug("Configuring OIDC authentication for NiFi...") + # OIDC requires special setup + nipy_config.nifi_config.host = config["nifi_url"] + + if login: + # Always capture token data for OIDC (needed for UUID extraction) + auth_metadata = security.service_login_oidc( + service="nifi", + username=nifi_auth_params["nifi_user"], + password=nifi_auth_params["nifi_pass"], + oidc_token_endpoint=nifi_auth_params["oidc_token_endpoint"], + client_id=nifi_auth_params["oidc_client_id"], + client_secret=nifi_auth_params["oidc_client_secret"], + return_token_info=True, + ) + log.debug("OIDC authentication completed") + else: + log.debug("OIDC configuration completed (no login attempted)") + elif nifi_auth_method == "mtls": + log.debug("Configuring mTLS authentication for NiFi...") + # Apply client certificates for mTLS + nipy_config.nifi_config.cert_file = nifi_auth_params["client_cert"] + nipy_config.nifi_config.key_file = nifi_auth_params["client_key"] + # mTLS uses certificate auth, not username/password + utils.set_endpoint(config["nifi_url"], True, False) # SSL enabled, auth disabled + log.debug("mTLS authentication completed") + elif nifi_auth_method == "basic": + log.debug( + "Configuring basic authentication for NiFi with user: %s", + nifi_auth_params["nifi_user"], + ) + if login: + # Standard HTTP Basic authentication using set_endpoint's login capability + utils.set_endpoint( + endpoint_url=config["nifi_url"], + ssl=True, + login=True, + username=nifi_auth_params["nifi_user"], + password=nifi_auth_params["nifi_pass"], + ) + # For basic auth, return the logged-in username as metadata + auth_metadata = nifi_auth_params["nifi_user"] + log.debug("Basic authentication completed") + else: + # For readiness checks, just configure the host and let SSL be + # handled by ssl_ca_cert + nipy_config.nifi_config.host = config["nifi_url"] + log.debug("Basic auth configuration completed (no login attempted)") + else: + log.debug("No authentication method detected for NiFi") + + # 6. Configuration-driven Registry setup + if connect_to_registry: + log.debug("Detecting Registry authentication method...") + registry_auth_method, registry_auth_params = _detect_and_validate_auth( + config, REGISTRY_AUTH_METHODS, "Registry" + ) + + log.info("Using Registry authentication method: %s", registry_auth_method) + log.debug("Auth params: %s", list(registry_auth_params.keys())) + + if registry_auth_method == "mtls": + log.debug("Configuring mTLS authentication for Registry...") + # Apply client certificates for mTLS + nipy_config.registry_config.cert_file = registry_auth_params["client_cert"] + nipy_config.registry_config.key_file = registry_auth_params["client_key"] + # mTLS uses certificate auth, not username/password + # SSL enabled, auth disabled + utils.set_endpoint(config["registry_url"], True, False) + log.debug("Registry mTLS authentication completed") + elif registry_auth_method == "basic": + log.debug( + "Configuring basic authentication for Registry with user: %s", + registry_auth_params["registry_user"], + ) + if login: + # Basic username/password authentication for Registry using + # set_endpoint's login capability + utils.set_endpoint( + endpoint_url=config["registry_url"], + ssl=True, + login=True, + username=registry_auth_params["registry_user"], + password=registry_auth_params["registry_pass"], + ) + log.debug("Registry basic authentication completed") + else: + # For readiness checks, just configure the host and let SSL be + # handled by ssl_ca_cert + nipy_config.registry_config.host = config["registry_url"] + log.debug("Registry basic auth configuration completed (no login attempted)") + else: + log.debug("No authentication method detected for Registry") + + # Note: Bootstrap security policies are NOT handled here as they change server state. + # Bootstrap should remain in conftest.py, sandbox.py, and other setup scripts. + # This function only handles CLIENT-side connection configuration. + + log.debug("Profile switch completed successfully: %s", profile_name) + + # Always return tuple (profile_name, metadata) + return profile_name, auth_metadata diff --git a/nipyapi/registry/__init__.py b/nipyapi/registry/__init__.py index 708d1b73..c9cb7ef7 100644 --- a/nipyapi/registry/__init__.py +++ b/nipyapi/registry/__init__.py @@ -1,15 +1,12 @@ """ Apache NiFi Registry REST API - The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components. + REST API definition for Apache NiFi Registry web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - - - # import models into sdk package from .models.access_policy import AccessPolicy from .models.access_policy_summary import AccessPolicySummary @@ -24,6 +21,8 @@ from .models.bundle_version import BundleVersion from .models.bundle_version_dependency import BundleVersionDependency from .models.bundle_version_metadata import BundleVersionMetadata +from .models.bundles_bundle_type_body import BundlesBundleTypeBody +from .models.client_id_parameter import ClientIdParameter from .models.component_difference import ComponentDifference from .models.component_difference_group import ComponentDifferenceGroup from .models.connectable_component import ConnectableComponent @@ -38,7 +37,6 @@ from .models.dynamic_property import DynamicProperty from .models.dynamic_relationship import DynamicRelationship from .models.extension import Extension -from .models.extension_bundle import ExtensionBundle from .models.extension_filter_params import ExtensionFilterParams from .models.extension_metadata import ExtensionMetadata from .models.extension_metadata_container import ExtensionMetadataContainer @@ -49,11 +47,15 @@ from .models.extension_repo_version_summary import ExtensionRepoVersionSummary from .models.external_controller_service_reference import ExternalControllerServiceReference from .models.fields import Fields -from .models.jaxb_link import JaxbLink +from .models.form_data_content_disposition import FormDataContentDisposition +from .models.link import Link +from .models.long_parameter import LongParameter from .models.model_property import ModelProperty +from .models.multi_processor_use_case import MultiProcessorUseCase from .models.parameter_provider_reference import ParameterProviderReference from .models.permissions import Permissions from .models.position import Position +from .models.processor_configuration import ProcessorConfiguration from .models.provided_service_api import ProvidedServiceAPI from .models.registry_about import RegistryAbout from .models.registry_configuration import RegistryConfiguration @@ -68,8 +70,11 @@ from .models.system_resource_consideration import SystemResourceConsideration from .models.tag_count import TagCount from .models.tenant import Tenant +from .models.uri_builder import UriBuilder +from .models.use_case import UseCase from .models.user import User from .models.user_group import UserGroup +from .models.versioned_asset import VersionedAsset from .models.versioned_connection import VersionedConnection from .models.versioned_controller_service import VersionedControllerService from .models.versioned_flow import VersionedFlow @@ -88,7 +93,6 @@ from .models.versioned_remote_group_port import VersionedRemoteGroupPort from .models.versioned_remote_process_group import VersionedRemoteProcessGroup from .models.versioned_resource_definition import VersionedResourceDefinition - # import apis into sdk package from .apis.about_api import AboutApi from .apis.access_api import AccessApi @@ -103,7 +107,6 @@ from .apis.items_api import ItemsApi from .apis.policies_api import PoliciesApi from .apis.tenants_api import TenantsApi - # import ApiClient from .api_client import ApiClient diff --git a/nipyapi/registry/api_client.py b/nipyapi/registry/api_client.py index 10001e93..9b1c85ee 100644 --- a/nipyapi/registry/api_client.py +++ b/nipyapi/registry/api_client.py @@ -1,20 +1,18 @@ """ Apache NiFi Registry REST API - The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components. + REST API definition for Apache NiFi Registry web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - import os import re import json import mimetypes import tempfile -import threading from datetime import date, datetime from urllib.parse import quote @@ -91,7 +89,7 @@ def set_default_header(self, header_name, header_value): def __call_api(self, resource_path, method, path_params=None, query_params=None, header_params=None, body=None, post_params=None, files=None, - response_type=None, auth_settings=None, callback=None, + response_type=None, auth_settings=None, _return_http_data_only=None, collection_formats=None, _preload_content=True, _request_timeout=None): @@ -158,12 +156,7 @@ def __call_api(self, resource_path, method, else: return_data = None - if callback: - if _return_http_data_only: - callback(return_data) - else: - callback((return_data, response_data.status, response_data.headers)) - elif _return_http_data_only: + if _return_http_data_only: return (return_data) else: return (return_data, response_data.status, response_data.headers) @@ -255,7 +248,7 @@ def __deserialize(self, data, klass): if type(klass) == str: if klass.startswith('list['): - sub_kls = re.match('list\[(.*)\]', klass).group(1) + sub_kls = re.match(r'list\[(.*)\]', klass).group(1) if isinstance(data, dict): # ok, we got a single instance when we may have gotten a list return self.__deserialize(data, sub_kls) @@ -263,7 +256,7 @@ def __deserialize(self, data, klass): for sub_data in data] if klass.startswith('dict('): - sub_kls = re.match('dict\(([^,]*), (.*)\)', klass).group(2) + sub_kls = re.match(r'dict\(([^,]*), (.*)\)', klass).group(2) return {k: self.__deserialize(v, sub_kls) for k, v in data.items()} @@ -287,12 +280,11 @@ def __deserialize(self, data, klass): def call_api(self, resource_path, method, path_params=None, query_params=None, header_params=None, body=None, post_params=None, files=None, - response_type=None, auth_settings=None, callback=None, + response_type=None, auth_settings=None, _return_http_data_only=None, collection_formats=None, _preload_content=True, _request_timeout=None): """ Makes the HTTP request (synchronous) and return the deserialized data. - To make an async request, define a function for callback. :param resource_path: Path to method endpoint. :param method: Method to call. @@ -307,9 +299,6 @@ def call_api(self, resource_path, method, :param response: Response data type. :param files dict: key -> filename, value -> filepath, for `multipart/form-data`. - :param callback function: Callback function for asynchronous request. - If provide this parameter, - the request will be called asynchronously. :param _return_http_data_only: response data without head status code and headers :param collection_formats: dict of collection formats for path, query, header, and post parameters. @@ -324,23 +313,11 @@ def call_api(self, resource_path, method, If parameter callback is None, then the method will return the response directly. """ - if callback is None: - return self.__call_api(resource_path, method, - path_params, query_params, header_params, - body, post_params, files, - response_type, auth_settings, callback, - _return_http_data_only, collection_formats, _preload_content, _request_timeout) - else: - thread = threading.Thread(target=self.__call_api, - args=(resource_path, method, - path_params, query_params, - header_params, body, - post_params, files, - response_type, auth_settings, - callback, _return_http_data_only, - collection_formats, _preload_content, _request_timeout)) - thread.start() - return thread + return self.__call_api(resource_path, method, + path_params, query_params, header_params, + body, post_params, files, + response_type, auth_settings, + _return_http_data_only, collection_formats, _preload_content, _request_timeout) def request(self, method, url, query_params=None, headers=None, post_params=None, body=None, _preload_content=True, _request_timeout=None): diff --git a/nipyapi/registry/apis/about_api.py b/nipyapi/registry/apis/about_api.py index 74a3079e..2b3d05d6 100644 --- a/nipyapi/registry/apis/about_api.py +++ b/nipyapi/registry/apis/about_api.py @@ -1,14 +1,13 @@ """ Apache NiFi Registry REST API - The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components. + REST API definition for Apache NiFi Registry web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - import sys import os import re @@ -35,21 +34,19 @@ def __init__(self, api_client=None): def get_version(self, **kwargs): """ - Get version + Get version. + Gets the NiFi Registry version. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_version(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :return: RegistryAbout - If the method is called asynchronously, - returns the request thread. + + 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_version_with_http_info()`` method instead. + + Args: + + Returns: + :class:`~nipyapi.registry.models.RegistryAbout`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): @@ -60,25 +57,22 @@ def get_version(self, **kwargs): def get_version_with_http_info(self, **kwargs): """ - Get version + Get version. + Gets the NiFi Registry version. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_version_with_http_info(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :return: RegistryAbout - If the method is called asynchronously, - returns the request thread. + + 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_version()`` method instead. + + Args: + + Returns: + tuple: (:class:`~nipyapi.registry.models.RegistryAbout`, status_code, headers) - Response data with HTTP details. """ all_params = [] - all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -110,7 +104,7 @@ def get_version_with_http_info(self, **kwargs): select_header_accept(['application/json']) # Authentication setting - auth_settings = ['tokenAuth', 'Authorization'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/about', 'GET', path_params, @@ -121,7 +115,6 @@ def get_version_with_http_info(self, **kwargs): files=local_var_files, response_type='RegistryAbout', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), diff --git a/nipyapi/registry/apis/access_api.py b/nipyapi/registry/apis/access_api.py index b51087f7..20e9dafd 100644 --- a/nipyapi/registry/apis/access_api.py +++ b/nipyapi/registry/apis/access_api.py @@ -1,14 +1,13 @@ """ Apache NiFi Registry REST API - The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components. + REST API definition for Apache NiFi Registry web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - import sys import os import re @@ -35,21 +34,19 @@ def __init__(self, api_client=None): def create_access_token_by_trying_all_providers(self, **kwargs): """ - Create token trying all providers + Create token trying all providers. + Creates a token for accessing the REST API via auto-detected method of verifying client identity claim credentials. The token returned is formatted as a JSON Web Token (JWT). The token is base64 encoded and comprised of three parts. The header, the body, and the signature. The expiration of the token is a contained within the body. The token can be used in the Authorization header in the format 'Authorization: Bearer '. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.create_access_token_by_trying_all_providers(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :return: str - If the method is called asynchronously, - returns the request thread. + + 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_access_token_by_trying_all_providers_with_http_info()`` method instead. + + Args: + + Returns: + str: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): @@ -60,25 +57,22 @@ def create_access_token_by_trying_all_providers(self, **kwargs): def create_access_token_by_trying_all_providers_with_http_info(self, **kwargs): """ - Create token trying all providers + Create token trying all providers. + Creates a token for accessing the REST API via auto-detected method of verifying client identity claim credentials. The token returned is formatted as a JSON Web Token (JWT). The token is base64 encoded and comprised of three parts. The header, the body, and the signature. The expiration of the token is a contained within the body. The token can be used in the Authorization header in the format 'Authorization: Bearer '. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.create_access_token_by_trying_all_providers_with_http_info(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :return: str - If the method is called asynchronously, - returns the request thread. + + 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_access_token_by_trying_all_providers()`` method instead. + + Args: + + Returns: + tuple: (str, status_code, headers) - Response data with HTTP details. """ all_params = [] - all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -109,12 +103,8 @@ def create_access_token_by_trying_all_providers_with_http_info(self, **kwargs): header_params['Accept'] = self.api_client.\ select_header_accept(['text/plain']) - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['*/*']) - # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = [] return self.api_client.call_api('/access/token', 'POST', path_params, @@ -125,7 +115,6 @@ def create_access_token_by_trying_all_providers_with_http_info(self, **kwargs): files=local_var_files, response_type='str', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), @@ -133,21 +122,19 @@ def create_access_token_by_trying_all_providers_with_http_info(self, **kwargs): def create_access_token_using_basic_auth_credentials(self, **kwargs): """ - Create token using basic auth + Create token using basic auth. + Creates a token for accessing the REST API via username/password. The user credentials must be passed in standard HTTP Basic Auth format. That is: 'Authorization: Basic ', where is the base64 encoded value of ':'. The token returned is formatted as a JSON Web Token (JWT). The token is base64 encoded and comprised of three parts. The header, the body, and the signature. The expiration of the token is a contained within the body. The token can be used in the Authorization header in the format 'Authorization: Bearer '. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.create_access_token_using_basic_auth_credentials(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :return: str - If the method is called asynchronously, - returns the request thread. + + 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_access_token_using_basic_auth_credentials_with_http_info()`` method instead. + + Args: + + Returns: + str: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): @@ -158,25 +145,22 @@ def create_access_token_using_basic_auth_credentials(self, **kwargs): def create_access_token_using_basic_auth_credentials_with_http_info(self, **kwargs): """ - Create token using basic auth + Create token using basic auth. + Creates a token for accessing the REST API via username/password. The user credentials must be passed in standard HTTP Basic Auth format. That is: 'Authorization: Basic ', where is the base64 encoded value of ':'. The token returned is formatted as a JSON Web Token (JWT). The token is base64 encoded and comprised of three parts. The header, the body, and the signature. The expiration of the token is a contained within the body. The token can be used in the Authorization header in the format 'Authorization: Bearer '. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.create_access_token_using_basic_auth_credentials_with_http_info(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :return: str - If the method is called asynchronously, - returns the request thread. + + 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_access_token_using_basic_auth_credentials()`` method instead. + + Args: + + Returns: + tuple: (str, status_code, headers) - Response data with HTTP details. """ all_params = [] - all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -207,12 +191,8 @@ def create_access_token_using_basic_auth_credentials_with_http_info(self, **kwar header_params['Accept'] = self.api_client.\ select_header_accept(['text/plain']) - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['*/*']) - # Authentication setting - auth_settings = ['tokenAuth', 'BasicAuth'] + auth_settings = ['basicAuth'] return self.api_client.call_api('/access/token/login', 'POST', path_params, @@ -223,7 +203,6 @@ def create_access_token_using_basic_auth_credentials_with_http_info(self, **kwar files=local_var_files, response_type='str', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), @@ -231,21 +210,19 @@ def create_access_token_using_basic_auth_credentials_with_http_info(self, **kwar def create_access_token_using_identity_provider_credentials(self, **kwargs): """ - Create token using identity provider + Create token using identity provider. + Creates a token for accessing the REST API via a custom identity provider. The user credentials must be passed in a format understood by the custom identity provider, e.g., a third-party auth token in an HTTP header. The exact format of the user credentials expected by the custom identity provider can be discovered by 'GET /access/token/identity-provider/usage'. The token returned is formatted as a JSON Web Token (JWT). The token is base64 encoded and comprised of three parts. The header, the body, and the signature. The expiration of the token is a contained within the body. The token can be used in the Authorization header in the format 'Authorization: Bearer '. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.create_access_token_using_identity_provider_credentials(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :return: str - If the method is called asynchronously, - returns the request thread. + + 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_access_token_using_identity_provider_credentials_with_http_info()`` method instead. + + Args: + + Returns: + str: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): @@ -256,25 +233,22 @@ def create_access_token_using_identity_provider_credentials(self, **kwargs): def create_access_token_using_identity_provider_credentials_with_http_info(self, **kwargs): """ - Create token using identity provider + Create token using identity provider. + Creates a token for accessing the REST API via a custom identity provider. The user credentials must be passed in a format understood by the custom identity provider, e.g., a third-party auth token in an HTTP header. The exact format of the user credentials expected by the custom identity provider can be discovered by 'GET /access/token/identity-provider/usage'. The token returned is formatted as a JSON Web Token (JWT). The token is base64 encoded and comprised of three parts. The header, the body, and the signature. The expiration of the token is a contained within the body. The token can be used in the Authorization header in the format 'Authorization: Bearer '. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.create_access_token_using_identity_provider_credentials_with_http_info(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :return: str - If the method is called asynchronously, - returns the request thread. + + 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_access_token_using_identity_provider_credentials()`` method instead. + + Args: + + Returns: + tuple: (str, status_code, headers) - Response data with HTTP details. """ all_params = [] - all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -305,12 +279,8 @@ def create_access_token_using_identity_provider_credentials_with_http_info(self, header_params['Accept'] = self.api_client.\ select_header_accept(['text/plain']) - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['*/*']) - # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/access/token/identity-provider', 'POST', path_params, @@ -321,7 +291,6 @@ def create_access_token_using_identity_provider_credentials_with_http_info(self, files=local_var_files, response_type='str', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), @@ -329,21 +298,19 @@ def create_access_token_using_identity_provider_credentials_with_http_info(self, def create_access_token_using_kerberos_ticket(self, **kwargs): """ - Create token using kerberos + Create token using kerberos. + Creates a token for accessing the REST API via Kerberos Service Tickets or SPNEGO Tokens (which includes Kerberos Service Tickets). The token returned is formatted as a JSON Web Token (JWT). The token is base64 encoded and comprised of three parts. The header, the body, and the signature. The expiration of the token is a contained within the body. The token can be used in the Authorization header in the format 'Authorization: Bearer '. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.create_access_token_using_kerberos_ticket(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :return: str - If the method is called asynchronously, - returns the request thread. + + 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_access_token_using_kerberos_ticket_with_http_info()`` method instead. + + Args: + + Returns: + str: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): @@ -354,25 +321,22 @@ def create_access_token_using_kerberos_ticket(self, **kwargs): def create_access_token_using_kerberos_ticket_with_http_info(self, **kwargs): """ - Create token using kerberos + Create token using kerberos. + Creates a token for accessing the REST API via Kerberos Service Tickets or SPNEGO Tokens (which includes Kerberos Service Tickets). The token returned is formatted as a JSON Web Token (JWT). The token is base64 encoded and comprised of three parts. The header, the body, and the signature. The expiration of the token is a contained within the body. The token can be used in the Authorization header in the format 'Authorization: Bearer '. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.create_access_token_using_kerberos_ticket_with_http_info(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :return: str - If the method is called asynchronously, - returns the request thread. + + 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_access_token_using_kerberos_ticket()`` method instead. + + Args: + + Returns: + tuple: (str, status_code, headers) - Response data with HTTP details. """ all_params = [] - all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -403,12 +367,8 @@ def create_access_token_using_kerberos_ticket_with_http_info(self, **kwargs): header_params['Accept'] = self.api_client.\ select_header_accept(['text/plain']) - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['*/*']) - # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/access/token/kerberos', 'POST', path_params, @@ -419,7 +379,6 @@ def create_access_token_using_kerberos_ticket_with_http_info(self, **kwargs): files=local_var_files, response_type='str', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), @@ -427,21 +386,19 @@ def create_access_token_using_kerberos_ticket_with_http_info(self, **kwargs): def get_access_status(self, **kwargs): """ - Get access status + Get access status. + Returns the current client's authenticated identity and permissions to top-level resources - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_access_status(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :return: CurrentUser - If the method is called asynchronously, - returns the request thread. + + 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_access_status_with_http_info()`` method instead. + + Args: + + Returns: + :class:`~nipyapi.registry.models.CurrentUser`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): @@ -452,25 +409,22 @@ def get_access_status(self, **kwargs): def get_access_status_with_http_info(self, **kwargs): """ - Get access status + Get access status. + Returns the current client's authenticated identity and permissions to top-level resources - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_access_status_with_http_info(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :return: CurrentUser - If the method is called asynchronously, - returns the request thread. + + 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_access_status()`` method instead. + + Args: + + Returns: + tuple: (:class:`~nipyapi.registry.models.CurrentUser`, status_code, headers) - Response data with HTTP details. """ all_params = [] - all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -501,12 +455,8 @@ def get_access_status_with_http_info(self, **kwargs): header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['*/*']) - # Authentication setting - auth_settings = ['tokenAuth', 'Authorization'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/access', 'GET', path_params, @@ -517,7 +467,6 @@ def get_access_status_with_http_info(self, **kwargs): files=local_var_files, response_type='CurrentUser', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), @@ -525,21 +474,19 @@ def get_access_status_with_http_info(self, **kwargs): def get_identity_provider_usage_instructions(self, **kwargs): """ - Get identity provider usage + Get identity provider usage. + Provides a description of how the currently configured identity provider expects credentials to be passed to POST /access/token/identity-provider - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_identity_provider_usage_instructions(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :return: str - If the method is called asynchronously, - returns the request thread. + + 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_identity_provider_usage_instructions_with_http_info()`` method instead. + + Args: + + Returns: + str: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): @@ -550,25 +497,22 @@ def get_identity_provider_usage_instructions(self, **kwargs): def get_identity_provider_usage_instructions_with_http_info(self, **kwargs): """ - Get identity provider usage + Get identity provider usage. + Provides a description of how the currently configured identity provider expects credentials to be passed to POST /access/token/identity-provider - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_identity_provider_usage_instructions_with_http_info(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :return: str - If the method is called asynchronously, - returns the request thread. + + 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_identity_provider_usage_instructions()`` method instead. + + Args: + + Returns: + tuple: (str, status_code, headers) - Response data with HTTP details. """ all_params = [] - all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -599,12 +543,8 @@ def get_identity_provider_usage_instructions_with_http_info(self, **kwargs): header_params['Accept'] = self.api_client.\ select_header_accept(['text/plain']) - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['*/*']) - # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/access/token/identity-provider/usage', 'GET', path_params, @@ -615,7 +555,6 @@ def get_identity_provider_usage_instructions_with_http_info(self, **kwargs): files=local_var_files, response_type='str', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), @@ -623,21 +562,19 @@ def get_identity_provider_usage_instructions_with_http_info(self, **kwargs): def logout(self, **kwargs): """ - Performs a logout for other providers that have been issued a JWT. + Performs a logout for other providers that have been issued a JWT.. + NOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.logout(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :return: None - If the method is called asynchronously, - returns the request thread. + + 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 + ``logout_with_http_info()`` method instead. + + Args: + + Returns: + None """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): @@ -648,25 +585,22 @@ def logout(self, **kwargs): def logout_with_http_info(self, **kwargs): """ - Performs a logout for other providers that have been issued a JWT. + Performs a logout for other providers that have been issued a JWT.. + NOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.logout_with_http_info(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :return: None - If the method is called asynchronously, - returns the request thread. + + 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 ``logout()`` method instead. + + Args: + + Returns: + tuple: (None, status_code, headers) - Response data with HTTP details. """ all_params = [] - all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -693,16 +627,8 @@ def logout_with_http_info(self, **kwargs): local_var_files = {} body_params = None - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['*/*']) - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['*/*']) - # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/access/logout', 'DELETE', path_params, @@ -713,7 +639,6 @@ def logout_with_http_info(self, **kwargs): files=local_var_files, response_type=None, auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), @@ -721,21 +646,19 @@ def logout_with_http_info(self, **kwargs): def logout_complete(self, **kwargs): """ - Completes the logout sequence. + Completes the logout sequence.. + NOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.logout_complete(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :return: None - If the method is called asynchronously, - returns the request thread. + + 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 + ``logout_complete_with_http_info()`` method instead. + + Args: + + Returns: + None """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): @@ -746,25 +669,22 @@ def logout_complete(self, **kwargs): def logout_complete_with_http_info(self, **kwargs): """ - Completes the logout sequence. + Completes the logout sequence.. + NOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.logout_complete_with_http_info(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :return: None - If the method is called asynchronously, - returns the request thread. + + 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 ``logout_complete()`` method instead. + + Args: + + Returns: + tuple: (None, status_code, headers) - Response data with HTTP details. """ all_params = [] - all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -791,16 +711,8 @@ def logout_complete_with_http_info(self, **kwargs): local_var_files = {} body_params = None - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['*/*']) - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['*/*']) - # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/access/logout/complete', 'GET', path_params, @@ -811,7 +723,6 @@ def logout_complete_with_http_info(self, **kwargs): files=local_var_files, response_type=None, auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), @@ -819,21 +730,19 @@ def logout_complete_with_http_info(self, **kwargs): def oidc_callback(self, **kwargs): """ - Redirect/callback URI for processing the result of the OpenId Connect login sequence. + Redirect/callback URI for processing the result of the OpenId Connect login sequence.. + NOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.oidc_callback(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :return: None - If the method is called asynchronously, - returns the request thread. + + 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 + ``oidc_callback_with_http_info()`` method instead. + + Args: + + Returns: + None """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): @@ -844,25 +753,22 @@ def oidc_callback(self, **kwargs): def oidc_callback_with_http_info(self, **kwargs): """ - Redirect/callback URI for processing the result of the OpenId Connect login sequence. + Redirect/callback URI for processing the result of the OpenId Connect login sequence.. + NOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.oidc_callback_with_http_info(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :return: None - If the method is called asynchronously, - returns the request thread. + + 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 ``oidc_callback()`` method instead. + + Args: + + Returns: + tuple: (None, status_code, headers) - Response data with HTTP details. """ all_params = [] - all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -893,12 +799,8 @@ def oidc_callback_with_http_info(self, **kwargs): header_params['Accept'] = self.api_client.\ select_header_accept(['*/*']) - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['*/*']) - # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/access/oidc/callback', 'GET', path_params, @@ -909,7 +811,6 @@ def oidc_callback_with_http_info(self, **kwargs): files=local_var_files, response_type=None, auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), @@ -917,21 +818,19 @@ def oidc_callback_with_http_info(self, **kwargs): def oidc_exchange(self, **kwargs): """ - Retrieves a JWT following a successful login sequence using the configured OpenId Connect provider. + Retrieves a JWT following a successful login sequence using the configured OpenId Connect provider.. + NOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.oidc_exchange(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :return: str - If the method is called asynchronously, - returns the request thread. + + 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 + ``oidc_exchange_with_http_info()`` method instead. + + Args: + + Returns: + None """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): @@ -942,25 +841,22 @@ def oidc_exchange(self, **kwargs): def oidc_exchange_with_http_info(self, **kwargs): """ - Retrieves a JWT following a successful login sequence using the configured OpenId Connect provider. + Retrieves a JWT following a successful login sequence using the configured OpenId Connect provider.. + NOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.oidc_exchange_with_http_info(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :return: str - If the method is called asynchronously, - returns the request thread. + + 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 ``oidc_exchange()`` method instead. + + Args: + + Returns: + tuple: (None, status_code, headers) - Response data with HTTP details. """ all_params = [] - all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -991,12 +887,8 @@ def oidc_exchange_with_http_info(self, **kwargs): header_params['Accept'] = self.api_client.\ select_header_accept(['text/plain']) - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['*/*']) - # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/access/oidc/exchange', 'POST', path_params, @@ -1005,9 +897,8 @@ def oidc_exchange_with_http_info(self, **kwargs): body=body_params, post_params=form_params, files=local_var_files, - response_type='str', + response_type=None, auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), @@ -1015,21 +906,19 @@ def oidc_exchange_with_http_info(self, **kwargs): def oidc_logout(self, **kwargs): """ - Performs a logout in the OpenId Provider. + Performs a logout in the OpenId Provider.. + NOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.oidc_logout(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :return: None - If the method is called asynchronously, - returns the request thread. + + 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 + ``oidc_logout_with_http_info()`` method instead. + + Args: + + Returns: + None """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): @@ -1040,25 +929,22 @@ def oidc_logout(self, **kwargs): def oidc_logout_with_http_info(self, **kwargs): """ - Performs a logout in the OpenId Provider. + Performs a logout in the OpenId Provider.. + NOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.oidc_logout_with_http_info(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :return: None - If the method is called asynchronously, - returns the request thread. + + 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 ``oidc_logout()`` method instead. + + Args: + + Returns: + tuple: (None, status_code, headers) - Response data with HTTP details. """ all_params = [] - all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -1089,12 +975,8 @@ def oidc_logout_with_http_info(self, **kwargs): header_params['Accept'] = self.api_client.\ select_header_accept(['*/*']) - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['*/*']) - # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/access/oidc/logout', 'GET', path_params, @@ -1105,7 +987,6 @@ def oidc_logout_with_http_info(self, **kwargs): files=local_var_files, response_type=None, auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), @@ -1113,21 +994,19 @@ def oidc_logout_with_http_info(self, **kwargs): def oidc_logout_callback(self, **kwargs): """ - Redirect/callback URI for processing the result of the OpenId Connect logout sequence. + Redirect/callback URI for processing the result of the OpenId Connect logout sequence.. + NOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.oidc_logout_callback(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :return: None - If the method is called asynchronously, - returns the request thread. + + 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 + ``oidc_logout_callback_with_http_info()`` method instead. + + Args: + + Returns: + None """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): @@ -1138,25 +1017,22 @@ def oidc_logout_callback(self, **kwargs): def oidc_logout_callback_with_http_info(self, **kwargs): """ - Redirect/callback URI for processing the result of the OpenId Connect logout sequence. + Redirect/callback URI for processing the result of the OpenId Connect logout sequence.. + NOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.oidc_logout_callback_with_http_info(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :return: None - If the method is called asynchronously, - returns the request thread. + + 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 ``oidc_logout_callback()`` method instead. + + Args: + + Returns: + tuple: (None, status_code, headers) - Response data with HTTP details. """ all_params = [] - all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -1187,12 +1063,8 @@ def oidc_logout_callback_with_http_info(self, **kwargs): header_params['Accept'] = self.api_client.\ select_header_accept(['*/*']) - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['*/*']) - # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/access/oidc/logout/callback', 'GET', path_params, @@ -1203,7 +1075,6 @@ def oidc_logout_callback_with_http_info(self, **kwargs): files=local_var_files, response_type=None, auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), @@ -1211,21 +1082,19 @@ def oidc_logout_callback_with_http_info(self, **kwargs): def oidc_request(self, **kwargs): """ - Initiates a request to authenticate through the configured OpenId Connect provider. + Initiates a request to authenticate through the configured OpenId Connect provider.. + NOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.oidc_request(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :return: None - If the method is called asynchronously, - returns the request thread. + + 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 + ``oidc_request_with_http_info()`` method instead. + + Args: + + Returns: + None """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): @@ -1236,25 +1105,22 @@ def oidc_request(self, **kwargs): def oidc_request_with_http_info(self, **kwargs): """ - Initiates a request to authenticate through the configured OpenId Connect provider. + Initiates a request to authenticate through the configured OpenId Connect provider.. + NOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.oidc_request_with_http_info(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :return: None - If the method is called asynchronously, - returns the request thread. + + 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 ``oidc_request()`` method instead. + + Args: + + Returns: + tuple: (None, status_code, headers) - Response data with HTTP details. """ all_params = [] - all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -1285,12 +1151,8 @@ def oidc_request_with_http_info(self, **kwargs): header_params['Accept'] = self.api_client.\ select_header_accept(['*/*']) - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['*/*']) - # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/access/oidc/request', 'GET', path_params, @@ -1301,7 +1163,6 @@ def oidc_request_with_http_info(self, **kwargs): files=local_var_files, response_type=None, auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), @@ -1309,21 +1170,19 @@ def oidc_request_with_http_info(self, **kwargs): def test_identity_provider_recognizes_credentials_format(self, **kwargs): """ - Test identity provider + Test identity provider. + Tests the format of the credentials against this identity provider without preforming authentication on the credentials to validate them. The user credentials should be passed in a format understood by the custom identity provider as defined by 'GET /access/token/identity-provider/usage'. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.test_identity_provider_recognizes_credentials_format(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :return: str - If the method is called asynchronously, - returns the request thread. + + 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 + ``test_identity_provider_recognizes_credentials_format_with_http_info()`` method instead. + + Args: + + Returns: + str: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): @@ -1334,25 +1193,22 @@ def test_identity_provider_recognizes_credentials_format(self, **kwargs): def test_identity_provider_recognizes_credentials_format_with_http_info(self, **kwargs): """ - Test identity provider + Test identity provider. + Tests the format of the credentials against this identity provider without preforming authentication on the credentials to validate them. The user credentials should be passed in a format understood by the custom identity provider as defined by 'GET /access/token/identity-provider/usage'. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.test_identity_provider_recognizes_credentials_format_with_http_info(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :return: str - If the method is called asynchronously, - returns the request thread. + + 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 ``test_identity_provider_recognizes_credentials_format()`` method instead. + + Args: + + Returns: + tuple: (str, status_code, headers) - Response data with HTTP details. """ all_params = [] - all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -1383,12 +1239,8 @@ def test_identity_provider_recognizes_credentials_format_with_http_info(self, ** header_params['Accept'] = self.api_client.\ select_header_accept(['text/plain']) - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['*/*']) - # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/access/token/identity-provider/test', 'POST', path_params, @@ -1399,7 +1251,6 @@ def test_identity_provider_recognizes_credentials_format_with_http_info(self, ** files=local_var_files, response_type='str', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), diff --git a/nipyapi/registry/apis/bucket_bundles_api.py b/nipyapi/registry/apis/bucket_bundles_api.py index 9ef725a2..a7f61d5b 100644 --- a/nipyapi/registry/apis/bucket_bundles_api.py +++ b/nipyapi/registry/apis/bucket_bundles_api.py @@ -1,14 +1,13 @@ """ Apache NiFi Registry REST API - The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components. + REST API definition for Apache NiFi Registry web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - import sys import os import re @@ -33,60 +32,59 @@ def __init__(self, api_client=None): config.api_client = ApiClient() self.api_client = config.api_client - def create_extension_bundle_version(self, bucket_id, bundle_type, file, **kwargs): + def create_extension_bundle_version(self, bucket_id, bundle_type, **kwargs): """ - Create extension bundle version + Create extension bundle version. + Creates a version of an extension bundle by uploading a binary artifact. If an extension bundle already exists in the given bucket with the same group id and artifact id as that of the bundle being uploaded, then it will be added as a new version to the existing bundle. If an extension bundle does not already exist in the given bucket with the same group id and artifact id, then a new extension bundle will be created and this version will be added to the new bundle. Client's may optionally supply a SHA-256 in hex format through the multi-part form field 'sha256'. If supplied, then this value will be compared against the SHA-256 computed by the server, and the bundle will be rejected if the values do not match. If not supplied, the bundle will be accepted, but will be marked to indicate that the client did not supply a SHA-256 during creation. NOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.create_extension_bundle_version(bucket_id, bundle_type, file, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str bucket_id: The bucket identifier (required) - :param str bundle_type: The type of the bundle (required) - :param file file: The binary content of the bundle file being uploaded. (required) - :param str sha256: Optional sha256 of the provided bundle - :return: BundleVersion - If the method is called asynchronously, - returns the request thread. + + 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_extension_bundle_version_with_http_info()`` method instead. + + Args: + bucket_id (str): + The bucket identifier (required) + bundle_type (str): + The type of the bundle (required) + file (:class:`~nipyapi.registry.models.FormDataContentDisposition`): + sha256 (str): + + Returns: + :class:`~nipyapi.registry.models.BundleVersion`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.create_extension_bundle_version_with_http_info(bucket_id, bundle_type, file, **kwargs) + return self.create_extension_bundle_version_with_http_info(bucket_id, bundle_type, **kwargs) else: - (data) = self.create_extension_bundle_version_with_http_info(bucket_id, bundle_type, file, **kwargs) + (data) = self.create_extension_bundle_version_with_http_info(bucket_id, bundle_type, **kwargs) return data - def create_extension_bundle_version_with_http_info(self, bucket_id, bundle_type, file, **kwargs): + def create_extension_bundle_version_with_http_info(self, bucket_id, bundle_type, **kwargs): """ - Create extension bundle version + Create extension bundle version. + Creates a version of an extension bundle by uploading a binary artifact. If an extension bundle already exists in the given bucket with the same group id and artifact id as that of the bundle being uploaded, then it will be added as a new version to the existing bundle. If an extension bundle does not already exist in the given bucket with the same group id and artifact id, then a new extension bundle will be created and this version will be added to the new bundle. Client's may optionally supply a SHA-256 in hex format through the multi-part form field 'sha256'. If supplied, then this value will be compared against the SHA-256 computed by the server, and the bundle will be rejected if the values do not match. If not supplied, the bundle will be accepted, but will be marked to indicate that the client did not supply a SHA-256 during creation. NOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.create_extension_bundle_version_with_http_info(bucket_id, bundle_type, file, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str bucket_id: The bucket identifier (required) - :param str bundle_type: The type of the bundle (required) - :param file file: The binary content of the bundle file being uploaded. (required) - :param str sha256: Optional sha256 of the provided bundle - :return: BundleVersion - If the method is called asynchronously, - returns the request thread. + + 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_extension_bundle_version()`` method instead. + + Args: + bucket_id (str): + The bucket identifier (required) + bundle_type (str): + The type of the bundle (required) + file (:class:`~nipyapi.registry.models.FormDataContentDisposition`): + sha256 (str): + + Returns: + tuple: (:class:`~nipyapi.registry.models.BundleVersion`, status_code, headers) - Response data with HTTP details. """ all_params = ['bucket_id', 'bundle_type', 'file', 'sha256'] - all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -106,11 +104,11 @@ def create_extension_bundle_version_with_http_info(self, bucket_id, bundle_type, # verify the required parameter 'bundle_type' is set if ('bundle_type' not in params) or (params['bundle_type'] is None): raise ValueError("Missing the required parameter `bundle_type` when calling `create_extension_bundle_version`") - # verify the required parameter 'file' is set - if ('file' not in params) or (params['file'] is None): - raise ValueError("Missing the required parameter `file` when calling `create_extension_bundle_version`") - + + + + collection_formats = {} path_params = {} @@ -126,7 +124,7 @@ def create_extension_bundle_version_with_http_info(self, bucket_id, bundle_type, form_params = [] local_var_files = {} if 'file' in params: - local_var_files['file'] = params['file'] + form_params.append(('file', params['file'])) if 'sha256' in params: form_params.append(('sha256', params['sha256'])) @@ -140,7 +138,7 @@ def create_extension_bundle_version_with_http_info(self, bucket_id, bundle_type, select_header_content_type(['multipart/form-data']) # Authentication setting - auth_settings = ['tokenAuth', 'Authorization'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/buckets/{bucketId}/bundles/{bundleType}', 'POST', path_params, @@ -151,7 +149,6 @@ def create_extension_bundle_version_with_http_info(self, bucket_id, bundle_type, files=local_var_files, response_type='BundleVersion', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), @@ -159,22 +156,21 @@ def create_extension_bundle_version_with_http_info(self, bucket_id, bundle_type, def get_extension_bundles(self, bucket_id, **kwargs): """ - Get extension bundles by bucket + Get extension bundles by bucket. + NOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_extension_bundles(bucket_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str bucket_id: The bucket identifier (required) - :return: list[ExtensionBundle] - If the method is called asynchronously, - returns the request thread. + + 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_extension_bundles_with_http_info()`` method instead. + + Args: + bucket_id (str): + The bucket identifier (required) + + Returns: + :class:`~nipyapi.registry.models.list[Bundle]`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): @@ -185,26 +181,24 @@ def get_extension_bundles(self, bucket_id, **kwargs): def get_extension_bundles_with_http_info(self, bucket_id, **kwargs): """ - Get extension bundles by bucket + Get extension bundles by bucket. + NOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_extension_bundles_with_http_info(bucket_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str bucket_id: The bucket identifier (required) - :return: list[ExtensionBundle] - If the method is called asynchronously, - returns the request thread. + + 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_extension_bundles()`` method instead. + + Args: + bucket_id (str): + The bucket identifier (required) + + Returns: + tuple: (:class:`~nipyapi.registry.models.list[Bundle]`, status_code, headers) - Response data with HTTP details. """ all_params = ['bucket_id'] - all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -222,7 +216,7 @@ def get_extension_bundles_with_http_info(self, bucket_id, **kwargs): if ('bucket_id' not in params) or (params['bucket_id'] is None): raise ValueError("Missing the required parameter `bucket_id` when calling `get_extension_bundles`") - + collection_formats = {} path_params = {} @@ -241,12 +235,8 @@ def get_extension_bundles_with_http_info(self, bucket_id, **kwargs): header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['*/*']) - # Authentication setting - auth_settings = ['tokenAuth', 'Authorization'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/buckets/{bucketId}/bundles', 'GET', path_params, @@ -255,9 +245,8 @@ def get_extension_bundles_with_http_info(self, bucket_id, **kwargs): body=body_params, post_params=form_params, files=local_var_files, - response_type='list[ExtensionBundle]', + response_type='list[Bundle]', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), diff --git a/nipyapi/registry/apis/bucket_flows_api.py b/nipyapi/registry/apis/bucket_flows_api.py index 00682465..78701f61 100644 --- a/nipyapi/registry/apis/bucket_flows_api.py +++ b/nipyapi/registry/apis/bucket_flows_api.py @@ -1,14 +1,13 @@ """ Apache NiFi Registry REST API - The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components. + REST API definition for Apache NiFi Registry web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - import sys import os import re @@ -33,56 +32,55 @@ def __init__(self, api_client=None): config.api_client = ApiClient() self.api_client = config.api_client - def create_flow(self, bucket_id, body, **kwargs): + def create_flow(self, body, bucket_id, **kwargs): """ - Create flow + Create flow. + Creates a flow in the given bucket. The flow id is created by the server and populated in the returned entity. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.create_flow(bucket_id, body, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str bucket_id: The bucket identifier (required) - :param VersionedFlow body: The details of the flow to create. (required) - :return: VersionedFlow - If the method is called asynchronously, - returns the request thread. + + 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_flow_with_http_info()`` method instead. + + Args: + body (:class:`~nipyapi.registry.models.VersionedFlow`): + The details of the flow to create. (required) + bucket_id (str): + The bucket identifier (required) + + Returns: + :class:`~nipyapi.registry.models.VersionedFlow`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.create_flow_with_http_info(bucket_id, body, **kwargs) + return self.create_flow_with_http_info(body, bucket_id, **kwargs) else: - (data) = self.create_flow_with_http_info(bucket_id, body, **kwargs) + (data) = self.create_flow_with_http_info(body, bucket_id, **kwargs) return data - def create_flow_with_http_info(self, bucket_id, body, **kwargs): + def create_flow_with_http_info(self, body, bucket_id, **kwargs): """ - Create flow + Create flow. + Creates a flow in the given bucket. The flow id is created by the server and populated in the returned entity. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.create_flow_with_http_info(bucket_id, body, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str bucket_id: The bucket identifier (required) - :param VersionedFlow body: The details of the flow to create. (required) - :return: VersionedFlow - If the method is called asynchronously, - returns the request thread. + + 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_flow()`` method instead. + + Args: + body (:class:`~nipyapi.registry.models.VersionedFlow`): + The details of the flow to create. (required) + bucket_id (str): + The bucket identifier (required) + + Returns: + tuple: (:class:`~nipyapi.registry.models.VersionedFlow`, status_code, headers) - Response data with HTTP details. """ - all_params = ['bucket_id', 'body'] - all_params.append('callback') + all_params = ['body', 'bucket_id'] all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -96,14 +94,15 @@ def create_flow_with_http_info(self, bucket_id, body, **kwargs): ) params[key] = val del params['kwargs'] - # verify the required parameter 'bucket_id' is set - if ('bucket_id' not in params) or (params['bucket_id'] is None): - raise ValueError("Missing the required parameter `bucket_id` when calling `create_flow`") # 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_flow`") + # verify the required parameter 'bucket_id' is set + if ('bucket_id' not in params) or (params['bucket_id'] is None): + raise ValueError("Missing the required parameter `bucket_id` when calling `create_flow`") - + + collection_formats = {} path_params = {} @@ -129,7 +128,7 @@ def create_flow_with_http_info(self, bucket_id, body, **kwargs): select_header_content_type(['application/json']) # Authentication setting - auth_settings = ['tokenAuth', 'Authorization'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/buckets/{bucketId}/flows', 'POST', path_params, @@ -140,66 +139,68 @@ def create_flow_with_http_info(self, bucket_id, body, **kwargs): files=local_var_files, response_type='VersionedFlow', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def create_flow_version(self, bucket_id, flow_id, body, **kwargs): + def create_flow_version(self, body, bucket_id, flow_id, **kwargs): """ - Create flow version + Create flow version. + Creates the next version of a flow. The version number of the object being created must be the next available version integer. Flow versions are immutable after they are created. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.create_flow_version(bucket_id, flow_id, body, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str bucket_id: The bucket identifier (required) - :param str flow_id: The flow identifier (required) - :param VersionedFlowSnapshot body: The new versioned flow snapshot. (required) - :param bool preserve_source_properties: Whether source properties like author should be kept - :return: VersionedFlowSnapshot - If the method is called asynchronously, - returns the request thread. + + 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_flow_version_with_http_info()`` method instead. + + Args: + body (:class:`~nipyapi.registry.models.VersionedFlowSnapshot`): + The new versioned flow snapshot. (required) + bucket_id (str): + The bucket identifier (required) + flow_id (str): + The flow identifier (required) + preserve_source_properties (bool): + Whether source properties like author should be kept + + Returns: + :class:`~nipyapi.registry.models.VersionedFlowSnapshot`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.create_flow_version_with_http_info(bucket_id, flow_id, body, **kwargs) + return self.create_flow_version_with_http_info(body, bucket_id, flow_id, **kwargs) else: - (data) = self.create_flow_version_with_http_info(bucket_id, flow_id, body, **kwargs) + (data) = self.create_flow_version_with_http_info(body, bucket_id, flow_id, **kwargs) return data - def create_flow_version_with_http_info(self, bucket_id, flow_id, body, **kwargs): + def create_flow_version_with_http_info(self, body, bucket_id, flow_id, **kwargs): """ - Create flow version + Create flow version. + Creates the next version of a flow. The version number of the object being created must be the next available version integer. Flow versions are immutable after they are created. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.create_flow_version_with_http_info(bucket_id, flow_id, body, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str bucket_id: The bucket identifier (required) - :param str flow_id: The flow identifier (required) - :param VersionedFlowSnapshot body: The new versioned flow snapshot. (required) - :param bool preserve_source_properties: Whether source properties like author should be kept - :return: VersionedFlowSnapshot - If the method is called asynchronously, - returns the request thread. + + 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_flow_version()`` method instead. + + Args: + body (:class:`~nipyapi.registry.models.VersionedFlowSnapshot`): + The new versioned flow snapshot. (required) + bucket_id (str): + The bucket identifier (required) + flow_id (str): + The flow identifier (required) + preserve_source_properties (bool): + Whether source properties like author should be kept + + Returns: + tuple: (:class:`~nipyapi.registry.models.VersionedFlowSnapshot`, status_code, headers) - Response data with HTTP details. """ - all_params = ['bucket_id', 'flow_id', 'body', 'preserve_source_properties'] - all_params.append('callback') + all_params = ['body', 'bucket_id', 'flow_id', 'preserve_source_properties'] all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -213,17 +214,20 @@ def create_flow_version_with_http_info(self, bucket_id, flow_id, body, **kwargs) ) 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_flow_version`") # verify the required parameter 'bucket_id' is set if ('bucket_id' not in params) or (params['bucket_id'] is None): raise ValueError("Missing the required parameter `bucket_id` when calling `create_flow_version`") # verify the required parameter 'flow_id' is set if ('flow_id' not in params) or (params['flow_id'] is None): raise ValueError("Missing the required parameter `flow_id` when calling `create_flow_version`") - # 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_flow_version`") - + + + + collection_formats = {} path_params = {} @@ -253,7 +257,7 @@ def create_flow_version_with_http_info(self, bucket_id, flow_id, body, **kwargs) select_header_content_type(['*/*']) # Authentication setting - auth_settings = ['tokenAuth', 'Authorization'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/buckets/{bucketId}/flows/{flowId}/versions', 'POST', path_params, @@ -264,7 +268,6 @@ def create_flow_version_with_http_info(self, bucket_id, flow_id, body, **kwargs) files=local_var_files, response_type='VersionedFlowSnapshot', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), @@ -272,25 +275,27 @@ def create_flow_version_with_http_info(self, bucket_id, flow_id, body, **kwargs) def delete_flow(self, version, bucket_id, flow_id, **kwargs): """ - Delete bucket flow + Delete bucket flow. + Deletes a flow, including all saved versions of that flow. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.delete_flow(version, bucket_id, flow_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str version: The version is used to verify the client is working with the latest version of the entity. (required) - :param str bucket_id: The bucket identifier (required) - :param str flow_id: The flow identifier (required) - :param str client_id: If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response. - :return: VersionedFlow - If the method is called asynchronously, - returns the request thread. + + 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_flow_with_http_info()`` method instead. + + Args: + version (:class:`~nipyapi.registry.models.LongParameter`): + The version is used to verify the client is working with the latest version of the entity. (required) + bucket_id (str): + The bucket identifier (required) + flow_id (str): + The flow identifier (required) + client_id (:class:`~nipyapi.registry.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. + + Returns: + :class:`~nipyapi.registry.models.VersionedFlow`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): @@ -301,29 +306,30 @@ def delete_flow(self, version, bucket_id, flow_id, **kwargs): def delete_flow_with_http_info(self, version, bucket_id, flow_id, **kwargs): """ - Delete bucket flow + Delete bucket flow. + Deletes a flow, including all saved versions of that flow. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.delete_flow_with_http_info(version, bucket_id, flow_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str version: The version is used to verify the client is working with the latest version of the entity. (required) - :param str bucket_id: The bucket identifier (required) - :param str flow_id: The flow identifier (required) - :param str client_id: If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response. - :return: VersionedFlow - If the method is called asynchronously, - returns the request thread. + + 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_flow()`` method instead. + + Args: + version (:class:`~nipyapi.registry.models.LongParameter`): + The version is used to verify the client is working with the latest version of the entity. (required) + bucket_id (str): + The bucket identifier (required) + flow_id (str): + The flow identifier (required) + client_id (:class:`~nipyapi.registry.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. + + Returns: + tuple: (:class:`~nipyapi.registry.models.VersionedFlow`, status_code, headers) - Response data with HTTP details. """ all_params = ['version', 'bucket_id', 'flow_id', 'client_id'] - all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -347,7 +353,10 @@ def delete_flow_with_http_info(self, version, bucket_id, flow_id, **kwargs): if ('flow_id' not in params) or (params['flow_id'] is None): raise ValueError("Missing the required parameter `flow_id` when calling `delete_flow`") - + + + + collection_formats = {} path_params = {} @@ -372,12 +381,8 @@ def delete_flow_with_http_info(self, version, bucket_id, flow_id, **kwargs): header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['*/*']) - # Authentication setting - auth_settings = ['tokenAuth', 'Authorization'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/buckets/{bucketId}/flows/{flowId}', 'DELETE', path_params, @@ -388,7 +393,6 @@ def delete_flow_with_http_info(self, version, bucket_id, flow_id, **kwargs): files=local_var_files, response_type='VersionedFlow', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), @@ -396,24 +400,25 @@ def delete_flow_with_http_info(self, version, bucket_id, flow_id, **kwargs): def export_versioned_flow(self, bucket_id, flow_id, version_number, **kwargs): """ - Exports specified bucket flow version content + Exports specified bucket flow version content. + Exports the specified version of a flow, including the metadata and content of the flow. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.export_versioned_flow(bucket_id, flow_id, version_number, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str bucket_id: The bucket identifier (required) - :param str flow_id: The flow identifier (required) - :param int version_number: The version number (required) - :return: VersionedFlowSnapshot - If the method is called asynchronously, - returns the request thread. + + 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 + ``export_versioned_flow_with_http_info()`` method instead. + + Args: + bucket_id (str): + The bucket identifier (required) + flow_id (str): + The flow identifier (required) + version_number (int): + The version number (required) + + Returns: + :class:`~nipyapi.registry.models.VersionedFlowSnapshot`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): @@ -424,28 +429,28 @@ def export_versioned_flow(self, bucket_id, flow_id, version_number, **kwargs): def export_versioned_flow_with_http_info(self, bucket_id, flow_id, version_number, **kwargs): """ - Exports specified bucket flow version content + Exports specified bucket flow version content. + Exports the specified version of a flow, including the metadata and content of the flow. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.export_versioned_flow_with_http_info(bucket_id, flow_id, version_number, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str bucket_id: The bucket identifier (required) - :param str flow_id: The flow identifier (required) - :param int version_number: The version number (required) - :return: VersionedFlowSnapshot - If the method is called asynchronously, - returns the request thread. + + 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 ``export_versioned_flow()`` method instead. + + Args: + bucket_id (str): + The bucket identifier (required) + flow_id (str): + The flow identifier (required) + version_number (int): + The version number (required) + + Returns: + tuple: (:class:`~nipyapi.registry.models.VersionedFlowSnapshot`, status_code, headers) - Response data with HTTP details. """ all_params = ['bucket_id', 'flow_id', 'version_number'] - all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -469,9 +474,9 @@ def export_versioned_flow_with_http_info(self, bucket_id, flow_id, version_numbe if ('version_number' not in params) or (params['version_number'] is None): raise ValueError("Missing the required parameter `version_number` when calling `export_versioned_flow`") - if 'version_number' in params and not re.search('\\d+', params['version_number']): - raise ValueError("Invalid value for parameter `version_number` when calling `export_versioned_flow`, must conform to the pattern `/\\d+/`") - + + + collection_formats = {} path_params = {} @@ -494,12 +499,8 @@ def export_versioned_flow_with_http_info(self, bucket_id, flow_id, version_numbe header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['*/*']) - # Authentication setting - auth_settings = ['tokenAuth', 'Authorization'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/buckets/{bucketId}/flows/{flowId}/versions/{versionNumber}/export', 'GET', path_params, @@ -510,7 +511,6 @@ def export_versioned_flow_with_http_info(self, bucket_id, flow_id, version_numbe files=local_var_files, response_type='VersionedFlowSnapshot', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), @@ -518,23 +518,23 @@ def export_versioned_flow_with_http_info(self, bucket_id, flow_id, version_numbe def get_flow(self, bucket_id, flow_id, **kwargs): """ - Get bucket flow + Get bucket flow. + Retrieves the flow with the given id in the given bucket. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_flow(bucket_id, flow_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str bucket_id: The bucket identifier (required) - :param str flow_id: The flow identifier (required) - :return: VersionedFlow - If the method is called asynchronously, - returns the request thread. + + 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_flow_with_http_info()`` method instead. + + Args: + bucket_id (str): + The bucket identifier (required) + flow_id (str): + The flow identifier (required) + + Returns: + :class:`~nipyapi.registry.models.VersionedFlow`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): @@ -545,27 +545,26 @@ def get_flow(self, bucket_id, flow_id, **kwargs): def get_flow_with_http_info(self, bucket_id, flow_id, **kwargs): """ - Get bucket flow + Get bucket flow. + Retrieves the flow with the given id in the given bucket. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_flow_with_http_info(bucket_id, flow_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str bucket_id: The bucket identifier (required) - :param str flow_id: The flow identifier (required) - :return: VersionedFlow - If the method is called asynchronously, - returns the request thread. + + 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_flow()`` method instead. + + Args: + bucket_id (str): + The bucket identifier (required) + flow_id (str): + The flow identifier (required) + + Returns: + tuple: (:class:`~nipyapi.registry.models.VersionedFlow`, status_code, headers) - Response data with HTTP details. """ all_params = ['bucket_id', 'flow_id'] - all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -586,7 +585,8 @@ def get_flow_with_http_info(self, bucket_id, flow_id, **kwargs): if ('flow_id' not in params) or (params['flow_id'] is None): raise ValueError("Missing the required parameter `flow_id` when calling `get_flow`") - + + collection_formats = {} path_params = {} @@ -607,12 +607,8 @@ def get_flow_with_http_info(self, bucket_id, flow_id, **kwargs): header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['*/*']) - # Authentication setting - auth_settings = ['tokenAuth', 'Authorization'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/buckets/{bucketId}/flows/{flowId}', 'GET', path_params, @@ -623,7 +619,6 @@ def get_flow_with_http_info(self, bucket_id, flow_id, **kwargs): files=local_var_files, response_type='VersionedFlow', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), @@ -631,25 +626,27 @@ def get_flow_with_http_info(self, bucket_id, flow_id, **kwargs): def get_flow_diff(self, bucket_id, flow_id, version_a, version_b, **kwargs): """ - Get bucket flow diff + Get bucket flow diff. + Computes the differences between two given versions of a flow. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_flow_diff(bucket_id, flow_id, version_a, version_b, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str bucket_id: The bucket identifier (required) - :param str flow_id: The flow identifier (required) - :param int version_a: The first version number (required) - :param int version_b: The second version number (required) - :return: VersionedFlowDifference - If the method is called asynchronously, - returns the request thread. + + 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_flow_diff_with_http_info()`` method instead. + + Args: + bucket_id (str): + The bucket identifier (required) + flow_id (str): + The flow identifier (required) + version_a (int): + The first version number (required) + version_b (int): + The second version number (required) + + Returns: + :class:`~nipyapi.registry.models.VersionedFlowDifference`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): @@ -660,29 +657,30 @@ def get_flow_diff(self, bucket_id, flow_id, version_a, version_b, **kwargs): def get_flow_diff_with_http_info(self, bucket_id, flow_id, version_a, version_b, **kwargs): """ - Get bucket flow diff + Get bucket flow diff. + Computes the differences between two given versions of a flow. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_flow_diff_with_http_info(bucket_id, flow_id, version_a, version_b, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str bucket_id: The bucket identifier (required) - :param str flow_id: The flow identifier (required) - :param int version_a: The first version number (required) - :param int version_b: The second version number (required) - :return: VersionedFlowDifference - If the method is called asynchronously, - returns the request thread. + + 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_flow_diff()`` method instead. + + Args: + bucket_id (str): + The bucket identifier (required) + flow_id (str): + The flow identifier (required) + version_a (int): + The first version number (required) + version_b (int): + The second version number (required) + + Returns: + tuple: (:class:`~nipyapi.registry.models.VersionedFlowDifference`, status_code, headers) - Response data with HTTP details. """ all_params = ['bucket_id', 'flow_id', 'version_a', 'version_b'] - all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -709,11 +707,10 @@ def get_flow_diff_with_http_info(self, bucket_id, flow_id, version_a, version_b, if ('version_b' not in params) or (params['version_b'] is None): raise ValueError("Missing the required parameter `version_b` when calling `get_flow_diff`") - if 'version_a' in params and not re.search('\\d+', params['version_a']): - raise ValueError("Invalid value for parameter `version_a` when calling `get_flow_diff`, must conform to the pattern `/\\d+/`") - if 'version_b' in params and not re.search('\\d+', params['version_b']): - raise ValueError("Invalid value for parameter `version_b` when calling `get_flow_diff`, must conform to the pattern `/\\d+/`") - + + + + collection_formats = {} path_params = {} @@ -738,12 +735,8 @@ def get_flow_diff_with_http_info(self, bucket_id, flow_id, version_a, version_b, header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['*/*']) - # Authentication setting - auth_settings = ['tokenAuth', 'Authorization'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/buckets/{bucketId}/flows/{flowId}/diff/{versionA}/{versionB}', 'GET', path_params, @@ -754,7 +747,6 @@ def get_flow_diff_with_http_info(self, bucket_id, flow_id, version_a, version_b, files=local_var_files, response_type='VersionedFlowDifference', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), @@ -762,24 +754,25 @@ def get_flow_diff_with_http_info(self, bucket_id, flow_id, version_a, version_b, def get_flow_version(self, bucket_id, flow_id, version_number, **kwargs): """ - Get bucket flow version + Get bucket flow version. + Gets the given version of a flow, including the metadata and content for the version. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_flow_version(bucket_id, flow_id, version_number, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str bucket_id: The bucket identifier (required) - :param str flow_id: The flow identifier (required) - :param int version_number: The version number (required) - :return: VersionedFlowSnapshot - If the method is called asynchronously, - returns the request thread. + + 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_flow_version_with_http_info()`` method instead. + + Args: + bucket_id (str): + The bucket identifier (required) + flow_id (str): + The flow identifier (required) + version_number (int): + The version number (required) + + Returns: + :class:`~nipyapi.registry.models.VersionedFlowSnapshot`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): @@ -790,28 +783,28 @@ def get_flow_version(self, bucket_id, flow_id, version_number, **kwargs): def get_flow_version_with_http_info(self, bucket_id, flow_id, version_number, **kwargs): """ - Get bucket flow version + Get bucket flow version. + Gets the given version of a flow, including the metadata and content for the version. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_flow_version_with_http_info(bucket_id, flow_id, version_number, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str bucket_id: The bucket identifier (required) - :param str flow_id: The flow identifier (required) - :param int version_number: The version number (required) - :return: VersionedFlowSnapshot - If the method is called asynchronously, - returns the request thread. + + 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_flow_version()`` method instead. + + Args: + bucket_id (str): + The bucket identifier (required) + flow_id (str): + The flow identifier (required) + version_number (int): + The version number (required) + + Returns: + tuple: (:class:`~nipyapi.registry.models.VersionedFlowSnapshot`, status_code, headers) - Response data with HTTP details. """ all_params = ['bucket_id', 'flow_id', 'version_number'] - all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -835,9 +828,9 @@ def get_flow_version_with_http_info(self, bucket_id, flow_id, version_number, ** if ('version_number' not in params) or (params['version_number'] is None): raise ValueError("Missing the required parameter `version_number` when calling `get_flow_version`") - if 'version_number' in params and not re.search('\\d+', params['version_number']): - raise ValueError("Invalid value for parameter `version_number` when calling `get_flow_version`, must conform to the pattern `/\\d+/`") - + + + collection_formats = {} path_params = {} @@ -860,12 +853,8 @@ def get_flow_version_with_http_info(self, bucket_id, flow_id, version_number, ** header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['*/*']) - # Authentication setting - auth_settings = ['tokenAuth', 'Authorization'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/buckets/{bucketId}/flows/{flowId}/versions/{versionNumber}', 'GET', path_params, @@ -876,7 +865,6 @@ def get_flow_version_with_http_info(self, bucket_id, flow_id, version_number, ** files=local_var_files, response_type='VersionedFlowSnapshot', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), @@ -884,23 +872,23 @@ def get_flow_version_with_http_info(self, bucket_id, flow_id, version_number, ** def get_flow_versions(self, bucket_id, flow_id, **kwargs): """ - Get bucket flow versions + Get bucket flow versions. + Gets summary information for all versions of a flow. Versions are ordered newest->oldest. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_flow_versions(bucket_id, flow_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str bucket_id: The bucket identifier (required) - :param str flow_id: The flow identifier (required) - :return: list[VersionedFlowSnapshotMetadata] - If the method is called asynchronously, - returns the request thread. + + 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_flow_versions_with_http_info()`` method instead. + + Args: + bucket_id (str): + The bucket identifier (required) + flow_id (str): + The flow identifier (required) + + Returns: + :class:`~nipyapi.registry.models.list[VersionedFlowSnapshotMetadata]`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): @@ -911,27 +899,26 @@ def get_flow_versions(self, bucket_id, flow_id, **kwargs): def get_flow_versions_with_http_info(self, bucket_id, flow_id, **kwargs): """ - Get bucket flow versions + Get bucket flow versions. + Gets summary information for all versions of a flow. Versions are ordered newest->oldest. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_flow_versions_with_http_info(bucket_id, flow_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str bucket_id: The bucket identifier (required) - :param str flow_id: The flow identifier (required) - :return: list[VersionedFlowSnapshotMetadata] - If the method is called asynchronously, - returns the request thread. + + 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_flow_versions()`` method instead. + + Args: + bucket_id (str): + The bucket identifier (required) + flow_id (str): + The flow identifier (required) + + Returns: + tuple: (:class:`~nipyapi.registry.models.list[VersionedFlowSnapshotMetadata]`, status_code, headers) - Response data with HTTP details. """ all_params = ['bucket_id', 'flow_id'] - all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -952,7 +939,8 @@ def get_flow_versions_with_http_info(self, bucket_id, flow_id, **kwargs): if ('flow_id' not in params) or (params['flow_id'] is None): raise ValueError("Missing the required parameter `flow_id` when calling `get_flow_versions`") - + + collection_formats = {} path_params = {} @@ -973,12 +961,8 @@ def get_flow_versions_with_http_info(self, bucket_id, flow_id, **kwargs): header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['*/*']) - # Authentication setting - auth_settings = ['tokenAuth', 'Authorization'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/buckets/{bucketId}/flows/{flowId}/versions', 'GET', path_params, @@ -989,7 +973,6 @@ def get_flow_versions_with_http_info(self, bucket_id, flow_id, **kwargs): files=local_var_files, response_type='list[VersionedFlowSnapshotMetadata]', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), @@ -997,22 +980,21 @@ def get_flow_versions_with_http_info(self, bucket_id, flow_id, **kwargs): def get_flows(self, bucket_id, **kwargs): """ - Get bucket flows + Get bucket flows. + Retrieves all flows in the given bucket. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_flows(bucket_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str bucket_id: The bucket identifier (required) - :return: list[VersionedFlow] - If the method is called asynchronously, - returns the request thread. + + 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_flows_with_http_info()`` method instead. + + Args: + bucket_id (str): + The bucket identifier (required) + + Returns: + :class:`~nipyapi.registry.models.list[VersionedFlow]`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): @@ -1023,26 +1005,24 @@ def get_flows(self, bucket_id, **kwargs): def get_flows_with_http_info(self, bucket_id, **kwargs): """ - Get bucket flows + Get bucket flows. + Retrieves all flows in the given bucket. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_flows_with_http_info(bucket_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str bucket_id: The bucket identifier (required) - :return: list[VersionedFlow] - If the method is called asynchronously, - returns the request thread. + + 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_flows()`` method instead. + + Args: + bucket_id (str): + The bucket identifier (required) + + Returns: + tuple: (:class:`~nipyapi.registry.models.list[VersionedFlow]`, status_code, headers) - Response data with HTTP details. """ all_params = ['bucket_id'] - all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -1060,7 +1040,7 @@ def get_flows_with_http_info(self, bucket_id, **kwargs): if ('bucket_id' not in params) or (params['bucket_id'] is None): raise ValueError("Missing the required parameter `bucket_id` when calling `get_flows`") - + collection_formats = {} path_params = {} @@ -1079,12 +1059,8 @@ def get_flows_with_http_info(self, bucket_id, **kwargs): header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['*/*']) - # Authentication setting - auth_settings = ['tokenAuth', 'Authorization'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/buckets/{bucketId}/flows', 'GET', path_params, @@ -1095,7 +1071,6 @@ def get_flows_with_http_info(self, bucket_id, **kwargs): files=local_var_files, response_type='list[VersionedFlow]', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), @@ -1103,23 +1078,23 @@ def get_flows_with_http_info(self, bucket_id, **kwargs): def get_latest_flow_version(self, bucket_id, flow_id, **kwargs): """ - Get latest bucket flow version content + Get latest bucket flow version content. + Gets the latest version of a flow, including the metadata and content of the flow. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_latest_flow_version(bucket_id, flow_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str bucket_id: The bucket identifier (required) - :param str flow_id: The flow identifier (required) - :return: VersionedFlowSnapshot - If the method is called asynchronously, - returns the request thread. + + 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_latest_flow_version_with_http_info()`` method instead. + + Args: + bucket_id (str): + The bucket identifier (required) + flow_id (str): + The flow identifier (required) + + Returns: + :class:`~nipyapi.registry.models.VersionedFlowSnapshot`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): @@ -1130,27 +1105,26 @@ def get_latest_flow_version(self, bucket_id, flow_id, **kwargs): def get_latest_flow_version_with_http_info(self, bucket_id, flow_id, **kwargs): """ - Get latest bucket flow version content + Get latest bucket flow version content. + Gets the latest version of a flow, including the metadata and content of the flow. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_latest_flow_version_with_http_info(bucket_id, flow_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str bucket_id: The bucket identifier (required) - :param str flow_id: The flow identifier (required) - :return: VersionedFlowSnapshot - If the method is called asynchronously, - returns the request thread. + + 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_latest_flow_version()`` method instead. + + Args: + bucket_id (str): + The bucket identifier (required) + flow_id (str): + The flow identifier (required) + + Returns: + tuple: (:class:`~nipyapi.registry.models.VersionedFlowSnapshot`, status_code, headers) - Response data with HTTP details. """ all_params = ['bucket_id', 'flow_id'] - all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -1171,7 +1145,8 @@ def get_latest_flow_version_with_http_info(self, bucket_id, flow_id, **kwargs): if ('flow_id' not in params) or (params['flow_id'] is None): raise ValueError("Missing the required parameter `flow_id` when calling `get_latest_flow_version`") - + + collection_formats = {} path_params = {} @@ -1192,12 +1167,8 @@ def get_latest_flow_version_with_http_info(self, bucket_id, flow_id, **kwargs): header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['*/*']) - # Authentication setting - auth_settings = ['tokenAuth', 'Authorization'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/buckets/{bucketId}/flows/{flowId}/versions/latest', 'GET', path_params, @@ -1208,7 +1179,6 @@ def get_latest_flow_version_with_http_info(self, bucket_id, flow_id, **kwargs): files=local_var_files, response_type='VersionedFlowSnapshot', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), @@ -1216,23 +1186,23 @@ def get_latest_flow_version_with_http_info(self, bucket_id, flow_id, **kwargs): def get_latest_flow_version_metadata(self, bucket_id, flow_id, **kwargs): """ - Get latest bucket flow version metadata + Get latest bucket flow version metadata. + Gets the metadata for the latest version of a flow. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_latest_flow_version_metadata(bucket_id, flow_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str bucket_id: The bucket identifier (required) - :param str flow_id: The flow identifier (required) - :return: VersionedFlowSnapshotMetadata - If the method is called asynchronously, - returns the request thread. + + 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_latest_flow_version_metadata_with_http_info()`` method instead. + + Args: + bucket_id (str): + The bucket identifier (required) + flow_id (str): + The flow identifier (required) + + Returns: + :class:`~nipyapi.registry.models.VersionedFlowSnapshotMetadata`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): @@ -1243,27 +1213,26 @@ def get_latest_flow_version_metadata(self, bucket_id, flow_id, **kwargs): def get_latest_flow_version_metadata_with_http_info(self, bucket_id, flow_id, **kwargs): """ - Get latest bucket flow version metadata + Get latest bucket flow version metadata. + Gets the metadata for the latest version of a flow. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_latest_flow_version_metadata_with_http_info(bucket_id, flow_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str bucket_id: The bucket identifier (required) - :param str flow_id: The flow identifier (required) - :return: VersionedFlowSnapshotMetadata - If the method is called asynchronously, - returns the request thread. + + 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_latest_flow_version_metadata()`` method instead. + + Args: + bucket_id (str): + The bucket identifier (required) + flow_id (str): + The flow identifier (required) + + Returns: + tuple: (:class:`~nipyapi.registry.models.VersionedFlowSnapshotMetadata`, status_code, headers) - Response data with HTTP details. """ all_params = ['bucket_id', 'flow_id'] - all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -1284,7 +1253,8 @@ def get_latest_flow_version_metadata_with_http_info(self, bucket_id, flow_id, ** if ('flow_id' not in params) or (params['flow_id'] is None): raise ValueError("Missing the required parameter `flow_id` when calling `get_latest_flow_version_metadata`") - + + collection_formats = {} path_params = {} @@ -1305,12 +1275,8 @@ def get_latest_flow_version_metadata_with_http_info(self, bucket_id, flow_id, ** header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['*/*']) - # Authentication setting - auth_settings = ['tokenAuth', 'Authorization'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/buckets/{bucketId}/flows/{flowId}/versions/latest/metadata', 'GET', path_params, @@ -1321,7 +1287,6 @@ def get_latest_flow_version_metadata_with_http_info(self, bucket_id, flow_id, ** files=local_var_files, response_type='VersionedFlowSnapshotMetadata', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), @@ -1329,25 +1294,26 @@ def get_latest_flow_version_metadata_with_http_info(self, bucket_id, flow_id, ** def import_versioned_flow(self, bucket_id, flow_id, **kwargs): """ - Import flow version + Import flow version. + Import the next version of a flow. The version number of the object being created will be the next available version integer. Flow versions are immutable after they are created. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.import_versioned_flow(bucket_id, flow_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str bucket_id: The bucket identifier (required) - :param str flow_id: The flow identifier (required) - :param VersionedFlowSnapshot body: file - :param str comments: - :return: VersionedFlowSnapshot - If the method is called asynchronously, - returns the request thread. + + 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 + ``import_versioned_flow_with_http_info()`` method instead. + + Args: + bucket_id (str): + The bucket identifier (required) + flow_id (str): + The flow identifier (required) + body (:class:`~nipyapi.registry.models.VersionedFlowSnapshot`): + file + comments (str): + + Returns: + :class:`~nipyapi.registry.models.VersionedFlowSnapshot`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): @@ -1358,29 +1324,29 @@ def import_versioned_flow(self, bucket_id, flow_id, **kwargs): def import_versioned_flow_with_http_info(self, bucket_id, flow_id, **kwargs): """ - Import flow version + Import flow version. + Import the next version of a flow. The version number of the object being created will be the next available version integer. Flow versions are immutable after they are created. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.import_versioned_flow_with_http_info(bucket_id, flow_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str bucket_id: The bucket identifier (required) - :param str flow_id: The flow identifier (required) - :param VersionedFlowSnapshot body: file - :param str comments: - :return: VersionedFlowSnapshot - If the method is called asynchronously, - returns the request thread. + + 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 ``import_versioned_flow()`` method instead. + + Args: + bucket_id (str): + The bucket identifier (required) + flow_id (str): + The flow identifier (required) + body (:class:`~nipyapi.registry.models.VersionedFlowSnapshot`): + file + comments (str): + + Returns: + tuple: (:class:`~nipyapi.registry.models.VersionedFlowSnapshot`, status_code, headers) - Response data with HTTP details. """ all_params = ['bucket_id', 'flow_id', 'body', 'comments'] - all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -1401,7 +1367,10 @@ def import_versioned_flow_with_http_info(self, bucket_id, flow_id, **kwargs): if ('flow_id' not in params) or (params['flow_id'] is None): raise ValueError("Missing the required parameter `flow_id` when calling `import_versioned_flow`") - + + + + collection_formats = {} path_params = {} @@ -1431,7 +1400,7 @@ def import_versioned_flow_with_http_info(self, bucket_id, flow_id, **kwargs): select_header_content_type(['application/json']) # Authentication setting - auth_settings = ['tokenAuth', 'Authorization'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/buckets/{bucketId}/flows/{flowId}/versions/import', 'POST', path_params, @@ -1442,64 +1411,64 @@ def import_versioned_flow_with_http_info(self, bucket_id, flow_id, **kwargs): files=local_var_files, response_type='VersionedFlowSnapshot', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def update_flow(self, bucket_id, flow_id, body, **kwargs): + def update_flow(self, body, bucket_id, flow_id, **kwargs): """ - Update bucket flow + Update bucket flow. + Updates the flow with the given id in the given bucket. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.update_flow(bucket_id, flow_id, body, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str bucket_id: The bucket identifier (required) - :param str flow_id: The flow identifier (required) - :param VersionedFlow body: The updated flow (required) - :return: VersionedFlow - If the method is called asynchronously, - returns the request thread. + + 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 + ``update_flow_with_http_info()`` method instead. + + Args: + body (:class:`~nipyapi.registry.models.VersionedFlow`): + The updated flow (required) + bucket_id (str): + The bucket identifier (required) + flow_id (str): + The flow identifier (required) + + Returns: + :class:`~nipyapi.registry.models.VersionedFlow`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.update_flow_with_http_info(bucket_id, flow_id, body, **kwargs) + return self.update_flow_with_http_info(body, bucket_id, flow_id, **kwargs) else: - (data) = self.update_flow_with_http_info(bucket_id, flow_id, body, **kwargs) + (data) = self.update_flow_with_http_info(body, bucket_id, flow_id, **kwargs) return data - def update_flow_with_http_info(self, bucket_id, flow_id, body, **kwargs): + def update_flow_with_http_info(self, body, bucket_id, flow_id, **kwargs): """ - Update bucket flow + Update bucket flow. + Updates the flow with the given id in the given bucket. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.update_flow_with_http_info(bucket_id, flow_id, body, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str bucket_id: The bucket identifier (required) - :param str flow_id: The flow identifier (required) - :param VersionedFlow body: The updated flow (required) - :return: VersionedFlow - If the method is called asynchronously, - returns the request thread. + + 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 ``update_flow()`` method instead. + + Args: + body (:class:`~nipyapi.registry.models.VersionedFlow`): + The updated flow (required) + bucket_id (str): + The bucket identifier (required) + flow_id (str): + The flow identifier (required) + + Returns: + tuple: (:class:`~nipyapi.registry.models.VersionedFlow`, status_code, headers) - Response data with HTTP details. """ - all_params = ['bucket_id', 'flow_id', 'body'] - all_params.append('callback') + all_params = ['body', 'bucket_id', 'flow_id'] all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -1513,17 +1482,19 @@ def update_flow_with_http_info(self, bucket_id, flow_id, body, **kwargs): ) 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 `update_flow`") # verify the required parameter 'bucket_id' is set if ('bucket_id' not in params) or (params['bucket_id'] is None): raise ValueError("Missing the required parameter `bucket_id` when calling `update_flow`") # verify the required parameter 'flow_id' is set if ('flow_id' not in params) or (params['flow_id'] is None): raise ValueError("Missing the required parameter `flow_id` when calling `update_flow`") - # verify the required parameter 'body' is set - if ('body' not in params) or (params['body'] is None): - raise ValueError("Missing the required parameter `body` when calling `update_flow`") - + + + collection_formats = {} path_params = {} @@ -1551,7 +1522,7 @@ def update_flow_with_http_info(self, bucket_id, flow_id, body, **kwargs): select_header_content_type(['application/json']) # Authentication setting - auth_settings = ['tokenAuth', 'Authorization'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/buckets/{bucketId}/flows/{flowId}', 'PUT', path_params, @@ -1562,7 +1533,6 @@ def update_flow_with_http_info(self, bucket_id, flow_id, body, **kwargs): files=local_var_files, response_type='VersionedFlow', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), diff --git a/nipyapi/registry/apis/buckets_api.py b/nipyapi/registry/apis/buckets_api.py index b366798e..c3b16350 100644 --- a/nipyapi/registry/apis/buckets_api.py +++ b/nipyapi/registry/apis/buckets_api.py @@ -1,14 +1,13 @@ """ Apache NiFi Registry REST API - The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components. + REST API definition for Apache NiFi Registry web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - import sys import os import re @@ -35,23 +34,20 @@ def __init__(self, api_client=None): def create_bucket(self, body, **kwargs): """ - Create bucket + Create bucket. + 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_bucket_with_http_info()`` method instead. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.create_bucket(body, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param Bucket body: The bucket to create (required) - :param bool preserve_source_properties: Whether source properties like identifier should be kept - :return: Bucket - If the method is called asynchronously, - returns the request thread. + Args: + body (:class:`~nipyapi.registry.models.Bucket`): + The bucket to create (required) + preserve_source_properties (bool): + Whether source properties like identifier should be kept + + Returns: + :class:`~nipyapi.registry.models.Bucket`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): @@ -62,27 +58,23 @@ def create_bucket(self, body, **kwargs): def create_bucket_with_http_info(self, body, **kwargs): """ - Create bucket + Create bucket. + 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_bucket()`` method instead. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.create_bucket_with_http_info(body, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param Bucket body: The bucket to create (required) - :param bool preserve_source_properties: Whether source properties like identifier should be kept - :return: Bucket - If the method is called asynchronously, - returns the request thread. + Args: + body (:class:`~nipyapi.registry.models.Bucket`): + The bucket to create (required) + preserve_source_properties (bool): + Whether source properties like identifier should be kept + + Returns: + tuple: (:class:`~nipyapi.registry.models.Bucket`, status_code, headers) - Response data with HTTP details. """ all_params = ['body', 'preserve_source_properties'] - all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -100,7 +92,8 @@ def create_bucket_with_http_info(self, body, **kwargs): if ('body' not in params) or (params['body'] is None): raise ValueError("Missing the required parameter `body` when calling `create_bucket`") - + + collection_formats = {} path_params = {} @@ -126,7 +119,7 @@ def create_bucket_with_http_info(self, body, **kwargs): select_header_content_type(['application/json']) # Authentication setting - auth_settings = ['tokenAuth', 'Authorization'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/buckets', 'POST', path_params, @@ -137,7 +130,6 @@ def create_bucket_with_http_info(self, body, **kwargs): files=local_var_files, response_type='Bucket', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), @@ -145,24 +137,25 @@ def create_bucket_with_http_info(self, body, **kwargs): def delete_bucket(self, version, bucket_id, **kwargs): """ - Delete bucket + Delete bucket. + Deletes the bucket with the given id, along with all objects stored in the bucket - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.delete_bucket(version, bucket_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str version: The version is used to verify the client is working with the latest version of the entity. (required) - :param str bucket_id: The bucket identifier (required) - :param str client_id: If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response. - :return: Bucket - If the method is called asynchronously, - returns the request thread. + + 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_bucket_with_http_info()`` method instead. + + Args: + version (:class:`~nipyapi.registry.models.LongParameter`): + The version is used to verify the client is working with the latest version of the entity. (required) + bucket_id (str): + The bucket identifier (required) + client_id (:class:`~nipyapi.registry.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. + + Returns: + :class:`~nipyapi.registry.models.Bucket`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): @@ -173,28 +166,28 @@ def delete_bucket(self, version, bucket_id, **kwargs): def delete_bucket_with_http_info(self, version, bucket_id, **kwargs): """ - Delete bucket + Delete bucket. + Deletes the bucket with the given id, along with all objects stored in the bucket - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.delete_bucket_with_http_info(version, bucket_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str version: The version is used to verify the client is working with the latest version of the entity. (required) - :param str bucket_id: The bucket identifier (required) - :param str client_id: If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response. - :return: Bucket - If the method is called asynchronously, - returns the request thread. + + 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_bucket()`` method instead. + + Args: + version (:class:`~nipyapi.registry.models.LongParameter`): + The version is used to verify the client is working with the latest version of the entity. (required) + bucket_id (str): + The bucket identifier (required) + client_id (:class:`~nipyapi.registry.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. + + Returns: + tuple: (:class:`~nipyapi.registry.models.Bucket`, status_code, headers) - Response data with HTTP details. """ all_params = ['version', 'bucket_id', 'client_id'] - all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -215,7 +208,9 @@ def delete_bucket_with_http_info(self, version, bucket_id, **kwargs): if ('bucket_id' not in params) or (params['bucket_id'] is None): raise ValueError("Missing the required parameter `bucket_id` when calling `delete_bucket`") - + + + collection_formats = {} path_params = {} @@ -238,12 +233,8 @@ def delete_bucket_with_http_info(self, version, bucket_id, **kwargs): header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['*/*']) - # Authentication setting - auth_settings = ['tokenAuth', 'Authorization'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/buckets/{bucketId}', 'DELETE', path_params, @@ -254,7 +245,6 @@ def delete_bucket_with_http_info(self, version, bucket_id, **kwargs): files=local_var_files, response_type='Bucket', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), @@ -262,21 +252,19 @@ def delete_bucket_with_http_info(self, version, bucket_id, **kwargs): def get_available_bucket_fields(self, **kwargs): """ - Get bucket fields + Get bucket fields. + Retrieves bucket field names for searching or sorting on buckets. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_available_bucket_fields(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :return: Fields - If the method is called asynchronously, - returns the request thread. + + 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_available_bucket_fields_with_http_info()`` method instead. + + Args: + + Returns: + :class:`~nipyapi.registry.models.Fields`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): @@ -287,25 +275,22 @@ def get_available_bucket_fields(self, **kwargs): def get_available_bucket_fields_with_http_info(self, **kwargs): """ - Get bucket fields + Get bucket fields. + Retrieves bucket field names for searching or sorting on buckets. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_available_bucket_fields_with_http_info(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :return: Fields - If the method is called asynchronously, - returns the request thread. + + 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_available_bucket_fields()`` method instead. + + Args: + + Returns: + tuple: (:class:`~nipyapi.registry.models.Fields`, status_code, headers) - Response data with HTTP details. """ all_params = [] - all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -336,12 +321,8 @@ def get_available_bucket_fields_with_http_info(self, **kwargs): header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['*/*']) - # Authentication setting - auth_settings = ['tokenAuth', 'Authorization'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/buckets/fields', 'GET', path_params, @@ -352,7 +333,6 @@ def get_available_bucket_fields_with_http_info(self, **kwargs): files=local_var_files, response_type='Fields', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), @@ -360,22 +340,21 @@ def get_available_bucket_fields_with_http_info(self, **kwargs): def get_bucket(self, bucket_id, **kwargs): """ - Get bucket + Get bucket. + Gets the bucket with the given id. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_bucket(bucket_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str bucket_id: The bucket identifier (required) - :return: Bucket - If the method is called asynchronously, - returns the request thread. + + 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_bucket_with_http_info()`` method instead. + + Args: + bucket_id (str): + The bucket identifier (required) + + Returns: + :class:`~nipyapi.registry.models.Bucket`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): @@ -386,26 +365,24 @@ def get_bucket(self, bucket_id, **kwargs): def get_bucket_with_http_info(self, bucket_id, **kwargs): """ - Get bucket + Get bucket. + Gets the bucket with the given id. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_bucket_with_http_info(bucket_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str bucket_id: The bucket identifier (required) - :return: Bucket - If the method is called asynchronously, - returns the request thread. + + 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_bucket()`` method instead. + + Args: + bucket_id (str): + The bucket identifier (required) + + Returns: + tuple: (:class:`~nipyapi.registry.models.Bucket`, status_code, headers) - Response data with HTTP details. """ all_params = ['bucket_id'] - all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -423,7 +400,7 @@ def get_bucket_with_http_info(self, bucket_id, **kwargs): if ('bucket_id' not in params) or (params['bucket_id'] is None): raise ValueError("Missing the required parameter `bucket_id` when calling `get_bucket`") - + collection_formats = {} path_params = {} @@ -442,12 +419,8 @@ def get_bucket_with_http_info(self, bucket_id, **kwargs): header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['*/*']) - # Authentication setting - auth_settings = ['tokenAuth', 'Authorization'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/buckets/{bucketId}', 'GET', path_params, @@ -458,7 +431,6 @@ def get_bucket_with_http_info(self, bucket_id, **kwargs): files=local_var_files, response_type='Bucket', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), @@ -466,21 +438,19 @@ def get_bucket_with_http_info(self, bucket_id, **kwargs): def get_buckets(self, **kwargs): """ - Get all buckets + Get all buckets. + The returned list will include only buckets for which the user is authorized.If the user is not authorized for any buckets, this returns an empty list. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_buckets(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :return: list[Bucket] - If the method is called asynchronously, - returns the request thread. + + 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_buckets_with_http_info()`` method instead. + + Args: + + Returns: + :class:`~nipyapi.registry.models.list[Bucket]`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): @@ -491,25 +461,22 @@ def get_buckets(self, **kwargs): def get_buckets_with_http_info(self, **kwargs): """ - Get all buckets + Get all buckets. + The returned list will include only buckets for which the user is authorized.If the user is not authorized for any buckets, this returns an empty list. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_buckets_with_http_info(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :return: list[Bucket] - If the method is called asynchronously, - returns the request thread. + + 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_buckets()`` method instead. + + Args: + + Returns: + tuple: (:class:`~nipyapi.registry.models.list[Bucket]`, status_code, headers) - Response data with HTTP details. """ all_params = [] - all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -540,12 +507,8 @@ def get_buckets_with_http_info(self, **kwargs): header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['*/*']) - # Authentication setting - auth_settings = ['tokenAuth', 'Authorization'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/buckets', 'GET', path_params, @@ -556,62 +519,60 @@ def get_buckets_with_http_info(self, **kwargs): files=local_var_files, response_type='list[Bucket]', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def update_bucket(self, bucket_id, body, **kwargs): + def update_bucket(self, body, bucket_id, **kwargs): """ - Update bucket + Update bucket. + Updates the bucket with the given id. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.update_bucket(bucket_id, body, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str bucket_id: The bucket identifier (required) - :param Bucket body: The updated bucket (required) - :return: Bucket - If the method is called asynchronously, - returns the request thread. + + 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 + ``update_bucket_with_http_info()`` method instead. + + Args: + body (:class:`~nipyapi.registry.models.Bucket`): + The updated bucket (required) + bucket_id (str): + The bucket identifier (required) + + Returns: + :class:`~nipyapi.registry.models.Bucket`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.update_bucket_with_http_info(bucket_id, body, **kwargs) + return self.update_bucket_with_http_info(body, bucket_id, **kwargs) else: - (data) = self.update_bucket_with_http_info(bucket_id, body, **kwargs) + (data) = self.update_bucket_with_http_info(body, bucket_id, **kwargs) return data - def update_bucket_with_http_info(self, bucket_id, body, **kwargs): + def update_bucket_with_http_info(self, body, bucket_id, **kwargs): """ - Update bucket + Update bucket. + Updates the bucket with the given id. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.update_bucket_with_http_info(bucket_id, body, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str bucket_id: The bucket identifier (required) - :param Bucket body: The updated bucket (required) - :return: Bucket - If the method is called asynchronously, - returns the request thread. + + 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 ``update_bucket()`` method instead. + + Args: + body (:class:`~nipyapi.registry.models.Bucket`): + The updated bucket (required) + bucket_id (str): + The bucket identifier (required) + + Returns: + tuple: (:class:`~nipyapi.registry.models.Bucket`, status_code, headers) - Response data with HTTP details. """ - all_params = ['bucket_id', 'body'] - all_params.append('callback') + all_params = ['body', 'bucket_id'] all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -625,14 +586,15 @@ def update_bucket_with_http_info(self, bucket_id, body, **kwargs): ) params[key] = val del params['kwargs'] - # verify the required parameter 'bucket_id' is set - if ('bucket_id' not in params) or (params['bucket_id'] is None): - raise ValueError("Missing the required parameter `bucket_id` when calling `update_bucket`") # verify the required parameter 'body' is set if ('body' not in params) or (params['body'] is None): raise ValueError("Missing the required parameter `body` when calling `update_bucket`") + # verify the required parameter 'bucket_id' is set + if ('bucket_id' not in params) or (params['bucket_id'] is None): + raise ValueError("Missing the required parameter `bucket_id` when calling `update_bucket`") - + + collection_formats = {} path_params = {} @@ -658,7 +620,7 @@ def update_bucket_with_http_info(self, bucket_id, body, **kwargs): select_header_content_type(['application/json']) # Authentication setting - auth_settings = ['tokenAuth', 'Authorization'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/buckets/{bucketId}', 'PUT', path_params, @@ -669,7 +631,6 @@ def update_bucket_with_http_info(self, bucket_id, body, **kwargs): files=local_var_files, response_type='Bucket', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), diff --git a/nipyapi/registry/apis/bundles_api.py b/nipyapi/registry/apis/bundles_api.py index 9bebc770..634a6095 100644 --- a/nipyapi/registry/apis/bundles_api.py +++ b/nipyapi/registry/apis/bundles_api.py @@ -1,14 +1,13 @@ """ Apache NiFi Registry REST API - The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components. + REST API definition for Apache NiFi Registry web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - import sys import os import re @@ -33,58 +32,51 @@ def __init__(self, api_client=None): config.api_client = ApiClient() self.api_client = config.api_client - def get_bundle_version_extension_additional_details_docs(self, bundle_id, version, name, **kwargs): + def delete_bundle(self, bundle_id, **kwargs): """ - Get bundle version extension docs details - Gets the additional details documentation for the given extension in the given extension bundle version. NOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_bundle_version_extension_additional_details_docs(bundle_id, version, name, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str bundle_id: The extension bundle identifier (required) - :param str version: The version of the bundle (required) - :param str name: The fully qualified name of the extension (required) - :return: str - If the method is called asynchronously, - returns the request thread. + Delete bundle. + + Deletes the given extension bundle and all of it's versions. NOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve. + + This method makes a synchronous HTTP request and returns the response data directly. + + For full HTTP response details (status code, headers, etc.), use the corresponding + ``delete_bundle_with_http_info()`` method instead. + + Args: + bundle_id (str): + The extension bundle identifier (required) + + Returns: + :class:`~nipyapi.registry.models.Bundle`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.get_bundle_version_extension_additional_details_docs_with_http_info(bundle_id, version, name, **kwargs) + return self.delete_bundle_with_http_info(bundle_id, **kwargs) else: - (data) = self.get_bundle_version_extension_additional_details_docs_with_http_info(bundle_id, version, name, **kwargs) + (data) = self.delete_bundle_with_http_info(bundle_id, **kwargs) return data - def get_bundle_version_extension_additional_details_docs_with_http_info(self, bundle_id, version, name, **kwargs): + def delete_bundle_with_http_info(self, bundle_id, **kwargs): """ - Get bundle version extension docs details - Gets the additional details documentation for the given extension in the given extension bundle version. NOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_bundle_version_extension_additional_details_docs_with_http_info(bundle_id, version, name, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str bundle_id: The extension bundle identifier (required) - :param str version: The version of the bundle (required) - :param str name: The fully qualified name of the extension (required) - :return: str - If the method is called asynchronously, - returns the request thread. + Delete bundle. + + Deletes the given extension bundle and all of it's versions. NOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve. + + This method makes a synchronous HTTP request 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_bundle()`` method instead. + + Args: + bundle_id (str): + The extension bundle identifier (required) + + Returns: + tuple: (:class:`~nipyapi.registry.models.Bundle`, status_code, headers) - Response data with HTTP details. """ - all_params = ['bundle_id', 'version', 'name'] - all_params.append('callback') + all_params = ['bundle_id'] all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -94,30 +86,20 @@ def get_bundle_version_extension_additional_details_docs_with_http_info(self, bu if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method get_bundle_version_extension_additional_details_docs" % key + " to method delete_bundle" % key ) params[key] = val del params['kwargs'] # verify the required parameter 'bundle_id' is set if ('bundle_id' not in params) or (params['bundle_id'] is None): - raise ValueError("Missing the required parameter `bundle_id` when calling `get_bundle_version_extension_additional_details_docs`") - # verify the required parameter 'version' is set - if ('version' not in params) or (params['version'] is None): - raise ValueError("Missing the required parameter `version` when calling `get_bundle_version_extension_additional_details_docs`") - # verify the required parameter 'name' is set - if ('name' not in params) or (params['name'] is None): - raise ValueError("Missing the required parameter `name` when calling `get_bundle_version_extension_additional_details_docs`") - + raise ValueError("Missing the required parameter `bundle_id` when calling `delete_bundle`") + collection_formats = {} path_params = {} if 'bundle_id' in params: path_params['bundleId'] = params['bundle_id'] - if 'version' in params: - path_params['version'] = params['version'] - if 'name' in params: - path_params['name'] = params['name'] query_params = [] @@ -129,82 +111,74 @@ def get_bundle_version_extension_additional_details_docs_with_http_info(self, bu body_params = None # HTTP header `Accept` header_params['Accept'] = self.api_client.\ - select_header_accept(['text/html']) - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['*/*']) + select_header_accept(['application/json']) # Authentication setting - auth_settings = ['tokenAuth', 'Authorization'] + auth_settings = ['bearerAuth'] - return self.api_client.call_api('/bundles/{bundleId}/versions/{version}/extensions/{name}/docs/additional-details', 'GET', + return self.api_client.call_api('/bundles/{bundleId}', 'DELETE', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, - response_type='str', + response_type='Bundle', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def get_bundle_version_extension_docs(self, bundle_id, version, name, **kwargs): + def delete_bundle_version(self, bundle_id, version, **kwargs): """ - Get bundle version extension docs - Gets the documentation for the given extension in the given extension bundle version. NOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_bundle_version_extension_docs(bundle_id, version, name, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str bundle_id: The extension bundle identifier (required) - :param str version: The version of the bundle (required) - :param str name: The fully qualified name of the extension (required) - :return: str - If the method is called asynchronously, - returns the request thread. + Delete bundle version. + + Deletes the given extension bundle version and it's associated binary content. NOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve. + + This method makes a synchronous HTTP request and returns the response data directly. + + For full HTTP response details (status code, headers, etc.), use the corresponding + ``delete_bundle_version_with_http_info()`` method instead. + + Args: + bundle_id (str): + The extension bundle identifier (required) + version (str): + The version of the bundle (required) + + Returns: + :class:`~nipyapi.registry.models.BundleVersion`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.get_bundle_version_extension_docs_with_http_info(bundle_id, version, name, **kwargs) + return self.delete_bundle_version_with_http_info(bundle_id, version, **kwargs) else: - (data) = self.get_bundle_version_extension_docs_with_http_info(bundle_id, version, name, **kwargs) + (data) = self.delete_bundle_version_with_http_info(bundle_id, version, **kwargs) return data - def get_bundle_version_extension_docs_with_http_info(self, bundle_id, version, name, **kwargs): + def delete_bundle_version_with_http_info(self, bundle_id, version, **kwargs): """ - Get bundle version extension docs - Gets the documentation for the given extension in the given extension bundle version. NOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_bundle_version_extension_docs_with_http_info(bundle_id, version, name, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str bundle_id: The extension bundle identifier (required) - :param str version: The version of the bundle (required) - :param str name: The fully qualified name of the extension (required) - :return: str - If the method is called asynchronously, - returns the request thread. + Delete bundle version. + + Deletes the given extension bundle version and it's associated binary content. NOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve. + + This method makes a synchronous HTTP request 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_bundle_version()`` method instead. + + Args: + bundle_id (str): + The extension bundle identifier (required) + version (str): + The version of the bundle (required) + + Returns: + tuple: (:class:`~nipyapi.registry.models.BundleVersion`, status_code, headers) - Response data with HTTP details. """ - all_params = ['bundle_id', 'version', 'name'] - all_params.append('callback') + all_params = ['bundle_id', 'version'] all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -214,21 +188,19 @@ def get_bundle_version_extension_docs_with_http_info(self, bundle_id, version, n if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method get_bundle_version_extension_docs" % key + " to method delete_bundle_version" % key ) params[key] = val del params['kwargs'] # verify the required parameter 'bundle_id' is set if ('bundle_id' not in params) or (params['bundle_id'] is None): - raise ValueError("Missing the required parameter `bundle_id` when calling `get_bundle_version_extension_docs`") + raise ValueError("Missing the required parameter `bundle_id` when calling `delete_bundle_version`") # verify the required parameter 'version' is set if ('version' not in params) or (params['version'] is None): - raise ValueError("Missing the required parameter `version` when calling `get_bundle_version_extension_docs`") - # verify the required parameter 'name' is set - if ('name' not in params) or (params['name'] is None): - raise ValueError("Missing the required parameter `name` when calling `get_bundle_version_extension_docs`") - + raise ValueError("Missing the required parameter `version` when calling `delete_bundle_version`") + + collection_formats = {} path_params = {} @@ -236,8 +208,6 @@ def get_bundle_version_extension_docs_with_http_info(self, bundle_id, version, n path_params['bundleId'] = params['bundle_id'] if 'version' in params: path_params['version'] = params['version'] - if 'name' in params: - path_params['name'] = params['name'] query_params = [] @@ -249,82 +219,70 @@ def get_bundle_version_extension_docs_with_http_info(self, bundle_id, version, n body_params = None # HTTP header `Accept` header_params['Accept'] = self.api_client.\ - select_header_accept(['text/html']) - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['*/*']) + select_header_accept(['application/json']) # Authentication setting - auth_settings = ['tokenAuth', 'Authorization'] + auth_settings = ['bearerAuth'] - return self.api_client.call_api('/bundles/{bundleId}/versions/{version}/extensions/{name}/docs', 'GET', + return self.api_client.call_api('/bundles/{bundleId}/versions/{version}', 'DELETE', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, - response_type='str', + response_type='BundleVersion', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def get_bundle_versions(self, **kwargs): + def get_bundle(self, bundle_id, **kwargs): """ - Get all bundle versions - Gets the metadata about extension bundle versions across all authorized buckets with optional filters applied. If the user is not authorized to any buckets, an empty list will be returned. NOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_bundle_versions(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str group_id: Optional groupId to filter results. The value may be an exact match, or a wildcard, such as 'com.%' to select all bundle versions where the groupId starts with 'com.'. - :param str artifact_id: Optional artifactId to filter results. The value may be an exact match, or a wildcard, such as 'nifi-%' to select all bundle versions where the artifactId starts with 'nifi-'. - :param str version: Optional version to filter results. The value maye be an exact match, or a wildcard, such as '1.0.%' to select all bundle versions where the version starts with '1.0.'. - :return: list[BundleVersionMetadata] - If the method is called asynchronously, - returns the request thread. + Get bundle. + + Gets the metadata about an extension bundle. NOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve. + + This method makes a synchronous HTTP request and returns the response data directly. + + For full HTTP response details (status code, headers, etc.), use the corresponding + ``get_bundle_with_http_info()`` method instead. + + Args: + bundle_id (str): + The extension bundle identifier (required) + + Returns: + :class:`~nipyapi.registry.models.Bundle`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.get_bundle_versions_with_http_info(**kwargs) + return self.get_bundle_with_http_info(bundle_id, **kwargs) else: - (data) = self.get_bundle_versions_with_http_info(**kwargs) + (data) = self.get_bundle_with_http_info(bundle_id, **kwargs) return data - def get_bundle_versions_with_http_info(self, **kwargs): + def get_bundle_with_http_info(self, bundle_id, **kwargs): """ - Get all bundle versions - Gets the metadata about extension bundle versions across all authorized buckets with optional filters applied. If the user is not authorized to any buckets, an empty list will be returned. NOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_bundle_versions_with_http_info(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str group_id: Optional groupId to filter results. The value may be an exact match, or a wildcard, such as 'com.%' to select all bundle versions where the groupId starts with 'com.'. - :param str artifact_id: Optional artifactId to filter results. The value may be an exact match, or a wildcard, such as 'nifi-%' to select all bundle versions where the artifactId starts with 'nifi-'. - :param str version: Optional version to filter results. The value maye be an exact match, or a wildcard, such as '1.0.%' to select all bundle versions where the version starts with '1.0.'. - :return: list[BundleVersionMetadata] - If the method is called asynchronously, - returns the request thread. + Get bundle. + + Gets the metadata about an extension bundle. NOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve. + + This method makes a synchronous HTTP request 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_bundle()`` method instead. + + Args: + bundle_id (str): + The extension bundle identifier (required) + + Returns: + tuple: (:class:`~nipyapi.registry.models.Bundle`, status_code, headers) - Response data with HTTP details. """ - all_params = ['group_id', 'artifact_id', 'version'] - all_params.append('callback') + all_params = ['bundle_id'] all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -334,23 +292,22 @@ def get_bundle_versions_with_http_info(self, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method get_bundle_versions" % key + " to method get_bundle" % key ) params[key] = val del params['kwargs'] + # verify the required parameter 'bundle_id' is set + if ('bundle_id' not in params) or (params['bundle_id'] is None): + raise ValueError("Missing the required parameter `bundle_id` when calling `get_bundle`") - + collection_formats = {} path_params = {} + if 'bundle_id' in params: + path_params['bundleId'] = params['bundle_id'] query_params = [] - if 'group_id' in params: - query_params.append(('groupId', params['group_id'])) - if 'artifact_id' in params: - query_params.append(('artifactId', params['artifact_id'])) - if 'version' in params: - query_params.append(('version', params['version'])) header_params = {} @@ -362,80 +319,72 @@ def get_bundle_versions_with_http_info(self, **kwargs): header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['*/*']) - # Authentication setting - auth_settings = ['tokenAuth', 'Authorization'] + auth_settings = ['bearerAuth'] - return self.api_client.call_api('/bundles/versions', 'GET', + return self.api_client.call_api('/bundles/{bundleId}', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, - response_type='list[BundleVersionMetadata]', + response_type='Bundle', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def get_bundles(self, **kwargs): + def get_bundle_version(self, bundle_id, version, **kwargs): """ - Get all bundles - Gets the metadata for all bundles across all authorized buckets with optional filters applied. The returned results will include only items from buckets for which the user is authorized. If the user is not authorized to any buckets, an empty list will be returned. NOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_bundles(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str bucket_name: Optional bucket name to filter results. The value may be an exact match, or a wildcard, such as 'My Bucket%' to select all bundles where the bucket name starts with 'My Bucket'. - :param str group_id: Optional groupId to filter results. The value may be an exact match, or a wildcard, such as 'com.%' to select all bundles where the groupId starts with 'com.'. - :param str artifact_id: Optional artifactId to filter results. The value may be an exact match, or a wildcard, such as 'nifi-%' to select all bundles where the artifactId starts with 'nifi-'. - :return: list[ExtensionBundle] - If the method is called asynchronously, - returns the request thread. + Get bundle version. + + Gets the descriptor for the given version of the given extension bundle. NOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve. + + This method makes a synchronous HTTP request and returns the response data directly. + + For full HTTP response details (status code, headers, etc.), use the corresponding + ``get_bundle_version_with_http_info()`` method instead. + + Args: + bundle_id (str): + The extension bundle identifier (required) + version (str): + The version of the bundle (required) + + Returns: + :class:`~nipyapi.registry.models.BundleVersion`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.get_bundles_with_http_info(**kwargs) + return self.get_bundle_version_with_http_info(bundle_id, version, **kwargs) else: - (data) = self.get_bundles_with_http_info(**kwargs) + (data) = self.get_bundle_version_with_http_info(bundle_id, version, **kwargs) return data - def get_bundles_with_http_info(self, **kwargs): + def get_bundle_version_with_http_info(self, bundle_id, version, **kwargs): """ - Get all bundles - Gets the metadata for all bundles across all authorized buckets with optional filters applied. The returned results will include only items from buckets for which the user is authorized. If the user is not authorized to any buckets, an empty list will be returned. NOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_bundles_with_http_info(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str bucket_name: Optional bucket name to filter results. The value may be an exact match, or a wildcard, such as 'My Bucket%' to select all bundles where the bucket name starts with 'My Bucket'. - :param str group_id: Optional groupId to filter results. The value may be an exact match, or a wildcard, such as 'com.%' to select all bundles where the groupId starts with 'com.'. - :param str artifact_id: Optional artifactId to filter results. The value may be an exact match, or a wildcard, such as 'nifi-%' to select all bundles where the artifactId starts with 'nifi-'. - :return: list[ExtensionBundle] - If the method is called asynchronously, - returns the request thread. + Get bundle version. + + Gets the descriptor for the given version of the given extension bundle. NOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve. + + This method makes a synchronous HTTP request 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_bundle_version()`` method instead. + + Args: + bundle_id (str): + The extension bundle identifier (required) + version (str): + The version of the bundle (required) + + Returns: + tuple: (:class:`~nipyapi.registry.models.BundleVersion`, status_code, headers) - Response data with HTTP details. """ - all_params = ['bucket_name', 'group_id', 'artifact_id'] - all_params.append('callback') + all_params = ['bundle_id', 'version'] all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -445,23 +394,28 @@ def get_bundles_with_http_info(self, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method get_bundles" % key + " to method get_bundle_version" % key ) params[key] = val del params['kwargs'] + # verify the required parameter 'bundle_id' is set + if ('bundle_id' not in params) or (params['bundle_id'] is None): + raise ValueError("Missing the required parameter `bundle_id` when calling `get_bundle_version`") + # verify the required parameter 'version' is set + if ('version' not in params) or (params['version'] is None): + raise ValueError("Missing the required parameter `version` when calling `get_bundle_version`") - + + collection_formats = {} path_params = {} + if 'bundle_id' in params: + path_params['bundleId'] = params['bundle_id'] + if 'version' in params: + path_params['version'] = params['version'] query_params = [] - if 'bucket_name' in params: - query_params.append(('bucketName', params['bucket_name'])) - if 'group_id' in params: - query_params.append(('groupId', params['group_id'])) - if 'artifact_id' in params: - query_params.append(('artifactId', params['artifact_id'])) header_params = {} @@ -473,78 +427,72 @@ def get_bundles_with_http_info(self, **kwargs): header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['*/*']) - # Authentication setting - auth_settings = ['tokenAuth', 'Authorization'] + auth_settings = ['bearerAuth'] - return self.api_client.call_api('/bundles', 'GET', + return self.api_client.call_api('/bundles/{bundleId}/versions/{version}', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, - response_type='list[ExtensionBundle]', + response_type='BundleVersion', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def global_delete_bundle_version(self, bundle_id, version, **kwargs): + def get_bundle_version_content(self, bundle_id, version, **kwargs): """ - Delete bundle version - Deletes the given extension bundle version and it's associated binary content. NOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.global_delete_bundle_version(bundle_id, version, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str bundle_id: The extension bundle identifier (required) - :param str version: The version of the bundle (required) - :return: BundleVersion - If the method is called asynchronously, - returns the request thread. + Get bundle version content. + + Gets the binary content for the given version of the given extension bundle. NOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve. + + This method makes a synchronous HTTP request and returns the response data directly. + + For full HTTP response details (status code, headers, etc.), use the corresponding + ``get_bundle_version_content_with_http_info()`` method instead. + + Args: + bundle_id (str): + The extension bundle identifier (required) + version (str): + The version of the bundle (required) + + Returns: + str: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.global_delete_bundle_version_with_http_info(bundle_id, version, **kwargs) + return self.get_bundle_version_content_with_http_info(bundle_id, version, **kwargs) else: - (data) = self.global_delete_bundle_version_with_http_info(bundle_id, version, **kwargs) + (data) = self.get_bundle_version_content_with_http_info(bundle_id, version, **kwargs) return data - def global_delete_bundle_version_with_http_info(self, bundle_id, version, **kwargs): + def get_bundle_version_content_with_http_info(self, bundle_id, version, **kwargs): """ - Delete bundle version - Deletes the given extension bundle version and it's associated binary content. NOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.global_delete_bundle_version_with_http_info(bundle_id, version, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str bundle_id: The extension bundle identifier (required) - :param str version: The version of the bundle (required) - :return: BundleVersion - If the method is called asynchronously, - returns the request thread. + Get bundle version content. + + Gets the binary content for the given version of the given extension bundle. NOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve. + + This method makes a synchronous HTTP request 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_bundle_version_content()`` method instead. + + Args: + bundle_id (str): + The extension bundle identifier (required) + version (str): + The version of the bundle (required) + + Returns: + tuple: (str, status_code, headers) - Response data with HTTP details. """ all_params = ['bundle_id', 'version'] - all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -554,18 +502,19 @@ def global_delete_bundle_version_with_http_info(self, bundle_id, version, **kwar if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method global_delete_bundle_version" % key + " to method get_bundle_version_content" % key ) params[key] = val del params['kwargs'] # verify the required parameter 'bundle_id' is set if ('bundle_id' not in params) or (params['bundle_id'] is None): - raise ValueError("Missing the required parameter `bundle_id` when calling `global_delete_bundle_version`") + raise ValueError("Missing the required parameter `bundle_id` when calling `get_bundle_version_content`") # verify the required parameter 'version' is set if ('version' not in params) or (params['version'] is None): - raise ValueError("Missing the required parameter `version` when calling `global_delete_bundle_version`") - + raise ValueError("Missing the required parameter `version` when calling `get_bundle_version_content`") + + collection_formats = {} path_params = {} @@ -584,78 +533,78 @@ def global_delete_bundle_version_with_http_info(self, bundle_id, version, **kwar body_params = None # HTTP header `Accept` header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['*/*']) + select_header_accept(['application/octet-stream']) # Authentication setting - auth_settings = ['tokenAuth', 'Authorization'] + auth_settings = ['bearerAuth'] - return self.api_client.call_api('/bundles/{bundleId}/versions/{version}', 'DELETE', + return self.api_client.call_api('/bundles/{bundleId}/versions/{version}/content', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, - response_type='BundleVersion', + response_type='str', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def global_delete_extension_bundle(self, bundle_id, **kwargs): + def get_bundle_version_extension(self, bundle_id, version, name, **kwargs): """ - Delete bundle - Deletes the given extension bundle and all of it's versions. NOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.global_delete_extension_bundle(bundle_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str bundle_id: The extension bundle identifier (required) - :return: ExtensionBundle - If the method is called asynchronously, - returns the request thread. + Get bundle version extension. + + Gets the metadata about the extension with the given name in the given extension bundle version. NOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve. + + This method makes a synchronous HTTP request and returns the response data directly. + + For full HTTP response details (status code, headers, etc.), use the corresponding + ``get_bundle_version_extension_with_http_info()`` method instead. + + Args: + bundle_id (str): + The extension bundle identifier (required) + version (str): + The version of the bundle (required) + name (str): + The fully qualified name of the extension (required) + + Returns: + :class:`~nipyapi.registry.models.list[Extension]`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.global_delete_extension_bundle_with_http_info(bundle_id, **kwargs) + return self.get_bundle_version_extension_with_http_info(bundle_id, version, name, **kwargs) else: - (data) = self.global_delete_extension_bundle_with_http_info(bundle_id, **kwargs) + (data) = self.get_bundle_version_extension_with_http_info(bundle_id, version, name, **kwargs) return data - def global_delete_extension_bundle_with_http_info(self, bundle_id, **kwargs): + def get_bundle_version_extension_with_http_info(self, bundle_id, version, name, **kwargs): """ - Delete bundle - Deletes the given extension bundle and all of it's versions. NOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.global_delete_extension_bundle_with_http_info(bundle_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str bundle_id: The extension bundle identifier (required) - :return: ExtensionBundle - If the method is called asynchronously, - returns the request thread. + Get bundle version extension. + + Gets the metadata about the extension with the given name in the given extension bundle version. NOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve. + + This method makes a synchronous HTTP request 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_bundle_version_extension()`` method instead. + + Args: + bundle_id (str): + The extension bundle identifier (required) + version (str): + The version of the bundle (required) + name (str): + The fully qualified name of the extension (required) + + Returns: + tuple: (:class:`~nipyapi.registry.models.list[Extension]`, status_code, headers) - Response data with HTTP details. """ - all_params = ['bundle_id'] - all_params.append('callback') + all_params = ['bundle_id', 'version', 'name'] all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -665,20 +614,32 @@ def global_delete_extension_bundle_with_http_info(self, bundle_id, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method global_delete_extension_bundle" % key + " to method get_bundle_version_extension" % key ) params[key] = val del params['kwargs'] # verify the required parameter 'bundle_id' is set if ('bundle_id' not in params) or (params['bundle_id'] is None): - raise ValueError("Missing the required parameter `bundle_id` when calling `global_delete_extension_bundle`") - + raise ValueError("Missing the required parameter `bundle_id` when calling `get_bundle_version_extension`") + # verify the required parameter 'version' is set + if ('version' not in params) or (params['version'] is None): + raise ValueError("Missing the required parameter `version` when calling `get_bundle_version_extension`") + # verify the required parameter 'name' is set + if ('name' not in params) or (params['name'] is None): + raise ValueError("Missing the required parameter `name` when calling `get_bundle_version_extension`") + + + collection_formats = {} path_params = {} if 'bundle_id' in params: path_params['bundleId'] = params['bundle_id'] + if 'version' in params: + path_params['version'] = params['version'] + if 'name' in params: + path_params['name'] = params['name'] query_params = [] @@ -692,78 +653,76 @@ def global_delete_extension_bundle_with_http_info(self, bundle_id, **kwargs): header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['*/*']) - # Authentication setting - auth_settings = ['tokenAuth', 'Authorization'] + auth_settings = ['bearerAuth'] - return self.api_client.call_api('/bundles/{bundleId}', 'DELETE', + return self.api_client.call_api('/bundles/{bundleId}/versions/{version}/extensions/{name}', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, - response_type='ExtensionBundle', + response_type='list[Extension]', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def global_get_bundle_version(self, bundle_id, version, **kwargs): + def get_bundle_version_extension_additional_details_docs(self, bundle_id, version, name, **kwargs): """ - Get bundle version - Gets the descriptor for the given version of the given extension bundle. NOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.global_get_bundle_version(bundle_id, version, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str bundle_id: The extension bundle identifier (required) - :param str version: The version of the bundle (required) - :return: BundleVersion - If the method is called asynchronously, - returns the request thread. + Get bundle version extension docs details. + + Gets the additional details documentation for the given extension in the given extension bundle version. NOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve. + + This method makes a synchronous HTTP request and returns the response data directly. + + For full HTTP response details (status code, headers, etc.), use the corresponding + ``get_bundle_version_extension_additional_details_docs_with_http_info()`` method instead. + + Args: + bundle_id (str): + The extension bundle identifier (required) + version (str): + The version of the bundle (required) + name (str): + The fully qualified name of the extension (required) + + Returns: + None """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.global_get_bundle_version_with_http_info(bundle_id, version, **kwargs) + return self.get_bundle_version_extension_additional_details_docs_with_http_info(bundle_id, version, name, **kwargs) else: - (data) = self.global_get_bundle_version_with_http_info(bundle_id, version, **kwargs) + (data) = self.get_bundle_version_extension_additional_details_docs_with_http_info(bundle_id, version, name, **kwargs) return data - def global_get_bundle_version_with_http_info(self, bundle_id, version, **kwargs): + def get_bundle_version_extension_additional_details_docs_with_http_info(self, bundle_id, version, name, **kwargs): """ - Get bundle version - Gets the descriptor for the given version of the given extension bundle. NOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.global_get_bundle_version_with_http_info(bundle_id, version, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str bundle_id: The extension bundle identifier (required) - :param str version: The version of the bundle (required) - :return: BundleVersion - If the method is called asynchronously, - returns the request thread. + Get bundle version extension docs details. + + Gets the additional details documentation for the given extension in the given extension bundle version. NOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve. + + This method makes a synchronous HTTP request 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_bundle_version_extension_additional_details_docs()`` method instead. + + Args: + bundle_id (str): + The extension bundle identifier (required) + version (str): + The version of the bundle (required) + name (str): + The fully qualified name of the extension (required) + + Returns: + tuple: (None, status_code, headers) - Response data with HTTP details. """ - all_params = ['bundle_id', 'version'] - all_params.append('callback') + all_params = ['bundle_id', 'version', 'name'] all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -773,18 +732,23 @@ def global_get_bundle_version_with_http_info(self, bundle_id, version, **kwargs) if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method global_get_bundle_version" % key + " to method get_bundle_version_extension_additional_details_docs" % key ) params[key] = val del params['kwargs'] # verify the required parameter 'bundle_id' is set if ('bundle_id' not in params) or (params['bundle_id'] is None): - raise ValueError("Missing the required parameter `bundle_id` when calling `global_get_bundle_version`") + raise ValueError("Missing the required parameter `bundle_id` when calling `get_bundle_version_extension_additional_details_docs`") # verify the required parameter 'version' is set if ('version' not in params) or (params['version'] is None): - raise ValueError("Missing the required parameter `version` when calling `global_get_bundle_version`") - + raise ValueError("Missing the required parameter `version` when calling `get_bundle_version_extension_additional_details_docs`") + # verify the required parameter 'name' is set + if ('name' not in params) or (params['name'] is None): + raise ValueError("Missing the required parameter `name` when calling `get_bundle_version_extension_additional_details_docs`") + + + collection_formats = {} path_params = {} @@ -792,6 +756,8 @@ def global_get_bundle_version_with_http_info(self, bundle_id, version, **kwargs) path_params['bundleId'] = params['bundle_id'] if 'version' in params: path_params['version'] = params['version'] + if 'name' in params: + path_params['name'] = params['name'] query_params = [] @@ -801,82 +767,76 @@ def global_get_bundle_version_with_http_info(self, bundle_id, version, **kwargs) local_var_files = {} body_params = None - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['*/*']) - # Authentication setting - auth_settings = ['tokenAuth', 'Authorization'] + auth_settings = ['bearerAuth'] - return self.api_client.call_api('/bundles/{bundleId}/versions/{version}', 'GET', + return self.api_client.call_api('/bundles/{bundleId}/versions/{version}/extensions/{name}/docs/additional-details', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, - response_type='BundleVersion', + response_type=None, auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def global_get_bundle_version_content(self, bundle_id, version, **kwargs): + def get_bundle_version_extension_docs(self, bundle_id, version, name, **kwargs): """ - Get bundle version content - Gets the binary content for the given version of the given extension bundle. NOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.global_get_bundle_version_content(bundle_id, version, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str bundle_id: The extension bundle identifier (required) - :param str version: The version of the bundle (required) - :return: list[str] - If the method is called asynchronously, - returns the request thread. + Get bundle version extension docs. + + Gets the documentation for the given extension in the given extension bundle version. NOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve. + + This method makes a synchronous HTTP request and returns the response data directly. + + For full HTTP response details (status code, headers, etc.), use the corresponding + ``get_bundle_version_extension_docs_with_http_info()`` method instead. + + Args: + bundle_id (str): + The extension bundle identifier (required) + version (str): + The version of the bundle (required) + name (str): + The fully qualified name of the extension (required) + + Returns: + None """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.global_get_bundle_version_content_with_http_info(bundle_id, version, **kwargs) + return self.get_bundle_version_extension_docs_with_http_info(bundle_id, version, name, **kwargs) else: - (data) = self.global_get_bundle_version_content_with_http_info(bundle_id, version, **kwargs) + (data) = self.get_bundle_version_extension_docs_with_http_info(bundle_id, version, name, **kwargs) return data - def global_get_bundle_version_content_with_http_info(self, bundle_id, version, **kwargs): + def get_bundle_version_extension_docs_with_http_info(self, bundle_id, version, name, **kwargs): """ - Get bundle version content - Gets the binary content for the given version of the given extension bundle. NOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.global_get_bundle_version_content_with_http_info(bundle_id, version, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str bundle_id: The extension bundle identifier (required) - :param str version: The version of the bundle (required) - :return: list[str] - If the method is called asynchronously, - returns the request thread. + Get bundle version extension docs. + + Gets the documentation for the given extension in the given extension bundle version. NOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve. + + This method makes a synchronous HTTP request 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_bundle_version_extension_docs()`` method instead. + + Args: + bundle_id (str): + The extension bundle identifier (required) + version (str): + The version of the bundle (required) + name (str): + The fully qualified name of the extension (required) + + Returns: + tuple: (None, status_code, headers) - Response data with HTTP details. """ - all_params = ['bundle_id', 'version'] - all_params.append('callback') + all_params = ['bundle_id', 'version', 'name'] all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -886,18 +846,23 @@ def global_get_bundle_version_content_with_http_info(self, bundle_id, version, * if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method global_get_bundle_version_content" % key + " to method get_bundle_version_extension_docs" % key ) params[key] = val del params['kwargs'] # verify the required parameter 'bundle_id' is set if ('bundle_id' not in params) or (params['bundle_id'] is None): - raise ValueError("Missing the required parameter `bundle_id` when calling `global_get_bundle_version_content`") + raise ValueError("Missing the required parameter `bundle_id` when calling `get_bundle_version_extension_docs`") # verify the required parameter 'version' is set if ('version' not in params) or (params['version'] is None): - raise ValueError("Missing the required parameter `version` when calling `global_get_bundle_version_content`") - + raise ValueError("Missing the required parameter `version` when calling `get_bundle_version_extension_docs`") + # verify the required parameter 'name' is set + if ('name' not in params) or (params['name'] is None): + raise ValueError("Missing the required parameter `name` when calling `get_bundle_version_extension_docs`") + + + collection_formats = {} path_params = {} @@ -905,6 +870,8 @@ def global_get_bundle_version_content_with_http_info(self, bundle_id, version, * path_params['bundleId'] = params['bundle_id'] if 'version' in params: path_params['version'] = params['version'] + if 'name' in params: + path_params['name'] = params['name'] query_params = [] @@ -914,84 +881,72 @@ def global_get_bundle_version_content_with_http_info(self, bundle_id, version, * local_var_files = {} body_params = None - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/octet-stream']) - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['*/*']) - # Authentication setting - auth_settings = ['tokenAuth', 'Authorization'] + auth_settings = ['bearerAuth'] - return self.api_client.call_api('/bundles/{bundleId}/versions/{version}/content', 'GET', + return self.api_client.call_api('/bundles/{bundleId}/versions/{version}/extensions/{name}/docs', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, - response_type='list[str]', + response_type=None, auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def global_get_bundle_version_extension(self, bundle_id, version, name, **kwargs): + def get_bundle_version_extensions(self, bundle_id, version, **kwargs): """ - Get bundle version extension - Gets the metadata about the extension with the given name in the given extension bundle version. NOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.global_get_bundle_version_extension(bundle_id, version, name, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str bundle_id: The extension bundle identifier (required) - :param str version: The version of the bundle (required) - :param str name: The fully qualified name of the extension (required) - :return: list[Extension] - If the method is called asynchronously, - returns the request thread. + Get bundle version extensions. + + Gets the metadata about the extensions in the given extension bundle version. NOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve. + + This method makes a synchronous HTTP request and returns the response data directly. + + For full HTTP response details (status code, headers, etc.), use the corresponding + ``get_bundle_version_extensions_with_http_info()`` method instead. + + Args: + bundle_id (str): + The extension bundle identifier (required) + version (str): + The version of the bundle (required) + + Returns: + :class:`~nipyapi.registry.models.list[ExtensionMetadata]`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.global_get_bundle_version_extension_with_http_info(bundle_id, version, name, **kwargs) + return self.get_bundle_version_extensions_with_http_info(bundle_id, version, **kwargs) else: - (data) = self.global_get_bundle_version_extension_with_http_info(bundle_id, version, name, **kwargs) + (data) = self.get_bundle_version_extensions_with_http_info(bundle_id, version, **kwargs) return data - def global_get_bundle_version_extension_with_http_info(self, bundle_id, version, name, **kwargs): + def get_bundle_version_extensions_with_http_info(self, bundle_id, version, **kwargs): """ - Get bundle version extension - Gets the metadata about the extension with the given name in the given extension bundle version. NOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.global_get_bundle_version_extension_with_http_info(bundle_id, version, name, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str bundle_id: The extension bundle identifier (required) - :param str version: The version of the bundle (required) - :param str name: The fully qualified name of the extension (required) - :return: list[Extension] - If the method is called asynchronously, - returns the request thread. + Get bundle version extensions. + + Gets the metadata about the extensions in the given extension bundle version. NOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve. + + This method makes a synchronous HTTP request 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_bundle_version_extensions()`` method instead. + + Args: + bundle_id (str): + The extension bundle identifier (required) + version (str): + The version of the bundle (required) + + Returns: + tuple: (:class:`~nipyapi.registry.models.list[ExtensionMetadata]`, status_code, headers) - Response data with HTTP details. """ - all_params = ['bundle_id', 'version', 'name'] - all_params.append('callback') + all_params = ['bundle_id', 'version'] all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -1001,21 +956,19 @@ def global_get_bundle_version_extension_with_http_info(self, bundle_id, version, if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method global_get_bundle_version_extension" % key + " to method get_bundle_version_extensions" % key ) params[key] = val del params['kwargs'] # verify the required parameter 'bundle_id' is set if ('bundle_id' not in params) or (params['bundle_id'] is None): - raise ValueError("Missing the required parameter `bundle_id` when calling `global_get_bundle_version_extension`") + raise ValueError("Missing the required parameter `bundle_id` when calling `get_bundle_version_extensions`") # verify the required parameter 'version' is set if ('version' not in params) or (params['version'] is None): - raise ValueError("Missing the required parameter `version` when calling `global_get_bundle_version_extension`") - # verify the required parameter 'name' is set - if ('name' not in params) or (params['name'] is None): - raise ValueError("Missing the required parameter `name` when calling `global_get_bundle_version_extension`") - + raise ValueError("Missing the required parameter `version` when calling `get_bundle_version_extensions`") + + collection_formats = {} path_params = {} @@ -1023,8 +976,6 @@ def global_get_bundle_version_extension_with_http_info(self, bundle_id, version, path_params['bundleId'] = params['bundle_id'] if 'version' in params: path_params['version'] = params['version'] - if 'name' in params: - path_params['name'] = params['name'] query_params = [] @@ -1038,78 +989,68 @@ def global_get_bundle_version_extension_with_http_info(self, bundle_id, version, header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['*/*']) - # Authentication setting - auth_settings = ['tokenAuth', 'Authorization'] + auth_settings = ['bearerAuth'] - return self.api_client.call_api('/bundles/{bundleId}/versions/{version}/extensions/{name}', 'GET', + return self.api_client.call_api('/bundles/{bundleId}/versions/{version}/extensions', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, - response_type='list[Extension]', + response_type='list[ExtensionMetadata]', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def global_get_bundle_version_extensions(self, bundle_id, version, **kwargs): + def get_bundle_versions(self, bundle_id, **kwargs): """ - Get bundle version extensions - Gets the metadata about the extensions in the given extension bundle version. NOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.global_get_bundle_version_extensions(bundle_id, version, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str bundle_id: The extension bundle identifier (required) - :param str version: The version of the bundle (required) - :return: list[ExtensionMetadata] - If the method is called asynchronously, - returns the request thread. + Get bundle versions. + + Gets the metadata for the versions of the given extension bundle. NOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve. + + This method makes a synchronous HTTP request and returns the response data directly. + + For full HTTP response details (status code, headers, etc.), use the corresponding + ``get_bundle_versions_with_http_info()`` method instead. + + Args: + bundle_id (str): + The extension bundle identifier (required) + + Returns: + :class:`~nipyapi.registry.models.list[BundleVersionMetadata]`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.global_get_bundle_version_extensions_with_http_info(bundle_id, version, **kwargs) + return self.get_bundle_versions_with_http_info(bundle_id, **kwargs) else: - (data) = self.global_get_bundle_version_extensions_with_http_info(bundle_id, version, **kwargs) + (data) = self.get_bundle_versions_with_http_info(bundle_id, **kwargs) return data - def global_get_bundle_version_extensions_with_http_info(self, bundle_id, version, **kwargs): + def get_bundle_versions_with_http_info(self, bundle_id, **kwargs): """ - Get bundle version extensions - Gets the metadata about the extensions in the given extension bundle version. NOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.global_get_bundle_version_extensions_with_http_info(bundle_id, version, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str bundle_id: The extension bundle identifier (required) - :param str version: The version of the bundle (required) - :return: list[ExtensionMetadata] - If the method is called asynchronously, - returns the request thread. + Get bundle versions. + + Gets the metadata for the versions of the given extension bundle. NOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve. + + This method makes a synchronous HTTP request 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_bundle_versions()`` method instead. + + Args: + bundle_id (str): + The extension bundle identifier (required) + + Returns: + tuple: (:class:`~nipyapi.registry.models.list[BundleVersionMetadata]`, status_code, headers) - Response data with HTTP details. """ - all_params = ['bundle_id', 'version'] - all_params.append('callback') + all_params = ['bundle_id'] all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -1119,25 +1060,20 @@ def global_get_bundle_version_extensions_with_http_info(self, bundle_id, version if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method global_get_bundle_version_extensions" % key + " to method get_bundle_versions" % key ) params[key] = val del params['kwargs'] # verify the required parameter 'bundle_id' is set if ('bundle_id' not in params) or (params['bundle_id'] is None): - raise ValueError("Missing the required parameter `bundle_id` when calling `global_get_bundle_version_extensions`") - # verify the required parameter 'version' is set - if ('version' not in params) or (params['version'] is None): - raise ValueError("Missing the required parameter `version` when calling `global_get_bundle_version_extensions`") - + raise ValueError("Missing the required parameter `bundle_id` when calling `get_bundle_versions`") + collection_formats = {} path_params = {} if 'bundle_id' in params: path_params['bundleId'] = params['bundle_id'] - if 'version' in params: - path_params['version'] = params['version'] query_params = [] @@ -1151,76 +1087,76 @@ def global_get_bundle_version_extensions_with_http_info(self, bundle_id, version header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['*/*']) - # Authentication setting - auth_settings = ['tokenAuth', 'Authorization'] + auth_settings = ['bearerAuth'] - return self.api_client.call_api('/bundles/{bundleId}/versions/{version}/extensions', 'GET', + return self.api_client.call_api('/bundles/{bundleId}/versions', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, - response_type='list[ExtensionMetadata]', + response_type='list[BundleVersionMetadata]', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def global_get_bundle_versions(self, bundle_id, **kwargs): + def get_bundle_versions1(self, **kwargs): """ - Get bundle versions - Gets the metadata for the versions of the given extension bundle. NOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.global_get_bundle_versions(bundle_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str bundle_id: The extension bundle identifier (required) - :return: list[BundleVersionMetadata] - If the method is called asynchronously, - returns the request thread. + Get all bundle versions. + + Gets the metadata about extension bundle versions across all authorized buckets with optional filters applied. If the user is not authorized to any buckets, an empty list will be returned. NOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve. + + This method makes a synchronous HTTP request and returns the response data directly. + + For full HTTP response details (status code, headers, etc.), use the corresponding + ``get_bundle_versions1_with_http_info()`` method instead. + + Args: + group_id (str): + 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.'. + 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.'. + + Returns: + :class:`~nipyapi.registry.models.list[BundleVersionMetadata]`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.global_get_bundle_versions_with_http_info(bundle_id, **kwargs) + return self.get_bundle_versions1_with_http_info(**kwargs) else: - (data) = self.global_get_bundle_versions_with_http_info(bundle_id, **kwargs) + (data) = self.get_bundle_versions1_with_http_info(**kwargs) return data - def global_get_bundle_versions_with_http_info(self, bundle_id, **kwargs): + def get_bundle_versions1_with_http_info(self, **kwargs): """ - Get bundle versions - Gets the metadata for the versions of the given extension bundle. NOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.global_get_bundle_versions_with_http_info(bundle_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str bundle_id: The extension bundle identifier (required) - :return: list[BundleVersionMetadata] - If the method is called asynchronously, - returns the request thread. + Get all bundle versions. + + Gets the metadata about extension bundle versions across all authorized buckets with optional filters applied. If the user is not authorized to any buckets, an empty list will be returned. NOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve. + + This method makes a synchronous HTTP request 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_bundle_versions1()`` method instead. + + Args: + group_id (str): + 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.'. + 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.'. + + Returns: + tuple: (:class:`~nipyapi.registry.models.list[BundleVersionMetadata]`, status_code, headers) - Response data with HTTP details. """ - all_params = ['bundle_id'] - all_params.append('callback') + all_params = ['group_id', 'artifact_id', 'version'] all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -1230,22 +1166,25 @@ def global_get_bundle_versions_with_http_info(self, bundle_id, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method global_get_bundle_versions" % key + " to method get_bundle_versions1" % key ) params[key] = val del params['kwargs'] - # verify the required parameter 'bundle_id' is set - if ('bundle_id' not in params) or (params['bundle_id'] is None): - raise ValueError("Missing the required parameter `bundle_id` when calling `global_get_bundle_versions`") - + + + collection_formats = {} path_params = {} - if 'bundle_id' in params: - path_params['bundleId'] = params['bundle_id'] query_params = [] + if 'group_id' in params: + query_params.append(('groupId', params['group_id'])) + if 'artifact_id' in params: + query_params.append(('artifactId', params['artifact_id'])) + if 'version' in params: + query_params.append(('version', params['version'])) header_params = {} @@ -1257,14 +1196,10 @@ def global_get_bundle_versions_with_http_info(self, bundle_id, **kwargs): header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['*/*']) - # Authentication setting - auth_settings = ['tokenAuth', 'Authorization'] + auth_settings = ['bearerAuth'] - return self.api_client.call_api('/bundles/{bundleId}/versions', 'GET', + return self.api_client.call_api('/bundles/versions', 'GET', path_params, query_params, header_params, @@ -1273,60 +1208,64 @@ def global_get_bundle_versions_with_http_info(self, bundle_id, **kwargs): files=local_var_files, response_type='list[BundleVersionMetadata]', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def global_get_extension_bundle(self, bundle_id, **kwargs): + def get_bundles(self, **kwargs): """ - Get bundle - Gets the metadata about an extension bundle. NOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.global_get_extension_bundle(bundle_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str bundle_id: The extension bundle identifier (required) - :return: ExtensionBundle - If the method is called asynchronously, - returns the request thread. + Get all bundles. + + Gets the metadata for all bundles across all authorized buckets with optional filters applied. The returned results will include only items from buckets for which the user is authorized. If the user is not authorized to any buckets, an empty list will be returned. NOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve. + + This method makes a synchronous HTTP request and returns the response data directly. + + For full HTTP response details (status code, headers, etc.), use the corresponding + ``get_bundles_with_http_info()`` method instead. + + Args: + bucket_name (str): + 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'. + group_id (str): + 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.'. + artifact_id (str): + 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-'. + + Returns: + :class:`~nipyapi.registry.models.list[Bundle]`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.global_get_extension_bundle_with_http_info(bundle_id, **kwargs) + return self.get_bundles_with_http_info(**kwargs) else: - (data) = self.global_get_extension_bundle_with_http_info(bundle_id, **kwargs) + (data) = self.get_bundles_with_http_info(**kwargs) return data - def global_get_extension_bundle_with_http_info(self, bundle_id, **kwargs): + def get_bundles_with_http_info(self, **kwargs): """ - Get bundle - Gets the metadata about an extension bundle. NOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.global_get_extension_bundle_with_http_info(bundle_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str bundle_id: The extension bundle identifier (required) - :return: ExtensionBundle - If the method is called asynchronously, - returns the request thread. + Get all bundles. + + Gets the metadata for all bundles across all authorized buckets with optional filters applied. The returned results will include only items from buckets for which the user is authorized. If the user is not authorized to any buckets, an empty list will be returned. NOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve. + + This method makes a synchronous HTTP request 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_bundles()`` method instead. + + Args: + bucket_name (str): + 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'. + group_id (str): + 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.'. + artifact_id (str): + 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-'. + + Returns: + tuple: (:class:`~nipyapi.registry.models.list[Bundle]`, status_code, headers) - Response data with HTTP details. """ - all_params = ['bundle_id'] - all_params.append('callback') + all_params = ['bucket_name', 'group_id', 'artifact_id'] all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -1336,22 +1275,25 @@ def global_get_extension_bundle_with_http_info(self, bundle_id, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method global_get_extension_bundle" % key + " to method get_bundles" % key ) params[key] = val del params['kwargs'] - # verify the required parameter 'bundle_id' is set - if ('bundle_id' not in params) or (params['bundle_id'] is None): - raise ValueError("Missing the required parameter `bundle_id` when calling `global_get_extension_bundle`") - + + + collection_formats = {} path_params = {} - if 'bundle_id' in params: - path_params['bundleId'] = params['bundle_id'] query_params = [] + if 'bucket_name' in params: + query_params.append(('bucketName', params['bucket_name'])) + if 'group_id' in params: + query_params.append(('groupId', params['group_id'])) + if 'artifact_id' in params: + query_params.append(('artifactId', params['artifact_id'])) header_params = {} @@ -1363,23 +1305,18 @@ def global_get_extension_bundle_with_http_info(self, bundle_id, **kwargs): header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['*/*']) - # Authentication setting - auth_settings = ['tokenAuth', 'Authorization'] + auth_settings = ['bearerAuth'] - return self.api_client.call_api('/bundles/{bundleId}', 'GET', + return self.api_client.call_api('/bundles', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, - response_type='ExtensionBundle', + response_type='list[Bundle]', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), diff --git a/nipyapi/registry/apis/config_api.py b/nipyapi/registry/apis/config_api.py index e3977181..3db7c63e 100644 --- a/nipyapi/registry/apis/config_api.py +++ b/nipyapi/registry/apis/config_api.py @@ -1,14 +1,13 @@ """ Apache NiFi Registry REST API - The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components. + REST API definition for Apache NiFi Registry web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - import sys import os import re @@ -35,21 +34,19 @@ def __init__(self, api_client=None): def get_configuration(self, **kwargs): """ - Get configration + Get configration. + Gets the NiFi Registry configurations. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_configuration(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :return: RegistryConfiguration - If the method is called asynchronously, - returns the request thread. + + 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_configuration_with_http_info()`` method instead. + + Args: + + Returns: + :class:`~nipyapi.registry.models.RegistryConfiguration`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): @@ -60,25 +57,22 @@ def get_configuration(self, **kwargs): def get_configuration_with_http_info(self, **kwargs): """ - Get configration + Get configration. + Gets the NiFi Registry configurations. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_configuration_with_http_info(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :return: RegistryConfiguration - If the method is called asynchronously, - returns the request thread. + + 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_configuration()`` method instead. + + Args: + + Returns: + tuple: (:class:`~nipyapi.registry.models.RegistryConfiguration`, status_code, headers) - Response data with HTTP details. """ all_params = [] - all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -109,12 +103,8 @@ def get_configuration_with_http_info(self, **kwargs): header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['*/*']) - # Authentication setting - auth_settings = ['tokenAuth', 'Authorization'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/config', 'GET', path_params, @@ -125,7 +115,6 @@ def get_configuration_with_http_info(self, **kwargs): files=local_var_files, response_type='RegistryConfiguration', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), diff --git a/nipyapi/registry/apis/extension_repository_api.py b/nipyapi/registry/apis/extension_repository_api.py index 048c49a2..84332682 100644 --- a/nipyapi/registry/apis/extension_repository_api.py +++ b/nipyapi/registry/apis/extension_repository_api.py @@ -1,14 +1,13 @@ """ Apache NiFi Registry REST API - The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components. + REST API definition for Apache NiFi Registry web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - import sys import os import re @@ -35,23 +34,23 @@ def __init__(self, api_client=None): def get_extension_repo_artifacts(self, bucket_name, group_id, **kwargs): """ - Get extension repo artifacts + Get extension repo artifacts. + Gets the artifacts in the extension repository in the given bucket and group. NOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_extension_repo_artifacts(bucket_name, group_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str bucket_name: The bucket name (required) - :param str group_id: The group id (required) - :return: list[ExtensionRepoArtifact] - If the method is called asynchronously, - returns the request thread. + + 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_extension_repo_artifacts_with_http_info()`` method instead. + + Args: + bucket_name (str): + The bucket name (required) + group_id (str): + The group id (required) + + Returns: + :class:`~nipyapi.registry.models.list[ExtensionRepoArtifact]`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): @@ -62,27 +61,26 @@ def get_extension_repo_artifacts(self, bucket_name, group_id, **kwargs): def get_extension_repo_artifacts_with_http_info(self, bucket_name, group_id, **kwargs): """ - Get extension repo artifacts + Get extension repo artifacts. + Gets the artifacts in the extension repository in the given bucket and group. NOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_extension_repo_artifacts_with_http_info(bucket_name, group_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str bucket_name: The bucket name (required) - :param str group_id: The group id (required) - :return: list[ExtensionRepoArtifact] - If the method is called asynchronously, - returns the request thread. + + 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_extension_repo_artifacts()`` method instead. + + Args: + bucket_name (str): + The bucket name (required) + group_id (str): + The group id (required) + + Returns: + tuple: (:class:`~nipyapi.registry.models.list[ExtensionRepoArtifact]`, status_code, headers) - Response data with HTTP details. """ all_params = ['bucket_name', 'group_id'] - all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -103,7 +101,8 @@ def get_extension_repo_artifacts_with_http_info(self, bucket_name, group_id, **k if ('group_id' not in params) or (params['group_id'] is None): raise ValueError("Missing the required parameter `group_id` when calling `get_extension_repo_artifacts`") - + + collection_formats = {} path_params = {} @@ -124,12 +123,8 @@ def get_extension_repo_artifacts_with_http_info(self, bucket_name, group_id, **k header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['*/*']) - # Authentication setting - auth_settings = ['tokenAuth', 'Authorization'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/extension-repository/{bucketName}/{groupId}', 'GET', path_params, @@ -140,7 +135,6 @@ def get_extension_repo_artifacts_with_http_info(self, bucket_name, group_id, **k files=local_var_files, response_type='list[ExtensionRepoArtifact]', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), @@ -148,21 +142,19 @@ def get_extension_repo_artifacts_with_http_info(self, bucket_name, group_id, **k def get_extension_repo_buckets(self, **kwargs): """ - Get extension repo buckets + Get extension repo buckets. + Gets the names of the buckets the current user is authorized for in order to browse the repo by bucket. NOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_extension_repo_buckets(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :return: list[ExtensionRepoBucket] - If the method is called asynchronously, - returns the request thread. + + 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_extension_repo_buckets_with_http_info()`` method instead. + + Args: + + Returns: + :class:`~nipyapi.registry.models.list[ExtensionRepoBucket]`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): @@ -173,25 +165,22 @@ def get_extension_repo_buckets(self, **kwargs): def get_extension_repo_buckets_with_http_info(self, **kwargs): """ - Get extension repo buckets + Get extension repo buckets. + Gets the names of the buckets the current user is authorized for in order to browse the repo by bucket. NOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_extension_repo_buckets_with_http_info(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :return: list[ExtensionRepoBucket] - If the method is called asynchronously, - returns the request thread. + + 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_extension_repo_buckets()`` method instead. + + Args: + + Returns: + tuple: (:class:`~nipyapi.registry.models.list[ExtensionRepoBucket]`, status_code, headers) - Response data with HTTP details. """ all_params = [] - all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -222,12 +211,8 @@ def get_extension_repo_buckets_with_http_info(self, **kwargs): header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['*/*']) - # Authentication setting - auth_settings = ['tokenAuth', 'Authorization'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/extension-repository', 'GET', path_params, @@ -238,7 +223,6 @@ def get_extension_repo_buckets_with_http_info(self, **kwargs): files=local_var_files, response_type='list[ExtensionRepoBucket]', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), @@ -246,22 +230,21 @@ def get_extension_repo_buckets_with_http_info(self, **kwargs): def get_extension_repo_groups(self, bucket_name, **kwargs): """ - Get extension repo groups + Get extension repo groups. + Gets the groups in the extension repository in the given bucket. NOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_extension_repo_groups(bucket_name, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str bucket_name: The bucket name (required) - :return: list[ExtensionRepoGroup] - If the method is called asynchronously, - returns the request thread. + + 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_extension_repo_groups_with_http_info()`` method instead. + + Args: + bucket_name (str): + The bucket name (required) + + Returns: + :class:`~nipyapi.registry.models.list[ExtensionRepoGroup]`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): @@ -272,26 +255,24 @@ def get_extension_repo_groups(self, bucket_name, **kwargs): def get_extension_repo_groups_with_http_info(self, bucket_name, **kwargs): """ - Get extension repo groups + Get extension repo groups. + Gets the groups in the extension repository in the given bucket. NOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_extension_repo_groups_with_http_info(bucket_name, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str bucket_name: The bucket name (required) - :return: list[ExtensionRepoGroup] - If the method is called asynchronously, - returns the request thread. + + 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_extension_repo_groups()`` method instead. + + Args: + bucket_name (str): + The bucket name (required) + + Returns: + tuple: (:class:`~nipyapi.registry.models.list[ExtensionRepoGroup]`, status_code, headers) - Response data with HTTP details. """ all_params = ['bucket_name'] - all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -309,7 +290,7 @@ def get_extension_repo_groups_with_http_info(self, bucket_name, **kwargs): if ('bucket_name' not in params) or (params['bucket_name'] is None): raise ValueError("Missing the required parameter `bucket_name` when calling `get_extension_repo_groups`") - + collection_formats = {} path_params = {} @@ -328,12 +309,8 @@ def get_extension_repo_groups_with_http_info(self, bucket_name, **kwargs): header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['*/*']) - # Authentication setting - auth_settings = ['tokenAuth', 'Authorization'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/extension-repository/{bucketName}', 'GET', path_params, @@ -344,7 +321,6 @@ def get_extension_repo_groups_with_http_info(self, bucket_name, **kwargs): files=local_var_files, response_type='list[ExtensionRepoGroup]', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), @@ -352,25 +328,27 @@ def get_extension_repo_groups_with_http_info(self, bucket_name, **kwargs): def get_extension_repo_version(self, bucket_name, group_id, artifact_id, version, **kwargs): """ - Get extension repo version + Get extension repo version. + Gets information about the version in the given bucket, group, and artifact. NOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_extension_repo_version(bucket_name, group_id, artifact_id, version, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str bucket_name: The bucket name (required) - :param str group_id: The group identifier (required) - :param str artifact_id: The artifact identifier (required) - :param str version: The version (required) - :return: ExtensionRepoVersion - If the method is called asynchronously, - returns the request thread. + + 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_extension_repo_version_with_http_info()`` method instead. + + Args: + bucket_name (str): + The bucket name (required) + group_id (str): + The group identifier (required) + artifact_id (str): + The artifact identifier (required) + version (str): + The version (required) + + Returns: + :class:`~nipyapi.registry.models.ExtensionRepoVersion`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): @@ -381,29 +359,30 @@ def get_extension_repo_version(self, bucket_name, group_id, artifact_id, version def get_extension_repo_version_with_http_info(self, bucket_name, group_id, artifact_id, version, **kwargs): """ - Get extension repo version + Get extension repo version. + Gets information about the version in the given bucket, group, and artifact. NOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_extension_repo_version_with_http_info(bucket_name, group_id, artifact_id, version, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str bucket_name: The bucket name (required) - :param str group_id: The group identifier (required) - :param str artifact_id: The artifact identifier (required) - :param str version: The version (required) - :return: ExtensionRepoVersion - If the method is called asynchronously, - returns the request thread. + + 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_extension_repo_version()`` method instead. + + Args: + bucket_name (str): + The bucket name (required) + group_id (str): + The group identifier (required) + artifact_id (str): + The artifact identifier (required) + version (str): + The version (required) + + Returns: + tuple: (:class:`~nipyapi.registry.models.ExtensionRepoVersion`, status_code, headers) - Response data with HTTP details. """ all_params = ['bucket_name', 'group_id', 'artifact_id', 'version'] - all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -430,7 +409,10 @@ def get_extension_repo_version_with_http_info(self, bucket_name, group_id, artif if ('version' not in params) or (params['version'] is None): raise ValueError("Missing the required parameter `version` when calling `get_extension_repo_version`") - + + + + collection_formats = {} path_params = {} @@ -455,12 +437,8 @@ def get_extension_repo_version_with_http_info(self, bucket_name, group_id, artif header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['*/*']) - # Authentication setting - auth_settings = ['tokenAuth', 'Authorization'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/extension-repository/{bucketName}/{groupId}/{artifactId}/{version}', 'GET', path_params, @@ -471,7 +449,6 @@ def get_extension_repo_version_with_http_info(self, bucket_name, group_id, artif files=local_var_files, response_type='ExtensionRepoVersion', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), @@ -479,25 +456,27 @@ def get_extension_repo_version_with_http_info(self, bucket_name, group_id, artif def get_extension_repo_version_content(self, bucket_name, group_id, artifact_id, version, **kwargs): """ - Get extension repo version content + Get extension repo version content. + Gets the binary content of the bundle with the given bucket, group, artifact, and version. NOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_extension_repo_version_content(bucket_name, group_id, artifact_id, version, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str bucket_name: The bucket name (required) - :param str group_id: The group identifier (required) - :param str artifact_id: The artifact identifier (required) - :param str version: The version (required) - :return: list[str] - If the method is called asynchronously, - returns the request thread. + + 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_extension_repo_version_content_with_http_info()`` method instead. + + Args: + bucket_name (str): + The bucket name (required) + group_id (str): + The group identifier (required) + artifact_id (str): + The artifact identifier (required) + version (str): + The version (required) + + Returns: + str: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): @@ -508,29 +487,30 @@ def get_extension_repo_version_content(self, bucket_name, group_id, artifact_id, def get_extension_repo_version_content_with_http_info(self, bucket_name, group_id, artifact_id, version, **kwargs): """ - Get extension repo version content + Get extension repo version content. + Gets the binary content of the bundle with the given bucket, group, artifact, and version. NOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_extension_repo_version_content_with_http_info(bucket_name, group_id, artifact_id, version, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str bucket_name: The bucket name (required) - :param str group_id: The group identifier (required) - :param str artifact_id: The artifact identifier (required) - :param str version: The version (required) - :return: list[str] - If the method is called asynchronously, - returns the request thread. + + 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_extension_repo_version_content()`` method instead. + + Args: + bucket_name (str): + The bucket name (required) + group_id (str): + The group identifier (required) + artifact_id (str): + The artifact identifier (required) + version (str): + The version (required) + + Returns: + tuple: (str, status_code, headers) - Response data with HTTP details. """ all_params = ['bucket_name', 'group_id', 'artifact_id', 'version'] - all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -557,7 +537,10 @@ def get_extension_repo_version_content_with_http_info(self, bucket_name, group_i if ('version' not in params) or (params['version'] is None): raise ValueError("Missing the required parameter `version` when calling `get_extension_repo_version_content`") - + + + + collection_formats = {} path_params = {} @@ -582,12 +565,8 @@ def get_extension_repo_version_content_with_http_info(self, bucket_name, group_i header_params['Accept'] = self.api_client.\ select_header_accept(['application/octet-stream']) - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['*/*']) - # Authentication setting - auth_settings = ['tokenAuth', 'Authorization'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/extension-repository/{bucketName}/{groupId}/{artifactId}/{version}/content', 'GET', path_params, @@ -596,9 +575,8 @@ def get_extension_repo_version_content_with_http_info(self, bucket_name, group_i body=body_params, post_params=form_params, files=local_var_files, - response_type='list[str]', + response_type='str', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), @@ -606,26 +584,29 @@ def get_extension_repo_version_content_with_http_info(self, bucket_name, group_i def get_extension_repo_version_extension(self, bucket_name, group_id, artifact_id, version, name, **kwargs): """ - Get extension repo extension + Get extension repo extension. + Gets information about the extension with the given name in the given bucket, group, artifact, and version. NOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_extension_repo_version_extension(bucket_name, group_id, artifact_id, version, name, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str bucket_name: The bucket name (required) - :param str group_id: The group identifier (required) - :param str artifact_id: The artifact identifier (required) - :param str version: The version (required) - :param str name: The fully qualified name of the extension (required) - :return: Extension - If the method is called asynchronously, - returns the request thread. + + 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_extension_repo_version_extension_with_http_info()`` method instead. + + Args: + bucket_name (str): + The bucket name (required) + group_id (str): + The group identifier (required) + artifact_id (str): + The artifact identifier (required) + version (str): + The version (required) + name (str): + The fully qualified name of the extension (required) + + Returns: + :class:`~nipyapi.registry.models.Extension`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): @@ -636,30 +617,32 @@ def get_extension_repo_version_extension(self, bucket_name, group_id, artifact_i def get_extension_repo_version_extension_with_http_info(self, bucket_name, group_id, artifact_id, version, name, **kwargs): """ - Get extension repo extension + Get extension repo extension. + Gets information about the extension with the given name in the given bucket, group, artifact, and version. NOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_extension_repo_version_extension_with_http_info(bucket_name, group_id, artifact_id, version, name, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str bucket_name: The bucket name (required) - :param str group_id: The group identifier (required) - :param str artifact_id: The artifact identifier (required) - :param str version: The version (required) - :param str name: The fully qualified name of the extension (required) - :return: Extension - If the method is called asynchronously, - returns the request thread. + + 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_extension_repo_version_extension()`` method instead. + + Args: + bucket_name (str): + The bucket name (required) + group_id (str): + The group identifier (required) + artifact_id (str): + The artifact identifier (required) + version (str): + The version (required) + name (str): + The fully qualified name of the extension (required) + + Returns: + tuple: (:class:`~nipyapi.registry.models.Extension`, status_code, headers) - Response data with HTTP details. """ all_params = ['bucket_name', 'group_id', 'artifact_id', 'version', 'name'] - all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -689,7 +672,11 @@ def get_extension_repo_version_extension_with_http_info(self, bucket_name, group if ('name' not in params) or (params['name'] is None): raise ValueError("Missing the required parameter `name` when calling `get_extension_repo_version_extension`") - + + + + + collection_formats = {} path_params = {} @@ -716,12 +703,8 @@ def get_extension_repo_version_extension_with_http_info(self, bucket_name, group header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['*/*']) - # Authentication setting - auth_settings = ['tokenAuth', 'Authorization'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/extension-repository/{bucketName}/{groupId}/{artifactId}/{version}/extensions/{name}', 'GET', path_params, @@ -732,7 +715,6 @@ def get_extension_repo_version_extension_with_http_info(self, bucket_name, group files=local_var_files, response_type='Extension', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), @@ -740,26 +722,29 @@ def get_extension_repo_version_extension_with_http_info(self, bucket_name, group def get_extension_repo_version_extension_additional_details_docs(self, bucket_name, group_id, artifact_id, version, name, **kwargs): """ - Get extension repo extension details + Get extension repo extension details. + Gets the additional details documentation for the extension with the given name in the given bucket, group, artifact, and version. NOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_extension_repo_version_extension_additional_details_docs(bucket_name, group_id, artifact_id, version, name, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str bucket_name: The bucket name (required) - :param str group_id: The group identifier (required) - :param str artifact_id: The artifact identifier (required) - :param str version: The version (required) - :param str name: The fully qualified name of the extension (required) - :return: str - If the method is called asynchronously, - returns the request thread. + + 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_extension_repo_version_extension_additional_details_docs_with_http_info()`` method instead. + + Args: + bucket_name (str): + The bucket name (required) + group_id (str): + The group identifier (required) + artifact_id (str): + The artifact identifier (required) + version (str): + The version (required) + name (str): + The fully qualified name of the extension (required) + + Returns: + None """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): @@ -770,30 +755,32 @@ def get_extension_repo_version_extension_additional_details_docs(self, bucket_na def get_extension_repo_version_extension_additional_details_docs_with_http_info(self, bucket_name, group_id, artifact_id, version, name, **kwargs): """ - Get extension repo extension details + Get extension repo extension details. + Gets the additional details documentation for the extension with the given name in the given bucket, group, artifact, and version. NOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_extension_repo_version_extension_additional_details_docs_with_http_info(bucket_name, group_id, artifact_id, version, name, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str bucket_name: The bucket name (required) - :param str group_id: The group identifier (required) - :param str artifact_id: The artifact identifier (required) - :param str version: The version (required) - :param str name: The fully qualified name of the extension (required) - :return: str - If the method is called asynchronously, - returns the request thread. + + 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_extension_repo_version_extension_additional_details_docs()`` method instead. + + Args: + bucket_name (str): + The bucket name (required) + group_id (str): + The group identifier (required) + artifact_id (str): + The artifact identifier (required) + version (str): + The version (required) + name (str): + The fully qualified name of the extension (required) + + Returns: + tuple: (None, status_code, headers) - Response data with HTTP details. """ all_params = ['bucket_name', 'group_id', 'artifact_id', 'version', 'name'] - all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -823,7 +810,11 @@ def get_extension_repo_version_extension_additional_details_docs_with_http_info( if ('name' not in params) or (params['name'] is None): raise ValueError("Missing the required parameter `name` when calling `get_extension_repo_version_extension_additional_details_docs`") - + + + + + collection_formats = {} path_params = {} @@ -846,16 +837,8 @@ def get_extension_repo_version_extension_additional_details_docs_with_http_info( local_var_files = {} body_params = None - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['text/html']) - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['*/*']) - # Authentication setting - auth_settings = ['tokenAuth', 'Authorization'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/extension-repository/{bucketName}/{groupId}/{artifactId}/{version}/extensions/{name}/docs/additional-details', 'GET', path_params, @@ -864,9 +847,8 @@ def get_extension_repo_version_extension_additional_details_docs_with_http_info( body=body_params, post_params=form_params, files=local_var_files, - response_type='str', + response_type=None, auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), @@ -874,26 +856,29 @@ def get_extension_repo_version_extension_additional_details_docs_with_http_info( def get_extension_repo_version_extension_docs(self, bucket_name, group_id, artifact_id, version, name, **kwargs): """ - Get extension repo extension docs + Get extension repo extension docs. + Gets the documentation for the extension with the given name in the given bucket, group, artifact, and version. NOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_extension_repo_version_extension_docs(bucket_name, group_id, artifact_id, version, name, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str bucket_name: The bucket name (required) - :param str group_id: The group identifier (required) - :param str artifact_id: The artifact identifier (required) - :param str version: The version (required) - :param str name: The fully qualified name of the extension (required) - :return: str - If the method is called asynchronously, - returns the request thread. + + 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_extension_repo_version_extension_docs_with_http_info()`` method instead. + + Args: + bucket_name (str): + The bucket name (required) + group_id (str): + The group identifier (required) + artifact_id (str): + The artifact identifier (required) + version (str): + The version (required) + name (str): + The fully qualified name of the extension (required) + + Returns: + None """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): @@ -904,30 +889,32 @@ def get_extension_repo_version_extension_docs(self, bucket_name, group_id, artif def get_extension_repo_version_extension_docs_with_http_info(self, bucket_name, group_id, artifact_id, version, name, **kwargs): """ - Get extension repo extension docs + Get extension repo extension docs. + Gets the documentation for the extension with the given name in the given bucket, group, artifact, and version. NOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_extension_repo_version_extension_docs_with_http_info(bucket_name, group_id, artifact_id, version, name, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str bucket_name: The bucket name (required) - :param str group_id: The group identifier (required) - :param str artifact_id: The artifact identifier (required) - :param str version: The version (required) - :param str name: The fully qualified name of the extension (required) - :return: str - If the method is called asynchronously, - returns the request thread. + + 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_extension_repo_version_extension_docs()`` method instead. + + Args: + bucket_name (str): + The bucket name (required) + group_id (str): + The group identifier (required) + artifact_id (str): + The artifact identifier (required) + version (str): + The version (required) + name (str): + The fully qualified name of the extension (required) + + Returns: + tuple: (None, status_code, headers) - Response data with HTTP details. """ all_params = ['bucket_name', 'group_id', 'artifact_id', 'version', 'name'] - all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -957,7 +944,11 @@ def get_extension_repo_version_extension_docs_with_http_info(self, bucket_name, if ('name' not in params) or (params['name'] is None): raise ValueError("Missing the required parameter `name` when calling `get_extension_repo_version_extension_docs`") - + + + + + collection_formats = {} path_params = {} @@ -980,16 +971,8 @@ def get_extension_repo_version_extension_docs_with_http_info(self, bucket_name, local_var_files = {} body_params = None - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['text/html']) - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['*/*']) - # Authentication setting - auth_settings = ['tokenAuth', 'Authorization'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/extension-repository/{bucketName}/{groupId}/{artifactId}/{version}/extensions/{name}/docs', 'GET', path_params, @@ -998,9 +981,8 @@ def get_extension_repo_version_extension_docs_with_http_info(self, bucket_name, body=body_params, post_params=form_params, files=local_var_files, - response_type='str', + response_type=None, auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), @@ -1008,25 +990,27 @@ def get_extension_repo_version_extension_docs_with_http_info(self, bucket_name, def get_extension_repo_version_extensions(self, bucket_name, group_id, artifact_id, version, **kwargs): """ - Get extension repo extensions + Get extension repo extensions. + Gets information about the extensions in the given bucket, group, artifact, and version. NOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_extension_repo_version_extensions(bucket_name, group_id, artifact_id, version, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str bucket_name: The bucket name (required) - :param str group_id: The group identifier (required) - :param str artifact_id: The artifact identifier (required) - :param str version: The version (required) - :return: list[ExtensionMetadata] - If the method is called asynchronously, - returns the request thread. + + 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_extension_repo_version_extensions_with_http_info()`` method instead. + + Args: + bucket_name (str): + The bucket name (required) + group_id (str): + The group identifier (required) + artifact_id (str): + The artifact identifier (required) + version (str): + The version (required) + + Returns: + :class:`~nipyapi.registry.models.list[ExtensionMetadata]`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): @@ -1037,29 +1021,30 @@ def get_extension_repo_version_extensions(self, bucket_name, group_id, artifact_ def get_extension_repo_version_extensions_with_http_info(self, bucket_name, group_id, artifact_id, version, **kwargs): """ - Get extension repo extensions + Get extension repo extensions. + Gets information about the extensions in the given bucket, group, artifact, and version. NOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_extension_repo_version_extensions_with_http_info(bucket_name, group_id, artifact_id, version, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str bucket_name: The bucket name (required) - :param str group_id: The group identifier (required) - :param str artifact_id: The artifact identifier (required) - :param str version: The version (required) - :return: list[ExtensionMetadata] - If the method is called asynchronously, - returns the request thread. + + 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_extension_repo_version_extensions()`` method instead. + + Args: + bucket_name (str): + The bucket name (required) + group_id (str): + The group identifier (required) + artifact_id (str): + The artifact identifier (required) + version (str): + The version (required) + + Returns: + tuple: (:class:`~nipyapi.registry.models.list[ExtensionMetadata]`, status_code, headers) - Response data with HTTP details. """ all_params = ['bucket_name', 'group_id', 'artifact_id', 'version'] - all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -1086,7 +1071,10 @@ def get_extension_repo_version_extensions_with_http_info(self, bucket_name, grou if ('version' not in params) or (params['version'] is None): raise ValueError("Missing the required parameter `version` when calling `get_extension_repo_version_extensions`") - + + + + collection_formats = {} path_params = {} @@ -1111,12 +1099,8 @@ def get_extension_repo_version_extensions_with_http_info(self, bucket_name, grou header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['*/*']) - # Authentication setting - auth_settings = ['tokenAuth', 'Authorization'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/extension-repository/{bucketName}/{groupId}/{artifactId}/{version}/extensions', 'GET', path_params, @@ -1127,7 +1111,6 @@ def get_extension_repo_version_extensions_with_http_info(self, bucket_name, grou files=local_var_files, response_type='list[ExtensionMetadata]', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), @@ -1135,25 +1118,27 @@ def get_extension_repo_version_extensions_with_http_info(self, bucket_name, grou def get_extension_repo_version_sha256(self, bucket_name, group_id, artifact_id, version, **kwargs): """ - Get extension repo version checksum + Get extension repo version checksum. + Gets the hex representation of the SHA-256 digest for the binary content of the bundle with the given bucket, group, artifact, and version. NOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_extension_repo_version_sha256(bucket_name, group_id, artifact_id, version, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str bucket_name: The bucket name (required) - :param str group_id: The group identifier (required) - :param str artifact_id: The artifact identifier (required) - :param str version: The version (required) - :return: str - If the method is called asynchronously, - returns the request thread. + + 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_extension_repo_version_sha256_with_http_info()`` method instead. + + Args: + bucket_name (str): + The bucket name (required) + group_id (str): + The group identifier (required) + artifact_id (str): + The artifact identifier (required) + version (str): + The version (required) + + Returns: + None """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): @@ -1164,29 +1149,30 @@ def get_extension_repo_version_sha256(self, bucket_name, group_id, artifact_id, def get_extension_repo_version_sha256_with_http_info(self, bucket_name, group_id, artifact_id, version, **kwargs): """ - Get extension repo version checksum + Get extension repo version checksum. + Gets the hex representation of the SHA-256 digest for the binary content of the bundle with the given bucket, group, artifact, and version. NOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_extension_repo_version_sha256_with_http_info(bucket_name, group_id, artifact_id, version, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str bucket_name: The bucket name (required) - :param str group_id: The group identifier (required) - :param str artifact_id: The artifact identifier (required) - :param str version: The version (required) - :return: str - If the method is called asynchronously, - returns the request thread. + + 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_extension_repo_version_sha256()`` method instead. + + Args: + bucket_name (str): + The bucket name (required) + group_id (str): + The group identifier (required) + artifact_id (str): + The artifact identifier (required) + version (str): + The version (required) + + Returns: + tuple: (None, status_code, headers) - Response data with HTTP details. """ all_params = ['bucket_name', 'group_id', 'artifact_id', 'version'] - all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -1213,7 +1199,10 @@ def get_extension_repo_version_sha256_with_http_info(self, bucket_name, group_id if ('version' not in params) or (params['version'] is None): raise ValueError("Missing the required parameter `version` when calling `get_extension_repo_version_sha256`") - + + + + collection_formats = {} path_params = {} @@ -1234,16 +1223,8 @@ def get_extension_repo_version_sha256_with_http_info(self, bucket_name, group_id local_var_files = {} body_params = None - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['text/plain']) - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['*/*']) - # Authentication setting - auth_settings = ['tokenAuth', 'Authorization'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/extension-repository/{bucketName}/{groupId}/{artifactId}/{version}/sha256', 'GET', path_params, @@ -1252,9 +1233,8 @@ def get_extension_repo_version_sha256_with_http_info(self, bucket_name, group_id body=body_params, post_params=form_params, files=local_var_files, - response_type='str', + response_type=None, auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), @@ -1262,24 +1242,25 @@ def get_extension_repo_version_sha256_with_http_info(self, bucket_name, group_id def get_extension_repo_versions(self, bucket_name, group_id, artifact_id, **kwargs): """ - Get extension repo versions + Get extension repo versions. + Gets the versions in the extension repository for the given bucket, group, and artifact. NOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_extension_repo_versions(bucket_name, group_id, artifact_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str bucket_name: The bucket name (required) - :param str group_id: The group identifier (required) - :param str artifact_id: The artifact identifier (required) - :return: list[ExtensionRepoVersionSummary] - If the method is called asynchronously, - returns the request thread. + + 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_extension_repo_versions_with_http_info()`` method instead. + + Args: + bucket_name (str): + The bucket name (required) + group_id (str): + The group identifier (required) + artifact_id (str): + The artifact identifier (required) + + Returns: + :class:`~nipyapi.registry.models.list[ExtensionRepoVersionSummary]`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): @@ -1290,28 +1271,28 @@ def get_extension_repo_versions(self, bucket_name, group_id, artifact_id, **kwar def get_extension_repo_versions_with_http_info(self, bucket_name, group_id, artifact_id, **kwargs): """ - Get extension repo versions + Get extension repo versions. + Gets the versions in the extension repository for the given bucket, group, and artifact. NOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_extension_repo_versions_with_http_info(bucket_name, group_id, artifact_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str bucket_name: The bucket name (required) - :param str group_id: The group identifier (required) - :param str artifact_id: The artifact identifier (required) - :return: list[ExtensionRepoVersionSummary] - If the method is called asynchronously, - returns the request thread. + + 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_extension_repo_versions()`` method instead. + + Args: + bucket_name (str): + The bucket name (required) + group_id (str): + The group identifier (required) + artifact_id (str): + The artifact identifier (required) + + Returns: + tuple: (:class:`~nipyapi.registry.models.list[ExtensionRepoVersionSummary]`, status_code, headers) - Response data with HTTP details. """ all_params = ['bucket_name', 'group_id', 'artifact_id'] - all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -1335,7 +1316,9 @@ def get_extension_repo_versions_with_http_info(self, bucket_name, group_id, arti if ('artifact_id' not in params) or (params['artifact_id'] is None): raise ValueError("Missing the required parameter `artifact_id` when calling `get_extension_repo_versions`") - + + + collection_formats = {} path_params = {} @@ -1358,12 +1341,8 @@ def get_extension_repo_versions_with_http_info(self, bucket_name, group_id, arti header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['*/*']) - # Authentication setting - auth_settings = ['tokenAuth', 'Authorization'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/extension-repository/{bucketName}/{groupId}/{artifactId}', 'GET', path_params, @@ -1374,7 +1353,6 @@ def get_extension_repo_versions_with_http_info(self, bucket_name, group_id, arti files=local_var_files, response_type='list[ExtensionRepoVersionSummary]', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), @@ -1382,24 +1360,25 @@ def get_extension_repo_versions_with_http_info(self, bucket_name, group_id, arti def get_global_extension_repo_version_sha256(self, group_id, artifact_id, version, **kwargs): """ - Get global extension repo version checksum + Get global extension repo version checksum. + Gets the hex representation of the SHA-256 digest for the binary content with the given bucket, group, artifact, and version. Since the same group-artifact-version can exist in multiple buckets, this will return the checksum of the first one returned. This will be consistent since the checksum must be the same when existing in multiple buckets. NOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_global_extension_repo_version_sha256(group_id, artifact_id, version, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str group_id: The group identifier (required) - :param str artifact_id: The artifact identifier (required) - :param str version: The version (required) - :return: str - If the method is called asynchronously, - returns the request thread. + + 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_global_extension_repo_version_sha256_with_http_info()`` method instead. + + Args: + group_id (str): + The group identifier (required) + artifact_id (str): + The artifact identifier (required) + version (str): + The version (required) + + Returns: + None """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): @@ -1410,28 +1389,28 @@ def get_global_extension_repo_version_sha256(self, group_id, artifact_id, versio def get_global_extension_repo_version_sha256_with_http_info(self, group_id, artifact_id, version, **kwargs): """ - Get global extension repo version checksum + Get global extension repo version checksum. + Gets the hex representation of the SHA-256 digest for the binary content with the given bucket, group, artifact, and version. Since the same group-artifact-version can exist in multiple buckets, this will return the checksum of the first one returned. This will be consistent since the checksum must be the same when existing in multiple buckets. NOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_global_extension_repo_version_sha256_with_http_info(group_id, artifact_id, version, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str group_id: The group identifier (required) - :param str artifact_id: The artifact identifier (required) - :param str version: The version (required) - :return: str - If the method is called asynchronously, - returns the request thread. + + 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_global_extension_repo_version_sha256()`` method instead. + + Args: + group_id (str): + The group identifier (required) + artifact_id (str): + The artifact identifier (required) + version (str): + The version (required) + + Returns: + tuple: (None, status_code, headers) - Response data with HTTP details. """ all_params = ['group_id', 'artifact_id', 'version'] - all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -1455,7 +1434,9 @@ def get_global_extension_repo_version_sha256_with_http_info(self, group_id, arti if ('version' not in params) or (params['version'] is None): raise ValueError("Missing the required parameter `version` when calling `get_global_extension_repo_version_sha256`") - + + + collection_formats = {} path_params = {} @@ -1474,16 +1455,8 @@ def get_global_extension_repo_version_sha256_with_http_info(self, group_id, arti local_var_files = {} body_params = None - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['text/plain']) - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['*/*']) - # Authentication setting - auth_settings = ['tokenAuth', 'Authorization'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/extension-repository/{groupId}/{artifactId}/{version}/sha256', 'GET', path_params, @@ -1492,9 +1465,8 @@ def get_global_extension_repo_version_sha256_with_http_info(self, group_id, arti body=body_params, post_params=form_params, files=local_var_files, - response_type='str', + response_type=None, auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), diff --git a/nipyapi/registry/apis/extensions_api.py b/nipyapi/registry/apis/extensions_api.py index b7a9b5ea..62d16144 100644 --- a/nipyapi/registry/apis/extensions_api.py +++ b/nipyapi/registry/apis/extensions_api.py @@ -1,14 +1,13 @@ """ Apache NiFi Registry REST API - The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components. + REST API definition for Apache NiFi Registry web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - import sys import os import re @@ -35,24 +34,25 @@ def __init__(self, api_client=None): def get_extensions(self, **kwargs): """ - Get all extensions + Get all extensions. + Gets the metadata for all extensions that match the filter params and are part of bundles located in buckets the current user is authorized for. If the user is not authorized to any buckets, an empty result set will be returned. NOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_extensions(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str bundle_type: The type of bundles to return - :param str extension_type: The type of extensions to return - :param list[str] tag: The tags to filter on, will be used in an OR statement - :return: ExtensionMetadataContainer - If the method is called asynchronously, - returns the request thread. + + 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_extensions_with_http_info()`` method instead. + + Args: + bundle_type (str): + The type of bundles to return + extension_type (str): + The type of extensions to return + tag (:class:`~nipyapi.registry.models.list[str]`): + The tags to filter on, will be used in an OR statement + + Returns: + :class:`~nipyapi.registry.models.ExtensionMetadataContainer`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): @@ -63,28 +63,28 @@ def get_extensions(self, **kwargs): def get_extensions_with_http_info(self, **kwargs): """ - Get all extensions + Get all extensions. + Gets the metadata for all extensions that match the filter params and are part of bundles located in buckets the current user is authorized for. If the user is not authorized to any buckets, an empty result set will be returned. NOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_extensions_with_http_info(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str bundle_type: The type of bundles to return - :param str extension_type: The type of extensions to return - :param list[str] tag: The tags to filter on, will be used in an OR statement - :return: ExtensionMetadataContainer - If the method is called asynchronously, - returns the request thread. + + 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_extensions()`` method instead. + + Args: + bundle_type (str): + The type of bundles to return + extension_type (str): + The type of extensions to return + tag (:class:`~nipyapi.registry.models.list[str]`): + The tags to filter on, will be used in an OR statement + + Returns: + tuple: (:class:`~nipyapi.registry.models.ExtensionMetadataContainer`, status_code, headers) - Response data with HTTP details. """ all_params = ['bundle_type', 'extension_type', 'tag'] - all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -99,7 +99,9 @@ def get_extensions_with_http_info(self, **kwargs): params[key] = val del params['kwargs'] - + + + collection_formats = {} path_params = {} @@ -123,12 +125,8 @@ def get_extensions_with_http_info(self, **kwargs): header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['*/*']) - # Authentication setting - auth_settings = ['tokenAuth', 'Authorization'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/extensions', 'GET', path_params, @@ -139,7 +137,6 @@ def get_extensions_with_http_info(self, **kwargs): files=local_var_files, response_type='ExtensionMetadataContainer', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), @@ -147,25 +144,27 @@ def get_extensions_with_http_info(self, **kwargs): def get_extensions_providing_service_api(self, class_name, group_id, artifact_id, version, **kwargs): """ - Get extensions providing service API + Get extensions providing service API. + Gets the metadata for extensions that provide the specified API and are part of bundles located in buckets the current user is authorized for. If the user is not authorized to any buckets, an empty result set will be returned. NOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_extensions_providing_service_api(class_name, group_id, artifact_id, version, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str class_name: The name of the service API class (required) - :param str group_id: The groupId of the bundle containing the service API class (required) - :param str artifact_id: The artifactId of the bundle containing the service API class (required) - :param str version: The version of the bundle containing the service API class (required) - :return: ExtensionMetadataContainer - If the method is called asynchronously, - returns the request thread. + + 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_extensions_providing_service_api_with_http_info()`` method instead. + + Args: + class_name (str): + The name of the service API class (required) + group_id (str): + The groupId of the bundle containing the service API class (required) + artifact_id (str): + The artifactId of the bundle containing the service API class (required) + version (str): + The version of the bundle containing the service API class (required) + + Returns: + :class:`~nipyapi.registry.models.ExtensionMetadataContainer`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): @@ -176,29 +175,30 @@ def get_extensions_providing_service_api(self, class_name, group_id, artifact_id def get_extensions_providing_service_api_with_http_info(self, class_name, group_id, artifact_id, version, **kwargs): """ - Get extensions providing service API + Get extensions providing service API. + Gets the metadata for extensions that provide the specified API and are part of bundles located in buckets the current user is authorized for. If the user is not authorized to any buckets, an empty result set will be returned. NOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_extensions_providing_service_api_with_http_info(class_name, group_id, artifact_id, version, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str class_name: The name of the service API class (required) - :param str group_id: The groupId of the bundle containing the service API class (required) - :param str artifact_id: The artifactId of the bundle containing the service API class (required) - :param str version: The version of the bundle containing the service API class (required) - :return: ExtensionMetadataContainer - If the method is called asynchronously, - returns the request thread. + + 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_extensions_providing_service_api()`` method instead. + + Args: + class_name (str): + The name of the service API class (required) + group_id (str): + The groupId of the bundle containing the service API class (required) + artifact_id (str): + The artifactId of the bundle containing the service API class (required) + version (str): + The version of the bundle containing the service API class (required) + + Returns: + tuple: (:class:`~nipyapi.registry.models.ExtensionMetadataContainer`, status_code, headers) - Response data with HTTP details. """ all_params = ['class_name', 'group_id', 'artifact_id', 'version'] - all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -225,7 +225,10 @@ def get_extensions_providing_service_api_with_http_info(self, class_name, group_ if ('version' not in params) or (params['version'] is None): raise ValueError("Missing the required parameter `version` when calling `get_extensions_providing_service_api`") - + + + + collection_formats = {} path_params = {} @@ -250,12 +253,8 @@ def get_extensions_providing_service_api_with_http_info(self, class_name, group_ header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['*/*']) - # Authentication setting - auth_settings = ['tokenAuth', 'Authorization'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/extensions/provided-service-api', 'GET', path_params, @@ -266,7 +265,6 @@ def get_extensions_providing_service_api_with_http_info(self, class_name, group_ files=local_var_files, response_type='ExtensionMetadataContainer', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), @@ -274,21 +272,19 @@ def get_extensions_providing_service_api_with_http_info(self, class_name, group_ def get_tags(self, **kwargs): """ - Get extension tags + Get extension tags. + Gets all the extension tags known to this NiFi Registry instance, along with the number of extensions that have the given tag. NOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_tags(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :return: list[TagCount] - If the method is called asynchronously, - returns the request thread. + + 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_tags_with_http_info()`` method instead. + + Args: + + Returns: + :class:`~nipyapi.registry.models.list[TagCount]`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): @@ -299,25 +295,22 @@ def get_tags(self, **kwargs): def get_tags_with_http_info(self, **kwargs): """ - Get extension tags + Get extension tags. + Gets all the extension tags known to this NiFi Registry instance, along with the number of extensions that have the given tag. NOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_tags_with_http_info(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :return: list[TagCount] - If the method is called asynchronously, - returns the request thread. + + 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_tags()`` method instead. + + Args: + + Returns: + tuple: (:class:`~nipyapi.registry.models.list[TagCount]`, status_code, headers) - Response data with HTTP details. """ all_params = [] - all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -348,12 +341,8 @@ def get_tags_with_http_info(self, **kwargs): header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['*/*']) - # Authentication setting - auth_settings = ['tokenAuth', 'Authorization'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/extensions/tags', 'GET', path_params, @@ -364,7 +353,6 @@ def get_tags_with_http_info(self, **kwargs): files=local_var_files, response_type='list[TagCount]', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), diff --git a/nipyapi/registry/apis/flows_api.py b/nipyapi/registry/apis/flows_api.py index 9963e8a9..2760ca28 100644 --- a/nipyapi/registry/apis/flows_api.py +++ b/nipyapi/registry/apis/flows_api.py @@ -1,14 +1,13 @@ """ Apache NiFi Registry REST API - The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components. + REST API definition for Apache NiFi Registry web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - import sys import os import re @@ -35,21 +34,19 @@ def __init__(self, api_client=None): def get_available_flow_fields(self, **kwargs): """ - Get flow fields + Get flow fields. + Retrieves the flow field names that can be used for searching or sorting on flows. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_available_flow_fields(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :return: Fields - If the method is called asynchronously, - returns the request thread. + + 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_available_flow_fields_with_http_info()`` method instead. + + Args: + + Returns: + :class:`~nipyapi.registry.models.Fields`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): @@ -60,25 +57,22 @@ def get_available_flow_fields(self, **kwargs): def get_available_flow_fields_with_http_info(self, **kwargs): """ - Get flow fields + Get flow fields. + Retrieves the flow field names that can be used for searching or sorting on flows. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_available_flow_fields_with_http_info(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :return: Fields - If the method is called asynchronously, - returns the request thread. + + 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_available_flow_fields()`` method instead. + + Args: + + Returns: + tuple: (:class:`~nipyapi.registry.models.Fields`, status_code, headers) - Response data with HTTP details. """ all_params = [] - all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -109,12 +103,8 @@ def get_available_flow_fields_with_http_info(self, **kwargs): header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['*/*']) - # Authentication setting - auth_settings = ['tokenAuth', 'Authorization'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/flows/fields', 'GET', path_params, @@ -125,60 +115,56 @@ def get_available_flow_fields_with_http_info(self, **kwargs): files=local_var_files, response_type='Fields', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def global_get_flow(self, flow_id, **kwargs): + def get_flow1(self, flow_id, **kwargs): """ - Get flow + Get flow. + Gets a flow by id. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.global_get_flow(flow_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str flow_id: The flow identifier (required) - :return: VersionedFlow - If the method is called asynchronously, - returns the request thread. + + 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_flow1_with_http_info()`` method instead. + + Args: + flow_id (str): + The flow identifier (required) + + Returns: + :class:`~nipyapi.registry.models.VersionedFlow`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.global_get_flow_with_http_info(flow_id, **kwargs) + return self.get_flow1_with_http_info(flow_id, **kwargs) else: - (data) = self.global_get_flow_with_http_info(flow_id, **kwargs) + (data) = self.get_flow1_with_http_info(flow_id, **kwargs) return data - def global_get_flow_with_http_info(self, flow_id, **kwargs): + def get_flow1_with_http_info(self, flow_id, **kwargs): """ - Get flow + Get flow. + Gets a flow by id. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.global_get_flow_with_http_info(flow_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str flow_id: The flow identifier (required) - :return: VersionedFlow - If the method is called asynchronously, - returns the request thread. + + 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_flow1()`` method instead. + + Args: + flow_id (str): + The flow identifier (required) + + Returns: + tuple: (:class:`~nipyapi.registry.models.VersionedFlow`, status_code, headers) - Response data with HTTP details. """ all_params = ['flow_id'] - all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -188,15 +174,15 @@ def global_get_flow_with_http_info(self, flow_id, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method global_get_flow" % key + " to method get_flow1" % key ) params[key] = val del params['kwargs'] # verify the required parameter 'flow_id' is set if ('flow_id' not in params) or (params['flow_id'] is None): - raise ValueError("Missing the required parameter `flow_id` when calling `global_get_flow`") - + raise ValueError("Missing the required parameter `flow_id` when calling `get_flow1`") + collection_formats = {} path_params = {} @@ -215,12 +201,8 @@ def global_get_flow_with_http_info(self, flow_id, **kwargs): header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['*/*']) - # Authentication setting - auth_settings = ['tokenAuth', 'Authorization'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/flows/{flowId}', 'GET', path_params, @@ -231,62 +213,60 @@ def global_get_flow_with_http_info(self, flow_id, **kwargs): files=local_var_files, response_type='VersionedFlow', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def global_get_flow_version(self, flow_id, version_number, **kwargs): + def get_flow_version1(self, flow_id, version_number, **kwargs): """ - Get flow version + Get flow version. + Gets the given version of a flow, including metadata and flow content. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.global_get_flow_version(flow_id, version_number, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str flow_id: The flow identifier (required) - :param int version_number: The version number (required) - :return: VersionedFlowSnapshot - If the method is called asynchronously, - returns the request thread. + + 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_flow_version1_with_http_info()`` method instead. + + Args: + flow_id (str): + The flow identifier (required) + version_number (int): + The version number (required) + + Returns: + :class:`~nipyapi.registry.models.VersionedFlowSnapshot`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.global_get_flow_version_with_http_info(flow_id, version_number, **kwargs) + return self.get_flow_version1_with_http_info(flow_id, version_number, **kwargs) else: - (data) = self.global_get_flow_version_with_http_info(flow_id, version_number, **kwargs) + (data) = self.get_flow_version1_with_http_info(flow_id, version_number, **kwargs) return data - def global_get_flow_version_with_http_info(self, flow_id, version_number, **kwargs): + def get_flow_version1_with_http_info(self, flow_id, version_number, **kwargs): """ - Get flow version + Get flow version. + Gets the given version of a flow, including metadata and flow content. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.global_get_flow_version_with_http_info(flow_id, version_number, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str flow_id: The flow identifier (required) - :param int version_number: The version number (required) - :return: VersionedFlowSnapshot - If the method is called asynchronously, - returns the request thread. + + 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_flow_version1()`` method instead. + + Args: + flow_id (str): + The flow identifier (required) + version_number (int): + The version number (required) + + Returns: + tuple: (:class:`~nipyapi.registry.models.VersionedFlowSnapshot`, status_code, headers) - Response data with HTTP details. """ all_params = ['flow_id', 'version_number'] - all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -296,20 +276,19 @@ def global_get_flow_version_with_http_info(self, flow_id, version_number, **kwar if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method global_get_flow_version" % key + " to method get_flow_version1" % key ) params[key] = val del params['kwargs'] # verify the required parameter 'flow_id' is set if ('flow_id' not in params) or (params['flow_id'] is None): - raise ValueError("Missing the required parameter `flow_id` when calling `global_get_flow_version`") + raise ValueError("Missing the required parameter `flow_id` when calling `get_flow_version1`") # verify the required parameter 'version_number' is set if ('version_number' not in params) or (params['version_number'] is None): - raise ValueError("Missing the required parameter `version_number` when calling `global_get_flow_version`") - - if 'version_number' in params and not re.search('\\d+', params['version_number']): - raise ValueError("Invalid value for parameter `version_number` when calling `global_get_flow_version`, must conform to the pattern `/\\d+/`") + raise ValueError("Missing the required parameter `version_number` when calling `get_flow_version1`") + + collection_formats = {} path_params = {} @@ -330,12 +309,8 @@ def global_get_flow_version_with_http_info(self, flow_id, version_number, **kwar header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['*/*']) - # Authentication setting - auth_settings = ['tokenAuth', 'Authorization'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/flows/{flowId}/versions/{versionNumber}', 'GET', path_params, @@ -346,60 +321,56 @@ def global_get_flow_version_with_http_info(self, flow_id, version_number, **kwar files=local_var_files, response_type='VersionedFlowSnapshot', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def global_get_flow_versions(self, flow_id, **kwargs): + def get_flow_versions1(self, flow_id, **kwargs): """ - Get flow versions + Get flow versions. + Gets summary information for all versions of a given flow. Versions are ordered newest->oldest. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.global_get_flow_versions(flow_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str flow_id: The flow identifier (required) - :return: list[VersionedFlowSnapshotMetadata] - If the method is called asynchronously, - returns the request thread. + + 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_flow_versions1_with_http_info()`` method instead. + + Args: + flow_id (str): + The flow identifier (required) + + Returns: + :class:`~nipyapi.registry.models.list[VersionedFlowSnapshotMetadata]`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.global_get_flow_versions_with_http_info(flow_id, **kwargs) + return self.get_flow_versions1_with_http_info(flow_id, **kwargs) else: - (data) = self.global_get_flow_versions_with_http_info(flow_id, **kwargs) + (data) = self.get_flow_versions1_with_http_info(flow_id, **kwargs) return data - def global_get_flow_versions_with_http_info(self, flow_id, **kwargs): + def get_flow_versions1_with_http_info(self, flow_id, **kwargs): """ - Get flow versions + Get flow versions. + Gets summary information for all versions of a given flow. Versions are ordered newest->oldest. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.global_get_flow_versions_with_http_info(flow_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str flow_id: The flow identifier (required) - :return: list[VersionedFlowSnapshotMetadata] - If the method is called asynchronously, - returns the request thread. + + 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_flow_versions1()`` method instead. + + Args: + flow_id (str): + The flow identifier (required) + + Returns: + tuple: (:class:`~nipyapi.registry.models.list[VersionedFlowSnapshotMetadata]`, status_code, headers) - Response data with HTTP details. """ all_params = ['flow_id'] - all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -409,15 +380,15 @@ def global_get_flow_versions_with_http_info(self, flow_id, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method global_get_flow_versions" % key + " to method get_flow_versions1" % key ) params[key] = val del params['kwargs'] # verify the required parameter 'flow_id' is set if ('flow_id' not in params) or (params['flow_id'] is None): - raise ValueError("Missing the required parameter `flow_id` when calling `global_get_flow_versions`") - + raise ValueError("Missing the required parameter `flow_id` when calling `get_flow_versions1`") + collection_formats = {} path_params = {} @@ -436,12 +407,8 @@ def global_get_flow_versions_with_http_info(self, flow_id, **kwargs): header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['*/*']) - # Authentication setting - auth_settings = ['tokenAuth', 'Authorization'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/flows/{flowId}/versions', 'GET', path_params, @@ -452,60 +419,56 @@ def global_get_flow_versions_with_http_info(self, flow_id, **kwargs): files=local_var_files, response_type='list[VersionedFlowSnapshotMetadata]', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def global_get_latest_flow_version(self, flow_id, **kwargs): + def get_latest_flow_version1(self, flow_id, **kwargs): """ - Get latest flow version + Get latest flow version. + Gets the latest version of a flow, including metadata and flow content. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.global_get_latest_flow_version(flow_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str flow_id: The flow identifier (required) - :return: VersionedFlowSnapshot - If the method is called asynchronously, - returns the request thread. + + 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_latest_flow_version1_with_http_info()`` method instead. + + Args: + flow_id (str): + The flow identifier (required) + + Returns: + :class:`~nipyapi.registry.models.VersionedFlowSnapshot`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.global_get_latest_flow_version_with_http_info(flow_id, **kwargs) + return self.get_latest_flow_version1_with_http_info(flow_id, **kwargs) else: - (data) = self.global_get_latest_flow_version_with_http_info(flow_id, **kwargs) + (data) = self.get_latest_flow_version1_with_http_info(flow_id, **kwargs) return data - def global_get_latest_flow_version_with_http_info(self, flow_id, **kwargs): + def get_latest_flow_version1_with_http_info(self, flow_id, **kwargs): """ - Get latest flow version + Get latest flow version. + Gets the latest version of a flow, including metadata and flow content. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.global_get_latest_flow_version_with_http_info(flow_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str flow_id: The flow identifier (required) - :return: VersionedFlowSnapshot - If the method is called asynchronously, - returns the request thread. + + 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_latest_flow_version1()`` method instead. + + Args: + flow_id (str): + The flow identifier (required) + + Returns: + tuple: (:class:`~nipyapi.registry.models.VersionedFlowSnapshot`, status_code, headers) - Response data with HTTP details. """ all_params = ['flow_id'] - all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -515,15 +478,15 @@ def global_get_latest_flow_version_with_http_info(self, flow_id, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method global_get_latest_flow_version" % key + " to method get_latest_flow_version1" % key ) params[key] = val del params['kwargs'] # verify the required parameter 'flow_id' is set if ('flow_id' not in params) or (params['flow_id'] is None): - raise ValueError("Missing the required parameter `flow_id` when calling `global_get_latest_flow_version`") - + raise ValueError("Missing the required parameter `flow_id` when calling `get_latest_flow_version1`") + collection_formats = {} path_params = {} @@ -542,12 +505,8 @@ def global_get_latest_flow_version_with_http_info(self, flow_id, **kwargs): header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['*/*']) - # Authentication setting - auth_settings = ['tokenAuth', 'Authorization'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/flows/{flowId}/versions/latest', 'GET', path_params, @@ -558,60 +517,56 @@ def global_get_latest_flow_version_with_http_info(self, flow_id, **kwargs): files=local_var_files, response_type='VersionedFlowSnapshot', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def global_get_latest_flow_version_metadata(self, flow_id, **kwargs): + def get_latest_flow_version_metadata1(self, flow_id, **kwargs): """ - Get latest flow version metadata + Get latest flow version metadata. + Gets the metadata for the latest version of a flow. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.global_get_latest_flow_version_metadata(flow_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str flow_id: The flow identifier (required) - :return: VersionedFlowSnapshotMetadata - If the method is called asynchronously, - returns the request thread. + + 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_latest_flow_version_metadata1_with_http_info()`` method instead. + + Args: + flow_id (str): + The flow identifier (required) + + Returns: + :class:`~nipyapi.registry.models.VersionedFlowSnapshotMetadata`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.global_get_latest_flow_version_metadata_with_http_info(flow_id, **kwargs) + return self.get_latest_flow_version_metadata1_with_http_info(flow_id, **kwargs) else: - (data) = self.global_get_latest_flow_version_metadata_with_http_info(flow_id, **kwargs) + (data) = self.get_latest_flow_version_metadata1_with_http_info(flow_id, **kwargs) return data - def global_get_latest_flow_version_metadata_with_http_info(self, flow_id, **kwargs): + def get_latest_flow_version_metadata1_with_http_info(self, flow_id, **kwargs): """ - Get latest flow version metadata + Get latest flow version metadata. + Gets the metadata for the latest version of a flow. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.global_get_latest_flow_version_metadata_with_http_info(flow_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str flow_id: The flow identifier (required) - :return: VersionedFlowSnapshotMetadata - If the method is called asynchronously, - returns the request thread. + + 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_latest_flow_version_metadata1()`` method instead. + + Args: + flow_id (str): + The flow identifier (required) + + Returns: + tuple: (:class:`~nipyapi.registry.models.VersionedFlowSnapshotMetadata`, status_code, headers) - Response data with HTTP details. """ all_params = ['flow_id'] - all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -621,15 +576,15 @@ def global_get_latest_flow_version_metadata_with_http_info(self, flow_id, **kwar if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method global_get_latest_flow_version_metadata" % key + " to method get_latest_flow_version_metadata1" % key ) params[key] = val del params['kwargs'] # verify the required parameter 'flow_id' is set if ('flow_id' not in params) or (params['flow_id'] is None): - raise ValueError("Missing the required parameter `flow_id` when calling `global_get_latest_flow_version_metadata`") - + raise ValueError("Missing the required parameter `flow_id` when calling `get_latest_flow_version_metadata1`") + collection_formats = {} path_params = {} @@ -648,12 +603,8 @@ def global_get_latest_flow_version_metadata_with_http_info(self, flow_id, **kwar header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['*/*']) - # Authentication setting - auth_settings = ['tokenAuth', 'Authorization'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/flows/{flowId}/versions/latest/metadata', 'GET', path_params, @@ -664,7 +615,6 @@ def global_get_latest_flow_version_metadata_with_http_info(self, flow_id, **kwar files=local_var_files, response_type='VersionedFlowSnapshotMetadata', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), diff --git a/nipyapi/registry/apis/items_api.py b/nipyapi/registry/apis/items_api.py index 62f5b8bf..811a1c0b 100644 --- a/nipyapi/registry/apis/items_api.py +++ b/nipyapi/registry/apis/items_api.py @@ -1,14 +1,13 @@ """ Apache NiFi Registry REST API - The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components. + REST API definition for Apache NiFi Registry web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - import sys import os import re @@ -35,21 +34,19 @@ def __init__(self, api_client=None): def get_available_bucket_item_fields(self, **kwargs): """ - Get item fields + Get item fields. + Retrieves the item field names for searching or sorting on bucket items. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_available_bucket_item_fields(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :return: Fields - If the method is called asynchronously, - returns the request thread. + + 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_available_bucket_item_fields_with_http_info()`` method instead. + + Args: + + Returns: + :class:`~nipyapi.registry.models.Fields`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): @@ -60,25 +57,22 @@ def get_available_bucket_item_fields(self, **kwargs): def get_available_bucket_item_fields_with_http_info(self, **kwargs): """ - Get item fields + Get item fields. + Retrieves the item field names for searching or sorting on bucket items. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_available_bucket_item_fields_with_http_info(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :return: Fields - If the method is called asynchronously, - returns the request thread. + + 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_available_bucket_item_fields()`` method instead. + + Args: + + Returns: + tuple: (:class:`~nipyapi.registry.models.Fields`, status_code, headers) - Response data with HTTP details. """ all_params = [] - all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -109,12 +103,8 @@ def get_available_bucket_item_fields_with_http_info(self, **kwargs): header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['*/*']) - # Authentication setting - auth_settings = ['tokenAuth', 'Authorization'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/items/fields', 'GET', path_params, @@ -125,7 +115,6 @@ def get_available_bucket_item_fields_with_http_info(self, **kwargs): files=local_var_files, response_type='Fields', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), @@ -133,21 +122,19 @@ def get_available_bucket_item_fields_with_http_info(self, **kwargs): def get_items(self, **kwargs): """ - Get all items + Get all items. + Get items across all buckets. The returned items will include only items from buckets for which the user is authorized. If the user is not authorized to any buckets, an empty list will be returned. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_items(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :return: list[BucketItem] - If the method is called asynchronously, - returns the request thread. + + 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_items_with_http_info()`` method instead. + + Args: + + Returns: + :class:`~nipyapi.registry.models.list[BucketItem]`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): @@ -158,25 +145,22 @@ def get_items(self, **kwargs): def get_items_with_http_info(self, **kwargs): """ - Get all items + Get all items. + Get items across all buckets. The returned items will include only items from buckets for which the user is authorized. If the user is not authorized to any buckets, an empty list will be returned. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_items_with_http_info(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :return: list[BucketItem] - If the method is called asynchronously, - returns the request thread. + + 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_items()`` method instead. + + Args: + + Returns: + tuple: (:class:`~nipyapi.registry.models.list[BucketItem]`, status_code, headers) - Response data with HTTP details. """ all_params = [] - all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -207,12 +191,8 @@ def get_items_with_http_info(self, **kwargs): header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['*/*']) - # Authentication setting - auth_settings = ['tokenAuth', 'Authorization'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/items', 'GET', path_params, @@ -223,60 +203,56 @@ def get_items_with_http_info(self, **kwargs): files=local_var_files, response_type='list[BucketItem]', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def get_items_in_bucket(self, bucket_id, **kwargs): + def get_items1(self, bucket_id, **kwargs): """ - Get bucket items + Get bucket items. + Gets the items located in the given bucket. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_items_in_bucket(bucket_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str bucket_id: The bucket identifier (required) - :return: list[BucketItem] - If the method is called asynchronously, - returns the request thread. + + 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_items1_with_http_info()`` method instead. + + Args: + bucket_id (str): + The bucket identifier (required) + + Returns: + :class:`~nipyapi.registry.models.list[BucketItem]`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.get_items_in_bucket_with_http_info(bucket_id, **kwargs) + return self.get_items1_with_http_info(bucket_id, **kwargs) else: - (data) = self.get_items_in_bucket_with_http_info(bucket_id, **kwargs) + (data) = self.get_items1_with_http_info(bucket_id, **kwargs) return data - def get_items_in_bucket_with_http_info(self, bucket_id, **kwargs): + def get_items1_with_http_info(self, bucket_id, **kwargs): """ - Get bucket items + Get bucket items. + Gets the items located in the given bucket. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_items_in_bucket_with_http_info(bucket_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str bucket_id: The bucket identifier (required) - :return: list[BucketItem] - If the method is called asynchronously, - returns the request thread. + + 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_items1()`` method instead. + + Args: + bucket_id (str): + The bucket identifier (required) + + Returns: + tuple: (:class:`~nipyapi.registry.models.list[BucketItem]`, status_code, headers) - Response data with HTTP details. """ all_params = ['bucket_id'] - all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -286,15 +262,15 @@ def get_items_in_bucket_with_http_info(self, bucket_id, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method get_items_in_bucket" % key + " to method get_items1" % key ) params[key] = val del params['kwargs'] # verify the required parameter 'bucket_id' is set if ('bucket_id' not in params) or (params['bucket_id'] is None): - raise ValueError("Missing the required parameter `bucket_id` when calling `get_items_in_bucket`") - + raise ValueError("Missing the required parameter `bucket_id` when calling `get_items1`") + collection_formats = {} path_params = {} @@ -313,12 +289,8 @@ def get_items_in_bucket_with_http_info(self, bucket_id, **kwargs): header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['*/*']) - # Authentication setting - auth_settings = ['tokenAuth', 'Authorization'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/items/{bucketId}', 'GET', path_params, @@ -329,7 +301,6 @@ def get_items_in_bucket_with_http_info(self, bucket_id, **kwargs): files=local_var_files, response_type='list[BucketItem]', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), diff --git a/nipyapi/registry/apis/policies_api.py b/nipyapi/registry/apis/policies_api.py index 10efb47a..cda415b5 100644 --- a/nipyapi/registry/apis/policies_api.py +++ b/nipyapi/registry/apis/policies_api.py @@ -1,14 +1,13 @@ """ Apache NiFi Registry REST API - The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components. + REST API definition for Apache NiFi Registry web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - import sys import os import re @@ -35,22 +34,18 @@ def __init__(self, api_client=None): def create_access_policy(self, body, **kwargs): """ - Create access policy + Create access policy. + 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_access_policy_with_http_info()`` method instead. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.create_access_policy(body, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param AccessPolicy body: The access policy configuration details. (required) - :return: AccessPolicy - If the method is called asynchronously, - returns the request thread. + Args: + body (:class:`~nipyapi.registry.models.AccessPolicy`): + The access policy configuration details. (required) + + Returns: + :class:`~nipyapi.registry.models.AccessPolicy`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): @@ -61,26 +56,21 @@ def create_access_policy(self, body, **kwargs): def create_access_policy_with_http_info(self, body, **kwargs): """ - Create access policy + Create access policy. + This method makes a synchronous HTTP request and returns detailed response information. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.create_access_policy_with_http_info(body, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param AccessPolicy body: The access policy configuration details. (required) - :return: AccessPolicy - If the method is called asynchronously, - returns the request thread. + Returns the response data along with HTTP status code, headers, and other metadata. + For just the response data, use the corresponding ``create_access_policy()`` method instead. + + Args: + body (:class:`~nipyapi.registry.models.AccessPolicy`): + The access policy configuration details. (required) + + Returns: + tuple: (:class:`~nipyapi.registry.models.AccessPolicy`, status_code, headers) - Response data with HTTP details. """ all_params = ['body'] - all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -98,7 +88,7 @@ def create_access_policy_with_http_info(self, body, **kwargs): if ('body' not in params) or (params['body'] is None): raise ValueError("Missing the required parameter `body` when calling `create_access_policy`") - + collection_formats = {} path_params = {} @@ -122,7 +112,7 @@ def create_access_policy_with_http_info(self, body, **kwargs): select_header_content_type(['application/json']) # Authentication setting - auth_settings = ['tokenAuth', 'Authorization'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/policies', 'POST', path_params, @@ -133,7 +123,6 @@ def create_access_policy_with_http_info(self, body, **kwargs): files=local_var_files, response_type='AccessPolicy', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), @@ -141,21 +130,16 @@ def create_access_policy_with_http_info(self, body, **kwargs): def get_access_policies(self, **kwargs): """ - Get all access policies + Get all access policies. + This method makes a synchronous HTTP request and returns the response data directly. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_access_policies(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :return: list[AccessPolicy] - If the method is called asynchronously, - returns the request thread. + For full HTTP response details (status code, headers, etc.), use the corresponding + ``get_access_policies_with_http_info()`` method instead. + + Args: + + Returns: + :class:`~nipyapi.registry.models.list[AccessPolicy]`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): @@ -166,25 +150,19 @@ def get_access_policies(self, **kwargs): def get_access_policies_with_http_info(self, **kwargs): """ - Get all access policies + Get all access policies. + 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_access_policies()`` method instead. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_access_policies_with_http_info(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :return: list[AccessPolicy] - If the method is called asynchronously, - returns the request thread. + Args: + + Returns: + tuple: (:class:`~nipyapi.registry.models.list[AccessPolicy]`, status_code, headers) - Response data with HTTP details. """ all_params = [] - all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -215,12 +193,8 @@ def get_access_policies_with_http_info(self, **kwargs): header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['*/*']) - # Authentication setting - auth_settings = ['tokenAuth', 'Authorization'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/policies', 'GET', path_params, @@ -231,7 +205,6 @@ def get_access_policies_with_http_info(self, **kwargs): files=local_var_files, response_type='list[AccessPolicy]', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), @@ -239,22 +212,18 @@ def get_access_policies_with_http_info(self, **kwargs): def get_access_policy(self, id, **kwargs): """ - Get access policy + Get access policy. + This method makes a synchronous HTTP request and returns the response data directly. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_access_policy(id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The access policy id. (required) - :return: AccessPolicy - If the method is called asynchronously, - returns the request thread. + For full HTTP response details (status code, headers, etc.), use the corresponding + ``get_access_policy_with_http_info()`` method instead. + + Args: + id (str): + The access policy id. (required) + + Returns: + :class:`~nipyapi.registry.models.AccessPolicy`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): @@ -265,26 +234,21 @@ def get_access_policy(self, id, **kwargs): def get_access_policy_with_http_info(self, id, **kwargs): """ - Get access policy + Get access policy. + 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_access_policy()`` method instead. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_access_policy_with_http_info(id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The access policy id. (required) - :return: AccessPolicy - If the method is called asynchronously, - returns the request thread. + Args: + id (str): + The access policy id. (required) + + Returns: + tuple: (:class:`~nipyapi.registry.models.AccessPolicy`, status_code, headers) - Response data with HTTP details. """ all_params = ['id'] - all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -302,7 +266,7 @@ def get_access_policy_with_http_info(self, id, **kwargs): if ('id' not in params) or (params['id'] is None): raise ValueError("Missing the required parameter `id` when calling `get_access_policy`") - + collection_formats = {} path_params = {} @@ -321,12 +285,8 @@ def get_access_policy_with_http_info(self, id, **kwargs): header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['*/*']) - # Authentication setting - auth_settings = ['tokenAuth', 'Authorization'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/policies/{id}', 'GET', path_params, @@ -337,7 +297,6 @@ def get_access_policy_with_http_info(self, id, **kwargs): files=local_var_files, response_type='AccessPolicy', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), @@ -345,23 +304,23 @@ def get_access_policy_with_http_info(self, id, **kwargs): def get_access_policy_for_resource(self, action, resource, **kwargs): """ - Get access policy for resource + Get access policy for resource. + Gets an access policy for the specified action and resource - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_access_policy_for_resource(action, resource, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str action: The request action. (required) - :param str resource: The resource of the policy. (required) - :return: AccessPolicy - If the method is called asynchronously, - returns the request thread. + + 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_access_policy_for_resource_with_http_info()`` method instead. + + Args: + action (str): + The request action. (required) + resource (str): + The resource of the policy. (required) + + Returns: + :class:`~nipyapi.registry.models.AccessPolicy`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): @@ -372,27 +331,26 @@ def get_access_policy_for_resource(self, action, resource, **kwargs): def get_access_policy_for_resource_with_http_info(self, action, resource, **kwargs): """ - Get access policy for resource + Get access policy for resource. + Gets an access policy for the specified action and resource - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_access_policy_for_resource_with_http_info(action, resource, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str action: The request action. (required) - :param str resource: The resource of the policy. (required) - :return: AccessPolicy - If the method is called asynchronously, - returns the request thread. + + 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_access_policy_for_resource()`` method instead. + + Args: + action (str): + The request action. (required) + resource (str): + The resource of the policy. (required) + + Returns: + tuple: (:class:`~nipyapi.registry.models.AccessPolicy`, status_code, headers) - Response data with HTTP details. """ all_params = ['action', 'resource'] - all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -413,9 +371,8 @@ def get_access_policy_for_resource_with_http_info(self, action, resource, **kwar if ('resource' not in params) or (params['resource'] is None): raise ValueError("Missing the required parameter `resource` when calling `get_access_policy_for_resource`") - if 'resource' in params and not re.search('.+', params['resource']): - raise ValueError("Invalid value for parameter `resource` when calling `get_access_policy_for_resource`, must conform to the pattern `/.+/`") - + + collection_formats = {} path_params = {} @@ -436,12 +393,8 @@ def get_access_policy_for_resource_with_http_info(self, action, resource, **kwar header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['*/*']) - # Authentication setting - auth_settings = ['tokenAuth', 'Authorization'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/policies/{action}/{resource}', 'GET', path_params, @@ -452,7 +405,6 @@ def get_access_policy_for_resource_with_http_info(self, action, resource, **kwar files=local_var_files, response_type='AccessPolicy', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), @@ -460,21 +412,19 @@ def get_access_policy_for_resource_with_http_info(self, action, resource, **kwar def get_resources(self, **kwargs): """ - Get available resources + Get available resources. + Gets the available resources that support access/authorization policies - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_resources(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :return: list[Resource] - If the method is called asynchronously, - returns the request thread. + + 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_resources_with_http_info()`` method instead. + + Args: + + Returns: + :class:`~nipyapi.registry.models.list[Resource]`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): @@ -485,25 +435,22 @@ def get_resources(self, **kwargs): def get_resources_with_http_info(self, **kwargs): """ - Get available resources + Get available resources. + Gets the available resources that support access/authorization policies - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_resources_with_http_info(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :return: list[Resource] - If the method is called asynchronously, - returns the request thread. + + 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_resources()`` method instead. + + Args: + + Returns: + tuple: (:class:`~nipyapi.registry.models.list[Resource]`, status_code, headers) - Response data with HTTP details. """ all_params = [] - all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -534,12 +481,8 @@ def get_resources_with_http_info(self, **kwargs): header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['*/*']) - # Authentication setting - auth_settings = ['tokenAuth', 'Authorization'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/policies/resources', 'GET', path_params, @@ -550,7 +493,6 @@ def get_resources_with_http_info(self, **kwargs): files=local_var_files, response_type='list[Resource]', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), @@ -558,24 +500,22 @@ def get_resources_with_http_info(self, **kwargs): def remove_access_policy(self, version, id, **kwargs): """ - Delete access policy + Delete access policy. + 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 + ``remove_access_policy_with_http_info()`` method instead. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.remove_access_policy(version, id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str version: The version is used to verify the client is working with the latest version of the entity. (required) - :param str id: The access policy id. (required) - :param str client_id: If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response. - :return: AccessPolicy - If the method is called asynchronously, - returns the request thread. + Args: + version (:class:`~nipyapi.registry.models.LongParameter`): + The version is used to verify the client is working with the latest version of the entity. (required) + id (str): + The access policy id. (required) + client_id (:class:`~nipyapi.registry.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. + + Returns: + :class:`~nipyapi.registry.models.AccessPolicy`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): @@ -586,28 +526,25 @@ def remove_access_policy(self, version, id, **kwargs): def remove_access_policy_with_http_info(self, version, id, **kwargs): """ - Delete access policy + Delete access policy. + 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 ``remove_access_policy()`` method instead. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.remove_access_policy_with_http_info(version, id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str version: The version is used to verify the client is working with the latest version of the entity. (required) - :param str id: The access policy id. (required) - :param str client_id: If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response. - :return: AccessPolicy - If the method is called asynchronously, - returns the request thread. + Args: + version (:class:`~nipyapi.registry.models.LongParameter`): + The version is used to verify the client is working with the latest version of the entity. (required) + id (str): + The access policy id. (required) + client_id (:class:`~nipyapi.registry.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. + + Returns: + tuple: (:class:`~nipyapi.registry.models.AccessPolicy`, status_code, headers) - Response data with HTTP details. """ all_params = ['version', 'id', 'client_id'] - all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -628,7 +565,9 @@ def remove_access_policy_with_http_info(self, version, id, **kwargs): if ('id' not in params) or (params['id'] is None): raise ValueError("Missing the required parameter `id` when calling `remove_access_policy`") - + + + collection_formats = {} path_params = {} @@ -651,12 +590,8 @@ def remove_access_policy_with_http_info(self, version, id, **kwargs): header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['*/*']) - # Authentication setting - auth_settings = ['tokenAuth', 'Authorization'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/policies/{id}', 'DELETE', path_params, @@ -667,62 +602,54 @@ def remove_access_policy_with_http_info(self, version, id, **kwargs): files=local_var_files, response_type='AccessPolicy', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def update_access_policy(self, id, body, **kwargs): + def update_access_policy(self, body, id, **kwargs): """ - Update access policy + Update access policy. + This method makes a synchronous HTTP request and returns the response data directly. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.update_access_policy(id, body, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The access policy id. (required) - :param AccessPolicy body: The access policy configuration details. (required) - :return: AccessPolicy - If the method is called asynchronously, - returns the request thread. + For full HTTP response details (status code, headers, etc.), use the corresponding + ``update_access_policy_with_http_info()`` method instead. + + Args: + body (:class:`~nipyapi.registry.models.AccessPolicy`): + The access policy configuration details. (required) + id (str): + The access policy id. (required) + + Returns: + :class:`~nipyapi.registry.models.AccessPolicy`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.update_access_policy_with_http_info(id, body, **kwargs) + return self.update_access_policy_with_http_info(body, id, **kwargs) else: - (data) = self.update_access_policy_with_http_info(id, body, **kwargs) + (data) = self.update_access_policy_with_http_info(body, id, **kwargs) return data - def update_access_policy_with_http_info(self, id, body, **kwargs): + def update_access_policy_with_http_info(self, body, id, **kwargs): """ - Update access policy + Update access policy. + 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 ``update_access_policy()`` method instead. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.update_access_policy_with_http_info(id, body, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The access policy id. (required) - :param AccessPolicy body: The access policy configuration details. (required) - :return: AccessPolicy - If the method is called asynchronously, - returns the request thread. + Args: + body (:class:`~nipyapi.registry.models.AccessPolicy`): + The access policy configuration details. (required) + id (str): + The access policy id. (required) + + Returns: + tuple: (:class:`~nipyapi.registry.models.AccessPolicy`, status_code, headers) - Response data with HTTP details. """ - all_params = ['id', 'body'] - all_params.append('callback') + all_params = ['body', 'id'] all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -736,14 +663,15 @@ def update_access_policy_with_http_info(self, id, body, **kwargs): ) params[key] = val del params['kwargs'] - # verify the required parameter 'id' is set - if ('id' not in params) or (params['id'] is None): - raise ValueError("Missing the required parameter `id` when calling `update_access_policy`") # verify the required parameter 'body' is set if ('body' not in params) or (params['body'] is None): raise ValueError("Missing the required parameter `body` when calling `update_access_policy`") + # verify the required parameter 'id' is set + if ('id' not in params) or (params['id'] is None): + raise ValueError("Missing the required parameter `id` when calling `update_access_policy`") - + + collection_formats = {} path_params = {} @@ -769,7 +697,7 @@ def update_access_policy_with_http_info(self, id, body, **kwargs): select_header_content_type(['application/json']) # Authentication setting - auth_settings = ['tokenAuth', 'Authorization'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/policies/{id}', 'PUT', path_params, @@ -780,7 +708,6 @@ def update_access_policy_with_http_info(self, id, body, **kwargs): files=local_var_files, response_type='AccessPolicy', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), diff --git a/nipyapi/registry/apis/tenants_api.py b/nipyapi/registry/apis/tenants_api.py index 799333ec..7898cdeb 100644 --- a/nipyapi/registry/apis/tenants_api.py +++ b/nipyapi/registry/apis/tenants_api.py @@ -1,14 +1,13 @@ """ Apache NiFi Registry REST API - The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components. + REST API definition for Apache NiFi Registry web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - import sys import os import re @@ -35,22 +34,21 @@ def __init__(self, api_client=None): def create_user(self, body, **kwargs): """ - Create user + Create user. + NOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.create_user(body, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param User body: The user configuration details. (required) - :return: User - If the method is called asynchronously, - returns the request thread. + + 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_user_with_http_info()`` method instead. + + Args: + body (:class:`~nipyapi.registry.models.User`): + The user configuration details. (required) + + Returns: + :class:`~nipyapi.registry.models.User`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): @@ -61,26 +59,24 @@ def create_user(self, body, **kwargs): def create_user_with_http_info(self, body, **kwargs): """ - Create user + Create user. + NOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.create_user_with_http_info(body, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param User body: The user configuration details. (required) - :return: User - If the method is called asynchronously, - returns the request thread. + + 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_user()`` method instead. + + Args: + body (:class:`~nipyapi.registry.models.User`): + The user configuration details. (required) + + Returns: + tuple: (:class:`~nipyapi.registry.models.User`, status_code, headers) - Response data with HTTP details. """ all_params = ['body'] - all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -98,7 +94,7 @@ def create_user_with_http_info(self, body, **kwargs): if ('body' not in params) or (params['body'] is None): raise ValueError("Missing the required parameter `body` when calling `create_user`") - + collection_formats = {} path_params = {} @@ -122,7 +118,7 @@ def create_user_with_http_info(self, body, **kwargs): select_header_content_type(['application/json']) # Authentication setting - auth_settings = ['tokenAuth', 'Authorization'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/tenants/users', 'POST', path_params, @@ -133,7 +129,6 @@ def create_user_with_http_info(self, body, **kwargs): files=local_var_files, response_type='User', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), @@ -141,22 +136,21 @@ def create_user_with_http_info(self, body, **kwargs): def create_user_group(self, body, **kwargs): """ - Create user group + Create user group. + NOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.create_user_group(body, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param UserGroup body: The user group configuration details. (required) - :return: UserGroup - If the method is called asynchronously, - returns the request thread. + + 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_user_group_with_http_info()`` method instead. + + Args: + body (:class:`~nipyapi.registry.models.UserGroup`): + The user group configuration details. (required) + + Returns: + :class:`~nipyapi.registry.models.UserGroup`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): @@ -167,26 +161,24 @@ def create_user_group(self, body, **kwargs): def create_user_group_with_http_info(self, body, **kwargs): """ - Create user group + Create user group. + NOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.create_user_group_with_http_info(body, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param UserGroup body: The user group configuration details. (required) - :return: UserGroup - If the method is called asynchronously, - returns the request thread. + + 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_user_group()`` method instead. + + Args: + body (:class:`~nipyapi.registry.models.UserGroup`): + The user group configuration details. (required) + + Returns: + tuple: (:class:`~nipyapi.registry.models.UserGroup`, status_code, headers) - Response data with HTTP details. """ all_params = ['body'] - all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -204,7 +196,7 @@ def create_user_group_with_http_info(self, body, **kwargs): if ('body' not in params) or (params['body'] is None): raise ValueError("Missing the required parameter `body` when calling `create_user_group`") - + collection_formats = {} path_params = {} @@ -228,7 +220,7 @@ def create_user_group_with_http_info(self, body, **kwargs): select_header_content_type(['application/json']) # Authentication setting - auth_settings = ['tokenAuth', 'Authorization'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/tenants/user-groups', 'POST', path_params, @@ -239,7 +231,6 @@ def create_user_group_with_http_info(self, body, **kwargs): files=local_var_files, response_type='UserGroup', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), @@ -247,22 +238,21 @@ def create_user_group_with_http_info(self, body, **kwargs): def get_user(self, id, **kwargs): """ - Get user + Get user. + NOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_user(id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The user id. (required) - :return: User - If the method is called asynchronously, - returns the request thread. + + 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_user_with_http_info()`` method instead. + + Args: + id (str): + The user id. (required) + + Returns: + :class:`~nipyapi.registry.models.User`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): @@ -273,26 +263,24 @@ def get_user(self, id, **kwargs): def get_user_with_http_info(self, id, **kwargs): """ - Get user + Get user. + NOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_user_with_http_info(id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The user id. (required) - :return: User - If the method is called asynchronously, - returns the request thread. + + 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_user()`` method instead. + + Args: + id (str): + The user id. (required) + + Returns: + tuple: (:class:`~nipyapi.registry.models.User`, status_code, headers) - Response data with HTTP details. """ all_params = ['id'] - all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -310,7 +298,7 @@ def get_user_with_http_info(self, id, **kwargs): if ('id' not in params) or (params['id'] is None): raise ValueError("Missing the required parameter `id` when calling `get_user`") - + collection_formats = {} path_params = {} @@ -329,12 +317,8 @@ def get_user_with_http_info(self, id, **kwargs): header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['*/*']) - # Authentication setting - auth_settings = ['tokenAuth', 'Authorization'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/tenants/users/{id}', 'GET', path_params, @@ -345,7 +329,6 @@ def get_user_with_http_info(self, id, **kwargs): files=local_var_files, response_type='User', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), @@ -353,22 +336,21 @@ def get_user_with_http_info(self, id, **kwargs): def get_user_group(self, id, **kwargs): """ - Get user group + Get user group. + NOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_user_group(id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The user group id. (required) - :return: UserGroup - If the method is called asynchronously, - returns the request thread. + + 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_user_group_with_http_info()`` method instead. + + Args: + id (str): + The user group id. (required) + + Returns: + :class:`~nipyapi.registry.models.UserGroup`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): @@ -379,26 +361,24 @@ def get_user_group(self, id, **kwargs): def get_user_group_with_http_info(self, id, **kwargs): """ - Get user group + Get user group. + NOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_user_group_with_http_info(id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The user group id. (required) - :return: UserGroup - If the method is called asynchronously, - returns the request thread. + + 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_user_group()`` method instead. + + Args: + id (str): + The user group id. (required) + + Returns: + tuple: (:class:`~nipyapi.registry.models.UserGroup`, status_code, headers) - Response data with HTTP details. """ all_params = ['id'] - all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -416,7 +396,7 @@ def get_user_group_with_http_info(self, id, **kwargs): if ('id' not in params) or (params['id'] is None): raise ValueError("Missing the required parameter `id` when calling `get_user_group`") - + collection_formats = {} path_params = {} @@ -435,12 +415,8 @@ def get_user_group_with_http_info(self, id, **kwargs): header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['*/*']) - # Authentication setting - auth_settings = ['tokenAuth', 'Authorization'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/tenants/user-groups/{id}', 'GET', path_params, @@ -451,7 +427,6 @@ def get_user_group_with_http_info(self, id, **kwargs): files=local_var_files, response_type='UserGroup', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), @@ -459,21 +434,19 @@ def get_user_group_with_http_info(self, id, **kwargs): def get_user_groups(self, **kwargs): """ - Get user groups + Get user groups. + NOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_user_groups(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :return: list[UserGroup] - If the method is called asynchronously, - returns the request thread. + + 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_user_groups_with_http_info()`` method instead. + + Args: + + Returns: + :class:`~nipyapi.registry.models.list[UserGroup]`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): @@ -484,25 +457,22 @@ def get_user_groups(self, **kwargs): def get_user_groups_with_http_info(self, **kwargs): """ - Get user groups + Get user groups. + NOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_user_groups_with_http_info(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :return: list[UserGroup] - If the method is called asynchronously, - returns the request thread. + + 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_user_groups()`` method instead. + + Args: + + Returns: + tuple: (:class:`~nipyapi.registry.models.list[UserGroup]`, status_code, headers) - Response data with HTTP details. """ all_params = [] - all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -533,12 +503,8 @@ def get_user_groups_with_http_info(self, **kwargs): header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['*/*']) - # Authentication setting - auth_settings = ['tokenAuth', 'Authorization'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/tenants/user-groups', 'GET', path_params, @@ -549,7 +515,6 @@ def get_user_groups_with_http_info(self, **kwargs): files=local_var_files, response_type='list[UserGroup]', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), @@ -557,21 +522,19 @@ def get_user_groups_with_http_info(self, **kwargs): def get_users(self, **kwargs): """ - Get all users + Get all users. + NOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_users(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :return: list[User] - If the method is called asynchronously, - returns the request thread. + + 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_users_with_http_info()`` method instead. + + Args: + + Returns: + :class:`~nipyapi.registry.models.list[User]`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): @@ -582,25 +545,22 @@ def get_users(self, **kwargs): def get_users_with_http_info(self, **kwargs): """ - Get all users + Get all users. + NOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_users_with_http_info(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :return: list[User] - If the method is called asynchronously, - returns the request thread. + + 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_users()`` method instead. + + Args: + + Returns: + tuple: (:class:`~nipyapi.registry.models.list[User]`, status_code, headers) - Response data with HTTP details. """ all_params = [] - all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -631,12 +591,8 @@ def get_users_with_http_info(self, **kwargs): header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['*/*']) - # Authentication setting - auth_settings = ['tokenAuth', 'Authorization'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/tenants/users', 'GET', path_params, @@ -647,7 +603,6 @@ def get_users_with_http_info(self, **kwargs): files=local_var_files, response_type='list[User]', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), @@ -655,24 +610,25 @@ def get_users_with_http_info(self, **kwargs): def remove_user(self, version, id, **kwargs): """ - Delete user + Delete user. + NOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.remove_user(version, id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str version: The version is used to verify the client is working with the latest version of the entity. (required) - :param str id: The user id. (required) - :param str client_id: If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response. - :return: User - If the method is called asynchronously, - returns the request thread. + + 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 + ``remove_user_with_http_info()`` method instead. + + Args: + version (:class:`~nipyapi.registry.models.LongParameter`): + The version is used to verify the client is working with the latest version of the entity. (required) + id (str): + The user id. (required) + client_id (:class:`~nipyapi.registry.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. + + Returns: + :class:`~nipyapi.registry.models.User`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): @@ -683,28 +639,28 @@ def remove_user(self, version, id, **kwargs): def remove_user_with_http_info(self, version, id, **kwargs): """ - Delete user + Delete user. + NOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.remove_user_with_http_info(version, id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str version: The version is used to verify the client is working with the latest version of the entity. (required) - :param str id: The user id. (required) - :param str client_id: If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response. - :return: User - If the method is called asynchronously, - returns the request thread. + + 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 ``remove_user()`` method instead. + + Args: + version (:class:`~nipyapi.registry.models.LongParameter`): + The version is used to verify the client is working with the latest version of the entity. (required) + id (str): + The user id. (required) + client_id (:class:`~nipyapi.registry.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. + + Returns: + tuple: (:class:`~nipyapi.registry.models.User`, status_code, headers) - Response data with HTTP details. """ all_params = ['version', 'id', 'client_id'] - all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -725,7 +681,9 @@ def remove_user_with_http_info(self, version, id, **kwargs): if ('id' not in params) or (params['id'] is None): raise ValueError("Missing the required parameter `id` when calling `remove_user`") - + + + collection_formats = {} path_params = {} @@ -748,12 +706,8 @@ def remove_user_with_http_info(self, version, id, **kwargs): header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['*/*']) - # Authentication setting - auth_settings = ['tokenAuth', 'Authorization'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/tenants/users/{id}', 'DELETE', path_params, @@ -764,7 +718,6 @@ def remove_user_with_http_info(self, version, id, **kwargs): files=local_var_files, response_type='User', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), @@ -772,24 +725,25 @@ def remove_user_with_http_info(self, version, id, **kwargs): def remove_user_group(self, version, id, **kwargs): """ - Delete user group + Delete user group. + NOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.remove_user_group(version, id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str version: The version is used to verify the client is working with the latest version of the entity. (required) - :param str id: The user group id. (required) - :param str client_id: If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response. - :return: UserGroup - If the method is called asynchronously, - returns the request thread. + + 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 + ``remove_user_group_with_http_info()`` method instead. + + Args: + version (:class:`~nipyapi.registry.models.LongParameter`): + The version is used to verify the client is working with the latest version of the entity. (required) + id (str): + The user group id. (required) + client_id (:class:`~nipyapi.registry.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. + + Returns: + :class:`~nipyapi.registry.models.UserGroup`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): @@ -800,28 +754,28 @@ def remove_user_group(self, version, id, **kwargs): def remove_user_group_with_http_info(self, version, id, **kwargs): """ - Delete user group + Delete user group. + NOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.remove_user_group_with_http_info(version, id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str version: The version is used to verify the client is working with the latest version of the entity. (required) - :param str id: The user group id. (required) - :param str client_id: If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response. - :return: UserGroup - If the method is called asynchronously, - returns the request thread. + + 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 ``remove_user_group()`` method instead. + + Args: + version (:class:`~nipyapi.registry.models.LongParameter`): + The version is used to verify the client is working with the latest version of the entity. (required) + id (str): + The user group id. (required) + client_id (:class:`~nipyapi.registry.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. + + Returns: + tuple: (:class:`~nipyapi.registry.models.UserGroup`, status_code, headers) - Response data with HTTP details. """ all_params = ['version', 'id', 'client_id'] - all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -842,7 +796,9 @@ def remove_user_group_with_http_info(self, version, id, **kwargs): if ('id' not in params) or (params['id'] is None): raise ValueError("Missing the required parameter `id` when calling `remove_user_group`") - + + + collection_formats = {} path_params = {} @@ -865,12 +821,8 @@ def remove_user_group_with_http_info(self, version, id, **kwargs): header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['*/*']) - # Authentication setting - auth_settings = ['tokenAuth', 'Authorization'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/tenants/user-groups/{id}', 'DELETE', path_params, @@ -881,62 +833,60 @@ def remove_user_group_with_http_info(self, version, id, **kwargs): files=local_var_files, response_type='UserGroup', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def update_user(self, id, body, **kwargs): + def update_user(self, body, id, **kwargs): """ - Update user + Update user. + NOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.update_user(id, body, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The user id. (required) - :param User body: The user configuration details. (required) - :return: User - If the method is called asynchronously, - returns the request thread. + + 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 + ``update_user_with_http_info()`` method instead. + + Args: + body (:class:`~nipyapi.registry.models.User`): + The user configuration details. (required) + id (str): + The user id. (required) + + Returns: + :class:`~nipyapi.registry.models.User`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.update_user_with_http_info(id, body, **kwargs) + return self.update_user_with_http_info(body, id, **kwargs) else: - (data) = self.update_user_with_http_info(id, body, **kwargs) + (data) = self.update_user_with_http_info(body, id, **kwargs) return data - def update_user_with_http_info(self, id, body, **kwargs): + def update_user_with_http_info(self, body, id, **kwargs): """ - Update user + Update user. + NOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.update_user_with_http_info(id, body, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The user id. (required) - :param User body: The user configuration details. (required) - :return: User - If the method is called asynchronously, - returns the request thread. + + 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 ``update_user()`` method instead. + + Args: + body (:class:`~nipyapi.registry.models.User`): + The user configuration details. (required) + id (str): + The user id. (required) + + Returns: + tuple: (:class:`~nipyapi.registry.models.User`, status_code, headers) - Response data with HTTP details. """ - all_params = ['id', 'body'] - all_params.append('callback') + all_params = ['body', 'id'] all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -950,14 +900,15 @@ def update_user_with_http_info(self, id, body, **kwargs): ) params[key] = val del params['kwargs'] - # verify the required parameter 'id' is set - if ('id' not in params) or (params['id'] is None): - raise ValueError("Missing the required parameter `id` when calling `update_user`") # verify the required parameter 'body' is set if ('body' not in params) or (params['body'] is None): raise ValueError("Missing the required parameter `body` when calling `update_user`") + # verify the required parameter 'id' is set + if ('id' not in params) or (params['id'] is None): + raise ValueError("Missing the required parameter `id` when calling `update_user`") - + + collection_formats = {} path_params = {} @@ -983,7 +934,7 @@ def update_user_with_http_info(self, id, body, **kwargs): select_header_content_type(['application/json']) # Authentication setting - auth_settings = ['tokenAuth', 'Authorization'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/tenants/users/{id}', 'PUT', path_params, @@ -994,62 +945,60 @@ def update_user_with_http_info(self, id, body, **kwargs): files=local_var_files, response_type='User', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def update_user_group(self, id, body, **kwargs): + def update_user_group(self, body, id, **kwargs): """ - Update user group + Update user group. + NOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.update_user_group(id, body, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The user group id. (required) - :param UserGroup body: The user group configuration details. (required) - :return: UserGroup - If the method is called asynchronously, - returns the request thread. + + 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 + ``update_user_group_with_http_info()`` method instead. + + Args: + body (:class:`~nipyapi.registry.models.UserGroup`): + The user group configuration details. (required) + id (str): + The user group id. (required) + + Returns: + :class:`~nipyapi.registry.models.UserGroup`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.update_user_group_with_http_info(id, body, **kwargs) + return self.update_user_group_with_http_info(body, id, **kwargs) else: - (data) = self.update_user_group_with_http_info(id, body, **kwargs) + (data) = self.update_user_group_with_http_info(body, id, **kwargs) return data - def update_user_group_with_http_info(self, id, body, **kwargs): + def update_user_group_with_http_info(self, body, id, **kwargs): """ - Update user group + Update user group. + NOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve. - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.update_user_group_with_http_info(id, body, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The user group id. (required) - :param UserGroup body: The user group configuration details. (required) - :return: UserGroup - If the method is called asynchronously, - returns the request thread. + + 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 ``update_user_group()`` method instead. + + Args: + body (:class:`~nipyapi.registry.models.UserGroup`): + The user group configuration details. (required) + id (str): + The user group id. (required) + + Returns: + tuple: (:class:`~nipyapi.registry.models.UserGroup`, status_code, headers) - Response data with HTTP details. """ - all_params = ['id', 'body'] - all_params.append('callback') + all_params = ['body', 'id'] all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -1063,14 +1012,15 @@ def update_user_group_with_http_info(self, id, body, **kwargs): ) params[key] = val del params['kwargs'] - # verify the required parameter 'id' is set - if ('id' not in params) or (params['id'] is None): - raise ValueError("Missing the required parameter `id` when calling `update_user_group`") # verify the required parameter 'body' is set if ('body' not in params) or (params['body'] is None): raise ValueError("Missing the required parameter `body` when calling `update_user_group`") + # verify the required parameter 'id' is set + if ('id' not in params) or (params['id'] is None): + raise ValueError("Missing the required parameter `id` when calling `update_user_group`") - + + collection_formats = {} path_params = {} @@ -1096,7 +1046,7 @@ def update_user_group_with_http_info(self, id, body, **kwargs): select_header_content_type(['application/json']) # Authentication setting - auth_settings = ['tokenAuth', 'Authorization'] + auth_settings = ['bearerAuth'] return self.api_client.call_api('/tenants/user-groups/{id}', 'PUT', path_params, @@ -1107,7 +1057,6 @@ def update_user_group_with_http_info(self, id, body, **kwargs): files=local_var_files, response_type='UserGroup', auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), diff --git a/nipyapi/registry/configuration.py b/nipyapi/registry/configuration.py index 6ea462be..1a314c1c 100644 --- a/nipyapi/registry/configuration.py +++ b/nipyapi/registry/configuration.py @@ -1,14 +1,13 @@ """ Apache NiFi Registry REST API - The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components. + REST API definition for Apache NiFi Registry web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - import urllib3 import sys @@ -40,7 +39,7 @@ def __init__(self): Constructor """ # Default Base url - self.host = "http://localhost/nifi-registry-api" + self.host = "/" # Default api client self.api_client = None # Temp file folder for downloading files @@ -56,7 +55,6 @@ def __init__(self): self.username = "" # Password for HTTP basic authentication self.password = "" - # Logging Settings self.logger = {} self.logger["package_logger"] = logging.getLogger("registry") @@ -83,6 +81,8 @@ def __init__(self): self.key_file = None # client key password self.key_password = None + # Set this to false to skip hostname verification when calling API from https server. + self.disable_host_check = None # Alternative TLS configuration: set this to an instance of ssl.SSLContext or urllib3.util.ssl_.SSLContext self.ssl_context = None @@ -207,12 +207,12 @@ def auth_settings(self): :return: The Auth Settings information dict. """ return { - 'tokenAuth': + 'bearerAuth': { 'type': 'api_key', 'in': 'header', 'key': 'Authorization', - 'value': self.get_api_key_with_prefix('tokenAuth') + 'value': self.get_api_key_with_prefix('bearerAuth') }, 'basicAuth': { @@ -221,21 +221,6 @@ def auth_settings(self): 'key': 'Authorization', 'value': self.get_basic_auth_token() }, - 'Authorization': - { - 'type': 'api_key', - 'in': 'header', - 'key': 'Authorization', - 'value': self.get_api_key_with_prefix('Authorization') - }, - 'BasicAuth': - { - 'type': 'basic', - 'in': 'header', - 'key': 'Authorization', - 'value': self.get_basic_auth_token() - }, - } def to_debug_report(self): @@ -247,6 +232,6 @@ def to_debug_report(self): return "Python SDK Debug Report:\n"\ "OS: {env}\n"\ "Python Version: {pyversion}\n"\ - "Version of the API: 1.28.1\n"\ + "Version of the API: 2.5.0\n"\ "SDK Package Version: 1.0.0".\ format(env=sys.platform, pyversion=sys.version) diff --git a/nipyapi/registry/models/__init__.py b/nipyapi/registry/models/__init__.py index 411b3367..a3bbd28e 100644 --- a/nipyapi/registry/models/__init__.py +++ b/nipyapi/registry/models/__init__.py @@ -1,14 +1,13 @@ """ Apache NiFi Registry REST API - The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components. + REST API definition for Apache NiFi Registry web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - # import models into model package from .access_policy import AccessPolicy from .access_policy_summary import AccessPolicySummary @@ -23,6 +22,8 @@ from .bundle_version import BundleVersion from .bundle_version_dependency import BundleVersionDependency from .bundle_version_metadata import BundleVersionMetadata +from .bundles_bundle_type_body import BundlesBundleTypeBody +from .client_id_parameter import ClientIdParameter from .component_difference import ComponentDifference from .component_difference_group import ComponentDifferenceGroup from .connectable_component import ConnectableComponent @@ -37,7 +38,6 @@ from .dynamic_property import DynamicProperty from .dynamic_relationship import DynamicRelationship from .extension import Extension -from .extension_bundle import ExtensionBundle from .extension_filter_params import ExtensionFilterParams from .extension_metadata import ExtensionMetadata from .extension_metadata_container import ExtensionMetadataContainer @@ -48,11 +48,15 @@ from .extension_repo_version_summary import ExtensionRepoVersionSummary from .external_controller_service_reference import ExternalControllerServiceReference from .fields import Fields -from .jaxb_link import JaxbLink +from .form_data_content_disposition import FormDataContentDisposition +from .link import Link +from .long_parameter import LongParameter from .model_property import ModelProperty +from .multi_processor_use_case import MultiProcessorUseCase from .parameter_provider_reference import ParameterProviderReference from .permissions import Permissions from .position import Position +from .processor_configuration import ProcessorConfiguration from .provided_service_api import ProvidedServiceAPI from .registry_about import RegistryAbout from .registry_configuration import RegistryConfiguration @@ -67,8 +71,11 @@ from .system_resource_consideration import SystemResourceConsideration from .tag_count import TagCount from .tenant import Tenant +from .uri_builder import UriBuilder +from .use_case import UseCase from .user import User from .user_group import UserGroup +from .versioned_asset import VersionedAsset from .versioned_connection import VersionedConnection from .versioned_controller_service import VersionedControllerService from .versioned_flow import VersionedFlow diff --git a/nipyapi/registry/models/access_policy.py b/nipyapi/registry/models/access_policy.py index be97fff4..bd17c593 100644 --- a/nipyapi/registry/models/access_policy.py +++ b/nipyapi/registry/models/access_policy.py @@ -1,14 +1,13 @@ """ Apache NiFi Registry REST API - The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components. + REST API definition for Apache NiFi Registry web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,98 +27,50 @@ class AccessPolicy(object): and the value is json key in definition. """ swagger_types = { - 'identifier': 'str', - 'resource': 'str', 'action': 'str', - 'configurable': 'bool', - 'revision': 'RevisionInfo', - 'users': 'list[Tenant]', - 'user_groups': 'list[Tenant]' - } +'configurable': 'bool', +'identifier': 'str', +'resource': 'str', +'revision': 'RevisionInfo', +'user_groups': 'list[Tenant]', +'users': 'list[Tenant]' } attribute_map = { - 'identifier': 'identifier', - 'resource': 'resource', 'action': 'action', - 'configurable': 'configurable', - 'revision': 'revision', - 'users': 'users', - 'user_groups': 'userGroups' - } +'configurable': 'configurable', +'identifier': 'identifier', +'resource': 'resource', +'revision': 'revision', +'user_groups': 'userGroups', +'users': 'users' } - def __init__(self, identifier=None, resource=None, action=None, configurable=None, revision=None, users=None, user_groups=None): + def __init__(self, action=None, configurable=None, identifier=None, resource=None, revision=None, user_groups=None, users=None): """ AccessPolicy - a model defined in Swagger """ - self._identifier = None - self._resource = None self._action = None self._configurable = None + self._identifier = None + self._resource = None self._revision = None - self._users = None self._user_groups = None + self._users = None - if identifier is not None: - self.identifier = identifier - self.resource = resource - self.action = action + if action is not None: + self.action = action if configurable is not None: self.configurable = configurable + if identifier is not None: + self.identifier = identifier + if resource is not None: + self.resource = resource if revision is not None: self.revision = revision - if users is not None: - self.users = users if user_groups is not None: self.user_groups = user_groups - - @property - def identifier(self): - """ - Gets the identifier of this AccessPolicy. - The id of the policy. Set by server at creation time. - - :return: The identifier of this AccessPolicy. - :rtype: str - """ - return self._identifier - - @identifier.setter - def identifier(self, identifier): - """ - Sets the identifier of this AccessPolicy. - The id of the policy. Set by server at creation time. - - :param identifier: The identifier of this AccessPolicy. - :type: str - """ - - self._identifier = identifier - - @property - def resource(self): - """ - Gets the resource of this AccessPolicy. - The resource for this access policy. - - :return: The resource of this AccessPolicy. - :rtype: str - """ - return self._resource - - @resource.setter - def resource(self, resource): - """ - Sets the resource of this AccessPolicy. - The resource for this access policy. - - :param resource: The resource of this AccessPolicy. - :type: str - """ - if resource is None: - raise ValueError("Invalid value for `resource`, must not be `None`") - - self._resource = resource + if users is not None: + self.users = users @property def action(self): @@ -141,9 +92,7 @@ def action(self, action): :param action: The action of this AccessPolicy. :type: str """ - if action is None: - raise ValueError("Invalid value for `action`, must not be `None`") - allowed_values = ["read", "write", "delete"] + allowed_values = ["read", "write", "delete", ] if action not in allowed_values: raise ValueError( "Invalid value for `action` ({0}), must be one of {1}" @@ -175,11 +124,56 @@ def configurable(self, configurable): self._configurable = configurable + @property + def identifier(self): + """ + Gets the identifier of this AccessPolicy. + The id of the policy. Set by server at creation time. + + :return: The identifier of this AccessPolicy. + :rtype: str + """ + return self._identifier + + @identifier.setter + def identifier(self, identifier): + """ + Sets the identifier of this AccessPolicy. + The id of the policy. Set by server at creation time. + + :param identifier: The identifier of this AccessPolicy. + :type: str + """ + + self._identifier = identifier + + @property + def resource(self): + """ + Gets the resource of this AccessPolicy. + The resource for this access policy. + + :return: The resource of this AccessPolicy. + :rtype: str + """ + return self._resource + + @resource.setter + def resource(self, resource): + """ + Sets the resource of this AccessPolicy. + The resource for this access policy. + + :param resource: The resource of this AccessPolicy. + :type: str + """ + + self._resource = resource + @property def revision(self): """ Gets the revision of this AccessPolicy. - The revision of this entity used for optimistic-locking during updates. :return: The revision of this AccessPolicy. :rtype: RevisionInfo @@ -190,7 +184,6 @@ def revision(self): def revision(self, revision): """ Sets the revision of this AccessPolicy. - The revision of this entity used for optimistic-locking during updates. :param revision: The revision of this AccessPolicy. :type: RevisionInfo @@ -199,50 +192,50 @@ def revision(self, revision): self._revision = revision @property - def users(self): + def user_groups(self): """ - Gets the users of this AccessPolicy. - The set of user IDs associated with this access policy. + Gets the user_groups of this AccessPolicy. + The set of user group IDs associated with this access policy. - :return: The users of this AccessPolicy. + :return: The user_groups of this AccessPolicy. :rtype: list[Tenant] """ - return self._users + return self._user_groups - @users.setter - def users(self, users): + @user_groups.setter + def user_groups(self, user_groups): """ - Sets the users of this AccessPolicy. - The set of user IDs associated with this access policy. + Sets the user_groups of this AccessPolicy. + The set of user group IDs associated with this access policy. - :param users: The users of this AccessPolicy. + :param user_groups: The user_groups of this AccessPolicy. :type: list[Tenant] """ - self._users = users + self._user_groups = user_groups @property - def user_groups(self): + def users(self): """ - Gets the user_groups of this AccessPolicy. - The set of user group IDs associated with this access policy. + Gets the users of this AccessPolicy. + The set of user IDs associated with this access policy. - :return: The user_groups of this AccessPolicy. + :return: The users of this AccessPolicy. :rtype: list[Tenant] """ - return self._user_groups + return self._users - @user_groups.setter - def user_groups(self, user_groups): + @users.setter + def users(self, users): """ - Sets the user_groups of this AccessPolicy. - The set of user group IDs associated with this access policy. + Sets the users of this AccessPolicy. + The set of user IDs associated with this access policy. - :param user_groups: The user_groups of this AccessPolicy. + :param users: The users of this AccessPolicy. :type: list[Tenant] """ - self._user_groups = user_groups + self._users = users def to_dict(self): """ diff --git a/nipyapi/registry/models/access_policy_summary.py b/nipyapi/registry/models/access_policy_summary.py index 5ec39365..56aa2dab 100644 --- a/nipyapi/registry/models/access_policy_summary.py +++ b/nipyapi/registry/models/access_policy_summary.py @@ -1,14 +1,13 @@ """ Apache NiFi Registry REST API - The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components. + REST API definition for Apache NiFi Registry web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,89 +27,41 @@ class AccessPolicySummary(object): and the value is json key in definition. """ swagger_types = { - 'identifier': 'str', - 'resource': 'str', 'action': 'str', - 'configurable': 'bool', - 'revision': 'RevisionInfo' - } +'configurable': 'bool', +'identifier': 'str', +'resource': 'str', +'revision': 'RevisionInfo' } attribute_map = { - 'identifier': 'identifier', - 'resource': 'resource', 'action': 'action', - 'configurable': 'configurable', - 'revision': 'revision' - } +'configurable': 'configurable', +'identifier': 'identifier', +'resource': 'resource', +'revision': 'revision' } - def __init__(self, identifier=None, resource=None, action=None, configurable=None, revision=None): + def __init__(self, action=None, configurable=None, identifier=None, resource=None, revision=None): """ AccessPolicySummary - a model defined in Swagger """ - self._identifier = None - self._resource = None self._action = None self._configurable = None + self._identifier = None + self._resource = None self._revision = None - if identifier is not None: - self.identifier = identifier - self.resource = resource - self.action = action + if action is not None: + self.action = action if configurable is not None: self.configurable = configurable + if identifier is not None: + self.identifier = identifier + if resource is not None: + self.resource = resource if revision is not None: self.revision = revision - @property - def identifier(self): - """ - Gets the identifier of this AccessPolicySummary. - The id of the policy. Set by server at creation time. - - :return: The identifier of this AccessPolicySummary. - :rtype: str - """ - return self._identifier - - @identifier.setter - def identifier(self, identifier): - """ - Sets the identifier of this AccessPolicySummary. - The id of the policy. Set by server at creation time. - - :param identifier: The identifier of this AccessPolicySummary. - :type: str - """ - - self._identifier = identifier - - @property - def resource(self): - """ - Gets the resource of this AccessPolicySummary. - The resource for this access policy. - - :return: The resource of this AccessPolicySummary. - :rtype: str - """ - return self._resource - - @resource.setter - def resource(self, resource): - """ - Sets the resource of this AccessPolicySummary. - The resource for this access policy. - - :param resource: The resource of this AccessPolicySummary. - :type: str - """ - if resource is None: - raise ValueError("Invalid value for `resource`, must not be `None`") - - self._resource = resource - @property def action(self): """ @@ -131,9 +82,7 @@ def action(self, action): :param action: The action of this AccessPolicySummary. :type: str """ - if action is None: - raise ValueError("Invalid value for `action`, must not be `None`") - allowed_values = ["read", "write", "delete"] + allowed_values = ["read", "write", "delete", ] if action not in allowed_values: raise ValueError( "Invalid value for `action` ({0}), must be one of {1}" @@ -165,11 +114,56 @@ def configurable(self, configurable): self._configurable = configurable + @property + def identifier(self): + """ + Gets the identifier of this AccessPolicySummary. + The id of the policy. Set by server at creation time. + + :return: The identifier of this AccessPolicySummary. + :rtype: str + """ + return self._identifier + + @identifier.setter + def identifier(self, identifier): + """ + Sets the identifier of this AccessPolicySummary. + The id of the policy. Set by server at creation time. + + :param identifier: The identifier of this AccessPolicySummary. + :type: str + """ + + self._identifier = identifier + + @property + def resource(self): + """ + Gets the resource of this AccessPolicySummary. + The resource for this access policy. + + :return: The resource of this AccessPolicySummary. + :rtype: str + """ + return self._resource + + @resource.setter + def resource(self, resource): + """ + Sets the resource of this AccessPolicySummary. + The resource for this access policy. + + :param resource: The resource of this AccessPolicySummary. + :type: str + """ + + self._resource = resource + @property def revision(self): """ Gets the revision of this AccessPolicySummary. - The revision of this entity used for optimistic-locking during updates. :return: The revision of this AccessPolicySummary. :rtype: RevisionInfo @@ -180,7 +174,6 @@ def revision(self): def revision(self, revision): """ Sets the revision of this AccessPolicySummary. - The revision of this entity used for optimistic-locking during updates. :param revision: The revision of this AccessPolicySummary. :type: RevisionInfo diff --git a/nipyapi/registry/models/allowable_value.py b/nipyapi/registry/models/allowable_value.py index fc09821a..2a735a02 100644 --- a/nipyapi/registry/models/allowable_value.py +++ b/nipyapi/registry/models/allowable_value.py @@ -1,14 +1,13 @@ """ Apache NiFi Registry REST API - The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components. + REST API definition for Apache NiFi Registry web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,55 +27,53 @@ class AllowableValue(object): and the value is json key in definition. """ swagger_types = { - 'value': 'str', - 'display_name': 'str', - 'description': 'str' - } + 'description': 'str', +'display_name': 'str', +'value': 'str' } attribute_map = { - 'value': 'value', - 'display_name': 'displayName', - 'description': 'description' - } + 'description': 'description', +'display_name': 'displayName', +'value': 'value' } - def __init__(self, value=None, display_name=None, description=None): + def __init__(self, description=None, display_name=None, value=None): """ AllowableValue - a model defined in Swagger """ - self._value = None - self._display_name = None self._description = None + self._display_name = None + self._value = None - if value is not None: - self.value = value - if display_name is not None: - self.display_name = display_name if description is not None: self.description = description + if display_name is not None: + self.display_name = display_name + if value is not None: + self.value = value @property - def value(self): + def description(self): """ - Gets the value of this AllowableValue. - The value of the allowable value + Gets the description of this AllowableValue. + The description of the allowable value - :return: The value of this AllowableValue. + :return: The description of this AllowableValue. :rtype: str """ - return self._value + return self._description - @value.setter - def value(self, value): + @description.setter + def description(self, description): """ - Sets the value of this AllowableValue. - The value of the allowable value + Sets the description of this AllowableValue. + The description of the allowable value - :param value: The value of this AllowableValue. + :param description: The description of this AllowableValue. :type: str """ - self._value = value + self._description = description @property def display_name(self): @@ -102,27 +99,27 @@ def display_name(self, display_name): self._display_name = display_name @property - def description(self): + def value(self): """ - Gets the description of this AllowableValue. - The description of the allowable value + Gets the value of this AllowableValue. + The value of the allowable value - :return: The description of this AllowableValue. + :return: The value of this AllowableValue. :rtype: str """ - return self._description + return self._value - @description.setter - def description(self, description): + @value.setter + def value(self, value): """ - Sets the description of this AllowableValue. - The description of the allowable value + Sets the value of this AllowableValue. + The value of the allowable value - :param description: The description of this AllowableValue. + :param value: The value of this AllowableValue. :type: str """ - self._description = description + self._value = value def to_dict(self): """ diff --git a/nipyapi/registry/models/attribute.py b/nipyapi/registry/models/attribute.py index 534ed7de..6630ac6d 100644 --- a/nipyapi/registry/models/attribute.py +++ b/nipyapi/registry/models/attribute.py @@ -1,14 +1,13 @@ """ Apache NiFi Registry REST API - The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components. + REST API definition for Apache NiFi Registry web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,73 +27,71 @@ class Attribute(object): and the value is json key in definition. """ swagger_types = { - 'name': 'str', - 'description': 'str' - } + 'description': 'str', +'name': 'str' } attribute_map = { - 'name': 'name', - 'description': 'description' - } + 'description': 'description', +'name': 'name' } - def __init__(self, name=None, description=None): + def __init__(self, description=None, name=None): """ Attribute - a model defined in Swagger """ - self._name = None self._description = None + self._name = None - if name is not None: - self.name = name if description is not None: self.description = description + if name is not None: + self.name = name @property - def name(self): + def description(self): """ - Gets the name of this Attribute. - The name of the attribute + Gets the description of this Attribute. + The description of the attribute - :return: The name of this Attribute. + :return: The description of this Attribute. :rtype: str """ - return self._name + return self._description - @name.setter - def name(self, name): + @description.setter + def description(self, description): """ - Sets the name of this Attribute. - The name of the attribute + Sets the description of this Attribute. + The description of the attribute - :param name: The name of this Attribute. + :param description: The description of this Attribute. :type: str """ - self._name = name + self._description = description @property - def description(self): + def name(self): """ - Gets the description of this Attribute. - The description of the attribute + Gets the name of this Attribute. + The name of the attribute - :return: The description of this Attribute. + :return: The name of this Attribute. :rtype: str """ - return self._description + return self._name - @description.setter - def description(self, description): + @name.setter + def name(self, name): """ - Sets the description of this Attribute. - The description of the attribute + Sets the name of this Attribute. + The name of the attribute - :param description: The description of this Attribute. + :param name: The name of this Attribute. :type: str """ - self._description = description + self._name = name def to_dict(self): """ diff --git a/nipyapi/registry/models/batch_size.py b/nipyapi/registry/models/batch_size.py index 40861e8b..fee909fc 100644 --- a/nipyapi/registry/models/batch_size.py +++ b/nipyapi/registry/models/batch_size.py @@ -1,14 +1,13 @@ """ Apache NiFi Registry REST API - The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components. + REST API definition for Apache NiFi Registry web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -29,31 +28,29 @@ class BatchSize(object): """ swagger_types = { 'count': 'int', - 'size': 'str', - 'duration': 'str' - } +'duration': 'str', +'size': 'str' } attribute_map = { 'count': 'count', - 'size': 'size', - 'duration': 'duration' - } +'duration': 'duration', +'size': 'size' } - def __init__(self, count=None, size=None, duration=None): + def __init__(self, count=None, duration=None, size=None): """ BatchSize - a model defined in Swagger """ self._count = None - self._size = None self._duration = None + self._size = None if count is not None: self.count = count - if size is not None: - self.size = size if duration is not None: self.duration = duration + if size is not None: + self.size = size @property def count(self): @@ -79,50 +76,50 @@ def count(self, count): self._count = count @property - def size(self): + def duration(self): """ - Gets the size of this BatchSize. - Preferred number of bytes to include in a transaction. + Gets the duration of this BatchSize. + Preferred amount of time that a transaction should span. - :return: The size of this BatchSize. + :return: The duration of this BatchSize. :rtype: str """ - return self._size + return self._duration - @size.setter - def size(self, size): + @duration.setter + def duration(self, duration): """ - Sets the size of this BatchSize. - Preferred number of bytes to include in a transaction. + Sets the duration of this BatchSize. + Preferred amount of time that a transaction should span. - :param size: The size of this BatchSize. + :param duration: The duration of this BatchSize. :type: str """ - self._size = size + self._duration = duration @property - def duration(self): + def size(self): """ - Gets the duration of this BatchSize. - Preferred amount of time that a transaction should span. + Gets the size of this BatchSize. + Preferred number of bytes to include in a transaction. - :return: The duration of this BatchSize. + :return: The size of this BatchSize. :rtype: str """ - return self._duration + return self._size - @duration.setter - def duration(self, duration): + @size.setter + def size(self, size): """ - Sets the duration of this BatchSize. - Preferred amount of time that a transaction should span. + Sets the size of this BatchSize. + Preferred number of bytes to include in a transaction. - :param duration: The duration of this BatchSize. + :param size: The size of this BatchSize. :type: str """ - self._duration = duration + self._size = size def to_dict(self): """ diff --git a/nipyapi/registry/models/bucket.py b/nipyapi/registry/models/bucket.py index e3adb523..02ed45dd 100644 --- a/nipyapi/registry/models/bucket.py +++ b/nipyapi/registry/models/bucket.py @@ -1,14 +1,13 @@ """ Apache NiFi Registry REST API - The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components. + REST API definition for Apache NiFi Registry web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,132 +27,104 @@ class Bucket(object): and the value is json key in definition. """ swagger_types = { - 'link': 'JaxbLink', - 'identifier': 'str', - 'name': 'str', - 'created_timestamp': 'int', - 'description': 'str', 'allow_bundle_redeploy': 'bool', - 'allow_public_read': 'bool', - 'permissions': 'Permissions', - 'revision': 'RevisionInfo' - } +'allow_public_read': 'bool', +'created_timestamp': 'int', +'description': 'str', +'identifier': 'str', +'link': 'Link', +'name': 'str', +'permissions': 'Permissions', +'revision': 'RevisionInfo' } attribute_map = { - 'link': 'link', - 'identifier': 'identifier', - 'name': 'name', - 'created_timestamp': 'createdTimestamp', - 'description': 'description', 'allow_bundle_redeploy': 'allowBundleRedeploy', - 'allow_public_read': 'allowPublicRead', - 'permissions': 'permissions', - 'revision': 'revision' - } +'allow_public_read': 'allowPublicRead', +'created_timestamp': 'createdTimestamp', +'description': 'description', +'identifier': 'identifier', +'link': 'link', +'name': 'name', +'permissions': 'permissions', +'revision': 'revision' } - def __init__(self, link=None, identifier=None, name=None, created_timestamp=None, description=None, allow_bundle_redeploy=None, allow_public_read=None, permissions=None, revision=None): + def __init__(self, allow_bundle_redeploy=None, allow_public_read=None, created_timestamp=None, description=None, identifier=None, link=None, name=None, permissions=None, revision=None): """ Bucket - a model defined in Swagger """ - self._link = None - self._identifier = None - self._name = None - self._created_timestamp = None - self._description = None self._allow_bundle_redeploy = None self._allow_public_read = None + self._created_timestamp = None + self._description = None + self._identifier = None + self._link = None + self._name = None self._permissions = None self._revision = None - if link is not None: - self.link = link - if identifier is not None: - self.identifier = identifier - self.name = name - if created_timestamp is not None: - self.created_timestamp = created_timestamp - if description is not None: - self.description = description if allow_bundle_redeploy is not None: self.allow_bundle_redeploy = allow_bundle_redeploy if allow_public_read is not None: self.allow_public_read = allow_public_read + if created_timestamp is not None: + self.created_timestamp = created_timestamp + if description is not None: + self.description = description + self.identifier = identifier + if link is not None: + self.link = link + self.name = name if permissions is not None: self.permissions = permissions if revision is not None: self.revision = revision @property - def link(self): - """ - Gets the link of this Bucket. - An WebLink to this entity. - - :return: The link of this Bucket. - :rtype: JaxbLink - """ - return self._link - - @link.setter - def link(self, link): - """ - Sets the link of this Bucket. - An WebLink to this entity. - - :param link: The link of this Bucket. - :type: JaxbLink - """ - - self._link = link - - @property - def identifier(self): + def allow_bundle_redeploy(self): """ - Gets the identifier of this Bucket. - An ID to uniquely identify this object. + Gets the allow_bundle_redeploy of this Bucket. + Indicates if this bucket allows the same version of an extension bundle to be redeployed and thus overwrite the existing artifact. By default this is false. - :return: The identifier of this Bucket. - :rtype: str + :return: The allow_bundle_redeploy of this Bucket. + :rtype: bool """ - return self._identifier + return self._allow_bundle_redeploy - @identifier.setter - def identifier(self, identifier): + @allow_bundle_redeploy.setter + def allow_bundle_redeploy(self, allow_bundle_redeploy): """ - Sets the identifier of this Bucket. - An ID to uniquely identify this object. + Sets the allow_bundle_redeploy of this Bucket. + Indicates if this bucket allows the same version of an extension bundle to be redeployed and thus overwrite the existing artifact. By default this is false. - :param identifier: The identifier of this Bucket. - :type: str + :param allow_bundle_redeploy: The allow_bundle_redeploy of this Bucket. + :type: bool """ - self._identifier = identifier + self._allow_bundle_redeploy = allow_bundle_redeploy @property - def name(self): + def allow_public_read(self): """ - Gets the name of this Bucket. - The name of the bucket. + Gets the allow_public_read of this Bucket. + Indicates if this bucket allows read access to unauthenticated anonymous users - :return: The name of this Bucket. - :rtype: str + :return: The allow_public_read of this Bucket. + :rtype: bool """ - return self._name + return self._allow_public_read - @name.setter - def name(self, name): + @allow_public_read.setter + def allow_public_read(self, allow_public_read): """ - Sets the name of this Bucket. - The name of the bucket. + Sets the allow_public_read of this Bucket. + Indicates if this bucket allows read access to unauthenticated anonymous users - :param name: The name of this Bucket. - :type: str + :param allow_public_read: The allow_public_read of this Bucket. + :type: bool """ - if name is None: - raise ValueError("Invalid value for `name`, must not be `None`") - self._name = name + self._allow_public_read = allow_public_read @property def created_timestamp(self): @@ -175,8 +146,6 @@ def created_timestamp(self, created_timestamp): :param created_timestamp: The created_timestamp of this Bucket. :type: int """ - if created_timestamp is not None and created_timestamp < 1: - raise ValueError("Invalid value for `created_timestamp`, must be a value greater than or equal to `1`") self._created_timestamp = created_timestamp @@ -204,56 +173,78 @@ def description(self, description): self._description = description @property - def allow_bundle_redeploy(self): + def identifier(self): """ - Gets the allow_bundle_redeploy of this Bucket. - Indicates if this bucket allows the same version of an extension bundle to be redeployed and thus overwrite the existing artifact. By default this is false. + Gets the identifier of this Bucket. + An ID to uniquely identify this object. - :return: The allow_bundle_redeploy of this Bucket. - :rtype: bool + :return: The identifier of this Bucket. + :rtype: str """ - return self._allow_bundle_redeploy + return self._identifier - @allow_bundle_redeploy.setter - def allow_bundle_redeploy(self, allow_bundle_redeploy): + @identifier.setter + def identifier(self, identifier): """ - Sets the allow_bundle_redeploy of this Bucket. - Indicates if this bucket allows the same version of an extension bundle to be redeployed and thus overwrite the existing artifact. By default this is false. + Sets the identifier of this Bucket. + An ID to uniquely identify this object. - :param allow_bundle_redeploy: The allow_bundle_redeploy of this Bucket. - :type: bool + :param identifier: The identifier of this Bucket. + :type: str """ - self._allow_bundle_redeploy = allow_bundle_redeploy + self._identifier = identifier @property - def allow_public_read(self): + def link(self): """ - Gets the allow_public_read of this Bucket. - Indicates if this bucket allows read access to unauthenticated anonymous users + Gets the link of this Bucket. - :return: The allow_public_read of this Bucket. - :rtype: bool + :return: The link of this Bucket. + :rtype: Link """ - return self._allow_public_read + return self._link - @allow_public_read.setter - def allow_public_read(self, allow_public_read): + @link.setter + def link(self, link): """ - Sets the allow_public_read of this Bucket. - Indicates if this bucket allows read access to unauthenticated anonymous users + Sets the link of this Bucket. - :param allow_public_read: The allow_public_read of this Bucket. - :type: bool + :param link: The link of this Bucket. + :type: Link """ - self._allow_public_read = allow_public_read + self._link = link + + @property + def name(self): + """ + Gets the name of this Bucket. + The name of the bucket. + + :return: The name of this Bucket. + :rtype: str + """ + return self._name + + @name.setter + def name(self, name): + """ + Sets the name of this Bucket. + The name of the bucket. + + :param name: The name of this Bucket. + :type: str + """ + if name is None: + raise ValueError("Invalid value for `name`, must not be `None`") + + self._name = name @property def permissions(self): """ Gets the permissions of this Bucket. - The access that the current user has to this bucket. :return: The permissions of this Bucket. :rtype: Permissions @@ -264,7 +255,6 @@ def permissions(self): def permissions(self, permissions): """ Sets the permissions of this Bucket. - The access that the current user has to this bucket. :param permissions: The permissions of this Bucket. :type: Permissions @@ -276,7 +266,6 @@ def permissions(self, permissions): def revision(self): """ Gets the revision of this Bucket. - The revision of this entity used for optimistic-locking during updates. :return: The revision of this Bucket. :rtype: RevisionInfo @@ -287,7 +276,6 @@ def revision(self): def revision(self, revision): """ Sets the revision of this Bucket. - The revision of this entity used for optimistic-locking during updates. :param revision: The revision of this Bucket. :type: RevisionInfo diff --git a/nipyapi/registry/models/bucket_item.py b/nipyapi/registry/models/bucket_item.py index cea371c1..57cd57a0 100644 --- a/nipyapi/registry/models/bucket_item.py +++ b/nipyapi/registry/models/bucket_item.py @@ -1,14 +1,13 @@ """ Apache NiFi Registry REST API - The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components. + REST API definition for Apache NiFi Registry web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,135 +27,132 @@ class BucketItem(object): and the value is json key in definition. """ swagger_types = { - 'link': 'JaxbLink', - 'identifier': 'str', - 'name': 'str', - 'description': 'str', 'bucket_identifier': 'str', - 'bucket_name': 'str', - 'created_timestamp': 'int', - 'modified_timestamp': 'int', - 'type': 'str', - 'permissions': 'Permissions' - } +'bucket_name': 'str', +'created_timestamp': 'int', +'description': 'str', +'identifier': 'str', +'link': 'Link', +'modified_timestamp': 'int', +'name': 'str', +'permissions': 'Permissions', +'type': 'str' } attribute_map = { - 'link': 'link', - 'identifier': 'identifier', - 'name': 'name', - 'description': 'description', 'bucket_identifier': 'bucketIdentifier', - 'bucket_name': 'bucketName', - 'created_timestamp': 'createdTimestamp', - 'modified_timestamp': 'modifiedTimestamp', - 'type': 'type', - 'permissions': 'permissions' - } - - def __init__(self, link=None, identifier=None, name=None, description=None, bucket_identifier=None, bucket_name=None, created_timestamp=None, modified_timestamp=None, type=None, permissions=None): +'bucket_name': 'bucketName', +'created_timestamp': 'createdTimestamp', +'description': 'description', +'identifier': 'identifier', +'link': 'link', +'modified_timestamp': 'modifiedTimestamp', +'name': 'name', +'permissions': 'permissions', +'type': 'type' } + + def __init__(self, bucket_identifier=None, bucket_name=None, created_timestamp=None, description=None, identifier=None, link=None, modified_timestamp=None, name=None, permissions=None, type=None): """ BucketItem - a model defined in Swagger """ - self._link = None - self._identifier = None - self._name = None - self._description = None self._bucket_identifier = None self._bucket_name = None self._created_timestamp = None + self._description = None + self._identifier = None + self._link = None self._modified_timestamp = None - self._type = None + self._name = None self._permissions = None + self._type = None - if link is not None: - self.link = link - if identifier is not None: - self.identifier = identifier - self.name = name - if description is not None: - self.description = description self.bucket_identifier = bucket_identifier if bucket_name is not None: self.bucket_name = bucket_name if created_timestamp is not None: self.created_timestamp = created_timestamp + if description is not None: + self.description = description + self.identifier = identifier + if link is not None: + self.link = link if modified_timestamp is not None: self.modified_timestamp = modified_timestamp - self.type = type + self.name = name if permissions is not None: self.permissions = permissions + self.type = type @property - def link(self): + def bucket_identifier(self): """ - Gets the link of this BucketItem. - An WebLink to this entity. + Gets the bucket_identifier of this BucketItem. + The identifier of the bucket this items belongs to. This cannot be changed after the item is created. - :return: The link of this BucketItem. - :rtype: JaxbLink + :return: The bucket_identifier of this BucketItem. + :rtype: str """ - return self._link + return self._bucket_identifier - @link.setter - def link(self, link): + @bucket_identifier.setter + def bucket_identifier(self, bucket_identifier): """ - Sets the link of this BucketItem. - An WebLink to this entity. + Sets the bucket_identifier of this BucketItem. + The identifier of the bucket this items belongs to. This cannot be changed after the item is created. - :param link: The link of this BucketItem. - :type: JaxbLink + :param bucket_identifier: The bucket_identifier of this BucketItem. + :type: str """ + if bucket_identifier is None: + raise ValueError("Invalid value for `bucket_identifier`, must not be `None`") - self._link = link + self._bucket_identifier = bucket_identifier @property - def identifier(self): + def bucket_name(self): """ - Gets the identifier of this BucketItem. - An ID to uniquely identify this object. + Gets the bucket_name of this BucketItem. + The name of the bucket this items belongs to. - :return: The identifier of this BucketItem. + :return: The bucket_name of this BucketItem. :rtype: str """ - return self._identifier + return self._bucket_name - @identifier.setter - def identifier(self, identifier): + @bucket_name.setter + def bucket_name(self, bucket_name): """ - Sets the identifier of this BucketItem. - An ID to uniquely identify this object. + Sets the bucket_name of this BucketItem. + The name of the bucket this items belongs to. - :param identifier: The identifier of this BucketItem. + :param bucket_name: The bucket_name of this BucketItem. :type: str """ - self._identifier = identifier + self._bucket_name = bucket_name @property - def name(self): + def created_timestamp(self): """ - Gets the name of this BucketItem. - The name of the item. + Gets the created_timestamp of this BucketItem. + The timestamp of when the item was created, as milliseconds since epoch. - :return: The name of this BucketItem. - :rtype: str + :return: The created_timestamp of this BucketItem. + :rtype: int """ - return self._name + return self._created_timestamp - @name.setter - def name(self, name): + @created_timestamp.setter + def created_timestamp(self, created_timestamp): """ - Sets the name of this BucketItem. - The name of the item. + Sets the created_timestamp of this BucketItem. + The timestamp of when the item was created, as milliseconds since epoch. - :param name: The name of this BucketItem. - :type: str + :param created_timestamp: The created_timestamp of this BucketItem. + :type: int """ - if name is None: - raise ValueError("Invalid value for `name`, must not be `None`") - self._name = name + self._created_timestamp = created_timestamp @property def description(self): @@ -182,77 +178,48 @@ def description(self, description): self._description = description @property - def bucket_identifier(self): - """ - Gets the bucket_identifier of this BucketItem. - The identifier of the bucket this items belongs to. This cannot be changed after the item is created. - - :return: The bucket_identifier of this BucketItem. - :rtype: str - """ - return self._bucket_identifier - - @bucket_identifier.setter - def bucket_identifier(self, bucket_identifier): - """ - Sets the bucket_identifier of this BucketItem. - The identifier of the bucket this items belongs to. This cannot be changed after the item is created. - - :param bucket_identifier: The bucket_identifier of this BucketItem. - :type: str - """ - if bucket_identifier is None: - raise ValueError("Invalid value for `bucket_identifier`, must not be `None`") - - self._bucket_identifier = bucket_identifier - - @property - def bucket_name(self): + def identifier(self): """ - Gets the bucket_name of this BucketItem. - The name of the bucket this items belongs to. + Gets the identifier of this BucketItem. + An ID to uniquely identify this object. - :return: The bucket_name of this BucketItem. + :return: The identifier of this BucketItem. :rtype: str """ - return self._bucket_name + return self._identifier - @bucket_name.setter - def bucket_name(self, bucket_name): + @identifier.setter + def identifier(self, identifier): """ - Sets the bucket_name of this BucketItem. - The name of the bucket this items belongs to. + Sets the identifier of this BucketItem. + An ID to uniquely identify this object. - :param bucket_name: The bucket_name of this BucketItem. + :param identifier: The identifier of this BucketItem. :type: str """ - self._bucket_name = bucket_name + self._identifier = identifier @property - def created_timestamp(self): + def link(self): """ - Gets the created_timestamp of this BucketItem. - The timestamp of when the item was created, as milliseconds since epoch. + Gets the link of this BucketItem. - :return: The created_timestamp of this BucketItem. - :rtype: int + :return: The link of this BucketItem. + :rtype: Link """ - return self._created_timestamp + return self._link - @created_timestamp.setter - def created_timestamp(self, created_timestamp): + @link.setter + def link(self, link): """ - Sets the created_timestamp of this BucketItem. - The timestamp of when the item was created, as milliseconds since epoch. + Sets the link of this BucketItem. - :param created_timestamp: The created_timestamp of this BucketItem. - :type: int + :param link: The link of this BucketItem. + :type: Link """ - if created_timestamp is not None and created_timestamp < 1: - raise ValueError("Invalid value for `created_timestamp`, must be a value greater than or equal to `1`") - self._created_timestamp = created_timestamp + self._link = link @property def modified_timestamp(self): @@ -274,47 +241,38 @@ def modified_timestamp(self, modified_timestamp): :param modified_timestamp: The modified_timestamp of this BucketItem. :type: int """ - if modified_timestamp is not None and modified_timestamp < 1: - raise ValueError("Invalid value for `modified_timestamp`, must be a value greater than or equal to `1`") self._modified_timestamp = modified_timestamp @property - def type(self): + def name(self): """ - Gets the type of this BucketItem. - The type of item. + Gets the name of this BucketItem. + The name of the item. - :return: The type of this BucketItem. + :return: The name of this BucketItem. :rtype: str """ - return self._type + return self._name - @type.setter - def type(self, type): + @name.setter + def name(self, name): """ - Sets the type of this BucketItem. - The type of item. + Sets the name of this BucketItem. + The name of the item. - :param type: The type of this BucketItem. + :param name: The name of this BucketItem. :type: str """ - if type is None: - raise ValueError("Invalid value for `type`, must not be `None`") - allowed_values = ["Flow", "Bundle"] - if type not in allowed_values: - raise ValueError( - "Invalid value for `type` ({0}), must be one of {1}" - .format(type, allowed_values) - ) + if name is None: + raise ValueError("Invalid value for `name`, must not be `None`") - self._type = type + self._name = name @property def permissions(self): """ Gets the permissions of this BucketItem. - The access that the current user has to the bucket containing this item. :return: The permissions of this BucketItem. :rtype: Permissions @@ -325,7 +283,6 @@ def permissions(self): def permissions(self, permissions): """ Sets the permissions of this BucketItem. - The access that the current user has to the bucket containing this item. :param permissions: The permissions of this BucketItem. :type: Permissions @@ -333,6 +290,37 @@ def permissions(self, permissions): self._permissions = permissions + @property + def type(self): + """ + Gets the type of this BucketItem. + The type of item. + + :return: The type of this BucketItem. + :rtype: str + """ + return self._type + + @type.setter + def type(self, type): + """ + Sets the type of this BucketItem. + The type of item. + + :param type: The type of this BucketItem. + :type: str + """ + if type is None: + raise ValueError("Invalid value for `type`, must not be `None`") + allowed_values = ["Flow", "Bundle", ] + if type not in allowed_values: + raise ValueError( + "Invalid value for `type` ({0}), must be one of {1}" + .format(type, allowed_values) + ) + + self._type = type + def to_dict(self): """ Returns the model properties as a dict diff --git a/nipyapi/registry/models/build_info.py b/nipyapi/registry/models/build_info.py index 7c8c0dda..c93004af 100644 --- a/nipyapi/registry/models/build_info.py +++ b/nipyapi/registry/models/build_info.py @@ -1,14 +1,13 @@ """ Apache NiFi Registry REST API - The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components. + REST API definition for Apache NiFi Registry web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,75 +27,73 @@ class BuildInfo(object): and the value is json key in definition. """ swagger_types = { - 'build_tool': 'str', - 'build_flags': 'str', 'build_branch': 'str', - 'build_tag': 'str', - 'build_revision': 'str', - 'built': 'int', - 'built_by': 'str' - } +'build_flags': 'str', +'build_revision': 'str', +'build_tag': 'str', +'build_tool': 'str', +'built': 'int', +'built_by': 'str' } attribute_map = { - 'build_tool': 'buildTool', - 'build_flags': 'buildFlags', 'build_branch': 'buildBranch', - 'build_tag': 'buildTag', - 'build_revision': 'buildRevision', - 'built': 'built', - 'built_by': 'builtBy' - } +'build_flags': 'buildFlags', +'build_revision': 'buildRevision', +'build_tag': 'buildTag', +'build_tool': 'buildTool', +'built': 'built', +'built_by': 'builtBy' } - def __init__(self, build_tool=None, build_flags=None, build_branch=None, build_tag=None, build_revision=None, built=None, built_by=None): + def __init__(self, build_branch=None, build_flags=None, build_revision=None, build_tag=None, build_tool=None, built=None, built_by=None): """ BuildInfo - a model defined in Swagger """ - self._build_tool = None - self._build_flags = None self._build_branch = None - self._build_tag = None + self._build_flags = None self._build_revision = None + self._build_tag = None + self._build_tool = None self._built = None self._built_by = None - if build_tool is not None: - self.build_tool = build_tool - if build_flags is not None: - self.build_flags = build_flags if build_branch is not None: self.build_branch = build_branch - if build_tag is not None: - self.build_tag = build_tag + if build_flags is not None: + self.build_flags = build_flags if build_revision is not None: self.build_revision = build_revision + if build_tag is not None: + self.build_tag = build_tag + if build_tool is not None: + self.build_tool = build_tool if built is not None: self.built = built if built_by is not None: self.built_by = built_by @property - def build_tool(self): + def build_branch(self): """ - Gets the build_tool of this BuildInfo. - The tool used to build the version of the bundle + Gets the build_branch of this BuildInfo. + The branch used to build the version of the bundle - :return: The build_tool of this BuildInfo. + :return: The build_branch of this BuildInfo. :rtype: str """ - return self._build_tool + return self._build_branch - @build_tool.setter - def build_tool(self, build_tool): + @build_branch.setter + def build_branch(self, build_branch): """ - Sets the build_tool of this BuildInfo. - The tool used to build the version of the bundle + Sets the build_branch of this BuildInfo. + The branch used to build the version of the bundle - :param build_tool: The build_tool of this BuildInfo. + :param build_branch: The build_branch of this BuildInfo. :type: str """ - self._build_tool = build_tool + self._build_branch = build_branch @property def build_flags(self): @@ -122,27 +119,27 @@ def build_flags(self, build_flags): self._build_flags = build_flags @property - def build_branch(self): + def build_revision(self): """ - Gets the build_branch of this BuildInfo. - The branch used to build the version of the bundle + Gets the build_revision of this BuildInfo. + The revision used to build the version of the bundle - :return: The build_branch of this BuildInfo. + :return: The build_revision of this BuildInfo. :rtype: str """ - return self._build_branch + return self._build_revision - @build_branch.setter - def build_branch(self, build_branch): + @build_revision.setter + def build_revision(self, build_revision): """ - Sets the build_branch of this BuildInfo. - The branch used to build the version of the bundle + Sets the build_revision of this BuildInfo. + The revision used to build the version of the bundle - :param build_branch: The build_branch of this BuildInfo. + :param build_revision: The build_revision of this BuildInfo. :type: str """ - self._build_branch = build_branch + self._build_revision = build_revision @property def build_tag(self): @@ -168,27 +165,27 @@ def build_tag(self, build_tag): self._build_tag = build_tag @property - def build_revision(self): + def build_tool(self): """ - Gets the build_revision of this BuildInfo. - The revision used to build the version of the bundle + Gets the build_tool of this BuildInfo. + The tool used to build the version of the bundle - :return: The build_revision of this BuildInfo. + :return: The build_tool of this BuildInfo. :rtype: str """ - return self._build_revision + return self._build_tool - @build_revision.setter - def build_revision(self, build_revision): + @build_tool.setter + def build_tool(self, build_tool): """ - Sets the build_revision of this BuildInfo. - The revision used to build the version of the bundle + Sets the build_tool of this BuildInfo. + The tool used to build the version of the bundle - :param build_revision: The build_revision of this BuildInfo. + :param build_tool: The build_tool of this BuildInfo. :type: str """ - self._build_revision = build_revision + self._build_tool = build_tool @property def built(self): diff --git a/nipyapi/registry/models/bundle.py b/nipyapi/registry/models/bundle.py index 0839ff4a..b8f46146 100644 --- a/nipyapi/registry/models/bundle.py +++ b/nipyapi/registry/models/bundle.py @@ -1,14 +1,13 @@ """ Apache NiFi Registry REST API - The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components. + REST API definition for Apache NiFi Registry web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,78 +27,76 @@ class Bundle(object): and the value is json key in definition. """ swagger_types = { - 'group': 'str', 'artifact': 'str', - 'version': 'str' - } +'group': 'str', +'version': 'str' } attribute_map = { - 'group': 'group', 'artifact': 'artifact', - 'version': 'version' - } +'group': 'group', +'version': 'version' } - def __init__(self, group=None, artifact=None, version=None): + def __init__(self, artifact=None, group=None, version=None): """ Bundle - a model defined in Swagger """ - self._group = None self._artifact = None + self._group = None self._version = None - if group is not None: - self.group = group if artifact is not None: self.artifact = artifact + if group is not None: + self.group = group if version is not None: self.version = version @property - def group(self): + def artifact(self): """ - Gets the group of this Bundle. - The group of the bundle + Gets the artifact of this Bundle. + The artifact of the bundle - :return: The group of this Bundle. + :return: The artifact of this Bundle. :rtype: str """ - return self._group + return self._artifact - @group.setter - def group(self, group): + @artifact.setter + def artifact(self, artifact): """ - Sets the group of this Bundle. - The group of the bundle + Sets the artifact of this Bundle. + The artifact of the bundle - :param group: The group of this Bundle. + :param artifact: The artifact of this Bundle. :type: str """ - self._group = group + self._artifact = artifact @property - def artifact(self): + def group(self): """ - Gets the artifact of this Bundle. - The artifact of the bundle + Gets the group of this Bundle. + The group of the bundle - :return: The artifact of this Bundle. + :return: The group of this Bundle. :rtype: str """ - return self._artifact + return self._group - @artifact.setter - def artifact(self, artifact): + @group.setter + def group(self, group): """ - Sets the artifact of this Bundle. - The artifact of the bundle + Sets the group of this Bundle. + The group of the bundle - :param artifact: The artifact of this Bundle. + :param group: The group of this Bundle. :type: str """ - self._artifact = artifact + self._group = group @property def version(self): diff --git a/nipyapi/registry/models/bundle_info.py b/nipyapi/registry/models/bundle_info.py index b2835b4b..40349e36 100644 --- a/nipyapi/registry/models/bundle_info.py +++ b/nipyapi/registry/models/bundle_info.py @@ -1,14 +1,13 @@ """ Apache NiFi Registry REST API - The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components. + REST API definition for Apache NiFi Registry web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,41 +27,41 @@ class BundleInfo(object): and the value is json key in definition. """ swagger_types = { - 'bucket_id': 'str', - 'bucket_name': 'str', - 'bundle_id': 'str', - 'bundle_type': 'str', - 'group_id': 'str', 'artifact_id': 'str', - 'version': 'str', - 'system_api_version': 'str' - } +'bucket_id': 'str', +'bucket_name': 'str', +'bundle_id': 'str', +'bundle_type': 'str', +'group_id': 'str', +'system_api_version': 'str', +'version': 'str' } attribute_map = { - 'bucket_id': 'bucketId', - 'bucket_name': 'bucketName', - 'bundle_id': 'bundleId', - 'bundle_type': 'bundleType', - 'group_id': 'groupId', 'artifact_id': 'artifactId', - 'version': 'version', - 'system_api_version': 'systemApiVersion' - } +'bucket_id': 'bucketId', +'bucket_name': 'bucketName', +'bundle_id': 'bundleId', +'bundle_type': 'bundleType', +'group_id': 'groupId', +'system_api_version': 'systemApiVersion', +'version': 'version' } - def __init__(self, bucket_id=None, bucket_name=None, bundle_id=None, bundle_type=None, group_id=None, artifact_id=None, version=None, system_api_version=None): + def __init__(self, artifact_id=None, bucket_id=None, bucket_name=None, bundle_id=None, bundle_type=None, group_id=None, system_api_version=None, version=None): """ BundleInfo - a model defined in Swagger """ + self._artifact_id = None self._bucket_id = None self._bucket_name = None self._bundle_id = None self._bundle_type = None self._group_id = None - self._artifact_id = None - self._version = None self._system_api_version = None + self._version = None + if artifact_id is not None: + self.artifact_id = artifact_id if bucket_id is not None: self.bucket_id = bucket_id if bucket_name is not None: @@ -73,12 +72,33 @@ def __init__(self, bucket_id=None, bucket_name=None, bundle_id=None, bundle_type self.bundle_type = bundle_type if group_id is not None: self.group_id = group_id - if artifact_id is not None: - self.artifact_id = artifact_id - if version is not None: - self.version = version if system_api_version is not None: self.system_api_version = system_api_version + if version is not None: + self.version = version + + @property + def artifact_id(self): + """ + Gets the artifact_id of this BundleInfo. + The artifact id of the bundle + + :return: The artifact_id of this BundleInfo. + :rtype: str + """ + return self._artifact_id + + @artifact_id.setter + def artifact_id(self, artifact_id): + """ + Sets the artifact_id of this BundleInfo. + The artifact id of the bundle + + :param artifact_id: The artifact_id of this BundleInfo. + :type: str + """ + + self._artifact_id = artifact_id @property def bucket_id(self): @@ -169,7 +189,7 @@ def bundle_type(self, bundle_type): :param bundle_type: The bundle_type of this BundleInfo. :type: str """ - allowed_values = ["NIFI_NAR", "MINIFI_CPP"] + 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}" @@ -202,27 +222,27 @@ def group_id(self, group_id): self._group_id = group_id @property - def artifact_id(self): + def system_api_version(self): """ - Gets the artifact_id of this BundleInfo. - The artifact id of the bundle + Gets the system_api_version of this BundleInfo. + The version of the system API the bundle was built against - :return: The artifact_id of this BundleInfo. + :return: The system_api_version of this BundleInfo. :rtype: str """ - return self._artifact_id + return self._system_api_version - @artifact_id.setter - def artifact_id(self, artifact_id): + @system_api_version.setter + def system_api_version(self, system_api_version): """ - Sets the artifact_id of this BundleInfo. - The artifact id of the bundle + Sets the system_api_version of this BundleInfo. + The version of the system API the bundle was built against - :param artifact_id: The artifact_id of this BundleInfo. + :param system_api_version: The system_api_version of this BundleInfo. :type: str """ - self._artifact_id = artifact_id + self._system_api_version = system_api_version @property def version(self): @@ -247,29 +267,6 @@ def version(self, version): self._version = version - @property - def system_api_version(self): - """ - Gets the system_api_version of this BundleInfo. - The version of the system API the bundle was built against - - :return: The system_api_version of this BundleInfo. - :rtype: str - """ - return self._system_api_version - - @system_api_version.setter - def system_api_version(self, system_api_version): - """ - Sets the system_api_version of this BundleInfo. - The version of the system API the bundle was built against - - :param system_api_version: The system_api_version of this BundleInfo. - :type: str - """ - - self._system_api_version = system_api_version - def to_dict(self): """ Returns the model properties as a dict diff --git a/nipyapi/registry/models/bundle_version.py b/nipyapi/registry/models/bundle_version.py index c1dcf00b..1dc74810 100644 --- a/nipyapi/registry/models/bundle_version.py +++ b/nipyapi/registry/models/bundle_version.py @@ -1,14 +1,13 @@ """ Apache NiFi Registry REST API - The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components. + REST API definition for Apache NiFi Registry web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,94 +27,86 @@ class BundleVersion(object): and the value is json key in definition. """ swagger_types = { - 'link': 'JaxbLink', - 'version_metadata': 'BundleVersionMetadata', - 'dependencies': 'list[BundleVersionDependency]', - 'bundle': 'ExtensionBundle', 'bucket': 'Bucket', - 'filename': 'str' - } +'bundle': 'Bundle', +'dependencies': 'list[BundleVersionDependency]', +'filename': 'str', +'link': 'Link', +'version_metadata': 'BundleVersionMetadata' } attribute_map = { - 'link': 'link', - 'version_metadata': 'versionMetadata', - 'dependencies': 'dependencies', - 'bundle': 'bundle', 'bucket': 'bucket', - 'filename': 'filename' - } +'bundle': 'bundle', +'dependencies': 'dependencies', +'filename': 'filename', +'link': 'link', +'version_metadata': 'versionMetadata' } - def __init__(self, link=None, version_metadata=None, dependencies=None, bundle=None, bucket=None, filename=None): + def __init__(self, bucket=None, bundle=None, dependencies=None, filename=None, link=None, version_metadata=None): """ BundleVersion - a model defined in Swagger """ - self._link = None - self._version_metadata = None - self._dependencies = None - self._bundle = None self._bucket = None + self._bundle = None + self._dependencies = None self._filename = None + self._link = None + self._version_metadata = None - if link is not None: - self.link = link - self.version_metadata = version_metadata - if dependencies is not None: - self.dependencies = dependencies - if bundle is not None: - self.bundle = bundle if bucket is not None: self.bucket = bucket + if bundle is not None: + self.bundle = bundle + if dependencies is not None: + self.dependencies = dependencies if filename is not None: self.filename = filename + if link is not None: + self.link = link + self.version_metadata = version_metadata @property - def link(self): + def bucket(self): """ - Gets the link of this BundleVersion. - An WebLink to this entity. + Gets the bucket of this BundleVersion. - :return: The link of this BundleVersion. - :rtype: JaxbLink + :return: The bucket of this BundleVersion. + :rtype: Bucket """ - return self._link + return self._bucket - @link.setter - def link(self, link): + @bucket.setter + def bucket(self, bucket): """ - Sets the link of this BundleVersion. - An WebLink to this entity. + Sets the bucket of this BundleVersion. - :param link: The link of this BundleVersion. - :type: JaxbLink + :param bucket: The bucket of this BundleVersion. + :type: Bucket """ - self._link = link + self._bucket = bucket @property - def version_metadata(self): + def bundle(self): """ - Gets the version_metadata of this BundleVersion. - The metadata about this version of the extension bundle + Gets the bundle of this BundleVersion. - :return: The version_metadata of this BundleVersion. - :rtype: BundleVersionMetadata + :return: The bundle of this BundleVersion. + :rtype: Bundle """ - return self._version_metadata + return self._bundle - @version_metadata.setter - def version_metadata(self, version_metadata): + @bundle.setter + def bundle(self, bundle): """ - Sets the version_metadata of this BundleVersion. - The metadata about this version of the extension bundle + Sets the bundle of this BundleVersion. - :param version_metadata: The version_metadata of this BundleVersion. - :type: BundleVersionMetadata + :param bundle: The bundle of this BundleVersion. + :type: Bundle """ - if version_metadata is None: - raise ValueError("Invalid value for `version_metadata`, must not be `None`") - self._version_metadata = version_metadata + self._bundle = bundle @property def dependencies(self): @@ -141,71 +132,69 @@ def dependencies(self, dependencies): self._dependencies = dependencies @property - def bundle(self): + def filename(self): """ - Gets the bundle of this BundleVersion. - The bundle this version is for + Gets the filename of this BundleVersion. - :return: The bundle of this BundleVersion. - :rtype: ExtensionBundle + :return: The filename of this BundleVersion. + :rtype: str """ - return self._bundle + return self._filename - @bundle.setter - def bundle(self, bundle): + @filename.setter + def filename(self, filename): """ - Sets the bundle of this BundleVersion. - The bundle this version is for + Sets the filename of this BundleVersion. - :param bundle: The bundle of this BundleVersion. - :type: ExtensionBundle + :param filename: The filename of this BundleVersion. + :type: str """ - self._bundle = bundle + self._filename = filename @property - def bucket(self): + def link(self): """ - Gets the bucket of this BundleVersion. - The bucket that the extension bundle belongs to + Gets the link of this BundleVersion. - :return: The bucket of this BundleVersion. - :rtype: Bucket + :return: The link of this BundleVersion. + :rtype: Link """ - return self._bucket + return self._link - @bucket.setter - def bucket(self, bucket): + @link.setter + def link(self, link): """ - Sets the bucket of this BundleVersion. - The bucket that the extension bundle belongs to + Sets the link of this BundleVersion. - :param bucket: The bucket of this BundleVersion. - :type: Bucket + :param link: The link of this BundleVersion. + :type: Link """ - self._bucket = bucket + self._link = link @property - def filename(self): + def version_metadata(self): """ - Gets the filename of this BundleVersion. + Gets the version_metadata of this BundleVersion. - :return: The filename of this BundleVersion. - :rtype: str + :return: The version_metadata of this BundleVersion. + :rtype: BundleVersionMetadata """ - return self._filename + return self._version_metadata - @filename.setter - def filename(self, filename): + @version_metadata.setter + def version_metadata(self, version_metadata): """ - Sets the filename of this BundleVersion. + Sets the version_metadata of this BundleVersion. - :param filename: The filename of this BundleVersion. - :type: str + :param version_metadata: The version_metadata of this BundleVersion. + :type: BundleVersionMetadata """ + if version_metadata is None: + raise ValueError("Invalid value for `version_metadata`, must not be `None`") - self._filename = filename + self._version_metadata = version_metadata def to_dict(self): """ diff --git a/nipyapi/registry/models/bundle_version_dependency.py b/nipyapi/registry/models/bundle_version_dependency.py index a57272b3..085dfc92 100644 --- a/nipyapi/registry/models/bundle_version_dependency.py +++ b/nipyapi/registry/models/bundle_version_dependency.py @@ -1,14 +1,13 @@ """ Apache NiFi Registry REST API - The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components. + REST API definition for Apache NiFi Registry web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,78 +27,77 @@ class BundleVersionDependency(object): and the value is json key in definition. """ swagger_types = { - 'group_id': 'str', 'artifact_id': 'str', - 'version': 'str' - } +'group_id': 'str', +'version': 'str' } attribute_map = { - 'group_id': 'groupId', 'artifact_id': 'artifactId', - 'version': 'version' - } +'group_id': 'groupId', +'version': 'version' } - def __init__(self, group_id=None, artifact_id=None, version=None): + def __init__(self, artifact_id=None, group_id=None, version=None): """ BundleVersionDependency - a model defined in Swagger """ - self._group_id = None self._artifact_id = None + self._group_id = None self._version = None - if group_id is not None: - self.group_id = group_id - if artifact_id is not None: - self.artifact_id = artifact_id - if version is not None: - self.version = version + self.artifact_id = artifact_id + self.group_id = group_id + self.version = version @property - def group_id(self): + def artifact_id(self): """ - Gets the group_id of this BundleVersionDependency. - The group id of the bundle dependency + Gets the artifact_id of this BundleVersionDependency. + The artifact id of the bundle dependency - :return: The group_id of this BundleVersionDependency. + :return: The artifact_id of this BundleVersionDependency. :rtype: str """ - return self._group_id + return self._artifact_id - @group_id.setter - def group_id(self, group_id): + @artifact_id.setter + def artifact_id(self, artifact_id): """ - Sets the group_id of this BundleVersionDependency. - The group id of the bundle dependency + Sets the artifact_id of this BundleVersionDependency. + The artifact id of the bundle dependency - :param group_id: The group_id of this BundleVersionDependency. + :param artifact_id: The artifact_id of this BundleVersionDependency. :type: str """ + if artifact_id is None: + raise ValueError("Invalid value for `artifact_id`, must not be `None`") - self._group_id = group_id + self._artifact_id = artifact_id @property - def artifact_id(self): + def group_id(self): """ - Gets the artifact_id of this BundleVersionDependency. - The artifact id of the bundle dependency + Gets the group_id of this BundleVersionDependency. + The group id of the bundle dependency - :return: The artifact_id of this BundleVersionDependency. + :return: The group_id of this BundleVersionDependency. :rtype: str """ - return self._artifact_id + return self._group_id - @artifact_id.setter - def artifact_id(self, artifact_id): + @group_id.setter + def group_id(self, group_id): """ - Sets the artifact_id of this BundleVersionDependency. - The artifact id of the bundle dependency + Sets the group_id of this BundleVersionDependency. + The group id of the bundle dependency - :param artifact_id: The artifact_id of this BundleVersionDependency. + :param group_id: The group_id of this BundleVersionDependency. :type: str """ + if group_id is None: + raise ValueError("Invalid value for `group_id`, must not be `None`") - self._artifact_id = artifact_id + self._group_id = group_id @property def version(self): @@ -121,6 +119,8 @@ def version(self, version): :param version: The version of this BundleVersionDependency. :type: str """ + if version is None: + raise ValueError("Invalid value for `version`, must not be `None`") self._version = version diff --git a/nipyapi/registry/models/bundle_version_metadata.py b/nipyapi/registry/models/bundle_version_metadata.py index 5fc4a25c..949cb303 100644 --- a/nipyapi/registry/models/bundle_version_metadata.py +++ b/nipyapi/registry/models/bundle_version_metadata.py @@ -1,14 +1,13 @@ """ Apache NiFi Registry REST API - The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components. + REST API definition for Apache NiFi Registry web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,157 +27,126 @@ class BundleVersionMetadata(object): and the value is json key in definition. """ swagger_types = { - 'link': 'JaxbLink', - 'id': 'str', - 'bundle_id': 'str', - 'bucket_id': 'str', - 'group_id': 'str', 'artifact_id': 'str', - 'version': 'str', - 'timestamp': 'int', - 'author': 'str', - 'description': 'str', - 'sha256': 'str', - 'sha256_supplied': 'bool', - 'content_size': 'int', - 'system_api_version': 'str', - 'build_info': 'BuildInfo' - } +'author': 'str', +'bucket_id': 'str', +'build_info': 'BuildInfo', +'bundle_id': 'str', +'content_size': 'int', +'description': 'str', +'group_id': 'str', +'id': 'str', +'link': 'Link', +'sha256': 'str', +'sha256_supplied': 'bool', +'system_api_version': 'str', +'timestamp': 'int', +'version': 'str' } attribute_map = { - 'link': 'link', - 'id': 'id', - 'bundle_id': 'bundleId', - 'bucket_id': 'bucketId', - 'group_id': 'groupId', 'artifact_id': 'artifactId', - 'version': 'version', - 'timestamp': 'timestamp', - 'author': 'author', - 'description': 'description', - 'sha256': 'sha256', - 'sha256_supplied': 'sha256Supplied', - 'content_size': 'contentSize', - 'system_api_version': 'systemApiVersion', - 'build_info': 'buildInfo' - } - - def __init__(self, link=None, id=None, bundle_id=None, bucket_id=None, group_id=None, artifact_id=None, version=None, timestamp=None, author=None, description=None, sha256=None, sha256_supplied=None, content_size=None, system_api_version=None, build_info=None): +'author': 'author', +'bucket_id': 'bucketId', +'build_info': 'buildInfo', +'bundle_id': 'bundleId', +'content_size': 'contentSize', +'description': 'description', +'group_id': 'groupId', +'id': 'id', +'link': 'link', +'sha256': 'sha256', +'sha256_supplied': 'sha256Supplied', +'system_api_version': 'systemApiVersion', +'timestamp': 'timestamp', +'version': 'version' } + + def __init__(self, artifact_id=None, author=None, bucket_id=None, build_info=None, bundle_id=None, content_size=None, description=None, group_id=None, id=None, link=None, sha256=None, sha256_supplied=None, system_api_version=None, timestamp=None, version=None): """ BundleVersionMetadata - a model defined in Swagger """ - self._link = None - self._id = None - self._bundle_id = None - self._bucket_id = None - self._group_id = None self._artifact_id = None - self._version = None - self._timestamp = None self._author = None + self._bucket_id = None + self._build_info = None + self._bundle_id = None + self._content_size = None self._description = None + self._group_id = None + self._id = None + self._link = None self._sha256 = None self._sha256_supplied = None - self._content_size = None self._system_api_version = None - self._build_info = None + self._timestamp = None + self._version = None - if link is not None: - self.link = link - if id is not None: - self.id = id - if bundle_id is not None: - self.bundle_id = bundle_id - self.bucket_id = bucket_id - if group_id is not None: - self.group_id = group_id if artifact_id is not None: self.artifact_id = artifact_id - if version is not None: - self.version = version - if timestamp is not None: - self.timestamp = timestamp - if author is not None: - self.author = author + self.author = author + self.bucket_id = bucket_id + self.build_info = build_info + self.bundle_id = bundle_id + self.content_size = content_size if description is not None: self.description = description - if sha256 is not None: - self.sha256 = sha256 + if group_id is not None: + self.group_id = group_id + self.id = id + if link is not None: + self.link = link + self.sha256 = sha256 self.sha256_supplied = sha256_supplied - self.content_size = content_size - if system_api_version is not None: - self.system_api_version = system_api_version - self.build_info = build_info - - @property - def link(self): - """ - Gets the link of this BundleVersionMetadata. - An WebLink to this entity. - - :return: The link of this BundleVersionMetadata. - :rtype: JaxbLink - """ - return self._link - - @link.setter - def link(self, link): - """ - Sets the link of this BundleVersionMetadata. - An WebLink to this entity. - - :param link: The link of this BundleVersionMetadata. - :type: JaxbLink - """ - - self._link = link + self.system_api_version = system_api_version + if timestamp is not None: + self.timestamp = timestamp + self.version = version @property - def id(self): + def artifact_id(self): """ - Gets the id of this BundleVersionMetadata. - The id of this version of the extension bundle + Gets the artifact_id of this BundleVersionMetadata. - :return: The id of this BundleVersionMetadata. + :return: The artifact_id of this BundleVersionMetadata. :rtype: str """ - return self._id + return self._artifact_id - @id.setter - def id(self, id): + @artifact_id.setter + def artifact_id(self, artifact_id): """ - Sets the id of this BundleVersionMetadata. - The id of this version of the extension bundle + Sets the artifact_id of this BundleVersionMetadata. - :param id: The id of this BundleVersionMetadata. + :param artifact_id: The artifact_id of this BundleVersionMetadata. :type: str """ - self._id = id + self._artifact_id = artifact_id @property - def bundle_id(self): + def author(self): """ - Gets the bundle_id of this BundleVersionMetadata. - The id of the extension bundle this version is for + Gets the author of this BundleVersionMetadata. + The identity that created this version - :return: The bundle_id of this BundleVersionMetadata. + :return: The author of this BundleVersionMetadata. :rtype: str """ - return self._bundle_id + return self._author - @bundle_id.setter - def bundle_id(self, bundle_id): + @author.setter + def author(self, author): """ - Sets the bundle_id of this BundleVersionMetadata. - The id of the extension bundle this version is for + Sets the author of this BundleVersionMetadata. + The identity that created this version - :param bundle_id: The bundle_id of this BundleVersionMetadata. + :param author: The author of this BundleVersionMetadata. :type: str """ + if author is None: + raise ValueError("Invalid value for `author`, must not be `None`") - self._bundle_id = bundle_id + self._author = author @property def bucket_id(self): @@ -206,140 +174,167 @@ def bucket_id(self, bucket_id): self._bucket_id = bucket_id @property - def group_id(self): + def build_info(self): """ - Gets the group_id of this BundleVersionMetadata. + Gets the build_info of this BundleVersionMetadata. - :return: The group_id of this BundleVersionMetadata. - :rtype: str + :return: The build_info of this BundleVersionMetadata. + :rtype: BuildInfo """ - return self._group_id + return self._build_info - @group_id.setter - def group_id(self, group_id): + @build_info.setter + def build_info(self, build_info): """ - Sets the group_id of this BundleVersionMetadata. + Sets the build_info of this BundleVersionMetadata. - :param group_id: The group_id of this BundleVersionMetadata. - :type: str + :param build_info: The build_info of this BundleVersionMetadata. + :type: BuildInfo """ + if build_info is None: + raise ValueError("Invalid value for `build_info`, must not be `None`") - self._group_id = group_id + self._build_info = build_info @property - def artifact_id(self): + def bundle_id(self): """ - Gets the artifact_id of this BundleVersionMetadata. + Gets the bundle_id of this BundleVersionMetadata. + The id of the extension bundle this version is for - :return: The artifact_id of this BundleVersionMetadata. + :return: The bundle_id of this BundleVersionMetadata. :rtype: str """ - return self._artifact_id + return self._bundle_id - @artifact_id.setter - def artifact_id(self, artifact_id): + @bundle_id.setter + def bundle_id(self, bundle_id): """ - Sets the artifact_id of this BundleVersionMetadata. + Sets the bundle_id of this BundleVersionMetadata. + The id of the extension bundle this version is for - :param artifact_id: The artifact_id of this BundleVersionMetadata. + :param bundle_id: The bundle_id of this BundleVersionMetadata. :type: str """ + if bundle_id is None: + raise ValueError("Invalid value for `bundle_id`, must not be `None`") - self._artifact_id = artifact_id + self._bundle_id = bundle_id @property - def version(self): + def content_size(self): """ - Gets the version of this BundleVersionMetadata. - The version of the extension bundle + Gets the content_size of this BundleVersionMetadata. + The size of the binary content for this version in bytes - :return: The version of this BundleVersionMetadata. - :rtype: str + :return: The content_size of this BundleVersionMetadata. + :rtype: int """ - return self._version + return self._content_size - @version.setter - def version(self, version): + @content_size.setter + def content_size(self, content_size): """ - Sets the version of this BundleVersionMetadata. - The version of the extension bundle + Sets the content_size of this BundleVersionMetadata. + The size of the binary content for this version in bytes - :param version: The version of this BundleVersionMetadata. - :type: str + :param content_size: The content_size of this BundleVersionMetadata. + :type: int """ + if content_size is None: + raise ValueError("Invalid value for `content_size`, must not be `None`") - self._version = version + self._content_size = content_size @property - def timestamp(self): + def description(self): """ - Gets the timestamp of this BundleVersionMetadata. - The timestamp of the create date of this version + Gets the description of this BundleVersionMetadata. + The description for this version - :return: The timestamp of this BundleVersionMetadata. - :rtype: int + :return: The description of this BundleVersionMetadata. + :rtype: str """ - return self._timestamp + return self._description - @timestamp.setter - def timestamp(self, timestamp): + @description.setter + def description(self, description): """ - Sets the timestamp of this BundleVersionMetadata. - The timestamp of the create date of this version + Sets the description of this BundleVersionMetadata. + The description for this version - :param timestamp: The timestamp of this BundleVersionMetadata. - :type: int + :param description: The description of this BundleVersionMetadata. + :type: str """ - if timestamp is not None and timestamp < 1: - raise ValueError("Invalid value for `timestamp`, must be a value greater than or equal to `1`") - self._timestamp = timestamp + self._description = description @property - def author(self): + def group_id(self): """ - Gets the author of this BundleVersionMetadata. - The identity that created this version + Gets the group_id of this BundleVersionMetadata. - :return: The author of this BundleVersionMetadata. + :return: The group_id of this BundleVersionMetadata. :rtype: str """ - return self._author + return self._group_id - @author.setter - def author(self, author): + @group_id.setter + def group_id(self, group_id): """ - Sets the author of this BundleVersionMetadata. - The identity that created this version + Sets the group_id of this BundleVersionMetadata. - :param author: The author of this BundleVersionMetadata. + :param group_id: The group_id of this BundleVersionMetadata. :type: str """ - self._author = author + self._group_id = group_id @property - def description(self): + def id(self): """ - Gets the description of this BundleVersionMetadata. - The description for this version + Gets the id of this BundleVersionMetadata. + The id of this version of the extension bundle - :return: The description of this BundleVersionMetadata. + :return: The id of this BundleVersionMetadata. :rtype: str """ - return self._description + return self._id - @description.setter - def description(self, description): + @id.setter + def id(self, id): """ - Sets the description of this BundleVersionMetadata. - The description for this version + Sets the id of this BundleVersionMetadata. + The id of this version of the extension bundle - :param description: The description of this BundleVersionMetadata. + :param id: The id of this BundleVersionMetadata. :type: str """ + if id is None: + raise ValueError("Invalid value for `id`, must not be `None`") - self._description = description + self._id = id + + @property + def link(self): + """ + Gets the link of this BundleVersionMetadata. + + :return: The link of this BundleVersionMetadata. + :rtype: Link + """ + return self._link + + @link.setter + def link(self, link): + """ + Sets the link of this BundleVersionMetadata. + + :param link: The link of this BundleVersionMetadata. + :type: Link + """ + + self._link = link @property def sha256(self): @@ -361,6 +356,8 @@ def sha256(self, sha256): :param sha256: The sha256 of this BundleVersionMetadata. :type: str """ + if sha256 is None: + raise ValueError("Invalid value for `sha256`, must not be `None`") self._sha256 = sha256 @@ -389,33 +386,6 @@ def sha256_supplied(self, sha256_supplied): self._sha256_supplied = sha256_supplied - @property - def content_size(self): - """ - Gets the content_size of this BundleVersionMetadata. - The size of the binary content for this version in bytes - - :return: The content_size of this BundleVersionMetadata. - :rtype: int - """ - return self._content_size - - @content_size.setter - def content_size(self, content_size): - """ - Sets the content_size of this BundleVersionMetadata. - The size of the binary content for this version in bytes - - :param content_size: The content_size of this BundleVersionMetadata. - :type: int - """ - if content_size is None: - raise ValueError("Invalid value for `content_size`, must not be `None`") - if content_size is not None and content_size < 0: - raise ValueError("Invalid value for `content_size`, must be a value greater than or equal to `0`") - - self._content_size = content_size - @property def system_api_version(self): """ @@ -436,33 +406,58 @@ def system_api_version(self, system_api_version): :param system_api_version: The system_api_version of this BundleVersionMetadata. :type: str """ + if system_api_version is None: + raise ValueError("Invalid value for `system_api_version`, must not be `None`") self._system_api_version = system_api_version @property - def build_info(self): + def timestamp(self): """ - Gets the build_info of this BundleVersionMetadata. - The build information about this version + Gets the timestamp of this BundleVersionMetadata. + The timestamp of the create date of this version - :return: The build_info of this BundleVersionMetadata. - :rtype: BuildInfo + :return: The timestamp of this BundleVersionMetadata. + :rtype: int """ - return self._build_info + return self._timestamp - @build_info.setter - def build_info(self, build_info): + @timestamp.setter + def timestamp(self, timestamp): """ - Sets the build_info of this BundleVersionMetadata. - The build information about this version + Sets the timestamp of this BundleVersionMetadata. + The timestamp of the create date of this version - :param build_info: The build_info of this BundleVersionMetadata. - :type: BuildInfo + :param timestamp: The timestamp of this BundleVersionMetadata. + :type: int """ - if build_info is None: - raise ValueError("Invalid value for `build_info`, must not be `None`") - self._build_info = build_info + self._timestamp = timestamp + + @property + def version(self): + """ + Gets the version of this BundleVersionMetadata. + The version of the extension bundle + + :return: The version of this BundleVersionMetadata. + :rtype: str + """ + return self._version + + @version.setter + def version(self, version): + """ + Sets the version of this BundleVersionMetadata. + The version of the extension bundle + + :param version: The version of this BundleVersionMetadata. + :type: str + """ + if version is None: + raise ValueError("Invalid value for `version`, must not be `None`") + + self._version = version def to_dict(self): """ diff --git a/nipyapi/registry/models/jaxb_link.py b/nipyapi/registry/models/bundles_bundle_type_body.py similarity index 61% rename from nipyapi/registry/models/jaxb_link.py rename to nipyapi/registry/models/bundles_bundle_type_body.py index f8bf2b11..199e992c 100644 --- a/nipyapi/registry/models/jaxb_link.py +++ b/nipyapi/registry/models/bundles_bundle_type_body.py @@ -1,19 +1,18 @@ """ Apache NiFi Registry REST API - The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components. + REST API definition for Apache NiFi Registry web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re -class JaxbLink(object): +class BundlesBundleTypeBody(object): """ NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually. @@ -28,73 +27,67 @@ class JaxbLink(object): and the value is json key in definition. """ swagger_types = { - 'href': 'str', - 'params': 'dict(str, str)' - } + 'file': 'FormDataContentDisposition', +'sha256': 'str' } attribute_map = { - 'href': 'href', - 'params': 'params' - } + 'file': 'file', +'sha256': 'sha256' } - def __init__(self, href=None, params=None): + def __init__(self, file=None, sha256=None): """ - JaxbLink - a model defined in Swagger + BundlesBundleTypeBody - a model defined in Swagger """ - self._href = None - self._params = None + self._file = None + self._sha256 = None - if href is not None: - self.href = href - if params is not None: - self.params = params + if file is not None: + self.file = file + if sha256 is not None: + self.sha256 = sha256 @property - def href(self): + def file(self): """ - Gets the href of this JaxbLink. - The href for the link + Gets the file of this BundlesBundleTypeBody. - :return: The href of this JaxbLink. - :rtype: str + :return: The file of this BundlesBundleTypeBody. + :rtype: FormDataContentDisposition """ - return self._href + return self._file - @href.setter - def href(self, href): + @file.setter + def file(self, file): """ - Sets the href of this JaxbLink. - The href for the link + Sets the file of this BundlesBundleTypeBody. - :param href: The href of this JaxbLink. - :type: str + :param file: The file of this BundlesBundleTypeBody. + :type: FormDataContentDisposition """ - self._href = href + self._file = file @property - def params(self): + def sha256(self): """ - Gets the params of this JaxbLink. - The params for the link + Gets the sha256 of this BundlesBundleTypeBody. - :return: The params of this JaxbLink. - :rtype: dict(str, str) + :return: The sha256 of this BundlesBundleTypeBody. + :rtype: str """ - return self._params + return self._sha256 - @params.setter - def params(self, params): + @sha256.setter + def sha256(self, sha256): """ - Sets the params of this JaxbLink. - The params for the link + Sets the sha256 of this BundlesBundleTypeBody. - :param params: The params of this JaxbLink. - :type: dict(str, str) + :param sha256: The sha256 of this BundlesBundleTypeBody. + :type: str """ - self._params = params + self._sha256 = sha256 def to_dict(self): """ @@ -138,7 +131,7 @@ def __eq__(self, other): """ Returns true if both objects are equal """ - if not isinstance(other, JaxbLink): + if not isinstance(other, BundlesBundleTypeBody): return False return self.__dict__ == other.__dict__ diff --git a/nipyapi/registry/models/client_id_parameter.py b/nipyapi/registry/models/client_id_parameter.py new file mode 100644 index 00000000..aa82a5f6 --- /dev/null +++ b/nipyapi/registry/models/client_id_parameter.py @@ -0,0 +1,117 @@ +""" + Apache NiFi Registry REST API + + REST API definition for Apache NiFi Registry web services + + OpenAPI spec version: 2.5.0 + Contact: dev@nifi.apache.org + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from pprint import pformat +import re + + +class ClientIdParameter(object): + """ + NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. + """ + + + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'client_id': 'str' } + + attribute_map = { + 'client_id': 'clientId' } + + def __init__(self, client_id=None): + """ + ClientIdParameter - a model defined in Swagger + """ + + self._client_id = None + + if client_id is not None: + self.client_id = client_id + + @property + def client_id(self): + """ + Gets the client_id of this ClientIdParameter. + + :return: The client_id of this ClientIdParameter. + :rtype: str + """ + return self._client_id + + @client_id.setter + def client_id(self, client_id): + """ + Sets the client_id of this ClientIdParameter. + + :param client_id: The client_id of this ClientIdParameter. + :type: str + """ + + self._client_id = client_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, ClientIdParameter): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """ + Returns true if both objects are not equal + """ + return not self == other diff --git a/nipyapi/registry/models/component_difference.py b/nipyapi/registry/models/component_difference.py index 00c0899c..e5ea7a44 100644 --- a/nipyapi/registry/models/component_difference.py +++ b/nipyapi/registry/models/component_difference.py @@ -1,14 +1,13 @@ """ Apache NiFi Registry REST API - The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components. + REST API definition for Apache NiFi Registry web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,88 +27,40 @@ class ComponentDifference(object): and the value is json key in definition. """ swagger_types = { - 'value_a': 'str', - 'value_b': 'str', 'change_description': 'str', - 'difference_type': 'str', - 'difference_type_description': 'str' - } +'difference_type': 'str', +'difference_type_description': 'str', +'value_a': 'str', +'value_b': 'str' } attribute_map = { - 'value_a': 'valueA', - 'value_b': 'valueB', 'change_description': 'changeDescription', - 'difference_type': 'differenceType', - 'difference_type_description': 'differenceTypeDescription' - } +'difference_type': 'differenceType', +'difference_type_description': 'differenceTypeDescription', +'value_a': 'valueA', +'value_b': 'valueB' } - def __init__(self, value_a=None, value_b=None, change_description=None, difference_type=None, difference_type_description=None): + def __init__(self, change_description=None, difference_type=None, difference_type_description=None, value_a=None, value_b=None): """ ComponentDifference - a model defined in Swagger """ - self._value_a = None - self._value_b = None self._change_description = None self._difference_type = None self._difference_type_description = None + self._value_a = None + self._value_b = None - if value_a is not None: - self.value_a = value_a - if value_b is not None: - self.value_b = value_b if change_description is not None: self.change_description = change_description if difference_type is not None: self.difference_type = difference_type if difference_type_description is not None: self.difference_type_description = difference_type_description - - @property - def value_a(self): - """ - Gets the value_a of this ComponentDifference. - The earlier value from the difference. - - :return: The value_a of this ComponentDifference. - :rtype: str - """ - return self._value_a - - @value_a.setter - def value_a(self, value_a): - """ - Sets the value_a of this ComponentDifference. - The earlier value from the difference. - - :param value_a: The value_a of this ComponentDifference. - :type: str - """ - - self._value_a = value_a - - @property - def value_b(self): - """ - Gets the value_b of this ComponentDifference. - The newer value from the difference. - - :return: The value_b of this ComponentDifference. - :rtype: str - """ - return self._value_b - - @value_b.setter - def value_b(self, value_b): - """ - Sets the value_b of this ComponentDifference. - The newer value from the difference. - - :param value_b: The value_b of this ComponentDifference. - :type: str - """ - - self._value_b = value_b + if value_a is not None: + self.value_a = value_a + if value_b is not None: + self.value_b = value_b @property def change_description(self): @@ -180,6 +131,52 @@ def difference_type_description(self, difference_type_description): self._difference_type_description = difference_type_description + @property + def value_a(self): + """ + Gets the value_a of this ComponentDifference. + The earlier value from the difference. + + :return: The value_a of this ComponentDifference. + :rtype: str + """ + return self._value_a + + @value_a.setter + def value_a(self, value_a): + """ + Sets the value_a of this ComponentDifference. + The earlier value from the difference. + + :param value_a: The value_a of this ComponentDifference. + :type: str + """ + + self._value_a = value_a + + @property + def value_b(self): + """ + Gets the value_b of this ComponentDifference. + The newer value from the difference. + + :return: The value_b of this ComponentDifference. + :rtype: str + """ + return self._value_b + + @value_b.setter + def value_b(self, value_b): + """ + Sets the value_b of this ComponentDifference. + The newer value from the difference. + + :param value_b: The value_b of this ComponentDifference. + :type: str + """ + + self._value_b = value_b + def to_dict(self): """ Returns the model properties as a dict diff --git a/nipyapi/registry/models/component_difference_group.py b/nipyapi/registry/models/component_difference_group.py index 622eba78..8a12d31e 100644 --- a/nipyapi/registry/models/component_difference_group.py +++ b/nipyapi/registry/models/component_difference_group.py @@ -1,14 +1,13 @@ """ Apache NiFi Registry REST API - The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components. + REST API definition for Apache NiFi Registry web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -29,21 +28,19 @@ class ComponentDifferenceGroup(object): """ swagger_types = { 'component_id': 'str', - 'component_name': 'str', - 'component_type': 'str', - 'process_group_id': 'str', - 'differences': 'list[ComponentDifference]' - } +'component_name': 'str', +'component_type': 'str', +'differences': 'list[ComponentDifference]', +'process_group_id': 'str' } attribute_map = { 'component_id': 'componentId', - 'component_name': 'componentName', - 'component_type': 'componentType', - 'process_group_id': 'processGroupId', - 'differences': 'differences' - } +'component_name': 'componentName', +'component_type': 'componentType', +'differences': 'differences', +'process_group_id': 'processGroupId' } - def __init__(self, component_id=None, component_name=None, component_type=None, process_group_id=None, differences=None): + def __init__(self, component_id=None, component_name=None, component_type=None, differences=None, process_group_id=None): """ ComponentDifferenceGroup - a model defined in Swagger """ @@ -51,8 +48,8 @@ def __init__(self, component_id=None, component_name=None, component_type=None, self._component_id = None self._component_name = None self._component_type = None - self._process_group_id = None self._differences = None + self._process_group_id = None if component_id is not None: self.component_id = component_id @@ -60,10 +57,10 @@ def __init__(self, component_id=None, component_name=None, component_type=None, self.component_name = component_name if component_type is not None: self.component_type = component_type - if process_group_id is not None: - self.process_group_id = process_group_id if differences is not None: self.differences = differences + if process_group_id is not None: + self.process_group_id = process_group_id @property def component_id(self): @@ -134,29 +131,6 @@ def component_type(self, component_type): self._component_type = component_type - @property - def process_group_id(self): - """ - Gets the process_group_id of this ComponentDifferenceGroup. - The process group id for this component. - - :return: The process_group_id of this ComponentDifferenceGroup. - :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 ComponentDifferenceGroup. - The process group id for this component. - - :param process_group_id: The process_group_id of this ComponentDifferenceGroup. - :type: str - """ - - self._process_group_id = process_group_id - @property def differences(self): """ @@ -180,6 +154,29 @@ def differences(self, differences): self._differences = differences + @property + def process_group_id(self): + """ + Gets the process_group_id of this ComponentDifferenceGroup. + The process group id for this component. + + :return: The process_group_id of this ComponentDifferenceGroup. + :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 ComponentDifferenceGroup. + The process group id for this component. + + :param process_group_id: The process_group_id of this ComponentDifferenceGroup. + :type: str + """ + + self._process_group_id = process_group_id + def to_dict(self): """ Returns the model properties as a dict diff --git a/nipyapi/registry/models/connectable_component.py b/nipyapi/registry/models/connectable_component.py index 8ad7a569..d1eb91f8 100644 --- a/nipyapi/registry/models/connectable_component.py +++ b/nipyapi/registry/models/connectable_component.py @@ -1,14 +1,13 @@ """ Apache NiFi Registry REST API - The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components. + REST API definition for Apache NiFi Registry web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,194 +27,189 @@ class ConnectableComponent(object): and the value is json key in definition. """ swagger_types = { - 'id': 'str', - 'type': 'str', - 'group_id': 'str', - 'name': 'str', 'comments': 'str', - 'instance_identifier': 'str' - } +'group_id': 'str', +'id': 'str', +'instance_identifier': 'str', +'name': 'str', +'type': 'str' } attribute_map = { - 'id': 'id', - 'type': 'type', - 'group_id': 'groupId', - 'name': 'name', 'comments': 'comments', - 'instance_identifier': 'instanceIdentifier' - } +'group_id': 'groupId', +'id': 'id', +'instance_identifier': 'instanceIdentifier', +'name': 'name', +'type': 'type' } - def __init__(self, id=None, type=None, group_id=None, name=None, comments=None, instance_identifier=None): + def __init__(self, comments=None, group_id=None, id=None, instance_identifier=None, name=None, type=None): """ ConnectableComponent - a model defined in Swagger """ - self._id = None - self._type = None - self._group_id = None - self._name = None self._comments = None + self._group_id = None + self._id = None self._instance_identifier = None + self._name = None + self._type = None - self.id = id - self.type = type - self.group_id = group_id - if name is not None: - self.name = name if comments is not None: self.comments = comments + if group_id is not None: + self.group_id = group_id + if id is not None: + self.id = id if instance_identifier is not None: self.instance_identifier = instance_identifier + if name is not None: + self.name = name + if type is not None: + self.type = type @property - def id(self): + def comments(self): """ - Gets the id of this ConnectableComponent. - The id of the connectable component. + Gets the comments of this ConnectableComponent. + The comments for the connectable component. - :return: The id of this ConnectableComponent. + :return: The comments of this ConnectableComponent. :rtype: str """ - return self._id + return self._comments - @id.setter - def id(self, id): + @comments.setter + def comments(self, comments): """ - Sets the id of this ConnectableComponent. - The id of the connectable component. + Sets the comments of this ConnectableComponent. + The comments for the connectable component. - :param id: The id of this ConnectableComponent. + :param comments: The comments of this ConnectableComponent. :type: str """ - if id is None: - raise ValueError("Invalid value for `id`, must not be `None`") - self._id = id + self._comments = comments @property - def type(self): + def group_id(self): """ - Gets the type of this ConnectableComponent. - The type of component the connectable is. + Gets the group_id of this ConnectableComponent. + The id of the group that the connectable component resides in - :return: The type of this ConnectableComponent. + :return: The group_id of this ConnectableComponent. :rtype: str """ - return self._type + return self._group_id - @type.setter - def type(self, type): + @group_id.setter + def group_id(self, group_id): """ - Sets the type of this ConnectableComponent. - The type of component the connectable is. + Sets the group_id of this ConnectableComponent. + The id of the group that the connectable component resides in - :param type: The type of this ConnectableComponent. + :param group_id: The group_id of this ConnectableComponent. :type: str """ - 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) - ) - self._type = type + self._group_id = group_id @property - def group_id(self): + def id(self): """ - Gets the group_id of this ConnectableComponent. - The id of the group that the connectable component resides in + Gets the id of this ConnectableComponent. + The id of the connectable component. - :return: The group_id of this ConnectableComponent. + :return: The id of this ConnectableComponent. :rtype: str """ - return self._group_id + return self._id - @group_id.setter - def group_id(self, group_id): + @id.setter + def id(self, id): """ - Sets the group_id of this ConnectableComponent. - The id of the group that the connectable component resides in + Sets the id of this ConnectableComponent. + The id of the connectable component. - :param group_id: The group_id of this ConnectableComponent. + :param id: The id of this ConnectableComponent. :type: str """ - if group_id is None: - raise ValueError("Invalid value for `group_id`, must not be `None`") - self._group_id = group_id + self._id = id @property - def name(self): + def instance_identifier(self): """ - Gets the name of this ConnectableComponent. - The name of the connectable component + Gets the instance_identifier of this ConnectableComponent. + The instance ID of an existing component that is described by this VersionedComponent, or null if this is not mapped to an instantiated component - :return: The name of this ConnectableComponent. + :return: The instance_identifier of this ConnectableComponent. :rtype: str """ - return self._name + return self._instance_identifier - @name.setter - def name(self, name): + @instance_identifier.setter + def instance_identifier(self, instance_identifier): """ - Sets the name of this ConnectableComponent. - The name of the connectable component + Sets the instance_identifier of this ConnectableComponent. + The instance ID of an existing component that is described by this VersionedComponent, or null if this is not mapped to an instantiated component - :param name: The name of this ConnectableComponent. + :param instance_identifier: The instance_identifier of this ConnectableComponent. :type: str """ - self._name = name + self._instance_identifier = instance_identifier @property - def comments(self): + def name(self): """ - Gets the comments of this ConnectableComponent. - The comments for the connectable component. + Gets the name of this ConnectableComponent. + The name of the connectable component - :return: The comments of this ConnectableComponent. + :return: The name of this ConnectableComponent. :rtype: str """ - return self._comments + return self._name - @comments.setter - def comments(self, comments): + @name.setter + def name(self, name): """ - Sets the comments of this ConnectableComponent. - The comments for the connectable component. + Sets the name of this ConnectableComponent. + The name of the connectable component - :param comments: The comments of this ConnectableComponent. + :param name: The name of this ConnectableComponent. :type: str """ - self._comments = comments + self._name = name @property - def instance_identifier(self): + def type(self): """ - Gets the instance_identifier of this ConnectableComponent. - The instance ID of an existing component that is described by this VersionedComponent, or null if this is not mapped to an instantiated component + Gets the type of this ConnectableComponent. + The type of component the connectable is. - :return: The instance_identifier of this ConnectableComponent. + :return: The type of this ConnectableComponent. :rtype: str """ - return self._instance_identifier + return self._type - @instance_identifier.setter - def instance_identifier(self, instance_identifier): + @type.setter + def type(self, type): """ - Sets the instance_identifier of this ConnectableComponent. - The instance ID of an existing component that is described by this VersionedComponent, or null if this is not mapped to an instantiated component + Sets the type of this ConnectableComponent. + The type of component the connectable is. - :param instance_identifier: The instance_identifier of this ConnectableComponent. + :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) + ) - self._instance_identifier = instance_identifier + self._type = type def to_dict(self): """ diff --git a/nipyapi/registry/models/controller_service_api.py b/nipyapi/registry/models/controller_service_api.py index 6e3ed50d..89cca316 100644 --- a/nipyapi/registry/models/controller_service_api.py +++ b/nipyapi/registry/models/controller_service_api.py @@ -1,14 +1,13 @@ """ Apache NiFi Registry REST API - The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components. + REST API definition for Apache NiFi Registry web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,27 +27,46 @@ class ControllerServiceAPI(object): and the value is json key in definition. """ swagger_types = { - 'type': 'str', - 'bundle': 'Bundle' - } + 'bundle': 'Bundle', +'type': 'str' } attribute_map = { - 'type': 'type', - 'bundle': 'bundle' - } + 'bundle': 'bundle', +'type': 'type' } - def __init__(self, type=None, bundle=None): + def __init__(self, bundle=None, type=None): """ ControllerServiceAPI - a model defined in Swagger """ - self._type = None self._bundle = None + self._type = None - if type is not None: - self.type = type if bundle is not None: self.bundle = bundle + if type is not None: + self.type = type + + @property + def bundle(self): + """ + Gets the bundle of this ControllerServiceAPI. + + :return: The bundle of this ControllerServiceAPI. + :rtype: Bundle + """ + return self._bundle + + @bundle.setter + def bundle(self, bundle): + """ + Sets the bundle of this ControllerServiceAPI. + + :param bundle: The bundle of this ControllerServiceAPI. + :type: Bundle + """ + + self._bundle = bundle @property def type(self): @@ -73,29 +91,6 @@ def type(self, type): self._type = type - @property - def bundle(self): - """ - Gets the bundle of this ControllerServiceAPI. - The details of the artifact that bundled this service interface. - - :return: The bundle of this ControllerServiceAPI. - :rtype: Bundle - """ - return self._bundle - - @bundle.setter - def bundle(self, bundle): - """ - Sets the bundle of this ControllerServiceAPI. - The details of the artifact that bundled this service interface. - - :param bundle: The bundle of this ControllerServiceAPI. - :type: Bundle - """ - - self._bundle = bundle - def to_dict(self): """ Returns the model properties as a dict diff --git a/nipyapi/registry/models/controller_service_definition.py b/nipyapi/registry/models/controller_service_definition.py index 4ec7a8b7..e852cc08 100644 --- a/nipyapi/registry/models/controller_service_definition.py +++ b/nipyapi/registry/models/controller_service_definition.py @@ -1,14 +1,13 @@ """ Apache NiFi Registry REST API - The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components. + REST API definition for Apache NiFi Registry web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,38 +27,59 @@ class ControllerServiceDefinition(object): and the value is json key in definition. """ swagger_types = { - 'class_name': 'str', - 'group_id': 'str', 'artifact_id': 'str', - 'version': 'str' - } +'class_name': 'str', +'group_id': 'str', +'version': 'str' } attribute_map = { - 'class_name': 'className', - 'group_id': 'groupId', 'artifact_id': 'artifactId', - 'version': 'version' - } +'class_name': 'className', +'group_id': 'groupId', +'version': 'version' } - def __init__(self, class_name=None, group_id=None, artifact_id=None, version=None): + def __init__(self, artifact_id=None, class_name=None, group_id=None, version=None): """ ControllerServiceDefinition - a model defined in Swagger """ + self._artifact_id = None self._class_name = None self._group_id = None - self._artifact_id = None self._version = None + if artifact_id is not None: + self.artifact_id = artifact_id if class_name is not None: self.class_name = class_name if group_id is not None: self.group_id = group_id - if artifact_id is not None: - self.artifact_id = artifact_id if version is not None: self.version = version + @property + def artifact_id(self): + """ + Gets the artifact_id of this ControllerServiceDefinition. + The artifact id of the service API + + :return: The artifact_id of this ControllerServiceDefinition. + :rtype: str + """ + return self._artifact_id + + @artifact_id.setter + def artifact_id(self, artifact_id): + """ + Sets the artifact_id of this ControllerServiceDefinition. + The artifact id of the service API + + :param artifact_id: The artifact_id of this ControllerServiceDefinition. + :type: str + """ + + self._artifact_id = artifact_id + @property def class_name(self): """ @@ -106,29 +126,6 @@ def group_id(self, group_id): self._group_id = group_id - @property - def artifact_id(self): - """ - Gets the artifact_id of this ControllerServiceDefinition. - The artifact id of the service API - - :return: The artifact_id of this ControllerServiceDefinition. - :rtype: str - """ - return self._artifact_id - - @artifact_id.setter - def artifact_id(self, artifact_id): - """ - Sets the artifact_id of this ControllerServiceDefinition. - The artifact id of the service API - - :param artifact_id: The artifact_id of this ControllerServiceDefinition. - :type: str - """ - - self._artifact_id = artifact_id - @property def version(self): """ diff --git a/nipyapi/registry/models/current_user.py b/nipyapi/registry/models/current_user.py index ef1ffa62..882e6929 100644 --- a/nipyapi/registry/models/current_user.py +++ b/nipyapi/registry/models/current_user.py @@ -1,14 +1,13 @@ """ Apache NiFi Registry REST API - The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components. + REST API definition for Apache NiFi Registry web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,65 +27,40 @@ class CurrentUser(object): and the value is json key in definition. """ swagger_types = { - 'identity': 'str', 'anonymous': 'bool', - 'login_supported': 'bool', - 'resource_permissions': 'ResourcePermissions', - 'oidclogin_supported': 'bool' - } +'identity': 'str', +'login_supported': 'bool', +'oidclogin_supported': 'bool', +'resource_permissions': 'ResourcePermissions' } attribute_map = { - 'identity': 'identity', 'anonymous': 'anonymous', - 'login_supported': 'loginSupported', - 'resource_permissions': 'resourcePermissions', - 'oidclogin_supported': 'oidcloginSupported' - } +'identity': 'identity', +'login_supported': 'loginSupported', +'oidclogin_supported': 'oidcloginSupported', +'resource_permissions': 'resourcePermissions' } - def __init__(self, identity=None, anonymous=None, login_supported=None, resource_permissions=None, oidclogin_supported=None): + def __init__(self, anonymous=None, identity=None, login_supported=None, oidclogin_supported=None, resource_permissions=None): """ CurrentUser - a model defined in Swagger """ - self._identity = None self._anonymous = None + self._identity = None self._login_supported = None - self._resource_permissions = None self._oidclogin_supported = None + self._resource_permissions = None - if identity is not None: - self.identity = identity if anonymous is not None: self.anonymous = anonymous + if identity is not None: + self.identity = identity if login_supported is not None: self.login_supported = login_supported - if resource_permissions is not None: - self.resource_permissions = resource_permissions if oidclogin_supported is not None: self.oidclogin_supported = oidclogin_supported - - @property - def identity(self): - """ - Gets the identity of this CurrentUser. - The identity of the current user - - :return: The identity of this CurrentUser. - :rtype: str - """ - return self._identity - - @identity.setter - def identity(self, identity): - """ - Sets the identity of this CurrentUser. - The identity of the current user - - :param identity: The identity of this CurrentUser. - :type: str - """ - - self._identity = identity + if resource_permissions is not None: + self.resource_permissions = resource_permissions @property def anonymous(self): @@ -111,6 +85,29 @@ def anonymous(self, anonymous): self._anonymous = anonymous + @property + def identity(self): + """ + Gets the identity of this CurrentUser. + The identity of the current user + + :return: The identity of this CurrentUser. + :rtype: str + """ + return self._identity + + @identity.setter + def identity(self, identity): + """ + Sets the identity of this CurrentUser. + The identity of the current user + + :param identity: The identity of this CurrentUser. + :type: str + """ + + self._identity = identity + @property def login_supported(self): """ @@ -134,29 +131,6 @@ def login_supported(self, login_supported): self._login_supported = login_supported - @property - def resource_permissions(self): - """ - Gets the resource_permissions of this CurrentUser. - The access that the current user has to top level resources - - :return: The resource_permissions of this CurrentUser. - :rtype: ResourcePermissions - """ - return self._resource_permissions - - @resource_permissions.setter - def resource_permissions(self, resource_permissions): - """ - Sets the resource_permissions of this CurrentUser. - The access that the current user has to top level resources - - :param resource_permissions: The resource_permissions of this CurrentUser. - :type: ResourcePermissions - """ - - self._resource_permissions = resource_permissions - @property def oidclogin_supported(self): """ @@ -180,6 +154,27 @@ def oidclogin_supported(self, oidclogin_supported): self._oidclogin_supported = oidclogin_supported + @property + def resource_permissions(self): + """ + Gets the resource_permissions of this CurrentUser. + + :return: The resource_permissions of this CurrentUser. + :rtype: ResourcePermissions + """ + return self._resource_permissions + + @resource_permissions.setter + def resource_permissions(self, resource_permissions): + """ + Sets the resource_permissions of this CurrentUser. + + :param resource_permissions: The resource_permissions of this CurrentUser. + :type: ResourcePermissions + """ + + self._resource_permissions = resource_permissions + def to_dict(self): """ Returns the model properties as a dict diff --git a/nipyapi/registry/models/default_schedule.py b/nipyapi/registry/models/default_schedule.py index 6323dd3a..dd95ffa1 100644 --- a/nipyapi/registry/models/default_schedule.py +++ b/nipyapi/registry/models/default_schedule.py @@ -1,14 +1,13 @@ """ Apache NiFi Registry REST API - The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components. + REST API definition for Apache NiFi Registry web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,55 +27,53 @@ class DefaultSchedule(object): and the value is json key in definition. """ swagger_types = { - 'strategy': 'str', - 'period': 'str', - 'concurrent_tasks': 'str' - } + 'concurrent_tasks': 'str', +'period': 'str', +'strategy': 'str' } attribute_map = { - 'strategy': 'strategy', - 'period': 'period', - 'concurrent_tasks': 'concurrentTasks' - } + 'concurrent_tasks': 'concurrentTasks', +'period': 'period', +'strategy': 'strategy' } - def __init__(self, strategy=None, period=None, concurrent_tasks=None): + def __init__(self, concurrent_tasks=None, period=None, strategy=None): """ DefaultSchedule - a model defined in Swagger """ - self._strategy = None - self._period = None self._concurrent_tasks = None + self._period = None + self._strategy = None - if strategy is not None: - self.strategy = strategy - if period is not None: - self.period = period if concurrent_tasks is not None: self.concurrent_tasks = concurrent_tasks + if period is not None: + self.period = period + if strategy is not None: + self.strategy = strategy @property - def strategy(self): + def concurrent_tasks(self): """ - Gets the strategy of this DefaultSchedule. - The default scheduling strategy + Gets the concurrent_tasks of this DefaultSchedule. + The default concurrent tasks - :return: The strategy of this DefaultSchedule. + :return: The concurrent_tasks of this DefaultSchedule. :rtype: str """ - return self._strategy + return self._concurrent_tasks - @strategy.setter - def strategy(self, strategy): + @concurrent_tasks.setter + def concurrent_tasks(self, concurrent_tasks): """ - Sets the strategy of this DefaultSchedule. - The default scheduling strategy + Sets the concurrent_tasks of this DefaultSchedule. + The default concurrent tasks - :param strategy: The strategy of this DefaultSchedule. + :param concurrent_tasks: The concurrent_tasks of this DefaultSchedule. :type: str """ - self._strategy = strategy + self._concurrent_tasks = concurrent_tasks @property def period(self): @@ -102,27 +99,27 @@ def period(self, period): self._period = period @property - def concurrent_tasks(self): + def strategy(self): """ - Gets the concurrent_tasks of this DefaultSchedule. - The default concurrent tasks + Gets the strategy of this DefaultSchedule. + The default scheduling strategy - :return: The concurrent_tasks of this DefaultSchedule. + :return: The strategy of this DefaultSchedule. :rtype: str """ - return self._concurrent_tasks + return self._strategy - @concurrent_tasks.setter - def concurrent_tasks(self, concurrent_tasks): + @strategy.setter + def strategy(self, strategy): """ - Sets the concurrent_tasks of this DefaultSchedule. - The default concurrent tasks + Sets the strategy of this DefaultSchedule. + The default scheduling strategy - :param concurrent_tasks: The concurrent_tasks of this DefaultSchedule. + :param strategy: The strategy of this DefaultSchedule. :type: str """ - self._concurrent_tasks = concurrent_tasks + self._strategy = strategy def to_dict(self): """ diff --git a/nipyapi/registry/models/default_settings.py b/nipyapi/registry/models/default_settings.py index 0a87c364..6d354d54 100644 --- a/nipyapi/registry/models/default_settings.py +++ b/nipyapi/registry/models/default_settings.py @@ -1,14 +1,13 @@ """ Apache NiFi Registry REST API - The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components. + REST API definition for Apache NiFi Registry web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,55 +27,53 @@ class DefaultSettings(object): and the value is json key in definition. """ swagger_types = { - 'yield_duration': 'str', - 'penalty_duration': 'str', - 'bulletin_level': 'str' - } + 'bulletin_level': 'str', +'penalty_duration': 'str', +'yield_duration': 'str' } attribute_map = { - 'yield_duration': 'yieldDuration', - 'penalty_duration': 'penaltyDuration', - 'bulletin_level': 'bulletinLevel' - } + 'bulletin_level': 'bulletinLevel', +'penalty_duration': 'penaltyDuration', +'yield_duration': 'yieldDuration' } - def __init__(self, yield_duration=None, penalty_duration=None, bulletin_level=None): + def __init__(self, bulletin_level=None, penalty_duration=None, yield_duration=None): """ DefaultSettings - a model defined in Swagger """ - self._yield_duration = None - self._penalty_duration = None self._bulletin_level = None + self._penalty_duration = None + self._yield_duration = None - if yield_duration is not None: - self.yield_duration = yield_duration - if penalty_duration is not None: - self.penalty_duration = penalty_duration if bulletin_level is not None: self.bulletin_level = bulletin_level + if penalty_duration is not None: + self.penalty_duration = penalty_duration + if yield_duration is not None: + self.yield_duration = yield_duration @property - def yield_duration(self): + def bulletin_level(self): """ - Gets the yield_duration of this DefaultSettings. - The default yield duration + Gets the bulletin_level of this DefaultSettings. + The default bulletin level - :return: The yield_duration of this DefaultSettings. + :return: The bulletin_level of this DefaultSettings. :rtype: str """ - return self._yield_duration + return self._bulletin_level - @yield_duration.setter - def yield_duration(self, yield_duration): + @bulletin_level.setter + def bulletin_level(self, bulletin_level): """ - Sets the yield_duration of this DefaultSettings. - The default yield duration + Sets the bulletin_level of this DefaultSettings. + The default bulletin level - :param yield_duration: The yield_duration of this DefaultSettings. + :param bulletin_level: The bulletin_level of this DefaultSettings. :type: str """ - self._yield_duration = yield_duration + self._bulletin_level = bulletin_level @property def penalty_duration(self): @@ -102,27 +99,27 @@ def penalty_duration(self, penalty_duration): self._penalty_duration = penalty_duration @property - def bulletin_level(self): + def yield_duration(self): """ - Gets the bulletin_level of this DefaultSettings. - The default bulletin level + Gets the yield_duration of this DefaultSettings. + The default yield duration - :return: The bulletin_level of this DefaultSettings. + :return: The yield_duration of this DefaultSettings. :rtype: str """ - return self._bulletin_level + return self._yield_duration - @bulletin_level.setter - def bulletin_level(self, bulletin_level): + @yield_duration.setter + def yield_duration(self, yield_duration): """ - Sets the bulletin_level of this DefaultSettings. - The default bulletin level + Sets the yield_duration of this DefaultSettings. + The default yield duration - :param bulletin_level: The bulletin_level of this DefaultSettings. + :param yield_duration: The yield_duration of this DefaultSettings. :type: str """ - self._bulletin_level = bulletin_level + self._yield_duration = yield_duration def to_dict(self): """ diff --git a/nipyapi/registry/models/dependency.py b/nipyapi/registry/models/dependency.py index 8fe224c1..d26f31d7 100644 --- a/nipyapi/registry/models/dependency.py +++ b/nipyapi/registry/models/dependency.py @@ -1,14 +1,13 @@ """ Apache NiFi Registry REST API - The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components. + REST API definition for Apache NiFi Registry web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,55 +27,51 @@ class Dependency(object): and the value is json key in definition. """ swagger_types = { - 'property_name': 'str', - 'property_display_name': 'str', - 'dependent_values': 'DependentValues' - } + 'dependent_values': 'DependentValues', +'property_display_name': 'str', +'property_name': 'str' } attribute_map = { - 'property_name': 'propertyName', - 'property_display_name': 'propertyDisplayName', - 'dependent_values': 'dependentValues' - } + 'dependent_values': 'dependentValues', +'property_display_name': 'propertyDisplayName', +'property_name': 'propertyName' } - def __init__(self, property_name=None, property_display_name=None, dependent_values=None): + def __init__(self, dependent_values=None, property_display_name=None, property_name=None): """ Dependency - a model defined in Swagger """ - self._property_name = None - self._property_display_name = None self._dependent_values = None + self._property_display_name = None + self._property_name = None - if property_name is not None: - self.property_name = property_name - if property_display_name is not None: - self.property_display_name = property_display_name if dependent_values is not None: self.dependent_values = dependent_values + if property_display_name is not None: + self.property_display_name = property_display_name + if property_name is not None: + self.property_name = property_name @property - def property_name(self): + def dependent_values(self): """ - Gets the property_name of this Dependency. - The name of the dependent property + Gets the dependent_values of this Dependency. - :return: The property_name of this Dependency. - :rtype: str + :return: The dependent_values of this Dependency. + :rtype: DependentValues """ - return self._property_name + return self._dependent_values - @property_name.setter - def property_name(self, property_name): + @dependent_values.setter + def dependent_values(self, dependent_values): """ - Sets the property_name of this Dependency. - The name of the dependent property + Sets the dependent_values of this Dependency. - :param property_name: The property_name of this Dependency. - :type: str + :param dependent_values: The dependent_values of this Dependency. + :type: DependentValues """ - self._property_name = property_name + self._dependent_values = dependent_values @property def property_display_name(self): @@ -102,27 +97,27 @@ def property_display_name(self, property_display_name): self._property_display_name = property_display_name @property - def dependent_values(self): + def property_name(self): """ - Gets the dependent_values of this Dependency. - The values of the dependent property that enable the depending property + Gets the property_name of this Dependency. + The name of the dependent property - :return: The dependent_values of this Dependency. - :rtype: DependentValues + :return: The property_name of this Dependency. + :rtype: str """ - return self._dependent_values + return self._property_name - @dependent_values.setter - def dependent_values(self, dependent_values): + @property_name.setter + def property_name(self, property_name): """ - Sets the dependent_values of this Dependency. - The values of the dependent property that enable the depending property + Sets the property_name of this Dependency. + The name of the dependent property - :param dependent_values: The dependent_values of this Dependency. - :type: DependentValues + :param property_name: The property_name of this Dependency. + :type: str """ - self._dependent_values = dependent_values + self._property_name = property_name def to_dict(self): """ diff --git a/nipyapi/registry/models/dependent_values.py b/nipyapi/registry/models/dependent_values.py index c35a087b..28e0e228 100644 --- a/nipyapi/registry/models/dependent_values.py +++ b/nipyapi/registry/models/dependent_values.py @@ -1,14 +1,13 @@ """ Apache NiFi Registry REST API - The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components. + REST API definition for Apache NiFi Registry web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,12 +27,10 @@ class DependentValues(object): and the value is json key in definition. """ swagger_types = { - 'values': 'list[str]' - } + 'values': 'list[str]' } attribute_map = { - 'values': 'values' - } + 'values': 'values' } def __init__(self, values=None): """ diff --git a/nipyapi/registry/models/deprecation_notice.py b/nipyapi/registry/models/deprecation_notice.py index 2f2b8adc..a4ba8ec4 100644 --- a/nipyapi/registry/models/deprecation_notice.py +++ b/nipyapi/registry/models/deprecation_notice.py @@ -1,14 +1,13 @@ """ Apache NiFi Registry REST API - The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components. + REST API definition for Apache NiFi Registry web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,50 +27,25 @@ class DeprecationNotice(object): and the value is json key in definition. """ swagger_types = { - 'reason': 'str', - 'alternatives': 'list[str]' - } + 'alternatives': 'list[str]', +'reason': 'str' } attribute_map = { - 'reason': 'reason', - 'alternatives': 'alternatives' - } + 'alternatives': 'alternatives', +'reason': 'reason' } - def __init__(self, reason=None, alternatives=None): + def __init__(self, alternatives=None, reason=None): """ DeprecationNotice - a model defined in Swagger """ - self._reason = None self._alternatives = None + self._reason = None - if reason is not None: - self.reason = reason if alternatives is not None: self.alternatives = alternatives - - @property - def reason(self): - """ - Gets the reason of this DeprecationNotice. - The reason for the deprecation - - :return: The reason of this DeprecationNotice. - :rtype: str - """ - return self._reason - - @reason.setter - def reason(self, reason): - """ - Sets the reason of this DeprecationNotice. - The reason for the deprecation - - :param reason: The reason of this DeprecationNotice. - :type: str - """ - - self._reason = reason + if reason is not None: + self.reason = reason @property def alternatives(self): @@ -96,6 +70,29 @@ def alternatives(self, alternatives): self._alternatives = alternatives + @property + def reason(self): + """ + Gets the reason of this DeprecationNotice. + The reason for the deprecation + + :return: The reason of this DeprecationNotice. + :rtype: str + """ + return self._reason + + @reason.setter + def reason(self, reason): + """ + Sets the reason of this DeprecationNotice. + The reason for the deprecation + + :param reason: The reason of this DeprecationNotice. + :type: str + """ + + self._reason = reason + def to_dict(self): """ Returns the model properties as a dict diff --git a/nipyapi/registry/models/dynamic_property.py b/nipyapi/registry/models/dynamic_property.py index 23489bd9..6ad2c4fa 100644 --- a/nipyapi/registry/models/dynamic_property.py +++ b/nipyapi/registry/models/dynamic_property.py @@ -1,14 +1,13 @@ """ Apache NiFi Registry REST API - The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components. + REST API definition for Apache NiFi Registry web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,88 +27,40 @@ class DynamicProperty(object): and the value is json key in definition. """ swagger_types = { - 'name': 'str', - 'value': 'str', 'description': 'str', - 'expression_language_scope': 'str', - 'expression_language_supported': 'bool' - } +'expression_language_scope': 'str', +'expression_language_supported': 'bool', +'name': 'str', +'value': 'str' } attribute_map = { - 'name': 'name', - 'value': 'value', 'description': 'description', - 'expression_language_scope': 'expressionLanguageScope', - 'expression_language_supported': 'expressionLanguageSupported' - } +'expression_language_scope': 'expressionLanguageScope', +'expression_language_supported': 'expressionLanguageSupported', +'name': 'name', +'value': 'value' } - def __init__(self, name=None, value=None, description=None, expression_language_scope=None, expression_language_supported=None): + def __init__(self, description=None, expression_language_scope=None, expression_language_supported=None, name=None, value=None): """ DynamicProperty - a model defined in Swagger """ - self._name = None - self._value = None self._description = None self._expression_language_scope = None self._expression_language_supported = None + self._name = None + self._value = None - if name is not None: - self.name = name - if value is not None: - self.value = value if description is not None: self.description = description if expression_language_scope is not None: self.expression_language_scope = expression_language_scope if expression_language_supported is not None: self.expression_language_supported = expression_language_supported - - @property - def name(self): - """ - Gets the name of this DynamicProperty. - The description of the dynamic property name - - :return: The name of this DynamicProperty. - :rtype: str - """ - return self._name - - @name.setter - def name(self, name): - """ - Sets the name of this DynamicProperty. - The description of the dynamic property name - - :param name: The name of this DynamicProperty. - :type: str - """ - - self._name = name - - @property - def value(self): - """ - Gets the value of this DynamicProperty. - The description of the dynamic property value - - :return: The value of this DynamicProperty. - :rtype: str - """ - return self._value - - @value.setter - def value(self, value): - """ - Sets the value of this DynamicProperty. - The description of the dynamic property value - - :param value: The value of this DynamicProperty. - :type: str - """ - - self._value = value + if name is not None: + self.name = name + if value is not None: + self.value = value @property def description(self): @@ -154,7 +105,7 @@ def expression_language_scope(self, expression_language_scope): :param expression_language_scope: The expression_language_scope of this DynamicProperty. :type: str """ - allowed_values = ["NONE", "VARIABLE_REGISTRY", "FLOWFILE_ATTRIBUTES"] + 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}" @@ -186,6 +137,52 @@ def expression_language_supported(self, expression_language_supported): self._expression_language_supported = expression_language_supported + @property + def name(self): + """ + Gets the name of this DynamicProperty. + The description of the dynamic property name + + :return: The name of this DynamicProperty. + :rtype: str + """ + return self._name + + @name.setter + def name(self, name): + """ + Sets the name of this DynamicProperty. + The description of the dynamic property name + + :param name: The name of this DynamicProperty. + :type: str + """ + + self._name = name + + @property + def value(self): + """ + Gets the value of this DynamicProperty. + The description of the dynamic property value + + :return: The value of this DynamicProperty. + :rtype: str + """ + return self._value + + @value.setter + def value(self, value): + """ + Sets the value of this DynamicProperty. + The description of the dynamic property value + + :param value: The value of this DynamicProperty. + :type: str + """ + + self._value = value + def to_dict(self): """ Returns the model properties as a dict diff --git a/nipyapi/registry/models/dynamic_relationship.py b/nipyapi/registry/models/dynamic_relationship.py index 619c6158..adbe4365 100644 --- a/nipyapi/registry/models/dynamic_relationship.py +++ b/nipyapi/registry/models/dynamic_relationship.py @@ -1,14 +1,13 @@ """ Apache NiFi Registry REST API - The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components. + REST API definition for Apache NiFi Registry web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,73 +27,71 @@ class DynamicRelationship(object): and the value is json key in definition. """ swagger_types = { - 'name': 'str', - 'description': 'str' - } + 'description': 'str', +'name': 'str' } attribute_map = { - 'name': 'name', - 'description': 'description' - } + 'description': 'description', +'name': 'name' } - def __init__(self, name=None, description=None): + def __init__(self, description=None, name=None): """ DynamicRelationship - a model defined in Swagger """ - self._name = None self._description = None + self._name = None - if name is not None: - self.name = name if description is not None: self.description = description + if name is not None: + self.name = name @property - def name(self): + def description(self): """ - Gets the name of this DynamicRelationship. - The description of the dynamic relationship name + Gets the description of this DynamicRelationship. + The description of the dynamic relationship - :return: The name of this DynamicRelationship. + :return: The description of this DynamicRelationship. :rtype: str """ - return self._name + return self._description - @name.setter - def name(self, name): + @description.setter + def description(self, description): """ - Sets the name of this DynamicRelationship. - The description of the dynamic relationship name + Sets the description of this DynamicRelationship. + The description of the dynamic relationship - :param name: The name of this DynamicRelationship. + :param description: The description of this DynamicRelationship. :type: str """ - self._name = name + self._description = description @property - def description(self): + def name(self): """ - Gets the description of this DynamicRelationship. - The description of the dynamic relationship + Gets the name of this DynamicRelationship. + The description of the dynamic relationship name - :return: The description of this DynamicRelationship. + :return: The name of this DynamicRelationship. :rtype: str """ - return self._description + return self._name - @description.setter - def description(self, description): + @name.setter + def name(self, name): """ - Sets the description of this DynamicRelationship. - The description of the dynamic relationship + Sets the name of this DynamicRelationship. + The description of the dynamic relationship name - :param description: The description of this DynamicRelationship. + :param name: The name of this DynamicRelationship. :type: str """ - self._description = description + self._name = name def to_dict(self): """ diff --git a/nipyapi/registry/models/extension.py b/nipyapi/registry/models/extension.py index 26146350..a604d9ae 100644 --- a/nipyapi/registry/models/extension.py +++ b/nipyapi/registry/models/extension.py @@ -1,14 +1,13 @@ """ Apache NiFi Registry REST API - The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components. + REST API definition for Apache NiFi Registry web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,210 +27,200 @@ class Extension(object): and the value is json key in definition. """ swagger_types = { - 'name': 'str', - 'type': 'str', - 'deprecation_notice': 'DeprecationNotice', - 'description': 'str', - 'tags': 'list[str]', - 'properties': 'list[ModelProperty]', - 'supports_sensitive_dynamic_properties': 'bool', - 'dynamic_properties': 'list[DynamicProperty]', - 'relationships': 'list[Relationship]', - 'dynamic_relationship': 'DynamicRelationship', - 'reads_attributes': 'list[Attribute]', - 'writes_attributes': 'list[Attribute]', - 'stateful': 'Stateful', - 'restricted': 'Restricted', - 'input_requirement': 'str', - 'system_resource_considerations': 'list[SystemResourceConsideration]', - 'see_also': 'list[str]', - 'provided_service_apis': 'list[ProvidedServiceAPI]', - 'default_settings': 'DefaultSettings', 'default_schedule': 'DefaultSchedule', - 'trigger_serially': 'bool', - 'trigger_when_empty': 'bool', - 'trigger_when_any_destination_available': 'bool', - 'supports_batching': 'bool', - 'event_driven': 'bool', - 'primary_node_only': 'bool', - 'side_effect_free': 'bool' - } +'default_settings': 'DefaultSettings', +'deprecation_notice': 'DeprecationNotice', +'description': 'str', +'dynamic_properties': 'list[DynamicProperty]', +'dynamic_relationship': 'DynamicRelationship', +'input_requirement': 'str', +'multi_processor_use_cases': 'list[MultiProcessorUseCase]', +'name': 'str', +'primary_node_only': 'bool', +'properties': 'list[ModelProperty]', +'provided_service_apis': 'list[ProvidedServiceAPI]', +'reads_attributes': 'list[Attribute]', +'relationships': 'list[Relationship]', +'restricted': 'Restricted', +'see_also': 'list[str]', +'side_effect_free': 'bool', +'stateful': 'Stateful', +'supports_batching': 'bool', +'supports_sensitive_dynamic_properties': 'bool', +'system_resource_considerations': 'list[SystemResourceConsideration]', +'tags': 'list[str]', +'trigger_serially': 'bool', +'trigger_when_any_destination_available': 'bool', +'trigger_when_empty': 'bool', +'type': 'str', +'use_cases': 'list[UseCase]', +'writes_attributes': 'list[Attribute]' } attribute_map = { - 'name': 'name', - 'type': 'type', - 'deprecation_notice': 'deprecationNotice', - 'description': 'description', - 'tags': 'tags', - 'properties': 'properties', - 'supports_sensitive_dynamic_properties': 'supportsSensitiveDynamicProperties', - 'dynamic_properties': 'dynamicProperties', - 'relationships': 'relationships', - 'dynamic_relationship': 'dynamicRelationship', - 'reads_attributes': 'readsAttributes', - 'writes_attributes': 'writesAttributes', - 'stateful': 'stateful', - 'restricted': 'restricted', - 'input_requirement': 'inputRequirement', - 'system_resource_considerations': 'systemResourceConsiderations', - 'see_also': 'seeAlso', - 'provided_service_apis': 'providedServiceAPIs', - 'default_settings': 'defaultSettings', 'default_schedule': 'defaultSchedule', - 'trigger_serially': 'triggerSerially', - 'trigger_when_empty': 'triggerWhenEmpty', - 'trigger_when_any_destination_available': 'triggerWhenAnyDestinationAvailable', - 'supports_batching': 'supportsBatching', - 'event_driven': 'eventDriven', - 'primary_node_only': 'primaryNodeOnly', - 'side_effect_free': 'sideEffectFree' - } - - def __init__(self, name=None, type=None, deprecation_notice=None, description=None, tags=None, properties=None, supports_sensitive_dynamic_properties=None, dynamic_properties=None, relationships=None, dynamic_relationship=None, reads_attributes=None, writes_attributes=None, stateful=None, restricted=None, input_requirement=None, system_resource_considerations=None, see_also=None, provided_service_apis=None, default_settings=None, default_schedule=None, trigger_serially=None, trigger_when_empty=None, trigger_when_any_destination_available=None, supports_batching=None, event_driven=None, primary_node_only=None, side_effect_free=None): +'default_settings': 'defaultSettings', +'deprecation_notice': 'deprecationNotice', +'description': 'description', +'dynamic_properties': 'dynamicProperties', +'dynamic_relationship': 'dynamicRelationship', +'input_requirement': 'inputRequirement', +'multi_processor_use_cases': 'multiProcessorUseCases', +'name': 'name', +'primary_node_only': 'primaryNodeOnly', +'properties': 'properties', +'provided_service_apis': 'providedServiceAPIs', +'reads_attributes': 'readsAttributes', +'relationships': 'relationships', +'restricted': 'restricted', +'see_also': 'seeAlso', +'side_effect_free': 'sideEffectFree', +'stateful': 'stateful', +'supports_batching': 'supportsBatching', +'supports_sensitive_dynamic_properties': 'supportsSensitiveDynamicProperties', +'system_resource_considerations': 'systemResourceConsiderations', +'tags': 'tags', +'trigger_serially': 'triggerSerially', +'trigger_when_any_destination_available': 'triggerWhenAnyDestinationAvailable', +'trigger_when_empty': 'triggerWhenEmpty', +'type': 'type', +'use_cases': 'useCases', +'writes_attributes': 'writesAttributes' } + + def __init__(self, default_schedule=None, default_settings=None, deprecation_notice=None, description=None, dynamic_properties=None, dynamic_relationship=None, input_requirement=None, multi_processor_use_cases=None, name=None, primary_node_only=None, properties=None, provided_service_apis=None, reads_attributes=None, relationships=None, restricted=None, see_also=None, side_effect_free=None, stateful=None, supports_batching=None, supports_sensitive_dynamic_properties=None, system_resource_considerations=None, tags=None, trigger_serially=None, trigger_when_any_destination_available=None, trigger_when_empty=None, type=None, use_cases=None, writes_attributes=None): """ Extension - a model defined in Swagger """ - self._name = None - self._type = None + self._default_schedule = None + self._default_settings = None self._deprecation_notice = None self._description = None - self._tags = None - self._properties = None - self._supports_sensitive_dynamic_properties = None self._dynamic_properties = None - self._relationships = None self._dynamic_relationship = None + self._input_requirement = None + self._multi_processor_use_cases = None + self._name = None + self._primary_node_only = None + self._properties = None + self._provided_service_apis = None self._reads_attributes = None - self._writes_attributes = None - self._stateful = None + self._relationships = None self._restricted = None - self._input_requirement = None - self._system_resource_considerations = None self._see_also = None - self._provided_service_apis = None - self._default_settings = None - self._default_schedule = None + self._side_effect_free = None + self._stateful = None + self._supports_batching = None + self._supports_sensitive_dynamic_properties = None + self._system_resource_considerations = None + self._tags = None self._trigger_serially = None - self._trigger_when_empty = None self._trigger_when_any_destination_available = None - self._supports_batching = None - self._event_driven = None - self._primary_node_only = None - self._side_effect_free = None + self._trigger_when_empty = None + self._type = None + self._use_cases = None + self._writes_attributes = None - if name is not None: - self.name = name - if type is not None: - self.type = type + if default_schedule is not None: + self.default_schedule = default_schedule + if default_settings is not None: + self.default_settings = default_settings if deprecation_notice is not None: self.deprecation_notice = deprecation_notice if description is not None: self.description = description - if tags is not None: - self.tags = tags - if properties is not None: - self.properties = properties - if supports_sensitive_dynamic_properties is not None: - self.supports_sensitive_dynamic_properties = supports_sensitive_dynamic_properties if dynamic_properties is not None: self.dynamic_properties = dynamic_properties - if relationships is not None: - self.relationships = relationships if dynamic_relationship is not None: self.dynamic_relationship = dynamic_relationship + if input_requirement is not None: + self.input_requirement = input_requirement + if multi_processor_use_cases is not None: + self.multi_processor_use_cases = multi_processor_use_cases + self.name = name + if primary_node_only is not None: + self.primary_node_only = primary_node_only + if properties is not None: + self.properties = properties + if provided_service_apis is not None: + self.provided_service_apis = provided_service_apis if reads_attributes is not None: self.reads_attributes = reads_attributes - if writes_attributes is not None: - self.writes_attributes = writes_attributes - if stateful is not None: - self.stateful = stateful + if relationships is not None: + self.relationships = relationships if restricted is not None: self.restricted = restricted - if input_requirement is not None: - self.input_requirement = input_requirement - if system_resource_considerations is not None: - self.system_resource_considerations = system_resource_considerations if see_also is not None: self.see_also = see_also - if provided_service_apis is not None: - self.provided_service_apis = provided_service_apis - if default_settings is not None: - self.default_settings = default_settings - if default_schedule is not None: - self.default_schedule = default_schedule + if side_effect_free is not None: + self.side_effect_free = side_effect_free + if stateful is not None: + self.stateful = stateful + if supports_batching is not None: + self.supports_batching = supports_batching + if supports_sensitive_dynamic_properties is not None: + self.supports_sensitive_dynamic_properties = supports_sensitive_dynamic_properties + if system_resource_considerations is not None: + self.system_resource_considerations = system_resource_considerations + if tags is not None: + self.tags = tags if trigger_serially is not None: self.trigger_serially = trigger_serially - if trigger_when_empty is not None: - self.trigger_when_empty = trigger_when_empty if trigger_when_any_destination_available is not None: self.trigger_when_any_destination_available = trigger_when_any_destination_available - if supports_batching is not None: - self.supports_batching = supports_batching - if event_driven is not None: - self.event_driven = event_driven - if primary_node_only is not None: - self.primary_node_only = primary_node_only - if side_effect_free is not None: - self.side_effect_free = side_effect_free + if trigger_when_empty is not None: + self.trigger_when_empty = trigger_when_empty + self.type = type + if use_cases is not None: + self.use_cases = use_cases + if writes_attributes is not None: + self.writes_attributes = writes_attributes @property - def name(self): + def default_schedule(self): """ - Gets the name of this Extension. - The name of the extension + Gets the default_schedule of this Extension. - :return: The name of this Extension. - :rtype: str + :return: The default_schedule of this Extension. + :rtype: DefaultSchedule """ - return self._name + return self._default_schedule - @name.setter - def name(self, name): + @default_schedule.setter + def default_schedule(self, default_schedule): """ - Sets the name of this Extension. - The name of the extension + Sets the default_schedule of this Extension. - :param name: The name of this Extension. - :type: str + :param default_schedule: The default_schedule of this Extension. + :type: DefaultSchedule """ - self._name = name + self._default_schedule = default_schedule @property - def type(self): + def default_settings(self): """ - Gets the type of this Extension. - The type of the extension + Gets the default_settings of this Extension. - :return: The type of this Extension. - :rtype: str + :return: The default_settings of this Extension. + :rtype: DefaultSettings """ - return self._type + return self._default_settings - @type.setter - def type(self, type): + @default_settings.setter + def default_settings(self, default_settings): """ - Sets the type of this Extension. - The type of the extension + Sets the default_settings of this Extension. - :param type: The type of this Extension. - :type: str + :param default_settings: The default_settings of this Extension. + :type: DefaultSettings """ - allowed_values = ["PROCESSOR", "CONTROLLER_SERVICE", "REPORTING_TASK"] - if type not in allowed_values: - raise ValueError( - "Invalid value for `type` ({0}), must be one of {1}" - .format(type, allowed_values) - ) - self._type = type + self._default_settings = default_settings @property def deprecation_notice(self): """ Gets the deprecation_notice of this Extension. - The deprecation notice of the extension :return: The deprecation_notice of this Extension. :rtype: DeprecationNotice @@ -242,7 +231,6 @@ def deprecation_notice(self): def deprecation_notice(self, deprecation_notice): """ Sets the deprecation_notice of this Extension. - The deprecation notice of the extension :param deprecation_notice: The deprecation_notice of this Extension. :type: DeprecationNotice @@ -273,73 +261,6 @@ def description(self, description): self._description = description - @property - def tags(self): - """ - Gets the tags of this Extension. - The tags of the extension - - :return: The tags of this Extension. - :rtype: list[str] - """ - return self._tags - - @tags.setter - def tags(self, tags): - """ - Sets the tags of this Extension. - The tags of the extension - - :param tags: The tags of this Extension. - :type: list[str] - """ - - self._tags = tags - - @property - def properties(self): - """ - Gets the properties of this Extension. - The properties of the extension - - :return: The properties of this Extension. - :rtype: list[ModelProperty] - """ - return self._properties - - @properties.setter - def properties(self, properties): - """ - Sets the properties of this Extension. - The properties of the extension - - :param properties: The properties of this Extension. - :type: list[ModelProperty] - """ - - self._properties = properties - - @property - def supports_sensitive_dynamic_properties(self): - """ - Gets the supports_sensitive_dynamic_properties of this Extension. - - :return: The supports_sensitive_dynamic_properties of this Extension. - :rtype: bool - """ - return self._supports_sensitive_dynamic_properties - - @supports_sensitive_dynamic_properties.setter - def supports_sensitive_dynamic_properties(self, supports_sensitive_dynamic_properties): - """ - Sets the supports_sensitive_dynamic_properties of this Extension. - - :param supports_sensitive_dynamic_properties: The supports_sensitive_dynamic_properties of this Extension. - :type: bool - """ - - self._supports_sensitive_dynamic_properties = supports_sensitive_dynamic_properties - @property def dynamic_properties(self): """ @@ -363,34 +284,10 @@ def dynamic_properties(self, dynamic_properties): self._dynamic_properties = dynamic_properties - @property - def relationships(self): - """ - Gets the relationships of this Extension. - The relationships of the extension - - :return: The relationships of this Extension. - :rtype: list[Relationship] - """ - return self._relationships - - @relationships.setter - def relationships(self, relationships): - """ - Sets the relationships of this Extension. - The relationships of the extension - - :param relationships: The relationships of this Extension. - :type: list[Relationship] - """ - - self._relationships = relationships - @property def dynamic_relationship(self): """ Gets the dynamic_relationship of this Extension. - The dynamic relationships of the extension :return: The dynamic_relationship of this Extension. :rtype: DynamicRelationship @@ -401,7 +298,6 @@ def dynamic_relationship(self): def dynamic_relationship(self, dynamic_relationship): """ Sets the dynamic_relationship of this Extension. - The dynamic relationships of the extension :param dynamic_relationship: The dynamic_relationship of this Extension. :type: DynamicRelationship @@ -410,148 +306,217 @@ def dynamic_relationship(self, dynamic_relationship): self._dynamic_relationship = dynamic_relationship @property - def reads_attributes(self): + def input_requirement(self): """ - Gets the reads_attributes of this Extension. - The attributes read from flow files by the extension + Gets the input_requirement of this Extension. + The input requirement of the extension - :return: The reads_attributes of this Extension. - :rtype: list[Attribute] + :return: The input_requirement of this Extension. + :rtype: str """ - return self._reads_attributes + return self._input_requirement - @reads_attributes.setter - def reads_attributes(self, reads_attributes): + @input_requirement.setter + def input_requirement(self, input_requirement): """ - Sets the reads_attributes of this Extension. - The attributes read from flow files by the extension + Sets the input_requirement of this Extension. + The input requirement of the extension - :param reads_attributes: The reads_attributes of this Extension. - :type: list[Attribute] + :param input_requirement: The input_requirement of this Extension. + :type: str """ + allowed_values = ["INPUT_REQUIRED", "INPUT_ALLOWED", "INPUT_FORBIDDEN", ] + if input_requirement not in allowed_values: + raise ValueError( + "Invalid value for `input_requirement` ({0}), must be one of {1}" + .format(input_requirement, allowed_values) + ) - self._reads_attributes = reads_attributes + self._input_requirement = input_requirement @property - def writes_attributes(self): + def multi_processor_use_cases(self): """ - Gets the writes_attributes of this Extension. - The attributes written to flow files by the extension + Gets the multi_processor_use_cases of this Extension. + Zero or more documented use cases for how the processor may be used in conjunction with other processors - :return: The writes_attributes of this Extension. - :rtype: list[Attribute] + :return: The multi_processor_use_cases of this Extension. + :rtype: list[MultiProcessorUseCase] """ - return self._writes_attributes + return self._multi_processor_use_cases - @writes_attributes.setter - def writes_attributes(self, writes_attributes): + @multi_processor_use_cases.setter + def multi_processor_use_cases(self, multi_processor_use_cases): """ - Sets the writes_attributes of this Extension. - The attributes written to flow files by the extension + Sets the multi_processor_use_cases of this Extension. + Zero or more documented use cases for how the processor may be used in conjunction with other processors - :param writes_attributes: The writes_attributes of this Extension. - :type: list[Attribute] + :param multi_processor_use_cases: The multi_processor_use_cases of this Extension. + :type: list[MultiProcessorUseCase] """ - self._writes_attributes = writes_attributes + self._multi_processor_use_cases = multi_processor_use_cases @property - def stateful(self): + def name(self): """ - Gets the stateful of this Extension. - The information about how the extension stores state + Gets the name of this Extension. + The name of the extension - :return: The stateful of this Extension. - :rtype: Stateful + :return: The name of this Extension. + :rtype: str """ - return self._stateful + return self._name - @stateful.setter - def stateful(self, stateful): + @name.setter + def name(self, name): """ - Sets the stateful of this Extension. - The information about how the extension stores state + Sets the name of this Extension. + The name of the extension - :param stateful: The stateful of this Extension. - :type: Stateful + :param name: The name of this Extension. + :type: str """ + if name is None: + raise ValueError("Invalid value for `name`, must not be `None`") - self._stateful = stateful + self._name = name @property - def restricted(self): + def primary_node_only(self): """ - Gets the restricted of this Extension. - The restrictions of the extension + Gets the primary_node_only of this Extension. + Indicates that a processor should be scheduled only on the primary node - :return: The restricted of this Extension. - :rtype: Restricted + :return: The primary_node_only of this Extension. + :rtype: bool """ - return self._restricted + return self._primary_node_only - @restricted.setter - def restricted(self, restricted): + @primary_node_only.setter + def primary_node_only(self, primary_node_only): """ - Sets the restricted of this Extension. - The restrictions of the extension + Sets the primary_node_only of this Extension. + Indicates that a processor should be scheduled only on the primary node - :param restricted: The restricted of this Extension. - :type: Restricted + :param primary_node_only: The primary_node_only of this Extension. + :type: bool """ - self._restricted = restricted + self._primary_node_only = primary_node_only @property - def input_requirement(self): + def properties(self): """ - Gets the input_requirement of this Extension. - The input requirement of the extension + Gets the properties of this Extension. + The properties of the extension - :return: The input_requirement of this Extension. - :rtype: str + :return: The properties of this Extension. + :rtype: list[ModelProperty] """ - return self._input_requirement + return self._properties - @input_requirement.setter - def input_requirement(self, input_requirement): + @properties.setter + def properties(self, properties): """ - Sets the input_requirement of this Extension. - The input requirement of the extension + Sets the properties of this Extension. + The properties of the extension - :param input_requirement: The input_requirement of this Extension. - :type: str + :param properties: The properties of this Extension. + :type: list[ModelProperty] """ - 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 + self._properties = properties @property - def system_resource_considerations(self): + def provided_service_apis(self): """ - Gets the system_resource_considerations of this Extension. - The resource considerations of the extension + Gets the provided_service_apis of this Extension. + The service APIs provided by this extension - :return: The system_resource_considerations of this Extension. - :rtype: list[SystemResourceConsideration] + :return: The provided_service_apis of this Extension. + :rtype: list[ProvidedServiceAPI] """ - return self._system_resource_considerations + return self._provided_service_apis - @system_resource_considerations.setter - def system_resource_considerations(self, system_resource_considerations): + @provided_service_apis.setter + def provided_service_apis(self, provided_service_apis): """ - Sets the system_resource_considerations of this Extension. - The resource considerations of the extension + Sets the provided_service_apis of this Extension. + The service APIs provided by this extension - :param system_resource_considerations: The system_resource_considerations of this Extension. - :type: list[SystemResourceConsideration] + :param provided_service_apis: The provided_service_apis of this Extension. + :type: list[ProvidedServiceAPI] """ - self._system_resource_considerations = system_resource_considerations + self._provided_service_apis = provided_service_apis + + @property + def reads_attributes(self): + """ + Gets the reads_attributes of this Extension. + The attributes read from flow files by the extension + + :return: The reads_attributes of this Extension. + :rtype: list[Attribute] + """ + return self._reads_attributes + + @reads_attributes.setter + def reads_attributes(self, reads_attributes): + """ + Sets the reads_attributes of this Extension. + The attributes read from flow files by the extension + + :param reads_attributes: The reads_attributes of this Extension. + :type: list[Attribute] + """ + + self._reads_attributes = reads_attributes + + @property + def relationships(self): + """ + Gets the relationships of this Extension. + The relationships of the extension + + :return: The relationships of this Extension. + :rtype: list[Relationship] + """ + return self._relationships + + @relationships.setter + def relationships(self, relationships): + """ + Sets the relationships of this Extension. + The relationships of the extension + + :param relationships: The relationships of this Extension. + :type: list[Relationship] + """ + + self._relationships = relationships + + @property + def restricted(self): + """ + Gets the restricted of this Extension. + + :return: The restricted of this Extension. + :rtype: Restricted + """ + return self._restricted + + @restricted.setter + def restricted(self, restricted): + """ + Sets the restricted of this Extension. + + :param restricted: The restricted of this Extension. + :type: Restricted + """ + + self._restricted = restricted @property def see_also(self): @@ -577,119 +542,161 @@ def see_also(self, see_also): self._see_also = see_also @property - def provided_service_apis(self): + def side_effect_free(self): """ - Gets the provided_service_apis of this Extension. - The service APIs provided by this extension + Gets the side_effect_free of this Extension. + Indicates that a processor is side effect free - :return: The provided_service_apis of this Extension. - :rtype: list[ProvidedServiceAPI] + :return: The side_effect_free of this Extension. + :rtype: bool """ - return self._provided_service_apis + return self._side_effect_free - @provided_service_apis.setter - def provided_service_apis(self, provided_service_apis): + @side_effect_free.setter + def side_effect_free(self, side_effect_free): """ - Sets the provided_service_apis of this Extension. - The service APIs provided by this extension + Sets the side_effect_free of this Extension. + Indicates that a processor is side effect free - :param provided_service_apis: The provided_service_apis of this Extension. - :type: list[ProvidedServiceAPI] + :param side_effect_free: The side_effect_free of this Extension. + :type: bool """ - self._provided_service_apis = provided_service_apis + self._side_effect_free = side_effect_free @property - def default_settings(self): + def stateful(self): """ - Gets the default_settings of this Extension. - The default settings for a processor + Gets the stateful of this Extension. - :return: The default_settings of this Extension. - :rtype: DefaultSettings + :return: The stateful of this Extension. + :rtype: Stateful """ - return self._default_settings + return self._stateful - @default_settings.setter - def default_settings(self, default_settings): + @stateful.setter + def stateful(self, stateful): """ - Sets the default_settings of this Extension. - The default settings for a processor + Sets the stateful of this Extension. - :param default_settings: The default_settings of this Extension. - :type: DefaultSettings + :param stateful: The stateful of this Extension. + :type: Stateful """ - self._default_settings = default_settings + self._stateful = stateful @property - def default_schedule(self): + def supports_batching(self): """ - Gets the default_schedule of this Extension. - The default schedule for a processor reporting task + Gets the supports_batching of this Extension. + Indicates that a processor supports batching - :return: The default_schedule of this Extension. - :rtype: DefaultSchedule + :return: The supports_batching of this Extension. + :rtype: bool """ - return self._default_schedule + return self._supports_batching - @default_schedule.setter - def default_schedule(self, default_schedule): + @supports_batching.setter + def supports_batching(self, supports_batching): """ - Sets the default_schedule of this Extension. - The default schedule for a processor reporting task + Sets the supports_batching of this Extension. + Indicates that a processor supports batching - :param default_schedule: The default_schedule of this Extension. - :type: DefaultSchedule + :param supports_batching: The supports_batching of this Extension. + :type: bool """ - self._default_schedule = default_schedule + self._supports_batching = supports_batching @property - def trigger_serially(self): + def supports_sensitive_dynamic_properties(self): """ - Gets the trigger_serially of this Extension. - Indicates that a processor should be triggered serially + Gets the supports_sensitive_dynamic_properties of this Extension. - :return: The trigger_serially of this Extension. + :return: The supports_sensitive_dynamic_properties of this Extension. :rtype: bool """ - return self._trigger_serially + return self._supports_sensitive_dynamic_properties - @trigger_serially.setter - def trigger_serially(self, trigger_serially): + @supports_sensitive_dynamic_properties.setter + def supports_sensitive_dynamic_properties(self, supports_sensitive_dynamic_properties): """ - Sets the trigger_serially of this Extension. - Indicates that a processor should be triggered serially + Sets the supports_sensitive_dynamic_properties of this Extension. - :param trigger_serially: The trigger_serially of this Extension. + :param supports_sensitive_dynamic_properties: The supports_sensitive_dynamic_properties of this Extension. :type: bool """ - self._trigger_serially = trigger_serially + self._supports_sensitive_dynamic_properties = supports_sensitive_dynamic_properties @property - def trigger_when_empty(self): + def system_resource_considerations(self): """ - Gets the trigger_when_empty of this Extension. - Indicates that a processor should be triggered when the incoming queues are empty + Gets the system_resource_considerations of this Extension. + The resource considerations of the extension - :return: The trigger_when_empty of this Extension. + :return: The system_resource_considerations of this Extension. + :rtype: list[SystemResourceConsideration] + """ + return self._system_resource_considerations + + @system_resource_considerations.setter + def system_resource_considerations(self, system_resource_considerations): + """ + Sets the system_resource_considerations of this Extension. + The resource considerations of the extension + + :param system_resource_considerations: The system_resource_considerations of this Extension. + :type: list[SystemResourceConsideration] + """ + + self._system_resource_considerations = system_resource_considerations + + @property + def tags(self): + """ + Gets the tags of this Extension. + The tags of the extension + + :return: The tags of this Extension. + :rtype: list[str] + """ + return self._tags + + @tags.setter + def tags(self, tags): + """ + Sets the tags of this Extension. + The tags of the extension + + :param tags: The tags of this Extension. + :type: list[str] + """ + + self._tags = tags + + @property + def trigger_serially(self): + """ + Gets the trigger_serially of this Extension. + Indicates that a processor should be triggered serially + + :return: The trigger_serially of this Extension. :rtype: bool """ - return self._trigger_when_empty + return self._trigger_serially - @trigger_when_empty.setter - def trigger_when_empty(self, trigger_when_empty): + @trigger_serially.setter + def trigger_serially(self, trigger_serially): """ - Sets the trigger_when_empty of this Extension. - Indicates that a processor should be triggered when the incoming queues are empty + Sets the trigger_serially of this Extension. + Indicates that a processor should be triggered serially - :param trigger_when_empty: The trigger_when_empty of this Extension. + :param trigger_serially: The trigger_serially of this Extension. :type: bool """ - self._trigger_when_empty = trigger_when_empty + self._trigger_serially = trigger_serially @property def trigger_when_any_destination_available(self): @@ -715,96 +722,104 @@ def trigger_when_any_destination_available(self, trigger_when_any_destination_av self._trigger_when_any_destination_available = trigger_when_any_destination_available @property - def supports_batching(self): + def trigger_when_empty(self): """ - Gets the supports_batching of this Extension. - Indicates that a processor supports batching + Gets the trigger_when_empty of this Extension. + Indicates that a processor should be triggered when the incoming queues are empty - :return: The supports_batching of this Extension. + :return: The trigger_when_empty of this Extension. :rtype: bool """ - return self._supports_batching + return self._trigger_when_empty - @supports_batching.setter - def supports_batching(self, supports_batching): + @trigger_when_empty.setter + def trigger_when_empty(self, trigger_when_empty): """ - Sets the supports_batching of this Extension. - Indicates that a processor supports batching + Sets the trigger_when_empty of this Extension. + Indicates that a processor should be triggered when the incoming queues are empty - :param supports_batching: The supports_batching of this Extension. + :param trigger_when_empty: The trigger_when_empty of this Extension. :type: bool """ - self._supports_batching = supports_batching + self._trigger_when_empty = trigger_when_empty @property - def event_driven(self): + def type(self): """ - Gets the event_driven of this Extension. - Indicates that a processor supports event driven scheduling + Gets the type of this Extension. + The type of the extension - :return: The event_driven of this Extension. - :rtype: bool + :return: The type of this Extension. + :rtype: str """ - return self._event_driven + return self._type - @event_driven.setter - def event_driven(self, event_driven): + @type.setter + def type(self, type): """ - Sets the event_driven of this Extension. - Indicates that a processor supports event driven scheduling + Sets the type of this Extension. + The type of the extension - :param event_driven: The event_driven of this Extension. - :type: bool + :param type: The type of this Extension. + :type: str """ + 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", ] + if type not in allowed_values: + raise ValueError( + "Invalid value for `type` ({0}), must be one of {1}" + .format(type, allowed_values) + ) - self._event_driven = event_driven + self._type = type @property - def primary_node_only(self): + def use_cases(self): """ - Gets the primary_node_only of this Extension. - Indicates that a processor should be scheduled only on the primary node + Gets the use_cases of this Extension. + Zero or more documented use cases for how the extension may be used - :return: The primary_node_only of this Extension. - :rtype: bool + :return: The use_cases of this Extension. + :rtype: list[UseCase] """ - return self._primary_node_only + return self._use_cases - @primary_node_only.setter - def primary_node_only(self, primary_node_only): + @use_cases.setter + def use_cases(self, use_cases): """ - Sets the primary_node_only of this Extension. - Indicates that a processor should be scheduled only on the primary node + Sets the use_cases of this Extension. + Zero or more documented use cases for how the extension may be used - :param primary_node_only: The primary_node_only of this Extension. - :type: bool + :param use_cases: The use_cases of this Extension. + :type: list[UseCase] """ - self._primary_node_only = primary_node_only + self._use_cases = use_cases @property - def side_effect_free(self): + def writes_attributes(self): """ - Gets the side_effect_free of this Extension. - Indicates that a processor is side effect free + Gets the writes_attributes of this Extension. + The attributes written to flow files by the extension - :return: The side_effect_free of this Extension. - :rtype: bool + :return: The writes_attributes of this Extension. + :rtype: list[Attribute] """ - return self._side_effect_free + return self._writes_attributes - @side_effect_free.setter - def side_effect_free(self, side_effect_free): + @writes_attributes.setter + def writes_attributes(self, writes_attributes): """ - Sets the side_effect_free of this Extension. - Indicates that a processor is side effect free + Sets the writes_attributes of this Extension. + The attributes written to flow files by the extension - :param side_effect_free: The side_effect_free of this Extension. - :type: bool + :param writes_attributes: The writes_attributes of this Extension. + :type: list[Attribute] """ - self._side_effect_free = side_effect_free + self._writes_attributes = writes_attributes def to_dict(self): """ diff --git a/nipyapi/registry/models/extension_bundle.py b/nipyapi/registry/models/extension_bundle.py deleted file mode 100644 index 2772cd3c..00000000 --- a/nipyapi/registry/models/extension_bundle.py +++ /dev/null @@ -1,508 +0,0 @@ -""" - Apache NiFi Registry REST API - - The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components. - - OpenAPI spec version: 1.28.1 - Contact: dev@nifi.apache.org - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - - -from pprint import pformat -import re - - -class ExtensionBundle(object): - """ - NOTE: This class is auto generated by the swagger code generator program. - Do not edit the class manually. - """ - - - """ - Attributes: - swagger_types (dict): The key is attribute name - and the value is attribute type. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - """ - swagger_types = { - 'link': 'JaxbLink', - 'identifier': 'str', - 'name': 'str', - 'description': 'str', - 'bucket_identifier': 'str', - 'bucket_name': 'str', - 'created_timestamp': 'int', - 'modified_timestamp': 'int', - 'type': 'str', - 'permissions': 'Permissions', - 'bundle_type': 'str', - 'group_id': 'str', - 'artifact_id': 'str', - 'version_count': 'int' - } - - attribute_map = { - 'link': 'link', - 'identifier': 'identifier', - 'name': 'name', - 'description': 'description', - 'bucket_identifier': 'bucketIdentifier', - 'bucket_name': 'bucketName', - 'created_timestamp': 'createdTimestamp', - 'modified_timestamp': 'modifiedTimestamp', - 'type': 'type', - 'permissions': 'permissions', - 'bundle_type': 'bundleType', - 'group_id': 'groupId', - 'artifact_id': 'artifactId', - 'version_count': 'versionCount' - } - - def __init__(self, link=None, identifier=None, name=None, description=None, bucket_identifier=None, bucket_name=None, created_timestamp=None, modified_timestamp=None, type=None, permissions=None, bundle_type=None, group_id=None, artifact_id=None, version_count=None): - """ - ExtensionBundle - a model defined in Swagger - """ - - self._link = None - self._identifier = None - self._name = None - self._description = None - self._bucket_identifier = None - self._bucket_name = None - self._created_timestamp = None - self._modified_timestamp = None - self._type = None - self._permissions = None - self._bundle_type = None - self._group_id = None - self._artifact_id = None - self._version_count = None - - if link is not None: - self.link = link - if identifier is not None: - self.identifier = identifier - self.name = name - if description is not None: - self.description = description - self.bucket_identifier = bucket_identifier - if bucket_name is not None: - self.bucket_name = bucket_name - if created_timestamp is not None: - self.created_timestamp = created_timestamp - if modified_timestamp is not None: - self.modified_timestamp = modified_timestamp - self.type = type - if permissions is not None: - self.permissions = permissions - self.bundle_type = bundle_type - if group_id is not None: - self.group_id = group_id - if artifact_id is not None: - self.artifact_id = artifact_id - if version_count is not None: - self.version_count = version_count - - @property - def link(self): - """ - Gets the link of this ExtensionBundle. - An WebLink to this entity. - - :return: The link of this ExtensionBundle. - :rtype: JaxbLink - """ - return self._link - - @link.setter - def link(self, link): - """ - Sets the link of this ExtensionBundle. - An WebLink to this entity. - - :param link: The link of this ExtensionBundle. - :type: JaxbLink - """ - - self._link = link - - @property - def identifier(self): - """ - Gets the identifier of this ExtensionBundle. - An ID to uniquely identify this object. - - :return: The identifier of this ExtensionBundle. - :rtype: str - """ - return self._identifier - - @identifier.setter - def identifier(self, identifier): - """ - Sets the identifier of this ExtensionBundle. - An ID to uniquely identify this object. - - :param identifier: The identifier of this ExtensionBundle. - :type: str - """ - - self._identifier = identifier - - @property - def name(self): - """ - Gets the name of this ExtensionBundle. - The name of the item. - - :return: The name of this ExtensionBundle. - :rtype: str - """ - return self._name - - @name.setter - def name(self, name): - """ - Sets the name of this ExtensionBundle. - The name of the item. - - :param name: The name of this ExtensionBundle. - :type: str - """ - if name is None: - raise ValueError("Invalid value for `name`, must not be `None`") - - self._name = name - - @property - def description(self): - """ - Gets the description of this ExtensionBundle. - A description of the item. - - :return: The description of this ExtensionBundle. - :rtype: str - """ - return self._description - - @description.setter - def description(self, description): - """ - Sets the description of this ExtensionBundle. - A description of the item. - - :param description: The description of this ExtensionBundle. - :type: str - """ - - self._description = description - - @property - def bucket_identifier(self): - """ - Gets the bucket_identifier of this ExtensionBundle. - The identifier of the bucket this items belongs to. This cannot be changed after the item is created. - - :return: The bucket_identifier of this ExtensionBundle. - :rtype: str - """ - return self._bucket_identifier - - @bucket_identifier.setter - def bucket_identifier(self, bucket_identifier): - """ - Sets the bucket_identifier of this ExtensionBundle. - The identifier of the bucket this items belongs to. This cannot be changed after the item is created. - - :param bucket_identifier: The bucket_identifier of this ExtensionBundle. - :type: str - """ - if bucket_identifier is None: - raise ValueError("Invalid value for `bucket_identifier`, must not be `None`") - - self._bucket_identifier = bucket_identifier - - @property - def bucket_name(self): - """ - Gets the bucket_name of this ExtensionBundle. - The name of the bucket this items belongs to. - - :return: The bucket_name of this ExtensionBundle. - :rtype: str - """ - return self._bucket_name - - @bucket_name.setter - def bucket_name(self, bucket_name): - """ - Sets the bucket_name of this ExtensionBundle. - The name of the bucket this items belongs to. - - :param bucket_name: The bucket_name of this ExtensionBundle. - :type: str - """ - - self._bucket_name = bucket_name - - @property - def created_timestamp(self): - """ - Gets the created_timestamp of this ExtensionBundle. - The timestamp of when the item was created, as milliseconds since epoch. - - :return: The created_timestamp of this ExtensionBundle. - :rtype: int - """ - return self._created_timestamp - - @created_timestamp.setter - def created_timestamp(self, created_timestamp): - """ - Sets the created_timestamp of this ExtensionBundle. - The timestamp of when the item was created, as milliseconds since epoch. - - :param created_timestamp: The created_timestamp of this ExtensionBundle. - :type: int - """ - if created_timestamp is not None and created_timestamp < 1: - raise ValueError("Invalid value for `created_timestamp`, must be a value greater than or equal to `1`") - - self._created_timestamp = created_timestamp - - @property - def modified_timestamp(self): - """ - Gets the modified_timestamp of this ExtensionBundle. - The timestamp of when the item was last modified, as milliseconds since epoch. - - :return: The modified_timestamp of this ExtensionBundle. - :rtype: int - """ - return self._modified_timestamp - - @modified_timestamp.setter - def modified_timestamp(self, modified_timestamp): - """ - Sets the modified_timestamp of this ExtensionBundle. - The timestamp of when the item was last modified, as milliseconds since epoch. - - :param modified_timestamp: The modified_timestamp of this ExtensionBundle. - :type: int - """ - if modified_timestamp is not None and modified_timestamp < 1: - raise ValueError("Invalid value for `modified_timestamp`, must be a value greater than or equal to `1`") - - self._modified_timestamp = modified_timestamp - - @property - def type(self): - """ - Gets the type of this ExtensionBundle. - The type of item. - - :return: The type of this ExtensionBundle. - :rtype: str - """ - return self._type - - @type.setter - def type(self, type): - """ - Sets the type of this ExtensionBundle. - The type of item. - - :param type: The type of this ExtensionBundle. - :type: str - """ - if type is None: - raise ValueError("Invalid value for `type`, must not be `None`") - allowed_values = ["Flow", "Bundle"] - if type not in allowed_values: - raise ValueError( - "Invalid value for `type` ({0}), must be one of {1}" - .format(type, allowed_values) - ) - - self._type = type - - @property - def permissions(self): - """ - Gets the permissions of this ExtensionBundle. - The access that the current user has to the bucket containing this item. - - :return: The permissions of this ExtensionBundle. - :rtype: Permissions - """ - return self._permissions - - @permissions.setter - def permissions(self, permissions): - """ - Sets the permissions of this ExtensionBundle. - The access that the current user has to the bucket containing this item. - - :param permissions: The permissions of this ExtensionBundle. - :type: Permissions - """ - - self._permissions = permissions - - @property - def bundle_type(self): - """ - Gets the bundle_type of this ExtensionBundle. - The type of the extension bundle - - :return: The bundle_type of this ExtensionBundle. - :rtype: str - """ - return self._bundle_type - - @bundle_type.setter - def bundle_type(self, bundle_type): - """ - Sets the bundle_type of this ExtensionBundle. - The type of the extension bundle - - :param bundle_type: The bundle_type of this ExtensionBundle. - :type: str - """ - if bundle_type is None: - raise ValueError("Invalid value for `bundle_type`, must not be `None`") - allowed_values = ["NIFI_NAR", "MINIFI_CPP"] - if bundle_type not in allowed_values: - raise ValueError( - "Invalid value for `bundle_type` ({0}), must be one of {1}" - .format(bundle_type, allowed_values) - ) - - self._bundle_type = bundle_type - - @property - def group_id(self): - """ - Gets the group_id of this ExtensionBundle. - The group id of the extension bundle - - :return: The group_id of this ExtensionBundle. - :rtype: str - """ - return self._group_id - - @group_id.setter - def group_id(self, group_id): - """ - Sets the group_id of this ExtensionBundle. - The group id of the extension bundle - - :param group_id: The group_id of this ExtensionBundle. - :type: str - """ - - self._group_id = group_id - - @property - def artifact_id(self): - """ - Gets the artifact_id of this ExtensionBundle. - The artifact id of the extension bundle - - :return: The artifact_id of this ExtensionBundle. - :rtype: str - """ - return self._artifact_id - - @artifact_id.setter - def artifact_id(self, artifact_id): - """ - Sets the artifact_id of this ExtensionBundle. - The artifact id of the extension bundle - - :param artifact_id: The artifact_id of this ExtensionBundle. - :type: str - """ - - self._artifact_id = artifact_id - - @property - def version_count(self): - """ - Gets the version_count of this ExtensionBundle. - The number of versions of this extension bundle. - - :return: The version_count of this ExtensionBundle. - :rtype: int - """ - return self._version_count - - @version_count.setter - def version_count(self, version_count): - """ - Sets the version_count of this ExtensionBundle. - The number of versions of this extension bundle. - - :param version_count: The version_count of this ExtensionBundle. - :type: int - """ - if version_count is not None and version_count < 0: - raise ValueError("Invalid value for `version_count`, must be a value greater than or equal to `0`") - - self._version_count = version_count - - def to_dict(self): - """ - Returns the model properties as a dict - """ - result = {} - - for attr, _ in 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, ExtensionBundle): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other): - """ - Returns true if both objects are not equal - """ - return not self == other diff --git a/nipyapi/registry/models/extension_filter_params.py b/nipyapi/registry/models/extension_filter_params.py index 8e260620..500a3b4e 100644 --- a/nipyapi/registry/models/extension_filter_params.py +++ b/nipyapi/registry/models/extension_filter_params.py @@ -1,14 +1,13 @@ """ Apache NiFi Registry REST API - The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components. + REST API definition for Apache NiFi Registry web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -29,15 +28,13 @@ class ExtensionFilterParams(object): """ swagger_types = { 'bundle_type': 'str', - 'extension_type': 'str', - 'tags': 'list[str]' - } +'extension_type': 'str', +'tags': 'list[str]' } attribute_map = { 'bundle_type': 'bundleType', - 'extension_type': 'extensionType', - 'tags': 'tags' - } +'extension_type': 'extensionType', +'tags': 'tags' } def __init__(self, bundle_type=None, extension_type=None, tags=None): """ @@ -75,7 +72,7 @@ def bundle_type(self, bundle_type): :param bundle_type: The bundle_type of this ExtensionFilterParams. :type: str """ - allowed_values = ["NIFI_NAR", "MINIFI_CPP"] + 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}" @@ -104,7 +101,7 @@ def extension_type(self, extension_type): :param extension_type: The extension_type of this ExtensionFilterParams. :type: str """ - allowed_values = ["PROCESSOR", "CONTROLLER_SERVICE", "REPORTING_TASK"] + allowed_values = ["PROCESSOR", "CONTROLLER_SERVICE", "REPORTING_TASK", "FLOW_ANALYSIS_RULE", "PARAMETER_PROVIDER", ] if extension_type not in allowed_values: raise ValueError( "Invalid value for `extension_type` ({0}), must be one of {1}" diff --git a/nipyapi/registry/models/extension_metadata.py b/nipyapi/registry/models/extension_metadata.py index 659def00..26e21fb6 100644 --- a/nipyapi/registry/models/extension_metadata.py +++ b/nipyapi/registry/models/extension_metadata.py @@ -1,14 +1,13 @@ """ Apache NiFi Registry REST API - The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components. + REST API definition for Apache NiFi Registry web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,123 +27,140 @@ class ExtensionMetadata(object): and the value is json key in definition. """ swagger_types = { - 'link': 'JaxbLink', - 'name': 'str', - 'display_name': 'str', - 'type': 'str', - 'description': 'str', - 'deprecation_notice': 'DeprecationNotice', - 'tags': 'list[str]', - 'restricted': 'Restricted', - 'provided_service_apis': 'list[ProvidedServiceAPI]', 'bundle_info': 'BundleInfo', - 'has_additional_details': 'bool', - 'link_docs': 'JaxbLink' - } +'deprecation_notice': 'DeprecationNotice', +'description': 'str', +'display_name': 'str', +'has_additional_details': 'bool', +'link': 'Link', +'link_docs': 'Link', +'name': 'str', +'provided_service_apis': 'list[ProvidedServiceAPI]', +'restricted': 'Restricted', +'tags': 'list[str]', +'type': 'str' } attribute_map = { - 'link': 'link', - 'name': 'name', - 'display_name': 'displayName', - 'type': 'type', - 'description': 'description', - 'deprecation_notice': 'deprecationNotice', - 'tags': 'tags', - 'restricted': 'restricted', - 'provided_service_apis': 'providedServiceAPIs', 'bundle_info': 'bundleInfo', - 'has_additional_details': 'hasAdditionalDetails', - 'link_docs': 'linkDocs' - } - - def __init__(self, link=None, name=None, display_name=None, type=None, description=None, deprecation_notice=None, tags=None, restricted=None, provided_service_apis=None, bundle_info=None, has_additional_details=None, link_docs=None): +'deprecation_notice': 'deprecationNotice', +'description': 'description', +'display_name': 'displayName', +'has_additional_details': 'hasAdditionalDetails', +'link': 'link', +'link_docs': 'linkDocs', +'name': 'name', +'provided_service_apis': 'providedServiceAPIs', +'restricted': 'restricted', +'tags': 'tags', +'type': 'type' } + + def __init__(self, bundle_info=None, deprecation_notice=None, description=None, display_name=None, has_additional_details=None, link=None, link_docs=None, name=None, provided_service_apis=None, restricted=None, tags=None, type=None): """ ExtensionMetadata - a model defined in Swagger """ - self._link = None - self._name = None - self._display_name = None - self._type = None - self._description = None - self._deprecation_notice = None - self._tags = None - self._restricted = None - self._provided_service_apis = None self._bundle_info = None + self._deprecation_notice = None + self._description = None + self._display_name = None self._has_additional_details = None + self._link = None self._link_docs = None + self._name = None + self._provided_service_apis = None + self._restricted = None + self._tags = None + self._type = None - if link is not None: - self.link = link - if name is not None: - self.name = name - if display_name is not None: - self.display_name = display_name - if type is not None: - self.type = type - if description is not None: - self.description = description - if deprecation_notice is not None: - self.deprecation_notice = deprecation_notice - if tags is not None: - self.tags = tags - if restricted is not None: - self.restricted = restricted - if provided_service_apis is not None: - self.provided_service_apis = provided_service_apis if bundle_info is not None: self.bundle_info = bundle_info + if deprecation_notice is not None: + self.deprecation_notice = deprecation_notice + if description is not None: + self.description = description + if display_name is not None: + self.display_name = display_name if has_additional_details is not None: self.has_additional_details = has_additional_details + if link is not None: + self.link = link if link_docs is not None: self.link_docs = link_docs + if name is not None: + self.name = name + if provided_service_apis is not None: + self.provided_service_apis = provided_service_apis + if restricted is not None: + self.restricted = restricted + if tags is not None: + self.tags = tags + if type is not None: + self.type = type @property - def link(self): + def bundle_info(self): """ - Gets the link of this ExtensionMetadata. - An WebLink to this entity. + Gets the bundle_info of this ExtensionMetadata. - :return: The link of this ExtensionMetadata. - :rtype: JaxbLink + :return: The bundle_info of this ExtensionMetadata. + :rtype: BundleInfo """ - return self._link + return self._bundle_info - @link.setter - def link(self, link): + @bundle_info.setter + def bundle_info(self, bundle_info): """ - Sets the link of this ExtensionMetadata. - An WebLink to this entity. + Sets the bundle_info of this ExtensionMetadata. - :param link: The link of this ExtensionMetadata. - :type: JaxbLink + :param bundle_info: The bundle_info of this ExtensionMetadata. + :type: BundleInfo """ - self._link = link + self._bundle_info = bundle_info @property - def name(self): + def deprecation_notice(self): """ - Gets the name of this ExtensionMetadata. - The name of the extension + Gets the deprecation_notice of this ExtensionMetadata. - :return: The name of this ExtensionMetadata. + :return: The deprecation_notice of this ExtensionMetadata. + :rtype: DeprecationNotice + """ + return self._deprecation_notice + + @deprecation_notice.setter + def deprecation_notice(self, deprecation_notice): + """ + Sets the deprecation_notice of this ExtensionMetadata. + + :param deprecation_notice: The deprecation_notice of this ExtensionMetadata. + :type: DeprecationNotice + """ + + self._deprecation_notice = deprecation_notice + + @property + def description(self): + """ + Gets the description of this ExtensionMetadata. + The description of the extension + + :return: The description of this ExtensionMetadata. :rtype: str """ - return self._name + return self._description - @name.setter - def name(self, name): + @description.setter + def description(self, description): """ - Sets the name of this ExtensionMetadata. - The name of the extension + Sets the description of this ExtensionMetadata. + The description of the extension - :param name: The name of this ExtensionMetadata. + :param description: The description of this ExtensionMetadata. :type: str """ - self._name = name + self._description = description @property def display_name(self): @@ -170,125 +186,92 @@ def display_name(self, display_name): self._display_name = display_name @property - def type(self): - """ - Gets the type of this ExtensionMetadata. - The type of the extension - - :return: The type of this ExtensionMetadata. - :rtype: str - """ - return self._type - - @type.setter - def type(self, type): - """ - Sets the type of this ExtensionMetadata. - The type of the extension - - :param type: The type of this ExtensionMetadata. - :type: str - """ - allowed_values = ["PROCESSOR", "CONTROLLER_SERVICE", "REPORTING_TASK"] - if type not in allowed_values: - raise ValueError( - "Invalid value for `type` ({0}), must be one of {1}" - .format(type, allowed_values) - ) - - self._type = type - - @property - def description(self): + def has_additional_details(self): """ - Gets the description of this ExtensionMetadata. - The description of the extension + Gets the has_additional_details of this ExtensionMetadata. + Whether or not the extension has additional detail documentation - :return: The description of this ExtensionMetadata. - :rtype: str + :return: The has_additional_details of this ExtensionMetadata. + :rtype: bool """ - return self._description + return self._has_additional_details - @description.setter - def description(self, description): + @has_additional_details.setter + def has_additional_details(self, has_additional_details): """ - Sets the description of this ExtensionMetadata. - The description of the extension + Sets the has_additional_details of this ExtensionMetadata. + Whether or not the extension has additional detail documentation - :param description: The description of this ExtensionMetadata. - :type: str + :param has_additional_details: The has_additional_details of this ExtensionMetadata. + :type: bool """ - self._description = description + self._has_additional_details = has_additional_details @property - def deprecation_notice(self): + def link(self): """ - Gets the deprecation_notice of this ExtensionMetadata. - The deprecation notice of the extension + Gets the link of this ExtensionMetadata. - :return: The deprecation_notice of this ExtensionMetadata. - :rtype: DeprecationNotice + :return: The link of this ExtensionMetadata. + :rtype: Link """ - return self._deprecation_notice + return self._link - @deprecation_notice.setter - def deprecation_notice(self, deprecation_notice): + @link.setter + def link(self, link): """ - Sets the deprecation_notice of this ExtensionMetadata. - The deprecation notice of the extension + Sets the link of this ExtensionMetadata. - :param deprecation_notice: The deprecation_notice of this ExtensionMetadata. - :type: DeprecationNotice + :param link: The link of this ExtensionMetadata. + :type: Link """ - self._deprecation_notice = deprecation_notice + self._link = link @property - def tags(self): + def link_docs(self): """ - Gets the tags of this ExtensionMetadata. - The tags of the extension + Gets the link_docs of this ExtensionMetadata. - :return: The tags of this ExtensionMetadata. - :rtype: list[str] + :return: The link_docs of this ExtensionMetadata. + :rtype: Link """ - return self._tags + return self._link_docs - @tags.setter - def tags(self, tags): + @link_docs.setter + def link_docs(self, link_docs): """ - Sets the tags of this ExtensionMetadata. - The tags of the extension + Sets the link_docs of this ExtensionMetadata. - :param tags: The tags of this ExtensionMetadata. - :type: list[str] + :param link_docs: The link_docs of this ExtensionMetadata. + :type: Link """ - self._tags = tags + self._link_docs = link_docs @property - def restricted(self): + def name(self): """ - Gets the restricted of this ExtensionMetadata. - The restrictions of the extension + Gets the name of this ExtensionMetadata. + The name of the extension - :return: The restricted of this ExtensionMetadata. - :rtype: Restricted + :return: The name of this ExtensionMetadata. + :rtype: str """ - return self._restricted + return self._name - @restricted.setter - def restricted(self, restricted): + @name.setter + def name(self, name): """ - Sets the restricted of this ExtensionMetadata. - The restrictions of the extension + Sets the name of this ExtensionMetadata. + The name of the extension - :param restricted: The restricted of this ExtensionMetadata. - :type: Restricted + :param name: The name of this ExtensionMetadata. + :type: str """ - self._restricted = restricted + self._name = name @property def provided_service_apis(self): @@ -314,73 +297,77 @@ def provided_service_apis(self, provided_service_apis): self._provided_service_apis = provided_service_apis @property - def bundle_info(self): + def restricted(self): """ - Gets the bundle_info of this ExtensionMetadata. - The information for the bundle where this extension is located + Gets the restricted of this ExtensionMetadata. - :return: The bundle_info of this ExtensionMetadata. - :rtype: BundleInfo + :return: The restricted of this ExtensionMetadata. + :rtype: Restricted """ - return self._bundle_info + return self._restricted - @bundle_info.setter - def bundle_info(self, bundle_info): + @restricted.setter + def restricted(self, restricted): """ - Sets the bundle_info of this ExtensionMetadata. - The information for the bundle where this extension is located + Sets the restricted of this ExtensionMetadata. - :param bundle_info: The bundle_info of this ExtensionMetadata. - :type: BundleInfo + :param restricted: The restricted of this ExtensionMetadata. + :type: Restricted """ - self._bundle_info = bundle_info + self._restricted = restricted @property - def has_additional_details(self): + def tags(self): """ - Gets the has_additional_details of this ExtensionMetadata. - Whether or not the extension has additional detail documentation + Gets the tags of this ExtensionMetadata. + The tags of the extension - :return: The has_additional_details of this ExtensionMetadata. - :rtype: bool + :return: The tags of this ExtensionMetadata. + :rtype: list[str] """ - return self._has_additional_details + return self._tags - @has_additional_details.setter - def has_additional_details(self, has_additional_details): + @tags.setter + def tags(self, tags): """ - Sets the has_additional_details of this ExtensionMetadata. - Whether or not the extension has additional detail documentation + Sets the tags of this ExtensionMetadata. + The tags of the extension - :param has_additional_details: The has_additional_details of this ExtensionMetadata. - :type: bool + :param tags: The tags of this ExtensionMetadata. + :type: list[str] """ - self._has_additional_details = has_additional_details + self._tags = tags @property - def link_docs(self): + def type(self): """ - Gets the link_docs of this ExtensionMetadata. - A WebLink to the documentation for this extension. + Gets the type of this ExtensionMetadata. + The type of the extension - :return: The link_docs of this ExtensionMetadata. - :rtype: JaxbLink + :return: The type of this ExtensionMetadata. + :rtype: str """ - return self._link_docs + return self._type - @link_docs.setter - def link_docs(self, link_docs): + @type.setter + def type(self, type): """ - Sets the link_docs of this ExtensionMetadata. - A WebLink to the documentation for this extension. + Sets the type of this ExtensionMetadata. + The type of the extension - :param link_docs: The link_docs of this ExtensionMetadata. - :type: JaxbLink + :param type: The type of this ExtensionMetadata. + :type: str """ + allowed_values = ["PROCESSOR", "CONTROLLER_SERVICE", "REPORTING_TASK", "FLOW_ANALYSIS_RULE", "PARAMETER_PROVIDER", ] + if type not in allowed_values: + raise ValueError( + "Invalid value for `type` ({0}), must be one of {1}" + .format(type, allowed_values) + ) - self._link_docs = link_docs + self._type = type def to_dict(self): """ diff --git a/nipyapi/registry/models/extension_metadata_container.py b/nipyapi/registry/models/extension_metadata_container.py index d8d5e870..3ad87316 100644 --- a/nipyapi/registry/models/extension_metadata_container.py +++ b/nipyapi/registry/models/extension_metadata_container.py @@ -1,14 +1,13 @@ """ Apache NiFi Registry REST API - The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components. + REST API definition for Apache NiFi Registry web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,61 +27,58 @@ class ExtensionMetadataContainer(object): and the value is json key in definition. """ swagger_types = { - 'num_results': 'int', - 'filter_params': 'ExtensionFilterParams', - 'extensions': 'list[ExtensionMetadata]' - } + 'extensions': 'list[ExtensionMetadata]', +'filter_params': 'ExtensionFilterParams', +'num_results': 'int' } attribute_map = { - 'num_results': 'numResults', - 'filter_params': 'filterParams', - 'extensions': 'extensions' - } + 'extensions': 'extensions', +'filter_params': 'filterParams', +'num_results': 'numResults' } - def __init__(self, num_results=None, filter_params=None, extensions=None): + def __init__(self, extensions=None, filter_params=None, num_results=None): """ ExtensionMetadataContainer - a model defined in Swagger """ - self._num_results = None - self._filter_params = None self._extensions = None + self._filter_params = None + self._num_results = None - if num_results is not None: - self.num_results = num_results - if filter_params is not None: - self.filter_params = filter_params if extensions is not None: self.extensions = extensions + if filter_params is not None: + self.filter_params = filter_params + if num_results is not None: + self.num_results = num_results @property - def num_results(self): + def extensions(self): """ - Gets the num_results of this ExtensionMetadataContainer. - The number of extensions in the response + Gets the extensions of this ExtensionMetadataContainer. + The metadata for the extensions - :return: The num_results of this ExtensionMetadataContainer. - :rtype: int + :return: The extensions of this ExtensionMetadataContainer. + :rtype: list[ExtensionMetadata] """ - return self._num_results + return self._extensions - @num_results.setter - def num_results(self, num_results): + @extensions.setter + def extensions(self, extensions): """ - Sets the num_results of this ExtensionMetadataContainer. - The number of extensions in the response + Sets the extensions of this ExtensionMetadataContainer. + The metadata for the extensions - :param num_results: The num_results of this ExtensionMetadataContainer. - :type: int + :param extensions: The extensions of this ExtensionMetadataContainer. + :type: list[ExtensionMetadata] """ - self._num_results = num_results + self._extensions = extensions @property def filter_params(self): """ Gets the filter_params of this ExtensionMetadataContainer. - The filter parameters submitted for the request :return: The filter_params of this ExtensionMetadataContainer. :rtype: ExtensionFilterParams @@ -93,7 +89,6 @@ def filter_params(self): def filter_params(self, filter_params): """ Sets the filter_params of this ExtensionMetadataContainer. - The filter parameters submitted for the request :param filter_params: The filter_params of this ExtensionMetadataContainer. :type: ExtensionFilterParams @@ -102,27 +97,27 @@ def filter_params(self, filter_params): self._filter_params = filter_params @property - def extensions(self): + def num_results(self): """ - Gets the extensions of this ExtensionMetadataContainer. - The metadata for the extensions + Gets the num_results of this ExtensionMetadataContainer. + The number of extensions in the response - :return: The extensions of this ExtensionMetadataContainer. - :rtype: list[ExtensionMetadata] + :return: The num_results of this ExtensionMetadataContainer. + :rtype: int """ - return self._extensions + return self._num_results - @extensions.setter - def extensions(self, extensions): + @num_results.setter + def num_results(self, num_results): """ - Sets the extensions of this ExtensionMetadataContainer. - The metadata for the extensions + Sets the num_results of this ExtensionMetadataContainer. + The number of extensions in the response - :param extensions: The extensions of this ExtensionMetadataContainer. - :type: list[ExtensionMetadata] + :param num_results: The num_results of this ExtensionMetadataContainer. + :type: int """ - self._extensions = extensions + self._num_results = num_results def to_dict(self): """ diff --git a/nipyapi/registry/models/extension_repo_artifact.py b/nipyapi/registry/models/extension_repo_artifact.py index 1d3d802e..c929616c 100644 --- a/nipyapi/registry/models/extension_repo_artifact.py +++ b/nipyapi/registry/models/extension_repo_artifact.py @@ -1,14 +1,13 @@ """ Apache NiFi Registry REST API - The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components. + REST API definition for Apache NiFi Registry web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,60 +27,58 @@ class ExtensionRepoArtifact(object): and the value is json key in definition. """ swagger_types = { - 'link': 'JaxbLink', - 'bucket_name': 'str', - 'group_id': 'str', - 'artifact_id': 'str' - } + 'artifact_id': 'str', +'bucket_name': 'str', +'group_id': 'str', +'link': 'Link' } attribute_map = { - 'link': 'link', - 'bucket_name': 'bucketName', - 'group_id': 'groupId', - 'artifact_id': 'artifactId' - } + 'artifact_id': 'artifactId', +'bucket_name': 'bucketName', +'group_id': 'groupId', +'link': 'link' } - def __init__(self, link=None, bucket_name=None, group_id=None, artifact_id=None): + def __init__(self, artifact_id=None, bucket_name=None, group_id=None, link=None): """ ExtensionRepoArtifact - a model defined in Swagger """ - self._link = None + self._artifact_id = None self._bucket_name = None self._group_id = None - self._artifact_id = None + self._link = None - if link is not None: - self.link = link + if artifact_id is not None: + self.artifact_id = artifact_id if bucket_name is not None: self.bucket_name = bucket_name if group_id is not None: self.group_id = group_id - if artifact_id is not None: - self.artifact_id = artifact_id + if link is not None: + self.link = link @property - def link(self): + def artifact_id(self): """ - Gets the link of this ExtensionRepoArtifact. - An WebLink to this entity. + Gets the artifact_id of this ExtensionRepoArtifact. + The artifact id - :return: The link of this ExtensionRepoArtifact. - :rtype: JaxbLink + :return: The artifact_id of this ExtensionRepoArtifact. + :rtype: str """ - return self._link + return self._artifact_id - @link.setter - def link(self, link): + @artifact_id.setter + def artifact_id(self, artifact_id): """ - Sets the link of this ExtensionRepoArtifact. - An WebLink to this entity. + Sets the artifact_id of this ExtensionRepoArtifact. + The artifact id - :param link: The link of this ExtensionRepoArtifact. - :type: JaxbLink + :param artifact_id: The artifact_id of this ExtensionRepoArtifact. + :type: str """ - self._link = link + self._artifact_id = artifact_id @property def bucket_name(self): @@ -130,27 +127,25 @@ def group_id(self, group_id): self._group_id = group_id @property - def artifact_id(self): + def link(self): """ - Gets the artifact_id of this ExtensionRepoArtifact. - The artifact id + Gets the link of this ExtensionRepoArtifact. - :return: The artifact_id of this ExtensionRepoArtifact. - :rtype: str + :return: The link of this ExtensionRepoArtifact. + :rtype: Link """ - return self._artifact_id + return self._link - @artifact_id.setter - def artifact_id(self, artifact_id): + @link.setter + def link(self, link): """ - Sets the artifact_id of this ExtensionRepoArtifact. - The artifact id + Sets the link of this ExtensionRepoArtifact. - :param artifact_id: The artifact_id of this ExtensionRepoArtifact. - :type: str + :param link: The link of this ExtensionRepoArtifact. + :type: Link """ - self._artifact_id = artifact_id + self._link = link def to_dict(self): """ diff --git a/nipyapi/registry/models/extension_repo_bucket.py b/nipyapi/registry/models/extension_repo_bucket.py index ccfb212f..fc1f3dfe 100644 --- a/nipyapi/registry/models/extension_repo_bucket.py +++ b/nipyapi/registry/models/extension_repo_bucket.py @@ -1,14 +1,13 @@ """ Apache NiFi Registry REST API - The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components. + REST API definition for Apache NiFi Registry web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,50 +27,25 @@ class ExtensionRepoBucket(object): and the value is json key in definition. """ swagger_types = { - 'link': 'JaxbLink', - 'bucket_name': 'str' - } + 'bucket_name': 'str', +'link': 'Link' } attribute_map = { - 'link': 'link', - 'bucket_name': 'bucketName' - } + 'bucket_name': 'bucketName', +'link': 'link' } - def __init__(self, link=None, bucket_name=None): + def __init__(self, bucket_name=None, link=None): """ ExtensionRepoBucket - a model defined in Swagger """ - self._link = None self._bucket_name = None + self._link = None - if link is not None: - self.link = link if bucket_name is not None: self.bucket_name = bucket_name - - @property - def link(self): - """ - Gets the link of this ExtensionRepoBucket. - An WebLink to this entity. - - :return: The link of this ExtensionRepoBucket. - :rtype: JaxbLink - """ - return self._link - - @link.setter - def link(self, link): - """ - Sets the link of this ExtensionRepoBucket. - An WebLink to this entity. - - :param link: The link of this ExtensionRepoBucket. - :type: JaxbLink - """ - - self._link = link + if link is not None: + self.link = link @property def bucket_name(self): @@ -96,6 +70,27 @@ def bucket_name(self, bucket_name): self._bucket_name = bucket_name + @property + def link(self): + """ + Gets the link of this ExtensionRepoBucket. + + :return: The link of this ExtensionRepoBucket. + :rtype: Link + """ + return self._link + + @link.setter + def link(self, link): + """ + Sets the link of this ExtensionRepoBucket. + + :param link: The link of this ExtensionRepoBucket. + :type: Link + """ + + self._link = link + def to_dict(self): """ Returns the model properties as a dict diff --git a/nipyapi/registry/models/extension_repo_group.py b/nipyapi/registry/models/extension_repo_group.py index 08f61aef..54793989 100644 --- a/nipyapi/registry/models/extension_repo_group.py +++ b/nipyapi/registry/models/extension_repo_group.py @@ -1,14 +1,13 @@ """ Apache NiFi Registry REST API - The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components. + REST API definition for Apache NiFi Registry web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,55 +27,30 @@ class ExtensionRepoGroup(object): and the value is json key in definition. """ swagger_types = { - 'link': 'JaxbLink', 'bucket_name': 'str', - 'group_id': 'str' - } +'group_id': 'str', +'link': 'Link' } attribute_map = { - 'link': 'link', 'bucket_name': 'bucketName', - 'group_id': 'groupId' - } +'group_id': 'groupId', +'link': 'link' } - def __init__(self, link=None, bucket_name=None, group_id=None): + def __init__(self, bucket_name=None, group_id=None, link=None): """ ExtensionRepoGroup - a model defined in Swagger """ - self._link = None self._bucket_name = None self._group_id = None + self._link = None - if link is not None: - self.link = link if bucket_name is not None: self.bucket_name = bucket_name if group_id is not None: self.group_id = group_id - - @property - def link(self): - """ - Gets the link of this ExtensionRepoGroup. - An WebLink to this entity. - - :return: The link of this ExtensionRepoGroup. - :rtype: JaxbLink - """ - return self._link - - @link.setter - def link(self, link): - """ - Sets the link of this ExtensionRepoGroup. - An WebLink to this entity. - - :param link: The link of this ExtensionRepoGroup. - :type: JaxbLink - """ - - self._link = link + if link is not None: + self.link = link @property def bucket_name(self): @@ -124,6 +98,27 @@ def group_id(self, group_id): self._group_id = group_id + @property + def link(self): + """ + Gets the link of this ExtensionRepoGroup. + + :return: The link of this ExtensionRepoGroup. + :rtype: Link + """ + return self._link + + @link.setter + def link(self, link): + """ + Sets the link of this ExtensionRepoGroup. + + :param link: The link of this ExtensionRepoGroup. + :type: Link + """ + + self._link = link + def to_dict(self): """ Returns the model properties as a dict diff --git a/nipyapi/registry/models/extension_repo_version.py b/nipyapi/registry/models/extension_repo_version.py index 36f31bb4..06dc15cb 100644 --- a/nipyapi/registry/models/extension_repo_version.py +++ b/nipyapi/registry/models/extension_repo_version.py @@ -1,14 +1,13 @@ """ Apache NiFi Registry REST API - The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components. + REST API definition for Apache NiFi Registry web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,92 +27,85 @@ class ExtensionRepoVersion(object): and the value is json key in definition. """ swagger_types = { - 'extensions_link': 'JaxbLink', - 'download_link': 'JaxbLink', - 'sha256_link': 'JaxbLink', - 'sha256_supplied': 'JaxbLink' - } + 'download_link': 'Link', +'extensions_link': 'Link', +'sha256_link': 'Link', +'sha256_supplied': 'bool' } attribute_map = { - 'extensions_link': 'extensionsLink', 'download_link': 'downloadLink', - 'sha256_link': 'sha256Link', - 'sha256_supplied': 'sha256Supplied' - } +'extensions_link': 'extensionsLink', +'sha256_link': 'sha256Link', +'sha256_supplied': 'sha256Supplied' } - def __init__(self, extensions_link=None, download_link=None, sha256_link=None, sha256_supplied=None): + def __init__(self, download_link=None, extensions_link=None, sha256_link=None, sha256_supplied=None): """ ExtensionRepoVersion - a model defined in Swagger """ - self._extensions_link = None self._download_link = None + self._extensions_link = None self._sha256_link = None self._sha256_supplied = None - if extensions_link is not None: - self.extensions_link = extensions_link if download_link is not None: self.download_link = download_link + if extensions_link is not None: + self.extensions_link = extensions_link if sha256_link is not None: self.sha256_link = sha256_link if sha256_supplied is not None: self.sha256_supplied = sha256_supplied @property - def extensions_link(self): + def download_link(self): """ - Gets the extensions_link of this ExtensionRepoVersion. - The WebLink to view the metadata about the extensions contained in the extension bundle. + Gets the download_link of this ExtensionRepoVersion. - :return: The extensions_link of this ExtensionRepoVersion. - :rtype: JaxbLink + :return: The download_link of this ExtensionRepoVersion. + :rtype: Link """ - return self._extensions_link + return self._download_link - @extensions_link.setter - def extensions_link(self, extensions_link): + @download_link.setter + def download_link(self, download_link): """ - Sets the extensions_link of this ExtensionRepoVersion. - The WebLink to view the metadata about the extensions contained in the extension bundle. + Sets the download_link of this ExtensionRepoVersion. - :param extensions_link: The extensions_link of this ExtensionRepoVersion. - :type: JaxbLink + :param download_link: The download_link of this ExtensionRepoVersion. + :type: Link """ - self._extensions_link = extensions_link + self._download_link = download_link @property - def download_link(self): + def extensions_link(self): """ - Gets the download_link of this ExtensionRepoVersion. - The WebLink to download this version of the extension bundle. + Gets the extensions_link of this ExtensionRepoVersion. - :return: The download_link of this ExtensionRepoVersion. - :rtype: JaxbLink + :return: The extensions_link of this ExtensionRepoVersion. + :rtype: Link """ - return self._download_link + return self._extensions_link - @download_link.setter - def download_link(self, download_link): + @extensions_link.setter + def extensions_link(self, extensions_link): """ - Sets the download_link of this ExtensionRepoVersion. - The WebLink to download this version of the extension bundle. + Sets the extensions_link of this ExtensionRepoVersion. - :param download_link: The download_link of this ExtensionRepoVersion. - :type: JaxbLink + :param extensions_link: The extensions_link of this ExtensionRepoVersion. + :type: Link """ - self._download_link = download_link + self._extensions_link = extensions_link @property def sha256_link(self): """ Gets the sha256_link of this ExtensionRepoVersion. - The WebLink to retrieve the SHA-256 digest for this version of the extension bundle. :return: The sha256_link of this ExtensionRepoVersion. - :rtype: JaxbLink + :rtype: Link """ return self._sha256_link @@ -121,10 +113,9 @@ def sha256_link(self): def sha256_link(self, sha256_link): """ Sets the sha256_link of this ExtensionRepoVersion. - The WebLink to retrieve the SHA-256 digest for this version of the extension bundle. :param sha256_link: The sha256_link of this ExtensionRepoVersion. - :type: JaxbLink + :type: Link """ self._sha256_link = sha256_link @@ -136,7 +127,7 @@ def sha256_supplied(self): Indicates if the client supplied a SHA-256 when uploading this version of the extension bundle. :return: The sha256_supplied of this ExtensionRepoVersion. - :rtype: JaxbLink + :rtype: bool """ return self._sha256_supplied @@ -147,7 +138,7 @@ def sha256_supplied(self, sha256_supplied): Indicates if the client supplied a SHA-256 when uploading this version of the extension bundle. :param sha256_supplied: The sha256_supplied of this ExtensionRepoVersion. - :type: JaxbLink + :type: bool """ self._sha256_supplied = sha256_supplied diff --git a/nipyapi/registry/models/extension_repo_version_summary.py b/nipyapi/registry/models/extension_repo_version_summary.py index caacc2cd..f46b669f 100644 --- a/nipyapi/registry/models/extension_repo_version_summary.py +++ b/nipyapi/registry/models/extension_repo_version_summary.py @@ -1,14 +1,13 @@ """ Apache NiFi Registry REST API - The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components. + REST API definition for Apache NiFi Registry web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,75 +27,96 @@ class ExtensionRepoVersionSummary(object): and the value is json key in definition. """ swagger_types = { - 'link': 'JaxbLink', - 'bucket_name': 'str', - 'group_id': 'str', 'artifact_id': 'str', - 'version': 'str', - 'author': 'str', - 'timestamp': 'int' - } +'author': 'str', +'bucket_name': 'str', +'group_id': 'str', +'link': 'Link', +'timestamp': 'int', +'version': 'str' } attribute_map = { - 'link': 'link', - 'bucket_name': 'bucketName', - 'group_id': 'groupId', 'artifact_id': 'artifactId', - 'version': 'version', - 'author': 'author', - 'timestamp': 'timestamp' - } +'author': 'author', +'bucket_name': 'bucketName', +'group_id': 'groupId', +'link': 'link', +'timestamp': 'timestamp', +'version': 'version' } - def __init__(self, link=None, bucket_name=None, group_id=None, artifact_id=None, version=None, author=None, timestamp=None): + def __init__(self, artifact_id=None, author=None, bucket_name=None, group_id=None, link=None, timestamp=None, version=None): """ ExtensionRepoVersionSummary - a model defined in Swagger """ - self._link = None - self._bucket_name = None - self._group_id = None self._artifact_id = None - self._version = None self._author = None + self._bucket_name = None + self._group_id = None + self._link = None self._timestamp = None + self._version = None - if link is not None: - self.link = link - if bucket_name is not None: - self.bucket_name = bucket_name - if group_id is not None: - self.group_id = group_id if artifact_id is not None: self.artifact_id = artifact_id - if version is not None: - self.version = version if author is not None: self.author = author + if bucket_name is not None: + self.bucket_name = bucket_name + if group_id is not None: + self.group_id = group_id + if link is not None: + self.link = link if timestamp is not None: self.timestamp = timestamp + if version is not None: + self.version = version @property - def link(self): + def artifact_id(self): """ - Gets the link of this ExtensionRepoVersionSummary. - An WebLink to this entity. + Gets the artifact_id of this ExtensionRepoVersionSummary. + The artifact id - :return: The link of this ExtensionRepoVersionSummary. - :rtype: JaxbLink + :return: The artifact_id of this ExtensionRepoVersionSummary. + :rtype: str """ - return self._link + return self._artifact_id - @link.setter - def link(self, link): + @artifact_id.setter + def artifact_id(self, artifact_id): """ - Sets the link of this ExtensionRepoVersionSummary. - An WebLink to this entity. + Sets the artifact_id of this ExtensionRepoVersionSummary. + The artifact id - :param link: The link of this ExtensionRepoVersionSummary. - :type: JaxbLink + :param artifact_id: The artifact_id of this ExtensionRepoVersionSummary. + :type: str """ - self._link = link + self._artifact_id = artifact_id + + @property + def author(self): + """ + Gets the author of this ExtensionRepoVersionSummary. + The identity of the user that created this version + + :return: The author of this ExtensionRepoVersionSummary. + :rtype: str + """ + return self._author + + @author.setter + def author(self, author): + """ + Sets the author of this ExtensionRepoVersionSummary. + The identity of the user that created this version + + :param author: The author of this ExtensionRepoVersionSummary. + :type: str + """ + + self._author = author @property def bucket_name(self): @@ -145,73 +165,25 @@ def group_id(self, group_id): self._group_id = group_id @property - def artifact_id(self): - """ - Gets the artifact_id of this ExtensionRepoVersionSummary. - The artifact id - - :return: The artifact_id of this ExtensionRepoVersionSummary. - :rtype: str - """ - return self._artifact_id - - @artifact_id.setter - def artifact_id(self, artifact_id): - """ - Sets the artifact_id of this ExtensionRepoVersionSummary. - The artifact id - - :param artifact_id: The artifact_id of this ExtensionRepoVersionSummary. - :type: str - """ - - self._artifact_id = artifact_id - - @property - def version(self): - """ - Gets the version of this ExtensionRepoVersionSummary. - The version - - :return: The version of this ExtensionRepoVersionSummary. - :rtype: str - """ - return self._version - - @version.setter - def version(self, version): - """ - Sets the version of this ExtensionRepoVersionSummary. - The version - - :param version: The version of this ExtensionRepoVersionSummary. - :type: str - """ - - self._version = version - - @property - def author(self): + def link(self): """ - Gets the author of this ExtensionRepoVersionSummary. - The identity of the user that created this version + Gets the link of this ExtensionRepoVersionSummary. - :return: The author of this ExtensionRepoVersionSummary. - :rtype: str + :return: The link of this ExtensionRepoVersionSummary. + :rtype: Link """ - return self._author + return self._link - @author.setter - def author(self, author): + @link.setter + def link(self, link): """ - Sets the author of this ExtensionRepoVersionSummary. - The identity of the user that created this version + Sets the link of this ExtensionRepoVersionSummary. - :param author: The author of this ExtensionRepoVersionSummary. - :type: str + :param link: The link of this ExtensionRepoVersionSummary. + :type: Link """ - self._author = author + self._link = link @property def timestamp(self): @@ -236,6 +208,29 @@ def timestamp(self, timestamp): self._timestamp = timestamp + @property + def version(self): + """ + Gets the version of this ExtensionRepoVersionSummary. + The version + + :return: The version of this ExtensionRepoVersionSummary. + :rtype: str + """ + return self._version + + @version.setter + def version(self, version): + """ + Sets the version of this ExtensionRepoVersionSummary. + The version + + :param version: The version of this ExtensionRepoVersionSummary. + :type: str + """ + + self._version = version + def to_dict(self): """ Returns the model properties as a dict diff --git a/nipyapi/registry/models/external_controller_service_reference.py b/nipyapi/registry/models/external_controller_service_reference.py index 78791b09..754beb00 100644 --- a/nipyapi/registry/models/external_controller_service_reference.py +++ b/nipyapi/registry/models/external_controller_service_reference.py @@ -1,14 +1,13 @@ """ Apache NiFi Registry REST API - The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components. + REST API definition for Apache NiFi Registry web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -29,13 +28,11 @@ class ExternalControllerServiceReference(object): """ swagger_types = { 'identifier': 'str', - 'name': 'str' - } +'name': 'str' } attribute_map = { 'identifier': 'identifier', - 'name': 'name' - } +'name': 'name' } def __init__(self, identifier=None, name=None): """ diff --git a/nipyapi/registry/models/fields.py b/nipyapi/registry/models/fields.py index 06f6c688..741187ec 100644 --- a/nipyapi/registry/models/fields.py +++ b/nipyapi/registry/models/fields.py @@ -1,14 +1,13 @@ """ Apache NiFi Registry REST API - The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components. + REST API definition for Apache NiFi Registry web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,12 +27,10 @@ class Fields(object): and the value is json key in definition. """ swagger_types = { - 'fields': 'list[str]' - } + 'fields': 'list[str]' } attribute_map = { - 'fields': 'fields' - } + 'fields': 'fields' } def __init__(self, fields=None): """ diff --git a/nipyapi/registry/models/form_data_content_disposition.py b/nipyapi/registry/models/form_data_content_disposition.py new file mode 100644 index 00000000..140e95d8 --- /dev/null +++ b/nipyapi/registry/models/form_data_content_disposition.py @@ -0,0 +1,299 @@ +""" + Apache NiFi Registry REST API + + REST API definition for Apache NiFi Registry web services + + OpenAPI spec version: 2.5.0 + Contact: dev@nifi.apache.org + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from pprint import pformat +import re + + +class FormDataContentDisposition(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 = { + 'creation_date': 'datetime', +'file_name': 'str', +'modification_date': 'datetime', +'name': 'str', +'parameters': 'dict(str, str)', +'read_date': 'datetime', +'size': 'int', +'type': 'str' } + + attribute_map = { + 'creation_date': 'creationDate', +'file_name': 'fileName', +'modification_date': 'modificationDate', +'name': 'name', +'parameters': 'parameters', +'read_date': 'readDate', +'size': 'size', +'type': 'type' } + + def __init__(self, creation_date=None, file_name=None, modification_date=None, name=None, parameters=None, read_date=None, size=None, type=None): + """ + FormDataContentDisposition - a model defined in Swagger + """ + + self._creation_date = None + self._file_name = None + self._modification_date = None + self._name = None + self._parameters = None + self._read_date = None + self._size = None + self._type = None + + if creation_date is not None: + self.creation_date = creation_date + if file_name is not None: + self.file_name = file_name + if modification_date is not None: + self.modification_date = modification_date + if name is not None: + self.name = name + if parameters is not None: + self.parameters = parameters + if read_date is not None: + self.read_date = read_date + if size is not None: + self.size = size + if type is not None: + self.type = type + + @property + def creation_date(self): + """ + Gets the creation_date of this FormDataContentDisposition. + + :return: The creation_date of this FormDataContentDisposition. + :rtype: datetime + """ + return self._creation_date + + @creation_date.setter + def creation_date(self, creation_date): + """ + Sets the creation_date of this FormDataContentDisposition. + + :param creation_date: The creation_date of this FormDataContentDisposition. + :type: datetime + """ + + self._creation_date = creation_date + + @property + def file_name(self): + """ + Gets the file_name of this FormDataContentDisposition. + + :return: The file_name of this FormDataContentDisposition. + :rtype: str + """ + return self._file_name + + @file_name.setter + def file_name(self, file_name): + """ + Sets the file_name of this FormDataContentDisposition. + + :param file_name: The file_name of this FormDataContentDisposition. + :type: str + """ + + self._file_name = file_name + + @property + def modification_date(self): + """ + Gets the modification_date of this FormDataContentDisposition. + + :return: The modification_date of this FormDataContentDisposition. + :rtype: datetime + """ + return self._modification_date + + @modification_date.setter + def modification_date(self, modification_date): + """ + Sets the modification_date of this FormDataContentDisposition. + + :param modification_date: The modification_date of this FormDataContentDisposition. + :type: datetime + """ + + self._modification_date = modification_date + + @property + def name(self): + """ + Gets the name of this FormDataContentDisposition. + + :return: The name of this FormDataContentDisposition. + :rtype: str + """ + return self._name + + @name.setter + def name(self, name): + """ + Sets the name of this FormDataContentDisposition. + + :param name: The name of this FormDataContentDisposition. + :type: str + """ + + self._name = name + + @property + def parameters(self): + """ + Gets the parameters of this FormDataContentDisposition. + + :return: The parameters of this FormDataContentDisposition. + :rtype: dict(str, str) + """ + return self._parameters + + @parameters.setter + def parameters(self, parameters): + """ + Sets the parameters of this FormDataContentDisposition. + + :param parameters: The parameters of this FormDataContentDisposition. + :type: dict(str, str) + """ + + self._parameters = parameters + + @property + def read_date(self): + """ + Gets the read_date of this FormDataContentDisposition. + + :return: The read_date of this FormDataContentDisposition. + :rtype: datetime + """ + return self._read_date + + @read_date.setter + def read_date(self, read_date): + """ + Sets the read_date of this FormDataContentDisposition. + + :param read_date: The read_date of this FormDataContentDisposition. + :type: datetime + """ + + self._read_date = read_date + + @property + def size(self): + """ + Gets the size of this FormDataContentDisposition. + + :return: The size of this FormDataContentDisposition. + :rtype: int + """ + return self._size + + @size.setter + def size(self, size): + """ + Sets the size of this FormDataContentDisposition. + + :param size: The size of this FormDataContentDisposition. + :type: int + """ + + self._size = size + + @property + def type(self): + """ + Gets the type of this FormDataContentDisposition. + + :return: The type of this FormDataContentDisposition. + :rtype: str + """ + return self._type + + @type.setter + def type(self, type): + """ + Sets the type of this FormDataContentDisposition. + + :param type: The type of this FormDataContentDisposition. + :type: str + """ + + self._type = type + + 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, FormDataContentDisposition): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """ + Returns true if both objects are not equal + """ + return not self == other diff --git a/nipyapi/registry/models/link.py b/nipyapi/registry/models/link.py new file mode 100644 index 00000000..83850e29 --- /dev/null +++ b/nipyapi/registry/models/link.py @@ -0,0 +1,273 @@ +""" + Apache NiFi Registry REST API + + REST API definition for Apache NiFi Registry web services + + OpenAPI spec version: 2.5.0 + Contact: dev@nifi.apache.org + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from pprint import pformat +import re + + +class Link(object): + """ + NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. + """ + + + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'params': 'dict(str, str)', +'rel': 'str', +'rels': 'list[str]', +'title': 'str', +'type': 'str', +'uri': 'str', +'uri_builder': 'UriBuilder' } + + attribute_map = { + 'params': 'params', +'rel': 'rel', +'rels': 'rels', +'title': 'title', +'type': 'type', +'uri': 'uri', +'uri_builder': 'uriBuilder' } + + def __init__(self, params=None, rel=None, rels=None, title=None, type=None, uri=None, uri_builder=None): + """ + Link - a model defined in Swagger + """ + + self._params = None + self._rel = None + self._rels = None + self._title = None + self._type = None + self._uri = None + self._uri_builder = None + + if params is not None: + self.params = params + if rel is not None: + self.rel = rel + if rels is not None: + self.rels = rels + if title is not None: + self.title = title + if type is not None: + self.type = type + if uri is not None: + self.uri = uri + if uri_builder is not None: + self.uri_builder = uri_builder + + @property + def params(self): + """ + Gets the params of this Link. + + :return: The params of this Link. + :rtype: dict(str, str) + """ + return self._params + + @params.setter + def params(self, params): + """ + Sets the params of this Link. + + :param params: The params of this Link. + :type: dict(str, str) + """ + + self._params = params + + @property + def rel(self): + """ + Gets the rel of this Link. + + :return: The rel of this Link. + :rtype: str + """ + return self._rel + + @rel.setter + def rel(self, rel): + """ + Sets the rel of this Link. + + :param rel: The rel of this Link. + :type: str + """ + + self._rel = rel + + @property + def rels(self): + """ + Gets the rels of this Link. + + :return: The rels of this Link. + :rtype: list[str] + """ + return self._rels + + @rels.setter + def rels(self, rels): + """ + Sets the rels of this Link. + + :param rels: The rels of this Link. + :type: list[str] + """ + + self._rels = rels + + @property + def title(self): + """ + Gets the title of this Link. + + :return: The title of this Link. + :rtype: str + """ + return self._title + + @title.setter + def title(self, title): + """ + Sets the title of this Link. + + :param title: The title of this Link. + :type: str + """ + + self._title = title + + @property + def type(self): + """ + Gets the type of this Link. + + :return: The type of this Link. + :rtype: str + """ + return self._type + + @type.setter + def type(self, type): + """ + Sets the type of this Link. + + :param type: The type of this Link. + :type: str + """ + + self._type = type + + @property + def uri(self): + """ + Gets the uri of this Link. + + :return: The uri of this Link. + :rtype: str + """ + return self._uri + + @uri.setter + def uri(self, uri): + """ + Sets the uri of this Link. + + :param uri: The uri of this Link. + :type: str + """ + + self._uri = uri + + @property + def uri_builder(self): + """ + Gets the uri_builder of this Link. + + :return: The uri_builder of this Link. + :rtype: UriBuilder + """ + return self._uri_builder + + @uri_builder.setter + def uri_builder(self, uri_builder): + """ + Sets the uri_builder of this Link. + + :param uri_builder: The uri_builder of this Link. + :type: UriBuilder + """ + + self._uri_builder = uri_builder + + 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, Link): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """ + Returns true if both objects are not equal + """ + return not self == other diff --git a/nipyapi/nifi/models/input_stream.py b/nipyapi/registry/models/long_parameter.py similarity index 70% rename from nipyapi/nifi/models/input_stream.py rename to nipyapi/registry/models/long_parameter.py index 41450e42..d0c4b092 100644 --- a/nipyapi/nifi/models/input_stream.py +++ b/nipyapi/registry/models/long_parameter.py @@ -1,19 +1,18 @@ """ - NiFi Rest API + Apache NiFi Registry REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi Registry web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re -class InputStream(object): +class LongParameter(object): """ NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually. @@ -28,19 +27,41 @@ class InputStream(object): and the value is json key in definition. """ swagger_types = { - - } + 'long': 'int' } attribute_map = { - - } + 'long': 'long' } + + def __init__(self, long=None): + """ + LongParameter - a model defined in Swagger + """ + + self._long = None - def __init__(self): + if long is not None: + self.long = long + + @property + def long(self): """ - InputStream - a model defined in Swagger + Gets the long of this LongParameter. + + :return: The long of this LongParameter. + :rtype: int """ + return self._long + @long.setter + def long(self, long): + """ + Sets the long of this LongParameter. + + :param long: The long of this LongParameter. + :type: int + """ + self._long = long def to_dict(self): """ @@ -84,7 +105,7 @@ def __eq__(self, other): """ Returns true if both objects are equal """ - if not isinstance(other, InputStream): + if not isinstance(other, LongParameter): return False return self.__dict__ == other.__dict__ diff --git a/nipyapi/registry/models/model_property.py b/nipyapi/registry/models/model_property.py index 38239ac9..a507b67c 100644 --- a/nipyapi/registry/models/model_property.py +++ b/nipyapi/registry/models/model_property.py @@ -1,14 +1,13 @@ """ Apache NiFi Registry REST API - The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components. + REST API definition for Apache NiFi Registry web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,156 +27,129 @@ class ModelProperty(object): and the value is json key in definition. """ swagger_types = { - 'name': 'str', - 'display_name': 'str', - 'description': 'str', - 'default_value': 'str', - 'controller_service_definition': 'ControllerServiceDefinition', 'allowable_values': 'list[AllowableValue]', - 'required': 'bool', - 'sensitive': 'bool', - 'expression_language_supported': 'bool', - 'expression_language_scope': 'str', - 'dynamically_modifies_classpath': 'bool', - 'dynamic': 'bool', - 'dependencies': 'list[Dependency]', - 'resource_definition': 'ResourceDefinition' - } +'controller_service_definition': 'ControllerServiceDefinition', +'default_value': 'str', +'dependencies': 'list[Dependency]', +'description': 'str', +'display_name': 'str', +'dynamic': 'bool', +'dynamically_modifies_classpath': 'bool', +'expression_language_scope': 'str', +'expression_language_supported': 'bool', +'name': 'str', +'required': 'bool', +'resource_definition': 'ResourceDefinition', +'sensitive': 'bool' } attribute_map = { - 'name': 'name', - 'display_name': 'displayName', - 'description': 'description', - 'default_value': 'defaultValue', - 'controller_service_definition': 'controllerServiceDefinition', 'allowable_values': 'allowableValues', - 'required': 'required', - 'sensitive': 'sensitive', - 'expression_language_supported': 'expressionLanguageSupported', - 'expression_language_scope': 'expressionLanguageScope', - 'dynamically_modifies_classpath': 'dynamicallyModifiesClasspath', - 'dynamic': 'dynamic', - 'dependencies': 'dependencies', - 'resource_definition': 'resourceDefinition' - } - - def __init__(self, name=None, display_name=None, description=None, default_value=None, controller_service_definition=None, allowable_values=None, required=None, sensitive=None, expression_language_supported=None, expression_language_scope=None, dynamically_modifies_classpath=None, dynamic=None, dependencies=None, resource_definition=None): +'controller_service_definition': 'controllerServiceDefinition', +'default_value': 'defaultValue', +'dependencies': 'dependencies', +'description': 'description', +'display_name': 'displayName', +'dynamic': 'dynamic', +'dynamically_modifies_classpath': 'dynamicallyModifiesClasspath', +'expression_language_scope': 'expressionLanguageScope', +'expression_language_supported': 'expressionLanguageSupported', +'name': 'name', +'required': 'required', +'resource_definition': 'resourceDefinition', +'sensitive': 'sensitive' } + + def __init__(self, allowable_values=None, controller_service_definition=None, default_value=None, dependencies=None, description=None, display_name=None, dynamic=None, dynamically_modifies_classpath=None, expression_language_scope=None, expression_language_supported=None, name=None, required=None, resource_definition=None, sensitive=None): """ ModelProperty - a model defined in Swagger """ - self._name = None - self._display_name = None - self._description = None - self._default_value = None - self._controller_service_definition = None self._allowable_values = None - self._required = None - self._sensitive = None - self._expression_language_supported = None - self._expression_language_scope = None - self._dynamically_modifies_classpath = None - self._dynamic = None + self._controller_service_definition = None + self._default_value = None self._dependencies = None + self._description = None + self._display_name = None + self._dynamic = None + self._dynamically_modifies_classpath = None + self._expression_language_scope = None + self._expression_language_supported = None + self._name = None + self._required = None self._resource_definition = None + self._sensitive = None - if name is not None: - self.name = name - if display_name is not None: - self.display_name = display_name - if description is not None: - self.description = description - if default_value is not None: - self.default_value = default_value - if controller_service_definition is not None: - self.controller_service_definition = controller_service_definition if allowable_values is not None: self.allowable_values = allowable_values - if required is not None: - self.required = required - if sensitive is not None: - self.sensitive = sensitive - if expression_language_supported is not None: - self.expression_language_supported = expression_language_supported - if expression_language_scope is not None: - self.expression_language_scope = expression_language_scope - if dynamically_modifies_classpath is not None: - self.dynamically_modifies_classpath = dynamically_modifies_classpath - if dynamic is not None: - self.dynamic = dynamic + if controller_service_definition is not None: + self.controller_service_definition = controller_service_definition + if default_value is not None: + self.default_value = default_value if dependencies is not None: self.dependencies = dependencies + if description is not None: + self.description = description + if display_name is not None: + self.display_name = display_name + if dynamic is not None: + self.dynamic = dynamic + if dynamically_modifies_classpath is not None: + self.dynamically_modifies_classpath = dynamically_modifies_classpath + if expression_language_scope is not None: + self.expression_language_scope = expression_language_scope + if expression_language_supported is not None: + self.expression_language_supported = expression_language_supported + if name is not None: + self.name = name + if required is not None: + self.required = required if resource_definition is not None: self.resource_definition = resource_definition + if sensitive is not None: + self.sensitive = sensitive @property - def name(self): - """ - Gets the name of this ModelProperty. - The name of the property - - :return: The name of this ModelProperty. - :rtype: str - """ - return self._name - - @name.setter - def name(self, name): - """ - Sets the name of this ModelProperty. - The name of the property - - :param name: The name of this ModelProperty. - :type: str - """ - - self._name = name - - @property - def display_name(self): + def allowable_values(self): """ - Gets the display_name of this ModelProperty. - The display name + Gets the allowable_values of this ModelProperty. + The allowable values for this property - :return: The display_name of this ModelProperty. - :rtype: str + :return: The allowable_values of this ModelProperty. + :rtype: list[AllowableValue] """ - return self._display_name + return self._allowable_values - @display_name.setter - def display_name(self, display_name): + @allowable_values.setter + def allowable_values(self, allowable_values): """ - Sets the display_name of this ModelProperty. - The display name + Sets the allowable_values of this ModelProperty. + The allowable values for this property - :param display_name: The display_name of this ModelProperty. - :type: str + :param allowable_values: The allowable_values of this ModelProperty. + :type: list[AllowableValue] """ - self._display_name = display_name + self._allowable_values = allowable_values @property - def description(self): + def controller_service_definition(self): """ - Gets the description of this ModelProperty. - The description + Gets the controller_service_definition of this ModelProperty. - :return: The description of this ModelProperty. - :rtype: str + :return: The controller_service_definition of this ModelProperty. + :rtype: ControllerServiceDefinition """ - return self._description + return self._controller_service_definition - @description.setter - def description(self, description): + @controller_service_definition.setter + def controller_service_definition(self, controller_service_definition): """ - Sets the description of this ModelProperty. - The description + Sets the controller_service_definition of this ModelProperty. - :param description: The description of this ModelProperty. - :type: str + :param controller_service_definition: The controller_service_definition of this ModelProperty. + :type: ControllerServiceDefinition """ - self._description = description + self._controller_service_definition = controller_service_definition @property def default_value(self): @@ -203,119 +175,119 @@ def default_value(self, default_value): self._default_value = default_value @property - def controller_service_definition(self): + def dependencies(self): """ - Gets the controller_service_definition of this ModelProperty. - The controller service required by this property, or null if none is required + Gets the dependencies of this ModelProperty. + The properties that this property depends on - :return: The controller_service_definition of this ModelProperty. - :rtype: ControllerServiceDefinition + :return: The dependencies of this ModelProperty. + :rtype: list[Dependency] """ - return self._controller_service_definition + return self._dependencies - @controller_service_definition.setter - def controller_service_definition(self, controller_service_definition): + @dependencies.setter + def dependencies(self, dependencies): """ - Sets the controller_service_definition of this ModelProperty. - The controller service required by this property, or null if none is required + Sets the dependencies of this ModelProperty. + The properties that this property depends on - :param controller_service_definition: The controller_service_definition of this ModelProperty. - :type: ControllerServiceDefinition + :param dependencies: The dependencies of this ModelProperty. + :type: list[Dependency] """ - self._controller_service_definition = controller_service_definition + self._dependencies = dependencies @property - def allowable_values(self): + def description(self): """ - Gets the allowable_values of this ModelProperty. - The allowable values for this property + Gets the description of this ModelProperty. + The description - :return: The allowable_values of this ModelProperty. - :rtype: list[AllowableValue] + :return: The description of this ModelProperty. + :rtype: str """ - return self._allowable_values + return self._description - @allowable_values.setter - def allowable_values(self, allowable_values): + @description.setter + def description(self, description): """ - Sets the allowable_values of this ModelProperty. - The allowable values for this property + Sets the description of this ModelProperty. + The description - :param allowable_values: The allowable_values of this ModelProperty. - :type: list[AllowableValue] + :param description: The description of this ModelProperty. + :type: str """ - self._allowable_values = allowable_values + self._description = description @property - def required(self): + def display_name(self): """ - Gets the required of this ModelProperty. - Whether or not the property is required + Gets the display_name of this ModelProperty. + The display name - :return: The required of this ModelProperty. - :rtype: bool + :return: The display_name of this ModelProperty. + :rtype: str """ - return self._required + return self._display_name - @required.setter - def required(self, required): + @display_name.setter + def display_name(self, display_name): """ - Sets the required of this ModelProperty. - Whether or not the property is required + Sets the display_name of this ModelProperty. + The display name - :param required: The required of this ModelProperty. - :type: bool + :param display_name: The display_name of this ModelProperty. + :type: str """ - self._required = required + self._display_name = display_name @property - def sensitive(self): + def dynamic(self): """ - Gets the sensitive of this ModelProperty. - Whether or not the property is sensitive + Gets the dynamic of this ModelProperty. + Whether or not the processor is dynamic - :return: The sensitive of this ModelProperty. + :return: The dynamic of this ModelProperty. :rtype: bool """ - return self._sensitive + return self._dynamic - @sensitive.setter - def sensitive(self, sensitive): + @dynamic.setter + def dynamic(self, dynamic): """ - Sets the sensitive of this ModelProperty. - Whether or not the property is sensitive + Sets the dynamic of this ModelProperty. + Whether or not the processor is dynamic - :param sensitive: The sensitive of this ModelProperty. + :param dynamic: The dynamic of this ModelProperty. :type: bool """ - self._sensitive = sensitive + self._dynamic = dynamic @property - def expression_language_supported(self): + def dynamically_modifies_classpath(self): """ - Gets the expression_language_supported of this ModelProperty. - Whether or not expression language is supported + Gets the dynamically_modifies_classpath of this ModelProperty. + Whether or not the processor dynamically modifies the classpath - :return: The expression_language_supported of this ModelProperty. + :return: The dynamically_modifies_classpath of this ModelProperty. :rtype: bool """ - return self._expression_language_supported + return self._dynamically_modifies_classpath - @expression_language_supported.setter - def expression_language_supported(self, expression_language_supported): + @dynamically_modifies_classpath.setter + def dynamically_modifies_classpath(self, dynamically_modifies_classpath): """ - Sets the expression_language_supported of this ModelProperty. - Whether or not expression language is supported + Sets the dynamically_modifies_classpath of this ModelProperty. + Whether or not the processor dynamically modifies the classpath - :param expression_language_supported: The expression_language_supported of this ModelProperty. + :param dynamically_modifies_classpath: The dynamically_modifies_classpath of this ModelProperty. :type: bool """ - self._expression_language_supported = expression_language_supported + self._dynamically_modifies_classpath = dynamically_modifies_classpath @property def expression_language_scope(self): @@ -337,7 +309,7 @@ def expression_language_scope(self, expression_language_scope): :param expression_language_scope: The expression_language_scope of this ModelProperty. :type: str """ - allowed_values = ["NONE", "VARIABLE_REGISTRY", "FLOWFILE_ATTRIBUTES"] + 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}" @@ -347,79 +319,78 @@ def expression_language_scope(self, expression_language_scope): self._expression_language_scope = expression_language_scope @property - def dynamically_modifies_classpath(self): + def expression_language_supported(self): """ - Gets the dynamically_modifies_classpath of this ModelProperty. - Whether or not the processor dynamically modifies the classpath + Gets the expression_language_supported of this ModelProperty. + Whether or not expression language is supported - :return: The dynamically_modifies_classpath of this ModelProperty. + :return: The expression_language_supported of this ModelProperty. :rtype: bool """ - return self._dynamically_modifies_classpath + return self._expression_language_supported - @dynamically_modifies_classpath.setter - def dynamically_modifies_classpath(self, dynamically_modifies_classpath): + @expression_language_supported.setter + def expression_language_supported(self, expression_language_supported): """ - Sets the dynamically_modifies_classpath of this ModelProperty. - Whether or not the processor dynamically modifies the classpath + Sets the expression_language_supported of this ModelProperty. + Whether or not expression language is supported - :param dynamically_modifies_classpath: The dynamically_modifies_classpath of this ModelProperty. + :param expression_language_supported: The expression_language_supported of this ModelProperty. :type: bool """ - self._dynamically_modifies_classpath = dynamically_modifies_classpath + self._expression_language_supported = expression_language_supported @property - def dynamic(self): + def name(self): """ - Gets the dynamic of this ModelProperty. - Whether or not the processor is dynamic + Gets the name of this ModelProperty. + The name of the property - :return: The dynamic of this ModelProperty. - :rtype: bool + :return: The name of this ModelProperty. + :rtype: str """ - return self._dynamic + return self._name - @dynamic.setter - def dynamic(self, dynamic): + @name.setter + def name(self, name): """ - Sets the dynamic of this ModelProperty. - Whether or not the processor is dynamic + Sets the name of this ModelProperty. + The name of the property - :param dynamic: The dynamic of this ModelProperty. - :type: bool + :param name: The name of this ModelProperty. + :type: str """ - self._dynamic = dynamic + self._name = name @property - def dependencies(self): + def required(self): """ - Gets the dependencies of this ModelProperty. - The properties that this property depends on + Gets the required of this ModelProperty. + Whether or not the property is required - :return: The dependencies of this ModelProperty. - :rtype: list[Dependency] + :return: The required of this ModelProperty. + :rtype: bool """ - return self._dependencies + return self._required - @dependencies.setter - def dependencies(self, dependencies): + @required.setter + def required(self, required): """ - Sets the dependencies of this ModelProperty. - The properties that this property depends on + Sets the required of this ModelProperty. + Whether or not the property is required - :param dependencies: The dependencies of this ModelProperty. - :type: list[Dependency] + :param required: The required of this ModelProperty. + :type: bool """ - self._dependencies = dependencies + self._required = required @property def resource_definition(self): """ Gets the resource_definition of this ModelProperty. - The optional resource definition :return: The resource_definition of this ModelProperty. :rtype: ResourceDefinition @@ -430,7 +401,6 @@ def resource_definition(self): def resource_definition(self, resource_definition): """ Sets the resource_definition of this ModelProperty. - The optional resource definition :param resource_definition: The resource_definition of this ModelProperty. :type: ResourceDefinition @@ -438,6 +408,29 @@ def resource_definition(self, resource_definition): self._resource_definition = resource_definition + @property + def sensitive(self): + """ + Gets the sensitive of this ModelProperty. + Whether or not the property is sensitive + + :return: The sensitive of this ModelProperty. + :rtype: bool + """ + return self._sensitive + + @sensitive.setter + def sensitive(self, sensitive): + """ + Sets the sensitive of this ModelProperty. + Whether or not the property is sensitive + + :param sensitive: The sensitive of this ModelProperty. + :type: bool + """ + + self._sensitive = sensitive + def to_dict(self): """ Returns the model properties as a dict diff --git a/nipyapi/registry/models/multi_processor_use_case.py b/nipyapi/registry/models/multi_processor_use_case.py new file mode 100644 index 00000000..48613289 --- /dev/null +++ b/nipyapi/registry/models/multi_processor_use_case.py @@ -0,0 +1,195 @@ +""" + Apache NiFi Registry REST API + + REST API definition for Apache NiFi Registry web services + + OpenAPI spec version: 2.5.0 + Contact: dev@nifi.apache.org + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from pprint import pformat +import re + + +class MultiProcessorUseCase(object): + """ + NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. + """ + + + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'description': 'str', +'keywords': 'list[str]', +'notes': 'str', +'processor_configurations': 'list[ProcessorConfiguration]' } + + attribute_map = { + 'description': 'description', +'keywords': 'keywords', +'notes': 'notes', +'processor_configurations': 'processorConfigurations' } + + def __init__(self, description=None, keywords=None, notes=None, processor_configurations=None): + """ + MultiProcessorUseCase - a model defined in Swagger + """ + + self._description = None + self._keywords = None + self._notes = None + self._processor_configurations = None + + if description is not None: + self.description = description + if keywords is not None: + self.keywords = keywords + if notes is not None: + self.notes = notes + if processor_configurations is not None: + self.processor_configurations = processor_configurations + + @property + def description(self): + """ + Gets the description of this MultiProcessorUseCase. + + :return: The description of this MultiProcessorUseCase. + :rtype: str + """ + return self._description + + @description.setter + def description(self, description): + """ + Sets the description of this MultiProcessorUseCase. + + :param description: The description of this MultiProcessorUseCase. + :type: str + """ + + self._description = description + + @property + def keywords(self): + """ + Gets the keywords of this MultiProcessorUseCase. + + :return: The keywords of this MultiProcessorUseCase. + :rtype: list[str] + """ + return self._keywords + + @keywords.setter + def keywords(self, keywords): + """ + Sets the keywords of this MultiProcessorUseCase. + + :param keywords: The keywords of this MultiProcessorUseCase. + :type: list[str] + """ + + self._keywords = keywords + + @property + def notes(self): + """ + Gets the notes of this MultiProcessorUseCase. + + :return: The notes of this MultiProcessorUseCase. + :rtype: str + """ + return self._notes + + @notes.setter + def notes(self, notes): + """ + Sets the notes of this MultiProcessorUseCase. + + :param notes: The notes of this MultiProcessorUseCase. + :type: str + """ + + self._notes = notes + + @property + def processor_configurations(self): + """ + Gets the processor_configurations of this MultiProcessorUseCase. + + :return: The processor_configurations of this MultiProcessorUseCase. + :rtype: list[ProcessorConfiguration] + """ + return self._processor_configurations + + @processor_configurations.setter + def processor_configurations(self, processor_configurations): + """ + Sets the processor_configurations of this MultiProcessorUseCase. + + :param processor_configurations: The processor_configurations of this MultiProcessorUseCase. + :type: list[ProcessorConfiguration] + """ + + self._processor_configurations = processor_configurations + + 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, MultiProcessorUseCase): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """ + Returns true if both objects are not equal + """ + return not self == other diff --git a/nipyapi/registry/models/parameter_provider_reference.py b/nipyapi/registry/models/parameter_provider_reference.py index 92030055..97a30a06 100644 --- a/nipyapi/registry/models/parameter_provider_reference.py +++ b/nipyapi/registry/models/parameter_provider_reference.py @@ -1,14 +1,13 @@ """ Apache NiFi Registry REST API - The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components. + REST API definition for Apache NiFi Registry web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,37 +27,56 @@ class ParameterProviderReference(object): and the value is json key in definition. """ swagger_types = { - 'identifier': 'str', - 'name': 'str', - 'type': 'str', - 'bundle': 'Bundle' - } + 'bundle': 'Bundle', +'identifier': 'str', +'name': 'str', +'type': 'str' } attribute_map = { - 'identifier': 'identifier', - 'name': 'name', - 'type': 'type', - 'bundle': 'bundle' - } + 'bundle': 'bundle', +'identifier': 'identifier', +'name': 'name', +'type': 'type' } - def __init__(self, identifier=None, name=None, type=None, bundle=None): + def __init__(self, bundle=None, identifier=None, name=None, type=None): """ ParameterProviderReference - a model defined in Swagger """ + self._bundle = None self._identifier = None self._name = None self._type = None - self._bundle = None + if bundle is not None: + self.bundle = bundle if identifier is not None: self.identifier = identifier if name is not None: self.name = name if type is not None: self.type = type - if bundle is not None: - self.bundle = bundle + + @property + def bundle(self): + """ + Gets the bundle of this ParameterProviderReference. + + :return: The bundle of this ParameterProviderReference. + :rtype: Bundle + """ + return self._bundle + + @bundle.setter + def bundle(self, bundle): + """ + Sets the bundle of this ParameterProviderReference. + + :param bundle: The bundle of this ParameterProviderReference. + :type: Bundle + """ + + self._bundle = bundle @property def identifier(self): @@ -129,29 +147,6 @@ def type(self, type): self._type = type - @property - def bundle(self): - """ - Gets the bundle of this ParameterProviderReference. - The details of the artifact that bundled this parameter provider. - - :return: The bundle of this ParameterProviderReference. - :rtype: Bundle - """ - return self._bundle - - @bundle.setter - def bundle(self, bundle): - """ - Sets the bundle of this ParameterProviderReference. - The details of the artifact that bundled this parameter provider. - - :param bundle: The bundle of this ParameterProviderReference. - :type: Bundle - """ - - self._bundle = bundle - def to_dict(self): """ Returns the model properties as a dict diff --git a/nipyapi/registry/models/permissions.py b/nipyapi/registry/models/permissions.py index 77b45b33..b6c5c7b7 100644 --- a/nipyapi/registry/models/permissions.py +++ b/nipyapi/registry/models/permissions.py @@ -1,14 +1,13 @@ """ Apache NiFi Registry REST API - The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components. + REST API definition for Apache NiFi Registry web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,32 +27,53 @@ class Permissions(object): and the value is json key in definition. """ swagger_types = { - 'can_read': 'bool', - 'can_write': 'bool', - 'can_delete': 'bool' - } + 'can_delete': 'bool', +'can_read': 'bool', +'can_write': 'bool' } attribute_map = { - 'can_read': 'canRead', - 'can_write': 'canWrite', - 'can_delete': 'canDelete' - } + 'can_delete': 'canDelete', +'can_read': 'canRead', +'can_write': 'canWrite' } - def __init__(self, can_read=None, can_write=None, can_delete=None): + def __init__(self, can_delete=None, can_read=None, can_write=None): """ Permissions - a model defined in Swagger """ + self._can_delete = None self._can_read = None self._can_write = None - self._can_delete = None + if can_delete is not None: + self.can_delete = can_delete if can_read is not None: self.can_read = can_read if can_write is not None: self.can_write = can_write - if can_delete is not None: - self.can_delete = can_delete + + @property + def can_delete(self): + """ + Gets the can_delete of this Permissions. + Indicates whether the user can delete a given resource. + + :return: The can_delete of this Permissions. + :rtype: bool + """ + return self._can_delete + + @can_delete.setter + def can_delete(self, can_delete): + """ + Sets the can_delete of this Permissions. + Indicates whether the user can delete a given resource. + + :param can_delete: The can_delete of this Permissions. + :type: bool + """ + + self._can_delete = can_delete @property def can_read(self): @@ -101,29 +121,6 @@ def can_write(self, can_write): self._can_write = can_write - @property - def can_delete(self): - """ - Gets the can_delete of this Permissions. - Indicates whether the user can delete a given resource. - - :return: The can_delete of this Permissions. - :rtype: bool - """ - return self._can_delete - - @can_delete.setter - def can_delete(self, can_delete): - """ - Sets the can_delete of this Permissions. - Indicates whether the user can delete a given resource. - - :param can_delete: The can_delete of this Permissions. - :type: bool - """ - - self._can_delete = can_delete - def to_dict(self): """ Returns the model properties as a dict diff --git a/nipyapi/registry/models/position.py b/nipyapi/registry/models/position.py index e55608d9..1d3e1da2 100644 --- a/nipyapi/registry/models/position.py +++ b/nipyapi/registry/models/position.py @@ -1,14 +1,13 @@ """ Apache NiFi Registry REST API - The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components. + REST API definition for Apache NiFi Registry web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -29,13 +28,11 @@ class Position(object): """ swagger_types = { 'x': 'float', - 'y': 'float' - } +'y': 'float' } attribute_map = { 'x': 'x', - 'y': 'y' - } +'y': 'y' } def __init__(self, x=None, y=None): """ diff --git a/nipyapi/registry/models/processor_configuration.py b/nipyapi/registry/models/processor_configuration.py new file mode 100644 index 00000000..1984614c --- /dev/null +++ b/nipyapi/registry/models/processor_configuration.py @@ -0,0 +1,143 @@ +""" + Apache NiFi Registry REST API + + REST API definition for Apache NiFi Registry web services + + OpenAPI spec version: 2.5.0 + Contact: dev@nifi.apache.org + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from pprint import pformat +import re + + +class ProcessorConfiguration(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 = { + 'configuration': 'str', +'processor_class_name': 'str' } + + attribute_map = { + 'configuration': 'configuration', +'processor_class_name': 'processorClassName' } + + def __init__(self, configuration=None, processor_class_name=None): + """ + ProcessorConfiguration - a model defined in Swagger + """ + + self._configuration = None + self._processor_class_name = None + + if configuration is not None: + self.configuration = configuration + if processor_class_name is not None: + self.processor_class_name = processor_class_name + + @property + def configuration(self): + """ + Gets the configuration of this ProcessorConfiguration. + + :return: The configuration of this ProcessorConfiguration. + :rtype: str + """ + return self._configuration + + @configuration.setter + def configuration(self, configuration): + """ + Sets the configuration of this ProcessorConfiguration. + + :param configuration: The configuration of this ProcessorConfiguration. + :type: str + """ + + self._configuration = configuration + + @property + def processor_class_name(self): + """ + Gets the processor_class_name of this ProcessorConfiguration. + + :return: The processor_class_name of this ProcessorConfiguration. + :rtype: str + """ + return self._processor_class_name + + @processor_class_name.setter + def processor_class_name(self, processor_class_name): + """ + Sets the processor_class_name of this ProcessorConfiguration. + + :param processor_class_name: The processor_class_name of this ProcessorConfiguration. + :type: str + """ + + self._processor_class_name = processor_class_name + + 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, ProcessorConfiguration): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """ + Returns true if both objects are not equal + """ + return not self == other diff --git a/nipyapi/registry/models/provided_service_api.py b/nipyapi/registry/models/provided_service_api.py index 9ca7549f..0b6f53a2 100644 --- a/nipyapi/registry/models/provided_service_api.py +++ b/nipyapi/registry/models/provided_service_api.py @@ -1,14 +1,13 @@ """ Apache NiFi Registry REST API - The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components. + REST API definition for Apache NiFi Registry web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,38 +27,59 @@ class ProvidedServiceAPI(object): and the value is json key in definition. """ swagger_types = { - 'class_name': 'str', - 'group_id': 'str', 'artifact_id': 'str', - 'version': 'str' - } +'class_name': 'str', +'group_id': 'str', +'version': 'str' } attribute_map = { - 'class_name': 'className', - 'group_id': 'groupId', 'artifact_id': 'artifactId', - 'version': 'version' - } +'class_name': 'className', +'group_id': 'groupId', +'version': 'version' } - def __init__(self, class_name=None, group_id=None, artifact_id=None, version=None): + def __init__(self, artifact_id=None, class_name=None, group_id=None, version=None): """ ProvidedServiceAPI - a model defined in Swagger """ + self._artifact_id = None self._class_name = None self._group_id = None - self._artifact_id = None self._version = None + if artifact_id is not None: + self.artifact_id = artifact_id if class_name is not None: self.class_name = class_name if group_id is not None: self.group_id = group_id - if artifact_id is not None: - self.artifact_id = artifact_id if version is not None: self.version = version + @property + def artifact_id(self): + """ + Gets the artifact_id of this ProvidedServiceAPI. + The artifact id of the service API being provided + + :return: The artifact_id of this ProvidedServiceAPI. + :rtype: str + """ + return self._artifact_id + + @artifact_id.setter + def artifact_id(self, artifact_id): + """ + Sets the artifact_id of this ProvidedServiceAPI. + The artifact id of the service API being provided + + :param artifact_id: The artifact_id of this ProvidedServiceAPI. + :type: str + """ + + self._artifact_id = artifact_id + @property def class_name(self): """ @@ -106,29 +126,6 @@ def group_id(self, group_id): self._group_id = group_id - @property - def artifact_id(self): - """ - Gets the artifact_id of this ProvidedServiceAPI. - The artifact id of the service API being provided - - :return: The artifact_id of this ProvidedServiceAPI. - :rtype: str - """ - return self._artifact_id - - @artifact_id.setter - def artifact_id(self, artifact_id): - """ - Sets the artifact_id of this ProvidedServiceAPI. - The artifact id of the service API being provided - - :param artifact_id: The artifact_id of this ProvidedServiceAPI. - :type: str - """ - - self._artifact_id = artifact_id - @property def version(self): """ diff --git a/nipyapi/registry/models/registry_about.py b/nipyapi/registry/models/registry_about.py index 5c0360d2..b9233a65 100644 --- a/nipyapi/registry/models/registry_about.py +++ b/nipyapi/registry/models/registry_about.py @@ -1,14 +1,13 @@ """ Apache NiFi Registry REST API - The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components. + REST API definition for Apache NiFi Registry web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,12 +27,10 @@ class RegistryAbout(object): and the value is json key in definition. """ swagger_types = { - 'registry_about_version': 'str' - } + 'registry_about_version': 'str' } attribute_map = { - 'registry_about_version': 'registryAboutVersion' - } + 'registry_about_version': 'registryAboutVersion' } def __init__(self, registry_about_version=None): """ diff --git a/nipyapi/registry/models/registry_configuration.py b/nipyapi/registry/models/registry_configuration.py index 27136453..137f7d86 100644 --- a/nipyapi/registry/models/registry_configuration.py +++ b/nipyapi/registry/models/registry_configuration.py @@ -1,14 +1,13 @@ """ Apache NiFi Registry REST API - The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components. + REST API definition for Apache NiFi Registry web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,55 +27,30 @@ class RegistryConfiguration(object): and the value is json key in definition. """ swagger_types = { - 'supports_managed_authorizer': 'bool', 'supports_configurable_authorizer': 'bool', - 'supports_configurable_users_and_groups': 'bool' - } +'supports_configurable_users_and_groups': 'bool', +'supports_managed_authorizer': 'bool' } attribute_map = { - 'supports_managed_authorizer': 'supportsManagedAuthorizer', 'supports_configurable_authorizer': 'supportsConfigurableAuthorizer', - 'supports_configurable_users_and_groups': 'supportsConfigurableUsersAndGroups' - } +'supports_configurable_users_and_groups': 'supportsConfigurableUsersAndGroups', +'supports_managed_authorizer': 'supportsManagedAuthorizer' } - def __init__(self, supports_managed_authorizer=None, supports_configurable_authorizer=None, supports_configurable_users_and_groups=None): + def __init__(self, supports_configurable_authorizer=None, supports_configurable_users_and_groups=None, supports_managed_authorizer=None): """ RegistryConfiguration - a model defined in Swagger """ - self._supports_managed_authorizer = None self._supports_configurable_authorizer = None self._supports_configurable_users_and_groups = None + self._supports_managed_authorizer = None - if supports_managed_authorizer is not None: - self.supports_managed_authorizer = supports_managed_authorizer if supports_configurable_authorizer is not None: self.supports_configurable_authorizer = supports_configurable_authorizer if supports_configurable_users_and_groups is not None: self.supports_configurable_users_and_groups = supports_configurable_users_and_groups - - @property - def supports_managed_authorizer(self): - """ - Gets the supports_managed_authorizer of this RegistryConfiguration. - Whether this NiFi Registry supports a managed authorizer. Managed authorizers can visualize users, groups, and policies in the UI. - - :return: The supports_managed_authorizer of this RegistryConfiguration. - :rtype: bool - """ - return self._supports_managed_authorizer - - @supports_managed_authorizer.setter - def supports_managed_authorizer(self, supports_managed_authorizer): - """ - Sets the supports_managed_authorizer of this RegistryConfiguration. - Whether this NiFi Registry supports a managed authorizer. Managed authorizers can visualize users, groups, and policies in the UI. - - :param supports_managed_authorizer: The supports_managed_authorizer of this RegistryConfiguration. - :type: bool - """ - - self._supports_managed_authorizer = supports_managed_authorizer + if supports_managed_authorizer is not None: + self.supports_managed_authorizer = supports_managed_authorizer @property def supports_configurable_authorizer(self): @@ -124,6 +98,29 @@ def supports_configurable_users_and_groups(self, supports_configurable_users_and self._supports_configurable_users_and_groups = supports_configurable_users_and_groups + @property + def supports_managed_authorizer(self): + """ + Gets the supports_managed_authorizer of this RegistryConfiguration. + Whether this NiFi Registry supports a managed authorizer. Managed authorizers can visualize users, groups, and policies in the UI. + + :return: The supports_managed_authorizer of this RegistryConfiguration. + :rtype: bool + """ + return self._supports_managed_authorizer + + @supports_managed_authorizer.setter + def supports_managed_authorizer(self, supports_managed_authorizer): + """ + Sets the supports_managed_authorizer of this RegistryConfiguration. + Whether this NiFi Registry supports a managed authorizer. Managed authorizers can visualize users, groups, and policies in the UI. + + :param supports_managed_authorizer: The supports_managed_authorizer of this RegistryConfiguration. + :type: bool + """ + + self._supports_managed_authorizer = supports_managed_authorizer + def to_dict(self): """ Returns the model properties as a dict diff --git a/nipyapi/registry/models/relationship.py b/nipyapi/registry/models/relationship.py index 2033949c..8e98190a 100644 --- a/nipyapi/registry/models/relationship.py +++ b/nipyapi/registry/models/relationship.py @@ -1,14 +1,13 @@ """ Apache NiFi Registry REST API - The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components. + REST API definition for Apache NiFi Registry web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,55 +27,53 @@ class Relationship(object): and the value is json key in definition. """ swagger_types = { - 'name': 'str', - 'description': 'str', - 'auto_terminated': 'bool' - } + 'auto_terminated': 'bool', +'description': 'str', +'name': 'str' } attribute_map = { - 'name': 'name', - 'description': 'description', - 'auto_terminated': 'autoTerminated' - } + 'auto_terminated': 'autoTerminated', +'description': 'description', +'name': 'name' } - def __init__(self, name=None, description=None, auto_terminated=None): + def __init__(self, auto_terminated=None, description=None, name=None): """ Relationship - a model defined in Swagger """ - self._name = None - self._description = None self._auto_terminated = None + self._description = None + self._name = None - if name is not None: - self.name = name - if description is not None: - self.description = description if auto_terminated is not None: self.auto_terminated = auto_terminated + if description is not None: + self.description = description + if name is not None: + self.name = name @property - def name(self): + def auto_terminated(self): """ - Gets the name of this Relationship. - The name of the relationship + Gets the auto_terminated of this Relationship. + Whether or not the relationship is auto-terminated by default - :return: The name of this Relationship. - :rtype: str + :return: The auto_terminated of this Relationship. + :rtype: bool """ - return self._name + return self._auto_terminated - @name.setter - def name(self, name): + @auto_terminated.setter + def auto_terminated(self, auto_terminated): """ - Sets the name of this Relationship. - The name of the relationship + Sets the auto_terminated of this Relationship. + Whether or not the relationship is auto-terminated by default - :param name: The name of this Relationship. - :type: str + :param auto_terminated: The auto_terminated of this Relationship. + :type: bool """ - self._name = name + self._auto_terminated = auto_terminated @property def description(self): @@ -102,27 +99,27 @@ def description(self, description): self._description = description @property - def auto_terminated(self): + def name(self): """ - Gets the auto_terminated of this Relationship. - Whether or not the relationship is auto-terminated by default + Gets the name of this Relationship. + The name of the relationship - :return: The auto_terminated of this Relationship. - :rtype: bool + :return: The name of this Relationship. + :rtype: str """ - return self._auto_terminated + return self._name - @auto_terminated.setter - def auto_terminated(self, auto_terminated): + @name.setter + def name(self, name): """ - Sets the auto_terminated of this Relationship. - Whether or not the relationship is auto-terminated by default + Sets the name of this Relationship. + The name of the relationship - :param auto_terminated: The auto_terminated of this Relationship. - :type: bool + :param name: The name of this Relationship. + :type: str """ - self._auto_terminated = auto_terminated + self._name = name def to_dict(self): """ diff --git a/nipyapi/registry/models/resource.py b/nipyapi/registry/models/resource.py index 9f73b80d..f523b4cf 100644 --- a/nipyapi/registry/models/resource.py +++ b/nipyapi/registry/models/resource.py @@ -1,14 +1,13 @@ """ Apache NiFi Registry REST API - The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components. + REST API definition for Apache NiFi Registry web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -29,13 +28,11 @@ class Resource(object): """ swagger_types = { 'identifier': 'str', - 'name': 'str' - } +'name': 'str' } attribute_map = { 'identifier': 'identifier', - 'name': 'name' - } +'name': 'name' } def __init__(self, identifier=None, name=None): """ diff --git a/nipyapi/registry/models/resource_definition.py b/nipyapi/registry/models/resource_definition.py index 11f45564..d067828f 100644 --- a/nipyapi/registry/models/resource_definition.py +++ b/nipyapi/registry/models/resource_definition.py @@ -1,14 +1,13 @@ """ Apache NiFi Registry REST API - The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components. + REST API definition for Apache NiFi Registry web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -29,13 +28,11 @@ class ResourceDefinition(object): """ swagger_types = { 'cardinality': 'str', - 'resource_types': 'list[str]' - } +'resource_types': 'list[str]' } attribute_map = { 'cardinality': 'cardinality', - 'resource_types': 'resourceTypes' - } +'resource_types': 'resourceTypes' } def __init__(self, cardinality=None, resource_types=None): """ @@ -70,7 +67,7 @@ def cardinality(self, cardinality): :param cardinality: The cardinality of this ResourceDefinition. :type: str """ - allowed_values = ["SINGLE", "MULTIPLE"] + allowed_values = ["SINGLE", "MULTIPLE", ] if cardinality not in allowed_values: raise ValueError( "Invalid value for `cardinality` ({0}), must be one of {1}" @@ -99,7 +96,7 @@ def resource_types(self, resource_types): :param resource_types: The resource_types of this ResourceDefinition. :type: list[str] """ - allowed_values = ["FILE", "DIRECTORY", "TEXT", "URL"] + 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}]" diff --git a/nipyapi/registry/models/resource_permissions.py b/nipyapi/registry/models/resource_permissions.py index 77af4596..27178341 100644 --- a/nipyapi/registry/models/resource_permissions.py +++ b/nipyapi/registry/models/resource_permissions.py @@ -1,14 +1,13 @@ """ Apache NiFi Registry REST API - The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components. + REST API definition for Apache NiFi Registry web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,94 +27,87 @@ class ResourcePermissions(object): and the value is json key in definition. """ swagger_types = { - 'buckets': 'Permissions', - 'tenants': 'Permissions', - 'policies': 'Permissions', - 'proxy': 'Permissions', - 'any_top_level_resource': 'Permissions' - } + 'any_top_level_resource': 'Permissions', +'buckets': 'Permissions', +'policies': 'Permissions', +'proxy': 'Permissions', +'tenants': 'Permissions' } attribute_map = { - 'buckets': 'buckets', - 'tenants': 'tenants', - 'policies': 'policies', - 'proxy': 'proxy', - 'any_top_level_resource': 'anyTopLevelResource' - } + 'any_top_level_resource': 'anyTopLevelResource', +'buckets': 'buckets', +'policies': 'policies', +'proxy': 'proxy', +'tenants': 'tenants' } - def __init__(self, buckets=None, tenants=None, policies=None, proxy=None, any_top_level_resource=None): + def __init__(self, any_top_level_resource=None, buckets=None, policies=None, proxy=None, tenants=None): """ ResourcePermissions - a model defined in Swagger """ + self._any_top_level_resource = None self._buckets = None - self._tenants = None self._policies = None self._proxy = None - self._any_top_level_resource = None + self._tenants = None + if any_top_level_resource is not None: + self.any_top_level_resource = any_top_level_resource if buckets is not None: self.buckets = buckets - if tenants is not None: - self.tenants = tenants if policies is not None: self.policies = policies if proxy is not None: self.proxy = proxy - if any_top_level_resource is not None: - self.any_top_level_resource = any_top_level_resource + if tenants is not None: + self.tenants = tenants @property - def buckets(self): + def any_top_level_resource(self): """ - Gets the buckets of this ResourcePermissions. - The access that the current user has to the top level /buckets resource of this NiFi Registry (i.e., access to all buckets) + Gets the any_top_level_resource of this ResourcePermissions. - :return: The buckets of this ResourcePermissions. + :return: The any_top_level_resource of this ResourcePermissions. :rtype: Permissions """ - return self._buckets + return self._any_top_level_resource - @buckets.setter - def buckets(self, buckets): + @any_top_level_resource.setter + def any_top_level_resource(self, any_top_level_resource): """ - Sets the buckets of this ResourcePermissions. - The access that the current user has to the top level /buckets resource of this NiFi Registry (i.e., access to all buckets) + Sets the any_top_level_resource of this ResourcePermissions. - :param buckets: The buckets of this ResourcePermissions. + :param any_top_level_resource: The any_top_level_resource of this ResourcePermissions. :type: Permissions """ - self._buckets = buckets + self._any_top_level_resource = any_top_level_resource @property - def tenants(self): + def buckets(self): """ - Gets the tenants of this ResourcePermissions. - The access that the current user has to the top level /tenants resource of this NiFi Registry + Gets the buckets of this ResourcePermissions. - :return: The tenants of this ResourcePermissions. + :return: The buckets of this ResourcePermissions. :rtype: Permissions """ - return self._tenants + return self._buckets - @tenants.setter - def tenants(self, tenants): + @buckets.setter + def buckets(self, buckets): """ - Sets the tenants of this ResourcePermissions. - The access that the current user has to the top level /tenants resource of this NiFi Registry + Sets the buckets of this ResourcePermissions. - :param tenants: The tenants of this ResourcePermissions. + :param buckets: The buckets of this ResourcePermissions. :type: Permissions """ - self._tenants = tenants + self._buckets = buckets @property def policies(self): """ Gets the policies of this ResourcePermissions. - The access that the current user has to the top level /policies resource of this NiFi Registry :return: The policies of this ResourcePermissions. :rtype: Permissions @@ -126,7 +118,6 @@ def policies(self): def policies(self, policies): """ Sets the policies of this ResourcePermissions. - The access that the current user has to the top level /policies resource of this NiFi Registry :param policies: The policies of this ResourcePermissions. :type: Permissions @@ -138,7 +129,6 @@ def policies(self, policies): def proxy(self): """ Gets the proxy of this ResourcePermissions. - The access that the current user has to the top level /proxy resource of this NiFi Registry :return: The proxy of this ResourcePermissions. :rtype: Permissions @@ -149,7 +139,6 @@ def proxy(self): def proxy(self, proxy): """ Sets the proxy of this ResourcePermissions. - The access that the current user has to the top level /proxy resource of this NiFi Registry :param proxy: The proxy of this ResourcePermissions. :type: Permissions @@ -158,27 +147,25 @@ def proxy(self, proxy): self._proxy = proxy @property - def any_top_level_resource(self): + def tenants(self): """ - Gets the any_top_level_resource of this ResourcePermissions. - The access that the current user has to any top level resources (a logical 'OR' of all other values) + Gets the tenants of this ResourcePermissions. - :return: The any_top_level_resource of this ResourcePermissions. + :return: The tenants of this ResourcePermissions. :rtype: Permissions """ - return self._any_top_level_resource + return self._tenants - @any_top_level_resource.setter - def any_top_level_resource(self, any_top_level_resource): + @tenants.setter + def tenants(self, tenants): """ - Sets the any_top_level_resource of this ResourcePermissions. - The access that the current user has to any top level resources (a logical 'OR' of all other values) + Sets the tenants of this ResourcePermissions. - :param any_top_level_resource: The any_top_level_resource of this ResourcePermissions. + :param tenants: The tenants of this ResourcePermissions. :type: Permissions """ - self._any_top_level_resource = any_top_level_resource + self._tenants = tenants def to_dict(self): """ diff --git a/nipyapi/registry/models/restricted.py b/nipyapi/registry/models/restricted.py index 1d27e266..cab5a862 100644 --- a/nipyapi/registry/models/restricted.py +++ b/nipyapi/registry/models/restricted.py @@ -1,14 +1,13 @@ """ Apache NiFi Registry REST API - The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components. + REST API definition for Apache NiFi Registry web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -29,13 +28,11 @@ class Restricted(object): """ swagger_types = { 'general_restriction_explanation': 'str', - 'restrictions': 'list[Restriction]' - } +'restrictions': 'list[Restriction]' } attribute_map = { 'general_restriction_explanation': 'generalRestrictionExplanation', - 'restrictions': 'restrictions' - } +'restrictions': 'restrictions' } def __init__(self, general_restriction_explanation=None, restrictions=None): """ diff --git a/nipyapi/registry/models/restriction.py b/nipyapi/registry/models/restriction.py index 062b8c26..0b31eaf3 100644 --- a/nipyapi/registry/models/restriction.py +++ b/nipyapi/registry/models/restriction.py @@ -1,14 +1,13 @@ """ Apache NiFi Registry REST API - The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components. + REST API definition for Apache NiFi Registry web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,73 +27,71 @@ class Restriction(object): and the value is json key in definition. """ swagger_types = { - 'required_permission': 'str', - 'explanation': 'str' - } + 'explanation': 'str', +'required_permission': 'str' } attribute_map = { - 'required_permission': 'requiredPermission', - 'explanation': 'explanation' - } + 'explanation': 'explanation', +'required_permission': 'requiredPermission' } - def __init__(self, required_permission=None, explanation=None): + def __init__(self, explanation=None, required_permission=None): """ Restriction - a model defined in Swagger """ - self._required_permission = None self._explanation = None + self._required_permission = None - if required_permission is not None: - self.required_permission = required_permission if explanation is not None: self.explanation = explanation + if required_permission is not None: + self.required_permission = required_permission @property - def required_permission(self): + def explanation(self): """ - Gets the required_permission of this Restriction. - The permission required for this restriction + Gets the explanation of this Restriction. + The explanation of this restriction - :return: The required_permission of this Restriction. + :return: The explanation of this Restriction. :rtype: str """ - return self._required_permission + return self._explanation - @required_permission.setter - def required_permission(self, required_permission): + @explanation.setter + def explanation(self, explanation): """ - Sets the required_permission of this Restriction. - The permission required for this restriction + Sets the explanation of this Restriction. + The explanation of this restriction - :param required_permission: The required_permission of this Restriction. + :param explanation: The explanation of this Restriction. :type: str """ - self._required_permission = required_permission + self._explanation = explanation @property - def explanation(self): + def required_permission(self): """ - Gets the explanation of this Restriction. - The explanation of this restriction + Gets the required_permission of this Restriction. + The permission required for this restriction - :return: The explanation of this Restriction. + :return: The required_permission of this Restriction. :rtype: str """ - return self._explanation + return self._required_permission - @explanation.setter - def explanation(self, explanation): + @required_permission.setter + def required_permission(self, required_permission): """ - Sets the explanation of this Restriction. - The explanation of this restriction + Sets the required_permission of this Restriction. + The permission required for this restriction - :param explanation: The explanation of this Restriction. + :param required_permission: The required_permission of this Restriction. :type: str """ - self._explanation = explanation + self._required_permission = required_permission def to_dict(self): """ diff --git a/nipyapi/registry/models/revision_info.py b/nipyapi/registry/models/revision_info.py index 138b04e7..cd3c6281 100644 --- a/nipyapi/registry/models/revision_info.py +++ b/nipyapi/registry/models/revision_info.py @@ -1,14 +1,13 @@ """ Apache NiFi Registry REST API - The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components. + REST API definition for Apache NiFi Registry web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -29,31 +28,29 @@ class RevisionInfo(object): """ swagger_types = { 'client_id': 'str', - 'version': 'int', - 'last_modifier': 'str' - } +'last_modifier': 'str', +'version': 'int' } attribute_map = { 'client_id': 'clientId', - 'version': 'version', - 'last_modifier': 'lastModifier' - } +'last_modifier': 'lastModifier', +'version': 'version' } - def __init__(self, client_id=None, version=None, last_modifier=None): + def __init__(self, client_id=None, last_modifier=None, version=None): """ RevisionInfo - a model defined in Swagger """ self._client_id = None - self._version = None self._last_modifier = None + self._version = None if client_id is not None: self.client_id = client_id - if version is not None: - self.version = version if last_modifier is not None: self.last_modifier = last_modifier + if version is not None: + self.version = version @property def client_id(self): @@ -78,29 +75,6 @@ def client_id(self, client_id): self._client_id = client_id - @property - def version(self): - """ - Gets the version of this RevisionInfo. - NiFi Registry employs an optimistic locking strategy where the client must include a revision in their request when performing an update. In a response to a mutable flow request, this field represents the updated base version. - - :return: The version of this RevisionInfo. - :rtype: int - """ - return self._version - - @version.setter - def version(self, version): - """ - Sets the version of this RevisionInfo. - NiFi Registry employs an optimistic locking strategy where the client must include a revision in their request when performing an update. In a response to a mutable flow request, this field represents the updated base version. - - :param version: The version of this RevisionInfo. - :type: int - """ - - self._version = version - @property def last_modifier(self): """ @@ -124,6 +98,29 @@ def last_modifier(self, last_modifier): self._last_modifier = last_modifier + @property + def version(self): + """ + Gets the version of this RevisionInfo. + NiFi Registry employs an optimistic locking strategy where the client must include a revision in their request when performing an update. In a response to a mutable flow request, this field represents the updated base version. + + :return: The version of this RevisionInfo. + :rtype: int + """ + return self._version + + @version.setter + def version(self, version): + """ + Sets the version of this RevisionInfo. + NiFi Registry employs an optimistic locking strategy where the client must include a revision in their request when performing an update. In a response to a mutable flow request, this field represents the updated base version. + + :param version: The version of this RevisionInfo. + :type: int + """ + + self._version = version + def to_dict(self): """ Returns the model properties as a dict diff --git a/nipyapi/registry/models/stateful.py b/nipyapi/registry/models/stateful.py index 6707c284..412f9c3f 100644 --- a/nipyapi/registry/models/stateful.py +++ b/nipyapi/registry/models/stateful.py @@ -1,14 +1,13 @@ """ Apache NiFi Registry REST API - The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components. + REST API definition for Apache NiFi Registry web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -29,13 +28,11 @@ class Stateful(object): """ swagger_types = { 'description': 'str', - 'scopes': 'list[str]' - } +'scopes': 'list[str]' } attribute_map = { 'description': 'description', - 'scopes': 'scopes' - } +'scopes': 'scopes' } def __init__(self, description=None, scopes=None): """ @@ -93,7 +90,7 @@ def scopes(self, scopes): :param scopes: The scopes of this Stateful. :type: list[str] """ - allowed_values = ["CLUSTER", "LOCAL"] + 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}]" diff --git a/nipyapi/registry/models/system_resource_consideration.py b/nipyapi/registry/models/system_resource_consideration.py index f0520a6d..2c631c8d 100644 --- a/nipyapi/registry/models/system_resource_consideration.py +++ b/nipyapi/registry/models/system_resource_consideration.py @@ -1,14 +1,13 @@ """ Apache NiFi Registry REST API - The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components. + REST API definition for Apache NiFi Registry web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,73 +27,71 @@ class SystemResourceConsideration(object): and the value is json key in definition. """ swagger_types = { - 'resource': 'str', - 'description': 'str' - } + 'description': 'str', +'resource': 'str' } attribute_map = { - 'resource': 'resource', - 'description': 'description' - } + 'description': 'description', +'resource': 'resource' } - def __init__(self, resource=None, description=None): + def __init__(self, description=None, resource=None): """ SystemResourceConsideration - a model defined in Swagger """ - self._resource = None self._description = None + self._resource = None - if resource is not None: - self.resource = resource if description is not None: self.description = description + if resource is not None: + self.resource = resource @property - def resource(self): + def description(self): """ - Gets the resource of this SystemResourceConsideration. - The resource to consider + Gets the description of this SystemResourceConsideration. + The description of how the resource is affected - :return: The resource of this SystemResourceConsideration. + :return: The description of this SystemResourceConsideration. :rtype: str """ - return self._resource + return self._description - @resource.setter - def resource(self, resource): + @description.setter + def description(self, description): """ - Sets the resource of this SystemResourceConsideration. - The resource to consider + Sets the description of this SystemResourceConsideration. + The description of how the resource is affected - :param resource: The resource of this SystemResourceConsideration. + :param description: The description of this SystemResourceConsideration. :type: str """ - self._resource = resource + self._description = description @property - def description(self): + def resource(self): """ - Gets the description of this SystemResourceConsideration. - The description of how the resource is affected + Gets the resource of this SystemResourceConsideration. + The resource to consider - :return: The description of this SystemResourceConsideration. + :return: The resource of this SystemResourceConsideration. :rtype: str """ - return self._description + return self._resource - @description.setter - def description(self, description): + @resource.setter + def resource(self, resource): """ - Sets the description of this SystemResourceConsideration. - The description of how the resource is affected + Sets the resource of this SystemResourceConsideration. + The resource to consider - :param description: The description of this SystemResourceConsideration. + :param resource: The resource of this SystemResourceConsideration. :type: str """ - self._description = description + self._resource = resource def to_dict(self): """ diff --git a/nipyapi/registry/models/tag_count.py b/nipyapi/registry/models/tag_count.py index d4fb3293..8f729e8a 100644 --- a/nipyapi/registry/models/tag_count.py +++ b/nipyapi/registry/models/tag_count.py @@ -1,14 +1,13 @@ """ Apache NiFi Registry REST API - The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components. + REST API definition for Apache NiFi Registry web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,50 +27,25 @@ class TagCount(object): and the value is json key in definition. """ swagger_types = { - 'tag': 'str', - 'count': 'int' - } + 'count': 'int', +'tag': 'str' } attribute_map = { - 'tag': 'tag', - 'count': 'count' - } + 'count': 'count', +'tag': 'tag' } - def __init__(self, tag=None, count=None): + def __init__(self, count=None, tag=None): """ TagCount - a model defined in Swagger """ - self._tag = None self._count = None + self._tag = None - if tag is not None: - self.tag = tag if count is not None: self.count = count - - @property - def tag(self): - """ - Gets the tag of this TagCount. - The tag label - - :return: The tag of this TagCount. - :rtype: str - """ - return self._tag - - @tag.setter - def tag(self, tag): - """ - Sets the tag of this TagCount. - The tag label - - :param tag: The tag of this TagCount. - :type: str - """ - - self._tag = tag + if tag is not None: + self.tag = tag @property def count(self): @@ -96,6 +70,29 @@ def count(self, count): self._count = count + @property + def tag(self): + """ + Gets the tag of this TagCount. + The tag label + + :return: The tag of this TagCount. + :rtype: str + """ + return self._tag + + @tag.setter + def tag(self, tag): + """ + Sets the tag of this TagCount. + The tag label + + :param tag: The tag of this TagCount. + :type: str + """ + + self._tag = tag + def to_dict(self): """ Returns the model properties as a dict diff --git a/nipyapi/registry/models/tenant.py b/nipyapi/registry/models/tenant.py index 3c1b835f..84d64ed8 100644 --- a/nipyapi/registry/models/tenant.py +++ b/nipyapi/registry/models/tenant.py @@ -1,14 +1,13 @@ """ Apache NiFi Registry REST API - The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components. + REST API definition for Apache NiFi Registry web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,47 +27,92 @@ class Tenant(object): and the value is json key in definition. """ swagger_types = { - 'identifier': 'str', - 'identity': 'str', - 'configurable': 'bool', - 'resource_permissions': 'ResourcePermissions', 'access_policies': 'list[AccessPolicySummary]', - 'revision': 'RevisionInfo' - } +'configurable': 'bool', +'identifier': 'str', +'identity': 'str', +'resource_permissions': 'ResourcePermissions', +'revision': 'RevisionInfo' } attribute_map = { - 'identifier': 'identifier', - 'identity': 'identity', - 'configurable': 'configurable', - 'resource_permissions': 'resourcePermissions', 'access_policies': 'accessPolicies', - 'revision': 'revision' - } +'configurable': 'configurable', +'identifier': 'identifier', +'identity': 'identity', +'resource_permissions': 'resourcePermissions', +'revision': 'revision' } - def __init__(self, identifier=None, identity=None, configurable=None, resource_permissions=None, access_policies=None, revision=None): + def __init__(self, access_policies=None, configurable=None, identifier=None, identity=None, resource_permissions=None, revision=None): """ Tenant - a model defined in Swagger """ + self._access_policies = None + self._configurable = None self._identifier = None self._identity = None - self._configurable = None self._resource_permissions = None - self._access_policies = None self._revision = None - if identifier is not None: - self.identifier = identifier - self.identity = identity + if access_policies is not None: + self.access_policies = access_policies if configurable is not None: self.configurable = configurable + if identifier is not None: + self.identifier = identifier + if identity is not None: + self.identity = identity if resource_permissions is not None: self.resource_permissions = resource_permissions - if access_policies is not None: - self.access_policies = access_policies if revision is not None: self.revision = revision + @property + def access_policies(self): + """ + Gets the access_policies of this Tenant. + The access policies granted to this tenant. + + :return: The access_policies of this Tenant. + :rtype: list[AccessPolicySummary] + """ + return self._access_policies + + @access_policies.setter + def access_policies(self, access_policies): + """ + Sets the access_policies of this Tenant. + The access policies granted to this tenant. + + :param access_policies: The access_policies of this Tenant. + :type: list[AccessPolicySummary] + """ + + self._access_policies = access_policies + + @property + def configurable(self): + """ + Gets the configurable of this Tenant. + Indicates if this tenant is configurable, based on which UserGroupProvider has been configured to manage it. + + :return: The configurable of this Tenant. + :rtype: bool + """ + return self._configurable + + @configurable.setter + def configurable(self, configurable): + """ + Sets the configurable of this Tenant. + Indicates if this tenant is configurable, based on which UserGroupProvider has been configured to manage it. + + :param configurable: The configurable of this Tenant. + :type: bool + """ + + self._configurable = configurable + @property def identifier(self): """ @@ -112,39 +156,13 @@ def identity(self, identity): :param identity: The identity of this Tenant. :type: str """ - if identity is None: - raise ValueError("Invalid value for `identity`, must not be `None`") self._identity = identity - @property - def configurable(self): - """ - Gets the configurable of this Tenant. - Indicates if this tenant is configurable, based on which UserGroupProvider has been configured to manage it. - - :return: The configurable of this Tenant. - :rtype: bool - """ - return self._configurable - - @configurable.setter - def configurable(self, configurable): - """ - Sets the configurable of this Tenant. - Indicates if this tenant is configurable, based on which UserGroupProvider has been configured to manage it. - - :param configurable: The configurable of this Tenant. - :type: bool - """ - - self._configurable = configurable - @property def resource_permissions(self): """ Gets the resource_permissions of this Tenant. - A summary top-level resource access policies granted to this tenant. :return: The resource_permissions of this Tenant. :rtype: ResourcePermissions @@ -155,7 +173,6 @@ def resource_permissions(self): def resource_permissions(self, resource_permissions): """ Sets the resource_permissions of this Tenant. - A summary top-level resource access policies granted to this tenant. :param resource_permissions: The resource_permissions of this Tenant. :type: ResourcePermissions @@ -163,34 +180,10 @@ def resource_permissions(self, resource_permissions): self._resource_permissions = resource_permissions - @property - def access_policies(self): - """ - Gets the access_policies of this Tenant. - The access policies granted to this tenant. - - :return: The access_policies of this Tenant. - :rtype: list[AccessPolicySummary] - """ - return self._access_policies - - @access_policies.setter - def access_policies(self, access_policies): - """ - Sets the access_policies of this Tenant. - The access policies granted to this tenant. - - :param access_policies: The access_policies of this Tenant. - :type: list[AccessPolicySummary] - """ - - self._access_policies = access_policies - @property def revision(self): """ Gets the revision of this Tenant. - The revision of this entity used for optimistic-locking during updates. :return: The revision of this Tenant. :rtype: RevisionInfo @@ -201,7 +194,6 @@ def revision(self): def revision(self, revision): """ Sets the revision of this Tenant. - The revision of this entity used for optimistic-locking during updates. :param revision: The revision of this Tenant. :type: RevisionInfo diff --git a/nipyapi/nifi/models/entity.py b/nipyapi/registry/models/uri_builder.py similarity index 75% rename from nipyapi/nifi/models/entity.py rename to nipyapi/registry/models/uri_builder.py index a8cf5269..f3339fa3 100644 --- a/nipyapi/nifi/models/entity.py +++ b/nipyapi/registry/models/uri_builder.py @@ -1,19 +1,18 @@ """ - NiFi Rest API + Apache NiFi Registry REST API - The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + REST API definition for Apache NiFi Registry web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re -class Entity(object): +class UriBuilder(object): """ NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually. @@ -28,16 +27,14 @@ class Entity(object): and the value is json key in definition. """ swagger_types = { - - } + } attribute_map = { - - } + } def __init__(self): """ - Entity - a model defined in Swagger + UriBuilder - a model defined in Swagger """ @@ -84,7 +81,7 @@ def __eq__(self, other): """ Returns true if both objects are equal """ - if not isinstance(other, Entity): + if not isinstance(other, UriBuilder): return False return self.__dict__ == other.__dict__ diff --git a/nipyapi/registry/models/use_case.py b/nipyapi/registry/models/use_case.py new file mode 100644 index 00000000..36d18b1e --- /dev/null +++ b/nipyapi/registry/models/use_case.py @@ -0,0 +1,227 @@ +""" + Apache NiFi Registry REST API + + REST API definition for Apache NiFi Registry web services + + OpenAPI spec version: 2.5.0 + Contact: dev@nifi.apache.org + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from pprint import pformat +import re + + +class UseCase(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 = { + 'configuration': 'str', +'description': 'str', +'input_requirement': 'str', +'keywords': 'list[str]', +'notes': 'str' } + + attribute_map = { + 'configuration': 'configuration', +'description': 'description', +'input_requirement': 'inputRequirement', +'keywords': 'keywords', +'notes': 'notes' } + + def __init__(self, configuration=None, description=None, input_requirement=None, keywords=None, notes=None): + """ + UseCase - a model defined in Swagger + """ + + self._configuration = None + self._description = None + self._input_requirement = None + self._keywords = None + self._notes = None + + if configuration is not None: + self.configuration = configuration + if description is not None: + self.description = description + if input_requirement is not None: + self.input_requirement = input_requirement + if keywords is not None: + self.keywords = keywords + if notes is not None: + self.notes = notes + + @property + def configuration(self): + """ + Gets the configuration of this UseCase. + + :return: The configuration of this UseCase. + :rtype: str + """ + return self._configuration + + @configuration.setter + def configuration(self, configuration): + """ + Sets the configuration of this UseCase. + + :param configuration: The configuration of this UseCase. + :type: str + """ + + self._configuration = configuration + + @property + def description(self): + """ + Gets the description of this UseCase. + + :return: The description of this UseCase. + :rtype: str + """ + return self._description + + @description.setter + def description(self, description): + """ + Sets the description of this UseCase. + + :param description: The description of this UseCase. + :type: str + """ + + self._description = description + + @property + def input_requirement(self): + """ + Gets the input_requirement of this UseCase. + + :return: The input_requirement of this UseCase. + :rtype: str + """ + return self._input_requirement + + @input_requirement.setter + def input_requirement(self, input_requirement): + """ + Sets the input_requirement of this UseCase. + + :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) + ) + + self._input_requirement = input_requirement + + @property + def keywords(self): + """ + Gets the keywords of this UseCase. + + :return: The keywords of this UseCase. + :rtype: list[str] + """ + return self._keywords + + @keywords.setter + def keywords(self, keywords): + """ + Sets the keywords of this UseCase. + + :param keywords: The keywords of this UseCase. + :type: list[str] + """ + + self._keywords = keywords + + @property + def notes(self): + """ + Gets the notes of this UseCase. + + :return: The notes of this UseCase. + :rtype: str + """ + return self._notes + + @notes.setter + def notes(self, notes): + """ + Sets the notes of this UseCase. + + :param notes: The notes of this UseCase. + :type: str + """ + + self._notes = notes + + 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, UseCase): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """ + Returns true if both objects are not equal + """ + return not self == other diff --git a/nipyapi/registry/models/user.py b/nipyapi/registry/models/user.py index 2a2178c5..5b5c6e5d 100644 --- a/nipyapi/registry/models/user.py +++ b/nipyapi/registry/models/user.py @@ -1,14 +1,13 @@ """ Apache NiFi Registry REST API - The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components. + REST API definition for Apache NiFi Registry web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,52 +27,97 @@ class User(object): and the value is json key in definition. """ swagger_types = { - 'identifier': 'str', - 'identity': 'str', - 'configurable': 'bool', - 'resource_permissions': 'ResourcePermissions', 'access_policies': 'list[AccessPolicySummary]', - 'revision': 'RevisionInfo', - 'user_groups': 'list[Tenant]' - } +'configurable': 'bool', +'identifier': 'str', +'identity': 'str', +'resource_permissions': 'ResourcePermissions', +'revision': 'RevisionInfo', +'user_groups': 'list[Tenant]' } attribute_map = { - 'identifier': 'identifier', - 'identity': 'identity', - 'configurable': 'configurable', - 'resource_permissions': 'resourcePermissions', 'access_policies': 'accessPolicies', - 'revision': 'revision', - 'user_groups': 'userGroups' - } +'configurable': 'configurable', +'identifier': 'identifier', +'identity': 'identity', +'resource_permissions': 'resourcePermissions', +'revision': 'revision', +'user_groups': 'userGroups' } - def __init__(self, identifier=None, identity=None, configurable=None, resource_permissions=None, access_policies=None, revision=None, user_groups=None): + def __init__(self, access_policies=None, configurable=None, identifier=None, identity=None, resource_permissions=None, revision=None, user_groups=None): """ User - a model defined in Swagger """ + self._access_policies = None + self._configurable = None self._identifier = None self._identity = None - self._configurable = None self._resource_permissions = None - self._access_policies = None self._revision = None self._user_groups = None - if identifier is not None: - self.identifier = identifier - self.identity = identity + if access_policies is not None: + self.access_policies = access_policies if configurable is not None: self.configurable = configurable + if identifier is not None: + self.identifier = identifier + if identity is not None: + self.identity = identity if resource_permissions is not None: self.resource_permissions = resource_permissions - if access_policies is not None: - self.access_policies = access_policies if revision is not None: self.revision = revision if user_groups is not None: self.user_groups = user_groups + @property + def access_policies(self): + """ + Gets the access_policies of this User. + The access policies granted to this tenant. + + :return: The access_policies of this User. + :rtype: list[AccessPolicySummary] + """ + return self._access_policies + + @access_policies.setter + def access_policies(self, access_policies): + """ + Sets the access_policies of this User. + The access policies granted to this tenant. + + :param access_policies: The access_policies of this User. + :type: list[AccessPolicySummary] + """ + + self._access_policies = access_policies + + @property + def configurable(self): + """ + Gets the configurable of this User. + Indicates if this tenant is configurable, based on which UserGroupProvider has been configured to manage it. + + :return: The configurable of this User. + :rtype: bool + """ + return self._configurable + + @configurable.setter + def configurable(self, configurable): + """ + Sets the configurable of this User. + Indicates if this tenant is configurable, based on which UserGroupProvider has been configured to manage it. + + :param configurable: The configurable of this User. + :type: bool + """ + + self._configurable = configurable + @property def identifier(self): """ @@ -117,39 +161,13 @@ def identity(self, identity): :param identity: The identity of this User. :type: str """ - if identity is None: - raise ValueError("Invalid value for `identity`, must not be `None`") self._identity = identity - @property - def configurable(self): - """ - Gets the configurable of this User. - Indicates if this tenant is configurable, based on which UserGroupProvider has been configured to manage it. - - :return: The configurable of this User. - :rtype: bool - """ - return self._configurable - - @configurable.setter - def configurable(self, configurable): - """ - Sets the configurable of this User. - Indicates if this tenant is configurable, based on which UserGroupProvider has been configured to manage it. - - :param configurable: The configurable of this User. - :type: bool - """ - - self._configurable = configurable - @property def resource_permissions(self): """ Gets the resource_permissions of this User. - A summary top-level resource access policies granted to this tenant. :return: The resource_permissions of this User. :rtype: ResourcePermissions @@ -160,7 +178,6 @@ def resource_permissions(self): def resource_permissions(self, resource_permissions): """ Sets the resource_permissions of this User. - A summary top-level resource access policies granted to this tenant. :param resource_permissions: The resource_permissions of this User. :type: ResourcePermissions @@ -168,34 +185,10 @@ def resource_permissions(self, resource_permissions): self._resource_permissions = resource_permissions - @property - def access_policies(self): - """ - Gets the access_policies of this User. - The access policies granted to this tenant. - - :return: The access_policies of this User. - :rtype: list[AccessPolicySummary] - """ - return self._access_policies - - @access_policies.setter - def access_policies(self, access_policies): - """ - Sets the access_policies of this User. - The access policies granted to this tenant. - - :param access_policies: The access_policies of this User. - :type: list[AccessPolicySummary] - """ - - self._access_policies = access_policies - @property def revision(self): """ Gets the revision of this User. - The revision of this entity used for optimistic-locking during updates. :return: The revision of this User. :rtype: RevisionInfo @@ -206,7 +199,6 @@ def revision(self): def revision(self, revision): """ Sets the revision of this User. - The revision of this entity used for optimistic-locking during updates. :param revision: The revision of this User. :type: RevisionInfo diff --git a/nipyapi/registry/models/user_group.py b/nipyapi/registry/models/user_group.py index d19b6fd6..4df746c6 100644 --- a/nipyapi/registry/models/user_group.py +++ b/nipyapi/registry/models/user_group.py @@ -1,14 +1,13 @@ """ Apache NiFi Registry REST API - The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components. + REST API definition for Apache NiFi Registry web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,52 +27,97 @@ class UserGroup(object): and the value is json key in definition. """ swagger_types = { - 'identifier': 'str', - 'identity': 'str', - 'configurable': 'bool', - 'resource_permissions': 'ResourcePermissions', 'access_policies': 'list[AccessPolicySummary]', - 'revision': 'RevisionInfo', - 'users': 'list[Tenant]' - } +'configurable': 'bool', +'identifier': 'str', +'identity': 'str', +'resource_permissions': 'ResourcePermissions', +'revision': 'RevisionInfo', +'users': 'list[Tenant]' } attribute_map = { - 'identifier': 'identifier', - 'identity': 'identity', - 'configurable': 'configurable', - 'resource_permissions': 'resourcePermissions', 'access_policies': 'accessPolicies', - 'revision': 'revision', - 'users': 'users' - } +'configurable': 'configurable', +'identifier': 'identifier', +'identity': 'identity', +'resource_permissions': 'resourcePermissions', +'revision': 'revision', +'users': 'users' } - def __init__(self, identifier=None, identity=None, configurable=None, resource_permissions=None, access_policies=None, revision=None, users=None): + def __init__(self, access_policies=None, configurable=None, identifier=None, identity=None, resource_permissions=None, revision=None, users=None): """ UserGroup - a model defined in Swagger """ + self._access_policies = None + self._configurable = None self._identifier = None self._identity = None - self._configurable = None self._resource_permissions = None - self._access_policies = None self._revision = None self._users = None - if identifier is not None: - self.identifier = identifier - self.identity = identity + if access_policies is not None: + self.access_policies = access_policies if configurable is not None: self.configurable = configurable + if identifier is not None: + self.identifier = identifier + if identity is not None: + self.identity = identity if resource_permissions is not None: self.resource_permissions = resource_permissions - if access_policies is not None: - self.access_policies = access_policies if revision is not None: self.revision = revision if users is not None: self.users = users + @property + def access_policies(self): + """ + Gets the access_policies of this UserGroup. + The access policies granted to this tenant. + + :return: The access_policies of this UserGroup. + :rtype: list[AccessPolicySummary] + """ + return self._access_policies + + @access_policies.setter + def access_policies(self, access_policies): + """ + Sets the access_policies of this UserGroup. + The access policies granted to this tenant. + + :param access_policies: The access_policies of this UserGroup. + :type: list[AccessPolicySummary] + """ + + self._access_policies = access_policies + + @property + def configurable(self): + """ + Gets the configurable of this UserGroup. + Indicates if this tenant is configurable, based on which UserGroupProvider has been configured to manage it. + + :return: The configurable of this UserGroup. + :rtype: bool + """ + return self._configurable + + @configurable.setter + def configurable(self, configurable): + """ + Sets the configurable of this UserGroup. + Indicates if this tenant is configurable, based on which UserGroupProvider has been configured to manage it. + + :param configurable: The configurable of this UserGroup. + :type: bool + """ + + self._configurable = configurable + @property def identifier(self): """ @@ -117,39 +161,13 @@ def identity(self, identity): :param identity: The identity of this UserGroup. :type: str """ - if identity is None: - raise ValueError("Invalid value for `identity`, must not be `None`") self._identity = identity - @property - def configurable(self): - """ - Gets the configurable of this UserGroup. - Indicates if this tenant is configurable, based on which UserGroupProvider has been configured to manage it. - - :return: The configurable of this UserGroup. - :rtype: bool - """ - return self._configurable - - @configurable.setter - def configurable(self, configurable): - """ - Sets the configurable of this UserGroup. - Indicates if this tenant is configurable, based on which UserGroupProvider has been configured to manage it. - - :param configurable: The configurable of this UserGroup. - :type: bool - """ - - self._configurable = configurable - @property def resource_permissions(self): """ Gets the resource_permissions of this UserGroup. - A summary top-level resource access policies granted to this tenant. :return: The resource_permissions of this UserGroup. :rtype: ResourcePermissions @@ -160,7 +178,6 @@ def resource_permissions(self): def resource_permissions(self, resource_permissions): """ Sets the resource_permissions of this UserGroup. - A summary top-level resource access policies granted to this tenant. :param resource_permissions: The resource_permissions of this UserGroup. :type: ResourcePermissions @@ -168,34 +185,10 @@ def resource_permissions(self, resource_permissions): self._resource_permissions = resource_permissions - @property - def access_policies(self): - """ - Gets the access_policies of this UserGroup. - The access policies granted to this tenant. - - :return: The access_policies of this UserGroup. - :rtype: list[AccessPolicySummary] - """ - return self._access_policies - - @access_policies.setter - def access_policies(self, access_policies): - """ - Sets the access_policies of this UserGroup. - The access policies granted to this tenant. - - :param access_policies: The access_policies of this UserGroup. - :type: list[AccessPolicySummary] - """ - - self._access_policies = access_policies - @property def revision(self): """ Gets the revision of this UserGroup. - The revision of this entity used for optimistic-locking during updates. :return: The revision of this UserGroup. :rtype: RevisionInfo @@ -206,7 +199,6 @@ def revision(self): def revision(self, revision): """ Sets the revision of this UserGroup. - The revision of this entity used for optimistic-locking during updates. :param revision: The revision of this UserGroup. :type: RevisionInfo diff --git a/nipyapi/registry/models/versioned_asset.py b/nipyapi/registry/models/versioned_asset.py new file mode 100644 index 00000000..f2424d52 --- /dev/null +++ b/nipyapi/registry/models/versioned_asset.py @@ -0,0 +1,147 @@ +""" + Apache NiFi Registry REST API + + REST API definition for Apache NiFi Registry web services + + OpenAPI spec version: 2.5.0 + Contact: dev@nifi.apache.org + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from pprint import pformat +import re + + +class VersionedAsset(object): + """ + NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. + """ + + + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'identifier': 'str', +'name': 'str' } + + attribute_map = { + 'identifier': 'identifier', +'name': 'name' } + + def __init__(self, identifier=None, name=None): + """ + VersionedAsset - a model defined in Swagger + """ + + self._identifier = None + self._name = None + + if identifier is not None: + self.identifier = identifier + if name is not None: + self.name = name + + @property + def identifier(self): + """ + Gets the identifier of this VersionedAsset. + The identifier of the asset + + :return: The identifier of this VersionedAsset. + :rtype: str + """ + return self._identifier + + @identifier.setter + def identifier(self, identifier): + """ + Sets the identifier of this VersionedAsset. + The identifier of the asset + + :param identifier: The identifier of this VersionedAsset. + :type: str + """ + + self._identifier = identifier + + @property + def name(self): + """ + Gets the name of this VersionedAsset. + The name of the asset + + :return: The name of this VersionedAsset. + :rtype: str + """ + return self._name + + @name.setter + def name(self, name): + """ + Sets the name of this VersionedAsset. + The name of the asset + + :param name: The name of this VersionedAsset. + :type: str + """ + + self._name = name + + 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, VersionedAsset): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """ + Returns true if both objects are not equal + """ + return not self == other diff --git a/nipyapi/registry/models/versioned_connection.py b/nipyapi/registry/models/versioned_connection.py index 1d0f349e..9da5d596 100644 --- a/nipyapi/registry/models/versioned_connection.py +++ b/nipyapi/registry/models/versioned_connection.py @@ -1,14 +1,13 @@ """ Apache NiFi Registry REST API - The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components. + REST API definition for Apache NiFi Registry web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,186 +27,184 @@ class VersionedConnection(object): and the value is json key in definition. """ swagger_types = { - 'identifier': 'str', - 'instance_identifier': 'str', - 'name': 'str', - 'comments': 'str', - 'position': 'Position', - 'source': 'ConnectableComponent', - 'destination': 'ConnectableComponent', - 'label_index': 'int', - 'z_index': 'int', - 'selected_relationships': 'list[str]', - 'back_pressure_object_threshold': 'int', 'back_pressure_data_size_threshold': 'str', - 'flow_file_expiration': 'str', - 'prioritizers': 'list[str]', - 'bends': 'list[Position]', - 'load_balance_strategy': 'str', - 'partitioning_attribute': 'str', - 'load_balance_compression': 'str', - 'component_type': 'str', - 'group_identifier': 'str' - } +'back_pressure_object_threshold': 'int', +'bends': 'list[Position]', +'comments': 'str', +'component_type': 'str', +'destination': 'ConnectableComponent', +'flow_file_expiration': 'str', +'group_identifier': 'str', +'identifier': 'str', +'instance_identifier': 'str', +'label_index': 'int', +'load_balance_compression': 'str', +'load_balance_strategy': 'str', +'name': 'str', +'partitioning_attribute': 'str', +'position': 'Position', +'prioritizers': 'list[str]', +'selected_relationships': 'list[str]', +'source': 'ConnectableComponent', +'z_index': 'int' } attribute_map = { - 'identifier': 'identifier', - 'instance_identifier': 'instanceIdentifier', - 'name': 'name', - 'comments': 'comments', - 'position': 'position', - 'source': 'source', - 'destination': 'destination', - 'label_index': 'labelIndex', - 'z_index': 'zIndex', - 'selected_relationships': 'selectedRelationships', - 'back_pressure_object_threshold': 'backPressureObjectThreshold', 'back_pressure_data_size_threshold': 'backPressureDataSizeThreshold', - 'flow_file_expiration': 'flowFileExpiration', - 'prioritizers': 'prioritizers', - 'bends': 'bends', - 'load_balance_strategy': 'loadBalanceStrategy', - 'partitioning_attribute': 'partitioningAttribute', - 'load_balance_compression': 'loadBalanceCompression', - 'component_type': 'componentType', - 'group_identifier': 'groupIdentifier' - } - - def __init__(self, identifier=None, instance_identifier=None, name=None, comments=None, position=None, source=None, destination=None, label_index=None, z_index=None, selected_relationships=None, back_pressure_object_threshold=None, back_pressure_data_size_threshold=None, flow_file_expiration=None, prioritizers=None, bends=None, load_balance_strategy=None, partitioning_attribute=None, load_balance_compression=None, component_type=None, group_identifier=None): +'back_pressure_object_threshold': 'backPressureObjectThreshold', +'bends': 'bends', +'comments': 'comments', +'component_type': 'componentType', +'destination': 'destination', +'flow_file_expiration': 'flowFileExpiration', +'group_identifier': 'groupIdentifier', +'identifier': 'identifier', +'instance_identifier': 'instanceIdentifier', +'label_index': 'labelIndex', +'load_balance_compression': 'loadBalanceCompression', +'load_balance_strategy': 'loadBalanceStrategy', +'name': 'name', +'partitioning_attribute': 'partitioningAttribute', +'position': 'position', +'prioritizers': 'prioritizers', +'selected_relationships': 'selectedRelationships', +'source': 'source', +'z_index': 'zIndex' } + + def __init__(self, back_pressure_data_size_threshold=None, back_pressure_object_threshold=None, bends=None, comments=None, component_type=None, destination=None, flow_file_expiration=None, group_identifier=None, identifier=None, instance_identifier=None, label_index=None, load_balance_compression=None, load_balance_strategy=None, name=None, partitioning_attribute=None, position=None, prioritizers=None, selected_relationships=None, source=None, z_index=None): """ VersionedConnection - a model defined in Swagger """ + self._back_pressure_data_size_threshold = None + self._back_pressure_object_threshold = None + self._bends = None + self._comments = None + self._component_type = None + self._destination = None + self._flow_file_expiration = None + self._group_identifier = None self._identifier = None self._instance_identifier = None + self._label_index = None + self._load_balance_compression = None + self._load_balance_strategy = None self._name = None - self._comments = None + self._partitioning_attribute = None self._position = None + self._prioritizers = None + self._selected_relationships = None self._source = None - self._destination = None - self._label_index = None self._z_index = None - self._selected_relationships = None - self._back_pressure_object_threshold = None - self._back_pressure_data_size_threshold = None - self._flow_file_expiration = None - self._prioritizers = None - self._bends = None - self._load_balance_strategy = None - self._partitioning_attribute = None - self._load_balance_compression = None - self._component_type = None - self._group_identifier = None + if back_pressure_data_size_threshold is not None: + self.back_pressure_data_size_threshold = back_pressure_data_size_threshold + if back_pressure_object_threshold is not None: + self.back_pressure_object_threshold = back_pressure_object_threshold + if bends is not None: + self.bends = bends + if comments is not None: + self.comments = comments + if component_type is not None: + self.component_type = component_type + if destination is not None: + self.destination = destination + if flow_file_expiration is not None: + self.flow_file_expiration = flow_file_expiration + if group_identifier is not None: + self.group_identifier = group_identifier if identifier is not None: self.identifier = identifier if instance_identifier is not None: self.instance_identifier = instance_identifier + if label_index is not None: + self.label_index = label_index + if load_balance_compression is not None: + self.load_balance_compression = load_balance_compression + if load_balance_strategy is not None: + self.load_balance_strategy = load_balance_strategy if name is not None: self.name = name - if comments is not None: - self.comments = comments + if partitioning_attribute is not None: + self.partitioning_attribute = partitioning_attribute if position is not None: self.position = position + if prioritizers is not None: + self.prioritizers = prioritizers + if selected_relationships is not None: + self.selected_relationships = selected_relationships if source is not None: self.source = source - if destination is not None: - self.destination = destination - if label_index is not None: - self.label_index = label_index if z_index is not None: self.z_index = z_index - if selected_relationships is not None: - self.selected_relationships = selected_relationships - if back_pressure_object_threshold is not None: - self.back_pressure_object_threshold = back_pressure_object_threshold - if back_pressure_data_size_threshold is not None: - self.back_pressure_data_size_threshold = back_pressure_data_size_threshold - if flow_file_expiration is not None: - self.flow_file_expiration = flow_file_expiration - if prioritizers is not None: - self.prioritizers = prioritizers - if bends is not None: - self.bends = bends - if load_balance_strategy is not None: - self.load_balance_strategy = load_balance_strategy - if partitioning_attribute is not None: - self.partitioning_attribute = partitioning_attribute - if load_balance_compression is not None: - self.load_balance_compression = load_balance_compression - if component_type is not None: - self.component_type = component_type - if group_identifier is not None: - self.group_identifier = group_identifier @property - def identifier(self): + def back_pressure_data_size_threshold(self): """ - Gets the identifier of this VersionedConnection. - The component's unique identifier + Gets the back_pressure_data_size_threshold of this VersionedConnection. + The object data size threshold for determining when back pressure is applied. Updating this value is a passive change in the sense that it won't impact whether existing files over the limit are affected but it does help feeder processors to stop pushing too much into this work queue. - :return: The identifier of this VersionedConnection. + :return: The back_pressure_data_size_threshold of this VersionedConnection. :rtype: str """ - return self._identifier + return self._back_pressure_data_size_threshold - @identifier.setter - def identifier(self, identifier): + @back_pressure_data_size_threshold.setter + def back_pressure_data_size_threshold(self, back_pressure_data_size_threshold): """ - Sets the identifier of this VersionedConnection. - The component's unique identifier + Sets the back_pressure_data_size_threshold of this VersionedConnection. + The object data size threshold for determining when back pressure is applied. Updating this value is a passive change in the sense that it won't impact whether existing files over the limit are affected but it does help feeder processors to stop pushing too much into this work queue. - :param identifier: The identifier of this VersionedConnection. + :param back_pressure_data_size_threshold: The back_pressure_data_size_threshold of this VersionedConnection. :type: str """ - self._identifier = identifier + self._back_pressure_data_size_threshold = back_pressure_data_size_threshold @property - def instance_identifier(self): + def back_pressure_object_threshold(self): """ - Gets the instance_identifier of this VersionedConnection. - The instance ID of an existing component that is described by this VersionedComponent, or null if this is not mapped to an instantiated component + Gets the back_pressure_object_threshold of this VersionedConnection. + The object count threshold for determining when back pressure is applied. Updating this value is a passive change in the sense that it won't impact whether existing files over the limit are affected but it does help feeder processors to stop pushing too much into this work queue. - :return: The instance_identifier of this VersionedConnection. - :rtype: str + :return: The back_pressure_object_threshold of this VersionedConnection. + :rtype: int """ - return self._instance_identifier + return self._back_pressure_object_threshold - @instance_identifier.setter - def instance_identifier(self, instance_identifier): + @back_pressure_object_threshold.setter + def back_pressure_object_threshold(self, back_pressure_object_threshold): """ - Sets the instance_identifier of this VersionedConnection. - The instance ID of an existing component that is described by this VersionedComponent, or null if this is not mapped to an instantiated component + Sets the back_pressure_object_threshold of this VersionedConnection. + The object count threshold for determining when back pressure is applied. Updating this value is a passive change in the sense that it won't impact whether existing files over the limit are affected but it does help feeder processors to stop pushing too much into this work queue. - :param instance_identifier: The instance_identifier of this VersionedConnection. - :type: str + :param back_pressure_object_threshold: The back_pressure_object_threshold of this VersionedConnection. + :type: int """ - self._instance_identifier = instance_identifier + self._back_pressure_object_threshold = back_pressure_object_threshold @property - def name(self): + def bends(self): """ - Gets the name of this VersionedConnection. - The component's name + Gets the bends of this VersionedConnection. + The bend points on the connection. - :return: The name of this VersionedConnection. - :rtype: str + :return: The bends of this VersionedConnection. + :rtype: list[Position] """ - return self._name + return self._bends - @name.setter - def name(self, name): + @bends.setter + def bends(self, bends): """ - Sets the name of this VersionedConnection. - The component's name + Sets the bends of this VersionedConnection. + The bend points on the connection. - :param name: The name of this VersionedConnection. - :type: str + :param bends: The bends of this VersionedConnection. + :type: list[Position] """ - self._name = name + self._bends = bends @property def comments(self): @@ -233,56 +230,36 @@ def comments(self, comments): self._comments = comments @property - def position(self): - """ - Gets the position of this VersionedConnection. - The component's position on the graph - - :return: The position of this VersionedConnection. - :rtype: Position - """ - return self._position - - @position.setter - def position(self, position): - """ - Sets the position of this VersionedConnection. - The component's position on the graph - - :param position: The position of this VersionedConnection. - :type: Position - """ - - self._position = position - - @property - def source(self): + def component_type(self): """ - Gets the source of this VersionedConnection. - The source of the connection. + Gets the component_type of this VersionedConnection. - :return: The source of this VersionedConnection. - :rtype: ConnectableComponent + :return: The component_type of this VersionedConnection. + :rtype: str """ - return self._source + return self._component_type - @source.setter - def source(self, source): + @component_type.setter + def component_type(self, component_type): """ - Sets the source of this VersionedConnection. - The source of the connection. + Sets the component_type of this VersionedConnection. - :param source: The source of this VersionedConnection. - :type: ConnectableComponent + :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", ] + 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._source = source + self._component_type = component_type @property def destination(self): """ Gets the destination of this VersionedConnection. - The destination of the connection. :return: The destination of this VersionedConnection. :rtype: ConnectableComponent @@ -293,7 +270,6 @@ def destination(self): def destination(self, destination): """ Sets the destination of this VersionedConnection. - The destination of the connection. :param destination: The destination of this VersionedConnection. :type: ConnectableComponent @@ -302,188 +278,148 @@ def destination(self, destination): self._destination = destination @property - def label_index(self): + def flow_file_expiration(self): """ - Gets the label_index of this VersionedConnection. - The index of the bend point where to place the connection label. + Gets the flow_file_expiration of this VersionedConnection. + The amount of time a flow file may be in the flow before it will be automatically aged out of the flow. Once a flow file reaches this age it will be terminated from the flow the next time a processor attempts to start work on it. - :return: The label_index of this VersionedConnection. - :rtype: int + :return: The flow_file_expiration of this VersionedConnection. + :rtype: str """ - return self._label_index + return self._flow_file_expiration - @label_index.setter - def label_index(self, label_index): + @flow_file_expiration.setter + def flow_file_expiration(self, flow_file_expiration): """ - Sets the label_index of this VersionedConnection. - The index of the bend point where to place the connection label. + Sets the flow_file_expiration of this VersionedConnection. + The amount of time a flow file may be in the flow before it will be automatically aged out of the flow. Once a flow file reaches this age it will be terminated from the flow the next time a processor attempts to start work on it. - :param label_index: The label_index of this VersionedConnection. - :type: int + :param flow_file_expiration: The flow_file_expiration of this VersionedConnection. + :type: str """ - self._label_index = label_index + self._flow_file_expiration = flow_file_expiration @property - def z_index(self): + def group_identifier(self): """ - Gets the z_index of this VersionedConnection. - The z index of the connection. + Gets the group_identifier of this VersionedConnection. + The ID of the Process Group that this component belongs to - :return: The z_index of this VersionedConnection. - :rtype: int + :return: The group_identifier of this VersionedConnection. + :rtype: str """ - return self._z_index + return self._group_identifier - @z_index.setter - def z_index(self, z_index): + @group_identifier.setter + def group_identifier(self, group_identifier): """ - Sets the z_index of this VersionedConnection. - The z index of the connection. + Sets the group_identifier of this VersionedConnection. + The ID of the Process Group that this component belongs to - :param z_index: The z_index of this VersionedConnection. - :type: int - """ - - self._z_index = z_index - - @property - def selected_relationships(self): - """ - Gets the selected_relationships of this VersionedConnection. - The selected relationship that comprise the connection. - - :return: The selected_relationships of this VersionedConnection. - :rtype: list[str] - """ - return self._selected_relationships - - @selected_relationships.setter - def selected_relationships(self, selected_relationships): - """ - Sets the selected_relationships of this VersionedConnection. - The selected relationship that comprise the connection. - - :param selected_relationships: The selected_relationships of this VersionedConnection. - :type: list[str] - """ - - self._selected_relationships = selected_relationships - - @property - def back_pressure_object_threshold(self): - """ - Gets the back_pressure_object_threshold of this VersionedConnection. - The object count threshold for determining when back pressure is applied. Updating this value is a passive change in the sense that it won't impact whether existing files over the limit are affected but it does help feeder processors to stop pushing too much into this work queue. - - :return: The back_pressure_object_threshold of this VersionedConnection. - :rtype: int - """ - return self._back_pressure_object_threshold - - @back_pressure_object_threshold.setter - def back_pressure_object_threshold(self, back_pressure_object_threshold): - """ - Sets the back_pressure_object_threshold of this VersionedConnection. - The object count threshold for determining when back pressure is applied. Updating this value is a passive change in the sense that it won't impact whether existing files over the limit are affected but it does help feeder processors to stop pushing too much into this work queue. - - :param back_pressure_object_threshold: The back_pressure_object_threshold of this VersionedConnection. - :type: int + :param group_identifier: The group_identifier of this VersionedConnection. + :type: str """ - self._back_pressure_object_threshold = back_pressure_object_threshold + self._group_identifier = group_identifier @property - def back_pressure_data_size_threshold(self): + def identifier(self): """ - Gets the back_pressure_data_size_threshold of this VersionedConnection. - The object data size threshold for determining when back pressure is applied. Updating this value is a passive change in the sense that it won't impact whether existing files over the limit are affected but it does help feeder processors to stop pushing too much into this work queue. + Gets the identifier of this VersionedConnection. + The component's unique identifier - :return: The back_pressure_data_size_threshold of this VersionedConnection. + :return: The identifier of this VersionedConnection. :rtype: str """ - return self._back_pressure_data_size_threshold + return self._identifier - @back_pressure_data_size_threshold.setter - def back_pressure_data_size_threshold(self, back_pressure_data_size_threshold): + @identifier.setter + def identifier(self, identifier): """ - Sets the back_pressure_data_size_threshold of this VersionedConnection. - The object data size threshold for determining when back pressure is applied. Updating this value is a passive change in the sense that it won't impact whether existing files over the limit are affected but it does help feeder processors to stop pushing too much into this work queue. + Sets the identifier of this VersionedConnection. + The component's unique identifier - :param back_pressure_data_size_threshold: The back_pressure_data_size_threshold of this VersionedConnection. + :param identifier: The identifier of this VersionedConnection. :type: str """ - self._back_pressure_data_size_threshold = back_pressure_data_size_threshold + self._identifier = identifier @property - def flow_file_expiration(self): + def instance_identifier(self): """ - Gets the flow_file_expiration of this VersionedConnection. - The amount of time a flow file may be in the flow before it will be automatically aged out of the flow. Once a flow file reaches this age it will be terminated from the flow the next time a processor attempts to start work on it. + Gets the instance_identifier of this VersionedConnection. + The instance ID of an existing component that is described by this VersionedComponent, or null if this is not mapped to an instantiated component - :return: The flow_file_expiration of this VersionedConnection. + :return: The instance_identifier of this VersionedConnection. :rtype: str """ - return self._flow_file_expiration + return self._instance_identifier - @flow_file_expiration.setter - def flow_file_expiration(self, flow_file_expiration): + @instance_identifier.setter + def instance_identifier(self, instance_identifier): """ - Sets the flow_file_expiration of this VersionedConnection. - The amount of time a flow file may be in the flow before it will be automatically aged out of the flow. Once a flow file reaches this age it will be terminated from the flow the next time a processor attempts to start work on it. + Sets the instance_identifier of this VersionedConnection. + The instance ID of an existing component that is described by this VersionedComponent, or null if this is not mapped to an instantiated component - :param flow_file_expiration: The flow_file_expiration of this VersionedConnection. + :param instance_identifier: The instance_identifier of this VersionedConnection. :type: str """ - self._flow_file_expiration = flow_file_expiration + self._instance_identifier = instance_identifier @property - def prioritizers(self): + def label_index(self): """ - Gets the prioritizers of this VersionedConnection. - The comparators used to prioritize the queue. + Gets the label_index of this VersionedConnection. + The index of the bend point where to place the connection label. - :return: The prioritizers of this VersionedConnection. - :rtype: list[str] + :return: The label_index of this VersionedConnection. + :rtype: int """ - return self._prioritizers + return self._label_index - @prioritizers.setter - def prioritizers(self, prioritizers): + @label_index.setter + def label_index(self, label_index): """ - Sets the prioritizers of this VersionedConnection. - The comparators used to prioritize the queue. + Sets the label_index of this VersionedConnection. + The index of the bend point where to place the connection label. - :param prioritizers: The prioritizers of this VersionedConnection. - :type: list[str] + :param label_index: The label_index of this VersionedConnection. + :type: int """ - self._prioritizers = prioritizers + self._label_index = label_index @property - def bends(self): + def load_balance_compression(self): """ - Gets the bends of this VersionedConnection. - The bend points on the connection. + Gets the load_balance_compression of this VersionedConnection. + Whether or not compression should be used when transferring FlowFiles between nodes - :return: The bends of this VersionedConnection. - :rtype: list[Position] + :return: The load_balance_compression of this VersionedConnection. + :rtype: str """ - return self._bends + return self._load_balance_compression - @bends.setter - def bends(self, bends): + @load_balance_compression.setter + def load_balance_compression(self, load_balance_compression): """ - Sets the bends of this VersionedConnection. - The bend points on the connection. + Sets the load_balance_compression of this VersionedConnection. + Whether or not compression should be used when transferring FlowFiles between nodes - :param bends: The bends of this VersionedConnection. - :type: list[Position] + :param load_balance_compression: The load_balance_compression of this VersionedConnection. + :type: str """ + allowed_values = ["DO_NOT_COMPRESS", "COMPRESS_ATTRIBUTES_ONLY", "COMPRESS_ATTRIBUTES_AND_CONTENT", ] + if load_balance_compression not in allowed_values: + raise ValueError( + "Invalid value for `load_balance_compression` ({0}), must be one of {1}" + .format(load_balance_compression, allowed_values) + ) - self._bends = bends + self._load_balance_compression = load_balance_compression @property def load_balance_strategy(self): @@ -505,7 +441,7 @@ def load_balance_strategy(self, load_balance_strategy): :param load_balance_strategy: The load_balance_strategy of this VersionedConnection. :type: str """ - allowed_values = ["DO_NOT_LOAD_BALANCE", "PARTITION_BY_ATTRIBUTE", "ROUND_ROBIN", "SINGLE_NODE"] + allowed_values = ["DO_NOT_LOAD_BALANCE", "PARTITION_BY_ATTRIBUTE", "ROUND_ROBIN", "SINGLE_NODE", ] if load_balance_strategy not in allowed_values: raise ValueError( "Invalid value for `load_balance_strategy` ({0}), must be one of {1}" @@ -514,6 +450,29 @@ def load_balance_strategy(self, load_balance_strategy): self._load_balance_strategy = load_balance_strategy + @property + def name(self): + """ + Gets the name of this VersionedConnection. + The component's name + + :return: The name of this VersionedConnection. + :rtype: str + """ + return self._name + + @name.setter + def name(self, name): + """ + Sets the name of this VersionedConnection. + The component's name + + :param name: The name of this VersionedConnection. + :type: str + """ + + self._name = name + @property def partitioning_attribute(self): """ @@ -538,83 +497,115 @@ def partitioning_attribute(self, partitioning_attribute): self._partitioning_attribute = partitioning_attribute @property - def load_balance_compression(self): + def position(self): """ - Gets the load_balance_compression of this VersionedConnection. - Whether or not compression should be used when transferring FlowFiles between nodes + Gets the position of this VersionedConnection. - :return: The load_balance_compression of this VersionedConnection. - :rtype: str + :return: The position of this VersionedConnection. + :rtype: Position """ - return self._load_balance_compression + return self._position - @load_balance_compression.setter - def load_balance_compression(self, load_balance_compression): + @position.setter + def position(self, position): """ - Sets the load_balance_compression of this VersionedConnection. - Whether or not compression should be used when transferring FlowFiles between nodes + Sets the position of this VersionedConnection. - :param load_balance_compression: The load_balance_compression of this VersionedConnection. - :type: str + :param position: The position of this VersionedConnection. + :type: Position """ - allowed_values = ["DO_NOT_COMPRESS", "COMPRESS_ATTRIBUTES_ONLY", "COMPRESS_ATTRIBUTES_AND_CONTENT"] - if load_balance_compression not in allowed_values: - raise ValueError( - "Invalid value for `load_balance_compression` ({0}), must be one of {1}" - .format(load_balance_compression, allowed_values) - ) - self._load_balance_compression = load_balance_compression + self._position = position @property - def component_type(self): + def prioritizers(self): """ - Gets the component_type of this VersionedConnection. + Gets the prioritizers of this VersionedConnection. + The comparators used to prioritize the queue. - :return: The component_type of this VersionedConnection. - :rtype: str + :return: The prioritizers of this VersionedConnection. + :rtype: list[str] """ - return self._component_type + return self._prioritizers - @component_type.setter - def component_type(self, component_type): + @prioritizers.setter + def prioritizers(self, prioritizers): """ - Sets the component_type of this VersionedConnection. + Sets the prioritizers of this VersionedConnection. + The comparators used to prioritize the queue. - :param component_type: The component_type of this VersionedConnection. - :type: str + :param prioritizers: The prioritizers of this VersionedConnection. + :type: list[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", "PARAMETER_CONTEXT", "PARAMETER_PROVIDER", "TEMPLATE", "FLOW_REGISTRY_CLIENT"] - 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 + self._prioritizers = prioritizers @property - def group_identifier(self): + def selected_relationships(self): """ - Gets the group_identifier of this VersionedConnection. - The ID of the Process Group that this component belongs to + Gets the selected_relationships of this VersionedConnection. + The selected relationship that comprise the connection. - :return: The group_identifier of this VersionedConnection. - :rtype: str + :return: The selected_relationships of this VersionedConnection. + :rtype: list[str] """ - return self._group_identifier + return self._selected_relationships - @group_identifier.setter - def group_identifier(self, group_identifier): + @selected_relationships.setter + def selected_relationships(self, selected_relationships): """ - Sets the group_identifier of this VersionedConnection. - The ID of the Process Group that this component belongs to + Sets the selected_relationships of this VersionedConnection. + The selected relationship that comprise the connection. - :param group_identifier: The group_identifier of this VersionedConnection. - :type: str + :param selected_relationships: The selected_relationships of this VersionedConnection. + :type: list[str] """ - self._group_identifier = group_identifier + self._selected_relationships = selected_relationships + + @property + def source(self): + """ + Gets the source of this VersionedConnection. + + :return: The source of this VersionedConnection. + :rtype: ConnectableComponent + """ + return self._source + + @source.setter + def source(self, source): + """ + Sets the source of this VersionedConnection. + + :param source: The source of this VersionedConnection. + :type: ConnectableComponent + """ + + self._source = source + + @property + def z_index(self): + """ + Gets the z_index of this VersionedConnection. + The z index of the connection. + + :return: The z_index of this VersionedConnection. + :rtype: int + """ + return self._z_index + + @z_index.setter + def z_index(self, z_index): + """ + Sets the z_index of this VersionedConnection. + The z index of the connection. + + :param z_index: The z_index of this VersionedConnection. + :type: int + """ + + self._z_index = z_index def to_dict(self): """ diff --git a/nipyapi/registry/models/versioned_controller_service.py b/nipyapi/registry/models/versioned_controller_service.py index 870c40b6..4ef701d4 100644 --- a/nipyapi/registry/models/versioned_controller_service.py +++ b/nipyapi/registry/models/versioned_controller_service.py @@ -1,14 +1,13 @@ """ Apache NiFi Registry REST API - The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components. + REST API definition for Apache NiFi Registry web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,92 +27,253 @@ class VersionedControllerService(object): and the value is json key in definition. """ swagger_types = { - 'identifier': 'str', - 'instance_identifier': 'str', - 'name': 'str', - 'comments': 'str', - 'position': 'Position', - 'type': 'str', - 'bundle': 'Bundle', - 'properties': 'dict(str, str)', - 'property_descriptors': 'dict(str, VersionedPropertyDescriptor)', - 'controller_service_apis': 'list[ControllerServiceAPI]', 'annotation_data': 'str', - 'scheduled_state': 'str', - 'bulletin_level': 'str', - 'component_type': 'str', - 'group_identifier': 'str' - } +'bulletin_level': 'str', +'bundle': 'Bundle', +'comments': 'str', +'component_type': 'str', +'controller_service_apis': 'list[ControllerServiceAPI]', +'group_identifier': 'str', +'identifier': 'str', +'instance_identifier': 'str', +'name': 'str', +'position': 'Position', +'properties': 'dict(str, str)', +'property_descriptors': 'dict(str, VersionedPropertyDescriptor)', +'scheduled_state': 'str', +'type': 'str' } attribute_map = { - 'identifier': 'identifier', - 'instance_identifier': 'instanceIdentifier', - 'name': 'name', - 'comments': 'comments', - 'position': 'position', - 'type': 'type', - 'bundle': 'bundle', - 'properties': 'properties', - 'property_descriptors': 'propertyDescriptors', - 'controller_service_apis': 'controllerServiceApis', 'annotation_data': 'annotationData', - 'scheduled_state': 'scheduledState', - 'bulletin_level': 'bulletinLevel', - 'component_type': 'componentType', - 'group_identifier': 'groupIdentifier' - } - - def __init__(self, identifier=None, instance_identifier=None, name=None, comments=None, position=None, type=None, bundle=None, properties=None, property_descriptors=None, controller_service_apis=None, annotation_data=None, scheduled_state=None, bulletin_level=None, component_type=None, group_identifier=None): +'bulletin_level': 'bulletinLevel', +'bundle': 'bundle', +'comments': 'comments', +'component_type': 'componentType', +'controller_service_apis': 'controllerServiceApis', +'group_identifier': 'groupIdentifier', +'identifier': 'identifier', +'instance_identifier': 'instanceIdentifier', +'name': 'name', +'position': 'position', +'properties': 'properties', +'property_descriptors': 'propertyDescriptors', +'scheduled_state': 'scheduledState', +'type': 'type' } + + def __init__(self, annotation_data=None, bulletin_level=None, bundle=None, comments=None, component_type=None, controller_service_apis=None, group_identifier=None, identifier=None, instance_identifier=None, name=None, position=None, properties=None, property_descriptors=None, scheduled_state=None, type=None): """ VersionedControllerService - a model defined in Swagger """ + self._annotation_data = None + self._bulletin_level = None + self._bundle = None + self._comments = None + self._component_type = None + self._controller_service_apis = None + self._group_identifier = None self._identifier = None self._instance_identifier = None self._name = None - self._comments = None self._position = None - self._type = None - self._bundle = None self._properties = None self._property_descriptors = None - self._controller_service_apis = None - self._annotation_data = None self._scheduled_state = None - self._bulletin_level = None - self._component_type = None - self._group_identifier = None + self._type = None + if annotation_data is not None: + self.annotation_data = annotation_data + if bulletin_level is not None: + self.bulletin_level = bulletin_level + if bundle is not None: + self.bundle = bundle + if comments is not None: + self.comments = comments + if component_type is not None: + self.component_type = component_type + if controller_service_apis is not None: + self.controller_service_apis = controller_service_apis + if group_identifier is not None: + self.group_identifier = group_identifier if identifier is not None: self.identifier = identifier if instance_identifier is not None: self.instance_identifier = instance_identifier if name is not None: self.name = name - if comments is not None: - self.comments = comments if position is not None: self.position = position - if type is not None: - self.type = type - if bundle is not None: - self.bundle = bundle if properties is not None: self.properties = properties if property_descriptors is not None: self.property_descriptors = property_descriptors - if controller_service_apis is not None: - self.controller_service_apis = controller_service_apis - if annotation_data is not None: - self.annotation_data = annotation_data if scheduled_state is not None: self.scheduled_state = scheduled_state - if bulletin_level is not None: - self.bulletin_level = bulletin_level - if component_type is not None: - self.component_type = component_type - if group_identifier is not None: - self.group_identifier = group_identifier + if type is not None: + self.type = type + + @property + def annotation_data(self): + """ + Gets the annotation_data of this VersionedControllerService. + The annotation for the controller service. This is how the custom UI relays configuration to the controller service. + + :return: The annotation_data of this VersionedControllerService. + :rtype: str + """ + return self._annotation_data + + @annotation_data.setter + def annotation_data(self, annotation_data): + """ + Sets the annotation_data of this VersionedControllerService. + The annotation for the controller service. This is how the custom UI relays configuration to the controller service. + + :param annotation_data: The annotation_data of this VersionedControllerService. + :type: str + """ + + self._annotation_data = annotation_data + + @property + def bulletin_level(self): + """ + Gets the bulletin_level of this VersionedControllerService. + The level at which the controller service will report bulletins. + + :return: The bulletin_level of this VersionedControllerService. + :rtype: str + """ + return self._bulletin_level + + @bulletin_level.setter + def bulletin_level(self, bulletin_level): + """ + Sets the bulletin_level of this VersionedControllerService. + The level at which the controller service will report bulletins. + + :param bulletin_level: The bulletin_level of this VersionedControllerService. + :type: str + """ + + self._bulletin_level = bulletin_level + + @property + def bundle(self): + """ + Gets the bundle of this VersionedControllerService. + + :return: The bundle of this VersionedControllerService. + :rtype: Bundle + """ + return self._bundle + + @bundle.setter + def bundle(self, bundle): + """ + Sets the bundle of this VersionedControllerService. + + :param bundle: The bundle of this VersionedControllerService. + :type: Bundle + """ + + self._bundle = bundle + + @property + def comments(self): + """ + Gets the comments of this VersionedControllerService. + The user-supplied comments for the component + + :return: The comments of this VersionedControllerService. + :rtype: str + """ + return self._comments + + @comments.setter + def comments(self, comments): + """ + Sets the comments of this VersionedControllerService. + The user-supplied comments for the component + + :param comments: The comments of this VersionedControllerService. + :type: str + """ + + self._comments = comments + + @property + def component_type(self): + """ + Gets the component_type of this VersionedControllerService. + + :return: The component_type of this VersionedControllerService. + :rtype: str + """ + return self._component_type + + @component_type.setter + def component_type(self, component_type): + """ + Sets the component_type of this VersionedControllerService. + + :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", ] + 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 + + @property + def controller_service_apis(self): + """ + Gets the controller_service_apis of this VersionedControllerService. + Lists the APIs this Controller Service implements. + + :return: The controller_service_apis of this VersionedControllerService. + :rtype: list[ControllerServiceAPI] + """ + return self._controller_service_apis + + @controller_service_apis.setter + def controller_service_apis(self, controller_service_apis): + """ + Sets the controller_service_apis of this VersionedControllerService. + Lists the APIs this Controller Service implements. + + :param controller_service_apis: The controller_service_apis of this VersionedControllerService. + :type: list[ControllerServiceAPI] + """ + + self._controller_service_apis = controller_service_apis + + @property + def group_identifier(self): + """ + Gets the group_identifier of this VersionedControllerService. + The ID of the Process Group that this component belongs to + + :return: The group_identifier of this VersionedControllerService. + :rtype: str + """ + return self._group_identifier + + @group_identifier.setter + def group_identifier(self, group_identifier): + """ + Sets the group_identifier of this VersionedControllerService. + The ID of the Process Group that this component belongs to + + :param group_identifier: The group_identifier of this VersionedControllerService. + :type: str + """ + + self._group_identifier = group_identifier @property def identifier(self): @@ -184,34 +344,10 @@ def name(self, name): self._name = name - @property - def comments(self): - """ - Gets the comments of this VersionedControllerService. - The user-supplied comments for the component - - :return: The comments of this VersionedControllerService. - :rtype: str - """ - return self._comments - - @comments.setter - def comments(self, comments): - """ - Sets the comments of this VersionedControllerService. - The user-supplied comments for the component - - :param comments: The comments of this VersionedControllerService. - :type: str - """ - - self._comments = comments - @property def position(self): """ Gets the position of this VersionedControllerService. - The component's position on the graph :return: The position of this VersionedControllerService. :rtype: Position @@ -222,7 +358,6 @@ def position(self): def position(self, position): """ Sets the position of this VersionedControllerService. - The component's position on the graph :param position: The position of this VersionedControllerService. :type: Position @@ -230,52 +365,6 @@ def position(self, position): self._position = position - @property - def type(self): - """ - Gets the type of this VersionedControllerService. - The type of the extension component - - :return: The type of this VersionedControllerService. - :rtype: str - """ - return self._type - - @type.setter - def type(self, type): - """ - Sets the type of this VersionedControllerService. - The type of the extension component - - :param type: The type of this VersionedControllerService. - :type: str - """ - - self._type = type - - @property - def bundle(self): - """ - Gets the bundle of this VersionedControllerService. - Information about the bundle from which the component came - - :return: The bundle of this VersionedControllerService. - :rtype: Bundle - """ - return self._bundle - - @bundle.setter - def bundle(self, bundle): - """ - Sets the bundle of this VersionedControllerService. - Information about the bundle from which the component came - - :param bundle: The bundle of this VersionedControllerService. - :type: Bundle - """ - - self._bundle = bundle - @property def properties(self): """ @@ -322,52 +411,6 @@ def property_descriptors(self, property_descriptors): self._property_descriptors = property_descriptors - @property - def controller_service_apis(self): - """ - Gets the controller_service_apis of this VersionedControllerService. - Lists the APIs this Controller Service implements. - - :return: The controller_service_apis of this VersionedControllerService. - :rtype: list[ControllerServiceAPI] - """ - return self._controller_service_apis - - @controller_service_apis.setter - def controller_service_apis(self, controller_service_apis): - """ - Sets the controller_service_apis of this VersionedControllerService. - Lists the APIs this Controller Service implements. - - :param controller_service_apis: The controller_service_apis of this VersionedControllerService. - :type: list[ControllerServiceAPI] - """ - - self._controller_service_apis = controller_service_apis - - @property - def annotation_data(self): - """ - Gets the annotation_data of this VersionedControllerService. - The annotation for the controller service. This is how the custom UI relays configuration to the controller service. - - :return: The annotation_data of this VersionedControllerService. - :rtype: str - """ - return self._annotation_data - - @annotation_data.setter - def annotation_data(self, annotation_data): - """ - Sets the annotation_data of this VersionedControllerService. - The annotation for the controller service. This is how the custom UI relays configuration to the controller service. - - :param annotation_data: The annotation_data of this VersionedControllerService. - :type: str - """ - - self._annotation_data = annotation_data - @property def scheduled_state(self): """ @@ -388,7 +431,7 @@ def scheduled_state(self, scheduled_state): :param scheduled_state: The scheduled_state of this VersionedControllerService. :type: str """ - allowed_values = ["ENABLED", "DISABLED", "RUNNING"] + 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}" @@ -398,77 +441,27 @@ def scheduled_state(self, scheduled_state): self._scheduled_state = scheduled_state @property - def bulletin_level(self): - """ - Gets the bulletin_level of this VersionedControllerService. - The level at which the controller service will report bulletins. - - :return: The bulletin_level of this VersionedControllerService. - :rtype: str - """ - return self._bulletin_level - - @bulletin_level.setter - def bulletin_level(self, bulletin_level): - """ - Sets the bulletin_level of this VersionedControllerService. - The level at which the controller service will report bulletins. - - :param bulletin_level: The bulletin_level of this VersionedControllerService. - :type: str - """ - - self._bulletin_level = bulletin_level - - @property - def component_type(self): - """ - Gets the component_type of this VersionedControllerService. - - :return: The component_type of this VersionedControllerService. - :rtype: str - """ - return self._component_type - - @component_type.setter - def component_type(self, component_type): - """ - Sets the component_type of this VersionedControllerService. - - :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", "PARAMETER_CONTEXT", "PARAMETER_PROVIDER", "TEMPLATE", "FLOW_REGISTRY_CLIENT"] - 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 - - @property - def group_identifier(self): + def type(self): """ - Gets the group_identifier of this VersionedControllerService. - The ID of the Process Group that this component belongs to + Gets the type of this VersionedControllerService. + The type of the extension component - :return: The group_identifier of this VersionedControllerService. + :return: The type of this VersionedControllerService. :rtype: str """ - return self._group_identifier + return self._type - @group_identifier.setter - def group_identifier(self, group_identifier): + @type.setter + def type(self, type): """ - Sets the group_identifier of this VersionedControllerService. - The ID of the Process Group that this component belongs to + Sets the type of this VersionedControllerService. + The type of the extension component - :param group_identifier: The group_identifier of this VersionedControllerService. + :param type: The type of this VersionedControllerService. :type: str """ - self._group_identifier = group_identifier + self._type = type def to_dict(self): """ diff --git a/nipyapi/registry/models/versioned_flow.py b/nipyapi/registry/models/versioned_flow.py index 22472d92..c61f1e6a 100644 --- a/nipyapi/registry/models/versioned_flow.py +++ b/nipyapi/registry/models/versioned_flow.py @@ -1,14 +1,13 @@ """ Apache NiFi Registry REST API - The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components. + REST API definition for Apache NiFi Registry web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,145 +27,142 @@ class VersionedFlow(object): and the value is json key in definition. """ swagger_types = { - 'link': 'JaxbLink', - 'identifier': 'str', - 'name': 'str', - 'description': 'str', 'bucket_identifier': 'str', - 'bucket_name': 'str', - 'created_timestamp': 'int', - 'modified_timestamp': 'int', - 'type': 'str', - 'permissions': 'Permissions', - 'version_count': 'int', - 'revision': 'RevisionInfo' - } +'bucket_name': 'str', +'created_timestamp': 'int', +'description': 'str', +'identifier': 'str', +'link': 'Link', +'modified_timestamp': 'int', +'name': 'str', +'permissions': 'Permissions', +'revision': 'RevisionInfo', +'type': 'str', +'version_count': 'int' } attribute_map = { - 'link': 'link', - 'identifier': 'identifier', - 'name': 'name', - 'description': 'description', 'bucket_identifier': 'bucketIdentifier', - 'bucket_name': 'bucketName', - 'created_timestamp': 'createdTimestamp', - 'modified_timestamp': 'modifiedTimestamp', - 'type': 'type', - 'permissions': 'permissions', - 'version_count': 'versionCount', - 'revision': 'revision' - } - - def __init__(self, link=None, identifier=None, name=None, description=None, bucket_identifier=None, bucket_name=None, created_timestamp=None, modified_timestamp=None, type=None, permissions=None, version_count=None, revision=None): +'bucket_name': 'bucketName', +'created_timestamp': 'createdTimestamp', +'description': 'description', +'identifier': 'identifier', +'link': 'link', +'modified_timestamp': 'modifiedTimestamp', +'name': 'name', +'permissions': 'permissions', +'revision': 'revision', +'type': 'type', +'version_count': 'versionCount' } + + def __init__(self, bucket_identifier=None, bucket_name=None, created_timestamp=None, description=None, identifier=None, link=None, modified_timestamp=None, name=None, permissions=None, revision=None, type=None, version_count=None): """ VersionedFlow - a model defined in Swagger """ - self._link = None - self._identifier = None - self._name = None - self._description = None self._bucket_identifier = None self._bucket_name = None self._created_timestamp = None + self._description = None + self._identifier = None + self._link = None self._modified_timestamp = None - self._type = None + self._name = None self._permissions = None - self._version_count = None self._revision = None + self._type = None + self._version_count = None - if link is not None: - self.link = link - if identifier is not None: - self.identifier = identifier - self.name = name - if description is not None: - self.description = description self.bucket_identifier = bucket_identifier if bucket_name is not None: self.bucket_name = bucket_name if created_timestamp is not None: self.created_timestamp = created_timestamp + if description is not None: + self.description = description + self.identifier = identifier + if link is not None: + self.link = link if modified_timestamp is not None: self.modified_timestamp = modified_timestamp - self.type = type + self.name = name if permissions is not None: self.permissions = permissions - if version_count is not None: - self.version_count = version_count if revision is not None: self.revision = revision + self.type = type + if version_count is not None: + self.version_count = version_count @property - def link(self): + def bucket_identifier(self): """ - Gets the link of this VersionedFlow. - An WebLink to this entity. + Gets the bucket_identifier of this VersionedFlow. + The identifier of the bucket this items belongs to. This cannot be changed after the item is created. - :return: The link of this VersionedFlow. - :rtype: JaxbLink + :return: The bucket_identifier of this VersionedFlow. + :rtype: str """ - return self._link + return self._bucket_identifier - @link.setter - def link(self, link): + @bucket_identifier.setter + def bucket_identifier(self, bucket_identifier): """ - Sets the link of this VersionedFlow. - An WebLink to this entity. + Sets the bucket_identifier of this VersionedFlow. + The identifier of the bucket this items belongs to. This cannot be changed after the item is created. - :param link: The link of this VersionedFlow. - :type: JaxbLink + :param bucket_identifier: The bucket_identifier of this VersionedFlow. + :type: str """ + if bucket_identifier is None: + raise ValueError("Invalid value for `bucket_identifier`, must not be `None`") - self._link = link + self._bucket_identifier = bucket_identifier @property - def identifier(self): + def bucket_name(self): """ - Gets the identifier of this VersionedFlow. - An ID to uniquely identify this object. + Gets the bucket_name of this VersionedFlow. + The name of the bucket this items belongs to. - :return: The identifier of this VersionedFlow. + :return: The bucket_name of this VersionedFlow. :rtype: str """ - return self._identifier + return self._bucket_name - @identifier.setter - def identifier(self, identifier): + @bucket_name.setter + def bucket_name(self, bucket_name): """ - Sets the identifier of this VersionedFlow. - An ID to uniquely identify this object. + Sets the bucket_name of this VersionedFlow. + The name of the bucket this items belongs to. - :param identifier: The identifier of this VersionedFlow. + :param bucket_name: The bucket_name of this VersionedFlow. :type: str """ - self._identifier = identifier + self._bucket_name = bucket_name @property - def name(self): + def created_timestamp(self): """ - Gets the name of this VersionedFlow. - The name of the item. + Gets the created_timestamp of this VersionedFlow. + The timestamp of when the item was created, as milliseconds since epoch. - :return: The name of this VersionedFlow. - :rtype: str + :return: The created_timestamp of this VersionedFlow. + :rtype: int """ - return self._name + return self._created_timestamp - @name.setter - def name(self, name): + @created_timestamp.setter + def created_timestamp(self, created_timestamp): """ - Sets the name of this VersionedFlow. - The name of the item. + Sets the created_timestamp of this VersionedFlow. + The timestamp of when the item was created, as milliseconds since epoch. - :param name: The name of this VersionedFlow. - :type: str + :param created_timestamp: The created_timestamp of this VersionedFlow. + :type: int """ - if name is None: - raise ValueError("Invalid value for `name`, must not be `None`") - self._name = name + self._created_timestamp = created_timestamp @property def description(self): @@ -192,77 +188,48 @@ def description(self, description): self._description = description @property - def bucket_identifier(self): - """ - Gets the bucket_identifier of this VersionedFlow. - The identifier of the bucket this items belongs to. This cannot be changed after the item is created. - - :return: The bucket_identifier of this VersionedFlow. - :rtype: str - """ - return self._bucket_identifier - - @bucket_identifier.setter - def bucket_identifier(self, bucket_identifier): - """ - Sets the bucket_identifier of this VersionedFlow. - The identifier of the bucket this items belongs to. This cannot be changed after the item is created. - - :param bucket_identifier: The bucket_identifier of this VersionedFlow. - :type: str - """ - if bucket_identifier is None: - raise ValueError("Invalid value for `bucket_identifier`, must not be `None`") - - self._bucket_identifier = bucket_identifier - - @property - def bucket_name(self): + def identifier(self): """ - Gets the bucket_name of this VersionedFlow. - The name of the bucket this items belongs to. + Gets the identifier of this VersionedFlow. + An ID to uniquely identify this object. - :return: The bucket_name of this VersionedFlow. + :return: The identifier of this VersionedFlow. :rtype: str """ - return self._bucket_name + return self._identifier - @bucket_name.setter - def bucket_name(self, bucket_name): + @identifier.setter + def identifier(self, identifier): """ - Sets the bucket_name of this VersionedFlow. - The name of the bucket this items belongs to. + Sets the identifier of this VersionedFlow. + An ID to uniquely identify this object. - :param bucket_name: The bucket_name of this VersionedFlow. + :param identifier: The identifier of this VersionedFlow. :type: str """ - self._bucket_name = bucket_name + self._identifier = identifier @property - def created_timestamp(self): + def link(self): """ - Gets the created_timestamp of this VersionedFlow. - The timestamp of when the item was created, as milliseconds since epoch. + Gets the link of this VersionedFlow. - :return: The created_timestamp of this VersionedFlow. - :rtype: int + :return: The link of this VersionedFlow. + :rtype: Link """ - return self._created_timestamp + return self._link - @created_timestamp.setter - def created_timestamp(self, created_timestamp): + @link.setter + def link(self, link): """ - Sets the created_timestamp of this VersionedFlow. - The timestamp of when the item was created, as milliseconds since epoch. + Sets the link of this VersionedFlow. - :param created_timestamp: The created_timestamp of this VersionedFlow. - :type: int + :param link: The link of this VersionedFlow. + :type: Link """ - if created_timestamp is not None and created_timestamp < 1: - raise ValueError("Invalid value for `created_timestamp`, must be a value greater than or equal to `1`") - self._created_timestamp = created_timestamp + self._link = link @property def modified_timestamp(self): @@ -284,47 +251,38 @@ def modified_timestamp(self, modified_timestamp): :param modified_timestamp: The modified_timestamp of this VersionedFlow. :type: int """ - if modified_timestamp is not None and modified_timestamp < 1: - raise ValueError("Invalid value for `modified_timestamp`, must be a value greater than or equal to `1`") self._modified_timestamp = modified_timestamp @property - def type(self): + def name(self): """ - Gets the type of this VersionedFlow. - The type of item. + Gets the name of this VersionedFlow. + The name of the item. - :return: The type of this VersionedFlow. + :return: The name of this VersionedFlow. :rtype: str """ - return self._type + return self._name - @type.setter - def type(self, type): + @name.setter + def name(self, name): """ - Sets the type of this VersionedFlow. - The type of item. + Sets the name of this VersionedFlow. + The name of the item. - :param type: The type of this VersionedFlow. + :param name: The name of this VersionedFlow. :type: str """ - if type is None: - raise ValueError("Invalid value for `type`, must not be `None`") - allowed_values = ["Flow", "Bundle"] - if type not in allowed_values: - raise ValueError( - "Invalid value for `type` ({0}), must be one of {1}" - .format(type, allowed_values) - ) + if name is None: + raise ValueError("Invalid value for `name`, must not be `None`") - self._type = type + self._name = name @property def permissions(self): """ Gets the permissions of this VersionedFlow. - The access that the current user has to the bucket containing this item. :return: The permissions of this VersionedFlow. :rtype: Permissions @@ -335,7 +293,6 @@ def permissions(self): def permissions(self, permissions): """ Sets the permissions of this VersionedFlow. - The access that the current user has to the bucket containing this item. :param permissions: The permissions of this VersionedFlow. :type: Permissions @@ -343,6 +300,58 @@ def permissions(self, permissions): self._permissions = permissions + @property + def revision(self): + """ + Gets the revision of this VersionedFlow. + + :return: The revision of this VersionedFlow. + :rtype: RevisionInfo + """ + return self._revision + + @revision.setter + def revision(self, revision): + """ + Sets the revision of this VersionedFlow. + + :param revision: The revision of this VersionedFlow. + :type: RevisionInfo + """ + + self._revision = revision + + @property + def type(self): + """ + Gets the type of this VersionedFlow. + The type of item. + + :return: The type of this VersionedFlow. + :rtype: str + """ + return self._type + + @type.setter + def type(self, type): + """ + Sets the type of this VersionedFlow. + The type of item. + + :param type: The type of this VersionedFlow. + :type: str + """ + if type is None: + raise ValueError("Invalid value for `type`, must not be `None`") + allowed_values = ["Flow", "Bundle", ] + if type not in allowed_values: + raise ValueError( + "Invalid value for `type` ({0}), must be one of {1}" + .format(type, allowed_values) + ) + + self._type = type + @property def version_count(self): """ @@ -363,34 +372,9 @@ def version_count(self, version_count): :param version_count: The version_count of this VersionedFlow. :type: int """ - if version_count is not None and version_count < 0: - raise ValueError("Invalid value for `version_count`, must be a value greater than or equal to `0`") self._version_count = version_count - @property - def revision(self): - """ - Gets the revision of this VersionedFlow. - The revision of this entity used for optimistic-locking during updates. - - :return: The revision of this VersionedFlow. - :rtype: RevisionInfo - """ - return self._revision - - @revision.setter - def revision(self, revision): - """ - Sets the revision of this VersionedFlow. - The revision of this entity used for optimistic-locking during updates. - - :param revision: The revision of this VersionedFlow. - :type: RevisionInfo - """ - - self._revision = revision - def to_dict(self): """ Returns the model properties as a dict diff --git a/nipyapi/registry/models/versioned_flow_coordinates.py b/nipyapi/registry/models/versioned_flow_coordinates.py index 414a8f8d..b72dfe29 100644 --- a/nipyapi/registry/models/versioned_flow_coordinates.py +++ b/nipyapi/registry/models/versioned_flow_coordinates.py @@ -1,14 +1,13 @@ """ Apache NiFi Registry REST API - The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components. + REST API definition for Apache NiFi Registry web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,121 +27,73 @@ class VersionedFlowCoordinates(object): and the value is json key in definition. """ swagger_types = { - 'registry_id': 'str', - 'storage_location': 'str', - 'registry_url': 'str', - 'bucket_id': 'str', - 'flow_id': 'str', - 'version': 'int', - 'latest': 'bool' - } + 'branch': 'str', +'bucket_id': 'str', +'flow_id': 'str', +'latest': 'bool', +'registry_id': 'str', +'storage_location': 'str', +'version': 'str' } attribute_map = { - 'registry_id': 'registryId', - 'storage_location': 'storageLocation', - 'registry_url': 'registryUrl', - 'bucket_id': 'bucketId', - 'flow_id': 'flowId', - 'version': 'version', - 'latest': 'latest' - } + 'branch': 'branch', +'bucket_id': 'bucketId', +'flow_id': 'flowId', +'latest': 'latest', +'registry_id': 'registryId', +'storage_location': 'storageLocation', +'version': 'version' } - def __init__(self, registry_id=None, storage_location=None, registry_url=None, bucket_id=None, flow_id=None, version=None, latest=None): + def __init__(self, branch=None, bucket_id=None, flow_id=None, latest=None, registry_id=None, storage_location=None, version=None): """ VersionedFlowCoordinates - a model defined in Swagger """ - self._registry_id = None - self._storage_location = None - self._registry_url = None + self._branch = None self._bucket_id = None self._flow_id = None - self._version = None self._latest = None + self._registry_id = None + self._storage_location = None + self._version = None - if registry_id is not None: - self.registry_id = registry_id - if storage_location is not None: - self.storage_location = storage_location - if registry_url is not None: - self.registry_url = registry_url + if branch is not None: + self.branch = branch if bucket_id is not None: self.bucket_id = bucket_id if flow_id is not None: self.flow_id = flow_id - if version is not None: - self.version = version if latest is not None: self.latest = latest + if registry_id is not None: + self.registry_id = registry_id + if storage_location is not None: + self.storage_location = storage_location + if version is not None: + self.version = version @property - def registry_id(self): - """ - Gets the registry_id of this VersionedFlowCoordinates. - The identifier of the Flow Registry that contains the flow - - :return: The registry_id of this VersionedFlowCoordinates. - :rtype: str - """ - return self._registry_id - - @registry_id.setter - def registry_id(self, registry_id): - """ - Sets the registry_id of this VersionedFlowCoordinates. - The identifier of the Flow Registry that contains the flow - - :param registry_id: The registry_id of this VersionedFlowCoordinates. - :type: str - """ - - self._registry_id = registry_id - - @property - def storage_location(self): - """ - Gets the storage_location of this VersionedFlowCoordinates. - The location of the Flow Registry that stores the flow - - :return: The storage_location of this VersionedFlowCoordinates. - :rtype: str - """ - return self._storage_location - - @storage_location.setter - def storage_location(self, storage_location): - """ - Sets the storage_location of this VersionedFlowCoordinates. - The location of the Flow Registry that stores the flow - - :param storage_location: The storage_location of this VersionedFlowCoordinates. - :type: str - """ - - self._storage_location = storage_location - - @property - def registry_url(self): + def branch(self): """ - Gets the registry_url of this VersionedFlowCoordinates. - The URL of the Flow Registry that contains the flow + Gets the branch of this VersionedFlowCoordinates. + The name of the branch that the flow resides in - :return: The registry_url of this VersionedFlowCoordinates. + :return: The branch of this VersionedFlowCoordinates. :rtype: str """ - return self._registry_url + return self._branch - @registry_url.setter - def registry_url(self, registry_url): + @branch.setter + def branch(self, branch): """ - Sets the registry_url of this VersionedFlowCoordinates. - The URL of the Flow Registry that contains the flow + Sets the branch of this VersionedFlowCoordinates. + The name of the branch that the flow resides in - :param registry_url: The registry_url of this VersionedFlowCoordinates. + :param branch: The branch of this VersionedFlowCoordinates. :type: str """ - self._registry_url = registry_url + self._branch = branch @property def bucket_id(self): @@ -190,29 +141,6 @@ def flow_id(self, flow_id): self._flow_id = flow_id - @property - def version(self): - """ - Gets the version of this VersionedFlowCoordinates. - The version of the flow - - :return: The version of this VersionedFlowCoordinates. - :rtype: int - """ - return self._version - - @version.setter - def version(self, version): - """ - Sets the version of this VersionedFlowCoordinates. - The version of the flow - - :param version: The version of this VersionedFlowCoordinates. - :type: int - """ - - self._version = version - @property def latest(self): """ @@ -236,6 +164,75 @@ def latest(self, latest): self._latest = latest + @property + def registry_id(self): + """ + Gets the registry_id of this VersionedFlowCoordinates. + The identifier of the Flow Registry that contains the flow + + :return: The registry_id of this VersionedFlowCoordinates. + :rtype: str + """ + return self._registry_id + + @registry_id.setter + def registry_id(self, registry_id): + """ + Sets the registry_id of this VersionedFlowCoordinates. + The identifier of the Flow Registry that contains the flow + + :param registry_id: The registry_id of this VersionedFlowCoordinates. + :type: str + """ + + self._registry_id = registry_id + + @property + def storage_location(self): + """ + Gets the storage_location of this VersionedFlowCoordinates. + The location of the Flow Registry that stores the flow + + :return: The storage_location of this VersionedFlowCoordinates. + :rtype: str + """ + return self._storage_location + + @storage_location.setter + def storage_location(self, storage_location): + """ + Sets the storage_location of this VersionedFlowCoordinates. + The location of the Flow Registry that stores the flow + + :param storage_location: The storage_location of this VersionedFlowCoordinates. + :type: str + """ + + self._storage_location = storage_location + + @property + def version(self): + """ + Gets the version of this VersionedFlowCoordinates. + The version of the flow + + :return: The version of this VersionedFlowCoordinates. + :rtype: str + """ + return self._version + + @version.setter + def version(self, version): + """ + Sets the version of this VersionedFlowCoordinates. + The version of the flow + + :param version: The version of this VersionedFlowCoordinates. + :type: str + """ + + self._version = version + def to_dict(self): """ Returns the model properties as a dict diff --git a/nipyapi/registry/models/versioned_flow_difference.py b/nipyapi/registry/models/versioned_flow_difference.py index 1da5720c..adb7e1cd 100644 --- a/nipyapi/registry/models/versioned_flow_difference.py +++ b/nipyapi/registry/models/versioned_flow_difference.py @@ -1,14 +1,13 @@ """ Apache NiFi Registry REST API - The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components. + REST API definition for Apache NiFi Registry web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -29,41 +28,39 @@ class VersionedFlowDifference(object): """ swagger_types = { 'bucket_id': 'str', - 'flow_id': 'str', - 'version_a': 'int', - 'version_b': 'int', - 'component_difference_groups': 'list[ComponentDifferenceGroup]' - } +'component_difference_groups': 'list[ComponentDifferenceGroup]', +'flow_id': 'str', +'version_a': 'int', +'version_b': 'int' } attribute_map = { 'bucket_id': 'bucketId', - 'flow_id': 'flowId', - 'version_a': 'versionA', - 'version_b': 'versionB', - 'component_difference_groups': 'componentDifferenceGroups' - } +'component_difference_groups': 'componentDifferenceGroups', +'flow_id': 'flowId', +'version_a': 'versionA', +'version_b': 'versionB' } - def __init__(self, bucket_id=None, flow_id=None, version_a=None, version_b=None, component_difference_groups=None): + def __init__(self, bucket_id=None, component_difference_groups=None, flow_id=None, version_a=None, version_b=None): """ VersionedFlowDifference - a model defined in Swagger """ self._bucket_id = None + self._component_difference_groups = None self._flow_id = None self._version_a = None self._version_b = None - self._component_difference_groups = None if bucket_id is not None: self.bucket_id = bucket_id + if component_difference_groups is not None: + self.component_difference_groups = component_difference_groups if flow_id is not None: self.flow_id = flow_id if version_a is not None: self.version_a = version_a if version_b is not None: self.version_b = version_b - if component_difference_groups is not None: - self.component_difference_groups = component_difference_groups @property def bucket_id(self): @@ -88,6 +85,27 @@ def bucket_id(self, bucket_id): self._bucket_id = bucket_id + @property + def component_difference_groups(self): + """ + Gets the component_difference_groups of this VersionedFlowDifference. + + :return: The component_difference_groups of this VersionedFlowDifference. + :rtype: list[ComponentDifferenceGroup] + """ + return self._component_difference_groups + + @component_difference_groups.setter + def component_difference_groups(self, component_difference_groups): + """ + Sets the component_difference_groups of this VersionedFlowDifference. + + :param component_difference_groups: The component_difference_groups of this VersionedFlowDifference. + :type: list[ComponentDifferenceGroup] + """ + + self._component_difference_groups = component_difference_groups + @property def flow_id(self): """ @@ -157,27 +175,6 @@ def version_b(self, version_b): self._version_b = version_b - @property - def component_difference_groups(self): - """ - Gets the component_difference_groups of this VersionedFlowDifference. - - :return: The component_difference_groups of this VersionedFlowDifference. - :rtype: list[ComponentDifferenceGroup] - """ - return self._component_difference_groups - - @component_difference_groups.setter - def component_difference_groups(self, component_difference_groups): - """ - Sets the component_difference_groups of this VersionedFlowDifference. - - :param component_difference_groups: The component_difference_groups of this VersionedFlowDifference. - :type: list[ComponentDifferenceGroup] - """ - - self._component_difference_groups = component_difference_groups - def to_dict(self): """ Returns the model properties as a dict diff --git a/nipyapi/registry/models/versioned_flow_snapshot.py b/nipyapi/registry/models/versioned_flow_snapshot.py index 6c8ec035..b1749458 100644 --- a/nipyapi/registry/models/versioned_flow_snapshot.py +++ b/nipyapi/registry/models/versioned_flow_snapshot.py @@ -1,14 +1,13 @@ """ Apache NiFi Registry REST API - The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components. + REST API definition for Apache NiFi Registry web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,110 +27,79 @@ class VersionedFlowSnapshot(object): and the value is json key in definition. """ swagger_types = { - 'snapshot_metadata': 'VersionedFlowSnapshotMetadata', - 'flow_contents': 'VersionedProcessGroup', - 'external_controller_services': 'dict(str, ExternalControllerServiceReference)', - 'parameter_providers': 'dict(str, ParameterProviderReference)', - 'parameter_contexts': 'dict(str, VersionedParameterContext)', - 'flow_encoding_version': 'str', - 'flow': 'VersionedFlow', 'bucket': 'Bucket', - 'latest': 'bool' - } +'external_controller_services': 'dict(str, ExternalControllerServiceReference)', +'flow': 'VersionedFlow', +'flow_contents': 'VersionedProcessGroup', +'flow_encoding_version': 'str', +'latest': 'bool', +'parameter_contexts': 'dict(str, VersionedParameterContext)', +'parameter_providers': 'dict(str, ParameterProviderReference)', +'snapshot_metadata': 'VersionedFlowSnapshotMetadata' } attribute_map = { - 'snapshot_metadata': 'snapshotMetadata', - 'flow_contents': 'flowContents', - 'external_controller_services': 'externalControllerServices', - 'parameter_providers': 'parameterProviders', - 'parameter_contexts': 'parameterContexts', - 'flow_encoding_version': 'flowEncodingVersion', - 'flow': 'flow', 'bucket': 'bucket', - 'latest': 'latest' - } +'external_controller_services': 'externalControllerServices', +'flow': 'flow', +'flow_contents': 'flowContents', +'flow_encoding_version': 'flowEncodingVersion', +'latest': 'latest', +'parameter_contexts': 'parameterContexts', +'parameter_providers': 'parameterProviders', +'snapshot_metadata': 'snapshotMetadata' } - def __init__(self, snapshot_metadata=None, flow_contents=None, external_controller_services=None, parameter_providers=None, parameter_contexts=None, flow_encoding_version=None, flow=None, bucket=None, latest=None): + def __init__(self, bucket=None, external_controller_services=None, flow=None, flow_contents=None, flow_encoding_version=None, latest=None, parameter_contexts=None, parameter_providers=None, snapshot_metadata=None): """ VersionedFlowSnapshot - a model defined in Swagger """ - self._snapshot_metadata = None - self._flow_contents = None + self._bucket = None self._external_controller_services = None - self._parameter_providers = None - self._parameter_contexts = None - self._flow_encoding_version = None self._flow = None - self._bucket = None + self._flow_contents = None + self._flow_encoding_version = None self._latest = None + self._parameter_contexts = None + self._parameter_providers = None + self._snapshot_metadata = None - self.snapshot_metadata = snapshot_metadata - self.flow_contents = flow_contents + if bucket is not None: + self.bucket = bucket if external_controller_services is not None: self.external_controller_services = external_controller_services - if parameter_providers is not None: - self.parameter_providers = parameter_providers - if parameter_contexts is not None: - self.parameter_contexts = parameter_contexts - if flow_encoding_version is not None: - self.flow_encoding_version = flow_encoding_version if flow is not None: self.flow = flow - if bucket is not None: - self.bucket = bucket + self.flow_contents = flow_contents + if flow_encoding_version is not None: + self.flow_encoding_version = flow_encoding_version if latest is not None: self.latest = latest + if parameter_contexts is not None: + self.parameter_contexts = parameter_contexts + if parameter_providers is not None: + self.parameter_providers = parameter_providers + self.snapshot_metadata = snapshot_metadata @property - def snapshot_metadata(self): - """ - Gets the snapshot_metadata of this VersionedFlowSnapshot. - The metadata for this snapshot - - :return: The snapshot_metadata of this VersionedFlowSnapshot. - :rtype: VersionedFlowSnapshotMetadata - """ - return self._snapshot_metadata - - @snapshot_metadata.setter - def snapshot_metadata(self, snapshot_metadata): - """ - Sets the snapshot_metadata of this VersionedFlowSnapshot. - The metadata for this snapshot - - :param snapshot_metadata: The snapshot_metadata of this VersionedFlowSnapshot. - :type: VersionedFlowSnapshotMetadata - """ - if snapshot_metadata is None: - raise ValueError("Invalid value for `snapshot_metadata`, must not be `None`") - - self._snapshot_metadata = snapshot_metadata - - @property - def flow_contents(self): + def bucket(self): """ - Gets the flow_contents of this VersionedFlowSnapshot. - The contents of the versioned flow + Gets the bucket of this VersionedFlowSnapshot. - :return: The flow_contents of this VersionedFlowSnapshot. - :rtype: VersionedProcessGroup + :return: The bucket of this VersionedFlowSnapshot. + :rtype: Bucket """ - return self._flow_contents + return self._bucket - @flow_contents.setter - def flow_contents(self, flow_contents): + @bucket.setter + def bucket(self, bucket): """ - Sets the flow_contents of this VersionedFlowSnapshot. - The contents of the versioned flow + Sets the bucket of this VersionedFlowSnapshot. - :param flow_contents: The flow_contents of this VersionedFlowSnapshot. - :type: VersionedProcessGroup + :param bucket: The bucket of this VersionedFlowSnapshot. + :type: Bucket """ - if flow_contents is None: - raise ValueError("Invalid value for `flow_contents`, must not be `None`") - self._flow_contents = flow_contents + self._bucket = bucket @property def external_controller_services(self): @@ -157,50 +125,48 @@ def external_controller_services(self, external_controller_services): self._external_controller_services = external_controller_services @property - def parameter_providers(self): + def flow(self): """ - Gets the parameter_providers of this VersionedFlowSnapshot. - Contains basic information about parameter providers referenced in the versioned flow. + Gets the flow of this VersionedFlowSnapshot. - :return: The parameter_providers of this VersionedFlowSnapshot. - :rtype: dict(str, ParameterProviderReference) + :return: The flow of this VersionedFlowSnapshot. + :rtype: VersionedFlow """ - return self._parameter_providers + return self._flow - @parameter_providers.setter - def parameter_providers(self, parameter_providers): + @flow.setter + def flow(self, flow): """ - Sets the parameter_providers of this VersionedFlowSnapshot. - Contains basic information about parameter providers referenced in the versioned flow. + Sets the flow of this VersionedFlowSnapshot. - :param parameter_providers: The parameter_providers of this VersionedFlowSnapshot. - :type: dict(str, ParameterProviderReference) + :param flow: The flow of this VersionedFlowSnapshot. + :type: VersionedFlow """ - self._parameter_providers = parameter_providers + self._flow = flow @property - def parameter_contexts(self): + def flow_contents(self): """ - Gets the parameter_contexts of this VersionedFlowSnapshot. - The parameter contexts referenced by process groups in the flow contents. The mapping is from the name of the context to the context instance, and it is expected that any context in this map is referenced by at least one process group in this flow. + Gets the flow_contents of this VersionedFlowSnapshot. - :return: The parameter_contexts of this VersionedFlowSnapshot. - :rtype: dict(str, VersionedParameterContext) + :return: The flow_contents of this VersionedFlowSnapshot. + :rtype: VersionedProcessGroup """ - return self._parameter_contexts + return self._flow_contents - @parameter_contexts.setter - def parameter_contexts(self, parameter_contexts): + @flow_contents.setter + def flow_contents(self, flow_contents): """ - Sets the parameter_contexts of this VersionedFlowSnapshot. - The parameter contexts referenced by process groups in the flow contents. The mapping is from the name of the context to the context instance, and it is expected that any context in this map is referenced by at least one process group in this flow. + Sets the flow_contents of this VersionedFlowSnapshot. - :param parameter_contexts: The parameter_contexts of this VersionedFlowSnapshot. - :type: dict(str, VersionedParameterContext) + :param flow_contents: The flow_contents of this VersionedFlowSnapshot. + :type: VersionedProcessGroup """ + if flow_contents is None: + raise ValueError("Invalid value for `flow_contents`, must not be `None`") - self._parameter_contexts = parameter_contexts + self._flow_contents = flow_contents @property def flow_encoding_version(self): @@ -226,71 +192,94 @@ def flow_encoding_version(self, flow_encoding_version): self._flow_encoding_version = flow_encoding_version @property - def flow(self): + def latest(self): """ - Gets the flow of this VersionedFlowSnapshot. - The flow this snapshot is for + Gets the latest of this VersionedFlowSnapshot. - :return: The flow of this VersionedFlowSnapshot. - :rtype: VersionedFlow + :return: The latest of this VersionedFlowSnapshot. + :rtype: bool """ - return self._flow + return self._latest - @flow.setter - def flow(self, flow): + @latest.setter + def latest(self, latest): """ - Sets the flow of this VersionedFlowSnapshot. - The flow this snapshot is for + Sets the latest of this VersionedFlowSnapshot. - :param flow: The flow of this VersionedFlowSnapshot. - :type: VersionedFlow + :param latest: The latest of this VersionedFlowSnapshot. + :type: bool """ - self._flow = flow + self._latest = latest @property - def bucket(self): + def parameter_contexts(self): """ - Gets the bucket of this VersionedFlowSnapshot. - The bucket where the flow is located + Gets the parameter_contexts of this VersionedFlowSnapshot. + The parameter contexts referenced by process groups in the flow contents. The mapping is from the name of the context to the context instance, and it is expected that any context in this map is referenced by at least one process group in this flow. - :return: The bucket of this VersionedFlowSnapshot. - :rtype: Bucket + :return: The parameter_contexts of this VersionedFlowSnapshot. + :rtype: dict(str, VersionedParameterContext) """ - return self._bucket + return self._parameter_contexts - @bucket.setter - def bucket(self, bucket): + @parameter_contexts.setter + def parameter_contexts(self, parameter_contexts): """ - Sets the bucket of this VersionedFlowSnapshot. - The bucket where the flow is located + Sets the parameter_contexts of this VersionedFlowSnapshot. + The parameter contexts referenced by process groups in the flow contents. The mapping is from the name of the context to the context instance, and it is expected that any context in this map is referenced by at least one process group in this flow. - :param bucket: The bucket of this VersionedFlowSnapshot. - :type: Bucket + :param parameter_contexts: The parameter_contexts of this VersionedFlowSnapshot. + :type: dict(str, VersionedParameterContext) """ - self._bucket = bucket + self._parameter_contexts = parameter_contexts @property - def latest(self): + def parameter_providers(self): """ - Gets the latest of this VersionedFlowSnapshot. + Gets the parameter_providers of this VersionedFlowSnapshot. + Contains basic information about parameter providers referenced in the versioned flow. - :return: The latest of this VersionedFlowSnapshot. - :rtype: bool + :return: The parameter_providers of this VersionedFlowSnapshot. + :rtype: dict(str, ParameterProviderReference) """ - return self._latest + return self._parameter_providers - @latest.setter - def latest(self, latest): + @parameter_providers.setter + def parameter_providers(self, parameter_providers): """ - Sets the latest of this VersionedFlowSnapshot. + Sets the parameter_providers of this VersionedFlowSnapshot. + Contains basic information about parameter providers referenced in the versioned flow. - :param latest: The latest of this VersionedFlowSnapshot. - :type: bool + :param parameter_providers: The parameter_providers of this VersionedFlowSnapshot. + :type: dict(str, ParameterProviderReference) """ - self._latest = latest + self._parameter_providers = parameter_providers + + @property + def snapshot_metadata(self): + """ + Gets the snapshot_metadata of this VersionedFlowSnapshot. + + :return: The snapshot_metadata of this VersionedFlowSnapshot. + :rtype: VersionedFlowSnapshotMetadata + """ + return self._snapshot_metadata + + @snapshot_metadata.setter + def snapshot_metadata(self, snapshot_metadata): + """ + Sets the snapshot_metadata of this VersionedFlowSnapshot. + + :param snapshot_metadata: The snapshot_metadata of this VersionedFlowSnapshot. + :type: VersionedFlowSnapshotMetadata + """ + if snapshot_metadata is None: + raise ValueError("Invalid value for `snapshot_metadata`, must not be `None`") + + self._snapshot_metadata = snapshot_metadata def to_dict(self): """ diff --git a/nipyapi/registry/models/versioned_flow_snapshot_metadata.py b/nipyapi/registry/models/versioned_flow_snapshot_metadata.py index 380fd803..a19fc60f 100644 --- a/nipyapi/registry/models/versioned_flow_snapshot_metadata.py +++ b/nipyapi/registry/models/versioned_flow_snapshot_metadata.py @@ -1,14 +1,13 @@ """ Apache NiFi Registry REST API - The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components. + REST API definition for Apache NiFi Registry web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,72 +27,70 @@ class VersionedFlowSnapshotMetadata(object): and the value is json key in definition. """ swagger_types = { - 'link': 'JaxbLink', - 'bucket_identifier': 'str', - 'flow_identifier': 'str', - 'version': 'int', - 'timestamp': 'int', 'author': 'str', - 'comments': 'str' - } +'bucket_identifier': 'str', +'comments': 'str', +'flow_identifier': 'str', +'link': 'Link', +'timestamp': 'int', +'version': 'int' } attribute_map = { - 'link': 'link', - 'bucket_identifier': 'bucketIdentifier', - 'flow_identifier': 'flowIdentifier', - 'version': 'version', - 'timestamp': 'timestamp', 'author': 'author', - 'comments': 'comments' - } +'bucket_identifier': 'bucketIdentifier', +'comments': 'comments', +'flow_identifier': 'flowIdentifier', +'link': 'link', +'timestamp': 'timestamp', +'version': 'version' } - def __init__(self, link=None, bucket_identifier=None, flow_identifier=None, version=None, timestamp=None, author=None, comments=None): + def __init__(self, author=None, bucket_identifier=None, comments=None, flow_identifier=None, link=None, timestamp=None, version=None): """ VersionedFlowSnapshotMetadata - a model defined in Swagger """ - self._link = None + self._author = None self._bucket_identifier = None + self._comments = None self._flow_identifier = None - self._version = None + self._link = None self._timestamp = None - self._author = None - self._comments = None + self._version = None - if link is not None: - self.link = link + self.author = author self.bucket_identifier = bucket_identifier + if comments is not None: + self.comments = comments self.flow_identifier = flow_identifier - self.version = version + if link is not None: + self.link = link if timestamp is not None: self.timestamp = timestamp - if author is not None: - self.author = author - if comments is not None: - self.comments = comments + if version is not None: + self.version = version @property - def link(self): + def author(self): """ - Gets the link of this VersionedFlowSnapshotMetadata. - An WebLink to this entity. + Gets the author of this VersionedFlowSnapshotMetadata. + The user that created this snapshot of the flow. - :return: The link of this VersionedFlowSnapshotMetadata. - :rtype: JaxbLink + :return: The author of this VersionedFlowSnapshotMetadata. + :rtype: str """ - return self._link + return self._author - @link.setter - def link(self, link): + @author.setter + def author(self, author): """ - Sets the link of this VersionedFlowSnapshotMetadata. - An WebLink to this entity. + Sets the author of this VersionedFlowSnapshotMetadata. + The user that created this snapshot of the flow. - :param link: The link of this VersionedFlowSnapshotMetadata. - :type: JaxbLink + :param author: The author of this VersionedFlowSnapshotMetadata. + :type: str """ - self._link = link + self._author = author @property def bucket_identifier(self): @@ -120,6 +117,29 @@ def bucket_identifier(self, bucket_identifier): self._bucket_identifier = bucket_identifier + @property + def comments(self): + """ + Gets the comments of this VersionedFlowSnapshotMetadata. + The comments provided by the user when creating the snapshot. + + :return: The comments of this VersionedFlowSnapshotMetadata. + :rtype: str + """ + return self._comments + + @comments.setter + def comments(self, comments): + """ + Sets the comments of this VersionedFlowSnapshotMetadata. + The comments provided by the user when creating the snapshot. + + :param comments: The comments of this VersionedFlowSnapshotMetadata. + :type: str + """ + + self._comments = comments + @property def flow_identifier(self): """ @@ -146,31 +166,25 @@ def flow_identifier(self, flow_identifier): self._flow_identifier = flow_identifier @property - def version(self): + def link(self): """ - Gets the version of this VersionedFlowSnapshotMetadata. - The version of this snapshot of the flow. + Gets the link of this VersionedFlowSnapshotMetadata. - :return: The version of this VersionedFlowSnapshotMetadata. - :rtype: int + :return: The link of this VersionedFlowSnapshotMetadata. + :rtype: Link """ - return self._version + return self._link - @version.setter - def version(self, version): + @link.setter + def link(self, link): """ - Sets the version of this VersionedFlowSnapshotMetadata. - The version of this snapshot of the flow. + Sets the link of this VersionedFlowSnapshotMetadata. - :param version: The version of this VersionedFlowSnapshotMetadata. - :type: int + :param link: The link of this VersionedFlowSnapshotMetadata. + :type: Link """ - if version is None: - raise ValueError("Invalid value for `version`, must not be `None`") - if version is not None and version < -1: - raise ValueError("Invalid value for `version`, must be a value greater than or equal to `-1`") - self._version = version + self._link = link @property def timestamp(self): @@ -192,56 +206,31 @@ def timestamp(self, timestamp): :param timestamp: The timestamp of this VersionedFlowSnapshotMetadata. :type: int """ - if timestamp is not None and timestamp < 1: - raise ValueError("Invalid value for `timestamp`, must be a value greater than or equal to `1`") self._timestamp = timestamp @property - def author(self): - """ - Gets the author of this VersionedFlowSnapshotMetadata. - The user that created this snapshot of the flow. - - :return: The author of this VersionedFlowSnapshotMetadata. - :rtype: str - """ - return self._author - - @author.setter - def author(self, author): - """ - Sets the author of this VersionedFlowSnapshotMetadata. - The user that created this snapshot of the flow. - - :param author: The author of this VersionedFlowSnapshotMetadata. - :type: str - """ - - self._author = author - - @property - def comments(self): + def version(self): """ - Gets the comments of this VersionedFlowSnapshotMetadata. - The comments provided by the user when creating the snapshot. + Gets the version of this VersionedFlowSnapshotMetadata. + The version of this snapshot of the flow. - :return: The comments of this VersionedFlowSnapshotMetadata. - :rtype: str + :return: The version of this VersionedFlowSnapshotMetadata. + :rtype: int """ - return self._comments + return self._version - @comments.setter - def comments(self, comments): + @version.setter + def version(self, version): """ - Sets the comments of this VersionedFlowSnapshotMetadata. - The comments provided by the user when creating the snapshot. + Sets the version of this VersionedFlowSnapshotMetadata. + The version of this snapshot of the flow. - :param comments: The comments of this VersionedFlowSnapshotMetadata. - :type: str + :param version: The version of this VersionedFlowSnapshotMetadata. + :type: int """ - self._comments = comments + self._version = version def to_dict(self): """ diff --git a/nipyapi/registry/models/versioned_funnel.py b/nipyapi/registry/models/versioned_funnel.py index f1b3b03d..fd46aa95 100644 --- a/nipyapi/registry/models/versioned_funnel.py +++ b/nipyapi/registry/models/versioned_funnel.py @@ -1,14 +1,13 @@ """ Apache NiFi Registry REST API - The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components. + REST API definition for Apache NiFi Registry web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,52 +27,123 @@ class VersionedFunnel(object): and the value is json key in definition. """ swagger_types = { - 'identifier': 'str', - 'instance_identifier': 'str', - 'name': 'str', 'comments': 'str', - 'position': 'Position', - 'component_type': 'str', - 'group_identifier': 'str' - } +'component_type': 'str', +'group_identifier': 'str', +'identifier': 'str', +'instance_identifier': 'str', +'name': 'str', +'position': 'Position' } attribute_map = { - 'identifier': 'identifier', - 'instance_identifier': 'instanceIdentifier', - 'name': 'name', 'comments': 'comments', - 'position': 'position', - 'component_type': 'componentType', - 'group_identifier': 'groupIdentifier' - } +'component_type': 'componentType', +'group_identifier': 'groupIdentifier', +'identifier': 'identifier', +'instance_identifier': 'instanceIdentifier', +'name': 'name', +'position': 'position' } - def __init__(self, identifier=None, instance_identifier=None, name=None, comments=None, position=None, component_type=None, group_identifier=None): + def __init__(self, comments=None, component_type=None, group_identifier=None, identifier=None, instance_identifier=None, name=None, position=None): """ VersionedFunnel - a model defined in Swagger """ + self._comments = None + self._component_type = None + self._group_identifier = None self._identifier = None self._instance_identifier = None self._name = None - self._comments = None self._position = None - self._component_type = None - self._group_identifier = None + if comments is not None: + self.comments = comments + if component_type is not None: + self.component_type = component_type + if group_identifier is not None: + self.group_identifier = group_identifier if identifier is not None: self.identifier = identifier if instance_identifier is not None: self.instance_identifier = instance_identifier if name is not None: self.name = name - if comments is not None: - self.comments = comments if position is not None: self.position = position - if component_type is not None: - self.component_type = component_type - if group_identifier is not None: - self.group_identifier = group_identifier + + @property + def comments(self): + """ + Gets the comments of this VersionedFunnel. + The user-supplied comments for the component + + :return: The comments of this VersionedFunnel. + :rtype: str + """ + return self._comments + + @comments.setter + def comments(self, comments): + """ + Sets the comments of this VersionedFunnel. + The user-supplied comments for the component + + :param comments: The comments of this VersionedFunnel. + :type: str + """ + + self._comments = comments + + @property + def component_type(self): + """ + Gets the component_type of this VersionedFunnel. + + :return: The component_type of this VersionedFunnel. + :rtype: str + """ + return self._component_type + + @component_type.setter + def component_type(self, component_type): + """ + Sets the component_type of this VersionedFunnel. + + :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", ] + 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 + + @property + def group_identifier(self): + """ + Gets the group_identifier of this VersionedFunnel. + The ID of the Process Group that this component belongs to + + :return: The group_identifier of this VersionedFunnel. + :rtype: str + """ + return self._group_identifier + + @group_identifier.setter + def group_identifier(self, group_identifier): + """ + Sets the group_identifier of this VersionedFunnel. + The ID of the Process Group that this component belongs to + + :param group_identifier: The group_identifier of this VersionedFunnel. + :type: str + """ + + self._group_identifier = group_identifier @property def identifier(self): @@ -144,34 +214,10 @@ def name(self, name): self._name = name - @property - def comments(self): - """ - Gets the comments of this VersionedFunnel. - The user-supplied comments for the component - - :return: The comments of this VersionedFunnel. - :rtype: str - """ - return self._comments - - @comments.setter - def comments(self, comments): - """ - Sets the comments of this VersionedFunnel. - The user-supplied comments for the component - - :param comments: The comments of this VersionedFunnel. - :type: str - """ - - self._comments = comments - @property def position(self): """ Gets the position of this VersionedFunnel. - The component's position on the graph :return: The position of this VersionedFunnel. :rtype: Position @@ -182,7 +228,6 @@ def position(self): def position(self, position): """ Sets the position of this VersionedFunnel. - The component's position on the graph :param position: The position of this VersionedFunnel. :type: Position @@ -190,56 +235,6 @@ def position(self, position): self._position = position - @property - def component_type(self): - """ - Gets the component_type of this VersionedFunnel. - - :return: The component_type of this VersionedFunnel. - :rtype: str - """ - return self._component_type - - @component_type.setter - def component_type(self, component_type): - """ - Sets the component_type of this VersionedFunnel. - - :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", "PARAMETER_CONTEXT", "PARAMETER_PROVIDER", "TEMPLATE", "FLOW_REGISTRY_CLIENT"] - 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 - - @property - def group_identifier(self): - """ - Gets the group_identifier of this VersionedFunnel. - The ID of the Process Group that this component belongs to - - :return: The group_identifier of this VersionedFunnel. - :rtype: str - """ - return self._group_identifier - - @group_identifier.setter - def group_identifier(self, group_identifier): - """ - Sets the group_identifier of this VersionedFunnel. - The ID of the Process Group that this component belongs to - - :param group_identifier: The group_identifier of this VersionedFunnel. - :type: str - """ - - self._group_identifier = group_identifier - def to_dict(self): """ Returns the model properties as a dict diff --git a/nipyapi/registry/models/versioned_label.py b/nipyapi/registry/models/versioned_label.py index 743a90c6..6b1c409b 100644 --- a/nipyapi/registry/models/versioned_label.py +++ b/nipyapi/registry/models/versioned_label.py @@ -1,14 +1,13 @@ """ Apache NiFi Registry REST API - The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components. + REST API definition for Apache NiFi Registry web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,192 +27,217 @@ class VersionedLabel(object): and the value is json key in definition. """ swagger_types = { - 'identifier': 'str', - 'instance_identifier': 'str', - 'name': 'str', 'comments': 'str', - 'position': 'Position', - 'label': 'str', - 'z_index': 'int', - 'width': 'float', - 'height': 'float', - 'style': 'dict(str, str)', - 'component_type': 'str', - 'group_identifier': 'str' - } +'component_type': 'str', +'group_identifier': 'str', +'height': 'float', +'identifier': 'str', +'instance_identifier': 'str', +'label': 'str', +'name': 'str', +'position': 'Position', +'style': 'dict(str, str)', +'width': 'float', +'z_index': 'int' } attribute_map = { - 'identifier': 'identifier', - 'instance_identifier': 'instanceIdentifier', - 'name': 'name', 'comments': 'comments', - 'position': 'position', - 'label': 'label', - 'z_index': 'zIndex', - 'width': 'width', - 'height': 'height', - 'style': 'style', - 'component_type': 'componentType', - 'group_identifier': 'groupIdentifier' - } - - def __init__(self, identifier=None, instance_identifier=None, name=None, comments=None, position=None, label=None, z_index=None, width=None, height=None, style=None, component_type=None, group_identifier=None): +'component_type': 'componentType', +'group_identifier': 'groupIdentifier', +'height': 'height', +'identifier': 'identifier', +'instance_identifier': 'instanceIdentifier', +'label': 'label', +'name': 'name', +'position': 'position', +'style': 'style', +'width': 'width', +'z_index': 'zIndex' } + + def __init__(self, comments=None, component_type=None, group_identifier=None, height=None, identifier=None, instance_identifier=None, label=None, name=None, position=None, style=None, width=None, z_index=None): """ VersionedLabel - a model defined in Swagger """ + self._comments = None + self._component_type = None + self._group_identifier = None + self._height = None self._identifier = None self._instance_identifier = None + self._label = None self._name = None - self._comments = None self._position = None - self._label = None - self._z_index = None - self._width = None - self._height = None self._style = None - self._component_type = None - self._group_identifier = None + self._width = None + self._z_index = None + if comments is not None: + self.comments = comments + if component_type is not None: + self.component_type = component_type + if group_identifier is not None: + self.group_identifier = group_identifier + if height is not None: + self.height = height if identifier is not None: self.identifier = identifier if instance_identifier is not None: self.instance_identifier = instance_identifier + if label is not None: + self.label = label if name is not None: self.name = name - if comments is not None: - self.comments = comments if position is not None: self.position = position - if label is not None: - self.label = label - if z_index is not None: - self.z_index = z_index - if width is not None: - self.width = width - if height is not None: - self.height = height if style is not None: self.style = style - if component_type is not None: - self.component_type = component_type - if group_identifier is not None: - self.group_identifier = group_identifier + if width is not None: + self.width = width + if z_index is not None: + self.z_index = z_index @property - def identifier(self): + def comments(self): """ - Gets the identifier of this VersionedLabel. - The component's unique identifier + Gets the comments of this VersionedLabel. + The user-supplied comments for the component - :return: The identifier of this VersionedLabel. + :return: The comments of this VersionedLabel. :rtype: str """ - return self._identifier + return self._comments - @identifier.setter - def identifier(self, identifier): + @comments.setter + def comments(self, comments): """ - Sets the identifier of this VersionedLabel. - The component's unique identifier + Sets the comments of this VersionedLabel. + The user-supplied comments for the component - :param identifier: The identifier of this VersionedLabel. + :param comments: The comments of this VersionedLabel. :type: str """ - self._identifier = identifier + self._comments = comments @property - def instance_identifier(self): + def component_type(self): """ - Gets the instance_identifier of this VersionedLabel. - The instance ID of an existing component that is described by this VersionedComponent, or null if this is not mapped to an instantiated component + Gets the component_type of this VersionedLabel. - :return: The instance_identifier of this VersionedLabel. + :return: The component_type of this VersionedLabel. :rtype: str """ - return self._instance_identifier + return self._component_type - @instance_identifier.setter - def instance_identifier(self, instance_identifier): + @component_type.setter + def component_type(self, component_type): """ - Sets the instance_identifier of this VersionedLabel. - The instance ID of an existing component that is described by this VersionedComponent, or null if this is not mapped to an instantiated component + Sets the component_type of this VersionedLabel. - :param instance_identifier: The instance_identifier of this VersionedLabel. + :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", ] + 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._instance_identifier = instance_identifier + self._component_type = component_type @property - def name(self): + def group_identifier(self): """ - Gets the name of this VersionedLabel. - The component's name + Gets the group_identifier of this VersionedLabel. + The ID of the Process Group that this component belongs to - :return: The name of this VersionedLabel. + :return: The group_identifier of this VersionedLabel. :rtype: str """ - return self._name + return self._group_identifier - @name.setter - def name(self, name): + @group_identifier.setter + def group_identifier(self, group_identifier): """ - Sets the name of this VersionedLabel. - The component's name + Sets the group_identifier of this VersionedLabel. + The ID of the Process Group that this component belongs to - :param name: The name of this VersionedLabel. + :param group_identifier: The group_identifier of this VersionedLabel. :type: str """ - self._name = name + self._group_identifier = group_identifier @property - def comments(self): + def height(self): """ - Gets the comments of this VersionedLabel. - The user-supplied comments for the component + Gets the height of this VersionedLabel. + The height of the label in pixels when at a 1:1 scale. - :return: The comments of this VersionedLabel. + :return: The height of this VersionedLabel. + :rtype: float + """ + return self._height + + @height.setter + def height(self, height): + """ + Sets the height of this VersionedLabel. + The height of the label in pixels when at a 1:1 scale. + + :param height: The height of this VersionedLabel. + :type: float + """ + + self._height = height + + @property + def identifier(self): + """ + Gets the identifier of this VersionedLabel. + The component's unique identifier + + :return: The identifier of this VersionedLabel. :rtype: str """ - return self._comments + return self._identifier - @comments.setter - def comments(self, comments): + @identifier.setter + def identifier(self, identifier): """ - Sets the comments of this VersionedLabel. - The user-supplied comments for the component + Sets the identifier of this VersionedLabel. + The component's unique identifier - :param comments: The comments of this VersionedLabel. + :param identifier: The identifier of this VersionedLabel. :type: str """ - self._comments = comments + self._identifier = identifier @property - def position(self): + def instance_identifier(self): """ - Gets the position of this VersionedLabel. - The component's position on the graph + Gets the instance_identifier of this VersionedLabel. + The instance ID of an existing component that is described by this VersionedComponent, or null if this is not mapped to an instantiated component - :return: The position of this VersionedLabel. - :rtype: Position + :return: The instance_identifier of this VersionedLabel. + :rtype: str """ - return self._position + return self._instance_identifier - @position.setter - def position(self, position): + @instance_identifier.setter + def instance_identifier(self, instance_identifier): """ - Sets the position of this VersionedLabel. - The component's position on the graph + Sets the instance_identifier of this VersionedLabel. + The instance ID of an existing component that is described by this VersionedComponent, or null if this is not mapped to an instantiated component - :param position: The position of this VersionedLabel. - :type: Position + :param instance_identifier: The instance_identifier of this VersionedLabel. + :type: str """ - self._position = position + self._instance_identifier = instance_identifier @property def label(self): @@ -239,73 +263,48 @@ def label(self, label): self._label = label @property - def z_index(self): - """ - Gets the z_index of this VersionedLabel. - The z index of the connection. - - :return: The z_index of this VersionedLabel. - :rtype: int - """ - return self._z_index - - @z_index.setter - def z_index(self, z_index): - """ - Sets the z_index of this VersionedLabel. - The z index of the connection. - - :param z_index: The z_index of this VersionedLabel. - :type: int - """ - - self._z_index = z_index - - @property - def width(self): + def name(self): """ - Gets the width of this VersionedLabel. - The width of the label in pixels when at a 1:1 scale. + Gets the name of this VersionedLabel. + The component's name - :return: The width of this VersionedLabel. - :rtype: float + :return: The name of this VersionedLabel. + :rtype: str """ - return self._width + return self._name - @width.setter - def width(self, width): + @name.setter + def name(self, name): """ - Sets the width of this VersionedLabel. - The width of the label in pixels when at a 1:1 scale. + Sets the name of this VersionedLabel. + The component's name - :param width: The width of this VersionedLabel. - :type: float + :param name: The name of this VersionedLabel. + :type: str """ - self._width = width + self._name = name @property - def height(self): + def position(self): """ - Gets the height of this VersionedLabel. - The height of the label in pixels when at a 1:1 scale. + Gets the position of this VersionedLabel. - :return: The height of this VersionedLabel. - :rtype: float + :return: The position of this VersionedLabel. + :rtype: Position """ - return self._height + return self._position - @height.setter - def height(self, height): + @position.setter + def position(self, position): """ - Sets the height of this VersionedLabel. - The height of the label in pixels when at a 1:1 scale. + Sets the position of this VersionedLabel. - :param height: The height of this VersionedLabel. - :type: float + :param position: The position of this VersionedLabel. + :type: Position """ - self._height = height + self._position = position @property def style(self): @@ -331,54 +330,50 @@ def style(self, style): self._style = style @property - def component_type(self): + def width(self): """ - Gets the component_type of this VersionedLabel. + Gets the width of this VersionedLabel. + The width of the label in pixels when at a 1:1 scale. - :return: The component_type of this VersionedLabel. - :rtype: str + :return: The width of this VersionedLabel. + :rtype: float """ - return self._component_type + return self._width - @component_type.setter - def component_type(self, component_type): + @width.setter + def width(self, width): """ - Sets the component_type of this VersionedLabel. + Sets the width of this VersionedLabel. + The width of the label in pixels when at a 1:1 scale. - :param component_type: The component_type of this VersionedLabel. - :type: str + :param width: The width of this VersionedLabel. + :type: float """ - 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", "PARAMETER_CONTEXT", "PARAMETER_PROVIDER", "TEMPLATE", "FLOW_REGISTRY_CLIENT"] - 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 + self._width = width @property - def group_identifier(self): + def z_index(self): """ - Gets the group_identifier of this VersionedLabel. - The ID of the Process Group that this component belongs to + Gets the z_index of this VersionedLabel. + The z index of the connection. - :return: The group_identifier of this VersionedLabel. - :rtype: str + :return: The z_index of this VersionedLabel. + :rtype: int """ - return self._group_identifier + return self._z_index - @group_identifier.setter - def group_identifier(self, group_identifier): + @z_index.setter + def z_index(self, z_index): """ - Sets the group_identifier of this VersionedLabel. - The ID of the Process Group that this component belongs to + Sets the z_index of this VersionedLabel. + The z index of the connection. - :param group_identifier: The group_identifier of this VersionedLabel. - :type: str + :param z_index: The z_index of this VersionedLabel. + :type: int """ - self._group_identifier = group_identifier + self._z_index = z_index def to_dict(self): """ diff --git a/nipyapi/registry/models/versioned_parameter.py b/nipyapi/registry/models/versioned_parameter.py index c8608728..114c18e1 100644 --- a/nipyapi/registry/models/versioned_parameter.py +++ b/nipyapi/registry/models/versioned_parameter.py @@ -1,14 +1,13 @@ """ Apache NiFi Registry REST API - The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components. + REST API definition for Apache NiFi Registry web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,66 +27,46 @@ class VersionedParameter(object): and the value is json key in definition. """ swagger_types = { - 'name': 'str', 'description': 'str', - 'sensitive': 'bool', - 'provided': 'bool', - 'value': 'str' - } +'name': 'str', +'provided': 'bool', +'referenced_assets': 'list[VersionedAsset]', +'sensitive': 'bool', +'value': 'str' } attribute_map = { - 'name': 'name', 'description': 'description', - 'sensitive': 'sensitive', - 'provided': 'provided', - 'value': 'value' - } +'name': 'name', +'provided': 'provided', +'referenced_assets': 'referencedAssets', +'sensitive': 'sensitive', +'value': 'value' } - def __init__(self, name=None, description=None, sensitive=None, provided=None, value=None): + def __init__(self, description=None, name=None, provided=None, referenced_assets=None, sensitive=None, value=None): """ VersionedParameter - a model defined in Swagger """ - self._name = None self._description = None - self._sensitive = None + self._name = None self._provided = None + self._referenced_assets = None + self._sensitive = None self._value = None - if name is not None: - self.name = name if description is not None: self.description = description - if sensitive is not None: - self.sensitive = sensitive + if name is not None: + self.name = name if provided is not None: self.provided = provided + if referenced_assets is not None: + self.referenced_assets = referenced_assets + if sensitive is not None: + self.sensitive = sensitive if value is not None: self.value = value - @property - def name(self): - """ - Gets the name of this VersionedParameter. - The name of the parameter - - :return: The name of this VersionedParameter. - :rtype: str - """ - return self._name - - @name.setter - def name(self, name): - """ - Sets the name of this VersionedParameter. - The name of the parameter - - :param name: The name of this VersionedParameter. - :type: str - """ - - self._name = name - @property def description(self): """ @@ -112,27 +91,27 @@ def description(self, description): self._description = description @property - def sensitive(self): + def name(self): """ - Gets the sensitive of this VersionedParameter. - Whether or not the parameter value is sensitive + Gets the name of this VersionedParameter. + The name of the parameter - :return: The sensitive of this VersionedParameter. - :rtype: bool + :return: The name of this VersionedParameter. + :rtype: str """ - return self._sensitive + return self._name - @sensitive.setter - def sensitive(self, sensitive): + @name.setter + def name(self, name): """ - Sets the sensitive of this VersionedParameter. - Whether or not the parameter value is sensitive + Sets the name of this VersionedParameter. + The name of the parameter - :param sensitive: The sensitive of this VersionedParameter. - :type: bool + :param name: The name of this VersionedParameter. + :type: str """ - self._sensitive = sensitive + self._name = name @property def provided(self): @@ -157,6 +136,52 @@ def provided(self, provided): self._provided = provided + @property + def referenced_assets(self): + """ + Gets the referenced_assets of this VersionedParameter. + The assets that are referenced by this parameter + + :return: The referenced_assets of this VersionedParameter. + :rtype: list[VersionedAsset] + """ + return self._referenced_assets + + @referenced_assets.setter + def referenced_assets(self, referenced_assets): + """ + Sets the referenced_assets of this VersionedParameter. + The assets that are referenced by this parameter + + :param referenced_assets: The referenced_assets of this VersionedParameter. + :type: list[VersionedAsset] + """ + + self._referenced_assets = referenced_assets + + @property + def sensitive(self): + """ + Gets the sensitive of this VersionedParameter. + Whether or not the parameter value is sensitive + + :return: The sensitive of this VersionedParameter. + :rtype: bool + """ + return self._sensitive + + @sensitive.setter + def sensitive(self, sensitive): + """ + Sets the sensitive of this VersionedParameter. + Whether or not the parameter value is sensitive + + :param sensitive: The sensitive of this VersionedParameter. + :type: bool + """ + + self._sensitive = sensitive + @property def value(self): """ diff --git a/nipyapi/registry/models/versioned_parameter_context.py b/nipyapi/registry/models/versioned_parameter_context.py index 81ad5f55..b64041e0 100644 --- a/nipyapi/registry/models/versioned_parameter_context.py +++ b/nipyapi/registry/models/versioned_parameter_context.py @@ -1,14 +1,13 @@ """ Apache NiFi Registry REST API - The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components. + REST API definition for Apache NiFi Registry web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,220 +27,199 @@ class VersionedParameterContext(object): and the value is json key in definition. """ swagger_types = { - 'identifier': 'str', - 'instance_identifier': 'str', - 'name': 'str', 'comments': 'str', - 'position': 'Position', - 'parameters': 'list[VersionedParameter]', - 'inherited_parameter_contexts': 'list[str]', - 'description': 'str', - 'parameter_provider': 'str', - 'parameter_group_name': 'str', - 'component_type': 'str', - 'synchronized': 'bool', - 'group_identifier': 'str' - } +'component_type': 'str', +'description': 'str', +'group_identifier': 'str', +'identifier': 'str', +'inherited_parameter_contexts': 'list[str]', +'instance_identifier': 'str', +'name': 'str', +'parameter_group_name': 'str', +'parameter_provider': 'str', +'parameters': 'list[VersionedParameter]', +'position': 'Position', +'synchronized': 'bool' } attribute_map = { - 'identifier': 'identifier', - 'instance_identifier': 'instanceIdentifier', - 'name': 'name', 'comments': 'comments', - 'position': 'position', - 'parameters': 'parameters', - 'inherited_parameter_contexts': 'inheritedParameterContexts', - 'description': 'description', - 'parameter_provider': 'parameterProvider', - 'parameter_group_name': 'parameterGroupName', - 'component_type': 'componentType', - 'synchronized': 'synchronized', - 'group_identifier': 'groupIdentifier' - } - - def __init__(self, identifier=None, instance_identifier=None, name=None, comments=None, position=None, parameters=None, inherited_parameter_contexts=None, description=None, parameter_provider=None, parameter_group_name=None, component_type=None, synchronized=None, group_identifier=None): +'component_type': 'componentType', +'description': 'description', +'group_identifier': 'groupIdentifier', +'identifier': 'identifier', +'inherited_parameter_contexts': 'inheritedParameterContexts', +'instance_identifier': 'instanceIdentifier', +'name': 'name', +'parameter_group_name': 'parameterGroupName', +'parameter_provider': 'parameterProvider', +'parameters': 'parameters', +'position': 'position', +'synchronized': 'synchronized' } + + def __init__(self, comments=None, component_type=None, description=None, group_identifier=None, identifier=None, inherited_parameter_contexts=None, instance_identifier=None, name=None, parameter_group_name=None, parameter_provider=None, parameters=None, position=None, synchronized=None): """ VersionedParameterContext - a model defined in Swagger """ + self._comments = None + self._component_type = None + self._description = None + self._group_identifier = None self._identifier = None + self._inherited_parameter_contexts = None self._instance_identifier = None self._name = None - self._comments = None - self._position = None - self._parameters = None - self._inherited_parameter_contexts = None - self._description = None - self._parameter_provider = None self._parameter_group_name = None - self._component_type = None + self._parameter_provider = None + self._parameters = None + self._position = None self._synchronized = None - self._group_identifier = None + if comments is not None: + self.comments = comments + if component_type is not None: + self.component_type = component_type + if description is not None: + self.description = description + if group_identifier is not None: + self.group_identifier = group_identifier if identifier is not None: self.identifier = identifier + if inherited_parameter_contexts is not None: + self.inherited_parameter_contexts = inherited_parameter_contexts if instance_identifier is not None: self.instance_identifier = instance_identifier if name is not None: self.name = name - if comments is not None: - self.comments = comments - if position is not None: - self.position = position - if parameters is not None: - self.parameters = parameters - if inherited_parameter_contexts is not None: - self.inherited_parameter_contexts = inherited_parameter_contexts - if description is not None: - self.description = description - if parameter_provider is not None: - self.parameter_provider = parameter_provider if parameter_group_name is not None: self.parameter_group_name = parameter_group_name - if component_type is not None: - self.component_type = component_type + if parameter_provider is not None: + self.parameter_provider = parameter_provider + if parameters is not None: + self.parameters = parameters + if position is not None: + self.position = position if synchronized is not None: self.synchronized = synchronized - if group_identifier is not None: - self.group_identifier = group_identifier @property - def identifier(self): + def comments(self): """ - Gets the identifier of this VersionedParameterContext. - The component's unique identifier + Gets the comments of this VersionedParameterContext. + The user-supplied comments for the component - :return: The identifier of this VersionedParameterContext. + :return: The comments of this VersionedParameterContext. :rtype: str """ - return self._identifier + return self._comments - @identifier.setter - def identifier(self, identifier): + @comments.setter + def comments(self, comments): """ - Sets the identifier of this VersionedParameterContext. - The component's unique identifier + Sets the comments of this VersionedParameterContext. + The user-supplied comments for the component - :param identifier: The identifier of this VersionedParameterContext. + :param comments: The comments of this VersionedParameterContext. :type: str """ - self._identifier = identifier + self._comments = comments @property - def instance_identifier(self): + def component_type(self): """ - Gets the instance_identifier of this VersionedParameterContext. - The instance ID of an existing component that is described by this VersionedComponent, or null if this is not mapped to an instantiated component + Gets the component_type of this VersionedParameterContext. - :return: The instance_identifier of this VersionedParameterContext. + :return: The component_type of this VersionedParameterContext. :rtype: str """ - return self._instance_identifier + return self._component_type - @instance_identifier.setter - def instance_identifier(self, instance_identifier): + @component_type.setter + def component_type(self, component_type): """ - Sets the instance_identifier of this VersionedParameterContext. - The instance ID of an existing component that is described by this VersionedComponent, or null if this is not mapped to an instantiated component + Sets the component_type of this VersionedParameterContext. - :param instance_identifier: The instance_identifier of this VersionedParameterContext. + :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", ] + 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._instance_identifier = instance_identifier + self._component_type = component_type @property - def name(self): + def description(self): """ - Gets the name of this VersionedParameterContext. - The component's name + Gets the description of this VersionedParameterContext. + The description of the parameter context - :return: The name of this VersionedParameterContext. + :return: The description of this VersionedParameterContext. :rtype: str """ - return self._name + return self._description - @name.setter - def name(self, name): + @description.setter + def description(self, description): """ - Sets the name of this VersionedParameterContext. - The component's name + Sets the description of this VersionedParameterContext. + The description of the parameter context - :param name: The name of this VersionedParameterContext. + :param description: The description of this VersionedParameterContext. :type: str """ - self._name = name + self._description = description @property - def comments(self): + def group_identifier(self): """ - Gets the comments of this VersionedParameterContext. - The user-supplied comments for the component + Gets the group_identifier of this VersionedParameterContext. + The ID of the Process Group that this component belongs to - :return: The comments of this VersionedParameterContext. + :return: The group_identifier of this VersionedParameterContext. :rtype: str """ - return self._comments + return self._group_identifier - @comments.setter - def comments(self, comments): + @group_identifier.setter + def group_identifier(self, group_identifier): """ - Sets the comments of this VersionedParameterContext. - The user-supplied comments for the component + Sets the group_identifier of this VersionedParameterContext. + The ID of the Process Group that this component belongs to - :param comments: The comments of this VersionedParameterContext. + :param group_identifier: The group_identifier of this VersionedParameterContext. :type: str """ - self._comments = comments - - @property - def position(self): - """ - Gets the position of this VersionedParameterContext. - The component's position on the graph - - :return: The position of this VersionedParameterContext. - :rtype: Position - """ - return self._position - - @position.setter - def position(self, position): - """ - Sets the position of this VersionedParameterContext. - The component's position on the graph - - :param position: The position of this VersionedParameterContext. - :type: Position - """ - - self._position = position + self._group_identifier = group_identifier @property - def parameters(self): + def identifier(self): """ - Gets the parameters of this VersionedParameterContext. - The parameters in the context + Gets the identifier of this VersionedParameterContext. + The component's unique identifier - :return: The parameters of this VersionedParameterContext. - :rtype: list[VersionedParameter] + :return: The identifier of this VersionedParameterContext. + :rtype: str """ - return self._parameters + return self._identifier - @parameters.setter - def parameters(self, parameters): + @identifier.setter + def identifier(self, identifier): """ - Sets the parameters of this VersionedParameterContext. - The parameters in the context + Sets the identifier of this VersionedParameterContext. + The component's unique identifier - :param parameters: The parameters of this VersionedParameterContext. - :type: list[VersionedParameter] + :param identifier: The identifier of this VersionedParameterContext. + :type: str """ - self._parameters = parameters + self._identifier = identifier @property def inherited_parameter_contexts(self): @@ -267,50 +245,50 @@ def inherited_parameter_contexts(self, inherited_parameter_contexts): self._inherited_parameter_contexts = inherited_parameter_contexts @property - def description(self): + def instance_identifier(self): """ - Gets the description of this VersionedParameterContext. - The description of the parameter context + Gets the instance_identifier of this VersionedParameterContext. + The instance ID of an existing component that is described by this VersionedComponent, or null if this is not mapped to an instantiated component - :return: The description of this VersionedParameterContext. + :return: The instance_identifier of this VersionedParameterContext. :rtype: str """ - return self._description + return self._instance_identifier - @description.setter - def description(self, description): + @instance_identifier.setter + def instance_identifier(self, instance_identifier): """ - Sets the description of this VersionedParameterContext. - The description of the parameter context + Sets the instance_identifier of this VersionedParameterContext. + The instance ID of an existing component that is described by this VersionedComponent, or null if this is not mapped to an instantiated component - :param description: The description of this VersionedParameterContext. + :param instance_identifier: The instance_identifier of this VersionedParameterContext. :type: str """ - self._description = description + self._instance_identifier = instance_identifier @property - def parameter_provider(self): + def name(self): """ - Gets the parameter_provider of this VersionedParameterContext. - The identifier of an optional parameter provider + Gets the name of this VersionedParameterContext. + The component's name - :return: The parameter_provider of this VersionedParameterContext. + :return: The name of this VersionedParameterContext. :rtype: str """ - return self._parameter_provider + return self._name - @parameter_provider.setter - def parameter_provider(self, parameter_provider): + @name.setter + def name(self, name): """ - Sets the parameter_provider of this VersionedParameterContext. - The identifier of an optional parameter provider + Sets the name of this VersionedParameterContext. + The component's name - :param parameter_provider: The parameter_provider of this VersionedParameterContext. + :param name: The name of this VersionedParameterContext. :type: str """ - self._parameter_provider = parameter_provider + self._name = name @property def parameter_group_name(self): @@ -336,31 +314,71 @@ def parameter_group_name(self, parameter_group_name): self._parameter_group_name = parameter_group_name @property - def component_type(self): + def parameter_provider(self): """ - Gets the component_type of this VersionedParameterContext. + Gets the parameter_provider of this VersionedParameterContext. + The identifier of an optional parameter provider - :return: The component_type of this VersionedParameterContext. + :return: The parameter_provider of this VersionedParameterContext. :rtype: str """ - return self._component_type + return self._parameter_provider - @component_type.setter - def component_type(self, component_type): + @parameter_provider.setter + def parameter_provider(self, parameter_provider): """ - Sets the component_type of this VersionedParameterContext. + Sets the parameter_provider of this VersionedParameterContext. + The identifier of an optional parameter provider - :param component_type: The component_type of this VersionedParameterContext. + :param parameter_provider: The parameter_provider 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", "PARAMETER_CONTEXT", "PARAMETER_PROVIDER", "TEMPLATE", "FLOW_REGISTRY_CLIENT"] - 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 + self._parameter_provider = parameter_provider + + @property + def parameters(self): + """ + Gets the parameters of this VersionedParameterContext. + The parameters in the context + + :return: The parameters of this VersionedParameterContext. + :rtype: list[VersionedParameter] + """ + return self._parameters + + @parameters.setter + def parameters(self, parameters): + """ + Sets the parameters of this VersionedParameterContext. + The parameters in the context + + :param parameters: The parameters of this VersionedParameterContext. + :type: list[VersionedParameter] + """ + + self._parameters = parameters + + @property + def position(self): + """ + Gets the position of this VersionedParameterContext. + + :return: The position of this VersionedParameterContext. + :rtype: Position + """ + return self._position + + @position.setter + def position(self, position): + """ + Sets the position of this VersionedParameterContext. + + :param position: The position of this VersionedParameterContext. + :type: Position + """ + + self._position = position @property def synchronized(self): @@ -385,29 +403,6 @@ def synchronized(self, synchronized): self._synchronized = synchronized - @property - def group_identifier(self): - """ - Gets the group_identifier of this VersionedParameterContext. - The ID of the Process Group that this component belongs to - - :return: The group_identifier of this VersionedParameterContext. - :rtype: str - """ - return self._group_identifier - - @group_identifier.setter - def group_identifier(self, group_identifier): - """ - Sets the group_identifier of this VersionedParameterContext. - The ID of the Process Group that this component belongs to - - :param group_identifier: The group_identifier of this VersionedParameterContext. - :type: str - """ - - self._group_identifier = group_identifier - def to_dict(self): """ Returns the model properties as a dict diff --git a/nipyapi/registry/models/versioned_port.py b/nipyapi/registry/models/versioned_port.py index d8add882..6076d3b8 100644 --- a/nipyapi/registry/models/versioned_port.py +++ b/nipyapi/registry/models/versioned_port.py @@ -1,14 +1,13 @@ """ Apache NiFi Registry REST API - The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components. + REST API definition for Apache NiFi Registry web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,72 +27,194 @@ class VersionedPort(object): and the value is json key in definition. """ swagger_types = { - 'identifier': 'str', - 'instance_identifier': 'str', - 'name': 'str', - 'comments': 'str', - 'position': 'Position', - 'type': 'str', - 'concurrently_schedulable_task_count': 'int', - 'scheduled_state': 'str', 'allow_remote_access': 'bool', - 'component_type': 'str', - 'group_identifier': 'str' - } +'comments': 'str', +'component_type': 'str', +'concurrently_schedulable_task_count': 'int', +'group_identifier': 'str', +'identifier': 'str', +'instance_identifier': 'str', +'name': 'str', +'port_function': 'str', +'position': 'Position', +'scheduled_state': 'str', +'type': 'str' } attribute_map = { - 'identifier': 'identifier', - 'instance_identifier': 'instanceIdentifier', - 'name': 'name', - 'comments': 'comments', - 'position': 'position', - 'type': 'type', - 'concurrently_schedulable_task_count': 'concurrentlySchedulableTaskCount', - 'scheduled_state': 'scheduledState', 'allow_remote_access': 'allowRemoteAccess', - 'component_type': 'componentType', - 'group_identifier': 'groupIdentifier' - } - - def __init__(self, identifier=None, instance_identifier=None, name=None, comments=None, position=None, type=None, concurrently_schedulable_task_count=None, scheduled_state=None, allow_remote_access=None, component_type=None, group_identifier=None): +'comments': 'comments', +'component_type': 'componentType', +'concurrently_schedulable_task_count': 'concurrentlySchedulableTaskCount', +'group_identifier': 'groupIdentifier', +'identifier': 'identifier', +'instance_identifier': 'instanceIdentifier', +'name': 'name', +'port_function': 'portFunction', +'position': 'position', +'scheduled_state': 'scheduledState', +'type': 'type' } + + def __init__(self, allow_remote_access=None, comments=None, component_type=None, concurrently_schedulable_task_count=None, group_identifier=None, identifier=None, instance_identifier=None, name=None, port_function=None, position=None, scheduled_state=None, type=None): """ VersionedPort - a model defined in Swagger """ + self._allow_remote_access = None + self._comments = None + self._component_type = None + self._concurrently_schedulable_task_count = None + self._group_identifier = None self._identifier = None self._instance_identifier = None self._name = None - self._comments = None + self._port_function = None self._position = None - self._type = None - self._concurrently_schedulable_task_count = None self._scheduled_state = None - self._allow_remote_access = None - self._component_type = None - self._group_identifier = None + self._type = None + if allow_remote_access is not None: + self.allow_remote_access = allow_remote_access + if comments is not None: + self.comments = comments + if component_type is not None: + self.component_type = component_type + if concurrently_schedulable_task_count is not None: + self.concurrently_schedulable_task_count = concurrently_schedulable_task_count + if group_identifier is not None: + self.group_identifier = group_identifier if identifier is not None: self.identifier = identifier if instance_identifier is not None: self.instance_identifier = instance_identifier if name is not None: self.name = name - if comments is not None: - self.comments = comments + if port_function is not None: + self.port_function = port_function if position is not None: self.position = position - if type is not None: - self.type = type - if concurrently_schedulable_task_count is not None: - self.concurrently_schedulable_task_count = concurrently_schedulable_task_count if scheduled_state is not None: self.scheduled_state = scheduled_state - if allow_remote_access is not None: - self.allow_remote_access = allow_remote_access - if component_type is not None: - self.component_type = component_type - if group_identifier is not None: - self.group_identifier = group_identifier + if type is not None: + self.type = type + + @property + def allow_remote_access(self): + """ + Gets the allow_remote_access of this VersionedPort. + Whether or not this port allows remote access for site-to-site + + :return: The allow_remote_access of this VersionedPort. + :rtype: bool + """ + return self._allow_remote_access + + @allow_remote_access.setter + def allow_remote_access(self, allow_remote_access): + """ + Sets the allow_remote_access of this VersionedPort. + Whether or not this port allows remote access for site-to-site + + :param allow_remote_access: The allow_remote_access of this VersionedPort. + :type: bool + """ + + self._allow_remote_access = allow_remote_access + + @property + def comments(self): + """ + Gets the comments of this VersionedPort. + The user-supplied comments for the component + + :return: The comments of this VersionedPort. + :rtype: str + """ + return self._comments + + @comments.setter + def comments(self, comments): + """ + Sets the comments of this VersionedPort. + The user-supplied comments for the component + + :param comments: The comments of this VersionedPort. + :type: str + """ + + self._comments = comments + + @property + def component_type(self): + """ + Gets the component_type of this VersionedPort. + + :return: The component_type of this VersionedPort. + :rtype: str + """ + return self._component_type + + @component_type.setter + def component_type(self, component_type): + """ + Sets the component_type of this VersionedPort. + + :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", ] + 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 + + @property + def concurrently_schedulable_task_count(self): + """ + Gets the concurrently_schedulable_task_count of this VersionedPort. + The number of tasks that should be concurrently scheduled for the port. + + :return: The concurrently_schedulable_task_count of this VersionedPort. + :rtype: int + """ + return self._concurrently_schedulable_task_count + + @concurrently_schedulable_task_count.setter + def concurrently_schedulable_task_count(self, concurrently_schedulable_task_count): + """ + Sets the concurrently_schedulable_task_count of this VersionedPort. + The number of tasks that should be concurrently scheduled for the port. + + :param concurrently_schedulable_task_count: The concurrently_schedulable_task_count of this VersionedPort. + :type: int + """ + + self._concurrently_schedulable_task_count = concurrently_schedulable_task_count + + @property + def group_identifier(self): + """ + Gets the group_identifier of this VersionedPort. + The ID of the Process Group that this component belongs to + + :return: The group_identifier of this VersionedPort. + :rtype: str + """ + return self._group_identifier + + @group_identifier.setter + def group_identifier(self, group_identifier): + """ + Sets the group_identifier of this VersionedPort. + The ID of the Process Group that this component belongs to + + :param group_identifier: The group_identifier of this VersionedPort. + :type: str + """ + + self._group_identifier = group_identifier @property def identifier(self): @@ -165,33 +286,38 @@ def name(self, name): self._name = name @property - def comments(self): + def port_function(self): """ - Gets the comments of this VersionedPort. - The user-supplied comments for the component + Gets the port_function of this VersionedPort. + Specifies how the Port should function - :return: The comments of this VersionedPort. + :return: The port_function of this VersionedPort. :rtype: str """ - return self._comments + return self._port_function - @comments.setter - def comments(self, comments): + @port_function.setter + def port_function(self, port_function): """ - Sets the comments of this VersionedPort. - The user-supplied comments for the component + Sets the port_function of this VersionedPort. + Specifies how the Port should function - :param comments: The comments of this VersionedPort. + :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) + ) - self._comments = comments + self._port_function = port_function @property def position(self): """ Gets the position of this VersionedPort. - The component's position on the graph :return: The position of this VersionedPort. :rtype: Position @@ -202,7 +328,6 @@ def position(self): def position(self, position): """ Sets the position of this VersionedPort. - The component's position on the graph :param position: The position of this VersionedPort. :type: Position @@ -210,58 +335,6 @@ def position(self, position): self._position = position - @property - def type(self): - """ - Gets the type of this VersionedPort. - The type of port. - - :return: The type of this VersionedPort. - :rtype: str - """ - return self._type - - @type.setter - def type(self, type): - """ - Sets the type of this VersionedPort. - The type of port. - - :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) - ) - - self._type = type - - @property - def concurrently_schedulable_task_count(self): - """ - Gets the concurrently_schedulable_task_count of this VersionedPort. - The number of tasks that should be concurrently scheduled for the port. - - :return: The concurrently_schedulable_task_count of this VersionedPort. - :rtype: int - """ - return self._concurrently_schedulable_task_count - - @concurrently_schedulable_task_count.setter - def concurrently_schedulable_task_count(self, concurrently_schedulable_task_count): - """ - Sets the concurrently_schedulable_task_count of this VersionedPort. - The number of tasks that should be concurrently scheduled for the port. - - :param concurrently_schedulable_task_count: The concurrently_schedulable_task_count of this VersionedPort. - :type: int - """ - - self._concurrently_schedulable_task_count = concurrently_schedulable_task_count - @property def scheduled_state(self): """ @@ -282,7 +355,7 @@ def scheduled_state(self, scheduled_state): :param scheduled_state: The scheduled_state of this VersionedPort. :type: str """ - allowed_values = ["ENABLED", "DISABLED", "RUNNING"] + 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}" @@ -292,77 +365,33 @@ def scheduled_state(self, scheduled_state): self._scheduled_state = scheduled_state @property - def allow_remote_access(self): - """ - Gets the allow_remote_access of this VersionedPort. - Whether or not this port allows remote access for site-to-site - - :return: The allow_remote_access of this VersionedPort. - :rtype: bool - """ - return self._allow_remote_access - - @allow_remote_access.setter - def allow_remote_access(self, allow_remote_access): - """ - Sets the allow_remote_access of this VersionedPort. - Whether or not this port allows remote access for site-to-site - - :param allow_remote_access: The allow_remote_access of this VersionedPort. - :type: bool - """ - - self._allow_remote_access = allow_remote_access - - @property - def component_type(self): + def type(self): """ - Gets the component_type of this VersionedPort. + Gets the type of this VersionedPort. + The type of port. - :return: The component_type of this VersionedPort. + :return: The type of this VersionedPort. :rtype: str """ - return self._component_type + return self._type - @component_type.setter - def component_type(self, component_type): + @type.setter + def type(self, type): """ - Sets the component_type of this VersionedPort. + Sets the type of this VersionedPort. + The type of port. - :param component_type: The component_type of this VersionedPort. + :param type: The 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", "PARAMETER_CONTEXT", "PARAMETER_PROVIDER", "TEMPLATE", "FLOW_REGISTRY_CLIENT"] - if component_type not in allowed_values: + allowed_values = ["INPUT_PORT", "OUTPUT_PORT", ] + if type not in allowed_values: raise ValueError( - "Invalid value for `component_type` ({0}), must be one of {1}" - .format(component_type, allowed_values) + "Invalid value for `type` ({0}), must be one of {1}" + .format(type, allowed_values) ) - self._component_type = component_type - - @property - def group_identifier(self): - """ - Gets the group_identifier of this VersionedPort. - The ID of the Process Group that this component belongs to - - :return: The group_identifier of this VersionedPort. - :rtype: str - """ - return self._group_identifier - - @group_identifier.setter - def group_identifier(self, group_identifier): - """ - Sets the group_identifier of this VersionedPort. - The ID of the Process Group that this component belongs to - - :param group_identifier: The group_identifier of this VersionedPort. - :type: str - """ - - self._group_identifier = group_identifier + self._type = type def to_dict(self): """ diff --git a/nipyapi/registry/models/versioned_process_group.py b/nipyapi/registry/models/versioned_process_group.py index 8196326b..a48649f7 100644 --- a/nipyapi/registry/models/versioned_process_group.py +++ b/nipyapi/registry/models/versioned_process_group.py @@ -1,14 +1,13 @@ """ Apache NiFi Registry REST API - The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components. + REST API definition for Apache NiFi Registry web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,326 +27,464 @@ class VersionedProcessGroup(object): and the value is json key in definition. """ swagger_types = { - 'identifier': 'str', - 'instance_identifier': 'str', - 'name': 'str', 'comments': 'str', - 'position': 'Position', - 'process_groups': 'list[VersionedProcessGroup]', - 'remote_process_groups': 'list[VersionedRemoteProcessGroup]', - 'processors': 'list[VersionedProcessor]', - 'input_ports': 'list[VersionedPort]', - 'output_ports': 'list[VersionedPort]', - 'connections': 'list[VersionedConnection]', - 'labels': 'list[VersionedLabel]', - 'funnels': 'list[VersionedFunnel]', - 'controller_services': 'list[VersionedControllerService]', - 'versioned_flow_coordinates': 'VersionedFlowCoordinates', - 'variables': 'dict(str, str)', - 'parameter_context_name': 'str', - 'default_flow_file_expiration': 'str', - 'default_back_pressure_object_threshold': 'int', - 'default_back_pressure_data_size_threshold': 'str', - 'log_file_suffix': 'str', - 'component_type': 'str', - 'flow_file_outbound_policy': 'str', - 'flow_file_concurrency': 'str', - 'group_identifier': 'str' - } +'component_type': 'str', +'connections': 'list[VersionedConnection]', +'controller_services': 'list[VersionedControllerService]', +'default_back_pressure_data_size_threshold': 'str', +'default_back_pressure_object_threshold': 'int', +'default_flow_file_expiration': 'str', +'execution_engine': 'str', +'flow_file_concurrency': 'str', +'flow_file_outbound_policy': 'str', +'funnels': 'list[VersionedFunnel]', +'group_identifier': 'str', +'identifier': 'str', +'input_ports': 'list[VersionedPort]', +'instance_identifier': 'str', +'labels': 'list[VersionedLabel]', +'log_file_suffix': 'str', +'max_concurrent_tasks': 'int', +'name': 'str', +'output_ports': 'list[VersionedPort]', +'parameter_context_name': 'str', +'position': 'Position', +'process_groups': 'list[VersionedProcessGroup]', +'processors': 'list[VersionedProcessor]', +'remote_process_groups': 'list[VersionedRemoteProcessGroup]', +'scheduled_state': 'str', +'stateless_flow_timeout': 'str', +'versioned_flow_coordinates': 'VersionedFlowCoordinates' } attribute_map = { - 'identifier': 'identifier', - 'instance_identifier': 'instanceIdentifier', - 'name': 'name', 'comments': 'comments', - 'position': 'position', - 'process_groups': 'processGroups', - 'remote_process_groups': 'remoteProcessGroups', - 'processors': 'processors', - 'input_ports': 'inputPorts', - 'output_ports': 'outputPorts', - 'connections': 'connections', - 'labels': 'labels', - 'funnels': 'funnels', - 'controller_services': 'controllerServices', - 'versioned_flow_coordinates': 'versionedFlowCoordinates', - 'variables': 'variables', - 'parameter_context_name': 'parameterContextName', - 'default_flow_file_expiration': 'defaultFlowFileExpiration', - 'default_back_pressure_object_threshold': 'defaultBackPressureObjectThreshold', - 'default_back_pressure_data_size_threshold': 'defaultBackPressureDataSizeThreshold', - 'log_file_suffix': 'logFileSuffix', - 'component_type': 'componentType', - 'flow_file_outbound_policy': 'flowFileOutboundPolicy', - 'flow_file_concurrency': 'flowFileConcurrency', - 'group_identifier': 'groupIdentifier' - } - - def __init__(self, identifier=None, instance_identifier=None, name=None, comments=None, position=None, process_groups=None, remote_process_groups=None, processors=None, input_ports=None, output_ports=None, connections=None, labels=None, funnels=None, controller_services=None, versioned_flow_coordinates=None, variables=None, parameter_context_name=None, default_flow_file_expiration=None, default_back_pressure_object_threshold=None, default_back_pressure_data_size_threshold=None, log_file_suffix=None, component_type=None, flow_file_outbound_policy=None, flow_file_concurrency=None, group_identifier=None): +'component_type': 'componentType', +'connections': 'connections', +'controller_services': 'controllerServices', +'default_back_pressure_data_size_threshold': 'defaultBackPressureDataSizeThreshold', +'default_back_pressure_object_threshold': 'defaultBackPressureObjectThreshold', +'default_flow_file_expiration': 'defaultFlowFileExpiration', +'execution_engine': 'executionEngine', +'flow_file_concurrency': 'flowFileConcurrency', +'flow_file_outbound_policy': 'flowFileOutboundPolicy', +'funnels': 'funnels', +'group_identifier': 'groupIdentifier', +'identifier': 'identifier', +'input_ports': 'inputPorts', +'instance_identifier': 'instanceIdentifier', +'labels': 'labels', +'log_file_suffix': 'logFileSuffix', +'max_concurrent_tasks': 'maxConcurrentTasks', +'name': 'name', +'output_ports': 'outputPorts', +'parameter_context_name': 'parameterContextName', +'position': 'position', +'process_groups': 'processGroups', +'processors': 'processors', +'remote_process_groups': 'remoteProcessGroups', +'scheduled_state': 'scheduledState', +'stateless_flow_timeout': 'statelessFlowTimeout', +'versioned_flow_coordinates': 'versionedFlowCoordinates' } + + def __init__(self, comments=None, component_type=None, connections=None, controller_services=None, default_back_pressure_data_size_threshold=None, default_back_pressure_object_threshold=None, default_flow_file_expiration=None, execution_engine=None, flow_file_concurrency=None, flow_file_outbound_policy=None, funnels=None, group_identifier=None, identifier=None, input_ports=None, instance_identifier=None, labels=None, log_file_suffix=None, max_concurrent_tasks=None, name=None, output_ports=None, parameter_context_name=None, position=None, process_groups=None, processors=None, remote_process_groups=None, scheduled_state=None, stateless_flow_timeout=None, versioned_flow_coordinates=None): """ VersionedProcessGroup - a model defined in Swagger """ + self._comments = None + self._component_type = None + self._connections = None + self._controller_services = None + self._default_back_pressure_data_size_threshold = None + self._default_back_pressure_object_threshold = None + self._default_flow_file_expiration = None + self._execution_engine = None + self._flow_file_concurrency = None + self._flow_file_outbound_policy = None + self._funnels = None + self._group_identifier = None self._identifier = None + self._input_ports = None self._instance_identifier = None + self._labels = None + self._log_file_suffix = None + self._max_concurrent_tasks = None self._name = None - self._comments = None + self._output_ports = None + self._parameter_context_name = None self._position = None self._process_groups = None - self._remote_process_groups = None self._processors = None - self._input_ports = None - self._output_ports = None - self._connections = None - self._labels = None - self._funnels = None - self._controller_services = None + self._remote_process_groups = None + self._scheduled_state = None + self._stateless_flow_timeout = None self._versioned_flow_coordinates = None - self._variables = None - self._parameter_context_name = None - self._default_flow_file_expiration = None - self._default_back_pressure_object_threshold = None - self._default_back_pressure_data_size_threshold = None - self._log_file_suffix = None - self._component_type = None - self._flow_file_outbound_policy = None - self._flow_file_concurrency = None - self._group_identifier = None + if comments is not None: + self.comments = comments + if component_type is not None: + self.component_type = component_type + if connections is not None: + self.connections = connections + if controller_services is not None: + self.controller_services = controller_services + if default_back_pressure_data_size_threshold is not None: + self.default_back_pressure_data_size_threshold = default_back_pressure_data_size_threshold + if default_back_pressure_object_threshold is not None: + self.default_back_pressure_object_threshold = default_back_pressure_object_threshold + if default_flow_file_expiration is not None: + self.default_flow_file_expiration = default_flow_file_expiration + if execution_engine is not None: + self.execution_engine = execution_engine + if flow_file_concurrency is not None: + self.flow_file_concurrency = flow_file_concurrency + if flow_file_outbound_policy is not None: + self.flow_file_outbound_policy = flow_file_outbound_policy + if funnels is not None: + self.funnels = funnels + if group_identifier is not None: + self.group_identifier = group_identifier if identifier is not None: self.identifier = identifier + if input_ports is not None: + self.input_ports = input_ports if instance_identifier is not None: self.instance_identifier = instance_identifier + if labels is not None: + self.labels = labels + if log_file_suffix is not None: + self.log_file_suffix = log_file_suffix + if max_concurrent_tasks is not None: + self.max_concurrent_tasks = max_concurrent_tasks if name is not None: self.name = name - if comments is not None: - self.comments = comments + if output_ports is not None: + self.output_ports = output_ports + if parameter_context_name is not None: + self.parameter_context_name = parameter_context_name if position is not None: self.position = position if process_groups is not None: self.process_groups = process_groups - if remote_process_groups is not None: - self.remote_process_groups = remote_process_groups if processors is not None: self.processors = processors - if input_ports is not None: - self.input_ports = input_ports - if output_ports is not None: - self.output_ports = output_ports - if connections is not None: - self.connections = connections - if labels is not None: - self.labels = labels - if funnels is not None: - self.funnels = funnels - if controller_services is not None: - self.controller_services = controller_services + if remote_process_groups is not None: + self.remote_process_groups = remote_process_groups + if scheduled_state is not None: + self.scheduled_state = scheduled_state + if stateless_flow_timeout is not None: + self.stateless_flow_timeout = stateless_flow_timeout if versioned_flow_coordinates is not None: self.versioned_flow_coordinates = versioned_flow_coordinates - if variables is not None: - self.variables = variables - if parameter_context_name is not None: - self.parameter_context_name = parameter_context_name - if default_flow_file_expiration is not None: - self.default_flow_file_expiration = default_flow_file_expiration - if default_back_pressure_object_threshold is not None: - self.default_back_pressure_object_threshold = default_back_pressure_object_threshold - if default_back_pressure_data_size_threshold is not None: - self.default_back_pressure_data_size_threshold = default_back_pressure_data_size_threshold - if log_file_suffix is not None: - self.log_file_suffix = log_file_suffix - if component_type is not None: - self.component_type = component_type - if flow_file_outbound_policy is not None: - self.flow_file_outbound_policy = flow_file_outbound_policy - if flow_file_concurrency is not None: - self.flow_file_concurrency = flow_file_concurrency - if group_identifier is not None: - self.group_identifier = group_identifier @property - def identifier(self): + def comments(self): """ - Gets the identifier of this VersionedProcessGroup. - The component's unique identifier + Gets the comments of this VersionedProcessGroup. + The user-supplied comments for the component - :return: The identifier of this VersionedProcessGroup. + :return: The comments of this VersionedProcessGroup. :rtype: str """ - return self._identifier + return self._comments - @identifier.setter - def identifier(self, identifier): + @comments.setter + def comments(self, comments): """ - Sets the identifier of this VersionedProcessGroup. - The component's unique identifier + Sets the comments of this VersionedProcessGroup. + The user-supplied comments for the component - :param identifier: The identifier of this VersionedProcessGroup. + :param comments: The comments of this VersionedProcessGroup. :type: str """ - self._identifier = identifier + self._comments = comments @property - def instance_identifier(self): + def component_type(self): """ - Gets the instance_identifier of this VersionedProcessGroup. - The instance ID of an existing component that is described by this VersionedComponent, or null if this is not mapped to an instantiated component + Gets the component_type of this VersionedProcessGroup. - :return: The instance_identifier of this VersionedProcessGroup. + :return: The component_type of this VersionedProcessGroup. :rtype: str """ - return self._instance_identifier + return self._component_type - @instance_identifier.setter - def instance_identifier(self, instance_identifier): + @component_type.setter + def component_type(self, component_type): """ - Sets the instance_identifier of this VersionedProcessGroup. - The instance ID of an existing component that is described by this VersionedComponent, or null if this is not mapped to an instantiated component + Sets the component_type of this VersionedProcessGroup. - :param instance_identifier: The instance_identifier of this VersionedProcessGroup. + :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", ] + 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._instance_identifier = instance_identifier + self._component_type = component_type @property - def name(self): + def connections(self): """ - Gets the name of this VersionedProcessGroup. - The component's name + Gets the connections of this VersionedProcessGroup. + The Connections - :return: The name of this VersionedProcessGroup. + :return: The connections of this VersionedProcessGroup. + :rtype: list[VersionedConnection] + """ + return self._connections + + @connections.setter + def connections(self, connections): + """ + Sets the connections of this VersionedProcessGroup. + The Connections + + :param connections: The connections of this VersionedProcessGroup. + :type: list[VersionedConnection] + """ + + self._connections = connections + + @property + def controller_services(self): + """ + Gets the controller_services of this VersionedProcessGroup. + The Controller Services + + :return: The controller_services of this VersionedProcessGroup. + :rtype: list[VersionedControllerService] + """ + return self._controller_services + + @controller_services.setter + def controller_services(self, controller_services): + """ + Sets the controller_services of this VersionedProcessGroup. + The Controller Services + + :param controller_services: The controller_services of this VersionedProcessGroup. + :type: list[VersionedControllerService] + """ + + self._controller_services = controller_services + + @property + def default_back_pressure_data_size_threshold(self): + """ + Gets the default_back_pressure_data_size_threshold of this VersionedProcessGroup. + Default value used in this Process Group for the maximum data size of objects that can be queued before back pressure is applied. + + :return: The default_back_pressure_data_size_threshold of this VersionedProcessGroup. :rtype: str """ - return self._name + return self._default_back_pressure_data_size_threshold - @name.setter - def name(self, name): + @default_back_pressure_data_size_threshold.setter + def default_back_pressure_data_size_threshold(self, default_back_pressure_data_size_threshold): """ - Sets the name of this VersionedProcessGroup. - The component's name + Sets the default_back_pressure_data_size_threshold of this VersionedProcessGroup. + Default value used in this Process Group for the maximum data size of objects that can be queued before back pressure is applied. - :param name: The name of this VersionedProcessGroup. + :param default_back_pressure_data_size_threshold: The default_back_pressure_data_size_threshold of this VersionedProcessGroup. :type: str """ - self._name = name + self._default_back_pressure_data_size_threshold = default_back_pressure_data_size_threshold @property - def comments(self): + def default_back_pressure_object_threshold(self): """ - Gets the comments of this VersionedProcessGroup. - The user-supplied comments for the component + Gets the default_back_pressure_object_threshold of this VersionedProcessGroup. + Default value used in this Process Group for the maximum number of objects that can be queued before back pressure is applied. - :return: The comments of this VersionedProcessGroup. + :return: The default_back_pressure_object_threshold of this VersionedProcessGroup. + :rtype: int + """ + return self._default_back_pressure_object_threshold + + @default_back_pressure_object_threshold.setter + def default_back_pressure_object_threshold(self, default_back_pressure_object_threshold): + """ + Sets the default_back_pressure_object_threshold of this VersionedProcessGroup. + Default value used in this Process Group for the maximum number of objects that can be queued before back pressure is applied. + + :param default_back_pressure_object_threshold: The default_back_pressure_object_threshold of this VersionedProcessGroup. + :type: int + """ + + self._default_back_pressure_object_threshold = default_back_pressure_object_threshold + + @property + def default_flow_file_expiration(self): + """ + Gets the default_flow_file_expiration of this VersionedProcessGroup. + The default FlowFile Expiration for this Process Group. + + :return: The default_flow_file_expiration of this VersionedProcessGroup. :rtype: str """ - return self._comments + return self._default_flow_file_expiration - @comments.setter - def comments(self, comments): + @default_flow_file_expiration.setter + def default_flow_file_expiration(self, default_flow_file_expiration): """ - Sets the comments of this VersionedProcessGroup. - The user-supplied comments for the component + Sets the default_flow_file_expiration of this VersionedProcessGroup. + The default FlowFile Expiration for this Process Group. - :param comments: The comments of this VersionedProcessGroup. + :param default_flow_file_expiration: The default_flow_file_expiration of this VersionedProcessGroup. :type: str """ - self._comments = comments + self._default_flow_file_expiration = default_flow_file_expiration @property - def position(self): + def execution_engine(self): """ - Gets the position of this VersionedProcessGroup. - The component's position on the graph + Gets the execution_engine of this VersionedProcessGroup. + The Execution Engine that should be used to run the components within the group. - :return: The position of this VersionedProcessGroup. - :rtype: Position + :return: The execution_engine of this VersionedProcessGroup. + :rtype: str """ - return self._position + return self._execution_engine - @position.setter - def position(self, position): + @execution_engine.setter + def execution_engine(self, execution_engine): """ - Sets the position of this VersionedProcessGroup. - The component's position on the graph + Sets the execution_engine of this VersionedProcessGroup. + The Execution Engine that should be used to run the components within the group. - :param position: The position of this VersionedProcessGroup. - :type: Position + :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) + ) - self._position = position + self._execution_engine = execution_engine @property - def process_groups(self): + def flow_file_concurrency(self): """ - Gets the process_groups of this VersionedProcessGroup. - The child Process Groups + Gets the flow_file_concurrency of this VersionedProcessGroup. + The configured FlowFile Concurrency for the Process Group - :return: The process_groups of this VersionedProcessGroup. - :rtype: list[VersionedProcessGroup] + :return: The flow_file_concurrency of this VersionedProcessGroup. + :rtype: str """ - return self._process_groups + return self._flow_file_concurrency - @process_groups.setter - def process_groups(self, process_groups): + @flow_file_concurrency.setter + def flow_file_concurrency(self, flow_file_concurrency): """ - Sets the process_groups of this VersionedProcessGroup. - The child Process Groups + Sets the flow_file_concurrency of this VersionedProcessGroup. + The configured FlowFile Concurrency for the Process Group - :param process_groups: The process_groups of this VersionedProcessGroup. - :type: list[VersionedProcessGroup] + :param flow_file_concurrency: The flow_file_concurrency of this VersionedProcessGroup. + :type: str """ - self._process_groups = process_groups + self._flow_file_concurrency = flow_file_concurrency @property - def remote_process_groups(self): + def flow_file_outbound_policy(self): """ - Gets the remote_process_groups of this VersionedProcessGroup. - The Remote Process Groups + Gets the flow_file_outbound_policy of this VersionedProcessGroup. + The FlowFile Outbound Policy for the Process Group - :return: The remote_process_groups of this VersionedProcessGroup. - :rtype: list[VersionedRemoteProcessGroup] + :return: The flow_file_outbound_policy of this VersionedProcessGroup. + :rtype: str """ - return self._remote_process_groups + return self._flow_file_outbound_policy - @remote_process_groups.setter - def remote_process_groups(self, remote_process_groups): + @flow_file_outbound_policy.setter + def flow_file_outbound_policy(self, flow_file_outbound_policy): """ - Sets the remote_process_groups of this VersionedProcessGroup. - The Remote Process Groups + Sets the flow_file_outbound_policy of this VersionedProcessGroup. + The FlowFile Outbound Policy for the Process Group - :param remote_process_groups: The remote_process_groups of this VersionedProcessGroup. - :type: list[VersionedRemoteProcessGroup] + :param flow_file_outbound_policy: The flow_file_outbound_policy of this VersionedProcessGroup. + :type: str """ - self._remote_process_groups = remote_process_groups + self._flow_file_outbound_policy = flow_file_outbound_policy @property - def processors(self): + def funnels(self): """ - Gets the processors of this VersionedProcessGroup. - The Processors + Gets the funnels of this VersionedProcessGroup. + The Funnels - :return: The processors of this VersionedProcessGroup. - :rtype: list[VersionedProcessor] + :return: The funnels of this VersionedProcessGroup. + :rtype: list[VersionedFunnel] """ - return self._processors + return self._funnels - @processors.setter - def processors(self, processors): + @funnels.setter + def funnels(self, funnels): """ - Sets the processors of this VersionedProcessGroup. - The Processors + Sets the funnels of this VersionedProcessGroup. + The Funnels - :param processors: The processors of this VersionedProcessGroup. - :type: list[VersionedProcessor] + :param funnels: The funnels of this VersionedProcessGroup. + :type: list[VersionedFunnel] """ - self._processors = processors + self._funnels = funnels + + @property + def group_identifier(self): + """ + Gets the group_identifier of this VersionedProcessGroup. + The ID of the Process Group that this component belongs to + + :return: The group_identifier of this VersionedProcessGroup. + :rtype: str + """ + return self._group_identifier + + @group_identifier.setter + def group_identifier(self, group_identifier): + """ + Sets the group_identifier of this VersionedProcessGroup. + The ID of the Process Group that this component belongs to + + :param group_identifier: The group_identifier of this VersionedProcessGroup. + :type: str + """ + + self._group_identifier = group_identifier + + @property + def identifier(self): + """ + Gets the identifier of this VersionedProcessGroup. + The component's unique identifier + + :return: The identifier of this VersionedProcessGroup. + :rtype: str + """ + return self._identifier + + @identifier.setter + def identifier(self, identifier): + """ + Sets the identifier of this VersionedProcessGroup. + The component's unique identifier + + :param identifier: The identifier of this VersionedProcessGroup. + :type: str + """ + + self._identifier = identifier @property def input_ports(self): @@ -373,50 +510,27 @@ def input_ports(self, input_ports): self._input_ports = input_ports @property - def output_ports(self): - """ - Gets the output_ports of this VersionedProcessGroup. - The Output Ports - - :return: The output_ports of this VersionedProcessGroup. - :rtype: list[VersionedPort] - """ - return self._output_ports - - @output_ports.setter - def output_ports(self, output_ports): - """ - Sets the output_ports of this VersionedProcessGroup. - The Output Ports - - :param output_ports: The output_ports of this VersionedProcessGroup. - :type: list[VersionedPort] - """ - - self._output_ports = output_ports - - @property - def connections(self): + def instance_identifier(self): """ - Gets the connections of this VersionedProcessGroup. - The Connections + Gets the instance_identifier of this VersionedProcessGroup. + The instance ID of an existing component that is described by this VersionedComponent, or null if this is not mapped to an instantiated component - :return: The connections of this VersionedProcessGroup. - :rtype: list[VersionedConnection] + :return: The instance_identifier of this VersionedProcessGroup. + :rtype: str """ - return self._connections + return self._instance_identifier - @connections.setter - def connections(self, connections): + @instance_identifier.setter + def instance_identifier(self, instance_identifier): """ - Sets the connections of this VersionedProcessGroup. - The Connections + Sets the instance_identifier of this VersionedProcessGroup. + The instance ID of an existing component that is described by this VersionedComponent, or null if this is not mapped to an instantiated component - :param connections: The connections of this VersionedProcessGroup. - :type: list[VersionedConnection] + :param instance_identifier: The instance_identifier of this VersionedProcessGroup. + :type: str """ - self._connections = connections + self._instance_identifier = instance_identifier @property def labels(self): @@ -442,96 +556,96 @@ def labels(self, labels): self._labels = labels @property - def funnels(self): + def log_file_suffix(self): """ - Gets the funnels of this VersionedProcessGroup. - The Funnels + Gets the log_file_suffix of this VersionedProcessGroup. + The log file suffix for this Process Group for dedicated logging. - :return: The funnels of this VersionedProcessGroup. - :rtype: list[VersionedFunnel] + :return: The log_file_suffix of this VersionedProcessGroup. + :rtype: str """ - return self._funnels + return self._log_file_suffix - @funnels.setter - def funnels(self, funnels): + @log_file_suffix.setter + def log_file_suffix(self, log_file_suffix): """ - Sets the funnels of this VersionedProcessGroup. - The Funnels + Sets the log_file_suffix of this VersionedProcessGroup. + The log file suffix for this Process Group for dedicated logging. - :param funnels: The funnels of this VersionedProcessGroup. - :type: list[VersionedFunnel] + :param log_file_suffix: The log_file_suffix of this VersionedProcessGroup. + :type: str """ - self._funnels = funnels + self._log_file_suffix = log_file_suffix @property - def controller_services(self): + def max_concurrent_tasks(self): """ - Gets the controller_services of this VersionedProcessGroup. - The Controller Services + Gets the max_concurrent_tasks of this VersionedProcessGroup. + The maximum number of concurrent tasks that should be scheduled for this Process Group when using the Stateless Engine - :return: The controller_services of this VersionedProcessGroup. - :rtype: list[VersionedControllerService] + :return: The max_concurrent_tasks of this VersionedProcessGroup. + :rtype: int """ - return self._controller_services + return self._max_concurrent_tasks - @controller_services.setter - def controller_services(self, controller_services): + @max_concurrent_tasks.setter + def max_concurrent_tasks(self, max_concurrent_tasks): """ - Sets the controller_services of this VersionedProcessGroup. - The Controller Services + Sets the max_concurrent_tasks of this VersionedProcessGroup. + The maximum number of concurrent tasks that should be scheduled for this Process Group when using the Stateless Engine - :param controller_services: The controller_services of this VersionedProcessGroup. - :type: list[VersionedControllerService] + :param max_concurrent_tasks: The max_concurrent_tasks of this VersionedProcessGroup. + :type: int """ - self._controller_services = controller_services + self._max_concurrent_tasks = max_concurrent_tasks @property - def versioned_flow_coordinates(self): + def name(self): """ - Gets the versioned_flow_coordinates of this VersionedProcessGroup. - The coordinates where the remote flow is stored, or null if the Process Group is not directly under Version Control + Gets the name of this VersionedProcessGroup. + The component's name - :return: The versioned_flow_coordinates of this VersionedProcessGroup. - :rtype: VersionedFlowCoordinates + :return: The name of this VersionedProcessGroup. + :rtype: str """ - return self._versioned_flow_coordinates + return self._name - @versioned_flow_coordinates.setter - def versioned_flow_coordinates(self, versioned_flow_coordinates): + @name.setter + def name(self, name): """ - Sets the versioned_flow_coordinates of this VersionedProcessGroup. - The coordinates where the remote flow is stored, or null if the Process Group is not directly under Version Control + Sets the name of this VersionedProcessGroup. + The component's name - :param versioned_flow_coordinates: The versioned_flow_coordinates of this VersionedProcessGroup. - :type: VersionedFlowCoordinates + :param name: The name of this VersionedProcessGroup. + :type: str """ - self._versioned_flow_coordinates = versioned_flow_coordinates + self._name = name @property - def variables(self): + def output_ports(self): """ - Gets the variables of this VersionedProcessGroup. - The Variables in the Variable Registry for this Process Group (not including any ancestor or descendant Process Groups) + Gets the output_ports of this VersionedProcessGroup. + The Output Ports - :return: The variables of this VersionedProcessGroup. - :rtype: dict(str, str) + :return: The output_ports of this VersionedProcessGroup. + :rtype: list[VersionedPort] """ - return self._variables + return self._output_ports - @variables.setter - def variables(self, variables): + @output_ports.setter + def output_ports(self, output_ports): """ - Sets the variables of this VersionedProcessGroup. - The Variables in the Variable Registry for this Process Group (not including any ancestor or descendant Process Groups) + Sets the output_ports of this VersionedProcessGroup. + The Output Ports - :param variables: The variables of this VersionedProcessGroup. - :type: dict(str, str) + :param output_ports: The output_ports of this VersionedProcessGroup. + :type: list[VersionedPort] """ - self._variables = variables + self._output_ports = output_ports @property def parameter_context_name(self): @@ -557,192 +671,167 @@ def parameter_context_name(self, parameter_context_name): self._parameter_context_name = parameter_context_name @property - def default_flow_file_expiration(self): + def position(self): """ - Gets the default_flow_file_expiration of this VersionedProcessGroup. - The default FlowFile Expiration for this Process Group. + Gets the position of this VersionedProcessGroup. - :return: The default_flow_file_expiration of this VersionedProcessGroup. - :rtype: str + :return: The position of this VersionedProcessGroup. + :rtype: Position """ - return self._default_flow_file_expiration + return self._position - @default_flow_file_expiration.setter - def default_flow_file_expiration(self, default_flow_file_expiration): + @position.setter + def position(self, position): """ - Sets the default_flow_file_expiration of this VersionedProcessGroup. - The default FlowFile Expiration for this Process Group. + Sets the position of this VersionedProcessGroup. - :param default_flow_file_expiration: The default_flow_file_expiration of this VersionedProcessGroup. - :type: str + :param position: The position of this VersionedProcessGroup. + :type: Position """ - self._default_flow_file_expiration = default_flow_file_expiration + self._position = position @property - def default_back_pressure_object_threshold(self): + def process_groups(self): """ - Gets the default_back_pressure_object_threshold of this VersionedProcessGroup. - Default value used in this Process Group for the maximum number of objects that can be queued before back pressure is applied. + Gets the process_groups of this VersionedProcessGroup. + The child Process Groups - :return: The default_back_pressure_object_threshold of this VersionedProcessGroup. - :rtype: int + :return: The process_groups of this VersionedProcessGroup. + :rtype: list[VersionedProcessGroup] """ - return self._default_back_pressure_object_threshold + return self._process_groups - @default_back_pressure_object_threshold.setter - def default_back_pressure_object_threshold(self, default_back_pressure_object_threshold): + @process_groups.setter + def process_groups(self, process_groups): """ - Sets the default_back_pressure_object_threshold of this VersionedProcessGroup. - Default value used in this Process Group for the maximum number of objects that can be queued before back pressure is applied. + Sets the process_groups of this VersionedProcessGroup. + The child Process Groups - :param default_back_pressure_object_threshold: The default_back_pressure_object_threshold of this VersionedProcessGroup. - :type: int + :param process_groups: The process_groups of this VersionedProcessGroup. + :type: list[VersionedProcessGroup] """ - self._default_back_pressure_object_threshold = default_back_pressure_object_threshold + self._process_groups = process_groups @property - def default_back_pressure_data_size_threshold(self): + def processors(self): """ - Gets the default_back_pressure_data_size_threshold of this VersionedProcessGroup. - Default value used in this Process Group for the maximum data size of objects that can be queued before back pressure is applied. + Gets the processors of this VersionedProcessGroup. + The Processors - :return: The default_back_pressure_data_size_threshold of this VersionedProcessGroup. - :rtype: str + :return: The processors of this VersionedProcessGroup. + :rtype: list[VersionedProcessor] """ - return self._default_back_pressure_data_size_threshold + return self._processors - @default_back_pressure_data_size_threshold.setter - def default_back_pressure_data_size_threshold(self, default_back_pressure_data_size_threshold): + @processors.setter + def processors(self, processors): """ - Sets the default_back_pressure_data_size_threshold of this VersionedProcessGroup. - Default value used in this Process Group for the maximum data size of objects that can be queued before back pressure is applied. + Sets the processors of this VersionedProcessGroup. + The Processors - :param default_back_pressure_data_size_threshold: The default_back_pressure_data_size_threshold of this VersionedProcessGroup. - :type: str + :param processors: The processors of this VersionedProcessGroup. + :type: list[VersionedProcessor] """ - self._default_back_pressure_data_size_threshold = default_back_pressure_data_size_threshold + self._processors = processors @property - def log_file_suffix(self): + def remote_process_groups(self): """ - Gets the log_file_suffix of this VersionedProcessGroup. - The log file suffix for this Process Group for dedicated logging. + Gets the remote_process_groups of this VersionedProcessGroup. + The Remote Process Groups - :return: The log_file_suffix of this VersionedProcessGroup. - :rtype: str + :return: The remote_process_groups of this VersionedProcessGroup. + :rtype: list[VersionedRemoteProcessGroup] """ - return self._log_file_suffix + return self._remote_process_groups - @log_file_suffix.setter - def log_file_suffix(self, log_file_suffix): + @remote_process_groups.setter + def remote_process_groups(self, remote_process_groups): """ - Sets the log_file_suffix of this VersionedProcessGroup. - The log file suffix for this Process Group for dedicated logging. + Sets the remote_process_groups of this VersionedProcessGroup. + The Remote Process Groups - :param log_file_suffix: The log_file_suffix of this VersionedProcessGroup. - :type: str + :param remote_process_groups: The remote_process_groups of this VersionedProcessGroup. + :type: list[VersionedRemoteProcessGroup] """ - self._log_file_suffix = log_file_suffix + self._remote_process_groups = remote_process_groups @property - def component_type(self): + def scheduled_state(self): """ - Gets the component_type of this VersionedProcessGroup. + Gets the scheduled_state of this VersionedProcessGroup. + The Scheduled State of the Process Group, if the group is configured to use the Stateless Execution Engine. Otherwise, this value has no relevance. - :return: The component_type of this VersionedProcessGroup. + :return: The scheduled_state of this VersionedProcessGroup. :rtype: str """ - return self._component_type + return self._scheduled_state - @component_type.setter - def component_type(self, component_type): + @scheduled_state.setter + def scheduled_state(self, scheduled_state): """ - Sets the component_type of this VersionedProcessGroup. + Sets the scheduled_state of this VersionedProcessGroup. + The Scheduled State of the Process Group, if the group is configured to use the Stateless Execution Engine. Otherwise, this value has no relevance. - :param component_type: The component_type of this VersionedProcessGroup. + :param scheduled_state: The scheduled_state 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", "PARAMETER_CONTEXT", "PARAMETER_PROVIDER", "TEMPLATE", "FLOW_REGISTRY_CLIENT"] - if component_type not in allowed_values: + allowed_values = ["ENABLED", "DISABLED", "RUNNING", ] + if scheduled_state not in allowed_values: raise ValueError( - "Invalid value for `component_type` ({0}), must be one of {1}" - .format(component_type, allowed_values) + "Invalid value for `scheduled_state` ({0}), must be one of {1}" + .format(scheduled_state, allowed_values) ) - self._component_type = component_type - - @property - def flow_file_outbound_policy(self): - """ - Gets the flow_file_outbound_policy of this VersionedProcessGroup. - The FlowFile Outbound Policy for the Process Group - - :return: The flow_file_outbound_policy of this VersionedProcessGroup. - :rtype: str - """ - return self._flow_file_outbound_policy - - @flow_file_outbound_policy.setter - def flow_file_outbound_policy(self, flow_file_outbound_policy): - """ - Sets the flow_file_outbound_policy of this VersionedProcessGroup. - The FlowFile Outbound Policy for the Process Group - - :param flow_file_outbound_policy: The flow_file_outbound_policy of this VersionedProcessGroup. - :type: str - """ - - self._flow_file_outbound_policy = flow_file_outbound_policy + self._scheduled_state = scheduled_state @property - def flow_file_concurrency(self): + def stateless_flow_timeout(self): """ - Gets the flow_file_concurrency of this VersionedProcessGroup. - The configured FlowFile Concurrency for the Process Group + Gets the stateless_flow_timeout of this VersionedProcessGroup. + 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 - :return: The flow_file_concurrency of this VersionedProcessGroup. + :return: The stateless_flow_timeout of this VersionedProcessGroup. :rtype: str """ - return self._flow_file_concurrency + return self._stateless_flow_timeout - @flow_file_concurrency.setter - def flow_file_concurrency(self, flow_file_concurrency): + @stateless_flow_timeout.setter + def stateless_flow_timeout(self, stateless_flow_timeout): """ - Sets the flow_file_concurrency of this VersionedProcessGroup. - The configured FlowFile Concurrency for the Process Group + Sets the stateless_flow_timeout of this VersionedProcessGroup. + 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 - :param flow_file_concurrency: The flow_file_concurrency of this VersionedProcessGroup. + :param stateless_flow_timeout: The stateless_flow_timeout of this VersionedProcessGroup. :type: str """ - self._flow_file_concurrency = flow_file_concurrency + self._stateless_flow_timeout = stateless_flow_timeout @property - def group_identifier(self): + def versioned_flow_coordinates(self): """ - Gets the group_identifier of this VersionedProcessGroup. - The ID of the Process Group that this component belongs to + Gets the versioned_flow_coordinates of this VersionedProcessGroup. - :return: The group_identifier of this VersionedProcessGroup. - :rtype: str + :return: The versioned_flow_coordinates of this VersionedProcessGroup. + :rtype: VersionedFlowCoordinates """ - return self._group_identifier + return self._versioned_flow_coordinates - @group_identifier.setter - def group_identifier(self, group_identifier): + @versioned_flow_coordinates.setter + def versioned_flow_coordinates(self, versioned_flow_coordinates): """ - Sets the group_identifier of this VersionedProcessGroup. - The ID of the Process Group that this component belongs to + Sets the versioned_flow_coordinates of this VersionedProcessGroup. - :param group_identifier: The group_identifier of this VersionedProcessGroup. - :type: str + :param versioned_flow_coordinates: The versioned_flow_coordinates of this VersionedProcessGroup. + :type: VersionedFlowCoordinates """ - self._group_identifier = group_identifier + self._versioned_flow_coordinates = versioned_flow_coordinates def to_dict(self): """ diff --git a/nipyapi/registry/models/versioned_processor.py b/nipyapi/registry/models/versioned_processor.py index de0a63ad..f432ad24 100644 --- a/nipyapi/registry/models/versioned_processor.py +++ b/nipyapi/registry/models/versioned_processor.py @@ -1,14 +1,13 @@ """ Apache NiFi Registry REST API - The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components. + REST API definition for Apache NiFi Registry web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,221 +27,269 @@ class VersionedProcessor(object): and the value is json key in definition. """ swagger_types = { - 'identifier': 'str', - 'instance_identifier': 'str', - 'name': 'str', - 'comments': 'str', - 'position': 'Position', - 'type': 'str', - 'bundle': 'Bundle', - 'properties': 'dict(str, str)', - 'property_descriptors': 'dict(str, VersionedPropertyDescriptor)', - 'style': 'dict(str, str)', 'annotation_data': 'str', - 'scheduling_period': 'str', - 'scheduling_strategy': 'str', - 'execution_node': 'str', - 'penalty_duration': 'str', - 'yield_duration': 'str', - 'bulletin_level': 'str', - 'run_duration_millis': 'int', - 'concurrently_schedulable_task_count': 'int', - 'auto_terminated_relationships': 'list[str]', - 'scheduled_state': 'str', - 'retry_count': 'int', - 'retried_relationships': 'list[str]', - 'backoff_mechanism': 'str', - 'max_backoff_period': 'str', - 'component_type': 'str', - 'group_identifier': 'str' - } +'auto_terminated_relationships': 'list[str]', +'backoff_mechanism': 'str', +'bulletin_level': 'str', +'bundle': 'Bundle', +'comments': 'str', +'component_type': 'str', +'concurrently_schedulable_task_count': 'int', +'execution_node': 'str', +'group_identifier': 'str', +'identifier': 'str', +'instance_identifier': 'str', +'max_backoff_period': 'str', +'name': 'str', +'penalty_duration': 'str', +'position': 'Position', +'properties': 'dict(str, str)', +'property_descriptors': 'dict(str, VersionedPropertyDescriptor)', +'retried_relationships': 'list[str]', +'retry_count': 'int', +'run_duration_millis': 'int', +'scheduled_state': 'str', +'scheduling_period': 'str', +'scheduling_strategy': 'str', +'style': 'dict(str, str)', +'type': 'str', +'yield_duration': 'str' } attribute_map = { - 'identifier': 'identifier', - 'instance_identifier': 'instanceIdentifier', - 'name': 'name', - 'comments': 'comments', - 'position': 'position', - 'type': 'type', - 'bundle': 'bundle', - 'properties': 'properties', - 'property_descriptors': 'propertyDescriptors', - 'style': 'style', 'annotation_data': 'annotationData', - 'scheduling_period': 'schedulingPeriod', - 'scheduling_strategy': 'schedulingStrategy', - 'execution_node': 'executionNode', - 'penalty_duration': 'penaltyDuration', - 'yield_duration': 'yieldDuration', - 'bulletin_level': 'bulletinLevel', - 'run_duration_millis': 'runDurationMillis', - 'concurrently_schedulable_task_count': 'concurrentlySchedulableTaskCount', - 'auto_terminated_relationships': 'autoTerminatedRelationships', - 'scheduled_state': 'scheduledState', - 'retry_count': 'retryCount', - 'retried_relationships': 'retriedRelationships', - 'backoff_mechanism': 'backoffMechanism', - 'max_backoff_period': 'maxBackoffPeriod', - 'component_type': 'componentType', - 'group_identifier': 'groupIdentifier' - } - - def __init__(self, identifier=None, instance_identifier=None, name=None, comments=None, position=None, type=None, bundle=None, properties=None, property_descriptors=None, style=None, annotation_data=None, scheduling_period=None, scheduling_strategy=None, execution_node=None, penalty_duration=None, yield_duration=None, bulletin_level=None, run_duration_millis=None, concurrently_schedulable_task_count=None, auto_terminated_relationships=None, scheduled_state=None, retry_count=None, retried_relationships=None, backoff_mechanism=None, max_backoff_period=None, component_type=None, group_identifier=None): +'auto_terminated_relationships': 'autoTerminatedRelationships', +'backoff_mechanism': 'backoffMechanism', +'bulletin_level': 'bulletinLevel', +'bundle': 'bundle', +'comments': 'comments', +'component_type': 'componentType', +'concurrently_schedulable_task_count': 'concurrentlySchedulableTaskCount', +'execution_node': 'executionNode', +'group_identifier': 'groupIdentifier', +'identifier': 'identifier', +'instance_identifier': 'instanceIdentifier', +'max_backoff_period': 'maxBackoffPeriod', +'name': 'name', +'penalty_duration': 'penaltyDuration', +'position': 'position', +'properties': 'properties', +'property_descriptors': 'propertyDescriptors', +'retried_relationships': 'retriedRelationships', +'retry_count': 'retryCount', +'run_duration_millis': 'runDurationMillis', +'scheduled_state': 'scheduledState', +'scheduling_period': 'schedulingPeriod', +'scheduling_strategy': 'schedulingStrategy', +'style': 'style', +'type': 'type', +'yield_duration': 'yieldDuration' } + + def __init__(self, annotation_data=None, auto_terminated_relationships=None, backoff_mechanism=None, bulletin_level=None, bundle=None, comments=None, component_type=None, concurrently_schedulable_task_count=None, execution_node=None, group_identifier=None, identifier=None, instance_identifier=None, max_backoff_period=None, name=None, penalty_duration=None, position=None, properties=None, property_descriptors=None, retried_relationships=None, retry_count=None, run_duration_millis=None, scheduled_state=None, scheduling_period=None, scheduling_strategy=None, style=None, type=None, yield_duration=None): """ VersionedProcessor - a model defined in Swagger """ + self._annotation_data = None + self._auto_terminated_relationships = None + self._backoff_mechanism = None + self._bulletin_level = None + self._bundle = None + self._comments = None + self._component_type = None + self._concurrently_schedulable_task_count = None + self._execution_node = None + self._group_identifier = None self._identifier = None self._instance_identifier = None + self._max_backoff_period = None self._name = None - self._comments = None + self._penalty_duration = None self._position = None - self._type = None - self._bundle = None self._properties = None self._property_descriptors = None - self._style = None - self._annotation_data = None + self._retried_relationships = None + self._retry_count = None + self._run_duration_millis = None + self._scheduled_state = None self._scheduling_period = None self._scheduling_strategy = None - self._execution_node = None - self._penalty_duration = None + self._style = None + self._type = None self._yield_duration = None - self._bulletin_level = None - self._run_duration_millis = None - self._concurrently_schedulable_task_count = None - self._auto_terminated_relationships = None - self._scheduled_state = None - self._retry_count = None - self._retried_relationships = None - self._backoff_mechanism = None - self._max_backoff_period = None - self._component_type = None - self._group_identifier = None + if annotation_data is not None: + self.annotation_data = annotation_data + if auto_terminated_relationships is not None: + self.auto_terminated_relationships = auto_terminated_relationships + if backoff_mechanism is not None: + self.backoff_mechanism = backoff_mechanism + if bulletin_level is not None: + self.bulletin_level = bulletin_level + if bundle is not None: + self.bundle = bundle + if comments is not None: + self.comments = comments + if component_type is not None: + self.component_type = component_type + if concurrently_schedulable_task_count is not None: + self.concurrently_schedulable_task_count = concurrently_schedulable_task_count + if execution_node is not None: + self.execution_node = execution_node + if group_identifier is not None: + self.group_identifier = group_identifier if identifier is not None: self.identifier = identifier if instance_identifier is not None: self.instance_identifier = instance_identifier + if max_backoff_period is not None: + self.max_backoff_period = max_backoff_period if name is not None: self.name = name - if comments is not None: - self.comments = comments + if penalty_duration is not None: + self.penalty_duration = penalty_duration if position is not None: self.position = position - if type is not None: - self.type = type - if bundle is not None: - self.bundle = bundle if properties is not None: self.properties = properties if property_descriptors is not None: self.property_descriptors = property_descriptors - if style is not None: - self.style = style - if annotation_data is not None: - self.annotation_data = annotation_data + if retried_relationships is not None: + self.retried_relationships = retried_relationships + if retry_count is not None: + self.retry_count = retry_count + if run_duration_millis is not None: + self.run_duration_millis = run_duration_millis + if scheduled_state is not None: + self.scheduled_state = scheduled_state if scheduling_period is not None: self.scheduling_period = scheduling_period if scheduling_strategy is not None: self.scheduling_strategy = scheduling_strategy - if execution_node is not None: - self.execution_node = execution_node - if penalty_duration is not None: - self.penalty_duration = penalty_duration + if style is not None: + self.style = style + if type is not None: + self.type = type if yield_duration is not None: self.yield_duration = yield_duration - if bulletin_level is not None: - self.bulletin_level = bulletin_level - if run_duration_millis is not None: - self.run_duration_millis = run_duration_millis - if concurrently_schedulable_task_count is not None: - self.concurrently_schedulable_task_count = concurrently_schedulable_task_count - if auto_terminated_relationships is not None: - self.auto_terminated_relationships = auto_terminated_relationships - if scheduled_state is not None: - self.scheduled_state = scheduled_state - if retry_count is not None: - self.retry_count = retry_count - if retried_relationships is not None: - self.retried_relationships = retried_relationships - if backoff_mechanism is not None: - self.backoff_mechanism = backoff_mechanism - if max_backoff_period is not None: - self.max_backoff_period = max_backoff_period - if component_type is not None: - self.component_type = component_type - if group_identifier is not None: - self.group_identifier = group_identifier @property - def identifier(self): + def annotation_data(self): """ - Gets the identifier of this VersionedProcessor. - The component's unique identifier + Gets the annotation_data of this VersionedProcessor. + The annotation data for the processor used to relay configuration between a custom UI and the procesosr. - :return: The identifier of this VersionedProcessor. + :return: The annotation_data of this VersionedProcessor. :rtype: str """ - return self._identifier + return self._annotation_data - @identifier.setter - def identifier(self, identifier): + @annotation_data.setter + def annotation_data(self, annotation_data): """ - Sets the identifier of this VersionedProcessor. - The component's unique identifier + Sets the annotation_data of this VersionedProcessor. + The annotation data for the processor used to relay configuration between a custom UI and the procesosr. - :param identifier: The identifier of this VersionedProcessor. + :param annotation_data: The annotation_data of this VersionedProcessor. :type: str """ - self._identifier = identifier + self._annotation_data = annotation_data @property - def instance_identifier(self): + def auto_terminated_relationships(self): """ - Gets the instance_identifier of this VersionedProcessor. - The instance ID of an existing component that is described by this VersionedComponent, or null if this is not mapped to an instantiated component + Gets the auto_terminated_relationships of this VersionedProcessor. + The names of all relationships that cause a flow file to be terminated if the relationship is not connected elsewhere. This property differs from the 'isAutoTerminate' property of the RelationshipDTO in that the RelationshipDTO is meant to depict the current configuration, whereas this property can be set in a DTO when updating a Processor in order to change which Relationships should be auto-terminated. - :return: The instance_identifier of this VersionedProcessor. + :return: The auto_terminated_relationships of this VersionedProcessor. + :rtype: list[str] + """ + return self._auto_terminated_relationships + + @auto_terminated_relationships.setter + def auto_terminated_relationships(self, auto_terminated_relationships): + """ + Sets the auto_terminated_relationships of this VersionedProcessor. + The names of all relationships that cause a flow file to be terminated if the relationship is not connected elsewhere. This property differs from the 'isAutoTerminate' property of the RelationshipDTO in that the RelationshipDTO is meant to depict the current configuration, whereas this property can be set in a DTO when updating a Processor in order to change which Relationships should be auto-terminated. + + :param auto_terminated_relationships: The auto_terminated_relationships of this VersionedProcessor. + :type: list[str] + """ + + self._auto_terminated_relationships = auto_terminated_relationships + + @property + def backoff_mechanism(self): + """ + Gets the backoff_mechanism of this VersionedProcessor. + Determines whether the FlowFile should be penalized or the processor should be yielded between retries. + + :return: The backoff_mechanism of this VersionedProcessor. :rtype: str """ - return self._instance_identifier + return self._backoff_mechanism - @instance_identifier.setter - def instance_identifier(self, instance_identifier): + @backoff_mechanism.setter + def backoff_mechanism(self, backoff_mechanism): """ - Sets the instance_identifier of this VersionedProcessor. - The instance ID of an existing component that is described by this VersionedComponent, or null if this is not mapped to an instantiated component + Sets the backoff_mechanism of this VersionedProcessor. + Determines whether the FlowFile should be penalized or the processor should be yielded between retries. - :param instance_identifier: The instance_identifier of this VersionedProcessor. + :param backoff_mechanism: The backoff_mechanism of this VersionedProcessor. :type: str """ + allowed_values = ["PENALIZE_FLOWFILE", "YIELD_PROCESSOR", ] + if backoff_mechanism not in allowed_values: + raise ValueError( + "Invalid value for `backoff_mechanism` ({0}), must be one of {1}" + .format(backoff_mechanism, allowed_values) + ) - self._instance_identifier = instance_identifier + self._backoff_mechanism = backoff_mechanism @property - def name(self): + def bulletin_level(self): """ - Gets the name of this VersionedProcessor. - The component's name + Gets the bulletin_level of this VersionedProcessor. + The level at which the processor will report bulletins. - :return: The name of this VersionedProcessor. + :return: The bulletin_level of this VersionedProcessor. :rtype: str """ - return self._name + return self._bulletin_level - @name.setter - def name(self, name): + @bulletin_level.setter + def bulletin_level(self, bulletin_level): """ - Sets the name of this VersionedProcessor. - The component's name + Sets the bulletin_level of this VersionedProcessor. + The level at which the processor will report bulletins. - :param name: The name of this VersionedProcessor. + :param bulletin_level: The bulletin_level of this VersionedProcessor. :type: str """ - self._name = name + self._bulletin_level = bulletin_level + + @property + def bundle(self): + """ + Gets the bundle of this VersionedProcessor. + + :return: The bundle of this VersionedProcessor. + :rtype: Bundle + """ + return self._bundle + + @bundle.setter + def bundle(self, bundle): + """ + Sets the bundle of this VersionedProcessor. + + :param bundle: The bundle of this VersionedProcessor. + :type: Bundle + """ + + self._bundle = bundle @property def comments(self): @@ -268,303 +315,328 @@ def comments(self, comments): self._comments = comments @property - def position(self): + def component_type(self): """ - Gets the position of this VersionedProcessor. - The component's position on the graph + Gets the component_type of this VersionedProcessor. - :return: The position of this VersionedProcessor. - :rtype: Position + :return: The component_type of this VersionedProcessor. + :rtype: str """ - return self._position + return self._component_type - @position.setter - def position(self, position): + @component_type.setter + def component_type(self, component_type): """ - Sets the position of this VersionedProcessor. - The component's position on the graph + Sets the component_type of this VersionedProcessor. - :param position: The position of this VersionedProcessor. - :type: Position + :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", ] + 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._position = position + self._component_type = component_type @property - def type(self): + def concurrently_schedulable_task_count(self): """ - Gets the type of this VersionedProcessor. - The type of the extension component + Gets the concurrently_schedulable_task_count of this VersionedProcessor. + The number of tasks that should be concurrently schedule for the processor. If the processor doesn't allow parallol processing then any positive input will be ignored. - :return: The type of this VersionedProcessor. - :rtype: str + :return: The concurrently_schedulable_task_count of this VersionedProcessor. + :rtype: int """ - return self._type + return self._concurrently_schedulable_task_count - @type.setter - def type(self, type): + @concurrently_schedulable_task_count.setter + def concurrently_schedulable_task_count(self, concurrently_schedulable_task_count): """ - Sets the type of this VersionedProcessor. - The type of the extension component + Sets the concurrently_schedulable_task_count of this VersionedProcessor. + The number of tasks that should be concurrently schedule for the processor. If the processor doesn't allow parallol processing then any positive input will be ignored. - :param type: The type of this VersionedProcessor. - :type: str + :param concurrently_schedulable_task_count: The concurrently_schedulable_task_count of this VersionedProcessor. + :type: int """ - self._type = type + self._concurrently_schedulable_task_count = concurrently_schedulable_task_count @property - def bundle(self): + def execution_node(self): """ - Gets the bundle of this VersionedProcessor. - Information about the bundle from which the component came + Gets the execution_node of this VersionedProcessor. + Indicates the node where the process will execute. - :return: The bundle of this VersionedProcessor. - :rtype: Bundle + :return: The execution_node of this VersionedProcessor. + :rtype: str """ - return self._bundle + return self._execution_node - @bundle.setter - def bundle(self, bundle): + @execution_node.setter + def execution_node(self, execution_node): """ - Sets the bundle of this VersionedProcessor. - Information about the bundle from which the component came + Sets the execution_node of this VersionedProcessor. + Indicates the node where the process will execute. - :param bundle: The bundle of this VersionedProcessor. - :type: Bundle + :param execution_node: The execution_node of this VersionedProcessor. + :type: str """ - self._bundle = bundle + self._execution_node = execution_node @property - def properties(self): + def group_identifier(self): """ - Gets the properties of this VersionedProcessor. - The properties for the component. Properties whose value is not set will only contain the property name. + Gets the group_identifier of this VersionedProcessor. + The ID of the Process Group that this component belongs to - :return: The properties of this VersionedProcessor. - :rtype: dict(str, str) + :return: The group_identifier of this VersionedProcessor. + :rtype: str """ - return self._properties + return self._group_identifier - @properties.setter - def properties(self, properties): + @group_identifier.setter + def group_identifier(self, group_identifier): """ - Sets the properties of this VersionedProcessor. - The properties for the component. Properties whose value is not set will only contain the property name. + Sets the group_identifier of this VersionedProcessor. + The ID of the Process Group that this component belongs to - :param properties: The properties of this VersionedProcessor. - :type: dict(str, str) + :param group_identifier: The group_identifier of this VersionedProcessor. + :type: str """ - self._properties = properties + self._group_identifier = group_identifier @property - def property_descriptors(self): + def identifier(self): """ - Gets the property_descriptors of this VersionedProcessor. - The property descriptors for the component. + Gets the identifier of this VersionedProcessor. + The component's unique identifier - :return: The property_descriptors of this VersionedProcessor. - :rtype: dict(str, VersionedPropertyDescriptor) + :return: The identifier of this VersionedProcessor. + :rtype: str """ - return self._property_descriptors + return self._identifier - @property_descriptors.setter - def property_descriptors(self, property_descriptors): + @identifier.setter + def identifier(self, identifier): """ - Sets the property_descriptors of this VersionedProcessor. - The property descriptors for the component. + Sets the identifier of this VersionedProcessor. + The component's unique identifier - :param property_descriptors: The property_descriptors of this VersionedProcessor. - :type: dict(str, VersionedPropertyDescriptor) + :param identifier: The identifier of this VersionedProcessor. + :type: str """ - self._property_descriptors = property_descriptors + self._identifier = identifier @property - def style(self): + def instance_identifier(self): """ - Gets the style of this VersionedProcessor. - Stylistic data for rendering in a UI + Gets the instance_identifier of this VersionedProcessor. + The instance ID of an existing component that is described by this VersionedComponent, or null if this is not mapped to an instantiated component - :return: The style of this VersionedProcessor. - :rtype: dict(str, str) + :return: The instance_identifier of this VersionedProcessor. + :rtype: str """ - return self._style + return self._instance_identifier - @style.setter - def style(self, style): + @instance_identifier.setter + def instance_identifier(self, instance_identifier): """ - Sets the style of this VersionedProcessor. - Stylistic data for rendering in a UI + Sets the instance_identifier of this VersionedProcessor. + The instance ID of an existing component that is described by this VersionedComponent, or null if this is not mapped to an instantiated component - :param style: The style of this VersionedProcessor. - :type: dict(str, str) + :param instance_identifier: The instance_identifier of this VersionedProcessor. + :type: str """ - self._style = style + self._instance_identifier = instance_identifier @property - def annotation_data(self): + def max_backoff_period(self): """ - Gets the annotation_data of this VersionedProcessor. - The annotation data for the processor used to relay configuration between a custom UI and the procesosr. + Gets the max_backoff_period of this VersionedProcessor. + Maximum amount of time to be waited during a retry period. - :return: The annotation_data of this VersionedProcessor. + :return: The max_backoff_period of this VersionedProcessor. :rtype: str """ - return self._annotation_data + return self._max_backoff_period - @annotation_data.setter - def annotation_data(self, annotation_data): + @max_backoff_period.setter + def max_backoff_period(self, max_backoff_period): """ - Sets the annotation_data of this VersionedProcessor. - The annotation data for the processor used to relay configuration between a custom UI and the procesosr. + Sets the max_backoff_period of this VersionedProcessor. + Maximum amount of time to be waited during a retry period. - :param annotation_data: The annotation_data of this VersionedProcessor. + :param max_backoff_period: The max_backoff_period of this VersionedProcessor. :type: str """ - self._annotation_data = annotation_data + self._max_backoff_period = max_backoff_period @property - def scheduling_period(self): + def name(self): """ - Gets the scheduling_period of this VersionedProcessor. - The frequency with which to schedule the processor. The format of the value will depend on th value of schedulingStrategy. + Gets the name of this VersionedProcessor. + The component's name - :return: The scheduling_period of this VersionedProcessor. + :return: The name of this VersionedProcessor. :rtype: str """ - return self._scheduling_period + return self._name - @scheduling_period.setter - def scheduling_period(self, scheduling_period): + @name.setter + def name(self, name): """ - Sets the scheduling_period of this VersionedProcessor. - The frequency with which to schedule the processor. The format of the value will depend on th value of schedulingStrategy. + Sets the name of this VersionedProcessor. + The component's name - :param scheduling_period: The scheduling_period of this VersionedProcessor. + :param name: The name of this VersionedProcessor. :type: str """ - self._scheduling_period = scheduling_period + self._name = name @property - def scheduling_strategy(self): + def penalty_duration(self): """ - Gets the scheduling_strategy of this VersionedProcessor. - Indicates whether the processor should be scheduled to run in event or timer driven mode. + Gets the penalty_duration of this VersionedProcessor. + The amout of time that is used when the process penalizes a flowfile. - :return: The scheduling_strategy of this VersionedProcessor. + :return: The penalty_duration of this VersionedProcessor. :rtype: str """ - return self._scheduling_strategy + return self._penalty_duration - @scheduling_strategy.setter - def scheduling_strategy(self, scheduling_strategy): + @penalty_duration.setter + def penalty_duration(self, penalty_duration): """ - Sets the scheduling_strategy of this VersionedProcessor. - Indicates whether the processor should be scheduled to run in event or timer driven mode. + Sets the penalty_duration of this VersionedProcessor. + The amout of time that is used when the process penalizes a flowfile. - :param scheduling_strategy: The scheduling_strategy of this VersionedProcessor. + :param penalty_duration: The penalty_duration of this VersionedProcessor. :type: str """ - self._scheduling_strategy = scheduling_strategy + self._penalty_duration = penalty_duration @property - def execution_node(self): + def position(self): """ - Gets the execution_node of this VersionedProcessor. - Indicates the node where the process will execute. + Gets the position of this VersionedProcessor. - :return: The execution_node of this VersionedProcessor. - :rtype: str + :return: The position of this VersionedProcessor. + :rtype: Position """ - return self._execution_node + return self._position - @execution_node.setter - def execution_node(self, execution_node): + @position.setter + def position(self, position): """ - Sets the execution_node of this VersionedProcessor. - Indicates the node where the process will execute. + Sets the position of this VersionedProcessor. - :param execution_node: The execution_node of this VersionedProcessor. - :type: str + :param position: The position of this VersionedProcessor. + :type: Position """ - self._execution_node = execution_node + self._position = position @property - def penalty_duration(self): + def properties(self): """ - Gets the penalty_duration of this VersionedProcessor. - The amout of time that is used when the process penalizes a flowfile. + Gets the properties of this VersionedProcessor. + The properties for the component. Properties whose value is not set will only contain the property name. - :return: The penalty_duration of this VersionedProcessor. - :rtype: str + :return: The properties of this VersionedProcessor. + :rtype: dict(str, str) """ - return self._penalty_duration + return self._properties - @penalty_duration.setter - def penalty_duration(self, penalty_duration): + @properties.setter + def properties(self, properties): + """ + Sets the properties of this VersionedProcessor. + The properties for the component. Properties whose value is not set will only contain the property name. + + :param properties: The properties of this VersionedProcessor. + :type: dict(str, str) + """ + + self._properties = properties + + @property + def property_descriptors(self): + """ + Gets the property_descriptors of this VersionedProcessor. + The property descriptors for the component. + + :return: The property_descriptors of this VersionedProcessor. + :rtype: dict(str, VersionedPropertyDescriptor) + """ + return self._property_descriptors + + @property_descriptors.setter + def property_descriptors(self, property_descriptors): """ - Sets the penalty_duration of this VersionedProcessor. - The amout of time that is used when the process penalizes a flowfile. + Sets the property_descriptors of this VersionedProcessor. + The property descriptors for the component. - :param penalty_duration: The penalty_duration of this VersionedProcessor. - :type: str + :param property_descriptors: The property_descriptors of this VersionedProcessor. + :type: dict(str, VersionedPropertyDescriptor) """ - self._penalty_duration = penalty_duration + self._property_descriptors = property_descriptors @property - def yield_duration(self): + def retried_relationships(self): """ - Gets the yield_duration of this VersionedProcessor. - The amount of time that must elapse before this processor is scheduled again after yielding. + Gets the retried_relationships of this VersionedProcessor. + All the relationships should be retried. - :return: The yield_duration of this VersionedProcessor. - :rtype: str + :return: The retried_relationships of this VersionedProcessor. + :rtype: list[str] """ - return self._yield_duration + return self._retried_relationships - @yield_duration.setter - def yield_duration(self, yield_duration): + @retried_relationships.setter + def retried_relationships(self, retried_relationships): """ - Sets the yield_duration of this VersionedProcessor. - The amount of time that must elapse before this processor is scheduled again after yielding. + Sets the retried_relationships of this VersionedProcessor. + All the relationships should be retried. - :param yield_duration: The yield_duration of this VersionedProcessor. - :type: str + :param retried_relationships: The retried_relationships of this VersionedProcessor. + :type: list[str] """ - self._yield_duration = yield_duration + self._retried_relationships = retried_relationships @property - def bulletin_level(self): + def retry_count(self): """ - Gets the bulletin_level of this VersionedProcessor. - The level at which the processor will report bulletins. + Gets the retry_count of this VersionedProcessor. + Overall number of retries. - :return: The bulletin_level of this VersionedProcessor. - :rtype: str + :return: The retry_count of this VersionedProcessor. + :rtype: int """ - return self._bulletin_level + return self._retry_count - @bulletin_level.setter - def bulletin_level(self, bulletin_level): + @retry_count.setter + def retry_count(self, retry_count): """ - Sets the bulletin_level of this VersionedProcessor. - The level at which the processor will report bulletins. + Sets the retry_count of this VersionedProcessor. + Overall number of retries. - :param bulletin_level: The bulletin_level of this VersionedProcessor. - :type: str + :param retry_count: The retry_count of this VersionedProcessor. + :type: int """ - self._bulletin_level = bulletin_level + self._retry_count = retry_count @property def run_duration_millis(self): @@ -589,52 +661,6 @@ def run_duration_millis(self, run_duration_millis): self._run_duration_millis = run_duration_millis - @property - def concurrently_schedulable_task_count(self): - """ - Gets the concurrently_schedulable_task_count of this VersionedProcessor. - The number of tasks that should be concurrently schedule for the processor. If the processor doesn't allow parallol processing then any positive input will be ignored. - - :return: The concurrently_schedulable_task_count of this VersionedProcessor. - :rtype: int - """ - return self._concurrently_schedulable_task_count - - @concurrently_schedulable_task_count.setter - def concurrently_schedulable_task_count(self, concurrently_schedulable_task_count): - """ - Sets the concurrently_schedulable_task_count of this VersionedProcessor. - The number of tasks that should be concurrently schedule for the processor. If the processor doesn't allow parallol processing then any positive input will be ignored. - - :param concurrently_schedulable_task_count: The concurrently_schedulable_task_count of this VersionedProcessor. - :type: int - """ - - self._concurrently_schedulable_task_count = concurrently_schedulable_task_count - - @property - def auto_terminated_relationships(self): - """ - Gets the auto_terminated_relationships of this VersionedProcessor. - The names of all relationships that cause a flow file to be terminated if the relationship is not connected elsewhere. This property differs from the 'isAutoTerminate' property of the RelationshipDTO in that the RelationshipDTO is meant to depict the current configuration, whereas this property can be set in a DTO when updating a Processor in order to change which Relationships should be auto-terminated. - - :return: The auto_terminated_relationships of this VersionedProcessor. - :rtype: list[str] - """ - return self._auto_terminated_relationships - - @auto_terminated_relationships.setter - def auto_terminated_relationships(self, auto_terminated_relationships): - """ - Sets the auto_terminated_relationships of this VersionedProcessor. - The names of all relationships that cause a flow file to be terminated if the relationship is not connected elsewhere. This property differs from the 'isAutoTerminate' property of the RelationshipDTO in that the RelationshipDTO is meant to depict the current configuration, whereas this property can be set in a DTO when updating a Processor in order to change which Relationships should be auto-terminated. - - :param auto_terminated_relationships: The auto_terminated_relationships of this VersionedProcessor. - :type: list[str] - """ - - self._auto_terminated_relationships = auto_terminated_relationships - @property def scheduled_state(self): """ @@ -655,7 +681,7 @@ def scheduled_state(self, scheduled_state): :param scheduled_state: The scheduled_state of this VersionedProcessor. :type: str """ - allowed_values = ["ENABLED", "DISABLED", "RUNNING"] + 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}" @@ -665,152 +691,119 @@ def scheduled_state(self, scheduled_state): self._scheduled_state = scheduled_state @property - def retry_count(self): - """ - Gets the retry_count of this VersionedProcessor. - Overall number of retries. - - :return: The retry_count of this VersionedProcessor. - :rtype: int - """ - return self._retry_count - - @retry_count.setter - def retry_count(self, retry_count): - """ - Sets the retry_count of this VersionedProcessor. - Overall number of retries. - - :param retry_count: The retry_count of this VersionedProcessor. - :type: int - """ - - self._retry_count = retry_count - - @property - def retried_relationships(self): + def scheduling_period(self): """ - Gets the retried_relationships of this VersionedProcessor. - All the relationships should be retried. + Gets the scheduling_period of this VersionedProcessor. + The frequency with which to schedule the processor. The format of the value will depend on th value of schedulingStrategy. - :return: The retried_relationships of this VersionedProcessor. - :rtype: list[str] + :return: The scheduling_period of this VersionedProcessor. + :rtype: str """ - return self._retried_relationships + return self._scheduling_period - @retried_relationships.setter - def retried_relationships(self, retried_relationships): + @scheduling_period.setter + def scheduling_period(self, scheduling_period): """ - Sets the retried_relationships of this VersionedProcessor. - All the relationships should be retried. + Sets the scheduling_period of this VersionedProcessor. + The frequency with which to schedule the processor. The format of the value will depend on th value of schedulingStrategy. - :param retried_relationships: The retried_relationships of this VersionedProcessor. - :type: list[str] + :param scheduling_period: The scheduling_period of this VersionedProcessor. + :type: str """ - self._retried_relationships = retried_relationships + self._scheduling_period = scheduling_period @property - def backoff_mechanism(self): + def scheduling_strategy(self): """ - Gets the backoff_mechanism of this VersionedProcessor. - Determines whether the FlowFile should be penalized or the processor should be yielded between retries. + Gets the scheduling_strategy of this VersionedProcessor. + Indicates how the processor should be scheduled to run. - :return: The backoff_mechanism of this VersionedProcessor. + :return: The scheduling_strategy of this VersionedProcessor. :rtype: str """ - return self._backoff_mechanism + return self._scheduling_strategy - @backoff_mechanism.setter - def backoff_mechanism(self, backoff_mechanism): + @scheduling_strategy.setter + def scheduling_strategy(self, scheduling_strategy): """ - Sets the backoff_mechanism of this VersionedProcessor. - Determines whether the FlowFile should be penalized or the processor should be yielded between retries. + Sets the scheduling_strategy of this VersionedProcessor. + Indicates how the processor should be scheduled to run. - :param backoff_mechanism: The backoff_mechanism of this VersionedProcessor. + :param scheduling_strategy: The scheduling_strategy of this VersionedProcessor. :type: str """ - allowed_values = ["PENALIZE_FLOWFILE", "YIELD_PROCESSOR"] - if backoff_mechanism not in allowed_values: - raise ValueError( - "Invalid value for `backoff_mechanism` ({0}), must be one of {1}" - .format(backoff_mechanism, allowed_values) - ) - self._backoff_mechanism = backoff_mechanism + self._scheduling_strategy = scheduling_strategy @property - def max_backoff_period(self): + def style(self): """ - Gets the max_backoff_period of this VersionedProcessor. - Maximum amount of time to be waited during a retry period. + Gets the style of this VersionedProcessor. + Stylistic data for rendering in a UI - :return: The max_backoff_period of this VersionedProcessor. - :rtype: str + :return: The style of this VersionedProcessor. + :rtype: dict(str, str) """ - return self._max_backoff_period + return self._style - @max_backoff_period.setter - def max_backoff_period(self, max_backoff_period): + @style.setter + def style(self, style): """ - Sets the max_backoff_period of this VersionedProcessor. - Maximum amount of time to be waited during a retry period. + Sets the style of this VersionedProcessor. + Stylistic data for rendering in a UI - :param max_backoff_period: The max_backoff_period of this VersionedProcessor. - :type: str + :param style: The style of this VersionedProcessor. + :type: dict(str, str) """ - self._max_backoff_period = max_backoff_period + self._style = style @property - def component_type(self): + def type(self): """ - Gets the component_type of this VersionedProcessor. + Gets the type of this VersionedProcessor. + The type of the extension component - :return: The component_type of this VersionedProcessor. + :return: The type of this VersionedProcessor. :rtype: str """ - return self._component_type + return self._type - @component_type.setter - def component_type(self, component_type): + @type.setter + def type(self, type): """ - Sets the component_type of this VersionedProcessor. + Sets the type of this VersionedProcessor. + The type of the extension component - :param component_type: The component_type of this VersionedProcessor. + :param type: The 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", "PARAMETER_CONTEXT", "PARAMETER_PROVIDER", "TEMPLATE", "FLOW_REGISTRY_CLIENT"] - 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 + self._type = type @property - def group_identifier(self): + def yield_duration(self): """ - Gets the group_identifier of this VersionedProcessor. - The ID of the Process Group that this component belongs to + Gets the yield_duration of this VersionedProcessor. + The amount of time that must elapse before this processor is scheduled again after yielding. - :return: The group_identifier of this VersionedProcessor. + :return: The yield_duration of this VersionedProcessor. :rtype: str """ - return self._group_identifier + return self._yield_duration - @group_identifier.setter - def group_identifier(self, group_identifier): + @yield_duration.setter + def yield_duration(self, yield_duration): """ - Sets the group_identifier of this VersionedProcessor. - The ID of the Process Group that this component belongs to + Sets the yield_duration of this VersionedProcessor. + The amount of time that must elapse before this processor is scheduled again after yielding. - :param group_identifier: The group_identifier of this VersionedProcessor. + :param yield_duration: The yield_duration of this VersionedProcessor. :type: str """ - self._group_identifier = group_identifier + self._yield_duration = yield_duration def to_dict(self): """ diff --git a/nipyapi/registry/models/versioned_property_descriptor.py b/nipyapi/registry/models/versioned_property_descriptor.py index ffaa5ad7..cc5bf436 100644 --- a/nipyapi/registry/models/versioned_property_descriptor.py +++ b/nipyapi/registry/models/versioned_property_descriptor.py @@ -1,14 +1,13 @@ """ Apache NiFi Registry REST API - The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components. + REST API definition for Apache NiFi Registry web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,65 +27,45 @@ class VersionedPropertyDescriptor(object): and the value is json key in definition. """ swagger_types = { - 'name': 'str', 'display_name': 'str', - 'identifies_controller_service': 'bool', - 'sensitive': 'bool', - 'resource_definition': 'VersionedResourceDefinition' - } +'dynamic': 'bool', +'identifies_controller_service': 'bool', +'name': 'str', +'resource_definition': 'VersionedResourceDefinition', +'sensitive': 'bool' } attribute_map = { - 'name': 'name', 'display_name': 'displayName', - 'identifies_controller_service': 'identifiesControllerService', - 'sensitive': 'sensitive', - 'resource_definition': 'resourceDefinition' - } +'dynamic': 'dynamic', +'identifies_controller_service': 'identifiesControllerService', +'name': 'name', +'resource_definition': 'resourceDefinition', +'sensitive': 'sensitive' } - def __init__(self, name=None, display_name=None, identifies_controller_service=None, sensitive=None, resource_definition=None): + def __init__(self, display_name=None, dynamic=None, identifies_controller_service=None, name=None, resource_definition=None, sensitive=None): """ VersionedPropertyDescriptor - a model defined in Swagger """ - self._name = None self._display_name = None + self._dynamic = None self._identifies_controller_service = None - self._sensitive = None + self._name = None self._resource_definition = None + self._sensitive = None - if name is not None: - self.name = name if display_name is not None: self.display_name = display_name + if dynamic is not None: + self.dynamic = dynamic if identifies_controller_service is not None: self.identifies_controller_service = identifies_controller_service - if sensitive is not None: - self.sensitive = sensitive + if name is not None: + self.name = name if resource_definition is not None: self.resource_definition = resource_definition - - @property - def name(self): - """ - Gets the name of this VersionedPropertyDescriptor. - The name of the property - - :return: The name of this VersionedPropertyDescriptor. - :rtype: str - """ - return self._name - - @name.setter - def name(self, name): - """ - Sets the name of this VersionedPropertyDescriptor. - The name of the property - - :param name: The name of this VersionedPropertyDescriptor. - :type: str - """ - - self._name = name + if sensitive is not None: + self.sensitive = sensitive @property def display_name(self): @@ -111,6 +90,29 @@ def display_name(self, display_name): self._display_name = display_name + @property + def dynamic(self): + """ + Gets the dynamic of this VersionedPropertyDescriptor. + Whether or not the property is user-defined + + :return: The dynamic of this VersionedPropertyDescriptor. + :rtype: bool + """ + return self._dynamic + + @dynamic.setter + def dynamic(self, dynamic): + """ + Sets the dynamic of this VersionedPropertyDescriptor. + Whether or not the property is user-defined + + :param dynamic: The dynamic of this VersionedPropertyDescriptor. + :type: bool + """ + + self._dynamic = dynamic + @property def identifies_controller_service(self): """ @@ -135,33 +137,32 @@ def identifies_controller_service(self, identifies_controller_service): self._identifies_controller_service = identifies_controller_service @property - def sensitive(self): + def name(self): """ - Gets the sensitive of this VersionedPropertyDescriptor. - Whether or not the property is considered sensitive + Gets the name of this VersionedPropertyDescriptor. + The name of the property - :return: The sensitive of this VersionedPropertyDescriptor. - :rtype: bool + :return: The name of this VersionedPropertyDescriptor. + :rtype: str """ - return self._sensitive + return self._name - @sensitive.setter - def sensitive(self, sensitive): + @name.setter + def name(self, name): """ - Sets the sensitive of this VersionedPropertyDescriptor. - Whether or not the property is considered sensitive + Sets the name of this VersionedPropertyDescriptor. + The name of the property - :param sensitive: The sensitive of this VersionedPropertyDescriptor. - :type: bool + :param name: The name of this VersionedPropertyDescriptor. + :type: str """ - self._sensitive = sensitive + self._name = name @property def resource_definition(self): """ Gets the resource_definition of this VersionedPropertyDescriptor. - Returns the Resource Definition that defines which type(s) of resource(s) this property references, if any :return: The resource_definition of this VersionedPropertyDescriptor. :rtype: VersionedResourceDefinition @@ -172,7 +173,6 @@ def resource_definition(self): def resource_definition(self, resource_definition): """ Sets the resource_definition of this VersionedPropertyDescriptor. - Returns the Resource Definition that defines which type(s) of resource(s) this property references, if any :param resource_definition: The resource_definition of this VersionedPropertyDescriptor. :type: VersionedResourceDefinition @@ -180,6 +180,29 @@ def resource_definition(self, resource_definition): self._resource_definition = resource_definition + @property + def sensitive(self): + """ + Gets the sensitive of this VersionedPropertyDescriptor. + Whether or not the property is considered sensitive + + :return: The sensitive of this VersionedPropertyDescriptor. + :rtype: bool + """ + return self._sensitive + + @sensitive.setter + def sensitive(self, sensitive): + """ + Sets the sensitive of this VersionedPropertyDescriptor. + Whether or not the property is considered sensitive + + :param sensitive: The sensitive of this VersionedPropertyDescriptor. + :type: bool + """ + + self._sensitive = sensitive + def to_dict(self): """ Returns the model properties as a dict diff --git a/nipyapi/registry/models/versioned_remote_group_port.py b/nipyapi/registry/models/versioned_remote_group_port.py index 7a62d192..c22ceb3b 100644 --- a/nipyapi/registry/models/versioned_remote_group_port.py +++ b/nipyapi/registry/models/versioned_remote_group_port.py @@ -1,14 +1,13 @@ """ Apache NiFi Registry REST API - The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components. + REST API definition for Apache NiFi Registry web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,82 +27,197 @@ class VersionedRemoteGroupPort(object): and the value is json key in definition. """ swagger_types = { - 'identifier': 'str', - 'instance_identifier': 'str', - 'name': 'str', - 'comments': 'str', - 'position': 'Position', - 'remote_group_id': 'str', - 'concurrently_schedulable_task_count': 'int', - 'use_compression': 'bool', 'batch_size': 'BatchSize', - 'component_type': 'str', - 'target_id': 'str', - 'scheduled_state': 'str', - 'group_identifier': 'str' - } +'comments': 'str', +'component_type': 'str', +'concurrently_schedulable_task_count': 'int', +'group_identifier': 'str', +'identifier': 'str', +'instance_identifier': 'str', +'name': 'str', +'position': 'Position', +'remote_group_id': 'str', +'scheduled_state': 'str', +'target_id': 'str', +'use_compression': 'bool' } attribute_map = { - 'identifier': 'identifier', - 'instance_identifier': 'instanceIdentifier', - 'name': 'name', - 'comments': 'comments', - 'position': 'position', - 'remote_group_id': 'remoteGroupId', - 'concurrently_schedulable_task_count': 'concurrentlySchedulableTaskCount', - 'use_compression': 'useCompression', 'batch_size': 'batchSize', - 'component_type': 'componentType', - 'target_id': 'targetId', - 'scheduled_state': 'scheduledState', - 'group_identifier': 'groupIdentifier' - } - - def __init__(self, identifier=None, instance_identifier=None, name=None, comments=None, position=None, remote_group_id=None, concurrently_schedulable_task_count=None, use_compression=None, batch_size=None, component_type=None, target_id=None, scheduled_state=None, group_identifier=None): +'comments': 'comments', +'component_type': 'componentType', +'concurrently_schedulable_task_count': 'concurrentlySchedulableTaskCount', +'group_identifier': 'groupIdentifier', +'identifier': 'identifier', +'instance_identifier': 'instanceIdentifier', +'name': 'name', +'position': 'position', +'remote_group_id': 'remoteGroupId', +'scheduled_state': 'scheduledState', +'target_id': 'targetId', +'use_compression': 'useCompression' } + + def __init__(self, batch_size=None, comments=None, component_type=None, concurrently_schedulable_task_count=None, group_identifier=None, identifier=None, instance_identifier=None, name=None, position=None, remote_group_id=None, scheduled_state=None, target_id=None, use_compression=None): """ VersionedRemoteGroupPort - a model defined in Swagger """ + self._batch_size = None + self._comments = None + self._component_type = None + self._concurrently_schedulable_task_count = None + self._group_identifier = None self._identifier = None self._instance_identifier = None self._name = None - self._comments = None self._position = None self._remote_group_id = None - self._concurrently_schedulable_task_count = None - self._use_compression = None - self._batch_size = None - self._component_type = None - self._target_id = None self._scheduled_state = None - self._group_identifier = None + self._target_id = None + self._use_compression = None + if batch_size is not None: + self.batch_size = batch_size + if comments is not None: + self.comments = comments + if component_type is not None: + self.component_type = component_type + if concurrently_schedulable_task_count is not None: + self.concurrently_schedulable_task_count = concurrently_schedulable_task_count + if group_identifier is not None: + self.group_identifier = group_identifier if identifier is not None: self.identifier = identifier if instance_identifier is not None: self.instance_identifier = instance_identifier if name is not None: self.name = name - if comments is not None: - self.comments = comments if position is not None: self.position = position if remote_group_id is not None: self.remote_group_id = remote_group_id - if concurrently_schedulable_task_count is not None: - self.concurrently_schedulable_task_count = concurrently_schedulable_task_count - if use_compression is not None: - self.use_compression = use_compression - if batch_size is not None: - self.batch_size = batch_size - if component_type is not None: - self.component_type = component_type - if target_id is not None: - self.target_id = target_id if scheduled_state is not None: self.scheduled_state = scheduled_state - if group_identifier is not None: - self.group_identifier = group_identifier + if target_id is not None: + self.target_id = target_id + if use_compression is not None: + self.use_compression = use_compression + + @property + def batch_size(self): + """ + Gets the batch_size of this VersionedRemoteGroupPort. + + :return: The batch_size of this VersionedRemoteGroupPort. + :rtype: BatchSize + """ + return self._batch_size + + @batch_size.setter + def batch_size(self, batch_size): + """ + Sets the batch_size of this VersionedRemoteGroupPort. + + :param batch_size: The batch_size of this VersionedRemoteGroupPort. + :type: BatchSize + """ + + self._batch_size = batch_size + + @property + def comments(self): + """ + Gets the comments of this VersionedRemoteGroupPort. + The user-supplied comments for the component + + :return: The comments of this VersionedRemoteGroupPort. + :rtype: str + """ + return self._comments + + @comments.setter + def comments(self, comments): + """ + Sets the comments of this VersionedRemoteGroupPort. + The user-supplied comments for the component + + :param comments: The comments of this VersionedRemoteGroupPort. + :type: str + """ + + self._comments = comments + + @property + def component_type(self): + """ + Gets the component_type of this VersionedRemoteGroupPort. + + :return: The component_type of this VersionedRemoteGroupPort. + :rtype: str + """ + return self._component_type + + @component_type.setter + def component_type(self, component_type): + """ + Sets the component_type of this VersionedRemoteGroupPort. + + :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", ] + 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 + + @property + def concurrently_schedulable_task_count(self): + """ + Gets the concurrently_schedulable_task_count of this VersionedRemoteGroupPort. + The number of task that may transmit flowfiles to the target port concurrently. + + :return: The concurrently_schedulable_task_count of this VersionedRemoteGroupPort. + :rtype: int + """ + return self._concurrently_schedulable_task_count + + @concurrently_schedulable_task_count.setter + def concurrently_schedulable_task_count(self, concurrently_schedulable_task_count): + """ + Sets the concurrently_schedulable_task_count of this VersionedRemoteGroupPort. + The number of task that may transmit flowfiles to the target port concurrently. + + :param concurrently_schedulable_task_count: The concurrently_schedulable_task_count of this VersionedRemoteGroupPort. + :type: int + """ + + self._concurrently_schedulable_task_count = concurrently_schedulable_task_count + + @property + def group_identifier(self): + """ + Gets the group_identifier of this VersionedRemoteGroupPort. + The ID of the Process Group that this component belongs to + + :return: The group_identifier of this VersionedRemoteGroupPort. + :rtype: str + """ + return self._group_identifier + + @group_identifier.setter + def group_identifier(self, group_identifier): + """ + Sets the group_identifier of this VersionedRemoteGroupPort. + The ID of the Process Group that this component belongs to + + :param group_identifier: The group_identifier of this VersionedRemoteGroupPort. + :type: str + """ + + self._group_identifier = group_identifier @property def identifier(self): @@ -174,34 +288,10 @@ def name(self, name): self._name = name - @property - def comments(self): - """ - Gets the comments of this VersionedRemoteGroupPort. - The user-supplied comments for the component - - :return: The comments of this VersionedRemoteGroupPort. - :rtype: str - """ - return self._comments - - @comments.setter - def comments(self, comments): - """ - Sets the comments of this VersionedRemoteGroupPort. - The user-supplied comments for the component - - :param comments: The comments of this VersionedRemoteGroupPort. - :type: str - """ - - self._comments = comments - @property def position(self): """ Gets the position of this VersionedRemoteGroupPort. - The component's position on the graph :return: The position of this VersionedRemoteGroupPort. :rtype: Position @@ -212,7 +302,6 @@ def position(self): def position(self, position): """ Sets the position of this VersionedRemoteGroupPort. - The component's position on the graph :param position: The position of this VersionedRemoteGroupPort. :type: Position @@ -244,100 +333,33 @@ def remote_group_id(self, remote_group_id): self._remote_group_id = remote_group_id @property - def concurrently_schedulable_task_count(self): - """ - Gets the concurrently_schedulable_task_count of this VersionedRemoteGroupPort. - The number of task that may transmit flowfiles to the target port concurrently. - - :return: The concurrently_schedulable_task_count of this VersionedRemoteGroupPort. - :rtype: int - """ - return self._concurrently_schedulable_task_count - - @concurrently_schedulable_task_count.setter - def concurrently_schedulable_task_count(self, concurrently_schedulable_task_count): - """ - Sets the concurrently_schedulable_task_count of this VersionedRemoteGroupPort. - The number of task that may transmit flowfiles to the target port concurrently. - - :param concurrently_schedulable_task_count: The concurrently_schedulable_task_count of this VersionedRemoteGroupPort. - :type: int - """ - - self._concurrently_schedulable_task_count = concurrently_schedulable_task_count - - @property - def use_compression(self): - """ - Gets the use_compression of this VersionedRemoteGroupPort. - Whether the flowfiles are compressed when sent to the target port. - - :return: The use_compression of this VersionedRemoteGroupPort. - :rtype: bool - """ - return self._use_compression - - @use_compression.setter - def use_compression(self, use_compression): - """ - Sets the use_compression of this VersionedRemoteGroupPort. - Whether the flowfiles are compressed when sent to the target port. - - :param use_compression: The use_compression of this VersionedRemoteGroupPort. - :type: bool - """ - - self._use_compression = use_compression - - @property - def batch_size(self): - """ - Gets the batch_size of this VersionedRemoteGroupPort. - The batch settings for data transmission. - - :return: The batch_size of this VersionedRemoteGroupPort. - :rtype: BatchSize - """ - return self._batch_size - - @batch_size.setter - def batch_size(self, batch_size): - """ - Sets the batch_size of this VersionedRemoteGroupPort. - The batch settings for data transmission. - - :param batch_size: The batch_size of this VersionedRemoteGroupPort. - :type: BatchSize - """ - - self._batch_size = batch_size - - @property - def component_type(self): + def scheduled_state(self): """ - Gets the component_type of this VersionedRemoteGroupPort. + Gets the scheduled_state of this VersionedRemoteGroupPort. + The scheduled state of the component - :return: The component_type of this VersionedRemoteGroupPort. + :return: The scheduled_state of this VersionedRemoteGroupPort. :rtype: str """ - return self._component_type + return self._scheduled_state - @component_type.setter - def component_type(self, component_type): + @scheduled_state.setter + def scheduled_state(self, scheduled_state): """ - Sets the component_type of this VersionedRemoteGroupPort. + Sets the scheduled_state of this VersionedRemoteGroupPort. + The scheduled state of the component - :param component_type: The component_type of this VersionedRemoteGroupPort. + :param scheduled_state: The scheduled_state 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", "PARAMETER_CONTEXT", "PARAMETER_PROVIDER", "TEMPLATE", "FLOW_REGISTRY_CLIENT"] - if component_type not in allowed_values: + allowed_values = ["ENABLED", "DISABLED", "RUNNING", ] + if scheduled_state not in allowed_values: raise ValueError( - "Invalid value for `component_type` ({0}), must be one of {1}" - .format(component_type, allowed_values) + "Invalid value for `scheduled_state` ({0}), must be one of {1}" + .format(scheduled_state, allowed_values) ) - self._component_type = component_type + self._scheduled_state = scheduled_state @property def target_id(self): @@ -363,56 +385,27 @@ def target_id(self, target_id): self._target_id = target_id @property - def scheduled_state(self): - """ - Gets the scheduled_state of this VersionedRemoteGroupPort. - The scheduled state of the component - - :return: The scheduled_state of this VersionedRemoteGroupPort. - :rtype: str - """ - return self._scheduled_state - - @scheduled_state.setter - def scheduled_state(self, scheduled_state): - """ - Sets the scheduled_state of this VersionedRemoteGroupPort. - The scheduled state of the component - - :param scheduled_state: The scheduled_state of this VersionedRemoteGroupPort. - :type: str - """ - allowed_values = ["ENABLED", "DISABLED", "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 - - @property - def group_identifier(self): + def use_compression(self): """ - Gets the group_identifier of this VersionedRemoteGroupPort. - The ID of the Process Group that this component belongs to + Gets the use_compression of this VersionedRemoteGroupPort. + Whether the flowfiles are compressed when sent to the target port. - :return: The group_identifier of this VersionedRemoteGroupPort. - :rtype: str + :return: The use_compression of this VersionedRemoteGroupPort. + :rtype: bool """ - return self._group_identifier + return self._use_compression - @group_identifier.setter - def group_identifier(self, group_identifier): + @use_compression.setter + def use_compression(self, use_compression): """ - Sets the group_identifier of this VersionedRemoteGroupPort. - The ID of the Process Group that this component belongs to + Sets the use_compression of this VersionedRemoteGroupPort. + Whether the flowfiles are compressed when sent to the target port. - :param group_identifier: The group_identifier of this VersionedRemoteGroupPort. - :type: str + :param use_compression: The use_compression of this VersionedRemoteGroupPort. + :type: bool """ - self._group_identifier = group_identifier + self._use_compression = use_compression def to_dict(self): """ diff --git a/nipyapi/registry/models/versioned_remote_process_group.py b/nipyapi/registry/models/versioned_remote_process_group.py index b68edd3a..bf1c9e36 100644 --- a/nipyapi/registry/models/versioned_remote_process_group.py +++ b/nipyapi/registry/models/versioned_remote_process_group.py @@ -1,14 +1,13 @@ """ Apache NiFi Registry REST API - The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components. + REST API definition for Apache NiFi Registry web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -28,371 +27,360 @@ class VersionedRemoteProcessGroup(object): and the value is json key in definition. """ swagger_types = { - 'identifier': 'str', - 'instance_identifier': 'str', - 'name': 'str', 'comments': 'str', - 'position': 'Position', - 'target_uri': 'str', - 'target_uris': 'str', - 'communications_timeout': 'str', - 'yield_duration': 'str', - 'transport_protocol': 'str', - 'local_network_interface': 'str', - 'proxy_host': 'str', - 'proxy_port': 'int', - 'proxy_user': 'str', - 'proxy_password': 'str', - 'input_ports': 'list[VersionedRemoteGroupPort]', - 'output_ports': 'list[VersionedRemoteGroupPort]', - 'component_type': 'str', - 'group_identifier': 'str' - } +'communications_timeout': 'str', +'component_type': 'str', +'group_identifier': 'str', +'identifier': 'str', +'input_ports': 'list[VersionedRemoteGroupPort]', +'instance_identifier': 'str', +'local_network_interface': 'str', +'name': 'str', +'output_ports': 'list[VersionedRemoteGroupPort]', +'position': 'Position', +'proxy_host': 'str', +'proxy_password': 'str', +'proxy_port': 'int', +'proxy_user': 'str', +'target_uris': 'str', +'transport_protocol': 'str', +'yield_duration': 'str' } attribute_map = { - 'identifier': 'identifier', - 'instance_identifier': 'instanceIdentifier', - 'name': 'name', 'comments': 'comments', - 'position': 'position', - 'target_uri': 'targetUri', - 'target_uris': 'targetUris', - 'communications_timeout': 'communicationsTimeout', - 'yield_duration': 'yieldDuration', - 'transport_protocol': 'transportProtocol', - 'local_network_interface': 'localNetworkInterface', - 'proxy_host': 'proxyHost', - 'proxy_port': 'proxyPort', - 'proxy_user': 'proxyUser', - 'proxy_password': 'proxyPassword', - 'input_ports': 'inputPorts', - 'output_ports': 'outputPorts', - 'component_type': 'componentType', - 'group_identifier': 'groupIdentifier' - } - - def __init__(self, identifier=None, instance_identifier=None, name=None, comments=None, position=None, target_uri=None, target_uris=None, communications_timeout=None, yield_duration=None, transport_protocol=None, local_network_interface=None, proxy_host=None, proxy_port=None, proxy_user=None, proxy_password=None, input_ports=None, output_ports=None, component_type=None, group_identifier=None): +'communications_timeout': 'communicationsTimeout', +'component_type': 'componentType', +'group_identifier': 'groupIdentifier', +'identifier': 'identifier', +'input_ports': 'inputPorts', +'instance_identifier': 'instanceIdentifier', +'local_network_interface': 'localNetworkInterface', +'name': 'name', +'output_ports': 'outputPorts', +'position': 'position', +'proxy_host': 'proxyHost', +'proxy_password': 'proxyPassword', +'proxy_port': 'proxyPort', +'proxy_user': 'proxyUser', +'target_uris': 'targetUris', +'transport_protocol': 'transportProtocol', +'yield_duration': 'yieldDuration' } + + def __init__(self, comments=None, communications_timeout=None, component_type=None, group_identifier=None, identifier=None, input_ports=None, instance_identifier=None, local_network_interface=None, name=None, output_ports=None, position=None, proxy_host=None, proxy_password=None, proxy_port=None, proxy_user=None, target_uris=None, transport_protocol=None, yield_duration=None): """ VersionedRemoteProcessGroup - a model defined in Swagger """ + self._comments = None + self._communications_timeout = None + self._component_type = None + self._group_identifier = None self._identifier = None + self._input_ports = None self._instance_identifier = None + self._local_network_interface = None self._name = None - self._comments = None + self._output_ports = None self._position = None - self._target_uri = None - self._target_uris = None - self._communications_timeout = None - self._yield_duration = None - self._transport_protocol = None - self._local_network_interface = None self._proxy_host = None + self._proxy_password = None self._proxy_port = None self._proxy_user = None - self._proxy_password = None - self._input_ports = None - self._output_ports = None - self._component_type = None - self._group_identifier = None + self._target_uris = None + self._transport_protocol = None + self._yield_duration = None + if comments is not None: + self.comments = comments + if communications_timeout is not None: + self.communications_timeout = communications_timeout + if component_type is not None: + self.component_type = component_type + if group_identifier is not None: + self.group_identifier = group_identifier if identifier is not None: self.identifier = identifier + if input_ports is not None: + self.input_ports = input_ports if instance_identifier is not None: self.instance_identifier = instance_identifier + if local_network_interface is not None: + self.local_network_interface = local_network_interface if name is not None: self.name = name - if comments is not None: - self.comments = comments + if output_ports is not None: + self.output_ports = output_ports if position is not None: self.position = position - if target_uri is not None: - self.target_uri = target_uri - if target_uris is not None: - self.target_uris = target_uris - if communications_timeout is not None: - self.communications_timeout = communications_timeout - if yield_duration is not None: - self.yield_duration = yield_duration - if transport_protocol is not None: - self.transport_protocol = transport_protocol - if local_network_interface is not None: - self.local_network_interface = local_network_interface if proxy_host is not None: self.proxy_host = proxy_host + if proxy_password is not None: + self.proxy_password = proxy_password if proxy_port is not None: self.proxy_port = proxy_port if proxy_user is not None: self.proxy_user = proxy_user - if proxy_password is not None: - self.proxy_password = proxy_password - if input_ports is not None: - self.input_ports = input_ports - if output_ports is not None: - self.output_ports = output_ports - if component_type is not None: - self.component_type = component_type - if group_identifier is not None: - self.group_identifier = group_identifier + if target_uris is not None: + self.target_uris = target_uris + if transport_protocol is not None: + self.transport_protocol = transport_protocol + if yield_duration is not None: + self.yield_duration = yield_duration @property - def identifier(self): + def comments(self): """ - Gets the identifier of this VersionedRemoteProcessGroup. - The component's unique identifier + Gets the comments of this VersionedRemoteProcessGroup. + The user-supplied comments for the component - :return: The identifier of this VersionedRemoteProcessGroup. + :return: The comments of this VersionedRemoteProcessGroup. :rtype: str """ - return self._identifier + return self._comments - @identifier.setter - def identifier(self, identifier): + @comments.setter + def comments(self, comments): """ - Sets the identifier of this VersionedRemoteProcessGroup. - The component's unique identifier + Sets the comments of this VersionedRemoteProcessGroup. + The user-supplied comments for the component - :param identifier: The identifier of this VersionedRemoteProcessGroup. + :param comments: The comments of this VersionedRemoteProcessGroup. :type: str """ - self._identifier = identifier + self._comments = comments @property - def instance_identifier(self): + def communications_timeout(self): """ - Gets the instance_identifier of this VersionedRemoteProcessGroup. - The instance ID of an existing component that is described by this VersionedComponent, or null if this is not mapped to an instantiated component + Gets the communications_timeout of this VersionedRemoteProcessGroup. + The time period used for the timeout when communicating with the target. - :return: The instance_identifier of this VersionedRemoteProcessGroup. + :return: The communications_timeout of this VersionedRemoteProcessGroup. :rtype: str """ - return self._instance_identifier + return self._communications_timeout - @instance_identifier.setter - def instance_identifier(self, instance_identifier): + @communications_timeout.setter + def communications_timeout(self, communications_timeout): """ - Sets the instance_identifier of this VersionedRemoteProcessGroup. - The instance ID of an existing component that is described by this VersionedComponent, or null if this is not mapped to an instantiated component + Sets the communications_timeout of this VersionedRemoteProcessGroup. + The time period used for the timeout when communicating with the target. - :param instance_identifier: The instance_identifier of this VersionedRemoteProcessGroup. + :param communications_timeout: The communications_timeout of this VersionedRemoteProcessGroup. :type: str """ - self._instance_identifier = instance_identifier + self._communications_timeout = communications_timeout @property - def name(self): + def component_type(self): """ - Gets the name of this VersionedRemoteProcessGroup. - The component's name + Gets the component_type of this VersionedRemoteProcessGroup. - :return: The name of this VersionedRemoteProcessGroup. + :return: The component_type of this VersionedRemoteProcessGroup. :rtype: str """ - return self._name + return self._component_type - @name.setter - def name(self, name): + @component_type.setter + def component_type(self, component_type): """ - Sets the name of this VersionedRemoteProcessGroup. - The component's name + Sets the component_type of this VersionedRemoteProcessGroup. - :param name: The name of this VersionedRemoteProcessGroup. + :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", ] + 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._name = name + self._component_type = component_type @property - def comments(self): + def group_identifier(self): """ - Gets the comments of this VersionedRemoteProcessGroup. - The user-supplied comments for the component + Gets the group_identifier of this VersionedRemoteProcessGroup. + The ID of the Process Group that this component belongs to - :return: The comments of this VersionedRemoteProcessGroup. + :return: The group_identifier of this VersionedRemoteProcessGroup. :rtype: str """ - return self._comments + return self._group_identifier - @comments.setter - def comments(self, comments): + @group_identifier.setter + def group_identifier(self, group_identifier): """ - Sets the comments of this VersionedRemoteProcessGroup. - The user-supplied comments for the component + Sets the group_identifier of this VersionedRemoteProcessGroup. + The ID of the Process Group that this component belongs to - :param comments: The comments of this VersionedRemoteProcessGroup. + :param group_identifier: The group_identifier of this VersionedRemoteProcessGroup. :type: str """ - self._comments = comments + self._group_identifier = group_identifier @property - def position(self): + def identifier(self): """ - Gets the position of this VersionedRemoteProcessGroup. - The component's position on the graph + Gets the identifier of this VersionedRemoteProcessGroup. + The component's unique identifier - :return: The position of this VersionedRemoteProcessGroup. - :rtype: Position + :return: The identifier of this VersionedRemoteProcessGroup. + :rtype: str """ - return self._position + return self._identifier - @position.setter - def position(self, position): + @identifier.setter + def identifier(self, identifier): """ - Sets the position of this VersionedRemoteProcessGroup. - The component's position on the graph + Sets the identifier of this VersionedRemoteProcessGroup. + The component's unique identifier - :param position: The position of this VersionedRemoteProcessGroup. - :type: Position + :param identifier: The identifier of this VersionedRemoteProcessGroup. + :type: str """ - self._position = position + self._identifier = identifier @property - def target_uri(self): + def input_ports(self): """ - Gets the target_uri of this VersionedRemoteProcessGroup. - [DEPRECATED] The target URI of the remote process group. If target uri is not set, but uris are set, then returns the first uri in the uris. If neither target uri nor uris are set, then returns null. + Gets the input_ports of this VersionedRemoteProcessGroup. + A Set of Input Ports that can be connected to, in order to send data to the remote NiFi instance - :return: The target_uri of this VersionedRemoteProcessGroup. - :rtype: str + :return: The input_ports of this VersionedRemoteProcessGroup. + :rtype: list[VersionedRemoteGroupPort] """ - return self._target_uri + return self._input_ports - @target_uri.setter - def target_uri(self, target_uri): + @input_ports.setter + def input_ports(self, input_ports): """ - Sets the target_uri of this VersionedRemoteProcessGroup. - [DEPRECATED] The target URI of the remote process group. If target uri is not set, but uris are set, then returns the first uri in the uris. If neither target uri nor uris are set, then returns null. + Sets the input_ports of this VersionedRemoteProcessGroup. + A Set of Input Ports that can be connected to, in order to send data to the remote NiFi instance - :param target_uri: The target_uri of this VersionedRemoteProcessGroup. - :type: str + :param input_ports: The input_ports of this VersionedRemoteProcessGroup. + :type: list[VersionedRemoteGroupPort] """ - self._target_uri = target_uri + self._input_ports = input_ports @property - def target_uris(self): + def instance_identifier(self): """ - Gets the target_uris of this VersionedRemoteProcessGroup. - The target URIs of the remote process group. If target uris is not set but target uri is set, then returns the single target uri. If neither target uris nor target uri is set, then returns null. + Gets the instance_identifier of this VersionedRemoteProcessGroup. + The instance ID of an existing component that is described by this VersionedComponent, or null if this is not mapped to an instantiated component - :return: The target_uris of this VersionedRemoteProcessGroup. + :return: The instance_identifier of this VersionedRemoteProcessGroup. :rtype: str """ - return self._target_uris + return self._instance_identifier - @target_uris.setter - def target_uris(self, target_uris): + @instance_identifier.setter + def instance_identifier(self, instance_identifier): """ - Sets the target_uris of this VersionedRemoteProcessGroup. - The target URIs of the remote process group. If target uris is not set but target uri is set, then returns the single target uri. If neither target uris nor target uri is set, then returns null. + Sets the instance_identifier of this VersionedRemoteProcessGroup. + The instance ID of an existing component that is described by this VersionedComponent, or null if this is not mapped to an instantiated component - :param target_uris: The target_uris of this VersionedRemoteProcessGroup. + :param instance_identifier: The instance_identifier of this VersionedRemoteProcessGroup. :type: str """ - self._target_uris = target_uris + self._instance_identifier = instance_identifier @property - def communications_timeout(self): + def local_network_interface(self): """ - Gets the communications_timeout of this VersionedRemoteProcessGroup. - The time period used for the timeout when communicating with the target. + Gets the local_network_interface of this VersionedRemoteProcessGroup. + The local network interface to send/receive data. If not specified, any local address is used. If clustered, all nodes must have an interface with this identifier. - :return: The communications_timeout of this VersionedRemoteProcessGroup. + :return: The local_network_interface of this VersionedRemoteProcessGroup. :rtype: str """ - return self._communications_timeout + return self._local_network_interface - @communications_timeout.setter - def communications_timeout(self, communications_timeout): + @local_network_interface.setter + def local_network_interface(self, local_network_interface): """ - Sets the communications_timeout of this VersionedRemoteProcessGroup. - The time period used for the timeout when communicating with the target. + Sets the local_network_interface of this VersionedRemoteProcessGroup. + The local network interface to send/receive data. If not specified, any local address is used. If clustered, all nodes must have an interface with this identifier. - :param communications_timeout: The communications_timeout of this VersionedRemoteProcessGroup. + :param local_network_interface: The local_network_interface of this VersionedRemoteProcessGroup. :type: str """ - self._communications_timeout = communications_timeout + self._local_network_interface = local_network_interface @property - def yield_duration(self): + def name(self): """ - Gets the yield_duration of this VersionedRemoteProcessGroup. - When yielding, this amount of time must elapse before the remote process group is scheduled again. + Gets the name of this VersionedRemoteProcessGroup. + The component's name - :return: The yield_duration of this VersionedRemoteProcessGroup. + :return: The name of this VersionedRemoteProcessGroup. :rtype: str """ - return self._yield_duration + return self._name - @yield_duration.setter - def yield_duration(self, yield_duration): + @name.setter + def name(self, name): """ - Sets the yield_duration of this VersionedRemoteProcessGroup. - When yielding, this amount of time must elapse before the remote process group is scheduled again. + Sets the name of this VersionedRemoteProcessGroup. + The component's name - :param yield_duration: The yield_duration of this VersionedRemoteProcessGroup. + :param name: The name of this VersionedRemoteProcessGroup. :type: str """ - self._yield_duration = yield_duration + self._name = name @property - def transport_protocol(self): + def output_ports(self): """ - Gets the transport_protocol of this VersionedRemoteProcessGroup. - The Transport Protocol that is used for Site-to-Site communications + Gets the output_ports of this VersionedRemoteProcessGroup. + A Set of Output Ports that can be connected to, in order to pull data from the remote NiFi instance - :return: The transport_protocol of this VersionedRemoteProcessGroup. - :rtype: str + :return: The output_ports of this VersionedRemoteProcessGroup. + :rtype: list[VersionedRemoteGroupPort] """ - return self._transport_protocol + return self._output_ports - @transport_protocol.setter - def transport_protocol(self, transport_protocol): + @output_ports.setter + def output_ports(self, output_ports): """ - Sets the transport_protocol of this VersionedRemoteProcessGroup. - The Transport Protocol that is used for Site-to-Site communications + Sets the output_ports of this VersionedRemoteProcessGroup. + A Set of Output Ports that can be connected to, in order to pull data from the remote NiFi instance - :param transport_protocol: The transport_protocol of this VersionedRemoteProcessGroup. - :type: str + :param output_ports: The output_ports of this VersionedRemoteProcessGroup. + :type: list[VersionedRemoteGroupPort] """ - allowed_values = ["RAW", "HTTP"] - 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 + self._output_ports = output_ports @property - def local_network_interface(self): + def position(self): """ - Gets the local_network_interface of this VersionedRemoteProcessGroup. - The local network interface to send/receive data. If not specified, any local address is used. If clustered, all nodes must have an interface with this identifier. + Gets the position of this VersionedRemoteProcessGroup. - :return: The local_network_interface of this VersionedRemoteProcessGroup. - :rtype: str + :return: The position of this VersionedRemoteProcessGroup. + :rtype: Position """ - return self._local_network_interface + return self._position - @local_network_interface.setter - def local_network_interface(self, local_network_interface): + @position.setter + def position(self, position): """ - Sets the local_network_interface of this VersionedRemoteProcessGroup. - The local network interface to send/receive data. If not specified, any local address is used. If clustered, all nodes must have an interface with this identifier. + Sets the position of this VersionedRemoteProcessGroup. - :param local_network_interface: The local_network_interface of this VersionedRemoteProcessGroup. - :type: str + :param position: The position of this VersionedRemoteProcessGroup. + :type: Position """ - self._local_network_interface = local_network_interface + self._position = position @property def proxy_host(self): @@ -415,6 +403,27 @@ def proxy_host(self, proxy_host): self._proxy_host = proxy_host + @property + def proxy_password(self): + """ + Gets the proxy_password of this VersionedRemoteProcessGroup. + + :return: The proxy_password of this VersionedRemoteProcessGroup. + :rtype: str + """ + return self._proxy_password + + @proxy_password.setter + def proxy_password(self, proxy_password): + """ + Sets the proxy_password of this VersionedRemoteProcessGroup. + + :param proxy_password: The proxy_password of this VersionedRemoteProcessGroup. + :type: str + """ + + self._proxy_password = proxy_password + @property def proxy_port(self): """ @@ -458,121 +467,79 @@ def proxy_user(self, proxy_user): self._proxy_user = proxy_user @property - def proxy_password(self): + def target_uris(self): """ - Gets the proxy_password of this VersionedRemoteProcessGroup. + Gets the target_uris of this VersionedRemoteProcessGroup. + The target URIs of the remote process group. If target uris is not set but target uri is set, then returns the single target uri. If neither target uris nor target uri is set, then returns null. - :return: The proxy_password of this VersionedRemoteProcessGroup. + :return: The target_uris of this VersionedRemoteProcessGroup. :rtype: str """ - return self._proxy_password + return self._target_uris - @proxy_password.setter - def proxy_password(self, proxy_password): + @target_uris.setter + def target_uris(self, target_uris): """ - Sets the proxy_password of this VersionedRemoteProcessGroup. + Sets the target_uris of this VersionedRemoteProcessGroup. + The target URIs of the remote process group. If target uris is not set but target uri is set, then returns the single target uri. If neither target uris nor target uri is set, then returns null. - :param proxy_password: The proxy_password of this VersionedRemoteProcessGroup. + :param target_uris: The target_uris of this VersionedRemoteProcessGroup. :type: str """ - self._proxy_password = proxy_password - - @property - def input_ports(self): - """ - Gets the input_ports of this VersionedRemoteProcessGroup. - A Set of Input Ports that can be connected to, in order to send data to the remote NiFi instance - - :return: The input_ports of this VersionedRemoteProcessGroup. - :rtype: list[VersionedRemoteGroupPort] - """ - return self._input_ports - - @input_ports.setter - def input_ports(self, input_ports): - """ - Sets the input_ports of this VersionedRemoteProcessGroup. - A Set of Input Ports that can be connected to, in order to send data to the remote NiFi instance - - :param input_ports: The input_ports of this VersionedRemoteProcessGroup. - :type: list[VersionedRemoteGroupPort] - """ - - self._input_ports = input_ports - - @property - def output_ports(self): - """ - Gets the output_ports of this VersionedRemoteProcessGroup. - A Set of Output Ports that can be connected to, in order to pull data from the remote NiFi instance - - :return: The output_ports of this VersionedRemoteProcessGroup. - :rtype: list[VersionedRemoteGroupPort] - """ - return self._output_ports - - @output_ports.setter - def output_ports(self, output_ports): - """ - Sets the output_ports of this VersionedRemoteProcessGroup. - A Set of Output Ports that can be connected to, in order to pull data from the remote NiFi instance - - :param output_ports: The output_ports of this VersionedRemoteProcessGroup. - :type: list[VersionedRemoteGroupPort] - """ - - self._output_ports = output_ports + self._target_uris = target_uris @property - def component_type(self): + def transport_protocol(self): """ - Gets the component_type of this VersionedRemoteProcessGroup. + Gets the transport_protocol of this VersionedRemoteProcessGroup. + The Transport Protocol that is used for Site-to-Site communications - :return: The component_type of this VersionedRemoteProcessGroup. + :return: The transport_protocol of this VersionedRemoteProcessGroup. :rtype: str """ - return self._component_type + return self._transport_protocol - @component_type.setter - def component_type(self, component_type): + @transport_protocol.setter + def transport_protocol(self, transport_protocol): """ - Sets the component_type of this VersionedRemoteProcessGroup. + Sets the transport_protocol of this VersionedRemoteProcessGroup. + The Transport Protocol that is used for Site-to-Site communications - :param component_type: The component_type of this VersionedRemoteProcessGroup. + :param transport_protocol: The transport_protocol 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", "PARAMETER_CONTEXT", "PARAMETER_PROVIDER", "TEMPLATE", "FLOW_REGISTRY_CLIENT"] - if component_type not in allowed_values: + allowed_values = ["RAW", "HTTP", ] + if transport_protocol not in allowed_values: raise ValueError( - "Invalid value for `component_type` ({0}), must be one of {1}" - .format(component_type, allowed_values) + "Invalid value for `transport_protocol` ({0}), must be one of {1}" + .format(transport_protocol, allowed_values) ) - self._component_type = component_type + self._transport_protocol = transport_protocol @property - def group_identifier(self): + def yield_duration(self): """ - Gets the group_identifier of this VersionedRemoteProcessGroup. - The ID of the Process Group that this component belongs to + Gets the yield_duration of this VersionedRemoteProcessGroup. + When yielding, this amount of time must elapse before the remote process group is scheduled again. - :return: The group_identifier of this VersionedRemoteProcessGroup. + :return: The yield_duration of this VersionedRemoteProcessGroup. :rtype: str """ - return self._group_identifier + return self._yield_duration - @group_identifier.setter - def group_identifier(self, group_identifier): + @yield_duration.setter + def yield_duration(self, yield_duration): """ - Sets the group_identifier of this VersionedRemoteProcessGroup. - The ID of the Process Group that this component belongs to + Sets the yield_duration of this VersionedRemoteProcessGroup. + When yielding, this amount of time must elapse before the remote process group is scheduled again. - :param group_identifier: The group_identifier of this VersionedRemoteProcessGroup. + :param yield_duration: The yield_duration of this VersionedRemoteProcessGroup. :type: str """ - self._group_identifier = group_identifier + self._yield_duration = yield_duration def to_dict(self): """ diff --git a/nipyapi/registry/models/versioned_resource_definition.py b/nipyapi/registry/models/versioned_resource_definition.py index a16a0d0d..9f572780 100644 --- a/nipyapi/registry/models/versioned_resource_definition.py +++ b/nipyapi/registry/models/versioned_resource_definition.py @@ -1,14 +1,13 @@ """ Apache NiFi Registry REST API - The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components. + REST API definition for Apache NiFi Registry web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from pprint import pformat import re @@ -29,13 +28,11 @@ class VersionedResourceDefinition(object): """ swagger_types = { 'cardinality': 'str', - 'resource_types': 'list[str]' - } +'resource_types': 'list[str]' } attribute_map = { 'cardinality': 'cardinality', - 'resource_types': 'resourceTypes' - } +'resource_types': 'resourceTypes' } def __init__(self, cardinality=None, resource_types=None): """ @@ -70,7 +67,7 @@ def cardinality(self, cardinality): :param cardinality: The cardinality of this VersionedResourceDefinition. :type: str """ - allowed_values = ["SINGLE", "MULTIPLE"] + allowed_values = ["SINGLE", "MULTIPLE", ] if cardinality not in allowed_values: raise ValueError( "Invalid value for `cardinality` ({0}), must be one of {1}" @@ -99,7 +96,7 @@ def resource_types(self, resource_types): :param resource_types: The resource_types of this VersionedResourceDefinition. :type: list[str] """ - allowed_values = ["FILE", "DIRECTORY", "TEXT", "URL"] + 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}]" diff --git a/nipyapi/registry/rest.py b/nipyapi/registry/rest.py index b263f4d9..f9cb602e 100644 --- a/nipyapi/registry/rest.py +++ b/nipyapi/registry/rest.py @@ -1,14 +1,13 @@ """ Apache NiFi Registry REST API - The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components. + REST API definition for Apache NiFi Registry web services - OpenAPI spec version: 1.28.1 + OpenAPI spec version: 2.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ - import io import json import ssl @@ -65,7 +64,7 @@ def __init__(self, pools_size=4, maxsize=4): cert_reqs = ssl.CERT_REQUIRED if config.verify_ssl else ssl.CERT_NONE # ca_certs - ca_certs = (config.ssl_ca_cert if config.ssl_ca_cert + ca_certs = (config.ssl_ca_cert if config.ssl_ca_cert else certifi.where()) # cert_file @@ -83,42 +82,31 @@ def __init__(self, pools_size=4, maxsize=4): # proxy proxy = config.proxy - # https pool manager + # Common pool manager parameters + pool_kwargs = { + 'num_pools': pools_size, + 'maxsize': maxsize, + 'cert_reqs': cert_reqs, + 'ca_certs': ca_certs, + 'cert_file': cert_file, + 'key_file': key_file, + 'key_password': key_password, + 'ssl_context': ssl_context, + } + + # Only override hostname checking when user explicitly disables it + # Default urllib3 behavior (secure hostname checking) is used otherwise + if config.disable_host_check is True: + pool_kwargs['assert_hostname'] = False + + # Create appropriate pool manager based on proxy configuration if proxy and "socks" not in str(proxy): - self.pool_manager = urllib3.ProxyManager( - num_pools=pools_size, - maxsize=maxsize, - cert_reqs=cert_reqs, - ca_certs=ca_certs, - cert_file=cert_file, - key_file=key_file, - key_password=key_password, - ssl_context=ssl_context, - proxy_url=proxy - ) + self.pool_manager = urllib3.ProxyManager(proxy_url=proxy, **pool_kwargs) elif proxy and "socks" in str(proxy): self.pool_manager = urllib3.contrib.socks.SOCKSProxyManager( - num_pools=pools_size, - maxsize=maxsize, - cert_reqs=cert_reqs, - ca_certs=ca_certs, - cert_file=cert_file, - key_file=key_file, - key_password=key_password, - ssl_context=ssl_context, - proxy_url=proxy - ) + proxy_url=proxy, **pool_kwargs) else: - self.pool_manager = urllib3.PoolManager( - num_pools=pools_size, - maxsize=maxsize, - cert_reqs=cert_reqs, - ca_certs=ca_certs, - cert_file=cert_file, - key_file=key_file, - key_password=key_password, - ssl_context=ssl_context - ) + self.pool_manager = urllib3.PoolManager(**pool_kwargs) def request(self, method, url, query_params=None, headers=None, @@ -300,7 +288,7 @@ def __init__(self, status=None, reason=None, http_resp=None): self.status = http_resp.status self.reason = http_resp.reason self.body = http_resp.data - self.headers = (http_resp.headers if hasattr(http_resp, 'headers') + self.headers = (http_resp.headers if hasattr(http_resp, 'headers') else http_resp.getheaders()) else: self.status = status diff --git a/nipyapi/security.py b/nipyapi/security.py index be3b0bdb..0433faf9 100644 --- a/nipyapi/security.py +++ b/nipyapi/security.py @@ -1,3 +1,4 @@ +# pylint: disable=C0302 """ Secure connectivity management for NiPyApi """ @@ -5,13 +6,19 @@ import logging import ssl from copy import copy + +import requests import urllib3 + import nipyapi log = logging.getLogger(__name__) __all__ = [ + "set_ssl_warning_suppression", + "reset_service_connections", + "set_shared_ca_cert", "create_service_user", "create_service_user_group", "set_service_auth_token", @@ -27,10 +34,13 @@ "add_user_group_to_access_policy", "bootstrap_security_policies", "service_login", + "service_login_oidc", "remove_service_user", "list_service_user_groups", "get_service_user_group", "remove_service_user_group", + "create_ssl_context_controller_service", + "ensure_ssl_context", ] # These are the known-valid policy actions @@ -39,6 +49,72 @@ _valid_services = ["nifi", "registry"] +# --- Configuration Application Functions --- + + +def set_shared_ca_cert(ca_cert_path): + """Set CA certificate for both NiFi and Registry services. + + This is the typical pattern since both services usually trust the same + Certificate Authority. + + Args: + ca_cert_path (str): Path to the CA certificate file + """ + nipyapi.config.nifi_config.ssl_ca_cert = ca_cert_path + nipyapi.config.registry_config.ssl_ca_cert = ca_cert_path + + +def set_ssl_warning_suppression(suppress_warnings): + """Control SSL warning suppression. + + Args: + suppress_warnings (bool): Whether to suppress SSL warnings. + True = suppress warnings (development/self-signed certs) + False = show warnings (production/security audit) + """ + assert isinstance(suppress_warnings, bool), "suppress_warnings must be boolean" + + if suppress_warnings: + urllib3.disable_warnings(urllib3.exceptions.InsecureRequestWarning) + log.debug("SSL warnings suppressed") + else: + # Note: urllib3 warnings cannot be re-enabled once disabled + # This is a limitation of urllib3 itself + log.debug("SSL warnings should be enabled (urllib3 limitation: cannot re-enable)") + + +def reset_service_connections(service=None): + """Reset service connections by logging out and clearing API clients. + + Args: + service (str, optional): 'nifi', 'registry', or None for both services. + Defaults to None (both services). + """ + services = [] + if service is None: + services = _valid_services + elif service in _valid_services: + services = [service] + else: + raise ValueError(f"Invalid service '{service}'. Must be 'nifi', 'registry', or None.") + + for svc in services: + log.debug("Resetting %s connection...", svc) + + # Best effort logout + try: + service_logout(svc) + log.debug("%s logout successful", svc.title()) + except Exception as e: # pylint: disable=broad-exception-caught + log.debug("%s logout failed (expected if not logged in): %s", svc.title(), e) + + # Force API client reset + config_obj = getattr(nipyapi.config, f"{svc}_config") + config_obj.api_client = None + log.debug("%s API client reset", svc.title()) + + def list_service_users(service="nifi"): """Lists all users of a given service, takes a service name as a string""" assert service in _valid_services @@ -66,8 +142,7 @@ def get_service_user(identifier, identifier_type="identity", service="nifi"): assert isinstance(identifier, str) assert isinstance(identifier_type, str) obj = list_service_users(service) - out = nipyapi.utils.filter_obj(obj, identifier, identifier_type, - greedy=False) + out = nipyapi.utils.filter_obj(obj, identifier, identifier_type, greedy=False) return out @@ -110,7 +185,8 @@ def create_service_user(identity, service="nifi", strict=True): strict (bool): If Strict, will error if user already exists Returns: - The new (User) or (UserEntity) object + The new :class:`~nipyapi.registry.models.User` or + :class:`~nipyapi.nifi.models.UserEntity` object """ assert service in _valid_services @@ -126,15 +202,13 @@ def create_service_user(identity, service="nifi", strict=True): ) try: return getattr(nipyapi, service).TenantsApi().create_user(user_obj) - except (nipyapi.nifi.rest.ApiException, - nipyapi.registry.rest.ApiException) as e: + except (nipyapi.nifi.rest.ApiException, nipyapi.registry.rest.ApiException) as e: if "already exists" in e.body and not strict: return get_service_user(identity, service=service) raise ValueError(e.body) from e -def create_service_user_group(identity, service="nifi", users=None, - strict=True): +def create_service_user_group(identity, service="nifi", users=None, strict=True): """ Attempts to create a user with the provided identity and member users in the given service @@ -147,7 +221,8 @@ def create_service_user_group(identity, service="nifi", users=None, strict (bool): Whether to throw an error on already exists Returns: - The new (UserGroup) or (UserGroupEntity) object + The new :class:`~nipyapi.registry.models.UserGroup` or + :class:`~nipyapi.nifi.models.UserGroupEntity` object """ assert service in _valid_services @@ -157,26 +232,20 @@ def create_service_user_group(identity, service="nifi", users=None, if service == "nifi": if users: - assert all(isinstance(user, nipyapi.nifi.UserEntity) - for user in users) + assert all(isinstance(user, nipyapi.nifi.UserEntity) for user in users) users_ids = [{"id": user.id} for user in users] user_group_obj = nipyapi.nifi.UserGroupEntity( revision=nipyapi.nifi.RevisionDTO(version=0), - component=nipyapi.nifi.UserGroupDTO(identity=identity, - users=users_ids), + component=nipyapi.nifi.UserGroupDTO(identity=identity, users=users_ids), ) else: if users: - assert all(isinstance(user, nipyapi.registry.User) - for user in users) + assert all(isinstance(user, nipyapi.registry.User) for user in users) users_ids = [{"identifier": user.identifier} for user in users] - user_group_obj = nipyapi.registry.UserGroup(identity=identity, - users=users_ids) + user_group_obj = nipyapi.registry.UserGroup(identity=identity, users=users_ids) try: - return getattr(nipyapi, service).TenantsApi().create_user_group( - user_group_obj) - except (nipyapi.nifi.rest.ApiException, - nipyapi.registry.rest.ApiException) as e: + return getattr(nipyapi, service).TenantsApi().create_user_group(user_group_obj) + except (nipyapi.nifi.rest.ApiException, nipyapi.registry.rest.ApiException) as e: if "already exists" in e.body: if not strict: return get_service_user_group(identity, service=service) @@ -201,8 +270,7 @@ def list_service_user_groups(service="nifi"): return out -def get_service_user_group(identifier, identifier_type="identity", - service="nifi"): +def get_service_user_group(identifier, identifier_type="identity", service="nifi"): """ Gets the unique group matching to the given identifier and type. @@ -219,8 +287,7 @@ def get_service_user_group(identifier, identifier_type="identity", assert isinstance(identifier, str) assert isinstance(identifier_type, str) obj = list_service_user_groups(service) - out = nipyapi.utils.filter_obj(obj, identifier, identifier_type, - greedy=False) + out = nipyapi.utils.filter_obj(obj, identifier, identifier_type, greedy=False) return out @@ -245,8 +312,7 @@ def remove_service_user_group(group, service="nifi", strict=True): submit = {"id": group.id, "version": group.revision.version} assert isinstance(strict, bool) try: - return getattr(nipyapi, service).TenantsApi().remove_user_group( - **submit) + return getattr(nipyapi, service).TenantsApi().remove_user_group(**submit) except getattr(nipyapi, service).rest.ApiException as e: if "Unable to find user" in e.body or "does not exist" in e.body: if not strict: @@ -254,8 +320,7 @@ def remove_service_user_group(group, service="nifi", strict=True): raise ValueError(e.body) from e -def service_login(service="nifi", username=None, password=None, - bool_response=False): +def service_login(service="nifi", username=None, password=None, bool_response=False): """ Login to the currently configured NiFi or NiFi-Registry server. @@ -295,31 +360,35 @@ def service_login(service="nifi", username=None, password=None, assert configuration.host.startswith( "https" ), "Login is only available when connecting over HTTPS." - default_pword = getattr(nipyapi.config, "default_" + service + "_password") - default_uname = getattr(nipyapi.config, "default_" + service + "_username") - # We use copy so we don't clobber the default by mistake - pword = password if password is not None else copy(default_pword) - uname = username if username is not None else copy(default_uname) + default_pword = getattr(nipyapi.config, "default_" + service + "_password", None) + default_uname = getattr(nipyapi.config, "default_" + service + "_username", None) + # Prefer explicitly provided credentials, then configuration-set creds, then deprecated defaults + cfg_uname = getattr(configuration, "username", None) + cfg_pword = getattr(configuration, "password", None) + uname = ( + username + if username is not None + else (copy(cfg_uname) if cfg_uname else copy(default_uname)) + ) + pword = ( + password + if password is not None + else (copy(cfg_pword) if cfg_pword else copy(default_pword)) + ) assert pword, "Password must be set or in default config" assert uname, "Username must be set or in default config" # set username/password in configuration for initial login # Registry pulls from config, NiFi allows submission configuration.username = uname configuration.password = pword - log.info( - "Attempting tokenAuth login with user identity [%s]", - configuration.username - ) + log.info("Attempting bearerAuth login with user identity [%s]", configuration.username) try: if service == "nifi": - token = nipyapi.nifi.AccessApi().create_access_token( - username=uname, password=pword - ) - else: - token = ( - nipyapi.registry.AccessApi() - .create_access_token_using_basic_auth_credentials() - ) + token = nipyapi.nifi.AccessApi().create_access_token(username=uname, password=pword) + set_service_auth_token(token=token, service=service) + return True + # else: + token = nipyapi.registry.AccessApi().create_access_token_using_basic_auth_credentials() set_service_auth_token(token=token, service=service) return True except getattr(nipyapi, service).rest.ApiException as e: @@ -328,14 +397,111 @@ def service_login(service="nifi", username=None, password=None, raise ValueError(e.body) from e -def set_service_auth_token(token=None, token_name="tokenAuth", service="nifi"): +# pylint: disable=too-many-arguments,too-many-positional-arguments +def service_login_oidc( + service="nifi", + username=None, + password=None, + oidc_token_endpoint=None, + client_id=None, + client_secret=None, + bool_response=False, + return_token_info=False, +): + """ + Login to NiFi using OpenID Connect (OIDC) OAuth2 password flow. + + This method acquires an access token from an OIDC provider using the + OAuth2 Resource Owner Password Credentials flow (RFC 6749) and configures + the service to use bearer token authentication. + NiFi does not currently provide native methods for OIDC authentication. + + Args: + service (str): 'nifi' or 'registry'; the service to login to + (currently only 'nifi' supports OIDC) + username (str): The username to submit to the OIDC provider + password (str): The password to use with the OIDC provider + oidc_token_endpoint (str): The OIDC token endpoint URL + (e.g., 'http://localhost:8080/realms/nipyapi/protocol/openid-connect/token') + client_id (str): The OIDC client ID + client_secret (str): The OIDC client secret + bool_response (bool): If True, the function will return False instead + of an error. Useful for connection testing. + return_token_info (bool): If True, return the full OAuth2 token response + instead of just a boolean. Useful for extracting user identity information. + + Returns: + (bool or dict): True if successful (default), False if bool_response=True and failed, + or full OAuth2 token response dict if return_token_info=True. + See bool_response and return_token_info. + + """ + log_args = locals() + log_args["password"] = "REDACTED" + log_args["client_secret"] = "REDACTED" + log.info("Called service_login_oidc with args %s", log_args) + + assert service in _valid_services + assert username is None or isinstance(username, str) + assert password is None or isinstance(password, str) + assert oidc_token_endpoint is None or isinstance(oidc_token_endpoint, str) + assert client_id is None or isinstance(client_id, str) + assert client_secret is None or isinstance(client_secret, str) + assert isinstance(bool_response, bool) + + if service == "registry": + raise ValueError("OIDC authentication is not supported for Registry service") + + # Validate required parameters + if not all([username, password, oidc_token_endpoint, client_id, client_secret]): + raise ValueError( + "OIDC login requires username, password, oidc_token_endpoint, " + "client_id, and client_secret" + ) + + try: + token_response = requests.post( + oidc_token_endpoint, + headers={"Content-Type": "application/x-www-form-urlencoded"}, + timeout=30, + data={ + "grant_type": "password", + "client_id": client_id, + "client_secret": client_secret, + "username": username, + "password": password, + }, + ) + + if token_response.status_code == 200: + token_data = token_response.json() + access_token = token_data["access_token"] + set_service_auth_token(token=access_token, service=service) + + if return_token_info: + return token_data + return True + + if bool_response: + return False + raise ValueError( + f"OIDC token acquisition failed: {token_response.status_code} {token_response.text}" + ) + + except Exception as e: + if bool_response: + return False + raise ValueError(f"OIDC authentication error: {e}") from e + + +def set_service_auth_token(token=None, token_name="bearerAuth", service="nifi"): """ Helper method to set the auth token correctly for the specified service Args: token (Optional[str]): The token to set. Defaults to None. token_name (str): the api_key field name to set the token to. Defaults - to 'tokenAuth' + to 'bearerAuth' service (str): 'nifi' or 'registry', the service to set Returns: @@ -408,15 +574,23 @@ def get_service_access_status(service="nifi", bool_response=False): log.debug("- bool_response is True, disabling urllib3 warnings") logging.getLogger("urllib3").setLevel(logging.ERROR) try: - out = getattr(nipyapi, service).AccessApi().get_access_status() - log.info("Got server response, returning") - return out + # NiFi 2.x: use FlowApi.get_current_user() as status check + if service == "nifi": + return nipyapi.nifi.FlowApi().get_current_user() + # Registry 2.x: use AboutApi.get_version() as a benign reachability check + # This does not assert auth, but serves as a health/status probe + return nipyapi.registry.AboutApi().get_version() + except AttributeError as e: + # NiFi 2.x removed AccessApi.get_access_status; treat as unavailable + log.debug("AccessApi.get_access_status not available: %s", e) + if bool_response: + return False + raise except urllib3.exceptions.MaxRetryError as e: log.debug("- Caught exception %s", type(e)) if bool_response: log.debug( - "Connection failed with error %s and bool_response is " - "True, returning False", + "Connection failed with error %s and bool_response is True, returning False", e, ) return False @@ -433,8 +607,7 @@ def get_service_access_status(service="nifi", bool_response=False): raise e -def add_user_to_access_policy(user, policy, service="nifi", refresh=True, - strict=True): +def add_user_to_access_policy(user, policy, service="nifi", refresh=True, strict=True): """ Attempts to add the given user object to the given access policy @@ -461,8 +634,7 @@ def add_user_to_access_policy(user, policy, service="nifi", refresh=True, ) assert isinstance( user, - nipyapi.registry.User if service == "registry" - else nipyapi.nifi.UserEntity, + nipyapi.registry.User if service == "registry" else nipyapi.nifi.UserEntity, ) user_id = user.id if service == "nifi" else user.identifier @@ -471,8 +643,7 @@ def add_user_to_access_policy(user, policy, service="nifi", refresh=True, policy_tgt = ( getattr(nipyapi, service) .PoliciesApi() - .get_access_policy(policy.id if service == "nifi" - else policy.identifier) + .get_access_policy(policy.id if service == "nifi" else policy.identifier) ) else: policy_tgt = policy @@ -486,14 +657,26 @@ def add_user_to_access_policy(user, policy, service="nifi", refresh=True, ), ) - policy_users = ( - policy_tgt.users if service == "registry" - else policy_tgt.component.users - ) - policy_user_ids = [ - i.identifier if service == "registry" else i.id for i in policy_users - ] + policy_users = policy_tgt.users if service == "registry" else policy_tgt.component.users + policy_user_ids = [i.identifier if service == "registry" else i.id for i in policy_users] + # Add concise debug context to help trace registry bootstrap activity + try: + pol_resource = getattr(policy_tgt, "resource", None) + pol_action = getattr(policy_tgt, "action", None) + if pol_resource is None and hasattr(policy_tgt, "component"): + pol_resource = getattr(policy_tgt.component, "resource", None) + pol_action = getattr(policy_tgt.component, "action", None) + except Exception: # pylint: disable=broad-exception-caught # best-effort logging only + pol_resource = None + pol_action = None if user_id not in policy_user_ids: + log.info( + "add_user_to_access_policy: service=%s action=%s resource=%s add user=%s", + service, + pol_action, + pol_resource, + getattr(user, "identity", user_id), + ) if service == "registry": policy_tgt.users.append(user) elif service == "nifi": @@ -504,8 +687,7 @@ def add_user_to_access_policy(user, policy, service="nifi", refresh=True, raise ValueError("Strict is True and User ID already in Policy") -def add_user_group_to_access_policy(user_group, policy, service="nifi", - refresh=True): +def add_user_group_to_access_policy(user_group, policy, service="nifi", refresh=True): """ Attempts to add the given user group object to the given access policy @@ -530,22 +712,15 @@ def add_user_group_to_access_policy(user_group, policy, service="nifi", ) assert isinstance( user_group, - ( - nipyapi.registry.UserGroup - if service == "registry" - else nipyapi.nifi.UserGroupEntity - ), - ) - user_group_id = ( - user_group.id if service == "nifi" else user_group.identifier + (nipyapi.registry.UserGroup if service == "registry" else nipyapi.nifi.UserGroupEntity), ) + user_group_id = user_group.id if service == "nifi" else user_group.identifier if refresh: policy_tgt = ( getattr(nipyapi, service) .PoliciesApi() - .get_access_policy(policy.id if service == "nifi" - else policy.identifier) + .get_access_policy(policy.id if service == "nifi" else policy.identifier) ) else: policy_tgt = policy @@ -560,12 +735,10 @@ def add_user_group_to_access_policy(user_group, policy, service="nifi", ) policy_user_groups = ( - policy_tgt.users if service == "registry" - else policy_tgt.component.user_groups + policy_tgt.users if service == "registry" else policy_tgt.component.user_groups ) policy_user_group_ids = [ - i.identifier if service == "registry" else i.id - for i in policy_user_groups + i.identifier if service == "registry" else i.id for i in policy_user_groups ] assert user_group_id not in policy_user_group_ids @@ -587,7 +760,7 @@ def update_access_policy(policy, service="nifi"): service (str): 'nifi' or 'registry' to indicate the target service Returns: - (PolicyEntity): The updated policy if successful + :class:`~nipyapi.nifi.models.AccessPolicyEntity`: The updated policy if successful """ assert service in _valid_services @@ -604,15 +777,12 @@ def update_access_policy(policy, service="nifi"): getattr(nipyapi, service) .PoliciesApi() .update_access_policy( - id=policy.id if service == "nifi" else policy.identifier, - body=policy + id=policy.id if service == "nifi" else policy.identifier, body=policy ) ) -def get_access_policy_for_resource( - resource, action, r_id=None, service="nifi", auto_create=False -): +def get_access_policy_for_resource(resource, action, r_id=None, service="nifi", auto_create=False): """ Attempts to retrieve the access policy for a given resource and action, and optionally resource_id if targeting NiFi. Optionally creates the policy @@ -640,8 +810,7 @@ def get_access_policy_for_resource( # Strip leading '/' from resource as lookup endpoint prepends a '/' resource = resource[1:] if resource.startswith("/") else resource - log.info("Getting %s Policy for %s:%s:%s", service, action, resource, - str(r_id)) + log.info("Getting %s Policy for %s:%s:%s", service, action, resource, str(r_id)) if service == "nifi": pol_api = nipyapi.nifi.PoliciesApi() else: @@ -649,12 +818,11 @@ def get_access_policy_for_resource( try: nipyapi.utils.bypass_slash_encoding(service, True) response = pol_api.get_access_policy_for_resource( - action=action, - resource="/".join([resource, r_id]) if r_id else resource + action=action, resource="/".join([resource, r_id]) if r_id else resource ) nipyapi.utils.bypass_slash_encoding(service, False) return response - except nipyapi.nifi.rest.ApiException as e: + except (nipyapi.nifi.rest.ApiException, nipyapi.registry.rest.ApiException) as e: if any( pol_string in e.body for pol_string in [ @@ -666,9 +834,7 @@ def get_access_policy_for_resource( log.info("Access policy not found") if not auto_create: return None - return nipyapi.security.create_access_policy( - resource, action, r_id, service - ) + return nipyapi.security.create_access_policy(resource, action, r_id, service) log.info("Unexpected Error, raising...") raise ValueError(e.body) from e finally: @@ -705,8 +871,7 @@ def create_access_policy(resource, action, r_id=None, service="nifi"): body=nipyapi.nifi.AccessPolicyEntity( revision=nipyapi.nifi.RevisionDTO(version=0), component=nipyapi.nifi.AccessPolicyDTO( - action=action, - resource="/".join([r, r_id]) if r_id else r + action=action, resource="/".join([r, r_id]) if r_id else r ), ) ) @@ -723,7 +888,7 @@ def set_service_ssl_context( client_cert_file=None, client_key_file=None, client_key_password=None, - check_hostname=None, + disable_host_check=None, purpose=None, ): """ @@ -752,16 +917,14 @@ def set_service_ssl_context( client_key_file (str): An encrypted (password-protected) PEM file containing the client's secret key client_key_password (str): The password to decrypt the client_key_file - check_hostname (bool): Enable or Disable hostname checking + disable_host_check (bool): Set to True to disable hostname checking purpose (ssl.Purpose): The purpose of the SSLContext Returns: (None) """ assert service in ["nifi", "registry"] - ssl_context = ssl.create_default_context( - purpose=purpose or ssl.Purpose.SERVER_AUTH - ) + ssl_context = ssl.create_default_context(purpose=purpose or ssl.Purpose.SERVER_AUTH) if client_cert_file is not None and client_key_file is not None: try: ssl_context.load_cert_chain( @@ -778,17 +941,24 @@ def set_service_ssl_context( except ssl.SSLError as e: if e.errno == 9: raise ssl.SSLError( - "This error possibly pertains to a mis-typed or " - "incorrect key password" + "This error possibly pertains to a mis-typed or incorrect key password" ) from e if ca_file is not None: ssl_context.load_verify_locations(cafile=ca_file) - if check_hostname is not None: - ssl_context.check_hostname = check_hostname + # CRITICAL SSL constraint: hostname checking requires certificate verification + # When no CA file is provided, we cannot verify certificates, so hostname checking is disabled + if ca_file is None: + # No CA file = no certificate verification possible, force disable hostname checking + ssl_context.check_hostname = False + if disable_host_check is None: + log.warning( + "No CA file provided - force disabling hostname checking for SSL compatibility" + ) else: - ssl_context.check_hostname = nipyapi.config.global_ssl_host_check + # CA file provided = certificate verification possible, respect user configuration + ssl_context.check_hostname = not (disable_host_check or False) if service == "registry": nipyapi.config.registry_config.ssl_context = ssl_context @@ -796,8 +966,10 @@ def set_service_ssl_context( nipyapi.config.nifi_config.ssl_context = ssl_context -# pylint: disable=W0702,R0912,r0914 -def bootstrap_security_policies(service, user_identity=None, group_identity=None): +# pylint: disable=W0702,R0912,r0914,R0915 +def bootstrap_security_policies( + service, user_identity=None, group_identity=None, nifi_proxy_identity=None +): """Creates a default security context within NiFi or Nifi-Registry. Args: @@ -818,14 +990,28 @@ def bootstrap_security_policies(service, user_identity=None, group_identity=None if "nifi" in service: rpg_id = nipyapi.canvas.get_root_pg_id() if user_identity is None and group_identity is None: - # Try to find user by certificate DN if using mTLS - nifi_user_identity = nipyapi.security.get_service_user( - nipyapi.config.default_mtls_identity, service="nifi" - ) - # Fall back to default username if not found - if not nifi_user_identity: + # Prefer currently authenticated user for policy bootstrapping + current_user = nipyapi.nifi.FlowApi().get_current_user() + current_identity = None + if current_user and not getattr(current_user, "anonymous", True): + current_identity = current_user.identity + # Resolve or create a NiFi user entity for the current identity + nifi_user_identity = None + if current_identity: nifi_user_identity = nipyapi.security.get_service_user( - nipyapi.config.default_nifi_username, service="nifi" + current_identity, service="nifi" + ) + if not nifi_user_identity: + # Ensure a user entity exists to attach policies + nifi_user_identity = nipyapi.security.create_service_user( + identity=current_identity, service="nifi", strict=False + ) + # If no current identity could be resolved, skip attaching a default + # identity here. Callers should pass explicit identities. + if not nifi_user_identity: + log.warning( + "bootstrap_nifi: no current user identity resolved; " + "skipping user policy attachment" ) else: nifi_user_identity = user_identity @@ -838,6 +1024,8 @@ def bootstrap_security_policies(service, user_identity=None, group_identity=None ("read", "system", None), ("read", "system-diagnostics", None), ("read", "policies", None), + ("read", "controller", None), + ("write", "controller", None), ] for pol in access_policies: ap = nipyapi.security.get_access_policy_for_resource( @@ -853,101 +1041,122 @@ def bootstrap_security_policies(service, user_identity=None, group_identity=None # break the server :-) ) try: nipyapi.security.add_user_group_to_access_policy( - user_group=group_identity, - policy=ap, - service="nifi" + user_group=group_identity, policy=ap, service="nifi" ) except: # noqa pass else: nipyapi.security.add_user_to_access_policy( - user=nifi_user_identity, - policy=ap, - service="nifi", - strict=False + user=nifi_user_identity, policy=ap, service="nifi", strict=False ) else: + log.info("bootstrap_security_policies: starting registry bootstrap") + # Respect explicit caller-provided identity only; do not guess defaults here if user_identity is None and group_identity is None: - # Try to find user by certificate DN if using mTLS - reg_user_identity = nipyapi.security.get_service_user( - nipyapi.config.default_mtls_identity, service="registry" - ) - # Fall back to default username if not found - if not reg_user_identity: - reg_user_identity = nipyapi.security.get_service_user( - nipyapi.config.default_registry_username, - service="registry" - ) + reg_user_identity = None else: reg_user_identity = user_identity - - all_buckets_access_policies = [ - ("read", "/buckets"), - ("write", "/buckets"), - ("delete", "/buckets"), - ] - for action, resource in all_buckets_access_policies: - pol = nipyapi.security.get_access_policy_for_resource( - resource=resource, - action=action, - service="registry", - auto_create=True + if reg_user_identity: + log.info( + "bootstrap_registry: resolved reg_user_identity=%s", + getattr(reg_user_identity, "identity", None), ) - if reg_user_identity is None: - if group_identity: # Only try to add group if it exists - nipyapi.security.add_user_group_to_access_policy( - user_group=group_identity, - policy=pol, - service="registry" + + try: + all_buckets_access_policies = [ + ("read", "/buckets"), + ("write", "/buckets"), + ("delete", "/buckets"), + ] + for action, resource in all_buckets_access_policies: + pol = nipyapi.security.get_access_policy_for_resource( + resource=resource, action=action, service="registry", auto_create=True + ) + log.info( + "bootstrap_registry: ensure policy action=%s resource=%s id=%s", + action, + resource, + getattr(pol, "identifier", None), + ) + if reg_user_identity is None: + if group_identity: # Only try to add group if it exists + nipyapi.security.add_user_group_to_access_policy( + user_group=group_identity, policy=pol, service="registry" + ) + else: + nipyapi.security.add_user_to_access_policy( + user=reg_user_identity, policy=pol, service="registry", strict=False ) - else: + except Exception as e: # pylint: disable=broad-exception-caught + log.warning("Registry bucket policy bootstrap skipped due to error: %s", e) + # Setup Proxy Access for NiFi's TLS client identity if provided + if nifi_proxy_identity: + log.info( + "bootstrap_registry: ensuring proxy DN=%s user and policies", + nifi_proxy_identity, + ) + nifi_proxy_user = nipyapi.security.create_service_user( + identity=nifi_proxy_identity, service="registry", strict=False + ) + # Grant global buckets read/write so proxy can operate across all buckets + for action in ("read", "write"): + pol = nipyapi.security.get_access_policy_for_resource( + resource="/buckets", + action=action, + service="registry", + auto_create=True, + ) + log.info( + "bootstrap_registry: attach proxy to /buckets action=%s policy id=%s", + action, + getattr(pol, "identifier", None), + ) nipyapi.security.add_user_to_access_policy( - user=reg_user_identity, + user=nifi_proxy_user, policy=pol, service="registry", - strict=False + strict=False, + ) + proxy_access_policies = [ + ("read", "/proxy"), + ("write", "/proxy"), + ("delete", "/proxy"), + ] + for action, resource in proxy_access_policies: + pol = nipyapi.security.get_access_policy_for_resource( + resource=resource, action=action, service="registry", auto_create=True + ) + log.info( + "bootstrap_registry: attach proxy to %s action=%s policy id=%s", + resource, + action, + getattr(pol, "identifier", None), + ) + nipyapi.security.add_user_to_access_policy( + user=nifi_proxy_user, policy=pol, service="registry", strict=False ) - # get the identity of the user as a string - if isinstance(reg_user_identity, nipyapi.registry.User): - reg_user_ident_str = reg_user_identity.identity - else: - reg_user_ident_str = reg_user_identity - # Setup Proxy Access - nifi_proxy_user = nipyapi.security.create_service_user( - identity=reg_user_ident_str, - service="registry", - strict=False - ) - proxy_access_policies = [ - ("read", "/proxy"), - ("write", "/proxy"), - ("delete", "/proxy"), - ] - for action, resource in proxy_access_policies: - pol = nipyapi.security.get_access_policy_for_resource( - resource=resource, - action=action, - service="registry", - auto_create=True - ) - nipyapi.security.add_user_to_access_policy( - user=nifi_proxy_user, - policy=pol, - service="registry", - strict=False - ) def create_ssl_context_controller_service( - parent_pg, name, keystore_file, keystore_password, truststore_file, truststore_password, - key_password=None, keystore_type=None, truststore_type=None, ssl_protocol=None, - ssl_service_type=None): + parent_pg, + name, + keystore_file=None, + keystore_password=None, + truststore_file=None, + truststore_password=None, + key_password=None, + keystore_type=None, + truststore_type=None, + ssl_protocol=None, + ssl_service_type=None, +): """ Creates and configures an SSL Context Service for secure client connections. Note that once created it can be listed and deleted using the standard canvas functions. Args: - parent_pg (ProcessGroupEntity): The Process Group to create the service in + parent_pg (:class:`~nipyapi.nifi.models.ProcessGroupEntity`): The Process Group to + create the service in name (str): Name for the SSL Context Service keystore_file (str): Path to the client certificate/keystore file keystore_password (str): Password for the keystore @@ -965,8 +1174,8 @@ def create_ssl_context_controller_service( """ assert isinstance(parent_pg, nipyapi.nifi.ProcessGroupEntity) assert isinstance(name, str) - assert isinstance(keystore_file, str) - assert isinstance(keystore_password, str) + assert keystore_file is None or isinstance(keystore_file, str) + assert keystore_password is None or isinstance(keystore_password, str) assert isinstance(truststore_file, str) assert isinstance(truststore_password, str) assert key_password is None or isinstance(key_password, str) @@ -974,23 +1183,137 @@ def create_ssl_context_controller_service( assert truststore_type is None or isinstance(truststore_type, str) assert ssl_protocol is None or isinstance(ssl_protocol, str) - default_ssl_service_type = 'org.apache.nifi.ssl.StandardRestrictedSSLContextService' + default_ssl_service_type = "org.apache.nifi.ssl.StandardRestrictedSSLContextService" with nipyapi.utils.rest_exceptions(): + props = { + "Truststore Filename": truststore_file, + "Truststore Password": truststore_password, + "Truststore Type": truststore_type or "JKS", + "SSL Protocol": ssl_protocol or "TLS", + } + if keystore_file: + props.update( + { + "Keystore Filename": keystore_file, + "Keystore Password": keystore_password or "", + "key-password": key_password or keystore_password or "", + "Keystore Type": keystore_type or "JKS", + } + ) return nipyapi.nifi.ControllerApi().create_controller_service( body=nipyapi.nifi.ControllerServiceEntity( - revision=nipyapi.nifi.RevisionDTO( - version=0 - ), + revision=nipyapi.nifi.RevisionDTO(version=0), component=nipyapi.nifi.ControllerServiceDTO( - type=ssl_service_type or default_ssl_service_type, - name=name, - properties={ - 'Keystore Filename': keystore_file, - 'Keystore Password': keystore_password, - 'key-password': key_password or keystore_password, - 'Keystore Type': keystore_type or 'JKS', - 'Truststore Filename': truststore_file, - 'Truststore Password': truststore_password, - 'Truststore Type': truststore_type or 'JKS', - 'SSL Protocol': ssl_protocol or 'TLS' - }))) + type=ssl_service_type or default_ssl_service_type, name=name, properties=props + ), + ) + ) + + +def ensure_ssl_context( + name, + parent_pg, + keystore_file=None, + keystore_password=None, + truststore_file=None, + truststore_password=None, + key_password=None, + keystore_type=None, + truststore_type=None, + ssl_protocol=None, + ssl_service_type=None, +): + """ + Ensures an SSL Context Service exists, creating it if necessary. + + This is a convenience function that implements the common pattern of: + 1. Try to get existing SSL context service by name + 2. If not found, create it + 3. Ensure it's scheduled/enabled + 4. Handle race conditions gracefully + + Args: + name (str): Name for the SSL Context Service + parent_pg (:class:`~nipyapi.nifi.models.ProcessGroupEntity`): The Process Group to + create the service in + keystore_file (str): Path to the client certificate/keystore file + keystore_password (str): Password for the keystore + truststore_file (str): Path to the truststore file + truststore_password (str): Password for the truststore + key_password (Optional[str]): Password for the key, defaults to keystore_password + if not set + keystore_type (Optional[str]): Type of keystore (JKS, PKCS12), defaults to JKS + truststore_type (Optional[str]): Type of truststore (JKS, PKCS12), defaults to JKS + ssl_protocol (Optional[str]): SSL protocol version, defaults to TLS + ssl_service_type (Optional[str]): SSL service type, defaults to + StandardRestrictedSSLContextService + + Returns: + (ControllerServiceEntity): The SSL context service (existing or new) + """ + # Try to get existing SSL context first + try: + existing = nipyapi.canvas.get_controller(name, "name") + if existing: + log.debug("Found existing SSL context service: %s", name) + # Ensure it's scheduled/enabled + try: + nipyapi.canvas.schedule_controller(existing, scheduled=True, refresh=True) + except Exception as e: # pylint: disable=broad-exception-caught + log.debug("SSL context service scheduling: %s", e) + return existing + except Exception: # pylint: disable=broad-exception-caught + # Service doesn't exist, we'll create it below + pass + + # Try to create new SSL context service + try: + ssl_context = create_ssl_context_controller_service( + parent_pg=parent_pg, + name=name, + keystore_file=keystore_file, + keystore_password=keystore_password, + truststore_file=truststore_file, + truststore_password=truststore_password, + key_password=key_password, + keystore_type=keystore_type, + truststore_type=truststore_type, + ssl_protocol=ssl_protocol, + ssl_service_type=ssl_service_type, + ) + + # Enable the SSL context service + try: + nipyapi.canvas.schedule_controller(ssl_context, scheduled=True, refresh=True) + except Exception as e: # pylint: disable=broad-exception-caught + # Log validation errors for easier debugging + try: + api = nipyapi.nifi.ControllerServicesApi() + svc = api.get_controller_service(ssl_context.id) + verrs = getattr(svc.component, "validation_errors", None) + log.warning("SSL context service validation errors: %s", verrs) + except Exception: # pylint: disable=broad-exception-caught + pass + raise e + + log.debug("Created and enabled SSL context service: %s", name) + return ssl_context + + except Exception as e: + # Handle race condition where service was created between check and creation + error_msg = str(e).lower() + if "already exists" in error_msg or "duplicate" in error_msg: + try: + existing = nipyapi.canvas.get_controller(name, "name") + log.debug("Found existing SSL context service after race condition: %s", name) + # Ensure it's scheduled/enabled + try: + nipyapi.canvas.schedule_controller(existing, scheduled=True, refresh=True) + except Exception: # pylint: disable=broad-exception-caught + pass + return existing + except Exception: # pylint: disable=broad-exception-caught + # If we still can't find it, something else is wrong + pass + # Re-raise the original exception if we can't handle it + raise e diff --git a/nipyapi/system.py b/nipyapi/system.py index f327055c..31159477 100644 --- a/nipyapi/system.py +++ b/nipyapi/system.py @@ -5,10 +5,12 @@ import nipyapi - __all__ = [ - "get_system_diagnostics", "get_cluster", "get_node", - "get_nifi_version_info" + "get_system_diagnostics", + "get_cluster", + "get_node", + "get_nifi_version_info", + "get_registry_version_info", ] @@ -49,19 +51,65 @@ def get_node(nid): def get_nifi_version_info(): """ - Returns the version information of the connected NiFi instance + Returns version info for the connected NiFi instance. + + - In 2.x, the non-privileged About endpoint is used first. + - For backward compatibility with callers expecting a VersionInfoDTO, + we return a VersionInfoDTO with only ni_fi_version set when About + succeeds. + - If About is unavailable, fall back to system diagnostics DTO. Returns (VersionInfoDTO): """ - diags = get_system_diagnostics() - return diags.system_diagnostics.aggregate_snapshot.version_info + with nipyapi.utils.rest_exceptions(): + try: + about = nipyapi.nifi.FlowApi().get_about_info() + return nipyapi.nifi.VersionInfoDTO(ni_fi_version=about.about.version) + except Exception: # pylint: disable=broad-exception-caught + diags = get_system_diagnostics() + return diags.system_diagnostics.aggregate_snapshot.version_info def get_registry_version_info(): """ - Returns the version information of the connected NiFi Registry instance + Returns the version information of the connected NiFi Registry instance. - Returns (VersionInfoDTO): + Uses About endpoint which is sufficient for version probes. + Returns (str): The version string (e.g., "2.5.0") """ details = nipyapi.registry.AboutApi().get_version() - return details.registry_about_version + # The generated model for Registry 2.5.0 exposes `registry_about_version` + # but we normalize and attempt multiple shapes for forward/backward compat. + # Always return a plain version string. + try: + # Direct attribute on the model (current generator) + ver = getattr(details, "registry_about_version", None) + if ver: + return ver + # Sometimes models expose a top-level `version` + ver = getattr(details, "version", None) + if ver: + return ver + # Attempt dict conversion and look for common keys + if hasattr(details, "to_dict"): + d = details.to_dict() or {} + elif isinstance(details, dict): + d = details + else: + d = {} + for key in ( + "registry_about_version", + "registryAboutVersion", + "version", + "registry_version", + "registryVersion", + ): + if key in d and d[key]: + return d[key] + # If details is already a string, return it as-is + if isinstance(details, str): + return details + except Exception: # pylint: disable=broad-exception-caught + pass + # Could not determine; raise to allow caller to handle defaults + raise ValueError("Unable to determine NiFi Registry version from About API response") diff --git a/nipyapi/templates.py b/nipyapi/templates.py deleted file mode 100644 index 9af066ba..00000000 --- a/nipyapi/templates.py +++ /dev/null @@ -1,328 +0,0 @@ -""" -For Managing NiFi Templates in NiFi 1.x -""" - -import json -import io -from os import access, R_OK, W_OK -from os.path import isfile, dirname -import logging -import xmltodict -from lxml import etree -import nipyapi - -log = logging.getLogger(__name__) - -__all__ = [ - "list_all_templates", "get_template_by_name", "deploy_template", - "upload_template", "create_pg_snippet", "create_template", - "delete_template", "export_template", 'get_template', - "load_template_from_xml_file_path", "load_template_from_xml_file_stream", - "load_template_from_xml_string" -] - - -def get_template_by_name(name): - """ - DEPRECATED - Returns a specific template by name, if it exists. - - Note: This function is replaced by get_template - - Args: - name (str): The Name of the template, exact match required - - Returns: - (TemplateEntity) - - """ - out = [ - i for i in - list_all_templates(native=False) - if - name == i.template.name - ] - if len(out) == 1: - return out[0] - return None - - -def get_template(identifier, identifier_type='name', greedy=False): - """ - Filters the list of all Templates for a given string in a given field. - Note that filters are configured in config.py - - Args: - identifier (str): The string to filter on - identifier_type (str): The identifier of the field to filter on - greedy (bool): True for greedy match, False for exact match - - Returns: - None for no matches, Single Object for unique match, - list(Objects) for multiple matches - - """ - assert isinstance(identifier, str) - assert identifier_type in ['name', 'id'] - with nipyapi.utils.rest_exceptions(): - obj = nipyapi.templates.list_all_templates(native=False) - if obj: - return nipyapi.utils.filter_obj(obj, identifier, identifier_type, - greedy) - return None - - -def deploy_template(pg_id, template_id, loc_x=0.0, loc_y=0.0): - """ - Instantiates a given template request in a given process group - - Args: - pg_id (str): The UUID of the Process Group to deploy into - template_id (str): The UUID of the Template to deploy. Note that the - Template must already be uploaded and available to the target - Process Group - loc_x (float): The X coordinate to deploy the Template at. Default(0.0) - loc_y (float): The X coordinate to deploy the Template at. Default(0.0) - - Returns: - (FlowEntity): The FlowEntity of the Process Group with the deployed - template - - """ - nipyapi.utils.validate_templates_version_support() - with nipyapi.utils.rest_exceptions(): - return nipyapi.nifi.ProcessGroupsApi().instantiate_template( - id=pg_id, - body=nipyapi.nifi.InstantiateTemplateRequestEntity( - origin_x=loc_x, - origin_y=loc_y, - template_id=template_id - ) - ) - - -def create_pg_snippet(pg_id): - """ - Creates a snippet of the targeted process group, and returns the object - ready to be turned into a Template - - Args: - pg_id: UUID of the process Group to snippet - - Returns: - (SnippetEntity): The Snippet Object - """ - target_pg = nipyapi.canvas.get_process_group(pg_id, 'id') - new_snippet_req = nipyapi.nifi.SnippetEntity( - snippet={ - 'processGroups': { - target_pg.id: target_pg.revision - }, - 'parentGroupId': - target_pg.component.parent_group_id - } - ) - with nipyapi.utils.rest_exceptions(): - snippet_resp = nipyapi.nifi.SnippetsApi().create_snippet( - new_snippet_req - ) - return snippet_resp - - -def create_template(pg_id, name, desc=''): - """ - Creates a Template from a Process Group - - Args: - pg_id (str): The UUID of the target Process Group - name (str): The name for the new Template. Must be unique - desc (optional[str]): The description for the new Template - - Returns: - (TemplateEntity): The newly created Template - - """ - nipyapi.utils.validate_templates_version_support() - snippet = create_pg_snippet(pg_id) - with nipyapi.utils.rest_exceptions(): - new_template = nipyapi.nifi.CreateTemplateRequestEntity( - name=str(name), - description=str(desc), - snippet_id=snippet.snippet.id - ) - return nipyapi.nifi.ProcessGroupsApi().create_template( - id=snippet.snippet.parent_group_id, - body=new_template - ) - - -def delete_template(t_id): - """ - Deletes a Template - - Args: - t_id (str): UUID of the Template to be deleted - - Returns: - The updated Template object - """ - nipyapi.utils.validate_templates_version_support() - with nipyapi.utils.rest_exceptions(): - return nipyapi.nifi.TemplatesApi().remove_template(id=t_id) - - -def upload_template(pg_id, template_file): - """ - Uploads a given template xml from from the file system to the given - Process Group - - Args: - pg_id (str): The UUID of the Process Group to upload to - template_file (str): The path including filename to the template file - - Returns: - (TemplateEntity): The new Template object - - """ - nipyapi.utils.validate_templates_version_support() - with nipyapi.utils.rest_exceptions(): - this_pg = nipyapi.canvas.get_process_group(pg_id, 'id') - assert isinstance(this_pg, nipyapi.nifi.ProcessGroupEntity) - log.info("Called upload_template against endpoint %s with args %s", - nipyapi.config.nifi_config.api_client.host, locals()) - # Ensure we are receiving a valid file - assert isfile(template_file) and access(template_file, R_OK), \ - SystemError("File {0} invalid or unreadable".format(template_file)) - # Test for expected Template XML elements - tree = etree.parse(template_file) - root_tag = tree.getroot().tag - if root_tag != 'template': - raise TypeError( - "Expected 'template' as xml root element, got {0} instead." - "Are you sure this is a Template?" - .format(root_tag) - ) - t_name = tree.find('name').text - with nipyapi.utils.rest_exceptions(): - # For some reason identical code that produces the duplicate error - # in later versions is going through OK for NiFi-1.1.2 - # The error occurs as normal in Postman, so not sure what's going on - # Will force this error for consistency until it can be investigated - if nipyapi.templates.get_template(t_name): - raise ValueError('A template named {} already exists.' - .format(t_name)) - nipyapi.nifi.ProcessGroupsApi().upload_template( - id=this_pg.id, - template=template_file - ) - return nipyapi.templates.get_template( - tree.find('name').text - ) - - -def export_template(t_id, output='string', file_path=None): - """ - Exports a given Template as either a string or a file. - - Note that to reimport the Template it must be a file - - Args: - t_id (str): The UUID of the Template to export - output (str): 'string' or 'file' to set the export action - file_path (Optional [str]): The full path including filename to write - the Template export to - - Returns: - (str): A String representation of the exported Template XML. Note - that this may not be utf-8 encoded. - - """ - nipyapi.utils.validate_templates_version_support() - assert output in ['string', 'file'] - assert file_path is None or isinstance(file_path, str) - template = nipyapi.templates.get_template(t_id, 'id') - assert isinstance(template, nipyapi.nifi.TemplateEntity) - obj = nipyapi.nifi.TemplatesApi().export_template(t_id) - assert isinstance(obj, str) - assert obj[0] == '<' - if output == 'string': - return obj - if output == 'file': - assert access(dirname(file_path), W_OK), \ - "File_path {0} is inaccessible or not writable".format(file_path) - nipyapi.utils.fs_write(obj, file_path) - return obj - - -def list_all_templates(native=True): - """ - Gets a list of all templates on the canvas - - Returns: - (list[TemplateEntity]): A list of TemplateEntity's - """ - nipyapi.utils.validate_templates_version_support() - with nipyapi.utils.rest_exceptions(): - templates = nipyapi.nifi.FlowApi().get_templates() - if not native: - if templates: - return templates.templates - return None - return templates - - -def load_template_from_xml_file_path(file_path): - """ - Loads a TemplateEntity from an xml file for a - given path - - - Args: - file_path (str): path to the xml file - - Returns: - TemplateEntity - """ - assert isfile(file_path) and access(file_path, R_OK), \ - SystemError("File {0} invalid or unreadable".format(file_path)) - with io.open(file_path, "r", encoding='utf8') as template_file: - return load_template_from_xml_file_stream(template_file) - - -def load_template_from_xml_file_stream(file_stream): - """ - Loads a TemplateEntity from a template xml file - - Args: - file_stream (io stream): the xml file stream as returned by open - - Returns: - TemplateEntity - """ - return load_template_from_xml_string(file_stream.read()) - - -def load_template_from_xml_string(xml_string): - """ - Loads a TemplateEntity from xml string, as if - you had read in the xml file to string - - Args: - xml_string (str): string of xml - - Returns: - TemplateEntity - """ - assert isinstance(xml_string, str) - - json_string = json.dumps(xmltodict.parse(xml_string)) - unset = False - if nipyapi.config.nifi_config.api_client is None: - unset = True - nipyapi.config.nifi_config.api_client = nipyapi.nifi.ApiClient() - - template_entity = nipyapi.utils.load(json_string, - ('nifi', 'TemplateEntity')) - if unset: - nipyapi.config.nifi_config.api_client = None - return template_entity diff --git a/nipyapi/utils.py b/nipyapi/utils.py index 64268757..193d0518 100644 --- a/nipyapi/utils.py +++ b/nipyapi/utils.py @@ -2,41 +2,52 @@ Convenience utility functions for NiPyApi, not really intended for external use """ -import logging -import json +import base64 import io +import json +import logging +import operator +import os import time +from contextlib import contextmanager from copy import copy from functools import reduce, wraps -import operator -from contextlib import contextmanager -from packaging import version -from ruamel.yaml import YAML -from ruamel.yaml.compat import StringIO +from typing import Optional + import requests +import yaml +from packaging import version from requests.models import Response + import nipyapi from nipyapi.config import default_string_encoding as DEF_ENCODING -__all__ = ['dump', 'load', 'fs_read', 'fs_write', 'filter_obj', - 'wait_to_complete', 'is_endpoint_up', 'set_endpoint', - 'start_docker_containers', 'DockerContainer', - 'infer_object_label_from_class', 'bypass_slash_encoding', - 'exception_handler', 'enforce_min_ver', 'check_version', - 'validate_parameters_versioning_support' - ] +__all__ = [ + "dump", + "load", + "fs_read", + "fs_write", + "filter_obj", + "wait_to_complete", + "is_endpoint_up", + "set_endpoint", + "infer_object_label_from_class", + "bypass_slash_encoding", + "exception_handler", + "enforce_min_ver", + "check_version", + "validate_parameters_versioning_support", + "extract_oidc_user_identity", + "getenv", + "getenv_bool", + "resolve_relative_paths", +] log = logging.getLogger(__name__) +DOCKER_AVAILABLE = False # Docker management removed in 1.x (NiFi 2.x) -try: - import docker - from docker.errors import ImageNotFound - DOCKER_AVAILABLE = True -except ImportError: - DOCKER_AVAILABLE = False - -def dump(obj, mode='json'): +def dump(obj, mode="json"): """ Dumps a native datatype object or swagger entity to json or yaml defaults to json @@ -48,27 +59,18 @@ def dump(obj, mode='json'): Returns (str): The serialised object """ - assert mode in ['json', 'yaml'] + assert mode in ["json", "yaml"] api_client = nipyapi.nifi.ApiClient() prepared_obj = api_client.sanitize_for_serialization(obj) - if mode == 'json': + if mode == "json": try: - return json.dumps( - obj=prepared_obj, - sort_keys=True, - indent=4 - ) + return json.dumps(obj=prepared_obj, sort_keys=True, indent=4) except TypeError as e: raise e - if mode == 'yaml': - # Use 'safe' loading to prevent arbitrary code execution - yaml = YAML(typ='safe', pure=True) - # Create a StringIO object to act as the stream - stream = StringIO() - # Dump to the StringIO stream - yaml.dump(prepared_obj, stream) - # Return the contents of the stream as a string - return stream.getvalue() + if mode == "yaml": + # Use 'safe' dumping to prevent arbitrary code execution + # Force block style to avoid inline flow mappings that can break parsing + return yaml.safe_dump(prepared_obj, default_flow_style=False, sort_keys=True, indent=4) raise ValueError("Invalid dump Mode specified {0}".format(mode)) @@ -94,22 +96,20 @@ def load(obj, dto=None): """ assert isinstance(obj, (str, bytes)) assert dto is None or isinstance(dto, tuple) - yaml = YAML(typ='safe', pure=True) - loaded_obj = yaml.load(obj) + # Use safe_load to prevent arbitrary code execution + loaded_obj = yaml.safe_load(obj) if dto: - assert dto[0] in ['nifi', 'registry'] + assert dto[0] in ["nifi", "registry"] assert isinstance(dto[1], str) obj_as_json = dump(loaded_obj) response = Response() response.data = obj_as_json - if 'nifi' in dto[0]: + if "nifi" in dto[0]: return nipyapi.config.nifi_config.api_client.deserialize( - response=response, - response_type=dto[1] + response=response, response_type=dto[1] ) return nipyapi.config.registry_config.api_client.deserialize( - response=response, - response_type=dto[1] + response=response, response_type=dto[1] ) return loaded_obj @@ -125,7 +125,7 @@ def fs_write(obj, file_path): Returns: The object that was written """ try: - with io.open(str(file_path), 'w', encoding=DEF_ENCODING) as f: + with io.open(str(file_path), "w", encoding=DEF_ENCODING) as f: if isinstance(obj, bytes): obj_str = obj.decode(DEF_ENCODING) else: @@ -146,7 +146,7 @@ def fs_read(file_path): Returns: The object that was read """ try: - with io.open(str(file_path), 'r', encoding=DEF_ENCODING) as f: + with io.open(str(file_path), "r", encoding=DEF_ENCODING) as f: return f.read() except IOError as e: raise e @@ -178,39 +178,31 @@ def filter_obj(obj, value, key, greedy=True): obj_class_name = obj[0].__class__.__name__ except (TypeError, IndexError) as e: raise TypeError( - "The passed object {0} is not a filterable nipyapi object" - .format(obj.__class__.__name__)) from e + "The passed object {0} is not a filterable nipyapi object".format( + obj.__class__.__name__ + ) + ) from e # Check if this class has a registered filter in Nipyapi.config this_filter = nipyapi.config.registered_filters.get(obj_class_name, False) if not this_filter: - registered_filters = ' '.join(nipyapi.config.registered_filters.keys()) + registered_filters = " ".join(nipyapi.config.registered_filters.keys()) raise ValueError( "{0} is not a registered NiPyApi filterable class, registered " "classes are {1}".format(obj_class_name, registered_filters) ) # Check if the supplied key is part of the registered filter - key_lookup = nipyapi.config.registered_filters[obj_class_name].get( - key, False - ) + key_lookup = nipyapi.config.registered_filters[obj_class_name].get(key, False) if not key_lookup: - valid_keys = ' '.join( - nipyapi.config.registered_filters[obj_class_name].keys() - ) + valid_keys = " ".join(nipyapi.config.registered_filters[obj_class_name].keys()) raise ValueError( "{0} is not a registered filter method for object {1}, valid " "methods are {2}".format(key, obj_class_name, valid_keys) ) # List comprehension using reduce to unpack the list of keys in the filter if greedy: - out = [ - i for i in obj if value in - reduce(operator.getitem, key_lookup, i.to_dict()) - ] + out = [i for i in obj if value in reduce(operator.getitem, key_lookup, i.to_dict())] else: - out = [ - i for i in obj if - value == reduce(operator.getitem, key_lookup, i.to_dict()) - ] + out = [i for i in obj if value == reduce(operator.getitem, key_lookup, i.to_dict())] # Manage our return contract if not out: return None @@ -237,10 +229,9 @@ def wait_to_complete(test_function, *args, **kwargs): Returns (bool): True for success, False for not """ - log.info("Called wait_to_complete for function %s", - test_function.__name__) - delay = kwargs.pop('nipyapi_delay', nipyapi.config.short_retry_delay) - max_wait = kwargs.pop('nipyapi_max_wait', nipyapi.config.short_max_wait) + log.info("Called wait_to_complete for function %s", test_function.__name__) + delay = kwargs.pop("nipyapi_delay", nipyapi.config.short_retry_delay) + max_wait = kwargs.pop("nipyapi_max_wait", nipyapi.config.short_max_wait) timeout = time.time() + max_wait while time.time() < timeout: log.debug("Calling test_function") @@ -252,39 +243,66 @@ def wait_to_complete(test_function, *args, **kwargs): log.info("Function output evaluated to False, sleeping...") time.sleep(delay) log.info("Hit Timeout, raising TimeOut Error") - raise ValueError("Timed Out waiting for {0} to complete".format( - test_function.__name__)) + raise ValueError("Timed Out waiting for {0} to complete".format(test_function.__name__)) -def is_endpoint_up(endpoint_url): +def is_endpoint_up(endpoint_url): # pylint: disable=too-many-return-statements """ Tests if a URL is available for requests + A service is considered "up" if it responds with: + - Success codes (200-399) + - Authentication required codes (401, 403) - service is ready for auth + - SSL certificate verification errors - service up but cert issues + + SSL handshake failures (UNEXPECTED_EOF, etc.) indicate service not ready. + Args: endpoint_url (str): The URL to test - Returns (bool): True for a 200 response, False for not + Returns (bool): True if service is ready for requests, False if not """ log.info("Called is_endpoint_up with args %s", locals()) try: - response = requests.get( - endpoint_url, - timeout=nipyapi.config.short_max_wait - ) + response = requests.get(endpoint_url, timeout=nipyapi.config.short_max_wait) if response.status_code: - if response.status_code == 200: - log.info("Got 200 response from endpoint, returning True") + # Service ready: success codes or auth required + if (200 <= response.status_code < 400) or response.status_code in (401, 403): + log.info("Got status %s from endpoint, service ready", response.status_code) return True - log.info("Got status code %s from endpoint, returning False", - response.status_code) + log.info("Got status code %s from endpoint, service not ready", response.status_code) return False - except (requests.ConnectionError, requests.exceptions.SSLError) as e: + except ( + requests.ConnectionError, + requests.exceptions.SSLError, + requests.exceptions.ReadTimeout, + ) as e: log.info("Got Error of type %s with details %s", type(e), str(e)) - if 'SSLError' in str(type(e)): - log.info("Got OpenSSL error, port is probably up but needs Cert") - return True - log.info("Got ConnectionError, returning False") + if "SSLError" in str(type(e)): + error_str = str(e) + # Only treat specific SSL errors as "service ready" + if any( + indicator in error_str + for indicator in [ + "CERTIFICATE_VERIFY_FAILED", + "WRONG_VERSION_NUMBER", + "certificate verify failed", + ] + ): + log.info("Got SSL cert error, service up but certificate issues") + return True + log.info("Got SSL handshake error, service not ready yet") + return False + if "ReadTimeout" in str(type(e)): + # Check if this is an SSL handshake timeout + error_str = str(e) + if "handshake" in error_str.lower() or "ssl" in error_str.lower(): + log.info("Got SSL handshake timeout, service not ready yet") + return False + log.info("Got read timeout, service not ready") + return False + log.info("Got ConnectionError, service not ready") return False @@ -301,184 +319,95 @@ def set_endpoint(endpoint_url, ssl=False, login=False, username=None, password=N Returns (bool): True for success """ log.info("Called set_endpoint with args %s", locals()) - if 'nifi-api' in endpoint_url: + if "nifi-api" in endpoint_url: configuration = nipyapi.config.nifi_config - service = 'nifi' - elif 'registry-api' in endpoint_url: + service = "nifi" + elif "registry-api" in endpoint_url: configuration = nipyapi.config.registry_config - service = 'registry' + service = "registry" else: raise ValueError("Endpoint not recognised") log.info("Setting %s endpoint to %s", service, endpoint_url) if configuration.api_client: - # Running controlled logout procedure nipyapi.security.service_logout(service) - # Resetting API client so it recreates from config.host configuration.api_client = None # remove any trailing slash to avoid hard to spot errors - configuration.host = endpoint_url.rstrip('/') + configuration.host = endpoint_url.rstrip("/") + + # Respect preconfigured CA only; environment integration should be handled by callers + shared_ca = getattr(configuration, "ssl_ca_cert", None) + if shared_ca and login: + # For username/password (one-way TLS) flows, prefer CA bundle over any pre-set SSLContext + configuration.ssl_context = None + # Recreate API client to pick up new CA + configuration.api_client = None # Set up SSL context if using HTTPS - if ssl and 'https://' in endpoint_url: + if ssl and "https://" in endpoint_url: if login: - # Username/password auth with basic SSL - nipyapi.security.set_service_ssl_context( - service=service, - ca_file=nipyapi.config.default_ssl_context['ca_file'] - ) - nipyapi.security.service_login( - service, username=username, password=password - ) + # For one-way TLS with username/password, rely on ssl_ca_cert and verify_ssl + # Avoid setting a custom SSLContext here + nipyapi.security.service_login(service, username=username, password=password) else: - # mTLS auth with client certificates + # mTLS auth with client certificates; require preconfigured values + client_cert = getattr(configuration, "cert_file", None) + client_key = getattr(configuration, "key_file", None) + client_key_password = getattr(configuration, "key_password", None) + if not (client_cert and client_key): + raise ValueError( + f"mTLS requires cert_file and key_file to be set on {service} configuration" + ) nipyapi.security.set_service_ssl_context( service=service, - ca_file=nipyapi.config.default_ssl_context['ca_file'], - client_cert_file=nipyapi.config.default_ssl_context['client_cert_file'], - client_key_file=nipyapi.config.default_ssl_context['client_key_file'], - client_key_password=nipyapi.config.default_ssl_context['client_key_password'] + ca_file=shared_ca, + client_cert_file=client_cert, + client_key_file=client_key, + client_key_password=client_key_password, ) + # One-time supported-version enforcement: check once using existing helper. + try: + enforce_min_ver("2", service=service) + except Exception as e: # pylint: disable=broad-except + # Do not block connection for unreachable About in secured setups; log instead + log.debug("Version check skipped or failed for %s: %s", service, e) return True -# pylint: disable=R0913,R0902,R0917 -class DockerContainer(): - """ - Helper class for Docker container automation without using Ansible - """ - def __init__(self, name=None, image_name=None, image_tag=None, ports=None, - env=None, volumes=None, test_url=None, endpoint=None): - if not DOCKER_AVAILABLE: - raise ImportError( - "The 'docker' package is required for this class. " - "Please install nipyapi with the 'demo' extra: " - "pip install nipyapi[demo]" - ) - self.name = name - self.image_name = image_name - self.image_tag = image_tag - self.ports = ports - self.env = env - self.volumes = volumes - self.test_url = test_url - self.endpoint = endpoint - self.container = None - - def get_test_url_status(self): - """ - Checks if a URL is available - :return: status code if available, String 'ConnectionError' if not - """ - try: - return requests.get(self.test_url, timeout=10).status_code - except requests.ConnectionError: - return 'ConnectionError' - except requests.Timeout: - return 'Timeout' +# pylint: disable=R0913,R0902,R0917,R0903 +class DockerContainer: # pragma: no cover + """Removed in 1.x (NiFi 2.x). Use Docker Compose or external tooling. - def set_container(self, container): - """Set the container object""" - self.container = container + This class is kept as a stub to raise a clear error for callers + who still import it. It will be removed in a future release. + """ - def get_container(self): - """Fetch the container object""" - return self.container + def __init__(self, *args, **kwargs): + raise RuntimeError( + "DockerContainer has been removed. Use Docker Compose or external tooling." + ) # pylint: disable=W0703,R1718 -def start_docker_containers(docker_containers, network_name='demo'): +def start_docker_containers(*args, **kwargs): # pragma: no cover """ - Deploys a list of DockerContainer's on a given network - - Args: - docker_containers (list[DockerContainer]): list of Dockers to start - network_name (str): The name of the Docker Bridge Network to get or - create for the Docker Containers - - Returns: Nothing + Removed in 1.x (NiFi 2.x). Use Docker Compose or external tooling. + This function is kept as a stub to raise a clear error for callers + who still import it. It will be removed in a future release. """ - if not DOCKER_AVAILABLE: - raise ImportError( - "The 'docker' package is required for this function. " - "Please install nipyapi with the 'demo' extra: " - "pip install nipyapi[demo]" - ) - - log.info("Creating Docker client using Environment Variables") - d_client = docker.from_env() - - # Test if Docker Service is available - try: - d_client.version() - except Exception as e: - raise EnvironmentError("Docker Service not found") from e - - for target in docker_containers: - assert isinstance(target, DockerContainer) - - # Pull relevant Images - log.info("Pulling relevant Docker Images if needed") - for image in set([(c.image_name + ':' + c.image_tag) - for c in docker_containers]): - log.info("Checking image %s", image) - try: - d_client.images.get(image) - log.info("Using local image for %s", image) - except ImageNotFound: - log.info("Pulling %s", image) - d_client.images.pull(image) - - # Clear previous containers - log.info("Clearing previous containers for this demo") - d_clear_list = [li for li in d_client.containers.list(all=True) - if li.name in [i.name for i in docker_containers]] - for c in d_clear_list: - log.info("Removing old container %s", c.name) - c.remove(force=True) - - # Deploy/Get Network - log.info("Getting Docker bridge network") - d_n_list = [li for li in d_client.networks.list() - if network_name in li.name] - if not d_n_list: - d_network = d_client.networks.create( - name=network_name, - driver='bridge', - check_duplicate=True - ) - elif len(d_n_list) > 1: - raise EnvironmentError("Too many test networks found") - else: - d_network = d_n_list[0] - log.info("Using Docker network: %s", d_network.name) - - # Deploy Containers - log.info("Starting relevant Docker Containers") - for c in docker_containers: - log.info("Starting Container %s", c.name) - c.set_container(d_client.containers.run( - image=c.image_name + ':' + c.image_tag, - detach=True, - network=network_name, - hostname=c.name, - name=c.name, - ports=c.ports, - environment=c.env, - volumes=c.volumes, - auto_remove=True - )) + raise RuntimeError( + "start_docker_containers has been removed. Use Docker Compose or external tooling." + ) class VersionError(Exception): """Error raised when a feature is not supported in the current version""" -def check_version(base, comparator=None, service='nifi', - default_version='0.2.0'): +def check_version(base, comparator=None, service="nifi", default_version="2.0.0"): """ Compares version base against either version comparator, or the version of the currently connected service instance. @@ -503,43 +432,25 @@ def check_version(base, comparator=None, service='nifi', def strip_version_string(version_string): # Reduces the string to only the major.minor.patch version - return '.'.join(version_string.split('-')[0].split('.')[:3]) + return ".".join(version_string.split("-")[0].split(".")[:3]) assert isinstance(base, str) assert comparator is None or isinstance(comparator, str) - assert service in ['nifi', 'registry'] + assert service in ["nifi", "registry"] ver_a = version.parse(strip_version_string(base)) if comparator: ver_b = version.parse(strip_version_string(comparator)) - elif service == 'registry': + elif service == "registry": try: reg_ver = nipyapi.system.get_registry_version_info() ver_b = version.parse(strip_version_string(reg_ver)) - except nipyapi.registry.rest.ApiException: - log.warning( - "Unable to get registry version, trying swagger.json") - try: - config = nipyapi.config.registry_config - if config.api_client is None: - config.api_client = nipyapi.registry.ApiClient() - reg_swagger_def = config.api_client.call_api( - resource_path='/swagger/swagger.json', - method='GET', _preload_content=False, - auth_settings=['tokenAuth', 'Authorization'] - ) - reg_json = load(reg_swagger_def[0].data) - ver_b = version.parse(reg_json['info']['version']) - except nipyapi.registry.rest.ApiException: - log.warning( - "Can't get registry swagger.json, assuming version %s", - default_version) - ver_b = version.parse(default_version) + except Exception: # pylint: disable=broad-exception-caught + log.warning("Unable to get registry About version, assuming %s", default_version) + ver_b = version.parse(default_version) else: - ver_b = version.parse( - strip_version_string( - nipyapi.system.get_nifi_version_info().ni_fi_version - ) - ) + nifi_ver = nipyapi.system.get_nifi_version_info() + nifi_ver_str = getattr(nifi_ver, "ni_fi_version", nifi_ver) + ver_b = version.parse(strip_version_string(nifi_ver_str)) if ver_b > ver_a: return -1 if ver_b < ver_a: @@ -547,58 +458,95 @@ def strip_version_string(version_string): return 0 -def validate_parameters_versioning_support(verify_nifi=True, - verify_registry=True): +def validate_parameters_versioning_support( + verify_nifi=True, verify_registry=True # pylint: disable=unused-argument +): # pylint: disable=unused-argument """ Convenience method to check if Parameters are supported Args: verify_nifi (bool): If True, check NiFi meets the min version verify_registry (bool): If True, check Registry meets the min version """ - if verify_nifi: - nifi_check = enforce_min_ver('1.10', bool_response=True) - else: - nifi_check = False + # NiFi 2.x/Registry 2.x support Parameter Contexts in versioned flows. + # Legacy warnings for <1.10 (NiFi) or <0.6 (Registry) removed as we no + # longer support those platform versions. + return None - if verify_registry: - registry_check = enforce_min_ver('0.6', service='registry', - bool_response=True) - else: - registry_check = False - if nifi_check or registry_check: - log.warning("Connected NiFi Registry may not support " - "Parameter Contexts and they may be lost in " - "Version Control") +def extract_oidc_user_identity(token_data): + """ + Extract user identity (UUID) from OIDC token response. + + This function decodes the JWT access token to extract the 'sub' (subject) field, + which contains the user's unique identifier that NiFi uses for policy assignment. + + Args: + token_data (dict): The full OAuth2 token response from service_login_oidc() + when called with return_token_info=True + + Returns: + str: The user identity UUID from the token's 'sub' field + + Raises: + ValueError: If the token cannot be decoded or doesn't contain expected fields + """ + try: + access_token = token_data.get("access_token") + if not access_token: + raise ValueError("No access_token found in token data") + + # JWT tokens have 3 parts separated by dots: header.payload.signature + parts = access_token.split(".") + if len(parts) < 2: + raise ValueError("Invalid JWT token format") + + # Decode the payload (second part) + payload = parts[1] + # Add padding for base64 decoding if needed + payload += "=" * (4 - len(payload) % 4) + decoded_payload = base64.b64decode(payload) + payload_json = json.loads(decoded_payload) + + # Extract the 'sub' (subject) field which contains the user UUID + user_uuid = payload_json.get("sub") + if not user_uuid: + raise ValueError("No 'sub' field found in JWT token payload") + + return user_uuid + + except Exception as e: + raise ValueError(f"Failed to extract user identity from OIDC token: {e}") from e def validate_templates_version_support(): """ Validate that the current version of NiFi supports Templates API """ - enforce_max_ver('2', service='nifi', error_message="Templates are deprecated in NiFi 2.x") + enforce_max_ver("2", service="nifi", error_message="Templates are deprecated in NiFi 2.x") -def enforce_max_ver(max_version, bool_response=False, service='nifi', error_message=None): +def enforce_max_ver(max_version, bool_response=False, service="nifi", error_message=None): """ Raises an error if target NiFi environment is at or above the max version """ if check_version(max_version, service=service) == -1: if not bool_response: - raise VersionError(error_message or "This function is not available " - "in NiFi {} or above".format(max_version)) + raise VersionError( + error_message + or "This function is not available " "in NiFi {} or above".format(max_version) + ) return True return False -def enforce_min_ver(min_version, bool_response=False, service='nifi'): +def enforce_min_ver(min_version, bool_response=False, service="nifi"): """ - Raises an error if target NiFi environment is not minimum version + Raises an error if target NiFi environment is not minimum version. + Args: min_version (str): Version to check against - bool_response (bool): If True, will return True instead of - raising error - service: nifi or registry + bool_response (bool): If True, will return True instead of raising error + service (str): nifi or registry Returns: (bool) or (NotImplementedError) @@ -606,8 +554,8 @@ def enforce_min_ver(min_version, bool_response=False, service='nifi'): if check_version(min_version, service=service) == 1: if not bool_response: raise VersionError( - "This function is not available " - "before NiFi version " + str(min_version)) + "This function is not available " "before NiFi version " + str(min_version) + ) return True return False @@ -625,21 +573,20 @@ def infer_object_label_from_class(obj): """ if isinstance(obj, nipyapi.nifi.ProcessorEntity): - return 'PROCESSOR' + return "PROCESSOR" if isinstance(obj, nipyapi.nifi.FunnelEntity): - return 'FUNNEL' + return "FUNNEL" if isinstance(obj, nipyapi.nifi.PortEntity): return obj.port_type if isinstance(obj, nipyapi.nifi.RemoteProcessGroupDTO): - return 'REMOTEPROCESSGROUP' + return "REMOTEPROCESSGROUP" if isinstance(obj, nipyapi.nifi.RemoteProcessGroupPortDTO): # get RPG summary, find id of obj in input or output list - parent_rpg = nipyapi.canvas.get_remote_process_group( - obj.group_id, True) - if obj.id in [x.id for x in parent_rpg['input_ports']]: - return 'REMOTE_INPUT_PORT' - if obj.id in [x.id for x in parent_rpg['output_ports']]: - return 'REMOTE_OUTPUT_PORT' + parent_rpg = nipyapi.canvas.get_remote_process_group(obj.group_id, True) + if obj.id in [x.id for x in parent_rpg["input_ports"]]: + return "REMOTE_INPUT_PORT" + if obj.id in [x.id for x in parent_rpg["output_ports"]]: + return "REMOTE_OUTPUT_PORT" raise ValueError("Remote Port not present as expected in RPG") raise AssertionError("Object Class not recognised for this function") @@ -656,15 +603,14 @@ def bypass_slash_encoding(service, bypass): None """ - assert service in ['nifi', 'registry'] + assert service in ["nifi", "registry"] assert isinstance(bypass, bool) current_config = getattr(nipyapi, service).configuration if bypass: - if '/' not in current_config.safe_chars_for_path_param: - current_config.safe_chars_for_path_param += '/' + if "/" not in current_config.safe_chars_for_path_param: + current_config.safe_chars_for_path_param += "/" else: - current_config.safe_chars_for_path_param = \ - copy(nipyapi.config.default_safe_chars) + current_config.safe_chars_for_path_param = copy(nipyapi.config.default_safe_chars) @contextmanager @@ -672,22 +618,114 @@ def rest_exceptions(): """Simple exception wrapper for Rest Exceptions""" try: yield - except (nipyapi.nifi.rest.ApiException, - nipyapi.registry.rest.ApiException) as e: + except (nipyapi.nifi.rest.ApiException, nipyapi.registry.rest.ApiException) as e: raise ValueError(e.body) from e def exception_handler(status_code=None, response=None): """Simple Function wrapper to handle HTTP Status Exceptions""" + def func_wrapper(f): @wraps(f) def wrapper(*args, **kwargs): try: return f(*args, **kwargs) - except (nipyapi.nifi.rest.ApiException, - nipyapi.registry.rest.ApiException) as e: + except (nipyapi.nifi.rest.ApiException, nipyapi.registry.rest.ApiException) as e: if status_code is not None and e.status == int(status_code): return response raise ValueError(e.body) from e + return wrapper + return func_wrapper + + +def resolve_relative_paths(file_path, root_path=None): + """ + Convert a relative path to absolute, leave absolute paths unchanged. + + Essential for SSL/TLS certificate configuration where libraries typically + require absolute paths to avoid ambiguity about file locations. + + Args: + file_path (str or None): File path to resolve + root_path (str, optional): Root directory for relative path resolution. + Defaults to PROJECT_ROOT_DIR if not specified. + + Returns: + str or None: Absolute path if input was a relative path string, + unchanged if input was absolute path or None. + + Example: + >>> resolve_relative_paths('certs/ca.pem', '/project') + '/project/certs/ca.pem' + >>> resolve_relative_paths('/etc/ssl/ca.pem') + '/etc/ssl/ca.pem' + >>> resolve_relative_paths(None) + None + """ + + if file_path is None or not isinstance(file_path, str) or not file_path.strip(): + return file_path + + if os.path.isabs(file_path): + return file_path + + # Use provided root or default to package root directory + effective_root = root_path or os.path.dirname(nipyapi.config.PROJECT_ROOT_DIR) + return os.path.join(effective_root, file_path) + + +def getenv(name: str, default: Optional[str] = None) -> Optional[str]: + """ + Enhanced environment variable getter with None handling. + + Args: + name (str): Environment variable name + default (Optional[str]): Default value if variable not set + + Returns: + Optional[str]: Environment variable value or default + """ + val = os.getenv(name) + return val if val is not None else default + + +def getenv_bool(name: str, default: Optional[bool] = None) -> Optional[bool]: + """ + Parse environment variable as boolean using JSON-style interpretation. + + Handles common boolean environment variable patterns and uses json.loads() + for the standard 'true'/'false' cases that most programmers understand. + + Args: + name (str): Environment variable name + default (Optional[bool]): Default value if variable not set + + Returns: + Optional[bool]: Boolean value or default if not set + + Example: + >>> os.environ['MY_FLAG'] = '0' + >>> getenv_bool('MY_FLAG') # False + >>> os.environ['MY_FLAG'] = 'true' + >>> getenv_bool('MY_FLAG') # True + >>> getenv_bool('UNSET_FLAG', False) # False + """ + val = os.getenv(name) + if val is None: + return default + + # Clean and normalize the value + val_clean = val.strip().lower() + + # Handle JSON-style booleans directly + if val_clean in ("true", "false"): + return json.loads(val_clean) + + # Handle common falsy patterns + if val_clean in ("0", "no", "off", "n", ""): + return False + + # Everything else is truthy (including '1', 'yes', 'on', 'y', etc.) + return True diff --git a/nipyapi/versioning.py b/nipyapi/versioning.py index eb93b706..0e7bc0ea 100644 --- a/nipyapi/versioning.py +++ b/nipyapi/versioning.py @@ -3,20 +3,37 @@ """ import logging + import nipyapi + # Due to line lengths, creating shortened names for these objects from nipyapi.nifi import VersionControlInformationDTO as VciDTO from nipyapi.registry import VersionedFlowSnapshotMetadata as VfsMd __all__ = [ - 'create_registry_client', 'list_registry_clients', - 'delete_registry_client', 'get_registry_client', 'list_registry_buckets', - 'create_registry_bucket', 'delete_registry_bucket', 'get_registry_bucket', - 'save_flow_ver', 'list_flows_in_bucket', 'get_flow_in_bucket', - 'get_latest_flow_ver', 'update_flow_ver', 'get_version_info', - 'create_flow', 'create_flow_version', 'get_flow_version', - 'export_flow_version', 'import_flow_version', 'list_flow_versions', - 'deploy_flow_version' + "create_registry_client", + "list_registry_clients", + "delete_registry_client", + "get_registry_client", + "ensure_registry_client", + "list_registry_buckets", + "create_registry_bucket", + "delete_registry_bucket", + "get_registry_bucket", + "ensure_registry_bucket", + "save_flow_ver", + "list_flows_in_bucket", + "get_flow_in_bucket", + "get_latest_flow_ver", + "update_flow_ver", + "get_version_info", + "create_flow", + "create_flow_version", + "get_flow_version", + "export_flow_version", + "import_flow_version", + "list_flow_versions", + "deploy_flow_version", ] log = logging.getLogger(__name__) @@ -30,60 +47,42 @@ def create_registry_client(name, uri, description, reg_type=None, ssl_context_se name (str): The name of the new Client uri (str): The URI for the connection description (str): A description for the Client - reg_type (str): The type of registry client to create + reg_type (str): The type of registry client to create. + Defaults to 'org.apache.nifi.registry.flow.NifiRegistryFlowRegistryClient' ssl_context_service (ControllerServiceEntity): Optional SSL Context Service Returns: - (FlowRegistryClientEntity): The new registry client object + :class:`~nipyapi.nifi.models.FlowRegistryClientEntity`: The new registry client object """ assert isinstance(uri, str) and uri is not False assert isinstance(name, str) and name is not False assert isinstance(description, str) - if nipyapi.utils.check_version('2', service='nifi') == 1: - component = { - 'uri': uri, - 'name': name, - 'description': description - } - else: - component = { - 'name': name, - 'description': description, - 'type': reg_type or 'org.apache.nifi.registry.flow.NifiRegistryFlowRegistryClient', - 'properties': { - 'url': uri - } - } + # NiFi 2.x registry client format + component = { + "name": name, + "description": description, + "type": reg_type or "org.apache.nifi.registry.flow.NifiRegistryFlowRegistryClient", + "properties": {"url": uri}, + } with nipyapi.utils.rest_exceptions(): controller = nipyapi.nifi.ControllerApi().create_flow_registry_client( - body={ - 'component': component, - 'revision': { - 'version': 0 - } - } + body={"component": component, "revision": {"version": 0}} ) # Update with SSL context if provided - # Will be ignored in 1.x if set in original creation request if ssl_context_service: update_component = dict(controller.component.to_dict()) - update_component['properties'] = { - 'url': uri, - 'ssl-context-service': ssl_context_service.id - } + update_component["properties"] = {"url": uri, "ssl-context-service": ssl_context_service.id} with nipyapi.utils.rest_exceptions(): controller = nipyapi.nifi.ControllerApi().update_flow_registry_client( id=controller.id, body={ - 'component': update_component, - 'revision': { - 'version': controller.revision.version - } - } + "component": update_component, + "revision": {"version": controller.revision.version}, + }, ) return controller @@ -103,14 +102,11 @@ def delete_registry_client(client, refresh=True): assert isinstance(client, nipyapi.nifi.FlowRegistryClientEntity) with nipyapi.utils.rest_exceptions(): if refresh: - target = nipyapi.nifi.ControllerApi().get_flow_registry_client( - client.id - ) + target = nipyapi.nifi.ControllerApi().get_flow_registry_client(client.id) else: target = client return nipyapi.nifi.ControllerApi().delete_flow_registry_client( - id=target.id, - version=target.revision.version + id=target.id, version=target.revision.version ) @@ -119,13 +115,13 @@ def list_registry_clients(): Lists the available Registry Clients in the NiFi Controller Services Returns: - (list[FlowRegistryClientEntity]) objects + list[:class:`~nipyapi.nifi.models.FlowRegistryClientEntity`]: objects """ with nipyapi.utils.rest_exceptions(): return nipyapi.nifi.ControllerApi().get_flow_registry_clients() -def get_registry_client(identifier, identifier_type='name'): +def get_registry_client(identifier, identifier_type="name"): """ Filters the Registry clients to a particular identifier @@ -142,39 +138,166 @@ def get_registry_client(identifier, identifier_type='name'): return nipyapi.utils.filter_obj(obj, identifier, identifier_type) +def ensure_registry_client(name, uri, description, reg_type=None, ssl_context_service=None): + """ + Ensures a Registry Client exists, creating it if necessary. + + This is a convenience function that implements the common pattern of: + 1. Try to get existing client by name + 2. If not found, create it + 3. Handle race conditions gracefully + + Args: + name (str): The name of the Client + uri (str): The URI for the connection + description (str): A description for the Client + reg_type (str): The type of registry client to create. + Defaults to 'org.apache.nifi.registry.flow.NifiRegistryFlowRegistryClient' + ssl_context_service (ControllerServiceEntity): Optional SSL Context Service + + Returns: + (FlowRegistryClientEntity): The registry client object (existing or new) + """ + # Try to get existing client first + try: + existing = get_registry_client(name) + if existing: + # Handle both single object and list of objects + if isinstance(existing, list): + # Multiple matches - use the first one + log.warning( + "Multiple registry clients found with name '%s', using first match", name + ) + existing = existing[0] + + # Check if existing client's URI matches the desired URI + existing_uri = existing.component.properties.get("url", "") + if existing_uri == uri: + log.debug("Found existing registry client with matching URI: %s", name) + return existing + + # URI mismatch - delete existing and create new one + log.debug( + "Registry client %s URI mismatch (existing: %s, desired: %s) - recreating", + name, + existing_uri, + uri, + ) + delete_registry_client(existing) + except ValueError: + # Client doesn't exist, we'll create it below + pass + + # Try to create new client + try: + client = create_registry_client(name, uri, description, reg_type, ssl_context_service) + log.debug("Created new registry client: %s", name) + return client + except Exception as e: + # Handle race condition where client was created between check and creation + error_msg = str(e).lower() + if "already exists" in error_msg or "duplicate" in error_msg: + try: + existing = get_registry_client(name) + if existing: + # Handle both single object and list of objects + if isinstance(existing, list): + log.warning( + "Multiple registry clients found with name '%s' " + "after race condition, using first match", + name, + ) + existing = existing[0] + log.debug("Found existing registry client after race condition: %s", name) + return existing + except ValueError: + # If we still can't find it, something else is wrong + pass + # Re-raise the original exception if we can't handle it + raise e + + def list_registry_buckets(): """ Lists all available Buckets in the NiFi Registry Returns: - (list[Bucket]) objects + list[:class:`~nipyapi.registry.models.Bucket`]: objects """ with nipyapi.utils.rest_exceptions(): return nipyapi.registry.BucketsApi().get_buckets() -def create_registry_bucket(name): +def create_registry_bucket(name, description=None): """ Creates a new Registry Bucket Args: name (str): name for the bucket, must be unique in the Registry + description (str, optional): description for the bucket Returns: - (Bucket): The new Bucket object + :class:`~nipyapi.registry.models.Bucket`: The new Bucket object """ with nipyapi.utils.rest_exceptions(): - bucket = nipyapi.registry.BucketsApi().create_bucket( - body={ - 'name': name - } + # Create a proper Bucket object with all supported fields + bucket_obj = nipyapi.registry.models.Bucket(name=name, description=description) + + bucket = nipyapi.registry.BucketsApi().create_bucket(body=bucket_obj) + log.debug( + "Created bucket %s against registry connection at %s", + bucket.identifier, + nipyapi.config.registry_config.api_client.host, ) - log.debug("Created bucket %s against registry connection at %s", - bucket.identifier, - nipyapi.config.registry_config.api_client.host) return bucket +def ensure_registry_bucket(name, description=None): + """ + Ensures a Registry Bucket exists, creating it if necessary. + + This is a convenience function that implements the common pattern of: + 1. Try to get existing bucket by name + 2. If not found, create it + 3. Handle race conditions gracefully + + Args: + name (str): name for the bucket, must be unique in the Registry + description (str, optional): description for the bucket (only used if creating new) + + Returns: + (Bucket): The bucket object (existing or new) + """ + # Try to get existing bucket first + try: + existing = get_registry_bucket(name) + if existing: + log.debug("Found existing registry bucket: %s", name) + return existing + except ValueError: + # Bucket doesn't exist, we'll create it below + pass + + # Try to create new bucket + try: + bucket = create_registry_bucket(name, description) + log.debug("Created new registry bucket: %s", name) + return bucket + except Exception as e: + # Handle race condition where bucket was created between check and creation + error_msg = str(e).lower() + if "already exists" in error_msg or "duplicate" in error_msg: + try: + existing = get_registry_bucket(name) + log.debug("Found existing registry bucket after race condition: %s", name) + return existing + except ValueError: + # If we still can't find it, something else is wrong + pass + # Re-raise the original exception if we can't handle it + raise e + + def delete_registry_bucket(bucket): """ Removes a bucket from the NiFi Registry @@ -187,15 +310,14 @@ def delete_registry_bucket(bucket): """ try: return nipyapi.registry.BucketsApi().delete_bucket( - version=bucket.revision.version - if bucket.revision is not None else 0, - bucket_id=bucket.identifier + version=bucket.revision.version if bucket.revision is not None else 0, + bucket_id=bucket.identifier, ) except (nipyapi.registry.rest.ApiException, AttributeError) as e: raise ValueError(e) from e -def get_registry_bucket(identifier, identifier_type='name', greedy=True): +def get_registry_bucket(identifier, identifier_type="name", greedy=True): """ Filters the Bucket list to a particular identifier @@ -210,8 +332,7 @@ def get_registry_bucket(identifier, identifier_type='name', greedy=True): """ with nipyapi.utils.rest_exceptions(): obj = list_registry_buckets() - return nipyapi.utils.filter_obj( - obj, identifier, identifier_type, greedy=greedy) + return nipyapi.utils.filter_obj(obj, identifier, identifier_type, greedy=greedy) def list_flows_in_bucket(bucket_id): @@ -228,8 +349,7 @@ def list_flows_in_bucket(bucket_id): return nipyapi.registry.BucketFlowsApi().get_flows(bucket_id) -def get_flow_in_bucket(bucket_id, identifier, identifier_type='name', - greedy=True): +def get_flow_in_bucket(bucket_id, identifier, identifier_type="name", greedy=True): """ Filters the Flows in a Bucket against a particular identifier @@ -245,14 +365,21 @@ def get_flow_in_bucket(bucket_id, identifier, identifier_type='name', """ with nipyapi.utils.rest_exceptions(): obj = list_flows_in_bucket(bucket_id) - return nipyapi.utils.filter_obj( - obj, identifier, identifier_type, greedy=greedy) + return nipyapi.utils.filter_obj(obj, identifier, identifier_type, greedy=greedy) # pylint: disable=R0913,R0917 -def save_flow_ver(process_group, registry_client, bucket, flow_name=None, - flow_id=None, comment='', desc='', refresh=True, - force=False): +def save_flow_ver( + process_group, + registry_client, + bucket, + flow_name=None, + flow_id=None, + comment="", + desc="", + refresh=True, + force=False, +): """ Adds a Process Group into NiFi Registry Version Control, or saves a new version to an existing VersionedFlow with a new version @@ -274,10 +401,21 @@ def save_flow_ver(process_group, registry_client, bucket, flow_name=None, force (bool): Whether to Force Commit, or just regular Commit Returns: - (VersionControlInformationEntity) - """ + :class:`~nipyapi.nifi.models.VersionControlInformationEntity` + """ + # Validate parameter types + assert isinstance( + registry_client, nipyapi.nifi.FlowRegistryClientEntity + ), "registry_client must be a FlowRegistryClientEntity, got: {}".format(type(registry_client)) + assert isinstance( + bucket, nipyapi.registry.Bucket + ), "bucket must be a Registry Bucket, got: {}".format(type(bucket)) + assert isinstance( + process_group, nipyapi.nifi.ProcessGroupEntity + ), "process_group must be a ProcessGroupEntity, got: {}".format(type(process_group)) + if refresh: - target_pg = nipyapi.canvas.get_process_group(process_group.id, 'id') + target_pg = nipyapi.canvas.get_process_group(process_group.id, "id") else: target_pg = process_group flow_dto = nipyapi.nifi.VersionedFlowDTO( @@ -286,19 +424,18 @@ def save_flow_ver(process_group, registry_client, bucket, flow_name=None, description=desc, flow_name=flow_name, flow_id=flow_id, - registry_id=registry_client.id + registry_id=registry_client.id, ) - if nipyapi.utils.check_version('1.10.0') <= 0: + 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( id=target_pg.id, body=nipyapi.nifi.StartVersionControlRequestEntity( - process_group_revision=target_pg.revision, - versioned_flow=flow_dto - ) + process_group_revision=target_pg.revision, versioned_flow=flow_dto + ), ) @@ -311,18 +448,15 @@ def stop_flow_ver(process_group, refresh=True): refresh (bool): Whether to refresh the object status before actioning Returns: - (VersionControlInformationEntity) + :class:`~nipyapi.nifi.models.VersionControlInformationEntity` """ with nipyapi.utils.rest_exceptions(): if refresh: - target_pg = nipyapi.canvas.get_process_group( - process_group.id, 'id' - ) + target_pg = nipyapi.canvas.get_process_group(process_group.id, "id") else: target_pg = process_group return nipyapi.nifi.VersionsApi().stop_version_control( - id=target_pg.id, - version=target_pg.revision.version + id=target_pg.id, version=target_pg.revision.version ) @@ -341,14 +475,11 @@ def revert_flow_ver(process_group): with nipyapi.utils.rest_exceptions(): return nipyapi.nifi.VersionsApi().initiate_revert_flow_version( id=process_group.id, - body=nipyapi.nifi.VersionsApi().get_version_information( - process_group.id - ) + body=nipyapi.nifi.VersionsApi().get_version_information(process_group.id), ) -def list_flow_versions(bucket_id, flow_id, registry_id=None, - service='registry'): +def list_flow_versions(bucket_id, flow_id, registry_id=None, service="registry"): """ EXPERIMENTAL List all the versions of a given Flow in a given Bucket @@ -365,19 +496,16 @@ def list_flow_versions(bucket_id, flow_id, registry_id=None, list(VersionedFlowSnapshotMetadata) or (VersionedFlowSnapshotMetadataSetEntity) """ - assert service in ['nifi', 'registry'] - if service == 'nifi': + assert service in ["nifi", "registry"] + if service == "nifi": with nipyapi.utils.rest_exceptions(): return nipyapi.nifi.FlowApi().get_versions( - registry_id=registry_id, - bucket_id=bucket_id, - flow_id=flow_id + registry_id=registry_id, bucket_id=bucket_id, flow_id=flow_id ) else: with nipyapi.utils.rest_exceptions(): return nipyapi.registry.BucketFlowsApi().get_flow_versions( - bucket_id=bucket_id, - flow_id=flow_id + bucket_id=bucket_id, flow_id=flow_id ) @@ -394,6 +522,7 @@ def update_flow_ver(process_group, target_version=None): Returns: (bool): True if successful, False if not """ + def _running_update_flow_version(): """ Tests for completion of the operation @@ -401,9 +530,7 @@ def _running_update_flow_version(): Returns: (bool) Boolean of operation success """ - status = nipyapi.nifi.VersionsApi().get_update_request( - u_init.request.request_id - ) + status = nipyapi.nifi.VersionsApi().get_update_request(u_init.request.request_id) if not status.request.complete: return False if status.request.failure_reason is None: @@ -412,12 +539,12 @@ def _running_update_flow_version(): "Flow Version Update did not complete successfully. " "Error text {0}".format(status.request.failure_reason) ) + with nipyapi.utils.rest_exceptions(): vci = get_version_info(process_group) assert isinstance(vci, nipyapi.nifi.VersionControlInformationEntity) flow_vers = list_flow_versions( - vci.version_control_information.bucket_id, - vci.version_control_information.flow_id + vci.version_control_information.bucket_id, vci.version_control_information.flow_id ) if target_version is None: # the first version is always the latest available @@ -425,9 +552,11 @@ def _running_update_flow_version(): else: # otherwise the version must be an int if not isinstance(target_version, int): - raise ValueError("target_version must be a positive Integer to" - " pick a specific available version, or None" - " for the latest version to be fetched") + raise ValueError( + "target_version must be a positive Integer to" + " pick a specific available version, or None" + " for the latest version to be fetched" + ) ver = target_version u_init = nipyapi.nifi.VersionsApi().initiate_version_control_update( id=process_group.id, @@ -438,14 +567,12 @@ def _running_update_flow_version(): flow_id=vci.version_control_information.flow_id, group_id=vci.version_control_information.group_id, registry_id=vci.version_control_information.registry_id, - version=ver - ) - ) + version=ver, + ), + ), ) nipyapi.utils.wait_to_complete(_running_update_flow_version) - return nipyapi.nifi.VersionsApi().get_update_request( - u_init.request.request_id - ) + return nipyapi.nifi.VersionsApi().get_update_request(u_init.request.request_id) def get_latest_flow_ver(bucket_id, flow_id): @@ -460,9 +587,7 @@ def get_latest_flow_ver(bucket_id, flow_id): (VersionedFlowSnapshot) """ with nipyapi.utils.rest_exceptions(): - return get_flow_version( - bucket_id, flow_id, version=None - ) + return get_flow_version(bucket_id, flow_id, version=None) def get_version_info(process_group): @@ -473,16 +598,14 @@ def get_version_info(process_group): process_group (ProcessGroupEntity): the ProcessGroup to work with Returns: - (VersionControlInformationEntity) + :class:`~nipyapi.nifi.models.VersionControlInformationEntity` """ assert isinstance(process_group, nipyapi.nifi.ProcessGroupEntity) with nipyapi.utils.rest_exceptions(): - return nipyapi.nifi.VersionsApi().get_version_information( - process_group.id - ) + return nipyapi.nifi.VersionsApi().get_version_information(process_group.id) -def create_flow(bucket_id, flow_name, flow_desc='', flow_type='Flow'): +def create_flow(bucket_id, flow_name, flow_desc="", flow_type="Flow"): """ Creates a new VersionedFlow stub in NiFi Registry. Can be used to write VersionedFlow information to without using a NiFi @@ -506,8 +629,8 @@ def create_flow(bucket_id, flow_name, flow_desc='', flow_type='Flow'): description=flow_desc, bucket_identifier=bucket_id, type=flow_type, - version_count=0 - ) + version_count=0, + ), ) @@ -531,23 +654,20 @@ def create_flow_version(flow, flow_snapshot, refresh=True): The new (VersionedFlowSnapshot) """ if not isinstance(flow_snapshot, nipyapi.registry.VersionedFlowSnapshot): - raise ValueError("flow_snapshot must be an instance of a " - "registry.VersionedFlowSnapshot object, not an {0}" - .format(type(flow_snapshot))) + raise ValueError( + "flow_snapshot must be an instance of a " + "registry.VersionedFlowSnapshot object, not an {0}".format(type(flow_snapshot)) + ) with nipyapi.utils.rest_exceptions(): if refresh: target_flow = get_flow_in_bucket( - bucket_id=flow.bucket_identifier, - identifier=flow.identifier, - identifier_type='id' + bucket_id=flow.bucket_identifier, identifier=flow.identifier, identifier_type="id" ) else: target_flow = flow - target_bucket = get_registry_bucket( - target_flow.bucket_identifier, 'id' - ) + target_bucket = get_registry_bucket(target_flow.bucket_identifier, "id") # The current version of NiFi doesn't ignore link objects passed to it - bad_params = ['link'] + bad_params = ["link"] for obj in [target_bucket, target_flow]: for p in bad_params: setattr(obj, p, None) @@ -566,9 +686,9 @@ def create_flow_version(flow, flow_snapshot, refresh=True): version=target_flow.version_count + 1, comments=flow_snapshot.snapshot_metadata.comments, bucket_identifier=target_flow.bucket_identifier, - flow_identifier=target_flow.identifier + flow_identifier=target_flow.identifier, ), - ) + ), ) @@ -595,9 +715,7 @@ def get_flow_version(bucket_id, flow_id, version=None, export=False): assert isinstance(flow_id, str) # Version needs to be coerced to str pass API client regex test # Even though the client specifies it as Int - assert version is None or isinstance( - version, (str, int) - ) + assert version is None or isinstance(version, (str, int)) assert isinstance(export, bool) if version: with nipyapi.utils.rest_exceptions(): @@ -605,22 +723,19 @@ def get_flow_version(bucket_id, flow_id, version=None, export=False): bucket_id=bucket_id, flow_id=flow_id, version_number=str(version), # This str coercion is intended - _preload_content=not export + _preload_content=not export, ) else: with nipyapi.utils.rest_exceptions(): out = nipyapi.registry.BucketFlowsApi().get_latest_flow_version( - bucket_id, - flow_id, - _preload_content=not export + bucket_id, flow_id, _preload_content=not export ) if export: return out.data return out -def export_flow_version(bucket_id, flow_id, version=None, file_path=None, - mode='json'): +def export_flow_version(bucket_id, flow_id, version=None, file_path=None, mode="json"): """ Convenience method to export the identified VersionedFlowSnapshot in the provided format mode. @@ -641,7 +756,7 @@ def export_flow_version(bucket_id, flow_id, version=None, file_path=None, assert isinstance(flow_id, str) assert file_path is None or isinstance(file_path, str) assert version is None or isinstance(version, str) - assert mode in ['yaml', 'json'] + assert mode in ["yaml", "json"] raw_obj = get_flow_version(bucket_id, flow_id, version, export=True) export_obj = nipyapi.utils.dump(nipyapi.utils.load(raw_obj), mode) if file_path: @@ -652,8 +767,7 @@ def export_flow_version(bucket_id, flow_id, version=None, file_path=None, return export_obj -def import_flow_version(bucket_id, encoded_flow=None, file_path=None, - flow_name=None, flow_id=None): +def import_flow_version(bucket_id, encoded_flow=None, file_path=None, flow_name=None, flow_id=None): """ Imports a given encoded_flow version into the bucket and flow described, may optionally be passed a file to read the encoded flow_contents from. @@ -676,50 +790,36 @@ def import_flow_version(bucket_id, encoded_flow=None, file_path=None, The new (VersionedFlowSnapshot) """ # First, decode the flow snapshot contents - dto = ('registry', 'VersionedFlowSnapshot') + dto = ("registry", "VersionedFlowSnapshot") if file_path is None and encoded_flow is not None: with nipyapi.utils.rest_exceptions(): - imported_flow = nipyapi.utils.load( - encoded_flow, - dto=dto - ) + imported_flow = nipyapi.utils.load(encoded_flow, dto=dto) elif file_path is not None and encoded_flow is None: with nipyapi.utils.rest_exceptions(): - file_in = nipyapi.utils.fs_read( - file_path=file_path - ) + file_in = nipyapi.utils.fs_read(file_path=file_path) assert isinstance(file_in, (str, bytes)) - imported_flow = nipyapi.utils.load( - obj=file_in, - dto=dto - ) - assert isinstance( - imported_flow, - nipyapi.registry.VersionedFlowSnapshot - ) + imported_flow = nipyapi.utils.load(obj=file_in, dto=dto) + assert isinstance(imported_flow, nipyapi.registry.VersionedFlowSnapshot) else: - raise ValueError("Either file_path must point to a file for import, or" - " flow_snapshot must be an importable object, but" - "not both") + raise ValueError( + "Either file_path must point to a file for import, or" + " flow_snapshot must be an importable object, but" + "not both" + ) # Now handle determining which Versioned Item to write to if flow_id is None and flow_name is not None: # Case: New flow # create the Bucket item - ver_flow = create_flow( - bucket_id=bucket_id, - flow_name=flow_name - ) + ver_flow = create_flow(bucket_id=bucket_id, flow_name=flow_name) elif flow_name is None and flow_id is not None: # Case: New version in existing flow - ver_flow = get_flow_in_bucket( - bucket_id=bucket_id, - identifier=flow_id, - identifier_type='id' - ) + ver_flow = get_flow_in_bucket(bucket_id=bucket_id, identifier=flow_id, identifier_type="id") else: - raise ValueError("Either flow_id must be the identifier of a flow to" - " add this version to, or flow_name must be a unique " - "name for a flow in this bucket, but not both") + raise ValueError( + "Either flow_id must be the identifier of a flow to" + " add this version to, or flow_name must be a unique " + "name for a flow in this bucket, but not both" + ) # Now write the new version nipyapi.utils.validate_parameters_versioning_support(verify_nifi=False) return create_flow_version( @@ -729,8 +829,7 @@ def import_flow_version(bucket_id, encoded_flow=None, file_path=None, # pylint: disable=R0913, R0917 -def deploy_flow_version(parent_id, location, bucket_id, flow_id, reg_client_id, - version=None): +def deploy_flow_version(parent_id, location, bucket_id, flow_id, reg_client_id, version=None): """ Deploys a versioned flow as a new process group inside the given parent process group. If version is not provided, the latest version will be @@ -755,24 +854,23 @@ def deploy_flow_version(parent_id, location, bucket_id, flow_id, reg_client_id, location = location or (0, 0) assert isinstance(location, tuple) # check reg client is valid - target_reg_client = get_registry_client(reg_client_id, 'id') + target_reg_client = get_registry_client(reg_client_id, "id") # Being pedantic about checking this as API failure errors are terse # Using NiFi here to keep all calls within the same API client flow_versions = list_flow_versions( - bucket_id=bucket_id, - flow_id=flow_id, - registry_id=reg_client_id, - service='nifi' + bucket_id=bucket_id, flow_id=flow_id, registry_id=reg_client_id, service="nifi" ) if not flow_versions: - raise ValueError("Could not find Flows matching Bucket ID [{0}] and " - "Flow ID [{1}] on Registry Client [{2}]" - .format(bucket_id, flow_id, reg_client_id)) + raise ValueError( + "Could not find Flows matching Bucket ID [{0}] and " + "Flow ID [{1}] on Registry Client [{2}]".format(bucket_id, flow_id, reg_client_id) + ) if version is None: target_flow = flow_versions.versioned_flow_snapshot_metadata_set else: target_flow = [ - x for x in flow_versions.versioned_flow_snapshot_metadata_set + x + for x in flow_versions.versioned_flow_snapshot_metadata_set if str(x.versioned_flow_snapshot_metadata.version) == str(version) ] if not target_flow: @@ -782,34 +880,27 @@ def deploy_flow_version(parent_id, location, bucket_id, flow_id, reg_client_id, ] raise ValueError( "Could not find Version [{0}] for Flow [{1}] in Bucket [{2}] on " - "Registry Client [{3}]. Available versions are: {4}" - .format(str(version), flow_id, bucket_id, reg_client_id, - ", ".join(available_versions)) + "Registry Client [{3}]. Available versions are: {4}".format( + str(version), flow_id, bucket_id, reg_client_id, ", ".join(available_versions) + ) ) target_flow = sorted( - target_flow, - key=lambda x: x.versioned_flow_snapshot_metadata.version, - reverse=True + target_flow, key=lambda x: x.versioned_flow_snapshot_metadata.version, reverse=True )[0].versioned_flow_snapshot_metadata # Issue deploy statement with nipyapi.utils.rest_exceptions(): return nipyapi.nifi.ProcessGroupsApi().create_process_group( id=parent_id, body=nipyapi.nifi.ProcessGroupEntity( - revision=nipyapi.nifi.RevisionDTO( - version=0 - ), + revision=nipyapi.nifi.RevisionDTO(version=0), component=nipyapi.nifi.ProcessGroupDTO( - position=nipyapi.nifi.PositionDTO( - x=float(location[0]), - y=float(location[1]) - ), + position=nipyapi.nifi.PositionDTO(x=float(location[0]), y=float(location[1])), version_control_information=VciDTO( bucket_id=target_flow.bucket_identifier, flow_id=target_flow.flow_identifier, registry_id=target_reg_client.id, - version=target_flow.version - ) - ) - ) + version=target_flow.version, + ), + ), + ), ) diff --git a/pyproject.toml b/pyproject.toml new file mode 100644 index 00000000..8c5d4be5 --- /dev/null +++ b/pyproject.toml @@ -0,0 +1,96 @@ +[build-system] +requires = [ + "setuptools>=69", + "wheel", + "setuptools-scm[toml]>=8", +] +build-backend = "setuptools.build_meta" + +[project] +name = "nipyapi" +description = "A rich Apache NiFi Python Client SDK" +readme = "README.rst" +requires-python = ">=3.9" +license = "Apache-2.0" +authors = [ { name = "NiPyAPI maintainers", email = "chaffelson@gmail.com" } ] +keywords = ["nipyapi", "nifi", "apache nifi", "client", "sdk"] +classifiers = [ + "Development Status :: 4 - Beta", + "Intended Audience :: Developers", + "Intended Audience :: System Administrators", + "Natural Language :: English", + "Operating System :: OS Independent", + "Programming Language :: Python :: 3", + "Programming Language :: Python :: 3.9", + "Programming Language :: Python :: 3.10", + "Programming Language :: Python :: 3.11", + "Programming Language :: Python :: 3.12", + "Topic :: Software Development :: Libraries", +] +dynamic = ["version", "dependencies"] + +[tool.setuptools.dynamic] +dependencies = { file = ["requirements.txt"] } + +[tool.setuptools_scm] +write_to = "nipyapi/_version.py" +fallback_version = "0.0.0+unknown" + +[tool.setuptools] +include-package-data = true + +[tool.setuptools.packages.find] +include = ["nipyapi*"] +exclude = ["nipyapi.demo", "nipyapi.demo.*"] + +[tool.setuptools.exclude-package-data] +"nipyapi.demo" = ["keys/*"] + +# Black configuration +[tool.black] +line-length = 100 +target-version = ['py39'] +include = '^nipyapi/.*\.py$' +exclude = ''' +/( + nipyapi/(nifi|registry) + | nipyapi/_version\.py +)/ +''' + +# isort configuration (compatible with black) +[tool.isort] +profile = "black" +line_length = 100 +include_trailing_comma = true +multi_line_output = 3 +src_paths = ["nipyapi"] +skip_glob = ["nipyapi/nifi/*", "nipyapi/registry/*", "nipyapi/_version.py"] + +[project.urls] +Homepage = "https://github.com/Chaffelson/nipyapi" +Repository = "https://github.com/Chaffelson/nipyapi.git" +Documentation = "https://nipyapi.readthedocs.io/en/latest/" +Issues = "https://github.com/Chaffelson/nipyapi/issues" + +[project.optional-dependencies] +dev = [ + "build>=1.0.0", + "setuptools-scm[toml]>=8", + "flake8>=3.6.0", + "pylint>=3.3.0", + "black>=24.8.0", + "isort>=5.13.2", + "coverage>=7.0", + "pytest>=8.4", + "pytest-cov>=5.0.0", + "codecov>=2.1.13", + "deepdiff>=3.3.0", + "twine>=6.0.0", + "pre-commit>=3.0.0", +] +docs = [ + "Sphinx>=7.4.0", + "sphinx_rtd_theme>=3.0.0", + "sphinxcontrib-jquery>=4.1", +] diff --git a/requirements.txt b/requirements.txt index f6ca4de6..0b300b1f 100644 --- a/requirements.txt +++ b/requirements.txt @@ -6,18 +6,16 @@ setuptools>=38.5 # Version comparison packaging>=17.1 -# Templates management implementation -lxml>=4.9.3 +# HTTP stack (explicit because generated clients import these directly) +# TODO: evaluate reducing direct requests usage in favor of urllib3-only later +urllib3>=1.26,<3 +certifi>=2023.7.22 -# Security and Connectivity -requests[security]>=2.18 -# urllib3, cryptography are handled by requests +# Security and Connectivity (used in utils and demos) +requests>=2.18 # Socks Proxy pysocks>=1.7.1 # Import Export and Utils implementation -ruamel.yaml>=0.16.3 - -# xml to json parsing -xmltodict>=0.12.0 +PyYAML>=6.0 diff --git a/requirements_dev.txt b/requirements_dev.txt deleted file mode 100644 index c5e7e6a2..00000000 --- a/requirements_dev.txt +++ /dev/null @@ -1,30 +0,0 @@ -# basics -wheel>=0.30.0 -pip>=9.0.1 - -# Project management and Deployment -bumpversion>=0.5.3 -watchdog>=0.8.3 -twine>=1.9.1 -virtualenvwrapper>=4.8 -virtualenv>=16.0.0 # required for tox 3.14.2 but not forced - -# Testing -tox>=3.28.0 -flake8>=3.6.0 -coverage>=4.4.1 -coveralls>=1.2.0 -pytest # pyup: ignore -nose>=1.3.7 -pluggy>=0.3.1 -pylint>=1.7.4 -deepdiff>=3.3.0 - -# Docs -Sphinx>=1.6.3 -sphinx_rtd_theme>=0.2.5b1 - -# Code Deps -cryptography>=2.1.2 -randomize>=0.13 -certifi>=2017.7.27.1 diff --git a/resources/certs/gen_certs.sh b/resources/certs/gen_certs.sh new file mode 100755 index 00000000..1ecb8c66 --- /dev/null +++ b/resources/certs/gen_certs.sh @@ -0,0 +1,198 @@ +#!/usr/bin/env bash +set -euo pipefail + +# Generates a test CA, server certs (with SANs) and PKCS12 keystores/truststores +# for NiFi and NiFi Registry, plus a client cert for mTLS. +# +# Outputs (relative to this directory): +# - ca/ca.key, ca/ca.crt +# - nifi/server.key, nifi/server.crt, nifi/keystore.p12 +# - registry/server.key, registry/server.crt, registry/keystore.p12 +# - truststore/truststore.p12 (contains CA cert) +# - client/client.key, client/client.crt (PEM), client/client.p12 (optional), client/ca.pem +# +# Keystore/truststore type: PKCS12 +# Default password: changeit (override with CERT_PASSWORD env) +# +# SANs include: localhost, 127.0.0.1, nifi-single, nifi-ldap, nifi-mtls, registry-single, registry-ldap, registry-mtls +# +# Requirements: openssl + +script_dir="$(cd "$(dirname "$0")" && pwd)" +cd "$script_dir" + +PASS="${CERT_PASSWORD:-changeit}" +DAYS="${CERT_DAYS:-3650}" + +# Clean existing cert artifacts unless disabled +CLEAN="${CERTS_CLEAN:-1}" +if [[ "$CLEAN" == "1" || "$CLEAN" == "true" ]]; then + rm -rf ca nifi registry truststore client || true +fi + +mkdir -p ca nifi registry truststore client + +cat > ca/ca.cnf < "$extfile" </dev/null 2>&1; then + keytool -importcert -noprompt -alias nipyca \ + -file ca/ca.crt \ + -keystore truststore/truststore.p12 \ + -storetype PKCS12 -storepass "$PASS" >/dev/null 2>&1 || true + fi +} + +create_client() { + # Client cert for mTLS (PEM and optional PKCS12) + openssl genrsa -out client/client.key 2048 + openssl req -new -key client/client.key -subj "/CN=user1/O=NiPyAPI/C=US" -out client/client.csr + openssl x509 -req -in client/client.csr -CA ca/ca.crt -CAkey ca/ca.key -CAcreateserial \ + -out client/client.crt -days "$DAYS" -sha256 -extfile <(cat </dev/null 2>&1; then + keytool -importkeystore -noprompt \ + -srckeystore nifi/keystore.p12 -srcstoretype PKCS12 -srcstorepass "$PASS" \ + -destkeystore nifi/keystore.jks -deststoretype JKS -deststorepass "$PASS" >/dev/null 2>&1 || true + chmod 644 nifi/keystore.jks 2>/dev/null || true + keytool -importkeystore -noprompt \ + -srckeystore registry/keystore.p12 -srcstoretype PKCS12 -srcstorepass "$PASS" \ + -destkeystore registry/keystore.jks -deststoretype JKS -deststorepass "$PASS" >/dev/null 2>&1 || true + chmod 644 registry/keystore.jks 2>/dev/null || true + keytool -importkeystore -noprompt \ + -srckeystore truststore/truststore.p12 -srcstoretype PKCS12 -srcstorepass "$PASS" \ + -destkeystore truststore/truststore.jks -deststoretype JKS -deststorepass "$PASS" >/dev/null 2>&1 || true + chmod 644 truststore/truststore.jks 2>/dev/null || true +fi + +cat > ./certs.env < ./nifi.env < ./registry.env <'.", - "operationId" : "createAccessTokenFromTicket", - "consumes" : [ "text/plain" ], - "produces" : [ "text/plain" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "NiFi was unable to complete the request because it did not contain a valid Kerberos ticket in the Authorization header. Retry this request after initializing a ticket with kinit and ensuring your browser is configured to support SPNEGO." - }, - "409" : { - "description" : "Unable to create access token because NiFi is not in the appropriate state. (i.e. may not be configured to support Kerberos login." - }, - "500" : { - "description" : "Unable to create access token because an unexpected error occurred." - } - } - } - }, - "/access/knox/callback" : { - "get" : { - "tags" : [ "access" ], - "summary" : "Redirect/callback URI for processing the result of the Apache Knox login sequence.", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "knoxCallback", - "consumes" : [ "*/*" ], - "produces" : [ "*/*" ], - "responses" : { - "default" : { - "description" : "successful operation" - } - } - } - }, - "/access/knox/logout" : { - "get" : { - "tags" : [ "access" ], - "summary" : "Performs a logout in the Apache Knox.", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "knoxLogout", - "consumes" : [ "*/*" ], - "produces" : [ "*/*" ], - "responses" : { - "default" : { - "description" : "successful operation" - } - } - } - }, - "/access/knox/request" : { - "get" : { - "tags" : [ "access" ], - "summary" : "Initiates a request to authenticate through Apache Knox.", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "knoxRequest", - "consumes" : [ "*/*" ], - "produces" : [ "*/*" ], - "responses" : { - "default" : { - "description" : "successful operation" - } - } - } - }, - "/access/logout" : { - "delete" : { - "tags" : [ "access" ], - "summary" : "Performs a logout for other providers that have been issued a JWT.", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "logOut", - "consumes" : [ "*/*" ], - "produces" : [ "*/*" ], - "responses" : { - "200" : { - "description" : "User was logged out successfully." - }, - "401" : { - "description" : "Authentication token provided was empty or not in the correct JWT format." - }, - "500" : { - "description" : "Client failed to log out." - } - } - } - }, - "/access/oidc/callback" : { - "get" : { - "tags" : [ "access" ], - "summary" : "Redirect/callback URI for processing the result of the OpenId Connect login sequence.", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "oidcCallback", - "consumes" : [ "*/*" ], - "produces" : [ "*/*" ], - "responses" : { - "default" : { - "description" : "successful operation" - } - } - } - }, - "/access/oidc/exchange" : { - "post" : { - "tags" : [ "access" ], - "summary" : "Retrieves a JWT following a successful login sequence using the configured OpenId Connect provider.", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "oidcExchange", - "consumes" : [ "*/*" ], - "produces" : [ "text/plain" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - } - } - } - }, - "/access/oidc/logout" : { - "get" : { - "tags" : [ "access" ], - "summary" : "Performs a logout in the OpenId Provider.", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "oidcLogout", - "consumes" : [ "*/*" ], - "produces" : [ "*/*" ], - "responses" : { - "default" : { - "description" : "successful operation" - } - } - } - }, - "/access/oidc/request" : { - "get" : { - "tags" : [ "access" ], - "summary" : "Initiates a request to authenticate through the configured OpenId Connect provider.", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "oidcRequest", - "consumes" : [ "*/*" ], - "produces" : [ "*/*" ], - "responses" : { - "default" : { - "description" : "successful operation" - } - } - } - }, - "/access/token" : { - "post" : { - "tags" : [ "access" ], - "summary" : "Creates a token for accessing the REST API via username/password", - "description" : "The token returned is formatted as a JSON Web Token (JWT). The token is base64 encoded and comprised of three parts. The header, the body, and the signature. The expiration of the token is a contained within the body. The token can be used in the Authorization header in the format 'Authorization: Bearer '.", - "operationId" : "createAccessToken", - "consumes" : [ "application/x-www-form-urlencoded" ], - "produces" : [ "text/plain" ], - "parameters" : [ { - "name" : "username", - "in" : "formData", - "required" : false, - "type" : "string" - }, { - "name" : "password", - "in" : "formData", - "required" : false, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "Unable to create access token because NiFi is not in the appropriate state. (i.e. may not be configured to support username/password login." - }, - "500" : { - "description" : "Unable to create access token because an unexpected error occurred." - } - } - } - }, - "/access/ui-extension-token" : { - "post" : { - "tags" : [ "access" ], - "summary" : "Creates a single use access token for accessing a NiFi UI extension.", - "description" : "The token returned is a base64 encoded string. It is valid for a single request up to five minutes from being issued. It is used as a query parameter name 'access_token'.", - "operationId" : "createUiExtensionToken", - "consumes" : [ "application/x-www-form-urlencoded" ], - "produces" : [ "text/plain" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "Unable to create the download token because NiFi is not in the appropriate state. (i.e. may not have any tokens to grant or be configured to support username/password login)" - }, - "500" : { - "description" : "Unable to create download token because an unexpected error occurred." - } - } - } - }, - "/connections/{id}" : { - "get" : { - "tags" : [ "connections" ], - "summary" : "Gets a connection", - "description" : "", - "operationId" : "getConnection", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The connection id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ConnectionEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read Source - /{component-type}/{uuid}" : [ ] - }, { - "Read Destination - /{component-type}/{uuid}" : [ ] - } ] - }, - "put" : { - "tags" : [ "connections" ], - "summary" : "Updates a connection", - "description" : "", - "operationId" : "updateConnection", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The connection id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The connection configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ConnectionEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ConnectionEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write Source - /{component-type}/{uuid}" : [ ] - }, { - "Write Destination - /{component-type}/{uuid}" : [ ] - }, { - "Write New Destination - /{component-type}/{uuid} - if updating Destination" : [ ] - }, { - "Write Process Group - /process-groups/{uuid} - if updating Destination" : [ ] - } ] - }, - "delete" : { - "tags" : [ "connections" ], - "summary" : "Deletes a connection", - "description" : "", - "operationId" : "deleteConnection", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The revision is used to verify the client is working with the latest version of the flow.", - "required" : false, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The connection id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ConnectionEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write Source - /{component-type}/{uuid}" : [ ] - }, { - "Write - Parent Process Group - /process-groups/{uuid}" : [ ] - }, { - "Write Destination - /{component-type}/{uuid}" : [ ] - } ] - } - }, - "/controller-services/{id}" : { - "get" : { - "tags" : [ "controller-services" ], - "summary" : "Gets a controller service", - "description" : "", - "operationId" : "getControllerService", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The controller service id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ControllerServiceEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /controller-services/{uuid}" : [ ] - } ] - }, - "put" : { - "tags" : [ "controller-services" ], - "summary" : "Updates a controller service", - "description" : "", - "operationId" : "updateControllerService", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The controller service id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The controller service configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ControllerServiceEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ControllerServiceEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /controller-services/{uuid}" : [ ] - }, { - "Read - any referenced Controller Services if this request changes the reference - /controller-services/{uuid}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "controller-services" ], - "summary" : "Deletes a controller service", - "description" : "", - "operationId" : "removeControllerService", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The revision is used to verify the client is working with the latest version of the flow.", - "required" : false, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The controller service id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ControllerServiceEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /controller-services/{uuid}" : [ ] - }, { - "Write - Parent Process Group if scoped by Process Group - /process-groups/{uuid}" : [ ] - }, { - "Write - Controller if scoped by Controller - /controller" : [ ] - }, { - "Read - any referenced Controller Services - /controller-services/{uuid}" : [ ] - } ] - } - }, - "/controller-services/{id}/descriptors" : { - "get" : { - "tags" : [ "controller-services" ], - "summary" : "Gets a controller service property descriptor", - "description" : "", - "operationId" : "getPropertyDescriptor", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The controller service id.", - "required" : true, - "type" : "string" - }, { - "name" : "propertyName", - "in" : "query", - "description" : "The property name to return the descriptor for.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/PropertyDescriptorEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /controller-services/{uuid}" : [ ] - } ] - } - }, - "/controller-services/{id}/references" : { - "get" : { - "tags" : [ "controller-services" ], - "summary" : "Gets a controller service", - "description" : "", - "operationId" : "getControllerServiceReferences", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The controller service id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ControllerServiceReferencingComponentsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /controller-services/{uuid}" : [ ] - } ] - }, - "put" : { - "tags" : [ "controller-services" ], - "summary" : "Updates a controller services references", - "description" : "", - "operationId" : "updateControllerServiceReferences", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The controller service id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The controller service request update request.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/UpdateControllerServiceReferenceRequestEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ControllerServiceReferencingComponentsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /{component-type}/{uuid} or /operate/{component-type}/{uuid} - For each referencing component specified" : [ ] - } ] - } - }, - "/controller-services/{id}/run-status" : { - "put" : { - "tags" : [ "controller-services" ], - "summary" : "Updates run status of a controller service", - "description" : "", - "operationId" : "updateRunStatus", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The controller service id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The controller service run status.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ControllerServiceRunStatusEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ControllerServiceEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /controller-services/{uuid} or /operation/controller-services/{uuid}" : [ ] - } ] - } - }, - "/controller-services/{id}/state" : { - "get" : { - "tags" : [ "controller-services" ], - "summary" : "Gets the state for a controller service", - "description" : "", - "operationId" : "getState", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The controller service id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ComponentStateEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /controller-services/{uuid}" : [ ] - } ] - } - }, - "/controller-services/{id}/state/clear-requests" : { - "post" : { - "tags" : [ "controller-services" ], - "summary" : "Clears the state for a controller service", - "description" : "", - "operationId" : "clearState", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The controller service id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ComponentStateEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /controller-services/{uuid}" : [ ] - } ] - } - }, - "/controller/bulletin" : { - "post" : { - "tags" : [ "controller" ], - "summary" : "Creates a new bulletin", - "description" : "", - "operationId" : "createBulletin", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The reporting task configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/BulletinEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /controller" : [ ] - } ] - } - }, - "/controller/cluster" : { - "get" : { - "tags" : [ "controller" ], - "summary" : "Gets the contents of the cluster", - "description" : "Returns the contents of the cluster including all nodes and their status.", - "operationId" : "getCluster", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ClusterEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /controller" : [ ] - } ] - } - }, - "/controller/cluster/nodes/{id}" : { - "get" : { - "tags" : [ "controller" ], - "summary" : "Gets a node in the cluster", - "description" : "", - "operationId" : "getNode", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The node id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/NodeEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /controller" : [ ] - } ] - }, - "put" : { - "tags" : [ "controller" ], - "summary" : "Updates a node in the cluster", - "description" : "", - "operationId" : "updateNode", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The node id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The node configuration. The only configuration that will be honored at this endpoint is the status.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/NodeEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/NodeEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /controller" : [ ] - } ] - }, - "delete" : { - "tags" : [ "controller" ], - "summary" : "Removes a node from the cluster", - "description" : "", - "operationId" : "deleteNode", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The node id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/NodeEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /controller" : [ ] - } ] - } - }, - "/controller/config" : { - "get" : { - "tags" : [ "controller" ], - "summary" : "Retrieves the configuration for this NiFi Controller", - "description" : "", - "operationId" : "getControllerConfig", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ControllerConfigurationEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /controller" : [ ] - } ] - }, - "put" : { - "tags" : [ "controller" ], - "summary" : "Retrieves the configuration for this NiFi", - "description" : "", - "operationId" : "updateControllerConfig", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The controller configuration.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ControllerConfigurationEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ControllerConfigurationEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /controller" : [ ] - } ] - } - }, - "/controller/controller-services" : { - "post" : { - "tags" : [ "controller" ], - "summary" : "Creates a new controller service", - "description" : "", - "operationId" : "createControllerService", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The controller service configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ControllerServiceEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ControllerServiceEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /controller" : [ ] - }, { - "Read - any referenced Controller Services - /controller-services/{uuid}" : [ ] - }, { - "Write - if the Controller Service is restricted - /restricted-components" : [ ] - } ] - } - }, - "/controller/history" : { - "delete" : { - "tags" : [ "controller" ], - "summary" : "Purges history", - "description" : "", - "operationId" : "deleteHistory", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "endDate", - "in" : "query", - "description" : "Purge actions before this date/time.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/HistoryEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /controller" : [ ] - } ] - } - }, - "/controller/registry-clients" : { - "get" : { - "tags" : [ "controller" ], - "summary" : "Gets the listing of available registry clients", - "description" : "", - "operationId" : "getRegistryClients", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/RegistryClientsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - }, - "post" : { - "tags" : [ "controller" ], - "summary" : "Creates a new registry client", - "description" : "", - "operationId" : "createRegistryClient", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The registry configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/RegistryClientEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/RegistryClientEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /controller" : [ ] - } ] - } - }, - "/controller/registry-clients/{id}" : { - "get" : { - "tags" : [ "controller" ], - "summary" : "Gets a registry client", - "description" : "", - "operationId" : "getRegistryClient", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The registry id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/RegistryClientEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /controller" : [ ] - } ] - }, - "put" : { - "tags" : [ "controller" ], - "summary" : "Updates a registry client", - "description" : "", - "operationId" : "updateRegistryClient", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The registry id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The registry configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/RegistryClientEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/RegistryClientEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /controller" : [ ] - } ] - }, - "delete" : { - "tags" : [ "controller" ], - "summary" : "Deletes a registry client", - "description" : "", - "operationId" : "deleteRegistryClient", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The revision is used to verify the client is working with the latest version of the flow.", - "required" : false, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The registry id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/RegistryClientEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /controller" : [ ] - } ] - } - }, - "/controller/reporting-tasks" : { - "post" : { - "tags" : [ "controller" ], - "summary" : "Creates a new reporting task", - "description" : "", - "operationId" : "createReportingTask", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The reporting task configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ReportingTaskEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ReportingTaskEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /controller" : [ ] - }, { - "Read - any referenced Controller Services - /controller-services/{uuid}" : [ ] - }, { - "Write - if the Reporting Task is restricted - /restricted-components" : [ ] - } ] - } - }, - "/counters" : { - "get" : { - "tags" : [ "counters" ], - "summary" : "Gets the current counters for this NiFi", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getCounters", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "nodewise", - "in" : "query", - "description" : "Whether or not to include the breakdown per node. Optional, defaults to false", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "clusterNodeId", - "in" : "query", - "description" : "The id of the node where to get the status.", - "required" : false, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/CountersEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /counters" : [ ] - } ] - } - }, - "/counters/{id}" : { - "put" : { - "tags" : [ "counters" ], - "summary" : "Updates the specified counter. This will reset the counter value to 0", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "updateCounter", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The id of the counter.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/CounterEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /counters" : [ ] - } ] - } - }, - "/data-transfer/input-ports/{portId}/transactions/{transactionId}" : { - "put" : { - "tags" : [ "data-transfer" ], - "summary" : "Extend transaction TTL", - "description" : "", - "operationId" : "extendInputPortTransactionTTL", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "portId", - "in" : "path", - "required" : true, - "type" : "string" - }, { - "name" : "transactionId", - "in" : "path", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/TransactionResultEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /data-transfer/input-ports/{uuid}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "data-transfer" ], - "summary" : "Commit or cancel the specified transaction", - "description" : "", - "operationId" : "commitInputPortTransaction", - "consumes" : [ "application/octet-stream" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "responseCode", - "in" : "query", - "description" : "The response code. Available values are BAD_CHECKSUM(19), CONFIRM_TRANSACTION(12) or CANCEL_TRANSACTION(15).", - "required" : true, - "type" : "integer", - "format" : "int32" - }, { - "name" : "portId", - "in" : "path", - "description" : "The input port id.", - "required" : true, - "type" : "string" - }, { - "name" : "transactionId", - "in" : "path", - "description" : "The transaction id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/TransactionResultEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - }, - "503" : { - "description" : "NiFi instance is not ready for serving request, or temporarily overloaded. Retrying the same request later may be successful" - } - }, - "security" : [ { - "Write - /data-transfer/input-ports/{uuid}" : [ ] - } ] - } - }, - "/data-transfer/input-ports/{portId}/transactions/{transactionId}/flow-files" : { - "post" : { - "tags" : [ "data-transfer" ], - "summary" : "Transfer flow files to the input port", - "description" : "", - "operationId" : "receiveFlowFiles", - "consumes" : [ "application/octet-stream" ], - "produces" : [ "text/plain" ], - "parameters" : [ { - "name" : "portId", - "in" : "path", - "description" : "The input port id.", - "required" : true, - "type" : "string" - }, { - "name" : "transactionId", - "in" : "path", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - }, - "503" : { - "description" : "NiFi instance is not ready for serving request, or temporarily overloaded. Retrying the same request later may be successful" - } - }, - "security" : [ { - "Write - /data-transfer/input-ports/{uuid}" : [ ] - } ] - } - }, - "/data-transfer/output-ports/{portId}/transactions/{transactionId}" : { - "put" : { - "tags" : [ "data-transfer" ], - "summary" : "Extend transaction TTL", - "description" : "", - "operationId" : "extendOutputPortTransactionTTL", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "portId", - "in" : "path", - "required" : true, - "type" : "string" - }, { - "name" : "transactionId", - "in" : "path", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/TransactionResultEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - }, - "503" : { - "description" : "NiFi instance is not ready for serving request, or temporarily overloaded. Retrying the same request later may be successful" - } - }, - "security" : [ { - "Write - /data-transfer/output-ports/{uuid}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "data-transfer" ], - "summary" : "Commit or cancel the specified transaction", - "description" : "", - "operationId" : "commitOutputPortTransaction", - "consumes" : [ "application/octet-stream" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "responseCode", - "in" : "query", - "description" : "The response code. Available values are CONFIRM_TRANSACTION(12) or CANCEL_TRANSACTION(15).", - "required" : true, - "type" : "integer", - "format" : "int32" - }, { - "name" : "checksum", - "in" : "query", - "description" : "A checksum calculated at client side using CRC32 to check flow file content integrity. It must match with the value calculated at server side.", - "required" : true, - "type" : "string" - }, { - "name" : "portId", - "in" : "path", - "description" : "The output port id.", - "required" : true, - "type" : "string" - }, { - "name" : "transactionId", - "in" : "path", - "description" : "The transaction id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/TransactionResultEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - }, - "503" : { - "description" : "NiFi instance is not ready for serving request, or temporarily overloaded. Retrying the same request later may be successful" - } - }, - "security" : [ { - "Write - /data-transfer/output-ports/{uuid}" : [ ] - } ] - } - }, - "/data-transfer/output-ports/{portId}/transactions/{transactionId}/flow-files" : { - "get" : { - "tags" : [ "data-transfer" ], - "summary" : "Transfer flow files from the output port", - "description" : "", - "operationId" : "transferFlowFiles", - "consumes" : [ "*/*" ], - "produces" : [ "application/octet-stream" ], - "parameters" : [ { - "name" : "portId", - "in" : "path", - "description" : "The output port id.", - "required" : true, - "type" : "string" - }, { - "name" : "transactionId", - "in" : "path", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "There is no flow file to return.", - "schema" : { - "$ref" : "#/definitions/StreamingOutput" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - }, - "503" : { - "description" : "NiFi instance is not ready for serving request, or temporarily overloaded. Retrying the same request later may be successful" - } - }, - "security" : [ { - "Write - /data-transfer/output-ports/{uuid}" : [ ] - } ] - } - }, - "/data-transfer/{portType}/{portId}/transactions" : { - "post" : { - "tags" : [ "data-transfer" ], - "summary" : "Create a transaction to the specified output port or input port", - "description" : "", - "operationId" : "createPortTransaction", - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "portType", - "in" : "path", - "description" : "The port type.", - "required" : true, - "type" : "string", - "enum" : [ "input-ports", "output-ports" ] - }, { - "name" : "portId", - "in" : "path", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/TransactionResultEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - }, - "503" : { - "description" : "NiFi instance is not ready for serving request, or temporarily overloaded. Retrying the same request later may be successful" - } - }, - "security" : [ { - "Write - /data-transfer/{component-type}/{uuid}" : [ ] - } ] - } - }, - "/flow/about" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Retrieves details about this NiFi to put in the About dialog", - "description" : "", - "operationId" : "getAboutInfo", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/AboutEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/banners" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Retrieves the banners for this NiFi", - "description" : "", - "operationId" : "getBanners", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/BannerEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/bulletin-board" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets current bulletins", - "description" : "", - "operationId" : "getBulletinBoard", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "after", - "in" : "query", - "description" : "Includes bulletins with an id after this value.", - "required" : false, - "type" : "string" - }, { - "name" : "sourceName", - "in" : "query", - "description" : "Includes bulletins originating from this sources whose name match this regular expression.", - "required" : false, - "type" : "string" - }, { - "name" : "message", - "in" : "query", - "description" : "Includes bulletins whose message that match this regular expression.", - "required" : false, - "type" : "string" - }, { - "name" : "sourceId", - "in" : "query", - "description" : "Includes bulletins originating from this sources whose id match this regular expression.", - "required" : false, - "type" : "string" - }, { - "name" : "groupId", - "in" : "query", - "description" : "Includes bulletins originating from this sources whose group id match this regular expression.", - "required" : false, - "type" : "string" - }, { - "name" : "limit", - "in" : "query", - "description" : "The number of bulletins to limit the response to.", - "required" : false, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/BulletinBoardEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - }, { - "Read - /{component-type}/{uuid} - For component specific bulletins" : [ ] - } ] - } - }, - "/flow/client-id" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Generates a client id.", - "description" : "", - "operationId" : "generateClientId", - "consumes" : [ "*/*" ], - "produces" : [ "text/plain" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/cluster/search-results" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Searches the cluster for a node with the specified address", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "searchCluster", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "q", - "in" : "query", - "description" : "Node address to search for.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ClusterSearchResultsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/cluster/summary" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "The cluster summary for this NiFi", - "description" : "", - "operationId" : "getClusterSummary", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ClusteSummaryEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/config" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Retrieves the configuration for this NiFi flow", - "description" : "", - "operationId" : "getFlowConfig", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/FlowConfigurationEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/connections/{id}/statistics" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets statistics for a connection", - "description" : "", - "operationId" : "getConnectionStatistics", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "nodewise", - "in" : "query", - "description" : "Whether or not to include the breakdown per node. Optional, defaults to false", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "clusterNodeId", - "in" : "query", - "description" : "The id of the node where to get the statistics.", - "required" : false, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The connection id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ConnectionStatisticsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/connections/{id}/status" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets status for a connection", - "description" : "", - "operationId" : "getConnectionStatus", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "nodewise", - "in" : "query", - "description" : "Whether or not to include the breakdown per node. Optional, defaults to false", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "clusterNodeId", - "in" : "query", - "description" : "The id of the node where to get the status.", - "required" : false, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The connection id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ConnectionStatusEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/connections/{id}/status/history" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets the status history for a connection", - "description" : "", - "operationId" : "getConnectionStatusHistory", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The connection id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/StatusHistoryEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/controller-service-types" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Retrieves the types of controller services that this NiFi supports", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getControllerServiceTypes", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "serviceType", - "in" : "query", - "description" : "If specified, will only return controller services that are compatible with this type of service.", - "required" : false, - "type" : "string" - }, { - "name" : "serviceBundleGroup", - "in" : "query", - "description" : "If serviceType specified, is the bundle group of the serviceType.", - "required" : false, - "type" : "string" - }, { - "name" : "serviceBundleArtifact", - "in" : "query", - "description" : "If serviceType specified, is the bundle artifact of the serviceType.", - "required" : false, - "type" : "string" - }, { - "name" : "serviceBundleVersion", - "in" : "query", - "description" : "If serviceType specified, is the bundle version of the serviceType.", - "required" : false, - "type" : "string" - }, { - "name" : "bundleGroupFilter", - "in" : "query", - "description" : "If specified, will only return types that are a member of this bundle group.", - "required" : false, - "type" : "string" - }, { - "name" : "bundleArtifactFilter", - "in" : "query", - "description" : "If specified, will only return types that are a member of this bundle artifact.", - "required" : false, - "type" : "string" - }, { - "name" : "typeFilter", - "in" : "query", - "description" : "If specified, will only return types whose fully qualified classname matches.", - "required" : false, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ControllerServiceTypesEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/controller/bulletins" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Retrieves Controller level bulletins", - "description" : "", - "operationId" : "getBulletins", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ControllerBulletinsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - }, { - "Read - /controller - For controller bulletins" : [ ] - }, { - "Read - /controller-services/{uuid} - For controller service bulletins" : [ ] - }, { - "Read - /reporting-tasks/{uuid} - For reporting task bulletins" : [ ] - } ] - } - }, - "/flow/controller/controller-services" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets controller services for reporting tasks", - "description" : "", - "operationId" : "getControllerServicesFromController", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ControllerServicesEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/current-user" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Retrieves the user identity of the user making the request", - "description" : "", - "operationId" : "getCurrentUser", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/CurrentUserEntity" - } - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/history" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets configuration history", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "queryHistory", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "offset", - "in" : "query", - "description" : "The offset into the result set.", - "required" : true, - "type" : "string" - }, { - "name" : "count", - "in" : "query", - "description" : "The number of actions to return.", - "required" : true, - "type" : "string" - }, { - "name" : "sortColumn", - "in" : "query", - "description" : "The field to sort on.", - "required" : false, - "type" : "string" - }, { - "name" : "sortOrder", - "in" : "query", - "description" : "The direction to sort.", - "required" : false, - "type" : "string" - }, { - "name" : "startDate", - "in" : "query", - "description" : "Include actions after this date.", - "required" : false, - "type" : "string" - }, { - "name" : "endDate", - "in" : "query", - "description" : "Include actions before this date.", - "required" : false, - "type" : "string" - }, { - "name" : "userIdentity", - "in" : "query", - "description" : "Include actions performed by this user.", - "required" : false, - "type" : "string" - }, { - "name" : "sourceId", - "in" : "query", - "description" : "Include actions on this component.", - "required" : false, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/HistoryEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/history/components/{componentId}" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets configuration history for a component", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getComponentHistory", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "componentId", - "in" : "path", - "description" : "The component id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ComponentHistoryEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - }, { - "Read underlying component - /{component-type}/{uuid}" : [ ] - } ] - } - }, - "/flow/history/{id}" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets an action", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getAction", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The action id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ActionEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/input-ports/{id}/status" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets status for an input port", - "description" : "", - "operationId" : "getInputPortStatus", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "nodewise", - "in" : "query", - "description" : "Whether or not to include the breakdown per node. Optional, defaults to false", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "clusterNodeId", - "in" : "query", - "description" : "The id of the node where to get the status.", - "required" : false, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The input port id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/PortStatusEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/output-ports/{id}/status" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets status for an output port", - "description" : "", - "operationId" : "getOutputPortStatus", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "nodewise", - "in" : "query", - "description" : "Whether or not to include the breakdown per node. Optional, defaults to false", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "clusterNodeId", - "in" : "query", - "description" : "The id of the node where to get the status.", - "required" : false, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The output port id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/PortStatusEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/parameter-contexts" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets all Parameter Contexts", - "description" : "", - "operationId" : "getParameterContexts", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ParameterContextsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /parameter-contexts/{id} for each Parameter Context" : [ ] - } ] - } - }, - "/flow/prioritizers" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Retrieves the types of prioritizers that this NiFi supports", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getPrioritizers", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/PrioritizerTypesEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/process-groups/{id}" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets a process group", - "description" : "", - "operationId" : "getFlow", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessGroupFlowEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - }, - "put" : { - "tags" : [ "flow" ], - "summary" : "Schedule or unschedule components in the specified Process Group.", - "description" : "", - "operationId" : "scheduleComponents", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The request to schedule or unschedule. If the comopnents in the request are not specified, all authorized components will be considered.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ScheduleComponentsEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ScheduleComponentsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - }, { - "Write - /{component-type}/{uuid} or /operation/{component-type}/{uuid} - For every component being scheduled/unscheduled" : [ ] - } ] - } - }, - "/flow/process-groups/{id}/controller-services" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets all controller services", - "description" : "", - "operationId" : "getControllerServicesFromGroup", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "name" : "includeAncestorGroups", - "in" : "query", - "description" : "Whether or not to include parent/ancestory process groups", - "required" : false, - "type" : "boolean", - "default" : true - }, { - "name" : "includeDescendantGroups", - "in" : "query", - "description" : "Whether or not to include descendant process groups", - "required" : false, - "type" : "boolean", - "default" : false - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ControllerServicesEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - }, - "put" : { - "tags" : [ "flow" ], - "summary" : "Enable or disable Controller Services in the specified Process Group.", - "description" : "", - "operationId" : "activateControllerServices", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The request to schedule or unschedule. If the comopnents in the request are not specified, all authorized components will be considered.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ActivateControllerServicesEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ActivateControllerServicesEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - }, { - "Write - /{component-type}/{uuid} or /operation/{component-type}/{uuid} - For every service being enabled/disabled" : [ ] - } ] - } - }, - "/flow/process-groups/{id}/status" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets the status for a process group", - "description" : "The status for a process group includes status for all descendent components. When invoked on the root group with recursive set to true, it will return the current status of every component in the flow.", - "operationId" : "getProcessGroupStatus", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "recursive", - "in" : "query", - "description" : "Whether all descendant groups and the status of their content will be included. Optional, defaults to false", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "nodewise", - "in" : "query", - "description" : "Whether or not to include the breakdown per node. Optional, defaults to false", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "clusterNodeId", - "in" : "query", - "description" : "The id of the node where to get the status.", - "required" : false, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessGroupStatusEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/process-groups/{id}/status/history" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets status history for a remote process group", - "description" : "", - "operationId" : "getProcessGroupStatusHistory", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/StatusHistoryEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/processor-types" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Retrieves the types of processors that this NiFi supports", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getProcessorTypes", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bundleGroupFilter", - "in" : "query", - "description" : "If specified, will only return types that are a member of this bundle group.", - "required" : false, - "type" : "string" - }, { - "name" : "bundleArtifactFilter", - "in" : "query", - "description" : "If specified, will only return types that are a member of this bundle artifact.", - "required" : false, - "type" : "string" - }, { - "name" : "type", - "in" : "query", - "description" : "If specified, will only return types whose fully qualified classname matches.", - "required" : false, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessorTypesEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/processors/{id}/status" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets status for a processor", - "description" : "", - "operationId" : "getProcessorStatus", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "nodewise", - "in" : "query", - "description" : "Whether or not to include the breakdown per node. Optional, defaults to false", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "clusterNodeId", - "in" : "query", - "description" : "The id of the node where to get the status.", - "required" : false, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The processor id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessorStatusEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/processors/{id}/status/history" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets status history for a processor", - "description" : "", - "operationId" : "getProcessorStatusHistory", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The processor id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/StatusHistoryEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/registries" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets the listing of available registries", - "description" : "", - "operationId" : "getRegistries", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/RegistryClientsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/registries/{id}/buckets" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets the buckets from the specified registry for the current user", - "description" : "", - "operationId" : "getBuckets", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The registry id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/BucketsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/registries/{registry-id}/buckets/{bucket-id}/flows" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets the flows from the specified registry and bucket for the current user", - "description" : "", - "operationId" : "getFlows", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "registry-id", - "in" : "path", - "description" : "The registry id.", - "required" : true, - "type" : "string" - }, { - "name" : "bucket-id", - "in" : "path", - "description" : "The bucket id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlowsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/registries/{registry-id}/buckets/{bucket-id}/flows/{flow-id}/versions" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets the flow versions from the specified registry and bucket for the specified flow for the current user", - "description" : "", - "operationId" : "getVersions", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "registry-id", - "in" : "path", - "description" : "The registry id.", - "required" : true, - "type" : "string" - }, { - "name" : "bucket-id", - "in" : "path", - "description" : "The bucket id.", - "required" : true, - "type" : "string" - }, { - "name" : "flow-id", - "in" : "path", - "description" : "The flow id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlowSnapshotMetadataSetEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/remote-process-groups/{id}/status" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets status for a remote process group", - "description" : "", - "operationId" : "getRemoteProcessGroupStatus", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "nodewise", - "in" : "query", - "description" : "Whether or not to include the breakdown per node. Optional, defaults to false", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "clusterNodeId", - "in" : "query", - "description" : "The id of the node where to get the status.", - "required" : false, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The remote process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/RemoteProcessGroupStatusEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/remote-process-groups/{id}/status/history" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets the status history", - "description" : "", - "operationId" : "getRemoteProcessGroupStatusHistory", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The remote process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/StatusHistoryEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/reporting-task-types" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Retrieves the types of reporting tasks that this NiFi supports", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getReportingTaskTypes", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bundleGroupFilter", - "in" : "query", - "description" : "If specified, will only return types that are a member of this bundle group.", - "required" : false, - "type" : "string" - }, { - "name" : "bundleArtifactFilter", - "in" : "query", - "description" : "If specified, will only return types that are a member of this bundle artifact.", - "required" : false, - "type" : "string" - }, { - "name" : "type", - "in" : "query", - "description" : "If specified, will only return types whose fully qualified classname matches.", - "required" : false, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ReportingTaskTypesEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/reporting-tasks" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets all reporting tasks", - "description" : "", - "operationId" : "getReportingTasks", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ReportingTasksEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/search-results" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Performs a search against this NiFi using the specified search term", - "description" : "Only search results from authorized components will be returned.", - "operationId" : "searchFlow", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "q", - "in" : "query", - "required" : false, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/SearchResultsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/status" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets the current status of this NiFi", - "description" : "", - "operationId" : "getControllerStatus", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ControllerStatusEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/templates" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets all templates", - "description" : "", - "operationId" : "getTemplates", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/TemplatesEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flowfile-queues/{id}/drop-requests" : { - "post" : { - "tags" : [ "flowfile-queues" ], - "summary" : "Creates a request to drop the contents of the queue in this connection.", - "description" : "", - "operationId" : "createDropRequest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The connection id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/DropRequestEntity" - } - }, - "202" : { - "description" : "The request has been accepted. A HTTP response header will contain the URI where the response can be polled." - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write Source Data - /data/{component-type}/{uuid}" : [ ] - } ] - } - }, - "/flowfile-queues/{id}/drop-requests/{drop-request-id}" : { - "get" : { - "tags" : [ "flowfile-queues" ], - "summary" : "Gets the current status of a drop request for the specified connection.", - "description" : "", - "operationId" : "getDropRequest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The connection id.", - "required" : true, - "type" : "string" - }, { - "name" : "drop-request-id", - "in" : "path", - "description" : "The drop request id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/DropRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write Source Data - /data/{component-type}/{uuid}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "flowfile-queues" ], - "summary" : "Cancels and/or removes a request to drop the contents of this connection.", - "description" : "", - "operationId" : "removeDropRequest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The connection id.", - "required" : true, - "type" : "string" - }, { - "name" : "drop-request-id", - "in" : "path", - "description" : "The drop request id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/DropRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write Source Data - /data/{component-type}/{uuid}" : [ ] - } ] - } - }, - "/flowfile-queues/{id}/flowfiles/{flowfile-uuid}" : { - "get" : { - "tags" : [ "flowfile-queues" ], - "summary" : "Gets a FlowFile from a Connection.", - "description" : "", - "operationId" : "getFlowFile", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The connection id.", - "required" : true, - "type" : "string" - }, { - "name" : "flowfile-uuid", - "in" : "path", - "description" : "The flowfile uuid.", - "required" : true, - "type" : "string" - }, { - "name" : "clusterNodeId", - "in" : "query", - "description" : "The id of the node where the content exists if clustered.", - "required" : false, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/FlowFileEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read Source Data - /data/{component-type}/{uuid}" : [ ] - } ] - } - }, - "/flowfile-queues/{id}/flowfiles/{flowfile-uuid}/content" : { - "get" : { - "tags" : [ "flowfile-queues" ], - "summary" : "Gets the content for a FlowFile in a Connection.", - "description" : "", - "operationId" : "downloadFlowFileContent", - "consumes" : [ "*/*" ], - "produces" : [ "*/*" ], - "parameters" : [ { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The connection id.", - "required" : true, - "type" : "string" - }, { - "name" : "flowfile-uuid", - "in" : "path", - "description" : "The flowfile uuid.", - "required" : true, - "type" : "string" - }, { - "name" : "clusterNodeId", - "in" : "query", - "description" : "The id of the node where the content exists if clustered.", - "required" : false, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/StreamingOutput" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read Source Data - /data/{component-type}/{uuid}" : [ ] - } ] - } - }, - "/flowfile-queues/{id}/listing-requests" : { - "post" : { - "tags" : [ "flowfile-queues" ], - "summary" : "Lists the contents of the queue in this connection.", - "description" : "", - "operationId" : "createFlowFileListing", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The connection id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ListingRequestEntity" - } - }, - "202" : { - "description" : "The request has been accepted. A HTTP response header will contain the URI where the response can be polled." - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read Source Data - /data/{component-type}/{uuid}" : [ ] - } ] - } - }, - "/flowfile-queues/{id}/listing-requests/{listing-request-id}" : { - "get" : { - "tags" : [ "flowfile-queues" ], - "summary" : "Gets the current status of a listing request for the specified connection.", - "description" : "", - "operationId" : "getListingRequest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The connection id.", - "required" : true, - "type" : "string" - }, { - "name" : "listing-request-id", - "in" : "path", - "description" : "The listing request id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ListingRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read Source Data - /data/{component-type}/{uuid}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "flowfile-queues" ], - "summary" : "Cancels and/or removes a request to list the contents of this connection.", - "description" : "", - "operationId" : "deleteListingRequest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The connection id.", - "required" : true, - "type" : "string" - }, { - "name" : "listing-request-id", - "in" : "path", - "description" : "The listing request id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ListingRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read Source Data - /data/{component-type}/{uuid}" : [ ] - } ] - } - }, - "/funnels/{id}" : { - "get" : { - "tags" : [ "funnel" ], - "summary" : "Gets a funnel", - "description" : "", - "operationId" : "getFunnel", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The funnel id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/FunnelEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /funnels/{uuid}" : [ ] - } ] - }, - "put" : { - "tags" : [ "funnel" ], - "summary" : "Updates a funnel", - "description" : "", - "operationId" : "updateFunnel", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The funnel id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The funnel configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/FunnelEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/FunnelEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /funnels/{uuid}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "funnel" ], - "summary" : "Deletes a funnel", - "description" : "", - "operationId" : "removeFunnel", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The revision is used to verify the client is working with the latest version of the flow.", - "required" : false, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The funnel id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/FunnelEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /funnels/{uuid}" : [ ] - }, { - "Write - Parent Process Group - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/input-ports/{id}" : { - "get" : { - "tags" : [ "input-ports" ], - "summary" : "Gets an input port", - "description" : "", - "operationId" : "getInputPort", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The input port id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/PortEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /input-ports/{uuid}" : [ ] - } ] - }, - "put" : { - "tags" : [ "input-ports" ], - "summary" : "Updates an input port", - "description" : "", - "operationId" : "updateInputPort", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The input port id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The input port configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/PortEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/PortEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /input-ports/{uuid}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "input-ports" ], - "summary" : "Deletes an input port", - "description" : "", - "operationId" : "removeInputPort", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The revision is used to verify the client is working with the latest version of the flow.", - "required" : false, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The input port id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/PortEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /input-ports/{uuid}" : [ ] - }, { - "Write - Parent Process Group - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/input-ports/{id}/run-status" : { - "put" : { - "tags" : [ "input-ports" ], - "summary" : "Updates run status of an input-port", - "description" : "", - "operationId" : "updateRunStatus", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The port id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The port run status.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/PortRunStatusEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessorEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /input-ports/{uuid} or /operation/input-ports/{uuid}" : [ ] - } ] - } - }, - "/labels/{id}" : { - "get" : { - "tags" : [ "labels" ], - "summary" : "Gets a label", - "description" : "", - "operationId" : "getLabel", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The label id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/LabelEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /labels/{uuid}" : [ ] - } ] - }, - "put" : { - "tags" : [ "labels" ], - "summary" : "Updates a label", - "description" : "", - "operationId" : "updateLabel", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The label id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The label configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/LabelEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/LabelEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /labels/{uuid}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "labels" ], - "summary" : "Deletes a label", - "description" : "", - "operationId" : "removeLabel", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The revision is used to verify the client is working with the latest version of the flow.", - "required" : false, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The label id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/LabelEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /labels/{uuid}" : [ ] - }, { - "Write - Parent Process Group - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/output-ports/{id}" : { - "get" : { - "tags" : [ "output-ports" ], - "summary" : "Gets an output port", - "description" : "", - "operationId" : "getOutputPort", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The output port id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/PortEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /output-ports/{uuid}" : [ ] - } ] - }, - "put" : { - "tags" : [ "output-ports" ], - "summary" : "Updates an output port", - "description" : "", - "operationId" : "updateOutputPort", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The output port id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The output port configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/PortEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/PortEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /output-ports/{uuid}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "output-ports" ], - "summary" : "Deletes an output port", - "description" : "", - "operationId" : "removeOutputPort", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The revision is used to verify the client is working with the latest version of the flow.", - "required" : false, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The output port id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/PortEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /output-ports/{uuid}" : [ ] - }, { - "Write - Parent Process Group - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/output-ports/{id}/run-status" : { - "put" : { - "tags" : [ "output-ports" ], - "summary" : "Updates run status of an output-port", - "description" : "", - "operationId" : "updateRunStatus", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The port id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The port run status.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/PortRunStatusEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessorEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /output-ports/{uuid} or /operation/output-ports/{uuid}" : [ ] - } ] - } - }, - "/parameter-contexts" : { - "post" : { - "tags" : [ "parameter-contexts" ], - "summary" : "Create a Parameter Context", - "description" : "", - "operationId" : "createParameterContext", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The Parameter Context.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ParameterContextEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ParameterContextEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /parameter-contexts" : [ ] - } ] - } - }, - "/parameter-contexts/{contextId}/update-requests" : { - "post" : { - "tags" : [ "parameter-contexts" ], - "summary" : "Initiate the Update Request of a Parameter Context", - "description" : "This will initiate the process of updating a Parameter Context. Changing the value of a Parameter may require that one or more components be stopped and restarted, so this acttion may take significantly more time than many other REST API actions. As a result, this endpoint will immediately return a ParameterContextUpdateRequestEntity, and the process of updating the necessary components will occur asynchronously in the background. The client may then periodically poll the status of the request by issuing a GET request to /parameter-contexts/update-requests/{requestId}. Once the request is completed, the client is expected to issue a DELETE request to /parameter-contexts/update-requests/{requestId}.", - "operationId" : "submitParameterContextUpdate", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "contextId", - "in" : "path", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The updated version of the parameter context.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ParameterContextEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ParameterContextUpdateRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /parameter-contexts/{parameterContextId}" : [ ] - }, { - "Write - /parameter-contexts/{parameterContextId}" : [ ] - }, { - "Read - for every component that is affected by the update" : [ ] - }, { - "Write - for every component that is affected by the update" : [ ] - } ] - } - }, - "/parameter-contexts/{contextId}/update-requests/{requestId}" : { - "get" : { - "tags" : [ "parameter-contexts" ], - "summary" : "Returns the Update Request with the given ID", - "description" : "Returns the Update Request with the given ID. Once an Update Request has been created by performing a POST to /nifi-api/parameter-contexts, that request can subsequently be retrieved via this endpoint, and the request that is fetched will contain the updated state, such as percent complete, the current state of the request, and any failures. ", - "operationId" : "getParameterContextUpdate", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "contextId", - "in" : "path", - "description" : "The ID of the Parameter Context", - "required" : true, - "type" : "string" - }, { - "name" : "requestId", - "in" : "path", - "description" : "The ID of the Update Request", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ParameterContextUpdateRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Only the user that submitted the request can get it" : [ ] - } ] - }, - "delete" : { - "tags" : [ "parameter-contexts" ], - "summary" : "Deletes the Update Request with the given ID", - "description" : "Deletes the Update Request with the given ID. After a request is created via a POST to /nifi-api/parameter-contexts/update-requests, it is expected that the client will properly clean up the request by DELETE'ing it, once the Update process has completed. If the request is deleted before the request completes, then the Update request will finish the step that it is currently performing and then will cancel any subsequent steps.", - "operationId" : "deleteUpdateRequest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "contextId", - "in" : "path", - "description" : "The ID of the ParameterContext", - "required" : true, - "type" : "string" - }, { - "name" : "requestId", - "in" : "path", - "description" : "The ID of the Update Request", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ParameterContextUpdateRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Only the user that submitted the request can remove it" : [ ] - } ] - } - }, - "/parameter-contexts/{contextId}/validation-requests" : { - "post" : { - "tags" : [ "parameter-contexts" ], - "summary" : "Initiate a Validation Request to determine how the validity of components will change if a Parameter Context were to be updated", - "description" : "This will initiate the process of validating all components whose Process Group is bound to the specified Parameter Context. Performing validation against an arbitrary number of components may be expect and take significantly more time than many other REST API actions. As a result, this endpoint will immediately return a ParameterContextValidationRequestEntity, and the process of validating the necessary components will occur asynchronously in the background. The client may then periodically poll the status of the request by issuing a GET request to /parameter-contexts/validation-requests/{requestId}. Once the request is completed, the client is expected to issue a DELETE request to /parameter-contexts/validation-requests/{requestId}.", - "operationId" : "submitValidationRequest", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "contextId", - "in" : "path", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The validation request", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ParameterContextValidationRequestEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ParameterContextValidationRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /parameter-contexts/{parameterContextId}" : [ ] - } ] - } - }, - "/parameter-contexts/{contextId}/validation-requests/{id}" : { - "get" : { - "tags" : [ "parameter-contexts" ], - "summary" : "Returns the Validation Request with the given ID", - "description" : "Returns the Validation Request with the given ID. Once a Validation Request has been created by performing a POST to /nifi-api/validation-contexts, that request can subsequently be retrieved via this endpoint, and the request that is fetched will contain the updated state, such as percent complete, the current state of the request, and any failures. ", - "operationId" : "getValidationRequest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "contextId", - "in" : "path", - "description" : "The ID of the Parameter Context", - "required" : true, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The ID of the Validation Request", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ParameterContextValidationRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Only the user that submitted the request can get it" : [ ] - } ] - }, - "delete" : { - "tags" : [ "parameter-contexts" ], - "summary" : "Deletes the Validation Request with the given ID", - "description" : "Deletes the Validation Request with the given ID. After a request is created via a POST to /nifi-api/validation-contexts, it is expected that the client will properly clean up the request by DELETE'ing it, once the validation process has completed. If the request is deleted before the request completes, then the Validation request will finish the step that it is currently performing and then will cancel any subsequent steps.", - "operationId" : "deleteValidationRequest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "contextId", - "in" : "path", - "description" : "The ID of the Parameter Context", - "required" : true, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The ID of the Update Request", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ParameterContextValidationRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Only the user that submitted the request can remove it" : [ ] - } ] - } - }, - "/parameter-contexts/{id}" : { - "get" : { - "tags" : [ "parameter-contexts" ], - "summary" : "Returns the Parameter Context with the given ID", - "description" : "Returns the Parameter Context with the given ID.", - "operationId" : "getParameterContext", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The ID of the Parameter Context", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ParameterContextEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /parameter-contexts/{id}" : [ ] - } ] - }, - "put" : { - "tags" : [ "parameter-contexts" ], - "summary" : "Modifies a Parameter Context", - "description" : "This endpoint will update a Parameter Context to match the provided entity. However, this request will fail if any component is running and is referencing a Parameter in the Parameter Context. Generally, this endpoint is not called directly. Instead, an update request should be submitted by making a POST to the /parameter-contexts/update-requests endpoint. That endpoint will, in turn, call this endpoint.", - "operationId" : "updateParameterContext", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The updated Parameter Context", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ParameterContextEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ParameterContextEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /parameter-contexts/{id}" : [ ] - }, { - "Write - /parameter-contexts/{id}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "parameter-contexts" ], - "summary" : "Deletes the Parameter Context with the given ID", - "description" : "Deletes the Parameter Context with the given ID.", - "operationId" : "deleteParameterContext", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The version is used to verify the client is working with the latest version of the flow.", - "required" : false, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, a new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The Parameter Context ID.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ParameterContextEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /parameter-contexts/{uuid}" : [ ] - }, { - "Write - /parameter-contexts/{uuid}" : [ ] - }, { - "Read - /process-groups/{uuid}, for any Process Group that is currently bound to the Parameter Context" : [ ] - }, { - "Write - /process-groups/{uuid}, for any Process Group that is currently bound to the Parameter Context" : [ ] - } ] - } - }, - "/policies" : { - "post" : { - "tags" : [ "policies" ], - "summary" : "Creates an access policy", - "description" : "", - "operationId" : "createAccessPolicy", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The access policy configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/AccessPolicyEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/AccessPolicyEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /policies/{resource}" : [ ] - } ] - } - }, - "/policies/{action}/{resource}" : { - "get" : { - "tags" : [ "policies" ], - "summary" : "Gets an access policy for the specified action and resource", - "description" : "Will return the effective policy if no component specific policy exists for the specified action and resource. Must have Read permissions to the policy with the desired action and resource. Permissions for the policy that is returned will be indicated in the response. This means the client could be authorized to get the policy for a given component but the effective policy may be inherited from an ancestor Process Group. If the client does not have permissions to that policy, the response will not include the policy and the permissions in the response will be marked accordingly. If the client does not have permissions to the policy of the desired action and resource a 403 response will be returned.", - "operationId" : "getAccessPolicyForResource", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "action", - "in" : "path", - "description" : "The request action.", - "required" : true, - "type" : "string", - "enum" : [ "read", "write" ] - }, { - "name" : "resource", - "in" : "path", - "description" : "The resource of the policy.", - "required" : true, - "type" : "string", - "pattern" : ".+" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/AccessPolicyEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /policies/{resource}" : [ ] - } ] - } - }, - "/policies/{id}" : { - "get" : { - "tags" : [ "policies" ], - "summary" : "Gets an access policy", - "description" : "", - "operationId" : "getAccessPolicy", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The access policy id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/AccessPolicyEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /policies/{resource}" : [ ] - } ] - }, - "put" : { - "tags" : [ "policies" ], - "summary" : "Updates a access policy", - "description" : "", - "operationId" : "updateAccessPolicy", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The access policy id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The access policy configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/AccessPolicyEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/AccessPolicyEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /policies/{resource}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "policies" ], - "summary" : "Deletes an access policy", - "description" : "", - "operationId" : "removeAccessPolicy", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The revision is used to verify the client is working with the latest version of the flow.", - "required" : false, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The access policy id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/AccessPolicyEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /policies/{resource}" : [ ] - }, { - "Write - Policy of the parent resource - /policies/{resource}" : [ ] - } ] - } - }, - "/process-groups/{groupId}/variable-registry/update-requests/{updateId}" : { - "get" : { - "tags" : [ "process-groups" ], - "summary" : "Gets a process group's variable registry", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getVariableRegistryUpdateRequest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "groupId", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "name" : "updateId", - "in" : "path", - "description" : "The ID of the Variable Registry Update Request", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VariableRegistryUpdateRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "process-groups" ], - "summary" : "Deletes an update request for a process group's variable registry. If the request is not yet complete, it will automatically be cancelled.", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "deleteVariableRegistryUpdateRequest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "groupId", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "name" : "updateId", - "in" : "path", - "description" : "The ID of the Variable Registry Update Request", - "required" : true, - "type" : "string" - }, { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VariableRegistryUpdateRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/process-groups/{id}" : { - "get" : { - "tags" : [ "process-groups" ], - "summary" : "Gets a process group", - "description" : "", - "operationId" : "getProcessGroup", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessGroupEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - } ] - }, - "put" : { - "tags" : [ "process-groups" ], - "summary" : "Updates a process group", - "description" : "", - "operationId" : "updateProcessGroup", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The process group configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ProcessGroupEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessGroupEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "process-groups" ], - "summary" : "Deletes a process group", - "description" : "", - "operationId" : "removeProcessGroup", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The revision is used to verify the client is working with the latest version of the flow.", - "required" : false, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessGroupEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - }, { - "Write - Parent Process Group - /process-groups/{uuid}" : [ ] - }, { - "Read - any referenced Controller Services by any encapsulated components - /controller-services/{uuid}" : [ ] - }, { - "Write - /{component-type}/{uuid} - For all encapsulated components" : [ ] - } ] - } - }, - "/process-groups/{id}/connections" : { - "get" : { - "tags" : [ "process-groups" ], - "summary" : "Gets all connections", - "description" : "", - "operationId" : "getConnections", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ConnectionsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - } ] - }, - "post" : { - "tags" : [ "process-groups" ], - "summary" : "Creates a connection", - "description" : "", - "operationId" : "createConnection", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The connection configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ConnectionEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ConnectionEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - }, { - "Write Source - /{component-type}/{uuid}" : [ ] - }, { - "Write Destination - /{component-type}/{uuid}" : [ ] - } ] - } - }, - "/process-groups/{id}/controller-services" : { - "post" : { - "tags" : [ "process-groups" ], - "summary" : "Creates a new controller service", - "description" : "", - "operationId" : "createControllerService", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The controller service configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ControllerServiceEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ControllerServiceEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - }, { - "Read - any referenced Controller Services - /controller-services/{uuid}" : [ ] - }, { - "Write - if the Controller Service is restricted - /restricted-components" : [ ] - } ] - } - }, - "/process-groups/{id}/funnels" : { - "get" : { - "tags" : [ "process-groups" ], - "summary" : "Gets all funnels", - "description" : "", - "operationId" : "getFunnels", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/FunnelsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - } ] - }, - "post" : { - "tags" : [ "process-groups" ], - "summary" : "Creates a funnel", - "description" : "", - "operationId" : "createFunnel", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The funnel configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/FunnelEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/FunnelEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/process-groups/{id}/input-ports" : { - "get" : { - "tags" : [ "process-groups" ], - "summary" : "Gets all input ports", - "description" : "", - "operationId" : "getInputPorts", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/InputPortsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - } ] - }, - "post" : { - "tags" : [ "process-groups" ], - "summary" : "Creates an input port", - "description" : "", - "operationId" : "createInputPort", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The input port configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/PortEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/PortEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/process-groups/{id}/labels" : { - "get" : { - "tags" : [ "process-groups" ], - "summary" : "Gets all labels", - "description" : "", - "operationId" : "getLabels", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/LabelsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - } ] - }, - "post" : { - "tags" : [ "process-groups" ], - "summary" : "Creates a label", - "description" : "", - "operationId" : "createLabel", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The label configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/LabelEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/LabelEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/process-groups/{id}/local-modifications" : { - "get" : { - "tags" : [ "process-groups" ], - "summary" : "Gets a list of local modifications to the Process Group since it was last synchronized with the Flow Registry", - "description" : "", - "operationId" : "getLocalModifications", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/FlowComparisonEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - }, { - "Read - /{component-type}/{uuid} - For all encapsulated components" : [ ] - } ] - } - }, - "/process-groups/{id}/output-ports" : { - "get" : { - "tags" : [ "process-groups" ], - "summary" : "Gets all output ports", - "description" : "", - "operationId" : "getOutputPorts", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/OutputPortsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - } ] - }, - "post" : { - "tags" : [ "process-groups" ], - "summary" : "Creates an output port", - "description" : "", - "operationId" : "createOutputPort", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The output port configuration.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/PortEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/PortEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/process-groups/{id}/process-groups" : { - "get" : { - "tags" : [ "process-groups" ], - "summary" : "Gets all process groups", - "description" : "", - "operationId" : "getProcessGroups", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessGroupsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - } ] - }, - "post" : { - "tags" : [ "process-groups" ], - "summary" : "Creates a process group", - "description" : "", - "operationId" : "createProcessGroup", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The process group configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ProcessGroupEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessGroupEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/process-groups/{id}/processors" : { - "get" : { - "tags" : [ "process-groups" ], - "summary" : "Gets all processors", - "description" : "", - "operationId" : "getProcessors", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "name" : "includeDescendantGroups", - "in" : "query", - "description" : "Whether or not to include processors from descendant process groups", - "required" : false, - "type" : "boolean", - "default" : false - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessorsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - } ] - }, - "post" : { - "tags" : [ "process-groups" ], - "summary" : "Creates a new processor", - "description" : "", - "operationId" : "createProcessor", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The processor configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ProcessorEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessorEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - }, { - "Read - any referenced Controller Services - /controller-services/{uuid}" : [ ] - }, { - "Write - if the Processor is restricted - /restricted-components" : [ ] - } ] - } - }, - "/process-groups/{id}/remote-process-groups" : { - "get" : { - "tags" : [ "process-groups" ], - "summary" : "Gets all remote process groups", - "description" : "", - "operationId" : "getRemoteProcessGroups", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/RemoteProcessGroupsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - } ] - }, - "post" : { - "tags" : [ "process-groups" ], - "summary" : "Creates a new process group", - "description" : "", - "operationId" : "createRemoteProcessGroup", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The remote process group configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/RemoteProcessGroupEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/RemoteProcessGroupEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/process-groups/{id}/snippet-instance" : { - "post" : { - "tags" : [ "process-groups" ], - "summary" : "Copies a snippet and discards it.", - "description" : "", - "operationId" : "copySnippet", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The copy snippet request.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/CopySnippetRequestEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/FlowEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - }, { - "Read - /{component-type}/{uuid} - For each component in the snippet and their descendant components" : [ ] - }, { - "Write - if the snippet contains any restricted Processors - /restricted-components" : [ ] - } ] - } - }, - "/process-groups/{id}/template-instance" : { - "post" : { - "tags" : [ "process-groups" ], - "summary" : "Instantiates a template", - "description" : "", - "operationId" : "instantiateTemplate", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The instantiate template request.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/InstantiateTemplateRequestEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/FlowEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - }, { - "Read - /templates/{uuid}" : [ ] - }, { - "Write - if the template contains any restricted components - /restricted-components" : [ ] - } ] - } - }, - "/process-groups/{id}/templates" : { - "post" : { - "tags" : [ "process-groups" ], - "summary" : "Creates a template and discards the specified snippet.", - "description" : "", - "operationId" : "createTemplate", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The create template request.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/CreateTemplateRequestEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/TemplateEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - }, { - "Read - /{component-type}/{uuid} - For each component in the snippet and their descendant components" : [ ] - } ] - } - }, - "/process-groups/{id}/templates/import" : { - "post" : { - "tags" : [ "process-groups" ], - "summary" : "Imports a template", - "description" : "", - "operationId" : "importTemplate", - "consumes" : [ "application/xml" ], - "produces" : [ "application/xml" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/TemplateEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/process-groups/{id}/templates/upload" : { - "post" : { - "tags" : [ "process-groups" ], - "summary" : "Uploads a template", - "description" : "", - "operationId" : "uploadTemplate", - "consumes" : [ "multipart/form-data" ], - "produces" : [ "application/xml" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "schema" : { - "type" : "boolean" - } - }, { - "name" : "template", - "in" : "formData", - "description" : "The binary content of the template file being uploaded.", - "required" : true, - "type" : "file" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/TemplateEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/process-groups/{id}/variable-registry" : { - "get" : { - "tags" : [ "process-groups" ], - "summary" : "Gets a process group's variable registry", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getVariableRegistry", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "name" : "includeAncestorGroups", - "in" : "query", - "description" : "Whether or not to include ancestor groups", - "required" : false, - "type" : "boolean", - "default" : true - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VariableRegistryEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - } ] - }, - "put" : { - "tags" : [ "process-groups" ], - "summary" : "Updates the contents of a Process Group's variable Registry", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "updateVariableRegistry", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The variable registry configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/VariableRegistryEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VariableRegistryEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/process-groups/{id}/variable-registry/update-requests" : { - "post" : { - "tags" : [ "process-groups" ], - "summary" : "Submits a request to update a process group's variable registry", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "submitUpdateVariableRegistryRequest", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The variable registry configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/VariableRegistryEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VariableRegistryUpdateRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/processors/{id}" : { - "get" : { - "tags" : [ "processors" ], - "summary" : "Gets a processor", - "description" : "", - "operationId" : "getProcessor", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The processor id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessorEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /processors/{uuid}" : [ ] - } ] - }, - "put" : { - "tags" : [ "processors" ], - "summary" : "Updates a processor", - "description" : "", - "operationId" : "updateProcessor", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The processor id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The processor configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ProcessorEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessorEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /processors/{uuid}" : [ ] - }, { - "Read - any referenced Controller Services if this request changes the reference - /controller-services/{uuid}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "processors" ], - "summary" : "Deletes a processor", - "description" : "", - "operationId" : "deleteProcessor", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The revision is used to verify the client is working with the latest version of the flow.", - "required" : false, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The processor id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessorEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /processors/{uuid}" : [ ] - }, { - "Write - Parent Process Group - /process-groups/{uuid}" : [ ] - }, { - "Read - any referenced Controller Services - /controller-services/{uuid}" : [ ] - } ] - } - }, - "/processors/{id}/descriptors" : { - "get" : { - "tags" : [ "processors" ], - "summary" : "Gets the descriptor for a processor property", - "description" : "", - "operationId" : "getPropertyDescriptor", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The processor id.", - "required" : true, - "type" : "string" - }, { - "name" : "propertyName", - "in" : "query", - "description" : "The property name.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/PropertyDescriptorEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /processors/{uuid}" : [ ] - } ] - } - }, - "/processors/{id}/diagnostics" : { - "get" : { - "tags" : [ "processors" ], - "summary" : "Gets diagnostics information about a processor", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getProcessorDiagnostics", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The processor id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessorEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /processors/{uuid}" : [ ] - } ] - } - }, - "/processors/{id}/run-status" : { - "put" : { - "tags" : [ "processors" ], - "summary" : "Updates run status of a processor", - "description" : "", - "operationId" : "updateRunStatus", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The processor id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The processor run status.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ProcessorRunStatusEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessorEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /processors/{uuid} or /operation/processors/{uuid}" : [ ] - } ] - } - }, - "/processors/{id}/state" : { - "get" : { - "tags" : [ "processors" ], - "summary" : "Gets the state for a processor", - "description" : "", - "operationId" : "getState", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The processor id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ComponentStateEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /processors/{uuid}" : [ ] - } ] - } - }, - "/processors/{id}/state/clear-requests" : { - "post" : { - "tags" : [ "processors" ], - "summary" : "Clears the state for a processor", - "description" : "", - "operationId" : "clearState", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The processor id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ComponentStateEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /processors/{uuid}" : [ ] - } ] - } - }, - "/processors/{id}/threads" : { - "delete" : { - "tags" : [ "processors" ], - "summary" : "Terminates a processor, essentially \"deleting\" its threads and any active tasks", - "description" : "", - "operationId" : "terminateProcessor", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The processor id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessorEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /processors/{uuid} or /operation/processors/{uuid}" : [ ] - } ] - } - }, - "/provenance" : { - "post" : { - "tags" : [ "provenance" ], - "summary" : "Submits a provenance query", - "description" : "Provenance queries may be long running so this endpoint submits a request. The response will include the current state of the query. If the request is not completed the URI in the response can be used at a later time to get the updated state of the query. Once the query has completed the provenance request should be deleted by the client who originally submitted it.", - "operationId" : "submitProvenanceRequest", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The provenance query details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ProvenanceEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProvenanceEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /provenance" : [ ] - }, { - "Read - /data/{component-type}/{uuid}" : [ ] - } ] - } - }, - "/provenance-events/replays" : { - "post" : { - "tags" : [ "provenance-events" ], - "summary" : "Replays content from a provenance event", - "description" : "", - "operationId" : "submitReplay", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The replay request.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/SubmitReplayRequestEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProvenanceEventEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read Component Provenance Data - /provenance-data/{component-type}/{uuid}" : [ ] - }, { - "Read Component Data - /data/{component-type}/{uuid}" : [ ] - }, { - "Write Component Data - /data/{component-type}/{uuid}" : [ ] - } ] - } - }, - "/provenance-events/{id}" : { - "get" : { - "tags" : [ "provenance-events" ], - "summary" : "Gets a provenance event", - "description" : "", - "operationId" : "getProvenanceEvent", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "clusterNodeId", - "in" : "query", - "description" : "The id of the node where this event exists if clustered.", - "required" : false, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The provenance event id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProvenanceEventEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read Component Provenance Data - /provenance-data/{component-type}/{uuid}" : [ ] - } ] - } - }, - "/provenance-events/{id}/content/input" : { - "get" : { - "tags" : [ "provenance-events" ], - "summary" : "Gets the input content for a provenance event", - "description" : "", - "operationId" : "getInputContent", - "consumes" : [ "*/*" ], - "produces" : [ "*/*" ], - "parameters" : [ { - "name" : "clusterNodeId", - "in" : "query", - "description" : "The id of the node where the content exists if clustered.", - "required" : false, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The provenance event id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/StreamingOutput" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read Component Provenance Data - /provenance-data/{component-type}/{uuid}" : [ ] - }, { - "Read Component Data - /data/{component-type}/{uuid}" : [ ] - } ] - } - }, - "/provenance-events/{id}/content/output" : { - "get" : { - "tags" : [ "provenance-events" ], - "summary" : "Gets the output content for a provenance event", - "description" : "", - "operationId" : "getOutputContent", - "consumes" : [ "*/*" ], - "produces" : [ "*/*" ], - "parameters" : [ { - "name" : "clusterNodeId", - "in" : "query", - "description" : "The id of the node where the content exists if clustered.", - "required" : false, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The provenance event id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/StreamingOutput" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read Component Provenance Data - /provenance-data/{component-type}/{uuid}" : [ ] - }, { - "Read Component Data - /data/{component-type}/{uuid}" : [ ] - } ] - } - }, - "/provenance/lineage" : { - "post" : { - "tags" : [ "provenance" ], - "summary" : "Submits a lineage query", - "description" : "Lineage queries may be long running so this endpoint submits a request. The response will include the current state of the query. If the request is not completed the URI in the response can be used at a later time to get the updated state of the query. Once the query has completed the lineage request should be deleted by the client who originally submitted it.", - "operationId" : "submitLineageRequest", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The lineage query details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/LineageEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/LineageEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /provenance" : [ ] - }, { - "Read - /data/{component-type}/{uuid}" : [ ] - } ] - } - }, - "/provenance/lineage/{id}" : { - "get" : { - "tags" : [ "provenance" ], - "summary" : "Gets a lineage query", - "description" : "", - "operationId" : "getLineage", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "clusterNodeId", - "in" : "query", - "description" : "The id of the node where this query exists if clustered.", - "required" : false, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The id of the lineage query.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/LineageEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /provenance" : [ ] - }, { - "Read - /data/{component-type}/{uuid}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "provenance" ], - "summary" : "Deletes a lineage query", - "description" : "", - "operationId" : "deleteLineage", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "clusterNodeId", - "in" : "query", - "description" : "The id of the node where this query exists if clustered.", - "required" : false, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The id of the lineage query.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/LineageEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /provenance" : [ ] - } ] - } - }, - "/provenance/search-options" : { - "get" : { - "tags" : [ "provenance" ], - "summary" : "Gets the searchable attributes for provenance events", - "description" : "", - "operationId" : "getSearchOptions", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProvenanceOptionsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /provenance" : [ ] - } ] - } - }, - "/provenance/{id}" : { - "get" : { - "tags" : [ "provenance" ], - "summary" : "Gets a provenance query", - "description" : "", - "operationId" : "getProvenance", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "clusterNodeId", - "in" : "query", - "description" : "The id of the node where this query exists if clustered.", - "required" : false, - "type" : "string" - }, { - "name" : "summarize", - "in" : "query", - "description" : "Whether or not incremental results are returned. If false, provenance events are only returned once the query completes. This property is true by default.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "incrementalResults", - "in" : "query", - "description" : "Whether or not to summarize provenance events returned. This property is false by default.", - "required" : false, - "type" : "boolean", - "default" : true - }, { - "name" : "id", - "in" : "path", - "description" : "The id of the provenance query.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProvenanceEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /provenance" : [ ] - }, { - "Read - /data/{component-type}/{uuid}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "provenance" ], - "summary" : "Deletes a provenance query", - "description" : "", - "operationId" : "deleteProvenance", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "clusterNodeId", - "in" : "query", - "description" : "The id of the node where this query exists if clustered.", - "required" : false, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The id of the provenance query.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProvenanceEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /provenance" : [ ] - } ] - } - }, - "/remote-process-groups/{id}" : { - "get" : { - "tags" : [ "remote-process-groups" ], - "summary" : "Gets a remote process group", - "description" : "", - "operationId" : "getRemoteProcessGroup", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The remote process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/RemoteProcessGroupEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /remote-process-groups/{uuid}" : [ ] - } ] - }, - "put" : { - "tags" : [ "remote-process-groups" ], - "summary" : "Updates a remote process group", - "description" : "", - "operationId" : "updateRemoteProcessGroup", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The remote process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The remote process group.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/RemoteProcessGroupEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/RemoteProcessGroupEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /remote-process-groups/{uuid}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "remote-process-groups" ], - "summary" : "Deletes a remote process group", - "description" : "", - "operationId" : "removeRemoteProcessGroup", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The revision is used to verify the client is working with the latest version of the flow.", - "required" : false, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The remote process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/RemoteProcessGroupEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /remote-process-groups/{uuid}" : [ ] - }, { - "Write - Parent Process Group - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/remote-process-groups/{id}/input-ports/{port-id}" : { - "put" : { - "tags" : [ "remote-process-groups" ], - "summary" : "Updates a remote port", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "updateRemoteProcessGroupInputPort", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The remote process group id.", - "required" : true, - "type" : "string" - }, { - "name" : "port-id", - "in" : "path", - "description" : "The remote process group port id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The remote process group port.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/RemoteProcessGroupPortEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/RemoteProcessGroupPortEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /remote-process-groups/{uuid}" : [ ] - } ] - } - }, - "/remote-process-groups/{id}/input-ports/{port-id}/run-status" : { - "put" : { - "tags" : [ "remote-process-groups" ], - "summary" : "Updates run status of a remote port", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "updateRemoteProcessGroupInputPortRunStatus", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The remote process group id.", - "required" : true, - "type" : "string" - }, { - "name" : "port-id", - "in" : "path", - "description" : "The remote process group port id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The remote process group port.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/RemotePortRunStatusEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/RemoteProcessGroupPortEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /remote-process-groups/{uuid} or /operation/remote-process-groups/{uuid}" : [ ] - } ] - } - }, - "/remote-process-groups/{id}/output-ports/{port-id}" : { - "put" : { - "tags" : [ "remote-process-groups" ], - "summary" : "Updates a remote port", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "updateRemoteProcessGroupOutputPort", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The remote process group id.", - "required" : true, - "type" : "string" - }, { - "name" : "port-id", - "in" : "path", - "description" : "The remote process group port id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The remote process group port.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/RemoteProcessGroupPortEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/RemoteProcessGroupPortEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /remote-process-groups/{uuid}" : [ ] - } ] - } - }, - "/remote-process-groups/{id}/output-ports/{port-id}/run-status" : { - "put" : { - "tags" : [ "remote-process-groups" ], - "summary" : "Updates run status of a remote port", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "updateRemoteProcessGroupOutputPortRunStatus", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The remote process group id.", - "required" : true, - "type" : "string" - }, { - "name" : "port-id", - "in" : "path", - "description" : "The remote process group port id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The remote process group port.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/RemotePortRunStatusEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/RemoteProcessGroupPortEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /remote-process-groups/{uuid} or /operation/remote-process-groups/{uuid}" : [ ] - } ] - } - }, - "/remote-process-groups/{id}/run-status" : { - "put" : { - "tags" : [ "remote-process-groups" ], - "summary" : "Updates run status of a remote process group", - "description" : "", - "operationId" : "updateRemoteProcessGroupRunStatus", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The remote process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The remote process group run status.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/RemotePortRunStatusEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/RemoteProcessGroupEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /remote-process-groups/{uuid} or /operation/remote-process-groups/{uuid}" : [ ] - } ] - } - }, - "/remote-process-groups/{id}/state" : { - "get" : { - "tags" : [ "remote-process-groups" ], - "summary" : "Gets the state for a RemoteProcessGroup", - "description" : "", - "operationId" : "getState", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The processor id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ComponentStateEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /remote-process-groups/{uuid}" : [ ] - } ] - } - }, - "/reporting-tasks/{id}" : { - "get" : { - "tags" : [ "reporting-tasks" ], - "summary" : "Gets a reporting task", - "description" : "", - "operationId" : "getReportingTask", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The reporting task id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ReportingTaskEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /reporting-tasks/{uuid}" : [ ] - } ] - }, - "put" : { - "tags" : [ "reporting-tasks" ], - "summary" : "Updates a reporting task", - "description" : "", - "operationId" : "updateReportingTask", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The reporting task id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The reporting task configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ReportingTaskEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ReportingTaskEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /reporting-tasks/{uuid}" : [ ] - }, { - "Read - any referenced Controller Services if this request changes the reference - /controller-services/{uuid}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "reporting-tasks" ], - "summary" : "Deletes a reporting task", - "description" : "", - "operationId" : "removeReportingTask", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The revision is used to verify the client is working with the latest version of the flow.", - "required" : false, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The reporting task id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ReportingTaskEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /reporting-tasks/{uuid}" : [ ] - }, { - "Write - /controller" : [ ] - }, { - "Read - any referenced Controller Services - /controller-services/{uuid}" : [ ] - } ] - } - }, - "/reporting-tasks/{id}/descriptors" : { - "get" : { - "tags" : [ "reporting-tasks" ], - "summary" : "Gets a reporting task property descriptor", - "description" : "", - "operationId" : "getPropertyDescriptor", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The reporting task id.", - "required" : true, - "type" : "string" - }, { - "name" : "propertyName", - "in" : "query", - "description" : "The property name.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/PropertyDescriptorEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /reporting-tasks/{uuid}" : [ ] - } ] - } - }, - "/reporting-tasks/{id}/run-status" : { - "put" : { - "tags" : [ "reporting-tasks" ], - "summary" : "Updates run status of a reporting task", - "description" : "", - "operationId" : "updateRunStatus", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The reporting task id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The reporting task run status.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ReportingTaskRunStatusEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ReportingTaskEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /reporting-tasks/{uuid} or or /operation/reporting-tasks/{uuid}" : [ ] - } ] - } - }, - "/reporting-tasks/{id}/state" : { - "get" : { - "tags" : [ "reporting-tasks" ], - "summary" : "Gets the state for a reporting task", - "description" : "", - "operationId" : "getState", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The reporting task id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ComponentStateEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /reporting-tasks/{uuid}" : [ ] - } ] - } - }, - "/reporting-tasks/{id}/state/clear-requests" : { - "post" : { - "tags" : [ "reporting-tasks" ], - "summary" : "Clears the state for a reporting task", - "description" : "", - "operationId" : "clearState", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The reporting task id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ComponentStateEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /reporting-tasks/{uuid}" : [ ] - } ] - } - }, - "/resources" : { - "get" : { - "tags" : [ "resources" ], - "summary" : "Gets the available resources that support access/authorization policies", - "description" : "", - "operationId" : "getResources", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ResourcesEntity" - } - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - } - }, - "security" : [ { - "Read - /resources" : [ ] - } ] - } - }, - "/site-to-site" : { - "get" : { - "tags" : [ "site-to-site" ], - "summary" : "Returns the details about this NiFi necessary to communicate via site to site", - "description" : "", - "operationId" : "getSiteToSiteDetails", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ControllerEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /site-to-site" : [ ] - } ] - } - }, - "/site-to-site/peers" : { - "get" : { - "tags" : [ "site-to-site" ], - "summary" : "Returns the available Peers and its status of this NiFi", - "description" : "", - "operationId" : "getPeers", - "consumes" : [ "*/*" ], - "produces" : [ "application/json", "application/xml" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/PeersEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /site-to-site" : [ ] - } ] - } - }, - "/snippets" : { - "post" : { - "tags" : [ "snippets" ], - "summary" : "Creates a snippet. The snippet will be automatically discarded if not used in a subsequent request after 1 minute.", - "description" : "", - "operationId" : "createSnippet", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The snippet configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/SnippetEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/SnippetEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read or Write - /{component-type}/{uuid} - For every component (all Read or all Write) in the Snippet and their descendant components" : [ ] - } ] - } - }, - "/snippets/{id}" : { - "put" : { - "tags" : [ "snippets" ], - "summary" : "Move's the components in this Snippet into a new Process Group and discards the snippet", - "description" : "", - "operationId" : "updateSnippet", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The snippet id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The snippet configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/SnippetEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/SnippetEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write Process Group - /process-groups/{uuid}" : [ ] - }, { - "Write - /{component-type}/{uuid} - For each component in the Snippet and their descendant components" : [ ] - } ] - }, - "delete" : { - "tags" : [ "snippets" ], - "summary" : "Deletes the components in a snippet and discards the snippet", - "description" : "", - "operationId" : "deleteSnippet", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The snippet id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/SnippetEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /{component-type}/{uuid} - For each component in the Snippet and their descendant components" : [ ] - }, { - "Write - Parent Process Group - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/system-diagnostics" : { - "get" : { - "tags" : [ "system-diagnostics" ], - "summary" : "Gets the diagnostics for the system NiFi is running on", - "description" : "", - "operationId" : "getSystemDiagnostics", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "nodewise", - "in" : "query", - "description" : "Whether or not to include the breakdown per node. Optional, defaults to false", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "clusterNodeId", - "in" : "query", - "description" : "The id of the node where to get the status.", - "required" : false, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/SystemDiagnosticsEntity" - } - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - } - }, - "security" : [ { - "Read - /system" : [ ] - } ] - } - }, - "/templates/{id}" : { - "delete" : { - "tags" : [ "templates" ], - "summary" : "Deletes a template", - "description" : "", - "operationId" : "removeTemplate", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The template id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/TemplateEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /templates/{uuid}" : [ ] - }, { - "Write - Parent Process Group - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/templates/{id}/download" : { - "get" : { - "tags" : [ "templates" ], - "summary" : "Exports a template", - "description" : "", - "operationId" : "exportTemplate", - "consumes" : [ "*/*" ], - "produces" : [ "application/xml" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The template id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /templates/{uuid}" : [ ] - } ] - } - }, - "/tenants/search-results" : { - "get" : { - "tags" : [ "tenants" ], - "summary" : "Searches for a tenant with the specified identity", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "searchTenants", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "q", - "in" : "query", - "description" : "Identity to search for.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/TenantsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /tenants" : [ ] - } ] - } - }, - "/tenants/user-groups" : { - "get" : { - "tags" : [ "tenants" ], - "summary" : "Gets all user groups", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getUserGroups", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/UserGroupsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /tenants" : [ ] - } ] - }, - "post" : { - "tags" : [ "tenants" ], - "summary" : "Creates a user group", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "createUserGroup", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The user group configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/UserGroupEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/UserGroupEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /tenants" : [ ] - } ] - } - }, - "/tenants/user-groups/{id}" : { - "get" : { - "tags" : [ "tenants" ], - "summary" : "Gets a user group", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getUserGroup", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The user group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/UserGroupEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /tenants" : [ ] - } ] - }, - "put" : { - "tags" : [ "tenants" ], - "summary" : "Updates a user group", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "updateUserGroup", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The user group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The user group configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/UserGroupEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/UserGroupEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /tenants" : [ ] - } ] - }, - "delete" : { - "tags" : [ "tenants" ], - "summary" : "Deletes a user group", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "removeUserGroup", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The revision is used to verify the client is working with the latest version of the flow.", - "required" : false, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The user group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/UserGroupEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /tenants" : [ ] - } ] - } - }, - "/tenants/users" : { - "get" : { - "tags" : [ "tenants" ], - "summary" : "Gets all users", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getUsers", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/UsersEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /tenants" : [ ] - } ] - }, - "post" : { - "tags" : [ "tenants" ], - "summary" : "Creates a user", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "createUser", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The user configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/UserEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/UserEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /tenants" : [ ] - } ] - } - }, - "/tenants/users/{id}" : { - "get" : { - "tags" : [ "tenants" ], - "summary" : "Gets a user", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getUser", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The user id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/UserEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /tenants" : [ ] - } ] - }, - "put" : { - "tags" : [ "tenants" ], - "summary" : "Updates a user", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "updateUser", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The user id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The user configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/UserEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/UserEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /tenants" : [ ] - } ] - }, - "delete" : { - "tags" : [ "tenants" ], - "summary" : "Deletes a user", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "removeUser", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The revision is used to verify the client is working with the latest version of the flow.", - "required" : false, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The user id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/UserEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /tenants" : [ ] - } ] - } - }, - "/versions/active-requests" : { - "post" : { - "tags" : [ "versions" ], - "summary" : "Create a version control request", - "description" : "Creates a request so that a Process Group can be placed under Version Control or have its Version Control configuration changed. Creating this request will prevent any other threads from simultaneously saving local changes to Version Control. It will not, however, actually save the local flow to the Flow Registry. A POST to /versions/process-groups/{id} should be used to initiate saving of the local flow to the Flow Registry. Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "createVersionControlRequest", - "consumes" : [ "application/json" ], - "produces" : [ "text/plain" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The versioned flow details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/CreateActiveRequestEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/versions/active-requests/{id}" : { - "put" : { - "tags" : [ "versions" ], - "summary" : "Updates the request with the given ID", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "updateVersionControlRequest", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The request ID.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The version control component mapping.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/VersionControlComponentMappingEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionControlInformationEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Only the user that submitted the request can update it" : [ ] - } ] - }, - "delete" : { - "tags" : [ "versions" ], - "summary" : "Deletes the version control request with the given ID", - "description" : "Deletes the Version Control Request with the given ID. This will allow other threads to save flows to the Flow Registry. See also the documentation for POSTing to /versions/active-requests for information regarding why this is done. Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "deleteVersionControlRequest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The request ID.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Only the user that submitted the request can remove it" : [ ] - } ] - } - }, - "/versions/process-groups/{id}" : { - "get" : { - "tags" : [ "versions" ], - "summary" : "Gets the Version Control information for a process group", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getVersionInformation", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionControlInformationEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - } ] - }, - "post" : { - "tags" : [ "versions" ], - "summary" : "Save the Process Group with the given ID", - "description" : "Begins version controlling the Process Group with the given ID or commits changes to the Versioned Flow, depending on if the provided VersionControlInformation includes a flowId. Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "saveToFlowRegistry", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The versioned flow details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/StartVersionControlRequestEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionControlInformationEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - }, { - "Write - /process-groups/{uuid}" : [ ] - }, { - "Read - /{component-type}/{uuid} - For all encapsulated components" : [ ] - }, { - "Read - any referenced Controller Services by any encapsulated components - /controller-services/{uuid}" : [ ] - } ] - }, - "put" : { - "tags" : [ "versions" ], - "summary" : "Update the version of a Process Group with the given ID", - "description" : "For a Process Group that is already under Version Control, this will update the version of the flow to a different version. This endpoint expects that the given snapshot will not modify any Processor that is currently running or any Controller Service that is enabled. Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "updateFlowVersion", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The controller service configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/VersionedFlowSnapshotEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionControlInformationEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - }, { - "Write - /process-groups/{uuid}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "versions" ], - "summary" : "Stops version controlling the Process Group with the given ID", - "description" : "Stops version controlling the Process Group with the given ID. The Process Group will no longer track to any Versioned Flow. Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "stopVersionControl", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The version is used to verify the client is working with the latest version of the flow.", - "required" : false, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, a new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionControlInformationEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - }, { - "Write - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/versions/revert-requests/process-groups/{id}" : { - "post" : { - "tags" : [ "versions" ], - "summary" : "Initiate the Revert Request of a Process Group with the given ID", - "description" : "For a Process Group that is already under Version Control, this will initiate the action of reverting any local changes that have been made to the Process Group since it was last synchronized with the Flow Registry. This will result in the flow matching the Versioned Flow that exists in the Flow Registry. This can be a lengthy process, as it will stop any Processors and disable any Controller Services necessary to perform the action and then restart them. As a result, the endpoint will immediately return a VersionedFlowUpdateRequestEntity, and the process of updating the flow will occur asynchronously in the background. The client may then periodically poll the status of the request by issuing a GET request to /versions/revert-requests/{requestId}. Once the request is completed, the client is expected to issue a DELETE request to /versions/revert-requests/{requestId}. Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "initiateRevertFlowVersion", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The controller service configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/VersionControlInformationEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlowUpdateRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - }, { - "Write - /process-groups/{uuid}" : [ ] - }, { - "Read - /{component-type}/{uuid} - For all encapsulated components" : [ ] - }, { - "Write - /{component-type}/{uuid} - For all encapsulated components" : [ ] - }, { - "Write - if the template contains any restricted components - /restricted-components" : [ ] - }, { - "Read - /parameter-contexts/{uuid} - For any Parameter Context that is referenced by a Property that is changed, added, or removed" : [ ] - } ] - } - }, - "/versions/revert-requests/{id}" : { - "get" : { - "tags" : [ "versions" ], - "summary" : "Returns the Revert Request with the given ID", - "description" : "Returns the Revert Request with the given ID. Once a Revert Request has been created by performing a POST to /versions/revert-requests/process-groups/{id}, that request can subsequently be retrieved via this endpoint, and the request that is fetched will contain the updated state, such as percent complete, the current state of the request, and any failures. Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getRevertRequest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The ID of the Revert Request", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlowUpdateRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Only the user that submitted the request can get it" : [ ] - } ] - }, - "delete" : { - "tags" : [ "versions" ], - "summary" : "Deletes the Revert Request with the given ID", - "description" : "Deletes the Revert Request with the given ID. After a request is created via a POST to /versions/revert-requests/process-groups/{id}, it is expected that the client will properly clean up the request by DELETE'ing it, once the Revert process has completed. If the request is deleted before the request completes, then the Revert request will finish the step that it is currently performing and then will cancel any subsequent steps. Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "deleteRevertRequest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The ID of the Revert Request", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlowUpdateRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Only the user that submitted the request can remove it" : [ ] - } ] - } - }, - "/versions/update-requests/process-groups/{id}" : { - "post" : { - "tags" : [ "versions" ], - "summary" : "Initiate the Update Request of a Process Group with the given ID", - "description" : "For a Process Group that is already under Version Control, this will initiate the action of changing from a specific version of the flow in the Flow Registry to a different version of the flow. This can be a lengthy process, as it will stop any Processors and disable any Controller Services necessary to perform the action and then restart them. As a result, the endpoint will immediately return a VersionedFlowUpdateRequestEntity, and the process of updating the flow will occur asynchronously in the background. The client may then periodically poll the status of the request by issuing a GET request to /versions/update-requests/{requestId}. Once the request is completed, the client is expected to issue a DELETE request to /versions/update-requests/{requestId}. Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "initiateVersionControlUpdate", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The controller service configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/VersionControlInformationEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlowUpdateRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - }, { - "Write - /process-groups/{uuid}" : [ ] - }, { - "Read - /{component-type}/{uuid} - For all encapsulated components" : [ ] - }, { - "Write - /{component-type}/{uuid} - For all encapsulated components" : [ ] - }, { - "Write - if the template contains any restricted components - /restricted-components" : [ ] - }, { - "Read - /parameter-contexts/{uuid} - For any Parameter Context that is referenced by a Property that is changed, added, or removed" : [ ] - } ] - } - }, - "/versions/update-requests/{id}" : { - "get" : { - "tags" : [ "versions" ], - "summary" : "Returns the Update Request with the given ID", - "description" : "Returns the Update Request with the given ID. Once an Update Request has been created by performing a POST to /versions/update-requests/process-groups/{id}, that request can subsequently be retrieved via this endpoint, and the request that is fetched will contain the updated state, such as percent complete, the current state of the request, and any failures. Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getUpdateRequest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The ID of the Update Request", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlowUpdateRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Only the user that submitted the request can get it" : [ ] - } ] - }, - "delete" : { - "tags" : [ "versions" ], - "summary" : "Deletes the Update Request with the given ID", - "description" : "Deletes the Update Request with the given ID. After a request is created via a POST to /versions/update-requests/process-groups/{id}, it is expected that the client will properly clean up the request by DELETE'ing it, once the Update process has completed. If the request is deleted before the request completes, then the Update request will finish the step that it is currently performing and then will cancel any subsequent steps. Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "deleteUpdateRequest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The ID of the Update Request", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlowUpdateRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Only the user that submitted the request can remove it" : [ ] - } ] - } - } - }, - "definitions" : { - "AboutDTO" : { - "type" : "object", - "properties" : { - "title" : { - "type" : "string", - "description" : "The title to be used on the page and in the about dialog." - }, - "version" : { - "type" : "string", - "description" : "The version of this NiFi." - }, - "uri" : { - "type" : "string", - "description" : "The URI for the NiFi." - }, - "contentViewerUrl" : { - "type" : "string", - "description" : "The URL for the content viewer if configured." - }, - "timezone" : { - "type" : "string", - "description" : "The timezone of the NiFi instance.", - "readOnly" : true - }, - "buildTag" : { - "type" : "string", - "description" : "Build tag" - }, - "buildRevision" : { - "type" : "string", - "description" : "Build revision or commit hash" - }, - "buildBranch" : { - "type" : "string", - "description" : "Build branch" - }, - "buildTimestamp" : { - "type" : "string", - "description" : "Build timestamp" - } - } - }, - "AboutEntity" : { - "type" : "object", - "properties" : { - "about" : { - "$ref" : "#/definitions/AboutDTO" - } - }, - "xml" : { - "name" : "aboutEntity" - } - }, - "AccessConfigurationDTO" : { - "type" : "object", - "properties" : { - "supportsLogin" : { - "type" : "boolean", - "description" : "Indicates whether or not this NiFi supports user login.", - "readOnly" : true - } - } - }, - "AccessConfigurationEntity" : { - "type" : "object", - "properties" : { - "config" : { - "$ref" : "#/definitions/AccessConfigurationDTO" - } - }, - "xml" : { - "name" : "accessConfigurationEntity" - } - }, - "AccessPolicyDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "versionedComponentId" : { - "type" : "string", - "description" : "The ID of the corresponding component that is under version control" - }, - "parentGroupId" : { - "type" : "string", - "description" : "The id of parent process group of this component if applicable." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "resource" : { - "type" : "string", - "description" : "The resource for this access policy." - }, - "action" : { - "type" : "string", - "description" : "The action associated with this access policy.", - "enum" : [ "read", "write" ] - }, - "componentReference" : { - "description" : "Component this policy references if applicable.", - "$ref" : "#/definitions/ComponentReferenceEntity" - }, - "configurable" : { - "type" : "boolean", - "description" : "Whether this policy is configurable." - }, - "users" : { - "type" : "array", - "description" : "The set of user IDs associated with this access policy.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/TenantEntity" - } - }, - "userGroups" : { - "type" : "array", - "description" : "The set of user group IDs associated with this access policy.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/TenantEntity" - } - } - } - }, - "AccessPolicyEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "generated" : { - "type" : "string", - "description" : "When this content was generated." - }, - "component" : { - "$ref" : "#/definitions/AccessPolicyDTO" - } - }, - "xml" : { - "name" : "accessPolicyEntity" - } - }, - "AccessPolicySummaryDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "versionedComponentId" : { - "type" : "string", - "description" : "The ID of the corresponding component that is under version control" - }, - "parentGroupId" : { - "type" : "string", - "description" : "The id of parent process group of this component if applicable." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "resource" : { - "type" : "string", - "description" : "The resource for this access policy." - }, - "action" : { - "type" : "string", - "description" : "The action associated with this access policy.", - "enum" : [ "read", "write" ] - }, - "componentReference" : { - "description" : "Component this policy references if applicable.", - "$ref" : "#/definitions/ComponentReferenceEntity" - }, - "configurable" : { - "type" : "boolean", - "description" : "Whether this policy is configurable." - } - } - }, - "AccessPolicySummaryEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "component" : { - "$ref" : "#/definitions/AccessPolicySummaryDTO" - } - }, - "xml" : { - "name" : "accessPolicySummaryEntity" - } - }, - "AccessStatusDTO" : { - "type" : "object", - "properties" : { - "identity" : { - "type" : "string", - "description" : "The user identity.", - "readOnly" : true - }, - "status" : { - "type" : "string", - "description" : "The user access status.", - "readOnly" : true - }, - "message" : { - "type" : "string", - "description" : "Additional details about the user access status.", - "readOnly" : true - } - }, - "xml" : { - "name" : "accessStatus" - } - }, - "AccessStatusEntity" : { - "type" : "object", - "properties" : { - "accessStatus" : { - "$ref" : "#/definitions/AccessStatusDTO" - } - }, - "xml" : { - "name" : "accessStatusEntity" - } - }, - "ActionDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "integer", - "format" : "int32", - "description" : "The action id." - }, - "userIdentity" : { - "type" : "string", - "description" : "The identity of the user that performed the action." - }, - "timestamp" : { - "type" : "string", - "description" : "The timestamp of the action." - }, - "sourceId" : { - "type" : "string", - "description" : "The id of the source component." - }, - "sourceName" : { - "type" : "string", - "description" : "The name of the source component." - }, - "sourceType" : { - "type" : "string", - "description" : "The type of the source component." - }, - "componentDetails" : { - "description" : "The details of the source component.", - "$ref" : "#/definitions/ComponentDetailsDTO" - }, - "operation" : { - "type" : "string", - "description" : "The operation that was performed." - }, - "actionDetails" : { - "description" : "The details of the action.", - "$ref" : "#/definitions/ActionDetailsDTO" - } - } - }, - "ActionDetailsDTO" : { - "type" : "object" - }, - "ActionEntity" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "integer", - "format" : "int32" - }, - "timestamp" : { - "type" : "string", - "description" : "The timestamp of the action." - }, - "sourceId" : { - "type" : "string" - }, - "canRead" : { - "type" : "boolean", - "description" : "Indicates whether the user can read a given resource.", - "readOnly" : true - }, - "action" : { - "$ref" : "#/definitions/ActionDTO" - } - }, - "xml" : { - "name" : "actionEntity" - } - }, - "ActivateControllerServicesEntity" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the ProcessGroup" - }, - "state" : { - "type" : "string", - "description" : "The desired state of the descendant components", - "enum" : [ "ENABLED", "DISABLED" ] - }, - "components" : { - "type" : "object", - "description" : "Optional services to schedule. If not specified, all authorized descendant controller services will be used.", - "additionalProperties" : { - "$ref" : "#/definitions/RevisionDTO" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - } - }, - "xml" : { - "name" : "activateControllerServicesEntity" - } - }, - "AffectedComponentDTO" : { - "type" : "object", - "properties" : { - "processGroupId" : { - "type" : "string", - "description" : "The UUID of the Process Group that this component is in" - }, - "id" : { - "type" : "string", - "description" : "The UUID of this component" - }, - "referenceType" : { - "type" : "string", - "description" : "The type of this component", - "enum" : [ "PROCESSOR", "CONTROLLER_SERVICE", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT" ] - }, - "name" : { - "type" : "string", - "description" : "The name of this component." - }, - "state" : { - "type" : "string", - "description" : "The scheduled state of a processor or reporting task referencing a controller service. If this component is another controller service, this field represents the controller service state." - }, - "activeThreadCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of active threads for the referencing component." - }, - "validationErrors" : { - "type" : "array", - "description" : "The validation errors for the component.", - "items" : { - "type" : "string" - } - } - } - }, - "AffectedComponentEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "component" : { - "$ref" : "#/definitions/AffectedComponentDTO" - }, - "processGroup" : { - "description" : "The Process Group that the component belongs to", - "$ref" : "#/definitions/ProcessGroupNameDTO" - }, - "referenceType" : { - "type" : "string", - "description" : "The type of component referenced", - "enum" : [ "PROCESSOR", "CONTROLLER_SERVICE", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT" ] - } - }, - "xml" : { - "name" : "affectedComponentEntity" - } - }, - "AllowableValueDTO" : { - "type" : "object", - "properties" : { - "displayName" : { - "type" : "string", - "description" : "A human readable value that is allowed for the property descriptor." - }, - "value" : { - "type" : "string", - "description" : "A value that is allowed for the property descriptor." - }, - "description" : { - "type" : "string", - "description" : "A description for this allowable value." - } - } - }, - "AllowableValueEntity" : { - "type" : "object", - "properties" : { - "allowableValue" : { - "$ref" : "#/definitions/AllowableValueDTO" - }, - "canRead" : { - "type" : "boolean", - "description" : "Indicates whether the user can read a given resource.", - "readOnly" : true - } - }, - "xml" : { - "name" : "entity" - } - }, - "AttributeDTO" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The attribute name." - }, - "value" : { - "type" : "string", - "description" : "The attribute value." - }, - "previousValue" : { - "type" : "string", - "description" : "The value of the attribute before the event took place." - } - } - }, - "BannerDTO" : { - "type" : "object", - "properties" : { - "headerText" : { - "type" : "string", - "description" : "The header text." - }, - "footerText" : { - "type" : "string", - "description" : "The footer text." - } - } - }, - "BannerEntity" : { - "type" : "object", - "properties" : { - "banners" : { - "$ref" : "#/definitions/BannerDTO" - } - }, - "xml" : { - "name" : "bannersEntity" - } - }, - "BatchSettingsDTO" : { - "type" : "object", - "properties" : { - "count" : { - "type" : "integer", - "format" : "int32", - "description" : "Preferred number of flow files to include in a transaction." - }, - "size" : { - "type" : "string", - "description" : "Preferred number of bytes to include in a transaction." - }, - "duration" : { - "type" : "string", - "description" : "Preferred amount of time that a transaction should span." - } - } - }, - "BatchSize" : { - "type" : "object", - "properties" : { - "count" : { - "type" : "integer", - "format" : "int32", - "description" : "Preferred number of flow files to include in a transaction." - }, - "size" : { - "type" : "string", - "description" : "Preferred number of bytes to include in a transaction." - }, - "duration" : { - "type" : "string", - "description" : "Preferred amount of time that a transaction should span." - } - } - }, - "Bucket" : { - "type" : "object", - "required" : [ "name" ], - "properties" : { - "link" : { - "description" : "An WebLink to this entity.", - "readOnly" : true, - "$ref" : "#/definitions/JaxbLink" - }, - "identifier" : { - "type" : "string", - "description" : "An ID to uniquely identify this object.", - "readOnly" : true - }, - "name" : { - "type" : "string", - "description" : "The name of the bucket." - }, - "createdTimestamp" : { - "type" : "integer", - "format" : "int64", - "description" : "The timestamp of when the bucket was first created. This is set by the server at creation time.", - "readOnly" : true, - "minimum" : 1 - }, - "description" : { - "type" : "string", - "description" : "A description of the bucket." - }, - "allowBundleRedeploy" : { - "type" : "boolean", - "description" : "Indicates if this bucket allows the same version of an extension bundle to be redeployed and thus overwrite the existing artifact. By default this is false." - }, - "allowPublicRead" : { - "type" : "boolean", - "description" : "Indicates if this bucket allows read access to unauthenticated anonymous users" - }, - "permissions" : { - "description" : "The access that the current user has to this bucket.", - "readOnly" : true, - "$ref" : "#/definitions/Permissions" - } - } - }, - "BucketDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The bucket identifier" - }, - "name" : { - "type" : "string", - "description" : "The bucket name" - }, - "description" : { - "type" : "string", - "description" : "The bucket description" - }, - "created" : { - "type" : "integer", - "format" : "int64", - "description" : "The created timestamp of this bucket" - } - } - }, - "BucketEntity" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string" - }, - "bucket" : { - "$ref" : "#/definitions/BucketDTO" - }, - "permissions" : { - "$ref" : "#/definitions/PermissionsDTO" - } - }, - "xml" : { - "name" : "bucketEntity" - } - }, - "BucketsEntity" : { - "type" : "object", - "properties" : { - "buckets" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/BucketEntity" - } - } - }, - "xml" : { - "name" : "bucketsEntity" - } - }, - "BulletinBoardDTO" : { - "type" : "object", - "properties" : { - "bulletins" : { - "type" : "array", - "description" : "The bulletins in the bulletin board, that matches the supplied request.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "generated" : { - "type" : "string", - "description" : "The timestamp when this report was generated." - } - } - }, - "BulletinBoardEntity" : { - "type" : "object", - "properties" : { - "bulletinBoard" : { - "$ref" : "#/definitions/BulletinBoardDTO" - } - }, - "xml" : { - "name" : "bulletinBoardEntity" - } - }, - "BulletinDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "integer", - "format" : "int64", - "description" : "The id of the bulletin." - }, - "nodeAddress" : { - "type" : "string", - "description" : "If clustered, the address of the node from which the bulletin originated." - }, - "category" : { - "type" : "string", - "description" : "The category of this bulletin." - }, - "groupId" : { - "type" : "string", - "description" : "The group id of the source component." - }, - "sourceId" : { - "type" : "string", - "description" : "The id of the source component." - }, - "sourceName" : { - "type" : "string", - "description" : "The name of the source component." - }, - "level" : { - "type" : "string", - "description" : "The level of the bulletin." - }, - "message" : { - "type" : "string", - "description" : "The bulletin message." - }, - "timestamp" : { - "type" : "string", - "description" : "When this bulletin was generated." - } - } - }, - "BulletinEntity" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "integer", - "format" : "int64" - }, - "groupId" : { - "type" : "string" - }, - "sourceId" : { - "type" : "string" - }, - "timestamp" : { - "type" : "string", - "description" : "When this bulletin was generated." - }, - "nodeAddress" : { - "type" : "string" - }, - "canRead" : { - "type" : "boolean", - "description" : "Indicates whether the user can read a given resource.", - "readOnly" : true - }, - "bulletin" : { - "$ref" : "#/definitions/BulletinDTO" - } - }, - "xml" : { - "name" : "bulletinEntity" - } - }, - "Bundle" : { - "type" : "object", - "properties" : { - "group" : { - "type" : "string", - "description" : "The group of the bundle" - }, - "artifact" : { - "type" : "string", - "description" : "The artifact of the bundle" - }, - "version" : { - "type" : "string", - "description" : "The version of the bundle" - } - } - }, - "BundleDTO" : { - "type" : "object", - "properties" : { - "group" : { - "type" : "string", - "description" : "The group of the bundle." - }, - "artifact" : { - "type" : "string", - "description" : "The artifact of the bundle." - }, - "version" : { - "type" : "string", - "description" : "The version of the bundle." - } - } - }, - "ClusteSummaryEntity" : { - "type" : "object", - "properties" : { - "clusterSummary" : { - "$ref" : "#/definitions/ClusterSummaryDTO" - } - }, - "xml" : { - "name" : "clusterSummaryEntity" - } - }, - "ClusterDTO" : { - "type" : "object", - "properties" : { - "nodes" : { - "type" : "array", - "description" : "The collection of nodes that are part of the cluster.", - "items" : { - "$ref" : "#/definitions/NodeDTO" - } - }, - "generated" : { - "type" : "string", - "description" : "The timestamp the report was generated." - } - } - }, - "ClusterEntity" : { - "type" : "object", - "properties" : { - "cluster" : { - "$ref" : "#/definitions/ClusterDTO" - } - }, - "xml" : { - "name" : "clusterEntity" - } - }, - "ClusterSearchResultsEntity" : { - "type" : "object", - "properties" : { - "nodeResults" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/NodeSearchResultDTO" - } - } - }, - "xml" : { - "name" : "clusterSearchResultsEntity" - } - }, - "ClusterSummaryDTO" : { - "type" : "object", - "properties" : { - "connectedNodes" : { - "type" : "string", - "description" : "When clustered, reports the number of nodes connected vs the number of nodes in the cluster." - }, - "connectedNodeCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of nodes that are currently connected to the cluster" - }, - "totalNodeCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of nodes in the cluster, regardless of whether or not they are connected" - }, - "clustered" : { - "type" : "boolean", - "description" : "Whether this NiFi instance is clustered." - }, - "connectedToCluster" : { - "type" : "boolean", - "description" : "Whether this NiFi instance is connected to a cluster." - } - } - }, - "ComponentDetailsDTO" : { - "type" : "object" - }, - "ComponentDifferenceDTO" : { - "type" : "object", - "properties" : { - "componentType" : { - "type" : "string", - "description" : "The type of component" - }, - "componentId" : { - "type" : "string", - "description" : "The ID of the component" - }, - "componentName" : { - "type" : "string", - "description" : "The name of the component" - }, - "processGroupId" : { - "type" : "string", - "description" : "The ID of the Process Group that the component belongs to" - }, - "differences" : { - "type" : "array", - "description" : "The differences in the component between the two flows", - "items" : { - "$ref" : "#/definitions/DifferenceDTO" - } - } - } - }, - "ComponentHistoryDTO" : { - "type" : "object", - "properties" : { - "componentId" : { - "type" : "string", - "description" : "The component id." - }, - "propertyHistory" : { - "type" : "object", - "description" : "The history for the properties of the component.", - "additionalProperties" : { - "$ref" : "#/definitions/PropertyHistoryDTO" - } - } - } - }, - "ComponentHistoryEntity" : { - "type" : "object", - "properties" : { - "componentHistory" : { - "$ref" : "#/definitions/ComponentHistoryDTO" - } - }, - "xml" : { - "name" : "componentHistoryEntity" - } - }, - "ComponentReferenceDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "versionedComponentId" : { - "type" : "string", - "description" : "The ID of the corresponding component that is under version control" - }, - "parentGroupId" : { - "type" : "string", - "description" : "The id of parent process group of this component if applicable." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "name" : { - "type" : "string", - "description" : "The name of the component." - } - } - }, - "ComponentReferenceEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "parentGroupId" : { - "type" : "string", - "description" : "The id of parent process group of this component if applicable." - }, - "component" : { - "$ref" : "#/definitions/ComponentReferenceDTO" - } - }, - "xml" : { - "name" : "componentReferenceEntity" - } - }, - "ComponentRestrictionPermissionDTO" : { - "type" : "object", - "properties" : { - "requiredPermission" : { - "description" : "The required permission necessary for this restriction.", - "$ref" : "#/definitions/RequiredPermissionDTO" - }, - "permissions" : { - "description" : "The permissions for this component restriction. Note: the read permission are not used and will always be false.", - "$ref" : "#/definitions/PermissionsDTO" - } - } - }, - "ComponentSearchResultDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component that matched the search." - }, - "groupId" : { - "type" : "string", - "description" : "The group id of the component that matched the search." - }, - "parentGroup" : { - "description" : "The parent group of the component that matched the search.", - "$ref" : "#/definitions/SearchResultGroupDTO" - }, - "versionedGroup" : { - "description" : "The nearest versioned ancestor group of the component that matched the search.", - "$ref" : "#/definitions/SearchResultGroupDTO" - }, - "name" : { - "type" : "string", - "description" : "The name of the component that matched the search." - }, - "matches" : { - "type" : "array", - "description" : "What matched the search from the component.", - "items" : { - "type" : "string" - } - } - } - }, - "ComponentStateDTO" : { - "type" : "object", - "properties" : { - "componentId" : { - "type" : "string", - "description" : "The component identifier." - }, - "stateDescription" : { - "type" : "string", - "description" : "Description of the state this component persists." - }, - "clusterState" : { - "description" : "The cluster state for this component, or null if this NiFi is a standalone instance.", - "$ref" : "#/definitions/StateMapDTO" - }, - "localState" : { - "description" : "The local state for this component.", - "$ref" : "#/definitions/StateMapDTO" - } - } - }, - "ComponentStateEntity" : { - "type" : "object", - "properties" : { - "componentState" : { - "description" : "The component state.", - "$ref" : "#/definitions/ComponentStateDTO" - } - }, - "xml" : { - "name" : "componentStateEntity" - } - }, - "ComponentValidationResultDTO" : { - "type" : "object", - "properties" : { - "processGroupId" : { - "type" : "string", - "description" : "The UUID of the Process Group that this component is in" - }, - "id" : { - "type" : "string", - "description" : "The UUID of this component" - }, - "referenceType" : { - "type" : "string", - "description" : "The type of this component", - "enum" : [ "PROCESSOR", "CONTROLLER_SERVICE", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT" ] - }, - "name" : { - "type" : "string", - "description" : "The name of this component." - }, - "state" : { - "type" : "string", - "description" : "The scheduled state of a processor or reporting task referencing a controller service. If this component is another controller service, this field represents the controller service state." - }, - "activeThreadCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of active threads for the referencing component." - }, - "validationErrors" : { - "type" : "array", - "description" : "The validation errors for the component.", - "items" : { - "type" : "string" - } - }, - "currentlyValid" : { - "type" : "boolean", - "description" : "Whether or not the component is currently valid" - }, - "resultsValid" : { - "type" : "boolean", - "description" : "Whether or not the component will be valid if the Parameter Context is changed" - }, - "resultantValidationErrors" : { - "type" : "array", - "description" : "The validation errors that will apply to the component if the Parameter Context is changed", - "items" : { - "type" : "string" - } - } - } - }, - "ComponentValidationResultEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "component" : { - "$ref" : "#/definitions/ComponentValidationResultDTO" - } - }, - "xml" : { - "name" : "componentValidationResultEntity" - } - }, - "ComponentValidationResultsEntity" : { - "type" : "object", - "properties" : { - "validationResults" : { - "type" : "array", - "description" : "A List of ComponentValidationResultEntity, one for each component that is validated", - "items" : { - "$ref" : "#/definitions/ComponentValidationResultEntity" - } - } - }, - "xml" : { - "name" : "componentValidationResults" - } - }, - "ConnectableComponent" : { - "type" : "object", - "required" : [ "groupId", "id", "type" ], - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the connectable component." - }, - "type" : { - "type" : "string", - "description" : "The type of component the connectable is.", - "enum" : [ "PROCESSOR", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "INPUT_PORT", "OUTPUT_PORT", "FUNNEL" ] - }, - "groupId" : { - "type" : "string", - "description" : "The id of the group that the connectable component resides in" - }, - "name" : { - "type" : "string", - "description" : "The name of the connectable component" - }, - "comments" : { - "type" : "string", - "description" : "The comments for the connectable component." - } - } - }, - "ConnectableDTO" : { - "type" : "object", - "required" : [ "groupId", "id", "type" ], - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the connectable component." - }, - "versionedComponentId" : { - "type" : "string", - "description" : "The ID of the corresponding component that is under version control" - }, - "type" : { - "type" : "string", - "description" : "The type of component the connectable is.", - "enum" : [ "PROCESSOR", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "INPUT_PORT", "OUTPUT_PORT", "FUNNEL" ] - }, - "groupId" : { - "type" : "string", - "description" : "The id of the group that the connectable component resides in" - }, - "name" : { - "type" : "string", - "description" : "The name of the connectable component" - }, - "running" : { - "type" : "boolean", - "description" : "Reflects the current state of the connectable component." - }, - "transmitting" : { - "type" : "boolean", - "description" : "If the connectable component represents a remote port, indicates if the target is configured to transmit." - }, - "exists" : { - "type" : "boolean", - "description" : "If the connectable component represents a remote port, indicates if the target exists." - }, - "comments" : { - "type" : "string", - "description" : "The comments for the connectable component." - } - } - }, - "ConnectionDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "versionedComponentId" : { - "type" : "string", - "description" : "The ID of the corresponding component that is under version control" - }, - "parentGroupId" : { - "type" : "string", - "description" : "The id of parent process group of this component if applicable." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "source" : { - "description" : "The source of the connection.", - "$ref" : "#/definitions/ConnectableDTO" - }, - "destination" : { - "description" : "The destination of the connection.", - "$ref" : "#/definitions/ConnectableDTO" - }, - "name" : { - "type" : "string", - "description" : "The name of the connection." - }, - "labelIndex" : { - "type" : "integer", - "format" : "int32", - "description" : "The index of the bend point where to place the connection label." - }, - "getzIndex" : { - "type" : "integer", - "format" : "int64", - "description" : "The z index of the connection." - }, - "selectedRelationships" : { - "type" : "array", - "description" : "The selected relationship that comprise the connection.", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - }, - "availableRelationships" : { - "type" : "array", - "description" : "The relationships that the source of the connection currently supports.", - "readOnly" : true, - "uniqueItems" : true, - "items" : { - "type" : "string" - } - }, - "backPressureObjectThreshold" : { - "type" : "integer", - "format" : "int64", - "description" : "The object count threshold for determining when back pressure is applied. Updating this value is a passive change in the sense that it won't impact whether existing files over the limit are affected but it does help feeder processors to stop pushing too much into this work queue." - }, - "backPressureDataSizeThreshold" : { - "type" : "string", - "description" : "The object data size threshold for determining when back pressure is applied. Updating this value is a passive change in the sense that it won't impact whether existing files over the limit are affected but it does help feeder processors to stop pushing too much into this work queue." - }, - "flowFileExpiration" : { - "type" : "string", - "description" : "The amount of time a flow file may be in the flow before it will be automatically aged out of the flow. Once a flow file reaches this age it will be terminated from the flow the next time a processor attempts to start work on it." - }, - "prioritizers" : { - "type" : "array", - "description" : "The comparators used to prioritize the queue.", - "items" : { - "type" : "string" - } - }, - "bends" : { - "type" : "array", - "description" : "The bend points on the connection.", - "items" : { - "$ref" : "#/definitions/PositionDTO" - } - }, - "loadBalanceStrategy" : { - "type" : "string", - "description" : "How to load balance the data in this Connection across the nodes in the cluster.", - "enum" : [ "DO_NOT_LOAD_BALANCE", "PARTITION_BY_ATTRIBUTE", "ROUND_ROBIN", "SINGLE_NODE" ] - }, - "loadBalancePartitionAttribute" : { - "type" : "string", - "description" : "The FlowFile Attribute to use for determining which node a FlowFile will go to if the Load Balancing Strategy is set to PARTITION_BY_ATTRIBUTE" - }, - "loadBalanceCompression" : { - "type" : "string", - "description" : "Whether or not data should be compressed when being transferred between nodes in the cluster.", - "enum" : [ "DO_NOT_COMPRESS", "COMPRESS_ATTRIBUTES_ONLY", "COMPRESS_ATTRIBUTES_AND_CONTENT" ] - }, - "loadBalanceStatus" : { - "type" : "string", - "description" : "The current status of the Connection's Load Balancing Activities. Status can indicate that Load Balancing is not configured for the connection, that Load Balancing is configured but inactive (not currently transferring data to another node), or that Load Balancing is configured and actively transferring data to another node.", - "readOnly" : true, - "enum" : [ "LOAD_BALANCE_NOT_CONFIGURED", "LOAD_BALANCE_INACTIVE", "LOAD_BALANCE_ACTIVE" ] - } - } - }, - "ConnectionEntity" : { - "type" : "object", - "required" : [ "destinationType", "sourceType" ], - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "component" : { - "$ref" : "#/definitions/ConnectionDTO" - }, - "status" : { - "description" : "The status of the connection.", - "$ref" : "#/definitions/ConnectionStatusDTO" - }, - "bends" : { - "type" : "array", - "description" : "The bend points on the connection.", - "items" : { - "$ref" : "#/definitions/PositionDTO" - } - }, - "labelIndex" : { - "type" : "integer", - "format" : "int32", - "description" : "The index of the bend point where to place the connection label." - }, - "getzIndex" : { - "type" : "integer", - "format" : "int64", - "description" : "The z index of the connection." - }, - "sourceId" : { - "type" : "string", - "description" : "The identifier of the source of this connection." - }, - "sourceGroupId" : { - "type" : "string", - "description" : "The identifier of the group of the source of this connection." - }, - "sourceType" : { - "type" : "string", - "description" : "The type of component the source connectable is.", - "enum" : [ "PROCESSOR", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "INPUT_PORT", "OUTPUT_PORT", "FUNNEL" ] - }, - "destinationId" : { - "type" : "string", - "description" : "The identifier of the destination of this connection." - }, - "destinationGroupId" : { - "type" : "string", - "description" : "The identifier of the group of the destination of this connection." - }, - "destinationType" : { - "type" : "string", - "description" : "The type of component the destination connectable is.", - "enum" : [ "PROCESSOR", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "INPUT_PORT", "OUTPUT_PORT", "FUNNEL" ] - } - }, - "xml" : { - "name" : "connectionEntity" - } - }, - "ConnectionStatisticsDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The ID of the connection" - }, - "statsLastRefreshed" : { - "type" : "string", - "description" : "The timestamp of when the stats were last refreshed" - }, - "aggregateSnapshot" : { - "description" : "The status snapshot that represents the aggregate stats of the cluster", - "$ref" : "#/definitions/ConnectionStatisticsSnapshotDTO" - }, - "nodeSnapshots" : { - "type" : "array", - "description" : "A list of status snapshots for each node", - "items" : { - "$ref" : "#/definitions/NodeConnectionStatisticsSnapshotDTO" - } - } - } - }, - "ConnectionStatisticsEntity" : { - "type" : "object", - "properties" : { - "connectionStatistics" : { - "$ref" : "#/definitions/ConnectionStatisticsDTO" - }, - "canRead" : { - "type" : "boolean", - "description" : "Indicates whether the user can read a given resource.", - "readOnly" : true - } - }, - "xml" : { - "name" : "connectionStatisticsEntity" - } - }, - "ConnectionStatisticsSnapshotDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the connection." - }, - "predictedMillisUntilCountBackpressure" : { - "type" : "integer", - "format" : "int64", - "description" : "The predicted number of milliseconds before the connection will have backpressure applied, based on the queued count." - }, - "predictedMillisUntilBytesBackpressure" : { - "type" : "integer", - "format" : "int64", - "description" : "The predicted number of milliseconds before the connection will have backpressure applied, based on the total number of bytes in the queue." - }, - "predictedCountAtNextInterval" : { - "type" : "integer", - "format" : "int32", - "description" : "The predicted number of queued objects at the next configured interval." - }, - "predictedBytesAtNextInterval" : { - "type" : "integer", - "format" : "int64", - "description" : "The predicted total number of bytes in the queue at the next configured interval." - }, - "predictedPercentCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The predicted percentage of queued objects at the next configured interval." - }, - "predictedPercentBytes" : { - "type" : "integer", - "format" : "int32", - "description" : "The predicted percentage of bytes in the queue against current threshold at the next configured interval." - }, - "predictionIntervalMillis" : { - "type" : "integer", - "format" : "int64", - "description" : "The prediction interval in seconds" - } - } - }, - "ConnectionStatusDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The ID of the connection" - }, - "groupId" : { - "type" : "string", - "description" : "The ID of the Process Group that the connection belongs to" - }, - "name" : { - "type" : "string", - "description" : "The name of the connection" - }, - "statsLastRefreshed" : { - "type" : "string", - "description" : "The timestamp of when the stats were last refreshed" - }, - "sourceId" : { - "type" : "string", - "description" : "The ID of the source component" - }, - "sourceName" : { - "type" : "string", - "description" : "The name of the source component" - }, - "destinationId" : { - "type" : "string", - "description" : "The ID of the destination component" - }, - "destinationName" : { - "type" : "string", - "description" : "The name of the destination component" - }, - "aggregateSnapshot" : { - "description" : "The status snapshot that represents the aggregate stats of the cluster", - "$ref" : "#/definitions/ConnectionStatusSnapshotDTO" - }, - "nodeSnapshots" : { - "type" : "array", - "description" : "A list of status snapshots for each node", - "items" : { - "$ref" : "#/definitions/NodeConnectionStatusSnapshotDTO" - } - } - } - }, - "ConnectionStatusEntity" : { - "type" : "object", - "properties" : { - "connectionStatus" : { - "$ref" : "#/definitions/ConnectionStatusDTO" - }, - "canRead" : { - "type" : "boolean", - "description" : "Indicates whether the user can read a given resource.", - "readOnly" : true - } - }, - "xml" : { - "name" : "connectionStatusEntity" - } - }, - "ConnectionStatusPredictionsSnapshotDTO" : { - "type" : "object", - "properties" : { - "predictedMillisUntilCountBackpressure" : { - "type" : "integer", - "format" : "int64", - "description" : "The predicted number of milliseconds before the connection will have backpressure applied, based on the queued count." - }, - "predictedMillisUntilBytesBackpressure" : { - "type" : "integer", - "format" : "int64", - "description" : "The predicted number of milliseconds before the connection will have backpressure applied, based on the total number of bytes in the queue." - }, - "predictionIntervalSeconds" : { - "type" : "integer", - "format" : "int32", - "description" : "The configured interval (in seconds) for predicting connection queue count and size (and percent usage)." - }, - "predictedCountAtNextInterval" : { - "type" : "integer", - "format" : "int32", - "description" : "The predicted number of queued objects at the next configured interval." - }, - "predictedBytesAtNextInterval" : { - "type" : "integer", - "format" : "int64", - "description" : "The predicted total number of bytes in the queue at the next configured interval." - }, - "predictedPercentCount" : { - "type" : "integer", - "format" : "int32", - "description" : "Predicted connection percent use regarding queued flow files count and backpressure threshold if configured." - }, - "predictedPercentBytes" : { - "type" : "integer", - "format" : "int32", - "description" : "Predicted connection percent use regarding queued flow files size and backpressure threshold if configured." - } - } - }, - "ConnectionStatusSnapshotDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the connection." - }, - "groupId" : { - "type" : "string", - "description" : "The id of the process group the connection belongs to." - }, - "name" : { - "type" : "string", - "description" : "The name of the connection." - }, - "sourceId" : { - "type" : "string", - "description" : "The id of the source of the connection." - }, - "sourceName" : { - "type" : "string", - "description" : "The name of the source of the connection." - }, - "destinationId" : { - "type" : "string", - "description" : "The id of the destination of the connection." - }, - "destinationName" : { - "type" : "string", - "description" : "The name of the destination of the connection." - }, - "predictions" : { - "description" : "Predictions, if available, for this connection (null if not available)", - "$ref" : "#/definitions/ConnectionStatusPredictionsSnapshotDTO" - }, - "flowFilesIn" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of FlowFiles that have come into the connection in the last 5 minutes." - }, - "bytesIn" : { - "type" : "integer", - "format" : "int64", - "description" : "The size of the FlowFiles that have come into the connection in the last 5 minutes." - }, - "input" : { - "type" : "string", - "description" : "The input count/size for the connection in the last 5 minutes, pretty printed." - }, - "flowFilesOut" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of FlowFiles that have left the connection in the last 5 minutes." - }, - "bytesOut" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes that have left the connection in the last 5 minutes." - }, - "output" : { - "type" : "string", - "description" : "The output count/sie for the connection in the last 5 minutes, pretty printed." - }, - "flowFilesQueued" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of FlowFiles that are currently queued in the connection." - }, - "bytesQueued" : { - "type" : "integer", - "format" : "int64", - "description" : "The size of the FlowFiles that are currently queued in the connection." - }, - "queued" : { - "type" : "string", - "description" : "The total count and size of queued flowfiles formatted." - }, - "queuedSize" : { - "type" : "string", - "description" : "The total size of flowfiles that are queued formatted." - }, - "queuedCount" : { - "type" : "string", - "description" : "The number of flowfiles that are queued, pretty printed." - }, - "percentUseCount" : { - "type" : "integer", - "format" : "int32", - "description" : "Connection percent use regarding queued flow files count and backpressure threshold if configured." - }, - "percentUseBytes" : { - "type" : "integer", - "format" : "int32", - "description" : "Connection percent use regarding queued flow files size and backpressure threshold if configured." - } - } - }, - "ConnectionStatusSnapshotEntity" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the connection." - }, - "connectionStatusSnapshot" : { - "$ref" : "#/definitions/ConnectionStatusSnapshotDTO" - }, - "canRead" : { - "type" : "boolean", - "description" : "Indicates whether the user can read a given resource.", - "readOnly" : true - } - }, - "xml" : { - "name" : "entity" - } - }, - "ConnectionsEntity" : { - "type" : "object", - "properties" : { - "connections" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ConnectionEntity" - } - } - }, - "xml" : { - "name" : "connectionsEntity" - } - }, - "ControllerBulletinsEntity" : { - "type" : "object", - "properties" : { - "bulletins" : { - "type" : "array", - "description" : "System level bulletins to be reported to the user.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "controllerServiceBulletins" : { - "type" : "array", - "description" : "Controller service bulletins to be reported to the user.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "reportingTaskBulletins" : { - "type" : "array", - "description" : "Reporting task bulletins to be reported to the user.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - } - }, - "xml" : { - "name" : "controllerConfigurationEntity" - } - }, - "ControllerConfigurationDTO" : { - "type" : "object", - "properties" : { - "maxTimerDrivenThreadCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The maximum number of timer driven threads the NiFi has available." - }, - "maxEventDrivenThreadCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The maximum number of event driven threads the NiFi has available." - } - } - }, - "ControllerConfigurationEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "component" : { - "description" : "The controller configuration.", - "$ref" : "#/definitions/ControllerConfigurationDTO" - } - }, - "xml" : { - "name" : "controllerConfigurationEntity" - } - }, - "ControllerDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the NiFi." - }, - "name" : { - "type" : "string", - "description" : "The name of the NiFi." - }, - "comments" : { - "type" : "string", - "description" : "The comments for the NiFi." - }, - "runningCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of running components in the NiFi." - }, - "stoppedCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of stopped components in the NiFi." - }, - "invalidCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of invalid components in the NiFi." - }, - "disabledCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of disabled components in the NiFi." - }, - "activeRemotePortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of active remote ports contained in the NiFi." - }, - "inactiveRemotePortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of inactive remote ports contained in the NiFi." - }, - "inputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of input ports contained in the NiFi." - }, - "outputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of output ports in the NiFi." - }, - "remoteSiteListeningPort" : { - "type" : "integer", - "format" : "int32", - "description" : "The Socket Port on which this instance is listening for Remote Transfers of Flow Files. If this instance is not configured to receive Flow Files from remote instances, this will be null." - }, - "remoteSiteHttpListeningPort" : { - "type" : "integer", - "format" : "int32", - "description" : "The HTTP(S) Port on which this instance is listening for Remote Transfers of Flow Files. If this instance is not configured to receive Flow Files from remote instances, this will be null." - }, - "siteToSiteSecure" : { - "type" : "boolean", - "description" : "Indicates whether or not Site-to-Site communications with this instance is secure (2-way authentication)." - }, - "instanceId" : { - "type" : "string", - "description" : "If clustered, the id of the Cluster Manager, otherwise the id of the NiFi." - }, - "inputPorts" : { - "type" : "array", - "description" : "The input ports available to send data to for the NiFi.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/PortDTO" - } - }, - "outputPorts" : { - "type" : "array", - "description" : "The output ports available to received data from the NiFi.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/PortDTO" - } - } - } - }, - "ControllerEntity" : { - "type" : "object", - "properties" : { - "controller" : { - "$ref" : "#/definitions/ControllerDTO" - } - }, - "xml" : { - "name" : "controllerEntity" - } - }, - "ControllerServiceAPI" : { - "type" : "object", - "properties" : { - "type" : { - "type" : "string", - "description" : "The fully qualified name of the service interface." - }, - "bundle" : { - "description" : "The details of the artifact that bundled this service interface.", - "$ref" : "#/definitions/Bundle" - } - } - }, - "ControllerServiceApiDTO" : { - "type" : "object", - "properties" : { - "type" : { - "type" : "string", - "description" : "The fully qualified name of the service interface." - }, - "bundle" : { - "description" : "The details of the artifact that bundled this service interface.", - "$ref" : "#/definitions/BundleDTO" - } - } - }, - "ControllerServiceDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "versionedComponentId" : { - "type" : "string", - "description" : "The ID of the corresponding component that is under version control" - }, - "parentGroupId" : { - "type" : "string", - "description" : "The id of parent process group of this component if applicable." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "name" : { - "type" : "string", - "description" : "The name of the controller service." - }, - "type" : { - "type" : "string", - "description" : "The type of the controller service." - }, - "bundle" : { - "description" : "The details of the artifact that bundled this processor type.", - "$ref" : "#/definitions/BundleDTO" - }, - "controllerServiceApis" : { - "type" : "array", - "description" : "Lists the APIs this Controller Service implements.", - "items" : { - "$ref" : "#/definitions/ControllerServiceApiDTO" - } - }, - "comments" : { - "type" : "string", - "description" : "The comments for the controller service." - }, - "state" : { - "type" : "string", - "description" : "The state of the controller service.", - "enum" : [ "ENABLED", "ENABLING", "DISABLED", "DISABLING" ] - }, - "persistsState" : { - "type" : "boolean", - "description" : "Whether the controller service persists state." - }, - "restricted" : { - "type" : "boolean", - "description" : "Whether the controller service requires elevated privileges." - }, - "deprecated" : { - "type" : "boolean", - "description" : "Whether the ontroller service has been deprecated." - }, - "multipleVersionsAvailable" : { - "type" : "boolean", - "description" : "Whether the controller service has multiple versions available." - }, - "properties" : { - "type" : "object", - "description" : "The properties of the controller service.", - "additionalProperties" : { - "type" : "string" - } - }, - "descriptors" : { - "type" : "object", - "description" : "The descriptors for the controller service properties.", - "additionalProperties" : { - "$ref" : "#/definitions/PropertyDescriptorDTO" - } - }, - "customUiUrl" : { - "type" : "string", - "description" : "The URL for the controller services custom configuration UI if applicable." - }, - "annotationData" : { - "type" : "string", - "description" : "The annotation for the controller service. This is how the custom UI relays configuration to the controller service." - }, - "referencingComponents" : { - "type" : "array", - "description" : "All components referencing this controller service.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ControllerServiceReferencingComponentEntity" - } - }, - "validationErrors" : { - "type" : "array", - "description" : "The validation errors from the controller service. These validation errors represent the problems with the controller service that must be resolved before it can be enabled.", - "items" : { - "type" : "string" - } - }, - "validationStatus" : { - "type" : "string", - "description" : "Indicates whether the ControllerService is valid, invalid, or still in the process of validating (i.e., it is unknown whether or not the ControllerService is valid)", - "readOnly" : true, - "enum" : [ "VALID", "INVALID", "VALIDATING" ] - }, - "extensionMissing" : { - "type" : "boolean", - "description" : "Whether the underlying extension is missing." - } - } - }, - "ControllerServiceEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "parentGroupId" : { - "type" : "string", - "description" : "The id of parent process group of this ControllerService." - }, - "component" : { - "$ref" : "#/definitions/ControllerServiceDTO" - }, - "operatePermissions" : { - "description" : "The permissions for this component operations.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "status" : { - "description" : "The status for this ControllerService.", - "readOnly" : true, - "$ref" : "#/definitions/ControllerServiceStatusDTO" - } - }, - "xml" : { - "name" : "controllerServiceEntity" - } - }, - "ControllerServiceReferencingComponentDTO" : { - "type" : "object", - "properties" : { - "groupId" : { - "type" : "string", - "description" : "The group id for the component referencing a controller service. If this component is another controller service or a reporting task, this field is blank." - }, - "id" : { - "type" : "string", - "description" : "The id of the component referencing a controller service." - }, - "name" : { - "type" : "string", - "description" : "The name of the component referencing a controller service." - }, - "type" : { - "type" : "string", - "description" : "The type of the component referencing a controller service in simple Java class name format without package name." - }, - "state" : { - "type" : "string", - "description" : "The scheduled state of a processor or reporting task referencing a controller service. If this component is another controller service, this field represents the controller service state." - }, - "properties" : { - "type" : "object", - "description" : "The properties for the component.", - "additionalProperties" : { - "type" : "string" - } - }, - "descriptors" : { - "type" : "object", - "description" : "The descriptors for the component properties.", - "additionalProperties" : { - "$ref" : "#/definitions/PropertyDescriptorDTO" - } - }, - "validationErrors" : { - "type" : "array", - "description" : "The validation errors for the component.", - "items" : { - "type" : "string" - } - }, - "referenceType" : { - "type" : "string", - "description" : "The type of reference this is.", - "enum" : [ "Processor", "ControllerService", "ReportingTask" ] - }, - "activeThreadCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of active threads for the referencing component." - }, - "referenceCycle" : { - "type" : "boolean", - "description" : "If the referencing component represents a controller service, this indicates whether it has already been represented in this hierarchy." - }, - "referencingComponents" : { - "type" : "array", - "description" : "If the referencing component represents a controller service, these are the components that reference it.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ControllerServiceReferencingComponentEntity" - } - } - } - }, - "ControllerServiceReferencingComponentEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "component" : { - "$ref" : "#/definitions/ControllerServiceReferencingComponentDTO" - }, - "operatePermissions" : { - "description" : "The permissions for this component operations.", - "$ref" : "#/definitions/PermissionsDTO" - } - }, - "xml" : { - "name" : "controllerServiceReferencingComponentEntity" - } - }, - "ControllerServiceReferencingComponentsEntity" : { - "type" : "object", - "properties" : { - "controllerServiceReferencingComponents" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ControllerServiceReferencingComponentEntity" - } - } - }, - "xml" : { - "name" : "controllerServiceReferencingComponentsEntity" - } - }, - "ControllerServiceRunStatusEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "state" : { - "type" : "string", - "description" : "The run status of the ControllerService.", - "enum" : [ "ENABLED", "DISABLED" ] - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - } - }, - "xml" : { - "name" : "entity" - } - }, - "ControllerServiceStatusDTO" : { - "type" : "object", - "properties" : { - "runStatus" : { - "type" : "string", - "description" : "The run status of this ControllerService", - "readOnly" : true, - "enum" : [ "ENABLED", "ENABLING", "DISABLED", "DISABLING" ] - }, - "validationStatus" : { - "type" : "string", - "description" : "Indicates whether the component is valid, invalid, or still in the process of validating (i.e., it is unknown whether or not the component is valid)", - "readOnly" : true, - "enum" : [ "VALID", "INVALID", "VALIDATING" ] - }, - "activeThreadCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of active threads for the component." - } - } - }, - "ControllerServiceTypesEntity" : { - "type" : "object", - "properties" : { - "controllerServiceTypes" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/DocumentedTypeDTO" - } - } - }, - "xml" : { - "name" : "controllerServiceTypesEntity" - } - }, - "ControllerServicesEntity" : { - "type" : "object", - "properties" : { - "currentTime" : { - "type" : "string", - "description" : "The current time on the system." - }, - "controllerServices" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ControllerServiceEntity" - } - } - }, - "xml" : { - "name" : "controllerServicesEntity" - } - }, - "ControllerStatusDTO" : { - "type" : "object", - "properties" : { - "activeThreadCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of active threads in the NiFi." - }, - "terminatedThreadCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of terminated threads in the NiFi." - }, - "queued" : { - "type" : "string", - "description" : "The number of flowfiles queued in the NiFi." - }, - "flowFilesQueued" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of FlowFiles queued across the entire flow" - }, - "bytesQueued" : { - "type" : "integer", - "format" : "int64", - "description" : "The size of the FlowFiles queued across the entire flow" - }, - "runningCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of running components in the NiFi." - }, - "stoppedCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of stopped components in the NiFi." - }, - "invalidCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of invalid components in the NiFi." - }, - "disabledCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of disabled components in the NiFi." - }, - "activeRemotePortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of active remote ports in the NiFi." - }, - "inactiveRemotePortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of inactive remote ports in the NiFi." - }, - "upToDateCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of up to date versioned process groups in the NiFi." - }, - "locallyModifiedCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of locally modified versioned process groups in the NiFi." - }, - "staleCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of stale versioned process groups in the NiFi." - }, - "locallyModifiedAndStaleCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of locally modified and stale versioned process groups in the NiFi." - }, - "syncFailureCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of versioned process groups in the NiFi that are unable to sync to a registry." - } - } - }, - "ControllerStatusEntity" : { - "type" : "object", - "properties" : { - "controllerStatus" : { - "$ref" : "#/definitions/ControllerStatusDTO" - } - }, - "xml" : { - "name" : "controllerStatusEntity" - } - }, - "CopySnippetRequestEntity" : { - "type" : "object", - "properties" : { - "snippetId" : { - "type" : "string", - "description" : "The identifier of the snippet." - }, - "originX" : { - "type" : "number", - "format" : "double", - "description" : "The x coordinate of the origin of the bounding box where the new components will be placed." - }, - "originY" : { - "type" : "number", - "format" : "double", - "description" : "The y coordinate of the origin of the bounding box where the new components will be placed." - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - } - }, - "xml" : { - "name" : "copySnippetRequestEntity" - } - }, - "CounterDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the counter." - }, - "context" : { - "type" : "string", - "description" : "The context of the counter." - }, - "name" : { - "type" : "string", - "description" : "The name of the counter." - }, - "valueCount" : { - "type" : "integer", - "format" : "int64", - "description" : "The value count." - }, - "value" : { - "type" : "string", - "description" : "The value of the counter." - } - } - }, - "CounterEntity" : { - "type" : "object", - "properties" : { - "counter" : { - "$ref" : "#/definitions/CounterDTO" - } - }, - "xml" : { - "name" : "counterEntity" - } - }, - "CountersDTO" : { - "type" : "object", - "properties" : { - "aggregateSnapshot" : { - "description" : "A Counters snapshot that represents the aggregate values of all nodes in the cluster. If the NiFi instance is a standalone instance, rather than a cluster, this represents the stats of the single instance.", - "$ref" : "#/definitions/CountersSnapshotDTO" - }, - "nodeSnapshots" : { - "type" : "array", - "description" : "A Counters snapshot for each node in the cluster. If the NiFi instance is a standalone instance, rather than a cluster, this may be null.", - "items" : { - "$ref" : "#/definitions/NodeCountersSnapshotDTO" - } - } - } - }, - "CountersEntity" : { - "type" : "object", - "properties" : { - "counters" : { - "$ref" : "#/definitions/CountersDTO" - } - }, - "xml" : { - "name" : "countersEntity" - } - }, - "CountersSnapshotDTO" : { - "type" : "object", - "properties" : { - "generated" : { - "type" : "string", - "description" : "The timestamp when the report was generated." - }, - "counters" : { - "type" : "array", - "description" : "All counters in the NiFi.", - "items" : { - "$ref" : "#/definitions/CounterDTO" - } - } - } - }, - "CreateActiveRequestEntity" : { - "type" : "object", - "properties" : { - "processGroupId" : { - "type" : "string", - "description" : "The Process Group ID that this active request will update" - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - } - }, - "xml" : { - "name" : "createActiveRequestEntity" - } - }, - "CreateTemplateRequestEntity" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The name of the template." - }, - "description" : { - "type" : "string", - "description" : "The description of the template." - }, - "snippetId" : { - "type" : "string", - "description" : "The identifier of the snippet." - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - } - }, - "xml" : { - "name" : "createTemplateRequestEntity" - } - }, - "CurrentUserEntity" : { - "type" : "object", - "properties" : { - "identity" : { - "type" : "string", - "description" : "The user identity being serialized." - }, - "anonymous" : { - "type" : "boolean", - "description" : "Whether the current user is anonymous." - }, - "provenancePermissions" : { - "description" : "Permissions for querying provenance.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "countersPermissions" : { - "description" : "Permissions for accessing counters.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "tenantsPermissions" : { - "description" : "Permissions for accessing tenants.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "controllerPermissions" : { - "description" : "Permissions for accessing the controller.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "policiesPermissions" : { - "description" : "Permissions for accessing the policies.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "systemPermissions" : { - "description" : "Permissions for accessing system.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "parameterContextPermissions" : { - "description" : "Permissions for accessing parameter contexts.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "restrictedComponentsPermissions" : { - "description" : "Permissions for accessing restricted components. Note: the read permission are not used and will always be false.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "componentRestrictionPermissions" : { - "type" : "array", - "description" : "Permissions for specific component restrictions.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ComponentRestrictionPermissionDTO" - } - }, - "canVersionFlows" : { - "type" : "boolean", - "description" : "Whether the current user can version flows." - } - }, - "xml" : { - "name" : "currentEntity" - } - }, - "DifferenceDTO" : { - "type" : "object", - "properties" : { - "differenceType" : { - "type" : "string", - "description" : "The type of difference" - }, - "difference" : { - "type" : "string", - "description" : "Description of the difference" - } - } - }, - "DimensionsDTO" : { - "type" : "object", - "properties" : { - "width" : { - "type" : "number", - "format" : "double", - "description" : "The width of the label in pixels when at a 1:1 scale." - }, - "height" : { - "type" : "number", - "format" : "double", - "description" : "The height of the label in pixels when at a 1:1 scale." - } - } - }, - "DocumentedTypeDTO" : { - "type" : "object", - "properties" : { - "type" : { - "type" : "string", - "description" : "The fully qualified name of the type." - }, - "bundle" : { - "description" : "The details of the artifact that bundled this type.", - "$ref" : "#/definitions/BundleDTO" - }, - "controllerServiceApis" : { - "type" : "array", - "description" : "If this type represents a ControllerService, this lists the APIs it implements.", - "items" : { - "$ref" : "#/definitions/ControllerServiceApiDTO" - } - }, - "description" : { - "type" : "string", - "description" : "The description of the type." - }, - "restricted" : { - "type" : "boolean", - "description" : "Whether this type is restricted." - }, - "usageRestriction" : { - "type" : "string", - "description" : "The optional description of why the usage of this component is restricted." - }, - "explicitRestrictions" : { - "type" : "array", - "description" : "An optional collection of explicit restrictions. If specified, these explicit restrictions will be enfored.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ExplicitRestrictionDTO" - } - }, - "deprecationReason" : { - "type" : "string", - "description" : "The description of why the usage of this component is restricted." - }, - "tags" : { - "type" : "array", - "description" : "The tags associated with this type.", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - } - } - }, - "DropRequestDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id for this drop request." - }, - "uri" : { - "type" : "string", - "description" : "The URI for future requests to this drop request." - }, - "submissionTime" : { - "type" : "string", - "description" : "The timestamp when the query was submitted." - }, - "lastUpdated" : { - "type" : "string", - "description" : "The last time this drop request was updated." - }, - "percentCompleted" : { - "type" : "integer", - "format" : "int32", - "description" : "The current percent complete." - }, - "finished" : { - "type" : "boolean", - "description" : "Whether the query has finished." - }, - "failureReason" : { - "type" : "string", - "description" : "The reason, if any, that this drop request failed." - }, - "currentCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of flow files currently queued." - }, - "currentSize" : { - "type" : "integer", - "format" : "int64", - "description" : "The size of flow files currently queued in bytes." - }, - "current" : { - "type" : "string", - "description" : "The count and size of flow files currently queued." - }, - "originalCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of flow files to be dropped as a result of this request." - }, - "originalSize" : { - "type" : "integer", - "format" : "int64", - "description" : "The size of flow files to be dropped as a result of this request in bytes." - }, - "original" : { - "type" : "string", - "description" : "The count and size of flow files to be dropped as a result of this request." - }, - "droppedCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of flow files that have been dropped thus far." - }, - "droppedSize" : { - "type" : "integer", - "format" : "int64", - "description" : "The size of flow files that have been dropped thus far in bytes." - }, - "dropped" : { - "type" : "string", - "description" : "The count and size of flow files that have been dropped thus far." - }, - "state" : { - "type" : "string", - "description" : "The current state of the drop request." - } - } - }, - "DropRequestEntity" : { - "type" : "object", - "properties" : { - "dropRequest" : { - "$ref" : "#/definitions/DropRequestDTO" - } - }, - "xml" : { - "name" : "dropRequestEntity" - } - }, - "ExplicitRestrictionDTO" : { - "type" : "object", - "properties" : { - "requiredPermission" : { - "description" : "The required permission necessary for this restriction.", - "$ref" : "#/definitions/RequiredPermissionDTO" - }, - "explanation" : { - "type" : "string", - "description" : "The description of why the usage of this component is restricted for this required permission." - } - } - }, - "ExternalControllerServiceReference" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The identifier of the controller service" - }, - "name" : { - "type" : "string", - "description" : "The name of the controller service" - } - } - }, - "FlowBreadcrumbDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the group." - }, - "name" : { - "type" : "string", - "description" : "The id of the group." - }, - "versionControlInformation" : { - "description" : "The process group version control information or null if not version controlled.", - "$ref" : "#/definitions/VersionControlInformationDTO" - } - } - }, - "FlowBreadcrumbEntity" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of this ancestor ProcessGroup." - }, - "permissions" : { - "description" : "The permissions for this ancestor ProcessGroup.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "versionedFlowState" : { - "type" : "string", - "description" : "The current state of the Process Group, as it relates to the Versioned Flow", - "readOnly" : true, - "enum" : [ "LOCALLY_MODIFIED", "STALE", "LOCALLY_MODIFIED_AND_STALE", "UP_TO_DATE", "SYNC_FAILURE" ] - }, - "breadcrumb" : { - "description" : "This breadcrumb.", - "$ref" : "#/definitions/FlowBreadcrumbDTO" - }, - "parentBreadcrumb" : { - "description" : "The parent breadcrumb for this breadcrumb.", - "$ref" : "#/definitions/FlowBreadcrumbEntity" - } - }, - "xml" : { - "name" : "flowEntity" - } - }, - "FlowComparisonEntity" : { - "type" : "object", - "properties" : { - "componentDifferences" : { - "type" : "array", - "description" : "The list of differences for each component in the flow that is not the same between the two flows", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ComponentDifferenceDTO" - } - } - }, - "xml" : { - "name" : "flowComparisonEntity" - } - }, - "FlowConfigurationDTO" : { - "type" : "object", - "properties" : { - "supportsManagedAuthorizer" : { - "type" : "boolean", - "description" : "Whether this NiFi supports a managed authorizer. Managed authorizers can visualize users, groups, and policies in the UI.", - "readOnly" : true - }, - "supportsConfigurableAuthorizer" : { - "type" : "boolean", - "description" : "Whether this NiFi supports a configurable authorizer.", - "readOnly" : true - }, - "supportsConfigurableUsersAndGroups" : { - "type" : "boolean", - "description" : "Whether this NiFi supports configurable users and groups.", - "readOnly" : true - }, - "autoRefreshIntervalSeconds" : { - "type" : "integer", - "format" : "int64", - "description" : "The interval in seconds between the automatic NiFi refresh requests.", - "readOnly" : true - }, - "currentTime" : { - "type" : "string", - "description" : "The current time on the system." - }, - "timeOffset" : { - "type" : "integer", - "format" : "int32", - "description" : "The time offset of the system." - }, - "defaultBackPressureObjectThreshold" : { - "type" : "integer", - "format" : "int64", - "description" : "The default back pressure object threshold." - }, - "defaultBackPressureDataSizeThreshold" : { - "type" : "string", - "description" : "The default back pressure data size threshold." - } - } - }, - "FlowConfigurationEntity" : { - "type" : "object", - "properties" : { - "flowConfiguration" : { - "description" : "The controller configuration.", - "$ref" : "#/definitions/FlowConfigurationDTO" - } - }, - "xml" : { - "name" : "flowConfigurationEntity" - } - }, - "FlowDTO" : { - "type" : "object", - "properties" : { - "processGroups" : { - "type" : "array", - "description" : "The process groups in this flow.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ProcessGroupEntity" - } - }, - "remoteProcessGroups" : { - "type" : "array", - "description" : "The remote process groups in this flow.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/RemoteProcessGroupEntity" - } - }, - "processors" : { - "type" : "array", - "description" : "The processors in this flow.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ProcessorEntity" - } - }, - "inputPorts" : { - "type" : "array", - "description" : "The input ports in this flow.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/PortEntity" - } - }, - "outputPorts" : { - "type" : "array", - "description" : "The output ports in this flow.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/PortEntity" - } - }, - "connections" : { - "type" : "array", - "description" : "The connections in this flow.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ConnectionEntity" - } - }, - "labels" : { - "type" : "array", - "description" : "The labels in this flow.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/LabelEntity" - } - }, - "funnels" : { - "type" : "array", - "description" : "The funnels in this flow.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/FunnelEntity" - } - } - } - }, - "FlowEntity" : { - "type" : "object", - "properties" : { - "flow" : { - "$ref" : "#/definitions/FlowDTO" - } - }, - "xml" : { - "name" : "flowEntity" - } - }, - "FlowFileDTO" : { - "type" : "object", - "properties" : { - "uri" : { - "type" : "string", - "description" : "The URI that can be used to access this FlowFile." - }, - "uuid" : { - "type" : "string", - "description" : "The FlowFile UUID." - }, - "filename" : { - "type" : "string", - "description" : "The FlowFile filename." - }, - "position" : { - "type" : "integer", - "format" : "int32", - "description" : "The FlowFile's position in the queue." - }, - "size" : { - "type" : "integer", - "format" : "int64", - "description" : "The FlowFile file size." - }, - "queuedDuration" : { - "type" : "integer", - "format" : "int64", - "description" : "How long this FlowFile has been enqueued." - }, - "lineageDuration" : { - "type" : "integer", - "format" : "int64", - "description" : "Duration since the FlowFile's greatest ancestor entered the flow." - }, - "penaltyExpiresIn" : { - "type" : "integer", - "format" : "int64", - "description" : "How long in milliseconds until the FlowFile penalty expires." - }, - "clusterNodeId" : { - "type" : "string", - "description" : "The id of the node where this FlowFile resides." - }, - "clusterNodeAddress" : { - "type" : "string", - "description" : "The label for the node where this FlowFile resides." - }, - "attributes" : { - "type" : "object", - "description" : "The FlowFile attributes.", - "additionalProperties" : { - "type" : "string" - } - }, - "contentClaimSection" : { - "type" : "string", - "description" : "The section in which the content claim lives." - }, - "contentClaimContainer" : { - "type" : "string", - "description" : "The container in which the content claim lives." - }, - "contentClaimIdentifier" : { - "type" : "string", - "description" : "The identifier of the content claim." - }, - "contentClaimOffset" : { - "type" : "integer", - "format" : "int64", - "description" : "The offset into the content claim where the flowfile's content begins." - }, - "contentClaimFileSize" : { - "type" : "string", - "description" : "The file size of the content claim formatted." - }, - "contentClaimFileSizeBytes" : { - "type" : "integer", - "format" : "int64", - "description" : "The file size of the content claim in bytes." - }, - "penalized" : { - "type" : "boolean", - "description" : "If the FlowFile is penalized." - } - } - }, - "FlowFileEntity" : { - "type" : "object", - "properties" : { - "flowFile" : { - "$ref" : "#/definitions/FlowFileDTO" - } - }, - "xml" : { - "name" : "flowFileEntity" - } - }, - "FlowFileSummaryDTO" : { - "type" : "object", - "properties" : { - "uri" : { - "type" : "string", - "description" : "The URI that can be used to access this FlowFile." - }, - "uuid" : { - "type" : "string", - "description" : "The FlowFile UUID." - }, - "filename" : { - "type" : "string", - "description" : "The FlowFile filename." - }, - "position" : { - "type" : "integer", - "format" : "int32", - "description" : "The FlowFile's position in the queue." - }, - "size" : { - "type" : "integer", - "format" : "int64", - "description" : "The FlowFile file size." - }, - "queuedDuration" : { - "type" : "integer", - "format" : "int64", - "description" : "How long this FlowFile has been enqueued." - }, - "lineageDuration" : { - "type" : "integer", - "format" : "int64", - "description" : "Duration since the FlowFile's greatest ancestor entered the flow." - }, - "penaltyExpiresIn" : { - "type" : "integer", - "format" : "int64", - "description" : "How long in milliseconds until the FlowFile penalty expires." - }, - "clusterNodeId" : { - "type" : "string", - "description" : "The id of the node where this FlowFile resides." - }, - "clusterNodeAddress" : { - "type" : "string", - "description" : "The label for the node where this FlowFile resides." - }, - "penalized" : { - "type" : "boolean", - "description" : "If the FlowFile is penalized." - } - } - }, - "FlowSnippetDTO" : { - "type" : "object", - "properties" : { - "processGroups" : { - "type" : "array", - "description" : "The process groups in this flow snippet.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ProcessGroupDTO" - } - }, - "remoteProcessGroups" : { - "type" : "array", - "description" : "The remote process groups in this flow snippet.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/RemoteProcessGroupDTO" - } - }, - "processors" : { - "type" : "array", - "description" : "The processors in this flow snippet.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ProcessorDTO" - } - }, - "inputPorts" : { - "type" : "array", - "description" : "The input ports in this flow snippet.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/PortDTO" - } - }, - "outputPorts" : { - "type" : "array", - "description" : "The output ports in this flow snippet.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/PortDTO" - } - }, - "connections" : { - "type" : "array", - "description" : "The connections in this flow snippet.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ConnectionDTO" - } - }, - "labels" : { - "type" : "array", - "description" : "The labels in this flow snippet.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/LabelDTO" - } - }, - "funnels" : { - "type" : "array", - "description" : "The funnels in this flow snippet.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/FunnelDTO" - } - }, - "controllerServices" : { - "type" : "array", - "description" : "The controller services in this flow snippet.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ControllerServiceDTO" - } - } - } - }, - "FunnelDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "versionedComponentId" : { - "type" : "string", - "description" : "The ID of the corresponding component that is under version control" - }, - "parentGroupId" : { - "type" : "string", - "description" : "The id of parent process group of this component if applicable." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - } - } - }, - "FunnelEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "component" : { - "$ref" : "#/definitions/FunnelDTO" - } - }, - "xml" : { - "name" : "funnelEntity" - } - }, - "FunnelsEntity" : { - "type" : "object", - "properties" : { - "funnels" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/FunnelEntity" - } - } - }, - "xml" : { - "name" : "funnelsEntity" - } - }, - "GarbageCollectionDTO" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The name of the garbage collector." - }, - "collectionCount" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of times garbage collection has run." - }, - "collectionTime" : { - "type" : "string", - "description" : "The total amount of time spent garbage collecting." - }, - "collectionMillis" : { - "type" : "integer", - "format" : "int64", - "description" : "The total number of milliseconds spent garbage collecting." - } - } - }, - "HistoryDTO" : { - "type" : "object", - "properties" : { - "total" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of number of actions that matched the search criteria.." - }, - "lastRefreshed" : { - "type" : "string", - "description" : "The timestamp when the report was generated." - }, - "actions" : { - "type" : "array", - "description" : "The actions.", - "items" : { - "$ref" : "#/definitions/ActionEntity" - } - } - } - }, - "HistoryEntity" : { - "type" : "object", - "properties" : { - "history" : { - "$ref" : "#/definitions/HistoryDTO" - } - }, - "xml" : { - "name" : "historyEntity" - } - }, - "InputPortsEntity" : { - "type" : "object", - "properties" : { - "inputPorts" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/PortEntity" - } - } - }, - "xml" : { - "name" : "inputPortsEntity" - } - }, - "InstantiateTemplateRequestEntity" : { - "type" : "object", - "properties" : { - "originX" : { - "type" : "number", - "format" : "double", - "description" : "The x coordinate of the origin of the bounding box where the new components will be placed." - }, - "originY" : { - "type" : "number", - "format" : "double", - "description" : "The y coordinate of the origin of the bounding box where the new components will be placed." - }, - "templateId" : { - "type" : "string", - "description" : "The identifier of the template." - }, - "encodingVersion" : { - "type" : "string", - "description" : "The encoding version of the flow snippet. If not specified, this is automatically populated by the node receiving the user request. If the snippet is specified, the version will be the latest. If the snippet is not specified, the version will come from the underlying template. These details need to be replicated throughout the cluster to ensure consistency." - }, - "snippet" : { - "description" : "A flow snippet of the template contents. If not specified, this is automatically populated by the node receiving the user request. These details need to be replicated throughout the cluster to ensure consistency.", - "$ref" : "#/definitions/FlowSnippetDTO" - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - } - }, - "xml" : { - "name" : "instantiateTemplateRequestEntity" - } - }, - "JaxbLink" : { - "type" : "object", - "properties" : { - "href" : { - "type" : "string", - "format" : "uri", - "xml" : { - "attribute" : true - }, - "description" : "The href for the link" - }, - "params" : { - "type" : "object", - "description" : "The params for the link", - "additionalProperties" : { - "type" : "string" - } - } - } - }, - "LabelDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "versionedComponentId" : { - "type" : "string", - "description" : "The ID of the corresponding component that is under version control" - }, - "parentGroupId" : { - "type" : "string", - "description" : "The id of parent process group of this component if applicable." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "label" : { - "type" : "string", - "description" : "The text that appears in the label." - }, - "width" : { - "type" : "number", - "format" : "double", - "description" : "The width of the label in pixels when at a 1:1 scale." - }, - "height" : { - "type" : "number", - "format" : "double", - "description" : "The height of the label in pixels when at a 1:1 scale." - }, - "style" : { - "type" : "object", - "description" : "The styles for this label (font-size : 12px, background-color : #eee, etc).", - "additionalProperties" : { - "type" : "string" - } - } - } - }, - "LabelEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "dimensions" : { - "$ref" : "#/definitions/DimensionsDTO" - }, - "component" : { - "$ref" : "#/definitions/LabelDTO" - } - }, - "xml" : { - "name" : "labelEntity" - } - }, - "LabelsEntity" : { - "type" : "object", - "properties" : { - "labels" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/LabelEntity" - } - } - }, - "xml" : { - "name" : "labelsEntity" - } - }, - "LineageDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of this lineage query." - }, - "uri" : { - "type" : "string", - "description" : "The URI for this lineage query for later retrieval and deletion." - }, - "submissionTime" : { - "type" : "string", - "description" : "When the lineage query was submitted." - }, - "expiration" : { - "type" : "string", - "description" : "When the lineage query will expire." - }, - "percentCompleted" : { - "type" : "integer", - "format" : "int32", - "description" : "The percent complete for the lineage query." - }, - "finished" : { - "type" : "boolean", - "description" : "Whether the lineage query has finished." - }, - "request" : { - "description" : "The initial lineage result.", - "$ref" : "#/definitions/LineageRequestDTO" - }, - "results" : { - "description" : "The results of the lineage query.", - "$ref" : "#/definitions/LineageResultsDTO" - } - } - }, - "LineageEntity" : { - "type" : "object", - "properties" : { - "lineage" : { - "$ref" : "#/definitions/LineageDTO" - } - }, - "xml" : { - "name" : "lineageEntity" - } - }, - "LineageRequestDTO" : { - "type" : "object", - "properties" : { - "eventId" : { - "type" : "integer", - "format" : "int64", - "description" : "The event id that was used to generate this lineage, if applicable. The event id is allowed for any type of lineageRequestType. If the lineageRequestType is FLOWFILE and the flowfile uuid is also included in the request, the event id will be ignored." - }, - "lineageRequestType" : { - "type" : "string", - "description" : "The type of lineage request. PARENTS will return the lineage for the flowfiles that are parents of the specified event. CHILDREN will return the lineage for the flowfiles that are children of the specified event. FLOWFILE will return the lineage for the specified flowfile.", - "enum" : [ "PARENTS", "CHILDREN", "and FLOWFILE" ] - }, - "uuid" : { - "type" : "string", - "description" : "The flowfile uuid that was used to generate the lineage. The flowfile uuid is only allowed when the lineageRequestType is FLOWFILE and will take precedence over event id." - }, - "clusterNodeId" : { - "type" : "string", - "description" : "The id of the node where this lineage originated if clustered." - } - } - }, - "LineageResultsDTO" : { - "type" : "object", - "properties" : { - "errors" : { - "type" : "array", - "description" : "Any errors that occurred while generating the lineage.", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - }, - "nodes" : { - "type" : "array", - "description" : "The nodes in the lineage.", - "items" : { - "$ref" : "#/definitions/ProvenanceNodeDTO" - } - }, - "links" : { - "type" : "array", - "description" : "The links between the nodes in the lineage.", - "items" : { - "$ref" : "#/definitions/ProvenanceLinkDTO" - } - } - } - }, - "ListingRequestDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id for this listing request." - }, - "uri" : { - "type" : "string", - "description" : "The URI for future requests to this listing request." - }, - "submissionTime" : { - "type" : "string", - "description" : "The timestamp when the query was submitted." - }, - "lastUpdated" : { - "type" : "string", - "description" : "The last time this listing request was updated." - }, - "percentCompleted" : { - "type" : "integer", - "format" : "int32", - "description" : "The current percent complete." - }, - "finished" : { - "type" : "boolean", - "description" : "Whether the query has finished." - }, - "failureReason" : { - "type" : "string", - "description" : "The reason, if any, that this listing request failed." - }, - "maxResults" : { - "type" : "integer", - "format" : "int32", - "description" : "The maximum number of FlowFileSummary objects to return" - }, - "state" : { - "type" : "string", - "description" : "The current state of the listing request." - }, - "queueSize" : { - "description" : "The size of the queue", - "$ref" : "#/definitions/QueueSizeDTO" - }, - "flowFileSummaries" : { - "type" : "array", - "description" : "The FlowFile summaries. The summaries will be populated once the request has completed.", - "items" : { - "$ref" : "#/definitions/FlowFileSummaryDTO" - } - }, - "sourceRunning" : { - "type" : "boolean", - "description" : "Whether the source of the connection is running" - }, - "destinationRunning" : { - "type" : "boolean", - "description" : "Whether the destination of the connection is running" - } - } - }, - "ListingRequestEntity" : { - "type" : "object", - "properties" : { - "listingRequest" : { - "$ref" : "#/definitions/ListingRequestDTO" - } - }, - "xml" : { - "name" : "listingRequestEntity" - } - }, - "NodeConnectionStatisticsSnapshotDTO" : { - "type" : "object", - "properties" : { - "nodeId" : { - "type" : "string", - "description" : "The unique ID that identifies the node" - }, - "address" : { - "type" : "string", - "description" : "The API address of the node" - }, - "apiPort" : { - "type" : "integer", - "format" : "int32", - "description" : "The API port used to communicate with the node" - }, - "statisticsSnapshot" : { - "description" : "The connection status snapshot from the node.", - "$ref" : "#/definitions/ConnectionStatisticsSnapshotDTO" - } - } - }, - "NodeConnectionStatusSnapshotDTO" : { - "type" : "object", - "properties" : { - "nodeId" : { - "type" : "string", - "description" : "The unique ID that identifies the node" - }, - "address" : { - "type" : "string", - "description" : "The API address of the node" - }, - "apiPort" : { - "type" : "integer", - "format" : "int32", - "description" : "The API port used to communicate with the node" - }, - "statusSnapshot" : { - "description" : "The connection status snapshot from the node.", - "$ref" : "#/definitions/ConnectionStatusSnapshotDTO" - } - } - }, - "NodeCountersSnapshotDTO" : { - "type" : "object", - "properties" : { - "nodeId" : { - "type" : "string", - "description" : "The unique ID that identifies the node" - }, - "address" : { - "type" : "string", - "description" : "The API address of the node" - }, - "apiPort" : { - "type" : "integer", - "format" : "int32", - "description" : "The API port used to communicate with the node" - }, - "snapshot" : { - "description" : "The counters from the node.", - "$ref" : "#/definitions/CountersSnapshotDTO" - } - } - }, - "NodeDTO" : { - "type" : "object", - "properties" : { - "nodeId" : { - "type" : "string", - "description" : "The id of the node.", - "readOnly" : true - }, - "address" : { - "type" : "string", - "description" : "The node's host/ip address.", - "readOnly" : true - }, - "apiPort" : { - "type" : "integer", - "format" : "int32", - "description" : "The port the node is listening for API requests.", - "readOnly" : true - }, - "status" : { - "type" : "string", - "description" : "The node's status." - }, - "heartbeat" : { - "type" : "string", - "description" : "the time of the nodes's last heartbeat.", - "readOnly" : true - }, - "connectionRequested" : { - "type" : "string", - "description" : "The time of the node's last connection request.", - "readOnly" : true - }, - "roles" : { - "type" : "array", - "description" : "The roles of this node.", - "readOnly" : true, - "uniqueItems" : true, - "items" : { - "type" : "string" - } - }, - "activeThreadCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The active threads for the NiFi on the node.", - "readOnly" : true - }, - "queued" : { - "type" : "string", - "description" : "The queue the NiFi on the node.", - "readOnly" : true - }, - "events" : { - "type" : "array", - "description" : "The node's events.", - "readOnly" : true, - "items" : { - "$ref" : "#/definitions/NodeEventDTO" - } - }, - "nodeStartTime" : { - "type" : "string", - "description" : "The time at which this Node was last refreshed.", - "readOnly" : true - } - } - }, - "NodeEntity" : { - "type" : "object", - "properties" : { - "node" : { - "$ref" : "#/definitions/NodeDTO" - } - }, - "xml" : { - "name" : "nodeEntity" - } - }, - "NodeEventDTO" : { - "type" : "object", - "properties" : { - "timestamp" : { - "type" : "string", - "description" : "The timestamp of the node event." - }, - "category" : { - "type" : "string", - "description" : "The category of the node event." - }, - "message" : { - "type" : "string", - "description" : "The message in the node event." - } - } - }, - "NodePortStatusSnapshotDTO" : { - "type" : "object", - "properties" : { - "nodeId" : { - "type" : "string", - "description" : "The unique ID that identifies the node" - }, - "address" : { - "type" : "string", - "description" : "The API address of the node" - }, - "apiPort" : { - "type" : "integer", - "format" : "int32", - "description" : "The API port used to communicate with the node" - }, - "statusSnapshot" : { - "description" : "The port status snapshot from the node.", - "$ref" : "#/definitions/PortStatusSnapshotDTO" - } - } - }, - "NodeProcessGroupStatusSnapshotDTO" : { - "type" : "object", - "properties" : { - "nodeId" : { - "type" : "string", - "description" : "The unique ID that identifies the node" - }, - "address" : { - "type" : "string", - "description" : "The API address of the node" - }, - "apiPort" : { - "type" : "integer", - "format" : "int32", - "description" : "The API port used to communicate with the node" - }, - "statusSnapshot" : { - "description" : "The process group status snapshot from the node.", - "$ref" : "#/definitions/ProcessGroupStatusSnapshotDTO" - } - } - }, - "NodeProcessorStatusSnapshotDTO" : { - "type" : "object", - "properties" : { - "nodeId" : { - "type" : "string", - "description" : "The unique ID that identifies the node" - }, - "address" : { - "type" : "string", - "description" : "The API address of the node" - }, - "apiPort" : { - "type" : "integer", - "format" : "int32", - "description" : "The API port used to communicate with the node" - }, - "statusSnapshot" : { - "description" : "The processor status snapshot from the node.", - "$ref" : "#/definitions/ProcessorStatusSnapshotDTO" - } - } - }, - "NodeRemoteProcessGroupStatusSnapshotDTO" : { - "type" : "object", - "properties" : { - "nodeId" : { - "type" : "string", - "description" : "The unique ID that identifies the node" - }, - "address" : { - "type" : "string", - "description" : "The API address of the node" - }, - "apiPort" : { - "type" : "integer", - "format" : "int32", - "description" : "The API port used to communicate with the node" - }, - "statusSnapshot" : { - "description" : "The remote process group status snapshot from the node.", - "$ref" : "#/definitions/RemoteProcessGroupStatusSnapshotDTO" - } - } - }, - "NodeSearchResultDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the node that matched the search." - }, - "address" : { - "type" : "string", - "description" : "The address of the node that matched the search." - } - } - }, - "NodeStatusSnapshotsDTO" : { - "type" : "object", - "properties" : { - "nodeId" : { - "type" : "string", - "description" : "The id of the node." - }, - "address" : { - "type" : "string", - "description" : "The node's host/ip address." - }, - "apiPort" : { - "type" : "integer", - "format" : "int32", - "description" : "The port the node is listening for API requests." - }, - "statusSnapshots" : { - "type" : "array", - "description" : "A list of StatusSnapshotDTO objects that provide the actual metric values for the component for this node.", - "items" : { - "$ref" : "#/definitions/StatusSnapshotDTO" - } - } - } - }, - "NodeSystemDiagnosticsSnapshotDTO" : { - "type" : "object", - "properties" : { - "nodeId" : { - "type" : "string", - "description" : "The unique ID that identifies the node" - }, - "address" : { - "type" : "string", - "description" : "The API address of the node" - }, - "apiPort" : { - "type" : "integer", - "format" : "int32", - "description" : "The API port used to communicate with the node" - }, - "snapshot" : { - "description" : "The System Diagnostics snapshot from the node.", - "$ref" : "#/definitions/SystemDiagnosticsSnapshotDTO" - } - } - }, - "OutputPortsEntity" : { - "type" : "object", - "properties" : { - "outputPorts" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/PortEntity" - } - } - }, - "xml" : { - "name" : "outputPortsEntity" - } - }, - "ParameterContextDTO" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The Name of the Parameter Context." - }, - "description" : { - "type" : "string", - "description" : "The Description of the Parameter Context." - }, - "parameters" : { - "type" : "array", - "description" : "The Parameters for the Parameter Context", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ParameterEntity" - } - }, - "boundProcessGroups" : { - "type" : "array", - "description" : "The Process Groups that are bound to this Parameter Context", - "readOnly" : true, - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ProcessGroupEntity" - } - }, - "id" : { - "type" : "string", - "description" : "The ID the Parameter Context.", - "readOnly" : true - } - } - }, - "ParameterContextEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "component" : { - "description" : "The Parameter Context", - "$ref" : "#/definitions/ParameterContextDTO" - } - }, - "xml" : { - "name" : "parameterContextEntity" - } - }, - "ParameterContextReferenceDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The ID of the Parameter Context" - }, - "name" : { - "type" : "string", - "description" : "The name of the Parameter Context" - } - } - }, - "ParameterContextReferenceEntity" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "component" : { - "$ref" : "#/definitions/ParameterContextReferenceDTO" - } - }, - "xml" : { - "name" : "parameterContextReferenceEntity" - } - }, - "ParameterContextUpdateRequestDTO" : { - "type" : "object", - "properties" : { - "requestId" : { - "type" : "string", - "description" : "The ID of the request", - "readOnly" : true - }, - "uri" : { - "type" : "string", - "description" : "The URI for the request", - "readOnly" : true - }, - "submissionTime" : { - "type" : "string", - "format" : "date-time", - "description" : "The timestamp of when the request was submitted", - "readOnly" : true - }, - "lastUpdated" : { - "type" : "string", - "format" : "date-time", - "description" : "The timestamp of when the request was last updated", - "readOnly" : true - }, - "complete" : { - "type" : "boolean", - "description" : "Whether or not the request is completed", - "readOnly" : true - }, - "failureReason" : { - "type" : "string", - "description" : "The reason for the request failing, or null if the request has not failed", - "readOnly" : true - }, - "percentCompleted" : { - "type" : "integer", - "format" : "int32", - "description" : "A value between 0 and 100 (inclusive) indicating how close the request is to completion", - "readOnly" : true - }, - "state" : { - "type" : "string", - "description" : "A description of the current state of the request", - "readOnly" : true - }, - "updateSteps" : { - "type" : "array", - "description" : "The steps that are required in order to complete the request, along with the status of each", - "readOnly" : true, - "items" : { - "$ref" : "#/definitions/ParameterContextUpdateStepDTO" - } - }, - "parameterContext" : { - "description" : "The Parameter Context that is being operated on. This may not be populated until the request has successfully completed.", - "readOnly" : true, - "$ref" : "#/definitions/ParameterContextDTO" - }, - "referencingComponents" : { - "type" : "array", - "description" : "The components that are referenced by the update.", - "readOnly" : true, - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/AffectedComponentEntity" - } - } - } - }, - "ParameterContextUpdateRequestEntity" : { - "type" : "object", - "properties" : { - "parameterContextRevision" : { - "description" : "The Revision of the Parameter Context", - "$ref" : "#/definitions/RevisionDTO" - }, - "request" : { - "description" : "The Update Request", - "$ref" : "#/definitions/ParameterContextUpdateRequestDTO" - } - }, - "xml" : { - "name" : "parameterContextUpdateRequestEntity" - } - }, - "ParameterContextUpdateStepDTO" : { - "type" : "object", - "properties" : { - "description" : { - "type" : "string", - "description" : "Explanation of what happens in this step", - "readOnly" : true - }, - "complete" : { - "type" : "boolean", - "description" : "Whether or not this step has completed", - "readOnly" : true - }, - "failureReason" : { - "type" : "string", - "description" : "An explanation of why this step failed, or null if this step did not fail", - "readOnly" : true - } - } - }, - "ParameterContextValidationRequestDTO" : { - "type" : "object", - "properties" : { - "requestId" : { - "type" : "string", - "description" : "The ID of the request", - "readOnly" : true - }, - "uri" : { - "type" : "string", - "description" : "The URI for the request", - "readOnly" : true - }, - "submissionTime" : { - "type" : "string", - "format" : "date-time", - "description" : "The timestamp of when the request was submitted", - "readOnly" : true - }, - "lastUpdated" : { - "type" : "string", - "format" : "date-time", - "description" : "The timestamp of when the request was last updated", - "readOnly" : true - }, - "complete" : { - "type" : "boolean", - "description" : "Whether or not the request is completed", - "readOnly" : true - }, - "failureReason" : { - "type" : "string", - "description" : "The reason for the request failing, or null if the request has not failed", - "readOnly" : true - }, - "percentCompleted" : { - "type" : "integer", - "format" : "int32", - "description" : "A value between 0 and 100 (inclusive) indicating how close the request is to completion", - "readOnly" : true - }, - "state" : { - "type" : "string", - "description" : "A description of the current state of the request", - "readOnly" : true - }, - "updateSteps" : { - "type" : "array", - "description" : "The steps that are required in order to complete the request, along with the status of each", - "readOnly" : true, - "items" : { - "$ref" : "#/definitions/ParameterContextValidationStepDTO" - } - }, - "parameterContext" : { - "description" : "The Parameter Context that is being operated on.", - "$ref" : "#/definitions/ParameterContextDTO" - }, - "componentValidationResults" : { - "description" : "The Validation Results that were calculated for each component. This value may not be set until the request completes.", - "readOnly" : true, - "$ref" : "#/definitions/ComponentValidationResultsEntity" - } - } - }, - "ParameterContextValidationRequestEntity" : { - "type" : "object", - "properties" : { - "request" : { - "description" : "The Update Request", - "$ref" : "#/definitions/ParameterContextValidationRequestDTO" - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - } - }, - "xml" : { - "name" : "parameterContextValidationRequestEntity" - } - }, - "ParameterContextValidationStepDTO" : { - "type" : "object", - "properties" : { - "description" : { - "type" : "string", - "description" : "Explanation of what happens in this step", - "readOnly" : true - }, - "complete" : { - "type" : "boolean", - "description" : "Whether or not this step has completed", - "readOnly" : true - }, - "failureReason" : { - "type" : "string", - "description" : "An explanation of why this step failed, or null if this step did not fail", - "readOnly" : true - } - } - }, - "ParameterContextsEntity" : { - "type" : "object", - "properties" : { - "parameterContexts" : { - "type" : "array", - "description" : "The Parameter Contexts", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ParameterContextEntity" - } - }, - "currentTime" : { - "type" : "string", - "description" : "The current time on the system.", - "readOnly" : true - } - }, - "xml" : { - "name" : "parameterContexts" - } - }, - "ParameterDTO" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The name of the Parameter" - }, - "description" : { - "type" : "string", - "description" : "The description of the Parameter" - }, - "sensitive" : { - "type" : "boolean", - "description" : "Whether or not the Parameter is sensitive" - }, - "value" : { - "type" : "string", - "description" : "The value of the Parameter" - }, - "referencingComponents" : { - "type" : "array", - "description" : "The set of all components in the flow that are referencing this Parameter", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/AffectedComponentEntity" - } - } - } - }, - "ParameterEntity" : { - "type" : "object", - "properties" : { - "canWrite" : { - "type" : "boolean", - "description" : "Indicates whether the user can write a given resource.", - "readOnly" : true - }, - "parameter" : { - "description" : "The parameter information", - "$ref" : "#/definitions/ParameterDTO" - } - }, - "xml" : { - "name" : "parameterEntity" - } - }, - "PeerDTO" : { - "type" : "object", - "properties" : { - "hostname" : { - "type" : "string", - "description" : "The hostname of this peer." - }, - "port" : { - "type" : "integer", - "format" : "int32", - "description" : "The port number of this peer." - }, - "secure" : { - "type" : "boolean", - "description" : "Returns if this peer connection is secure." - }, - "flowFileCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of flowFiles this peer holds." - } - } - }, - "PeersEntity" : { - "type" : "object", - "properties" : { - "peers" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/PeerDTO" - } - } - }, - "xml" : { - "name" : "peersEntity" - } - }, - "Permissions" : { - "type" : "object", - "properties" : { - "canRead" : { - "type" : "boolean", - "description" : "Indicates whether the user can read a given resource.", - "readOnly" : true - }, - "canWrite" : { - "type" : "boolean", - "description" : "Indicates whether the user can write a given resource.", - "readOnly" : true - }, - "canDelete" : { - "type" : "boolean", - "description" : "Indicates whether the user can delete a given resource.", - "readOnly" : true - } - } - }, - "PermissionsDTO" : { - "type" : "object", - "properties" : { - "canRead" : { - "type" : "boolean", - "description" : "Indicates whether the user can read a given resource.", - "readOnly" : true - }, - "canWrite" : { - "type" : "boolean", - "description" : "Indicates whether the user can write a given resource.", - "readOnly" : true - } - } - }, - "PortDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "versionedComponentId" : { - "type" : "string", - "description" : "The ID of the corresponding component that is under version control" - }, - "parentGroupId" : { - "type" : "string", - "description" : "The id of parent process group of this component if applicable." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "name" : { - "type" : "string", - "description" : "The name of the port." - }, - "comments" : { - "type" : "string", - "description" : "The comments for the port." - }, - "state" : { - "type" : "string", - "description" : "The state of the port.", - "enum" : [ "RUNNING", "STOPPED", "DISABLED" ] - }, - "type" : { - "type" : "string", - "description" : "The type of port.", - "enum" : [ "INPUT_PORT", "OUTPUT_PORT" ] - }, - "transmitting" : { - "type" : "boolean", - "description" : "Whether the port has incoming or output connections to a remote NiFi. This is only applicable when the port is allowed to be accessed remotely." - }, - "concurrentlySchedulableTaskCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of tasks that should be concurrently scheduled for the port." - }, - "userAccessControl" : { - "type" : "array", - "description" : "The users that are allowed to access the port.", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - }, - "groupAccessControl" : { - "type" : "array", - "description" : "The user groups that are allowed to access the port.", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - }, - "allowRemoteAccess" : { - "type" : "boolean", - "description" : "Whether this port can be accessed remotely via Site-to-Site protocol." - }, - "validationErrors" : { - "type" : "array", - "description" : "Gets the validation errors from this port. These validation errors represent the problems with the port that must be resolved before it can be started.", - "items" : { - "type" : "string" - } - } - } - }, - "PortEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "component" : { - "$ref" : "#/definitions/PortDTO" - }, - "status" : { - "description" : "The status of the port.", - "$ref" : "#/definitions/PortStatusDTO" - }, - "portType" : { - "type" : "string" - }, - "operatePermissions" : { - "description" : "The permissions for this component operations.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "allowRemoteAccess" : { - "type" : "boolean", - "description" : "Whether this port can be accessed remotely via Site-to-Site protocol." - } - }, - "xml" : { - "name" : "portEntity" - } - }, - "PortRunStatusEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "state" : { - "type" : "string", - "description" : "The run status of the Port.", - "enum" : [ "RUNNING", "STOPPED", "DISABLED" ] - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - } - }, - "xml" : { - "name" : "entity" - } - }, - "PortStatusDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the port." - }, - "groupId" : { - "type" : "string", - "description" : "The id of the parent process group of the port." - }, - "name" : { - "type" : "string", - "description" : "The name of the port." - }, - "transmitting" : { - "type" : "boolean", - "description" : "Whether the port has incoming or outgoing connections to a remote NiFi." - }, - "runStatus" : { - "type" : "string", - "description" : "The run status of the port.", - "enum" : [ "Running", "Stopped", "Validating", "Disabled", "Invalid" ] - }, - "statsLastRefreshed" : { - "type" : "string", - "description" : "The time the status for the process group was last refreshed." - }, - "aggregateSnapshot" : { - "description" : "A status snapshot that represents the aggregate stats of all nodes in the cluster. If the NiFi instance is a standalone instance, rather than a cluster, this represents the stats of the single instance.", - "$ref" : "#/definitions/PortStatusSnapshotDTO" - }, - "nodeSnapshots" : { - "type" : "array", - "description" : "A status snapshot for each node in the cluster. If the NiFi instance is a standalone instance, rather than a cluster, this may be null.", - "items" : { - "$ref" : "#/definitions/NodePortStatusSnapshotDTO" - } - } - } - }, - "PortStatusEntity" : { - "type" : "object", - "properties" : { - "portStatus" : { - "$ref" : "#/definitions/PortStatusDTO" - }, - "canRead" : { - "type" : "boolean", - "description" : "Indicates whether the user can read a given resource.", - "readOnly" : true - } - }, - "xml" : { - "name" : "portStatusEntity" - } - }, - "PortStatusSnapshotDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the port." - }, - "groupId" : { - "type" : "string", - "description" : "The id of the parent process group of the port." - }, - "name" : { - "type" : "string", - "description" : "The name of the port." - }, - "activeThreadCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The active thread count for the port." - }, - "flowFilesIn" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of FlowFiles that have been accepted in the last 5 minutes." - }, - "bytesIn" : { - "type" : "integer", - "format" : "int64", - "description" : "The size of hte FlowFiles that have been accepted in the last 5 minutes." - }, - "input" : { - "type" : "string", - "description" : "The count/size of flowfiles that have been accepted in the last 5 minutes." - }, - "flowFilesOut" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of FlowFiles that have been processed in the last 5 minutes." - }, - "bytesOut" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes that have been processed in the last 5 minutes." - }, - "output" : { - "type" : "string", - "description" : "The count/size of flowfiles that have been processed in the last 5 minutes." - }, - "transmitting" : { - "type" : "boolean", - "description" : "Whether the port has incoming or outgoing connections to a remote NiFi." - }, - "runStatus" : { - "type" : "string", - "description" : "The run status of the port.", - "enum" : [ "Running", "Stopped", "Validating", "Disabled", "Invalid" ] - } - } - }, - "PortStatusSnapshotEntity" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the port." - }, - "portStatusSnapshot" : { - "$ref" : "#/definitions/PortStatusSnapshotDTO" - }, - "canRead" : { - "type" : "boolean", - "description" : "Indicates whether the user can read a given resource.", - "readOnly" : true - } - }, - "xml" : { - "name" : "entity" - } - }, - "Position" : { - "type" : "object", - "properties" : { - "x" : { - "type" : "number", - "format" : "double", - "description" : "The x coordinate." - }, - "y" : { - "type" : "number", - "format" : "double", - "description" : "The y coordinate." - } - }, - "description" : "The position of a component on the graph" - }, - "PositionDTO" : { - "type" : "object", - "properties" : { - "x" : { - "type" : "number", - "format" : "double", - "description" : "The x coordinate." - }, - "y" : { - "type" : "number", - "format" : "double", - "description" : "The y coordinate." - } - } - }, - "PreviousValueDTO" : { - "type" : "object", - "properties" : { - "previousValue" : { - "type" : "string", - "description" : "The previous value." - }, - "timestamp" : { - "type" : "string", - "description" : "The timestamp when the value was modified." - }, - "userIdentity" : { - "type" : "string", - "description" : "The user who changed the previous value." - } - } - }, - "PrioritizerTypesEntity" : { - "type" : "object", - "properties" : { - "prioritizerTypes" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/DocumentedTypeDTO" - } - } - }, - "xml" : { - "name" : "prioritizerTypesEntity" - } - }, - "ProcessGroupDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "versionedComponentId" : { - "type" : "string", - "description" : "The ID of the corresponding component that is under version control" - }, - "parentGroupId" : { - "type" : "string", - "description" : "The id of parent process group of this component if applicable." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "name" : { - "type" : "string", - "description" : "The name of the process group." - }, - "comments" : { - "type" : "string", - "description" : "The comments for the process group." - }, - "variables" : { - "type" : "object", - "description" : "The variables that are configured for the Process Group. Note that this map contains only those variables that are defined on this Process Group and not any variables that are defined in the parent Process Group, etc. I.e., this Map will not contain all variables that are accessible by components in this Process Group by rather only the variables that are defined for this Process Group itself.", - "readOnly" : true, - "additionalProperties" : { - "type" : "string" - } - }, - "versionControlInformation" : { - "description" : "The Version Control information that indicates which Flow Registry, and where in the Flow Registry, this Process Group is tracking to; or null if this Process Group is not under version control", - "$ref" : "#/definitions/VersionControlInformationDTO" - }, - "parameterContext" : { - "description" : "The Parameter Context that this Process Group is bound to.", - "$ref" : "#/definitions/ParameterContextReferenceEntity" - }, - "runningCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of running components in this process group." - }, - "stoppedCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of stopped components in the process group." - }, - "invalidCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of invalid components in the process group." - }, - "disabledCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of disabled components in the process group." - }, - "activeRemotePortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of active remote ports in the process group." - }, - "inactiveRemotePortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of inactive remote ports in the process group." - }, - "upToDateCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of up to date versioned process groups in the process group." - }, - "locallyModifiedCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of locally modified versioned process groups in the process group." - }, - "staleCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of stale versioned process groups in the process group." - }, - "locallyModifiedAndStaleCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of locally modified and stale versioned process groups in the process group." - }, - "syncFailureCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of versioned process groups in the process group that are unable to sync to a registry." - }, - "localInputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of local input ports in the process group." - }, - "localOutputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of local output ports in the process group." - }, - "publicInputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of public input ports in the process group." - }, - "publicOutputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of public output ports in the process group." - }, - "contents" : { - "description" : "The contents of this process group.", - "$ref" : "#/definitions/FlowSnippetDTO" - }, - "inputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of input ports in the process group.", - "readOnly" : true - }, - "outputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of output ports in the process group.", - "readOnly" : true - } - } - }, - "ProcessGroupEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "component" : { - "$ref" : "#/definitions/ProcessGroupDTO" - }, - "status" : { - "description" : "The status of the process group.", - "$ref" : "#/definitions/ProcessGroupStatusDTO" - }, - "versionedFlowSnapshot" : { - "description" : "Returns the Versioned Flow that describes the contents of the Versioned Flow to be imported", - "readOnly" : true, - "$ref" : "#/definitions/VersionedFlowSnapshot" - }, - "runningCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of running components in this process group." - }, - "stoppedCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of stopped components in the process group." - }, - "invalidCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of invalid components in the process group." - }, - "disabledCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of disabled components in the process group." - }, - "activeRemotePortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of active remote ports in the process group." - }, - "inactiveRemotePortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of inactive remote ports in the process group." - }, - "versionedFlowState" : { - "type" : "string", - "description" : "The current state of the Process Group, as it relates to the Versioned Flow", - "readOnly" : true, - "enum" : [ "LOCALLY_MODIFIED", "STALE", "LOCALLY_MODIFIED_AND_STALE", "UP_TO_DATE", "SYNC_FAILURE" ] - }, - "upToDateCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of up to date versioned process groups in the process group." - }, - "locallyModifiedCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of locally modified versioned process groups in the process group." - }, - "staleCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of stale versioned process groups in the process group." - }, - "locallyModifiedAndStaleCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of locally modified and stale versioned process groups in the process group." - }, - "syncFailureCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of versioned process groups in the process group that are unable to sync to a registry." - }, - "localInputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of local input ports in the process group." - }, - "localOutputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of local output ports in the process group." - }, - "publicInputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of public input ports in the process group." - }, - "publicOutputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of public output ports in the process group." - }, - "parameterContext" : { - "description" : "The Parameter Context, or null if no Parameter Context has been bound to the Process Group", - "$ref" : "#/definitions/ParameterContextReferenceEntity" - }, - "inputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of input ports in the process group.", - "readOnly" : true - }, - "outputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of output ports in the process group.", - "readOnly" : true - } - }, - "xml" : { - "name" : "processGroupEntity" - } - }, - "ProcessGroupFlowDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "parentGroupId" : { - "type" : "string", - "description" : "The id of parent process group of this component if applicable." - }, - "parameterContext" : { - "description" : "The Parameter Context, or null if no Parameter Context has been bound to the Process Group", - "$ref" : "#/definitions/ParameterContextReferenceEntity" - }, - "breadcrumb" : { - "description" : "The breadcrumb of the process group.", - "$ref" : "#/definitions/FlowBreadcrumbEntity" - }, - "flow" : { - "description" : "The flow structure starting at this Process Group.", - "$ref" : "#/definitions/FlowDTO" - }, - "lastRefreshed" : { - "type" : "string", - "description" : "The time the flow for the process group was last refreshed." - } - } - }, - "ProcessGroupFlowEntity" : { - "type" : "object", - "properties" : { - "permissions" : { - "description" : "The access policy for this process group.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "processGroupFlow" : { - "$ref" : "#/definitions/ProcessGroupFlowDTO" - } - }, - "xml" : { - "name" : "processGroupFlowEntity" - } - }, - "ProcessGroupNameDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The ID of the Process Group" - }, - "name" : { - "type" : "string", - "description" : "The name of the Process Group, or the ID of the Process Group if the user does not have the READ policy for the Process Group" - } - } - }, - "ProcessGroupStatusDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The ID of the Process Group" - }, - "name" : { - "type" : "string", - "description" : "The name of the Process Group" - }, - "statsLastRefreshed" : { - "type" : "string", - "description" : "The time the status for the process group was last refreshed." - }, - "aggregateSnapshot" : { - "description" : "The aggregate status of all nodes in the cluster", - "$ref" : "#/definitions/ProcessGroupStatusSnapshotDTO" - }, - "nodeSnapshots" : { - "type" : "array", - "description" : "The status reported by each node in the cluster. If the NiFi instance is a standalone instance, rather than a clustered instance, this value may be null.", - "items" : { - "$ref" : "#/definitions/NodeProcessGroupStatusSnapshotDTO" - } - } - } - }, - "ProcessGroupStatusEntity" : { - "type" : "object", - "properties" : { - "processGroupStatus" : { - "$ref" : "#/definitions/ProcessGroupStatusDTO" - }, - "canRead" : { - "type" : "boolean", - "description" : "Indicates whether the user can read a given resource.", - "readOnly" : true - } - }, - "xml" : { - "name" : "processGroupStatusEntity" - } - }, - "ProcessGroupStatusSnapshotDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the process group." - }, - "name" : { - "type" : "string", - "description" : "The name of this process group." - }, - "connectionStatusSnapshots" : { - "type" : "array", - "description" : "The status of all connections in the process group.", - "items" : { - "$ref" : "#/definitions/ConnectionStatusSnapshotEntity" - } - }, - "processorStatusSnapshots" : { - "type" : "array", - "description" : "The status of all processors in the process group.", - "items" : { - "$ref" : "#/definitions/ProcessorStatusSnapshotEntity" - } - }, - "processGroupStatusSnapshots" : { - "type" : "array", - "description" : "The status of all process groups in the process group.", - "items" : { - "$ref" : "#/definitions/ProcessGroupStatusSnapshotEntity" - } - }, - "remoteProcessGroupStatusSnapshots" : { - "type" : "array", - "description" : "The status of all remote process groups in the process group.", - "items" : { - "$ref" : "#/definitions/RemoteProcessGroupStatusSnapshotEntity" - } - }, - "inputPortStatusSnapshots" : { - "type" : "array", - "description" : "The status of all input ports in the process group.", - "items" : { - "$ref" : "#/definitions/PortStatusSnapshotEntity" - } - }, - "outputPortStatusSnapshots" : { - "type" : "array", - "description" : "The status of all output ports in the process group.", - "items" : { - "$ref" : "#/definitions/PortStatusSnapshotEntity" - } - }, - "versionedFlowState" : { - "type" : "string", - "description" : "The current state of the Process Group, as it relates to the Versioned Flow", - "readOnly" : true, - "enum" : [ "LOCALLY_MODIFIED", "STALE", "LOCALLY_MODIFIED_AND_STALE", "UP_TO_DATE", "SYNC_FAILURE" ] - }, - "flowFilesIn" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of FlowFiles that have come into this ProcessGroup in the last 5 minutes" - }, - "bytesIn" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes that have come into this ProcessGroup in the last 5 minutes" - }, - "input" : { - "type" : "string", - "description" : "The input count/size for the process group in the last 5 minutes (pretty printed)." - }, - "flowFilesQueued" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of FlowFiles that are queued up in this ProcessGroup right now" - }, - "bytesQueued" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes that are queued up in this ProcessGroup right now" - }, - "queued" : { - "type" : "string", - "description" : "The count/size that is queued in the the process group." - }, - "queuedCount" : { - "type" : "string", - "description" : "The count that is queued for the process group." - }, - "queuedSize" : { - "type" : "string", - "description" : "The size that is queued for the process group." - }, - "bytesRead" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes read by components in this ProcessGroup in the last 5 minutes" - }, - "read" : { - "type" : "string", - "description" : "The number of bytes read in the last 5 minutes." - }, - "bytesWritten" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes written by components in this ProcessGroup in the last 5 minutes" - }, - "written" : { - "type" : "string", - "description" : "The number of bytes written in the last 5 minutes." - }, - "flowFilesOut" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of FlowFiles transferred out of this ProcessGroup in the last 5 minutes" - }, - "bytesOut" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes transferred out of this ProcessGroup in the last 5 minutes" - }, - "output" : { - "type" : "string", - "description" : "The output count/size for the process group in the last 5 minutes." - }, - "flowFilesTransferred" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of FlowFiles transferred in this ProcessGroup in the last 5 minutes" - }, - "bytesTransferred" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes transferred in this ProcessGroup in the last 5 minutes" - }, - "transferred" : { - "type" : "string", - "description" : "The count/size transferred to/from queues in the process group in the last 5 minutes." - }, - "bytesReceived" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes received from external sources by components within this ProcessGroup in the last 5 minutes" - }, - "flowFilesReceived" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of FlowFiles received from external sources by components within this ProcessGroup in the last 5 minutes" - }, - "received" : { - "type" : "string", - "description" : "The count/size sent to the process group in the last 5 minutes." - }, - "bytesSent" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes sent to an external sink by components within this ProcessGroup in the last 5 minutes" - }, - "flowFilesSent" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of FlowFiles sent to an external sink by components within this ProcessGroup in the last 5 minutes" - }, - "sent" : { - "type" : "string", - "description" : "The count/size sent from this process group in the last 5 minutes." - }, - "activeThreadCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The active thread count for this process group." - }, - "terminatedThreadCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of threads currently terminated for the process group." - } - } - }, - "ProcessGroupStatusSnapshotEntity" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the process group." - }, - "processGroupStatusSnapshot" : { - "$ref" : "#/definitions/ProcessGroupStatusSnapshotDTO" - }, - "canRead" : { - "type" : "boolean", - "description" : "Indicates whether the user can read a given resource.", - "readOnly" : true - } - }, - "xml" : { - "name" : "entity" - } - }, - "ProcessGroupsEntity" : { - "type" : "object", - "properties" : { - "processGroups" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ProcessGroupEntity" - } - } - }, - "xml" : { - "name" : "processGroupsEntity" - } - }, - "ProcessorConfigDTO" : { - "type" : "object", - "properties" : { - "properties" : { - "type" : "object", - "description" : "The properties for the processor. Properties whose value is not set will only contain the property name.", - "additionalProperties" : { - "type" : "string" - } - }, - "descriptors" : { - "type" : "object", - "description" : "Descriptors for the processor's properties.", - "additionalProperties" : { - "$ref" : "#/definitions/PropertyDescriptorDTO" - } - }, - "schedulingPeriod" : { - "type" : "string", - "description" : "The frequency with which to schedule the processor. The format of the value will depend on th value of schedulingStrategy." - }, - "schedulingStrategy" : { - "type" : "string", - "description" : "Indcates whether the prcessor should be scheduled to run in event or timer driven mode." - }, - "executionNode" : { - "type" : "string", - "description" : "Indicates the node where the process will execute." - }, - "penaltyDuration" : { - "type" : "string", - "description" : "The amount of time that is used when the process penalizes a flowfile." - }, - "yieldDuration" : { - "type" : "string", - "description" : "The amount of time that must elapse before this processor is scheduled again after yielding." - }, - "bulletinLevel" : { - "type" : "string", - "description" : "The level at which the processor will report bulletins." - }, - "runDurationMillis" : { - "type" : "integer", - "format" : "int64", - "description" : "The run duration for the processor in milliseconds." - }, - "concurrentlySchedulableTaskCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of tasks that should be concurrently schedule for the processor. If the processor doesn't allow parallol processing then any positive input will be ignored." - }, - "autoTerminatedRelationships" : { - "type" : "array", - "description" : "The names of all relationships that cause a flow file to be terminated if the relationship is not connected elsewhere. This property differs from the 'isAutoTerminate' property of the RelationshipDTO in that the RelationshipDTO is meant to depict the current configuration, whereas this property can be set in a DTO when updating a Processor in order to change which Relationships should be auto-terminated.", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - }, - "comments" : { - "type" : "string", - "description" : "The comments for the processor." - }, - "customUiUrl" : { - "type" : "string", - "description" : "The URL for the processor's custom configuration UI if applicable." - }, - "lossTolerant" : { - "type" : "boolean", - "description" : "Whether the processor is loss tolerant." - }, - "annotationData" : { - "type" : "string", - "description" : "The annotation data for the processor used to relay configuration between a custom UI and the procesosr." - }, - "defaultConcurrentTasks" : { - "type" : "object", - "description" : "Maps default values for concurrent tasks for each applicable scheduling strategy.", - "additionalProperties" : { - "type" : "string" - } - }, - "defaultSchedulingPeriod" : { - "type" : "object", - "description" : "Maps default values for scheduling period for each applicable scheduling strategy.", - "additionalProperties" : { - "type" : "string" - } - } - } - }, - "ProcessorDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "versionedComponentId" : { - "type" : "string", - "description" : "The ID of the corresponding component that is under version control" - }, - "parentGroupId" : { - "type" : "string", - "description" : "The id of parent process group of this component if applicable." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "name" : { - "type" : "string", - "description" : "The name of the processor." - }, - "type" : { - "type" : "string", - "description" : "The type of the processor." - }, - "bundle" : { - "description" : "The details of the artifact that bundled this processor type.", - "$ref" : "#/definitions/BundleDTO" - }, - "state" : { - "type" : "string", - "description" : "The state of the processor", - "enum" : [ "RUNNING", "STOPPED", "DISABLED" ] - }, - "style" : { - "type" : "object", - "description" : "Styles for the processor (background-color : #eee).", - "additionalProperties" : { - "type" : "string" - } - }, - "relationships" : { - "type" : "array", - "description" : "The available relationships that the processor currently supports.", - "readOnly" : true, - "items" : { - "$ref" : "#/definitions/RelationshipDTO" - } - }, - "description" : { - "type" : "string", - "description" : "The description of the processor." - }, - "supportsParallelProcessing" : { - "type" : "boolean", - "description" : "Whether the processor supports parallel processing." - }, - "supportsEventDriven" : { - "type" : "boolean", - "description" : "Whether the processor supports event driven scheduling." - }, - "supportsBatching" : { - "type" : "boolean", - "description" : "Whether the processor supports batching. This makes the run duration settings available." - }, - "persistsState" : { - "type" : "boolean", - "description" : "Whether the processor persists state." - }, - "restricted" : { - "type" : "boolean", - "description" : "Whether the processor requires elevated privileges." - }, - "deprecated" : { - "type" : "boolean", - "description" : "Whether the processor has been deprecated." - }, - "executionNodeRestricted" : { - "type" : "boolean", - "description" : "Indicates if the execution node of a processor is restricted to run only on the primary node" - }, - "multipleVersionsAvailable" : { - "type" : "boolean", - "description" : "Whether the processor has multiple versions available." - }, - "inputRequirement" : { - "type" : "string", - "description" : "The input requirement for this processor." - }, - "config" : { - "description" : "The configuration details for the processor. These details will be included in a response if the verbose flag is included in a request.", - "$ref" : "#/definitions/ProcessorConfigDTO" - }, - "validationErrors" : { - "type" : "array", - "description" : "The validation errors for the processor. These validation errors represent the problems with the processor that must be resolved before it can be started.", - "items" : { - "type" : "string" - } - }, - "validationStatus" : { - "type" : "string", - "description" : "Indicates whether the Processor is valid, invalid, or still in the process of validating (i.e., it is unknown whether or not the Processor is valid)", - "readOnly" : true, - "enum" : [ "VALID", "INVALID", "VALIDATING" ] - }, - "extensionMissing" : { - "type" : "boolean", - "description" : "Whether the underlying extension is missing." - } - } - }, - "ProcessorEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "component" : { - "$ref" : "#/definitions/ProcessorDTO" - }, - "inputRequirement" : { - "type" : "string", - "description" : "The input requirement for this processor." - }, - "status" : { - "$ref" : "#/definitions/ProcessorStatusDTO" - }, - "operatePermissions" : { - "description" : "The permissions for this component operations.", - "$ref" : "#/definitions/PermissionsDTO" - } - }, - "xml" : { - "name" : "processorEntity" - } - }, - "ProcessorRunStatusEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "state" : { - "type" : "string", - "description" : "The run status of the Processor.", - "enum" : [ "RUNNING", "STOPPED", "DISABLED" ] - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - } - }, - "xml" : { - "name" : "entity" - } - }, - "ProcessorStatusDTO" : { - "type" : "object", - "properties" : { - "groupId" : { - "type" : "string", - "description" : "The unique ID of the process group that the Processor belongs to" - }, - "id" : { - "type" : "string", - "description" : "The unique ID of the Processor" - }, - "name" : { - "type" : "string", - "description" : "The name of the Processor" - }, - "type" : { - "type" : "string", - "description" : "The type of the Processor" - }, - "runStatus" : { - "type" : "string", - "description" : "The run status of the Processor", - "enum" : [ "Running", "Stopped", "Validating", "Disabled", "Invalid" ] - }, - "statsLastRefreshed" : { - "type" : "string", - "description" : "The timestamp of when the stats were last refreshed" - }, - "aggregateSnapshot" : { - "description" : "A status snapshot that represents the aggregate stats of all nodes in the cluster. If the NiFi instance is a standalone instance, rather than a cluster, this represents the stats of the single instance.", - "$ref" : "#/definitions/ProcessorStatusSnapshotDTO" - }, - "nodeSnapshots" : { - "type" : "array", - "description" : "A status snapshot for each node in the cluster. If the NiFi instance is a standalone instance, rather than a cluster, this may be null.", - "items" : { - "$ref" : "#/definitions/NodeProcessorStatusSnapshotDTO" - } - } - } - }, - "ProcessorStatusEntity" : { - "type" : "object", - "properties" : { - "processorStatus" : { - "$ref" : "#/definitions/ProcessorStatusDTO" - }, - "canRead" : { - "type" : "boolean", - "description" : "Indicates whether the user can read a given resource.", - "readOnly" : true - } - }, - "xml" : { - "name" : "processorStatusEntity" - } - }, - "ProcessorStatusSnapshotDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the processor." - }, - "groupId" : { - "type" : "string", - "description" : "The id of the parent process group to which the processor belongs." - }, - "name" : { - "type" : "string", - "description" : "The name of the prcessor." - }, - "type" : { - "type" : "string", - "description" : "The type of the processor." - }, - "runStatus" : { - "type" : "string", - "description" : "The state of the processor.", - "enum" : [ "Running", "Stopped", "Validating", "Disabled", "Invalid" ] - }, - "executionNode" : { - "type" : "string", - "description" : "Indicates the node where the process will execute.", - "enum" : [ "ALL", "PRIMARY" ] - }, - "bytesRead" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes read by this Processor in the last 5 mintues" - }, - "bytesWritten" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes written by this Processor in the last 5 minutes" - }, - "read" : { - "type" : "string", - "description" : "The number of bytes read in the last 5 minutes." - }, - "written" : { - "type" : "string", - "description" : "The number of bytes written in the last 5 minutes." - }, - "flowFilesIn" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of FlowFiles that have been accepted in the last 5 minutes" - }, - "bytesIn" : { - "type" : "integer", - "format" : "int64", - "description" : "The size of the FlowFiles that have been accepted in the last 5 minutes" - }, - "input" : { - "type" : "string", - "description" : "The count/size of flowfiles that have been accepted in the last 5 minutes." - }, - "flowFilesOut" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of FlowFiles transferred to a Connection in the last 5 minutes" - }, - "bytesOut" : { - "type" : "integer", - "format" : "int64", - "description" : "The size of the FlowFiles transferred to a Connection in the last 5 minutes" - }, - "output" : { - "type" : "string", - "description" : "The count/size of flowfiles that have been processed in the last 5 minutes." - }, - "taskCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of times this Processor has run in the last 5 minutes" - }, - "tasksDurationNanos" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of nanoseconds that this Processor has spent running in the last 5 minutes" - }, - "tasks" : { - "type" : "string", - "description" : "The total number of task this connectable has completed over the last 5 minutes." - }, - "tasksDuration" : { - "type" : "string", - "description" : "The total duration of all tasks for this connectable over the last 5 minutes." - }, - "activeThreadCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of threads currently executing in the processor." - }, - "terminatedThreadCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of threads currently terminated for the processor." - } - } - }, - "ProcessorStatusSnapshotEntity" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the processor." - }, - "processorStatusSnapshot" : { - "$ref" : "#/definitions/ProcessorStatusSnapshotDTO" - }, - "canRead" : { - "type" : "boolean", - "description" : "Indicates whether the user can read a given resource.", - "readOnly" : true - } - }, - "xml" : { - "name" : "entity" - } - }, - "ProcessorTypesEntity" : { - "type" : "object", - "properties" : { - "processorTypes" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/DocumentedTypeDTO" - } - } - }, - "xml" : { - "name" : "processorTypesEntity" - } - }, - "ProcessorsEntity" : { - "type" : "object", - "properties" : { - "processors" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ProcessorEntity" - } - } - }, - "xml" : { - "name" : "processorsEntity" - } - }, - "PropertyDescriptorDTO" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The name for the property." - }, - "displayName" : { - "type" : "string", - "description" : "The human readable name for the property." - }, - "description" : { - "type" : "string", - "description" : "The description for the property. Used to relay additional details to a user or provide a mechanism of documenting intent." - }, - "defaultValue" : { - "type" : "string", - "description" : "The default value for the property." - }, - "allowableValues" : { - "type" : "array", - "description" : "Allowable values for the property. If empty then the allowed values are not constrained.", - "items" : { - "$ref" : "#/definitions/AllowableValueEntity" - } - }, - "required" : { - "type" : "boolean", - "description" : "Whether the property is required." - }, - "sensitive" : { - "type" : "boolean", - "description" : "Whether the property is sensitive and protected whenever stored or represented." - }, - "dynamic" : { - "type" : "boolean", - "description" : "Whether the property is dynamic (user-defined)." - }, - "supportsEl" : { - "type" : "boolean", - "description" : "Whether the property supports expression language." - }, - "expressionLanguageScope" : { - "type" : "string", - "description" : "Scope of the Expression Language evaluation for the property." - }, - "identifiesControllerService" : { - "type" : "string", - "description" : "If the property identifies a controller service this returns the fully qualified type." - }, - "identifiesControllerServiceBundle" : { - "description" : "If the property identifies a controller service this returns the bundle of the type, null otherwise.", - "$ref" : "#/definitions/BundleDTO" - } - } - }, - "PropertyDescriptorEntity" : { - "type" : "object", - "properties" : { - "propertyDescriptor" : { - "$ref" : "#/definitions/PropertyDescriptorDTO" - } - }, - "xml" : { - "name" : "propertyDescriptor" - } - }, - "PropertyHistoryDTO" : { - "type" : "object", - "properties" : { - "previousValues" : { - "type" : "array", - "description" : "Previous values for a given property.", - "items" : { - "$ref" : "#/definitions/PreviousValueDTO" - } - } - } - }, - "ProvenanceDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the provenance query." - }, - "uri" : { - "type" : "string", - "description" : "The URI for this query. Used for obtaining/deleting the request at a later time" - }, - "submissionTime" : { - "type" : "string", - "description" : "The timestamp when the query was submitted." - }, - "expiration" : { - "type" : "string", - "description" : "The timestamp when the query will expire." - }, - "percentCompleted" : { - "type" : "integer", - "format" : "int32", - "description" : "The current percent complete." - }, - "finished" : { - "type" : "boolean", - "description" : "Whether the query has finished." - }, - "request" : { - "description" : "The provenance request.", - "$ref" : "#/definitions/ProvenanceRequestDTO" - }, - "results" : { - "description" : "The provenance results.", - "$ref" : "#/definitions/ProvenanceResultsDTO" - } - } - }, - "ProvenanceEntity" : { - "type" : "object", - "properties" : { - "provenance" : { - "$ref" : "#/definitions/ProvenanceDTO" - } - }, - "xml" : { - "name" : "provenanceEntity" - } - }, - "ProvenanceEventDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The event uuid." - }, - "eventId" : { - "type" : "integer", - "format" : "int64", - "description" : "The event id. This is a one up number thats unique per node." - }, - "eventTime" : { - "type" : "string", - "description" : "The timestamp of the event." - }, - "eventDuration" : { - "type" : "integer", - "format" : "int64", - "description" : "The event duration in milliseconds." - }, - "lineageDuration" : { - "type" : "integer", - "format" : "int64", - "description" : "The duration since the lineage began, in milliseconds." - }, - "eventType" : { - "type" : "string", - "description" : "The type of the event." - }, - "flowFileUuid" : { - "type" : "string", - "description" : "The uuid of the flowfile for the event." - }, - "fileSize" : { - "type" : "string", - "description" : "The size of the flowfile for the event." - }, - "fileSizeBytes" : { - "type" : "integer", - "format" : "int64", - "description" : "The size of the flowfile in bytes for the event." - }, - "clusterNodeId" : { - "type" : "string", - "description" : "The identifier for the node where the event originated." - }, - "clusterNodeAddress" : { - "type" : "string", - "description" : "The label for the node where the event originated." - }, - "groupId" : { - "type" : "string", - "description" : "The id of the group that the component resides in. If the component is no longer in the flow, the group id will not be set." - }, - "componentId" : { - "type" : "string", - "description" : "The id of the component that generated the event." - }, - "componentType" : { - "type" : "string", - "description" : "The type of the component that generated the event." - }, - "componentName" : { - "type" : "string", - "description" : "The name of the component that generated the event." - }, - "sourceSystemFlowFileId" : { - "type" : "string", - "description" : "The source system flowfile id." - }, - "alternateIdentifierUri" : { - "type" : "string", - "description" : "The alternate identifier uri for the fileflow for the event." - }, - "attributes" : { - "type" : "array", - "description" : "The attributes of the flowfile for the event.", - "items" : { - "$ref" : "#/definitions/AttributeDTO" - } - }, - "parentUuids" : { - "type" : "array", - "description" : "The parent uuids for the event.", - "items" : { - "type" : "string" - } - }, - "childUuids" : { - "type" : "array", - "description" : "The child uuids for the event.", - "items" : { - "type" : "string" - } - }, - "transitUri" : { - "type" : "string", - "description" : "The source/destination system uri if the event was a RECEIVE/SEND." - }, - "relationship" : { - "type" : "string", - "description" : "The relationship to which the flowfile was routed if the event is of type ROUTE." - }, - "details" : { - "type" : "string", - "description" : "The event details." - }, - "contentEqual" : { - "type" : "boolean", - "description" : "Whether the input and output content claim is the same." - }, - "inputContentAvailable" : { - "type" : "boolean", - "description" : "Whether the input content is still available." - }, - "inputContentClaimSection" : { - "type" : "string", - "description" : "The section in which the input content claim lives." - }, - "inputContentClaimContainer" : { - "type" : "string", - "description" : "The container in which the input content claim lives." - }, - "inputContentClaimIdentifier" : { - "type" : "string", - "description" : "The identifier of the input content claim." - }, - "inputContentClaimOffset" : { - "type" : "integer", - "format" : "int64", - "description" : "The offset into the input content claim where the flowfiles content begins." - }, - "inputContentClaimFileSize" : { - "type" : "string", - "description" : "The file size of the input content claim formatted." - }, - "inputContentClaimFileSizeBytes" : { - "type" : "integer", - "format" : "int64", - "description" : "The file size of the intput content claim in bytes." - }, - "outputContentAvailable" : { - "type" : "boolean", - "description" : "Whether the output content is still available." - }, - "outputContentClaimSection" : { - "type" : "string", - "description" : "The section in which the output content claim lives." - }, - "outputContentClaimContainer" : { - "type" : "string", - "description" : "The container in which the output content claim lives." - }, - "outputContentClaimIdentifier" : { - "type" : "string", - "description" : "The identifier of the output content claim." - }, - "outputContentClaimOffset" : { - "type" : "integer", - "format" : "int64", - "description" : "The offset into the output content claim where the flowfiles content begins." - }, - "outputContentClaimFileSize" : { - "type" : "string", - "description" : "The file size of the output content claim formatted." - }, - "outputContentClaimFileSizeBytes" : { - "type" : "integer", - "format" : "int64", - "description" : "The file size of the output content claim in bytes." - }, - "replayAvailable" : { - "type" : "boolean", - "description" : "Whether or not replay is available." - }, - "replayExplanation" : { - "type" : "string", - "description" : "Explanation as to why replay is unavailable." - }, - "sourceConnectionIdentifier" : { - "type" : "string", - "description" : "The identifier of the queue/connection from which the flowfile was pulled to genereate this event. May be null if the queue/connection is unknown or the flowfile was generated from this event." - } - } - }, - "ProvenanceEventEntity" : { - "type" : "object", - "properties" : { - "provenanceEvent" : { - "$ref" : "#/definitions/ProvenanceEventDTO" - } - }, - "xml" : { - "name" : "provenanceEventEntity" - } - }, - "ProvenanceLinkDTO" : { - "type" : "object", - "properties" : { - "sourceId" : { - "type" : "string", - "description" : "The source node id of the link." - }, - "targetId" : { - "type" : "string", - "description" : "The target node id of the link." - }, - "flowFileUuid" : { - "type" : "string", - "description" : "The flowfile uuid that traversed the link." - }, - "timestamp" : { - "type" : "string", - "description" : "The timestamp of the link (based on the destination)." - }, - "millis" : { - "type" : "integer", - "format" : "int64", - "description" : "The timestamp of this link in milliseconds." - } - } - }, - "ProvenanceNodeDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the node." - }, - "flowFileUuid" : { - "type" : "string", - "description" : "The uuid of the flowfile associated with the provenance event." - }, - "parentUuids" : { - "type" : "array", - "description" : "The uuid of the parent flowfiles of the provenance event.", - "items" : { - "type" : "string" - } - }, - "childUuids" : { - "type" : "array", - "description" : "The uuid of the childrent flowfiles of the provenance event.", - "items" : { - "type" : "string" - } - }, - "clusterNodeIdentifier" : { - "type" : "string", - "description" : "The identifier of the node that this event/flowfile originated from." - }, - "type" : { - "type" : "string", - "description" : "The type of the node.", - "enum" : [ "FLOWFILE", "EVENT" ] - }, - "eventType" : { - "type" : "string", - "description" : "If the type is EVENT, this is the type of event." - }, - "millis" : { - "type" : "integer", - "format" : "int64", - "description" : "The timestamp of the node in milliseconds." - }, - "timestamp" : { - "type" : "string", - "description" : "The timestamp of the node formatted." - } - } - }, - "ProvenanceOptionsDTO" : { - "type" : "object", - "properties" : { - "searchableFields" : { - "type" : "array", - "description" : "The available searchable field for the NiFi.", - "items" : { - "$ref" : "#/definitions/ProvenanceSearchableFieldDTO" - } - } - } - }, - "ProvenanceOptionsEntity" : { - "type" : "object", - "properties" : { - "provenanceOptions" : { - "$ref" : "#/definitions/ProvenanceOptionsDTO" - } - }, - "xml" : { - "name" : "provenanceOptionsEntity" - } - }, - "ProvenanceRequestDTO" : { - "type" : "object", - "properties" : { - "searchTerms" : { - "type" : "object", - "description" : "The search terms used to perform the search.", - "additionalProperties" : { - "type" : "string" - } - }, - "clusterNodeId" : { - "type" : "string", - "description" : "The id of the node in the cluster where this provenance originated." - }, - "startDate" : { - "type" : "string", - "description" : "The earliest event time to include in the query." - }, - "endDate" : { - "type" : "string", - "description" : "The latest event time to include in the query." - }, - "minimumFileSize" : { - "type" : "string", - "description" : "The minimum file size to include in the query." - }, - "maximumFileSize" : { - "type" : "string", - "description" : "The maximum file size to include in the query." - }, - "maxResults" : { - "type" : "integer", - "format" : "int32", - "description" : "The maximum number of results to include." - }, - "summarize" : { - "type" : "boolean", - "description" : "Whether or not to summarize provenance events returned. This property is false by default." - }, - "incrementalResults" : { - "type" : "boolean", - "description" : "Whether or not incremental results are returned. If false, provenance events are only returned once the query completes. This property is true by default." - } - } - }, - "ProvenanceResultsDTO" : { - "type" : "object", - "properties" : { - "provenanceEvents" : { - "type" : "array", - "description" : "The provenance events that matched the search criteria.", - "items" : { - "$ref" : "#/definitions/ProvenanceEventDTO" - } - }, - "total" : { - "type" : "string", - "description" : "The total number of results formatted." - }, - "totalCount" : { - "type" : "integer", - "format" : "int64", - "description" : "The total number of results." - }, - "generated" : { - "type" : "string", - "description" : "Then the search was performed." - }, - "oldestEvent" : { - "type" : "string", - "description" : "The oldest event available in the provenance repository." - }, - "timeOffset" : { - "type" : "integer", - "format" : "int32", - "description" : "The time offset of the server that's used for event time." - }, - "errors" : { - "type" : "array", - "description" : "Any errors that occurred while performing the provenance request.", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - } - } - }, - "ProvenanceSearchableFieldDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the searchable field." - }, - "field" : { - "type" : "string", - "description" : "The searchable field." - }, - "label" : { - "type" : "string", - "description" : "The label for the searchable field." - }, - "type" : { - "type" : "string", - "description" : "The type of the searchable field." - } - } - }, - "QueueSizeDTO" : { - "type" : "object", - "properties" : { - "byteCount" : { - "type" : "integer", - "format" : "int64", - "description" : "The size of objects in a queue." - }, - "objectCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The count of objects in a queue." - } - } - }, - "RegistryClientEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "component" : { - "$ref" : "#/definitions/RegistryDTO" - } - }, - "xml" : { - "name" : "registryClientEntity" - } - }, - "RegistryClientsEntity" : { - "type" : "object", - "properties" : { - "registries" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/RegistryClientEntity" - } - } - }, - "xml" : { - "name" : "registryClientsEntity" - } - }, - "RegistryDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The registry identifier" - }, - "name" : { - "type" : "string", - "description" : "The registry name" - }, - "description" : { - "type" : "string", - "description" : "The registry description" - }, - "uri" : { - "type" : "string", - "description" : "The registry URI" - } - } - }, - "RelationshipDTO" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The relationship name." - }, - "description" : { - "type" : "string", - "description" : "The relationship description." - }, - "autoTerminate" : { - "type" : "boolean", - "description" : "Whether or not flowfiles sent to this relationship should auto terminate." - } - } - }, - "RemotePortRunStatusEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "state" : { - "type" : "string", - "description" : "The run status of the RemotePort.", - "enum" : [ "TRANSMITTING", "STOPPED" ] - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - } - }, - "xml" : { - "name" : "entity" - } - }, - "RemoteProcessGroupContentsDTO" : { - "type" : "object", - "properties" : { - "inputPorts" : { - "type" : "array", - "description" : "The input ports to which data can be sent.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/RemoteProcessGroupPortDTO" - } - }, - "outputPorts" : { - "type" : "array", - "description" : "The output ports from which data can be retrieved.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/RemoteProcessGroupPortDTO" - } - } - } - }, - "RemoteProcessGroupDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "versionedComponentId" : { - "type" : "string", - "description" : "The ID of the corresponding component that is under version control" - }, - "parentGroupId" : { - "type" : "string", - "description" : "The id of parent process group of this component if applicable." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "targetUri" : { - "type" : "string", - "description" : "The target URI of the remote process group. If target uri is not set, but uris are set, then returns the first url in the urls. If neither target uri nor uris are set, then returns null." - }, - "targetUris" : { - "type" : "string", - "description" : "The target URI of the remote process group. If target uris is not set but target uri is set, then returns a collection containing the single target uri. If neither target uris nor uris are set, then returns null." - }, - "targetSecure" : { - "type" : "boolean", - "description" : "Whether the target is running securely." - }, - "name" : { - "type" : "string", - "description" : "The name of the remote process group." - }, - "comments" : { - "type" : "string", - "description" : "The comments for the remote process group." - }, - "communicationsTimeout" : { - "type" : "string", - "description" : "The time period used for the timeout when communicating with the target." - }, - "yieldDuration" : { - "type" : "string", - "description" : "When yielding, this amount of time must elapse before the remote process group is scheduled again." - }, - "transportProtocol" : { - "type" : "string" - }, - "localNetworkInterface" : { - "type" : "string", - "description" : "The local network interface to send/receive data. If not specified, any local address is used. If clustered, all nodes must have an interface with this identifier." - }, - "proxyHost" : { - "type" : "string" - }, - "proxyPort" : { - "type" : "integer", - "format" : "int32" - }, - "proxyUser" : { - "type" : "string" - }, - "proxyPassword" : { - "type" : "string" - }, - "authorizationIssues" : { - "type" : "array", - "description" : "Any remote authorization issues for the remote process group.", - "items" : { - "type" : "string" - } - }, - "validationErrors" : { - "type" : "array", - "description" : "The validation errors for the remote process group. These validation errors represent the problems with the remote process group that must be resolved before it can transmit.", - "items" : { - "type" : "string" - } - }, - "transmitting" : { - "type" : "boolean", - "description" : "Whether the remote process group is actively transmitting." - }, - "inputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of remote input ports currently available on the target." - }, - "outputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of remote output ports currently available on the target." - }, - "activeRemoteInputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of active remote input ports." - }, - "inactiveRemoteInputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of inactive remote input ports." - }, - "activeRemoteOutputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of active remote output ports." - }, - "inactiveRemoteOutputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of inactive remote output ports." - }, - "flowRefreshed" : { - "type" : "string", - "description" : "The timestamp when this remote process group was last refreshed." - }, - "contents" : { - "description" : "The contents of the remote process group. Will contain available input/output ports.", - "$ref" : "#/definitions/RemoteProcessGroupContentsDTO" - } - } - }, - "RemoteProcessGroupEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "component" : { - "$ref" : "#/definitions/RemoteProcessGroupDTO" - }, - "status" : { - "description" : "The status of the remote process group.", - "$ref" : "#/definitions/RemoteProcessGroupStatusDTO" - }, - "inputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of remote input ports currently available on the target." - }, - "outputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of remote output ports currently available on the target." - }, - "operatePermissions" : { - "description" : "The permissions for this component operations.", - "$ref" : "#/definitions/PermissionsDTO" - } - }, - "xml" : { - "name" : "remoteProcessGroupEntity" - } - }, - "RemoteProcessGroupPortDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the port." - }, - "targetId" : { - "type" : "string", - "description" : "The id of the target port." - }, - "versionedComponentId" : { - "type" : "string", - "description" : "The ID of the corresponding component that is under version control" - }, - "groupId" : { - "type" : "string", - "description" : "The id of the remote process group that the port resides in." - }, - "name" : { - "type" : "string", - "description" : "The name of the target port." - }, - "comments" : { - "type" : "string", - "description" : "The comments as configured on the target port." - }, - "concurrentlySchedulableTaskCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of task that may transmit flowfiles to the target port concurrently." - }, - "transmitting" : { - "type" : "boolean", - "description" : "Whether the remote port is configured for transmission." - }, - "useCompression" : { - "type" : "boolean", - "description" : "Whether the flowfiles are compressed when sent to the target port." - }, - "exists" : { - "type" : "boolean", - "description" : "Whether the target port exists." - }, - "targetRunning" : { - "type" : "boolean", - "description" : "Whether the target port is running." - }, - "connected" : { - "type" : "boolean", - "description" : "Whether the port has either an incoming or outgoing connection." - }, - "batchSettings" : { - "description" : "The batch settings for data transmission.", - "$ref" : "#/definitions/BatchSettingsDTO" - } - } - }, - "RemoteProcessGroupPortEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "remoteProcessGroupPort" : { - "$ref" : "#/definitions/RemoteProcessGroupPortDTO" - }, - "operatePermissions" : { - "description" : "The permissions for this component operations.", - "$ref" : "#/definitions/PermissionsDTO" - } - }, - "xml" : { - "name" : "remoteProcessGroupPortEntity" - } - }, - "RemoteProcessGroupStatusDTO" : { - "type" : "object", - "properties" : { - "groupId" : { - "type" : "string", - "description" : "The unique ID of the process group that the Processor belongs to" - }, - "id" : { - "type" : "string", - "description" : "The unique ID of the Processor" - }, - "name" : { - "type" : "string", - "description" : "The name of the remote process group." - }, - "targetUri" : { - "type" : "string", - "description" : "The URI of the target system." - }, - "transmissionStatus" : { - "type" : "string", - "description" : "The transmission status of the remote process group." - }, - "statsLastRefreshed" : { - "type" : "string", - "description" : "The time the status for the process group was last refreshed." - }, - "validationStatus" : { - "type" : "string", - "description" : "Indicates whether the component is valid, invalid, or still in the process of validating (i.e., it is unknown whether or not the component is valid)", - "readOnly" : true, - "enum" : [ "VALID", "INVALID", "VALIDATING" ] - }, - "aggregateSnapshot" : { - "description" : "A status snapshot that represents the aggregate stats of all nodes in the cluster. If the NiFi instance is a standalone instance, rather than a cluster, this represents the stats of the single instance.", - "$ref" : "#/definitions/RemoteProcessGroupStatusSnapshotDTO" - }, - "nodeSnapshots" : { - "type" : "array", - "description" : "A status snapshot for each node in the cluster. If the NiFi instance is a standalone instance, rather than a cluster, this may be null.", - "items" : { - "$ref" : "#/definitions/NodeRemoteProcessGroupStatusSnapshotDTO" - } - } - } - }, - "RemoteProcessGroupStatusEntity" : { - "type" : "object", - "properties" : { - "remoteProcessGroupStatus" : { - "$ref" : "#/definitions/RemoteProcessGroupStatusDTO" - }, - "canRead" : { - "type" : "boolean", - "description" : "Indicates whether the user can read a given resource.", - "readOnly" : true - } - }, - "xml" : { - "name" : "remoteProcessGroupStatusEntity" - } - }, - "RemoteProcessGroupStatusSnapshotDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the remote process group." - }, - "groupId" : { - "type" : "string", - "description" : "The id of the parent process group the remote process group resides in." - }, - "name" : { - "type" : "string", - "description" : "The name of the remote process group." - }, - "targetUri" : { - "type" : "string", - "description" : "The URI of the target system." - }, - "transmissionStatus" : { - "type" : "string", - "description" : "The transmission status of the remote process group." - }, - "activeThreadCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of active threads for the remote process group." - }, - "flowFilesSent" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of FlowFiles sent to the remote process group in the last 5 minutes." - }, - "bytesSent" : { - "type" : "integer", - "format" : "int64", - "description" : "The size of the FlowFiles sent to the remote process group in the last 5 minutes." - }, - "sent" : { - "type" : "string", - "description" : "The count/size of the flowfiles sent to the remote process group in the last 5 minutes." - }, - "flowFilesReceived" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of FlowFiles received from the remote process group in the last 5 minutes." - }, - "bytesReceived" : { - "type" : "integer", - "format" : "int64", - "description" : "The size of the FlowFiles received from the remote process group in the last 5 minutes." - }, - "received" : { - "type" : "string", - "description" : "The count/size of the flowfiles received from the remote process group in the last 5 minutes." - } - } - }, - "RemoteProcessGroupStatusSnapshotEntity" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the remote process group." - }, - "remoteProcessGroupStatusSnapshot" : { - "$ref" : "#/definitions/RemoteProcessGroupStatusSnapshotDTO" - }, - "canRead" : { - "type" : "boolean", - "description" : "Indicates whether the user can read a given resource.", - "readOnly" : true - } - }, - "xml" : { - "name" : "entity" - } - }, - "RemoteProcessGroupsEntity" : { - "type" : "object", - "properties" : { - "remoteProcessGroups" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/RemoteProcessGroupEntity" - } - } - }, - "xml" : { - "name" : "remoteProcessGroupsEntity" - } - }, - "ReportingTaskDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "versionedComponentId" : { - "type" : "string", - "description" : "The ID of the corresponding component that is under version control" - }, - "parentGroupId" : { - "type" : "string", - "description" : "The id of parent process group of this component if applicable." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "name" : { - "type" : "string", - "description" : "The name of the reporting task." - }, - "type" : { - "type" : "string", - "description" : "The fully qualified type of the reporting task." - }, - "bundle" : { - "description" : "The details of the artifact that bundled this processor type.", - "$ref" : "#/definitions/BundleDTO" - }, - "state" : { - "type" : "string", - "description" : "The state of the reporting task.", - "enum" : [ "RUNNING", "STOPPED", "DISABLED" ] - }, - "comments" : { - "type" : "string", - "description" : "The comments of the reporting task." - }, - "persistsState" : { - "type" : "boolean", - "description" : "Whether the reporting task persists state." - }, - "restricted" : { - "type" : "boolean", - "description" : "Whether the reporting task requires elevated privileges." - }, - "deprecated" : { - "type" : "boolean", - "description" : "Whether the reporting task has been deprecated." - }, - "multipleVersionsAvailable" : { - "type" : "boolean", - "description" : "Whether the reporting task has multiple versions available." - }, - "schedulingPeriod" : { - "type" : "string", - "description" : "The frequency with which to schedule the reporting task. The format of the value willd epend on the valud of the schedulingStrategy." - }, - "schedulingStrategy" : { - "type" : "string", - "description" : "The scheduling strategy that determines how the schedulingPeriod value should be interpreted." - }, - "defaultSchedulingPeriod" : { - "type" : "object", - "description" : "The default scheduling period for the different scheduling strategies.", - "additionalProperties" : { - "type" : "string" - } - }, - "properties" : { - "type" : "object", - "description" : "The properties of the reporting task.", - "additionalProperties" : { - "type" : "string" - } - }, - "descriptors" : { - "type" : "object", - "description" : "The descriptors for the reporting tasks properties.", - "additionalProperties" : { - "$ref" : "#/definitions/PropertyDescriptorDTO" - } - }, - "customUiUrl" : { - "type" : "string", - "description" : "The URL for the custom configuration UI for the reporting task." - }, - "annotationData" : { - "type" : "string", - "description" : "The annotation data for the repoting task. This is how the custom UI relays configuration to the reporting task." - }, - "validationErrors" : { - "type" : "array", - "description" : "Gets the validation errors from the reporting task. These validation errors represent the problems with the reporting task that must be resolved before it can be scheduled to run.", - "items" : { - "type" : "string" - } - }, - "validationStatus" : { - "type" : "string", - "description" : "Indicates whether the Processor is valid, invalid, or still in the process of validating (i.e., it is unknown whether or not the Processor is valid)", - "readOnly" : true, - "enum" : [ "VALID", "INVALID", "VALIDATING" ] - }, - "activeThreadCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of active threads for the reporting task." - }, - "extensionMissing" : { - "type" : "boolean", - "description" : "Whether the underlying extension is missing." - } - } - }, - "ReportingTaskEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "component" : { - "$ref" : "#/definitions/ReportingTaskDTO" - }, - "operatePermissions" : { - "description" : "The permissions for this component operations.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "status" : { - "description" : "The status for this ReportingTask.", - "readOnly" : true, - "$ref" : "#/definitions/ReportingTaskStatusDTO" - } - }, - "xml" : { - "name" : "reportingTaskEntity" - } - }, - "ReportingTaskRunStatusEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "state" : { - "type" : "string", - "description" : "The run status of the ReportingTask.", - "enum" : [ "RUNNING", "STOPPED" ] - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - } - }, - "xml" : { - "name" : "entity" - } - }, - "ReportingTaskStatusDTO" : { - "type" : "object", - "properties" : { - "runStatus" : { - "type" : "string", - "description" : "The run status of this ReportingTask", - "readOnly" : true, - "enum" : [ "RUNNING", "STOPPED", "DISABLED" ] - }, - "validationStatus" : { - "type" : "string", - "description" : "Indicates whether the component is valid, invalid, or still in the process of validating (i.e., it is unknown whether or not the component is valid)", - "readOnly" : true, - "enum" : [ "VALID", "INVALID", "VALIDATING" ] - }, - "activeThreadCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of active threads for the component." - } - } - }, - "ReportingTaskTypesEntity" : { - "type" : "object", - "properties" : { - "reportingTaskTypes" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/DocumentedTypeDTO" - } - } - }, - "xml" : { - "name" : "reportingTaskTypesEntity" - } - }, - "ReportingTasksEntity" : { - "type" : "object", - "properties" : { - "reportingTasks" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ReportingTaskEntity" - } - } - }, - "xml" : { - "name" : "reportingTasksEntity" - } - }, - "RequiredPermissionDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The required sub-permission necessary for this restriction." - }, - "label" : { - "type" : "string", - "description" : "The label for the required sub-permission necessary for this restriction." - } - } - }, - "ResourceDTO" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The identifier of the resource." - }, - "name" : { - "type" : "string", - "description" : "The name of the resource." - } - } - }, - "ResourcesEntity" : { - "type" : "object", - "properties" : { - "resources" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/ResourceDTO" - } - } - }, - "xml" : { - "name" : "resourcesEntity" - } - }, - "RevisionDTO" : { - "type" : "object", - "properties" : { - "clientId" : { - "type" : "string", - "description" : "A client identifier used to make a request. By including a client identifier, the API can allow multiple requests without needing the current revision. Due to the asynchronous nature of requests/responses this was implemented to allow the client to make numerous requests without having to wait for the previous response to come back" - }, - "version" : { - "type" : "integer", - "format" : "int64", - "description" : "NiFi employs an optimistic locking strategy where the client must include a revision in their request when performing an update. In a response to a mutable flow request, this field represents the updated base version." - }, - "lastModifier" : { - "type" : "string", - "description" : "The user that last modified the flow.", - "readOnly" : true - } - } - }, - "ScheduleComponentsEntity" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the ProcessGroup" - }, - "state" : { - "type" : "string", - "description" : "The desired state of the descendant components", - "enum" : [ "RUNNING", "STOPPED", "ENABLED", "DISABLED" ] - }, - "components" : { - "type" : "object", - "description" : "Optional components to schedule. If not specified, all authorized descendant components will be used.", - "additionalProperties" : { - "$ref" : "#/definitions/RevisionDTO" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - } - }, - "xml" : { - "name" : "scheduleComponentEntity" - } - }, - "SearchResultGroupDTO" : { - "type" : "object", - "required" : [ "id" ], - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the group." - }, - "name" : { - "type" : "string", - "description" : "The name of the group." - } - } - }, - "SearchResultsDTO" : { - "type" : "object", - "properties" : { - "processorResults" : { - "type" : "array", - "description" : "The processors that matched the search.", - "items" : { - "$ref" : "#/definitions/ComponentSearchResultDTO" - } - }, - "connectionResults" : { - "type" : "array", - "description" : "The connections that matched the search.", - "items" : { - "$ref" : "#/definitions/ComponentSearchResultDTO" - } - }, - "processGroupResults" : { - "type" : "array", - "description" : "The process groups that matched the search.", - "items" : { - "$ref" : "#/definitions/ComponentSearchResultDTO" - } - }, - "inputPortResults" : { - "type" : "array", - "description" : "The input ports that matched the search.", - "items" : { - "$ref" : "#/definitions/ComponentSearchResultDTO" - } - }, - "outputPortResults" : { - "type" : "array", - "description" : "The output ports that matched the search.", - "items" : { - "$ref" : "#/definitions/ComponentSearchResultDTO" - } - }, - "remoteProcessGroupResults" : { - "type" : "array", - "description" : "The remote process groups that matched the search.", - "items" : { - "$ref" : "#/definitions/ComponentSearchResultDTO" - } - }, - "funnelResults" : { - "type" : "array", - "description" : "The funnels that matched the search.", - "items" : { - "$ref" : "#/definitions/ComponentSearchResultDTO" - } - }, - "parameterContextResults" : { - "type" : "array", - "description" : "The parameter contexts that matched the search.", - "items" : { - "$ref" : "#/definitions/ComponentSearchResultDTO" - } - }, - "parameterResults" : { - "type" : "array", - "description" : "The parameters that matched the search.", - "items" : { - "$ref" : "#/definitions/ComponentSearchResultDTO" - } - } - } - }, - "SearchResultsEntity" : { - "type" : "object", - "properties" : { - "searchResultsDTO" : { - "$ref" : "#/definitions/SearchResultsDTO" - } - }, - "xml" : { - "name" : "searchResultsEntity" - } - }, - "SnippetDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the snippet." - }, - "uri" : { - "type" : "string", - "description" : "The URI of the snippet." - }, - "parentGroupId" : { - "type" : "string", - "description" : "The group id for the components in the snippet." - }, - "processGroups" : { - "type" : "object", - "description" : "The ids of the process groups in this snippet. These ids will be populated within each response. They can be specified when creating a snippet. However, once a snippet has been created its contents cannot be modified (these ids are ignored during update requests).", - "additionalProperties" : { - "$ref" : "#/definitions/RevisionDTO" - } - }, - "remoteProcessGroups" : { - "type" : "object", - "description" : "The ids of the remote process groups in this snippet. These ids will be populated within each response. They can be specified when creating a snippet. However, once a snippet has been created its contents cannot be modified (these ids are ignored during update requests).", - "additionalProperties" : { - "$ref" : "#/definitions/RevisionDTO" - } - }, - "processors" : { - "type" : "object", - "description" : "The ids of the processors in this snippet. These ids will be populated within each response. They can be specified when creating a snippet. However, once a snippet has been created its contents cannot be modified (these ids are ignored during update requests).", - "additionalProperties" : { - "$ref" : "#/definitions/RevisionDTO" - } - }, - "inputPorts" : { - "type" : "object", - "description" : "The ids of the input ports in this snippet. These ids will be populated within each response. They can be specified when creating a snippet. However, once a snippet has been created its contents cannot be modified (these ids are ignored during update requests).", - "additionalProperties" : { - "$ref" : "#/definitions/RevisionDTO" - } - }, - "outputPorts" : { - "type" : "object", - "description" : "The ids of the output ports in this snippet. These ids will be populated within each response. They can be specified when creating a snippet. However, once a snippet has been created its contents cannot be modified (these ids are ignored during update requests).", - "additionalProperties" : { - "$ref" : "#/definitions/RevisionDTO" - } - }, - "connections" : { - "type" : "object", - "description" : "The ids of the connections in this snippet. These ids will be populated within each response. They can be specified when creating a snippet. However, once a snippet has been created its contents cannot be modified (these ids are ignored during update requests).", - "additionalProperties" : { - "$ref" : "#/definitions/RevisionDTO" - } - }, - "labels" : { - "type" : "object", - "description" : "The ids of the labels in this snippet. These ids will be populated within each response. They can be specified when creating a snippet. However, once a snippet has been created its contents cannot be modified (these ids are ignored during update requests).", - "additionalProperties" : { - "$ref" : "#/definitions/RevisionDTO" - } - }, - "funnels" : { - "type" : "object", - "description" : "The ids of the funnels in this snippet. These ids will be populated within each response. They can be specified when creating a snippet. However, once a snippet has been created its contents cannot be modified (these ids are ignored during update requests).", - "additionalProperties" : { - "$ref" : "#/definitions/RevisionDTO" - } - } - } - }, - "SnippetEntity" : { - "type" : "object", - "properties" : { - "snippet" : { - "description" : "The snippet.", - "$ref" : "#/definitions/SnippetDTO" - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - } - }, - "xml" : { - "name" : "snippetEntity" - } - }, - "StartVersionControlRequestEntity" : { - "type" : "object", - "properties" : { - "versionedFlow" : { - "description" : "The versioned flow", - "$ref" : "#/definitions/VersionedFlowDTO" - }, - "processGroupRevision" : { - "description" : "The Revision of the Process Group under Version Control", - "$ref" : "#/definitions/RevisionDTO" - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - } - }, - "xml" : { - "name" : "startVersionControlRequestEntity" - } - }, - "StateEntryDTO" : { - "type" : "object", - "properties" : { - "key" : { - "type" : "string", - "description" : "The key for this state." - }, - "value" : { - "type" : "string", - "description" : "The value for this state." - }, - "clusterNodeId" : { - "type" : "string", - "description" : "The identifier for the node where the state originated." - }, - "clusterNodeAddress" : { - "type" : "string", - "description" : "The label for the node where the state originated." - } - } - }, - "StateMapDTO" : { - "type" : "object", - "properties" : { - "scope" : { - "type" : "string", - "description" : "The scope of this StateMap." - }, - "totalEntryCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The total number of state entries. When the state map is lengthy, only of portion of the entries are returned." - }, - "state" : { - "type" : "array", - "description" : "The state.", - "items" : { - "$ref" : "#/definitions/StateEntryDTO" - } - } - } - }, - "StatusDescriptorDTO" : { - "type" : "object", - "properties" : { - "field" : { - "type" : "string", - "description" : "The name of the status field." - }, - "label" : { - "type" : "string", - "description" : "The label for the status field." - }, - "description" : { - "type" : "string", - "description" : "The description of the status field." - }, - "formatter" : { - "type" : "string", - "description" : "The formatter for the status descriptor." - } - } - }, - "StatusHistoryDTO" : { - "type" : "object", - "properties" : { - "generated" : { - "type" : "string", - "description" : "When the status history was generated." - }, - "componentDetails" : { - "type" : "object", - "description" : "A Map of key/value pairs that describe the component that the status history belongs to", - "additionalProperties" : { - "type" : "string" - } - }, - "fieldDescriptors" : { - "type" : "array", - "description" : "The Descriptors that provide information on each of the metrics provided in the status history", - "items" : { - "$ref" : "#/definitions/StatusDescriptorDTO" - } - }, - "aggregateSnapshots" : { - "type" : "array", - "description" : "A list of StatusSnapshotDTO objects that provide the actual metric values for the component. If the NiFi instance is clustered, this will represent the aggregate status across all nodes. If the NiFi instance is not clustered, this will represent the status of the entire NiFi instance.", - "items" : { - "$ref" : "#/definitions/StatusSnapshotDTO" - } - }, - "nodeSnapshots" : { - "type" : "array", - "description" : "The NodeStatusSnapshotsDTO objects that provide the actual metric values for the component, for each node. If the NiFi instance is not clustered, this value will be null.", - "items" : { - "$ref" : "#/definitions/NodeStatusSnapshotsDTO" - } - } - } - }, - "StatusHistoryEntity" : { - "type" : "object", - "properties" : { - "statusHistory" : { - "$ref" : "#/definitions/StatusHistoryDTO" - }, - "canRead" : { - "type" : "boolean", - "description" : "Indicates whether the user can read a given resource.", - "readOnly" : true - } - }, - "xml" : { - "name" : "statusHistoryEntity" - } - }, - "StatusSnapshotDTO" : { - "type" : "object", - "properties" : { - "timestamp" : { - "type" : "string", - "format" : "date-time", - "description" : "The timestamp of the snapshot." - }, - "statusMetrics" : { - "type" : "object", - "description" : "The status metrics.", - "additionalProperties" : { - "type" : "integer", - "format" : "int64" - } - } - } - }, - "StorageUsageDTO" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The identifier of this storage location. The identifier will correspond to the identifier keyed in the storage configuration." - }, - "freeSpace" : { - "type" : "string", - "description" : "Amount of free space." - }, - "totalSpace" : { - "type" : "string", - "description" : "Amount of total space." - }, - "usedSpace" : { - "type" : "string", - "description" : "Amount of used space." - }, - "freeSpaceBytes" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes of free space." - }, - "totalSpaceBytes" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes of total space." - }, - "usedSpaceBytes" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes of used space." - }, - "utilization" : { - "type" : "string", - "description" : "Utilization of this storage location." - } - } - }, - "StreamingOutput" : { - "type" : "object" - }, - "SubmitReplayRequestEntity" : { - "type" : "object", - "properties" : { - "eventId" : { - "type" : "integer", - "format" : "int64", - "description" : "The event identifier" - }, - "clusterNodeId" : { - "type" : "string", - "description" : "The identifier of the node where to submit the replay request." - } - }, - "xml" : { - "name" : "copySnippetRequestEntity" - } - }, - "SystemDiagnosticsDTO" : { - "type" : "object", - "properties" : { - "aggregateSnapshot" : { - "description" : "A systems diagnostic snapshot that represents the aggregate values of all nodes in the cluster. If the NiFi instance is a standalone instance, rather than a cluster, this represents the stats of the single instance.", - "$ref" : "#/definitions/SystemDiagnosticsSnapshotDTO" - }, - "nodeSnapshots" : { - "type" : "array", - "description" : "A systems diagnostics snapshot for each node in the cluster. If the NiFi instance is a standalone instance, rather than a cluster, this may be null.", - "items" : { - "$ref" : "#/definitions/NodeSystemDiagnosticsSnapshotDTO" - } - } - } - }, - "SystemDiagnosticsEntity" : { - "type" : "object", - "properties" : { - "systemDiagnostics" : { - "$ref" : "#/definitions/SystemDiagnosticsDTO" - } - }, - "xml" : { - "name" : "systemDiagnosticsEntity" - } - }, - "SystemDiagnosticsSnapshotDTO" : { - "type" : "object", - "properties" : { - "totalNonHeap" : { - "type" : "string", - "description" : "Total size of non heap." - }, - "totalNonHeapBytes" : { - "type" : "integer", - "format" : "int64", - "description" : "Total number of bytes allocated to the JVM not used for heap" - }, - "usedNonHeap" : { - "type" : "string", - "description" : "Amount of use non heap." - }, - "usedNonHeapBytes" : { - "type" : "integer", - "format" : "int64", - "description" : "Total number of bytes used by the JVM not in the heap space" - }, - "freeNonHeap" : { - "type" : "string", - "description" : "Amount of free non heap." - }, - "freeNonHeapBytes" : { - "type" : "integer", - "format" : "int64", - "description" : "Total number of free non-heap bytes available to the JVM" - }, - "maxNonHeap" : { - "type" : "string", - "description" : "Maximum size of non heap." - }, - "maxNonHeapBytes" : { - "type" : "integer", - "format" : "int64", - "description" : "The maximum number of bytes that the JVM can use for non-heap purposes" - }, - "nonHeapUtilization" : { - "type" : "string", - "description" : "Utilization of non heap." - }, - "totalHeap" : { - "type" : "string", - "description" : "Total size of heap." - }, - "totalHeapBytes" : { - "type" : "integer", - "format" : "int64", - "description" : "The total number of bytes that are available for the JVM heap to use" - }, - "usedHeap" : { - "type" : "string", - "description" : "Amount of used heap." - }, - "usedHeapBytes" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes of JVM heap that are currently being used" - }, - "freeHeap" : { - "type" : "string", - "description" : "Amount of free heap." - }, - "freeHeapBytes" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes that are allocated to the JVM heap but not currently being used" - }, - "maxHeap" : { - "type" : "string", - "description" : "Maximum size of heap." - }, - "maxHeapBytes" : { - "type" : "integer", - "format" : "int64", - "description" : "The maximum number of bytes that can be used by the JVM" - }, - "heapUtilization" : { - "type" : "string", - "description" : "Utilization of heap." - }, - "availableProcessors" : { - "type" : "integer", - "format" : "int32", - "description" : "Number of available processors if supported by the underlying system." - }, - "processorLoadAverage" : { - "type" : "number", - "format" : "double", - "description" : "The processor load average if supported by the underlying system." - }, - "totalThreads" : { - "type" : "integer", - "format" : "int32", - "description" : "Total number of threads." - }, - "daemonThreads" : { - "type" : "integer", - "format" : "int32", - "description" : "Number of daemon threads." - }, - "uptime" : { - "type" : "string", - "description" : "The uptime of the Java virtual machine" - }, - "flowFileRepositoryStorageUsage" : { - "description" : "The flowfile repository storage usage.", - "$ref" : "#/definitions/StorageUsageDTO" - }, - "contentRepositoryStorageUsage" : { - "type" : "array", - "description" : "The content repository storage usage.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/StorageUsageDTO" - } - }, - "provenanceRepositoryStorageUsage" : { - "type" : "array", - "description" : "The provenance repository storage usage.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/StorageUsageDTO" - } - }, - "garbageCollection" : { - "type" : "array", - "description" : "The garbage collection details.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/GarbageCollectionDTO" - } - }, - "statsLastRefreshed" : { - "type" : "string", - "description" : "When the diagnostics were generated." - }, - "versionInfo" : { - "description" : "The nifi, os, java, and build version information", - "$ref" : "#/definitions/VersionInfoDTO" - } - } - }, - "TemplateDTO" : { - "type" : "object", - "properties" : { - "uri" : { - "type" : "string", - "description" : "The URI for the template." - }, - "id" : { - "type" : "string", - "description" : "The id of the template." - }, - "groupId" : { - "type" : "string", - "description" : "The id of the Process Group that the template belongs to." - }, - "name" : { - "type" : "string", - "description" : "The name of the template." - }, - "description" : { - "type" : "string", - "description" : "The description of the template." - }, - "timestamp" : { - "type" : "string", - "description" : "The timestamp when this template was created." - }, - "encodingVersion" : { - "type" : "string", - "xml" : { - "name" : "encoding-version", - "attribute" : true - }, - "description" : "The encoding version of this template." - }, - "snippet" : { - "description" : "The contents of the template.", - "$ref" : "#/definitions/FlowSnippetDTO" - } - }, - "xml" : { - "name" : "template" - } - }, - "TemplateEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "template" : { - "$ref" : "#/definitions/TemplateDTO" - } - }, - "xml" : { - "name" : "templateEntity" - } - }, - "TemplatesEntity" : { - "type" : "object", - "properties" : { - "templates" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/TemplateEntity" - } - }, - "generated" : { - "type" : "string", - "description" : "When this content was generated." - } - }, - "xml" : { - "name" : "templatesEntity" - } - }, - "TenantDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "versionedComponentId" : { - "type" : "string", - "description" : "The ID of the corresponding component that is under version control" - }, - "parentGroupId" : { - "type" : "string", - "description" : "The id of parent process group of this component if applicable." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "identity" : { - "type" : "string", - "description" : "The identity of the tenant." - }, - "configurable" : { - "type" : "boolean", - "description" : "Whether this tenant is configurable." - } - } - }, - "TenantEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "component" : { - "$ref" : "#/definitions/TenantDTO" - } - }, - "xml" : { - "name" : "tenantEntity" - } - }, - "TenantsEntity" : { - "type" : "object", - "properties" : { - "users" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/TenantEntity" - } - }, - "userGroups" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/TenantEntity" - } - } - }, - "xml" : { - "name" : "tenantsEntity" - } - }, - "TransactionResultEntity" : { - "type" : "object", - "properties" : { - "flowFileSent" : { - "type" : "integer", - "format" : "int32" - }, - "responseCode" : { - "type" : "integer", - "format" : "int32" - }, - "message" : { - "type" : "string" - } - }, - "xml" : { - "name" : "transactionResultEntity" - } - }, - "UpdateControllerServiceReferenceRequestEntity" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The identifier of the Controller Service." - }, - "state" : { - "type" : "string", - "description" : "The new state of the references for the controller service.", - "enum" : [ "ENABLED", "DISABLED", "RUNNING", "STOPPED" ] - }, - "referencingComponentRevisions" : { - "type" : "object", - "description" : "The revisions for all referencing components.", - "additionalProperties" : { - "$ref" : "#/definitions/RevisionDTO" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - } - }, - "xml" : { - "name" : "updateControllerServiceReferenceRequestEntity" - } - }, - "UserDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "versionedComponentId" : { - "type" : "string", - "description" : "The ID of the corresponding component that is under version control" - }, - "parentGroupId" : { - "type" : "string", - "description" : "The id of parent process group of this component if applicable." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "identity" : { - "type" : "string", - "description" : "The identity of the tenant." - }, - "configurable" : { - "type" : "boolean", - "description" : "Whether this tenant is configurable." - }, - "userGroups" : { - "type" : "array", - "description" : "The groups to which the user belongs. This field is read only and it provided for convenience.", - "readOnly" : true, - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/TenantEntity" - } - }, - "accessPolicies" : { - "type" : "array", - "description" : "The access policies this user belongs to.", - "readOnly" : true, - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/AccessPolicySummaryEntity" - } - } - } - }, - "UserEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "component" : { - "$ref" : "#/definitions/UserDTO" - } - }, - "xml" : { - "name" : "userEntity" - } - }, - "UserGroupDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "versionedComponentId" : { - "type" : "string", - "description" : "The ID of the corresponding component that is under version control" - }, - "parentGroupId" : { - "type" : "string", - "description" : "The id of parent process group of this component if applicable." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "identity" : { - "type" : "string", - "description" : "The identity of the tenant." - }, - "configurable" : { - "type" : "boolean", - "description" : "Whether this tenant is configurable." - }, - "users" : { - "type" : "array", - "description" : "The users that belong to the user group.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/TenantEntity" - } - }, - "accessPolicies" : { - "type" : "array", - "description" : "The access policies this user group belongs to. This field was incorrectly defined as an AccessPolicyEntity. For compatibility reasons the field will remain of this type, however only the fields that are present in the AccessPolicySummaryEntity will be populated here.", - "readOnly" : true, - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/AccessPolicyEntity" - } - } - } - }, - "UserGroupEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "component" : { - "$ref" : "#/definitions/UserGroupDTO" - } - }, - "xml" : { - "name" : "userGroupEntity" - } - }, - "UserGroupsEntity" : { - "type" : "object", - "properties" : { - "userGroups" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/UserGroupEntity" - } - } - }, - "xml" : { - "name" : "userGroupsEntity" - } - }, - "UsersEntity" : { - "type" : "object", - "properties" : { - "generated" : { - "type" : "string", - "description" : "When this content was generated." - }, - "users" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/UserEntity" - } - } - }, - "xml" : { - "name" : "usersEntity" - } - }, - "VariableDTO" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The name of the variable" - }, - "value" : { - "type" : "string", - "description" : "The value of the variable" - }, - "processGroupId" : { - "type" : "string", - "description" : "The ID of the Process Group where this Variable is defined", - "readOnly" : true - }, - "affectedComponents" : { - "type" : "array", - "description" : "A set of all components that will be affected if the value of this variable is changed", - "readOnly" : true, - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/AffectedComponentEntity" - } - } - } - }, - "VariableEntity" : { - "type" : "object", - "properties" : { - "variable" : { - "description" : "The variable information", - "$ref" : "#/definitions/VariableDTO" - }, - "canWrite" : { - "type" : "boolean", - "description" : "Indicates whether the user can write a given resource.", - "readOnly" : true - } - }, - "xml" : { - "name" : "variableEntity" - } - }, - "VariableRegistryDTO" : { - "type" : "object", - "properties" : { - "variables" : { - "type" : "array", - "description" : "The variables that are available in this Variable Registry", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VariableEntity" - } - }, - "processGroupId" : { - "type" : "string", - "description" : "The UUID of the Process Group that this Variable Registry belongs to" - } - } - }, - "VariableRegistryEntity" : { - "type" : "object", - "properties" : { - "processGroupRevision" : { - "description" : "The revision of the Process Group that the Variable Registry belongs to", - "$ref" : "#/definitions/RevisionDTO" - }, - "variableRegistry" : { - "description" : "The Variable Registry.", - "$ref" : "#/definitions/VariableRegistryDTO" - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - } - }, - "xml" : { - "name" : "variableRegistryEntity" - } - }, - "VariableRegistryUpdateRequestDTO" : { - "type" : "object", - "properties" : { - "requestId" : { - "type" : "string", - "description" : "The ID of the request", - "readOnly" : true - }, - "uri" : { - "type" : "string", - "description" : "The URI for the request", - "readOnly" : true - }, - "submissionTime" : { - "type" : "string", - "format" : "date-time", - "description" : "The timestamp of when the request was submitted", - "readOnly" : true - }, - "lastUpdated" : { - "type" : "string", - "format" : "date-time", - "description" : "The timestamp of when the request was last updated", - "readOnly" : true - }, - "complete" : { - "type" : "boolean", - "description" : "Whether or not the request is completed", - "readOnly" : true - }, - "failureReason" : { - "type" : "string", - "description" : "The reason for the request failing, or null if the request has not failed", - "readOnly" : true - }, - "percentCompleted" : { - "type" : "integer", - "format" : "int32", - "description" : "A value between 0 and 100 (inclusive) indicating how close the request is to completion", - "readOnly" : true - }, - "state" : { - "type" : "string", - "description" : "A description of the current state of the request", - "readOnly" : true - }, - "updateSteps" : { - "type" : "array", - "description" : "The steps that are required in order to complete the request, along with the status of each", - "readOnly" : true, - "items" : { - "$ref" : "#/definitions/VariableRegistryUpdateStepDTO" - } - }, - "processGroupId" : { - "type" : "string", - "description" : "The unique ID of the Process Group that the variable registry belongs to" - }, - "affectedComponents" : { - "type" : "array", - "description" : "A set of all components that will be affected if the value of this variable is changed", - "readOnly" : true, - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/AffectedComponentEntity" - } - } - } - }, - "VariableRegistryUpdateRequestEntity" : { - "type" : "object", - "properties" : { - "request" : { - "description" : "The Variable Registry Update Request", - "$ref" : "#/definitions/VariableRegistryUpdateRequestDTO" - }, - "processGroupRevision" : { - "description" : "The revision for the Process Group that owns this variable registry.", - "$ref" : "#/definitions/RevisionDTO" - } - }, - "xml" : { - "name" : "variableRegistryUpdateRequestEntity" - } - }, - "VariableRegistryUpdateStepDTO" : { - "type" : "object", - "properties" : { - "description" : { - "type" : "string", - "description" : "Explanation of what happens in this step", - "readOnly" : true - }, - "complete" : { - "type" : "boolean", - "description" : "Whether or not this step has completed", - "readOnly" : true - }, - "failureReason" : { - "type" : "string", - "description" : "An explanation of why this step failed, or null if this step did not fail", - "readOnly" : true - } - } - }, - "VersionControlComponentMappingEntity" : { - "type" : "object", - "properties" : { - "versionControlComponentMapping" : { - "type" : "object", - "description" : "The mapping of Versioned Component Identifiers to instance ID's", - "additionalProperties" : { - "type" : "string" - } - }, - "processGroupRevision" : { - "description" : "The revision of the Process Group", - "$ref" : "#/definitions/RevisionDTO" - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "versionControlInformation" : { - "description" : "The Version Control information", - "$ref" : "#/definitions/VersionControlInformationDTO" - } - }, - "xml" : { - "name" : "versionControlComponentMappingEntity" - } - }, - "VersionControlInformationDTO" : { - "type" : "object", - "properties" : { - "groupId" : { - "type" : "string", - "description" : "The ID of the Process Group that is under version control" - }, - "registryId" : { - "type" : "string", - "description" : "The ID of the registry that the flow is stored in" - }, - "registryName" : { - "type" : "string", - "description" : "The name of the registry that the flow is stored in", - "readOnly" : true - }, - "bucketId" : { - "type" : "string", - "description" : "The ID of the bucket that the flow is stored in" - }, - "bucketName" : { - "type" : "string", - "description" : "The name of the bucket that the flow is stored in", - "readOnly" : true - }, - "flowId" : { - "type" : "string", - "description" : "The ID of the flow" - }, - "flowName" : { - "type" : "string", - "description" : "The name of the flow" - }, - "flowDescription" : { - "type" : "string", - "description" : "The description of the flow" - }, - "version" : { - "type" : "integer", - "format" : "int32", - "description" : "The version of the flow" - }, - "state" : { - "type" : "string", - "description" : "The current state of the Process Group, as it relates to the Versioned Flow", - "readOnly" : true, - "enum" : [ "LOCALLY_MODIFIED", "STALE", "LOCALLY_MODIFIED_AND_STALE", "UP_TO_DATE", "SYNC_FAILURE" ] - }, - "stateExplanation" : { - "type" : "string", - "description" : "Explanation of why the group is in the specified state", - "readOnly" : true - } - } - }, - "VersionControlInformationEntity" : { - "type" : "object", - "properties" : { - "versionControlInformation" : { - "description" : "The Version Control information", - "$ref" : "#/definitions/VersionControlInformationDTO" - }, - "processGroupRevision" : { - "description" : "The Revision for the Process Group", - "$ref" : "#/definitions/RevisionDTO" - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - } - }, - "xml" : { - "name" : "versionControlInformationEntity" - } - }, - "VersionInfoDTO" : { - "type" : "object", - "properties" : { - "niFiVersion" : { - "type" : "string", - "description" : "The version of this NiFi." - }, - "javaVendor" : { - "type" : "string", - "description" : "Java JVM vendor" - }, - "javaVersion" : { - "type" : "string", - "description" : "Java version" - }, - "osName" : { - "type" : "string", - "description" : "Host operating system name" - }, - "osVersion" : { - "type" : "string", - "description" : "Host operating system version" - }, - "osArchitecture" : { - "type" : "string", - "description" : "Host operating system architecture" - }, - "buildTag" : { - "type" : "string", - "description" : "Build tag" - }, - "buildRevision" : { - "type" : "string", - "description" : "Build revision or commit hash" - }, - "buildBranch" : { - "type" : "string", - "description" : "Build branch" - }, - "buildTimestamp" : { - "type" : "string", - "format" : "date-time", - "description" : "Build timestamp" - } - } - }, - "VersionedConnection" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The component's unique identifier" - }, - "name" : { - "type" : "string", - "description" : "The component's name" - }, - "comments" : { - "type" : "string", - "description" : "The user-supplied comments for the component" - }, - "position" : { - "description" : "The component's position on the graph", - "$ref" : "#/definitions/Position" - }, - "source" : { - "description" : "The source of the connection.", - "$ref" : "#/definitions/ConnectableComponent" - }, - "destination" : { - "description" : "The destination of the connection.", - "$ref" : "#/definitions/ConnectableComponent" - }, - "labelIndex" : { - "type" : "integer", - "format" : "int32", - "description" : "The index of the bend point where to place the connection label." - }, - "zIndex" : { - "type" : "integer", - "format" : "int64", - "description" : "The z index of the connection." - }, - "selectedRelationships" : { - "type" : "array", - "description" : "The selected relationship that comprise the connection.", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - }, - "backPressureObjectThreshold" : { - "type" : "integer", - "format" : "int64", - "description" : "The object count threshold for determining when back pressure is applied. Updating this value is a passive change in the sense that it won't impact whether existing files over the limit are affected but it does help feeder processors to stop pushing too much into this work queue." - }, - "backPressureDataSizeThreshold" : { - "type" : "string", - "description" : "The object data size threshold for determining when back pressure is applied. Updating this value is a passive change in the sense that it won't impact whether existing files over the limit are affected but it does help feeder processors to stop pushing too much into this work queue." - }, - "flowFileExpiration" : { - "type" : "string", - "description" : "The amount of time a flow file may be in the flow before it will be automatically aged out of the flow. Once a flow file reaches this age it will be terminated from the flow the next time a processor attempts to start work on it." - }, - "prioritizers" : { - "type" : "array", - "description" : "The comparators used to prioritize the queue.", - "items" : { - "type" : "string" - } - }, - "bends" : { - "type" : "array", - "description" : "The bend points on the connection.", - "items" : { - "$ref" : "#/definitions/Position" - } - }, - "loadBalanceStrategy" : { - "type" : "string", - "description" : "The Strategy to use for load balancing data across the cluster, or null, if no Load Balance Strategy has been specified.", - "enum" : [ "DO_NOT_LOAD_BALANCE", "PARTITION_BY_ATTRIBUTE", "ROUND_ROBIN", "SINGLE_NODE" ] - }, - "partitioningAttribute" : { - "type" : "string", - "description" : "The attribute to use for partitioning data as it is load balanced across the cluster. If the Load Balance Strategy is configured to use PARTITION_BY_ATTRIBUTE, the value returned by this method is the name of the FlowFile Attribute that will be used to determine which node in the cluster should receive a given FlowFile. If the Load Balance Strategy is unset or is set to any other value, the Partitioning Attribute has no effect." - }, - "loadBalanceCompression" : { - "type" : "string", - "description" : "Whether or not compression should be used when transferring FlowFiles between nodes", - "enum" : [ "DO_NOT_COMPRESS", "COMPRESS_ATTRIBUTES_ONLY", "COMPRESS_ATTRIBUTES_AND_CONTENT" ] - }, - "componentType" : { - "type" : "string", - "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE" ] - }, - "groupIdentifier" : { - "type" : "string", - "description" : "The ID of the Process Group that this component belongs to" - } - } - }, - "VersionedControllerService" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The component's unique identifier" - }, - "name" : { - "type" : "string", - "description" : "The component's name" - }, - "comments" : { - "type" : "string", - "description" : "The user-supplied comments for the component" - }, - "position" : { - "description" : "The component's position on the graph", - "$ref" : "#/definitions/Position" - }, - "type" : { - "type" : "string", - "description" : "The type of the controller service." - }, - "bundle" : { - "description" : "The details of the artifact that bundled this processor type.", - "$ref" : "#/definitions/Bundle" - }, - "controllerServiceApis" : { - "type" : "array", - "description" : "Lists the APIs this Controller Service implements.", - "items" : { - "$ref" : "#/definitions/ControllerServiceAPI" - } - }, - "properties" : { - "type" : "object", - "description" : "The properties of the controller service.", - "additionalProperties" : { - "type" : "string" - } - }, - "propertyDescriptors" : { - "type" : "object", - "description" : "The property descriptors for the processor.", - "additionalProperties" : { - "$ref" : "#/definitions/VersionedPropertyDescriptor" - } - }, - "annotationData" : { - "type" : "string", - "description" : "The annotation for the controller service. This is how the custom UI relays configuration to the controller service." - }, - "componentType" : { - "type" : "string", - "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE" ] - }, - "groupIdentifier" : { - "type" : "string", - "description" : "The ID of the Process Group that this component belongs to" - } - } - }, - "VersionedFlow" : { - "type" : "object", - "required" : [ "bucketIdentifier", "name", "type" ], - "properties" : { - "link" : { - "description" : "An WebLink to this entity.", - "readOnly" : true, - "$ref" : "#/definitions/JaxbLink" - }, - "identifier" : { - "type" : "string", - "description" : "An ID to uniquely identify this object.", - "readOnly" : true - }, - "name" : { - "type" : "string", - "description" : "The name of the item." - }, - "description" : { - "type" : "string", - "description" : "A description of the item." - }, - "bucketIdentifier" : { - "type" : "string", - "description" : "The identifier of the bucket this items belongs to. This cannot be changed after the item is created." - }, - "bucketName" : { - "type" : "string", - "description" : "The name of the bucket this items belongs to.", - "readOnly" : true - }, - "createdTimestamp" : { - "type" : "integer", - "format" : "int64", - "description" : "The timestamp of when the item was created, as milliseconds since epoch.", - "readOnly" : true, - "minimum" : 1 - }, - "modifiedTimestamp" : { - "type" : "integer", - "format" : "int64", - "description" : "The timestamp of when the item was last modified, as milliseconds since epoch.", - "readOnly" : true, - "minimum" : 1 - }, - "type" : { - "type" : "string", - "description" : "The type of item.", - "enum" : [ "Flow", "Bundle" ] - }, - "permissions" : { - "description" : "The access that the current user has to the bucket containing this item.", - "readOnly" : true, - "$ref" : "#/definitions/Permissions" - }, - "versionCount" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of versions of this flow.", - "readOnly" : true, - "minimum" : 0 - } - } - }, - "VersionedFlowCoordinates" : { - "type" : "object", - "properties" : { - "registryUrl" : { - "type" : "string", - "description" : "The URL of the Flow Registry that contains the flow" - }, - "bucketId" : { - "type" : "string", - "description" : "The UUID of the bucket that the flow resides in" - }, - "flowId" : { - "type" : "string", - "description" : "The UUID of the flow" - }, - "version" : { - "type" : "integer", - "format" : "int32", - "description" : "The version of the flow" - }, - "latest" : { - "type" : "boolean", - "description" : "Whether or not these coordinates point to the latest version of the flow" - } - } - }, - "VersionedFlowDTO" : { - "type" : "object", - "properties" : { - "registryId" : { - "type" : "string", - "description" : "The ID of the registry that the flow is tracked to" - }, - "bucketId" : { - "type" : "string", - "description" : "The ID of the bucket where the flow is stored" - }, - "flowId" : { - "type" : "string", - "description" : "The ID of the flow" - }, - "flowName" : { - "type" : "string", - "description" : "The name of the flow" - }, - "description" : { - "type" : "string", - "description" : "A description of the flow" - }, - "comments" : { - "type" : "string", - "description" : "Comments for the changeset" - }, - "action" : { - "type" : "string", - "description" : "The action being performed", - "enum" : [ "COMMIT", "FORCE_COMMIT" ] - } - } - }, - "VersionedFlowEntity" : { - "type" : "object", - "properties" : { - "versionedFlow" : { - "description" : "The versioned flow", - "$ref" : "#/definitions/VersionedFlowDTO" - } - }, - "xml" : { - "name" : "versionedFlowEntity" - } - }, - "VersionedFlowSnapshot" : { - "type" : "object", - "required" : [ "flowContents", "snapshotMetadata" ], - "properties" : { - "snapshotMetadata" : { - "description" : "The metadata for this snapshot", - "$ref" : "#/definitions/VersionedFlowSnapshotMetadata" - }, - "flowContents" : { - "description" : "The contents of the versioned flow", - "$ref" : "#/definitions/VersionedProcessGroup" - }, - "externalControllerServices" : { - "type" : "object", - "description" : "The information about controller services that exist outside this versioned flow, but are referenced by components within the versioned flow.", - "additionalProperties" : { - "$ref" : "#/definitions/ExternalControllerServiceReference" - } - }, - "parameterContexts" : { - "type" : "object", - "description" : "The parameter contexts referenced by process groups in the flow contents. The mapping is from the name of the context to the context instance, and it is expected that any context in this map is referenced by at least one process group in this flow.", - "additionalProperties" : { - "$ref" : "#/definitions/VersionedParameterContext" - } - }, - "flowEncodingVersion" : { - "type" : "string", - "description" : "The optional encoding version of the flow contents." - }, - "flow" : { - "description" : "The flow this snapshot is for", - "readOnly" : true, - "$ref" : "#/definitions/VersionedFlow" - }, - "bucket" : { - "description" : "The bucket where the flow is located", - "readOnly" : true, - "$ref" : "#/definitions/Bucket" - }, - "latest" : { - "type" : "boolean" - } - } - }, - "VersionedFlowSnapshotEntity" : { - "type" : "object", - "properties" : { - "versionedFlowSnapshot" : { - "description" : "The versioned flow snapshot", - "$ref" : "#/definitions/VersionedFlowSnapshot" - }, - "processGroupRevision" : { - "description" : "The Revision of the Process Group under Version Control", - "$ref" : "#/definitions/RevisionDTO" - }, - "registryId" : { - "type" : "string", - "description" : "The ID of the Registry that this flow belongs to" - }, - "updateDescendantVersionedFlows" : { - "type" : "boolean", - "description" : "If the Process Group to be updated has a child or descendant Process Group that is also under Version Control, this specifies whether or not the contents of that child/descendant Process Group should be updated." - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - } - }, - "xml" : { - "name" : "versionedFlowSnapshotEntity" - } - }, - "VersionedFlowSnapshotMetadata" : { - "type" : "object", - "required" : [ "bucketIdentifier", "flowIdentifier", "version" ], - "properties" : { - "link" : { - "description" : "An WebLink to this entity.", - "readOnly" : true, - "$ref" : "#/definitions/JaxbLink" - }, - "bucketIdentifier" : { - "type" : "string", - "description" : "The identifier of the bucket this snapshot belongs to." - }, - "flowIdentifier" : { - "type" : "string", - "description" : "The identifier of the flow this snapshot belongs to." - }, - "version" : { - "type" : "integer", - "format" : "int32", - "description" : "The version of this snapshot of the flow.", - "minimum" : -1 - }, - "timestamp" : { - "type" : "integer", - "format" : "int64", - "description" : "The timestamp when the flow was saved, as milliseconds since epoch.", - "readOnly" : true, - "minimum" : 1 - }, - "author" : { - "type" : "string", - "description" : "The user that created this snapshot of the flow.", - "readOnly" : true - }, - "comments" : { - "type" : "string", - "description" : "The comments provided by the user when creating the snapshot." - } - } - }, - "VersionedFlowSnapshotMetadataEntity" : { - "type" : "object", - "properties" : { - "versionedFlowSnapshotMetadata" : { - "description" : "The collection of versioned flow snapshot metadata", - "$ref" : "#/definitions/VersionedFlowSnapshotMetadata" - }, - "registryId" : { - "type" : "string", - "description" : "The ID of the Registry that this flow belongs to" - } - }, - "xml" : { - "name" : "versionedFlowSnapshotMetadataEntity" - } - }, - "VersionedFlowSnapshotMetadataSetEntity" : { - "type" : "object", - "properties" : { - "versionedFlowSnapshotMetadataSet" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedFlowSnapshotMetadataEntity" - } - } - }, - "xml" : { - "name" : "versionedFlowSnapshotMetadataSetEntity" - } - }, - "VersionedFlowUpdateRequestDTO" : { - "type" : "object", - "properties" : { - "requestId" : { - "type" : "string", - "description" : "The unique ID of this request.", - "readOnly" : true - }, - "processGroupId" : { - "type" : "string", - "description" : "The unique ID of the Process Group that the variable registry belongs to" - }, - "uri" : { - "type" : "string", - "description" : "The URI for future requests to this drop request.", - "readOnly" : true - }, - "lastUpdated" : { - "type" : "string", - "description" : "The last time this request was updated.", - "readOnly" : true - }, - "complete" : { - "type" : "boolean", - "description" : "Whether or not this request has completed", - "readOnly" : true - }, - "failureReason" : { - "type" : "string", - "description" : "An explanation of why this request failed, or null if this request has not failed", - "readOnly" : true - }, - "percentCompleted" : { - "type" : "integer", - "format" : "int32", - "description" : "The percentage complete for the request, between 0 and 100", - "readOnly" : true - }, - "state" : { - "type" : "string", - "description" : "The state of the request", - "readOnly" : true - }, - "versionControlInformation" : { - "description" : "The VersionControlInformation that describes where the Versioned Flow is located; this may not be populated until the request is completed.", - "readOnly" : true, - "$ref" : "#/definitions/VersionControlInformationDTO" - } - } - }, - "VersionedFlowUpdateRequestEntity" : { - "type" : "object", - "properties" : { - "request" : { - "description" : "The Versioned Flow Update Request", - "$ref" : "#/definitions/VersionedFlowUpdateRequestDTO" - }, - "processGroupRevision" : { - "description" : "The revision for the Process Group that owns this variable registry.", - "$ref" : "#/definitions/RevisionDTO" - } - }, - "xml" : { - "name" : "versionedFlowUpdateRequestEntity" - } - }, - "VersionedFlowsEntity" : { - "type" : "object", - "properties" : { - "versionedFlows" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedFlowEntity" - } - } - }, - "xml" : { - "name" : "versionedFlowsEntity" - } - }, - "VersionedFunnel" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The component's unique identifier" - }, - "name" : { - "type" : "string", - "description" : "The component's name" - }, - "comments" : { - "type" : "string", - "description" : "The user-supplied comments for the component" - }, - "position" : { - "description" : "The component's position on the graph", - "$ref" : "#/definitions/Position" - }, - "componentType" : { - "type" : "string", - "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE" ] - }, - "groupIdentifier" : { - "type" : "string", - "description" : "The ID of the Process Group that this component belongs to" - } - } - }, - "VersionedLabel" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The component's unique identifier" - }, - "name" : { - "type" : "string", - "description" : "The component's name" - }, - "comments" : { - "type" : "string", - "description" : "The user-supplied comments for the component" - }, - "position" : { - "description" : "The component's position on the graph", - "$ref" : "#/definitions/Position" - }, - "label" : { - "type" : "string", - "description" : "The text that appears in the label." - }, - "width" : { - "type" : "number", - "format" : "double", - "description" : "The width of the label in pixels when at a 1:1 scale." - }, - "height" : { - "type" : "number", - "format" : "double", - "description" : "The height of the label in pixels when at a 1:1 scale." - }, - "style" : { - "type" : "object", - "description" : "The styles for this label (font-size : 12px, background-color : #eee, etc).", - "additionalProperties" : { - "type" : "string" - } - }, - "componentType" : { - "type" : "string", - "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE" ] - }, - "groupIdentifier" : { - "type" : "string", - "description" : "The ID of the Process Group that this component belongs to" - } - } - }, - "VersionedParameter" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The name of the parameter" - }, - "description" : { - "type" : "string", - "description" : "The description of the param" - }, - "sensitive" : { - "type" : "boolean", - "description" : "Whether or not the parameter value is sensitive" - }, - "value" : { - "type" : "string", - "description" : "The value of the parameter" - } - } - }, - "VersionedParameterContext" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The name of the context" - }, - "description" : { - "type" : "string", - "description" : "The description of the parameter context" - }, - "parameters" : { - "type" : "array", - "description" : "The parameters in the context", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedParameter" - } - } - } - }, - "VersionedPort" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The component's unique identifier" - }, - "name" : { - "type" : "string", - "description" : "The component's name" - }, - "comments" : { - "type" : "string", - "description" : "The user-supplied comments for the component" - }, - "position" : { - "description" : "The component's position on the graph", - "$ref" : "#/definitions/Position" - }, - "type" : { - "type" : "string", - "description" : "The type of port.", - "enum" : [ "INPUT_PORT", "OUTPUT_PORT" ] - }, - "concurrentlySchedulableTaskCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of tasks that should be concurrently scheduled for the port." - }, - "scheduledState" : { - "type" : "string", - "description" : "The scheduled state of the component", - "enum" : [ "ENABLED", "DISABLED" ] - }, - "allowRemoteAccess" : { - "type" : "boolean", - "description" : "Whether or not this port allows remote access for site-to-site" - }, - "componentType" : { - "type" : "string", - "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE" ] - }, - "groupIdentifier" : { - "type" : "string", - "description" : "The ID of the Process Group that this component belongs to" - } - } - }, - "VersionedProcessGroup" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The component's unique identifier" - }, - "name" : { - "type" : "string", - "description" : "The component's name" - }, - "comments" : { - "type" : "string", - "description" : "The user-supplied comments for the component" - }, - "position" : { - "description" : "The component's position on the graph", - "$ref" : "#/definitions/Position" - }, - "processGroups" : { - "type" : "array", - "description" : "The child Process Groups", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedProcessGroup" - } - }, - "remoteProcessGroups" : { - "type" : "array", - "description" : "The Remote Process Groups", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedRemoteProcessGroup" - } - }, - "processors" : { - "type" : "array", - "description" : "The Processors", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedProcessor" - } - }, - "inputPorts" : { - "type" : "array", - "description" : "The Input Ports", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedPort" - } - }, - "outputPorts" : { - "type" : "array", - "description" : "The Output Ports", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedPort" - } - }, - "connections" : { - "type" : "array", - "description" : "The Connections", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedConnection" - } - }, - "labels" : { - "type" : "array", - "description" : "The Labels", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedLabel" - } - }, - "funnels" : { - "type" : "array", - "description" : "The Funnels", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedFunnel" - } - }, - "controllerServices" : { - "type" : "array", - "description" : "The Controller Services", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedControllerService" - } - }, - "versionedFlowCoordinates" : { - "description" : "The coordinates where the remote flow is stored, or null if the Process Group is not directly under Version Control", - "$ref" : "#/definitions/VersionedFlowCoordinates" - }, - "variables" : { - "type" : "object", - "description" : "The Variables in the Variable Registry for this Process Group (not including any ancestor or descendant Process Groups)", - "additionalProperties" : { - "type" : "string" - } - }, - "parameterContextName" : { - "type" : "string", - "description" : "The name of the parameter context used by this process group" - }, - "componentType" : { - "type" : "string", - "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE" ] - }, - "groupIdentifier" : { - "type" : "string", - "description" : "The ID of the Process Group that this component belongs to" - } - } - }, - "VersionedProcessor" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The component's unique identifier" - }, - "name" : { - "type" : "string", - "description" : "The component's name" - }, - "comments" : { - "type" : "string", - "description" : "The user-supplied comments for the component" - }, - "position" : { - "description" : "The component's position on the graph", - "$ref" : "#/definitions/Position" - }, - "bundle" : { - "description" : "Information about the bundle from which the component came", - "$ref" : "#/definitions/Bundle" - }, - "style" : { - "type" : "object", - "description" : "Stylistic data for rendering in a UI", - "additionalProperties" : { - "type" : "string" - } - }, - "type" : { - "type" : "string", - "description" : "The type of Processor" - }, - "properties" : { - "type" : "object", - "description" : "The properties for the processor. Properties whose value is not set will only contain the property name.", - "additionalProperties" : { - "type" : "string" - } - }, - "propertyDescriptors" : { - "type" : "object", - "description" : "The property descriptors for the processor.", - "additionalProperties" : { - "$ref" : "#/definitions/VersionedPropertyDescriptor" - } - }, - "annotationData" : { - "type" : "string", - "description" : "The annotation data for the processor used to relay configuration between a custom UI and the procesosr." - }, - "schedulingPeriod" : { - "type" : "string", - "description" : "The frequency with which to schedule the processor. The format of the value will depend on th value of schedulingStrategy." - }, - "schedulingStrategy" : { - "type" : "string", - "description" : "Indcates whether the prcessor should be scheduled to run in event or timer driven mode." - }, - "executionNode" : { - "type" : "string", - "description" : "Indicates the node where the process will execute." - }, - "penaltyDuration" : { - "type" : "string", - "description" : "The amout of time that is used when the process penalizes a flowfile." - }, - "yieldDuration" : { - "type" : "string", - "description" : "The amount of time that must elapse before this processor is scheduled again after yielding." - }, - "bulletinLevel" : { - "type" : "string", - "description" : "The level at which the processor will report bulletins." - }, - "runDurationMillis" : { - "type" : "integer", - "format" : "int64", - "description" : "The run duration for the processor in milliseconds." - }, - "concurrentlySchedulableTaskCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of tasks that should be concurrently schedule for the processor. If the processor doesn't allow parallol processing then any positive input will be ignored." - }, - "autoTerminatedRelationships" : { - "type" : "array", - "description" : "The names of all relationships that cause a flow file to be terminated if the relationship is not connected elsewhere. This property differs from the 'isAutoTerminate' property of the RelationshipDTO in that the RelationshipDTO is meant to depict the current configuration, whereas this property can be set in a DTO when updating a Processor in order to change which Relationships should be auto-terminated.", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - }, - "scheduledState" : { - "type" : "string", - "description" : "The scheduled state of the component", - "enum" : [ "ENABLED", "DISABLED" ] - }, - "componentType" : { - "type" : "string", - "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE" ] - }, - "groupIdentifier" : { - "type" : "string", - "description" : "The ID of the Process Group that this component belongs to" - } - } - }, - "VersionedPropertyDescriptor" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The name of the property" - }, - "displayName" : { - "type" : "string", - "description" : "The display name of the property" - }, - "identifiesControllerService" : { - "type" : "boolean", - "description" : "Whether or not the property provides the identifier of a Controller Service" - }, - "sensitive" : { - "type" : "boolean", - "description" : "Whether or not the property is considered sensitive" - } - } - }, - "VersionedRemoteGroupPort" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The component's unique identifier" - }, - "name" : { - "type" : "string", - "description" : "The component's name" - }, - "comments" : { - "type" : "string", - "description" : "The user-supplied comments for the component" - }, - "position" : { - "description" : "The component's position on the graph", - "$ref" : "#/definitions/Position" - }, - "remoteGroupId" : { - "type" : "string", - "description" : "The id of the remote process group that the port resides in." - }, - "concurrentlySchedulableTaskCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of task that may transmit flowfiles to the target port concurrently." - }, - "useCompression" : { - "type" : "boolean", - "description" : "Whether the flowfiles are compressed when sent to the target port." - }, - "batchSize" : { - "description" : "The batch settings for data transmission.", - "$ref" : "#/definitions/BatchSize" - }, - "componentType" : { - "type" : "string", - "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE" ] - }, - "targetId" : { - "type" : "string", - "description" : "The ID of the port on the target NiFi instance" - }, - "scheduledState" : { - "type" : "string", - "description" : "The scheduled state of the component", - "enum" : [ "ENABLED", "DISABLED" ] - }, - "groupIdentifier" : { - "type" : "string", - "description" : "The ID of the Process Group that this component belongs to" - } - } - }, - "VersionedRemoteProcessGroup" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The component's unique identifier" - }, - "name" : { - "type" : "string", - "description" : "The component's name" - }, - "comments" : { - "type" : "string", - "description" : "The user-supplied comments for the component" - }, - "position" : { - "description" : "The component's position on the graph", - "$ref" : "#/definitions/Position" - }, - "targetUri" : { - "type" : "string", - "description" : "[DEPRECATED] The target URI of the remote process group. If target uri is not set, but uris are set, then returns the first uri in the uris. If neither target uri nor uris are set, then returns null." - }, - "targetUris" : { - "type" : "string", - "description" : "The target URIs of the remote process group. If target uris is not set but target uri is set, then returns the single target uri. If neither target uris nor target uri is set, then returns null." - }, - "communicationsTimeout" : { - "type" : "string", - "description" : "The time period used for the timeout when communicating with the target." - }, - "yieldDuration" : { - "type" : "string", - "description" : "When yielding, this amount of time must elapse before the remote process group is scheduled again." - }, - "transportProtocol" : { - "type" : "string", - "description" : "The Transport Protocol that is used for Site-to-Site communications", - "enum" : [ "RAW", "HTTP" ] - }, - "localNetworkInterface" : { - "type" : "string", - "description" : "The local network interface to send/receive data. If not specified, any local address is used. If clustered, all nodes must have an interface with this identifier." - }, - "proxyHost" : { - "type" : "string" - }, - "proxyPort" : { - "type" : "integer", - "format" : "int32" - }, - "proxyUser" : { - "type" : "string" - }, - "inputPorts" : { - "type" : "array", - "description" : "A Set of Input Ports that can be connected to, in order to send data to the remote NiFi instance", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedRemoteGroupPort" - } - }, - "outputPorts" : { - "type" : "array", - "description" : "A Set of Output Ports that can be connected to, in order to pull data from the remote NiFi instance", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedRemoteGroupPort" - } - }, - "componentType" : { - "type" : "string", - "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE" ] - }, - "groupIdentifier" : { - "type" : "string", - "description" : "The ID of the Process Group that this component belongs to" - } - } - } - } -} \ No newline at end of file diff --git a/resources/client_gen/api_defs/nifi-1.11.1.json b/resources/client_gen/api_defs/nifi-1.11.1.json deleted file mode 100644 index 54b56182..00000000 --- a/resources/client_gen/api_defs/nifi-1.11.1.json +++ /dev/null @@ -1,20689 +0,0 @@ -{ - "swagger" : "2.0", - "info" : { - "description" : "The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and \n stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description,\n definitions of the expected input and output, potential response codes, and the authorizations required\n to invoke each service.", - "version" : "1.11.1-SNAPSHOT", - "title" : "NiFi Rest Api", - "contact" : { - "url" : "https://nifi.apache.org", - "email" : "dev@nifi.apache.org" - }, - "license" : { - "name" : "Apache 2.0", - "url" : "http://www.apache.org/licenses/LICENSE-2.0.html" - } - }, - "basePath" : "/nifi-api", - "tags" : [ { - "name" : "access", - "description" : "Endpoints for obtaining an access token or checking access status." - }, { - "name" : "connections", - "description" : "Endpoint for managing a Connection." - }, { - "name" : "controller", - "description" : "Provides realtime command and control of this NiFi instance" - }, { - "name" : "controller-services", - "description" : "Endpoint for managing a Controller Service." - }, { - "name" : "counters", - "description" : "Endpoint for managing counters." - }, { - "name" : "data-transfer", - "description" : "Supports data transfers with this NiFi using HTTP based site to site" - }, { - "name" : "flow", - "description" : "Endpoint for accessing the flow structure and component status." - }, { - "name" : "flowfile-queues", - "description" : "Endpoint for managing a FlowFile Queue." - }, { - "name" : "funnel", - "description" : "Endpoint for managing a Funnel." - }, { - "name" : "input-ports", - "description" : "Endpoint for managing an Input Port." - }, { - "name" : "labels", - "description" : "Endpoint for managing a Label." - }, { - "name" : "output-ports", - "description" : "Endpoint for managing an Output Port." - }, { - "name" : "parameter-contexts", - "description" : "Endpoint for managing version control for a flow" - }, { - "name" : "policies", - "description" : "Endpoint for managing access policies." - }, { - "name" : "process-groups", - "description" : "Endpoint for managing a Process Group." - }, { - "name" : "processors", - "description" : "Endpoint for managing a Processor." - }, { - "name" : "provenance", - "description" : "Endpoint for accessing data flow provenance." - }, { - "name" : "provenance-events", - "description" : "Endpoint for accessing data flow provenance." - }, { - "name" : "remote-process-groups", - "description" : "Endpoint for managing a Remote Process Group." - }, { - "name" : "reporting-tasks", - "description" : "Endpoint for managing a Reporting Task." - }, { - "name" : "resources", - "description" : "Provides the resources in this NiFi that can have access/authorization policies." - }, { - "name" : "site-to-site", - "description" : "Provide access to site to site with this NiFi" - }, { - "name" : "snippets", - "description" : "Endpoint for accessing dataflow snippets." - }, { - "name" : "system-diagnostics", - "description" : "Endpoint for accessing system diagnostics." - }, { - "name" : "templates", - "description" : "Endpoint for managing a Template." - }, { - "name" : "tenants", - "description" : "Endpoint for managing users and user groups." - }, { - "name" : "versions", - "description" : "Endpoint for managing version control for a flow" - } ], - "schemes" : [ "http", "https" ], - "paths" : { - "/access" : { - "get" : { - "tags" : [ "access" ], - "summary" : "Gets the status the client's access", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getAccessStatus", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/AccessStatusEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Unable to determine access status because the client could not be authenticated." - }, - "403" : { - "description" : "Unable to determine access status because the client is not authorized to make this request." - }, - "409" : { - "description" : "Unable to determine access status because NiFi is not in the appropriate state." - }, - "500" : { - "description" : "Unable to determine access status because an unexpected error occurred." - } - } - } - }, - "/access/config" : { - "get" : { - "tags" : [ "access" ], - "summary" : "Retrieves the access configuration for this NiFi", - "description" : "", - "operationId" : "getLoginConfig", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/AccessConfigurationEntity" - } - } - } - } - }, - "/access/download-token" : { - "post" : { - "tags" : [ "access" ], - "summary" : "Creates a single use access token for downloading FlowFile content.", - "description" : "The token returned is a base64 encoded string. It is valid for a single request up to five minutes from being issued. It is used as a query parameter name 'access_token'.", - "operationId" : "createDownloadToken", - "consumes" : [ "application/x-www-form-urlencoded" ], - "produces" : [ "text/plain" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "Unable to create the download token because NiFi is not in the appropriate state. (i.e. may not have any tokens to grant or be configured to support username/password login)" - }, - "500" : { - "description" : "Unable to create download token because an unexpected error occurred." - } - } - } - }, - "/access/kerberos" : { - "post" : { - "tags" : [ "access" ], - "summary" : "Creates a token for accessing the REST API via Kerberos ticket exchange / SPNEGO negotiation", - "description" : "The token returned is formatted as a JSON Web Token (JWT). The token is base64 encoded and comprised of three parts. The header, the body, and the signature. The expiration of the token is a contained within the body. The token can be used in the Authorization header in the format 'Authorization: Bearer '.", - "operationId" : "createAccessTokenFromTicket", - "consumes" : [ "text/plain" ], - "produces" : [ "text/plain" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "NiFi was unable to complete the request because it did not contain a valid Kerberos ticket in the Authorization header. Retry this request after initializing a ticket with kinit and ensuring your browser is configured to support SPNEGO." - }, - "409" : { - "description" : "Unable to create access token because NiFi is not in the appropriate state. (i.e. may not be configured to support Kerberos login." - }, - "500" : { - "description" : "Unable to create access token because an unexpected error occurred." - } - } - } - }, - "/access/knox/callback" : { - "get" : { - "tags" : [ "access" ], - "summary" : "Redirect/callback URI for processing the result of the Apache Knox login sequence.", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "knoxCallback", - "consumes" : [ "*/*" ], - "produces" : [ "*/*" ], - "responses" : { - "default" : { - "description" : "successful operation" - } - } - } - }, - "/access/knox/logout" : { - "get" : { - "tags" : [ "access" ], - "summary" : "Performs a logout in the Apache Knox.", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "knoxLogout", - "consumes" : [ "*/*" ], - "produces" : [ "*/*" ], - "responses" : { - "default" : { - "description" : "successful operation" - } - } - } - }, - "/access/knox/request" : { - "get" : { - "tags" : [ "access" ], - "summary" : "Initiates a request to authenticate through Apache Knox.", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "knoxRequest", - "consumes" : [ "*/*" ], - "produces" : [ "*/*" ], - "responses" : { - "default" : { - "description" : "successful operation" - } - } - } - }, - "/access/logout" : { - "delete" : { - "tags" : [ "access" ], - "summary" : "Performs a logout for other providers that have been issued a JWT.", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "logOut", - "consumes" : [ "*/*" ], - "produces" : [ "*/*" ], - "responses" : { - "200" : { - "description" : "User was logged out successfully." - }, - "401" : { - "description" : "Authentication token provided was empty or not in the correct JWT format." - }, - "500" : { - "description" : "Client failed to log out." - } - } - } - }, - "/access/oidc/callback" : { - "get" : { - "tags" : [ "access" ], - "summary" : "Redirect/callback URI for processing the result of the OpenId Connect login sequence.", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "oidcCallback", - "consumes" : [ "*/*" ], - "produces" : [ "*/*" ], - "responses" : { - "default" : { - "description" : "successful operation" - } - } - } - }, - "/access/oidc/exchange" : { - "post" : { - "tags" : [ "access" ], - "summary" : "Retrieves a JWT following a successful login sequence using the configured OpenId Connect provider.", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "oidcExchange", - "consumes" : [ "*/*" ], - "produces" : [ "text/plain" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - } - } - } - }, - "/access/oidc/logout" : { - "get" : { - "tags" : [ "access" ], - "summary" : "Performs a logout in the OpenId Provider.", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "oidcLogout", - "consumes" : [ "*/*" ], - "produces" : [ "*/*" ], - "responses" : { - "default" : { - "description" : "successful operation" - } - } - } - }, - "/access/oidc/request" : { - "get" : { - "tags" : [ "access" ], - "summary" : "Initiates a request to authenticate through the configured OpenId Connect provider.", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "oidcRequest", - "consumes" : [ "*/*" ], - "produces" : [ "*/*" ], - "responses" : { - "default" : { - "description" : "successful operation" - } - } - } - }, - "/access/token" : { - "post" : { - "tags" : [ "access" ], - "summary" : "Creates a token for accessing the REST API via username/password", - "description" : "The token returned is formatted as a JSON Web Token (JWT). The token is base64 encoded and comprised of three parts. The header, the body, and the signature. The expiration of the token is a contained within the body. The token can be used in the Authorization header in the format 'Authorization: Bearer '.", - "operationId" : "createAccessToken", - "consumes" : [ "application/x-www-form-urlencoded" ], - "produces" : [ "text/plain" ], - "parameters" : [ { - "name" : "username", - "in" : "formData", - "required" : false, - "type" : "string" - }, { - "name" : "password", - "in" : "formData", - "required" : false, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "Unable to create access token because NiFi is not in the appropriate state. (i.e. may not be configured to support username/password login." - }, - "500" : { - "description" : "Unable to create access token because an unexpected error occurred." - } - } - } - }, - "/access/ui-extension-token" : { - "post" : { - "tags" : [ "access" ], - "summary" : "Creates a single use access token for accessing a NiFi UI extension.", - "description" : "The token returned is a base64 encoded string. It is valid for a single request up to five minutes from being issued. It is used as a query parameter name 'access_token'.", - "operationId" : "createUiExtensionToken", - "consumes" : [ "application/x-www-form-urlencoded" ], - "produces" : [ "text/plain" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "Unable to create the download token because NiFi is not in the appropriate state. (i.e. may not have any tokens to grant or be configured to support username/password login)" - }, - "500" : { - "description" : "Unable to create download token because an unexpected error occurred." - } - } - } - }, - "/connections/{id}" : { - "get" : { - "tags" : [ "connections" ], - "summary" : "Gets a connection", - "description" : "", - "operationId" : "getConnection", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The connection id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ConnectionEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read Source - /{component-type}/{uuid}" : [ ] - }, { - "Read Destination - /{component-type}/{uuid}" : [ ] - } ] - }, - "put" : { - "tags" : [ "connections" ], - "summary" : "Updates a connection", - "description" : "", - "operationId" : "updateConnection", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The connection id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The connection configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ConnectionEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ConnectionEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write Source - /{component-type}/{uuid}" : [ ] - }, { - "Write Destination - /{component-type}/{uuid}" : [ ] - }, { - "Write New Destination - /{component-type}/{uuid} - if updating Destination" : [ ] - }, { - "Write Process Group - /process-groups/{uuid} - if updating Destination" : [ ] - } ] - }, - "delete" : { - "tags" : [ "connections" ], - "summary" : "Deletes a connection", - "description" : "", - "operationId" : "deleteConnection", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The revision is used to verify the client is working with the latest version of the flow.", - "required" : false, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The connection id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ConnectionEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write Source - /{component-type}/{uuid}" : [ ] - }, { - "Write - Parent Process Group - /process-groups/{uuid}" : [ ] - }, { - "Write Destination - /{component-type}/{uuid}" : [ ] - } ] - } - }, - "/controller-services/{id}" : { - "get" : { - "tags" : [ "controller-services" ], - "summary" : "Gets a controller service", - "description" : "", - "operationId" : "getControllerService", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The controller service id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ControllerServiceEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /controller-services/{uuid}" : [ ] - } ] - }, - "put" : { - "tags" : [ "controller-services" ], - "summary" : "Updates a controller service", - "description" : "", - "operationId" : "updateControllerService", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The controller service id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The controller service configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ControllerServiceEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ControllerServiceEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /controller-services/{uuid}" : [ ] - }, { - "Read - any referenced Controller Services if this request changes the reference - /controller-services/{uuid}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "controller-services" ], - "summary" : "Deletes a controller service", - "description" : "", - "operationId" : "removeControllerService", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The revision is used to verify the client is working with the latest version of the flow.", - "required" : false, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The controller service id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ControllerServiceEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /controller-services/{uuid}" : [ ] - }, { - "Write - Parent Process Group if scoped by Process Group - /process-groups/{uuid}" : [ ] - }, { - "Write - Controller if scoped by Controller - /controller" : [ ] - }, { - "Read - any referenced Controller Services - /controller-services/{uuid}" : [ ] - } ] - } - }, - "/controller-services/{id}/descriptors" : { - "get" : { - "tags" : [ "controller-services" ], - "summary" : "Gets a controller service property descriptor", - "description" : "", - "operationId" : "getPropertyDescriptor", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The controller service id.", - "required" : true, - "type" : "string" - }, { - "name" : "propertyName", - "in" : "query", - "description" : "The property name to return the descriptor for.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/PropertyDescriptorEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /controller-services/{uuid}" : [ ] - } ] - } - }, - "/controller-services/{id}/references" : { - "get" : { - "tags" : [ "controller-services" ], - "summary" : "Gets a controller service", - "description" : "", - "operationId" : "getControllerServiceReferences", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The controller service id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ControllerServiceReferencingComponentsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /controller-services/{uuid}" : [ ] - } ] - }, - "put" : { - "tags" : [ "controller-services" ], - "summary" : "Updates a controller services references", - "description" : "", - "operationId" : "updateControllerServiceReferences", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The controller service id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The controller service request update request.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/UpdateControllerServiceReferenceRequestEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ControllerServiceReferencingComponentsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /{component-type}/{uuid} or /operate/{component-type}/{uuid} - For each referencing component specified" : [ ] - } ] - } - }, - "/controller-services/{id}/run-status" : { - "put" : { - "tags" : [ "controller-services" ], - "summary" : "Updates run status of a controller service", - "description" : "", - "operationId" : "updateRunStatus", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The controller service id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The controller service run status.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ControllerServiceRunStatusEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ControllerServiceEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /controller-services/{uuid} or /operation/controller-services/{uuid}" : [ ] - } ] - } - }, - "/controller-services/{id}/state" : { - "get" : { - "tags" : [ "controller-services" ], - "summary" : "Gets the state for a controller service", - "description" : "", - "operationId" : "getState", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The controller service id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ComponentStateEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /controller-services/{uuid}" : [ ] - } ] - } - }, - "/controller-services/{id}/state/clear-requests" : { - "post" : { - "tags" : [ "controller-services" ], - "summary" : "Clears the state for a controller service", - "description" : "", - "operationId" : "clearState", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The controller service id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ComponentStateEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /controller-services/{uuid}" : [ ] - } ] - } - }, - "/controller/bulletin" : { - "post" : { - "tags" : [ "controller" ], - "summary" : "Creates a new bulletin", - "description" : "", - "operationId" : "createBulletin", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The reporting task configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/BulletinEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /controller" : [ ] - } ] - } - }, - "/controller/cluster" : { - "get" : { - "tags" : [ "controller" ], - "summary" : "Gets the contents of the cluster", - "description" : "Returns the contents of the cluster including all nodes and their status.", - "operationId" : "getCluster", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ClusterEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /controller" : [ ] - } ] - } - }, - "/controller/cluster/nodes/{id}" : { - "get" : { - "tags" : [ "controller" ], - "summary" : "Gets a node in the cluster", - "description" : "", - "operationId" : "getNode", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The node id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/NodeEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /controller" : [ ] - } ] - }, - "put" : { - "tags" : [ "controller" ], - "summary" : "Updates a node in the cluster", - "description" : "", - "operationId" : "updateNode", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The node id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The node configuration. The only configuration that will be honored at this endpoint is the status.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/NodeEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/NodeEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /controller" : [ ] - } ] - }, - "delete" : { - "tags" : [ "controller" ], - "summary" : "Removes a node from the cluster", - "description" : "", - "operationId" : "deleteNode", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The node id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/NodeEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /controller" : [ ] - } ] - } - }, - "/controller/config" : { - "get" : { - "tags" : [ "controller" ], - "summary" : "Retrieves the configuration for this NiFi Controller", - "description" : "", - "operationId" : "getControllerConfig", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ControllerConfigurationEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /controller" : [ ] - } ] - }, - "put" : { - "tags" : [ "controller" ], - "summary" : "Retrieves the configuration for this NiFi", - "description" : "", - "operationId" : "updateControllerConfig", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The controller configuration.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ControllerConfigurationEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ControllerConfigurationEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /controller" : [ ] - } ] - } - }, - "/controller/controller-services" : { - "post" : { - "tags" : [ "controller" ], - "summary" : "Creates a new controller service", - "description" : "", - "operationId" : "createControllerService", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The controller service configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ControllerServiceEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ControllerServiceEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /controller" : [ ] - }, { - "Read - any referenced Controller Services - /controller-services/{uuid}" : [ ] - }, { - "Write - if the Controller Service is restricted - /restricted-components" : [ ] - } ] - } - }, - "/controller/history" : { - "delete" : { - "tags" : [ "controller" ], - "summary" : "Purges history", - "description" : "", - "operationId" : "deleteHistory", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "endDate", - "in" : "query", - "description" : "Purge actions before this date/time.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/HistoryEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /controller" : [ ] - } ] - } - }, - "/controller/registry-clients" : { - "get" : { - "tags" : [ "controller" ], - "summary" : "Gets the listing of available registry clients", - "description" : "", - "operationId" : "getRegistryClients", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/RegistryClientsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - }, - "post" : { - "tags" : [ "controller" ], - "summary" : "Creates a new registry client", - "description" : "", - "operationId" : "createRegistryClient", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The registry configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/RegistryClientEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/RegistryClientEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /controller" : [ ] - } ] - } - }, - "/controller/registry-clients/{id}" : { - "get" : { - "tags" : [ "controller" ], - "summary" : "Gets a registry client", - "description" : "", - "operationId" : "getRegistryClient", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The registry id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/RegistryClientEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /controller" : [ ] - } ] - }, - "put" : { - "tags" : [ "controller" ], - "summary" : "Updates a registry client", - "description" : "", - "operationId" : "updateRegistryClient", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The registry id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The registry configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/RegistryClientEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/RegistryClientEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /controller" : [ ] - } ] - }, - "delete" : { - "tags" : [ "controller" ], - "summary" : "Deletes a registry client", - "description" : "", - "operationId" : "deleteRegistryClient", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The revision is used to verify the client is working with the latest version of the flow.", - "required" : false, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The registry id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/RegistryClientEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /controller" : [ ] - } ] - } - }, - "/controller/reporting-tasks" : { - "post" : { - "tags" : [ "controller" ], - "summary" : "Creates a new reporting task", - "description" : "", - "operationId" : "createReportingTask", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The reporting task configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ReportingTaskEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ReportingTaskEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /controller" : [ ] - }, { - "Read - any referenced Controller Services - /controller-services/{uuid}" : [ ] - }, { - "Write - if the Reporting Task is restricted - /restricted-components" : [ ] - } ] - } - }, - "/counters" : { - "get" : { - "tags" : [ "counters" ], - "summary" : "Gets the current counters for this NiFi", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getCounters", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "nodewise", - "in" : "query", - "description" : "Whether or not to include the breakdown per node. Optional, defaults to false", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "clusterNodeId", - "in" : "query", - "description" : "The id of the node where to get the status.", - "required" : false, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/CountersEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /counters" : [ ] - } ] - } - }, - "/counters/{id}" : { - "put" : { - "tags" : [ "counters" ], - "summary" : "Updates the specified counter. This will reset the counter value to 0", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "updateCounter", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The id of the counter.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/CounterEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /counters" : [ ] - } ] - } - }, - "/data-transfer/input-ports/{portId}/transactions/{transactionId}" : { - "put" : { - "tags" : [ "data-transfer" ], - "summary" : "Extend transaction TTL", - "description" : "", - "operationId" : "extendInputPortTransactionTTL", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "portId", - "in" : "path", - "required" : true, - "type" : "string" - }, { - "name" : "transactionId", - "in" : "path", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/TransactionResultEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /data-transfer/input-ports/{uuid}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "data-transfer" ], - "summary" : "Commit or cancel the specified transaction", - "description" : "", - "operationId" : "commitInputPortTransaction", - "consumes" : [ "application/octet-stream" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "responseCode", - "in" : "query", - "description" : "The response code. Available values are BAD_CHECKSUM(19), CONFIRM_TRANSACTION(12) or CANCEL_TRANSACTION(15).", - "required" : true, - "type" : "integer", - "format" : "int32" - }, { - "name" : "portId", - "in" : "path", - "description" : "The input port id.", - "required" : true, - "type" : "string" - }, { - "name" : "transactionId", - "in" : "path", - "description" : "The transaction id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/TransactionResultEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - }, - "503" : { - "description" : "NiFi instance is not ready for serving request, or temporarily overloaded. Retrying the same request later may be successful" - } - }, - "security" : [ { - "Write - /data-transfer/input-ports/{uuid}" : [ ] - } ] - } - }, - "/data-transfer/input-ports/{portId}/transactions/{transactionId}/flow-files" : { - "post" : { - "tags" : [ "data-transfer" ], - "summary" : "Transfer flow files to the input port", - "description" : "", - "operationId" : "receiveFlowFiles", - "consumes" : [ "application/octet-stream" ], - "produces" : [ "text/plain" ], - "parameters" : [ { - "name" : "portId", - "in" : "path", - "description" : "The input port id.", - "required" : true, - "type" : "string" - }, { - "name" : "transactionId", - "in" : "path", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - }, - "503" : { - "description" : "NiFi instance is not ready for serving request, or temporarily overloaded. Retrying the same request later may be successful" - } - }, - "security" : [ { - "Write - /data-transfer/input-ports/{uuid}" : [ ] - } ] - } - }, - "/data-transfer/output-ports/{portId}/transactions/{transactionId}" : { - "put" : { - "tags" : [ "data-transfer" ], - "summary" : "Extend transaction TTL", - "description" : "", - "operationId" : "extendOutputPortTransactionTTL", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "portId", - "in" : "path", - "required" : true, - "type" : "string" - }, { - "name" : "transactionId", - "in" : "path", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/TransactionResultEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - }, - "503" : { - "description" : "NiFi instance is not ready for serving request, or temporarily overloaded. Retrying the same request later may be successful" - } - }, - "security" : [ { - "Write - /data-transfer/output-ports/{uuid}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "data-transfer" ], - "summary" : "Commit or cancel the specified transaction", - "description" : "", - "operationId" : "commitOutputPortTransaction", - "consumes" : [ "application/octet-stream" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "responseCode", - "in" : "query", - "description" : "The response code. Available values are CONFIRM_TRANSACTION(12) or CANCEL_TRANSACTION(15).", - "required" : true, - "type" : "integer", - "format" : "int32" - }, { - "name" : "checksum", - "in" : "query", - "description" : "A checksum calculated at client side using CRC32 to check flow file content integrity. It must match with the value calculated at server side.", - "required" : true, - "type" : "string" - }, { - "name" : "portId", - "in" : "path", - "description" : "The output port id.", - "required" : true, - "type" : "string" - }, { - "name" : "transactionId", - "in" : "path", - "description" : "The transaction id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/TransactionResultEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - }, - "503" : { - "description" : "NiFi instance is not ready for serving request, or temporarily overloaded. Retrying the same request later may be successful" - } - }, - "security" : [ { - "Write - /data-transfer/output-ports/{uuid}" : [ ] - } ] - } - }, - "/data-transfer/output-ports/{portId}/transactions/{transactionId}/flow-files" : { - "get" : { - "tags" : [ "data-transfer" ], - "summary" : "Transfer flow files from the output port", - "description" : "", - "operationId" : "transferFlowFiles", - "consumes" : [ "*/*" ], - "produces" : [ "application/octet-stream" ], - "parameters" : [ { - "name" : "portId", - "in" : "path", - "description" : "The output port id.", - "required" : true, - "type" : "string" - }, { - "name" : "transactionId", - "in" : "path", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "There is no flow file to return.", - "schema" : { - "$ref" : "#/definitions/StreamingOutput" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - }, - "503" : { - "description" : "NiFi instance is not ready for serving request, or temporarily overloaded. Retrying the same request later may be successful" - } - }, - "security" : [ { - "Write - /data-transfer/output-ports/{uuid}" : [ ] - } ] - } - }, - "/data-transfer/{portType}/{portId}/transactions" : { - "post" : { - "tags" : [ "data-transfer" ], - "summary" : "Create a transaction to the specified output port or input port", - "description" : "", - "operationId" : "createPortTransaction", - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "portType", - "in" : "path", - "description" : "The port type.", - "required" : true, - "type" : "string", - "enum" : [ "input-ports", "output-ports" ] - }, { - "name" : "portId", - "in" : "path", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/TransactionResultEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - }, - "503" : { - "description" : "NiFi instance is not ready for serving request, or temporarily overloaded. Retrying the same request later may be successful" - } - }, - "security" : [ { - "Write - /data-transfer/{component-type}/{uuid}" : [ ] - } ] - } - }, - "/flow/about" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Retrieves details about this NiFi to put in the About dialog", - "description" : "", - "operationId" : "getAboutInfo", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/AboutEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/banners" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Retrieves the banners for this NiFi", - "description" : "", - "operationId" : "getBanners", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/BannerEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/bulletin-board" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets current bulletins", - "description" : "", - "operationId" : "getBulletinBoard", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "after", - "in" : "query", - "description" : "Includes bulletins with an id after this value.", - "required" : false, - "type" : "string" - }, { - "name" : "sourceName", - "in" : "query", - "description" : "Includes bulletins originating from this sources whose name match this regular expression.", - "required" : false, - "type" : "string" - }, { - "name" : "message", - "in" : "query", - "description" : "Includes bulletins whose message that match this regular expression.", - "required" : false, - "type" : "string" - }, { - "name" : "sourceId", - "in" : "query", - "description" : "Includes bulletins originating from this sources whose id match this regular expression.", - "required" : false, - "type" : "string" - }, { - "name" : "groupId", - "in" : "query", - "description" : "Includes bulletins originating from this sources whose group id match this regular expression.", - "required" : false, - "type" : "string" - }, { - "name" : "limit", - "in" : "query", - "description" : "The number of bulletins to limit the response to.", - "required" : false, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/BulletinBoardEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - }, { - "Read - /{component-type}/{uuid} - For component specific bulletins" : [ ] - } ] - } - }, - "/flow/client-id" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Generates a client id.", - "description" : "", - "operationId" : "generateClientId", - "consumes" : [ "*/*" ], - "produces" : [ "text/plain" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/cluster/search-results" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Searches the cluster for a node with the specified address", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "searchCluster", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "q", - "in" : "query", - "description" : "Node address to search for.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ClusterSearchResultsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/cluster/summary" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "The cluster summary for this NiFi", - "description" : "", - "operationId" : "getClusterSummary", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ClusteSummaryEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/config" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Retrieves the configuration for this NiFi flow", - "description" : "", - "operationId" : "getFlowConfig", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/FlowConfigurationEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/connections/{id}/statistics" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets statistics for a connection", - "description" : "", - "operationId" : "getConnectionStatistics", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "nodewise", - "in" : "query", - "description" : "Whether or not to include the breakdown per node. Optional, defaults to false", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "clusterNodeId", - "in" : "query", - "description" : "The id of the node where to get the statistics.", - "required" : false, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The connection id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ConnectionStatisticsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/connections/{id}/status" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets status for a connection", - "description" : "", - "operationId" : "getConnectionStatus", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "nodewise", - "in" : "query", - "description" : "Whether or not to include the breakdown per node. Optional, defaults to false", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "clusterNodeId", - "in" : "query", - "description" : "The id of the node where to get the status.", - "required" : false, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The connection id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ConnectionStatusEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/connections/{id}/status/history" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets the status history for a connection", - "description" : "", - "operationId" : "getConnectionStatusHistory", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The connection id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/StatusHistoryEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/controller-service-types" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Retrieves the types of controller services that this NiFi supports", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getControllerServiceTypes", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "serviceType", - "in" : "query", - "description" : "If specified, will only return controller services that are compatible with this type of service.", - "required" : false, - "type" : "string" - }, { - "name" : "serviceBundleGroup", - "in" : "query", - "description" : "If serviceType specified, is the bundle group of the serviceType.", - "required" : false, - "type" : "string" - }, { - "name" : "serviceBundleArtifact", - "in" : "query", - "description" : "If serviceType specified, is the bundle artifact of the serviceType.", - "required" : false, - "type" : "string" - }, { - "name" : "serviceBundleVersion", - "in" : "query", - "description" : "If serviceType specified, is the bundle version of the serviceType.", - "required" : false, - "type" : "string" - }, { - "name" : "bundleGroupFilter", - "in" : "query", - "description" : "If specified, will only return types that are a member of this bundle group.", - "required" : false, - "type" : "string" - }, { - "name" : "bundleArtifactFilter", - "in" : "query", - "description" : "If specified, will only return types that are a member of this bundle artifact.", - "required" : false, - "type" : "string" - }, { - "name" : "typeFilter", - "in" : "query", - "description" : "If specified, will only return types whose fully qualified classname matches.", - "required" : false, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ControllerServiceTypesEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/controller/bulletins" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Retrieves Controller level bulletins", - "description" : "", - "operationId" : "getBulletins", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ControllerBulletinsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - }, { - "Read - /controller - For controller bulletins" : [ ] - }, { - "Read - /controller-services/{uuid} - For controller service bulletins" : [ ] - }, { - "Read - /reporting-tasks/{uuid} - For reporting task bulletins" : [ ] - } ] - } - }, - "/flow/controller/controller-services" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets controller services for reporting tasks", - "description" : "", - "operationId" : "getControllerServicesFromController", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ControllerServicesEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/current-user" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Retrieves the user identity of the user making the request", - "description" : "", - "operationId" : "getCurrentUser", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/CurrentUserEntity" - } - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/history" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets configuration history", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "queryHistory", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "offset", - "in" : "query", - "description" : "The offset into the result set.", - "required" : true, - "type" : "string" - }, { - "name" : "count", - "in" : "query", - "description" : "The number of actions to return.", - "required" : true, - "type" : "string" - }, { - "name" : "sortColumn", - "in" : "query", - "description" : "The field to sort on.", - "required" : false, - "type" : "string" - }, { - "name" : "sortOrder", - "in" : "query", - "description" : "The direction to sort.", - "required" : false, - "type" : "string" - }, { - "name" : "startDate", - "in" : "query", - "description" : "Include actions after this date.", - "required" : false, - "type" : "string" - }, { - "name" : "endDate", - "in" : "query", - "description" : "Include actions before this date.", - "required" : false, - "type" : "string" - }, { - "name" : "userIdentity", - "in" : "query", - "description" : "Include actions performed by this user.", - "required" : false, - "type" : "string" - }, { - "name" : "sourceId", - "in" : "query", - "description" : "Include actions on this component.", - "required" : false, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/HistoryEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/history/components/{componentId}" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets configuration history for a component", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getComponentHistory", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "componentId", - "in" : "path", - "description" : "The component id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ComponentHistoryEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - }, { - "Read underlying component - /{component-type}/{uuid}" : [ ] - } ] - } - }, - "/flow/history/{id}" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets an action", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getAction", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The action id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ActionEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/input-ports/{id}/status" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets status for an input port", - "description" : "", - "operationId" : "getInputPortStatus", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "nodewise", - "in" : "query", - "description" : "Whether or not to include the breakdown per node. Optional, defaults to false", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "clusterNodeId", - "in" : "query", - "description" : "The id of the node where to get the status.", - "required" : false, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The input port id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/PortStatusEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/output-ports/{id}/status" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets status for an output port", - "description" : "", - "operationId" : "getOutputPortStatus", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "nodewise", - "in" : "query", - "description" : "Whether or not to include the breakdown per node. Optional, defaults to false", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "clusterNodeId", - "in" : "query", - "description" : "The id of the node where to get the status.", - "required" : false, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The output port id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/PortStatusEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/parameter-contexts" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets all Parameter Contexts", - "description" : "", - "operationId" : "getParameterContexts", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ParameterContextsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /parameter-contexts/{id} for each Parameter Context" : [ ] - } ] - } - }, - "/flow/prioritizers" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Retrieves the types of prioritizers that this NiFi supports", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getPrioritizers", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/PrioritizerTypesEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/process-groups/{id}" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets a process group", - "description" : "", - "operationId" : "getFlow", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessGroupFlowEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - }, - "put" : { - "tags" : [ "flow" ], - "summary" : "Schedule or unschedule components in the specified Process Group.", - "description" : "", - "operationId" : "scheduleComponents", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The request to schedule or unschedule. If the comopnents in the request are not specified, all authorized components will be considered.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ScheduleComponentsEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ScheduleComponentsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - }, { - "Write - /{component-type}/{uuid} or /operation/{component-type}/{uuid} - For every component being scheduled/unscheduled" : [ ] - } ] - } - }, - "/flow/process-groups/{id}/controller-services" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets all controller services", - "description" : "", - "operationId" : "getControllerServicesFromGroup", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "name" : "includeAncestorGroups", - "in" : "query", - "description" : "Whether or not to include parent/ancestory process groups", - "required" : false, - "type" : "boolean", - "default" : true - }, { - "name" : "includeDescendantGroups", - "in" : "query", - "description" : "Whether or not to include descendant process groups", - "required" : false, - "type" : "boolean", - "default" : false - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ControllerServicesEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - }, - "put" : { - "tags" : [ "flow" ], - "summary" : "Enable or disable Controller Services in the specified Process Group.", - "description" : "", - "operationId" : "activateControllerServices", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The request to schedule or unschedule. If the comopnents in the request are not specified, all authorized components will be considered.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ActivateControllerServicesEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ActivateControllerServicesEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - }, { - "Write - /{component-type}/{uuid} or /operation/{component-type}/{uuid} - For every service being enabled/disabled" : [ ] - } ] - } - }, - "/flow/process-groups/{id}/status" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets the status for a process group", - "description" : "The status for a process group includes status for all descendent components. When invoked on the root group with recursive set to true, it will return the current status of every component in the flow.", - "operationId" : "getProcessGroupStatus", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "recursive", - "in" : "query", - "description" : "Whether all descendant groups and the status of their content will be included. Optional, defaults to false", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "nodewise", - "in" : "query", - "description" : "Whether or not to include the breakdown per node. Optional, defaults to false", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "clusterNodeId", - "in" : "query", - "description" : "The id of the node where to get the status.", - "required" : false, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessGroupStatusEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/process-groups/{id}/status/history" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets status history for a remote process group", - "description" : "", - "operationId" : "getProcessGroupStatusHistory", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/StatusHistoryEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/processor-types" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Retrieves the types of processors that this NiFi supports", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getProcessorTypes", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bundleGroupFilter", - "in" : "query", - "description" : "If specified, will only return types that are a member of this bundle group.", - "required" : false, - "type" : "string" - }, { - "name" : "bundleArtifactFilter", - "in" : "query", - "description" : "If specified, will only return types that are a member of this bundle artifact.", - "required" : false, - "type" : "string" - }, { - "name" : "type", - "in" : "query", - "description" : "If specified, will only return types whose fully qualified classname matches.", - "required" : false, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessorTypesEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/processors/{id}/status" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets status for a processor", - "description" : "", - "operationId" : "getProcessorStatus", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "nodewise", - "in" : "query", - "description" : "Whether or not to include the breakdown per node. Optional, defaults to false", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "clusterNodeId", - "in" : "query", - "description" : "The id of the node where to get the status.", - "required" : false, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The processor id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessorStatusEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/processors/{id}/status/history" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets status history for a processor", - "description" : "", - "operationId" : "getProcessorStatusHistory", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The processor id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/StatusHistoryEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/registries" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets the listing of available registries", - "description" : "", - "operationId" : "getRegistries", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/RegistryClientsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/registries/{id}/buckets" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets the buckets from the specified registry for the current user", - "description" : "", - "operationId" : "getBuckets", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The registry id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/BucketsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/registries/{registry-id}/buckets/{bucket-id}/flows" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets the flows from the specified registry and bucket for the current user", - "description" : "", - "operationId" : "getFlows", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "registry-id", - "in" : "path", - "description" : "The registry id.", - "required" : true, - "type" : "string" - }, { - "name" : "bucket-id", - "in" : "path", - "description" : "The bucket id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlowsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/registries/{registry-id}/buckets/{bucket-id}/flows/{flow-id}/versions" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets the flow versions from the specified registry and bucket for the specified flow for the current user", - "description" : "", - "operationId" : "getVersions", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "registry-id", - "in" : "path", - "description" : "The registry id.", - "required" : true, - "type" : "string" - }, { - "name" : "bucket-id", - "in" : "path", - "description" : "The bucket id.", - "required" : true, - "type" : "string" - }, { - "name" : "flow-id", - "in" : "path", - "description" : "The flow id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlowSnapshotMetadataSetEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/remote-process-groups/{id}/status" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets status for a remote process group", - "description" : "", - "operationId" : "getRemoteProcessGroupStatus", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "nodewise", - "in" : "query", - "description" : "Whether or not to include the breakdown per node. Optional, defaults to false", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "clusterNodeId", - "in" : "query", - "description" : "The id of the node where to get the status.", - "required" : false, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The remote process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/RemoteProcessGroupStatusEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/remote-process-groups/{id}/status/history" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets the status history", - "description" : "", - "operationId" : "getRemoteProcessGroupStatusHistory", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The remote process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/StatusHistoryEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/reporting-task-types" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Retrieves the types of reporting tasks that this NiFi supports", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getReportingTaskTypes", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bundleGroupFilter", - "in" : "query", - "description" : "If specified, will only return types that are a member of this bundle group.", - "required" : false, - "type" : "string" - }, { - "name" : "bundleArtifactFilter", - "in" : "query", - "description" : "If specified, will only return types that are a member of this bundle artifact.", - "required" : false, - "type" : "string" - }, { - "name" : "type", - "in" : "query", - "description" : "If specified, will only return types whose fully qualified classname matches.", - "required" : false, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ReportingTaskTypesEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/reporting-tasks" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets all reporting tasks", - "description" : "", - "operationId" : "getReportingTasks", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ReportingTasksEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/search-results" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Performs a search against this NiFi using the specified search term", - "description" : "Only search results from authorized components will be returned.", - "operationId" : "searchFlow", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "q", - "in" : "query", - "required" : false, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/SearchResultsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/status" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets the current status of this NiFi", - "description" : "", - "operationId" : "getControllerStatus", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ControllerStatusEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/templates" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets all templates", - "description" : "", - "operationId" : "getTemplates", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/TemplatesEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flowfile-queues/{id}/drop-requests" : { - "post" : { - "tags" : [ "flowfile-queues" ], - "summary" : "Creates a request to drop the contents of the queue in this connection.", - "description" : "", - "operationId" : "createDropRequest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The connection id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/DropRequestEntity" - } - }, - "202" : { - "description" : "The request has been accepted. A HTTP response header will contain the URI where the response can be polled." - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write Source Data - /data/{component-type}/{uuid}" : [ ] - } ] - } - }, - "/flowfile-queues/{id}/drop-requests/{drop-request-id}" : { - "get" : { - "tags" : [ "flowfile-queues" ], - "summary" : "Gets the current status of a drop request for the specified connection.", - "description" : "", - "operationId" : "getDropRequest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The connection id.", - "required" : true, - "type" : "string" - }, { - "name" : "drop-request-id", - "in" : "path", - "description" : "The drop request id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/DropRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write Source Data - /data/{component-type}/{uuid}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "flowfile-queues" ], - "summary" : "Cancels and/or removes a request to drop the contents of this connection.", - "description" : "", - "operationId" : "removeDropRequest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The connection id.", - "required" : true, - "type" : "string" - }, { - "name" : "drop-request-id", - "in" : "path", - "description" : "The drop request id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/DropRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write Source Data - /data/{component-type}/{uuid}" : [ ] - } ] - } - }, - "/flowfile-queues/{id}/flowfiles/{flowfile-uuid}" : { - "get" : { - "tags" : [ "flowfile-queues" ], - "summary" : "Gets a FlowFile from a Connection.", - "description" : "", - "operationId" : "getFlowFile", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The connection id.", - "required" : true, - "type" : "string" - }, { - "name" : "flowfile-uuid", - "in" : "path", - "description" : "The flowfile uuid.", - "required" : true, - "type" : "string" - }, { - "name" : "clusterNodeId", - "in" : "query", - "description" : "The id of the node where the content exists if clustered.", - "required" : false, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/FlowFileEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read Source Data - /data/{component-type}/{uuid}" : [ ] - } ] - } - }, - "/flowfile-queues/{id}/flowfiles/{flowfile-uuid}/content" : { - "get" : { - "tags" : [ "flowfile-queues" ], - "summary" : "Gets the content for a FlowFile in a Connection.", - "description" : "", - "operationId" : "downloadFlowFileContent", - "consumes" : [ "*/*" ], - "produces" : [ "*/*" ], - "parameters" : [ { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The connection id.", - "required" : true, - "type" : "string" - }, { - "name" : "flowfile-uuid", - "in" : "path", - "description" : "The flowfile uuid.", - "required" : true, - "type" : "string" - }, { - "name" : "clusterNodeId", - "in" : "query", - "description" : "The id of the node where the content exists if clustered.", - "required" : false, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/StreamingOutput" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read Source Data - /data/{component-type}/{uuid}" : [ ] - } ] - } - }, - "/flowfile-queues/{id}/listing-requests" : { - "post" : { - "tags" : [ "flowfile-queues" ], - "summary" : "Lists the contents of the queue in this connection.", - "description" : "", - "operationId" : "createFlowFileListing", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The connection id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ListingRequestEntity" - } - }, - "202" : { - "description" : "The request has been accepted. A HTTP response header will contain the URI where the response can be polled." - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read Source Data - /data/{component-type}/{uuid}" : [ ] - } ] - } - }, - "/flowfile-queues/{id}/listing-requests/{listing-request-id}" : { - "get" : { - "tags" : [ "flowfile-queues" ], - "summary" : "Gets the current status of a listing request for the specified connection.", - "description" : "", - "operationId" : "getListingRequest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The connection id.", - "required" : true, - "type" : "string" - }, { - "name" : "listing-request-id", - "in" : "path", - "description" : "The listing request id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ListingRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read Source Data - /data/{component-type}/{uuid}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "flowfile-queues" ], - "summary" : "Cancels and/or removes a request to list the contents of this connection.", - "description" : "", - "operationId" : "deleteListingRequest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The connection id.", - "required" : true, - "type" : "string" - }, { - "name" : "listing-request-id", - "in" : "path", - "description" : "The listing request id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ListingRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read Source Data - /data/{component-type}/{uuid}" : [ ] - } ] - } - }, - "/funnels/{id}" : { - "get" : { - "tags" : [ "funnel" ], - "summary" : "Gets a funnel", - "description" : "", - "operationId" : "getFunnel", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The funnel id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/FunnelEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /funnels/{uuid}" : [ ] - } ] - }, - "put" : { - "tags" : [ "funnel" ], - "summary" : "Updates a funnel", - "description" : "", - "operationId" : "updateFunnel", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The funnel id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The funnel configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/FunnelEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/FunnelEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /funnels/{uuid}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "funnel" ], - "summary" : "Deletes a funnel", - "description" : "", - "operationId" : "removeFunnel", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The revision is used to verify the client is working with the latest version of the flow.", - "required" : false, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The funnel id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/FunnelEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /funnels/{uuid}" : [ ] - }, { - "Write - Parent Process Group - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/input-ports/{id}" : { - "get" : { - "tags" : [ "input-ports" ], - "summary" : "Gets an input port", - "description" : "", - "operationId" : "getInputPort", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The input port id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/PortEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /input-ports/{uuid}" : [ ] - } ] - }, - "put" : { - "tags" : [ "input-ports" ], - "summary" : "Updates an input port", - "description" : "", - "operationId" : "updateInputPort", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The input port id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The input port configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/PortEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/PortEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /input-ports/{uuid}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "input-ports" ], - "summary" : "Deletes an input port", - "description" : "", - "operationId" : "removeInputPort", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The revision is used to verify the client is working with the latest version of the flow.", - "required" : false, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The input port id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/PortEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /input-ports/{uuid}" : [ ] - }, { - "Write - Parent Process Group - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/input-ports/{id}/run-status" : { - "put" : { - "tags" : [ "input-ports" ], - "summary" : "Updates run status of an input-port", - "description" : "", - "operationId" : "updateRunStatus", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The port id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The port run status.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/PortRunStatusEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessorEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /input-ports/{uuid} or /operation/input-ports/{uuid}" : [ ] - } ] - } - }, - "/labels/{id}" : { - "get" : { - "tags" : [ "labels" ], - "summary" : "Gets a label", - "description" : "", - "operationId" : "getLabel", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The label id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/LabelEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /labels/{uuid}" : [ ] - } ] - }, - "put" : { - "tags" : [ "labels" ], - "summary" : "Updates a label", - "description" : "", - "operationId" : "updateLabel", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The label id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The label configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/LabelEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/LabelEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /labels/{uuid}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "labels" ], - "summary" : "Deletes a label", - "description" : "", - "operationId" : "removeLabel", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The revision is used to verify the client is working with the latest version of the flow.", - "required" : false, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The label id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/LabelEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /labels/{uuid}" : [ ] - }, { - "Write - Parent Process Group - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/output-ports/{id}" : { - "get" : { - "tags" : [ "output-ports" ], - "summary" : "Gets an output port", - "description" : "", - "operationId" : "getOutputPort", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The output port id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/PortEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /output-ports/{uuid}" : [ ] - } ] - }, - "put" : { - "tags" : [ "output-ports" ], - "summary" : "Updates an output port", - "description" : "", - "operationId" : "updateOutputPort", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The output port id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The output port configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/PortEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/PortEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /output-ports/{uuid}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "output-ports" ], - "summary" : "Deletes an output port", - "description" : "", - "operationId" : "removeOutputPort", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The revision is used to verify the client is working with the latest version of the flow.", - "required" : false, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The output port id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/PortEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /output-ports/{uuid}" : [ ] - }, { - "Write - Parent Process Group - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/output-ports/{id}/run-status" : { - "put" : { - "tags" : [ "output-ports" ], - "summary" : "Updates run status of an output-port", - "description" : "", - "operationId" : "updateRunStatus", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The port id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The port run status.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/PortRunStatusEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessorEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /output-ports/{uuid} or /operation/output-ports/{uuid}" : [ ] - } ] - } - }, - "/parameter-contexts" : { - "post" : { - "tags" : [ "parameter-contexts" ], - "summary" : "Create a Parameter Context", - "description" : "", - "operationId" : "createParameterContext", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The Parameter Context.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ParameterContextEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ParameterContextEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /parameter-contexts" : [ ] - } ] - } - }, - "/parameter-contexts/{contextId}/update-requests" : { - "post" : { - "tags" : [ "parameter-contexts" ], - "summary" : "Initiate the Update Request of a Parameter Context", - "description" : "This will initiate the process of updating a Parameter Context. Changing the value of a Parameter may require that one or more components be stopped and restarted, so this acttion may take significantly more time than many other REST API actions. As a result, this endpoint will immediately return a ParameterContextUpdateRequestEntity, and the process of updating the necessary components will occur asynchronously in the background. The client may then periodically poll the status of the request by issuing a GET request to /parameter-contexts/update-requests/{requestId}. Once the request is completed, the client is expected to issue a DELETE request to /parameter-contexts/update-requests/{requestId}.", - "operationId" : "submitParameterContextUpdate", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "contextId", - "in" : "path", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The updated version of the parameter context.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ParameterContextEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ParameterContextUpdateRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /parameter-contexts/{parameterContextId}" : [ ] - }, { - "Write - /parameter-contexts/{parameterContextId}" : [ ] - }, { - "Read - for every component that is affected by the update" : [ ] - }, { - "Write - for every component that is affected by the update" : [ ] - } ] - } - }, - "/parameter-contexts/{contextId}/update-requests/{requestId}" : { - "get" : { - "tags" : [ "parameter-contexts" ], - "summary" : "Returns the Update Request with the given ID", - "description" : "Returns the Update Request with the given ID. Once an Update Request has been created by performing a POST to /nifi-api/parameter-contexts, that request can subsequently be retrieved via this endpoint, and the request that is fetched will contain the updated state, such as percent complete, the current state of the request, and any failures. ", - "operationId" : "getParameterContextUpdate", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "contextId", - "in" : "path", - "description" : "The ID of the Parameter Context", - "required" : true, - "type" : "string" - }, { - "name" : "requestId", - "in" : "path", - "description" : "The ID of the Update Request", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ParameterContextUpdateRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Only the user that submitted the request can get it" : [ ] - } ] - }, - "delete" : { - "tags" : [ "parameter-contexts" ], - "summary" : "Deletes the Update Request with the given ID", - "description" : "Deletes the Update Request with the given ID. After a request is created via a POST to /nifi-api/parameter-contexts/update-requests, it is expected that the client will properly clean up the request by DELETE'ing it, once the Update process has completed. If the request is deleted before the request completes, then the Update request will finish the step that it is currently performing and then will cancel any subsequent steps.", - "operationId" : "deleteUpdateRequest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "contextId", - "in" : "path", - "description" : "The ID of the ParameterContext", - "required" : true, - "type" : "string" - }, { - "name" : "requestId", - "in" : "path", - "description" : "The ID of the Update Request", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ParameterContextUpdateRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Only the user that submitted the request can remove it" : [ ] - } ] - } - }, - "/parameter-contexts/{contextId}/validation-requests" : { - "post" : { - "tags" : [ "parameter-contexts" ], - "summary" : "Initiate a Validation Request to determine how the validity of components will change if a Parameter Context were to be updated", - "description" : "This will initiate the process of validating all components whose Process Group is bound to the specified Parameter Context. Performing validation against an arbitrary number of components may be expect and take significantly more time than many other REST API actions. As a result, this endpoint will immediately return a ParameterContextValidationRequestEntity, and the process of validating the necessary components will occur asynchronously in the background. The client may then periodically poll the status of the request by issuing a GET request to /parameter-contexts/validation-requests/{requestId}. Once the request is completed, the client is expected to issue a DELETE request to /parameter-contexts/validation-requests/{requestId}.", - "operationId" : "submitValidationRequest", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "contextId", - "in" : "path", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The validation request", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ParameterContextValidationRequestEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ParameterContextValidationRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /parameter-contexts/{parameterContextId}" : [ ] - } ] - } - }, - "/parameter-contexts/{contextId}/validation-requests/{id}" : { - "get" : { - "tags" : [ "parameter-contexts" ], - "summary" : "Returns the Validation Request with the given ID", - "description" : "Returns the Validation Request with the given ID. Once a Validation Request has been created by performing a POST to /nifi-api/validation-contexts, that request can subsequently be retrieved via this endpoint, and the request that is fetched will contain the updated state, such as percent complete, the current state of the request, and any failures. ", - "operationId" : "getValidationRequest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "contextId", - "in" : "path", - "description" : "The ID of the Parameter Context", - "required" : true, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The ID of the Validation Request", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ParameterContextValidationRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Only the user that submitted the request can get it" : [ ] - } ] - }, - "delete" : { - "tags" : [ "parameter-contexts" ], - "summary" : "Deletes the Validation Request with the given ID", - "description" : "Deletes the Validation Request with the given ID. After a request is created via a POST to /nifi-api/validation-contexts, it is expected that the client will properly clean up the request by DELETE'ing it, once the validation process has completed. If the request is deleted before the request completes, then the Validation request will finish the step that it is currently performing and then will cancel any subsequent steps.", - "operationId" : "deleteValidationRequest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "contextId", - "in" : "path", - "description" : "The ID of the Parameter Context", - "required" : true, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The ID of the Update Request", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ParameterContextValidationRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Only the user that submitted the request can remove it" : [ ] - } ] - } - }, - "/parameter-contexts/{id}" : { - "get" : { - "tags" : [ "parameter-contexts" ], - "summary" : "Returns the Parameter Context with the given ID", - "description" : "Returns the Parameter Context with the given ID.", - "operationId" : "getParameterContext", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The ID of the Parameter Context", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ParameterContextEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /parameter-contexts/{id}" : [ ] - } ] - }, - "put" : { - "tags" : [ "parameter-contexts" ], - "summary" : "Modifies a Parameter Context", - "description" : "This endpoint will update a Parameter Context to match the provided entity. However, this request will fail if any component is running and is referencing a Parameter in the Parameter Context. Generally, this endpoint is not called directly. Instead, an update request should be submitted by making a POST to the /parameter-contexts/update-requests endpoint. That endpoint will, in turn, call this endpoint.", - "operationId" : "updateParameterContext", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The updated Parameter Context", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ParameterContextEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ParameterContextEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /parameter-contexts/{id}" : [ ] - }, { - "Write - /parameter-contexts/{id}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "parameter-contexts" ], - "summary" : "Deletes the Parameter Context with the given ID", - "description" : "Deletes the Parameter Context with the given ID.", - "operationId" : "deleteParameterContext", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The version is used to verify the client is working with the latest version of the flow.", - "required" : false, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, a new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The Parameter Context ID.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ParameterContextEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /parameter-contexts/{uuid}" : [ ] - }, { - "Write - /parameter-contexts/{uuid}" : [ ] - }, { - "Read - /process-groups/{uuid}, for any Process Group that is currently bound to the Parameter Context" : [ ] - }, { - "Write - /process-groups/{uuid}, for any Process Group that is currently bound to the Parameter Context" : [ ] - } ] - } - }, - "/policies" : { - "post" : { - "tags" : [ "policies" ], - "summary" : "Creates an access policy", - "description" : "", - "operationId" : "createAccessPolicy", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The access policy configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/AccessPolicyEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/AccessPolicyEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /policies/{resource}" : [ ] - } ] - } - }, - "/policies/{action}/{resource}" : { - "get" : { - "tags" : [ "policies" ], - "summary" : "Gets an access policy for the specified action and resource", - "description" : "Will return the effective policy if no component specific policy exists for the specified action and resource. Must have Read permissions to the policy with the desired action and resource. Permissions for the policy that is returned will be indicated in the response. This means the client could be authorized to get the policy for a given component but the effective policy may be inherited from an ancestor Process Group. If the client does not have permissions to that policy, the response will not include the policy and the permissions in the response will be marked accordingly. If the client does not have permissions to the policy of the desired action and resource a 403 response will be returned.", - "operationId" : "getAccessPolicyForResource", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "action", - "in" : "path", - "description" : "The request action.", - "required" : true, - "type" : "string", - "enum" : [ "read", "write" ] - }, { - "name" : "resource", - "in" : "path", - "description" : "The resource of the policy.", - "required" : true, - "type" : "string", - "pattern" : ".+" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/AccessPolicyEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /policies/{resource}" : [ ] - } ] - } - }, - "/policies/{id}" : { - "get" : { - "tags" : [ "policies" ], - "summary" : "Gets an access policy", - "description" : "", - "operationId" : "getAccessPolicy", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The access policy id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/AccessPolicyEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /policies/{resource}" : [ ] - } ] - }, - "put" : { - "tags" : [ "policies" ], - "summary" : "Updates a access policy", - "description" : "", - "operationId" : "updateAccessPolicy", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The access policy id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The access policy configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/AccessPolicyEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/AccessPolicyEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /policies/{resource}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "policies" ], - "summary" : "Deletes an access policy", - "description" : "", - "operationId" : "removeAccessPolicy", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The revision is used to verify the client is working with the latest version of the flow.", - "required" : false, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The access policy id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/AccessPolicyEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /policies/{resource}" : [ ] - }, { - "Write - Policy of the parent resource - /policies/{resource}" : [ ] - } ] - } - }, - "/process-groups/{groupId}/variable-registry/update-requests/{updateId}" : { - "get" : { - "tags" : [ "process-groups" ], - "summary" : "Gets a process group's variable registry", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getVariableRegistryUpdateRequest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "groupId", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "name" : "updateId", - "in" : "path", - "description" : "The ID of the Variable Registry Update Request", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VariableRegistryUpdateRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "process-groups" ], - "summary" : "Deletes an update request for a process group's variable registry. If the request is not yet complete, it will automatically be cancelled.", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "deleteVariableRegistryUpdateRequest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "groupId", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "name" : "updateId", - "in" : "path", - "description" : "The ID of the Variable Registry Update Request", - "required" : true, - "type" : "string" - }, { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VariableRegistryUpdateRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/process-groups/{id}" : { - "get" : { - "tags" : [ "process-groups" ], - "summary" : "Gets a process group", - "description" : "", - "operationId" : "getProcessGroup", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessGroupEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - } ] - }, - "put" : { - "tags" : [ "process-groups" ], - "summary" : "Updates a process group", - "description" : "", - "operationId" : "updateProcessGroup", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The process group configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ProcessGroupEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessGroupEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "process-groups" ], - "summary" : "Deletes a process group", - "description" : "", - "operationId" : "removeProcessGroup", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The revision is used to verify the client is working with the latest version of the flow.", - "required" : false, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessGroupEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - }, { - "Write - Parent Process Group - /process-groups/{uuid}" : [ ] - }, { - "Read - any referenced Controller Services by any encapsulated components - /controller-services/{uuid}" : [ ] - }, { - "Write - /{component-type}/{uuid} - For all encapsulated components" : [ ] - } ] - } - }, - "/process-groups/{id}/connections" : { - "get" : { - "tags" : [ "process-groups" ], - "summary" : "Gets all connections", - "description" : "", - "operationId" : "getConnections", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ConnectionsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - } ] - }, - "post" : { - "tags" : [ "process-groups" ], - "summary" : "Creates a connection", - "description" : "", - "operationId" : "createConnection", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The connection configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ConnectionEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ConnectionEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - }, { - "Write Source - /{component-type}/{uuid}" : [ ] - }, { - "Write Destination - /{component-type}/{uuid}" : [ ] - } ] - } - }, - "/process-groups/{id}/controller-services" : { - "post" : { - "tags" : [ "process-groups" ], - "summary" : "Creates a new controller service", - "description" : "", - "operationId" : "createControllerService", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The controller service configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ControllerServiceEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ControllerServiceEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - }, { - "Read - any referenced Controller Services - /controller-services/{uuid}" : [ ] - }, { - "Write - if the Controller Service is restricted - /restricted-components" : [ ] - } ] - } - }, - "/process-groups/{id}/download" : { - "get" : { - "tags" : [ "process-groups" ], - "summary" : "Gets a process group for download", - "description" : "", - "operationId" : "exportProcessGroup", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/process-groups/{id}/funnels" : { - "get" : { - "tags" : [ "process-groups" ], - "summary" : "Gets all funnels", - "description" : "", - "operationId" : "getFunnels", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/FunnelsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - } ] - }, - "post" : { - "tags" : [ "process-groups" ], - "summary" : "Creates a funnel", - "description" : "", - "operationId" : "createFunnel", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The funnel configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/FunnelEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/FunnelEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/process-groups/{id}/input-ports" : { - "get" : { - "tags" : [ "process-groups" ], - "summary" : "Gets all input ports", - "description" : "", - "operationId" : "getInputPorts", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/InputPortsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - } ] - }, - "post" : { - "tags" : [ "process-groups" ], - "summary" : "Creates an input port", - "description" : "", - "operationId" : "createInputPort", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The input port configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/PortEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/PortEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/process-groups/{id}/labels" : { - "get" : { - "tags" : [ "process-groups" ], - "summary" : "Gets all labels", - "description" : "", - "operationId" : "getLabels", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/LabelsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - } ] - }, - "post" : { - "tags" : [ "process-groups" ], - "summary" : "Creates a label", - "description" : "", - "operationId" : "createLabel", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The label configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/LabelEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/LabelEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/process-groups/{id}/local-modifications" : { - "get" : { - "tags" : [ "process-groups" ], - "summary" : "Gets a list of local modifications to the Process Group since it was last synchronized with the Flow Registry", - "description" : "", - "operationId" : "getLocalModifications", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/FlowComparisonEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - }, { - "Read - /{component-type}/{uuid} - For all encapsulated components" : [ ] - } ] - } - }, - "/process-groups/{id}/output-ports" : { - "get" : { - "tags" : [ "process-groups" ], - "summary" : "Gets all output ports", - "description" : "", - "operationId" : "getOutputPorts", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/OutputPortsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - } ] - }, - "post" : { - "tags" : [ "process-groups" ], - "summary" : "Creates an output port", - "description" : "", - "operationId" : "createOutputPort", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The output port configuration.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/PortEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/PortEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/process-groups/{id}/process-groups" : { - "get" : { - "tags" : [ "process-groups" ], - "summary" : "Gets all process groups", - "description" : "", - "operationId" : "getProcessGroups", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessGroupsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - } ] - }, - "post" : { - "tags" : [ "process-groups" ], - "summary" : "Creates a process group", - "description" : "", - "operationId" : "createProcessGroup", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The process group configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ProcessGroupEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessGroupEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/process-groups/{id}/processors" : { - "get" : { - "tags" : [ "process-groups" ], - "summary" : "Gets all processors", - "description" : "", - "operationId" : "getProcessors", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "name" : "includeDescendantGroups", - "in" : "query", - "description" : "Whether or not to include processors from descendant process groups", - "required" : false, - "type" : "boolean", - "default" : false - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessorsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - } ] - }, - "post" : { - "tags" : [ "process-groups" ], - "summary" : "Creates a new processor", - "description" : "", - "operationId" : "createProcessor", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The processor configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ProcessorEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessorEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - }, { - "Read - any referenced Controller Services - /controller-services/{uuid}" : [ ] - }, { - "Write - if the Processor is restricted - /restricted-components" : [ ] - } ] - } - }, - "/process-groups/{id}/remote-process-groups" : { - "get" : { - "tags" : [ "process-groups" ], - "summary" : "Gets all remote process groups", - "description" : "", - "operationId" : "getRemoteProcessGroups", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/RemoteProcessGroupsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - } ] - }, - "post" : { - "tags" : [ "process-groups" ], - "summary" : "Creates a new process group", - "description" : "", - "operationId" : "createRemoteProcessGroup", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The remote process group configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/RemoteProcessGroupEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/RemoteProcessGroupEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/process-groups/{id}/snippet-instance" : { - "post" : { - "tags" : [ "process-groups" ], - "summary" : "Copies a snippet and discards it.", - "description" : "", - "operationId" : "copySnippet", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The copy snippet request.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/CopySnippetRequestEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/FlowEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - }, { - "Read - /{component-type}/{uuid} - For each component in the snippet and their descendant components" : [ ] - }, { - "Write - if the snippet contains any restricted Processors - /restricted-components" : [ ] - } ] - } - }, - "/process-groups/{id}/template-instance" : { - "post" : { - "tags" : [ "process-groups" ], - "summary" : "Instantiates a template", - "description" : "", - "operationId" : "instantiateTemplate", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The instantiate template request.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/InstantiateTemplateRequestEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/FlowEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - }, { - "Read - /templates/{uuid}" : [ ] - }, { - "Write - if the template contains any restricted components - /restricted-components" : [ ] - } ] - } - }, - "/process-groups/{id}/templates" : { - "post" : { - "tags" : [ "process-groups" ], - "summary" : "Creates a template and discards the specified snippet.", - "description" : "", - "operationId" : "createTemplate", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The create template request.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/CreateTemplateRequestEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/TemplateEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - }, { - "Read - /{component-type}/{uuid} - For each component in the snippet and their descendant components" : [ ] - } ] - } - }, - "/process-groups/{id}/templates/import" : { - "post" : { - "tags" : [ "process-groups" ], - "summary" : "Imports a template", - "description" : "", - "operationId" : "importTemplate", - "consumes" : [ "application/xml" ], - "produces" : [ "application/xml" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/TemplateEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/process-groups/{id}/templates/upload" : { - "post" : { - "tags" : [ "process-groups" ], - "summary" : "Uploads a template", - "description" : "", - "operationId" : "uploadTemplate", - "consumes" : [ "multipart/form-data" ], - "produces" : [ "application/xml" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "schema" : { - "type" : "boolean" - } - }, { - "name" : "template", - "in" : "formData", - "description" : "The binary content of the template file being uploaded.", - "required" : true, - "type" : "file" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/TemplateEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/process-groups/{id}/variable-registry" : { - "get" : { - "tags" : [ "process-groups" ], - "summary" : "Gets a process group's variable registry", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getVariableRegistry", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "name" : "includeAncestorGroups", - "in" : "query", - "description" : "Whether or not to include ancestor groups", - "required" : false, - "type" : "boolean", - "default" : true - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VariableRegistryEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - } ] - }, - "put" : { - "tags" : [ "process-groups" ], - "summary" : "Updates the contents of a Process Group's variable Registry", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "updateVariableRegistry", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The variable registry configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/VariableRegistryEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VariableRegistryEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/process-groups/{id}/variable-registry/update-requests" : { - "post" : { - "tags" : [ "process-groups" ], - "summary" : "Submits a request to update a process group's variable registry", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "submitUpdateVariableRegistryRequest", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The variable registry configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/VariableRegistryEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VariableRegistryUpdateRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/processors/{id}" : { - "get" : { - "tags" : [ "processors" ], - "summary" : "Gets a processor", - "description" : "", - "operationId" : "getProcessor", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The processor id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessorEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /processors/{uuid}" : [ ] - } ] - }, - "put" : { - "tags" : [ "processors" ], - "summary" : "Updates a processor", - "description" : "", - "operationId" : "updateProcessor", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The processor id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The processor configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ProcessorEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessorEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /processors/{uuid}" : [ ] - }, { - "Read - any referenced Controller Services if this request changes the reference - /controller-services/{uuid}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "processors" ], - "summary" : "Deletes a processor", - "description" : "", - "operationId" : "deleteProcessor", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The revision is used to verify the client is working with the latest version of the flow.", - "required" : false, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The processor id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessorEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /processors/{uuid}" : [ ] - }, { - "Write - Parent Process Group - /process-groups/{uuid}" : [ ] - }, { - "Read - any referenced Controller Services - /controller-services/{uuid}" : [ ] - } ] - } - }, - "/processors/{id}/descriptors" : { - "get" : { - "tags" : [ "processors" ], - "summary" : "Gets the descriptor for a processor property", - "description" : "", - "operationId" : "getPropertyDescriptor", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The processor id.", - "required" : true, - "type" : "string" - }, { - "name" : "propertyName", - "in" : "query", - "description" : "The property name.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/PropertyDescriptorEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /processors/{uuid}" : [ ] - } ] - } - }, - "/processors/{id}/diagnostics" : { - "get" : { - "tags" : [ "processors" ], - "summary" : "Gets diagnostics information about a processor", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getProcessorDiagnostics", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The processor id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessorEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /processors/{uuid}" : [ ] - } ] - } - }, - "/processors/{id}/run-status" : { - "put" : { - "tags" : [ "processors" ], - "summary" : "Updates run status of a processor", - "description" : "", - "operationId" : "updateRunStatus", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The processor id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The processor run status.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ProcessorRunStatusEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessorEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /processors/{uuid} or /operation/processors/{uuid}" : [ ] - } ] - } - }, - "/processors/{id}/state" : { - "get" : { - "tags" : [ "processors" ], - "summary" : "Gets the state for a processor", - "description" : "", - "operationId" : "getState", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The processor id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ComponentStateEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /processors/{uuid}" : [ ] - } ] - } - }, - "/processors/{id}/state/clear-requests" : { - "post" : { - "tags" : [ "processors" ], - "summary" : "Clears the state for a processor", - "description" : "", - "operationId" : "clearState", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The processor id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ComponentStateEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /processors/{uuid}" : [ ] - } ] - } - }, - "/processors/{id}/threads" : { - "delete" : { - "tags" : [ "processors" ], - "summary" : "Terminates a processor, essentially \"deleting\" its threads and any active tasks", - "description" : "", - "operationId" : "terminateProcessor", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The processor id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessorEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /processors/{uuid} or /operation/processors/{uuid}" : [ ] - } ] - } - }, - "/provenance" : { - "post" : { - "tags" : [ "provenance" ], - "summary" : "Submits a provenance query", - "description" : "Provenance queries may be long running so this endpoint submits a request. The response will include the current state of the query. If the request is not completed the URI in the response can be used at a later time to get the updated state of the query. Once the query has completed the provenance request should be deleted by the client who originally submitted it.", - "operationId" : "submitProvenanceRequest", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The provenance query details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ProvenanceEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProvenanceEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /provenance" : [ ] - }, { - "Read - /data/{component-type}/{uuid}" : [ ] - } ] - } - }, - "/provenance-events/replays" : { - "post" : { - "tags" : [ "provenance-events" ], - "summary" : "Replays content from a provenance event", - "description" : "", - "operationId" : "submitReplay", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The replay request.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/SubmitReplayRequestEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProvenanceEventEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read Component Provenance Data - /provenance-data/{component-type}/{uuid}" : [ ] - }, { - "Read Component Data - /data/{component-type}/{uuid}" : [ ] - }, { - "Write Component Data - /data/{component-type}/{uuid}" : [ ] - } ] - } - }, - "/provenance-events/{id}" : { - "get" : { - "tags" : [ "provenance-events" ], - "summary" : "Gets a provenance event", - "description" : "", - "operationId" : "getProvenanceEvent", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "clusterNodeId", - "in" : "query", - "description" : "The id of the node where this event exists if clustered.", - "required" : false, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The provenance event id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProvenanceEventEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read Component Provenance Data - /provenance-data/{component-type}/{uuid}" : [ ] - } ] - } - }, - "/provenance-events/{id}/content/input" : { - "get" : { - "tags" : [ "provenance-events" ], - "summary" : "Gets the input content for a provenance event", - "description" : "", - "operationId" : "getInputContent", - "consumes" : [ "*/*" ], - "produces" : [ "*/*" ], - "parameters" : [ { - "name" : "clusterNodeId", - "in" : "query", - "description" : "The id of the node where the content exists if clustered.", - "required" : false, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The provenance event id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/StreamingOutput" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read Component Provenance Data - /provenance-data/{component-type}/{uuid}" : [ ] - }, { - "Read Component Data - /data/{component-type}/{uuid}" : [ ] - } ] - } - }, - "/provenance-events/{id}/content/output" : { - "get" : { - "tags" : [ "provenance-events" ], - "summary" : "Gets the output content for a provenance event", - "description" : "", - "operationId" : "getOutputContent", - "consumes" : [ "*/*" ], - "produces" : [ "*/*" ], - "parameters" : [ { - "name" : "clusterNodeId", - "in" : "query", - "description" : "The id of the node where the content exists if clustered.", - "required" : false, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The provenance event id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/StreamingOutput" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read Component Provenance Data - /provenance-data/{component-type}/{uuid}" : [ ] - }, { - "Read Component Data - /data/{component-type}/{uuid}" : [ ] - } ] - } - }, - "/provenance/lineage" : { - "post" : { - "tags" : [ "provenance" ], - "summary" : "Submits a lineage query", - "description" : "Lineage queries may be long running so this endpoint submits a request. The response will include the current state of the query. If the request is not completed the URI in the response can be used at a later time to get the updated state of the query. Once the query has completed the lineage request should be deleted by the client who originally submitted it.", - "operationId" : "submitLineageRequest", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The lineage query details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/LineageEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/LineageEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /provenance" : [ ] - }, { - "Read - /data/{component-type}/{uuid}" : [ ] - } ] - } - }, - "/provenance/lineage/{id}" : { - "get" : { - "tags" : [ "provenance" ], - "summary" : "Gets a lineage query", - "description" : "", - "operationId" : "getLineage", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "clusterNodeId", - "in" : "query", - "description" : "The id of the node where this query exists if clustered.", - "required" : false, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The id of the lineage query.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/LineageEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /provenance" : [ ] - }, { - "Read - /data/{component-type}/{uuid}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "provenance" ], - "summary" : "Deletes a lineage query", - "description" : "", - "operationId" : "deleteLineage", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "clusterNodeId", - "in" : "query", - "description" : "The id of the node where this query exists if clustered.", - "required" : false, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The id of the lineage query.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/LineageEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /provenance" : [ ] - } ] - } - }, - "/provenance/search-options" : { - "get" : { - "tags" : [ "provenance" ], - "summary" : "Gets the searchable attributes for provenance events", - "description" : "", - "operationId" : "getSearchOptions", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProvenanceOptionsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /provenance" : [ ] - } ] - } - }, - "/provenance/{id}" : { - "get" : { - "tags" : [ "provenance" ], - "summary" : "Gets a provenance query", - "description" : "", - "operationId" : "getProvenance", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "clusterNodeId", - "in" : "query", - "description" : "The id of the node where this query exists if clustered.", - "required" : false, - "type" : "string" - }, { - "name" : "summarize", - "in" : "query", - "description" : "Whether or not incremental results are returned. If false, provenance events are only returned once the query completes. This property is true by default.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "incrementalResults", - "in" : "query", - "description" : "Whether or not to summarize provenance events returned. This property is false by default.", - "required" : false, - "type" : "boolean", - "default" : true - }, { - "name" : "id", - "in" : "path", - "description" : "The id of the provenance query.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProvenanceEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /provenance" : [ ] - }, { - "Read - /data/{component-type}/{uuid}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "provenance" ], - "summary" : "Deletes a provenance query", - "description" : "", - "operationId" : "deleteProvenance", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "clusterNodeId", - "in" : "query", - "description" : "The id of the node where this query exists if clustered.", - "required" : false, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The id of the provenance query.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProvenanceEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /provenance" : [ ] - } ] - } - }, - "/remote-process-groups/{id}" : { - "get" : { - "tags" : [ "remote-process-groups" ], - "summary" : "Gets a remote process group", - "description" : "", - "operationId" : "getRemoteProcessGroup", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The remote process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/RemoteProcessGroupEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /remote-process-groups/{uuid}" : [ ] - } ] - }, - "put" : { - "tags" : [ "remote-process-groups" ], - "summary" : "Updates a remote process group", - "description" : "", - "operationId" : "updateRemoteProcessGroup", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The remote process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The remote process group.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/RemoteProcessGroupEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/RemoteProcessGroupEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /remote-process-groups/{uuid}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "remote-process-groups" ], - "summary" : "Deletes a remote process group", - "description" : "", - "operationId" : "removeRemoteProcessGroup", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The revision is used to verify the client is working with the latest version of the flow.", - "required" : false, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The remote process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/RemoteProcessGroupEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /remote-process-groups/{uuid}" : [ ] - }, { - "Write - Parent Process Group - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/remote-process-groups/{id}/input-ports/{port-id}" : { - "put" : { - "tags" : [ "remote-process-groups" ], - "summary" : "Updates a remote port", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "updateRemoteProcessGroupInputPort", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The remote process group id.", - "required" : true, - "type" : "string" - }, { - "name" : "port-id", - "in" : "path", - "description" : "The remote process group port id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The remote process group port.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/RemoteProcessGroupPortEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/RemoteProcessGroupPortEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /remote-process-groups/{uuid}" : [ ] - } ] - } - }, - "/remote-process-groups/{id}/input-ports/{port-id}/run-status" : { - "put" : { - "tags" : [ "remote-process-groups" ], - "summary" : "Updates run status of a remote port", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "updateRemoteProcessGroupInputPortRunStatus", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The remote process group id.", - "required" : true, - "type" : "string" - }, { - "name" : "port-id", - "in" : "path", - "description" : "The remote process group port id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The remote process group port.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/RemotePortRunStatusEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/RemoteProcessGroupPortEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /remote-process-groups/{uuid} or /operation/remote-process-groups/{uuid}" : [ ] - } ] - } - }, - "/remote-process-groups/{id}/output-ports/{port-id}" : { - "put" : { - "tags" : [ "remote-process-groups" ], - "summary" : "Updates a remote port", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "updateRemoteProcessGroupOutputPort", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The remote process group id.", - "required" : true, - "type" : "string" - }, { - "name" : "port-id", - "in" : "path", - "description" : "The remote process group port id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The remote process group port.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/RemoteProcessGroupPortEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/RemoteProcessGroupPortEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /remote-process-groups/{uuid}" : [ ] - } ] - } - }, - "/remote-process-groups/{id}/output-ports/{port-id}/run-status" : { - "put" : { - "tags" : [ "remote-process-groups" ], - "summary" : "Updates run status of a remote port", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "updateRemoteProcessGroupOutputPortRunStatus", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The remote process group id.", - "required" : true, - "type" : "string" - }, { - "name" : "port-id", - "in" : "path", - "description" : "The remote process group port id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The remote process group port.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/RemotePortRunStatusEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/RemoteProcessGroupPortEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /remote-process-groups/{uuid} or /operation/remote-process-groups/{uuid}" : [ ] - } ] - } - }, - "/remote-process-groups/{id}/run-status" : { - "put" : { - "tags" : [ "remote-process-groups" ], - "summary" : "Updates run status of a remote process group", - "description" : "", - "operationId" : "updateRemoteProcessGroupRunStatus", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The remote process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The remote process group run status.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/RemotePortRunStatusEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/RemoteProcessGroupEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /remote-process-groups/{uuid} or /operation/remote-process-groups/{uuid}" : [ ] - } ] - } - }, - "/remote-process-groups/{id}/state" : { - "get" : { - "tags" : [ "remote-process-groups" ], - "summary" : "Gets the state for a RemoteProcessGroup", - "description" : "", - "operationId" : "getState", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The processor id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ComponentStateEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /remote-process-groups/{uuid}" : [ ] - } ] - } - }, - "/reporting-tasks/{id}" : { - "get" : { - "tags" : [ "reporting-tasks" ], - "summary" : "Gets a reporting task", - "description" : "", - "operationId" : "getReportingTask", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The reporting task id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ReportingTaskEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /reporting-tasks/{uuid}" : [ ] - } ] - }, - "put" : { - "tags" : [ "reporting-tasks" ], - "summary" : "Updates a reporting task", - "description" : "", - "operationId" : "updateReportingTask", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The reporting task id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The reporting task configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ReportingTaskEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ReportingTaskEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /reporting-tasks/{uuid}" : [ ] - }, { - "Read - any referenced Controller Services if this request changes the reference - /controller-services/{uuid}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "reporting-tasks" ], - "summary" : "Deletes a reporting task", - "description" : "", - "operationId" : "removeReportingTask", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The revision is used to verify the client is working with the latest version of the flow.", - "required" : false, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The reporting task id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ReportingTaskEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /reporting-tasks/{uuid}" : [ ] - }, { - "Write - /controller" : [ ] - }, { - "Read - any referenced Controller Services - /controller-services/{uuid}" : [ ] - } ] - } - }, - "/reporting-tasks/{id}/descriptors" : { - "get" : { - "tags" : [ "reporting-tasks" ], - "summary" : "Gets a reporting task property descriptor", - "description" : "", - "operationId" : "getPropertyDescriptor", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The reporting task id.", - "required" : true, - "type" : "string" - }, { - "name" : "propertyName", - "in" : "query", - "description" : "The property name.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/PropertyDescriptorEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /reporting-tasks/{uuid}" : [ ] - } ] - } - }, - "/reporting-tasks/{id}/run-status" : { - "put" : { - "tags" : [ "reporting-tasks" ], - "summary" : "Updates run status of a reporting task", - "description" : "", - "operationId" : "updateRunStatus", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The reporting task id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The reporting task run status.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ReportingTaskRunStatusEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ReportingTaskEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /reporting-tasks/{uuid} or or /operation/reporting-tasks/{uuid}" : [ ] - } ] - } - }, - "/reporting-tasks/{id}/state" : { - "get" : { - "tags" : [ "reporting-tasks" ], - "summary" : "Gets the state for a reporting task", - "description" : "", - "operationId" : "getState", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The reporting task id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ComponentStateEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /reporting-tasks/{uuid}" : [ ] - } ] - } - }, - "/reporting-tasks/{id}/state/clear-requests" : { - "post" : { - "tags" : [ "reporting-tasks" ], - "summary" : "Clears the state for a reporting task", - "description" : "", - "operationId" : "clearState", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The reporting task id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ComponentStateEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /reporting-tasks/{uuid}" : [ ] - } ] - } - }, - "/resources" : { - "get" : { - "tags" : [ "resources" ], - "summary" : "Gets the available resources that support access/authorization policies", - "description" : "", - "operationId" : "getResources", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ResourcesEntity" - } - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - } - }, - "security" : [ { - "Read - /resources" : [ ] - } ] - } - }, - "/site-to-site" : { - "get" : { - "tags" : [ "site-to-site" ], - "summary" : "Returns the details about this NiFi necessary to communicate via site to site", - "description" : "", - "operationId" : "getSiteToSiteDetails", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ControllerEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /site-to-site" : [ ] - } ] - } - }, - "/site-to-site/peers" : { - "get" : { - "tags" : [ "site-to-site" ], - "summary" : "Returns the available Peers and its status of this NiFi", - "description" : "", - "operationId" : "getPeers", - "consumes" : [ "*/*" ], - "produces" : [ "application/json", "application/xml" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/PeersEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /site-to-site" : [ ] - } ] - } - }, - "/snippets" : { - "post" : { - "tags" : [ "snippets" ], - "summary" : "Creates a snippet. The snippet will be automatically discarded if not used in a subsequent request after 1 minute.", - "description" : "", - "operationId" : "createSnippet", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The snippet configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/SnippetEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/SnippetEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read or Write - /{component-type}/{uuid} - For every component (all Read or all Write) in the Snippet and their descendant components" : [ ] - } ] - } - }, - "/snippets/{id}" : { - "put" : { - "tags" : [ "snippets" ], - "summary" : "Move's the components in this Snippet into a new Process Group and discards the snippet", - "description" : "", - "operationId" : "updateSnippet", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The snippet id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The snippet configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/SnippetEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/SnippetEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write Process Group - /process-groups/{uuid}" : [ ] - }, { - "Write - /{component-type}/{uuid} - For each component in the Snippet and their descendant components" : [ ] - } ] - }, - "delete" : { - "tags" : [ "snippets" ], - "summary" : "Deletes the components in a snippet and discards the snippet", - "description" : "", - "operationId" : "deleteSnippet", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The snippet id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/SnippetEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /{component-type}/{uuid} - For each component in the Snippet and their descendant components" : [ ] - }, { - "Write - Parent Process Group - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/system-diagnostics" : { - "get" : { - "tags" : [ "system-diagnostics" ], - "summary" : "Gets the diagnostics for the system NiFi is running on", - "description" : "", - "operationId" : "getSystemDiagnostics", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "nodewise", - "in" : "query", - "description" : "Whether or not to include the breakdown per node. Optional, defaults to false", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "clusterNodeId", - "in" : "query", - "description" : "The id of the node where to get the status.", - "required" : false, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/SystemDiagnosticsEntity" - } - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - } - }, - "security" : [ { - "Read - /system" : [ ] - } ] - } - }, - "/templates/{id}" : { - "delete" : { - "tags" : [ "templates" ], - "summary" : "Deletes a template", - "description" : "", - "operationId" : "removeTemplate", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The template id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/TemplateEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /templates/{uuid}" : [ ] - }, { - "Write - Parent Process Group - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/templates/{id}/download" : { - "get" : { - "tags" : [ "templates" ], - "summary" : "Exports a template", - "description" : "", - "operationId" : "exportTemplate", - "consumes" : [ "*/*" ], - "produces" : [ "application/xml" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The template id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /templates/{uuid}" : [ ] - } ] - } - }, - "/tenants/search-results" : { - "get" : { - "tags" : [ "tenants" ], - "summary" : "Searches for a tenant with the specified identity", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "searchTenants", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "q", - "in" : "query", - "description" : "Identity to search for.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/TenantsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /tenants" : [ ] - } ] - } - }, - "/tenants/user-groups" : { - "get" : { - "tags" : [ "tenants" ], - "summary" : "Gets all user groups", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getUserGroups", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/UserGroupsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /tenants" : [ ] - } ] - }, - "post" : { - "tags" : [ "tenants" ], - "summary" : "Creates a user group", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "createUserGroup", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The user group configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/UserGroupEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/UserGroupEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /tenants" : [ ] - } ] - } - }, - "/tenants/user-groups/{id}" : { - "get" : { - "tags" : [ "tenants" ], - "summary" : "Gets a user group", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getUserGroup", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The user group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/UserGroupEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /tenants" : [ ] - } ] - }, - "put" : { - "tags" : [ "tenants" ], - "summary" : "Updates a user group", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "updateUserGroup", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The user group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The user group configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/UserGroupEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/UserGroupEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /tenants" : [ ] - } ] - }, - "delete" : { - "tags" : [ "tenants" ], - "summary" : "Deletes a user group", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "removeUserGroup", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The revision is used to verify the client is working with the latest version of the flow.", - "required" : false, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The user group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/UserGroupEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /tenants" : [ ] - } ] - } - }, - "/tenants/users" : { - "get" : { - "tags" : [ "tenants" ], - "summary" : "Gets all users", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getUsers", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/UsersEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /tenants" : [ ] - } ] - }, - "post" : { - "tags" : [ "tenants" ], - "summary" : "Creates a user", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "createUser", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The user configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/UserEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/UserEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /tenants" : [ ] - } ] - } - }, - "/tenants/users/{id}" : { - "get" : { - "tags" : [ "tenants" ], - "summary" : "Gets a user", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getUser", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The user id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/UserEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /tenants" : [ ] - } ] - }, - "put" : { - "tags" : [ "tenants" ], - "summary" : "Updates a user", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "updateUser", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The user id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The user configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/UserEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/UserEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /tenants" : [ ] - } ] - }, - "delete" : { - "tags" : [ "tenants" ], - "summary" : "Deletes a user", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "removeUser", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The revision is used to verify the client is working with the latest version of the flow.", - "required" : false, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The user id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/UserEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /tenants" : [ ] - } ] - } - }, - "/versions/active-requests" : { - "post" : { - "tags" : [ "versions" ], - "summary" : "Create a version control request", - "description" : "Creates a request so that a Process Group can be placed under Version Control or have its Version Control configuration changed. Creating this request will prevent any other threads from simultaneously saving local changes to Version Control. It will not, however, actually save the local flow to the Flow Registry. A POST to /versions/process-groups/{id} should be used to initiate saving of the local flow to the Flow Registry. Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "createVersionControlRequest", - "consumes" : [ "application/json" ], - "produces" : [ "text/plain" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The versioned flow details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/CreateActiveRequestEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/versions/active-requests/{id}" : { - "put" : { - "tags" : [ "versions" ], - "summary" : "Updates the request with the given ID", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "updateVersionControlRequest", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The request ID.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The version control component mapping.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/VersionControlComponentMappingEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionControlInformationEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Only the user that submitted the request can update it" : [ ] - } ] - }, - "delete" : { - "tags" : [ "versions" ], - "summary" : "Deletes the version control request with the given ID", - "description" : "Deletes the Version Control Request with the given ID. This will allow other threads to save flows to the Flow Registry. See also the documentation for POSTing to /versions/active-requests for information regarding why this is done. Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "deleteVersionControlRequest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The request ID.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Only the user that submitted the request can remove it" : [ ] - } ] - } - }, - "/versions/process-groups/{id}" : { - "get" : { - "tags" : [ "versions" ], - "summary" : "Gets the Version Control information for a process group", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getVersionInformation", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionControlInformationEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - } ] - }, - "post" : { - "tags" : [ "versions" ], - "summary" : "Save the Process Group with the given ID", - "description" : "Begins version controlling the Process Group with the given ID or commits changes to the Versioned Flow, depending on if the provided VersionControlInformation includes a flowId. Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "saveToFlowRegistry", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The versioned flow details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/StartVersionControlRequestEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionControlInformationEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - }, { - "Write - /process-groups/{uuid}" : [ ] - }, { - "Read - /{component-type}/{uuid} - For all encapsulated components" : [ ] - }, { - "Read - any referenced Controller Services by any encapsulated components - /controller-services/{uuid}" : [ ] - } ] - }, - "put" : { - "tags" : [ "versions" ], - "summary" : "Update the version of a Process Group with the given ID", - "description" : "For a Process Group that is already under Version Control, this will update the version of the flow to a different version. This endpoint expects that the given snapshot will not modify any Processor that is currently running or any Controller Service that is enabled. Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "updateFlowVersion", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The controller service configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/VersionedFlowSnapshotEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionControlInformationEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - }, { - "Write - /process-groups/{uuid}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "versions" ], - "summary" : "Stops version controlling the Process Group with the given ID", - "description" : "Stops version controlling the Process Group with the given ID. The Process Group will no longer track to any Versioned Flow. Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "stopVersionControl", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The version is used to verify the client is working with the latest version of the flow.", - "required" : false, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, a new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionControlInformationEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - }, { - "Write - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/versions/process-groups/{id}/download" : { - "get" : { - "tags" : [ "versions" ], - "summary" : "Gets the latest version of a Process Group for download", - "description" : "", - "operationId" : "exportFlowVersion", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/versions/revert-requests/process-groups/{id}" : { - "post" : { - "tags" : [ "versions" ], - "summary" : "Initiate the Revert Request of a Process Group with the given ID", - "description" : "For a Process Group that is already under Version Control, this will initiate the action of reverting any local changes that have been made to the Process Group since it was last synchronized with the Flow Registry. This will result in the flow matching the Versioned Flow that exists in the Flow Registry. This can be a lengthy process, as it will stop any Processors and disable any Controller Services necessary to perform the action and then restart them. As a result, the endpoint will immediately return a VersionedFlowUpdateRequestEntity, and the process of updating the flow will occur asynchronously in the background. The client may then periodically poll the status of the request by issuing a GET request to /versions/revert-requests/{requestId}. Once the request is completed, the client is expected to issue a DELETE request to /versions/revert-requests/{requestId}. Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "initiateRevertFlowVersion", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The controller service configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/VersionControlInformationEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlowUpdateRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - }, { - "Write - /process-groups/{uuid}" : [ ] - }, { - "Read - /{component-type}/{uuid} - For all encapsulated components" : [ ] - }, { - "Write - /{component-type}/{uuid} - For all encapsulated components" : [ ] - }, { - "Write - if the template contains any restricted components - /restricted-components" : [ ] - }, { - "Read - /parameter-contexts/{uuid} - For any Parameter Context that is referenced by a Property that is changed, added, or removed" : [ ] - } ] - } - }, - "/versions/revert-requests/{id}" : { - "get" : { - "tags" : [ "versions" ], - "summary" : "Returns the Revert Request with the given ID", - "description" : "Returns the Revert Request with the given ID. Once a Revert Request has been created by performing a POST to /versions/revert-requests/process-groups/{id}, that request can subsequently be retrieved via this endpoint, and the request that is fetched will contain the updated state, such as percent complete, the current state of the request, and any failures. Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getRevertRequest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The ID of the Revert Request", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlowUpdateRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Only the user that submitted the request can get it" : [ ] - } ] - }, - "delete" : { - "tags" : [ "versions" ], - "summary" : "Deletes the Revert Request with the given ID", - "description" : "Deletes the Revert Request with the given ID. After a request is created via a POST to /versions/revert-requests/process-groups/{id}, it is expected that the client will properly clean up the request by DELETE'ing it, once the Revert process has completed. If the request is deleted before the request completes, then the Revert request will finish the step that it is currently performing and then will cancel any subsequent steps. Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "deleteRevertRequest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The ID of the Revert Request", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlowUpdateRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Only the user that submitted the request can remove it" : [ ] - } ] - } - }, - "/versions/update-requests/process-groups/{id}" : { - "post" : { - "tags" : [ "versions" ], - "summary" : "Initiate the Update Request of a Process Group with the given ID", - "description" : "For a Process Group that is already under Version Control, this will initiate the action of changing from a specific version of the flow in the Flow Registry to a different version of the flow. This can be a lengthy process, as it will stop any Processors and disable any Controller Services necessary to perform the action and then restart them. As a result, the endpoint will immediately return a VersionedFlowUpdateRequestEntity, and the process of updating the flow will occur asynchronously in the background. The client may then periodically poll the status of the request by issuing a GET request to /versions/update-requests/{requestId}. Once the request is completed, the client is expected to issue a DELETE request to /versions/update-requests/{requestId}. Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "initiateVersionControlUpdate", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The controller service configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/VersionControlInformationEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlowUpdateRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - }, { - "Write - /process-groups/{uuid}" : [ ] - }, { - "Read - /{component-type}/{uuid} - For all encapsulated components" : [ ] - }, { - "Write - /{component-type}/{uuid} - For all encapsulated components" : [ ] - }, { - "Write - if the template contains any restricted components - /restricted-components" : [ ] - }, { - "Read - /parameter-contexts/{uuid} - For any Parameter Context that is referenced by a Property that is changed, added, or removed" : [ ] - } ] - } - }, - "/versions/update-requests/{id}" : { - "get" : { - "tags" : [ "versions" ], - "summary" : "Returns the Update Request with the given ID", - "description" : "Returns the Update Request with the given ID. Once an Update Request has been created by performing a POST to /versions/update-requests/process-groups/{id}, that request can subsequently be retrieved via this endpoint, and the request that is fetched will contain the updated state, such as percent complete, the current state of the request, and any failures. Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getUpdateRequest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The ID of the Update Request", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlowUpdateRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Only the user that submitted the request can get it" : [ ] - } ] - }, - "delete" : { - "tags" : [ "versions" ], - "summary" : "Deletes the Update Request with the given ID", - "description" : "Deletes the Update Request with the given ID. After a request is created via a POST to /versions/update-requests/process-groups/{id}, it is expected that the client will properly clean up the request by DELETE'ing it, once the Update process has completed. If the request is deleted before the request completes, then the Update request will finish the step that it is currently performing and then will cancel any subsequent steps. Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "deleteUpdateRequest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The ID of the Update Request", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlowUpdateRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Only the user that submitted the request can remove it" : [ ] - } ] - } - } - }, - "definitions" : { - "AboutDTO" : { - "type" : "object", - "properties" : { - "title" : { - "type" : "string", - "description" : "The title to be used on the page and in the about dialog." - }, - "version" : { - "type" : "string", - "description" : "The version of this NiFi." - }, - "uri" : { - "type" : "string", - "description" : "The URI for the NiFi." - }, - "contentViewerUrl" : { - "type" : "string", - "description" : "The URL for the content viewer if configured." - }, - "timezone" : { - "type" : "string", - "description" : "The timezone of the NiFi instance.", - "readOnly" : true - }, - "buildTag" : { - "type" : "string", - "description" : "Build tag" - }, - "buildRevision" : { - "type" : "string", - "description" : "Build revision or commit hash" - }, - "buildBranch" : { - "type" : "string", - "description" : "Build branch" - }, - "buildTimestamp" : { - "type" : "string", - "description" : "Build timestamp" - } - } - }, - "AboutEntity" : { - "type" : "object", - "properties" : { - "about" : { - "$ref" : "#/definitions/AboutDTO" - } - }, - "xml" : { - "name" : "aboutEntity" - } - }, - "AccessConfigurationDTO" : { - "type" : "object", - "properties" : { - "supportsLogin" : { - "type" : "boolean", - "description" : "Indicates whether or not this NiFi supports user login.", - "readOnly" : true - } - } - }, - "AccessConfigurationEntity" : { - "type" : "object", - "properties" : { - "config" : { - "$ref" : "#/definitions/AccessConfigurationDTO" - } - }, - "xml" : { - "name" : "accessConfigurationEntity" - } - }, - "AccessPolicyDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "versionedComponentId" : { - "type" : "string", - "description" : "The ID of the corresponding component that is under version control" - }, - "parentGroupId" : { - "type" : "string", - "description" : "The id of parent process group of this component if applicable." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "resource" : { - "type" : "string", - "description" : "The resource for this access policy." - }, - "action" : { - "type" : "string", - "description" : "The action associated with this access policy.", - "enum" : [ "read", "write" ] - }, - "componentReference" : { - "description" : "Component this policy references if applicable.", - "$ref" : "#/definitions/ComponentReferenceEntity" - }, - "configurable" : { - "type" : "boolean", - "description" : "Whether this policy is configurable." - }, - "users" : { - "type" : "array", - "description" : "The set of user IDs associated with this access policy.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/TenantEntity" - } - }, - "userGroups" : { - "type" : "array", - "description" : "The set of user group IDs associated with this access policy.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/TenantEntity" - } - } - } - }, - "AccessPolicyEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "generated" : { - "type" : "string", - "description" : "When this content was generated." - }, - "component" : { - "$ref" : "#/definitions/AccessPolicyDTO" - } - }, - "xml" : { - "name" : "accessPolicyEntity" - } - }, - "AccessPolicySummaryDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "versionedComponentId" : { - "type" : "string", - "description" : "The ID of the corresponding component that is under version control" - }, - "parentGroupId" : { - "type" : "string", - "description" : "The id of parent process group of this component if applicable." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "resource" : { - "type" : "string", - "description" : "The resource for this access policy." - }, - "action" : { - "type" : "string", - "description" : "The action associated with this access policy.", - "enum" : [ "read", "write" ] - }, - "componentReference" : { - "description" : "Component this policy references if applicable.", - "$ref" : "#/definitions/ComponentReferenceEntity" - }, - "configurable" : { - "type" : "boolean", - "description" : "Whether this policy is configurable." - } - } - }, - "AccessPolicySummaryEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "component" : { - "$ref" : "#/definitions/AccessPolicySummaryDTO" - } - }, - "xml" : { - "name" : "accessPolicySummaryEntity" - } - }, - "AccessStatusDTO" : { - "type" : "object", - "properties" : { - "identity" : { - "type" : "string", - "description" : "The user identity.", - "readOnly" : true - }, - "status" : { - "type" : "string", - "description" : "The user access status.", - "readOnly" : true - }, - "message" : { - "type" : "string", - "description" : "Additional details about the user access status.", - "readOnly" : true - } - }, - "xml" : { - "name" : "accessStatus" - } - }, - "AccessStatusEntity" : { - "type" : "object", - "properties" : { - "accessStatus" : { - "$ref" : "#/definitions/AccessStatusDTO" - } - }, - "xml" : { - "name" : "accessStatusEntity" - } - }, - "ActionDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "integer", - "format" : "int32", - "description" : "The action id." - }, - "userIdentity" : { - "type" : "string", - "description" : "The identity of the user that performed the action." - }, - "timestamp" : { - "type" : "string", - "description" : "The timestamp of the action." - }, - "sourceId" : { - "type" : "string", - "description" : "The id of the source component." - }, - "sourceName" : { - "type" : "string", - "description" : "The name of the source component." - }, - "sourceType" : { - "type" : "string", - "description" : "The type of the source component." - }, - "componentDetails" : { - "description" : "The details of the source component.", - "$ref" : "#/definitions/ComponentDetailsDTO" - }, - "operation" : { - "type" : "string", - "description" : "The operation that was performed." - }, - "actionDetails" : { - "description" : "The details of the action.", - "$ref" : "#/definitions/ActionDetailsDTO" - } - } - }, - "ActionDetailsDTO" : { - "type" : "object" - }, - "ActionEntity" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "integer", - "format" : "int32" - }, - "timestamp" : { - "type" : "string", - "description" : "The timestamp of the action." - }, - "sourceId" : { - "type" : "string" - }, - "canRead" : { - "type" : "boolean", - "description" : "Indicates whether the user can read a given resource.", - "readOnly" : true - }, - "action" : { - "$ref" : "#/definitions/ActionDTO" - } - }, - "xml" : { - "name" : "actionEntity" - } - }, - "ActivateControllerServicesEntity" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the ProcessGroup" - }, - "state" : { - "type" : "string", - "description" : "The desired state of the descendant components", - "enum" : [ "ENABLED", "DISABLED" ] - }, - "components" : { - "type" : "object", - "description" : "Optional services to schedule. If not specified, all authorized descendant controller services will be used.", - "additionalProperties" : { - "$ref" : "#/definitions/RevisionDTO" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - } - }, - "xml" : { - "name" : "activateControllerServicesEntity" - } - }, - "AffectedComponentDTO" : { - "type" : "object", - "properties" : { - "processGroupId" : { - "type" : "string", - "description" : "The UUID of the Process Group that this component is in" - }, - "id" : { - "type" : "string", - "description" : "The UUID of this component" - }, - "referenceType" : { - "type" : "string", - "description" : "The type of this component", - "enum" : [ "PROCESSOR", "CONTROLLER_SERVICE", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT" ] - }, - "name" : { - "type" : "string", - "description" : "The name of this component." - }, - "state" : { - "type" : "string", - "description" : "The scheduled state of a processor or reporting task referencing a controller service. If this component is another controller service, this field represents the controller service state." - }, - "activeThreadCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of active threads for the referencing component." - }, - "validationErrors" : { - "type" : "array", - "description" : "The validation errors for the component.", - "items" : { - "type" : "string" - } - } - } - }, - "AffectedComponentEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "component" : { - "$ref" : "#/definitions/AffectedComponentDTO" - }, - "processGroup" : { - "description" : "The Process Group that the component belongs to", - "$ref" : "#/definitions/ProcessGroupNameDTO" - }, - "referenceType" : { - "type" : "string", - "description" : "The type of component referenced", - "enum" : [ "PROCESSOR", "CONTROLLER_SERVICE", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT" ] - } - }, - "xml" : { - "name" : "affectedComponentEntity" - } - }, - "AllowableValueDTO" : { - "type" : "object", - "properties" : { - "displayName" : { - "type" : "string", - "description" : "A human readable value that is allowed for the property descriptor." - }, - "value" : { - "type" : "string", - "description" : "A value that is allowed for the property descriptor." - }, - "description" : { - "type" : "string", - "description" : "A description for this allowable value." - } - } - }, - "AllowableValueEntity" : { - "type" : "object", - "properties" : { - "allowableValue" : { - "$ref" : "#/definitions/AllowableValueDTO" - }, - "canRead" : { - "type" : "boolean", - "description" : "Indicates whether the user can read a given resource.", - "readOnly" : true - } - }, - "xml" : { - "name" : "entity" - } - }, - "AttributeDTO" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The attribute name." - }, - "value" : { - "type" : "string", - "description" : "The attribute value." - }, - "previousValue" : { - "type" : "string", - "description" : "The value of the attribute before the event took place." - } - } - }, - "BannerDTO" : { - "type" : "object", - "properties" : { - "headerText" : { - "type" : "string", - "description" : "The header text." - }, - "footerText" : { - "type" : "string", - "description" : "The footer text." - } - } - }, - "BannerEntity" : { - "type" : "object", - "properties" : { - "banners" : { - "$ref" : "#/definitions/BannerDTO" - } - }, - "xml" : { - "name" : "bannersEntity" - } - }, - "BatchSettingsDTO" : { - "type" : "object", - "properties" : { - "count" : { - "type" : "integer", - "format" : "int32", - "description" : "Preferred number of flow files to include in a transaction." - }, - "size" : { - "type" : "string", - "description" : "Preferred number of bytes to include in a transaction." - }, - "duration" : { - "type" : "string", - "description" : "Preferred amount of time that a transaction should span." - } - } - }, - "BatchSize" : { - "type" : "object", - "properties" : { - "count" : { - "type" : "integer", - "format" : "int32", - "description" : "Preferred number of flow files to include in a transaction." - }, - "size" : { - "type" : "string", - "description" : "Preferred number of bytes to include in a transaction." - }, - "duration" : { - "type" : "string", - "description" : "Preferred amount of time that a transaction should span." - } - } - }, - "Bucket" : { - "type" : "object", - "required" : [ "name" ], - "properties" : { - "link" : { - "description" : "An WebLink to this entity.", - "readOnly" : true, - "$ref" : "#/definitions/JaxbLink" - }, - "identifier" : { - "type" : "string", - "description" : "An ID to uniquely identify this object.", - "readOnly" : true - }, - "name" : { - "type" : "string", - "description" : "The name of the bucket." - }, - "createdTimestamp" : { - "type" : "integer", - "format" : "int64", - "description" : "The timestamp of when the bucket was first created. This is set by the server at creation time.", - "readOnly" : true, - "minimum" : 1 - }, - "description" : { - "type" : "string", - "description" : "A description of the bucket." - }, - "allowBundleRedeploy" : { - "type" : "boolean", - "description" : "Indicates if this bucket allows the same version of an extension bundle to be redeployed and thus overwrite the existing artifact. By default this is false." - }, - "allowPublicRead" : { - "type" : "boolean", - "description" : "Indicates if this bucket allows read access to unauthenticated anonymous users" - }, - "permissions" : { - "description" : "The access that the current user has to this bucket.", - "readOnly" : true, - "$ref" : "#/definitions/Permissions" - } - } - }, - "BucketDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The bucket identifier" - }, - "name" : { - "type" : "string", - "description" : "The bucket name" - }, - "description" : { - "type" : "string", - "description" : "The bucket description" - }, - "created" : { - "type" : "integer", - "format" : "int64", - "description" : "The created timestamp of this bucket" - } - } - }, - "BucketEntity" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string" - }, - "bucket" : { - "$ref" : "#/definitions/BucketDTO" - }, - "permissions" : { - "$ref" : "#/definitions/PermissionsDTO" - } - }, - "xml" : { - "name" : "bucketEntity" - } - }, - "BucketsEntity" : { - "type" : "object", - "properties" : { - "buckets" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/BucketEntity" - } - } - }, - "xml" : { - "name" : "bucketsEntity" - } - }, - "BulletinBoardDTO" : { - "type" : "object", - "properties" : { - "bulletins" : { - "type" : "array", - "description" : "The bulletins in the bulletin board, that matches the supplied request.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "generated" : { - "type" : "string", - "description" : "The timestamp when this report was generated." - } - } - }, - "BulletinBoardEntity" : { - "type" : "object", - "properties" : { - "bulletinBoard" : { - "$ref" : "#/definitions/BulletinBoardDTO" - } - }, - "xml" : { - "name" : "bulletinBoardEntity" - } - }, - "BulletinDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "integer", - "format" : "int64", - "description" : "The id of the bulletin." - }, - "nodeAddress" : { - "type" : "string", - "description" : "If clustered, the address of the node from which the bulletin originated." - }, - "category" : { - "type" : "string", - "description" : "The category of this bulletin." - }, - "groupId" : { - "type" : "string", - "description" : "The group id of the source component." - }, - "sourceId" : { - "type" : "string", - "description" : "The id of the source component." - }, - "sourceName" : { - "type" : "string", - "description" : "The name of the source component." - }, - "level" : { - "type" : "string", - "description" : "The level of the bulletin." - }, - "message" : { - "type" : "string", - "description" : "The bulletin message." - }, - "timestamp" : { - "type" : "string", - "description" : "When this bulletin was generated." - } - } - }, - "BulletinEntity" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "integer", - "format" : "int64" - }, - "groupId" : { - "type" : "string" - }, - "sourceId" : { - "type" : "string" - }, - "timestamp" : { - "type" : "string", - "description" : "When this bulletin was generated." - }, - "nodeAddress" : { - "type" : "string" - }, - "canRead" : { - "type" : "boolean", - "description" : "Indicates whether the user can read a given resource.", - "readOnly" : true - }, - "bulletin" : { - "$ref" : "#/definitions/BulletinDTO" - } - }, - "xml" : { - "name" : "bulletinEntity" - } - }, - "Bundle" : { - "type" : "object", - "properties" : { - "group" : { - "type" : "string", - "description" : "The group of the bundle" - }, - "artifact" : { - "type" : "string", - "description" : "The artifact of the bundle" - }, - "version" : { - "type" : "string", - "description" : "The version of the bundle" - } - } - }, - "BundleDTO" : { - "type" : "object", - "properties" : { - "group" : { - "type" : "string", - "description" : "The group of the bundle." - }, - "artifact" : { - "type" : "string", - "description" : "The artifact of the bundle." - }, - "version" : { - "type" : "string", - "description" : "The version of the bundle." - } - } - }, - "ClusteSummaryEntity" : { - "type" : "object", - "properties" : { - "clusterSummary" : { - "$ref" : "#/definitions/ClusterSummaryDTO" - } - }, - "xml" : { - "name" : "clusterSummaryEntity" - } - }, - "ClusterDTO" : { - "type" : "object", - "properties" : { - "nodes" : { - "type" : "array", - "description" : "The collection of nodes that are part of the cluster.", - "items" : { - "$ref" : "#/definitions/NodeDTO" - } - }, - "generated" : { - "type" : "string", - "description" : "The timestamp the report was generated." - } - } - }, - "ClusterEntity" : { - "type" : "object", - "properties" : { - "cluster" : { - "$ref" : "#/definitions/ClusterDTO" - } - }, - "xml" : { - "name" : "clusterEntity" - } - }, - "ClusterSearchResultsEntity" : { - "type" : "object", - "properties" : { - "nodeResults" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/NodeSearchResultDTO" - } - } - }, - "xml" : { - "name" : "clusterSearchResultsEntity" - } - }, - "ClusterSummaryDTO" : { - "type" : "object", - "properties" : { - "connectedNodes" : { - "type" : "string", - "description" : "When clustered, reports the number of nodes connected vs the number of nodes in the cluster." - }, - "connectedNodeCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of nodes that are currently connected to the cluster" - }, - "totalNodeCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of nodes in the cluster, regardless of whether or not they are connected" - }, - "clustered" : { - "type" : "boolean", - "description" : "Whether this NiFi instance is clustered." - }, - "connectedToCluster" : { - "type" : "boolean", - "description" : "Whether this NiFi instance is connected to a cluster." - } - } - }, - "ComponentDetailsDTO" : { - "type" : "object" - }, - "ComponentDifferenceDTO" : { - "type" : "object", - "properties" : { - "componentType" : { - "type" : "string", - "description" : "The type of component" - }, - "componentId" : { - "type" : "string", - "description" : "The ID of the component" - }, - "componentName" : { - "type" : "string", - "description" : "The name of the component" - }, - "processGroupId" : { - "type" : "string", - "description" : "The ID of the Process Group that the component belongs to" - }, - "differences" : { - "type" : "array", - "description" : "The differences in the component between the two flows", - "items" : { - "$ref" : "#/definitions/DifferenceDTO" - } - } - } - }, - "ComponentHistoryDTO" : { - "type" : "object", - "properties" : { - "componentId" : { - "type" : "string", - "description" : "The component id." - }, - "propertyHistory" : { - "type" : "object", - "description" : "The history for the properties of the component.", - "additionalProperties" : { - "$ref" : "#/definitions/PropertyHistoryDTO" - } - } - } - }, - "ComponentHistoryEntity" : { - "type" : "object", - "properties" : { - "componentHistory" : { - "$ref" : "#/definitions/ComponentHistoryDTO" - } - }, - "xml" : { - "name" : "componentHistoryEntity" - } - }, - "ComponentReferenceDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "versionedComponentId" : { - "type" : "string", - "description" : "The ID of the corresponding component that is under version control" - }, - "parentGroupId" : { - "type" : "string", - "description" : "The id of parent process group of this component if applicable." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "name" : { - "type" : "string", - "description" : "The name of the component." - } - } - }, - "ComponentReferenceEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "parentGroupId" : { - "type" : "string", - "description" : "The id of parent process group of this component if applicable." - }, - "component" : { - "$ref" : "#/definitions/ComponentReferenceDTO" - } - }, - "xml" : { - "name" : "componentReferenceEntity" - } - }, - "ComponentRestrictionPermissionDTO" : { - "type" : "object", - "properties" : { - "requiredPermission" : { - "description" : "The required permission necessary for this restriction.", - "$ref" : "#/definitions/RequiredPermissionDTO" - }, - "permissions" : { - "description" : "The permissions for this component restriction. Note: the read permission are not used and will always be false.", - "$ref" : "#/definitions/PermissionsDTO" - } - } - }, - "ComponentSearchResultDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component that matched the search." - }, - "groupId" : { - "type" : "string", - "description" : "The group id of the component that matched the search." - }, - "parentGroup" : { - "description" : "The parent group of the component that matched the search.", - "$ref" : "#/definitions/SearchResultGroupDTO" - }, - "versionedGroup" : { - "description" : "The nearest versioned ancestor group of the component that matched the search.", - "$ref" : "#/definitions/SearchResultGroupDTO" - }, - "name" : { - "type" : "string", - "description" : "The name of the component that matched the search." - }, - "matches" : { - "type" : "array", - "description" : "What matched the search from the component.", - "items" : { - "type" : "string" - } - } - } - }, - "ComponentStateDTO" : { - "type" : "object", - "properties" : { - "componentId" : { - "type" : "string", - "description" : "The component identifier." - }, - "stateDescription" : { - "type" : "string", - "description" : "Description of the state this component persists." - }, - "clusterState" : { - "description" : "The cluster state for this component, or null if this NiFi is a standalone instance.", - "$ref" : "#/definitions/StateMapDTO" - }, - "localState" : { - "description" : "The local state for this component.", - "$ref" : "#/definitions/StateMapDTO" - } - } - }, - "ComponentStateEntity" : { - "type" : "object", - "properties" : { - "componentState" : { - "description" : "The component state.", - "$ref" : "#/definitions/ComponentStateDTO" - } - }, - "xml" : { - "name" : "componentStateEntity" - } - }, - "ComponentValidationResultDTO" : { - "type" : "object", - "properties" : { - "processGroupId" : { - "type" : "string", - "description" : "The UUID of the Process Group that this component is in" - }, - "id" : { - "type" : "string", - "description" : "The UUID of this component" - }, - "referenceType" : { - "type" : "string", - "description" : "The type of this component", - "enum" : [ "PROCESSOR", "CONTROLLER_SERVICE", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT" ] - }, - "name" : { - "type" : "string", - "description" : "The name of this component." - }, - "state" : { - "type" : "string", - "description" : "The scheduled state of a processor or reporting task referencing a controller service. If this component is another controller service, this field represents the controller service state." - }, - "activeThreadCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of active threads for the referencing component." - }, - "validationErrors" : { - "type" : "array", - "description" : "The validation errors for the component.", - "items" : { - "type" : "string" - } - }, - "currentlyValid" : { - "type" : "boolean", - "description" : "Whether or not the component is currently valid" - }, - "resultsValid" : { - "type" : "boolean", - "description" : "Whether or not the component will be valid if the Parameter Context is changed" - }, - "resultantValidationErrors" : { - "type" : "array", - "description" : "The validation errors that will apply to the component if the Parameter Context is changed", - "items" : { - "type" : "string" - } - } - } - }, - "ComponentValidationResultEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "component" : { - "$ref" : "#/definitions/ComponentValidationResultDTO" - } - }, - "xml" : { - "name" : "componentValidationResultEntity" - } - }, - "ComponentValidationResultsEntity" : { - "type" : "object", - "properties" : { - "validationResults" : { - "type" : "array", - "description" : "A List of ComponentValidationResultEntity, one for each component that is validated", - "items" : { - "$ref" : "#/definitions/ComponentValidationResultEntity" - } - } - }, - "xml" : { - "name" : "componentValidationResults" - } - }, - "ConnectableComponent" : { - "type" : "object", - "required" : [ "groupId", "id", "type" ], - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the connectable component." - }, - "type" : { - "type" : "string", - "description" : "The type of component the connectable is.", - "enum" : [ "PROCESSOR", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "INPUT_PORT", "OUTPUT_PORT", "FUNNEL" ] - }, - "groupId" : { - "type" : "string", - "description" : "The id of the group that the connectable component resides in" - }, - "name" : { - "type" : "string", - "description" : "The name of the connectable component" - }, - "comments" : { - "type" : "string", - "description" : "The comments for the connectable component." - } - } - }, - "ConnectableDTO" : { - "type" : "object", - "required" : [ "groupId", "id", "type" ], - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the connectable component." - }, - "versionedComponentId" : { - "type" : "string", - "description" : "The ID of the corresponding component that is under version control" - }, - "type" : { - "type" : "string", - "description" : "The type of component the connectable is.", - "enum" : [ "PROCESSOR", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "INPUT_PORT", "OUTPUT_PORT", "FUNNEL" ] - }, - "groupId" : { - "type" : "string", - "description" : "The id of the group that the connectable component resides in" - }, - "name" : { - "type" : "string", - "description" : "The name of the connectable component" - }, - "running" : { - "type" : "boolean", - "description" : "Reflects the current state of the connectable component." - }, - "transmitting" : { - "type" : "boolean", - "description" : "If the connectable component represents a remote port, indicates if the target is configured to transmit." - }, - "exists" : { - "type" : "boolean", - "description" : "If the connectable component represents a remote port, indicates if the target exists." - }, - "comments" : { - "type" : "string", - "description" : "The comments for the connectable component." - } - } - }, - "ConnectionDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "versionedComponentId" : { - "type" : "string", - "description" : "The ID of the corresponding component that is under version control" - }, - "parentGroupId" : { - "type" : "string", - "description" : "The id of parent process group of this component if applicable." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "source" : { - "description" : "The source of the connection.", - "$ref" : "#/definitions/ConnectableDTO" - }, - "destination" : { - "description" : "The destination of the connection.", - "$ref" : "#/definitions/ConnectableDTO" - }, - "name" : { - "type" : "string", - "description" : "The name of the connection." - }, - "labelIndex" : { - "type" : "integer", - "format" : "int32", - "description" : "The index of the bend point where to place the connection label." - }, - "getzIndex" : { - "type" : "integer", - "format" : "int64", - "description" : "The z index of the connection." - }, - "selectedRelationships" : { - "type" : "array", - "description" : "The selected relationship that comprise the connection.", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - }, - "availableRelationships" : { - "type" : "array", - "description" : "The relationships that the source of the connection currently supports.", - "readOnly" : true, - "uniqueItems" : true, - "items" : { - "type" : "string" - } - }, - "backPressureObjectThreshold" : { - "type" : "integer", - "format" : "int64", - "description" : "The object count threshold for determining when back pressure is applied. Updating this value is a passive change in the sense that it won't impact whether existing files over the limit are affected but it does help feeder processors to stop pushing too much into this work queue." - }, - "backPressureDataSizeThreshold" : { - "type" : "string", - "description" : "The object data size threshold for determining when back pressure is applied. Updating this value is a passive change in the sense that it won't impact whether existing files over the limit are affected but it does help feeder processors to stop pushing too much into this work queue." - }, - "flowFileExpiration" : { - "type" : "string", - "description" : "The amount of time a flow file may be in the flow before it will be automatically aged out of the flow. Once a flow file reaches this age it will be terminated from the flow the next time a processor attempts to start work on it." - }, - "prioritizers" : { - "type" : "array", - "description" : "The comparators used to prioritize the queue.", - "items" : { - "type" : "string" - } - }, - "bends" : { - "type" : "array", - "description" : "The bend points on the connection.", - "items" : { - "$ref" : "#/definitions/PositionDTO" - } - }, - "loadBalanceStrategy" : { - "type" : "string", - "description" : "How to load balance the data in this Connection across the nodes in the cluster.", - "enum" : [ "DO_NOT_LOAD_BALANCE", "PARTITION_BY_ATTRIBUTE", "ROUND_ROBIN", "SINGLE_NODE" ] - }, - "loadBalancePartitionAttribute" : { - "type" : "string", - "description" : "The FlowFile Attribute to use for determining which node a FlowFile will go to if the Load Balancing Strategy is set to PARTITION_BY_ATTRIBUTE" - }, - "loadBalanceCompression" : { - "type" : "string", - "description" : "Whether or not data should be compressed when being transferred between nodes in the cluster.", - "enum" : [ "DO_NOT_COMPRESS", "COMPRESS_ATTRIBUTES_ONLY", "COMPRESS_ATTRIBUTES_AND_CONTENT" ] - }, - "loadBalanceStatus" : { - "type" : "string", - "description" : "The current status of the Connection's Load Balancing Activities. Status can indicate that Load Balancing is not configured for the connection, that Load Balancing is configured but inactive (not currently transferring data to another node), or that Load Balancing is configured and actively transferring data to another node.", - "readOnly" : true, - "enum" : [ "LOAD_BALANCE_NOT_CONFIGURED", "LOAD_BALANCE_INACTIVE", "LOAD_BALANCE_ACTIVE" ] - } - } - }, - "ConnectionEntity" : { - "type" : "object", - "required" : [ "destinationType", "sourceType" ], - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "component" : { - "$ref" : "#/definitions/ConnectionDTO" - }, - "status" : { - "description" : "The status of the connection.", - "$ref" : "#/definitions/ConnectionStatusDTO" - }, - "bends" : { - "type" : "array", - "description" : "The bend points on the connection.", - "items" : { - "$ref" : "#/definitions/PositionDTO" - } - }, - "labelIndex" : { - "type" : "integer", - "format" : "int32", - "description" : "The index of the bend point where to place the connection label." - }, - "getzIndex" : { - "type" : "integer", - "format" : "int64", - "description" : "The z index of the connection." - }, - "sourceId" : { - "type" : "string", - "description" : "The identifier of the source of this connection." - }, - "sourceGroupId" : { - "type" : "string", - "description" : "The identifier of the group of the source of this connection." - }, - "sourceType" : { - "type" : "string", - "description" : "The type of component the source connectable is.", - "enum" : [ "PROCESSOR", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "INPUT_PORT", "OUTPUT_PORT", "FUNNEL" ] - }, - "destinationId" : { - "type" : "string", - "description" : "The identifier of the destination of this connection." - }, - "destinationGroupId" : { - "type" : "string", - "description" : "The identifier of the group of the destination of this connection." - }, - "destinationType" : { - "type" : "string", - "description" : "The type of component the destination connectable is.", - "enum" : [ "PROCESSOR", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "INPUT_PORT", "OUTPUT_PORT", "FUNNEL" ] - } - }, - "xml" : { - "name" : "connectionEntity" - } - }, - "ConnectionStatisticsDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The ID of the connection" - }, - "statsLastRefreshed" : { - "type" : "string", - "description" : "The timestamp of when the stats were last refreshed" - }, - "aggregateSnapshot" : { - "description" : "The status snapshot that represents the aggregate stats of the cluster", - "$ref" : "#/definitions/ConnectionStatisticsSnapshotDTO" - }, - "nodeSnapshots" : { - "type" : "array", - "description" : "A list of status snapshots for each node", - "items" : { - "$ref" : "#/definitions/NodeConnectionStatisticsSnapshotDTO" - } - } - } - }, - "ConnectionStatisticsEntity" : { - "type" : "object", - "properties" : { - "connectionStatistics" : { - "$ref" : "#/definitions/ConnectionStatisticsDTO" - }, - "canRead" : { - "type" : "boolean", - "description" : "Indicates whether the user can read a given resource.", - "readOnly" : true - } - }, - "xml" : { - "name" : "connectionStatisticsEntity" - } - }, - "ConnectionStatisticsSnapshotDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the connection." - }, - "predictedMillisUntilCountBackpressure" : { - "type" : "integer", - "format" : "int64", - "description" : "The predicted number of milliseconds before the connection will have backpressure applied, based on the queued count." - }, - "predictedMillisUntilBytesBackpressure" : { - "type" : "integer", - "format" : "int64", - "description" : "The predicted number of milliseconds before the connection will have backpressure applied, based on the total number of bytes in the queue." - }, - "predictedCountAtNextInterval" : { - "type" : "integer", - "format" : "int32", - "description" : "The predicted number of queued objects at the next configured interval." - }, - "predictedBytesAtNextInterval" : { - "type" : "integer", - "format" : "int64", - "description" : "The predicted total number of bytes in the queue at the next configured interval." - }, - "predictedPercentCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The predicted percentage of queued objects at the next configured interval." - }, - "predictedPercentBytes" : { - "type" : "integer", - "format" : "int32", - "description" : "The predicted percentage of bytes in the queue against current threshold at the next configured interval." - }, - "predictionIntervalMillis" : { - "type" : "integer", - "format" : "int64", - "description" : "The prediction interval in seconds" - } - } - }, - "ConnectionStatusDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The ID of the connection" - }, - "groupId" : { - "type" : "string", - "description" : "The ID of the Process Group that the connection belongs to" - }, - "name" : { - "type" : "string", - "description" : "The name of the connection" - }, - "statsLastRefreshed" : { - "type" : "string", - "description" : "The timestamp of when the stats were last refreshed" - }, - "sourceId" : { - "type" : "string", - "description" : "The ID of the source component" - }, - "sourceName" : { - "type" : "string", - "description" : "The name of the source component" - }, - "destinationId" : { - "type" : "string", - "description" : "The ID of the destination component" - }, - "destinationName" : { - "type" : "string", - "description" : "The name of the destination component" - }, - "aggregateSnapshot" : { - "description" : "The status snapshot that represents the aggregate stats of the cluster", - "$ref" : "#/definitions/ConnectionStatusSnapshotDTO" - }, - "nodeSnapshots" : { - "type" : "array", - "description" : "A list of status snapshots for each node", - "items" : { - "$ref" : "#/definitions/NodeConnectionStatusSnapshotDTO" - } - } - } - }, - "ConnectionStatusEntity" : { - "type" : "object", - "properties" : { - "connectionStatus" : { - "$ref" : "#/definitions/ConnectionStatusDTO" - }, - "canRead" : { - "type" : "boolean", - "description" : "Indicates whether the user can read a given resource.", - "readOnly" : true - } - }, - "xml" : { - "name" : "connectionStatusEntity" - } - }, - "ConnectionStatusPredictionsSnapshotDTO" : { - "type" : "object", - "properties" : { - "predictedMillisUntilCountBackpressure" : { - "type" : "integer", - "format" : "int64", - "description" : "The predicted number of milliseconds before the connection will have backpressure applied, based on the queued count." - }, - "predictedMillisUntilBytesBackpressure" : { - "type" : "integer", - "format" : "int64", - "description" : "The predicted number of milliseconds before the connection will have backpressure applied, based on the total number of bytes in the queue." - }, - "predictionIntervalSeconds" : { - "type" : "integer", - "format" : "int32", - "description" : "The configured interval (in seconds) for predicting connection queue count and size (and percent usage)." - }, - "predictedCountAtNextInterval" : { - "type" : "integer", - "format" : "int32", - "description" : "The predicted number of queued objects at the next configured interval." - }, - "predictedBytesAtNextInterval" : { - "type" : "integer", - "format" : "int64", - "description" : "The predicted total number of bytes in the queue at the next configured interval." - }, - "predictedPercentCount" : { - "type" : "integer", - "format" : "int32", - "description" : "Predicted connection percent use regarding queued flow files count and backpressure threshold if configured." - }, - "predictedPercentBytes" : { - "type" : "integer", - "format" : "int32", - "description" : "Predicted connection percent use regarding queued flow files size and backpressure threshold if configured." - } - } - }, - "ConnectionStatusSnapshotDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the connection." - }, - "groupId" : { - "type" : "string", - "description" : "The id of the process group the connection belongs to." - }, - "name" : { - "type" : "string", - "description" : "The name of the connection." - }, - "sourceId" : { - "type" : "string", - "description" : "The id of the source of the connection." - }, - "sourceName" : { - "type" : "string", - "description" : "The name of the source of the connection." - }, - "destinationId" : { - "type" : "string", - "description" : "The id of the destination of the connection." - }, - "destinationName" : { - "type" : "string", - "description" : "The name of the destination of the connection." - }, - "predictions" : { - "description" : "Predictions, if available, for this connection (null if not available)", - "$ref" : "#/definitions/ConnectionStatusPredictionsSnapshotDTO" - }, - "flowFilesIn" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of FlowFiles that have come into the connection in the last 5 minutes." - }, - "bytesIn" : { - "type" : "integer", - "format" : "int64", - "description" : "The size of the FlowFiles that have come into the connection in the last 5 minutes." - }, - "input" : { - "type" : "string", - "description" : "The input count/size for the connection in the last 5 minutes, pretty printed." - }, - "flowFilesOut" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of FlowFiles that have left the connection in the last 5 minutes." - }, - "bytesOut" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes that have left the connection in the last 5 minutes." - }, - "output" : { - "type" : "string", - "description" : "The output count/sie for the connection in the last 5 minutes, pretty printed." - }, - "flowFilesQueued" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of FlowFiles that are currently queued in the connection." - }, - "bytesQueued" : { - "type" : "integer", - "format" : "int64", - "description" : "The size of the FlowFiles that are currently queued in the connection." - }, - "queued" : { - "type" : "string", - "description" : "The total count and size of queued flowfiles formatted." - }, - "queuedSize" : { - "type" : "string", - "description" : "The total size of flowfiles that are queued formatted." - }, - "queuedCount" : { - "type" : "string", - "description" : "The number of flowfiles that are queued, pretty printed." - }, - "percentUseCount" : { - "type" : "integer", - "format" : "int32", - "description" : "Connection percent use regarding queued flow files count and backpressure threshold if configured." - }, - "percentUseBytes" : { - "type" : "integer", - "format" : "int32", - "description" : "Connection percent use regarding queued flow files size and backpressure threshold if configured." - } - } - }, - "ConnectionStatusSnapshotEntity" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the connection." - }, - "connectionStatusSnapshot" : { - "$ref" : "#/definitions/ConnectionStatusSnapshotDTO" - }, - "canRead" : { - "type" : "boolean", - "description" : "Indicates whether the user can read a given resource.", - "readOnly" : true - } - }, - "xml" : { - "name" : "entity" - } - }, - "ConnectionsEntity" : { - "type" : "object", - "properties" : { - "connections" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ConnectionEntity" - } - } - }, - "xml" : { - "name" : "connectionsEntity" - } - }, - "ControllerBulletinsEntity" : { - "type" : "object", - "properties" : { - "bulletins" : { - "type" : "array", - "description" : "System level bulletins to be reported to the user.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "controllerServiceBulletins" : { - "type" : "array", - "description" : "Controller service bulletins to be reported to the user.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "reportingTaskBulletins" : { - "type" : "array", - "description" : "Reporting task bulletins to be reported to the user.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - } - }, - "xml" : { - "name" : "controllerConfigurationEntity" - } - }, - "ControllerConfigurationDTO" : { - "type" : "object", - "properties" : { - "maxTimerDrivenThreadCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The maximum number of timer driven threads the NiFi has available." - }, - "maxEventDrivenThreadCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The maximum number of event driven threads the NiFi has available." - } - } - }, - "ControllerConfigurationEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "component" : { - "description" : "The controller configuration.", - "$ref" : "#/definitions/ControllerConfigurationDTO" - } - }, - "xml" : { - "name" : "controllerConfigurationEntity" - } - }, - "ControllerDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the NiFi." - }, - "name" : { - "type" : "string", - "description" : "The name of the NiFi." - }, - "comments" : { - "type" : "string", - "description" : "The comments for the NiFi." - }, - "runningCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of running components in the NiFi." - }, - "stoppedCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of stopped components in the NiFi." - }, - "invalidCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of invalid components in the NiFi." - }, - "disabledCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of disabled components in the NiFi." - }, - "activeRemotePortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of active remote ports contained in the NiFi." - }, - "inactiveRemotePortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of inactive remote ports contained in the NiFi." - }, - "inputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of input ports contained in the NiFi." - }, - "outputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of output ports in the NiFi." - }, - "remoteSiteListeningPort" : { - "type" : "integer", - "format" : "int32", - "description" : "The Socket Port on which this instance is listening for Remote Transfers of Flow Files. If this instance is not configured to receive Flow Files from remote instances, this will be null." - }, - "remoteSiteHttpListeningPort" : { - "type" : "integer", - "format" : "int32", - "description" : "The HTTP(S) Port on which this instance is listening for Remote Transfers of Flow Files. If this instance is not configured to receive Flow Files from remote instances, this will be null." - }, - "siteToSiteSecure" : { - "type" : "boolean", - "description" : "Indicates whether or not Site-to-Site communications with this instance is secure (2-way authentication)." - }, - "instanceId" : { - "type" : "string", - "description" : "If clustered, the id of the Cluster Manager, otherwise the id of the NiFi." - }, - "inputPorts" : { - "type" : "array", - "description" : "The input ports available to send data to for the NiFi.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/PortDTO" - } - }, - "outputPorts" : { - "type" : "array", - "description" : "The output ports available to received data from the NiFi.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/PortDTO" - } - } - } - }, - "ControllerEntity" : { - "type" : "object", - "properties" : { - "controller" : { - "$ref" : "#/definitions/ControllerDTO" - } - }, - "xml" : { - "name" : "controllerEntity" - } - }, - "ControllerServiceAPI" : { - "type" : "object", - "properties" : { - "type" : { - "type" : "string", - "description" : "The fully qualified name of the service interface." - }, - "bundle" : { - "description" : "The details of the artifact that bundled this service interface.", - "$ref" : "#/definitions/Bundle" - } - } - }, - "ControllerServiceApiDTO" : { - "type" : "object", - "properties" : { - "type" : { - "type" : "string", - "description" : "The fully qualified name of the service interface." - }, - "bundle" : { - "description" : "The details of the artifact that bundled this service interface.", - "$ref" : "#/definitions/BundleDTO" - } - } - }, - "ControllerServiceDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "versionedComponentId" : { - "type" : "string", - "description" : "The ID of the corresponding component that is under version control" - }, - "parentGroupId" : { - "type" : "string", - "description" : "The id of parent process group of this component if applicable." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "name" : { - "type" : "string", - "description" : "The name of the controller service." - }, - "type" : { - "type" : "string", - "description" : "The type of the controller service." - }, - "bundle" : { - "description" : "The details of the artifact that bundled this processor type.", - "$ref" : "#/definitions/BundleDTO" - }, - "controllerServiceApis" : { - "type" : "array", - "description" : "Lists the APIs this Controller Service implements.", - "items" : { - "$ref" : "#/definitions/ControllerServiceApiDTO" - } - }, - "comments" : { - "type" : "string", - "description" : "The comments for the controller service." - }, - "state" : { - "type" : "string", - "description" : "The state of the controller service.", - "enum" : [ "ENABLED", "ENABLING", "DISABLED", "DISABLING" ] - }, - "persistsState" : { - "type" : "boolean", - "description" : "Whether the controller service persists state." - }, - "restricted" : { - "type" : "boolean", - "description" : "Whether the controller service requires elevated privileges." - }, - "deprecated" : { - "type" : "boolean", - "description" : "Whether the ontroller service has been deprecated." - }, - "multipleVersionsAvailable" : { - "type" : "boolean", - "description" : "Whether the controller service has multiple versions available." - }, - "properties" : { - "type" : "object", - "description" : "The properties of the controller service.", - "additionalProperties" : { - "type" : "string" - } - }, - "descriptors" : { - "type" : "object", - "description" : "The descriptors for the controller service properties.", - "additionalProperties" : { - "$ref" : "#/definitions/PropertyDescriptorDTO" - } - }, - "customUiUrl" : { - "type" : "string", - "description" : "The URL for the controller services custom configuration UI if applicable." - }, - "annotationData" : { - "type" : "string", - "description" : "The annotation for the controller service. This is how the custom UI relays configuration to the controller service." - }, - "referencingComponents" : { - "type" : "array", - "description" : "All components referencing this controller service.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ControllerServiceReferencingComponentEntity" - } - }, - "validationErrors" : { - "type" : "array", - "description" : "The validation errors from the controller service. These validation errors represent the problems with the controller service that must be resolved before it can be enabled.", - "items" : { - "type" : "string" - } - }, - "validationStatus" : { - "type" : "string", - "description" : "Indicates whether the ControllerService is valid, invalid, or still in the process of validating (i.e., it is unknown whether or not the ControllerService is valid)", - "readOnly" : true, - "enum" : [ "VALID", "INVALID", "VALIDATING" ] - }, - "extensionMissing" : { - "type" : "boolean", - "description" : "Whether the underlying extension is missing." - } - } - }, - "ControllerServiceEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "parentGroupId" : { - "type" : "string", - "description" : "The id of parent process group of this ControllerService." - }, - "component" : { - "$ref" : "#/definitions/ControllerServiceDTO" - }, - "operatePermissions" : { - "description" : "The permissions for this component operations.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "status" : { - "description" : "The status for this ControllerService.", - "readOnly" : true, - "$ref" : "#/definitions/ControllerServiceStatusDTO" - } - }, - "xml" : { - "name" : "controllerServiceEntity" - } - }, - "ControllerServiceReferencingComponentDTO" : { - "type" : "object", - "properties" : { - "groupId" : { - "type" : "string", - "description" : "The group id for the component referencing a controller service. If this component is another controller service or a reporting task, this field is blank." - }, - "id" : { - "type" : "string", - "description" : "The id of the component referencing a controller service." - }, - "name" : { - "type" : "string", - "description" : "The name of the component referencing a controller service." - }, - "type" : { - "type" : "string", - "description" : "The type of the component referencing a controller service in simple Java class name format without package name." - }, - "state" : { - "type" : "string", - "description" : "The scheduled state of a processor or reporting task referencing a controller service. If this component is another controller service, this field represents the controller service state." - }, - "properties" : { - "type" : "object", - "description" : "The properties for the component.", - "additionalProperties" : { - "type" : "string" - } - }, - "descriptors" : { - "type" : "object", - "description" : "The descriptors for the component properties.", - "additionalProperties" : { - "$ref" : "#/definitions/PropertyDescriptorDTO" - } - }, - "validationErrors" : { - "type" : "array", - "description" : "The validation errors for the component.", - "items" : { - "type" : "string" - } - }, - "referenceType" : { - "type" : "string", - "description" : "The type of reference this is.", - "enum" : [ "Processor", "ControllerService", "ReportingTask" ] - }, - "activeThreadCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of active threads for the referencing component." - }, - "referenceCycle" : { - "type" : "boolean", - "description" : "If the referencing component represents a controller service, this indicates whether it has already been represented in this hierarchy." - }, - "referencingComponents" : { - "type" : "array", - "description" : "If the referencing component represents a controller service, these are the components that reference it.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ControllerServiceReferencingComponentEntity" - } - } - } - }, - "ControllerServiceReferencingComponentEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "component" : { - "$ref" : "#/definitions/ControllerServiceReferencingComponentDTO" - }, - "operatePermissions" : { - "description" : "The permissions for this component operations.", - "$ref" : "#/definitions/PermissionsDTO" - } - }, - "xml" : { - "name" : "controllerServiceReferencingComponentEntity" - } - }, - "ControllerServiceReferencingComponentsEntity" : { - "type" : "object", - "properties" : { - "controllerServiceReferencingComponents" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ControllerServiceReferencingComponentEntity" - } - } - }, - "xml" : { - "name" : "controllerServiceReferencingComponentsEntity" - } - }, - "ControllerServiceRunStatusEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "state" : { - "type" : "string", - "description" : "The run status of the ControllerService.", - "enum" : [ "ENABLED", "DISABLED" ] - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - } - }, - "xml" : { - "name" : "entity" - } - }, - "ControllerServiceStatusDTO" : { - "type" : "object", - "properties" : { - "runStatus" : { - "type" : "string", - "description" : "The run status of this ControllerService", - "readOnly" : true, - "enum" : [ "ENABLED", "ENABLING", "DISABLED", "DISABLING" ] - }, - "validationStatus" : { - "type" : "string", - "description" : "Indicates whether the component is valid, invalid, or still in the process of validating (i.e., it is unknown whether or not the component is valid)", - "readOnly" : true, - "enum" : [ "VALID", "INVALID", "VALIDATING" ] - }, - "activeThreadCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of active threads for the component." - } - } - }, - "ControllerServiceTypesEntity" : { - "type" : "object", - "properties" : { - "controllerServiceTypes" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/DocumentedTypeDTO" - } - } - }, - "xml" : { - "name" : "controllerServiceTypesEntity" - } - }, - "ControllerServicesEntity" : { - "type" : "object", - "properties" : { - "currentTime" : { - "type" : "string", - "description" : "The current time on the system." - }, - "controllerServices" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ControllerServiceEntity" - } - } - }, - "xml" : { - "name" : "controllerServicesEntity" - } - }, - "ControllerStatusDTO" : { - "type" : "object", - "properties" : { - "activeThreadCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of active threads in the NiFi." - }, - "terminatedThreadCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of terminated threads in the NiFi." - }, - "queued" : { - "type" : "string", - "description" : "The number of flowfiles queued in the NiFi." - }, - "flowFilesQueued" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of FlowFiles queued across the entire flow" - }, - "bytesQueued" : { - "type" : "integer", - "format" : "int64", - "description" : "The size of the FlowFiles queued across the entire flow" - }, - "runningCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of running components in the NiFi." - }, - "stoppedCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of stopped components in the NiFi." - }, - "invalidCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of invalid components in the NiFi." - }, - "disabledCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of disabled components in the NiFi." - }, - "activeRemotePortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of active remote ports in the NiFi." - }, - "inactiveRemotePortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of inactive remote ports in the NiFi." - }, - "upToDateCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of up to date versioned process groups in the NiFi." - }, - "locallyModifiedCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of locally modified versioned process groups in the NiFi." - }, - "staleCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of stale versioned process groups in the NiFi." - }, - "locallyModifiedAndStaleCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of locally modified and stale versioned process groups in the NiFi." - }, - "syncFailureCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of versioned process groups in the NiFi that are unable to sync to a registry." - } - } - }, - "ControllerStatusEntity" : { - "type" : "object", - "properties" : { - "controllerStatus" : { - "$ref" : "#/definitions/ControllerStatusDTO" - } - }, - "xml" : { - "name" : "controllerStatusEntity" - } - }, - "CopySnippetRequestEntity" : { - "type" : "object", - "properties" : { - "snippetId" : { - "type" : "string", - "description" : "The identifier of the snippet." - }, - "originX" : { - "type" : "number", - "format" : "double", - "description" : "The x coordinate of the origin of the bounding box where the new components will be placed." - }, - "originY" : { - "type" : "number", - "format" : "double", - "description" : "The y coordinate of the origin of the bounding box where the new components will be placed." - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - } - }, - "xml" : { - "name" : "copySnippetRequestEntity" - } - }, - "CounterDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the counter." - }, - "context" : { - "type" : "string", - "description" : "The context of the counter." - }, - "name" : { - "type" : "string", - "description" : "The name of the counter." - }, - "valueCount" : { - "type" : "integer", - "format" : "int64", - "description" : "The value count." - }, - "value" : { - "type" : "string", - "description" : "The value of the counter." - } - } - }, - "CounterEntity" : { - "type" : "object", - "properties" : { - "counter" : { - "$ref" : "#/definitions/CounterDTO" - } - }, - "xml" : { - "name" : "counterEntity" - } - }, - "CountersDTO" : { - "type" : "object", - "properties" : { - "aggregateSnapshot" : { - "description" : "A Counters snapshot that represents the aggregate values of all nodes in the cluster. If the NiFi instance is a standalone instance, rather than a cluster, this represents the stats of the single instance.", - "$ref" : "#/definitions/CountersSnapshotDTO" - }, - "nodeSnapshots" : { - "type" : "array", - "description" : "A Counters snapshot for each node in the cluster. If the NiFi instance is a standalone instance, rather than a cluster, this may be null.", - "items" : { - "$ref" : "#/definitions/NodeCountersSnapshotDTO" - } - } - } - }, - "CountersEntity" : { - "type" : "object", - "properties" : { - "counters" : { - "$ref" : "#/definitions/CountersDTO" - } - }, - "xml" : { - "name" : "countersEntity" - } - }, - "CountersSnapshotDTO" : { - "type" : "object", - "properties" : { - "generated" : { - "type" : "string", - "description" : "The timestamp when the report was generated." - }, - "counters" : { - "type" : "array", - "description" : "All counters in the NiFi.", - "items" : { - "$ref" : "#/definitions/CounterDTO" - } - } - } - }, - "CreateActiveRequestEntity" : { - "type" : "object", - "properties" : { - "processGroupId" : { - "type" : "string", - "description" : "The Process Group ID that this active request will update" - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - } - }, - "xml" : { - "name" : "createActiveRequestEntity" - } - }, - "CreateTemplateRequestEntity" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The name of the template." - }, - "description" : { - "type" : "string", - "description" : "The description of the template." - }, - "snippetId" : { - "type" : "string", - "description" : "The identifier of the snippet." - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - } - }, - "xml" : { - "name" : "createTemplateRequestEntity" - } - }, - "CurrentUserEntity" : { - "type" : "object", - "properties" : { - "identity" : { - "type" : "string", - "description" : "The user identity being serialized." - }, - "anonymous" : { - "type" : "boolean", - "description" : "Whether the current user is anonymous." - }, - "provenancePermissions" : { - "description" : "Permissions for querying provenance.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "countersPermissions" : { - "description" : "Permissions for accessing counters.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "tenantsPermissions" : { - "description" : "Permissions for accessing tenants.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "controllerPermissions" : { - "description" : "Permissions for accessing the controller.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "policiesPermissions" : { - "description" : "Permissions for accessing the policies.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "systemPermissions" : { - "description" : "Permissions for accessing system.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "parameterContextPermissions" : { - "description" : "Permissions for accessing parameter contexts.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "restrictedComponentsPermissions" : { - "description" : "Permissions for accessing restricted components. Note: the read permission are not used and will always be false.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "componentRestrictionPermissions" : { - "type" : "array", - "description" : "Permissions for specific component restrictions.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ComponentRestrictionPermissionDTO" - } - }, - "canVersionFlows" : { - "type" : "boolean", - "description" : "Whether the current user can version flows." - } - }, - "xml" : { - "name" : "currentEntity" - } - }, - "DifferenceDTO" : { - "type" : "object", - "properties" : { - "differenceType" : { - "type" : "string", - "description" : "The type of difference" - }, - "difference" : { - "type" : "string", - "description" : "Description of the difference" - } - } - }, - "DimensionsDTO" : { - "type" : "object", - "properties" : { - "width" : { - "type" : "number", - "format" : "double", - "description" : "The width of the label in pixels when at a 1:1 scale." - }, - "height" : { - "type" : "number", - "format" : "double", - "description" : "The height of the label in pixels when at a 1:1 scale." - } - } - }, - "DocumentedTypeDTO" : { - "type" : "object", - "properties" : { - "type" : { - "type" : "string", - "description" : "The fully qualified name of the type." - }, - "bundle" : { - "description" : "The details of the artifact that bundled this type.", - "$ref" : "#/definitions/BundleDTO" - }, - "controllerServiceApis" : { - "type" : "array", - "description" : "If this type represents a ControllerService, this lists the APIs it implements.", - "items" : { - "$ref" : "#/definitions/ControllerServiceApiDTO" - } - }, - "description" : { - "type" : "string", - "description" : "The description of the type." - }, - "restricted" : { - "type" : "boolean", - "description" : "Whether this type is restricted." - }, - "usageRestriction" : { - "type" : "string", - "description" : "The optional description of why the usage of this component is restricted." - }, - "explicitRestrictions" : { - "type" : "array", - "description" : "An optional collection of explicit restrictions. If specified, these explicit restrictions will be enfored.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ExplicitRestrictionDTO" - } - }, - "deprecationReason" : { - "type" : "string", - "description" : "The description of why the usage of this component is restricted." - }, - "tags" : { - "type" : "array", - "description" : "The tags associated with this type.", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - } - } - }, - "DropRequestDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id for this drop request." - }, - "uri" : { - "type" : "string", - "description" : "The URI for future requests to this drop request." - }, - "submissionTime" : { - "type" : "string", - "description" : "The timestamp when the query was submitted." - }, - "lastUpdated" : { - "type" : "string", - "description" : "The last time this drop request was updated." - }, - "percentCompleted" : { - "type" : "integer", - "format" : "int32", - "description" : "The current percent complete." - }, - "finished" : { - "type" : "boolean", - "description" : "Whether the query has finished." - }, - "failureReason" : { - "type" : "string", - "description" : "The reason, if any, that this drop request failed." - }, - "currentCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of flow files currently queued." - }, - "currentSize" : { - "type" : "integer", - "format" : "int64", - "description" : "The size of flow files currently queued in bytes." - }, - "current" : { - "type" : "string", - "description" : "The count and size of flow files currently queued." - }, - "originalCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of flow files to be dropped as a result of this request." - }, - "originalSize" : { - "type" : "integer", - "format" : "int64", - "description" : "The size of flow files to be dropped as a result of this request in bytes." - }, - "original" : { - "type" : "string", - "description" : "The count and size of flow files to be dropped as a result of this request." - }, - "droppedCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of flow files that have been dropped thus far." - }, - "droppedSize" : { - "type" : "integer", - "format" : "int64", - "description" : "The size of flow files that have been dropped thus far in bytes." - }, - "dropped" : { - "type" : "string", - "description" : "The count and size of flow files that have been dropped thus far." - }, - "state" : { - "type" : "string", - "description" : "The current state of the drop request." - } - } - }, - "DropRequestEntity" : { - "type" : "object", - "properties" : { - "dropRequest" : { - "$ref" : "#/definitions/DropRequestDTO" - } - }, - "xml" : { - "name" : "dropRequestEntity" - } - }, - "ExplicitRestrictionDTO" : { - "type" : "object", - "properties" : { - "requiredPermission" : { - "description" : "The required permission necessary for this restriction.", - "$ref" : "#/definitions/RequiredPermissionDTO" - }, - "explanation" : { - "type" : "string", - "description" : "The description of why the usage of this component is restricted for this required permission." - } - } - }, - "ExternalControllerServiceReference" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The identifier of the controller service" - }, - "name" : { - "type" : "string", - "description" : "The name of the controller service" - } - } - }, - "FlowBreadcrumbDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the group." - }, - "name" : { - "type" : "string", - "description" : "The id of the group." - }, - "versionControlInformation" : { - "description" : "The process group version control information or null if not version controlled.", - "$ref" : "#/definitions/VersionControlInformationDTO" - } - } - }, - "FlowBreadcrumbEntity" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of this ancestor ProcessGroup." - }, - "permissions" : { - "description" : "The permissions for this ancestor ProcessGroup.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "versionedFlowState" : { - "type" : "string", - "description" : "The current state of the Process Group, as it relates to the Versioned Flow", - "readOnly" : true, - "enum" : [ "LOCALLY_MODIFIED", "STALE", "LOCALLY_MODIFIED_AND_STALE", "UP_TO_DATE", "SYNC_FAILURE" ] - }, - "breadcrumb" : { - "description" : "This breadcrumb.", - "$ref" : "#/definitions/FlowBreadcrumbDTO" - }, - "parentBreadcrumb" : { - "description" : "The parent breadcrumb for this breadcrumb.", - "$ref" : "#/definitions/FlowBreadcrumbEntity" - } - }, - "xml" : { - "name" : "flowEntity" - } - }, - "FlowComparisonEntity" : { - "type" : "object", - "properties" : { - "componentDifferences" : { - "type" : "array", - "description" : "The list of differences for each component in the flow that is not the same between the two flows", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ComponentDifferenceDTO" - } - } - }, - "xml" : { - "name" : "flowComparisonEntity" - } - }, - "FlowConfigurationDTO" : { - "type" : "object", - "properties" : { - "supportsManagedAuthorizer" : { - "type" : "boolean", - "description" : "Whether this NiFi supports a managed authorizer. Managed authorizers can visualize users, groups, and policies in the UI.", - "readOnly" : true - }, - "supportsConfigurableAuthorizer" : { - "type" : "boolean", - "description" : "Whether this NiFi supports a configurable authorizer.", - "readOnly" : true - }, - "supportsConfigurableUsersAndGroups" : { - "type" : "boolean", - "description" : "Whether this NiFi supports configurable users and groups.", - "readOnly" : true - }, - "autoRefreshIntervalSeconds" : { - "type" : "integer", - "format" : "int64", - "description" : "The interval in seconds between the automatic NiFi refresh requests.", - "readOnly" : true - }, - "currentTime" : { - "type" : "string", - "description" : "The current time on the system." - }, - "timeOffset" : { - "type" : "integer", - "format" : "int32", - "description" : "The time offset of the system." - }, - "defaultBackPressureObjectThreshold" : { - "type" : "integer", - "format" : "int64", - "description" : "The default back pressure object threshold." - }, - "defaultBackPressureDataSizeThreshold" : { - "type" : "string", - "description" : "The default back pressure data size threshold." - } - } - }, - "FlowConfigurationEntity" : { - "type" : "object", - "properties" : { - "flowConfiguration" : { - "description" : "The controller configuration.", - "$ref" : "#/definitions/FlowConfigurationDTO" - } - }, - "xml" : { - "name" : "flowConfigurationEntity" - } - }, - "FlowDTO" : { - "type" : "object", - "properties" : { - "processGroups" : { - "type" : "array", - "description" : "The process groups in this flow.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ProcessGroupEntity" - } - }, - "remoteProcessGroups" : { - "type" : "array", - "description" : "The remote process groups in this flow.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/RemoteProcessGroupEntity" - } - }, - "processors" : { - "type" : "array", - "description" : "The processors in this flow.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ProcessorEntity" - } - }, - "inputPorts" : { - "type" : "array", - "description" : "The input ports in this flow.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/PortEntity" - } - }, - "outputPorts" : { - "type" : "array", - "description" : "The output ports in this flow.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/PortEntity" - } - }, - "connections" : { - "type" : "array", - "description" : "The connections in this flow.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ConnectionEntity" - } - }, - "labels" : { - "type" : "array", - "description" : "The labels in this flow.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/LabelEntity" - } - }, - "funnels" : { - "type" : "array", - "description" : "The funnels in this flow.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/FunnelEntity" - } - } - } - }, - "FlowEntity" : { - "type" : "object", - "properties" : { - "flow" : { - "$ref" : "#/definitions/FlowDTO" - } - }, - "xml" : { - "name" : "flowEntity" - } - }, - "FlowFileDTO" : { - "type" : "object", - "properties" : { - "uri" : { - "type" : "string", - "description" : "The URI that can be used to access this FlowFile." - }, - "uuid" : { - "type" : "string", - "description" : "The FlowFile UUID." - }, - "filename" : { - "type" : "string", - "description" : "The FlowFile filename." - }, - "position" : { - "type" : "integer", - "format" : "int32", - "description" : "The FlowFile's position in the queue." - }, - "size" : { - "type" : "integer", - "format" : "int64", - "description" : "The FlowFile file size." - }, - "queuedDuration" : { - "type" : "integer", - "format" : "int64", - "description" : "How long this FlowFile has been enqueued." - }, - "lineageDuration" : { - "type" : "integer", - "format" : "int64", - "description" : "Duration since the FlowFile's greatest ancestor entered the flow." - }, - "penaltyExpiresIn" : { - "type" : "integer", - "format" : "int64", - "description" : "How long in milliseconds until the FlowFile penalty expires." - }, - "clusterNodeId" : { - "type" : "string", - "description" : "The id of the node where this FlowFile resides." - }, - "clusterNodeAddress" : { - "type" : "string", - "description" : "The label for the node where this FlowFile resides." - }, - "attributes" : { - "type" : "object", - "description" : "The FlowFile attributes.", - "additionalProperties" : { - "type" : "string" - } - }, - "contentClaimSection" : { - "type" : "string", - "description" : "The section in which the content claim lives." - }, - "contentClaimContainer" : { - "type" : "string", - "description" : "The container in which the content claim lives." - }, - "contentClaimIdentifier" : { - "type" : "string", - "description" : "The identifier of the content claim." - }, - "contentClaimOffset" : { - "type" : "integer", - "format" : "int64", - "description" : "The offset into the content claim where the flowfile's content begins." - }, - "contentClaimFileSize" : { - "type" : "string", - "description" : "The file size of the content claim formatted." - }, - "contentClaimFileSizeBytes" : { - "type" : "integer", - "format" : "int64", - "description" : "The file size of the content claim in bytes." - }, - "penalized" : { - "type" : "boolean", - "description" : "If the FlowFile is penalized." - } - } - }, - "FlowFileEntity" : { - "type" : "object", - "properties" : { - "flowFile" : { - "$ref" : "#/definitions/FlowFileDTO" - } - }, - "xml" : { - "name" : "flowFileEntity" - } - }, - "FlowFileSummaryDTO" : { - "type" : "object", - "properties" : { - "uri" : { - "type" : "string", - "description" : "The URI that can be used to access this FlowFile." - }, - "uuid" : { - "type" : "string", - "description" : "The FlowFile UUID." - }, - "filename" : { - "type" : "string", - "description" : "The FlowFile filename." - }, - "position" : { - "type" : "integer", - "format" : "int32", - "description" : "The FlowFile's position in the queue." - }, - "size" : { - "type" : "integer", - "format" : "int64", - "description" : "The FlowFile file size." - }, - "queuedDuration" : { - "type" : "integer", - "format" : "int64", - "description" : "How long this FlowFile has been enqueued." - }, - "lineageDuration" : { - "type" : "integer", - "format" : "int64", - "description" : "Duration since the FlowFile's greatest ancestor entered the flow." - }, - "penaltyExpiresIn" : { - "type" : "integer", - "format" : "int64", - "description" : "How long in milliseconds until the FlowFile penalty expires." - }, - "clusterNodeId" : { - "type" : "string", - "description" : "The id of the node where this FlowFile resides." - }, - "clusterNodeAddress" : { - "type" : "string", - "description" : "The label for the node where this FlowFile resides." - }, - "penalized" : { - "type" : "boolean", - "description" : "If the FlowFile is penalized." - } - } - }, - "FlowSnippetDTO" : { - "type" : "object", - "properties" : { - "processGroups" : { - "type" : "array", - "description" : "The process groups in this flow snippet.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ProcessGroupDTO" - } - }, - "remoteProcessGroups" : { - "type" : "array", - "description" : "The remote process groups in this flow snippet.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/RemoteProcessGroupDTO" - } - }, - "processors" : { - "type" : "array", - "description" : "The processors in this flow snippet.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ProcessorDTO" - } - }, - "inputPorts" : { - "type" : "array", - "description" : "The input ports in this flow snippet.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/PortDTO" - } - }, - "outputPorts" : { - "type" : "array", - "description" : "The output ports in this flow snippet.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/PortDTO" - } - }, - "connections" : { - "type" : "array", - "description" : "The connections in this flow snippet.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ConnectionDTO" - } - }, - "labels" : { - "type" : "array", - "description" : "The labels in this flow snippet.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/LabelDTO" - } - }, - "funnels" : { - "type" : "array", - "description" : "The funnels in this flow snippet.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/FunnelDTO" - } - }, - "controllerServices" : { - "type" : "array", - "description" : "The controller services in this flow snippet.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ControllerServiceDTO" - } - } - } - }, - "FunnelDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "versionedComponentId" : { - "type" : "string", - "description" : "The ID of the corresponding component that is under version control" - }, - "parentGroupId" : { - "type" : "string", - "description" : "The id of parent process group of this component if applicable." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - } - } - }, - "FunnelEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "component" : { - "$ref" : "#/definitions/FunnelDTO" - } - }, - "xml" : { - "name" : "funnelEntity" - } - }, - "FunnelsEntity" : { - "type" : "object", - "properties" : { - "funnels" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/FunnelEntity" - } - } - }, - "xml" : { - "name" : "funnelsEntity" - } - }, - "GarbageCollectionDTO" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The name of the garbage collector." - }, - "collectionCount" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of times garbage collection has run." - }, - "collectionTime" : { - "type" : "string", - "description" : "The total amount of time spent garbage collecting." - }, - "collectionMillis" : { - "type" : "integer", - "format" : "int64", - "description" : "The total number of milliseconds spent garbage collecting." - } - } - }, - "HistoryDTO" : { - "type" : "object", - "properties" : { - "total" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of number of actions that matched the search criteria.." - }, - "lastRefreshed" : { - "type" : "string", - "description" : "The timestamp when the report was generated." - }, - "actions" : { - "type" : "array", - "description" : "The actions.", - "items" : { - "$ref" : "#/definitions/ActionEntity" - } - } - } - }, - "HistoryEntity" : { - "type" : "object", - "properties" : { - "history" : { - "$ref" : "#/definitions/HistoryDTO" - } - }, - "xml" : { - "name" : "historyEntity" - } - }, - "InputPortsEntity" : { - "type" : "object", - "properties" : { - "inputPorts" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/PortEntity" - } - } - }, - "xml" : { - "name" : "inputPortsEntity" - } - }, - "InstantiateTemplateRequestEntity" : { - "type" : "object", - "properties" : { - "originX" : { - "type" : "number", - "format" : "double", - "description" : "The x coordinate of the origin of the bounding box where the new components will be placed." - }, - "originY" : { - "type" : "number", - "format" : "double", - "description" : "The y coordinate of the origin of the bounding box where the new components will be placed." - }, - "templateId" : { - "type" : "string", - "description" : "The identifier of the template." - }, - "encodingVersion" : { - "type" : "string", - "description" : "The encoding version of the flow snippet. If not specified, this is automatically populated by the node receiving the user request. If the snippet is specified, the version will be the latest. If the snippet is not specified, the version will come from the underlying template. These details need to be replicated throughout the cluster to ensure consistency." - }, - "snippet" : { - "description" : "A flow snippet of the template contents. If not specified, this is automatically populated by the node receiving the user request. These details need to be replicated throughout the cluster to ensure consistency.", - "$ref" : "#/definitions/FlowSnippetDTO" - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - } - }, - "xml" : { - "name" : "instantiateTemplateRequestEntity" - } - }, - "JaxbLink" : { - "type" : "object", - "properties" : { - "href" : { - "type" : "string", - "format" : "uri", - "xml" : { - "attribute" : true - }, - "description" : "The href for the link" - }, - "params" : { - "type" : "object", - "description" : "The params for the link", - "additionalProperties" : { - "type" : "string" - } - } - } - }, - "LabelDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "versionedComponentId" : { - "type" : "string", - "description" : "The ID of the corresponding component that is under version control" - }, - "parentGroupId" : { - "type" : "string", - "description" : "The id of parent process group of this component if applicable." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "label" : { - "type" : "string", - "description" : "The text that appears in the label." - }, - "width" : { - "type" : "number", - "format" : "double", - "description" : "The width of the label in pixels when at a 1:1 scale." - }, - "height" : { - "type" : "number", - "format" : "double", - "description" : "The height of the label in pixels when at a 1:1 scale." - }, - "style" : { - "type" : "object", - "description" : "The styles for this label (font-size : 12px, background-color : #eee, etc).", - "additionalProperties" : { - "type" : "string" - } - } - } - }, - "LabelEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "dimensions" : { - "$ref" : "#/definitions/DimensionsDTO" - }, - "component" : { - "$ref" : "#/definitions/LabelDTO" - } - }, - "xml" : { - "name" : "labelEntity" - } - }, - "LabelsEntity" : { - "type" : "object", - "properties" : { - "labels" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/LabelEntity" - } - } - }, - "xml" : { - "name" : "labelsEntity" - } - }, - "LineageDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of this lineage query." - }, - "uri" : { - "type" : "string", - "description" : "The URI for this lineage query for later retrieval and deletion." - }, - "submissionTime" : { - "type" : "string", - "description" : "When the lineage query was submitted." - }, - "expiration" : { - "type" : "string", - "description" : "When the lineage query will expire." - }, - "percentCompleted" : { - "type" : "integer", - "format" : "int32", - "description" : "The percent complete for the lineage query." - }, - "finished" : { - "type" : "boolean", - "description" : "Whether the lineage query has finished." - }, - "request" : { - "description" : "The initial lineage result.", - "$ref" : "#/definitions/LineageRequestDTO" - }, - "results" : { - "description" : "The results of the lineage query.", - "$ref" : "#/definitions/LineageResultsDTO" - } - } - }, - "LineageEntity" : { - "type" : "object", - "properties" : { - "lineage" : { - "$ref" : "#/definitions/LineageDTO" - } - }, - "xml" : { - "name" : "lineageEntity" - } - }, - "LineageRequestDTO" : { - "type" : "object", - "properties" : { - "eventId" : { - "type" : "integer", - "format" : "int64", - "description" : "The event id that was used to generate this lineage, if applicable. The event id is allowed for any type of lineageRequestType. If the lineageRequestType is FLOWFILE and the flowfile uuid is also included in the request, the event id will be ignored." - }, - "lineageRequestType" : { - "type" : "string", - "description" : "The type of lineage request. PARENTS will return the lineage for the flowfiles that are parents of the specified event. CHILDREN will return the lineage for the flowfiles that are children of the specified event. FLOWFILE will return the lineage for the specified flowfile.", - "enum" : [ "PARENTS", "CHILDREN", "and FLOWFILE" ] - }, - "uuid" : { - "type" : "string", - "description" : "The flowfile uuid that was used to generate the lineage. The flowfile uuid is only allowed when the lineageRequestType is FLOWFILE and will take precedence over event id." - }, - "clusterNodeId" : { - "type" : "string", - "description" : "The id of the node where this lineage originated if clustered." - } - } - }, - "LineageResultsDTO" : { - "type" : "object", - "properties" : { - "errors" : { - "type" : "array", - "description" : "Any errors that occurred while generating the lineage.", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - }, - "nodes" : { - "type" : "array", - "description" : "The nodes in the lineage.", - "items" : { - "$ref" : "#/definitions/ProvenanceNodeDTO" - } - }, - "links" : { - "type" : "array", - "description" : "The links between the nodes in the lineage.", - "items" : { - "$ref" : "#/definitions/ProvenanceLinkDTO" - } - } - } - }, - "ListingRequestDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id for this listing request." - }, - "uri" : { - "type" : "string", - "description" : "The URI for future requests to this listing request." - }, - "submissionTime" : { - "type" : "string", - "description" : "The timestamp when the query was submitted." - }, - "lastUpdated" : { - "type" : "string", - "description" : "The last time this listing request was updated." - }, - "percentCompleted" : { - "type" : "integer", - "format" : "int32", - "description" : "The current percent complete." - }, - "finished" : { - "type" : "boolean", - "description" : "Whether the query has finished." - }, - "failureReason" : { - "type" : "string", - "description" : "The reason, if any, that this listing request failed." - }, - "maxResults" : { - "type" : "integer", - "format" : "int32", - "description" : "The maximum number of FlowFileSummary objects to return" - }, - "state" : { - "type" : "string", - "description" : "The current state of the listing request." - }, - "queueSize" : { - "description" : "The size of the queue", - "$ref" : "#/definitions/QueueSizeDTO" - }, - "flowFileSummaries" : { - "type" : "array", - "description" : "The FlowFile summaries. The summaries will be populated once the request has completed.", - "items" : { - "$ref" : "#/definitions/FlowFileSummaryDTO" - } - }, - "sourceRunning" : { - "type" : "boolean", - "description" : "Whether the source of the connection is running" - }, - "destinationRunning" : { - "type" : "boolean", - "description" : "Whether the destination of the connection is running" - } - } - }, - "ListingRequestEntity" : { - "type" : "object", - "properties" : { - "listingRequest" : { - "$ref" : "#/definitions/ListingRequestDTO" - } - }, - "xml" : { - "name" : "listingRequestEntity" - } - }, - "NodeConnectionStatisticsSnapshotDTO" : { - "type" : "object", - "properties" : { - "nodeId" : { - "type" : "string", - "description" : "The unique ID that identifies the node" - }, - "address" : { - "type" : "string", - "description" : "The API address of the node" - }, - "apiPort" : { - "type" : "integer", - "format" : "int32", - "description" : "The API port used to communicate with the node" - }, - "statisticsSnapshot" : { - "description" : "The connection status snapshot from the node.", - "$ref" : "#/definitions/ConnectionStatisticsSnapshotDTO" - } - } - }, - "NodeConnectionStatusSnapshotDTO" : { - "type" : "object", - "properties" : { - "nodeId" : { - "type" : "string", - "description" : "The unique ID that identifies the node" - }, - "address" : { - "type" : "string", - "description" : "The API address of the node" - }, - "apiPort" : { - "type" : "integer", - "format" : "int32", - "description" : "The API port used to communicate with the node" - }, - "statusSnapshot" : { - "description" : "The connection status snapshot from the node.", - "$ref" : "#/definitions/ConnectionStatusSnapshotDTO" - } - } - }, - "NodeCountersSnapshotDTO" : { - "type" : "object", - "properties" : { - "nodeId" : { - "type" : "string", - "description" : "The unique ID that identifies the node" - }, - "address" : { - "type" : "string", - "description" : "The API address of the node" - }, - "apiPort" : { - "type" : "integer", - "format" : "int32", - "description" : "The API port used to communicate with the node" - }, - "snapshot" : { - "description" : "The counters from the node.", - "$ref" : "#/definitions/CountersSnapshotDTO" - } - } - }, - "NodeDTO" : { - "type" : "object", - "properties" : { - "nodeId" : { - "type" : "string", - "description" : "The id of the node.", - "readOnly" : true - }, - "address" : { - "type" : "string", - "description" : "The node's host/ip address.", - "readOnly" : true - }, - "apiPort" : { - "type" : "integer", - "format" : "int32", - "description" : "The port the node is listening for API requests.", - "readOnly" : true - }, - "status" : { - "type" : "string", - "description" : "The node's status." - }, - "heartbeat" : { - "type" : "string", - "description" : "the time of the nodes's last heartbeat.", - "readOnly" : true - }, - "connectionRequested" : { - "type" : "string", - "description" : "The time of the node's last connection request.", - "readOnly" : true - }, - "roles" : { - "type" : "array", - "description" : "The roles of this node.", - "readOnly" : true, - "uniqueItems" : true, - "items" : { - "type" : "string" - } - }, - "activeThreadCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The active threads for the NiFi on the node.", - "readOnly" : true - }, - "queued" : { - "type" : "string", - "description" : "The queue the NiFi on the node.", - "readOnly" : true - }, - "events" : { - "type" : "array", - "description" : "The node's events.", - "readOnly" : true, - "items" : { - "$ref" : "#/definitions/NodeEventDTO" - } - }, - "nodeStartTime" : { - "type" : "string", - "description" : "The time at which this Node was last refreshed.", - "readOnly" : true - } - } - }, - "NodeEntity" : { - "type" : "object", - "properties" : { - "node" : { - "$ref" : "#/definitions/NodeDTO" - } - }, - "xml" : { - "name" : "nodeEntity" - } - }, - "NodeEventDTO" : { - "type" : "object", - "properties" : { - "timestamp" : { - "type" : "string", - "description" : "The timestamp of the node event." - }, - "category" : { - "type" : "string", - "description" : "The category of the node event." - }, - "message" : { - "type" : "string", - "description" : "The message in the node event." - } - } - }, - "NodePortStatusSnapshotDTO" : { - "type" : "object", - "properties" : { - "nodeId" : { - "type" : "string", - "description" : "The unique ID that identifies the node" - }, - "address" : { - "type" : "string", - "description" : "The API address of the node" - }, - "apiPort" : { - "type" : "integer", - "format" : "int32", - "description" : "The API port used to communicate with the node" - }, - "statusSnapshot" : { - "description" : "The port status snapshot from the node.", - "$ref" : "#/definitions/PortStatusSnapshotDTO" - } - } - }, - "NodeProcessGroupStatusSnapshotDTO" : { - "type" : "object", - "properties" : { - "nodeId" : { - "type" : "string", - "description" : "The unique ID that identifies the node" - }, - "address" : { - "type" : "string", - "description" : "The API address of the node" - }, - "apiPort" : { - "type" : "integer", - "format" : "int32", - "description" : "The API port used to communicate with the node" - }, - "statusSnapshot" : { - "description" : "The process group status snapshot from the node.", - "$ref" : "#/definitions/ProcessGroupStatusSnapshotDTO" - } - } - }, - "NodeProcessorStatusSnapshotDTO" : { - "type" : "object", - "properties" : { - "nodeId" : { - "type" : "string", - "description" : "The unique ID that identifies the node" - }, - "address" : { - "type" : "string", - "description" : "The API address of the node" - }, - "apiPort" : { - "type" : "integer", - "format" : "int32", - "description" : "The API port used to communicate with the node" - }, - "statusSnapshot" : { - "description" : "The processor status snapshot from the node.", - "$ref" : "#/definitions/ProcessorStatusSnapshotDTO" - } - } - }, - "NodeRemoteProcessGroupStatusSnapshotDTO" : { - "type" : "object", - "properties" : { - "nodeId" : { - "type" : "string", - "description" : "The unique ID that identifies the node" - }, - "address" : { - "type" : "string", - "description" : "The API address of the node" - }, - "apiPort" : { - "type" : "integer", - "format" : "int32", - "description" : "The API port used to communicate with the node" - }, - "statusSnapshot" : { - "description" : "The remote process group status snapshot from the node.", - "$ref" : "#/definitions/RemoteProcessGroupStatusSnapshotDTO" - } - } - }, - "NodeSearchResultDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the node that matched the search." - }, - "address" : { - "type" : "string", - "description" : "The address of the node that matched the search." - } - } - }, - "NodeStatusSnapshotsDTO" : { - "type" : "object", - "properties" : { - "nodeId" : { - "type" : "string", - "description" : "The id of the node." - }, - "address" : { - "type" : "string", - "description" : "The node's host/ip address." - }, - "apiPort" : { - "type" : "integer", - "format" : "int32", - "description" : "The port the node is listening for API requests." - }, - "statusSnapshots" : { - "type" : "array", - "description" : "A list of StatusSnapshotDTO objects that provide the actual metric values for the component for this node.", - "items" : { - "$ref" : "#/definitions/StatusSnapshotDTO" - } - } - } - }, - "NodeSystemDiagnosticsSnapshotDTO" : { - "type" : "object", - "properties" : { - "nodeId" : { - "type" : "string", - "description" : "The unique ID that identifies the node" - }, - "address" : { - "type" : "string", - "description" : "The API address of the node" - }, - "apiPort" : { - "type" : "integer", - "format" : "int32", - "description" : "The API port used to communicate with the node" - }, - "snapshot" : { - "description" : "The System Diagnostics snapshot from the node.", - "$ref" : "#/definitions/SystemDiagnosticsSnapshotDTO" - } - } - }, - "OutputPortsEntity" : { - "type" : "object", - "properties" : { - "outputPorts" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/PortEntity" - } - } - }, - "xml" : { - "name" : "outputPortsEntity" - } - }, - "ParameterContextDTO" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The Name of the Parameter Context." - }, - "description" : { - "type" : "string", - "description" : "The Description of the Parameter Context." - }, - "parameters" : { - "type" : "array", - "description" : "The Parameters for the Parameter Context", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ParameterEntity" - } - }, - "boundProcessGroups" : { - "type" : "array", - "description" : "The Process Groups that are bound to this Parameter Context", - "readOnly" : true, - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ProcessGroupEntity" - } - }, - "id" : { - "type" : "string", - "description" : "The ID the Parameter Context.", - "readOnly" : true - } - } - }, - "ParameterContextEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "component" : { - "description" : "The Parameter Context", - "$ref" : "#/definitions/ParameterContextDTO" - } - }, - "xml" : { - "name" : "parameterContextEntity" - } - }, - "ParameterContextReferenceDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The ID of the Parameter Context" - }, - "name" : { - "type" : "string", - "description" : "The name of the Parameter Context" - } - } - }, - "ParameterContextReferenceEntity" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "component" : { - "$ref" : "#/definitions/ParameterContextReferenceDTO" - } - }, - "xml" : { - "name" : "parameterContextReferenceEntity" - } - }, - "ParameterContextUpdateRequestDTO" : { - "type" : "object", - "properties" : { - "requestId" : { - "type" : "string", - "description" : "The ID of the request", - "readOnly" : true - }, - "uri" : { - "type" : "string", - "description" : "The URI for the request", - "readOnly" : true - }, - "submissionTime" : { - "type" : "string", - "format" : "date-time", - "description" : "The timestamp of when the request was submitted", - "readOnly" : true - }, - "lastUpdated" : { - "type" : "string", - "format" : "date-time", - "description" : "The timestamp of when the request was last updated", - "readOnly" : true - }, - "complete" : { - "type" : "boolean", - "description" : "Whether or not the request is completed", - "readOnly" : true - }, - "failureReason" : { - "type" : "string", - "description" : "The reason for the request failing, or null if the request has not failed", - "readOnly" : true - }, - "percentCompleted" : { - "type" : "integer", - "format" : "int32", - "description" : "A value between 0 and 100 (inclusive) indicating how close the request is to completion", - "readOnly" : true - }, - "state" : { - "type" : "string", - "description" : "A description of the current state of the request", - "readOnly" : true - }, - "updateSteps" : { - "type" : "array", - "description" : "The steps that are required in order to complete the request, along with the status of each", - "readOnly" : true, - "items" : { - "$ref" : "#/definitions/ParameterContextUpdateStepDTO" - } - }, - "parameterContext" : { - "description" : "The Parameter Context that is being operated on. This may not be populated until the request has successfully completed.", - "readOnly" : true, - "$ref" : "#/definitions/ParameterContextDTO" - }, - "referencingComponents" : { - "type" : "array", - "description" : "The components that are referenced by the update.", - "readOnly" : true, - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/AffectedComponentEntity" - } - } - } - }, - "ParameterContextUpdateRequestEntity" : { - "type" : "object", - "properties" : { - "parameterContextRevision" : { - "description" : "The Revision of the Parameter Context", - "$ref" : "#/definitions/RevisionDTO" - }, - "request" : { - "description" : "The Update Request", - "$ref" : "#/definitions/ParameterContextUpdateRequestDTO" - } - }, - "xml" : { - "name" : "parameterContextUpdateRequestEntity" - } - }, - "ParameterContextUpdateStepDTO" : { - "type" : "object", - "properties" : { - "description" : { - "type" : "string", - "description" : "Explanation of what happens in this step", - "readOnly" : true - }, - "complete" : { - "type" : "boolean", - "description" : "Whether or not this step has completed", - "readOnly" : true - }, - "failureReason" : { - "type" : "string", - "description" : "An explanation of why this step failed, or null if this step did not fail", - "readOnly" : true - } - } - }, - "ParameterContextValidationRequestDTO" : { - "type" : "object", - "properties" : { - "requestId" : { - "type" : "string", - "description" : "The ID of the request", - "readOnly" : true - }, - "uri" : { - "type" : "string", - "description" : "The URI for the request", - "readOnly" : true - }, - "submissionTime" : { - "type" : "string", - "format" : "date-time", - "description" : "The timestamp of when the request was submitted", - "readOnly" : true - }, - "lastUpdated" : { - "type" : "string", - "format" : "date-time", - "description" : "The timestamp of when the request was last updated", - "readOnly" : true - }, - "complete" : { - "type" : "boolean", - "description" : "Whether or not the request is completed", - "readOnly" : true - }, - "failureReason" : { - "type" : "string", - "description" : "The reason for the request failing, or null if the request has not failed", - "readOnly" : true - }, - "percentCompleted" : { - "type" : "integer", - "format" : "int32", - "description" : "A value between 0 and 100 (inclusive) indicating how close the request is to completion", - "readOnly" : true - }, - "state" : { - "type" : "string", - "description" : "A description of the current state of the request", - "readOnly" : true - }, - "updateSteps" : { - "type" : "array", - "description" : "The steps that are required in order to complete the request, along with the status of each", - "readOnly" : true, - "items" : { - "$ref" : "#/definitions/ParameterContextValidationStepDTO" - } - }, - "parameterContext" : { - "description" : "The Parameter Context that is being operated on.", - "$ref" : "#/definitions/ParameterContextDTO" - }, - "componentValidationResults" : { - "description" : "The Validation Results that were calculated for each component. This value may not be set until the request completes.", - "readOnly" : true, - "$ref" : "#/definitions/ComponentValidationResultsEntity" - } - } - }, - "ParameterContextValidationRequestEntity" : { - "type" : "object", - "properties" : { - "request" : { - "description" : "The Update Request", - "$ref" : "#/definitions/ParameterContextValidationRequestDTO" - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - } - }, - "xml" : { - "name" : "parameterContextValidationRequestEntity" - } - }, - "ParameterContextValidationStepDTO" : { - "type" : "object", - "properties" : { - "description" : { - "type" : "string", - "description" : "Explanation of what happens in this step", - "readOnly" : true - }, - "complete" : { - "type" : "boolean", - "description" : "Whether or not this step has completed", - "readOnly" : true - }, - "failureReason" : { - "type" : "string", - "description" : "An explanation of why this step failed, or null if this step did not fail", - "readOnly" : true - } - } - }, - "ParameterContextsEntity" : { - "type" : "object", - "properties" : { - "parameterContexts" : { - "type" : "array", - "description" : "The Parameter Contexts", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ParameterContextEntity" - } - }, - "currentTime" : { - "type" : "string", - "description" : "The current time on the system.", - "readOnly" : true - } - }, - "xml" : { - "name" : "parameterContexts" - } - }, - "ParameterDTO" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The name of the Parameter" - }, - "description" : { - "type" : "string", - "description" : "The description of the Parameter" - }, - "sensitive" : { - "type" : "boolean", - "description" : "Whether or not the Parameter is sensitive" - }, - "value" : { - "type" : "string", - "description" : "The value of the Parameter" - }, - "referencingComponents" : { - "type" : "array", - "description" : "The set of all components in the flow that are referencing this Parameter", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/AffectedComponentEntity" - } - } - } - }, - "ParameterEntity" : { - "type" : "object", - "properties" : { - "canWrite" : { - "type" : "boolean", - "description" : "Indicates whether the user can write a given resource.", - "readOnly" : true - }, - "parameter" : { - "description" : "The parameter information", - "$ref" : "#/definitions/ParameterDTO" - } - }, - "xml" : { - "name" : "parameterEntity" - } - }, - "PeerDTO" : { - "type" : "object", - "properties" : { - "hostname" : { - "type" : "string", - "description" : "The hostname of this peer." - }, - "port" : { - "type" : "integer", - "format" : "int32", - "description" : "The port number of this peer." - }, - "secure" : { - "type" : "boolean", - "description" : "Returns if this peer connection is secure." - }, - "flowFileCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of flowFiles this peer holds." - } - } - }, - "PeersEntity" : { - "type" : "object", - "properties" : { - "peers" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/PeerDTO" - } - } - }, - "xml" : { - "name" : "peersEntity" - } - }, - "Permissions" : { - "type" : "object", - "properties" : { - "canRead" : { - "type" : "boolean", - "description" : "Indicates whether the user can read a given resource.", - "readOnly" : true - }, - "canWrite" : { - "type" : "boolean", - "description" : "Indicates whether the user can write a given resource.", - "readOnly" : true - }, - "canDelete" : { - "type" : "boolean", - "description" : "Indicates whether the user can delete a given resource.", - "readOnly" : true - } - } - }, - "PermissionsDTO" : { - "type" : "object", - "properties" : { - "canRead" : { - "type" : "boolean", - "description" : "Indicates whether the user can read a given resource.", - "readOnly" : true - }, - "canWrite" : { - "type" : "boolean", - "description" : "Indicates whether the user can write a given resource.", - "readOnly" : true - } - } - }, - "PortDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "versionedComponentId" : { - "type" : "string", - "description" : "The ID of the corresponding component that is under version control" - }, - "parentGroupId" : { - "type" : "string", - "description" : "The id of parent process group of this component if applicable." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "name" : { - "type" : "string", - "description" : "The name of the port." - }, - "comments" : { - "type" : "string", - "description" : "The comments for the port." - }, - "state" : { - "type" : "string", - "description" : "The state of the port.", - "enum" : [ "RUNNING", "STOPPED", "DISABLED" ] - }, - "type" : { - "type" : "string", - "description" : "The type of port.", - "enum" : [ "INPUT_PORT", "OUTPUT_PORT" ] - }, - "transmitting" : { - "type" : "boolean", - "description" : "Whether the port has incoming or output connections to a remote NiFi. This is only applicable when the port is allowed to be accessed remotely." - }, - "concurrentlySchedulableTaskCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of tasks that should be concurrently scheduled for the port." - }, - "userAccessControl" : { - "type" : "array", - "description" : "The users that are allowed to access the port.", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - }, - "groupAccessControl" : { - "type" : "array", - "description" : "The user groups that are allowed to access the port.", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - }, - "allowRemoteAccess" : { - "type" : "boolean", - "description" : "Whether this port can be accessed remotely via Site-to-Site protocol." - }, - "validationErrors" : { - "type" : "array", - "description" : "Gets the validation errors from this port. These validation errors represent the problems with the port that must be resolved before it can be started.", - "items" : { - "type" : "string" - } - } - } - }, - "PortEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "component" : { - "$ref" : "#/definitions/PortDTO" - }, - "status" : { - "description" : "The status of the port.", - "$ref" : "#/definitions/PortStatusDTO" - }, - "portType" : { - "type" : "string" - }, - "operatePermissions" : { - "description" : "The permissions for this component operations.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "allowRemoteAccess" : { - "type" : "boolean", - "description" : "Whether this port can be accessed remotely via Site-to-Site protocol." - } - }, - "xml" : { - "name" : "portEntity" - } - }, - "PortRunStatusEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "state" : { - "type" : "string", - "description" : "The run status of the Port.", - "enum" : [ "RUNNING", "STOPPED", "DISABLED" ] - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - } - }, - "xml" : { - "name" : "entity" - } - }, - "PortStatusDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the port." - }, - "groupId" : { - "type" : "string", - "description" : "The id of the parent process group of the port." - }, - "name" : { - "type" : "string", - "description" : "The name of the port." - }, - "transmitting" : { - "type" : "boolean", - "description" : "Whether the port has incoming or outgoing connections to a remote NiFi." - }, - "runStatus" : { - "type" : "string", - "description" : "The run status of the port.", - "enum" : [ "Running", "Stopped", "Validating", "Disabled", "Invalid" ] - }, - "statsLastRefreshed" : { - "type" : "string", - "description" : "The time the status for the process group was last refreshed." - }, - "aggregateSnapshot" : { - "description" : "A status snapshot that represents the aggregate stats of all nodes in the cluster. If the NiFi instance is a standalone instance, rather than a cluster, this represents the stats of the single instance.", - "$ref" : "#/definitions/PortStatusSnapshotDTO" - }, - "nodeSnapshots" : { - "type" : "array", - "description" : "A status snapshot for each node in the cluster. If the NiFi instance is a standalone instance, rather than a cluster, this may be null.", - "items" : { - "$ref" : "#/definitions/NodePortStatusSnapshotDTO" - } - } - } - }, - "PortStatusEntity" : { - "type" : "object", - "properties" : { - "portStatus" : { - "$ref" : "#/definitions/PortStatusDTO" - }, - "canRead" : { - "type" : "boolean", - "description" : "Indicates whether the user can read a given resource.", - "readOnly" : true - } - }, - "xml" : { - "name" : "portStatusEntity" - } - }, - "PortStatusSnapshotDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the port." - }, - "groupId" : { - "type" : "string", - "description" : "The id of the parent process group of the port." - }, - "name" : { - "type" : "string", - "description" : "The name of the port." - }, - "activeThreadCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The active thread count for the port." - }, - "flowFilesIn" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of FlowFiles that have been accepted in the last 5 minutes." - }, - "bytesIn" : { - "type" : "integer", - "format" : "int64", - "description" : "The size of hte FlowFiles that have been accepted in the last 5 minutes." - }, - "input" : { - "type" : "string", - "description" : "The count/size of flowfiles that have been accepted in the last 5 minutes." - }, - "flowFilesOut" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of FlowFiles that have been processed in the last 5 minutes." - }, - "bytesOut" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes that have been processed in the last 5 minutes." - }, - "output" : { - "type" : "string", - "description" : "The count/size of flowfiles that have been processed in the last 5 minutes." - }, - "transmitting" : { - "type" : "boolean", - "description" : "Whether the port has incoming or outgoing connections to a remote NiFi." - }, - "runStatus" : { - "type" : "string", - "description" : "The run status of the port.", - "enum" : [ "Running", "Stopped", "Validating", "Disabled", "Invalid" ] - } - } - }, - "PortStatusSnapshotEntity" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the port." - }, - "portStatusSnapshot" : { - "$ref" : "#/definitions/PortStatusSnapshotDTO" - }, - "canRead" : { - "type" : "boolean", - "description" : "Indicates whether the user can read a given resource.", - "readOnly" : true - } - }, - "xml" : { - "name" : "entity" - } - }, - "Position" : { - "type" : "object", - "properties" : { - "x" : { - "type" : "number", - "format" : "double", - "description" : "The x coordinate." - }, - "y" : { - "type" : "number", - "format" : "double", - "description" : "The y coordinate." - } - }, - "description" : "The position of a component on the graph" - }, - "PositionDTO" : { - "type" : "object", - "properties" : { - "x" : { - "type" : "number", - "format" : "double", - "description" : "The x coordinate." - }, - "y" : { - "type" : "number", - "format" : "double", - "description" : "The y coordinate." - } - } - }, - "PreviousValueDTO" : { - "type" : "object", - "properties" : { - "previousValue" : { - "type" : "string", - "description" : "The previous value." - }, - "timestamp" : { - "type" : "string", - "description" : "The timestamp when the value was modified." - }, - "userIdentity" : { - "type" : "string", - "description" : "The user who changed the previous value." - } - } - }, - "PrioritizerTypesEntity" : { - "type" : "object", - "properties" : { - "prioritizerTypes" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/DocumentedTypeDTO" - } - } - }, - "xml" : { - "name" : "prioritizerTypesEntity" - } - }, - "ProcessGroupDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "versionedComponentId" : { - "type" : "string", - "description" : "The ID of the corresponding component that is under version control" - }, - "parentGroupId" : { - "type" : "string", - "description" : "The id of parent process group of this component if applicable." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "name" : { - "type" : "string", - "description" : "The name of the process group." - }, - "comments" : { - "type" : "string", - "description" : "The comments for the process group." - }, - "variables" : { - "type" : "object", - "description" : "The variables that are configured for the Process Group. Note that this map contains only those variables that are defined on this Process Group and not any variables that are defined in the parent Process Group, etc. I.e., this Map will not contain all variables that are accessible by components in this Process Group by rather only the variables that are defined for this Process Group itself.", - "readOnly" : true, - "additionalProperties" : { - "type" : "string" - } - }, - "versionControlInformation" : { - "description" : "The Version Control information that indicates which Flow Registry, and where in the Flow Registry, this Process Group is tracking to; or null if this Process Group is not under version control", - "$ref" : "#/definitions/VersionControlInformationDTO" - }, - "parameterContext" : { - "description" : "The Parameter Context that this Process Group is bound to.", - "$ref" : "#/definitions/ParameterContextReferenceEntity" - }, - "runningCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of running components in this process group." - }, - "stoppedCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of stopped components in the process group." - }, - "invalidCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of invalid components in the process group." - }, - "disabledCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of disabled components in the process group." - }, - "activeRemotePortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of active remote ports in the process group." - }, - "inactiveRemotePortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of inactive remote ports in the process group." - }, - "upToDateCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of up to date versioned process groups in the process group." - }, - "locallyModifiedCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of locally modified versioned process groups in the process group." - }, - "staleCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of stale versioned process groups in the process group." - }, - "locallyModifiedAndStaleCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of locally modified and stale versioned process groups in the process group." - }, - "syncFailureCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of versioned process groups in the process group that are unable to sync to a registry." - }, - "localInputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of local input ports in the process group." - }, - "localOutputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of local output ports in the process group." - }, - "publicInputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of public input ports in the process group." - }, - "publicOutputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of public output ports in the process group." - }, - "contents" : { - "description" : "The contents of this process group.", - "$ref" : "#/definitions/FlowSnippetDTO" - }, - "inputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of input ports in the process group.", - "readOnly" : true - }, - "outputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of output ports in the process group.", - "readOnly" : true - } - } - }, - "ProcessGroupEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "component" : { - "$ref" : "#/definitions/ProcessGroupDTO" - }, - "status" : { - "description" : "The status of the process group.", - "$ref" : "#/definitions/ProcessGroupStatusDTO" - }, - "versionedFlowSnapshot" : { - "description" : "Returns the Versioned Flow that describes the contents of the Versioned Flow to be imported", - "readOnly" : true, - "$ref" : "#/definitions/VersionedFlowSnapshot" - }, - "runningCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of running components in this process group." - }, - "stoppedCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of stopped components in the process group." - }, - "invalidCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of invalid components in the process group." - }, - "disabledCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of disabled components in the process group." - }, - "activeRemotePortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of active remote ports in the process group." - }, - "inactiveRemotePortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of inactive remote ports in the process group." - }, - "versionedFlowState" : { - "type" : "string", - "description" : "The current state of the Process Group, as it relates to the Versioned Flow", - "readOnly" : true, - "enum" : [ "LOCALLY_MODIFIED", "STALE", "LOCALLY_MODIFIED_AND_STALE", "UP_TO_DATE", "SYNC_FAILURE" ] - }, - "upToDateCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of up to date versioned process groups in the process group." - }, - "locallyModifiedCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of locally modified versioned process groups in the process group." - }, - "staleCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of stale versioned process groups in the process group." - }, - "locallyModifiedAndStaleCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of locally modified and stale versioned process groups in the process group." - }, - "syncFailureCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of versioned process groups in the process group that are unable to sync to a registry." - }, - "localInputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of local input ports in the process group." - }, - "localOutputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of local output ports in the process group." - }, - "publicInputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of public input ports in the process group." - }, - "publicOutputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of public output ports in the process group." - }, - "parameterContext" : { - "description" : "The Parameter Context, or null if no Parameter Context has been bound to the Process Group", - "$ref" : "#/definitions/ParameterContextReferenceEntity" - }, - "inputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of input ports in the process group.", - "readOnly" : true - }, - "outputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of output ports in the process group.", - "readOnly" : true - } - }, - "xml" : { - "name" : "processGroupEntity" - } - }, - "ProcessGroupFlowDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "parentGroupId" : { - "type" : "string", - "description" : "The id of parent process group of this component if applicable." - }, - "parameterContext" : { - "description" : "The Parameter Context, or null if no Parameter Context has been bound to the Process Group", - "$ref" : "#/definitions/ParameterContextReferenceEntity" - }, - "breadcrumb" : { - "description" : "The breadcrumb of the process group.", - "$ref" : "#/definitions/FlowBreadcrumbEntity" - }, - "flow" : { - "description" : "The flow structure starting at this Process Group.", - "$ref" : "#/definitions/FlowDTO" - }, - "lastRefreshed" : { - "type" : "string", - "description" : "The time the flow for the process group was last refreshed." - } - } - }, - "ProcessGroupFlowEntity" : { - "type" : "object", - "properties" : { - "permissions" : { - "description" : "The access policy for this process group.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "processGroupFlow" : { - "$ref" : "#/definitions/ProcessGroupFlowDTO" - } - }, - "xml" : { - "name" : "processGroupFlowEntity" - } - }, - "ProcessGroupNameDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The ID of the Process Group" - }, - "name" : { - "type" : "string", - "description" : "The name of the Process Group, or the ID of the Process Group if the user does not have the READ policy for the Process Group" - } - } - }, - "ProcessGroupStatusDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The ID of the Process Group" - }, - "name" : { - "type" : "string", - "description" : "The name of the Process Group" - }, - "statsLastRefreshed" : { - "type" : "string", - "description" : "The time the status for the process group was last refreshed." - }, - "aggregateSnapshot" : { - "description" : "The aggregate status of all nodes in the cluster", - "$ref" : "#/definitions/ProcessGroupStatusSnapshotDTO" - }, - "nodeSnapshots" : { - "type" : "array", - "description" : "The status reported by each node in the cluster. If the NiFi instance is a standalone instance, rather than a clustered instance, this value may be null.", - "items" : { - "$ref" : "#/definitions/NodeProcessGroupStatusSnapshotDTO" - } - } - } - }, - "ProcessGroupStatusEntity" : { - "type" : "object", - "properties" : { - "processGroupStatus" : { - "$ref" : "#/definitions/ProcessGroupStatusDTO" - }, - "canRead" : { - "type" : "boolean", - "description" : "Indicates whether the user can read a given resource.", - "readOnly" : true - } - }, - "xml" : { - "name" : "processGroupStatusEntity" - } - }, - "ProcessGroupStatusSnapshotDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the process group." - }, - "name" : { - "type" : "string", - "description" : "The name of this process group." - }, - "connectionStatusSnapshots" : { - "type" : "array", - "description" : "The status of all connections in the process group.", - "items" : { - "$ref" : "#/definitions/ConnectionStatusSnapshotEntity" - } - }, - "processorStatusSnapshots" : { - "type" : "array", - "description" : "The status of all processors in the process group.", - "items" : { - "$ref" : "#/definitions/ProcessorStatusSnapshotEntity" - } - }, - "processGroupStatusSnapshots" : { - "type" : "array", - "description" : "The status of all process groups in the process group.", - "items" : { - "$ref" : "#/definitions/ProcessGroupStatusSnapshotEntity" - } - }, - "remoteProcessGroupStatusSnapshots" : { - "type" : "array", - "description" : "The status of all remote process groups in the process group.", - "items" : { - "$ref" : "#/definitions/RemoteProcessGroupStatusSnapshotEntity" - } - }, - "inputPortStatusSnapshots" : { - "type" : "array", - "description" : "The status of all input ports in the process group.", - "items" : { - "$ref" : "#/definitions/PortStatusSnapshotEntity" - } - }, - "outputPortStatusSnapshots" : { - "type" : "array", - "description" : "The status of all output ports in the process group.", - "items" : { - "$ref" : "#/definitions/PortStatusSnapshotEntity" - } - }, - "versionedFlowState" : { - "type" : "string", - "description" : "The current state of the Process Group, as it relates to the Versioned Flow", - "readOnly" : true, - "enum" : [ "LOCALLY_MODIFIED", "STALE", "LOCALLY_MODIFIED_AND_STALE", "UP_TO_DATE", "SYNC_FAILURE" ] - }, - "flowFilesIn" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of FlowFiles that have come into this ProcessGroup in the last 5 minutes" - }, - "bytesIn" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes that have come into this ProcessGroup in the last 5 minutes" - }, - "input" : { - "type" : "string", - "description" : "The input count/size for the process group in the last 5 minutes (pretty printed)." - }, - "flowFilesQueued" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of FlowFiles that are queued up in this ProcessGroup right now" - }, - "bytesQueued" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes that are queued up in this ProcessGroup right now" - }, - "queued" : { - "type" : "string", - "description" : "The count/size that is queued in the the process group." - }, - "queuedCount" : { - "type" : "string", - "description" : "The count that is queued for the process group." - }, - "queuedSize" : { - "type" : "string", - "description" : "The size that is queued for the process group." - }, - "bytesRead" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes read by components in this ProcessGroup in the last 5 minutes" - }, - "read" : { - "type" : "string", - "description" : "The number of bytes read in the last 5 minutes." - }, - "bytesWritten" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes written by components in this ProcessGroup in the last 5 minutes" - }, - "written" : { - "type" : "string", - "description" : "The number of bytes written in the last 5 minutes." - }, - "flowFilesOut" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of FlowFiles transferred out of this ProcessGroup in the last 5 minutes" - }, - "bytesOut" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes transferred out of this ProcessGroup in the last 5 minutes" - }, - "output" : { - "type" : "string", - "description" : "The output count/size for the process group in the last 5 minutes." - }, - "flowFilesTransferred" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of FlowFiles transferred in this ProcessGroup in the last 5 minutes" - }, - "bytesTransferred" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes transferred in this ProcessGroup in the last 5 minutes" - }, - "transferred" : { - "type" : "string", - "description" : "The count/size transferred to/from queues in the process group in the last 5 minutes." - }, - "bytesReceived" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes received from external sources by components within this ProcessGroup in the last 5 minutes" - }, - "flowFilesReceived" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of FlowFiles received from external sources by components within this ProcessGroup in the last 5 minutes" - }, - "received" : { - "type" : "string", - "description" : "The count/size sent to the process group in the last 5 minutes." - }, - "bytesSent" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes sent to an external sink by components within this ProcessGroup in the last 5 minutes" - }, - "flowFilesSent" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of FlowFiles sent to an external sink by components within this ProcessGroup in the last 5 minutes" - }, - "sent" : { - "type" : "string", - "description" : "The count/size sent from this process group in the last 5 minutes." - }, - "activeThreadCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The active thread count for this process group." - }, - "terminatedThreadCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of threads currently terminated for the process group." - } - } - }, - "ProcessGroupStatusSnapshotEntity" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the process group." - }, - "processGroupStatusSnapshot" : { - "$ref" : "#/definitions/ProcessGroupStatusSnapshotDTO" - }, - "canRead" : { - "type" : "boolean", - "description" : "Indicates whether the user can read a given resource.", - "readOnly" : true - } - }, - "xml" : { - "name" : "entity" - } - }, - "ProcessGroupsEntity" : { - "type" : "object", - "properties" : { - "processGroups" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ProcessGroupEntity" - } - } - }, - "xml" : { - "name" : "processGroupsEntity" - } - }, - "ProcessorConfigDTO" : { - "type" : "object", - "properties" : { - "properties" : { - "type" : "object", - "description" : "The properties for the processor. Properties whose value is not set will only contain the property name.", - "additionalProperties" : { - "type" : "string" - } - }, - "descriptors" : { - "type" : "object", - "description" : "Descriptors for the processor's properties.", - "additionalProperties" : { - "$ref" : "#/definitions/PropertyDescriptorDTO" - } - }, - "schedulingPeriod" : { - "type" : "string", - "description" : "The frequency with which to schedule the processor. The format of the value will depend on th value of schedulingStrategy." - }, - "schedulingStrategy" : { - "type" : "string", - "description" : "Indcates whether the prcessor should be scheduled to run in event or timer driven mode." - }, - "executionNode" : { - "type" : "string", - "description" : "Indicates the node where the process will execute." - }, - "penaltyDuration" : { - "type" : "string", - "description" : "The amount of time that is used when the process penalizes a flowfile." - }, - "yieldDuration" : { - "type" : "string", - "description" : "The amount of time that must elapse before this processor is scheduled again after yielding." - }, - "bulletinLevel" : { - "type" : "string", - "description" : "The level at which the processor will report bulletins." - }, - "runDurationMillis" : { - "type" : "integer", - "format" : "int64", - "description" : "The run duration for the processor in milliseconds." - }, - "concurrentlySchedulableTaskCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of tasks that should be concurrently schedule for the processor. If the processor doesn't allow parallol processing then any positive input will be ignored." - }, - "autoTerminatedRelationships" : { - "type" : "array", - "description" : "The names of all relationships that cause a flow file to be terminated if the relationship is not connected elsewhere. This property differs from the 'isAutoTerminate' property of the RelationshipDTO in that the RelationshipDTO is meant to depict the current configuration, whereas this property can be set in a DTO when updating a Processor in order to change which Relationships should be auto-terminated.", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - }, - "comments" : { - "type" : "string", - "description" : "The comments for the processor." - }, - "customUiUrl" : { - "type" : "string", - "description" : "The URL for the processor's custom configuration UI if applicable." - }, - "lossTolerant" : { - "type" : "boolean", - "description" : "Whether the processor is loss tolerant." - }, - "annotationData" : { - "type" : "string", - "description" : "The annotation data for the processor used to relay configuration between a custom UI and the procesosr." - }, - "defaultConcurrentTasks" : { - "type" : "object", - "description" : "Maps default values for concurrent tasks for each applicable scheduling strategy.", - "additionalProperties" : { - "type" : "string" - } - }, - "defaultSchedulingPeriod" : { - "type" : "object", - "description" : "Maps default values for scheduling period for each applicable scheduling strategy.", - "additionalProperties" : { - "type" : "string" - } - } - } - }, - "ProcessorDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "versionedComponentId" : { - "type" : "string", - "description" : "The ID of the corresponding component that is under version control" - }, - "parentGroupId" : { - "type" : "string", - "description" : "The id of parent process group of this component if applicable." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "name" : { - "type" : "string", - "description" : "The name of the processor." - }, - "type" : { - "type" : "string", - "description" : "The type of the processor." - }, - "bundle" : { - "description" : "The details of the artifact that bundled this processor type.", - "$ref" : "#/definitions/BundleDTO" - }, - "state" : { - "type" : "string", - "description" : "The state of the processor", - "enum" : [ "RUNNING", "STOPPED", "DISABLED" ] - }, - "style" : { - "type" : "object", - "description" : "Styles for the processor (background-color : #eee).", - "additionalProperties" : { - "type" : "string" - } - }, - "relationships" : { - "type" : "array", - "description" : "The available relationships that the processor currently supports.", - "readOnly" : true, - "items" : { - "$ref" : "#/definitions/RelationshipDTO" - } - }, - "description" : { - "type" : "string", - "description" : "The description of the processor." - }, - "supportsParallelProcessing" : { - "type" : "boolean", - "description" : "Whether the processor supports parallel processing." - }, - "supportsEventDriven" : { - "type" : "boolean", - "description" : "Whether the processor supports event driven scheduling." - }, - "supportsBatching" : { - "type" : "boolean", - "description" : "Whether the processor supports batching. This makes the run duration settings available." - }, - "persistsState" : { - "type" : "boolean", - "description" : "Whether the processor persists state." - }, - "restricted" : { - "type" : "boolean", - "description" : "Whether the processor requires elevated privileges." - }, - "deprecated" : { - "type" : "boolean", - "description" : "Whether the processor has been deprecated." - }, - "executionNodeRestricted" : { - "type" : "boolean", - "description" : "Indicates if the execution node of a processor is restricted to run only on the primary node" - }, - "multipleVersionsAvailable" : { - "type" : "boolean", - "description" : "Whether the processor has multiple versions available." - }, - "inputRequirement" : { - "type" : "string", - "description" : "The input requirement for this processor." - }, - "config" : { - "description" : "The configuration details for the processor. These details will be included in a response if the verbose flag is included in a request.", - "$ref" : "#/definitions/ProcessorConfigDTO" - }, - "validationErrors" : { - "type" : "array", - "description" : "The validation errors for the processor. These validation errors represent the problems with the processor that must be resolved before it can be started.", - "items" : { - "type" : "string" - } - }, - "validationStatus" : { - "type" : "string", - "description" : "Indicates whether the Processor is valid, invalid, or still in the process of validating (i.e., it is unknown whether or not the Processor is valid)", - "readOnly" : true, - "enum" : [ "VALID", "INVALID", "VALIDATING" ] - }, - "extensionMissing" : { - "type" : "boolean", - "description" : "Whether the underlying extension is missing." - } - } - }, - "ProcessorEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "component" : { - "$ref" : "#/definitions/ProcessorDTO" - }, - "inputRequirement" : { - "type" : "string", - "description" : "The input requirement for this processor." - }, - "status" : { - "$ref" : "#/definitions/ProcessorStatusDTO" - }, - "operatePermissions" : { - "description" : "The permissions for this component operations.", - "$ref" : "#/definitions/PermissionsDTO" - } - }, - "xml" : { - "name" : "processorEntity" - } - }, - "ProcessorRunStatusEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "state" : { - "type" : "string", - "description" : "The run status of the Processor.", - "enum" : [ "RUNNING", "STOPPED", "DISABLED" ] - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - } - }, - "xml" : { - "name" : "entity" - } - }, - "ProcessorStatusDTO" : { - "type" : "object", - "properties" : { - "groupId" : { - "type" : "string", - "description" : "The unique ID of the process group that the Processor belongs to" - }, - "id" : { - "type" : "string", - "description" : "The unique ID of the Processor" - }, - "name" : { - "type" : "string", - "description" : "The name of the Processor" - }, - "type" : { - "type" : "string", - "description" : "The type of the Processor" - }, - "runStatus" : { - "type" : "string", - "description" : "The run status of the Processor", - "enum" : [ "Running", "Stopped", "Validating", "Disabled", "Invalid" ] - }, - "statsLastRefreshed" : { - "type" : "string", - "description" : "The timestamp of when the stats were last refreshed" - }, - "aggregateSnapshot" : { - "description" : "A status snapshot that represents the aggregate stats of all nodes in the cluster. If the NiFi instance is a standalone instance, rather than a cluster, this represents the stats of the single instance.", - "$ref" : "#/definitions/ProcessorStatusSnapshotDTO" - }, - "nodeSnapshots" : { - "type" : "array", - "description" : "A status snapshot for each node in the cluster. If the NiFi instance is a standalone instance, rather than a cluster, this may be null.", - "items" : { - "$ref" : "#/definitions/NodeProcessorStatusSnapshotDTO" - } - } - } - }, - "ProcessorStatusEntity" : { - "type" : "object", - "properties" : { - "processorStatus" : { - "$ref" : "#/definitions/ProcessorStatusDTO" - }, - "canRead" : { - "type" : "boolean", - "description" : "Indicates whether the user can read a given resource.", - "readOnly" : true - } - }, - "xml" : { - "name" : "processorStatusEntity" - } - }, - "ProcessorStatusSnapshotDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the processor." - }, - "groupId" : { - "type" : "string", - "description" : "The id of the parent process group to which the processor belongs." - }, - "name" : { - "type" : "string", - "description" : "The name of the prcessor." - }, - "type" : { - "type" : "string", - "description" : "The type of the processor." - }, - "runStatus" : { - "type" : "string", - "description" : "The state of the processor.", - "enum" : [ "Running", "Stopped", "Validating", "Disabled", "Invalid" ] - }, - "executionNode" : { - "type" : "string", - "description" : "Indicates the node where the process will execute.", - "enum" : [ "ALL", "PRIMARY" ] - }, - "bytesRead" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes read by this Processor in the last 5 mintues" - }, - "bytesWritten" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes written by this Processor in the last 5 minutes" - }, - "read" : { - "type" : "string", - "description" : "The number of bytes read in the last 5 minutes." - }, - "written" : { - "type" : "string", - "description" : "The number of bytes written in the last 5 minutes." - }, - "flowFilesIn" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of FlowFiles that have been accepted in the last 5 minutes" - }, - "bytesIn" : { - "type" : "integer", - "format" : "int64", - "description" : "The size of the FlowFiles that have been accepted in the last 5 minutes" - }, - "input" : { - "type" : "string", - "description" : "The count/size of flowfiles that have been accepted in the last 5 minutes." - }, - "flowFilesOut" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of FlowFiles transferred to a Connection in the last 5 minutes" - }, - "bytesOut" : { - "type" : "integer", - "format" : "int64", - "description" : "The size of the FlowFiles transferred to a Connection in the last 5 minutes" - }, - "output" : { - "type" : "string", - "description" : "The count/size of flowfiles that have been processed in the last 5 minutes." - }, - "taskCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of times this Processor has run in the last 5 minutes" - }, - "tasksDurationNanos" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of nanoseconds that this Processor has spent running in the last 5 minutes" - }, - "tasks" : { - "type" : "string", - "description" : "The total number of task this connectable has completed over the last 5 minutes." - }, - "tasksDuration" : { - "type" : "string", - "description" : "The total duration of all tasks for this connectable over the last 5 minutes." - }, - "activeThreadCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of threads currently executing in the processor." - }, - "terminatedThreadCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of threads currently terminated for the processor." - } - } - }, - "ProcessorStatusSnapshotEntity" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the processor." - }, - "processorStatusSnapshot" : { - "$ref" : "#/definitions/ProcessorStatusSnapshotDTO" - }, - "canRead" : { - "type" : "boolean", - "description" : "Indicates whether the user can read a given resource.", - "readOnly" : true - } - }, - "xml" : { - "name" : "entity" - } - }, - "ProcessorTypesEntity" : { - "type" : "object", - "properties" : { - "processorTypes" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/DocumentedTypeDTO" - } - } - }, - "xml" : { - "name" : "processorTypesEntity" - } - }, - "ProcessorsEntity" : { - "type" : "object", - "properties" : { - "processors" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ProcessorEntity" - } - } - }, - "xml" : { - "name" : "processorsEntity" - } - }, - "PropertyDescriptorDTO" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The name for the property." - }, - "displayName" : { - "type" : "string", - "description" : "The human readable name for the property." - }, - "description" : { - "type" : "string", - "description" : "The description for the property. Used to relay additional details to a user or provide a mechanism of documenting intent." - }, - "defaultValue" : { - "type" : "string", - "description" : "The default value for the property." - }, - "allowableValues" : { - "type" : "array", - "description" : "Allowable values for the property. If empty then the allowed values are not constrained.", - "items" : { - "$ref" : "#/definitions/AllowableValueEntity" - } - }, - "required" : { - "type" : "boolean", - "description" : "Whether the property is required." - }, - "sensitive" : { - "type" : "boolean", - "description" : "Whether the property is sensitive and protected whenever stored or represented." - }, - "dynamic" : { - "type" : "boolean", - "description" : "Whether the property is dynamic (user-defined)." - }, - "supportsEl" : { - "type" : "boolean", - "description" : "Whether the property supports expression language." - }, - "expressionLanguageScope" : { - "type" : "string", - "description" : "Scope of the Expression Language evaluation for the property." - }, - "identifiesControllerService" : { - "type" : "string", - "description" : "If the property identifies a controller service this returns the fully qualified type." - }, - "identifiesControllerServiceBundle" : { - "description" : "If the property identifies a controller service this returns the bundle of the type, null otherwise.", - "$ref" : "#/definitions/BundleDTO" - } - } - }, - "PropertyDescriptorEntity" : { - "type" : "object", - "properties" : { - "propertyDescriptor" : { - "$ref" : "#/definitions/PropertyDescriptorDTO" - } - }, - "xml" : { - "name" : "propertyDescriptor" - } - }, - "PropertyHistoryDTO" : { - "type" : "object", - "properties" : { - "previousValues" : { - "type" : "array", - "description" : "Previous values for a given property.", - "items" : { - "$ref" : "#/definitions/PreviousValueDTO" - } - } - } - }, - "ProvenanceDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the provenance query." - }, - "uri" : { - "type" : "string", - "description" : "The URI for this query. Used for obtaining/deleting the request at a later time" - }, - "submissionTime" : { - "type" : "string", - "description" : "The timestamp when the query was submitted." - }, - "expiration" : { - "type" : "string", - "description" : "The timestamp when the query will expire." - }, - "percentCompleted" : { - "type" : "integer", - "format" : "int32", - "description" : "The current percent complete." - }, - "finished" : { - "type" : "boolean", - "description" : "Whether the query has finished." - }, - "request" : { - "description" : "The provenance request.", - "$ref" : "#/definitions/ProvenanceRequestDTO" - }, - "results" : { - "description" : "The provenance results.", - "$ref" : "#/definitions/ProvenanceResultsDTO" - } - } - }, - "ProvenanceEntity" : { - "type" : "object", - "properties" : { - "provenance" : { - "$ref" : "#/definitions/ProvenanceDTO" - } - }, - "xml" : { - "name" : "provenanceEntity" - } - }, - "ProvenanceEventDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The event uuid." - }, - "eventId" : { - "type" : "integer", - "format" : "int64", - "description" : "The event id. This is a one up number thats unique per node." - }, - "eventTime" : { - "type" : "string", - "description" : "The timestamp of the event." - }, - "eventDuration" : { - "type" : "integer", - "format" : "int64", - "description" : "The event duration in milliseconds." - }, - "lineageDuration" : { - "type" : "integer", - "format" : "int64", - "description" : "The duration since the lineage began, in milliseconds." - }, - "eventType" : { - "type" : "string", - "description" : "The type of the event." - }, - "flowFileUuid" : { - "type" : "string", - "description" : "The uuid of the flowfile for the event." - }, - "fileSize" : { - "type" : "string", - "description" : "The size of the flowfile for the event." - }, - "fileSizeBytes" : { - "type" : "integer", - "format" : "int64", - "description" : "The size of the flowfile in bytes for the event." - }, - "clusterNodeId" : { - "type" : "string", - "description" : "The identifier for the node where the event originated." - }, - "clusterNodeAddress" : { - "type" : "string", - "description" : "The label for the node where the event originated." - }, - "groupId" : { - "type" : "string", - "description" : "The id of the group that the component resides in. If the component is no longer in the flow, the group id will not be set." - }, - "componentId" : { - "type" : "string", - "description" : "The id of the component that generated the event." - }, - "componentType" : { - "type" : "string", - "description" : "The type of the component that generated the event." - }, - "componentName" : { - "type" : "string", - "description" : "The name of the component that generated the event." - }, - "sourceSystemFlowFileId" : { - "type" : "string", - "description" : "The source system flowfile id." - }, - "alternateIdentifierUri" : { - "type" : "string", - "description" : "The alternate identifier uri for the fileflow for the event." - }, - "attributes" : { - "type" : "array", - "description" : "The attributes of the flowfile for the event.", - "items" : { - "$ref" : "#/definitions/AttributeDTO" - } - }, - "parentUuids" : { - "type" : "array", - "description" : "The parent uuids for the event.", - "items" : { - "type" : "string" - } - }, - "childUuids" : { - "type" : "array", - "description" : "The child uuids for the event.", - "items" : { - "type" : "string" - } - }, - "transitUri" : { - "type" : "string", - "description" : "The source/destination system uri if the event was a RECEIVE/SEND." - }, - "relationship" : { - "type" : "string", - "description" : "The relationship to which the flowfile was routed if the event is of type ROUTE." - }, - "details" : { - "type" : "string", - "description" : "The event details." - }, - "contentEqual" : { - "type" : "boolean", - "description" : "Whether the input and output content claim is the same." - }, - "inputContentAvailable" : { - "type" : "boolean", - "description" : "Whether the input content is still available." - }, - "inputContentClaimSection" : { - "type" : "string", - "description" : "The section in which the input content claim lives." - }, - "inputContentClaimContainer" : { - "type" : "string", - "description" : "The container in which the input content claim lives." - }, - "inputContentClaimIdentifier" : { - "type" : "string", - "description" : "The identifier of the input content claim." - }, - "inputContentClaimOffset" : { - "type" : "integer", - "format" : "int64", - "description" : "The offset into the input content claim where the flowfiles content begins." - }, - "inputContentClaimFileSize" : { - "type" : "string", - "description" : "The file size of the input content claim formatted." - }, - "inputContentClaimFileSizeBytes" : { - "type" : "integer", - "format" : "int64", - "description" : "The file size of the intput content claim in bytes." - }, - "outputContentAvailable" : { - "type" : "boolean", - "description" : "Whether the output content is still available." - }, - "outputContentClaimSection" : { - "type" : "string", - "description" : "The section in which the output content claim lives." - }, - "outputContentClaimContainer" : { - "type" : "string", - "description" : "The container in which the output content claim lives." - }, - "outputContentClaimIdentifier" : { - "type" : "string", - "description" : "The identifier of the output content claim." - }, - "outputContentClaimOffset" : { - "type" : "integer", - "format" : "int64", - "description" : "The offset into the output content claim where the flowfiles content begins." - }, - "outputContentClaimFileSize" : { - "type" : "string", - "description" : "The file size of the output content claim formatted." - }, - "outputContentClaimFileSizeBytes" : { - "type" : "integer", - "format" : "int64", - "description" : "The file size of the output content claim in bytes." - }, - "replayAvailable" : { - "type" : "boolean", - "description" : "Whether or not replay is available." - }, - "replayExplanation" : { - "type" : "string", - "description" : "Explanation as to why replay is unavailable." - }, - "sourceConnectionIdentifier" : { - "type" : "string", - "description" : "The identifier of the queue/connection from which the flowfile was pulled to genereate this event. May be null if the queue/connection is unknown or the flowfile was generated from this event." - } - } - }, - "ProvenanceEventEntity" : { - "type" : "object", - "properties" : { - "provenanceEvent" : { - "$ref" : "#/definitions/ProvenanceEventDTO" - } - }, - "xml" : { - "name" : "provenanceEventEntity" - } - }, - "ProvenanceLinkDTO" : { - "type" : "object", - "properties" : { - "sourceId" : { - "type" : "string", - "description" : "The source node id of the link." - }, - "targetId" : { - "type" : "string", - "description" : "The target node id of the link." - }, - "flowFileUuid" : { - "type" : "string", - "description" : "The flowfile uuid that traversed the link." - }, - "timestamp" : { - "type" : "string", - "description" : "The timestamp of the link (based on the destination)." - }, - "millis" : { - "type" : "integer", - "format" : "int64", - "description" : "The timestamp of this link in milliseconds." - } - } - }, - "ProvenanceNodeDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the node." - }, - "flowFileUuid" : { - "type" : "string", - "description" : "The uuid of the flowfile associated with the provenance event." - }, - "parentUuids" : { - "type" : "array", - "description" : "The uuid of the parent flowfiles of the provenance event.", - "items" : { - "type" : "string" - } - }, - "childUuids" : { - "type" : "array", - "description" : "The uuid of the childrent flowfiles of the provenance event.", - "items" : { - "type" : "string" - } - }, - "clusterNodeIdentifier" : { - "type" : "string", - "description" : "The identifier of the node that this event/flowfile originated from." - }, - "type" : { - "type" : "string", - "description" : "The type of the node.", - "enum" : [ "FLOWFILE", "EVENT" ] - }, - "eventType" : { - "type" : "string", - "description" : "If the type is EVENT, this is the type of event." - }, - "millis" : { - "type" : "integer", - "format" : "int64", - "description" : "The timestamp of the node in milliseconds." - }, - "timestamp" : { - "type" : "string", - "description" : "The timestamp of the node formatted." - } - } - }, - "ProvenanceOptionsDTO" : { - "type" : "object", - "properties" : { - "searchableFields" : { - "type" : "array", - "description" : "The available searchable field for the NiFi.", - "items" : { - "$ref" : "#/definitions/ProvenanceSearchableFieldDTO" - } - } - } - }, - "ProvenanceOptionsEntity" : { - "type" : "object", - "properties" : { - "provenanceOptions" : { - "$ref" : "#/definitions/ProvenanceOptionsDTO" - } - }, - "xml" : { - "name" : "provenanceOptionsEntity" - } - }, - "ProvenanceRequestDTO" : { - "type" : "object", - "properties" : { - "searchTerms" : { - "type" : "object", - "description" : "The search terms used to perform the search.", - "additionalProperties" : { - "type" : "string" - } - }, - "clusterNodeId" : { - "type" : "string", - "description" : "The id of the node in the cluster where this provenance originated." - }, - "startDate" : { - "type" : "string", - "description" : "The earliest event time to include in the query." - }, - "endDate" : { - "type" : "string", - "description" : "The latest event time to include in the query." - }, - "minimumFileSize" : { - "type" : "string", - "description" : "The minimum file size to include in the query." - }, - "maximumFileSize" : { - "type" : "string", - "description" : "The maximum file size to include in the query." - }, - "maxResults" : { - "type" : "integer", - "format" : "int32", - "description" : "The maximum number of results to include." - }, - "summarize" : { - "type" : "boolean", - "description" : "Whether or not to summarize provenance events returned. This property is false by default." - }, - "incrementalResults" : { - "type" : "boolean", - "description" : "Whether or not incremental results are returned. If false, provenance events are only returned once the query completes. This property is true by default." - } - } - }, - "ProvenanceResultsDTO" : { - "type" : "object", - "properties" : { - "provenanceEvents" : { - "type" : "array", - "description" : "The provenance events that matched the search criteria.", - "items" : { - "$ref" : "#/definitions/ProvenanceEventDTO" - } - }, - "total" : { - "type" : "string", - "description" : "The total number of results formatted." - }, - "totalCount" : { - "type" : "integer", - "format" : "int64", - "description" : "The total number of results." - }, - "generated" : { - "type" : "string", - "description" : "Then the search was performed." - }, - "oldestEvent" : { - "type" : "string", - "description" : "The oldest event available in the provenance repository." - }, - "timeOffset" : { - "type" : "integer", - "format" : "int32", - "description" : "The time offset of the server that's used for event time." - }, - "errors" : { - "type" : "array", - "description" : "Any errors that occurred while performing the provenance request.", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - } - } - }, - "ProvenanceSearchableFieldDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the searchable field." - }, - "field" : { - "type" : "string", - "description" : "The searchable field." - }, - "label" : { - "type" : "string", - "description" : "The label for the searchable field." - }, - "type" : { - "type" : "string", - "description" : "The type of the searchable field." - } - } - }, - "QueueSizeDTO" : { - "type" : "object", - "properties" : { - "byteCount" : { - "type" : "integer", - "format" : "int64", - "description" : "The size of objects in a queue." - }, - "objectCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The count of objects in a queue." - } - } - }, - "RegistryClientEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "component" : { - "$ref" : "#/definitions/RegistryDTO" - } - }, - "xml" : { - "name" : "registryClientEntity" - } - }, - "RegistryClientsEntity" : { - "type" : "object", - "properties" : { - "registries" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/RegistryClientEntity" - } - } - }, - "xml" : { - "name" : "registryClientsEntity" - } - }, - "RegistryDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The registry identifier" - }, - "name" : { - "type" : "string", - "description" : "The registry name" - }, - "description" : { - "type" : "string", - "description" : "The registry description" - }, - "uri" : { - "type" : "string", - "description" : "The registry URI" - } - } - }, - "RelationshipDTO" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The relationship name." - }, - "description" : { - "type" : "string", - "description" : "The relationship description." - }, - "autoTerminate" : { - "type" : "boolean", - "description" : "Whether or not flowfiles sent to this relationship should auto terminate." - } - } - }, - "RemotePortRunStatusEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "state" : { - "type" : "string", - "description" : "The run status of the RemotePort.", - "enum" : [ "TRANSMITTING", "STOPPED" ] - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - } - }, - "xml" : { - "name" : "entity" - } - }, - "RemoteProcessGroupContentsDTO" : { - "type" : "object", - "properties" : { - "inputPorts" : { - "type" : "array", - "description" : "The input ports to which data can be sent.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/RemoteProcessGroupPortDTO" - } - }, - "outputPorts" : { - "type" : "array", - "description" : "The output ports from which data can be retrieved.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/RemoteProcessGroupPortDTO" - } - } - } - }, - "RemoteProcessGroupDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "versionedComponentId" : { - "type" : "string", - "description" : "The ID of the corresponding component that is under version control" - }, - "parentGroupId" : { - "type" : "string", - "description" : "The id of parent process group of this component if applicable." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "targetUri" : { - "type" : "string", - "description" : "The target URI of the remote process group. If target uri is not set, but uris are set, then returns the first url in the urls. If neither target uri nor uris are set, then returns null." - }, - "targetUris" : { - "type" : "string", - "description" : "The target URI of the remote process group. If target uris is not set but target uri is set, then returns a collection containing the single target uri. If neither target uris nor uris are set, then returns null." - }, - "targetSecure" : { - "type" : "boolean", - "description" : "Whether the target is running securely." - }, - "name" : { - "type" : "string", - "description" : "The name of the remote process group." - }, - "comments" : { - "type" : "string", - "description" : "The comments for the remote process group." - }, - "communicationsTimeout" : { - "type" : "string", - "description" : "The time period used for the timeout when communicating with the target." - }, - "yieldDuration" : { - "type" : "string", - "description" : "When yielding, this amount of time must elapse before the remote process group is scheduled again." - }, - "transportProtocol" : { - "type" : "string" - }, - "localNetworkInterface" : { - "type" : "string", - "description" : "The local network interface to send/receive data. If not specified, any local address is used. If clustered, all nodes must have an interface with this identifier." - }, - "proxyHost" : { - "type" : "string" - }, - "proxyPort" : { - "type" : "integer", - "format" : "int32" - }, - "proxyUser" : { - "type" : "string" - }, - "proxyPassword" : { - "type" : "string" - }, - "authorizationIssues" : { - "type" : "array", - "description" : "Any remote authorization issues for the remote process group.", - "items" : { - "type" : "string" - } - }, - "validationErrors" : { - "type" : "array", - "description" : "The validation errors for the remote process group. These validation errors represent the problems with the remote process group that must be resolved before it can transmit.", - "items" : { - "type" : "string" - } - }, - "transmitting" : { - "type" : "boolean", - "description" : "Whether the remote process group is actively transmitting." - }, - "inputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of remote input ports currently available on the target." - }, - "outputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of remote output ports currently available on the target." - }, - "activeRemoteInputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of active remote input ports." - }, - "inactiveRemoteInputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of inactive remote input ports." - }, - "activeRemoteOutputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of active remote output ports." - }, - "inactiveRemoteOutputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of inactive remote output ports." - }, - "flowRefreshed" : { - "type" : "string", - "description" : "The timestamp when this remote process group was last refreshed." - }, - "contents" : { - "description" : "The contents of the remote process group. Will contain available input/output ports.", - "$ref" : "#/definitions/RemoteProcessGroupContentsDTO" - } - } - }, - "RemoteProcessGroupEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "component" : { - "$ref" : "#/definitions/RemoteProcessGroupDTO" - }, - "status" : { - "description" : "The status of the remote process group.", - "$ref" : "#/definitions/RemoteProcessGroupStatusDTO" - }, - "inputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of remote input ports currently available on the target." - }, - "outputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of remote output ports currently available on the target." - }, - "operatePermissions" : { - "description" : "The permissions for this component operations.", - "$ref" : "#/definitions/PermissionsDTO" - } - }, - "xml" : { - "name" : "remoteProcessGroupEntity" - } - }, - "RemoteProcessGroupPortDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the port." - }, - "targetId" : { - "type" : "string", - "description" : "The id of the target port." - }, - "versionedComponentId" : { - "type" : "string", - "description" : "The ID of the corresponding component that is under version control" - }, - "groupId" : { - "type" : "string", - "description" : "The id of the remote process group that the port resides in." - }, - "name" : { - "type" : "string", - "description" : "The name of the target port." - }, - "comments" : { - "type" : "string", - "description" : "The comments as configured on the target port." - }, - "concurrentlySchedulableTaskCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of task that may transmit flowfiles to the target port concurrently." - }, - "transmitting" : { - "type" : "boolean", - "description" : "Whether the remote port is configured for transmission." - }, - "useCompression" : { - "type" : "boolean", - "description" : "Whether the flowfiles are compressed when sent to the target port." - }, - "exists" : { - "type" : "boolean", - "description" : "Whether the target port exists." - }, - "targetRunning" : { - "type" : "boolean", - "description" : "Whether the target port is running." - }, - "connected" : { - "type" : "boolean", - "description" : "Whether the port has either an incoming or outgoing connection." - }, - "batchSettings" : { - "description" : "The batch settings for data transmission.", - "$ref" : "#/definitions/BatchSettingsDTO" - } - } - }, - "RemoteProcessGroupPortEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "remoteProcessGroupPort" : { - "$ref" : "#/definitions/RemoteProcessGroupPortDTO" - }, - "operatePermissions" : { - "description" : "The permissions for this component operations.", - "$ref" : "#/definitions/PermissionsDTO" - } - }, - "xml" : { - "name" : "remoteProcessGroupPortEntity" - } - }, - "RemoteProcessGroupStatusDTO" : { - "type" : "object", - "properties" : { - "groupId" : { - "type" : "string", - "description" : "The unique ID of the process group that the Processor belongs to" - }, - "id" : { - "type" : "string", - "description" : "The unique ID of the Processor" - }, - "name" : { - "type" : "string", - "description" : "The name of the remote process group." - }, - "targetUri" : { - "type" : "string", - "description" : "The URI of the target system." - }, - "transmissionStatus" : { - "type" : "string", - "description" : "The transmission status of the remote process group." - }, - "statsLastRefreshed" : { - "type" : "string", - "description" : "The time the status for the process group was last refreshed." - }, - "validationStatus" : { - "type" : "string", - "description" : "Indicates whether the component is valid, invalid, or still in the process of validating (i.e., it is unknown whether or not the component is valid)", - "readOnly" : true, - "enum" : [ "VALID", "INVALID", "VALIDATING" ] - }, - "aggregateSnapshot" : { - "description" : "A status snapshot that represents the aggregate stats of all nodes in the cluster. If the NiFi instance is a standalone instance, rather than a cluster, this represents the stats of the single instance.", - "$ref" : "#/definitions/RemoteProcessGroupStatusSnapshotDTO" - }, - "nodeSnapshots" : { - "type" : "array", - "description" : "A status snapshot for each node in the cluster. If the NiFi instance is a standalone instance, rather than a cluster, this may be null.", - "items" : { - "$ref" : "#/definitions/NodeRemoteProcessGroupStatusSnapshotDTO" - } - } - } - }, - "RemoteProcessGroupStatusEntity" : { - "type" : "object", - "properties" : { - "remoteProcessGroupStatus" : { - "$ref" : "#/definitions/RemoteProcessGroupStatusDTO" - }, - "canRead" : { - "type" : "boolean", - "description" : "Indicates whether the user can read a given resource.", - "readOnly" : true - } - }, - "xml" : { - "name" : "remoteProcessGroupStatusEntity" - } - }, - "RemoteProcessGroupStatusSnapshotDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the remote process group." - }, - "groupId" : { - "type" : "string", - "description" : "The id of the parent process group the remote process group resides in." - }, - "name" : { - "type" : "string", - "description" : "The name of the remote process group." - }, - "targetUri" : { - "type" : "string", - "description" : "The URI of the target system." - }, - "transmissionStatus" : { - "type" : "string", - "description" : "The transmission status of the remote process group." - }, - "activeThreadCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of active threads for the remote process group." - }, - "flowFilesSent" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of FlowFiles sent to the remote process group in the last 5 minutes." - }, - "bytesSent" : { - "type" : "integer", - "format" : "int64", - "description" : "The size of the FlowFiles sent to the remote process group in the last 5 minutes." - }, - "sent" : { - "type" : "string", - "description" : "The count/size of the flowfiles sent to the remote process group in the last 5 minutes." - }, - "flowFilesReceived" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of FlowFiles received from the remote process group in the last 5 minutes." - }, - "bytesReceived" : { - "type" : "integer", - "format" : "int64", - "description" : "The size of the FlowFiles received from the remote process group in the last 5 minutes." - }, - "received" : { - "type" : "string", - "description" : "The count/size of the flowfiles received from the remote process group in the last 5 minutes." - } - } - }, - "RemoteProcessGroupStatusSnapshotEntity" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the remote process group." - }, - "remoteProcessGroupStatusSnapshot" : { - "$ref" : "#/definitions/RemoteProcessGroupStatusSnapshotDTO" - }, - "canRead" : { - "type" : "boolean", - "description" : "Indicates whether the user can read a given resource.", - "readOnly" : true - } - }, - "xml" : { - "name" : "entity" - } - }, - "RemoteProcessGroupsEntity" : { - "type" : "object", - "properties" : { - "remoteProcessGroups" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/RemoteProcessGroupEntity" - } - } - }, - "xml" : { - "name" : "remoteProcessGroupsEntity" - } - }, - "ReportingTaskDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "versionedComponentId" : { - "type" : "string", - "description" : "The ID of the corresponding component that is under version control" - }, - "parentGroupId" : { - "type" : "string", - "description" : "The id of parent process group of this component if applicable." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "name" : { - "type" : "string", - "description" : "The name of the reporting task." - }, - "type" : { - "type" : "string", - "description" : "The fully qualified type of the reporting task." - }, - "bundle" : { - "description" : "The details of the artifact that bundled this processor type.", - "$ref" : "#/definitions/BundleDTO" - }, - "state" : { - "type" : "string", - "description" : "The state of the reporting task.", - "enum" : [ "RUNNING", "STOPPED", "DISABLED" ] - }, - "comments" : { - "type" : "string", - "description" : "The comments of the reporting task." - }, - "persistsState" : { - "type" : "boolean", - "description" : "Whether the reporting task persists state." - }, - "restricted" : { - "type" : "boolean", - "description" : "Whether the reporting task requires elevated privileges." - }, - "deprecated" : { - "type" : "boolean", - "description" : "Whether the reporting task has been deprecated." - }, - "multipleVersionsAvailable" : { - "type" : "boolean", - "description" : "Whether the reporting task has multiple versions available." - }, - "schedulingPeriod" : { - "type" : "string", - "description" : "The frequency with which to schedule the reporting task. The format of the value willd epend on the valud of the schedulingStrategy." - }, - "schedulingStrategy" : { - "type" : "string", - "description" : "The scheduling strategy that determines how the schedulingPeriod value should be interpreted." - }, - "defaultSchedulingPeriod" : { - "type" : "object", - "description" : "The default scheduling period for the different scheduling strategies.", - "additionalProperties" : { - "type" : "string" - } - }, - "properties" : { - "type" : "object", - "description" : "The properties of the reporting task.", - "additionalProperties" : { - "type" : "string" - } - }, - "descriptors" : { - "type" : "object", - "description" : "The descriptors for the reporting tasks properties.", - "additionalProperties" : { - "$ref" : "#/definitions/PropertyDescriptorDTO" - } - }, - "customUiUrl" : { - "type" : "string", - "description" : "The URL for the custom configuration UI for the reporting task." - }, - "annotationData" : { - "type" : "string", - "description" : "The annotation data for the repoting task. This is how the custom UI relays configuration to the reporting task." - }, - "validationErrors" : { - "type" : "array", - "description" : "Gets the validation errors from the reporting task. These validation errors represent the problems with the reporting task that must be resolved before it can be scheduled to run.", - "items" : { - "type" : "string" - } - }, - "validationStatus" : { - "type" : "string", - "description" : "Indicates whether the Processor is valid, invalid, or still in the process of validating (i.e., it is unknown whether or not the Processor is valid)", - "readOnly" : true, - "enum" : [ "VALID", "INVALID", "VALIDATING" ] - }, - "activeThreadCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of active threads for the reporting task." - }, - "extensionMissing" : { - "type" : "boolean", - "description" : "Whether the underlying extension is missing." - } - } - }, - "ReportingTaskEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "component" : { - "$ref" : "#/definitions/ReportingTaskDTO" - }, - "operatePermissions" : { - "description" : "The permissions for this component operations.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "status" : { - "description" : "The status for this ReportingTask.", - "readOnly" : true, - "$ref" : "#/definitions/ReportingTaskStatusDTO" - } - }, - "xml" : { - "name" : "reportingTaskEntity" - } - }, - "ReportingTaskRunStatusEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "state" : { - "type" : "string", - "description" : "The run status of the ReportingTask.", - "enum" : [ "RUNNING", "STOPPED" ] - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - } - }, - "xml" : { - "name" : "entity" - } - }, - "ReportingTaskStatusDTO" : { - "type" : "object", - "properties" : { - "runStatus" : { - "type" : "string", - "description" : "The run status of this ReportingTask", - "readOnly" : true, - "enum" : [ "RUNNING", "STOPPED", "DISABLED" ] - }, - "validationStatus" : { - "type" : "string", - "description" : "Indicates whether the component is valid, invalid, or still in the process of validating (i.e., it is unknown whether or not the component is valid)", - "readOnly" : true, - "enum" : [ "VALID", "INVALID", "VALIDATING" ] - }, - "activeThreadCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of active threads for the component." - } - } - }, - "ReportingTaskTypesEntity" : { - "type" : "object", - "properties" : { - "reportingTaskTypes" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/DocumentedTypeDTO" - } - } - }, - "xml" : { - "name" : "reportingTaskTypesEntity" - } - }, - "ReportingTasksEntity" : { - "type" : "object", - "properties" : { - "reportingTasks" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ReportingTaskEntity" - } - } - }, - "xml" : { - "name" : "reportingTasksEntity" - } - }, - "RequiredPermissionDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The required sub-permission necessary for this restriction." - }, - "label" : { - "type" : "string", - "description" : "The label for the required sub-permission necessary for this restriction." - } - } - }, - "ResourceDTO" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The identifier of the resource." - }, - "name" : { - "type" : "string", - "description" : "The name of the resource." - } - } - }, - "ResourcesEntity" : { - "type" : "object", - "properties" : { - "resources" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/ResourceDTO" - } - } - }, - "xml" : { - "name" : "resourcesEntity" - } - }, - "RevisionDTO" : { - "type" : "object", - "properties" : { - "clientId" : { - "type" : "string", - "description" : "A client identifier used to make a request. By including a client identifier, the API can allow multiple requests without needing the current revision. Due to the asynchronous nature of requests/responses this was implemented to allow the client to make numerous requests without having to wait for the previous response to come back" - }, - "version" : { - "type" : "integer", - "format" : "int64", - "description" : "NiFi employs an optimistic locking strategy where the client must include a revision in their request when performing an update. In a response to a mutable flow request, this field represents the updated base version." - }, - "lastModifier" : { - "type" : "string", - "description" : "The user that last modified the flow.", - "readOnly" : true - } - } - }, - "ScheduleComponentsEntity" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the ProcessGroup" - }, - "state" : { - "type" : "string", - "description" : "The desired state of the descendant components", - "enum" : [ "RUNNING", "STOPPED", "ENABLED", "DISABLED" ] - }, - "components" : { - "type" : "object", - "description" : "Optional components to schedule. If not specified, all authorized descendant components will be used.", - "additionalProperties" : { - "$ref" : "#/definitions/RevisionDTO" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - } - }, - "xml" : { - "name" : "scheduleComponentEntity" - } - }, - "SearchResultGroupDTO" : { - "type" : "object", - "required" : [ "id" ], - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the group." - }, - "name" : { - "type" : "string", - "description" : "The name of the group." - } - } - }, - "SearchResultsDTO" : { - "type" : "object", - "properties" : { - "processorResults" : { - "type" : "array", - "description" : "The processors that matched the search.", - "items" : { - "$ref" : "#/definitions/ComponentSearchResultDTO" - } - }, - "connectionResults" : { - "type" : "array", - "description" : "The connections that matched the search.", - "items" : { - "$ref" : "#/definitions/ComponentSearchResultDTO" - } - }, - "processGroupResults" : { - "type" : "array", - "description" : "The process groups that matched the search.", - "items" : { - "$ref" : "#/definitions/ComponentSearchResultDTO" - } - }, - "inputPortResults" : { - "type" : "array", - "description" : "The input ports that matched the search.", - "items" : { - "$ref" : "#/definitions/ComponentSearchResultDTO" - } - }, - "outputPortResults" : { - "type" : "array", - "description" : "The output ports that matched the search.", - "items" : { - "$ref" : "#/definitions/ComponentSearchResultDTO" - } - }, - "remoteProcessGroupResults" : { - "type" : "array", - "description" : "The remote process groups that matched the search.", - "items" : { - "$ref" : "#/definitions/ComponentSearchResultDTO" - } - }, - "funnelResults" : { - "type" : "array", - "description" : "The funnels that matched the search.", - "items" : { - "$ref" : "#/definitions/ComponentSearchResultDTO" - } - }, - "parameterContextResults" : { - "type" : "array", - "description" : "The parameter contexts that matched the search.", - "items" : { - "$ref" : "#/definitions/ComponentSearchResultDTO" - } - }, - "parameterResults" : { - "type" : "array", - "description" : "The parameters that matched the search.", - "items" : { - "$ref" : "#/definitions/ComponentSearchResultDTO" - } - } - } - }, - "SearchResultsEntity" : { - "type" : "object", - "properties" : { - "searchResultsDTO" : { - "$ref" : "#/definitions/SearchResultsDTO" - } - }, - "xml" : { - "name" : "searchResultsEntity" - } - }, - "SnippetDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the snippet." - }, - "uri" : { - "type" : "string", - "description" : "The URI of the snippet." - }, - "parentGroupId" : { - "type" : "string", - "description" : "The group id for the components in the snippet." - }, - "processGroups" : { - "type" : "object", - "description" : "The ids of the process groups in this snippet. These ids will be populated within each response. They can be specified when creating a snippet. However, once a snippet has been created its contents cannot be modified (these ids are ignored during update requests).", - "additionalProperties" : { - "$ref" : "#/definitions/RevisionDTO" - } - }, - "remoteProcessGroups" : { - "type" : "object", - "description" : "The ids of the remote process groups in this snippet. These ids will be populated within each response. They can be specified when creating a snippet. However, once a snippet has been created its contents cannot be modified (these ids are ignored during update requests).", - "additionalProperties" : { - "$ref" : "#/definitions/RevisionDTO" - } - }, - "processors" : { - "type" : "object", - "description" : "The ids of the processors in this snippet. These ids will be populated within each response. They can be specified when creating a snippet. However, once a snippet has been created its contents cannot be modified (these ids are ignored during update requests).", - "additionalProperties" : { - "$ref" : "#/definitions/RevisionDTO" - } - }, - "inputPorts" : { - "type" : "object", - "description" : "The ids of the input ports in this snippet. These ids will be populated within each response. They can be specified when creating a snippet. However, once a snippet has been created its contents cannot be modified (these ids are ignored during update requests).", - "additionalProperties" : { - "$ref" : "#/definitions/RevisionDTO" - } - }, - "outputPorts" : { - "type" : "object", - "description" : "The ids of the output ports in this snippet. These ids will be populated within each response. They can be specified when creating a snippet. However, once a snippet has been created its contents cannot be modified (these ids are ignored during update requests).", - "additionalProperties" : { - "$ref" : "#/definitions/RevisionDTO" - } - }, - "connections" : { - "type" : "object", - "description" : "The ids of the connections in this snippet. These ids will be populated within each response. They can be specified when creating a snippet. However, once a snippet has been created its contents cannot be modified (these ids are ignored during update requests).", - "additionalProperties" : { - "$ref" : "#/definitions/RevisionDTO" - } - }, - "labels" : { - "type" : "object", - "description" : "The ids of the labels in this snippet. These ids will be populated within each response. They can be specified when creating a snippet. However, once a snippet has been created its contents cannot be modified (these ids are ignored during update requests).", - "additionalProperties" : { - "$ref" : "#/definitions/RevisionDTO" - } - }, - "funnels" : { - "type" : "object", - "description" : "The ids of the funnels in this snippet. These ids will be populated within each response. They can be specified when creating a snippet. However, once a snippet has been created its contents cannot be modified (these ids are ignored during update requests).", - "additionalProperties" : { - "$ref" : "#/definitions/RevisionDTO" - } - } - } - }, - "SnippetEntity" : { - "type" : "object", - "properties" : { - "snippet" : { - "description" : "The snippet.", - "$ref" : "#/definitions/SnippetDTO" - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - } - }, - "xml" : { - "name" : "snippetEntity" - } - }, - "StartVersionControlRequestEntity" : { - "type" : "object", - "properties" : { - "versionedFlow" : { - "description" : "The versioned flow", - "$ref" : "#/definitions/VersionedFlowDTO" - }, - "processGroupRevision" : { - "description" : "The Revision of the Process Group under Version Control", - "$ref" : "#/definitions/RevisionDTO" - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - } - }, - "xml" : { - "name" : "startVersionControlRequestEntity" - } - }, - "StateEntryDTO" : { - "type" : "object", - "properties" : { - "key" : { - "type" : "string", - "description" : "The key for this state." - }, - "value" : { - "type" : "string", - "description" : "The value for this state." - }, - "clusterNodeId" : { - "type" : "string", - "description" : "The identifier for the node where the state originated." - }, - "clusterNodeAddress" : { - "type" : "string", - "description" : "The label for the node where the state originated." - } - } - }, - "StateMapDTO" : { - "type" : "object", - "properties" : { - "scope" : { - "type" : "string", - "description" : "The scope of this StateMap." - }, - "totalEntryCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The total number of state entries. When the state map is lengthy, only of portion of the entries are returned." - }, - "state" : { - "type" : "array", - "description" : "The state.", - "items" : { - "$ref" : "#/definitions/StateEntryDTO" - } - } - } - }, - "StatusDescriptorDTO" : { - "type" : "object", - "properties" : { - "field" : { - "type" : "string", - "description" : "The name of the status field." - }, - "label" : { - "type" : "string", - "description" : "The label for the status field." - }, - "description" : { - "type" : "string", - "description" : "The description of the status field." - }, - "formatter" : { - "type" : "string", - "description" : "The formatter for the status descriptor." - } - } - }, - "StatusHistoryDTO" : { - "type" : "object", - "properties" : { - "generated" : { - "type" : "string", - "description" : "When the status history was generated." - }, - "componentDetails" : { - "type" : "object", - "description" : "A Map of key/value pairs that describe the component that the status history belongs to", - "additionalProperties" : { - "type" : "string" - } - }, - "fieldDescriptors" : { - "type" : "array", - "description" : "The Descriptors that provide information on each of the metrics provided in the status history", - "items" : { - "$ref" : "#/definitions/StatusDescriptorDTO" - } - }, - "aggregateSnapshots" : { - "type" : "array", - "description" : "A list of StatusSnapshotDTO objects that provide the actual metric values for the component. If the NiFi instance is clustered, this will represent the aggregate status across all nodes. If the NiFi instance is not clustered, this will represent the status of the entire NiFi instance.", - "items" : { - "$ref" : "#/definitions/StatusSnapshotDTO" - } - }, - "nodeSnapshots" : { - "type" : "array", - "description" : "The NodeStatusSnapshotsDTO objects that provide the actual metric values for the component, for each node. If the NiFi instance is not clustered, this value will be null.", - "items" : { - "$ref" : "#/definitions/NodeStatusSnapshotsDTO" - } - } - } - }, - "StatusHistoryEntity" : { - "type" : "object", - "properties" : { - "statusHistory" : { - "$ref" : "#/definitions/StatusHistoryDTO" - }, - "canRead" : { - "type" : "boolean", - "description" : "Indicates whether the user can read a given resource.", - "readOnly" : true - } - }, - "xml" : { - "name" : "statusHistoryEntity" - } - }, - "StatusSnapshotDTO" : { - "type" : "object", - "properties" : { - "timestamp" : { - "type" : "string", - "format" : "date-time", - "description" : "The timestamp of the snapshot." - }, - "statusMetrics" : { - "type" : "object", - "description" : "The status metrics.", - "additionalProperties" : { - "type" : "integer", - "format" : "int64" - } - } - } - }, - "StorageUsageDTO" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The identifier of this storage location. The identifier will correspond to the identifier keyed in the storage configuration." - }, - "freeSpace" : { - "type" : "string", - "description" : "Amount of free space." - }, - "totalSpace" : { - "type" : "string", - "description" : "Amount of total space." - }, - "usedSpace" : { - "type" : "string", - "description" : "Amount of used space." - }, - "freeSpaceBytes" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes of free space." - }, - "totalSpaceBytes" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes of total space." - }, - "usedSpaceBytes" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes of used space." - }, - "utilization" : { - "type" : "string", - "description" : "Utilization of this storage location." - } - } - }, - "StreamingOutput" : { - "type" : "object" - }, - "SubmitReplayRequestEntity" : { - "type" : "object", - "properties" : { - "eventId" : { - "type" : "integer", - "format" : "int64", - "description" : "The event identifier" - }, - "clusterNodeId" : { - "type" : "string", - "description" : "The identifier of the node where to submit the replay request." - } - }, - "xml" : { - "name" : "copySnippetRequestEntity" - } - }, - "SystemDiagnosticsDTO" : { - "type" : "object", - "properties" : { - "aggregateSnapshot" : { - "description" : "A systems diagnostic snapshot that represents the aggregate values of all nodes in the cluster. If the NiFi instance is a standalone instance, rather than a cluster, this represents the stats of the single instance.", - "$ref" : "#/definitions/SystemDiagnosticsSnapshotDTO" - }, - "nodeSnapshots" : { - "type" : "array", - "description" : "A systems diagnostics snapshot for each node in the cluster. If the NiFi instance is a standalone instance, rather than a cluster, this may be null.", - "items" : { - "$ref" : "#/definitions/NodeSystemDiagnosticsSnapshotDTO" - } - } - } - }, - "SystemDiagnosticsEntity" : { - "type" : "object", - "properties" : { - "systemDiagnostics" : { - "$ref" : "#/definitions/SystemDiagnosticsDTO" - } - }, - "xml" : { - "name" : "systemDiagnosticsEntity" - } - }, - "SystemDiagnosticsSnapshotDTO" : { - "type" : "object", - "properties" : { - "totalNonHeap" : { - "type" : "string", - "description" : "Total size of non heap." - }, - "totalNonHeapBytes" : { - "type" : "integer", - "format" : "int64", - "description" : "Total number of bytes allocated to the JVM not used for heap" - }, - "usedNonHeap" : { - "type" : "string", - "description" : "Amount of use non heap." - }, - "usedNonHeapBytes" : { - "type" : "integer", - "format" : "int64", - "description" : "Total number of bytes used by the JVM not in the heap space" - }, - "freeNonHeap" : { - "type" : "string", - "description" : "Amount of free non heap." - }, - "freeNonHeapBytes" : { - "type" : "integer", - "format" : "int64", - "description" : "Total number of free non-heap bytes available to the JVM" - }, - "maxNonHeap" : { - "type" : "string", - "description" : "Maximum size of non heap." - }, - "maxNonHeapBytes" : { - "type" : "integer", - "format" : "int64", - "description" : "The maximum number of bytes that the JVM can use for non-heap purposes" - }, - "nonHeapUtilization" : { - "type" : "string", - "description" : "Utilization of non heap." - }, - "totalHeap" : { - "type" : "string", - "description" : "Total size of heap." - }, - "totalHeapBytes" : { - "type" : "integer", - "format" : "int64", - "description" : "The total number of bytes that are available for the JVM heap to use" - }, - "usedHeap" : { - "type" : "string", - "description" : "Amount of used heap." - }, - "usedHeapBytes" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes of JVM heap that are currently being used" - }, - "freeHeap" : { - "type" : "string", - "description" : "Amount of free heap." - }, - "freeHeapBytes" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes that are allocated to the JVM heap but not currently being used" - }, - "maxHeap" : { - "type" : "string", - "description" : "Maximum size of heap." - }, - "maxHeapBytes" : { - "type" : "integer", - "format" : "int64", - "description" : "The maximum number of bytes that can be used by the JVM" - }, - "heapUtilization" : { - "type" : "string", - "description" : "Utilization of heap." - }, - "availableProcessors" : { - "type" : "integer", - "format" : "int32", - "description" : "Number of available processors if supported by the underlying system." - }, - "processorLoadAverage" : { - "type" : "number", - "format" : "double", - "description" : "The processor load average if supported by the underlying system." - }, - "totalThreads" : { - "type" : "integer", - "format" : "int32", - "description" : "Total number of threads." - }, - "daemonThreads" : { - "type" : "integer", - "format" : "int32", - "description" : "Number of daemon threads." - }, - "uptime" : { - "type" : "string", - "description" : "The uptime of the Java virtual machine" - }, - "flowFileRepositoryStorageUsage" : { - "description" : "The flowfile repository storage usage.", - "$ref" : "#/definitions/StorageUsageDTO" - }, - "contentRepositoryStorageUsage" : { - "type" : "array", - "description" : "The content repository storage usage.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/StorageUsageDTO" - } - }, - "provenanceRepositoryStorageUsage" : { - "type" : "array", - "description" : "The provenance repository storage usage.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/StorageUsageDTO" - } - }, - "garbageCollection" : { - "type" : "array", - "description" : "The garbage collection details.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/GarbageCollectionDTO" - } - }, - "statsLastRefreshed" : { - "type" : "string", - "description" : "When the diagnostics were generated." - }, - "versionInfo" : { - "description" : "The nifi, os, java, and build version information", - "$ref" : "#/definitions/VersionInfoDTO" - } - } - }, - "TemplateDTO" : { - "type" : "object", - "properties" : { - "uri" : { - "type" : "string", - "description" : "The URI for the template." - }, - "id" : { - "type" : "string", - "description" : "The id of the template." - }, - "groupId" : { - "type" : "string", - "description" : "The id of the Process Group that the template belongs to." - }, - "name" : { - "type" : "string", - "description" : "The name of the template." - }, - "description" : { - "type" : "string", - "description" : "The description of the template." - }, - "timestamp" : { - "type" : "string", - "description" : "The timestamp when this template was created." - }, - "encodingVersion" : { - "type" : "string", - "xml" : { - "name" : "encoding-version", - "attribute" : true - }, - "description" : "The encoding version of this template." - }, - "snippet" : { - "description" : "The contents of the template.", - "$ref" : "#/definitions/FlowSnippetDTO" - } - }, - "xml" : { - "name" : "template" - } - }, - "TemplateEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "template" : { - "$ref" : "#/definitions/TemplateDTO" - } - }, - "xml" : { - "name" : "templateEntity" - } - }, - "TemplatesEntity" : { - "type" : "object", - "properties" : { - "templates" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/TemplateEntity" - } - }, - "generated" : { - "type" : "string", - "description" : "When this content was generated." - } - }, - "xml" : { - "name" : "templatesEntity" - } - }, - "TenantDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "versionedComponentId" : { - "type" : "string", - "description" : "The ID of the corresponding component that is under version control" - }, - "parentGroupId" : { - "type" : "string", - "description" : "The id of parent process group of this component if applicable." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "identity" : { - "type" : "string", - "description" : "The identity of the tenant." - }, - "configurable" : { - "type" : "boolean", - "description" : "Whether this tenant is configurable." - } - } - }, - "TenantEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "component" : { - "$ref" : "#/definitions/TenantDTO" - } - }, - "xml" : { - "name" : "tenantEntity" - } - }, - "TenantsEntity" : { - "type" : "object", - "properties" : { - "users" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/TenantEntity" - } - }, - "userGroups" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/TenantEntity" - } - } - }, - "xml" : { - "name" : "tenantsEntity" - } - }, - "TransactionResultEntity" : { - "type" : "object", - "properties" : { - "flowFileSent" : { - "type" : "integer", - "format" : "int32" - }, - "responseCode" : { - "type" : "integer", - "format" : "int32" - }, - "message" : { - "type" : "string" - } - }, - "xml" : { - "name" : "transactionResultEntity" - } - }, - "UpdateControllerServiceReferenceRequestEntity" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The identifier of the Controller Service." - }, - "state" : { - "type" : "string", - "description" : "The new state of the references for the controller service.", - "enum" : [ "ENABLED", "DISABLED", "RUNNING", "STOPPED" ] - }, - "referencingComponentRevisions" : { - "type" : "object", - "description" : "The revisions for all referencing components.", - "additionalProperties" : { - "$ref" : "#/definitions/RevisionDTO" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - } - }, - "xml" : { - "name" : "updateControllerServiceReferenceRequestEntity" - } - }, - "UserDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "versionedComponentId" : { - "type" : "string", - "description" : "The ID of the corresponding component that is under version control" - }, - "parentGroupId" : { - "type" : "string", - "description" : "The id of parent process group of this component if applicable." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "identity" : { - "type" : "string", - "description" : "The identity of the tenant." - }, - "configurable" : { - "type" : "boolean", - "description" : "Whether this tenant is configurable." - }, - "userGroups" : { - "type" : "array", - "description" : "The groups to which the user belongs. This field is read only and it provided for convenience.", - "readOnly" : true, - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/TenantEntity" - } - }, - "accessPolicies" : { - "type" : "array", - "description" : "The access policies this user belongs to.", - "readOnly" : true, - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/AccessPolicySummaryEntity" - } - } - } - }, - "UserEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "component" : { - "$ref" : "#/definitions/UserDTO" - } - }, - "xml" : { - "name" : "userEntity" - } - }, - "UserGroupDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "versionedComponentId" : { - "type" : "string", - "description" : "The ID of the corresponding component that is under version control" - }, - "parentGroupId" : { - "type" : "string", - "description" : "The id of parent process group of this component if applicable." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "identity" : { - "type" : "string", - "description" : "The identity of the tenant." - }, - "configurable" : { - "type" : "boolean", - "description" : "Whether this tenant is configurable." - }, - "users" : { - "type" : "array", - "description" : "The users that belong to the user group.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/TenantEntity" - } - }, - "accessPolicies" : { - "type" : "array", - "description" : "The access policies this user group belongs to. This field was incorrectly defined as an AccessPolicyEntity. For compatibility reasons the field will remain of this type, however only the fields that are present in the AccessPolicySummaryEntity will be populated here.", - "readOnly" : true, - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/AccessPolicyEntity" - } - } - } - }, - "UserGroupEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "component" : { - "$ref" : "#/definitions/UserGroupDTO" - } - }, - "xml" : { - "name" : "userGroupEntity" - } - }, - "UserGroupsEntity" : { - "type" : "object", - "properties" : { - "userGroups" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/UserGroupEntity" - } - } - }, - "xml" : { - "name" : "userGroupsEntity" - } - }, - "UsersEntity" : { - "type" : "object", - "properties" : { - "generated" : { - "type" : "string", - "description" : "When this content was generated." - }, - "users" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/UserEntity" - } - } - }, - "xml" : { - "name" : "usersEntity" - } - }, - "VariableDTO" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The name of the variable" - }, - "value" : { - "type" : "string", - "description" : "The value of the variable" - }, - "processGroupId" : { - "type" : "string", - "description" : "The ID of the Process Group where this Variable is defined", - "readOnly" : true - }, - "affectedComponents" : { - "type" : "array", - "description" : "A set of all components that will be affected if the value of this variable is changed", - "readOnly" : true, - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/AffectedComponentEntity" - } - } - } - }, - "VariableEntity" : { - "type" : "object", - "properties" : { - "variable" : { - "description" : "The variable information", - "$ref" : "#/definitions/VariableDTO" - }, - "canWrite" : { - "type" : "boolean", - "description" : "Indicates whether the user can write a given resource.", - "readOnly" : true - } - }, - "xml" : { - "name" : "variableEntity" - } - }, - "VariableRegistryDTO" : { - "type" : "object", - "properties" : { - "variables" : { - "type" : "array", - "description" : "The variables that are available in this Variable Registry", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VariableEntity" - } - }, - "processGroupId" : { - "type" : "string", - "description" : "The UUID of the Process Group that this Variable Registry belongs to" - } - } - }, - "VariableRegistryEntity" : { - "type" : "object", - "properties" : { - "processGroupRevision" : { - "description" : "The revision of the Process Group that the Variable Registry belongs to", - "$ref" : "#/definitions/RevisionDTO" - }, - "variableRegistry" : { - "description" : "The Variable Registry.", - "$ref" : "#/definitions/VariableRegistryDTO" - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - } - }, - "xml" : { - "name" : "variableRegistryEntity" - } - }, - "VariableRegistryUpdateRequestDTO" : { - "type" : "object", - "properties" : { - "requestId" : { - "type" : "string", - "description" : "The ID of the request", - "readOnly" : true - }, - "uri" : { - "type" : "string", - "description" : "The URI for the request", - "readOnly" : true - }, - "submissionTime" : { - "type" : "string", - "format" : "date-time", - "description" : "The timestamp of when the request was submitted", - "readOnly" : true - }, - "lastUpdated" : { - "type" : "string", - "format" : "date-time", - "description" : "The timestamp of when the request was last updated", - "readOnly" : true - }, - "complete" : { - "type" : "boolean", - "description" : "Whether or not the request is completed", - "readOnly" : true - }, - "failureReason" : { - "type" : "string", - "description" : "The reason for the request failing, or null if the request has not failed", - "readOnly" : true - }, - "percentCompleted" : { - "type" : "integer", - "format" : "int32", - "description" : "A value between 0 and 100 (inclusive) indicating how close the request is to completion", - "readOnly" : true - }, - "state" : { - "type" : "string", - "description" : "A description of the current state of the request", - "readOnly" : true - }, - "updateSteps" : { - "type" : "array", - "description" : "The steps that are required in order to complete the request, along with the status of each", - "readOnly" : true, - "items" : { - "$ref" : "#/definitions/VariableRegistryUpdateStepDTO" - } - }, - "processGroupId" : { - "type" : "string", - "description" : "The unique ID of the Process Group that the variable registry belongs to" - }, - "affectedComponents" : { - "type" : "array", - "description" : "A set of all components that will be affected if the value of this variable is changed", - "readOnly" : true, - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/AffectedComponentEntity" - } - } - } - }, - "VariableRegistryUpdateRequestEntity" : { - "type" : "object", - "properties" : { - "request" : { - "description" : "The Variable Registry Update Request", - "$ref" : "#/definitions/VariableRegistryUpdateRequestDTO" - }, - "processGroupRevision" : { - "description" : "The revision for the Process Group that owns this variable registry.", - "$ref" : "#/definitions/RevisionDTO" - } - }, - "xml" : { - "name" : "variableRegistryUpdateRequestEntity" - } - }, - "VariableRegistryUpdateStepDTO" : { - "type" : "object", - "properties" : { - "description" : { - "type" : "string", - "description" : "Explanation of what happens in this step", - "readOnly" : true - }, - "complete" : { - "type" : "boolean", - "description" : "Whether or not this step has completed", - "readOnly" : true - }, - "failureReason" : { - "type" : "string", - "description" : "An explanation of why this step failed, or null if this step did not fail", - "readOnly" : true - } - } - }, - "VersionControlComponentMappingEntity" : { - "type" : "object", - "properties" : { - "versionControlComponentMapping" : { - "type" : "object", - "description" : "The mapping of Versioned Component Identifiers to instance ID's", - "additionalProperties" : { - "type" : "string" - } - }, - "processGroupRevision" : { - "description" : "The revision of the Process Group", - "$ref" : "#/definitions/RevisionDTO" - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "versionControlInformation" : { - "description" : "The Version Control information", - "$ref" : "#/definitions/VersionControlInformationDTO" - } - }, - "xml" : { - "name" : "versionControlComponentMappingEntity" - } - }, - "VersionControlInformationDTO" : { - "type" : "object", - "properties" : { - "groupId" : { - "type" : "string", - "description" : "The ID of the Process Group that is under version control" - }, - "registryId" : { - "type" : "string", - "description" : "The ID of the registry that the flow is stored in" - }, - "registryName" : { - "type" : "string", - "description" : "The name of the registry that the flow is stored in", - "readOnly" : true - }, - "bucketId" : { - "type" : "string", - "description" : "The ID of the bucket that the flow is stored in" - }, - "bucketName" : { - "type" : "string", - "description" : "The name of the bucket that the flow is stored in", - "readOnly" : true - }, - "flowId" : { - "type" : "string", - "description" : "The ID of the flow" - }, - "flowName" : { - "type" : "string", - "description" : "The name of the flow" - }, - "flowDescription" : { - "type" : "string", - "description" : "The description of the flow" - }, - "version" : { - "type" : "integer", - "format" : "int32", - "description" : "The version of the flow" - }, - "state" : { - "type" : "string", - "description" : "The current state of the Process Group, as it relates to the Versioned Flow", - "readOnly" : true, - "enum" : [ "LOCALLY_MODIFIED", "STALE", "LOCALLY_MODIFIED_AND_STALE", "UP_TO_DATE", "SYNC_FAILURE" ] - }, - "stateExplanation" : { - "type" : "string", - "description" : "Explanation of why the group is in the specified state", - "readOnly" : true - } - } - }, - "VersionControlInformationEntity" : { - "type" : "object", - "properties" : { - "versionControlInformation" : { - "description" : "The Version Control information", - "$ref" : "#/definitions/VersionControlInformationDTO" - }, - "processGroupRevision" : { - "description" : "The Revision for the Process Group", - "$ref" : "#/definitions/RevisionDTO" - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - } - }, - "xml" : { - "name" : "versionControlInformationEntity" - } - }, - "VersionInfoDTO" : { - "type" : "object", - "properties" : { - "niFiVersion" : { - "type" : "string", - "description" : "The version of this NiFi." - }, - "javaVendor" : { - "type" : "string", - "description" : "Java JVM vendor" - }, - "javaVersion" : { - "type" : "string", - "description" : "Java version" - }, - "osName" : { - "type" : "string", - "description" : "Host operating system name" - }, - "osVersion" : { - "type" : "string", - "description" : "Host operating system version" - }, - "osArchitecture" : { - "type" : "string", - "description" : "Host operating system architecture" - }, - "buildTag" : { - "type" : "string", - "description" : "Build tag" - }, - "buildRevision" : { - "type" : "string", - "description" : "Build revision or commit hash" - }, - "buildBranch" : { - "type" : "string", - "description" : "Build branch" - }, - "buildTimestamp" : { - "type" : "string", - "format" : "date-time", - "description" : "Build timestamp" - } - } - }, - "VersionedConnection" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The component's unique identifier" - }, - "name" : { - "type" : "string", - "description" : "The component's name" - }, - "comments" : { - "type" : "string", - "description" : "The user-supplied comments for the component" - }, - "position" : { - "description" : "The component's position on the graph", - "$ref" : "#/definitions/Position" - }, - "source" : { - "description" : "The source of the connection.", - "$ref" : "#/definitions/ConnectableComponent" - }, - "destination" : { - "description" : "The destination of the connection.", - "$ref" : "#/definitions/ConnectableComponent" - }, - "labelIndex" : { - "type" : "integer", - "format" : "int32", - "description" : "The index of the bend point where to place the connection label." - }, - "zIndex" : { - "type" : "integer", - "format" : "int64", - "description" : "The z index of the connection." - }, - "selectedRelationships" : { - "type" : "array", - "description" : "The selected relationship that comprise the connection.", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - }, - "backPressureObjectThreshold" : { - "type" : "integer", - "format" : "int64", - "description" : "The object count threshold for determining when back pressure is applied. Updating this value is a passive change in the sense that it won't impact whether existing files over the limit are affected but it does help feeder processors to stop pushing too much into this work queue." - }, - "backPressureDataSizeThreshold" : { - "type" : "string", - "description" : "The object data size threshold for determining when back pressure is applied. Updating this value is a passive change in the sense that it won't impact whether existing files over the limit are affected but it does help feeder processors to stop pushing too much into this work queue." - }, - "flowFileExpiration" : { - "type" : "string", - "description" : "The amount of time a flow file may be in the flow before it will be automatically aged out of the flow. Once a flow file reaches this age it will be terminated from the flow the next time a processor attempts to start work on it." - }, - "prioritizers" : { - "type" : "array", - "description" : "The comparators used to prioritize the queue.", - "items" : { - "type" : "string" - } - }, - "bends" : { - "type" : "array", - "description" : "The bend points on the connection.", - "items" : { - "$ref" : "#/definitions/Position" - } - }, - "loadBalanceStrategy" : { - "type" : "string", - "description" : "The Strategy to use for load balancing data across the cluster, or null, if no Load Balance Strategy has been specified.", - "enum" : [ "DO_NOT_LOAD_BALANCE", "PARTITION_BY_ATTRIBUTE", "ROUND_ROBIN", "SINGLE_NODE" ] - }, - "partitioningAttribute" : { - "type" : "string", - "description" : "The attribute to use for partitioning data as it is load balanced across the cluster. If the Load Balance Strategy is configured to use PARTITION_BY_ATTRIBUTE, the value returned by this method is the name of the FlowFile Attribute that will be used to determine which node in the cluster should receive a given FlowFile. If the Load Balance Strategy is unset or is set to any other value, the Partitioning Attribute has no effect." - }, - "loadBalanceCompression" : { - "type" : "string", - "description" : "Whether or not compression should be used when transferring FlowFiles between nodes", - "enum" : [ "DO_NOT_COMPRESS", "COMPRESS_ATTRIBUTES_ONLY", "COMPRESS_ATTRIBUTES_AND_CONTENT" ] - }, - "componentType" : { - "type" : "string", - "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE" ] - }, - "groupIdentifier" : { - "type" : "string", - "description" : "The ID of the Process Group that this component belongs to" - } - } - }, - "VersionedControllerService" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The component's unique identifier" - }, - "name" : { - "type" : "string", - "description" : "The component's name" - }, - "comments" : { - "type" : "string", - "description" : "The user-supplied comments for the component" - }, - "position" : { - "description" : "The component's position on the graph", - "$ref" : "#/definitions/Position" - }, - "type" : { - "type" : "string", - "description" : "The type of the controller service." - }, - "bundle" : { - "description" : "The details of the artifact that bundled this processor type.", - "$ref" : "#/definitions/Bundle" - }, - "controllerServiceApis" : { - "type" : "array", - "description" : "Lists the APIs this Controller Service implements.", - "items" : { - "$ref" : "#/definitions/ControllerServiceAPI" - } - }, - "properties" : { - "type" : "object", - "description" : "The properties of the controller service.", - "additionalProperties" : { - "type" : "string" - } - }, - "propertyDescriptors" : { - "type" : "object", - "description" : "The property descriptors for the processor.", - "additionalProperties" : { - "$ref" : "#/definitions/VersionedPropertyDescriptor" - } - }, - "annotationData" : { - "type" : "string", - "description" : "The annotation for the controller service. This is how the custom UI relays configuration to the controller service." - }, - "componentType" : { - "type" : "string", - "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE" ] - }, - "groupIdentifier" : { - "type" : "string", - "description" : "The ID of the Process Group that this component belongs to" - } - } - }, - "VersionedFlow" : { - "type" : "object", - "required" : [ "bucketIdentifier", "name", "type" ], - "properties" : { - "link" : { - "description" : "An WebLink to this entity.", - "readOnly" : true, - "$ref" : "#/definitions/JaxbLink" - }, - "identifier" : { - "type" : "string", - "description" : "An ID to uniquely identify this object.", - "readOnly" : true - }, - "name" : { - "type" : "string", - "description" : "The name of the item." - }, - "description" : { - "type" : "string", - "description" : "A description of the item." - }, - "bucketIdentifier" : { - "type" : "string", - "description" : "The identifier of the bucket this items belongs to. This cannot be changed after the item is created." - }, - "bucketName" : { - "type" : "string", - "description" : "The name of the bucket this items belongs to.", - "readOnly" : true - }, - "createdTimestamp" : { - "type" : "integer", - "format" : "int64", - "description" : "The timestamp of when the item was created, as milliseconds since epoch.", - "readOnly" : true, - "minimum" : 1 - }, - "modifiedTimestamp" : { - "type" : "integer", - "format" : "int64", - "description" : "The timestamp of when the item was last modified, as milliseconds since epoch.", - "readOnly" : true, - "minimum" : 1 - }, - "type" : { - "type" : "string", - "description" : "The type of item.", - "enum" : [ "Flow", "Bundle" ] - }, - "permissions" : { - "description" : "The access that the current user has to the bucket containing this item.", - "readOnly" : true, - "$ref" : "#/definitions/Permissions" - }, - "versionCount" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of versions of this flow.", - "readOnly" : true, - "minimum" : 0 - } - } - }, - "VersionedFlowCoordinates" : { - "type" : "object", - "properties" : { - "registryUrl" : { - "type" : "string", - "description" : "The URL of the Flow Registry that contains the flow" - }, - "bucketId" : { - "type" : "string", - "description" : "The UUID of the bucket that the flow resides in" - }, - "flowId" : { - "type" : "string", - "description" : "The UUID of the flow" - }, - "version" : { - "type" : "integer", - "format" : "int32", - "description" : "The version of the flow" - }, - "latest" : { - "type" : "boolean", - "description" : "Whether or not these coordinates point to the latest version of the flow" - } - } - }, - "VersionedFlowDTO" : { - "type" : "object", - "properties" : { - "registryId" : { - "type" : "string", - "description" : "The ID of the registry that the flow is tracked to" - }, - "bucketId" : { - "type" : "string", - "description" : "The ID of the bucket where the flow is stored" - }, - "flowId" : { - "type" : "string", - "description" : "The ID of the flow" - }, - "flowName" : { - "type" : "string", - "description" : "The name of the flow" - }, - "description" : { - "type" : "string", - "description" : "A description of the flow" - }, - "comments" : { - "type" : "string", - "description" : "Comments for the changeset" - }, - "action" : { - "type" : "string", - "description" : "The action being performed", - "enum" : [ "COMMIT", "FORCE_COMMIT" ] - } - } - }, - "VersionedFlowEntity" : { - "type" : "object", - "properties" : { - "versionedFlow" : { - "description" : "The versioned flow", - "$ref" : "#/definitions/VersionedFlowDTO" - } - }, - "xml" : { - "name" : "versionedFlowEntity" - } - }, - "VersionedFlowSnapshot" : { - "type" : "object", - "required" : [ "flowContents", "snapshotMetadata" ], - "properties" : { - "snapshotMetadata" : { - "description" : "The metadata for this snapshot", - "$ref" : "#/definitions/VersionedFlowSnapshotMetadata" - }, - "flowContents" : { - "description" : "The contents of the versioned flow", - "$ref" : "#/definitions/VersionedProcessGroup" - }, - "externalControllerServices" : { - "type" : "object", - "description" : "The information about controller services that exist outside this versioned flow, but are referenced by components within the versioned flow.", - "additionalProperties" : { - "$ref" : "#/definitions/ExternalControllerServiceReference" - } - }, - "parameterContexts" : { - "type" : "object", - "description" : "The parameter contexts referenced by process groups in the flow contents. The mapping is from the name of the context to the context instance, and it is expected that any context in this map is referenced by at least one process group in this flow.", - "additionalProperties" : { - "$ref" : "#/definitions/VersionedParameterContext" - } - }, - "flowEncodingVersion" : { - "type" : "string", - "description" : "The optional encoding version of the flow contents." - }, - "flow" : { - "description" : "The flow this snapshot is for", - "readOnly" : true, - "$ref" : "#/definitions/VersionedFlow" - }, - "bucket" : { - "description" : "The bucket where the flow is located", - "readOnly" : true, - "$ref" : "#/definitions/Bucket" - }, - "latest" : { - "type" : "boolean" - } - } - }, - "VersionedFlowSnapshotEntity" : { - "type" : "object", - "properties" : { - "versionedFlowSnapshot" : { - "description" : "The versioned flow snapshot", - "$ref" : "#/definitions/VersionedFlowSnapshot" - }, - "processGroupRevision" : { - "description" : "The Revision of the Process Group under Version Control", - "$ref" : "#/definitions/RevisionDTO" - }, - "registryId" : { - "type" : "string", - "description" : "The ID of the Registry that this flow belongs to" - }, - "updateDescendantVersionedFlows" : { - "type" : "boolean", - "description" : "If the Process Group to be updated has a child or descendant Process Group that is also under Version Control, this specifies whether or not the contents of that child/descendant Process Group should be updated." - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - } - }, - "xml" : { - "name" : "versionedFlowSnapshotEntity" - } - }, - "VersionedFlowSnapshotMetadata" : { - "type" : "object", - "required" : [ "bucketIdentifier", "flowIdentifier", "version" ], - "properties" : { - "link" : { - "description" : "An WebLink to this entity.", - "readOnly" : true, - "$ref" : "#/definitions/JaxbLink" - }, - "bucketIdentifier" : { - "type" : "string", - "description" : "The identifier of the bucket this snapshot belongs to." - }, - "flowIdentifier" : { - "type" : "string", - "description" : "The identifier of the flow this snapshot belongs to." - }, - "version" : { - "type" : "integer", - "format" : "int32", - "description" : "The version of this snapshot of the flow.", - "minimum" : -1 - }, - "timestamp" : { - "type" : "integer", - "format" : "int64", - "description" : "The timestamp when the flow was saved, as milliseconds since epoch.", - "readOnly" : true, - "minimum" : 1 - }, - "author" : { - "type" : "string", - "description" : "The user that created this snapshot of the flow.", - "readOnly" : true - }, - "comments" : { - "type" : "string", - "description" : "The comments provided by the user when creating the snapshot." - } - } - }, - "VersionedFlowSnapshotMetadataEntity" : { - "type" : "object", - "properties" : { - "versionedFlowSnapshotMetadata" : { - "description" : "The collection of versioned flow snapshot metadata", - "$ref" : "#/definitions/VersionedFlowSnapshotMetadata" - }, - "registryId" : { - "type" : "string", - "description" : "The ID of the Registry that this flow belongs to" - } - }, - "xml" : { - "name" : "versionedFlowSnapshotMetadataEntity" - } - }, - "VersionedFlowSnapshotMetadataSetEntity" : { - "type" : "object", - "properties" : { - "versionedFlowSnapshotMetadataSet" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedFlowSnapshotMetadataEntity" - } - } - }, - "xml" : { - "name" : "versionedFlowSnapshotMetadataSetEntity" - } - }, - "VersionedFlowUpdateRequestDTO" : { - "type" : "object", - "properties" : { - "requestId" : { - "type" : "string", - "description" : "The unique ID of this request.", - "readOnly" : true - }, - "processGroupId" : { - "type" : "string", - "description" : "The unique ID of the Process Group that the variable registry belongs to" - }, - "uri" : { - "type" : "string", - "description" : "The URI for future requests to this drop request.", - "readOnly" : true - }, - "lastUpdated" : { - "type" : "string", - "description" : "The last time this request was updated.", - "readOnly" : true - }, - "complete" : { - "type" : "boolean", - "description" : "Whether or not this request has completed", - "readOnly" : true - }, - "failureReason" : { - "type" : "string", - "description" : "An explanation of why this request failed, or null if this request has not failed", - "readOnly" : true - }, - "percentCompleted" : { - "type" : "integer", - "format" : "int32", - "description" : "The percentage complete for the request, between 0 and 100", - "readOnly" : true - }, - "state" : { - "type" : "string", - "description" : "The state of the request", - "readOnly" : true - }, - "versionControlInformation" : { - "description" : "The VersionControlInformation that describes where the Versioned Flow is located; this may not be populated until the request is completed.", - "readOnly" : true, - "$ref" : "#/definitions/VersionControlInformationDTO" - } - } - }, - "VersionedFlowUpdateRequestEntity" : { - "type" : "object", - "properties" : { - "request" : { - "description" : "The Versioned Flow Update Request", - "$ref" : "#/definitions/VersionedFlowUpdateRequestDTO" - }, - "processGroupRevision" : { - "description" : "The revision for the Process Group that owns this variable registry.", - "$ref" : "#/definitions/RevisionDTO" - } - }, - "xml" : { - "name" : "versionedFlowUpdateRequestEntity" - } - }, - "VersionedFlowsEntity" : { - "type" : "object", - "properties" : { - "versionedFlows" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedFlowEntity" - } - } - }, - "xml" : { - "name" : "versionedFlowsEntity" - } - }, - "VersionedFunnel" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The component's unique identifier" - }, - "name" : { - "type" : "string", - "description" : "The component's name" - }, - "comments" : { - "type" : "string", - "description" : "The user-supplied comments for the component" - }, - "position" : { - "description" : "The component's position on the graph", - "$ref" : "#/definitions/Position" - }, - "componentType" : { - "type" : "string", - "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE" ] - }, - "groupIdentifier" : { - "type" : "string", - "description" : "The ID of the Process Group that this component belongs to" - } - } - }, - "VersionedLabel" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The component's unique identifier" - }, - "name" : { - "type" : "string", - "description" : "The component's name" - }, - "comments" : { - "type" : "string", - "description" : "The user-supplied comments for the component" - }, - "position" : { - "description" : "The component's position on the graph", - "$ref" : "#/definitions/Position" - }, - "label" : { - "type" : "string", - "description" : "The text that appears in the label." - }, - "width" : { - "type" : "number", - "format" : "double", - "description" : "The width of the label in pixels when at a 1:1 scale." - }, - "height" : { - "type" : "number", - "format" : "double", - "description" : "The height of the label in pixels when at a 1:1 scale." - }, - "style" : { - "type" : "object", - "description" : "The styles for this label (font-size : 12px, background-color : #eee, etc).", - "additionalProperties" : { - "type" : "string" - } - }, - "componentType" : { - "type" : "string", - "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE" ] - }, - "groupIdentifier" : { - "type" : "string", - "description" : "The ID of the Process Group that this component belongs to" - } - } - }, - "VersionedParameter" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The name of the parameter" - }, - "description" : { - "type" : "string", - "description" : "The description of the param" - }, - "sensitive" : { - "type" : "boolean", - "description" : "Whether or not the parameter value is sensitive" - }, - "value" : { - "type" : "string", - "description" : "The value of the parameter" - } - } - }, - "VersionedParameterContext" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The name of the context" - }, - "description" : { - "type" : "string", - "description" : "The description of the parameter context" - }, - "parameters" : { - "type" : "array", - "description" : "The parameters in the context", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedParameter" - } - } - } - }, - "VersionedPort" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The component's unique identifier" - }, - "name" : { - "type" : "string", - "description" : "The component's name" - }, - "comments" : { - "type" : "string", - "description" : "The user-supplied comments for the component" - }, - "position" : { - "description" : "The component's position on the graph", - "$ref" : "#/definitions/Position" - }, - "type" : { - "type" : "string", - "description" : "The type of port.", - "enum" : [ "INPUT_PORT", "OUTPUT_PORT" ] - }, - "concurrentlySchedulableTaskCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of tasks that should be concurrently scheduled for the port." - }, - "scheduledState" : { - "type" : "string", - "description" : "The scheduled state of the component", - "enum" : [ "ENABLED", "DISABLED" ] - }, - "allowRemoteAccess" : { - "type" : "boolean", - "description" : "Whether or not this port allows remote access for site-to-site" - }, - "componentType" : { - "type" : "string", - "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE" ] - }, - "groupIdentifier" : { - "type" : "string", - "description" : "The ID of the Process Group that this component belongs to" - } - } - }, - "VersionedProcessGroup" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The component's unique identifier" - }, - "name" : { - "type" : "string", - "description" : "The component's name" - }, - "comments" : { - "type" : "string", - "description" : "The user-supplied comments for the component" - }, - "position" : { - "description" : "The component's position on the graph", - "$ref" : "#/definitions/Position" - }, - "processGroups" : { - "type" : "array", - "description" : "The child Process Groups", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedProcessGroup" - } - }, - "remoteProcessGroups" : { - "type" : "array", - "description" : "The Remote Process Groups", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedRemoteProcessGroup" - } - }, - "processors" : { - "type" : "array", - "description" : "The Processors", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedProcessor" - } - }, - "inputPorts" : { - "type" : "array", - "description" : "The Input Ports", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedPort" - } - }, - "outputPorts" : { - "type" : "array", - "description" : "The Output Ports", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedPort" - } - }, - "connections" : { - "type" : "array", - "description" : "The Connections", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedConnection" - } - }, - "labels" : { - "type" : "array", - "description" : "The Labels", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedLabel" - } - }, - "funnels" : { - "type" : "array", - "description" : "The Funnels", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedFunnel" - } - }, - "controllerServices" : { - "type" : "array", - "description" : "The Controller Services", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedControllerService" - } - }, - "versionedFlowCoordinates" : { - "description" : "The coordinates where the remote flow is stored, or null if the Process Group is not directly under Version Control", - "$ref" : "#/definitions/VersionedFlowCoordinates" - }, - "variables" : { - "type" : "object", - "description" : "The Variables in the Variable Registry for this Process Group (not including any ancestor or descendant Process Groups)", - "additionalProperties" : { - "type" : "string" - } - }, - "parameterContextName" : { - "type" : "string", - "description" : "The name of the parameter context used by this process group" - }, - "componentType" : { - "type" : "string", - "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE" ] - }, - "groupIdentifier" : { - "type" : "string", - "description" : "The ID of the Process Group that this component belongs to" - } - } - }, - "VersionedProcessor" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The component's unique identifier" - }, - "name" : { - "type" : "string", - "description" : "The component's name" - }, - "comments" : { - "type" : "string", - "description" : "The user-supplied comments for the component" - }, - "position" : { - "description" : "The component's position on the graph", - "$ref" : "#/definitions/Position" - }, - "bundle" : { - "description" : "Information about the bundle from which the component came", - "$ref" : "#/definitions/Bundle" - }, - "style" : { - "type" : "object", - "description" : "Stylistic data for rendering in a UI", - "additionalProperties" : { - "type" : "string" - } - }, - "type" : { - "type" : "string", - "description" : "The type of Processor" - }, - "properties" : { - "type" : "object", - "description" : "The properties for the processor. Properties whose value is not set will only contain the property name.", - "additionalProperties" : { - "type" : "string" - } - }, - "propertyDescriptors" : { - "type" : "object", - "description" : "The property descriptors for the processor.", - "additionalProperties" : { - "$ref" : "#/definitions/VersionedPropertyDescriptor" - } - }, - "annotationData" : { - "type" : "string", - "description" : "The annotation data for the processor used to relay configuration between a custom UI and the procesosr." - }, - "schedulingPeriod" : { - "type" : "string", - "description" : "The frequency with which to schedule the processor. The format of the value will depend on th value of schedulingStrategy." - }, - "schedulingStrategy" : { - "type" : "string", - "description" : "Indcates whether the prcessor should be scheduled to run in event or timer driven mode." - }, - "executionNode" : { - "type" : "string", - "description" : "Indicates the node where the process will execute." - }, - "penaltyDuration" : { - "type" : "string", - "description" : "The amout of time that is used when the process penalizes a flowfile." - }, - "yieldDuration" : { - "type" : "string", - "description" : "The amount of time that must elapse before this processor is scheduled again after yielding." - }, - "bulletinLevel" : { - "type" : "string", - "description" : "The level at which the processor will report bulletins." - }, - "runDurationMillis" : { - "type" : "integer", - "format" : "int64", - "description" : "The run duration for the processor in milliseconds." - }, - "concurrentlySchedulableTaskCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of tasks that should be concurrently schedule for the processor. If the processor doesn't allow parallol processing then any positive input will be ignored." - }, - "autoTerminatedRelationships" : { - "type" : "array", - "description" : "The names of all relationships that cause a flow file to be terminated if the relationship is not connected elsewhere. This property differs from the 'isAutoTerminate' property of the RelationshipDTO in that the RelationshipDTO is meant to depict the current configuration, whereas this property can be set in a DTO when updating a Processor in order to change which Relationships should be auto-terminated.", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - }, - "scheduledState" : { - "type" : "string", - "description" : "The scheduled state of the component", - "enum" : [ "ENABLED", "DISABLED" ] - }, - "componentType" : { - "type" : "string", - "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE" ] - }, - "groupIdentifier" : { - "type" : "string", - "description" : "The ID of the Process Group that this component belongs to" - } - } - }, - "VersionedPropertyDescriptor" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The name of the property" - }, - "displayName" : { - "type" : "string", - "description" : "The display name of the property" - }, - "identifiesControllerService" : { - "type" : "boolean", - "description" : "Whether or not the property provides the identifier of a Controller Service" - }, - "sensitive" : { - "type" : "boolean", - "description" : "Whether or not the property is considered sensitive" - } - } - }, - "VersionedRemoteGroupPort" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The component's unique identifier" - }, - "name" : { - "type" : "string", - "description" : "The component's name" - }, - "comments" : { - "type" : "string", - "description" : "The user-supplied comments for the component" - }, - "position" : { - "description" : "The component's position on the graph", - "$ref" : "#/definitions/Position" - }, - "remoteGroupId" : { - "type" : "string", - "description" : "The id of the remote process group that the port resides in." - }, - "concurrentlySchedulableTaskCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of task that may transmit flowfiles to the target port concurrently." - }, - "useCompression" : { - "type" : "boolean", - "description" : "Whether the flowfiles are compressed when sent to the target port." - }, - "batchSize" : { - "description" : "The batch settings for data transmission.", - "$ref" : "#/definitions/BatchSize" - }, - "componentType" : { - "type" : "string", - "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE" ] - }, - "targetId" : { - "type" : "string", - "description" : "The ID of the port on the target NiFi instance" - }, - "scheduledState" : { - "type" : "string", - "description" : "The scheduled state of the component", - "enum" : [ "ENABLED", "DISABLED" ] - }, - "groupIdentifier" : { - "type" : "string", - "description" : "The ID of the Process Group that this component belongs to" - } - } - }, - "VersionedRemoteProcessGroup" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The component's unique identifier" - }, - "name" : { - "type" : "string", - "description" : "The component's name" - }, - "comments" : { - "type" : "string", - "description" : "The user-supplied comments for the component" - }, - "position" : { - "description" : "The component's position on the graph", - "$ref" : "#/definitions/Position" - }, - "targetUri" : { - "type" : "string", - "description" : "[DEPRECATED] The target URI of the remote process group. If target uri is not set, but uris are set, then returns the first uri in the uris. If neither target uri nor uris are set, then returns null." - }, - "targetUris" : { - "type" : "string", - "description" : "The target URIs of the remote process group. If target uris is not set but target uri is set, then returns the single target uri. If neither target uris nor target uri is set, then returns null." - }, - "communicationsTimeout" : { - "type" : "string", - "description" : "The time period used for the timeout when communicating with the target." - }, - "yieldDuration" : { - "type" : "string", - "description" : "When yielding, this amount of time must elapse before the remote process group is scheduled again." - }, - "transportProtocol" : { - "type" : "string", - "description" : "The Transport Protocol that is used for Site-to-Site communications", - "enum" : [ "RAW", "HTTP" ] - }, - "localNetworkInterface" : { - "type" : "string", - "description" : "The local network interface to send/receive data. If not specified, any local address is used. If clustered, all nodes must have an interface with this identifier." - }, - "proxyHost" : { - "type" : "string" - }, - "proxyPort" : { - "type" : "integer", - "format" : "int32" - }, - "proxyUser" : { - "type" : "string" - }, - "inputPorts" : { - "type" : "array", - "description" : "A Set of Input Ports that can be connected to, in order to send data to the remote NiFi instance", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedRemoteGroupPort" - } - }, - "outputPorts" : { - "type" : "array", - "description" : "A Set of Output Ports that can be connected to, in order to pull data from the remote NiFi instance", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedRemoteGroupPort" - } - }, - "componentType" : { - "type" : "string", - "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE" ] - }, - "groupIdentifier" : { - "type" : "string", - "description" : "The ID of the Process Group that this component belongs to" - } - } - } - } -} \ No newline at end of file diff --git a/resources/client_gen/api_defs/nifi-1.12.1.json b/resources/client_gen/api_defs/nifi-1.12.1.json deleted file mode 100644 index 74089bd1..00000000 --- a/resources/client_gen/api_defs/nifi-1.12.1.json +++ /dev/null @@ -1,21364 +0,0 @@ -{ - "swagger" : "2.0", - "info" : { - "description" : "The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and \n stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description,\n definitions of the expected input and output, potential response codes, and the authorizations required\n to invoke each service.", - "version" : "1.12.1", - "title" : "NiFi Rest Api", - "contact" : { - "url" : "https://nifi.apache.org", - "email" : "dev@nifi.apache.org" - }, - "license" : { - "name" : "Apache 2.0", - "url" : "http://www.apache.org/licenses/LICENSE-2.0.html" - } - }, - "basePath" : "/nifi-api", - "tags" : [ { - "name" : "access", - "description" : "Endpoints for obtaining an access token or checking access status." - }, { - "name" : "connections", - "description" : "Endpoint for managing a Connection." - }, { - "name" : "controller", - "description" : "Provides realtime command and control of this NiFi instance" - }, { - "name" : "controller-services", - "description" : "Endpoint for managing a Controller Service." - }, { - "name" : "counters", - "description" : "Endpoint for managing counters." - }, { - "name" : "data-transfer", - "description" : "Supports data transfers with this NiFi using HTTP based site to site" - }, { - "name" : "flow", - "description" : "Endpoint for accessing the flow structure and component status." - }, { - "name" : "flowfile-queues", - "description" : "Endpoint for managing a FlowFile Queue." - }, { - "name" : "funnel", - "description" : "Endpoint for managing a Funnel." - }, { - "name" : "input-ports", - "description" : "Endpoint for managing an Input Port." - }, { - "name" : "labels", - "description" : "Endpoint for managing a Label." - }, { - "name" : "output-ports", - "description" : "Endpoint for managing an Output Port." - }, { - "name" : "parameter-contexts", - "description" : "Endpoint for managing version control for a flow" - }, { - "name" : "policies", - "description" : "Endpoint for managing access policies." - }, { - "name" : "process-groups", - "description" : "Endpoint for managing a Process Group." - }, { - "name" : "processors", - "description" : "Endpoint for managing a Processor." - }, { - "name" : "provenance", - "description" : "Endpoint for accessing data flow provenance." - }, { - "name" : "provenance-events", - "description" : "Endpoint for accessing data flow provenance." - }, { - "name" : "remote-process-groups", - "description" : "Endpoint for managing a Remote Process Group." - }, { - "name" : "reporting-tasks", - "description" : "Endpoint for managing a Reporting Task." - }, { - "name" : "resources", - "description" : "Provides the resources in this NiFi that can have access/authorization policies." - }, { - "name" : "site-to-site", - "description" : "Provide access to site to site with this NiFi" - }, { - "name" : "snippets", - "description" : "Endpoint for accessing dataflow snippets." - }, { - "name" : "system-diagnostics", - "description" : "Endpoint for accessing system diagnostics." - }, { - "name" : "templates", - "description" : "Endpoint for managing a Template." - }, { - "name" : "tenants", - "description" : "Endpoint for managing users and user groups." - }, { - "name" : "versions", - "description" : "Endpoint for managing version control for a flow" - } ], - "schemes" : [ "http", "https" ], - "paths" : { - "/access" : { - "get" : { - "tags" : [ "access" ], - "summary" : "Gets the status the client's access", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getAccessStatus", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/AccessStatusEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Unable to determine access status because the client could not be authenticated." - }, - "403" : { - "description" : "Unable to determine access status because the client is not authorized to make this request." - }, - "409" : { - "description" : "Unable to determine access status because NiFi is not in the appropriate state." - }, - "500" : { - "description" : "Unable to determine access status because an unexpected error occurred." - } - } - } - }, - "/access/config" : { - "get" : { - "tags" : [ "access" ], - "summary" : "Retrieves the access configuration for this NiFi", - "description" : "", - "operationId" : "getLoginConfig", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/AccessConfigurationEntity" - } - } - } - } - }, - "/access/download-token" : { - "post" : { - "tags" : [ "access" ], - "summary" : "Creates a single use access token for downloading FlowFile content.", - "description" : "The token returned is a base64 encoded string. It is valid for a single request up to five minutes from being issued. It is used as a query parameter name 'access_token'.", - "operationId" : "createDownloadToken", - "consumes" : [ "application/x-www-form-urlencoded" ], - "produces" : [ "text/plain" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "Unable to create the download token because NiFi is not in the appropriate state. (i.e. may not have any tokens to grant or be configured to support username/password login)" - }, - "500" : { - "description" : "Unable to create download token because an unexpected error occurred." - } - } - } - }, - "/access/kerberos" : { - "post" : { - "tags" : [ "access" ], - "summary" : "Creates a token for accessing the REST API via Kerberos ticket exchange / SPNEGO negotiation", - "description" : "The token returned is formatted as a JSON Web Token (JWT). The token is base64 encoded and comprised of three parts. The header, the body, and the signature. The expiration of the token is a contained within the body. The token can be used in the Authorization header in the format 'Authorization: Bearer '.", - "operationId" : "createAccessTokenFromTicket", - "consumes" : [ "text/plain" ], - "produces" : [ "text/plain" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "NiFi was unable to complete the request because it did not contain a valid Kerberos ticket in the Authorization header. Retry this request after initializing a ticket with kinit and ensuring your browser is configured to support SPNEGO." - }, - "409" : { - "description" : "Unable to create access token because NiFi is not in the appropriate state. (i.e. may not be configured to support Kerberos login." - }, - "500" : { - "description" : "Unable to create access token because an unexpected error occurred." - } - } - } - }, - "/access/knox/callback" : { - "get" : { - "tags" : [ "access" ], - "summary" : "Redirect/callback URI for processing the result of the Apache Knox login sequence.", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "knoxCallback", - "consumes" : [ "*/*" ], - "produces" : [ "*/*" ], - "responses" : { - "default" : { - "description" : "successful operation" - } - } - } - }, - "/access/knox/logout" : { - "get" : { - "tags" : [ "access" ], - "summary" : "Performs a logout in the Apache Knox.", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "knoxLogout", - "consumes" : [ "*/*" ], - "produces" : [ "*/*" ], - "responses" : { - "default" : { - "description" : "successful operation" - } - } - } - }, - "/access/knox/request" : { - "get" : { - "tags" : [ "access" ], - "summary" : "Initiates a request to authenticate through Apache Knox.", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "knoxRequest", - "consumes" : [ "*/*" ], - "produces" : [ "*/*" ], - "responses" : { - "default" : { - "description" : "successful operation" - } - } - } - }, - "/access/logout" : { - "delete" : { - "tags" : [ "access" ], - "summary" : "Performs a logout for other providers that have been issued a JWT.", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "logOut", - "consumes" : [ "*/*" ], - "produces" : [ "*/*" ], - "responses" : { - "200" : { - "description" : "User was logged out successfully." - }, - "401" : { - "description" : "Authentication token provided was empty or not in the correct JWT format." - }, - "500" : { - "description" : "Client failed to log out." - } - } - } - }, - "/access/oidc/callback" : { - "get" : { - "tags" : [ "access" ], - "summary" : "Redirect/callback URI for processing the result of the OpenId Connect login sequence.", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "oidcCallback", - "consumes" : [ "*/*" ], - "produces" : [ "*/*" ], - "responses" : { - "default" : { - "description" : "successful operation" - } - } - } - }, - "/access/oidc/exchange" : { - "post" : { - "tags" : [ "access" ], - "summary" : "Retrieves a JWT following a successful login sequence using the configured OpenId Connect provider.", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "oidcExchange", - "consumes" : [ "*/*" ], - "produces" : [ "text/plain" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - } - } - } - }, - "/access/oidc/logout" : { - "get" : { - "tags" : [ "access" ], - "summary" : "Performs a logout in the OpenId Provider.", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "oidcLogout", - "consumes" : [ "*/*" ], - "produces" : [ "*/*" ], - "responses" : { - "default" : { - "description" : "successful operation" - } - } - } - }, - "/access/oidc/request" : { - "get" : { - "tags" : [ "access" ], - "summary" : "Initiates a request to authenticate through the configured OpenId Connect provider.", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "oidcRequest", - "consumes" : [ "*/*" ], - "produces" : [ "*/*" ], - "responses" : { - "default" : { - "description" : "successful operation" - } - } - } - }, - "/access/token" : { - "post" : { - "tags" : [ "access" ], - "summary" : "Creates a token for accessing the REST API via username/password", - "description" : "The token returned is formatted as a JSON Web Token (JWT). The token is base64 encoded and comprised of three parts. The header, the body, and the signature. The expiration of the token is a contained within the body. The token can be used in the Authorization header in the format 'Authorization: Bearer '.", - "operationId" : "createAccessToken", - "consumes" : [ "application/x-www-form-urlencoded" ], - "produces" : [ "text/plain" ], - "parameters" : [ { - "name" : "username", - "in" : "formData", - "required" : false, - "type" : "string" - }, { - "name" : "password", - "in" : "formData", - "required" : false, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "Unable to create access token because NiFi is not in the appropriate state. (i.e. may not be configured to support username/password login." - }, - "500" : { - "description" : "Unable to create access token because an unexpected error occurred." - } - } - } - }, - "/access/ui-extension-token" : { - "post" : { - "tags" : [ "access" ], - "summary" : "Creates a single use access token for accessing a NiFi UI extension.", - "description" : "The token returned is a base64 encoded string. It is valid for a single request up to five minutes from being issued. It is used as a query parameter name 'access_token'.", - "operationId" : "createUiExtensionToken", - "consumes" : [ "application/x-www-form-urlencoded" ], - "produces" : [ "text/plain" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "Unable to create the download token because NiFi is not in the appropriate state. (i.e. may not have any tokens to grant or be configured to support username/password login)" - }, - "500" : { - "description" : "Unable to create download token because an unexpected error occurred." - } - } - } - }, - "/connections/{id}" : { - "get" : { - "tags" : [ "connections" ], - "summary" : "Gets a connection", - "description" : "", - "operationId" : "getConnection", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The connection id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ConnectionEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read Source - /{component-type}/{uuid}" : [ ] - }, { - "Read Destination - /{component-type}/{uuid}" : [ ] - } ] - }, - "put" : { - "tags" : [ "connections" ], - "summary" : "Updates a connection", - "description" : "", - "operationId" : "updateConnection", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The connection id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The connection configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ConnectionEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ConnectionEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write Source - /{component-type}/{uuid}" : [ ] - }, { - "Write Destination - /{component-type}/{uuid}" : [ ] - }, { - "Write New Destination - /{component-type}/{uuid} - if updating Destination" : [ ] - }, { - "Write Process Group - /process-groups/{uuid} - if updating Destination" : [ ] - } ] - }, - "delete" : { - "tags" : [ "connections" ], - "summary" : "Deletes a connection", - "description" : "", - "operationId" : "deleteConnection", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The revision is used to verify the client is working with the latest version of the flow.", - "required" : false, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The connection id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ConnectionEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write Source - /{component-type}/{uuid}" : [ ] - }, { - "Write - Parent Process Group - /process-groups/{uuid}" : [ ] - }, { - "Write Destination - /{component-type}/{uuid}" : [ ] - } ] - } - }, - "/controller-services/{id}" : { - "get" : { - "tags" : [ "controller-services" ], - "summary" : "Gets a controller service", - "description" : "", - "operationId" : "getControllerService", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The controller service id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ControllerServiceEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /controller-services/{uuid}" : [ ] - } ] - }, - "put" : { - "tags" : [ "controller-services" ], - "summary" : "Updates a controller service", - "description" : "", - "operationId" : "updateControllerService", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The controller service id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The controller service configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ControllerServiceEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ControllerServiceEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /controller-services/{uuid}" : [ ] - }, { - "Read - any referenced Controller Services if this request changes the reference - /controller-services/{uuid}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "controller-services" ], - "summary" : "Deletes a controller service", - "description" : "", - "operationId" : "removeControllerService", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The revision is used to verify the client is working with the latest version of the flow.", - "required" : false, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The controller service id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ControllerServiceEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /controller-services/{uuid}" : [ ] - }, { - "Write - Parent Process Group if scoped by Process Group - /process-groups/{uuid}" : [ ] - }, { - "Write - Controller if scoped by Controller - /controller" : [ ] - }, { - "Read - any referenced Controller Services - /controller-services/{uuid}" : [ ] - } ] - } - }, - "/controller-services/{id}/descriptors" : { - "get" : { - "tags" : [ "controller-services" ], - "summary" : "Gets a controller service property descriptor", - "description" : "", - "operationId" : "getPropertyDescriptor", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The controller service id.", - "required" : true, - "type" : "string" - }, { - "name" : "propertyName", - "in" : "query", - "description" : "The property name to return the descriptor for.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/PropertyDescriptorEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /controller-services/{uuid}" : [ ] - } ] - } - }, - "/controller-services/{id}/references" : { - "get" : { - "tags" : [ "controller-services" ], - "summary" : "Gets a controller service", - "description" : "", - "operationId" : "getControllerServiceReferences", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The controller service id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ControllerServiceReferencingComponentsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /controller-services/{uuid}" : [ ] - } ] - }, - "put" : { - "tags" : [ "controller-services" ], - "summary" : "Updates a controller services references", - "description" : "", - "operationId" : "updateControllerServiceReferences", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The controller service id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The controller service request update request.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/UpdateControllerServiceReferenceRequestEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ControllerServiceReferencingComponentsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /{component-type}/{uuid} or /operate/{component-type}/{uuid} - For each referencing component specified" : [ ] - } ] - } - }, - "/controller-services/{id}/run-status" : { - "put" : { - "tags" : [ "controller-services" ], - "summary" : "Updates run status of a controller service", - "description" : "", - "operationId" : "updateRunStatus", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The controller service id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The controller service run status.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ControllerServiceRunStatusEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ControllerServiceEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /controller-services/{uuid} or /operation/controller-services/{uuid}" : [ ] - } ] - } - }, - "/controller-services/{id}/state" : { - "get" : { - "tags" : [ "controller-services" ], - "summary" : "Gets the state for a controller service", - "description" : "", - "operationId" : "getState", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The controller service id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ComponentStateEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /controller-services/{uuid}" : [ ] - } ] - } - }, - "/controller-services/{id}/state/clear-requests" : { - "post" : { - "tags" : [ "controller-services" ], - "summary" : "Clears the state for a controller service", - "description" : "", - "operationId" : "clearState", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The controller service id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ComponentStateEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /controller-services/{uuid}" : [ ] - } ] - } - }, - "/controller/bulletin" : { - "post" : { - "tags" : [ "controller" ], - "summary" : "Creates a new bulletin", - "description" : "", - "operationId" : "createBulletin", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The reporting task configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/BulletinEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /controller" : [ ] - } ] - } - }, - "/controller/cluster" : { - "get" : { - "tags" : [ "controller" ], - "summary" : "Gets the contents of the cluster", - "description" : "Returns the contents of the cluster including all nodes and their status.", - "operationId" : "getCluster", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ClusterEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /controller" : [ ] - } ] - } - }, - "/controller/cluster/nodes/{id}" : { - "get" : { - "tags" : [ "controller" ], - "summary" : "Gets a node in the cluster", - "description" : "", - "operationId" : "getNode", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The node id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/NodeEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /controller" : [ ] - } ] - }, - "put" : { - "tags" : [ "controller" ], - "summary" : "Updates a node in the cluster", - "description" : "", - "operationId" : "updateNode", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The node id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The node configuration. The only configuration that will be honored at this endpoint is the status.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/NodeEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/NodeEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /controller" : [ ] - } ] - }, - "delete" : { - "tags" : [ "controller" ], - "summary" : "Removes a node from the cluster", - "description" : "", - "operationId" : "deleteNode", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The node id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/NodeEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /controller" : [ ] - } ] - } - }, - "/controller/config" : { - "get" : { - "tags" : [ "controller" ], - "summary" : "Retrieves the configuration for this NiFi Controller", - "description" : "", - "operationId" : "getControllerConfig", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ControllerConfigurationEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /controller" : [ ] - } ] - }, - "put" : { - "tags" : [ "controller" ], - "summary" : "Retrieves the configuration for this NiFi", - "description" : "", - "operationId" : "updateControllerConfig", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The controller configuration.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ControllerConfigurationEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ControllerConfigurationEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /controller" : [ ] - } ] - } - }, - "/controller/controller-services" : { - "post" : { - "tags" : [ "controller" ], - "summary" : "Creates a new controller service", - "description" : "", - "operationId" : "createControllerService", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The controller service configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ControllerServiceEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ControllerServiceEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /controller" : [ ] - }, { - "Read - any referenced Controller Services - /controller-services/{uuid}" : [ ] - }, { - "Write - if the Controller Service is restricted - /restricted-components" : [ ] - } ] - } - }, - "/controller/history" : { - "delete" : { - "tags" : [ "controller" ], - "summary" : "Purges history", - "description" : "", - "operationId" : "deleteHistory", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "endDate", - "in" : "query", - "description" : "Purge actions before this date/time.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/HistoryEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /controller" : [ ] - } ] - } - }, - "/controller/registry-clients" : { - "get" : { - "tags" : [ "controller" ], - "summary" : "Gets the listing of available registry clients", - "description" : "", - "operationId" : "getRegistryClients", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/RegistryClientsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - }, - "post" : { - "tags" : [ "controller" ], - "summary" : "Creates a new registry client", - "description" : "", - "operationId" : "createRegistryClient", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The registry configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/RegistryClientEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/RegistryClientEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /controller" : [ ] - } ] - } - }, - "/controller/registry-clients/{id}" : { - "get" : { - "tags" : [ "controller" ], - "summary" : "Gets a registry client", - "description" : "", - "operationId" : "getRegistryClient", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The registry id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/RegistryClientEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /controller" : [ ] - } ] - }, - "put" : { - "tags" : [ "controller" ], - "summary" : "Updates a registry client", - "description" : "", - "operationId" : "updateRegistryClient", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The registry id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The registry configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/RegistryClientEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/RegistryClientEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /controller" : [ ] - } ] - }, - "delete" : { - "tags" : [ "controller" ], - "summary" : "Deletes a registry client", - "description" : "", - "operationId" : "deleteRegistryClient", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The revision is used to verify the client is working with the latest version of the flow.", - "required" : false, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The registry id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/RegistryClientEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /controller" : [ ] - } ] - } - }, - "/controller/reporting-tasks" : { - "post" : { - "tags" : [ "controller" ], - "summary" : "Creates a new reporting task", - "description" : "", - "operationId" : "createReportingTask", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The reporting task configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ReportingTaskEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ReportingTaskEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /controller" : [ ] - }, { - "Read - any referenced Controller Services - /controller-services/{uuid}" : [ ] - }, { - "Write - if the Reporting Task is restricted - /restricted-components" : [ ] - } ] - } - }, - "/counters" : { - "get" : { - "tags" : [ "counters" ], - "summary" : "Gets the current counters for this NiFi", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getCounters", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "nodewise", - "in" : "query", - "description" : "Whether or not to include the breakdown per node. Optional, defaults to false", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "clusterNodeId", - "in" : "query", - "description" : "The id of the node where to get the status.", - "required" : false, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/CountersEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /counters" : [ ] - } ] - } - }, - "/counters/{id}" : { - "put" : { - "tags" : [ "counters" ], - "summary" : "Updates the specified counter. This will reset the counter value to 0", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "updateCounter", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The id of the counter.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/CounterEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /counters" : [ ] - } ] - } - }, - "/data-transfer/input-ports/{portId}/transactions/{transactionId}" : { - "put" : { - "tags" : [ "data-transfer" ], - "summary" : "Extend transaction TTL", - "description" : "", - "operationId" : "extendInputPortTransactionTTL", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "portId", - "in" : "path", - "required" : true, - "type" : "string" - }, { - "name" : "transactionId", - "in" : "path", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/TransactionResultEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /data-transfer/input-ports/{uuid}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "data-transfer" ], - "summary" : "Commit or cancel the specified transaction", - "description" : "", - "operationId" : "commitInputPortTransaction", - "consumes" : [ "application/octet-stream" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "responseCode", - "in" : "query", - "description" : "The response code. Available values are BAD_CHECKSUM(19), CONFIRM_TRANSACTION(12) or CANCEL_TRANSACTION(15).", - "required" : true, - "type" : "integer", - "format" : "int32" - }, { - "name" : "portId", - "in" : "path", - "description" : "The input port id.", - "required" : true, - "type" : "string" - }, { - "name" : "transactionId", - "in" : "path", - "description" : "The transaction id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/TransactionResultEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - }, - "503" : { - "description" : "NiFi instance is not ready for serving request, or temporarily overloaded. Retrying the same request later may be successful" - } - }, - "security" : [ { - "Write - /data-transfer/input-ports/{uuid}" : [ ] - } ] - } - }, - "/data-transfer/input-ports/{portId}/transactions/{transactionId}/flow-files" : { - "post" : { - "tags" : [ "data-transfer" ], - "summary" : "Transfer flow files to the input port", - "description" : "", - "operationId" : "receiveFlowFiles", - "consumes" : [ "application/octet-stream" ], - "produces" : [ "text/plain" ], - "parameters" : [ { - "name" : "portId", - "in" : "path", - "description" : "The input port id.", - "required" : true, - "type" : "string" - }, { - "name" : "transactionId", - "in" : "path", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - }, - "503" : { - "description" : "NiFi instance is not ready for serving request, or temporarily overloaded. Retrying the same request later may be successful" - } - }, - "security" : [ { - "Write - /data-transfer/input-ports/{uuid}" : [ ] - } ] - } - }, - "/data-transfer/output-ports/{portId}/transactions/{transactionId}" : { - "put" : { - "tags" : [ "data-transfer" ], - "summary" : "Extend transaction TTL", - "description" : "", - "operationId" : "extendOutputPortTransactionTTL", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "portId", - "in" : "path", - "required" : true, - "type" : "string" - }, { - "name" : "transactionId", - "in" : "path", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/TransactionResultEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - }, - "503" : { - "description" : "NiFi instance is not ready for serving request, or temporarily overloaded. Retrying the same request later may be successful" - } - }, - "security" : [ { - "Write - /data-transfer/output-ports/{uuid}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "data-transfer" ], - "summary" : "Commit or cancel the specified transaction", - "description" : "", - "operationId" : "commitOutputPortTransaction", - "consumes" : [ "application/octet-stream" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "responseCode", - "in" : "query", - "description" : "The response code. Available values are CONFIRM_TRANSACTION(12) or CANCEL_TRANSACTION(15).", - "required" : true, - "type" : "integer", - "format" : "int32" - }, { - "name" : "checksum", - "in" : "query", - "description" : "A checksum calculated at client side using CRC32 to check flow file content integrity. It must match with the value calculated at server side.", - "required" : true, - "type" : "string" - }, { - "name" : "portId", - "in" : "path", - "description" : "The output port id.", - "required" : true, - "type" : "string" - }, { - "name" : "transactionId", - "in" : "path", - "description" : "The transaction id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/TransactionResultEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - }, - "503" : { - "description" : "NiFi instance is not ready for serving request, or temporarily overloaded. Retrying the same request later may be successful" - } - }, - "security" : [ { - "Write - /data-transfer/output-ports/{uuid}" : [ ] - } ] - } - }, - "/data-transfer/output-ports/{portId}/transactions/{transactionId}/flow-files" : { - "get" : { - "tags" : [ "data-transfer" ], - "summary" : "Transfer flow files from the output port", - "description" : "", - "operationId" : "transferFlowFiles", - "consumes" : [ "*/*" ], - "produces" : [ "application/octet-stream" ], - "parameters" : [ { - "name" : "portId", - "in" : "path", - "description" : "The output port id.", - "required" : true, - "type" : "string" - }, { - "name" : "transactionId", - "in" : "path", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "There is no flow file to return.", - "schema" : { - "$ref" : "#/definitions/StreamingOutput" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - }, - "503" : { - "description" : "NiFi instance is not ready for serving request, or temporarily overloaded. Retrying the same request later may be successful" - } - }, - "security" : [ { - "Write - /data-transfer/output-ports/{uuid}" : [ ] - } ] - } - }, - "/data-transfer/{portType}/{portId}/transactions" : { - "post" : { - "tags" : [ "data-transfer" ], - "summary" : "Create a transaction to the specified output port or input port", - "description" : "", - "operationId" : "createPortTransaction", - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "portType", - "in" : "path", - "description" : "The port type.", - "required" : true, - "type" : "string", - "enum" : [ "input-ports", "output-ports" ] - }, { - "name" : "portId", - "in" : "path", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/TransactionResultEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - }, - "503" : { - "description" : "NiFi instance is not ready for serving request, or temporarily overloaded. Retrying the same request later may be successful" - } - }, - "security" : [ { - "Write - /data-transfer/{component-type}/{uuid}" : [ ] - } ] - } - }, - "/flow/about" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Retrieves details about this NiFi to put in the About dialog", - "description" : "", - "operationId" : "getAboutInfo", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/AboutEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/banners" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Retrieves the banners for this NiFi", - "description" : "", - "operationId" : "getBanners", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/BannerEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/bulletin-board" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets current bulletins", - "description" : "", - "operationId" : "getBulletinBoard", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "after", - "in" : "query", - "description" : "Includes bulletins with an id after this value.", - "required" : false, - "type" : "string" - }, { - "name" : "sourceName", - "in" : "query", - "description" : "Includes bulletins originating from this sources whose name match this regular expression.", - "required" : false, - "type" : "string" - }, { - "name" : "message", - "in" : "query", - "description" : "Includes bulletins whose message that match this regular expression.", - "required" : false, - "type" : "string" - }, { - "name" : "sourceId", - "in" : "query", - "description" : "Includes bulletins originating from this sources whose id match this regular expression.", - "required" : false, - "type" : "string" - }, { - "name" : "groupId", - "in" : "query", - "description" : "Includes bulletins originating from this sources whose group id match this regular expression.", - "required" : false, - "type" : "string" - }, { - "name" : "limit", - "in" : "query", - "description" : "The number of bulletins to limit the response to.", - "required" : false, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/BulletinBoardEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - }, { - "Read - /{component-type}/{uuid} - For component specific bulletins" : [ ] - } ] - } - }, - "/flow/client-id" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Generates a client id.", - "description" : "", - "operationId" : "generateClientId", - "consumes" : [ "*/*" ], - "produces" : [ "text/plain" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/cluster/search-results" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Searches the cluster for a node with the specified address", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "searchCluster", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "q", - "in" : "query", - "description" : "Node address to search for.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ClusterSearchResultsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/cluster/summary" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "The cluster summary for this NiFi", - "description" : "", - "operationId" : "getClusterSummary", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ClusteSummaryEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/config" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Retrieves the configuration for this NiFi flow", - "description" : "", - "operationId" : "getFlowConfig", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/FlowConfigurationEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/connections/{id}/statistics" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets statistics for a connection", - "description" : "", - "operationId" : "getConnectionStatistics", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "nodewise", - "in" : "query", - "description" : "Whether or not to include the breakdown per node. Optional, defaults to false", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "clusterNodeId", - "in" : "query", - "description" : "The id of the node where to get the statistics.", - "required" : false, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The connection id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ConnectionStatisticsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/connections/{id}/status" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets status for a connection", - "description" : "", - "operationId" : "getConnectionStatus", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "nodewise", - "in" : "query", - "description" : "Whether or not to include the breakdown per node. Optional, defaults to false", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "clusterNodeId", - "in" : "query", - "description" : "The id of the node where to get the status.", - "required" : false, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The connection id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ConnectionStatusEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/connections/{id}/status/history" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets the status history for a connection", - "description" : "", - "operationId" : "getConnectionStatusHistory", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The connection id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/StatusHistoryEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/controller-service-types" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Retrieves the types of controller services that this NiFi supports", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getControllerServiceTypes", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "serviceType", - "in" : "query", - "description" : "If specified, will only return controller services that are compatible with this type of service.", - "required" : false, - "type" : "string" - }, { - "name" : "serviceBundleGroup", - "in" : "query", - "description" : "If serviceType specified, is the bundle group of the serviceType.", - "required" : false, - "type" : "string" - }, { - "name" : "serviceBundleArtifact", - "in" : "query", - "description" : "If serviceType specified, is the bundle artifact of the serviceType.", - "required" : false, - "type" : "string" - }, { - "name" : "serviceBundleVersion", - "in" : "query", - "description" : "If serviceType specified, is the bundle version of the serviceType.", - "required" : false, - "type" : "string" - }, { - "name" : "bundleGroupFilter", - "in" : "query", - "description" : "If specified, will only return types that are a member of this bundle group.", - "required" : false, - "type" : "string" - }, { - "name" : "bundleArtifactFilter", - "in" : "query", - "description" : "If specified, will only return types that are a member of this bundle artifact.", - "required" : false, - "type" : "string" - }, { - "name" : "typeFilter", - "in" : "query", - "description" : "If specified, will only return types whose fully qualified classname matches.", - "required" : false, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ControllerServiceTypesEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/controller/bulletins" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Retrieves Controller level bulletins", - "description" : "", - "operationId" : "getBulletins", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ControllerBulletinsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - }, { - "Read - /controller - For controller bulletins" : [ ] - }, { - "Read - /controller-services/{uuid} - For controller service bulletins" : [ ] - }, { - "Read - /reporting-tasks/{uuid} - For reporting task bulletins" : [ ] - } ] - } - }, - "/flow/controller/controller-services" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets controller services for reporting tasks", - "description" : "", - "operationId" : "getControllerServicesFromController", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ControllerServicesEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/current-user" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Retrieves the user identity of the user making the request", - "description" : "", - "operationId" : "getCurrentUser", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/CurrentUserEntity" - } - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/history" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets configuration history", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "queryHistory", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "offset", - "in" : "query", - "description" : "The offset into the result set.", - "required" : true, - "type" : "string" - }, { - "name" : "count", - "in" : "query", - "description" : "The number of actions to return.", - "required" : true, - "type" : "string" - }, { - "name" : "sortColumn", - "in" : "query", - "description" : "The field to sort on.", - "required" : false, - "type" : "string" - }, { - "name" : "sortOrder", - "in" : "query", - "description" : "The direction to sort.", - "required" : false, - "type" : "string" - }, { - "name" : "startDate", - "in" : "query", - "description" : "Include actions after this date.", - "required" : false, - "type" : "string" - }, { - "name" : "endDate", - "in" : "query", - "description" : "Include actions before this date.", - "required" : false, - "type" : "string" - }, { - "name" : "userIdentity", - "in" : "query", - "description" : "Include actions performed by this user.", - "required" : false, - "type" : "string" - }, { - "name" : "sourceId", - "in" : "query", - "description" : "Include actions on this component.", - "required" : false, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/HistoryEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/history/components/{componentId}" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets configuration history for a component", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getComponentHistory", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "componentId", - "in" : "path", - "description" : "The component id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ComponentHistoryEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - }, { - "Read underlying component - /{component-type}/{uuid}" : [ ] - } ] - } - }, - "/flow/history/{id}" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets an action", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getAction", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The action id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ActionEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/input-ports/{id}/status" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets status for an input port", - "description" : "", - "operationId" : "getInputPortStatus", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "nodewise", - "in" : "query", - "description" : "Whether or not to include the breakdown per node. Optional, defaults to false", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "clusterNodeId", - "in" : "query", - "description" : "The id of the node where to get the status.", - "required" : false, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The input port id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/PortStatusEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/metrics/{producer}" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets all metrics for the flow from a particular node", - "description" : "", - "operationId" : "getFlowMetrics", - "consumes" : [ "*/*" ], - "produces" : [ "*/*" ], - "parameters" : [ { - "name" : "producer", - "in" : "path", - "description" : "The producer for flow file metrics. Each producer may have its own output format.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/StreamingOutput" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/output-ports/{id}/status" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets status for an output port", - "description" : "", - "operationId" : "getOutputPortStatus", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "nodewise", - "in" : "query", - "description" : "Whether or not to include the breakdown per node. Optional, defaults to false", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "clusterNodeId", - "in" : "query", - "description" : "The id of the node where to get the status.", - "required" : false, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The output port id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/PortStatusEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/parameter-contexts" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets all Parameter Contexts", - "description" : "", - "operationId" : "getParameterContexts", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ParameterContextsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /parameter-contexts/{id} for each Parameter Context" : [ ] - } ] - } - }, - "/flow/prioritizers" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Retrieves the types of prioritizers that this NiFi supports", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getPrioritizers", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/PrioritizerTypesEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/process-groups/{id}" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets a process group", - "description" : "", - "operationId" : "getFlow", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessGroupFlowEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - }, - "put" : { - "tags" : [ "flow" ], - "summary" : "Schedule or unschedule components in the specified Process Group.", - "description" : "", - "operationId" : "scheduleComponents", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The request to schedule or unschedule. If the comopnents in the request are not specified, all authorized components will be considered.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ScheduleComponentsEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ScheduleComponentsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - }, { - "Write - /{component-type}/{uuid} or /operation/{component-type}/{uuid} - For every component being scheduled/unscheduled" : [ ] - } ] - } - }, - "/flow/process-groups/{id}/controller-services" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets all controller services", - "description" : "", - "operationId" : "getControllerServicesFromGroup", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "name" : "includeAncestorGroups", - "in" : "query", - "description" : "Whether or not to include parent/ancestory process groups", - "required" : false, - "type" : "boolean", - "default" : true - }, { - "name" : "includeDescendantGroups", - "in" : "query", - "description" : "Whether or not to include descendant process groups", - "required" : false, - "type" : "boolean", - "default" : false - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ControllerServicesEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - }, - "put" : { - "tags" : [ "flow" ], - "summary" : "Enable or disable Controller Services in the specified Process Group.", - "description" : "", - "operationId" : "activateControllerServices", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The request to schedule or unschedule. If the comopnents in the request are not specified, all authorized components will be considered.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ActivateControllerServicesEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ActivateControllerServicesEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - }, { - "Write - /{component-type}/{uuid} or /operation/{component-type}/{uuid} - For every service being enabled/disabled" : [ ] - } ] - } - }, - "/flow/process-groups/{id}/status" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets the status for a process group", - "description" : "The status for a process group includes status for all descendent components. When invoked on the root group with recursive set to true, it will return the current status of every component in the flow.", - "operationId" : "getProcessGroupStatus", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "recursive", - "in" : "query", - "description" : "Whether all descendant groups and the status of their content will be included. Optional, defaults to false", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "nodewise", - "in" : "query", - "description" : "Whether or not to include the breakdown per node. Optional, defaults to false", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "clusterNodeId", - "in" : "query", - "description" : "The id of the node where to get the status.", - "required" : false, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessGroupStatusEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/process-groups/{id}/status/history" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets status history for a remote process group", - "description" : "", - "operationId" : "getProcessGroupStatusHistory", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/StatusHistoryEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/processor-types" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Retrieves the types of processors that this NiFi supports", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getProcessorTypes", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bundleGroupFilter", - "in" : "query", - "description" : "If specified, will only return types that are a member of this bundle group.", - "required" : false, - "type" : "string" - }, { - "name" : "bundleArtifactFilter", - "in" : "query", - "description" : "If specified, will only return types that are a member of this bundle artifact.", - "required" : false, - "type" : "string" - }, { - "name" : "type", - "in" : "query", - "description" : "If specified, will only return types whose fully qualified classname matches.", - "required" : false, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessorTypesEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/processors/{id}/status" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets status for a processor", - "description" : "", - "operationId" : "getProcessorStatus", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "nodewise", - "in" : "query", - "description" : "Whether or not to include the breakdown per node. Optional, defaults to false", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "clusterNodeId", - "in" : "query", - "description" : "The id of the node where to get the status.", - "required" : false, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The processor id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessorStatusEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/processors/{id}/status/history" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets status history for a processor", - "description" : "", - "operationId" : "getProcessorStatusHistory", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The processor id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/StatusHistoryEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/registries" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets the listing of available registries", - "description" : "", - "operationId" : "getRegistries", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/RegistryClientsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/registries/{id}/buckets" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets the buckets from the specified registry for the current user", - "description" : "", - "operationId" : "getBuckets", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The registry id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/BucketsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/registries/{registry-id}/buckets/{bucket-id}/flows" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets the flows from the specified registry and bucket for the current user", - "description" : "", - "operationId" : "getFlows", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "registry-id", - "in" : "path", - "description" : "The registry id.", - "required" : true, - "type" : "string" - }, { - "name" : "bucket-id", - "in" : "path", - "description" : "The bucket id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlowsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/registries/{registry-id}/buckets/{bucket-id}/flows/{flow-id}/versions" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets the flow versions from the specified registry and bucket for the specified flow for the current user", - "description" : "", - "operationId" : "getVersions", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "registry-id", - "in" : "path", - "description" : "The registry id.", - "required" : true, - "type" : "string" - }, { - "name" : "bucket-id", - "in" : "path", - "description" : "The bucket id.", - "required" : true, - "type" : "string" - }, { - "name" : "flow-id", - "in" : "path", - "description" : "The flow id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlowSnapshotMetadataSetEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/remote-process-groups/{id}/status" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets status for a remote process group", - "description" : "", - "operationId" : "getRemoteProcessGroupStatus", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "nodewise", - "in" : "query", - "description" : "Whether or not to include the breakdown per node. Optional, defaults to false", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "clusterNodeId", - "in" : "query", - "description" : "The id of the node where to get the status.", - "required" : false, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The remote process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/RemoteProcessGroupStatusEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/remote-process-groups/{id}/status/history" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets the status history", - "description" : "", - "operationId" : "getRemoteProcessGroupStatusHistory", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The remote process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/StatusHistoryEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/reporting-task-types" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Retrieves the types of reporting tasks that this NiFi supports", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getReportingTaskTypes", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bundleGroupFilter", - "in" : "query", - "description" : "If specified, will only return types that are a member of this bundle group.", - "required" : false, - "type" : "string" - }, { - "name" : "bundleArtifactFilter", - "in" : "query", - "description" : "If specified, will only return types that are a member of this bundle artifact.", - "required" : false, - "type" : "string" - }, { - "name" : "type", - "in" : "query", - "description" : "If specified, will only return types whose fully qualified classname matches.", - "required" : false, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ReportingTaskTypesEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/reporting-tasks" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets all reporting tasks", - "description" : "", - "operationId" : "getReportingTasks", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ReportingTasksEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/search-results" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Performs a search against this NiFi using the specified search term", - "description" : "Only search results from authorized components will be returned.", - "operationId" : "searchFlow", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "q", - "in" : "query", - "required" : false, - "type" : "string" - }, { - "name" : "a", - "in" : "query", - "required" : false, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/SearchResultsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/status" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets the current status of this NiFi", - "description" : "", - "operationId" : "getControllerStatus", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ControllerStatusEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/templates" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets all templates", - "description" : "", - "operationId" : "getTemplates", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/TemplatesEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flowfile-queues/{id}/drop-requests" : { - "post" : { - "tags" : [ "flowfile-queues" ], - "summary" : "Creates a request to drop the contents of the queue in this connection.", - "description" : "", - "operationId" : "createDropRequest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The connection id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/DropRequestEntity" - } - }, - "202" : { - "description" : "The request has been accepted. A HTTP response header will contain the URI where the response can be polled." - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write Source Data - /data/{component-type}/{uuid}" : [ ] - } ] - } - }, - "/flowfile-queues/{id}/drop-requests/{drop-request-id}" : { - "get" : { - "tags" : [ "flowfile-queues" ], - "summary" : "Gets the current status of a drop request for the specified connection.", - "description" : "", - "operationId" : "getDropRequest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The connection id.", - "required" : true, - "type" : "string" - }, { - "name" : "drop-request-id", - "in" : "path", - "description" : "The drop request id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/DropRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write Source Data - /data/{component-type}/{uuid}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "flowfile-queues" ], - "summary" : "Cancels and/or removes a request to drop the contents of this connection.", - "description" : "", - "operationId" : "removeDropRequest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The connection id.", - "required" : true, - "type" : "string" - }, { - "name" : "drop-request-id", - "in" : "path", - "description" : "The drop request id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/DropRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write Source Data - /data/{component-type}/{uuid}" : [ ] - } ] - } - }, - "/flowfile-queues/{id}/flowfiles/{flowfile-uuid}" : { - "get" : { - "tags" : [ "flowfile-queues" ], - "summary" : "Gets a FlowFile from a Connection.", - "description" : "", - "operationId" : "getFlowFile", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The connection id.", - "required" : true, - "type" : "string" - }, { - "name" : "flowfile-uuid", - "in" : "path", - "description" : "The flowfile uuid.", - "required" : true, - "type" : "string" - }, { - "name" : "clusterNodeId", - "in" : "query", - "description" : "The id of the node where the content exists if clustered.", - "required" : false, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/FlowFileEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read Source Data - /data/{component-type}/{uuid}" : [ ] - } ] - } - }, - "/flowfile-queues/{id}/flowfiles/{flowfile-uuid}/content" : { - "get" : { - "tags" : [ "flowfile-queues" ], - "summary" : "Gets the content for a FlowFile in a Connection.", - "description" : "", - "operationId" : "downloadFlowFileContent", - "consumes" : [ "*/*" ], - "produces" : [ "*/*" ], - "parameters" : [ { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The connection id.", - "required" : true, - "type" : "string" - }, { - "name" : "flowfile-uuid", - "in" : "path", - "description" : "The flowfile uuid.", - "required" : true, - "type" : "string" - }, { - "name" : "clusterNodeId", - "in" : "query", - "description" : "The id of the node where the content exists if clustered.", - "required" : false, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/StreamingOutput" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read Source Data - /data/{component-type}/{uuid}" : [ ] - } ] - } - }, - "/flowfile-queues/{id}/listing-requests" : { - "post" : { - "tags" : [ "flowfile-queues" ], - "summary" : "Lists the contents of the queue in this connection.", - "description" : "", - "operationId" : "createFlowFileListing", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The connection id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ListingRequestEntity" - } - }, - "202" : { - "description" : "The request has been accepted. A HTTP response header will contain the URI where the response can be polled." - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read Source Data - /data/{component-type}/{uuid}" : [ ] - } ] - } - }, - "/flowfile-queues/{id}/listing-requests/{listing-request-id}" : { - "get" : { - "tags" : [ "flowfile-queues" ], - "summary" : "Gets the current status of a listing request for the specified connection.", - "description" : "", - "operationId" : "getListingRequest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The connection id.", - "required" : true, - "type" : "string" - }, { - "name" : "listing-request-id", - "in" : "path", - "description" : "The listing request id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ListingRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read Source Data - /data/{component-type}/{uuid}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "flowfile-queues" ], - "summary" : "Cancels and/or removes a request to list the contents of this connection.", - "description" : "", - "operationId" : "deleteListingRequest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The connection id.", - "required" : true, - "type" : "string" - }, { - "name" : "listing-request-id", - "in" : "path", - "description" : "The listing request id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ListingRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read Source Data - /data/{component-type}/{uuid}" : [ ] - } ] - } - }, - "/funnels/{id}" : { - "get" : { - "tags" : [ "funnel" ], - "summary" : "Gets a funnel", - "description" : "", - "operationId" : "getFunnel", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The funnel id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/FunnelEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /funnels/{uuid}" : [ ] - } ] - }, - "put" : { - "tags" : [ "funnel" ], - "summary" : "Updates a funnel", - "description" : "", - "operationId" : "updateFunnel", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The funnel id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The funnel configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/FunnelEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/FunnelEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /funnels/{uuid}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "funnel" ], - "summary" : "Deletes a funnel", - "description" : "", - "operationId" : "removeFunnel", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The revision is used to verify the client is working with the latest version of the flow.", - "required" : false, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The funnel id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/FunnelEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /funnels/{uuid}" : [ ] - }, { - "Write - Parent Process Group - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/input-ports/{id}" : { - "get" : { - "tags" : [ "input-ports" ], - "summary" : "Gets an input port", - "description" : "", - "operationId" : "getInputPort", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The input port id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/PortEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /input-ports/{uuid}" : [ ] - } ] - }, - "put" : { - "tags" : [ "input-ports" ], - "summary" : "Updates an input port", - "description" : "", - "operationId" : "updateInputPort", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The input port id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The input port configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/PortEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/PortEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /input-ports/{uuid}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "input-ports" ], - "summary" : "Deletes an input port", - "description" : "", - "operationId" : "removeInputPort", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The revision is used to verify the client is working with the latest version of the flow.", - "required" : false, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The input port id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/PortEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /input-ports/{uuid}" : [ ] - }, { - "Write - Parent Process Group - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/input-ports/{id}/run-status" : { - "put" : { - "tags" : [ "input-ports" ], - "summary" : "Updates run status of an input-port", - "description" : "", - "operationId" : "updateRunStatus", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The port id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The port run status.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/PortRunStatusEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessorEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /input-ports/{uuid} or /operation/input-ports/{uuid}" : [ ] - } ] - } - }, - "/labels/{id}" : { - "get" : { - "tags" : [ "labels" ], - "summary" : "Gets a label", - "description" : "", - "operationId" : "getLabel", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The label id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/LabelEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /labels/{uuid}" : [ ] - } ] - }, - "put" : { - "tags" : [ "labels" ], - "summary" : "Updates a label", - "description" : "", - "operationId" : "updateLabel", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The label id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The label configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/LabelEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/LabelEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /labels/{uuid}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "labels" ], - "summary" : "Deletes a label", - "description" : "", - "operationId" : "removeLabel", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The revision is used to verify the client is working with the latest version of the flow.", - "required" : false, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The label id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/LabelEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /labels/{uuid}" : [ ] - }, { - "Write - Parent Process Group - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/output-ports/{id}" : { - "get" : { - "tags" : [ "output-ports" ], - "summary" : "Gets an output port", - "description" : "", - "operationId" : "getOutputPort", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The output port id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/PortEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /output-ports/{uuid}" : [ ] - } ] - }, - "put" : { - "tags" : [ "output-ports" ], - "summary" : "Updates an output port", - "description" : "", - "operationId" : "updateOutputPort", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The output port id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The output port configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/PortEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/PortEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /output-ports/{uuid}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "output-ports" ], - "summary" : "Deletes an output port", - "description" : "", - "operationId" : "removeOutputPort", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The revision is used to verify the client is working with the latest version of the flow.", - "required" : false, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The output port id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/PortEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /output-ports/{uuid}" : [ ] - }, { - "Write - Parent Process Group - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/output-ports/{id}/run-status" : { - "put" : { - "tags" : [ "output-ports" ], - "summary" : "Updates run status of an output-port", - "description" : "", - "operationId" : "updateRunStatus", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The port id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The port run status.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/PortRunStatusEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessorEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /output-ports/{uuid} or /operation/output-ports/{uuid}" : [ ] - } ] - } - }, - "/parameter-contexts" : { - "post" : { - "tags" : [ "parameter-contexts" ], - "summary" : "Create a Parameter Context", - "description" : "", - "operationId" : "createParameterContext", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The Parameter Context.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ParameterContextEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ParameterContextEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /parameter-contexts" : [ ] - } ] - } - }, - "/parameter-contexts/{contextId}/update-requests" : { - "post" : { - "tags" : [ "parameter-contexts" ], - "summary" : "Initiate the Update Request of a Parameter Context", - "description" : "This will initiate the process of updating a Parameter Context. Changing the value of a Parameter may require that one or more components be stopped and restarted, so this acttion may take significantly more time than many other REST API actions. As a result, this endpoint will immediately return a ParameterContextUpdateRequestEntity, and the process of updating the necessary components will occur asynchronously in the background. The client may then periodically poll the status of the request by issuing a GET request to /parameter-contexts/update-requests/{requestId}. Once the request is completed, the client is expected to issue a DELETE request to /parameter-contexts/update-requests/{requestId}.", - "operationId" : "submitParameterContextUpdate", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "contextId", - "in" : "path", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The updated version of the parameter context.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ParameterContextEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ParameterContextUpdateRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /parameter-contexts/{parameterContextId}" : [ ] - }, { - "Write - /parameter-contexts/{parameterContextId}" : [ ] - }, { - "Read - for every component that is affected by the update" : [ ] - }, { - "Write - for every component that is affected by the update" : [ ] - } ] - } - }, - "/parameter-contexts/{contextId}/update-requests/{requestId}" : { - "get" : { - "tags" : [ "parameter-contexts" ], - "summary" : "Returns the Update Request with the given ID", - "description" : "Returns the Update Request with the given ID. Once an Update Request has been created by performing a POST to /nifi-api/parameter-contexts, that request can subsequently be retrieved via this endpoint, and the request that is fetched will contain the updated state, such as percent complete, the current state of the request, and any failures. ", - "operationId" : "getParameterContextUpdate", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "contextId", - "in" : "path", - "description" : "The ID of the Parameter Context", - "required" : true, - "type" : "string" - }, { - "name" : "requestId", - "in" : "path", - "description" : "The ID of the Update Request", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ParameterContextUpdateRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Only the user that submitted the request can get it" : [ ] - } ] - }, - "delete" : { - "tags" : [ "parameter-contexts" ], - "summary" : "Deletes the Update Request with the given ID", - "description" : "Deletes the Update Request with the given ID. After a request is created via a POST to /nifi-api/parameter-contexts/update-requests, it is expected that the client will properly clean up the request by DELETE'ing it, once the Update process has completed. If the request is deleted before the request completes, then the Update request will finish the step that it is currently performing and then will cancel any subsequent steps.", - "operationId" : "deleteUpdateRequest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "contextId", - "in" : "path", - "description" : "The ID of the ParameterContext", - "required" : true, - "type" : "string" - }, { - "name" : "requestId", - "in" : "path", - "description" : "The ID of the Update Request", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ParameterContextUpdateRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Only the user that submitted the request can remove it" : [ ] - } ] - } - }, - "/parameter-contexts/{contextId}/validation-requests" : { - "post" : { - "tags" : [ "parameter-contexts" ], - "summary" : "Initiate a Validation Request to determine how the validity of components will change if a Parameter Context were to be updated", - "description" : "This will initiate the process of validating all components whose Process Group is bound to the specified Parameter Context. Performing validation against an arbitrary number of components may be expect and take significantly more time than many other REST API actions. As a result, this endpoint will immediately return a ParameterContextValidationRequestEntity, and the process of validating the necessary components will occur asynchronously in the background. The client may then periodically poll the status of the request by issuing a GET request to /parameter-contexts/validation-requests/{requestId}. Once the request is completed, the client is expected to issue a DELETE request to /parameter-contexts/validation-requests/{requestId}.", - "operationId" : "submitValidationRequest", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "contextId", - "in" : "path", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The validation request", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ParameterContextValidationRequestEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ParameterContextValidationRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /parameter-contexts/{parameterContextId}" : [ ] - } ] - } - }, - "/parameter-contexts/{contextId}/validation-requests/{id}" : { - "get" : { - "tags" : [ "parameter-contexts" ], - "summary" : "Returns the Validation Request with the given ID", - "description" : "Returns the Validation Request with the given ID. Once a Validation Request has been created by performing a POST to /nifi-api/validation-contexts, that request can subsequently be retrieved via this endpoint, and the request that is fetched will contain the updated state, such as percent complete, the current state of the request, and any failures. ", - "operationId" : "getValidationRequest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "contextId", - "in" : "path", - "description" : "The ID of the Parameter Context", - "required" : true, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The ID of the Validation Request", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ParameterContextValidationRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Only the user that submitted the request can get it" : [ ] - } ] - }, - "delete" : { - "tags" : [ "parameter-contexts" ], - "summary" : "Deletes the Validation Request with the given ID", - "description" : "Deletes the Validation Request with the given ID. After a request is created via a POST to /nifi-api/validation-contexts, it is expected that the client will properly clean up the request by DELETE'ing it, once the validation process has completed. If the request is deleted before the request completes, then the Validation request will finish the step that it is currently performing and then will cancel any subsequent steps.", - "operationId" : "deleteValidationRequest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "contextId", - "in" : "path", - "description" : "The ID of the Parameter Context", - "required" : true, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The ID of the Update Request", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ParameterContextValidationRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Only the user that submitted the request can remove it" : [ ] - } ] - } - }, - "/parameter-contexts/{id}" : { - "get" : { - "tags" : [ "parameter-contexts" ], - "summary" : "Returns the Parameter Context with the given ID", - "description" : "Returns the Parameter Context with the given ID.", - "operationId" : "getParameterContext", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The ID of the Parameter Context", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ParameterContextEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /parameter-contexts/{id}" : [ ] - } ] - }, - "put" : { - "tags" : [ "parameter-contexts" ], - "summary" : "Modifies a Parameter Context", - "description" : "This endpoint will update a Parameter Context to match the provided entity. However, this request will fail if any component is running and is referencing a Parameter in the Parameter Context. Generally, this endpoint is not called directly. Instead, an update request should be submitted by making a POST to the /parameter-contexts/update-requests endpoint. That endpoint will, in turn, call this endpoint.", - "operationId" : "updateParameterContext", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The updated Parameter Context", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ParameterContextEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ParameterContextEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /parameter-contexts/{id}" : [ ] - }, { - "Write - /parameter-contexts/{id}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "parameter-contexts" ], - "summary" : "Deletes the Parameter Context with the given ID", - "description" : "Deletes the Parameter Context with the given ID.", - "operationId" : "deleteParameterContext", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The version is used to verify the client is working with the latest version of the flow.", - "required" : false, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, a new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The Parameter Context ID.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ParameterContextEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /parameter-contexts/{uuid}" : [ ] - }, { - "Write - /parameter-contexts/{uuid}" : [ ] - }, { - "Read - /process-groups/{uuid}, for any Process Group that is currently bound to the Parameter Context" : [ ] - }, { - "Write - /process-groups/{uuid}, for any Process Group that is currently bound to the Parameter Context" : [ ] - } ] - } - }, - "/policies" : { - "post" : { - "tags" : [ "policies" ], - "summary" : "Creates an access policy", - "description" : "", - "operationId" : "createAccessPolicy", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The access policy configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/AccessPolicyEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/AccessPolicyEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /policies/{resource}" : [ ] - } ] - } - }, - "/policies/{action}/{resource}" : { - "get" : { - "tags" : [ "policies" ], - "summary" : "Gets an access policy for the specified action and resource", - "description" : "Will return the effective policy if no component specific policy exists for the specified action and resource. Must have Read permissions to the policy with the desired action and resource. Permissions for the policy that is returned will be indicated in the response. This means the client could be authorized to get the policy for a given component but the effective policy may be inherited from an ancestor Process Group. If the client does not have permissions to that policy, the response will not include the policy and the permissions in the response will be marked accordingly. If the client does not have permissions to the policy of the desired action and resource a 403 response will be returned.", - "operationId" : "getAccessPolicyForResource", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "action", - "in" : "path", - "description" : "The request action.", - "required" : true, - "type" : "string", - "enum" : [ "read", "write" ] - }, { - "name" : "resource", - "in" : "path", - "description" : "The resource of the policy.", - "required" : true, - "type" : "string", - "pattern" : ".+" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/AccessPolicyEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /policies/{resource}" : [ ] - } ] - } - }, - "/policies/{id}" : { - "get" : { - "tags" : [ "policies" ], - "summary" : "Gets an access policy", - "description" : "", - "operationId" : "getAccessPolicy", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The access policy id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/AccessPolicyEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /policies/{resource}" : [ ] - } ] - }, - "put" : { - "tags" : [ "policies" ], - "summary" : "Updates a access policy", - "description" : "", - "operationId" : "updateAccessPolicy", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The access policy id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The access policy configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/AccessPolicyEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/AccessPolicyEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /policies/{resource}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "policies" ], - "summary" : "Deletes an access policy", - "description" : "", - "operationId" : "removeAccessPolicy", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The revision is used to verify the client is working with the latest version of the flow.", - "required" : false, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The access policy id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/AccessPolicyEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /policies/{resource}" : [ ] - }, { - "Write - Policy of the parent resource - /policies/{resource}" : [ ] - } ] - } - }, - "/process-groups/replace-requests/{id}" : { - "get" : { - "tags" : [ "process-groups" ], - "summary" : "Returns the Replace Request with the given ID", - "description" : "Returns the Replace Request with the given ID. Once a Replace Request has been created by performing a POST to /process-groups/{id}/replace-requests, that request can subsequently be retrieved via this endpoint, and the request that is fetched will contain the updated state, such as percent complete, the current state of the request, and any failures. Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getReplaceProcessGroupRequest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The ID of the Replace Request", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessGroupReplaceRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Only the user that submitted the request can get it" : [ ] - } ] - }, - "delete" : { - "tags" : [ "process-groups" ], - "summary" : "Deletes the Replace Request with the given ID", - "description" : "Deletes the Replace Request with the given ID. After a request is created via a POST to /process-groups/{id}/replace-requests, it is expected that the client will properly clean up the request by DELETE'ing it, once the Replace process has completed. If the request is deleted before the request completes, then the Replace request will finish the step that it is currently performing and then will cancel any subsequent steps. Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "deleteReplaceProcessGroupRequest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The ID of the Update Request", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessGroupReplaceRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Only the user that submitted the request can remove it" : [ ] - } ] - } - }, - "/process-groups/{groupId}/variable-registry/update-requests/{updateId}" : { - "get" : { - "tags" : [ "process-groups" ], - "summary" : "Gets a process group's variable registry", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getVariableRegistryUpdateRequest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "groupId", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "name" : "updateId", - "in" : "path", - "description" : "The ID of the Variable Registry Update Request", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VariableRegistryUpdateRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "process-groups" ], - "summary" : "Deletes an update request for a process group's variable registry. If the request is not yet complete, it will automatically be cancelled.", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "deleteVariableRegistryUpdateRequest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "groupId", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "name" : "updateId", - "in" : "path", - "description" : "The ID of the Variable Registry Update Request", - "required" : true, - "type" : "string" - }, { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VariableRegistryUpdateRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/process-groups/{id}" : { - "get" : { - "tags" : [ "process-groups" ], - "summary" : "Gets a process group", - "description" : "", - "operationId" : "getProcessGroup", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessGroupEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - } ] - }, - "put" : { - "tags" : [ "process-groups" ], - "summary" : "Updates a process group", - "description" : "", - "operationId" : "updateProcessGroup", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The process group configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ProcessGroupEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessGroupEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "process-groups" ], - "summary" : "Deletes a process group", - "description" : "", - "operationId" : "removeProcessGroup", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The revision is used to verify the client is working with the latest version of the flow.", - "required" : false, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessGroupEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - }, { - "Write - Parent Process Group - /process-groups/{uuid}" : [ ] - }, { - "Read - any referenced Controller Services by any encapsulated components - /controller-services/{uuid}" : [ ] - }, { - "Write - /{component-type}/{uuid} - For all encapsulated components" : [ ] - } ] - } - }, - "/process-groups/{id}/connections" : { - "get" : { - "tags" : [ "process-groups" ], - "summary" : "Gets all connections", - "description" : "", - "operationId" : "getConnections", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ConnectionsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - } ] - }, - "post" : { - "tags" : [ "process-groups" ], - "summary" : "Creates a connection", - "description" : "", - "operationId" : "createConnection", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The connection configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ConnectionEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ConnectionEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - }, { - "Write Source - /{component-type}/{uuid}" : [ ] - }, { - "Write Destination - /{component-type}/{uuid}" : [ ] - } ] - } - }, - "/process-groups/{id}/controller-services" : { - "post" : { - "tags" : [ "process-groups" ], - "summary" : "Creates a new controller service", - "description" : "", - "operationId" : "createControllerService", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The controller service configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ControllerServiceEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ControllerServiceEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - }, { - "Read - any referenced Controller Services - /controller-services/{uuid}" : [ ] - }, { - "Write - if the Controller Service is restricted - /restricted-components" : [ ] - } ] - } - }, - "/process-groups/{id}/download" : { - "get" : { - "tags" : [ "process-groups" ], - "summary" : "Gets a process group for download", - "description" : "", - "operationId" : "exportProcessGroup", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/process-groups/{id}/empty-all-connections-requests" : { - "post" : { - "tags" : [ "process-groups" ], - "summary" : "Creates a request to drop all flowfiles of all connection queues in this process group.", - "description" : "", - "operationId" : "createEmptyAllConnectionsRequest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessGroupEntity" - } - }, - "202" : { - "description" : "The request has been accepted. An HTTP response header will contain the URI where the status can be polled." - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid} - For this and all encapsulated process groups" : [ ] - }, { - "Write Source Data - /data/{component-type}/{uuid} - For all encapsulated connections" : [ ] - } ] - } - }, - "/process-groups/{id}/empty-all-connections-requests/{drop-request-id}" : { - "get" : { - "tags" : [ "process-groups" ], - "summary" : "Gets the current status of a drop all flowfiles request.", - "description" : "", - "operationId" : "getDropAllFlowfilesRequest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "name" : "drop-request-id", - "in" : "path", - "description" : "The drop request id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/DropRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid} - For this and all encapsulated process groups" : [ ] - }, { - "Write Source Data - /data/{component-type}/{uuid} - For all encapsulated connections" : [ ] - } ] - }, - "delete" : { - "tags" : [ "process-groups" ], - "summary" : "Cancels and/or removes a request to drop all flowfiles.", - "description" : "", - "operationId" : "removeDropRequest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "name" : "drop-request-id", - "in" : "path", - "description" : "The drop request id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/DropRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid} - For this and all encapsulated process groups" : [ ] - }, { - "Write Source Data - /data/{component-type}/{uuid} - For all encapsulated connections" : [ ] - } ] - } - }, - "/process-groups/{id}/flow-contents" : { - "put" : { - "tags" : [ "process-groups" ], - "summary" : "Replace Process Group contents with the given ID with the specified Process Group contents", - "description" : "This endpoint is used for replication within a cluster, when replacing a flow with a new flow. It expects that the flow beingreplaced is not under version control and that the given snapshot will not modify any Processor that is currently running or any Controller Service that is enabled. Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "replaceProcessGroup", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The process group replace request entity.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ProcessGroupImportEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessGroupImportEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - }, { - "Write - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/process-groups/{id}/funnels" : { - "get" : { - "tags" : [ "process-groups" ], - "summary" : "Gets all funnels", - "description" : "", - "operationId" : "getFunnels", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/FunnelsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - } ] - }, - "post" : { - "tags" : [ "process-groups" ], - "summary" : "Creates a funnel", - "description" : "", - "operationId" : "createFunnel", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The funnel configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/FunnelEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/FunnelEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/process-groups/{id}/input-ports" : { - "get" : { - "tags" : [ "process-groups" ], - "summary" : "Gets all input ports", - "description" : "", - "operationId" : "getInputPorts", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/InputPortsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - } ] - }, - "post" : { - "tags" : [ "process-groups" ], - "summary" : "Creates an input port", - "description" : "", - "operationId" : "createInputPort", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The input port configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/PortEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/PortEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/process-groups/{id}/labels" : { - "get" : { - "tags" : [ "process-groups" ], - "summary" : "Gets all labels", - "description" : "", - "operationId" : "getLabels", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/LabelsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - } ] - }, - "post" : { - "tags" : [ "process-groups" ], - "summary" : "Creates a label", - "description" : "", - "operationId" : "createLabel", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The label configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/LabelEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/LabelEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/process-groups/{id}/local-modifications" : { - "get" : { - "tags" : [ "process-groups" ], - "summary" : "Gets a list of local modifications to the Process Group since it was last synchronized with the Flow Registry", - "description" : "", - "operationId" : "getLocalModifications", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/FlowComparisonEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - }, { - "Read - /{component-type}/{uuid} - For all encapsulated components" : [ ] - } ] - } - }, - "/process-groups/{id}/output-ports" : { - "get" : { - "tags" : [ "process-groups" ], - "summary" : "Gets all output ports", - "description" : "", - "operationId" : "getOutputPorts", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/OutputPortsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - } ] - }, - "post" : { - "tags" : [ "process-groups" ], - "summary" : "Creates an output port", - "description" : "", - "operationId" : "createOutputPort", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The output port configuration.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/PortEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/PortEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/process-groups/{id}/process-groups" : { - "get" : { - "tags" : [ "process-groups" ], - "summary" : "Gets all process groups", - "description" : "", - "operationId" : "getProcessGroups", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessGroupsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - } ] - }, - "post" : { - "tags" : [ "process-groups" ], - "summary" : "Creates a process group", - "description" : "", - "operationId" : "createProcessGroup", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The process group configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ProcessGroupEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessGroupEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/process-groups/{id}/processors" : { - "get" : { - "tags" : [ "process-groups" ], - "summary" : "Gets all processors", - "description" : "", - "operationId" : "getProcessors", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "name" : "includeDescendantGroups", - "in" : "query", - "description" : "Whether or not to include processors from descendant process groups", - "required" : false, - "type" : "boolean", - "default" : false - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessorsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - } ] - }, - "post" : { - "tags" : [ "process-groups" ], - "summary" : "Creates a new processor", - "description" : "", - "operationId" : "createProcessor", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The processor configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ProcessorEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessorEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - }, { - "Read - any referenced Controller Services - /controller-services/{uuid}" : [ ] - }, { - "Write - if the Processor is restricted - /restricted-components" : [ ] - } ] - } - }, - "/process-groups/{id}/remote-process-groups" : { - "get" : { - "tags" : [ "process-groups" ], - "summary" : "Gets all remote process groups", - "description" : "", - "operationId" : "getRemoteProcessGroups", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/RemoteProcessGroupsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - } ] - }, - "post" : { - "tags" : [ "process-groups" ], - "summary" : "Creates a new process group", - "description" : "", - "operationId" : "createRemoteProcessGroup", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The remote process group configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/RemoteProcessGroupEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/RemoteProcessGroupEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/process-groups/{id}/replace-requests" : { - "post" : { - "tags" : [ "process-groups" ], - "summary" : "Initiate the Replace Request of a Process Group with the given ID", - "description" : "This will initiate the action of replacing a process group with the given process group. This can be a lengthy process, as it will stop any Processors and disable any Controller Services necessary to perform the action and then restart them. As a result, the endpoint will immediately return a ProcessGroupReplaceRequestEntity, and the process of replacing the flow will occur asynchronously in the background. The client may then periodically poll the status of the request by issuing a GET request to /process-groups/replace-requests/{requestId}. Once the request is completed, the client is expected to issue a DELETE request to /process-groups/replace-requests/{requestId}. Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "initiateReplaceProcessGroup", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The process group replace request entity", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ProcessGroupImportEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessGroupReplaceRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - }, { - "Write - /process-groups/{uuid}" : [ ] - }, { - "Read - /{component-type}/{uuid} - For all encapsulated components" : [ ] - }, { - "Write - /{component-type}/{uuid} - For all encapsulated components" : [ ] - }, { - "Write - if the template contains any restricted components - /restricted-components" : [ ] - }, { - "Read - /parameter-contexts/{uuid} - For any Parameter Context that is referenced by a Property that is changed, added, or removed" : [ ] - } ] - } - }, - "/process-groups/{id}/snippet-instance" : { - "post" : { - "tags" : [ "process-groups" ], - "summary" : "Copies a snippet and discards it.", - "description" : "", - "operationId" : "copySnippet", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The copy snippet request.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/CopySnippetRequestEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/FlowEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - }, { - "Read - /{component-type}/{uuid} - For each component in the snippet and their descendant components" : [ ] - }, { - "Write - if the snippet contains any restricted Processors - /restricted-components" : [ ] - } ] - } - }, - "/process-groups/{id}/template-instance" : { - "post" : { - "tags" : [ "process-groups" ], - "summary" : "Instantiates a template", - "description" : "", - "operationId" : "instantiateTemplate", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The instantiate template request.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/InstantiateTemplateRequestEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/FlowEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - }, { - "Read - /templates/{uuid}" : [ ] - }, { - "Write - if the template contains any restricted components - /restricted-components" : [ ] - } ] - } - }, - "/process-groups/{id}/templates" : { - "post" : { - "tags" : [ "process-groups" ], - "summary" : "Creates a template and discards the specified snippet.", - "description" : "", - "operationId" : "createTemplate", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The create template request.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/CreateTemplateRequestEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/TemplateEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - }, { - "Read - /{component-type}/{uuid} - For each component in the snippet and their descendant components" : [ ] - } ] - } - }, - "/process-groups/{id}/templates/import" : { - "post" : { - "tags" : [ "process-groups" ], - "summary" : "Imports a template", - "description" : "", - "operationId" : "importTemplate", - "consumes" : [ "application/xml" ], - "produces" : [ "application/xml" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/TemplateEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/process-groups/{id}/templates/upload" : { - "post" : { - "tags" : [ "process-groups" ], - "summary" : "Uploads a template", - "description" : "", - "operationId" : "uploadTemplate", - "consumes" : [ "multipart/form-data" ], - "produces" : [ "application/xml" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "schema" : { - "type" : "boolean" - } - }, { - "name" : "template", - "in" : "formData", - "description" : "The binary content of the template file being uploaded.", - "required" : true, - "type" : "file" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/TemplateEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/process-groups/{id}/variable-registry" : { - "get" : { - "tags" : [ "process-groups" ], - "summary" : "Gets a process group's variable registry", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getVariableRegistry", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "name" : "includeAncestorGroups", - "in" : "query", - "description" : "Whether or not to include ancestor groups", - "required" : false, - "type" : "boolean", - "default" : true - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VariableRegistryEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - } ] - }, - "put" : { - "tags" : [ "process-groups" ], - "summary" : "Updates the contents of a Process Group's variable Registry", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "updateVariableRegistry", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The variable registry configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/VariableRegistryEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VariableRegistryEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/process-groups/{id}/variable-registry/update-requests" : { - "post" : { - "tags" : [ "process-groups" ], - "summary" : "Submits a request to update a process group's variable registry", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "submitUpdateVariableRegistryRequest", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The variable registry configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/VariableRegistryEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VariableRegistryUpdateRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/processors/run-status-details/queries" : { - "post" : { - "tags" : [ "processors" ], - "summary" : "Submits a query to retrieve the run status details of all processors that are in the given list of Processor IDs", - "description" : "", - "operationId" : "getProcessorRunStatusDetails", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The request for the processors that should be included in the results", - "required" : false, - "schema" : { - "$ref" : "#/definitions/RunStatusDetailsRequestEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessorsRunStatusDetailsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /processors/{uuid} for each processor whose run status information is requested" : [ ] - } ] - } - }, - "/processors/{id}" : { - "get" : { - "tags" : [ "processors" ], - "summary" : "Gets a processor", - "description" : "", - "operationId" : "getProcessor", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The processor id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessorEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /processors/{uuid}" : [ ] - } ] - }, - "put" : { - "tags" : [ "processors" ], - "summary" : "Updates a processor", - "description" : "", - "operationId" : "updateProcessor", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The processor id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The processor configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ProcessorEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessorEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /processors/{uuid}" : [ ] - }, { - "Read - any referenced Controller Services if this request changes the reference - /controller-services/{uuid}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "processors" ], - "summary" : "Deletes a processor", - "description" : "", - "operationId" : "deleteProcessor", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The revision is used to verify the client is working with the latest version of the flow.", - "required" : false, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The processor id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessorEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /processors/{uuid}" : [ ] - }, { - "Write - Parent Process Group - /process-groups/{uuid}" : [ ] - }, { - "Read - any referenced Controller Services - /controller-services/{uuid}" : [ ] - } ] - } - }, - "/processors/{id}/descriptors" : { - "get" : { - "tags" : [ "processors" ], - "summary" : "Gets the descriptor for a processor property", - "description" : "", - "operationId" : "getPropertyDescriptor", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The processor id.", - "required" : true, - "type" : "string" - }, { - "name" : "propertyName", - "in" : "query", - "description" : "The property name.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/PropertyDescriptorEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /processors/{uuid}" : [ ] - } ] - } - }, - "/processors/{id}/diagnostics" : { - "get" : { - "tags" : [ "processors" ], - "summary" : "Gets diagnostics information about a processor", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getProcessorDiagnostics", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The processor id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessorEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /processors/{uuid}" : [ ] - } ] - } - }, - "/processors/{id}/run-status" : { - "put" : { - "tags" : [ "processors" ], - "summary" : "Updates run status of a processor", - "description" : "", - "operationId" : "updateRunStatus", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The processor id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The processor run status.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ProcessorRunStatusEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessorEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /processors/{uuid} or /operation/processors/{uuid}" : [ ] - } ] - } - }, - "/processors/{id}/state" : { - "get" : { - "tags" : [ "processors" ], - "summary" : "Gets the state for a processor", - "description" : "", - "operationId" : "getState", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The processor id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ComponentStateEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /processors/{uuid}" : [ ] - } ] - } - }, - "/processors/{id}/state/clear-requests" : { - "post" : { - "tags" : [ "processors" ], - "summary" : "Clears the state for a processor", - "description" : "", - "operationId" : "clearState", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The processor id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ComponentStateEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /processors/{uuid}" : [ ] - } ] - } - }, - "/processors/{id}/threads" : { - "delete" : { - "tags" : [ "processors" ], - "summary" : "Terminates a processor, essentially \"deleting\" its threads and any active tasks", - "description" : "", - "operationId" : "terminateProcessor", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The processor id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessorEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /processors/{uuid} or /operation/processors/{uuid}" : [ ] - } ] - } - }, - "/provenance" : { - "post" : { - "tags" : [ "provenance" ], - "summary" : "Submits a provenance query", - "description" : "Provenance queries may be long running so this endpoint submits a request. The response will include the current state of the query. If the request is not completed the URI in the response can be used at a later time to get the updated state of the query. Once the query has completed the provenance request should be deleted by the client who originally submitted it.", - "operationId" : "submitProvenanceRequest", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The provenance query details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ProvenanceEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProvenanceEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /provenance" : [ ] - }, { - "Read - /data/{component-type}/{uuid}" : [ ] - } ] - } - }, - "/provenance-events/replays" : { - "post" : { - "tags" : [ "provenance-events" ], - "summary" : "Replays content from a provenance event", - "description" : "", - "operationId" : "submitReplay", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The replay request.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/SubmitReplayRequestEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProvenanceEventEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read Component Provenance Data - /provenance-data/{component-type}/{uuid}" : [ ] - }, { - "Read Component Data - /data/{component-type}/{uuid}" : [ ] - }, { - "Write Component Data - /data/{component-type}/{uuid}" : [ ] - } ] - } - }, - "/provenance-events/{id}" : { - "get" : { - "tags" : [ "provenance-events" ], - "summary" : "Gets a provenance event", - "description" : "", - "operationId" : "getProvenanceEvent", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "clusterNodeId", - "in" : "query", - "description" : "The id of the node where this event exists if clustered.", - "required" : false, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The provenance event id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProvenanceEventEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read Component Provenance Data - /provenance-data/{component-type}/{uuid}" : [ ] - } ] - } - }, - "/provenance-events/{id}/content/input" : { - "get" : { - "tags" : [ "provenance-events" ], - "summary" : "Gets the input content for a provenance event", - "description" : "", - "operationId" : "getInputContent", - "consumes" : [ "*/*" ], - "produces" : [ "*/*" ], - "parameters" : [ { - "name" : "clusterNodeId", - "in" : "query", - "description" : "The id of the node where the content exists if clustered.", - "required" : false, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The provenance event id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/StreamingOutput" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read Component Provenance Data - /provenance-data/{component-type}/{uuid}" : [ ] - }, { - "Read Component Data - /data/{component-type}/{uuid}" : [ ] - } ] - } - }, - "/provenance-events/{id}/content/output" : { - "get" : { - "tags" : [ "provenance-events" ], - "summary" : "Gets the output content for a provenance event", - "description" : "", - "operationId" : "getOutputContent", - "consumes" : [ "*/*" ], - "produces" : [ "*/*" ], - "parameters" : [ { - "name" : "clusterNodeId", - "in" : "query", - "description" : "The id of the node where the content exists if clustered.", - "required" : false, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The provenance event id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/StreamingOutput" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read Component Provenance Data - /provenance-data/{component-type}/{uuid}" : [ ] - }, { - "Read Component Data - /data/{component-type}/{uuid}" : [ ] - } ] - } - }, - "/provenance/lineage" : { - "post" : { - "tags" : [ "provenance" ], - "summary" : "Submits a lineage query", - "description" : "Lineage queries may be long running so this endpoint submits a request. The response will include the current state of the query. If the request is not completed the URI in the response can be used at a later time to get the updated state of the query. Once the query has completed the lineage request should be deleted by the client who originally submitted it.", - "operationId" : "submitLineageRequest", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The lineage query details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/LineageEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/LineageEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /provenance" : [ ] - }, { - "Read - /data/{component-type}/{uuid}" : [ ] - } ] - } - }, - "/provenance/lineage/{id}" : { - "get" : { - "tags" : [ "provenance" ], - "summary" : "Gets a lineage query", - "description" : "", - "operationId" : "getLineage", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "clusterNodeId", - "in" : "query", - "description" : "The id of the node where this query exists if clustered.", - "required" : false, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The id of the lineage query.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/LineageEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /provenance" : [ ] - }, { - "Read - /data/{component-type}/{uuid}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "provenance" ], - "summary" : "Deletes a lineage query", - "description" : "", - "operationId" : "deleteLineage", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "clusterNodeId", - "in" : "query", - "description" : "The id of the node where this query exists if clustered.", - "required" : false, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The id of the lineage query.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/LineageEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /provenance" : [ ] - } ] - } - }, - "/provenance/search-options" : { - "get" : { - "tags" : [ "provenance" ], - "summary" : "Gets the searchable attributes for provenance events", - "description" : "", - "operationId" : "getSearchOptions", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProvenanceOptionsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /provenance" : [ ] - } ] - } - }, - "/provenance/{id}" : { - "get" : { - "tags" : [ "provenance" ], - "summary" : "Gets a provenance query", - "description" : "", - "operationId" : "getProvenance", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "clusterNodeId", - "in" : "query", - "description" : "The id of the node where this query exists if clustered.", - "required" : false, - "type" : "string" - }, { - "name" : "summarize", - "in" : "query", - "description" : "Whether or not incremental results are returned. If false, provenance events are only returned once the query completes. This property is true by default.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "incrementalResults", - "in" : "query", - "description" : "Whether or not to summarize provenance events returned. This property is false by default.", - "required" : false, - "type" : "boolean", - "default" : true - }, { - "name" : "id", - "in" : "path", - "description" : "The id of the provenance query.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProvenanceEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /provenance" : [ ] - }, { - "Read - /data/{component-type}/{uuid}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "provenance" ], - "summary" : "Deletes a provenance query", - "description" : "", - "operationId" : "deleteProvenance", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "clusterNodeId", - "in" : "query", - "description" : "The id of the node where this query exists if clustered.", - "required" : false, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The id of the provenance query.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProvenanceEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /provenance" : [ ] - } ] - } - }, - "/remote-process-groups/{id}" : { - "get" : { - "tags" : [ "remote-process-groups" ], - "summary" : "Gets a remote process group", - "description" : "", - "operationId" : "getRemoteProcessGroup", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The remote process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/RemoteProcessGroupEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /remote-process-groups/{uuid}" : [ ] - } ] - }, - "put" : { - "tags" : [ "remote-process-groups" ], - "summary" : "Updates a remote process group", - "description" : "", - "operationId" : "updateRemoteProcessGroup", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The remote process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The remote process group.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/RemoteProcessGroupEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/RemoteProcessGroupEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /remote-process-groups/{uuid}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "remote-process-groups" ], - "summary" : "Deletes a remote process group", - "description" : "", - "operationId" : "removeRemoteProcessGroup", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The revision is used to verify the client is working with the latest version of the flow.", - "required" : false, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The remote process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/RemoteProcessGroupEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /remote-process-groups/{uuid}" : [ ] - }, { - "Write - Parent Process Group - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/remote-process-groups/{id}/input-ports/{port-id}" : { - "put" : { - "tags" : [ "remote-process-groups" ], - "summary" : "Updates a remote port", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "updateRemoteProcessGroupInputPort", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The remote process group id.", - "required" : true, - "type" : "string" - }, { - "name" : "port-id", - "in" : "path", - "description" : "The remote process group port id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The remote process group port.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/RemoteProcessGroupPortEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/RemoteProcessGroupPortEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /remote-process-groups/{uuid}" : [ ] - } ] - } - }, - "/remote-process-groups/{id}/input-ports/{port-id}/run-status" : { - "put" : { - "tags" : [ "remote-process-groups" ], - "summary" : "Updates run status of a remote port", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "updateRemoteProcessGroupInputPortRunStatus", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The remote process group id.", - "required" : true, - "type" : "string" - }, { - "name" : "port-id", - "in" : "path", - "description" : "The remote process group port id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The remote process group port.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/RemotePortRunStatusEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/RemoteProcessGroupPortEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /remote-process-groups/{uuid} or /operation/remote-process-groups/{uuid}" : [ ] - } ] - } - }, - "/remote-process-groups/{id}/output-ports/{port-id}" : { - "put" : { - "tags" : [ "remote-process-groups" ], - "summary" : "Updates a remote port", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "updateRemoteProcessGroupOutputPort", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The remote process group id.", - "required" : true, - "type" : "string" - }, { - "name" : "port-id", - "in" : "path", - "description" : "The remote process group port id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The remote process group port.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/RemoteProcessGroupPortEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/RemoteProcessGroupPortEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /remote-process-groups/{uuid}" : [ ] - } ] - } - }, - "/remote-process-groups/{id}/output-ports/{port-id}/run-status" : { - "put" : { - "tags" : [ "remote-process-groups" ], - "summary" : "Updates run status of a remote port", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "updateRemoteProcessGroupOutputPortRunStatus", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The remote process group id.", - "required" : true, - "type" : "string" - }, { - "name" : "port-id", - "in" : "path", - "description" : "The remote process group port id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The remote process group port.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/RemotePortRunStatusEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/RemoteProcessGroupPortEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /remote-process-groups/{uuid} or /operation/remote-process-groups/{uuid}" : [ ] - } ] - } - }, - "/remote-process-groups/{id}/run-status" : { - "put" : { - "tags" : [ "remote-process-groups" ], - "summary" : "Updates run status of a remote process group", - "description" : "", - "operationId" : "updateRemoteProcessGroupRunStatus", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The remote process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The remote process group run status.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/RemotePortRunStatusEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/RemoteProcessGroupEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /remote-process-groups/{uuid} or /operation/remote-process-groups/{uuid}" : [ ] - } ] - } - }, - "/remote-process-groups/{id}/state" : { - "get" : { - "tags" : [ "remote-process-groups" ], - "summary" : "Gets the state for a RemoteProcessGroup", - "description" : "", - "operationId" : "getState", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The processor id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ComponentStateEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /remote-process-groups/{uuid}" : [ ] - } ] - } - }, - "/reporting-tasks/{id}" : { - "get" : { - "tags" : [ "reporting-tasks" ], - "summary" : "Gets a reporting task", - "description" : "", - "operationId" : "getReportingTask", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The reporting task id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ReportingTaskEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /reporting-tasks/{uuid}" : [ ] - } ] - }, - "put" : { - "tags" : [ "reporting-tasks" ], - "summary" : "Updates a reporting task", - "description" : "", - "operationId" : "updateReportingTask", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The reporting task id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The reporting task configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ReportingTaskEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ReportingTaskEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /reporting-tasks/{uuid}" : [ ] - }, { - "Read - any referenced Controller Services if this request changes the reference - /controller-services/{uuid}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "reporting-tasks" ], - "summary" : "Deletes a reporting task", - "description" : "", - "operationId" : "removeReportingTask", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The revision is used to verify the client is working with the latest version of the flow.", - "required" : false, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The reporting task id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ReportingTaskEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /reporting-tasks/{uuid}" : [ ] - }, { - "Write - /controller" : [ ] - }, { - "Read - any referenced Controller Services - /controller-services/{uuid}" : [ ] - } ] - } - }, - "/reporting-tasks/{id}/descriptors" : { - "get" : { - "tags" : [ "reporting-tasks" ], - "summary" : "Gets a reporting task property descriptor", - "description" : "", - "operationId" : "getPropertyDescriptor", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The reporting task id.", - "required" : true, - "type" : "string" - }, { - "name" : "propertyName", - "in" : "query", - "description" : "The property name.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/PropertyDescriptorEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /reporting-tasks/{uuid}" : [ ] - } ] - } - }, - "/reporting-tasks/{id}/run-status" : { - "put" : { - "tags" : [ "reporting-tasks" ], - "summary" : "Updates run status of a reporting task", - "description" : "", - "operationId" : "updateRunStatus", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The reporting task id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The reporting task run status.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ReportingTaskRunStatusEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ReportingTaskEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /reporting-tasks/{uuid} or or /operation/reporting-tasks/{uuid}" : [ ] - } ] - } - }, - "/reporting-tasks/{id}/state" : { - "get" : { - "tags" : [ "reporting-tasks" ], - "summary" : "Gets the state for a reporting task", - "description" : "", - "operationId" : "getState", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The reporting task id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ComponentStateEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /reporting-tasks/{uuid}" : [ ] - } ] - } - }, - "/reporting-tasks/{id}/state/clear-requests" : { - "post" : { - "tags" : [ "reporting-tasks" ], - "summary" : "Clears the state for a reporting task", - "description" : "", - "operationId" : "clearState", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The reporting task id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ComponentStateEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /reporting-tasks/{uuid}" : [ ] - } ] - } - }, - "/resources" : { - "get" : { - "tags" : [ "resources" ], - "summary" : "Gets the available resources that support access/authorization policies", - "description" : "", - "operationId" : "getResources", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ResourcesEntity" - } - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - } - }, - "security" : [ { - "Read - /resources" : [ ] - } ] - } - }, - "/site-to-site" : { - "get" : { - "tags" : [ "site-to-site" ], - "summary" : "Returns the details about this NiFi necessary to communicate via site to site", - "description" : "", - "operationId" : "getSiteToSiteDetails", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ControllerEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /site-to-site" : [ ] - } ] - } - }, - "/site-to-site/peers" : { - "get" : { - "tags" : [ "site-to-site" ], - "summary" : "Returns the available Peers and its status of this NiFi", - "description" : "", - "operationId" : "getPeers", - "consumes" : [ "*/*" ], - "produces" : [ "application/json", "application/xml" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/PeersEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /site-to-site" : [ ] - } ] - } - }, - "/snippets" : { - "post" : { - "tags" : [ "snippets" ], - "summary" : "Creates a snippet. The snippet will be automatically discarded if not used in a subsequent request after 1 minute.", - "description" : "", - "operationId" : "createSnippet", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The snippet configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/SnippetEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/SnippetEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read or Write - /{component-type}/{uuid} - For every component (all Read or all Write) in the Snippet and their descendant components" : [ ] - } ] - } - }, - "/snippets/{id}" : { - "put" : { - "tags" : [ "snippets" ], - "summary" : "Move's the components in this Snippet into a new Process Group and discards the snippet", - "description" : "", - "operationId" : "updateSnippet", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The snippet id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The snippet configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/SnippetEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/SnippetEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write Process Group - /process-groups/{uuid}" : [ ] - }, { - "Write - /{component-type}/{uuid} - For each component in the Snippet and their descendant components" : [ ] - } ] - }, - "delete" : { - "tags" : [ "snippets" ], - "summary" : "Deletes the components in a snippet and discards the snippet", - "description" : "", - "operationId" : "deleteSnippet", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The snippet id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/SnippetEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /{component-type}/{uuid} - For each component in the Snippet and their descendant components" : [ ] - }, { - "Write - Parent Process Group - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/system-diagnostics" : { - "get" : { - "tags" : [ "system-diagnostics" ], - "summary" : "Gets the diagnostics for the system NiFi is running on", - "description" : "", - "operationId" : "getSystemDiagnostics", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "nodewise", - "in" : "query", - "description" : "Whether or not to include the breakdown per node. Optional, defaults to false", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "clusterNodeId", - "in" : "query", - "description" : "The id of the node where to get the status.", - "required" : false, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/SystemDiagnosticsEntity" - } - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - } - }, - "security" : [ { - "Read - /system" : [ ] - } ] - } - }, - "/templates/{id}" : { - "delete" : { - "tags" : [ "templates" ], - "summary" : "Deletes a template", - "description" : "", - "operationId" : "removeTemplate", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The template id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/TemplateEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /templates/{uuid}" : [ ] - }, { - "Write - Parent Process Group - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/templates/{id}/download" : { - "get" : { - "tags" : [ "templates" ], - "summary" : "Exports a template", - "description" : "", - "operationId" : "exportTemplate", - "consumes" : [ "*/*" ], - "produces" : [ "application/xml" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The template id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /templates/{uuid}" : [ ] - } ] - } - }, - "/tenants/search-results" : { - "get" : { - "tags" : [ "tenants" ], - "summary" : "Searches for a tenant with the specified identity", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "searchTenants", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "q", - "in" : "query", - "description" : "Identity to search for.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/TenantsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /tenants" : [ ] - } ] - } - }, - "/tenants/user-groups" : { - "get" : { - "tags" : [ "tenants" ], - "summary" : "Gets all user groups", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getUserGroups", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/UserGroupsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /tenants" : [ ] - } ] - }, - "post" : { - "tags" : [ "tenants" ], - "summary" : "Creates a user group", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "createUserGroup", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The user group configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/UserGroupEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/UserGroupEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /tenants" : [ ] - } ] - } - }, - "/tenants/user-groups/{id}" : { - "get" : { - "tags" : [ "tenants" ], - "summary" : "Gets a user group", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getUserGroup", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The user group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/UserGroupEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /tenants" : [ ] - } ] - }, - "put" : { - "tags" : [ "tenants" ], - "summary" : "Updates a user group", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "updateUserGroup", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The user group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The user group configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/UserGroupEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/UserGroupEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /tenants" : [ ] - } ] - }, - "delete" : { - "tags" : [ "tenants" ], - "summary" : "Deletes a user group", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "removeUserGroup", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The revision is used to verify the client is working with the latest version of the flow.", - "required" : false, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The user group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/UserGroupEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /tenants" : [ ] - } ] - } - }, - "/tenants/users" : { - "get" : { - "tags" : [ "tenants" ], - "summary" : "Gets all users", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getUsers", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/UsersEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /tenants" : [ ] - } ] - }, - "post" : { - "tags" : [ "tenants" ], - "summary" : "Creates a user", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "createUser", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The user configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/UserEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/UserEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /tenants" : [ ] - } ] - } - }, - "/tenants/users/{id}" : { - "get" : { - "tags" : [ "tenants" ], - "summary" : "Gets a user", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getUser", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The user id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/UserEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /tenants" : [ ] - } ] - }, - "put" : { - "tags" : [ "tenants" ], - "summary" : "Updates a user", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "updateUser", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The user id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The user configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/UserEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/UserEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /tenants" : [ ] - } ] - }, - "delete" : { - "tags" : [ "tenants" ], - "summary" : "Deletes a user", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "removeUser", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The revision is used to verify the client is working with the latest version of the flow.", - "required" : false, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The user id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/UserEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /tenants" : [ ] - } ] - } - }, - "/versions/active-requests" : { - "post" : { - "tags" : [ "versions" ], - "summary" : "Create a version control request", - "description" : "Creates a request so that a Process Group can be placed under Version Control or have its Version Control configuration changed. Creating this request will prevent any other threads from simultaneously saving local changes to Version Control. It will not, however, actually save the local flow to the Flow Registry. A POST to /versions/process-groups/{id} should be used to initiate saving of the local flow to the Flow Registry. Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "createVersionControlRequest", - "consumes" : [ "application/json" ], - "produces" : [ "text/plain" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The versioned flow details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/CreateActiveRequestEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/versions/active-requests/{id}" : { - "put" : { - "tags" : [ "versions" ], - "summary" : "Updates the request with the given ID", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "updateVersionControlRequest", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The request ID.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The version control component mapping.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/VersionControlComponentMappingEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionControlInformationEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Only the user that submitted the request can update it" : [ ] - } ] - }, - "delete" : { - "tags" : [ "versions" ], - "summary" : "Deletes the version control request with the given ID", - "description" : "Deletes the Version Control Request with the given ID. This will allow other threads to save flows to the Flow Registry. See also the documentation for POSTing to /versions/active-requests for information regarding why this is done. Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "deleteVersionControlRequest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The request ID.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Only the user that submitted the request can remove it" : [ ] - } ] - } - }, - "/versions/process-groups/{id}" : { - "get" : { - "tags" : [ "versions" ], - "summary" : "Gets the Version Control information for a process group", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getVersionInformation", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionControlInformationEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - } ] - }, - "post" : { - "tags" : [ "versions" ], - "summary" : "Save the Process Group with the given ID", - "description" : "Begins version controlling the Process Group with the given ID or commits changes to the Versioned Flow, depending on if the provided VersionControlInformation includes a flowId. Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "saveToFlowRegistry", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The versioned flow details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/StartVersionControlRequestEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionControlInformationEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - }, { - "Write - /process-groups/{uuid}" : [ ] - }, { - "Read - /{component-type}/{uuid} - For all encapsulated components" : [ ] - }, { - "Read - any referenced Controller Services by any encapsulated components - /controller-services/{uuid}" : [ ] - } ] - }, - "put" : { - "tags" : [ "versions" ], - "summary" : "Update the version of a Process Group with the given ID", - "description" : "For a Process Group that is already under Version Control, this will update the version of the flow to a different version. This endpoint expects that the given snapshot will not modify any Processor that is currently running or any Controller Service that is enabled. Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "updateFlowVersion", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The controller service configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/VersionedFlowSnapshotEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionControlInformationEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - }, { - "Write - /process-groups/{uuid}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "versions" ], - "summary" : "Stops version controlling the Process Group with the given ID", - "description" : "Stops version controlling the Process Group with the given ID. The Process Group will no longer track to any Versioned Flow. Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "stopVersionControl", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The version is used to verify the client is working with the latest version of the flow.", - "required" : false, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, a new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionControlInformationEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - }, { - "Write - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/versions/process-groups/{id}/download" : { - "get" : { - "tags" : [ "versions" ], - "summary" : "Gets the latest version of a Process Group for download", - "description" : "", - "operationId" : "exportFlowVersion", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/versions/revert-requests/process-groups/{id}" : { - "post" : { - "tags" : [ "versions" ], - "summary" : "Initiate the Revert Request of a Process Group with the given ID", - "description" : "For a Process Group that is already under Version Control, this will initiate the action of reverting any local changes that have been made to the Process Group since it was last synchronized with the Flow Registry. This will result in the flow matching the Versioned Flow that exists in the Flow Registry. This can be a lengthy process, as it will stop any Processors and disable any Controller Services necessary to perform the action and then restart them. As a result, the endpoint will immediately return a VersionedFlowUpdateRequestEntity, and the process of updating the flow will occur asynchronously in the background. The client may then periodically poll the status of the request by issuing a GET request to /versions/revert-requests/{requestId}. Once the request is completed, the client is expected to issue a DELETE request to /versions/revert-requests/{requestId}. Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "initiateRevertFlowVersion", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The controller service configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/VersionControlInformationEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlowUpdateRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - }, { - "Write - /process-groups/{uuid}" : [ ] - }, { - "Read - /{component-type}/{uuid} - For all encapsulated components" : [ ] - }, { - "Write - /{component-type}/{uuid} - For all encapsulated components" : [ ] - }, { - "Write - if the template contains any restricted components - /restricted-components" : [ ] - }, { - "Read - /parameter-contexts/{uuid} - For any Parameter Context that is referenced by a Property that is changed, added, or removed" : [ ] - } ] - } - }, - "/versions/revert-requests/{id}" : { - "get" : { - "tags" : [ "versions" ], - "summary" : "Returns the Revert Request with the given ID", - "description" : "Returns the Revert Request with the given ID. Once a Revert Request has been created by performing a POST to /versions/revert-requests/process-groups/{id}, that request can subsequently be retrieved via this endpoint, and the request that is fetched will contain the updated state, such as percent complete, the current state of the request, and any failures. Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getRevertRequest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The ID of the Revert Request", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlowUpdateRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Only the user that submitted the request can get it" : [ ] - } ] - }, - "delete" : { - "tags" : [ "versions" ], - "summary" : "Deletes the Revert Request with the given ID", - "description" : "Deletes the Revert Request with the given ID. After a request is created via a POST to /versions/revert-requests/process-groups/{id}, it is expected that the client will properly clean up the request by DELETE'ing it, once the Revert process has completed. If the request is deleted before the request completes, then the Revert request will finish the step that it is currently performing and then will cancel any subsequent steps. Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "deleteRevertRequest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The ID of the Revert Request", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlowUpdateRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Only the user that submitted the request can remove it" : [ ] - } ] - } - }, - "/versions/update-requests/process-groups/{id}" : { - "post" : { - "tags" : [ "versions" ], - "summary" : "Initiate the Update Request of a Process Group with the given ID", - "description" : "For a Process Group that is already under Version Control, this will initiate the action of changing from a specific version of the flow in the Flow Registry to a different version of the flow. This can be a lengthy process, as it will stop any Processors and disable any Controller Services necessary to perform the action and then restart them. As a result, the endpoint will immediately return a VersionedFlowUpdateRequestEntity, and the process of updating the flow will occur asynchronously in the background. The client may then periodically poll the status of the request by issuing a GET request to /versions/update-requests/{requestId}. Once the request is completed, the client is expected to issue a DELETE request to /versions/update-requests/{requestId}. Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "initiateVersionControlUpdate", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The controller service configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/VersionControlInformationEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlowUpdateRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - }, { - "Write - /process-groups/{uuid}" : [ ] - }, { - "Read - /{component-type}/{uuid} - For all encapsulated components" : [ ] - }, { - "Write - /{component-type}/{uuid} - For all encapsulated components" : [ ] - }, { - "Write - if the template contains any restricted components - /restricted-components" : [ ] - }, { - "Read - /parameter-contexts/{uuid} - For any Parameter Context that is referenced by a Property that is changed, added, or removed" : [ ] - } ] - } - }, - "/versions/update-requests/{id}" : { - "get" : { - "tags" : [ "versions" ], - "summary" : "Returns the Update Request with the given ID", - "description" : "Returns the Update Request with the given ID. Once an Update Request has been created by performing a POST to /versions/update-requests/process-groups/{id}, that request can subsequently be retrieved via this endpoint, and the request that is fetched will contain the updated state, such as percent complete, the current state of the request, and any failures. Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getUpdateRequest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The ID of the Update Request", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlowUpdateRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Only the user that submitted the request can get it" : [ ] - } ] - }, - "delete" : { - "tags" : [ "versions" ], - "summary" : "Deletes the Update Request with the given ID", - "description" : "Deletes the Update Request with the given ID. After a request is created via a POST to /versions/update-requests/process-groups/{id}, it is expected that the client will properly clean up the request by DELETE'ing it, once the Update process has completed. If the request is deleted before the request completes, then the Update request will finish the step that it is currently performing and then will cancel any subsequent steps. Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "deleteUpdateRequest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The ID of the Update Request", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlowUpdateRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Only the user that submitted the request can remove it" : [ ] - } ] - } - } - }, - "definitions" : { - "AboutDTO" : { - "type" : "object", - "properties" : { - "title" : { - "type" : "string", - "description" : "The title to be used on the page and in the about dialog." - }, - "version" : { - "type" : "string", - "description" : "The version of this NiFi." - }, - "uri" : { - "type" : "string", - "description" : "The URI for the NiFi." - }, - "contentViewerUrl" : { - "type" : "string", - "description" : "The URL for the content viewer if configured." - }, - "timezone" : { - "type" : "string", - "description" : "The timezone of the NiFi instance.", - "readOnly" : true - }, - "buildTag" : { - "type" : "string", - "description" : "Build tag" - }, - "buildRevision" : { - "type" : "string", - "description" : "Build revision or commit hash" - }, - "buildBranch" : { - "type" : "string", - "description" : "Build branch" - }, - "buildTimestamp" : { - "type" : "string", - "description" : "Build timestamp" - } - } - }, - "AboutEntity" : { - "type" : "object", - "properties" : { - "about" : { - "$ref" : "#/definitions/AboutDTO" - } - }, - "xml" : { - "name" : "aboutEntity" - } - }, - "AccessConfigurationDTO" : { - "type" : "object", - "properties" : { - "supportsLogin" : { - "type" : "boolean", - "description" : "Indicates whether or not this NiFi supports user login.", - "readOnly" : true - } - } - }, - "AccessConfigurationEntity" : { - "type" : "object", - "properties" : { - "config" : { - "$ref" : "#/definitions/AccessConfigurationDTO" - } - }, - "xml" : { - "name" : "accessConfigurationEntity" - } - }, - "AccessPolicyDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "versionedComponentId" : { - "type" : "string", - "description" : "The ID of the corresponding component that is under version control" - }, - "parentGroupId" : { - "type" : "string", - "description" : "The id of parent process group of this component if applicable." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "resource" : { - "type" : "string", - "description" : "The resource for this access policy." - }, - "action" : { - "type" : "string", - "description" : "The action associated with this access policy.", - "enum" : [ "read", "write" ] - }, - "componentReference" : { - "description" : "Component this policy references if applicable.", - "$ref" : "#/definitions/ComponentReferenceEntity" - }, - "configurable" : { - "type" : "boolean", - "description" : "Whether this policy is configurable." - }, - "users" : { - "type" : "array", - "description" : "The set of user IDs associated with this access policy.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/TenantEntity" - } - }, - "userGroups" : { - "type" : "array", - "description" : "The set of user group IDs associated with this access policy.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/TenantEntity" - } - } - } - }, - "AccessPolicyEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "generated" : { - "type" : "string", - "description" : "When this content was generated." - }, - "component" : { - "$ref" : "#/definitions/AccessPolicyDTO" - } - }, - "xml" : { - "name" : "accessPolicyEntity" - } - }, - "AccessPolicySummaryDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "versionedComponentId" : { - "type" : "string", - "description" : "The ID of the corresponding component that is under version control" - }, - "parentGroupId" : { - "type" : "string", - "description" : "The id of parent process group of this component if applicable." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "resource" : { - "type" : "string", - "description" : "The resource for this access policy." - }, - "action" : { - "type" : "string", - "description" : "The action associated with this access policy.", - "enum" : [ "read", "write" ] - }, - "componentReference" : { - "description" : "Component this policy references if applicable.", - "$ref" : "#/definitions/ComponentReferenceEntity" - }, - "configurable" : { - "type" : "boolean", - "description" : "Whether this policy is configurable." - } - } - }, - "AccessPolicySummaryEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "component" : { - "$ref" : "#/definitions/AccessPolicySummaryDTO" - } - }, - "xml" : { - "name" : "accessPolicySummaryEntity" - } - }, - "AccessStatusDTO" : { - "type" : "object", - "properties" : { - "identity" : { - "type" : "string", - "description" : "The user identity.", - "readOnly" : true - }, - "status" : { - "type" : "string", - "description" : "The user access status.", - "readOnly" : true - }, - "message" : { - "type" : "string", - "description" : "Additional details about the user access status.", - "readOnly" : true - } - }, - "xml" : { - "name" : "accessStatus" - } - }, - "AccessStatusEntity" : { - "type" : "object", - "properties" : { - "accessStatus" : { - "$ref" : "#/definitions/AccessStatusDTO" - } - }, - "xml" : { - "name" : "accessStatusEntity" - } - }, - "ActionDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "integer", - "format" : "int32", - "description" : "The action id." - }, - "userIdentity" : { - "type" : "string", - "description" : "The identity of the user that performed the action." - }, - "timestamp" : { - "type" : "string", - "description" : "The timestamp of the action." - }, - "sourceId" : { - "type" : "string", - "description" : "The id of the source component." - }, - "sourceName" : { - "type" : "string", - "description" : "The name of the source component." - }, - "sourceType" : { - "type" : "string", - "description" : "The type of the source component." - }, - "componentDetails" : { - "description" : "The details of the source component.", - "$ref" : "#/definitions/ComponentDetailsDTO" - }, - "operation" : { - "type" : "string", - "description" : "The operation that was performed." - }, - "actionDetails" : { - "description" : "The details of the action.", - "$ref" : "#/definitions/ActionDetailsDTO" - } - } - }, - "ActionDetailsDTO" : { - "type" : "object" - }, - "ActionEntity" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "integer", - "format" : "int32" - }, - "timestamp" : { - "type" : "string", - "description" : "The timestamp of the action." - }, - "sourceId" : { - "type" : "string" - }, - "canRead" : { - "type" : "boolean", - "description" : "Indicates whether the user can read a given resource.", - "readOnly" : true - }, - "action" : { - "$ref" : "#/definitions/ActionDTO" - } - }, - "xml" : { - "name" : "actionEntity" - } - }, - "ActivateControllerServicesEntity" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the ProcessGroup" - }, - "state" : { - "type" : "string", - "description" : "The desired state of the descendant components", - "enum" : [ "ENABLED", "DISABLED" ] - }, - "components" : { - "type" : "object", - "description" : "Optional services to schedule. If not specified, all authorized descendant controller services will be used.", - "additionalProperties" : { - "$ref" : "#/definitions/RevisionDTO" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - } - }, - "xml" : { - "name" : "activateControllerServicesEntity" - } - }, - "AffectedComponentDTO" : { - "type" : "object", - "properties" : { - "processGroupId" : { - "type" : "string", - "description" : "The UUID of the Process Group that this component is in" - }, - "id" : { - "type" : "string", - "description" : "The UUID of this component" - }, - "referenceType" : { - "type" : "string", - "description" : "The type of this component", - "enum" : [ "PROCESSOR", "CONTROLLER_SERVICE", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT" ] - }, - "name" : { - "type" : "string", - "description" : "The name of this component." - }, - "state" : { - "type" : "string", - "description" : "The scheduled state of a processor or reporting task referencing a controller service. If this component is another controller service, this field represents the controller service state." - }, - "activeThreadCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of active threads for the referencing component." - }, - "validationErrors" : { - "type" : "array", - "description" : "The validation errors for the component.", - "items" : { - "type" : "string" - } - } - } - }, - "AffectedComponentEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "component" : { - "$ref" : "#/definitions/AffectedComponentDTO" - }, - "processGroup" : { - "description" : "The Process Group that the component belongs to", - "$ref" : "#/definitions/ProcessGroupNameDTO" - }, - "referenceType" : { - "type" : "string", - "description" : "The type of component referenced", - "enum" : [ "PROCESSOR", "CONTROLLER_SERVICE", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT" ] - } - }, - "xml" : { - "name" : "affectedComponentEntity" - } - }, - "AllowableValueDTO" : { - "type" : "object", - "properties" : { - "displayName" : { - "type" : "string", - "description" : "A human readable value that is allowed for the property descriptor." - }, - "value" : { - "type" : "string", - "description" : "A value that is allowed for the property descriptor." - }, - "description" : { - "type" : "string", - "description" : "A description for this allowable value." - } - } - }, - "AllowableValueEntity" : { - "type" : "object", - "properties" : { - "allowableValue" : { - "$ref" : "#/definitions/AllowableValueDTO" - }, - "canRead" : { - "type" : "boolean", - "description" : "Indicates whether the user can read a given resource.", - "readOnly" : true - } - }, - "xml" : { - "name" : "entity" - } - }, - "AttributeDTO" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The attribute name." - }, - "value" : { - "type" : "string", - "description" : "The attribute value." - }, - "previousValue" : { - "type" : "string", - "description" : "The value of the attribute before the event took place." - } - } - }, - "BannerDTO" : { - "type" : "object", - "properties" : { - "headerText" : { - "type" : "string", - "description" : "The header text." - }, - "footerText" : { - "type" : "string", - "description" : "The footer text." - } - } - }, - "BannerEntity" : { - "type" : "object", - "properties" : { - "banners" : { - "$ref" : "#/definitions/BannerDTO" - } - }, - "xml" : { - "name" : "bannersEntity" - } - }, - "BatchSettingsDTO" : { - "type" : "object", - "properties" : { - "count" : { - "type" : "integer", - "format" : "int32", - "description" : "Preferred number of flow files to include in a transaction." - }, - "size" : { - "type" : "string", - "description" : "Preferred number of bytes to include in a transaction." - }, - "duration" : { - "type" : "string", - "description" : "Preferred amount of time that a transaction should span." - } - } - }, - "BatchSize" : { - "type" : "object", - "properties" : { - "count" : { - "type" : "integer", - "format" : "int32", - "description" : "Preferred number of flow files to include in a transaction." - }, - "size" : { - "type" : "string", - "description" : "Preferred number of bytes to include in a transaction." - }, - "duration" : { - "type" : "string", - "description" : "Preferred amount of time that a transaction should span." - } - } - }, - "Bucket" : { - "type" : "object", - "required" : [ "name" ], - "properties" : { - "link" : { - "description" : "An WebLink to this entity.", - "readOnly" : true, - "$ref" : "#/definitions/JaxbLink" - }, - "identifier" : { - "type" : "string", - "description" : "An ID to uniquely identify this object.", - "readOnly" : true - }, - "name" : { - "type" : "string", - "description" : "The name of the bucket." - }, - "createdTimestamp" : { - "type" : "integer", - "format" : "int64", - "description" : "The timestamp of when the bucket was first created. This is set by the server at creation time.", - "readOnly" : true, - "minimum" : 1 - }, - "description" : { - "type" : "string", - "description" : "A description of the bucket." - }, - "allowBundleRedeploy" : { - "type" : "boolean", - "description" : "Indicates if this bucket allows the same version of an extension bundle to be redeployed and thus overwrite the existing artifact. By default this is false." - }, - "allowPublicRead" : { - "type" : "boolean", - "description" : "Indicates if this bucket allows read access to unauthenticated anonymous users" - }, - "permissions" : { - "description" : "The access that the current user has to this bucket.", - "readOnly" : true, - "$ref" : "#/definitions/Permissions" - }, - "revision" : { - "description" : "The revision of this entity used for optimistic-locking during updates.", - "readOnly" : true, - "$ref" : "#/definitions/RevisionInfo" - } - } - }, - "BucketDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The bucket identifier" - }, - "name" : { - "type" : "string", - "description" : "The bucket name" - }, - "description" : { - "type" : "string", - "description" : "The bucket description" - }, - "created" : { - "type" : "integer", - "format" : "int64", - "description" : "The created timestamp of this bucket" - } - } - }, - "BucketEntity" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string" - }, - "bucket" : { - "$ref" : "#/definitions/BucketDTO" - }, - "permissions" : { - "$ref" : "#/definitions/PermissionsDTO" - } - }, - "xml" : { - "name" : "bucketEntity" - } - }, - "BucketsEntity" : { - "type" : "object", - "properties" : { - "buckets" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/BucketEntity" - } - } - }, - "xml" : { - "name" : "bucketsEntity" - } - }, - "BulletinBoardDTO" : { - "type" : "object", - "properties" : { - "bulletins" : { - "type" : "array", - "description" : "The bulletins in the bulletin board, that matches the supplied request.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "generated" : { - "type" : "string", - "description" : "The timestamp when this report was generated." - } - } - }, - "BulletinBoardEntity" : { - "type" : "object", - "properties" : { - "bulletinBoard" : { - "$ref" : "#/definitions/BulletinBoardDTO" - } - }, - "xml" : { - "name" : "bulletinBoardEntity" - } - }, - "BulletinDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "integer", - "format" : "int64", - "description" : "The id of the bulletin." - }, - "nodeAddress" : { - "type" : "string", - "description" : "If clustered, the address of the node from which the bulletin originated." - }, - "category" : { - "type" : "string", - "description" : "The category of this bulletin." - }, - "groupId" : { - "type" : "string", - "description" : "The group id of the source component." - }, - "sourceId" : { - "type" : "string", - "description" : "The id of the source component." - }, - "sourceName" : { - "type" : "string", - "description" : "The name of the source component." - }, - "level" : { - "type" : "string", - "description" : "The level of the bulletin." - }, - "message" : { - "type" : "string", - "description" : "The bulletin message." - }, - "timestamp" : { - "type" : "string", - "description" : "When this bulletin was generated." - } - } - }, - "BulletinEntity" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "integer", - "format" : "int64" - }, - "groupId" : { - "type" : "string" - }, - "sourceId" : { - "type" : "string" - }, - "timestamp" : { - "type" : "string", - "description" : "When this bulletin was generated." - }, - "nodeAddress" : { - "type" : "string" - }, - "canRead" : { - "type" : "boolean", - "description" : "Indicates whether the user can read a given resource.", - "readOnly" : true - }, - "bulletin" : { - "$ref" : "#/definitions/BulletinDTO" - } - }, - "xml" : { - "name" : "bulletinEntity" - } - }, - "Bundle" : { - "type" : "object", - "properties" : { - "group" : { - "type" : "string", - "description" : "The group of the bundle" - }, - "artifact" : { - "type" : "string", - "description" : "The artifact of the bundle" - }, - "version" : { - "type" : "string", - "description" : "The version of the bundle" - } - } - }, - "BundleDTO" : { - "type" : "object", - "properties" : { - "group" : { - "type" : "string", - "description" : "The group of the bundle." - }, - "artifact" : { - "type" : "string", - "description" : "The artifact of the bundle." - }, - "version" : { - "type" : "string", - "description" : "The version of the bundle." - } - } - }, - "ClusteSummaryEntity" : { - "type" : "object", - "properties" : { - "clusterSummary" : { - "$ref" : "#/definitions/ClusterSummaryDTO" - } - }, - "xml" : { - "name" : "clusterSummaryEntity" - } - }, - "ClusterDTO" : { - "type" : "object", - "properties" : { - "nodes" : { - "type" : "array", - "description" : "The collection of nodes that are part of the cluster.", - "items" : { - "$ref" : "#/definitions/NodeDTO" - } - }, - "generated" : { - "type" : "string", - "description" : "The timestamp the report was generated." - } - } - }, - "ClusterEntity" : { - "type" : "object", - "properties" : { - "cluster" : { - "$ref" : "#/definitions/ClusterDTO" - } - }, - "xml" : { - "name" : "clusterEntity" - } - }, - "ClusterSearchResultsEntity" : { - "type" : "object", - "properties" : { - "nodeResults" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/NodeSearchResultDTO" - } - } - }, - "xml" : { - "name" : "clusterSearchResultsEntity" - } - }, - "ClusterSummaryDTO" : { - "type" : "object", - "properties" : { - "connectedNodes" : { - "type" : "string", - "description" : "When clustered, reports the number of nodes connected vs the number of nodes in the cluster." - }, - "connectedNodeCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of nodes that are currently connected to the cluster" - }, - "totalNodeCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of nodes in the cluster, regardless of whether or not they are connected" - }, - "clustered" : { - "type" : "boolean", - "description" : "Whether this NiFi instance is clustered." - }, - "connectedToCluster" : { - "type" : "boolean", - "description" : "Whether this NiFi instance is connected to a cluster." - } - } - }, - "ComponentDetailsDTO" : { - "type" : "object" - }, - "ComponentDifferenceDTO" : { - "type" : "object", - "properties" : { - "componentType" : { - "type" : "string", - "description" : "The type of component" - }, - "componentId" : { - "type" : "string", - "description" : "The ID of the component" - }, - "componentName" : { - "type" : "string", - "description" : "The name of the component" - }, - "processGroupId" : { - "type" : "string", - "description" : "The ID of the Process Group that the component belongs to" - }, - "differences" : { - "type" : "array", - "description" : "The differences in the component between the two flows", - "items" : { - "$ref" : "#/definitions/DifferenceDTO" - } - } - } - }, - "ComponentHistoryDTO" : { - "type" : "object", - "properties" : { - "componentId" : { - "type" : "string", - "description" : "The component id." - }, - "propertyHistory" : { - "type" : "object", - "description" : "The history for the properties of the component.", - "additionalProperties" : { - "$ref" : "#/definitions/PropertyHistoryDTO" - } - } - } - }, - "ComponentHistoryEntity" : { - "type" : "object", - "properties" : { - "componentHistory" : { - "$ref" : "#/definitions/ComponentHistoryDTO" - } - }, - "xml" : { - "name" : "componentHistoryEntity" - } - }, - "ComponentReferenceDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "versionedComponentId" : { - "type" : "string", - "description" : "The ID of the corresponding component that is under version control" - }, - "parentGroupId" : { - "type" : "string", - "description" : "The id of parent process group of this component if applicable." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "name" : { - "type" : "string", - "description" : "The name of the component." - } - } - }, - "ComponentReferenceEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "parentGroupId" : { - "type" : "string", - "description" : "The id of parent process group of this component if applicable." - }, - "component" : { - "$ref" : "#/definitions/ComponentReferenceDTO" - } - }, - "xml" : { - "name" : "componentReferenceEntity" - } - }, - "ComponentRestrictionPermissionDTO" : { - "type" : "object", - "properties" : { - "requiredPermission" : { - "description" : "The required permission necessary for this restriction.", - "$ref" : "#/definitions/RequiredPermissionDTO" - }, - "permissions" : { - "description" : "The permissions for this component restriction. Note: the read permission are not used and will always be false.", - "$ref" : "#/definitions/PermissionsDTO" - } - } - }, - "ComponentSearchResultDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component that matched the search." - }, - "groupId" : { - "type" : "string", - "description" : "The group id of the component that matched the search." - }, - "parentGroup" : { - "description" : "The parent group of the component that matched the search.", - "$ref" : "#/definitions/SearchResultGroupDTO" - }, - "versionedGroup" : { - "description" : "The nearest versioned ancestor group of the component that matched the search.", - "$ref" : "#/definitions/SearchResultGroupDTO" - }, - "name" : { - "type" : "string", - "description" : "The name of the component that matched the search." - }, - "matches" : { - "type" : "array", - "description" : "What matched the search from the component.", - "items" : { - "type" : "string" - } - } - } - }, - "ComponentStateDTO" : { - "type" : "object", - "properties" : { - "componentId" : { - "type" : "string", - "description" : "The component identifier." - }, - "stateDescription" : { - "type" : "string", - "description" : "Description of the state this component persists." - }, - "clusterState" : { - "description" : "The cluster state for this component, or null if this NiFi is a standalone instance.", - "$ref" : "#/definitions/StateMapDTO" - }, - "localState" : { - "description" : "The local state for this component.", - "$ref" : "#/definitions/StateMapDTO" - } - } - }, - "ComponentStateEntity" : { - "type" : "object", - "properties" : { - "componentState" : { - "description" : "The component state.", - "$ref" : "#/definitions/ComponentStateDTO" - } - }, - "xml" : { - "name" : "componentStateEntity" - } - }, - "ComponentValidationResultDTO" : { - "type" : "object", - "properties" : { - "processGroupId" : { - "type" : "string", - "description" : "The UUID of the Process Group that this component is in" - }, - "id" : { - "type" : "string", - "description" : "The UUID of this component" - }, - "referenceType" : { - "type" : "string", - "description" : "The type of this component", - "enum" : [ "PROCESSOR", "CONTROLLER_SERVICE", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT" ] - }, - "name" : { - "type" : "string", - "description" : "The name of this component." - }, - "state" : { - "type" : "string", - "description" : "The scheduled state of a processor or reporting task referencing a controller service. If this component is another controller service, this field represents the controller service state." - }, - "activeThreadCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of active threads for the referencing component." - }, - "validationErrors" : { - "type" : "array", - "description" : "The validation errors for the component.", - "items" : { - "type" : "string" - } - }, - "currentlyValid" : { - "type" : "boolean", - "description" : "Whether or not the component is currently valid" - }, - "resultsValid" : { - "type" : "boolean", - "description" : "Whether or not the component will be valid if the Parameter Context is changed" - }, - "resultantValidationErrors" : { - "type" : "array", - "description" : "The validation errors that will apply to the component if the Parameter Context is changed", - "items" : { - "type" : "string" - } - } - } - }, - "ComponentValidationResultEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "component" : { - "$ref" : "#/definitions/ComponentValidationResultDTO" - } - }, - "xml" : { - "name" : "componentValidationResultEntity" - } - }, - "ComponentValidationResultsEntity" : { - "type" : "object", - "properties" : { - "validationResults" : { - "type" : "array", - "description" : "A List of ComponentValidationResultEntity, one for each component that is validated", - "items" : { - "$ref" : "#/definitions/ComponentValidationResultEntity" - } - } - }, - "xml" : { - "name" : "componentValidationResults" - } - }, - "ConnectableComponent" : { - "type" : "object", - "required" : [ "groupId", "id", "type" ], - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the connectable component." - }, - "type" : { - "type" : "string", - "description" : "The type of component the connectable is.", - "enum" : [ "PROCESSOR", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "INPUT_PORT", "OUTPUT_PORT", "FUNNEL" ] - }, - "groupId" : { - "type" : "string", - "description" : "The id of the group that the connectable component resides in" - }, - "name" : { - "type" : "string", - "description" : "The name of the connectable component" - }, - "comments" : { - "type" : "string", - "description" : "The comments for the connectable component." - } - } - }, - "ConnectableDTO" : { - "type" : "object", - "required" : [ "groupId", "id", "type" ], - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the connectable component." - }, - "versionedComponentId" : { - "type" : "string", - "description" : "The ID of the corresponding component that is under version control" - }, - "type" : { - "type" : "string", - "description" : "The type of component the connectable is.", - "enum" : [ "PROCESSOR", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "INPUT_PORT", "OUTPUT_PORT", "FUNNEL" ] - }, - "groupId" : { - "type" : "string", - "description" : "The id of the group that the connectable component resides in" - }, - "name" : { - "type" : "string", - "description" : "The name of the connectable component" - }, - "running" : { - "type" : "boolean", - "description" : "Reflects the current state of the connectable component." - }, - "transmitting" : { - "type" : "boolean", - "description" : "If the connectable component represents a remote port, indicates if the target is configured to transmit." - }, - "exists" : { - "type" : "boolean", - "description" : "If the connectable component represents a remote port, indicates if the target exists." - }, - "comments" : { - "type" : "string", - "description" : "The comments for the connectable component." - } - } - }, - "ConnectionDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "versionedComponentId" : { - "type" : "string", - "description" : "The ID of the corresponding component that is under version control" - }, - "parentGroupId" : { - "type" : "string", - "description" : "The id of parent process group of this component if applicable." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "source" : { - "description" : "The source of the connection.", - "$ref" : "#/definitions/ConnectableDTO" - }, - "destination" : { - "description" : "The destination of the connection.", - "$ref" : "#/definitions/ConnectableDTO" - }, - "name" : { - "type" : "string", - "description" : "The name of the connection." - }, - "labelIndex" : { - "type" : "integer", - "format" : "int32", - "description" : "The index of the bend point where to place the connection label." - }, - "getzIndex" : { - "type" : "integer", - "format" : "int64", - "description" : "The z index of the connection." - }, - "selectedRelationships" : { - "type" : "array", - "description" : "The selected relationship that comprise the connection.", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - }, - "availableRelationships" : { - "type" : "array", - "description" : "The relationships that the source of the connection currently supports.", - "readOnly" : true, - "uniqueItems" : true, - "items" : { - "type" : "string" - } - }, - "backPressureObjectThreshold" : { - "type" : "integer", - "format" : "int64", - "description" : "The object count threshold for determining when back pressure is applied. Updating this value is a passive change in the sense that it won't impact whether existing files over the limit are affected but it does help feeder processors to stop pushing too much into this work queue." - }, - "backPressureDataSizeThreshold" : { - "type" : "string", - "description" : "The object data size threshold for determining when back pressure is applied. Updating this value is a passive change in the sense that it won't impact whether existing files over the limit are affected but it does help feeder processors to stop pushing too much into this work queue." - }, - "flowFileExpiration" : { - "type" : "string", - "description" : "The amount of time a flow file may be in the flow before it will be automatically aged out of the flow. Once a flow file reaches this age it will be terminated from the flow the next time a processor attempts to start work on it." - }, - "prioritizers" : { - "type" : "array", - "description" : "The comparators used to prioritize the queue.", - "items" : { - "type" : "string" - } - }, - "bends" : { - "type" : "array", - "description" : "The bend points on the connection.", - "items" : { - "$ref" : "#/definitions/PositionDTO" - } - }, - "loadBalanceStrategy" : { - "type" : "string", - "description" : "How to load balance the data in this Connection across the nodes in the cluster.", - "enum" : [ "DO_NOT_LOAD_BALANCE", "PARTITION_BY_ATTRIBUTE", "ROUND_ROBIN", "SINGLE_NODE" ] - }, - "loadBalancePartitionAttribute" : { - "type" : "string", - "description" : "The FlowFile Attribute to use for determining which node a FlowFile will go to if the Load Balancing Strategy is set to PARTITION_BY_ATTRIBUTE" - }, - "loadBalanceCompression" : { - "type" : "string", - "description" : "Whether or not data should be compressed when being transferred between nodes in the cluster.", - "enum" : [ "DO_NOT_COMPRESS", "COMPRESS_ATTRIBUTES_ONLY", "COMPRESS_ATTRIBUTES_AND_CONTENT" ] - }, - "loadBalanceStatus" : { - "type" : "string", - "description" : "The current status of the Connection's Load Balancing Activities. Status can indicate that Load Balancing is not configured for the connection, that Load Balancing is configured but inactive (not currently transferring data to another node), or that Load Balancing is configured and actively transferring data to another node.", - "readOnly" : true, - "enum" : [ "LOAD_BALANCE_NOT_CONFIGURED", "LOAD_BALANCE_INACTIVE", "LOAD_BALANCE_ACTIVE" ] - } - } - }, - "ConnectionEntity" : { - "type" : "object", - "required" : [ "destinationType", "sourceType" ], - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "component" : { - "$ref" : "#/definitions/ConnectionDTO" - }, - "status" : { - "description" : "The status of the connection.", - "$ref" : "#/definitions/ConnectionStatusDTO" - }, - "bends" : { - "type" : "array", - "description" : "The bend points on the connection.", - "items" : { - "$ref" : "#/definitions/PositionDTO" - } - }, - "labelIndex" : { - "type" : "integer", - "format" : "int32", - "description" : "The index of the bend point where to place the connection label." - }, - "getzIndex" : { - "type" : "integer", - "format" : "int64", - "description" : "The z index of the connection." - }, - "sourceId" : { - "type" : "string", - "description" : "The identifier of the source of this connection." - }, - "sourceGroupId" : { - "type" : "string", - "description" : "The identifier of the group of the source of this connection." - }, - "sourceType" : { - "type" : "string", - "description" : "The type of component the source connectable is.", - "enum" : [ "PROCESSOR", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "INPUT_PORT", "OUTPUT_PORT", "FUNNEL" ] - }, - "destinationId" : { - "type" : "string", - "description" : "The identifier of the destination of this connection." - }, - "destinationGroupId" : { - "type" : "string", - "description" : "The identifier of the group of the destination of this connection." - }, - "destinationType" : { - "type" : "string", - "description" : "The type of component the destination connectable is.", - "enum" : [ "PROCESSOR", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "INPUT_PORT", "OUTPUT_PORT", "FUNNEL" ] - } - }, - "xml" : { - "name" : "connectionEntity" - } - }, - "ConnectionStatisticsDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The ID of the connection" - }, - "statsLastRefreshed" : { - "type" : "string", - "description" : "The timestamp of when the stats were last refreshed" - }, - "aggregateSnapshot" : { - "description" : "The status snapshot that represents the aggregate stats of the cluster", - "$ref" : "#/definitions/ConnectionStatisticsSnapshotDTO" - }, - "nodeSnapshots" : { - "type" : "array", - "description" : "A list of status snapshots for each node", - "items" : { - "$ref" : "#/definitions/NodeConnectionStatisticsSnapshotDTO" - } - } - } - }, - "ConnectionStatisticsEntity" : { - "type" : "object", - "properties" : { - "connectionStatistics" : { - "$ref" : "#/definitions/ConnectionStatisticsDTO" - }, - "canRead" : { - "type" : "boolean", - "description" : "Indicates whether the user can read a given resource.", - "readOnly" : true - } - }, - "xml" : { - "name" : "connectionStatisticsEntity" - } - }, - "ConnectionStatisticsSnapshotDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the connection." - }, - "predictedMillisUntilCountBackpressure" : { - "type" : "integer", - "format" : "int64", - "description" : "The predicted number of milliseconds before the connection will have backpressure applied, based on the queued count." - }, - "predictedMillisUntilBytesBackpressure" : { - "type" : "integer", - "format" : "int64", - "description" : "The predicted number of milliseconds before the connection will have backpressure applied, based on the total number of bytes in the queue." - }, - "predictedCountAtNextInterval" : { - "type" : "integer", - "format" : "int32", - "description" : "The predicted number of queued objects at the next configured interval." - }, - "predictedBytesAtNextInterval" : { - "type" : "integer", - "format" : "int64", - "description" : "The predicted total number of bytes in the queue at the next configured interval." - }, - "predictedPercentCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The predicted percentage of queued objects at the next configured interval." - }, - "predictedPercentBytes" : { - "type" : "integer", - "format" : "int32", - "description" : "The predicted percentage of bytes in the queue against current threshold at the next configured interval." - }, - "predictionIntervalMillis" : { - "type" : "integer", - "format" : "int64", - "description" : "The prediction interval in seconds" - } - } - }, - "ConnectionStatusDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The ID of the connection" - }, - "groupId" : { - "type" : "string", - "description" : "The ID of the Process Group that the connection belongs to" - }, - "name" : { - "type" : "string", - "description" : "The name of the connection" - }, - "statsLastRefreshed" : { - "type" : "string", - "description" : "The timestamp of when the stats were last refreshed" - }, - "sourceId" : { - "type" : "string", - "description" : "The ID of the source component" - }, - "sourceName" : { - "type" : "string", - "description" : "The name of the source component" - }, - "destinationId" : { - "type" : "string", - "description" : "The ID of the destination component" - }, - "destinationName" : { - "type" : "string", - "description" : "The name of the destination component" - }, - "aggregateSnapshot" : { - "description" : "The status snapshot that represents the aggregate stats of the cluster", - "$ref" : "#/definitions/ConnectionStatusSnapshotDTO" - }, - "nodeSnapshots" : { - "type" : "array", - "description" : "A list of status snapshots for each node", - "items" : { - "$ref" : "#/definitions/NodeConnectionStatusSnapshotDTO" - } - } - } - }, - "ConnectionStatusEntity" : { - "type" : "object", - "properties" : { - "connectionStatus" : { - "$ref" : "#/definitions/ConnectionStatusDTO" - }, - "canRead" : { - "type" : "boolean", - "description" : "Indicates whether the user can read a given resource.", - "readOnly" : true - } - }, - "xml" : { - "name" : "connectionStatusEntity" - } - }, - "ConnectionStatusPredictionsSnapshotDTO" : { - "type" : "object", - "properties" : { - "predictedMillisUntilCountBackpressure" : { - "type" : "integer", - "format" : "int64", - "description" : "The predicted number of milliseconds before the connection will have backpressure applied, based on the queued count." - }, - "predictedMillisUntilBytesBackpressure" : { - "type" : "integer", - "format" : "int64", - "description" : "The predicted number of milliseconds before the connection will have backpressure applied, based on the total number of bytes in the queue." - }, - "predictionIntervalSeconds" : { - "type" : "integer", - "format" : "int32", - "description" : "The configured interval (in seconds) for predicting connection queue count and size (and percent usage)." - }, - "predictedCountAtNextInterval" : { - "type" : "integer", - "format" : "int32", - "description" : "The predicted number of queued objects at the next configured interval." - }, - "predictedBytesAtNextInterval" : { - "type" : "integer", - "format" : "int64", - "description" : "The predicted total number of bytes in the queue at the next configured interval." - }, - "predictedPercentCount" : { - "type" : "integer", - "format" : "int32", - "description" : "Predicted connection percent use regarding queued flow files count and backpressure threshold if configured." - }, - "predictedPercentBytes" : { - "type" : "integer", - "format" : "int32", - "description" : "Predicted connection percent use regarding queued flow files size and backpressure threshold if configured." - } - } - }, - "ConnectionStatusSnapshotDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the connection." - }, - "groupId" : { - "type" : "string", - "description" : "The id of the process group the connection belongs to." - }, - "name" : { - "type" : "string", - "description" : "The name of the connection." - }, - "sourceId" : { - "type" : "string", - "description" : "The id of the source of the connection." - }, - "sourceName" : { - "type" : "string", - "description" : "The name of the source of the connection." - }, - "destinationId" : { - "type" : "string", - "description" : "The id of the destination of the connection." - }, - "destinationName" : { - "type" : "string", - "description" : "The name of the destination of the connection." - }, - "predictions" : { - "description" : "Predictions, if available, for this connection (null if not available)", - "$ref" : "#/definitions/ConnectionStatusPredictionsSnapshotDTO" - }, - "flowFilesIn" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of FlowFiles that have come into the connection in the last 5 minutes." - }, - "bytesIn" : { - "type" : "integer", - "format" : "int64", - "description" : "The size of the FlowFiles that have come into the connection in the last 5 minutes." - }, - "input" : { - "type" : "string", - "description" : "The input count/size for the connection in the last 5 minutes, pretty printed." - }, - "flowFilesOut" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of FlowFiles that have left the connection in the last 5 minutes." - }, - "bytesOut" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes that have left the connection in the last 5 minutes." - }, - "output" : { - "type" : "string", - "description" : "The output count/sie for the connection in the last 5 minutes, pretty printed." - }, - "flowFilesQueued" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of FlowFiles that are currently queued in the connection." - }, - "bytesQueued" : { - "type" : "integer", - "format" : "int64", - "description" : "The size of the FlowFiles that are currently queued in the connection." - }, - "queued" : { - "type" : "string", - "description" : "The total count and size of queued flowfiles formatted." - }, - "queuedSize" : { - "type" : "string", - "description" : "The total size of flowfiles that are queued formatted." - }, - "queuedCount" : { - "type" : "string", - "description" : "The number of flowfiles that are queued, pretty printed." - }, - "percentUseCount" : { - "type" : "integer", - "format" : "int32", - "description" : "Connection percent use regarding queued flow files count and backpressure threshold if configured." - }, - "percentUseBytes" : { - "type" : "integer", - "format" : "int32", - "description" : "Connection percent use regarding queued flow files size and backpressure threshold if configured." - } - } - }, - "ConnectionStatusSnapshotEntity" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the connection." - }, - "connectionStatusSnapshot" : { - "$ref" : "#/definitions/ConnectionStatusSnapshotDTO" - }, - "canRead" : { - "type" : "boolean", - "description" : "Indicates whether the user can read a given resource.", - "readOnly" : true - } - }, - "xml" : { - "name" : "entity" - } - }, - "ConnectionsEntity" : { - "type" : "object", - "properties" : { - "connections" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ConnectionEntity" - } - } - }, - "xml" : { - "name" : "connectionsEntity" - } - }, - "ControllerBulletinsEntity" : { - "type" : "object", - "properties" : { - "bulletins" : { - "type" : "array", - "description" : "System level bulletins to be reported to the user.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "controllerServiceBulletins" : { - "type" : "array", - "description" : "Controller service bulletins to be reported to the user.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "reportingTaskBulletins" : { - "type" : "array", - "description" : "Reporting task bulletins to be reported to the user.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - } - }, - "xml" : { - "name" : "controllerConfigurationEntity" - } - }, - "ControllerConfigurationDTO" : { - "type" : "object", - "properties" : { - "maxTimerDrivenThreadCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The maximum number of timer driven threads the NiFi has available." - }, - "maxEventDrivenThreadCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The maximum number of event driven threads the NiFi has available." - } - } - }, - "ControllerConfigurationEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "component" : { - "description" : "The controller configuration.", - "$ref" : "#/definitions/ControllerConfigurationDTO" - } - }, - "xml" : { - "name" : "controllerConfigurationEntity" - } - }, - "ControllerDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the NiFi." - }, - "name" : { - "type" : "string", - "description" : "The name of the NiFi." - }, - "comments" : { - "type" : "string", - "description" : "The comments for the NiFi." - }, - "runningCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of running components in the NiFi." - }, - "stoppedCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of stopped components in the NiFi." - }, - "invalidCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of invalid components in the NiFi." - }, - "disabledCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of disabled components in the NiFi." - }, - "activeRemotePortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of active remote ports contained in the NiFi." - }, - "inactiveRemotePortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of inactive remote ports contained in the NiFi." - }, - "inputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of input ports contained in the NiFi." - }, - "outputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of output ports in the NiFi." - }, - "remoteSiteListeningPort" : { - "type" : "integer", - "format" : "int32", - "description" : "The Socket Port on which this instance is listening for Remote Transfers of Flow Files. If this instance is not configured to receive Flow Files from remote instances, this will be null." - }, - "remoteSiteHttpListeningPort" : { - "type" : "integer", - "format" : "int32", - "description" : "The HTTP(S) Port on which this instance is listening for Remote Transfers of Flow Files. If this instance is not configured to receive Flow Files from remote instances, this will be null." - }, - "siteToSiteSecure" : { - "type" : "boolean", - "description" : "Indicates whether or not Site-to-Site communications with this instance is secure (2-way authentication)." - }, - "instanceId" : { - "type" : "string", - "description" : "If clustered, the id of the Cluster Manager, otherwise the id of the NiFi." - }, - "inputPorts" : { - "type" : "array", - "description" : "The input ports available to send data to for the NiFi.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/PortDTO" - } - }, - "outputPorts" : { - "type" : "array", - "description" : "The output ports available to received data from the NiFi.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/PortDTO" - } - } - } - }, - "ControllerEntity" : { - "type" : "object", - "properties" : { - "controller" : { - "$ref" : "#/definitions/ControllerDTO" - } - }, - "xml" : { - "name" : "controllerEntity" - } - }, - "ControllerServiceAPI" : { - "type" : "object", - "properties" : { - "type" : { - "type" : "string", - "description" : "The fully qualified name of the service interface." - }, - "bundle" : { - "description" : "The details of the artifact that bundled this service interface.", - "$ref" : "#/definitions/Bundle" - } - } - }, - "ControllerServiceApiDTO" : { - "type" : "object", - "properties" : { - "type" : { - "type" : "string", - "description" : "The fully qualified name of the service interface." - }, - "bundle" : { - "description" : "The details of the artifact that bundled this service interface.", - "$ref" : "#/definitions/BundleDTO" - } - } - }, - "ControllerServiceDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "versionedComponentId" : { - "type" : "string", - "description" : "The ID of the corresponding component that is under version control" - }, - "parentGroupId" : { - "type" : "string", - "description" : "The id of parent process group of this component if applicable." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "name" : { - "type" : "string", - "description" : "The name of the controller service." - }, - "type" : { - "type" : "string", - "description" : "The type of the controller service." - }, - "bundle" : { - "description" : "The details of the artifact that bundled this processor type.", - "$ref" : "#/definitions/BundleDTO" - }, - "controllerServiceApis" : { - "type" : "array", - "description" : "Lists the APIs this Controller Service implements.", - "items" : { - "$ref" : "#/definitions/ControllerServiceApiDTO" - } - }, - "comments" : { - "type" : "string", - "description" : "The comments for the controller service." - }, - "state" : { - "type" : "string", - "description" : "The state of the controller service.", - "enum" : [ "ENABLED", "ENABLING", "DISABLED", "DISABLING" ] - }, - "persistsState" : { - "type" : "boolean", - "description" : "Whether the controller service persists state." - }, - "restricted" : { - "type" : "boolean", - "description" : "Whether the controller service requires elevated privileges." - }, - "deprecated" : { - "type" : "boolean", - "description" : "Whether the ontroller service has been deprecated." - }, - "multipleVersionsAvailable" : { - "type" : "boolean", - "description" : "Whether the controller service has multiple versions available." - }, - "properties" : { - "type" : "object", - "description" : "The properties of the controller service.", - "additionalProperties" : { - "type" : "string" - } - }, - "descriptors" : { - "type" : "object", - "description" : "The descriptors for the controller service properties.", - "additionalProperties" : { - "$ref" : "#/definitions/PropertyDescriptorDTO" - } - }, - "customUiUrl" : { - "type" : "string", - "description" : "The URL for the controller services custom configuration UI if applicable." - }, - "annotationData" : { - "type" : "string", - "description" : "The annotation for the controller service. This is how the custom UI relays configuration to the controller service." - }, - "referencingComponents" : { - "type" : "array", - "description" : "All components referencing this controller service.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ControllerServiceReferencingComponentEntity" - } - }, - "validationErrors" : { - "type" : "array", - "description" : "The validation errors from the controller service. These validation errors represent the problems with the controller service that must be resolved before it can be enabled.", - "items" : { - "type" : "string" - } - }, - "validationStatus" : { - "type" : "string", - "description" : "Indicates whether the ControllerService is valid, invalid, or still in the process of validating (i.e., it is unknown whether or not the ControllerService is valid)", - "readOnly" : true, - "enum" : [ "VALID", "INVALID", "VALIDATING" ] - }, - "extensionMissing" : { - "type" : "boolean", - "description" : "Whether the underlying extension is missing." - } - } - }, - "ControllerServiceEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "parentGroupId" : { - "type" : "string", - "description" : "The id of parent process group of this ControllerService." - }, - "component" : { - "$ref" : "#/definitions/ControllerServiceDTO" - }, - "operatePermissions" : { - "description" : "The permissions for this component operations.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "status" : { - "description" : "The status for this ControllerService.", - "readOnly" : true, - "$ref" : "#/definitions/ControllerServiceStatusDTO" - } - }, - "xml" : { - "name" : "controllerServiceEntity" - } - }, - "ControllerServiceReferencingComponentDTO" : { - "type" : "object", - "properties" : { - "groupId" : { - "type" : "string", - "description" : "The group id for the component referencing a controller service. If this component is another controller service or a reporting task, this field is blank." - }, - "id" : { - "type" : "string", - "description" : "The id of the component referencing a controller service." - }, - "name" : { - "type" : "string", - "description" : "The name of the component referencing a controller service." - }, - "type" : { - "type" : "string", - "description" : "The type of the component referencing a controller service in simple Java class name format without package name." - }, - "state" : { - "type" : "string", - "description" : "The scheduled state of a processor or reporting task referencing a controller service. If this component is another controller service, this field represents the controller service state." - }, - "properties" : { - "type" : "object", - "description" : "The properties for the component.", - "additionalProperties" : { - "type" : "string" - } - }, - "descriptors" : { - "type" : "object", - "description" : "The descriptors for the component properties.", - "additionalProperties" : { - "$ref" : "#/definitions/PropertyDescriptorDTO" - } - }, - "validationErrors" : { - "type" : "array", - "description" : "The validation errors for the component.", - "items" : { - "type" : "string" - } - }, - "referenceType" : { - "type" : "string", - "description" : "The type of reference this is.", - "enum" : [ "Processor", "ControllerService", "ReportingTask" ] - }, - "activeThreadCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of active threads for the referencing component." - }, - "referenceCycle" : { - "type" : "boolean", - "description" : "If the referencing component represents a controller service, this indicates whether it has already been represented in this hierarchy." - }, - "referencingComponents" : { - "type" : "array", - "description" : "If the referencing component represents a controller service, these are the components that reference it.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ControllerServiceReferencingComponentEntity" - } - } - } - }, - "ControllerServiceReferencingComponentEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "component" : { - "$ref" : "#/definitions/ControllerServiceReferencingComponentDTO" - }, - "operatePermissions" : { - "description" : "The permissions for this component operations.", - "$ref" : "#/definitions/PermissionsDTO" - } - }, - "xml" : { - "name" : "controllerServiceReferencingComponentEntity" - } - }, - "ControllerServiceReferencingComponentsEntity" : { - "type" : "object", - "properties" : { - "controllerServiceReferencingComponents" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ControllerServiceReferencingComponentEntity" - } - } - }, - "xml" : { - "name" : "controllerServiceReferencingComponentsEntity" - } - }, - "ControllerServiceRunStatusEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "state" : { - "type" : "string", - "description" : "The run status of the ControllerService.", - "enum" : [ "ENABLED", "DISABLED" ] - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - } - }, - "xml" : { - "name" : "entity" - } - }, - "ControllerServiceStatusDTO" : { - "type" : "object", - "properties" : { - "runStatus" : { - "type" : "string", - "description" : "The run status of this ControllerService", - "readOnly" : true, - "enum" : [ "ENABLED", "ENABLING", "DISABLED", "DISABLING" ] - }, - "validationStatus" : { - "type" : "string", - "description" : "Indicates whether the component is valid, invalid, or still in the process of validating (i.e., it is unknown whether or not the component is valid)", - "readOnly" : true, - "enum" : [ "VALID", "INVALID", "VALIDATING" ] - }, - "activeThreadCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of active threads for the component." - } - } - }, - "ControllerServiceTypesEntity" : { - "type" : "object", - "properties" : { - "controllerServiceTypes" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/DocumentedTypeDTO" - } - } - }, - "xml" : { - "name" : "controllerServiceTypesEntity" - } - }, - "ControllerServicesEntity" : { - "type" : "object", - "properties" : { - "currentTime" : { - "type" : "string", - "description" : "The current time on the system." - }, - "controllerServices" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ControllerServiceEntity" - } - } - }, - "xml" : { - "name" : "controllerServicesEntity" - } - }, - "ControllerStatusDTO" : { - "type" : "object", - "properties" : { - "activeThreadCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of active threads in the NiFi." - }, - "terminatedThreadCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of terminated threads in the NiFi." - }, - "queued" : { - "type" : "string", - "description" : "The number of flowfiles queued in the NiFi." - }, - "flowFilesQueued" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of FlowFiles queued across the entire flow" - }, - "bytesQueued" : { - "type" : "integer", - "format" : "int64", - "description" : "The size of the FlowFiles queued across the entire flow" - }, - "runningCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of running components in the NiFi." - }, - "stoppedCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of stopped components in the NiFi." - }, - "invalidCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of invalid components in the NiFi." - }, - "disabledCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of disabled components in the NiFi." - }, - "activeRemotePortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of active remote ports in the NiFi." - }, - "inactiveRemotePortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of inactive remote ports in the NiFi." - }, - "upToDateCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of up to date versioned process groups in the NiFi." - }, - "locallyModifiedCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of locally modified versioned process groups in the NiFi." - }, - "staleCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of stale versioned process groups in the NiFi." - }, - "locallyModifiedAndStaleCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of locally modified and stale versioned process groups in the NiFi." - }, - "syncFailureCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of versioned process groups in the NiFi that are unable to sync to a registry." - } - } - }, - "ControllerStatusEntity" : { - "type" : "object", - "properties" : { - "controllerStatus" : { - "$ref" : "#/definitions/ControllerStatusDTO" - } - }, - "xml" : { - "name" : "controllerStatusEntity" - } - }, - "CopySnippetRequestEntity" : { - "type" : "object", - "properties" : { - "snippetId" : { - "type" : "string", - "description" : "The identifier of the snippet." - }, - "originX" : { - "type" : "number", - "format" : "double", - "description" : "The x coordinate of the origin of the bounding box where the new components will be placed." - }, - "originY" : { - "type" : "number", - "format" : "double", - "description" : "The y coordinate of the origin of the bounding box where the new components will be placed." - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - } - }, - "xml" : { - "name" : "copySnippetRequestEntity" - } - }, - "CounterDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the counter." - }, - "context" : { - "type" : "string", - "description" : "The context of the counter." - }, - "name" : { - "type" : "string", - "description" : "The name of the counter." - }, - "valueCount" : { - "type" : "integer", - "format" : "int64", - "description" : "The value count." - }, - "value" : { - "type" : "string", - "description" : "The value of the counter." - } - } - }, - "CounterEntity" : { - "type" : "object", - "properties" : { - "counter" : { - "$ref" : "#/definitions/CounterDTO" - } - }, - "xml" : { - "name" : "counterEntity" - } - }, - "CountersDTO" : { - "type" : "object", - "properties" : { - "aggregateSnapshot" : { - "description" : "A Counters snapshot that represents the aggregate values of all nodes in the cluster. If the NiFi instance is a standalone instance, rather than a cluster, this represents the stats of the single instance.", - "$ref" : "#/definitions/CountersSnapshotDTO" - }, - "nodeSnapshots" : { - "type" : "array", - "description" : "A Counters snapshot for each node in the cluster. If the NiFi instance is a standalone instance, rather than a cluster, this may be null.", - "items" : { - "$ref" : "#/definitions/NodeCountersSnapshotDTO" - } - } - } - }, - "CountersEntity" : { - "type" : "object", - "properties" : { - "counters" : { - "$ref" : "#/definitions/CountersDTO" - } - }, - "xml" : { - "name" : "countersEntity" - } - }, - "CountersSnapshotDTO" : { - "type" : "object", - "properties" : { - "generated" : { - "type" : "string", - "description" : "The timestamp when the report was generated." - }, - "counters" : { - "type" : "array", - "description" : "All counters in the NiFi.", - "items" : { - "$ref" : "#/definitions/CounterDTO" - } - } - } - }, - "CreateActiveRequestEntity" : { - "type" : "object", - "properties" : { - "processGroupId" : { - "type" : "string", - "description" : "The Process Group ID that this active request will update" - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - } - }, - "xml" : { - "name" : "createActiveRequestEntity" - } - }, - "CreateTemplateRequestEntity" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The name of the template." - }, - "description" : { - "type" : "string", - "description" : "The description of the template." - }, - "snippetId" : { - "type" : "string", - "description" : "The identifier of the snippet." - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - } - }, - "xml" : { - "name" : "createTemplateRequestEntity" - } - }, - "CurrentUserEntity" : { - "type" : "object", - "properties" : { - "identity" : { - "type" : "string", - "description" : "The user identity being serialized." - }, - "anonymous" : { - "type" : "boolean", - "description" : "Whether the current user is anonymous." - }, - "provenancePermissions" : { - "description" : "Permissions for querying provenance.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "countersPermissions" : { - "description" : "Permissions for accessing counters.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "tenantsPermissions" : { - "description" : "Permissions for accessing tenants.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "controllerPermissions" : { - "description" : "Permissions for accessing the controller.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "policiesPermissions" : { - "description" : "Permissions for accessing the policies.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "systemPermissions" : { - "description" : "Permissions for accessing system.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "parameterContextPermissions" : { - "description" : "Permissions for accessing parameter contexts.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "restrictedComponentsPermissions" : { - "description" : "Permissions for accessing restricted components. Note: the read permission are not used and will always be false.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "componentRestrictionPermissions" : { - "type" : "array", - "description" : "Permissions for specific component restrictions.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ComponentRestrictionPermissionDTO" - } - }, - "canVersionFlows" : { - "type" : "boolean", - "description" : "Whether the current user can version flows." - } - }, - "xml" : { - "name" : "currentEntity" - } - }, - "DifferenceDTO" : { - "type" : "object", - "properties" : { - "differenceType" : { - "type" : "string", - "description" : "The type of difference" - }, - "difference" : { - "type" : "string", - "description" : "Description of the difference" - } - } - }, - "DimensionsDTO" : { - "type" : "object", - "properties" : { - "width" : { - "type" : "number", - "format" : "double", - "description" : "The width of the label in pixels when at a 1:1 scale." - }, - "height" : { - "type" : "number", - "format" : "double", - "description" : "The height of the label in pixels when at a 1:1 scale." - } - } - }, - "DocumentedTypeDTO" : { - "type" : "object", - "properties" : { - "type" : { - "type" : "string", - "description" : "The fully qualified name of the type." - }, - "bundle" : { - "description" : "The details of the artifact that bundled this type.", - "$ref" : "#/definitions/BundleDTO" - }, - "controllerServiceApis" : { - "type" : "array", - "description" : "If this type represents a ControllerService, this lists the APIs it implements.", - "items" : { - "$ref" : "#/definitions/ControllerServiceApiDTO" - } - }, - "description" : { - "type" : "string", - "description" : "The description of the type." - }, - "restricted" : { - "type" : "boolean", - "description" : "Whether this type is restricted." - }, - "usageRestriction" : { - "type" : "string", - "description" : "The optional description of why the usage of this component is restricted." - }, - "explicitRestrictions" : { - "type" : "array", - "description" : "An optional collection of explicit restrictions. If specified, these explicit restrictions will be enfored.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ExplicitRestrictionDTO" - } - }, - "deprecationReason" : { - "type" : "string", - "description" : "The description of why the usage of this component is restricted." - }, - "tags" : { - "type" : "array", - "description" : "The tags associated with this type.", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - } - } - }, - "DropRequestDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id for this drop request." - }, - "uri" : { - "type" : "string", - "description" : "The URI for future requests to this drop request." - }, - "submissionTime" : { - "type" : "string", - "description" : "The timestamp when the query was submitted." - }, - "lastUpdated" : { - "type" : "string", - "description" : "The last time this drop request was updated." - }, - "percentCompleted" : { - "type" : "integer", - "format" : "int32", - "description" : "The current percent complete." - }, - "finished" : { - "type" : "boolean", - "description" : "Whether the query has finished." - }, - "failureReason" : { - "type" : "string", - "description" : "The reason, if any, that this drop request failed." - }, - "currentCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of flow files currently queued." - }, - "currentSize" : { - "type" : "integer", - "format" : "int64", - "description" : "The size of flow files currently queued in bytes." - }, - "current" : { - "type" : "string", - "description" : "The count and size of flow files currently queued." - }, - "originalCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of flow files to be dropped as a result of this request." - }, - "originalSize" : { - "type" : "integer", - "format" : "int64", - "description" : "The size of flow files to be dropped as a result of this request in bytes." - }, - "original" : { - "type" : "string", - "description" : "The count and size of flow files to be dropped as a result of this request." - }, - "droppedCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of flow files that have been dropped thus far." - }, - "droppedSize" : { - "type" : "integer", - "format" : "int64", - "description" : "The size of flow files that have been dropped thus far in bytes." - }, - "dropped" : { - "type" : "string", - "description" : "The count and size of flow files that have been dropped thus far." - }, - "state" : { - "type" : "string", - "description" : "The current state of the drop request." - } - } - }, - "DropRequestEntity" : { - "type" : "object", - "properties" : { - "dropRequest" : { - "$ref" : "#/definitions/DropRequestDTO" - } - }, - "xml" : { - "name" : "dropRequestEntity" - } - }, - "ExplicitRestrictionDTO" : { - "type" : "object", - "properties" : { - "requiredPermission" : { - "description" : "The required permission necessary for this restriction.", - "$ref" : "#/definitions/RequiredPermissionDTO" - }, - "explanation" : { - "type" : "string", - "description" : "The description of why the usage of this component is restricted for this required permission." - } - } - }, - "ExternalControllerServiceReference" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The identifier of the controller service" - }, - "name" : { - "type" : "string", - "description" : "The name of the controller service" - } - } - }, - "FlowBreadcrumbDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the group." - }, - "name" : { - "type" : "string", - "description" : "The id of the group." - }, - "versionControlInformation" : { - "description" : "The process group version control information or null if not version controlled.", - "$ref" : "#/definitions/VersionControlInformationDTO" - } - } - }, - "FlowBreadcrumbEntity" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of this ancestor ProcessGroup." - }, - "permissions" : { - "description" : "The permissions for this ancestor ProcessGroup.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "versionedFlowState" : { - "type" : "string", - "description" : "The current state of the Process Group, as it relates to the Versioned Flow", - "readOnly" : true, - "enum" : [ "LOCALLY_MODIFIED", "STALE", "LOCALLY_MODIFIED_AND_STALE", "UP_TO_DATE", "SYNC_FAILURE" ] - }, - "breadcrumb" : { - "description" : "This breadcrumb.", - "$ref" : "#/definitions/FlowBreadcrumbDTO" - }, - "parentBreadcrumb" : { - "description" : "The parent breadcrumb for this breadcrumb.", - "$ref" : "#/definitions/FlowBreadcrumbEntity" - } - }, - "xml" : { - "name" : "flowEntity" - } - }, - "FlowComparisonEntity" : { - "type" : "object", - "properties" : { - "componentDifferences" : { - "type" : "array", - "description" : "The list of differences for each component in the flow that is not the same between the two flows", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ComponentDifferenceDTO" - } - } - }, - "xml" : { - "name" : "flowComparisonEntity" - } - }, - "FlowConfigurationDTO" : { - "type" : "object", - "properties" : { - "supportsManagedAuthorizer" : { - "type" : "boolean", - "description" : "Whether this NiFi supports a managed authorizer. Managed authorizers can visualize users, groups, and policies in the UI.", - "readOnly" : true - }, - "supportsConfigurableAuthorizer" : { - "type" : "boolean", - "description" : "Whether this NiFi supports a configurable authorizer.", - "readOnly" : true - }, - "supportsConfigurableUsersAndGroups" : { - "type" : "boolean", - "description" : "Whether this NiFi supports configurable users and groups.", - "readOnly" : true - }, - "autoRefreshIntervalSeconds" : { - "type" : "integer", - "format" : "int64", - "description" : "The interval in seconds between the automatic NiFi refresh requests.", - "readOnly" : true - }, - "currentTime" : { - "type" : "string", - "description" : "The current time on the system." - }, - "timeOffset" : { - "type" : "integer", - "format" : "int32", - "description" : "The time offset of the system." - }, - "defaultBackPressureObjectThreshold" : { - "type" : "integer", - "format" : "int64", - "description" : "The default back pressure object threshold." - }, - "defaultBackPressureDataSizeThreshold" : { - "type" : "string", - "description" : "The default back pressure data size threshold." - } - } - }, - "FlowConfigurationEntity" : { - "type" : "object", - "properties" : { - "flowConfiguration" : { - "description" : "The controller configuration.", - "$ref" : "#/definitions/FlowConfigurationDTO" - } - }, - "xml" : { - "name" : "flowConfigurationEntity" - } - }, - "FlowDTO" : { - "type" : "object", - "properties" : { - "processGroups" : { - "type" : "array", - "description" : "The process groups in this flow.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ProcessGroupEntity" - } - }, - "remoteProcessGroups" : { - "type" : "array", - "description" : "The remote process groups in this flow.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/RemoteProcessGroupEntity" - } - }, - "processors" : { - "type" : "array", - "description" : "The processors in this flow.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ProcessorEntity" - } - }, - "inputPorts" : { - "type" : "array", - "description" : "The input ports in this flow.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/PortEntity" - } - }, - "outputPorts" : { - "type" : "array", - "description" : "The output ports in this flow.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/PortEntity" - } - }, - "connections" : { - "type" : "array", - "description" : "The connections in this flow.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ConnectionEntity" - } - }, - "labels" : { - "type" : "array", - "description" : "The labels in this flow.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/LabelEntity" - } - }, - "funnels" : { - "type" : "array", - "description" : "The funnels in this flow.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/FunnelEntity" - } - } - } - }, - "FlowEntity" : { - "type" : "object", - "properties" : { - "flow" : { - "$ref" : "#/definitions/FlowDTO" - } - }, - "xml" : { - "name" : "flowEntity" - } - }, - "FlowFileDTO" : { - "type" : "object", - "properties" : { - "uri" : { - "type" : "string", - "description" : "The URI that can be used to access this FlowFile." - }, - "uuid" : { - "type" : "string", - "description" : "The FlowFile UUID." - }, - "filename" : { - "type" : "string", - "description" : "The FlowFile filename." - }, - "position" : { - "type" : "integer", - "format" : "int32", - "description" : "The FlowFile's position in the queue." - }, - "size" : { - "type" : "integer", - "format" : "int64", - "description" : "The FlowFile file size." - }, - "queuedDuration" : { - "type" : "integer", - "format" : "int64", - "description" : "How long this FlowFile has been enqueued." - }, - "lineageDuration" : { - "type" : "integer", - "format" : "int64", - "description" : "Duration since the FlowFile's greatest ancestor entered the flow." - }, - "penaltyExpiresIn" : { - "type" : "integer", - "format" : "int64", - "description" : "How long in milliseconds until the FlowFile penalty expires." - }, - "clusterNodeId" : { - "type" : "string", - "description" : "The id of the node where this FlowFile resides." - }, - "clusterNodeAddress" : { - "type" : "string", - "description" : "The label for the node where this FlowFile resides." - }, - "attributes" : { - "type" : "object", - "description" : "The FlowFile attributes.", - "additionalProperties" : { - "type" : "string" - } - }, - "contentClaimSection" : { - "type" : "string", - "description" : "The section in which the content claim lives." - }, - "contentClaimContainer" : { - "type" : "string", - "description" : "The container in which the content claim lives." - }, - "contentClaimIdentifier" : { - "type" : "string", - "description" : "The identifier of the content claim." - }, - "contentClaimOffset" : { - "type" : "integer", - "format" : "int64", - "description" : "The offset into the content claim where the flowfile's content begins." - }, - "contentClaimFileSize" : { - "type" : "string", - "description" : "The file size of the content claim formatted." - }, - "contentClaimFileSizeBytes" : { - "type" : "integer", - "format" : "int64", - "description" : "The file size of the content claim in bytes." - }, - "penalized" : { - "type" : "boolean", - "description" : "If the FlowFile is penalized." - } - } - }, - "FlowFileEntity" : { - "type" : "object", - "properties" : { - "flowFile" : { - "$ref" : "#/definitions/FlowFileDTO" - } - }, - "xml" : { - "name" : "flowFileEntity" - } - }, - "FlowFileSummaryDTO" : { - "type" : "object", - "properties" : { - "uri" : { - "type" : "string", - "description" : "The URI that can be used to access this FlowFile." - }, - "uuid" : { - "type" : "string", - "description" : "The FlowFile UUID." - }, - "filename" : { - "type" : "string", - "description" : "The FlowFile filename." - }, - "position" : { - "type" : "integer", - "format" : "int32", - "description" : "The FlowFile's position in the queue." - }, - "size" : { - "type" : "integer", - "format" : "int64", - "description" : "The FlowFile file size." - }, - "queuedDuration" : { - "type" : "integer", - "format" : "int64", - "description" : "How long this FlowFile has been enqueued." - }, - "lineageDuration" : { - "type" : "integer", - "format" : "int64", - "description" : "Duration since the FlowFile's greatest ancestor entered the flow." - }, - "penaltyExpiresIn" : { - "type" : "integer", - "format" : "int64", - "description" : "How long in milliseconds until the FlowFile penalty expires." - }, - "clusterNodeId" : { - "type" : "string", - "description" : "The id of the node where this FlowFile resides." - }, - "clusterNodeAddress" : { - "type" : "string", - "description" : "The label for the node where this FlowFile resides." - }, - "penalized" : { - "type" : "boolean", - "description" : "If the FlowFile is penalized." - } - } - }, - "FlowSnippetDTO" : { - "type" : "object", - "properties" : { - "processGroups" : { - "type" : "array", - "description" : "The process groups in this flow snippet.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ProcessGroupDTO" - } - }, - "remoteProcessGroups" : { - "type" : "array", - "description" : "The remote process groups in this flow snippet.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/RemoteProcessGroupDTO" - } - }, - "processors" : { - "type" : "array", - "description" : "The processors in this flow snippet.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ProcessorDTO" - } - }, - "inputPorts" : { - "type" : "array", - "description" : "The input ports in this flow snippet.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/PortDTO" - } - }, - "outputPorts" : { - "type" : "array", - "description" : "The output ports in this flow snippet.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/PortDTO" - } - }, - "connections" : { - "type" : "array", - "description" : "The connections in this flow snippet.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ConnectionDTO" - } - }, - "labels" : { - "type" : "array", - "description" : "The labels in this flow snippet.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/LabelDTO" - } - }, - "funnels" : { - "type" : "array", - "description" : "The funnels in this flow snippet.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/FunnelDTO" - } - }, - "controllerServices" : { - "type" : "array", - "description" : "The controller services in this flow snippet.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ControllerServiceDTO" - } - } - } - }, - "FunnelDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "versionedComponentId" : { - "type" : "string", - "description" : "The ID of the corresponding component that is under version control" - }, - "parentGroupId" : { - "type" : "string", - "description" : "The id of parent process group of this component if applicable." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - } - } - }, - "FunnelEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "component" : { - "$ref" : "#/definitions/FunnelDTO" - } - }, - "xml" : { - "name" : "funnelEntity" - } - }, - "FunnelsEntity" : { - "type" : "object", - "properties" : { - "funnels" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/FunnelEntity" - } - } - }, - "xml" : { - "name" : "funnelsEntity" - } - }, - "GarbageCollectionDTO" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The name of the garbage collector." - }, - "collectionCount" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of times garbage collection has run." - }, - "collectionTime" : { - "type" : "string", - "description" : "The total amount of time spent garbage collecting." - }, - "collectionMillis" : { - "type" : "integer", - "format" : "int64", - "description" : "The total number of milliseconds spent garbage collecting." - } - } - }, - "HistoryDTO" : { - "type" : "object", - "properties" : { - "total" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of number of actions that matched the search criteria.." - }, - "lastRefreshed" : { - "type" : "string", - "description" : "The timestamp when the report was generated." - }, - "actions" : { - "type" : "array", - "description" : "The actions.", - "items" : { - "$ref" : "#/definitions/ActionEntity" - } - } - } - }, - "HistoryEntity" : { - "type" : "object", - "properties" : { - "history" : { - "$ref" : "#/definitions/HistoryDTO" - } - }, - "xml" : { - "name" : "historyEntity" - } - }, - "InputPortsEntity" : { - "type" : "object", - "properties" : { - "inputPorts" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/PortEntity" - } - } - }, - "xml" : { - "name" : "inputPortsEntity" - } - }, - "InstantiateTemplateRequestEntity" : { - "type" : "object", - "properties" : { - "originX" : { - "type" : "number", - "format" : "double", - "description" : "The x coordinate of the origin of the bounding box where the new components will be placed." - }, - "originY" : { - "type" : "number", - "format" : "double", - "description" : "The y coordinate of the origin of the bounding box where the new components will be placed." - }, - "templateId" : { - "type" : "string", - "description" : "The identifier of the template." - }, - "encodingVersion" : { - "type" : "string", - "description" : "The encoding version of the flow snippet. If not specified, this is automatically populated by the node receiving the user request. If the snippet is specified, the version will be the latest. If the snippet is not specified, the version will come from the underlying template. These details need to be replicated throughout the cluster to ensure consistency." - }, - "snippet" : { - "description" : "A flow snippet of the template contents. If not specified, this is automatically populated by the node receiving the user request. These details need to be replicated throughout the cluster to ensure consistency.", - "$ref" : "#/definitions/FlowSnippetDTO" - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - } - }, - "xml" : { - "name" : "instantiateTemplateRequestEntity" - } - }, - "JaxbLink" : { - "type" : "object", - "properties" : { - "href" : { - "type" : "string", - "format" : "uri", - "xml" : { - "attribute" : true - }, - "description" : "The href for the link" - }, - "params" : { - "type" : "object", - "description" : "The params for the link", - "additionalProperties" : { - "type" : "string" - } - } - } - }, - "LabelDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "versionedComponentId" : { - "type" : "string", - "description" : "The ID of the corresponding component that is under version control" - }, - "parentGroupId" : { - "type" : "string", - "description" : "The id of parent process group of this component if applicable." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "label" : { - "type" : "string", - "description" : "The text that appears in the label." - }, - "width" : { - "type" : "number", - "format" : "double", - "description" : "The width of the label in pixels when at a 1:1 scale." - }, - "height" : { - "type" : "number", - "format" : "double", - "description" : "The height of the label in pixels when at a 1:1 scale." - }, - "style" : { - "type" : "object", - "description" : "The styles for this label (font-size : 12px, background-color : #eee, etc).", - "additionalProperties" : { - "type" : "string" - } - } - } - }, - "LabelEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "dimensions" : { - "$ref" : "#/definitions/DimensionsDTO" - }, - "component" : { - "$ref" : "#/definitions/LabelDTO" - } - }, - "xml" : { - "name" : "labelEntity" - } - }, - "LabelsEntity" : { - "type" : "object", - "properties" : { - "labels" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/LabelEntity" - } - } - }, - "xml" : { - "name" : "labelsEntity" - } - }, - "LineageDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of this lineage query." - }, - "uri" : { - "type" : "string", - "description" : "The URI for this lineage query for later retrieval and deletion." - }, - "submissionTime" : { - "type" : "string", - "description" : "When the lineage query was submitted." - }, - "expiration" : { - "type" : "string", - "description" : "When the lineage query will expire." - }, - "percentCompleted" : { - "type" : "integer", - "format" : "int32", - "description" : "The percent complete for the lineage query." - }, - "finished" : { - "type" : "boolean", - "description" : "Whether the lineage query has finished." - }, - "request" : { - "description" : "The initial lineage result.", - "$ref" : "#/definitions/LineageRequestDTO" - }, - "results" : { - "description" : "The results of the lineage query.", - "$ref" : "#/definitions/LineageResultsDTO" - } - } - }, - "LineageEntity" : { - "type" : "object", - "properties" : { - "lineage" : { - "$ref" : "#/definitions/LineageDTO" - } - }, - "xml" : { - "name" : "lineageEntity" - } - }, - "LineageRequestDTO" : { - "type" : "object", - "properties" : { - "eventId" : { - "type" : "integer", - "format" : "int64", - "description" : "The event id that was used to generate this lineage, if applicable. The event id is allowed for any type of lineageRequestType. If the lineageRequestType is FLOWFILE and the flowfile uuid is also included in the request, the event id will be ignored." - }, - "lineageRequestType" : { - "type" : "string", - "description" : "The type of lineage request. PARENTS will return the lineage for the flowfiles that are parents of the specified event. CHILDREN will return the lineage for the flowfiles that are children of the specified event. FLOWFILE will return the lineage for the specified flowfile.", - "enum" : [ "PARENTS", "CHILDREN", "and FLOWFILE" ] - }, - "uuid" : { - "type" : "string", - "description" : "The flowfile uuid that was used to generate the lineage. The flowfile uuid is only allowed when the lineageRequestType is FLOWFILE and will take precedence over event id." - }, - "clusterNodeId" : { - "type" : "string", - "description" : "The id of the node where this lineage originated if clustered." - } - } - }, - "LineageResultsDTO" : { - "type" : "object", - "properties" : { - "errors" : { - "type" : "array", - "description" : "Any errors that occurred while generating the lineage.", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - }, - "nodes" : { - "type" : "array", - "description" : "The nodes in the lineage.", - "items" : { - "$ref" : "#/definitions/ProvenanceNodeDTO" - } - }, - "links" : { - "type" : "array", - "description" : "The links between the nodes in the lineage.", - "items" : { - "$ref" : "#/definitions/ProvenanceLinkDTO" - } - } - } - }, - "ListingRequestDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id for this listing request." - }, - "uri" : { - "type" : "string", - "description" : "The URI for future requests to this listing request." - }, - "submissionTime" : { - "type" : "string", - "description" : "The timestamp when the query was submitted." - }, - "lastUpdated" : { - "type" : "string", - "description" : "The last time this listing request was updated." - }, - "percentCompleted" : { - "type" : "integer", - "format" : "int32", - "description" : "The current percent complete." - }, - "finished" : { - "type" : "boolean", - "description" : "Whether the query has finished." - }, - "failureReason" : { - "type" : "string", - "description" : "The reason, if any, that this listing request failed." - }, - "maxResults" : { - "type" : "integer", - "format" : "int32", - "description" : "The maximum number of FlowFileSummary objects to return" - }, - "state" : { - "type" : "string", - "description" : "The current state of the listing request." - }, - "queueSize" : { - "description" : "The size of the queue", - "$ref" : "#/definitions/QueueSizeDTO" - }, - "flowFileSummaries" : { - "type" : "array", - "description" : "The FlowFile summaries. The summaries will be populated once the request has completed.", - "items" : { - "$ref" : "#/definitions/FlowFileSummaryDTO" - } - }, - "destinationRunning" : { - "type" : "boolean", - "description" : "Whether the destination of the connection is running" - }, - "sourceRunning" : { - "type" : "boolean", - "description" : "Whether the source of the connection is running" - } - } - }, - "ListingRequestEntity" : { - "type" : "object", - "properties" : { - "listingRequest" : { - "$ref" : "#/definitions/ListingRequestDTO" - } - }, - "xml" : { - "name" : "listingRequestEntity" - } - }, - "NodeConnectionStatisticsSnapshotDTO" : { - "type" : "object", - "properties" : { - "nodeId" : { - "type" : "string", - "description" : "The unique ID that identifies the node" - }, - "address" : { - "type" : "string", - "description" : "The API address of the node" - }, - "apiPort" : { - "type" : "integer", - "format" : "int32", - "description" : "The API port used to communicate with the node" - }, - "statisticsSnapshot" : { - "description" : "The connection status snapshot from the node.", - "$ref" : "#/definitions/ConnectionStatisticsSnapshotDTO" - } - } - }, - "NodeConnectionStatusSnapshotDTO" : { - "type" : "object", - "properties" : { - "nodeId" : { - "type" : "string", - "description" : "The unique ID that identifies the node" - }, - "address" : { - "type" : "string", - "description" : "The API address of the node" - }, - "apiPort" : { - "type" : "integer", - "format" : "int32", - "description" : "The API port used to communicate with the node" - }, - "statusSnapshot" : { - "description" : "The connection status snapshot from the node.", - "$ref" : "#/definitions/ConnectionStatusSnapshotDTO" - } - } - }, - "NodeCountersSnapshotDTO" : { - "type" : "object", - "properties" : { - "nodeId" : { - "type" : "string", - "description" : "The unique ID that identifies the node" - }, - "address" : { - "type" : "string", - "description" : "The API address of the node" - }, - "apiPort" : { - "type" : "integer", - "format" : "int32", - "description" : "The API port used to communicate with the node" - }, - "snapshot" : { - "description" : "The counters from the node.", - "$ref" : "#/definitions/CountersSnapshotDTO" - } - } - }, - "NodeDTO" : { - "type" : "object", - "properties" : { - "nodeId" : { - "type" : "string", - "description" : "The id of the node.", - "readOnly" : true - }, - "address" : { - "type" : "string", - "description" : "The node's host/ip address.", - "readOnly" : true - }, - "apiPort" : { - "type" : "integer", - "format" : "int32", - "description" : "The port the node is listening for API requests.", - "readOnly" : true - }, - "status" : { - "type" : "string", - "description" : "The node's status." - }, - "heartbeat" : { - "type" : "string", - "description" : "the time of the nodes's last heartbeat.", - "readOnly" : true - }, - "connectionRequested" : { - "type" : "string", - "description" : "The time of the node's last connection request.", - "readOnly" : true - }, - "roles" : { - "type" : "array", - "description" : "The roles of this node.", - "readOnly" : true, - "uniqueItems" : true, - "items" : { - "type" : "string" - } - }, - "activeThreadCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The active threads for the NiFi on the node.", - "readOnly" : true - }, - "queued" : { - "type" : "string", - "description" : "The queue the NiFi on the node.", - "readOnly" : true - }, - "events" : { - "type" : "array", - "description" : "The node's events.", - "readOnly" : true, - "items" : { - "$ref" : "#/definitions/NodeEventDTO" - } - }, - "nodeStartTime" : { - "type" : "string", - "description" : "The time at which this Node was last refreshed.", - "readOnly" : true - } - } - }, - "NodeEntity" : { - "type" : "object", - "properties" : { - "node" : { - "$ref" : "#/definitions/NodeDTO" - } - }, - "xml" : { - "name" : "nodeEntity" - } - }, - "NodeEventDTO" : { - "type" : "object", - "properties" : { - "timestamp" : { - "type" : "string", - "description" : "The timestamp of the node event." - }, - "category" : { - "type" : "string", - "description" : "The category of the node event." - }, - "message" : { - "type" : "string", - "description" : "The message in the node event." - } - } - }, - "NodePortStatusSnapshotDTO" : { - "type" : "object", - "properties" : { - "nodeId" : { - "type" : "string", - "description" : "The unique ID that identifies the node" - }, - "address" : { - "type" : "string", - "description" : "The API address of the node" - }, - "apiPort" : { - "type" : "integer", - "format" : "int32", - "description" : "The API port used to communicate with the node" - }, - "statusSnapshot" : { - "description" : "The port status snapshot from the node.", - "$ref" : "#/definitions/PortStatusSnapshotDTO" - } - } - }, - "NodeProcessGroupStatusSnapshotDTO" : { - "type" : "object", - "properties" : { - "nodeId" : { - "type" : "string", - "description" : "The unique ID that identifies the node" - }, - "address" : { - "type" : "string", - "description" : "The API address of the node" - }, - "apiPort" : { - "type" : "integer", - "format" : "int32", - "description" : "The API port used to communicate with the node" - }, - "statusSnapshot" : { - "description" : "The process group status snapshot from the node.", - "$ref" : "#/definitions/ProcessGroupStatusSnapshotDTO" - } - } - }, - "NodeProcessorStatusSnapshotDTO" : { - "type" : "object", - "properties" : { - "nodeId" : { - "type" : "string", - "description" : "The unique ID that identifies the node" - }, - "address" : { - "type" : "string", - "description" : "The API address of the node" - }, - "apiPort" : { - "type" : "integer", - "format" : "int32", - "description" : "The API port used to communicate with the node" - }, - "statusSnapshot" : { - "description" : "The processor status snapshot from the node.", - "$ref" : "#/definitions/ProcessorStatusSnapshotDTO" - } - } - }, - "NodeRemoteProcessGroupStatusSnapshotDTO" : { - "type" : "object", - "properties" : { - "nodeId" : { - "type" : "string", - "description" : "The unique ID that identifies the node" - }, - "address" : { - "type" : "string", - "description" : "The API address of the node" - }, - "apiPort" : { - "type" : "integer", - "format" : "int32", - "description" : "The API port used to communicate with the node" - }, - "statusSnapshot" : { - "description" : "The remote process group status snapshot from the node.", - "$ref" : "#/definitions/RemoteProcessGroupStatusSnapshotDTO" - } - } - }, - "NodeSearchResultDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the node that matched the search." - }, - "address" : { - "type" : "string", - "description" : "The address of the node that matched the search." - } - } - }, - "NodeStatusSnapshotsDTO" : { - "type" : "object", - "properties" : { - "nodeId" : { - "type" : "string", - "description" : "The id of the node." - }, - "address" : { - "type" : "string", - "description" : "The node's host/ip address." - }, - "apiPort" : { - "type" : "integer", - "format" : "int32", - "description" : "The port the node is listening for API requests." - }, - "statusSnapshots" : { - "type" : "array", - "description" : "A list of StatusSnapshotDTO objects that provide the actual metric values for the component for this node.", - "items" : { - "$ref" : "#/definitions/StatusSnapshotDTO" - } - } - } - }, - "NodeSystemDiagnosticsSnapshotDTO" : { - "type" : "object", - "properties" : { - "nodeId" : { - "type" : "string", - "description" : "The unique ID that identifies the node" - }, - "address" : { - "type" : "string", - "description" : "The API address of the node" - }, - "apiPort" : { - "type" : "integer", - "format" : "int32", - "description" : "The API port used to communicate with the node" - }, - "snapshot" : { - "description" : "The System Diagnostics snapshot from the node.", - "$ref" : "#/definitions/SystemDiagnosticsSnapshotDTO" - } - } - }, - "OutputPortsEntity" : { - "type" : "object", - "properties" : { - "outputPorts" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/PortEntity" - } - } - }, - "xml" : { - "name" : "outputPortsEntity" - } - }, - "ParameterContextDTO" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The Name of the Parameter Context." - }, - "description" : { - "type" : "string", - "description" : "The Description of the Parameter Context." - }, - "parameters" : { - "type" : "array", - "description" : "The Parameters for the Parameter Context", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ParameterEntity" - } - }, - "boundProcessGroups" : { - "type" : "array", - "description" : "The Process Groups that are bound to this Parameter Context", - "readOnly" : true, - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ProcessGroupEntity" - } - }, - "id" : { - "type" : "string", - "description" : "The ID the Parameter Context.", - "readOnly" : true - } - } - }, - "ParameterContextEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "component" : { - "description" : "The Parameter Context", - "$ref" : "#/definitions/ParameterContextDTO" - } - }, - "xml" : { - "name" : "parameterContextEntity" - } - }, - "ParameterContextReferenceDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The ID of the Parameter Context" - }, - "name" : { - "type" : "string", - "description" : "The name of the Parameter Context" - } - } - }, - "ParameterContextReferenceEntity" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "component" : { - "$ref" : "#/definitions/ParameterContextReferenceDTO" - } - }, - "xml" : { - "name" : "parameterContextReferenceEntity" - } - }, - "ParameterContextUpdateRequestDTO" : { - "type" : "object", - "properties" : { - "requestId" : { - "type" : "string", - "description" : "The ID of the request", - "readOnly" : true - }, - "uri" : { - "type" : "string", - "description" : "The URI for the request", - "readOnly" : true - }, - "submissionTime" : { - "type" : "string", - "format" : "date-time", - "description" : "The timestamp of when the request was submitted", - "readOnly" : true - }, - "lastUpdated" : { - "type" : "string", - "format" : "date-time", - "description" : "The timestamp of when the request was last updated", - "readOnly" : true - }, - "complete" : { - "type" : "boolean", - "description" : "Whether or not the request is completed", - "readOnly" : true - }, - "failureReason" : { - "type" : "string", - "description" : "The reason for the request failing, or null if the request has not failed", - "readOnly" : true - }, - "percentCompleted" : { - "type" : "integer", - "format" : "int32", - "description" : "A value between 0 and 100 (inclusive) indicating how close the request is to completion", - "readOnly" : true - }, - "state" : { - "type" : "string", - "description" : "A description of the current state of the request", - "readOnly" : true - }, - "updateSteps" : { - "type" : "array", - "description" : "The steps that are required in order to complete the request, along with the status of each", - "readOnly" : true, - "items" : { - "$ref" : "#/definitions/ParameterContextUpdateStepDTO" - } - }, - "parameterContext" : { - "description" : "The Parameter Context that is being operated on. This may not be populated until the request has successfully completed.", - "readOnly" : true, - "$ref" : "#/definitions/ParameterContextDTO" - }, - "referencingComponents" : { - "type" : "array", - "description" : "The components that are referenced by the update.", - "readOnly" : true, - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/AffectedComponentEntity" - } - } - } - }, - "ParameterContextUpdateRequestEntity" : { - "type" : "object", - "properties" : { - "parameterContextRevision" : { - "description" : "The Revision of the Parameter Context", - "$ref" : "#/definitions/RevisionDTO" - }, - "request" : { - "description" : "The Update Request", - "$ref" : "#/definitions/ParameterContextUpdateRequestDTO" - } - }, - "xml" : { - "name" : "parameterContextUpdateRequestEntity" - } - }, - "ParameterContextUpdateStepDTO" : { - "type" : "object", - "properties" : { - "description" : { - "type" : "string", - "description" : "Explanation of what happens in this step", - "readOnly" : true - }, - "complete" : { - "type" : "boolean", - "description" : "Whether or not this step has completed", - "readOnly" : true - }, - "failureReason" : { - "type" : "string", - "description" : "An explanation of why this step failed, or null if this step did not fail", - "readOnly" : true - } - } - }, - "ParameterContextValidationRequestDTO" : { - "type" : "object", - "properties" : { - "requestId" : { - "type" : "string", - "description" : "The ID of the request", - "readOnly" : true - }, - "uri" : { - "type" : "string", - "description" : "The URI for the request", - "readOnly" : true - }, - "submissionTime" : { - "type" : "string", - "format" : "date-time", - "description" : "The timestamp of when the request was submitted", - "readOnly" : true - }, - "lastUpdated" : { - "type" : "string", - "format" : "date-time", - "description" : "The timestamp of when the request was last updated", - "readOnly" : true - }, - "complete" : { - "type" : "boolean", - "description" : "Whether or not the request is completed", - "readOnly" : true - }, - "failureReason" : { - "type" : "string", - "description" : "The reason for the request failing, or null if the request has not failed", - "readOnly" : true - }, - "percentCompleted" : { - "type" : "integer", - "format" : "int32", - "description" : "A value between 0 and 100 (inclusive) indicating how close the request is to completion", - "readOnly" : true - }, - "state" : { - "type" : "string", - "description" : "A description of the current state of the request", - "readOnly" : true - }, - "updateSteps" : { - "type" : "array", - "description" : "The steps that are required in order to complete the request, along with the status of each", - "readOnly" : true, - "items" : { - "$ref" : "#/definitions/ParameterContextValidationStepDTO" - } - }, - "parameterContext" : { - "description" : "The Parameter Context that is being operated on.", - "$ref" : "#/definitions/ParameterContextDTO" - }, - "componentValidationResults" : { - "description" : "The Validation Results that were calculated for each component. This value may not be set until the request completes.", - "readOnly" : true, - "$ref" : "#/definitions/ComponentValidationResultsEntity" - } - } - }, - "ParameterContextValidationRequestEntity" : { - "type" : "object", - "properties" : { - "request" : { - "description" : "The Update Request", - "$ref" : "#/definitions/ParameterContextValidationRequestDTO" - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - } - }, - "xml" : { - "name" : "parameterContextValidationRequestEntity" - } - }, - "ParameterContextValidationStepDTO" : { - "type" : "object", - "properties" : { - "description" : { - "type" : "string", - "description" : "Explanation of what happens in this step", - "readOnly" : true - }, - "complete" : { - "type" : "boolean", - "description" : "Whether or not this step has completed", - "readOnly" : true - }, - "failureReason" : { - "type" : "string", - "description" : "An explanation of why this step failed, or null if this step did not fail", - "readOnly" : true - } - } - }, - "ParameterContextsEntity" : { - "type" : "object", - "properties" : { - "parameterContexts" : { - "type" : "array", - "description" : "The Parameter Contexts", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ParameterContextEntity" - } - }, - "currentTime" : { - "type" : "string", - "description" : "The current time on the system.", - "readOnly" : true - } - }, - "xml" : { - "name" : "parameterContexts" - } - }, - "ParameterDTO" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The name of the Parameter" - }, - "description" : { - "type" : "string", - "description" : "The description of the Parameter" - }, - "sensitive" : { - "type" : "boolean", - "description" : "Whether or not the Parameter is sensitive" - }, - "value" : { - "type" : "string", - "description" : "The value of the Parameter" - }, - "referencingComponents" : { - "type" : "array", - "description" : "The set of all components in the flow that are referencing this Parameter", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/AffectedComponentEntity" - } - } - } - }, - "ParameterEntity" : { - "type" : "object", - "properties" : { - "canWrite" : { - "type" : "boolean", - "description" : "Indicates whether the user can write a given resource.", - "readOnly" : true - }, - "parameter" : { - "description" : "The parameter information", - "$ref" : "#/definitions/ParameterDTO" - } - }, - "xml" : { - "name" : "parameterEntity" - } - }, - "PeerDTO" : { - "type" : "object", - "properties" : { - "hostname" : { - "type" : "string", - "description" : "The hostname of this peer." - }, - "port" : { - "type" : "integer", - "format" : "int32", - "description" : "The port number of this peer." - }, - "secure" : { - "type" : "boolean", - "description" : "Returns if this peer connection is secure." - }, - "flowFileCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of flowFiles this peer holds." - } - } - }, - "PeersEntity" : { - "type" : "object", - "properties" : { - "peers" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/PeerDTO" - } - } - }, - "xml" : { - "name" : "peersEntity" - } - }, - "Permissions" : { - "type" : "object", - "properties" : { - "canRead" : { - "type" : "boolean", - "description" : "Indicates whether the user can read a given resource.", - "readOnly" : true - }, - "canWrite" : { - "type" : "boolean", - "description" : "Indicates whether the user can write a given resource.", - "readOnly" : true - }, - "canDelete" : { - "type" : "boolean", - "description" : "Indicates whether the user can delete a given resource.", - "readOnly" : true - } - } - }, - "PermissionsDTO" : { - "type" : "object", - "properties" : { - "canRead" : { - "type" : "boolean", - "description" : "Indicates whether the user can read a given resource.", - "readOnly" : true - }, - "canWrite" : { - "type" : "boolean", - "description" : "Indicates whether the user can write a given resource.", - "readOnly" : true - } - } - }, - "PortDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "versionedComponentId" : { - "type" : "string", - "description" : "The ID of the corresponding component that is under version control" - }, - "parentGroupId" : { - "type" : "string", - "description" : "The id of parent process group of this component if applicable." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "name" : { - "type" : "string", - "description" : "The name of the port." - }, - "comments" : { - "type" : "string", - "description" : "The comments for the port." - }, - "state" : { - "type" : "string", - "description" : "The state of the port.", - "enum" : [ "RUNNING", "STOPPED", "DISABLED" ] - }, - "type" : { - "type" : "string", - "description" : "The type of port.", - "enum" : [ "INPUT_PORT", "OUTPUT_PORT" ] - }, - "transmitting" : { - "type" : "boolean", - "description" : "Whether the port has incoming or output connections to a remote NiFi. This is only applicable when the port is allowed to be accessed remotely." - }, - "concurrentlySchedulableTaskCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of tasks that should be concurrently scheduled for the port." - }, - "userAccessControl" : { - "type" : "array", - "description" : "The users that are allowed to access the port.", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - }, - "groupAccessControl" : { - "type" : "array", - "description" : "The user groups that are allowed to access the port.", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - }, - "allowRemoteAccess" : { - "type" : "boolean", - "description" : "Whether this port can be accessed remotely via Site-to-Site protocol." - }, - "validationErrors" : { - "type" : "array", - "description" : "Gets the validation errors from this port. These validation errors represent the problems with the port that must be resolved before it can be started.", - "items" : { - "type" : "string" - } - } - } - }, - "PortEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "component" : { - "$ref" : "#/definitions/PortDTO" - }, - "status" : { - "description" : "The status of the port.", - "$ref" : "#/definitions/PortStatusDTO" - }, - "portType" : { - "type" : "string" - }, - "operatePermissions" : { - "description" : "The permissions for this component operations.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "allowRemoteAccess" : { - "type" : "boolean", - "description" : "Whether this port can be accessed remotely via Site-to-Site protocol." - } - }, - "xml" : { - "name" : "portEntity" - } - }, - "PortRunStatusEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "state" : { - "type" : "string", - "description" : "The run status of the Port.", - "enum" : [ "RUNNING", "STOPPED", "DISABLED" ] - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - } - }, - "xml" : { - "name" : "entity" - } - }, - "PortStatusDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the port." - }, - "groupId" : { - "type" : "string", - "description" : "The id of the parent process group of the port." - }, - "name" : { - "type" : "string", - "description" : "The name of the port." - }, - "transmitting" : { - "type" : "boolean", - "description" : "Whether the port has incoming or outgoing connections to a remote NiFi." - }, - "runStatus" : { - "type" : "string", - "description" : "The run status of the port.", - "enum" : [ "Running", "Stopped", "Validating", "Disabled", "Invalid" ] - }, - "statsLastRefreshed" : { - "type" : "string", - "description" : "The time the status for the process group was last refreshed." - }, - "aggregateSnapshot" : { - "description" : "A status snapshot that represents the aggregate stats of all nodes in the cluster. If the NiFi instance is a standalone instance, rather than a cluster, this represents the stats of the single instance.", - "$ref" : "#/definitions/PortStatusSnapshotDTO" - }, - "nodeSnapshots" : { - "type" : "array", - "description" : "A status snapshot for each node in the cluster. If the NiFi instance is a standalone instance, rather than a cluster, this may be null.", - "items" : { - "$ref" : "#/definitions/NodePortStatusSnapshotDTO" - } - } - } - }, - "PortStatusEntity" : { - "type" : "object", - "properties" : { - "portStatus" : { - "$ref" : "#/definitions/PortStatusDTO" - }, - "canRead" : { - "type" : "boolean", - "description" : "Indicates whether the user can read a given resource.", - "readOnly" : true - } - }, - "xml" : { - "name" : "portStatusEntity" - } - }, - "PortStatusSnapshotDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the port." - }, - "groupId" : { - "type" : "string", - "description" : "The id of the parent process group of the port." - }, - "name" : { - "type" : "string", - "description" : "The name of the port." - }, - "activeThreadCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The active thread count for the port." - }, - "flowFilesIn" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of FlowFiles that have been accepted in the last 5 minutes." - }, - "bytesIn" : { - "type" : "integer", - "format" : "int64", - "description" : "The size of hte FlowFiles that have been accepted in the last 5 minutes." - }, - "input" : { - "type" : "string", - "description" : "The count/size of flowfiles that have been accepted in the last 5 minutes." - }, - "flowFilesOut" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of FlowFiles that have been processed in the last 5 minutes." - }, - "bytesOut" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes that have been processed in the last 5 minutes." - }, - "output" : { - "type" : "string", - "description" : "The count/size of flowfiles that have been processed in the last 5 minutes." - }, - "transmitting" : { - "type" : "boolean", - "description" : "Whether the port has incoming or outgoing connections to a remote NiFi." - }, - "runStatus" : { - "type" : "string", - "description" : "The run status of the port.", - "enum" : [ "Running", "Stopped", "Validating", "Disabled", "Invalid" ] - } - } - }, - "PortStatusSnapshotEntity" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the port." - }, - "portStatusSnapshot" : { - "$ref" : "#/definitions/PortStatusSnapshotDTO" - }, - "canRead" : { - "type" : "boolean", - "description" : "Indicates whether the user can read a given resource.", - "readOnly" : true - } - }, - "xml" : { - "name" : "entity" - } - }, - "Position" : { - "type" : "object", - "properties" : { - "x" : { - "type" : "number", - "format" : "double", - "description" : "The x coordinate." - }, - "y" : { - "type" : "number", - "format" : "double", - "description" : "The y coordinate." - } - }, - "description" : "The position of a component on the graph" - }, - "PositionDTO" : { - "type" : "object", - "properties" : { - "x" : { - "type" : "number", - "format" : "double", - "description" : "The x coordinate." - }, - "y" : { - "type" : "number", - "format" : "double", - "description" : "The y coordinate." - } - } - }, - "PreviousValueDTO" : { - "type" : "object", - "properties" : { - "previousValue" : { - "type" : "string", - "description" : "The previous value." - }, - "timestamp" : { - "type" : "string", - "description" : "The timestamp when the value was modified." - }, - "userIdentity" : { - "type" : "string", - "description" : "The user who changed the previous value." - } - } - }, - "PrioritizerTypesEntity" : { - "type" : "object", - "properties" : { - "prioritizerTypes" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/DocumentedTypeDTO" - } - } - }, - "xml" : { - "name" : "prioritizerTypesEntity" - } - }, - "ProcessGroupDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "versionedComponentId" : { - "type" : "string", - "description" : "The ID of the corresponding component that is under version control" - }, - "parentGroupId" : { - "type" : "string", - "description" : "The id of parent process group of this component if applicable." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "name" : { - "type" : "string", - "description" : "The name of the process group." - }, - "comments" : { - "type" : "string", - "description" : "The comments for the process group." - }, - "variables" : { - "type" : "object", - "description" : "The variables that are configured for the Process Group. Note that this map contains only those variables that are defined on this Process Group and not any variables that are defined in the parent Process Group, etc. I.e., this Map will not contain all variables that are accessible by components in this Process Group by rather only the variables that are defined for this Process Group itself.", - "readOnly" : true, - "additionalProperties" : { - "type" : "string" - } - }, - "versionControlInformation" : { - "description" : "The Version Control information that indicates which Flow Registry, and where in the Flow Registry, this Process Group is tracking to; or null if this Process Group is not under version control", - "$ref" : "#/definitions/VersionControlInformationDTO" - }, - "parameterContext" : { - "description" : "The Parameter Context that this Process Group is bound to.", - "$ref" : "#/definitions/ParameterContextReferenceEntity" - }, - "flowfileConcurrency" : { - "type" : "string", - "description" : "The FlowFile Concurrency for this Process Group.", - "enum" : [ "UNBOUNDED", "SINGLE_FLOWFILE_PER_NODE" ] - }, - "flowfileOutboundPolicy" : { - "type" : "string", - "description" : "The Oubound Policy that is used for determining how FlowFiles should be transferred out of the Process Group.", - "enum" : [ "STREAM_WHEN_AVAILABLE", "BATCH_OUTPUT" ] - }, - "runningCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of running components in this process group." - }, - "stoppedCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of stopped components in the process group." - }, - "invalidCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of invalid components in the process group." - }, - "disabledCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of disabled components in the process group." - }, - "activeRemotePortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of active remote ports in the process group." - }, - "inactiveRemotePortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of inactive remote ports in the process group." - }, - "upToDateCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of up to date versioned process groups in the process group." - }, - "locallyModifiedCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of locally modified versioned process groups in the process group." - }, - "staleCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of stale versioned process groups in the process group." - }, - "locallyModifiedAndStaleCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of locally modified and stale versioned process groups in the process group." - }, - "syncFailureCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of versioned process groups in the process group that are unable to sync to a registry." - }, - "localInputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of local input ports in the process group." - }, - "localOutputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of local output ports in the process group." - }, - "publicInputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of public input ports in the process group." - }, - "publicOutputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of public output ports in the process group." - }, - "contents" : { - "description" : "The contents of this process group.", - "$ref" : "#/definitions/FlowSnippetDTO" - }, - "inputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of input ports in the process group.", - "readOnly" : true - }, - "outputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of output ports in the process group.", - "readOnly" : true - } - } - }, - "ProcessGroupEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "component" : { - "$ref" : "#/definitions/ProcessGroupDTO" - }, - "status" : { - "description" : "The status of the process group.", - "$ref" : "#/definitions/ProcessGroupStatusDTO" - }, - "versionedFlowSnapshot" : { - "description" : "Returns the Versioned Flow that describes the contents of the Versioned Flow to be imported", - "readOnly" : true, - "$ref" : "#/definitions/VersionedFlowSnapshot" - }, - "runningCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of running components in this process group." - }, - "stoppedCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of stopped components in the process group." - }, - "invalidCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of invalid components in the process group." - }, - "disabledCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of disabled components in the process group." - }, - "activeRemotePortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of active remote ports in the process group." - }, - "inactiveRemotePortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of inactive remote ports in the process group." - }, - "versionedFlowState" : { - "type" : "string", - "description" : "The current state of the Process Group, as it relates to the Versioned Flow", - "readOnly" : true, - "enum" : [ "LOCALLY_MODIFIED", "STALE", "LOCALLY_MODIFIED_AND_STALE", "UP_TO_DATE", "SYNC_FAILURE" ] - }, - "upToDateCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of up to date versioned process groups in the process group." - }, - "locallyModifiedCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of locally modified versioned process groups in the process group." - }, - "staleCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of stale versioned process groups in the process group." - }, - "locallyModifiedAndStaleCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of locally modified and stale versioned process groups in the process group." - }, - "syncFailureCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of versioned process groups in the process group that are unable to sync to a registry." - }, - "localInputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of local input ports in the process group." - }, - "localOutputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of local output ports in the process group." - }, - "publicInputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of public input ports in the process group." - }, - "publicOutputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of public output ports in the process group." - }, - "parameterContext" : { - "description" : "The Parameter Context, or null if no Parameter Context has been bound to the Process Group", - "$ref" : "#/definitions/ParameterContextReferenceEntity" - }, - "inputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of input ports in the process group.", - "readOnly" : true - }, - "outputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of output ports in the process group.", - "readOnly" : true - } - }, - "xml" : { - "name" : "processGroupEntity" - } - }, - "ProcessGroupFlowDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "parentGroupId" : { - "type" : "string", - "description" : "The id of parent process group of this component if applicable." - }, - "parameterContext" : { - "description" : "The Parameter Context, or null if no Parameter Context has been bound to the Process Group", - "$ref" : "#/definitions/ParameterContextReferenceEntity" - }, - "breadcrumb" : { - "description" : "The breadcrumb of the process group.", - "$ref" : "#/definitions/FlowBreadcrumbEntity" - }, - "flow" : { - "description" : "The flow structure starting at this Process Group.", - "$ref" : "#/definitions/FlowDTO" - }, - "lastRefreshed" : { - "type" : "string", - "description" : "The time the flow for the process group was last refreshed." - } - } - }, - "ProcessGroupFlowEntity" : { - "type" : "object", - "properties" : { - "permissions" : { - "description" : "The access policy for this process group.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "processGroupFlow" : { - "$ref" : "#/definitions/ProcessGroupFlowDTO" - } - }, - "xml" : { - "name" : "processGroupFlowEntity" - } - }, - "ProcessGroupImportEntity" : { - "type" : "object", - "properties" : { - "processGroupRevision" : { - "description" : "The Revision for the Process Group", - "$ref" : "#/definitions/RevisionDTO" - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "versionedFlowSnapshot" : { - "description" : "The Versioned Flow Snapshot to import", - "$ref" : "#/definitions/VersionedFlowSnapshot" - } - }, - "xml" : { - "name" : "processGroupImportEntity" - } - }, - "ProcessGroupNameDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The ID of the Process Group" - }, - "name" : { - "type" : "string", - "description" : "The name of the Process Group, or the ID of the Process Group if the user does not have the READ policy for the Process Group" - } - } - }, - "ProcessGroupReplaceRequestDTO" : { - "type" : "object", - "properties" : { - "requestId" : { - "type" : "string", - "description" : "The unique ID of this request.", - "readOnly" : true - }, - "processGroupId" : { - "type" : "string", - "description" : "The unique ID of the Process Group being updated" - }, - "uri" : { - "type" : "string", - "description" : "The URI for future requests to this drop request.", - "readOnly" : true - }, - "lastUpdated" : { - "type" : "string", - "description" : "The last time this request was updated.", - "readOnly" : true - }, - "complete" : { - "type" : "boolean", - "description" : "Whether or not this request has completed", - "readOnly" : true - }, - "failureReason" : { - "type" : "string", - "description" : "An explanation of why this request failed, or null if this request has not failed", - "readOnly" : true - }, - "percentCompleted" : { - "type" : "integer", - "format" : "int32", - "description" : "The percentage complete for the request, between 0 and 100", - "readOnly" : true - }, - "state" : { - "type" : "string", - "description" : "The state of the request", - "readOnly" : true - } - } - }, - "ProcessGroupReplaceRequestEntity" : { - "type" : "object", - "properties" : { - "processGroupRevision" : { - "description" : "The revision for the Process Group being updated.", - "$ref" : "#/definitions/RevisionDTO" - }, - "request" : { - "description" : "The Process Group Change Request", - "$ref" : "#/definitions/ProcessGroupReplaceRequestDTO" - }, - "versionedFlowSnapshot" : { - "description" : "Returns the Versioned Flow to replace with", - "readOnly" : true, - "$ref" : "#/definitions/VersionedFlowSnapshot" - } - }, - "xml" : { - "name" : "processGroupReplaceRequestEntity" - } - }, - "ProcessGroupStatusDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The ID of the Process Group" - }, - "name" : { - "type" : "string", - "description" : "The name of the Process Group" - }, - "statsLastRefreshed" : { - "type" : "string", - "description" : "The time the status for the process group was last refreshed." - }, - "aggregateSnapshot" : { - "description" : "The aggregate status of all nodes in the cluster", - "$ref" : "#/definitions/ProcessGroupStatusSnapshotDTO" - }, - "nodeSnapshots" : { - "type" : "array", - "description" : "The status reported by each node in the cluster. If the NiFi instance is a standalone instance, rather than a clustered instance, this value may be null.", - "items" : { - "$ref" : "#/definitions/NodeProcessGroupStatusSnapshotDTO" - } - } - } - }, - "ProcessGroupStatusEntity" : { - "type" : "object", - "properties" : { - "processGroupStatus" : { - "$ref" : "#/definitions/ProcessGroupStatusDTO" - }, - "canRead" : { - "type" : "boolean", - "description" : "Indicates whether the user can read a given resource.", - "readOnly" : true - } - }, - "xml" : { - "name" : "processGroupStatusEntity" - } - }, - "ProcessGroupStatusSnapshotDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the process group." - }, - "name" : { - "type" : "string", - "description" : "The name of this process group." - }, - "connectionStatusSnapshots" : { - "type" : "array", - "description" : "The status of all connections in the process group.", - "items" : { - "$ref" : "#/definitions/ConnectionStatusSnapshotEntity" - } - }, - "processorStatusSnapshots" : { - "type" : "array", - "description" : "The status of all processors in the process group.", - "items" : { - "$ref" : "#/definitions/ProcessorStatusSnapshotEntity" - } - }, - "processGroupStatusSnapshots" : { - "type" : "array", - "description" : "The status of all process groups in the process group.", - "items" : { - "$ref" : "#/definitions/ProcessGroupStatusSnapshotEntity" - } - }, - "remoteProcessGroupStatusSnapshots" : { - "type" : "array", - "description" : "The status of all remote process groups in the process group.", - "items" : { - "$ref" : "#/definitions/RemoteProcessGroupStatusSnapshotEntity" - } - }, - "inputPortStatusSnapshots" : { - "type" : "array", - "description" : "The status of all input ports in the process group.", - "items" : { - "$ref" : "#/definitions/PortStatusSnapshotEntity" - } - }, - "outputPortStatusSnapshots" : { - "type" : "array", - "description" : "The status of all output ports in the process group.", - "items" : { - "$ref" : "#/definitions/PortStatusSnapshotEntity" - } - }, - "versionedFlowState" : { - "type" : "string", - "description" : "The current state of the Process Group, as it relates to the Versioned Flow", - "readOnly" : true, - "enum" : [ "LOCALLY_MODIFIED", "STALE", "LOCALLY_MODIFIED_AND_STALE", "UP_TO_DATE", "SYNC_FAILURE" ] - }, - "flowFilesIn" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of FlowFiles that have come into this ProcessGroup in the last 5 minutes" - }, - "bytesIn" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes that have come into this ProcessGroup in the last 5 minutes" - }, - "input" : { - "type" : "string", - "description" : "The input count/size for the process group in the last 5 minutes (pretty printed)." - }, - "flowFilesQueued" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of FlowFiles that are queued up in this ProcessGroup right now" - }, - "bytesQueued" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes that are queued up in this ProcessGroup right now" - }, - "queued" : { - "type" : "string", - "description" : "The count/size that is queued in the the process group." - }, - "queuedCount" : { - "type" : "string", - "description" : "The count that is queued for the process group." - }, - "queuedSize" : { - "type" : "string", - "description" : "The size that is queued for the process group." - }, - "bytesRead" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes read by components in this ProcessGroup in the last 5 minutes" - }, - "read" : { - "type" : "string", - "description" : "The number of bytes read in the last 5 minutes." - }, - "bytesWritten" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes written by components in this ProcessGroup in the last 5 minutes" - }, - "written" : { - "type" : "string", - "description" : "The number of bytes written in the last 5 minutes." - }, - "flowFilesOut" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of FlowFiles transferred out of this ProcessGroup in the last 5 minutes" - }, - "bytesOut" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes transferred out of this ProcessGroup in the last 5 minutes" - }, - "output" : { - "type" : "string", - "description" : "The output count/size for the process group in the last 5 minutes." - }, - "flowFilesTransferred" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of FlowFiles transferred in this ProcessGroup in the last 5 minutes" - }, - "bytesTransferred" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes transferred in this ProcessGroup in the last 5 minutes" - }, - "transferred" : { - "type" : "string", - "description" : "The count/size transferred to/from queues in the process group in the last 5 minutes." - }, - "bytesReceived" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes received from external sources by components within this ProcessGroup in the last 5 minutes" - }, - "flowFilesReceived" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of FlowFiles received from external sources by components within this ProcessGroup in the last 5 minutes" - }, - "received" : { - "type" : "string", - "description" : "The count/size sent to the process group in the last 5 minutes." - }, - "bytesSent" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes sent to an external sink by components within this ProcessGroup in the last 5 minutes" - }, - "flowFilesSent" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of FlowFiles sent to an external sink by components within this ProcessGroup in the last 5 minutes" - }, - "sent" : { - "type" : "string", - "description" : "The count/size sent from this process group in the last 5 minutes." - }, - "activeThreadCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The active thread count for this process group." - }, - "terminatedThreadCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of threads currently terminated for the process group." - } - } - }, - "ProcessGroupStatusSnapshotEntity" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the process group." - }, - "processGroupStatusSnapshot" : { - "$ref" : "#/definitions/ProcessGroupStatusSnapshotDTO" - }, - "canRead" : { - "type" : "boolean", - "description" : "Indicates whether the user can read a given resource.", - "readOnly" : true - } - }, - "xml" : { - "name" : "entity" - } - }, - "ProcessGroupsEntity" : { - "type" : "object", - "properties" : { - "processGroups" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ProcessGroupEntity" - } - } - }, - "xml" : { - "name" : "processGroupsEntity" - } - }, - "ProcessorConfigDTO" : { - "type" : "object", - "properties" : { - "properties" : { - "type" : "object", - "description" : "The properties for the processor. Properties whose value is not set will only contain the property name.", - "additionalProperties" : { - "type" : "string" - } - }, - "descriptors" : { - "type" : "object", - "description" : "Descriptors for the processor's properties.", - "additionalProperties" : { - "$ref" : "#/definitions/PropertyDescriptorDTO" - } - }, - "schedulingPeriod" : { - "type" : "string", - "description" : "The frequency with which to schedule the processor. The format of the value will depend on th value of schedulingStrategy." - }, - "schedulingStrategy" : { - "type" : "string", - "description" : "Indcates whether the prcessor should be scheduled to run in event or timer driven mode." - }, - "executionNode" : { - "type" : "string", - "description" : "Indicates the node where the process will execute." - }, - "penaltyDuration" : { - "type" : "string", - "description" : "The amount of time that is used when the process penalizes a flowfile." - }, - "yieldDuration" : { - "type" : "string", - "description" : "The amount of time that must elapse before this processor is scheduled again after yielding." - }, - "bulletinLevel" : { - "type" : "string", - "description" : "The level at which the processor will report bulletins." - }, - "runDurationMillis" : { - "type" : "integer", - "format" : "int64", - "description" : "The run duration for the processor in milliseconds." - }, - "concurrentlySchedulableTaskCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of tasks that should be concurrently schedule for the processor. If the processor doesn't allow parallol processing then any positive input will be ignored." - }, - "autoTerminatedRelationships" : { - "type" : "array", - "description" : "The names of all relationships that cause a flow file to be terminated if the relationship is not connected elsewhere. This property differs from the 'isAutoTerminate' property of the RelationshipDTO in that the RelationshipDTO is meant to depict the current configuration, whereas this property can be set in a DTO when updating a Processor in order to change which Relationships should be auto-terminated.", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - }, - "comments" : { - "type" : "string", - "description" : "The comments for the processor." - }, - "customUiUrl" : { - "type" : "string", - "description" : "The URL for the processor's custom configuration UI if applicable." - }, - "lossTolerant" : { - "type" : "boolean", - "description" : "Whether the processor is loss tolerant." - }, - "annotationData" : { - "type" : "string", - "description" : "The annotation data for the processor used to relay configuration between a custom UI and the procesosr." - }, - "defaultConcurrentTasks" : { - "type" : "object", - "description" : "Maps default values for concurrent tasks for each applicable scheduling strategy.", - "additionalProperties" : { - "type" : "string" - } - }, - "defaultSchedulingPeriod" : { - "type" : "object", - "description" : "Maps default values for scheduling period for each applicable scheduling strategy.", - "additionalProperties" : { - "type" : "string" - } - } - } - }, - "ProcessorDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "versionedComponentId" : { - "type" : "string", - "description" : "The ID of the corresponding component that is under version control" - }, - "parentGroupId" : { - "type" : "string", - "description" : "The id of parent process group of this component if applicable." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "name" : { - "type" : "string", - "description" : "The name of the processor." - }, - "type" : { - "type" : "string", - "description" : "The type of the processor." - }, - "bundle" : { - "description" : "The details of the artifact that bundled this processor type.", - "$ref" : "#/definitions/BundleDTO" - }, - "state" : { - "type" : "string", - "description" : "The state of the processor", - "enum" : [ "RUNNING", "STOPPED", "DISABLED" ] - }, - "style" : { - "type" : "object", - "description" : "Styles for the processor (background-color : #eee).", - "additionalProperties" : { - "type" : "string" - } - }, - "relationships" : { - "type" : "array", - "description" : "The available relationships that the processor currently supports.", - "readOnly" : true, - "items" : { - "$ref" : "#/definitions/RelationshipDTO" - } - }, - "description" : { - "type" : "string", - "description" : "The description of the processor." - }, - "supportsParallelProcessing" : { - "type" : "boolean", - "description" : "Whether the processor supports parallel processing." - }, - "supportsEventDriven" : { - "type" : "boolean", - "description" : "Whether the processor supports event driven scheduling." - }, - "supportsBatching" : { - "type" : "boolean", - "description" : "Whether the processor supports batching. This makes the run duration settings available." - }, - "persistsState" : { - "type" : "boolean", - "description" : "Whether the processor persists state." - }, - "restricted" : { - "type" : "boolean", - "description" : "Whether the processor requires elevated privileges." - }, - "deprecated" : { - "type" : "boolean", - "description" : "Whether the processor has been deprecated." - }, - "executionNodeRestricted" : { - "type" : "boolean", - "description" : "Indicates if the execution node of a processor is restricted to run only on the primary node" - }, - "multipleVersionsAvailable" : { - "type" : "boolean", - "description" : "Whether the processor has multiple versions available." - }, - "inputRequirement" : { - "type" : "string", - "description" : "The input requirement for this processor." - }, - "config" : { - "description" : "The configuration details for the processor. These details will be included in a response if the verbose flag is included in a request.", - "$ref" : "#/definitions/ProcessorConfigDTO" - }, - "validationErrors" : { - "type" : "array", - "description" : "The validation errors for the processor. These validation errors represent the problems with the processor that must be resolved before it can be started.", - "items" : { - "type" : "string" - } - }, - "validationStatus" : { - "type" : "string", - "description" : "Indicates whether the Processor is valid, invalid, or still in the process of validating (i.e., it is unknown whether or not the Processor is valid)", - "readOnly" : true, - "enum" : [ "VALID", "INVALID", "VALIDATING" ] - }, - "extensionMissing" : { - "type" : "boolean", - "description" : "Whether the underlying extension is missing." - } - } - }, - "ProcessorEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "component" : { - "$ref" : "#/definitions/ProcessorDTO" - }, - "inputRequirement" : { - "type" : "string", - "description" : "The input requirement for this processor." - }, - "status" : { - "$ref" : "#/definitions/ProcessorStatusDTO" - }, - "operatePermissions" : { - "description" : "The permissions for this component operations.", - "$ref" : "#/definitions/PermissionsDTO" - } - }, - "xml" : { - "name" : "processorEntity" - } - }, - "ProcessorRunStatusDetailsDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The ID of the processor" - }, - "name" : { - "type" : "string", - "description" : "The name of the processor" - }, - "runStatus" : { - "type" : "string", - "description" : "The run status of the processor", - "enum" : [ "Running", "Stopped", "Invalid", "Validating", "Disabled" ] - }, - "validationErrors" : { - "type" : "array", - "description" : "The processor's validation errors", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - }, - "activeThreadCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The current number of threads that the processor is currently using" - } - } - }, - "ProcessorRunStatusDetailsEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for the Processor.", - "$ref" : "#/definitions/RevisionDTO" - }, - "permissions" : { - "description" : "The permissions for the Processor.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "runStatusDetails" : { - "description" : "The details of a Processor's run status", - "$ref" : "#/definitions/ProcessorRunStatusDetailsDTO" - } - }, - "xml" : { - "name" : "entity" - } - }, - "ProcessorRunStatusEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "state" : { - "type" : "string", - "description" : "The run status of the Processor.", - "enum" : [ "RUNNING", "STOPPED", "DISABLED" ] - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - } - }, - "xml" : { - "name" : "entity" - } - }, - "ProcessorStatusDTO" : { - "type" : "object", - "properties" : { - "groupId" : { - "type" : "string", - "description" : "The unique ID of the process group that the Processor belongs to" - }, - "id" : { - "type" : "string", - "description" : "The unique ID of the Processor" - }, - "name" : { - "type" : "string", - "description" : "The name of the Processor" - }, - "type" : { - "type" : "string", - "description" : "The type of the Processor" - }, - "runStatus" : { - "type" : "string", - "description" : "The run status of the Processor", - "enum" : [ "Running", "Stopped", "Validating", "Disabled", "Invalid" ] - }, - "statsLastRefreshed" : { - "type" : "string", - "description" : "The timestamp of when the stats were last refreshed" - }, - "aggregateSnapshot" : { - "description" : "A status snapshot that represents the aggregate stats of all nodes in the cluster. If the NiFi instance is a standalone instance, rather than a cluster, this represents the stats of the single instance.", - "$ref" : "#/definitions/ProcessorStatusSnapshotDTO" - }, - "nodeSnapshots" : { - "type" : "array", - "description" : "A status snapshot for each node in the cluster. If the NiFi instance is a standalone instance, rather than a cluster, this may be null.", - "items" : { - "$ref" : "#/definitions/NodeProcessorStatusSnapshotDTO" - } - } - } - }, - "ProcessorStatusEntity" : { - "type" : "object", - "properties" : { - "processorStatus" : { - "$ref" : "#/definitions/ProcessorStatusDTO" - }, - "canRead" : { - "type" : "boolean", - "description" : "Indicates whether the user can read a given resource.", - "readOnly" : true - } - }, - "xml" : { - "name" : "processorStatusEntity" - } - }, - "ProcessorStatusSnapshotDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the processor." - }, - "groupId" : { - "type" : "string", - "description" : "The id of the parent process group to which the processor belongs." - }, - "name" : { - "type" : "string", - "description" : "The name of the prcessor." - }, - "type" : { - "type" : "string", - "description" : "The type of the processor." - }, - "runStatus" : { - "type" : "string", - "description" : "The state of the processor.", - "enum" : [ "Running", "Stopped", "Validating", "Disabled", "Invalid" ] - }, - "executionNode" : { - "type" : "string", - "description" : "Indicates the node where the process will execute.", - "enum" : [ "ALL", "PRIMARY" ] - }, - "bytesRead" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes read by this Processor in the last 5 mintues" - }, - "bytesWritten" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes written by this Processor in the last 5 minutes" - }, - "read" : { - "type" : "string", - "description" : "The number of bytes read in the last 5 minutes." - }, - "written" : { - "type" : "string", - "description" : "The number of bytes written in the last 5 minutes." - }, - "flowFilesIn" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of FlowFiles that have been accepted in the last 5 minutes" - }, - "bytesIn" : { - "type" : "integer", - "format" : "int64", - "description" : "The size of the FlowFiles that have been accepted in the last 5 minutes" - }, - "input" : { - "type" : "string", - "description" : "The count/size of flowfiles that have been accepted in the last 5 minutes." - }, - "flowFilesOut" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of FlowFiles transferred to a Connection in the last 5 minutes" - }, - "bytesOut" : { - "type" : "integer", - "format" : "int64", - "description" : "The size of the FlowFiles transferred to a Connection in the last 5 minutes" - }, - "output" : { - "type" : "string", - "description" : "The count/size of flowfiles that have been processed in the last 5 minutes." - }, - "taskCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of times this Processor has run in the last 5 minutes" - }, - "tasksDurationNanos" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of nanoseconds that this Processor has spent running in the last 5 minutes" - }, - "tasks" : { - "type" : "string", - "description" : "The total number of task this connectable has completed over the last 5 minutes." - }, - "tasksDuration" : { - "type" : "string", - "description" : "The total duration of all tasks for this connectable over the last 5 minutes." - }, - "activeThreadCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of threads currently executing in the processor." - }, - "terminatedThreadCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of threads currently terminated for the processor." - } - } - }, - "ProcessorStatusSnapshotEntity" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the processor." - }, - "processorStatusSnapshot" : { - "$ref" : "#/definitions/ProcessorStatusSnapshotDTO" - }, - "canRead" : { - "type" : "boolean", - "description" : "Indicates whether the user can read a given resource.", - "readOnly" : true - } - }, - "xml" : { - "name" : "entity" - } - }, - "ProcessorTypesEntity" : { - "type" : "object", - "properties" : { - "processorTypes" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/DocumentedTypeDTO" - } - } - }, - "xml" : { - "name" : "processorTypesEntity" - } - }, - "ProcessorsEntity" : { - "type" : "object", - "properties" : { - "processors" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ProcessorEntity" - } - } - }, - "xml" : { - "name" : "processorsEntity" - } - }, - "ProcessorsRunStatusDetailsEntity" : { - "type" : "object", - "properties" : { - "runStatusDetails" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/ProcessorRunStatusDetailsEntity" - } - } - }, - "xml" : { - "name" : "processorsRunStatusDetails" - } - }, - "PropertyDescriptorDTO" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The name for the property." - }, - "displayName" : { - "type" : "string", - "description" : "The human readable name for the property." - }, - "description" : { - "type" : "string", - "description" : "The description for the property. Used to relay additional details to a user or provide a mechanism of documenting intent." - }, - "defaultValue" : { - "type" : "string", - "description" : "The default value for the property." - }, - "allowableValues" : { - "type" : "array", - "description" : "Allowable values for the property. If empty then the allowed values are not constrained.", - "items" : { - "$ref" : "#/definitions/AllowableValueEntity" - } - }, - "required" : { - "type" : "boolean", - "description" : "Whether the property is required." - }, - "sensitive" : { - "type" : "boolean", - "description" : "Whether the property is sensitive and protected whenever stored or represented." - }, - "dynamic" : { - "type" : "boolean", - "description" : "Whether the property is dynamic (user-defined)." - }, - "supportsEl" : { - "type" : "boolean", - "description" : "Whether the property supports expression language." - }, - "expressionLanguageScope" : { - "type" : "string", - "description" : "Scope of the Expression Language evaluation for the property." - }, - "identifiesControllerService" : { - "type" : "string", - "description" : "If the property identifies a controller service this returns the fully qualified type." - }, - "identifiesControllerServiceBundle" : { - "description" : "If the property identifies a controller service this returns the bundle of the type, null otherwise.", - "$ref" : "#/definitions/BundleDTO" - } - } - }, - "PropertyDescriptorEntity" : { - "type" : "object", - "properties" : { - "propertyDescriptor" : { - "$ref" : "#/definitions/PropertyDescriptorDTO" - } - }, - "xml" : { - "name" : "propertyDescriptor" - } - }, - "PropertyHistoryDTO" : { - "type" : "object", - "properties" : { - "previousValues" : { - "type" : "array", - "description" : "Previous values for a given property.", - "items" : { - "$ref" : "#/definitions/PreviousValueDTO" - } - } - } - }, - "ProvenanceDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the provenance query." - }, - "uri" : { - "type" : "string", - "description" : "The URI for this query. Used for obtaining/deleting the request at a later time" - }, - "submissionTime" : { - "type" : "string", - "description" : "The timestamp when the query was submitted." - }, - "expiration" : { - "type" : "string", - "description" : "The timestamp when the query will expire." - }, - "percentCompleted" : { - "type" : "integer", - "format" : "int32", - "description" : "The current percent complete." - }, - "finished" : { - "type" : "boolean", - "description" : "Whether the query has finished." - }, - "request" : { - "description" : "The provenance request.", - "$ref" : "#/definitions/ProvenanceRequestDTO" - }, - "results" : { - "description" : "The provenance results.", - "$ref" : "#/definitions/ProvenanceResultsDTO" - } - } - }, - "ProvenanceEntity" : { - "type" : "object", - "properties" : { - "provenance" : { - "$ref" : "#/definitions/ProvenanceDTO" - } - }, - "xml" : { - "name" : "provenanceEntity" - } - }, - "ProvenanceEventDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The event uuid." - }, - "eventId" : { - "type" : "integer", - "format" : "int64", - "description" : "The event id. This is a one up number thats unique per node." - }, - "eventTime" : { - "type" : "string", - "description" : "The timestamp of the event." - }, - "eventDuration" : { - "type" : "integer", - "format" : "int64", - "description" : "The event duration in milliseconds." - }, - "lineageDuration" : { - "type" : "integer", - "format" : "int64", - "description" : "The duration since the lineage began, in milliseconds." - }, - "eventType" : { - "type" : "string", - "description" : "The type of the event." - }, - "flowFileUuid" : { - "type" : "string", - "description" : "The uuid of the flowfile for the event." - }, - "fileSize" : { - "type" : "string", - "description" : "The size of the flowfile for the event." - }, - "fileSizeBytes" : { - "type" : "integer", - "format" : "int64", - "description" : "The size of the flowfile in bytes for the event." - }, - "clusterNodeId" : { - "type" : "string", - "description" : "The identifier for the node where the event originated." - }, - "clusterNodeAddress" : { - "type" : "string", - "description" : "The label for the node where the event originated." - }, - "groupId" : { - "type" : "string", - "description" : "The id of the group that the component resides in. If the component is no longer in the flow, the group id will not be set." - }, - "componentId" : { - "type" : "string", - "description" : "The id of the component that generated the event." - }, - "componentType" : { - "type" : "string", - "description" : "The type of the component that generated the event." - }, - "componentName" : { - "type" : "string", - "description" : "The name of the component that generated the event." - }, - "sourceSystemFlowFileId" : { - "type" : "string", - "description" : "The source system flowfile id." - }, - "alternateIdentifierUri" : { - "type" : "string", - "description" : "The alternate identifier uri for the fileflow for the event." - }, - "attributes" : { - "type" : "array", - "description" : "The attributes of the flowfile for the event.", - "items" : { - "$ref" : "#/definitions/AttributeDTO" - } - }, - "parentUuids" : { - "type" : "array", - "description" : "The parent uuids for the event.", - "items" : { - "type" : "string" - } - }, - "childUuids" : { - "type" : "array", - "description" : "The child uuids for the event.", - "items" : { - "type" : "string" - } - }, - "transitUri" : { - "type" : "string", - "description" : "The source/destination system uri if the event was a RECEIVE/SEND." - }, - "relationship" : { - "type" : "string", - "description" : "The relationship to which the flowfile was routed if the event is of type ROUTE." - }, - "details" : { - "type" : "string", - "description" : "The event details." - }, - "contentEqual" : { - "type" : "boolean", - "description" : "Whether the input and output content claim is the same." - }, - "inputContentAvailable" : { - "type" : "boolean", - "description" : "Whether the input content is still available." - }, - "inputContentClaimSection" : { - "type" : "string", - "description" : "The section in which the input content claim lives." - }, - "inputContentClaimContainer" : { - "type" : "string", - "description" : "The container in which the input content claim lives." - }, - "inputContentClaimIdentifier" : { - "type" : "string", - "description" : "The identifier of the input content claim." - }, - "inputContentClaimOffset" : { - "type" : "integer", - "format" : "int64", - "description" : "The offset into the input content claim where the flowfiles content begins." - }, - "inputContentClaimFileSize" : { - "type" : "string", - "description" : "The file size of the input content claim formatted." - }, - "inputContentClaimFileSizeBytes" : { - "type" : "integer", - "format" : "int64", - "description" : "The file size of the intput content claim in bytes." - }, - "outputContentAvailable" : { - "type" : "boolean", - "description" : "Whether the output content is still available." - }, - "outputContentClaimSection" : { - "type" : "string", - "description" : "The section in which the output content claim lives." - }, - "outputContentClaimContainer" : { - "type" : "string", - "description" : "The container in which the output content claim lives." - }, - "outputContentClaimIdentifier" : { - "type" : "string", - "description" : "The identifier of the output content claim." - }, - "outputContentClaimOffset" : { - "type" : "integer", - "format" : "int64", - "description" : "The offset into the output content claim where the flowfiles content begins." - }, - "outputContentClaimFileSize" : { - "type" : "string", - "description" : "The file size of the output content claim formatted." - }, - "outputContentClaimFileSizeBytes" : { - "type" : "integer", - "format" : "int64", - "description" : "The file size of the output content claim in bytes." - }, - "replayAvailable" : { - "type" : "boolean", - "description" : "Whether or not replay is available." - }, - "replayExplanation" : { - "type" : "string", - "description" : "Explanation as to why replay is unavailable." - }, - "sourceConnectionIdentifier" : { - "type" : "string", - "description" : "The identifier of the queue/connection from which the flowfile was pulled to genereate this event. May be null if the queue/connection is unknown or the flowfile was generated from this event." - } - } - }, - "ProvenanceEventEntity" : { - "type" : "object", - "properties" : { - "provenanceEvent" : { - "$ref" : "#/definitions/ProvenanceEventDTO" - } - }, - "xml" : { - "name" : "provenanceEventEntity" - } - }, - "ProvenanceLinkDTO" : { - "type" : "object", - "properties" : { - "sourceId" : { - "type" : "string", - "description" : "The source node id of the link." - }, - "targetId" : { - "type" : "string", - "description" : "The target node id of the link." - }, - "flowFileUuid" : { - "type" : "string", - "description" : "The flowfile uuid that traversed the link." - }, - "timestamp" : { - "type" : "string", - "description" : "The timestamp of the link (based on the destination)." - }, - "millis" : { - "type" : "integer", - "format" : "int64", - "description" : "The timestamp of this link in milliseconds." - } - } - }, - "ProvenanceNodeDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the node." - }, - "flowFileUuid" : { - "type" : "string", - "description" : "The uuid of the flowfile associated with the provenance event." - }, - "parentUuids" : { - "type" : "array", - "description" : "The uuid of the parent flowfiles of the provenance event.", - "items" : { - "type" : "string" - } - }, - "childUuids" : { - "type" : "array", - "description" : "The uuid of the childrent flowfiles of the provenance event.", - "items" : { - "type" : "string" - } - }, - "clusterNodeIdentifier" : { - "type" : "string", - "description" : "The identifier of the node that this event/flowfile originated from." - }, - "type" : { - "type" : "string", - "description" : "The type of the node.", - "enum" : [ "FLOWFILE", "EVENT" ] - }, - "eventType" : { - "type" : "string", - "description" : "If the type is EVENT, this is the type of event." - }, - "millis" : { - "type" : "integer", - "format" : "int64", - "description" : "The timestamp of the node in milliseconds." - }, - "timestamp" : { - "type" : "string", - "description" : "The timestamp of the node formatted." - } - } - }, - "ProvenanceOptionsDTO" : { - "type" : "object", - "properties" : { - "searchableFields" : { - "type" : "array", - "description" : "The available searchable field for the NiFi.", - "items" : { - "$ref" : "#/definitions/ProvenanceSearchableFieldDTO" - } - } - } - }, - "ProvenanceOptionsEntity" : { - "type" : "object", - "properties" : { - "provenanceOptions" : { - "$ref" : "#/definitions/ProvenanceOptionsDTO" - } - }, - "xml" : { - "name" : "provenanceOptionsEntity" - } - }, - "ProvenanceRequestDTO" : { - "type" : "object", - "properties" : { - "searchTerms" : { - "type" : "object", - "description" : "The search terms used to perform the search.", - "additionalProperties" : { - "type" : "string" - } - }, - "clusterNodeId" : { - "type" : "string", - "description" : "The id of the node in the cluster where this provenance originated." - }, - "startDate" : { - "type" : "string", - "description" : "The earliest event time to include in the query." - }, - "endDate" : { - "type" : "string", - "description" : "The latest event time to include in the query." - }, - "minimumFileSize" : { - "type" : "string", - "description" : "The minimum file size to include in the query." - }, - "maximumFileSize" : { - "type" : "string", - "description" : "The maximum file size to include in the query." - }, - "maxResults" : { - "type" : "integer", - "format" : "int32", - "description" : "The maximum number of results to include." - }, - "summarize" : { - "type" : "boolean", - "description" : "Whether or not to summarize provenance events returned. This property is false by default." - }, - "incrementalResults" : { - "type" : "boolean", - "description" : "Whether or not incremental results are returned. If false, provenance events are only returned once the query completes. This property is true by default." - } - } - }, - "ProvenanceResultsDTO" : { - "type" : "object", - "properties" : { - "provenanceEvents" : { - "type" : "array", - "description" : "The provenance events that matched the search criteria.", - "items" : { - "$ref" : "#/definitions/ProvenanceEventDTO" - } - }, - "total" : { - "type" : "string", - "description" : "The total number of results formatted." - }, - "totalCount" : { - "type" : "integer", - "format" : "int64", - "description" : "The total number of results." - }, - "generated" : { - "type" : "string", - "description" : "Then the search was performed." - }, - "oldestEvent" : { - "type" : "string", - "description" : "The oldest event available in the provenance repository." - }, - "timeOffset" : { - "type" : "integer", - "format" : "int32", - "description" : "The time offset of the server that's used for event time." - }, - "errors" : { - "type" : "array", - "description" : "Any errors that occurred while performing the provenance request.", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - } - } - }, - "ProvenanceSearchableFieldDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the searchable field." - }, - "field" : { - "type" : "string", - "description" : "The searchable field." - }, - "label" : { - "type" : "string", - "description" : "The label for the searchable field." - }, - "type" : { - "type" : "string", - "description" : "The type of the searchable field." - } - } - }, - "QueueSizeDTO" : { - "type" : "object", - "properties" : { - "byteCount" : { - "type" : "integer", - "format" : "int64", - "description" : "The size of objects in a queue." - }, - "objectCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The count of objects in a queue." - } - } - }, - "RegistryClientEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "component" : { - "$ref" : "#/definitions/RegistryDTO" - } - }, - "xml" : { - "name" : "registryClientEntity" - } - }, - "RegistryClientsEntity" : { - "type" : "object", - "properties" : { - "registries" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/RegistryClientEntity" - } - } - }, - "xml" : { - "name" : "registryClientsEntity" - } - }, - "RegistryDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The registry identifier" - }, - "name" : { - "type" : "string", - "description" : "The registry name" - }, - "description" : { - "type" : "string", - "description" : "The registry description" - }, - "uri" : { - "type" : "string", - "description" : "The registry URI" - } - } - }, - "RelationshipDTO" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The relationship name." - }, - "description" : { - "type" : "string", - "description" : "The relationship description." - }, - "autoTerminate" : { - "type" : "boolean", - "description" : "Whether or not flowfiles sent to this relationship should auto terminate." - } - } - }, - "RemotePortRunStatusEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "state" : { - "type" : "string", - "description" : "The run status of the RemotePort.", - "enum" : [ "TRANSMITTING", "STOPPED" ] - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - } - }, - "xml" : { - "name" : "entity" - } - }, - "RemoteProcessGroupContentsDTO" : { - "type" : "object", - "properties" : { - "inputPorts" : { - "type" : "array", - "description" : "The input ports to which data can be sent.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/RemoteProcessGroupPortDTO" - } - }, - "outputPorts" : { - "type" : "array", - "description" : "The output ports from which data can be retrieved.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/RemoteProcessGroupPortDTO" - } - } - } - }, - "RemoteProcessGroupDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "versionedComponentId" : { - "type" : "string", - "description" : "The ID of the corresponding component that is under version control" - }, - "parentGroupId" : { - "type" : "string", - "description" : "The id of parent process group of this component if applicable." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "targetUri" : { - "type" : "string", - "description" : "The target URI of the remote process group. If target uri is not set, but uris are set, then returns the first url in the urls. If neither target uri nor uris are set, then returns null." - }, - "targetUris" : { - "type" : "string", - "description" : "The target URI of the remote process group. If target uris is not set but target uri is set, then returns a collection containing the single target uri. If neither target uris nor uris are set, then returns null." - }, - "targetSecure" : { - "type" : "boolean", - "description" : "Whether the target is running securely." - }, - "name" : { - "type" : "string", - "description" : "The name of the remote process group." - }, - "comments" : { - "type" : "string", - "description" : "The comments for the remote process group." - }, - "communicationsTimeout" : { - "type" : "string", - "description" : "The time period used for the timeout when communicating with the target." - }, - "yieldDuration" : { - "type" : "string", - "description" : "When yielding, this amount of time must elapse before the remote process group is scheduled again." - }, - "transportProtocol" : { - "type" : "string" - }, - "localNetworkInterface" : { - "type" : "string", - "description" : "The local network interface to send/receive data. If not specified, any local address is used. If clustered, all nodes must have an interface with this identifier." - }, - "proxyHost" : { - "type" : "string" - }, - "proxyPort" : { - "type" : "integer", - "format" : "int32" - }, - "proxyUser" : { - "type" : "string" - }, - "proxyPassword" : { - "type" : "string" - }, - "authorizationIssues" : { - "type" : "array", - "description" : "Any remote authorization issues for the remote process group.", - "items" : { - "type" : "string" - } - }, - "validationErrors" : { - "type" : "array", - "description" : "The validation errors for the remote process group. These validation errors represent the problems with the remote process group that must be resolved before it can transmit.", - "items" : { - "type" : "string" - } - }, - "transmitting" : { - "type" : "boolean", - "description" : "Whether the remote process group is actively transmitting." - }, - "inputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of remote input ports currently available on the target." - }, - "outputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of remote output ports currently available on the target." - }, - "activeRemoteInputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of active remote input ports." - }, - "inactiveRemoteInputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of inactive remote input ports." - }, - "activeRemoteOutputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of active remote output ports." - }, - "inactiveRemoteOutputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of inactive remote output ports." - }, - "flowRefreshed" : { - "type" : "string", - "description" : "The timestamp when this remote process group was last refreshed." - }, - "contents" : { - "description" : "The contents of the remote process group. Will contain available input/output ports.", - "$ref" : "#/definitions/RemoteProcessGroupContentsDTO" - } - } - }, - "RemoteProcessGroupEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "component" : { - "$ref" : "#/definitions/RemoteProcessGroupDTO" - }, - "status" : { - "description" : "The status of the remote process group.", - "$ref" : "#/definitions/RemoteProcessGroupStatusDTO" - }, - "inputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of remote input ports currently available on the target." - }, - "outputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of remote output ports currently available on the target." - }, - "operatePermissions" : { - "description" : "The permissions for this component operations.", - "$ref" : "#/definitions/PermissionsDTO" - } - }, - "xml" : { - "name" : "remoteProcessGroupEntity" - } - }, - "RemoteProcessGroupPortDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the port." - }, - "targetId" : { - "type" : "string", - "description" : "The id of the target port." - }, - "versionedComponentId" : { - "type" : "string", - "description" : "The ID of the corresponding component that is under version control" - }, - "groupId" : { - "type" : "string", - "description" : "The id of the remote process group that the port resides in." - }, - "name" : { - "type" : "string", - "description" : "The name of the target port." - }, - "comments" : { - "type" : "string", - "description" : "The comments as configured on the target port." - }, - "concurrentlySchedulableTaskCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of task that may transmit flowfiles to the target port concurrently." - }, - "transmitting" : { - "type" : "boolean", - "description" : "Whether the remote port is configured for transmission." - }, - "useCompression" : { - "type" : "boolean", - "description" : "Whether the flowfiles are compressed when sent to the target port." - }, - "exists" : { - "type" : "boolean", - "description" : "Whether the target port exists." - }, - "targetRunning" : { - "type" : "boolean", - "description" : "Whether the target port is running." - }, - "connected" : { - "type" : "boolean", - "description" : "Whether the port has either an incoming or outgoing connection." - }, - "batchSettings" : { - "description" : "The batch settings for data transmission.", - "$ref" : "#/definitions/BatchSettingsDTO" - } - } - }, - "RemoteProcessGroupPortEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "remoteProcessGroupPort" : { - "$ref" : "#/definitions/RemoteProcessGroupPortDTO" - }, - "operatePermissions" : { - "description" : "The permissions for this component operations.", - "$ref" : "#/definitions/PermissionsDTO" - } - }, - "xml" : { - "name" : "remoteProcessGroupPortEntity" - } - }, - "RemoteProcessGroupStatusDTO" : { - "type" : "object", - "properties" : { - "groupId" : { - "type" : "string", - "description" : "The unique ID of the process group that the Processor belongs to" - }, - "id" : { - "type" : "string", - "description" : "The unique ID of the Processor" - }, - "name" : { - "type" : "string", - "description" : "The name of the remote process group." - }, - "targetUri" : { - "type" : "string", - "description" : "The URI of the target system." - }, - "transmissionStatus" : { - "type" : "string", - "description" : "The transmission status of the remote process group." - }, - "statsLastRefreshed" : { - "type" : "string", - "description" : "The time the status for the process group was last refreshed." - }, - "validationStatus" : { - "type" : "string", - "description" : "Indicates whether the component is valid, invalid, or still in the process of validating (i.e., it is unknown whether or not the component is valid)", - "readOnly" : true, - "enum" : [ "VALID", "INVALID", "VALIDATING" ] - }, - "aggregateSnapshot" : { - "description" : "A status snapshot that represents the aggregate stats of all nodes in the cluster. If the NiFi instance is a standalone instance, rather than a cluster, this represents the stats of the single instance.", - "$ref" : "#/definitions/RemoteProcessGroupStatusSnapshotDTO" - }, - "nodeSnapshots" : { - "type" : "array", - "description" : "A status snapshot for each node in the cluster. If the NiFi instance is a standalone instance, rather than a cluster, this may be null.", - "items" : { - "$ref" : "#/definitions/NodeRemoteProcessGroupStatusSnapshotDTO" - } - } - } - }, - "RemoteProcessGroupStatusEntity" : { - "type" : "object", - "properties" : { - "remoteProcessGroupStatus" : { - "$ref" : "#/definitions/RemoteProcessGroupStatusDTO" - }, - "canRead" : { - "type" : "boolean", - "description" : "Indicates whether the user can read a given resource.", - "readOnly" : true - } - }, - "xml" : { - "name" : "remoteProcessGroupStatusEntity" - } - }, - "RemoteProcessGroupStatusSnapshotDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the remote process group." - }, - "groupId" : { - "type" : "string", - "description" : "The id of the parent process group the remote process group resides in." - }, - "name" : { - "type" : "string", - "description" : "The name of the remote process group." - }, - "targetUri" : { - "type" : "string", - "description" : "The URI of the target system." - }, - "transmissionStatus" : { - "type" : "string", - "description" : "The transmission status of the remote process group." - }, - "activeThreadCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of active threads for the remote process group." - }, - "flowFilesSent" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of FlowFiles sent to the remote process group in the last 5 minutes." - }, - "bytesSent" : { - "type" : "integer", - "format" : "int64", - "description" : "The size of the FlowFiles sent to the remote process group in the last 5 minutes." - }, - "sent" : { - "type" : "string", - "description" : "The count/size of the flowfiles sent to the remote process group in the last 5 minutes." - }, - "flowFilesReceived" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of FlowFiles received from the remote process group in the last 5 minutes." - }, - "bytesReceived" : { - "type" : "integer", - "format" : "int64", - "description" : "The size of the FlowFiles received from the remote process group in the last 5 minutes." - }, - "received" : { - "type" : "string", - "description" : "The count/size of the flowfiles received from the remote process group in the last 5 minutes." - } - } - }, - "RemoteProcessGroupStatusSnapshotEntity" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the remote process group." - }, - "remoteProcessGroupStatusSnapshot" : { - "$ref" : "#/definitions/RemoteProcessGroupStatusSnapshotDTO" - }, - "canRead" : { - "type" : "boolean", - "description" : "Indicates whether the user can read a given resource.", - "readOnly" : true - } - }, - "xml" : { - "name" : "entity" - } - }, - "RemoteProcessGroupsEntity" : { - "type" : "object", - "properties" : { - "remoteProcessGroups" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/RemoteProcessGroupEntity" - } - } - }, - "xml" : { - "name" : "remoteProcessGroupsEntity" - } - }, - "ReportingTaskDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "versionedComponentId" : { - "type" : "string", - "description" : "The ID of the corresponding component that is under version control" - }, - "parentGroupId" : { - "type" : "string", - "description" : "The id of parent process group of this component if applicable." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "name" : { - "type" : "string", - "description" : "The name of the reporting task." - }, - "type" : { - "type" : "string", - "description" : "The fully qualified type of the reporting task." - }, - "bundle" : { - "description" : "The details of the artifact that bundled this processor type.", - "$ref" : "#/definitions/BundleDTO" - }, - "state" : { - "type" : "string", - "description" : "The state of the reporting task.", - "enum" : [ "RUNNING", "STOPPED", "DISABLED" ] - }, - "comments" : { - "type" : "string", - "description" : "The comments of the reporting task." - }, - "persistsState" : { - "type" : "boolean", - "description" : "Whether the reporting task persists state." - }, - "restricted" : { - "type" : "boolean", - "description" : "Whether the reporting task requires elevated privileges." - }, - "deprecated" : { - "type" : "boolean", - "description" : "Whether the reporting task has been deprecated." - }, - "multipleVersionsAvailable" : { - "type" : "boolean", - "description" : "Whether the reporting task has multiple versions available." - }, - "schedulingPeriod" : { - "type" : "string", - "description" : "The frequency with which to schedule the reporting task. The format of the value willd epend on the valud of the schedulingStrategy." - }, - "schedulingStrategy" : { - "type" : "string", - "description" : "The scheduling strategy that determines how the schedulingPeriod value should be interpreted." - }, - "defaultSchedulingPeriod" : { - "type" : "object", - "description" : "The default scheduling period for the different scheduling strategies.", - "additionalProperties" : { - "type" : "string" - } - }, - "properties" : { - "type" : "object", - "description" : "The properties of the reporting task.", - "additionalProperties" : { - "type" : "string" - } - }, - "descriptors" : { - "type" : "object", - "description" : "The descriptors for the reporting tasks properties.", - "additionalProperties" : { - "$ref" : "#/definitions/PropertyDescriptorDTO" - } - }, - "customUiUrl" : { - "type" : "string", - "description" : "The URL for the custom configuration UI for the reporting task." - }, - "annotationData" : { - "type" : "string", - "description" : "The annotation data for the repoting task. This is how the custom UI relays configuration to the reporting task." - }, - "validationErrors" : { - "type" : "array", - "description" : "Gets the validation errors from the reporting task. These validation errors represent the problems with the reporting task that must be resolved before it can be scheduled to run.", - "items" : { - "type" : "string" - } - }, - "validationStatus" : { - "type" : "string", - "description" : "Indicates whether the Processor is valid, invalid, or still in the process of validating (i.e., it is unknown whether or not the Processor is valid)", - "readOnly" : true, - "enum" : [ "VALID", "INVALID", "VALIDATING" ] - }, - "activeThreadCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of active threads for the reporting task." - }, - "extensionMissing" : { - "type" : "boolean", - "description" : "Whether the underlying extension is missing." - } - } - }, - "ReportingTaskEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "component" : { - "$ref" : "#/definitions/ReportingTaskDTO" - }, - "operatePermissions" : { - "description" : "The permissions for this component operations.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "status" : { - "description" : "The status for this ReportingTask.", - "readOnly" : true, - "$ref" : "#/definitions/ReportingTaskStatusDTO" - } - }, - "xml" : { - "name" : "reportingTaskEntity" - } - }, - "ReportingTaskRunStatusEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "state" : { - "type" : "string", - "description" : "The run status of the ReportingTask.", - "enum" : [ "RUNNING", "STOPPED" ] - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - } - }, - "xml" : { - "name" : "entity" - } - }, - "ReportingTaskStatusDTO" : { - "type" : "object", - "properties" : { - "runStatus" : { - "type" : "string", - "description" : "The run status of this ReportingTask", - "readOnly" : true, - "enum" : [ "RUNNING", "STOPPED", "DISABLED" ] - }, - "validationStatus" : { - "type" : "string", - "description" : "Indicates whether the component is valid, invalid, or still in the process of validating (i.e., it is unknown whether or not the component is valid)", - "readOnly" : true, - "enum" : [ "VALID", "INVALID", "VALIDATING" ] - }, - "activeThreadCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of active threads for the component." - } - } - }, - "ReportingTaskTypesEntity" : { - "type" : "object", - "properties" : { - "reportingTaskTypes" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/DocumentedTypeDTO" - } - } - }, - "xml" : { - "name" : "reportingTaskTypesEntity" - } - }, - "ReportingTasksEntity" : { - "type" : "object", - "properties" : { - "reportingTasks" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ReportingTaskEntity" - } - } - }, - "xml" : { - "name" : "reportingTasksEntity" - } - }, - "RequiredPermissionDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The required sub-permission necessary for this restriction." - }, - "label" : { - "type" : "string", - "description" : "The label for the required sub-permission necessary for this restriction." - } - } - }, - "ResourceDTO" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The identifier of the resource." - }, - "name" : { - "type" : "string", - "description" : "The name of the resource." - } - } - }, - "ResourcesEntity" : { - "type" : "object", - "properties" : { - "resources" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/ResourceDTO" - } - } - }, - "xml" : { - "name" : "resourcesEntity" - } - }, - "RevisionDTO" : { - "type" : "object", - "properties" : { - "clientId" : { - "type" : "string", - "description" : "A client identifier used to make a request. By including a client identifier, the API can allow multiple requests without needing the current revision. Due to the asynchronous nature of requests/responses this was implemented to allow the client to make numerous requests without having to wait for the previous response to come back" - }, - "version" : { - "type" : "integer", - "format" : "int64", - "description" : "NiFi employs an optimistic locking strategy where the client must include a revision in their request when performing an update. In a response to a mutable flow request, this field represents the updated base version." - }, - "lastModifier" : { - "type" : "string", - "description" : "The user that last modified the flow.", - "readOnly" : true - } - } - }, - "RevisionInfo" : { - "type" : "object", - "properties" : { - "clientId" : { - "type" : "string", - "description" : "A client identifier used to make a request. By including a client identifier, the API can allow multiple requests without needing the current revision. Due to the asynchronous nature of requests/responses this was implemented to allow the client to make numerous requests without having to wait for the previous response to come back." - }, - "version" : { - "type" : "integer", - "format" : "int64", - "description" : "NiFi Registry employs an optimistic locking strategy where the client must include a revision in their request when performing an update. In a response to a mutable flow request, this field represents the updated base version." - }, - "lastModifier" : { - "type" : "string", - "description" : "The user that last modified the entity.", - "readOnly" : true - } - }, - "description" : "The revision information for an entity managed through the REST API." - }, - "RunStatusDetailsRequestEntity" : { - "type" : "object", - "properties" : { - "processorIds" : { - "type" : "array", - "description" : "The IDs of all processors whose run status details should be provided", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - } - }, - "xml" : { - "name" : "runStatusDetailsRequest" - } - }, - "ScheduleComponentsEntity" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the ProcessGroup" - }, - "state" : { - "type" : "string", - "description" : "The desired state of the descendant components", - "enum" : [ "RUNNING", "STOPPED", "ENABLED", "DISABLED" ] - }, - "components" : { - "type" : "object", - "description" : "Optional components to schedule. If not specified, all authorized descendant components will be used.", - "additionalProperties" : { - "$ref" : "#/definitions/RevisionDTO" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - } - }, - "xml" : { - "name" : "scheduleComponentEntity" - } - }, - "SearchResultGroupDTO" : { - "type" : "object", - "required" : [ "id" ], - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the group." - }, - "name" : { - "type" : "string", - "description" : "The name of the group." - } - } - }, - "SearchResultsDTO" : { - "type" : "object", - "properties" : { - "processorResults" : { - "type" : "array", - "description" : "The processors that matched the search.", - "items" : { - "$ref" : "#/definitions/ComponentSearchResultDTO" - } - }, - "connectionResults" : { - "type" : "array", - "description" : "The connections that matched the search.", - "items" : { - "$ref" : "#/definitions/ComponentSearchResultDTO" - } - }, - "processGroupResults" : { - "type" : "array", - "description" : "The process groups that matched the search.", - "items" : { - "$ref" : "#/definitions/ComponentSearchResultDTO" - } - }, - "inputPortResults" : { - "type" : "array", - "description" : "The input ports that matched the search.", - "items" : { - "$ref" : "#/definitions/ComponentSearchResultDTO" - } - }, - "outputPortResults" : { - "type" : "array", - "description" : "The output ports that matched the search.", - "items" : { - "$ref" : "#/definitions/ComponentSearchResultDTO" - } - }, - "remoteProcessGroupResults" : { - "type" : "array", - "description" : "The remote process groups that matched the search.", - "items" : { - "$ref" : "#/definitions/ComponentSearchResultDTO" - } - }, - "funnelResults" : { - "type" : "array", - "description" : "The funnels that matched the search.", - "items" : { - "$ref" : "#/definitions/ComponentSearchResultDTO" - } - }, - "labelResults" : { - "type" : "array", - "description" : "The labels that matched the search.", - "items" : { - "$ref" : "#/definitions/ComponentSearchResultDTO" - } - }, - "controllerServiceNodeResults" : { - "type" : "array", - "description" : "The controller service nodes that matched the search", - "items" : { - "$ref" : "#/definitions/ComponentSearchResultDTO" - } - }, - "parameterContextResults" : { - "type" : "array", - "description" : "The parameter contexts that matched the search.", - "items" : { - "$ref" : "#/definitions/ComponentSearchResultDTO" - } - }, - "parameterResults" : { - "type" : "array", - "description" : "The parameters that matched the search.", - "items" : { - "$ref" : "#/definitions/ComponentSearchResultDTO" - } - } - } - }, - "SearchResultsEntity" : { - "type" : "object", - "properties" : { - "searchResultsDTO" : { - "$ref" : "#/definitions/SearchResultsDTO" - } - }, - "xml" : { - "name" : "searchResultsEntity" - } - }, - "SnippetDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the snippet." - }, - "uri" : { - "type" : "string", - "description" : "The URI of the snippet." - }, - "parentGroupId" : { - "type" : "string", - "description" : "The group id for the components in the snippet." - }, - "processGroups" : { - "type" : "object", - "description" : "The ids of the process groups in this snippet. These ids will be populated within each response. They can be specified when creating a snippet. However, once a snippet has been created its contents cannot be modified (these ids are ignored during update requests).", - "additionalProperties" : { - "$ref" : "#/definitions/RevisionDTO" - } - }, - "remoteProcessGroups" : { - "type" : "object", - "description" : "The ids of the remote process groups in this snippet. These ids will be populated within each response. They can be specified when creating a snippet. However, once a snippet has been created its contents cannot be modified (these ids are ignored during update requests).", - "additionalProperties" : { - "$ref" : "#/definitions/RevisionDTO" - } - }, - "processors" : { - "type" : "object", - "description" : "The ids of the processors in this snippet. These ids will be populated within each response. They can be specified when creating a snippet. However, once a snippet has been created its contents cannot be modified (these ids are ignored during update requests).", - "additionalProperties" : { - "$ref" : "#/definitions/RevisionDTO" - } - }, - "inputPorts" : { - "type" : "object", - "description" : "The ids of the input ports in this snippet. These ids will be populated within each response. They can be specified when creating a snippet. However, once a snippet has been created its contents cannot be modified (these ids are ignored during update requests).", - "additionalProperties" : { - "$ref" : "#/definitions/RevisionDTO" - } - }, - "outputPorts" : { - "type" : "object", - "description" : "The ids of the output ports in this snippet. These ids will be populated within each response. They can be specified when creating a snippet. However, once a snippet has been created its contents cannot be modified (these ids are ignored during update requests).", - "additionalProperties" : { - "$ref" : "#/definitions/RevisionDTO" - } - }, - "connections" : { - "type" : "object", - "description" : "The ids of the connections in this snippet. These ids will be populated within each response. They can be specified when creating a snippet. However, once a snippet has been created its contents cannot be modified (these ids are ignored during update requests).", - "additionalProperties" : { - "$ref" : "#/definitions/RevisionDTO" - } - }, - "labels" : { - "type" : "object", - "description" : "The ids of the labels in this snippet. These ids will be populated within each response. They can be specified when creating a snippet. However, once a snippet has been created its contents cannot be modified (these ids are ignored during update requests).", - "additionalProperties" : { - "$ref" : "#/definitions/RevisionDTO" - } - }, - "funnels" : { - "type" : "object", - "description" : "The ids of the funnels in this snippet. These ids will be populated within each response. They can be specified when creating a snippet. However, once a snippet has been created its contents cannot be modified (these ids are ignored during update requests).", - "additionalProperties" : { - "$ref" : "#/definitions/RevisionDTO" - } - } - } - }, - "SnippetEntity" : { - "type" : "object", - "properties" : { - "snippet" : { - "description" : "The snippet.", - "$ref" : "#/definitions/SnippetDTO" - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - } - }, - "xml" : { - "name" : "snippetEntity" - } - }, - "StartVersionControlRequestEntity" : { - "type" : "object", - "properties" : { - "versionedFlow" : { - "description" : "The versioned flow", - "$ref" : "#/definitions/VersionedFlowDTO" - }, - "processGroupRevision" : { - "description" : "The Revision of the Process Group under Version Control", - "$ref" : "#/definitions/RevisionDTO" - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - } - }, - "xml" : { - "name" : "startVersionControlRequestEntity" - } - }, - "StateEntryDTO" : { - "type" : "object", - "properties" : { - "key" : { - "type" : "string", - "description" : "The key for this state." - }, - "value" : { - "type" : "string", - "description" : "The value for this state." - }, - "clusterNodeId" : { - "type" : "string", - "description" : "The identifier for the node where the state originated." - }, - "clusterNodeAddress" : { - "type" : "string", - "description" : "The label for the node where the state originated." - } - } - }, - "StateMapDTO" : { - "type" : "object", - "properties" : { - "scope" : { - "type" : "string", - "description" : "The scope of this StateMap." - }, - "totalEntryCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The total number of state entries. When the state map is lengthy, only of portion of the entries are returned." - }, - "state" : { - "type" : "array", - "description" : "The state.", - "items" : { - "$ref" : "#/definitions/StateEntryDTO" - } - } - } - }, - "StatusDescriptorDTO" : { - "type" : "object", - "properties" : { - "field" : { - "type" : "string", - "description" : "The name of the status field." - }, - "label" : { - "type" : "string", - "description" : "The label for the status field." - }, - "description" : { - "type" : "string", - "description" : "The description of the status field." - }, - "formatter" : { - "type" : "string", - "description" : "The formatter for the status descriptor." - } - } - }, - "StatusHistoryDTO" : { - "type" : "object", - "properties" : { - "generated" : { - "type" : "string", - "description" : "When the status history was generated." - }, - "componentDetails" : { - "type" : "object", - "description" : "A Map of key/value pairs that describe the component that the status history belongs to", - "additionalProperties" : { - "type" : "string" - } - }, - "fieldDescriptors" : { - "type" : "array", - "description" : "The Descriptors that provide information on each of the metrics provided in the status history", - "items" : { - "$ref" : "#/definitions/StatusDescriptorDTO" - } - }, - "aggregateSnapshots" : { - "type" : "array", - "description" : "A list of StatusSnapshotDTO objects that provide the actual metric values for the component. If the NiFi instance is clustered, this will represent the aggregate status across all nodes. If the NiFi instance is not clustered, this will represent the status of the entire NiFi instance.", - "items" : { - "$ref" : "#/definitions/StatusSnapshotDTO" - } - }, - "nodeSnapshots" : { - "type" : "array", - "description" : "The NodeStatusSnapshotsDTO objects that provide the actual metric values for the component, for each node. If the NiFi instance is not clustered, this value will be null.", - "items" : { - "$ref" : "#/definitions/NodeStatusSnapshotsDTO" - } - } - } - }, - "StatusHistoryEntity" : { - "type" : "object", - "properties" : { - "statusHistory" : { - "$ref" : "#/definitions/StatusHistoryDTO" - }, - "canRead" : { - "type" : "boolean", - "description" : "Indicates whether the user can read a given resource.", - "readOnly" : true - } - }, - "xml" : { - "name" : "statusHistoryEntity" - } - }, - "StatusSnapshotDTO" : { - "type" : "object", - "properties" : { - "timestamp" : { - "type" : "string", - "format" : "date-time", - "description" : "The timestamp of the snapshot." - }, - "statusMetrics" : { - "type" : "object", - "description" : "The status metrics.", - "additionalProperties" : { - "type" : "integer", - "format" : "int64" - } - } - } - }, - "StorageUsageDTO" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The identifier of this storage location. The identifier will correspond to the identifier keyed in the storage configuration." - }, - "freeSpace" : { - "type" : "string", - "description" : "Amount of free space." - }, - "totalSpace" : { - "type" : "string", - "description" : "Amount of total space." - }, - "usedSpace" : { - "type" : "string", - "description" : "Amount of used space." - }, - "freeSpaceBytes" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes of free space." - }, - "totalSpaceBytes" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes of total space." - }, - "usedSpaceBytes" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes of used space." - }, - "utilization" : { - "type" : "string", - "description" : "Utilization of this storage location." - } - } - }, - "StreamingOutput" : { - "type" : "object" - }, - "SubmitReplayRequestEntity" : { - "type" : "object", - "properties" : { - "eventId" : { - "type" : "integer", - "format" : "int64", - "description" : "The event identifier" - }, - "clusterNodeId" : { - "type" : "string", - "description" : "The identifier of the node where to submit the replay request." - } - }, - "xml" : { - "name" : "copySnippetRequestEntity" - } - }, - "SystemDiagnosticsDTO" : { - "type" : "object", - "properties" : { - "aggregateSnapshot" : { - "description" : "A systems diagnostic snapshot that represents the aggregate values of all nodes in the cluster. If the NiFi instance is a standalone instance, rather than a cluster, this represents the stats of the single instance.", - "$ref" : "#/definitions/SystemDiagnosticsSnapshotDTO" - }, - "nodeSnapshots" : { - "type" : "array", - "description" : "A systems diagnostics snapshot for each node in the cluster. If the NiFi instance is a standalone instance, rather than a cluster, this may be null.", - "items" : { - "$ref" : "#/definitions/NodeSystemDiagnosticsSnapshotDTO" - } - } - } - }, - "SystemDiagnosticsEntity" : { - "type" : "object", - "properties" : { - "systemDiagnostics" : { - "$ref" : "#/definitions/SystemDiagnosticsDTO" - } - }, - "xml" : { - "name" : "systemDiagnosticsEntity" - } - }, - "SystemDiagnosticsSnapshotDTO" : { - "type" : "object", - "properties" : { - "totalNonHeap" : { - "type" : "string", - "description" : "Total size of non heap." - }, - "totalNonHeapBytes" : { - "type" : "integer", - "format" : "int64", - "description" : "Total number of bytes allocated to the JVM not used for heap" - }, - "usedNonHeap" : { - "type" : "string", - "description" : "Amount of use non heap." - }, - "usedNonHeapBytes" : { - "type" : "integer", - "format" : "int64", - "description" : "Total number of bytes used by the JVM not in the heap space" - }, - "freeNonHeap" : { - "type" : "string", - "description" : "Amount of free non heap." - }, - "freeNonHeapBytes" : { - "type" : "integer", - "format" : "int64", - "description" : "Total number of free non-heap bytes available to the JVM" - }, - "maxNonHeap" : { - "type" : "string", - "description" : "Maximum size of non heap." - }, - "maxNonHeapBytes" : { - "type" : "integer", - "format" : "int64", - "description" : "The maximum number of bytes that the JVM can use for non-heap purposes" - }, - "nonHeapUtilization" : { - "type" : "string", - "description" : "Utilization of non heap." - }, - "totalHeap" : { - "type" : "string", - "description" : "Total size of heap." - }, - "totalHeapBytes" : { - "type" : "integer", - "format" : "int64", - "description" : "The total number of bytes that are available for the JVM heap to use" - }, - "usedHeap" : { - "type" : "string", - "description" : "Amount of used heap." - }, - "usedHeapBytes" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes of JVM heap that are currently being used" - }, - "freeHeap" : { - "type" : "string", - "description" : "Amount of free heap." - }, - "freeHeapBytes" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes that are allocated to the JVM heap but not currently being used" - }, - "maxHeap" : { - "type" : "string", - "description" : "Maximum size of heap." - }, - "maxHeapBytes" : { - "type" : "integer", - "format" : "int64", - "description" : "The maximum number of bytes that can be used by the JVM" - }, - "heapUtilization" : { - "type" : "string", - "description" : "Utilization of heap." - }, - "availableProcessors" : { - "type" : "integer", - "format" : "int32", - "description" : "Number of available processors if supported by the underlying system." - }, - "processorLoadAverage" : { - "type" : "number", - "format" : "double", - "description" : "The processor load average if supported by the underlying system." - }, - "totalThreads" : { - "type" : "integer", - "format" : "int32", - "description" : "Total number of threads." - }, - "daemonThreads" : { - "type" : "integer", - "format" : "int32", - "description" : "Number of daemon threads." - }, - "uptime" : { - "type" : "string", - "description" : "The uptime of the Java virtual machine" - }, - "flowFileRepositoryStorageUsage" : { - "description" : "The flowfile repository storage usage.", - "$ref" : "#/definitions/StorageUsageDTO" - }, - "contentRepositoryStorageUsage" : { - "type" : "array", - "description" : "The content repository storage usage.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/StorageUsageDTO" - } - }, - "provenanceRepositoryStorageUsage" : { - "type" : "array", - "description" : "The provenance repository storage usage.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/StorageUsageDTO" - } - }, - "garbageCollection" : { - "type" : "array", - "description" : "The garbage collection details.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/GarbageCollectionDTO" - } - }, - "statsLastRefreshed" : { - "type" : "string", - "description" : "When the diagnostics were generated." - }, - "versionInfo" : { - "description" : "The nifi, os, java, and build version information", - "$ref" : "#/definitions/VersionInfoDTO" - } - } - }, - "TemplateDTO" : { - "type" : "object", - "properties" : { - "uri" : { - "type" : "string", - "description" : "The URI for the template." - }, - "id" : { - "type" : "string", - "description" : "The id of the template." - }, - "groupId" : { - "type" : "string", - "description" : "The id of the Process Group that the template belongs to." - }, - "name" : { - "type" : "string", - "description" : "The name of the template." - }, - "description" : { - "type" : "string", - "description" : "The description of the template." - }, - "timestamp" : { - "type" : "string", - "description" : "The timestamp when this template was created." - }, - "encodingVersion" : { - "type" : "string", - "xml" : { - "name" : "encoding-version", - "attribute" : true - }, - "description" : "The encoding version of this template." - }, - "snippet" : { - "description" : "The contents of the template.", - "$ref" : "#/definitions/FlowSnippetDTO" - } - }, - "xml" : { - "name" : "template" - } - }, - "TemplateEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "template" : { - "$ref" : "#/definitions/TemplateDTO" - } - }, - "xml" : { - "name" : "templateEntity" - } - }, - "TemplatesEntity" : { - "type" : "object", - "properties" : { - "templates" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/TemplateEntity" - } - }, - "generated" : { - "type" : "string", - "description" : "When this content was generated." - } - }, - "xml" : { - "name" : "templatesEntity" - } - }, - "TenantDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "versionedComponentId" : { - "type" : "string", - "description" : "The ID of the corresponding component that is under version control" - }, - "parentGroupId" : { - "type" : "string", - "description" : "The id of parent process group of this component if applicable." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "identity" : { - "type" : "string", - "description" : "The identity of the tenant." - }, - "configurable" : { - "type" : "boolean", - "description" : "Whether this tenant is configurable." - } - } - }, - "TenantEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "component" : { - "$ref" : "#/definitions/TenantDTO" - } - }, - "xml" : { - "name" : "tenantEntity" - } - }, - "TenantsEntity" : { - "type" : "object", - "properties" : { - "users" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/TenantEntity" - } - }, - "userGroups" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/TenantEntity" - } - } - }, - "xml" : { - "name" : "tenantsEntity" - } - }, - "TransactionResultEntity" : { - "type" : "object", - "properties" : { - "flowFileSent" : { - "type" : "integer", - "format" : "int32" - }, - "responseCode" : { - "type" : "integer", - "format" : "int32" - }, - "message" : { - "type" : "string" - } - }, - "xml" : { - "name" : "transactionResultEntity" - } - }, - "UpdateControllerServiceReferenceRequestEntity" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The identifier of the Controller Service." - }, - "state" : { - "type" : "string", - "description" : "The new state of the references for the controller service.", - "enum" : [ "ENABLED", "DISABLED", "RUNNING", "STOPPED" ] - }, - "referencingComponentRevisions" : { - "type" : "object", - "description" : "The revisions for all referencing components.", - "additionalProperties" : { - "$ref" : "#/definitions/RevisionDTO" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - } - }, - "xml" : { - "name" : "updateControllerServiceReferenceRequestEntity" - } - }, - "UserDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "versionedComponentId" : { - "type" : "string", - "description" : "The ID of the corresponding component that is under version control" - }, - "parentGroupId" : { - "type" : "string", - "description" : "The id of parent process group of this component if applicable." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "identity" : { - "type" : "string", - "description" : "The identity of the tenant." - }, - "configurable" : { - "type" : "boolean", - "description" : "Whether this tenant is configurable." - }, - "userGroups" : { - "type" : "array", - "description" : "The groups to which the user belongs. This field is read only and it provided for convenience.", - "readOnly" : true, - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/TenantEntity" - } - }, - "accessPolicies" : { - "type" : "array", - "description" : "The access policies this user belongs to.", - "readOnly" : true, - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/AccessPolicySummaryEntity" - } - } - } - }, - "UserEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "component" : { - "$ref" : "#/definitions/UserDTO" - } - }, - "xml" : { - "name" : "userEntity" - } - }, - "UserGroupDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "versionedComponentId" : { - "type" : "string", - "description" : "The ID of the corresponding component that is under version control" - }, - "parentGroupId" : { - "type" : "string", - "description" : "The id of parent process group of this component if applicable." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "identity" : { - "type" : "string", - "description" : "The identity of the tenant." - }, - "configurable" : { - "type" : "boolean", - "description" : "Whether this tenant is configurable." - }, - "users" : { - "type" : "array", - "description" : "The users that belong to the user group.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/TenantEntity" - } - }, - "accessPolicies" : { - "type" : "array", - "description" : "The access policies this user group belongs to. This field was incorrectly defined as an AccessPolicyEntity. For compatibility reasons the field will remain of this type, however only the fields that are present in the AccessPolicySummaryEntity will be populated here.", - "readOnly" : true, - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/AccessPolicyEntity" - } - } - } - }, - "UserGroupEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "component" : { - "$ref" : "#/definitions/UserGroupDTO" - } - }, - "xml" : { - "name" : "userGroupEntity" - } - }, - "UserGroupsEntity" : { - "type" : "object", - "properties" : { - "userGroups" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/UserGroupEntity" - } - } - }, - "xml" : { - "name" : "userGroupsEntity" - } - }, - "UsersEntity" : { - "type" : "object", - "properties" : { - "generated" : { - "type" : "string", - "description" : "When this content was generated." - }, - "users" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/UserEntity" - } - } - }, - "xml" : { - "name" : "usersEntity" - } - }, - "VariableDTO" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The name of the variable" - }, - "value" : { - "type" : "string", - "description" : "The value of the variable" - }, - "processGroupId" : { - "type" : "string", - "description" : "The ID of the Process Group where this Variable is defined", - "readOnly" : true - }, - "affectedComponents" : { - "type" : "array", - "description" : "A set of all components that will be affected if the value of this variable is changed", - "readOnly" : true, - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/AffectedComponentEntity" - } - } - } - }, - "VariableEntity" : { - "type" : "object", - "properties" : { - "variable" : { - "description" : "The variable information", - "$ref" : "#/definitions/VariableDTO" - }, - "canWrite" : { - "type" : "boolean", - "description" : "Indicates whether the user can write a given resource.", - "readOnly" : true - } - }, - "xml" : { - "name" : "variableEntity" - } - }, - "VariableRegistryDTO" : { - "type" : "object", - "properties" : { - "variables" : { - "type" : "array", - "description" : "The variables that are available in this Variable Registry", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VariableEntity" - } - }, - "processGroupId" : { - "type" : "string", - "description" : "The UUID of the Process Group that this Variable Registry belongs to" - } - } - }, - "VariableRegistryEntity" : { - "type" : "object", - "properties" : { - "processGroupRevision" : { - "description" : "The revision of the Process Group that the Variable Registry belongs to", - "$ref" : "#/definitions/RevisionDTO" - }, - "variableRegistry" : { - "description" : "The Variable Registry.", - "$ref" : "#/definitions/VariableRegistryDTO" - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - } - }, - "xml" : { - "name" : "variableRegistryEntity" - } - }, - "VariableRegistryUpdateRequestDTO" : { - "type" : "object", - "properties" : { - "requestId" : { - "type" : "string", - "description" : "The ID of the request", - "readOnly" : true - }, - "uri" : { - "type" : "string", - "description" : "The URI for the request", - "readOnly" : true - }, - "submissionTime" : { - "type" : "string", - "format" : "date-time", - "description" : "The timestamp of when the request was submitted", - "readOnly" : true - }, - "lastUpdated" : { - "type" : "string", - "format" : "date-time", - "description" : "The timestamp of when the request was last updated", - "readOnly" : true - }, - "complete" : { - "type" : "boolean", - "description" : "Whether or not the request is completed", - "readOnly" : true - }, - "failureReason" : { - "type" : "string", - "description" : "The reason for the request failing, or null if the request has not failed", - "readOnly" : true - }, - "percentCompleted" : { - "type" : "integer", - "format" : "int32", - "description" : "A value between 0 and 100 (inclusive) indicating how close the request is to completion", - "readOnly" : true - }, - "state" : { - "type" : "string", - "description" : "A description of the current state of the request", - "readOnly" : true - }, - "updateSteps" : { - "type" : "array", - "description" : "The steps that are required in order to complete the request, along with the status of each", - "readOnly" : true, - "items" : { - "$ref" : "#/definitions/VariableRegistryUpdateStepDTO" - } - }, - "processGroupId" : { - "type" : "string", - "description" : "The unique ID of the Process Group that the variable registry belongs to" - }, - "affectedComponents" : { - "type" : "array", - "description" : "A set of all components that will be affected if the value of this variable is changed", - "readOnly" : true, - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/AffectedComponentEntity" - } - } - } - }, - "VariableRegistryUpdateRequestEntity" : { - "type" : "object", - "properties" : { - "request" : { - "description" : "The Variable Registry Update Request", - "$ref" : "#/definitions/VariableRegistryUpdateRequestDTO" - }, - "processGroupRevision" : { - "description" : "The revision for the Process Group that owns this variable registry.", - "$ref" : "#/definitions/RevisionDTO" - } - }, - "xml" : { - "name" : "variableRegistryUpdateRequestEntity" - } - }, - "VariableRegistryUpdateStepDTO" : { - "type" : "object", - "properties" : { - "description" : { - "type" : "string", - "description" : "Explanation of what happens in this step", - "readOnly" : true - }, - "complete" : { - "type" : "boolean", - "description" : "Whether or not this step has completed", - "readOnly" : true - }, - "failureReason" : { - "type" : "string", - "description" : "An explanation of why this step failed, or null if this step did not fail", - "readOnly" : true - } - } - }, - "VersionControlComponentMappingEntity" : { - "type" : "object", - "properties" : { - "versionControlComponentMapping" : { - "type" : "object", - "description" : "The mapping of Versioned Component Identifiers to instance ID's", - "additionalProperties" : { - "type" : "string" - } - }, - "processGroupRevision" : { - "description" : "The revision of the Process Group", - "$ref" : "#/definitions/RevisionDTO" - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "versionControlInformation" : { - "description" : "The Version Control information", - "$ref" : "#/definitions/VersionControlInformationDTO" - } - }, - "xml" : { - "name" : "versionControlComponentMappingEntity" - } - }, - "VersionControlInformationDTO" : { - "type" : "object", - "properties" : { - "groupId" : { - "type" : "string", - "description" : "The ID of the Process Group that is under version control" - }, - "registryId" : { - "type" : "string", - "description" : "The ID of the registry that the flow is stored in" - }, - "registryName" : { - "type" : "string", - "description" : "The name of the registry that the flow is stored in", - "readOnly" : true - }, - "bucketId" : { - "type" : "string", - "description" : "The ID of the bucket that the flow is stored in" - }, - "bucketName" : { - "type" : "string", - "description" : "The name of the bucket that the flow is stored in", - "readOnly" : true - }, - "flowId" : { - "type" : "string", - "description" : "The ID of the flow" - }, - "flowName" : { - "type" : "string", - "description" : "The name of the flow" - }, - "flowDescription" : { - "type" : "string", - "description" : "The description of the flow" - }, - "version" : { - "type" : "integer", - "format" : "int32", - "description" : "The version of the flow" - }, - "state" : { - "type" : "string", - "description" : "The current state of the Process Group, as it relates to the Versioned Flow", - "readOnly" : true, - "enum" : [ "LOCALLY_MODIFIED", "STALE", "LOCALLY_MODIFIED_AND_STALE", "UP_TO_DATE", "SYNC_FAILURE" ] - }, - "stateExplanation" : { - "type" : "string", - "description" : "Explanation of why the group is in the specified state", - "readOnly" : true - } - } - }, - "VersionControlInformationEntity" : { - "type" : "object", - "properties" : { - "processGroupRevision" : { - "description" : "The Revision for the Process Group", - "$ref" : "#/definitions/RevisionDTO" - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "versionControlInformation" : { - "description" : "The Version Control information", - "$ref" : "#/definitions/VersionControlInformationDTO" - } - }, - "xml" : { - "name" : "versionControlInformationEntity" - } - }, - "VersionInfoDTO" : { - "type" : "object", - "properties" : { - "niFiVersion" : { - "type" : "string", - "description" : "The version of this NiFi." - }, - "javaVendor" : { - "type" : "string", - "description" : "Java JVM vendor" - }, - "javaVersion" : { - "type" : "string", - "description" : "Java version" - }, - "osName" : { - "type" : "string", - "description" : "Host operating system name" - }, - "osVersion" : { - "type" : "string", - "description" : "Host operating system version" - }, - "osArchitecture" : { - "type" : "string", - "description" : "Host operating system architecture" - }, - "buildTag" : { - "type" : "string", - "description" : "Build tag" - }, - "buildRevision" : { - "type" : "string", - "description" : "Build revision or commit hash" - }, - "buildBranch" : { - "type" : "string", - "description" : "Build branch" - }, - "buildTimestamp" : { - "type" : "string", - "format" : "date-time", - "description" : "Build timestamp" - } - } - }, - "VersionedConnection" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The component's unique identifier" - }, - "name" : { - "type" : "string", - "description" : "The component's name" - }, - "comments" : { - "type" : "string", - "description" : "The user-supplied comments for the component" - }, - "position" : { - "description" : "The component's position on the graph", - "$ref" : "#/definitions/Position" - }, - "source" : { - "description" : "The source of the connection.", - "$ref" : "#/definitions/ConnectableComponent" - }, - "destination" : { - "description" : "The destination of the connection.", - "$ref" : "#/definitions/ConnectableComponent" - }, - "labelIndex" : { - "type" : "integer", - "format" : "int32", - "description" : "The index of the bend point where to place the connection label." - }, - "zIndex" : { - "type" : "integer", - "format" : "int64", - "description" : "The z index of the connection." - }, - "selectedRelationships" : { - "type" : "array", - "description" : "The selected relationship that comprise the connection.", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - }, - "backPressureObjectThreshold" : { - "type" : "integer", - "format" : "int64", - "description" : "The object count threshold for determining when back pressure is applied. Updating this value is a passive change in the sense that it won't impact whether existing files over the limit are affected but it does help feeder processors to stop pushing too much into this work queue." - }, - "backPressureDataSizeThreshold" : { - "type" : "string", - "description" : "The object data size threshold for determining when back pressure is applied. Updating this value is a passive change in the sense that it won't impact whether existing files over the limit are affected but it does help feeder processors to stop pushing too much into this work queue." - }, - "flowFileExpiration" : { - "type" : "string", - "description" : "The amount of time a flow file may be in the flow before it will be automatically aged out of the flow. Once a flow file reaches this age it will be terminated from the flow the next time a processor attempts to start work on it." - }, - "prioritizers" : { - "type" : "array", - "description" : "The comparators used to prioritize the queue.", - "items" : { - "type" : "string" - } - }, - "bends" : { - "type" : "array", - "description" : "The bend points on the connection.", - "items" : { - "$ref" : "#/definitions/Position" - } - }, - "loadBalanceStrategy" : { - "type" : "string", - "description" : "The Strategy to use for load balancing data across the cluster, or null, if no Load Balance Strategy has been specified.", - "enum" : [ "DO_NOT_LOAD_BALANCE", "PARTITION_BY_ATTRIBUTE", "ROUND_ROBIN", "SINGLE_NODE" ] - }, - "partitioningAttribute" : { - "type" : "string", - "description" : "The attribute to use for partitioning data as it is load balanced across the cluster. If the Load Balance Strategy is configured to use PARTITION_BY_ATTRIBUTE, the value returned by this method is the name of the FlowFile Attribute that will be used to determine which node in the cluster should receive a given FlowFile. If the Load Balance Strategy is unset or is set to any other value, the Partitioning Attribute has no effect." - }, - "loadBalanceCompression" : { - "type" : "string", - "description" : "Whether or not compression should be used when transferring FlowFiles between nodes", - "enum" : [ "DO_NOT_COMPRESS", "COMPRESS_ATTRIBUTES_ONLY", "COMPRESS_ATTRIBUTES_AND_CONTENT" ] - }, - "componentType" : { - "type" : "string", - "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE" ] - }, - "groupIdentifier" : { - "type" : "string", - "description" : "The ID of the Process Group that this component belongs to" - } - } - }, - "VersionedControllerService" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The component's unique identifier" - }, - "name" : { - "type" : "string", - "description" : "The component's name" - }, - "comments" : { - "type" : "string", - "description" : "The user-supplied comments for the component" - }, - "position" : { - "description" : "The component's position on the graph", - "$ref" : "#/definitions/Position" - }, - "type" : { - "type" : "string", - "description" : "The type of the controller service." - }, - "bundle" : { - "description" : "The details of the artifact that bundled this processor type.", - "$ref" : "#/definitions/Bundle" - }, - "controllerServiceApis" : { - "type" : "array", - "description" : "Lists the APIs this Controller Service implements.", - "items" : { - "$ref" : "#/definitions/ControllerServiceAPI" - } - }, - "properties" : { - "type" : "object", - "description" : "The properties of the controller service.", - "additionalProperties" : { - "type" : "string" - } - }, - "propertyDescriptors" : { - "type" : "object", - "description" : "The property descriptors for the processor.", - "additionalProperties" : { - "$ref" : "#/definitions/VersionedPropertyDescriptor" - } - }, - "annotationData" : { - "type" : "string", - "description" : "The annotation for the controller service. This is how the custom UI relays configuration to the controller service." - }, - "componentType" : { - "type" : "string", - "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE" ] - }, - "groupIdentifier" : { - "type" : "string", - "description" : "The ID of the Process Group that this component belongs to" - } - } - }, - "VersionedFlow" : { - "type" : "object", - "required" : [ "bucketIdentifier", "name", "type" ], - "properties" : { - "link" : { - "description" : "An WebLink to this entity.", - "readOnly" : true, - "$ref" : "#/definitions/JaxbLink" - }, - "identifier" : { - "type" : "string", - "description" : "An ID to uniquely identify this object.", - "readOnly" : true - }, - "name" : { - "type" : "string", - "description" : "The name of the item." - }, - "description" : { - "type" : "string", - "description" : "A description of the item." - }, - "bucketIdentifier" : { - "type" : "string", - "description" : "The identifier of the bucket this items belongs to. This cannot be changed after the item is created." - }, - "bucketName" : { - "type" : "string", - "description" : "The name of the bucket this items belongs to.", - "readOnly" : true - }, - "createdTimestamp" : { - "type" : "integer", - "format" : "int64", - "description" : "The timestamp of when the item was created, as milliseconds since epoch.", - "readOnly" : true, - "minimum" : 1 - }, - "modifiedTimestamp" : { - "type" : "integer", - "format" : "int64", - "description" : "The timestamp of when the item was last modified, as milliseconds since epoch.", - "readOnly" : true, - "minimum" : 1 - }, - "type" : { - "type" : "string", - "description" : "The type of item.", - "enum" : [ "Flow", "Bundle" ] - }, - "permissions" : { - "description" : "The access that the current user has to the bucket containing this item.", - "readOnly" : true, - "$ref" : "#/definitions/Permissions" - }, - "versionCount" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of versions of this flow.", - "readOnly" : true, - "minimum" : 0 - }, - "revision" : { - "description" : "The revision of this entity used for optimistic-locking during updates.", - "readOnly" : true, - "$ref" : "#/definitions/RevisionInfo" - } - } - }, - "VersionedFlowCoordinates" : { - "type" : "object", - "properties" : { - "registryUrl" : { - "type" : "string", - "description" : "The URL of the Flow Registry that contains the flow" - }, - "bucketId" : { - "type" : "string", - "description" : "The UUID of the bucket that the flow resides in" - }, - "flowId" : { - "type" : "string", - "description" : "The UUID of the flow" - }, - "version" : { - "type" : "integer", - "format" : "int32", - "description" : "The version of the flow" - }, - "latest" : { - "type" : "boolean", - "description" : "Whether or not these coordinates point to the latest version of the flow" - } - } - }, - "VersionedFlowDTO" : { - "type" : "object", - "properties" : { - "registryId" : { - "type" : "string", - "description" : "The ID of the registry that the flow is tracked to" - }, - "bucketId" : { - "type" : "string", - "description" : "The ID of the bucket where the flow is stored" - }, - "flowId" : { - "type" : "string", - "description" : "The ID of the flow" - }, - "flowName" : { - "type" : "string", - "description" : "The name of the flow" - }, - "description" : { - "type" : "string", - "description" : "A description of the flow" - }, - "comments" : { - "type" : "string", - "description" : "Comments for the changeset" - }, - "action" : { - "type" : "string", - "description" : "The action being performed", - "enum" : [ "COMMIT", "FORCE_COMMIT" ] - } - } - }, - "VersionedFlowEntity" : { - "type" : "object", - "properties" : { - "versionedFlow" : { - "description" : "The versioned flow", - "$ref" : "#/definitions/VersionedFlowDTO" - } - }, - "xml" : { - "name" : "versionedFlowEntity" - } - }, - "VersionedFlowSnapshot" : { - "type" : "object", - "required" : [ "flowContents", "snapshotMetadata" ], - "properties" : { - "snapshotMetadata" : { - "description" : "The metadata for this snapshot", - "$ref" : "#/definitions/VersionedFlowSnapshotMetadata" - }, - "flowContents" : { - "description" : "The contents of the versioned flow", - "$ref" : "#/definitions/VersionedProcessGroup" - }, - "externalControllerServices" : { - "type" : "object", - "description" : "The information about controller services that exist outside this versioned flow, but are referenced by components within the versioned flow.", - "additionalProperties" : { - "$ref" : "#/definitions/ExternalControllerServiceReference" - } - }, - "parameterContexts" : { - "type" : "object", - "description" : "The parameter contexts referenced by process groups in the flow contents. The mapping is from the name of the context to the context instance, and it is expected that any context in this map is referenced by at least one process group in this flow.", - "additionalProperties" : { - "$ref" : "#/definitions/VersionedParameterContext" - } - }, - "flowEncodingVersion" : { - "type" : "string", - "description" : "The optional encoding version of the flow contents." - }, - "flow" : { - "description" : "The flow this snapshot is for", - "readOnly" : true, - "$ref" : "#/definitions/VersionedFlow" - }, - "bucket" : { - "description" : "The bucket where the flow is located", - "readOnly" : true, - "$ref" : "#/definitions/Bucket" - }, - "latest" : { - "type" : "boolean" - } - } - }, - "VersionedFlowSnapshotEntity" : { - "type" : "object", - "properties" : { - "versionedFlowSnapshot" : { - "description" : "The versioned flow snapshot", - "$ref" : "#/definitions/VersionedFlowSnapshot" - }, - "processGroupRevision" : { - "description" : "The Revision of the Process Group under Version Control", - "$ref" : "#/definitions/RevisionDTO" - }, - "registryId" : { - "type" : "string", - "description" : "The ID of the Registry that this flow belongs to" - }, - "updateDescendantVersionedFlows" : { - "type" : "boolean", - "description" : "If the Process Group to be updated has a child or descendant Process Group that is also under Version Control, this specifies whether or not the contents of that child/descendant Process Group should be updated." - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - } - }, - "xml" : { - "name" : "versionedFlowSnapshotEntity" - } - }, - "VersionedFlowSnapshotMetadata" : { - "type" : "object", - "required" : [ "bucketIdentifier", "flowIdentifier", "version" ], - "properties" : { - "link" : { - "description" : "An WebLink to this entity.", - "readOnly" : true, - "$ref" : "#/definitions/JaxbLink" - }, - "bucketIdentifier" : { - "type" : "string", - "description" : "The identifier of the bucket this snapshot belongs to." - }, - "flowIdentifier" : { - "type" : "string", - "description" : "The identifier of the flow this snapshot belongs to." - }, - "version" : { - "type" : "integer", - "format" : "int32", - "description" : "The version of this snapshot of the flow.", - "minimum" : -1 - }, - "timestamp" : { - "type" : "integer", - "format" : "int64", - "description" : "The timestamp when the flow was saved, as milliseconds since epoch.", - "readOnly" : true, - "minimum" : 1 - }, - "author" : { - "type" : "string", - "description" : "The user that created this snapshot of the flow.", - "readOnly" : true - }, - "comments" : { - "type" : "string", - "description" : "The comments provided by the user when creating the snapshot." - } - } - }, - "VersionedFlowSnapshotMetadataEntity" : { - "type" : "object", - "properties" : { - "versionedFlowSnapshotMetadata" : { - "description" : "The collection of versioned flow snapshot metadata", - "$ref" : "#/definitions/VersionedFlowSnapshotMetadata" - }, - "registryId" : { - "type" : "string", - "description" : "The ID of the Registry that this flow belongs to" - } - }, - "xml" : { - "name" : "versionedFlowSnapshotMetadataEntity" - } - }, - "VersionedFlowSnapshotMetadataSetEntity" : { - "type" : "object", - "properties" : { - "versionedFlowSnapshotMetadataSet" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedFlowSnapshotMetadataEntity" - } - } - }, - "xml" : { - "name" : "versionedFlowSnapshotMetadataSetEntity" - } - }, - "VersionedFlowUpdateRequestDTO" : { - "type" : "object", - "properties" : { - "requestId" : { - "type" : "string", - "description" : "The unique ID of this request.", - "readOnly" : true - }, - "processGroupId" : { - "type" : "string", - "description" : "The unique ID of the Process Group being updated" - }, - "uri" : { - "type" : "string", - "description" : "The URI for future requests to this drop request.", - "readOnly" : true - }, - "lastUpdated" : { - "type" : "string", - "description" : "The last time this request was updated.", - "readOnly" : true - }, - "complete" : { - "type" : "boolean", - "description" : "Whether or not this request has completed", - "readOnly" : true - }, - "failureReason" : { - "type" : "string", - "description" : "An explanation of why this request failed, or null if this request has not failed", - "readOnly" : true - }, - "percentCompleted" : { - "type" : "integer", - "format" : "int32", - "description" : "The percentage complete for the request, between 0 and 100", - "readOnly" : true - }, - "state" : { - "type" : "string", - "description" : "The state of the request", - "readOnly" : true - }, - "versionControlInformation" : { - "description" : "The VersionControlInformation that describes where the Versioned Flow is located; this may not be populated until the request is completed.", - "readOnly" : true, - "$ref" : "#/definitions/VersionControlInformationDTO" - } - } - }, - "VersionedFlowUpdateRequestEntity" : { - "type" : "object", - "properties" : { - "processGroupRevision" : { - "description" : "The revision for the Process Group being updated.", - "$ref" : "#/definitions/RevisionDTO" - }, - "request" : { - "description" : "The Flow Update Request", - "$ref" : "#/definitions/VersionedFlowUpdateRequestDTO" - } - }, - "xml" : { - "name" : "versionedFlowUpdateRequestEntity" - } - }, - "VersionedFlowsEntity" : { - "type" : "object", - "properties" : { - "versionedFlows" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedFlowEntity" - } - } - }, - "xml" : { - "name" : "versionedFlowsEntity" - } - }, - "VersionedFunnel" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The component's unique identifier" - }, - "name" : { - "type" : "string", - "description" : "The component's name" - }, - "comments" : { - "type" : "string", - "description" : "The user-supplied comments for the component" - }, - "position" : { - "description" : "The component's position on the graph", - "$ref" : "#/definitions/Position" - }, - "componentType" : { - "type" : "string", - "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE" ] - }, - "groupIdentifier" : { - "type" : "string", - "description" : "The ID of the Process Group that this component belongs to" - } - } - }, - "VersionedLabel" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The component's unique identifier" - }, - "name" : { - "type" : "string", - "description" : "The component's name" - }, - "comments" : { - "type" : "string", - "description" : "The user-supplied comments for the component" - }, - "position" : { - "description" : "The component's position on the graph", - "$ref" : "#/definitions/Position" - }, - "label" : { - "type" : "string", - "description" : "The text that appears in the label." - }, - "width" : { - "type" : "number", - "format" : "double", - "description" : "The width of the label in pixels when at a 1:1 scale." - }, - "height" : { - "type" : "number", - "format" : "double", - "description" : "The height of the label in pixels when at a 1:1 scale." - }, - "style" : { - "type" : "object", - "description" : "The styles for this label (font-size : 12px, background-color : #eee, etc).", - "additionalProperties" : { - "type" : "string" - } - }, - "componentType" : { - "type" : "string", - "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE" ] - }, - "groupIdentifier" : { - "type" : "string", - "description" : "The ID of the Process Group that this component belongs to" - } - } - }, - "VersionedParameter" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The name of the parameter" - }, - "description" : { - "type" : "string", - "description" : "The description of the param" - }, - "sensitive" : { - "type" : "boolean", - "description" : "Whether or not the parameter value is sensitive" - }, - "value" : { - "type" : "string", - "description" : "The value of the parameter" - } - } - }, - "VersionedParameterContext" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The name of the context" - }, - "description" : { - "type" : "string", - "description" : "The description of the parameter context" - }, - "parameters" : { - "type" : "array", - "description" : "The parameters in the context", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedParameter" - } - } - } - }, - "VersionedPort" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The component's unique identifier" - }, - "name" : { - "type" : "string", - "description" : "The component's name" - }, - "comments" : { - "type" : "string", - "description" : "The user-supplied comments for the component" - }, - "position" : { - "description" : "The component's position on the graph", - "$ref" : "#/definitions/Position" - }, - "type" : { - "type" : "string", - "description" : "The type of port.", - "enum" : [ "INPUT_PORT", "OUTPUT_PORT" ] - }, - "concurrentlySchedulableTaskCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of tasks that should be concurrently scheduled for the port." - }, - "scheduledState" : { - "type" : "string", - "description" : "The scheduled state of the component", - "enum" : [ "ENABLED", "DISABLED" ] - }, - "allowRemoteAccess" : { - "type" : "boolean", - "description" : "Whether or not this port allows remote access for site-to-site" - }, - "componentType" : { - "type" : "string", - "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE" ] - }, - "groupIdentifier" : { - "type" : "string", - "description" : "The ID of the Process Group that this component belongs to" - } - } - }, - "VersionedProcessGroup" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The component's unique identifier" - }, - "name" : { - "type" : "string", - "description" : "The component's name" - }, - "comments" : { - "type" : "string", - "description" : "The user-supplied comments for the component" - }, - "position" : { - "description" : "The component's position on the graph", - "$ref" : "#/definitions/Position" - }, - "processGroups" : { - "type" : "array", - "description" : "The child Process Groups", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedProcessGroup" - } - }, - "remoteProcessGroups" : { - "type" : "array", - "description" : "The Remote Process Groups", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedRemoteProcessGroup" - } - }, - "processors" : { - "type" : "array", - "description" : "The Processors", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedProcessor" - } - }, - "inputPorts" : { - "type" : "array", - "description" : "The Input Ports", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedPort" - } - }, - "outputPorts" : { - "type" : "array", - "description" : "The Output Ports", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedPort" - } - }, - "connections" : { - "type" : "array", - "description" : "The Connections", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedConnection" - } - }, - "labels" : { - "type" : "array", - "description" : "The Labels", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedLabel" - } - }, - "funnels" : { - "type" : "array", - "description" : "The Funnels", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedFunnel" - } - }, - "controllerServices" : { - "type" : "array", - "description" : "The Controller Services", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedControllerService" - } - }, - "versionedFlowCoordinates" : { - "description" : "The coordinates where the remote flow is stored, or null if the Process Group is not directly under Version Control", - "$ref" : "#/definitions/VersionedFlowCoordinates" - }, - "variables" : { - "type" : "object", - "description" : "The Variables in the Variable Registry for this Process Group (not including any ancestor or descendant Process Groups)", - "additionalProperties" : { - "type" : "string" - } - }, - "parameterContextName" : { - "type" : "string", - "description" : "The name of the parameter context used by this process group" - }, - "flowFileConcurrency" : { - "type" : "string", - "description" : "The configured FlowFile Concurrency for the Process Group" - }, - "flowFileOutboundPolicy" : { - "type" : "string", - "description" : "The FlowFile Outbound Policy for the Process Group" - }, - "componentType" : { - "type" : "string", - "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE" ] - }, - "groupIdentifier" : { - "type" : "string", - "description" : "The ID of the Process Group that this component belongs to" - } - } - }, - "VersionedProcessor" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The component's unique identifier" - }, - "name" : { - "type" : "string", - "description" : "The component's name" - }, - "comments" : { - "type" : "string", - "description" : "The user-supplied comments for the component" - }, - "position" : { - "description" : "The component's position on the graph", - "$ref" : "#/definitions/Position" - }, - "bundle" : { - "description" : "Information about the bundle from which the component came", - "$ref" : "#/definitions/Bundle" - }, - "style" : { - "type" : "object", - "description" : "Stylistic data for rendering in a UI", - "additionalProperties" : { - "type" : "string" - } - }, - "type" : { - "type" : "string", - "description" : "The type of Processor" - }, - "properties" : { - "type" : "object", - "description" : "The properties for the processor. Properties whose value is not set will only contain the property name.", - "additionalProperties" : { - "type" : "string" - } - }, - "propertyDescriptors" : { - "type" : "object", - "description" : "The property descriptors for the processor.", - "additionalProperties" : { - "$ref" : "#/definitions/VersionedPropertyDescriptor" - } - }, - "annotationData" : { - "type" : "string", - "description" : "The annotation data for the processor used to relay configuration between a custom UI and the procesosr." - }, - "schedulingPeriod" : { - "type" : "string", - "description" : "The frequency with which to schedule the processor. The format of the value will depend on th value of schedulingStrategy." - }, - "schedulingStrategy" : { - "type" : "string", - "description" : "Indcates whether the prcessor should be scheduled to run in event or timer driven mode." - }, - "executionNode" : { - "type" : "string", - "description" : "Indicates the node where the process will execute." - }, - "penaltyDuration" : { - "type" : "string", - "description" : "The amout of time that is used when the process penalizes a flowfile." - }, - "yieldDuration" : { - "type" : "string", - "description" : "The amount of time that must elapse before this processor is scheduled again after yielding." - }, - "bulletinLevel" : { - "type" : "string", - "description" : "The level at which the processor will report bulletins." - }, - "runDurationMillis" : { - "type" : "integer", - "format" : "int64", - "description" : "The run duration for the processor in milliseconds." - }, - "concurrentlySchedulableTaskCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of tasks that should be concurrently schedule for the processor. If the processor doesn't allow parallol processing then any positive input will be ignored." - }, - "autoTerminatedRelationships" : { - "type" : "array", - "description" : "The names of all relationships that cause a flow file to be terminated if the relationship is not connected elsewhere. This property differs from the 'isAutoTerminate' property of the RelationshipDTO in that the RelationshipDTO is meant to depict the current configuration, whereas this property can be set in a DTO when updating a Processor in order to change which Relationships should be auto-terminated.", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - }, - "scheduledState" : { - "type" : "string", - "description" : "The scheduled state of the component", - "enum" : [ "ENABLED", "DISABLED" ] - }, - "componentType" : { - "type" : "string", - "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE" ] - }, - "groupIdentifier" : { - "type" : "string", - "description" : "The ID of the Process Group that this component belongs to" - } - } - }, - "VersionedPropertyDescriptor" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The name of the property" - }, - "displayName" : { - "type" : "string", - "description" : "The display name of the property" - }, - "identifiesControllerService" : { - "type" : "boolean", - "description" : "Whether or not the property provides the identifier of a Controller Service" - }, - "sensitive" : { - "type" : "boolean", - "description" : "Whether or not the property is considered sensitive" - } - } - }, - "VersionedRemoteGroupPort" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The component's unique identifier" - }, - "name" : { - "type" : "string", - "description" : "The component's name" - }, - "comments" : { - "type" : "string", - "description" : "The user-supplied comments for the component" - }, - "position" : { - "description" : "The component's position on the graph", - "$ref" : "#/definitions/Position" - }, - "remoteGroupId" : { - "type" : "string", - "description" : "The id of the remote process group that the port resides in." - }, - "concurrentlySchedulableTaskCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of task that may transmit flowfiles to the target port concurrently." - }, - "useCompression" : { - "type" : "boolean", - "description" : "Whether the flowfiles are compressed when sent to the target port." - }, - "batchSize" : { - "description" : "The batch settings for data transmission.", - "$ref" : "#/definitions/BatchSize" - }, - "componentType" : { - "type" : "string", - "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE" ] - }, - "targetId" : { - "type" : "string", - "description" : "The ID of the port on the target NiFi instance" - }, - "scheduledState" : { - "type" : "string", - "description" : "The scheduled state of the component", - "enum" : [ "ENABLED", "DISABLED" ] - }, - "groupIdentifier" : { - "type" : "string", - "description" : "The ID of the Process Group that this component belongs to" - } - } - }, - "VersionedRemoteProcessGroup" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The component's unique identifier" - }, - "name" : { - "type" : "string", - "description" : "The component's name" - }, - "comments" : { - "type" : "string", - "description" : "The user-supplied comments for the component" - }, - "position" : { - "description" : "The component's position on the graph", - "$ref" : "#/definitions/Position" - }, - "targetUri" : { - "type" : "string", - "description" : "[DEPRECATED] The target URI of the remote process group. If target uri is not set, but uris are set, then returns the first uri in the uris. If neither target uri nor uris are set, then returns null." - }, - "targetUris" : { - "type" : "string", - "description" : "The target URIs of the remote process group. If target uris is not set but target uri is set, then returns the single target uri. If neither target uris nor target uri is set, then returns null." - }, - "communicationsTimeout" : { - "type" : "string", - "description" : "The time period used for the timeout when communicating with the target." - }, - "yieldDuration" : { - "type" : "string", - "description" : "When yielding, this amount of time must elapse before the remote process group is scheduled again." - }, - "transportProtocol" : { - "type" : "string", - "description" : "The Transport Protocol that is used for Site-to-Site communications", - "enum" : [ "RAW", "HTTP" ] - }, - "localNetworkInterface" : { - "type" : "string", - "description" : "The local network interface to send/receive data. If not specified, any local address is used. If clustered, all nodes must have an interface with this identifier." - }, - "proxyHost" : { - "type" : "string" - }, - "proxyPort" : { - "type" : "integer", - "format" : "int32" - }, - "proxyUser" : { - "type" : "string" - }, - "inputPorts" : { - "type" : "array", - "description" : "A Set of Input Ports that can be connected to, in order to send data to the remote NiFi instance", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedRemoteGroupPort" - } - }, - "outputPorts" : { - "type" : "array", - "description" : "A Set of Output Ports that can be connected to, in order to pull data from the remote NiFi instance", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedRemoteGroupPort" - } - }, - "componentType" : { - "type" : "string", - "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE" ] - }, - "groupIdentifier" : { - "type" : "string", - "description" : "The ID of the Process Group that this component belongs to" - } - } - } - } -} diff --git a/resources/client_gen/api_defs/nifi-1.13.2.json b/resources/client_gen/api_defs/nifi-1.13.2.json deleted file mode 100644 index 9cdd3719..00000000 --- a/resources/client_gen/api_defs/nifi-1.13.2.json +++ /dev/null @@ -1,21611 +0,0 @@ -{ - "swagger" : "2.0", - "info" : { - "description" : "The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and \n stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description,\n definitions of the expected input and output, potential response codes, and the authorizations required\n to invoke each service.", - "version" : "1.13.3-SNAPSHOT", - "title" : "NiFi Rest Api", - "contact" : { - "url" : "https://nifi.apache.org", - "email" : "dev@nifi.apache.org" - }, - "license" : { - "name" : "Apache 2.0", - "url" : "http://www.apache.org/licenses/LICENSE-2.0.html" - } - }, - "basePath" : "/nifi-api", - "tags" : [ { - "name" : "access", - "description" : "Endpoints for obtaining an access token or checking access status." - }, { - "name" : "connections", - "description" : "Endpoint for managing a Connection." - }, { - "name" : "controller", - "description" : "Provides realtime command and control of this NiFi instance" - }, { - "name" : "controller-services", - "description" : "Endpoint for managing a Controller Service." - }, { - "name" : "counters", - "description" : "Endpoint for managing counters." - }, { - "name" : "data-transfer", - "description" : "Supports data transfers with this NiFi using HTTP based site to site" - }, { - "name" : "flow", - "description" : "Endpoint for accessing the flow structure and component status." - }, { - "name" : "flowfile-queues", - "description" : "Endpoint for managing a FlowFile Queue." - }, { - "name" : "funnel", - "description" : "Endpoint for managing a Funnel." - }, { - "name" : "input-ports", - "description" : "Endpoint for managing an Input Port." - }, { - "name" : "labels", - "description" : "Endpoint for managing a Label." - }, { - "name" : "output-ports", - "description" : "Endpoint for managing an Output Port." - }, { - "name" : "parameter-contexts", - "description" : "Endpoint for managing version control for a flow" - }, { - "name" : "policies", - "description" : "Endpoint for managing access policies." - }, { - "name" : "process-groups", - "description" : "Endpoint for managing a Process Group." - }, { - "name" : "processors", - "description" : "Endpoint for managing a Processor." - }, { - "name" : "provenance", - "description" : "Endpoint for accessing data flow provenance." - }, { - "name" : "provenance-events", - "description" : "Endpoint for accessing data flow provenance." - }, { - "name" : "remote-process-groups", - "description" : "Endpoint for managing a Remote Process Group." - }, { - "name" : "reporting-tasks", - "description" : "Endpoint for managing a Reporting Task." - }, { - "name" : "resources", - "description" : "Provides the resources in this NiFi that can have access/authorization policies." - }, { - "name" : "site-to-site", - "description" : "Provide access to site to site with this NiFi" - }, { - "name" : "snippets", - "description" : "Endpoint for accessing dataflow snippets." - }, { - "name" : "system-diagnostics", - "description" : "Endpoint for accessing system diagnostics." - }, { - "name" : "templates", - "description" : "Endpoint for managing a Template." - }, { - "name" : "tenants", - "description" : "Endpoint for managing users and user groups." - }, { - "name" : "versions", - "description" : "Endpoint for managing version control for a flow" - } ], - "schemes" : [ "http", "https" ], - "paths" : { - "/access" : { - "get" : { - "tags" : [ "access" ], - "summary" : "Gets the status the client's access", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getAccessStatus", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/AccessStatusEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Unable to determine access status because the client could not be authenticated." - }, - "403" : { - "description" : "Unable to determine access status because the client is not authorized to make this request." - }, - "409" : { - "description" : "Unable to determine access status because NiFi is not in the appropriate state." - }, - "500" : { - "description" : "Unable to determine access status because an unexpected error occurred." - } - } - } - }, - "/access/config" : { - "get" : { - "tags" : [ "access" ], - "summary" : "Retrieves the access configuration for this NiFi", - "description" : "", - "operationId" : "getLoginConfig", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/AccessConfigurationEntity" - } - } - } - } - }, - "/access/download-token" : { - "post" : { - "tags" : [ "access" ], - "summary" : "Creates a single use access token for downloading FlowFile content.", - "description" : "The token returned is a base64 encoded string. It is valid for a single request up to five minutes from being issued. It is used as a query parameter name 'access_token'.", - "operationId" : "createDownloadToken", - "consumes" : [ "application/x-www-form-urlencoded" ], - "produces" : [ "text/plain" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "Unable to create the download token because NiFi is not in the appropriate state. (i.e. may not have any tokens to grant or be configured to support username/password login)" - }, - "500" : { - "description" : "Unable to create download token because an unexpected error occurred." - } - } - } - }, - "/access/kerberos" : { - "post" : { - "tags" : [ "access" ], - "summary" : "Creates a token for accessing the REST API via Kerberos ticket exchange / SPNEGO negotiation", - "description" : "The token returned is formatted as a JSON Web Token (JWT). The token is base64 encoded and comprised of three parts. The header, the body, and the signature. The expiration of the token is a contained within the body. The token can be used in the Authorization header in the format 'Authorization: Bearer '.", - "operationId" : "createAccessTokenFromTicket", - "consumes" : [ "text/plain" ], - "produces" : [ "text/plain" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "NiFi was unable to complete the request because it did not contain a valid Kerberos ticket in the Authorization header. Retry this request after initializing a ticket with kinit and ensuring your browser is configured to support SPNEGO." - }, - "409" : { - "description" : "Unable to create access token because NiFi is not in the appropriate state. (i.e. may not be configured to support Kerberos login." - }, - "500" : { - "description" : "Unable to create access token because an unexpected error occurred." - } - } - } - }, - "/access/knox/callback" : { - "get" : { - "tags" : [ "access" ], - "summary" : "Redirect/callback URI for processing the result of the Apache Knox login sequence.", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "knoxCallback", - "consumes" : [ "*/*" ], - "produces" : [ "*/*" ], - "responses" : { - "default" : { - "description" : "successful operation" - } - } - } - }, - "/access/knox/logout" : { - "get" : { - "tags" : [ "access" ], - "summary" : "Performs a logout in the Apache Knox.", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "knoxLogout", - "consumes" : [ "*/*" ], - "produces" : [ "*/*" ], - "responses" : { - "default" : { - "description" : "successful operation" - } - } - } - }, - "/access/knox/request" : { - "get" : { - "tags" : [ "access" ], - "summary" : "Initiates a request to authenticate through Apache Knox.", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "knoxRequest", - "consumes" : [ "*/*" ], - "produces" : [ "*/*" ], - "responses" : { - "default" : { - "description" : "successful operation" - } - } - } - }, - "/access/logout" : { - "delete" : { - "tags" : [ "access" ], - "summary" : "Performs a logout for other providers that have been issued a JWT.", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "logOut", - "consumes" : [ "*/*" ], - "produces" : [ "*/*" ], - "responses" : { - "200" : { - "description" : "User was logged out successfully." - }, - "401" : { - "description" : "Authentication token provided was empty or not in the correct JWT format." - }, - "500" : { - "description" : "Client failed to log out." - } - } - } - }, - "/access/logout/complete" : { - "get" : { - "tags" : [ "access" ], - "summary" : "Completes the logout sequence by removing the cached Logout Request and Cookie if they existed and redirects to /nifi/login.", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "logOutComplete", - "consumes" : [ "*/*" ], - "produces" : [ "*/*" ], - "responses" : { - "200" : { - "description" : "User was logged out successfully." - }, - "401" : { - "description" : "Authentication token provided was empty or not in the correct JWT format." - }, - "500" : { - "description" : "Client failed to log out." - } - } - } - }, - "/access/oidc/callback" : { - "get" : { - "tags" : [ "access" ], - "summary" : "Redirect/callback URI for processing the result of the OpenId Connect login sequence.", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "oidcCallback", - "consumes" : [ "*/*" ], - "produces" : [ "*/*" ], - "responses" : { - "default" : { - "description" : "successful operation" - } - } - } - }, - "/access/oidc/exchange" : { - "post" : { - "tags" : [ "access" ], - "summary" : "Retrieves a JWT following a successful login sequence using the configured OpenId Connect provider.", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "oidcExchange", - "consumes" : [ "*/*" ], - "produces" : [ "text/plain" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - } - } - } - }, - "/access/oidc/logout" : { - "get" : { - "tags" : [ "access" ], - "summary" : "Performs a logout in the OpenId Provider.", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "oidcLogout", - "consumes" : [ "*/*" ], - "produces" : [ "*/*" ], - "responses" : { - "default" : { - "description" : "successful operation" - } - } - } - }, - "/access/oidc/logoutCallback" : { - "get" : { - "tags" : [ "access" ], - "summary" : "Redirect/callback URI for processing the result of the OpenId Connect logout sequence.", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "oidcLogoutCallback", - "consumes" : [ "*/*" ], - "produces" : [ "*/*" ], - "responses" : { - "default" : { - "description" : "successful operation" - } - } - } - }, - "/access/oidc/request" : { - "get" : { - "tags" : [ "access" ], - "summary" : "Initiates a request to authenticate through the configured OpenId Connect provider.", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "oidcRequest", - "consumes" : [ "*/*" ], - "produces" : [ "*/*" ], - "responses" : { - "default" : { - "description" : "successful operation" - } - } - } - }, - "/access/saml/local-logout" : { - "get" : { - "tags" : [ "access" ], - "summary" : "Local logout when SAML is enabled, does not communicate with the IDP.", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "samlLocalLogout", - "consumes" : [ "*/*" ], - "produces" : [ "*/*" ], - "responses" : { - "default" : { - "description" : "successful operation" - } - } - } - }, - "/access/saml/login/consumer" : { - "get" : { - "tags" : [ "access" ], - "summary" : "Processes the SSO response from the SAML identity provider for HTTP-REDIRECT binding.", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "samlLoginHttpRedirectConsumer", - "consumes" : [ "*/*" ], - "produces" : [ "*/*" ], - "responses" : { - "default" : { - "description" : "successful operation" - } - } - }, - "post" : { - "tags" : [ "access" ], - "summary" : "Processes the SSO response from the SAML identity provider for HTTP-POST binding.", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "samlLoginHttpPostConsumer", - "consumes" : [ "application/x-www-form-urlencoded" ], - "produces" : [ "*/*" ], - "responses" : { - "default" : { - "description" : "successful operation" - } - } - } - }, - "/access/saml/login/exchange" : { - "post" : { - "tags" : [ "access" ], - "summary" : "Retrieves a JWT following a successful login sequence using the configured SAML identity provider.", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "samlLoginExchange", - "consumes" : [ "*/*" ], - "produces" : [ "text/plain" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - } - } - } - }, - "/access/saml/login/request" : { - "get" : { - "tags" : [ "access" ], - "summary" : "Initiates an SSO request to the configured SAML identity provider.", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "samlLoginRequest", - "consumes" : [ "*/*" ], - "produces" : [ "*/*" ], - "responses" : { - "default" : { - "description" : "successful operation" - } - } - } - }, - "/access/saml/metadata" : { - "get" : { - "tags" : [ "access" ], - "summary" : "Retrieves the service provider metadata.", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "samlMetadata", - "consumes" : [ "*/*" ], - "produces" : [ "application/samlmetadata+xml" ], - "responses" : { - "default" : { - "description" : "successful operation" - } - } - } - }, - "/access/saml/single-logout/consumer" : { - "get" : { - "tags" : [ "access" ], - "summary" : "Processes a SingleLogout message from the configured SAML identity provider using the HTTP-REDIRECT binding.", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "samlSingleLogoutHttpRedirectConsumer", - "consumes" : [ "*/*" ], - "produces" : [ "*/*" ], - "responses" : { - "default" : { - "description" : "successful operation" - } - } - }, - "post" : { - "tags" : [ "access" ], - "summary" : "Processes a SingleLogout message from the configured SAML identity provider using the HTTP-POST binding.", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "samlSingleLogoutHttpPostConsumer", - "consumes" : [ "*/*" ], - "produces" : [ "*/*" ], - "responses" : { - "default" : { - "description" : "successful operation" - } - } - } - }, - "/access/saml/single-logout/request" : { - "get" : { - "tags" : [ "access" ], - "summary" : "Initiates a logout request using the SingleLogout service of the configured SAML identity provider.", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "samlSingleLogoutRequest", - "consumes" : [ "*/*" ], - "produces" : [ "*/*" ], - "responses" : { - "default" : { - "description" : "successful operation" - } - } - } - }, - "/access/token" : { - "post" : { - "tags" : [ "access" ], - "summary" : "Creates a token for accessing the REST API via username/password", - "description" : "The token returned is formatted as a JSON Web Token (JWT). The token is base64 encoded and comprised of three parts. The header, the body, and the signature. The expiration of the token is a contained within the body. The token can be used in the Authorization header in the format 'Authorization: Bearer '.", - "operationId" : "createAccessToken", - "consumes" : [ "application/x-www-form-urlencoded" ], - "produces" : [ "text/plain" ], - "parameters" : [ { - "name" : "username", - "in" : "formData", - "required" : false, - "type" : "string" - }, { - "name" : "password", - "in" : "formData", - "required" : false, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "Unable to create access token because NiFi is not in the appropriate state. (i.e. may not be configured to support username/password login." - }, - "500" : { - "description" : "Unable to create access token because an unexpected error occurred." - } - } - } - }, - "/access/ui-extension-token" : { - "post" : { - "tags" : [ "access" ], - "summary" : "Creates a single use access token for accessing a NiFi UI extension.", - "description" : "The token returned is a base64 encoded string. It is valid for a single request up to five minutes from being issued. It is used as a query parameter name 'access_token'.", - "operationId" : "createUiExtensionToken", - "consumes" : [ "application/x-www-form-urlencoded" ], - "produces" : [ "text/plain" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "Unable to create the download token because NiFi is not in the appropriate state. (i.e. may not have any tokens to grant or be configured to support username/password login)" - }, - "500" : { - "description" : "Unable to create download token because an unexpected error occurred." - } - } - } - }, - "/connections/{id}" : { - "get" : { - "tags" : [ "connections" ], - "summary" : "Gets a connection", - "description" : "", - "operationId" : "getConnection", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The connection id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ConnectionEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read Source - /{component-type}/{uuid}" : [ ] - }, { - "Read Destination - /{component-type}/{uuid}" : [ ] - } ] - }, - "put" : { - "tags" : [ "connections" ], - "summary" : "Updates a connection", - "description" : "", - "operationId" : "updateConnection", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The connection id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The connection configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ConnectionEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ConnectionEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write Source - /{component-type}/{uuid}" : [ ] - }, { - "Write Destination - /{component-type}/{uuid}" : [ ] - }, { - "Write New Destination - /{component-type}/{uuid} - if updating Destination" : [ ] - }, { - "Write Process Group - /process-groups/{uuid} - if updating Destination" : [ ] - } ] - }, - "delete" : { - "tags" : [ "connections" ], - "summary" : "Deletes a connection", - "description" : "", - "operationId" : "deleteConnection", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The revision is used to verify the client is working with the latest version of the flow.", - "required" : false, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The connection id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ConnectionEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write Source - /{component-type}/{uuid}" : [ ] - }, { - "Write - Parent Process Group - /process-groups/{uuid}" : [ ] - }, { - "Write Destination - /{component-type}/{uuid}" : [ ] - } ] - } - }, - "/controller-services/{id}" : { - "get" : { - "tags" : [ "controller-services" ], - "summary" : "Gets a controller service", - "description" : "", - "operationId" : "getControllerService", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The controller service id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ControllerServiceEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /controller-services/{uuid}" : [ ] - } ] - }, - "put" : { - "tags" : [ "controller-services" ], - "summary" : "Updates a controller service", - "description" : "", - "operationId" : "updateControllerService", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The controller service id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The controller service configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ControllerServiceEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ControllerServiceEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /controller-services/{uuid}" : [ ] - }, { - "Read - any referenced Controller Services if this request changes the reference - /controller-services/{uuid}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "controller-services" ], - "summary" : "Deletes a controller service", - "description" : "", - "operationId" : "removeControllerService", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The revision is used to verify the client is working with the latest version of the flow.", - "required" : false, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The controller service id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ControllerServiceEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /controller-services/{uuid}" : [ ] - }, { - "Write - Parent Process Group if scoped by Process Group - /process-groups/{uuid}" : [ ] - }, { - "Write - Controller if scoped by Controller - /controller" : [ ] - }, { - "Read - any referenced Controller Services - /controller-services/{uuid}" : [ ] - } ] - } - }, - "/controller-services/{id}/descriptors" : { - "get" : { - "tags" : [ "controller-services" ], - "summary" : "Gets a controller service property descriptor", - "description" : "", - "operationId" : "getPropertyDescriptor", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The controller service id.", - "required" : true, - "type" : "string" - }, { - "name" : "propertyName", - "in" : "query", - "description" : "The property name to return the descriptor for.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/PropertyDescriptorEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /controller-services/{uuid}" : [ ] - } ] - } - }, - "/controller-services/{id}/references" : { - "get" : { - "tags" : [ "controller-services" ], - "summary" : "Gets a controller service", - "description" : "", - "operationId" : "getControllerServiceReferences", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The controller service id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ControllerServiceReferencingComponentsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /controller-services/{uuid}" : [ ] - } ] - }, - "put" : { - "tags" : [ "controller-services" ], - "summary" : "Updates a controller services references", - "description" : "", - "operationId" : "updateControllerServiceReferences", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The controller service id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The controller service request update request.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/UpdateControllerServiceReferenceRequestEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ControllerServiceReferencingComponentsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /{component-type}/{uuid} or /operate/{component-type}/{uuid} - For each referencing component specified" : [ ] - } ] - } - }, - "/controller-services/{id}/run-status" : { - "put" : { - "tags" : [ "controller-services" ], - "summary" : "Updates run status of a controller service", - "description" : "", - "operationId" : "updateRunStatus", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The controller service id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The controller service run status.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ControllerServiceRunStatusEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ControllerServiceEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /controller-services/{uuid} or /operation/controller-services/{uuid}" : [ ] - } ] - } - }, - "/controller-services/{id}/state" : { - "get" : { - "tags" : [ "controller-services" ], - "summary" : "Gets the state for a controller service", - "description" : "", - "operationId" : "getState", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The controller service id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ComponentStateEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /controller-services/{uuid}" : [ ] - } ] - } - }, - "/controller-services/{id}/state/clear-requests" : { - "post" : { - "tags" : [ "controller-services" ], - "summary" : "Clears the state for a controller service", - "description" : "", - "operationId" : "clearState", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The controller service id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ComponentStateEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /controller-services/{uuid}" : [ ] - } ] - } - }, - "/controller/bulletin" : { - "post" : { - "tags" : [ "controller" ], - "summary" : "Creates a new bulletin", - "description" : "", - "operationId" : "createBulletin", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The reporting task configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/BulletinEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /controller" : [ ] - } ] - } - }, - "/controller/cluster" : { - "get" : { - "tags" : [ "controller" ], - "summary" : "Gets the contents of the cluster", - "description" : "Returns the contents of the cluster including all nodes and their status.", - "operationId" : "getCluster", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ClusterEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /controller" : [ ] - } ] - } - }, - "/controller/cluster/nodes/{id}" : { - "get" : { - "tags" : [ "controller" ], - "summary" : "Gets a node in the cluster", - "description" : "", - "operationId" : "getNode", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The node id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/NodeEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /controller" : [ ] - } ] - }, - "put" : { - "tags" : [ "controller" ], - "summary" : "Updates a node in the cluster", - "description" : "", - "operationId" : "updateNode", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The node id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The node configuration. The only configuration that will be honored at this endpoint is the status.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/NodeEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/NodeEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /controller" : [ ] - } ] - }, - "delete" : { - "tags" : [ "controller" ], - "summary" : "Removes a node from the cluster", - "description" : "", - "operationId" : "deleteNode", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The node id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/NodeEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /controller" : [ ] - } ] - } - }, - "/controller/config" : { - "get" : { - "tags" : [ "controller" ], - "summary" : "Retrieves the configuration for this NiFi Controller", - "description" : "", - "operationId" : "getControllerConfig", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ControllerConfigurationEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /controller" : [ ] - } ] - }, - "put" : { - "tags" : [ "controller" ], - "summary" : "Retrieves the configuration for this NiFi", - "description" : "", - "operationId" : "updateControllerConfig", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The controller configuration.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ControllerConfigurationEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ControllerConfigurationEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /controller" : [ ] - } ] - } - }, - "/controller/controller-services" : { - "post" : { - "tags" : [ "controller" ], - "summary" : "Creates a new controller service", - "description" : "", - "operationId" : "createControllerService", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The controller service configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ControllerServiceEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ControllerServiceEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /controller" : [ ] - }, { - "Read - any referenced Controller Services - /controller-services/{uuid}" : [ ] - }, { - "Write - if the Controller Service is restricted - /restricted-components" : [ ] - } ] - } - }, - "/controller/history" : { - "delete" : { - "tags" : [ "controller" ], - "summary" : "Purges history", - "description" : "", - "operationId" : "deleteHistory", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "endDate", - "in" : "query", - "description" : "Purge actions before this date/time.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/HistoryEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /controller" : [ ] - } ] - } - }, - "/controller/registry-clients" : { - "get" : { - "tags" : [ "controller" ], - "summary" : "Gets the listing of available registry clients", - "description" : "", - "operationId" : "getRegistryClients", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/RegistryClientsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - }, - "post" : { - "tags" : [ "controller" ], - "summary" : "Creates a new registry client", - "description" : "", - "operationId" : "createRegistryClient", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The registry configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/RegistryClientEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/RegistryClientEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /controller" : [ ] - } ] - } - }, - "/controller/registry-clients/{id}" : { - "get" : { - "tags" : [ "controller" ], - "summary" : "Gets a registry client", - "description" : "", - "operationId" : "getRegistryClient", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The registry id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/RegistryClientEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /controller" : [ ] - } ] - }, - "put" : { - "tags" : [ "controller" ], - "summary" : "Updates a registry client", - "description" : "", - "operationId" : "updateRegistryClient", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The registry id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The registry configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/RegistryClientEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/RegistryClientEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /controller" : [ ] - } ] - }, - "delete" : { - "tags" : [ "controller" ], - "summary" : "Deletes a registry client", - "description" : "", - "operationId" : "deleteRegistryClient", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The revision is used to verify the client is working with the latest version of the flow.", - "required" : false, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The registry id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/RegistryClientEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /controller" : [ ] - } ] - } - }, - "/controller/reporting-tasks" : { - "post" : { - "tags" : [ "controller" ], - "summary" : "Creates a new reporting task", - "description" : "", - "operationId" : "createReportingTask", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The reporting task configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ReportingTaskEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ReportingTaskEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /controller" : [ ] - }, { - "Read - any referenced Controller Services - /controller-services/{uuid}" : [ ] - }, { - "Write - if the Reporting Task is restricted - /restricted-components" : [ ] - } ] - } - }, - "/controller/status/history" : { - "get" : { - "tags" : [ "controller" ], - "summary" : "Gets status history for the node", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getNodeStatusHistory", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ComponentHistoryEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /controller" : [ ] - } ] - } - }, - "/counters" : { - "get" : { - "tags" : [ "counters" ], - "summary" : "Gets the current counters for this NiFi", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getCounters", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "nodewise", - "in" : "query", - "description" : "Whether or not to include the breakdown per node. Optional, defaults to false", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "clusterNodeId", - "in" : "query", - "description" : "The id of the node where to get the status.", - "required" : false, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/CountersEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /counters" : [ ] - } ] - } - }, - "/counters/{id}" : { - "put" : { - "tags" : [ "counters" ], - "summary" : "Updates the specified counter. This will reset the counter value to 0", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "updateCounter", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The id of the counter.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/CounterEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /counters" : [ ] - } ] - } - }, - "/data-transfer/input-ports/{portId}/transactions/{transactionId}" : { - "put" : { - "tags" : [ "data-transfer" ], - "summary" : "Extend transaction TTL", - "description" : "", - "operationId" : "extendInputPortTransactionTTL", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "portId", - "in" : "path", - "required" : true, - "type" : "string" - }, { - "name" : "transactionId", - "in" : "path", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/TransactionResultEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /data-transfer/input-ports/{uuid}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "data-transfer" ], - "summary" : "Commit or cancel the specified transaction", - "description" : "", - "operationId" : "commitInputPortTransaction", - "consumes" : [ "application/octet-stream" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "responseCode", - "in" : "query", - "description" : "The response code. Available values are BAD_CHECKSUM(19), CONFIRM_TRANSACTION(12) or CANCEL_TRANSACTION(15).", - "required" : true, - "type" : "integer", - "format" : "int32" - }, { - "name" : "portId", - "in" : "path", - "description" : "The input port id.", - "required" : true, - "type" : "string" - }, { - "name" : "transactionId", - "in" : "path", - "description" : "The transaction id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/TransactionResultEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - }, - "503" : { - "description" : "NiFi instance is not ready for serving request, or temporarily overloaded. Retrying the same request later may be successful" - } - }, - "security" : [ { - "Write - /data-transfer/input-ports/{uuid}" : [ ] - } ] - } - }, - "/data-transfer/input-ports/{portId}/transactions/{transactionId}/flow-files" : { - "post" : { - "tags" : [ "data-transfer" ], - "summary" : "Transfer flow files to the input port", - "description" : "", - "operationId" : "receiveFlowFiles", - "consumes" : [ "application/octet-stream" ], - "produces" : [ "text/plain" ], - "parameters" : [ { - "name" : "portId", - "in" : "path", - "description" : "The input port id.", - "required" : true, - "type" : "string" - }, { - "name" : "transactionId", - "in" : "path", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - }, - "503" : { - "description" : "NiFi instance is not ready for serving request, or temporarily overloaded. Retrying the same request later may be successful" - } - }, - "security" : [ { - "Write - /data-transfer/input-ports/{uuid}" : [ ] - } ] - } - }, - "/data-transfer/output-ports/{portId}/transactions/{transactionId}" : { - "put" : { - "tags" : [ "data-transfer" ], - "summary" : "Extend transaction TTL", - "description" : "", - "operationId" : "extendOutputPortTransactionTTL", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "portId", - "in" : "path", - "required" : true, - "type" : "string" - }, { - "name" : "transactionId", - "in" : "path", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/TransactionResultEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - }, - "503" : { - "description" : "NiFi instance is not ready for serving request, or temporarily overloaded. Retrying the same request later may be successful" - } - }, - "security" : [ { - "Write - /data-transfer/output-ports/{uuid}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "data-transfer" ], - "summary" : "Commit or cancel the specified transaction", - "description" : "", - "operationId" : "commitOutputPortTransaction", - "consumes" : [ "application/octet-stream" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "responseCode", - "in" : "query", - "description" : "The response code. Available values are CONFIRM_TRANSACTION(12) or CANCEL_TRANSACTION(15).", - "required" : true, - "type" : "integer", - "format" : "int32" - }, { - "name" : "checksum", - "in" : "query", - "description" : "A checksum calculated at client side using CRC32 to check flow file content integrity. It must match with the value calculated at server side.", - "required" : true, - "type" : "string" - }, { - "name" : "portId", - "in" : "path", - "description" : "The output port id.", - "required" : true, - "type" : "string" - }, { - "name" : "transactionId", - "in" : "path", - "description" : "The transaction id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/TransactionResultEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - }, - "503" : { - "description" : "NiFi instance is not ready for serving request, or temporarily overloaded. Retrying the same request later may be successful" - } - }, - "security" : [ { - "Write - /data-transfer/output-ports/{uuid}" : [ ] - } ] - } - }, - "/data-transfer/output-ports/{portId}/transactions/{transactionId}/flow-files" : { - "get" : { - "tags" : [ "data-transfer" ], - "summary" : "Transfer flow files from the output port", - "description" : "", - "operationId" : "transferFlowFiles", - "consumes" : [ "*/*" ], - "produces" : [ "application/octet-stream" ], - "parameters" : [ { - "name" : "portId", - "in" : "path", - "description" : "The output port id.", - "required" : true, - "type" : "string" - }, { - "name" : "transactionId", - "in" : "path", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "There is no flow file to return.", - "schema" : { - "$ref" : "#/definitions/StreamingOutput" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - }, - "503" : { - "description" : "NiFi instance is not ready for serving request, or temporarily overloaded. Retrying the same request later may be successful" - } - }, - "security" : [ { - "Write - /data-transfer/output-ports/{uuid}" : [ ] - } ] - } - }, - "/data-transfer/{portType}/{portId}/transactions" : { - "post" : { - "tags" : [ "data-transfer" ], - "summary" : "Create a transaction to the specified output port or input port", - "description" : "", - "operationId" : "createPortTransaction", - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "portType", - "in" : "path", - "description" : "The port type.", - "required" : true, - "type" : "string", - "enum" : [ "input-ports", "output-ports" ] - }, { - "name" : "portId", - "in" : "path", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/TransactionResultEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - }, - "503" : { - "description" : "NiFi instance is not ready for serving request, or temporarily overloaded. Retrying the same request later may be successful" - } - }, - "security" : [ { - "Write - /data-transfer/{component-type}/{uuid}" : [ ] - } ] - } - }, - "/flow/about" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Retrieves details about this NiFi to put in the About dialog", - "description" : "", - "operationId" : "getAboutInfo", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/AboutEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/banners" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Retrieves the banners for this NiFi", - "description" : "", - "operationId" : "getBanners", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/BannerEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/bulletin-board" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets current bulletins", - "description" : "", - "operationId" : "getBulletinBoard", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "after", - "in" : "query", - "description" : "Includes bulletins with an id after this value.", - "required" : false, - "type" : "string" - }, { - "name" : "sourceName", - "in" : "query", - "description" : "Includes bulletins originating from this sources whose name match this regular expression.", - "required" : false, - "type" : "string" - }, { - "name" : "message", - "in" : "query", - "description" : "Includes bulletins whose message that match this regular expression.", - "required" : false, - "type" : "string" - }, { - "name" : "sourceId", - "in" : "query", - "description" : "Includes bulletins originating from this sources whose id match this regular expression.", - "required" : false, - "type" : "string" - }, { - "name" : "groupId", - "in" : "query", - "description" : "Includes bulletins originating from this sources whose group id match this regular expression.", - "required" : false, - "type" : "string" - }, { - "name" : "limit", - "in" : "query", - "description" : "The number of bulletins to limit the response to.", - "required" : false, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/BulletinBoardEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - }, { - "Read - /{component-type}/{uuid} - For component specific bulletins" : [ ] - } ] - } - }, - "/flow/client-id" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Generates a client id.", - "description" : "", - "operationId" : "generateClientId", - "consumes" : [ "*/*" ], - "produces" : [ "text/plain" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/cluster/search-results" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Searches the cluster for a node with the specified address", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "searchCluster", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "q", - "in" : "query", - "description" : "Node address to search for.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ClusterSearchResultsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/cluster/summary" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "The cluster summary for this NiFi", - "description" : "", - "operationId" : "getClusterSummary", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ClusteSummaryEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/config" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Retrieves the configuration for this NiFi flow", - "description" : "", - "operationId" : "getFlowConfig", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/FlowConfigurationEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/connections/{id}/statistics" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets statistics for a connection", - "description" : "", - "operationId" : "getConnectionStatistics", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "nodewise", - "in" : "query", - "description" : "Whether or not to include the breakdown per node. Optional, defaults to false", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "clusterNodeId", - "in" : "query", - "description" : "The id of the node where to get the statistics.", - "required" : false, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The connection id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ConnectionStatisticsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/connections/{id}/status" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets status for a connection", - "description" : "", - "operationId" : "getConnectionStatus", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "nodewise", - "in" : "query", - "description" : "Whether or not to include the breakdown per node. Optional, defaults to false", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "clusterNodeId", - "in" : "query", - "description" : "The id of the node where to get the status.", - "required" : false, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The connection id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ConnectionStatusEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/connections/{id}/status/history" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets the status history for a connection", - "description" : "", - "operationId" : "getConnectionStatusHistory", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The connection id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/StatusHistoryEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/controller-service-types" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Retrieves the types of controller services that this NiFi supports", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getControllerServiceTypes", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "serviceType", - "in" : "query", - "description" : "If specified, will only return controller services that are compatible with this type of service.", - "required" : false, - "type" : "string" - }, { - "name" : "serviceBundleGroup", - "in" : "query", - "description" : "If serviceType specified, is the bundle group of the serviceType.", - "required" : false, - "type" : "string" - }, { - "name" : "serviceBundleArtifact", - "in" : "query", - "description" : "If serviceType specified, is the bundle artifact of the serviceType.", - "required" : false, - "type" : "string" - }, { - "name" : "serviceBundleVersion", - "in" : "query", - "description" : "If serviceType specified, is the bundle version of the serviceType.", - "required" : false, - "type" : "string" - }, { - "name" : "bundleGroupFilter", - "in" : "query", - "description" : "If specified, will only return types that are a member of this bundle group.", - "required" : false, - "type" : "string" - }, { - "name" : "bundleArtifactFilter", - "in" : "query", - "description" : "If specified, will only return types that are a member of this bundle artifact.", - "required" : false, - "type" : "string" - }, { - "name" : "typeFilter", - "in" : "query", - "description" : "If specified, will only return types whose fully qualified classname matches.", - "required" : false, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ControllerServiceTypesEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/controller/bulletins" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Retrieves Controller level bulletins", - "description" : "", - "operationId" : "getBulletins", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ControllerBulletinsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - }, { - "Read - /controller - For controller bulletins" : [ ] - }, { - "Read - /controller-services/{uuid} - For controller service bulletins" : [ ] - }, { - "Read - /reporting-tasks/{uuid} - For reporting task bulletins" : [ ] - } ] - } - }, - "/flow/controller/controller-services" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets controller services for reporting tasks", - "description" : "", - "operationId" : "getControllerServicesFromController", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ControllerServicesEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/current-user" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Retrieves the user identity of the user making the request", - "description" : "", - "operationId" : "getCurrentUser", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/CurrentUserEntity" - } - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/history" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets configuration history", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "queryHistory", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "offset", - "in" : "query", - "description" : "The offset into the result set.", - "required" : true, - "type" : "string" - }, { - "name" : "count", - "in" : "query", - "description" : "The number of actions to return.", - "required" : true, - "type" : "string" - }, { - "name" : "sortColumn", - "in" : "query", - "description" : "The field to sort on.", - "required" : false, - "type" : "string" - }, { - "name" : "sortOrder", - "in" : "query", - "description" : "The direction to sort.", - "required" : false, - "type" : "string" - }, { - "name" : "startDate", - "in" : "query", - "description" : "Include actions after this date.", - "required" : false, - "type" : "string" - }, { - "name" : "endDate", - "in" : "query", - "description" : "Include actions before this date.", - "required" : false, - "type" : "string" - }, { - "name" : "userIdentity", - "in" : "query", - "description" : "Include actions performed by this user.", - "required" : false, - "type" : "string" - }, { - "name" : "sourceId", - "in" : "query", - "description" : "Include actions on this component.", - "required" : false, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/HistoryEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/history/components/{componentId}" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets configuration history for a component", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getComponentHistory", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "componentId", - "in" : "path", - "description" : "The component id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ComponentHistoryEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - }, { - "Read underlying component - /{component-type}/{uuid}" : [ ] - } ] - } - }, - "/flow/history/{id}" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets an action", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getAction", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The action id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ActionEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/input-ports/{id}/status" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets status for an input port", - "description" : "", - "operationId" : "getInputPortStatus", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "nodewise", - "in" : "query", - "description" : "Whether or not to include the breakdown per node. Optional, defaults to false", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "clusterNodeId", - "in" : "query", - "description" : "The id of the node where to get the status.", - "required" : false, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The input port id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/PortStatusEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/metrics/{producer}" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets all metrics for the flow from a particular node", - "description" : "", - "operationId" : "getFlowMetrics", - "consumes" : [ "*/*" ], - "produces" : [ "*/*" ], - "parameters" : [ { - "name" : "producer", - "in" : "path", - "description" : "The producer for flow file metrics. Each producer may have its own output format.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/StreamingOutput" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/output-ports/{id}/status" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets status for an output port", - "description" : "", - "operationId" : "getOutputPortStatus", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "nodewise", - "in" : "query", - "description" : "Whether or not to include the breakdown per node. Optional, defaults to false", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "clusterNodeId", - "in" : "query", - "description" : "The id of the node where to get the status.", - "required" : false, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The output port id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/PortStatusEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/parameter-contexts" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets all Parameter Contexts", - "description" : "", - "operationId" : "getParameterContexts", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ParameterContextsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /parameter-contexts/{id} for each Parameter Context" : [ ] - } ] - } - }, - "/flow/prioritizers" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Retrieves the types of prioritizers that this NiFi supports", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getPrioritizers", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/PrioritizerTypesEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/process-groups/{id}" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets a process group", - "description" : "", - "operationId" : "getFlow", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessGroupFlowEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - }, - "put" : { - "tags" : [ "flow" ], - "summary" : "Schedule or unschedule components in the specified Process Group.", - "description" : "", - "operationId" : "scheduleComponents", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The request to schedule or unschedule. If the comopnents in the request are not specified, all authorized components will be considered.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ScheduleComponentsEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ScheduleComponentsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - }, { - "Write - /{component-type}/{uuid} or /operation/{component-type}/{uuid} - For every component being scheduled/unscheduled" : [ ] - } ] - } - }, - "/flow/process-groups/{id}/controller-services" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets all controller services", - "description" : "", - "operationId" : "getControllerServicesFromGroup", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "name" : "includeAncestorGroups", - "in" : "query", - "description" : "Whether or not to include parent/ancestory process groups", - "required" : false, - "type" : "boolean", - "default" : true - }, { - "name" : "includeDescendantGroups", - "in" : "query", - "description" : "Whether or not to include descendant process groups", - "required" : false, - "type" : "boolean", - "default" : false - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ControllerServicesEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - }, - "put" : { - "tags" : [ "flow" ], - "summary" : "Enable or disable Controller Services in the specified Process Group.", - "description" : "", - "operationId" : "activateControllerServices", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The request to schedule or unschedule. If the comopnents in the request are not specified, all authorized components will be considered.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ActivateControllerServicesEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ActivateControllerServicesEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - }, { - "Write - /{component-type}/{uuid} or /operation/{component-type}/{uuid} - For every service being enabled/disabled" : [ ] - } ] - } - }, - "/flow/process-groups/{id}/status" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets the status for a process group", - "description" : "The status for a process group includes status for all descendent components. When invoked on the root group with recursive set to true, it will return the current status of every component in the flow.", - "operationId" : "getProcessGroupStatus", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "recursive", - "in" : "query", - "description" : "Whether all descendant groups and the status of their content will be included. Optional, defaults to false", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "nodewise", - "in" : "query", - "description" : "Whether or not to include the breakdown per node. Optional, defaults to false", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "clusterNodeId", - "in" : "query", - "description" : "The id of the node where to get the status.", - "required" : false, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessGroupStatusEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/process-groups/{id}/status/history" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets status history for a remote process group", - "description" : "", - "operationId" : "getProcessGroupStatusHistory", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/StatusHistoryEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/processor-types" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Retrieves the types of processors that this NiFi supports", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getProcessorTypes", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bundleGroupFilter", - "in" : "query", - "description" : "If specified, will only return types that are a member of this bundle group.", - "required" : false, - "type" : "string" - }, { - "name" : "bundleArtifactFilter", - "in" : "query", - "description" : "If specified, will only return types that are a member of this bundle artifact.", - "required" : false, - "type" : "string" - }, { - "name" : "type", - "in" : "query", - "description" : "If specified, will only return types whose fully qualified classname matches.", - "required" : false, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessorTypesEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/processors/{id}/status" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets status for a processor", - "description" : "", - "operationId" : "getProcessorStatus", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "nodewise", - "in" : "query", - "description" : "Whether or not to include the breakdown per node. Optional, defaults to false", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "clusterNodeId", - "in" : "query", - "description" : "The id of the node where to get the status.", - "required" : false, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The processor id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessorStatusEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/processors/{id}/status/history" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets status history for a processor", - "description" : "", - "operationId" : "getProcessorStatusHistory", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The processor id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/StatusHistoryEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/registries" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets the listing of available registries", - "description" : "", - "operationId" : "getRegistries", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/RegistryClientsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/registries/{id}/buckets" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets the buckets from the specified registry for the current user", - "description" : "", - "operationId" : "getBuckets", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The registry id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/BucketsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/registries/{registry-id}/buckets/{bucket-id}/flows" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets the flows from the specified registry and bucket for the current user", - "description" : "", - "operationId" : "getFlows", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "registry-id", - "in" : "path", - "description" : "The registry id.", - "required" : true, - "type" : "string" - }, { - "name" : "bucket-id", - "in" : "path", - "description" : "The bucket id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlowsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/registries/{registry-id}/buckets/{bucket-id}/flows/{flow-id}/versions" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets the flow versions from the specified registry and bucket for the specified flow for the current user", - "description" : "", - "operationId" : "getVersions", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "registry-id", - "in" : "path", - "description" : "The registry id.", - "required" : true, - "type" : "string" - }, { - "name" : "bucket-id", - "in" : "path", - "description" : "The bucket id.", - "required" : true, - "type" : "string" - }, { - "name" : "flow-id", - "in" : "path", - "description" : "The flow id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlowSnapshotMetadataSetEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/remote-process-groups/{id}/status" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets status for a remote process group", - "description" : "", - "operationId" : "getRemoteProcessGroupStatus", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "nodewise", - "in" : "query", - "description" : "Whether or not to include the breakdown per node. Optional, defaults to false", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "clusterNodeId", - "in" : "query", - "description" : "The id of the node where to get the status.", - "required" : false, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The remote process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/RemoteProcessGroupStatusEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/remote-process-groups/{id}/status/history" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets the status history", - "description" : "", - "operationId" : "getRemoteProcessGroupStatusHistory", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The remote process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/StatusHistoryEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/reporting-task-types" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Retrieves the types of reporting tasks that this NiFi supports", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getReportingTaskTypes", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bundleGroupFilter", - "in" : "query", - "description" : "If specified, will only return types that are a member of this bundle group.", - "required" : false, - "type" : "string" - }, { - "name" : "bundleArtifactFilter", - "in" : "query", - "description" : "If specified, will only return types that are a member of this bundle artifact.", - "required" : false, - "type" : "string" - }, { - "name" : "type", - "in" : "query", - "description" : "If specified, will only return types whose fully qualified classname matches.", - "required" : false, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ReportingTaskTypesEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/reporting-tasks" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets all reporting tasks", - "description" : "", - "operationId" : "getReportingTasks", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ReportingTasksEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/search-results" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Performs a search against this NiFi using the specified search term", - "description" : "Only search results from authorized components will be returned.", - "operationId" : "searchFlow", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "q", - "in" : "query", - "required" : false, - "type" : "string" - }, { - "name" : "a", - "in" : "query", - "required" : false, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/SearchResultsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/status" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets the current status of this NiFi", - "description" : "", - "operationId" : "getControllerStatus", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ControllerStatusEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/templates" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets all templates", - "description" : "", - "operationId" : "getTemplates", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/TemplatesEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flowfile-queues/{id}/drop-requests" : { - "post" : { - "tags" : [ "flowfile-queues" ], - "summary" : "Creates a request to drop the contents of the queue in this connection.", - "description" : "", - "operationId" : "createDropRequest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The connection id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/DropRequestEntity" - } - }, - "202" : { - "description" : "The request has been accepted. A HTTP response header will contain the URI where the response can be polled." - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write Source Data - /data/{component-type}/{uuid}" : [ ] - } ] - } - }, - "/flowfile-queues/{id}/drop-requests/{drop-request-id}" : { - "get" : { - "tags" : [ "flowfile-queues" ], - "summary" : "Gets the current status of a drop request for the specified connection.", - "description" : "", - "operationId" : "getDropRequest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The connection id.", - "required" : true, - "type" : "string" - }, { - "name" : "drop-request-id", - "in" : "path", - "description" : "The drop request id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/DropRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write Source Data - /data/{component-type}/{uuid}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "flowfile-queues" ], - "summary" : "Cancels and/or removes a request to drop the contents of this connection.", - "description" : "", - "operationId" : "removeDropRequest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The connection id.", - "required" : true, - "type" : "string" - }, { - "name" : "drop-request-id", - "in" : "path", - "description" : "The drop request id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/DropRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write Source Data - /data/{component-type}/{uuid}" : [ ] - } ] - } - }, - "/flowfile-queues/{id}/flowfiles/{flowfile-uuid}" : { - "get" : { - "tags" : [ "flowfile-queues" ], - "summary" : "Gets a FlowFile from a Connection.", - "description" : "", - "operationId" : "getFlowFile", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The connection id.", - "required" : true, - "type" : "string" - }, { - "name" : "flowfile-uuid", - "in" : "path", - "description" : "The flowfile uuid.", - "required" : true, - "type" : "string" - }, { - "name" : "clusterNodeId", - "in" : "query", - "description" : "The id of the node where the content exists if clustered.", - "required" : false, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/FlowFileEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read Source Data - /data/{component-type}/{uuid}" : [ ] - } ] - } - }, - "/flowfile-queues/{id}/flowfiles/{flowfile-uuid}/content" : { - "get" : { - "tags" : [ "flowfile-queues" ], - "summary" : "Gets the content for a FlowFile in a Connection.", - "description" : "", - "operationId" : "downloadFlowFileContent", - "consumes" : [ "*/*" ], - "produces" : [ "*/*" ], - "parameters" : [ { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The connection id.", - "required" : true, - "type" : "string" - }, { - "name" : "flowfile-uuid", - "in" : "path", - "description" : "The flowfile uuid.", - "required" : true, - "type" : "string" - }, { - "name" : "clusterNodeId", - "in" : "query", - "description" : "The id of the node where the content exists if clustered.", - "required" : false, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/StreamingOutput" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read Source Data - /data/{component-type}/{uuid}" : [ ] - } ] - } - }, - "/flowfile-queues/{id}/listing-requests" : { - "post" : { - "tags" : [ "flowfile-queues" ], - "summary" : "Lists the contents of the queue in this connection.", - "description" : "", - "operationId" : "createFlowFileListing", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The connection id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ListingRequestEntity" - } - }, - "202" : { - "description" : "The request has been accepted. A HTTP response header will contain the URI where the response can be polled." - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read Source Data - /data/{component-type}/{uuid}" : [ ] - } ] - } - }, - "/flowfile-queues/{id}/listing-requests/{listing-request-id}" : { - "get" : { - "tags" : [ "flowfile-queues" ], - "summary" : "Gets the current status of a listing request for the specified connection.", - "description" : "", - "operationId" : "getListingRequest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The connection id.", - "required" : true, - "type" : "string" - }, { - "name" : "listing-request-id", - "in" : "path", - "description" : "The listing request id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ListingRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read Source Data - /data/{component-type}/{uuid}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "flowfile-queues" ], - "summary" : "Cancels and/or removes a request to list the contents of this connection.", - "description" : "", - "operationId" : "deleteListingRequest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The connection id.", - "required" : true, - "type" : "string" - }, { - "name" : "listing-request-id", - "in" : "path", - "description" : "The listing request id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ListingRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read Source Data - /data/{component-type}/{uuid}" : [ ] - } ] - } - }, - "/funnels/{id}" : { - "get" : { - "tags" : [ "funnel" ], - "summary" : "Gets a funnel", - "description" : "", - "operationId" : "getFunnel", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The funnel id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/FunnelEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /funnels/{uuid}" : [ ] - } ] - }, - "put" : { - "tags" : [ "funnel" ], - "summary" : "Updates a funnel", - "description" : "", - "operationId" : "updateFunnel", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The funnel id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The funnel configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/FunnelEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/FunnelEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /funnels/{uuid}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "funnel" ], - "summary" : "Deletes a funnel", - "description" : "", - "operationId" : "removeFunnel", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The revision is used to verify the client is working with the latest version of the flow.", - "required" : false, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The funnel id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/FunnelEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /funnels/{uuid}" : [ ] - }, { - "Write - Parent Process Group - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/input-ports/{id}" : { - "get" : { - "tags" : [ "input-ports" ], - "summary" : "Gets an input port", - "description" : "", - "operationId" : "getInputPort", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The input port id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/PortEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /input-ports/{uuid}" : [ ] - } ] - }, - "put" : { - "tags" : [ "input-ports" ], - "summary" : "Updates an input port", - "description" : "", - "operationId" : "updateInputPort", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The input port id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The input port configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/PortEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/PortEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /input-ports/{uuid}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "input-ports" ], - "summary" : "Deletes an input port", - "description" : "", - "operationId" : "removeInputPort", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The revision is used to verify the client is working with the latest version of the flow.", - "required" : false, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The input port id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/PortEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /input-ports/{uuid}" : [ ] - }, { - "Write - Parent Process Group - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/input-ports/{id}/run-status" : { - "put" : { - "tags" : [ "input-ports" ], - "summary" : "Updates run status of an input-port", - "description" : "", - "operationId" : "updateRunStatus", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The port id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The port run status.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/PortRunStatusEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessorEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /input-ports/{uuid} or /operation/input-ports/{uuid}" : [ ] - } ] - } - }, - "/labels/{id}" : { - "get" : { - "tags" : [ "labels" ], - "summary" : "Gets a label", - "description" : "", - "operationId" : "getLabel", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The label id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/LabelEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /labels/{uuid}" : [ ] - } ] - }, - "put" : { - "tags" : [ "labels" ], - "summary" : "Updates a label", - "description" : "", - "operationId" : "updateLabel", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The label id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The label configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/LabelEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/LabelEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /labels/{uuid}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "labels" ], - "summary" : "Deletes a label", - "description" : "", - "operationId" : "removeLabel", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The revision is used to verify the client is working with the latest version of the flow.", - "required" : false, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The label id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/LabelEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /labels/{uuid}" : [ ] - }, { - "Write - Parent Process Group - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/output-ports/{id}" : { - "get" : { - "tags" : [ "output-ports" ], - "summary" : "Gets an output port", - "description" : "", - "operationId" : "getOutputPort", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The output port id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/PortEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /output-ports/{uuid}" : [ ] - } ] - }, - "put" : { - "tags" : [ "output-ports" ], - "summary" : "Updates an output port", - "description" : "", - "operationId" : "updateOutputPort", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The output port id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The output port configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/PortEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/PortEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /output-ports/{uuid}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "output-ports" ], - "summary" : "Deletes an output port", - "description" : "", - "operationId" : "removeOutputPort", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The revision is used to verify the client is working with the latest version of the flow.", - "required" : false, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The output port id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/PortEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /output-ports/{uuid}" : [ ] - }, { - "Write - Parent Process Group - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/output-ports/{id}/run-status" : { - "put" : { - "tags" : [ "output-ports" ], - "summary" : "Updates run status of an output-port", - "description" : "", - "operationId" : "updateRunStatus", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The port id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The port run status.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/PortRunStatusEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessorEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /output-ports/{uuid} or /operation/output-ports/{uuid}" : [ ] - } ] - } - }, - "/parameter-contexts" : { - "post" : { - "tags" : [ "parameter-contexts" ], - "summary" : "Create a Parameter Context", - "description" : "", - "operationId" : "createParameterContext", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The Parameter Context.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ParameterContextEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ParameterContextEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /parameter-contexts" : [ ] - } ] - } - }, - "/parameter-contexts/{contextId}/update-requests" : { - "post" : { - "tags" : [ "parameter-contexts" ], - "summary" : "Initiate the Update Request of a Parameter Context", - "description" : "This will initiate the process of updating a Parameter Context. Changing the value of a Parameter may require that one or more components be stopped and restarted, so this acttion may take significantly more time than many other REST API actions. As a result, this endpoint will immediately return a ParameterContextUpdateRequestEntity, and the process of updating the necessary components will occur asynchronously in the background. The client may then periodically poll the status of the request by issuing a GET request to /parameter-contexts/update-requests/{requestId}. Once the request is completed, the client is expected to issue a DELETE request to /parameter-contexts/update-requests/{requestId}.", - "operationId" : "submitParameterContextUpdate", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "contextId", - "in" : "path", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The updated version of the parameter context.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ParameterContextEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ParameterContextUpdateRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /parameter-contexts/{parameterContextId}" : [ ] - }, { - "Write - /parameter-contexts/{parameterContextId}" : [ ] - }, { - "Read - for every component that is affected by the update" : [ ] - }, { - "Write - for every component that is affected by the update" : [ ] - } ] - } - }, - "/parameter-contexts/{contextId}/update-requests/{requestId}" : { - "get" : { - "tags" : [ "parameter-contexts" ], - "summary" : "Returns the Update Request with the given ID", - "description" : "Returns the Update Request with the given ID. Once an Update Request has been created by performing a POST to /nifi-api/parameter-contexts, that request can subsequently be retrieved via this endpoint, and the request that is fetched will contain the updated state, such as percent complete, the current state of the request, and any failures. ", - "operationId" : "getParameterContextUpdate", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "contextId", - "in" : "path", - "description" : "The ID of the Parameter Context", - "required" : true, - "type" : "string" - }, { - "name" : "requestId", - "in" : "path", - "description" : "The ID of the Update Request", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ParameterContextUpdateRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Only the user that submitted the request can get it" : [ ] - } ] - }, - "delete" : { - "tags" : [ "parameter-contexts" ], - "summary" : "Deletes the Update Request with the given ID", - "description" : "Deletes the Update Request with the given ID. After a request is created via a POST to /nifi-api/parameter-contexts/update-requests, it is expected that the client will properly clean up the request by DELETE'ing it, once the Update process has completed. If the request is deleted before the request completes, then the Update request will finish the step that it is currently performing and then will cancel any subsequent steps.", - "operationId" : "deleteUpdateRequest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "contextId", - "in" : "path", - "description" : "The ID of the ParameterContext", - "required" : true, - "type" : "string" - }, { - "name" : "requestId", - "in" : "path", - "description" : "The ID of the Update Request", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ParameterContextUpdateRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Only the user that submitted the request can remove it" : [ ] - } ] - } - }, - "/parameter-contexts/{contextId}/validation-requests" : { - "post" : { - "tags" : [ "parameter-contexts" ], - "summary" : "Initiate a Validation Request to determine how the validity of components will change if a Parameter Context were to be updated", - "description" : "This will initiate the process of validating all components whose Process Group is bound to the specified Parameter Context. Performing validation against an arbitrary number of components may be expect and take significantly more time than many other REST API actions. As a result, this endpoint will immediately return a ParameterContextValidationRequestEntity, and the process of validating the necessary components will occur asynchronously in the background. The client may then periodically poll the status of the request by issuing a GET request to /parameter-contexts/validation-requests/{requestId}. Once the request is completed, the client is expected to issue a DELETE request to /parameter-contexts/validation-requests/{requestId}.", - "operationId" : "submitValidationRequest", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "contextId", - "in" : "path", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The validation request", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ParameterContextValidationRequestEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ParameterContextValidationRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /parameter-contexts/{parameterContextId}" : [ ] - } ] - } - }, - "/parameter-contexts/{contextId}/validation-requests/{id}" : { - "get" : { - "tags" : [ "parameter-contexts" ], - "summary" : "Returns the Validation Request with the given ID", - "description" : "Returns the Validation Request with the given ID. Once a Validation Request has been created by performing a POST to /nifi-api/validation-contexts, that request can subsequently be retrieved via this endpoint, and the request that is fetched will contain the updated state, such as percent complete, the current state of the request, and any failures. ", - "operationId" : "getValidationRequest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "contextId", - "in" : "path", - "description" : "The ID of the Parameter Context", - "required" : true, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The ID of the Validation Request", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ParameterContextValidationRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Only the user that submitted the request can get it" : [ ] - } ] - }, - "delete" : { - "tags" : [ "parameter-contexts" ], - "summary" : "Deletes the Validation Request with the given ID", - "description" : "Deletes the Validation Request with the given ID. After a request is created via a POST to /nifi-api/validation-contexts, it is expected that the client will properly clean up the request by DELETE'ing it, once the validation process has completed. If the request is deleted before the request completes, then the Validation request will finish the step that it is currently performing and then will cancel any subsequent steps.", - "operationId" : "deleteValidationRequest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "contextId", - "in" : "path", - "description" : "The ID of the Parameter Context", - "required" : true, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The ID of the Update Request", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ParameterContextValidationRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Only the user that submitted the request can remove it" : [ ] - } ] - } - }, - "/parameter-contexts/{id}" : { - "get" : { - "tags" : [ "parameter-contexts" ], - "summary" : "Returns the Parameter Context with the given ID", - "description" : "Returns the Parameter Context with the given ID.", - "operationId" : "getParameterContext", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The ID of the Parameter Context", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ParameterContextEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /parameter-contexts/{id}" : [ ] - } ] - }, - "put" : { - "tags" : [ "parameter-contexts" ], - "summary" : "Modifies a Parameter Context", - "description" : "This endpoint will update a Parameter Context to match the provided entity. However, this request will fail if any component is running and is referencing a Parameter in the Parameter Context. Generally, this endpoint is not called directly. Instead, an update request should be submitted by making a POST to the /parameter-contexts/update-requests endpoint. That endpoint will, in turn, call this endpoint.", - "operationId" : "updateParameterContext", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The updated Parameter Context", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ParameterContextEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ParameterContextEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /parameter-contexts/{id}" : [ ] - }, { - "Write - /parameter-contexts/{id}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "parameter-contexts" ], - "summary" : "Deletes the Parameter Context with the given ID", - "description" : "Deletes the Parameter Context with the given ID.", - "operationId" : "deleteParameterContext", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The version is used to verify the client is working with the latest version of the flow.", - "required" : false, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, a new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The Parameter Context ID.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ParameterContextEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /parameter-contexts/{uuid}" : [ ] - }, { - "Write - /parameter-contexts/{uuid}" : [ ] - }, { - "Read - /process-groups/{uuid}, for any Process Group that is currently bound to the Parameter Context" : [ ] - }, { - "Write - /process-groups/{uuid}, for any Process Group that is currently bound to the Parameter Context" : [ ] - } ] - } - }, - "/policies" : { - "post" : { - "tags" : [ "policies" ], - "summary" : "Creates an access policy", - "description" : "", - "operationId" : "createAccessPolicy", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The access policy configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/AccessPolicyEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/AccessPolicyEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /policies/{resource}" : [ ] - } ] - } - }, - "/policies/{action}/{resource}" : { - "get" : { - "tags" : [ "policies" ], - "summary" : "Gets an access policy for the specified action and resource", - "description" : "Will return the effective policy if no component specific policy exists for the specified action and resource. Must have Read permissions to the policy with the desired action and resource. Permissions for the policy that is returned will be indicated in the response. This means the client could be authorized to get the policy for a given component but the effective policy may be inherited from an ancestor Process Group. If the client does not have permissions to that policy, the response will not include the policy and the permissions in the response will be marked accordingly. If the client does not have permissions to the policy of the desired action and resource a 403 response will be returned.", - "operationId" : "getAccessPolicyForResource", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "action", - "in" : "path", - "description" : "The request action.", - "required" : true, - "type" : "string", - "enum" : [ "read", "write" ] - }, { - "name" : "resource", - "in" : "path", - "description" : "The resource of the policy.", - "required" : true, - "type" : "string", - "pattern" : ".+" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/AccessPolicyEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /policies/{resource}" : [ ] - } ] - } - }, - "/policies/{id}" : { - "get" : { - "tags" : [ "policies" ], - "summary" : "Gets an access policy", - "description" : "", - "operationId" : "getAccessPolicy", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The access policy id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/AccessPolicyEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /policies/{resource}" : [ ] - } ] - }, - "put" : { - "tags" : [ "policies" ], - "summary" : "Updates a access policy", - "description" : "", - "operationId" : "updateAccessPolicy", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The access policy id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The access policy configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/AccessPolicyEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/AccessPolicyEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /policies/{resource}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "policies" ], - "summary" : "Deletes an access policy", - "description" : "", - "operationId" : "removeAccessPolicy", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The revision is used to verify the client is working with the latest version of the flow.", - "required" : false, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The access policy id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/AccessPolicyEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /policies/{resource}" : [ ] - }, { - "Write - Policy of the parent resource - /policies/{resource}" : [ ] - } ] - } - }, - "/process-groups/replace-requests/{id}" : { - "get" : { - "tags" : [ "process-groups" ], - "summary" : "Returns the Replace Request with the given ID", - "description" : "Returns the Replace Request with the given ID. Once a Replace Request has been created by performing a POST to /process-groups/{id}/replace-requests, that request can subsequently be retrieved via this endpoint, and the request that is fetched will contain the updated state, such as percent complete, the current state of the request, and any failures. Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getReplaceProcessGroupRequest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The ID of the Replace Request", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessGroupReplaceRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Only the user that submitted the request can get it" : [ ] - } ] - }, - "delete" : { - "tags" : [ "process-groups" ], - "summary" : "Deletes the Replace Request with the given ID", - "description" : "Deletes the Replace Request with the given ID. After a request is created via a POST to /process-groups/{id}/replace-requests, it is expected that the client will properly clean up the request by DELETE'ing it, once the Replace process has completed. If the request is deleted before the request completes, then the Replace request will finish the step that it is currently performing and then will cancel any subsequent steps. Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "deleteReplaceProcessGroupRequest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The ID of the Update Request", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessGroupReplaceRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Only the user that submitted the request can remove it" : [ ] - } ] - } - }, - "/process-groups/{groupId}/variable-registry/update-requests/{updateId}" : { - "get" : { - "tags" : [ "process-groups" ], - "summary" : "Gets a process group's variable registry", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getVariableRegistryUpdateRequest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "groupId", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "name" : "updateId", - "in" : "path", - "description" : "The ID of the Variable Registry Update Request", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VariableRegistryUpdateRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "process-groups" ], - "summary" : "Deletes an update request for a process group's variable registry. If the request is not yet complete, it will automatically be cancelled.", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "deleteVariableRegistryUpdateRequest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "groupId", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "name" : "updateId", - "in" : "path", - "description" : "The ID of the Variable Registry Update Request", - "required" : true, - "type" : "string" - }, { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VariableRegistryUpdateRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/process-groups/{id}" : { - "get" : { - "tags" : [ "process-groups" ], - "summary" : "Gets a process group", - "description" : "", - "operationId" : "getProcessGroup", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessGroupEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - } ] - }, - "put" : { - "tags" : [ "process-groups" ], - "summary" : "Updates a process group", - "description" : "", - "operationId" : "updateProcessGroup", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The process group configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ProcessGroupEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessGroupEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "process-groups" ], - "summary" : "Deletes a process group", - "description" : "", - "operationId" : "removeProcessGroup", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The revision is used to verify the client is working with the latest version of the flow.", - "required" : false, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessGroupEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - }, { - "Write - Parent Process Group - /process-groups/{uuid}" : [ ] - }, { - "Read - any referenced Controller Services by any encapsulated components - /controller-services/{uuid}" : [ ] - }, { - "Write - /{component-type}/{uuid} - For all encapsulated components" : [ ] - } ] - } - }, - "/process-groups/{id}/connections" : { - "get" : { - "tags" : [ "process-groups" ], - "summary" : "Gets all connections", - "description" : "", - "operationId" : "getConnections", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ConnectionsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - } ] - }, - "post" : { - "tags" : [ "process-groups" ], - "summary" : "Creates a connection", - "description" : "", - "operationId" : "createConnection", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The connection configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ConnectionEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ConnectionEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - }, { - "Write Source - /{component-type}/{uuid}" : [ ] - }, { - "Write Destination - /{component-type}/{uuid}" : [ ] - } ] - } - }, - "/process-groups/{id}/controller-services" : { - "post" : { - "tags" : [ "process-groups" ], - "summary" : "Creates a new controller service", - "description" : "", - "operationId" : "createControllerService", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The controller service configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ControllerServiceEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ControllerServiceEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - }, { - "Read - any referenced Controller Services - /controller-services/{uuid}" : [ ] - }, { - "Write - if the Controller Service is restricted - /restricted-components" : [ ] - } ] - } - }, - "/process-groups/{id}/download" : { - "get" : { - "tags" : [ "process-groups" ], - "summary" : "Gets a process group for download", - "description" : "", - "operationId" : "exportProcessGroup", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/process-groups/{id}/empty-all-connections-requests" : { - "post" : { - "tags" : [ "process-groups" ], - "summary" : "Creates a request to drop all flowfiles of all connection queues in this process group.", - "description" : "", - "operationId" : "createEmptyAllConnectionsRequest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessGroupEntity" - } - }, - "202" : { - "description" : "The request has been accepted. An HTTP response header will contain the URI where the status can be polled." - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid} - For this and all encapsulated process groups" : [ ] - }, { - "Write Source Data - /data/{component-type}/{uuid} - For all encapsulated connections" : [ ] - } ] - } - }, - "/process-groups/{id}/empty-all-connections-requests/{drop-request-id}" : { - "get" : { - "tags" : [ "process-groups" ], - "summary" : "Gets the current status of a drop all flowfiles request.", - "description" : "", - "operationId" : "getDropAllFlowfilesRequest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "name" : "drop-request-id", - "in" : "path", - "description" : "The drop request id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/DropRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid} - For this and all encapsulated process groups" : [ ] - }, { - "Write Source Data - /data/{component-type}/{uuid} - For all encapsulated connections" : [ ] - } ] - }, - "delete" : { - "tags" : [ "process-groups" ], - "summary" : "Cancels and/or removes a request to drop all flowfiles.", - "description" : "", - "operationId" : "removeDropRequest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "name" : "drop-request-id", - "in" : "path", - "description" : "The drop request id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/DropRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid} - For this and all encapsulated process groups" : [ ] - }, { - "Write Source Data - /data/{component-type}/{uuid} - For all encapsulated connections" : [ ] - } ] - } - }, - "/process-groups/{id}/flow-contents" : { - "put" : { - "tags" : [ "process-groups" ], - "summary" : "Replace Process Group contents with the given ID with the specified Process Group contents", - "description" : "This endpoint is used for replication within a cluster, when replacing a flow with a new flow. It expects that the flow beingreplaced is not under version control and that the given snapshot will not modify any Processor that is currently running or any Controller Service that is enabled. Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "replaceProcessGroup", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The process group replace request entity.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ProcessGroupImportEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessGroupImportEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - }, { - "Write - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/process-groups/{id}/funnels" : { - "get" : { - "tags" : [ "process-groups" ], - "summary" : "Gets all funnels", - "description" : "", - "operationId" : "getFunnels", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/FunnelsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - } ] - }, - "post" : { - "tags" : [ "process-groups" ], - "summary" : "Creates a funnel", - "description" : "", - "operationId" : "createFunnel", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The funnel configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/FunnelEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/FunnelEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/process-groups/{id}/input-ports" : { - "get" : { - "tags" : [ "process-groups" ], - "summary" : "Gets all input ports", - "description" : "", - "operationId" : "getInputPorts", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/InputPortsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - } ] - }, - "post" : { - "tags" : [ "process-groups" ], - "summary" : "Creates an input port", - "description" : "", - "operationId" : "createInputPort", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The input port configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/PortEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/PortEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/process-groups/{id}/labels" : { - "get" : { - "tags" : [ "process-groups" ], - "summary" : "Gets all labels", - "description" : "", - "operationId" : "getLabels", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/LabelsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - } ] - }, - "post" : { - "tags" : [ "process-groups" ], - "summary" : "Creates a label", - "description" : "", - "operationId" : "createLabel", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The label configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/LabelEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/LabelEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/process-groups/{id}/local-modifications" : { - "get" : { - "tags" : [ "process-groups" ], - "summary" : "Gets a list of local modifications to the Process Group since it was last synchronized with the Flow Registry", - "description" : "", - "operationId" : "getLocalModifications", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/FlowComparisonEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - }, { - "Read - /{component-type}/{uuid} - For all encapsulated components" : [ ] - } ] - } - }, - "/process-groups/{id}/output-ports" : { - "get" : { - "tags" : [ "process-groups" ], - "summary" : "Gets all output ports", - "description" : "", - "operationId" : "getOutputPorts", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/OutputPortsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - } ] - }, - "post" : { - "tags" : [ "process-groups" ], - "summary" : "Creates an output port", - "description" : "", - "operationId" : "createOutputPort", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The output port configuration.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/PortEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/PortEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/process-groups/{id}/process-groups" : { - "get" : { - "tags" : [ "process-groups" ], - "summary" : "Gets all process groups", - "description" : "", - "operationId" : "getProcessGroups", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessGroupsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - } ] - }, - "post" : { - "tags" : [ "process-groups" ], - "summary" : "Creates a process group", - "description" : "", - "operationId" : "createProcessGroup", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The process group configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ProcessGroupEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessGroupEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/process-groups/{id}/processors" : { - "get" : { - "tags" : [ "process-groups" ], - "summary" : "Gets all processors", - "description" : "", - "operationId" : "getProcessors", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "name" : "includeDescendantGroups", - "in" : "query", - "description" : "Whether or not to include processors from descendant process groups", - "required" : false, - "type" : "boolean", - "default" : false - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessorsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - } ] - }, - "post" : { - "tags" : [ "process-groups" ], - "summary" : "Creates a new processor", - "description" : "", - "operationId" : "createProcessor", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The processor configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ProcessorEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessorEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - }, { - "Read - any referenced Controller Services - /controller-services/{uuid}" : [ ] - }, { - "Write - if the Processor is restricted - /restricted-components" : [ ] - } ] - } - }, - "/process-groups/{id}/remote-process-groups" : { - "get" : { - "tags" : [ "process-groups" ], - "summary" : "Gets all remote process groups", - "description" : "", - "operationId" : "getRemoteProcessGroups", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/RemoteProcessGroupsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - } ] - }, - "post" : { - "tags" : [ "process-groups" ], - "summary" : "Creates a new process group", - "description" : "", - "operationId" : "createRemoteProcessGroup", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The remote process group configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/RemoteProcessGroupEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/RemoteProcessGroupEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/process-groups/{id}/replace-requests" : { - "post" : { - "tags" : [ "process-groups" ], - "summary" : "Initiate the Replace Request of a Process Group with the given ID", - "description" : "This will initiate the action of replacing a process group with the given process group. This can be a lengthy process, as it will stop any Processors and disable any Controller Services necessary to perform the action and then restart them. As a result, the endpoint will immediately return a ProcessGroupReplaceRequestEntity, and the process of replacing the flow will occur asynchronously in the background. The client may then periodically poll the status of the request by issuing a GET request to /process-groups/replace-requests/{requestId}. Once the request is completed, the client is expected to issue a DELETE request to /process-groups/replace-requests/{requestId}. Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "initiateReplaceProcessGroup", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The process group replace request entity", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ProcessGroupImportEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessGroupReplaceRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - }, { - "Write - /process-groups/{uuid}" : [ ] - }, { - "Read - /{component-type}/{uuid} - For all encapsulated components" : [ ] - }, { - "Write - /{component-type}/{uuid} - For all encapsulated components" : [ ] - }, { - "Write - if the template contains any restricted components - /restricted-components" : [ ] - }, { - "Read - /parameter-contexts/{uuid} - For any Parameter Context that is referenced by a Property that is changed, added, or removed" : [ ] - } ] - } - }, - "/process-groups/{id}/snippet-instance" : { - "post" : { - "tags" : [ "process-groups" ], - "summary" : "Copies a snippet and discards it.", - "description" : "", - "operationId" : "copySnippet", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The copy snippet request.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/CopySnippetRequestEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/FlowEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - }, { - "Read - /{component-type}/{uuid} - For each component in the snippet and their descendant components" : [ ] - }, { - "Write - if the snippet contains any restricted Processors - /restricted-components" : [ ] - } ] - } - }, - "/process-groups/{id}/template-instance" : { - "post" : { - "tags" : [ "process-groups" ], - "summary" : "Instantiates a template", - "description" : "", - "operationId" : "instantiateTemplate", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The instantiate template request.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/InstantiateTemplateRequestEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/FlowEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - }, { - "Read - /templates/{uuid}" : [ ] - }, { - "Write - if the template contains any restricted components - /restricted-components" : [ ] - } ] - } - }, - "/process-groups/{id}/templates" : { - "post" : { - "tags" : [ "process-groups" ], - "summary" : "Creates a template and discards the specified snippet.", - "description" : "", - "operationId" : "createTemplate", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The create template request.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/CreateTemplateRequestEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/TemplateEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - }, { - "Read - /{component-type}/{uuid} - For each component in the snippet and their descendant components" : [ ] - } ] - } - }, - "/process-groups/{id}/templates/import" : { - "post" : { - "tags" : [ "process-groups" ], - "summary" : "Imports a template", - "description" : "", - "operationId" : "importTemplate", - "consumes" : [ "application/xml" ], - "produces" : [ "application/xml" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/TemplateEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/process-groups/{id}/templates/upload" : { - "post" : { - "tags" : [ "process-groups" ], - "summary" : "Uploads a template", - "description" : "", - "operationId" : "uploadTemplate", - "consumes" : [ "multipart/form-data" ], - "produces" : [ "application/xml" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "schema" : { - "type" : "boolean" - } - }, { - "name" : "template", - "in" : "formData", - "description" : "The binary content of the template file being uploaded.", - "required" : true, - "type" : "file" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/TemplateEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/process-groups/{id}/variable-registry" : { - "get" : { - "tags" : [ "process-groups" ], - "summary" : "Gets a process group's variable registry", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getVariableRegistry", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "name" : "includeAncestorGroups", - "in" : "query", - "description" : "Whether or not to include ancestor groups", - "required" : false, - "type" : "boolean", - "default" : true - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VariableRegistryEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - } ] - }, - "put" : { - "tags" : [ "process-groups" ], - "summary" : "Updates the contents of a Process Group's variable Registry", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "updateVariableRegistry", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The variable registry configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/VariableRegistryEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VariableRegistryEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/process-groups/{id}/variable-registry/update-requests" : { - "post" : { - "tags" : [ "process-groups" ], - "summary" : "Submits a request to update a process group's variable registry", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "submitUpdateVariableRegistryRequest", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The variable registry configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/VariableRegistryEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VariableRegistryUpdateRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/processors/run-status-details/queries" : { - "post" : { - "tags" : [ "processors" ], - "summary" : "Submits a query to retrieve the run status details of all processors that are in the given list of Processor IDs", - "description" : "", - "operationId" : "getProcessorRunStatusDetails", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The request for the processors that should be included in the results", - "required" : false, - "schema" : { - "$ref" : "#/definitions/RunStatusDetailsRequestEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessorsRunStatusDetailsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /processors/{uuid} for each processor whose run status information is requested" : [ ] - } ] - } - }, - "/processors/{id}" : { - "get" : { - "tags" : [ "processors" ], - "summary" : "Gets a processor", - "description" : "", - "operationId" : "getProcessor", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The processor id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessorEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /processors/{uuid}" : [ ] - } ] - }, - "put" : { - "tags" : [ "processors" ], - "summary" : "Updates a processor", - "description" : "", - "operationId" : "updateProcessor", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The processor id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The processor configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ProcessorEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessorEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /processors/{uuid}" : [ ] - }, { - "Read - any referenced Controller Services if this request changes the reference - /controller-services/{uuid}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "processors" ], - "summary" : "Deletes a processor", - "description" : "", - "operationId" : "deleteProcessor", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The revision is used to verify the client is working with the latest version of the flow.", - "required" : false, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The processor id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessorEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /processors/{uuid}" : [ ] - }, { - "Write - Parent Process Group - /process-groups/{uuid}" : [ ] - }, { - "Read - any referenced Controller Services - /controller-services/{uuid}" : [ ] - } ] - } - }, - "/processors/{id}/descriptors" : { - "get" : { - "tags" : [ "processors" ], - "summary" : "Gets the descriptor for a processor property", - "description" : "", - "operationId" : "getPropertyDescriptor", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The processor id.", - "required" : true, - "type" : "string" - }, { - "name" : "propertyName", - "in" : "query", - "description" : "The property name.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/PropertyDescriptorEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /processors/{uuid}" : [ ] - } ] - } - }, - "/processors/{id}/diagnostics" : { - "get" : { - "tags" : [ "processors" ], - "summary" : "Gets diagnostics information about a processor", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getProcessorDiagnostics", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The processor id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessorEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /processors/{uuid}" : [ ] - } ] - } - }, - "/processors/{id}/run-status" : { - "put" : { - "tags" : [ "processors" ], - "summary" : "Updates run status of a processor", - "description" : "", - "operationId" : "updateRunStatus", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The processor id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The processor run status.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ProcessorRunStatusEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessorEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /processors/{uuid} or /operation/processors/{uuid}" : [ ] - } ] - } - }, - "/processors/{id}/state" : { - "get" : { - "tags" : [ "processors" ], - "summary" : "Gets the state for a processor", - "description" : "", - "operationId" : "getState", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The processor id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ComponentStateEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /processors/{uuid}" : [ ] - } ] - } - }, - "/processors/{id}/state/clear-requests" : { - "post" : { - "tags" : [ "processors" ], - "summary" : "Clears the state for a processor", - "description" : "", - "operationId" : "clearState", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The processor id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ComponentStateEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /processors/{uuid}" : [ ] - } ] - } - }, - "/processors/{id}/threads" : { - "delete" : { - "tags" : [ "processors" ], - "summary" : "Terminates a processor, essentially \"deleting\" its threads and any active tasks", - "description" : "", - "operationId" : "terminateProcessor", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The processor id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessorEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /processors/{uuid} or /operation/processors/{uuid}" : [ ] - } ] - } - }, - "/provenance" : { - "post" : { - "tags" : [ "provenance" ], - "summary" : "Submits a provenance query", - "description" : "Provenance queries may be long running so this endpoint submits a request. The response will include the current state of the query. If the request is not completed the URI in the response can be used at a later time to get the updated state of the query. Once the query has completed the provenance request should be deleted by the client who originally submitted it.", - "operationId" : "submitProvenanceRequest", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The provenance query details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ProvenanceEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProvenanceEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /provenance" : [ ] - }, { - "Read - /data/{component-type}/{uuid}" : [ ] - } ] - } - }, - "/provenance-events/replays" : { - "post" : { - "tags" : [ "provenance-events" ], - "summary" : "Replays content from a provenance event", - "description" : "", - "operationId" : "submitReplay", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The replay request.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/SubmitReplayRequestEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProvenanceEventEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read Component Provenance Data - /provenance-data/{component-type}/{uuid}" : [ ] - }, { - "Read Component Data - /data/{component-type}/{uuid}" : [ ] - }, { - "Write Component Data - /data/{component-type}/{uuid}" : [ ] - } ] - } - }, - "/provenance-events/{id}" : { - "get" : { - "tags" : [ "provenance-events" ], - "summary" : "Gets a provenance event", - "description" : "", - "operationId" : "getProvenanceEvent", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "clusterNodeId", - "in" : "query", - "description" : "The id of the node where this event exists if clustered.", - "required" : false, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The provenance event id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProvenanceEventEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read Component Provenance Data - /provenance-data/{component-type}/{uuid}" : [ ] - } ] - } - }, - "/provenance-events/{id}/content/input" : { - "get" : { - "tags" : [ "provenance-events" ], - "summary" : "Gets the input content for a provenance event", - "description" : "", - "operationId" : "getInputContent", - "consumes" : [ "*/*" ], - "produces" : [ "*/*" ], - "parameters" : [ { - "name" : "clusterNodeId", - "in" : "query", - "description" : "The id of the node where the content exists if clustered.", - "required" : false, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The provenance event id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/StreamingOutput" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read Component Provenance Data - /provenance-data/{component-type}/{uuid}" : [ ] - }, { - "Read Component Data - /data/{component-type}/{uuid}" : [ ] - } ] - } - }, - "/provenance-events/{id}/content/output" : { - "get" : { - "tags" : [ "provenance-events" ], - "summary" : "Gets the output content for a provenance event", - "description" : "", - "operationId" : "getOutputContent", - "consumes" : [ "*/*" ], - "produces" : [ "*/*" ], - "parameters" : [ { - "name" : "clusterNodeId", - "in" : "query", - "description" : "The id of the node where the content exists if clustered.", - "required" : false, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The provenance event id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/StreamingOutput" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read Component Provenance Data - /provenance-data/{component-type}/{uuid}" : [ ] - }, { - "Read Component Data - /data/{component-type}/{uuid}" : [ ] - } ] - } - }, - "/provenance/lineage" : { - "post" : { - "tags" : [ "provenance" ], - "summary" : "Submits a lineage query", - "description" : "Lineage queries may be long running so this endpoint submits a request. The response will include the current state of the query. If the request is not completed the URI in the response can be used at a later time to get the updated state of the query. Once the query has completed the lineage request should be deleted by the client who originally submitted it.", - "operationId" : "submitLineageRequest", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The lineage query details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/LineageEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/LineageEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /provenance" : [ ] - }, { - "Read - /data/{component-type}/{uuid}" : [ ] - } ] - } - }, - "/provenance/lineage/{id}" : { - "get" : { - "tags" : [ "provenance" ], - "summary" : "Gets a lineage query", - "description" : "", - "operationId" : "getLineage", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "clusterNodeId", - "in" : "query", - "description" : "The id of the node where this query exists if clustered.", - "required" : false, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The id of the lineage query.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/LineageEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /provenance" : [ ] - }, { - "Read - /data/{component-type}/{uuid}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "provenance" ], - "summary" : "Deletes a lineage query", - "description" : "", - "operationId" : "deleteLineage", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "clusterNodeId", - "in" : "query", - "description" : "The id of the node where this query exists if clustered.", - "required" : false, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The id of the lineage query.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/LineageEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /provenance" : [ ] - } ] - } - }, - "/provenance/search-options" : { - "get" : { - "tags" : [ "provenance" ], - "summary" : "Gets the searchable attributes for provenance events", - "description" : "", - "operationId" : "getSearchOptions", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProvenanceOptionsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /provenance" : [ ] - } ] - } - }, - "/provenance/{id}" : { - "get" : { - "tags" : [ "provenance" ], - "summary" : "Gets a provenance query", - "description" : "", - "operationId" : "getProvenance", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "clusterNodeId", - "in" : "query", - "description" : "The id of the node where this query exists if clustered.", - "required" : false, - "type" : "string" - }, { - "name" : "summarize", - "in" : "query", - "description" : "Whether or not incremental results are returned. If false, provenance events are only returned once the query completes. This property is true by default.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "incrementalResults", - "in" : "query", - "description" : "Whether or not to summarize provenance events returned. This property is false by default.", - "required" : false, - "type" : "boolean", - "default" : true - }, { - "name" : "id", - "in" : "path", - "description" : "The id of the provenance query.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProvenanceEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /provenance" : [ ] - }, { - "Read - /data/{component-type}/{uuid}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "provenance" ], - "summary" : "Deletes a provenance query", - "description" : "", - "operationId" : "deleteProvenance", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "clusterNodeId", - "in" : "query", - "description" : "The id of the node where this query exists if clustered.", - "required" : false, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The id of the provenance query.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProvenanceEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /provenance" : [ ] - } ] - } - }, - "/remote-process-groups/{id}" : { - "get" : { - "tags" : [ "remote-process-groups" ], - "summary" : "Gets a remote process group", - "description" : "", - "operationId" : "getRemoteProcessGroup", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The remote process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/RemoteProcessGroupEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /remote-process-groups/{uuid}" : [ ] - } ] - }, - "put" : { - "tags" : [ "remote-process-groups" ], - "summary" : "Updates a remote process group", - "description" : "", - "operationId" : "updateRemoteProcessGroup", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The remote process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The remote process group.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/RemoteProcessGroupEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/RemoteProcessGroupEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /remote-process-groups/{uuid}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "remote-process-groups" ], - "summary" : "Deletes a remote process group", - "description" : "", - "operationId" : "removeRemoteProcessGroup", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The revision is used to verify the client is working with the latest version of the flow.", - "required" : false, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The remote process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/RemoteProcessGroupEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /remote-process-groups/{uuid}" : [ ] - }, { - "Write - Parent Process Group - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/remote-process-groups/{id}/input-ports/{port-id}" : { - "put" : { - "tags" : [ "remote-process-groups" ], - "summary" : "Updates a remote port", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "updateRemoteProcessGroupInputPort", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The remote process group id.", - "required" : true, - "type" : "string" - }, { - "name" : "port-id", - "in" : "path", - "description" : "The remote process group port id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The remote process group port.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/RemoteProcessGroupPortEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/RemoteProcessGroupPortEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /remote-process-groups/{uuid}" : [ ] - } ] - } - }, - "/remote-process-groups/{id}/input-ports/{port-id}/run-status" : { - "put" : { - "tags" : [ "remote-process-groups" ], - "summary" : "Updates run status of a remote port", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "updateRemoteProcessGroupInputPortRunStatus", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The remote process group id.", - "required" : true, - "type" : "string" - }, { - "name" : "port-id", - "in" : "path", - "description" : "The remote process group port id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The remote process group port.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/RemotePortRunStatusEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/RemoteProcessGroupPortEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /remote-process-groups/{uuid} or /operation/remote-process-groups/{uuid}" : [ ] - } ] - } - }, - "/remote-process-groups/{id}/output-ports/{port-id}" : { - "put" : { - "tags" : [ "remote-process-groups" ], - "summary" : "Updates a remote port", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "updateRemoteProcessGroupOutputPort", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The remote process group id.", - "required" : true, - "type" : "string" - }, { - "name" : "port-id", - "in" : "path", - "description" : "The remote process group port id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The remote process group port.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/RemoteProcessGroupPortEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/RemoteProcessGroupPortEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /remote-process-groups/{uuid}" : [ ] - } ] - } - }, - "/remote-process-groups/{id}/output-ports/{port-id}/run-status" : { - "put" : { - "tags" : [ "remote-process-groups" ], - "summary" : "Updates run status of a remote port", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "updateRemoteProcessGroupOutputPortRunStatus", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The remote process group id.", - "required" : true, - "type" : "string" - }, { - "name" : "port-id", - "in" : "path", - "description" : "The remote process group port id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The remote process group port.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/RemotePortRunStatusEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/RemoteProcessGroupPortEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /remote-process-groups/{uuid} or /operation/remote-process-groups/{uuid}" : [ ] - } ] - } - }, - "/remote-process-groups/{id}/run-status" : { - "put" : { - "tags" : [ "remote-process-groups" ], - "summary" : "Updates run status of a remote process group", - "description" : "", - "operationId" : "updateRemoteProcessGroupRunStatus", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The remote process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The remote process group run status.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/RemotePortRunStatusEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/RemoteProcessGroupEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /remote-process-groups/{uuid} or /operation/remote-process-groups/{uuid}" : [ ] - } ] - } - }, - "/remote-process-groups/{id}/state" : { - "get" : { - "tags" : [ "remote-process-groups" ], - "summary" : "Gets the state for a RemoteProcessGroup", - "description" : "", - "operationId" : "getState", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The processor id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ComponentStateEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /remote-process-groups/{uuid}" : [ ] - } ] - } - }, - "/reporting-tasks/{id}" : { - "get" : { - "tags" : [ "reporting-tasks" ], - "summary" : "Gets a reporting task", - "description" : "", - "operationId" : "getReportingTask", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The reporting task id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ReportingTaskEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /reporting-tasks/{uuid}" : [ ] - } ] - }, - "put" : { - "tags" : [ "reporting-tasks" ], - "summary" : "Updates a reporting task", - "description" : "", - "operationId" : "updateReportingTask", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The reporting task id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The reporting task configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ReportingTaskEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ReportingTaskEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /reporting-tasks/{uuid}" : [ ] - }, { - "Read - any referenced Controller Services if this request changes the reference - /controller-services/{uuid}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "reporting-tasks" ], - "summary" : "Deletes a reporting task", - "description" : "", - "operationId" : "removeReportingTask", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The revision is used to verify the client is working with the latest version of the flow.", - "required" : false, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The reporting task id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ReportingTaskEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /reporting-tasks/{uuid}" : [ ] - }, { - "Write - /controller" : [ ] - }, { - "Read - any referenced Controller Services - /controller-services/{uuid}" : [ ] - } ] - } - }, - "/reporting-tasks/{id}/descriptors" : { - "get" : { - "tags" : [ "reporting-tasks" ], - "summary" : "Gets a reporting task property descriptor", - "description" : "", - "operationId" : "getPropertyDescriptor", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The reporting task id.", - "required" : true, - "type" : "string" - }, { - "name" : "propertyName", - "in" : "query", - "description" : "The property name.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/PropertyDescriptorEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /reporting-tasks/{uuid}" : [ ] - } ] - } - }, - "/reporting-tasks/{id}/run-status" : { - "put" : { - "tags" : [ "reporting-tasks" ], - "summary" : "Updates run status of a reporting task", - "description" : "", - "operationId" : "updateRunStatus", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The reporting task id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The reporting task run status.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ReportingTaskRunStatusEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ReportingTaskEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /reporting-tasks/{uuid} or or /operation/reporting-tasks/{uuid}" : [ ] - } ] - } - }, - "/reporting-tasks/{id}/state" : { - "get" : { - "tags" : [ "reporting-tasks" ], - "summary" : "Gets the state for a reporting task", - "description" : "", - "operationId" : "getState", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The reporting task id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ComponentStateEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /reporting-tasks/{uuid}" : [ ] - } ] - } - }, - "/reporting-tasks/{id}/state/clear-requests" : { - "post" : { - "tags" : [ "reporting-tasks" ], - "summary" : "Clears the state for a reporting task", - "description" : "", - "operationId" : "clearState", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The reporting task id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ComponentStateEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /reporting-tasks/{uuid}" : [ ] - } ] - } - }, - "/resources" : { - "get" : { - "tags" : [ "resources" ], - "summary" : "Gets the available resources that support access/authorization policies", - "description" : "", - "operationId" : "getResources", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ResourcesEntity" - } - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - } - }, - "security" : [ { - "Read - /resources" : [ ] - } ] - } - }, - "/site-to-site" : { - "get" : { - "tags" : [ "site-to-site" ], - "summary" : "Returns the details about this NiFi necessary to communicate via site to site", - "description" : "", - "operationId" : "getSiteToSiteDetails", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ControllerEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /site-to-site" : [ ] - } ] - } - }, - "/site-to-site/peers" : { - "get" : { - "tags" : [ "site-to-site" ], - "summary" : "Returns the available Peers and its status of this NiFi", - "description" : "", - "operationId" : "getPeers", - "consumes" : [ "*/*" ], - "produces" : [ "application/json", "application/xml" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/PeersEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /site-to-site" : [ ] - } ] - } - }, - "/snippets" : { - "post" : { - "tags" : [ "snippets" ], - "summary" : "Creates a snippet. The snippet will be automatically discarded if not used in a subsequent request after 1 minute.", - "description" : "", - "operationId" : "createSnippet", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The snippet configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/SnippetEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/SnippetEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read or Write - /{component-type}/{uuid} - For every component (all Read or all Write) in the Snippet and their descendant components" : [ ] - } ] - } - }, - "/snippets/{id}" : { - "put" : { - "tags" : [ "snippets" ], - "summary" : "Move's the components in this Snippet into a new Process Group and discards the snippet", - "description" : "", - "operationId" : "updateSnippet", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The snippet id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The snippet configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/SnippetEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/SnippetEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write Process Group - /process-groups/{uuid}" : [ ] - }, { - "Write - /{component-type}/{uuid} - For each component in the Snippet and their descendant components" : [ ] - } ] - }, - "delete" : { - "tags" : [ "snippets" ], - "summary" : "Deletes the components in a snippet and discards the snippet", - "description" : "", - "operationId" : "deleteSnippet", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The snippet id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/SnippetEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /{component-type}/{uuid} - For each component in the Snippet and their descendant components" : [ ] - }, { - "Write - Parent Process Group - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/system-diagnostics" : { - "get" : { - "tags" : [ "system-diagnostics" ], - "summary" : "Gets the diagnostics for the system NiFi is running on", - "description" : "", - "operationId" : "getSystemDiagnostics", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "nodewise", - "in" : "query", - "description" : "Whether or not to include the breakdown per node. Optional, defaults to false", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "clusterNodeId", - "in" : "query", - "description" : "The id of the node where to get the status.", - "required" : false, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/SystemDiagnosticsEntity" - } - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - } - }, - "security" : [ { - "Read - /system" : [ ] - } ] - } - }, - "/templates/{id}" : { - "delete" : { - "tags" : [ "templates" ], - "summary" : "Deletes a template", - "description" : "", - "operationId" : "removeTemplate", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The template id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/TemplateEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /templates/{uuid}" : [ ] - }, { - "Write - Parent Process Group - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/templates/{id}/download" : { - "get" : { - "tags" : [ "templates" ], - "summary" : "Exports a template", - "description" : "", - "operationId" : "exportTemplate", - "consumes" : [ "*/*" ], - "produces" : [ "application/xml" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The template id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /templates/{uuid}" : [ ] - } ] - } - }, - "/tenants/search-results" : { - "get" : { - "tags" : [ "tenants" ], - "summary" : "Searches for a tenant with the specified identity", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "searchTenants", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "q", - "in" : "query", - "description" : "Identity to search for.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/TenantsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /tenants" : [ ] - } ] - } - }, - "/tenants/user-groups" : { - "get" : { - "tags" : [ "tenants" ], - "summary" : "Gets all user groups", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getUserGroups", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/UserGroupsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /tenants" : [ ] - } ] - }, - "post" : { - "tags" : [ "tenants" ], - "summary" : "Creates a user group", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "createUserGroup", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The user group configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/UserGroupEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/UserGroupEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /tenants" : [ ] - } ] - } - }, - "/tenants/user-groups/{id}" : { - "get" : { - "tags" : [ "tenants" ], - "summary" : "Gets a user group", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getUserGroup", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The user group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/UserGroupEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /tenants" : [ ] - } ] - }, - "put" : { - "tags" : [ "tenants" ], - "summary" : "Updates a user group", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "updateUserGroup", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The user group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The user group configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/UserGroupEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/UserGroupEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /tenants" : [ ] - } ] - }, - "delete" : { - "tags" : [ "tenants" ], - "summary" : "Deletes a user group", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "removeUserGroup", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The revision is used to verify the client is working with the latest version of the flow.", - "required" : false, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The user group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/UserGroupEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /tenants" : [ ] - } ] - } - }, - "/tenants/users" : { - "get" : { - "tags" : [ "tenants" ], - "summary" : "Gets all users", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getUsers", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/UsersEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /tenants" : [ ] - } ] - }, - "post" : { - "tags" : [ "tenants" ], - "summary" : "Creates a user", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "createUser", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The user configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/UserEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/UserEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /tenants" : [ ] - } ] - } - }, - "/tenants/users/{id}" : { - "get" : { - "tags" : [ "tenants" ], - "summary" : "Gets a user", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getUser", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The user id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/UserEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /tenants" : [ ] - } ] - }, - "put" : { - "tags" : [ "tenants" ], - "summary" : "Updates a user", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "updateUser", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The user id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The user configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/UserEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/UserEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /tenants" : [ ] - } ] - }, - "delete" : { - "tags" : [ "tenants" ], - "summary" : "Deletes a user", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "removeUser", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The revision is used to verify the client is working with the latest version of the flow.", - "required" : false, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The user id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/UserEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /tenants" : [ ] - } ] - } - }, - "/versions/active-requests" : { - "post" : { - "tags" : [ "versions" ], - "summary" : "Create a version control request", - "description" : "Creates a request so that a Process Group can be placed under Version Control or have its Version Control configuration changed. Creating this request will prevent any other threads from simultaneously saving local changes to Version Control. It will not, however, actually save the local flow to the Flow Registry. A POST to /versions/process-groups/{id} should be used to initiate saving of the local flow to the Flow Registry. Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "createVersionControlRequest", - "consumes" : [ "application/json" ], - "produces" : [ "text/plain" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The versioned flow details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/CreateActiveRequestEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/versions/active-requests/{id}" : { - "put" : { - "tags" : [ "versions" ], - "summary" : "Updates the request with the given ID", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "updateVersionControlRequest", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The request ID.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The version control component mapping.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/VersionControlComponentMappingEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionControlInformationEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Only the user that submitted the request can update it" : [ ] - } ] - }, - "delete" : { - "tags" : [ "versions" ], - "summary" : "Deletes the version control request with the given ID", - "description" : "Deletes the Version Control Request with the given ID. This will allow other threads to save flows to the Flow Registry. See also the documentation for POSTing to /versions/active-requests for information regarding why this is done. Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "deleteVersionControlRequest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The request ID.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Only the user that submitted the request can remove it" : [ ] - } ] - } - }, - "/versions/process-groups/{id}" : { - "get" : { - "tags" : [ "versions" ], - "summary" : "Gets the Version Control information for a process group", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getVersionInformation", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionControlInformationEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - } ] - }, - "post" : { - "tags" : [ "versions" ], - "summary" : "Save the Process Group with the given ID", - "description" : "Begins version controlling the Process Group with the given ID or commits changes to the Versioned Flow, depending on if the provided VersionControlInformation includes a flowId. Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "saveToFlowRegistry", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The versioned flow details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/StartVersionControlRequestEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionControlInformationEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - }, { - "Write - /process-groups/{uuid}" : [ ] - }, { - "Read - /{component-type}/{uuid} - For all encapsulated components" : [ ] - }, { - "Read - any referenced Controller Services by any encapsulated components - /controller-services/{uuid}" : [ ] - } ] - }, - "put" : { - "tags" : [ "versions" ], - "summary" : "Update the version of a Process Group with the given ID", - "description" : "For a Process Group that is already under Version Control, this will update the version of the flow to a different version. This endpoint expects that the given snapshot will not modify any Processor that is currently running or any Controller Service that is enabled. Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "updateFlowVersion", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The controller service configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/VersionedFlowSnapshotEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionControlInformationEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - }, { - "Write - /process-groups/{uuid}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "versions" ], - "summary" : "Stops version controlling the Process Group with the given ID", - "description" : "Stops version controlling the Process Group with the given ID. The Process Group will no longer track to any Versioned Flow. Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "stopVersionControl", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The version is used to verify the client is working with the latest version of the flow.", - "required" : false, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, a new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionControlInformationEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - }, { - "Write - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/versions/process-groups/{id}/download" : { - "get" : { - "tags" : [ "versions" ], - "summary" : "Gets the latest version of a Process Group for download", - "description" : "", - "operationId" : "exportFlowVersion", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/versions/revert-requests/process-groups/{id}" : { - "post" : { - "tags" : [ "versions" ], - "summary" : "Initiate the Revert Request of a Process Group with the given ID", - "description" : "For a Process Group that is already under Version Control, this will initiate the action of reverting any local changes that have been made to the Process Group since it was last synchronized with the Flow Registry. This will result in the flow matching the Versioned Flow that exists in the Flow Registry. This can be a lengthy process, as it will stop any Processors and disable any Controller Services necessary to perform the action and then restart them. As a result, the endpoint will immediately return a VersionedFlowUpdateRequestEntity, and the process of updating the flow will occur asynchronously in the background. The client may then periodically poll the status of the request by issuing a GET request to /versions/revert-requests/{requestId}. Once the request is completed, the client is expected to issue a DELETE request to /versions/revert-requests/{requestId}. Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "initiateRevertFlowVersion", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The controller service configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/VersionControlInformationEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlowUpdateRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - }, { - "Write - /process-groups/{uuid}" : [ ] - }, { - "Read - /{component-type}/{uuid} - For all encapsulated components" : [ ] - }, { - "Write - /{component-type}/{uuid} - For all encapsulated components" : [ ] - }, { - "Write - if the template contains any restricted components - /restricted-components" : [ ] - }, { - "Read - /parameter-contexts/{uuid} - For any Parameter Context that is referenced by a Property that is changed, added, or removed" : [ ] - } ] - } - }, - "/versions/revert-requests/{id}" : { - "get" : { - "tags" : [ "versions" ], - "summary" : "Returns the Revert Request with the given ID", - "description" : "Returns the Revert Request with the given ID. Once a Revert Request has been created by performing a POST to /versions/revert-requests/process-groups/{id}, that request can subsequently be retrieved via this endpoint, and the request that is fetched will contain the updated state, such as percent complete, the current state of the request, and any failures. Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getRevertRequest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The ID of the Revert Request", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlowUpdateRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Only the user that submitted the request can get it" : [ ] - } ] - }, - "delete" : { - "tags" : [ "versions" ], - "summary" : "Deletes the Revert Request with the given ID", - "description" : "Deletes the Revert Request with the given ID. After a request is created via a POST to /versions/revert-requests/process-groups/{id}, it is expected that the client will properly clean up the request by DELETE'ing it, once the Revert process has completed. If the request is deleted before the request completes, then the Revert request will finish the step that it is currently performing and then will cancel any subsequent steps. Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "deleteRevertRequest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The ID of the Revert Request", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlowUpdateRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Only the user that submitted the request can remove it" : [ ] - } ] - } - }, - "/versions/update-requests/process-groups/{id}" : { - "post" : { - "tags" : [ "versions" ], - "summary" : "Initiate the Update Request of a Process Group with the given ID", - "description" : "For a Process Group that is already under Version Control, this will initiate the action of changing from a specific version of the flow in the Flow Registry to a different version of the flow. This can be a lengthy process, as it will stop any Processors and disable any Controller Services necessary to perform the action and then restart them. As a result, the endpoint will immediately return a VersionedFlowUpdateRequestEntity, and the process of updating the flow will occur asynchronously in the background. The client may then periodically poll the status of the request by issuing a GET request to /versions/update-requests/{requestId}. Once the request is completed, the client is expected to issue a DELETE request to /versions/update-requests/{requestId}. Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "initiateVersionControlUpdate", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The controller service configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/VersionControlInformationEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlowUpdateRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - }, { - "Write - /process-groups/{uuid}" : [ ] - }, { - "Read - /{component-type}/{uuid} - For all encapsulated components" : [ ] - }, { - "Write - /{component-type}/{uuid} - For all encapsulated components" : [ ] - }, { - "Write - if the template contains any restricted components - /restricted-components" : [ ] - }, { - "Read - /parameter-contexts/{uuid} - For any Parameter Context that is referenced by a Property that is changed, added, or removed" : [ ] - } ] - } - }, - "/versions/update-requests/{id}" : { - "get" : { - "tags" : [ "versions" ], - "summary" : "Returns the Update Request with the given ID", - "description" : "Returns the Update Request with the given ID. Once an Update Request has been created by performing a POST to /versions/update-requests/process-groups/{id}, that request can subsequently be retrieved via this endpoint, and the request that is fetched will contain the updated state, such as percent complete, the current state of the request, and any failures. Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getUpdateRequest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The ID of the Update Request", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlowUpdateRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Only the user that submitted the request can get it" : [ ] - } ] - }, - "delete" : { - "tags" : [ "versions" ], - "summary" : "Deletes the Update Request with the given ID", - "description" : "Deletes the Update Request with the given ID. After a request is created via a POST to /versions/update-requests/process-groups/{id}, it is expected that the client will properly clean up the request by DELETE'ing it, once the Update process has completed. If the request is deleted before the request completes, then the Update request will finish the step that it is currently performing and then will cancel any subsequent steps. Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "deleteUpdateRequest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The ID of the Update Request", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlowUpdateRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Only the user that submitted the request can remove it" : [ ] - } ] - } - } - }, - "definitions" : { - "AboutDTO" : { - "type" : "object", - "properties" : { - "title" : { - "type" : "string", - "description" : "The title to be used on the page and in the about dialog." - }, - "version" : { - "type" : "string", - "description" : "The version of this NiFi." - }, - "uri" : { - "type" : "string", - "description" : "The URI for the NiFi." - }, - "contentViewerUrl" : { - "type" : "string", - "description" : "The URL for the content viewer if configured." - }, - "timezone" : { - "type" : "string", - "description" : "The timezone of the NiFi instance.", - "readOnly" : true - }, - "buildTag" : { - "type" : "string", - "description" : "Build tag" - }, - "buildRevision" : { - "type" : "string", - "description" : "Build revision or commit hash" - }, - "buildBranch" : { - "type" : "string", - "description" : "Build branch" - }, - "buildTimestamp" : { - "type" : "string", - "description" : "Build timestamp" - } - } - }, - "AboutEntity" : { - "type" : "object", - "properties" : { - "about" : { - "$ref" : "#/definitions/AboutDTO" - } - }, - "xml" : { - "name" : "aboutEntity" - } - }, - "AccessConfigurationDTO" : { - "type" : "object", - "properties" : { - "supportsLogin" : { - "type" : "boolean", - "description" : "Indicates whether or not this NiFi supports user login.", - "readOnly" : true - } - } - }, - "AccessConfigurationEntity" : { - "type" : "object", - "properties" : { - "config" : { - "$ref" : "#/definitions/AccessConfigurationDTO" - } - }, - "xml" : { - "name" : "accessConfigurationEntity" - } - }, - "AccessPolicyDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "versionedComponentId" : { - "type" : "string", - "description" : "The ID of the corresponding component that is under version control" - }, - "parentGroupId" : { - "type" : "string", - "description" : "The id of parent process group of this component if applicable." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "resource" : { - "type" : "string", - "description" : "The resource for this access policy." - }, - "action" : { - "type" : "string", - "description" : "The action associated with this access policy.", - "enum" : [ "read", "write" ] - }, - "componentReference" : { - "description" : "Component this policy references if applicable.", - "$ref" : "#/definitions/ComponentReferenceEntity" - }, - "configurable" : { - "type" : "boolean", - "description" : "Whether this policy is configurable." - }, - "users" : { - "type" : "array", - "description" : "The set of user IDs associated with this access policy.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/TenantEntity" - } - }, - "userGroups" : { - "type" : "array", - "description" : "The set of user group IDs associated with this access policy.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/TenantEntity" - } - } - } - }, - "AccessPolicyEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "generated" : { - "type" : "string", - "description" : "When this content was generated." - }, - "component" : { - "$ref" : "#/definitions/AccessPolicyDTO" - } - }, - "xml" : { - "name" : "accessPolicyEntity" - } - }, - "AccessPolicySummaryDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "versionedComponentId" : { - "type" : "string", - "description" : "The ID of the corresponding component that is under version control" - }, - "parentGroupId" : { - "type" : "string", - "description" : "The id of parent process group of this component if applicable." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "resource" : { - "type" : "string", - "description" : "The resource for this access policy." - }, - "action" : { - "type" : "string", - "description" : "The action associated with this access policy.", - "enum" : [ "read", "write" ] - }, - "componentReference" : { - "description" : "Component this policy references if applicable.", - "$ref" : "#/definitions/ComponentReferenceEntity" - }, - "configurable" : { - "type" : "boolean", - "description" : "Whether this policy is configurable." - } - } - }, - "AccessPolicySummaryEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "component" : { - "$ref" : "#/definitions/AccessPolicySummaryDTO" - } - }, - "xml" : { - "name" : "accessPolicySummaryEntity" - } - }, - "AccessStatusDTO" : { - "type" : "object", - "properties" : { - "identity" : { - "type" : "string", - "description" : "The user identity.", - "readOnly" : true - }, - "status" : { - "type" : "string", - "description" : "The user access status.", - "readOnly" : true - }, - "message" : { - "type" : "string", - "description" : "Additional details about the user access status.", - "readOnly" : true - } - }, - "xml" : { - "name" : "accessStatus" - } - }, - "AccessStatusEntity" : { - "type" : "object", - "properties" : { - "accessStatus" : { - "$ref" : "#/definitions/AccessStatusDTO" - } - }, - "xml" : { - "name" : "accessStatusEntity" - } - }, - "ActionDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "integer", - "format" : "int32", - "description" : "The action id." - }, - "userIdentity" : { - "type" : "string", - "description" : "The identity of the user that performed the action." - }, - "timestamp" : { - "type" : "string", - "description" : "The timestamp of the action." - }, - "sourceId" : { - "type" : "string", - "description" : "The id of the source component." - }, - "sourceName" : { - "type" : "string", - "description" : "The name of the source component." - }, - "sourceType" : { - "type" : "string", - "description" : "The type of the source component." - }, - "componentDetails" : { - "description" : "The details of the source component.", - "$ref" : "#/definitions/ComponentDetailsDTO" - }, - "operation" : { - "type" : "string", - "description" : "The operation that was performed." - }, - "actionDetails" : { - "description" : "The details of the action.", - "$ref" : "#/definitions/ActionDetailsDTO" - } - } - }, - "ActionDetailsDTO" : { - "type" : "object" - }, - "ActionEntity" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "integer", - "format" : "int32" - }, - "timestamp" : { - "type" : "string", - "description" : "The timestamp of the action." - }, - "sourceId" : { - "type" : "string" - }, - "canRead" : { - "type" : "boolean", - "description" : "Indicates whether the user can read a given resource.", - "readOnly" : true - }, - "action" : { - "$ref" : "#/definitions/ActionDTO" - } - }, - "xml" : { - "name" : "actionEntity" - } - }, - "ActivateControllerServicesEntity" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the ProcessGroup" - }, - "state" : { - "type" : "string", - "description" : "The desired state of the descendant components", - "enum" : [ "ENABLED", "DISABLED" ] - }, - "components" : { - "type" : "object", - "description" : "Optional services to schedule. If not specified, all authorized descendant controller services will be used.", - "additionalProperties" : { - "$ref" : "#/definitions/RevisionDTO" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - } - }, - "xml" : { - "name" : "activateControllerServicesEntity" - } - }, - "AffectedComponentDTO" : { - "type" : "object", - "properties" : { - "processGroupId" : { - "type" : "string", - "description" : "The UUID of the Process Group that this component is in" - }, - "id" : { - "type" : "string", - "description" : "The UUID of this component" - }, - "referenceType" : { - "type" : "string", - "description" : "The type of this component", - "enum" : [ "PROCESSOR", "CONTROLLER_SERVICE", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT" ] - }, - "name" : { - "type" : "string", - "description" : "The name of this component." - }, - "state" : { - "type" : "string", - "description" : "The scheduled state of a processor or reporting task referencing a controller service. If this component is another controller service, this field represents the controller service state." - }, - "activeThreadCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of active threads for the referencing component." - }, - "validationErrors" : { - "type" : "array", - "description" : "The validation errors for the component.", - "items" : { - "type" : "string" - } - } - } - }, - "AffectedComponentEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "component" : { - "$ref" : "#/definitions/AffectedComponentDTO" - }, - "processGroup" : { - "description" : "The Process Group that the component belongs to", - "$ref" : "#/definitions/ProcessGroupNameDTO" - }, - "referenceType" : { - "type" : "string", - "description" : "The type of component referenced", - "enum" : [ "PROCESSOR", "CONTROLLER_SERVICE", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT" ] - } - }, - "xml" : { - "name" : "affectedComponentEntity" - } - }, - "AllowableValueDTO" : { - "type" : "object", - "properties" : { - "displayName" : { - "type" : "string", - "description" : "A human readable value that is allowed for the property descriptor." - }, - "value" : { - "type" : "string", - "description" : "A value that is allowed for the property descriptor." - }, - "description" : { - "type" : "string", - "description" : "A description for this allowable value." - } - } - }, - "AllowableValueEntity" : { - "type" : "object", - "properties" : { - "allowableValue" : { - "$ref" : "#/definitions/AllowableValueDTO" - }, - "canRead" : { - "type" : "boolean", - "description" : "Indicates whether the user can read a given resource.", - "readOnly" : true - } - }, - "xml" : { - "name" : "entity" - } - }, - "AttributeDTO" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The attribute name." - }, - "value" : { - "type" : "string", - "description" : "The attribute value." - }, - "previousValue" : { - "type" : "string", - "description" : "The value of the attribute before the event took place." - } - } - }, - "BannerDTO" : { - "type" : "object", - "properties" : { - "headerText" : { - "type" : "string", - "description" : "The header text." - }, - "footerText" : { - "type" : "string", - "description" : "The footer text." - } - } - }, - "BannerEntity" : { - "type" : "object", - "properties" : { - "banners" : { - "$ref" : "#/definitions/BannerDTO" - } - }, - "xml" : { - "name" : "bannersEntity" - } - }, - "BatchSettingsDTO" : { - "type" : "object", - "properties" : { - "count" : { - "type" : "integer", - "format" : "int32", - "description" : "Preferred number of flow files to include in a transaction." - }, - "size" : { - "type" : "string", - "description" : "Preferred number of bytes to include in a transaction." - }, - "duration" : { - "type" : "string", - "description" : "Preferred amount of time that a transaction should span." - } - } - }, - "BatchSize" : { - "type" : "object", - "properties" : { - "count" : { - "type" : "integer", - "format" : "int32", - "description" : "Preferred number of flow files to include in a transaction." - }, - "size" : { - "type" : "string", - "description" : "Preferred number of bytes to include in a transaction." - }, - "duration" : { - "type" : "string", - "description" : "Preferred amount of time that a transaction should span." - } - } - }, - "Bucket" : { - "type" : "object", - "required" : [ "name" ], - "properties" : { - "link" : { - "description" : "An WebLink to this entity.", - "readOnly" : true, - "$ref" : "#/definitions/JaxbLink" - }, - "identifier" : { - "type" : "string", - "description" : "An ID to uniquely identify this object.", - "readOnly" : true - }, - "name" : { - "type" : "string", - "description" : "The name of the bucket." - }, - "createdTimestamp" : { - "type" : "integer", - "format" : "int64", - "description" : "The timestamp of when the bucket was first created. This is set by the server at creation time.", - "readOnly" : true, - "minimum" : 1 - }, - "description" : { - "type" : "string", - "description" : "A description of the bucket." - }, - "allowBundleRedeploy" : { - "type" : "boolean", - "description" : "Indicates if this bucket allows the same version of an extension bundle to be redeployed and thus overwrite the existing artifact. By default this is false." - }, - "allowPublicRead" : { - "type" : "boolean", - "description" : "Indicates if this bucket allows read access to unauthenticated anonymous users" - }, - "permissions" : { - "description" : "The access that the current user has to this bucket.", - "readOnly" : true, - "$ref" : "#/definitions/Permissions" - }, - "revision" : { - "description" : "The revision of this entity used for optimistic-locking during updates.", - "readOnly" : true, - "$ref" : "#/definitions/RevisionInfo" - } - } - }, - "BucketDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The bucket identifier" - }, - "name" : { - "type" : "string", - "description" : "The bucket name" - }, - "description" : { - "type" : "string", - "description" : "The bucket description" - }, - "created" : { - "type" : "integer", - "format" : "int64", - "description" : "The created timestamp of this bucket" - } - } - }, - "BucketEntity" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string" - }, - "bucket" : { - "$ref" : "#/definitions/BucketDTO" - }, - "permissions" : { - "$ref" : "#/definitions/PermissionsDTO" - } - }, - "xml" : { - "name" : "bucketEntity" - } - }, - "BucketsEntity" : { - "type" : "object", - "properties" : { - "buckets" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/BucketEntity" - } - } - }, - "xml" : { - "name" : "bucketsEntity" - } - }, - "BulletinBoardDTO" : { - "type" : "object", - "properties" : { - "bulletins" : { - "type" : "array", - "description" : "The bulletins in the bulletin board, that matches the supplied request.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "generated" : { - "type" : "string", - "description" : "The timestamp when this report was generated." - } - } - }, - "BulletinBoardEntity" : { - "type" : "object", - "properties" : { - "bulletinBoard" : { - "$ref" : "#/definitions/BulletinBoardDTO" - } - }, - "xml" : { - "name" : "bulletinBoardEntity" - } - }, - "BulletinDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "integer", - "format" : "int64", - "description" : "The id of the bulletin." - }, - "nodeAddress" : { - "type" : "string", - "description" : "If clustered, the address of the node from which the bulletin originated." - }, - "category" : { - "type" : "string", - "description" : "The category of this bulletin." - }, - "groupId" : { - "type" : "string", - "description" : "The group id of the source component." - }, - "sourceId" : { - "type" : "string", - "description" : "The id of the source component." - }, - "sourceName" : { - "type" : "string", - "description" : "The name of the source component." - }, - "level" : { - "type" : "string", - "description" : "The level of the bulletin." - }, - "message" : { - "type" : "string", - "description" : "The bulletin message." - }, - "timestamp" : { - "type" : "string", - "description" : "When this bulletin was generated." - } - } - }, - "BulletinEntity" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "integer", - "format" : "int64" - }, - "groupId" : { - "type" : "string" - }, - "sourceId" : { - "type" : "string" - }, - "timestamp" : { - "type" : "string", - "description" : "When this bulletin was generated." - }, - "nodeAddress" : { - "type" : "string" - }, - "canRead" : { - "type" : "boolean", - "description" : "Indicates whether the user can read a given resource.", - "readOnly" : true - }, - "bulletin" : { - "$ref" : "#/definitions/BulletinDTO" - } - }, - "xml" : { - "name" : "bulletinEntity" - } - }, - "Bundle" : { - "type" : "object", - "properties" : { - "group" : { - "type" : "string", - "description" : "The group of the bundle" - }, - "artifact" : { - "type" : "string", - "description" : "The artifact of the bundle" - }, - "version" : { - "type" : "string", - "description" : "The version of the bundle" - } - } - }, - "BundleDTO" : { - "type" : "object", - "properties" : { - "group" : { - "type" : "string", - "description" : "The group of the bundle." - }, - "artifact" : { - "type" : "string", - "description" : "The artifact of the bundle." - }, - "version" : { - "type" : "string", - "description" : "The version of the bundle." - } - } - }, - "ClusteSummaryEntity" : { - "type" : "object", - "properties" : { - "clusterSummary" : { - "$ref" : "#/definitions/ClusterSummaryDTO" - } - }, - "xml" : { - "name" : "clusterSummaryEntity" - } - }, - "ClusterDTO" : { - "type" : "object", - "properties" : { - "nodes" : { - "type" : "array", - "description" : "The collection of nodes that are part of the cluster.", - "items" : { - "$ref" : "#/definitions/NodeDTO" - } - }, - "generated" : { - "type" : "string", - "description" : "The timestamp the report was generated." - } - } - }, - "ClusterEntity" : { - "type" : "object", - "properties" : { - "cluster" : { - "$ref" : "#/definitions/ClusterDTO" - } - }, - "xml" : { - "name" : "clusterEntity" - } - }, - "ClusterSearchResultsEntity" : { - "type" : "object", - "properties" : { - "nodeResults" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/NodeSearchResultDTO" - } - } - }, - "xml" : { - "name" : "clusterSearchResultsEntity" - } - }, - "ClusterSummaryDTO" : { - "type" : "object", - "properties" : { - "connectedNodes" : { - "type" : "string", - "description" : "When clustered, reports the number of nodes connected vs the number of nodes in the cluster." - }, - "connectedNodeCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of nodes that are currently connected to the cluster" - }, - "totalNodeCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of nodes in the cluster, regardless of whether or not they are connected" - }, - "clustered" : { - "type" : "boolean", - "description" : "Whether this NiFi instance is clustered." - }, - "connectedToCluster" : { - "type" : "boolean", - "description" : "Whether this NiFi instance is connected to a cluster." - } - } - }, - "ComponentDetailsDTO" : { - "type" : "object" - }, - "ComponentDifferenceDTO" : { - "type" : "object", - "properties" : { - "componentType" : { - "type" : "string", - "description" : "The type of component" - }, - "componentId" : { - "type" : "string", - "description" : "The ID of the component" - }, - "componentName" : { - "type" : "string", - "description" : "The name of the component" - }, - "processGroupId" : { - "type" : "string", - "description" : "The ID of the Process Group that the component belongs to" - }, - "differences" : { - "type" : "array", - "description" : "The differences in the component between the two flows", - "items" : { - "$ref" : "#/definitions/DifferenceDTO" - } - } - } - }, - "ComponentHistoryDTO" : { - "type" : "object", - "properties" : { - "componentId" : { - "type" : "string", - "description" : "The component id." - }, - "propertyHistory" : { - "type" : "object", - "description" : "The history for the properties of the component.", - "additionalProperties" : { - "$ref" : "#/definitions/PropertyHistoryDTO" - } - } - } - }, - "ComponentHistoryEntity" : { - "type" : "object", - "properties" : { - "componentHistory" : { - "$ref" : "#/definitions/ComponentHistoryDTO" - } - }, - "xml" : { - "name" : "componentHistoryEntity" - } - }, - "ComponentReferenceDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "versionedComponentId" : { - "type" : "string", - "description" : "The ID of the corresponding component that is under version control" - }, - "parentGroupId" : { - "type" : "string", - "description" : "The id of parent process group of this component if applicable." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "name" : { - "type" : "string", - "description" : "The name of the component." - } - } - }, - "ComponentReferenceEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "parentGroupId" : { - "type" : "string", - "description" : "The id of parent process group of this component if applicable." - }, - "component" : { - "$ref" : "#/definitions/ComponentReferenceDTO" - } - }, - "xml" : { - "name" : "componentReferenceEntity" - } - }, - "ComponentRestrictionPermissionDTO" : { - "type" : "object", - "properties" : { - "requiredPermission" : { - "description" : "The required permission necessary for this restriction.", - "$ref" : "#/definitions/RequiredPermissionDTO" - }, - "permissions" : { - "description" : "The permissions for this component restriction. Note: the read permission are not used and will always be false.", - "$ref" : "#/definitions/PermissionsDTO" - } - } - }, - "ComponentSearchResultDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component that matched the search." - }, - "groupId" : { - "type" : "string", - "description" : "The group id of the component that matched the search." - }, - "parentGroup" : { - "description" : "The parent group of the component that matched the search.", - "$ref" : "#/definitions/SearchResultGroupDTO" - }, - "versionedGroup" : { - "description" : "The nearest versioned ancestor group of the component that matched the search.", - "$ref" : "#/definitions/SearchResultGroupDTO" - }, - "name" : { - "type" : "string", - "description" : "The name of the component that matched the search." - }, - "matches" : { - "type" : "array", - "description" : "What matched the search from the component.", - "items" : { - "type" : "string" - } - } - } - }, - "ComponentStateDTO" : { - "type" : "object", - "properties" : { - "componentId" : { - "type" : "string", - "description" : "The component identifier." - }, - "stateDescription" : { - "type" : "string", - "description" : "Description of the state this component persists." - }, - "clusterState" : { - "description" : "The cluster state for this component, or null if this NiFi is a standalone instance.", - "$ref" : "#/definitions/StateMapDTO" - }, - "localState" : { - "description" : "The local state for this component.", - "$ref" : "#/definitions/StateMapDTO" - } - } - }, - "ComponentStateEntity" : { - "type" : "object", - "properties" : { - "componentState" : { - "description" : "The component state.", - "$ref" : "#/definitions/ComponentStateDTO" - } - }, - "xml" : { - "name" : "componentStateEntity" - } - }, - "ComponentValidationResultDTO" : { - "type" : "object", - "properties" : { - "processGroupId" : { - "type" : "string", - "description" : "The UUID of the Process Group that this component is in" - }, - "id" : { - "type" : "string", - "description" : "The UUID of this component" - }, - "referenceType" : { - "type" : "string", - "description" : "The type of this component", - "enum" : [ "PROCESSOR", "CONTROLLER_SERVICE", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT" ] - }, - "name" : { - "type" : "string", - "description" : "The name of this component." - }, - "state" : { - "type" : "string", - "description" : "The scheduled state of a processor or reporting task referencing a controller service. If this component is another controller service, this field represents the controller service state." - }, - "activeThreadCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of active threads for the referencing component." - }, - "validationErrors" : { - "type" : "array", - "description" : "The validation errors for the component.", - "items" : { - "type" : "string" - } - }, - "currentlyValid" : { - "type" : "boolean", - "description" : "Whether or not the component is currently valid" - }, - "resultsValid" : { - "type" : "boolean", - "description" : "Whether or not the component will be valid if the Parameter Context is changed" - }, - "resultantValidationErrors" : { - "type" : "array", - "description" : "The validation errors that will apply to the component if the Parameter Context is changed", - "items" : { - "type" : "string" - } - } - } - }, - "ComponentValidationResultEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "component" : { - "$ref" : "#/definitions/ComponentValidationResultDTO" - } - }, - "xml" : { - "name" : "componentValidationResultEntity" - } - }, - "ComponentValidationResultsEntity" : { - "type" : "object", - "properties" : { - "validationResults" : { - "type" : "array", - "description" : "A List of ComponentValidationResultEntity, one for each component that is validated", - "items" : { - "$ref" : "#/definitions/ComponentValidationResultEntity" - } - } - }, - "xml" : { - "name" : "componentValidationResults" - } - }, - "ConnectableComponent" : { - "type" : "object", - "required" : [ "groupId", "id", "type" ], - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the connectable component." - }, - "type" : { - "type" : "string", - "description" : "The type of component the connectable is.", - "enum" : [ "PROCESSOR", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "INPUT_PORT", "OUTPUT_PORT", "FUNNEL" ] - }, - "groupId" : { - "type" : "string", - "description" : "The id of the group that the connectable component resides in" - }, - "name" : { - "type" : "string", - "description" : "The name of the connectable component" - }, - "comments" : { - "type" : "string", - "description" : "The comments for the connectable component." - } - } - }, - "ConnectableDTO" : { - "type" : "object", - "required" : [ "groupId", "id", "type" ], - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the connectable component." - }, - "versionedComponentId" : { - "type" : "string", - "description" : "The ID of the corresponding component that is under version control" - }, - "type" : { - "type" : "string", - "description" : "The type of component the connectable is.", - "enum" : [ "PROCESSOR", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "INPUT_PORT", "OUTPUT_PORT", "FUNNEL" ] - }, - "groupId" : { - "type" : "string", - "description" : "The id of the group that the connectable component resides in" - }, - "name" : { - "type" : "string", - "description" : "The name of the connectable component" - }, - "running" : { - "type" : "boolean", - "description" : "Reflects the current state of the connectable component." - }, - "transmitting" : { - "type" : "boolean", - "description" : "If the connectable component represents a remote port, indicates if the target is configured to transmit." - }, - "exists" : { - "type" : "boolean", - "description" : "If the connectable component represents a remote port, indicates if the target exists." - }, - "comments" : { - "type" : "string", - "description" : "The comments for the connectable component." - } - } - }, - "ConnectionDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "versionedComponentId" : { - "type" : "string", - "description" : "The ID of the corresponding component that is under version control" - }, - "parentGroupId" : { - "type" : "string", - "description" : "The id of parent process group of this component if applicable." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "source" : { - "description" : "The source of the connection.", - "$ref" : "#/definitions/ConnectableDTO" - }, - "destination" : { - "description" : "The destination of the connection.", - "$ref" : "#/definitions/ConnectableDTO" - }, - "name" : { - "type" : "string", - "description" : "The name of the connection." - }, - "labelIndex" : { - "type" : "integer", - "format" : "int32", - "description" : "The index of the bend point where to place the connection label." - }, - "getzIndex" : { - "type" : "integer", - "format" : "int64", - "description" : "The z index of the connection." - }, - "selectedRelationships" : { - "type" : "array", - "description" : "The selected relationship that comprise the connection.", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - }, - "availableRelationships" : { - "type" : "array", - "description" : "The relationships that the source of the connection currently supports.", - "readOnly" : true, - "uniqueItems" : true, - "items" : { - "type" : "string" - } - }, - "backPressureObjectThreshold" : { - "type" : "integer", - "format" : "int64", - "description" : "The object count threshold for determining when back pressure is applied. Updating this value is a passive change in the sense that it won't impact whether existing files over the limit are affected but it does help feeder processors to stop pushing too much into this work queue." - }, - "backPressureDataSizeThreshold" : { - "type" : "string", - "description" : "The object data size threshold for determining when back pressure is applied. Updating this value is a passive change in the sense that it won't impact whether existing files over the limit are affected but it does help feeder processors to stop pushing too much into this work queue." - }, - "flowFileExpiration" : { - "type" : "string", - "description" : "The amount of time a flow file may be in the flow before it will be automatically aged out of the flow. Once a flow file reaches this age it will be terminated from the flow the next time a processor attempts to start work on it." - }, - "prioritizers" : { - "type" : "array", - "description" : "The comparators used to prioritize the queue.", - "items" : { - "type" : "string" - } - }, - "bends" : { - "type" : "array", - "description" : "The bend points on the connection.", - "items" : { - "$ref" : "#/definitions/PositionDTO" - } - }, - "loadBalanceStrategy" : { - "type" : "string", - "description" : "How to load balance the data in this Connection across the nodes in the cluster.", - "enum" : [ "DO_NOT_LOAD_BALANCE", "PARTITION_BY_ATTRIBUTE", "ROUND_ROBIN", "SINGLE_NODE" ] - }, - "loadBalancePartitionAttribute" : { - "type" : "string", - "description" : "The FlowFile Attribute to use for determining which node a FlowFile will go to if the Load Balancing Strategy is set to PARTITION_BY_ATTRIBUTE" - }, - "loadBalanceCompression" : { - "type" : "string", - "description" : "Whether or not data should be compressed when being transferred between nodes in the cluster.", - "enum" : [ "DO_NOT_COMPRESS", "COMPRESS_ATTRIBUTES_ONLY", "COMPRESS_ATTRIBUTES_AND_CONTENT" ] - }, - "loadBalanceStatus" : { - "type" : "string", - "description" : "The current status of the Connection's Load Balancing Activities. Status can indicate that Load Balancing is not configured for the connection, that Load Balancing is configured but inactive (not currently transferring data to another node), or that Load Balancing is configured and actively transferring data to another node.", - "readOnly" : true, - "enum" : [ "LOAD_BALANCE_NOT_CONFIGURED", "LOAD_BALANCE_INACTIVE", "LOAD_BALANCE_ACTIVE" ] - } - } - }, - "ConnectionEntity" : { - "type" : "object", - "required" : [ "destinationType", "sourceType" ], - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "component" : { - "$ref" : "#/definitions/ConnectionDTO" - }, - "status" : { - "description" : "The status of the connection.", - "$ref" : "#/definitions/ConnectionStatusDTO" - }, - "bends" : { - "type" : "array", - "description" : "The bend points on the connection.", - "items" : { - "$ref" : "#/definitions/PositionDTO" - } - }, - "labelIndex" : { - "type" : "integer", - "format" : "int32", - "description" : "The index of the bend point where to place the connection label." - }, - "getzIndex" : { - "type" : "integer", - "format" : "int64", - "description" : "The z index of the connection." - }, - "sourceId" : { - "type" : "string", - "description" : "The identifier of the source of this connection." - }, - "sourceGroupId" : { - "type" : "string", - "description" : "The identifier of the group of the source of this connection." - }, - "sourceType" : { - "type" : "string", - "description" : "The type of component the source connectable is.", - "enum" : [ "PROCESSOR", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "INPUT_PORT", "OUTPUT_PORT", "FUNNEL" ] - }, - "destinationId" : { - "type" : "string", - "description" : "The identifier of the destination of this connection." - }, - "destinationGroupId" : { - "type" : "string", - "description" : "The identifier of the group of the destination of this connection." - }, - "destinationType" : { - "type" : "string", - "description" : "The type of component the destination connectable is.", - "enum" : [ "PROCESSOR", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "INPUT_PORT", "OUTPUT_PORT", "FUNNEL" ] - } - }, - "xml" : { - "name" : "connectionEntity" - } - }, - "ConnectionStatisticsDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The ID of the connection" - }, - "statsLastRefreshed" : { - "type" : "string", - "description" : "The timestamp of when the stats were last refreshed" - }, - "aggregateSnapshot" : { - "description" : "The status snapshot that represents the aggregate stats of the cluster", - "$ref" : "#/definitions/ConnectionStatisticsSnapshotDTO" - }, - "nodeSnapshots" : { - "type" : "array", - "description" : "A list of status snapshots for each node", - "items" : { - "$ref" : "#/definitions/NodeConnectionStatisticsSnapshotDTO" - } - } - } - }, - "ConnectionStatisticsEntity" : { - "type" : "object", - "properties" : { - "connectionStatistics" : { - "$ref" : "#/definitions/ConnectionStatisticsDTO" - }, - "canRead" : { - "type" : "boolean", - "description" : "Indicates whether the user can read a given resource.", - "readOnly" : true - } - }, - "xml" : { - "name" : "connectionStatisticsEntity" - } - }, - "ConnectionStatisticsSnapshotDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the connection." - }, - "predictedMillisUntilCountBackpressure" : { - "type" : "integer", - "format" : "int64", - "description" : "The predicted number of milliseconds before the connection will have backpressure applied, based on the queued count." - }, - "predictedMillisUntilBytesBackpressure" : { - "type" : "integer", - "format" : "int64", - "description" : "The predicted number of milliseconds before the connection will have backpressure applied, based on the total number of bytes in the queue." - }, - "predictedCountAtNextInterval" : { - "type" : "integer", - "format" : "int32", - "description" : "The predicted number of queued objects at the next configured interval." - }, - "predictedBytesAtNextInterval" : { - "type" : "integer", - "format" : "int64", - "description" : "The predicted total number of bytes in the queue at the next configured interval." - }, - "predictedPercentCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The predicted percentage of queued objects at the next configured interval." - }, - "predictedPercentBytes" : { - "type" : "integer", - "format" : "int32", - "description" : "The predicted percentage of bytes in the queue against current threshold at the next configured interval." - }, - "predictionIntervalMillis" : { - "type" : "integer", - "format" : "int64", - "description" : "The prediction interval in seconds" - } - } - }, - "ConnectionStatusDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The ID of the connection" - }, - "groupId" : { - "type" : "string", - "description" : "The ID of the Process Group that the connection belongs to" - }, - "name" : { - "type" : "string", - "description" : "The name of the connection" - }, - "statsLastRefreshed" : { - "type" : "string", - "description" : "The timestamp of when the stats were last refreshed" - }, - "sourceId" : { - "type" : "string", - "description" : "The ID of the source component" - }, - "sourceName" : { - "type" : "string", - "description" : "The name of the source component" - }, - "destinationId" : { - "type" : "string", - "description" : "The ID of the destination component" - }, - "destinationName" : { - "type" : "string", - "description" : "The name of the destination component" - }, - "aggregateSnapshot" : { - "description" : "The status snapshot that represents the aggregate stats of the cluster", - "$ref" : "#/definitions/ConnectionStatusSnapshotDTO" - }, - "nodeSnapshots" : { - "type" : "array", - "description" : "A list of status snapshots for each node", - "items" : { - "$ref" : "#/definitions/NodeConnectionStatusSnapshotDTO" - } - } - } - }, - "ConnectionStatusEntity" : { - "type" : "object", - "properties" : { - "connectionStatus" : { - "$ref" : "#/definitions/ConnectionStatusDTO" - }, - "canRead" : { - "type" : "boolean", - "description" : "Indicates whether the user can read a given resource.", - "readOnly" : true - } - }, - "xml" : { - "name" : "connectionStatusEntity" - } - }, - "ConnectionStatusPredictionsSnapshotDTO" : { - "type" : "object", - "properties" : { - "predictedMillisUntilCountBackpressure" : { - "type" : "integer", - "format" : "int64", - "description" : "The predicted number of milliseconds before the connection will have backpressure applied, based on the queued count." - }, - "predictedMillisUntilBytesBackpressure" : { - "type" : "integer", - "format" : "int64", - "description" : "The predicted number of milliseconds before the connection will have backpressure applied, based on the total number of bytes in the queue." - }, - "predictionIntervalSeconds" : { - "type" : "integer", - "format" : "int32", - "description" : "The configured interval (in seconds) for predicting connection queue count and size (and percent usage)." - }, - "predictedCountAtNextInterval" : { - "type" : "integer", - "format" : "int32", - "description" : "The predicted number of queued objects at the next configured interval." - }, - "predictedBytesAtNextInterval" : { - "type" : "integer", - "format" : "int64", - "description" : "The predicted total number of bytes in the queue at the next configured interval." - }, - "predictedPercentCount" : { - "type" : "integer", - "format" : "int32", - "description" : "Predicted connection percent use regarding queued flow files count and backpressure threshold if configured." - }, - "predictedPercentBytes" : { - "type" : "integer", - "format" : "int32", - "description" : "Predicted connection percent use regarding queued flow files size and backpressure threshold if configured." - } - } - }, - "ConnectionStatusSnapshotDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the connection." - }, - "groupId" : { - "type" : "string", - "description" : "The id of the process group the connection belongs to." - }, - "name" : { - "type" : "string", - "description" : "The name of the connection." - }, - "sourceId" : { - "type" : "string", - "description" : "The id of the source of the connection." - }, - "sourceName" : { - "type" : "string", - "description" : "The name of the source of the connection." - }, - "destinationId" : { - "type" : "string", - "description" : "The id of the destination of the connection." - }, - "destinationName" : { - "type" : "string", - "description" : "The name of the destination of the connection." - }, - "predictions" : { - "description" : "Predictions, if available, for this connection (null if not available)", - "$ref" : "#/definitions/ConnectionStatusPredictionsSnapshotDTO" - }, - "flowFilesIn" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of FlowFiles that have come into the connection in the last 5 minutes." - }, - "bytesIn" : { - "type" : "integer", - "format" : "int64", - "description" : "The size of the FlowFiles that have come into the connection in the last 5 minutes." - }, - "input" : { - "type" : "string", - "description" : "The input count/size for the connection in the last 5 minutes, pretty printed." - }, - "flowFilesOut" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of FlowFiles that have left the connection in the last 5 minutes." - }, - "bytesOut" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes that have left the connection in the last 5 minutes." - }, - "output" : { - "type" : "string", - "description" : "The output count/sie for the connection in the last 5 minutes, pretty printed." - }, - "flowFilesQueued" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of FlowFiles that are currently queued in the connection." - }, - "bytesQueued" : { - "type" : "integer", - "format" : "int64", - "description" : "The size of the FlowFiles that are currently queued in the connection." - }, - "queued" : { - "type" : "string", - "description" : "The total count and size of queued flowfiles formatted." - }, - "queuedSize" : { - "type" : "string", - "description" : "The total size of flowfiles that are queued formatted." - }, - "queuedCount" : { - "type" : "string", - "description" : "The number of flowfiles that are queued, pretty printed." - }, - "percentUseCount" : { - "type" : "integer", - "format" : "int32", - "description" : "Connection percent use regarding queued flow files count and backpressure threshold if configured." - }, - "percentUseBytes" : { - "type" : "integer", - "format" : "int32", - "description" : "Connection percent use regarding queued flow files size and backpressure threshold if configured." - } - } - }, - "ConnectionStatusSnapshotEntity" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the connection." - }, - "connectionStatusSnapshot" : { - "$ref" : "#/definitions/ConnectionStatusSnapshotDTO" - }, - "canRead" : { - "type" : "boolean", - "description" : "Indicates whether the user can read a given resource.", - "readOnly" : true - } - }, - "xml" : { - "name" : "entity" - } - }, - "ConnectionsEntity" : { - "type" : "object", - "properties" : { - "connections" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ConnectionEntity" - } - } - }, - "xml" : { - "name" : "connectionsEntity" - } - }, - "ControllerBulletinsEntity" : { - "type" : "object", - "properties" : { - "bulletins" : { - "type" : "array", - "description" : "System level bulletins to be reported to the user.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "controllerServiceBulletins" : { - "type" : "array", - "description" : "Controller service bulletins to be reported to the user.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "reportingTaskBulletins" : { - "type" : "array", - "description" : "Reporting task bulletins to be reported to the user.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - } - }, - "xml" : { - "name" : "controllerConfigurationEntity" - } - }, - "ControllerConfigurationDTO" : { - "type" : "object", - "properties" : { - "maxTimerDrivenThreadCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The maximum number of timer driven threads the NiFi has available." - }, - "maxEventDrivenThreadCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The maximum number of event driven threads the NiFi has available." - } - } - }, - "ControllerConfigurationEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "component" : { - "description" : "The controller configuration.", - "$ref" : "#/definitions/ControllerConfigurationDTO" - } - }, - "xml" : { - "name" : "controllerConfigurationEntity" - } - }, - "ControllerDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the NiFi." - }, - "name" : { - "type" : "string", - "description" : "The name of the NiFi." - }, - "comments" : { - "type" : "string", - "description" : "The comments for the NiFi." - }, - "runningCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of running components in the NiFi." - }, - "stoppedCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of stopped components in the NiFi." - }, - "invalidCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of invalid components in the NiFi." - }, - "disabledCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of disabled components in the NiFi." - }, - "activeRemotePortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of active remote ports contained in the NiFi." - }, - "inactiveRemotePortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of inactive remote ports contained in the NiFi." - }, - "inputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of input ports contained in the NiFi." - }, - "outputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of output ports in the NiFi." - }, - "remoteSiteListeningPort" : { - "type" : "integer", - "format" : "int32", - "description" : "The Socket Port on which this instance is listening for Remote Transfers of Flow Files. If this instance is not configured to receive Flow Files from remote instances, this will be null." - }, - "remoteSiteHttpListeningPort" : { - "type" : "integer", - "format" : "int32", - "description" : "The HTTP(S) Port on which this instance is listening for Remote Transfers of Flow Files. If this instance is not configured to receive Flow Files from remote instances, this will be null." - }, - "siteToSiteSecure" : { - "type" : "boolean", - "description" : "Indicates whether or not Site-to-Site communications with this instance is secure (2-way authentication)." - }, - "instanceId" : { - "type" : "string", - "description" : "If clustered, the id of the Cluster Manager, otherwise the id of the NiFi." - }, - "inputPorts" : { - "type" : "array", - "description" : "The input ports available to send data to for the NiFi.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/PortDTO" - } - }, - "outputPorts" : { - "type" : "array", - "description" : "The output ports available to received data from the NiFi.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/PortDTO" - } - } - } - }, - "ControllerEntity" : { - "type" : "object", - "properties" : { - "controller" : { - "$ref" : "#/definitions/ControllerDTO" - } - }, - "xml" : { - "name" : "controllerEntity" - } - }, - "ControllerServiceAPI" : { - "type" : "object", - "properties" : { - "type" : { - "type" : "string", - "description" : "The fully qualified name of the service interface." - }, - "bundle" : { - "description" : "The details of the artifact that bundled this service interface.", - "$ref" : "#/definitions/Bundle" - } - } - }, - "ControllerServiceApiDTO" : { - "type" : "object", - "properties" : { - "type" : { - "type" : "string", - "description" : "The fully qualified name of the service interface." - }, - "bundle" : { - "description" : "The details of the artifact that bundled this service interface.", - "$ref" : "#/definitions/BundleDTO" - } - } - }, - "ControllerServiceDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "versionedComponentId" : { - "type" : "string", - "description" : "The ID of the corresponding component that is under version control" - }, - "parentGroupId" : { - "type" : "string", - "description" : "The id of parent process group of this component if applicable." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "name" : { - "type" : "string", - "description" : "The name of the controller service." - }, - "type" : { - "type" : "string", - "description" : "The type of the controller service." - }, - "bundle" : { - "description" : "The details of the artifact that bundled this processor type.", - "$ref" : "#/definitions/BundleDTO" - }, - "controllerServiceApis" : { - "type" : "array", - "description" : "Lists the APIs this Controller Service implements.", - "items" : { - "$ref" : "#/definitions/ControllerServiceApiDTO" - } - }, - "comments" : { - "type" : "string", - "description" : "The comments for the controller service." - }, - "state" : { - "type" : "string", - "description" : "The state of the controller service.", - "enum" : [ "ENABLED", "ENABLING", "DISABLED", "DISABLING" ] - }, - "persistsState" : { - "type" : "boolean", - "description" : "Whether the controller service persists state." - }, - "restricted" : { - "type" : "boolean", - "description" : "Whether the controller service requires elevated privileges." - }, - "deprecated" : { - "type" : "boolean", - "description" : "Whether the ontroller service has been deprecated." - }, - "multipleVersionsAvailable" : { - "type" : "boolean", - "description" : "Whether the controller service has multiple versions available." - }, - "properties" : { - "type" : "object", - "description" : "The properties of the controller service.", - "additionalProperties" : { - "type" : "string" - } - }, - "descriptors" : { - "type" : "object", - "description" : "The descriptors for the controller service properties.", - "additionalProperties" : { - "$ref" : "#/definitions/PropertyDescriptorDTO" - } - }, - "customUiUrl" : { - "type" : "string", - "description" : "The URL for the controller services custom configuration UI if applicable." - }, - "annotationData" : { - "type" : "string", - "description" : "The annotation for the controller service. This is how the custom UI relays configuration to the controller service." - }, - "referencingComponents" : { - "type" : "array", - "description" : "All components referencing this controller service.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ControllerServiceReferencingComponentEntity" - } - }, - "validationErrors" : { - "type" : "array", - "description" : "The validation errors from the controller service. These validation errors represent the problems with the controller service that must be resolved before it can be enabled.", - "items" : { - "type" : "string" - } - }, - "validationStatus" : { - "type" : "string", - "description" : "Indicates whether the ControllerService is valid, invalid, or still in the process of validating (i.e., it is unknown whether or not the ControllerService is valid)", - "readOnly" : true, - "enum" : [ "VALID", "INVALID", "VALIDATING" ] - }, - "extensionMissing" : { - "type" : "boolean", - "description" : "Whether the underlying extension is missing." - } - } - }, - "ControllerServiceEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "parentGroupId" : { - "type" : "string", - "description" : "The id of parent process group of this ControllerService." - }, - "component" : { - "$ref" : "#/definitions/ControllerServiceDTO" - }, - "operatePermissions" : { - "description" : "The permissions for this component operations.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "status" : { - "description" : "The status for this ControllerService.", - "readOnly" : true, - "$ref" : "#/definitions/ControllerServiceStatusDTO" - } - }, - "xml" : { - "name" : "controllerServiceEntity" - } - }, - "ControllerServiceReferencingComponentDTO" : { - "type" : "object", - "properties" : { - "groupId" : { - "type" : "string", - "description" : "The group id for the component referencing a controller service. If this component is another controller service or a reporting task, this field is blank." - }, - "id" : { - "type" : "string", - "description" : "The id of the component referencing a controller service." - }, - "name" : { - "type" : "string", - "description" : "The name of the component referencing a controller service." - }, - "type" : { - "type" : "string", - "description" : "The type of the component referencing a controller service in simple Java class name format without package name." - }, - "state" : { - "type" : "string", - "description" : "The scheduled state of a processor or reporting task referencing a controller service. If this component is another controller service, this field represents the controller service state." - }, - "properties" : { - "type" : "object", - "description" : "The properties for the component.", - "additionalProperties" : { - "type" : "string" - } - }, - "descriptors" : { - "type" : "object", - "description" : "The descriptors for the component properties.", - "additionalProperties" : { - "$ref" : "#/definitions/PropertyDescriptorDTO" - } - }, - "validationErrors" : { - "type" : "array", - "description" : "The validation errors for the component.", - "items" : { - "type" : "string" - } - }, - "referenceType" : { - "type" : "string", - "description" : "The type of reference this is.", - "enum" : [ "Processor", "ControllerService", "ReportingTask" ] - }, - "activeThreadCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of active threads for the referencing component." - }, - "referenceCycle" : { - "type" : "boolean", - "description" : "If the referencing component represents a controller service, this indicates whether it has already been represented in this hierarchy." - }, - "referencingComponents" : { - "type" : "array", - "description" : "If the referencing component represents a controller service, these are the components that reference it.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ControllerServiceReferencingComponentEntity" - } - } - } - }, - "ControllerServiceReferencingComponentEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "component" : { - "$ref" : "#/definitions/ControllerServiceReferencingComponentDTO" - }, - "operatePermissions" : { - "description" : "The permissions for this component operations.", - "$ref" : "#/definitions/PermissionsDTO" - } - }, - "xml" : { - "name" : "controllerServiceReferencingComponentEntity" - } - }, - "ControllerServiceReferencingComponentsEntity" : { - "type" : "object", - "properties" : { - "controllerServiceReferencingComponents" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ControllerServiceReferencingComponentEntity" - } - } - }, - "xml" : { - "name" : "controllerServiceReferencingComponentsEntity" - } - }, - "ControllerServiceRunStatusEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "state" : { - "type" : "string", - "description" : "The run status of the ControllerService.", - "enum" : [ "ENABLED", "DISABLED" ] - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - } - }, - "xml" : { - "name" : "entity" - } - }, - "ControllerServiceStatusDTO" : { - "type" : "object", - "properties" : { - "runStatus" : { - "type" : "string", - "description" : "The run status of this ControllerService", - "readOnly" : true, - "enum" : [ "ENABLED", "ENABLING", "DISABLED", "DISABLING" ] - }, - "validationStatus" : { - "type" : "string", - "description" : "Indicates whether the component is valid, invalid, or still in the process of validating (i.e., it is unknown whether or not the component is valid)", - "readOnly" : true, - "enum" : [ "VALID", "INVALID", "VALIDATING" ] - }, - "activeThreadCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of active threads for the component." - } - } - }, - "ControllerServiceTypesEntity" : { - "type" : "object", - "properties" : { - "controllerServiceTypes" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/DocumentedTypeDTO" - } - } - }, - "xml" : { - "name" : "controllerServiceTypesEntity" - } - }, - "ControllerServicesEntity" : { - "type" : "object", - "properties" : { - "currentTime" : { - "type" : "string", - "description" : "The current time on the system." - }, - "controllerServices" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ControllerServiceEntity" - } - } - }, - "xml" : { - "name" : "controllerServicesEntity" - } - }, - "ControllerStatusDTO" : { - "type" : "object", - "properties" : { - "activeThreadCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of active threads in the NiFi." - }, - "terminatedThreadCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of terminated threads in the NiFi." - }, - "queued" : { - "type" : "string", - "description" : "The number of flowfiles queued in the NiFi." - }, - "flowFilesQueued" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of FlowFiles queued across the entire flow" - }, - "bytesQueued" : { - "type" : "integer", - "format" : "int64", - "description" : "The size of the FlowFiles queued across the entire flow" - }, - "runningCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of running components in the NiFi." - }, - "stoppedCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of stopped components in the NiFi." - }, - "invalidCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of invalid components in the NiFi." - }, - "disabledCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of disabled components in the NiFi." - }, - "activeRemotePortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of active remote ports in the NiFi." - }, - "inactiveRemotePortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of inactive remote ports in the NiFi." - }, - "upToDateCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of up to date versioned process groups in the NiFi." - }, - "locallyModifiedCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of locally modified versioned process groups in the NiFi." - }, - "staleCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of stale versioned process groups in the NiFi." - }, - "locallyModifiedAndStaleCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of locally modified and stale versioned process groups in the NiFi." - }, - "syncFailureCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of versioned process groups in the NiFi that are unable to sync to a registry." - } - } - }, - "ControllerStatusEntity" : { - "type" : "object", - "properties" : { - "controllerStatus" : { - "$ref" : "#/definitions/ControllerStatusDTO" - } - }, - "xml" : { - "name" : "controllerStatusEntity" - } - }, - "CopySnippetRequestEntity" : { - "type" : "object", - "properties" : { - "snippetId" : { - "type" : "string", - "description" : "The identifier of the snippet." - }, - "originX" : { - "type" : "number", - "format" : "double", - "description" : "The x coordinate of the origin of the bounding box where the new components will be placed." - }, - "originY" : { - "type" : "number", - "format" : "double", - "description" : "The y coordinate of the origin of the bounding box where the new components will be placed." - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - } - }, - "xml" : { - "name" : "copySnippetRequestEntity" - } - }, - "CounterDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the counter." - }, - "context" : { - "type" : "string", - "description" : "The context of the counter." - }, - "name" : { - "type" : "string", - "description" : "The name of the counter." - }, - "valueCount" : { - "type" : "integer", - "format" : "int64", - "description" : "The value count." - }, - "value" : { - "type" : "string", - "description" : "The value of the counter." - } - } - }, - "CounterEntity" : { - "type" : "object", - "properties" : { - "counter" : { - "$ref" : "#/definitions/CounterDTO" - } - }, - "xml" : { - "name" : "counterEntity" - } - }, - "CountersDTO" : { - "type" : "object", - "properties" : { - "aggregateSnapshot" : { - "description" : "A Counters snapshot that represents the aggregate values of all nodes in the cluster. If the NiFi instance is a standalone instance, rather than a cluster, this represents the stats of the single instance.", - "$ref" : "#/definitions/CountersSnapshotDTO" - }, - "nodeSnapshots" : { - "type" : "array", - "description" : "A Counters snapshot for each node in the cluster. If the NiFi instance is a standalone instance, rather than a cluster, this may be null.", - "items" : { - "$ref" : "#/definitions/NodeCountersSnapshotDTO" - } - } - } - }, - "CountersEntity" : { - "type" : "object", - "properties" : { - "counters" : { - "$ref" : "#/definitions/CountersDTO" - } - }, - "xml" : { - "name" : "countersEntity" - } - }, - "CountersSnapshotDTO" : { - "type" : "object", - "properties" : { - "generated" : { - "type" : "string", - "description" : "The timestamp when the report was generated." - }, - "counters" : { - "type" : "array", - "description" : "All counters in the NiFi.", - "items" : { - "$ref" : "#/definitions/CounterDTO" - } - } - } - }, - "CreateActiveRequestEntity" : { - "type" : "object", - "properties" : { - "processGroupId" : { - "type" : "string", - "description" : "The Process Group ID that this active request will update" - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - } - }, - "xml" : { - "name" : "createActiveRequestEntity" - } - }, - "CreateTemplateRequestEntity" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The name of the template." - }, - "description" : { - "type" : "string", - "description" : "The description of the template." - }, - "snippetId" : { - "type" : "string", - "description" : "The identifier of the snippet." - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - } - }, - "xml" : { - "name" : "createTemplateRequestEntity" - } - }, - "CurrentUserEntity" : { - "type" : "object", - "properties" : { - "identity" : { - "type" : "string", - "description" : "The user identity being serialized." - }, - "anonymous" : { - "type" : "boolean", - "description" : "Whether the current user is anonymous." - }, - "provenancePermissions" : { - "description" : "Permissions for querying provenance.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "countersPermissions" : { - "description" : "Permissions for accessing counters.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "tenantsPermissions" : { - "description" : "Permissions for accessing tenants.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "controllerPermissions" : { - "description" : "Permissions for accessing the controller.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "policiesPermissions" : { - "description" : "Permissions for accessing the policies.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "systemPermissions" : { - "description" : "Permissions for accessing system.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "parameterContextPermissions" : { - "description" : "Permissions for accessing parameter contexts.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "restrictedComponentsPermissions" : { - "description" : "Permissions for accessing restricted components. Note: the read permission are not used and will always be false.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "componentRestrictionPermissions" : { - "type" : "array", - "description" : "Permissions for specific component restrictions.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ComponentRestrictionPermissionDTO" - } - }, - "canVersionFlows" : { - "type" : "boolean", - "description" : "Whether the current user can version flows." - } - }, - "xml" : { - "name" : "currentEntity" - } - }, - "DifferenceDTO" : { - "type" : "object", - "properties" : { - "differenceType" : { - "type" : "string", - "description" : "The type of difference" - }, - "difference" : { - "type" : "string", - "description" : "Description of the difference" - } - } - }, - "DimensionsDTO" : { - "type" : "object", - "properties" : { - "width" : { - "type" : "number", - "format" : "double", - "description" : "The width of the label in pixels when at a 1:1 scale." - }, - "height" : { - "type" : "number", - "format" : "double", - "description" : "The height of the label in pixels when at a 1:1 scale." - } - } - }, - "DocumentedTypeDTO" : { - "type" : "object", - "properties" : { - "type" : { - "type" : "string", - "description" : "The fully qualified name of the type." - }, - "bundle" : { - "description" : "The details of the artifact that bundled this type.", - "$ref" : "#/definitions/BundleDTO" - }, - "controllerServiceApis" : { - "type" : "array", - "description" : "If this type represents a ControllerService, this lists the APIs it implements.", - "items" : { - "$ref" : "#/definitions/ControllerServiceApiDTO" - } - }, - "description" : { - "type" : "string", - "description" : "The description of the type." - }, - "restricted" : { - "type" : "boolean", - "description" : "Whether this type is restricted." - }, - "usageRestriction" : { - "type" : "string", - "description" : "The optional description of why the usage of this component is restricted." - }, - "explicitRestrictions" : { - "type" : "array", - "description" : "An optional collection of explicit restrictions. If specified, these explicit restrictions will be enfored.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ExplicitRestrictionDTO" - } - }, - "deprecationReason" : { - "type" : "string", - "description" : "The description of why the usage of this component is restricted." - }, - "tags" : { - "type" : "array", - "description" : "The tags associated with this type.", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - } - } - }, - "DropRequestDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id for this drop request." - }, - "uri" : { - "type" : "string", - "description" : "The URI for future requests to this drop request." - }, - "submissionTime" : { - "type" : "string", - "description" : "The timestamp when the query was submitted." - }, - "lastUpdated" : { - "type" : "string", - "description" : "The last time this drop request was updated." - }, - "percentCompleted" : { - "type" : "integer", - "format" : "int32", - "description" : "The current percent complete." - }, - "finished" : { - "type" : "boolean", - "description" : "Whether the query has finished." - }, - "failureReason" : { - "type" : "string", - "description" : "The reason, if any, that this drop request failed." - }, - "currentCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of flow files currently queued." - }, - "currentSize" : { - "type" : "integer", - "format" : "int64", - "description" : "The size of flow files currently queued in bytes." - }, - "current" : { - "type" : "string", - "description" : "The count and size of flow files currently queued." - }, - "originalCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of flow files to be dropped as a result of this request." - }, - "originalSize" : { - "type" : "integer", - "format" : "int64", - "description" : "The size of flow files to be dropped as a result of this request in bytes." - }, - "original" : { - "type" : "string", - "description" : "The count and size of flow files to be dropped as a result of this request." - }, - "droppedCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of flow files that have been dropped thus far." - }, - "droppedSize" : { - "type" : "integer", - "format" : "int64", - "description" : "The size of flow files that have been dropped thus far in bytes." - }, - "dropped" : { - "type" : "string", - "description" : "The count and size of flow files that have been dropped thus far." - }, - "state" : { - "type" : "string", - "description" : "The current state of the drop request." - } - } - }, - "DropRequestEntity" : { - "type" : "object", - "properties" : { - "dropRequest" : { - "$ref" : "#/definitions/DropRequestDTO" - } - }, - "xml" : { - "name" : "dropRequestEntity" - } - }, - "ExplicitRestrictionDTO" : { - "type" : "object", - "properties" : { - "requiredPermission" : { - "description" : "The required permission necessary for this restriction.", - "$ref" : "#/definitions/RequiredPermissionDTO" - }, - "explanation" : { - "type" : "string", - "description" : "The description of why the usage of this component is restricted for this required permission." - } - } - }, - "ExternalControllerServiceReference" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The identifier of the controller service" - }, - "name" : { - "type" : "string", - "description" : "The name of the controller service" - } - } - }, - "FlowBreadcrumbDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the group." - }, - "name" : { - "type" : "string", - "description" : "The id of the group." - }, - "versionControlInformation" : { - "description" : "The process group version control information or null if not version controlled.", - "$ref" : "#/definitions/VersionControlInformationDTO" - } - } - }, - "FlowBreadcrumbEntity" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of this ancestor ProcessGroup." - }, - "permissions" : { - "description" : "The permissions for this ancestor ProcessGroup.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "versionedFlowState" : { - "type" : "string", - "description" : "The current state of the Process Group, as it relates to the Versioned Flow", - "readOnly" : true, - "enum" : [ "LOCALLY_MODIFIED", "STALE", "LOCALLY_MODIFIED_AND_STALE", "UP_TO_DATE", "SYNC_FAILURE" ] - }, - "breadcrumb" : { - "description" : "This breadcrumb.", - "$ref" : "#/definitions/FlowBreadcrumbDTO" - }, - "parentBreadcrumb" : { - "description" : "The parent breadcrumb for this breadcrumb.", - "$ref" : "#/definitions/FlowBreadcrumbEntity" - } - }, - "xml" : { - "name" : "flowEntity" - } - }, - "FlowComparisonEntity" : { - "type" : "object", - "properties" : { - "componentDifferences" : { - "type" : "array", - "description" : "The list of differences for each component in the flow that is not the same between the two flows", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ComponentDifferenceDTO" - } - } - }, - "xml" : { - "name" : "flowComparisonEntity" - } - }, - "FlowConfigurationDTO" : { - "type" : "object", - "properties" : { - "supportsManagedAuthorizer" : { - "type" : "boolean", - "description" : "Whether this NiFi supports a managed authorizer. Managed authorizers can visualize users, groups, and policies in the UI.", - "readOnly" : true - }, - "supportsConfigurableAuthorizer" : { - "type" : "boolean", - "description" : "Whether this NiFi supports a configurable authorizer.", - "readOnly" : true - }, - "supportsConfigurableUsersAndGroups" : { - "type" : "boolean", - "description" : "Whether this NiFi supports configurable users and groups.", - "readOnly" : true - }, - "autoRefreshIntervalSeconds" : { - "type" : "integer", - "format" : "int64", - "description" : "The interval in seconds between the automatic NiFi refresh requests.", - "readOnly" : true - }, - "currentTime" : { - "type" : "string", - "description" : "The current time on the system." - }, - "timeOffset" : { - "type" : "integer", - "format" : "int32", - "description" : "The time offset of the system." - }, - "defaultBackPressureObjectThreshold" : { - "type" : "integer", - "format" : "int64", - "description" : "The default back pressure object threshold." - }, - "defaultBackPressureDataSizeThreshold" : { - "type" : "string", - "description" : "The default back pressure data size threshold." - } - } - }, - "FlowConfigurationEntity" : { - "type" : "object", - "properties" : { - "flowConfiguration" : { - "description" : "The controller configuration.", - "$ref" : "#/definitions/FlowConfigurationDTO" - } - }, - "xml" : { - "name" : "flowConfigurationEntity" - } - }, - "FlowDTO" : { - "type" : "object", - "properties" : { - "processGroups" : { - "type" : "array", - "description" : "The process groups in this flow.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ProcessGroupEntity" - } - }, - "remoteProcessGroups" : { - "type" : "array", - "description" : "The remote process groups in this flow.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/RemoteProcessGroupEntity" - } - }, - "processors" : { - "type" : "array", - "description" : "The processors in this flow.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ProcessorEntity" - } - }, - "inputPorts" : { - "type" : "array", - "description" : "The input ports in this flow.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/PortEntity" - } - }, - "outputPorts" : { - "type" : "array", - "description" : "The output ports in this flow.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/PortEntity" - } - }, - "connections" : { - "type" : "array", - "description" : "The connections in this flow.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ConnectionEntity" - } - }, - "labels" : { - "type" : "array", - "description" : "The labels in this flow.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/LabelEntity" - } - }, - "funnels" : { - "type" : "array", - "description" : "The funnels in this flow.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/FunnelEntity" - } - } - } - }, - "FlowEntity" : { - "type" : "object", - "properties" : { - "flow" : { - "$ref" : "#/definitions/FlowDTO" - } - }, - "xml" : { - "name" : "flowEntity" - } - }, - "FlowFileDTO" : { - "type" : "object", - "properties" : { - "uri" : { - "type" : "string", - "description" : "The URI that can be used to access this FlowFile." - }, - "uuid" : { - "type" : "string", - "description" : "The FlowFile UUID." - }, - "filename" : { - "type" : "string", - "description" : "The FlowFile filename." - }, - "position" : { - "type" : "integer", - "format" : "int32", - "description" : "The FlowFile's position in the queue." - }, - "size" : { - "type" : "integer", - "format" : "int64", - "description" : "The FlowFile file size." - }, - "queuedDuration" : { - "type" : "integer", - "format" : "int64", - "description" : "How long this FlowFile has been enqueued." - }, - "lineageDuration" : { - "type" : "integer", - "format" : "int64", - "description" : "Duration since the FlowFile's greatest ancestor entered the flow." - }, - "penaltyExpiresIn" : { - "type" : "integer", - "format" : "int64", - "description" : "How long in milliseconds until the FlowFile penalty expires." - }, - "clusterNodeId" : { - "type" : "string", - "description" : "The id of the node where this FlowFile resides." - }, - "clusterNodeAddress" : { - "type" : "string", - "description" : "The label for the node where this FlowFile resides." - }, - "attributes" : { - "type" : "object", - "description" : "The FlowFile attributes.", - "additionalProperties" : { - "type" : "string" - } - }, - "contentClaimSection" : { - "type" : "string", - "description" : "The section in which the content claim lives." - }, - "contentClaimContainer" : { - "type" : "string", - "description" : "The container in which the content claim lives." - }, - "contentClaimIdentifier" : { - "type" : "string", - "description" : "The identifier of the content claim." - }, - "contentClaimOffset" : { - "type" : "integer", - "format" : "int64", - "description" : "The offset into the content claim where the flowfile's content begins." - }, - "contentClaimFileSize" : { - "type" : "string", - "description" : "The file size of the content claim formatted." - }, - "contentClaimFileSizeBytes" : { - "type" : "integer", - "format" : "int64", - "description" : "The file size of the content claim in bytes." - }, - "penalized" : { - "type" : "boolean", - "description" : "If the FlowFile is penalized." - } - } - }, - "FlowFileEntity" : { - "type" : "object", - "properties" : { - "flowFile" : { - "$ref" : "#/definitions/FlowFileDTO" - } - }, - "xml" : { - "name" : "flowFileEntity" - } - }, - "FlowFileSummaryDTO" : { - "type" : "object", - "properties" : { - "uri" : { - "type" : "string", - "description" : "The URI that can be used to access this FlowFile." - }, - "uuid" : { - "type" : "string", - "description" : "The FlowFile UUID." - }, - "filename" : { - "type" : "string", - "description" : "The FlowFile filename." - }, - "position" : { - "type" : "integer", - "format" : "int32", - "description" : "The FlowFile's position in the queue." - }, - "size" : { - "type" : "integer", - "format" : "int64", - "description" : "The FlowFile file size." - }, - "queuedDuration" : { - "type" : "integer", - "format" : "int64", - "description" : "How long this FlowFile has been enqueued." - }, - "lineageDuration" : { - "type" : "integer", - "format" : "int64", - "description" : "Duration since the FlowFile's greatest ancestor entered the flow." - }, - "penaltyExpiresIn" : { - "type" : "integer", - "format" : "int64", - "description" : "How long in milliseconds until the FlowFile penalty expires." - }, - "clusterNodeId" : { - "type" : "string", - "description" : "The id of the node where this FlowFile resides." - }, - "clusterNodeAddress" : { - "type" : "string", - "description" : "The label for the node where this FlowFile resides." - }, - "penalized" : { - "type" : "boolean", - "description" : "If the FlowFile is penalized." - } - } - }, - "FlowSnippetDTO" : { - "type" : "object", - "properties" : { - "processGroups" : { - "type" : "array", - "description" : "The process groups in this flow snippet.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ProcessGroupDTO" - } - }, - "remoteProcessGroups" : { - "type" : "array", - "description" : "The remote process groups in this flow snippet.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/RemoteProcessGroupDTO" - } - }, - "processors" : { - "type" : "array", - "description" : "The processors in this flow snippet.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ProcessorDTO" - } - }, - "inputPorts" : { - "type" : "array", - "description" : "The input ports in this flow snippet.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/PortDTO" - } - }, - "outputPorts" : { - "type" : "array", - "description" : "The output ports in this flow snippet.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/PortDTO" - } - }, - "connections" : { - "type" : "array", - "description" : "The connections in this flow snippet.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ConnectionDTO" - } - }, - "labels" : { - "type" : "array", - "description" : "The labels in this flow snippet.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/LabelDTO" - } - }, - "funnels" : { - "type" : "array", - "description" : "The funnels in this flow snippet.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/FunnelDTO" - } - }, - "controllerServices" : { - "type" : "array", - "description" : "The controller services in this flow snippet.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ControllerServiceDTO" - } - } - } - }, - "FunnelDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "versionedComponentId" : { - "type" : "string", - "description" : "The ID of the corresponding component that is under version control" - }, - "parentGroupId" : { - "type" : "string", - "description" : "The id of parent process group of this component if applicable." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - } - } - }, - "FunnelEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "component" : { - "$ref" : "#/definitions/FunnelDTO" - } - }, - "xml" : { - "name" : "funnelEntity" - } - }, - "FunnelsEntity" : { - "type" : "object", - "properties" : { - "funnels" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/FunnelEntity" - } - } - }, - "xml" : { - "name" : "funnelsEntity" - } - }, - "GarbageCollectionDTO" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The name of the garbage collector." - }, - "collectionCount" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of times garbage collection has run." - }, - "collectionTime" : { - "type" : "string", - "description" : "The total amount of time spent garbage collecting." - }, - "collectionMillis" : { - "type" : "integer", - "format" : "int64", - "description" : "The total number of milliseconds spent garbage collecting." - } - } - }, - "HistoryDTO" : { - "type" : "object", - "properties" : { - "total" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of number of actions that matched the search criteria.." - }, - "lastRefreshed" : { - "type" : "string", - "description" : "The timestamp when the report was generated." - }, - "actions" : { - "type" : "array", - "description" : "The actions.", - "items" : { - "$ref" : "#/definitions/ActionEntity" - } - } - } - }, - "HistoryEntity" : { - "type" : "object", - "properties" : { - "history" : { - "$ref" : "#/definitions/HistoryDTO" - } - }, - "xml" : { - "name" : "historyEntity" - } - }, - "InputPortsEntity" : { - "type" : "object", - "properties" : { - "inputPorts" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/PortEntity" - } - } - }, - "xml" : { - "name" : "inputPortsEntity" - } - }, - "InstantiateTemplateRequestEntity" : { - "type" : "object", - "properties" : { - "originX" : { - "type" : "number", - "format" : "double", - "description" : "The x coordinate of the origin of the bounding box where the new components will be placed." - }, - "originY" : { - "type" : "number", - "format" : "double", - "description" : "The y coordinate of the origin of the bounding box where the new components will be placed." - }, - "templateId" : { - "type" : "string", - "description" : "The identifier of the template." - }, - "encodingVersion" : { - "type" : "string", - "description" : "The encoding version of the flow snippet. If not specified, this is automatically populated by the node receiving the user request. If the snippet is specified, the version will be the latest. If the snippet is not specified, the version will come from the underlying template. These details need to be replicated throughout the cluster to ensure consistency." - }, - "snippet" : { - "description" : "A flow snippet of the template contents. If not specified, this is automatically populated by the node receiving the user request. These details need to be replicated throughout the cluster to ensure consistency.", - "$ref" : "#/definitions/FlowSnippetDTO" - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - } - }, - "xml" : { - "name" : "instantiateTemplateRequestEntity" - } - }, - "JaxbLink" : { - "type" : "object", - "properties" : { - "href" : { - "type" : "string", - "format" : "uri", - "xml" : { - "attribute" : true - }, - "description" : "The href for the link" - }, - "params" : { - "type" : "object", - "description" : "The params for the link", - "additionalProperties" : { - "type" : "string" - } - } - } - }, - "LabelDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "versionedComponentId" : { - "type" : "string", - "description" : "The ID of the corresponding component that is under version control" - }, - "parentGroupId" : { - "type" : "string", - "description" : "The id of parent process group of this component if applicable." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "label" : { - "type" : "string", - "description" : "The text that appears in the label." - }, - "width" : { - "type" : "number", - "format" : "double", - "description" : "The width of the label in pixels when at a 1:1 scale." - }, - "height" : { - "type" : "number", - "format" : "double", - "description" : "The height of the label in pixels when at a 1:1 scale." - }, - "style" : { - "type" : "object", - "description" : "The styles for this label (font-size : 12px, background-color : #eee, etc).", - "additionalProperties" : { - "type" : "string" - } - } - } - }, - "LabelEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "dimensions" : { - "$ref" : "#/definitions/DimensionsDTO" - }, - "component" : { - "$ref" : "#/definitions/LabelDTO" - } - }, - "xml" : { - "name" : "labelEntity" - } - }, - "LabelsEntity" : { - "type" : "object", - "properties" : { - "labels" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/LabelEntity" - } - } - }, - "xml" : { - "name" : "labelsEntity" - } - }, - "LineageDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of this lineage query." - }, - "uri" : { - "type" : "string", - "description" : "The URI for this lineage query for later retrieval and deletion." - }, - "submissionTime" : { - "type" : "string", - "description" : "When the lineage query was submitted." - }, - "expiration" : { - "type" : "string", - "description" : "When the lineage query will expire." - }, - "percentCompleted" : { - "type" : "integer", - "format" : "int32", - "description" : "The percent complete for the lineage query." - }, - "finished" : { - "type" : "boolean", - "description" : "Whether the lineage query has finished." - }, - "request" : { - "description" : "The initial lineage result.", - "$ref" : "#/definitions/LineageRequestDTO" - }, - "results" : { - "description" : "The results of the lineage query.", - "$ref" : "#/definitions/LineageResultsDTO" - } - } - }, - "LineageEntity" : { - "type" : "object", - "properties" : { - "lineage" : { - "$ref" : "#/definitions/LineageDTO" - } - }, - "xml" : { - "name" : "lineageEntity" - } - }, - "LineageRequestDTO" : { - "type" : "object", - "properties" : { - "eventId" : { - "type" : "integer", - "format" : "int64", - "description" : "The event id that was used to generate this lineage, if applicable. The event id is allowed for any type of lineageRequestType. If the lineageRequestType is FLOWFILE and the flowfile uuid is also included in the request, the event id will be ignored." - }, - "lineageRequestType" : { - "type" : "string", - "description" : "The type of lineage request. PARENTS will return the lineage for the flowfiles that are parents of the specified event. CHILDREN will return the lineage for the flowfiles that are children of the specified event. FLOWFILE will return the lineage for the specified flowfile.", - "enum" : [ "PARENTS", "CHILDREN", "and FLOWFILE" ] - }, - "uuid" : { - "type" : "string", - "description" : "The flowfile uuid that was used to generate the lineage. The flowfile uuid is only allowed when the lineageRequestType is FLOWFILE and will take precedence over event id." - }, - "clusterNodeId" : { - "type" : "string", - "description" : "The id of the node where this lineage originated if clustered." - } - } - }, - "LineageResultsDTO" : { - "type" : "object", - "properties" : { - "errors" : { - "type" : "array", - "description" : "Any errors that occurred while generating the lineage.", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - }, - "nodes" : { - "type" : "array", - "description" : "The nodes in the lineage.", - "items" : { - "$ref" : "#/definitions/ProvenanceNodeDTO" - } - }, - "links" : { - "type" : "array", - "description" : "The links between the nodes in the lineage.", - "items" : { - "$ref" : "#/definitions/ProvenanceLinkDTO" - } - } - } - }, - "ListingRequestDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id for this listing request." - }, - "uri" : { - "type" : "string", - "description" : "The URI for future requests to this listing request." - }, - "submissionTime" : { - "type" : "string", - "description" : "The timestamp when the query was submitted." - }, - "lastUpdated" : { - "type" : "string", - "description" : "The last time this listing request was updated." - }, - "percentCompleted" : { - "type" : "integer", - "format" : "int32", - "description" : "The current percent complete." - }, - "finished" : { - "type" : "boolean", - "description" : "Whether the query has finished." - }, - "failureReason" : { - "type" : "string", - "description" : "The reason, if any, that this listing request failed." - }, - "maxResults" : { - "type" : "integer", - "format" : "int32", - "description" : "The maximum number of FlowFileSummary objects to return" - }, - "state" : { - "type" : "string", - "description" : "The current state of the listing request." - }, - "queueSize" : { - "description" : "The size of the queue", - "$ref" : "#/definitions/QueueSizeDTO" - }, - "flowFileSummaries" : { - "type" : "array", - "description" : "The FlowFile summaries. The summaries will be populated once the request has completed.", - "items" : { - "$ref" : "#/definitions/FlowFileSummaryDTO" - } - }, - "sourceRunning" : { - "type" : "boolean", - "description" : "Whether the source of the connection is running" - }, - "destinationRunning" : { - "type" : "boolean", - "description" : "Whether the destination of the connection is running" - } - } - }, - "ListingRequestEntity" : { - "type" : "object", - "properties" : { - "listingRequest" : { - "$ref" : "#/definitions/ListingRequestDTO" - } - }, - "xml" : { - "name" : "listingRequestEntity" - } - }, - "NodeConnectionStatisticsSnapshotDTO" : { - "type" : "object", - "properties" : { - "nodeId" : { - "type" : "string", - "description" : "The unique ID that identifies the node" - }, - "address" : { - "type" : "string", - "description" : "The API address of the node" - }, - "apiPort" : { - "type" : "integer", - "format" : "int32", - "description" : "The API port used to communicate with the node" - }, - "statisticsSnapshot" : { - "description" : "The connection status snapshot from the node.", - "$ref" : "#/definitions/ConnectionStatisticsSnapshotDTO" - } - } - }, - "NodeConnectionStatusSnapshotDTO" : { - "type" : "object", - "properties" : { - "nodeId" : { - "type" : "string", - "description" : "The unique ID that identifies the node" - }, - "address" : { - "type" : "string", - "description" : "The API address of the node" - }, - "apiPort" : { - "type" : "integer", - "format" : "int32", - "description" : "The API port used to communicate with the node" - }, - "statusSnapshot" : { - "description" : "The connection status snapshot from the node.", - "$ref" : "#/definitions/ConnectionStatusSnapshotDTO" - } - } - }, - "NodeCountersSnapshotDTO" : { - "type" : "object", - "properties" : { - "nodeId" : { - "type" : "string", - "description" : "The unique ID that identifies the node" - }, - "address" : { - "type" : "string", - "description" : "The API address of the node" - }, - "apiPort" : { - "type" : "integer", - "format" : "int32", - "description" : "The API port used to communicate with the node" - }, - "snapshot" : { - "description" : "The counters from the node.", - "$ref" : "#/definitions/CountersSnapshotDTO" - } - } - }, - "NodeDTO" : { - "type" : "object", - "properties" : { - "nodeId" : { - "type" : "string", - "description" : "The id of the node.", - "readOnly" : true - }, - "address" : { - "type" : "string", - "description" : "The node's host/ip address.", - "readOnly" : true - }, - "apiPort" : { - "type" : "integer", - "format" : "int32", - "description" : "The port the node is listening for API requests.", - "readOnly" : true - }, - "status" : { - "type" : "string", - "description" : "The node's status." - }, - "heartbeat" : { - "type" : "string", - "description" : "the time of the nodes's last heartbeat.", - "readOnly" : true - }, - "connectionRequested" : { - "type" : "string", - "description" : "The time of the node's last connection request.", - "readOnly" : true - }, - "roles" : { - "type" : "array", - "description" : "The roles of this node.", - "readOnly" : true, - "uniqueItems" : true, - "items" : { - "type" : "string" - } - }, - "activeThreadCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The active threads for the NiFi on the node.", - "readOnly" : true - }, - "queued" : { - "type" : "string", - "description" : "The queue the NiFi on the node.", - "readOnly" : true - }, - "events" : { - "type" : "array", - "description" : "The node's events.", - "readOnly" : true, - "items" : { - "$ref" : "#/definitions/NodeEventDTO" - } - }, - "nodeStartTime" : { - "type" : "string", - "description" : "The time at which this Node was last refreshed.", - "readOnly" : true - } - } - }, - "NodeEntity" : { - "type" : "object", - "properties" : { - "node" : { - "$ref" : "#/definitions/NodeDTO" - } - }, - "xml" : { - "name" : "nodeEntity" - } - }, - "NodeEventDTO" : { - "type" : "object", - "properties" : { - "timestamp" : { - "type" : "string", - "description" : "The timestamp of the node event." - }, - "category" : { - "type" : "string", - "description" : "The category of the node event." - }, - "message" : { - "type" : "string", - "description" : "The message in the node event." - } - } - }, - "NodePortStatusSnapshotDTO" : { - "type" : "object", - "properties" : { - "nodeId" : { - "type" : "string", - "description" : "The unique ID that identifies the node" - }, - "address" : { - "type" : "string", - "description" : "The API address of the node" - }, - "apiPort" : { - "type" : "integer", - "format" : "int32", - "description" : "The API port used to communicate with the node" - }, - "statusSnapshot" : { - "description" : "The port status snapshot from the node.", - "$ref" : "#/definitions/PortStatusSnapshotDTO" - } - } - }, - "NodeProcessGroupStatusSnapshotDTO" : { - "type" : "object", - "properties" : { - "nodeId" : { - "type" : "string", - "description" : "The unique ID that identifies the node" - }, - "address" : { - "type" : "string", - "description" : "The API address of the node" - }, - "apiPort" : { - "type" : "integer", - "format" : "int32", - "description" : "The API port used to communicate with the node" - }, - "statusSnapshot" : { - "description" : "The process group status snapshot from the node.", - "$ref" : "#/definitions/ProcessGroupStatusSnapshotDTO" - } - } - }, - "NodeProcessorStatusSnapshotDTO" : { - "type" : "object", - "properties" : { - "nodeId" : { - "type" : "string", - "description" : "The unique ID that identifies the node" - }, - "address" : { - "type" : "string", - "description" : "The API address of the node" - }, - "apiPort" : { - "type" : "integer", - "format" : "int32", - "description" : "The API port used to communicate with the node" - }, - "statusSnapshot" : { - "description" : "The processor status snapshot from the node.", - "$ref" : "#/definitions/ProcessorStatusSnapshotDTO" - } - } - }, - "NodeRemoteProcessGroupStatusSnapshotDTO" : { - "type" : "object", - "properties" : { - "nodeId" : { - "type" : "string", - "description" : "The unique ID that identifies the node" - }, - "address" : { - "type" : "string", - "description" : "The API address of the node" - }, - "apiPort" : { - "type" : "integer", - "format" : "int32", - "description" : "The API port used to communicate with the node" - }, - "statusSnapshot" : { - "description" : "The remote process group status snapshot from the node.", - "$ref" : "#/definitions/RemoteProcessGroupStatusSnapshotDTO" - } - } - }, - "NodeSearchResultDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the node that matched the search." - }, - "address" : { - "type" : "string", - "description" : "The address of the node that matched the search." - } - } - }, - "NodeStatusSnapshotsDTO" : { - "type" : "object", - "properties" : { - "nodeId" : { - "type" : "string", - "description" : "The id of the node." - }, - "address" : { - "type" : "string", - "description" : "The node's host/ip address." - }, - "apiPort" : { - "type" : "integer", - "format" : "int32", - "description" : "The port the node is listening for API requests." - }, - "statusSnapshots" : { - "type" : "array", - "description" : "A list of StatusSnapshotDTO objects that provide the actual metric values for the component for this node.", - "items" : { - "$ref" : "#/definitions/StatusSnapshotDTO" - } - } - } - }, - "NodeSystemDiagnosticsSnapshotDTO" : { - "type" : "object", - "properties" : { - "nodeId" : { - "type" : "string", - "description" : "The unique ID that identifies the node" - }, - "address" : { - "type" : "string", - "description" : "The API address of the node" - }, - "apiPort" : { - "type" : "integer", - "format" : "int32", - "description" : "The API port used to communicate with the node" - }, - "snapshot" : { - "description" : "The System Diagnostics snapshot from the node.", - "$ref" : "#/definitions/SystemDiagnosticsSnapshotDTO" - } - } - }, - "OutputPortsEntity" : { - "type" : "object", - "properties" : { - "outputPorts" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/PortEntity" - } - } - }, - "xml" : { - "name" : "outputPortsEntity" - } - }, - "ParameterContextDTO" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The Name of the Parameter Context." - }, - "description" : { - "type" : "string", - "description" : "The Description of the Parameter Context." - }, - "parameters" : { - "type" : "array", - "description" : "The Parameters for the Parameter Context", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ParameterEntity" - } - }, - "boundProcessGroups" : { - "type" : "array", - "description" : "The Process Groups that are bound to this Parameter Context", - "readOnly" : true, - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ProcessGroupEntity" - } - }, - "id" : { - "type" : "string", - "description" : "The ID the Parameter Context.", - "readOnly" : true - } - } - }, - "ParameterContextEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "component" : { - "description" : "The Parameter Context", - "$ref" : "#/definitions/ParameterContextDTO" - } - }, - "xml" : { - "name" : "parameterContextEntity" - } - }, - "ParameterContextReferenceDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The ID of the Parameter Context" - }, - "name" : { - "type" : "string", - "description" : "The name of the Parameter Context" - } - } - }, - "ParameterContextReferenceEntity" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "component" : { - "$ref" : "#/definitions/ParameterContextReferenceDTO" - } - }, - "xml" : { - "name" : "parameterContextReferenceEntity" - } - }, - "ParameterContextUpdateRequestDTO" : { - "type" : "object", - "properties" : { - "requestId" : { - "type" : "string", - "description" : "The ID of the request", - "readOnly" : true - }, - "uri" : { - "type" : "string", - "description" : "The URI for the request", - "readOnly" : true - }, - "submissionTime" : { - "type" : "string", - "format" : "date-time", - "description" : "The timestamp of when the request was submitted", - "readOnly" : true - }, - "lastUpdated" : { - "type" : "string", - "format" : "date-time", - "description" : "The timestamp of when the request was last updated", - "readOnly" : true - }, - "complete" : { - "type" : "boolean", - "description" : "Whether or not the request is completed", - "readOnly" : true - }, - "failureReason" : { - "type" : "string", - "description" : "The reason for the request failing, or null if the request has not failed", - "readOnly" : true - }, - "percentCompleted" : { - "type" : "integer", - "format" : "int32", - "description" : "A value between 0 and 100 (inclusive) indicating how close the request is to completion", - "readOnly" : true - }, - "state" : { - "type" : "string", - "description" : "A description of the current state of the request", - "readOnly" : true - }, - "updateSteps" : { - "type" : "array", - "description" : "The steps that are required in order to complete the request, along with the status of each", - "readOnly" : true, - "items" : { - "$ref" : "#/definitions/ParameterContextUpdateStepDTO" - } - }, - "parameterContext" : { - "description" : "The Parameter Context that is being operated on. This may not be populated until the request has successfully completed.", - "readOnly" : true, - "$ref" : "#/definitions/ParameterContextDTO" - }, - "referencingComponents" : { - "type" : "array", - "description" : "The components that are referenced by the update.", - "readOnly" : true, - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/AffectedComponentEntity" - } - } - } - }, - "ParameterContextUpdateRequestEntity" : { - "type" : "object", - "properties" : { - "parameterContextRevision" : { - "description" : "The Revision of the Parameter Context", - "$ref" : "#/definitions/RevisionDTO" - }, - "request" : { - "description" : "The Update Request", - "$ref" : "#/definitions/ParameterContextUpdateRequestDTO" - } - }, - "xml" : { - "name" : "parameterContextUpdateRequestEntity" - } - }, - "ParameterContextUpdateStepDTO" : { - "type" : "object", - "properties" : { - "description" : { - "type" : "string", - "description" : "Explanation of what happens in this step", - "readOnly" : true - }, - "complete" : { - "type" : "boolean", - "description" : "Whether or not this step has completed", - "readOnly" : true - }, - "failureReason" : { - "type" : "string", - "description" : "An explanation of why this step failed, or null if this step did not fail", - "readOnly" : true - } - } - }, - "ParameterContextValidationRequestDTO" : { - "type" : "object", - "properties" : { - "requestId" : { - "type" : "string", - "description" : "The ID of the request", - "readOnly" : true - }, - "uri" : { - "type" : "string", - "description" : "The URI for the request", - "readOnly" : true - }, - "submissionTime" : { - "type" : "string", - "format" : "date-time", - "description" : "The timestamp of when the request was submitted", - "readOnly" : true - }, - "lastUpdated" : { - "type" : "string", - "format" : "date-time", - "description" : "The timestamp of when the request was last updated", - "readOnly" : true - }, - "complete" : { - "type" : "boolean", - "description" : "Whether or not the request is completed", - "readOnly" : true - }, - "failureReason" : { - "type" : "string", - "description" : "The reason for the request failing, or null if the request has not failed", - "readOnly" : true - }, - "percentCompleted" : { - "type" : "integer", - "format" : "int32", - "description" : "A value between 0 and 100 (inclusive) indicating how close the request is to completion", - "readOnly" : true - }, - "state" : { - "type" : "string", - "description" : "A description of the current state of the request", - "readOnly" : true - }, - "updateSteps" : { - "type" : "array", - "description" : "The steps that are required in order to complete the request, along with the status of each", - "readOnly" : true, - "items" : { - "$ref" : "#/definitions/ParameterContextValidationStepDTO" - } - }, - "parameterContext" : { - "description" : "The Parameter Context that is being operated on.", - "$ref" : "#/definitions/ParameterContextDTO" - }, - "componentValidationResults" : { - "description" : "The Validation Results that were calculated for each component. This value may not be set until the request completes.", - "readOnly" : true, - "$ref" : "#/definitions/ComponentValidationResultsEntity" - } - } - }, - "ParameterContextValidationRequestEntity" : { - "type" : "object", - "properties" : { - "request" : { - "description" : "The Update Request", - "$ref" : "#/definitions/ParameterContextValidationRequestDTO" - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - } - }, - "xml" : { - "name" : "parameterContextValidationRequestEntity" - } - }, - "ParameterContextValidationStepDTO" : { - "type" : "object", - "properties" : { - "description" : { - "type" : "string", - "description" : "Explanation of what happens in this step", - "readOnly" : true - }, - "complete" : { - "type" : "boolean", - "description" : "Whether or not this step has completed", - "readOnly" : true - }, - "failureReason" : { - "type" : "string", - "description" : "An explanation of why this step failed, or null if this step did not fail", - "readOnly" : true - } - } - }, - "ParameterContextsEntity" : { - "type" : "object", - "properties" : { - "parameterContexts" : { - "type" : "array", - "description" : "The Parameter Contexts", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ParameterContextEntity" - } - }, - "currentTime" : { - "type" : "string", - "description" : "The current time on the system.", - "readOnly" : true - } - }, - "xml" : { - "name" : "parameterContexts" - } - }, - "ParameterDTO" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The name of the Parameter" - }, - "description" : { - "type" : "string", - "description" : "The description of the Parameter" - }, - "sensitive" : { - "type" : "boolean", - "description" : "Whether or not the Parameter is sensitive" - }, - "value" : { - "type" : "string", - "description" : "The value of the Parameter" - }, - "valueRemoved" : { - "type" : "boolean", - "description" : "Whether or not the value of the Parameter was removed. When a request is made to change a parameter, the value may be null. The 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). This denotes which of the two scenarios is being encountered." - }, - "referencingComponents" : { - "type" : "array", - "description" : "The set of all components in the flow that are referencing this Parameter", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/AffectedComponentEntity" - } - } - } - }, - "ParameterEntity" : { - "type" : "object", - "properties" : { - "canWrite" : { - "type" : "boolean", - "description" : "Indicates whether the user can write a given resource.", - "readOnly" : true - }, - "parameter" : { - "description" : "The parameter information", - "$ref" : "#/definitions/ParameterDTO" - } - }, - "xml" : { - "name" : "parameterEntity" - } - }, - "PeerDTO" : { - "type" : "object", - "properties" : { - "hostname" : { - "type" : "string", - "description" : "The hostname of this peer." - }, - "port" : { - "type" : "integer", - "format" : "int32", - "description" : "The port number of this peer." - }, - "secure" : { - "type" : "boolean", - "description" : "Returns if this peer connection is secure." - }, - "flowFileCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of flowFiles this peer holds." - } - } - }, - "PeersEntity" : { - "type" : "object", - "properties" : { - "peers" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/PeerDTO" - } - } - }, - "xml" : { - "name" : "peersEntity" - } - }, - "Permissions" : { - "type" : "object", - "properties" : { - "canRead" : { - "type" : "boolean", - "description" : "Indicates whether the user can read a given resource.", - "readOnly" : true - }, - "canWrite" : { - "type" : "boolean", - "description" : "Indicates whether the user can write a given resource.", - "readOnly" : true - }, - "canDelete" : { - "type" : "boolean", - "description" : "Indicates whether the user can delete a given resource.", - "readOnly" : true - } - } - }, - "PermissionsDTO" : { - "type" : "object", - "properties" : { - "canRead" : { - "type" : "boolean", - "description" : "Indicates whether the user can read a given resource.", - "readOnly" : true - }, - "canWrite" : { - "type" : "boolean", - "description" : "Indicates whether the user can write a given resource.", - "readOnly" : true - } - } - }, - "PortDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "versionedComponentId" : { - "type" : "string", - "description" : "The ID of the corresponding component that is under version control" - }, - "parentGroupId" : { - "type" : "string", - "description" : "The id of parent process group of this component if applicable." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "name" : { - "type" : "string", - "description" : "The name of the port." - }, - "comments" : { - "type" : "string", - "description" : "The comments for the port." - }, - "state" : { - "type" : "string", - "description" : "The state of the port.", - "enum" : [ "RUNNING", "STOPPED", "DISABLED" ] - }, - "type" : { - "type" : "string", - "description" : "The type of port.", - "enum" : [ "INPUT_PORT", "OUTPUT_PORT" ] - }, - "transmitting" : { - "type" : "boolean", - "description" : "Whether the port has incoming or output connections to a remote NiFi. This is only applicable when the port is allowed to be accessed remotely." - }, - "concurrentlySchedulableTaskCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of tasks that should be concurrently scheduled for the port." - }, - "userAccessControl" : { - "type" : "array", - "description" : "The users that are allowed to access the port.", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - }, - "groupAccessControl" : { - "type" : "array", - "description" : "The user groups that are allowed to access the port.", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - }, - "allowRemoteAccess" : { - "type" : "boolean", - "description" : "Whether this port can be accessed remotely via Site-to-Site protocol." - }, - "validationErrors" : { - "type" : "array", - "description" : "Gets the validation errors from this port. These validation errors represent the problems with the port that must be resolved before it can be started.", - "items" : { - "type" : "string" - } - } - } - }, - "PortEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "component" : { - "$ref" : "#/definitions/PortDTO" - }, - "status" : { - "description" : "The status of the port.", - "$ref" : "#/definitions/PortStatusDTO" - }, - "portType" : { - "type" : "string" - }, - "operatePermissions" : { - "description" : "The permissions for this component operations.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "allowRemoteAccess" : { - "type" : "boolean", - "description" : "Whether this port can be accessed remotely via Site-to-Site protocol." - } - }, - "xml" : { - "name" : "portEntity" - } - }, - "PortRunStatusEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "state" : { - "type" : "string", - "description" : "The run status of the Port.", - "enum" : [ "RUNNING", "STOPPED", "DISABLED" ] - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - } - }, - "xml" : { - "name" : "entity" - } - }, - "PortStatusDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the port." - }, - "groupId" : { - "type" : "string", - "description" : "The id of the parent process group of the port." - }, - "name" : { - "type" : "string", - "description" : "The name of the port." - }, - "transmitting" : { - "type" : "boolean", - "description" : "Whether the port has incoming or outgoing connections to a remote NiFi." - }, - "runStatus" : { - "type" : "string", - "description" : "The run status of the port.", - "enum" : [ "Running", "Stopped", "Validating", "Disabled", "Invalid" ] - }, - "statsLastRefreshed" : { - "type" : "string", - "description" : "The time the status for the process group was last refreshed." - }, - "aggregateSnapshot" : { - "description" : "A status snapshot that represents the aggregate stats of all nodes in the cluster. If the NiFi instance is a standalone instance, rather than a cluster, this represents the stats of the single instance.", - "$ref" : "#/definitions/PortStatusSnapshotDTO" - }, - "nodeSnapshots" : { - "type" : "array", - "description" : "A status snapshot for each node in the cluster. If the NiFi instance is a standalone instance, rather than a cluster, this may be null.", - "items" : { - "$ref" : "#/definitions/NodePortStatusSnapshotDTO" - } - } - } - }, - "PortStatusEntity" : { - "type" : "object", - "properties" : { - "portStatus" : { - "$ref" : "#/definitions/PortStatusDTO" - }, - "canRead" : { - "type" : "boolean", - "description" : "Indicates whether the user can read a given resource.", - "readOnly" : true - } - }, - "xml" : { - "name" : "portStatusEntity" - } - }, - "PortStatusSnapshotDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the port." - }, - "groupId" : { - "type" : "string", - "description" : "The id of the parent process group of the port." - }, - "name" : { - "type" : "string", - "description" : "The name of the port." - }, - "activeThreadCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The active thread count for the port." - }, - "flowFilesIn" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of FlowFiles that have been accepted in the last 5 minutes." - }, - "bytesIn" : { - "type" : "integer", - "format" : "int64", - "description" : "The size of hte FlowFiles that have been accepted in the last 5 minutes." - }, - "input" : { - "type" : "string", - "description" : "The count/size of flowfiles that have been accepted in the last 5 minutes." - }, - "flowFilesOut" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of FlowFiles that have been processed in the last 5 minutes." - }, - "bytesOut" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes that have been processed in the last 5 minutes." - }, - "output" : { - "type" : "string", - "description" : "The count/size of flowfiles that have been processed in the last 5 minutes." - }, - "transmitting" : { - "type" : "boolean", - "description" : "Whether the port has incoming or outgoing connections to a remote NiFi." - }, - "runStatus" : { - "type" : "string", - "description" : "The run status of the port.", - "enum" : [ "Running", "Stopped", "Validating", "Disabled", "Invalid" ] - } - } - }, - "PortStatusSnapshotEntity" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the port." - }, - "portStatusSnapshot" : { - "$ref" : "#/definitions/PortStatusSnapshotDTO" - }, - "canRead" : { - "type" : "boolean", - "description" : "Indicates whether the user can read a given resource.", - "readOnly" : true - } - }, - "xml" : { - "name" : "entity" - } - }, - "Position" : { - "type" : "object", - "properties" : { - "x" : { - "type" : "number", - "format" : "double", - "description" : "The x coordinate." - }, - "y" : { - "type" : "number", - "format" : "double", - "description" : "The y coordinate." - } - }, - "description" : "The position of a component on the graph" - }, - "PositionDTO" : { - "type" : "object", - "properties" : { - "x" : { - "type" : "number", - "format" : "double", - "description" : "The x coordinate." - }, - "y" : { - "type" : "number", - "format" : "double", - "description" : "The y coordinate." - } - } - }, - "PreviousValueDTO" : { - "type" : "object", - "properties" : { - "previousValue" : { - "type" : "string", - "description" : "The previous value." - }, - "timestamp" : { - "type" : "string", - "description" : "The timestamp when the value was modified." - }, - "userIdentity" : { - "type" : "string", - "description" : "The user who changed the previous value." - } - } - }, - "PrioritizerTypesEntity" : { - "type" : "object", - "properties" : { - "prioritizerTypes" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/DocumentedTypeDTO" - } - } - }, - "xml" : { - "name" : "prioritizerTypesEntity" - } - }, - "ProcessGroupDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "versionedComponentId" : { - "type" : "string", - "description" : "The ID of the corresponding component that is under version control" - }, - "parentGroupId" : { - "type" : "string", - "description" : "The id of parent process group of this component if applicable." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "name" : { - "type" : "string", - "description" : "The name of the process group." - }, - "comments" : { - "type" : "string", - "description" : "The comments for the process group." - }, - "variables" : { - "type" : "object", - "description" : "The variables that are configured for the Process Group. Note that this map contains only those variables that are defined on this Process Group and not any variables that are defined in the parent Process Group, etc. I.e., this Map will not contain all variables that are accessible by components in this Process Group by rather only the variables that are defined for this Process Group itself.", - "readOnly" : true, - "additionalProperties" : { - "type" : "string" - } - }, - "versionControlInformation" : { - "description" : "The Version Control information that indicates which Flow Registry, and where in the Flow Registry, this Process Group is tracking to; or null if this Process Group is not under version control", - "$ref" : "#/definitions/VersionControlInformationDTO" - }, - "parameterContext" : { - "description" : "The Parameter Context that this Process Group is bound to.", - "$ref" : "#/definitions/ParameterContextReferenceEntity" - }, - "flowfileConcurrency" : { - "type" : "string", - "description" : "The FlowFile Concurrency for this Process Group.", - "enum" : [ "UNBOUNDED", "SINGLE_FLOWFILE_PER_NODE" ] - }, - "flowfileOutboundPolicy" : { - "type" : "string", - "description" : "The Oubound Policy that is used for determining how FlowFiles should be transferred out of the Process Group.", - "enum" : [ "STREAM_WHEN_AVAILABLE", "BATCH_OUTPUT" ] - }, - "runningCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of running components in this process group." - }, - "stoppedCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of stopped components in the process group." - }, - "invalidCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of invalid components in the process group." - }, - "disabledCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of disabled components in the process group." - }, - "activeRemotePortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of active remote ports in the process group." - }, - "inactiveRemotePortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of inactive remote ports in the process group." - }, - "upToDateCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of up to date versioned process groups in the process group." - }, - "locallyModifiedCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of locally modified versioned process groups in the process group." - }, - "staleCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of stale versioned process groups in the process group." - }, - "locallyModifiedAndStaleCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of locally modified and stale versioned process groups in the process group." - }, - "syncFailureCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of versioned process groups in the process group that are unable to sync to a registry." - }, - "localInputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of local input ports in the process group." - }, - "localOutputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of local output ports in the process group." - }, - "publicInputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of public input ports in the process group." - }, - "publicOutputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of public output ports in the process group." - }, - "contents" : { - "description" : "The contents of this process group.", - "$ref" : "#/definitions/FlowSnippetDTO" - }, - "inputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of input ports in the process group.", - "readOnly" : true - }, - "outputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of output ports in the process group.", - "readOnly" : true - } - } - }, - "ProcessGroupEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "component" : { - "$ref" : "#/definitions/ProcessGroupDTO" - }, - "status" : { - "description" : "The status of the process group.", - "$ref" : "#/definitions/ProcessGroupStatusDTO" - }, - "versionedFlowSnapshot" : { - "description" : "Returns the Versioned Flow that describes the contents of the Versioned Flow to be imported", - "readOnly" : true, - "$ref" : "#/definitions/VersionedFlowSnapshot" - }, - "runningCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of running components in this process group." - }, - "stoppedCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of stopped components in the process group." - }, - "invalidCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of invalid components in the process group." - }, - "disabledCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of disabled components in the process group." - }, - "activeRemotePortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of active remote ports in the process group." - }, - "inactiveRemotePortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of inactive remote ports in the process group." - }, - "versionedFlowState" : { - "type" : "string", - "description" : "The current state of the Process Group, as it relates to the Versioned Flow", - "readOnly" : true, - "enum" : [ "LOCALLY_MODIFIED", "STALE", "LOCALLY_MODIFIED_AND_STALE", "UP_TO_DATE", "SYNC_FAILURE" ] - }, - "upToDateCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of up to date versioned process groups in the process group." - }, - "locallyModifiedCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of locally modified versioned process groups in the process group." - }, - "staleCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of stale versioned process groups in the process group." - }, - "locallyModifiedAndStaleCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of locally modified and stale versioned process groups in the process group." - }, - "syncFailureCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of versioned process groups in the process group that are unable to sync to a registry." - }, - "localInputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of local input ports in the process group." - }, - "localOutputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of local output ports in the process group." - }, - "publicInputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of public input ports in the process group." - }, - "publicOutputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of public output ports in the process group." - }, - "parameterContext" : { - "description" : "The Parameter Context, or null if no Parameter Context has been bound to the Process Group", - "$ref" : "#/definitions/ParameterContextReferenceEntity" - }, - "inputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of input ports in the process group.", - "readOnly" : true - }, - "outputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of output ports in the process group.", - "readOnly" : true - } - }, - "xml" : { - "name" : "processGroupEntity" - } - }, - "ProcessGroupFlowDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "parentGroupId" : { - "type" : "string", - "description" : "The id of parent process group of this component if applicable." - }, - "parameterContext" : { - "description" : "The Parameter Context, or null if no Parameter Context has been bound to the Process Group", - "$ref" : "#/definitions/ParameterContextReferenceEntity" - }, - "breadcrumb" : { - "description" : "The breadcrumb of the process group.", - "$ref" : "#/definitions/FlowBreadcrumbEntity" - }, - "flow" : { - "description" : "The flow structure starting at this Process Group.", - "$ref" : "#/definitions/FlowDTO" - }, - "lastRefreshed" : { - "type" : "string", - "description" : "The time the flow for the process group was last refreshed." - } - } - }, - "ProcessGroupFlowEntity" : { - "type" : "object", - "properties" : { - "permissions" : { - "description" : "The access policy for this process group.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "processGroupFlow" : { - "$ref" : "#/definitions/ProcessGroupFlowDTO" - } - }, - "xml" : { - "name" : "processGroupFlowEntity" - } - }, - "ProcessGroupImportEntity" : { - "type" : "object", - "properties" : { - "processGroupRevision" : { - "description" : "The Revision for the Process Group", - "$ref" : "#/definitions/RevisionDTO" - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "versionedFlowSnapshot" : { - "description" : "The Versioned Flow Snapshot to import", - "$ref" : "#/definitions/VersionedFlowSnapshot" - } - }, - "xml" : { - "name" : "processGroupImportEntity" - } - }, - "ProcessGroupNameDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The ID of the Process Group" - }, - "name" : { - "type" : "string", - "description" : "The name of the Process Group, or the ID of the Process Group if the user does not have the READ policy for the Process Group" - } - } - }, - "ProcessGroupReplaceRequestDTO" : { - "type" : "object", - "properties" : { - "requestId" : { - "type" : "string", - "description" : "The unique ID of this request.", - "readOnly" : true - }, - "processGroupId" : { - "type" : "string", - "description" : "The unique ID of the Process Group being updated" - }, - "uri" : { - "type" : "string", - "description" : "The URI for future requests to this drop request.", - "readOnly" : true - }, - "lastUpdated" : { - "type" : "string", - "description" : "The last time this request was updated.", - "readOnly" : true - }, - "complete" : { - "type" : "boolean", - "description" : "Whether or not this request has completed", - "readOnly" : true - }, - "failureReason" : { - "type" : "string", - "description" : "An explanation of why this request failed, or null if this request has not failed", - "readOnly" : true - }, - "percentCompleted" : { - "type" : "integer", - "format" : "int32", - "description" : "The percentage complete for the request, between 0 and 100", - "readOnly" : true - }, - "state" : { - "type" : "string", - "description" : "The state of the request", - "readOnly" : true - } - } - }, - "ProcessGroupReplaceRequestEntity" : { - "type" : "object", - "properties" : { - "processGroupRevision" : { - "description" : "The revision for the Process Group being updated.", - "$ref" : "#/definitions/RevisionDTO" - }, - "request" : { - "description" : "The Process Group Change Request", - "$ref" : "#/definitions/ProcessGroupReplaceRequestDTO" - }, - "versionedFlowSnapshot" : { - "description" : "Returns the Versioned Flow to replace with", - "readOnly" : true, - "$ref" : "#/definitions/VersionedFlowSnapshot" - } - }, - "xml" : { - "name" : "processGroupReplaceRequestEntity" - } - }, - "ProcessGroupStatusDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The ID of the Process Group" - }, - "name" : { - "type" : "string", - "description" : "The name of the Process Group" - }, - "statsLastRefreshed" : { - "type" : "string", - "description" : "The time the status for the process group was last refreshed." - }, - "aggregateSnapshot" : { - "description" : "The aggregate status of all nodes in the cluster", - "$ref" : "#/definitions/ProcessGroupStatusSnapshotDTO" - }, - "nodeSnapshots" : { - "type" : "array", - "description" : "The status reported by each node in the cluster. If the NiFi instance is a standalone instance, rather than a clustered instance, this value may be null.", - "items" : { - "$ref" : "#/definitions/NodeProcessGroupStatusSnapshotDTO" - } - } - } - }, - "ProcessGroupStatusEntity" : { - "type" : "object", - "properties" : { - "processGroupStatus" : { - "$ref" : "#/definitions/ProcessGroupStatusDTO" - }, - "canRead" : { - "type" : "boolean", - "description" : "Indicates whether the user can read a given resource.", - "readOnly" : true - } - }, - "xml" : { - "name" : "processGroupStatusEntity" - } - }, - "ProcessGroupStatusSnapshotDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the process group." - }, - "name" : { - "type" : "string", - "description" : "The name of this process group." - }, - "connectionStatusSnapshots" : { - "type" : "array", - "description" : "The status of all connections in the process group.", - "items" : { - "$ref" : "#/definitions/ConnectionStatusSnapshotEntity" - } - }, - "processorStatusSnapshots" : { - "type" : "array", - "description" : "The status of all processors in the process group.", - "items" : { - "$ref" : "#/definitions/ProcessorStatusSnapshotEntity" - } - }, - "processGroupStatusSnapshots" : { - "type" : "array", - "description" : "The status of all process groups in the process group.", - "items" : { - "$ref" : "#/definitions/ProcessGroupStatusSnapshotEntity" - } - }, - "remoteProcessGroupStatusSnapshots" : { - "type" : "array", - "description" : "The status of all remote process groups in the process group.", - "items" : { - "$ref" : "#/definitions/RemoteProcessGroupStatusSnapshotEntity" - } - }, - "inputPortStatusSnapshots" : { - "type" : "array", - "description" : "The status of all input ports in the process group.", - "items" : { - "$ref" : "#/definitions/PortStatusSnapshotEntity" - } - }, - "outputPortStatusSnapshots" : { - "type" : "array", - "description" : "The status of all output ports in the process group.", - "items" : { - "$ref" : "#/definitions/PortStatusSnapshotEntity" - } - }, - "versionedFlowState" : { - "type" : "string", - "description" : "The current state of the Process Group, as it relates to the Versioned Flow", - "readOnly" : true, - "enum" : [ "LOCALLY_MODIFIED", "STALE", "LOCALLY_MODIFIED_AND_STALE", "UP_TO_DATE", "SYNC_FAILURE" ] - }, - "flowFilesIn" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of FlowFiles that have come into this ProcessGroup in the last 5 minutes" - }, - "bytesIn" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes that have come into this ProcessGroup in the last 5 minutes" - }, - "input" : { - "type" : "string", - "description" : "The input count/size for the process group in the last 5 minutes (pretty printed)." - }, - "flowFilesQueued" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of FlowFiles that are queued up in this ProcessGroup right now" - }, - "bytesQueued" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes that are queued up in this ProcessGroup right now" - }, - "queued" : { - "type" : "string", - "description" : "The count/size that is queued in the the process group." - }, - "queuedCount" : { - "type" : "string", - "description" : "The count that is queued for the process group." - }, - "queuedSize" : { - "type" : "string", - "description" : "The size that is queued for the process group." - }, - "bytesRead" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes read by components in this ProcessGroup in the last 5 minutes" - }, - "read" : { - "type" : "string", - "description" : "The number of bytes read in the last 5 minutes." - }, - "bytesWritten" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes written by components in this ProcessGroup in the last 5 minutes" - }, - "written" : { - "type" : "string", - "description" : "The number of bytes written in the last 5 minutes." - }, - "flowFilesOut" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of FlowFiles transferred out of this ProcessGroup in the last 5 minutes" - }, - "bytesOut" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes transferred out of this ProcessGroup in the last 5 minutes" - }, - "output" : { - "type" : "string", - "description" : "The output count/size for the process group in the last 5 minutes." - }, - "flowFilesTransferred" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of FlowFiles transferred in this ProcessGroup in the last 5 minutes" - }, - "bytesTransferred" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes transferred in this ProcessGroup in the last 5 minutes" - }, - "transferred" : { - "type" : "string", - "description" : "The count/size transferred to/from queues in the process group in the last 5 minutes." - }, - "bytesReceived" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes received from external sources by components within this ProcessGroup in the last 5 minutes" - }, - "flowFilesReceived" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of FlowFiles received from external sources by components within this ProcessGroup in the last 5 minutes" - }, - "received" : { - "type" : "string", - "description" : "The count/size sent to the process group in the last 5 minutes." - }, - "bytesSent" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes sent to an external sink by components within this ProcessGroup in the last 5 minutes" - }, - "flowFilesSent" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of FlowFiles sent to an external sink by components within this ProcessGroup in the last 5 minutes" - }, - "sent" : { - "type" : "string", - "description" : "The count/size sent from this process group in the last 5 minutes." - }, - "activeThreadCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The active thread count for this process group." - }, - "terminatedThreadCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of threads currently terminated for the process group." - } - } - }, - "ProcessGroupStatusSnapshotEntity" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the process group." - }, - "processGroupStatusSnapshot" : { - "$ref" : "#/definitions/ProcessGroupStatusSnapshotDTO" - }, - "canRead" : { - "type" : "boolean", - "description" : "Indicates whether the user can read a given resource.", - "readOnly" : true - } - }, - "xml" : { - "name" : "entity" - } - }, - "ProcessGroupsEntity" : { - "type" : "object", - "properties" : { - "processGroups" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ProcessGroupEntity" - } - } - }, - "xml" : { - "name" : "processGroupsEntity" - } - }, - "ProcessorConfigDTO" : { - "type" : "object", - "properties" : { - "properties" : { - "type" : "object", - "description" : "The properties for the processor. Properties whose value is not set will only contain the property name.", - "additionalProperties" : { - "type" : "string" - } - }, - "descriptors" : { - "type" : "object", - "description" : "Descriptors for the processor's properties.", - "additionalProperties" : { - "$ref" : "#/definitions/PropertyDescriptorDTO" - } - }, - "schedulingPeriod" : { - "type" : "string", - "description" : "The frequency with which to schedule the processor. The format of the value will depend on th value of schedulingStrategy." - }, - "schedulingStrategy" : { - "type" : "string", - "description" : "Indcates whether the prcessor should be scheduled to run in event or timer driven mode." - }, - "executionNode" : { - "type" : "string", - "description" : "Indicates the node where the process will execute." - }, - "penaltyDuration" : { - "type" : "string", - "description" : "The amount of time that is used when the process penalizes a flowfile." - }, - "yieldDuration" : { - "type" : "string", - "description" : "The amount of time that must elapse before this processor is scheduled again after yielding." - }, - "bulletinLevel" : { - "type" : "string", - "description" : "The level at which the processor will report bulletins." - }, - "runDurationMillis" : { - "type" : "integer", - "format" : "int64", - "description" : "The run duration for the processor in milliseconds." - }, - "concurrentlySchedulableTaskCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of tasks that should be concurrently schedule for the processor. If the processor doesn't allow parallol processing then any positive input will be ignored." - }, - "autoTerminatedRelationships" : { - "type" : "array", - "description" : "The names of all relationships that cause a flow file to be terminated if the relationship is not connected elsewhere. This property differs from the 'isAutoTerminate' property of the RelationshipDTO in that the RelationshipDTO is meant to depict the current configuration, whereas this property can be set in a DTO when updating a Processor in order to change which Relationships should be auto-terminated.", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - }, - "comments" : { - "type" : "string", - "description" : "The comments for the processor." - }, - "customUiUrl" : { - "type" : "string", - "description" : "The URL for the processor's custom configuration UI if applicable." - }, - "lossTolerant" : { - "type" : "boolean", - "description" : "Whether the processor is loss tolerant." - }, - "annotationData" : { - "type" : "string", - "description" : "The annotation data for the processor used to relay configuration between a custom UI and the procesosr." - }, - "defaultConcurrentTasks" : { - "type" : "object", - "description" : "Maps default values for concurrent tasks for each applicable scheduling strategy.", - "additionalProperties" : { - "type" : "string" - } - }, - "defaultSchedulingPeriod" : { - "type" : "object", - "description" : "Maps default values for scheduling period for each applicable scheduling strategy.", - "additionalProperties" : { - "type" : "string" - } - } - } - }, - "ProcessorDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "versionedComponentId" : { - "type" : "string", - "description" : "The ID of the corresponding component that is under version control" - }, - "parentGroupId" : { - "type" : "string", - "description" : "The id of parent process group of this component if applicable." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "name" : { - "type" : "string", - "description" : "The name of the processor." - }, - "type" : { - "type" : "string", - "description" : "The type of the processor." - }, - "bundle" : { - "description" : "The details of the artifact that bundled this processor type.", - "$ref" : "#/definitions/BundleDTO" - }, - "state" : { - "type" : "string", - "description" : "The state of the processor", - "enum" : [ "RUNNING", "STOPPED", "DISABLED" ] - }, - "style" : { - "type" : "object", - "description" : "Styles for the processor (background-color : #eee).", - "additionalProperties" : { - "type" : "string" - } - }, - "relationships" : { - "type" : "array", - "description" : "The available relationships that the processor currently supports.", - "readOnly" : true, - "items" : { - "$ref" : "#/definitions/RelationshipDTO" - } - }, - "description" : { - "type" : "string", - "description" : "The description of the processor." - }, - "supportsParallelProcessing" : { - "type" : "boolean", - "description" : "Whether the processor supports parallel processing." - }, - "supportsEventDriven" : { - "type" : "boolean", - "description" : "Whether the processor supports event driven scheduling." - }, - "supportsBatching" : { - "type" : "boolean", - "description" : "Whether the processor supports batching. This makes the run duration settings available." - }, - "persistsState" : { - "type" : "boolean", - "description" : "Whether the processor persists state." - }, - "restricted" : { - "type" : "boolean", - "description" : "Whether the processor requires elevated privileges." - }, - "deprecated" : { - "type" : "boolean", - "description" : "Whether the processor has been deprecated." - }, - "executionNodeRestricted" : { - "type" : "boolean", - "description" : "Indicates if the execution node of a processor is restricted to run only on the primary node" - }, - "multipleVersionsAvailable" : { - "type" : "boolean", - "description" : "Whether the processor has multiple versions available." - }, - "inputRequirement" : { - "type" : "string", - "description" : "The input requirement for this processor." - }, - "config" : { - "description" : "The configuration details for the processor. These details will be included in a response if the verbose flag is included in a request.", - "$ref" : "#/definitions/ProcessorConfigDTO" - }, - "validationErrors" : { - "type" : "array", - "description" : "The validation errors for the processor. These validation errors represent the problems with the processor that must be resolved before it can be started.", - "items" : { - "type" : "string" - } - }, - "validationStatus" : { - "type" : "string", - "description" : "Indicates whether the Processor is valid, invalid, or still in the process of validating (i.e., it is unknown whether or not the Processor is valid)", - "readOnly" : true, - "enum" : [ "VALID", "INVALID", "VALIDATING" ] - }, - "extensionMissing" : { - "type" : "boolean", - "description" : "Whether the underlying extension is missing." - } - } - }, - "ProcessorEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "component" : { - "$ref" : "#/definitions/ProcessorDTO" - }, - "inputRequirement" : { - "type" : "string", - "description" : "The input requirement for this processor." - }, - "status" : { - "$ref" : "#/definitions/ProcessorStatusDTO" - }, - "operatePermissions" : { - "description" : "The permissions for this component operations.", - "$ref" : "#/definitions/PermissionsDTO" - } - }, - "xml" : { - "name" : "processorEntity" - } - }, - "ProcessorRunStatusDetailsDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The ID of the processor" - }, - "name" : { - "type" : "string", - "description" : "The name of the processor" - }, - "runStatus" : { - "type" : "string", - "description" : "The run status of the processor", - "enum" : [ "Running", "Stopped", "Invalid", "Validating", "Disabled" ] - }, - "validationErrors" : { - "type" : "array", - "description" : "The processor's validation errors", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - }, - "activeThreadCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The current number of threads that the processor is currently using" - } - } - }, - "ProcessorRunStatusDetailsEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for the Processor.", - "$ref" : "#/definitions/RevisionDTO" - }, - "permissions" : { - "description" : "The permissions for the Processor.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "runStatusDetails" : { - "description" : "The details of a Processor's run status", - "$ref" : "#/definitions/ProcessorRunStatusDetailsDTO" - } - }, - "xml" : { - "name" : "entity" - } - }, - "ProcessorRunStatusEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "state" : { - "type" : "string", - "description" : "The run status of the Processor.", - "enum" : [ "RUNNING", "STOPPED", "DISABLED" ] - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - } - }, - "xml" : { - "name" : "entity" - } - }, - "ProcessorStatusDTO" : { - "type" : "object", - "properties" : { - "groupId" : { - "type" : "string", - "description" : "The unique ID of the process group that the Processor belongs to" - }, - "id" : { - "type" : "string", - "description" : "The unique ID of the Processor" - }, - "name" : { - "type" : "string", - "description" : "The name of the Processor" - }, - "type" : { - "type" : "string", - "description" : "The type of the Processor" - }, - "runStatus" : { - "type" : "string", - "description" : "The run status of the Processor", - "enum" : [ "Running", "Stopped", "Validating", "Disabled", "Invalid" ] - }, - "statsLastRefreshed" : { - "type" : "string", - "description" : "The timestamp of when the stats were last refreshed" - }, - "aggregateSnapshot" : { - "description" : "A status snapshot that represents the aggregate stats of all nodes in the cluster. If the NiFi instance is a standalone instance, rather than a cluster, this represents the stats of the single instance.", - "$ref" : "#/definitions/ProcessorStatusSnapshotDTO" - }, - "nodeSnapshots" : { - "type" : "array", - "description" : "A status snapshot for each node in the cluster. If the NiFi instance is a standalone instance, rather than a cluster, this may be null.", - "items" : { - "$ref" : "#/definitions/NodeProcessorStatusSnapshotDTO" - } - } - } - }, - "ProcessorStatusEntity" : { - "type" : "object", - "properties" : { - "processorStatus" : { - "$ref" : "#/definitions/ProcessorStatusDTO" - }, - "canRead" : { - "type" : "boolean", - "description" : "Indicates whether the user can read a given resource.", - "readOnly" : true - } - }, - "xml" : { - "name" : "processorStatusEntity" - } - }, - "ProcessorStatusSnapshotDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the processor." - }, - "groupId" : { - "type" : "string", - "description" : "The id of the parent process group to which the processor belongs." - }, - "name" : { - "type" : "string", - "description" : "The name of the prcessor." - }, - "type" : { - "type" : "string", - "description" : "The type of the processor." - }, - "runStatus" : { - "type" : "string", - "description" : "The state of the processor.", - "enum" : [ "Running", "Stopped", "Validating", "Disabled", "Invalid" ] - }, - "executionNode" : { - "type" : "string", - "description" : "Indicates the node where the process will execute.", - "enum" : [ "ALL", "PRIMARY" ] - }, - "bytesRead" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes read by this Processor in the last 5 mintues" - }, - "bytesWritten" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes written by this Processor in the last 5 minutes" - }, - "read" : { - "type" : "string", - "description" : "The number of bytes read in the last 5 minutes." - }, - "written" : { - "type" : "string", - "description" : "The number of bytes written in the last 5 minutes." - }, - "flowFilesIn" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of FlowFiles that have been accepted in the last 5 minutes" - }, - "bytesIn" : { - "type" : "integer", - "format" : "int64", - "description" : "The size of the FlowFiles that have been accepted in the last 5 minutes" - }, - "input" : { - "type" : "string", - "description" : "The count/size of flowfiles that have been accepted in the last 5 minutes." - }, - "flowFilesOut" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of FlowFiles transferred to a Connection in the last 5 minutes" - }, - "bytesOut" : { - "type" : "integer", - "format" : "int64", - "description" : "The size of the FlowFiles transferred to a Connection in the last 5 minutes" - }, - "output" : { - "type" : "string", - "description" : "The count/size of flowfiles that have been processed in the last 5 minutes." - }, - "taskCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of times this Processor has run in the last 5 minutes" - }, - "tasksDurationNanos" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of nanoseconds that this Processor has spent running in the last 5 minutes" - }, - "tasks" : { - "type" : "string", - "description" : "The total number of task this connectable has completed over the last 5 minutes." - }, - "tasksDuration" : { - "type" : "string", - "description" : "The total duration of all tasks for this connectable over the last 5 minutes." - }, - "activeThreadCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of threads currently executing in the processor." - }, - "terminatedThreadCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of threads currently terminated for the processor." - } - } - }, - "ProcessorStatusSnapshotEntity" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the processor." - }, - "processorStatusSnapshot" : { - "$ref" : "#/definitions/ProcessorStatusSnapshotDTO" - }, - "canRead" : { - "type" : "boolean", - "description" : "Indicates whether the user can read a given resource.", - "readOnly" : true - } - }, - "xml" : { - "name" : "entity" - } - }, - "ProcessorTypesEntity" : { - "type" : "object", - "properties" : { - "processorTypes" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/DocumentedTypeDTO" - } - } - }, - "xml" : { - "name" : "processorTypesEntity" - } - }, - "ProcessorsEntity" : { - "type" : "object", - "properties" : { - "processors" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ProcessorEntity" - } - } - }, - "xml" : { - "name" : "processorsEntity" - } - }, - "ProcessorsRunStatusDetailsEntity" : { - "type" : "object", - "properties" : { - "runStatusDetails" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/ProcessorRunStatusDetailsEntity" - } - } - }, - "xml" : { - "name" : "processorsRunStatusDetails" - } - }, - "PropertyDependencyDTO" : { - "type" : "object", - "properties" : { - "propertyName" : { - "type" : "string", - "description" : "The name of the property that is being depended upon" - }, - "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", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - } - } - }, - "PropertyDescriptorDTO" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The name for the property." - }, - "displayName" : { - "type" : "string", - "description" : "The human readable name for the property." - }, - "description" : { - "type" : "string", - "description" : "The description for the property. Used to relay additional details to a user or provide a mechanism of documenting intent." - }, - "defaultValue" : { - "type" : "string", - "description" : "The default value for the property." - }, - "allowableValues" : { - "type" : "array", - "description" : "Allowable values for the property. If empty then the allowed values are not constrained.", - "items" : { - "$ref" : "#/definitions/AllowableValueEntity" - } - }, - "required" : { - "type" : "boolean", - "description" : "Whether the property is required." - }, - "sensitive" : { - "type" : "boolean", - "description" : "Whether the property is sensitive and protected whenever stored or represented." - }, - "dynamic" : { - "type" : "boolean", - "description" : "Whether the property is dynamic (user-defined)." - }, - "supportsEl" : { - "type" : "boolean", - "description" : "Whether the property supports expression language." - }, - "expressionLanguageScope" : { - "type" : "string", - "description" : "Scope of the Expression Language evaluation for the property." - }, - "identifiesControllerService" : { - "type" : "string", - "description" : "If the property identifies a controller service this returns the fully qualified type." - }, - "identifiesControllerServiceBundle" : { - "description" : "If the property identifies a controller service this returns the bundle of the type, null otherwise.", - "$ref" : "#/definitions/BundleDTO" - }, - "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" : "#/definitions/PropertyDependencyDTO" - } - } - } - }, - "PropertyDescriptorEntity" : { - "type" : "object", - "properties" : { - "propertyDescriptor" : { - "$ref" : "#/definitions/PropertyDescriptorDTO" - } - }, - "xml" : { - "name" : "propertyDescriptor" - } - }, - "PropertyHistoryDTO" : { - "type" : "object", - "properties" : { - "previousValues" : { - "type" : "array", - "description" : "Previous values for a given property.", - "items" : { - "$ref" : "#/definitions/PreviousValueDTO" - } - } - } - }, - "ProvenanceDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the provenance query." - }, - "uri" : { - "type" : "string", - "description" : "The URI for this query. Used for obtaining/deleting the request at a later time" - }, - "submissionTime" : { - "type" : "string", - "description" : "The timestamp when the query was submitted." - }, - "expiration" : { - "type" : "string", - "description" : "The timestamp when the query will expire." - }, - "percentCompleted" : { - "type" : "integer", - "format" : "int32", - "description" : "The current percent complete." - }, - "finished" : { - "type" : "boolean", - "description" : "Whether the query has finished." - }, - "request" : { - "description" : "The provenance request.", - "$ref" : "#/definitions/ProvenanceRequestDTO" - }, - "results" : { - "description" : "The provenance results.", - "$ref" : "#/definitions/ProvenanceResultsDTO" - } - } - }, - "ProvenanceEntity" : { - "type" : "object", - "properties" : { - "provenance" : { - "$ref" : "#/definitions/ProvenanceDTO" - } - }, - "xml" : { - "name" : "provenanceEntity" - } - }, - "ProvenanceEventDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The event uuid." - }, - "eventId" : { - "type" : "integer", - "format" : "int64", - "description" : "The event id. This is a one up number thats unique per node." - }, - "eventTime" : { - "type" : "string", - "description" : "The timestamp of the event." - }, - "eventDuration" : { - "type" : "integer", - "format" : "int64", - "description" : "The event duration in milliseconds." - }, - "lineageDuration" : { - "type" : "integer", - "format" : "int64", - "description" : "The duration since the lineage began, in milliseconds." - }, - "eventType" : { - "type" : "string", - "description" : "The type of the event." - }, - "flowFileUuid" : { - "type" : "string", - "description" : "The uuid of the flowfile for the event." - }, - "fileSize" : { - "type" : "string", - "description" : "The size of the flowfile for the event." - }, - "fileSizeBytes" : { - "type" : "integer", - "format" : "int64", - "description" : "The size of the flowfile in bytes for the event." - }, - "clusterNodeId" : { - "type" : "string", - "description" : "The identifier for the node where the event originated." - }, - "clusterNodeAddress" : { - "type" : "string", - "description" : "The label for the node where the event originated." - }, - "groupId" : { - "type" : "string", - "description" : "The id of the group that the component resides in. If the component is no longer in the flow, the group id will not be set." - }, - "componentId" : { - "type" : "string", - "description" : "The id of the component that generated the event." - }, - "componentType" : { - "type" : "string", - "description" : "The type of the component that generated the event." - }, - "componentName" : { - "type" : "string", - "description" : "The name of the component that generated the event." - }, - "sourceSystemFlowFileId" : { - "type" : "string", - "description" : "The source system flowfile id." - }, - "alternateIdentifierUri" : { - "type" : "string", - "description" : "The alternate identifier uri for the fileflow for the event." - }, - "attributes" : { - "type" : "array", - "description" : "The attributes of the flowfile for the event.", - "items" : { - "$ref" : "#/definitions/AttributeDTO" - } - }, - "parentUuids" : { - "type" : "array", - "description" : "The parent uuids for the event.", - "items" : { - "type" : "string" - } - }, - "childUuids" : { - "type" : "array", - "description" : "The child uuids for the event.", - "items" : { - "type" : "string" - } - }, - "transitUri" : { - "type" : "string", - "description" : "The source/destination system uri if the event was a RECEIVE/SEND." - }, - "relationship" : { - "type" : "string", - "description" : "The relationship to which the flowfile was routed if the event is of type ROUTE." - }, - "details" : { - "type" : "string", - "description" : "The event details." - }, - "contentEqual" : { - "type" : "boolean", - "description" : "Whether the input and output content claim is the same." - }, - "inputContentAvailable" : { - "type" : "boolean", - "description" : "Whether the input content is still available." - }, - "inputContentClaimSection" : { - "type" : "string", - "description" : "The section in which the input content claim lives." - }, - "inputContentClaimContainer" : { - "type" : "string", - "description" : "The container in which the input content claim lives." - }, - "inputContentClaimIdentifier" : { - "type" : "string", - "description" : "The identifier of the input content claim." - }, - "inputContentClaimOffset" : { - "type" : "integer", - "format" : "int64", - "description" : "The offset into the input content claim where the flowfiles content begins." - }, - "inputContentClaimFileSize" : { - "type" : "string", - "description" : "The file size of the input content claim formatted." - }, - "inputContentClaimFileSizeBytes" : { - "type" : "integer", - "format" : "int64", - "description" : "The file size of the intput content claim in bytes." - }, - "outputContentAvailable" : { - "type" : "boolean", - "description" : "Whether the output content is still available." - }, - "outputContentClaimSection" : { - "type" : "string", - "description" : "The section in which the output content claim lives." - }, - "outputContentClaimContainer" : { - "type" : "string", - "description" : "The container in which the output content claim lives." - }, - "outputContentClaimIdentifier" : { - "type" : "string", - "description" : "The identifier of the output content claim." - }, - "outputContentClaimOffset" : { - "type" : "integer", - "format" : "int64", - "description" : "The offset into the output content claim where the flowfiles content begins." - }, - "outputContentClaimFileSize" : { - "type" : "string", - "description" : "The file size of the output content claim formatted." - }, - "outputContentClaimFileSizeBytes" : { - "type" : "integer", - "format" : "int64", - "description" : "The file size of the output content claim in bytes." - }, - "replayAvailable" : { - "type" : "boolean", - "description" : "Whether or not replay is available." - }, - "replayExplanation" : { - "type" : "string", - "description" : "Explanation as to why replay is unavailable." - }, - "sourceConnectionIdentifier" : { - "type" : "string", - "description" : "The identifier of the queue/connection from which the flowfile was pulled to genereate this event. May be null if the queue/connection is unknown or the flowfile was generated from this event." - } - } - }, - "ProvenanceEventEntity" : { - "type" : "object", - "properties" : { - "provenanceEvent" : { - "$ref" : "#/definitions/ProvenanceEventDTO" - } - }, - "xml" : { - "name" : "provenanceEventEntity" - } - }, - "ProvenanceLinkDTO" : { - "type" : "object", - "properties" : { - "sourceId" : { - "type" : "string", - "description" : "The source node id of the link." - }, - "targetId" : { - "type" : "string", - "description" : "The target node id of the link." - }, - "flowFileUuid" : { - "type" : "string", - "description" : "The flowfile uuid that traversed the link." - }, - "timestamp" : { - "type" : "string", - "description" : "The timestamp of the link (based on the destination)." - }, - "millis" : { - "type" : "integer", - "format" : "int64", - "description" : "The timestamp of this link in milliseconds." - } - } - }, - "ProvenanceNodeDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the node." - }, - "flowFileUuid" : { - "type" : "string", - "description" : "The uuid of the flowfile associated with the provenance event." - }, - "parentUuids" : { - "type" : "array", - "description" : "The uuid of the parent flowfiles of the provenance event.", - "items" : { - "type" : "string" - } - }, - "childUuids" : { - "type" : "array", - "description" : "The uuid of the childrent flowfiles of the provenance event.", - "items" : { - "type" : "string" - } - }, - "clusterNodeIdentifier" : { - "type" : "string", - "description" : "The identifier of the node that this event/flowfile originated from." - }, - "type" : { - "type" : "string", - "description" : "The type of the node.", - "enum" : [ "FLOWFILE", "EVENT" ] - }, - "eventType" : { - "type" : "string", - "description" : "If the type is EVENT, this is the type of event." - }, - "millis" : { - "type" : "integer", - "format" : "int64", - "description" : "The timestamp of the node in milliseconds." - }, - "timestamp" : { - "type" : "string", - "description" : "The timestamp of the node formatted." - } - } - }, - "ProvenanceOptionsDTO" : { - "type" : "object", - "properties" : { - "searchableFields" : { - "type" : "array", - "description" : "The available searchable field for the NiFi.", - "items" : { - "$ref" : "#/definitions/ProvenanceSearchableFieldDTO" - } - } - } - }, - "ProvenanceOptionsEntity" : { - "type" : "object", - "properties" : { - "provenanceOptions" : { - "$ref" : "#/definitions/ProvenanceOptionsDTO" - } - }, - "xml" : { - "name" : "provenanceOptionsEntity" - } - }, - "ProvenanceRequestDTO" : { - "type" : "object", - "properties" : { - "searchTerms" : { - "type" : "object", - "description" : "The search terms used to perform the search.", - "additionalProperties" : { - "$ref" : "#/definitions/ProvenanceSearchValueDTO" - } - }, - "clusterNodeId" : { - "type" : "string", - "description" : "The id of the node in the cluster where this provenance originated." - }, - "startDate" : { - "type" : "string", - "description" : "The earliest event time to include in the query." - }, - "endDate" : { - "type" : "string", - "description" : "The latest event time to include in the query." - }, - "minimumFileSize" : { - "type" : "string", - "description" : "The minimum file size to include in the query." - }, - "maximumFileSize" : { - "type" : "string", - "description" : "The maximum file size to include in the query." - }, - "maxResults" : { - "type" : "integer", - "format" : "int32", - "description" : "The maximum number of results to include." - }, - "summarize" : { - "type" : "boolean", - "description" : "Whether or not to summarize provenance events returned. This property is false by default." - }, - "incrementalResults" : { - "type" : "boolean", - "description" : "Whether or not incremental results are returned. If false, provenance events are only returned once the query completes. This property is true by default." - } - } - }, - "ProvenanceResultsDTO" : { - "type" : "object", - "properties" : { - "provenanceEvents" : { - "type" : "array", - "description" : "The provenance events that matched the search criteria.", - "items" : { - "$ref" : "#/definitions/ProvenanceEventDTO" - } - }, - "total" : { - "type" : "string", - "description" : "The total number of results formatted." - }, - "totalCount" : { - "type" : "integer", - "format" : "int64", - "description" : "The total number of results." - }, - "generated" : { - "type" : "string", - "description" : "Then the search was performed." - }, - "oldestEvent" : { - "type" : "string", - "description" : "The oldest event available in the provenance repository." - }, - "timeOffset" : { - "type" : "integer", - "format" : "int32", - "description" : "The time offset of the server that's used for event time." - }, - "errors" : { - "type" : "array", - "description" : "Any errors that occurred while performing the provenance request.", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - } - } - }, - "ProvenanceSearchValueDTO" : { - "type" : "object", - "properties" : { - "value" : { - "type" : "string", - "description" : "The search value." - }, - "inverse" : { - "type" : "boolean", - "description" : "Query for all except for search value." - } - } - }, - "ProvenanceSearchableFieldDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the searchable field." - }, - "field" : { - "type" : "string", - "description" : "The searchable field." - }, - "label" : { - "type" : "string", - "description" : "The label for the searchable field." - }, - "type" : { - "type" : "string", - "description" : "The type of the searchable field." - } - } - }, - "QueueSizeDTO" : { - "type" : "object", - "properties" : { - "byteCount" : { - "type" : "integer", - "format" : "int64", - "description" : "The size of objects in a queue." - }, - "objectCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The count of objects in a queue." - } - } - }, - "RegistryClientEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "component" : { - "$ref" : "#/definitions/RegistryDTO" - } - }, - "xml" : { - "name" : "registryClientEntity" - } - }, - "RegistryClientsEntity" : { - "type" : "object", - "properties" : { - "registries" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/RegistryClientEntity" - } - } - }, - "xml" : { - "name" : "registryClientsEntity" - } - }, - "RegistryDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The registry identifier" - }, - "name" : { - "type" : "string", - "description" : "The registry name" - }, - "description" : { - "type" : "string", - "description" : "The registry description" - }, - "uri" : { - "type" : "string", - "description" : "The registry URI" - } - } - }, - "RelationshipDTO" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The relationship name." - }, - "description" : { - "type" : "string", - "description" : "The relationship description." - }, - "autoTerminate" : { - "type" : "boolean", - "description" : "Whether or not flowfiles sent to this relationship should auto terminate." - } - } - }, - "RemotePortRunStatusEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "state" : { - "type" : "string", - "description" : "The run status of the RemotePort.", - "enum" : [ "TRANSMITTING", "STOPPED" ] - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - } - }, - "xml" : { - "name" : "entity" - } - }, - "RemoteProcessGroupContentsDTO" : { - "type" : "object", - "properties" : { - "inputPorts" : { - "type" : "array", - "description" : "The input ports to which data can be sent.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/RemoteProcessGroupPortDTO" - } - }, - "outputPorts" : { - "type" : "array", - "description" : "The output ports from which data can be retrieved.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/RemoteProcessGroupPortDTO" - } - } - } - }, - "RemoteProcessGroupDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "versionedComponentId" : { - "type" : "string", - "description" : "The ID of the corresponding component that is under version control" - }, - "parentGroupId" : { - "type" : "string", - "description" : "The id of parent process group of this component if applicable." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "targetUri" : { - "type" : "string", - "description" : "The target URI of the remote process group. If target uri is not set, but uris are set, then returns the first url in the urls. If neither target uri nor uris are set, then returns null." - }, - "targetUris" : { - "type" : "string", - "description" : "The target URI of the remote process group. If target uris is not set but target uri is set, then returns a collection containing the single target uri. If neither target uris nor uris are set, then returns null." - }, - "targetSecure" : { - "type" : "boolean", - "description" : "Whether the target is running securely." - }, - "name" : { - "type" : "string", - "description" : "The name of the remote process group." - }, - "comments" : { - "type" : "string", - "description" : "The comments for the remote process group." - }, - "communicationsTimeout" : { - "type" : "string", - "description" : "The time period used for the timeout when communicating with the target." - }, - "yieldDuration" : { - "type" : "string", - "description" : "When yielding, this amount of time must elapse before the remote process group is scheduled again." - }, - "transportProtocol" : { - "type" : "string" - }, - "localNetworkInterface" : { - "type" : "string", - "description" : "The local network interface to send/receive data. If not specified, any local address is used. If clustered, all nodes must have an interface with this identifier." - }, - "proxyHost" : { - "type" : "string" - }, - "proxyPort" : { - "type" : "integer", - "format" : "int32" - }, - "proxyUser" : { - "type" : "string" - }, - "proxyPassword" : { - "type" : "string" - }, - "authorizationIssues" : { - "type" : "array", - "description" : "Any remote authorization issues for the remote process group.", - "items" : { - "type" : "string" - } - }, - "validationErrors" : { - "type" : "array", - "description" : "The validation errors for the remote process group. These validation errors represent the problems with the remote process group that must be resolved before it can transmit.", - "items" : { - "type" : "string" - } - }, - "transmitting" : { - "type" : "boolean", - "description" : "Whether the remote process group is actively transmitting." - }, - "inputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of remote input ports currently available on the target." - }, - "outputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of remote output ports currently available on the target." - }, - "activeRemoteInputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of active remote input ports." - }, - "inactiveRemoteInputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of inactive remote input ports." - }, - "activeRemoteOutputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of active remote output ports." - }, - "inactiveRemoteOutputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of inactive remote output ports." - }, - "flowRefreshed" : { - "type" : "string", - "description" : "The timestamp when this remote process group was last refreshed." - }, - "contents" : { - "description" : "The contents of the remote process group. Will contain available input/output ports.", - "$ref" : "#/definitions/RemoteProcessGroupContentsDTO" - } - } - }, - "RemoteProcessGroupEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "component" : { - "$ref" : "#/definitions/RemoteProcessGroupDTO" - }, - "status" : { - "description" : "The status of the remote process group.", - "$ref" : "#/definitions/RemoteProcessGroupStatusDTO" - }, - "inputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of remote input ports currently available on the target." - }, - "outputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of remote output ports currently available on the target." - }, - "operatePermissions" : { - "description" : "The permissions for this component operations.", - "$ref" : "#/definitions/PermissionsDTO" - } - }, - "xml" : { - "name" : "remoteProcessGroupEntity" - } - }, - "RemoteProcessGroupPortDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the port." - }, - "targetId" : { - "type" : "string", - "description" : "The id of the target port." - }, - "versionedComponentId" : { - "type" : "string", - "description" : "The ID of the corresponding component that is under version control" - }, - "groupId" : { - "type" : "string", - "description" : "The id of the remote process group that the port resides in." - }, - "name" : { - "type" : "string", - "description" : "The name of the target port." - }, - "comments" : { - "type" : "string", - "description" : "The comments as configured on the target port." - }, - "concurrentlySchedulableTaskCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of task that may transmit flowfiles to the target port concurrently." - }, - "transmitting" : { - "type" : "boolean", - "description" : "Whether the remote port is configured for transmission." - }, - "useCompression" : { - "type" : "boolean", - "description" : "Whether the flowfiles are compressed when sent to the target port." - }, - "exists" : { - "type" : "boolean", - "description" : "Whether the target port exists." - }, - "targetRunning" : { - "type" : "boolean", - "description" : "Whether the target port is running." - }, - "connected" : { - "type" : "boolean", - "description" : "Whether the port has either an incoming or outgoing connection." - }, - "batchSettings" : { - "description" : "The batch settings for data transmission.", - "$ref" : "#/definitions/BatchSettingsDTO" - } - } - }, - "RemoteProcessGroupPortEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "remoteProcessGroupPort" : { - "$ref" : "#/definitions/RemoteProcessGroupPortDTO" - }, - "operatePermissions" : { - "description" : "The permissions for this component operations.", - "$ref" : "#/definitions/PermissionsDTO" - } - }, - "xml" : { - "name" : "remoteProcessGroupPortEntity" - } - }, - "RemoteProcessGroupStatusDTO" : { - "type" : "object", - "properties" : { - "groupId" : { - "type" : "string", - "description" : "The unique ID of the process group that the Processor belongs to" - }, - "id" : { - "type" : "string", - "description" : "The unique ID of the Processor" - }, - "name" : { - "type" : "string", - "description" : "The name of the remote process group." - }, - "targetUri" : { - "type" : "string", - "description" : "The URI of the target system." - }, - "transmissionStatus" : { - "type" : "string", - "description" : "The transmission status of the remote process group." - }, - "statsLastRefreshed" : { - "type" : "string", - "description" : "The time the status for the process group was last refreshed." - }, - "validationStatus" : { - "type" : "string", - "description" : "Indicates whether the component is valid, invalid, or still in the process of validating (i.e., it is unknown whether or not the component is valid)", - "readOnly" : true, - "enum" : [ "VALID", "INVALID", "VALIDATING" ] - }, - "aggregateSnapshot" : { - "description" : "A status snapshot that represents the aggregate stats of all nodes in the cluster. If the NiFi instance is a standalone instance, rather than a cluster, this represents the stats of the single instance.", - "$ref" : "#/definitions/RemoteProcessGroupStatusSnapshotDTO" - }, - "nodeSnapshots" : { - "type" : "array", - "description" : "A status snapshot for each node in the cluster. If the NiFi instance is a standalone instance, rather than a cluster, this may be null.", - "items" : { - "$ref" : "#/definitions/NodeRemoteProcessGroupStatusSnapshotDTO" - } - } - } - }, - "RemoteProcessGroupStatusEntity" : { - "type" : "object", - "properties" : { - "remoteProcessGroupStatus" : { - "$ref" : "#/definitions/RemoteProcessGroupStatusDTO" - }, - "canRead" : { - "type" : "boolean", - "description" : "Indicates whether the user can read a given resource.", - "readOnly" : true - } - }, - "xml" : { - "name" : "remoteProcessGroupStatusEntity" - } - }, - "RemoteProcessGroupStatusSnapshotDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the remote process group." - }, - "groupId" : { - "type" : "string", - "description" : "The id of the parent process group the remote process group resides in." - }, - "name" : { - "type" : "string", - "description" : "The name of the remote process group." - }, - "targetUri" : { - "type" : "string", - "description" : "The URI of the target system." - }, - "transmissionStatus" : { - "type" : "string", - "description" : "The transmission status of the remote process group." - }, - "activeThreadCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of active threads for the remote process group." - }, - "flowFilesSent" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of FlowFiles sent to the remote process group in the last 5 minutes." - }, - "bytesSent" : { - "type" : "integer", - "format" : "int64", - "description" : "The size of the FlowFiles sent to the remote process group in the last 5 minutes." - }, - "sent" : { - "type" : "string", - "description" : "The count/size of the flowfiles sent to the remote process group in the last 5 minutes." - }, - "flowFilesReceived" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of FlowFiles received from the remote process group in the last 5 minutes." - }, - "bytesReceived" : { - "type" : "integer", - "format" : "int64", - "description" : "The size of the FlowFiles received from the remote process group in the last 5 minutes." - }, - "received" : { - "type" : "string", - "description" : "The count/size of the flowfiles received from the remote process group in the last 5 minutes." - } - } - }, - "RemoteProcessGroupStatusSnapshotEntity" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the remote process group." - }, - "remoteProcessGroupStatusSnapshot" : { - "$ref" : "#/definitions/RemoteProcessGroupStatusSnapshotDTO" - }, - "canRead" : { - "type" : "boolean", - "description" : "Indicates whether the user can read a given resource.", - "readOnly" : true - } - }, - "xml" : { - "name" : "entity" - } - }, - "RemoteProcessGroupsEntity" : { - "type" : "object", - "properties" : { - "remoteProcessGroups" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/RemoteProcessGroupEntity" - } - } - }, - "xml" : { - "name" : "remoteProcessGroupsEntity" - } - }, - "ReportingTaskDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "versionedComponentId" : { - "type" : "string", - "description" : "The ID of the corresponding component that is under version control" - }, - "parentGroupId" : { - "type" : "string", - "description" : "The id of parent process group of this component if applicable." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "name" : { - "type" : "string", - "description" : "The name of the reporting task." - }, - "type" : { - "type" : "string", - "description" : "The fully qualified type of the reporting task." - }, - "bundle" : { - "description" : "The details of the artifact that bundled this processor type.", - "$ref" : "#/definitions/BundleDTO" - }, - "state" : { - "type" : "string", - "description" : "The state of the reporting task.", - "enum" : [ "RUNNING", "STOPPED", "DISABLED" ] - }, - "comments" : { - "type" : "string", - "description" : "The comments of the reporting task." - }, - "persistsState" : { - "type" : "boolean", - "description" : "Whether the reporting task persists state." - }, - "restricted" : { - "type" : "boolean", - "description" : "Whether the reporting task requires elevated privileges." - }, - "deprecated" : { - "type" : "boolean", - "description" : "Whether the reporting task has been deprecated." - }, - "multipleVersionsAvailable" : { - "type" : "boolean", - "description" : "Whether the reporting task has multiple versions available." - }, - "schedulingPeriod" : { - "type" : "string", - "description" : "The frequency with which to schedule the reporting task. The format of the value willd epend on the valud of the schedulingStrategy." - }, - "schedulingStrategy" : { - "type" : "string", - "description" : "The scheduling strategy that determines how the schedulingPeriod value should be interpreted." - }, - "defaultSchedulingPeriod" : { - "type" : "object", - "description" : "The default scheduling period for the different scheduling strategies.", - "additionalProperties" : { - "type" : "string" - } - }, - "properties" : { - "type" : "object", - "description" : "The properties of the reporting task.", - "additionalProperties" : { - "type" : "string" - } - }, - "descriptors" : { - "type" : "object", - "description" : "The descriptors for the reporting tasks properties.", - "additionalProperties" : { - "$ref" : "#/definitions/PropertyDescriptorDTO" - } - }, - "customUiUrl" : { - "type" : "string", - "description" : "The URL for the custom configuration UI for the reporting task." - }, - "annotationData" : { - "type" : "string", - "description" : "The annotation data for the repoting task. This is how the custom UI relays configuration to the reporting task." - }, - "validationErrors" : { - "type" : "array", - "description" : "Gets the validation errors from the reporting task. These validation errors represent the problems with the reporting task that must be resolved before it can be scheduled to run.", - "items" : { - "type" : "string" - } - }, - "validationStatus" : { - "type" : "string", - "description" : "Indicates whether the Processor is valid, invalid, or still in the process of validating (i.e., it is unknown whether or not the Processor is valid)", - "readOnly" : true, - "enum" : [ "VALID", "INVALID", "VALIDATING" ] - }, - "activeThreadCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of active threads for the reporting task." - }, - "extensionMissing" : { - "type" : "boolean", - "description" : "Whether the underlying extension is missing." - } - } - }, - "ReportingTaskEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "component" : { - "$ref" : "#/definitions/ReportingTaskDTO" - }, - "operatePermissions" : { - "description" : "The permissions for this component operations.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "status" : { - "description" : "The status for this ReportingTask.", - "readOnly" : true, - "$ref" : "#/definitions/ReportingTaskStatusDTO" - } - }, - "xml" : { - "name" : "reportingTaskEntity" - } - }, - "ReportingTaskRunStatusEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "state" : { - "type" : "string", - "description" : "The run status of the ReportingTask.", - "enum" : [ "RUNNING", "STOPPED" ] - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - } - }, - "xml" : { - "name" : "entity" - } - }, - "ReportingTaskStatusDTO" : { - "type" : "object", - "properties" : { - "runStatus" : { - "type" : "string", - "description" : "The run status of this ReportingTask", - "readOnly" : true, - "enum" : [ "RUNNING", "STOPPED", "DISABLED" ] - }, - "validationStatus" : { - "type" : "string", - "description" : "Indicates whether the component is valid, invalid, or still in the process of validating (i.e., it is unknown whether or not the component is valid)", - "readOnly" : true, - "enum" : [ "VALID", "INVALID", "VALIDATING" ] - }, - "activeThreadCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of active threads for the component." - } - } - }, - "ReportingTaskTypesEntity" : { - "type" : "object", - "properties" : { - "reportingTaskTypes" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/DocumentedTypeDTO" - } - } - }, - "xml" : { - "name" : "reportingTaskTypesEntity" - } - }, - "ReportingTasksEntity" : { - "type" : "object", - "properties" : { - "reportingTasks" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ReportingTaskEntity" - } - } - }, - "xml" : { - "name" : "reportingTasksEntity" - } - }, - "RequiredPermissionDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The required sub-permission necessary for this restriction." - }, - "label" : { - "type" : "string", - "description" : "The label for the required sub-permission necessary for this restriction." - } - } - }, - "ResourceDTO" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The identifier of the resource." - }, - "name" : { - "type" : "string", - "description" : "The name of the resource." - } - } - }, - "ResourcesEntity" : { - "type" : "object", - "properties" : { - "resources" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/ResourceDTO" - } - } - }, - "xml" : { - "name" : "resourcesEntity" - } - }, - "RevisionDTO" : { - "type" : "object", - "properties" : { - "clientId" : { - "type" : "string", - "description" : "A client identifier used to make a request. By including a client identifier, the API can allow multiple requests without needing the current revision. Due to the asynchronous nature of requests/responses this was implemented to allow the client to make numerous requests without having to wait for the previous response to come back" - }, - "version" : { - "type" : "integer", - "format" : "int64", - "description" : "NiFi employs an optimistic locking strategy where the client must include a revision in their request when performing an update. In a response to a mutable flow request, this field represents the updated base version." - }, - "lastModifier" : { - "type" : "string", - "description" : "The user that last modified the flow.", - "readOnly" : true - } - } - }, - "RevisionInfo" : { - "type" : "object", - "properties" : { - "clientId" : { - "type" : "string", - "description" : "A client identifier used to make a request. By including a client identifier, the API can allow multiple requests without needing the current revision. Due to the asynchronous nature of requests/responses this was implemented to allow the client to make numerous requests without having to wait for the previous response to come back." - }, - "version" : { - "type" : "integer", - "format" : "int64", - "description" : "NiFi Registry employs an optimistic locking strategy where the client must include a revision in their request when performing an update. In a response to a mutable flow request, this field represents the updated base version." - }, - "lastModifier" : { - "type" : "string", - "description" : "The user that last modified the entity.", - "readOnly" : true - } - }, - "description" : "The revision information for an entity managed through the REST API." - }, - "RunStatusDetailsRequestEntity" : { - "type" : "object", - "properties" : { - "processorIds" : { - "type" : "array", - "description" : "The IDs of all processors whose run status details should be provided", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - } - }, - "xml" : { - "name" : "runStatusDetailsRequest" - } - }, - "ScheduleComponentsEntity" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the ProcessGroup" - }, - "state" : { - "type" : "string", - "description" : "The desired state of the descendant components", - "enum" : [ "RUNNING", "STOPPED", "ENABLED", "DISABLED" ] - }, - "components" : { - "type" : "object", - "description" : "Optional components to schedule. If not specified, all authorized descendant components will be used.", - "additionalProperties" : { - "$ref" : "#/definitions/RevisionDTO" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - } - }, - "xml" : { - "name" : "scheduleComponentEntity" - } - }, - "SearchResultGroupDTO" : { - "type" : "object", - "required" : [ "id" ], - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the group." - }, - "name" : { - "type" : "string", - "description" : "The name of the group." - } - } - }, - "SearchResultsDTO" : { - "type" : "object", - "properties" : { - "processorResults" : { - "type" : "array", - "description" : "The processors that matched the search.", - "items" : { - "$ref" : "#/definitions/ComponentSearchResultDTO" - } - }, - "connectionResults" : { - "type" : "array", - "description" : "The connections that matched the search.", - "items" : { - "$ref" : "#/definitions/ComponentSearchResultDTO" - } - }, - "processGroupResults" : { - "type" : "array", - "description" : "The process groups that matched the search.", - "items" : { - "$ref" : "#/definitions/ComponentSearchResultDTO" - } - }, - "inputPortResults" : { - "type" : "array", - "description" : "The input ports that matched the search.", - "items" : { - "$ref" : "#/definitions/ComponentSearchResultDTO" - } - }, - "outputPortResults" : { - "type" : "array", - "description" : "The output ports that matched the search.", - "items" : { - "$ref" : "#/definitions/ComponentSearchResultDTO" - } - }, - "remoteProcessGroupResults" : { - "type" : "array", - "description" : "The remote process groups that matched the search.", - "items" : { - "$ref" : "#/definitions/ComponentSearchResultDTO" - } - }, - "funnelResults" : { - "type" : "array", - "description" : "The funnels that matched the search.", - "items" : { - "$ref" : "#/definitions/ComponentSearchResultDTO" - } - }, - "labelResults" : { - "type" : "array", - "description" : "The labels that matched the search.", - "items" : { - "$ref" : "#/definitions/ComponentSearchResultDTO" - } - }, - "controllerServiceNodeResults" : { - "type" : "array", - "description" : "The controller service nodes that matched the search", - "items" : { - "$ref" : "#/definitions/ComponentSearchResultDTO" - } - }, - "parameterContextResults" : { - "type" : "array", - "description" : "The parameter contexts that matched the search.", - "items" : { - "$ref" : "#/definitions/ComponentSearchResultDTO" - } - }, - "parameterResults" : { - "type" : "array", - "description" : "The parameters that matched the search.", - "items" : { - "$ref" : "#/definitions/ComponentSearchResultDTO" - } - } - } - }, - "SearchResultsEntity" : { - "type" : "object", - "properties" : { - "searchResultsDTO" : { - "$ref" : "#/definitions/SearchResultsDTO" - } - }, - "xml" : { - "name" : "searchResultsEntity" - } - }, - "SnippetDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the snippet." - }, - "uri" : { - "type" : "string", - "description" : "The URI of the snippet." - }, - "parentGroupId" : { - "type" : "string", - "description" : "The group id for the components in the snippet." - }, - "processGroups" : { - "type" : "object", - "description" : "The ids of the process groups in this snippet. These ids will be populated within each response. They can be specified when creating a snippet. However, once a snippet has been created its contents cannot be modified (these ids are ignored during update requests).", - "additionalProperties" : { - "$ref" : "#/definitions/RevisionDTO" - } - }, - "remoteProcessGroups" : { - "type" : "object", - "description" : "The ids of the remote process groups in this snippet. These ids will be populated within each response. They can be specified when creating a snippet. However, once a snippet has been created its contents cannot be modified (these ids are ignored during update requests).", - "additionalProperties" : { - "$ref" : "#/definitions/RevisionDTO" - } - }, - "processors" : { - "type" : "object", - "description" : "The ids of the processors in this snippet. These ids will be populated within each response. They can be specified when creating a snippet. However, once a snippet has been created its contents cannot be modified (these ids are ignored during update requests).", - "additionalProperties" : { - "$ref" : "#/definitions/RevisionDTO" - } - }, - "inputPorts" : { - "type" : "object", - "description" : "The ids of the input ports in this snippet. These ids will be populated within each response. They can be specified when creating a snippet. However, once a snippet has been created its contents cannot be modified (these ids are ignored during update requests).", - "additionalProperties" : { - "$ref" : "#/definitions/RevisionDTO" - } - }, - "outputPorts" : { - "type" : "object", - "description" : "The ids of the output ports in this snippet. These ids will be populated within each response. They can be specified when creating a snippet. However, once a snippet has been created its contents cannot be modified (these ids are ignored during update requests).", - "additionalProperties" : { - "$ref" : "#/definitions/RevisionDTO" - } - }, - "connections" : { - "type" : "object", - "description" : "The ids of the connections in this snippet. These ids will be populated within each response. They can be specified when creating a snippet. However, once a snippet has been created its contents cannot be modified (these ids are ignored during update requests).", - "additionalProperties" : { - "$ref" : "#/definitions/RevisionDTO" - } - }, - "labels" : { - "type" : "object", - "description" : "The ids of the labels in this snippet. These ids will be populated within each response. They can be specified when creating a snippet. However, once a snippet has been created its contents cannot be modified (these ids are ignored during update requests).", - "additionalProperties" : { - "$ref" : "#/definitions/RevisionDTO" - } - }, - "funnels" : { - "type" : "object", - "description" : "The ids of the funnels in this snippet. These ids will be populated within each response. They can be specified when creating a snippet. However, once a snippet has been created its contents cannot be modified (these ids are ignored during update requests).", - "additionalProperties" : { - "$ref" : "#/definitions/RevisionDTO" - } - } - } - }, - "SnippetEntity" : { - "type" : "object", - "properties" : { - "snippet" : { - "description" : "The snippet.", - "$ref" : "#/definitions/SnippetDTO" - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - } - }, - "xml" : { - "name" : "snippetEntity" - } - }, - "StartVersionControlRequestEntity" : { - "type" : "object", - "properties" : { - "versionedFlow" : { - "description" : "The versioned flow", - "$ref" : "#/definitions/VersionedFlowDTO" - }, - "processGroupRevision" : { - "description" : "The Revision of the Process Group under Version Control", - "$ref" : "#/definitions/RevisionDTO" - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - } - }, - "xml" : { - "name" : "startVersionControlRequestEntity" - } - }, - "StateEntryDTO" : { - "type" : "object", - "properties" : { - "key" : { - "type" : "string", - "description" : "The key for this state." - }, - "value" : { - "type" : "string", - "description" : "The value for this state." - }, - "clusterNodeId" : { - "type" : "string", - "description" : "The identifier for the node where the state originated." - }, - "clusterNodeAddress" : { - "type" : "string", - "description" : "The label for the node where the state originated." - } - } - }, - "StateMapDTO" : { - "type" : "object", - "properties" : { - "scope" : { - "type" : "string", - "description" : "The scope of this StateMap." - }, - "totalEntryCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The total number of state entries. When the state map is lengthy, only of portion of the entries are returned." - }, - "state" : { - "type" : "array", - "description" : "The state.", - "items" : { - "$ref" : "#/definitions/StateEntryDTO" - } - } - } - }, - "StatusDescriptorDTO" : { - "type" : "object", - "properties" : { - "field" : { - "type" : "string", - "description" : "The name of the status field." - }, - "label" : { - "type" : "string", - "description" : "The label for the status field." - }, - "description" : { - "type" : "string", - "description" : "The description of the status field." - }, - "formatter" : { - "type" : "string", - "description" : "The formatter for the status descriptor." - } - } - }, - "StatusHistoryDTO" : { - "type" : "object", - "properties" : { - "generated" : { - "type" : "string", - "description" : "When the status history was generated." - }, - "componentDetails" : { - "type" : "object", - "description" : "A Map of key/value pairs that describe the component that the status history belongs to", - "additionalProperties" : { - "type" : "string" - } - }, - "fieldDescriptors" : { - "type" : "array", - "description" : "The Descriptors that provide information on each of the metrics provided in the status history", - "items" : { - "$ref" : "#/definitions/StatusDescriptorDTO" - } - }, - "aggregateSnapshots" : { - "type" : "array", - "description" : "A list of StatusSnapshotDTO objects that provide the actual metric values for the component. If the NiFi instance is clustered, this will represent the aggregate status across all nodes. If the NiFi instance is not clustered, this will represent the status of the entire NiFi instance.", - "items" : { - "$ref" : "#/definitions/StatusSnapshotDTO" - } - }, - "nodeSnapshots" : { - "type" : "array", - "description" : "The NodeStatusSnapshotsDTO objects that provide the actual metric values for the component, for each node. If the NiFi instance is not clustered, this value will be null.", - "items" : { - "$ref" : "#/definitions/NodeStatusSnapshotsDTO" - } - } - } - }, - "StatusHistoryEntity" : { - "type" : "object", - "properties" : { - "statusHistory" : { - "$ref" : "#/definitions/StatusHistoryDTO" - }, - "canRead" : { - "type" : "boolean", - "description" : "Indicates whether the user can read a given resource.", - "readOnly" : true - } - }, - "xml" : { - "name" : "statusHistoryEntity" - } - }, - "StatusSnapshotDTO" : { - "type" : "object", - "properties" : { - "timestamp" : { - "type" : "string", - "format" : "date-time", - "description" : "The timestamp of the snapshot." - }, - "statusMetrics" : { - "type" : "object", - "description" : "The status metrics.", - "additionalProperties" : { - "type" : "integer", - "format" : "int64" - } - } - } - }, - "StorageUsageDTO" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The identifier of this storage location. The identifier will correspond to the identifier keyed in the storage configuration." - }, - "freeSpace" : { - "type" : "string", - "description" : "Amount of free space." - }, - "totalSpace" : { - "type" : "string", - "description" : "Amount of total space." - }, - "usedSpace" : { - "type" : "string", - "description" : "Amount of used space." - }, - "freeSpaceBytes" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes of free space." - }, - "totalSpaceBytes" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes of total space." - }, - "usedSpaceBytes" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes of used space." - }, - "utilization" : { - "type" : "string", - "description" : "Utilization of this storage location." - } - } - }, - "StreamingOutput" : { - "type" : "object" - }, - "SubmitReplayRequestEntity" : { - "type" : "object", - "properties" : { - "eventId" : { - "type" : "integer", - "format" : "int64", - "description" : "The event identifier" - }, - "clusterNodeId" : { - "type" : "string", - "description" : "The identifier of the node where to submit the replay request." - } - }, - "xml" : { - "name" : "copySnippetRequestEntity" - } - }, - "SystemDiagnosticsDTO" : { - "type" : "object", - "properties" : { - "aggregateSnapshot" : { - "description" : "A systems diagnostic snapshot that represents the aggregate values of all nodes in the cluster. If the NiFi instance is a standalone instance, rather than a cluster, this represents the stats of the single instance.", - "$ref" : "#/definitions/SystemDiagnosticsSnapshotDTO" - }, - "nodeSnapshots" : { - "type" : "array", - "description" : "A systems diagnostics snapshot for each node in the cluster. If the NiFi instance is a standalone instance, rather than a cluster, this may be null.", - "items" : { - "$ref" : "#/definitions/NodeSystemDiagnosticsSnapshotDTO" - } - } - } - }, - "SystemDiagnosticsEntity" : { - "type" : "object", - "properties" : { - "systemDiagnostics" : { - "$ref" : "#/definitions/SystemDiagnosticsDTO" - } - }, - "xml" : { - "name" : "systemDiagnosticsEntity" - } - }, - "SystemDiagnosticsSnapshotDTO" : { - "type" : "object", - "properties" : { - "totalNonHeap" : { - "type" : "string", - "description" : "Total size of non heap." - }, - "totalNonHeapBytes" : { - "type" : "integer", - "format" : "int64", - "description" : "Total number of bytes allocated to the JVM not used for heap" - }, - "usedNonHeap" : { - "type" : "string", - "description" : "Amount of use non heap." - }, - "usedNonHeapBytes" : { - "type" : "integer", - "format" : "int64", - "description" : "Total number of bytes used by the JVM not in the heap space" - }, - "freeNonHeap" : { - "type" : "string", - "description" : "Amount of free non heap." - }, - "freeNonHeapBytes" : { - "type" : "integer", - "format" : "int64", - "description" : "Total number of free non-heap bytes available to the JVM" - }, - "maxNonHeap" : { - "type" : "string", - "description" : "Maximum size of non heap." - }, - "maxNonHeapBytes" : { - "type" : "integer", - "format" : "int64", - "description" : "The maximum number of bytes that the JVM can use for non-heap purposes" - }, - "nonHeapUtilization" : { - "type" : "string", - "description" : "Utilization of non heap." - }, - "totalHeap" : { - "type" : "string", - "description" : "Total size of heap." - }, - "totalHeapBytes" : { - "type" : "integer", - "format" : "int64", - "description" : "The total number of bytes that are available for the JVM heap to use" - }, - "usedHeap" : { - "type" : "string", - "description" : "Amount of used heap." - }, - "usedHeapBytes" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes of JVM heap that are currently being used" - }, - "freeHeap" : { - "type" : "string", - "description" : "Amount of free heap." - }, - "freeHeapBytes" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes that are allocated to the JVM heap but not currently being used" - }, - "maxHeap" : { - "type" : "string", - "description" : "Maximum size of heap." - }, - "maxHeapBytes" : { - "type" : "integer", - "format" : "int64", - "description" : "The maximum number of bytes that can be used by the JVM" - }, - "heapUtilization" : { - "type" : "string", - "description" : "Utilization of heap." - }, - "availableProcessors" : { - "type" : "integer", - "format" : "int32", - "description" : "Number of available processors if supported by the underlying system." - }, - "processorLoadAverage" : { - "type" : "number", - "format" : "double", - "description" : "The processor load average if supported by the underlying system." - }, - "totalThreads" : { - "type" : "integer", - "format" : "int32", - "description" : "Total number of threads." - }, - "daemonThreads" : { - "type" : "integer", - "format" : "int32", - "description" : "Number of daemon threads." - }, - "uptime" : { - "type" : "string", - "description" : "The uptime of the Java virtual machine" - }, - "flowFileRepositoryStorageUsage" : { - "description" : "The flowfile repository storage usage.", - "$ref" : "#/definitions/StorageUsageDTO" - }, - "contentRepositoryStorageUsage" : { - "type" : "array", - "description" : "The content repository storage usage.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/StorageUsageDTO" - } - }, - "provenanceRepositoryStorageUsage" : { - "type" : "array", - "description" : "The provenance repository storage usage.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/StorageUsageDTO" - } - }, - "garbageCollection" : { - "type" : "array", - "description" : "The garbage collection details.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/GarbageCollectionDTO" - } - }, - "statsLastRefreshed" : { - "type" : "string", - "description" : "When the diagnostics were generated." - }, - "versionInfo" : { - "description" : "The nifi, os, java, and build version information", - "$ref" : "#/definitions/VersionInfoDTO" - } - } - }, - "TemplateDTO" : { - "type" : "object", - "properties" : { - "uri" : { - "type" : "string", - "description" : "The URI for the template." - }, - "id" : { - "type" : "string", - "description" : "The id of the template." - }, - "groupId" : { - "type" : "string", - "description" : "The id of the Process Group that the template belongs to." - }, - "name" : { - "type" : "string", - "description" : "The name of the template." - }, - "description" : { - "type" : "string", - "description" : "The description of the template." - }, - "timestamp" : { - "type" : "string", - "description" : "The timestamp when this template was created." - }, - "encodingVersion" : { - "type" : "string", - "xml" : { - "name" : "encoding-version", - "attribute" : true - }, - "description" : "The encoding version of this template." - }, - "snippet" : { - "description" : "The contents of the template.", - "$ref" : "#/definitions/FlowSnippetDTO" - } - }, - "xml" : { - "name" : "template" - } - }, - "TemplateEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "template" : { - "$ref" : "#/definitions/TemplateDTO" - } - }, - "xml" : { - "name" : "templateEntity" - } - }, - "TemplatesEntity" : { - "type" : "object", - "properties" : { - "templates" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/TemplateEntity" - } - }, - "generated" : { - "type" : "string", - "description" : "When this content was generated." - } - }, - "xml" : { - "name" : "templatesEntity" - } - }, - "TenantDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "versionedComponentId" : { - "type" : "string", - "description" : "The ID of the corresponding component that is under version control" - }, - "parentGroupId" : { - "type" : "string", - "description" : "The id of parent process group of this component if applicable." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "identity" : { - "type" : "string", - "description" : "The identity of the tenant." - }, - "configurable" : { - "type" : "boolean", - "description" : "Whether this tenant is configurable." - } - } - }, - "TenantEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "component" : { - "$ref" : "#/definitions/TenantDTO" - } - }, - "xml" : { - "name" : "tenantEntity" - } - }, - "TenantsEntity" : { - "type" : "object", - "properties" : { - "users" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/TenantEntity" - } - }, - "userGroups" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/TenantEntity" - } - } - }, - "xml" : { - "name" : "tenantsEntity" - } - }, - "TransactionResultEntity" : { - "type" : "object", - "properties" : { - "flowFileSent" : { - "type" : "integer", - "format" : "int32" - }, - "responseCode" : { - "type" : "integer", - "format" : "int32" - }, - "message" : { - "type" : "string" - } - }, - "xml" : { - "name" : "transactionResultEntity" - } - }, - "UpdateControllerServiceReferenceRequestEntity" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The identifier of the Controller Service." - }, - "state" : { - "type" : "string", - "description" : "The new state of the references for the controller service.", - "enum" : [ "ENABLED", "DISABLED", "RUNNING", "STOPPED" ] - }, - "referencingComponentRevisions" : { - "type" : "object", - "description" : "The revisions for all referencing components.", - "additionalProperties" : { - "$ref" : "#/definitions/RevisionDTO" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - } - }, - "xml" : { - "name" : "updateControllerServiceReferenceRequestEntity" - } - }, - "UserDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "versionedComponentId" : { - "type" : "string", - "description" : "The ID of the corresponding component that is under version control" - }, - "parentGroupId" : { - "type" : "string", - "description" : "The id of parent process group of this component if applicable." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "identity" : { - "type" : "string", - "description" : "The identity of the tenant." - }, - "configurable" : { - "type" : "boolean", - "description" : "Whether this tenant is configurable." - }, - "userGroups" : { - "type" : "array", - "description" : "The groups to which the user belongs. This field is read only and it provided for convenience.", - "readOnly" : true, - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/TenantEntity" - } - }, - "accessPolicies" : { - "type" : "array", - "description" : "The access policies this user belongs to.", - "readOnly" : true, - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/AccessPolicySummaryEntity" - } - } - } - }, - "UserEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "component" : { - "$ref" : "#/definitions/UserDTO" - } - }, - "xml" : { - "name" : "userEntity" - } - }, - "UserGroupDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "versionedComponentId" : { - "type" : "string", - "description" : "The ID of the corresponding component that is under version control" - }, - "parentGroupId" : { - "type" : "string", - "description" : "The id of parent process group of this component if applicable." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "identity" : { - "type" : "string", - "description" : "The identity of the tenant." - }, - "configurable" : { - "type" : "boolean", - "description" : "Whether this tenant is configurable." - }, - "users" : { - "type" : "array", - "description" : "The users that belong to the user group.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/TenantEntity" - } - }, - "accessPolicies" : { - "type" : "array", - "description" : "The access policies this user group belongs to. This field was incorrectly defined as an AccessPolicyEntity. For compatibility reasons the field will remain of this type, however only the fields that are present in the AccessPolicySummaryEntity will be populated here.", - "readOnly" : true, - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/AccessPolicyEntity" - } - } - } - }, - "UserGroupEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "component" : { - "$ref" : "#/definitions/UserGroupDTO" - } - }, - "xml" : { - "name" : "userGroupEntity" - } - }, - "UserGroupsEntity" : { - "type" : "object", - "properties" : { - "userGroups" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/UserGroupEntity" - } - } - }, - "xml" : { - "name" : "userGroupsEntity" - } - }, - "UsersEntity" : { - "type" : "object", - "properties" : { - "generated" : { - "type" : "string", - "description" : "When this content was generated." - }, - "users" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/UserEntity" - } - } - }, - "xml" : { - "name" : "usersEntity" - } - }, - "VariableDTO" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The name of the variable" - }, - "value" : { - "type" : "string", - "description" : "The value of the variable" - }, - "processGroupId" : { - "type" : "string", - "description" : "The ID of the Process Group where this Variable is defined", - "readOnly" : true - }, - "affectedComponents" : { - "type" : "array", - "description" : "A set of all components that will be affected if the value of this variable is changed", - "readOnly" : true, - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/AffectedComponentEntity" - } - } - } - }, - "VariableEntity" : { - "type" : "object", - "properties" : { - "variable" : { - "description" : "The variable information", - "$ref" : "#/definitions/VariableDTO" - }, - "canWrite" : { - "type" : "boolean", - "description" : "Indicates whether the user can write a given resource.", - "readOnly" : true - } - }, - "xml" : { - "name" : "variableEntity" - } - }, - "VariableRegistryDTO" : { - "type" : "object", - "properties" : { - "variables" : { - "type" : "array", - "description" : "The variables that are available in this Variable Registry", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VariableEntity" - } - }, - "processGroupId" : { - "type" : "string", - "description" : "The UUID of the Process Group that this Variable Registry belongs to" - } - } - }, - "VariableRegistryEntity" : { - "type" : "object", - "properties" : { - "processGroupRevision" : { - "description" : "The revision of the Process Group that the Variable Registry belongs to", - "$ref" : "#/definitions/RevisionDTO" - }, - "variableRegistry" : { - "description" : "The Variable Registry.", - "$ref" : "#/definitions/VariableRegistryDTO" - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - } - }, - "xml" : { - "name" : "variableRegistryEntity" - } - }, - "VariableRegistryUpdateRequestDTO" : { - "type" : "object", - "properties" : { - "requestId" : { - "type" : "string", - "description" : "The ID of the request", - "readOnly" : true - }, - "uri" : { - "type" : "string", - "description" : "The URI for the request", - "readOnly" : true - }, - "submissionTime" : { - "type" : "string", - "format" : "date-time", - "description" : "The timestamp of when the request was submitted", - "readOnly" : true - }, - "lastUpdated" : { - "type" : "string", - "format" : "date-time", - "description" : "The timestamp of when the request was last updated", - "readOnly" : true - }, - "complete" : { - "type" : "boolean", - "description" : "Whether or not the request is completed", - "readOnly" : true - }, - "failureReason" : { - "type" : "string", - "description" : "The reason for the request failing, or null if the request has not failed", - "readOnly" : true - }, - "percentCompleted" : { - "type" : "integer", - "format" : "int32", - "description" : "A value between 0 and 100 (inclusive) indicating how close the request is to completion", - "readOnly" : true - }, - "state" : { - "type" : "string", - "description" : "A description of the current state of the request", - "readOnly" : true - }, - "updateSteps" : { - "type" : "array", - "description" : "The steps that are required in order to complete the request, along with the status of each", - "readOnly" : true, - "items" : { - "$ref" : "#/definitions/VariableRegistryUpdateStepDTO" - } - }, - "processGroupId" : { - "type" : "string", - "description" : "The unique ID of the Process Group that the variable registry belongs to" - }, - "affectedComponents" : { - "type" : "array", - "description" : "A set of all components that will be affected if the value of this variable is changed", - "readOnly" : true, - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/AffectedComponentEntity" - } - } - } - }, - "VariableRegistryUpdateRequestEntity" : { - "type" : "object", - "properties" : { - "request" : { - "description" : "The Variable Registry Update Request", - "$ref" : "#/definitions/VariableRegistryUpdateRequestDTO" - }, - "processGroupRevision" : { - "description" : "The revision for the Process Group that owns this variable registry.", - "$ref" : "#/definitions/RevisionDTO" - } - }, - "xml" : { - "name" : "variableRegistryUpdateRequestEntity" - } - }, - "VariableRegistryUpdateStepDTO" : { - "type" : "object", - "properties" : { - "description" : { - "type" : "string", - "description" : "Explanation of what happens in this step", - "readOnly" : true - }, - "complete" : { - "type" : "boolean", - "description" : "Whether or not this step has completed", - "readOnly" : true - }, - "failureReason" : { - "type" : "string", - "description" : "An explanation of why this step failed, or null if this step did not fail", - "readOnly" : true - } - } - }, - "VersionControlComponentMappingEntity" : { - "type" : "object", - "properties" : { - "versionControlComponentMapping" : { - "type" : "object", - "description" : "The mapping of Versioned Component Identifiers to instance ID's", - "additionalProperties" : { - "type" : "string" - } - }, - "processGroupRevision" : { - "description" : "The revision of the Process Group", - "$ref" : "#/definitions/RevisionDTO" - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "versionControlInformation" : { - "description" : "The Version Control information", - "$ref" : "#/definitions/VersionControlInformationDTO" - } - }, - "xml" : { - "name" : "versionControlComponentMappingEntity" - } - }, - "VersionControlInformationDTO" : { - "type" : "object", - "properties" : { - "groupId" : { - "type" : "string", - "description" : "The ID of the Process Group that is under version control" - }, - "registryId" : { - "type" : "string", - "description" : "The ID of the registry that the flow is stored in" - }, - "registryName" : { - "type" : "string", - "description" : "The name of the registry that the flow is stored in", - "readOnly" : true - }, - "bucketId" : { - "type" : "string", - "description" : "The ID of the bucket that the flow is stored in" - }, - "bucketName" : { - "type" : "string", - "description" : "The name of the bucket that the flow is stored in", - "readOnly" : true - }, - "flowId" : { - "type" : "string", - "description" : "The ID of the flow" - }, - "flowName" : { - "type" : "string", - "description" : "The name of the flow" - }, - "flowDescription" : { - "type" : "string", - "description" : "The description of the flow" - }, - "version" : { - "type" : "integer", - "format" : "int32", - "description" : "The version of the flow" - }, - "state" : { - "type" : "string", - "description" : "The current state of the Process Group, as it relates to the Versioned Flow", - "readOnly" : true, - "enum" : [ "LOCALLY_MODIFIED", "STALE", "LOCALLY_MODIFIED_AND_STALE", "UP_TO_DATE", "SYNC_FAILURE" ] - }, - "stateExplanation" : { - "type" : "string", - "description" : "Explanation of why the group is in the specified state", - "readOnly" : true - } - } - }, - "VersionControlInformationEntity" : { - "type" : "object", - "properties" : { - "processGroupRevision" : { - "description" : "The Revision for the Process Group", - "$ref" : "#/definitions/RevisionDTO" - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "versionControlInformation" : { - "description" : "The Version Control information", - "$ref" : "#/definitions/VersionControlInformationDTO" - } - }, - "xml" : { - "name" : "versionControlInformationEntity" - } - }, - "VersionInfoDTO" : { - "type" : "object", - "properties" : { - "niFiVersion" : { - "type" : "string", - "description" : "The version of this NiFi." - }, - "javaVendor" : { - "type" : "string", - "description" : "Java JVM vendor" - }, - "javaVersion" : { - "type" : "string", - "description" : "Java version" - }, - "osName" : { - "type" : "string", - "description" : "Host operating system name" - }, - "osVersion" : { - "type" : "string", - "description" : "Host operating system version" - }, - "osArchitecture" : { - "type" : "string", - "description" : "Host operating system architecture" - }, - "buildTag" : { - "type" : "string", - "description" : "Build tag" - }, - "buildRevision" : { - "type" : "string", - "description" : "Build revision or commit hash" - }, - "buildBranch" : { - "type" : "string", - "description" : "Build branch" - }, - "buildTimestamp" : { - "type" : "string", - "format" : "date-time", - "description" : "Build timestamp" - } - } - }, - "VersionedConnection" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The component's unique identifier" - }, - "name" : { - "type" : "string", - "description" : "The component's name" - }, - "comments" : { - "type" : "string", - "description" : "The user-supplied comments for the component" - }, - "position" : { - "description" : "The component's position on the graph", - "$ref" : "#/definitions/Position" - }, - "source" : { - "description" : "The source of the connection.", - "$ref" : "#/definitions/ConnectableComponent" - }, - "destination" : { - "description" : "The destination of the connection.", - "$ref" : "#/definitions/ConnectableComponent" - }, - "labelIndex" : { - "type" : "integer", - "format" : "int32", - "description" : "The index of the bend point where to place the connection label." - }, - "zIndex" : { - "type" : "integer", - "format" : "int64", - "description" : "The z index of the connection." - }, - "selectedRelationships" : { - "type" : "array", - "description" : "The selected relationship that comprise the connection.", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - }, - "backPressureObjectThreshold" : { - "type" : "integer", - "format" : "int64", - "description" : "The object count threshold for determining when back pressure is applied. Updating this value is a passive change in the sense that it won't impact whether existing files over the limit are affected but it does help feeder processors to stop pushing too much into this work queue." - }, - "backPressureDataSizeThreshold" : { - "type" : "string", - "description" : "The object data size threshold for determining when back pressure is applied. Updating this value is a passive change in the sense that it won't impact whether existing files over the limit are affected but it does help feeder processors to stop pushing too much into this work queue." - }, - "flowFileExpiration" : { - "type" : "string", - "description" : "The amount of time a flow file may be in the flow before it will be automatically aged out of the flow. Once a flow file reaches this age it will be terminated from the flow the next time a processor attempts to start work on it." - }, - "prioritizers" : { - "type" : "array", - "description" : "The comparators used to prioritize the queue.", - "items" : { - "type" : "string" - } - }, - "bends" : { - "type" : "array", - "description" : "The bend points on the connection.", - "items" : { - "$ref" : "#/definitions/Position" - } - }, - "loadBalanceStrategy" : { - "type" : "string", - "description" : "The Strategy to use for load balancing data across the cluster, or null, if no Load Balance Strategy has been specified.", - "enum" : [ "DO_NOT_LOAD_BALANCE", "PARTITION_BY_ATTRIBUTE", "ROUND_ROBIN", "SINGLE_NODE" ] - }, - "partitioningAttribute" : { - "type" : "string", - "description" : "The attribute to use for partitioning data as it is load balanced across the cluster. If the Load Balance Strategy is configured to use PARTITION_BY_ATTRIBUTE, the value returned by this method is the name of the FlowFile Attribute that will be used to determine which node in the cluster should receive a given FlowFile. If the Load Balance Strategy is unset or is set to any other value, the Partitioning Attribute has no effect." - }, - "loadBalanceCompression" : { - "type" : "string", - "description" : "Whether or not compression should be used when transferring FlowFiles between nodes", - "enum" : [ "DO_NOT_COMPRESS", "COMPRESS_ATTRIBUTES_ONLY", "COMPRESS_ATTRIBUTES_AND_CONTENT" ] - }, - "componentType" : { - "type" : "string", - "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE" ] - }, - "groupIdentifier" : { - "type" : "string", - "description" : "The ID of the Process Group that this component belongs to" - } - } - }, - "VersionedControllerService" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The component's unique identifier" - }, - "name" : { - "type" : "string", - "description" : "The component's name" - }, - "comments" : { - "type" : "string", - "description" : "The user-supplied comments for the component" - }, - "position" : { - "description" : "The component's position on the graph", - "$ref" : "#/definitions/Position" - }, - "type" : { - "type" : "string", - "description" : "The type of the controller service." - }, - "bundle" : { - "description" : "The details of the artifact that bundled this processor type.", - "$ref" : "#/definitions/Bundle" - }, - "controllerServiceApis" : { - "type" : "array", - "description" : "Lists the APIs this Controller Service implements.", - "items" : { - "$ref" : "#/definitions/ControllerServiceAPI" - } - }, - "properties" : { - "type" : "object", - "description" : "The properties of the controller service.", - "additionalProperties" : { - "type" : "string" - } - }, - "propertyDescriptors" : { - "type" : "object", - "description" : "The property descriptors for the processor.", - "additionalProperties" : { - "$ref" : "#/definitions/VersionedPropertyDescriptor" - } - }, - "annotationData" : { - "type" : "string", - "description" : "The annotation for the controller service. This is how the custom UI relays configuration to the controller service." - }, - "componentType" : { - "type" : "string", - "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE" ] - }, - "groupIdentifier" : { - "type" : "string", - "description" : "The ID of the Process Group that this component belongs to" - } - } - }, - "VersionedFlow" : { - "type" : "object", - "required" : [ "bucketIdentifier", "name", "type" ], - "properties" : { - "link" : { - "description" : "An WebLink to this entity.", - "readOnly" : true, - "$ref" : "#/definitions/JaxbLink" - }, - "identifier" : { - "type" : "string", - "description" : "An ID to uniquely identify this object.", - "readOnly" : true - }, - "name" : { - "type" : "string", - "description" : "The name of the item." - }, - "description" : { - "type" : "string", - "description" : "A description of the item." - }, - "bucketIdentifier" : { - "type" : "string", - "description" : "The identifier of the bucket this items belongs to. This cannot be changed after the item is created." - }, - "bucketName" : { - "type" : "string", - "description" : "The name of the bucket this items belongs to.", - "readOnly" : true - }, - "createdTimestamp" : { - "type" : "integer", - "format" : "int64", - "description" : "The timestamp of when the item was created, as milliseconds since epoch.", - "readOnly" : true, - "minimum" : 1 - }, - "modifiedTimestamp" : { - "type" : "integer", - "format" : "int64", - "description" : "The timestamp of when the item was last modified, as milliseconds since epoch.", - "readOnly" : true, - "minimum" : 1 - }, - "type" : { - "type" : "string", - "description" : "The type of item.", - "enum" : [ "Flow", "Bundle" ] - }, - "permissions" : { - "description" : "The access that the current user has to the bucket containing this item.", - "readOnly" : true, - "$ref" : "#/definitions/Permissions" - }, - "versionCount" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of versions of this flow.", - "readOnly" : true, - "minimum" : 0 - }, - "revision" : { - "description" : "The revision of this entity used for optimistic-locking during updates.", - "readOnly" : true, - "$ref" : "#/definitions/RevisionInfo" - } - } - }, - "VersionedFlowCoordinates" : { - "type" : "object", - "properties" : { - "registryUrl" : { - "type" : "string", - "description" : "The URL of the Flow Registry that contains the flow" - }, - "bucketId" : { - "type" : "string", - "description" : "The UUID of the bucket that the flow resides in" - }, - "flowId" : { - "type" : "string", - "description" : "The UUID of the flow" - }, - "version" : { - "type" : "integer", - "format" : "int32", - "description" : "The version of the flow" - }, - "latest" : { - "type" : "boolean", - "description" : "Whether or not these coordinates point to the latest version of the flow" - } - } - }, - "VersionedFlowDTO" : { - "type" : "object", - "properties" : { - "registryId" : { - "type" : "string", - "description" : "The ID of the registry that the flow is tracked to" - }, - "bucketId" : { - "type" : "string", - "description" : "The ID of the bucket where the flow is stored" - }, - "flowId" : { - "type" : "string", - "description" : "The ID of the flow" - }, - "flowName" : { - "type" : "string", - "description" : "The name of the flow" - }, - "description" : { - "type" : "string", - "description" : "A description of the flow" - }, - "comments" : { - "type" : "string", - "description" : "Comments for the changeset" - }, - "action" : { - "type" : "string", - "description" : "The action being performed", - "enum" : [ "COMMIT", "FORCE_COMMIT" ] - } - } - }, - "VersionedFlowEntity" : { - "type" : "object", - "properties" : { - "versionedFlow" : { - "description" : "The versioned flow", - "$ref" : "#/definitions/VersionedFlowDTO" - } - }, - "xml" : { - "name" : "versionedFlowEntity" - } - }, - "VersionedFlowSnapshot" : { - "type" : "object", - "required" : [ "flowContents", "snapshotMetadata" ], - "properties" : { - "snapshotMetadata" : { - "description" : "The metadata for this snapshot", - "$ref" : "#/definitions/VersionedFlowSnapshotMetadata" - }, - "flowContents" : { - "description" : "The contents of the versioned flow", - "$ref" : "#/definitions/VersionedProcessGroup" - }, - "externalControllerServices" : { - "type" : "object", - "description" : "The information about controller services that exist outside this versioned flow, but are referenced by components within the versioned flow.", - "additionalProperties" : { - "$ref" : "#/definitions/ExternalControllerServiceReference" - } - }, - "parameterContexts" : { - "type" : "object", - "description" : "The parameter contexts referenced by process groups in the flow contents. The mapping is from the name of the context to the context instance, and it is expected that any context in this map is referenced by at least one process group in this flow.", - "additionalProperties" : { - "$ref" : "#/definitions/VersionedParameterContext" - } - }, - "flowEncodingVersion" : { - "type" : "string", - "description" : "The optional encoding version of the flow contents." - }, - "flow" : { - "description" : "The flow this snapshot is for", - "readOnly" : true, - "$ref" : "#/definitions/VersionedFlow" - }, - "bucket" : { - "description" : "The bucket where the flow is located", - "readOnly" : true, - "$ref" : "#/definitions/Bucket" - }, - "latest" : { - "type" : "boolean" - } - } - }, - "VersionedFlowSnapshotEntity" : { - "type" : "object", - "properties" : { - "versionedFlowSnapshot" : { - "description" : "The versioned flow snapshot", - "$ref" : "#/definitions/VersionedFlowSnapshot" - }, - "processGroupRevision" : { - "description" : "The Revision of the Process Group under Version Control", - "$ref" : "#/definitions/RevisionDTO" - }, - "registryId" : { - "type" : "string", - "description" : "The ID of the Registry that this flow belongs to" - }, - "updateDescendantVersionedFlows" : { - "type" : "boolean", - "description" : "If the Process Group to be updated has a child or descendant Process Group that is also under Version Control, this specifies whether or not the contents of that child/descendant Process Group should be updated." - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - } - }, - "xml" : { - "name" : "versionedFlowSnapshotEntity" - } - }, - "VersionedFlowSnapshotMetadata" : { - "type" : "object", - "required" : [ "bucketIdentifier", "flowIdentifier", "version" ], - "properties" : { - "link" : { - "description" : "An WebLink to this entity.", - "readOnly" : true, - "$ref" : "#/definitions/JaxbLink" - }, - "bucketIdentifier" : { - "type" : "string", - "description" : "The identifier of the bucket this snapshot belongs to." - }, - "flowIdentifier" : { - "type" : "string", - "description" : "The identifier of the flow this snapshot belongs to." - }, - "version" : { - "type" : "integer", - "format" : "int32", - "description" : "The version of this snapshot of the flow.", - "minimum" : -1 - }, - "timestamp" : { - "type" : "integer", - "format" : "int64", - "description" : "The timestamp when the flow was saved, as milliseconds since epoch.", - "readOnly" : true, - "minimum" : 1 - }, - "author" : { - "type" : "string", - "description" : "The user that created this snapshot of the flow.", - "readOnly" : true - }, - "comments" : { - "type" : "string", - "description" : "The comments provided by the user when creating the snapshot." - } - } - }, - "VersionedFlowSnapshotMetadataEntity" : { - "type" : "object", - "properties" : { - "versionedFlowSnapshotMetadata" : { - "description" : "The collection of versioned flow snapshot metadata", - "$ref" : "#/definitions/VersionedFlowSnapshotMetadata" - }, - "registryId" : { - "type" : "string", - "description" : "The ID of the Registry that this flow belongs to" - } - }, - "xml" : { - "name" : "versionedFlowSnapshotMetadataEntity" - } - }, - "VersionedFlowSnapshotMetadataSetEntity" : { - "type" : "object", - "properties" : { - "versionedFlowSnapshotMetadataSet" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedFlowSnapshotMetadataEntity" - } - } - }, - "xml" : { - "name" : "versionedFlowSnapshotMetadataSetEntity" - } - }, - "VersionedFlowUpdateRequestDTO" : { - "type" : "object", - "properties" : { - "requestId" : { - "type" : "string", - "description" : "The unique ID of this request.", - "readOnly" : true - }, - "processGroupId" : { - "type" : "string", - "description" : "The unique ID of the Process Group being updated" - }, - "uri" : { - "type" : "string", - "description" : "The URI for future requests to this drop request.", - "readOnly" : true - }, - "lastUpdated" : { - "type" : "string", - "description" : "The last time this request was updated.", - "readOnly" : true - }, - "complete" : { - "type" : "boolean", - "description" : "Whether or not this request has completed", - "readOnly" : true - }, - "failureReason" : { - "type" : "string", - "description" : "An explanation of why this request failed, or null if this request has not failed", - "readOnly" : true - }, - "percentCompleted" : { - "type" : "integer", - "format" : "int32", - "description" : "The percentage complete for the request, between 0 and 100", - "readOnly" : true - }, - "state" : { - "type" : "string", - "description" : "The state of the request", - "readOnly" : true - }, - "versionControlInformation" : { - "description" : "The VersionControlInformation that describes where the Versioned Flow is located; this may not be populated until the request is completed.", - "readOnly" : true, - "$ref" : "#/definitions/VersionControlInformationDTO" - } - } - }, - "VersionedFlowUpdateRequestEntity" : { - "type" : "object", - "properties" : { - "processGroupRevision" : { - "description" : "The revision for the Process Group being updated.", - "$ref" : "#/definitions/RevisionDTO" - }, - "request" : { - "description" : "The Flow Update Request", - "$ref" : "#/definitions/VersionedFlowUpdateRequestDTO" - } - }, - "xml" : { - "name" : "versionedFlowUpdateRequestEntity" - } - }, - "VersionedFlowsEntity" : { - "type" : "object", - "properties" : { - "versionedFlows" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedFlowEntity" - } - } - }, - "xml" : { - "name" : "versionedFlowsEntity" - } - }, - "VersionedFunnel" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The component's unique identifier" - }, - "name" : { - "type" : "string", - "description" : "The component's name" - }, - "comments" : { - "type" : "string", - "description" : "The user-supplied comments for the component" - }, - "position" : { - "description" : "The component's position on the graph", - "$ref" : "#/definitions/Position" - }, - "componentType" : { - "type" : "string", - "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE" ] - }, - "groupIdentifier" : { - "type" : "string", - "description" : "The ID of the Process Group that this component belongs to" - } - } - }, - "VersionedLabel" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The component's unique identifier" - }, - "name" : { - "type" : "string", - "description" : "The component's name" - }, - "comments" : { - "type" : "string", - "description" : "The user-supplied comments for the component" - }, - "position" : { - "description" : "The component's position on the graph", - "$ref" : "#/definitions/Position" - }, - "label" : { - "type" : "string", - "description" : "The text that appears in the label." - }, - "width" : { - "type" : "number", - "format" : "double", - "description" : "The width of the label in pixels when at a 1:1 scale." - }, - "height" : { - "type" : "number", - "format" : "double", - "description" : "The height of the label in pixels when at a 1:1 scale." - }, - "style" : { - "type" : "object", - "description" : "The styles for this label (font-size : 12px, background-color : #eee, etc).", - "additionalProperties" : { - "type" : "string" - } - }, - "componentType" : { - "type" : "string", - "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE" ] - }, - "groupIdentifier" : { - "type" : "string", - "description" : "The ID of the Process Group that this component belongs to" - } - } - }, - "VersionedParameter" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The name of the parameter" - }, - "description" : { - "type" : "string", - "description" : "The description of the param" - }, - "sensitive" : { - "type" : "boolean", - "description" : "Whether or not the parameter value is sensitive" - }, - "value" : { - "type" : "string", - "description" : "The value of the parameter" - } - } - }, - "VersionedParameterContext" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The name of the context" - }, - "description" : { - "type" : "string", - "description" : "The description of the parameter context" - }, - "parameters" : { - "type" : "array", - "description" : "The parameters in the context", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedParameter" - } - } - } - }, - "VersionedPort" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The component's unique identifier" - }, - "name" : { - "type" : "string", - "description" : "The component's name" - }, - "comments" : { - "type" : "string", - "description" : "The user-supplied comments for the component" - }, - "position" : { - "description" : "The component's position on the graph", - "$ref" : "#/definitions/Position" - }, - "type" : { - "type" : "string", - "description" : "The type of port.", - "enum" : [ "INPUT_PORT", "OUTPUT_PORT" ] - }, - "concurrentlySchedulableTaskCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of tasks that should be concurrently scheduled for the port." - }, - "scheduledState" : { - "type" : "string", - "description" : "The scheduled state of the component", - "enum" : [ "ENABLED", "DISABLED" ] - }, - "allowRemoteAccess" : { - "type" : "boolean", - "description" : "Whether or not this port allows remote access for site-to-site" - }, - "componentType" : { - "type" : "string", - "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE" ] - }, - "groupIdentifier" : { - "type" : "string", - "description" : "The ID of the Process Group that this component belongs to" - } - } - }, - "VersionedProcessGroup" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The component's unique identifier" - }, - "name" : { - "type" : "string", - "description" : "The component's name" - }, - "comments" : { - "type" : "string", - "description" : "The user-supplied comments for the component" - }, - "position" : { - "description" : "The component's position on the graph", - "$ref" : "#/definitions/Position" - }, - "processGroups" : { - "type" : "array", - "description" : "The child Process Groups", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedProcessGroup" - } - }, - "remoteProcessGroups" : { - "type" : "array", - "description" : "The Remote Process Groups", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedRemoteProcessGroup" - } - }, - "processors" : { - "type" : "array", - "description" : "The Processors", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedProcessor" - } - }, - "inputPorts" : { - "type" : "array", - "description" : "The Input Ports", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedPort" - } - }, - "outputPorts" : { - "type" : "array", - "description" : "The Output Ports", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedPort" - } - }, - "connections" : { - "type" : "array", - "description" : "The Connections", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedConnection" - } - }, - "labels" : { - "type" : "array", - "description" : "The Labels", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedLabel" - } - }, - "funnels" : { - "type" : "array", - "description" : "The Funnels", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedFunnel" - } - }, - "controllerServices" : { - "type" : "array", - "description" : "The Controller Services", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedControllerService" - } - }, - "versionedFlowCoordinates" : { - "description" : "The coordinates where the remote flow is stored, or null if the Process Group is not directly under Version Control", - "$ref" : "#/definitions/VersionedFlowCoordinates" - }, - "variables" : { - "type" : "object", - "description" : "The Variables in the Variable Registry for this Process Group (not including any ancestor or descendant Process Groups)", - "additionalProperties" : { - "type" : "string" - } - }, - "parameterContextName" : { - "type" : "string", - "description" : "The name of the parameter context used by this process group" - }, - "flowFileConcurrency" : { - "type" : "string", - "description" : "The configured FlowFile Concurrency for the Process Group" - }, - "flowFileOutboundPolicy" : { - "type" : "string", - "description" : "The FlowFile Outbound Policy for the Process Group" - }, - "componentType" : { - "type" : "string", - "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE" ] - }, - "groupIdentifier" : { - "type" : "string", - "description" : "The ID of the Process Group that this component belongs to" - } - } - }, - "VersionedProcessor" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The component's unique identifier" - }, - "name" : { - "type" : "string", - "description" : "The component's name" - }, - "comments" : { - "type" : "string", - "description" : "The user-supplied comments for the component" - }, - "position" : { - "description" : "The component's position on the graph", - "$ref" : "#/definitions/Position" - }, - "bundle" : { - "description" : "Information about the bundle from which the component came", - "$ref" : "#/definitions/Bundle" - }, - "style" : { - "type" : "object", - "description" : "Stylistic data for rendering in a UI", - "additionalProperties" : { - "type" : "string" - } - }, - "type" : { - "type" : "string", - "description" : "The type of Processor" - }, - "properties" : { - "type" : "object", - "description" : "The properties for the processor. Properties whose value is not set will only contain the property name.", - "additionalProperties" : { - "type" : "string" - } - }, - "propertyDescriptors" : { - "type" : "object", - "description" : "The property descriptors for the processor.", - "additionalProperties" : { - "$ref" : "#/definitions/VersionedPropertyDescriptor" - } - }, - "annotationData" : { - "type" : "string", - "description" : "The annotation data for the processor used to relay configuration between a custom UI and the procesosr." - }, - "schedulingPeriod" : { - "type" : "string", - "description" : "The frequency with which to schedule the processor. The format of the value will depend on th value of schedulingStrategy." - }, - "schedulingStrategy" : { - "type" : "string", - "description" : "Indcates whether the prcessor should be scheduled to run in event or timer driven mode." - }, - "executionNode" : { - "type" : "string", - "description" : "Indicates the node where the process will execute." - }, - "penaltyDuration" : { - "type" : "string", - "description" : "The amout of time that is used when the process penalizes a flowfile." - }, - "yieldDuration" : { - "type" : "string", - "description" : "The amount of time that must elapse before this processor is scheduled again after yielding." - }, - "bulletinLevel" : { - "type" : "string", - "description" : "The level at which the processor will report bulletins." - }, - "runDurationMillis" : { - "type" : "integer", - "format" : "int64", - "description" : "The run duration for the processor in milliseconds." - }, - "concurrentlySchedulableTaskCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of tasks that should be concurrently schedule for the processor. If the processor doesn't allow parallol processing then any positive input will be ignored." - }, - "autoTerminatedRelationships" : { - "type" : "array", - "description" : "The names of all relationships that cause a flow file to be terminated if the relationship is not connected elsewhere. This property differs from the 'isAutoTerminate' property of the RelationshipDTO in that the RelationshipDTO is meant to depict the current configuration, whereas this property can be set in a DTO when updating a Processor in order to change which Relationships should be auto-terminated.", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - }, - "scheduledState" : { - "type" : "string", - "description" : "The scheduled state of the component", - "enum" : [ "ENABLED", "DISABLED" ] - }, - "componentType" : { - "type" : "string", - "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE" ] - }, - "groupIdentifier" : { - "type" : "string", - "description" : "The ID of the Process Group that this component belongs to" - } - } - }, - "VersionedPropertyDescriptor" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The name of the property" - }, - "displayName" : { - "type" : "string", - "description" : "The display name of the property" - }, - "identifiesControllerService" : { - "type" : "boolean", - "description" : "Whether or not the property provides the identifier of a Controller Service" - }, - "sensitive" : { - "type" : "boolean", - "description" : "Whether or not the property is considered sensitive" - } - } - }, - "VersionedRemoteGroupPort" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The component's unique identifier" - }, - "name" : { - "type" : "string", - "description" : "The component's name" - }, - "comments" : { - "type" : "string", - "description" : "The user-supplied comments for the component" - }, - "position" : { - "description" : "The component's position on the graph", - "$ref" : "#/definitions/Position" - }, - "remoteGroupId" : { - "type" : "string", - "description" : "The id of the remote process group that the port resides in." - }, - "concurrentlySchedulableTaskCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of task that may transmit flowfiles to the target port concurrently." - }, - "useCompression" : { - "type" : "boolean", - "description" : "Whether the flowfiles are compressed when sent to the target port." - }, - "batchSize" : { - "description" : "The batch settings for data transmission.", - "$ref" : "#/definitions/BatchSize" - }, - "componentType" : { - "type" : "string", - "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE" ] - }, - "targetId" : { - "type" : "string", - "description" : "The ID of the port on the target NiFi instance" - }, - "scheduledState" : { - "type" : "string", - "description" : "The scheduled state of the component", - "enum" : [ "ENABLED", "DISABLED" ] - }, - "groupIdentifier" : { - "type" : "string", - "description" : "The ID of the Process Group that this component belongs to" - } - } - }, - "VersionedRemoteProcessGroup" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The component's unique identifier" - }, - "name" : { - "type" : "string", - "description" : "The component's name" - }, - "comments" : { - "type" : "string", - "description" : "The user-supplied comments for the component" - }, - "position" : { - "description" : "The component's position on the graph", - "$ref" : "#/definitions/Position" - }, - "targetUri" : { - "type" : "string", - "description" : "[DEPRECATED] The target URI of the remote process group. If target uri is not set, but uris are set, then returns the first uri in the uris. If neither target uri nor uris are set, then returns null." - }, - "targetUris" : { - "type" : "string", - "description" : "The target URIs of the remote process group. If target uris is not set but target uri is set, then returns the single target uri. If neither target uris nor target uri is set, then returns null." - }, - "communicationsTimeout" : { - "type" : "string", - "description" : "The time period used for the timeout when communicating with the target." - }, - "yieldDuration" : { - "type" : "string", - "description" : "When yielding, this amount of time must elapse before the remote process group is scheduled again." - }, - "transportProtocol" : { - "type" : "string", - "description" : "The Transport Protocol that is used for Site-to-Site communications", - "enum" : [ "RAW", "HTTP" ] - }, - "localNetworkInterface" : { - "type" : "string", - "description" : "The local network interface to send/receive data. If not specified, any local address is used. If clustered, all nodes must have an interface with this identifier." - }, - "proxyHost" : { - "type" : "string" - }, - "proxyPort" : { - "type" : "integer", - "format" : "int32" - }, - "proxyUser" : { - "type" : "string" - }, - "inputPorts" : { - "type" : "array", - "description" : "A Set of Input Ports that can be connected to, in order to send data to the remote NiFi instance", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedRemoteGroupPort" - } - }, - "outputPorts" : { - "type" : "array", - "description" : "A Set of Output Ports that can be connected to, in order to pull data from the remote NiFi instance", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedRemoteGroupPort" - } - }, - "componentType" : { - "type" : "string", - "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE" ] - }, - "groupIdentifier" : { - "type" : "string", - "description" : "The ID of the Process Group that this component belongs to" - } - } - } - } -} diff --git a/resources/client_gen/api_defs/nifi-1.15.0.json b/resources/client_gen/api_defs/nifi-1.15.0.json deleted file mode 100644 index 3fe11831..00000000 --- a/resources/client_gen/api_defs/nifi-1.15.0.json +++ /dev/null @@ -1,23027 +0,0 @@ -{ - "swagger" : "2.0", - "info" : { - "description" : "The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and\n stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description,\n definitions of the expected input and output, potential response codes, and the authorizations required\n to invoke each service.", - "version" : "1.15.0", - "title" : "NiFi Rest API", - "contact" : { - "url" : "https://nifi.apache.org", - "email" : "dev@nifi.apache.org" - }, - "license" : { - "name" : "Apache 2.0", - "url" : "http://www.apache.org/licenses/LICENSE-2.0.html" - } - }, - "basePath" : "/nifi-api", - "tags" : [ { - "name" : "access", - "description" : "Endpoints for obtaining an access token or checking access status." - }, { - "name" : "accessoidc", - "description" : "Endpoints for obtaining an access token or checking access status." - }, { - "name" : "accesssaml", - "description" : "Endpoints for authenticating, obtaining an access token or logging out of a configured SAML authentication provider." - }, { - "name" : "connections", - "description" : "Endpoint for managing a Connection." - }, { - "name" : "controller", - "description" : "Provides realtime command and control of this NiFi instance" - }, { - "name" : "controller-services", - "description" : "Endpoint for managing a Controller Service." - }, { - "name" : "counters", - "description" : "Endpoint for managing counters." - }, { - "name" : "data-transfer", - "description" : "Supports data transfers with this NiFi using HTTP based site to site" - }, { - "name" : "flow", - "description" : "Endpoint for accessing the flow structure and component status." - }, { - "name" : "flowfile-queues", - "description" : "Endpoint for managing a FlowFile Queue." - }, { - "name" : "funnel", - "description" : "Endpoint for managing a Funnel." - }, { - "name" : "input-ports", - "description" : "Endpoint for managing an Input Port." - }, { - "name" : "labels", - "description" : "Endpoint for managing a Label." - }, { - "name" : "output-ports", - "description" : "Endpoint for managing an Output Port." - }, { - "name" : "parameter-contexts", - "description" : "Endpoint for managing version control for a flow" - }, { - "name" : "policies", - "description" : "Endpoint for managing access policies." - }, { - "name" : "process-groups", - "description" : "Endpoint for managing a Process Group." - }, { - "name" : "processors", - "description" : "Endpoint for managing a Processor." - }, { - "name" : "provenance", - "description" : "Endpoint for accessing data flow provenance." - }, { - "name" : "provenance-events", - "description" : "Endpoint for accessing data flow provenance." - }, { - "name" : "remote-process-groups", - "description" : "Endpoint for managing a Remote Process Group." - }, { - "name" : "reporting-tasks", - "description" : "Endpoint for managing a Reporting Task." - }, { - "name" : "resources", - "description" : "Provides the resources in this NiFi that can have access/authorization policies." - }, { - "name" : "site-to-site", - "description" : "Provide access to site to site with this NiFi" - }, { - "name" : "snippets", - "description" : "Endpoint for accessing dataflow snippets." - }, { - "name" : "system-diagnostics", - "description" : "Endpoint for accessing system diagnostics." - }, { - "name" : "templates", - "description" : "Endpoint for managing a Template." - }, { - "name" : "tenants", - "description" : "Endpoint for managing users and user groups." - }, { - "name" : "versions", - "description" : "Endpoint for managing version control for a flow" - } ], - "schemes" : [ "http", "https" ], - "paths" : { - "/access" : { - "get" : { - "tags" : [ "access" ], - "summary" : "Gets the status the client's access", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getAccessStatus", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/AccessStatusEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Unable to determine access status because the client could not be authenticated." - }, - "403" : { - "description" : "Unable to determine access status because the client is not authorized to make this request." - }, - "409" : { - "description" : "Unable to determine access status because NiFi is not in the appropriate state." - }, - "500" : { - "description" : "Unable to determine access status because an unexpected error occurred." - } - } - } - }, - "/access/config" : { - "get" : { - "tags" : [ "access" ], - "summary" : "Retrieves the access configuration for this NiFi", - "description" : "", - "operationId" : "getLoginConfig", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/AccessConfigurationEntity" - } - } - } - } - }, - "/access/kerberos" : { - "post" : { - "tags" : [ "access" ], - "summary" : "Creates a token for accessing the REST API via Kerberos ticket exchange / SPNEGO negotiation", - "description" : "The token returned is formatted as a JSON Web Token (JWT). The token is base64 encoded and comprised of three parts. The header, the body, and the signature. The expiration of the token is a contained within the body. The token can be used in the Authorization header in the format 'Authorization: Bearer '. It is also stored in the browser as a cookie.", - "operationId" : "createAccessTokenFromTicket", - "consumes" : [ "text/plain" ], - "produces" : [ "text/plain" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "NiFi was unable to complete the request because it did not contain a valid Kerberos ticket in the Authorization header. Retry this request after initializing a ticket with kinit and ensuring your browser is configured to support SPNEGO." - }, - "409" : { - "description" : "Unable to create access token because NiFi is not in the appropriate state. (i.e. may not be configured to support Kerberos login." - }, - "500" : { - "description" : "Unable to create access token because an unexpected error occurred." - } - } - } - }, - "/access/knox/callback" : { - "get" : { - "tags" : [ "access" ], - "summary" : "Redirect/callback URI for processing the result of the Apache Knox login sequence.", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "knoxCallback", - "consumes" : [ "*/*" ], - "produces" : [ "*/*" ], - "responses" : { - "default" : { - "description" : "successful operation" - } - } - } - }, - "/access/knox/logout" : { - "get" : { - "tags" : [ "access" ], - "summary" : "Performs a logout in the Apache Knox.", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "knoxLogout", - "consumes" : [ "*/*" ], - "produces" : [ "*/*" ], - "responses" : { - "default" : { - "description" : "successful operation" - } - } - } - }, - "/access/knox/request" : { - "get" : { - "tags" : [ "access" ], - "summary" : "Initiates a request to authenticate through Apache Knox.", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "knoxRequest", - "consumes" : [ "*/*" ], - "produces" : [ "*/*" ], - "responses" : { - "default" : { - "description" : "successful operation" - } - } - } - }, - "/access/logout" : { - "delete" : { - "tags" : [ "access" ], - "summary" : "Performs a logout for other providers that have been issued a JWT.", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "logOut", - "consumes" : [ "*/*" ], - "produces" : [ "*/*" ], - "responses" : { - "200" : { - "description" : "User was logged out successfully." - }, - "401" : { - "description" : "Authentication token provided was empty or not in the correct JWT format." - }, - "500" : { - "description" : "Client failed to log out." - } - } - } - }, - "/access/logout/complete" : { - "get" : { - "tags" : [ "access" ], - "summary" : "Completes the logout sequence by removing the cached Logout Request and Cookie if they existed and redirects to /nifi/login.", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "logOutComplete", - "consumes" : [ "*/*" ], - "produces" : [ "*/*" ], - "responses" : { - "200" : { - "description" : "User was logged out successfully." - }, - "401" : { - "description" : "Authentication token provided was empty or not in the correct JWT format." - }, - "500" : { - "description" : "Client failed to log out." - } - } - } - }, - "/access/oidc/callback" : { - "get" : { - "tags" : [ "accessoidc" ], - "summary" : "Redirect/callback URI for processing the result of the OpenId Connect login sequence.", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "oidcCallback", - "consumes" : [ "*/*" ], - "produces" : [ "*/*" ], - "responses" : { - "default" : { - "description" : "successful operation" - } - } - } - }, - "/access/oidc/exchange" : { - "post" : { - "tags" : [ "accessoidc" ], - "summary" : "Retrieves a JWT following a successful login sequence using the configured OpenId Connect provider.", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "oidcExchange", - "consumes" : [ "*/*" ], - "produces" : [ "text/plain" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - } - } - } - }, - "/access/oidc/logout" : { - "get" : { - "tags" : [ "accessoidc" ], - "summary" : "Performs a logout in the OpenId Provider.", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "oidcLogout", - "consumes" : [ "*/*" ], - "produces" : [ "*/*" ], - "responses" : { - "default" : { - "description" : "successful operation" - } - } - } - }, - "/access/oidc/logoutCallback" : { - "get" : { - "tags" : [ "accessoidc" ], - "summary" : "Redirect/callback URI for processing the result of the OpenId Connect logout sequence.", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "oidcLogoutCallback", - "consumes" : [ "*/*" ], - "produces" : [ "*/*" ], - "responses" : { - "default" : { - "description" : "successful operation" - } - } - } - }, - "/access/oidc/request" : { - "get" : { - "tags" : [ "accessoidc" ], - "summary" : "Initiates a request to authenticate through the configured OpenId Connect provider.", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "oidcRequest", - "consumes" : [ "*/*" ], - "produces" : [ "*/*" ], - "responses" : { - "default" : { - "description" : "successful operation" - } - } - } - }, - "/access/saml/local-logout" : { - "get" : { - "tags" : [ "accesssaml" ], - "summary" : "Local logout when SAML is enabled, does not communicate with the IDP.", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "samlLocalLogout", - "consumes" : [ "*/*" ], - "produces" : [ "*/*" ], - "responses" : { - "default" : { - "description" : "successful operation" - } - } - } - }, - "/access/saml/login/consumer" : { - "get" : { - "tags" : [ "accesssaml" ], - "summary" : "Processes the SSO response from the SAML identity provider for HTTP-REDIRECT binding.", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "samlLoginHttpRedirectConsumer", - "consumes" : [ "*/*" ], - "produces" : [ "*/*" ], - "responses" : { - "default" : { - "description" : "successful operation" - } - } - }, - "post" : { - "tags" : [ "accesssaml" ], - "summary" : "Processes the SSO response from the SAML identity provider for HTTP-POST binding.", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "samlLoginHttpPostConsumer", - "consumes" : [ "application/x-www-form-urlencoded" ], - "produces" : [ "*/*" ], - "responses" : { - "default" : { - "description" : "successful operation" - } - } - } - }, - "/access/saml/login/exchange" : { - "post" : { - "tags" : [ "accesssaml" ], - "summary" : "Retrieves a JWT following a successful login sequence using the configured SAML identity provider.", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "samlLoginExchange", - "consumes" : [ "*/*" ], - "produces" : [ "text/plain" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - } - } - } - }, - "/access/saml/login/request" : { - "get" : { - "tags" : [ "accesssaml" ], - "summary" : "Initiates an SSO request to the configured SAML identity provider.", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "samlLoginRequest", - "consumes" : [ "*/*" ], - "produces" : [ "*/*" ], - "responses" : { - "default" : { - "description" : "successful operation" - } - } - } - }, - "/access/saml/metadata" : { - "get" : { - "tags" : [ "accesssaml" ], - "summary" : "Retrieves the service provider metadata.", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "samlMetadata", - "consumes" : [ "*/*" ], - "produces" : [ "application/samlmetadata+xml" ], - "responses" : { - "default" : { - "description" : "successful operation" - } - } - } - }, - "/access/saml/single-logout/consumer" : { - "get" : { - "tags" : [ "accesssaml" ], - "summary" : "Processes a SingleLogout message from the configured SAML identity provider using the HTTP-REDIRECT binding.", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "samlSingleLogoutHttpRedirectConsumer", - "consumes" : [ "*/*" ], - "produces" : [ "*/*" ], - "responses" : { - "default" : { - "description" : "successful operation" - } - } - }, - "post" : { - "tags" : [ "accesssaml" ], - "summary" : "Processes a SingleLogout message from the configured SAML identity provider using the HTTP-POST binding.", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "samlSingleLogoutHttpPostConsumer", - "consumes" : [ "*/*" ], - "produces" : [ "*/*" ], - "responses" : { - "default" : { - "description" : "successful operation" - } - } - } - }, - "/access/saml/single-logout/request" : { - "get" : { - "tags" : [ "accesssaml" ], - "summary" : "Initiates a logout request using the SingleLogout service of the configured SAML identity provider.", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "samlSingleLogoutRequest", - "consumes" : [ "*/*" ], - "produces" : [ "*/*" ], - "responses" : { - "default" : { - "description" : "successful operation" - } - } - } - }, - "/access/token" : { - "post" : { - "tags" : [ "access" ], - "summary" : "Creates a token for accessing the REST API via username/password", - "description" : "The token returned is formatted as a JSON Web Token (JWT). The token is base64 encoded and comprised of three parts. The header, the body, and the signature. The expiration of the token is a contained within the body. 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", - "consumes" : [ "application/x-www-form-urlencoded" ], - "produces" : [ "text/plain" ], - "parameters" : [ { - "name" : "username", - "in" : "formData", - "required" : false, - "type" : "string" - }, { - "name" : "password", - "in" : "formData", - "required" : false, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "Unable to create access token because NiFi is not in the appropriate state. (i.e. may not be configured to support username/password login." - }, - "500" : { - "description" : "Unable to create access token because an unexpected error occurred." - } - } - } - }, - "/connections/{id}" : { - "get" : { - "tags" : [ "connections" ], - "summary" : "Gets a connection", - "description" : "", - "operationId" : "getConnection", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The connection id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ConnectionEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read Source - /{component-type}/{uuid}" : [ ] - }, { - "Read Destination - /{component-type}/{uuid}" : [ ] - } ] - }, - "put" : { - "tags" : [ "connections" ], - "summary" : "Updates a connection", - "description" : "", - "operationId" : "updateConnection", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The connection id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The connection configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ConnectionEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ConnectionEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write Source - /{component-type}/{uuid}" : [ ] - }, { - "Write Destination - /{component-type}/{uuid}" : [ ] - }, { - "Write New Destination - /{component-type}/{uuid} - if updating Destination" : [ ] - }, { - "Write Process Group - /process-groups/{uuid} - if updating Destination" : [ ] - } ] - }, - "delete" : { - "tags" : [ "connections" ], - "summary" : "Deletes a connection", - "description" : "", - "operationId" : "deleteConnection", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The revision is used to verify the client is working with the latest version of the flow.", - "required" : false, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The connection id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ConnectionEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write Source - /{component-type}/{uuid}" : [ ] - }, { - "Write - Parent Process Group - /process-groups/{uuid}" : [ ] - }, { - "Write Destination - /{component-type}/{uuid}" : [ ] - } ] - } - }, - "/controller-services/{id}" : { - "get" : { - "tags" : [ "controller-services" ], - "summary" : "Gets a controller service", - "description" : "", - "operationId" : "getControllerService", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The controller service id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ControllerServiceEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /controller-services/{uuid}" : [ ] - } ] - }, - "put" : { - "tags" : [ "controller-services" ], - "summary" : "Updates a controller service", - "description" : "", - "operationId" : "updateControllerService", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The controller service id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The controller service configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ControllerServiceEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ControllerServiceEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /controller-services/{uuid}" : [ ] - }, { - "Read - any referenced Controller Services if this request changes the reference - /controller-services/{uuid}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "controller-services" ], - "summary" : "Deletes a controller service", - "description" : "", - "operationId" : "removeControllerService", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The revision is used to verify the client is working with the latest version of the flow.", - "required" : false, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The controller service id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ControllerServiceEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /controller-services/{uuid}" : [ ] - }, { - "Write - Parent Process Group if scoped by Process Group - /process-groups/{uuid}" : [ ] - }, { - "Write - Controller if scoped by Controller - /controller" : [ ] - }, { - "Read - any referenced Controller Services - /controller-services/{uuid}" : [ ] - } ] - } - }, - "/controller-services/{id}/config/analysis" : { - "post" : { - "tags" : [ "controller-services" ], - "summary" : "Performs analysis of the component's configuration, providing information about which attributes are referenced.", - "description" : "", - "operationId" : "analyzeConfiguration", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The controller service id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The configuration analysis request.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ConfigurationAnalysisEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/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. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /controller-services/{uuid}" : [ ] - } ] - } - }, - "/controller-services/{id}/config/verification-requests" : { - "post" : { - "tags" : [ "controller-services" ], - "summary" : "Performs verification of the Controller Service's configuration", - "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", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The controller service id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The controller service configuration verification request.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/VerifyConfigRequestEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/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. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /controller-services/{uuid}" : [ ] - } ] - } - }, - "/controller-services/{id}/config/verification-requests/{requestId}" : { - "get" : { - "tags" : [ "controller-services" ], - "summary" : "Returns the Verification Request with the given ID", - "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", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The ID of the Controller Service", - "required" : true, - "type" : "string" - }, { - "name" : "requestId", - "in" : "path", - "description" : "The ID of the Verification Request", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/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. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Only the user that submitted the request can get it" : [ ] - } ] - }, - "delete" : { - "tags" : [ "controller-services" ], - "summary" : "Deletes the Verification Request with the given ID", - "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" : "deleteValidationRequest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The ID of the Controller Service", - "required" : true, - "type" : "string" - }, { - "name" : "requestId", - "in" : "path", - "description" : "The ID of the Verification Request", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/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. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Only the user that submitted the request can remove it" : [ ] - } ] - } - }, - "/controller-services/{id}/descriptors" : { - "get" : { - "tags" : [ "controller-services" ], - "summary" : "Gets a controller service property descriptor", - "description" : "", - "operationId" : "getPropertyDescriptor", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The controller service id.", - "required" : true, - "type" : "string" - }, { - "name" : "propertyName", - "in" : "query", - "description" : "The property name to return the descriptor for.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/PropertyDescriptorEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /controller-services/{uuid}" : [ ] - } ] - } - }, - "/controller-services/{id}/references" : { - "get" : { - "tags" : [ "controller-services" ], - "summary" : "Gets a controller service", - "description" : "", - "operationId" : "getControllerServiceReferences", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The controller service id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ControllerServiceReferencingComponentsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /controller-services/{uuid}" : [ ] - } ] - }, - "put" : { - "tags" : [ "controller-services" ], - "summary" : "Updates a controller services references", - "description" : "", - "operationId" : "updateControllerServiceReferences", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The controller service id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The controller service request update request.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/UpdateControllerServiceReferenceRequestEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ControllerServiceReferencingComponentsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /{component-type}/{uuid} or /operate/{component-type}/{uuid} - For each referencing component specified" : [ ] - } ] - } - }, - "/controller-services/{id}/run-status" : { - "put" : { - "tags" : [ "controller-services" ], - "summary" : "Updates run status of a controller service", - "description" : "", - "operationId" : "updateRunStatus", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The controller service id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The controller service run status.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ControllerServiceRunStatusEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ControllerServiceEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /controller-services/{uuid} or /operation/controller-services/{uuid}" : [ ] - } ] - } - }, - "/controller-services/{id}/state" : { - "get" : { - "tags" : [ "controller-services" ], - "summary" : "Gets the state for a controller service", - "description" : "", - "operationId" : "getState", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The controller service id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ComponentStateEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /controller-services/{uuid}" : [ ] - } ] - } - }, - "/controller-services/{id}/state/clear-requests" : { - "post" : { - "tags" : [ "controller-services" ], - "summary" : "Clears the state for a controller service", - "description" : "", - "operationId" : "clearState", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The controller service id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ComponentStateEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /controller-services/{uuid}" : [ ] - } ] - } - }, - "/controller/bulletin" : { - "post" : { - "tags" : [ "controller" ], - "summary" : "Creates a new bulletin", - "description" : "", - "operationId" : "createBulletin", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The reporting task configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/BulletinEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /controller" : [ ] - } ] - } - }, - "/controller/cluster" : { - "get" : { - "tags" : [ "controller" ], - "summary" : "Gets the contents of the cluster", - "description" : "Returns the contents of the cluster including all nodes and their status.", - "operationId" : "getCluster", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ClusterEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /controller" : [ ] - } ] - } - }, - "/controller/cluster/nodes/{id}" : { - "get" : { - "tags" : [ "controller" ], - "summary" : "Gets a node in the cluster", - "description" : "", - "operationId" : "getNode", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The node id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/NodeEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /controller" : [ ] - } ] - }, - "put" : { - "tags" : [ "controller" ], - "summary" : "Updates a node in the cluster", - "description" : "", - "operationId" : "updateNode", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The node id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The node configuration. The only configuration that will be honored at this endpoint is the status.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/NodeEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/NodeEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /controller" : [ ] - } ] - }, - "delete" : { - "tags" : [ "controller" ], - "summary" : "Removes a node from the cluster", - "description" : "", - "operationId" : "deleteNode", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The node id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/NodeEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /controller" : [ ] - } ] - } - }, - "/controller/config" : { - "get" : { - "tags" : [ "controller" ], - "summary" : "Retrieves the configuration for this NiFi Controller", - "description" : "", - "operationId" : "getControllerConfig", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ControllerConfigurationEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /controller" : [ ] - } ] - }, - "put" : { - "tags" : [ "controller" ], - "summary" : "Retrieves the configuration for this NiFi", - "description" : "", - "operationId" : "updateControllerConfig", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The controller configuration.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ControllerConfigurationEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ControllerConfigurationEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /controller" : [ ] - } ] - } - }, - "/controller/controller-services" : { - "post" : { - "tags" : [ "controller" ], - "summary" : "Creates a new controller service", - "description" : "", - "operationId" : "createControllerService", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The controller service configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ControllerServiceEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ControllerServiceEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /controller" : [ ] - }, { - "Read - any referenced Controller Services - /controller-services/{uuid}" : [ ] - }, { - "Write - if the Controller Service is restricted - /restricted-components" : [ ] - } ] - } - }, - "/controller/history" : { - "delete" : { - "tags" : [ "controller" ], - "summary" : "Purges history", - "description" : "", - "operationId" : "deleteHistory", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "endDate", - "in" : "query", - "description" : "Purge actions before this date/time.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/HistoryEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /controller" : [ ] - } ] - } - }, - "/controller/registry-clients" : { - "get" : { - "tags" : [ "controller" ], - "summary" : "Gets the listing of available registry clients", - "description" : "", - "operationId" : "getRegistryClients", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/RegistryClientsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - }, - "post" : { - "tags" : [ "controller" ], - "summary" : "Creates a new registry client", - "description" : "", - "operationId" : "createRegistryClient", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The registry configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/RegistryClientEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/RegistryClientEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /controller" : [ ] - } ] - } - }, - "/controller/registry-clients/{id}" : { - "get" : { - "tags" : [ "controller" ], - "summary" : "Gets a registry client", - "description" : "", - "operationId" : "getRegistryClient", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The registry id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/RegistryClientEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /controller" : [ ] - } ] - }, - "put" : { - "tags" : [ "controller" ], - "summary" : "Updates a registry client", - "description" : "", - "operationId" : "updateRegistryClient", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The registry id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The registry configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/RegistryClientEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/RegistryClientEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /controller" : [ ] - } ] - }, - "delete" : { - "tags" : [ "controller" ], - "summary" : "Deletes a registry client", - "description" : "", - "operationId" : "deleteRegistryClient", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The revision is used to verify the client is working with the latest version of the flow.", - "required" : false, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The registry id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/RegistryClientEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /controller" : [ ] - } ] - } - }, - "/controller/reporting-tasks" : { - "post" : { - "tags" : [ "controller" ], - "summary" : "Creates a new reporting task", - "description" : "", - "operationId" : "createReportingTask", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The reporting task configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ReportingTaskEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ReportingTaskEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /controller" : [ ] - }, { - "Read - any referenced Controller Services - /controller-services/{uuid}" : [ ] - }, { - "Write - if the Reporting Task is restricted - /restricted-components" : [ ] - } ] - } - }, - "/controller/status/history" : { - "get" : { - "tags" : [ "controller" ], - "summary" : "Gets status history for the node", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getNodeStatusHistory", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ComponentHistoryEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /controller" : [ ] - } ] - } - }, - "/counters" : { - "get" : { - "tags" : [ "counters" ], - "summary" : "Gets the current counters for this NiFi", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getCounters", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "nodewise", - "in" : "query", - "description" : "Whether or not to include the breakdown per node. Optional, defaults to false", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "clusterNodeId", - "in" : "query", - "description" : "The id of the node where to get the status.", - "required" : false, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/CountersEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /counters" : [ ] - } ] - } - }, - "/counters/{id}" : { - "put" : { - "tags" : [ "counters" ], - "summary" : "Updates the specified counter. This will reset the counter value to 0", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "updateCounter", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The id of the counter.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/CounterEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /counters" : [ ] - } ] - } - }, - "/data-transfer/input-ports/{portId}/transactions/{transactionId}" : { - "put" : { - "tags" : [ "data-transfer" ], - "summary" : "Extend transaction TTL", - "description" : "", - "operationId" : "extendInputPortTransactionTTL", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "portId", - "in" : "path", - "required" : true, - "type" : "string" - }, { - "name" : "transactionId", - "in" : "path", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/TransactionResultEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /data-transfer/input-ports/{uuid}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "data-transfer" ], - "summary" : "Commit or cancel the specified transaction", - "description" : "", - "operationId" : "commitInputPortTransaction", - "consumes" : [ "application/octet-stream" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "responseCode", - "in" : "query", - "description" : "The response code. Available values are BAD_CHECKSUM(19), CONFIRM_TRANSACTION(12) or CANCEL_TRANSACTION(15).", - "required" : true, - "type" : "integer", - "format" : "int32" - }, { - "name" : "portId", - "in" : "path", - "description" : "The input port id.", - "required" : true, - "type" : "string" - }, { - "name" : "transactionId", - "in" : "path", - "description" : "The transaction id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/TransactionResultEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - }, - "503" : { - "description" : "NiFi instance is not ready for serving request, or temporarily overloaded. Retrying the same request later may be successful" - } - }, - "security" : [ { - "Write - /data-transfer/input-ports/{uuid}" : [ ] - } ] - } - }, - "/data-transfer/input-ports/{portId}/transactions/{transactionId}/flow-files" : { - "post" : { - "tags" : [ "data-transfer" ], - "summary" : "Transfer flow files to the input port", - "description" : "", - "operationId" : "receiveFlowFiles", - "consumes" : [ "application/octet-stream" ], - "produces" : [ "text/plain" ], - "parameters" : [ { - "name" : "portId", - "in" : "path", - "description" : "The input port id.", - "required" : true, - "type" : "string" - }, { - "name" : "transactionId", - "in" : "path", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - }, - "503" : { - "description" : "NiFi instance is not ready for serving request, or temporarily overloaded. Retrying the same request later may be successful" - } - }, - "security" : [ { - "Write - /data-transfer/input-ports/{uuid}" : [ ] - } ] - } - }, - "/data-transfer/output-ports/{portId}/transactions/{transactionId}" : { - "put" : { - "tags" : [ "data-transfer" ], - "summary" : "Extend transaction TTL", - "description" : "", - "operationId" : "extendOutputPortTransactionTTL", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "portId", - "in" : "path", - "required" : true, - "type" : "string" - }, { - "name" : "transactionId", - "in" : "path", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/TransactionResultEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - }, - "503" : { - "description" : "NiFi instance is not ready for serving request, or temporarily overloaded. Retrying the same request later may be successful" - } - }, - "security" : [ { - "Write - /data-transfer/output-ports/{uuid}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "data-transfer" ], - "summary" : "Commit or cancel the specified transaction", - "description" : "", - "operationId" : "commitOutputPortTransaction", - "consumes" : [ "application/octet-stream" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "responseCode", - "in" : "query", - "description" : "The response code. Available values are CONFIRM_TRANSACTION(12) or CANCEL_TRANSACTION(15).", - "required" : true, - "type" : "integer", - "format" : "int32" - }, { - "name" : "checksum", - "in" : "query", - "description" : "A checksum calculated at client side using CRC32 to check flow file content integrity. It must match with the value calculated at server side.", - "required" : true, - "type" : "string" - }, { - "name" : "portId", - "in" : "path", - "description" : "The output port id.", - "required" : true, - "type" : "string" - }, { - "name" : "transactionId", - "in" : "path", - "description" : "The transaction id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/TransactionResultEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - }, - "503" : { - "description" : "NiFi instance is not ready for serving request, or temporarily overloaded. Retrying the same request later may be successful" - } - }, - "security" : [ { - "Write - /data-transfer/output-ports/{uuid}" : [ ] - } ] - } - }, - "/data-transfer/output-ports/{portId}/transactions/{transactionId}/flow-files" : { - "get" : { - "tags" : [ "data-transfer" ], - "summary" : "Transfer flow files from the output port", - "description" : "", - "operationId" : "transferFlowFiles", - "consumes" : [ "*/*" ], - "produces" : [ "application/octet-stream" ], - "parameters" : [ { - "name" : "portId", - "in" : "path", - "description" : "The output port id.", - "required" : true, - "type" : "string" - }, { - "name" : "transactionId", - "in" : "path", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "There is no flow file to return.", - "schema" : { - "$ref" : "#/definitions/StreamingOutput" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - }, - "503" : { - "description" : "NiFi instance is not ready for serving request, or temporarily overloaded. Retrying the same request later may be successful" - } - }, - "security" : [ { - "Write - /data-transfer/output-ports/{uuid}" : [ ] - } ] - } - }, - "/data-transfer/{portType}/{portId}/transactions" : { - "post" : { - "tags" : [ "data-transfer" ], - "summary" : "Create a transaction to the specified output port or input port", - "description" : "", - "operationId" : "createPortTransaction", - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "portType", - "in" : "path", - "description" : "The port type.", - "required" : true, - "type" : "string", - "enum" : [ "input-ports", "output-ports" ] - }, { - "name" : "portId", - "in" : "path", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/TransactionResultEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - }, - "503" : { - "description" : "NiFi instance is not ready for serving request, or temporarily overloaded. Retrying the same request later may be successful" - } - }, - "security" : [ { - "Write - /data-transfer/{component-type}/{uuid}" : [ ] - } ] - } - }, - "/flow/about" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Retrieves details about this NiFi to put in the About dialog", - "description" : "", - "operationId" : "getAboutInfo", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/AboutEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/banners" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Retrieves the banners for this NiFi", - "description" : "", - "operationId" : "getBanners", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/BannerEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/bulletin-board" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets current bulletins", - "description" : "", - "operationId" : "getBulletinBoard", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "after", - "in" : "query", - "description" : "Includes bulletins with an id after this value.", - "required" : false, - "type" : "string" - }, { - "name" : "sourceName", - "in" : "query", - "description" : "Includes bulletins originating from this sources whose name match this regular expression.", - "required" : false, - "type" : "string" - }, { - "name" : "message", - "in" : "query", - "description" : "Includes bulletins whose message that match this regular expression.", - "required" : false, - "type" : "string" - }, { - "name" : "sourceId", - "in" : "query", - "description" : "Includes bulletins originating from this sources whose id match this regular expression.", - "required" : false, - "type" : "string" - }, { - "name" : "groupId", - "in" : "query", - "description" : "Includes bulletins originating from this sources whose group id match this regular expression.", - "required" : false, - "type" : "string" - }, { - "name" : "limit", - "in" : "query", - "description" : "The number of bulletins to limit the response to.", - "required" : false, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/BulletinBoardEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - }, { - "Read - /{component-type}/{uuid} - For component specific bulletins" : [ ] - } ] - } - }, - "/flow/client-id" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Generates a client id.", - "description" : "", - "operationId" : "generateClientId", - "consumes" : [ "*/*" ], - "produces" : [ "text/plain" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/cluster/search-results" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Searches the cluster for a node with the specified address", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "searchCluster", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "q", - "in" : "query", - "description" : "Node address to search for.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ClusterSearchResultsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/cluster/summary" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "The cluster summary for this NiFi", - "description" : "", - "operationId" : "getClusterSummary", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ClusteSummaryEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/config" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Retrieves the configuration for this NiFi flow", - "description" : "", - "operationId" : "getFlowConfig", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/FlowConfigurationEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/connections/{id}/statistics" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets statistics for a connection", - "description" : "", - "operationId" : "getConnectionStatistics", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "nodewise", - "in" : "query", - "description" : "Whether or not to include the breakdown per node. Optional, defaults to false", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "clusterNodeId", - "in" : "query", - "description" : "The id of the node where to get the statistics.", - "required" : false, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The connection id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ConnectionStatisticsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/connections/{id}/status" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets status for a connection", - "description" : "", - "operationId" : "getConnectionStatus", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "nodewise", - "in" : "query", - "description" : "Whether or not to include the breakdown per node. Optional, defaults to false", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "clusterNodeId", - "in" : "query", - "description" : "The id of the node where to get the status.", - "required" : false, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The connection id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ConnectionStatusEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/connections/{id}/status/history" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets the status history for a connection", - "description" : "", - "operationId" : "getConnectionStatusHistory", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The connection id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/StatusHistoryEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/controller-service-types" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Retrieves the types of controller services that this NiFi supports", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getControllerServiceTypes", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "serviceType", - "in" : "query", - "description" : "If specified, will only return controller services that are compatible with this type of service.", - "required" : false, - "type" : "string" - }, { - "name" : "serviceBundleGroup", - "in" : "query", - "description" : "If serviceType specified, is the bundle group of the serviceType.", - "required" : false, - "type" : "string" - }, { - "name" : "serviceBundleArtifact", - "in" : "query", - "description" : "If serviceType specified, is the bundle artifact of the serviceType.", - "required" : false, - "type" : "string" - }, { - "name" : "serviceBundleVersion", - "in" : "query", - "description" : "If serviceType specified, is the bundle version of the serviceType.", - "required" : false, - "type" : "string" - }, { - "name" : "bundleGroupFilter", - "in" : "query", - "description" : "If specified, will only return types that are a member of this bundle group.", - "required" : false, - "type" : "string" - }, { - "name" : "bundleArtifactFilter", - "in" : "query", - "description" : "If specified, will only return types that are a member of this bundle artifact.", - "required" : false, - "type" : "string" - }, { - "name" : "typeFilter", - "in" : "query", - "description" : "If specified, will only return types whose fully qualified classname matches.", - "required" : false, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ControllerServiceTypesEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/controller/bulletins" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Retrieves Controller level bulletins", - "description" : "", - "operationId" : "getBulletins", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ControllerBulletinsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - }, { - "Read - /controller - For controller bulletins" : [ ] - }, { - "Read - /controller-services/{uuid} - For controller service bulletins" : [ ] - }, { - "Read - /reporting-tasks/{uuid} - For reporting task bulletins" : [ ] - } ] - } - }, - "/flow/controller/controller-services" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets controller services for reporting tasks", - "description" : "", - "operationId" : "getControllerServicesFromController", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ControllerServicesEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/current-user" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Retrieves the user identity of the user making the request", - "description" : "", - "operationId" : "getCurrentUser", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/CurrentUserEntity" - } - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/history" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets configuration history", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "queryHistory", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "offset", - "in" : "query", - "description" : "The offset into the result set.", - "required" : true, - "type" : "string" - }, { - "name" : "count", - "in" : "query", - "description" : "The number of actions to return.", - "required" : true, - "type" : "string" - }, { - "name" : "sortColumn", - "in" : "query", - "description" : "The field to sort on.", - "required" : false, - "type" : "string" - }, { - "name" : "sortOrder", - "in" : "query", - "description" : "The direction to sort.", - "required" : false, - "type" : "string" - }, { - "name" : "startDate", - "in" : "query", - "description" : "Include actions after this date.", - "required" : false, - "type" : "string" - }, { - "name" : "endDate", - "in" : "query", - "description" : "Include actions before this date.", - "required" : false, - "type" : "string" - }, { - "name" : "userIdentity", - "in" : "query", - "description" : "Include actions performed by this user.", - "required" : false, - "type" : "string" - }, { - "name" : "sourceId", - "in" : "query", - "description" : "Include actions on this component.", - "required" : false, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/HistoryEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/history/components/{componentId}" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets configuration history for a component", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getComponentHistory", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "componentId", - "in" : "path", - "description" : "The component id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ComponentHistoryEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - }, { - "Read underlying component - /{component-type}/{uuid}" : [ ] - } ] - } - }, - "/flow/history/{id}" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets an action", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getAction", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The action id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ActionEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/input-ports/{id}/status" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets status for an input port", - "description" : "", - "operationId" : "getInputPortStatus", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "nodewise", - "in" : "query", - "description" : "Whether or not to include the breakdown per node. Optional, defaults to false", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "clusterNodeId", - "in" : "query", - "description" : "The id of the node where to get the status.", - "required" : false, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The input port id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/PortStatusEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/metrics/{producer}" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets all metrics for the flow from a particular node", - "description" : "", - "operationId" : "getFlowMetrics", - "consumes" : [ "*/*" ], - "produces" : [ "*/*" ], - "parameters" : [ { - "name" : "producer", - "in" : "path", - "description" : "The producer for flow file metrics. Each producer may have its own output format.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/StreamingOutput" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/output-ports/{id}/status" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets status for an output port", - "description" : "", - "operationId" : "getOutputPortStatus", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "nodewise", - "in" : "query", - "description" : "Whether or not to include the breakdown per node. Optional, defaults to false", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "clusterNodeId", - "in" : "query", - "description" : "The id of the node where to get the status.", - "required" : false, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The output port id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/PortStatusEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/parameter-contexts" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets all Parameter Contexts", - "description" : "", - "operationId" : "getParameterContexts", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ParameterContextsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /parameter-contexts/{id} for each Parameter Context" : [ ] - } ] - } - }, - "/flow/prioritizers" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Retrieves the types of prioritizers that this NiFi supports", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getPrioritizers", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/PrioritizerTypesEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/process-groups/{id}" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets a process group", - "description" : "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", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "name" : "uiOnly", - "in" : "query", - "required" : false, - "type" : "boolean", - "default" : false - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessGroupFlowEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - }, - "put" : { - "tags" : [ "flow" ], - "summary" : "Schedule or unschedule components in the specified Process Group.", - "description" : "", - "operationId" : "scheduleComponents", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The request to schedule or unschedule. If the comopnents in the request are not specified, all authorized components will be considered.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ScheduleComponentsEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ScheduleComponentsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - }, { - "Write - /{component-type}/{uuid} or /operation/{component-type}/{uuid} - For every component being scheduled/unscheduled" : [ ] - } ] - } - }, - "/flow/process-groups/{id}/controller-services" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets all controller services", - "description" : "", - "operationId" : "getControllerServicesFromGroup", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "name" : "includeAncestorGroups", - "in" : "query", - "description" : "Whether or not to include parent/ancestory process groups", - "required" : false, - "type" : "boolean", - "default" : true - }, { - "name" : "includeDescendantGroups", - "in" : "query", - "description" : "Whether or not to include descendant process groups", - "required" : false, - "type" : "boolean", - "default" : false - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ControllerServicesEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - }, - "put" : { - "tags" : [ "flow" ], - "summary" : "Enable or disable Controller Services in the specified Process Group.", - "description" : "", - "operationId" : "activateControllerServices", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The request to schedule or unschedule. If the comopnents in the request are not specified, all authorized components will be considered.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ActivateControllerServicesEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ActivateControllerServicesEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - }, { - "Write - /{component-type}/{uuid} or /operation/{component-type}/{uuid} - For every service being enabled/disabled" : [ ] - } ] - } - }, - "/flow/process-groups/{id}/status" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets the status for a process group", - "description" : "The status for a process group includes status for all descendent components. When invoked on the root group with recursive set to true, it will return the current status of every component in the flow.", - "operationId" : "getProcessGroupStatus", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "recursive", - "in" : "query", - "description" : "Whether all descendant groups and the status of their content will be included. Optional, defaults to false", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "nodewise", - "in" : "query", - "description" : "Whether or not to include the breakdown per node. Optional, defaults to false", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "clusterNodeId", - "in" : "query", - "description" : "The id of the node where to get the status.", - "required" : false, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessGroupStatusEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/process-groups/{id}/status/history" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets status history for a remote process group", - "description" : "", - "operationId" : "getProcessGroupStatusHistory", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/StatusHistoryEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/processor-types" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Retrieves the types of processors that this NiFi supports", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getProcessorTypes", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bundleGroupFilter", - "in" : "query", - "description" : "If specified, will only return types that are a member of this bundle group.", - "required" : false, - "type" : "string" - }, { - "name" : "bundleArtifactFilter", - "in" : "query", - "description" : "If specified, will only return types that are a member of this bundle artifact.", - "required" : false, - "type" : "string" - }, { - "name" : "type", - "in" : "query", - "description" : "If specified, will only return types whose fully qualified classname matches.", - "required" : false, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessorTypesEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/processors/{id}/status" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets status for a processor", - "description" : "", - "operationId" : "getProcessorStatus", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "nodewise", - "in" : "query", - "description" : "Whether or not to include the breakdown per node. Optional, defaults to false", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "clusterNodeId", - "in" : "query", - "description" : "The id of the node where to get the status.", - "required" : false, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The processor id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessorStatusEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/processors/{id}/status/history" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets status history for a processor", - "description" : "", - "operationId" : "getProcessorStatusHistory", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The processor id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/StatusHistoryEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/registries" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets the listing of available registries", - "description" : "", - "operationId" : "getRegistries", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/RegistryClientsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/registries/{id}/buckets" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets the buckets from the specified registry for the current user", - "description" : "", - "operationId" : "getBuckets", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The registry id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/BucketsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/registries/{registry-id}/buckets/{bucket-id}/flows" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets the flows from the specified registry and bucket for the current user", - "description" : "", - "operationId" : "getFlows", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "registry-id", - "in" : "path", - "description" : "The registry id.", - "required" : true, - "type" : "string" - }, { - "name" : "bucket-id", - "in" : "path", - "description" : "The bucket id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlowsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/registries/{registry-id}/buckets/{bucket-id}/flows/{flow-id}/versions" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets the flow versions from the specified registry and bucket for the specified flow for the current user", - "description" : "", - "operationId" : "getVersions", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "registry-id", - "in" : "path", - "description" : "The registry id.", - "required" : true, - "type" : "string" - }, { - "name" : "bucket-id", - "in" : "path", - "description" : "The bucket id.", - "required" : true, - "type" : "string" - }, { - "name" : "flow-id", - "in" : "path", - "description" : "The flow id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlowSnapshotMetadataSetEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/remote-process-groups/{id}/status" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets status for a remote process group", - "description" : "", - "operationId" : "getRemoteProcessGroupStatus", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "nodewise", - "in" : "query", - "description" : "Whether or not to include the breakdown per node. Optional, defaults to false", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "clusterNodeId", - "in" : "query", - "description" : "The id of the node where to get the status.", - "required" : false, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The remote process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/RemoteProcessGroupStatusEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/remote-process-groups/{id}/status/history" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets the status history", - "description" : "", - "operationId" : "getRemoteProcessGroupStatusHistory", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The remote process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/StatusHistoryEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/reporting-task-types" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Retrieves the types of reporting tasks that this NiFi supports", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getReportingTaskTypes", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bundleGroupFilter", - "in" : "query", - "description" : "If specified, will only return types that are a member of this bundle group.", - "required" : false, - "type" : "string" - }, { - "name" : "bundleArtifactFilter", - "in" : "query", - "description" : "If specified, will only return types that are a member of this bundle artifact.", - "required" : false, - "type" : "string" - }, { - "name" : "type", - "in" : "query", - "description" : "If specified, will only return types whose fully qualified classname matches.", - "required" : false, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ReportingTaskTypesEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/reporting-tasks" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets all reporting tasks", - "description" : "", - "operationId" : "getReportingTasks", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ReportingTasksEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/search-results" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Performs a search against this NiFi using the specified search term", - "description" : "Only search results from authorized components will be returned.", - "operationId" : "searchFlow", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "q", - "in" : "query", - "required" : false, - "type" : "string" - }, { - "name" : "a", - "in" : "query", - "required" : false, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/SearchResultsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/status" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets the current status of this NiFi", - "description" : "", - "operationId" : "getControllerStatus", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ControllerStatusEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/templates" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets all templates", - "description" : "", - "operationId" : "getTemplates", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/TemplatesEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flowfile-queues/{id}/drop-requests" : { - "post" : { - "tags" : [ "flowfile-queues" ], - "summary" : "Creates a request to drop the contents of the queue in this connection.", - "description" : "", - "operationId" : "createDropRequest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The connection id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/DropRequestEntity" - } - }, - "202" : { - "description" : "The request has been accepted. A HTTP response header will contain the URI where the response can be polled." - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write Source Data - /data/{component-type}/{uuid}" : [ ] - } ] - } - }, - "/flowfile-queues/{id}/drop-requests/{drop-request-id}" : { - "get" : { - "tags" : [ "flowfile-queues" ], - "summary" : "Gets the current status of a drop request for the specified connection.", - "description" : "", - "operationId" : "getDropRequest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The connection id.", - "required" : true, - "type" : "string" - }, { - "name" : "drop-request-id", - "in" : "path", - "description" : "The drop request id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/DropRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write Source Data - /data/{component-type}/{uuid}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "flowfile-queues" ], - "summary" : "Cancels and/or removes a request to drop the contents of this connection.", - "description" : "", - "operationId" : "removeDropRequest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The connection id.", - "required" : true, - "type" : "string" - }, { - "name" : "drop-request-id", - "in" : "path", - "description" : "The drop request id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/DropRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write Source Data - /data/{component-type}/{uuid}" : [ ] - } ] - } - }, - "/flowfile-queues/{id}/flowfiles/{flowfile-uuid}" : { - "get" : { - "tags" : [ "flowfile-queues" ], - "summary" : "Gets a FlowFile from a Connection.", - "description" : "", - "operationId" : "getFlowFile", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The connection id.", - "required" : true, - "type" : "string" - }, { - "name" : "flowfile-uuid", - "in" : "path", - "description" : "The flowfile uuid.", - "required" : true, - "type" : "string" - }, { - "name" : "clusterNodeId", - "in" : "query", - "description" : "The id of the node where the content exists if clustered.", - "required" : false, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/FlowFileEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read Source Data - /data/{component-type}/{uuid}" : [ ] - } ] - } - }, - "/flowfile-queues/{id}/flowfiles/{flowfile-uuid}/content" : { - "get" : { - "tags" : [ "flowfile-queues" ], - "summary" : "Gets the content for a FlowFile in a Connection.", - "description" : "", - "operationId" : "downloadFlowFileContent", - "consumes" : [ "*/*" ], - "produces" : [ "*/*" ], - "parameters" : [ { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The connection id.", - "required" : true, - "type" : "string" - }, { - "name" : "flowfile-uuid", - "in" : "path", - "description" : "The flowfile uuid.", - "required" : true, - "type" : "string" - }, { - "name" : "clusterNodeId", - "in" : "query", - "description" : "The id of the node where the content exists if clustered.", - "required" : false, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/StreamingOutput" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read Source Data - /data/{component-type}/{uuid}" : [ ] - } ] - } - }, - "/flowfile-queues/{id}/listing-requests" : { - "post" : { - "tags" : [ "flowfile-queues" ], - "summary" : "Lists the contents of the queue in this connection.", - "description" : "", - "operationId" : "createFlowFileListing", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The connection id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ListingRequestEntity" - } - }, - "202" : { - "description" : "The request has been accepted. A HTTP response header will contain the URI where the response can be polled." - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read Source Data - /data/{component-type}/{uuid}" : [ ] - } ] - } - }, - "/flowfile-queues/{id}/listing-requests/{listing-request-id}" : { - "get" : { - "tags" : [ "flowfile-queues" ], - "summary" : "Gets the current status of a listing request for the specified connection.", - "description" : "", - "operationId" : "getListingRequest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The connection id.", - "required" : true, - "type" : "string" - }, { - "name" : "listing-request-id", - "in" : "path", - "description" : "The listing request id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ListingRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read Source Data - /data/{component-type}/{uuid}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "flowfile-queues" ], - "summary" : "Cancels and/or removes a request to list the contents of this connection.", - "description" : "", - "operationId" : "deleteListingRequest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The connection id.", - "required" : true, - "type" : "string" - }, { - "name" : "listing-request-id", - "in" : "path", - "description" : "The listing request id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ListingRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read Source Data - /data/{component-type}/{uuid}" : [ ] - } ] - } - }, - "/funnels/{id}" : { - "get" : { - "tags" : [ "funnel" ], - "summary" : "Gets a funnel", - "description" : "", - "operationId" : "getFunnel", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The funnel id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/FunnelEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /funnels/{uuid}" : [ ] - } ] - }, - "put" : { - "tags" : [ "funnel" ], - "summary" : "Updates a funnel", - "description" : "", - "operationId" : "updateFunnel", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The funnel id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The funnel configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/FunnelEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/FunnelEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /funnels/{uuid}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "funnel" ], - "summary" : "Deletes a funnel", - "description" : "", - "operationId" : "removeFunnel", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The revision is used to verify the client is working with the latest version of the flow.", - "required" : false, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The funnel id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/FunnelEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /funnels/{uuid}" : [ ] - }, { - "Write - Parent Process Group - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/input-ports/{id}" : { - "get" : { - "tags" : [ "input-ports" ], - "summary" : "Gets an input port", - "description" : "", - "operationId" : "getInputPort", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The input port id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/PortEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /input-ports/{uuid}" : [ ] - } ] - }, - "put" : { - "tags" : [ "input-ports" ], - "summary" : "Updates an input port", - "description" : "", - "operationId" : "updateInputPort", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The input port id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The input port configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/PortEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/PortEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /input-ports/{uuid}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "input-ports" ], - "summary" : "Deletes an input port", - "description" : "", - "operationId" : "removeInputPort", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The revision is used to verify the client is working with the latest version of the flow.", - "required" : false, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The input port id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/PortEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /input-ports/{uuid}" : [ ] - }, { - "Write - Parent Process Group - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/input-ports/{id}/run-status" : { - "put" : { - "tags" : [ "input-ports" ], - "summary" : "Updates run status of an input-port", - "description" : "", - "operationId" : "updateRunStatus", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The port id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The port run status.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/PortRunStatusEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessorEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /input-ports/{uuid} or /operation/input-ports/{uuid}" : [ ] - } ] - } - }, - "/labels/{id}" : { - "get" : { - "tags" : [ "labels" ], - "summary" : "Gets a label", - "description" : "", - "operationId" : "getLabel", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The label id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/LabelEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /labels/{uuid}" : [ ] - } ] - }, - "put" : { - "tags" : [ "labels" ], - "summary" : "Updates a label", - "description" : "", - "operationId" : "updateLabel", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The label id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The label configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/LabelEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/LabelEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /labels/{uuid}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "labels" ], - "summary" : "Deletes a label", - "description" : "", - "operationId" : "removeLabel", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The revision is used to verify the client is working with the latest version of the flow.", - "required" : false, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The label id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/LabelEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /labels/{uuid}" : [ ] - }, { - "Write - Parent Process Group - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/output-ports/{id}" : { - "get" : { - "tags" : [ "output-ports" ], - "summary" : "Gets an output port", - "description" : "", - "operationId" : "getOutputPort", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The output port id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/PortEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /output-ports/{uuid}" : [ ] - } ] - }, - "put" : { - "tags" : [ "output-ports" ], - "summary" : "Updates an output port", - "description" : "", - "operationId" : "updateOutputPort", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The output port id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The output port configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/PortEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/PortEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /output-ports/{uuid}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "output-ports" ], - "summary" : "Deletes an output port", - "description" : "", - "operationId" : "removeOutputPort", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The revision is used to verify the client is working with the latest version of the flow.", - "required" : false, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The output port id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/PortEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /output-ports/{uuid}" : [ ] - }, { - "Write - Parent Process Group - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/output-ports/{id}/run-status" : { - "put" : { - "tags" : [ "output-ports" ], - "summary" : "Updates run status of an output-port", - "description" : "", - "operationId" : "updateRunStatus", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The port id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The port run status.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/PortRunStatusEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessorEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /output-ports/{uuid} or /operation/output-ports/{uuid}" : [ ] - } ] - } - }, - "/parameter-contexts" : { - "post" : { - "tags" : [ "parameter-contexts" ], - "summary" : "Create a Parameter Context", - "description" : "", - "operationId" : "createParameterContext", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The Parameter Context.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ParameterContextEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ParameterContextEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /parameter-contexts" : [ ] - }, { - "Read - for every inherited parameter context" : [ ] - } ] - } - }, - "/parameter-contexts/{contextId}/update-requests" : { - "post" : { - "tags" : [ "parameter-contexts" ], - "summary" : "Initiate the Update Request of a Parameter Context", - "description" : "This will initiate the process of updating a Parameter Context. Changing the value of a Parameter may require that one or more components be stopped and restarted, so this 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", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "contextId", - "in" : "path", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The updated version of the parameter context.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ParameterContextEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ParameterContextUpdateRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /parameter-contexts/{parameterContextId}" : [ ] - }, { - "Write - /parameter-contexts/{parameterContextId}" : [ ] - }, { - "Read - for every component that is affected by the update" : [ ] - }, { - "Write - for every component that is affected by the update" : [ ] - }, { - "Read - for every currently inherited parameter context" : [ ] - }, { - "Read - for any new inherited parameter context" : [ ] - } ] - } - }, - "/parameter-contexts/{contextId}/update-requests/{requestId}" : { - "get" : { - "tags" : [ "parameter-contexts" ], - "summary" : "Returns the Update Request with the given ID", - "description" : "Returns the Update Request with the given ID. Once an Update Request has been created by performing a POST to /nifi-api/parameter-contexts, that request can subsequently be retrieved via this endpoint, and the request that is fetched will contain the updated state, such as percent complete, the current state of the request, and any failures. ", - "operationId" : "getParameterContextUpdate", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "contextId", - "in" : "path", - "description" : "The ID of the Parameter Context", - "required" : true, - "type" : "string" - }, { - "name" : "requestId", - "in" : "path", - "description" : "The ID of the Update Request", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ParameterContextUpdateRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Only the user that submitted the request can get it" : [ ] - } ] - }, - "delete" : { - "tags" : [ "parameter-contexts" ], - "summary" : "Deletes the Update Request with the given ID", - "description" : "Deletes the Update Request with the given ID. After a request is created via a POST to /nifi-api/parameter-contexts/update-requests, it is expected that the client will properly clean up the request by DELETE'ing it, once the Update process has completed. If the request is deleted before the request completes, then the Update request will finish the step that it is currently performing and then will cancel any subsequent steps.", - "operationId" : "deleteUpdateRequest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "contextId", - "in" : "path", - "description" : "The ID of the ParameterContext", - "required" : true, - "type" : "string" - }, { - "name" : "requestId", - "in" : "path", - "description" : "The ID of the Update Request", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ParameterContextUpdateRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Only the user that submitted the request can remove it" : [ ] - } ] - } - }, - "/parameter-contexts/{contextId}/validation-requests" : { - "post" : { - "tags" : [ "parameter-contexts" ], - "summary" : "Initiate a Validation Request to determine how the validity of components will change if a Parameter Context were to be updated", - "description" : "This will initiate the process of validating all components whose Process Group is bound to the specified Parameter Context. Performing validation against an arbitrary number of components may be expect and take significantly more time than many other REST API actions. As a result, this endpoint will immediately return a ParameterContextValidationRequestEntity, and the process of validating the necessary components will occur asynchronously in the background. The client may then periodically poll the status of the request by issuing a GET request to /parameter-contexts/validation-requests/{requestId}. Once the request is completed, the client is expected to issue a DELETE request to /parameter-contexts/validation-requests/{requestId}.", - "operationId" : "submitValidationRequest", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "contextId", - "in" : "path", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The validation request", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ParameterContextValidationRequestEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ParameterContextValidationRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /parameter-contexts/{parameterContextId}" : [ ] - } ] - } - }, - "/parameter-contexts/{contextId}/validation-requests/{id}" : { - "get" : { - "tags" : [ "parameter-contexts" ], - "summary" : "Returns the Validation Request with the given ID", - "description" : "Returns the Validation Request with the given ID. Once a Validation Request has been created by performing a POST to /nifi-api/validation-contexts, that request can subsequently be retrieved via this endpoint, and the request that is fetched will contain the updated state, such as percent complete, the current state of the request, and any failures. ", - "operationId" : "getValidationRequest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "contextId", - "in" : "path", - "description" : "The ID of the Parameter Context", - "required" : true, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The ID of the Validation Request", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ParameterContextValidationRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Only the user that submitted the request can get it" : [ ] - } ] - }, - "delete" : { - "tags" : [ "parameter-contexts" ], - "summary" : "Deletes the Validation Request with the given ID", - "description" : "Deletes the Validation Request with the given ID. After a request is created via a POST to /nifi-api/validation-contexts, it is expected that the client will properly clean up the request by DELETE'ing it, once the validation process has completed. If the request is deleted before the request completes, then the Validation request will finish the step that it is currently performing and then will cancel any subsequent steps.", - "operationId" : "deleteValidationRequest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "contextId", - "in" : "path", - "description" : "The ID of the Parameter Context", - "required" : true, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The ID of the Update Request", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ParameterContextValidationRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Only the user that submitted the request can remove it" : [ ] - } ] - } - }, - "/parameter-contexts/{id}" : { - "get" : { - "tags" : [ "parameter-contexts" ], - "summary" : "Returns the Parameter Context with the given ID", - "description" : "Returns the Parameter Context with the given ID.", - "operationId" : "getParameterContext", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The ID of the Parameter Context", - "required" : true, - "type" : "string" - }, { - "name" : "includeInheritedParameters", - "in" : "query", - "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.", - "required" : false, - "type" : "boolean", - "default" : false - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ParameterContextEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /parameter-contexts/{id}" : [ ] - } ] - }, - "put" : { - "tags" : [ "parameter-contexts" ], - "summary" : "Modifies a Parameter Context", - "description" : "This endpoint will update a Parameter Context to match the provided entity. However, this request will fail if any component is running and is referencing a Parameter in the Parameter Context. Generally, this endpoint is not called directly. Instead, an update request should be submitted by making a POST to the /parameter-contexts/update-requests endpoint. That endpoint will, in turn, call this endpoint.", - "operationId" : "updateParameterContext", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The updated Parameter Context", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ParameterContextEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ParameterContextEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /parameter-contexts/{id}" : [ ] - }, { - "Write - /parameter-contexts/{id}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "parameter-contexts" ], - "summary" : "Deletes the Parameter Context with the given ID", - "description" : "Deletes the Parameter Context with the given ID.", - "operationId" : "deleteParameterContext", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The version is used to verify the client is working with the latest version of the flow.", - "required" : false, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, a new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The Parameter Context ID.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ParameterContextEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /parameter-contexts/{uuid}" : [ ] - }, { - "Write - /parameter-contexts/{uuid}" : [ ] - }, { - "Read - /process-groups/{uuid}, for any Process Group that is currently bound to the Parameter Context" : [ ] - }, { - "Write - /process-groups/{uuid}, for any Process Group that is currently bound to the Parameter Context" : [ ] - } ] - } - }, - "/policies" : { - "post" : { - "tags" : [ "policies" ], - "summary" : "Creates an access policy", - "description" : "", - "operationId" : "createAccessPolicy", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The access policy configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/AccessPolicyEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/AccessPolicyEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /policies/{resource}" : [ ] - } ] - } - }, - "/policies/{action}/{resource}" : { - "get" : { - "tags" : [ "policies" ], - "summary" : "Gets an access policy for the specified action and resource", - "description" : "Will return the effective policy if no component specific policy exists for the specified action and resource. Must have Read permissions to the policy with the desired action and resource. Permissions for the policy that is returned will be indicated in the response. This means the client could be authorized to get the policy for a given component but the effective policy may be inherited from an ancestor Process Group. If the client does not have permissions to that policy, the response will not include the policy and the permissions in the response will be marked accordingly. If the client does not have permissions to the policy of the desired action and resource a 403 response will be returned.", - "operationId" : "getAccessPolicyForResource", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "action", - "in" : "path", - "description" : "The request action.", - "required" : true, - "type" : "string", - "enum" : [ "read", "write" ] - }, { - "name" : "resource", - "in" : "path", - "description" : "The resource of the policy.", - "required" : true, - "type" : "string", - "pattern" : ".+" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/AccessPolicyEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /policies/{resource}" : [ ] - } ] - } - }, - "/policies/{id}" : { - "get" : { - "tags" : [ "policies" ], - "summary" : "Gets an access policy", - "description" : "", - "operationId" : "getAccessPolicy", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The access policy id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/AccessPolicyEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /policies/{resource}" : [ ] - } ] - }, - "put" : { - "tags" : [ "policies" ], - "summary" : "Updates a access policy", - "description" : "", - "operationId" : "updateAccessPolicy", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The access policy id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The access policy configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/AccessPolicyEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/AccessPolicyEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /policies/{resource}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "policies" ], - "summary" : "Deletes an access policy", - "description" : "", - "operationId" : "removeAccessPolicy", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The revision is used to verify the client is working with the latest version of the flow.", - "required" : false, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The access policy id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/AccessPolicyEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /policies/{resource}" : [ ] - }, { - "Write - Policy of the parent resource - /policies/{resource}" : [ ] - } ] - } - }, - "/process-groups/replace-requests/{id}" : { - "get" : { - "tags" : [ "process-groups" ], - "summary" : "Returns the Replace Request with the given ID", - "description" : "Returns the Replace Request with the given ID. Once a Replace Request has been created by performing a POST to /process-groups/{id}/replace-requests, that request can subsequently be retrieved via this endpoint, and the request that is fetched will contain the updated state, such as percent complete, the current state of the request, and any failures. Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getReplaceProcessGroupRequest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The ID of the Replace Request", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessGroupReplaceRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Only the user that submitted the request can get it" : [ ] - } ] - }, - "delete" : { - "tags" : [ "process-groups" ], - "summary" : "Deletes the Replace Request with the given ID", - "description" : "Deletes the Replace Request with the given ID. After a request is created via a POST to /process-groups/{id}/replace-requests, it is expected that the client will properly clean up the request by DELETE'ing it, once the Replace process has completed. If the request is deleted before the request completes, then the Replace request will finish the step that it is currently performing and then will cancel any subsequent steps. Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "deleteReplaceProcessGroupRequest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The ID of the Update Request", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessGroupReplaceRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Only the user that submitted the request can remove it" : [ ] - } ] - } - }, - "/process-groups/{groupId}/variable-registry/update-requests/{updateId}" : { - "get" : { - "tags" : [ "process-groups" ], - "summary" : "Gets a process group's variable registry", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getVariableRegistryUpdateRequest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "groupId", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "name" : "updateId", - "in" : "path", - "description" : "The ID of the Variable Registry Update Request", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VariableRegistryUpdateRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "process-groups" ], - "summary" : "Deletes an update request for a process group's variable registry. If the request is not yet complete, it will automatically be cancelled.", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "deleteVariableRegistryUpdateRequest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "groupId", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "name" : "updateId", - "in" : "path", - "description" : "The ID of the Variable Registry Update Request", - "required" : true, - "type" : "string" - }, { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VariableRegistryUpdateRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/process-groups/{id}" : { - "get" : { - "tags" : [ "process-groups" ], - "summary" : "Gets a process group", - "description" : "", - "operationId" : "getProcessGroup", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessGroupEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - } ] - }, - "put" : { - "tags" : [ "process-groups" ], - "summary" : "Updates a process group", - "description" : "", - "operationId" : "updateProcessGroup", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The process group configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ProcessGroupEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessGroupEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "process-groups" ], - "summary" : "Deletes a process group", - "description" : "", - "operationId" : "removeProcessGroup", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The revision is used to verify the client is working with the latest version of the flow.", - "required" : false, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessGroupEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - }, { - "Write - Parent Process Group - /process-groups/{uuid}" : [ ] - }, { - "Read - any referenced Controller Services by any encapsulated components - /controller-services/{uuid}" : [ ] - }, { - "Write - /{component-type}/{uuid} - For all encapsulated components" : [ ] - } ] - } - }, - "/process-groups/{id}/connections" : { - "get" : { - "tags" : [ "process-groups" ], - "summary" : "Gets all connections", - "description" : "", - "operationId" : "getConnections", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ConnectionsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - } ] - }, - "post" : { - "tags" : [ "process-groups" ], - "summary" : "Creates a connection", - "description" : "", - "operationId" : "createConnection", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The connection configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ConnectionEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ConnectionEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - }, { - "Write Source - /{component-type}/{uuid}" : [ ] - }, { - "Write Destination - /{component-type}/{uuid}" : [ ] - } ] - } - }, - "/process-groups/{id}/controller-services" : { - "post" : { - "tags" : [ "process-groups" ], - "summary" : "Creates a new controller service", - "description" : "", - "operationId" : "createControllerService", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The controller service configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ControllerServiceEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ControllerServiceEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - }, { - "Read - any referenced Controller Services - /controller-services/{uuid}" : [ ] - }, { - "Write - if the Controller Service is restricted - /restricted-components" : [ ] - } ] - } - }, - "/process-groups/{id}/download" : { - "get" : { - "tags" : [ "process-groups" ], - "summary" : "Gets a process group for download", - "description" : "", - "operationId" : "exportProcessGroup", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/process-groups/{id}/empty-all-connections-requests" : { - "post" : { - "tags" : [ "process-groups" ], - "summary" : "Creates a request to drop all flowfiles of all connection queues in this process group.", - "description" : "", - "operationId" : "createEmptyAllConnectionsRequest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessGroupEntity" - } - }, - "202" : { - "description" : "The request has been accepted. An HTTP response header will contain the URI where the status can be polled." - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid} - For this and all encapsulated process groups" : [ ] - }, { - "Write Source Data - /data/{component-type}/{uuid} - For all encapsulated connections" : [ ] - } ] - } - }, - "/process-groups/{id}/empty-all-connections-requests/{drop-request-id}" : { - "get" : { - "tags" : [ "process-groups" ], - "summary" : "Gets the current status of a drop all flowfiles request.", - "description" : "", - "operationId" : "getDropAllFlowfilesRequest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "name" : "drop-request-id", - "in" : "path", - "description" : "The drop request id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/DropRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid} - For this and all encapsulated process groups" : [ ] - }, { - "Write Source Data - /data/{component-type}/{uuid} - For all encapsulated connections" : [ ] - } ] - }, - "delete" : { - "tags" : [ "process-groups" ], - "summary" : "Cancels and/or removes a request to drop all flowfiles.", - "description" : "", - "operationId" : "removeDropRequest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "name" : "drop-request-id", - "in" : "path", - "description" : "The drop request id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/DropRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid} - For this and all encapsulated process groups" : [ ] - }, { - "Write Source Data - /data/{component-type}/{uuid} - For all encapsulated connections" : [ ] - } ] - } - }, - "/process-groups/{id}/flow-contents" : { - "put" : { - "tags" : [ "process-groups" ], - "summary" : "Replace Process Group contents with the given ID with the specified Process Group contents", - "description" : "This endpoint is used for replication within a cluster, when replacing a flow with a new flow. It expects that the flow beingreplaced is not under version control and that the given snapshot will not modify any Processor that is currently running or any Controller Service that is enabled. Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "replaceProcessGroup", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The process group replace request entity.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ProcessGroupImportEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessGroupImportEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - }, { - "Write - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/process-groups/{id}/funnels" : { - "get" : { - "tags" : [ "process-groups" ], - "summary" : "Gets all funnels", - "description" : "", - "operationId" : "getFunnels", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/FunnelsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - } ] - }, - "post" : { - "tags" : [ "process-groups" ], - "summary" : "Creates a funnel", - "description" : "", - "operationId" : "createFunnel", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The funnel configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/FunnelEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/FunnelEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/process-groups/{id}/input-ports" : { - "get" : { - "tags" : [ "process-groups" ], - "summary" : "Gets all input ports", - "description" : "", - "operationId" : "getInputPorts", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/InputPortsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - } ] - }, - "post" : { - "tags" : [ "process-groups" ], - "summary" : "Creates an input port", - "description" : "", - "operationId" : "createInputPort", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The input port configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/PortEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/PortEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/process-groups/{id}/labels" : { - "get" : { - "tags" : [ "process-groups" ], - "summary" : "Gets all labels", - "description" : "", - "operationId" : "getLabels", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/LabelsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - } ] - }, - "post" : { - "tags" : [ "process-groups" ], - "summary" : "Creates a label", - "description" : "", - "operationId" : "createLabel", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The label configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/LabelEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/LabelEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/process-groups/{id}/local-modifications" : { - "get" : { - "tags" : [ "process-groups" ], - "summary" : "Gets a list of local modifications to the Process Group since it was last synchronized with the Flow Registry", - "description" : "", - "operationId" : "getLocalModifications", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/FlowComparisonEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - }, { - "Read - /{component-type}/{uuid} - For all encapsulated components" : [ ] - } ] - } - }, - "/process-groups/{id}/output-ports" : { - "get" : { - "tags" : [ "process-groups" ], - "summary" : "Gets all output ports", - "description" : "", - "operationId" : "getOutputPorts", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/OutputPortsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - } ] - }, - "post" : { - "tags" : [ "process-groups" ], - "summary" : "Creates an output port", - "description" : "", - "operationId" : "createOutputPort", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The output port configuration.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/PortEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/PortEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/process-groups/{id}/process-groups" : { - "get" : { - "tags" : [ "process-groups" ], - "summary" : "Gets all process groups", - "description" : "", - "operationId" : "getProcessGroups", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessGroupsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - } ] - }, - "post" : { - "tags" : [ "process-groups" ], - "summary" : "Creates a process group", - "description" : "", - "operationId" : "createProcessGroup", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The process group configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ProcessGroupEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessGroupEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/process-groups/{id}/process-groups/import" : { - "post" : { - "tags" : [ "process-groups" ], - "summary" : "Imports a specified process group", - "description" : "", - "operationId" : "importProcessGroup", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessGroupEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/process-groups/{id}/process-groups/upload" : { - "post" : { - "tags" : [ "process-groups" ], - "summary" : "Uploads a versioned flow definition and creates a process group", - "description" : "", - "operationId" : "uploadProcessGroup", - "consumes" : [ "multipart/form-data" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The process group name.", - "required" : true, - "schema" : { - "type" : "string" - } - }, { - "in" : "body", - "name" : "body", - "description" : "The process group X position.", - "required" : true, - "schema" : { - "type" : "number", - "format" : "double" - } - }, { - "in" : "body", - "name" : "body", - "description" : "The process group Y position.", - "required" : true, - "schema" : { - "type" : "number", - "format" : "double" - } - }, { - "in" : "body", - "name" : "body", - "description" : "The client id.", - "required" : true, - "schema" : { - "type" : "string" - } - }, { - "in" : "body", - "name" : "body", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "schema" : { - "type" : "boolean" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessGroupEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/process-groups/{id}/processors" : { - "get" : { - "tags" : [ "process-groups" ], - "summary" : "Gets all processors", - "description" : "", - "operationId" : "getProcessors", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "name" : "includeDescendantGroups", - "in" : "query", - "description" : "Whether or not to include processors from descendant process groups", - "required" : false, - "type" : "boolean", - "default" : false - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessorsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - } ] - }, - "post" : { - "tags" : [ "process-groups" ], - "summary" : "Creates a new processor", - "description" : "", - "operationId" : "createProcessor", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The processor configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ProcessorEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessorEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - }, { - "Read - any referenced Controller Services - /controller-services/{uuid}" : [ ] - }, { - "Write - if the Processor is restricted - /restricted-components" : [ ] - } ] - } - }, - "/process-groups/{id}/remote-process-groups" : { - "get" : { - "tags" : [ "process-groups" ], - "summary" : "Gets all remote process groups", - "description" : "", - "operationId" : "getRemoteProcessGroups", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/RemoteProcessGroupsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - } ] - }, - "post" : { - "tags" : [ "process-groups" ], - "summary" : "Creates a new process group", - "description" : "", - "operationId" : "createRemoteProcessGroup", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The remote process group configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/RemoteProcessGroupEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/RemoteProcessGroupEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/process-groups/{id}/replace-requests" : { - "post" : { - "tags" : [ "process-groups" ], - "summary" : "Initiate the Replace Request of a Process Group with the given ID", - "description" : "This will initiate the action of replacing a process group with the given process group. This can be a lengthy process, as it will stop any Processors and disable any Controller Services necessary to perform the action and then restart them. As a result, the endpoint will immediately return a ProcessGroupReplaceRequestEntity, and the process of replacing the flow will occur asynchronously in the background. The client may then periodically poll the status of the request by issuing a GET request to /process-groups/replace-requests/{requestId}. Once the request is completed, the client is expected to issue a DELETE request to /process-groups/replace-requests/{requestId}. Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "initiateReplaceProcessGroup", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The process group replace request entity", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ProcessGroupImportEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessGroupReplaceRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - }, { - "Write - /process-groups/{uuid}" : [ ] - }, { - "Read - /{component-type}/{uuid} - For all encapsulated components" : [ ] - }, { - "Write - /{component-type}/{uuid} - For all encapsulated components" : [ ] - }, { - "Write - if the template contains any restricted components - /restricted-components" : [ ] - }, { - "Read - /parameter-contexts/{uuid} - For any Parameter Context that is referenced by a Property that is changed, added, or removed" : [ ] - } ] - } - }, - "/process-groups/{id}/snippet-instance" : { - "post" : { - "tags" : [ "process-groups" ], - "summary" : "Copies a snippet and discards it.", - "description" : "", - "operationId" : "copySnippet", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The copy snippet request.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/CopySnippetRequestEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/FlowEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - }, { - "Read - /{component-type}/{uuid} - For each component in the snippet and their descendant components" : [ ] - }, { - "Write - if the snippet contains any restricted Processors - /restricted-components" : [ ] - } ] - } - }, - "/process-groups/{id}/template-instance" : { - "post" : { - "tags" : [ "process-groups" ], - "summary" : "Instantiates a template", - "description" : "", - "operationId" : "instantiateTemplate", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The instantiate template request.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/InstantiateTemplateRequestEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/FlowEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - }, { - "Read - /templates/{uuid}" : [ ] - }, { - "Write - if the template contains any restricted components - /restricted-components" : [ ] - } ] - } - }, - "/process-groups/{id}/templates" : { - "post" : { - "tags" : [ "process-groups" ], - "summary" : "Creates a template and discards the specified snippet.", - "description" : "", - "operationId" : "createTemplate", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The create template request.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/CreateTemplateRequestEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/TemplateEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - }, { - "Read - /{component-type}/{uuid} - For each component in the snippet and their descendant components" : [ ] - } ] - } - }, - "/process-groups/{id}/templates/import" : { - "post" : { - "tags" : [ "process-groups" ], - "summary" : "Imports a template", - "description" : "", - "operationId" : "importTemplate", - "consumes" : [ "application/xml" ], - "produces" : [ "application/xml" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/TemplateEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/process-groups/{id}/templates/upload" : { - "post" : { - "tags" : [ "process-groups" ], - "summary" : "Uploads a template", - "description" : "", - "operationId" : "uploadTemplate", - "consumes" : [ "multipart/form-data" ], - "produces" : [ "application/xml" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "schema" : { - "type" : "boolean" - } - }, { - "name" : "template", - "in" : "formData", - "description" : "The binary content of the template file being uploaded.", - "required" : true, - "type" : "file" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/TemplateEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/process-groups/{id}/variable-registry" : { - "get" : { - "tags" : [ "process-groups" ], - "summary" : "Gets a process group's variable registry", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getVariableRegistry", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "name" : "includeAncestorGroups", - "in" : "query", - "description" : "Whether or not to include ancestor groups", - "required" : false, - "type" : "boolean", - "default" : true - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VariableRegistryEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - } ] - }, - "put" : { - "tags" : [ "process-groups" ], - "summary" : "Updates the contents of a Process Group's variable Registry", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "updateVariableRegistry", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The variable registry configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/VariableRegistryEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VariableRegistryEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/process-groups/{id}/variable-registry/update-requests" : { - "post" : { - "tags" : [ "process-groups" ], - "summary" : "Submits a request to update a process group's variable registry", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "submitUpdateVariableRegistryRequest", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The variable registry configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/VariableRegistryEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VariableRegistryUpdateRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/processors/run-status-details/queries" : { - "post" : { - "tags" : [ "processors" ], - "summary" : "Submits a query to retrieve the run status details of all processors that are in the given list of Processor IDs", - "description" : "", - "operationId" : "getProcessorRunStatusDetails", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The request for the processors that should be included in the results", - "required" : false, - "schema" : { - "$ref" : "#/definitions/RunStatusDetailsRequestEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessorsRunStatusDetailsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /processors/{uuid} for each processor whose run status information is requested" : [ ] - } ] - } - }, - "/processors/{id}" : { - "get" : { - "tags" : [ "processors" ], - "summary" : "Gets a processor", - "description" : "", - "operationId" : "getProcessor", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The processor id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessorEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /processors/{uuid}" : [ ] - } ] - }, - "put" : { - "tags" : [ "processors" ], - "summary" : "Updates a processor", - "description" : "", - "operationId" : "updateProcessor", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The processor id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The processor configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ProcessorEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessorEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /processors/{uuid}" : [ ] - }, { - "Read - any referenced Controller Services if this request changes the reference - /controller-services/{uuid}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "processors" ], - "summary" : "Deletes a processor", - "description" : "", - "operationId" : "deleteProcessor", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The revision is used to verify the client is working with the latest version of the flow.", - "required" : false, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The processor id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessorEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /processors/{uuid}" : [ ] - }, { - "Write - Parent Process Group - /process-groups/{uuid}" : [ ] - }, { - "Read - any referenced Controller Services - /controller-services/{uuid}" : [ ] - } ] - } - }, - "/processors/{id}/config/analysis" : { - "post" : { - "tags" : [ "processors" ], - "summary" : "Performs analysis of the component's configuration, providing information about which attributes are referenced.", - "description" : "", - "operationId" : "analyzeConfiguration", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The processor id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The processor configuration analysis request.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ConfigurationAnalysisEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/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. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /processors/{uuid}" : [ ] - } ] - } - }, - "/processors/{id}/config/verification-requests" : { - "post" : { - "tags" : [ "processors" ], - "summary" : "Performs verification of the Processor's configuration", - "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", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The processor id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The processor configuration verification request.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/VerifyConfigRequestEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/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. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /processors/{uuid}" : [ ] - } ] - } - }, - "/processors/{id}/config/verification-requests/{requestId}" : { - "get" : { - "tags" : [ "processors" ], - "summary" : "Returns the Verification Request with the given ID", - "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", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The ID of the Processor", - "required" : true, - "type" : "string" - }, { - "name" : "requestId", - "in" : "path", - "description" : "The ID of the Verification Request", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/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. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Only the user that submitted the request can get it" : [ ] - } ] - }, - "delete" : { - "tags" : [ "processors" ], - "summary" : "Deletes the Verification Request with the given ID", - "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", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The ID of the Processor", - "required" : true, - "type" : "string" - }, { - "name" : "requestId", - "in" : "path", - "description" : "The ID of the Verification Request", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/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. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Only the user that submitted the request can remove it" : [ ] - } ] - } - }, - "/processors/{id}/descriptors" : { - "get" : { - "tags" : [ "processors" ], - "summary" : "Gets the descriptor for a processor property", - "description" : "", - "operationId" : "getPropertyDescriptor", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The processor id.", - "required" : true, - "type" : "string" - }, { - "name" : "propertyName", - "in" : "query", - "description" : "The property name.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/PropertyDescriptorEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /processors/{uuid}" : [ ] - } ] - } - }, - "/processors/{id}/diagnostics" : { - "get" : { - "tags" : [ "processors" ], - "summary" : "Gets diagnostics information about a processor", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getProcessorDiagnostics", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The processor id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessorEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /processors/{uuid}" : [ ] - } ] - } - }, - "/processors/{id}/run-status" : { - "put" : { - "tags" : [ "processors" ], - "summary" : "Updates run status of a processor", - "description" : "", - "operationId" : "updateRunStatus", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The processor id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The processor run status.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ProcessorRunStatusEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessorEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /processors/{uuid} or /operation/processors/{uuid}" : [ ] - } ] - } - }, - "/processors/{id}/state" : { - "get" : { - "tags" : [ "processors" ], - "summary" : "Gets the state for a processor", - "description" : "", - "operationId" : "getState", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The processor id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ComponentStateEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /processors/{uuid}" : [ ] - } ] - } - }, - "/processors/{id}/state/clear-requests" : { - "post" : { - "tags" : [ "processors" ], - "summary" : "Clears the state for a processor", - "description" : "", - "operationId" : "clearState", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The processor id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ComponentStateEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /processors/{uuid}" : [ ] - } ] - } - }, - "/processors/{id}/threads" : { - "delete" : { - "tags" : [ "processors" ], - "summary" : "Terminates a processor, essentially \"deleting\" its threads and any active tasks", - "description" : "", - "operationId" : "terminateProcessor", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The processor id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessorEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /processors/{uuid} or /operation/processors/{uuid}" : [ ] - } ] - } - }, - "/provenance" : { - "post" : { - "tags" : [ "provenance" ], - "summary" : "Submits a provenance query", - "description" : "Provenance queries may be long running so this endpoint submits a request. The response will include the current state of the query. If the request is not completed the URI in the response can be used at a later time to get the updated state of the query. Once the query has completed the provenance request should be deleted by the client who originally submitted it.", - "operationId" : "submitProvenanceRequest", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The provenance query details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ProvenanceEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProvenanceEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /provenance" : [ ] - }, { - "Read - /data/{component-type}/{uuid}" : [ ] - } ] - } - }, - "/provenance-events/replays" : { - "post" : { - "tags" : [ "provenance-events" ], - "summary" : "Replays content from a provenance event", - "description" : "", - "operationId" : "submitReplay", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The replay request.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/SubmitReplayRequestEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProvenanceEventEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read Component Provenance Data - /provenance-data/{component-type}/{uuid}" : [ ] - }, { - "Read Component Data - /data/{component-type}/{uuid}" : [ ] - }, { - "Write Component Data - /data/{component-type}/{uuid}" : [ ] - } ] - } - }, - "/provenance-events/{id}" : { - "get" : { - "tags" : [ "provenance-events" ], - "summary" : "Gets a provenance event", - "description" : "", - "operationId" : "getProvenanceEvent", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "clusterNodeId", - "in" : "query", - "description" : "The id of the node where this event exists if clustered.", - "required" : false, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The provenance event id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProvenanceEventEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read Component Provenance Data - /provenance-data/{component-type}/{uuid}" : [ ] - } ] - } - }, - "/provenance-events/{id}/content/input" : { - "get" : { - "tags" : [ "provenance-events" ], - "summary" : "Gets the input content for a provenance event", - "description" : "", - "operationId" : "getInputContent", - "consumes" : [ "*/*" ], - "produces" : [ "*/*" ], - "parameters" : [ { - "name" : "clusterNodeId", - "in" : "query", - "description" : "The id of the node where the content exists if clustered.", - "required" : false, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The provenance event id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/StreamingOutput" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read Component Provenance Data - /provenance-data/{component-type}/{uuid}" : [ ] - }, { - "Read Component Data - /data/{component-type}/{uuid}" : [ ] - } ] - } - }, - "/provenance-events/{id}/content/output" : { - "get" : { - "tags" : [ "provenance-events" ], - "summary" : "Gets the output content for a provenance event", - "description" : "", - "operationId" : "getOutputContent", - "consumes" : [ "*/*" ], - "produces" : [ "*/*" ], - "parameters" : [ { - "name" : "clusterNodeId", - "in" : "query", - "description" : "The id of the node where the content exists if clustered.", - "required" : false, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The provenance event id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/StreamingOutput" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read Component Provenance Data - /provenance-data/{component-type}/{uuid}" : [ ] - }, { - "Read Component Data - /data/{component-type}/{uuid}" : [ ] - } ] - } - }, - "/provenance/lineage" : { - "post" : { - "tags" : [ "provenance" ], - "summary" : "Submits a lineage query", - "description" : "Lineage queries may be long running so this endpoint submits a request. The response will include the current state of the query. If the request is not completed the URI in the response can be used at a later time to get the updated state of the query. Once the query has completed the lineage request should be deleted by the client who originally submitted it.", - "operationId" : "submitLineageRequest", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The lineage query details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/LineageEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/LineageEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /provenance" : [ ] - }, { - "Read - /data/{component-type}/{uuid}" : [ ] - } ] - } - }, - "/provenance/lineage/{id}" : { - "get" : { - "tags" : [ "provenance" ], - "summary" : "Gets a lineage query", - "description" : "", - "operationId" : "getLineage", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "clusterNodeId", - "in" : "query", - "description" : "The id of the node where this query exists if clustered.", - "required" : false, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The id of the lineage query.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/LineageEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /provenance" : [ ] - }, { - "Read - /data/{component-type}/{uuid}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "provenance" ], - "summary" : "Deletes a lineage query", - "description" : "", - "operationId" : "deleteLineage", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "clusterNodeId", - "in" : "query", - "description" : "The id of the node where this query exists if clustered.", - "required" : false, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The id of the lineage query.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/LineageEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /provenance" : [ ] - } ] - } - }, - "/provenance/search-options" : { - "get" : { - "tags" : [ "provenance" ], - "summary" : "Gets the searchable attributes for provenance events", - "description" : "", - "operationId" : "getSearchOptions", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProvenanceOptionsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /provenance" : [ ] - } ] - } - }, - "/provenance/{id}" : { - "get" : { - "tags" : [ "provenance" ], - "summary" : "Gets a provenance query", - "description" : "", - "operationId" : "getProvenance", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "clusterNodeId", - "in" : "query", - "description" : "The id of the node where this query exists if clustered.", - "required" : false, - "type" : "string" - }, { - "name" : "summarize", - "in" : "query", - "description" : "Whether or not incremental results are returned. If false, provenance events are only returned once the query completes. This property is true by default.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "incrementalResults", - "in" : "query", - "description" : "Whether or not to summarize provenance events returned. This property is false by default.", - "required" : false, - "type" : "boolean", - "default" : true - }, { - "name" : "id", - "in" : "path", - "description" : "The id of the provenance query.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProvenanceEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /provenance" : [ ] - }, { - "Read - /data/{component-type}/{uuid}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "provenance" ], - "summary" : "Deletes a provenance query", - "description" : "", - "operationId" : "deleteProvenance", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "clusterNodeId", - "in" : "query", - "description" : "The id of the node where this query exists if clustered.", - "required" : false, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The id of the provenance query.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProvenanceEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /provenance" : [ ] - } ] - } - }, - "/remote-process-groups/process-group/{id}/run-status" : { - "put" : { - "tags" : [ "remote-process-groups" ], - "summary" : "Updates run status of all remote process groups in a process group (recursively)", - "description" : "", - "operationId" : "updateRemoteProcessGroupRunStatuses", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The remote process groups run status.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/RemotePortRunStatusEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/RemoteProcessGroupEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /remote-process-groups/{uuid} or /operation/remote-process-groups/{uuid}" : [ ] - } ] - } - }, - "/remote-process-groups/{id}" : { - "get" : { - "tags" : [ "remote-process-groups" ], - "summary" : "Gets a remote process group", - "description" : "", - "operationId" : "getRemoteProcessGroup", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The remote process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/RemoteProcessGroupEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /remote-process-groups/{uuid}" : [ ] - } ] - }, - "put" : { - "tags" : [ "remote-process-groups" ], - "summary" : "Updates a remote process group", - "description" : "", - "operationId" : "updateRemoteProcessGroup", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The remote process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The remote process group.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/RemoteProcessGroupEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/RemoteProcessGroupEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /remote-process-groups/{uuid}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "remote-process-groups" ], - "summary" : "Deletes a remote process group", - "description" : "", - "operationId" : "removeRemoteProcessGroup", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The revision is used to verify the client is working with the latest version of the flow.", - "required" : false, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The remote process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/RemoteProcessGroupEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /remote-process-groups/{uuid}" : [ ] - }, { - "Write - Parent Process Group - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/remote-process-groups/{id}/input-ports/{port-id}" : { - "put" : { - "tags" : [ "remote-process-groups" ], - "summary" : "Updates a remote port", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "updateRemoteProcessGroupInputPort", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The remote process group id.", - "required" : true, - "type" : "string" - }, { - "name" : "port-id", - "in" : "path", - "description" : "The remote process group port id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The remote process group port.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/RemoteProcessGroupPortEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/RemoteProcessGroupPortEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /remote-process-groups/{uuid}" : [ ] - } ] - } - }, - "/remote-process-groups/{id}/input-ports/{port-id}/run-status" : { - "put" : { - "tags" : [ "remote-process-groups" ], - "summary" : "Updates run status of a remote port", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "updateRemoteProcessGroupInputPortRunStatus", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The remote process group id.", - "required" : true, - "type" : "string" - }, { - "name" : "port-id", - "in" : "path", - "description" : "The remote process group port id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The remote process group port.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/RemotePortRunStatusEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/RemoteProcessGroupPortEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /remote-process-groups/{uuid} or /operation/remote-process-groups/{uuid}" : [ ] - } ] - } - }, - "/remote-process-groups/{id}/output-ports/{port-id}" : { - "put" : { - "tags" : [ "remote-process-groups" ], - "summary" : "Updates a remote port", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "updateRemoteProcessGroupOutputPort", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The remote process group id.", - "required" : true, - "type" : "string" - }, { - "name" : "port-id", - "in" : "path", - "description" : "The remote process group port id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The remote process group port.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/RemoteProcessGroupPortEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/RemoteProcessGroupPortEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /remote-process-groups/{uuid}" : [ ] - } ] - } - }, - "/remote-process-groups/{id}/output-ports/{port-id}/run-status" : { - "put" : { - "tags" : [ "remote-process-groups" ], - "summary" : "Updates run status of a remote port", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "updateRemoteProcessGroupOutputPortRunStatus", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The remote process group id.", - "required" : true, - "type" : "string" - }, { - "name" : "port-id", - "in" : "path", - "description" : "The remote process group port id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The remote process group port.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/RemotePortRunStatusEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/RemoteProcessGroupPortEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /remote-process-groups/{uuid} or /operation/remote-process-groups/{uuid}" : [ ] - } ] - } - }, - "/remote-process-groups/{id}/run-status" : { - "put" : { - "tags" : [ "remote-process-groups" ], - "summary" : "Updates run status of a remote process group", - "description" : "", - "operationId" : "updateRemoteProcessGroupRunStatus", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The remote process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The remote process group run status.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/RemotePortRunStatusEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/RemoteProcessGroupEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /remote-process-groups/{uuid} or /operation/remote-process-groups/{uuid}" : [ ] - } ] - } - }, - "/remote-process-groups/{id}/state" : { - "get" : { - "tags" : [ "remote-process-groups" ], - "summary" : "Gets the state for a RemoteProcessGroup", - "description" : "", - "operationId" : "getState", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The processor id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ComponentStateEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /remote-process-groups/{uuid}" : [ ] - } ] - } - }, - "/reporting-tasks/{id}" : { - "get" : { - "tags" : [ "reporting-tasks" ], - "summary" : "Gets a reporting task", - "description" : "", - "operationId" : "getReportingTask", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The reporting task id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ReportingTaskEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /reporting-tasks/{uuid}" : [ ] - } ] - }, - "put" : { - "tags" : [ "reporting-tasks" ], - "summary" : "Updates a reporting task", - "description" : "", - "operationId" : "updateReportingTask", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The reporting task id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The reporting task configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ReportingTaskEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ReportingTaskEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /reporting-tasks/{uuid}" : [ ] - }, { - "Read - any referenced Controller Services if this request changes the reference - /controller-services/{uuid}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "reporting-tasks" ], - "summary" : "Deletes a reporting task", - "description" : "", - "operationId" : "removeReportingTask", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The revision is used to verify the client is working with the latest version of the flow.", - "required" : false, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The reporting task id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ReportingTaskEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /reporting-tasks/{uuid}" : [ ] - }, { - "Write - /controller" : [ ] - }, { - "Read - any referenced Controller Services - /controller-services/{uuid}" : [ ] - } ] - } - }, - "/reporting-tasks/{id}/config/analysis" : { - "post" : { - "tags" : [ "reporting-tasks" ], - "summary" : "Performs analysis of the component's configuration, providing information about which attributes are referenced.", - "description" : "", - "operationId" : "analyzeConfiguration", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The reporting task id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The configuration analysis request.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ConfigurationAnalysisEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/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. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /reporting-tasks/{uuid}" : [ ] - } ] - } - }, - "/reporting-tasks/{id}/config/verification-requests" : { - "post" : { - "tags" : [ "reporting-tasks" ], - "summary" : "Performs verification of the Reporting Task's configuration", - "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/{serviceId}/verification-requests/{requestId}. Once the request is completed, the client is expected to issue a DELETE request to /reporting-tasks/{serviceId}/verification-requests/{requestId}.", - "operationId" : "submitConfigVerificationRequest", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The reporting task id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The reporting task configuration verification request.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/VerifyConfigRequestEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/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. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /reporting-tasks/{uuid}" : [ ] - } ] - } - }, - "/reporting-tasks/{id}/config/verification-requests/{requestId}" : { - "get" : { - "tags" : [ "reporting-tasks" ], - "summary" : "Returns the Verification Request with the given ID", - "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", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The ID of the Reporting Task", - "required" : true, - "type" : "string" - }, { - "name" : "requestId", - "in" : "path", - "description" : "The ID of the Verification Request", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/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. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Only the user that submitted the request can get it" : [ ] - } ] - }, - "delete" : { - "tags" : [ "reporting-tasks" ], - "summary" : "Deletes the Verification Request with the given ID", - "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" : "deleteValidationRequest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The ID of the Reporting Task", - "required" : true, - "type" : "string" - }, { - "name" : "requestId", - "in" : "path", - "description" : "The ID of the Verification Request", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/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. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Only the user that submitted the request can remove it" : [ ] - } ] - } - }, - "/reporting-tasks/{id}/descriptors" : { - "get" : { - "tags" : [ "reporting-tasks" ], - "summary" : "Gets a reporting task property descriptor", - "description" : "", - "operationId" : "getPropertyDescriptor", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The reporting task id.", - "required" : true, - "type" : "string" - }, { - "name" : "propertyName", - "in" : "query", - "description" : "The property name.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/PropertyDescriptorEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /reporting-tasks/{uuid}" : [ ] - } ] - } - }, - "/reporting-tasks/{id}/run-status" : { - "put" : { - "tags" : [ "reporting-tasks" ], - "summary" : "Updates run status of a reporting task", - "description" : "", - "operationId" : "updateRunStatus", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The reporting task id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The reporting task run status.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ReportingTaskRunStatusEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ReportingTaskEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /reporting-tasks/{uuid} or or /operation/reporting-tasks/{uuid}" : [ ] - } ] - } - }, - "/reporting-tasks/{id}/state" : { - "get" : { - "tags" : [ "reporting-tasks" ], - "summary" : "Gets the state for a reporting task", - "description" : "", - "operationId" : "getState", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The reporting task id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ComponentStateEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /reporting-tasks/{uuid}" : [ ] - } ] - } - }, - "/reporting-tasks/{id}/state/clear-requests" : { - "post" : { - "tags" : [ "reporting-tasks" ], - "summary" : "Clears the state for a reporting task", - "description" : "", - "operationId" : "clearState", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The reporting task id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ComponentStateEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /reporting-tasks/{uuid}" : [ ] - } ] - } - }, - "/resources" : { - "get" : { - "tags" : [ "resources" ], - "summary" : "Gets the available resources that support access/authorization policies", - "description" : "", - "operationId" : "getResources", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ResourcesEntity" - } - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - } - }, - "security" : [ { - "Read - /resources" : [ ] - } ] - } - }, - "/site-to-site" : { - "get" : { - "tags" : [ "site-to-site" ], - "summary" : "Returns the details about this NiFi necessary to communicate via site to site", - "description" : "", - "operationId" : "getSiteToSiteDetails", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ControllerEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /site-to-site" : [ ] - } ] - } - }, - "/site-to-site/peers" : { - "get" : { - "tags" : [ "site-to-site" ], - "summary" : "Returns the available Peers and its status of this NiFi", - "description" : "", - "operationId" : "getPeers", - "consumes" : [ "*/*" ], - "produces" : [ "application/json", "application/xml" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/PeersEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /site-to-site" : [ ] - } ] - } - }, - "/snippets" : { - "post" : { - "tags" : [ "snippets" ], - "summary" : "Creates a snippet. The snippet will be automatically discarded if not used in a subsequent request after 1 minute.", - "description" : "", - "operationId" : "createSnippet", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The snippet configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/SnippetEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/SnippetEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read or Write - /{component-type}/{uuid} - For every component (all Read or all Write) in the Snippet and their descendant components" : [ ] - } ] - } - }, - "/snippets/{id}" : { - "put" : { - "tags" : [ "snippets" ], - "summary" : "Move's the components in this Snippet into a new Process Group and discards the snippet", - "description" : "", - "operationId" : "updateSnippet", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The snippet id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The snippet configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/SnippetEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/SnippetEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write Process Group - /process-groups/{uuid}" : [ ] - }, { - "Write - /{component-type}/{uuid} - For each component in the Snippet and their descendant components" : [ ] - } ] - }, - "delete" : { - "tags" : [ "snippets" ], - "summary" : "Deletes the components in a snippet and discards the snippet", - "description" : "", - "operationId" : "deleteSnippet", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The snippet id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/SnippetEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /{component-type}/{uuid} - For each component in the Snippet and their descendant components" : [ ] - }, { - "Write - Parent Process Group - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/system-diagnostics" : { - "get" : { - "tags" : [ "system-diagnostics" ], - "summary" : "Gets the diagnostics for the system NiFi is running on", - "description" : "", - "operationId" : "getSystemDiagnostics", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "nodewise", - "in" : "query", - "description" : "Whether or not to include the breakdown per node. Optional, defaults to false", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "clusterNodeId", - "in" : "query", - "description" : "The id of the node where to get the status.", - "required" : false, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/SystemDiagnosticsEntity" - } - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - } - }, - "security" : [ { - "Read - /system" : [ ] - } ] - } - }, - "/templates/{id}" : { - "delete" : { - "tags" : [ "templates" ], - "summary" : "Deletes a template", - "description" : "", - "operationId" : "removeTemplate", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The template id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/TemplateEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /templates/{uuid}" : [ ] - }, { - "Write - Parent Process Group - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/templates/{id}/download" : { - "get" : { - "tags" : [ "templates" ], - "summary" : "Exports a template", - "description" : "", - "operationId" : "exportTemplate", - "consumes" : [ "*/*" ], - "produces" : [ "application/xml" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The template id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /templates/{uuid}" : [ ] - } ] - } - }, - "/tenants/search-results" : { - "get" : { - "tags" : [ "tenants" ], - "summary" : "Searches for a tenant with the specified identity", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "searchTenants", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "q", - "in" : "query", - "description" : "Identity to search for.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/TenantsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /tenants" : [ ] - } ] - } - }, - "/tenants/user-groups" : { - "get" : { - "tags" : [ "tenants" ], - "summary" : "Gets all user groups", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getUserGroups", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/UserGroupsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /tenants" : [ ] - } ] - }, - "post" : { - "tags" : [ "tenants" ], - "summary" : "Creates a user group", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "createUserGroup", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The user group configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/UserGroupEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/UserGroupEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /tenants" : [ ] - } ] - } - }, - "/tenants/user-groups/{id}" : { - "get" : { - "tags" : [ "tenants" ], - "summary" : "Gets a user group", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getUserGroup", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The user group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/UserGroupEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /tenants" : [ ] - } ] - }, - "put" : { - "tags" : [ "tenants" ], - "summary" : "Updates a user group", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "updateUserGroup", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The user group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The user group configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/UserGroupEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/UserGroupEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /tenants" : [ ] - } ] - }, - "delete" : { - "tags" : [ "tenants" ], - "summary" : "Deletes a user group", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "removeUserGroup", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The revision is used to verify the client is working with the latest version of the flow.", - "required" : false, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The user group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/UserGroupEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /tenants" : [ ] - } ] - } - }, - "/tenants/users" : { - "get" : { - "tags" : [ "tenants" ], - "summary" : "Gets all users", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getUsers", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/UsersEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /tenants" : [ ] - } ] - }, - "post" : { - "tags" : [ "tenants" ], - "summary" : "Creates a user", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "createUser", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The user configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/UserEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/UserEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /tenants" : [ ] - } ] - } - }, - "/tenants/users/{id}" : { - "get" : { - "tags" : [ "tenants" ], - "summary" : "Gets a user", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getUser", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The user id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/UserEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /tenants" : [ ] - } ] - }, - "put" : { - "tags" : [ "tenants" ], - "summary" : "Updates a user", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "updateUser", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The user id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The user configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/UserEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/UserEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /tenants" : [ ] - } ] - }, - "delete" : { - "tags" : [ "tenants" ], - "summary" : "Deletes a user", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "removeUser", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The revision is used to verify the client is working with the latest version of the flow.", - "required" : false, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The user id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/UserEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /tenants" : [ ] - } ] - } - }, - "/versions/active-requests" : { - "post" : { - "tags" : [ "versions" ], - "summary" : "Create a version control request", - "description" : "Creates a request so that a Process Group can be placed under Version Control or have its Version Control configuration changed. Creating this request will prevent any other threads from simultaneously saving local changes to Version Control. It will not, however, actually save the local flow to the Flow Registry. A POST to /versions/process-groups/{id} should be used to initiate saving of the local flow to the Flow Registry. Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "createVersionControlRequest", - "consumes" : [ "application/json" ], - "produces" : [ "text/plain" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The versioned flow details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/CreateActiveRequestEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/versions/active-requests/{id}" : { - "put" : { - "tags" : [ "versions" ], - "summary" : "Updates the request with the given ID", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "updateVersionControlRequest", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The request ID.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The version control component mapping.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/VersionControlComponentMappingEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionControlInformationEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Only the user that submitted the request can update it" : [ ] - } ] - }, - "delete" : { - "tags" : [ "versions" ], - "summary" : "Deletes the version control request with the given ID", - "description" : "Deletes the Version Control Request with the given ID. This will allow other threads to save flows to the Flow Registry. See also the documentation for POSTing to /versions/active-requests for information regarding why this is done. Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "deleteVersionControlRequest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The request ID.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Only the user that submitted the request can remove it" : [ ] - } ] - } - }, - "/versions/process-groups/{id}" : { - "get" : { - "tags" : [ "versions" ], - "summary" : "Gets the Version Control information for a process group", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getVersionInformation", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionControlInformationEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - } ] - }, - "post" : { - "tags" : [ "versions" ], - "summary" : "Save the Process Group with the given ID", - "description" : "Begins version controlling the Process Group with the given ID or commits changes to the Versioned Flow, depending on if the provided VersionControlInformation includes a flowId. Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "saveToFlowRegistry", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The versioned flow details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/StartVersionControlRequestEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionControlInformationEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - }, { - "Write - /process-groups/{uuid}" : [ ] - }, { - "Read - /{component-type}/{uuid} - For all encapsulated components" : [ ] - }, { - "Read - any referenced Controller Services by any encapsulated components - /controller-services/{uuid}" : [ ] - } ] - }, - "put" : { - "tags" : [ "versions" ], - "summary" : "Update the version of a Process Group with the given ID", - "description" : "For a Process Group that is already under Version Control, this will update the version of the flow to a different version. This endpoint expects that the given snapshot will not modify any Processor that is currently running or any Controller Service that is enabled. Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "updateFlowVersion", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The controller service configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/VersionedFlowSnapshotEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionControlInformationEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - }, { - "Write - /process-groups/{uuid}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "versions" ], - "summary" : "Stops version controlling the Process Group with the given ID", - "description" : "Stops version controlling the Process Group with the given ID. The Process Group will no longer track to any Versioned Flow. Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "stopVersionControl", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The version is used to verify the client is working with the latest version of the flow.", - "required" : false, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, a new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionControlInformationEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - }, { - "Write - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/versions/process-groups/{id}/download" : { - "get" : { - "tags" : [ "versions" ], - "summary" : "Gets the latest version of a Process Group for download", - "description" : "", - "operationId" : "exportFlowVersion", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/versions/revert-requests/process-groups/{id}" : { - "post" : { - "tags" : [ "versions" ], - "summary" : "Initiate the Revert Request of a Process Group with the given ID", - "description" : "For a Process Group that is already under Version Control, this will initiate the action of reverting any local changes that have been made to the Process Group since it was last synchronized with the Flow Registry. This will result in the flow matching the Versioned Flow that exists in the Flow Registry. This can be a lengthy process, as it will stop any Processors and disable any Controller Services necessary to perform the action and then restart them. As a result, the endpoint will immediately return a VersionedFlowUpdateRequestEntity, and the process of updating the flow will occur asynchronously in the background. The client may then periodically poll the status of the request by issuing a GET request to /versions/revert-requests/{requestId}. Once the request is completed, the client is expected to issue a DELETE request to /versions/revert-requests/{requestId}. Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "initiateRevertFlowVersion", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The controller service configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/VersionControlInformationEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlowUpdateRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - }, { - "Write - /process-groups/{uuid}" : [ ] - }, { - "Read - /{component-type}/{uuid} - For all encapsulated components" : [ ] - }, { - "Write - /{component-type}/{uuid} - For all encapsulated components" : [ ] - }, { - "Write - if the template contains any restricted components - /restricted-components" : [ ] - }, { - "Read - /parameter-contexts/{uuid} - For any Parameter Context that is referenced by a Property that is changed, added, or removed" : [ ] - } ] - } - }, - "/versions/revert-requests/{id}" : { - "get" : { - "tags" : [ "versions" ], - "summary" : "Returns the Revert Request with the given ID", - "description" : "Returns the Revert Request with the given ID. Once a Revert Request has been created by performing a POST to /versions/revert-requests/process-groups/{id}, that request can subsequently be retrieved via this endpoint, and the request that is fetched will contain the updated state, such as percent complete, the current state of the request, and any failures. Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getRevertRequest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The ID of the Revert Request", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlowUpdateRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Only the user that submitted the request can get it" : [ ] - } ] - }, - "delete" : { - "tags" : [ "versions" ], - "summary" : "Deletes the Revert Request with the given ID", - "description" : "Deletes the Revert Request with the given ID. After a request is created via a POST to /versions/revert-requests/process-groups/{id}, it is expected that the client will properly clean up the request by DELETE'ing it, once the Revert process has completed. If the request is deleted before the request completes, then the Revert request will finish the step that it is currently performing and then will cancel any subsequent steps. Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "deleteRevertRequest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The ID of the Revert Request", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlowUpdateRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Only the user that submitted the request can remove it" : [ ] - } ] - } - }, - "/versions/update-requests/process-groups/{id}" : { - "post" : { - "tags" : [ "versions" ], - "summary" : "Initiate the Update Request of a Process Group with the given ID", - "description" : "For a Process Group that is already under Version Control, this will initiate the action of changing from a specific version of the flow in the Flow Registry to a different version of the flow. This can be a lengthy process, as it will stop any Processors and disable any Controller Services necessary to perform the action and then restart them. As a result, the endpoint will immediately return a VersionedFlowUpdateRequestEntity, and the process of updating the flow will occur asynchronously in the background. The client may then periodically poll the status of the request by issuing a GET request to /versions/update-requests/{requestId}. Once the request is completed, the client is expected to issue a DELETE request to /versions/update-requests/{requestId}. Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "initiateVersionControlUpdate", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The controller service configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/VersionControlInformationEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlowUpdateRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - }, { - "Write - /process-groups/{uuid}" : [ ] - }, { - "Read - /{component-type}/{uuid} - For all encapsulated components" : [ ] - }, { - "Write - /{component-type}/{uuid} - For all encapsulated components" : [ ] - }, { - "Write - if the template contains any restricted components - /restricted-components" : [ ] - }, { - "Read - /parameter-contexts/{uuid} - For any Parameter Context that is referenced by a Property that is changed, added, or removed" : [ ] - } ] - } - }, - "/versions/update-requests/{id}" : { - "get" : { - "tags" : [ "versions" ], - "summary" : "Returns the Update Request with the given ID", - "description" : "Returns the Update Request with the given ID. Once an Update Request has been created by performing a POST to /versions/update-requests/process-groups/{id}, that request can subsequently be retrieved via this endpoint, and the request that is fetched will contain the updated state, such as percent complete, the current state of the request, and any failures. Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getUpdateRequest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The ID of the Update Request", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlowUpdateRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Only the user that submitted the request can get it" : [ ] - } ] - }, - "delete" : { - "tags" : [ "versions" ], - "summary" : "Deletes the Update Request with the given ID", - "description" : "Deletes the Update Request with the given ID. After a request is created via a POST to /versions/update-requests/process-groups/{id}, it is expected that the client will properly clean up the request by DELETE'ing it, once the Update process has completed. If the request is deleted before the request completes, then the Update request will finish the step that it is currently performing and then will cancel any subsequent steps. Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "deleteUpdateRequest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The ID of the Update Request", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlowUpdateRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Only the user that submitted the request can remove it" : [ ] - } ] - } - } - }, - "definitions" : { - "AboutDTO" : { - "type" : "object", - "properties" : { - "title" : { - "type" : "string", - "description" : "The title to be used on the page and in the about dialog." - }, - "version" : { - "type" : "string", - "description" : "The version of this NiFi." - }, - "uri" : { - "type" : "string", - "description" : "The URI for the NiFi." - }, - "contentViewerUrl" : { - "type" : "string", - "description" : "The URL for the content viewer if configured." - }, - "timezone" : { - "type" : "string", - "description" : "The timezone of the NiFi instance." - }, - "buildTag" : { - "type" : "string", - "description" : "Build tag" - }, - "buildRevision" : { - "type" : "string", - "description" : "Build revision or commit hash" - }, - "buildBranch" : { - "type" : "string", - "description" : "Build branch" - }, - "buildTimestamp" : { - "type" : "string", - "description" : "Build timestamp" - } - } - }, - "AboutEntity" : { - "type" : "object", - "properties" : { - "about" : { - "$ref" : "#/definitions/AboutDTO" - } - }, - "xml" : { - "name" : "aboutEntity" - } - }, - "AccessConfigurationDTO" : { - "type" : "object", - "properties" : { - "supportsLogin" : { - "type" : "boolean", - "description" : "Indicates whether or not this NiFi supports user login." - } - } - }, - "AccessConfigurationEntity" : { - "type" : "object", - "properties" : { - "config" : { - "$ref" : "#/definitions/AccessConfigurationDTO" - } - }, - "xml" : { - "name" : "accessConfigurationEntity" - } - }, - "AccessPolicyDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "versionedComponentId" : { - "type" : "string", - "description" : "The ID of the corresponding component that is under version control" - }, - "parentGroupId" : { - "type" : "string", - "description" : "The id of parent process group of this component if applicable." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "resource" : { - "type" : "string", - "description" : "The resource for this access policy." - }, - "action" : { - "type" : "string", - "description" : "The action associated with this access policy.", - "enum" : [ "read", "write" ] - }, - "componentReference" : { - "description" : "Component this policy references if applicable.", - "$ref" : "#/definitions/ComponentReferenceEntity" - }, - "configurable" : { - "type" : "boolean", - "description" : "Whether this policy is configurable." - }, - "users" : { - "type" : "array", - "description" : "The set of user IDs associated with this access policy.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/TenantEntity" - } - }, - "userGroups" : { - "type" : "array", - "description" : "The set of user group IDs associated with this access policy.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/TenantEntity" - } - } - } - }, - "AccessPolicyEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "generated" : { - "type" : "string", - "description" : "When this content was generated." - }, - "component" : { - "$ref" : "#/definitions/AccessPolicyDTO" - } - }, - "xml" : { - "name" : "accessPolicyEntity" - } - }, - "AccessPolicySummaryDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "versionedComponentId" : { - "type" : "string", - "description" : "The ID of the corresponding component that is under version control" - }, - "parentGroupId" : { - "type" : "string", - "description" : "The id of parent process group of this component if applicable." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "resource" : { - "type" : "string", - "description" : "The resource for this access policy." - }, - "action" : { - "type" : "string", - "description" : "The action associated with this access policy.", - "enum" : [ "read", "write" ] - }, - "componentReference" : { - "description" : "Component this policy references if applicable.", - "$ref" : "#/definitions/ComponentReferenceEntity" - }, - "configurable" : { - "type" : "boolean", - "description" : "Whether this policy is configurable." - } - } - }, - "AccessPolicySummaryEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "component" : { - "$ref" : "#/definitions/AccessPolicySummaryDTO" - } - }, - "xml" : { - "name" : "accessPolicySummaryEntity" - } - }, - "AccessStatusDTO" : { - "type" : "object", - "properties" : { - "identity" : { - "type" : "string", - "description" : "The user identity." - }, - "status" : { - "type" : "string", - "description" : "The user access status." - }, - "message" : { - "type" : "string", - "description" : "Additional details about the user access status." - } - }, - "xml" : { - "name" : "accessStatus" - } - }, - "AccessStatusEntity" : { - "type" : "object", - "properties" : { - "accessStatus" : { - "$ref" : "#/definitions/AccessStatusDTO" - } - }, - "xml" : { - "name" : "accessStatusEntity" - } - }, - "ActionDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "integer", - "format" : "int32", - "description" : "The action id." - }, - "userIdentity" : { - "type" : "string", - "description" : "The identity of the user that performed the action." - }, - "timestamp" : { - "type" : "string", - "description" : "The timestamp of the action." - }, - "sourceId" : { - "type" : "string", - "description" : "The id of the source component." - }, - "sourceName" : { - "type" : "string", - "description" : "The name of the source component." - }, - "sourceType" : { - "type" : "string", - "description" : "The type of the source component." - }, - "componentDetails" : { - "description" : "The details of the source component.", - "$ref" : "#/definitions/ComponentDetailsDTO" - }, - "operation" : { - "type" : "string", - "description" : "The operation that was performed." - }, - "actionDetails" : { - "description" : "The details of the action.", - "$ref" : "#/definitions/ActionDetailsDTO" - } - } - }, - "ActionDetailsDTO" : { - "type" : "object" - }, - "ActionEntity" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "integer", - "format" : "int32" - }, - "timestamp" : { - "type" : "string", - "description" : "The timestamp of the action." - }, - "sourceId" : { - "type" : "string" - }, - "canRead" : { - "type" : "boolean", - "description" : "Indicates whether the user can read a given resource." - }, - "action" : { - "$ref" : "#/definitions/ActionDTO" - } - }, - "xml" : { - "name" : "actionEntity" - } - }, - "ActivateControllerServicesEntity" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the ProcessGroup" - }, - "state" : { - "type" : "string", - "description" : "The desired state of the descendant components", - "enum" : [ "ENABLED", "DISABLED" ] - }, - "components" : { - "type" : "object", - "description" : "Optional services to schedule. If not specified, all authorized descendant controller services will be used.", - "additionalProperties" : { - "$ref" : "#/definitions/RevisionDTO" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - } - }, - "xml" : { - "name" : "activateControllerServicesEntity" - } - }, - "AffectedComponentDTO" : { - "type" : "object", - "properties" : { - "processGroupId" : { - "type" : "string", - "description" : "The UUID of the Process Group that this component is in" - }, - "id" : { - "type" : "string", - "description" : "The UUID of this component" - }, - "referenceType" : { - "type" : "string", - "description" : "The type of this component", - "enum" : [ "PROCESSOR", "CONTROLLER_SERVICE", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT" ] - }, - "name" : { - "type" : "string", - "description" : "The name of this component." - }, - "state" : { - "type" : "string", - "description" : "The scheduled state of a processor or reporting task referencing a controller service. If this component is another controller service, this field represents the controller service state." - }, - "activeThreadCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of active threads for the referencing component." - }, - "validationErrors" : { - "type" : "array", - "description" : "The validation errors for the component.", - "items" : { - "type" : "string" - } - } - } - }, - "AffectedComponentEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "component" : { - "$ref" : "#/definitions/AffectedComponentDTO" - }, - "processGroup" : { - "description" : "The Process Group that the component belongs to", - "$ref" : "#/definitions/ProcessGroupNameDTO" - }, - "referenceType" : { - "type" : "string", - "description" : "The type of component referenced", - "enum" : [ "PROCESSOR", "CONTROLLER_SERVICE", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT" ] - } - }, - "xml" : { - "name" : "affectedComponentEntity" - } - }, - "AllowableValueDTO" : { - "type" : "object", - "properties" : { - "displayName" : { - "type" : "string", - "description" : "A human readable value that is allowed for the property descriptor." - }, - "value" : { - "type" : "string", - "description" : "A value that is allowed for the property descriptor." - }, - "description" : { - "type" : "string", - "description" : "A description for this allowable value." - } - } - }, - "AllowableValueEntity" : { - "type" : "object", - "properties" : { - "allowableValue" : { - "$ref" : "#/definitions/AllowableValueDTO" - }, - "canRead" : { - "type" : "boolean", - "description" : "Indicates whether the user can read a given resource." - } - }, - "xml" : { - "name" : "entity" - } - }, - "AttributeDTO" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The attribute name." - }, - "value" : { - "type" : "string", - "description" : "The attribute value." - }, - "previousValue" : { - "type" : "string", - "description" : "The value of the attribute before the event took place." - } - } - }, - "BannerDTO" : { - "type" : "object", - "properties" : { - "headerText" : { - "type" : "string", - "description" : "The header text." - }, - "footerText" : { - "type" : "string", - "description" : "The footer text." - } - } - }, - "BannerEntity" : { - "type" : "object", - "properties" : { - "banners" : { - "$ref" : "#/definitions/BannerDTO" - } - }, - "xml" : { - "name" : "bannersEntity" - } - }, - "BatchSettingsDTO" : { - "type" : "object", - "properties" : { - "count" : { - "type" : "integer", - "format" : "int32", - "description" : "Preferred number of flow files to include in a transaction." - }, - "size" : { - "type" : "string", - "description" : "Preferred number of bytes to include in a transaction." - }, - "duration" : { - "type" : "string", - "description" : "Preferred amount of time that a transaction should span." - } - } - }, - "BatchSize" : { - "type" : "object", - "properties" : { - "count" : { - "type" : "integer", - "format" : "int32", - "description" : "Preferred number of flow files to include in a transaction." - }, - "size" : { - "type" : "string", - "description" : "Preferred number of bytes to include in a transaction." - }, - "duration" : { - "type" : "string", - "description" : "Preferred amount of time that a transaction should span." - } - } - }, - "Bucket" : { - "type" : "object", - "required" : [ "name" ], - "properties" : { - "link" : { - "description" : "An WebLink to this entity.", - "readOnly" : true, - "$ref" : "#/definitions/JaxbLink" - }, - "identifier" : { - "type" : "string", - "description" : "An ID to uniquely identify this object.", - "readOnly" : true - }, - "name" : { - "type" : "string", - "description" : "The name of the bucket." - }, - "createdTimestamp" : { - "type" : "integer", - "format" : "int64", - "description" : "The timestamp of when the bucket was first created. This is set by the server at creation time.", - "readOnly" : true, - "minimum" : 1 - }, - "description" : { - "type" : "string", - "description" : "A description of the bucket." - }, - "allowBundleRedeploy" : { - "type" : "boolean", - "description" : "Indicates if this bucket allows the same version of an extension bundle to be redeployed and thus overwrite the existing artifact. By default this is false." - }, - "allowPublicRead" : { - "type" : "boolean", - "description" : "Indicates if this bucket allows read access to unauthenticated anonymous users" - }, - "permissions" : { - "description" : "The access that the current user has to this bucket.", - "readOnly" : true, - "$ref" : "#/definitions/Permissions" - }, - "revision" : { - "description" : "The revision of this entity used for optimistic-locking during updates.", - "readOnly" : true, - "$ref" : "#/definitions/RevisionInfo" - } - } - }, - "BucketDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The bucket identifier" - }, - "name" : { - "type" : "string", - "description" : "The bucket name" - }, - "description" : { - "type" : "string", - "description" : "The bucket description" - }, - "created" : { - "type" : "integer", - "format" : "int64", - "description" : "The created timestamp of this bucket" - } - } - }, - "BucketEntity" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string" - }, - "bucket" : { - "$ref" : "#/definitions/BucketDTO" - }, - "permissions" : { - "$ref" : "#/definitions/PermissionsDTO" - } - }, - "xml" : { - "name" : "bucketEntity" - } - }, - "BucketsEntity" : { - "type" : "object", - "properties" : { - "buckets" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/BucketEntity" - } - } - }, - "xml" : { - "name" : "bucketsEntity" - } - }, - "BulletinBoardDTO" : { - "type" : "object", - "properties" : { - "bulletins" : { - "type" : "array", - "description" : "The bulletins in the bulletin board, that matches the supplied request.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "generated" : { - "type" : "string", - "description" : "The timestamp when this report was generated." - } - } - }, - "BulletinBoardEntity" : { - "type" : "object", - "properties" : { - "bulletinBoard" : { - "$ref" : "#/definitions/BulletinBoardDTO" - } - }, - "xml" : { - "name" : "bulletinBoardEntity" - } - }, - "BulletinDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "integer", - "format" : "int64", - "description" : "The id of the bulletin." - }, - "nodeAddress" : { - "type" : "string", - "description" : "If clustered, the address of the node from which the bulletin originated." - }, - "category" : { - "type" : "string", - "description" : "The category of this bulletin." - }, - "groupId" : { - "type" : "string", - "description" : "The group id of the source component." - }, - "sourceId" : { - "type" : "string", - "description" : "The id of the source component." - }, - "sourceName" : { - "type" : "string", - "description" : "The name of the source component." - }, - "level" : { - "type" : "string", - "description" : "The level of the bulletin." - }, - "message" : { - "type" : "string", - "description" : "The bulletin message." - }, - "timestamp" : { - "type" : "string", - "description" : "When this bulletin was generated." - } - } - }, - "BulletinEntity" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "integer", - "format" : "int64" - }, - "groupId" : { - "type" : "string" - }, - "sourceId" : { - "type" : "string" - }, - "timestamp" : { - "type" : "string", - "description" : "When this bulletin was generated." - }, - "nodeAddress" : { - "type" : "string" - }, - "canRead" : { - "type" : "boolean", - "description" : "Indicates whether the user can read a given resource." - }, - "bulletin" : { - "$ref" : "#/definitions/BulletinDTO" - } - }, - "xml" : { - "name" : "bulletinEntity" - } - }, - "Bundle" : { - "type" : "object", - "properties" : { - "group" : { - "type" : "string", - "description" : "The group of the bundle" - }, - "artifact" : { - "type" : "string", - "description" : "The artifact of the bundle" - }, - "version" : { - "type" : "string", - "description" : "The version of the bundle" - } - } - }, - "BundleDTO" : { - "type" : "object", - "properties" : { - "group" : { - "type" : "string", - "description" : "The group of the bundle." - }, - "artifact" : { - "type" : "string", - "description" : "The artifact of the bundle." - }, - "version" : { - "type" : "string", - "description" : "The version of the bundle." - } - } - }, - "ClassLoaderDiagnosticsDTO" : { - "type" : "object", - "properties" : { - "bundle" : { - "description" : "Information about the Bundle that the ClassLoader belongs to, if any", - "$ref" : "#/definitions/BundleDTO" - }, - "parentClassLoader" : { - "description" : "A ClassLoaderDiagnosticsDTO that provides information about the parent ClassLoader", - "$ref" : "#/definitions/ClassLoaderDiagnosticsDTO" - } - } - }, - "ClusteSummaryEntity" : { - "type" : "object", - "properties" : { - "clusterSummary" : { - "$ref" : "#/definitions/ClusterSummaryDTO" - } - }, - "xml" : { - "name" : "clusterSummaryEntity" - } - }, - "ClusterDTO" : { - "type" : "object", - "properties" : { - "nodes" : { - "type" : "array", - "description" : "The collection of nodes that are part of the cluster.", - "items" : { - "$ref" : "#/definitions/NodeDTO" - } - }, - "generated" : { - "type" : "string", - "description" : "The timestamp the report was generated." - } - } - }, - "ClusterEntity" : { - "type" : "object", - "properties" : { - "cluster" : { - "$ref" : "#/definitions/ClusterDTO" - } - }, - "xml" : { - "name" : "clusterEntity" - } - }, - "ClusterSearchResultsEntity" : { - "type" : "object", - "properties" : { - "nodeResults" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/NodeSearchResultDTO" - } - } - }, - "xml" : { - "name" : "clusterSearchResultsEntity" - } - }, - "ClusterSummaryDTO" : { - "type" : "object", - "properties" : { - "connectedNodes" : { - "type" : "string", - "description" : "When clustered, reports the number of nodes connected vs the number of nodes in the cluster." - }, - "connectedNodeCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of nodes that are currently connected to the cluster" - }, - "totalNodeCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of nodes in the cluster, regardless of whether or not they are connected" - }, - "connectedToCluster" : { - "type" : "boolean", - "description" : "Whether this NiFi instance is connected to a cluster." - }, - "clustered" : { - "type" : "boolean", - "description" : "Whether this NiFi instance is clustered." - } - } - }, - "ComponentDetailsDTO" : { - "type" : "object" - }, - "ComponentDifferenceDTO" : { - "type" : "object", - "properties" : { - "componentType" : { - "type" : "string", - "description" : "The type of component" - }, - "componentId" : { - "type" : "string", - "description" : "The ID of the component" - }, - "componentName" : { - "type" : "string", - "description" : "The name of the component" - }, - "processGroupId" : { - "type" : "string", - "description" : "The ID of the Process Group that the component belongs to" - }, - "differences" : { - "type" : "array", - "description" : "The differences in the component between the two flows", - "items" : { - "$ref" : "#/definitions/DifferenceDTO" - } - } - } - }, - "ComponentHistoryDTO" : { - "type" : "object", - "properties" : { - "componentId" : { - "type" : "string", - "description" : "The component id." - }, - "propertyHistory" : { - "type" : "object", - "description" : "The history for the properties of the component.", - "additionalProperties" : { - "$ref" : "#/definitions/PropertyHistoryDTO" - } - } - } - }, - "ComponentHistoryEntity" : { - "type" : "object", - "properties" : { - "componentHistory" : { - "$ref" : "#/definitions/ComponentHistoryDTO" - } - }, - "xml" : { - "name" : "componentHistoryEntity" - } - }, - "ComponentReferenceDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "versionedComponentId" : { - "type" : "string", - "description" : "The ID of the corresponding component that is under version control" - }, - "parentGroupId" : { - "type" : "string", - "description" : "The id of parent process group of this component if applicable." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "name" : { - "type" : "string", - "description" : "The name of the component." - } - } - }, - "ComponentReferenceEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "parentGroupId" : { - "type" : "string", - "description" : "The id of parent process group of this component if applicable." - }, - "component" : { - "$ref" : "#/definitions/ComponentReferenceDTO" - } - }, - "xml" : { - "name" : "componentReferenceEntity" - } - }, - "ComponentRestrictionPermissionDTO" : { - "type" : "object", - "properties" : { - "requiredPermission" : { - "description" : "The required permission necessary for this restriction.", - "$ref" : "#/definitions/RequiredPermissionDTO" - }, - "permissions" : { - "description" : "The permissions for this component restriction. Note: the read permission are not used and will always be false.", - "$ref" : "#/definitions/PermissionsDTO" - } - } - }, - "ComponentSearchResultDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component that matched the search." - }, - "groupId" : { - "type" : "string", - "description" : "The group id of the component that matched the search." - }, - "parentGroup" : { - "description" : "The parent group of the component that matched the search.", - "$ref" : "#/definitions/SearchResultGroupDTO" - }, - "versionedGroup" : { - "description" : "The nearest versioned ancestor group of the component that matched the search.", - "$ref" : "#/definitions/SearchResultGroupDTO" - }, - "name" : { - "type" : "string", - "description" : "The name of the component that matched the search." - }, - "matches" : { - "type" : "array", - "description" : "What matched the search from the component.", - "items" : { - "type" : "string" - } - } - } - }, - "ComponentStateDTO" : { - "type" : "object", - "properties" : { - "componentId" : { - "type" : "string", - "description" : "The component identifier." - }, - "stateDescription" : { - "type" : "string", - "description" : "Description of the state this component persists." - }, - "clusterState" : { - "description" : "The cluster state for this component, or null if this NiFi is a standalone instance.", - "$ref" : "#/definitions/StateMapDTO" - }, - "localState" : { - "description" : "The local state for this component.", - "$ref" : "#/definitions/StateMapDTO" - } - } - }, - "ComponentStateEntity" : { - "type" : "object", - "properties" : { - "componentState" : { - "description" : "The component state.", - "$ref" : "#/definitions/ComponentStateDTO" - } - }, - "xml" : { - "name" : "componentStateEntity" - } - }, - "ComponentValidationResultDTO" : { - "type" : "object", - "properties" : { - "processGroupId" : { - "type" : "string", - "description" : "The UUID of the Process Group that this component is in" - }, - "id" : { - "type" : "string", - "description" : "The UUID of this component" - }, - "referenceType" : { - "type" : "string", - "description" : "The type of this component", - "enum" : [ "PROCESSOR", "CONTROLLER_SERVICE", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT" ] - }, - "name" : { - "type" : "string", - "description" : "The name of this component." - }, - "state" : { - "type" : "string", - "description" : "The scheduled state of a processor or reporting task referencing a controller service. If this component is another controller service, this field represents the controller service state." - }, - "activeThreadCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of active threads for the referencing component." - }, - "validationErrors" : { - "type" : "array", - "description" : "The validation errors for the component.", - "items" : { - "type" : "string" - } - }, - "currentlyValid" : { - "type" : "boolean", - "description" : "Whether or not the component is currently valid" - }, - "resultsValid" : { - "type" : "boolean", - "description" : "Whether or not the component will be valid if the Parameter Context is changed" - }, - "resultantValidationErrors" : { - "type" : "array", - "description" : "The validation errors that will apply to the component if the Parameter Context is changed", - "items" : { - "type" : "string" - } - } - } - }, - "ComponentValidationResultEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "component" : { - "$ref" : "#/definitions/ComponentValidationResultDTO" - } - }, - "xml" : { - "name" : "componentValidationResultEntity" - } - }, - "ComponentValidationResultsEntity" : { - "type" : "object", - "properties" : { - "validationResults" : { - "type" : "array", - "description" : "A List of ComponentValidationResultEntity, one for each component that is validated", - "items" : { - "$ref" : "#/definitions/ComponentValidationResultEntity" - } - } - }, - "xml" : { - "name" : "componentValidationResults" - } - }, - "ConfigVerificationResultDTO" : { - "type" : "object", - "properties" : { - "outcome" : { - "type" : "string", - "description" : "The outcome of the verification", - "enum" : [ "SUCCESSFUL", "FAILED", "SKIPPED" ] - }, - "verificationStepName" : { - "type" : "string", - "description" : "The name of the verification step" - }, - "explanation" : { - "type" : "string", - "description" : "An explanation of why the step was or was not successful" - } - } - }, - "ConfigurationAnalysisDTO" : { - "type" : "object", - "properties" : { - "componentId" : { - "type" : "string", - "description" : "The ID of the component" - }, - "properties" : { - "type" : "object", - "description" : "The configured properties for the component", - "additionalProperties" : { - "type" : "string" - } - }, - "referencedAttributes" : { - "type" : "object", - "description" : "The attributes that are referenced by the properties, mapped to recently used values", - "additionalProperties" : { - "type" : "string" - } - }, - "supportsVerification" : { - "type" : "boolean", - "description" : "Whether or not the component supports verification" - } - } - }, - "ConfigurationAnalysisEntity" : { - "type" : "object", - "properties" : { - "configurationAnalysis" : { - "description" : "The configuration analysis", - "$ref" : "#/definitions/ConfigurationAnalysisDTO" - } - }, - "xml" : { - "name" : "configurationAnalysis" - } - }, - "ConnectableComponent" : { - "type" : "object", - "required" : [ "groupId", "id", "type" ], - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the connectable component." - }, - "type" : { - "type" : "string", - "description" : "The type of component the connectable is.", - "enum" : [ "PROCESSOR", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "INPUT_PORT", "OUTPUT_PORT", "FUNNEL" ] - }, - "groupId" : { - "type" : "string", - "description" : "The id of the group that the connectable component resides in" - }, - "name" : { - "type" : "string", - "description" : "The name of the connectable component" - }, - "comments" : { - "type" : "string", - "description" : "The comments for the connectable component." - } - } - }, - "ConnectableDTO" : { - "type" : "object", - "required" : [ "groupId", "id", "type" ], - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the connectable component." - }, - "versionedComponentId" : { - "type" : "string", - "description" : "The ID of the corresponding component that is under version control" - }, - "type" : { - "type" : "string", - "description" : "The type of component the connectable is.", - "enum" : [ "PROCESSOR", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "INPUT_PORT", "OUTPUT_PORT", "FUNNEL" ] - }, - "groupId" : { - "type" : "string", - "description" : "The id of the group that the connectable component resides in" - }, - "name" : { - "type" : "string", - "description" : "The name of the connectable component" - }, - "running" : { - "type" : "boolean", - "description" : "Reflects the current state of the connectable component." - }, - "transmitting" : { - "type" : "boolean", - "description" : "If the connectable component represents a remote port, indicates if the target is configured to transmit." - }, - "exists" : { - "type" : "boolean", - "description" : "If the connectable component represents a remote port, indicates if the target exists." - }, - "comments" : { - "type" : "string", - "description" : "The comments for the connectable component." - } - } - }, - "ConnectionDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "versionedComponentId" : { - "type" : "string", - "description" : "The ID of the corresponding component that is under version control" - }, - "parentGroupId" : { - "type" : "string", - "description" : "The id of parent process group of this component if applicable." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "source" : { - "description" : "The source of the connection.", - "$ref" : "#/definitions/ConnectableDTO" - }, - "destination" : { - "description" : "The destination of the connection.", - "$ref" : "#/definitions/ConnectableDTO" - }, - "name" : { - "type" : "string", - "description" : "The name of the connection." - }, - "labelIndex" : { - "type" : "integer", - "format" : "int32", - "description" : "The index of the bend point where to place the connection label." - }, - "getzIndex" : { - "type" : "integer", - "format" : "int64", - "description" : "The z index of the connection." - }, - "selectedRelationships" : { - "type" : "array", - "description" : "The selected relationship that comprise the connection.", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - }, - "availableRelationships" : { - "type" : "array", - "description" : "The relationships that the source of the connection currently supports.", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - }, - "backPressureObjectThreshold" : { - "type" : "integer", - "format" : "int64", - "description" : "The object count threshold for determining when back pressure is applied. Updating this value is a passive change in the sense that it won't impact whether existing files over the limit are affected but it does help feeder processors to stop pushing too much into this work queue." - }, - "backPressureDataSizeThreshold" : { - "type" : "string", - "description" : "The object data size threshold for determining when back pressure is applied. Updating this value is a passive change in the sense that it won't impact whether existing files over the limit are affected but it does help feeder processors to stop pushing too much into this work queue." - }, - "flowFileExpiration" : { - "type" : "string", - "description" : "The amount of time a flow file may be in the flow before it will be automatically aged out of the flow. Once a flow file reaches this age it will be terminated from the flow the next time a processor attempts to start work on it." - }, - "prioritizers" : { - "type" : "array", - "description" : "The comparators used to prioritize the queue.", - "items" : { - "type" : "string" - } - }, - "bends" : { - "type" : "array", - "description" : "The bend points on the connection.", - "items" : { - "$ref" : "#/definitions/PositionDTO" - } - }, - "loadBalanceStrategy" : { - "type" : "string", - "description" : "How to load balance the data in this Connection across the nodes in the cluster.", - "enum" : [ "DO_NOT_LOAD_BALANCE", "PARTITION_BY_ATTRIBUTE", "ROUND_ROBIN", "SINGLE_NODE" ] - }, - "loadBalancePartitionAttribute" : { - "type" : "string", - "description" : "The FlowFile Attribute to use for determining which node a FlowFile will go to if the Load Balancing Strategy is set to PARTITION_BY_ATTRIBUTE" - }, - "loadBalanceCompression" : { - "type" : "string", - "description" : "Whether or not data should be compressed when being transferred between nodes in the cluster.", - "enum" : [ "DO_NOT_COMPRESS", "COMPRESS_ATTRIBUTES_ONLY", "COMPRESS_ATTRIBUTES_AND_CONTENT" ] - }, - "loadBalanceStatus" : { - "type" : "string", - "description" : "The current status of the Connection's Load Balancing Activities. Status can indicate that Load Balancing is not configured for the connection, that Load Balancing is configured but inactive (not currently transferring data to another node), or that Load Balancing is configured and actively transferring data to another node.", - "enum" : [ "LOAD_BALANCE_NOT_CONFIGURED", "LOAD_BALANCE_INACTIVE", "LOAD_BALANCE_ACTIVE" ] - } - } - }, - "ConnectionDiagnosticsDTO" : { - "type" : "object", - "properties" : { - "connection" : { - "description" : "Details about the connection", - "$ref" : "#/definitions/ConnectionDTO" - }, - "aggregateSnapshot" : { - "description" : "Aggregate values for all nodes in the cluster, or for this instance if not clustered", - "$ref" : "#/definitions/ConnectionDiagnosticsSnapshotDTO" - }, - "nodeSnapshots" : { - "type" : "array", - "description" : "A list of values for each node in the cluster, if clustered.", - "items" : { - "$ref" : "#/definitions/ConnectionDiagnosticsSnapshotDTO" - } - } - } - }, - "ConnectionDiagnosticsSnapshotDTO" : { - "type" : "object", - "properties" : { - "totalFlowFileCount" : { - "type" : "integer", - "format" : "int32", - "description" : "Total number of FlowFiles owned by the Connection" - }, - "totalByteCount" : { - "type" : "integer", - "format" : "int64", - "description" : "Total number of bytes that make up the content for the FlowFiles owned by this Connection" - }, - "nodeIdentifier" : { - "type" : "string", - "description" : "The Node Identifier that this information pertains to" - }, - "localQueuePartition" : { - "description" : "The local queue partition, from which components can pull FlowFiles on this node.", - "$ref" : "#/definitions/LocalQueuePartitionDTO" - }, - "remoteQueuePartitions" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/RemoteQueuePartitionDTO" - } - } - } - }, - "ConnectionEntity" : { - "type" : "object", - "required" : [ "destinationType", "sourceType" ], - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "component" : { - "$ref" : "#/definitions/ConnectionDTO" - }, - "status" : { - "description" : "The status of the connection.", - "$ref" : "#/definitions/ConnectionStatusDTO" - }, - "bends" : { - "type" : "array", - "description" : "The bend points on the connection.", - "items" : { - "$ref" : "#/definitions/PositionDTO" - } - }, - "labelIndex" : { - "type" : "integer", - "format" : "int32", - "description" : "The index of the bend point where to place the connection label." - }, - "getzIndex" : { - "type" : "integer", - "format" : "int64", - "description" : "The z index of the connection." - }, - "sourceId" : { - "type" : "string", - "description" : "The identifier of the source of this connection." - }, - "sourceGroupId" : { - "type" : "string", - "description" : "The identifier of the group of the source of this connection." - }, - "sourceType" : { - "type" : "string", - "description" : "The type of component the source connectable is.", - "enum" : [ "PROCESSOR", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "INPUT_PORT", "OUTPUT_PORT", "FUNNEL" ] - }, - "destinationId" : { - "type" : "string", - "description" : "The identifier of the destination of this connection." - }, - "destinationGroupId" : { - "type" : "string", - "description" : "The identifier of the group of the destination of this connection." - }, - "destinationType" : { - "type" : "string", - "description" : "The type of component the destination connectable is.", - "enum" : [ "PROCESSOR", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "INPUT_PORT", "OUTPUT_PORT", "FUNNEL" ] - } - }, - "xml" : { - "name" : "connectionEntity" - } - }, - "ConnectionStatisticsDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The ID of the connection" - }, - "statsLastRefreshed" : { - "type" : "string", - "description" : "The timestamp of when the stats were last refreshed" - }, - "aggregateSnapshot" : { - "description" : "The status snapshot that represents the aggregate stats of the cluster", - "$ref" : "#/definitions/ConnectionStatisticsSnapshotDTO" - }, - "nodeSnapshots" : { - "type" : "array", - "description" : "A list of status snapshots for each node", - "items" : { - "$ref" : "#/definitions/NodeConnectionStatisticsSnapshotDTO" - } - } - } - }, - "ConnectionStatisticsEntity" : { - "type" : "object", - "properties" : { - "connectionStatistics" : { - "$ref" : "#/definitions/ConnectionStatisticsDTO" - }, - "canRead" : { - "type" : "boolean", - "description" : "Indicates whether the user can read a given resource." - } - }, - "xml" : { - "name" : "connectionStatisticsEntity" - } - }, - "ConnectionStatisticsSnapshotDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the connection." - }, - "predictedMillisUntilCountBackpressure" : { - "type" : "integer", - "format" : "int64", - "description" : "The predicted number of milliseconds before the connection will have backpressure applied, based on the queued count." - }, - "predictedMillisUntilBytesBackpressure" : { - "type" : "integer", - "format" : "int64", - "description" : "The predicted number of milliseconds before the connection will have backpressure applied, based on the total number of bytes in the queue." - }, - "predictedCountAtNextInterval" : { - "type" : "integer", - "format" : "int32", - "description" : "The predicted number of queued objects at the next configured interval." - }, - "predictedBytesAtNextInterval" : { - "type" : "integer", - "format" : "int64", - "description" : "The predicted total number of bytes in the queue at the next configured interval." - }, - "predictedPercentCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The predicted percentage of queued objects at the next configured interval." - }, - "predictedPercentBytes" : { - "type" : "integer", - "format" : "int32", - "description" : "The predicted percentage of bytes in the queue against current threshold at the next configured interval." - }, - "predictionIntervalMillis" : { - "type" : "integer", - "format" : "int64", - "description" : "The prediction interval in seconds" - } - } - }, - "ConnectionStatusDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The ID of the connection" - }, - "groupId" : { - "type" : "string", - "description" : "The ID of the Process Group that the connection belongs to" - }, - "name" : { - "type" : "string", - "description" : "The name of the connection" - }, - "statsLastRefreshed" : { - "type" : "string", - "description" : "The timestamp of when the stats were last refreshed" - }, - "sourceId" : { - "type" : "string", - "description" : "The ID of the source component" - }, - "sourceName" : { - "type" : "string", - "description" : "The name of the source component" - }, - "destinationId" : { - "type" : "string", - "description" : "The ID of the destination component" - }, - "destinationName" : { - "type" : "string", - "description" : "The name of the destination component" - }, - "aggregateSnapshot" : { - "description" : "The status snapshot that represents the aggregate stats of the cluster", - "$ref" : "#/definitions/ConnectionStatusSnapshotDTO" - }, - "nodeSnapshots" : { - "type" : "array", - "description" : "A list of status snapshots for each node", - "items" : { - "$ref" : "#/definitions/NodeConnectionStatusSnapshotDTO" - } - } - } - }, - "ConnectionStatusEntity" : { - "type" : "object", - "properties" : { - "connectionStatus" : { - "$ref" : "#/definitions/ConnectionStatusDTO" - }, - "canRead" : { - "type" : "boolean", - "description" : "Indicates whether the user can read a given resource." - } - }, - "xml" : { - "name" : "connectionStatusEntity" - } - }, - "ConnectionStatusPredictionsSnapshotDTO" : { - "type" : "object", - "properties" : { - "predictedMillisUntilCountBackpressure" : { - "type" : "integer", - "format" : "int64", - "description" : "The predicted number of milliseconds before the connection will have backpressure applied, based on the queued count." - }, - "predictedMillisUntilBytesBackpressure" : { - "type" : "integer", - "format" : "int64", - "description" : "The predicted number of milliseconds before the connection will have backpressure applied, based on the total number of bytes in the queue." - }, - "predictionIntervalSeconds" : { - "type" : "integer", - "format" : "int32", - "description" : "The configured interval (in seconds) for predicting connection queue count and size (and percent usage)." - }, - "predictedCountAtNextInterval" : { - "type" : "integer", - "format" : "int32", - "description" : "The predicted number of queued objects at the next configured interval." - }, - "predictedBytesAtNextInterval" : { - "type" : "integer", - "format" : "int64", - "description" : "The predicted total number of bytes in the queue at the next configured interval." - }, - "predictedPercentCount" : { - "type" : "integer", - "format" : "int32", - "description" : "Predicted connection percent use regarding queued flow files count and backpressure threshold if configured." - }, - "predictedPercentBytes" : { - "type" : "integer", - "format" : "int32", - "description" : "Predicted connection percent use regarding queued flow files size and backpressure threshold if configured." - } - } - }, - "ConnectionStatusSnapshotDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the connection." - }, - "groupId" : { - "type" : "string", - "description" : "The id of the process group the connection belongs to." - }, - "name" : { - "type" : "string", - "description" : "The name of the connection." - }, - "sourceId" : { - "type" : "string", - "description" : "The id of the source of the connection." - }, - "sourceName" : { - "type" : "string", - "description" : "The name of the source of the connection." - }, - "destinationId" : { - "type" : "string", - "description" : "The id of the destination of the connection." - }, - "destinationName" : { - "type" : "string", - "description" : "The name of the destination of the connection." - }, - "predictions" : { - "description" : "Predictions, if available, for this connection (null if not available)", - "$ref" : "#/definitions/ConnectionStatusPredictionsSnapshotDTO" - }, - "flowFilesIn" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of FlowFiles that have come into the connection in the last 5 minutes." - }, - "bytesIn" : { - "type" : "integer", - "format" : "int64", - "description" : "The size of the FlowFiles that have come into the connection in the last 5 minutes." - }, - "input" : { - "type" : "string", - "description" : "The input count/size for the connection in the last 5 minutes, pretty printed." - }, - "flowFilesOut" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of FlowFiles that have left the connection in the last 5 minutes." - }, - "bytesOut" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes that have left the connection in the last 5 minutes." - }, - "output" : { - "type" : "string", - "description" : "The output count/sie for the connection in the last 5 minutes, pretty printed." - }, - "flowFilesQueued" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of FlowFiles that are currently queued in the connection." - }, - "bytesQueued" : { - "type" : "integer", - "format" : "int64", - "description" : "The size of the FlowFiles that are currently queued in the connection." - }, - "queued" : { - "type" : "string", - "description" : "The total count and size of queued flowfiles formatted." - }, - "queuedSize" : { - "type" : "string", - "description" : "The total size of flowfiles that are queued formatted." - }, - "queuedCount" : { - "type" : "string", - "description" : "The number of flowfiles that are queued, pretty printed." - }, - "percentUseCount" : { - "type" : "integer", - "format" : "int32", - "description" : "Connection percent use regarding queued flow files count and backpressure threshold if configured." - }, - "percentUseBytes" : { - "type" : "integer", - "format" : "int32", - "description" : "Connection percent use regarding queued flow files size and backpressure threshold if configured." - } - } - }, - "ConnectionStatusSnapshotEntity" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the connection." - }, - "connectionStatusSnapshot" : { - "$ref" : "#/definitions/ConnectionStatusSnapshotDTO" - }, - "canRead" : { - "type" : "boolean", - "description" : "Indicates whether the user can read a given resource." - } - }, - "xml" : { - "name" : "entity" - } - }, - "ConnectionsEntity" : { - "type" : "object", - "properties" : { - "connections" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ConnectionEntity" - } - } - }, - "xml" : { - "name" : "connectionsEntity" - } - }, - "ControllerBulletinsEntity" : { - "type" : "object", - "properties" : { - "bulletins" : { - "type" : "array", - "description" : "System level bulletins to be reported to the user.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "controllerServiceBulletins" : { - "type" : "array", - "description" : "Controller service bulletins to be reported to the user.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "reportingTaskBulletins" : { - "type" : "array", - "description" : "Reporting task bulletins to be reported to the user.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - } - }, - "xml" : { - "name" : "controllerConfigurationEntity" - } - }, - "ControllerConfigurationDTO" : { - "type" : "object", - "properties" : { - "maxTimerDrivenThreadCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The maximum number of timer driven threads the NiFi has available." - }, - "maxEventDrivenThreadCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The maximum number of event driven threads the NiFi has available." - } - } - }, - "ControllerConfigurationEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "component" : { - "description" : "The controller configuration.", - "$ref" : "#/definitions/ControllerConfigurationDTO" - } - }, - "xml" : { - "name" : "controllerConfigurationEntity" - } - }, - "ControllerDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the NiFi." - }, - "name" : { - "type" : "string", - "description" : "The name of the NiFi." - }, - "comments" : { - "type" : "string", - "description" : "The comments for the NiFi." - }, - "runningCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of running components in the NiFi." - }, - "stoppedCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of stopped components in the NiFi." - }, - "invalidCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of invalid components in the NiFi." - }, - "disabledCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of disabled components in the NiFi." - }, - "activeRemotePortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of active remote ports contained in the NiFi." - }, - "inactiveRemotePortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of inactive remote ports contained in the NiFi." - }, - "inputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of input ports contained in the NiFi." - }, - "outputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of output ports in the NiFi." - }, - "remoteSiteListeningPort" : { - "type" : "integer", - "format" : "int32", - "description" : "The Socket Port on which this instance is listening for Remote Transfers of Flow Files. If this instance is not configured to receive Flow Files from remote instances, this will be null." - }, - "remoteSiteHttpListeningPort" : { - "type" : "integer", - "format" : "int32", - "description" : "The HTTP(S) Port on which this instance is listening for Remote Transfers of Flow Files. If this instance is not configured to receive Flow Files from remote instances, this will be null." - }, - "siteToSiteSecure" : { - "type" : "boolean", - "description" : "Indicates whether or not Site-to-Site communications with this instance is secure (2-way authentication)." - }, - "instanceId" : { - "type" : "string", - "description" : "If clustered, the id of the Cluster Manager, otherwise the id of the NiFi." - }, - "inputPorts" : { - "type" : "array", - "description" : "The input ports available to send data to for the NiFi.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/PortDTO" - } - }, - "outputPorts" : { - "type" : "array", - "description" : "The output ports available to received data from the NiFi.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/PortDTO" - } - } - } - }, - "ControllerEntity" : { - "type" : "object", - "properties" : { - "controller" : { - "$ref" : "#/definitions/ControllerDTO" - } - }, - "xml" : { - "name" : "controllerEntity" - } - }, - "ControllerServiceAPI" : { - "type" : "object", - "properties" : { - "type" : { - "type" : "string", - "description" : "The fully qualified name of the service interface." - }, - "bundle" : { - "description" : "The details of the artifact that bundled this service interface.", - "$ref" : "#/definitions/Bundle" - } - } - }, - "ControllerServiceApiDTO" : { - "type" : "object", - "properties" : { - "type" : { - "type" : "string", - "description" : "The fully qualified name of the service interface." - }, - "bundle" : { - "description" : "The details of the artifact that bundled this service interface.", - "$ref" : "#/definitions/BundleDTO" - } - } - }, - "ControllerServiceDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "versionedComponentId" : { - "type" : "string", - "description" : "The ID of the corresponding component that is under version control" - }, - "parentGroupId" : { - "type" : "string", - "description" : "The id of parent process group of this component if applicable." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "name" : { - "type" : "string", - "description" : "The name of the controller service." - }, - "type" : { - "type" : "string", - "description" : "The type of the controller service." - }, - "bundle" : { - "description" : "The details of the artifact that bundled this processor type.", - "$ref" : "#/definitions/BundleDTO" - }, - "controllerServiceApis" : { - "type" : "array", - "description" : "Lists the APIs this Controller Service implements.", - "items" : { - "$ref" : "#/definitions/ControllerServiceApiDTO" - } - }, - "comments" : { - "type" : "string", - "description" : "The comments for the controller service." - }, - "state" : { - "type" : "string", - "description" : "The state of the controller service.", - "enum" : [ "ENABLED", "ENABLING", "DISABLED", "DISABLING" ] - }, - "persistsState" : { - "type" : "boolean", - "description" : "Whether the controller service persists state." - }, - "restricted" : { - "type" : "boolean", - "description" : "Whether the controller service requires elevated privileges." - }, - "deprecated" : { - "type" : "boolean", - "description" : "Whether the ontroller service has been deprecated." - }, - "multipleVersionsAvailable" : { - "type" : "boolean", - "description" : "Whether the controller service has multiple versions available." - }, - "properties" : { - "type" : "object", - "description" : "The properties of the controller service.", - "additionalProperties" : { - "type" : "string" - } - }, - "descriptors" : { - "type" : "object", - "description" : "The descriptors for the controller service properties.", - "additionalProperties" : { - "$ref" : "#/definitions/PropertyDescriptorDTO" - } - }, - "customUiUrl" : { - "type" : "string", - "description" : "The URL for the controller services custom configuration UI if applicable." - }, - "annotationData" : { - "type" : "string", - "description" : "The annotation for the controller service. This is how the custom UI relays configuration to the controller service." - }, - "referencingComponents" : { - "type" : "array", - "description" : "All components referencing this controller service.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ControllerServiceReferencingComponentEntity" - } - }, - "validationErrors" : { - "type" : "array", - "description" : "The validation errors from the controller service. These validation errors represent the problems with the controller service that must be resolved before it can be enabled.", - "items" : { - "type" : "string" - } - }, - "validationStatus" : { - "type" : "string", - "description" : "Indicates whether the ControllerService is valid, invalid, or still in the process of validating (i.e., it is unknown whether or not the ControllerService is valid)", - "enum" : [ "VALID", "INVALID", "VALIDATING" ] - }, - "extensionMissing" : { - "type" : "boolean", - "description" : "Whether the underlying extension is missing." - } - } - }, - "ControllerServiceDiagnosticsDTO" : { - "type" : "object", - "properties" : { - "controllerService" : { - "description" : "The Controller Service", - "$ref" : "#/definitions/ControllerServiceEntity" - }, - "classLoaderDiagnostics" : { - "description" : "Information about the Controller Service's Class Loader", - "$ref" : "#/definitions/ClassLoaderDiagnosticsDTO" - } - } - }, - "ControllerServiceEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "parentGroupId" : { - "type" : "string", - "description" : "The id of parent process group of this ControllerService." - }, - "component" : { - "$ref" : "#/definitions/ControllerServiceDTO" - }, - "operatePermissions" : { - "description" : "The permissions for this component operations.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "status" : { - "description" : "The status for this ControllerService.", - "$ref" : "#/definitions/ControllerServiceStatusDTO" - } - }, - "xml" : { - "name" : "controllerServiceEntity" - } - }, - "ControllerServiceReferencingComponentDTO" : { - "type" : "object", - "properties" : { - "groupId" : { - "type" : "string", - "description" : "The group id for the component referencing a controller service. If this component is another controller service or a reporting task, this field is blank." - }, - "id" : { - "type" : "string", - "description" : "The id of the component referencing a controller service." - }, - "name" : { - "type" : "string", - "description" : "The name of the component referencing a controller service." - }, - "type" : { - "type" : "string", - "description" : "The type of the component referencing a controller service in simple Java class name format without package name." - }, - "state" : { - "type" : "string", - "description" : "The scheduled state of a processor or reporting task referencing a controller service. If this component is another controller service, this field represents the controller service state." - }, - "properties" : { - "type" : "object", - "description" : "The properties for the component.", - "additionalProperties" : { - "type" : "string" - } - }, - "descriptors" : { - "type" : "object", - "description" : "The descriptors for the component properties.", - "additionalProperties" : { - "$ref" : "#/definitions/PropertyDescriptorDTO" - } - }, - "validationErrors" : { - "type" : "array", - "description" : "The validation errors for the component.", - "items" : { - "type" : "string" - } - }, - "referenceType" : { - "type" : "string", - "description" : "The type of reference this is.", - "enum" : [ "Processor", "ControllerService", "ReportingTask" ] - }, - "activeThreadCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of active threads for the referencing component." - }, - "referenceCycle" : { - "type" : "boolean", - "description" : "If the referencing component represents a controller service, this indicates whether it has already been represented in this hierarchy." - }, - "referencingComponents" : { - "type" : "array", - "description" : "If the referencing component represents a controller service, these are the components that reference it.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ControllerServiceReferencingComponentEntity" - } - } - } - }, - "ControllerServiceReferencingComponentEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "component" : { - "$ref" : "#/definitions/ControllerServiceReferencingComponentDTO" - }, - "operatePermissions" : { - "description" : "The permissions for this component operations.", - "$ref" : "#/definitions/PermissionsDTO" - } - }, - "xml" : { - "name" : "controllerServiceReferencingComponentEntity" - } - }, - "ControllerServiceReferencingComponentsEntity" : { - "type" : "object", - "properties" : { - "controllerServiceReferencingComponents" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ControllerServiceReferencingComponentEntity" - } - } - }, - "xml" : { - "name" : "controllerServiceReferencingComponentsEntity" - } - }, - "ControllerServiceRunStatusEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "state" : { - "type" : "string", - "description" : "The run status of the ControllerService.", - "enum" : [ "ENABLED", "DISABLED" ] - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - } - }, - "xml" : { - "name" : "entity" - } - }, - "ControllerServiceStatusDTO" : { - "type" : "object", - "properties" : { - "runStatus" : { - "type" : "string", - "description" : "The run status of this ControllerService", - "enum" : [ "ENABLED", "ENABLING", "DISABLED", "DISABLING" ] - }, - "validationStatus" : { - "type" : "string", - "description" : "Indicates whether the component is valid, invalid, or still in the process of validating (i.e., it is unknown whether or not the component is valid)", - "enum" : [ "VALID", "INVALID", "VALIDATING" ] - }, - "activeThreadCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of active threads for the component." - } - } - }, - "ControllerServiceTypesEntity" : { - "type" : "object", - "properties" : { - "controllerServiceTypes" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/DocumentedTypeDTO" - } - } - }, - "xml" : { - "name" : "controllerServiceTypesEntity" - } - }, - "ControllerServicesEntity" : { - "type" : "object", - "properties" : { - "currentTime" : { - "type" : "string", - "description" : "The current time on the system." - }, - "controllerServices" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ControllerServiceEntity" - } - } - }, - "xml" : { - "name" : "controllerServicesEntity" - } - }, - "ControllerStatusDTO" : { - "type" : "object", - "properties" : { - "activeThreadCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of active threads in the NiFi." - }, - "terminatedThreadCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of terminated threads in the NiFi." - }, - "queued" : { - "type" : "string", - "description" : "The number of flowfiles queued in the NiFi." - }, - "flowFilesQueued" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of FlowFiles queued across the entire flow" - }, - "bytesQueued" : { - "type" : "integer", - "format" : "int64", - "description" : "The size of the FlowFiles queued across the entire flow" - }, - "runningCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of running components in the NiFi." - }, - "stoppedCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of stopped components in the NiFi." - }, - "invalidCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of invalid components in the NiFi." - }, - "disabledCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of disabled components in the NiFi." - }, - "activeRemotePortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of active remote ports in the NiFi." - }, - "inactiveRemotePortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of inactive remote ports in the NiFi." - }, - "upToDateCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of up to date versioned process groups in the NiFi." - }, - "locallyModifiedCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of locally modified versioned process groups in the NiFi." - }, - "staleCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of stale versioned process groups in the NiFi." - }, - "locallyModifiedAndStaleCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of locally modified and stale versioned process groups in the NiFi." - }, - "syncFailureCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of versioned process groups in the NiFi that are unable to sync to a registry." - } - } - }, - "ControllerStatusEntity" : { - "type" : "object", - "properties" : { - "controllerStatus" : { - "$ref" : "#/definitions/ControllerStatusDTO" - } - }, - "xml" : { - "name" : "controllerStatusEntity" - } - }, - "CopySnippetRequestEntity" : { - "type" : "object", - "properties" : { - "snippetId" : { - "type" : "string", - "description" : "The identifier of the snippet." - }, - "originX" : { - "type" : "number", - "format" : "double", - "description" : "The x coordinate of the origin of the bounding box where the new components will be placed." - }, - "originY" : { - "type" : "number", - "format" : "double", - "description" : "The y coordinate of the origin of the bounding box where the new components will be placed." - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - } - }, - "xml" : { - "name" : "copySnippetRequestEntity" - } - }, - "CounterDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the counter." - }, - "context" : { - "type" : "string", - "description" : "The context of the counter." - }, - "name" : { - "type" : "string", - "description" : "The name of the counter." - }, - "valueCount" : { - "type" : "integer", - "format" : "int64", - "description" : "The value count." - }, - "value" : { - "type" : "string", - "description" : "The value of the counter." - } - } - }, - "CounterEntity" : { - "type" : "object", - "properties" : { - "counter" : { - "$ref" : "#/definitions/CounterDTO" - } - }, - "xml" : { - "name" : "counterEntity" - } - }, - "CountersDTO" : { - "type" : "object", - "properties" : { - "aggregateSnapshot" : { - "description" : "A Counters snapshot that represents the aggregate values of all nodes in the cluster. If the NiFi instance is a standalone instance, rather than a cluster, this represents the stats of the single instance.", - "$ref" : "#/definitions/CountersSnapshotDTO" - }, - "nodeSnapshots" : { - "type" : "array", - "description" : "A Counters snapshot for each node in the cluster. If the NiFi instance is a standalone instance, rather than a cluster, this may be null.", - "items" : { - "$ref" : "#/definitions/NodeCountersSnapshotDTO" - } - } - } - }, - "CountersEntity" : { - "type" : "object", - "properties" : { - "counters" : { - "$ref" : "#/definitions/CountersDTO" - } - }, - "xml" : { - "name" : "countersEntity" - } - }, - "CountersSnapshotDTO" : { - "type" : "object", - "properties" : { - "generated" : { - "type" : "string", - "description" : "The timestamp when the report was generated." - }, - "counters" : { - "type" : "array", - "description" : "All counters in the NiFi.", - "items" : { - "$ref" : "#/definitions/CounterDTO" - } - } - } - }, - "CreateActiveRequestEntity" : { - "type" : "object", - "properties" : { - "processGroupId" : { - "type" : "string", - "description" : "The Process Group ID that this active request will update" - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - } - }, - "xml" : { - "name" : "createActiveRequestEntity" - } - }, - "CreateTemplateRequestEntity" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The name of the template." - }, - "description" : { - "type" : "string", - "description" : "The description of the template." - }, - "snippetId" : { - "type" : "string", - "description" : "The identifier of the snippet." - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - } - }, - "xml" : { - "name" : "createTemplateRequestEntity" - } - }, - "CurrentUserEntity" : { - "type" : "object", - "properties" : { - "identity" : { - "type" : "string", - "description" : "The user identity being serialized." - }, - "anonymous" : { - "type" : "boolean", - "description" : "Whether the current user is anonymous." - }, - "provenancePermissions" : { - "description" : "Permissions for querying provenance.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "countersPermissions" : { - "description" : "Permissions for accessing counters.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "tenantsPermissions" : { - "description" : "Permissions for accessing tenants.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "controllerPermissions" : { - "description" : "Permissions for accessing the controller.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "policiesPermissions" : { - "description" : "Permissions for accessing the policies.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "systemPermissions" : { - "description" : "Permissions for accessing system.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "parameterContextPermissions" : { - "description" : "Permissions for accessing parameter contexts.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "restrictedComponentsPermissions" : { - "description" : "Permissions for accessing restricted components. Note: the read permission are not used and will always be false.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "componentRestrictionPermissions" : { - "type" : "array", - "description" : "Permissions for specific component restrictions.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ComponentRestrictionPermissionDTO" - } - }, - "canVersionFlows" : { - "type" : "boolean", - "description" : "Whether the current user can version flows." - } - }, - "xml" : { - "name" : "currentEntity" - } - }, - "DifferenceDTO" : { - "type" : "object", - "properties" : { - "differenceType" : { - "type" : "string", - "description" : "The type of difference" - }, - "difference" : { - "type" : "string", - "description" : "Description of the difference" - } - } - }, - "DimensionsDTO" : { - "type" : "object", - "properties" : { - "width" : { - "type" : "number", - "format" : "double", - "description" : "The width of the label in pixels when at a 1:1 scale." - }, - "height" : { - "type" : "number", - "format" : "double", - "description" : "The height of the label in pixels when at a 1:1 scale." - } - } - }, - "DocumentedTypeDTO" : { - "type" : "object", - "properties" : { - "type" : { - "type" : "string", - "description" : "The fully qualified name of the type." - }, - "bundle" : { - "description" : "The details of the artifact that bundled this type.", - "$ref" : "#/definitions/BundleDTO" - }, - "controllerServiceApis" : { - "type" : "array", - "description" : "If this type represents a ControllerService, this lists the APIs it implements.", - "items" : { - "$ref" : "#/definitions/ControllerServiceApiDTO" - } - }, - "description" : { - "type" : "string", - "description" : "The description of the type." - }, - "restricted" : { - "type" : "boolean", - "description" : "Whether this type is restricted." - }, - "usageRestriction" : { - "type" : "string", - "description" : "The optional description of why the usage of this component is restricted." - }, - "explicitRestrictions" : { - "type" : "array", - "description" : "An optional collection of explicit restrictions. If specified, these explicit restrictions will be enfored.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ExplicitRestrictionDTO" - } - }, - "deprecationReason" : { - "type" : "string", - "description" : "The description of why the usage of this component is restricted." - }, - "tags" : { - "type" : "array", - "description" : "The tags associated with this type.", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - } - } - }, - "DropRequestDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id for this drop request." - }, - "uri" : { - "type" : "string", - "description" : "The URI for future requests to this drop request." - }, - "submissionTime" : { - "type" : "string", - "description" : "The timestamp when the query was submitted." - }, - "lastUpdated" : { - "type" : "string", - "description" : "The last time this drop request was updated." - }, - "percentCompleted" : { - "type" : "integer", - "format" : "int32", - "description" : "The current percent complete." - }, - "finished" : { - "type" : "boolean", - "description" : "Whether the query has finished." - }, - "failureReason" : { - "type" : "string", - "description" : "The reason, if any, that this drop request failed." - }, - "currentCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of flow files currently queued." - }, - "currentSize" : { - "type" : "integer", - "format" : "int64", - "description" : "The size of flow files currently queued in bytes." - }, - "current" : { - "type" : "string", - "description" : "The count and size of flow files currently queued." - }, - "originalCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of flow files to be dropped as a result of this request." - }, - "originalSize" : { - "type" : "integer", - "format" : "int64", - "description" : "The size of flow files to be dropped as a result of this request in bytes." - }, - "original" : { - "type" : "string", - "description" : "The count and size of flow files to be dropped as a result of this request." - }, - "droppedCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of flow files that have been dropped thus far." - }, - "droppedSize" : { - "type" : "integer", - "format" : "int64", - "description" : "The size of flow files that have been dropped thus far in bytes." - }, - "dropped" : { - "type" : "string", - "description" : "The count and size of flow files that have been dropped thus far." - }, - "state" : { - "type" : "string", - "description" : "The current state of the drop request." - } - } - }, - "DropRequestEntity" : { - "type" : "object", - "properties" : { - "dropRequest" : { - "$ref" : "#/definitions/DropRequestDTO" - } - }, - "xml" : { - "name" : "dropRequestEntity" - } - }, - "ExplicitRestrictionDTO" : { - "type" : "object", - "properties" : { - "requiredPermission" : { - "description" : "The required permission necessary for this restriction.", - "$ref" : "#/definitions/RequiredPermissionDTO" - }, - "explanation" : { - "type" : "string", - "description" : "The description of why the usage of this component is restricted for this required permission." - } - } - }, - "ExternalControllerServiceReference" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The identifier of the controller service" - }, - "name" : { - "type" : "string", - "description" : "The name of the controller service" - } - } - }, - "FlowBreadcrumbDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the group." - }, - "name" : { - "type" : "string", - "description" : "The id of the group." - }, - "versionControlInformation" : { - "description" : "The process group version control information or null if not version controlled.", - "$ref" : "#/definitions/VersionControlInformationDTO" - } - } - }, - "FlowBreadcrumbEntity" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of this ancestor ProcessGroup." - }, - "permissions" : { - "description" : "The permissions for this ancestor ProcessGroup.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "versionedFlowState" : { - "type" : "string", - "description" : "The current state of the Process Group, as it relates to the Versioned Flow", - "enum" : [ "LOCALLY_MODIFIED", "STALE", "LOCALLY_MODIFIED_AND_STALE", "UP_TO_DATE", "SYNC_FAILURE" ] - }, - "breadcrumb" : { - "description" : "This breadcrumb.", - "$ref" : "#/definitions/FlowBreadcrumbDTO" - }, - "parentBreadcrumb" : { - "description" : "The parent breadcrumb for this breadcrumb.", - "$ref" : "#/definitions/FlowBreadcrumbEntity" - } - }, - "xml" : { - "name" : "flowEntity" - } - }, - "FlowComparisonEntity" : { - "type" : "object", - "properties" : { - "componentDifferences" : { - "type" : "array", - "description" : "The list of differences for each component in the flow that is not the same between the two flows", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ComponentDifferenceDTO" - } - } - }, - "xml" : { - "name" : "flowComparisonEntity" - } - }, - "FlowConfigurationDTO" : { - "type" : "object", - "properties" : { - "supportsManagedAuthorizer" : { - "type" : "boolean", - "description" : "Whether this NiFi supports a managed authorizer. Managed authorizers can visualize users, groups, and policies in the UI." - }, - "supportsConfigurableAuthorizer" : { - "type" : "boolean", - "description" : "Whether this NiFi supports a configurable authorizer." - }, - "supportsConfigurableUsersAndGroups" : { - "type" : "boolean", - "description" : "Whether this NiFi supports configurable users and groups." - }, - "autoRefreshIntervalSeconds" : { - "type" : "integer", - "format" : "int64", - "description" : "The interval in seconds between the automatic NiFi refresh requests." - }, - "currentTime" : { - "type" : "string", - "description" : "The current time on the system." - }, - "timeOffset" : { - "type" : "integer", - "format" : "int32", - "description" : "The time offset of the system." - }, - "defaultBackPressureObjectThreshold" : { - "type" : "integer", - "format" : "int64", - "description" : "The default back pressure object threshold." - }, - "defaultBackPressureDataSizeThreshold" : { - "type" : "string", - "description" : "The default back pressure data size threshold." - } - } - }, - "FlowConfigurationEntity" : { - "type" : "object", - "properties" : { - "flowConfiguration" : { - "description" : "The controller configuration.", - "$ref" : "#/definitions/FlowConfigurationDTO" - } - }, - "xml" : { - "name" : "flowConfigurationEntity" - } - }, - "FlowDTO" : { - "type" : "object", - "properties" : { - "processGroups" : { - "type" : "array", - "description" : "The process groups in this flow.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ProcessGroupEntity" - } - }, - "remoteProcessGroups" : { - "type" : "array", - "description" : "The remote process groups in this flow.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/RemoteProcessGroupEntity" - } - }, - "processors" : { - "type" : "array", - "description" : "The processors in this flow.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ProcessorEntity" - } - }, - "inputPorts" : { - "type" : "array", - "description" : "The input ports in this flow.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/PortEntity" - } - }, - "outputPorts" : { - "type" : "array", - "description" : "The output ports in this flow.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/PortEntity" - } - }, - "connections" : { - "type" : "array", - "description" : "The connections in this flow.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ConnectionEntity" - } - }, - "labels" : { - "type" : "array", - "description" : "The labels in this flow.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/LabelEntity" - } - }, - "funnels" : { - "type" : "array", - "description" : "The funnels in this flow.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/FunnelEntity" - } - } - } - }, - "FlowEntity" : { - "type" : "object", - "properties" : { - "flow" : { - "$ref" : "#/definitions/FlowDTO" - } - }, - "xml" : { - "name" : "flowEntity" - } - }, - "FlowFileDTO" : { - "type" : "object", - "properties" : { - "uri" : { - "type" : "string", - "description" : "The URI that can be used to access this FlowFile." - }, - "uuid" : { - "type" : "string", - "description" : "The FlowFile UUID." - }, - "filename" : { - "type" : "string", - "description" : "The FlowFile filename." - }, - "position" : { - "type" : "integer", - "format" : "int32", - "description" : "The FlowFile's position in the queue." - }, - "size" : { - "type" : "integer", - "format" : "int64", - "description" : "The FlowFile file size." - }, - "queuedDuration" : { - "type" : "integer", - "format" : "int64", - "description" : "How long this FlowFile has been enqueued." - }, - "lineageDuration" : { - "type" : "integer", - "format" : "int64", - "description" : "Duration since the FlowFile's greatest ancestor entered the flow." - }, - "penaltyExpiresIn" : { - "type" : "integer", - "format" : "int64", - "description" : "How long in milliseconds until the FlowFile penalty expires." - }, - "clusterNodeId" : { - "type" : "string", - "description" : "The id of the node where this FlowFile resides." - }, - "clusterNodeAddress" : { - "type" : "string", - "description" : "The label for the node where this FlowFile resides." - }, - "attributes" : { - "type" : "object", - "description" : "The FlowFile attributes.", - "additionalProperties" : { - "type" : "string" - } - }, - "contentClaimSection" : { - "type" : "string", - "description" : "The section in which the content claim lives." - }, - "contentClaimContainer" : { - "type" : "string", - "description" : "The container in which the content claim lives." - }, - "contentClaimIdentifier" : { - "type" : "string", - "description" : "The identifier of the content claim." - }, - "contentClaimOffset" : { - "type" : "integer", - "format" : "int64", - "description" : "The offset into the content claim where the flowfile's content begins." - }, - "contentClaimFileSize" : { - "type" : "string", - "description" : "The file size of the content claim formatted." - }, - "contentClaimFileSizeBytes" : { - "type" : "integer", - "format" : "int64", - "description" : "The file size of the content claim in bytes." - }, - "penalized" : { - "type" : "boolean", - "description" : "If the FlowFile is penalized." - } - } - }, - "FlowFileEntity" : { - "type" : "object", - "properties" : { - "flowFile" : { - "$ref" : "#/definitions/FlowFileDTO" - } - }, - "xml" : { - "name" : "flowFileEntity" - } - }, - "FlowFileSummaryDTO" : { - "type" : "object", - "properties" : { - "uri" : { - "type" : "string", - "description" : "The URI that can be used to access this FlowFile." - }, - "uuid" : { - "type" : "string", - "description" : "The FlowFile UUID." - }, - "filename" : { - "type" : "string", - "description" : "The FlowFile filename." - }, - "position" : { - "type" : "integer", - "format" : "int32", - "description" : "The FlowFile's position in the queue." - }, - "size" : { - "type" : "integer", - "format" : "int64", - "description" : "The FlowFile file size." - }, - "queuedDuration" : { - "type" : "integer", - "format" : "int64", - "description" : "How long this FlowFile has been enqueued." - }, - "lineageDuration" : { - "type" : "integer", - "format" : "int64", - "description" : "Duration since the FlowFile's greatest ancestor entered the flow." - }, - "penaltyExpiresIn" : { - "type" : "integer", - "format" : "int64", - "description" : "How long in milliseconds until the FlowFile penalty expires." - }, - "clusterNodeId" : { - "type" : "string", - "description" : "The id of the node where this FlowFile resides." - }, - "clusterNodeAddress" : { - "type" : "string", - "description" : "The label for the node where this FlowFile resides." - }, - "penalized" : { - "type" : "boolean", - "description" : "If the FlowFile is penalized." - } - } - }, - "FlowSnippetDTO" : { - "type" : "object", - "properties" : { - "processGroups" : { - "type" : "array", - "description" : "The process groups in this flow snippet.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ProcessGroupDTO" - } - }, - "remoteProcessGroups" : { - "type" : "array", - "description" : "The remote process groups in this flow snippet.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/RemoteProcessGroupDTO" - } - }, - "processors" : { - "type" : "array", - "description" : "The processors in this flow snippet.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ProcessorDTO" - } - }, - "inputPorts" : { - "type" : "array", - "description" : "The input ports in this flow snippet.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/PortDTO" - } - }, - "outputPorts" : { - "type" : "array", - "description" : "The output ports in this flow snippet.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/PortDTO" - } - }, - "connections" : { - "type" : "array", - "description" : "The connections in this flow snippet.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ConnectionDTO" - } - }, - "labels" : { - "type" : "array", - "description" : "The labels in this flow snippet.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/LabelDTO" - } - }, - "funnels" : { - "type" : "array", - "description" : "The funnels in this flow snippet.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/FunnelDTO" - } - }, - "controllerServices" : { - "type" : "array", - "description" : "The controller services in this flow snippet.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ControllerServiceDTO" - } - } - } - }, - "FunnelDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "versionedComponentId" : { - "type" : "string", - "description" : "The ID of the corresponding component that is under version control" - }, - "parentGroupId" : { - "type" : "string", - "description" : "The id of parent process group of this component if applicable." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - } - } - }, - "FunnelEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "component" : { - "$ref" : "#/definitions/FunnelDTO" - } - }, - "xml" : { - "name" : "funnelEntity" - } - }, - "FunnelsEntity" : { - "type" : "object", - "properties" : { - "funnels" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/FunnelEntity" - } - } - }, - "xml" : { - "name" : "funnelsEntity" - } - }, - "GCDiagnosticsSnapshotDTO" : { - "type" : "object", - "properties" : { - "timestamp" : { - "type" : "string", - "format" : "date-time", - "description" : "The timestamp of when the Snapshot was taken" - }, - "collectionCount" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of times that Garbage Collection has occurred" - }, - "collectionMillis" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of milliseconds that the Garbage Collector spent performing Garbage Collection duties" - } - } - }, - "GarbageCollectionDTO" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The name of the garbage collector." - }, - "collectionCount" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of times garbage collection has run." - }, - "collectionTime" : { - "type" : "string", - "description" : "The total amount of time spent garbage collecting." - }, - "collectionMillis" : { - "type" : "integer", - "format" : "int64", - "description" : "The total number of milliseconds spent garbage collecting." - } - } - }, - "GarbageCollectionDiagnosticsDTO" : { - "type" : "object", - "properties" : { - "memoryManagerName" : { - "type" : "string", - "description" : "The name of the Memory Manager that this Garbage Collection information pertains to" - }, - "snapshots" : { - "type" : "array", - "description" : "A list of snapshots that have been taken to determine the health of the JVM's heap", - "items" : { - "$ref" : "#/definitions/GCDiagnosticsSnapshotDTO" - } - } - } - }, - "HistoryDTO" : { - "type" : "object", - "properties" : { - "total" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of number of actions that matched the search criteria.." - }, - "lastRefreshed" : { - "type" : "string", - "description" : "The timestamp when the report was generated." - }, - "actions" : { - "type" : "array", - "description" : "The actions.", - "items" : { - "$ref" : "#/definitions/ActionEntity" - } - } - } - }, - "HistoryEntity" : { - "type" : "object", - "properties" : { - "history" : { - "$ref" : "#/definitions/HistoryDTO" - } - }, - "xml" : { - "name" : "historyEntity" - } - }, - "InputPortsEntity" : { - "type" : "object", - "properties" : { - "inputPorts" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/PortEntity" - } - } - }, - "xml" : { - "name" : "inputPortsEntity" - } - }, - "InstantiateTemplateRequestEntity" : { - "type" : "object", - "properties" : { - "originX" : { - "type" : "number", - "format" : "double", - "description" : "The x coordinate of the origin of the bounding box where the new components will be placed." - }, - "originY" : { - "type" : "number", - "format" : "double", - "description" : "The y coordinate of the origin of the bounding box where the new components will be placed." - }, - "templateId" : { - "type" : "string", - "description" : "The identifier of the template." - }, - "encodingVersion" : { - "type" : "string", - "description" : "The encoding version of the flow snippet. If not specified, this is automatically populated by the node receiving the user request. If the snippet is specified, the version will be the latest. If the snippet is not specified, the version will come from the underlying template. These details need to be replicated throughout the cluster to ensure consistency." - }, - "snippet" : { - "description" : "A flow snippet of the template contents. If not specified, this is automatically populated by the node receiving the user request. These details need to be replicated throughout the cluster to ensure consistency.", - "$ref" : "#/definitions/FlowSnippetDTO" - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - } - }, - "xml" : { - "name" : "instantiateTemplateRequestEntity" - } - }, - "JVMControllerDiagnosticsSnapshotDTO" : { - "type" : "object", - "properties" : { - "primaryNode" : { - "type" : "boolean", - "description" : "Whether or not this node is primary node" - }, - "clusterCoordinator" : { - "type" : "boolean", - "description" : "Whether or not this node is cluster coordinator" - }, - "maxTimerDrivenThreads" : { - "type" : "integer", - "format" : "int32", - "description" : "The maximum number of timer-driven threads" - }, - "maxEventDrivenThreads" : { - "type" : "integer", - "format" : "int32", - "description" : "The maximum number of event-driven threads" - } - } - }, - "JVMDiagnosticsDTO" : { - "type" : "object", - "properties" : { - "clustered" : { - "type" : "boolean", - "description" : "Whether or not the NiFi instance is clustered" - }, - "connected" : { - "type" : "boolean", - "description" : "Whether or not the node is connected to the cluster" - }, - "aggregateSnapshot" : { - "description" : "Aggregate JVM diagnostic information about the entire cluster", - "$ref" : "#/definitions/JVMDiagnosticsSnapshotDTO" - }, - "nodeSnapshots" : { - "type" : "array", - "description" : "Node-wise breakdown of JVM diagnostic information", - "items" : { - "$ref" : "#/definitions/NodeJVMDiagnosticsSnapshotDTO" - } - } - } - }, - "JVMDiagnosticsSnapshotDTO" : { - "type" : "object", - "properties" : { - "systemDiagnosticsDto" : { - "description" : "System-related diagnostics information", - "$ref" : "#/definitions/JVMSystemDiagnosticsSnapshotDTO" - }, - "flowDiagnosticsDto" : { - "description" : "Flow-related diagnostics information", - "$ref" : "#/definitions/JVMFlowDiagnosticsSnapshotDTO" - }, - "controllerDiagnostics" : { - "description" : "Controller-related diagnostics information", - "$ref" : "#/definitions/JVMControllerDiagnosticsSnapshotDTO" - } - } - }, - "JVMFlowDiagnosticsSnapshotDTO" : { - "type" : "object", - "properties" : { - "uptime" : { - "type" : "string", - "description" : "How long this node has been running, formatted as hours:minutes:seconds.milliseconds" - }, - "timeZone" : { - "type" : "string", - "description" : "The name of the Time Zone that is configured, if available" - }, - "activeTimerDrivenThreads" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of timer-driven threads that are active" - }, - "activeEventDrivenThreads" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of event-driven threads that are active" - }, - "bundlesLoaded" : { - "type" : "array", - "description" : "The NiFi Bundles (NARs) that are loaded by NiFi", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/BundleDTO" - } - } - } - }, - "JVMSystemDiagnosticsSnapshotDTO" : { - "type" : "object", - "properties" : { - "flowFileRepositoryStorageUsage" : { - "description" : "Information about the FlowFile Repository's usage", - "$ref" : "#/definitions/RepositoryUsageDTO" - }, - "contentRepositoryStorageUsage" : { - "type" : "array", - "description" : "Information about the Content Repository's usage", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/RepositoryUsageDTO" - } - }, - "provenanceRepositoryStorageUsage" : { - "type" : "array", - "description" : "Information about the Provenance Repository's usage", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/RepositoryUsageDTO" - } - }, - "maxHeapBytes" : { - "type" : "integer", - "format" : "int64", - "description" : "The maximum number of bytes that the JVM heap is configured to use for heap" - }, - "maxHeap" : { - "type" : "string", - "description" : "The maximum number of bytes that the JVM heap is configured to use, as a human-readable value" - }, - "garbageCollectionDiagnostics" : { - "type" : "array", - "description" : "Diagnostic information about the JVM's garbage collections", - "items" : { - "$ref" : "#/definitions/GarbageCollectionDiagnosticsDTO" - } - }, - "cpuCores" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of CPU Cores available on the system" - }, - "cpuLoadAverage" : { - "type" : "number", - "format" : "double", - "description" : "The 1-minute CPU Load Average" - }, - "physicalMemoryBytes" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes of RAM available on the system" - }, - "physicalMemory" : { - "type" : "string", - "description" : "The number of bytes of RAM available on the system as a human-readable value" - }, - "openFileDescriptors" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of files that are open by the NiFi process" - }, - "maxOpenFileDescriptors" : { - "type" : "integer", - "format" : "int64", - "description" : "The maximum number of open file descriptors that are available to each process" - } - } - }, - "JaxbLink" : { - "type" : "object", - "properties" : { - "href" : { - "type" : "string", - "format" : "uri", - "xml" : { - "attribute" : true - }, - "description" : "The href for the link" - }, - "params" : { - "type" : "object", - "description" : "The params for the link", - "additionalProperties" : { - "type" : "string" - } - } - } - }, - "LabelDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "versionedComponentId" : { - "type" : "string", - "description" : "The ID of the corresponding component that is under version control" - }, - "parentGroupId" : { - "type" : "string", - "description" : "The id of parent process group of this component if applicable." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "label" : { - "type" : "string", - "description" : "The text that appears in the label." - }, - "width" : { - "type" : "number", - "format" : "double", - "description" : "The width of the label in pixels when at a 1:1 scale." - }, - "height" : { - "type" : "number", - "format" : "double", - "description" : "The height of the label in pixels when at a 1:1 scale." - }, - "style" : { - "type" : "object", - "description" : "The styles for this label (font-size : 12px, background-color : #eee, etc).", - "additionalProperties" : { - "type" : "string" - } - } - } - }, - "LabelEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "dimensions" : { - "$ref" : "#/definitions/DimensionsDTO" - }, - "component" : { - "$ref" : "#/definitions/LabelDTO" - } - }, - "xml" : { - "name" : "labelEntity" - } - }, - "LabelsEntity" : { - "type" : "object", - "properties" : { - "labels" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/LabelEntity" - } - } - }, - "xml" : { - "name" : "labelsEntity" - } - }, - "LineageDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of this lineage query." - }, - "uri" : { - "type" : "string", - "description" : "The URI for this lineage query for later retrieval and deletion." - }, - "submissionTime" : { - "type" : "string", - "description" : "When the lineage query was submitted." - }, - "expiration" : { - "type" : "string", - "description" : "When the lineage query will expire." - }, - "percentCompleted" : { - "type" : "integer", - "format" : "int32", - "description" : "The percent complete for the lineage query." - }, - "finished" : { - "type" : "boolean", - "description" : "Whether the lineage query has finished." - }, - "request" : { - "description" : "The initial lineage result.", - "$ref" : "#/definitions/LineageRequestDTO" - }, - "results" : { - "description" : "The results of the lineage query.", - "$ref" : "#/definitions/LineageResultsDTO" - } - } - }, - "LineageEntity" : { - "type" : "object", - "properties" : { - "lineage" : { - "$ref" : "#/definitions/LineageDTO" - } - }, - "xml" : { - "name" : "lineageEntity" - } - }, - "LineageRequestDTO" : { - "type" : "object", - "properties" : { - "eventId" : { - "type" : "integer", - "format" : "int64", - "description" : "The event id that was used to generate this lineage, if applicable. The event id is allowed for any type of lineageRequestType. If the lineageRequestType is FLOWFILE and the flowfile uuid is also included in the request, the event id will be ignored." - }, - "lineageRequestType" : { - "type" : "string", - "description" : "The type of lineage request. PARENTS will return the lineage for the flowfiles that are parents of the specified event. CHILDREN will return the lineage for the flowfiles that are children of the specified event. FLOWFILE will return the lineage for the specified flowfile.", - "enum" : [ "PARENTS", "CHILDREN", "and FLOWFILE" ] - }, - "uuid" : { - "type" : "string", - "description" : "The flowfile uuid that was used to generate the lineage. The flowfile uuid is only allowed when the lineageRequestType is FLOWFILE and will take precedence over event id." - }, - "clusterNodeId" : { - "type" : "string", - "description" : "The id of the node where this lineage originated if clustered." - } - } - }, - "LineageResultsDTO" : { - "type" : "object", - "properties" : { - "errors" : { - "type" : "array", - "description" : "Any errors that occurred while generating the lineage.", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - }, - "nodes" : { - "type" : "array", - "description" : "The nodes in the lineage.", - "items" : { - "$ref" : "#/definitions/ProvenanceNodeDTO" - } - }, - "links" : { - "type" : "array", - "description" : "The links between the nodes in the lineage.", - "items" : { - "$ref" : "#/definitions/ProvenanceLinkDTO" - } - } - } - }, - "ListingRequestDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id for this listing request." - }, - "uri" : { - "type" : "string", - "description" : "The URI for future requests to this listing request." - }, - "submissionTime" : { - "type" : "string", - "description" : "The timestamp when the query was submitted." - }, - "lastUpdated" : { - "type" : "string", - "description" : "The last time this listing request was updated." - }, - "percentCompleted" : { - "type" : "integer", - "format" : "int32", - "description" : "The current percent complete." - }, - "finished" : { - "type" : "boolean", - "description" : "Whether the query has finished." - }, - "failureReason" : { - "type" : "string", - "description" : "The reason, if any, that this listing request failed." - }, - "maxResults" : { - "type" : "integer", - "format" : "int32", - "description" : "The maximum number of FlowFileSummary objects to return" - }, - "state" : { - "type" : "string", - "description" : "The current state of the listing request." - }, - "queueSize" : { - "description" : "The size of the queue", - "$ref" : "#/definitions/QueueSizeDTO" - }, - "flowFileSummaries" : { - "type" : "array", - "description" : "The FlowFile summaries. The summaries will be populated once the request has completed.", - "items" : { - "$ref" : "#/definitions/FlowFileSummaryDTO" - } - }, - "sourceRunning" : { - "type" : "boolean", - "description" : "Whether the source of the connection is running" - }, - "destinationRunning" : { - "type" : "boolean", - "description" : "Whether the destination of the connection is running" - } - } - }, - "ListingRequestEntity" : { - "type" : "object", - "properties" : { - "listingRequest" : { - "$ref" : "#/definitions/ListingRequestDTO" - } - }, - "xml" : { - "name" : "listingRequestEntity" - } - }, - "LocalQueuePartitionDTO" : { - "type" : "object", - "properties" : { - "totalFlowFileCount" : { - "type" : "integer", - "format" : "int32", - "description" : "Total number of FlowFiles owned by the Connection" - }, - "totalByteCount" : { - "type" : "integer", - "format" : "int64", - "description" : "Total number of bytes that make up the content for the FlowFiles owned by this Connection" - }, - "activeQueueFlowFileCount" : { - "type" : "integer", - "format" : "int32", - "description" : "Total number of FlowFiles that exist in the Connection's Active Queue, immediately available to be offered up to a component" - }, - "activeQueueByteCount" : { - "type" : "integer", - "format" : "int64", - "description" : "Total number of bytes that make up the content for the FlowFiles that are present in the Connection's Active Queue" - }, - "swapFlowFileCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The total number of FlowFiles that are swapped out for this Connection" - }, - "swapByteCount" : { - "type" : "integer", - "format" : "int64", - "description" : "Total number of bytes that make up the content for the FlowFiles that are swapped out to disk for the Connection" - }, - "swapFiles" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of Swap Files that exist for this Connection" - }, - "inFlightFlowFileCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of In-Flight FlowFiles for this Connection. These are FlowFiles that belong to the connection but are currently being operated on by a Processor, Port, etc." - }, - "inFlightByteCount" : { - "type" : "integer", - "format" : "int64", - "description" : "The number bytes that make up the content of the FlowFiles that are In-Flight" - }, - "allActiveQueueFlowFilesPenalized" : { - "type" : "boolean", - "description" : "Whether or not all of the FlowFiles in the Active Queue are penalized" - }, - "anyActiveQueueFlowFilesPenalized" : { - "type" : "boolean", - "description" : "Whether or not any of the FlowFiles in the Active Queue are penalized" - } - } - }, - "NodeConnectionStatisticsSnapshotDTO" : { - "type" : "object", - "properties" : { - "nodeId" : { - "type" : "string", - "description" : "The unique ID that identifies the node" - }, - "address" : { - "type" : "string", - "description" : "The API address of the node" - }, - "apiPort" : { - "type" : "integer", - "format" : "int32", - "description" : "The API port used to communicate with the node" - }, - "statisticsSnapshot" : { - "description" : "The connection status snapshot from the node.", - "$ref" : "#/definitions/ConnectionStatisticsSnapshotDTO" - } - } - }, - "NodeConnectionStatusSnapshotDTO" : { - "type" : "object", - "properties" : { - "nodeId" : { - "type" : "string", - "description" : "The unique ID that identifies the node" - }, - "address" : { - "type" : "string", - "description" : "The API address of the node" - }, - "apiPort" : { - "type" : "integer", - "format" : "int32", - "description" : "The API port used to communicate with the node" - }, - "statusSnapshot" : { - "description" : "The connection status snapshot from the node.", - "$ref" : "#/definitions/ConnectionStatusSnapshotDTO" - } - } - }, - "NodeCountersSnapshotDTO" : { - "type" : "object", - "properties" : { - "nodeId" : { - "type" : "string", - "description" : "The unique ID that identifies the node" - }, - "address" : { - "type" : "string", - "description" : "The API address of the node" - }, - "apiPort" : { - "type" : "integer", - "format" : "int32", - "description" : "The API port used to communicate with the node" - }, - "snapshot" : { - "description" : "The counters from the node.", - "$ref" : "#/definitions/CountersSnapshotDTO" - } - } - }, - "NodeDTO" : { - "type" : "object", - "properties" : { - "nodeId" : { - "type" : "string", - "description" : "The id of the node." - }, - "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." - }, - "status" : { - "type" : "string", - "description" : "The node's status." - }, - "heartbeat" : { - "type" : "string", - "description" : "the time of the nodes's last heartbeat." - }, - "connectionRequested" : { - "type" : "string", - "description" : "The time of the node's last connection request." - }, - "roles" : { - "type" : "array", - "description" : "The roles of this node.", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - }, - "activeThreadCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The active threads for the NiFi on the node." - }, - "queued" : { - "type" : "string", - "description" : "The queue the NiFi on the node." - }, - "events" : { - "type" : "array", - "description" : "The node's events.", - "items" : { - "$ref" : "#/definitions/NodeEventDTO" - } - }, - "nodeStartTime" : { - "type" : "string", - "description" : "The time at which this Node was last refreshed." - } - } - }, - "NodeEntity" : { - "type" : "object", - "properties" : { - "node" : { - "$ref" : "#/definitions/NodeDTO" - } - }, - "xml" : { - "name" : "nodeEntity" - } - }, - "NodeEventDTO" : { - "type" : "object", - "properties" : { - "timestamp" : { - "type" : "string", - "description" : "The timestamp of the node event." - }, - "category" : { - "type" : "string", - "description" : "The category of the node event." - }, - "message" : { - "type" : "string", - "description" : "The message in the node event." - } - } - }, - "NodeJVMDiagnosticsSnapshotDTO" : { - "type" : "object", - "properties" : { - "nodeId" : { - "type" : "string", - "description" : "The unique ID that identifies the node" - }, - "address" : { - "type" : "string", - "description" : "The API address of the node" - }, - "apiPort" : { - "type" : "integer", - "format" : "int32", - "description" : "The API port used to communicate with the node" - }, - "snapshot" : { - "description" : "The JVM Diagnostics Snapshot", - "$ref" : "#/definitions/JVMDiagnosticsSnapshotDTO" - } - } - }, - "NodePortStatusSnapshotDTO" : { - "type" : "object", - "properties" : { - "nodeId" : { - "type" : "string", - "description" : "The unique ID that identifies the node" - }, - "address" : { - "type" : "string", - "description" : "The API address of the node" - }, - "apiPort" : { - "type" : "integer", - "format" : "int32", - "description" : "The API port used to communicate with the node" - }, - "statusSnapshot" : { - "description" : "The port status snapshot from the node.", - "$ref" : "#/definitions/PortStatusSnapshotDTO" - } - } - }, - "NodeProcessGroupStatusSnapshotDTO" : { - "type" : "object", - "properties" : { - "nodeId" : { - "type" : "string", - "description" : "The unique ID that identifies the node" - }, - "address" : { - "type" : "string", - "description" : "The API address of the node" - }, - "apiPort" : { - "type" : "integer", - "format" : "int32", - "description" : "The API port used to communicate with the node" - }, - "statusSnapshot" : { - "description" : "The process group status snapshot from the node.", - "$ref" : "#/definitions/ProcessGroupStatusSnapshotDTO" - } - } - }, - "NodeProcessorStatusSnapshotDTO" : { - "type" : "object", - "properties" : { - "nodeId" : { - "type" : "string", - "description" : "The unique ID that identifies the node" - }, - "address" : { - "type" : "string", - "description" : "The API address of the node" - }, - "apiPort" : { - "type" : "integer", - "format" : "int32", - "description" : "The API port used to communicate with the node" - }, - "statusSnapshot" : { - "description" : "The processor status snapshot from the node.", - "$ref" : "#/definitions/ProcessorStatusSnapshotDTO" - } - } - }, - "NodeRemoteProcessGroupStatusSnapshotDTO" : { - "type" : "object", - "properties" : { - "nodeId" : { - "type" : "string", - "description" : "The unique ID that identifies the node" - }, - "address" : { - "type" : "string", - "description" : "The API address of the node" - }, - "apiPort" : { - "type" : "integer", - "format" : "int32", - "description" : "The API port used to communicate with the node" - }, - "statusSnapshot" : { - "description" : "The remote process group status snapshot from the node.", - "$ref" : "#/definitions/RemoteProcessGroupStatusSnapshotDTO" - } - } - }, - "NodeSearchResultDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the node that matched the search." - }, - "address" : { - "type" : "string", - "description" : "The address of the node that matched the search." - } - } - }, - "NodeStatusSnapshotsDTO" : { - "type" : "object", - "properties" : { - "nodeId" : { - "type" : "string", - "description" : "The id of the node." - }, - "address" : { - "type" : "string", - "description" : "The node's host/ip address." - }, - "apiPort" : { - "type" : "integer", - "format" : "int32", - "description" : "The port the node is listening for API requests." - }, - "statusSnapshots" : { - "type" : "array", - "description" : "A list of StatusSnapshotDTO objects that provide the actual metric values for the component for this node.", - "items" : { - "$ref" : "#/definitions/StatusSnapshotDTO" - } - } - } - }, - "NodeSystemDiagnosticsSnapshotDTO" : { - "type" : "object", - "properties" : { - "nodeId" : { - "type" : "string", - "description" : "The unique ID that identifies the node" - }, - "address" : { - "type" : "string", - "description" : "The API address of the node" - }, - "apiPort" : { - "type" : "integer", - "format" : "int32", - "description" : "The API port used to communicate with the node" - }, - "snapshot" : { - "description" : "The System Diagnostics snapshot from the node.", - "$ref" : "#/definitions/SystemDiagnosticsSnapshotDTO" - } - } - }, - "OutputPortsEntity" : { - "type" : "object", - "properties" : { - "outputPorts" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/PortEntity" - } - } - }, - "xml" : { - "name" : "outputPortsEntity" - } - }, - "ParameterContextDTO" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The Name of the Parameter Context." - }, - "description" : { - "type" : "string", - "description" : "The Description of the Parameter Context." - }, - "parameters" : { - "type" : "array", - "description" : "The Parameters for the Parameter Context", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ParameterEntity" - } - }, - "boundProcessGroups" : { - "type" : "array", - "description" : "The Process Groups that are bound to this Parameter Context", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ProcessGroupEntity" - } - }, - "inheritedParameterContexts" : { - "type" : "array", - "description" : "A list of references of Parameter Contexts from which this one inherits parameters", - "items" : { - "$ref" : "#/definitions/ParameterContextReferenceEntity" - } - }, - "id" : { - "type" : "string", - "description" : "The ID the Parameter Context." - } - } - }, - "ParameterContextEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "component" : { - "description" : "The Parameter Context", - "$ref" : "#/definitions/ParameterContextDTO" - } - }, - "xml" : { - "name" : "parameterContextEntity" - } - }, - "ParameterContextReferenceDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The ID of the Parameter Context" - }, - "name" : { - "type" : "string", - "description" : "The name of the Parameter Context" - } - } - }, - "ParameterContextReferenceEntity" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "component" : { - "$ref" : "#/definitions/ParameterContextReferenceDTO" - } - }, - "xml" : { - "name" : "parameterContextReferenceEntity" - } - }, - "ParameterContextUpdateRequestDTO" : { - "type" : "object", - "properties" : { - "requestId" : { - "type" : "string", - "description" : "The ID of the request" - }, - "uri" : { - "type" : "string", - "description" : "The URI for the request" - }, - "submissionTime" : { - "type" : "string", - "format" : "date-time", - "description" : "The timestamp of when the request was submitted" - }, - "lastUpdated" : { - "type" : "string", - "format" : "date-time", - "description" : "The timestamp of when the request was last updated" - }, - "complete" : { - "type" : "boolean", - "description" : "Whether or not the request is completed" - }, - "failureReason" : { - "type" : "string", - "description" : "The reason for the request failing, or null if the request has not failed" - }, - "percentCompleted" : { - "type" : "integer", - "format" : "int32", - "description" : "A value between 0 and 100 (inclusive) indicating how close the request is to completion" - }, - "state" : { - "type" : "string", - "description" : "A description of the current state of the request" - }, - "updateSteps" : { - "type" : "array", - "description" : "The steps that are required in order to complete the request, along with the status of each", - "items" : { - "$ref" : "#/definitions/ParameterContextUpdateStepDTO" - } - }, - "parameterContext" : { - "description" : "The Parameter Context that is being operated on. This may not be populated until the request has successfully completed.", - "$ref" : "#/definitions/ParameterContextDTO" - }, - "referencingComponents" : { - "type" : "array", - "description" : "The components that are referenced by the update.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/AffectedComponentEntity" - } - } - } - }, - "ParameterContextUpdateRequestEntity" : { - "type" : "object", - "properties" : { - "parameterContextRevision" : { - "description" : "The Revision of the Parameter Context", - "$ref" : "#/definitions/RevisionDTO" - }, - "request" : { - "description" : "The Update Request", - "$ref" : "#/definitions/ParameterContextUpdateRequestDTO" - } - }, - "xml" : { - "name" : "parameterContextUpdateRequestEntity" - } - }, - "ParameterContextUpdateStepDTO" : { - "type" : "object", - "properties" : { - "description" : { - "type" : "string", - "description" : "Explanation of what happens in this step" - }, - "complete" : { - "type" : "boolean", - "description" : "Whether or not this step has completed" - }, - "failureReason" : { - "type" : "string", - "description" : "An explanation of why this step failed, or null if this step did not fail" - } - } - }, - "ParameterContextValidationRequestDTO" : { - "type" : "object", - "properties" : { - "requestId" : { - "type" : "string", - "description" : "The ID of the request" - }, - "uri" : { - "type" : "string", - "description" : "The URI for the request" - }, - "submissionTime" : { - "type" : "string", - "format" : "date-time", - "description" : "The timestamp of when the request was submitted" - }, - "lastUpdated" : { - "type" : "string", - "format" : "date-time", - "description" : "The timestamp of when the request was last updated" - }, - "complete" : { - "type" : "boolean", - "description" : "Whether or not the request is completed" - }, - "failureReason" : { - "type" : "string", - "description" : "The reason for the request failing, or null if the request has not failed" - }, - "percentCompleted" : { - "type" : "integer", - "format" : "int32", - "description" : "A value between 0 and 100 (inclusive) indicating how close the request is to completion" - }, - "state" : { - "type" : "string", - "description" : "A description of the current state of the request" - }, - "updateSteps" : { - "type" : "array", - "description" : "The steps that are required in order to complete the request, along with the status of each", - "items" : { - "$ref" : "#/definitions/ParameterContextValidationStepDTO" - } - }, - "parameterContext" : { - "description" : "The Parameter Context that is being operated on.", - "$ref" : "#/definitions/ParameterContextDTO" - }, - "componentValidationResults" : { - "description" : "The Validation Results that were calculated for each component. This value may not be set until the request completes.", - "$ref" : "#/definitions/ComponentValidationResultsEntity" - } - } - }, - "ParameterContextValidationRequestEntity" : { - "type" : "object", - "properties" : { - "request" : { - "description" : "The Update Request", - "$ref" : "#/definitions/ParameterContextValidationRequestDTO" - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - } - }, - "xml" : { - "name" : "parameterContextValidationRequestEntity" - } - }, - "ParameterContextValidationStepDTO" : { - "type" : "object", - "properties" : { - "description" : { - "type" : "string", - "description" : "Explanation of what happens in this step" - }, - "complete" : { - "type" : "boolean", - "description" : "Whether or not this step has completed" - }, - "failureReason" : { - "type" : "string", - "description" : "An explanation of why this step failed, or null if this step did not fail" - } - } - }, - "ParameterContextsEntity" : { - "type" : "object", - "properties" : { - "parameterContexts" : { - "type" : "array", - "description" : "The Parameter Contexts", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ParameterContextEntity" - } - }, - "currentTime" : { - "type" : "string", - "description" : "The current time on the system." - } - }, - "xml" : { - "name" : "parameterContexts" - } - }, - "ParameterDTO" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The name of the Parameter" - }, - "description" : { - "type" : "string", - "description" : "The description of the Parameter" - }, - "sensitive" : { - "type" : "boolean", - "description" : "Whether or not the Parameter is sensitive" - }, - "value" : { - "type" : "string", - "description" : "The value of the Parameter" - }, - "valueRemoved" : { - "type" : "boolean", - "description" : "Whether or not the value of the Parameter was removed. When a request is made to change a parameter, the value may be null. The 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). This denotes which of the two scenarios is being encountered." - }, - "referencingComponents" : { - "type" : "array", - "description" : "The set of all components in the flow that are referencing this Parameter", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/AffectedComponentEntity" - } - }, - "parameterContext" : { - "description" : "A reference to the Parameter Context that contains this one", - "$ref" : "#/definitions/ParameterContextReferenceEntity" - }, - "inherited" : { - "type" : "boolean", - "description" : "Whether or not the Parameter is inherited from another context" - } - } - }, - "ParameterEntity" : { - "type" : "object", - "properties" : { - "canWrite" : { - "type" : "boolean", - "description" : "Indicates whether the user can write a given resource." - }, - "parameter" : { - "description" : "The parameter information", - "$ref" : "#/definitions/ParameterDTO" - } - }, - "xml" : { - "name" : "parameterEntity" - } - }, - "PeerDTO" : { - "type" : "object", - "properties" : { - "hostname" : { - "type" : "string", - "description" : "The hostname of this peer." - }, - "port" : { - "type" : "integer", - "format" : "int32", - "description" : "The port number of this peer." - }, - "secure" : { - "type" : "boolean", - "description" : "Returns if this peer connection is secure." - }, - "flowFileCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of flowFiles this peer holds." - } - } - }, - "PeersEntity" : { - "type" : "object", - "properties" : { - "peers" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/PeerDTO" - } - } - }, - "xml" : { - "name" : "peersEntity" - } - }, - "Permissions" : { - "type" : "object", - "properties" : { - "canRead" : { - "type" : "boolean", - "description" : "Indicates whether the user can read a given resource.", - "readOnly" : true - }, - "canWrite" : { - "type" : "boolean", - "description" : "Indicates whether the user can write a given resource.", - "readOnly" : true - }, - "canDelete" : { - "type" : "boolean", - "description" : "Indicates whether the user can delete a given resource.", - "readOnly" : true - } - } - }, - "PermissionsDTO" : { - "type" : "object", - "properties" : { - "canRead" : { - "type" : "boolean", - "description" : "Indicates whether the user can read a given resource." - }, - "canWrite" : { - "type" : "boolean", - "description" : "Indicates whether the user can write a given resource." - } - } - }, - "PortDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "versionedComponentId" : { - "type" : "string", - "description" : "The ID of the corresponding component that is under version control" - }, - "parentGroupId" : { - "type" : "string", - "description" : "The id of parent process group of this component if applicable." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "name" : { - "type" : "string", - "description" : "The name of the port." - }, - "comments" : { - "type" : "string", - "description" : "The comments for the port." - }, - "state" : { - "type" : "string", - "description" : "The state of the port.", - "enum" : [ "RUNNING", "STOPPED", "DISABLED" ] - }, - "type" : { - "type" : "string", - "description" : "The type of port.", - "enum" : [ "INPUT_PORT", "OUTPUT_PORT" ] - }, - "transmitting" : { - "type" : "boolean", - "description" : "Whether the port has incoming or output connections to a remote NiFi. This is only applicable when the port is allowed to be accessed remotely." - }, - "concurrentlySchedulableTaskCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of tasks that should be concurrently scheduled for the port." - }, - "userAccessControl" : { - "type" : "array", - "description" : "The users that are allowed to access the port.", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - }, - "groupAccessControl" : { - "type" : "array", - "description" : "The user groups that are allowed to access the port.", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - }, - "allowRemoteAccess" : { - "type" : "boolean", - "description" : "Whether this port can be accessed remotely via Site-to-Site protocol." - }, - "validationErrors" : { - "type" : "array", - "description" : "Gets the validation errors from this port. These validation errors represent the problems with the port that must be resolved before it can be started.", - "items" : { - "type" : "string" - } - } - } - }, - "PortEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "component" : { - "$ref" : "#/definitions/PortDTO" - }, - "status" : { - "description" : "The status of the port.", - "$ref" : "#/definitions/PortStatusDTO" - }, - "portType" : { - "type" : "string" - }, - "operatePermissions" : { - "description" : "The permissions for this component operations.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "allowRemoteAccess" : { - "type" : "boolean", - "description" : "Whether this port can be accessed remotely via Site-to-Site protocol." - } - }, - "xml" : { - "name" : "portEntity" - } - }, - "PortRunStatusEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "state" : { - "type" : "string", - "description" : "The run status of the Port.", - "enum" : [ "RUNNING", "STOPPED", "DISABLED" ] - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - } - }, - "xml" : { - "name" : "entity" - } - }, - "PortStatusDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the port." - }, - "groupId" : { - "type" : "string", - "description" : "The id of the parent process group of the port." - }, - "name" : { - "type" : "string", - "description" : "The name of the port." - }, - "transmitting" : { - "type" : "boolean", - "description" : "Whether the port has incoming or outgoing connections to a remote NiFi." - }, - "runStatus" : { - "type" : "string", - "description" : "The run status of the port.", - "enum" : [ "Running", "Stopped", "Validating", "Disabled", "Invalid" ] - }, - "statsLastRefreshed" : { - "type" : "string", - "description" : "The time the status for the process group was last refreshed." - }, - "aggregateSnapshot" : { - "description" : "A status snapshot that represents the aggregate stats of all nodes in the cluster. If the NiFi instance is a standalone instance, rather than a cluster, this represents the stats of the single instance.", - "$ref" : "#/definitions/PortStatusSnapshotDTO" - }, - "nodeSnapshots" : { - "type" : "array", - "description" : "A status snapshot for each node in the cluster. If the NiFi instance is a standalone instance, rather than a cluster, this may be null.", - "items" : { - "$ref" : "#/definitions/NodePortStatusSnapshotDTO" - } - } - } - }, - "PortStatusEntity" : { - "type" : "object", - "properties" : { - "portStatus" : { - "$ref" : "#/definitions/PortStatusDTO" - }, - "canRead" : { - "type" : "boolean", - "description" : "Indicates whether the user can read a given resource." - } - }, - "xml" : { - "name" : "portStatusEntity" - } - }, - "PortStatusSnapshotDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the port." - }, - "groupId" : { - "type" : "string", - "description" : "The id of the parent process group of the port." - }, - "name" : { - "type" : "string", - "description" : "The name of the port." - }, - "activeThreadCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The active thread count for the port." - }, - "flowFilesIn" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of FlowFiles that have been accepted in the last 5 minutes." - }, - "bytesIn" : { - "type" : "integer", - "format" : "int64", - "description" : "The size of hte FlowFiles that have been accepted in the last 5 minutes." - }, - "input" : { - "type" : "string", - "description" : "The count/size of flowfiles that have been accepted in the last 5 minutes." - }, - "flowFilesOut" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of FlowFiles that have been processed in the last 5 minutes." - }, - "bytesOut" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes that have been processed in the last 5 minutes." - }, - "output" : { - "type" : "string", - "description" : "The count/size of flowfiles that have been processed in the last 5 minutes." - }, - "transmitting" : { - "type" : "boolean", - "description" : "Whether the port has incoming or outgoing connections to a remote NiFi." - }, - "runStatus" : { - "type" : "string", - "description" : "The run status of the port.", - "enum" : [ "Running", "Stopped", "Validating", "Disabled", "Invalid" ] - } - } - }, - "PortStatusSnapshotEntity" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the port." - }, - "portStatusSnapshot" : { - "$ref" : "#/definitions/PortStatusSnapshotDTO" - }, - "canRead" : { - "type" : "boolean", - "description" : "Indicates whether the user can read a given resource." - } - }, - "xml" : { - "name" : "entity" - } - }, - "Position" : { - "type" : "object", - "properties" : { - "x" : { - "type" : "number", - "format" : "double", - "description" : "The x coordinate." - }, - "y" : { - "type" : "number", - "format" : "double", - "description" : "The y coordinate." - } - }, - "description" : "The position of a component on the graph" - }, - "PositionDTO" : { - "type" : "object", - "properties" : { - "x" : { - "type" : "number", - "format" : "double", - "description" : "The x coordinate." - }, - "y" : { - "type" : "number", - "format" : "double", - "description" : "The y coordinate." - } - } - }, - "PreviousValueDTO" : { - "type" : "object", - "properties" : { - "previousValue" : { - "type" : "string", - "description" : "The previous value." - }, - "timestamp" : { - "type" : "string", - "description" : "The timestamp when the value was modified." - }, - "userIdentity" : { - "type" : "string", - "description" : "The user who changed the previous value." - } - } - }, - "PrioritizerTypesEntity" : { - "type" : "object", - "properties" : { - "prioritizerTypes" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/DocumentedTypeDTO" - } - } - }, - "xml" : { - "name" : "prioritizerTypesEntity" - } - }, - "ProcessGroupDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "versionedComponentId" : { - "type" : "string", - "description" : "The ID of the corresponding component that is under version control" - }, - "parentGroupId" : { - "type" : "string", - "description" : "The id of parent process group of this component if applicable." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "name" : { - "type" : "string", - "description" : "The name of the process group." - }, - "comments" : { - "type" : "string", - "description" : "The comments for the process group." - }, - "variables" : { - "type" : "object", - "description" : "The variables that are configured for the Process Group. Note that this map contains only those variables that are defined on this Process Group and not any variables that are defined in the parent Process Group, etc. I.e., this Map will not contain all variables that are accessible by components in this Process Group by rather only the variables that are defined for this Process Group itself.", - "additionalProperties" : { - "type" : "string" - } - }, - "versionControlInformation" : { - "description" : "The Version Control information that indicates which Flow Registry, and where in the Flow Registry, this Process Group is tracking to; or null if this Process Group is not under version control", - "$ref" : "#/definitions/VersionControlInformationDTO" - }, - "parameterContext" : { - "description" : "The Parameter Context that this Process Group is bound to.", - "$ref" : "#/definitions/ParameterContextReferenceEntity" - }, - "flowfileConcurrency" : { - "type" : "string", - "description" : "The FlowFile Concurrency for this Process Group.", - "enum" : [ "UNBOUNDED", "SINGLE_FLOWFILE_PER_NODE" ] - }, - "flowfileOutboundPolicy" : { - "type" : "string", - "description" : "The Outbound Policy that is used for determining how FlowFiles should be transferred out of the Process Group.", - "enum" : [ "STREAM_WHEN_AVAILABLE", "BATCH_OUTPUT" ] - }, - "defaultFlowFileExpiration" : { - "type" : "string", - "description" : "The default FlowFile Expiration for this Process Group." - }, - "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." - }, - "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." - }, - "runningCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of running components in this process group." - }, - "stoppedCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of stopped components in the process group." - }, - "invalidCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of invalid components in the process group." - }, - "disabledCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of disabled components in the process group." - }, - "activeRemotePortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of active remote ports in the process group." - }, - "inactiveRemotePortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of inactive remote ports in the process group." - }, - "upToDateCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of up to date versioned process groups in the process group." - }, - "locallyModifiedCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of locally modified versioned process groups in the process group." - }, - "staleCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of stale versioned process groups in the process group." - }, - "locallyModifiedAndStaleCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of locally modified and stale versioned process groups in the process group." - }, - "syncFailureCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of versioned process groups in the process group that are unable to sync to a registry." - }, - "localInputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of local input ports in the process group." - }, - "localOutputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of local output ports in the process group." - }, - "publicInputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of public input ports in the process group." - }, - "publicOutputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of public output ports in the process group." - }, - "contents" : { - "description" : "The contents of this process group.", - "$ref" : "#/definitions/FlowSnippetDTO" - }, - "inputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of input ports in the process group." - }, - "outputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of output ports in the process group." - } - } - }, - "ProcessGroupEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "component" : { - "$ref" : "#/definitions/ProcessGroupDTO" - }, - "status" : { - "description" : "The status of the process group.", - "$ref" : "#/definitions/ProcessGroupStatusDTO" - }, - "versionedFlowSnapshot" : { - "description" : "Returns the Versioned Flow that describes the contents of the Versioned Flow to be imported", - "$ref" : "#/definitions/VersionedFlowSnapshot" - }, - "runningCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of running components in this process group." - }, - "stoppedCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of stopped components in the process group." - }, - "invalidCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of invalid components in the process group." - }, - "disabledCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of disabled components in the process group." - }, - "activeRemotePortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of active remote ports in the process group." - }, - "inactiveRemotePortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of inactive remote ports in the process group." - }, - "versionedFlowState" : { - "type" : "string", - "description" : "The current state of the Process Group, as it relates to the Versioned Flow", - "enum" : [ "LOCALLY_MODIFIED", "STALE", "LOCALLY_MODIFIED_AND_STALE", "UP_TO_DATE", "SYNC_FAILURE" ] - }, - "upToDateCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of up to date versioned process groups in the process group." - }, - "locallyModifiedCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of locally modified versioned process groups in the process group." - }, - "staleCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of stale versioned process groups in the process group." - }, - "locallyModifiedAndStaleCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of locally modified and stale versioned process groups in the process group." - }, - "syncFailureCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of versioned process groups in the process group that are unable to sync to a registry." - }, - "localInputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of local input ports in the process group." - }, - "localOutputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of local output ports in the process group." - }, - "publicInputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of public input ports in the process group." - }, - "publicOutputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of public output ports in the process group." - }, - "parameterContext" : { - "description" : "The Parameter Context, or null if no Parameter Context has been bound to the Process Group", - "$ref" : "#/definitions/ParameterContextReferenceEntity" - }, - "inputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of input ports in the process group." - }, - "outputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of output ports in the process group." - } - }, - "xml" : { - "name" : "processGroupEntity" - } - }, - "ProcessGroupFlowDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "parentGroupId" : { - "type" : "string", - "description" : "The id of parent process group of this component if applicable." - }, - "parameterContext" : { - "description" : "The Parameter Context, or null if no Parameter Context has been bound to the Process Group", - "$ref" : "#/definitions/ParameterContextReferenceEntity" - }, - "breadcrumb" : { - "description" : "The breadcrumb of the process group.", - "$ref" : "#/definitions/FlowBreadcrumbEntity" - }, - "flow" : { - "description" : "The flow structure starting at this Process Group.", - "$ref" : "#/definitions/FlowDTO" - }, - "lastRefreshed" : { - "type" : "string", - "description" : "The time the flow for the process group was last refreshed." - } - } - }, - "ProcessGroupFlowEntity" : { - "type" : "object", - "properties" : { - "permissions" : { - "description" : "The access policy for this process group.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "processGroupFlow" : { - "$ref" : "#/definitions/ProcessGroupFlowDTO" - } - }, - "xml" : { - "name" : "processGroupFlowEntity" - } - }, - "ProcessGroupImportEntity" : { - "type" : "object", - "properties" : { - "processGroupRevision" : { - "description" : "The Revision for the Process Group", - "$ref" : "#/definitions/RevisionDTO" - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "versionedFlowSnapshot" : { - "description" : "The Versioned Flow Snapshot to import", - "$ref" : "#/definitions/VersionedFlowSnapshot" - } - }, - "xml" : { - "name" : "processGroupImportEntity" - } - }, - "ProcessGroupNameDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The ID of the Process Group" - }, - "name" : { - "type" : "string", - "description" : "The name of the Process Group, or the ID of the Process Group if the user does not have the READ policy for the Process Group" - } - } - }, - "ProcessGroupReplaceRequestDTO" : { - "type" : "object", - "properties" : { - "requestId" : { - "type" : "string", - "description" : "The unique ID of this request." - }, - "processGroupId" : { - "type" : "string", - "description" : "The unique ID of the Process Group being updated" - }, - "uri" : { - "type" : "string", - "description" : "The URI for future requests to this drop request." - }, - "lastUpdated" : { - "type" : "string", - "description" : "The last time this request was updated." - }, - "complete" : { - "type" : "boolean", - "description" : "Whether or not this request has completed" - }, - "failureReason" : { - "type" : "string", - "description" : "An explanation of why this request failed, or null if this request has not failed" - }, - "percentCompleted" : { - "type" : "integer", - "format" : "int32", - "description" : "The percentage complete for the request, between 0 and 100" - }, - "state" : { - "type" : "string", - "description" : "The state of the request" - } - } - }, - "ProcessGroupReplaceRequestEntity" : { - "type" : "object", - "properties" : { - "processGroupRevision" : { - "description" : "The revision for the Process Group being updated.", - "$ref" : "#/definitions/RevisionDTO" - }, - "request" : { - "description" : "The Process Group Change Request", - "$ref" : "#/definitions/ProcessGroupReplaceRequestDTO" - }, - "versionedFlowSnapshot" : { - "description" : "Returns the Versioned Flow to replace with", - "$ref" : "#/definitions/VersionedFlowSnapshot" - } - }, - "xml" : { - "name" : "processGroupReplaceRequestEntity" - } - }, - "ProcessGroupStatusDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The ID of the Process Group" - }, - "name" : { - "type" : "string", - "description" : "The name of the Process Group" - }, - "statsLastRefreshed" : { - "type" : "string", - "description" : "The time the status for the process group was last refreshed." - }, - "aggregateSnapshot" : { - "description" : "The aggregate status of all nodes in the cluster", - "$ref" : "#/definitions/ProcessGroupStatusSnapshotDTO" - }, - "nodeSnapshots" : { - "type" : "array", - "description" : "The status reported by each node in the cluster. If the NiFi instance is a standalone instance, rather than a clustered instance, this value may be null.", - "items" : { - "$ref" : "#/definitions/NodeProcessGroupStatusSnapshotDTO" - } - } - } - }, - "ProcessGroupStatusEntity" : { - "type" : "object", - "properties" : { - "processGroupStatus" : { - "$ref" : "#/definitions/ProcessGroupStatusDTO" - }, - "canRead" : { - "type" : "boolean", - "description" : "Indicates whether the user can read a given resource." - } - }, - "xml" : { - "name" : "processGroupStatusEntity" - } - }, - "ProcessGroupStatusSnapshotDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the process group." - }, - "name" : { - "type" : "string", - "description" : "The name of this process group." - }, - "connectionStatusSnapshots" : { - "type" : "array", - "description" : "The status of all connections in the process group.", - "items" : { - "$ref" : "#/definitions/ConnectionStatusSnapshotEntity" - } - }, - "processorStatusSnapshots" : { - "type" : "array", - "description" : "The status of all processors in the process group.", - "items" : { - "$ref" : "#/definitions/ProcessorStatusSnapshotEntity" - } - }, - "processGroupStatusSnapshots" : { - "type" : "array", - "description" : "The status of all process groups in the process group.", - "items" : { - "$ref" : "#/definitions/ProcessGroupStatusSnapshotEntity" - } - }, - "remoteProcessGroupStatusSnapshots" : { - "type" : "array", - "description" : "The status of all remote process groups in the process group.", - "items" : { - "$ref" : "#/definitions/RemoteProcessGroupStatusSnapshotEntity" - } - }, - "inputPortStatusSnapshots" : { - "type" : "array", - "description" : "The status of all input ports in the process group.", - "items" : { - "$ref" : "#/definitions/PortStatusSnapshotEntity" - } - }, - "outputPortStatusSnapshots" : { - "type" : "array", - "description" : "The status of all output ports in the process group.", - "items" : { - "$ref" : "#/definitions/PortStatusSnapshotEntity" - } - }, - "versionedFlowState" : { - "type" : "string", - "description" : "The current state of the Process Group, as it relates to the Versioned Flow", - "enum" : [ "LOCALLY_MODIFIED", "STALE", "LOCALLY_MODIFIED_AND_STALE", "UP_TO_DATE", "SYNC_FAILURE" ] - }, - "flowFilesIn" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of FlowFiles that have come into this ProcessGroup in the last 5 minutes" - }, - "bytesIn" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes that have come into this ProcessGroup in the last 5 minutes" - }, - "input" : { - "type" : "string", - "description" : "The input count/size for the process group in the last 5 minutes (pretty printed)." - }, - "flowFilesQueued" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of FlowFiles that are queued up in this ProcessGroup right now" - }, - "bytesQueued" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes that are queued up in this ProcessGroup right now" - }, - "queued" : { - "type" : "string", - "description" : "The count/size that is queued in the the process group." - }, - "queuedCount" : { - "type" : "string", - "description" : "The count that is queued for the process group." - }, - "queuedSize" : { - "type" : "string", - "description" : "The size that is queued for the process group." - }, - "bytesRead" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes read by components in this ProcessGroup in the last 5 minutes" - }, - "read" : { - "type" : "string", - "description" : "The number of bytes read in the last 5 minutes." - }, - "bytesWritten" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes written by components in this ProcessGroup in the last 5 minutes" - }, - "written" : { - "type" : "string", - "description" : "The number of bytes written in the last 5 minutes." - }, - "flowFilesOut" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of FlowFiles transferred out of this ProcessGroup in the last 5 minutes" - }, - "bytesOut" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes transferred out of this ProcessGroup in the last 5 minutes" - }, - "output" : { - "type" : "string", - "description" : "The output count/size for the process group in the last 5 minutes." - }, - "flowFilesTransferred" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of FlowFiles transferred in this ProcessGroup in the last 5 minutes" - }, - "bytesTransferred" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes transferred in this ProcessGroup in the last 5 minutes" - }, - "transferred" : { - "type" : "string", - "description" : "The count/size transferred to/from queues in the process group in the last 5 minutes." - }, - "bytesReceived" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes received from external sources by components within this ProcessGroup in the last 5 minutes" - }, - "flowFilesReceived" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of FlowFiles received from external sources by components within this ProcessGroup in the last 5 minutes" - }, - "received" : { - "type" : "string", - "description" : "The count/size sent to the process group in the last 5 minutes." - }, - "bytesSent" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes sent to an external sink by components within this ProcessGroup in the last 5 minutes" - }, - "flowFilesSent" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of FlowFiles sent to an external sink by components within this ProcessGroup in the last 5 minutes" - }, - "sent" : { - "type" : "string", - "description" : "The count/size sent from this process group in the last 5 minutes." - }, - "activeThreadCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The active thread count for this process group." - }, - "terminatedThreadCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of threads currently terminated for the process group." - } - } - }, - "ProcessGroupStatusSnapshotEntity" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the process group." - }, - "processGroupStatusSnapshot" : { - "$ref" : "#/definitions/ProcessGroupStatusSnapshotDTO" - }, - "canRead" : { - "type" : "boolean", - "description" : "Indicates whether the user can read a given resource." - } - }, - "xml" : { - "name" : "entity" - } - }, - "ProcessGroupsEntity" : { - "type" : "object", - "properties" : { - "processGroups" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ProcessGroupEntity" - } - } - }, - "xml" : { - "name" : "processGroupsEntity" - } - }, - "ProcessorConfigDTO" : { - "type" : "object", - "properties" : { - "properties" : { - "type" : "object", - "description" : "The properties for the processor. Properties whose value is not set will only contain the property name.", - "additionalProperties" : { - "type" : "string" - } - }, - "descriptors" : { - "type" : "object", - "description" : "Descriptors for the processor's properties.", - "additionalProperties" : { - "$ref" : "#/definitions/PropertyDescriptorDTO" - } - }, - "schedulingPeriod" : { - "type" : "string", - "description" : "The frequency with which to schedule the processor. The format of the value will depend on th value of schedulingStrategy." - }, - "schedulingStrategy" : { - "type" : "string", - "description" : "Indcates whether the prcessor should be scheduled to run in event or timer driven mode." - }, - "executionNode" : { - "type" : "string", - "description" : "Indicates the node where the process will execute." - }, - "penaltyDuration" : { - "type" : "string", - "description" : "The amount of time that is used when the process penalizes a flowfile." - }, - "yieldDuration" : { - "type" : "string", - "description" : "The amount of time that must elapse before this processor is scheduled again after yielding." - }, - "bulletinLevel" : { - "type" : "string", - "description" : "The level at which the processor will report bulletins." - }, - "runDurationMillis" : { - "type" : "integer", - "format" : "int64", - "description" : "The run duration for the processor in milliseconds." - }, - "concurrentlySchedulableTaskCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of tasks that should be concurrently schedule for the processor. If the processor doesn't allow parallol processing then any positive input will be ignored." - }, - "autoTerminatedRelationships" : { - "type" : "array", - "description" : "The names of all relationships that cause a flow file to be terminated if the relationship is not connected elsewhere. This property differs from the 'isAutoTerminate' property of the RelationshipDTO in that the RelationshipDTO is meant to depict the current configuration, whereas this property can be set in a DTO when updating a Processor in order to change which Relationships should be auto-terminated.", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - }, - "comments" : { - "type" : "string", - "description" : "The comments for the processor." - }, - "customUiUrl" : { - "type" : "string", - "description" : "The URL for the processor's custom configuration UI if applicable." - }, - "lossTolerant" : { - "type" : "boolean", - "description" : "Whether the processor is loss tolerant." - }, - "annotationData" : { - "type" : "string", - "description" : "The annotation data for the processor used to relay configuration between a custom UI and the procesosr." - }, - "defaultConcurrentTasks" : { - "type" : "object", - "description" : "Maps default values for concurrent tasks for each applicable scheduling strategy.", - "additionalProperties" : { - "type" : "string" - } - }, - "defaultSchedulingPeriod" : { - "type" : "object", - "description" : "Maps default values for scheduling period for each applicable scheduling strategy.", - "additionalProperties" : { - "type" : "string" - } - } - } - }, - "ProcessorDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "versionedComponentId" : { - "type" : "string", - "description" : "The ID of the corresponding component that is under version control" - }, - "parentGroupId" : { - "type" : "string", - "description" : "The id of parent process group of this component if applicable." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "name" : { - "type" : "string", - "description" : "The name of the processor." - }, - "type" : { - "type" : "string", - "description" : "The type of the processor." - }, - "bundle" : { - "description" : "The details of the artifact that bundled this processor type.", - "$ref" : "#/definitions/BundleDTO" - }, - "state" : { - "type" : "string", - "description" : "The state of the processor", - "enum" : [ "RUNNING", "STOPPED", "DISABLED" ] - }, - "style" : { - "type" : "object", - "description" : "Styles for the processor (background-color : #eee).", - "additionalProperties" : { - "type" : "string" - } - }, - "relationships" : { - "type" : "array", - "description" : "The available relationships that the processor currently supports.", - "items" : { - "$ref" : "#/definitions/RelationshipDTO" - } - }, - "description" : { - "type" : "string", - "description" : "The description of the processor." - }, - "supportsParallelProcessing" : { - "type" : "boolean", - "description" : "Whether the processor supports parallel processing." - }, - "supportsEventDriven" : { - "type" : "boolean", - "description" : "Whether the processor supports event driven scheduling." - }, - "supportsBatching" : { - "type" : "boolean", - "description" : "Whether the processor supports batching. This makes the run duration settings available." - }, - "persistsState" : { - "type" : "boolean", - "description" : "Whether the processor persists state." - }, - "restricted" : { - "type" : "boolean", - "description" : "Whether the processor requires elevated privileges." - }, - "deprecated" : { - "type" : "boolean", - "description" : "Whether the processor has been deprecated." - }, - "executionNodeRestricted" : { - "type" : "boolean", - "description" : "Indicates if the execution node of a processor is restricted to run only on the primary node" - }, - "multipleVersionsAvailable" : { - "type" : "boolean", - "description" : "Whether the processor has multiple versions available." - }, - "inputRequirement" : { - "type" : "string", - "description" : "The input requirement for this processor." - }, - "config" : { - "description" : "The configuration details for the processor. These details will be included in a response if the verbose flag is included in a request.", - "$ref" : "#/definitions/ProcessorConfigDTO" - }, - "validationErrors" : { - "type" : "array", - "description" : "The validation errors for the processor. These validation errors represent the problems with the processor that must be resolved before it can be started.", - "items" : { - "type" : "string" - } - }, - "validationStatus" : { - "type" : "string", - "description" : "Indicates whether the Processor is valid, invalid, or still in the process of validating (i.e., it is unknown whether or not the Processor is valid)", - "enum" : [ "VALID", "INVALID", "VALIDATING" ] - }, - "extensionMissing" : { - "type" : "boolean", - "description" : "Whether the underlying extension is missing." - } - } - }, - "ProcessorDiagnosticsDTO" : { - "type" : "object", - "properties" : { - "processor" : { - "description" : "Information about the Processor for which the Diagnostic Report is generated", - "$ref" : "#/definitions/ProcessorDTO" - }, - "processorStatus" : { - "description" : "The Status for the Processor for which the Diagnostic Report is generated", - "$ref" : "#/definitions/ProcessorStatusDTO" - }, - "referencedControllerServices" : { - "type" : "array", - "description" : "Diagnostic Information about all Controller Services that the Processor is referencing", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ControllerServiceDiagnosticsDTO" - } - }, - "incomingConnections" : { - "type" : "array", - "description" : "Diagnostic Information about all incoming Connections", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ConnectionDiagnosticsDTO" - } - }, - "outgoingConnections" : { - "type" : "array", - "description" : "Diagnostic Information about all outgoing Connections", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ConnectionDiagnosticsDTO" - } - }, - "jvmDiagnostics" : { - "description" : "Diagnostic Information about the JVM and system-level diagnostics", - "$ref" : "#/definitions/JVMDiagnosticsDTO" - }, - "threadDumps" : { - "type" : "array", - "description" : "Thread Dumps that were taken of the threads that are active in the Processor", - "items" : { - "$ref" : "#/definitions/ThreadDumpDTO" - } - }, - "classLoaderDiagnostics" : { - "description" : "Information about the Controller Service's Class Loader", - "$ref" : "#/definitions/ClassLoaderDiagnosticsDTO" - } - } - }, - "ProcessorDiagnosticsEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "component" : { - "description" : "The Processor Diagnostics", - "$ref" : "#/definitions/ProcessorDiagnosticsDTO" - } - }, - "xml" : { - "name" : "processorDiagnosticsEntity" - } - }, - "ProcessorEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "component" : { - "$ref" : "#/definitions/ProcessorDTO" - }, - "inputRequirement" : { - "type" : "string", - "description" : "The input requirement for this processor." - }, - "status" : { - "$ref" : "#/definitions/ProcessorStatusDTO" - }, - "operatePermissions" : { - "description" : "The permissions for this component operations.", - "$ref" : "#/definitions/PermissionsDTO" - } - }, - "xml" : { - "name" : "processorEntity" - } - }, - "ProcessorRunStatusDetailsDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The ID of the processor" - }, - "name" : { - "type" : "string", - "description" : "The name of the processor" - }, - "runStatus" : { - "type" : "string", - "description" : "The run status of the processor", - "enum" : [ "Running", "Stopped", "Invalid", "Validating", "Disabled" ] - }, - "validationErrors" : { - "type" : "array", - "description" : "The processor's validation errors", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - }, - "activeThreadCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The current number of threads that the processor is currently using" - } - } - }, - "ProcessorRunStatusDetailsEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for the Processor.", - "$ref" : "#/definitions/RevisionDTO" - }, - "permissions" : { - "description" : "The permissions for the Processor.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "runStatusDetails" : { - "description" : "The details of a Processor's run status", - "$ref" : "#/definitions/ProcessorRunStatusDetailsDTO" - } - }, - "xml" : { - "name" : "entity" - } - }, - "ProcessorRunStatusEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "state" : { - "type" : "string", - "description" : "The run status of the Processor.", - "enum" : [ "RUNNING", "STOPPED", "DISABLED" ] - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - } - }, - "xml" : { - "name" : "entity" - } - }, - "ProcessorStatusDTO" : { - "type" : "object", - "properties" : { - "groupId" : { - "type" : "string", - "description" : "The unique ID of the process group that the Processor belongs to" - }, - "id" : { - "type" : "string", - "description" : "The unique ID of the Processor" - }, - "name" : { - "type" : "string", - "description" : "The name of the Processor" - }, - "type" : { - "type" : "string", - "description" : "The type of the Processor" - }, - "runStatus" : { - "type" : "string", - "description" : "The run status of the Processor", - "enum" : [ "Running", "Stopped", "Validating", "Disabled", "Invalid" ] - }, - "statsLastRefreshed" : { - "type" : "string", - "description" : "The timestamp of when the stats were last refreshed" - }, - "aggregateSnapshot" : { - "description" : "A status snapshot that represents the aggregate stats of all nodes in the cluster. If the NiFi instance is a standalone instance, rather than a cluster, this represents the stats of the single instance.", - "$ref" : "#/definitions/ProcessorStatusSnapshotDTO" - }, - "nodeSnapshots" : { - "type" : "array", - "description" : "A status snapshot for each node in the cluster. If the NiFi instance is a standalone instance, rather than a cluster, this may be null.", - "items" : { - "$ref" : "#/definitions/NodeProcessorStatusSnapshotDTO" - } - } - } - }, - "ProcessorStatusEntity" : { - "type" : "object", - "properties" : { - "processorStatus" : { - "$ref" : "#/definitions/ProcessorStatusDTO" - }, - "canRead" : { - "type" : "boolean", - "description" : "Indicates whether the user can read a given resource." - } - }, - "xml" : { - "name" : "processorStatusEntity" - } - }, - "ProcessorStatusSnapshotDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the processor." - }, - "groupId" : { - "type" : "string", - "description" : "The id of the parent process group to which the processor belongs." - }, - "name" : { - "type" : "string", - "description" : "The name of the prcessor." - }, - "type" : { - "type" : "string", - "description" : "The type of the processor." - }, - "runStatus" : { - "type" : "string", - "description" : "The state of the processor.", - "enum" : [ "Running", "Stopped", "Validating", "Disabled", "Invalid" ] - }, - "executionNode" : { - "type" : "string", - "description" : "Indicates the node where the process will execute.", - "enum" : [ "ALL", "PRIMARY" ] - }, - "bytesRead" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes read by this Processor in the last 5 mintues" - }, - "bytesWritten" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes written by this Processor in the last 5 minutes" - }, - "read" : { - "type" : "string", - "description" : "The number of bytes read in the last 5 minutes." - }, - "written" : { - "type" : "string", - "description" : "The number of bytes written in the last 5 minutes." - }, - "flowFilesIn" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of FlowFiles that have been accepted in the last 5 minutes" - }, - "bytesIn" : { - "type" : "integer", - "format" : "int64", - "description" : "The size of the FlowFiles that have been accepted in the last 5 minutes" - }, - "input" : { - "type" : "string", - "description" : "The count/size of flowfiles that have been accepted in the last 5 minutes." - }, - "flowFilesOut" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of FlowFiles transferred to a Connection in the last 5 minutes" - }, - "bytesOut" : { - "type" : "integer", - "format" : "int64", - "description" : "The size of the FlowFiles transferred to a Connection in the last 5 minutes" - }, - "output" : { - "type" : "string", - "description" : "The count/size of flowfiles that have been processed in the last 5 minutes." - }, - "taskCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of times this Processor has run in the last 5 minutes" - }, - "tasksDurationNanos" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of nanoseconds that this Processor has spent running in the last 5 minutes" - }, - "tasks" : { - "type" : "string", - "description" : "The total number of task this connectable has completed over the last 5 minutes." - }, - "tasksDuration" : { - "type" : "string", - "description" : "The total duration of all tasks for this connectable over the last 5 minutes." - }, - "activeThreadCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of threads currently executing in the processor." - }, - "terminatedThreadCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of threads currently terminated for the processor." - } - } - }, - "ProcessorStatusSnapshotEntity" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the processor." - }, - "processorStatusSnapshot" : { - "$ref" : "#/definitions/ProcessorStatusSnapshotDTO" - }, - "canRead" : { - "type" : "boolean", - "description" : "Indicates whether the user can read a given resource." - } - }, - "xml" : { - "name" : "entity" - } - }, - "ProcessorTypesEntity" : { - "type" : "object", - "properties" : { - "processorTypes" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/DocumentedTypeDTO" - } - } - }, - "xml" : { - "name" : "processorTypesEntity" - } - }, - "ProcessorsEntity" : { - "type" : "object", - "properties" : { - "processors" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ProcessorEntity" - } - } - }, - "xml" : { - "name" : "processorsEntity" - } - }, - "ProcessorsRunStatusDetailsEntity" : { - "type" : "object", - "properties" : { - "runStatusDetails" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/ProcessorRunStatusDetailsEntity" - } - } - }, - "xml" : { - "name" : "processorsRunStatusDetails" - } - }, - "PropertyDependencyDTO" : { - "type" : "object", - "properties" : { - "propertyName" : { - "type" : "string", - "description" : "The name of the property that is being depended upon" - }, - "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", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - } - } - }, - "PropertyDescriptorDTO" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The name for the property." - }, - "displayName" : { - "type" : "string", - "description" : "The human readable name for the property." - }, - "description" : { - "type" : "string", - "description" : "The description for the property. Used to relay additional details to a user or provide a mechanism of documenting intent." - }, - "defaultValue" : { - "type" : "string", - "description" : "The default value for the property." - }, - "allowableValues" : { - "type" : "array", - "description" : "Allowable values for the property. If empty then the allowed values are not constrained.", - "items" : { - "$ref" : "#/definitions/AllowableValueEntity" - } - }, - "required" : { - "type" : "boolean", - "description" : "Whether the property is required." - }, - "sensitive" : { - "type" : "boolean", - "description" : "Whether the property is sensitive and protected whenever stored or represented." - }, - "dynamic" : { - "type" : "boolean", - "description" : "Whether the property is dynamic (user-defined)." - }, - "supportsEl" : { - "type" : "boolean", - "description" : "Whether the property supports expression language." - }, - "expressionLanguageScope" : { - "type" : "string", - "description" : "Scope of the Expression Language evaluation for the property." - }, - "identifiesControllerService" : { - "type" : "string", - "description" : "If the property identifies a controller service this returns the fully qualified type." - }, - "identifiesControllerServiceBundle" : { - "description" : "If the property identifies a controller service this returns the bundle of the type, null otherwise.", - "$ref" : "#/definitions/BundleDTO" - }, - "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" : "#/definitions/PropertyDependencyDTO" - } - } - } - }, - "PropertyDescriptorEntity" : { - "type" : "object", - "properties" : { - "propertyDescriptor" : { - "$ref" : "#/definitions/PropertyDescriptorDTO" - } - }, - "xml" : { - "name" : "propertyDescriptor" - } - }, - "PropertyHistoryDTO" : { - "type" : "object", - "properties" : { - "previousValues" : { - "type" : "array", - "description" : "Previous values for a given property.", - "items" : { - "$ref" : "#/definitions/PreviousValueDTO" - } - } - } - }, - "ProvenanceDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the provenance query." - }, - "uri" : { - "type" : "string", - "description" : "The URI for this query. Used for obtaining/deleting the request at a later time" - }, - "submissionTime" : { - "type" : "string", - "description" : "The timestamp when the query was submitted." - }, - "expiration" : { - "type" : "string", - "description" : "The timestamp when the query will expire." - }, - "percentCompleted" : { - "type" : "integer", - "format" : "int32", - "description" : "The current percent complete." - }, - "finished" : { - "type" : "boolean", - "description" : "Whether the query has finished." - }, - "request" : { - "description" : "The provenance request.", - "$ref" : "#/definitions/ProvenanceRequestDTO" - }, - "results" : { - "description" : "The provenance results.", - "$ref" : "#/definitions/ProvenanceResultsDTO" - } - } - }, - "ProvenanceEntity" : { - "type" : "object", - "properties" : { - "provenance" : { - "$ref" : "#/definitions/ProvenanceDTO" - } - }, - "xml" : { - "name" : "provenanceEntity" - } - }, - "ProvenanceEventDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The event uuid." - }, - "eventId" : { - "type" : "integer", - "format" : "int64", - "description" : "The event id. This is a one up number thats unique per node." - }, - "eventTime" : { - "type" : "string", - "description" : "The timestamp of the event." - }, - "eventDuration" : { - "type" : "integer", - "format" : "int64", - "description" : "The event duration in milliseconds." - }, - "lineageDuration" : { - "type" : "integer", - "format" : "int64", - "description" : "The duration since the lineage began, in milliseconds." - }, - "eventType" : { - "type" : "string", - "description" : "The type of the event." - }, - "flowFileUuid" : { - "type" : "string", - "description" : "The uuid of the flowfile for the event." - }, - "fileSize" : { - "type" : "string", - "description" : "The size of the flowfile for the event." - }, - "fileSizeBytes" : { - "type" : "integer", - "format" : "int64", - "description" : "The size of the flowfile in bytes for the event." - }, - "clusterNodeId" : { - "type" : "string", - "description" : "The identifier for the node where the event originated." - }, - "clusterNodeAddress" : { - "type" : "string", - "description" : "The label for the node where the event originated." - }, - "groupId" : { - "type" : "string", - "description" : "The id of the group that the component resides in. If the component is no longer in the flow, the group id will not be set." - }, - "componentId" : { - "type" : "string", - "description" : "The id of the component that generated the event." - }, - "componentType" : { - "type" : "string", - "description" : "The type of the component that generated the event." - }, - "componentName" : { - "type" : "string", - "description" : "The name of the component that generated the event." - }, - "sourceSystemFlowFileId" : { - "type" : "string", - "description" : "The source system flowfile id." - }, - "alternateIdentifierUri" : { - "type" : "string", - "description" : "The alternate identifier uri for the fileflow for the event." - }, - "attributes" : { - "type" : "array", - "description" : "The attributes of the flowfile for the event.", - "items" : { - "$ref" : "#/definitions/AttributeDTO" - } - }, - "parentUuids" : { - "type" : "array", - "description" : "The parent uuids for the event.", - "items" : { - "type" : "string" - } - }, - "childUuids" : { - "type" : "array", - "description" : "The child uuids for the event.", - "items" : { - "type" : "string" - } - }, - "transitUri" : { - "type" : "string", - "description" : "The source/destination system uri if the event was a RECEIVE/SEND." - }, - "relationship" : { - "type" : "string", - "description" : "The relationship to which the flowfile was routed if the event is of type ROUTE." - }, - "details" : { - "type" : "string", - "description" : "The event details." - }, - "contentEqual" : { - "type" : "boolean", - "description" : "Whether the input and output content claim is the same." - }, - "inputContentAvailable" : { - "type" : "boolean", - "description" : "Whether the input content is still available." - }, - "inputContentClaimSection" : { - "type" : "string", - "description" : "The section in which the input content claim lives." - }, - "inputContentClaimContainer" : { - "type" : "string", - "description" : "The container in which the input content claim lives." - }, - "inputContentClaimIdentifier" : { - "type" : "string", - "description" : "The identifier of the input content claim." - }, - "inputContentClaimOffset" : { - "type" : "integer", - "format" : "int64", - "description" : "The offset into the input content claim where the flowfiles content begins." - }, - "inputContentClaimFileSize" : { - "type" : "string", - "description" : "The file size of the input content claim formatted." - }, - "inputContentClaimFileSizeBytes" : { - "type" : "integer", - "format" : "int64", - "description" : "The file size of the intput content claim in bytes." - }, - "outputContentAvailable" : { - "type" : "boolean", - "description" : "Whether the output content is still available." - }, - "outputContentClaimSection" : { - "type" : "string", - "description" : "The section in which the output content claim lives." - }, - "outputContentClaimContainer" : { - "type" : "string", - "description" : "The container in which the output content claim lives." - }, - "outputContentClaimIdentifier" : { - "type" : "string", - "description" : "The identifier of the output content claim." - }, - "outputContentClaimOffset" : { - "type" : "integer", - "format" : "int64", - "description" : "The offset into the output content claim where the flowfiles content begins." - }, - "outputContentClaimFileSize" : { - "type" : "string", - "description" : "The file size of the output content claim formatted." - }, - "outputContentClaimFileSizeBytes" : { - "type" : "integer", - "format" : "int64", - "description" : "The file size of the output content claim in bytes." - }, - "replayAvailable" : { - "type" : "boolean", - "description" : "Whether or not replay is available." - }, - "replayExplanation" : { - "type" : "string", - "description" : "Explanation as to why replay is unavailable." - }, - "sourceConnectionIdentifier" : { - "type" : "string", - "description" : "The identifier of the queue/connection from which the flowfile was pulled to genereate this event. May be null if the queue/connection is unknown or the flowfile was generated from this event." - } - } - }, - "ProvenanceEventEntity" : { - "type" : "object", - "properties" : { - "provenanceEvent" : { - "$ref" : "#/definitions/ProvenanceEventDTO" - } - }, - "xml" : { - "name" : "provenanceEventEntity" - } - }, - "ProvenanceLinkDTO" : { - "type" : "object", - "properties" : { - "sourceId" : { - "type" : "string", - "description" : "The source node id of the link." - }, - "targetId" : { - "type" : "string", - "description" : "The target node id of the link." - }, - "flowFileUuid" : { - "type" : "string", - "description" : "The flowfile uuid that traversed the link." - }, - "timestamp" : { - "type" : "string", - "description" : "The timestamp of the link (based on the destination)." - }, - "millis" : { - "type" : "integer", - "format" : "int64", - "description" : "The timestamp of this link in milliseconds." - } - } - }, - "ProvenanceNodeDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the node." - }, - "flowFileUuid" : { - "type" : "string", - "description" : "The uuid of the flowfile associated with the provenance event." - }, - "parentUuids" : { - "type" : "array", - "description" : "The uuid of the parent flowfiles of the provenance event.", - "items" : { - "type" : "string" - } - }, - "childUuids" : { - "type" : "array", - "description" : "The uuid of the childrent flowfiles of the provenance event.", - "items" : { - "type" : "string" - } - }, - "clusterNodeIdentifier" : { - "type" : "string", - "description" : "The identifier of the node that this event/flowfile originated from." - }, - "type" : { - "type" : "string", - "description" : "The type of the node.", - "enum" : [ "FLOWFILE", "EVENT" ] - }, - "eventType" : { - "type" : "string", - "description" : "If the type is EVENT, this is the type of event." - }, - "millis" : { - "type" : "integer", - "format" : "int64", - "description" : "The timestamp of the node in milliseconds." - }, - "timestamp" : { - "type" : "string", - "description" : "The timestamp of the node formatted." - } - } - }, - "ProvenanceOptionsDTO" : { - "type" : "object", - "properties" : { - "searchableFields" : { - "type" : "array", - "description" : "The available searchable field for the NiFi.", - "items" : { - "$ref" : "#/definitions/ProvenanceSearchableFieldDTO" - } - } - } - }, - "ProvenanceOptionsEntity" : { - "type" : "object", - "properties" : { - "provenanceOptions" : { - "$ref" : "#/definitions/ProvenanceOptionsDTO" - } - }, - "xml" : { - "name" : "provenanceOptionsEntity" - } - }, - "ProvenanceRequestDTO" : { - "type" : "object", - "properties" : { - "searchTerms" : { - "type" : "object", - "description" : "The search terms used to perform the search.", - "additionalProperties" : { - "$ref" : "#/definitions/ProvenanceSearchValueDTO" - } - }, - "clusterNodeId" : { - "type" : "string", - "description" : "The id of the node in the cluster where this provenance originated." - }, - "startDate" : { - "type" : "string", - "description" : "The earliest event time to include in the query." - }, - "endDate" : { - "type" : "string", - "description" : "The latest event time to include in the query." - }, - "minimumFileSize" : { - "type" : "string", - "description" : "The minimum file size to include in the query." - }, - "maximumFileSize" : { - "type" : "string", - "description" : "The maximum file size to include in the query." - }, - "maxResults" : { - "type" : "integer", - "format" : "int32", - "description" : "The maximum number of results to include." - }, - "summarize" : { - "type" : "boolean", - "description" : "Whether or not to summarize provenance events returned. This property is false by default." - }, - "incrementalResults" : { - "type" : "boolean", - "description" : "Whether or not incremental results are returned. If false, provenance events are only returned once the query completes. This property is true by default." - } - } - }, - "ProvenanceResultsDTO" : { - "type" : "object", - "properties" : { - "provenanceEvents" : { - "type" : "array", - "description" : "The provenance events that matched the search criteria.", - "items" : { - "$ref" : "#/definitions/ProvenanceEventDTO" - } - }, - "total" : { - "type" : "string", - "description" : "The total number of results formatted." - }, - "totalCount" : { - "type" : "integer", - "format" : "int64", - "description" : "The total number of results." - }, - "generated" : { - "type" : "string", - "description" : "Then the search was performed." - }, - "oldestEvent" : { - "type" : "string", - "description" : "The oldest event available in the provenance repository." - }, - "timeOffset" : { - "type" : "integer", - "format" : "int32", - "description" : "The time offset of the server that's used for event time." - }, - "errors" : { - "type" : "array", - "description" : "Any errors that occurred while performing the provenance request.", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - } - } - }, - "ProvenanceSearchValueDTO" : { - "type" : "object", - "properties" : { - "value" : { - "type" : "string", - "description" : "The search value." - }, - "inverse" : { - "type" : "boolean", - "description" : "Query for all except for search value." - } - } - }, - "ProvenanceSearchableFieldDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the searchable field." - }, - "field" : { - "type" : "string", - "description" : "The searchable field." - }, - "label" : { - "type" : "string", - "description" : "The label for the searchable field." - }, - "type" : { - "type" : "string", - "description" : "The type of the searchable field." - } - } - }, - "QueueSizeDTO" : { - "type" : "object", - "properties" : { - "byteCount" : { - "type" : "integer", - "format" : "int64", - "description" : "The size of objects in a queue." - }, - "objectCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The count of objects in a queue." - } - } - }, - "RegistryClientEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "component" : { - "$ref" : "#/definitions/RegistryDTO" - } - }, - "xml" : { - "name" : "registryClientEntity" - } - }, - "RegistryClientsEntity" : { - "type" : "object", - "properties" : { - "registries" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/RegistryClientEntity" - } - } - }, - "xml" : { - "name" : "registryClientsEntity" - } - }, - "RegistryDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The registry identifier" - }, - "name" : { - "type" : "string", - "description" : "The registry name" - }, - "description" : { - "type" : "string", - "description" : "The registry description" - }, - "uri" : { - "type" : "string", - "description" : "The registry URI" - } - } - }, - "RelationshipDTO" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The relationship name." - }, - "description" : { - "type" : "string", - "description" : "The relationship description." - }, - "autoTerminate" : { - "type" : "boolean", - "description" : "Whether or not flowfiles sent to this relationship should auto terminate." - } - } - }, - "RemotePortRunStatusEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "state" : { - "type" : "string", - "description" : "The run status of the RemotePort.", - "enum" : [ "TRANSMITTING", "STOPPED" ] - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - } - }, - "xml" : { - "name" : "entity" - } - }, - "RemoteProcessGroupContentsDTO" : { - "type" : "object", - "properties" : { - "inputPorts" : { - "type" : "array", - "description" : "The input ports to which data can be sent.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/RemoteProcessGroupPortDTO" - } - }, - "outputPorts" : { - "type" : "array", - "description" : "The output ports from which data can be retrieved.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/RemoteProcessGroupPortDTO" - } - } - } - }, - "RemoteProcessGroupDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "versionedComponentId" : { - "type" : "string", - "description" : "The ID of the corresponding component that is under version control" - }, - "parentGroupId" : { - "type" : "string", - "description" : "The id of parent process group of this component if applicable." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "targetUri" : { - "type" : "string", - "description" : "The target URI of the remote process group. If target uri is not set, but uris are set, then returns the first url in the urls. If neither target uri nor uris are set, then returns null." - }, - "targetUris" : { - "type" : "string", - "description" : "The target URI of the remote process group. If target uris is not set but target uri is set, then returns a collection containing the single target uri. If neither target uris nor uris are set, then returns null." - }, - "targetSecure" : { - "type" : "boolean", - "description" : "Whether the target is running securely." - }, - "name" : { - "type" : "string", - "description" : "The name of the remote process group." - }, - "comments" : { - "type" : "string", - "description" : "The comments for the remote process group." - }, - "communicationsTimeout" : { - "type" : "string", - "description" : "The time period used for the timeout when communicating with the target." - }, - "yieldDuration" : { - "type" : "string", - "description" : "When yielding, this amount of time must elapse before the remote process group is scheduled again." - }, - "transportProtocol" : { - "type" : "string" - }, - "localNetworkInterface" : { - "type" : "string", - "description" : "The local network interface to send/receive data. If not specified, any local address is used. If clustered, all nodes must have an interface with this identifier." - }, - "proxyHost" : { - "type" : "string" - }, - "proxyPort" : { - "type" : "integer", - "format" : "int32" - }, - "proxyUser" : { - "type" : "string" - }, - "proxyPassword" : { - "type" : "string" - }, - "authorizationIssues" : { - "type" : "array", - "description" : "Any remote authorization issues for the remote process group.", - "items" : { - "type" : "string" - } - }, - "validationErrors" : { - "type" : "array", - "description" : "The validation errors for the remote process group. These validation errors represent the problems with the remote process group that must be resolved before it can transmit.", - "items" : { - "type" : "string" - } - }, - "transmitting" : { - "type" : "boolean", - "description" : "Whether the remote process group is actively transmitting." - }, - "inputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of remote input ports currently available on the target." - }, - "outputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of remote output ports currently available on the target." - }, - "activeRemoteInputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of active remote input ports." - }, - "inactiveRemoteInputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of inactive remote input ports." - }, - "activeRemoteOutputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of active remote output ports." - }, - "inactiveRemoteOutputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of inactive remote output ports." - }, - "flowRefreshed" : { - "type" : "string", - "description" : "The timestamp when this remote process group was last refreshed." - }, - "contents" : { - "description" : "The contents of the remote process group. Will contain available input/output ports.", - "$ref" : "#/definitions/RemoteProcessGroupContentsDTO" - } - } - }, - "RemoteProcessGroupEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "component" : { - "$ref" : "#/definitions/RemoteProcessGroupDTO" - }, - "status" : { - "description" : "The status of the remote process group.", - "$ref" : "#/definitions/RemoteProcessGroupStatusDTO" - }, - "inputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of remote input ports currently available on the target." - }, - "outputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of remote output ports currently available on the target." - }, - "operatePermissions" : { - "description" : "The permissions for this component operations.", - "$ref" : "#/definitions/PermissionsDTO" - } - }, - "xml" : { - "name" : "remoteProcessGroupEntity" - } - }, - "RemoteProcessGroupPortDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the port." - }, - "targetId" : { - "type" : "string", - "description" : "The id of the target port." - }, - "versionedComponentId" : { - "type" : "string", - "description" : "The ID of the corresponding component that is under version control" - }, - "groupId" : { - "type" : "string", - "description" : "The id of the remote process group that the port resides in." - }, - "name" : { - "type" : "string", - "description" : "The name of the target port." - }, - "comments" : { - "type" : "string", - "description" : "The comments as configured on the target port." - }, - "concurrentlySchedulableTaskCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of task that may transmit flowfiles to the target port concurrently." - }, - "transmitting" : { - "type" : "boolean", - "description" : "Whether the remote port is configured for transmission." - }, - "useCompression" : { - "type" : "boolean", - "description" : "Whether the flowfiles are compressed when sent to the target port." - }, - "exists" : { - "type" : "boolean", - "description" : "Whether the target port exists." - }, - "targetRunning" : { - "type" : "boolean", - "description" : "Whether the target port is running." - }, - "connected" : { - "type" : "boolean", - "description" : "Whether the port has either an incoming or outgoing connection." - }, - "batchSettings" : { - "description" : "The batch settings for data transmission.", - "$ref" : "#/definitions/BatchSettingsDTO" - } - } - }, - "RemoteProcessGroupPortEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "remoteProcessGroupPort" : { - "$ref" : "#/definitions/RemoteProcessGroupPortDTO" - }, - "operatePermissions" : { - "description" : "The permissions for this component operations.", - "$ref" : "#/definitions/PermissionsDTO" - } - }, - "xml" : { - "name" : "remoteProcessGroupPortEntity" - } - }, - "RemoteProcessGroupStatusDTO" : { - "type" : "object", - "properties" : { - "groupId" : { - "type" : "string", - "description" : "The unique ID of the process group that the Processor belongs to" - }, - "id" : { - "type" : "string", - "description" : "The unique ID of the Processor" - }, - "name" : { - "type" : "string", - "description" : "The name of the remote process group." - }, - "targetUri" : { - "type" : "string", - "description" : "The URI of the target system." - }, - "transmissionStatus" : { - "type" : "string", - "description" : "The transmission status of the remote process group." - }, - "statsLastRefreshed" : { - "type" : "string", - "description" : "The time the status for the process group was last refreshed." - }, - "validationStatus" : { - "type" : "string", - "description" : "Indicates whether the component is valid, invalid, or still in the process of validating (i.e., it is unknown whether or not the component is valid)", - "enum" : [ "VALID", "INVALID", "VALIDATING" ] - }, - "aggregateSnapshot" : { - "description" : "A status snapshot that represents the aggregate stats of all nodes in the cluster. If the NiFi instance is a standalone instance, rather than a cluster, this represents the stats of the single instance.", - "$ref" : "#/definitions/RemoteProcessGroupStatusSnapshotDTO" - }, - "nodeSnapshots" : { - "type" : "array", - "description" : "A status snapshot for each node in the cluster. If the NiFi instance is a standalone instance, rather than a cluster, this may be null.", - "items" : { - "$ref" : "#/definitions/NodeRemoteProcessGroupStatusSnapshotDTO" - } - } - } - }, - "RemoteProcessGroupStatusEntity" : { - "type" : "object", - "properties" : { - "remoteProcessGroupStatus" : { - "$ref" : "#/definitions/RemoteProcessGroupStatusDTO" - }, - "canRead" : { - "type" : "boolean", - "description" : "Indicates whether the user can read a given resource." - } - }, - "xml" : { - "name" : "remoteProcessGroupStatusEntity" - } - }, - "RemoteProcessGroupStatusSnapshotDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the remote process group." - }, - "groupId" : { - "type" : "string", - "description" : "The id of the parent process group the remote process group resides in." - }, - "name" : { - "type" : "string", - "description" : "The name of the remote process group." - }, - "targetUri" : { - "type" : "string", - "description" : "The URI of the target system." - }, - "transmissionStatus" : { - "type" : "string", - "description" : "The transmission status of the remote process group." - }, - "activeThreadCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of active threads for the remote process group." - }, - "flowFilesSent" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of FlowFiles sent to the remote process group in the last 5 minutes." - }, - "bytesSent" : { - "type" : "integer", - "format" : "int64", - "description" : "The size of the FlowFiles sent to the remote process group in the last 5 minutes." - }, - "sent" : { - "type" : "string", - "description" : "The count/size of the flowfiles sent to the remote process group in the last 5 minutes." - }, - "flowFilesReceived" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of FlowFiles received from the remote process group in the last 5 minutes." - }, - "bytesReceived" : { - "type" : "integer", - "format" : "int64", - "description" : "The size of the FlowFiles received from the remote process group in the last 5 minutes." - }, - "received" : { - "type" : "string", - "description" : "The count/size of the flowfiles received from the remote process group in the last 5 minutes." - } - } - }, - "RemoteProcessGroupStatusSnapshotEntity" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the remote process group." - }, - "remoteProcessGroupStatusSnapshot" : { - "$ref" : "#/definitions/RemoteProcessGroupStatusSnapshotDTO" - }, - "canRead" : { - "type" : "boolean", - "description" : "Indicates whether the user can read a given resource." - } - }, - "xml" : { - "name" : "entity" - } - }, - "RemoteProcessGroupsEntity" : { - "type" : "object", - "properties" : { - "remoteProcessGroups" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/RemoteProcessGroupEntity" - } - } - }, - "xml" : { - "name" : "remoteProcessGroupsEntity" - } - }, - "RemoteQueuePartitionDTO" : { - "type" : "object", - "properties" : { - "totalFlowFileCount" : { - "type" : "integer", - "format" : "int32", - "description" : "Total number of FlowFiles owned by the Connection" - }, - "totalByteCount" : { - "type" : "integer", - "format" : "int64", - "description" : "Total number of bytes that make up the content for the FlowFiles owned by this Connection" - }, - "activeQueueFlowFileCount" : { - "type" : "integer", - "format" : "int32", - "description" : "Total number of FlowFiles that exist in the Connection's Active Queue, immediately available to be offered up to a component" - }, - "activeQueueByteCount" : { - "type" : "integer", - "format" : "int64", - "description" : "Total number of bytes that make up the content for the FlowFiles that are present in the Connection's Active Queue" - }, - "swapFlowFileCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The total number of FlowFiles that are swapped out for this Connection" - }, - "swapByteCount" : { - "type" : "integer", - "format" : "int64", - "description" : "Total number of bytes that make up the content for the FlowFiles that are swapped out to disk for the Connection" - }, - "swapFiles" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of Swap Files that exist for this Connection" - }, - "inFlightFlowFileCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of In-Flight FlowFiles for this Connection. These are FlowFiles that belong to the connection but are currently being operated on by a Processor, Port, etc." - }, - "inFlightByteCount" : { - "type" : "integer", - "format" : "int64", - "description" : "The number bytes that make up the content of the FlowFiles that are In-Flight" - }, - "nodeIdentifier" : { - "type" : "string", - "description" : "The Node Identifier that this queue partition is sending to" - } - } - }, - "ReportingTaskDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "versionedComponentId" : { - "type" : "string", - "description" : "The ID of the corresponding component that is under version control" - }, - "parentGroupId" : { - "type" : "string", - "description" : "The id of parent process group of this component if applicable." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "name" : { - "type" : "string", - "description" : "The name of the reporting task." - }, - "type" : { - "type" : "string", - "description" : "The fully qualified type of the reporting task." - }, - "bundle" : { - "description" : "The details of the artifact that bundled this processor type.", - "$ref" : "#/definitions/BundleDTO" - }, - "state" : { - "type" : "string", - "description" : "The state of the reporting task.", - "enum" : [ "RUNNING", "STOPPED", "DISABLED" ] - }, - "comments" : { - "type" : "string", - "description" : "The comments of the reporting task." - }, - "persistsState" : { - "type" : "boolean", - "description" : "Whether the reporting task persists state." - }, - "restricted" : { - "type" : "boolean", - "description" : "Whether the reporting task requires elevated privileges." - }, - "deprecated" : { - "type" : "boolean", - "description" : "Whether the reporting task has been deprecated." - }, - "multipleVersionsAvailable" : { - "type" : "boolean", - "description" : "Whether the reporting task has multiple versions available." - }, - "schedulingPeriod" : { - "type" : "string", - "description" : "The frequency with which to schedule the reporting task. The format of the value willd epend on the valud of the schedulingStrategy." - }, - "schedulingStrategy" : { - "type" : "string", - "description" : "The scheduling strategy that determines how the schedulingPeriod value should be interpreted." - }, - "defaultSchedulingPeriod" : { - "type" : "object", - "description" : "The default scheduling period for the different scheduling strategies.", - "additionalProperties" : { - "type" : "string" - } - }, - "properties" : { - "type" : "object", - "description" : "The properties of the reporting task.", - "additionalProperties" : { - "type" : "string" - } - }, - "descriptors" : { - "type" : "object", - "description" : "The descriptors for the reporting tasks properties.", - "additionalProperties" : { - "$ref" : "#/definitions/PropertyDescriptorDTO" - } - }, - "customUiUrl" : { - "type" : "string", - "description" : "The URL for the custom configuration UI for the reporting task." - }, - "annotationData" : { - "type" : "string", - "description" : "The annotation data for the repoting task. This is how the custom UI relays configuration to the reporting task." - }, - "validationErrors" : { - "type" : "array", - "description" : "Gets the validation errors from the reporting task. These validation errors represent the problems with the reporting task that must be resolved before it can be scheduled to run.", - "items" : { - "type" : "string" - } - }, - "validationStatus" : { - "type" : "string", - "description" : "Indicates whether the Processor is valid, invalid, or still in the process of validating (i.e., it is unknown whether or not the Processor is valid)", - "enum" : [ "VALID", "INVALID", "VALIDATING" ] - }, - "activeThreadCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of active threads for the reporting task." - }, - "extensionMissing" : { - "type" : "boolean", - "description" : "Whether the underlying extension is missing." - } - } - }, - "ReportingTaskEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "component" : { - "$ref" : "#/definitions/ReportingTaskDTO" - }, - "operatePermissions" : { - "description" : "The permissions for this component operations.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "status" : { - "description" : "The status for this ReportingTask.", - "$ref" : "#/definitions/ReportingTaskStatusDTO" - } - }, - "xml" : { - "name" : "reportingTaskEntity" - } - }, - "ReportingTaskRunStatusEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "state" : { - "type" : "string", - "description" : "The run status of the ReportingTask.", - "enum" : [ "RUNNING", "STOPPED" ] - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - } - }, - "xml" : { - "name" : "entity" - } - }, - "ReportingTaskStatusDTO" : { - "type" : "object", - "properties" : { - "runStatus" : { - "type" : "string", - "description" : "The run status of this ReportingTask", - "enum" : [ "RUNNING", "STOPPED", "DISABLED" ] - }, - "validationStatus" : { - "type" : "string", - "description" : "Indicates whether the component is valid, invalid, or still in the process of validating (i.e., it is unknown whether or not the component is valid)", - "enum" : [ "VALID", "INVALID", "VALIDATING" ] - }, - "activeThreadCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of active threads for the component." - } - } - }, - "ReportingTaskTypesEntity" : { - "type" : "object", - "properties" : { - "reportingTaskTypes" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/DocumentedTypeDTO" - } - } - }, - "xml" : { - "name" : "reportingTaskTypesEntity" - } - }, - "ReportingTasksEntity" : { - "type" : "object", - "properties" : { - "reportingTasks" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ReportingTaskEntity" - } - } - }, - "xml" : { - "name" : "reportingTasksEntity" - } - }, - "RepositoryUsageDTO" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The name of the repository" - }, - "fileStoreHash" : { - "type" : "string", - "description" : "A SHA-256 hash of the File Store name/path that is used to store the repository's data. This information is exposed as a hash in order to avoid exposing potentially sensitive information that is not generally relevant. What is typically relevant is whether or not multiple repositories on the same node are using the same File Store, as this indicates that the repositories are competing for the resources of the backing disk/storage mechanism." - }, - "freeSpace" : { - "type" : "string", - "description" : "Amount of free space." - }, - "totalSpace" : { - "type" : "string", - "description" : "Amount of total space." - }, - "freeSpaceBytes" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes of free space." - }, - "totalSpaceBytes" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes of total space." - }, - "utilization" : { - "type" : "string", - "description" : "Utilization of this storage location." - } - } - }, - "RequiredPermissionDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The required sub-permission necessary for this restriction." - }, - "label" : { - "type" : "string", - "description" : "The label for the required sub-permission necessary for this restriction." - } - } - }, - "ResourceDTO" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The identifier of the resource." - }, - "name" : { - "type" : "string", - "description" : "The name of the resource." - } - } - }, - "ResourcesEntity" : { - "type" : "object", - "properties" : { - "resources" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/ResourceDTO" - } - } - }, - "xml" : { - "name" : "resourcesEntity" - } - }, - "RevisionDTO" : { - "type" : "object", - "properties" : { - "clientId" : { - "type" : "string", - "description" : "A client identifier used to make a request. By including a client identifier, the API can allow multiple requests without needing the current revision. Due to the asynchronous nature of requests/responses this was implemented to allow the client to make numerous requests without having to wait for the previous response to come back" - }, - "version" : { - "type" : "integer", - "format" : "int64", - "description" : "NiFi employs an optimistic locking strategy where the client must include a revision in their request when performing an update. In a response to a mutable flow request, this field represents the updated base version." - }, - "lastModifier" : { - "type" : "string", - "description" : "The user that last modified the flow." - } - } - }, - "RevisionInfo" : { - "type" : "object", - "properties" : { - "clientId" : { - "type" : "string", - "description" : "A client identifier used to make a request. By including a client identifier, the API can allow multiple requests without needing the current revision. Due to the asynchronous nature of requests/responses this was implemented to allow the client to make numerous requests without having to wait for the previous response to come back." - }, - "version" : { - "type" : "integer", - "format" : "int64", - "description" : "NiFi Registry employs an optimistic locking strategy where the client must include a revision in their request when performing an update. In a response to a mutable flow request, this field represents the updated base version." - }, - "lastModifier" : { - "type" : "string", - "description" : "The user that last modified the entity.", - "readOnly" : true - } - }, - "description" : "The revision information for an entity managed through the REST API." - }, - "RunStatusDetailsRequestEntity" : { - "type" : "object", - "properties" : { - "processorIds" : { - "type" : "array", - "description" : "The IDs of all processors whose run status details should be provided", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - } - }, - "xml" : { - "name" : "runStatusDetailsRequest" - } - }, - "ScheduleComponentsEntity" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the ProcessGroup" - }, - "state" : { - "type" : "string", - "description" : "The desired state of the descendant components", - "enum" : [ "RUNNING", "STOPPED", "ENABLED", "DISABLED" ] - }, - "components" : { - "type" : "object", - "description" : "Optional components to schedule. If not specified, all authorized descendant components will be used.", - "additionalProperties" : { - "$ref" : "#/definitions/RevisionDTO" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - } - }, - "xml" : { - "name" : "scheduleComponentEntity" - } - }, - "SearchResultGroupDTO" : { - "type" : "object", - "required" : [ "id" ], - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the group." - }, - "name" : { - "type" : "string", - "description" : "The name of the group." - } - } - }, - "SearchResultsDTO" : { - "type" : "object", - "properties" : { - "processorResults" : { - "type" : "array", - "description" : "The processors that matched the search.", - "items" : { - "$ref" : "#/definitions/ComponentSearchResultDTO" - } - }, - "connectionResults" : { - "type" : "array", - "description" : "The connections that matched the search.", - "items" : { - "$ref" : "#/definitions/ComponentSearchResultDTO" - } - }, - "processGroupResults" : { - "type" : "array", - "description" : "The process groups that matched the search.", - "items" : { - "$ref" : "#/definitions/ComponentSearchResultDTO" - } - }, - "inputPortResults" : { - "type" : "array", - "description" : "The input ports that matched the search.", - "items" : { - "$ref" : "#/definitions/ComponentSearchResultDTO" - } - }, - "outputPortResults" : { - "type" : "array", - "description" : "The output ports that matched the search.", - "items" : { - "$ref" : "#/definitions/ComponentSearchResultDTO" - } - }, - "remoteProcessGroupResults" : { - "type" : "array", - "description" : "The remote process groups that matched the search.", - "items" : { - "$ref" : "#/definitions/ComponentSearchResultDTO" - } - }, - "funnelResults" : { - "type" : "array", - "description" : "The funnels that matched the search.", - "items" : { - "$ref" : "#/definitions/ComponentSearchResultDTO" - } - }, - "labelResults" : { - "type" : "array", - "description" : "The labels that matched the search.", - "items" : { - "$ref" : "#/definitions/ComponentSearchResultDTO" - } - }, - "controllerServiceNodeResults" : { - "type" : "array", - "description" : "The controller service nodes that matched the search", - "items" : { - "$ref" : "#/definitions/ComponentSearchResultDTO" - } - }, - "parameterContextResults" : { - "type" : "array", - "description" : "The parameter contexts that matched the search.", - "items" : { - "$ref" : "#/definitions/ComponentSearchResultDTO" - } - }, - "parameterResults" : { - "type" : "array", - "description" : "The parameters that matched the search.", - "items" : { - "$ref" : "#/definitions/ComponentSearchResultDTO" - } - } - } - }, - "SearchResultsEntity" : { - "type" : "object", - "properties" : { - "searchResultsDTO" : { - "$ref" : "#/definitions/SearchResultsDTO" - } - }, - "xml" : { - "name" : "searchResultsEntity" - } - }, - "SnippetDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the snippet." - }, - "uri" : { - "type" : "string", - "description" : "The URI of the snippet." - }, - "parentGroupId" : { - "type" : "string", - "description" : "The group id for the components in the snippet." - }, - "processGroups" : { - "type" : "object", - "description" : "The ids of the process groups in this snippet. These ids will be populated within each response. They can be specified when creating a snippet. However, once a snippet has been created its contents cannot be modified (these ids are ignored during update requests).", - "additionalProperties" : { - "$ref" : "#/definitions/RevisionDTO" - } - }, - "remoteProcessGroups" : { - "type" : "object", - "description" : "The ids of the remote process groups in this snippet. These ids will be populated within each response. They can be specified when creating a snippet. However, once a snippet has been created its contents cannot be modified (these ids are ignored during update requests).", - "additionalProperties" : { - "$ref" : "#/definitions/RevisionDTO" - } - }, - "processors" : { - "type" : "object", - "description" : "The ids of the processors in this snippet. These ids will be populated within each response. They can be specified when creating a snippet. However, once a snippet has been created its contents cannot be modified (these ids are ignored during update requests).", - "additionalProperties" : { - "$ref" : "#/definitions/RevisionDTO" - } - }, - "inputPorts" : { - "type" : "object", - "description" : "The ids of the input ports in this snippet. These ids will be populated within each response. They can be specified when creating a snippet. However, once a snippet has been created its contents cannot be modified (these ids are ignored during update requests).", - "additionalProperties" : { - "$ref" : "#/definitions/RevisionDTO" - } - }, - "outputPorts" : { - "type" : "object", - "description" : "The ids of the output ports in this snippet. These ids will be populated within each response. They can be specified when creating a snippet. However, once a snippet has been created its contents cannot be modified (these ids are ignored during update requests).", - "additionalProperties" : { - "$ref" : "#/definitions/RevisionDTO" - } - }, - "connections" : { - "type" : "object", - "description" : "The ids of the connections in this snippet. These ids will be populated within each response. They can be specified when creating a snippet. However, once a snippet has been created its contents cannot be modified (these ids are ignored during update requests).", - "additionalProperties" : { - "$ref" : "#/definitions/RevisionDTO" - } - }, - "labels" : { - "type" : "object", - "description" : "The ids of the labels in this snippet. These ids will be populated within each response. They can be specified when creating a snippet. However, once a snippet has been created its contents cannot be modified (these ids are ignored during update requests).", - "additionalProperties" : { - "$ref" : "#/definitions/RevisionDTO" - } - }, - "funnels" : { - "type" : "object", - "description" : "The ids of the funnels in this snippet. These ids will be populated within each response. They can be specified when creating a snippet. However, once a snippet has been created its contents cannot be modified (these ids are ignored during update requests).", - "additionalProperties" : { - "$ref" : "#/definitions/RevisionDTO" - } - } - } - }, - "SnippetEntity" : { - "type" : "object", - "properties" : { - "snippet" : { - "description" : "The snippet.", - "$ref" : "#/definitions/SnippetDTO" - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - } - }, - "xml" : { - "name" : "snippetEntity" - } - }, - "StartVersionControlRequestEntity" : { - "type" : "object", - "properties" : { - "versionedFlow" : { - "description" : "The versioned flow", - "$ref" : "#/definitions/VersionedFlowDTO" - }, - "processGroupRevision" : { - "description" : "The Revision of the Process Group under Version Control", - "$ref" : "#/definitions/RevisionDTO" - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - } - }, - "xml" : { - "name" : "startVersionControlRequestEntity" - } - }, - "StateEntryDTO" : { - "type" : "object", - "properties" : { - "key" : { - "type" : "string", - "description" : "The key for this state." - }, - "value" : { - "type" : "string", - "description" : "The value for this state." - }, - "clusterNodeId" : { - "type" : "string", - "description" : "The identifier for the node where the state originated." - }, - "clusterNodeAddress" : { - "type" : "string", - "description" : "The label for the node where the state originated." - } - } - }, - "StateMapDTO" : { - "type" : "object", - "properties" : { - "scope" : { - "type" : "string", - "description" : "The scope of this StateMap." - }, - "totalEntryCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The total number of state entries. When the state map is lengthy, only of portion of the entries are returned." - }, - "state" : { - "type" : "array", - "description" : "The state.", - "items" : { - "$ref" : "#/definitions/StateEntryDTO" - } - } - } - }, - "StatusDescriptorDTO" : { - "type" : "object", - "properties" : { - "field" : { - "type" : "string", - "description" : "The name of the status field." - }, - "label" : { - "type" : "string", - "description" : "The label for the status field." - }, - "description" : { - "type" : "string", - "description" : "The description of the status field." - }, - "formatter" : { - "type" : "string", - "description" : "The formatter for the status descriptor." - } - } - }, - "StatusHistoryDTO" : { - "type" : "object", - "properties" : { - "generated" : { - "type" : "string", - "description" : "When the status history was generated." - }, - "componentDetails" : { - "type" : "object", - "description" : "A Map of key/value pairs that describe the component that the status history belongs to", - "additionalProperties" : { - "type" : "string" - } - }, - "fieldDescriptors" : { - "type" : "array", - "description" : "The Descriptors that provide information on each of the metrics provided in the status history", - "items" : { - "$ref" : "#/definitions/StatusDescriptorDTO" - } - }, - "aggregateSnapshots" : { - "type" : "array", - "description" : "A list of StatusSnapshotDTO objects that provide the actual metric values for the component. If the NiFi instance is clustered, this will represent the aggregate status across all nodes. If the NiFi instance is not clustered, this will represent the status of the entire NiFi instance.", - "items" : { - "$ref" : "#/definitions/StatusSnapshotDTO" - } - }, - "nodeSnapshots" : { - "type" : "array", - "description" : "The NodeStatusSnapshotsDTO objects that provide the actual metric values for the component, for each node. If the NiFi instance is not clustered, this value will be null.", - "items" : { - "$ref" : "#/definitions/NodeStatusSnapshotsDTO" - } - } - } - }, - "StatusHistoryEntity" : { - "type" : "object", - "properties" : { - "statusHistory" : { - "$ref" : "#/definitions/StatusHistoryDTO" - }, - "canRead" : { - "type" : "boolean", - "description" : "Indicates whether the user can read a given resource." - } - }, - "xml" : { - "name" : "statusHistoryEntity" - } - }, - "StatusSnapshotDTO" : { - "type" : "object", - "properties" : { - "timestamp" : { - "type" : "string", - "format" : "date-time", - "description" : "The timestamp of the snapshot." - }, - "statusMetrics" : { - "type" : "object", - "description" : "The status metrics.", - "additionalProperties" : { - "type" : "integer", - "format" : "int64" - } - } - } - }, - "StorageUsageDTO" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The identifier of this storage location. The identifier will correspond to the identifier keyed in the storage configuration." - }, - "freeSpace" : { - "type" : "string", - "description" : "Amount of free space." - }, - "totalSpace" : { - "type" : "string", - "description" : "Amount of total space." - }, - "usedSpace" : { - "type" : "string", - "description" : "Amount of used space." - }, - "freeSpaceBytes" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes of free space." - }, - "totalSpaceBytes" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes of total space." - }, - "usedSpaceBytes" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes of used space." - }, - "utilization" : { - "type" : "string", - "description" : "Utilization of this storage location." - } - } - }, - "StreamingOutput" : { - "type" : "object" - }, - "SubmitReplayRequestEntity" : { - "type" : "object", - "properties" : { - "eventId" : { - "type" : "integer", - "format" : "int64", - "description" : "The event identifier" - }, - "clusterNodeId" : { - "type" : "string", - "description" : "The identifier of the node where to submit the replay request." - } - }, - "xml" : { - "name" : "copySnippetRequestEntity" - } - }, - "SystemDiagnosticsDTO" : { - "type" : "object", - "properties" : { - "aggregateSnapshot" : { - "description" : "A systems diagnostic snapshot that represents the aggregate values of all nodes in the cluster. If the NiFi instance is a standalone instance, rather than a cluster, this represents the stats of the single instance.", - "$ref" : "#/definitions/SystemDiagnosticsSnapshotDTO" - }, - "nodeSnapshots" : { - "type" : "array", - "description" : "A systems diagnostics snapshot for each node in the cluster. If the NiFi instance is a standalone instance, rather than a cluster, this may be null.", - "items" : { - "$ref" : "#/definitions/NodeSystemDiagnosticsSnapshotDTO" - } - } - } - }, - "SystemDiagnosticsEntity" : { - "type" : "object", - "properties" : { - "systemDiagnostics" : { - "$ref" : "#/definitions/SystemDiagnosticsDTO" - } - }, - "xml" : { - "name" : "systemDiagnosticsEntity" - } - }, - "SystemDiagnosticsSnapshotDTO" : { - "type" : "object", - "properties" : { - "totalNonHeap" : { - "type" : "string", - "description" : "Total size of non heap." - }, - "totalNonHeapBytes" : { - "type" : "integer", - "format" : "int64", - "description" : "Total number of bytes allocated to the JVM not used for heap" - }, - "usedNonHeap" : { - "type" : "string", - "description" : "Amount of use non heap." - }, - "usedNonHeapBytes" : { - "type" : "integer", - "format" : "int64", - "description" : "Total number of bytes used by the JVM not in the heap space" - }, - "freeNonHeap" : { - "type" : "string", - "description" : "Amount of free non heap." - }, - "freeNonHeapBytes" : { - "type" : "integer", - "format" : "int64", - "description" : "Total number of free non-heap bytes available to the JVM" - }, - "maxNonHeap" : { - "type" : "string", - "description" : "Maximum size of non heap." - }, - "maxNonHeapBytes" : { - "type" : "integer", - "format" : "int64", - "description" : "The maximum number of bytes that the JVM can use for non-heap purposes" - }, - "nonHeapUtilization" : { - "type" : "string", - "description" : "Utilization of non heap." - }, - "totalHeap" : { - "type" : "string", - "description" : "Total size of heap." - }, - "totalHeapBytes" : { - "type" : "integer", - "format" : "int64", - "description" : "The total number of bytes that are available for the JVM heap to use" - }, - "usedHeap" : { - "type" : "string", - "description" : "Amount of used heap." - }, - "usedHeapBytes" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes of JVM heap that are currently being used" - }, - "freeHeap" : { - "type" : "string", - "description" : "Amount of free heap." - }, - "freeHeapBytes" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes that are allocated to the JVM heap but not currently being used" - }, - "maxHeap" : { - "type" : "string", - "description" : "Maximum size of heap." - }, - "maxHeapBytes" : { - "type" : "integer", - "format" : "int64", - "description" : "The maximum number of bytes that can be used by the JVM" - }, - "heapUtilization" : { - "type" : "string", - "description" : "Utilization of heap." - }, - "availableProcessors" : { - "type" : "integer", - "format" : "int32", - "description" : "Number of available processors if supported by the underlying system." - }, - "processorLoadAverage" : { - "type" : "number", - "format" : "double", - "description" : "The processor load average if supported by the underlying system." - }, - "totalThreads" : { - "type" : "integer", - "format" : "int32", - "description" : "Total number of threads." - }, - "daemonThreads" : { - "type" : "integer", - "format" : "int32", - "description" : "Number of daemon threads." - }, - "uptime" : { - "type" : "string", - "description" : "The uptime of the Java virtual machine" - }, - "flowFileRepositoryStorageUsage" : { - "description" : "The flowfile repository storage usage.", - "$ref" : "#/definitions/StorageUsageDTO" - }, - "contentRepositoryStorageUsage" : { - "type" : "array", - "description" : "The content repository storage usage.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/StorageUsageDTO" - } - }, - "provenanceRepositoryStorageUsage" : { - "type" : "array", - "description" : "The provenance repository storage usage.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/StorageUsageDTO" - } - }, - "garbageCollection" : { - "type" : "array", - "description" : "The garbage collection details.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/GarbageCollectionDTO" - } - }, - "statsLastRefreshed" : { - "type" : "string", - "description" : "When the diagnostics were generated." - }, - "versionInfo" : { - "description" : "The nifi, os, java, and build version information", - "$ref" : "#/definitions/VersionInfoDTO" - } - } - }, - "TemplateDTO" : { - "type" : "object", - "properties" : { - "uri" : { - "type" : "string", - "description" : "The URI for the template." - }, - "id" : { - "type" : "string", - "description" : "The id of the template." - }, - "groupId" : { - "type" : "string", - "description" : "The id of the Process Group that the template belongs to." - }, - "name" : { - "type" : "string", - "description" : "The name of the template." - }, - "description" : { - "type" : "string", - "description" : "The description of the template." - }, - "timestamp" : { - "type" : "string", - "description" : "The timestamp when this template was created." - }, - "encodingVersion" : { - "type" : "string", - "xml" : { - "name" : "encoding-version", - "attribute" : true - }, - "description" : "The encoding version of this template." - }, - "snippet" : { - "description" : "The contents of the template.", - "$ref" : "#/definitions/FlowSnippetDTO" - } - }, - "xml" : { - "name" : "template" - } - }, - "TemplateEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "template" : { - "$ref" : "#/definitions/TemplateDTO" - } - }, - "xml" : { - "name" : "templateEntity" - } - }, - "TemplatesEntity" : { - "type" : "object", - "properties" : { - "templates" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/TemplateEntity" - } - }, - "generated" : { - "type" : "string", - "description" : "When this content was generated." - } - }, - "xml" : { - "name" : "templatesEntity" - } - }, - "TenantDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "versionedComponentId" : { - "type" : "string", - "description" : "The ID of the corresponding component that is under version control" - }, - "parentGroupId" : { - "type" : "string", - "description" : "The id of parent process group of this component if applicable." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "identity" : { - "type" : "string", - "description" : "The identity of the tenant." - }, - "configurable" : { - "type" : "boolean", - "description" : "Whether this tenant is configurable." - } - } - }, - "TenantEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "component" : { - "$ref" : "#/definitions/TenantDTO" - } - }, - "xml" : { - "name" : "tenantEntity" - } - }, - "TenantsEntity" : { - "type" : "object", - "properties" : { - "users" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/TenantEntity" - } - }, - "userGroups" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/TenantEntity" - } - } - }, - "xml" : { - "name" : "tenantsEntity" - } - }, - "ThreadDumpDTO" : { - "type" : "object", - "properties" : { - "nodeId" : { - "type" : "string", - "description" : "The ID of the node in the cluster" - }, - "nodeAddress" : { - "type" : "string", - "description" : "The address of the node in the cluster" - }, - "apiPort" : { - "type" : "integer", - "format" : "int32", - "description" : "The port the node is listening for API requests." - }, - "stackTrace" : { - "type" : "string", - "description" : "The stack trace for the thread" - }, - "threadName" : { - "type" : "string", - "description" : "The name of the thread" - }, - "threadActiveMillis" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of milliseconds that the thread has been executing in the Processor" - }, - "taskTerminated" : { - "type" : "boolean", - "description" : "Indicates whether or not the user has requested that the task be terminated. If this is true, it may indicate that the thread is in a state where it will continue running indefinitely without returning." - } - } - }, - "TransactionResultEntity" : { - "type" : "object", - "properties" : { - "flowFileSent" : { - "type" : "integer", - "format" : "int32" - }, - "responseCode" : { - "type" : "integer", - "format" : "int32" - }, - "message" : { - "type" : "string" - } - }, - "xml" : { - "name" : "transactionResultEntity" - } - }, - "UpdateControllerServiceReferenceRequestEntity" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The identifier of the Controller Service." - }, - "state" : { - "type" : "string", - "description" : "The new state of the references for the controller service.", - "enum" : [ "ENABLED", "DISABLED", "RUNNING", "STOPPED" ] - }, - "referencingComponentRevisions" : { - "type" : "object", - "description" : "The revisions for all referencing components.", - "additionalProperties" : { - "$ref" : "#/definitions/RevisionDTO" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - } - }, - "xml" : { - "name" : "updateControllerServiceReferenceRequestEntity" - } - }, - "UserDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "versionedComponentId" : { - "type" : "string", - "description" : "The ID of the corresponding component that is under version control" - }, - "parentGroupId" : { - "type" : "string", - "description" : "The id of parent process group of this component if applicable." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "identity" : { - "type" : "string", - "description" : "The identity of the tenant." - }, - "configurable" : { - "type" : "boolean", - "description" : "Whether this tenant is configurable." - }, - "userGroups" : { - "type" : "array", - "description" : "The groups to which the user belongs. This field is read only and it provided for convenience.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/TenantEntity" - } - }, - "accessPolicies" : { - "type" : "array", - "description" : "The access policies this user belongs to.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/AccessPolicySummaryEntity" - } - } - } - }, - "UserEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "component" : { - "$ref" : "#/definitions/UserDTO" - } - }, - "xml" : { - "name" : "userEntity" - } - }, - "UserGroupDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "versionedComponentId" : { - "type" : "string", - "description" : "The ID of the corresponding component that is under version control" - }, - "parentGroupId" : { - "type" : "string", - "description" : "The id of parent process group of this component if applicable." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "identity" : { - "type" : "string", - "description" : "The identity of the tenant." - }, - "configurable" : { - "type" : "boolean", - "description" : "Whether this tenant is configurable." - }, - "users" : { - "type" : "array", - "description" : "The users that belong to the user group.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/TenantEntity" - } - }, - "accessPolicies" : { - "type" : "array", - "description" : "The access policies this user group belongs to. This field was incorrectly defined as an AccessPolicyEntity. For compatibility reasons the field will remain of this type, however only the fields that are present in the AccessPolicySummaryEntity will be populated here.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/AccessPolicyEntity" - } - } - } - }, - "UserGroupEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "component" : { - "$ref" : "#/definitions/UserGroupDTO" - } - }, - "xml" : { - "name" : "userGroupEntity" - } - }, - "UserGroupsEntity" : { - "type" : "object", - "properties" : { - "userGroups" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/UserGroupEntity" - } - } - }, - "xml" : { - "name" : "userGroupsEntity" - } - }, - "UsersEntity" : { - "type" : "object", - "properties" : { - "generated" : { - "type" : "string", - "description" : "When this content was generated." - }, - "users" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/UserEntity" - } - } - }, - "xml" : { - "name" : "usersEntity" - } - }, - "VariableDTO" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The name of the variable" - }, - "value" : { - "type" : "string", - "description" : "The value of the variable" - }, - "processGroupId" : { - "type" : "string", - "description" : "The ID of the Process Group where this Variable is defined" - }, - "affectedComponents" : { - "type" : "array", - "description" : "A set of all components that will be affected if the value of this variable is changed", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/AffectedComponentEntity" - } - } - } - }, - "VariableEntity" : { - "type" : "object", - "properties" : { - "variable" : { - "description" : "The variable information", - "$ref" : "#/definitions/VariableDTO" - }, - "canWrite" : { - "type" : "boolean", - "description" : "Indicates whether the user can write a given resource." - } - }, - "xml" : { - "name" : "variableEntity" - } - }, - "VariableRegistryDTO" : { - "type" : "object", - "properties" : { - "variables" : { - "type" : "array", - "description" : "The variables that are available in this Variable Registry", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VariableEntity" - } - }, - "processGroupId" : { - "type" : "string", - "description" : "The UUID of the Process Group that this Variable Registry belongs to" - } - } - }, - "VariableRegistryEntity" : { - "type" : "object", - "properties" : { - "processGroupRevision" : { - "description" : "The revision of the Process Group that the Variable Registry belongs to", - "$ref" : "#/definitions/RevisionDTO" - }, - "variableRegistry" : { - "description" : "The Variable Registry.", - "$ref" : "#/definitions/VariableRegistryDTO" - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - } - }, - "xml" : { - "name" : "variableRegistryEntity" - } - }, - "VariableRegistryUpdateRequestDTO" : { - "type" : "object", - "properties" : { - "requestId" : { - "type" : "string", - "description" : "The ID of the request" - }, - "uri" : { - "type" : "string", - "description" : "The URI for the request" - }, - "submissionTime" : { - "type" : "string", - "format" : "date-time", - "description" : "The timestamp of when the request was submitted" - }, - "lastUpdated" : { - "type" : "string", - "format" : "date-time", - "description" : "The timestamp of when the request was last updated" - }, - "complete" : { - "type" : "boolean", - "description" : "Whether or not the request is completed" - }, - "failureReason" : { - "type" : "string", - "description" : "The reason for the request failing, or null if the request has not failed" - }, - "percentCompleted" : { - "type" : "integer", - "format" : "int32", - "description" : "A value between 0 and 100 (inclusive) indicating how close the request is to completion" - }, - "state" : { - "type" : "string", - "description" : "A description of the current state of the request" - }, - "updateSteps" : { - "type" : "array", - "description" : "The steps that are required in order to complete the request, along with the status of each", - "items" : { - "$ref" : "#/definitions/VariableRegistryUpdateStepDTO" - } - }, - "processGroupId" : { - "type" : "string", - "description" : "The unique ID of the Process Group that the variable registry belongs to" - }, - "affectedComponents" : { - "type" : "array", - "description" : "A set of all components that will be affected if the value of this variable is changed", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/AffectedComponentEntity" - } - } - } - }, - "VariableRegistryUpdateRequestEntity" : { - "type" : "object", - "properties" : { - "request" : { - "description" : "The Variable Registry Update Request", - "$ref" : "#/definitions/VariableRegistryUpdateRequestDTO" - }, - "processGroupRevision" : { - "description" : "The revision for the Process Group that owns this variable registry.", - "$ref" : "#/definitions/RevisionDTO" - } - }, - "xml" : { - "name" : "variableRegistryUpdateRequestEntity" - } - }, - "VariableRegistryUpdateStepDTO" : { - "type" : "object", - "properties" : { - "description" : { - "type" : "string", - "description" : "Explanation of what happens in this step" - }, - "complete" : { - "type" : "boolean", - "description" : "Whether or not this step has completed" - }, - "failureReason" : { - "type" : "string", - "description" : "An explanation of why this step failed, or null if this step did not fail" - } - } - }, - "VerifyConfigRequestDTO" : { - "type" : "object", - "properties" : { - "requestId" : { - "type" : "string", - "description" : "The ID of the request" - }, - "uri" : { - "type" : "string", - "description" : "The URI for the request" - }, - "submissionTime" : { - "type" : "string", - "format" : "date-time", - "description" : "The timestamp of when the request was submitted" - }, - "lastUpdated" : { - "type" : "string", - "format" : "date-time", - "description" : "The timestamp of when the request was last updated" - }, - "complete" : { - "type" : "boolean", - "description" : "Whether or not the request is completed" - }, - "failureReason" : { - "type" : "string", - "description" : "The reason for the request failing, or null if the request has not failed" - }, - "percentCompleted" : { - "type" : "integer", - "format" : "int32", - "description" : "A value between 0 and 100 (inclusive) indicating how close the request is to completion" - }, - "state" : { - "type" : "string", - "description" : "A description of the current state of the request" - }, - "updateSteps" : { - "type" : "array", - "description" : "The steps that are required in order to complete the request, along with the status of each", - "items" : { - "$ref" : "#/definitions/VerifyConfigUpdateStepDTO" - } - }, - "componentId" : { - "type" : "string", - "description" : "The ID of the component whose configuration was verified" - }, - "properties" : { - "type" : "object", - "description" : "The configured component properties", - "additionalProperties" : { - "type" : "string" - } - }, - "attributes" : { - "type" : "object", - "description" : "FlowFile Attributes that should be used to evaluate Expression Language for resolving property values", - "additionalProperties" : { - "type" : "string" - } - }, - "results" : { - "type" : "array", - "description" : "The Results of the verification", - "items" : { - "$ref" : "#/definitions/ConfigVerificationResultDTO" - } - } - } - }, - "VerifyConfigRequestEntity" : { - "type" : "object", - "properties" : { - "request" : { - "description" : "The request", - "$ref" : "#/definitions/VerifyConfigRequestDTO" - } - }, - "xml" : { - "name" : "verifyConfigRequest" - } - }, - "VerifyConfigUpdateStepDTO" : { - "type" : "object", - "properties" : { - "description" : { - "type" : "string", - "description" : "Explanation of what happens in this step" - }, - "complete" : { - "type" : "boolean", - "description" : "Whether or not this step has completed" - }, - "failureReason" : { - "type" : "string", - "description" : "An explanation of why this step failed, or null if this step did not fail" - } - } - }, - "VersionControlComponentMappingEntity" : { - "type" : "object", - "properties" : { - "versionControlComponentMapping" : { - "type" : "object", - "description" : "The mapping of Versioned Component Identifiers to instance ID's", - "additionalProperties" : { - "type" : "string" - } - }, - "processGroupRevision" : { - "description" : "The revision of the Process Group", - "$ref" : "#/definitions/RevisionDTO" - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "versionControlInformation" : { - "description" : "The Version Control information", - "$ref" : "#/definitions/VersionControlInformationDTO" - } - }, - "xml" : { - "name" : "versionControlComponentMappingEntity" - } - }, - "VersionControlInformationDTO" : { - "type" : "object", - "properties" : { - "groupId" : { - "type" : "string", - "description" : "The ID of the Process Group that is under version control" - }, - "registryId" : { - "type" : "string", - "description" : "The ID of the registry that the flow is stored in" - }, - "registryName" : { - "type" : "string", - "description" : "The name of the registry that the flow is stored in" - }, - "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" - }, - "flowId" : { - "type" : "string", - "description" : "The ID of the flow" - }, - "flowName" : { - "type" : "string", - "description" : "The name of the flow" - }, - "flowDescription" : { - "type" : "string", - "description" : "The description of the flow" - }, - "version" : { - "type" : "integer", - "format" : "int32", - "description" : "The version of the flow" - }, - "state" : { - "type" : "string", - "description" : "The current state of the Process Group, as it relates to the Versioned Flow", - "enum" : [ "LOCALLY_MODIFIED", "STALE", "LOCALLY_MODIFIED_AND_STALE", "UP_TO_DATE", "SYNC_FAILURE" ] - }, - "stateExplanation" : { - "type" : "string", - "description" : "Explanation of why the group is in the specified state" - } - } - }, - "VersionControlInformationEntity" : { - "type" : "object", - "properties" : { - "processGroupRevision" : { - "description" : "The Revision for the Process Group", - "$ref" : "#/definitions/RevisionDTO" - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "versionControlInformation" : { - "description" : "The Version Control information", - "$ref" : "#/definitions/VersionControlInformationDTO" - } - }, - "xml" : { - "name" : "versionControlInformationEntity" - } - }, - "VersionInfoDTO" : { - "type" : "object", - "properties" : { - "niFiVersion" : { - "type" : "string", - "description" : "The version of this NiFi." - }, - "javaVendor" : { - "type" : "string", - "description" : "Java JVM vendor" - }, - "javaVersion" : { - "type" : "string", - "description" : "Java version" - }, - "osName" : { - "type" : "string", - "description" : "Host operating system name" - }, - "osVersion" : { - "type" : "string", - "description" : "Host operating system version" - }, - "osArchitecture" : { - "type" : "string", - "description" : "Host operating system architecture" - }, - "buildTag" : { - "type" : "string", - "description" : "Build tag" - }, - "buildRevision" : { - "type" : "string", - "description" : "Build revision or commit hash" - }, - "buildBranch" : { - "type" : "string", - "description" : "Build branch" - }, - "buildTimestamp" : { - "type" : "string", - "format" : "date-time", - "description" : "Build timestamp" - } - } - }, - "VersionedConnection" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The component's unique identifier" - }, - "name" : { - "type" : "string", - "description" : "The component's name" - }, - "comments" : { - "type" : "string", - "description" : "The user-supplied comments for the component" - }, - "position" : { - "description" : "The component's position on the graph", - "$ref" : "#/definitions/Position" - }, - "source" : { - "description" : "The source of the connection.", - "$ref" : "#/definitions/ConnectableComponent" - }, - "destination" : { - "description" : "The destination of the connection.", - "$ref" : "#/definitions/ConnectableComponent" - }, - "labelIndex" : { - "type" : "integer", - "format" : "int32", - "description" : "The index of the bend point where to place the connection label." - }, - "zIndex" : { - "type" : "integer", - "format" : "int64", - "description" : "The z index of the connection." - }, - "selectedRelationships" : { - "type" : "array", - "description" : "The selected relationship that comprise the connection.", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - }, - "backPressureObjectThreshold" : { - "type" : "integer", - "format" : "int64", - "description" : "The object count threshold for determining when back pressure is applied. Updating this value is a passive change in the sense that it won't impact whether existing files over the limit are affected but it does help feeder processors to stop pushing too much into this work queue." - }, - "backPressureDataSizeThreshold" : { - "type" : "string", - "description" : "The object data size threshold for determining when back pressure is applied. Updating this value is a passive change in the sense that it won't impact whether existing files over the limit are affected but it does help feeder processors to stop pushing too much into this work queue." - }, - "flowFileExpiration" : { - "type" : "string", - "description" : "The amount of time a flow file may be in the flow before it will be automatically aged out of the flow. Once a flow file reaches this age it will be terminated from the flow the next time a processor attempts to start work on it." - }, - "prioritizers" : { - "type" : "array", - "description" : "The comparators used to prioritize the queue.", - "items" : { - "type" : "string" - } - }, - "bends" : { - "type" : "array", - "description" : "The bend points on the connection.", - "items" : { - "$ref" : "#/definitions/Position" - } - }, - "loadBalanceStrategy" : { - "type" : "string", - "description" : "The Strategy to use for load balancing data across the cluster, or null, if no Load Balance Strategy has been specified.", - "enum" : [ "DO_NOT_LOAD_BALANCE", "PARTITION_BY_ATTRIBUTE", "ROUND_ROBIN", "SINGLE_NODE" ] - }, - "partitioningAttribute" : { - "type" : "string", - "description" : "The attribute to use for partitioning data as it is load balanced across the cluster. If the Load Balance Strategy is configured to use PARTITION_BY_ATTRIBUTE, the value returned by this method is the name of the FlowFile Attribute that will be used to determine which node in the cluster should receive a given FlowFile. If the Load Balance Strategy is unset or is set to any other value, the Partitioning Attribute has no effect." - }, - "loadBalanceCompression" : { - "type" : "string", - "description" : "Whether or not compression should be used when transferring FlowFiles between nodes", - "enum" : [ "DO_NOT_COMPRESS", "COMPRESS_ATTRIBUTES_ONLY", "COMPRESS_ATTRIBUTES_AND_CONTENT" ] - }, - "componentType" : { - "type" : "string", - "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE" ] - }, - "groupIdentifier" : { - "type" : "string", - "description" : "The ID of the Process Group that this component belongs to" - } - } - }, - "VersionedControllerService" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The component's unique identifier" - }, - "name" : { - "type" : "string", - "description" : "The component's name" - }, - "comments" : { - "type" : "string", - "description" : "The user-supplied comments for the component" - }, - "position" : { - "description" : "The component's position on the graph", - "$ref" : "#/definitions/Position" - }, - "type" : { - "type" : "string", - "description" : "The type of the controller service." - }, - "bundle" : { - "description" : "The details of the artifact that bundled this processor type.", - "$ref" : "#/definitions/Bundle" - }, - "controllerServiceApis" : { - "type" : "array", - "description" : "Lists the APIs this Controller Service implements.", - "items" : { - "$ref" : "#/definitions/ControllerServiceAPI" - } - }, - "properties" : { - "type" : "object", - "description" : "The properties of the controller service.", - "additionalProperties" : { - "type" : "string" - } - }, - "propertyDescriptors" : { - "type" : "object", - "description" : "The property descriptors for the processor.", - "additionalProperties" : { - "$ref" : "#/definitions/VersionedPropertyDescriptor" - } - }, - "annotationData" : { - "type" : "string", - "description" : "The annotation for the controller service. This is how the custom UI relays configuration to the controller service." - }, - "componentType" : { - "type" : "string", - "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE" ] - }, - "groupIdentifier" : { - "type" : "string", - "description" : "The ID of the Process Group that this component belongs to" - } - } - }, - "VersionedFlow" : { - "type" : "object", - "required" : [ "bucketIdentifier", "name", "type" ], - "properties" : { - "link" : { - "description" : "An WebLink to this entity.", - "readOnly" : true, - "$ref" : "#/definitions/JaxbLink" - }, - "identifier" : { - "type" : "string", - "description" : "An ID to uniquely identify this object.", - "readOnly" : true - }, - "name" : { - "type" : "string", - "description" : "The name of the item." - }, - "description" : { - "type" : "string", - "description" : "A description of the item." - }, - "bucketIdentifier" : { - "type" : "string", - "description" : "The identifier of the bucket this items belongs to. This cannot be changed after the item is created." - }, - "bucketName" : { - "type" : "string", - "description" : "The name of the bucket this items belongs to.", - "readOnly" : true - }, - "createdTimestamp" : { - "type" : "integer", - "format" : "int64", - "description" : "The timestamp of when the item was created, as milliseconds since epoch.", - "readOnly" : true, - "minimum" : 1 - }, - "modifiedTimestamp" : { - "type" : "integer", - "format" : "int64", - "description" : "The timestamp of when the item was last modified, as milliseconds since epoch.", - "readOnly" : true, - "minimum" : 1 - }, - "type" : { - "type" : "string", - "description" : "The type of item.", - "enum" : [ "Flow", "Bundle" ] - }, - "permissions" : { - "description" : "The access that the current user has to the bucket containing this item.", - "readOnly" : true, - "$ref" : "#/definitions/Permissions" - }, - "versionCount" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of versions of this flow.", - "readOnly" : true, - "minimum" : 0 - }, - "revision" : { - "description" : "The revision of this entity used for optimistic-locking during updates.", - "readOnly" : true, - "$ref" : "#/definitions/RevisionInfo" - } - } - }, - "VersionedFlowCoordinates" : { - "type" : "object", - "properties" : { - "registryUrl" : { - "type" : "string", - "description" : "The URL of the Flow Registry that contains the flow" - }, - "bucketId" : { - "type" : "string", - "description" : "The UUID of the bucket that the flow resides in" - }, - "flowId" : { - "type" : "string", - "description" : "The UUID of the flow" - }, - "version" : { - "type" : "integer", - "format" : "int32", - "description" : "The version of the flow" - }, - "latest" : { - "type" : "boolean", - "description" : "Whether or not these coordinates point to the latest version of the flow" - } - } - }, - "VersionedFlowDTO" : { - "type" : "object", - "properties" : { - "registryId" : { - "type" : "string", - "description" : "The ID of the registry that the flow is tracked to" - }, - "bucketId" : { - "type" : "string", - "description" : "The ID of the bucket where the flow is stored" - }, - "flowId" : { - "type" : "string", - "description" : "The ID of the flow" - }, - "flowName" : { - "type" : "string", - "description" : "The name of the flow" - }, - "description" : { - "type" : "string", - "description" : "A description of the flow" - }, - "comments" : { - "type" : "string", - "description" : "Comments for the changeset" - }, - "action" : { - "type" : "string", - "description" : "The action being performed", - "enum" : [ "COMMIT", "FORCE_COMMIT" ] - } - } - }, - "VersionedFlowEntity" : { - "type" : "object", - "properties" : { - "versionedFlow" : { - "description" : "The versioned flow", - "$ref" : "#/definitions/VersionedFlowDTO" - } - }, - "xml" : { - "name" : "versionedFlowEntity" - } - }, - "VersionedFlowSnapshot" : { - "type" : "object", - "required" : [ "flowContents", "snapshotMetadata" ], - "properties" : { - "snapshotMetadata" : { - "description" : "The metadata for this snapshot", - "$ref" : "#/definitions/VersionedFlowSnapshotMetadata" - }, - "flowContents" : { - "description" : "The contents of the versioned flow", - "$ref" : "#/definitions/VersionedProcessGroup" - }, - "externalControllerServices" : { - "type" : "object", - "description" : "The information about controller services that exist outside this versioned flow, but are referenced by components within the versioned flow.", - "additionalProperties" : { - "$ref" : "#/definitions/ExternalControllerServiceReference" - } - }, - "parameterContexts" : { - "type" : "object", - "description" : "The parameter contexts referenced by process groups in the flow contents. The mapping is from the name of the context to the context instance, and it is expected that any context in this map is referenced by at least one process group in this flow.", - "additionalProperties" : { - "$ref" : "#/definitions/VersionedParameterContext" - } - }, - "flowEncodingVersion" : { - "type" : "string", - "description" : "The optional encoding version of the flow contents." - }, - "flow" : { - "description" : "The flow this snapshot is for", - "readOnly" : true, - "$ref" : "#/definitions/VersionedFlow" - }, - "bucket" : { - "description" : "The bucket where the flow is located", - "readOnly" : true, - "$ref" : "#/definitions/Bucket" - }, - "latest" : { - "type" : "boolean" - } - } - }, - "VersionedFlowSnapshotEntity" : { - "type" : "object", - "properties" : { - "versionedFlowSnapshot" : { - "description" : "The versioned flow snapshot", - "$ref" : "#/definitions/VersionedFlowSnapshot" - }, - "processGroupRevision" : { - "description" : "The Revision of the Process Group under Version Control", - "$ref" : "#/definitions/RevisionDTO" - }, - "registryId" : { - "type" : "string", - "description" : "The ID of the Registry that this flow belongs to" - }, - "updateDescendantVersionedFlows" : { - "type" : "boolean", - "description" : "If the Process Group to be updated has a child or descendant Process Group that is also under Version Control, this specifies whether or not the contents of that child/descendant Process Group should be updated." - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - } - }, - "xml" : { - "name" : "versionedFlowSnapshotEntity" - } - }, - "VersionedFlowSnapshotMetadata" : { - "type" : "object", - "required" : [ "bucketIdentifier", "flowIdentifier", "version" ], - "properties" : { - "link" : { - "description" : "An WebLink to this entity.", - "readOnly" : true, - "$ref" : "#/definitions/JaxbLink" - }, - "bucketIdentifier" : { - "type" : "string", - "description" : "The identifier of the bucket this snapshot belongs to." - }, - "flowIdentifier" : { - "type" : "string", - "description" : "The identifier of the flow this snapshot belongs to." - }, - "version" : { - "type" : "integer", - "format" : "int32", - "description" : "The version of this snapshot of the flow.", - "minimum" : -1 - }, - "timestamp" : { - "type" : "integer", - "format" : "int64", - "description" : "The timestamp when the flow was saved, as milliseconds since epoch.", - "readOnly" : true, - "minimum" : 1 - }, - "author" : { - "type" : "string", - "description" : "The user that created this snapshot of the flow.", - "readOnly" : true - }, - "comments" : { - "type" : "string", - "description" : "The comments provided by the user when creating the snapshot." - } - } - }, - "VersionedFlowSnapshotMetadataEntity" : { - "type" : "object", - "properties" : { - "versionedFlowSnapshotMetadata" : { - "description" : "The collection of versioned flow snapshot metadata", - "$ref" : "#/definitions/VersionedFlowSnapshotMetadata" - }, - "registryId" : { - "type" : "string", - "description" : "The ID of the Registry that this flow belongs to" - } - }, - "xml" : { - "name" : "versionedFlowSnapshotMetadataEntity" - } - }, - "VersionedFlowSnapshotMetadataSetEntity" : { - "type" : "object", - "properties" : { - "versionedFlowSnapshotMetadataSet" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedFlowSnapshotMetadataEntity" - } - } - }, - "xml" : { - "name" : "versionedFlowSnapshotMetadataSetEntity" - } - }, - "VersionedFlowUpdateRequestDTO" : { - "type" : "object", - "properties" : { - "requestId" : { - "type" : "string", - "description" : "The unique ID of this request." - }, - "processGroupId" : { - "type" : "string", - "description" : "The unique ID of the Process Group being updated" - }, - "uri" : { - "type" : "string", - "description" : "The URI for future requests to this drop request." - }, - "lastUpdated" : { - "type" : "string", - "description" : "The last time this request was updated." - }, - "complete" : { - "type" : "boolean", - "description" : "Whether or not this request has completed" - }, - "failureReason" : { - "type" : "string", - "description" : "An explanation of why this request failed, or null if this request has not failed" - }, - "percentCompleted" : { - "type" : "integer", - "format" : "int32", - "description" : "The percentage complete for the request, between 0 and 100" - }, - "state" : { - "type" : "string", - "description" : "The state of the request" - }, - "versionControlInformation" : { - "description" : "The VersionControlInformation that describes where the Versioned Flow is located; this may not be populated until the request is completed.", - "$ref" : "#/definitions/VersionControlInformationDTO" - } - } - }, - "VersionedFlowUpdateRequestEntity" : { - "type" : "object", - "properties" : { - "processGroupRevision" : { - "description" : "The revision for the Process Group being updated.", - "$ref" : "#/definitions/RevisionDTO" - }, - "request" : { - "description" : "The Flow Update Request", - "$ref" : "#/definitions/VersionedFlowUpdateRequestDTO" - } - }, - "xml" : { - "name" : "versionedFlowUpdateRequestEntity" - } - }, - "VersionedFlowsEntity" : { - "type" : "object", - "properties" : { - "versionedFlows" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedFlowEntity" - } - } - }, - "xml" : { - "name" : "versionedFlowsEntity" - } - }, - "VersionedFunnel" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The component's unique identifier" - }, - "name" : { - "type" : "string", - "description" : "The component's name" - }, - "comments" : { - "type" : "string", - "description" : "The user-supplied comments for the component" - }, - "position" : { - "description" : "The component's position on the graph", - "$ref" : "#/definitions/Position" - }, - "componentType" : { - "type" : "string", - "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE" ] - }, - "groupIdentifier" : { - "type" : "string", - "description" : "The ID of the Process Group that this component belongs to" - } - } - }, - "VersionedLabel" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The component's unique identifier" - }, - "name" : { - "type" : "string", - "description" : "The component's name" - }, - "comments" : { - "type" : "string", - "description" : "The user-supplied comments for the component" - }, - "position" : { - "description" : "The component's position on the graph", - "$ref" : "#/definitions/Position" - }, - "label" : { - "type" : "string", - "description" : "The text that appears in the label." - }, - "width" : { - "type" : "number", - "format" : "double", - "description" : "The width of the label in pixels when at a 1:1 scale." - }, - "height" : { - "type" : "number", - "format" : "double", - "description" : "The height of the label in pixels when at a 1:1 scale." - }, - "style" : { - "type" : "object", - "description" : "The styles for this label (font-size : 12px, background-color : #eee, etc).", - "additionalProperties" : { - "type" : "string" - } - }, - "componentType" : { - "type" : "string", - "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE" ] - }, - "groupIdentifier" : { - "type" : "string", - "description" : "The ID of the Process Group that this component belongs to" - } - } - }, - "VersionedParameter" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The name of the parameter" - }, - "description" : { - "type" : "string", - "description" : "The description of the param" - }, - "sensitive" : { - "type" : "boolean", - "description" : "Whether or not the parameter value is sensitive" - }, - "value" : { - "type" : "string", - "description" : "The value of the parameter" - } - } - }, - "VersionedParameterContext" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The name of the context" - }, - "description" : { - "type" : "string", - "description" : "The description of the parameter context" - }, - "parameters" : { - "type" : "array", - "description" : "The parameters in the context", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedParameter" - } - }, - "inheritedParameterContexts" : { - "type" : "array", - "description" : "The names of additional parameter contexts from which to inherit parameters", - "items" : { - "type" : "string" - } - } - } - }, - "VersionedPort" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The component's unique identifier" - }, - "name" : { - "type" : "string", - "description" : "The component's name" - }, - "comments" : { - "type" : "string", - "description" : "The user-supplied comments for the component" - }, - "position" : { - "description" : "The component's position on the graph", - "$ref" : "#/definitions/Position" - }, - "type" : { - "type" : "string", - "description" : "The type of port.", - "enum" : [ "INPUT_PORT", "OUTPUT_PORT" ] - }, - "concurrentlySchedulableTaskCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of tasks that should be concurrently scheduled for the port." - }, - "scheduledState" : { - "type" : "string", - "description" : "The scheduled state of the component", - "enum" : [ "ENABLED", "DISABLED" ] - }, - "allowRemoteAccess" : { - "type" : "boolean", - "description" : "Whether or not this port allows remote access for site-to-site" - }, - "componentType" : { - "type" : "string", - "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE" ] - }, - "groupIdentifier" : { - "type" : "string", - "description" : "The ID of the Process Group that this component belongs to" - } - } - }, - "VersionedProcessGroup" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The component's unique identifier" - }, - "name" : { - "type" : "string", - "description" : "The component's name" - }, - "comments" : { - "type" : "string", - "description" : "The user-supplied comments for the component" - }, - "position" : { - "description" : "The component's position on the graph", - "$ref" : "#/definitions/Position" - }, - "processGroups" : { - "type" : "array", - "description" : "The child Process Groups", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedProcessGroup" - } - }, - "remoteProcessGroups" : { - "type" : "array", - "description" : "The Remote Process Groups", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedRemoteProcessGroup" - } - }, - "processors" : { - "type" : "array", - "description" : "The Processors", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedProcessor" - } - }, - "inputPorts" : { - "type" : "array", - "description" : "The Input Ports", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedPort" - } - }, - "outputPorts" : { - "type" : "array", - "description" : "The Output Ports", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedPort" - } - }, - "connections" : { - "type" : "array", - "description" : "The Connections", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedConnection" - } - }, - "labels" : { - "type" : "array", - "description" : "The Labels", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedLabel" - } - }, - "funnels" : { - "type" : "array", - "description" : "The Funnels", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedFunnel" - } - }, - "controllerServices" : { - "type" : "array", - "description" : "The Controller Services", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedControllerService" - } - }, - "versionedFlowCoordinates" : { - "description" : "The coordinates where the remote flow is stored, or null if the Process Group is not directly under Version Control", - "$ref" : "#/definitions/VersionedFlowCoordinates" - }, - "variables" : { - "type" : "object", - "description" : "The Variables in the Variable Registry for this Process Group (not including any ancestor or descendant Process Groups)", - "additionalProperties" : { - "type" : "string" - } - }, - "parameterContextName" : { - "type" : "string", - "description" : "The name of the parameter context used by this process group" - }, - "defaultFlowFileExpiration" : { - "type" : "string", - "description" : "The default FlowFile Expiration for this Process Group." - }, - "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." - }, - "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." - }, - "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" ] - }, - "flowFileConcurrency" : { - "type" : "string", - "description" : "The configured FlowFile Concurrency for the Process Group" - }, - "flowFileOutboundPolicy" : { - "type" : "string", - "description" : "The FlowFile Outbound Policy for the Process Group" - }, - "groupIdentifier" : { - "type" : "string", - "description" : "The ID of the Process Group that this component belongs to" - } - } - }, - "VersionedProcessor" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The component's unique identifier" - }, - "name" : { - "type" : "string", - "description" : "The component's name" - }, - "comments" : { - "type" : "string", - "description" : "The user-supplied comments for the component" - }, - "position" : { - "description" : "The component's position on the graph", - "$ref" : "#/definitions/Position" - }, - "bundle" : { - "description" : "Information about the bundle from which the component came", - "$ref" : "#/definitions/Bundle" - }, - "style" : { - "type" : "object", - "description" : "Stylistic data for rendering in a UI", - "additionalProperties" : { - "type" : "string" - } - }, - "type" : { - "type" : "string", - "description" : "The type of Processor" - }, - "properties" : { - "type" : "object", - "description" : "The properties for the processor. Properties whose value is not set will only contain the property name.", - "additionalProperties" : { - "type" : "string" - } - }, - "propertyDescriptors" : { - "type" : "object", - "description" : "The property descriptors for the processor.", - "additionalProperties" : { - "$ref" : "#/definitions/VersionedPropertyDescriptor" - } - }, - "annotationData" : { - "type" : "string", - "description" : "The annotation data for the processor used to relay configuration between a custom UI and the procesosr." - }, - "schedulingPeriod" : { - "type" : "string", - "description" : "The frequency with which to schedule the processor. The format of the value will depend on th value of schedulingStrategy." - }, - "schedulingStrategy" : { - "type" : "string", - "description" : "Indcates whether the prcessor should be scheduled to run in event or timer driven mode." - }, - "executionNode" : { - "type" : "string", - "description" : "Indicates the node where the process will execute." - }, - "penaltyDuration" : { - "type" : "string", - "description" : "The amout of time that is used when the process penalizes a flowfile." - }, - "yieldDuration" : { - "type" : "string", - "description" : "The amount of time that must elapse before this processor is scheduled again after yielding." - }, - "bulletinLevel" : { - "type" : "string", - "description" : "The level at which the processor will report bulletins." - }, - "runDurationMillis" : { - "type" : "integer", - "format" : "int64", - "description" : "The run duration for the processor in milliseconds." - }, - "concurrentlySchedulableTaskCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of tasks that should be concurrently schedule for the processor. If the processor doesn't allow parallol processing then any positive input will be ignored." - }, - "autoTerminatedRelationships" : { - "type" : "array", - "description" : "The names of all relationships that cause a flow file to be terminated if the relationship is not connected elsewhere. This property differs from the 'isAutoTerminate' property of the RelationshipDTO in that the RelationshipDTO is meant to depict the current configuration, whereas this property can be set in a DTO when updating a Processor in order to change which Relationships should be auto-terminated.", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - }, - "scheduledState" : { - "type" : "string", - "description" : "The scheduled state of the component", - "enum" : [ "ENABLED", "DISABLED" ] - }, - "componentType" : { - "type" : "string", - "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE" ] - }, - "groupIdentifier" : { - "type" : "string", - "description" : "The ID of the Process Group that this component belongs to" - } - } - }, - "VersionedPropertyDescriptor" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The name of the property" - }, - "displayName" : { - "type" : "string", - "description" : "The display name of the property" - }, - "identifiesControllerService" : { - "type" : "boolean", - "description" : "Whether or not the property provides the identifier of a Controller Service" - }, - "sensitive" : { - "type" : "boolean", - "description" : "Whether or not the property is considered sensitive" - }, - "resourceDefinition" : { - "description" : "Returns the Resource Definition that defines which type(s) of resource(s) this property references, if any", - "$ref" : "#/definitions/VersionedResourceDefinition" - } - } - }, - "VersionedRemoteGroupPort" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The component's unique identifier" - }, - "name" : { - "type" : "string", - "description" : "The component's name" - }, - "comments" : { - "type" : "string", - "description" : "The user-supplied comments for the component" - }, - "position" : { - "description" : "The component's position on the graph", - "$ref" : "#/definitions/Position" - }, - "remoteGroupId" : { - "type" : "string", - "description" : "The id of the remote process group that the port resides in." - }, - "concurrentlySchedulableTaskCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of task that may transmit flowfiles to the target port concurrently." - }, - "useCompression" : { - "type" : "boolean", - "description" : "Whether the flowfiles are compressed when sent to the target port." - }, - "batchSize" : { - "description" : "The batch settings for data transmission.", - "$ref" : "#/definitions/BatchSize" - }, - "componentType" : { - "type" : "string", - "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE" ] - }, - "targetId" : { - "type" : "string", - "description" : "The ID of the port on the target NiFi instance" - }, - "scheduledState" : { - "type" : "string", - "description" : "The scheduled state of the component", - "enum" : [ "ENABLED", "DISABLED" ] - }, - "groupIdentifier" : { - "type" : "string", - "description" : "The ID of the Process Group that this component belongs to" - } - } - }, - "VersionedRemoteProcessGroup" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The component's unique identifier" - }, - "name" : { - "type" : "string", - "description" : "The component's name" - }, - "comments" : { - "type" : "string", - "description" : "The user-supplied comments for the component" - }, - "position" : { - "description" : "The component's position on the graph", - "$ref" : "#/definitions/Position" - }, - "targetUri" : { - "type" : "string", - "description" : "[DEPRECATED] The target URI of the remote process group. If target uri is not set, but uris are set, then returns the first uri in the uris. If neither target uri nor uris are set, then returns null." - }, - "targetUris" : { - "type" : "string", - "description" : "The target URIs of the remote process group. If target uris is not set but target uri is set, then returns the single target uri. If neither target uris nor target uri is set, then returns null." - }, - "communicationsTimeout" : { - "type" : "string", - "description" : "The time period used for the timeout when communicating with the target." - }, - "yieldDuration" : { - "type" : "string", - "description" : "When yielding, this amount of time must elapse before the remote process group is scheduled again." - }, - "transportProtocol" : { - "type" : "string", - "description" : "The Transport Protocol that is used for Site-to-Site communications", - "enum" : [ "RAW", "HTTP" ] - }, - "localNetworkInterface" : { - "type" : "string", - "description" : "The local network interface to send/receive data. If not specified, any local address is used. If clustered, all nodes must have an interface with this identifier." - }, - "proxyHost" : { - "type" : "string" - }, - "proxyPort" : { - "type" : "integer", - "format" : "int32" - }, - "proxyUser" : { - "type" : "string" - }, - "inputPorts" : { - "type" : "array", - "description" : "A Set of Input Ports that can be connected to, in order to send data to the remote NiFi instance", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedRemoteGroupPort" - } - }, - "outputPorts" : { - "type" : "array", - "description" : "A Set of Output Ports that can be connected to, in order to pull data from the remote NiFi instance", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedRemoteGroupPort" - } - }, - "componentType" : { - "type" : "string", - "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE" ] - }, - "groupIdentifier" : { - "type" : "string", - "description" : "The ID of the Process Group that this component belongs to" - } - } - }, - "VersionedResourceDefinition" : { - "type" : "object", - "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", - "uniqueItems" : true, - "items" : { - "type" : "string", - "enum" : [ "FILE", "DIRECTORY", "TEXT", "URL" ] - } - } - } - } - } -} diff --git a/resources/client_gen/api_defs/nifi-1.16.1.json b/resources/client_gen/api_defs/nifi-1.16.1.json deleted file mode 100644 index 61166fce..00000000 --- a/resources/client_gen/api_defs/nifi-1.16.1.json +++ /dev/null @@ -1,23877 +0,0 @@ -{ - "swagger" : "2.0", - "info" : { - "description" : "The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and\n stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description,\n definitions of the expected input and output, potential response codes, and the authorizations required\n to invoke each service.", - "version" : "1.16.1", - "title" : "NiFi Rest API", - "contact" : { - "url" : "https://nifi.apache.org", - "email" : "dev@nifi.apache.org" - }, - "license" : { - "name" : "Apache 2.0", - "url" : "http://www.apache.org/licenses/LICENSE-2.0.html" - } - }, - "basePath" : "/nifi-api", - "tags" : [ { - "name" : "access", - "description" : "Endpoints for obtaining an access token or checking access status." - }, { - "name" : "accessoidc", - "description" : "Endpoints for obtaining an access token or checking access status." - }, { - "name" : "accesssaml", - "description" : "Endpoints for authenticating, obtaining an access token or logging out of a configured SAML authentication provider." - }, { - "name" : "connections", - "description" : "Endpoint for managing a Connection." - }, { - "name" : "controller", - "description" : "Provides realtime command and control of this NiFi instance" - }, { - "name" : "controller-services", - "description" : "Endpoint for managing a Controller Service." - }, { - "name" : "counters", - "description" : "Endpoint for managing counters." - }, { - "name" : "data-transfer", - "description" : "Supports data transfers with this NiFi using HTTP based site to site" - }, { - "name" : "flow", - "description" : "Endpoint for accessing the flow structure and component status." - }, { - "name" : "flowfile-queues", - "description" : "Endpoint for managing a FlowFile Queue." - }, { - "name" : "funnel", - "description" : "Endpoint for managing a Funnel." - }, { - "name" : "input-ports", - "description" : "Endpoint for managing an Input Port." - }, { - "name" : "labels", - "description" : "Endpoint for managing a Label." - }, { - "name" : "output-ports", - "description" : "Endpoint for managing an Output Port." - }, { - "name" : "parameter-contexts", - "description" : "Endpoint for managing version control for a flow" - }, { - "name" : "policies", - "description" : "Endpoint for managing access policies." - }, { - "name" : "process-groups", - "description" : "Endpoint for managing a Process Group." - }, { - "name" : "processors", - "description" : "Endpoint for managing a Processor." - }, { - "name" : "provenance", - "description" : "Endpoint for accessing data flow provenance." - }, { - "name" : "provenance-events", - "description" : "Endpoint for accessing data flow provenance." - }, { - "name" : "remote-process-groups", - "description" : "Endpoint for managing a Remote Process Group." - }, { - "name" : "reporting-tasks", - "description" : "Endpoint for managing a Reporting Task." - }, { - "name" : "resources", - "description" : "Provides the resources in this NiFi that can have access/authorization policies." - }, { - "name" : "site-to-site", - "description" : "Provide access to site to site with this NiFi" - }, { - "name" : "snippets", - "description" : "Endpoint for accessing dataflow snippets." - }, { - "name" : "system-diagnostics", - "description" : "Endpoint for accessing system diagnostics." - }, { - "name" : "templates", - "description" : "Endpoint for managing a Template." - }, { - "name" : "tenants", - "description" : "Endpoint for managing users and user groups." - }, { - "name" : "versions", - "description" : "Endpoint for managing version control for a flow" - } ], - "schemes" : [ "http", "https" ], - "paths" : { - "/access" : { - "get" : { - "tags" : [ "access" ], - "summary" : "Gets the status the client's access", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getAccessStatus", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/AccessStatusEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Unable to determine access status because the client could not be authenticated." - }, - "403" : { - "description" : "Unable to determine access status because the client is not authorized to make this request." - }, - "409" : { - "description" : "Unable to determine access status because NiFi is not in the appropriate state." - }, - "500" : { - "description" : "Unable to determine access status because an unexpected error occurred." - } - } - } - }, - "/access/config" : { - "get" : { - "tags" : [ "access" ], - "summary" : "Retrieves the access configuration for this NiFi", - "description" : "", - "operationId" : "getLoginConfig", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/AccessConfigurationEntity" - } - } - } - } - }, - "/access/kerberos" : { - "post" : { - "tags" : [ "access" ], - "summary" : "Creates a token for accessing the REST API via Kerberos ticket exchange / SPNEGO negotiation", - "description" : "The token returned is formatted as a JSON Web Token (JWT). The token is base64 encoded and comprised of three parts. The header, the body, and the signature. The expiration of the token is a contained within the body. The token can be used in the Authorization header in the format 'Authorization: Bearer '. It is also stored in the browser as a cookie.", - "operationId" : "createAccessTokenFromTicket", - "consumes" : [ "text/plain" ], - "produces" : [ "text/plain" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "NiFi was unable to complete the request because it did not contain a valid Kerberos ticket in the Authorization header. Retry this request after initializing a ticket with kinit and ensuring your browser is configured to support SPNEGO." - }, - "409" : { - "description" : "Unable to create access token because NiFi is not in the appropriate state. (i.e. may not be configured to support Kerberos login." - }, - "500" : { - "description" : "Unable to create access token because an unexpected error occurred." - } - } - } - }, - "/access/knox/callback" : { - "get" : { - "tags" : [ "access" ], - "summary" : "Redirect/callback URI for processing the result of the Apache Knox login sequence.", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "knoxCallback", - "consumes" : [ "*/*" ], - "produces" : [ "*/*" ], - "responses" : { - "default" : { - "description" : "successful operation" - } - } - } - }, - "/access/knox/logout" : { - "get" : { - "tags" : [ "access" ], - "summary" : "Performs a logout in the Apache Knox.", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "knoxLogout", - "consumes" : [ "*/*" ], - "produces" : [ "*/*" ], - "responses" : { - "default" : { - "description" : "successful operation" - } - } - } - }, - "/access/knox/request" : { - "get" : { - "tags" : [ "access" ], - "summary" : "Initiates a request to authenticate through Apache Knox.", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "knoxRequest", - "consumes" : [ "*/*" ], - "produces" : [ "*/*" ], - "responses" : { - "default" : { - "description" : "successful operation" - } - } - } - }, - "/access/logout" : { - "delete" : { - "tags" : [ "access" ], - "summary" : "Performs a logout for other providers that have been issued a JWT.", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "logOut", - "consumes" : [ "*/*" ], - "produces" : [ "*/*" ], - "responses" : { - "200" : { - "description" : "User was logged out successfully." - }, - "401" : { - "description" : "Authentication token provided was empty or not in the correct JWT format." - }, - "500" : { - "description" : "Client failed to log out." - } - } - } - }, - "/access/logout/complete" : { - "get" : { - "tags" : [ "access" ], - "summary" : "Completes the logout sequence by removing the cached Logout Request and Cookie if they existed and redirects to /nifi/login.", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "logOutComplete", - "consumes" : [ "*/*" ], - "produces" : [ "*/*" ], - "responses" : { - "200" : { - "description" : "User was logged out successfully." - }, - "401" : { - "description" : "Authentication token provided was empty or not in the correct JWT format." - }, - "500" : { - "description" : "Client failed to log out." - } - } - } - }, - "/access/oidc/callback" : { - "get" : { - "tags" : [ "accessoidc" ], - "summary" : "Redirect/callback URI for processing the result of the OpenId Connect login sequence.", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "oidcCallback", - "consumes" : [ "*/*" ], - "produces" : [ "*/*" ], - "responses" : { - "default" : { - "description" : "successful operation" - } - } - } - }, - "/access/oidc/exchange" : { - "post" : { - "tags" : [ "accessoidc" ], - "summary" : "Retrieves a JWT following a successful login sequence using the configured OpenId Connect provider.", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "oidcExchange", - "consumes" : [ "*/*" ], - "produces" : [ "text/plain" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - } - } - } - }, - "/access/oidc/logout" : { - "get" : { - "tags" : [ "accessoidc" ], - "summary" : "Performs a logout in the OpenId Provider.", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "oidcLogout", - "consumes" : [ "*/*" ], - "produces" : [ "*/*" ], - "responses" : { - "default" : { - "description" : "successful operation" - } - } - } - }, - "/access/oidc/logoutCallback" : { - "get" : { - "tags" : [ "accessoidc" ], - "summary" : "Redirect/callback URI for processing the result of the OpenId Connect logout sequence.", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "oidcLogoutCallback", - "consumes" : [ "*/*" ], - "produces" : [ "*/*" ], - "responses" : { - "default" : { - "description" : "successful operation" - } - } - } - }, - "/access/oidc/request" : { - "get" : { - "tags" : [ "accessoidc" ], - "summary" : "Initiates a request to authenticate through the configured OpenId Connect provider.", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "oidcRequest", - "consumes" : [ "*/*" ], - "produces" : [ "*/*" ], - "responses" : { - "default" : { - "description" : "successful operation" - } - } - } - }, - "/access/saml/local-logout" : { - "get" : { - "tags" : [ "accesssaml" ], - "summary" : "Local logout when SAML is enabled, does not communicate with the IDP.", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "samlLocalLogout", - "consumes" : [ "*/*" ], - "produces" : [ "*/*" ], - "responses" : { - "default" : { - "description" : "successful operation" - } - } - } - }, - "/access/saml/login/consumer" : { - "get" : { - "tags" : [ "accesssaml" ], - "summary" : "Processes the SSO response from the SAML identity provider for HTTP-REDIRECT binding.", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "samlLoginHttpRedirectConsumer", - "consumes" : [ "*/*" ], - "produces" : [ "*/*" ], - "responses" : { - "default" : { - "description" : "successful operation" - } - } - }, - "post" : { - "tags" : [ "accesssaml" ], - "summary" : "Processes the SSO response from the SAML identity provider for HTTP-POST binding.", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "samlLoginHttpPostConsumer", - "consumes" : [ "application/x-www-form-urlencoded" ], - "produces" : [ "*/*" ], - "responses" : { - "default" : { - "description" : "successful operation" - } - } - } - }, - "/access/saml/login/exchange" : { - "post" : { - "tags" : [ "accesssaml" ], - "summary" : "Retrieves a JWT following a successful login sequence using the configured SAML identity provider.", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "samlLoginExchange", - "consumes" : [ "*/*" ], - "produces" : [ "text/plain" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - } - } - } - }, - "/access/saml/login/request" : { - "get" : { - "tags" : [ "accesssaml" ], - "summary" : "Initiates an SSO request to the configured SAML identity provider.", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "samlLoginRequest", - "consumes" : [ "*/*" ], - "produces" : [ "*/*" ], - "responses" : { - "default" : { - "description" : "successful operation" - } - } - } - }, - "/access/saml/metadata" : { - "get" : { - "tags" : [ "accesssaml" ], - "summary" : "Retrieves the service provider metadata.", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "samlMetadata", - "consumes" : [ "*/*" ], - "produces" : [ "application/samlmetadata+xml" ], - "responses" : { - "default" : { - "description" : "successful operation" - } - } - } - }, - "/access/saml/single-logout/consumer" : { - "get" : { - "tags" : [ "accesssaml" ], - "summary" : "Processes a SingleLogout message from the configured SAML identity provider using the HTTP-REDIRECT binding.", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "samlSingleLogoutHttpRedirectConsumer", - "consumes" : [ "*/*" ], - "produces" : [ "*/*" ], - "responses" : { - "default" : { - "description" : "successful operation" - } - } - }, - "post" : { - "tags" : [ "accesssaml" ], - "summary" : "Processes a SingleLogout message from the configured SAML identity provider using the HTTP-POST binding.", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "samlSingleLogoutHttpPostConsumer", - "consumes" : [ "*/*" ], - "produces" : [ "*/*" ], - "responses" : { - "default" : { - "description" : "successful operation" - } - } - } - }, - "/access/saml/single-logout/request" : { - "get" : { - "tags" : [ "accesssaml" ], - "summary" : "Initiates a logout request using the SingleLogout service of the configured SAML identity provider.", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "samlSingleLogoutRequest", - "consumes" : [ "*/*" ], - "produces" : [ "*/*" ], - "responses" : { - "default" : { - "description" : "successful operation" - } - } - } - }, - "/access/token" : { - "post" : { - "tags" : [ "access" ], - "summary" : "Creates a token for accessing the REST API via username/password", - "description" : "The token returned is formatted as a JSON Web Token (JWT). The token is base64 encoded and comprised of three parts. The header, the body, and the signature. The expiration of the token is a contained within the body. 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", - "consumes" : [ "application/x-www-form-urlencoded" ], - "produces" : [ "text/plain" ], - "parameters" : [ { - "name" : "username", - "in" : "formData", - "required" : false, - "type" : "string" - }, { - "name" : "password", - "in" : "formData", - "required" : false, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "Unable to create access token because NiFi is not in the appropriate state. (i.e. may not be configured to support username/password login." - }, - "500" : { - "description" : "Unable to create access token because an unexpected error occurred." - } - } - } - }, - "/connections/{id}" : { - "get" : { - "tags" : [ "connections" ], - "summary" : "Gets a connection", - "description" : "", - "operationId" : "getConnection", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The connection id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ConnectionEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read Source - /{component-type}/{uuid}" : [ ] - }, { - "Read Destination - /{component-type}/{uuid}" : [ ] - } ] - }, - "put" : { - "tags" : [ "connections" ], - "summary" : "Updates a connection", - "description" : "", - "operationId" : "updateConnection", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The connection id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The connection configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ConnectionEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ConnectionEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write Source - /{component-type}/{uuid}" : [ ] - }, { - "Write Destination - /{component-type}/{uuid}" : [ ] - }, { - "Write New Destination - /{component-type}/{uuid} - if updating Destination" : [ ] - }, { - "Write Process Group - /process-groups/{uuid} - if updating Destination" : [ ] - } ] - }, - "delete" : { - "tags" : [ "connections" ], - "summary" : "Deletes a connection", - "description" : "", - "operationId" : "deleteConnection", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The revision is used to verify the client is working with the latest version of the flow.", - "required" : false, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The connection id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ConnectionEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write Source - /{component-type}/{uuid}" : [ ] - }, { - "Write - Parent Process Group - /process-groups/{uuid}" : [ ] - }, { - "Write Destination - /{component-type}/{uuid}" : [ ] - } ] - } - }, - "/controller-services/{id}" : { - "get" : { - "tags" : [ "controller-services" ], - "summary" : "Gets a controller service", - "description" : "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", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The controller service id.", - "required" : true, - "type" : "string" - }, { - "name" : "uiOnly", - "in" : "query", - "required" : false, - "type" : "boolean", - "default" : false - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ControllerServiceEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /controller-services/{uuid}" : [ ] - } ] - }, - "put" : { - "tags" : [ "controller-services" ], - "summary" : "Updates a controller service", - "description" : "", - "operationId" : "updateControllerService", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The controller service id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The controller service configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ControllerServiceEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ControllerServiceEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /controller-services/{uuid}" : [ ] - }, { - "Read - any referenced Controller Services if this request changes the reference - /controller-services/{uuid}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "controller-services" ], - "summary" : "Deletes a controller service", - "description" : "", - "operationId" : "removeControllerService", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The revision is used to verify the client is working with the latest version of the flow.", - "required" : false, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The controller service id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ControllerServiceEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /controller-services/{uuid}" : [ ] - }, { - "Write - Parent Process Group if scoped by Process Group - /process-groups/{uuid}" : [ ] - }, { - "Write - Controller if scoped by Controller - /controller" : [ ] - }, { - "Read - any referenced Controller Services - /controller-services/{uuid}" : [ ] - } ] - } - }, - "/controller-services/{id}/config/analysis" : { - "post" : { - "tags" : [ "controller-services" ], - "summary" : "Performs analysis of the component's configuration, providing information about which attributes are referenced.", - "description" : "", - "operationId" : "analyzeConfiguration", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The controller service id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The configuration analysis request.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ConfigurationAnalysisEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/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. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /controller-services/{uuid}" : [ ] - } ] - } - }, - "/controller-services/{id}/config/verification-requests" : { - "post" : { - "tags" : [ "controller-services" ], - "summary" : "Performs verification of the Controller Service's configuration", - "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", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The controller service id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The controller service configuration verification request.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/VerifyConfigRequestEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/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. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /controller-services/{uuid}" : [ ] - } ] - } - }, - "/controller-services/{id}/config/verification-requests/{requestId}" : { - "get" : { - "tags" : [ "controller-services" ], - "summary" : "Returns the Verification Request with the given ID", - "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", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The ID of the Controller Service", - "required" : true, - "type" : "string" - }, { - "name" : "requestId", - "in" : "path", - "description" : "The ID of the Verification Request", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/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. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Only the user that submitted the request can get it" : [ ] - } ] - }, - "delete" : { - "tags" : [ "controller-services" ], - "summary" : "Deletes the Verification Request with the given ID", - "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" : "deleteValidationRequest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The ID of the Controller Service", - "required" : true, - "type" : "string" - }, { - "name" : "requestId", - "in" : "path", - "description" : "The ID of the Verification Request", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/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. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Only the user that submitted the request can remove it" : [ ] - } ] - } - }, - "/controller-services/{id}/descriptors" : { - "get" : { - "tags" : [ "controller-services" ], - "summary" : "Gets a controller service property descriptor", - "description" : "", - "operationId" : "getPropertyDescriptor", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The controller service id.", - "required" : true, - "type" : "string" - }, { - "name" : "propertyName", - "in" : "query", - "description" : "The property name to return the descriptor for.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/PropertyDescriptorEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /controller-services/{uuid}" : [ ] - } ] - } - }, - "/controller-services/{id}/references" : { - "get" : { - "tags" : [ "controller-services" ], - "summary" : "Gets a controller service", - "description" : "", - "operationId" : "getControllerServiceReferences", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The controller service id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ControllerServiceReferencingComponentsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /controller-services/{uuid}" : [ ] - } ] - }, - "put" : { - "tags" : [ "controller-services" ], - "summary" : "Updates a controller services references", - "description" : "", - "operationId" : "updateControllerServiceReferences", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The controller service id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The controller service request update request.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/UpdateControllerServiceReferenceRequestEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ControllerServiceReferencingComponentsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /{component-type}/{uuid} or /operate/{component-type}/{uuid} - For each referencing component specified" : [ ] - } ] - } - }, - "/controller-services/{id}/run-status" : { - "put" : { - "tags" : [ "controller-services" ], - "summary" : "Updates run status of a controller service", - "description" : "", - "operationId" : "updateRunStatus", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The controller service id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The controller service run status.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ControllerServiceRunStatusEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ControllerServiceEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /controller-services/{uuid} or /operation/controller-services/{uuid}" : [ ] - } ] - } - }, - "/controller-services/{id}/state" : { - "get" : { - "tags" : [ "controller-services" ], - "summary" : "Gets the state for a controller service", - "description" : "", - "operationId" : "getState", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The controller service id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ComponentStateEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /controller-services/{uuid}" : [ ] - } ] - } - }, - "/controller-services/{id}/state/clear-requests" : { - "post" : { - "tags" : [ "controller-services" ], - "summary" : "Clears the state for a controller service", - "description" : "", - "operationId" : "clearState", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The controller service id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ComponentStateEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /controller-services/{uuid}" : [ ] - } ] - } - }, - "/controller/bulletin" : { - "post" : { - "tags" : [ "controller" ], - "summary" : "Creates a new bulletin", - "description" : "", - "operationId" : "createBulletin", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The reporting task configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/BulletinEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /controller" : [ ] - } ] - } - }, - "/controller/cluster" : { - "get" : { - "tags" : [ "controller" ], - "summary" : "Gets the contents of the cluster", - "description" : "Returns the contents of the cluster including all nodes and their status.", - "operationId" : "getCluster", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ClusterEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /controller" : [ ] - } ] - } - }, - "/controller/cluster/nodes/{id}" : { - "get" : { - "tags" : [ "controller" ], - "summary" : "Gets a node in the cluster", - "description" : "", - "operationId" : "getNode", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The node id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/NodeEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /controller" : [ ] - } ] - }, - "put" : { - "tags" : [ "controller" ], - "summary" : "Updates a node in the cluster", - "description" : "", - "operationId" : "updateNode", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The node id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The node configuration. The only configuration that will be honored at this endpoint is the status.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/NodeEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/NodeEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /controller" : [ ] - } ] - }, - "delete" : { - "tags" : [ "controller" ], - "summary" : "Removes a node from the cluster", - "description" : "", - "operationId" : "deleteNode", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The node id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/NodeEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /controller" : [ ] - } ] - } - }, - "/controller/config" : { - "get" : { - "tags" : [ "controller" ], - "summary" : "Retrieves the configuration for this NiFi Controller", - "description" : "", - "operationId" : "getControllerConfig", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ControllerConfigurationEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /controller" : [ ] - } ] - }, - "put" : { - "tags" : [ "controller" ], - "summary" : "Retrieves the configuration for this NiFi", - "description" : "", - "operationId" : "updateControllerConfig", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The controller configuration.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ControllerConfigurationEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ControllerConfigurationEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /controller" : [ ] - } ] - } - }, - "/controller/controller-services" : { - "post" : { - "tags" : [ "controller" ], - "summary" : "Creates a new controller service", - "description" : "", - "operationId" : "createControllerService", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The controller service configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ControllerServiceEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ControllerServiceEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /controller" : [ ] - }, { - "Read - any referenced Controller Services - /controller-services/{uuid}" : [ ] - }, { - "Write - if the Controller Service is restricted - /restricted-components" : [ ] - } ] - } - }, - "/controller/history" : { - "delete" : { - "tags" : [ "controller" ], - "summary" : "Purges history", - "description" : "", - "operationId" : "deleteHistory", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "endDate", - "in" : "query", - "description" : "Purge actions before this date/time.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/HistoryEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /controller" : [ ] - } ] - } - }, - "/controller/registry-clients" : { - "get" : { - "tags" : [ "controller" ], - "summary" : "Gets the listing of available registry clients", - "description" : "", - "operationId" : "getRegistryClients", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/RegistryClientsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - }, - "post" : { - "tags" : [ "controller" ], - "summary" : "Creates a new registry client", - "description" : "", - "operationId" : "createRegistryClient", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The registry configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/RegistryClientEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/RegistryClientEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /controller" : [ ] - } ] - } - }, - "/controller/registry-clients/{id}" : { - "get" : { - "tags" : [ "controller" ], - "summary" : "Gets a registry client", - "description" : "", - "operationId" : "getRegistryClient", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The registry id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/RegistryClientEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /controller" : [ ] - } ] - }, - "put" : { - "tags" : [ "controller" ], - "summary" : "Updates a registry client", - "description" : "", - "operationId" : "updateRegistryClient", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The registry id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The registry configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/RegistryClientEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/RegistryClientEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /controller" : [ ] - } ] - }, - "delete" : { - "tags" : [ "controller" ], - "summary" : "Deletes a registry client", - "description" : "", - "operationId" : "deleteRegistryClient", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The revision is used to verify the client is working with the latest version of the flow.", - "required" : false, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The registry id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/RegistryClientEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /controller" : [ ] - } ] - } - }, - "/controller/reporting-tasks" : { - "post" : { - "tags" : [ "controller" ], - "summary" : "Creates a new reporting task", - "description" : "", - "operationId" : "createReportingTask", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The reporting task configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ReportingTaskEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ReportingTaskEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /controller" : [ ] - }, { - "Read - any referenced Controller Services - /controller-services/{uuid}" : [ ] - }, { - "Write - if the Reporting Task is restricted - /restricted-components" : [ ] - } ] - } - }, - "/controller/status/history" : { - "get" : { - "tags" : [ "controller" ], - "summary" : "Gets status history for the node", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getNodeStatusHistory", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ComponentHistoryEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /controller" : [ ] - } ] - } - }, - "/counters" : { - "get" : { - "tags" : [ "counters" ], - "summary" : "Gets the current counters for this NiFi", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getCounters", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "nodewise", - "in" : "query", - "description" : "Whether or not to include the breakdown per node. Optional, defaults to false", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "clusterNodeId", - "in" : "query", - "description" : "The id of the node where to get the status.", - "required" : false, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/CountersEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /counters" : [ ] - } ] - } - }, - "/counters/{id}" : { - "put" : { - "tags" : [ "counters" ], - "summary" : "Updates the specified counter. This will reset the counter value to 0", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "updateCounter", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The id of the counter.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/CounterEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /counters" : [ ] - } ] - } - }, - "/data-transfer/input-ports/{portId}/transactions/{transactionId}" : { - "put" : { - "tags" : [ "data-transfer" ], - "summary" : "Extend transaction TTL", - "description" : "", - "operationId" : "extendInputPortTransactionTTL", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "portId", - "in" : "path", - "required" : true, - "type" : "string" - }, { - "name" : "transactionId", - "in" : "path", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/TransactionResultEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /data-transfer/input-ports/{uuid}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "data-transfer" ], - "summary" : "Commit or cancel the specified transaction", - "description" : "", - "operationId" : "commitInputPortTransaction", - "consumes" : [ "application/octet-stream" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "responseCode", - "in" : "query", - "description" : "The response code. Available values are BAD_CHECKSUM(19), CONFIRM_TRANSACTION(12) or CANCEL_TRANSACTION(15).", - "required" : true, - "type" : "integer", - "format" : "int32" - }, { - "name" : "portId", - "in" : "path", - "description" : "The input port id.", - "required" : true, - "type" : "string" - }, { - "name" : "transactionId", - "in" : "path", - "description" : "The transaction id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/TransactionResultEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - }, - "503" : { - "description" : "NiFi instance is not ready for serving request, or temporarily overloaded. Retrying the same request later may be successful" - } - }, - "security" : [ { - "Write - /data-transfer/input-ports/{uuid}" : [ ] - } ] - } - }, - "/data-transfer/input-ports/{portId}/transactions/{transactionId}/flow-files" : { - "post" : { - "tags" : [ "data-transfer" ], - "summary" : "Transfer flow files to the input port", - "description" : "", - "operationId" : "receiveFlowFiles", - "consumes" : [ "application/octet-stream" ], - "produces" : [ "text/plain" ], - "parameters" : [ { - "name" : "portId", - "in" : "path", - "description" : "The input port id.", - "required" : true, - "type" : "string" - }, { - "name" : "transactionId", - "in" : "path", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - }, - "503" : { - "description" : "NiFi instance is not ready for serving request, or temporarily overloaded. Retrying the same request later may be successful" - } - }, - "security" : [ { - "Write - /data-transfer/input-ports/{uuid}" : [ ] - } ] - } - }, - "/data-transfer/output-ports/{portId}/transactions/{transactionId}" : { - "put" : { - "tags" : [ "data-transfer" ], - "summary" : "Extend transaction TTL", - "description" : "", - "operationId" : "extendOutputPortTransactionTTL", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "portId", - "in" : "path", - "required" : true, - "type" : "string" - }, { - "name" : "transactionId", - "in" : "path", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/TransactionResultEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - }, - "503" : { - "description" : "NiFi instance is not ready for serving request, or temporarily overloaded. Retrying the same request later may be successful" - } - }, - "security" : [ { - "Write - /data-transfer/output-ports/{uuid}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "data-transfer" ], - "summary" : "Commit or cancel the specified transaction", - "description" : "", - "operationId" : "commitOutputPortTransaction", - "consumes" : [ "application/octet-stream" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "responseCode", - "in" : "query", - "description" : "The response code. Available values are CONFIRM_TRANSACTION(12) or CANCEL_TRANSACTION(15).", - "required" : true, - "type" : "integer", - "format" : "int32" - }, { - "name" : "checksum", - "in" : "query", - "description" : "A checksum calculated at client side using CRC32 to check flow file content integrity. It must match with the value calculated at server side.", - "required" : true, - "type" : "string" - }, { - "name" : "portId", - "in" : "path", - "description" : "The output port id.", - "required" : true, - "type" : "string" - }, { - "name" : "transactionId", - "in" : "path", - "description" : "The transaction id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/TransactionResultEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - }, - "503" : { - "description" : "NiFi instance is not ready for serving request, or temporarily overloaded. Retrying the same request later may be successful" - } - }, - "security" : [ { - "Write - /data-transfer/output-ports/{uuid}" : [ ] - } ] - } - }, - "/data-transfer/output-ports/{portId}/transactions/{transactionId}/flow-files" : { - "get" : { - "tags" : [ "data-transfer" ], - "summary" : "Transfer flow files from the output port", - "description" : "", - "operationId" : "transferFlowFiles", - "consumes" : [ "*/*" ], - "produces" : [ "application/octet-stream" ], - "parameters" : [ { - "name" : "portId", - "in" : "path", - "description" : "The output port id.", - "required" : true, - "type" : "string" - }, { - "name" : "transactionId", - "in" : "path", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "There is no flow file to return.", - "schema" : { - "$ref" : "#/definitions/StreamingOutput" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - }, - "503" : { - "description" : "NiFi instance is not ready for serving request, or temporarily overloaded. Retrying the same request later may be successful" - } - }, - "security" : [ { - "Write - /data-transfer/output-ports/{uuid}" : [ ] - } ] - } - }, - "/data-transfer/{portType}/{portId}/transactions" : { - "post" : { - "tags" : [ "data-transfer" ], - "summary" : "Create a transaction to the specified output port or input port", - "description" : "", - "operationId" : "createPortTransaction", - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "portType", - "in" : "path", - "description" : "The port type.", - "required" : true, - "type" : "string", - "enum" : [ "input-ports", "output-ports" ] - }, { - "name" : "portId", - "in" : "path", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/TransactionResultEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - }, - "503" : { - "description" : "NiFi instance is not ready for serving request, or temporarily overloaded. Retrying the same request later may be successful" - } - }, - "security" : [ { - "Write - /data-transfer/{component-type}/{uuid}" : [ ] - } ] - } - }, - "/flow/about" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Retrieves details about this NiFi to put in the About dialog", - "description" : "", - "operationId" : "getAboutInfo", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/AboutEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/banners" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Retrieves the banners for this NiFi", - "description" : "", - "operationId" : "getBanners", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/BannerEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/bulletin-board" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets current bulletins", - "description" : "", - "operationId" : "getBulletinBoard", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "after", - "in" : "query", - "description" : "Includes bulletins with an id after this value.", - "required" : false, - "type" : "string" - }, { - "name" : "sourceName", - "in" : "query", - "description" : "Includes bulletins originating from this sources whose name match this regular expression.", - "required" : false, - "type" : "string" - }, { - "name" : "message", - "in" : "query", - "description" : "Includes bulletins whose message that match this regular expression.", - "required" : false, - "type" : "string" - }, { - "name" : "sourceId", - "in" : "query", - "description" : "Includes bulletins originating from this sources whose id match this regular expression.", - "required" : false, - "type" : "string" - }, { - "name" : "groupId", - "in" : "query", - "description" : "Includes bulletins originating from this sources whose group id match this regular expression.", - "required" : false, - "type" : "string" - }, { - "name" : "limit", - "in" : "query", - "description" : "The number of bulletins to limit the response to.", - "required" : false, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/BulletinBoardEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - }, { - "Read - /{component-type}/{uuid} - For component specific bulletins" : [ ] - } ] - } - }, - "/flow/client-id" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Generates a client id.", - "description" : "", - "operationId" : "generateClientId", - "consumes" : [ "*/*" ], - "produces" : [ "text/plain" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/cluster/search-results" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Searches the cluster for a node with the specified address", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "searchCluster", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "q", - "in" : "query", - "description" : "Node address to search for.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ClusterSearchResultsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/cluster/summary" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "The cluster summary for this NiFi", - "description" : "", - "operationId" : "getClusterSummary", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ClusteSummaryEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/config" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Retrieves the configuration for this NiFi flow", - "description" : "", - "operationId" : "getFlowConfig", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/FlowConfigurationEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/connections/{id}/statistics" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets statistics for a connection", - "description" : "", - "operationId" : "getConnectionStatistics", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "nodewise", - "in" : "query", - "description" : "Whether or not to include the breakdown per node. Optional, defaults to false", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "clusterNodeId", - "in" : "query", - "description" : "The id of the node where to get the statistics.", - "required" : false, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The connection id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ConnectionStatisticsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/connections/{id}/status" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets status for a connection", - "description" : "", - "operationId" : "getConnectionStatus", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "nodewise", - "in" : "query", - "description" : "Whether or not to include the breakdown per node. Optional, defaults to false", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "clusterNodeId", - "in" : "query", - "description" : "The id of the node where to get the status.", - "required" : false, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The connection id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ConnectionStatusEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/connections/{id}/status/history" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets the status history for a connection", - "description" : "", - "operationId" : "getConnectionStatusHistory", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The connection id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/StatusHistoryEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/controller-service-types" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Retrieves the types of controller services that this NiFi supports", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getControllerServiceTypes", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "serviceType", - "in" : "query", - "description" : "If specified, will only return controller services that are compatible with this type of service.", - "required" : false, - "type" : "string" - }, { - "name" : "serviceBundleGroup", - "in" : "query", - "description" : "If serviceType specified, is the bundle group of the serviceType.", - "required" : false, - "type" : "string" - }, { - "name" : "serviceBundleArtifact", - "in" : "query", - "description" : "If serviceType specified, is the bundle artifact of the serviceType.", - "required" : false, - "type" : "string" - }, { - "name" : "serviceBundleVersion", - "in" : "query", - "description" : "If serviceType specified, is the bundle version of the serviceType.", - "required" : false, - "type" : "string" - }, { - "name" : "bundleGroupFilter", - "in" : "query", - "description" : "If specified, will only return types that are a member of this bundle group.", - "required" : false, - "type" : "string" - }, { - "name" : "bundleArtifactFilter", - "in" : "query", - "description" : "If specified, will only return types that are a member of this bundle artifact.", - "required" : false, - "type" : "string" - }, { - "name" : "typeFilter", - "in" : "query", - "description" : "If specified, will only return types whose fully qualified classname matches.", - "required" : false, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ControllerServiceTypesEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/controller/bulletins" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Retrieves Controller level bulletins", - "description" : "", - "operationId" : "getBulletins", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ControllerBulletinsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - }, { - "Read - /controller - For controller bulletins" : [ ] - }, { - "Read - /controller-services/{uuid} - For controller service bulletins" : [ ] - }, { - "Read - /reporting-tasks/{uuid} - For reporting task bulletins" : [ ] - } ] - } - }, - "/flow/controller/controller-services" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets controller services for reporting tasks", - "description" : "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", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "uiOnly", - "in" : "query", - "required" : false, - "type" : "boolean", - "default" : false - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ControllerServicesEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/current-user" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Retrieves the user identity of the user making the request", - "description" : "", - "operationId" : "getCurrentUser", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/CurrentUserEntity" - } - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/history" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets configuration history", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "queryHistory", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "offset", - "in" : "query", - "description" : "The offset into the result set.", - "required" : true, - "type" : "string" - }, { - "name" : "count", - "in" : "query", - "description" : "The number of actions to return.", - "required" : true, - "type" : "string" - }, { - "name" : "sortColumn", - "in" : "query", - "description" : "The field to sort on.", - "required" : false, - "type" : "string" - }, { - "name" : "sortOrder", - "in" : "query", - "description" : "The direction to sort.", - "required" : false, - "type" : "string" - }, { - "name" : "startDate", - "in" : "query", - "description" : "Include actions after this date.", - "required" : false, - "type" : "string" - }, { - "name" : "endDate", - "in" : "query", - "description" : "Include actions before this date.", - "required" : false, - "type" : "string" - }, { - "name" : "userIdentity", - "in" : "query", - "description" : "Include actions performed by this user.", - "required" : false, - "type" : "string" - }, { - "name" : "sourceId", - "in" : "query", - "description" : "Include actions on this component.", - "required" : false, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/HistoryEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/history/components/{componentId}" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets configuration history for a component", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getComponentHistory", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "componentId", - "in" : "path", - "description" : "The component id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ComponentHistoryEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - }, { - "Read underlying component - /{component-type}/{uuid}" : [ ] - } ] - } - }, - "/flow/history/{id}" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets an action", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getAction", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The action id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ActionEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/input-ports/{id}/status" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets status for an input port", - "description" : "", - "operationId" : "getInputPortStatus", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "nodewise", - "in" : "query", - "description" : "Whether or not to include the breakdown per node. Optional, defaults to false", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "clusterNodeId", - "in" : "query", - "description" : "The id of the node where to get the status.", - "required" : false, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The input port id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/PortStatusEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/metrics/{producer}" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets all metrics for the flow from a particular node", - "description" : "", - "operationId" : "getFlowMetrics", - "consumes" : [ "*/*" ], - "produces" : [ "*/*" ], - "parameters" : [ { - "name" : "producer", - "in" : "path", - "description" : "The producer for flow file metrics. Each producer may have its own output format.", - "required" : true, - "type" : "string", - "enum" : [ "prometheus" ] - }, { - "name" : "includedRegistries", - "in" : "query", - "description" : "Set of included metrics registries", - "required" : false, - "type" : "array", - "items" : { - "type" : "string", - "enum" : [ "NIFI", "JVM", "BULLETIN", "CONNECTION" ] - }, - "collectionFormat" : "multi" - }, { - "name" : "sampleName", - "in" : "query", - "description" : "Regular Expression Pattern to be applied against the sample name field", - "required" : false, - "type" : "string" - }, { - "name" : "sampleLabelValue", - "in" : "query", - "description" : "Regular Expression Pattern to be applied against the sample label value field", - "required" : false, - "type" : "string" - }, { - "name" : "rootFieldName", - "in" : "query", - "description" : "Name of the first field of JSON object. Applicable for JSON producer only.", - "required" : false, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/StreamingOutput" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/output-ports/{id}/status" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets status for an output port", - "description" : "", - "operationId" : "getOutputPortStatus", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "nodewise", - "in" : "query", - "description" : "Whether or not to include the breakdown per node. Optional, defaults to false", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "clusterNodeId", - "in" : "query", - "description" : "The id of the node where to get the status.", - "required" : false, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The output port id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/PortStatusEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/parameter-contexts" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets all Parameter Contexts", - "description" : "", - "operationId" : "getParameterContexts", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ParameterContextsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /parameter-contexts/{id} for each Parameter Context" : [ ] - } ] - } - }, - "/flow/prioritizers" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Retrieves the types of prioritizers that this NiFi supports", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getPrioritizers", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/PrioritizerTypesEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/process-groups/{id}" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets a process group", - "description" : "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", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "name" : "uiOnly", - "in" : "query", - "required" : false, - "type" : "boolean", - "default" : false - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessGroupFlowEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - }, - "put" : { - "tags" : [ "flow" ], - "summary" : "Schedule or unschedule components in the specified Process Group.", - "description" : "", - "operationId" : "scheduleComponents", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The request to schedule or unschedule. If the comopnents in the request are not specified, all authorized components will be considered.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ScheduleComponentsEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ScheduleComponentsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - }, { - "Write - /{component-type}/{uuid} or /operation/{component-type}/{uuid} - For every component being scheduled/unscheduled" : [ ] - } ] - } - }, - "/flow/process-groups/{id}/controller-services" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets all controller services", - "description" : "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", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "name" : "includeAncestorGroups", - "in" : "query", - "description" : "Whether or not to include parent/ancestory process groups", - "required" : false, - "type" : "boolean", - "default" : true - }, { - "name" : "includeDescendantGroups", - "in" : "query", - "description" : "Whether or not to include descendant process groups", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "uiOnly", - "in" : "query", - "required" : false, - "type" : "boolean", - "default" : false - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ControllerServicesEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - }, - "put" : { - "tags" : [ "flow" ], - "summary" : "Enable or disable Controller Services in the specified Process Group.", - "description" : "", - "operationId" : "activateControllerServices", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The request to schedule or unschedule. If the comopnents in the request are not specified, all authorized components will be considered.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ActivateControllerServicesEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ActivateControllerServicesEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - }, { - "Write - /{component-type}/{uuid} or /operation/{component-type}/{uuid} - For every service being enabled/disabled" : [ ] - } ] - } - }, - "/flow/process-groups/{id}/status" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets the status for a process group", - "description" : "The status for a process group includes status for all descendent components. When invoked on the root group with recursive set to true, it will return the current status of every component in the flow.", - "operationId" : "getProcessGroupStatus", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "recursive", - "in" : "query", - "description" : "Whether all descendant groups and the status of their content will be included. Optional, defaults to false", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "nodewise", - "in" : "query", - "description" : "Whether or not to include the breakdown per node. Optional, defaults to false", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "clusterNodeId", - "in" : "query", - "description" : "The id of the node where to get the status.", - "required" : false, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessGroupStatusEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/process-groups/{id}/status/history" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets status history for a remote process group", - "description" : "", - "operationId" : "getProcessGroupStatusHistory", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/StatusHistoryEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/processor-types" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Retrieves the types of processors that this NiFi supports", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getProcessorTypes", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bundleGroupFilter", - "in" : "query", - "description" : "If specified, will only return types that are a member of this bundle group.", - "required" : false, - "type" : "string" - }, { - "name" : "bundleArtifactFilter", - "in" : "query", - "description" : "If specified, will only return types that are a member of this bundle artifact.", - "required" : false, - "type" : "string" - }, { - "name" : "type", - "in" : "query", - "description" : "If specified, will only return types whose fully qualified classname matches.", - "required" : false, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessorTypesEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/processors/{id}/status" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets status for a processor", - "description" : "", - "operationId" : "getProcessorStatus", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "nodewise", - "in" : "query", - "description" : "Whether or not to include the breakdown per node. Optional, defaults to false", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "clusterNodeId", - "in" : "query", - "description" : "The id of the node where to get the status.", - "required" : false, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The processor id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessorStatusEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/processors/{id}/status/history" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets status history for a processor", - "description" : "", - "operationId" : "getProcessorStatusHistory", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The processor id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/StatusHistoryEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/registries" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets the listing of available registries", - "description" : "", - "operationId" : "getRegistries", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/RegistryClientsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/registries/{id}/buckets" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets the buckets from the specified registry for the current user", - "description" : "", - "operationId" : "getBuckets", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The registry id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/BucketsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/registries/{registry-id}/buckets/{bucket-id}/flows" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets the flows from the specified registry and bucket for the current user", - "description" : "", - "operationId" : "getFlows", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "registry-id", - "in" : "path", - "description" : "The registry id.", - "required" : true, - "type" : "string" - }, { - "name" : "bucket-id", - "in" : "path", - "description" : "The bucket id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlowsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/registries/{registry-id}/buckets/{bucket-id}/flows/{flow-id}/versions" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets the flow versions from the specified registry and bucket for the specified flow for the current user", - "description" : "", - "operationId" : "getVersions", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "registry-id", - "in" : "path", - "description" : "The registry id.", - "required" : true, - "type" : "string" - }, { - "name" : "bucket-id", - "in" : "path", - "description" : "The bucket id.", - "required" : true, - "type" : "string" - }, { - "name" : "flow-id", - "in" : "path", - "description" : "The flow id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlowSnapshotMetadataSetEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/remote-process-groups/{id}/status" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets status for a remote process group", - "description" : "", - "operationId" : "getRemoteProcessGroupStatus", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "nodewise", - "in" : "query", - "description" : "Whether or not to include the breakdown per node. Optional, defaults to false", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "clusterNodeId", - "in" : "query", - "description" : "The id of the node where to get the status.", - "required" : false, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The remote process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/RemoteProcessGroupStatusEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/remote-process-groups/{id}/status/history" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets the status history", - "description" : "", - "operationId" : "getRemoteProcessGroupStatusHistory", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The remote process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/StatusHistoryEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/reporting-task-types" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Retrieves the types of reporting tasks that this NiFi supports", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getReportingTaskTypes", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bundleGroupFilter", - "in" : "query", - "description" : "If specified, will only return types that are a member of this bundle group.", - "required" : false, - "type" : "string" - }, { - "name" : "bundleArtifactFilter", - "in" : "query", - "description" : "If specified, will only return types that are a member of this bundle artifact.", - "required" : false, - "type" : "string" - }, { - "name" : "type", - "in" : "query", - "description" : "If specified, will only return types whose fully qualified classname matches.", - "required" : false, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ReportingTaskTypesEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/reporting-tasks" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets all reporting tasks", - "description" : "", - "operationId" : "getReportingTasks", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ReportingTasksEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/runtime-manifest" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Retrieves the runtime manifest for this NiFi instance.", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getRuntimeManifest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/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. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/search-results" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Performs a search against this NiFi using the specified search term", - "description" : "Only search results from authorized components will be returned.", - "operationId" : "searchFlow", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "q", - "in" : "query", - "required" : false, - "type" : "string" - }, { - "name" : "a", - "in" : "query", - "required" : false, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/SearchResultsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/status" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets the current status of this NiFi", - "description" : "", - "operationId" : "getControllerStatus", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ControllerStatusEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/templates" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets all templates", - "description" : "", - "operationId" : "getTemplates", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/TemplatesEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flowfile-queues/{id}/drop-requests" : { - "post" : { - "tags" : [ "flowfile-queues" ], - "summary" : "Creates a request to drop the contents of the queue in this connection.", - "description" : "", - "operationId" : "createDropRequest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The connection id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/DropRequestEntity" - } - }, - "202" : { - "description" : "The request has been accepted. A HTTP response header will contain the URI where the response can be polled." - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write Source Data - /data/{component-type}/{uuid}" : [ ] - } ] - } - }, - "/flowfile-queues/{id}/drop-requests/{drop-request-id}" : { - "get" : { - "tags" : [ "flowfile-queues" ], - "summary" : "Gets the current status of a drop request for the specified connection.", - "description" : "", - "operationId" : "getDropRequest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The connection id.", - "required" : true, - "type" : "string" - }, { - "name" : "drop-request-id", - "in" : "path", - "description" : "The drop request id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/DropRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write Source Data - /data/{component-type}/{uuid}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "flowfile-queues" ], - "summary" : "Cancels and/or removes a request to drop the contents of this connection.", - "description" : "", - "operationId" : "removeDropRequest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The connection id.", - "required" : true, - "type" : "string" - }, { - "name" : "drop-request-id", - "in" : "path", - "description" : "The drop request id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/DropRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write Source Data - /data/{component-type}/{uuid}" : [ ] - } ] - } - }, - "/flowfile-queues/{id}/flowfiles/{flowfile-uuid}" : { - "get" : { - "tags" : [ "flowfile-queues" ], - "summary" : "Gets a FlowFile from a Connection.", - "description" : "", - "operationId" : "getFlowFile", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The connection id.", - "required" : true, - "type" : "string" - }, { - "name" : "flowfile-uuid", - "in" : "path", - "description" : "The flowfile uuid.", - "required" : true, - "type" : "string" - }, { - "name" : "clusterNodeId", - "in" : "query", - "description" : "The id of the node where the content exists if clustered.", - "required" : false, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/FlowFileEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read Source Data - /data/{component-type}/{uuid}" : [ ] - } ] - } - }, - "/flowfile-queues/{id}/flowfiles/{flowfile-uuid}/content" : { - "get" : { - "tags" : [ "flowfile-queues" ], - "summary" : "Gets the content for a FlowFile in a Connection.", - "description" : "", - "operationId" : "downloadFlowFileContent", - "consumes" : [ "*/*" ], - "produces" : [ "*/*" ], - "parameters" : [ { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The connection id.", - "required" : true, - "type" : "string" - }, { - "name" : "flowfile-uuid", - "in" : "path", - "description" : "The flowfile uuid.", - "required" : true, - "type" : "string" - }, { - "name" : "clusterNodeId", - "in" : "query", - "description" : "The id of the node where the content exists if clustered.", - "required" : false, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/StreamingOutput" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read Source Data - /data/{component-type}/{uuid}" : [ ] - } ] - } - }, - "/flowfile-queues/{id}/listing-requests" : { - "post" : { - "tags" : [ "flowfile-queues" ], - "summary" : "Lists the contents of the queue in this connection.", - "description" : "", - "operationId" : "createFlowFileListing", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The connection id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ListingRequestEntity" - } - }, - "202" : { - "description" : "The request has been accepted. A HTTP response header will contain the URI where the response can be polled." - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read Source Data - /data/{component-type}/{uuid}" : [ ] - } ] - } - }, - "/flowfile-queues/{id}/listing-requests/{listing-request-id}" : { - "get" : { - "tags" : [ "flowfile-queues" ], - "summary" : "Gets the current status of a listing request for the specified connection.", - "description" : "", - "operationId" : "getListingRequest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The connection id.", - "required" : true, - "type" : "string" - }, { - "name" : "listing-request-id", - "in" : "path", - "description" : "The listing request id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ListingRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read Source Data - /data/{component-type}/{uuid}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "flowfile-queues" ], - "summary" : "Cancels and/or removes a request to list the contents of this connection.", - "description" : "", - "operationId" : "deleteListingRequest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The connection id.", - "required" : true, - "type" : "string" - }, { - "name" : "listing-request-id", - "in" : "path", - "description" : "The listing request id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ListingRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read Source Data - /data/{component-type}/{uuid}" : [ ] - } ] - } - }, - "/funnels/{id}" : { - "get" : { - "tags" : [ "funnel" ], - "summary" : "Gets a funnel", - "description" : "", - "operationId" : "getFunnel", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The funnel id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/FunnelEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /funnels/{uuid}" : [ ] - } ] - }, - "put" : { - "tags" : [ "funnel" ], - "summary" : "Updates a funnel", - "description" : "", - "operationId" : "updateFunnel", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The funnel id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The funnel configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/FunnelEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/FunnelEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /funnels/{uuid}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "funnel" ], - "summary" : "Deletes a funnel", - "description" : "", - "operationId" : "removeFunnel", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The revision is used to verify the client is working with the latest version of the flow.", - "required" : false, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The funnel id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/FunnelEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /funnels/{uuid}" : [ ] - }, { - "Write - Parent Process Group - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/input-ports/{id}" : { - "get" : { - "tags" : [ "input-ports" ], - "summary" : "Gets an input port", - "description" : "", - "operationId" : "getInputPort", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The input port id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/PortEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /input-ports/{uuid}" : [ ] - } ] - }, - "put" : { - "tags" : [ "input-ports" ], - "summary" : "Updates an input port", - "description" : "", - "operationId" : "updateInputPort", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The input port id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The input port configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/PortEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/PortEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /input-ports/{uuid}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "input-ports" ], - "summary" : "Deletes an input port", - "description" : "", - "operationId" : "removeInputPort", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The revision is used to verify the client is working with the latest version of the flow.", - "required" : false, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The input port id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/PortEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /input-ports/{uuid}" : [ ] - }, { - "Write - Parent Process Group - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/input-ports/{id}/run-status" : { - "put" : { - "tags" : [ "input-ports" ], - "summary" : "Updates run status of an input-port", - "description" : "", - "operationId" : "updateRunStatus", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The port id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The port run status.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/PortRunStatusEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessorEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /input-ports/{uuid} or /operation/input-ports/{uuid}" : [ ] - } ] - } - }, - "/labels/{id}" : { - "get" : { - "tags" : [ "labels" ], - "summary" : "Gets a label", - "description" : "", - "operationId" : "getLabel", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The label id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/LabelEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /labels/{uuid}" : [ ] - } ] - }, - "put" : { - "tags" : [ "labels" ], - "summary" : "Updates a label", - "description" : "", - "operationId" : "updateLabel", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The label id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The label configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/LabelEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/LabelEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /labels/{uuid}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "labels" ], - "summary" : "Deletes a label", - "description" : "", - "operationId" : "removeLabel", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The revision is used to verify the client is working with the latest version of the flow.", - "required" : false, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The label id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/LabelEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /labels/{uuid}" : [ ] - }, { - "Write - Parent Process Group - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/output-ports/{id}" : { - "get" : { - "tags" : [ "output-ports" ], - "summary" : "Gets an output port", - "description" : "", - "operationId" : "getOutputPort", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The output port id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/PortEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /output-ports/{uuid}" : [ ] - } ] - }, - "put" : { - "tags" : [ "output-ports" ], - "summary" : "Updates an output port", - "description" : "", - "operationId" : "updateOutputPort", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The output port id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The output port configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/PortEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/PortEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /output-ports/{uuid}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "output-ports" ], - "summary" : "Deletes an output port", - "description" : "", - "operationId" : "removeOutputPort", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The revision is used to verify the client is working with the latest version of the flow.", - "required" : false, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The output port id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/PortEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /output-ports/{uuid}" : [ ] - }, { - "Write - Parent Process Group - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/output-ports/{id}/run-status" : { - "put" : { - "tags" : [ "output-ports" ], - "summary" : "Updates run status of an output-port", - "description" : "", - "operationId" : "updateRunStatus", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The port id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The port run status.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/PortRunStatusEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessorEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /output-ports/{uuid} or /operation/output-ports/{uuid}" : [ ] - } ] - } - }, - "/parameter-contexts" : { - "post" : { - "tags" : [ "parameter-contexts" ], - "summary" : "Create a Parameter Context", - "description" : "", - "operationId" : "createParameterContext", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The Parameter Context.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ParameterContextEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ParameterContextEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /parameter-contexts" : [ ] - }, { - "Read - for every inherited parameter context" : [ ] - } ] - } - }, - "/parameter-contexts/{contextId}/update-requests" : { - "post" : { - "tags" : [ "parameter-contexts" ], - "summary" : "Initiate the Update Request of a Parameter Context", - "description" : "This will initiate the process of updating a Parameter Context. Changing the value of a Parameter may require that one or more components be stopped and restarted, so this 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", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "contextId", - "in" : "path", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The updated version of the parameter context.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ParameterContextEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ParameterContextUpdateRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /parameter-contexts/{parameterContextId}" : [ ] - }, { - "Write - /parameter-contexts/{parameterContextId}" : [ ] - }, { - "Read - for every component that is affected by the update" : [ ] - }, { - "Write - for every component that is affected by the update" : [ ] - }, { - "Read - for every currently inherited parameter context" : [ ] - }, { - "Read - for any new inherited parameter context" : [ ] - } ] - } - }, - "/parameter-contexts/{contextId}/update-requests/{requestId}" : { - "get" : { - "tags" : [ "parameter-contexts" ], - "summary" : "Returns the Update Request with the given ID", - "description" : "Returns the Update Request with the given ID. Once an Update Request has been created by performing a POST to /nifi-api/parameter-contexts, that request can subsequently be retrieved via this endpoint, and the request that is fetched will contain the updated state, such as percent complete, the current state of the request, and any failures. ", - "operationId" : "getParameterContextUpdate", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "contextId", - "in" : "path", - "description" : "The ID of the Parameter Context", - "required" : true, - "type" : "string" - }, { - "name" : "requestId", - "in" : "path", - "description" : "The ID of the Update Request", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ParameterContextUpdateRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Only the user that submitted the request can get it" : [ ] - } ] - }, - "delete" : { - "tags" : [ "parameter-contexts" ], - "summary" : "Deletes the Update Request with the given ID", - "description" : "Deletes the Update Request with the given ID. After a request is created via a POST to /nifi-api/parameter-contexts/update-requests, it is expected that the client will properly clean up the request by DELETE'ing it, once the Update process has completed. If the request is deleted before the request completes, then the Update request will finish the step that it is currently performing and then will cancel any subsequent steps.", - "operationId" : "deleteUpdateRequest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "contextId", - "in" : "path", - "description" : "The ID of the ParameterContext", - "required" : true, - "type" : "string" - }, { - "name" : "requestId", - "in" : "path", - "description" : "The ID of the Update Request", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ParameterContextUpdateRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Only the user that submitted the request can remove it" : [ ] - } ] - } - }, - "/parameter-contexts/{contextId}/validation-requests" : { - "post" : { - "tags" : [ "parameter-contexts" ], - "summary" : "Initiate a Validation Request to determine how the validity of components will change if a Parameter Context were to be updated", - "description" : "This will initiate the process of validating all components whose Process Group is bound to the specified Parameter Context. Performing validation against an arbitrary number of components may be expect and take significantly more time than many other REST API actions. As a result, this endpoint will immediately return a ParameterContextValidationRequestEntity, and the process of validating the necessary components will occur asynchronously in the background. The client may then periodically poll the status of the request by issuing a GET request to /parameter-contexts/validation-requests/{requestId}. Once the request is completed, the client is expected to issue a DELETE request to /parameter-contexts/validation-requests/{requestId}.", - "operationId" : "submitValidationRequest", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "contextId", - "in" : "path", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The validation request", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ParameterContextValidationRequestEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ParameterContextValidationRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /parameter-contexts/{parameterContextId}" : [ ] - } ] - } - }, - "/parameter-contexts/{contextId}/validation-requests/{id}" : { - "get" : { - "tags" : [ "parameter-contexts" ], - "summary" : "Returns the Validation Request with the given ID", - "description" : "Returns the Validation Request with the given ID. Once a Validation Request has been created by performing a POST to /nifi-api/validation-contexts, that request can subsequently be retrieved via this endpoint, and the request that is fetched will contain the updated state, such as percent complete, the current state of the request, and any failures. ", - "operationId" : "getValidationRequest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "contextId", - "in" : "path", - "description" : "The ID of the Parameter Context", - "required" : true, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The ID of the Validation Request", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ParameterContextValidationRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Only the user that submitted the request can get it" : [ ] - } ] - }, - "delete" : { - "tags" : [ "parameter-contexts" ], - "summary" : "Deletes the Validation Request with the given ID", - "description" : "Deletes the Validation Request with the given ID. After a request is created via a POST to /nifi-api/validation-contexts, it is expected that the client will properly clean up the request by DELETE'ing it, once the validation process has completed. If the request is deleted before the request completes, then the Validation request will finish the step that it is currently performing and then will cancel any subsequent steps.", - "operationId" : "deleteValidationRequest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "contextId", - "in" : "path", - "description" : "The ID of the Parameter Context", - "required" : true, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The ID of the Update Request", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ParameterContextValidationRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Only the user that submitted the request can remove it" : [ ] - } ] - } - }, - "/parameter-contexts/{id}" : { - "get" : { - "tags" : [ "parameter-contexts" ], - "summary" : "Returns the Parameter Context with the given ID", - "description" : "Returns the Parameter Context with the given ID.", - "operationId" : "getParameterContext", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The ID of the Parameter Context", - "required" : true, - "type" : "string" - }, { - "name" : "includeInheritedParameters", - "in" : "query", - "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.", - "required" : false, - "type" : "boolean", - "default" : false - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ParameterContextEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /parameter-contexts/{id}" : [ ] - } ] - }, - "put" : { - "tags" : [ "parameter-contexts" ], - "summary" : "Modifies a Parameter Context", - "description" : "This endpoint will update a Parameter Context to match the provided entity. However, this request will fail if any component is running and is referencing a Parameter in the Parameter Context. Generally, this endpoint is not called directly. Instead, an update request should be submitted by making a POST to the /parameter-contexts/update-requests endpoint. That endpoint will, in turn, call this endpoint.", - "operationId" : "updateParameterContext", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The updated Parameter Context", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ParameterContextEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ParameterContextEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /parameter-contexts/{id}" : [ ] - }, { - "Write - /parameter-contexts/{id}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "parameter-contexts" ], - "summary" : "Deletes the Parameter Context with the given ID", - "description" : "Deletes the Parameter Context with the given ID.", - "operationId" : "deleteParameterContext", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The version is used to verify the client is working with the latest version of the flow.", - "required" : false, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, a new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The Parameter Context ID.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ParameterContextEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /parameter-contexts/{uuid}" : [ ] - }, { - "Write - /parameter-contexts/{uuid}" : [ ] - }, { - "Read - /process-groups/{uuid}, for any Process Group that is currently bound to the Parameter Context" : [ ] - }, { - "Write - /process-groups/{uuid}, for any Process Group that is currently bound to the Parameter Context" : [ ] - } ] - } - }, - "/policies" : { - "post" : { - "tags" : [ "policies" ], - "summary" : "Creates an access policy", - "description" : "", - "operationId" : "createAccessPolicy", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The access policy configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/AccessPolicyEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/AccessPolicyEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /policies/{resource}" : [ ] - } ] - } - }, - "/policies/{action}/{resource}" : { - "get" : { - "tags" : [ "policies" ], - "summary" : "Gets an access policy for the specified action and resource", - "description" : "Will return the effective policy if no component specific policy exists for the specified action and resource. Must have Read permissions to the policy with the desired action and resource. Permissions for the policy that is returned will be indicated in the response. This means the client could be authorized to get the policy for a given component but the effective policy may be inherited from an ancestor Process Group. If the client does not have permissions to that policy, the response will not include the policy and the permissions in the response will be marked accordingly. If the client does not have permissions to the policy of the desired action and resource a 403 response will be returned.", - "operationId" : "getAccessPolicyForResource", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "action", - "in" : "path", - "description" : "The request action.", - "required" : true, - "type" : "string", - "enum" : [ "read", "write" ] - }, { - "name" : "resource", - "in" : "path", - "description" : "The resource of the policy.", - "required" : true, - "type" : "string", - "pattern" : ".+" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/AccessPolicyEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /policies/{resource}" : [ ] - } ] - } - }, - "/policies/{id}" : { - "get" : { - "tags" : [ "policies" ], - "summary" : "Gets an access policy", - "description" : "", - "operationId" : "getAccessPolicy", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The access policy id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/AccessPolicyEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /policies/{resource}" : [ ] - } ] - }, - "put" : { - "tags" : [ "policies" ], - "summary" : "Updates a access policy", - "description" : "", - "operationId" : "updateAccessPolicy", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The access policy id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The access policy configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/AccessPolicyEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/AccessPolicyEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /policies/{resource}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "policies" ], - "summary" : "Deletes an access policy", - "description" : "", - "operationId" : "removeAccessPolicy", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The revision is used to verify the client is working with the latest version of the flow.", - "required" : false, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The access policy id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/AccessPolicyEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /policies/{resource}" : [ ] - }, { - "Write - Policy of the parent resource - /policies/{resource}" : [ ] - } ] - } - }, - "/process-groups/replace-requests/{id}" : { - "get" : { - "tags" : [ "process-groups" ], - "summary" : "Returns the Replace Request with the given ID", - "description" : "Returns the Replace Request with the given ID. Once a Replace Request has been created by performing a POST to /process-groups/{id}/replace-requests, that request can subsequently be retrieved via this endpoint, and the request that is fetched will contain the updated state, such as percent complete, the current state of the request, and any failures. Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getReplaceProcessGroupRequest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The ID of the Replace Request", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessGroupReplaceRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Only the user that submitted the request can get it" : [ ] - } ] - }, - "delete" : { - "tags" : [ "process-groups" ], - "summary" : "Deletes the Replace Request with the given ID", - "description" : "Deletes the Replace Request with the given ID. After a request is created via a POST to /process-groups/{id}/replace-requests, it is expected that the client will properly clean up the request by DELETE'ing it, once the Replace process has completed. If the request is deleted before the request completes, then the Replace request will finish the step that it is currently performing and then will cancel any subsequent steps. Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "deleteReplaceProcessGroupRequest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The ID of the Update Request", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessGroupReplaceRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Only the user that submitted the request can remove it" : [ ] - } ] - } - }, - "/process-groups/{groupId}/variable-registry/update-requests/{updateId}" : { - "get" : { - "tags" : [ "process-groups" ], - "summary" : "Gets a process group's variable registry", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getVariableRegistryUpdateRequest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "groupId", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "name" : "updateId", - "in" : "path", - "description" : "The ID of the Variable Registry Update Request", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VariableRegistryUpdateRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "process-groups" ], - "summary" : "Deletes an update request for a process group's variable registry. If the request is not yet complete, it will automatically be cancelled.", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "deleteVariableRegistryUpdateRequest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "groupId", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "name" : "updateId", - "in" : "path", - "description" : "The ID of the Variable Registry Update Request", - "required" : true, - "type" : "string" - }, { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VariableRegistryUpdateRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/process-groups/{id}" : { - "get" : { - "tags" : [ "process-groups" ], - "summary" : "Gets a process group", - "description" : "", - "operationId" : "getProcessGroup", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessGroupEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - } ] - }, - "put" : { - "tags" : [ "process-groups" ], - "summary" : "Updates a process group", - "description" : "", - "operationId" : "updateProcessGroup", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The process group configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ProcessGroupEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessGroupEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "process-groups" ], - "summary" : "Deletes a process group", - "description" : "", - "operationId" : "removeProcessGroup", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The revision is used to verify the client is working with the latest version of the flow.", - "required" : false, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessGroupEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - }, { - "Write - Parent Process Group - /process-groups/{uuid}" : [ ] - }, { - "Read - any referenced Controller Services by any encapsulated components - /controller-services/{uuid}" : [ ] - }, { - "Write - /{component-type}/{uuid} - For all encapsulated components" : [ ] - } ] - } - }, - "/process-groups/{id}/connections" : { - "get" : { - "tags" : [ "process-groups" ], - "summary" : "Gets all connections", - "description" : "", - "operationId" : "getConnections", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ConnectionsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - } ] - }, - "post" : { - "tags" : [ "process-groups" ], - "summary" : "Creates a connection", - "description" : "", - "operationId" : "createConnection", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The connection configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ConnectionEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ConnectionEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - }, { - "Write Source - /{component-type}/{uuid}" : [ ] - }, { - "Write Destination - /{component-type}/{uuid}" : [ ] - } ] - } - }, - "/process-groups/{id}/controller-services" : { - "post" : { - "tags" : [ "process-groups" ], - "summary" : "Creates a new controller service", - "description" : "", - "operationId" : "createControllerService", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The controller service configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ControllerServiceEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ControllerServiceEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - }, { - "Read - any referenced Controller Services - /controller-services/{uuid}" : [ ] - }, { - "Write - if the Controller Service is restricted - /restricted-components" : [ ] - } ] - } - }, - "/process-groups/{id}/download" : { - "get" : { - "tags" : [ "process-groups" ], - "summary" : "Gets a process group for download", - "description" : "", - "operationId" : "exportProcessGroup", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "name" : "includeReferencedServices", - "in" : "query", - "description" : "If referenced services from outside the target group should be included", - "required" : false, - "type" : "boolean", - "default" : false - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/process-groups/{id}/empty-all-connections-requests" : { - "post" : { - "tags" : [ "process-groups" ], - "summary" : "Creates a request to drop all flowfiles of all connection queues in this process group.", - "description" : "", - "operationId" : "createEmptyAllConnectionsRequest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessGroupEntity" - } - }, - "202" : { - "description" : "The request has been accepted. An HTTP response header will contain the URI where the status can be polled." - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid} - For this and all encapsulated process groups" : [ ] - }, { - "Write Source Data - /data/{component-type}/{uuid} - For all encapsulated connections" : [ ] - } ] - } - }, - "/process-groups/{id}/empty-all-connections-requests/{drop-request-id}" : { - "get" : { - "tags" : [ "process-groups" ], - "summary" : "Gets the current status of a drop all flowfiles request.", - "description" : "", - "operationId" : "getDropAllFlowfilesRequest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "name" : "drop-request-id", - "in" : "path", - "description" : "The drop request id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/DropRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid} - For this and all encapsulated process groups" : [ ] - }, { - "Write Source Data - /data/{component-type}/{uuid} - For all encapsulated connections" : [ ] - } ] - }, - "delete" : { - "tags" : [ "process-groups" ], - "summary" : "Cancels and/or removes a request to drop all flowfiles.", - "description" : "", - "operationId" : "removeDropRequest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "name" : "drop-request-id", - "in" : "path", - "description" : "The drop request id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/DropRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid} - For this and all encapsulated process groups" : [ ] - }, { - "Write Source Data - /data/{component-type}/{uuid} - For all encapsulated connections" : [ ] - } ] - } - }, - "/process-groups/{id}/flow-contents" : { - "put" : { - "tags" : [ "process-groups" ], - "summary" : "Replace Process Group contents with the given ID with the specified Process Group contents", - "description" : "This endpoint is used for replication within a cluster, when replacing a flow with a new flow. It expects that the flow beingreplaced is not under version control and that the given snapshot will not modify any Processor that is currently running or any Controller Service that is enabled. Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "replaceProcessGroup", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The process group replace request entity.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ProcessGroupImportEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessGroupImportEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - }, { - "Write - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/process-groups/{id}/funnels" : { - "get" : { - "tags" : [ "process-groups" ], - "summary" : "Gets all funnels", - "description" : "", - "operationId" : "getFunnels", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/FunnelsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - } ] - }, - "post" : { - "tags" : [ "process-groups" ], - "summary" : "Creates a funnel", - "description" : "", - "operationId" : "createFunnel", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The funnel configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/FunnelEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/FunnelEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/process-groups/{id}/input-ports" : { - "get" : { - "tags" : [ "process-groups" ], - "summary" : "Gets all input ports", - "description" : "", - "operationId" : "getInputPorts", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/InputPortsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - } ] - }, - "post" : { - "tags" : [ "process-groups" ], - "summary" : "Creates an input port", - "description" : "", - "operationId" : "createInputPort", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The input port configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/PortEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/PortEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/process-groups/{id}/labels" : { - "get" : { - "tags" : [ "process-groups" ], - "summary" : "Gets all labels", - "description" : "", - "operationId" : "getLabels", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/LabelsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - } ] - }, - "post" : { - "tags" : [ "process-groups" ], - "summary" : "Creates a label", - "description" : "", - "operationId" : "createLabel", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The label configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/LabelEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/LabelEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/process-groups/{id}/local-modifications" : { - "get" : { - "tags" : [ "process-groups" ], - "summary" : "Gets a list of local modifications to the Process Group since it was last synchronized with the Flow Registry", - "description" : "", - "operationId" : "getLocalModifications", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/FlowComparisonEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - }, { - "Read - /{component-type}/{uuid} - For all encapsulated components" : [ ] - } ] - } - }, - "/process-groups/{id}/output-ports" : { - "get" : { - "tags" : [ "process-groups" ], - "summary" : "Gets all output ports", - "description" : "", - "operationId" : "getOutputPorts", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/OutputPortsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - } ] - }, - "post" : { - "tags" : [ "process-groups" ], - "summary" : "Creates an output port", - "description" : "", - "operationId" : "createOutputPort", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The output port configuration.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/PortEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/PortEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/process-groups/{id}/process-groups" : { - "get" : { - "tags" : [ "process-groups" ], - "summary" : "Gets all process groups", - "description" : "", - "operationId" : "getProcessGroups", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessGroupsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - } ] - }, - "post" : { - "tags" : [ "process-groups" ], - "summary" : "Creates a process group", - "description" : "", - "operationId" : "createProcessGroup", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The process group configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ProcessGroupEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessGroupEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/process-groups/{id}/process-groups/import" : { - "post" : { - "tags" : [ "process-groups" ], - "summary" : "Imports a specified process group", - "description" : "", - "operationId" : "importProcessGroup", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessGroupEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/process-groups/{id}/process-groups/upload" : { - "post" : { - "tags" : [ "process-groups" ], - "summary" : "Uploads a versioned flow definition and creates a process group", - "description" : "", - "operationId" : "uploadProcessGroup", - "consumes" : [ "multipart/form-data" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The process group name.", - "required" : true, - "schema" : { - "type" : "string" - } - }, { - "in" : "body", - "name" : "body", - "description" : "The process group X position.", - "required" : true, - "schema" : { - "type" : "number", - "format" : "double" - } - }, { - "in" : "body", - "name" : "body", - "description" : "The process group Y position.", - "required" : true, - "schema" : { - "type" : "number", - "format" : "double" - } - }, { - "in" : "body", - "name" : "body", - "description" : "The client id.", - "required" : true, - "schema" : { - "type" : "string" - } - }, { - "in" : "body", - "name" : "body", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "schema" : { - "type" : "boolean" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessGroupEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/process-groups/{id}/processors" : { - "get" : { - "tags" : [ "process-groups" ], - "summary" : "Gets all processors", - "description" : "", - "operationId" : "getProcessors", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "name" : "includeDescendantGroups", - "in" : "query", - "description" : "Whether or not to include processors from descendant process groups", - "required" : false, - "type" : "boolean", - "default" : false - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessorsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - } ] - }, - "post" : { - "tags" : [ "process-groups" ], - "summary" : "Creates a new processor", - "description" : "", - "operationId" : "createProcessor", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The processor configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ProcessorEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessorEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - }, { - "Read - any referenced Controller Services - /controller-services/{uuid}" : [ ] - }, { - "Write - if the Processor is restricted - /restricted-components" : [ ] - } ] - } - }, - "/process-groups/{id}/remote-process-groups" : { - "get" : { - "tags" : [ "process-groups" ], - "summary" : "Gets all remote process groups", - "description" : "", - "operationId" : "getRemoteProcessGroups", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/RemoteProcessGroupsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - } ] - }, - "post" : { - "tags" : [ "process-groups" ], - "summary" : "Creates a new process group", - "description" : "", - "operationId" : "createRemoteProcessGroup", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The remote process group configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/RemoteProcessGroupEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/RemoteProcessGroupEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/process-groups/{id}/replace-requests" : { - "post" : { - "tags" : [ "process-groups" ], - "summary" : "Initiate the Replace Request of a Process Group with the given ID", - "description" : "This will initiate the action of replacing a process group with the given process group. This can be a lengthy process, as it will stop any Processors and disable any Controller Services necessary to perform the action and then restart them. As a result, the endpoint will immediately return a ProcessGroupReplaceRequestEntity, and the process of replacing the flow will occur asynchronously in the background. The client may then periodically poll the status of the request by issuing a GET request to /process-groups/replace-requests/{requestId}. Once the request is completed, the client is expected to issue a DELETE request to /process-groups/replace-requests/{requestId}. Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "initiateReplaceProcessGroup", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The process group replace request entity", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ProcessGroupImportEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessGroupReplaceRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - }, { - "Write - /process-groups/{uuid}" : [ ] - }, { - "Read - /{component-type}/{uuid} - For all encapsulated components" : [ ] - }, { - "Write - /{component-type}/{uuid} - For all encapsulated components" : [ ] - }, { - "Write - if the template contains any restricted components - /restricted-components" : [ ] - }, { - "Read - /parameter-contexts/{uuid} - For any Parameter Context that is referenced by a Property that is changed, added, or removed" : [ ] - } ] - } - }, - "/process-groups/{id}/snippet-instance" : { - "post" : { - "tags" : [ "process-groups" ], - "summary" : "Copies a snippet and discards it.", - "description" : "", - "operationId" : "copySnippet", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The copy snippet request.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/CopySnippetRequestEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/FlowEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - }, { - "Read - /{component-type}/{uuid} - For each component in the snippet and their descendant components" : [ ] - }, { - "Write - if the snippet contains any restricted Processors - /restricted-components" : [ ] - } ] - } - }, - "/process-groups/{id}/template-instance" : { - "post" : { - "tags" : [ "process-groups" ], - "summary" : "Instantiates a template", - "description" : "", - "operationId" : "instantiateTemplate", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The instantiate template request.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/InstantiateTemplateRequestEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/FlowEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - }, { - "Read - /templates/{uuid}" : [ ] - }, { - "Write - if the template contains any restricted components - /restricted-components" : [ ] - } ] - } - }, - "/process-groups/{id}/templates" : { - "post" : { - "tags" : [ "process-groups" ], - "summary" : "Creates a template and discards the specified snippet.", - "description" : "", - "operationId" : "createTemplate", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The create template request.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/CreateTemplateRequestEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/TemplateEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - }, { - "Read - /{component-type}/{uuid} - For each component in the snippet and their descendant components" : [ ] - } ] - } - }, - "/process-groups/{id}/templates/import" : { - "post" : { - "tags" : [ "process-groups" ], - "summary" : "Imports a template", - "description" : "", - "operationId" : "importTemplate", - "consumes" : [ "application/xml" ], - "produces" : [ "application/xml" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/TemplateEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/process-groups/{id}/templates/upload" : { - "post" : { - "tags" : [ "process-groups" ], - "summary" : "Uploads a template", - "description" : "", - "operationId" : "uploadTemplate", - "consumes" : [ "multipart/form-data" ], - "produces" : [ "application/xml" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "schema" : { - "type" : "boolean" - } - }, { - "name" : "template", - "in" : "formData", - "description" : "The binary content of the template file being uploaded.", - "required" : true, - "type" : "file" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/TemplateEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/process-groups/{id}/variable-registry" : { - "get" : { - "tags" : [ "process-groups" ], - "summary" : "Gets a process group's variable registry", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getVariableRegistry", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "name" : "includeAncestorGroups", - "in" : "query", - "description" : "Whether or not to include ancestor groups", - "required" : false, - "type" : "boolean", - "default" : true - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VariableRegistryEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - } ] - }, - "put" : { - "tags" : [ "process-groups" ], - "summary" : "Updates the contents of a Process Group's variable Registry", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "updateVariableRegistry", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The variable registry configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/VariableRegistryEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VariableRegistryEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/process-groups/{id}/variable-registry/update-requests" : { - "post" : { - "tags" : [ "process-groups" ], - "summary" : "Submits a request to update a process group's variable registry", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "submitUpdateVariableRegistryRequest", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The variable registry configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/VariableRegistryEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VariableRegistryUpdateRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/processors/run-status-details/queries" : { - "post" : { - "tags" : [ "processors" ], - "summary" : "Submits a query to retrieve the run status details of all processors that are in the given list of Processor IDs", - "description" : "", - "operationId" : "getProcessorRunStatusDetails", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The request for the processors that should be included in the results", - "required" : false, - "schema" : { - "$ref" : "#/definitions/RunStatusDetailsRequestEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessorsRunStatusDetailsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /processors/{uuid} for each processor whose run status information is requested" : [ ] - } ] - } - }, - "/processors/{id}" : { - "get" : { - "tags" : [ "processors" ], - "summary" : "Gets a processor", - "description" : "", - "operationId" : "getProcessor", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The processor id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessorEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /processors/{uuid}" : [ ] - } ] - }, - "put" : { - "tags" : [ "processors" ], - "summary" : "Updates a processor", - "description" : "", - "operationId" : "updateProcessor", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The processor id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The processor configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ProcessorEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessorEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /processors/{uuid}" : [ ] - }, { - "Read - any referenced Controller Services if this request changes the reference - /controller-services/{uuid}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "processors" ], - "summary" : "Deletes a processor", - "description" : "", - "operationId" : "deleteProcessor", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The revision is used to verify the client is working with the latest version of the flow.", - "required" : false, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The processor id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessorEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /processors/{uuid}" : [ ] - }, { - "Write - Parent Process Group - /process-groups/{uuid}" : [ ] - }, { - "Read - any referenced Controller Services - /controller-services/{uuid}" : [ ] - } ] - } - }, - "/processors/{id}/config/analysis" : { - "post" : { - "tags" : [ "processors" ], - "summary" : "Performs analysis of the component's configuration, providing information about which attributes are referenced.", - "description" : "", - "operationId" : "analyzeConfiguration", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The processor id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The processor configuration analysis request.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ConfigurationAnalysisEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/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. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /processors/{uuid}" : [ ] - } ] - } - }, - "/processors/{id}/config/verification-requests" : { - "post" : { - "tags" : [ "processors" ], - "summary" : "Performs verification of the Processor's configuration", - "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", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The processor id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The processor configuration verification request.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/VerifyConfigRequestEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/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. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /processors/{uuid}" : [ ] - } ] - } - }, - "/processors/{id}/config/verification-requests/{requestId}" : { - "get" : { - "tags" : [ "processors" ], - "summary" : "Returns the Verification Request with the given ID", - "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", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The ID of the Processor", - "required" : true, - "type" : "string" - }, { - "name" : "requestId", - "in" : "path", - "description" : "The ID of the Verification Request", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/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. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Only the user that submitted the request can get it" : [ ] - } ] - }, - "delete" : { - "tags" : [ "processors" ], - "summary" : "Deletes the Verification Request with the given ID", - "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", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The ID of the Processor", - "required" : true, - "type" : "string" - }, { - "name" : "requestId", - "in" : "path", - "description" : "The ID of the Verification Request", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/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. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Only the user that submitted the request can remove it" : [ ] - } ] - } - }, - "/processors/{id}/descriptors" : { - "get" : { - "tags" : [ "processors" ], - "summary" : "Gets the descriptor for a processor property", - "description" : "", - "operationId" : "getPropertyDescriptor", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The processor id.", - "required" : true, - "type" : "string" - }, { - "name" : "propertyName", - "in" : "query", - "description" : "The property name.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/PropertyDescriptorEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /processors/{uuid}" : [ ] - } ] - } - }, - "/processors/{id}/diagnostics" : { - "get" : { - "tags" : [ "processors" ], - "summary" : "Gets diagnostics information about a processor", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getProcessorDiagnostics", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The processor id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessorEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /processors/{uuid}" : [ ] - } ] - } - }, - "/processors/{id}/run-status" : { - "put" : { - "tags" : [ "processors" ], - "summary" : "Updates run status of a processor", - "description" : "", - "operationId" : "updateRunStatus", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The processor id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The processor run status.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ProcessorRunStatusEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessorEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /processors/{uuid} or /operation/processors/{uuid}" : [ ] - } ] - } - }, - "/processors/{id}/state" : { - "get" : { - "tags" : [ "processors" ], - "summary" : "Gets the state for a processor", - "description" : "", - "operationId" : "getState", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The processor id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ComponentStateEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /processors/{uuid}" : [ ] - } ] - } - }, - "/processors/{id}/state/clear-requests" : { - "post" : { - "tags" : [ "processors" ], - "summary" : "Clears the state for a processor", - "description" : "", - "operationId" : "clearState", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The processor id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ComponentStateEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /processors/{uuid}" : [ ] - } ] - } - }, - "/processors/{id}/threads" : { - "delete" : { - "tags" : [ "processors" ], - "summary" : "Terminates a processor, essentially \"deleting\" its threads and any active tasks", - "description" : "", - "operationId" : "terminateProcessor", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The processor id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessorEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /processors/{uuid} or /operation/processors/{uuid}" : [ ] - } ] - } - }, - "/provenance" : { - "post" : { - "tags" : [ "provenance" ], - "summary" : "Submits a provenance query", - "description" : "Provenance queries may be long running so this endpoint submits a request. The response will include the current state of the query. If the request is not completed the URI in the response can be used at a later time to get the updated state of the query. Once the query has completed the provenance request should be deleted by the client who originally submitted it.", - "operationId" : "submitProvenanceRequest", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The provenance query details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ProvenanceEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProvenanceEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /provenance" : [ ] - }, { - "Read - /data/{component-type}/{uuid}" : [ ] - } ] - } - }, - "/provenance-events/replays" : { - "post" : { - "tags" : [ "provenance-events" ], - "summary" : "Replays content from a provenance event", - "description" : "", - "operationId" : "submitReplay", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The replay request.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/SubmitReplayRequestEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProvenanceEventEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read Component Provenance Data - /provenance-data/{component-type}/{uuid}" : [ ] - }, { - "Read Component Data - /data/{component-type}/{uuid}" : [ ] - }, { - "Write Component Data - /data/{component-type}/{uuid}" : [ ] - } ] - } - }, - "/provenance-events/{id}" : { - "get" : { - "tags" : [ "provenance-events" ], - "summary" : "Gets a provenance event", - "description" : "", - "operationId" : "getProvenanceEvent", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "clusterNodeId", - "in" : "query", - "description" : "The id of the node where this event exists if clustered.", - "required" : false, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The provenance event id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProvenanceEventEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read Component Provenance Data - /provenance-data/{component-type}/{uuid}" : [ ] - } ] - } - }, - "/provenance-events/{id}/content/input" : { - "get" : { - "tags" : [ "provenance-events" ], - "summary" : "Gets the input content for a provenance event", - "description" : "", - "operationId" : "getInputContent", - "consumes" : [ "*/*" ], - "produces" : [ "*/*" ], - "parameters" : [ { - "name" : "clusterNodeId", - "in" : "query", - "description" : "The id of the node where the content exists if clustered.", - "required" : false, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The provenance event id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/StreamingOutput" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read Component Provenance Data - /provenance-data/{component-type}/{uuid}" : [ ] - }, { - "Read Component Data - /data/{component-type}/{uuid}" : [ ] - } ] - } - }, - "/provenance-events/{id}/content/output" : { - "get" : { - "tags" : [ "provenance-events" ], - "summary" : "Gets the output content for a provenance event", - "description" : "", - "operationId" : "getOutputContent", - "consumes" : [ "*/*" ], - "produces" : [ "*/*" ], - "parameters" : [ { - "name" : "clusterNodeId", - "in" : "query", - "description" : "The id of the node where the content exists if clustered.", - "required" : false, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The provenance event id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/StreamingOutput" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read Component Provenance Data - /provenance-data/{component-type}/{uuid}" : [ ] - }, { - "Read Component Data - /data/{component-type}/{uuid}" : [ ] - } ] - } - }, - "/provenance/lineage" : { - "post" : { - "tags" : [ "provenance" ], - "summary" : "Submits a lineage query", - "description" : "Lineage queries may be long running so this endpoint submits a request. The response will include the current state of the query. If the request is not completed the URI in the response can be used at a later time to get the updated state of the query. Once the query has completed the lineage request should be deleted by the client who originally submitted it.", - "operationId" : "submitLineageRequest", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The lineage query details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/LineageEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/LineageEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /provenance" : [ ] - }, { - "Read - /data/{component-type}/{uuid}" : [ ] - } ] - } - }, - "/provenance/lineage/{id}" : { - "get" : { - "tags" : [ "provenance" ], - "summary" : "Gets a lineage query", - "description" : "", - "operationId" : "getLineage", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "clusterNodeId", - "in" : "query", - "description" : "The id of the node where this query exists if clustered.", - "required" : false, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The id of the lineage query.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/LineageEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /provenance" : [ ] - }, { - "Read - /data/{component-type}/{uuid}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "provenance" ], - "summary" : "Deletes a lineage query", - "description" : "", - "operationId" : "deleteLineage", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "clusterNodeId", - "in" : "query", - "description" : "The id of the node where this query exists if clustered.", - "required" : false, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The id of the lineage query.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/LineageEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /provenance" : [ ] - } ] - } - }, - "/provenance/search-options" : { - "get" : { - "tags" : [ "provenance" ], - "summary" : "Gets the searchable attributes for provenance events", - "description" : "", - "operationId" : "getSearchOptions", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProvenanceOptionsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /provenance" : [ ] - } ] - } - }, - "/provenance/{id}" : { - "get" : { - "tags" : [ "provenance" ], - "summary" : "Gets a provenance query", - "description" : "", - "operationId" : "getProvenance", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "clusterNodeId", - "in" : "query", - "description" : "The id of the node where this query exists if clustered.", - "required" : false, - "type" : "string" - }, { - "name" : "summarize", - "in" : "query", - "description" : "Whether or not incremental results are returned. If false, provenance events are only returned once the query completes. This property is true by default.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "incrementalResults", - "in" : "query", - "description" : "Whether or not to summarize provenance events returned. This property is false by default.", - "required" : false, - "type" : "boolean", - "default" : true - }, { - "name" : "id", - "in" : "path", - "description" : "The id of the provenance query.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProvenanceEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /provenance" : [ ] - }, { - "Read - /data/{component-type}/{uuid}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "provenance" ], - "summary" : "Deletes a provenance query", - "description" : "", - "operationId" : "deleteProvenance", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "clusterNodeId", - "in" : "query", - "description" : "The id of the node where this query exists if clustered.", - "required" : false, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The id of the provenance query.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProvenanceEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /provenance" : [ ] - } ] - } - }, - "/remote-process-groups/process-group/{id}/run-status" : { - "put" : { - "tags" : [ "remote-process-groups" ], - "summary" : "Updates run status of all remote process groups in a process group (recursively)", - "description" : "", - "operationId" : "updateRemoteProcessGroupRunStatuses", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The remote process groups run status.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/RemotePortRunStatusEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/RemoteProcessGroupEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /remote-process-groups/{uuid} or /operation/remote-process-groups/{uuid}" : [ ] - } ] - } - }, - "/remote-process-groups/{id}" : { - "get" : { - "tags" : [ "remote-process-groups" ], - "summary" : "Gets a remote process group", - "description" : "", - "operationId" : "getRemoteProcessGroup", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The remote process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/RemoteProcessGroupEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /remote-process-groups/{uuid}" : [ ] - } ] - }, - "put" : { - "tags" : [ "remote-process-groups" ], - "summary" : "Updates a remote process group", - "description" : "", - "operationId" : "updateRemoteProcessGroup", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The remote process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The remote process group.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/RemoteProcessGroupEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/RemoteProcessGroupEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /remote-process-groups/{uuid}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "remote-process-groups" ], - "summary" : "Deletes a remote process group", - "description" : "", - "operationId" : "removeRemoteProcessGroup", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The revision is used to verify the client is working with the latest version of the flow.", - "required" : false, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The remote process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/RemoteProcessGroupEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /remote-process-groups/{uuid}" : [ ] - }, { - "Write - Parent Process Group - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/remote-process-groups/{id}/input-ports/{port-id}" : { - "put" : { - "tags" : [ "remote-process-groups" ], - "summary" : "Updates a remote port", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "updateRemoteProcessGroupInputPort", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The remote process group id.", - "required" : true, - "type" : "string" - }, { - "name" : "port-id", - "in" : "path", - "description" : "The remote process group port id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The remote process group port.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/RemoteProcessGroupPortEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/RemoteProcessGroupPortEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /remote-process-groups/{uuid}" : [ ] - } ] - } - }, - "/remote-process-groups/{id}/input-ports/{port-id}/run-status" : { - "put" : { - "tags" : [ "remote-process-groups" ], - "summary" : "Updates run status of a remote port", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "updateRemoteProcessGroupInputPortRunStatus", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The remote process group id.", - "required" : true, - "type" : "string" - }, { - "name" : "port-id", - "in" : "path", - "description" : "The remote process group port id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The remote process group port.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/RemotePortRunStatusEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/RemoteProcessGroupPortEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /remote-process-groups/{uuid} or /operation/remote-process-groups/{uuid}" : [ ] - } ] - } - }, - "/remote-process-groups/{id}/output-ports/{port-id}" : { - "put" : { - "tags" : [ "remote-process-groups" ], - "summary" : "Updates a remote port", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "updateRemoteProcessGroupOutputPort", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The remote process group id.", - "required" : true, - "type" : "string" - }, { - "name" : "port-id", - "in" : "path", - "description" : "The remote process group port id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The remote process group port.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/RemoteProcessGroupPortEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/RemoteProcessGroupPortEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /remote-process-groups/{uuid}" : [ ] - } ] - } - }, - "/remote-process-groups/{id}/output-ports/{port-id}/run-status" : { - "put" : { - "tags" : [ "remote-process-groups" ], - "summary" : "Updates run status of a remote port", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "updateRemoteProcessGroupOutputPortRunStatus", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The remote process group id.", - "required" : true, - "type" : "string" - }, { - "name" : "port-id", - "in" : "path", - "description" : "The remote process group port id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The remote process group port.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/RemotePortRunStatusEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/RemoteProcessGroupPortEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /remote-process-groups/{uuid} or /operation/remote-process-groups/{uuid}" : [ ] - } ] - } - }, - "/remote-process-groups/{id}/run-status" : { - "put" : { - "tags" : [ "remote-process-groups" ], - "summary" : "Updates run status of a remote process group", - "description" : "", - "operationId" : "updateRemoteProcessGroupRunStatus", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The remote process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The remote process group run status.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/RemotePortRunStatusEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/RemoteProcessGroupEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /remote-process-groups/{uuid} or /operation/remote-process-groups/{uuid}" : [ ] - } ] - } - }, - "/remote-process-groups/{id}/state" : { - "get" : { - "tags" : [ "remote-process-groups" ], - "summary" : "Gets the state for a RemoteProcessGroup", - "description" : "", - "operationId" : "getState", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The processor id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ComponentStateEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /remote-process-groups/{uuid}" : [ ] - } ] - } - }, - "/reporting-tasks/{id}" : { - "get" : { - "tags" : [ "reporting-tasks" ], - "summary" : "Gets a reporting task", - "description" : "", - "operationId" : "getReportingTask", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The reporting task id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ReportingTaskEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /reporting-tasks/{uuid}" : [ ] - } ] - }, - "put" : { - "tags" : [ "reporting-tasks" ], - "summary" : "Updates a reporting task", - "description" : "", - "operationId" : "updateReportingTask", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The reporting task id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The reporting task configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ReportingTaskEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ReportingTaskEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /reporting-tasks/{uuid}" : [ ] - }, { - "Read - any referenced Controller Services if this request changes the reference - /controller-services/{uuid}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "reporting-tasks" ], - "summary" : "Deletes a reporting task", - "description" : "", - "operationId" : "removeReportingTask", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The revision is used to verify the client is working with the latest version of the flow.", - "required" : false, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The reporting task id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ReportingTaskEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /reporting-tasks/{uuid}" : [ ] - }, { - "Write - /controller" : [ ] - }, { - "Read - any referenced Controller Services - /controller-services/{uuid}" : [ ] - } ] - } - }, - "/reporting-tasks/{id}/config/analysis" : { - "post" : { - "tags" : [ "reporting-tasks" ], - "summary" : "Performs analysis of the component's configuration, providing information about which attributes are referenced.", - "description" : "", - "operationId" : "analyzeConfiguration", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The reporting task id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The configuration analysis request.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ConfigurationAnalysisEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/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. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /reporting-tasks/{uuid}" : [ ] - } ] - } - }, - "/reporting-tasks/{id}/config/verification-requests" : { - "post" : { - "tags" : [ "reporting-tasks" ], - "summary" : "Performs verification of the Reporting Task's configuration", - "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/{serviceId}/verification-requests/{requestId}. Once the request is completed, the client is expected to issue a DELETE request to /reporting-tasks/{serviceId}/verification-requests/{requestId}.", - "operationId" : "submitConfigVerificationRequest", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The reporting task id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The reporting task configuration verification request.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/VerifyConfigRequestEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/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. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /reporting-tasks/{uuid}" : [ ] - } ] - } - }, - "/reporting-tasks/{id}/config/verification-requests/{requestId}" : { - "get" : { - "tags" : [ "reporting-tasks" ], - "summary" : "Returns the Verification Request with the given ID", - "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", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The ID of the Reporting Task", - "required" : true, - "type" : "string" - }, { - "name" : "requestId", - "in" : "path", - "description" : "The ID of the Verification Request", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/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. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Only the user that submitted the request can get it" : [ ] - } ] - }, - "delete" : { - "tags" : [ "reporting-tasks" ], - "summary" : "Deletes the Verification Request with the given ID", - "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" : "deleteValidationRequest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The ID of the Reporting Task", - "required" : true, - "type" : "string" - }, { - "name" : "requestId", - "in" : "path", - "description" : "The ID of the Verification Request", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/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. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Only the user that submitted the request can remove it" : [ ] - } ] - } - }, - "/reporting-tasks/{id}/descriptors" : { - "get" : { - "tags" : [ "reporting-tasks" ], - "summary" : "Gets a reporting task property descriptor", - "description" : "", - "operationId" : "getPropertyDescriptor", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The reporting task id.", - "required" : true, - "type" : "string" - }, { - "name" : "propertyName", - "in" : "query", - "description" : "The property name.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/PropertyDescriptorEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /reporting-tasks/{uuid}" : [ ] - } ] - } - }, - "/reporting-tasks/{id}/run-status" : { - "put" : { - "tags" : [ "reporting-tasks" ], - "summary" : "Updates run status of a reporting task", - "description" : "", - "operationId" : "updateRunStatus", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The reporting task id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The reporting task run status.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ReportingTaskRunStatusEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ReportingTaskEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /reporting-tasks/{uuid} or or /operation/reporting-tasks/{uuid}" : [ ] - } ] - } - }, - "/reporting-tasks/{id}/state" : { - "get" : { - "tags" : [ "reporting-tasks" ], - "summary" : "Gets the state for a reporting task", - "description" : "", - "operationId" : "getState", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The reporting task id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ComponentStateEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /reporting-tasks/{uuid}" : [ ] - } ] - } - }, - "/reporting-tasks/{id}/state/clear-requests" : { - "post" : { - "tags" : [ "reporting-tasks" ], - "summary" : "Clears the state for a reporting task", - "description" : "", - "operationId" : "clearState", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The reporting task id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ComponentStateEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /reporting-tasks/{uuid}" : [ ] - } ] - } - }, - "/resources" : { - "get" : { - "tags" : [ "resources" ], - "summary" : "Gets the available resources that support access/authorization policies", - "description" : "", - "operationId" : "getResources", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ResourcesEntity" - } - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - } - }, - "security" : [ { - "Read - /resources" : [ ] - } ] - } - }, - "/site-to-site" : { - "get" : { - "tags" : [ "site-to-site" ], - "summary" : "Returns the details about this NiFi necessary to communicate via site to site", - "description" : "", - "operationId" : "getSiteToSiteDetails", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ControllerEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /site-to-site" : [ ] - } ] - } - }, - "/site-to-site/peers" : { - "get" : { - "tags" : [ "site-to-site" ], - "summary" : "Returns the available Peers and its status of this NiFi", - "description" : "", - "operationId" : "getPeers", - "consumes" : [ "*/*" ], - "produces" : [ "application/json", "application/xml" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/PeersEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /site-to-site" : [ ] - } ] - } - }, - "/snippets" : { - "post" : { - "tags" : [ "snippets" ], - "summary" : "Creates a snippet. The snippet will be automatically discarded if not used in a subsequent request after 1 minute.", - "description" : "", - "operationId" : "createSnippet", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The snippet configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/SnippetEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/SnippetEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read or Write - /{component-type}/{uuid} - For every component (all Read or all Write) in the Snippet and their descendant components" : [ ] - } ] - } - }, - "/snippets/{id}" : { - "put" : { - "tags" : [ "snippets" ], - "summary" : "Move's the components in this Snippet into a new Process Group and discards the snippet", - "description" : "", - "operationId" : "updateSnippet", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The snippet id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The snippet configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/SnippetEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/SnippetEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write Process Group - /process-groups/{uuid}" : [ ] - }, { - "Write - /{component-type}/{uuid} - For each component in the Snippet and their descendant components" : [ ] - } ] - }, - "delete" : { - "tags" : [ "snippets" ], - "summary" : "Deletes the components in a snippet and discards the snippet", - "description" : "", - "operationId" : "deleteSnippet", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The snippet id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/SnippetEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /{component-type}/{uuid} - For each component in the Snippet and their descendant components" : [ ] - }, { - "Write - Parent Process Group - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/system-diagnostics" : { - "get" : { - "tags" : [ "system-diagnostics" ], - "summary" : "Gets the diagnostics for the system NiFi is running on", - "description" : "", - "operationId" : "getSystemDiagnostics", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "nodewise", - "in" : "query", - "description" : "Whether or not to include the breakdown per node. Optional, defaults to false", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "clusterNodeId", - "in" : "query", - "description" : "The id of the node where to get the status.", - "required" : false, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/SystemDiagnosticsEntity" - } - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - } - }, - "security" : [ { - "Read - /system" : [ ] - } ] - } - }, - "/templates/{id}" : { - "delete" : { - "tags" : [ "templates" ], - "summary" : "Deletes a template", - "description" : "", - "operationId" : "removeTemplate", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The template id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/TemplateEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /templates/{uuid}" : [ ] - }, { - "Write - Parent Process Group - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/templates/{id}/download" : { - "get" : { - "tags" : [ "templates" ], - "summary" : "Exports a template", - "description" : "", - "operationId" : "exportTemplate", - "consumes" : [ "*/*" ], - "produces" : [ "application/xml" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The template id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /templates/{uuid}" : [ ] - } ] - } - }, - "/tenants/search-results" : { - "get" : { - "tags" : [ "tenants" ], - "summary" : "Searches for a tenant with the specified identity", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "searchTenants", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "q", - "in" : "query", - "description" : "Identity to search for.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/TenantsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /tenants" : [ ] - } ] - } - }, - "/tenants/user-groups" : { - "get" : { - "tags" : [ "tenants" ], - "summary" : "Gets all user groups", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getUserGroups", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/UserGroupsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /tenants" : [ ] - } ] - }, - "post" : { - "tags" : [ "tenants" ], - "summary" : "Creates a user group", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "createUserGroup", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The user group configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/UserGroupEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/UserGroupEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /tenants" : [ ] - } ] - } - }, - "/tenants/user-groups/{id}" : { - "get" : { - "tags" : [ "tenants" ], - "summary" : "Gets a user group", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getUserGroup", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The user group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/UserGroupEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /tenants" : [ ] - } ] - }, - "put" : { - "tags" : [ "tenants" ], - "summary" : "Updates a user group", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "updateUserGroup", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The user group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The user group configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/UserGroupEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/UserGroupEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /tenants" : [ ] - } ] - }, - "delete" : { - "tags" : [ "tenants" ], - "summary" : "Deletes a user group", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "removeUserGroup", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The revision is used to verify the client is working with the latest version of the flow.", - "required" : false, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The user group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/UserGroupEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /tenants" : [ ] - } ] - } - }, - "/tenants/users" : { - "get" : { - "tags" : [ "tenants" ], - "summary" : "Gets all users", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getUsers", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/UsersEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /tenants" : [ ] - } ] - }, - "post" : { - "tags" : [ "tenants" ], - "summary" : "Creates a user", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "createUser", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The user configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/UserEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/UserEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /tenants" : [ ] - } ] - } - }, - "/tenants/users/{id}" : { - "get" : { - "tags" : [ "tenants" ], - "summary" : "Gets a user", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getUser", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The user id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/UserEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /tenants" : [ ] - } ] - }, - "put" : { - "tags" : [ "tenants" ], - "summary" : "Updates a user", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "updateUser", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The user id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The user configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/UserEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/UserEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /tenants" : [ ] - } ] - }, - "delete" : { - "tags" : [ "tenants" ], - "summary" : "Deletes a user", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "removeUser", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The revision is used to verify the client is working with the latest version of the flow.", - "required" : false, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The user id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/UserEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /tenants" : [ ] - } ] - } - }, - "/versions/active-requests" : { - "post" : { - "tags" : [ "versions" ], - "summary" : "Create a version control request", - "description" : "Creates a request so that a Process Group can be placed under Version Control or have its Version Control configuration changed. Creating this request will prevent any other threads from simultaneously saving local changes to Version Control. It will not, however, actually save the local flow to the Flow Registry. A POST to /versions/process-groups/{id} should be used to initiate saving of the local flow to the Flow Registry. Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "createVersionControlRequest", - "consumes" : [ "application/json" ], - "produces" : [ "text/plain" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The versioned flow details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/CreateActiveRequestEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/versions/active-requests/{id}" : { - "put" : { - "tags" : [ "versions" ], - "summary" : "Updates the request with the given ID", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "updateVersionControlRequest", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The request ID.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The version control component mapping.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/VersionControlComponentMappingEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionControlInformationEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Only the user that submitted the request can update it" : [ ] - } ] - }, - "delete" : { - "tags" : [ "versions" ], - "summary" : "Deletes the version control request with the given ID", - "description" : "Deletes the Version Control Request with the given ID. This will allow other threads to save flows to the Flow Registry. See also the documentation for POSTing to /versions/active-requests for information regarding why this is done. Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "deleteVersionControlRequest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The request ID.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Only the user that submitted the request can remove it" : [ ] - } ] - } - }, - "/versions/process-groups/{id}" : { - "get" : { - "tags" : [ "versions" ], - "summary" : "Gets the Version Control information for a process group", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getVersionInformation", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionControlInformationEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - } ] - }, - "post" : { - "tags" : [ "versions" ], - "summary" : "Save the Process Group with the given ID", - "description" : "Begins version controlling the Process Group with the given ID or commits changes to the Versioned Flow, depending on if the provided VersionControlInformation includes a flowId. Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "saveToFlowRegistry", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The versioned flow details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/StartVersionControlRequestEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionControlInformationEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - }, { - "Write - /process-groups/{uuid}" : [ ] - }, { - "Read - /{component-type}/{uuid} - For all encapsulated components" : [ ] - }, { - "Read - any referenced Controller Services by any encapsulated components - /controller-services/{uuid}" : [ ] - } ] - }, - "put" : { - "tags" : [ "versions" ], - "summary" : "Update the version of a Process Group with the given ID", - "description" : "For a Process Group that is already under Version Control, this will update the version of the flow to a different version. This endpoint expects that the given snapshot will not modify any Processor that is currently running or any Controller Service that is enabled. Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "updateFlowVersion", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The controller service configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/VersionedFlowSnapshotEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionControlInformationEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - }, { - "Write - /process-groups/{uuid}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "versions" ], - "summary" : "Stops version controlling the Process Group with the given ID", - "description" : "Stops version controlling the Process Group with the given ID. The Process Group will no longer track to any Versioned Flow. Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "stopVersionControl", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The version is used to verify the client is working with the latest version of the flow.", - "required" : false, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, a new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionControlInformationEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - }, { - "Write - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/versions/process-groups/{id}/download" : { - "get" : { - "tags" : [ "versions" ], - "summary" : "Gets the latest version of a Process Group for download", - "description" : "", - "operationId" : "exportFlowVersion", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/versions/revert-requests/process-groups/{id}" : { - "post" : { - "tags" : [ "versions" ], - "summary" : "Initiate the Revert Request of a Process Group with the given ID", - "description" : "For a Process Group that is already under Version Control, this will initiate the action of reverting any local changes that have been made to the Process Group since it was last synchronized with the Flow Registry. This will result in the flow matching the Versioned Flow that exists in the Flow Registry. This can be a lengthy process, as it will stop any Processors and disable any Controller Services necessary to perform the action and then restart them. As a result, the endpoint will immediately return a VersionedFlowUpdateRequestEntity, and the process of updating the flow will occur asynchronously in the background. The client may then periodically poll the status of the request by issuing a GET request to /versions/revert-requests/{requestId}. Once the request is completed, the client is expected to issue a DELETE request to /versions/revert-requests/{requestId}. Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "initiateRevertFlowVersion", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The controller service configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/VersionControlInformationEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlowUpdateRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - }, { - "Write - /process-groups/{uuid}" : [ ] - }, { - "Read - /{component-type}/{uuid} - For all encapsulated components" : [ ] - }, { - "Write - /{component-type}/{uuid} - For all encapsulated components" : [ ] - }, { - "Write - if the template contains any restricted components - /restricted-components" : [ ] - }, { - "Read - /parameter-contexts/{uuid} - For any Parameter Context that is referenced by a Property that is changed, added, or removed" : [ ] - } ] - } - }, - "/versions/revert-requests/{id}" : { - "get" : { - "tags" : [ "versions" ], - "summary" : "Returns the Revert Request with the given ID", - "description" : "Returns the Revert Request with the given ID. Once a Revert Request has been created by performing a POST to /versions/revert-requests/process-groups/{id}, that request can subsequently be retrieved via this endpoint, and the request that is fetched will contain the updated state, such as percent complete, the current state of the request, and any failures. Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getRevertRequest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The ID of the Revert Request", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlowUpdateRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Only the user that submitted the request can get it" : [ ] - } ] - }, - "delete" : { - "tags" : [ "versions" ], - "summary" : "Deletes the Revert Request with the given ID", - "description" : "Deletes the Revert Request with the given ID. After a request is created via a POST to /versions/revert-requests/process-groups/{id}, it is expected that the client will properly clean up the request by DELETE'ing it, once the Revert process has completed. If the request is deleted before the request completes, then the Revert request will finish the step that it is currently performing and then will cancel any subsequent steps. Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "deleteRevertRequest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The ID of the Revert Request", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlowUpdateRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Only the user that submitted the request can remove it" : [ ] - } ] - } - }, - "/versions/update-requests/process-groups/{id}" : { - "post" : { - "tags" : [ "versions" ], - "summary" : "Initiate the Update Request of a Process Group with the given ID", - "description" : "For a Process Group that is already under Version Control, this will initiate the action of changing from a specific version of the flow in the Flow Registry to a different version of the flow. This can be a lengthy process, as it will stop any Processors and disable any Controller Services necessary to perform the action and then restart them. As a result, the endpoint will immediately return a VersionedFlowUpdateRequestEntity, and the process of updating the flow will occur asynchronously in the background. The client may then periodically poll the status of the request by issuing a GET request to /versions/update-requests/{requestId}. Once the request is completed, the client is expected to issue a DELETE request to /versions/update-requests/{requestId}. Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "initiateVersionControlUpdate", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The controller service configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/VersionControlInformationEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlowUpdateRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - }, { - "Write - /process-groups/{uuid}" : [ ] - }, { - "Read - /{component-type}/{uuid} - For all encapsulated components" : [ ] - }, { - "Write - /{component-type}/{uuid} - For all encapsulated components" : [ ] - }, { - "Write - if the template contains any restricted components - /restricted-components" : [ ] - }, { - "Read - /parameter-contexts/{uuid} - For any Parameter Context that is referenced by a Property that is changed, added, or removed" : [ ] - } ] - } - }, - "/versions/update-requests/{id}" : { - "get" : { - "tags" : [ "versions" ], - "summary" : "Returns the Update Request with the given ID", - "description" : "Returns the Update Request with the given ID. Once an Update Request has been created by performing a POST to /versions/update-requests/process-groups/{id}, that request can subsequently be retrieved via this endpoint, and the request that is fetched will contain the updated state, such as percent complete, the current state of the request, and any failures. Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getUpdateRequest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The ID of the Update Request", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlowUpdateRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Only the user that submitted the request can get it" : [ ] - } ] - }, - "delete" : { - "tags" : [ "versions" ], - "summary" : "Deletes the Update Request with the given ID", - "description" : "Deletes the Update Request with the given ID. After a request is created via a POST to /versions/update-requests/process-groups/{id}, it is expected that the client will properly clean up the request by DELETE'ing it, once the Update process has completed. If the request is deleted before the request completes, then the Update request will finish the step that it is currently performing and then will cancel any subsequent steps. Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "deleteUpdateRequest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The ID of the Update Request", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlowUpdateRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Only the user that submitted the request can remove it" : [ ] - } ] - } - } - }, - "definitions" : { - "AboutDTO" : { - "type" : "object", - "properties" : { - "title" : { - "type" : "string", - "description" : "The title to be used on the page and in the about dialog." - }, - "version" : { - "type" : "string", - "description" : "The version of this NiFi." - }, - "uri" : { - "type" : "string", - "description" : "The URI for the NiFi." - }, - "contentViewerUrl" : { - "type" : "string", - "description" : "The URL for the content viewer if configured." - }, - "timezone" : { - "type" : "string", - "description" : "The timezone of the NiFi instance." - }, - "buildTag" : { - "type" : "string", - "description" : "Build tag" - }, - "buildRevision" : { - "type" : "string", - "description" : "Build revision or commit hash" - }, - "buildBranch" : { - "type" : "string", - "description" : "Build branch" - }, - "buildTimestamp" : { - "type" : "string", - "description" : "Build timestamp" - } - } - }, - "AboutEntity" : { - "type" : "object", - "properties" : { - "about" : { - "$ref" : "#/definitions/AboutDTO" - } - }, - "xml" : { - "name" : "aboutEntity" - } - }, - "AccessConfigurationDTO" : { - "type" : "object", - "properties" : { - "supportsLogin" : { - "type" : "boolean", - "description" : "Indicates whether or not this NiFi supports user login." - } - } - }, - "AccessConfigurationEntity" : { - "type" : "object", - "properties" : { - "config" : { - "$ref" : "#/definitions/AccessConfigurationDTO" - } - }, - "xml" : { - "name" : "accessConfigurationEntity" - } - }, - "AccessPolicyDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "versionedComponentId" : { - "type" : "string", - "description" : "The ID of the corresponding component that is under version control" - }, - "parentGroupId" : { - "type" : "string", - "description" : "The id of parent process group of this component if applicable." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "resource" : { - "type" : "string", - "description" : "The resource for this access policy." - }, - "action" : { - "type" : "string", - "description" : "The action associated with this access policy.", - "enum" : [ "read", "write" ] - }, - "componentReference" : { - "description" : "Component this policy references if applicable.", - "$ref" : "#/definitions/ComponentReferenceEntity" - }, - "configurable" : { - "type" : "boolean", - "description" : "Whether this policy is configurable." - }, - "users" : { - "type" : "array", - "description" : "The set of user IDs associated with this access policy.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/TenantEntity" - } - }, - "userGroups" : { - "type" : "array", - "description" : "The set of user group IDs associated with this access policy.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/TenantEntity" - } - } - } - }, - "AccessPolicyEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "generated" : { - "type" : "string", - "description" : "When this content was generated." - }, - "component" : { - "$ref" : "#/definitions/AccessPolicyDTO" - } - }, - "xml" : { - "name" : "accessPolicyEntity" - } - }, - "AccessPolicySummaryDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "versionedComponentId" : { - "type" : "string", - "description" : "The ID of the corresponding component that is under version control" - }, - "parentGroupId" : { - "type" : "string", - "description" : "The id of parent process group of this component if applicable." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "resource" : { - "type" : "string", - "description" : "The resource for this access policy." - }, - "action" : { - "type" : "string", - "description" : "The action associated with this access policy.", - "enum" : [ "read", "write" ] - }, - "componentReference" : { - "description" : "Component this policy references if applicable.", - "$ref" : "#/definitions/ComponentReferenceEntity" - }, - "configurable" : { - "type" : "boolean", - "description" : "Whether this policy is configurable." - } - } - }, - "AccessPolicySummaryEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "component" : { - "$ref" : "#/definitions/AccessPolicySummaryDTO" - } - }, - "xml" : { - "name" : "accessPolicySummaryEntity" - } - }, - "AccessStatusDTO" : { - "type" : "object", - "properties" : { - "identity" : { - "type" : "string", - "description" : "The user identity." - }, - "status" : { - "type" : "string", - "description" : "The user access status." - }, - "message" : { - "type" : "string", - "description" : "Additional details about the user access status." - } - }, - "xml" : { - "name" : "accessStatus" - } - }, - "AccessStatusEntity" : { - "type" : "object", - "properties" : { - "accessStatus" : { - "$ref" : "#/definitions/AccessStatusDTO" - } - }, - "xml" : { - "name" : "accessStatusEntity" - } - }, - "ActionDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "integer", - "format" : "int32", - "description" : "The action id." - }, - "userIdentity" : { - "type" : "string", - "description" : "The identity of the user that performed the action." - }, - "timestamp" : { - "type" : "string", - "description" : "The timestamp of the action." - }, - "sourceId" : { - "type" : "string", - "description" : "The id of the source component." - }, - "sourceName" : { - "type" : "string", - "description" : "The name of the source component." - }, - "sourceType" : { - "type" : "string", - "description" : "The type of the source component." - }, - "componentDetails" : { - "description" : "The details of the source component.", - "$ref" : "#/definitions/ComponentDetailsDTO" - }, - "operation" : { - "type" : "string", - "description" : "The operation that was performed." - }, - "actionDetails" : { - "description" : "The details of the action.", - "$ref" : "#/definitions/ActionDetailsDTO" - } - } - }, - "ActionDetailsDTO" : { - "type" : "object" - }, - "ActionEntity" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "integer", - "format" : "int32" - }, - "timestamp" : { - "type" : "string", - "description" : "The timestamp of the action." - }, - "sourceId" : { - "type" : "string" - }, - "canRead" : { - "type" : "boolean", - "description" : "Indicates whether the user can read a given resource." - }, - "action" : { - "$ref" : "#/definitions/ActionDTO" - } - }, - "xml" : { - "name" : "actionEntity" - } - }, - "ActivateControllerServicesEntity" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the ProcessGroup" - }, - "state" : { - "type" : "string", - "description" : "The desired state of the descendant components", - "enum" : [ "ENABLED", "DISABLED" ] - }, - "components" : { - "type" : "object", - "description" : "Optional services to schedule. If not specified, all authorized descendant controller services will be used.", - "additionalProperties" : { - "$ref" : "#/definitions/RevisionDTO" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - } - }, - "xml" : { - "name" : "activateControllerServicesEntity" - } - }, - "AffectedComponentDTO" : { - "type" : "object", - "properties" : { - "processGroupId" : { - "type" : "string", - "description" : "The UUID of the Process Group that this component is in" - }, - "id" : { - "type" : "string", - "description" : "The UUID of this component" - }, - "referenceType" : { - "type" : "string", - "description" : "The type of this component", - "enum" : [ "PROCESSOR", "CONTROLLER_SERVICE", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT" ] - }, - "name" : { - "type" : "string", - "description" : "The name of this component." - }, - "state" : { - "type" : "string", - "description" : "The scheduled state of a processor or reporting task referencing a controller service. If this component is another controller service, this field represents the controller service state." - }, - "activeThreadCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of active threads for the referencing component." - }, - "validationErrors" : { - "type" : "array", - "description" : "The validation errors for the component.", - "items" : { - "type" : "string" - } - } - } - }, - "AffectedComponentEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "component" : { - "$ref" : "#/definitions/AffectedComponentDTO" - }, - "processGroup" : { - "description" : "The Process Group that the component belongs to", - "$ref" : "#/definitions/ProcessGroupNameDTO" - }, - "referenceType" : { - "type" : "string", - "description" : "The type of component referenced", - "enum" : [ "PROCESSOR", "CONTROLLER_SERVICE", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT" ] - } - }, - "xml" : { - "name" : "affectedComponentEntity" - } - }, - "AllowableValueDTO" : { - "type" : "object", - "properties" : { - "displayName" : { - "type" : "string", - "description" : "A human readable value that is allowed for the property descriptor." - }, - "value" : { - "type" : "string", - "description" : "A value that is allowed for the property descriptor." - }, - "description" : { - "type" : "string", - "description" : "A description for this allowable value." - } - } - }, - "AllowableValueEntity" : { - "type" : "object", - "properties" : { - "allowableValue" : { - "$ref" : "#/definitions/AllowableValueDTO" - }, - "canRead" : { - "type" : "boolean", - "description" : "Indicates whether the user can read a given resource." - } - }, - "xml" : { - "name" : "entity" - } - }, - "AttributeDTO" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The attribute name." - }, - "value" : { - "type" : "string", - "description" : "The attribute value." - }, - "previousValue" : { - "type" : "string", - "description" : "The value of the attribute before the event took place." - } - } - }, - "BannerDTO" : { - "type" : "object", - "properties" : { - "headerText" : { - "type" : "string", - "description" : "The header text." - }, - "footerText" : { - "type" : "string", - "description" : "The footer text." - } - } - }, - "BannerEntity" : { - "type" : "object", - "properties" : { - "banners" : { - "$ref" : "#/definitions/BannerDTO" - } - }, - "xml" : { - "name" : "bannersEntity" - } - }, - "BatchSettingsDTO" : { - "type" : "object", - "properties" : { - "count" : { - "type" : "integer", - "format" : "int32", - "description" : "Preferred number of flow files to include in a transaction." - }, - "size" : { - "type" : "string", - "description" : "Preferred number of bytes to include in a transaction." - }, - "duration" : { - "type" : "string", - "description" : "Preferred amount of time that a transaction should span." - } - } - }, - "BatchSize" : { - "type" : "object", - "properties" : { - "count" : { - "type" : "integer", - "format" : "int32", - "description" : "Preferred number of flow files to include in a transaction." - }, - "size" : { - "type" : "string", - "description" : "Preferred number of bytes to include in a transaction." - }, - "duration" : { - "type" : "string", - "description" : "Preferred amount of time that a transaction should span." - } - } - }, - "Bucket" : { - "type" : "object", - "required" : [ "name" ], - "properties" : { - "link" : { - "description" : "An WebLink to this entity.", - "readOnly" : true, - "$ref" : "#/definitions/JaxbLink" - }, - "identifier" : { - "type" : "string", - "description" : "An ID to uniquely identify this object.", - "readOnly" : true - }, - "name" : { - "type" : "string", - "description" : "The name of the bucket." - }, - "createdTimestamp" : { - "type" : "integer", - "format" : "int64", - "description" : "The timestamp of when the bucket was first created. This is set by the server at creation time.", - "readOnly" : true, - "minimum" : 1 - }, - "description" : { - "type" : "string", - "description" : "A description of the bucket." - }, - "allowBundleRedeploy" : { - "type" : "boolean", - "description" : "Indicates if this bucket allows the same version of an extension bundle to be redeployed and thus overwrite the existing artifact. By default this is false." - }, - "allowPublicRead" : { - "type" : "boolean", - "description" : "Indicates if this bucket allows read access to unauthenticated anonymous users" - }, - "permissions" : { - "description" : "The access that the current user has to this bucket.", - "readOnly" : true, - "$ref" : "#/definitions/Permissions" - }, - "revision" : { - "description" : "The revision of this entity used for optimistic-locking during updates.", - "readOnly" : true, - "$ref" : "#/definitions/RevisionInfo" - } - } - }, - "BucketDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The bucket identifier" - }, - "name" : { - "type" : "string", - "description" : "The bucket name" - }, - "description" : { - "type" : "string", - "description" : "The bucket description" - }, - "created" : { - "type" : "integer", - "format" : "int64", - "description" : "The created timestamp of this bucket" - } - } - }, - "BucketEntity" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string" - }, - "bucket" : { - "$ref" : "#/definitions/BucketDTO" - }, - "permissions" : { - "$ref" : "#/definitions/PermissionsDTO" - } - }, - "xml" : { - "name" : "bucketEntity" - } - }, - "BucketsEntity" : { - "type" : "object", - "properties" : { - "buckets" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/BucketEntity" - } - } - }, - "xml" : { - "name" : "bucketsEntity" - } - }, - "BuildInfo" : { - "type" : "object", - "properties" : { - "version" : { - "type" : "string", - "description" : "The version number of the built component." - }, - "revision" : { - "type" : "string", - "description" : "The SCM revision id of the source code used for this build." - }, - "timestamp" : { - "type" : "integer", - "format" : "int64", - "description" : "The timestamp (milliseconds since Epoch) of the build." - }, - "targetArch" : { - "type" : "string", - "description" : "The target architecture of the built component." - }, - "compiler" : { - "type" : "string", - "description" : "The compiler used for the build" - }, - "compilerFlags" : { - "type" : "string", - "description" : "The compiler flags used for the build." - } - } - }, - "BulletinBoardDTO" : { - "type" : "object", - "properties" : { - "bulletins" : { - "type" : "array", - "description" : "The bulletins in the bulletin board, that matches the supplied request.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "generated" : { - "type" : "string", - "description" : "The timestamp when this report was generated." - } - } - }, - "BulletinBoardEntity" : { - "type" : "object", - "properties" : { - "bulletinBoard" : { - "$ref" : "#/definitions/BulletinBoardDTO" - } - }, - "xml" : { - "name" : "bulletinBoardEntity" - } - }, - "BulletinDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "integer", - "format" : "int64", - "description" : "The id of the bulletin." - }, - "nodeAddress" : { - "type" : "string", - "description" : "If clustered, the address of the node from which the bulletin originated." - }, - "category" : { - "type" : "string", - "description" : "The category of this bulletin." - }, - "groupId" : { - "type" : "string", - "description" : "The group id of the source component." - }, - "sourceId" : { - "type" : "string", - "description" : "The id of the source component." - }, - "sourceName" : { - "type" : "string", - "description" : "The name of the source component." - }, - "level" : { - "type" : "string", - "description" : "The level of the bulletin." - }, - "message" : { - "type" : "string", - "description" : "The bulletin message." - }, - "timestamp" : { - "type" : "string", - "description" : "When this bulletin was generated." - } - } - }, - "BulletinEntity" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "integer", - "format" : "int64" - }, - "groupId" : { - "type" : "string" - }, - "sourceId" : { - "type" : "string" - }, - "timestamp" : { - "type" : "string", - "description" : "When this bulletin was generated." - }, - "nodeAddress" : { - "type" : "string" - }, - "canRead" : { - "type" : "boolean", - "description" : "Indicates whether the user can read a given resource." - }, - "bulletin" : { - "$ref" : "#/definitions/BulletinDTO" - } - }, - "xml" : { - "name" : "bulletinEntity" - } - }, - "Bundle" : { - "type" : "object", - "properties" : { - "group" : { - "type" : "string", - "description" : "The group of the bundle" - }, - "artifact" : { - "type" : "string", - "description" : "The artifact of the bundle" - }, - "version" : { - "type" : "string", - "description" : "The version of the bundle" - } - } - }, - "BundleDTO" : { - "type" : "object", - "properties" : { - "group" : { - "type" : "string", - "description" : "The group of the bundle." - }, - "artifact" : { - "type" : "string", - "description" : "The artifact of the bundle." - }, - "version" : { - "type" : "string", - "description" : "The version of the bundle." - } - } - }, - "ClassLoaderDiagnosticsDTO" : { - "type" : "object", - "properties" : { - "bundle" : { - "description" : "Information about the Bundle that the ClassLoader belongs to, if any", - "$ref" : "#/definitions/BundleDTO" - }, - "parentClassLoader" : { - "description" : "A ClassLoaderDiagnosticsDTO that provides information about the parent ClassLoader", - "$ref" : "#/definitions/ClassLoaderDiagnosticsDTO" - } - } - }, - "ClusteSummaryEntity" : { - "type" : "object", - "properties" : { - "clusterSummary" : { - "$ref" : "#/definitions/ClusterSummaryDTO" - } - }, - "xml" : { - "name" : "clusterSummaryEntity" - } - }, - "ClusterDTO" : { - "type" : "object", - "properties" : { - "nodes" : { - "type" : "array", - "description" : "The collection of nodes that are part of the cluster.", - "items" : { - "$ref" : "#/definitions/NodeDTO" - } - }, - "generated" : { - "type" : "string", - "description" : "The timestamp the report was generated." - } - } - }, - "ClusterEntity" : { - "type" : "object", - "properties" : { - "cluster" : { - "$ref" : "#/definitions/ClusterDTO" - } - }, - "xml" : { - "name" : "clusterEntity" - } - }, - "ClusterSearchResultsEntity" : { - "type" : "object", - "properties" : { - "nodeResults" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/NodeSearchResultDTO" - } - } - }, - "xml" : { - "name" : "clusterSearchResultsEntity" - } - }, - "ClusterSummaryDTO" : { - "type" : "object", - "properties" : { - "connectedNodes" : { - "type" : "string", - "description" : "When clustered, reports the number of nodes connected vs the number of nodes in the cluster." - }, - "connectedNodeCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of nodes that are currently connected to the cluster" - }, - "totalNodeCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of nodes in the cluster, regardless of whether or not they are connected" - }, - "clustered" : { - "type" : "boolean", - "description" : "Whether this NiFi instance is clustered." - }, - "connectedToCluster" : { - "type" : "boolean", - "description" : "Whether this NiFi instance is connected to a cluster." - } - } - }, - "ComponentDetailsDTO" : { - "type" : "object" - }, - "ComponentDifferenceDTO" : { - "type" : "object", - "properties" : { - "componentType" : { - "type" : "string", - "description" : "The type of component" - }, - "componentId" : { - "type" : "string", - "description" : "The ID of the component" - }, - "componentName" : { - "type" : "string", - "description" : "The name of the component" - }, - "processGroupId" : { - "type" : "string", - "description" : "The ID of the Process Group that the component belongs to" - }, - "differences" : { - "type" : "array", - "description" : "The differences in the component between the two flows", - "items" : { - "$ref" : "#/definitions/DifferenceDTO" - } - } - } - }, - "ComponentHistoryDTO" : { - "type" : "object", - "properties" : { - "componentId" : { - "type" : "string", - "description" : "The component id." - }, - "propertyHistory" : { - "type" : "object", - "description" : "The history for the properties of the component.", - "additionalProperties" : { - "$ref" : "#/definitions/PropertyHistoryDTO" - } - } - } - }, - "ComponentHistoryEntity" : { - "type" : "object", - "properties" : { - "componentHistory" : { - "$ref" : "#/definitions/ComponentHistoryDTO" - } - }, - "xml" : { - "name" : "componentHistoryEntity" - } - }, - "ComponentManifest" : { - "type" : "object", - "properties" : { - "apis" : { - "type" : "array", - "description" : "Public interfaces defined in this bundle", - "items" : { - "$ref" : "#/definitions/DefinedType" - } - }, - "controllerServices" : { - "type" : "array", - "description" : "Controller Services provided in this bundle", - "items" : { - "$ref" : "#/definitions/ControllerServiceDefinition" - } - }, - "processors" : { - "type" : "array", - "description" : "Processors provided in this bundle", - "items" : { - "$ref" : "#/definitions/ProcessorDefinition" - } - }, - "reportingTasks" : { - "type" : "array", - "description" : "Reporting Tasks provided in this bundle", - "items" : { - "$ref" : "#/definitions/ReportingTaskDefinition" - } - } - } - }, - "ComponentReferenceDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "versionedComponentId" : { - "type" : "string", - "description" : "The ID of the corresponding component that is under version control" - }, - "parentGroupId" : { - "type" : "string", - "description" : "The id of parent process group of this component if applicable." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "name" : { - "type" : "string", - "description" : "The name of the component." - } - } - }, - "ComponentReferenceEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "parentGroupId" : { - "type" : "string", - "description" : "The id of parent process group of this component if applicable." - }, - "component" : { - "$ref" : "#/definitions/ComponentReferenceDTO" - } - }, - "xml" : { - "name" : "componentReferenceEntity" - } - }, - "ComponentRestrictionPermissionDTO" : { - "type" : "object", - "properties" : { - "requiredPermission" : { - "description" : "The required permission necessary for this restriction.", - "$ref" : "#/definitions/RequiredPermissionDTO" - }, - "permissions" : { - "description" : "The permissions for this component restriction. Note: the read permission are not used and will always be false.", - "$ref" : "#/definitions/PermissionsDTO" - } - } - }, - "ComponentSearchResultDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component that matched the search." - }, - "groupId" : { - "type" : "string", - "description" : "The group id of the component that matched the search." - }, - "parentGroup" : { - "description" : "The parent group of the component that matched the search.", - "$ref" : "#/definitions/SearchResultGroupDTO" - }, - "versionedGroup" : { - "description" : "The nearest versioned ancestor group of the component that matched the search.", - "$ref" : "#/definitions/SearchResultGroupDTO" - }, - "name" : { - "type" : "string", - "description" : "The name of the component that matched the search." - }, - "matches" : { - "type" : "array", - "description" : "What matched the search from the component.", - "items" : { - "type" : "string" - } - } - } - }, - "ComponentStateDTO" : { - "type" : "object", - "properties" : { - "componentId" : { - "type" : "string", - "description" : "The component identifier." - }, - "stateDescription" : { - "type" : "string", - "description" : "Description of the state this component persists." - }, - "clusterState" : { - "description" : "The cluster state for this component, or null if this NiFi is a standalone instance.", - "$ref" : "#/definitions/StateMapDTO" - }, - "localState" : { - "description" : "The local state for this component.", - "$ref" : "#/definitions/StateMapDTO" - } - } - }, - "ComponentStateEntity" : { - "type" : "object", - "properties" : { - "componentState" : { - "description" : "The component state.", - "$ref" : "#/definitions/ComponentStateDTO" - } - }, - "xml" : { - "name" : "componentStateEntity" - } - }, - "ComponentValidationResultDTO" : { - "type" : "object", - "properties" : { - "processGroupId" : { - "type" : "string", - "description" : "The UUID of the Process Group that this component is in" - }, - "id" : { - "type" : "string", - "description" : "The UUID of this component" - }, - "referenceType" : { - "type" : "string", - "description" : "The type of this component", - "enum" : [ "PROCESSOR", "CONTROLLER_SERVICE", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT" ] - }, - "name" : { - "type" : "string", - "description" : "The name of this component." - }, - "state" : { - "type" : "string", - "description" : "The scheduled state of a processor or reporting task referencing a controller service. If this component is another controller service, this field represents the controller service state." - }, - "activeThreadCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of active threads for the referencing component." - }, - "validationErrors" : { - "type" : "array", - "description" : "The validation errors for the component.", - "items" : { - "type" : "string" - } - }, - "currentlyValid" : { - "type" : "boolean", - "description" : "Whether or not the component is currently valid" - }, - "resultsValid" : { - "type" : "boolean", - "description" : "Whether or not the component will be valid if the Parameter Context is changed" - }, - "resultantValidationErrors" : { - "type" : "array", - "description" : "The validation errors that will apply to the component if the Parameter Context is changed", - "items" : { - "type" : "string" - } - } - } - }, - "ComponentValidationResultEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "component" : { - "$ref" : "#/definitions/ComponentValidationResultDTO" - } - }, - "xml" : { - "name" : "componentValidationResultEntity" - } - }, - "ComponentValidationResultsEntity" : { - "type" : "object", - "properties" : { - "validationResults" : { - "type" : "array", - "description" : "A List of ComponentValidationResultEntity, one for each component that is validated", - "items" : { - "$ref" : "#/definitions/ComponentValidationResultEntity" - } - } - }, - "xml" : { - "name" : "componentValidationResults" - } - }, - "ConfigVerificationResultDTO" : { - "type" : "object", - "properties" : { - "outcome" : { - "type" : "string", - "description" : "The outcome of the verification", - "enum" : [ "SUCCESSFUL", "FAILED", "SKIPPED" ] - }, - "verificationStepName" : { - "type" : "string", - "description" : "The name of the verification step" - }, - "explanation" : { - "type" : "string", - "description" : "An explanation of why the step was or was not successful" - } - } - }, - "ConfigurationAnalysisDTO" : { - "type" : "object", - "properties" : { - "componentId" : { - "type" : "string", - "description" : "The ID of the component" - }, - "properties" : { - "type" : "object", - "description" : "The configured properties for the component", - "additionalProperties" : { - "type" : "string" - } - }, - "referencedAttributes" : { - "type" : "object", - "description" : "The attributes that are referenced by the properties, mapped to recently used values", - "additionalProperties" : { - "type" : "string" - } - }, - "supportsVerification" : { - "type" : "boolean", - "description" : "Whether or not the component supports verification" - } - } - }, - "ConfigurationAnalysisEntity" : { - "type" : "object", - "properties" : { - "configurationAnalysis" : { - "description" : "The configuration analysis", - "$ref" : "#/definitions/ConfigurationAnalysisDTO" - } - }, - "xml" : { - "name" : "configurationAnalysis" - } - }, - "ConnectableComponent" : { - "type" : "object", - "required" : [ "groupId", "id", "type" ], - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the connectable component." - }, - "type" : { - "type" : "string", - "description" : "The type of component the connectable is.", - "enum" : [ "PROCESSOR", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "INPUT_PORT", "OUTPUT_PORT", "FUNNEL" ] - }, - "groupId" : { - "type" : "string", - "description" : "The id of the group that the connectable component resides in" - }, - "name" : { - "type" : "string", - "description" : "The name of the connectable component" - }, - "comments" : { - "type" : "string", - "description" : "The comments for the connectable component." - }, - "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" - } - } - }, - "ConnectableDTO" : { - "type" : "object", - "required" : [ "groupId", "id", "type" ], - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the connectable component." - }, - "versionedComponentId" : { - "type" : "string", - "description" : "The ID of the corresponding component that is under version control" - }, - "type" : { - "type" : "string", - "description" : "The type of component the connectable is.", - "enum" : [ "PROCESSOR", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "INPUT_PORT", "OUTPUT_PORT", "FUNNEL" ] - }, - "groupId" : { - "type" : "string", - "description" : "The id of the group that the connectable component resides in" - }, - "name" : { - "type" : "string", - "description" : "The name of the connectable component" - }, - "running" : { - "type" : "boolean", - "description" : "Reflects the current state of the connectable component." - }, - "transmitting" : { - "type" : "boolean", - "description" : "If the connectable component represents a remote port, indicates if the target is configured to transmit." - }, - "exists" : { - "type" : "boolean", - "description" : "If the connectable component represents a remote port, indicates if the target exists." - }, - "comments" : { - "type" : "string", - "description" : "The comments for the connectable component." - } - } - }, - "ConnectionDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "versionedComponentId" : { - "type" : "string", - "description" : "The ID of the corresponding component that is under version control" - }, - "parentGroupId" : { - "type" : "string", - "description" : "The id of parent process group of this component if applicable." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "source" : { - "description" : "The source of the connection.", - "$ref" : "#/definitions/ConnectableDTO" - }, - "destination" : { - "description" : "The destination of the connection.", - "$ref" : "#/definitions/ConnectableDTO" - }, - "name" : { - "type" : "string", - "description" : "The name of the connection." - }, - "labelIndex" : { - "type" : "integer", - "format" : "int32", - "description" : "The index of the bend point where to place the connection label." - }, - "getzIndex" : { - "type" : "integer", - "format" : "int64", - "description" : "The z index of the connection." - }, - "selectedRelationships" : { - "type" : "array", - "description" : "The selected relationship that comprise the connection.", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - }, - "availableRelationships" : { - "type" : "array", - "description" : "The relationships that the source of the connection currently supports.", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - }, - "backPressureObjectThreshold" : { - "type" : "integer", - "format" : "int64", - "description" : "The object count threshold for determining when back pressure is applied. Updating this value is a passive change in the sense that it won't impact whether existing files over the limit are affected but it does help feeder processors to stop pushing too much into this work queue." - }, - "backPressureDataSizeThreshold" : { - "type" : "string", - "description" : "The object data size threshold for determining when back pressure is applied. Updating this value is a passive change in the sense that it won't impact whether existing files over the limit are affected but it does help feeder processors to stop pushing too much into this work queue." - }, - "flowFileExpiration" : { - "type" : "string", - "description" : "The amount of time a flow file may be in the flow before it will be automatically aged out of the flow. Once a flow file reaches this age it will be terminated from the flow the next time a processor attempts to start work on it." - }, - "prioritizers" : { - "type" : "array", - "description" : "The comparators used to prioritize the queue.", - "items" : { - "type" : "string" - } - }, - "bends" : { - "type" : "array", - "description" : "The bend points on the connection.", - "items" : { - "$ref" : "#/definitions/PositionDTO" - } - }, - "loadBalanceStrategy" : { - "type" : "string", - "description" : "How to load balance the data in this Connection across the nodes in the cluster.", - "enum" : [ "DO_NOT_LOAD_BALANCE", "PARTITION_BY_ATTRIBUTE", "ROUND_ROBIN", "SINGLE_NODE" ] - }, - "loadBalancePartitionAttribute" : { - "type" : "string", - "description" : "The FlowFile Attribute to use for determining which node a FlowFile will go to if the Load Balancing Strategy is set to PARTITION_BY_ATTRIBUTE" - }, - "loadBalanceCompression" : { - "type" : "string", - "description" : "Whether or not data should be compressed when being transferred between nodes in the cluster.", - "enum" : [ "DO_NOT_COMPRESS", "COMPRESS_ATTRIBUTES_ONLY", "COMPRESS_ATTRIBUTES_AND_CONTENT" ] - }, - "loadBalanceStatus" : { - "type" : "string", - "description" : "The current status of the Connection's Load Balancing Activities. Status can indicate that Load Balancing is not configured for the connection, that Load Balancing is configured but inactive (not currently transferring data to another node), or that Load Balancing is configured and actively transferring data to another node.", - "enum" : [ "LOAD_BALANCE_NOT_CONFIGURED", "LOAD_BALANCE_INACTIVE", "LOAD_BALANCE_ACTIVE" ] - } - } - }, - "ConnectionDiagnosticsDTO" : { - "type" : "object", - "properties" : { - "connection" : { - "description" : "Details about the connection", - "$ref" : "#/definitions/ConnectionDTO" - }, - "aggregateSnapshot" : { - "description" : "Aggregate values for all nodes in the cluster, or for this instance if not clustered", - "$ref" : "#/definitions/ConnectionDiagnosticsSnapshotDTO" - }, - "nodeSnapshots" : { - "type" : "array", - "description" : "A list of values for each node in the cluster, if clustered.", - "items" : { - "$ref" : "#/definitions/ConnectionDiagnosticsSnapshotDTO" - } - } - } - }, - "ConnectionDiagnosticsSnapshotDTO" : { - "type" : "object", - "properties" : { - "totalFlowFileCount" : { - "type" : "integer", - "format" : "int32", - "description" : "Total number of FlowFiles owned by the Connection" - }, - "totalByteCount" : { - "type" : "integer", - "format" : "int64", - "description" : "Total number of bytes that make up the content for the FlowFiles owned by this Connection" - }, - "nodeIdentifier" : { - "type" : "string", - "description" : "The Node Identifier that this information pertains to" - }, - "localQueuePartition" : { - "description" : "The local queue partition, from which components can pull FlowFiles on this node.", - "$ref" : "#/definitions/LocalQueuePartitionDTO" - }, - "remoteQueuePartitions" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/RemoteQueuePartitionDTO" - } - } - } - }, - "ConnectionEntity" : { - "type" : "object", - "required" : [ "destinationType", "sourceType" ], - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "component" : { - "$ref" : "#/definitions/ConnectionDTO" - }, - "status" : { - "description" : "The status of the connection.", - "$ref" : "#/definitions/ConnectionStatusDTO" - }, - "bends" : { - "type" : "array", - "description" : "The bend points on the connection.", - "items" : { - "$ref" : "#/definitions/PositionDTO" - } - }, - "labelIndex" : { - "type" : "integer", - "format" : "int32", - "description" : "The index of the bend point where to place the connection label." - }, - "getzIndex" : { - "type" : "integer", - "format" : "int64", - "description" : "The z index of the connection." - }, - "sourceId" : { - "type" : "string", - "description" : "The identifier of the source of this connection." - }, - "sourceGroupId" : { - "type" : "string", - "description" : "The identifier of the group of the source of this connection." - }, - "sourceType" : { - "type" : "string", - "description" : "The type of component the source connectable is.", - "enum" : [ "PROCESSOR", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "INPUT_PORT", "OUTPUT_PORT", "FUNNEL" ] - }, - "destinationId" : { - "type" : "string", - "description" : "The identifier of the destination of this connection." - }, - "destinationGroupId" : { - "type" : "string", - "description" : "The identifier of the group of the destination of this connection." - }, - "destinationType" : { - "type" : "string", - "description" : "The type of component the destination connectable is.", - "enum" : [ "PROCESSOR", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "INPUT_PORT", "OUTPUT_PORT", "FUNNEL" ] - } - }, - "xml" : { - "name" : "connectionEntity" - } - }, - "ConnectionStatisticsDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The ID of the connection" - }, - "statsLastRefreshed" : { - "type" : "string", - "description" : "The timestamp of when the stats were last refreshed" - }, - "aggregateSnapshot" : { - "description" : "The status snapshot that represents the aggregate stats of the cluster", - "$ref" : "#/definitions/ConnectionStatisticsSnapshotDTO" - }, - "nodeSnapshots" : { - "type" : "array", - "description" : "A list of status snapshots for each node", - "items" : { - "$ref" : "#/definitions/NodeConnectionStatisticsSnapshotDTO" - } - } - } - }, - "ConnectionStatisticsEntity" : { - "type" : "object", - "properties" : { - "connectionStatistics" : { - "$ref" : "#/definitions/ConnectionStatisticsDTO" - }, - "canRead" : { - "type" : "boolean", - "description" : "Indicates whether the user can read a given resource." - } - }, - "xml" : { - "name" : "connectionStatisticsEntity" - } - }, - "ConnectionStatisticsSnapshotDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the connection." - }, - "predictedMillisUntilCountBackpressure" : { - "type" : "integer", - "format" : "int64", - "description" : "The predicted number of milliseconds before the connection will have backpressure applied, based on the queued count." - }, - "predictedMillisUntilBytesBackpressure" : { - "type" : "integer", - "format" : "int64", - "description" : "The predicted number of milliseconds before the connection will have backpressure applied, based on the total number of bytes in the queue." - }, - "predictedCountAtNextInterval" : { - "type" : "integer", - "format" : "int32", - "description" : "The predicted number of queued objects at the next configured interval." - }, - "predictedBytesAtNextInterval" : { - "type" : "integer", - "format" : "int64", - "description" : "The predicted total number of bytes in the queue at the next configured interval." - }, - "predictedPercentCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The predicted percentage of queued objects at the next configured interval." - }, - "predictedPercentBytes" : { - "type" : "integer", - "format" : "int32", - "description" : "The predicted percentage of bytes in the queue against current threshold at the next configured interval." - }, - "predictionIntervalMillis" : { - "type" : "integer", - "format" : "int64", - "description" : "The prediction interval in seconds" - } - } - }, - "ConnectionStatusDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The ID of the connection" - }, - "groupId" : { - "type" : "string", - "description" : "The ID of the Process Group that the connection belongs to" - }, - "name" : { - "type" : "string", - "description" : "The name of the connection" - }, - "statsLastRefreshed" : { - "type" : "string", - "description" : "The timestamp of when the stats were last refreshed" - }, - "sourceId" : { - "type" : "string", - "description" : "The ID of the source component" - }, - "sourceName" : { - "type" : "string", - "description" : "The name of the source component" - }, - "destinationId" : { - "type" : "string", - "description" : "The ID of the destination component" - }, - "destinationName" : { - "type" : "string", - "description" : "The name of the destination component" - }, - "aggregateSnapshot" : { - "description" : "The status snapshot that represents the aggregate stats of the cluster", - "$ref" : "#/definitions/ConnectionStatusSnapshotDTO" - }, - "nodeSnapshots" : { - "type" : "array", - "description" : "A list of status snapshots for each node", - "items" : { - "$ref" : "#/definitions/NodeConnectionStatusSnapshotDTO" - } - } - } - }, - "ConnectionStatusEntity" : { - "type" : "object", - "properties" : { - "connectionStatus" : { - "$ref" : "#/definitions/ConnectionStatusDTO" - }, - "canRead" : { - "type" : "boolean", - "description" : "Indicates whether the user can read a given resource." - } - }, - "xml" : { - "name" : "connectionStatusEntity" - } - }, - "ConnectionStatusPredictionsSnapshotDTO" : { - "type" : "object", - "properties" : { - "predictedMillisUntilCountBackpressure" : { - "type" : "integer", - "format" : "int64", - "description" : "The predicted number of milliseconds before the connection will have backpressure applied, based on the queued count." - }, - "predictedMillisUntilBytesBackpressure" : { - "type" : "integer", - "format" : "int64", - "description" : "The predicted number of milliseconds before the connection will have backpressure applied, based on the total number of bytes in the queue." - }, - "predictionIntervalSeconds" : { - "type" : "integer", - "format" : "int32", - "description" : "The configured interval (in seconds) for predicting connection queue count and size (and percent usage)." - }, - "predictedCountAtNextInterval" : { - "type" : "integer", - "format" : "int32", - "description" : "The predicted number of queued objects at the next configured interval." - }, - "predictedBytesAtNextInterval" : { - "type" : "integer", - "format" : "int64", - "description" : "The predicted total number of bytes in the queue at the next configured interval." - }, - "predictedPercentCount" : { - "type" : "integer", - "format" : "int32", - "description" : "Predicted connection percent use regarding queued flow files count and backpressure threshold if configured." - }, - "predictedPercentBytes" : { - "type" : "integer", - "format" : "int32", - "description" : "Predicted connection percent use regarding queued flow files size and backpressure threshold if configured." - } - } - }, - "ConnectionStatusSnapshotDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the connection." - }, - "groupId" : { - "type" : "string", - "description" : "The id of the process group the connection belongs to." - }, - "name" : { - "type" : "string", - "description" : "The name of the connection." - }, - "sourceId" : { - "type" : "string", - "description" : "The id of the source of the connection." - }, - "sourceName" : { - "type" : "string", - "description" : "The name of the source of the connection." - }, - "destinationId" : { - "type" : "string", - "description" : "The id of the destination of the connection." - }, - "destinationName" : { - "type" : "string", - "description" : "The name of the destination of the connection." - }, - "predictions" : { - "description" : "Predictions, if available, for this connection (null if not available)", - "$ref" : "#/definitions/ConnectionStatusPredictionsSnapshotDTO" - }, - "flowFilesIn" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of FlowFiles that have come into the connection in the last 5 minutes." - }, - "bytesIn" : { - "type" : "integer", - "format" : "int64", - "description" : "The size of the FlowFiles that have come into the connection in the last 5 minutes." - }, - "input" : { - "type" : "string", - "description" : "The input count/size for the connection in the last 5 minutes, pretty printed." - }, - "flowFilesOut" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of FlowFiles that have left the connection in the last 5 minutes." - }, - "bytesOut" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes that have left the connection in the last 5 minutes." - }, - "output" : { - "type" : "string", - "description" : "The output count/sie for the connection in the last 5 minutes, pretty printed." - }, - "flowFilesQueued" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of FlowFiles that are currently queued in the connection." - }, - "bytesQueued" : { - "type" : "integer", - "format" : "int64", - "description" : "The size of the FlowFiles that are currently queued in the connection." - }, - "queued" : { - "type" : "string", - "description" : "The total count and size of queued flowfiles formatted." - }, - "queuedSize" : { - "type" : "string", - "description" : "The total size of flowfiles that are queued formatted." - }, - "queuedCount" : { - "type" : "string", - "description" : "The number of flowfiles that are queued, pretty printed." - }, - "percentUseCount" : { - "type" : "integer", - "format" : "int32", - "description" : "Connection percent use regarding queued flow files count and backpressure threshold if configured." - }, - "percentUseBytes" : { - "type" : "integer", - "format" : "int32", - "description" : "Connection percent use regarding queued flow files size and backpressure threshold if configured." - }, - "flowFileAvailability" : { - "type" : "string", - "description" : "The availability of FlowFiles in this connection" - } - } - }, - "ConnectionStatusSnapshotEntity" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the connection." - }, - "connectionStatusSnapshot" : { - "$ref" : "#/definitions/ConnectionStatusSnapshotDTO" - }, - "canRead" : { - "type" : "boolean", - "description" : "Indicates whether the user can read a given resource." - } - }, - "xml" : { - "name" : "entity" - } - }, - "ConnectionsEntity" : { - "type" : "object", - "properties" : { - "connections" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ConnectionEntity" - } - } - }, - "xml" : { - "name" : "connectionsEntity" - } - }, - "ControllerBulletinsEntity" : { - "type" : "object", - "properties" : { - "bulletins" : { - "type" : "array", - "description" : "System level bulletins to be reported to the user.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "controllerServiceBulletins" : { - "type" : "array", - "description" : "Controller service bulletins to be reported to the user.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "reportingTaskBulletins" : { - "type" : "array", - "description" : "Reporting task bulletins to be reported to the user.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - } - }, - "xml" : { - "name" : "controllerConfigurationEntity" - } - }, - "ControllerConfigurationDTO" : { - "type" : "object", - "properties" : { - "maxTimerDrivenThreadCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The maximum number of timer driven threads the NiFi has available." - }, - "maxEventDrivenThreadCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The maximum number of event driven threads the NiFi has available." - } - } - }, - "ControllerConfigurationEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "component" : { - "description" : "The controller configuration.", - "$ref" : "#/definitions/ControllerConfigurationDTO" - } - }, - "xml" : { - "name" : "controllerConfigurationEntity" - } - }, - "ControllerDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the NiFi." - }, - "name" : { - "type" : "string", - "description" : "The name of the NiFi." - }, - "comments" : { - "type" : "string", - "description" : "The comments for the NiFi." - }, - "runningCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of running components in the NiFi." - }, - "stoppedCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of stopped components in the NiFi." - }, - "invalidCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of invalid components in the NiFi." - }, - "disabledCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of disabled components in the NiFi." - }, - "activeRemotePortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of active remote ports contained in the NiFi." - }, - "inactiveRemotePortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of inactive remote ports contained in the NiFi." - }, - "inputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of input ports contained in the NiFi." - }, - "outputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of output ports in the NiFi." - }, - "remoteSiteListeningPort" : { - "type" : "integer", - "format" : "int32", - "description" : "The Socket Port on which this instance is listening for Remote Transfers of Flow Files. If this instance is not configured to receive Flow Files from remote instances, this will be null." - }, - "remoteSiteHttpListeningPort" : { - "type" : "integer", - "format" : "int32", - "description" : "The HTTP(S) Port on which this instance is listening for Remote Transfers of Flow Files. If this instance is not configured to receive Flow Files from remote instances, this will be null." - }, - "siteToSiteSecure" : { - "type" : "boolean", - "description" : "Indicates whether or not Site-to-Site communications with this instance is secure (2-way authentication)." - }, - "instanceId" : { - "type" : "string", - "description" : "If clustered, the id of the Cluster Manager, otherwise the id of the NiFi." - }, - "inputPorts" : { - "type" : "array", - "description" : "The input ports available to send data to for the NiFi.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/PortDTO" - } - }, - "outputPorts" : { - "type" : "array", - "description" : "The output ports available to received data from the NiFi.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/PortDTO" - } - } - } - }, - "ControllerEntity" : { - "type" : "object", - "properties" : { - "controller" : { - "$ref" : "#/definitions/ControllerDTO" - } - }, - "xml" : { - "name" : "controllerEntity" - } - }, - "ControllerServiceAPI" : { - "type" : "object", - "properties" : { - "type" : { - "type" : "string", - "description" : "The fully qualified name of the service interface." - }, - "bundle" : { - "description" : "The details of the artifact that bundled this service interface.", - "$ref" : "#/definitions/Bundle" - } - } - }, - "ControllerServiceApiDTO" : { - "type" : "object", - "properties" : { - "type" : { - "type" : "string", - "description" : "The fully qualified name of the service interface." - }, - "bundle" : { - "description" : "The details of the artifact that bundled this service interface.", - "$ref" : "#/definitions/BundleDTO" - } - } - }, - "ControllerServiceDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "versionedComponentId" : { - "type" : "string", - "description" : "The ID of the corresponding component that is under version control" - }, - "parentGroupId" : { - "type" : "string", - "description" : "The id of parent process group of this component if applicable." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "name" : { - "type" : "string", - "description" : "The name of the controller service." - }, - "type" : { - "type" : "string", - "description" : "The type of the controller service." - }, - "bundle" : { - "description" : "The details of the artifact that bundled this processor type.", - "$ref" : "#/definitions/BundleDTO" - }, - "controllerServiceApis" : { - "type" : "array", - "description" : "Lists the APIs this Controller Service implements.", - "items" : { - "$ref" : "#/definitions/ControllerServiceApiDTO" - } - }, - "comments" : { - "type" : "string", - "description" : "The comments for the controller service." - }, - "state" : { - "type" : "string", - "description" : "The state of the controller service.", - "enum" : [ "ENABLED", "ENABLING", "DISABLED", "DISABLING" ] - }, - "persistsState" : { - "type" : "boolean", - "description" : "Whether the controller service persists state." - }, - "restricted" : { - "type" : "boolean", - "description" : "Whether the controller service requires elevated privileges." - }, - "deprecated" : { - "type" : "boolean", - "description" : "Whether the ontroller service has been deprecated." - }, - "multipleVersionsAvailable" : { - "type" : "boolean", - "description" : "Whether the controller service has multiple versions available." - }, - "properties" : { - "type" : "object", - "description" : "The properties of the controller service.", - "additionalProperties" : { - "type" : "string" - } - }, - "descriptors" : { - "type" : "object", - "description" : "The descriptors for the controller service properties.", - "additionalProperties" : { - "$ref" : "#/definitions/PropertyDescriptorDTO" - } - }, - "customUiUrl" : { - "type" : "string", - "description" : "The URL for the controller services custom configuration UI if applicable." - }, - "annotationData" : { - "type" : "string", - "description" : "The annotation for the controller service. This is how the custom UI relays configuration to the controller service." - }, - "referencingComponents" : { - "type" : "array", - "description" : "All components referencing this controller service.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ControllerServiceReferencingComponentEntity" - } - }, - "validationErrors" : { - "type" : "array", - "description" : "The validation errors from the controller service. These validation errors represent the problems with the controller service that must be resolved before it can be enabled.", - "items" : { - "type" : "string" - } - }, - "validationStatus" : { - "type" : "string", - "description" : "Indicates whether the ControllerService is valid, invalid, or still in the process of validating (i.e., it is unknown whether or not the ControllerService is valid)", - "enum" : [ "VALID", "INVALID", "VALIDATING" ] - }, - "extensionMissing" : { - "type" : "boolean", - "description" : "Whether the underlying extension is missing." - } - } - }, - "ControllerServiceDefinition" : { - "type" : "object", - "required" : [ "type" ], - "properties" : { - "group" : { - "type" : "string", - "description" : "The group name of the bundle that provides the referenced type." - }, - "artifact" : { - "type" : "string", - "description" : "The artifact name of the bundle that provides the referenced type." - }, - "version" : { - "type" : "string", - "description" : "The version 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." - }, - "buildInfo" : { - "description" : "The build metadata for this component", - "$ref" : "#/definitions/BuildInfo" - }, - "providedApiImplementations" : { - "type" : "array", - "description" : "If this type represents a provider for an interface, this lists the APIs it implements", - "items" : { - "$ref" : "#/definitions/DefinedType" - } - }, - "tags" : { - "type" : "array", - "description" : "The tags associated with this type", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - }, - "deprecated" : { - "type" : "boolean", - "description" : "Whether or not the component has been deprecated" - }, - "deprecationReason" : { - "type" : "string", - "description" : "If this component has been deprecated, this optional field can be used to provide an explanation" - }, - "propertyDescriptors" : { - "type" : "object", - "description" : "Descriptions of configuration properties applicable to this component.", - "additionalProperties" : { - "$ref" : "#/definitions/PropertyDescriptor" - } - }, - "supportsDynamicProperties" : { - "type" : "boolean", - "description" : "Whether or not this component makes use of dynamic (user-set) properties." - } - } - }, - "ControllerServiceDiagnosticsDTO" : { - "type" : "object", - "properties" : { - "controllerService" : { - "description" : "The Controller Service", - "$ref" : "#/definitions/ControllerServiceEntity" - }, - "classLoaderDiagnostics" : { - "description" : "Information about the Controller Service's Class Loader", - "$ref" : "#/definitions/ClassLoaderDiagnosticsDTO" - } - } - }, - "ControllerServiceEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "parentGroupId" : { - "type" : "string", - "description" : "The id of parent process group of this ControllerService." - }, - "component" : { - "$ref" : "#/definitions/ControllerServiceDTO" - }, - "operatePermissions" : { - "description" : "The permissions for this component operations.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "status" : { - "description" : "The status for this ControllerService.", - "$ref" : "#/definitions/ControllerServiceStatusDTO" - } - }, - "xml" : { - "name" : "controllerServiceEntity" - } - }, - "ControllerServiceReferencingComponentDTO" : { - "type" : "object", - "properties" : { - "groupId" : { - "type" : "string", - "description" : "The group id for the component referencing a controller service. If this component is another controller service or a reporting task, this field is blank." - }, - "id" : { - "type" : "string", - "description" : "The id of the component referencing a controller service." - }, - "name" : { - "type" : "string", - "description" : "The name of the component referencing a controller service." - }, - "type" : { - "type" : "string", - "description" : "The type of the component referencing a controller service in simple Java class name format without package name." - }, - "state" : { - "type" : "string", - "description" : "The scheduled state of a processor or reporting task referencing a controller service. If this component is another controller service, this field represents the controller service state." - }, - "properties" : { - "type" : "object", - "description" : "The properties for the component.", - "additionalProperties" : { - "type" : "string" - } - }, - "descriptors" : { - "type" : "object", - "description" : "The descriptors for the component properties.", - "additionalProperties" : { - "$ref" : "#/definitions/PropertyDescriptorDTO" - } - }, - "validationErrors" : { - "type" : "array", - "description" : "The validation errors for the component.", - "items" : { - "type" : "string" - } - }, - "referenceType" : { - "type" : "string", - "description" : "The type of reference this is.", - "enum" : [ "Processor", "ControllerService", "ReportingTask" ] - }, - "activeThreadCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of active threads for the referencing component." - }, - "referenceCycle" : { - "type" : "boolean", - "description" : "If the referencing component represents a controller service, this indicates whether it has already been represented in this hierarchy." - }, - "referencingComponents" : { - "type" : "array", - "description" : "If the referencing component represents a controller service, these are the components that reference it.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ControllerServiceReferencingComponentEntity" - } - } - } - }, - "ControllerServiceReferencingComponentEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "component" : { - "$ref" : "#/definitions/ControllerServiceReferencingComponentDTO" - }, - "operatePermissions" : { - "description" : "The permissions for this component operations.", - "$ref" : "#/definitions/PermissionsDTO" - } - }, - "xml" : { - "name" : "controllerServiceReferencingComponentEntity" - } - }, - "ControllerServiceReferencingComponentsEntity" : { - "type" : "object", - "properties" : { - "controllerServiceReferencingComponents" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ControllerServiceReferencingComponentEntity" - } - } - }, - "xml" : { - "name" : "controllerServiceReferencingComponentsEntity" - } - }, - "ControllerServiceRunStatusEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "state" : { - "type" : "string", - "description" : "The run status of the ControllerService.", - "enum" : [ "ENABLED", "DISABLED" ] - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "uiOnly" : { - "type" : "boolean", - "description" : "Indicates whether or not responses should only include fields necessary for rendering the NiFi User Interface. As such, when this value is set to true, some fields may be returned as null values, and the selected fields may change at any time without notice. As a result, this value should not be set to true by any client other than the UI." - } - }, - "xml" : { - "name" : "entity" - } - }, - "ControllerServiceStatusDTO" : { - "type" : "object", - "properties" : { - "runStatus" : { - "type" : "string", - "description" : "The run status of this ControllerService", - "enum" : [ "ENABLED", "ENABLING", "DISABLED", "DISABLING" ] - }, - "validationStatus" : { - "type" : "string", - "description" : "Indicates whether the component is valid, invalid, or still in the process of validating (i.e., it is unknown whether or not the component is valid)", - "enum" : [ "VALID", "INVALID", "VALIDATING" ] - }, - "activeThreadCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of active threads for the component." - } - } - }, - "ControllerServiceTypesEntity" : { - "type" : "object", - "properties" : { - "controllerServiceTypes" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/DocumentedTypeDTO" - } - } - }, - "xml" : { - "name" : "controllerServiceTypesEntity" - } - }, - "ControllerServicesEntity" : { - "type" : "object", - "properties" : { - "currentTime" : { - "type" : "string", - "description" : "The current time on the system." - }, - "controllerServices" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ControllerServiceEntity" - } - } - }, - "xml" : { - "name" : "controllerServicesEntity" - } - }, - "ControllerStatusDTO" : { - "type" : "object", - "properties" : { - "activeThreadCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of active threads in the NiFi." - }, - "terminatedThreadCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of terminated threads in the NiFi." - }, - "queued" : { - "type" : "string", - "description" : "The number of flowfiles queued in the NiFi." - }, - "flowFilesQueued" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of FlowFiles queued across the entire flow" - }, - "bytesQueued" : { - "type" : "integer", - "format" : "int64", - "description" : "The size of the FlowFiles queued across the entire flow" - }, - "runningCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of running components in the NiFi." - }, - "stoppedCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of stopped components in the NiFi." - }, - "invalidCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of invalid components in the NiFi." - }, - "disabledCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of disabled components in the NiFi." - }, - "activeRemotePortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of active remote ports in the NiFi." - }, - "inactiveRemotePortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of inactive remote ports in the NiFi." - }, - "upToDateCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of up to date versioned process groups in the NiFi." - }, - "locallyModifiedCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of locally modified versioned process groups in the NiFi." - }, - "staleCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of stale versioned process groups in the NiFi." - }, - "locallyModifiedAndStaleCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of locally modified and stale versioned process groups in the NiFi." - }, - "syncFailureCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of versioned process groups in the NiFi that are unable to sync to a registry." - } - } - }, - "ControllerStatusEntity" : { - "type" : "object", - "properties" : { - "controllerStatus" : { - "$ref" : "#/definitions/ControllerStatusDTO" - } - }, - "xml" : { - "name" : "controllerStatusEntity" - } - }, - "CopySnippetRequestEntity" : { - "type" : "object", - "properties" : { - "snippetId" : { - "type" : "string", - "description" : "The identifier of the snippet." - }, - "originX" : { - "type" : "number", - "format" : "double", - "description" : "The x coordinate of the origin of the bounding box where the new components will be placed." - }, - "originY" : { - "type" : "number", - "format" : "double", - "description" : "The y coordinate of the origin of the bounding box where the new components will be placed." - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - } - }, - "xml" : { - "name" : "copySnippetRequestEntity" - } - }, - "CounterDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the counter." - }, - "context" : { - "type" : "string", - "description" : "The context of the counter." - }, - "name" : { - "type" : "string", - "description" : "The name of the counter." - }, - "valueCount" : { - "type" : "integer", - "format" : "int64", - "description" : "The value count." - }, - "value" : { - "type" : "string", - "description" : "The value of the counter." - } - } - }, - "CounterEntity" : { - "type" : "object", - "properties" : { - "counter" : { - "$ref" : "#/definitions/CounterDTO" - } - }, - "xml" : { - "name" : "counterEntity" - } - }, - "CountersDTO" : { - "type" : "object", - "properties" : { - "aggregateSnapshot" : { - "description" : "A Counters snapshot that represents the aggregate values of all nodes in the cluster. If the NiFi instance is a standalone instance, rather than a cluster, this represents the stats of the single instance.", - "$ref" : "#/definitions/CountersSnapshotDTO" - }, - "nodeSnapshots" : { - "type" : "array", - "description" : "A Counters snapshot for each node in the cluster. If the NiFi instance is a standalone instance, rather than a cluster, this may be null.", - "items" : { - "$ref" : "#/definitions/NodeCountersSnapshotDTO" - } - } - } - }, - "CountersEntity" : { - "type" : "object", - "properties" : { - "counters" : { - "$ref" : "#/definitions/CountersDTO" - } - }, - "xml" : { - "name" : "countersEntity" - } - }, - "CountersSnapshotDTO" : { - "type" : "object", - "properties" : { - "generated" : { - "type" : "string", - "description" : "The timestamp when the report was generated." - }, - "counters" : { - "type" : "array", - "description" : "All counters in the NiFi.", - "items" : { - "$ref" : "#/definitions/CounterDTO" - } - } - } - }, - "CreateActiveRequestEntity" : { - "type" : "object", - "properties" : { - "processGroupId" : { - "type" : "string", - "description" : "The Process Group ID that this active request will update" - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - } - }, - "xml" : { - "name" : "createActiveRequestEntity" - } - }, - "CreateTemplateRequestEntity" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The name of the template." - }, - "description" : { - "type" : "string", - "description" : "The description of the template." - }, - "snippetId" : { - "type" : "string", - "description" : "The identifier of the snippet." - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - } - }, - "xml" : { - "name" : "createTemplateRequestEntity" - } - }, - "CurrentUserEntity" : { - "type" : "object", - "properties" : { - "identity" : { - "type" : "string", - "description" : "The user identity being serialized." - }, - "anonymous" : { - "type" : "boolean", - "description" : "Whether the current user is anonymous." - }, - "provenancePermissions" : { - "description" : "Permissions for querying provenance.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "countersPermissions" : { - "description" : "Permissions for accessing counters.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "tenantsPermissions" : { - "description" : "Permissions for accessing tenants.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "controllerPermissions" : { - "description" : "Permissions for accessing the controller.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "policiesPermissions" : { - "description" : "Permissions for accessing the policies.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "systemPermissions" : { - "description" : "Permissions for accessing system.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "parameterContextPermissions" : { - "description" : "Permissions for accessing parameter contexts.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "restrictedComponentsPermissions" : { - "description" : "Permissions for accessing restricted components. Note: the read permission are not used and will always be false.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "componentRestrictionPermissions" : { - "type" : "array", - "description" : "Permissions for specific component restrictions.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ComponentRestrictionPermissionDTO" - } - }, - "canVersionFlows" : { - "type" : "boolean", - "description" : "Whether the current user can version flows." - } - }, - "xml" : { - "name" : "currentEntity" - } - }, - "DefinedType" : { - "type" : "object", - "required" : [ "type" ], - "properties" : { - "group" : { - "type" : "string", - "description" : "The group name of the bundle that provides the referenced type." - }, - "artifact" : { - "type" : "string", - "description" : "The artifact name of the bundle that provides the referenced type." - }, - "version" : { - "type" : "string", - "description" : "The version 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." - } - } - }, - "DifferenceDTO" : { - "type" : "object", - "properties" : { - "differenceType" : { - "type" : "string", - "description" : "The type of difference" - }, - "difference" : { - "type" : "string", - "description" : "Description of the difference" - } - } - }, - "DimensionsDTO" : { - "type" : "object", - "properties" : { - "width" : { - "type" : "number", - "format" : "double", - "description" : "The width of the label in pixels when at a 1:1 scale." - }, - "height" : { - "type" : "number", - "format" : "double", - "description" : "The height of the label in pixels when at a 1:1 scale." - } - } - }, - "DocumentedTypeDTO" : { - "type" : "object", - "properties" : { - "type" : { - "type" : "string", - "description" : "The fully qualified name of the type." - }, - "bundle" : { - "description" : "The details of the artifact that bundled this type.", - "$ref" : "#/definitions/BundleDTO" - }, - "controllerServiceApis" : { - "type" : "array", - "description" : "If this type represents a ControllerService, this lists the APIs it implements.", - "items" : { - "$ref" : "#/definitions/ControllerServiceApiDTO" - } - }, - "description" : { - "type" : "string", - "description" : "The description of the type." - }, - "restricted" : { - "type" : "boolean", - "description" : "Whether this type is restricted." - }, - "usageRestriction" : { - "type" : "string", - "description" : "The optional description of why the usage of this component is restricted." - }, - "explicitRestrictions" : { - "type" : "array", - "description" : "An optional collection of explicit restrictions. If specified, these explicit restrictions will be enfored.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ExplicitRestrictionDTO" - } - }, - "deprecationReason" : { - "type" : "string", - "description" : "The description of why the usage of this component is restricted." - }, - "tags" : { - "type" : "array", - "description" : "The tags associated with this type.", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - } - } - }, - "DropRequestDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id for this drop request." - }, - "uri" : { - "type" : "string", - "description" : "The URI for future requests to this drop request." - }, - "submissionTime" : { - "type" : "string", - "description" : "The timestamp when the query was submitted." - }, - "lastUpdated" : { - "type" : "string", - "description" : "The last time this drop request was updated." - }, - "percentCompleted" : { - "type" : "integer", - "format" : "int32", - "description" : "The current percent complete." - }, - "finished" : { - "type" : "boolean", - "description" : "Whether the query has finished." - }, - "failureReason" : { - "type" : "string", - "description" : "The reason, if any, that this drop request failed." - }, - "currentCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of flow files currently queued." - }, - "currentSize" : { - "type" : "integer", - "format" : "int64", - "description" : "The size of flow files currently queued in bytes." - }, - "current" : { - "type" : "string", - "description" : "The count and size of flow files currently queued." - }, - "originalCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of flow files to be dropped as a result of this request." - }, - "originalSize" : { - "type" : "integer", - "format" : "int64", - "description" : "The size of flow files to be dropped as a result of this request in bytes." - }, - "original" : { - "type" : "string", - "description" : "The count and size of flow files to be dropped as a result of this request." - }, - "droppedCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of flow files that have been dropped thus far." - }, - "droppedSize" : { - "type" : "integer", - "format" : "int64", - "description" : "The size of flow files that have been dropped thus far in bytes." - }, - "dropped" : { - "type" : "string", - "description" : "The count and size of flow files that have been dropped thus far." - }, - "state" : { - "type" : "string", - "description" : "The current state of the drop request." - } - } - }, - "DropRequestEntity" : { - "type" : "object", - "properties" : { - "dropRequest" : { - "$ref" : "#/definitions/DropRequestDTO" - } - }, - "xml" : { - "name" : "dropRequestEntity" - } - }, - "ExplicitRestrictionDTO" : { - "type" : "object", - "properties" : { - "requiredPermission" : { - "description" : "The required permission necessary for this restriction.", - "$ref" : "#/definitions/RequiredPermissionDTO" - }, - "explanation" : { - "type" : "string", - "description" : "The description of why the usage of this component is restricted for this required permission." - } - } - }, - "ExternalControllerServiceReference" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The identifier of the controller service" - }, - "name" : { - "type" : "string", - "description" : "The name of the controller service" - } - } - }, - "FlowBreadcrumbDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the group." - }, - "name" : { - "type" : "string", - "description" : "The id of the group." - }, - "versionControlInformation" : { - "description" : "The process group version control information or null if not version controlled.", - "$ref" : "#/definitions/VersionControlInformationDTO" - } - } - }, - "FlowBreadcrumbEntity" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of this ancestor ProcessGroup." - }, - "permissions" : { - "description" : "The permissions for this ancestor ProcessGroup.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "versionedFlowState" : { - "type" : "string", - "description" : "The current state of the Process Group, as it relates to the Versioned Flow", - "enum" : [ "LOCALLY_MODIFIED", "STALE", "LOCALLY_MODIFIED_AND_STALE", "UP_TO_DATE", "SYNC_FAILURE" ] - }, - "breadcrumb" : { - "description" : "This breadcrumb.", - "$ref" : "#/definitions/FlowBreadcrumbDTO" - }, - "parentBreadcrumb" : { - "description" : "The parent breadcrumb for this breadcrumb.", - "$ref" : "#/definitions/FlowBreadcrumbEntity" - } - }, - "xml" : { - "name" : "flowEntity" - } - }, - "FlowComparisonEntity" : { - "type" : "object", - "properties" : { - "componentDifferences" : { - "type" : "array", - "description" : "The list of differences for each component in the flow that is not the same between the two flows", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ComponentDifferenceDTO" - } - } - }, - "xml" : { - "name" : "flowComparisonEntity" - } - }, - "FlowConfigurationDTO" : { - "type" : "object", - "properties" : { - "supportsManagedAuthorizer" : { - "type" : "boolean", - "description" : "Whether this NiFi supports a managed authorizer. Managed authorizers can visualize users, groups, and policies in the UI." - }, - "supportsConfigurableAuthorizer" : { - "type" : "boolean", - "description" : "Whether this NiFi supports a configurable authorizer." - }, - "supportsConfigurableUsersAndGroups" : { - "type" : "boolean", - "description" : "Whether this NiFi supports configurable users and groups." - }, - "autoRefreshIntervalSeconds" : { - "type" : "integer", - "format" : "int64", - "description" : "The interval in seconds between the automatic NiFi refresh requests." - }, - "currentTime" : { - "type" : "string", - "description" : "The current time on the system." - }, - "timeOffset" : { - "type" : "integer", - "format" : "int32", - "description" : "The time offset of the system." - }, - "defaultBackPressureObjectThreshold" : { - "type" : "integer", - "format" : "int64", - "description" : "The default back pressure object threshold." - }, - "defaultBackPressureDataSizeThreshold" : { - "type" : "string", - "description" : "The default back pressure data size threshold." - } - } - }, - "FlowConfigurationEntity" : { - "type" : "object", - "properties" : { - "flowConfiguration" : { - "description" : "The controller configuration.", - "$ref" : "#/definitions/FlowConfigurationDTO" - } - }, - "xml" : { - "name" : "flowConfigurationEntity" - } - }, - "FlowDTO" : { - "type" : "object", - "properties" : { - "processGroups" : { - "type" : "array", - "description" : "The process groups in this flow.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ProcessGroupEntity" - } - }, - "remoteProcessGroups" : { - "type" : "array", - "description" : "The remote process groups in this flow.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/RemoteProcessGroupEntity" - } - }, - "processors" : { - "type" : "array", - "description" : "The processors in this flow.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ProcessorEntity" - } - }, - "inputPorts" : { - "type" : "array", - "description" : "The input ports in this flow.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/PortEntity" - } - }, - "outputPorts" : { - "type" : "array", - "description" : "The output ports in this flow.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/PortEntity" - } - }, - "connections" : { - "type" : "array", - "description" : "The connections in this flow.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ConnectionEntity" - } - }, - "labels" : { - "type" : "array", - "description" : "The labels in this flow.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/LabelEntity" - } - }, - "funnels" : { - "type" : "array", - "description" : "The funnels in this flow.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/FunnelEntity" - } - } - } - }, - "FlowEntity" : { - "type" : "object", - "properties" : { - "flow" : { - "$ref" : "#/definitions/FlowDTO" - } - }, - "xml" : { - "name" : "flowEntity" - } - }, - "FlowFileDTO" : { - "type" : "object", - "properties" : { - "uri" : { - "type" : "string", - "description" : "The URI that can be used to access this FlowFile." - }, - "uuid" : { - "type" : "string", - "description" : "The FlowFile UUID." - }, - "filename" : { - "type" : "string", - "description" : "The FlowFile filename." - }, - "position" : { - "type" : "integer", - "format" : "int32", - "description" : "The FlowFile's position in the queue." - }, - "size" : { - "type" : "integer", - "format" : "int64", - "description" : "The FlowFile file size." - }, - "queuedDuration" : { - "type" : "integer", - "format" : "int64", - "description" : "How long this FlowFile has been enqueued." - }, - "lineageDuration" : { - "type" : "integer", - "format" : "int64", - "description" : "Duration since the FlowFile's greatest ancestor entered the flow." - }, - "penaltyExpiresIn" : { - "type" : "integer", - "format" : "int64", - "description" : "How long in milliseconds until the FlowFile penalty expires." - }, - "clusterNodeId" : { - "type" : "string", - "description" : "The id of the node where this FlowFile resides." - }, - "clusterNodeAddress" : { - "type" : "string", - "description" : "The label for the node where this FlowFile resides." - }, - "attributes" : { - "type" : "object", - "description" : "The FlowFile attributes.", - "additionalProperties" : { - "type" : "string" - } - }, - "contentClaimSection" : { - "type" : "string", - "description" : "The section in which the content claim lives." - }, - "contentClaimContainer" : { - "type" : "string", - "description" : "The container in which the content claim lives." - }, - "contentClaimIdentifier" : { - "type" : "string", - "description" : "The identifier of the content claim." - }, - "contentClaimOffset" : { - "type" : "integer", - "format" : "int64", - "description" : "The offset into the content claim where the flowfile's content begins." - }, - "contentClaimFileSize" : { - "type" : "string", - "description" : "The file size of the content claim formatted." - }, - "contentClaimFileSizeBytes" : { - "type" : "integer", - "format" : "int64", - "description" : "The file size of the content claim in bytes." - }, - "penalized" : { - "type" : "boolean", - "description" : "If the FlowFile is penalized." - } - } - }, - "FlowFileEntity" : { - "type" : "object", - "properties" : { - "flowFile" : { - "$ref" : "#/definitions/FlowFileDTO" - } - }, - "xml" : { - "name" : "flowFileEntity" - } - }, - "FlowFileSummaryDTO" : { - "type" : "object", - "properties" : { - "uri" : { - "type" : "string", - "description" : "The URI that can be used to access this FlowFile." - }, - "uuid" : { - "type" : "string", - "description" : "The FlowFile UUID." - }, - "filename" : { - "type" : "string", - "description" : "The FlowFile filename." - }, - "position" : { - "type" : "integer", - "format" : "int32", - "description" : "The FlowFile's position in the queue." - }, - "size" : { - "type" : "integer", - "format" : "int64", - "description" : "The FlowFile file size." - }, - "queuedDuration" : { - "type" : "integer", - "format" : "int64", - "description" : "How long this FlowFile has been enqueued." - }, - "lineageDuration" : { - "type" : "integer", - "format" : "int64", - "description" : "Duration since the FlowFile's greatest ancestor entered the flow." - }, - "penaltyExpiresIn" : { - "type" : "integer", - "format" : "int64", - "description" : "How long in milliseconds until the FlowFile penalty expires." - }, - "clusterNodeId" : { - "type" : "string", - "description" : "The id of the node where this FlowFile resides." - }, - "clusterNodeAddress" : { - "type" : "string", - "description" : "The label for the node where this FlowFile resides." - }, - "penalized" : { - "type" : "boolean", - "description" : "If the FlowFile is penalized." - } - } - }, - "FlowSnippetDTO" : { - "type" : "object", - "properties" : { - "processGroups" : { - "type" : "array", - "description" : "The process groups in this flow snippet.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ProcessGroupDTO" - } - }, - "remoteProcessGroups" : { - "type" : "array", - "description" : "The remote process groups in this flow snippet.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/RemoteProcessGroupDTO" - } - }, - "processors" : { - "type" : "array", - "description" : "The processors in this flow snippet.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ProcessorDTO" - } - }, - "inputPorts" : { - "type" : "array", - "description" : "The input ports in this flow snippet.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/PortDTO" - } - }, - "outputPorts" : { - "type" : "array", - "description" : "The output ports in this flow snippet.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/PortDTO" - } - }, - "connections" : { - "type" : "array", - "description" : "The connections in this flow snippet.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ConnectionDTO" - } - }, - "labels" : { - "type" : "array", - "description" : "The labels in this flow snippet.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/LabelDTO" - } - }, - "funnels" : { - "type" : "array", - "description" : "The funnels in this flow snippet.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/FunnelDTO" - } - }, - "controllerServices" : { - "type" : "array", - "description" : "The controller services in this flow snippet.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ControllerServiceDTO" - } - } - } - }, - "FunnelDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "versionedComponentId" : { - "type" : "string", - "description" : "The ID of the corresponding component that is under version control" - }, - "parentGroupId" : { - "type" : "string", - "description" : "The id of parent process group of this component if applicable." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - } - } - }, - "FunnelEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "component" : { - "$ref" : "#/definitions/FunnelDTO" - } - }, - "xml" : { - "name" : "funnelEntity" - } - }, - "FunnelsEntity" : { - "type" : "object", - "properties" : { - "funnels" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/FunnelEntity" - } - } - }, - "xml" : { - "name" : "funnelsEntity" - } - }, - "GCDiagnosticsSnapshotDTO" : { - "type" : "object", - "properties" : { - "timestamp" : { - "type" : "string", - "format" : "date-time", - "description" : "The timestamp of when the Snapshot was taken" - }, - "collectionCount" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of times that Garbage Collection has occurred" - }, - "collectionMillis" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of milliseconds that the Garbage Collector spent performing Garbage Collection duties" - } - } - }, - "GarbageCollectionDTO" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The name of the garbage collector." - }, - "collectionCount" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of times garbage collection has run." - }, - "collectionTime" : { - "type" : "string", - "description" : "The total amount of time spent garbage collecting." - }, - "collectionMillis" : { - "type" : "integer", - "format" : "int64", - "description" : "The total number of milliseconds spent garbage collecting." - } - } - }, - "GarbageCollectionDiagnosticsDTO" : { - "type" : "object", - "properties" : { - "memoryManagerName" : { - "type" : "string", - "description" : "The name of the Memory Manager that this Garbage Collection information pertains to" - }, - "snapshots" : { - "type" : "array", - "description" : "A list of snapshots that have been taken to determine the health of the JVM's heap", - "items" : { - "$ref" : "#/definitions/GCDiagnosticsSnapshotDTO" - } - } - } - }, - "HistoryDTO" : { - "type" : "object", - "properties" : { - "total" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of number of actions that matched the search criteria.." - }, - "lastRefreshed" : { - "type" : "string", - "description" : "The timestamp when the report was generated." - }, - "actions" : { - "type" : "array", - "description" : "The actions.", - "items" : { - "$ref" : "#/definitions/ActionEntity" - } - } - } - }, - "HistoryEntity" : { - "type" : "object", - "properties" : { - "history" : { - "$ref" : "#/definitions/HistoryDTO" - } - }, - "xml" : { - "name" : "historyEntity" - } - }, - "InputPortsEntity" : { - "type" : "object", - "properties" : { - "inputPorts" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/PortEntity" - } - } - }, - "xml" : { - "name" : "inputPortsEntity" - } - }, - "InstantiateTemplateRequestEntity" : { - "type" : "object", - "properties" : { - "originX" : { - "type" : "number", - "format" : "double", - "description" : "The x coordinate of the origin of the bounding box where the new components will be placed." - }, - "originY" : { - "type" : "number", - "format" : "double", - "description" : "The y coordinate of the origin of the bounding box where the new components will be placed." - }, - "templateId" : { - "type" : "string", - "description" : "The identifier of the template." - }, - "encodingVersion" : { - "type" : "string", - "description" : "The encoding version of the flow snippet. If not specified, this is automatically populated by the node receiving the user request. If the snippet is specified, the version will be the latest. If the snippet is not specified, the version will come from the underlying template. These details need to be replicated throughout the cluster to ensure consistency." - }, - "snippet" : { - "description" : "A flow snippet of the template contents. If not specified, this is automatically populated by the node receiving the user request. These details need to be replicated throughout the cluster to ensure consistency.", - "$ref" : "#/definitions/FlowSnippetDTO" - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - } - }, - "xml" : { - "name" : "instantiateTemplateRequestEntity" - } - }, - "JVMControllerDiagnosticsSnapshotDTO" : { - "type" : "object", - "properties" : { - "primaryNode" : { - "type" : "boolean", - "description" : "Whether or not this node is primary node" - }, - "clusterCoordinator" : { - "type" : "boolean", - "description" : "Whether or not this node is cluster coordinator" - }, - "maxTimerDrivenThreads" : { - "type" : "integer", - "format" : "int32", - "description" : "The maximum number of timer-driven threads" - }, - "maxEventDrivenThreads" : { - "type" : "integer", - "format" : "int32", - "description" : "The maximum number of event-driven threads" - } - } - }, - "JVMDiagnosticsDTO" : { - "type" : "object", - "properties" : { - "clustered" : { - "type" : "boolean", - "description" : "Whether or not the NiFi instance is clustered" - }, - "connected" : { - "type" : "boolean", - "description" : "Whether or not the node is connected to the cluster" - }, - "aggregateSnapshot" : { - "description" : "Aggregate JVM diagnostic information about the entire cluster", - "$ref" : "#/definitions/JVMDiagnosticsSnapshotDTO" - }, - "nodeSnapshots" : { - "type" : "array", - "description" : "Node-wise breakdown of JVM diagnostic information", - "items" : { - "$ref" : "#/definitions/NodeJVMDiagnosticsSnapshotDTO" - } - } - } - }, - "JVMDiagnosticsSnapshotDTO" : { - "type" : "object", - "properties" : { - "systemDiagnosticsDto" : { - "description" : "System-related diagnostics information", - "$ref" : "#/definitions/JVMSystemDiagnosticsSnapshotDTO" - }, - "flowDiagnosticsDto" : { - "description" : "Flow-related diagnostics information", - "$ref" : "#/definitions/JVMFlowDiagnosticsSnapshotDTO" - }, - "controllerDiagnostics" : { - "description" : "Controller-related diagnostics information", - "$ref" : "#/definitions/JVMControllerDiagnosticsSnapshotDTO" - } - } - }, - "JVMFlowDiagnosticsSnapshotDTO" : { - "type" : "object", - "properties" : { - "uptime" : { - "type" : "string", - "description" : "How long this node has been running, formatted as hours:minutes:seconds.milliseconds" - }, - "timeZone" : { - "type" : "string", - "description" : "The name of the Time Zone that is configured, if available" - }, - "activeTimerDrivenThreads" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of timer-driven threads that are active" - }, - "activeEventDrivenThreads" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of event-driven threads that are active" - }, - "bundlesLoaded" : { - "type" : "array", - "description" : "The NiFi Bundles (NARs) that are loaded by NiFi", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/BundleDTO" - } - } - } - }, - "JVMSystemDiagnosticsSnapshotDTO" : { - "type" : "object", - "properties" : { - "flowFileRepositoryStorageUsage" : { - "description" : "Information about the FlowFile Repository's usage", - "$ref" : "#/definitions/RepositoryUsageDTO" - }, - "contentRepositoryStorageUsage" : { - "type" : "array", - "description" : "Information about the Content Repository's usage", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/RepositoryUsageDTO" - } - }, - "provenanceRepositoryStorageUsage" : { - "type" : "array", - "description" : "Information about the Provenance Repository's usage", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/RepositoryUsageDTO" - } - }, - "maxHeapBytes" : { - "type" : "integer", - "format" : "int64", - "description" : "The maximum number of bytes that the JVM heap is configured to use for heap" - }, - "maxHeap" : { - "type" : "string", - "description" : "The maximum number of bytes that the JVM heap is configured to use, as a human-readable value" - }, - "garbageCollectionDiagnostics" : { - "type" : "array", - "description" : "Diagnostic information about the JVM's garbage collections", - "items" : { - "$ref" : "#/definitions/GarbageCollectionDiagnosticsDTO" - } - }, - "cpuCores" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of CPU Cores available on the system" - }, - "cpuLoadAverage" : { - "type" : "number", - "format" : "double", - "description" : "The 1-minute CPU Load Average" - }, - "physicalMemoryBytes" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes of RAM available on the system" - }, - "physicalMemory" : { - "type" : "string", - "description" : "The number of bytes of RAM available on the system as a human-readable value" - }, - "openFileDescriptors" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of files that are open by the NiFi process" - }, - "maxOpenFileDescriptors" : { - "type" : "integer", - "format" : "int64", - "description" : "The maximum number of open file descriptors that are available to each process" - } - } - }, - "JaxbLink" : { - "type" : "object", - "properties" : { - "href" : { - "type" : "string", - "format" : "uri", - "xml" : { - "attribute" : true - }, - "description" : "The href for the link" - }, - "params" : { - "type" : "object", - "description" : "The params for the link", - "additionalProperties" : { - "type" : "string" - } - } - } - }, - "LabelDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "versionedComponentId" : { - "type" : "string", - "description" : "The ID of the corresponding component that is under version control" - }, - "parentGroupId" : { - "type" : "string", - "description" : "The id of parent process group of this component if applicable." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "label" : { - "type" : "string", - "description" : "The text that appears in the label." - }, - "width" : { - "type" : "number", - "format" : "double", - "description" : "The width of the label in pixels when at a 1:1 scale." - }, - "height" : { - "type" : "number", - "format" : "double", - "description" : "The height of the label in pixels when at a 1:1 scale." - }, - "getzIndex" : { - "type" : "integer", - "format" : "int64", - "description" : "The z index of the label." - }, - "style" : { - "type" : "object", - "description" : "The styles for this label (font-size : 12px, background-color : #eee, etc).", - "additionalProperties" : { - "type" : "string" - } - } - } - }, - "LabelEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "dimensions" : { - "$ref" : "#/definitions/DimensionsDTO" - }, - "getzIndex" : { - "type" : "integer", - "format" : "int64", - "description" : "The z index of the label." - }, - "component" : { - "$ref" : "#/definitions/LabelDTO" - } - }, - "xml" : { - "name" : "labelEntity" - } - }, - "LabelsEntity" : { - "type" : "object", - "properties" : { - "labels" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/LabelEntity" - } - } - }, - "xml" : { - "name" : "labelsEntity" - } - }, - "LineageDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of this lineage query." - }, - "uri" : { - "type" : "string", - "description" : "The URI for this lineage query for later retrieval and deletion." - }, - "submissionTime" : { - "type" : "string", - "description" : "When the lineage query was submitted." - }, - "expiration" : { - "type" : "string", - "description" : "When the lineage query will expire." - }, - "percentCompleted" : { - "type" : "integer", - "format" : "int32", - "description" : "The percent complete for the lineage query." - }, - "finished" : { - "type" : "boolean", - "description" : "Whether the lineage query has finished." - }, - "request" : { - "description" : "The initial lineage result.", - "$ref" : "#/definitions/LineageRequestDTO" - }, - "results" : { - "description" : "The results of the lineage query.", - "$ref" : "#/definitions/LineageResultsDTO" - } - } - }, - "LineageEntity" : { - "type" : "object", - "properties" : { - "lineage" : { - "$ref" : "#/definitions/LineageDTO" - } - }, - "xml" : { - "name" : "lineageEntity" - } - }, - "LineageRequestDTO" : { - "type" : "object", - "properties" : { - "eventId" : { - "type" : "integer", - "format" : "int64", - "description" : "The event id that was used to generate this lineage, if applicable. The event id is allowed for any type of lineageRequestType. If the lineageRequestType is FLOWFILE and the flowfile uuid is also included in the request, the event id will be ignored." - }, - "lineageRequestType" : { - "type" : "string", - "description" : "The type of lineage request. PARENTS will return the lineage for the flowfiles that are parents of the specified event. CHILDREN will return the lineage for the flowfiles that are children of the specified event. FLOWFILE will return the lineage for the specified flowfile.", - "enum" : [ "PARENTS", "CHILDREN", "and FLOWFILE" ] - }, - "uuid" : { - "type" : "string", - "description" : "The flowfile uuid that was used to generate the lineage. The flowfile uuid is only allowed when the lineageRequestType is FLOWFILE and will take precedence over event id." - }, - "clusterNodeId" : { - "type" : "string", - "description" : "The id of the node where this lineage originated if clustered." - } - } - }, - "LineageResultsDTO" : { - "type" : "object", - "properties" : { - "errors" : { - "type" : "array", - "description" : "Any errors that occurred while generating the lineage.", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - }, - "nodes" : { - "type" : "array", - "description" : "The nodes in the lineage.", - "items" : { - "$ref" : "#/definitions/ProvenanceNodeDTO" - } - }, - "links" : { - "type" : "array", - "description" : "The links between the nodes in the lineage.", - "items" : { - "$ref" : "#/definitions/ProvenanceLinkDTO" - } - } - } - }, - "ListingRequestDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id for this listing request." - }, - "uri" : { - "type" : "string", - "description" : "The URI for future requests to this listing request." - }, - "submissionTime" : { - "type" : "string", - "description" : "The timestamp when the query was submitted." - }, - "lastUpdated" : { - "type" : "string", - "description" : "The last time this listing request was updated." - }, - "percentCompleted" : { - "type" : "integer", - "format" : "int32", - "description" : "The current percent complete." - }, - "finished" : { - "type" : "boolean", - "description" : "Whether the query has finished." - }, - "failureReason" : { - "type" : "string", - "description" : "The reason, if any, that this listing request failed." - }, - "maxResults" : { - "type" : "integer", - "format" : "int32", - "description" : "The maximum number of FlowFileSummary objects to return" - }, - "state" : { - "type" : "string", - "description" : "The current state of the listing request." - }, - "queueSize" : { - "description" : "The size of the queue", - "$ref" : "#/definitions/QueueSizeDTO" - }, - "flowFileSummaries" : { - "type" : "array", - "description" : "The FlowFile summaries. The summaries will be populated once the request has completed.", - "items" : { - "$ref" : "#/definitions/FlowFileSummaryDTO" - } - }, - "sourceRunning" : { - "type" : "boolean", - "description" : "Whether the source of the connection is running" - }, - "destinationRunning" : { - "type" : "boolean", - "description" : "Whether the destination of the connection is running" - } - } - }, - "ListingRequestEntity" : { - "type" : "object", - "properties" : { - "listingRequest" : { - "$ref" : "#/definitions/ListingRequestDTO" - } - }, - "xml" : { - "name" : "listingRequestEntity" - } - }, - "LocalQueuePartitionDTO" : { - "type" : "object", - "properties" : { - "totalFlowFileCount" : { - "type" : "integer", - "format" : "int32", - "description" : "Total number of FlowFiles owned by the Connection" - }, - "totalByteCount" : { - "type" : "integer", - "format" : "int64", - "description" : "Total number of bytes that make up the content for the FlowFiles owned by this Connection" - }, - "activeQueueFlowFileCount" : { - "type" : "integer", - "format" : "int32", - "description" : "Total number of FlowFiles that exist in the Connection's Active Queue, immediately available to be offered up to a component" - }, - "activeQueueByteCount" : { - "type" : "integer", - "format" : "int64", - "description" : "Total number of bytes that make up the content for the FlowFiles that are present in the Connection's Active Queue" - }, - "swapFlowFileCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The total number of FlowFiles that are swapped out for this Connection" - }, - "swapByteCount" : { - "type" : "integer", - "format" : "int64", - "description" : "Total number of bytes that make up the content for the FlowFiles that are swapped out to disk for the Connection" - }, - "swapFiles" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of Swap Files that exist for this Connection" - }, - "inFlightFlowFileCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of In-Flight FlowFiles for this Connection. These are FlowFiles that belong to the connection but are currently being operated on by a Processor, Port, etc." - }, - "inFlightByteCount" : { - "type" : "integer", - "format" : "int64", - "description" : "The number bytes that make up the content of the FlowFiles that are In-Flight" - }, - "allActiveQueueFlowFilesPenalized" : { - "type" : "boolean", - "description" : "Whether or not all of the FlowFiles in the Active Queue are penalized" - }, - "anyActiveQueueFlowFilesPenalized" : { - "type" : "boolean", - "description" : "Whether or not any of the FlowFiles in the Active Queue are penalized" - } - } - }, - "NodeConnectionStatisticsSnapshotDTO" : { - "type" : "object", - "properties" : { - "nodeId" : { - "type" : "string", - "description" : "The unique ID that identifies the node" - }, - "address" : { - "type" : "string", - "description" : "The API address of the node" - }, - "apiPort" : { - "type" : "integer", - "format" : "int32", - "description" : "The API port used to communicate with the node" - }, - "statisticsSnapshot" : { - "description" : "The connection status snapshot from the node.", - "$ref" : "#/definitions/ConnectionStatisticsSnapshotDTO" - } - } - }, - "NodeConnectionStatusSnapshotDTO" : { - "type" : "object", - "properties" : { - "nodeId" : { - "type" : "string", - "description" : "The unique ID that identifies the node" - }, - "address" : { - "type" : "string", - "description" : "The API address of the node" - }, - "apiPort" : { - "type" : "integer", - "format" : "int32", - "description" : "The API port used to communicate with the node" - }, - "statusSnapshot" : { - "description" : "The connection status snapshot from the node.", - "$ref" : "#/definitions/ConnectionStatusSnapshotDTO" - } - } - }, - "NodeCountersSnapshotDTO" : { - "type" : "object", - "properties" : { - "nodeId" : { - "type" : "string", - "description" : "The unique ID that identifies the node" - }, - "address" : { - "type" : "string", - "description" : "The API address of the node" - }, - "apiPort" : { - "type" : "integer", - "format" : "int32", - "description" : "The API port used to communicate with the node" - }, - "snapshot" : { - "description" : "The counters from the node.", - "$ref" : "#/definitions/CountersSnapshotDTO" - } - } - }, - "NodeDTO" : { - "type" : "object", - "properties" : { - "nodeId" : { - "type" : "string", - "description" : "The id of the node." - }, - "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." - }, - "status" : { - "type" : "string", - "description" : "The node's status." - }, - "heartbeat" : { - "type" : "string", - "description" : "the time of the nodes's last heartbeat." - }, - "connectionRequested" : { - "type" : "string", - "description" : "The time of the node's last connection request." - }, - "roles" : { - "type" : "array", - "description" : "The roles of this node.", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - }, - "activeThreadCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The active threads for the NiFi on the node." - }, - "queued" : { - "type" : "string", - "description" : "The queue the NiFi on the node." - }, - "events" : { - "type" : "array", - "description" : "The node's events.", - "items" : { - "$ref" : "#/definitions/NodeEventDTO" - } - }, - "nodeStartTime" : { - "type" : "string", - "description" : "The time at which this Node was last refreshed." - } - } - }, - "NodeEntity" : { - "type" : "object", - "properties" : { - "node" : { - "$ref" : "#/definitions/NodeDTO" - } - }, - "xml" : { - "name" : "nodeEntity" - } - }, - "NodeEventDTO" : { - "type" : "object", - "properties" : { - "timestamp" : { - "type" : "string", - "description" : "The timestamp of the node event." - }, - "category" : { - "type" : "string", - "description" : "The category of the node event." - }, - "message" : { - "type" : "string", - "description" : "The message in the node event." - } - } - }, - "NodeJVMDiagnosticsSnapshotDTO" : { - "type" : "object", - "properties" : { - "nodeId" : { - "type" : "string", - "description" : "The unique ID that identifies the node" - }, - "address" : { - "type" : "string", - "description" : "The API address of the node" - }, - "apiPort" : { - "type" : "integer", - "format" : "int32", - "description" : "The API port used to communicate with the node" - }, - "snapshot" : { - "description" : "The JVM Diagnostics Snapshot", - "$ref" : "#/definitions/JVMDiagnosticsSnapshotDTO" - } - } - }, - "NodePortStatusSnapshotDTO" : { - "type" : "object", - "properties" : { - "nodeId" : { - "type" : "string", - "description" : "The unique ID that identifies the node" - }, - "address" : { - "type" : "string", - "description" : "The API address of the node" - }, - "apiPort" : { - "type" : "integer", - "format" : "int32", - "description" : "The API port used to communicate with the node" - }, - "statusSnapshot" : { - "description" : "The port status snapshot from the node.", - "$ref" : "#/definitions/PortStatusSnapshotDTO" - } - } - }, - "NodeProcessGroupStatusSnapshotDTO" : { - "type" : "object", - "properties" : { - "nodeId" : { - "type" : "string", - "description" : "The unique ID that identifies the node" - }, - "address" : { - "type" : "string", - "description" : "The API address of the node" - }, - "apiPort" : { - "type" : "integer", - "format" : "int32", - "description" : "The API port used to communicate with the node" - }, - "statusSnapshot" : { - "description" : "The process group status snapshot from the node.", - "$ref" : "#/definitions/ProcessGroupStatusSnapshotDTO" - } - } - }, - "NodeProcessorStatusSnapshotDTO" : { - "type" : "object", - "properties" : { - "nodeId" : { - "type" : "string", - "description" : "The unique ID that identifies the node" - }, - "address" : { - "type" : "string", - "description" : "The API address of the node" - }, - "apiPort" : { - "type" : "integer", - "format" : "int32", - "description" : "The API port used to communicate with the node" - }, - "statusSnapshot" : { - "description" : "The processor status snapshot from the node.", - "$ref" : "#/definitions/ProcessorStatusSnapshotDTO" - } - } - }, - "NodeRemoteProcessGroupStatusSnapshotDTO" : { - "type" : "object", - "properties" : { - "nodeId" : { - "type" : "string", - "description" : "The unique ID that identifies the node" - }, - "address" : { - "type" : "string", - "description" : "The API address of the node" - }, - "apiPort" : { - "type" : "integer", - "format" : "int32", - "description" : "The API port used to communicate with the node" - }, - "statusSnapshot" : { - "description" : "The remote process group status snapshot from the node.", - "$ref" : "#/definitions/RemoteProcessGroupStatusSnapshotDTO" - } - } - }, - "NodeSearchResultDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the node that matched the search." - }, - "address" : { - "type" : "string", - "description" : "The address of the node that matched the search." - } - } - }, - "NodeStatusSnapshotsDTO" : { - "type" : "object", - "properties" : { - "nodeId" : { - "type" : "string", - "description" : "The id of the node." - }, - "address" : { - "type" : "string", - "description" : "The node's host/ip address." - }, - "apiPort" : { - "type" : "integer", - "format" : "int32", - "description" : "The port the node is listening for API requests." - }, - "statusSnapshots" : { - "type" : "array", - "description" : "A list of StatusSnapshotDTO objects that provide the actual metric values for the component for this node.", - "items" : { - "$ref" : "#/definitions/StatusSnapshotDTO" - } - } - } - }, - "NodeSystemDiagnosticsSnapshotDTO" : { - "type" : "object", - "properties" : { - "nodeId" : { - "type" : "string", - "description" : "The unique ID that identifies the node" - }, - "address" : { - "type" : "string", - "description" : "The API address of the node" - }, - "apiPort" : { - "type" : "integer", - "format" : "int32", - "description" : "The API port used to communicate with the node" - }, - "snapshot" : { - "description" : "The System Diagnostics snapshot from the node.", - "$ref" : "#/definitions/SystemDiagnosticsSnapshotDTO" - } - } - }, - "OutputPortsEntity" : { - "type" : "object", - "properties" : { - "outputPorts" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/PortEntity" - } - } - }, - "xml" : { - "name" : "outputPortsEntity" - } - }, - "ParameterContextDTO" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The Name of the Parameter Context." - }, - "description" : { - "type" : "string", - "description" : "The Description of the Parameter Context." - }, - "parameters" : { - "type" : "array", - "description" : "The Parameters for the Parameter Context", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ParameterEntity" - } - }, - "boundProcessGroups" : { - "type" : "array", - "description" : "The Process Groups that are bound to this Parameter Context", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ProcessGroupEntity" - } - }, - "inheritedParameterContexts" : { - "type" : "array", - "description" : "A list of references of Parameter Contexts from which this one inherits parameters", - "items" : { - "$ref" : "#/definitions/ParameterContextReferenceEntity" - } - }, - "id" : { - "type" : "string", - "description" : "The ID the Parameter Context." - } - } - }, - "ParameterContextEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "component" : { - "description" : "The Parameter Context", - "$ref" : "#/definitions/ParameterContextDTO" - } - }, - "xml" : { - "name" : "parameterContextEntity" - } - }, - "ParameterContextReferenceDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The ID of the Parameter Context" - }, - "name" : { - "type" : "string", - "description" : "The name of the Parameter Context" - } - } - }, - "ParameterContextReferenceEntity" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "component" : { - "$ref" : "#/definitions/ParameterContextReferenceDTO" - } - }, - "xml" : { - "name" : "parameterContextReferenceEntity" - } - }, - "ParameterContextUpdateRequestDTO" : { - "type" : "object", - "properties" : { - "requestId" : { - "type" : "string", - "description" : "The ID of the request" - }, - "uri" : { - "type" : "string", - "description" : "The URI for the request" - }, - "submissionTime" : { - "type" : "string", - "format" : "date-time", - "description" : "The timestamp of when the request was submitted" - }, - "lastUpdated" : { - "type" : "string", - "format" : "date-time", - "description" : "The timestamp of when the request was last updated" - }, - "complete" : { - "type" : "boolean", - "description" : "Whether or not the request is completed" - }, - "failureReason" : { - "type" : "string", - "description" : "The reason for the request failing, or null if the request has not failed" - }, - "percentCompleted" : { - "type" : "integer", - "format" : "int32", - "description" : "A value between 0 and 100 (inclusive) indicating how close the request is to completion" - }, - "state" : { - "type" : "string", - "description" : "A description of the current state of the request" - }, - "updateSteps" : { - "type" : "array", - "description" : "The steps that are required in order to complete the request, along with the status of each", - "items" : { - "$ref" : "#/definitions/ParameterContextUpdateStepDTO" - } - }, - "parameterContext" : { - "description" : "The Parameter Context that is being operated on. This may not be populated until the request has successfully completed.", - "$ref" : "#/definitions/ParameterContextDTO" - }, - "referencingComponents" : { - "type" : "array", - "description" : "The components that are referenced by the update.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/AffectedComponentEntity" - } - } - } - }, - "ParameterContextUpdateRequestEntity" : { - "type" : "object", - "properties" : { - "parameterContextRevision" : { - "description" : "The Revision of the Parameter Context", - "$ref" : "#/definitions/RevisionDTO" - }, - "request" : { - "description" : "The Update Request", - "$ref" : "#/definitions/ParameterContextUpdateRequestDTO" - } - }, - "xml" : { - "name" : "parameterContextUpdateRequestEntity" - } - }, - "ParameterContextUpdateStepDTO" : { - "type" : "object", - "properties" : { - "description" : { - "type" : "string", - "description" : "Explanation of what happens in this step" - }, - "complete" : { - "type" : "boolean", - "description" : "Whether or not this step has completed" - }, - "failureReason" : { - "type" : "string", - "description" : "An explanation of why this step failed, or null if this step did not fail" - } - } - }, - "ParameterContextValidationRequestDTO" : { - "type" : "object", - "properties" : { - "requestId" : { - "type" : "string", - "description" : "The ID of the request" - }, - "uri" : { - "type" : "string", - "description" : "The URI for the request" - }, - "submissionTime" : { - "type" : "string", - "format" : "date-time", - "description" : "The timestamp of when the request was submitted" - }, - "lastUpdated" : { - "type" : "string", - "format" : "date-time", - "description" : "The timestamp of when the request was last updated" - }, - "complete" : { - "type" : "boolean", - "description" : "Whether or not the request is completed" - }, - "failureReason" : { - "type" : "string", - "description" : "The reason for the request failing, or null if the request has not failed" - }, - "percentCompleted" : { - "type" : "integer", - "format" : "int32", - "description" : "A value between 0 and 100 (inclusive) indicating how close the request is to completion" - }, - "state" : { - "type" : "string", - "description" : "A description of the current state of the request" - }, - "updateSteps" : { - "type" : "array", - "description" : "The steps that are required in order to complete the request, along with the status of each", - "items" : { - "$ref" : "#/definitions/ParameterContextValidationStepDTO" - } - }, - "parameterContext" : { - "description" : "The Parameter Context that is being operated on.", - "$ref" : "#/definitions/ParameterContextDTO" - }, - "componentValidationResults" : { - "description" : "The Validation Results that were calculated for each component. This value may not be set until the request completes.", - "$ref" : "#/definitions/ComponentValidationResultsEntity" - } - } - }, - "ParameterContextValidationRequestEntity" : { - "type" : "object", - "properties" : { - "request" : { - "description" : "The Update Request", - "$ref" : "#/definitions/ParameterContextValidationRequestDTO" - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - } - }, - "xml" : { - "name" : "parameterContextValidationRequestEntity" - } - }, - "ParameterContextValidationStepDTO" : { - "type" : "object", - "properties" : { - "description" : { - "type" : "string", - "description" : "Explanation of what happens in this step" - }, - "complete" : { - "type" : "boolean", - "description" : "Whether or not this step has completed" - }, - "failureReason" : { - "type" : "string", - "description" : "An explanation of why this step failed, or null if this step did not fail" - } - } - }, - "ParameterContextsEntity" : { - "type" : "object", - "properties" : { - "parameterContexts" : { - "type" : "array", - "description" : "The Parameter Contexts", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ParameterContextEntity" - } - }, - "currentTime" : { - "type" : "string", - "description" : "The current time on the system." - } - }, - "xml" : { - "name" : "parameterContexts" - } - }, - "ParameterDTO" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The name of the Parameter" - }, - "description" : { - "type" : "string", - "description" : "The description of the Parameter" - }, - "sensitive" : { - "type" : "boolean", - "description" : "Whether or not the Parameter is sensitive" - }, - "value" : { - "type" : "string", - "description" : "The value of the Parameter" - }, - "valueRemoved" : { - "type" : "boolean", - "description" : "Whether or not the value of the Parameter was removed. When a request is made to change a parameter, the value may be null. The 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). This denotes which of the two scenarios is being encountered." - }, - "referencingComponents" : { - "type" : "array", - "description" : "The set of all components in the flow that are referencing this Parameter", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/AffectedComponentEntity" - } - }, - "parameterContext" : { - "description" : "A reference to the Parameter Context that contains this one", - "$ref" : "#/definitions/ParameterContextReferenceEntity" - }, - "inherited" : { - "type" : "boolean", - "description" : "Whether or not the Parameter is inherited from another context" - } - } - }, - "ParameterEntity" : { - "type" : "object", - "properties" : { - "canWrite" : { - "type" : "boolean", - "description" : "Indicates whether the user can write a given resource." - }, - "parameter" : { - "description" : "The parameter information", - "$ref" : "#/definitions/ParameterDTO" - } - }, - "xml" : { - "name" : "parameterEntity" - } - }, - "PeerDTO" : { - "type" : "object", - "properties" : { - "hostname" : { - "type" : "string", - "description" : "The hostname of this peer." - }, - "port" : { - "type" : "integer", - "format" : "int32", - "description" : "The port number of this peer." - }, - "secure" : { - "type" : "boolean", - "description" : "Returns if this peer connection is secure." - }, - "flowFileCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of flowFiles this peer holds." - } - } - }, - "PeersEntity" : { - "type" : "object", - "properties" : { - "peers" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/PeerDTO" - } - } - }, - "xml" : { - "name" : "peersEntity" - } - }, - "Permissions" : { - "type" : "object", - "properties" : { - "canRead" : { - "type" : "boolean", - "description" : "Indicates whether the user can read a given resource.", - "readOnly" : true - }, - "canWrite" : { - "type" : "boolean", - "description" : "Indicates whether the user can write a given resource.", - "readOnly" : true - }, - "canDelete" : { - "type" : "boolean", - "description" : "Indicates whether the user can delete a given resource.", - "readOnly" : true - } - } - }, - "PermissionsDTO" : { - "type" : "object", - "properties" : { - "canRead" : { - "type" : "boolean", - "description" : "Indicates whether the user can read a given resource." - }, - "canWrite" : { - "type" : "boolean", - "description" : "Indicates whether the user can write a given resource." - } - } - }, - "PortDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "versionedComponentId" : { - "type" : "string", - "description" : "The ID of the corresponding component that is under version control" - }, - "parentGroupId" : { - "type" : "string", - "description" : "The id of parent process group of this component if applicable." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "name" : { - "type" : "string", - "description" : "The name of the port." - }, - "comments" : { - "type" : "string", - "description" : "The comments for the port." - }, - "state" : { - "type" : "string", - "description" : "The state of the port.", - "enum" : [ "RUNNING", "STOPPED", "DISABLED" ] - }, - "type" : { - "type" : "string", - "description" : "The type of port.", - "enum" : [ "INPUT_PORT", "OUTPUT_PORT" ] - }, - "transmitting" : { - "type" : "boolean", - "description" : "Whether the port has incoming or output connections to a remote NiFi. This is only applicable when the port is allowed to be accessed remotely." - }, - "concurrentlySchedulableTaskCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of tasks that should be concurrently scheduled for the port." - }, - "userAccessControl" : { - "type" : "array", - "description" : "The users that are allowed to access the port.", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - }, - "groupAccessControl" : { - "type" : "array", - "description" : "The user groups that are allowed to access the port.", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - }, - "allowRemoteAccess" : { - "type" : "boolean", - "description" : "Whether this port can be accessed remotely via Site-to-Site protocol." - }, - "validationErrors" : { - "type" : "array", - "description" : "Gets the validation errors from this port. These validation errors represent the problems with the port that must be resolved before it can be started.", - "items" : { - "type" : "string" - } - } - } - }, - "PortEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "component" : { - "$ref" : "#/definitions/PortDTO" - }, - "status" : { - "description" : "The status of the port.", - "$ref" : "#/definitions/PortStatusDTO" - }, - "portType" : { - "type" : "string" - }, - "operatePermissions" : { - "description" : "The permissions for this component operations.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "allowRemoteAccess" : { - "type" : "boolean", - "description" : "Whether this port can be accessed remotely via Site-to-Site protocol." - } - }, - "xml" : { - "name" : "portEntity" - } - }, - "PortRunStatusEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "state" : { - "type" : "string", - "description" : "The run status of the Port.", - "enum" : [ "RUNNING", "STOPPED", "DISABLED" ] - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - } - }, - "xml" : { - "name" : "entity" - } - }, - "PortStatusDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the port." - }, - "groupId" : { - "type" : "string", - "description" : "The id of the parent process group of the port." - }, - "name" : { - "type" : "string", - "description" : "The name of the port." - }, - "transmitting" : { - "type" : "boolean", - "description" : "Whether the port has incoming or outgoing connections to a remote NiFi." - }, - "runStatus" : { - "type" : "string", - "description" : "The run status of the port.", - "enum" : [ "Running", "Stopped", "Validating", "Disabled", "Invalid" ] - }, - "statsLastRefreshed" : { - "type" : "string", - "description" : "The time the status for the process group was last refreshed." - }, - "aggregateSnapshot" : { - "description" : "A status snapshot that represents the aggregate stats of all nodes in the cluster. If the NiFi instance is a standalone instance, rather than a cluster, this represents the stats of the single instance.", - "$ref" : "#/definitions/PortStatusSnapshotDTO" - }, - "nodeSnapshots" : { - "type" : "array", - "description" : "A status snapshot for each node in the cluster. If the NiFi instance is a standalone instance, rather than a cluster, this may be null.", - "items" : { - "$ref" : "#/definitions/NodePortStatusSnapshotDTO" - } - } - } - }, - "PortStatusEntity" : { - "type" : "object", - "properties" : { - "portStatus" : { - "$ref" : "#/definitions/PortStatusDTO" - }, - "canRead" : { - "type" : "boolean", - "description" : "Indicates whether the user can read a given resource." - } - }, - "xml" : { - "name" : "portStatusEntity" - } - }, - "PortStatusSnapshotDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the port." - }, - "groupId" : { - "type" : "string", - "description" : "The id of the parent process group of the port." - }, - "name" : { - "type" : "string", - "description" : "The name of the port." - }, - "activeThreadCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The active thread count for the port." - }, - "flowFilesIn" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of FlowFiles that have been accepted in the last 5 minutes." - }, - "bytesIn" : { - "type" : "integer", - "format" : "int64", - "description" : "The size of hte FlowFiles that have been accepted in the last 5 minutes." - }, - "input" : { - "type" : "string", - "description" : "The count/size of flowfiles that have been accepted in the last 5 minutes." - }, - "flowFilesOut" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of FlowFiles that have been processed in the last 5 minutes." - }, - "bytesOut" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes that have been processed in the last 5 minutes." - }, - "output" : { - "type" : "string", - "description" : "The count/size of flowfiles that have been processed in the last 5 minutes." - }, - "transmitting" : { - "type" : "boolean", - "description" : "Whether the port has incoming or outgoing connections to a remote NiFi." - }, - "runStatus" : { - "type" : "string", - "description" : "The run status of the port.", - "enum" : [ "Running", "Stopped", "Validating", "Disabled", "Invalid" ] - } - } - }, - "PortStatusSnapshotEntity" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the port." - }, - "portStatusSnapshot" : { - "$ref" : "#/definitions/PortStatusSnapshotDTO" - }, - "canRead" : { - "type" : "boolean", - "description" : "Indicates whether the user can read a given resource." - } - }, - "xml" : { - "name" : "entity" - } - }, - "Position" : { - "type" : "object", - "properties" : { - "x" : { - "type" : "number", - "format" : "double", - "description" : "The x coordinate." - }, - "y" : { - "type" : "number", - "format" : "double", - "description" : "The y coordinate." - } - }, - "description" : "The position of a component on the graph" - }, - "PositionDTO" : { - "type" : "object", - "properties" : { - "x" : { - "type" : "number", - "format" : "double", - "description" : "The x coordinate." - }, - "y" : { - "type" : "number", - "format" : "double", - "description" : "The y coordinate." - } - } - }, - "PreviousValueDTO" : { - "type" : "object", - "properties" : { - "previousValue" : { - "type" : "string", - "description" : "The previous value." - }, - "timestamp" : { - "type" : "string", - "description" : "The timestamp when the value was modified." - }, - "userIdentity" : { - "type" : "string", - "description" : "The user who changed the previous value." - } - } - }, - "PrioritizerTypesEntity" : { - "type" : "object", - "properties" : { - "prioritizerTypes" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/DocumentedTypeDTO" - } - } - }, - "xml" : { - "name" : "prioritizerTypesEntity" - } - }, - "ProcessGroupDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "versionedComponentId" : { - "type" : "string", - "description" : "The ID of the corresponding component that is under version control" - }, - "parentGroupId" : { - "type" : "string", - "description" : "The id of parent process group of this component if applicable." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "name" : { - "type" : "string", - "description" : "The name of the process group." - }, - "comments" : { - "type" : "string", - "description" : "The comments for the process group." - }, - "variables" : { - "type" : "object", - "description" : "The variables that are configured for the Process Group. Note that this map contains only those variables that are defined on this Process Group and not any variables that are defined in the parent Process Group, etc. I.e., this Map will not contain all variables that are accessible by components in this Process Group by rather only the variables that are defined for this Process Group itself.", - "additionalProperties" : { - "type" : "string" - } - }, - "versionControlInformation" : { - "description" : "The Version Control information that indicates which Flow Registry, and where in the Flow Registry, this Process Group is tracking to; or null if this Process Group is not under version control", - "$ref" : "#/definitions/VersionControlInformationDTO" - }, - "parameterContext" : { - "description" : "The Parameter Context that this Process Group is bound to.", - "$ref" : "#/definitions/ParameterContextReferenceEntity" - }, - "flowfileConcurrency" : { - "type" : "string", - "description" : "The FlowFile Concurrency for this Process Group.", - "enum" : [ "UNBOUNDED", "SINGLE_FLOWFILE_PER_NODE" ] - }, - "flowfileOutboundPolicy" : { - "type" : "string", - "description" : "The Outbound Policy that is used for determining how FlowFiles should be transferred out of the Process Group.", - "enum" : [ "STREAM_WHEN_AVAILABLE", "BATCH_OUTPUT" ] - }, - "defaultFlowFileExpiration" : { - "type" : "string", - "description" : "The default FlowFile Expiration for this Process Group." - }, - "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." - }, - "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." - }, - "runningCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of running components in this process group." - }, - "stoppedCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of stopped components in the process group." - }, - "invalidCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of invalid components in the process group." - }, - "disabledCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of disabled components in the process group." - }, - "activeRemotePortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of active remote ports in the process group." - }, - "inactiveRemotePortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of inactive remote ports in the process group." - }, - "upToDateCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of up to date versioned process groups in the process group." - }, - "locallyModifiedCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of locally modified versioned process groups in the process group." - }, - "staleCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of stale versioned process groups in the process group." - }, - "locallyModifiedAndStaleCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of locally modified and stale versioned process groups in the process group." - }, - "syncFailureCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of versioned process groups in the process group that are unable to sync to a registry." - }, - "localInputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of local input ports in the process group." - }, - "localOutputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of local output ports in the process group." - }, - "publicInputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of public input ports in the process group." - }, - "publicOutputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of public output ports in the process group." - }, - "contents" : { - "description" : "The contents of this process group.", - "$ref" : "#/definitions/FlowSnippetDTO" - }, - "inputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of input ports in the process group." - }, - "outputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of output ports in the process group." - } - } - }, - "ProcessGroupEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "component" : { - "$ref" : "#/definitions/ProcessGroupDTO" - }, - "status" : { - "description" : "The status of the process group.", - "$ref" : "#/definitions/ProcessGroupStatusDTO" - }, - "versionedFlowSnapshot" : { - "description" : "Returns the Versioned Flow that describes the contents of the Versioned Flow to be imported", - "$ref" : "#/definitions/VersionedFlowSnapshot" - }, - "runningCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of running components in this process group." - }, - "stoppedCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of stopped components in the process group." - }, - "invalidCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of invalid components in the process group." - }, - "disabledCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of disabled components in the process group." - }, - "activeRemotePortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of active remote ports in the process group." - }, - "inactiveRemotePortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of inactive remote ports in the process group." - }, - "versionedFlowState" : { - "type" : "string", - "description" : "The current state of the Process Group, as it relates to the Versioned Flow", - "enum" : [ "LOCALLY_MODIFIED", "STALE", "LOCALLY_MODIFIED_AND_STALE", "UP_TO_DATE", "SYNC_FAILURE" ] - }, - "upToDateCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of up to date versioned process groups in the process group." - }, - "locallyModifiedCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of locally modified versioned process groups in the process group." - }, - "staleCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of stale versioned process groups in the process group." - }, - "locallyModifiedAndStaleCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of locally modified and stale versioned process groups in the process group." - }, - "syncFailureCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of versioned process groups in the process group that are unable to sync to a registry." - }, - "localInputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of local input ports in the process group." - }, - "localOutputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of local output ports in the process group." - }, - "publicInputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of public input ports in the process group." - }, - "publicOutputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of public output ports in the process group." - }, - "parameterContext" : { - "description" : "The Parameter Context, or null if no Parameter Context has been bound to the Process Group", - "$ref" : "#/definitions/ParameterContextReferenceEntity" - }, - "inputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of input ports in the process group." - }, - "outputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of output ports in the process group." - } - }, - "xml" : { - "name" : "processGroupEntity" - } - }, - "ProcessGroupFlowDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "parentGroupId" : { - "type" : "string", - "description" : "The id of parent process group of this component if applicable." - }, - "parameterContext" : { - "description" : "The Parameter Context, or null if no Parameter Context has been bound to the Process Group", - "$ref" : "#/definitions/ParameterContextReferenceEntity" - }, - "breadcrumb" : { - "description" : "The breadcrumb of the process group.", - "$ref" : "#/definitions/FlowBreadcrumbEntity" - }, - "flow" : { - "description" : "The flow structure starting at this Process Group.", - "$ref" : "#/definitions/FlowDTO" - }, - "lastRefreshed" : { - "type" : "string", - "description" : "The time the flow for the process group was last refreshed." - } - } - }, - "ProcessGroupFlowEntity" : { - "type" : "object", - "properties" : { - "permissions" : { - "description" : "The access policy for this process group.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "processGroupFlow" : { - "$ref" : "#/definitions/ProcessGroupFlowDTO" - } - }, - "xml" : { - "name" : "processGroupFlowEntity" - } - }, - "ProcessGroupImportEntity" : { - "type" : "object", - "properties" : { - "processGroupRevision" : { - "description" : "The Revision for the Process Group", - "$ref" : "#/definitions/RevisionDTO" - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "versionedFlowSnapshot" : { - "description" : "The Versioned Flow Snapshot to import", - "$ref" : "#/definitions/VersionedFlowSnapshot" - } - }, - "xml" : { - "name" : "processGroupImportEntity" - } - }, - "ProcessGroupNameDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The ID of the Process Group" - }, - "name" : { - "type" : "string", - "description" : "The name of the Process Group, or the ID of the Process Group if the user does not have the READ policy for the Process Group" - } - } - }, - "ProcessGroupReplaceRequestDTO" : { - "type" : "object", - "properties" : { - "requestId" : { - "type" : "string", - "description" : "The unique ID of this request." - }, - "processGroupId" : { - "type" : "string", - "description" : "The unique ID of the Process Group being updated" - }, - "uri" : { - "type" : "string", - "description" : "The URI for future requests to this drop request." - }, - "lastUpdated" : { - "type" : "string", - "description" : "The last time this request was updated." - }, - "complete" : { - "type" : "boolean", - "description" : "Whether or not this request has completed" - }, - "failureReason" : { - "type" : "string", - "description" : "An explanation of why this request failed, or null if this request has not failed" - }, - "percentCompleted" : { - "type" : "integer", - "format" : "int32", - "description" : "The percentage complete for the request, between 0 and 100" - }, - "state" : { - "type" : "string", - "description" : "The state of the request" - } - } - }, - "ProcessGroupReplaceRequestEntity" : { - "type" : "object", - "properties" : { - "processGroupRevision" : { - "description" : "The revision for the Process Group being updated.", - "$ref" : "#/definitions/RevisionDTO" - }, - "request" : { - "description" : "The Process Group Change Request", - "$ref" : "#/definitions/ProcessGroupReplaceRequestDTO" - }, - "versionedFlowSnapshot" : { - "description" : "Returns the Versioned Flow to replace with", - "$ref" : "#/definitions/VersionedFlowSnapshot" - } - }, - "xml" : { - "name" : "processGroupReplaceRequestEntity" - } - }, - "ProcessGroupStatusDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The ID of the Process Group" - }, - "name" : { - "type" : "string", - "description" : "The name of the Process Group" - }, - "statsLastRefreshed" : { - "type" : "string", - "description" : "The time the status for the process group was last refreshed." - }, - "aggregateSnapshot" : { - "description" : "The aggregate status of all nodes in the cluster", - "$ref" : "#/definitions/ProcessGroupStatusSnapshotDTO" - }, - "nodeSnapshots" : { - "type" : "array", - "description" : "The status reported by each node in the cluster. If the NiFi instance is a standalone instance, rather than a clustered instance, this value may be null.", - "items" : { - "$ref" : "#/definitions/NodeProcessGroupStatusSnapshotDTO" - } - } - } - }, - "ProcessGroupStatusEntity" : { - "type" : "object", - "properties" : { - "processGroupStatus" : { - "$ref" : "#/definitions/ProcessGroupStatusDTO" - }, - "canRead" : { - "type" : "boolean", - "description" : "Indicates whether the user can read a given resource." - } - }, - "xml" : { - "name" : "processGroupStatusEntity" - } - }, - "ProcessGroupStatusSnapshotDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the process group." - }, - "name" : { - "type" : "string", - "description" : "The name of this process group." - }, - "connectionStatusSnapshots" : { - "type" : "array", - "description" : "The status of all connections in the process group.", - "items" : { - "$ref" : "#/definitions/ConnectionStatusSnapshotEntity" - } - }, - "processorStatusSnapshots" : { - "type" : "array", - "description" : "The status of all processors in the process group.", - "items" : { - "$ref" : "#/definitions/ProcessorStatusSnapshotEntity" - } - }, - "processGroupStatusSnapshots" : { - "type" : "array", - "description" : "The status of all process groups in the process group.", - "items" : { - "$ref" : "#/definitions/ProcessGroupStatusSnapshotEntity" - } - }, - "remoteProcessGroupStatusSnapshots" : { - "type" : "array", - "description" : "The status of all remote process groups in the process group.", - "items" : { - "$ref" : "#/definitions/RemoteProcessGroupStatusSnapshotEntity" - } - }, - "inputPortStatusSnapshots" : { - "type" : "array", - "description" : "The status of all input ports in the process group.", - "items" : { - "$ref" : "#/definitions/PortStatusSnapshotEntity" - } - }, - "outputPortStatusSnapshots" : { - "type" : "array", - "description" : "The status of all output ports in the process group.", - "items" : { - "$ref" : "#/definitions/PortStatusSnapshotEntity" - } - }, - "versionedFlowState" : { - "type" : "string", - "description" : "The current state of the Process Group, as it relates to the Versioned Flow", - "enum" : [ "LOCALLY_MODIFIED", "STALE", "LOCALLY_MODIFIED_AND_STALE", "UP_TO_DATE", "SYNC_FAILURE" ] - }, - "flowFilesIn" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of FlowFiles that have come into this ProcessGroup in the last 5 minutes" - }, - "bytesIn" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes that have come into this ProcessGroup in the last 5 minutes" - }, - "input" : { - "type" : "string", - "description" : "The input count/size for the process group in the last 5 minutes (pretty printed)." - }, - "flowFilesQueued" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of FlowFiles that are queued up in this ProcessGroup right now" - }, - "bytesQueued" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes that are queued up in this ProcessGroup right now" - }, - "queued" : { - "type" : "string", - "description" : "The count/size that is queued in the the process group." - }, - "queuedCount" : { - "type" : "string", - "description" : "The count that is queued for the process group." - }, - "queuedSize" : { - "type" : "string", - "description" : "The size that is queued for the process group." - }, - "bytesRead" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes read by components in this ProcessGroup in the last 5 minutes" - }, - "read" : { - "type" : "string", - "description" : "The number of bytes read in the last 5 minutes." - }, - "bytesWritten" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes written by components in this ProcessGroup in the last 5 minutes" - }, - "written" : { - "type" : "string", - "description" : "The number of bytes written in the last 5 minutes." - }, - "flowFilesOut" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of FlowFiles transferred out of this ProcessGroup in the last 5 minutes" - }, - "bytesOut" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes transferred out of this ProcessGroup in the last 5 minutes" - }, - "output" : { - "type" : "string", - "description" : "The output count/size for the process group in the last 5 minutes." - }, - "flowFilesTransferred" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of FlowFiles transferred in this ProcessGroup in the last 5 minutes" - }, - "bytesTransferred" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes transferred in this ProcessGroup in the last 5 minutes" - }, - "transferred" : { - "type" : "string", - "description" : "The count/size transferred to/from queues in the process group in the last 5 minutes." - }, - "bytesReceived" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes received from external sources by components within this ProcessGroup in the last 5 minutes" - }, - "flowFilesReceived" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of FlowFiles received from external sources by components within this ProcessGroup in the last 5 minutes" - }, - "received" : { - "type" : "string", - "description" : "The count/size sent to the process group in the last 5 minutes." - }, - "bytesSent" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes sent to an external sink by components within this ProcessGroup in the last 5 minutes" - }, - "flowFilesSent" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of FlowFiles sent to an external sink by components within this ProcessGroup in the last 5 minutes" - }, - "sent" : { - "type" : "string", - "description" : "The count/size sent from this process group in the last 5 minutes." - }, - "activeThreadCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The active thread count for this process group." - }, - "terminatedThreadCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of threads currently terminated for the process group." - } - } - }, - "ProcessGroupStatusSnapshotEntity" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the process group." - }, - "processGroupStatusSnapshot" : { - "$ref" : "#/definitions/ProcessGroupStatusSnapshotDTO" - }, - "canRead" : { - "type" : "boolean", - "description" : "Indicates whether the user can read a given resource." - } - }, - "xml" : { - "name" : "entity" - } - }, - "ProcessGroupsEntity" : { - "type" : "object", - "properties" : { - "processGroups" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ProcessGroupEntity" - } - } - }, - "xml" : { - "name" : "processGroupsEntity" - } - }, - "ProcessorConfigDTO" : { - "type" : "object", - "properties" : { - "properties" : { - "type" : "object", - "description" : "The properties for the processor. Properties whose value is not set will only contain the property name.", - "additionalProperties" : { - "type" : "string" - } - }, - "descriptors" : { - "type" : "object", - "description" : "Descriptors for the processor's properties.", - "additionalProperties" : { - "$ref" : "#/definitions/PropertyDescriptorDTO" - } - }, - "schedulingPeriod" : { - "type" : "string", - "description" : "The frequency with which to schedule the processor. The format of the value will depend on th value of schedulingStrategy." - }, - "schedulingStrategy" : { - "type" : "string", - "description" : "Indcates whether the prcessor should be scheduled to run in event or timer driven mode." - }, - "executionNode" : { - "type" : "string", - "description" : "Indicates the node where the process will execute." - }, - "penaltyDuration" : { - "type" : "string", - "description" : "The amount of time that is used when the process penalizes a flowfile." - }, - "yieldDuration" : { - "type" : "string", - "description" : "The amount of time that must elapse before this processor is scheduled again after yielding." - }, - "bulletinLevel" : { - "type" : "string", - "description" : "The level at which the processor will report bulletins." - }, - "runDurationMillis" : { - "type" : "integer", - "format" : "int64", - "description" : "The run duration for the processor in milliseconds." - }, - "concurrentlySchedulableTaskCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of tasks that should be concurrently schedule for the processor. If the processor doesn't allow parallol processing then any positive input will be ignored." - }, - "autoTerminatedRelationships" : { - "type" : "array", - "description" : "The names of all relationships that cause a flow file to be terminated if the relationship is not connected elsewhere. This property differs from the 'isAutoTerminate' property of the RelationshipDTO in that the RelationshipDTO is meant to depict the current configuration, whereas this property can be set in a DTO when updating a Processor in order to change which Relationships should be auto-terminated.", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - }, - "comments" : { - "type" : "string", - "description" : "The comments for the processor." - }, - "customUiUrl" : { - "type" : "string", - "description" : "The URL for the processor's custom configuration UI if applicable." - }, - "lossTolerant" : { - "type" : "boolean", - "description" : "Whether the processor is loss tolerant." - }, - "annotationData" : { - "type" : "string", - "description" : "The annotation data for the processor used to relay configuration between a custom UI and the procesosr." - }, - "defaultConcurrentTasks" : { - "type" : "object", - "description" : "Maps default values for concurrent tasks for each applicable scheduling strategy.", - "additionalProperties" : { - "type" : "string" - } - }, - "defaultSchedulingPeriod" : { - "type" : "object", - "description" : "Maps default values for scheduling period for each applicable scheduling strategy.", - "additionalProperties" : { - "type" : "string" - } - }, - "retryCount" : { - "type" : "integer", - "format" : "int32", - "description" : "Overall number of retries." - }, - "retriedRelationships" : { - "type" : "array", - "description" : "All the relationships should be retried.", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - }, - "backoffMechanism" : { - "type" : "string", - "description" : "Determines whether the FlowFile should be penalized or the processor should be yielded between retries.", - "enum" : [ "PENALIZE_FLOWFILE", "YIELD_PROCESSOR" ] - }, - "maxBackoffPeriod" : { - "type" : "string", - "description" : "Maximum amount of time to be waited during a retry period." - } - } - }, - "ProcessorDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "versionedComponentId" : { - "type" : "string", - "description" : "The ID of the corresponding component that is under version control" - }, - "parentGroupId" : { - "type" : "string", - "description" : "The id of parent process group of this component if applicable." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "name" : { - "type" : "string", - "description" : "The name of the processor." - }, - "type" : { - "type" : "string", - "description" : "The type of the processor." - }, - "bundle" : { - "description" : "The details of the artifact that bundled this processor type.", - "$ref" : "#/definitions/BundleDTO" - }, - "state" : { - "type" : "string", - "description" : "The state of the processor", - "enum" : [ "RUNNING", "STOPPED", "DISABLED" ] - }, - "style" : { - "type" : "object", - "description" : "Styles for the processor (background-color : #eee).", - "additionalProperties" : { - "type" : "string" - } - }, - "relationships" : { - "type" : "array", - "description" : "The available relationships that the processor currently supports.", - "items" : { - "$ref" : "#/definitions/RelationshipDTO" - } - }, - "description" : { - "type" : "string", - "description" : "The description of the processor." - }, - "supportsParallelProcessing" : { - "type" : "boolean", - "description" : "Whether the processor supports parallel processing." - }, - "supportsEventDriven" : { - "type" : "boolean", - "description" : "Whether the processor supports event driven scheduling." - }, - "supportsBatching" : { - "type" : "boolean", - "description" : "Whether the processor supports batching. This makes the run duration settings available." - }, - "persistsState" : { - "type" : "boolean", - "description" : "Whether the processor persists state." - }, - "restricted" : { - "type" : "boolean", - "description" : "Whether the processor requires elevated privileges." - }, - "deprecated" : { - "type" : "boolean", - "description" : "Whether the processor has been deprecated." - }, - "executionNodeRestricted" : { - "type" : "boolean", - "description" : "Indicates if the execution node of a processor is restricted to run only on the primary node" - }, - "multipleVersionsAvailable" : { - "type" : "boolean", - "description" : "Whether the processor has multiple versions available." - }, - "inputRequirement" : { - "type" : "string", - "description" : "The input requirement for this processor." - }, - "config" : { - "description" : "The configuration details for the processor. These details will be included in a response if the verbose flag is included in a request.", - "$ref" : "#/definitions/ProcessorConfigDTO" - }, - "validationErrors" : { - "type" : "array", - "description" : "The validation errors for the processor. These validation errors represent the problems with the processor that must be resolved before it can be started.", - "items" : { - "type" : "string" - } - }, - "validationStatus" : { - "type" : "string", - "description" : "Indicates whether the Processor is valid, invalid, or still in the process of validating (i.e., it is unknown whether or not the Processor is valid)", - "enum" : [ "VALID", "INVALID", "VALIDATING" ] - }, - "extensionMissing" : { - "type" : "boolean", - "description" : "Whether the underlying extension is missing." - } - } - }, - "ProcessorDefinition" : { - "type" : "object", - "required" : [ "type" ], - "properties" : { - "group" : { - "type" : "string", - "description" : "The group name of the bundle that provides the referenced type." - }, - "artifact" : { - "type" : "string", - "description" : "The artifact name of the bundle that provides the referenced type." - }, - "version" : { - "type" : "string", - "description" : "The version 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." - }, - "buildInfo" : { - "description" : "The build metadata for this component", - "$ref" : "#/definitions/BuildInfo" - }, - "providedApiImplementations" : { - "type" : "array", - "description" : "If this type represents a provider for an interface, this lists the APIs it implements", - "items" : { - "$ref" : "#/definitions/DefinedType" - } - }, - "tags" : { - "type" : "array", - "description" : "The tags associated with this type", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - }, - "deprecated" : { - "type" : "boolean", - "description" : "Whether or not the component has been deprecated" - }, - "deprecationReason" : { - "type" : "string", - "description" : "If this component has been deprecated, this optional field can be used to provide an explanation" - }, - "propertyDescriptors" : { - "type" : "object", - "description" : "Descriptions of configuration properties applicable to this component.", - "additionalProperties" : { - "$ref" : "#/definitions/PropertyDescriptor" - } - }, - "supportsDynamicProperties" : { - "type" : "boolean", - "description" : "Whether or not this component makes use of dynamic (user-set) properties." - }, - "inputRequirement" : { - "type" : "string", - "description" : "Any input requirements this processor has.", - "enum" : [ "INPUT_REQUIRED", "INPUT_ALLOWED", "INPUT_FORBIDDEN" ] - }, - "supportedRelationships" : { - "type" : "array", - "description" : "The supported relationships for this processor.", - "items" : { - "$ref" : "#/definitions/Relationship" - } - }, - "supportsDynamicRelationships" : { - "type" : "boolean", - "description" : "Whether or not this processor supports dynamic relationships." - }, - "triggerSerially" : { - "type" : "boolean", - "description" : "Whether or not this processor should be triggered serially (i.e. no concurrent execution)." - }, - "triggerWhenEmpty" : { - "type" : "boolean", - "description" : "Whether or not this processor should be triggered when incoming queues are empty." - }, - "triggerWhenAnyDestinationAvailable" : { - "type" : "boolean", - "description" : "Whether or not this processor should be triggered when any destination queue has room." - }, - "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." - }, - "supportsEventDriven" : { - "type" : "boolean", - "description" : "Whether or not this processor supports event driven scheduling. Indicates to the framework that the Processor is eligible to be scheduled to run based on the occurrence of an \"Event\" (e.g., when a FlowFile is enqueued in an incoming Connection), rather than being triggered periodically." - }, - "primaryNodeOnly" : { - "type" : "boolean", - "description" : "Whether or not this processor should be scheduled only on the primary node in a cluster." - }, - "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." - }, - "supportedSchedulingStrategies" : { - "type" : "array", - "description" : "The supported scheduling strategies, such as TIME_DRIVER, CRON, or EVENT_DRIVEN.", - "items" : { - "type" : "string" - } - }, - "defaultSchedulingStrategy" : { - "type" : "string", - "description" : "The default scheduling strategy for the processor." - }, - "defaultConcurrentTasksBySchedulingStrategy" : { - "type" : "object", - "description" : "The default concurrent tasks for each scheduling strategy.", - "additionalProperties" : { - "type" : "integer", - "format" : "int32" - } - }, - "defaultSchedulingPeriodBySchedulingStrategy" : { - "type" : "object", - "description" : "The default scheduling period for each scheduling strategy. The scheduling period is expected to be a time period, such as \"30 sec\".", - "additionalProperties" : { - "type" : "string" - } - }, - "defaultPenaltyDuration" : { - "type" : "string", - "description" : "The default penalty duration as a time period, such as \"30 sec\"." - }, - "defaultYieldDuration" : { - "type" : "string", - "description" : "The default yield duration as a time period, such as \"1 sec\"." - }, - "defaultBulletinLevel" : { - "type" : "string", - "description" : "The default bulletin level, such as WARN, INFO, DEBUG, etc." - } - } - }, - "ProcessorDiagnosticsDTO" : { - "type" : "object", - "properties" : { - "processor" : { - "description" : "Information about the Processor for which the Diagnostic Report is generated", - "$ref" : "#/definitions/ProcessorDTO" - }, - "processorStatus" : { - "description" : "The Status for the Processor for which the Diagnostic Report is generated", - "$ref" : "#/definitions/ProcessorStatusDTO" - }, - "referencedControllerServices" : { - "type" : "array", - "description" : "Diagnostic Information about all Controller Services that the Processor is referencing", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ControllerServiceDiagnosticsDTO" - } - }, - "incomingConnections" : { - "type" : "array", - "description" : "Diagnostic Information about all incoming Connections", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ConnectionDiagnosticsDTO" - } - }, - "outgoingConnections" : { - "type" : "array", - "description" : "Diagnostic Information about all outgoing Connections", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ConnectionDiagnosticsDTO" - } - }, - "jvmDiagnostics" : { - "description" : "Diagnostic Information about the JVM and system-level diagnostics", - "$ref" : "#/definitions/JVMDiagnosticsDTO" - }, - "threadDumps" : { - "type" : "array", - "description" : "Thread Dumps that were taken of the threads that are active in the Processor", - "items" : { - "$ref" : "#/definitions/ThreadDumpDTO" - } - }, - "classLoaderDiagnostics" : { - "description" : "Information about the Controller Service's Class Loader", - "$ref" : "#/definitions/ClassLoaderDiagnosticsDTO" - } - } - }, - "ProcessorDiagnosticsEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "component" : { - "description" : "The Processor Diagnostics", - "$ref" : "#/definitions/ProcessorDiagnosticsDTO" - } - }, - "xml" : { - "name" : "processorDiagnosticsEntity" - } - }, - "ProcessorEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "component" : { - "$ref" : "#/definitions/ProcessorDTO" - }, - "inputRequirement" : { - "type" : "string", - "description" : "The input requirement for this processor." - }, - "status" : { - "$ref" : "#/definitions/ProcessorStatusDTO" - }, - "operatePermissions" : { - "description" : "The permissions for this component operations.", - "$ref" : "#/definitions/PermissionsDTO" - } - }, - "xml" : { - "name" : "processorEntity" - } - }, - "ProcessorRunStatusDetailsDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The ID of the processor" - }, - "name" : { - "type" : "string", - "description" : "The name of the processor" - }, - "runStatus" : { - "type" : "string", - "description" : "The run status of the processor", - "enum" : [ "Running", "Stopped", "Invalid", "Validating", "Disabled" ] - }, - "validationErrors" : { - "type" : "array", - "description" : "The processor's validation errors", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - }, - "activeThreadCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The current number of threads that the processor is currently using" - } - } - }, - "ProcessorRunStatusDetailsEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for the Processor.", - "$ref" : "#/definitions/RevisionDTO" - }, - "permissions" : { - "description" : "The permissions for the Processor.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "runStatusDetails" : { - "description" : "The details of a Processor's run status", - "$ref" : "#/definitions/ProcessorRunStatusDetailsDTO" - } - }, - "xml" : { - "name" : "entity" - } - }, - "ProcessorRunStatusEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "state" : { - "type" : "string", - "description" : "The run status of the Processor.", - "enum" : [ "RUNNING", "STOPPED", "DISABLED" ] - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - } - }, - "xml" : { - "name" : "entity" - } - }, - "ProcessorStatusDTO" : { - "type" : "object", - "properties" : { - "groupId" : { - "type" : "string", - "description" : "The unique ID of the process group that the Processor belongs to" - }, - "id" : { - "type" : "string", - "description" : "The unique ID of the Processor" - }, - "name" : { - "type" : "string", - "description" : "The name of the Processor" - }, - "type" : { - "type" : "string", - "description" : "The type of the Processor" - }, - "runStatus" : { - "type" : "string", - "description" : "The run status of the Processor", - "enum" : [ "Running", "Stopped", "Validating", "Disabled", "Invalid" ] - }, - "statsLastRefreshed" : { - "type" : "string", - "description" : "The timestamp of when the stats were last refreshed" - }, - "aggregateSnapshot" : { - "description" : "A status snapshot that represents the aggregate stats of all nodes in the cluster. If the NiFi instance is a standalone instance, rather than a cluster, this represents the stats of the single instance.", - "$ref" : "#/definitions/ProcessorStatusSnapshotDTO" - }, - "nodeSnapshots" : { - "type" : "array", - "description" : "A status snapshot for each node in the cluster. If the NiFi instance is a standalone instance, rather than a cluster, this may be null.", - "items" : { - "$ref" : "#/definitions/NodeProcessorStatusSnapshotDTO" - } - } - } - }, - "ProcessorStatusEntity" : { - "type" : "object", - "properties" : { - "processorStatus" : { - "$ref" : "#/definitions/ProcessorStatusDTO" - }, - "canRead" : { - "type" : "boolean", - "description" : "Indicates whether the user can read a given resource." - } - }, - "xml" : { - "name" : "processorStatusEntity" - } - }, - "ProcessorStatusSnapshotDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the processor." - }, - "groupId" : { - "type" : "string", - "description" : "The id of the parent process group to which the processor belongs." - }, - "name" : { - "type" : "string", - "description" : "The name of the prcessor." - }, - "type" : { - "type" : "string", - "description" : "The type of the processor." - }, - "runStatus" : { - "type" : "string", - "description" : "The state of the processor.", - "enum" : [ "Running", "Stopped", "Validating", "Disabled", "Invalid" ] - }, - "executionNode" : { - "type" : "string", - "description" : "Indicates the node where the process will execute.", - "enum" : [ "ALL", "PRIMARY" ] - }, - "bytesRead" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes read by this Processor in the last 5 mintues" - }, - "bytesWritten" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes written by this Processor in the last 5 minutes" - }, - "read" : { - "type" : "string", - "description" : "The number of bytes read in the last 5 minutes." - }, - "written" : { - "type" : "string", - "description" : "The number of bytes written in the last 5 minutes." - }, - "flowFilesIn" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of FlowFiles that have been accepted in the last 5 minutes" - }, - "bytesIn" : { - "type" : "integer", - "format" : "int64", - "description" : "The size of the FlowFiles that have been accepted in the last 5 minutes" - }, - "input" : { - "type" : "string", - "description" : "The count/size of flowfiles that have been accepted in the last 5 minutes." - }, - "flowFilesOut" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of FlowFiles transferred to a Connection in the last 5 minutes" - }, - "bytesOut" : { - "type" : "integer", - "format" : "int64", - "description" : "The size of the FlowFiles transferred to a Connection in the last 5 minutes" - }, - "output" : { - "type" : "string", - "description" : "The count/size of flowfiles that have been processed in the last 5 minutes." - }, - "taskCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of times this Processor has run in the last 5 minutes" - }, - "tasksDurationNanos" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of nanoseconds that this Processor has spent running in the last 5 minutes" - }, - "tasks" : { - "type" : "string", - "description" : "The total number of task this connectable has completed over the last 5 minutes." - }, - "tasksDuration" : { - "type" : "string", - "description" : "The total duration of all tasks for this connectable over the last 5 minutes." - }, - "activeThreadCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of threads currently executing in the processor." - }, - "terminatedThreadCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of threads currently terminated for the processor." - } - } - }, - "ProcessorStatusSnapshotEntity" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the processor." - }, - "processorStatusSnapshot" : { - "$ref" : "#/definitions/ProcessorStatusSnapshotDTO" - }, - "canRead" : { - "type" : "boolean", - "description" : "Indicates whether the user can read a given resource." - } - }, - "xml" : { - "name" : "entity" - } - }, - "ProcessorTypesEntity" : { - "type" : "object", - "properties" : { - "processorTypes" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/DocumentedTypeDTO" - } - } - }, - "xml" : { - "name" : "processorTypesEntity" - } - }, - "ProcessorsEntity" : { - "type" : "object", - "properties" : { - "processors" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ProcessorEntity" - } - } - }, - "xml" : { - "name" : "processorsEntity" - } - }, - "ProcessorsRunStatusDetailsEntity" : { - "type" : "object", - "properties" : { - "runStatusDetails" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/ProcessorRunStatusDetailsEntity" - } - } - }, - "xml" : { - "name" : "processorsRunStatusDetails" - } - }, - "PropertyAllowableValue" : { - "type" : "object", - "required" : [ "value" ], - "properties" : { - "value" : { - "type" : "string", - "description" : "The internal value" - }, - "displayName" : { - "type" : "string", - "description" : "The display name of the value, if different from the internal value" - }, - "description" : { - "type" : "string", - "description" : "The description of the value, e.g., the behavior it produces." - } - } - }, - "PropertyDependency" : { - "type" : "object", - "properties" : { - "propertyName" : { - "type" : "string", - "description" : "The name of the property that is depended upon" - }, - "propertyDisplayName" : { - "type" : "string", - "description" : "The name of the property that is depended upon" - }, - "dependentValues" : { - "type" : "array", - "description" : "The values that satisfy the dependency", - "items" : { - "type" : "string" - } - } - } - }, - "PropertyDependencyDTO" : { - "type" : "object", - "properties" : { - "propertyName" : { - "type" : "string", - "description" : "The name of the property that is being depended upon" - }, - "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", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - } - } - }, - "PropertyDescriptor" : { - "type" : "object", - "required" : [ "name" ], - "properties" : { - "name" : { - "type" : "string", - "description" : "The name of the property key" - }, - "displayName" : { - "type" : "string", - "description" : "The display name of the property key, if different from the name" - }, - "description" : { - "type" : "string", - "description" : "The description of what the property does" - }, - "allowableValues" : { - "type" : "array", - "description" : "A list of the allowable values for the property", - "items" : { - "$ref" : "#/definitions/PropertyAllowableValue" - } - }, - "defaultValue" : { - "type" : "string", - "description" : "The default value if a user-set value is not specified" - }, - "required" : { - "type" : "boolean", - "description" : "Whether or not the property is required for the component" - }, - "sensitive" : { - "type" : "boolean", - "description" : "Whether or not the value of the property is considered sensitive (e.g., passwords and keys)" - }, - "expressionLanguageScope" : { - "type" : "string", - "description" : "The scope of expression language supported by this property", - "enum" : [ "NONE", "VARIABLE_REGISTRY", "FLOWFILE_ATTRIBUTES" ] - }, - "expressionLanguageScopeDescription" : { - "type" : "string", - "description" : "The description of the expression language scope supported by this property", - "readOnly" : true - }, - "typeProvidedByValue" : { - "description" : "Indicates that this property is for selecting a controller service of the specified type", - "$ref" : "#/definitions/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" - }, - "dynamic" : { - "type" : "boolean", - "description" : "Whether or not the descriptor is for a dynamically added property" - }, - "resourceDefinition" : { - "description" : "Indicates that this property references external resources", - "$ref" : "#/definitions/PropertyResourceDefinition" - }, - "dependencies" : { - "type" : "array", - "description" : "The dependencies that this property has on other properties", - "items" : { - "$ref" : "#/definitions/PropertyDependency" - } - } - } - }, - "PropertyDescriptorDTO" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The name for the property." - }, - "displayName" : { - "type" : "string", - "description" : "The human readable name for the property." - }, - "description" : { - "type" : "string", - "description" : "The description for the property. Used to relay additional details to a user or provide a mechanism of documenting intent." - }, - "defaultValue" : { - "type" : "string", - "description" : "The default value for the property." - }, - "allowableValues" : { - "type" : "array", - "description" : "Allowable values for the property. If empty then the allowed values are not constrained.", - "items" : { - "$ref" : "#/definitions/AllowableValueEntity" - } - }, - "required" : { - "type" : "boolean", - "description" : "Whether the property is required." - }, - "sensitive" : { - "type" : "boolean", - "description" : "Whether the property is sensitive and protected whenever stored or represented." - }, - "dynamic" : { - "type" : "boolean", - "description" : "Whether the property is dynamic (user-defined)." - }, - "supportsEl" : { - "type" : "boolean", - "description" : "Whether the property supports expression language." - }, - "expressionLanguageScope" : { - "type" : "string", - "description" : "Scope of the Expression Language evaluation for the property." - }, - "identifiesControllerService" : { - "type" : "string", - "description" : "If the property identifies a controller service this returns the fully qualified type." - }, - "identifiesControllerServiceBundle" : { - "description" : "If the property identifies a controller service this returns the bundle of the type, null otherwise.", - "$ref" : "#/definitions/BundleDTO" - }, - "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" : "#/definitions/PropertyDependencyDTO" - } - } - } - }, - "PropertyDescriptorEntity" : { - "type" : "object", - "properties" : { - "propertyDescriptor" : { - "$ref" : "#/definitions/PropertyDescriptorDTO" - } - }, - "xml" : { - "name" : "propertyDescriptor" - } - }, - "PropertyHistoryDTO" : { - "type" : "object", - "properties" : { - "previousValues" : { - "type" : "array", - "description" : "Previous values for a given property.", - "items" : { - "$ref" : "#/definitions/PreviousValueDTO" - } - } - } - }, - "PropertyResourceDefinition" : { - "type" : "object", - "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", - "uniqueItems" : true, - "items" : { - "type" : "string", - "enum" : [ "FILE", "DIRECTORY", "TEXT", "URL" ] - } - } - } - }, - "ProvenanceDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the provenance query." - }, - "uri" : { - "type" : "string", - "description" : "The URI for this query. Used for obtaining/deleting the request at a later time" - }, - "submissionTime" : { - "type" : "string", - "description" : "The timestamp when the query was submitted." - }, - "expiration" : { - "type" : "string", - "description" : "The timestamp when the query will expire." - }, - "percentCompleted" : { - "type" : "integer", - "format" : "int32", - "description" : "The current percent complete." - }, - "finished" : { - "type" : "boolean", - "description" : "Whether the query has finished." - }, - "request" : { - "description" : "The provenance request.", - "$ref" : "#/definitions/ProvenanceRequestDTO" - }, - "results" : { - "description" : "The provenance results.", - "$ref" : "#/definitions/ProvenanceResultsDTO" - } - } - }, - "ProvenanceEntity" : { - "type" : "object", - "properties" : { - "provenance" : { - "$ref" : "#/definitions/ProvenanceDTO" - } - }, - "xml" : { - "name" : "provenanceEntity" - } - }, - "ProvenanceEventDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The event uuid." - }, - "eventId" : { - "type" : "integer", - "format" : "int64", - "description" : "The event id. This is a one up number thats unique per node." - }, - "eventTime" : { - "type" : "string", - "description" : "The timestamp of the event." - }, - "eventDuration" : { - "type" : "integer", - "format" : "int64", - "description" : "The event duration in milliseconds." - }, - "lineageDuration" : { - "type" : "integer", - "format" : "int64", - "description" : "The duration since the lineage began, in milliseconds." - }, - "eventType" : { - "type" : "string", - "description" : "The type of the event." - }, - "flowFileUuid" : { - "type" : "string", - "description" : "The uuid of the flowfile for the event." - }, - "fileSize" : { - "type" : "string", - "description" : "The size of the flowfile for the event." - }, - "fileSizeBytes" : { - "type" : "integer", - "format" : "int64", - "description" : "The size of the flowfile in bytes for the event." - }, - "clusterNodeId" : { - "type" : "string", - "description" : "The identifier for the node where the event originated." - }, - "clusterNodeAddress" : { - "type" : "string", - "description" : "The label for the node where the event originated." - }, - "groupId" : { - "type" : "string", - "description" : "The id of the group that the component resides in. If the component is no longer in the flow, the group id will not be set." - }, - "componentId" : { - "type" : "string", - "description" : "The id of the component that generated the event." - }, - "componentType" : { - "type" : "string", - "description" : "The type of the component that generated the event." - }, - "componentName" : { - "type" : "string", - "description" : "The name of the component that generated the event." - }, - "sourceSystemFlowFileId" : { - "type" : "string", - "description" : "The source system flowfile id." - }, - "alternateIdentifierUri" : { - "type" : "string", - "description" : "The alternate identifier uri for the fileflow for the event." - }, - "attributes" : { - "type" : "array", - "description" : "The attributes of the flowfile for the event.", - "items" : { - "$ref" : "#/definitions/AttributeDTO" - } - }, - "parentUuids" : { - "type" : "array", - "description" : "The parent uuids for the event.", - "items" : { - "type" : "string" - } - }, - "childUuids" : { - "type" : "array", - "description" : "The child uuids for the event.", - "items" : { - "type" : "string" - } - }, - "transitUri" : { - "type" : "string", - "description" : "The source/destination system uri if the event was a RECEIVE/SEND." - }, - "relationship" : { - "type" : "string", - "description" : "The relationship to which the flowfile was routed if the event is of type ROUTE." - }, - "details" : { - "type" : "string", - "description" : "The event details." - }, - "contentEqual" : { - "type" : "boolean", - "description" : "Whether the input and output content claim is the same." - }, - "inputContentAvailable" : { - "type" : "boolean", - "description" : "Whether the input content is still available." - }, - "inputContentClaimSection" : { - "type" : "string", - "description" : "The section in which the input content claim lives." - }, - "inputContentClaimContainer" : { - "type" : "string", - "description" : "The container in which the input content claim lives." - }, - "inputContentClaimIdentifier" : { - "type" : "string", - "description" : "The identifier of the input content claim." - }, - "inputContentClaimOffset" : { - "type" : "integer", - "format" : "int64", - "description" : "The offset into the input content claim where the flowfiles content begins." - }, - "inputContentClaimFileSize" : { - "type" : "string", - "description" : "The file size of the input content claim formatted." - }, - "inputContentClaimFileSizeBytes" : { - "type" : "integer", - "format" : "int64", - "description" : "The file size of the intput content claim in bytes." - }, - "outputContentAvailable" : { - "type" : "boolean", - "description" : "Whether the output content is still available." - }, - "outputContentClaimSection" : { - "type" : "string", - "description" : "The section in which the output content claim lives." - }, - "outputContentClaimContainer" : { - "type" : "string", - "description" : "The container in which the output content claim lives." - }, - "outputContentClaimIdentifier" : { - "type" : "string", - "description" : "The identifier of the output content claim." - }, - "outputContentClaimOffset" : { - "type" : "integer", - "format" : "int64", - "description" : "The offset into the output content claim where the flowfiles content begins." - }, - "outputContentClaimFileSize" : { - "type" : "string", - "description" : "The file size of the output content claim formatted." - }, - "outputContentClaimFileSizeBytes" : { - "type" : "integer", - "format" : "int64", - "description" : "The file size of the output content claim in bytes." - }, - "replayAvailable" : { - "type" : "boolean", - "description" : "Whether or not replay is available." - }, - "replayExplanation" : { - "type" : "string", - "description" : "Explanation as to why replay is unavailable." - }, - "sourceConnectionIdentifier" : { - "type" : "string", - "description" : "The identifier of the queue/connection from which the flowfile was pulled to genereate this event. May be null if the queue/connection is unknown or the flowfile was generated from this event." - } - } - }, - "ProvenanceEventEntity" : { - "type" : "object", - "properties" : { - "provenanceEvent" : { - "$ref" : "#/definitions/ProvenanceEventDTO" - } - }, - "xml" : { - "name" : "provenanceEventEntity" - } - }, - "ProvenanceLinkDTO" : { - "type" : "object", - "properties" : { - "sourceId" : { - "type" : "string", - "description" : "The source node id of the link." - }, - "targetId" : { - "type" : "string", - "description" : "The target node id of the link." - }, - "flowFileUuid" : { - "type" : "string", - "description" : "The flowfile uuid that traversed the link." - }, - "timestamp" : { - "type" : "string", - "description" : "The timestamp of the link (based on the destination)." - }, - "millis" : { - "type" : "integer", - "format" : "int64", - "description" : "The timestamp of this link in milliseconds." - } - } - }, - "ProvenanceNodeDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the node." - }, - "flowFileUuid" : { - "type" : "string", - "description" : "The uuid of the flowfile associated with the provenance event." - }, - "parentUuids" : { - "type" : "array", - "description" : "The uuid of the parent flowfiles of the provenance event.", - "items" : { - "type" : "string" - } - }, - "childUuids" : { - "type" : "array", - "description" : "The uuid of the childrent flowfiles of the provenance event.", - "items" : { - "type" : "string" - } - }, - "clusterNodeIdentifier" : { - "type" : "string", - "description" : "The identifier of the node that this event/flowfile originated from." - }, - "type" : { - "type" : "string", - "description" : "The type of the node.", - "enum" : [ "FLOWFILE", "EVENT" ] - }, - "eventType" : { - "type" : "string", - "description" : "If the type is EVENT, this is the type of event." - }, - "millis" : { - "type" : "integer", - "format" : "int64", - "description" : "The timestamp of the node in milliseconds." - }, - "timestamp" : { - "type" : "string", - "description" : "The timestamp of the node formatted." - } - } - }, - "ProvenanceOptionsDTO" : { - "type" : "object", - "properties" : { - "searchableFields" : { - "type" : "array", - "description" : "The available searchable field for the NiFi.", - "items" : { - "$ref" : "#/definitions/ProvenanceSearchableFieldDTO" - } - } - } - }, - "ProvenanceOptionsEntity" : { - "type" : "object", - "properties" : { - "provenanceOptions" : { - "$ref" : "#/definitions/ProvenanceOptionsDTO" - } - }, - "xml" : { - "name" : "provenanceOptionsEntity" - } - }, - "ProvenanceRequestDTO" : { - "type" : "object", - "properties" : { - "searchTerms" : { - "type" : "object", - "description" : "The search terms used to perform the search.", - "additionalProperties" : { - "$ref" : "#/definitions/ProvenanceSearchValueDTO" - } - }, - "clusterNodeId" : { - "type" : "string", - "description" : "The id of the node in the cluster where this provenance originated." - }, - "startDate" : { - "type" : "string", - "description" : "The earliest event time to include in the query." - }, - "endDate" : { - "type" : "string", - "description" : "The latest event time to include in the query." - }, - "minimumFileSize" : { - "type" : "string", - "description" : "The minimum file size to include in the query." - }, - "maximumFileSize" : { - "type" : "string", - "description" : "The maximum file size to include in the query." - }, - "maxResults" : { - "type" : "integer", - "format" : "int32", - "description" : "The maximum number of results to include." - }, - "summarize" : { - "type" : "boolean", - "description" : "Whether or not to summarize provenance events returned. This property is false by default." - }, - "incrementalResults" : { - "type" : "boolean", - "description" : "Whether or not incremental results are returned. If false, provenance events are only returned once the query completes. This property is true by default." - } - } - }, - "ProvenanceResultsDTO" : { - "type" : "object", - "properties" : { - "provenanceEvents" : { - "type" : "array", - "description" : "The provenance events that matched the search criteria.", - "items" : { - "$ref" : "#/definitions/ProvenanceEventDTO" - } - }, - "total" : { - "type" : "string", - "description" : "The total number of results formatted." - }, - "totalCount" : { - "type" : "integer", - "format" : "int64", - "description" : "The total number of results." - }, - "generated" : { - "type" : "string", - "description" : "Then the search was performed." - }, - "oldestEvent" : { - "type" : "string", - "description" : "The oldest event available in the provenance repository." - }, - "timeOffset" : { - "type" : "integer", - "format" : "int32", - "description" : "The time offset of the server that's used for event time." - }, - "errors" : { - "type" : "array", - "description" : "Any errors that occurred while performing the provenance request.", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - } - } - }, - "ProvenanceSearchValueDTO" : { - "type" : "object", - "properties" : { - "value" : { - "type" : "string", - "description" : "The search value." - }, - "inverse" : { - "type" : "boolean", - "description" : "Query for all except for search value." - } - } - }, - "ProvenanceSearchableFieldDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the searchable field." - }, - "field" : { - "type" : "string", - "description" : "The searchable field." - }, - "label" : { - "type" : "string", - "description" : "The label for the searchable field." - }, - "type" : { - "type" : "string", - "description" : "The type of the searchable field." - } - } - }, - "QueueSizeDTO" : { - "type" : "object", - "properties" : { - "byteCount" : { - "type" : "integer", - "format" : "int64", - "description" : "The size of objects in a queue." - }, - "objectCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The count of objects in a queue." - } - } - }, - "RegistryClientEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "component" : { - "$ref" : "#/definitions/RegistryDTO" - } - }, - "xml" : { - "name" : "registryClientEntity" - } - }, - "RegistryClientsEntity" : { - "type" : "object", - "properties" : { - "registries" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/RegistryClientEntity" - } - } - }, - "xml" : { - "name" : "registryClientsEntity" - } - }, - "RegistryDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The registry identifier" - }, - "name" : { - "type" : "string", - "description" : "The registry name" - }, - "description" : { - "type" : "string", - "description" : "The registry description" - }, - "uri" : { - "type" : "string", - "description" : "The registry URI" - } - } - }, - "Relationship" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The name of the relationship" - }, - "description" : { - "type" : "string", - "description" : "The description of the relationship" - } - } - }, - "RelationshipDTO" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The relationship name." - }, - "description" : { - "type" : "string", - "description" : "The relationship description." - }, - "autoTerminate" : { - "type" : "boolean", - "description" : "Whether or not flowfiles sent to this relationship should auto terminate." - }, - "retry" : { - "type" : "boolean", - "description" : "Whether or not flowfiles sent to this relationship should retry." - } - } - }, - "RemotePortRunStatusEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "state" : { - "type" : "string", - "description" : "The run status of the RemotePort.", - "enum" : [ "TRANSMITTING", "STOPPED" ] - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - } - }, - "xml" : { - "name" : "entity" - } - }, - "RemoteProcessGroupContentsDTO" : { - "type" : "object", - "properties" : { - "inputPorts" : { - "type" : "array", - "description" : "The input ports to which data can be sent.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/RemoteProcessGroupPortDTO" - } - }, - "outputPorts" : { - "type" : "array", - "description" : "The output ports from which data can be retrieved.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/RemoteProcessGroupPortDTO" - } - } - } - }, - "RemoteProcessGroupDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "versionedComponentId" : { - "type" : "string", - "description" : "The ID of the corresponding component that is under version control" - }, - "parentGroupId" : { - "type" : "string", - "description" : "The id of parent process group of this component if applicable." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "targetUri" : { - "type" : "string", - "description" : "The target URI of the remote process group. If target uri is not set, but uris are set, then returns the first url in the urls. If neither target uri nor uris are set, then returns null." - }, - "targetUris" : { - "type" : "string", - "description" : "The target URI of the remote process group. If target uris is not set but target uri is set, then returns a collection containing the single target uri. If neither target uris nor uris are set, then returns null." - }, - "targetSecure" : { - "type" : "boolean", - "description" : "Whether the target is running securely." - }, - "name" : { - "type" : "string", - "description" : "The name of the remote process group." - }, - "comments" : { - "type" : "string", - "description" : "The comments for the remote process group." - }, - "communicationsTimeout" : { - "type" : "string", - "description" : "The time period used for the timeout when communicating with the target." - }, - "yieldDuration" : { - "type" : "string", - "description" : "When yielding, this amount of time must elapse before the remote process group is scheduled again." - }, - "transportProtocol" : { - "type" : "string" - }, - "localNetworkInterface" : { - "type" : "string", - "description" : "The local network interface to send/receive data. If not specified, any local address is used. If clustered, all nodes must have an interface with this identifier." - }, - "proxyHost" : { - "type" : "string" - }, - "proxyPort" : { - "type" : "integer", - "format" : "int32" - }, - "proxyUser" : { - "type" : "string" - }, - "proxyPassword" : { - "type" : "string" - }, - "authorizationIssues" : { - "type" : "array", - "description" : "Any remote authorization issues for the remote process group.", - "items" : { - "type" : "string" - } - }, - "validationErrors" : { - "type" : "array", - "description" : "The validation errors for the remote process group. These validation errors represent the problems with the remote process group that must be resolved before it can transmit.", - "items" : { - "type" : "string" - } - }, - "transmitting" : { - "type" : "boolean", - "description" : "Whether the remote process group is actively transmitting." - }, - "inputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of remote input ports currently available on the target." - }, - "outputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of remote output ports currently available on the target." - }, - "activeRemoteInputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of active remote input ports." - }, - "inactiveRemoteInputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of inactive remote input ports." - }, - "activeRemoteOutputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of active remote output ports." - }, - "inactiveRemoteOutputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of inactive remote output ports." - }, - "flowRefreshed" : { - "type" : "string", - "description" : "The timestamp when this remote process group was last refreshed." - }, - "contents" : { - "description" : "The contents of the remote process group. Will contain available input/output ports.", - "$ref" : "#/definitions/RemoteProcessGroupContentsDTO" - } - } - }, - "RemoteProcessGroupEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "component" : { - "$ref" : "#/definitions/RemoteProcessGroupDTO" - }, - "status" : { - "description" : "The status of the remote process group.", - "$ref" : "#/definitions/RemoteProcessGroupStatusDTO" - }, - "inputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of remote input ports currently available on the target." - }, - "outputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of remote output ports currently available on the target." - }, - "operatePermissions" : { - "description" : "The permissions for this component operations.", - "$ref" : "#/definitions/PermissionsDTO" - } - }, - "xml" : { - "name" : "remoteProcessGroupEntity" - } - }, - "RemoteProcessGroupPortDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the port." - }, - "targetId" : { - "type" : "string", - "description" : "The id of the target port." - }, - "versionedComponentId" : { - "type" : "string", - "description" : "The ID of the corresponding component that is under version control" - }, - "groupId" : { - "type" : "string", - "description" : "The id of the remote process group that the port resides in." - }, - "name" : { - "type" : "string", - "description" : "The name of the target port." - }, - "comments" : { - "type" : "string", - "description" : "The comments as configured on the target port." - }, - "concurrentlySchedulableTaskCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of task that may transmit flowfiles to the target port concurrently." - }, - "transmitting" : { - "type" : "boolean", - "description" : "Whether the remote port is configured for transmission." - }, - "useCompression" : { - "type" : "boolean", - "description" : "Whether the flowfiles are compressed when sent to the target port." - }, - "exists" : { - "type" : "boolean", - "description" : "Whether the target port exists." - }, - "targetRunning" : { - "type" : "boolean", - "description" : "Whether the target port is running." - }, - "connected" : { - "type" : "boolean", - "description" : "Whether the port has either an incoming or outgoing connection." - }, - "batchSettings" : { - "description" : "The batch settings for data transmission.", - "$ref" : "#/definitions/BatchSettingsDTO" - } - } - }, - "RemoteProcessGroupPortEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "remoteProcessGroupPort" : { - "$ref" : "#/definitions/RemoteProcessGroupPortDTO" - }, - "operatePermissions" : { - "description" : "The permissions for this component operations.", - "$ref" : "#/definitions/PermissionsDTO" - } - }, - "xml" : { - "name" : "remoteProcessGroupPortEntity" - } - }, - "RemoteProcessGroupStatusDTO" : { - "type" : "object", - "properties" : { - "groupId" : { - "type" : "string", - "description" : "The unique ID of the process group that the Processor belongs to" - }, - "id" : { - "type" : "string", - "description" : "The unique ID of the Processor" - }, - "name" : { - "type" : "string", - "description" : "The name of the remote process group." - }, - "targetUri" : { - "type" : "string", - "description" : "The URI of the target system." - }, - "transmissionStatus" : { - "type" : "string", - "description" : "The transmission status of the remote process group." - }, - "statsLastRefreshed" : { - "type" : "string", - "description" : "The time the status for the process group was last refreshed." - }, - "validationStatus" : { - "type" : "string", - "description" : "Indicates whether the component is valid, invalid, or still in the process of validating (i.e., it is unknown whether or not the component is valid)", - "enum" : [ "VALID", "INVALID", "VALIDATING" ] - }, - "aggregateSnapshot" : { - "description" : "A status snapshot that represents the aggregate stats of all nodes in the cluster. If the NiFi instance is a standalone instance, rather than a cluster, this represents the stats of the single instance.", - "$ref" : "#/definitions/RemoteProcessGroupStatusSnapshotDTO" - }, - "nodeSnapshots" : { - "type" : "array", - "description" : "A status snapshot for each node in the cluster. If the NiFi instance is a standalone instance, rather than a cluster, this may be null.", - "items" : { - "$ref" : "#/definitions/NodeRemoteProcessGroupStatusSnapshotDTO" - } - } - } - }, - "RemoteProcessGroupStatusEntity" : { - "type" : "object", - "properties" : { - "remoteProcessGroupStatus" : { - "$ref" : "#/definitions/RemoteProcessGroupStatusDTO" - }, - "canRead" : { - "type" : "boolean", - "description" : "Indicates whether the user can read a given resource." - } - }, - "xml" : { - "name" : "remoteProcessGroupStatusEntity" - } - }, - "RemoteProcessGroupStatusSnapshotDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the remote process group." - }, - "groupId" : { - "type" : "string", - "description" : "The id of the parent process group the remote process group resides in." - }, - "name" : { - "type" : "string", - "description" : "The name of the remote process group." - }, - "targetUri" : { - "type" : "string", - "description" : "The URI of the target system." - }, - "transmissionStatus" : { - "type" : "string", - "description" : "The transmission status of the remote process group." - }, - "activeThreadCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of active threads for the remote process group." - }, - "flowFilesSent" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of FlowFiles sent to the remote process group in the last 5 minutes." - }, - "bytesSent" : { - "type" : "integer", - "format" : "int64", - "description" : "The size of the FlowFiles sent to the remote process group in the last 5 minutes." - }, - "sent" : { - "type" : "string", - "description" : "The count/size of the flowfiles sent to the remote process group in the last 5 minutes." - }, - "flowFilesReceived" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of FlowFiles received from the remote process group in the last 5 minutes." - }, - "bytesReceived" : { - "type" : "integer", - "format" : "int64", - "description" : "The size of the FlowFiles received from the remote process group in the last 5 minutes." - }, - "received" : { - "type" : "string", - "description" : "The count/size of the flowfiles received from the remote process group in the last 5 minutes." - } - } - }, - "RemoteProcessGroupStatusSnapshotEntity" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the remote process group." - }, - "remoteProcessGroupStatusSnapshot" : { - "$ref" : "#/definitions/RemoteProcessGroupStatusSnapshotDTO" - }, - "canRead" : { - "type" : "boolean", - "description" : "Indicates whether the user can read a given resource." - } - }, - "xml" : { - "name" : "entity" - } - }, - "RemoteProcessGroupsEntity" : { - "type" : "object", - "properties" : { - "remoteProcessGroups" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/RemoteProcessGroupEntity" - } - } - }, - "xml" : { - "name" : "remoteProcessGroupsEntity" - } - }, - "RemoteQueuePartitionDTO" : { - "type" : "object", - "properties" : { - "totalFlowFileCount" : { - "type" : "integer", - "format" : "int32", - "description" : "Total number of FlowFiles owned by the Connection" - }, - "totalByteCount" : { - "type" : "integer", - "format" : "int64", - "description" : "Total number of bytes that make up the content for the FlowFiles owned by this Connection" - }, - "activeQueueFlowFileCount" : { - "type" : "integer", - "format" : "int32", - "description" : "Total number of FlowFiles that exist in the Connection's Active Queue, immediately available to be offered up to a component" - }, - "activeQueueByteCount" : { - "type" : "integer", - "format" : "int64", - "description" : "Total number of bytes that make up the content for the FlowFiles that are present in the Connection's Active Queue" - }, - "swapFlowFileCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The total number of FlowFiles that are swapped out for this Connection" - }, - "swapByteCount" : { - "type" : "integer", - "format" : "int64", - "description" : "Total number of bytes that make up the content for the FlowFiles that are swapped out to disk for the Connection" - }, - "swapFiles" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of Swap Files that exist for this Connection" - }, - "inFlightFlowFileCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of In-Flight FlowFiles for this Connection. These are FlowFiles that belong to the connection but are currently being operated on by a Processor, Port, etc." - }, - "inFlightByteCount" : { - "type" : "integer", - "format" : "int64", - "description" : "The number bytes that make up the content of the FlowFiles that are In-Flight" - }, - "nodeIdentifier" : { - "type" : "string", - "description" : "The Node Identifier that this queue partition is sending to" - } - } - }, - "ReportingTaskDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "versionedComponentId" : { - "type" : "string", - "description" : "The ID of the corresponding component that is under version control" - }, - "parentGroupId" : { - "type" : "string", - "description" : "The id of parent process group of this component if applicable." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "name" : { - "type" : "string", - "description" : "The name of the reporting task." - }, - "type" : { - "type" : "string", - "description" : "The fully qualified type of the reporting task." - }, - "bundle" : { - "description" : "The details of the artifact that bundled this processor type.", - "$ref" : "#/definitions/BundleDTO" - }, - "state" : { - "type" : "string", - "description" : "The state of the reporting task.", - "enum" : [ "RUNNING", "STOPPED", "DISABLED" ] - }, - "comments" : { - "type" : "string", - "description" : "The comments of the reporting task." - }, - "persistsState" : { - "type" : "boolean", - "description" : "Whether the reporting task persists state." - }, - "restricted" : { - "type" : "boolean", - "description" : "Whether the reporting task requires elevated privileges." - }, - "deprecated" : { - "type" : "boolean", - "description" : "Whether the reporting task has been deprecated." - }, - "multipleVersionsAvailable" : { - "type" : "boolean", - "description" : "Whether the reporting task has multiple versions available." - }, - "schedulingPeriod" : { - "type" : "string", - "description" : "The frequency with which to schedule the reporting task. The format of the value willd epend on the valud of the schedulingStrategy." - }, - "schedulingStrategy" : { - "type" : "string", - "description" : "The scheduling strategy that determines how the schedulingPeriod value should be interpreted." - }, - "defaultSchedulingPeriod" : { - "type" : "object", - "description" : "The default scheduling period for the different scheduling strategies.", - "additionalProperties" : { - "type" : "string" - } - }, - "properties" : { - "type" : "object", - "description" : "The properties of the reporting task.", - "additionalProperties" : { - "type" : "string" - } - }, - "descriptors" : { - "type" : "object", - "description" : "The descriptors for the reporting tasks properties.", - "additionalProperties" : { - "$ref" : "#/definitions/PropertyDescriptorDTO" - } - }, - "customUiUrl" : { - "type" : "string", - "description" : "The URL for the custom configuration UI for the reporting task." - }, - "annotationData" : { - "type" : "string", - "description" : "The annotation data for the repoting task. This is how the custom UI relays configuration to the reporting task." - }, - "validationErrors" : { - "type" : "array", - "description" : "Gets the validation errors from the reporting task. These validation errors represent the problems with the reporting task that must be resolved before it can be scheduled to run.", - "items" : { - "type" : "string" - } - }, - "validationStatus" : { - "type" : "string", - "description" : "Indicates whether the Processor is valid, invalid, or still in the process of validating (i.e., it is unknown whether or not the Processor is valid)", - "enum" : [ "VALID", "INVALID", "VALIDATING" ] - }, - "activeThreadCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of active threads for the reporting task." - }, - "extensionMissing" : { - "type" : "boolean", - "description" : "Whether the underlying extension is missing." - } - } - }, - "ReportingTaskDefinition" : { - "type" : "object", - "required" : [ "type" ], - "properties" : { - "group" : { - "type" : "string", - "description" : "The group name of the bundle that provides the referenced type." - }, - "artifact" : { - "type" : "string", - "description" : "The artifact name of the bundle that provides the referenced type." - }, - "version" : { - "type" : "string", - "description" : "The version 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." - }, - "buildInfo" : { - "description" : "The build metadata for this component", - "$ref" : "#/definitions/BuildInfo" - }, - "providedApiImplementations" : { - "type" : "array", - "description" : "If this type represents a provider for an interface, this lists the APIs it implements", - "items" : { - "$ref" : "#/definitions/DefinedType" - } - }, - "tags" : { - "type" : "array", - "description" : "The tags associated with this type", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - }, - "deprecated" : { - "type" : "boolean", - "description" : "Whether or not the component has been deprecated" - }, - "deprecationReason" : { - "type" : "string", - "description" : "If this component has been deprecated, this optional field can be used to provide an explanation" - }, - "propertyDescriptors" : { - "type" : "object", - "description" : "Descriptions of configuration properties applicable to this component.", - "additionalProperties" : { - "$ref" : "#/definitions/PropertyDescriptor" - } - }, - "supportsDynamicProperties" : { - "type" : "boolean", - "description" : "Whether or not this component makes use of dynamic (user-set) properties." - }, - "supportedSchedulingStrategies" : { - "type" : "array", - "description" : "The supported scheduling strategies, such as TIME_DRIVER or CRON.", - "items" : { - "type" : "string" - } - }, - "defaultSchedulingStrategy" : { - "type" : "string", - "description" : "The default scheduling strategy for the reporting task." - }, - "defaultSchedulingPeriodBySchedulingStrategy" : { - "type" : "object", - "description" : "The default scheduling period for each scheduling strategy. The scheduling period is expected to be a time period, such as \"30 sec\".", - "additionalProperties" : { - "type" : "string" - } - } - } - }, - "ReportingTaskEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "component" : { - "$ref" : "#/definitions/ReportingTaskDTO" - }, - "operatePermissions" : { - "description" : "The permissions for this component operations.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "status" : { - "description" : "The status for this ReportingTask.", - "$ref" : "#/definitions/ReportingTaskStatusDTO" - } - }, - "xml" : { - "name" : "reportingTaskEntity" - } - }, - "ReportingTaskRunStatusEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "state" : { - "type" : "string", - "description" : "The run status of the ReportingTask.", - "enum" : [ "RUNNING", "STOPPED" ] - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - } - }, - "xml" : { - "name" : "entity" - } - }, - "ReportingTaskStatusDTO" : { - "type" : "object", - "properties" : { - "runStatus" : { - "type" : "string", - "description" : "The run status of this ReportingTask", - "enum" : [ "RUNNING", "STOPPED", "DISABLED" ] - }, - "validationStatus" : { - "type" : "string", - "description" : "Indicates whether the component is valid, invalid, or still in the process of validating (i.e., it is unknown whether or not the component is valid)", - "enum" : [ "VALID", "INVALID", "VALIDATING" ] - }, - "activeThreadCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of active threads for the component." - } - } - }, - "ReportingTaskTypesEntity" : { - "type" : "object", - "properties" : { - "reportingTaskTypes" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/DocumentedTypeDTO" - } - } - }, - "xml" : { - "name" : "reportingTaskTypesEntity" - } - }, - "ReportingTasksEntity" : { - "type" : "object", - "properties" : { - "reportingTasks" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ReportingTaskEntity" - } - } - }, - "xml" : { - "name" : "reportingTasksEntity" - } - }, - "RepositoryUsageDTO" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The name of the repository" - }, - "fileStoreHash" : { - "type" : "string", - "description" : "A SHA-256 hash of the File Store name/path that is used to store the repository's data. This information is exposed as a hash in order to avoid exposing potentially sensitive information that is not generally relevant. What is typically relevant is whether or not multiple repositories on the same node are using the same File Store, as this indicates that the repositories are competing for the resources of the backing disk/storage mechanism." - }, - "freeSpace" : { - "type" : "string", - "description" : "Amount of free space." - }, - "totalSpace" : { - "type" : "string", - "description" : "Amount of total space." - }, - "freeSpaceBytes" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes of free space." - }, - "totalSpaceBytes" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes of total space." - }, - "utilization" : { - "type" : "string", - "description" : "Utilization of this storage location." - } - } - }, - "RequiredPermissionDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The required sub-permission necessary for this restriction." - }, - "label" : { - "type" : "string", - "description" : "The label for the required sub-permission necessary for this restriction." - } - } - }, - "ResourceDTO" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The identifier of the resource." - }, - "name" : { - "type" : "string", - "description" : "The name of the resource." - } - } - }, - "ResourcesEntity" : { - "type" : "object", - "properties" : { - "resources" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/ResourceDTO" - } - } - }, - "xml" : { - "name" : "resourcesEntity" - } - }, - "RevisionDTO" : { - "type" : "object", - "properties" : { - "clientId" : { - "type" : "string", - "description" : "A client identifier used to make a request. By including a client identifier, the API can allow multiple requests without needing the current revision. Due to the asynchronous nature of requests/responses this was implemented to allow the client to make numerous requests without having to wait for the previous response to come back" - }, - "version" : { - "type" : "integer", - "format" : "int64", - "description" : "NiFi employs an optimistic locking strategy where the client must include a revision in their request when performing an update. In a response to a mutable flow request, this field represents the updated base version." - }, - "lastModifier" : { - "type" : "string", - "description" : "The user that last modified the flow." - } - } - }, - "RevisionInfo" : { - "type" : "object", - "properties" : { - "clientId" : { - "type" : "string", - "description" : "A client identifier used to make a request. By including a client identifier, the API can allow multiple requests without needing the current revision. Due to the asynchronous nature of requests/responses this was implemented to allow the client to make numerous requests without having to wait for the previous response to come back." - }, - "version" : { - "type" : "integer", - "format" : "int64", - "description" : "NiFi Registry employs an optimistic locking strategy where the client must include a revision in their request when performing an update. In a response to a mutable flow request, this field represents the updated base version." - }, - "lastModifier" : { - "type" : "string", - "description" : "The user that last modified the entity.", - "readOnly" : true - } - }, - "description" : "The revision information for an entity managed through the REST API." - }, - "RunStatusDetailsRequestEntity" : { - "type" : "object", - "properties" : { - "processorIds" : { - "type" : "array", - "description" : "The IDs of all processors whose run status details should be provided", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - } - }, - "xml" : { - "name" : "runStatusDetailsRequest" - } - }, - "RuntimeManifest" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "A unique identifier for the manifest" - }, - "agentType" : { - "type" : "string", - "description" : "The type of the runtime binary, e.g., 'minifi-java' or 'minifi-cpp'" - }, - "version" : { - "type" : "string", - "description" : "The version of the runtime binary, e.g., '1.0.1'" - }, - "buildInfo" : { - "description" : "Build summary for this runtime binary", - "$ref" : "#/definitions/BuildInfo" - }, - "bundles" : { - "type" : "array", - "description" : "All extension bundles included with this runtime", - "items" : { - "$ref" : "#/definitions/Bundle" - } - }, - "schedulingDefaults" : { - "description" : "Scheduling defaults for components defined in this manifest", - "$ref" : "#/definitions/SchedulingDefaults" - } - } - }, - "RuntimeManifestEntity" : { - "type" : "object", - "properties" : { - "runtimeManifest" : { - "$ref" : "#/definitions/RuntimeManifest" - } - }, - "xml" : { - "name" : "runtimeManifestEntity" - } - }, - "ScheduleComponentsEntity" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the ProcessGroup" - }, - "state" : { - "type" : "string", - "description" : "The desired state of the descendant components", - "enum" : [ "RUNNING", "STOPPED", "ENABLED", "DISABLED" ] - }, - "components" : { - "type" : "object", - "description" : "Optional components to schedule. If not specified, all authorized descendant components will be used.", - "additionalProperties" : { - "$ref" : "#/definitions/RevisionDTO" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - } - }, - "xml" : { - "name" : "scheduleComponentEntity" - } - }, - "SchedulingDefaults" : { - "type" : "object", - "properties" : { - "defaultSchedulingStrategy" : { - "type" : "string", - "description" : "The name of the default scheduling strategy", - "enum" : [ "EVENT_DRIVEN", "TIMER_DRIVEN", "PRIMARY_NODE_ONLY", "CRON_DRIVEN" ] - }, - "defaultSchedulingPeriodMillis" : { - "type" : "integer", - "format" : "int64", - "description" : "The default scheduling period in milliseconds" - }, - "penalizationPeriodMillis" : { - "type" : "integer", - "format" : "int64", - "description" : "The default penalization period in milliseconds" - }, - "yieldDurationMillis" : { - "type" : "integer", - "format" : "int64", - "description" : "The default yield duration in milliseconds" - }, - "defaultRunDurationNanos" : { - "type" : "integer", - "format" : "int64", - "description" : "The default run duration in nano-seconds" - }, - "defaultMaxConcurrentTasks" : { - "type" : "string", - "description" : "The default concurrent tasks" - }, - "defaultConcurrentTasksBySchedulingStrategy" : { - "type" : "object", - "description" : "The default concurrent tasks for each scheduling strategy", - "additionalProperties" : { - "type" : "integer", - "format" : "int32" - } - }, - "defaultSchedulingPeriodsBySchedulingStrategy" : { - "type" : "object", - "description" : "The default scheduling period for each scheduling strategy", - "additionalProperties" : { - "type" : "string" - } - } - } - }, - "SearchResultGroupDTO" : { - "type" : "object", - "required" : [ "id" ], - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the group." - }, - "name" : { - "type" : "string", - "description" : "The name of the group." - } - } - }, - "SearchResultsDTO" : { - "type" : "object", - "properties" : { - "processorResults" : { - "type" : "array", - "description" : "The processors that matched the search.", - "items" : { - "$ref" : "#/definitions/ComponentSearchResultDTO" - } - }, - "connectionResults" : { - "type" : "array", - "description" : "The connections that matched the search.", - "items" : { - "$ref" : "#/definitions/ComponentSearchResultDTO" - } - }, - "processGroupResults" : { - "type" : "array", - "description" : "The process groups that matched the search.", - "items" : { - "$ref" : "#/definitions/ComponentSearchResultDTO" - } - }, - "inputPortResults" : { - "type" : "array", - "description" : "The input ports that matched the search.", - "items" : { - "$ref" : "#/definitions/ComponentSearchResultDTO" - } - }, - "outputPortResults" : { - "type" : "array", - "description" : "The output ports that matched the search.", - "items" : { - "$ref" : "#/definitions/ComponentSearchResultDTO" - } - }, - "remoteProcessGroupResults" : { - "type" : "array", - "description" : "The remote process groups that matched the search.", - "items" : { - "$ref" : "#/definitions/ComponentSearchResultDTO" - } - }, - "funnelResults" : { - "type" : "array", - "description" : "The funnels that matched the search.", - "items" : { - "$ref" : "#/definitions/ComponentSearchResultDTO" - } - }, - "labelResults" : { - "type" : "array", - "description" : "The labels that matched the search.", - "items" : { - "$ref" : "#/definitions/ComponentSearchResultDTO" - } - }, - "controllerServiceNodeResults" : { - "type" : "array", - "description" : "The controller service nodes that matched the search", - "items" : { - "$ref" : "#/definitions/ComponentSearchResultDTO" - } - }, - "parameterContextResults" : { - "type" : "array", - "description" : "The parameter contexts that matched the search.", - "items" : { - "$ref" : "#/definitions/ComponentSearchResultDTO" - } - }, - "parameterResults" : { - "type" : "array", - "description" : "The parameters that matched the search.", - "items" : { - "$ref" : "#/definitions/ComponentSearchResultDTO" - } - } - } - }, - "SearchResultsEntity" : { - "type" : "object", - "properties" : { - "searchResultsDTO" : { - "$ref" : "#/definitions/SearchResultsDTO" - } - }, - "xml" : { - "name" : "searchResultsEntity" - } - }, - "SnippetDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the snippet." - }, - "uri" : { - "type" : "string", - "description" : "The URI of the snippet." - }, - "parentGroupId" : { - "type" : "string", - "description" : "The group id for the components in the snippet." - }, - "processGroups" : { - "type" : "object", - "description" : "The ids of the process groups in this snippet. These ids will be populated within each response. They can be specified when creating a snippet. However, once a snippet has been created its contents cannot be modified (these ids are ignored during update requests).", - "additionalProperties" : { - "$ref" : "#/definitions/RevisionDTO" - } - }, - "remoteProcessGroups" : { - "type" : "object", - "description" : "The ids of the remote process groups in this snippet. These ids will be populated within each response. They can be specified when creating a snippet. However, once a snippet has been created its contents cannot be modified (these ids are ignored during update requests).", - "additionalProperties" : { - "$ref" : "#/definitions/RevisionDTO" - } - }, - "processors" : { - "type" : "object", - "description" : "The ids of the processors in this snippet. These ids will be populated within each response. They can be specified when creating a snippet. However, once a snippet has been created its contents cannot be modified (these ids are ignored during update requests).", - "additionalProperties" : { - "$ref" : "#/definitions/RevisionDTO" - } - }, - "inputPorts" : { - "type" : "object", - "description" : "The ids of the input ports in this snippet. These ids will be populated within each response. They can be specified when creating a snippet. However, once a snippet has been created its contents cannot be modified (these ids are ignored during update requests).", - "additionalProperties" : { - "$ref" : "#/definitions/RevisionDTO" - } - }, - "outputPorts" : { - "type" : "object", - "description" : "The ids of the output ports in this snippet. These ids will be populated within each response. They can be specified when creating a snippet. However, once a snippet has been created its contents cannot be modified (these ids are ignored during update requests).", - "additionalProperties" : { - "$ref" : "#/definitions/RevisionDTO" - } - }, - "connections" : { - "type" : "object", - "description" : "The ids of the connections in this snippet. These ids will be populated within each response. They can be specified when creating a snippet. However, once a snippet has been created its contents cannot be modified (these ids are ignored during update requests).", - "additionalProperties" : { - "$ref" : "#/definitions/RevisionDTO" - } - }, - "labels" : { - "type" : "object", - "description" : "The ids of the labels in this snippet. These ids will be populated within each response. They can be specified when creating a snippet. However, once a snippet has been created its contents cannot be modified (these ids are ignored during update requests).", - "additionalProperties" : { - "$ref" : "#/definitions/RevisionDTO" - } - }, - "funnels" : { - "type" : "object", - "description" : "The ids of the funnels in this snippet. These ids will be populated within each response. They can be specified when creating a snippet. However, once a snippet has been created its contents cannot be modified (these ids are ignored during update requests).", - "additionalProperties" : { - "$ref" : "#/definitions/RevisionDTO" - } - } - } - }, - "SnippetEntity" : { - "type" : "object", - "properties" : { - "snippet" : { - "description" : "The snippet.", - "$ref" : "#/definitions/SnippetDTO" - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - } - }, - "xml" : { - "name" : "snippetEntity" - } - }, - "StartVersionControlRequestEntity" : { - "type" : "object", - "properties" : { - "versionedFlow" : { - "description" : "The versioned flow", - "$ref" : "#/definitions/VersionedFlowDTO" - }, - "processGroupRevision" : { - "description" : "The Revision of the Process Group under Version Control", - "$ref" : "#/definitions/RevisionDTO" - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - } - }, - "xml" : { - "name" : "startVersionControlRequestEntity" - } - }, - "StateEntryDTO" : { - "type" : "object", - "properties" : { - "key" : { - "type" : "string", - "description" : "The key for this state." - }, - "value" : { - "type" : "string", - "description" : "The value for this state." - }, - "clusterNodeId" : { - "type" : "string", - "description" : "The identifier for the node where the state originated." - }, - "clusterNodeAddress" : { - "type" : "string", - "description" : "The label for the node where the state originated." - } - } - }, - "StateMapDTO" : { - "type" : "object", - "properties" : { - "scope" : { - "type" : "string", - "description" : "The scope of this StateMap." - }, - "totalEntryCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The total number of state entries. When the state map is lengthy, only of portion of the entries are returned." - }, - "state" : { - "type" : "array", - "description" : "The state.", - "items" : { - "$ref" : "#/definitions/StateEntryDTO" - } - } - } - }, - "StatusDescriptorDTO" : { - "type" : "object", - "properties" : { - "field" : { - "type" : "string", - "description" : "The name of the status field." - }, - "label" : { - "type" : "string", - "description" : "The label for the status field." - }, - "description" : { - "type" : "string", - "description" : "The description of the status field." - }, - "formatter" : { - "type" : "string", - "description" : "The formatter for the status descriptor." - } - } - }, - "StatusHistoryDTO" : { - "type" : "object", - "properties" : { - "generated" : { - "type" : "string", - "description" : "When the status history was generated." - }, - "componentDetails" : { - "type" : "object", - "description" : "A Map of key/value pairs that describe the component that the status history belongs to", - "additionalProperties" : { - "type" : "string" - } - }, - "fieldDescriptors" : { - "type" : "array", - "description" : "The Descriptors that provide information on each of the metrics provided in the status history", - "items" : { - "$ref" : "#/definitions/StatusDescriptorDTO" - } - }, - "aggregateSnapshots" : { - "type" : "array", - "description" : "A list of StatusSnapshotDTO objects that provide the actual metric values for the component. If the NiFi instance is clustered, this will represent the aggregate status across all nodes. If the NiFi instance is not clustered, this will represent the status of the entire NiFi instance.", - "items" : { - "$ref" : "#/definitions/StatusSnapshotDTO" - } - }, - "nodeSnapshots" : { - "type" : "array", - "description" : "The NodeStatusSnapshotsDTO objects that provide the actual metric values for the component, for each node. If the NiFi instance is not clustered, this value will be null.", - "items" : { - "$ref" : "#/definitions/NodeStatusSnapshotsDTO" - } - } - } - }, - "StatusHistoryEntity" : { - "type" : "object", - "properties" : { - "statusHistory" : { - "$ref" : "#/definitions/StatusHistoryDTO" - }, - "canRead" : { - "type" : "boolean", - "description" : "Indicates whether the user can read a given resource." - } - }, - "xml" : { - "name" : "statusHistoryEntity" - } - }, - "StatusSnapshotDTO" : { - "type" : "object", - "properties" : { - "timestamp" : { - "type" : "string", - "format" : "date-time", - "description" : "The timestamp of the snapshot." - }, - "statusMetrics" : { - "type" : "object", - "description" : "The status metrics.", - "additionalProperties" : { - "type" : "integer", - "format" : "int64" - } - } - } - }, - "StorageUsageDTO" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The identifier of this storage location. The identifier will correspond to the identifier keyed in the storage configuration." - }, - "freeSpace" : { - "type" : "string", - "description" : "Amount of free space." - }, - "totalSpace" : { - "type" : "string", - "description" : "Amount of total space." - }, - "usedSpace" : { - "type" : "string", - "description" : "Amount of used space." - }, - "freeSpaceBytes" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes of free space." - }, - "totalSpaceBytes" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes of total space." - }, - "usedSpaceBytes" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes of used space." - }, - "utilization" : { - "type" : "string", - "description" : "Utilization of this storage location." - } - } - }, - "StreamingOutput" : { - "type" : "object" - }, - "SubmitReplayRequestEntity" : { - "type" : "object", - "properties" : { - "eventId" : { - "type" : "integer", - "format" : "int64", - "description" : "The event identifier" - }, - "clusterNodeId" : { - "type" : "string", - "description" : "The identifier of the node where to submit the replay request." - } - }, - "xml" : { - "name" : "copySnippetRequestEntity" - } - }, - "SystemDiagnosticsDTO" : { - "type" : "object", - "properties" : { - "aggregateSnapshot" : { - "description" : "A systems diagnostic snapshot that represents the aggregate values of all nodes in the cluster. If the NiFi instance is a standalone instance, rather than a cluster, this represents the stats of the single instance.", - "$ref" : "#/definitions/SystemDiagnosticsSnapshotDTO" - }, - "nodeSnapshots" : { - "type" : "array", - "description" : "A systems diagnostics snapshot for each node in the cluster. If the NiFi instance is a standalone instance, rather than a cluster, this may be null.", - "items" : { - "$ref" : "#/definitions/NodeSystemDiagnosticsSnapshotDTO" - } - } - } - }, - "SystemDiagnosticsEntity" : { - "type" : "object", - "properties" : { - "systemDiagnostics" : { - "$ref" : "#/definitions/SystemDiagnosticsDTO" - } - }, - "xml" : { - "name" : "systemDiagnosticsEntity" - } - }, - "SystemDiagnosticsSnapshotDTO" : { - "type" : "object", - "properties" : { - "totalNonHeap" : { - "type" : "string", - "description" : "Total size of non heap." - }, - "totalNonHeapBytes" : { - "type" : "integer", - "format" : "int64", - "description" : "Total number of bytes allocated to the JVM not used for heap" - }, - "usedNonHeap" : { - "type" : "string", - "description" : "Amount of use non heap." - }, - "usedNonHeapBytes" : { - "type" : "integer", - "format" : "int64", - "description" : "Total number of bytes used by the JVM not in the heap space" - }, - "freeNonHeap" : { - "type" : "string", - "description" : "Amount of free non heap." - }, - "freeNonHeapBytes" : { - "type" : "integer", - "format" : "int64", - "description" : "Total number of free non-heap bytes available to the JVM" - }, - "maxNonHeap" : { - "type" : "string", - "description" : "Maximum size of non heap." - }, - "maxNonHeapBytes" : { - "type" : "integer", - "format" : "int64", - "description" : "The maximum number of bytes that the JVM can use for non-heap purposes" - }, - "nonHeapUtilization" : { - "type" : "string", - "description" : "Utilization of non heap." - }, - "totalHeap" : { - "type" : "string", - "description" : "Total size of heap." - }, - "totalHeapBytes" : { - "type" : "integer", - "format" : "int64", - "description" : "The total number of bytes that are available for the JVM heap to use" - }, - "usedHeap" : { - "type" : "string", - "description" : "Amount of used heap." - }, - "usedHeapBytes" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes of JVM heap that are currently being used" - }, - "freeHeap" : { - "type" : "string", - "description" : "Amount of free heap." - }, - "freeHeapBytes" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes that are allocated to the JVM heap but not currently being used" - }, - "maxHeap" : { - "type" : "string", - "description" : "Maximum size of heap." - }, - "maxHeapBytes" : { - "type" : "integer", - "format" : "int64", - "description" : "The maximum number of bytes that can be used by the JVM" - }, - "heapUtilization" : { - "type" : "string", - "description" : "Utilization of heap." - }, - "availableProcessors" : { - "type" : "integer", - "format" : "int32", - "description" : "Number of available processors if supported by the underlying system." - }, - "processorLoadAverage" : { - "type" : "number", - "format" : "double", - "description" : "The processor load average if supported by the underlying system." - }, - "totalThreads" : { - "type" : "integer", - "format" : "int32", - "description" : "Total number of threads." - }, - "daemonThreads" : { - "type" : "integer", - "format" : "int32", - "description" : "Number of daemon threads." - }, - "uptime" : { - "type" : "string", - "description" : "The uptime of the Java virtual machine" - }, - "flowFileRepositoryStorageUsage" : { - "description" : "The flowfile repository storage usage.", - "$ref" : "#/definitions/StorageUsageDTO" - }, - "contentRepositoryStorageUsage" : { - "type" : "array", - "description" : "The content repository storage usage.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/StorageUsageDTO" - } - }, - "provenanceRepositoryStorageUsage" : { - "type" : "array", - "description" : "The provenance repository storage usage.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/StorageUsageDTO" - } - }, - "garbageCollection" : { - "type" : "array", - "description" : "The garbage collection details.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/GarbageCollectionDTO" - } - }, - "statsLastRefreshed" : { - "type" : "string", - "description" : "When the diagnostics were generated." - }, - "versionInfo" : { - "description" : "The nifi, os, java, and build version information", - "$ref" : "#/definitions/VersionInfoDTO" - } - } - }, - "TemplateDTO" : { - "type" : "object", - "properties" : { - "uri" : { - "type" : "string", - "description" : "The URI for the template." - }, - "id" : { - "type" : "string", - "description" : "The id of the template." - }, - "groupId" : { - "type" : "string", - "description" : "The id of the Process Group that the template belongs to." - }, - "name" : { - "type" : "string", - "description" : "The name of the template." - }, - "description" : { - "type" : "string", - "description" : "The description of the template." - }, - "timestamp" : { - "type" : "string", - "description" : "The timestamp when this template was created." - }, - "encodingVersion" : { - "type" : "string", - "xml" : { - "name" : "encoding-version", - "attribute" : true - }, - "description" : "The encoding version of this template." - }, - "snippet" : { - "description" : "The contents of the template.", - "$ref" : "#/definitions/FlowSnippetDTO" - } - }, - "xml" : { - "name" : "template" - } - }, - "TemplateEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "template" : { - "$ref" : "#/definitions/TemplateDTO" - } - }, - "xml" : { - "name" : "templateEntity" - } - }, - "TemplatesEntity" : { - "type" : "object", - "properties" : { - "templates" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/TemplateEntity" - } - }, - "generated" : { - "type" : "string", - "description" : "When this content was generated." - } - }, - "xml" : { - "name" : "templatesEntity" - } - }, - "TenantDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "versionedComponentId" : { - "type" : "string", - "description" : "The ID of the corresponding component that is under version control" - }, - "parentGroupId" : { - "type" : "string", - "description" : "The id of parent process group of this component if applicable." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "identity" : { - "type" : "string", - "description" : "The identity of the tenant." - }, - "configurable" : { - "type" : "boolean", - "description" : "Whether this tenant is configurable." - } - } - }, - "TenantEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "component" : { - "$ref" : "#/definitions/TenantDTO" - } - }, - "xml" : { - "name" : "tenantEntity" - } - }, - "TenantsEntity" : { - "type" : "object", - "properties" : { - "users" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/TenantEntity" - } - }, - "userGroups" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/TenantEntity" - } - } - }, - "xml" : { - "name" : "tenantsEntity" - } - }, - "ThreadDumpDTO" : { - "type" : "object", - "properties" : { - "nodeId" : { - "type" : "string", - "description" : "The ID of the node in the cluster" - }, - "nodeAddress" : { - "type" : "string", - "description" : "The address of the node in the cluster" - }, - "apiPort" : { - "type" : "integer", - "format" : "int32", - "description" : "The port the node is listening for API requests." - }, - "stackTrace" : { - "type" : "string", - "description" : "The stack trace for the thread" - }, - "threadName" : { - "type" : "string", - "description" : "The name of the thread" - }, - "threadActiveMillis" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of milliseconds that the thread has been executing in the Processor" - }, - "taskTerminated" : { - "type" : "boolean", - "description" : "Indicates whether or not the user has requested that the task be terminated. If this is true, it may indicate that the thread is in a state where it will continue running indefinitely without returning." - } - } - }, - "TransactionResultEntity" : { - "type" : "object", - "properties" : { - "flowFileSent" : { - "type" : "integer", - "format" : "int32" - }, - "responseCode" : { - "type" : "integer", - "format" : "int32" - }, - "message" : { - "type" : "string" - } - }, - "xml" : { - "name" : "transactionResultEntity" - } - }, - "UpdateControllerServiceReferenceRequestEntity" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The identifier of the Controller Service." - }, - "state" : { - "type" : "string", - "description" : "The new state of the references for the controller service.", - "enum" : [ "ENABLED", "DISABLED", "RUNNING", "STOPPED" ] - }, - "referencingComponentRevisions" : { - "type" : "object", - "description" : "The revisions for all referencing components.", - "additionalProperties" : { - "$ref" : "#/definitions/RevisionDTO" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "uiOnly" : { - "type" : "boolean", - "description" : "Indicates whether or not the response should only include fields necessary for rendering the NiFi User Interface. As such, when this value is set to true, some fields may be returned as null values, and the selected fields may change at any time without notice. As a result, this value should not be set to true by any client other than the UI." - } - }, - "xml" : { - "name" : "updateControllerServiceReferenceRequestEntity" - } - }, - "UserDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "versionedComponentId" : { - "type" : "string", - "description" : "The ID of the corresponding component that is under version control" - }, - "parentGroupId" : { - "type" : "string", - "description" : "The id of parent process group of this component if applicable." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "identity" : { - "type" : "string", - "description" : "The identity of the tenant." - }, - "configurable" : { - "type" : "boolean", - "description" : "Whether this tenant is configurable." - }, - "userGroups" : { - "type" : "array", - "description" : "The groups to which the user belongs. This field is read only and it provided for convenience.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/TenantEntity" - } - }, - "accessPolicies" : { - "type" : "array", - "description" : "The access policies this user belongs to.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/AccessPolicySummaryEntity" - } - } - } - }, - "UserEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "component" : { - "$ref" : "#/definitions/UserDTO" - } - }, - "xml" : { - "name" : "userEntity" - } - }, - "UserGroupDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "versionedComponentId" : { - "type" : "string", - "description" : "The ID of the corresponding component that is under version control" - }, - "parentGroupId" : { - "type" : "string", - "description" : "The id of parent process group of this component if applicable." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "identity" : { - "type" : "string", - "description" : "The identity of the tenant." - }, - "configurable" : { - "type" : "boolean", - "description" : "Whether this tenant is configurable." - }, - "users" : { - "type" : "array", - "description" : "The users that belong to the user group.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/TenantEntity" - } - }, - "accessPolicies" : { - "type" : "array", - "description" : "The access policies this user group belongs to. This field was incorrectly defined as an AccessPolicyEntity. For compatibility reasons the field will remain of this type, however only the fields that are present in the AccessPolicySummaryEntity will be populated here.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/AccessPolicyEntity" - } - } - } - }, - "UserGroupEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "component" : { - "$ref" : "#/definitions/UserGroupDTO" - } - }, - "xml" : { - "name" : "userGroupEntity" - } - }, - "UserGroupsEntity" : { - "type" : "object", - "properties" : { - "userGroups" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/UserGroupEntity" - } - } - }, - "xml" : { - "name" : "userGroupsEntity" - } - }, - "UsersEntity" : { - "type" : "object", - "properties" : { - "generated" : { - "type" : "string", - "description" : "When this content was generated." - }, - "users" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/UserEntity" - } - } - }, - "xml" : { - "name" : "usersEntity" - } - }, - "VariableDTO" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The name of the variable" - }, - "value" : { - "type" : "string", - "description" : "The value of the variable" - }, - "processGroupId" : { - "type" : "string", - "description" : "The ID of the Process Group where this Variable is defined" - }, - "affectedComponents" : { - "type" : "array", - "description" : "A set of all components that will be affected if the value of this variable is changed", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/AffectedComponentEntity" - } - } - } - }, - "VariableEntity" : { - "type" : "object", - "properties" : { - "variable" : { - "description" : "The variable information", - "$ref" : "#/definitions/VariableDTO" - }, - "canWrite" : { - "type" : "boolean", - "description" : "Indicates whether the user can write a given resource." - } - }, - "xml" : { - "name" : "variableEntity" - } - }, - "VariableRegistryDTO" : { - "type" : "object", - "properties" : { - "variables" : { - "type" : "array", - "description" : "The variables that are available in this Variable Registry", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VariableEntity" - } - }, - "processGroupId" : { - "type" : "string", - "description" : "The UUID of the Process Group that this Variable Registry belongs to" - } - } - }, - "VariableRegistryEntity" : { - "type" : "object", - "properties" : { - "processGroupRevision" : { - "description" : "The revision of the Process Group that the Variable Registry belongs to", - "$ref" : "#/definitions/RevisionDTO" - }, - "variableRegistry" : { - "description" : "The Variable Registry.", - "$ref" : "#/definitions/VariableRegistryDTO" - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - } - }, - "xml" : { - "name" : "variableRegistryEntity" - } - }, - "VariableRegistryUpdateRequestDTO" : { - "type" : "object", - "properties" : { - "requestId" : { - "type" : "string", - "description" : "The ID of the request" - }, - "uri" : { - "type" : "string", - "description" : "The URI for the request" - }, - "submissionTime" : { - "type" : "string", - "format" : "date-time", - "description" : "The timestamp of when the request was submitted" - }, - "lastUpdated" : { - "type" : "string", - "format" : "date-time", - "description" : "The timestamp of when the request was last updated" - }, - "complete" : { - "type" : "boolean", - "description" : "Whether or not the request is completed" - }, - "failureReason" : { - "type" : "string", - "description" : "The reason for the request failing, or null if the request has not failed" - }, - "percentCompleted" : { - "type" : "integer", - "format" : "int32", - "description" : "A value between 0 and 100 (inclusive) indicating how close the request is to completion" - }, - "state" : { - "type" : "string", - "description" : "A description of the current state of the request" - }, - "updateSteps" : { - "type" : "array", - "description" : "The steps that are required in order to complete the request, along with the status of each", - "items" : { - "$ref" : "#/definitions/VariableRegistryUpdateStepDTO" - } - }, - "processGroupId" : { - "type" : "string", - "description" : "The unique ID of the Process Group that the variable registry belongs to" - }, - "affectedComponents" : { - "type" : "array", - "description" : "A set of all components that will be affected if the value of this variable is changed", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/AffectedComponentEntity" - } - } - } - }, - "VariableRegistryUpdateRequestEntity" : { - "type" : "object", - "properties" : { - "request" : { - "description" : "The Variable Registry Update Request", - "$ref" : "#/definitions/VariableRegistryUpdateRequestDTO" - }, - "processGroupRevision" : { - "description" : "The revision for the Process Group that owns this variable registry.", - "$ref" : "#/definitions/RevisionDTO" - } - }, - "xml" : { - "name" : "variableRegistryUpdateRequestEntity" - } - }, - "VariableRegistryUpdateStepDTO" : { - "type" : "object", - "properties" : { - "description" : { - "type" : "string", - "description" : "Explanation of what happens in this step" - }, - "complete" : { - "type" : "boolean", - "description" : "Whether or not this step has completed" - }, - "failureReason" : { - "type" : "string", - "description" : "An explanation of why this step failed, or null if this step did not fail" - } - } - }, - "VerifyConfigRequestDTO" : { - "type" : "object", - "properties" : { - "requestId" : { - "type" : "string", - "description" : "The ID of the request" - }, - "uri" : { - "type" : "string", - "description" : "The URI for the request" - }, - "submissionTime" : { - "type" : "string", - "format" : "date-time", - "description" : "The timestamp of when the request was submitted" - }, - "lastUpdated" : { - "type" : "string", - "format" : "date-time", - "description" : "The timestamp of when the request was last updated" - }, - "complete" : { - "type" : "boolean", - "description" : "Whether or not the request is completed" - }, - "failureReason" : { - "type" : "string", - "description" : "The reason for the request failing, or null if the request has not failed" - }, - "percentCompleted" : { - "type" : "integer", - "format" : "int32", - "description" : "A value between 0 and 100 (inclusive) indicating how close the request is to completion" - }, - "state" : { - "type" : "string", - "description" : "A description of the current state of the request" - }, - "updateSteps" : { - "type" : "array", - "description" : "The steps that are required in order to complete the request, along with the status of each", - "items" : { - "$ref" : "#/definitions/VerifyConfigUpdateStepDTO" - } - }, - "componentId" : { - "type" : "string", - "description" : "The ID of the component whose configuration was verified" - }, - "properties" : { - "type" : "object", - "description" : "The configured component properties", - "additionalProperties" : { - "type" : "string" - } - }, - "attributes" : { - "type" : "object", - "description" : "FlowFile Attributes that should be used to evaluate Expression Language for resolving property values", - "additionalProperties" : { - "type" : "string" - } - }, - "results" : { - "type" : "array", - "description" : "The Results of the verification", - "items" : { - "$ref" : "#/definitions/ConfigVerificationResultDTO" - } - } - } - }, - "VerifyConfigRequestEntity" : { - "type" : "object", - "properties" : { - "request" : { - "description" : "The request", - "$ref" : "#/definitions/VerifyConfigRequestDTO" - } - }, - "xml" : { - "name" : "verifyConfigRequest" - } - }, - "VerifyConfigUpdateStepDTO" : { - "type" : "object", - "properties" : { - "description" : { - "type" : "string", - "description" : "Explanation of what happens in this step" - }, - "complete" : { - "type" : "boolean", - "description" : "Whether or not this step has completed" - }, - "failureReason" : { - "type" : "string", - "description" : "An explanation of why this step failed, or null if this step did not fail" - } - } - }, - "VersionControlComponentMappingEntity" : { - "type" : "object", - "properties" : { - "versionControlComponentMapping" : { - "type" : "object", - "description" : "The mapping of Versioned Component Identifiers to instance ID's", - "additionalProperties" : { - "type" : "string" - } - }, - "processGroupRevision" : { - "description" : "The revision of the Process Group", - "$ref" : "#/definitions/RevisionDTO" - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "versionControlInformation" : { - "description" : "The Version Control information", - "$ref" : "#/definitions/VersionControlInformationDTO" - } - }, - "xml" : { - "name" : "versionControlComponentMappingEntity" - } - }, - "VersionControlInformationDTO" : { - "type" : "object", - "properties" : { - "groupId" : { - "type" : "string", - "description" : "The ID of the Process Group that is under version control" - }, - "registryId" : { - "type" : "string", - "description" : "The ID of the registry that the flow is stored in" - }, - "registryName" : { - "type" : "string", - "description" : "The name of the registry that the flow is stored in" - }, - "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" - }, - "flowId" : { - "type" : "string", - "description" : "The ID of the flow" - }, - "flowName" : { - "type" : "string", - "description" : "The name of the flow" - }, - "flowDescription" : { - "type" : "string", - "description" : "The description of the flow" - }, - "version" : { - "type" : "integer", - "format" : "int32", - "description" : "The version of the flow" - }, - "state" : { - "type" : "string", - "description" : "The current state of the Process Group, as it relates to the Versioned Flow", - "enum" : [ "LOCALLY_MODIFIED", "STALE", "LOCALLY_MODIFIED_AND_STALE", "UP_TO_DATE", "SYNC_FAILURE" ] - }, - "stateExplanation" : { - "type" : "string", - "description" : "Explanation of why the group is in the specified state" - } - } - }, - "VersionControlInformationEntity" : { - "type" : "object", - "properties" : { - "processGroupRevision" : { - "description" : "The Revision for the Process Group", - "$ref" : "#/definitions/RevisionDTO" - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "versionControlInformation" : { - "description" : "The Version Control information", - "$ref" : "#/definitions/VersionControlInformationDTO" - } - }, - "xml" : { - "name" : "versionControlInformationEntity" - } - }, - "VersionInfoDTO" : { - "type" : "object", - "properties" : { - "niFiVersion" : { - "type" : "string", - "description" : "The version of this NiFi." - }, - "javaVendor" : { - "type" : "string", - "description" : "Java JVM vendor" - }, - "javaVersion" : { - "type" : "string", - "description" : "Java version" - }, - "osName" : { - "type" : "string", - "description" : "Host operating system name" - }, - "osVersion" : { - "type" : "string", - "description" : "Host operating system version" - }, - "osArchitecture" : { - "type" : "string", - "description" : "Host operating system architecture" - }, - "buildTag" : { - "type" : "string", - "description" : "Build tag" - }, - "buildRevision" : { - "type" : "string", - "description" : "Build revision or commit hash" - }, - "buildBranch" : { - "type" : "string", - "description" : "Build branch" - }, - "buildTimestamp" : { - "type" : "string", - "format" : "date-time", - "description" : "Build timestamp" - } - } - }, - "VersionedConnection" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The component's unique identifier" - }, - "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" - }, - "comments" : { - "type" : "string", - "description" : "The user-supplied comments for the component" - }, - "position" : { - "description" : "The component's position on the graph", - "$ref" : "#/definitions/Position" - }, - "source" : { - "description" : "The source of the connection.", - "$ref" : "#/definitions/ConnectableComponent" - }, - "destination" : { - "description" : "The destination of the connection.", - "$ref" : "#/definitions/ConnectableComponent" - }, - "labelIndex" : { - "type" : "integer", - "format" : "int32", - "description" : "The index of the bend point where to place the connection label." - }, - "zIndex" : { - "type" : "integer", - "format" : "int64", - "description" : "The z index of the connection." - }, - "selectedRelationships" : { - "type" : "array", - "description" : "The selected relationship that comprise the connection.", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - }, - "backPressureObjectThreshold" : { - "type" : "integer", - "format" : "int64", - "description" : "The object count threshold for determining when back pressure is applied. Updating this value is a passive change in the sense that it won't impact whether existing files over the limit are affected but it does help feeder processors to stop pushing too much into this work queue." - }, - "backPressureDataSizeThreshold" : { - "type" : "string", - "description" : "The object data size threshold for determining when back pressure is applied. Updating this value is a passive change in the sense that it won't impact whether existing files over the limit are affected but it does help feeder processors to stop pushing too much into this work queue." - }, - "flowFileExpiration" : { - "type" : "string", - "description" : "The amount of time a flow file may be in the flow before it will be automatically aged out of the flow. Once a flow file reaches this age it will be terminated from the flow the next time a processor attempts to start work on it." - }, - "prioritizers" : { - "type" : "array", - "description" : "The comparators used to prioritize the queue.", - "items" : { - "type" : "string" - } - }, - "bends" : { - "type" : "array", - "description" : "The bend points on the connection.", - "items" : { - "$ref" : "#/definitions/Position" - } - }, - "loadBalanceStrategy" : { - "type" : "string", - "description" : "The Strategy to use for load balancing data across the cluster, or null, if no Load Balance Strategy has been specified.", - "enum" : [ "DO_NOT_LOAD_BALANCE", "PARTITION_BY_ATTRIBUTE", "ROUND_ROBIN", "SINGLE_NODE" ] - }, - "partitioningAttribute" : { - "type" : "string", - "description" : "The attribute to use for partitioning data as it is load balanced across the cluster. If the Load Balance Strategy is configured to use PARTITION_BY_ATTRIBUTE, the value returned by this method is the name of the FlowFile Attribute that will be used to determine which node in the cluster should receive a given FlowFile. If the Load Balance Strategy is unset or is set to any other value, the Partitioning Attribute has no effect." - }, - "loadBalanceCompression" : { - "type" : "string", - "description" : "Whether or not compression should be used when transferring FlowFiles between nodes", - "enum" : [ "DO_NOT_COMPRESS", "COMPRESS_ATTRIBUTES_ONLY", "COMPRESS_ATTRIBUTES_AND_CONTENT" ] - }, - "componentType" : { - "type" : "string", - "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE", "REPORTING_TASK", "PARAMETER_CONTEXT", "TEMPLATE" ] - }, - "groupIdentifier" : { - "type" : "string", - "description" : "The ID of the Process Group that this component belongs to" - } - } - }, - "VersionedControllerService" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The component's unique identifier" - }, - "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" - }, - "comments" : { - "type" : "string", - "description" : "The user-supplied comments for the component" - }, - "position" : { - "description" : "The component's position on the graph", - "$ref" : "#/definitions/Position" - }, - "type" : { - "type" : "string", - "description" : "The type of the extension component" - }, - "bundle" : { - "description" : "Information about the bundle from which the component came", - "$ref" : "#/definitions/Bundle" - }, - "properties" : { - "type" : "object", - "description" : "The properties for the component. Properties whose value is not set will only contain the property name.", - "additionalProperties" : { - "type" : "string" - } - }, - "propertyDescriptors" : { - "type" : "object", - "description" : "The property descriptors for the component.", - "additionalProperties" : { - "$ref" : "#/definitions/VersionedPropertyDescriptor" - } - }, - "controllerServiceApis" : { - "type" : "array", - "description" : "Lists the APIs this Controller Service implements.", - "items" : { - "$ref" : "#/definitions/ControllerServiceAPI" - } - }, - "annotationData" : { - "type" : "string", - "description" : "The annotation for the controller service. This is how the custom UI relays configuration to the controller service." - }, - "scheduledState" : { - "type" : "string", - "description" : "The ScheduledState denoting whether the Controller Service is ENABLED or DISABLED", - "enum" : [ "ENABLED", "DISABLED", "RUNNING" ] - }, - "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", "PARAMETER_CONTEXT", "TEMPLATE" ] - }, - "groupIdentifier" : { - "type" : "string", - "description" : "The ID of the Process Group that this component belongs to" - } - } - }, - "VersionedFlow" : { - "type" : "object", - "required" : [ "bucketIdentifier", "name", "type" ], - "properties" : { - "link" : { - "description" : "An WebLink to this entity.", - "readOnly" : true, - "$ref" : "#/definitions/JaxbLink" - }, - "identifier" : { - "type" : "string", - "description" : "An ID to uniquely identify this object.", - "readOnly" : true - }, - "name" : { - "type" : "string", - "description" : "The name of the item." - }, - "description" : { - "type" : "string", - "description" : "A description of the item." - }, - "bucketIdentifier" : { - "type" : "string", - "description" : "The identifier of the bucket this items belongs to. This cannot be changed after the item is created." - }, - "bucketName" : { - "type" : "string", - "description" : "The name of the bucket this items belongs to.", - "readOnly" : true - }, - "createdTimestamp" : { - "type" : "integer", - "format" : "int64", - "description" : "The timestamp of when the item was created, as milliseconds since epoch.", - "readOnly" : true, - "minimum" : 1 - }, - "modifiedTimestamp" : { - "type" : "integer", - "format" : "int64", - "description" : "The timestamp of when the item was last modified, as milliseconds since epoch.", - "readOnly" : true, - "minimum" : 1 - }, - "type" : { - "type" : "string", - "description" : "The type of item.", - "enum" : [ "Flow", "Bundle" ] - }, - "permissions" : { - "description" : "The access that the current user has to the bucket containing this item.", - "readOnly" : true, - "$ref" : "#/definitions/Permissions" - }, - "versionCount" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of versions of this flow.", - "readOnly" : true, - "minimum" : 0 - }, - "revision" : { - "description" : "The revision of this entity used for optimistic-locking during updates.", - "readOnly" : true, - "$ref" : "#/definitions/RevisionInfo" - } - } - }, - "VersionedFlowCoordinates" : { - "type" : "object", - "properties" : { - "registryUrl" : { - "type" : "string", - "description" : "The URL of the Flow Registry that contains the flow" - }, - "bucketId" : { - "type" : "string", - "description" : "The UUID of the bucket that the flow resides in" - }, - "flowId" : { - "type" : "string", - "description" : "The UUID of the flow" - }, - "version" : { - "type" : "integer", - "format" : "int32", - "description" : "The version of the flow" - }, - "latest" : { - "type" : "boolean", - "description" : "Whether or not these coordinates point to the latest version of the flow" - } - } - }, - "VersionedFlowDTO" : { - "type" : "object", - "properties" : { - "registryId" : { - "type" : "string", - "description" : "The ID of the registry that the flow is tracked to" - }, - "bucketId" : { - "type" : "string", - "description" : "The ID of the bucket where the flow is stored" - }, - "flowId" : { - "type" : "string", - "description" : "The ID of the flow" - }, - "flowName" : { - "type" : "string", - "description" : "The name of the flow" - }, - "description" : { - "type" : "string", - "description" : "A description of the flow" - }, - "comments" : { - "type" : "string", - "description" : "Comments for the changeset" - }, - "action" : { - "type" : "string", - "description" : "The action being performed", - "enum" : [ "COMMIT", "FORCE_COMMIT" ] - } - } - }, - "VersionedFlowEntity" : { - "type" : "object", - "properties" : { - "versionedFlow" : { - "description" : "The versioned flow", - "$ref" : "#/definitions/VersionedFlowDTO" - } - }, - "xml" : { - "name" : "versionedFlowEntity" - } - }, - "VersionedFlowSnapshot" : { - "type" : "object", - "required" : [ "flowContents", "snapshotMetadata" ], - "properties" : { - "snapshotMetadata" : { - "description" : "The metadata for this snapshot", - "$ref" : "#/definitions/VersionedFlowSnapshotMetadata" - }, - "flowContents" : { - "description" : "The contents of the versioned flow", - "$ref" : "#/definitions/VersionedProcessGroup" - }, - "externalControllerServices" : { - "type" : "object", - "description" : "The information about controller services that exist outside this versioned flow, but are referenced by components within the versioned flow.", - "additionalProperties" : { - "$ref" : "#/definitions/ExternalControllerServiceReference" - } - }, - "parameterContexts" : { - "type" : "object", - "description" : "The parameter contexts referenced by process groups in the flow contents. The mapping is from the name of the context to the context instance, and it is expected that any context in this map is referenced by at least one process group in this flow.", - "additionalProperties" : { - "$ref" : "#/definitions/VersionedParameterContext" - } - }, - "flowEncodingVersion" : { - "type" : "string", - "description" : "The optional encoding version of the flow contents." - }, - "flow" : { - "description" : "The flow this snapshot is for", - "readOnly" : true, - "$ref" : "#/definitions/VersionedFlow" - }, - "bucket" : { - "description" : "The bucket where the flow is located", - "readOnly" : true, - "$ref" : "#/definitions/Bucket" - }, - "latest" : { - "type" : "boolean" - } - } - }, - "VersionedFlowSnapshotEntity" : { - "type" : "object", - "properties" : { - "versionedFlowSnapshot" : { - "description" : "The versioned flow snapshot", - "$ref" : "#/definitions/VersionedFlowSnapshot" - }, - "processGroupRevision" : { - "description" : "The Revision of the Process Group under Version Control", - "$ref" : "#/definitions/RevisionDTO" - }, - "registryId" : { - "type" : "string", - "description" : "The ID of the Registry that this flow belongs to" - }, - "updateDescendantVersionedFlows" : { - "type" : "boolean", - "description" : "If the Process Group to be updated has a child or descendant Process Group that is also under Version Control, this specifies whether or not the contents of that child/descendant Process Group should be updated." - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - } - }, - "xml" : { - "name" : "versionedFlowSnapshotEntity" - } - }, - "VersionedFlowSnapshotMetadata" : { - "type" : "object", - "required" : [ "bucketIdentifier", "flowIdentifier", "version" ], - "properties" : { - "link" : { - "description" : "An WebLink to this entity.", - "readOnly" : true, - "$ref" : "#/definitions/JaxbLink" - }, - "bucketIdentifier" : { - "type" : "string", - "description" : "The identifier of the bucket this snapshot belongs to." - }, - "flowIdentifier" : { - "type" : "string", - "description" : "The identifier of the flow this snapshot belongs to." - }, - "version" : { - "type" : "integer", - "format" : "int32", - "description" : "The version of this snapshot of the flow.", - "minimum" : -1 - }, - "timestamp" : { - "type" : "integer", - "format" : "int64", - "description" : "The timestamp when the flow was saved, as milliseconds since epoch.", - "readOnly" : true, - "minimum" : 1 - }, - "author" : { - "type" : "string", - "description" : "The user that created this snapshot of the flow.", - "readOnly" : true - }, - "comments" : { - "type" : "string", - "description" : "The comments provided by the user when creating the snapshot." - } - } - }, - "VersionedFlowSnapshotMetadataEntity" : { - "type" : "object", - "properties" : { - "versionedFlowSnapshotMetadata" : { - "description" : "The collection of versioned flow snapshot metadata", - "$ref" : "#/definitions/VersionedFlowSnapshotMetadata" - }, - "registryId" : { - "type" : "string", - "description" : "The ID of the Registry that this flow belongs to" - } - }, - "xml" : { - "name" : "versionedFlowSnapshotMetadataEntity" - } - }, - "VersionedFlowSnapshotMetadataSetEntity" : { - "type" : "object", - "properties" : { - "versionedFlowSnapshotMetadataSet" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedFlowSnapshotMetadataEntity" - } - } - }, - "xml" : { - "name" : "versionedFlowSnapshotMetadataSetEntity" - } - }, - "VersionedFlowUpdateRequestDTO" : { - "type" : "object", - "properties" : { - "requestId" : { - "type" : "string", - "description" : "The unique ID of this request." - }, - "processGroupId" : { - "type" : "string", - "description" : "The unique ID of the Process Group being updated" - }, - "uri" : { - "type" : "string", - "description" : "The URI for future requests to this drop request." - }, - "lastUpdated" : { - "type" : "string", - "description" : "The last time this request was updated." - }, - "complete" : { - "type" : "boolean", - "description" : "Whether or not this request has completed" - }, - "failureReason" : { - "type" : "string", - "description" : "An explanation of why this request failed, or null if this request has not failed" - }, - "percentCompleted" : { - "type" : "integer", - "format" : "int32", - "description" : "The percentage complete for the request, between 0 and 100" - }, - "state" : { - "type" : "string", - "description" : "The state of the request" - }, - "versionControlInformation" : { - "description" : "The VersionControlInformation that describes where the Versioned Flow is located; this may not be populated until the request is completed.", - "$ref" : "#/definitions/VersionControlInformationDTO" - } - } - }, - "VersionedFlowUpdateRequestEntity" : { - "type" : "object", - "properties" : { - "processGroupRevision" : { - "description" : "The revision for the Process Group being updated.", - "$ref" : "#/definitions/RevisionDTO" - }, - "request" : { - "description" : "The Flow Update Request", - "$ref" : "#/definitions/VersionedFlowUpdateRequestDTO" - } - }, - "xml" : { - "name" : "versionedFlowUpdateRequestEntity" - } - }, - "VersionedFlowsEntity" : { - "type" : "object", - "properties" : { - "versionedFlows" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedFlowEntity" - } - } - }, - "xml" : { - "name" : "versionedFlowsEntity" - } - }, - "VersionedFunnel" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The component's unique identifier" - }, - "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" - }, - "comments" : { - "type" : "string", - "description" : "The user-supplied comments for the component" - }, - "position" : { - "description" : "The component's position on the graph", - "$ref" : "#/definitions/Position" - }, - "componentType" : { - "type" : "string", - "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE", "REPORTING_TASK", "PARAMETER_CONTEXT", "TEMPLATE" ] - }, - "groupIdentifier" : { - "type" : "string", - "description" : "The ID of the Process Group that this component belongs to" - } - } - }, - "VersionedLabel" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The component's unique identifier" - }, - "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" - }, - "comments" : { - "type" : "string", - "description" : "The user-supplied comments for the component" - }, - "position" : { - "description" : "The component's position on the graph", - "$ref" : "#/definitions/Position" - }, - "label" : { - "type" : "string", - "description" : "The text that appears in the label." - }, - "zIndex" : { - "type" : "integer", - "format" : "int64", - "description" : "The z index of the connection." - }, - "width" : { - "type" : "number", - "format" : "double", - "description" : "The width of the label in pixels when at a 1:1 scale." - }, - "height" : { - "type" : "number", - "format" : "double", - "description" : "The height of the label in pixels when at a 1:1 scale." - }, - "style" : { - "type" : "object", - "description" : "The styles for this label (font-size : 12px, background-color : #eee, etc).", - "additionalProperties" : { - "type" : "string" - } - }, - "componentType" : { - "type" : "string", - "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE", "REPORTING_TASK", "PARAMETER_CONTEXT", "TEMPLATE" ] - }, - "groupIdentifier" : { - "type" : "string", - "description" : "The ID of the Process Group that this component belongs to" - } - } - }, - "VersionedParameter" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The name of the parameter" - }, - "description" : { - "type" : "string", - "description" : "The description of the param" - }, - "sensitive" : { - "type" : "boolean", - "description" : "Whether or not the parameter value is sensitive" - }, - "value" : { - "type" : "string", - "description" : "The value of the parameter" - } - } - }, - "VersionedParameterContext" : { - "type" : "object", - "properties" : { - "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" - }, - "comments" : { - "type" : "string", - "description" : "The user-supplied comments for the component" - }, - "position" : { - "description" : "The component's position on the graph", - "$ref" : "#/definitions/Position" - }, - "parameters" : { - "type" : "array", - "description" : "The parameters in the context", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedParameter" - } - }, - "inheritedParameterContexts" : { - "type" : "array", - "description" : "The names of additional parameter contexts from which to inherit parameters", - "items" : { - "type" : "string" - } - }, - "description" : { - "type" : "string", - "description" : "The description of the parameter context" - }, - "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", "PARAMETER_CONTEXT", "TEMPLATE" ] - }, - "groupIdentifier" : { - "type" : "string", - "description" : "The ID of the Process Group that this component belongs to" - } - } - }, - "VersionedPort" : { - "type" : "object", - "properties" : { - "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" - }, - "comments" : { - "type" : "string", - "description" : "The user-supplied comments for the component" - }, - "position" : { - "description" : "The component's position on the graph", - "$ref" : "#/definitions/Position" - }, - "type" : { - "type" : "string", - "description" : "The type of port.", - "enum" : [ "INPUT_PORT", "OUTPUT_PORT" ] - }, - "concurrentlySchedulableTaskCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of tasks that should be concurrently scheduled for the port." - }, - "scheduledState" : { - "type" : "string", - "description" : "The scheduled state of the component", - "enum" : [ "ENABLED", "DISABLED", "RUNNING" ] - }, - "allowRemoteAccess" : { - "type" : "boolean", - "description" : "Whether or not this port allows remote access for site-to-site" - }, - "componentType" : { - "type" : "string", - "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE", "REPORTING_TASK", "PARAMETER_CONTEXT", "TEMPLATE" ] - }, - "groupIdentifier" : { - "type" : "string", - "description" : "The ID of the Process Group that this component belongs to" - } - } - }, - "VersionedProcessGroup" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The component's unique identifier" - }, - "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" - }, - "comments" : { - "type" : "string", - "description" : "The user-supplied comments for the component" - }, - "position" : { - "description" : "The component's position on the graph", - "$ref" : "#/definitions/Position" - }, - "processGroups" : { - "type" : "array", - "description" : "The child Process Groups", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedProcessGroup" - } - }, - "remoteProcessGroups" : { - "type" : "array", - "description" : "The Remote Process Groups", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedRemoteProcessGroup" - } - }, - "processors" : { - "type" : "array", - "description" : "The Processors", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedProcessor" - } - }, - "inputPorts" : { - "type" : "array", - "description" : "The Input Ports", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedPort" - } - }, - "outputPorts" : { - "type" : "array", - "description" : "The Output Ports", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedPort" - } - }, - "connections" : { - "type" : "array", - "description" : "The Connections", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedConnection" - } - }, - "labels" : { - "type" : "array", - "description" : "The Labels", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedLabel" - } - }, - "funnels" : { - "type" : "array", - "description" : "The Funnels", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedFunnel" - } - }, - "controllerServices" : { - "type" : "array", - "description" : "The Controller Services", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedControllerService" - } - }, - "versionedFlowCoordinates" : { - "description" : "The coordinates where the remote flow is stored, or null if the Process Group is not directly under Version Control", - "$ref" : "#/definitions/VersionedFlowCoordinates" - }, - "variables" : { - "type" : "object", - "description" : "The Variables in the Variable Registry for this Process Group (not including any ancestor or descendant Process Groups)", - "additionalProperties" : { - "type" : "string" - } - }, - "parameterContextName" : { - "type" : "string", - "description" : "The name of the parameter context used by this process group" - }, - "defaultFlowFileExpiration" : { - "type" : "string", - "description" : "The default FlowFile Expiration for this Process Group." - }, - "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." - }, - "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." - }, - "flowFileConcurrency" : { - "type" : "string", - "description" : "The configured FlowFile Concurrency for the Process Group" - }, - "flowFileOutboundPolicy" : { - "type" : "string", - "description" : "The FlowFile Outbound Policy for the Process Group" - }, - "componentType" : { - "type" : "string", - "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE", "REPORTING_TASK", "PARAMETER_CONTEXT", "TEMPLATE" ] - }, - "groupIdentifier" : { - "type" : "string", - "description" : "The ID of the Process Group that this component belongs to" - } - } - }, - "VersionedProcessor" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The component's unique identifier" - }, - "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" - }, - "comments" : { - "type" : "string", - "description" : "The user-supplied comments for the component" - }, - "position" : { - "description" : "The component's position on the graph", - "$ref" : "#/definitions/Position" - }, - "type" : { - "type" : "string", - "description" : "The type of the extension component" - }, - "bundle" : { - "description" : "Information about the bundle from which the component came", - "$ref" : "#/definitions/Bundle" - }, - "properties" : { - "type" : "object", - "description" : "The properties for the component. Properties whose value is not set will only contain the property name.", - "additionalProperties" : { - "type" : "string" - } - }, - "propertyDescriptors" : { - "type" : "object", - "description" : "The property descriptors for the component.", - "additionalProperties" : { - "$ref" : "#/definitions/VersionedPropertyDescriptor" - } - }, - "style" : { - "type" : "object", - "description" : "Stylistic data for rendering in a UI", - "additionalProperties" : { - "type" : "string" - } - }, - "annotationData" : { - "type" : "string", - "description" : "The annotation data for the processor used to relay configuration between a custom UI and the procesosr." - }, - "schedulingPeriod" : { - "type" : "string", - "description" : "The frequency with which to schedule the processor. The format of the value will depend on th value of schedulingStrategy." - }, - "schedulingStrategy" : { - "type" : "string", - "description" : "Indicates whether the processor should be scheduled to run in event or timer driven mode." - }, - "executionNode" : { - "type" : "string", - "description" : "Indicates the node where the process will execute." - }, - "penaltyDuration" : { - "type" : "string", - "description" : "The amout of time that is used when the process penalizes a flowfile." - }, - "yieldDuration" : { - "type" : "string", - "description" : "The amount of time that must elapse before this processor is scheduled again after yielding." - }, - "bulletinLevel" : { - "type" : "string", - "description" : "The level at which the processor will report bulletins." - }, - "runDurationMillis" : { - "type" : "integer", - "format" : "int64", - "description" : "The run duration for the processor in milliseconds." - }, - "concurrentlySchedulableTaskCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of tasks that should be concurrently schedule for the processor. If the processor doesn't allow parallol processing then any positive input will be ignored." - }, - "autoTerminatedRelationships" : { - "type" : "array", - "description" : "The names of all relationships that cause a flow file to be terminated if the relationship is not connected elsewhere. This property differs from the 'isAutoTerminate' property of the RelationshipDTO in that the RelationshipDTO is meant to depict the current configuration, whereas this property can be set in a DTO when updating a Processor in order to change which Relationships should be auto-terminated.", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - }, - "scheduledState" : { - "type" : "string", - "description" : "The scheduled state of the component", - "enum" : [ "ENABLED", "DISABLED", "RUNNING" ] - }, - "retryCount" : { - "type" : "integer", - "format" : "int32", - "description" : "Overall number of retries." - }, - "retriedRelationships" : { - "type" : "array", - "description" : "All the relationships should be retried.", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - }, - "backoffMechanism" : { - "type" : "string", - "description" : "Determines whether the FlowFile should be penalized or the processor should be yielded between retries.", - "enum" : [ "PENALIZE_FLOWFILE", "YIELD_PROCESSOR" ] - }, - "maxBackoffPeriod" : { - "type" : "string", - "description" : "Maximum amount of time to be waited during a retry period." - }, - "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", "PARAMETER_CONTEXT", "TEMPLATE" ] - }, - "groupIdentifier" : { - "type" : "string", - "description" : "The ID of the Process Group that this component belongs to" - } - } - }, - "VersionedPropertyDescriptor" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The name of the property" - }, - "displayName" : { - "type" : "string", - "description" : "The display name of the property" - }, - "identifiesControllerService" : { - "type" : "boolean", - "description" : "Whether or not the property provides the identifier of a Controller Service" - }, - "sensitive" : { - "type" : "boolean", - "description" : "Whether or not the property is considered sensitive" - }, - "resourceDefinition" : { - "description" : "Returns the Resource Definition that defines which type(s) of resource(s) this property references, if any", - "$ref" : "#/definitions/VersionedResourceDefinition" - } - } - }, - "VersionedRemoteGroupPort" : { - "type" : "object", - "properties" : { - "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" - }, - "comments" : { - "type" : "string", - "description" : "The user-supplied comments for the component" - }, - "position" : { - "description" : "The component's position on the graph", - "$ref" : "#/definitions/Position" - }, - "remoteGroupId" : { - "type" : "string", - "description" : "The id of the remote process group that the port resides in." - }, - "concurrentlySchedulableTaskCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of task that may transmit flowfiles to the target port concurrently." - }, - "useCompression" : { - "type" : "boolean", - "description" : "Whether the flowfiles are compressed when sent to the target port." - }, - "batchSize" : { - "description" : "The batch settings for data transmission.", - "$ref" : "#/definitions/BatchSize" - }, - "componentType" : { - "type" : "string", - "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE", "REPORTING_TASK", "PARAMETER_CONTEXT", "TEMPLATE" ] - }, - "targetId" : { - "type" : "string", - "description" : "The ID of the port on the target NiFi instance" - }, - "scheduledState" : { - "type" : "string", - "description" : "The scheduled state of the component", - "enum" : [ "ENABLED", "DISABLED", "RUNNING" ] - }, - "groupIdentifier" : { - "type" : "string", - "description" : "The ID of the Process Group that this component belongs to" - } - } - }, - "VersionedRemoteProcessGroup" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The component's unique identifier" - }, - "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" - }, - "comments" : { - "type" : "string", - "description" : "The user-supplied comments for the component" - }, - "position" : { - "description" : "The component's position on the graph", - "$ref" : "#/definitions/Position" - }, - "targetUri" : { - "type" : "string", - "description" : "[DEPRECATED] The target URI of the remote process group. If target uri is not set, but uris are set, then returns the first uri in the uris. If neither target uri nor uris are set, then returns null." - }, - "targetUris" : { - "type" : "string", - "description" : "The target URIs of the remote process group. If target uris is not set but target uri is set, then returns the single target uri. If neither target uris nor target uri is set, then returns null." - }, - "communicationsTimeout" : { - "type" : "string", - "description" : "The time period used for the timeout when communicating with the target." - }, - "yieldDuration" : { - "type" : "string", - "description" : "When yielding, this amount of time must elapse before the remote process group is scheduled again." - }, - "transportProtocol" : { - "type" : "string", - "description" : "The Transport Protocol that is used for Site-to-Site communications", - "enum" : [ "RAW", "HTTP" ] - }, - "localNetworkInterface" : { - "type" : "string", - "description" : "The local network interface to send/receive data. If not specified, any local address is used. If clustered, all nodes must have an interface with this identifier." - }, - "proxyHost" : { - "type" : "string" - }, - "proxyPort" : { - "type" : "integer", - "format" : "int32" - }, - "proxyUser" : { - "type" : "string" - }, - "inputPorts" : { - "type" : "array", - "description" : "A Set of Input Ports that can be connected to, in order to send data to the remote NiFi instance", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedRemoteGroupPort" - } - }, - "outputPorts" : { - "type" : "array", - "description" : "A Set of Output Ports that can be connected to, in order to pull data from the remote NiFi instance", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedRemoteGroupPort" - } - }, - "componentType" : { - "type" : "string", - "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE", "REPORTING_TASK", "PARAMETER_CONTEXT", "TEMPLATE" ] - }, - "groupIdentifier" : { - "type" : "string", - "description" : "The ID of the Process Group that this component belongs to" - } - } - }, - "VersionedResourceDefinition" : { - "type" : "object", - "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", - "uniqueItems" : true, - "items" : { - "type" : "string", - "enum" : [ "FILE", "DIRECTORY", "TEXT", "URL" ] - } - } - } - } - } -} \ No newline at end of file diff --git a/resources/client_gen/api_defs/nifi-1.17.0.json b/resources/client_gen/api_defs/nifi-1.17.0.json deleted file mode 100644 index a06d5019..00000000 --- a/resources/client_gen/api_defs/nifi-1.17.0.json +++ /dev/null @@ -1,23912 +0,0 @@ -{ - "swagger" : "2.0", - "info" : { - "description" : "The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and\n stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description,\n definitions of the expected input and output, potential response codes, and the authorizations required\n to invoke each service.", - "version" : "1.17.0", - "title" : "NiFi Rest API", - "contact" : { - "url" : "https://nifi.apache.org", - "email" : "dev@nifi.apache.org" - }, - "license" : { - "name" : "Apache 2.0", - "url" : "http://www.apache.org/licenses/LICENSE-2.0.html" - } - }, - "basePath" : "/nifi-api", - "tags" : [ { - "name" : "access", - "description" : "Endpoints for obtaining an access token or checking access status." - }, { - "name" : "accessoidc", - "description" : "Endpoints for obtaining an access token or checking access status." - }, { - "name" : "connections", - "description" : "Endpoint for managing a Connection." - }, { - "name" : "controller", - "description" : "Provides realtime command and control of this NiFi instance" - }, { - "name" : "controller-services", - "description" : "Endpoint for managing a Controller Service." - }, { - "name" : "counters", - "description" : "Endpoint for managing counters." - }, { - "name" : "data-transfer", - "description" : "Supports data transfers with this NiFi using HTTP based site to site" - }, { - "name" : "flow", - "description" : "Endpoint for accessing the flow structure and component status." - }, { - "name" : "flowfile-queues", - "description" : "Endpoint for managing a FlowFile Queue." - }, { - "name" : "funnel", - "description" : "Endpoint for managing a Funnel." - }, { - "name" : "input-ports", - "description" : "Endpoint for managing an Input Port." - }, { - "name" : "labels", - "description" : "Endpoint for managing a Label." - }, { - "name" : "output-ports", - "description" : "Endpoint for managing an Output Port." - }, { - "name" : "parameter-contexts", - "description" : "Endpoint for managing version control for a flow" - }, { - "name" : "policies", - "description" : "Endpoint for managing access policies." - }, { - "name" : "process-groups", - "description" : "Endpoint for managing a Process Group." - }, { - "name" : "processors", - "description" : "Endpoint for managing a Processor." - }, { - "name" : "provenance", - "description" : "Endpoint for accessing data flow provenance." - }, { - "name" : "provenance-events", - "description" : "Endpoint for accessing data flow provenance." - }, { - "name" : "remote-process-groups", - "description" : "Endpoint for managing a Remote Process Group." - }, { - "name" : "reporting-tasks", - "description" : "Endpoint for managing a Reporting Task." - }, { - "name" : "resources", - "description" : "Provides the resources in this NiFi that can have access/authorization policies." - }, { - "name" : "site-to-site", - "description" : "Provide access to site to site with this NiFi" - }, { - "name" : "snippets", - "description" : "Endpoint for accessing dataflow snippets." - }, { - "name" : "system-diagnostics", - "description" : "Endpoint for accessing system diagnostics." - }, { - "name" : "templates", - "description" : "Endpoint for managing a Template." - }, { - "name" : "tenants", - "description" : "Endpoint for managing users and user groups." - }, { - "name" : "versions", - "description" : "Endpoint for managing version control for a flow" - } ], - "schemes" : [ "http", "https" ], - "paths" : { - "/access" : { - "get" : { - "tags" : [ "access" ], - "summary" : "Gets the status the client's access", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getAccessStatus", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/AccessStatusEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Unable to determine access status because the client could not be authenticated." - }, - "403" : { - "description" : "Unable to determine access status because the client is not authorized to make this request." - }, - "409" : { - "description" : "Unable to determine access status because NiFi is not in the appropriate state." - }, - "500" : { - "description" : "Unable to determine access status because an unexpected error occurred." - } - } - } - }, - "/access/config" : { - "get" : { - "tags" : [ "access" ], - "summary" : "Retrieves the access configuration for this NiFi", - "description" : "", - "operationId" : "getLoginConfig", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/AccessConfigurationEntity" - } - } - } - } - }, - "/access/kerberos" : { - "post" : { - "tags" : [ "access" ], - "summary" : "Creates a token for accessing the REST API via Kerberos ticket exchange / SPNEGO negotiation", - "description" : "The token returned is formatted as a JSON Web Token (JWT). The token is base64 encoded and comprised of three parts. The header, the body, and the signature. The expiration of the token is a contained within the body. The token can be used in the Authorization header in the format 'Authorization: Bearer '. It is also stored in the browser as a cookie.", - "operationId" : "createAccessTokenFromTicket", - "consumes" : [ "text/plain" ], - "produces" : [ "text/plain" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "NiFi was unable to complete the request because it did not contain a valid Kerberos ticket in the Authorization header. Retry this request after initializing a ticket with kinit and ensuring your browser is configured to support SPNEGO." - }, - "409" : { - "description" : "Unable to create access token because NiFi is not in the appropriate state. (i.e. may not be configured to support Kerberos login." - }, - "500" : { - "description" : "Unable to create access token because an unexpected error occurred." - } - } - } - }, - "/access/knox/callback" : { - "get" : { - "tags" : [ "access" ], - "summary" : "Redirect/callback URI for processing the result of the Apache Knox login sequence.", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "knoxCallback", - "consumes" : [ "*/*" ], - "produces" : [ "*/*" ], - "responses" : { - "default" : { - "description" : "successful operation" - } - } - } - }, - "/access/knox/logout" : { - "get" : { - "tags" : [ "access" ], - "summary" : "Performs a logout in the Apache Knox.", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "knoxLogout", - "consumes" : [ "*/*" ], - "produces" : [ "*/*" ], - "responses" : { - "default" : { - "description" : "successful operation" - } - } - } - }, - "/access/knox/request" : { - "get" : { - "tags" : [ "access" ], - "summary" : "Initiates a request to authenticate through Apache Knox.", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "knoxRequest", - "consumes" : [ "*/*" ], - "produces" : [ "*/*" ], - "responses" : { - "default" : { - "description" : "successful operation" - } - } - } - }, - "/access/logout" : { - "delete" : { - "tags" : [ "access" ], - "summary" : "Performs a logout for other providers that have been issued a JWT.", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "logOut", - "consumes" : [ "*/*" ], - "produces" : [ "*/*" ], - "responses" : { - "200" : { - "description" : "User was logged out successfully." - }, - "401" : { - "description" : "Authentication token provided was empty or not in the correct JWT format." - }, - "500" : { - "description" : "Client failed to log out." - } - } - } - }, - "/access/logout/complete" : { - "get" : { - "tags" : [ "access" ], - "summary" : "Completes the logout sequence by removing the cached Logout Request and Cookie if they existed and redirects to /nifi/login.", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "logOutComplete", - "consumes" : [ "*/*" ], - "produces" : [ "*/*" ], - "responses" : { - "200" : { - "description" : "User was logged out successfully." - }, - "401" : { - "description" : "Authentication token provided was empty or not in the correct JWT format." - }, - "500" : { - "description" : "Client failed to log out." - } - } - } - }, - "/access/oidc/callback" : { - "get" : { - "tags" : [ "accessoidc" ], - "summary" : "Redirect/callback URI for processing the result of the OpenId Connect login sequence.", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "oidcCallback", - "consumes" : [ "*/*" ], - "produces" : [ "*/*" ], - "responses" : { - "default" : { - "description" : "successful operation" - } - } - } - }, - "/access/oidc/exchange" : { - "post" : { - "tags" : [ "accessoidc" ], - "summary" : "Retrieves a JWT following a successful login sequence using the configured OpenId Connect provider.", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "oidcExchange", - "consumes" : [ "*/*" ], - "produces" : [ "text/plain" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - } - } - } - }, - "/access/oidc/logout" : { - "get" : { - "tags" : [ "accessoidc" ], - "summary" : "Performs a logout in the OpenId Provider.", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "oidcLogout", - "consumes" : [ "*/*" ], - "produces" : [ "*/*" ], - "responses" : { - "default" : { - "description" : "successful operation" - } - } - } - }, - "/access/oidc/logoutCallback" : { - "get" : { - "tags" : [ "accessoidc" ], - "summary" : "Redirect/callback URI for processing the result of the OpenId Connect logout sequence.", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "oidcLogoutCallback", - "consumes" : [ "*/*" ], - "produces" : [ "*/*" ], - "responses" : { - "default" : { - "description" : "successful operation" - } - } - } - }, - "/access/oidc/request" : { - "get" : { - "tags" : [ "accessoidc" ], - "summary" : "Initiates a request to authenticate through the configured OpenId Connect provider.", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "oidcRequest", - "consumes" : [ "*/*" ], - "produces" : [ "*/*" ], - "responses" : { - "default" : { - "description" : "successful operation" - } - } - } - }, - "/access/token" : { - "post" : { - "tags" : [ "access" ], - "summary" : "Creates a token for accessing the REST API via username/password", - "description" : "The token returned is formatted as a JSON Web Token (JWT). The token is base64 encoded and comprised of three parts. The header, the body, and the signature. The expiration of the token is a contained within the body. 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", - "consumes" : [ "application/x-www-form-urlencoded" ], - "produces" : [ "text/plain" ], - "parameters" : [ { - "name" : "username", - "in" : "formData", - "required" : false, - "type" : "string" - }, { - "name" : "password", - "in" : "formData", - "required" : false, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "Unable to create access token because NiFi is not in the appropriate state. (i.e. may not be configured to support username/password login." - }, - "500" : { - "description" : "Unable to create access token because an unexpected error occurred." - } - } - } - }, - "/access/token/expiration" : { - "get" : { - "tags" : [ "access" ], - "summary" : "Get expiration for current Access Token", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getAccessTokenExpiration", - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "Access Token Expiration found", - "schema" : { - "$ref" : "#/definitions/AccessTokenExpirationEntity" - } - }, - "401" : { - "description" : "Access Token not authorized" - }, - "409" : { - "description" : "Access Token not resolved" - } - } - } - }, - "/connections/{id}" : { - "get" : { - "tags" : [ "connections" ], - "summary" : "Gets a connection", - "description" : "", - "operationId" : "getConnection", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The connection id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ConnectionEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read Source - /{component-type}/{uuid}" : [ ] - }, { - "Read Destination - /{component-type}/{uuid}" : [ ] - } ] - }, - "put" : { - "tags" : [ "connections" ], - "summary" : "Updates a connection", - "description" : "", - "operationId" : "updateConnection", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The connection id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The connection configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ConnectionEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ConnectionEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write Source - /{component-type}/{uuid}" : [ ] - }, { - "Write Destination - /{component-type}/{uuid}" : [ ] - }, { - "Write New Destination - /{component-type}/{uuid} - if updating Destination" : [ ] - }, { - "Write Process Group - /process-groups/{uuid} - if updating Destination" : [ ] - } ] - }, - "delete" : { - "tags" : [ "connections" ], - "summary" : "Deletes a connection", - "description" : "", - "operationId" : "deleteConnection", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The revision is used to verify the client is working with the latest version of the flow.", - "required" : false, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The connection id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ConnectionEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write Source - /{component-type}/{uuid}" : [ ] - }, { - "Write - Parent Process Group - /process-groups/{uuid}" : [ ] - }, { - "Write Destination - /{component-type}/{uuid}" : [ ] - } ] - } - }, - "/controller-services/{id}" : { - "get" : { - "tags" : [ "controller-services" ], - "summary" : "Gets a controller service", - "description" : "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", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The controller service id.", - "required" : true, - "type" : "string" - }, { - "name" : "uiOnly", - "in" : "query", - "required" : false, - "type" : "boolean", - "default" : false - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ControllerServiceEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /controller-services/{uuid}" : [ ] - } ] - }, - "put" : { - "tags" : [ "controller-services" ], - "summary" : "Updates a controller service", - "description" : "", - "operationId" : "updateControllerService", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The controller service id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The controller service configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ControllerServiceEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ControllerServiceEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /controller-services/{uuid}" : [ ] - }, { - "Read - any referenced Controller Services if this request changes the reference - /controller-services/{uuid}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "controller-services" ], - "summary" : "Deletes a controller service", - "description" : "", - "operationId" : "removeControllerService", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The revision is used to verify the client is working with the latest version of the flow.", - "required" : false, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The controller service id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ControllerServiceEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /controller-services/{uuid}" : [ ] - }, { - "Write - Parent Process Group if scoped by Process Group - /process-groups/{uuid}" : [ ] - }, { - "Write - Controller if scoped by Controller - /controller" : [ ] - }, { - "Read - any referenced Controller Services - /controller-services/{uuid}" : [ ] - } ] - } - }, - "/controller-services/{id}/config/analysis" : { - "post" : { - "tags" : [ "controller-services" ], - "summary" : "Performs analysis of the component's configuration, providing information about which attributes are referenced.", - "description" : "", - "operationId" : "analyzeConfiguration", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The controller service id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The configuration analysis request.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ConfigurationAnalysisEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/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. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /controller-services/{uuid}" : [ ] - } ] - } - }, - "/controller-services/{id}/config/verification-requests" : { - "post" : { - "tags" : [ "controller-services" ], - "summary" : "Performs verification of the Controller Service's configuration", - "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", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The controller service id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The controller service configuration verification request.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/VerifyConfigRequestEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/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. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /controller-services/{uuid}" : [ ] - } ] - } - }, - "/controller-services/{id}/config/verification-requests/{requestId}" : { - "get" : { - "tags" : [ "controller-services" ], - "summary" : "Returns the Verification Request with the given ID", - "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", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The ID of the Controller Service", - "required" : true, - "type" : "string" - }, { - "name" : "requestId", - "in" : "path", - "description" : "The ID of the Verification Request", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/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. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Only the user that submitted the request can get it" : [ ] - } ] - }, - "delete" : { - "tags" : [ "controller-services" ], - "summary" : "Deletes the Verification Request with the given ID", - "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" : "deleteValidationRequest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The ID of the Controller Service", - "required" : true, - "type" : "string" - }, { - "name" : "requestId", - "in" : "path", - "description" : "The ID of the Verification Request", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/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. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Only the user that submitted the request can remove it" : [ ] - } ] - } - }, - "/controller-services/{id}/descriptors" : { - "get" : { - "tags" : [ "controller-services" ], - "summary" : "Gets a controller service property descriptor", - "description" : "", - "operationId" : "getPropertyDescriptor", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The controller service id.", - "required" : true, - "type" : "string" - }, { - "name" : "propertyName", - "in" : "query", - "description" : "The property name to return the descriptor for.", - "required" : true, - "type" : "string" - }, { - "name" : "sensitive", - "in" : "query", - "description" : "Property Descriptor requested sensitive status", - "required" : false, - "type" : "boolean", - "default" : false - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/PropertyDescriptorEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /controller-services/{uuid}" : [ ] - } ] - } - }, - "/controller-services/{id}/references" : { - "get" : { - "tags" : [ "controller-services" ], - "summary" : "Gets a controller service", - "description" : "", - "operationId" : "getControllerServiceReferences", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The controller service id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ControllerServiceReferencingComponentsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /controller-services/{uuid}" : [ ] - } ] - }, - "put" : { - "tags" : [ "controller-services" ], - "summary" : "Updates a controller services references", - "description" : "", - "operationId" : "updateControllerServiceReferences", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The controller service id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The controller service request update request.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/UpdateControllerServiceReferenceRequestEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ControllerServiceReferencingComponentsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /{component-type}/{uuid} or /operate/{component-type}/{uuid} - For each referencing component specified" : [ ] - } ] - } - }, - "/controller-services/{id}/run-status" : { - "put" : { - "tags" : [ "controller-services" ], - "summary" : "Updates run status of a controller service", - "description" : "", - "operationId" : "updateRunStatus", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The controller service id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The controller service run status.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ControllerServiceRunStatusEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ControllerServiceEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /controller-services/{uuid} or /operation/controller-services/{uuid}" : [ ] - } ] - } - }, - "/controller-services/{id}/state" : { - "get" : { - "tags" : [ "controller-services" ], - "summary" : "Gets the state for a controller service", - "description" : "", - "operationId" : "getState", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The controller service id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ComponentStateEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /controller-services/{uuid}" : [ ] - } ] - } - }, - "/controller-services/{id}/state/clear-requests" : { - "post" : { - "tags" : [ "controller-services" ], - "summary" : "Clears the state for a controller service", - "description" : "", - "operationId" : "clearState", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The controller service id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ComponentStateEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /controller-services/{uuid}" : [ ] - } ] - } - }, - "/controller/bulletin" : { - "post" : { - "tags" : [ "controller" ], - "summary" : "Creates a new bulletin", - "description" : "", - "operationId" : "createBulletin", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The reporting task configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/BulletinEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /controller" : [ ] - } ] - } - }, - "/controller/cluster" : { - "get" : { - "tags" : [ "controller" ], - "summary" : "Gets the contents of the cluster", - "description" : "Returns the contents of the cluster including all nodes and their status.", - "operationId" : "getCluster", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ClusterEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /controller" : [ ] - } ] - } - }, - "/controller/cluster/nodes/{id}" : { - "get" : { - "tags" : [ "controller" ], - "summary" : "Gets a node in the cluster", - "description" : "", - "operationId" : "getNode", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The node id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/NodeEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /controller" : [ ] - } ] - }, - "put" : { - "tags" : [ "controller" ], - "summary" : "Updates a node in the cluster", - "description" : "", - "operationId" : "updateNode", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The node id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The node configuration. The only configuration that will be honored at this endpoint is the status.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/NodeEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/NodeEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /controller" : [ ] - } ] - }, - "delete" : { - "tags" : [ "controller" ], - "summary" : "Removes a node from the cluster", - "description" : "", - "operationId" : "deleteNode", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The node id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/NodeEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /controller" : [ ] - } ] - } - }, - "/controller/config" : { - "get" : { - "tags" : [ "controller" ], - "summary" : "Retrieves the configuration for this NiFi Controller", - "description" : "", - "operationId" : "getControllerConfig", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ControllerConfigurationEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /controller" : [ ] - } ] - }, - "put" : { - "tags" : [ "controller" ], - "summary" : "Retrieves the configuration for this NiFi", - "description" : "", - "operationId" : "updateControllerConfig", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The controller configuration.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ControllerConfigurationEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ControllerConfigurationEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /controller" : [ ] - } ] - } - }, - "/controller/controller-services" : { - "post" : { - "tags" : [ "controller" ], - "summary" : "Creates a new controller service", - "description" : "", - "operationId" : "createControllerService", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The controller service configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ControllerServiceEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ControllerServiceEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /controller" : [ ] - }, { - "Read - any referenced Controller Services - /controller-services/{uuid}" : [ ] - }, { - "Write - if the Controller Service is restricted - /restricted-components" : [ ] - } ] - } - }, - "/controller/history" : { - "delete" : { - "tags" : [ "controller" ], - "summary" : "Purges history", - "description" : "", - "operationId" : "deleteHistory", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "endDate", - "in" : "query", - "description" : "Purge actions before this date/time.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/HistoryEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /controller" : [ ] - } ] - } - }, - "/controller/registry-clients" : { - "get" : { - "tags" : [ "controller" ], - "summary" : "Gets the listing of available registry clients", - "description" : "", - "operationId" : "getRegistryClients", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/RegistryClientsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - }, - "post" : { - "tags" : [ "controller" ], - "summary" : "Creates a new registry client", - "description" : "", - "operationId" : "createRegistryClient", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The registry configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/RegistryClientEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/RegistryClientEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /controller" : [ ] - } ] - } - }, - "/controller/registry-clients/{id}" : { - "get" : { - "tags" : [ "controller" ], - "summary" : "Gets a registry client", - "description" : "", - "operationId" : "getRegistryClient", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The registry id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/RegistryClientEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /controller" : [ ] - } ] - }, - "put" : { - "tags" : [ "controller" ], - "summary" : "Updates a registry client", - "description" : "", - "operationId" : "updateRegistryClient", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The registry id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The registry configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/RegistryClientEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/RegistryClientEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /controller" : [ ] - } ] - }, - "delete" : { - "tags" : [ "controller" ], - "summary" : "Deletes a registry client", - "description" : "", - "operationId" : "deleteRegistryClient", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The revision is used to verify the client is working with the latest version of the flow.", - "required" : false, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The registry id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/RegistryClientEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /controller" : [ ] - } ] - } - }, - "/controller/reporting-tasks" : { - "post" : { - "tags" : [ "controller" ], - "summary" : "Creates a new reporting task", - "description" : "", - "operationId" : "createReportingTask", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The reporting task configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ReportingTaskEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ReportingTaskEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /controller" : [ ] - }, { - "Read - any referenced Controller Services - /controller-services/{uuid}" : [ ] - }, { - "Write - if the Reporting Task is restricted - /restricted-components" : [ ] - } ] - } - }, - "/controller/status/history" : { - "get" : { - "tags" : [ "controller" ], - "summary" : "Gets status history for the node", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getNodeStatusHistory", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ComponentHistoryEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /controller" : [ ] - } ] - } - }, - "/counters" : { - "get" : { - "tags" : [ "counters" ], - "summary" : "Gets the current counters for this NiFi", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getCounters", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "nodewise", - "in" : "query", - "description" : "Whether or not to include the breakdown per node. Optional, defaults to false", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "clusterNodeId", - "in" : "query", - "description" : "The id of the node where to get the status.", - "required" : false, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/CountersEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /counters" : [ ] - } ] - } - }, - "/counters/{id}" : { - "put" : { - "tags" : [ "counters" ], - "summary" : "Updates the specified counter. This will reset the counter value to 0", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "updateCounter", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The id of the counter.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/CounterEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /counters" : [ ] - } ] - } - }, - "/data-transfer/input-ports/{portId}/transactions/{transactionId}" : { - "put" : { - "tags" : [ "data-transfer" ], - "summary" : "Extend transaction TTL", - "description" : "", - "operationId" : "extendInputPortTransactionTTL", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "portId", - "in" : "path", - "required" : true, - "type" : "string" - }, { - "name" : "transactionId", - "in" : "path", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/TransactionResultEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /data-transfer/input-ports/{uuid}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "data-transfer" ], - "summary" : "Commit or cancel the specified transaction", - "description" : "", - "operationId" : "commitInputPortTransaction", - "consumes" : [ "application/octet-stream" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "responseCode", - "in" : "query", - "description" : "The response code. Available values are BAD_CHECKSUM(19), CONFIRM_TRANSACTION(12) or CANCEL_TRANSACTION(15).", - "required" : true, - "type" : "integer", - "format" : "int32" - }, { - "name" : "portId", - "in" : "path", - "description" : "The input port id.", - "required" : true, - "type" : "string" - }, { - "name" : "transactionId", - "in" : "path", - "description" : "The transaction id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/TransactionResultEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - }, - "503" : { - "description" : "NiFi instance is not ready for serving request, or temporarily overloaded. Retrying the same request later may be successful" - } - }, - "security" : [ { - "Write - /data-transfer/input-ports/{uuid}" : [ ] - } ] - } - }, - "/data-transfer/input-ports/{portId}/transactions/{transactionId}/flow-files" : { - "post" : { - "tags" : [ "data-transfer" ], - "summary" : "Transfer flow files to the input port", - "description" : "", - "operationId" : "receiveFlowFiles", - "consumes" : [ "application/octet-stream" ], - "produces" : [ "text/plain" ], - "parameters" : [ { - "name" : "portId", - "in" : "path", - "description" : "The input port id.", - "required" : true, - "type" : "string" - }, { - "name" : "transactionId", - "in" : "path", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - }, - "503" : { - "description" : "NiFi instance is not ready for serving request, or temporarily overloaded. Retrying the same request later may be successful" - } - }, - "security" : [ { - "Write - /data-transfer/input-ports/{uuid}" : [ ] - } ] - } - }, - "/data-transfer/output-ports/{portId}/transactions/{transactionId}" : { - "put" : { - "tags" : [ "data-transfer" ], - "summary" : "Extend transaction TTL", - "description" : "", - "operationId" : "extendOutputPortTransactionTTL", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "portId", - "in" : "path", - "required" : true, - "type" : "string" - }, { - "name" : "transactionId", - "in" : "path", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/TransactionResultEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - }, - "503" : { - "description" : "NiFi instance is not ready for serving request, or temporarily overloaded. Retrying the same request later may be successful" - } - }, - "security" : [ { - "Write - /data-transfer/output-ports/{uuid}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "data-transfer" ], - "summary" : "Commit or cancel the specified transaction", - "description" : "", - "operationId" : "commitOutputPortTransaction", - "consumes" : [ "application/octet-stream" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "responseCode", - "in" : "query", - "description" : "The response code. Available values are CONFIRM_TRANSACTION(12) or CANCEL_TRANSACTION(15).", - "required" : true, - "type" : "integer", - "format" : "int32" - }, { - "name" : "checksum", - "in" : "query", - "description" : "A checksum calculated at client side using CRC32 to check flow file content integrity. It must match with the value calculated at server side.", - "required" : true, - "type" : "string" - }, { - "name" : "portId", - "in" : "path", - "description" : "The output port id.", - "required" : true, - "type" : "string" - }, { - "name" : "transactionId", - "in" : "path", - "description" : "The transaction id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/TransactionResultEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - }, - "503" : { - "description" : "NiFi instance is not ready for serving request, or temporarily overloaded. Retrying the same request later may be successful" - } - }, - "security" : [ { - "Write - /data-transfer/output-ports/{uuid}" : [ ] - } ] - } - }, - "/data-transfer/output-ports/{portId}/transactions/{transactionId}/flow-files" : { - "get" : { - "tags" : [ "data-transfer" ], - "summary" : "Transfer flow files from the output port", - "description" : "", - "operationId" : "transferFlowFiles", - "consumes" : [ "*/*" ], - "produces" : [ "application/octet-stream" ], - "parameters" : [ { - "name" : "portId", - "in" : "path", - "description" : "The output port id.", - "required" : true, - "type" : "string" - }, { - "name" : "transactionId", - "in" : "path", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "There is no flow file to return.", - "schema" : { - "$ref" : "#/definitions/StreamingOutput" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - }, - "503" : { - "description" : "NiFi instance is not ready for serving request, or temporarily overloaded. Retrying the same request later may be successful" - } - }, - "security" : [ { - "Write - /data-transfer/output-ports/{uuid}" : [ ] - } ] - } - }, - "/data-transfer/{portType}/{portId}/transactions" : { - "post" : { - "tags" : [ "data-transfer" ], - "summary" : "Create a transaction to the specified output port or input port", - "description" : "", - "operationId" : "createPortTransaction", - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "portType", - "in" : "path", - "description" : "The port type.", - "required" : true, - "type" : "string", - "enum" : [ "input-ports", "output-ports" ] - }, { - "name" : "portId", - "in" : "path", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/TransactionResultEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - }, - "503" : { - "description" : "NiFi instance is not ready for serving request, or temporarily overloaded. Retrying the same request later may be successful" - } - }, - "security" : [ { - "Write - /data-transfer/{component-type}/{uuid}" : [ ] - } ] - } - }, - "/flow/about" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Retrieves details about this NiFi to put in the About dialog", - "description" : "", - "operationId" : "getAboutInfo", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/AboutEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/banners" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Retrieves the banners for this NiFi", - "description" : "", - "operationId" : "getBanners", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/BannerEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/bulletin-board" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets current bulletins", - "description" : "", - "operationId" : "getBulletinBoard", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "after", - "in" : "query", - "description" : "Includes bulletins with an id after this value.", - "required" : false, - "type" : "string" - }, { - "name" : "sourceName", - "in" : "query", - "description" : "Includes bulletins originating from this sources whose name match this regular expression.", - "required" : false, - "type" : "string" - }, { - "name" : "message", - "in" : "query", - "description" : "Includes bulletins whose message that match this regular expression.", - "required" : false, - "type" : "string" - }, { - "name" : "sourceId", - "in" : "query", - "description" : "Includes bulletins originating from this sources whose id match this regular expression.", - "required" : false, - "type" : "string" - }, { - "name" : "groupId", - "in" : "query", - "description" : "Includes bulletins originating from this sources whose group id match this regular expression.", - "required" : false, - "type" : "string" - }, { - "name" : "limit", - "in" : "query", - "description" : "The number of bulletins to limit the response to.", - "required" : false, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/BulletinBoardEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - }, { - "Read - /{component-type}/{uuid} - For component specific bulletins" : [ ] - } ] - } - }, - "/flow/client-id" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Generates a client id.", - "description" : "", - "operationId" : "generateClientId", - "consumes" : [ "*/*" ], - "produces" : [ "text/plain" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/cluster/search-results" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Searches the cluster for a node with the specified address", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "searchCluster", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "q", - "in" : "query", - "description" : "Node address to search for.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ClusterSearchResultsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/cluster/summary" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "The cluster summary for this NiFi", - "description" : "", - "operationId" : "getClusterSummary", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ClusteSummaryEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/config" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Retrieves the configuration for this NiFi flow", - "description" : "", - "operationId" : "getFlowConfig", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/FlowConfigurationEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/connections/{id}/statistics" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets statistics for a connection", - "description" : "", - "operationId" : "getConnectionStatistics", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "nodewise", - "in" : "query", - "description" : "Whether or not to include the breakdown per node. Optional, defaults to false", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "clusterNodeId", - "in" : "query", - "description" : "The id of the node where to get the statistics.", - "required" : false, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The connection id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ConnectionStatisticsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/connections/{id}/status" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets status for a connection", - "description" : "", - "operationId" : "getConnectionStatus", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "nodewise", - "in" : "query", - "description" : "Whether or not to include the breakdown per node. Optional, defaults to false", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "clusterNodeId", - "in" : "query", - "description" : "The id of the node where to get the status.", - "required" : false, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The connection id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ConnectionStatusEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/connections/{id}/status/history" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets the status history for a connection", - "description" : "", - "operationId" : "getConnectionStatusHistory", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The connection id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/StatusHistoryEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/controller-service-types" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Retrieves the types of controller services that this NiFi supports", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getControllerServiceTypes", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "serviceType", - "in" : "query", - "description" : "If specified, will only return controller services that are compatible with this type of service.", - "required" : false, - "type" : "string" - }, { - "name" : "serviceBundleGroup", - "in" : "query", - "description" : "If serviceType specified, is the bundle group of the serviceType.", - "required" : false, - "type" : "string" - }, { - "name" : "serviceBundleArtifact", - "in" : "query", - "description" : "If serviceType specified, is the bundle artifact of the serviceType.", - "required" : false, - "type" : "string" - }, { - "name" : "serviceBundleVersion", - "in" : "query", - "description" : "If serviceType specified, is the bundle version of the serviceType.", - "required" : false, - "type" : "string" - }, { - "name" : "bundleGroupFilter", - "in" : "query", - "description" : "If specified, will only return types that are a member of this bundle group.", - "required" : false, - "type" : "string" - }, { - "name" : "bundleArtifactFilter", - "in" : "query", - "description" : "If specified, will only return types that are a member of this bundle artifact.", - "required" : false, - "type" : "string" - }, { - "name" : "typeFilter", - "in" : "query", - "description" : "If specified, will only return types whose fully qualified classname matches.", - "required" : false, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ControllerServiceTypesEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/controller/bulletins" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Retrieves Controller level bulletins", - "description" : "", - "operationId" : "getBulletins", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ControllerBulletinsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - }, { - "Read - /controller - For controller bulletins" : [ ] - }, { - "Read - /controller-services/{uuid} - For controller service bulletins" : [ ] - }, { - "Read - /reporting-tasks/{uuid} - For reporting task bulletins" : [ ] - } ] - } - }, - "/flow/controller/controller-services" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets controller services for reporting tasks", - "description" : "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", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "uiOnly", - "in" : "query", - "required" : false, - "type" : "boolean", - "default" : false - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ControllerServicesEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/current-user" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Retrieves the user identity of the user making the request", - "description" : "", - "operationId" : "getCurrentUser", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/CurrentUserEntity" - } - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/history" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets configuration history", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "queryHistory", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "offset", - "in" : "query", - "description" : "The offset into the result set.", - "required" : true, - "type" : "string" - }, { - "name" : "count", - "in" : "query", - "description" : "The number of actions to return.", - "required" : true, - "type" : "string" - }, { - "name" : "sortColumn", - "in" : "query", - "description" : "The field to sort on.", - "required" : false, - "type" : "string" - }, { - "name" : "sortOrder", - "in" : "query", - "description" : "The direction to sort.", - "required" : false, - "type" : "string" - }, { - "name" : "startDate", - "in" : "query", - "description" : "Include actions after this date.", - "required" : false, - "type" : "string" - }, { - "name" : "endDate", - "in" : "query", - "description" : "Include actions before this date.", - "required" : false, - "type" : "string" - }, { - "name" : "userIdentity", - "in" : "query", - "description" : "Include actions performed by this user.", - "required" : false, - "type" : "string" - }, { - "name" : "sourceId", - "in" : "query", - "description" : "Include actions on this component.", - "required" : false, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/HistoryEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/history/components/{componentId}" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets configuration history for a component", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getComponentHistory", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "componentId", - "in" : "path", - "description" : "The component id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ComponentHistoryEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - }, { - "Read underlying component - /{component-type}/{uuid}" : [ ] - } ] - } - }, - "/flow/history/{id}" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets an action", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getAction", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The action id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ActionEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/input-ports/{id}/status" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets status for an input port", - "description" : "", - "operationId" : "getInputPortStatus", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "nodewise", - "in" : "query", - "description" : "Whether or not to include the breakdown per node. Optional, defaults to false", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "clusterNodeId", - "in" : "query", - "description" : "The id of the node where to get the status.", - "required" : false, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The input port id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/PortStatusEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/metrics/{producer}" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets all metrics for the flow from a particular node", - "description" : "", - "operationId" : "getFlowMetrics", - "consumes" : [ "*/*" ], - "produces" : [ "*/*" ], - "parameters" : [ { - "name" : "producer", - "in" : "path", - "description" : "The producer for flow file metrics. Each producer may have its own output format.", - "required" : true, - "type" : "string", - "enum" : [ "prometheus" ] - }, { - "name" : "includedRegistries", - "in" : "query", - "description" : "Set of included metrics registries", - "required" : false, - "type" : "array", - "items" : { - "type" : "string", - "enum" : [ "NIFI", "JVM", "BULLETIN", "CONNECTION" ] - }, - "collectionFormat" : "multi" - }, { - "name" : "sampleName", - "in" : "query", - "description" : "Regular Expression Pattern to be applied against the sample name field", - "required" : false, - "type" : "string" - }, { - "name" : "sampleLabelValue", - "in" : "query", - "description" : "Regular Expression Pattern to be applied against the sample label value field", - "required" : false, - "type" : "string" - }, { - "name" : "rootFieldName", - "in" : "query", - "description" : "Name of the first field of JSON object. Applicable for JSON producer only.", - "required" : false, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/StreamingOutput" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/output-ports/{id}/status" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets status for an output port", - "description" : "", - "operationId" : "getOutputPortStatus", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "nodewise", - "in" : "query", - "description" : "Whether or not to include the breakdown per node. Optional, defaults to false", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "clusterNodeId", - "in" : "query", - "description" : "The id of the node where to get the status.", - "required" : false, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The output port id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/PortStatusEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/parameter-contexts" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets all Parameter Contexts", - "description" : "", - "operationId" : "getParameterContexts", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ParameterContextsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /parameter-contexts/{id} for each Parameter Context" : [ ] - } ] - } - }, - "/flow/prioritizers" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Retrieves the types of prioritizers that this NiFi supports", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getPrioritizers", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/PrioritizerTypesEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/process-groups/{id}" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets a process group", - "description" : "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", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "name" : "uiOnly", - "in" : "query", - "required" : false, - "type" : "boolean", - "default" : false - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessGroupFlowEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - }, - "put" : { - "tags" : [ "flow" ], - "summary" : "Schedule or unschedule components in the specified Process Group.", - "description" : "", - "operationId" : "scheduleComponents", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The request to schedule or unschedule. If the comopnents in the request are not specified, all authorized components will be considered.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ScheduleComponentsEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ScheduleComponentsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - }, { - "Write - /{component-type}/{uuid} or /operation/{component-type}/{uuid} - For every component being scheduled/unscheduled" : [ ] - } ] - } - }, - "/flow/process-groups/{id}/controller-services" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets all controller services", - "description" : "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", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "name" : "includeAncestorGroups", - "in" : "query", - "description" : "Whether or not to include parent/ancestory process groups", - "required" : false, - "type" : "boolean", - "default" : true - }, { - "name" : "includeDescendantGroups", - "in" : "query", - "description" : "Whether or not to include descendant process groups", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "uiOnly", - "in" : "query", - "required" : false, - "type" : "boolean", - "default" : false - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ControllerServicesEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - }, - "put" : { - "tags" : [ "flow" ], - "summary" : "Enable or disable Controller Services in the specified Process Group.", - "description" : "", - "operationId" : "activateControllerServices", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The request to schedule or unschedule. If the comopnents in the request are not specified, all authorized components will be considered.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ActivateControllerServicesEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ActivateControllerServicesEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - }, { - "Write - /{component-type}/{uuid} or /operation/{component-type}/{uuid} - For every service being enabled/disabled" : [ ] - } ] - } - }, - "/flow/process-groups/{id}/status" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets the status for a process group", - "description" : "The status for a process group includes status for all descendent components. When invoked on the root group with recursive set to true, it will return the current status of every component in the flow.", - "operationId" : "getProcessGroupStatus", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "recursive", - "in" : "query", - "description" : "Whether all descendant groups and the status of their content will be included. Optional, defaults to false", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "nodewise", - "in" : "query", - "description" : "Whether or not to include the breakdown per node. Optional, defaults to false", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "clusterNodeId", - "in" : "query", - "description" : "The id of the node where to get the status.", - "required" : false, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessGroupStatusEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/process-groups/{id}/status/history" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets status history for a remote process group", - "description" : "", - "operationId" : "getProcessGroupStatusHistory", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/StatusHistoryEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/processor-types" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Retrieves the types of processors that this NiFi supports", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getProcessorTypes", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bundleGroupFilter", - "in" : "query", - "description" : "If specified, will only return types that are a member of this bundle group.", - "required" : false, - "type" : "string" - }, { - "name" : "bundleArtifactFilter", - "in" : "query", - "description" : "If specified, will only return types that are a member of this bundle artifact.", - "required" : false, - "type" : "string" - }, { - "name" : "type", - "in" : "query", - "description" : "If specified, will only return types whose fully qualified classname matches.", - "required" : false, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessorTypesEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/processors/{id}/status" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets status for a processor", - "description" : "", - "operationId" : "getProcessorStatus", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "nodewise", - "in" : "query", - "description" : "Whether or not to include the breakdown per node. Optional, defaults to false", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "clusterNodeId", - "in" : "query", - "description" : "The id of the node where to get the status.", - "required" : false, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The processor id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessorStatusEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/processors/{id}/status/history" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets status history for a processor", - "description" : "", - "operationId" : "getProcessorStatusHistory", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The processor id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/StatusHistoryEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/registries" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets the listing of available registries", - "description" : "", - "operationId" : "getRegistries", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/RegistryClientsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/registries/{id}/buckets" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets the buckets from the specified registry for the current user", - "description" : "", - "operationId" : "getBuckets", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The registry id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/BucketsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/registries/{registry-id}/buckets/{bucket-id}/flows" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets the flows from the specified registry and bucket for the current user", - "description" : "", - "operationId" : "getFlows", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "registry-id", - "in" : "path", - "description" : "The registry id.", - "required" : true, - "type" : "string" - }, { - "name" : "bucket-id", - "in" : "path", - "description" : "The bucket id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlowsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/registries/{registry-id}/buckets/{bucket-id}/flows/{flow-id}/versions" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets the flow versions from the specified registry and bucket for the specified flow for the current user", - "description" : "", - "operationId" : "getVersions", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "registry-id", - "in" : "path", - "description" : "The registry id.", - "required" : true, - "type" : "string" - }, { - "name" : "bucket-id", - "in" : "path", - "description" : "The bucket id.", - "required" : true, - "type" : "string" - }, { - "name" : "flow-id", - "in" : "path", - "description" : "The flow id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlowSnapshotMetadataSetEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/remote-process-groups/{id}/status" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets status for a remote process group", - "description" : "", - "operationId" : "getRemoteProcessGroupStatus", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "nodewise", - "in" : "query", - "description" : "Whether or not to include the breakdown per node. Optional, defaults to false", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "clusterNodeId", - "in" : "query", - "description" : "The id of the node where to get the status.", - "required" : false, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The remote process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/RemoteProcessGroupStatusEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/remote-process-groups/{id}/status/history" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets the status history", - "description" : "", - "operationId" : "getRemoteProcessGroupStatusHistory", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The remote process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/StatusHistoryEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/reporting-task-types" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Retrieves the types of reporting tasks that this NiFi supports", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getReportingTaskTypes", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bundleGroupFilter", - "in" : "query", - "description" : "If specified, will only return types that are a member of this bundle group.", - "required" : false, - "type" : "string" - }, { - "name" : "bundleArtifactFilter", - "in" : "query", - "description" : "If specified, will only return types that are a member of this bundle artifact.", - "required" : false, - "type" : "string" - }, { - "name" : "type", - "in" : "query", - "description" : "If specified, will only return types whose fully qualified classname matches.", - "required" : false, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ReportingTaskTypesEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/reporting-tasks" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets all reporting tasks", - "description" : "", - "operationId" : "getReportingTasks", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ReportingTasksEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/runtime-manifest" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Retrieves the runtime manifest for this NiFi instance.", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getRuntimeManifest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/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. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/search-results" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Performs a search against this NiFi using the specified search term", - "description" : "Only search results from authorized components will be returned.", - "operationId" : "searchFlow", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "q", - "in" : "query", - "required" : false, - "type" : "string" - }, { - "name" : "a", - "in" : "query", - "required" : false, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/SearchResultsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/status" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets the current status of this NiFi", - "description" : "", - "operationId" : "getControllerStatus", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ControllerStatusEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/templates" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets all templates", - "description" : "", - "operationId" : "getTemplates", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/TemplatesEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flowfile-queues/{id}/drop-requests" : { - "post" : { - "tags" : [ "flowfile-queues" ], - "summary" : "Creates a request to drop the contents of the queue in this connection.", - "description" : "", - "operationId" : "createDropRequest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The connection id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/DropRequestEntity" - } - }, - "202" : { - "description" : "The request has been accepted. A HTTP response header will contain the URI where the response can be polled." - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write Source Data - /data/{component-type}/{uuid}" : [ ] - } ] - } - }, - "/flowfile-queues/{id}/drop-requests/{drop-request-id}" : { - "get" : { - "tags" : [ "flowfile-queues" ], - "summary" : "Gets the current status of a drop request for the specified connection.", - "description" : "", - "operationId" : "getDropRequest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The connection id.", - "required" : true, - "type" : "string" - }, { - "name" : "drop-request-id", - "in" : "path", - "description" : "The drop request id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/DropRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write Source Data - /data/{component-type}/{uuid}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "flowfile-queues" ], - "summary" : "Cancels and/or removes a request to drop the contents of this connection.", - "description" : "", - "operationId" : "removeDropRequest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The connection id.", - "required" : true, - "type" : "string" - }, { - "name" : "drop-request-id", - "in" : "path", - "description" : "The drop request id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/DropRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write Source Data - /data/{component-type}/{uuid}" : [ ] - } ] - } - }, - "/flowfile-queues/{id}/flowfiles/{flowfile-uuid}" : { - "get" : { - "tags" : [ "flowfile-queues" ], - "summary" : "Gets a FlowFile from a Connection.", - "description" : "", - "operationId" : "getFlowFile", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The connection id.", - "required" : true, - "type" : "string" - }, { - "name" : "flowfile-uuid", - "in" : "path", - "description" : "The flowfile uuid.", - "required" : true, - "type" : "string" - }, { - "name" : "clusterNodeId", - "in" : "query", - "description" : "The id of the node where the content exists if clustered.", - "required" : false, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/FlowFileEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read Source Data - /data/{component-type}/{uuid}" : [ ] - } ] - } - }, - "/flowfile-queues/{id}/flowfiles/{flowfile-uuid}/content" : { - "get" : { - "tags" : [ "flowfile-queues" ], - "summary" : "Gets the content for a FlowFile in a Connection.", - "description" : "", - "operationId" : "downloadFlowFileContent", - "consumes" : [ "*/*" ], - "produces" : [ "*/*" ], - "parameters" : [ { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The connection id.", - "required" : true, - "type" : "string" - }, { - "name" : "flowfile-uuid", - "in" : "path", - "description" : "The flowfile uuid.", - "required" : true, - "type" : "string" - }, { - "name" : "clusterNodeId", - "in" : "query", - "description" : "The id of the node where the content exists if clustered.", - "required" : false, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/StreamingOutput" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read Source Data - /data/{component-type}/{uuid}" : [ ] - } ] - } - }, - "/flowfile-queues/{id}/listing-requests" : { - "post" : { - "tags" : [ "flowfile-queues" ], - "summary" : "Lists the contents of the queue in this connection.", - "description" : "", - "operationId" : "createFlowFileListing", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The connection id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ListingRequestEntity" - } - }, - "202" : { - "description" : "The request has been accepted. A HTTP response header will contain the URI where the response can be polled." - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read Source Data - /data/{component-type}/{uuid}" : [ ] - } ] - } - }, - "/flowfile-queues/{id}/listing-requests/{listing-request-id}" : { - "get" : { - "tags" : [ "flowfile-queues" ], - "summary" : "Gets the current status of a listing request for the specified connection.", - "description" : "", - "operationId" : "getListingRequest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The connection id.", - "required" : true, - "type" : "string" - }, { - "name" : "listing-request-id", - "in" : "path", - "description" : "The listing request id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ListingRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read Source Data - /data/{component-type}/{uuid}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "flowfile-queues" ], - "summary" : "Cancels and/or removes a request to list the contents of this connection.", - "description" : "", - "operationId" : "deleteListingRequest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The connection id.", - "required" : true, - "type" : "string" - }, { - "name" : "listing-request-id", - "in" : "path", - "description" : "The listing request id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ListingRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read Source Data - /data/{component-type}/{uuid}" : [ ] - } ] - } - }, - "/funnels/{id}" : { - "get" : { - "tags" : [ "funnel" ], - "summary" : "Gets a funnel", - "description" : "", - "operationId" : "getFunnel", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The funnel id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/FunnelEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /funnels/{uuid}" : [ ] - } ] - }, - "put" : { - "tags" : [ "funnel" ], - "summary" : "Updates a funnel", - "description" : "", - "operationId" : "updateFunnel", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The funnel id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The funnel configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/FunnelEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/FunnelEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /funnels/{uuid}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "funnel" ], - "summary" : "Deletes a funnel", - "description" : "", - "operationId" : "removeFunnel", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The revision is used to verify the client is working with the latest version of the flow.", - "required" : false, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The funnel id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/FunnelEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /funnels/{uuid}" : [ ] - }, { - "Write - Parent Process Group - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/input-ports/{id}" : { - "get" : { - "tags" : [ "input-ports" ], - "summary" : "Gets an input port", - "description" : "", - "operationId" : "getInputPort", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The input port id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/PortEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /input-ports/{uuid}" : [ ] - } ] - }, - "put" : { - "tags" : [ "input-ports" ], - "summary" : "Updates an input port", - "description" : "", - "operationId" : "updateInputPort", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The input port id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The input port configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/PortEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/PortEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /input-ports/{uuid}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "input-ports" ], - "summary" : "Deletes an input port", - "description" : "", - "operationId" : "removeInputPort", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The revision is used to verify the client is working with the latest version of the flow.", - "required" : false, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The input port id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/PortEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /input-ports/{uuid}" : [ ] - }, { - "Write - Parent Process Group - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/input-ports/{id}/run-status" : { - "put" : { - "tags" : [ "input-ports" ], - "summary" : "Updates run status of an input-port", - "description" : "", - "operationId" : "updateRunStatus", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The port id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The port run status.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/PortRunStatusEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessorEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /input-ports/{uuid} or /operation/input-ports/{uuid}" : [ ] - } ] - } - }, - "/labels/{id}" : { - "get" : { - "tags" : [ "labels" ], - "summary" : "Gets a label", - "description" : "", - "operationId" : "getLabel", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The label id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/LabelEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /labels/{uuid}" : [ ] - } ] - }, - "put" : { - "tags" : [ "labels" ], - "summary" : "Updates a label", - "description" : "", - "operationId" : "updateLabel", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The label id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The label configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/LabelEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/LabelEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /labels/{uuid}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "labels" ], - "summary" : "Deletes a label", - "description" : "", - "operationId" : "removeLabel", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The revision is used to verify the client is working with the latest version of the flow.", - "required" : false, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The label id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/LabelEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /labels/{uuid}" : [ ] - }, { - "Write - Parent Process Group - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/output-ports/{id}" : { - "get" : { - "tags" : [ "output-ports" ], - "summary" : "Gets an output port", - "description" : "", - "operationId" : "getOutputPort", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The output port id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/PortEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /output-ports/{uuid}" : [ ] - } ] - }, - "put" : { - "tags" : [ "output-ports" ], - "summary" : "Updates an output port", - "description" : "", - "operationId" : "updateOutputPort", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The output port id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The output port configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/PortEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/PortEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /output-ports/{uuid}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "output-ports" ], - "summary" : "Deletes an output port", - "description" : "", - "operationId" : "removeOutputPort", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The revision is used to verify the client is working with the latest version of the flow.", - "required" : false, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The output port id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/PortEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /output-ports/{uuid}" : [ ] - }, { - "Write - Parent Process Group - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/output-ports/{id}/run-status" : { - "put" : { - "tags" : [ "output-ports" ], - "summary" : "Updates run status of an output-port", - "description" : "", - "operationId" : "updateRunStatus", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The port id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The port run status.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/PortRunStatusEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessorEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /output-ports/{uuid} or /operation/output-ports/{uuid}" : [ ] - } ] - } - }, - "/parameter-contexts" : { - "post" : { - "tags" : [ "parameter-contexts" ], - "summary" : "Create a Parameter Context", - "description" : "", - "operationId" : "createParameterContext", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The Parameter Context.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ParameterContextEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ParameterContextEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /parameter-contexts" : [ ] - }, { - "Read - for every inherited parameter context" : [ ] - } ] - } - }, - "/parameter-contexts/{contextId}/update-requests" : { - "post" : { - "tags" : [ "parameter-contexts" ], - "summary" : "Initiate the Update Request of a Parameter Context", - "description" : "This will initiate the process of updating a Parameter Context. Changing the value of a Parameter may require that one or more components be stopped and restarted, so this 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", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "contextId", - "in" : "path", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The updated version of the parameter context.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ParameterContextEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ParameterContextUpdateRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /parameter-contexts/{parameterContextId}" : [ ] - }, { - "Write - /parameter-contexts/{parameterContextId}" : [ ] - }, { - "Read - for every component that is affected by the update" : [ ] - }, { - "Write - for every component that is affected by the update" : [ ] - }, { - "Read - for every currently inherited parameter context" : [ ] - }, { - "Read - for any new inherited parameter context" : [ ] - } ] - } - }, - "/parameter-contexts/{contextId}/update-requests/{requestId}" : { - "get" : { - "tags" : [ "parameter-contexts" ], - "summary" : "Returns the Update Request with the given ID", - "description" : "Returns the Update Request with the given ID. Once an Update Request has been created by performing a POST to /nifi-api/parameter-contexts, that request can subsequently be retrieved via this endpoint, and the request that is fetched will contain the updated state, such as percent complete, the current state of the request, and any failures. ", - "operationId" : "getParameterContextUpdate", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "contextId", - "in" : "path", - "description" : "The ID of the Parameter Context", - "required" : true, - "type" : "string" - }, { - "name" : "requestId", - "in" : "path", - "description" : "The ID of the Update Request", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ParameterContextUpdateRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Only the user that submitted the request can get it" : [ ] - } ] - }, - "delete" : { - "tags" : [ "parameter-contexts" ], - "summary" : "Deletes the Update Request with the given ID", - "description" : "Deletes the Update Request with the given ID. After a request is created via a POST to /nifi-api/parameter-contexts/update-requests, it is expected that the client will properly clean up the request by DELETE'ing it, once the Update process has completed. If the request is deleted before the request completes, then the Update request will finish the step that it is currently performing and then will cancel any subsequent steps.", - "operationId" : "deleteUpdateRequest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "contextId", - "in" : "path", - "description" : "The ID of the ParameterContext", - "required" : true, - "type" : "string" - }, { - "name" : "requestId", - "in" : "path", - "description" : "The ID of the Update Request", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ParameterContextUpdateRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Only the user that submitted the request can remove it" : [ ] - } ] - } - }, - "/parameter-contexts/{contextId}/validation-requests" : { - "post" : { - "tags" : [ "parameter-contexts" ], - "summary" : "Initiate a Validation Request to determine how the validity of components will change if a Parameter Context were to be updated", - "description" : "This will initiate the process of validating all components whose Process Group is bound to the specified Parameter Context. Performing validation against an arbitrary number of components may be expect and take significantly more time than many other REST API actions. As a result, this endpoint will immediately return a ParameterContextValidationRequestEntity, and the process of validating the necessary components will occur asynchronously in the background. The client may then periodically poll the status of the request by issuing a GET request to /parameter-contexts/validation-requests/{requestId}. Once the request is completed, the client is expected to issue a DELETE request to /parameter-contexts/validation-requests/{requestId}.", - "operationId" : "submitValidationRequest", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "contextId", - "in" : "path", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The validation request", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ParameterContextValidationRequestEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ParameterContextValidationRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /parameter-contexts/{parameterContextId}" : [ ] - } ] - } - }, - "/parameter-contexts/{contextId}/validation-requests/{id}" : { - "get" : { - "tags" : [ "parameter-contexts" ], - "summary" : "Returns the Validation Request with the given ID", - "description" : "Returns the Validation Request with the given ID. Once a Validation Request has been created by performing a POST to /nifi-api/validation-contexts, that request can subsequently be retrieved via this endpoint, and the request that is fetched will contain the updated state, such as percent complete, the current state of the request, and any failures. ", - "operationId" : "getValidationRequest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "contextId", - "in" : "path", - "description" : "The ID of the Parameter Context", - "required" : true, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The ID of the Validation Request", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ParameterContextValidationRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Only the user that submitted the request can get it" : [ ] - } ] - }, - "delete" : { - "tags" : [ "parameter-contexts" ], - "summary" : "Deletes the Validation Request with the given ID", - "description" : "Deletes the Validation Request with the given ID. After a request is created via a POST to /nifi-api/validation-contexts, it is expected that the client will properly clean up the request by DELETE'ing it, once the validation process has completed. If the request is deleted before the request completes, then the Validation request will finish the step that it is currently performing and then will cancel any subsequent steps.", - "operationId" : "deleteValidationRequest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "contextId", - "in" : "path", - "description" : "The ID of the Parameter Context", - "required" : true, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The ID of the Update Request", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ParameterContextValidationRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Only the user that submitted the request can remove it" : [ ] - } ] - } - }, - "/parameter-contexts/{id}" : { - "get" : { - "tags" : [ "parameter-contexts" ], - "summary" : "Returns the Parameter Context with the given ID", - "description" : "Returns the Parameter Context with the given ID.", - "operationId" : "getParameterContext", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The ID of the Parameter Context", - "required" : true, - "type" : "string" - }, { - "name" : "includeInheritedParameters", - "in" : "query", - "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.", - "required" : false, - "type" : "boolean", - "default" : false - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ParameterContextEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /parameter-contexts/{id}" : [ ] - } ] - }, - "put" : { - "tags" : [ "parameter-contexts" ], - "summary" : "Modifies a Parameter Context", - "description" : "This endpoint will update a Parameter Context to match the provided entity. However, this request will fail if any component is running and is referencing a Parameter in the Parameter Context. Generally, this endpoint is not called directly. Instead, an update request should be submitted by making a POST to the /parameter-contexts/update-requests endpoint. That endpoint will, in turn, call this endpoint.", - "operationId" : "updateParameterContext", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The updated Parameter Context", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ParameterContextEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ParameterContextEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /parameter-contexts/{id}" : [ ] - }, { - "Write - /parameter-contexts/{id}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "parameter-contexts" ], - "summary" : "Deletes the Parameter Context with the given ID", - "description" : "Deletes the Parameter Context with the given ID.", - "operationId" : "deleteParameterContext", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The version is used to verify the client is working with the latest version of the flow.", - "required" : false, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, a new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The Parameter Context ID.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ParameterContextEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /parameter-contexts/{uuid}" : [ ] - }, { - "Write - /parameter-contexts/{uuid}" : [ ] - }, { - "Read - /process-groups/{uuid}, for any Process Group that is currently bound to the Parameter Context" : [ ] - }, { - "Write - /process-groups/{uuid}, for any Process Group that is currently bound to the Parameter Context" : [ ] - } ] - } - }, - "/policies" : { - "post" : { - "tags" : [ "policies" ], - "summary" : "Creates an access policy", - "description" : "", - "operationId" : "createAccessPolicy", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The access policy configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/AccessPolicyEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/AccessPolicyEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /policies/{resource}" : [ ] - } ] - } - }, - "/policies/{action}/{resource}" : { - "get" : { - "tags" : [ "policies" ], - "summary" : "Gets an access policy for the specified action and resource", - "description" : "Will return the effective policy if no component specific policy exists for the specified action and resource. Must have Read permissions to the policy with the desired action and resource. Permissions for the policy that is returned will be indicated in the response. This means the client could be authorized to get the policy for a given component but the effective policy may be inherited from an ancestor Process Group. If the client does not have permissions to that policy, the response will not include the policy and the permissions in the response will be marked accordingly. If the client does not have permissions to the policy of the desired action and resource a 403 response will be returned.", - "operationId" : "getAccessPolicyForResource", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "action", - "in" : "path", - "description" : "The request action.", - "required" : true, - "type" : "string", - "enum" : [ "read", "write" ] - }, { - "name" : "resource", - "in" : "path", - "description" : "The resource of the policy.", - "required" : true, - "type" : "string", - "pattern" : ".+" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/AccessPolicyEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /policies/{resource}" : [ ] - } ] - } - }, - "/policies/{id}" : { - "get" : { - "tags" : [ "policies" ], - "summary" : "Gets an access policy", - "description" : "", - "operationId" : "getAccessPolicy", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The access policy id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/AccessPolicyEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /policies/{resource}" : [ ] - } ] - }, - "put" : { - "tags" : [ "policies" ], - "summary" : "Updates a access policy", - "description" : "", - "operationId" : "updateAccessPolicy", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The access policy id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The access policy configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/AccessPolicyEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/AccessPolicyEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /policies/{resource}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "policies" ], - "summary" : "Deletes an access policy", - "description" : "", - "operationId" : "removeAccessPolicy", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The revision is used to verify the client is working with the latest version of the flow.", - "required" : false, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The access policy id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/AccessPolicyEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /policies/{resource}" : [ ] - }, { - "Write - Policy of the parent resource - /policies/{resource}" : [ ] - } ] - } - }, - "/process-groups/replace-requests/{id}" : { - "get" : { - "tags" : [ "process-groups" ], - "summary" : "Returns the Replace Request with the given ID", - "description" : "Returns the Replace Request with the given ID. Once a Replace Request has been created by performing a POST to /process-groups/{id}/replace-requests, that request can subsequently be retrieved via this endpoint, and the request that is fetched will contain the updated state, such as percent complete, the current state of the request, and any failures. Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getReplaceProcessGroupRequest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The ID of the Replace Request", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessGroupReplaceRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Only the user that submitted the request can get it" : [ ] - } ] - }, - "delete" : { - "tags" : [ "process-groups" ], - "summary" : "Deletes the Replace Request with the given ID", - "description" : "Deletes the Replace Request with the given ID. After a request is created via a POST to /process-groups/{id}/replace-requests, it is expected that the client will properly clean up the request by DELETE'ing it, once the Replace process has completed. If the request is deleted before the request completes, then the Replace request will finish the step that it is currently performing and then will cancel any subsequent steps. Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "deleteReplaceProcessGroupRequest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The ID of the Update Request", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessGroupReplaceRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Only the user that submitted the request can remove it" : [ ] - } ] - } - }, - "/process-groups/{groupId}/variable-registry/update-requests/{updateId}" : { - "get" : { - "tags" : [ "process-groups" ], - "summary" : "Gets a process group's variable registry", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getVariableRegistryUpdateRequest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "groupId", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "name" : "updateId", - "in" : "path", - "description" : "The ID of the Variable Registry Update Request", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VariableRegistryUpdateRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "process-groups" ], - "summary" : "Deletes an update request for a process group's variable registry. If the request is not yet complete, it will automatically be cancelled.", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "deleteVariableRegistryUpdateRequest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "groupId", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "name" : "updateId", - "in" : "path", - "description" : "The ID of the Variable Registry Update Request", - "required" : true, - "type" : "string" - }, { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VariableRegistryUpdateRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/process-groups/{id}" : { - "get" : { - "tags" : [ "process-groups" ], - "summary" : "Gets a process group", - "description" : "", - "operationId" : "getProcessGroup", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessGroupEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - } ] - }, - "put" : { - "tags" : [ "process-groups" ], - "summary" : "Updates a process group", - "description" : "", - "operationId" : "updateProcessGroup", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The process group configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ProcessGroupEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessGroupEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "process-groups" ], - "summary" : "Deletes a process group", - "description" : "", - "operationId" : "removeProcessGroup", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The revision is used to verify the client is working with the latest version of the flow.", - "required" : false, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessGroupEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - }, { - "Write - Parent Process Group - /process-groups/{uuid}" : [ ] - }, { - "Read - any referenced Controller Services by any encapsulated components - /controller-services/{uuid}" : [ ] - }, { - "Write - /{component-type}/{uuid} - For all encapsulated components" : [ ] - } ] - } - }, - "/process-groups/{id}/connections" : { - "get" : { - "tags" : [ "process-groups" ], - "summary" : "Gets all connections", - "description" : "", - "operationId" : "getConnections", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ConnectionsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - } ] - }, - "post" : { - "tags" : [ "process-groups" ], - "summary" : "Creates a connection", - "description" : "", - "operationId" : "createConnection", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The connection configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ConnectionEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ConnectionEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - }, { - "Write Source - /{component-type}/{uuid}" : [ ] - }, { - "Write Destination - /{component-type}/{uuid}" : [ ] - } ] - } - }, - "/process-groups/{id}/controller-services" : { - "post" : { - "tags" : [ "process-groups" ], - "summary" : "Creates a new controller service", - "description" : "", - "operationId" : "createControllerService", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The controller service configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ControllerServiceEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ControllerServiceEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - }, { - "Read - any referenced Controller Services - /controller-services/{uuid}" : [ ] - }, { - "Write - if the Controller Service is restricted - /restricted-components" : [ ] - } ] - } - }, - "/process-groups/{id}/download" : { - "get" : { - "tags" : [ "process-groups" ], - "summary" : "Gets a process group for download", - "description" : "", - "operationId" : "exportProcessGroup", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "name" : "includeReferencedServices", - "in" : "query", - "description" : "If referenced services from outside the target group should be included", - "required" : false, - "type" : "boolean", - "default" : false - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/process-groups/{id}/empty-all-connections-requests" : { - "post" : { - "tags" : [ "process-groups" ], - "summary" : "Creates a request to drop all flowfiles of all connection queues in this process group.", - "description" : "", - "operationId" : "createEmptyAllConnectionsRequest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/DropRequestEntity" - } - }, - "202" : { - "description" : "The request has been accepted. An HTTP response header will contain the URI where the status can be polled." - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid} - For this and all encapsulated process groups" : [ ] - }, { - "Write Source Data - /data/{component-type}/{uuid} - For all encapsulated connections" : [ ] - } ] - } - }, - "/process-groups/{id}/empty-all-connections-requests/{drop-request-id}" : { - "get" : { - "tags" : [ "process-groups" ], - "summary" : "Gets the current status of a drop all flowfiles request.", - "description" : "", - "operationId" : "getDropAllFlowfilesRequest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "name" : "drop-request-id", - "in" : "path", - "description" : "The drop request id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/DropRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid} - For this and all encapsulated process groups" : [ ] - }, { - "Write Source Data - /data/{component-type}/{uuid} - For all encapsulated connections" : [ ] - } ] - }, - "delete" : { - "tags" : [ "process-groups" ], - "summary" : "Cancels and/or removes a request to drop all flowfiles.", - "description" : "", - "operationId" : "removeDropRequest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "name" : "drop-request-id", - "in" : "path", - "description" : "The drop request id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/DropRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid} - For this and all encapsulated process groups" : [ ] - }, { - "Write Source Data - /data/{component-type}/{uuid} - For all encapsulated connections" : [ ] - } ] - } - }, - "/process-groups/{id}/flow-contents" : { - "put" : { - "tags" : [ "process-groups" ], - "summary" : "Replace Process Group contents with the given ID with the specified Process Group contents", - "description" : "This endpoint is used for replication within a cluster, when replacing a flow with a new flow. It expects that the flow beingreplaced is not under version control and that the given snapshot will not modify any Processor that is currently running or any Controller Service that is enabled. Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "replaceProcessGroup", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The process group replace request entity.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ProcessGroupImportEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessGroupImportEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - }, { - "Write - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/process-groups/{id}/funnels" : { - "get" : { - "tags" : [ "process-groups" ], - "summary" : "Gets all funnels", - "description" : "", - "operationId" : "getFunnels", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/FunnelsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - } ] - }, - "post" : { - "tags" : [ "process-groups" ], - "summary" : "Creates a funnel", - "description" : "", - "operationId" : "createFunnel", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The funnel configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/FunnelEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/FunnelEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/process-groups/{id}/input-ports" : { - "get" : { - "tags" : [ "process-groups" ], - "summary" : "Gets all input ports", - "description" : "", - "operationId" : "getInputPorts", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/InputPortsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - } ] - }, - "post" : { - "tags" : [ "process-groups" ], - "summary" : "Creates an input port", - "description" : "", - "operationId" : "createInputPort", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The input port configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/PortEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/PortEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/process-groups/{id}/labels" : { - "get" : { - "tags" : [ "process-groups" ], - "summary" : "Gets all labels", - "description" : "", - "operationId" : "getLabels", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/LabelsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - } ] - }, - "post" : { - "tags" : [ "process-groups" ], - "summary" : "Creates a label", - "description" : "", - "operationId" : "createLabel", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The label configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/LabelEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/LabelEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/process-groups/{id}/local-modifications" : { - "get" : { - "tags" : [ "process-groups" ], - "summary" : "Gets a list of local modifications to the Process Group since it was last synchronized with the Flow Registry", - "description" : "", - "operationId" : "getLocalModifications", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/FlowComparisonEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - }, { - "Read - /{component-type}/{uuid} - For all encapsulated components" : [ ] - } ] - } - }, - "/process-groups/{id}/output-ports" : { - "get" : { - "tags" : [ "process-groups" ], - "summary" : "Gets all output ports", - "description" : "", - "operationId" : "getOutputPorts", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/OutputPortsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - } ] - }, - "post" : { - "tags" : [ "process-groups" ], - "summary" : "Creates an output port", - "description" : "", - "operationId" : "createOutputPort", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The output port configuration.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/PortEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/PortEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/process-groups/{id}/process-groups" : { - "get" : { - "tags" : [ "process-groups" ], - "summary" : "Gets all process groups", - "description" : "", - "operationId" : "getProcessGroups", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessGroupsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - } ] - }, - "post" : { - "tags" : [ "process-groups" ], - "summary" : "Creates a process group", - "description" : "", - "operationId" : "createProcessGroup", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The process group configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ProcessGroupEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessGroupEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/process-groups/{id}/process-groups/import" : { - "post" : { - "tags" : [ "process-groups" ], - "summary" : "Imports a specified process group", - "description" : "", - "operationId" : "importProcessGroup", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessGroupEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/process-groups/{id}/process-groups/upload" : { - "post" : { - "tags" : [ "process-groups" ], - "summary" : "Uploads a versioned flow definition and creates a process group", - "description" : "", - "operationId" : "uploadProcessGroup", - "consumes" : [ "multipart/form-data" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The process group name.", - "required" : true, - "schema" : { - "type" : "string" - } - }, { - "in" : "body", - "name" : "body", - "description" : "The process group X position.", - "required" : true, - "schema" : { - "type" : "number", - "format" : "double" - } - }, { - "in" : "body", - "name" : "body", - "description" : "The process group Y position.", - "required" : true, - "schema" : { - "type" : "number", - "format" : "double" - } - }, { - "in" : "body", - "name" : "body", - "description" : "The client id.", - "required" : true, - "schema" : { - "type" : "string" - } - }, { - "in" : "body", - "name" : "body", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "schema" : { - "type" : "boolean" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessGroupEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/process-groups/{id}/processors" : { - "get" : { - "tags" : [ "process-groups" ], - "summary" : "Gets all processors", - "description" : "", - "operationId" : "getProcessors", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "name" : "includeDescendantGroups", - "in" : "query", - "description" : "Whether or not to include processors from descendant process groups", - "required" : false, - "type" : "boolean", - "default" : false - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessorsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - } ] - }, - "post" : { - "tags" : [ "process-groups" ], - "summary" : "Creates a new processor", - "description" : "", - "operationId" : "createProcessor", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The processor configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ProcessorEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessorEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - }, { - "Read - any referenced Controller Services - /controller-services/{uuid}" : [ ] - }, { - "Write - if the Processor is restricted - /restricted-components" : [ ] - } ] - } - }, - "/process-groups/{id}/remote-process-groups" : { - "get" : { - "tags" : [ "process-groups" ], - "summary" : "Gets all remote process groups", - "description" : "", - "operationId" : "getRemoteProcessGroups", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/RemoteProcessGroupsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - } ] - }, - "post" : { - "tags" : [ "process-groups" ], - "summary" : "Creates a new process group", - "description" : "", - "operationId" : "createRemoteProcessGroup", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The remote process group configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/RemoteProcessGroupEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/RemoteProcessGroupEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/process-groups/{id}/replace-requests" : { - "post" : { - "tags" : [ "process-groups" ], - "summary" : "Initiate the Replace Request of a Process Group with the given ID", - "description" : "This will initiate the action of replacing a process group with the given process group. This can be a lengthy process, as it will stop any Processors and disable any Controller Services necessary to perform the action and then restart them. As a result, the endpoint will immediately return a ProcessGroupReplaceRequestEntity, and the process of replacing the flow will occur asynchronously in the background. The client may then periodically poll the status of the request by issuing a GET request to /process-groups/replace-requests/{requestId}. Once the request is completed, the client is expected to issue a DELETE request to /process-groups/replace-requests/{requestId}. Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "initiateReplaceProcessGroup", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The process group replace request entity", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ProcessGroupImportEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessGroupReplaceRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - }, { - "Write - /process-groups/{uuid}" : [ ] - }, { - "Read - /{component-type}/{uuid} - For all encapsulated components" : [ ] - }, { - "Write - /{component-type}/{uuid} - For all encapsulated components" : [ ] - }, { - "Write - if the template contains any restricted components - /restricted-components" : [ ] - }, { - "Read - /parameter-contexts/{uuid} - For any Parameter Context that is referenced by a Property that is changed, added, or removed" : [ ] - } ] - } - }, - "/process-groups/{id}/snippet-instance" : { - "post" : { - "tags" : [ "process-groups" ], - "summary" : "Copies a snippet and discards it.", - "description" : "", - "operationId" : "copySnippet", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The copy snippet request.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/CopySnippetRequestEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/FlowEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - }, { - "Read - /{component-type}/{uuid} - For each component in the snippet and their descendant components" : [ ] - }, { - "Write - if the snippet contains any restricted Processors - /restricted-components" : [ ] - } ] - } - }, - "/process-groups/{id}/template-instance" : { - "post" : { - "tags" : [ "process-groups" ], - "summary" : "Instantiates a template", - "description" : "", - "operationId" : "instantiateTemplate", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The instantiate template request.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/InstantiateTemplateRequestEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/FlowEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - }, { - "Read - /templates/{uuid}" : [ ] - }, { - "Write - if the template contains any restricted components - /restricted-components" : [ ] - } ] - } - }, - "/process-groups/{id}/templates" : { - "post" : { - "tags" : [ "process-groups" ], - "summary" : "Creates a template and discards the specified snippet.", - "description" : "", - "operationId" : "createTemplate", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The create template request.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/CreateTemplateRequestEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/TemplateEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - }, { - "Read - /{component-type}/{uuid} - For each component in the snippet and their descendant components" : [ ] - } ] - } - }, - "/process-groups/{id}/templates/import" : { - "post" : { - "tags" : [ "process-groups" ], - "summary" : "Imports a template", - "description" : "", - "operationId" : "importTemplate", - "consumes" : [ "application/xml" ], - "produces" : [ "application/xml" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/TemplateEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/process-groups/{id}/templates/upload" : { - "post" : { - "tags" : [ "process-groups" ], - "summary" : "Uploads a template", - "description" : "", - "operationId" : "uploadTemplate", - "consumes" : [ "multipart/form-data" ], - "produces" : [ "application/xml" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "schema" : { - "type" : "boolean" - } - }, { - "name" : "template", - "in" : "formData", - "description" : "The binary content of the template file being uploaded.", - "required" : true, - "type" : "file" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/TemplateEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/process-groups/{id}/variable-registry" : { - "get" : { - "tags" : [ "process-groups" ], - "summary" : "Gets a process group's variable registry", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getVariableRegistry", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "name" : "includeAncestorGroups", - "in" : "query", - "description" : "Whether or not to include ancestor groups", - "required" : false, - "type" : "boolean", - "default" : true - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VariableRegistryEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - } ] - }, - "put" : { - "tags" : [ "process-groups" ], - "summary" : "Updates the contents of a Process Group's variable Registry", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "updateVariableRegistry", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The variable registry configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/VariableRegistryEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VariableRegistryEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/process-groups/{id}/variable-registry/update-requests" : { - "post" : { - "tags" : [ "process-groups" ], - "summary" : "Submits a request to update a process group's variable registry", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "submitUpdateVariableRegistryRequest", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The variable registry configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/VariableRegistryEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VariableRegistryUpdateRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/processors/run-status-details/queries" : { - "post" : { - "tags" : [ "processors" ], - "summary" : "Submits a query to retrieve the run status details of all processors that are in the given list of Processor IDs", - "description" : "", - "operationId" : "getProcessorRunStatusDetails", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The request for the processors that should be included in the results", - "required" : false, - "schema" : { - "$ref" : "#/definitions/RunStatusDetailsRequestEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessorsRunStatusDetailsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /processors/{uuid} for each processor whose run status information is requested" : [ ] - } ] - } - }, - "/processors/{id}" : { - "get" : { - "tags" : [ "processors" ], - "summary" : "Gets a processor", - "description" : "", - "operationId" : "getProcessor", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The processor id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessorEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /processors/{uuid}" : [ ] - } ] - }, - "put" : { - "tags" : [ "processors" ], - "summary" : "Updates a processor", - "description" : "", - "operationId" : "updateProcessor", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The processor id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The processor configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ProcessorEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessorEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /processors/{uuid}" : [ ] - }, { - "Read - any referenced Controller Services if this request changes the reference - /controller-services/{uuid}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "processors" ], - "summary" : "Deletes a processor", - "description" : "", - "operationId" : "deleteProcessor", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The revision is used to verify the client is working with the latest version of the flow.", - "required" : false, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The processor id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessorEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /processors/{uuid}" : [ ] - }, { - "Write - Parent Process Group - /process-groups/{uuid}" : [ ] - }, { - "Read - any referenced Controller Services - /controller-services/{uuid}" : [ ] - } ] - } - }, - "/processors/{id}/config/analysis" : { - "post" : { - "tags" : [ "processors" ], - "summary" : "Performs analysis of the component's configuration, providing information about which attributes are referenced.", - "description" : "", - "operationId" : "analyzeConfiguration", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The processor id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The processor configuration analysis request.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ConfigurationAnalysisEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/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. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /processors/{uuid}" : [ ] - } ] - } - }, - "/processors/{id}/config/verification-requests" : { - "post" : { - "tags" : [ "processors" ], - "summary" : "Performs verification of the Processor's configuration", - "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", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The processor id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The processor configuration verification request.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/VerifyConfigRequestEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/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. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /processors/{uuid}" : [ ] - } ] - } - }, - "/processors/{id}/config/verification-requests/{requestId}" : { - "get" : { - "tags" : [ "processors" ], - "summary" : "Returns the Verification Request with the given ID", - "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", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The ID of the Processor", - "required" : true, - "type" : "string" - }, { - "name" : "requestId", - "in" : "path", - "description" : "The ID of the Verification Request", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/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. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Only the user that submitted the request can get it" : [ ] - } ] - }, - "delete" : { - "tags" : [ "processors" ], - "summary" : "Deletes the Verification Request with the given ID", - "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", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The ID of the Processor", - "required" : true, - "type" : "string" - }, { - "name" : "requestId", - "in" : "path", - "description" : "The ID of the Verification Request", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/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. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Only the user that submitted the request can remove it" : [ ] - } ] - } - }, - "/processors/{id}/descriptors" : { - "get" : { - "tags" : [ "processors" ], - "summary" : "Gets the descriptor for a processor property", - "description" : "", - "operationId" : "getPropertyDescriptor", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The processor id.", - "required" : true, - "type" : "string" - }, { - "name" : "propertyName", - "in" : "query", - "description" : "The property name.", - "required" : true, - "type" : "string" - }, { - "name" : "sensitive", - "in" : "query", - "description" : "Property Descriptor requested sensitive status", - "required" : false, - "type" : "boolean", - "default" : false - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/PropertyDescriptorEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /processors/{uuid}" : [ ] - } ] - } - }, - "/processors/{id}/diagnostics" : { - "get" : { - "tags" : [ "processors" ], - "summary" : "Gets diagnostics information about a processor", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getProcessorDiagnostics", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The processor id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessorEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /processors/{uuid}" : [ ] - } ] - } - }, - "/processors/{id}/run-status" : { - "put" : { - "tags" : [ "processors" ], - "summary" : "Updates run status of a processor", - "description" : "", - "operationId" : "updateRunStatus", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The processor id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The processor run status.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ProcessorRunStatusEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessorEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /processors/{uuid} or /operation/processors/{uuid}" : [ ] - } ] - } - }, - "/processors/{id}/state" : { - "get" : { - "tags" : [ "processors" ], - "summary" : "Gets the state for a processor", - "description" : "", - "operationId" : "getState", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The processor id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ComponentStateEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /processors/{uuid}" : [ ] - } ] - } - }, - "/processors/{id}/state/clear-requests" : { - "post" : { - "tags" : [ "processors" ], - "summary" : "Clears the state for a processor", - "description" : "", - "operationId" : "clearState", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The processor id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ComponentStateEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /processors/{uuid}" : [ ] - } ] - } - }, - "/processors/{id}/threads" : { - "delete" : { - "tags" : [ "processors" ], - "summary" : "Terminates a processor, essentially \"deleting\" its threads and any active tasks", - "description" : "", - "operationId" : "terminateProcessor", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The processor id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessorEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /processors/{uuid} or /operation/processors/{uuid}" : [ ] - } ] - } - }, - "/provenance" : { - "post" : { - "tags" : [ "provenance" ], - "summary" : "Submits a provenance query", - "description" : "Provenance queries may be long running so this endpoint submits a request. The response will include the current state of the query. If the request is not completed the URI in the response can be used at a later time to get the updated state of the query. Once the query has completed the provenance request should be deleted by the client who originally submitted it.", - "operationId" : "submitProvenanceRequest", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The provenance query details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ProvenanceEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProvenanceEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /provenance" : [ ] - }, { - "Read - /data/{component-type}/{uuid}" : [ ] - } ] - } - }, - "/provenance-events/replays" : { - "post" : { - "tags" : [ "provenance-events" ], - "summary" : "Replays content from a provenance event", - "description" : "", - "operationId" : "submitReplay", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The replay request.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/SubmitReplayRequestEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProvenanceEventEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read Component Provenance Data - /provenance-data/{component-type}/{uuid}" : [ ] - }, { - "Read Component Data - /data/{component-type}/{uuid}" : [ ] - }, { - "Write Component Data - /data/{component-type}/{uuid}" : [ ] - } ] - } - }, - "/provenance-events/{id}" : { - "get" : { - "tags" : [ "provenance-events" ], - "summary" : "Gets a provenance event", - "description" : "", - "operationId" : "getProvenanceEvent", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "clusterNodeId", - "in" : "query", - "description" : "The id of the node where this event exists if clustered.", - "required" : false, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The provenance event id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProvenanceEventEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read Component Provenance Data - /provenance-data/{component-type}/{uuid}" : [ ] - } ] - } - }, - "/provenance-events/{id}/content/input" : { - "get" : { - "tags" : [ "provenance-events" ], - "summary" : "Gets the input content for a provenance event", - "description" : "", - "operationId" : "getInputContent", - "consumes" : [ "*/*" ], - "produces" : [ "*/*" ], - "parameters" : [ { - "name" : "clusterNodeId", - "in" : "query", - "description" : "The id of the node where the content exists if clustered.", - "required" : false, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The provenance event id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/StreamingOutput" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read Component Provenance Data - /provenance-data/{component-type}/{uuid}" : [ ] - }, { - "Read Component Data - /data/{component-type}/{uuid}" : [ ] - } ] - } - }, - "/provenance-events/{id}/content/output" : { - "get" : { - "tags" : [ "provenance-events" ], - "summary" : "Gets the output content for a provenance event", - "description" : "", - "operationId" : "getOutputContent", - "consumes" : [ "*/*" ], - "produces" : [ "*/*" ], - "parameters" : [ { - "name" : "clusterNodeId", - "in" : "query", - "description" : "The id of the node where the content exists if clustered.", - "required" : false, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The provenance event id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/StreamingOutput" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read Component Provenance Data - /provenance-data/{component-type}/{uuid}" : [ ] - }, { - "Read Component Data - /data/{component-type}/{uuid}" : [ ] - } ] - } - }, - "/provenance/lineage" : { - "post" : { - "tags" : [ "provenance" ], - "summary" : "Submits a lineage query", - "description" : "Lineage queries may be long running so this endpoint submits a request. The response will include the current state of the query. If the request is not completed the URI in the response can be used at a later time to get the updated state of the query. Once the query has completed the lineage request should be deleted by the client who originally submitted it.", - "operationId" : "submitLineageRequest", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The lineage query details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/LineageEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/LineageEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /provenance" : [ ] - }, { - "Read - /data/{component-type}/{uuid}" : [ ] - } ] - } - }, - "/provenance/lineage/{id}" : { - "get" : { - "tags" : [ "provenance" ], - "summary" : "Gets a lineage query", - "description" : "", - "operationId" : "getLineage", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "clusterNodeId", - "in" : "query", - "description" : "The id of the node where this query exists if clustered.", - "required" : false, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The id of the lineage query.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/LineageEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /provenance" : [ ] - }, { - "Read - /data/{component-type}/{uuid}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "provenance" ], - "summary" : "Deletes a lineage query", - "description" : "", - "operationId" : "deleteLineage", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "clusterNodeId", - "in" : "query", - "description" : "The id of the node where this query exists if clustered.", - "required" : false, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The id of the lineage query.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/LineageEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /provenance" : [ ] - } ] - } - }, - "/provenance/search-options" : { - "get" : { - "tags" : [ "provenance" ], - "summary" : "Gets the searchable attributes for provenance events", - "description" : "", - "operationId" : "getSearchOptions", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProvenanceOptionsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /provenance" : [ ] - } ] - } - }, - "/provenance/{id}" : { - "get" : { - "tags" : [ "provenance" ], - "summary" : "Gets a provenance query", - "description" : "", - "operationId" : "getProvenance", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "clusterNodeId", - "in" : "query", - "description" : "The id of the node where this query exists if clustered.", - "required" : false, - "type" : "string" - }, { - "name" : "summarize", - "in" : "query", - "description" : "Whether or not incremental results are returned. If false, provenance events are only returned once the query completes. This property is true by default.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "incrementalResults", - "in" : "query", - "description" : "Whether or not to summarize provenance events returned. This property is false by default.", - "required" : false, - "type" : "boolean", - "default" : true - }, { - "name" : "id", - "in" : "path", - "description" : "The id of the provenance query.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProvenanceEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /provenance" : [ ] - }, { - "Read - /data/{component-type}/{uuid}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "provenance" ], - "summary" : "Deletes a provenance query", - "description" : "", - "operationId" : "deleteProvenance", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "clusterNodeId", - "in" : "query", - "description" : "The id of the node where this query exists if clustered.", - "required" : false, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The id of the provenance query.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProvenanceEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /provenance" : [ ] - } ] - } - }, - "/remote-process-groups/process-group/{id}/run-status" : { - "put" : { - "tags" : [ "remote-process-groups" ], - "summary" : "Updates run status of all remote process groups in a process group (recursively)", - "description" : "", - "operationId" : "updateRemoteProcessGroupRunStatuses", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The remote process groups run status.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/RemotePortRunStatusEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/RemoteProcessGroupEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /remote-process-groups/{uuid} or /operation/remote-process-groups/{uuid}" : [ ] - } ] - } - }, - "/remote-process-groups/{id}" : { - "get" : { - "tags" : [ "remote-process-groups" ], - "summary" : "Gets a remote process group", - "description" : "", - "operationId" : "getRemoteProcessGroup", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The remote process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/RemoteProcessGroupEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /remote-process-groups/{uuid}" : [ ] - } ] - }, - "put" : { - "tags" : [ "remote-process-groups" ], - "summary" : "Updates a remote process group", - "description" : "", - "operationId" : "updateRemoteProcessGroup", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The remote process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The remote process group.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/RemoteProcessGroupEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/RemoteProcessGroupEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /remote-process-groups/{uuid}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "remote-process-groups" ], - "summary" : "Deletes a remote process group", - "description" : "", - "operationId" : "removeRemoteProcessGroup", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The revision is used to verify the client is working with the latest version of the flow.", - "required" : false, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The remote process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/RemoteProcessGroupEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /remote-process-groups/{uuid}" : [ ] - }, { - "Write - Parent Process Group - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/remote-process-groups/{id}/input-ports/{port-id}" : { - "put" : { - "tags" : [ "remote-process-groups" ], - "summary" : "Updates a remote port", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "updateRemoteProcessGroupInputPort", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The remote process group id.", - "required" : true, - "type" : "string" - }, { - "name" : "port-id", - "in" : "path", - "description" : "The remote process group port id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The remote process group port.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/RemoteProcessGroupPortEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/RemoteProcessGroupPortEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /remote-process-groups/{uuid}" : [ ] - } ] - } - }, - "/remote-process-groups/{id}/input-ports/{port-id}/run-status" : { - "put" : { - "tags" : [ "remote-process-groups" ], - "summary" : "Updates run status of a remote port", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "updateRemoteProcessGroupInputPortRunStatus", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The remote process group id.", - "required" : true, - "type" : "string" - }, { - "name" : "port-id", - "in" : "path", - "description" : "The remote process group port id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The remote process group port.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/RemotePortRunStatusEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/RemoteProcessGroupPortEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /remote-process-groups/{uuid} or /operation/remote-process-groups/{uuid}" : [ ] - } ] - } - }, - "/remote-process-groups/{id}/output-ports/{port-id}" : { - "put" : { - "tags" : [ "remote-process-groups" ], - "summary" : "Updates a remote port", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "updateRemoteProcessGroupOutputPort", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The remote process group id.", - "required" : true, - "type" : "string" - }, { - "name" : "port-id", - "in" : "path", - "description" : "The remote process group port id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The remote process group port.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/RemoteProcessGroupPortEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/RemoteProcessGroupPortEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /remote-process-groups/{uuid}" : [ ] - } ] - } - }, - "/remote-process-groups/{id}/output-ports/{port-id}/run-status" : { - "put" : { - "tags" : [ "remote-process-groups" ], - "summary" : "Updates run status of a remote port", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "updateRemoteProcessGroupOutputPortRunStatus", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The remote process group id.", - "required" : true, - "type" : "string" - }, { - "name" : "port-id", - "in" : "path", - "description" : "The remote process group port id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The remote process group port.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/RemotePortRunStatusEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/RemoteProcessGroupPortEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /remote-process-groups/{uuid} or /operation/remote-process-groups/{uuid}" : [ ] - } ] - } - }, - "/remote-process-groups/{id}/run-status" : { - "put" : { - "tags" : [ "remote-process-groups" ], - "summary" : "Updates run status of a remote process group", - "description" : "", - "operationId" : "updateRemoteProcessGroupRunStatus", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The remote process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The remote process group run status.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/RemotePortRunStatusEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/RemoteProcessGroupEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /remote-process-groups/{uuid} or /operation/remote-process-groups/{uuid}" : [ ] - } ] - } - }, - "/remote-process-groups/{id}/state" : { - "get" : { - "tags" : [ "remote-process-groups" ], - "summary" : "Gets the state for a RemoteProcessGroup", - "description" : "", - "operationId" : "getState", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The processor id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ComponentStateEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /remote-process-groups/{uuid}" : [ ] - } ] - } - }, - "/reporting-tasks/{id}" : { - "get" : { - "tags" : [ "reporting-tasks" ], - "summary" : "Gets a reporting task", - "description" : "", - "operationId" : "getReportingTask", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The reporting task id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ReportingTaskEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /reporting-tasks/{uuid}" : [ ] - } ] - }, - "put" : { - "tags" : [ "reporting-tasks" ], - "summary" : "Updates a reporting task", - "description" : "", - "operationId" : "updateReportingTask", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The reporting task id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The reporting task configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ReportingTaskEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ReportingTaskEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /reporting-tasks/{uuid}" : [ ] - }, { - "Read - any referenced Controller Services if this request changes the reference - /controller-services/{uuid}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "reporting-tasks" ], - "summary" : "Deletes a reporting task", - "description" : "", - "operationId" : "removeReportingTask", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The revision is used to verify the client is working with the latest version of the flow.", - "required" : false, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The reporting task id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ReportingTaskEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /reporting-tasks/{uuid}" : [ ] - }, { - "Write - /controller" : [ ] - }, { - "Read - any referenced Controller Services - /controller-services/{uuid}" : [ ] - } ] - } - }, - "/reporting-tasks/{id}/config/analysis" : { - "post" : { - "tags" : [ "reporting-tasks" ], - "summary" : "Performs analysis of the component's configuration, providing information about which attributes are referenced.", - "description" : "", - "operationId" : "analyzeConfiguration", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The reporting task id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The configuration analysis request.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ConfigurationAnalysisEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/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. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /reporting-tasks/{uuid}" : [ ] - } ] - } - }, - "/reporting-tasks/{id}/config/verification-requests" : { - "post" : { - "tags" : [ "reporting-tasks" ], - "summary" : "Performs verification of the Reporting Task's configuration", - "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/{serviceId}/verification-requests/{requestId}. Once the request is completed, the client is expected to issue a DELETE request to /reporting-tasks/{serviceId}/verification-requests/{requestId}.", - "operationId" : "submitConfigVerificationRequest", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The reporting task id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The reporting task configuration verification request.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/VerifyConfigRequestEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/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. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /reporting-tasks/{uuid}" : [ ] - } ] - } - }, - "/reporting-tasks/{id}/config/verification-requests/{requestId}" : { - "get" : { - "tags" : [ "reporting-tasks" ], - "summary" : "Returns the Verification Request with the given ID", - "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", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The ID of the Reporting Task", - "required" : true, - "type" : "string" - }, { - "name" : "requestId", - "in" : "path", - "description" : "The ID of the Verification Request", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/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. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Only the user that submitted the request can get it" : [ ] - } ] - }, - "delete" : { - "tags" : [ "reporting-tasks" ], - "summary" : "Deletes the Verification Request with the given ID", - "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" : "deleteValidationRequest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The ID of the Reporting Task", - "required" : true, - "type" : "string" - }, { - "name" : "requestId", - "in" : "path", - "description" : "The ID of the Verification Request", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/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. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Only the user that submitted the request can remove it" : [ ] - } ] - } - }, - "/reporting-tasks/{id}/descriptors" : { - "get" : { - "tags" : [ "reporting-tasks" ], - "summary" : "Gets a reporting task property descriptor", - "description" : "", - "operationId" : "getPropertyDescriptor", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The reporting task id.", - "required" : true, - "type" : "string" - }, { - "name" : "propertyName", - "in" : "query", - "description" : "The property name.", - "required" : true, - "type" : "string" - }, { - "name" : "sensitive", - "in" : "query", - "description" : "Property Descriptor requested sensitive status", - "required" : false, - "type" : "boolean", - "default" : false - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/PropertyDescriptorEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /reporting-tasks/{uuid}" : [ ] - } ] - } - }, - "/reporting-tasks/{id}/run-status" : { - "put" : { - "tags" : [ "reporting-tasks" ], - "summary" : "Updates run status of a reporting task", - "description" : "", - "operationId" : "updateRunStatus", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The reporting task id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The reporting task run status.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ReportingTaskRunStatusEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ReportingTaskEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /reporting-tasks/{uuid} or or /operation/reporting-tasks/{uuid}" : [ ] - } ] - } - }, - "/reporting-tasks/{id}/state" : { - "get" : { - "tags" : [ "reporting-tasks" ], - "summary" : "Gets the state for a reporting task", - "description" : "", - "operationId" : "getState", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The reporting task id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ComponentStateEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /reporting-tasks/{uuid}" : [ ] - } ] - } - }, - "/reporting-tasks/{id}/state/clear-requests" : { - "post" : { - "tags" : [ "reporting-tasks" ], - "summary" : "Clears the state for a reporting task", - "description" : "", - "operationId" : "clearState", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The reporting task id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ComponentStateEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /reporting-tasks/{uuid}" : [ ] - } ] - } - }, - "/resources" : { - "get" : { - "tags" : [ "resources" ], - "summary" : "Gets the available resources that support access/authorization policies", - "description" : "", - "operationId" : "getResources", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ResourcesEntity" - } - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - } - }, - "security" : [ { - "Read - /resources" : [ ] - } ] - } - }, - "/site-to-site" : { - "get" : { - "tags" : [ "site-to-site" ], - "summary" : "Returns the details about this NiFi necessary to communicate via site to site", - "description" : "", - "operationId" : "getSiteToSiteDetails", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ControllerEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /site-to-site" : [ ] - } ] - } - }, - "/site-to-site/peers" : { - "get" : { - "tags" : [ "site-to-site" ], - "summary" : "Returns the available Peers and its status of this NiFi", - "description" : "", - "operationId" : "getPeers", - "consumes" : [ "*/*" ], - "produces" : [ "application/json", "application/xml" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/PeersEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /site-to-site" : [ ] - } ] - } - }, - "/snippets" : { - "post" : { - "tags" : [ "snippets" ], - "summary" : "Creates a snippet. The snippet will be automatically discarded if not used in a subsequent request after 1 minute.", - "description" : "", - "operationId" : "createSnippet", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The snippet configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/SnippetEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/SnippetEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read or Write - /{component-type}/{uuid} - For every component (all Read or all Write) in the Snippet and their descendant components" : [ ] - } ] - } - }, - "/snippets/{id}" : { - "put" : { - "tags" : [ "snippets" ], - "summary" : "Move's the components in this Snippet into a new Process Group and discards the snippet", - "description" : "", - "operationId" : "updateSnippet", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The snippet id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The snippet configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/SnippetEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/SnippetEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write Process Group - /process-groups/{uuid}" : [ ] - }, { - "Write - /{component-type}/{uuid} - For each component in the Snippet and their descendant components" : [ ] - } ] - }, - "delete" : { - "tags" : [ "snippets" ], - "summary" : "Deletes the components in a snippet and discards the snippet", - "description" : "", - "operationId" : "deleteSnippet", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The snippet id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/SnippetEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /{component-type}/{uuid} - For each component in the Snippet and their descendant components" : [ ] - }, { - "Write - Parent Process Group - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/system-diagnostics" : { - "get" : { - "tags" : [ "system-diagnostics" ], - "summary" : "Gets the diagnostics for the system NiFi is running on", - "description" : "", - "operationId" : "getSystemDiagnostics", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "nodewise", - "in" : "query", - "description" : "Whether or not to include the breakdown per node. Optional, defaults to false", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "clusterNodeId", - "in" : "query", - "description" : "The id of the node where to get the status.", - "required" : false, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/SystemDiagnosticsEntity" - } - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - } - }, - "security" : [ { - "Read - /system" : [ ] - } ] - } - }, - "/templates/{id}" : { - "delete" : { - "tags" : [ "templates" ], - "summary" : "Deletes a template", - "description" : "", - "operationId" : "removeTemplate", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The template id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/TemplateEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /templates/{uuid}" : [ ] - }, { - "Write - Parent Process Group - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/templates/{id}/download" : { - "get" : { - "tags" : [ "templates" ], - "summary" : "Exports a template", - "description" : "", - "operationId" : "exportTemplate", - "consumes" : [ "*/*" ], - "produces" : [ "application/xml" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The template id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /templates/{uuid}" : [ ] - } ] - } - }, - "/tenants/search-results" : { - "get" : { - "tags" : [ "tenants" ], - "summary" : "Searches for a tenant with the specified identity", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "searchTenants", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "q", - "in" : "query", - "description" : "Identity to search for.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/TenantsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /tenants" : [ ] - } ] - } - }, - "/tenants/user-groups" : { - "get" : { - "tags" : [ "tenants" ], - "summary" : "Gets all user groups", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getUserGroups", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/UserGroupsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /tenants" : [ ] - } ] - }, - "post" : { - "tags" : [ "tenants" ], - "summary" : "Creates a user group", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "createUserGroup", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The user group configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/UserGroupEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/UserGroupEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /tenants" : [ ] - } ] - } - }, - "/tenants/user-groups/{id}" : { - "get" : { - "tags" : [ "tenants" ], - "summary" : "Gets a user group", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getUserGroup", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The user group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/UserGroupEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /tenants" : [ ] - } ] - }, - "put" : { - "tags" : [ "tenants" ], - "summary" : "Updates a user group", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "updateUserGroup", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The user group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The user group configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/UserGroupEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/UserGroupEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /tenants" : [ ] - } ] - }, - "delete" : { - "tags" : [ "tenants" ], - "summary" : "Deletes a user group", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "removeUserGroup", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The revision is used to verify the client is working with the latest version of the flow.", - "required" : false, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The user group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/UserGroupEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /tenants" : [ ] - } ] - } - }, - "/tenants/users" : { - "get" : { - "tags" : [ "tenants" ], - "summary" : "Gets all users", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getUsers", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/UsersEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /tenants" : [ ] - } ] - }, - "post" : { - "tags" : [ "tenants" ], - "summary" : "Creates a user", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "createUser", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The user configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/UserEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/UserEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /tenants" : [ ] - } ] - } - }, - "/tenants/users/{id}" : { - "get" : { - "tags" : [ "tenants" ], - "summary" : "Gets a user", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getUser", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The user id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/UserEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /tenants" : [ ] - } ] - }, - "put" : { - "tags" : [ "tenants" ], - "summary" : "Updates a user", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "updateUser", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The user id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The user configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/UserEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/UserEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /tenants" : [ ] - } ] - }, - "delete" : { - "tags" : [ "tenants" ], - "summary" : "Deletes a user", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "removeUser", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The revision is used to verify the client is working with the latest version of the flow.", - "required" : false, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The user id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/UserEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /tenants" : [ ] - } ] - } - }, - "/versions/active-requests" : { - "post" : { - "tags" : [ "versions" ], - "summary" : "Create a version control request", - "description" : "Creates a request so that a Process Group can be placed under Version Control or have its Version Control configuration changed. Creating this request will prevent any other threads from simultaneously saving local changes to Version Control. It will not, however, actually save the local flow to the Flow Registry. A POST to /versions/process-groups/{id} should be used to initiate saving of the local flow to the Flow Registry. Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "createVersionControlRequest", - "consumes" : [ "application/json" ], - "produces" : [ "text/plain" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The versioned flow details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/CreateActiveRequestEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/versions/active-requests/{id}" : { - "put" : { - "tags" : [ "versions" ], - "summary" : "Updates the request with the given ID", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "updateVersionControlRequest", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The request ID.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The version control component mapping.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/VersionControlComponentMappingEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionControlInformationEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Only the user that submitted the request can update it" : [ ] - } ] - }, - "delete" : { - "tags" : [ "versions" ], - "summary" : "Deletes the version control request with the given ID", - "description" : "Deletes the Version Control Request with the given ID. This will allow other threads to save flows to the Flow Registry. See also the documentation for POSTing to /versions/active-requests for information regarding why this is done. Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "deleteVersionControlRequest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The request ID.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Only the user that submitted the request can remove it" : [ ] - } ] - } - }, - "/versions/process-groups/{id}" : { - "get" : { - "tags" : [ "versions" ], - "summary" : "Gets the Version Control information for a process group", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getVersionInformation", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionControlInformationEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - } ] - }, - "post" : { - "tags" : [ "versions" ], - "summary" : "Save the Process Group with the given ID", - "description" : "Begins version controlling the Process Group with the given ID or commits changes to the Versioned Flow, depending on if the provided VersionControlInformation includes a flowId. Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "saveToFlowRegistry", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The versioned flow details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/StartVersionControlRequestEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionControlInformationEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - }, { - "Write - /process-groups/{uuid}" : [ ] - }, { - "Read - /{component-type}/{uuid} - For all encapsulated components" : [ ] - }, { - "Read - any referenced Controller Services by any encapsulated components - /controller-services/{uuid}" : [ ] - } ] - }, - "put" : { - "tags" : [ "versions" ], - "summary" : "Update the version of a Process Group with the given ID", - "description" : "For a Process Group that is already under Version Control, this will update the version of the flow to a different version. This endpoint expects that the given snapshot will not modify any Processor that is currently running or any Controller Service that is enabled. Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "updateFlowVersion", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The controller service configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/VersionedFlowSnapshotEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionControlInformationEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - }, { - "Write - /process-groups/{uuid}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "versions" ], - "summary" : "Stops version controlling the Process Group with the given ID", - "description" : "Stops version controlling the Process Group with the given ID. The Process Group will no longer track to any Versioned Flow. Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "stopVersionControl", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The version is used to verify the client is working with the latest version of the flow.", - "required" : false, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, a new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionControlInformationEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - }, { - "Write - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/versions/process-groups/{id}/download" : { - "get" : { - "tags" : [ "versions" ], - "summary" : "Gets the latest version of a Process Group for download", - "description" : "", - "operationId" : "exportFlowVersion", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/versions/revert-requests/process-groups/{id}" : { - "post" : { - "tags" : [ "versions" ], - "summary" : "Initiate the Revert Request of a Process Group with the given ID", - "description" : "For a Process Group that is already under Version Control, this will initiate the action of reverting any local changes that have been made to the Process Group since it was last synchronized with the Flow Registry. This will result in the flow matching the Versioned Flow that exists in the Flow Registry. This can be a lengthy process, as it will stop any Processors and disable any Controller Services necessary to perform the action and then restart them. As a result, the endpoint will immediately return a VersionedFlowUpdateRequestEntity, and the process of updating the flow will occur asynchronously in the background. The client may then periodically poll the status of the request by issuing a GET request to /versions/revert-requests/{requestId}. Once the request is completed, the client is expected to issue a DELETE request to /versions/revert-requests/{requestId}. Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "initiateRevertFlowVersion", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The controller service configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/VersionControlInformationEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlowUpdateRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - }, { - "Write - /process-groups/{uuid}" : [ ] - }, { - "Read - /{component-type}/{uuid} - For all encapsulated components" : [ ] - }, { - "Write - /{component-type}/{uuid} - For all encapsulated components" : [ ] - }, { - "Write - if the template contains any restricted components - /restricted-components" : [ ] - }, { - "Read - /parameter-contexts/{uuid} - For any Parameter Context that is referenced by a Property that is changed, added, or removed" : [ ] - } ] - } - }, - "/versions/revert-requests/{id}" : { - "get" : { - "tags" : [ "versions" ], - "summary" : "Returns the Revert Request with the given ID", - "description" : "Returns the Revert Request with the given ID. Once a Revert Request has been created by performing a POST to /versions/revert-requests/process-groups/{id}, that request can subsequently be retrieved via this endpoint, and the request that is fetched will contain the updated state, such as percent complete, the current state of the request, and any failures. Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getRevertRequest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The ID of the Revert Request", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlowUpdateRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Only the user that submitted the request can get it" : [ ] - } ] - }, - "delete" : { - "tags" : [ "versions" ], - "summary" : "Deletes the Revert Request with the given ID", - "description" : "Deletes the Revert Request with the given ID. After a request is created via a POST to /versions/revert-requests/process-groups/{id}, it is expected that the client will properly clean up the request by DELETE'ing it, once the Revert process has completed. If the request is deleted before the request completes, then the Revert request will finish the step that it is currently performing and then will cancel any subsequent steps. Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "deleteRevertRequest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The ID of the Revert Request", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlowUpdateRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Only the user that submitted the request can remove it" : [ ] - } ] - } - }, - "/versions/update-requests/process-groups/{id}" : { - "post" : { - "tags" : [ "versions" ], - "summary" : "Initiate the Update Request of a Process Group with the given ID", - "description" : "For a Process Group that is already under Version Control, this will initiate the action of changing from a specific version of the flow in the Flow Registry to a different version of the flow. This can be a lengthy process, as it will stop any Processors and disable any Controller Services necessary to perform the action and then restart them. As a result, the endpoint will immediately return a VersionedFlowUpdateRequestEntity, and the process of updating the flow will occur asynchronously in the background. The client may then periodically poll the status of the request by issuing a GET request to /versions/update-requests/{requestId}. Once the request is completed, the client is expected to issue a DELETE request to /versions/update-requests/{requestId}. Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "initiateVersionControlUpdate", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The controller service configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/VersionControlInformationEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlowUpdateRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - }, { - "Write - /process-groups/{uuid}" : [ ] - }, { - "Read - /{component-type}/{uuid} - For all encapsulated components" : [ ] - }, { - "Write - /{component-type}/{uuid} - For all encapsulated components" : [ ] - }, { - "Write - if the template contains any restricted components - /restricted-components" : [ ] - }, { - "Read - /parameter-contexts/{uuid} - For any Parameter Context that is referenced by a Property that is changed, added, or removed" : [ ] - } ] - } - }, - "/versions/update-requests/{id}" : { - "get" : { - "tags" : [ "versions" ], - "summary" : "Returns the Update Request with the given ID", - "description" : "Returns the Update Request with the given ID. Once an Update Request has been created by performing a POST to /versions/update-requests/process-groups/{id}, that request can subsequently be retrieved via this endpoint, and the request that is fetched will contain the updated state, such as percent complete, the current state of the request, and any failures. Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getUpdateRequest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The ID of the Update Request", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlowUpdateRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Only the user that submitted the request can get it" : [ ] - } ] - }, - "delete" : { - "tags" : [ "versions" ], - "summary" : "Deletes the Update Request with the given ID", - "description" : "Deletes the Update Request with the given ID. After a request is created via a POST to /versions/update-requests/process-groups/{id}, it is expected that the client will properly clean up the request by DELETE'ing it, once the Update process has completed. If the request is deleted before the request completes, then the Update request will finish the step that it is currently performing and then will cancel any subsequent steps. Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "deleteUpdateRequest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The ID of the Update Request", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlowUpdateRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Only the user that submitted the request can remove it" : [ ] - } ] - } - } - }, - "definitions" : { - "AboutDTO" : { - "type" : "object", - "properties" : { - "title" : { - "type" : "string", - "description" : "The title to be used on the page and in the about dialog." - }, - "version" : { - "type" : "string", - "description" : "The version of this NiFi." - }, - "uri" : { - "type" : "string", - "description" : "The URI for the NiFi." - }, - "contentViewerUrl" : { - "type" : "string", - "description" : "The URL for the content viewer if configured." - }, - "timezone" : { - "type" : "string", - "description" : "The timezone of the NiFi instance." - }, - "buildTag" : { - "type" : "string", - "description" : "Build tag" - }, - "buildRevision" : { - "type" : "string", - "description" : "Build revision or commit hash" - }, - "buildBranch" : { - "type" : "string", - "description" : "Build branch" - }, - "buildTimestamp" : { - "type" : "string", - "description" : "Build timestamp" - } - } - }, - "AboutEntity" : { - "type" : "object", - "properties" : { - "about" : { - "$ref" : "#/definitions/AboutDTO" - } - }, - "xml" : { - "name" : "aboutEntity" - } - }, - "AccessConfigurationDTO" : { - "type" : "object", - "properties" : { - "supportsLogin" : { - "type" : "boolean", - "description" : "Indicates whether or not this NiFi supports user login." - } - } - }, - "AccessConfigurationEntity" : { - "type" : "object", - "properties" : { - "config" : { - "$ref" : "#/definitions/AccessConfigurationDTO" - } - }, - "xml" : { - "name" : "accessConfigurationEntity" - } - }, - "AccessPolicyDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "versionedComponentId" : { - "type" : "string", - "description" : "The ID of the corresponding component that is under version control" - }, - "parentGroupId" : { - "type" : "string", - "description" : "The id of parent process group of this component if applicable." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "resource" : { - "type" : "string", - "description" : "The resource for this access policy." - }, - "action" : { - "type" : "string", - "description" : "The action associated with this access policy.", - "enum" : [ "read", "write" ] - }, - "componentReference" : { - "description" : "Component this policy references if applicable.", - "$ref" : "#/definitions/ComponentReferenceEntity" - }, - "configurable" : { - "type" : "boolean", - "description" : "Whether this policy is configurable." - }, - "users" : { - "type" : "array", - "description" : "The set of user IDs associated with this access policy.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/TenantEntity" - } - }, - "userGroups" : { - "type" : "array", - "description" : "The set of user group IDs associated with this access policy.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/TenantEntity" - } - } - } - }, - "AccessPolicyEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "generated" : { - "type" : "string", - "description" : "When this content was generated." - }, - "component" : { - "$ref" : "#/definitions/AccessPolicyDTO" - } - }, - "xml" : { - "name" : "accessPolicyEntity" - } - }, - "AccessPolicySummaryDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "versionedComponentId" : { - "type" : "string", - "description" : "The ID of the corresponding component that is under version control" - }, - "parentGroupId" : { - "type" : "string", - "description" : "The id of parent process group of this component if applicable." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "resource" : { - "type" : "string", - "description" : "The resource for this access policy." - }, - "action" : { - "type" : "string", - "description" : "The action associated with this access policy.", - "enum" : [ "read", "write" ] - }, - "componentReference" : { - "description" : "Component this policy references if applicable.", - "$ref" : "#/definitions/ComponentReferenceEntity" - }, - "configurable" : { - "type" : "boolean", - "description" : "Whether this policy is configurable." - } - } - }, - "AccessPolicySummaryEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "component" : { - "$ref" : "#/definitions/AccessPolicySummaryDTO" - } - }, - "xml" : { - "name" : "accessPolicySummaryEntity" - } - }, - "AccessStatusDTO" : { - "type" : "object", - "properties" : { - "identity" : { - "type" : "string", - "description" : "The user identity." - }, - "status" : { - "type" : "string", - "description" : "The user access status." - }, - "message" : { - "type" : "string", - "description" : "Additional details about the user access status." - } - }, - "xml" : { - "name" : "accessStatus" - } - }, - "AccessStatusEntity" : { - "type" : "object", - "properties" : { - "accessStatus" : { - "$ref" : "#/definitions/AccessStatusDTO" - } - }, - "xml" : { - "name" : "accessStatusEntity" - } - }, - "AccessTokenExpirationDTO" : { - "type" : "object", - "properties" : { - "expiration" : { - "type" : "string", - "description" : "Token Expiration" - } - }, - "xml" : { - "name" : "accessTokenExpiration" - } - }, - "AccessTokenExpirationEntity" : { - "type" : "object", - "properties" : { - "accessTokenExpiration" : { - "$ref" : "#/definitions/AccessTokenExpirationDTO" - } - }, - "xml" : { - "name" : "accessTokenExpirationEntity" - } - }, - "ActionDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "integer", - "format" : "int32", - "description" : "The action id." - }, - "userIdentity" : { - "type" : "string", - "description" : "The identity of the user that performed the action." - }, - "timestamp" : { - "type" : "string", - "description" : "The timestamp of the action." - }, - "sourceId" : { - "type" : "string", - "description" : "The id of the source component." - }, - "sourceName" : { - "type" : "string", - "description" : "The name of the source component." - }, - "sourceType" : { - "type" : "string", - "description" : "The type of the source component." - }, - "componentDetails" : { - "description" : "The details of the source component.", - "$ref" : "#/definitions/ComponentDetailsDTO" - }, - "operation" : { - "type" : "string", - "description" : "The operation that was performed." - }, - "actionDetails" : { - "description" : "The details of the action.", - "$ref" : "#/definitions/ActionDetailsDTO" - } - } - }, - "ActionDetailsDTO" : { - "type" : "object" - }, - "ActionEntity" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "integer", - "format" : "int32" - }, - "timestamp" : { - "type" : "string", - "description" : "The timestamp of the action." - }, - "sourceId" : { - "type" : "string" - }, - "canRead" : { - "type" : "boolean", - "description" : "Indicates whether the user can read a given resource." - }, - "action" : { - "$ref" : "#/definitions/ActionDTO" - } - }, - "xml" : { - "name" : "actionEntity" - } - }, - "ActivateControllerServicesEntity" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the ProcessGroup" - }, - "state" : { - "type" : "string", - "description" : "The desired state of the descendant components", - "enum" : [ "ENABLED", "DISABLED" ] - }, - "components" : { - "type" : "object", - "description" : "Optional services to schedule. If not specified, all authorized descendant controller services will be used.", - "additionalProperties" : { - "$ref" : "#/definitions/RevisionDTO" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - } - }, - "xml" : { - "name" : "activateControllerServicesEntity" - } - }, - "AffectedComponentDTO" : { - "type" : "object", - "properties" : { - "processGroupId" : { - "type" : "string", - "description" : "The UUID of the Process Group that this component is in" - }, - "id" : { - "type" : "string", - "description" : "The UUID of this component" - }, - "referenceType" : { - "type" : "string", - "description" : "The type of this component", - "enum" : [ "PROCESSOR", "CONTROLLER_SERVICE", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT" ] - }, - "name" : { - "type" : "string", - "description" : "The name of this component." - }, - "state" : { - "type" : "string", - "description" : "The scheduled state of a processor or reporting task referencing a controller service. If this component is another controller service, this field represents the controller service state." - }, - "activeThreadCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of active threads for the referencing component." - }, - "validationErrors" : { - "type" : "array", - "description" : "The validation errors for the component.", - "items" : { - "type" : "string" - } - } - } - }, - "AffectedComponentEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "component" : { - "$ref" : "#/definitions/AffectedComponentDTO" - }, - "processGroup" : { - "description" : "The Process Group that the component belongs to", - "$ref" : "#/definitions/ProcessGroupNameDTO" - }, - "referenceType" : { - "type" : "string", - "description" : "The type of component referenced", - "enum" : [ "PROCESSOR", "CONTROLLER_SERVICE", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT" ] - } - }, - "xml" : { - "name" : "affectedComponentEntity" - } - }, - "AllowableValueDTO" : { - "type" : "object", - "properties" : { - "displayName" : { - "type" : "string", - "description" : "A human readable value that is allowed for the property descriptor." - }, - "value" : { - "type" : "string", - "description" : "A value that is allowed for the property descriptor." - }, - "description" : { - "type" : "string", - "description" : "A description for this allowable value." - } - } - }, - "AllowableValueEntity" : { - "type" : "object", - "properties" : { - "allowableValue" : { - "$ref" : "#/definitions/AllowableValueDTO" - }, - "canRead" : { - "type" : "boolean", - "description" : "Indicates whether the user can read a given resource." - } - }, - "xml" : { - "name" : "entity" - } - }, - "AttributeDTO" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The attribute name." - }, - "value" : { - "type" : "string", - "description" : "The attribute value." - }, - "previousValue" : { - "type" : "string", - "description" : "The value of the attribute before the event took place." - } - } - }, - "BannerDTO" : { - "type" : "object", - "properties" : { - "headerText" : { - "type" : "string", - "description" : "The header text." - }, - "footerText" : { - "type" : "string", - "description" : "The footer text." - } - } - }, - "BannerEntity" : { - "type" : "object", - "properties" : { - "banners" : { - "$ref" : "#/definitions/BannerDTO" - } - }, - "xml" : { - "name" : "bannersEntity" - } - }, - "BatchSettingsDTO" : { - "type" : "object", - "properties" : { - "count" : { - "type" : "integer", - "format" : "int32", - "description" : "Preferred number of flow files to include in a transaction." - }, - "size" : { - "type" : "string", - "description" : "Preferred number of bytes to include in a transaction." - }, - "duration" : { - "type" : "string", - "description" : "Preferred amount of time that a transaction should span." - } - } - }, - "BatchSize" : { - "type" : "object", - "properties" : { - "count" : { - "type" : "integer", - "format" : "int32", - "description" : "Preferred number of flow files to include in a transaction." - }, - "size" : { - "type" : "string", - "description" : "Preferred number of bytes to include in a transaction." - }, - "duration" : { - "type" : "string", - "description" : "Preferred amount of time that a transaction should span." - } - } - }, - "Bucket" : { - "type" : "object", - "required" : [ "name" ], - "properties" : { - "link" : { - "description" : "An WebLink to this entity.", - "readOnly" : true, - "$ref" : "#/definitions/JaxbLink" - }, - "identifier" : { - "type" : "string", - "description" : "An ID to uniquely identify this object.", - "readOnly" : true - }, - "name" : { - "type" : "string", - "description" : "The name of the bucket." - }, - "createdTimestamp" : { - "type" : "integer", - "format" : "int64", - "description" : "The timestamp of when the bucket was first created. This is set by the server at creation time.", - "readOnly" : true, - "minimum" : 1 - }, - "description" : { - "type" : "string", - "description" : "A description of the bucket." - }, - "allowBundleRedeploy" : { - "type" : "boolean", - "description" : "Indicates if this bucket allows the same version of an extension bundle to be redeployed and thus overwrite the existing artifact. By default this is false." - }, - "allowPublicRead" : { - "type" : "boolean", - "description" : "Indicates if this bucket allows read access to unauthenticated anonymous users" - }, - "permissions" : { - "description" : "The access that the current user has to this bucket.", - "readOnly" : true, - "$ref" : "#/definitions/Permissions" - }, - "revision" : { - "description" : "The revision of this entity used for optimistic-locking during updates.", - "readOnly" : true, - "$ref" : "#/definitions/RevisionInfo" - } - } - }, - "BucketDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The bucket identifier" - }, - "name" : { - "type" : "string", - "description" : "The bucket name" - }, - "description" : { - "type" : "string", - "description" : "The bucket description" - }, - "created" : { - "type" : "integer", - "format" : "int64", - "description" : "The created timestamp of this bucket" - } - } - }, - "BucketEntity" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string" - }, - "bucket" : { - "$ref" : "#/definitions/BucketDTO" - }, - "permissions" : { - "$ref" : "#/definitions/PermissionsDTO" - } - }, - "xml" : { - "name" : "bucketEntity" - } - }, - "BucketsEntity" : { - "type" : "object", - "properties" : { - "buckets" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/BucketEntity" - } - } - }, - "xml" : { - "name" : "bucketsEntity" - } - }, - "BuildInfo" : { - "type" : "object", - "properties" : { - "version" : { - "type" : "string", - "description" : "The version number of the built component." - }, - "revision" : { - "type" : "string", - "description" : "The SCM revision id of the source code used for this build." - }, - "timestamp" : { - "type" : "integer", - "format" : "int64", - "description" : "The timestamp (milliseconds since Epoch) of the build." - }, - "targetArch" : { - "type" : "string", - "description" : "The target architecture of the built component." - }, - "compiler" : { - "type" : "string", - "description" : "The compiler used for the build" - }, - "compilerFlags" : { - "type" : "string", - "description" : "The compiler flags used for the build." - } - } - }, - "BulletinBoardDTO" : { - "type" : "object", - "properties" : { - "bulletins" : { - "type" : "array", - "description" : "The bulletins in the bulletin board, that matches the supplied request.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "generated" : { - "type" : "string", - "description" : "The timestamp when this report was generated." - } - } - }, - "BulletinBoardEntity" : { - "type" : "object", - "properties" : { - "bulletinBoard" : { - "$ref" : "#/definitions/BulletinBoardDTO" - } - }, - "xml" : { - "name" : "bulletinBoardEntity" - } - }, - "BulletinDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "integer", - "format" : "int64", - "description" : "The id of the bulletin." - }, - "nodeAddress" : { - "type" : "string", - "description" : "If clustered, the address of the node from which the bulletin originated." - }, - "category" : { - "type" : "string", - "description" : "The category of this bulletin." - }, - "groupId" : { - "type" : "string", - "description" : "The group id of the source component." - }, - "sourceId" : { - "type" : "string", - "description" : "The id of the source component." - }, - "sourceName" : { - "type" : "string", - "description" : "The name of the source component." - }, - "level" : { - "type" : "string", - "description" : "The level of the bulletin." - }, - "message" : { - "type" : "string", - "description" : "The bulletin message." - }, - "timestamp" : { - "type" : "string", - "description" : "When this bulletin was generated." - } - } - }, - "BulletinEntity" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "integer", - "format" : "int64" - }, - "groupId" : { - "type" : "string" - }, - "sourceId" : { - "type" : "string" - }, - "timestamp" : { - "type" : "string", - "description" : "When this bulletin was generated." - }, - "nodeAddress" : { - "type" : "string" - }, - "canRead" : { - "type" : "boolean", - "description" : "Indicates whether the user can read a given resource." - }, - "bulletin" : { - "$ref" : "#/definitions/BulletinDTO" - } - }, - "xml" : { - "name" : "bulletinEntity" - } - }, - "Bundle" : { - "type" : "object", - "properties" : { - "group" : { - "type" : "string", - "description" : "The group of the bundle" - }, - "artifact" : { - "type" : "string", - "description" : "The artifact of the bundle" - }, - "version" : { - "type" : "string", - "description" : "The version of the bundle" - } - } - }, - "BundleDTO" : { - "type" : "object", - "properties" : { - "group" : { - "type" : "string", - "description" : "The group of the bundle." - }, - "artifact" : { - "type" : "string", - "description" : "The artifact of the bundle." - }, - "version" : { - "type" : "string", - "description" : "The version of the bundle." - } - } - }, - "ClassLoaderDiagnosticsDTO" : { - "type" : "object", - "properties" : { - "bundle" : { - "description" : "Information about the Bundle that the ClassLoader belongs to, if any", - "$ref" : "#/definitions/BundleDTO" - }, - "parentClassLoader" : { - "description" : "A ClassLoaderDiagnosticsDTO that provides information about the parent ClassLoader", - "$ref" : "#/definitions/ClassLoaderDiagnosticsDTO" - } - } - }, - "ClusteSummaryEntity" : { - "type" : "object", - "properties" : { - "clusterSummary" : { - "$ref" : "#/definitions/ClusterSummaryDTO" - } - }, - "xml" : { - "name" : "clusterSummaryEntity" - } - }, - "ClusterDTO" : { - "type" : "object", - "properties" : { - "nodes" : { - "type" : "array", - "description" : "The collection of nodes that are part of the cluster.", - "items" : { - "$ref" : "#/definitions/NodeDTO" - } - }, - "generated" : { - "type" : "string", - "description" : "The timestamp the report was generated." - } - } - }, - "ClusterEntity" : { - "type" : "object", - "properties" : { - "cluster" : { - "$ref" : "#/definitions/ClusterDTO" - } - }, - "xml" : { - "name" : "clusterEntity" - } - }, - "ClusterSearchResultsEntity" : { - "type" : "object", - "properties" : { - "nodeResults" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/NodeSearchResultDTO" - } - } - }, - "xml" : { - "name" : "clusterSearchResultsEntity" - } - }, - "ClusterSummaryDTO" : { - "type" : "object", - "properties" : { - "connectedNodes" : { - "type" : "string", - "description" : "When clustered, reports the number of nodes connected vs the number of nodes in the cluster." - }, - "connectedNodeCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of nodes that are currently connected to the cluster" - }, - "totalNodeCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of nodes in the cluster, regardless of whether or not they are connected" - }, - "clustered" : { - "type" : "boolean", - "description" : "Whether this NiFi instance is clustered." - }, - "connectedToCluster" : { - "type" : "boolean", - "description" : "Whether this NiFi instance is connected to a cluster." - } - } - }, - "ComponentDetailsDTO" : { - "type" : "object" - }, - "ComponentDifferenceDTO" : { - "type" : "object", - "properties" : { - "componentType" : { - "type" : "string", - "description" : "The type of component" - }, - "componentId" : { - "type" : "string", - "description" : "The ID of the component" - }, - "componentName" : { - "type" : "string", - "description" : "The name of the component" - }, - "processGroupId" : { - "type" : "string", - "description" : "The ID of the Process Group that the component belongs to" - }, - "differences" : { - "type" : "array", - "description" : "The differences in the component between the two flows", - "items" : { - "$ref" : "#/definitions/DifferenceDTO" - } - } - } - }, - "ComponentHistoryDTO" : { - "type" : "object", - "properties" : { - "componentId" : { - "type" : "string", - "description" : "The component id." - }, - "propertyHistory" : { - "type" : "object", - "description" : "The history for the properties of the component.", - "additionalProperties" : { - "$ref" : "#/definitions/PropertyHistoryDTO" - } - } - } - }, - "ComponentHistoryEntity" : { - "type" : "object", - "properties" : { - "componentHistory" : { - "$ref" : "#/definitions/ComponentHistoryDTO" - } - }, - "xml" : { - "name" : "componentHistoryEntity" - } - }, - "ComponentManifest" : { - "type" : "object", - "properties" : { - "apis" : { - "type" : "array", - "description" : "Public interfaces defined in this bundle", - "items" : { - "$ref" : "#/definitions/DefinedType" - } - }, - "controllerServices" : { - "type" : "array", - "description" : "Controller Services provided in this bundle", - "items" : { - "$ref" : "#/definitions/ControllerServiceDefinition" - } - }, - "processors" : { - "type" : "array", - "description" : "Processors provided in this bundle", - "items" : { - "$ref" : "#/definitions/ProcessorDefinition" - } - }, - "reportingTasks" : { - "type" : "array", - "description" : "Reporting Tasks provided in this bundle", - "items" : { - "$ref" : "#/definitions/ReportingTaskDefinition" - } - } - } - }, - "ComponentReferenceDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "versionedComponentId" : { - "type" : "string", - "description" : "The ID of the corresponding component that is under version control" - }, - "parentGroupId" : { - "type" : "string", - "description" : "The id of parent process group of this component if applicable." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "name" : { - "type" : "string", - "description" : "The name of the component." - } - } - }, - "ComponentReferenceEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "parentGroupId" : { - "type" : "string", - "description" : "The id of parent process group of this component if applicable." - }, - "component" : { - "$ref" : "#/definitions/ComponentReferenceDTO" - } - }, - "xml" : { - "name" : "componentReferenceEntity" - } - }, - "ComponentRestrictionPermissionDTO" : { - "type" : "object", - "properties" : { - "requiredPermission" : { - "description" : "The required permission necessary for this restriction.", - "$ref" : "#/definitions/RequiredPermissionDTO" - }, - "permissions" : { - "description" : "The permissions for this component restriction. Note: the read permission are not used and will always be false.", - "$ref" : "#/definitions/PermissionsDTO" - } - } - }, - "ComponentSearchResultDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component that matched the search." - }, - "groupId" : { - "type" : "string", - "description" : "The group id of the component that matched the search." - }, - "parentGroup" : { - "description" : "The parent group of the component that matched the search.", - "$ref" : "#/definitions/SearchResultGroupDTO" - }, - "versionedGroup" : { - "description" : "The nearest versioned ancestor group of the component that matched the search.", - "$ref" : "#/definitions/SearchResultGroupDTO" - }, - "name" : { - "type" : "string", - "description" : "The name of the component that matched the search." - }, - "matches" : { - "type" : "array", - "description" : "What matched the search from the component.", - "items" : { - "type" : "string" - } - } - } - }, - "ComponentStateDTO" : { - "type" : "object", - "properties" : { - "componentId" : { - "type" : "string", - "description" : "The component identifier." - }, - "stateDescription" : { - "type" : "string", - "description" : "Description of the state this component persists." - }, - "clusterState" : { - "description" : "The cluster state for this component, or null if this NiFi is a standalone instance.", - "$ref" : "#/definitions/StateMapDTO" - }, - "localState" : { - "description" : "The local state for this component.", - "$ref" : "#/definitions/StateMapDTO" - } - } - }, - "ComponentStateEntity" : { - "type" : "object", - "properties" : { - "componentState" : { - "description" : "The component state.", - "$ref" : "#/definitions/ComponentStateDTO" - } - }, - "xml" : { - "name" : "componentStateEntity" - } - }, - "ComponentValidationResultDTO" : { - "type" : "object", - "properties" : { - "processGroupId" : { - "type" : "string", - "description" : "The UUID of the Process Group that this component is in" - }, - "id" : { - "type" : "string", - "description" : "The UUID of this component" - }, - "referenceType" : { - "type" : "string", - "description" : "The type of this component", - "enum" : [ "PROCESSOR", "CONTROLLER_SERVICE", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT" ] - }, - "name" : { - "type" : "string", - "description" : "The name of this component." - }, - "state" : { - "type" : "string", - "description" : "The scheduled state of a processor or reporting task referencing a controller service. If this component is another controller service, this field represents the controller service state." - }, - "activeThreadCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of active threads for the referencing component." - }, - "validationErrors" : { - "type" : "array", - "description" : "The validation errors for the component.", - "items" : { - "type" : "string" - } - }, - "currentlyValid" : { - "type" : "boolean", - "description" : "Whether or not the component is currently valid" - }, - "resultsValid" : { - "type" : "boolean", - "description" : "Whether or not the component will be valid if the Parameter Context is changed" - }, - "resultantValidationErrors" : { - "type" : "array", - "description" : "The validation errors that will apply to the component if the Parameter Context is changed", - "items" : { - "type" : "string" - } - } - } - }, - "ComponentValidationResultEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "component" : { - "$ref" : "#/definitions/ComponentValidationResultDTO" - } - }, - "xml" : { - "name" : "componentValidationResultEntity" - } - }, - "ComponentValidationResultsEntity" : { - "type" : "object", - "properties" : { - "validationResults" : { - "type" : "array", - "description" : "A List of ComponentValidationResultEntity, one for each component that is validated", - "items" : { - "$ref" : "#/definitions/ComponentValidationResultEntity" - } - } - }, - "xml" : { - "name" : "componentValidationResults" - } - }, - "ConfigVerificationResultDTO" : { - "type" : "object", - "properties" : { - "outcome" : { - "type" : "string", - "description" : "The outcome of the verification", - "enum" : [ "SUCCESSFUL", "FAILED", "SKIPPED" ] - }, - "verificationStepName" : { - "type" : "string", - "description" : "The name of the verification step" - }, - "explanation" : { - "type" : "string", - "description" : "An explanation of why the step was or was not successful" - } - } - }, - "ConfigurationAnalysisDTO" : { - "type" : "object", - "properties" : { - "componentId" : { - "type" : "string", - "description" : "The ID of the component" - }, - "properties" : { - "type" : "object", - "description" : "The configured properties for the component", - "additionalProperties" : { - "type" : "string" - } - }, - "referencedAttributes" : { - "type" : "object", - "description" : "The attributes that are referenced by the properties, mapped to recently used values", - "additionalProperties" : { - "type" : "string" - } - }, - "supportsVerification" : { - "type" : "boolean", - "description" : "Whether or not the component supports verification" - } - } - }, - "ConfigurationAnalysisEntity" : { - "type" : "object", - "properties" : { - "configurationAnalysis" : { - "description" : "The configuration analysis", - "$ref" : "#/definitions/ConfigurationAnalysisDTO" - } - }, - "xml" : { - "name" : "configurationAnalysis" - } - }, - "ConnectableComponent" : { - "type" : "object", - "required" : [ "groupId", "id", "type" ], - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the connectable component." - }, - "type" : { - "type" : "string", - "description" : "The type of component the connectable is.", - "enum" : [ "PROCESSOR", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "INPUT_PORT", "OUTPUT_PORT", "FUNNEL" ] - }, - "groupId" : { - "type" : "string", - "description" : "The id of the group that the connectable component resides in" - }, - "name" : { - "type" : "string", - "description" : "The name of the connectable component" - }, - "comments" : { - "type" : "string", - "description" : "The comments for the connectable component." - }, - "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" - } - } - }, - "ConnectableDTO" : { - "type" : "object", - "required" : [ "groupId", "id", "type" ], - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the connectable component." - }, - "versionedComponentId" : { - "type" : "string", - "description" : "The ID of the corresponding component that is under version control" - }, - "type" : { - "type" : "string", - "description" : "The type of component the connectable is.", - "enum" : [ "PROCESSOR", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "INPUT_PORT", "OUTPUT_PORT", "FUNNEL" ] - }, - "groupId" : { - "type" : "string", - "description" : "The id of the group that the connectable component resides in" - }, - "name" : { - "type" : "string", - "description" : "The name of the connectable component" - }, - "running" : { - "type" : "boolean", - "description" : "Reflects the current state of the connectable component." - }, - "transmitting" : { - "type" : "boolean", - "description" : "If the connectable component represents a remote port, indicates if the target is configured to transmit." - }, - "exists" : { - "type" : "boolean", - "description" : "If the connectable component represents a remote port, indicates if the target exists." - }, - "comments" : { - "type" : "string", - "description" : "The comments for the connectable component." - } - } - }, - "ConnectionDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "versionedComponentId" : { - "type" : "string", - "description" : "The ID of the corresponding component that is under version control" - }, - "parentGroupId" : { - "type" : "string", - "description" : "The id of parent process group of this component if applicable." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "source" : { - "description" : "The source of the connection.", - "$ref" : "#/definitions/ConnectableDTO" - }, - "destination" : { - "description" : "The destination of the connection.", - "$ref" : "#/definitions/ConnectableDTO" - }, - "name" : { - "type" : "string", - "description" : "The name of the connection." - }, - "labelIndex" : { - "type" : "integer", - "format" : "int32", - "description" : "The index of the bend point where to place the connection label." - }, - "getzIndex" : { - "type" : "integer", - "format" : "int64", - "description" : "The z index of the connection." - }, - "selectedRelationships" : { - "type" : "array", - "description" : "The selected relationship that comprise the connection.", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - }, - "availableRelationships" : { - "type" : "array", - "description" : "The relationships that the source of the connection currently supports.", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - }, - "backPressureObjectThreshold" : { - "type" : "integer", - "format" : "int64", - "description" : "The object count threshold for determining when back pressure is applied. Updating this value is a passive change in the sense that it won't impact whether existing files over the limit are affected but it does help feeder processors to stop pushing too much into this work queue." - }, - "backPressureDataSizeThreshold" : { - "type" : "string", - "description" : "The object data size threshold for determining when back pressure is applied. Updating this value is a passive change in the sense that it won't impact whether existing files over the limit are affected but it does help feeder processors to stop pushing too much into this work queue." - }, - "flowFileExpiration" : { - "type" : "string", - "description" : "The amount of time a flow file may be in the flow before it will be automatically aged out of the flow. Once a flow file reaches this age it will be terminated from the flow the next time a processor attempts to start work on it." - }, - "prioritizers" : { - "type" : "array", - "description" : "The comparators used to prioritize the queue.", - "items" : { - "type" : "string" - } - }, - "bends" : { - "type" : "array", - "description" : "The bend points on the connection.", - "items" : { - "$ref" : "#/definitions/PositionDTO" - } - }, - "loadBalanceStrategy" : { - "type" : "string", - "description" : "How to load balance the data in this Connection across the nodes in the cluster.", - "enum" : [ "DO_NOT_LOAD_BALANCE", "PARTITION_BY_ATTRIBUTE", "ROUND_ROBIN", "SINGLE_NODE" ] - }, - "loadBalancePartitionAttribute" : { - "type" : "string", - "description" : "The FlowFile Attribute to use for determining which node a FlowFile will go to if the Load Balancing Strategy is set to PARTITION_BY_ATTRIBUTE" - }, - "loadBalanceCompression" : { - "type" : "string", - "description" : "Whether or not data should be compressed when being transferred between nodes in the cluster.", - "enum" : [ "DO_NOT_COMPRESS", "COMPRESS_ATTRIBUTES_ONLY", "COMPRESS_ATTRIBUTES_AND_CONTENT" ] - }, - "loadBalanceStatus" : { - "type" : "string", - "description" : "The current status of the Connection's Load Balancing Activities. Status can indicate that Load Balancing is not configured for the connection, that Load Balancing is configured but inactive (not currently transferring data to another node), or that Load Balancing is configured and actively transferring data to another node.", - "enum" : [ "LOAD_BALANCE_NOT_CONFIGURED", "LOAD_BALANCE_INACTIVE", "LOAD_BALANCE_ACTIVE" ] - } - } - }, - "ConnectionDiagnosticsDTO" : { - "type" : "object", - "properties" : { - "connection" : { - "description" : "Details about the connection", - "$ref" : "#/definitions/ConnectionDTO" - }, - "aggregateSnapshot" : { - "description" : "Aggregate values for all nodes in the cluster, or for this instance if not clustered", - "$ref" : "#/definitions/ConnectionDiagnosticsSnapshotDTO" - }, - "nodeSnapshots" : { - "type" : "array", - "description" : "A list of values for each node in the cluster, if clustered.", - "items" : { - "$ref" : "#/definitions/ConnectionDiagnosticsSnapshotDTO" - } - } - } - }, - "ConnectionDiagnosticsSnapshotDTO" : { - "type" : "object", - "properties" : { - "totalFlowFileCount" : { - "type" : "integer", - "format" : "int32", - "description" : "Total number of FlowFiles owned by the Connection" - }, - "totalByteCount" : { - "type" : "integer", - "format" : "int64", - "description" : "Total number of bytes that make up the content for the FlowFiles owned by this Connection" - }, - "nodeIdentifier" : { - "type" : "string", - "description" : "The Node Identifier that this information pertains to" - }, - "localQueuePartition" : { - "description" : "The local queue partition, from which components can pull FlowFiles on this node.", - "$ref" : "#/definitions/LocalQueuePartitionDTO" - }, - "remoteQueuePartitions" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/RemoteQueuePartitionDTO" - } - } - } - }, - "ConnectionEntity" : { - "type" : "object", - "required" : [ "destinationType", "sourceType" ], - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "component" : { - "$ref" : "#/definitions/ConnectionDTO" - }, - "status" : { - "description" : "The status of the connection.", - "$ref" : "#/definitions/ConnectionStatusDTO" - }, - "bends" : { - "type" : "array", - "description" : "The bend points on the connection.", - "items" : { - "$ref" : "#/definitions/PositionDTO" - } - }, - "labelIndex" : { - "type" : "integer", - "format" : "int32", - "description" : "The index of the bend point where to place the connection label." - }, - "getzIndex" : { - "type" : "integer", - "format" : "int64", - "description" : "The z index of the connection." - }, - "sourceId" : { - "type" : "string", - "description" : "The identifier of the source of this connection." - }, - "sourceGroupId" : { - "type" : "string", - "description" : "The identifier of the group of the source of this connection." - }, - "sourceType" : { - "type" : "string", - "description" : "The type of component the source connectable is.", - "enum" : [ "PROCESSOR", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "INPUT_PORT", "OUTPUT_PORT", "FUNNEL" ] - }, - "destinationId" : { - "type" : "string", - "description" : "The identifier of the destination of this connection." - }, - "destinationGroupId" : { - "type" : "string", - "description" : "The identifier of the group of the destination of this connection." - }, - "destinationType" : { - "type" : "string", - "description" : "The type of component the destination connectable is.", - "enum" : [ "PROCESSOR", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "INPUT_PORT", "OUTPUT_PORT", "FUNNEL" ] - } - }, - "xml" : { - "name" : "connectionEntity" - } - }, - "ConnectionStatisticsDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The ID of the connection" - }, - "statsLastRefreshed" : { - "type" : "string", - "description" : "The timestamp of when the stats were last refreshed" - }, - "aggregateSnapshot" : { - "description" : "The status snapshot that represents the aggregate stats of the cluster", - "$ref" : "#/definitions/ConnectionStatisticsSnapshotDTO" - }, - "nodeSnapshots" : { - "type" : "array", - "description" : "A list of status snapshots for each node", - "items" : { - "$ref" : "#/definitions/NodeConnectionStatisticsSnapshotDTO" - } - } - } - }, - "ConnectionStatisticsEntity" : { - "type" : "object", - "properties" : { - "connectionStatistics" : { - "$ref" : "#/definitions/ConnectionStatisticsDTO" - }, - "canRead" : { - "type" : "boolean", - "description" : "Indicates whether the user can read a given resource." - } - }, - "xml" : { - "name" : "connectionStatisticsEntity" - } - }, - "ConnectionStatisticsSnapshotDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the connection." - }, - "predictedMillisUntilCountBackpressure" : { - "type" : "integer", - "format" : "int64", - "description" : "The predicted number of milliseconds before the connection will have backpressure applied, based on the queued count." - }, - "predictedMillisUntilBytesBackpressure" : { - "type" : "integer", - "format" : "int64", - "description" : "The predicted number of milliseconds before the connection will have backpressure applied, based on the total number of bytes in the queue." - }, - "predictedCountAtNextInterval" : { - "type" : "integer", - "format" : "int32", - "description" : "The predicted number of queued objects at the next configured interval." - }, - "predictedBytesAtNextInterval" : { - "type" : "integer", - "format" : "int64", - "description" : "The predicted total number of bytes in the queue at the next configured interval." - }, - "predictedPercentCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The predicted percentage of queued objects at the next configured interval." - }, - "predictedPercentBytes" : { - "type" : "integer", - "format" : "int32", - "description" : "The predicted percentage of bytes in the queue against current threshold at the next configured interval." - }, - "predictionIntervalMillis" : { - "type" : "integer", - "format" : "int64", - "description" : "The prediction interval in seconds" - } - } - }, - "ConnectionStatusDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The ID of the connection" - }, - "groupId" : { - "type" : "string", - "description" : "The ID of the Process Group that the connection belongs to" - }, - "name" : { - "type" : "string", - "description" : "The name of the connection" - }, - "statsLastRefreshed" : { - "type" : "string", - "description" : "The timestamp of when the stats were last refreshed" - }, - "sourceId" : { - "type" : "string", - "description" : "The ID of the source component" - }, - "sourceName" : { - "type" : "string", - "description" : "The name of the source component" - }, - "destinationId" : { - "type" : "string", - "description" : "The ID of the destination component" - }, - "destinationName" : { - "type" : "string", - "description" : "The name of the destination component" - }, - "aggregateSnapshot" : { - "description" : "The status snapshot that represents the aggregate stats of the cluster", - "$ref" : "#/definitions/ConnectionStatusSnapshotDTO" - }, - "nodeSnapshots" : { - "type" : "array", - "description" : "A list of status snapshots for each node", - "items" : { - "$ref" : "#/definitions/NodeConnectionStatusSnapshotDTO" - } - } - } - }, - "ConnectionStatusEntity" : { - "type" : "object", - "properties" : { - "connectionStatus" : { - "$ref" : "#/definitions/ConnectionStatusDTO" - }, - "canRead" : { - "type" : "boolean", - "description" : "Indicates whether the user can read a given resource." - } - }, - "xml" : { - "name" : "connectionStatusEntity" - } - }, - "ConnectionStatusPredictionsSnapshotDTO" : { - "type" : "object", - "properties" : { - "predictedMillisUntilCountBackpressure" : { - "type" : "integer", - "format" : "int64", - "description" : "The predicted number of milliseconds before the connection will have backpressure applied, based on the queued count." - }, - "predictedMillisUntilBytesBackpressure" : { - "type" : "integer", - "format" : "int64", - "description" : "The predicted number of milliseconds before the connection will have backpressure applied, based on the total number of bytes in the queue." - }, - "predictionIntervalSeconds" : { - "type" : "integer", - "format" : "int32", - "description" : "The configured interval (in seconds) for predicting connection queue count and size (and percent usage)." - }, - "predictedCountAtNextInterval" : { - "type" : "integer", - "format" : "int32", - "description" : "The predicted number of queued objects at the next configured interval." - }, - "predictedBytesAtNextInterval" : { - "type" : "integer", - "format" : "int64", - "description" : "The predicted total number of bytes in the queue at the next configured interval." - }, - "predictedPercentCount" : { - "type" : "integer", - "format" : "int32", - "description" : "Predicted connection percent use regarding queued flow files count and backpressure threshold if configured." - }, - "predictedPercentBytes" : { - "type" : "integer", - "format" : "int32", - "description" : "Predicted connection percent use regarding queued flow files size and backpressure threshold if configured." - } - } - }, - "ConnectionStatusSnapshotDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the connection." - }, - "groupId" : { - "type" : "string", - "description" : "The id of the process group the connection belongs to." - }, - "name" : { - "type" : "string", - "description" : "The name of the connection." - }, - "sourceId" : { - "type" : "string", - "description" : "The id of the source of the connection." - }, - "sourceName" : { - "type" : "string", - "description" : "The name of the source of the connection." - }, - "destinationId" : { - "type" : "string", - "description" : "The id of the destination of the connection." - }, - "destinationName" : { - "type" : "string", - "description" : "The name of the destination of the connection." - }, - "predictions" : { - "description" : "Predictions, if available, for this connection (null if not available)", - "$ref" : "#/definitions/ConnectionStatusPredictionsSnapshotDTO" - }, - "flowFilesIn" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of FlowFiles that have come into the connection in the last 5 minutes." - }, - "bytesIn" : { - "type" : "integer", - "format" : "int64", - "description" : "The size of the FlowFiles that have come into the connection in the last 5 minutes." - }, - "input" : { - "type" : "string", - "description" : "The input count/size for the connection in the last 5 minutes, pretty printed." - }, - "flowFilesOut" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of FlowFiles that have left the connection in the last 5 minutes." - }, - "bytesOut" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes that have left the connection in the last 5 minutes." - }, - "output" : { - "type" : "string", - "description" : "The output count/sie for the connection in the last 5 minutes, pretty printed." - }, - "flowFilesQueued" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of FlowFiles that are currently queued in the connection." - }, - "bytesQueued" : { - "type" : "integer", - "format" : "int64", - "description" : "The size of the FlowFiles that are currently queued in the connection." - }, - "queued" : { - "type" : "string", - "description" : "The total count and size of queued flowfiles formatted." - }, - "queuedSize" : { - "type" : "string", - "description" : "The total size of flowfiles that are queued formatted." - }, - "queuedCount" : { - "type" : "string", - "description" : "The number of flowfiles that are queued, pretty printed." - }, - "percentUseCount" : { - "type" : "integer", - "format" : "int32", - "description" : "Connection percent use regarding queued flow files count and backpressure threshold if configured." - }, - "percentUseBytes" : { - "type" : "integer", - "format" : "int32", - "description" : "Connection percent use regarding queued flow files size and backpressure threshold if configured." - }, - "flowFileAvailability" : { - "type" : "string", - "description" : "The availability of FlowFiles in this connection" - } - } - }, - "ConnectionStatusSnapshotEntity" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the connection." - }, - "connectionStatusSnapshot" : { - "$ref" : "#/definitions/ConnectionStatusSnapshotDTO" - }, - "canRead" : { - "type" : "boolean", - "description" : "Indicates whether the user can read a given resource." - } - }, - "xml" : { - "name" : "entity" - } - }, - "ConnectionsEntity" : { - "type" : "object", - "properties" : { - "connections" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ConnectionEntity" - } - } - }, - "xml" : { - "name" : "connectionsEntity" - } - }, - "ControllerBulletinsEntity" : { - "type" : "object", - "properties" : { - "bulletins" : { - "type" : "array", - "description" : "System level bulletins to be reported to the user.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "controllerServiceBulletins" : { - "type" : "array", - "description" : "Controller service bulletins to be reported to the user.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "reportingTaskBulletins" : { - "type" : "array", - "description" : "Reporting task bulletins to be reported to the user.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - } - }, - "xml" : { - "name" : "controllerConfigurationEntity" - } - }, - "ControllerConfigurationDTO" : { - "type" : "object", - "properties" : { - "maxTimerDrivenThreadCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The maximum number of timer driven threads the NiFi has available." - }, - "maxEventDrivenThreadCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The maximum number of event driven threads the NiFi has available." - } - } - }, - "ControllerConfigurationEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "component" : { - "description" : "The controller configuration.", - "$ref" : "#/definitions/ControllerConfigurationDTO" - } - }, - "xml" : { - "name" : "controllerConfigurationEntity" - } - }, - "ControllerDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the NiFi." - }, - "name" : { - "type" : "string", - "description" : "The name of the NiFi." - }, - "comments" : { - "type" : "string", - "description" : "The comments for the NiFi." - }, - "runningCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of running components in the NiFi." - }, - "stoppedCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of stopped components in the NiFi." - }, - "invalidCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of invalid components in the NiFi." - }, - "disabledCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of disabled components in the NiFi." - }, - "activeRemotePortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of active remote ports contained in the NiFi." - }, - "inactiveRemotePortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of inactive remote ports contained in the NiFi." - }, - "inputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of input ports contained in the NiFi." - }, - "outputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of output ports in the NiFi." - }, - "remoteSiteListeningPort" : { - "type" : "integer", - "format" : "int32", - "description" : "The Socket Port on which this instance is listening for Remote Transfers of Flow Files. If this instance is not configured to receive Flow Files from remote instances, this will be null." - }, - "remoteSiteHttpListeningPort" : { - "type" : "integer", - "format" : "int32", - "description" : "The HTTP(S) Port on which this instance is listening for Remote Transfers of Flow Files. If this instance is not configured to receive Flow Files from remote instances, this will be null." - }, - "siteToSiteSecure" : { - "type" : "boolean", - "description" : "Indicates whether or not Site-to-Site communications with this instance is secure (2-way authentication)." - }, - "instanceId" : { - "type" : "string", - "description" : "If clustered, the id of the Cluster Manager, otherwise the id of the NiFi." - }, - "inputPorts" : { - "type" : "array", - "description" : "The input ports available to send data to for the NiFi.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/PortDTO" - } - }, - "outputPorts" : { - "type" : "array", - "description" : "The output ports available to received data from the NiFi.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/PortDTO" - } - } - } - }, - "ControllerEntity" : { - "type" : "object", - "properties" : { - "controller" : { - "$ref" : "#/definitions/ControllerDTO" - } - }, - "xml" : { - "name" : "controllerEntity" - } - }, - "ControllerServiceAPI" : { - "type" : "object", - "properties" : { - "type" : { - "type" : "string", - "description" : "The fully qualified name of the service interface." - }, - "bundle" : { - "description" : "The details of the artifact that bundled this service interface.", - "$ref" : "#/definitions/Bundle" - } - } - }, - "ControllerServiceApiDTO" : { - "type" : "object", - "properties" : { - "type" : { - "type" : "string", - "description" : "The fully qualified name of the service interface." - }, - "bundle" : { - "description" : "The details of the artifact that bundled this service interface.", - "$ref" : "#/definitions/BundleDTO" - } - } - }, - "ControllerServiceDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "versionedComponentId" : { - "type" : "string", - "description" : "The ID of the corresponding component that is under version control" - }, - "parentGroupId" : { - "type" : "string", - "description" : "The id of parent process group of this component if applicable." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "name" : { - "type" : "string", - "description" : "The name of the controller service." - }, - "type" : { - "type" : "string", - "description" : "The type of the controller service." - }, - "bundle" : { - "description" : "The details of the artifact that bundled this processor type.", - "$ref" : "#/definitions/BundleDTO" - }, - "controllerServiceApis" : { - "type" : "array", - "description" : "Lists the APIs this Controller Service implements.", - "items" : { - "$ref" : "#/definitions/ControllerServiceApiDTO" - } - }, - "comments" : { - "type" : "string", - "description" : "The comments for the controller service." - }, - "state" : { - "type" : "string", - "description" : "The state of the controller service.", - "enum" : [ "ENABLED", "ENABLING", "DISABLED", "DISABLING" ] - }, - "persistsState" : { - "type" : "boolean", - "description" : "Whether the controller service persists state." - }, - "restricted" : { - "type" : "boolean", - "description" : "Whether the controller service requires elevated privileges." - }, - "deprecated" : { - "type" : "boolean", - "description" : "Whether the ontroller service has been deprecated." - }, - "multipleVersionsAvailable" : { - "type" : "boolean", - "description" : "Whether the controller service has multiple versions available." - }, - "supportsSensitiveDynamicProperties" : { - "type" : "boolean", - "description" : "Whether the controller service supports sensitive dynamic properties." - }, - "properties" : { - "type" : "object", - "description" : "The properties of the controller service.", - "additionalProperties" : { - "type" : "string" - } - }, - "descriptors" : { - "type" : "object", - "description" : "The descriptors for the controller service properties.", - "additionalProperties" : { - "$ref" : "#/definitions/PropertyDescriptorDTO" - } - }, - "sensitiveDynamicPropertyNames" : { - "type" : "array", - "description" : "Set of sensitive dynamic property names", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - }, - "customUiUrl" : { - "type" : "string", - "description" : "The URL for the controller services custom configuration UI if applicable." - }, - "annotationData" : { - "type" : "string", - "description" : "The annotation for the controller service. This is how the custom UI relays configuration to the controller service." - }, - "referencingComponents" : { - "type" : "array", - "description" : "All components referencing this controller service.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ControllerServiceReferencingComponentEntity" - } - }, - "validationErrors" : { - "type" : "array", - "description" : "The validation errors from the controller service. These validation errors represent the problems with the controller service that must be resolved before it can be enabled.", - "items" : { - "type" : "string" - } - }, - "validationStatus" : { - "type" : "string", - "description" : "Indicates whether the ControllerService is valid, invalid, or still in the process of validating (i.e., it is unknown whether or not the ControllerService is valid)", - "enum" : [ "VALID", "INVALID", "VALIDATING" ] - }, - "bulletinLevel" : { - "type" : "string", - "description" : "The level at which the controller service will report bulletins." - }, - "extensionMissing" : { - "type" : "boolean", - "description" : "Whether the underlying extension is missing." - } - } - }, - "ControllerServiceDefinition" : { - "type" : "object", - "required" : [ "type" ], - "properties" : { - "group" : { - "type" : "string", - "description" : "The group name of the bundle that provides the referenced type." - }, - "artifact" : { - "type" : "string", - "description" : "The artifact name of the bundle that provides the referenced type." - }, - "version" : { - "type" : "string", - "description" : "The version 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." - }, - "buildInfo" : { - "description" : "The build metadata for this component", - "$ref" : "#/definitions/BuildInfo" - }, - "providedApiImplementations" : { - "type" : "array", - "description" : "If this type represents a provider for an interface, this lists the APIs it implements", - "items" : { - "$ref" : "#/definitions/DefinedType" - } - }, - "tags" : { - "type" : "array", - "description" : "The tags associated with this type", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - }, - "deprecated" : { - "type" : "boolean", - "description" : "Whether or not the component has been deprecated" - }, - "deprecationReason" : { - "type" : "string", - "description" : "If this component has been deprecated, this optional field can be used to provide an explanation" - }, - "restricted" : { - "type" : "boolean", - "description" : "Whether or not the component has a general restriction" - }, - "restrictedExplanation" : { - "type" : "string", - "description" : "An optional description of the general restriction" - }, - "explicitRestrictions" : { - "type" : "array", - "description" : "Explicit restrictions that indicate a require permission to use the component", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/Restriction" - } - }, - "propertyDescriptors" : { - "type" : "object", - "description" : "Descriptions of configuration properties applicable to this component.", - "additionalProperties" : { - "$ref" : "#/definitions/PropertyDescriptor" - } - }, - "supportsDynamicProperties" : { - "type" : "boolean", - "description" : "Whether or not this component makes use of dynamic (user-set) properties." - } - } - }, - "ControllerServiceDiagnosticsDTO" : { - "type" : "object", - "properties" : { - "controllerService" : { - "description" : "The Controller Service", - "$ref" : "#/definitions/ControllerServiceEntity" - }, - "classLoaderDiagnostics" : { - "description" : "Information about the Controller Service's Class Loader", - "$ref" : "#/definitions/ClassLoaderDiagnosticsDTO" - } - } - }, - "ControllerServiceEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "parentGroupId" : { - "type" : "string", - "description" : "The id of parent process group of this ControllerService." - }, - "component" : { - "$ref" : "#/definitions/ControllerServiceDTO" - }, - "operatePermissions" : { - "description" : "The permissions for this component operations.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "status" : { - "description" : "The status for this ControllerService.", - "$ref" : "#/definitions/ControllerServiceStatusDTO" - } - }, - "xml" : { - "name" : "controllerServiceEntity" - } - }, - "ControllerServiceReferencingComponentDTO" : { - "type" : "object", - "properties" : { - "groupId" : { - "type" : "string", - "description" : "The group id for the component referencing a controller service. If this component is another controller service or a reporting task, this field is blank." - }, - "id" : { - "type" : "string", - "description" : "The id of the component referencing a controller service." - }, - "name" : { - "type" : "string", - "description" : "The name of the component referencing a controller service." - }, - "type" : { - "type" : "string", - "description" : "The type of the component referencing a controller service in simple Java class name format without package name." - }, - "state" : { - "type" : "string", - "description" : "The scheduled state of a processor or reporting task referencing a controller service. If this component is another controller service, this field represents the controller service state." - }, - "properties" : { - "type" : "object", - "description" : "The properties for the component.", - "additionalProperties" : { - "type" : "string" - } - }, - "descriptors" : { - "type" : "object", - "description" : "The descriptors for the component properties.", - "additionalProperties" : { - "$ref" : "#/definitions/PropertyDescriptorDTO" - } - }, - "validationErrors" : { - "type" : "array", - "description" : "The validation errors for the component.", - "items" : { - "type" : "string" - } - }, - "referenceType" : { - "type" : "string", - "description" : "The type of reference this is.", - "enum" : [ "Processor", "ControllerService", "ReportingTask" ] - }, - "activeThreadCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of active threads for the referencing component." - }, - "referenceCycle" : { - "type" : "boolean", - "description" : "If the referencing component represents a controller service, this indicates whether it has already been represented in this hierarchy." - }, - "referencingComponents" : { - "type" : "array", - "description" : "If the referencing component represents a controller service, these are the components that reference it.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ControllerServiceReferencingComponentEntity" - } - } - } - }, - "ControllerServiceReferencingComponentEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "component" : { - "$ref" : "#/definitions/ControllerServiceReferencingComponentDTO" - }, - "operatePermissions" : { - "description" : "The permissions for this component operations.", - "$ref" : "#/definitions/PermissionsDTO" - } - }, - "xml" : { - "name" : "controllerServiceReferencingComponentEntity" - } - }, - "ControllerServiceReferencingComponentsEntity" : { - "type" : "object", - "properties" : { - "controllerServiceReferencingComponents" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ControllerServiceReferencingComponentEntity" - } - } - }, - "xml" : { - "name" : "controllerServiceReferencingComponentsEntity" - } - }, - "ControllerServiceRunStatusEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "state" : { - "type" : "string", - "description" : "The run status of the ControllerService.", - "enum" : [ "ENABLED", "DISABLED" ] - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "uiOnly" : { - "type" : "boolean", - "description" : "Indicates whether or not responses should only include fields necessary for rendering the NiFi User Interface. As such, when this value is set to true, some fields may be returned as null values, and the selected fields may change at any time without notice. As a result, this value should not be set to true by any client other than the UI." - } - }, - "xml" : { - "name" : "entity" - } - }, - "ControllerServiceStatusDTO" : { - "type" : "object", - "properties" : { - "runStatus" : { - "type" : "string", - "description" : "The run status of this ControllerService", - "enum" : [ "ENABLED", "ENABLING", "DISABLED", "DISABLING" ] - }, - "validationStatus" : { - "type" : "string", - "description" : "Indicates whether the component is valid, invalid, or still in the process of validating (i.e., it is unknown whether or not the component is valid)", - "enum" : [ "VALID", "INVALID", "VALIDATING" ] - }, - "activeThreadCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of active threads for the component." - } - } - }, - "ControllerServiceTypesEntity" : { - "type" : "object", - "properties" : { - "controllerServiceTypes" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/DocumentedTypeDTO" - } - } - }, - "xml" : { - "name" : "controllerServiceTypesEntity" - } - }, - "ControllerServicesEntity" : { - "type" : "object", - "properties" : { - "currentTime" : { - "type" : "string", - "description" : "The current time on the system." - }, - "controllerServices" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ControllerServiceEntity" - } - } - }, - "xml" : { - "name" : "controllerServicesEntity" - } - }, - "ControllerStatusDTO" : { - "type" : "object", - "properties" : { - "activeThreadCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of active threads in the NiFi." - }, - "terminatedThreadCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of terminated threads in the NiFi." - }, - "queued" : { - "type" : "string", - "description" : "The number of flowfiles queued in the NiFi." - }, - "flowFilesQueued" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of FlowFiles queued across the entire flow" - }, - "bytesQueued" : { - "type" : "integer", - "format" : "int64", - "description" : "The size of the FlowFiles queued across the entire flow" - }, - "runningCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of running components in the NiFi." - }, - "stoppedCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of stopped components in the NiFi." - }, - "invalidCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of invalid components in the NiFi." - }, - "disabledCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of disabled components in the NiFi." - }, - "activeRemotePortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of active remote ports in the NiFi." - }, - "inactiveRemotePortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of inactive remote ports in the NiFi." - }, - "upToDateCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of up to date versioned process groups in the NiFi." - }, - "locallyModifiedCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of locally modified versioned process groups in the NiFi." - }, - "staleCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of stale versioned process groups in the NiFi." - }, - "locallyModifiedAndStaleCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of locally modified and stale versioned process groups in the NiFi." - }, - "syncFailureCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of versioned process groups in the NiFi that are unable to sync to a registry." - } - } - }, - "ControllerStatusEntity" : { - "type" : "object", - "properties" : { - "controllerStatus" : { - "$ref" : "#/definitions/ControllerStatusDTO" - } - }, - "xml" : { - "name" : "controllerStatusEntity" - } - }, - "CopySnippetRequestEntity" : { - "type" : "object", - "properties" : { - "snippetId" : { - "type" : "string", - "description" : "The identifier of the snippet." - }, - "originX" : { - "type" : "number", - "format" : "double", - "description" : "The x coordinate of the origin of the bounding box where the new components will be placed." - }, - "originY" : { - "type" : "number", - "format" : "double", - "description" : "The y coordinate of the origin of the bounding box where the new components will be placed." - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - } - }, - "xml" : { - "name" : "copySnippetRequestEntity" - } - }, - "CounterDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the counter." - }, - "context" : { - "type" : "string", - "description" : "The context of the counter." - }, - "name" : { - "type" : "string", - "description" : "The name of the counter." - }, - "valueCount" : { - "type" : "integer", - "format" : "int64", - "description" : "The value count." - }, - "value" : { - "type" : "string", - "description" : "The value of the counter." - } - } - }, - "CounterEntity" : { - "type" : "object", - "properties" : { - "counter" : { - "$ref" : "#/definitions/CounterDTO" - } - }, - "xml" : { - "name" : "counterEntity" - } - }, - "CountersDTO" : { - "type" : "object", - "properties" : { - "aggregateSnapshot" : { - "description" : "A Counters snapshot that represents the aggregate values of all nodes in the cluster. If the NiFi instance is a standalone instance, rather than a cluster, this represents the stats of the single instance.", - "$ref" : "#/definitions/CountersSnapshotDTO" - }, - "nodeSnapshots" : { - "type" : "array", - "description" : "A Counters snapshot for each node in the cluster. If the NiFi instance is a standalone instance, rather than a cluster, this may be null.", - "items" : { - "$ref" : "#/definitions/NodeCountersSnapshotDTO" - } - } - } - }, - "CountersEntity" : { - "type" : "object", - "properties" : { - "counters" : { - "$ref" : "#/definitions/CountersDTO" - } - }, - "xml" : { - "name" : "countersEntity" - } - }, - "CountersSnapshotDTO" : { - "type" : "object", - "properties" : { - "generated" : { - "type" : "string", - "description" : "The timestamp when the report was generated." - }, - "counters" : { - "type" : "array", - "description" : "All counters in the NiFi.", - "items" : { - "$ref" : "#/definitions/CounterDTO" - } - } - } - }, - "CreateActiveRequestEntity" : { - "type" : "object", - "properties" : { - "processGroupId" : { - "type" : "string", - "description" : "The Process Group ID that this active request will update" - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - } - }, - "xml" : { - "name" : "createActiveRequestEntity" - } - }, - "CreateTemplateRequestEntity" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The name of the template." - }, - "description" : { - "type" : "string", - "description" : "The description of the template." - }, - "snippetId" : { - "type" : "string", - "description" : "The identifier of the snippet." - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - } - }, - "xml" : { - "name" : "createTemplateRequestEntity" - } - }, - "CurrentUserEntity" : { - "type" : "object", - "properties" : { - "identity" : { - "type" : "string", - "description" : "The user identity being serialized." - }, - "anonymous" : { - "type" : "boolean", - "description" : "Whether the current user is anonymous." - }, - "provenancePermissions" : { - "description" : "Permissions for querying provenance.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "countersPermissions" : { - "description" : "Permissions for accessing counters.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "tenantsPermissions" : { - "description" : "Permissions for accessing tenants.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "controllerPermissions" : { - "description" : "Permissions for accessing the controller.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "policiesPermissions" : { - "description" : "Permissions for accessing the policies.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "systemPermissions" : { - "description" : "Permissions for accessing system.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "parameterContextPermissions" : { - "description" : "Permissions for accessing parameter contexts.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "restrictedComponentsPermissions" : { - "description" : "Permissions for accessing restricted components. Note: the read permission are not used and will always be false.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "componentRestrictionPermissions" : { - "type" : "array", - "description" : "Permissions for specific component restrictions.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ComponentRestrictionPermissionDTO" - } - }, - "canVersionFlows" : { - "type" : "boolean", - "description" : "Whether the current user can version flows." - } - }, - "xml" : { - "name" : "currentEntity" - } - }, - "DefinedType" : { - "type" : "object", - "required" : [ "type" ], - "properties" : { - "group" : { - "type" : "string", - "description" : "The group name of the bundle that provides the referenced type." - }, - "artifact" : { - "type" : "string", - "description" : "The artifact name of the bundle that provides the referenced type." - }, - "version" : { - "type" : "string", - "description" : "The version 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." - } - } - }, - "DifferenceDTO" : { - "type" : "object", - "properties" : { - "differenceType" : { - "type" : "string", - "description" : "The type of difference" - }, - "difference" : { - "type" : "string", - "description" : "Description of the difference" - } - } - }, - "DimensionsDTO" : { - "type" : "object", - "properties" : { - "width" : { - "type" : "number", - "format" : "double", - "description" : "The width of the label in pixels when at a 1:1 scale." - }, - "height" : { - "type" : "number", - "format" : "double", - "description" : "The height of the label in pixels when at a 1:1 scale." - } - } - }, - "DocumentedTypeDTO" : { - "type" : "object", - "properties" : { - "type" : { - "type" : "string", - "description" : "The fully qualified name of the type." - }, - "bundle" : { - "description" : "The details of the artifact that bundled this type.", - "$ref" : "#/definitions/BundleDTO" - }, - "controllerServiceApis" : { - "type" : "array", - "description" : "If this type represents a ControllerService, this lists the APIs it implements.", - "items" : { - "$ref" : "#/definitions/ControllerServiceApiDTO" - } - }, - "description" : { - "type" : "string", - "description" : "The description of the type." - }, - "restricted" : { - "type" : "boolean", - "description" : "Whether this type is restricted." - }, - "usageRestriction" : { - "type" : "string", - "description" : "The optional description of why the usage of this component is restricted." - }, - "explicitRestrictions" : { - "type" : "array", - "description" : "An optional collection of explicit restrictions. If specified, these explicit restrictions will be enfored.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ExplicitRestrictionDTO" - } - }, - "deprecationReason" : { - "type" : "string", - "description" : "The description of why the usage of this component is restricted." - }, - "tags" : { - "type" : "array", - "description" : "The tags associated with this type.", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - } - } - }, - "DropRequestDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id for this drop request." - }, - "uri" : { - "type" : "string", - "description" : "The URI for future requests to this drop request." - }, - "submissionTime" : { - "type" : "string", - "description" : "The timestamp when the query was submitted." - }, - "lastUpdated" : { - "type" : "string", - "description" : "The last time this drop request was updated." - }, - "percentCompleted" : { - "type" : "integer", - "format" : "int32", - "description" : "The current percent complete." - }, - "finished" : { - "type" : "boolean", - "description" : "Whether the query has finished." - }, - "failureReason" : { - "type" : "string", - "description" : "The reason, if any, that this drop request failed." - }, - "currentCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of flow files currently queued." - }, - "currentSize" : { - "type" : "integer", - "format" : "int64", - "description" : "The size of flow files currently queued in bytes." - }, - "current" : { - "type" : "string", - "description" : "The count and size of flow files currently queued." - }, - "originalCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of flow files to be dropped as a result of this request." - }, - "originalSize" : { - "type" : "integer", - "format" : "int64", - "description" : "The size of flow files to be dropped as a result of this request in bytes." - }, - "original" : { - "type" : "string", - "description" : "The count and size of flow files to be dropped as a result of this request." - }, - "droppedCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of flow files that have been dropped thus far." - }, - "droppedSize" : { - "type" : "integer", - "format" : "int64", - "description" : "The size of flow files that have been dropped thus far in bytes." - }, - "dropped" : { - "type" : "string", - "description" : "The count and size of flow files that have been dropped thus far." - }, - "state" : { - "type" : "string", - "description" : "The current state of the drop request." - } - } - }, - "DropRequestEntity" : { - "type" : "object", - "properties" : { - "dropRequest" : { - "$ref" : "#/definitions/DropRequestDTO" - } - }, - "xml" : { - "name" : "dropRequestEntity" - } - }, - "ExplicitRestrictionDTO" : { - "type" : "object", - "properties" : { - "requiredPermission" : { - "description" : "The required permission necessary for this restriction.", - "$ref" : "#/definitions/RequiredPermissionDTO" - }, - "explanation" : { - "type" : "string", - "description" : "The description of why the usage of this component is restricted for this required permission." - } - } - }, - "ExternalControllerServiceReference" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The identifier of the controller service" - }, - "name" : { - "type" : "string", - "description" : "The name of the controller service" - } - } - }, - "FlowBreadcrumbDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the group." - }, - "name" : { - "type" : "string", - "description" : "The id of the group." - }, - "versionControlInformation" : { - "description" : "The process group version control information or null if not version controlled.", - "$ref" : "#/definitions/VersionControlInformationDTO" - } - } - }, - "FlowBreadcrumbEntity" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of this ancestor ProcessGroup." - }, - "permissions" : { - "description" : "The permissions for this ancestor ProcessGroup.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "versionedFlowState" : { - "type" : "string", - "description" : "The current state of the Process Group, as it relates to the Versioned Flow", - "enum" : [ "LOCALLY_MODIFIED", "STALE", "LOCALLY_MODIFIED_AND_STALE", "UP_TO_DATE", "SYNC_FAILURE" ] - }, - "breadcrumb" : { - "description" : "This breadcrumb.", - "$ref" : "#/definitions/FlowBreadcrumbDTO" - }, - "parentBreadcrumb" : { - "description" : "The parent breadcrumb for this breadcrumb.", - "$ref" : "#/definitions/FlowBreadcrumbEntity" - } - }, - "xml" : { - "name" : "flowEntity" - } - }, - "FlowComparisonEntity" : { - "type" : "object", - "properties" : { - "componentDifferences" : { - "type" : "array", - "description" : "The list of differences for each component in the flow that is not the same between the two flows", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ComponentDifferenceDTO" - } - } - }, - "xml" : { - "name" : "flowComparisonEntity" - } - }, - "FlowConfigurationDTO" : { - "type" : "object", - "properties" : { - "supportsManagedAuthorizer" : { - "type" : "boolean", - "description" : "Whether this NiFi supports a managed authorizer. Managed authorizers can visualize users, groups, and policies in the UI." - }, - "supportsConfigurableAuthorizer" : { - "type" : "boolean", - "description" : "Whether this NiFi supports a configurable authorizer." - }, - "supportsConfigurableUsersAndGroups" : { - "type" : "boolean", - "description" : "Whether this NiFi supports configurable users and groups." - }, - "autoRefreshIntervalSeconds" : { - "type" : "integer", - "format" : "int64", - "description" : "The interval in seconds between the automatic NiFi refresh requests." - }, - "currentTime" : { - "type" : "string", - "description" : "The current time on the system." - }, - "timeOffset" : { - "type" : "integer", - "format" : "int32", - "description" : "The time offset of the system." - }, - "defaultBackPressureObjectThreshold" : { - "type" : "integer", - "format" : "int64", - "description" : "The default back pressure object threshold." - }, - "defaultBackPressureDataSizeThreshold" : { - "type" : "string", - "description" : "The default back pressure data size threshold." - } - } - }, - "FlowConfigurationEntity" : { - "type" : "object", - "properties" : { - "flowConfiguration" : { - "description" : "The controller configuration.", - "$ref" : "#/definitions/FlowConfigurationDTO" - } - }, - "xml" : { - "name" : "flowConfigurationEntity" - } - }, - "FlowDTO" : { - "type" : "object", - "properties" : { - "processGroups" : { - "type" : "array", - "description" : "The process groups in this flow.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ProcessGroupEntity" - } - }, - "remoteProcessGroups" : { - "type" : "array", - "description" : "The remote process groups in this flow.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/RemoteProcessGroupEntity" - } - }, - "processors" : { - "type" : "array", - "description" : "The processors in this flow.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ProcessorEntity" - } - }, - "inputPorts" : { - "type" : "array", - "description" : "The input ports in this flow.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/PortEntity" - } - }, - "outputPorts" : { - "type" : "array", - "description" : "The output ports in this flow.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/PortEntity" - } - }, - "connections" : { - "type" : "array", - "description" : "The connections in this flow.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ConnectionEntity" - } - }, - "labels" : { - "type" : "array", - "description" : "The labels in this flow.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/LabelEntity" - } - }, - "funnels" : { - "type" : "array", - "description" : "The funnels in this flow.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/FunnelEntity" - } - } - } - }, - "FlowEntity" : { - "type" : "object", - "properties" : { - "flow" : { - "$ref" : "#/definitions/FlowDTO" - } - }, - "xml" : { - "name" : "flowEntity" - } - }, - "FlowFileDTO" : { - "type" : "object", - "properties" : { - "uri" : { - "type" : "string", - "description" : "The URI that can be used to access this FlowFile." - }, - "uuid" : { - "type" : "string", - "description" : "The FlowFile UUID." - }, - "filename" : { - "type" : "string", - "description" : "The FlowFile filename." - }, - "position" : { - "type" : "integer", - "format" : "int32", - "description" : "The FlowFile's position in the queue." - }, - "size" : { - "type" : "integer", - "format" : "int64", - "description" : "The FlowFile file size." - }, - "queuedDuration" : { - "type" : "integer", - "format" : "int64", - "description" : "How long this FlowFile has been enqueued." - }, - "lineageDuration" : { - "type" : "integer", - "format" : "int64", - "description" : "Duration since the FlowFile's greatest ancestor entered the flow." - }, - "penaltyExpiresIn" : { - "type" : "integer", - "format" : "int64", - "description" : "How long in milliseconds until the FlowFile penalty expires." - }, - "clusterNodeId" : { - "type" : "string", - "description" : "The id of the node where this FlowFile resides." - }, - "clusterNodeAddress" : { - "type" : "string", - "description" : "The label for the node where this FlowFile resides." - }, - "attributes" : { - "type" : "object", - "description" : "The FlowFile attributes.", - "additionalProperties" : { - "type" : "string" - } - }, - "contentClaimSection" : { - "type" : "string", - "description" : "The section in which the content claim lives." - }, - "contentClaimContainer" : { - "type" : "string", - "description" : "The container in which the content claim lives." - }, - "contentClaimIdentifier" : { - "type" : "string", - "description" : "The identifier of the content claim." - }, - "contentClaimOffset" : { - "type" : "integer", - "format" : "int64", - "description" : "The offset into the content claim where the flowfile's content begins." - }, - "contentClaimFileSize" : { - "type" : "string", - "description" : "The file size of the content claim formatted." - }, - "contentClaimFileSizeBytes" : { - "type" : "integer", - "format" : "int64", - "description" : "The file size of the content claim in bytes." - }, - "penalized" : { - "type" : "boolean", - "description" : "If the FlowFile is penalized." - } - } - }, - "FlowFileEntity" : { - "type" : "object", - "properties" : { - "flowFile" : { - "$ref" : "#/definitions/FlowFileDTO" - } - }, - "xml" : { - "name" : "flowFileEntity" - } - }, - "FlowFileSummaryDTO" : { - "type" : "object", - "properties" : { - "uri" : { - "type" : "string", - "description" : "The URI that can be used to access this FlowFile." - }, - "uuid" : { - "type" : "string", - "description" : "The FlowFile UUID." - }, - "filename" : { - "type" : "string", - "description" : "The FlowFile filename." - }, - "position" : { - "type" : "integer", - "format" : "int32", - "description" : "The FlowFile's position in the queue." - }, - "size" : { - "type" : "integer", - "format" : "int64", - "description" : "The FlowFile file size." - }, - "queuedDuration" : { - "type" : "integer", - "format" : "int64", - "description" : "How long this FlowFile has been enqueued." - }, - "lineageDuration" : { - "type" : "integer", - "format" : "int64", - "description" : "Duration since the FlowFile's greatest ancestor entered the flow." - }, - "penaltyExpiresIn" : { - "type" : "integer", - "format" : "int64", - "description" : "How long in milliseconds until the FlowFile penalty expires." - }, - "clusterNodeId" : { - "type" : "string", - "description" : "The id of the node where this FlowFile resides." - }, - "clusterNodeAddress" : { - "type" : "string", - "description" : "The label for the node where this FlowFile resides." - }, - "penalized" : { - "type" : "boolean", - "description" : "If the FlowFile is penalized." - } - } - }, - "FlowSnippetDTO" : { - "type" : "object", - "properties" : { - "processGroups" : { - "type" : "array", - "description" : "The process groups in this flow snippet.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ProcessGroupDTO" - } - }, - "remoteProcessGroups" : { - "type" : "array", - "description" : "The remote process groups in this flow snippet.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/RemoteProcessGroupDTO" - } - }, - "processors" : { - "type" : "array", - "description" : "The processors in this flow snippet.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ProcessorDTO" - } - }, - "inputPorts" : { - "type" : "array", - "description" : "The input ports in this flow snippet.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/PortDTO" - } - }, - "outputPorts" : { - "type" : "array", - "description" : "The output ports in this flow snippet.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/PortDTO" - } - }, - "connections" : { - "type" : "array", - "description" : "The connections in this flow snippet.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ConnectionDTO" - } - }, - "labels" : { - "type" : "array", - "description" : "The labels in this flow snippet.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/LabelDTO" - } - }, - "funnels" : { - "type" : "array", - "description" : "The funnels in this flow snippet.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/FunnelDTO" - } - }, - "controllerServices" : { - "type" : "array", - "description" : "The controller services in this flow snippet.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ControllerServiceDTO" - } - } - } - }, - "FunnelDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "versionedComponentId" : { - "type" : "string", - "description" : "The ID of the corresponding component that is under version control" - }, - "parentGroupId" : { - "type" : "string", - "description" : "The id of parent process group of this component if applicable." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - } - } - }, - "FunnelEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "component" : { - "$ref" : "#/definitions/FunnelDTO" - } - }, - "xml" : { - "name" : "funnelEntity" - } - }, - "FunnelsEntity" : { - "type" : "object", - "properties" : { - "funnels" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/FunnelEntity" - } - } - }, - "xml" : { - "name" : "funnelsEntity" - } - }, - "GCDiagnosticsSnapshotDTO" : { - "type" : "object", - "properties" : { - "timestamp" : { - "type" : "string", - "format" : "date-time", - "description" : "The timestamp of when the Snapshot was taken" - }, - "collectionCount" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of times that Garbage Collection has occurred" - }, - "collectionMillis" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of milliseconds that the Garbage Collector spent performing Garbage Collection duties" - } - } - }, - "GarbageCollectionDTO" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The name of the garbage collector." - }, - "collectionCount" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of times garbage collection has run." - }, - "collectionTime" : { - "type" : "string", - "description" : "The total amount of time spent garbage collecting." - }, - "collectionMillis" : { - "type" : "integer", - "format" : "int64", - "description" : "The total number of milliseconds spent garbage collecting." - } - } - }, - "GarbageCollectionDiagnosticsDTO" : { - "type" : "object", - "properties" : { - "memoryManagerName" : { - "type" : "string", - "description" : "The name of the Memory Manager that this Garbage Collection information pertains to" - }, - "snapshots" : { - "type" : "array", - "description" : "A list of snapshots that have been taken to determine the health of the JVM's heap", - "items" : { - "$ref" : "#/definitions/GCDiagnosticsSnapshotDTO" - } - } - } - }, - "HistoryDTO" : { - "type" : "object", - "properties" : { - "total" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of number of actions that matched the search criteria.." - }, - "lastRefreshed" : { - "type" : "string", - "description" : "The timestamp when the report was generated." - }, - "actions" : { - "type" : "array", - "description" : "The actions.", - "items" : { - "$ref" : "#/definitions/ActionEntity" - } - } - } - }, - "HistoryEntity" : { - "type" : "object", - "properties" : { - "history" : { - "$ref" : "#/definitions/HistoryDTO" - } - }, - "xml" : { - "name" : "historyEntity" - } - }, - "InputPortsEntity" : { - "type" : "object", - "properties" : { - "inputPorts" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/PortEntity" - } - } - }, - "xml" : { - "name" : "inputPortsEntity" - } - }, - "InstantiateTemplateRequestEntity" : { - "type" : "object", - "properties" : { - "originX" : { - "type" : "number", - "format" : "double", - "description" : "The x coordinate of the origin of the bounding box where the new components will be placed." - }, - "originY" : { - "type" : "number", - "format" : "double", - "description" : "The y coordinate of the origin of the bounding box where the new components will be placed." - }, - "templateId" : { - "type" : "string", - "description" : "The identifier of the template." - }, - "encodingVersion" : { - "type" : "string", - "description" : "The encoding version of the flow snippet. If not specified, this is automatically populated by the node receiving the user request. If the snippet is specified, the version will be the latest. If the snippet is not specified, the version will come from the underlying template. These details need to be replicated throughout the cluster to ensure consistency." - }, - "snippet" : { - "description" : "A flow snippet of the template contents. If not specified, this is automatically populated by the node receiving the user request. These details need to be replicated throughout the cluster to ensure consistency.", - "$ref" : "#/definitions/FlowSnippetDTO" - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - } - }, - "xml" : { - "name" : "instantiateTemplateRequestEntity" - } - }, - "JVMControllerDiagnosticsSnapshotDTO" : { - "type" : "object", - "properties" : { - "primaryNode" : { - "type" : "boolean", - "description" : "Whether or not this node is primary node" - }, - "clusterCoordinator" : { - "type" : "boolean", - "description" : "Whether or not this node is cluster coordinator" - }, - "maxTimerDrivenThreads" : { - "type" : "integer", - "format" : "int32", - "description" : "The maximum number of timer-driven threads" - }, - "maxEventDrivenThreads" : { - "type" : "integer", - "format" : "int32", - "description" : "The maximum number of event-driven threads" - } - } - }, - "JVMDiagnosticsDTO" : { - "type" : "object", - "properties" : { - "clustered" : { - "type" : "boolean", - "description" : "Whether or not the NiFi instance is clustered" - }, - "connected" : { - "type" : "boolean", - "description" : "Whether or not the node is connected to the cluster" - }, - "aggregateSnapshot" : { - "description" : "Aggregate JVM diagnostic information about the entire cluster", - "$ref" : "#/definitions/JVMDiagnosticsSnapshotDTO" - }, - "nodeSnapshots" : { - "type" : "array", - "description" : "Node-wise breakdown of JVM diagnostic information", - "items" : { - "$ref" : "#/definitions/NodeJVMDiagnosticsSnapshotDTO" - } - } - } - }, - "JVMDiagnosticsSnapshotDTO" : { - "type" : "object", - "properties" : { - "systemDiagnosticsDto" : { - "description" : "System-related diagnostics information", - "$ref" : "#/definitions/JVMSystemDiagnosticsSnapshotDTO" - }, - "flowDiagnosticsDto" : { - "description" : "Flow-related diagnostics information", - "$ref" : "#/definitions/JVMFlowDiagnosticsSnapshotDTO" - }, - "controllerDiagnostics" : { - "description" : "Controller-related diagnostics information", - "$ref" : "#/definitions/JVMControllerDiagnosticsSnapshotDTO" - } - } - }, - "JVMFlowDiagnosticsSnapshotDTO" : { - "type" : "object", - "properties" : { - "uptime" : { - "type" : "string", - "description" : "How long this node has been running, formatted as hours:minutes:seconds.milliseconds" - }, - "timeZone" : { - "type" : "string", - "description" : "The name of the Time Zone that is configured, if available" - }, - "activeTimerDrivenThreads" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of timer-driven threads that are active" - }, - "activeEventDrivenThreads" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of event-driven threads that are active" - }, - "bundlesLoaded" : { - "type" : "array", - "description" : "The NiFi Bundles (NARs) that are loaded by NiFi", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/BundleDTO" - } - } - } - }, - "JVMSystemDiagnosticsSnapshotDTO" : { - "type" : "object", - "properties" : { - "flowFileRepositoryStorageUsage" : { - "description" : "Information about the FlowFile Repository's usage", - "$ref" : "#/definitions/RepositoryUsageDTO" - }, - "contentRepositoryStorageUsage" : { - "type" : "array", - "description" : "Information about the Content Repository's usage", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/RepositoryUsageDTO" - } - }, - "provenanceRepositoryStorageUsage" : { - "type" : "array", - "description" : "Information about the Provenance Repository's usage", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/RepositoryUsageDTO" - } - }, - "maxHeapBytes" : { - "type" : "integer", - "format" : "int64", - "description" : "The maximum number of bytes that the JVM heap is configured to use for heap" - }, - "maxHeap" : { - "type" : "string", - "description" : "The maximum number of bytes that the JVM heap is configured to use, as a human-readable value" - }, - "garbageCollectionDiagnostics" : { - "type" : "array", - "description" : "Diagnostic information about the JVM's garbage collections", - "items" : { - "$ref" : "#/definitions/GarbageCollectionDiagnosticsDTO" - } - }, - "cpuCores" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of CPU Cores available on the system" - }, - "cpuLoadAverage" : { - "type" : "number", - "format" : "double", - "description" : "The 1-minute CPU Load Average" - }, - "physicalMemoryBytes" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes of RAM available on the system" - }, - "physicalMemory" : { - "type" : "string", - "description" : "The number of bytes of RAM available on the system as a human-readable value" - }, - "openFileDescriptors" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of files that are open by the NiFi process" - }, - "maxOpenFileDescriptors" : { - "type" : "integer", - "format" : "int64", - "description" : "The maximum number of open file descriptors that are available to each process" - } - } - }, - "JaxbLink" : { - "type" : "object", - "properties" : { - "href" : { - "type" : "string", - "format" : "uri", - "xml" : { - "attribute" : true - }, - "description" : "The href for the link" - }, - "params" : { - "type" : "object", - "description" : "The params for the link", - "additionalProperties" : { - "type" : "string" - } - } - } - }, - "LabelDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "versionedComponentId" : { - "type" : "string", - "description" : "The ID of the corresponding component that is under version control" - }, - "parentGroupId" : { - "type" : "string", - "description" : "The id of parent process group of this component if applicable." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "label" : { - "type" : "string", - "description" : "The text that appears in the label." - }, - "width" : { - "type" : "number", - "format" : "double", - "description" : "The width of the label in pixels when at a 1:1 scale." - }, - "height" : { - "type" : "number", - "format" : "double", - "description" : "The height of the label in pixels when at a 1:1 scale." - }, - "getzIndex" : { - "type" : "integer", - "format" : "int64", - "description" : "The z index of the label." - }, - "style" : { - "type" : "object", - "description" : "The styles for this label (font-size : 12px, background-color : #eee, etc).", - "additionalProperties" : { - "type" : "string" - } - } - } - }, - "LabelEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "dimensions" : { - "$ref" : "#/definitions/DimensionsDTO" - }, - "getzIndex" : { - "type" : "integer", - "format" : "int64", - "description" : "The z index of the label." - }, - "component" : { - "$ref" : "#/definitions/LabelDTO" - } - }, - "xml" : { - "name" : "labelEntity" - } - }, - "LabelsEntity" : { - "type" : "object", - "properties" : { - "labels" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/LabelEntity" - } - } - }, - "xml" : { - "name" : "labelsEntity" - } - }, - "LineageDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of this lineage query." - }, - "uri" : { - "type" : "string", - "description" : "The URI for this lineage query for later retrieval and deletion." - }, - "submissionTime" : { - "type" : "string", - "description" : "When the lineage query was submitted." - }, - "expiration" : { - "type" : "string", - "description" : "When the lineage query will expire." - }, - "percentCompleted" : { - "type" : "integer", - "format" : "int32", - "description" : "The percent complete for the lineage query." - }, - "finished" : { - "type" : "boolean", - "description" : "Whether the lineage query has finished." - }, - "request" : { - "description" : "The initial lineage result.", - "$ref" : "#/definitions/LineageRequestDTO" - }, - "results" : { - "description" : "The results of the lineage query.", - "$ref" : "#/definitions/LineageResultsDTO" - } - } - }, - "LineageEntity" : { - "type" : "object", - "properties" : { - "lineage" : { - "$ref" : "#/definitions/LineageDTO" - } - }, - "xml" : { - "name" : "lineageEntity" - } - }, - "LineageRequestDTO" : { - "type" : "object", - "properties" : { - "eventId" : { - "type" : "integer", - "format" : "int64", - "description" : "The event id that was used to generate this lineage, if applicable. The event id is allowed for any type of lineageRequestType. If the lineageRequestType is FLOWFILE and the flowfile uuid is also included in the request, the event id will be ignored." - }, - "lineageRequestType" : { - "type" : "string", - "description" : "The type of lineage request. PARENTS will return the lineage for the flowfiles that are parents of the specified event. CHILDREN will return the lineage for the flowfiles that are children of the specified event. FLOWFILE will return the lineage for the specified flowfile.", - "enum" : [ "PARENTS", "CHILDREN", "and FLOWFILE" ] - }, - "uuid" : { - "type" : "string", - "description" : "The flowfile uuid that was used to generate the lineage. The flowfile uuid is only allowed when the lineageRequestType is FLOWFILE and will take precedence over event id." - }, - "clusterNodeId" : { - "type" : "string", - "description" : "The id of the node where this lineage originated if clustered." - } - } - }, - "LineageResultsDTO" : { - "type" : "object", - "properties" : { - "errors" : { - "type" : "array", - "description" : "Any errors that occurred while generating the lineage.", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - }, - "nodes" : { - "type" : "array", - "description" : "The nodes in the lineage.", - "items" : { - "$ref" : "#/definitions/ProvenanceNodeDTO" - } - }, - "links" : { - "type" : "array", - "description" : "The links between the nodes in the lineage.", - "items" : { - "$ref" : "#/definitions/ProvenanceLinkDTO" - } - } - } - }, - "ListingRequestDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id for this listing request." - }, - "uri" : { - "type" : "string", - "description" : "The URI for future requests to this listing request." - }, - "submissionTime" : { - "type" : "string", - "description" : "The timestamp when the query was submitted." - }, - "lastUpdated" : { - "type" : "string", - "description" : "The last time this listing request was updated." - }, - "percentCompleted" : { - "type" : "integer", - "format" : "int32", - "description" : "The current percent complete." - }, - "finished" : { - "type" : "boolean", - "description" : "Whether the query has finished." - }, - "failureReason" : { - "type" : "string", - "description" : "The reason, if any, that this listing request failed." - }, - "maxResults" : { - "type" : "integer", - "format" : "int32", - "description" : "The maximum number of FlowFileSummary objects to return" - }, - "state" : { - "type" : "string", - "description" : "The current state of the listing request." - }, - "queueSize" : { - "description" : "The size of the queue", - "$ref" : "#/definitions/QueueSizeDTO" - }, - "flowFileSummaries" : { - "type" : "array", - "description" : "The FlowFile summaries. The summaries will be populated once the request has completed.", - "items" : { - "$ref" : "#/definitions/FlowFileSummaryDTO" - } - }, - "sourceRunning" : { - "type" : "boolean", - "description" : "Whether the source of the connection is running" - }, - "destinationRunning" : { - "type" : "boolean", - "description" : "Whether the destination of the connection is running" - } - } - }, - "ListingRequestEntity" : { - "type" : "object", - "properties" : { - "listingRequest" : { - "$ref" : "#/definitions/ListingRequestDTO" - } - }, - "xml" : { - "name" : "listingRequestEntity" - } - }, - "LocalQueuePartitionDTO" : { - "type" : "object", - "properties" : { - "totalFlowFileCount" : { - "type" : "integer", - "format" : "int32", - "description" : "Total number of FlowFiles owned by the Connection" - }, - "totalByteCount" : { - "type" : "integer", - "format" : "int64", - "description" : "Total number of bytes that make up the content for the FlowFiles owned by this Connection" - }, - "activeQueueFlowFileCount" : { - "type" : "integer", - "format" : "int32", - "description" : "Total number of FlowFiles that exist in the Connection's Active Queue, immediately available to be offered up to a component" - }, - "activeQueueByteCount" : { - "type" : "integer", - "format" : "int64", - "description" : "Total number of bytes that make up the content for the FlowFiles that are present in the Connection's Active Queue" - }, - "swapFlowFileCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The total number of FlowFiles that are swapped out for this Connection" - }, - "swapByteCount" : { - "type" : "integer", - "format" : "int64", - "description" : "Total number of bytes that make up the content for the FlowFiles that are swapped out to disk for the Connection" - }, - "swapFiles" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of Swap Files that exist for this Connection" - }, - "inFlightFlowFileCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of In-Flight FlowFiles for this Connection. These are FlowFiles that belong to the connection but are currently being operated on by a Processor, Port, etc." - }, - "inFlightByteCount" : { - "type" : "integer", - "format" : "int64", - "description" : "The number bytes that make up the content of the FlowFiles that are In-Flight" - }, - "allActiveQueueFlowFilesPenalized" : { - "type" : "boolean", - "description" : "Whether or not all of the FlowFiles in the Active Queue are penalized" - }, - "anyActiveQueueFlowFilesPenalized" : { - "type" : "boolean", - "description" : "Whether or not any of the FlowFiles in the Active Queue are penalized" - } - } - }, - "NodeConnectionStatisticsSnapshotDTO" : { - "type" : "object", - "properties" : { - "nodeId" : { - "type" : "string", - "description" : "The unique ID that identifies the node" - }, - "address" : { - "type" : "string", - "description" : "The API address of the node" - }, - "apiPort" : { - "type" : "integer", - "format" : "int32", - "description" : "The API port used to communicate with the node" - }, - "statisticsSnapshot" : { - "description" : "The connection status snapshot from the node.", - "$ref" : "#/definitions/ConnectionStatisticsSnapshotDTO" - } - } - }, - "NodeConnectionStatusSnapshotDTO" : { - "type" : "object", - "properties" : { - "nodeId" : { - "type" : "string", - "description" : "The unique ID that identifies the node" - }, - "address" : { - "type" : "string", - "description" : "The API address of the node" - }, - "apiPort" : { - "type" : "integer", - "format" : "int32", - "description" : "The API port used to communicate with the node" - }, - "statusSnapshot" : { - "description" : "The connection status snapshot from the node.", - "$ref" : "#/definitions/ConnectionStatusSnapshotDTO" - } - } - }, - "NodeCountersSnapshotDTO" : { - "type" : "object", - "properties" : { - "nodeId" : { - "type" : "string", - "description" : "The unique ID that identifies the node" - }, - "address" : { - "type" : "string", - "description" : "The API address of the node" - }, - "apiPort" : { - "type" : "integer", - "format" : "int32", - "description" : "The API port used to communicate with the node" - }, - "snapshot" : { - "description" : "The counters from the node.", - "$ref" : "#/definitions/CountersSnapshotDTO" - } - } - }, - "NodeDTO" : { - "type" : "object", - "properties" : { - "nodeId" : { - "type" : "string", - "description" : "The id of the node." - }, - "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." - }, - "status" : { - "type" : "string", - "description" : "The node's status." - }, - "heartbeat" : { - "type" : "string", - "description" : "the time of the nodes's last heartbeat." - }, - "connectionRequested" : { - "type" : "string", - "description" : "The time of the node's last connection request." - }, - "roles" : { - "type" : "array", - "description" : "The roles of this node.", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - }, - "activeThreadCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The active threads for the NiFi on the node." - }, - "queued" : { - "type" : "string", - "description" : "The queue the NiFi on the node." - }, - "events" : { - "type" : "array", - "description" : "The node's events.", - "items" : { - "$ref" : "#/definitions/NodeEventDTO" - } - }, - "nodeStartTime" : { - "type" : "string", - "description" : "The time at which this Node was last refreshed." - } - } - }, - "NodeEntity" : { - "type" : "object", - "properties" : { - "node" : { - "$ref" : "#/definitions/NodeDTO" - } - }, - "xml" : { - "name" : "nodeEntity" - } - }, - "NodeEventDTO" : { - "type" : "object", - "properties" : { - "timestamp" : { - "type" : "string", - "description" : "The timestamp of the node event." - }, - "category" : { - "type" : "string", - "description" : "The category of the node event." - }, - "message" : { - "type" : "string", - "description" : "The message in the node event." - } - } - }, - "NodeJVMDiagnosticsSnapshotDTO" : { - "type" : "object", - "properties" : { - "nodeId" : { - "type" : "string", - "description" : "The unique ID that identifies the node" - }, - "address" : { - "type" : "string", - "description" : "The API address of the node" - }, - "apiPort" : { - "type" : "integer", - "format" : "int32", - "description" : "The API port used to communicate with the node" - }, - "snapshot" : { - "description" : "The JVM Diagnostics Snapshot", - "$ref" : "#/definitions/JVMDiagnosticsSnapshotDTO" - } - } - }, - "NodePortStatusSnapshotDTO" : { - "type" : "object", - "properties" : { - "nodeId" : { - "type" : "string", - "description" : "The unique ID that identifies the node" - }, - "address" : { - "type" : "string", - "description" : "The API address of the node" - }, - "apiPort" : { - "type" : "integer", - "format" : "int32", - "description" : "The API port used to communicate with the node" - }, - "statusSnapshot" : { - "description" : "The port status snapshot from the node.", - "$ref" : "#/definitions/PortStatusSnapshotDTO" - } - } - }, - "NodeProcessGroupStatusSnapshotDTO" : { - "type" : "object", - "properties" : { - "nodeId" : { - "type" : "string", - "description" : "The unique ID that identifies the node" - }, - "address" : { - "type" : "string", - "description" : "The API address of the node" - }, - "apiPort" : { - "type" : "integer", - "format" : "int32", - "description" : "The API port used to communicate with the node" - }, - "statusSnapshot" : { - "description" : "The process group status snapshot from the node.", - "$ref" : "#/definitions/ProcessGroupStatusSnapshotDTO" - } - } - }, - "NodeProcessorStatusSnapshotDTO" : { - "type" : "object", - "properties" : { - "nodeId" : { - "type" : "string", - "description" : "The unique ID that identifies the node" - }, - "address" : { - "type" : "string", - "description" : "The API address of the node" - }, - "apiPort" : { - "type" : "integer", - "format" : "int32", - "description" : "The API port used to communicate with the node" - }, - "statusSnapshot" : { - "description" : "The processor status snapshot from the node.", - "$ref" : "#/definitions/ProcessorStatusSnapshotDTO" - } - } - }, - "NodeRemoteProcessGroupStatusSnapshotDTO" : { - "type" : "object", - "properties" : { - "nodeId" : { - "type" : "string", - "description" : "The unique ID that identifies the node" - }, - "address" : { - "type" : "string", - "description" : "The API address of the node" - }, - "apiPort" : { - "type" : "integer", - "format" : "int32", - "description" : "The API port used to communicate with the node" - }, - "statusSnapshot" : { - "description" : "The remote process group status snapshot from the node.", - "$ref" : "#/definitions/RemoteProcessGroupStatusSnapshotDTO" - } - } - }, - "NodeSearchResultDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the node that matched the search." - }, - "address" : { - "type" : "string", - "description" : "The address of the node that matched the search." - } - } - }, - "NodeStatusSnapshotsDTO" : { - "type" : "object", - "properties" : { - "nodeId" : { - "type" : "string", - "description" : "The id of the node." - }, - "address" : { - "type" : "string", - "description" : "The node's host/ip address." - }, - "apiPort" : { - "type" : "integer", - "format" : "int32", - "description" : "The port the node is listening for API requests." - }, - "statusSnapshots" : { - "type" : "array", - "description" : "A list of StatusSnapshotDTO objects that provide the actual metric values for the component for this node.", - "items" : { - "$ref" : "#/definitions/StatusSnapshotDTO" - } - } - } - }, - "NodeSystemDiagnosticsSnapshotDTO" : { - "type" : "object", - "properties" : { - "nodeId" : { - "type" : "string", - "description" : "The unique ID that identifies the node" - }, - "address" : { - "type" : "string", - "description" : "The API address of the node" - }, - "apiPort" : { - "type" : "integer", - "format" : "int32", - "description" : "The API port used to communicate with the node" - }, - "snapshot" : { - "description" : "The System Diagnostics snapshot from the node.", - "$ref" : "#/definitions/SystemDiagnosticsSnapshotDTO" - } - } - }, - "OutputPortsEntity" : { - "type" : "object", - "properties" : { - "outputPorts" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/PortEntity" - } - } - }, - "xml" : { - "name" : "outputPortsEntity" - } - }, - "ParameterContextDTO" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The Name of the Parameter Context." - }, - "description" : { - "type" : "string", - "description" : "The Description of the Parameter Context." - }, - "parameters" : { - "type" : "array", - "description" : "The Parameters for the Parameter Context", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ParameterEntity" - } - }, - "boundProcessGroups" : { - "type" : "array", - "description" : "The Process Groups that are bound to this Parameter Context", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ProcessGroupEntity" - } - }, - "inheritedParameterContexts" : { - "type" : "array", - "description" : "A list of references of Parameter Contexts from which this one inherits parameters", - "items" : { - "$ref" : "#/definitions/ParameterContextReferenceEntity" - } - }, - "id" : { - "type" : "string", - "description" : "The ID the Parameter Context." - } - } - }, - "ParameterContextEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "component" : { - "description" : "The Parameter Context", - "$ref" : "#/definitions/ParameterContextDTO" - } - }, - "xml" : { - "name" : "parameterContextEntity" - } - }, - "ParameterContextReferenceDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The ID of the Parameter Context" - }, - "name" : { - "type" : "string", - "description" : "The name of the Parameter Context" - } - } - }, - "ParameterContextReferenceEntity" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "component" : { - "$ref" : "#/definitions/ParameterContextReferenceDTO" - } - }, - "xml" : { - "name" : "parameterContextReferenceEntity" - } - }, - "ParameterContextUpdateRequestDTO" : { - "type" : "object", - "properties" : { - "requestId" : { - "type" : "string", - "description" : "The ID of the request" - }, - "uri" : { - "type" : "string", - "description" : "The URI for the request" - }, - "submissionTime" : { - "type" : "string", - "format" : "date-time", - "description" : "The timestamp of when the request was submitted" - }, - "lastUpdated" : { - "type" : "string", - "format" : "date-time", - "description" : "The timestamp of when the request was last updated" - }, - "complete" : { - "type" : "boolean", - "description" : "Whether or not the request is completed" - }, - "failureReason" : { - "type" : "string", - "description" : "The reason for the request failing, or null if the request has not failed" - }, - "percentCompleted" : { - "type" : "integer", - "format" : "int32", - "description" : "A value between 0 and 100 (inclusive) indicating how close the request is to completion" - }, - "state" : { - "type" : "string", - "description" : "A description of the current state of the request" - }, - "updateSteps" : { - "type" : "array", - "description" : "The steps that are required in order to complete the request, along with the status of each", - "items" : { - "$ref" : "#/definitions/ParameterContextUpdateStepDTO" - } - }, - "parameterContext" : { - "description" : "The Parameter Context that is being operated on. This may not be populated until the request has successfully completed.", - "$ref" : "#/definitions/ParameterContextDTO" - }, - "referencingComponents" : { - "type" : "array", - "description" : "The components that are referenced by the update.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/AffectedComponentEntity" - } - } - } - }, - "ParameterContextUpdateRequestEntity" : { - "type" : "object", - "properties" : { - "parameterContextRevision" : { - "description" : "The Revision of the Parameter Context", - "$ref" : "#/definitions/RevisionDTO" - }, - "request" : { - "description" : "The Update Request", - "$ref" : "#/definitions/ParameterContextUpdateRequestDTO" - } - }, - "xml" : { - "name" : "parameterContextUpdateRequestEntity" - } - }, - "ParameterContextUpdateStepDTO" : { - "type" : "object", - "properties" : { - "description" : { - "type" : "string", - "description" : "Explanation of what happens in this step" - }, - "complete" : { - "type" : "boolean", - "description" : "Whether or not this step has completed" - }, - "failureReason" : { - "type" : "string", - "description" : "An explanation of why this step failed, or null if this step did not fail" - } - } - }, - "ParameterContextValidationRequestDTO" : { - "type" : "object", - "properties" : { - "requestId" : { - "type" : "string", - "description" : "The ID of the request" - }, - "uri" : { - "type" : "string", - "description" : "The URI for the request" - }, - "submissionTime" : { - "type" : "string", - "format" : "date-time", - "description" : "The timestamp of when the request was submitted" - }, - "lastUpdated" : { - "type" : "string", - "format" : "date-time", - "description" : "The timestamp of when the request was last updated" - }, - "complete" : { - "type" : "boolean", - "description" : "Whether or not the request is completed" - }, - "failureReason" : { - "type" : "string", - "description" : "The reason for the request failing, or null if the request has not failed" - }, - "percentCompleted" : { - "type" : "integer", - "format" : "int32", - "description" : "A value between 0 and 100 (inclusive) indicating how close the request is to completion" - }, - "state" : { - "type" : "string", - "description" : "A description of the current state of the request" - }, - "updateSteps" : { - "type" : "array", - "description" : "The steps that are required in order to complete the request, along with the status of each", - "items" : { - "$ref" : "#/definitions/ParameterContextValidationStepDTO" - } - }, - "parameterContext" : { - "description" : "The Parameter Context that is being operated on.", - "$ref" : "#/definitions/ParameterContextDTO" - }, - "componentValidationResults" : { - "description" : "The Validation Results that were calculated for each component. This value may not be set until the request completes.", - "$ref" : "#/definitions/ComponentValidationResultsEntity" - } - } - }, - "ParameterContextValidationRequestEntity" : { - "type" : "object", - "properties" : { - "request" : { - "description" : "The Update Request", - "$ref" : "#/definitions/ParameterContextValidationRequestDTO" - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - } - }, - "xml" : { - "name" : "parameterContextValidationRequestEntity" - } - }, - "ParameterContextValidationStepDTO" : { - "type" : "object", - "properties" : { - "description" : { - "type" : "string", - "description" : "Explanation of what happens in this step" - }, - "complete" : { - "type" : "boolean", - "description" : "Whether or not this step has completed" - }, - "failureReason" : { - "type" : "string", - "description" : "An explanation of why this step failed, or null if this step did not fail" - } - } - }, - "ParameterContextsEntity" : { - "type" : "object", - "properties" : { - "parameterContexts" : { - "type" : "array", - "description" : "The Parameter Contexts", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ParameterContextEntity" - } - }, - "currentTime" : { - "type" : "string", - "description" : "The current time on the system." - } - }, - "xml" : { - "name" : "parameterContexts" - } - }, - "ParameterDTO" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The name of the Parameter" - }, - "description" : { - "type" : "string", - "description" : "The description of the Parameter" - }, - "sensitive" : { - "type" : "boolean", - "description" : "Whether or not the Parameter is sensitive" - }, - "value" : { - "type" : "string", - "description" : "The value of the Parameter" - }, - "valueRemoved" : { - "type" : "boolean", - "description" : "Whether or not the value of the Parameter was removed. When a request is made to change a parameter, the value may be null. The 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). This denotes which of the two scenarios is being encountered." - }, - "referencingComponents" : { - "type" : "array", - "description" : "The set of all components in the flow that are referencing this Parameter", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/AffectedComponentEntity" - } - }, - "parameterContext" : { - "description" : "A reference to the Parameter Context that contains this one", - "$ref" : "#/definitions/ParameterContextReferenceEntity" - }, - "inherited" : { - "type" : "boolean", - "description" : "Whether or not the Parameter is inherited from another context" - } - } - }, - "ParameterEntity" : { - "type" : "object", - "properties" : { - "canWrite" : { - "type" : "boolean", - "description" : "Indicates whether the user can write a given resource." - }, - "parameter" : { - "description" : "The parameter information", - "$ref" : "#/definitions/ParameterDTO" - } - }, - "xml" : { - "name" : "parameterEntity" - } - }, - "PeerDTO" : { - "type" : "object", - "properties" : { - "hostname" : { - "type" : "string", - "description" : "The hostname of this peer." - }, - "port" : { - "type" : "integer", - "format" : "int32", - "description" : "The port number of this peer." - }, - "secure" : { - "type" : "boolean", - "description" : "Returns if this peer connection is secure." - }, - "flowFileCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of flowFiles this peer holds." - } - } - }, - "PeersEntity" : { - "type" : "object", - "properties" : { - "peers" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/PeerDTO" - } - } - }, - "xml" : { - "name" : "peersEntity" - } - }, - "Permissions" : { - "type" : "object", - "properties" : { - "canRead" : { - "type" : "boolean", - "description" : "Indicates whether the user can read a given resource.", - "readOnly" : true - }, - "canWrite" : { - "type" : "boolean", - "description" : "Indicates whether the user can write a given resource.", - "readOnly" : true - }, - "canDelete" : { - "type" : "boolean", - "description" : "Indicates whether the user can delete a given resource.", - "readOnly" : true - } - } - }, - "PermissionsDTO" : { - "type" : "object", - "properties" : { - "canRead" : { - "type" : "boolean", - "description" : "Indicates whether the user can read a given resource." - }, - "canWrite" : { - "type" : "boolean", - "description" : "Indicates whether the user can write a given resource." - } - } - }, - "PortDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "versionedComponentId" : { - "type" : "string", - "description" : "The ID of the corresponding component that is under version control" - }, - "parentGroupId" : { - "type" : "string", - "description" : "The id of parent process group of this component if applicable." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "name" : { - "type" : "string", - "description" : "The name of the port." - }, - "comments" : { - "type" : "string", - "description" : "The comments for the port." - }, - "state" : { - "type" : "string", - "description" : "The state of the port.", - "enum" : [ "RUNNING", "STOPPED", "DISABLED" ] - }, - "type" : { - "type" : "string", - "description" : "The type of port.", - "enum" : [ "INPUT_PORT", "OUTPUT_PORT" ] - }, - "transmitting" : { - "type" : "boolean", - "description" : "Whether the port has incoming or output connections to a remote NiFi. This is only applicable when the port is allowed to be accessed remotely." - }, - "concurrentlySchedulableTaskCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of tasks that should be concurrently scheduled for the port." - }, - "userAccessControl" : { - "type" : "array", - "description" : "The users that are allowed to access the port.", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - }, - "groupAccessControl" : { - "type" : "array", - "description" : "The user groups that are allowed to access the port.", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - }, - "allowRemoteAccess" : { - "type" : "boolean", - "description" : "Whether this port can be accessed remotely via Site-to-Site protocol." - }, - "validationErrors" : { - "type" : "array", - "description" : "Gets the validation errors from this port. These validation errors represent the problems with the port that must be resolved before it can be started.", - "items" : { - "type" : "string" - } - } - } - }, - "PortEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "component" : { - "$ref" : "#/definitions/PortDTO" - }, - "status" : { - "description" : "The status of the port.", - "$ref" : "#/definitions/PortStatusDTO" - }, - "portType" : { - "type" : "string" - }, - "operatePermissions" : { - "description" : "The permissions for this component operations.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "allowRemoteAccess" : { - "type" : "boolean", - "description" : "Whether this port can be accessed remotely via Site-to-Site protocol." - } - }, - "xml" : { - "name" : "portEntity" - } - }, - "PortRunStatusEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "state" : { - "type" : "string", - "description" : "The run status of the Port.", - "enum" : [ "RUNNING", "STOPPED", "DISABLED" ] - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - } - }, - "xml" : { - "name" : "entity" - } - }, - "PortStatusDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the port." - }, - "groupId" : { - "type" : "string", - "description" : "The id of the parent process group of the port." - }, - "name" : { - "type" : "string", - "description" : "The name of the port." - }, - "transmitting" : { - "type" : "boolean", - "description" : "Whether the port has incoming or outgoing connections to a remote NiFi." - }, - "runStatus" : { - "type" : "string", - "description" : "The run status of the port.", - "enum" : [ "Running", "Stopped", "Validating", "Disabled", "Invalid" ] - }, - "statsLastRefreshed" : { - "type" : "string", - "description" : "The time the status for the process group was last refreshed." - }, - "aggregateSnapshot" : { - "description" : "A status snapshot that represents the aggregate stats of all nodes in the cluster. If the NiFi instance is a standalone instance, rather than a cluster, this represents the stats of the single instance.", - "$ref" : "#/definitions/PortStatusSnapshotDTO" - }, - "nodeSnapshots" : { - "type" : "array", - "description" : "A status snapshot for each node in the cluster. If the NiFi instance is a standalone instance, rather than a cluster, this may be null.", - "items" : { - "$ref" : "#/definitions/NodePortStatusSnapshotDTO" - } - } - } - }, - "PortStatusEntity" : { - "type" : "object", - "properties" : { - "portStatus" : { - "$ref" : "#/definitions/PortStatusDTO" - }, - "canRead" : { - "type" : "boolean", - "description" : "Indicates whether the user can read a given resource." - } - }, - "xml" : { - "name" : "portStatusEntity" - } - }, - "PortStatusSnapshotDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the port." - }, - "groupId" : { - "type" : "string", - "description" : "The id of the parent process group of the port." - }, - "name" : { - "type" : "string", - "description" : "The name of the port." - }, - "activeThreadCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The active thread count for the port." - }, - "flowFilesIn" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of FlowFiles that have been accepted in the last 5 minutes." - }, - "bytesIn" : { - "type" : "integer", - "format" : "int64", - "description" : "The size of hte FlowFiles that have been accepted in the last 5 minutes." - }, - "input" : { - "type" : "string", - "description" : "The count/size of flowfiles that have been accepted in the last 5 minutes." - }, - "flowFilesOut" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of FlowFiles that have been processed in the last 5 minutes." - }, - "bytesOut" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes that have been processed in the last 5 minutes." - }, - "output" : { - "type" : "string", - "description" : "The count/size of flowfiles that have been processed in the last 5 minutes." - }, - "transmitting" : { - "type" : "boolean", - "description" : "Whether the port has incoming or outgoing connections to a remote NiFi." - }, - "runStatus" : { - "type" : "string", - "description" : "The run status of the port.", - "enum" : [ "Running", "Stopped", "Validating", "Disabled", "Invalid" ] - } - } - }, - "PortStatusSnapshotEntity" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the port." - }, - "portStatusSnapshot" : { - "$ref" : "#/definitions/PortStatusSnapshotDTO" - }, - "canRead" : { - "type" : "boolean", - "description" : "Indicates whether the user can read a given resource." - } - }, - "xml" : { - "name" : "entity" - } - }, - "Position" : { - "type" : "object", - "properties" : { - "x" : { - "type" : "number", - "format" : "double", - "description" : "The x coordinate." - }, - "y" : { - "type" : "number", - "format" : "double", - "description" : "The y coordinate." - } - }, - "description" : "The position of a component on the graph" - }, - "PositionDTO" : { - "type" : "object", - "properties" : { - "x" : { - "type" : "number", - "format" : "double", - "description" : "The x coordinate." - }, - "y" : { - "type" : "number", - "format" : "double", - "description" : "The y coordinate." - } - } - }, - "PreviousValueDTO" : { - "type" : "object", - "properties" : { - "previousValue" : { - "type" : "string", - "description" : "The previous value." - }, - "timestamp" : { - "type" : "string", - "description" : "The timestamp when the value was modified." - }, - "userIdentity" : { - "type" : "string", - "description" : "The user who changed the previous value." - } - } - }, - "PrioritizerTypesEntity" : { - "type" : "object", - "properties" : { - "prioritizerTypes" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/DocumentedTypeDTO" - } - } - }, - "xml" : { - "name" : "prioritizerTypesEntity" - } - }, - "ProcessGroupDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "versionedComponentId" : { - "type" : "string", - "description" : "The ID of the corresponding component that is under version control" - }, - "parentGroupId" : { - "type" : "string", - "description" : "The id of parent process group of this component if applicable." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "name" : { - "type" : "string", - "description" : "The name of the process group." - }, - "comments" : { - "type" : "string", - "description" : "The comments for the process group." - }, - "variables" : { - "type" : "object", - "description" : "The variables that are configured for the Process Group. Note that this map contains only those variables that are defined on this Process Group and not any variables that are defined in the parent Process Group, etc. I.e., this Map will not contain all variables that are accessible by components in this Process Group by rather only the variables that are defined for this Process Group itself.", - "additionalProperties" : { - "type" : "string" - } - }, - "versionControlInformation" : { - "description" : "The Version Control information that indicates which Flow Registry, and where in the Flow Registry, this Process Group is tracking to; or null if this Process Group is not under version control", - "$ref" : "#/definitions/VersionControlInformationDTO" - }, - "parameterContext" : { - "description" : "The Parameter Context that this Process Group is bound to.", - "$ref" : "#/definitions/ParameterContextReferenceEntity" - }, - "flowfileConcurrency" : { - "type" : "string", - "description" : "The FlowFile Concurrency for this Process Group.", - "enum" : [ "UNBOUNDED", "SINGLE_FLOWFILE_PER_NODE" ] - }, - "flowfileOutboundPolicy" : { - "type" : "string", - "description" : "The Outbound Policy that is used for determining how FlowFiles should be transferred out of the Process Group.", - "enum" : [ "STREAM_WHEN_AVAILABLE", "BATCH_OUTPUT" ] - }, - "defaultFlowFileExpiration" : { - "type" : "string", - "description" : "The default FlowFile Expiration for this Process Group." - }, - "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." - }, - "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." - }, - "runningCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of running components in this process group." - }, - "stoppedCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of stopped components in the process group." - }, - "invalidCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of invalid components in the process group." - }, - "disabledCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of disabled components in the process group." - }, - "activeRemotePortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of active remote ports in the process group." - }, - "inactiveRemotePortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of inactive remote ports in the process group." - }, - "upToDateCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of up to date versioned process groups in the process group." - }, - "locallyModifiedCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of locally modified versioned process groups in the process group." - }, - "staleCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of stale versioned process groups in the process group." - }, - "locallyModifiedAndStaleCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of locally modified and stale versioned process groups in the process group." - }, - "syncFailureCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of versioned process groups in the process group that are unable to sync to a registry." - }, - "localInputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of local input ports in the process group." - }, - "localOutputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of local output ports in the process group." - }, - "publicInputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of public input ports in the process group." - }, - "publicOutputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of public output ports in the process group." - }, - "contents" : { - "description" : "The contents of this process group.", - "$ref" : "#/definitions/FlowSnippetDTO" - }, - "inputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of input ports in the process group." - }, - "outputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of output ports in the process group." - } - } - }, - "ProcessGroupEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "component" : { - "$ref" : "#/definitions/ProcessGroupDTO" - }, - "status" : { - "description" : "The status of the process group.", - "$ref" : "#/definitions/ProcessGroupStatusDTO" - }, - "versionedFlowSnapshot" : { - "description" : "Returns the Versioned Flow that describes the contents of the Versioned Flow to be imported", - "$ref" : "#/definitions/VersionedFlowSnapshot" - }, - "runningCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of running components in this process group." - }, - "stoppedCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of stopped components in the process group." - }, - "invalidCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of invalid components in the process group." - }, - "disabledCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of disabled components in the process group." - }, - "activeRemotePortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of active remote ports in the process group." - }, - "inactiveRemotePortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of inactive remote ports in the process group." - }, - "versionedFlowState" : { - "type" : "string", - "description" : "The current state of the Process Group, as it relates to the Versioned Flow", - "enum" : [ "LOCALLY_MODIFIED", "STALE", "LOCALLY_MODIFIED_AND_STALE", "UP_TO_DATE", "SYNC_FAILURE" ] - }, - "upToDateCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of up to date versioned process groups in the process group." - }, - "locallyModifiedCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of locally modified versioned process groups in the process group." - }, - "staleCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of stale versioned process groups in the process group." - }, - "locallyModifiedAndStaleCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of locally modified and stale versioned process groups in the process group." - }, - "syncFailureCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of versioned process groups in the process group that are unable to sync to a registry." - }, - "localInputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of local input ports in the process group." - }, - "localOutputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of local output ports in the process group." - }, - "publicInputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of public input ports in the process group." - }, - "publicOutputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of public output ports in the process group." - }, - "parameterContext" : { - "description" : "The Parameter Context, or null if no Parameter Context has been bound to the Process Group", - "$ref" : "#/definitions/ParameterContextReferenceEntity" - }, - "inputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of input ports in the process group." - }, - "outputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of output ports in the process group." - } - }, - "xml" : { - "name" : "processGroupEntity" - } - }, - "ProcessGroupFlowDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "parentGroupId" : { - "type" : "string", - "description" : "The id of parent process group of this component if applicable." - }, - "parameterContext" : { - "description" : "The Parameter Context, or null if no Parameter Context has been bound to the Process Group", - "$ref" : "#/definitions/ParameterContextReferenceEntity" - }, - "breadcrumb" : { - "description" : "The breadcrumb of the process group.", - "$ref" : "#/definitions/FlowBreadcrumbEntity" - }, - "flow" : { - "description" : "The flow structure starting at this Process Group.", - "$ref" : "#/definitions/FlowDTO" - }, - "lastRefreshed" : { - "type" : "string", - "description" : "The time the flow for the process group was last refreshed." - } - } - }, - "ProcessGroupFlowEntity" : { - "type" : "object", - "properties" : { - "permissions" : { - "description" : "The access policy for this process group.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "processGroupFlow" : { - "$ref" : "#/definitions/ProcessGroupFlowDTO" - } - }, - "xml" : { - "name" : "processGroupFlowEntity" - } - }, - "ProcessGroupImportEntity" : { - "type" : "object", - "properties" : { - "processGroupRevision" : { - "description" : "The Revision for the Process Group", - "$ref" : "#/definitions/RevisionDTO" - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "versionedFlowSnapshot" : { - "description" : "The Versioned Flow Snapshot to import", - "$ref" : "#/definitions/VersionedFlowSnapshot" - } - }, - "xml" : { - "name" : "processGroupImportEntity" - } - }, - "ProcessGroupNameDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The ID of the Process Group" - }, - "name" : { - "type" : "string", - "description" : "The name of the Process Group, or the ID of the Process Group if the user does not have the READ policy for the Process Group" - } - } - }, - "ProcessGroupReplaceRequestDTO" : { - "type" : "object", - "properties" : { - "requestId" : { - "type" : "string", - "description" : "The unique ID of this request." - }, - "processGroupId" : { - "type" : "string", - "description" : "The unique ID of the Process Group being updated" - }, - "uri" : { - "type" : "string", - "description" : "The URI for future requests to this drop request." - }, - "lastUpdated" : { - "type" : "string", - "description" : "The last time this request was updated." - }, - "complete" : { - "type" : "boolean", - "description" : "Whether or not this request has completed" - }, - "failureReason" : { - "type" : "string", - "description" : "An explanation of why this request failed, or null if this request has not failed" - }, - "percentCompleted" : { - "type" : "integer", - "format" : "int32", - "description" : "The percentage complete for the request, between 0 and 100" - }, - "state" : { - "type" : "string", - "description" : "The state of the request" - } - } - }, - "ProcessGroupReplaceRequestEntity" : { - "type" : "object", - "properties" : { - "processGroupRevision" : { - "description" : "The revision for the Process Group being updated.", - "$ref" : "#/definitions/RevisionDTO" - }, - "request" : { - "description" : "The Process Group Change Request", - "$ref" : "#/definitions/ProcessGroupReplaceRequestDTO" - }, - "versionedFlowSnapshot" : { - "description" : "Returns the Versioned Flow to replace with", - "$ref" : "#/definitions/VersionedFlowSnapshot" - } - }, - "xml" : { - "name" : "processGroupReplaceRequestEntity" - } - }, - "ProcessGroupStatusDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The ID of the Process Group" - }, - "name" : { - "type" : "string", - "description" : "The name of the Process Group" - }, - "statsLastRefreshed" : { - "type" : "string", - "description" : "The time the status for the process group was last refreshed." - }, - "aggregateSnapshot" : { - "description" : "The aggregate status of all nodes in the cluster", - "$ref" : "#/definitions/ProcessGroupStatusSnapshotDTO" - }, - "nodeSnapshots" : { - "type" : "array", - "description" : "The status reported by each node in the cluster. If the NiFi instance is a standalone instance, rather than a clustered instance, this value may be null.", - "items" : { - "$ref" : "#/definitions/NodeProcessGroupStatusSnapshotDTO" - } - } - } - }, - "ProcessGroupStatusEntity" : { - "type" : "object", - "properties" : { - "processGroupStatus" : { - "$ref" : "#/definitions/ProcessGroupStatusDTO" - }, - "canRead" : { - "type" : "boolean", - "description" : "Indicates whether the user can read a given resource." - } - }, - "xml" : { - "name" : "processGroupStatusEntity" - } - }, - "ProcessGroupStatusSnapshotDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the process group." - }, - "name" : { - "type" : "string", - "description" : "The name of this process group." - }, - "connectionStatusSnapshots" : { - "type" : "array", - "description" : "The status of all connections in the process group.", - "items" : { - "$ref" : "#/definitions/ConnectionStatusSnapshotEntity" - } - }, - "processorStatusSnapshots" : { - "type" : "array", - "description" : "The status of all processors in the process group.", - "items" : { - "$ref" : "#/definitions/ProcessorStatusSnapshotEntity" - } - }, - "processGroupStatusSnapshots" : { - "type" : "array", - "description" : "The status of all process groups in the process group.", - "items" : { - "$ref" : "#/definitions/ProcessGroupStatusSnapshotEntity" - } - }, - "remoteProcessGroupStatusSnapshots" : { - "type" : "array", - "description" : "The status of all remote process groups in the process group.", - "items" : { - "$ref" : "#/definitions/RemoteProcessGroupStatusSnapshotEntity" - } - }, - "inputPortStatusSnapshots" : { - "type" : "array", - "description" : "The status of all input ports in the process group.", - "items" : { - "$ref" : "#/definitions/PortStatusSnapshotEntity" - } - }, - "outputPortStatusSnapshots" : { - "type" : "array", - "description" : "The status of all output ports in the process group.", - "items" : { - "$ref" : "#/definitions/PortStatusSnapshotEntity" - } - }, - "versionedFlowState" : { - "type" : "string", - "description" : "The current state of the Process Group, as it relates to the Versioned Flow", - "enum" : [ "LOCALLY_MODIFIED", "STALE", "LOCALLY_MODIFIED_AND_STALE", "UP_TO_DATE", "SYNC_FAILURE" ] - }, - "flowFilesIn" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of FlowFiles that have come into this ProcessGroup in the last 5 minutes" - }, - "bytesIn" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes that have come into this ProcessGroup in the last 5 minutes" - }, - "input" : { - "type" : "string", - "description" : "The input count/size for the process group in the last 5 minutes (pretty printed)." - }, - "flowFilesQueued" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of FlowFiles that are queued up in this ProcessGroup right now" - }, - "bytesQueued" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes that are queued up in this ProcessGroup right now" - }, - "queued" : { - "type" : "string", - "description" : "The count/size that is queued in the the process group." - }, - "queuedCount" : { - "type" : "string", - "description" : "The count that is queued for the process group." - }, - "queuedSize" : { - "type" : "string", - "description" : "The size that is queued for the process group." - }, - "bytesRead" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes read by components in this ProcessGroup in the last 5 minutes" - }, - "read" : { - "type" : "string", - "description" : "The number of bytes read in the last 5 minutes." - }, - "bytesWritten" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes written by components in this ProcessGroup in the last 5 minutes" - }, - "written" : { - "type" : "string", - "description" : "The number of bytes written in the last 5 minutes." - }, - "flowFilesOut" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of FlowFiles transferred out of this ProcessGroup in the last 5 minutes" - }, - "bytesOut" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes transferred out of this ProcessGroup in the last 5 minutes" - }, - "output" : { - "type" : "string", - "description" : "The output count/size for the process group in the last 5 minutes." - }, - "flowFilesTransferred" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of FlowFiles transferred in this ProcessGroup in the last 5 minutes" - }, - "bytesTransferred" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes transferred in this ProcessGroup in the last 5 minutes" - }, - "transferred" : { - "type" : "string", - "description" : "The count/size transferred to/from queues in the process group in the last 5 minutes." - }, - "bytesReceived" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes received from external sources by components within this ProcessGroup in the last 5 minutes" - }, - "flowFilesReceived" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of FlowFiles received from external sources by components within this ProcessGroup in the last 5 minutes" - }, - "received" : { - "type" : "string", - "description" : "The count/size sent to the process group in the last 5 minutes." - }, - "bytesSent" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes sent to an external sink by components within this ProcessGroup in the last 5 minutes" - }, - "flowFilesSent" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of FlowFiles sent to an external sink by components within this ProcessGroup in the last 5 minutes" - }, - "sent" : { - "type" : "string", - "description" : "The count/size sent from this process group in the last 5 minutes." - }, - "activeThreadCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The active thread count for this process group." - }, - "terminatedThreadCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of threads currently terminated for the process group." - } - } - }, - "ProcessGroupStatusSnapshotEntity" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the process group." - }, - "processGroupStatusSnapshot" : { - "$ref" : "#/definitions/ProcessGroupStatusSnapshotDTO" - }, - "canRead" : { - "type" : "boolean", - "description" : "Indicates whether the user can read a given resource." - } - }, - "xml" : { - "name" : "entity" - } - }, - "ProcessGroupsEntity" : { - "type" : "object", - "properties" : { - "processGroups" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ProcessGroupEntity" - } - } - }, - "xml" : { - "name" : "processGroupsEntity" - } - }, - "ProcessorConfigDTO" : { - "type" : "object", - "properties" : { - "properties" : { - "type" : "object", - "description" : "The properties for the processor. Properties whose value is not set will only contain the property name.", - "additionalProperties" : { - "type" : "string" - } - }, - "descriptors" : { - "type" : "object", - "description" : "Descriptors for the processor's properties.", - "additionalProperties" : { - "$ref" : "#/definitions/PropertyDescriptorDTO" - } - }, - "sensitiveDynamicPropertyNames" : { - "type" : "array", - "description" : "Set of sensitive dynamic property names", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - }, - "schedulingPeriod" : { - "type" : "string", - "description" : "The frequency with which to schedule the processor. The format of the value will depend on th value of schedulingStrategy." - }, - "schedulingStrategy" : { - "type" : "string", - "description" : "Indcates whether the prcessor should be scheduled to run in event or timer driven mode." - }, - "executionNode" : { - "type" : "string", - "description" : "Indicates the node where the process will execute." - }, - "penaltyDuration" : { - "type" : "string", - "description" : "The amount of time that is used when the process penalizes a flowfile." - }, - "yieldDuration" : { - "type" : "string", - "description" : "The amount of time that must elapse before this processor is scheduled again after yielding." - }, - "bulletinLevel" : { - "type" : "string", - "description" : "The level at which the processor will report bulletins." - }, - "runDurationMillis" : { - "type" : "integer", - "format" : "int64", - "description" : "The run duration for the processor in milliseconds." - }, - "concurrentlySchedulableTaskCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of tasks that should be concurrently schedule for the processor. If the processor doesn't allow parallol processing then any positive input will be ignored." - }, - "autoTerminatedRelationships" : { - "type" : "array", - "description" : "The names of all relationships that cause a flow file to be terminated if the relationship is not connected elsewhere. This property differs from the 'isAutoTerminate' property of the RelationshipDTO in that the RelationshipDTO is meant to depict the current configuration, whereas this property can be set in a DTO when updating a Processor in order to change which Relationships should be auto-terminated.", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - }, - "comments" : { - "type" : "string", - "description" : "The comments for the processor." - }, - "customUiUrl" : { - "type" : "string", - "description" : "The URL for the processor's custom configuration UI if applicable." - }, - "lossTolerant" : { - "type" : "boolean", - "description" : "Whether the processor is loss tolerant." - }, - "annotationData" : { - "type" : "string", - "description" : "The annotation data for the processor used to relay configuration between a custom UI and the procesosr." - }, - "defaultConcurrentTasks" : { - "type" : "object", - "description" : "Maps default values for concurrent tasks for each applicable scheduling strategy.", - "additionalProperties" : { - "type" : "string" - } - }, - "defaultSchedulingPeriod" : { - "type" : "object", - "description" : "Maps default values for scheduling period for each applicable scheduling strategy.", - "additionalProperties" : { - "type" : "string" - } - }, - "retryCount" : { - "type" : "integer", - "format" : "int32", - "description" : "Overall number of retries." - }, - "retriedRelationships" : { - "type" : "array", - "description" : "All the relationships should be retried.", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - }, - "backoffMechanism" : { - "type" : "string", - "description" : "Determines whether the FlowFile should be penalized or the processor should be yielded between retries.", - "enum" : [ "PENALIZE_FLOWFILE", "YIELD_PROCESSOR" ] - }, - "maxBackoffPeriod" : { - "type" : "string", - "description" : "Maximum amount of time to be waited during a retry period." - } - } - }, - "ProcessorDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "versionedComponentId" : { - "type" : "string", - "description" : "The ID of the corresponding component that is under version control" - }, - "parentGroupId" : { - "type" : "string", - "description" : "The id of parent process group of this component if applicable." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "name" : { - "type" : "string", - "description" : "The name of the processor." - }, - "type" : { - "type" : "string", - "description" : "The type of the processor." - }, - "bundle" : { - "description" : "The details of the artifact that bundled this processor type.", - "$ref" : "#/definitions/BundleDTO" - }, - "state" : { - "type" : "string", - "description" : "The state of the processor", - "enum" : [ "RUNNING", "STOPPED", "DISABLED" ] - }, - "style" : { - "type" : "object", - "description" : "Styles for the processor (background-color : #eee).", - "additionalProperties" : { - "type" : "string" - } - }, - "relationships" : { - "type" : "array", - "description" : "The available relationships that the processor currently supports.", - "items" : { - "$ref" : "#/definitions/RelationshipDTO" - } - }, - "description" : { - "type" : "string", - "description" : "The description of the processor." - }, - "supportsParallelProcessing" : { - "type" : "boolean", - "description" : "Whether the processor supports parallel processing." - }, - "supportsEventDriven" : { - "type" : "boolean", - "description" : "Whether the processor supports event driven scheduling." - }, - "supportsBatching" : { - "type" : "boolean", - "description" : "Whether the processor supports batching. This makes the run duration settings available." - }, - "supportsSensitiveDynamicProperties" : { - "type" : "boolean", - "description" : "Whether the processor supports sensitive dynamic properties." - }, - "persistsState" : { - "type" : "boolean", - "description" : "Whether the processor persists state." - }, - "restricted" : { - "type" : "boolean", - "description" : "Whether the processor requires elevated privileges." - }, - "deprecated" : { - "type" : "boolean", - "description" : "Whether the processor has been deprecated." - }, - "executionNodeRestricted" : { - "type" : "boolean", - "description" : "Indicates if the execution node of a processor is restricted to run only on the primary node" - }, - "multipleVersionsAvailable" : { - "type" : "boolean", - "description" : "Whether the processor has multiple versions available." - }, - "inputRequirement" : { - "type" : "string", - "description" : "The input requirement for this processor." - }, - "config" : { - "description" : "The configuration details for the processor. These details will be included in a response if the verbose flag is included in a request.", - "$ref" : "#/definitions/ProcessorConfigDTO" - }, - "validationErrors" : { - "type" : "array", - "description" : "The validation errors for the processor. These validation errors represent the problems with the processor that must be resolved before it can be started.", - "items" : { - "type" : "string" - } - }, - "validationStatus" : { - "type" : "string", - "description" : "Indicates whether the Processor is valid, invalid, or still in the process of validating (i.e., it is unknown whether or not the Processor is valid)", - "enum" : [ "VALID", "INVALID", "VALIDATING" ] - }, - "extensionMissing" : { - "type" : "boolean", - "description" : "Whether the underlying extension is missing." - } - } - }, - "ProcessorDefinition" : { - "type" : "object", - "required" : [ "type" ], - "properties" : { - "group" : { - "type" : "string", - "description" : "The group name of the bundle that provides the referenced type." - }, - "artifact" : { - "type" : "string", - "description" : "The artifact name of the bundle that provides the referenced type." - }, - "version" : { - "type" : "string", - "description" : "The version 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." - }, - "buildInfo" : { - "description" : "The build metadata for this component", - "$ref" : "#/definitions/BuildInfo" - }, - "providedApiImplementations" : { - "type" : "array", - "description" : "If this type represents a provider for an interface, this lists the APIs it implements", - "items" : { - "$ref" : "#/definitions/DefinedType" - } - }, - "tags" : { - "type" : "array", - "description" : "The tags associated with this type", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - }, - "deprecated" : { - "type" : "boolean", - "description" : "Whether or not the component has been deprecated" - }, - "deprecationReason" : { - "type" : "string", - "description" : "If this component has been deprecated, this optional field can be used to provide an explanation" - }, - "restricted" : { - "type" : "boolean", - "description" : "Whether or not the component has a general restriction" - }, - "restrictedExplanation" : { - "type" : "string", - "description" : "An optional description of the general restriction" - }, - "explicitRestrictions" : { - "type" : "array", - "description" : "Explicit restrictions that indicate a require permission to use the component", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/Restriction" - } - }, - "propertyDescriptors" : { - "type" : "object", - "description" : "Descriptions of configuration properties applicable to this component.", - "additionalProperties" : { - "$ref" : "#/definitions/PropertyDescriptor" - } - }, - "supportsDynamicProperties" : { - "type" : "boolean", - "description" : "Whether or not this component makes use of dynamic (user-set) properties." - }, - "inputRequirement" : { - "type" : "string", - "description" : "Any input requirements this processor has.", - "enum" : [ "INPUT_REQUIRED", "INPUT_ALLOWED", "INPUT_FORBIDDEN" ] - }, - "supportedRelationships" : { - "type" : "array", - "description" : "The supported relationships for this processor.", - "items" : { - "$ref" : "#/definitions/Relationship" - } - }, - "supportsDynamicRelationships" : { - "type" : "boolean", - "description" : "Whether or not this processor supports dynamic relationships." - }, - "triggerSerially" : { - "type" : "boolean", - "description" : "Whether or not this processor should be triggered serially (i.e. no concurrent execution)." - }, - "triggerWhenEmpty" : { - "type" : "boolean", - "description" : "Whether or not this processor should be triggered when incoming queues are empty." - }, - "triggerWhenAnyDestinationAvailable" : { - "type" : "boolean", - "description" : "Whether or not this processor should be triggered when any destination queue has room." - }, - "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." - }, - "supportsEventDriven" : { - "type" : "boolean", - "description" : "Whether or not this processor supports event driven scheduling. Indicates to the framework that the Processor is eligible to be scheduled to run based on the occurrence of an \"Event\" (e.g., when a FlowFile is enqueued in an incoming Connection), rather than being triggered periodically." - }, - "primaryNodeOnly" : { - "type" : "boolean", - "description" : "Whether or not this processor should be scheduled only on the primary node in a cluster." - }, - "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." - }, - "supportedSchedulingStrategies" : { - "type" : "array", - "description" : "The supported scheduling strategies, such as TIME_DRIVER, CRON, or EVENT_DRIVEN.", - "items" : { - "type" : "string" - } - }, - "defaultSchedulingStrategy" : { - "type" : "string", - "description" : "The default scheduling strategy for the processor." - }, - "defaultConcurrentTasksBySchedulingStrategy" : { - "type" : "object", - "description" : "The default concurrent tasks for each scheduling strategy.", - "additionalProperties" : { - "type" : "integer", - "format" : "int32" - } - }, - "defaultSchedulingPeriodBySchedulingStrategy" : { - "type" : "object", - "description" : "The default scheduling period for each scheduling strategy. The scheduling period is expected to be a time period, such as \"30 sec\".", - "additionalProperties" : { - "type" : "string" - } - }, - "defaultPenaltyDuration" : { - "type" : "string", - "description" : "The default penalty duration as a time period, such as \"30 sec\"." - }, - "defaultYieldDuration" : { - "type" : "string", - "description" : "The default yield duration as a time period, such as \"1 sec\"." - }, - "defaultBulletinLevel" : { - "type" : "string", - "description" : "The default bulletin level, such as WARN, INFO, DEBUG, etc." - } - } - }, - "ProcessorDiagnosticsDTO" : { - "type" : "object", - "properties" : { - "processor" : { - "description" : "Information about the Processor for which the Diagnostic Report is generated", - "$ref" : "#/definitions/ProcessorDTO" - }, - "processorStatus" : { - "description" : "The Status for the Processor for which the Diagnostic Report is generated", - "$ref" : "#/definitions/ProcessorStatusDTO" - }, - "referencedControllerServices" : { - "type" : "array", - "description" : "Diagnostic Information about all Controller Services that the Processor is referencing", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ControllerServiceDiagnosticsDTO" - } - }, - "incomingConnections" : { - "type" : "array", - "description" : "Diagnostic Information about all incoming Connections", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ConnectionDiagnosticsDTO" - } - }, - "outgoingConnections" : { - "type" : "array", - "description" : "Diagnostic Information about all outgoing Connections", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ConnectionDiagnosticsDTO" - } - }, - "jvmDiagnostics" : { - "description" : "Diagnostic Information about the JVM and system-level diagnostics", - "$ref" : "#/definitions/JVMDiagnosticsDTO" - }, - "threadDumps" : { - "type" : "array", - "description" : "Thread Dumps that were taken of the threads that are active in the Processor", - "items" : { - "$ref" : "#/definitions/ThreadDumpDTO" - } - }, - "classLoaderDiagnostics" : { - "description" : "Information about the Controller Service's Class Loader", - "$ref" : "#/definitions/ClassLoaderDiagnosticsDTO" - } - } - }, - "ProcessorDiagnosticsEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "component" : { - "description" : "The Processor Diagnostics", - "$ref" : "#/definitions/ProcessorDiagnosticsDTO" - } - }, - "xml" : { - "name" : "processorDiagnosticsEntity" - } - }, - "ProcessorEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "component" : { - "$ref" : "#/definitions/ProcessorDTO" - }, - "inputRequirement" : { - "type" : "string", - "description" : "The input requirement for this processor." - }, - "status" : { - "$ref" : "#/definitions/ProcessorStatusDTO" - }, - "operatePermissions" : { - "description" : "The permissions for this component operations.", - "$ref" : "#/definitions/PermissionsDTO" - } - }, - "xml" : { - "name" : "processorEntity" - } - }, - "ProcessorRunStatusDetailsDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The ID of the processor" - }, - "name" : { - "type" : "string", - "description" : "The name of the processor" - }, - "runStatus" : { - "type" : "string", - "description" : "The run status of the processor", - "enum" : [ "Running", "Stopped", "Invalid", "Validating", "Disabled" ] - }, - "validationErrors" : { - "type" : "array", - "description" : "The processor's validation errors", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - }, - "activeThreadCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The current number of threads that the processor is currently using" - } - } - }, - "ProcessorRunStatusDetailsEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for the Processor.", - "$ref" : "#/definitions/RevisionDTO" - }, - "permissions" : { - "description" : "The permissions for the Processor.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "runStatusDetails" : { - "description" : "The details of a Processor's run status", - "$ref" : "#/definitions/ProcessorRunStatusDetailsDTO" - } - }, - "xml" : { - "name" : "entity" - } - }, - "ProcessorRunStatusEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "state" : { - "type" : "string", - "description" : "The run status of the Processor.", - "enum" : [ "RUNNING", "STOPPED", "DISABLED", "RUN_ONCE" ] - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - } - }, - "xml" : { - "name" : "entity" - } - }, - "ProcessorStatusDTO" : { - "type" : "object", - "properties" : { - "groupId" : { - "type" : "string", - "description" : "The unique ID of the process group that the Processor belongs to" - }, - "id" : { - "type" : "string", - "description" : "The unique ID of the Processor" - }, - "name" : { - "type" : "string", - "description" : "The name of the Processor" - }, - "type" : { - "type" : "string", - "description" : "The type of the Processor" - }, - "runStatus" : { - "type" : "string", - "description" : "The run status of the Processor", - "enum" : [ "Running", "Stopped", "Validating", "Disabled", "Invalid" ] - }, - "statsLastRefreshed" : { - "type" : "string", - "description" : "The timestamp of when the stats were last refreshed" - }, - "aggregateSnapshot" : { - "description" : "A status snapshot that represents the aggregate stats of all nodes in the cluster. If the NiFi instance is a standalone instance, rather than a cluster, this represents the stats of the single instance.", - "$ref" : "#/definitions/ProcessorStatusSnapshotDTO" - }, - "nodeSnapshots" : { - "type" : "array", - "description" : "A status snapshot for each node in the cluster. If the NiFi instance is a standalone instance, rather than a cluster, this may be null.", - "items" : { - "$ref" : "#/definitions/NodeProcessorStatusSnapshotDTO" - } - } - } - }, - "ProcessorStatusEntity" : { - "type" : "object", - "properties" : { - "processorStatus" : { - "$ref" : "#/definitions/ProcessorStatusDTO" - }, - "canRead" : { - "type" : "boolean", - "description" : "Indicates whether the user can read a given resource." - } - }, - "xml" : { - "name" : "processorStatusEntity" - } - }, - "ProcessorStatusSnapshotDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the processor." - }, - "groupId" : { - "type" : "string", - "description" : "The id of the parent process group to which the processor belongs." - }, - "name" : { - "type" : "string", - "description" : "The name of the prcessor." - }, - "type" : { - "type" : "string", - "description" : "The type of the processor." - }, - "runStatus" : { - "type" : "string", - "description" : "The state of the processor.", - "enum" : [ "Running", "Stopped", "Validating", "Disabled", "Invalid" ] - }, - "executionNode" : { - "type" : "string", - "description" : "Indicates the node where the process will execute.", - "enum" : [ "ALL", "PRIMARY" ] - }, - "bytesRead" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes read by this Processor in the last 5 mintues" - }, - "bytesWritten" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes written by this Processor in the last 5 minutes" - }, - "read" : { - "type" : "string", - "description" : "The number of bytes read in the last 5 minutes." - }, - "written" : { - "type" : "string", - "description" : "The number of bytes written in the last 5 minutes." - }, - "flowFilesIn" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of FlowFiles that have been accepted in the last 5 minutes" - }, - "bytesIn" : { - "type" : "integer", - "format" : "int64", - "description" : "The size of the FlowFiles that have been accepted in the last 5 minutes" - }, - "input" : { - "type" : "string", - "description" : "The count/size of flowfiles that have been accepted in the last 5 minutes." - }, - "flowFilesOut" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of FlowFiles transferred to a Connection in the last 5 minutes" - }, - "bytesOut" : { - "type" : "integer", - "format" : "int64", - "description" : "The size of the FlowFiles transferred to a Connection in the last 5 minutes" - }, - "output" : { - "type" : "string", - "description" : "The count/size of flowfiles that have been processed in the last 5 minutes." - }, - "taskCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of times this Processor has run in the last 5 minutes" - }, - "tasksDurationNanos" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of nanoseconds that this Processor has spent running in the last 5 minutes" - }, - "tasks" : { - "type" : "string", - "description" : "The total number of task this connectable has completed over the last 5 minutes." - }, - "tasksDuration" : { - "type" : "string", - "description" : "The total duration of all tasks for this connectable over the last 5 minutes." - }, - "activeThreadCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of threads currently executing in the processor." - }, - "terminatedThreadCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of threads currently terminated for the processor." - } - } - }, - "ProcessorStatusSnapshotEntity" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the processor." - }, - "processorStatusSnapshot" : { - "$ref" : "#/definitions/ProcessorStatusSnapshotDTO" - }, - "canRead" : { - "type" : "boolean", - "description" : "Indicates whether the user can read a given resource." - } - }, - "xml" : { - "name" : "entity" - } - }, - "ProcessorTypesEntity" : { - "type" : "object", - "properties" : { - "processorTypes" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/DocumentedTypeDTO" - } - } - }, - "xml" : { - "name" : "processorTypesEntity" - } - }, - "ProcessorsEntity" : { - "type" : "object", - "properties" : { - "processors" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ProcessorEntity" - } - } - }, - "xml" : { - "name" : "processorsEntity" - } - }, - "ProcessorsRunStatusDetailsEntity" : { - "type" : "object", - "properties" : { - "runStatusDetails" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/ProcessorRunStatusDetailsEntity" - } - } - }, - "xml" : { - "name" : "processorsRunStatusDetails" - } - }, - "PropertyAllowableValue" : { - "type" : "object", - "required" : [ "value" ], - "properties" : { - "value" : { - "type" : "string", - "description" : "The internal value" - }, - "displayName" : { - "type" : "string", - "description" : "The display name of the value, if different from the internal value" - }, - "description" : { - "type" : "string", - "description" : "The description of the value, e.g., the behavior it produces." - } - } - }, - "PropertyDependency" : { - "type" : "object", - "properties" : { - "propertyName" : { - "type" : "string", - "description" : "The name of the property that is depended upon" - }, - "propertyDisplayName" : { - "type" : "string", - "description" : "The name of the property that is depended upon" - }, - "dependentValues" : { - "type" : "array", - "description" : "The values that satisfy the dependency", - "items" : { - "type" : "string" - } - } - } - }, - "PropertyDependencyDTO" : { - "type" : "object", - "properties" : { - "propertyName" : { - "type" : "string", - "description" : "The name of the property that is being depended upon" - }, - "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", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - } - } - }, - "PropertyDescriptor" : { - "type" : "object", - "required" : [ "name" ], - "properties" : { - "name" : { - "type" : "string", - "description" : "The name of the property key" - }, - "displayName" : { - "type" : "string", - "description" : "The display name of the property key, if different from the name" - }, - "description" : { - "type" : "string", - "description" : "The description of what the property does" - }, - "allowableValues" : { - "type" : "array", - "description" : "A list of the allowable values for the property", - "items" : { - "$ref" : "#/definitions/PropertyAllowableValue" - } - }, - "defaultValue" : { - "type" : "string", - "description" : "The default value if a user-set value is not specified" - }, - "required" : { - "type" : "boolean", - "description" : "Whether or not the property is required for the component" - }, - "sensitive" : { - "type" : "boolean", - "description" : "Whether or not the value of the property is considered sensitive (e.g., passwords and keys)" - }, - "expressionLanguageScope" : { - "type" : "string", - "description" : "The scope of expression language supported by this property", - "enum" : [ "NONE", "VARIABLE_REGISTRY", "FLOWFILE_ATTRIBUTES" ] - }, - "expressionLanguageScopeDescription" : { - "type" : "string", - "description" : "The description of the expression language scope supported by this property", - "readOnly" : true - }, - "typeProvidedByValue" : { - "description" : "Indicates that this property is for selecting a controller service of the specified type", - "$ref" : "#/definitions/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" - }, - "dynamic" : { - "type" : "boolean", - "description" : "Whether or not the descriptor is for a dynamically added property" - }, - "resourceDefinition" : { - "description" : "Indicates that this property references external resources", - "$ref" : "#/definitions/PropertyResourceDefinition" - }, - "dependencies" : { - "type" : "array", - "description" : "The dependencies that this property has on other properties", - "items" : { - "$ref" : "#/definitions/PropertyDependency" - } - } - } - }, - "PropertyDescriptorDTO" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The name for the property." - }, - "displayName" : { - "type" : "string", - "description" : "The human readable name for the property." - }, - "description" : { - "type" : "string", - "description" : "The description for the property. Used to relay additional details to a user or provide a mechanism of documenting intent." - }, - "defaultValue" : { - "type" : "string", - "description" : "The default value for the property." - }, - "allowableValues" : { - "type" : "array", - "description" : "Allowable values for the property. If empty then the allowed values are not constrained.", - "items" : { - "$ref" : "#/definitions/AllowableValueEntity" - } - }, - "required" : { - "type" : "boolean", - "description" : "Whether the property is required." - }, - "sensitive" : { - "type" : "boolean", - "description" : "Whether the property is sensitive and protected whenever stored or represented." - }, - "dynamic" : { - "type" : "boolean", - "description" : "Whether the property is dynamic (user-defined)." - }, - "supportsEl" : { - "type" : "boolean", - "description" : "Whether the property supports expression language." - }, - "expressionLanguageScope" : { - "type" : "string", - "description" : "Scope of the Expression Language evaluation for the property." - }, - "identifiesControllerService" : { - "type" : "string", - "description" : "If the property identifies a controller service this returns the fully qualified type." - }, - "identifiesControllerServiceBundle" : { - "description" : "If the property identifies a controller service this returns the bundle of the type, null otherwise.", - "$ref" : "#/definitions/BundleDTO" - }, - "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" : "#/definitions/PropertyDependencyDTO" - } - } - } - }, - "PropertyDescriptorEntity" : { - "type" : "object", - "properties" : { - "propertyDescriptor" : { - "$ref" : "#/definitions/PropertyDescriptorDTO" - } - }, - "xml" : { - "name" : "propertyDescriptor" - } - }, - "PropertyHistoryDTO" : { - "type" : "object", - "properties" : { - "previousValues" : { - "type" : "array", - "description" : "Previous values for a given property.", - "items" : { - "$ref" : "#/definitions/PreviousValueDTO" - } - } - } - }, - "PropertyResourceDefinition" : { - "type" : "object", - "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", - "uniqueItems" : true, - "items" : { - "type" : "string", - "enum" : [ "FILE", "DIRECTORY", "TEXT", "URL" ] - } - } - } - }, - "ProvenanceDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the provenance query." - }, - "uri" : { - "type" : "string", - "description" : "The URI for this query. Used for obtaining/deleting the request at a later time" - }, - "submissionTime" : { - "type" : "string", - "description" : "The timestamp when the query was submitted." - }, - "expiration" : { - "type" : "string", - "description" : "The timestamp when the query will expire." - }, - "percentCompleted" : { - "type" : "integer", - "format" : "int32", - "description" : "The current percent complete." - }, - "finished" : { - "type" : "boolean", - "description" : "Whether the query has finished." - }, - "request" : { - "description" : "The provenance request.", - "$ref" : "#/definitions/ProvenanceRequestDTO" - }, - "results" : { - "description" : "The provenance results.", - "$ref" : "#/definitions/ProvenanceResultsDTO" - } - } - }, - "ProvenanceEntity" : { - "type" : "object", - "properties" : { - "provenance" : { - "$ref" : "#/definitions/ProvenanceDTO" - } - }, - "xml" : { - "name" : "provenanceEntity" - } - }, - "ProvenanceEventDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The event uuid." - }, - "eventId" : { - "type" : "integer", - "format" : "int64", - "description" : "The event id. This is a one up number thats unique per node." - }, - "eventTime" : { - "type" : "string", - "description" : "The timestamp of the event." - }, - "eventDuration" : { - "type" : "integer", - "format" : "int64", - "description" : "The event duration in milliseconds." - }, - "lineageDuration" : { - "type" : "integer", - "format" : "int64", - "description" : "The duration since the lineage began, in milliseconds." - }, - "eventType" : { - "type" : "string", - "description" : "The type of the event." - }, - "flowFileUuid" : { - "type" : "string", - "description" : "The uuid of the flowfile for the event." - }, - "fileSize" : { - "type" : "string", - "description" : "The size of the flowfile for the event." - }, - "fileSizeBytes" : { - "type" : "integer", - "format" : "int64", - "description" : "The size of the flowfile in bytes for the event." - }, - "clusterNodeId" : { - "type" : "string", - "description" : "The identifier for the node where the event originated." - }, - "clusterNodeAddress" : { - "type" : "string", - "description" : "The label for the node where the event originated." - }, - "groupId" : { - "type" : "string", - "description" : "The id of the group that the component resides in. If the component is no longer in the flow, the group id will not be set." - }, - "componentId" : { - "type" : "string", - "description" : "The id of the component that generated the event." - }, - "componentType" : { - "type" : "string", - "description" : "The type of the component that generated the event." - }, - "componentName" : { - "type" : "string", - "description" : "The name of the component that generated the event." - }, - "sourceSystemFlowFileId" : { - "type" : "string", - "description" : "The source system flowfile id." - }, - "alternateIdentifierUri" : { - "type" : "string", - "description" : "The alternate identifier uri for the fileflow for the event." - }, - "attributes" : { - "type" : "array", - "description" : "The attributes of the flowfile for the event.", - "items" : { - "$ref" : "#/definitions/AttributeDTO" - } - }, - "parentUuids" : { - "type" : "array", - "description" : "The parent uuids for the event.", - "items" : { - "type" : "string" - } - }, - "childUuids" : { - "type" : "array", - "description" : "The child uuids for the event.", - "items" : { - "type" : "string" - } - }, - "transitUri" : { - "type" : "string", - "description" : "The source/destination system uri if the event was a RECEIVE/SEND." - }, - "relationship" : { - "type" : "string", - "description" : "The relationship to which the flowfile was routed if the event is of type ROUTE." - }, - "details" : { - "type" : "string", - "description" : "The event details." - }, - "contentEqual" : { - "type" : "boolean", - "description" : "Whether the input and output content claim is the same." - }, - "inputContentAvailable" : { - "type" : "boolean", - "description" : "Whether the input content is still available." - }, - "inputContentClaimSection" : { - "type" : "string", - "description" : "The section in which the input content claim lives." - }, - "inputContentClaimContainer" : { - "type" : "string", - "description" : "The container in which the input content claim lives." - }, - "inputContentClaimIdentifier" : { - "type" : "string", - "description" : "The identifier of the input content claim." - }, - "inputContentClaimOffset" : { - "type" : "integer", - "format" : "int64", - "description" : "The offset into the input content claim where the flowfiles content begins." - }, - "inputContentClaimFileSize" : { - "type" : "string", - "description" : "The file size of the input content claim formatted." - }, - "inputContentClaimFileSizeBytes" : { - "type" : "integer", - "format" : "int64", - "description" : "The file size of the intput content claim in bytes." - }, - "outputContentAvailable" : { - "type" : "boolean", - "description" : "Whether the output content is still available." - }, - "outputContentClaimSection" : { - "type" : "string", - "description" : "The section in which the output content claim lives." - }, - "outputContentClaimContainer" : { - "type" : "string", - "description" : "The container in which the output content claim lives." - }, - "outputContentClaimIdentifier" : { - "type" : "string", - "description" : "The identifier of the output content claim." - }, - "outputContentClaimOffset" : { - "type" : "integer", - "format" : "int64", - "description" : "The offset into the output content claim where the flowfiles content begins." - }, - "outputContentClaimFileSize" : { - "type" : "string", - "description" : "The file size of the output content claim formatted." - }, - "outputContentClaimFileSizeBytes" : { - "type" : "integer", - "format" : "int64", - "description" : "The file size of the output content claim in bytes." - }, - "replayAvailable" : { - "type" : "boolean", - "description" : "Whether or not replay is available." - }, - "replayExplanation" : { - "type" : "string", - "description" : "Explanation as to why replay is unavailable." - }, - "sourceConnectionIdentifier" : { - "type" : "string", - "description" : "The identifier of the queue/connection from which the flowfile was pulled to genereate this event. May be null if the queue/connection is unknown or the flowfile was generated from this event." - } - } - }, - "ProvenanceEventEntity" : { - "type" : "object", - "properties" : { - "provenanceEvent" : { - "$ref" : "#/definitions/ProvenanceEventDTO" - } - }, - "xml" : { - "name" : "provenanceEventEntity" - } - }, - "ProvenanceLinkDTO" : { - "type" : "object", - "properties" : { - "sourceId" : { - "type" : "string", - "description" : "The source node id of the link." - }, - "targetId" : { - "type" : "string", - "description" : "The target node id of the link." - }, - "flowFileUuid" : { - "type" : "string", - "description" : "The flowfile uuid that traversed the link." - }, - "timestamp" : { - "type" : "string", - "description" : "The timestamp of the link (based on the destination)." - }, - "millis" : { - "type" : "integer", - "format" : "int64", - "description" : "The timestamp of this link in milliseconds." - } - } - }, - "ProvenanceNodeDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the node." - }, - "flowFileUuid" : { - "type" : "string", - "description" : "The uuid of the flowfile associated with the provenance event." - }, - "parentUuids" : { - "type" : "array", - "description" : "The uuid of the parent flowfiles of the provenance event.", - "items" : { - "type" : "string" - } - }, - "childUuids" : { - "type" : "array", - "description" : "The uuid of the childrent flowfiles of the provenance event.", - "items" : { - "type" : "string" - } - }, - "clusterNodeIdentifier" : { - "type" : "string", - "description" : "The identifier of the node that this event/flowfile originated from." - }, - "type" : { - "type" : "string", - "description" : "The type of the node.", - "enum" : [ "FLOWFILE", "EVENT" ] - }, - "eventType" : { - "type" : "string", - "description" : "If the type is EVENT, this is the type of event." - }, - "millis" : { - "type" : "integer", - "format" : "int64", - "description" : "The timestamp of the node in milliseconds." - }, - "timestamp" : { - "type" : "string", - "description" : "The timestamp of the node formatted." - } - } - }, - "ProvenanceOptionsDTO" : { - "type" : "object", - "properties" : { - "searchableFields" : { - "type" : "array", - "description" : "The available searchable field for the NiFi.", - "items" : { - "$ref" : "#/definitions/ProvenanceSearchableFieldDTO" - } - } - } - }, - "ProvenanceOptionsEntity" : { - "type" : "object", - "properties" : { - "provenanceOptions" : { - "$ref" : "#/definitions/ProvenanceOptionsDTO" - } - }, - "xml" : { - "name" : "provenanceOptionsEntity" - } - }, - "ProvenanceRequestDTO" : { - "type" : "object", - "properties" : { - "searchTerms" : { - "type" : "object", - "description" : "The search terms used to perform the search.", - "additionalProperties" : { - "$ref" : "#/definitions/ProvenanceSearchValueDTO" - } - }, - "clusterNodeId" : { - "type" : "string", - "description" : "The id of the node in the cluster where this provenance originated." - }, - "startDate" : { - "type" : "string", - "description" : "The earliest event time to include in the query." - }, - "endDate" : { - "type" : "string", - "description" : "The latest event time to include in the query." - }, - "minimumFileSize" : { - "type" : "string", - "description" : "The minimum file size to include in the query." - }, - "maximumFileSize" : { - "type" : "string", - "description" : "The maximum file size to include in the query." - }, - "maxResults" : { - "type" : "integer", - "format" : "int32", - "description" : "The maximum number of results to include." - }, - "summarize" : { - "type" : "boolean", - "description" : "Whether or not to summarize provenance events returned. This property is false by default." - }, - "incrementalResults" : { - "type" : "boolean", - "description" : "Whether or not incremental results are returned. If false, provenance events are only returned once the query completes. This property is true by default." - } - } - }, - "ProvenanceResultsDTO" : { - "type" : "object", - "properties" : { - "provenanceEvents" : { - "type" : "array", - "description" : "The provenance events that matched the search criteria.", - "items" : { - "$ref" : "#/definitions/ProvenanceEventDTO" - } - }, - "total" : { - "type" : "string", - "description" : "The total number of results formatted." - }, - "totalCount" : { - "type" : "integer", - "format" : "int64", - "description" : "The total number of results." - }, - "generated" : { - "type" : "string", - "description" : "Then the search was performed." - }, - "oldestEvent" : { - "type" : "string", - "description" : "The oldest event available in the provenance repository." - }, - "timeOffset" : { - "type" : "integer", - "format" : "int32", - "description" : "The time offset of the server that's used for event time." - }, - "errors" : { - "type" : "array", - "description" : "Any errors that occurred while performing the provenance request.", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - } - } - }, - "ProvenanceSearchValueDTO" : { - "type" : "object", - "properties" : { - "value" : { - "type" : "string", - "description" : "The search value." - }, - "inverse" : { - "type" : "boolean", - "description" : "Query for all except for search value." - } - } - }, - "ProvenanceSearchableFieldDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the searchable field." - }, - "field" : { - "type" : "string", - "description" : "The searchable field." - }, - "label" : { - "type" : "string", - "description" : "The label for the searchable field." - }, - "type" : { - "type" : "string", - "description" : "The type of the searchable field." - } - } - }, - "QueueSizeDTO" : { - "type" : "object", - "properties" : { - "byteCount" : { - "type" : "integer", - "format" : "int64", - "description" : "The size of objects in a queue." - }, - "objectCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The count of objects in a queue." - } - } - }, - "RegistryClientEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "component" : { - "$ref" : "#/definitions/RegistryDTO" - } - }, - "xml" : { - "name" : "registryClientEntity" - } - }, - "RegistryClientsEntity" : { - "type" : "object", - "properties" : { - "registries" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/RegistryClientEntity" - } - } - }, - "xml" : { - "name" : "registryClientsEntity" - } - }, - "RegistryDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The registry identifier" - }, - "name" : { - "type" : "string", - "description" : "The registry name" - }, - "description" : { - "type" : "string", - "description" : "The registry description" - }, - "uri" : { - "type" : "string", - "description" : "The registry URI" - } - } - }, - "Relationship" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The name of the relationship" - }, - "description" : { - "type" : "string", - "description" : "The description of the relationship" - } - } - }, - "RelationshipDTO" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The relationship name." - }, - "description" : { - "type" : "string", - "description" : "The relationship description." - }, - "autoTerminate" : { - "type" : "boolean", - "description" : "Whether or not flowfiles sent to this relationship should auto terminate." - }, - "retry" : { - "type" : "boolean", - "description" : "Whether or not flowfiles sent to this relationship should retry." - } - } - }, - "RemotePortRunStatusEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "state" : { - "type" : "string", - "description" : "The run status of the RemotePort.", - "enum" : [ "TRANSMITTING", "STOPPED" ] - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - } - }, - "xml" : { - "name" : "entity" - } - }, - "RemoteProcessGroupContentsDTO" : { - "type" : "object", - "properties" : { - "inputPorts" : { - "type" : "array", - "description" : "The input ports to which data can be sent.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/RemoteProcessGroupPortDTO" - } - }, - "outputPorts" : { - "type" : "array", - "description" : "The output ports from which data can be retrieved.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/RemoteProcessGroupPortDTO" - } - } - } - }, - "RemoteProcessGroupDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "versionedComponentId" : { - "type" : "string", - "description" : "The ID of the corresponding component that is under version control" - }, - "parentGroupId" : { - "type" : "string", - "description" : "The id of parent process group of this component if applicable." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "targetUri" : { - "type" : "string", - "description" : "The target URI of the remote process group. If target uri is not set, but uris are set, then returns the first url in the urls. If neither target uri nor uris are set, then returns null." - }, - "targetUris" : { - "type" : "string", - "description" : "The target URI of the remote process group. If target uris is not set but target uri is set, then returns a collection containing the single target uri. If neither target uris nor uris are set, then returns null." - }, - "targetSecure" : { - "type" : "boolean", - "description" : "Whether the target is running securely." - }, - "name" : { - "type" : "string", - "description" : "The name of the remote process group." - }, - "comments" : { - "type" : "string", - "description" : "The comments for the remote process group." - }, - "communicationsTimeout" : { - "type" : "string", - "description" : "The time period used for the timeout when communicating with the target." - }, - "yieldDuration" : { - "type" : "string", - "description" : "When yielding, this amount of time must elapse before the remote process group is scheduled again." - }, - "transportProtocol" : { - "type" : "string" - }, - "localNetworkInterface" : { - "type" : "string", - "description" : "The local network interface to send/receive data. If not specified, any local address is used. If clustered, all nodes must have an interface with this identifier." - }, - "proxyHost" : { - "type" : "string" - }, - "proxyPort" : { - "type" : "integer", - "format" : "int32" - }, - "proxyUser" : { - "type" : "string" - }, - "proxyPassword" : { - "type" : "string" - }, - "authorizationIssues" : { - "type" : "array", - "description" : "Any remote authorization issues for the remote process group.", - "items" : { - "type" : "string" - } - }, - "validationErrors" : { - "type" : "array", - "description" : "The validation errors for the remote process group. These validation errors represent the problems with the remote process group that must be resolved before it can transmit.", - "items" : { - "type" : "string" - } - }, - "transmitting" : { - "type" : "boolean", - "description" : "Whether the remote process group is actively transmitting." - }, - "inputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of remote input ports currently available on the target." - }, - "outputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of remote output ports currently available on the target." - }, - "activeRemoteInputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of active remote input ports." - }, - "inactiveRemoteInputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of inactive remote input ports." - }, - "activeRemoteOutputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of active remote output ports." - }, - "inactiveRemoteOutputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of inactive remote output ports." - }, - "flowRefreshed" : { - "type" : "string", - "description" : "The timestamp when this remote process group was last refreshed." - }, - "contents" : { - "description" : "The contents of the remote process group. Will contain available input/output ports.", - "$ref" : "#/definitions/RemoteProcessGroupContentsDTO" - } - } - }, - "RemoteProcessGroupEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "component" : { - "$ref" : "#/definitions/RemoteProcessGroupDTO" - }, - "status" : { - "description" : "The status of the remote process group.", - "$ref" : "#/definitions/RemoteProcessGroupStatusDTO" - }, - "inputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of remote input ports currently available on the target." - }, - "outputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of remote output ports currently available on the target." - }, - "operatePermissions" : { - "description" : "The permissions for this component operations.", - "$ref" : "#/definitions/PermissionsDTO" - } - }, - "xml" : { - "name" : "remoteProcessGroupEntity" - } - }, - "RemoteProcessGroupPortDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the port." - }, - "targetId" : { - "type" : "string", - "description" : "The id of the target port." - }, - "versionedComponentId" : { - "type" : "string", - "description" : "The ID of the corresponding component that is under version control" - }, - "groupId" : { - "type" : "string", - "description" : "The id of the remote process group that the port resides in." - }, - "name" : { - "type" : "string", - "description" : "The name of the target port." - }, - "comments" : { - "type" : "string", - "description" : "The comments as configured on the target port." - }, - "concurrentlySchedulableTaskCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of task that may transmit flowfiles to the target port concurrently." - }, - "transmitting" : { - "type" : "boolean", - "description" : "Whether the remote port is configured for transmission." - }, - "useCompression" : { - "type" : "boolean", - "description" : "Whether the flowfiles are compressed when sent to the target port." - }, - "exists" : { - "type" : "boolean", - "description" : "Whether the target port exists." - }, - "targetRunning" : { - "type" : "boolean", - "description" : "Whether the target port is running." - }, - "connected" : { - "type" : "boolean", - "description" : "Whether the port has either an incoming or outgoing connection." - }, - "batchSettings" : { - "description" : "The batch settings for data transmission.", - "$ref" : "#/definitions/BatchSettingsDTO" - } - } - }, - "RemoteProcessGroupPortEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "remoteProcessGroupPort" : { - "$ref" : "#/definitions/RemoteProcessGroupPortDTO" - }, - "operatePermissions" : { - "description" : "The permissions for this component operations.", - "$ref" : "#/definitions/PermissionsDTO" - } - }, - "xml" : { - "name" : "remoteProcessGroupPortEntity" - } - }, - "RemoteProcessGroupStatusDTO" : { - "type" : "object", - "properties" : { - "groupId" : { - "type" : "string", - "description" : "The unique ID of the process group that the Processor belongs to" - }, - "id" : { - "type" : "string", - "description" : "The unique ID of the Processor" - }, - "name" : { - "type" : "string", - "description" : "The name of the remote process group." - }, - "targetUri" : { - "type" : "string", - "description" : "The URI of the target system." - }, - "transmissionStatus" : { - "type" : "string", - "description" : "The transmission status of the remote process group." - }, - "statsLastRefreshed" : { - "type" : "string", - "description" : "The time the status for the process group was last refreshed." - }, - "validationStatus" : { - "type" : "string", - "description" : "Indicates whether the component is valid, invalid, or still in the process of validating (i.e., it is unknown whether or not the component is valid)", - "enum" : [ "VALID", "INVALID", "VALIDATING" ] - }, - "aggregateSnapshot" : { - "description" : "A status snapshot that represents the aggregate stats of all nodes in the cluster. If the NiFi instance is a standalone instance, rather than a cluster, this represents the stats of the single instance.", - "$ref" : "#/definitions/RemoteProcessGroupStatusSnapshotDTO" - }, - "nodeSnapshots" : { - "type" : "array", - "description" : "A status snapshot for each node in the cluster. If the NiFi instance is a standalone instance, rather than a cluster, this may be null.", - "items" : { - "$ref" : "#/definitions/NodeRemoteProcessGroupStatusSnapshotDTO" - } - } - } - }, - "RemoteProcessGroupStatusEntity" : { - "type" : "object", - "properties" : { - "remoteProcessGroupStatus" : { - "$ref" : "#/definitions/RemoteProcessGroupStatusDTO" - }, - "canRead" : { - "type" : "boolean", - "description" : "Indicates whether the user can read a given resource." - } - }, - "xml" : { - "name" : "remoteProcessGroupStatusEntity" - } - }, - "RemoteProcessGroupStatusSnapshotDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the remote process group." - }, - "groupId" : { - "type" : "string", - "description" : "The id of the parent process group the remote process group resides in." - }, - "name" : { - "type" : "string", - "description" : "The name of the remote process group." - }, - "targetUri" : { - "type" : "string", - "description" : "The URI of the target system." - }, - "transmissionStatus" : { - "type" : "string", - "description" : "The transmission status of the remote process group." - }, - "activeThreadCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of active threads for the remote process group." - }, - "flowFilesSent" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of FlowFiles sent to the remote process group in the last 5 minutes." - }, - "bytesSent" : { - "type" : "integer", - "format" : "int64", - "description" : "The size of the FlowFiles sent to the remote process group in the last 5 minutes." - }, - "sent" : { - "type" : "string", - "description" : "The count/size of the flowfiles sent to the remote process group in the last 5 minutes." - }, - "flowFilesReceived" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of FlowFiles received from the remote process group in the last 5 minutes." - }, - "bytesReceived" : { - "type" : "integer", - "format" : "int64", - "description" : "The size of the FlowFiles received from the remote process group in the last 5 minutes." - }, - "received" : { - "type" : "string", - "description" : "The count/size of the flowfiles received from the remote process group in the last 5 minutes." - } - } - }, - "RemoteProcessGroupStatusSnapshotEntity" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the remote process group." - }, - "remoteProcessGroupStatusSnapshot" : { - "$ref" : "#/definitions/RemoteProcessGroupStatusSnapshotDTO" - }, - "canRead" : { - "type" : "boolean", - "description" : "Indicates whether the user can read a given resource." - } - }, - "xml" : { - "name" : "entity" - } - }, - "RemoteProcessGroupsEntity" : { - "type" : "object", - "properties" : { - "remoteProcessGroups" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/RemoteProcessGroupEntity" - } - } - }, - "xml" : { - "name" : "remoteProcessGroupsEntity" - } - }, - "RemoteQueuePartitionDTO" : { - "type" : "object", - "properties" : { - "totalFlowFileCount" : { - "type" : "integer", - "format" : "int32", - "description" : "Total number of FlowFiles owned by the Connection" - }, - "totalByteCount" : { - "type" : "integer", - "format" : "int64", - "description" : "Total number of bytes that make up the content for the FlowFiles owned by this Connection" - }, - "activeQueueFlowFileCount" : { - "type" : "integer", - "format" : "int32", - "description" : "Total number of FlowFiles that exist in the Connection's Active Queue, immediately available to be offered up to a component" - }, - "activeQueueByteCount" : { - "type" : "integer", - "format" : "int64", - "description" : "Total number of bytes that make up the content for the FlowFiles that are present in the Connection's Active Queue" - }, - "swapFlowFileCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The total number of FlowFiles that are swapped out for this Connection" - }, - "swapByteCount" : { - "type" : "integer", - "format" : "int64", - "description" : "Total number of bytes that make up the content for the FlowFiles that are swapped out to disk for the Connection" - }, - "swapFiles" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of Swap Files that exist for this Connection" - }, - "inFlightFlowFileCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of In-Flight FlowFiles for this Connection. These are FlowFiles that belong to the connection but are currently being operated on by a Processor, Port, etc." - }, - "inFlightByteCount" : { - "type" : "integer", - "format" : "int64", - "description" : "The number bytes that make up the content of the FlowFiles that are In-Flight" - }, - "nodeIdentifier" : { - "type" : "string", - "description" : "The Node Identifier that this queue partition is sending to" - } - } - }, - "ReportingTaskDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "versionedComponentId" : { - "type" : "string", - "description" : "The ID of the corresponding component that is under version control" - }, - "parentGroupId" : { - "type" : "string", - "description" : "The id of parent process group of this component if applicable." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "name" : { - "type" : "string", - "description" : "The name of the reporting task." - }, - "type" : { - "type" : "string", - "description" : "The fully qualified type of the reporting task." - }, - "bundle" : { - "description" : "The details of the artifact that bundled this processor type.", - "$ref" : "#/definitions/BundleDTO" - }, - "state" : { - "type" : "string", - "description" : "The state of the reporting task.", - "enum" : [ "RUNNING", "STOPPED", "DISABLED" ] - }, - "comments" : { - "type" : "string", - "description" : "The comments of the reporting task." - }, - "persistsState" : { - "type" : "boolean", - "description" : "Whether the reporting task persists state." - }, - "restricted" : { - "type" : "boolean", - "description" : "Whether the reporting task requires elevated privileges." - }, - "deprecated" : { - "type" : "boolean", - "description" : "Whether the reporting task has been deprecated." - }, - "multipleVersionsAvailable" : { - "type" : "boolean", - "description" : "Whether the reporting task has multiple versions available." - }, - "supportsSensitiveDynamicProperties" : { - "type" : "boolean", - "description" : "Whether the reporting task supports sensitive dynamic properties." - }, - "schedulingPeriod" : { - "type" : "string", - "description" : "The frequency with which to schedule the reporting task. The format of the value willd epend on the valud of the schedulingStrategy." - }, - "schedulingStrategy" : { - "type" : "string", - "description" : "The scheduling strategy that determines how the schedulingPeriod value should be interpreted." - }, - "defaultSchedulingPeriod" : { - "type" : "object", - "description" : "The default scheduling period for the different scheduling strategies.", - "additionalProperties" : { - "type" : "string" - } - }, - "properties" : { - "type" : "object", - "description" : "The properties of the reporting task.", - "additionalProperties" : { - "type" : "string" - } - }, - "descriptors" : { - "type" : "object", - "description" : "The descriptors for the reporting tasks properties.", - "additionalProperties" : { - "$ref" : "#/definitions/PropertyDescriptorDTO" - } - }, - "sensitiveDynamicPropertyNames" : { - "type" : "array", - "description" : "Set of sensitive dynamic property names", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - }, - "customUiUrl" : { - "type" : "string", - "description" : "The URL for the custom configuration UI for the reporting task." - }, - "annotationData" : { - "type" : "string", - "description" : "The annotation data for the repoting task. This is how the custom UI relays configuration to the reporting task." - }, - "validationErrors" : { - "type" : "array", - "description" : "Gets the validation errors from the reporting task. These validation errors represent the problems with the reporting task that must be resolved before it can be scheduled to run.", - "items" : { - "type" : "string" - } - }, - "validationStatus" : { - "type" : "string", - "description" : "Indicates whether the Processor is valid, invalid, or still in the process of validating (i.e., it is unknown whether or not the Processor is valid)", - "enum" : [ "VALID", "INVALID", "VALIDATING" ] - }, - "activeThreadCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of active threads for the reporting task." - }, - "extensionMissing" : { - "type" : "boolean", - "description" : "Whether the underlying extension is missing." - } - } - }, - "ReportingTaskDefinition" : { - "type" : "object", - "required" : [ "type" ], - "properties" : { - "group" : { - "type" : "string", - "description" : "The group name of the bundle that provides the referenced type." - }, - "artifact" : { - "type" : "string", - "description" : "The artifact name of the bundle that provides the referenced type." - }, - "version" : { - "type" : "string", - "description" : "The version 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." - }, - "buildInfo" : { - "description" : "The build metadata for this component", - "$ref" : "#/definitions/BuildInfo" - }, - "providedApiImplementations" : { - "type" : "array", - "description" : "If this type represents a provider for an interface, this lists the APIs it implements", - "items" : { - "$ref" : "#/definitions/DefinedType" - } - }, - "tags" : { - "type" : "array", - "description" : "The tags associated with this type", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - }, - "deprecated" : { - "type" : "boolean", - "description" : "Whether or not the component has been deprecated" - }, - "deprecationReason" : { - "type" : "string", - "description" : "If this component has been deprecated, this optional field can be used to provide an explanation" - }, - "restricted" : { - "type" : "boolean", - "description" : "Whether or not the component has a general restriction" - }, - "restrictedExplanation" : { - "type" : "string", - "description" : "An optional description of the general restriction" - }, - "explicitRestrictions" : { - "type" : "array", - "description" : "Explicit restrictions that indicate a require permission to use the component", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/Restriction" - } - }, - "propertyDescriptors" : { - "type" : "object", - "description" : "Descriptions of configuration properties applicable to this component.", - "additionalProperties" : { - "$ref" : "#/definitions/PropertyDescriptor" - } - }, - "supportsDynamicProperties" : { - "type" : "boolean", - "description" : "Whether or not this component makes use of dynamic (user-set) properties." - }, - "supportedSchedulingStrategies" : { - "type" : "array", - "description" : "The supported scheduling strategies, such as TIME_DRIVER or CRON.", - "items" : { - "type" : "string" - } - }, - "defaultSchedulingStrategy" : { - "type" : "string", - "description" : "The default scheduling strategy for the reporting task." - }, - "defaultSchedulingPeriodBySchedulingStrategy" : { - "type" : "object", - "description" : "The default scheduling period for each scheduling strategy. The scheduling period is expected to be a time period, such as \"30 sec\".", - "additionalProperties" : { - "type" : "string" - } - } - } - }, - "ReportingTaskEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "component" : { - "$ref" : "#/definitions/ReportingTaskDTO" - }, - "operatePermissions" : { - "description" : "The permissions for this component operations.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "status" : { - "description" : "The status for this ReportingTask.", - "$ref" : "#/definitions/ReportingTaskStatusDTO" - } - }, - "xml" : { - "name" : "reportingTaskEntity" - } - }, - "ReportingTaskRunStatusEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "state" : { - "type" : "string", - "description" : "The run status of the ReportingTask.", - "enum" : [ "RUNNING", "STOPPED" ] - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - } - }, - "xml" : { - "name" : "entity" - } - }, - "ReportingTaskStatusDTO" : { - "type" : "object", - "properties" : { - "runStatus" : { - "type" : "string", - "description" : "The run status of this ReportingTask", - "enum" : [ "RUNNING", "STOPPED", "DISABLED" ] - }, - "validationStatus" : { - "type" : "string", - "description" : "Indicates whether the component is valid, invalid, or still in the process of validating (i.e., it is unknown whether or not the component is valid)", - "enum" : [ "VALID", "INVALID", "VALIDATING" ] - }, - "activeThreadCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of active threads for the component." - } - } - }, - "ReportingTaskTypesEntity" : { - "type" : "object", - "properties" : { - "reportingTaskTypes" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/DocumentedTypeDTO" - } - } - }, - "xml" : { - "name" : "reportingTaskTypesEntity" - } - }, - "ReportingTasksEntity" : { - "type" : "object", - "properties" : { - "reportingTasks" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ReportingTaskEntity" - } - } - }, - "xml" : { - "name" : "reportingTasksEntity" - } - }, - "RepositoryUsageDTO" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The name of the repository" - }, - "fileStoreHash" : { - "type" : "string", - "description" : "A SHA-256 hash of the File Store name/path that is used to store the repository's data. This information is exposed as a hash in order to avoid exposing potentially sensitive information that is not generally relevant. What is typically relevant is whether or not multiple repositories on the same node are using the same File Store, as this indicates that the repositories are competing for the resources of the backing disk/storage mechanism." - }, - "freeSpace" : { - "type" : "string", - "description" : "Amount of free space." - }, - "totalSpace" : { - "type" : "string", - "description" : "Amount of total space." - }, - "freeSpaceBytes" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes of free space." - }, - "totalSpaceBytes" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes of total space." - }, - "utilization" : { - "type" : "string", - "description" : "Utilization of this storage location." - } - } - }, - "RequiredPermissionDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The required sub-permission necessary for this restriction." - }, - "label" : { - "type" : "string", - "description" : "The label for the required sub-permission necessary for this restriction." - } - } - }, - "ResourceDTO" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The identifier of the resource." - }, - "name" : { - "type" : "string", - "description" : "The name of the resource." - } - } - }, - "ResourcesEntity" : { - "type" : "object", - "properties" : { - "resources" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/ResourceDTO" - } - } - }, - "xml" : { - "name" : "resourcesEntity" - } - }, - "Restriction" : { - "type" : "object", - "properties" : { - "requiredPermission" : { - "type" : "string", - "description" : "The permission required for this restriction" - }, - "explanation" : { - "type" : "string", - "description" : "The explanation of this restriction" - } - } - }, - "RevisionDTO" : { - "type" : "object", - "properties" : { - "clientId" : { - "type" : "string", - "description" : "A client identifier used to make a request. By including a client identifier, the API can allow multiple requests without needing the current revision. Due to the asynchronous nature of requests/responses this was implemented to allow the client to make numerous requests without having to wait for the previous response to come back" - }, - "version" : { - "type" : "integer", - "format" : "int64", - "description" : "NiFi employs an optimistic locking strategy where the client must include a revision in their request when performing an update. In a response to a mutable flow request, this field represents the updated base version." - }, - "lastModifier" : { - "type" : "string", - "description" : "The user that last modified the flow." - } - } - }, - "RevisionInfo" : { - "type" : "object", - "properties" : { - "clientId" : { - "type" : "string", - "description" : "A client identifier used to make a request. By including a client identifier, the API can allow multiple requests without needing the current revision. Due to the asynchronous nature of requests/responses this was implemented to allow the client to make numerous requests without having to wait for the previous response to come back." - }, - "version" : { - "type" : "integer", - "format" : "int64", - "description" : "NiFi Registry employs an optimistic locking strategy where the client must include a revision in their request when performing an update. In a response to a mutable flow request, this field represents the updated base version." - }, - "lastModifier" : { - "type" : "string", - "description" : "The user that last modified the entity.", - "readOnly" : true - } - }, - "description" : "The revision information for an entity managed through the REST API." - }, - "RunStatusDetailsRequestEntity" : { - "type" : "object", - "properties" : { - "processorIds" : { - "type" : "array", - "description" : "The IDs of all processors whose run status details should be provided", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - } - }, - "xml" : { - "name" : "runStatusDetailsRequest" - } - }, - "RuntimeManifest" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "A unique identifier for the manifest" - }, - "agentType" : { - "type" : "string", - "description" : "The type of the runtime binary, e.g., 'minifi-java' or 'minifi-cpp'" - }, - "version" : { - "type" : "string", - "description" : "The version of the runtime binary, e.g., '1.0.1'" - }, - "buildInfo" : { - "description" : "Build summary for this runtime binary", - "$ref" : "#/definitions/BuildInfo" - }, - "bundles" : { - "type" : "array", - "description" : "All extension bundles included with this runtime", - "items" : { - "$ref" : "#/definitions/Bundle" - } - }, - "schedulingDefaults" : { - "description" : "Scheduling defaults for components defined in this manifest", - "$ref" : "#/definitions/SchedulingDefaults" - } - } - }, - "RuntimeManifestEntity" : { - "type" : "object", - "properties" : { - "runtimeManifest" : { - "$ref" : "#/definitions/RuntimeManifest" - } - }, - "xml" : { - "name" : "runtimeManifestEntity" - } - }, - "ScheduleComponentsEntity" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the ProcessGroup" - }, - "state" : { - "type" : "string", - "description" : "The desired state of the descendant components", - "enum" : [ "RUNNING", "STOPPED", "ENABLED", "DISABLED" ] - }, - "components" : { - "type" : "object", - "description" : "Optional components to schedule. If not specified, all authorized descendant components will be used.", - "additionalProperties" : { - "$ref" : "#/definitions/RevisionDTO" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - } - }, - "xml" : { - "name" : "scheduleComponentEntity" - } - }, - "SchedulingDefaults" : { - "type" : "object", - "properties" : { - "defaultSchedulingStrategy" : { - "type" : "string", - "description" : "The name of the default scheduling strategy", - "enum" : [ "EVENT_DRIVEN", "TIMER_DRIVEN", "PRIMARY_NODE_ONLY", "CRON_DRIVEN" ] - }, - "defaultSchedulingPeriodMillis" : { - "type" : "integer", - "format" : "int64", - "description" : "The default scheduling period in milliseconds" - }, - "penalizationPeriodMillis" : { - "type" : "integer", - "format" : "int64", - "description" : "The default penalization period in milliseconds" - }, - "yieldDurationMillis" : { - "type" : "integer", - "format" : "int64", - "description" : "The default yield duration in milliseconds" - }, - "defaultRunDurationNanos" : { - "type" : "integer", - "format" : "int64", - "description" : "The default run duration in nano-seconds" - }, - "defaultMaxConcurrentTasks" : { - "type" : "string", - "description" : "The default concurrent tasks" - }, - "defaultConcurrentTasksBySchedulingStrategy" : { - "type" : "object", - "description" : "The default concurrent tasks for each scheduling strategy", - "additionalProperties" : { - "type" : "integer", - "format" : "int32" - } - }, - "defaultSchedulingPeriodsBySchedulingStrategy" : { - "type" : "object", - "description" : "The default scheduling period for each scheduling strategy", - "additionalProperties" : { - "type" : "string" - } - } - } - }, - "SearchResultGroupDTO" : { - "type" : "object", - "required" : [ "id" ], - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the group." - }, - "name" : { - "type" : "string", - "description" : "The name of the group." - } - } - }, - "SearchResultsDTO" : { - "type" : "object", - "properties" : { - "processorResults" : { - "type" : "array", - "description" : "The processors that matched the search.", - "items" : { - "$ref" : "#/definitions/ComponentSearchResultDTO" - } - }, - "connectionResults" : { - "type" : "array", - "description" : "The connections that matched the search.", - "items" : { - "$ref" : "#/definitions/ComponentSearchResultDTO" - } - }, - "processGroupResults" : { - "type" : "array", - "description" : "The process groups that matched the search.", - "items" : { - "$ref" : "#/definitions/ComponentSearchResultDTO" - } - }, - "inputPortResults" : { - "type" : "array", - "description" : "The input ports that matched the search.", - "items" : { - "$ref" : "#/definitions/ComponentSearchResultDTO" - } - }, - "outputPortResults" : { - "type" : "array", - "description" : "The output ports that matched the search.", - "items" : { - "$ref" : "#/definitions/ComponentSearchResultDTO" - } - }, - "remoteProcessGroupResults" : { - "type" : "array", - "description" : "The remote process groups that matched the search.", - "items" : { - "$ref" : "#/definitions/ComponentSearchResultDTO" - } - }, - "funnelResults" : { - "type" : "array", - "description" : "The funnels that matched the search.", - "items" : { - "$ref" : "#/definitions/ComponentSearchResultDTO" - } - }, - "labelResults" : { - "type" : "array", - "description" : "The labels that matched the search.", - "items" : { - "$ref" : "#/definitions/ComponentSearchResultDTO" - } - }, - "controllerServiceNodeResults" : { - "type" : "array", - "description" : "The controller service nodes that matched the search", - "items" : { - "$ref" : "#/definitions/ComponentSearchResultDTO" - } - }, - "parameterContextResults" : { - "type" : "array", - "description" : "The parameter contexts that matched the search.", - "items" : { - "$ref" : "#/definitions/ComponentSearchResultDTO" - } - }, - "parameterResults" : { - "type" : "array", - "description" : "The parameters that matched the search.", - "items" : { - "$ref" : "#/definitions/ComponentSearchResultDTO" - } - } - } - }, - "SearchResultsEntity" : { - "type" : "object", - "properties" : { - "searchResultsDTO" : { - "$ref" : "#/definitions/SearchResultsDTO" - } - }, - "xml" : { - "name" : "searchResultsEntity" - } - }, - "SnippetDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the snippet." - }, - "uri" : { - "type" : "string", - "description" : "The URI of the snippet." - }, - "parentGroupId" : { - "type" : "string", - "description" : "The group id for the components in the snippet." - }, - "processGroups" : { - "type" : "object", - "description" : "The ids of the process groups in this snippet. These ids will be populated within each response. They can be specified when creating a snippet. However, once a snippet has been created its contents cannot be modified (these ids are ignored during update requests).", - "additionalProperties" : { - "$ref" : "#/definitions/RevisionDTO" - } - }, - "remoteProcessGroups" : { - "type" : "object", - "description" : "The ids of the remote process groups in this snippet. These ids will be populated within each response. They can be specified when creating a snippet. However, once a snippet has been created its contents cannot be modified (these ids are ignored during update requests).", - "additionalProperties" : { - "$ref" : "#/definitions/RevisionDTO" - } - }, - "processors" : { - "type" : "object", - "description" : "The ids of the processors in this snippet. These ids will be populated within each response. They can be specified when creating a snippet. However, once a snippet has been created its contents cannot be modified (these ids are ignored during update requests).", - "additionalProperties" : { - "$ref" : "#/definitions/RevisionDTO" - } - }, - "inputPorts" : { - "type" : "object", - "description" : "The ids of the input ports in this snippet. These ids will be populated within each response. They can be specified when creating a snippet. However, once a snippet has been created its contents cannot be modified (these ids are ignored during update requests).", - "additionalProperties" : { - "$ref" : "#/definitions/RevisionDTO" - } - }, - "outputPorts" : { - "type" : "object", - "description" : "The ids of the output ports in this snippet. These ids will be populated within each response. They can be specified when creating a snippet. However, once a snippet has been created its contents cannot be modified (these ids are ignored during update requests).", - "additionalProperties" : { - "$ref" : "#/definitions/RevisionDTO" - } - }, - "connections" : { - "type" : "object", - "description" : "The ids of the connections in this snippet. These ids will be populated within each response. They can be specified when creating a snippet. However, once a snippet has been created its contents cannot be modified (these ids are ignored during update requests).", - "additionalProperties" : { - "$ref" : "#/definitions/RevisionDTO" - } - }, - "labels" : { - "type" : "object", - "description" : "The ids of the labels in this snippet. These ids will be populated within each response. They can be specified when creating a snippet. However, once a snippet has been created its contents cannot be modified (these ids are ignored during update requests).", - "additionalProperties" : { - "$ref" : "#/definitions/RevisionDTO" - } - }, - "funnels" : { - "type" : "object", - "description" : "The ids of the funnels in this snippet. These ids will be populated within each response. They can be specified when creating a snippet. However, once a snippet has been created its contents cannot be modified (these ids are ignored during update requests).", - "additionalProperties" : { - "$ref" : "#/definitions/RevisionDTO" - } - } - } - }, - "SnippetEntity" : { - "type" : "object", - "properties" : { - "snippet" : { - "description" : "The snippet.", - "$ref" : "#/definitions/SnippetDTO" - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - } - }, - "xml" : { - "name" : "snippetEntity" - } - }, - "StartVersionControlRequestEntity" : { - "type" : "object", - "properties" : { - "versionedFlow" : { - "description" : "The versioned flow", - "$ref" : "#/definitions/VersionedFlowDTO" - }, - "processGroupRevision" : { - "description" : "The Revision of the Process Group under Version Control", - "$ref" : "#/definitions/RevisionDTO" - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - } - }, - "xml" : { - "name" : "startVersionControlRequestEntity" - } - }, - "StateEntryDTO" : { - "type" : "object", - "properties" : { - "key" : { - "type" : "string", - "description" : "The key for this state." - }, - "value" : { - "type" : "string", - "description" : "The value for this state." - }, - "clusterNodeId" : { - "type" : "string", - "description" : "The identifier for the node where the state originated." - }, - "clusterNodeAddress" : { - "type" : "string", - "description" : "The label for the node where the state originated." - } - } - }, - "StateMapDTO" : { - "type" : "object", - "properties" : { - "scope" : { - "type" : "string", - "description" : "The scope of this StateMap." - }, - "totalEntryCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The total number of state entries. When the state map is lengthy, only of portion of the entries are returned." - }, - "state" : { - "type" : "array", - "description" : "The state.", - "items" : { - "$ref" : "#/definitions/StateEntryDTO" - } - } - } - }, - "StatusDescriptorDTO" : { - "type" : "object", - "properties" : { - "field" : { - "type" : "string", - "description" : "The name of the status field." - }, - "label" : { - "type" : "string", - "description" : "The label for the status field." - }, - "description" : { - "type" : "string", - "description" : "The description of the status field." - }, - "formatter" : { - "type" : "string", - "description" : "The formatter for the status descriptor." - } - } - }, - "StatusHistoryDTO" : { - "type" : "object", - "properties" : { - "generated" : { - "type" : "string", - "description" : "When the status history was generated." - }, - "componentDetails" : { - "type" : "object", - "description" : "A Map of key/value pairs that describe the component that the status history belongs to", - "additionalProperties" : { - "type" : "string" - } - }, - "fieldDescriptors" : { - "type" : "array", - "description" : "The Descriptors that provide information on each of the metrics provided in the status history", - "items" : { - "$ref" : "#/definitions/StatusDescriptorDTO" - } - }, - "aggregateSnapshots" : { - "type" : "array", - "description" : "A list of StatusSnapshotDTO objects that provide the actual metric values for the component. If the NiFi instance is clustered, this will represent the aggregate status across all nodes. If the NiFi instance is not clustered, this will represent the status of the entire NiFi instance.", - "items" : { - "$ref" : "#/definitions/StatusSnapshotDTO" - } - }, - "nodeSnapshots" : { - "type" : "array", - "description" : "The NodeStatusSnapshotsDTO objects that provide the actual metric values for the component, for each node. If the NiFi instance is not clustered, this value will be null.", - "items" : { - "$ref" : "#/definitions/NodeStatusSnapshotsDTO" - } - } - } - }, - "StatusHistoryEntity" : { - "type" : "object", - "properties" : { - "statusHistory" : { - "$ref" : "#/definitions/StatusHistoryDTO" - }, - "canRead" : { - "type" : "boolean", - "description" : "Indicates whether the user can read a given resource." - } - }, - "xml" : { - "name" : "statusHistoryEntity" - } - }, - "StatusSnapshotDTO" : { - "type" : "object", - "properties" : { - "timestamp" : { - "type" : "string", - "format" : "date-time", - "description" : "The timestamp of the snapshot." - }, - "statusMetrics" : { - "type" : "object", - "description" : "The status metrics.", - "additionalProperties" : { - "type" : "integer", - "format" : "int64" - } - } - } - }, - "StorageUsageDTO" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The identifier of this storage location. The identifier will correspond to the identifier keyed in the storage configuration." - }, - "freeSpace" : { - "type" : "string", - "description" : "Amount of free space." - }, - "totalSpace" : { - "type" : "string", - "description" : "Amount of total space." - }, - "usedSpace" : { - "type" : "string", - "description" : "Amount of used space." - }, - "freeSpaceBytes" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes of free space." - }, - "totalSpaceBytes" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes of total space." - }, - "usedSpaceBytes" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes of used space." - }, - "utilization" : { - "type" : "string", - "description" : "Utilization of this storage location." - } - } - }, - "StreamingOutput" : { - "type" : "object" - }, - "SubmitReplayRequestEntity" : { - "type" : "object", - "properties" : { - "eventId" : { - "type" : "integer", - "format" : "int64", - "description" : "The event identifier" - }, - "clusterNodeId" : { - "type" : "string", - "description" : "The identifier of the node where to submit the replay request." - } - }, - "xml" : { - "name" : "copySnippetRequestEntity" - } - }, - "SystemDiagnosticsDTO" : { - "type" : "object", - "properties" : { - "aggregateSnapshot" : { - "description" : "A systems diagnostic snapshot that represents the aggregate values of all nodes in the cluster. If the NiFi instance is a standalone instance, rather than a cluster, this represents the stats of the single instance.", - "$ref" : "#/definitions/SystemDiagnosticsSnapshotDTO" - }, - "nodeSnapshots" : { - "type" : "array", - "description" : "A systems diagnostics snapshot for each node in the cluster. If the NiFi instance is a standalone instance, rather than a cluster, this may be null.", - "items" : { - "$ref" : "#/definitions/NodeSystemDiagnosticsSnapshotDTO" - } - } - } - }, - "SystemDiagnosticsEntity" : { - "type" : "object", - "properties" : { - "systemDiagnostics" : { - "$ref" : "#/definitions/SystemDiagnosticsDTO" - } - }, - "xml" : { - "name" : "systemDiagnosticsEntity" - } - }, - "SystemDiagnosticsSnapshotDTO" : { - "type" : "object", - "properties" : { - "totalNonHeap" : { - "type" : "string", - "description" : "Total size of non heap." - }, - "totalNonHeapBytes" : { - "type" : "integer", - "format" : "int64", - "description" : "Total number of bytes allocated to the JVM not used for heap" - }, - "usedNonHeap" : { - "type" : "string", - "description" : "Amount of use non heap." - }, - "usedNonHeapBytes" : { - "type" : "integer", - "format" : "int64", - "description" : "Total number of bytes used by the JVM not in the heap space" - }, - "freeNonHeap" : { - "type" : "string", - "description" : "Amount of free non heap." - }, - "freeNonHeapBytes" : { - "type" : "integer", - "format" : "int64", - "description" : "Total number of free non-heap bytes available to the JVM" - }, - "maxNonHeap" : { - "type" : "string", - "description" : "Maximum size of non heap." - }, - "maxNonHeapBytes" : { - "type" : "integer", - "format" : "int64", - "description" : "The maximum number of bytes that the JVM can use for non-heap purposes" - }, - "nonHeapUtilization" : { - "type" : "string", - "description" : "Utilization of non heap." - }, - "totalHeap" : { - "type" : "string", - "description" : "Total size of heap." - }, - "totalHeapBytes" : { - "type" : "integer", - "format" : "int64", - "description" : "The total number of bytes that are available for the JVM heap to use" - }, - "usedHeap" : { - "type" : "string", - "description" : "Amount of used heap." - }, - "usedHeapBytes" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes of JVM heap that are currently being used" - }, - "freeHeap" : { - "type" : "string", - "description" : "Amount of free heap." - }, - "freeHeapBytes" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes that are allocated to the JVM heap but not currently being used" - }, - "maxHeap" : { - "type" : "string", - "description" : "Maximum size of heap." - }, - "maxHeapBytes" : { - "type" : "integer", - "format" : "int64", - "description" : "The maximum number of bytes that can be used by the JVM" - }, - "heapUtilization" : { - "type" : "string", - "description" : "Utilization of heap." - }, - "availableProcessors" : { - "type" : "integer", - "format" : "int32", - "description" : "Number of available processors if supported by the underlying system." - }, - "processorLoadAverage" : { - "type" : "number", - "format" : "double", - "description" : "The processor load average if supported by the underlying system." - }, - "totalThreads" : { - "type" : "integer", - "format" : "int32", - "description" : "Total number of threads." - }, - "daemonThreads" : { - "type" : "integer", - "format" : "int32", - "description" : "Number of daemon threads." - }, - "uptime" : { - "type" : "string", - "description" : "The uptime of the Java virtual machine" - }, - "flowFileRepositoryStorageUsage" : { - "description" : "The flowfile repository storage usage.", - "$ref" : "#/definitions/StorageUsageDTO" - }, - "contentRepositoryStorageUsage" : { - "type" : "array", - "description" : "The content repository storage usage.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/StorageUsageDTO" - } - }, - "provenanceRepositoryStorageUsage" : { - "type" : "array", - "description" : "The provenance repository storage usage.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/StorageUsageDTO" - } - }, - "garbageCollection" : { - "type" : "array", - "description" : "The garbage collection details.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/GarbageCollectionDTO" - } - }, - "statsLastRefreshed" : { - "type" : "string", - "description" : "When the diagnostics were generated." - }, - "versionInfo" : { - "description" : "The nifi, os, java, and build version information", - "$ref" : "#/definitions/VersionInfoDTO" - } - } - }, - "TemplateDTO" : { - "type" : "object", - "properties" : { - "uri" : { - "type" : "string", - "description" : "The URI for the template." - }, - "id" : { - "type" : "string", - "description" : "The id of the template." - }, - "groupId" : { - "type" : "string", - "description" : "The id of the Process Group that the template belongs to." - }, - "name" : { - "type" : "string", - "description" : "The name of the template." - }, - "description" : { - "type" : "string", - "description" : "The description of the template." - }, - "timestamp" : { - "type" : "string", - "description" : "The timestamp when this template was created." - }, - "encodingVersion" : { - "type" : "string", - "xml" : { - "name" : "encoding-version", - "attribute" : true - }, - "description" : "The encoding version of this template." - }, - "snippet" : { - "description" : "The contents of the template.", - "$ref" : "#/definitions/FlowSnippetDTO" - } - }, - "xml" : { - "name" : "template" - } - }, - "TemplateEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "template" : { - "$ref" : "#/definitions/TemplateDTO" - } - }, - "xml" : { - "name" : "templateEntity" - } - }, - "TemplatesEntity" : { - "type" : "object", - "properties" : { - "templates" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/TemplateEntity" - } - }, - "generated" : { - "type" : "string", - "description" : "When this content was generated." - } - }, - "xml" : { - "name" : "templatesEntity" - } - }, - "TenantDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "versionedComponentId" : { - "type" : "string", - "description" : "The ID of the corresponding component that is under version control" - }, - "parentGroupId" : { - "type" : "string", - "description" : "The id of parent process group of this component if applicable." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "identity" : { - "type" : "string", - "description" : "The identity of the tenant." - }, - "configurable" : { - "type" : "boolean", - "description" : "Whether this tenant is configurable." - } - } - }, - "TenantEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "component" : { - "$ref" : "#/definitions/TenantDTO" - } - }, - "xml" : { - "name" : "tenantEntity" - } - }, - "TenantsEntity" : { - "type" : "object", - "properties" : { - "users" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/TenantEntity" - } - }, - "userGroups" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/TenantEntity" - } - } - }, - "xml" : { - "name" : "tenantsEntity" - } - }, - "ThreadDumpDTO" : { - "type" : "object", - "properties" : { - "nodeId" : { - "type" : "string", - "description" : "The ID of the node in the cluster" - }, - "nodeAddress" : { - "type" : "string", - "description" : "The address of the node in the cluster" - }, - "apiPort" : { - "type" : "integer", - "format" : "int32", - "description" : "The port the node is listening for API requests." - }, - "stackTrace" : { - "type" : "string", - "description" : "The stack trace for the thread" - }, - "threadName" : { - "type" : "string", - "description" : "The name of the thread" - }, - "threadActiveMillis" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of milliseconds that the thread has been executing in the Processor" - }, - "taskTerminated" : { - "type" : "boolean", - "description" : "Indicates whether or not the user has requested that the task be terminated. If this is true, it may indicate that the thread is in a state where it will continue running indefinitely without returning." - } - } - }, - "TransactionResultEntity" : { - "type" : "object", - "properties" : { - "flowFileSent" : { - "type" : "integer", - "format" : "int32" - }, - "responseCode" : { - "type" : "integer", - "format" : "int32" - }, - "message" : { - "type" : "string" - } - }, - "xml" : { - "name" : "transactionResultEntity" - } - }, - "UpdateControllerServiceReferenceRequestEntity" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The identifier of the Controller Service." - }, - "state" : { - "type" : "string", - "description" : "The new state of the references for the controller service.", - "enum" : [ "ENABLED", "DISABLED", "RUNNING", "STOPPED" ] - }, - "referencingComponentRevisions" : { - "type" : "object", - "description" : "The revisions for all referencing components.", - "additionalProperties" : { - "$ref" : "#/definitions/RevisionDTO" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "uiOnly" : { - "type" : "boolean", - "description" : "Indicates whether or not the response should only include fields necessary for rendering the NiFi User Interface. As such, when this value is set to true, some fields may be returned as null values, and the selected fields may change at any time without notice. As a result, this value should not be set to true by any client other than the UI." - } - }, - "xml" : { - "name" : "updateControllerServiceReferenceRequestEntity" - } - }, - "UserDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "versionedComponentId" : { - "type" : "string", - "description" : "The ID of the corresponding component that is under version control" - }, - "parentGroupId" : { - "type" : "string", - "description" : "The id of parent process group of this component if applicable." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "identity" : { - "type" : "string", - "description" : "The identity of the tenant." - }, - "configurable" : { - "type" : "boolean", - "description" : "Whether this tenant is configurable." - }, - "userGroups" : { - "type" : "array", - "description" : "The groups to which the user belongs. This field is read only and it provided for convenience.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/TenantEntity" - } - }, - "accessPolicies" : { - "type" : "array", - "description" : "The access policies this user belongs to.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/AccessPolicySummaryEntity" - } - } - } - }, - "UserEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "component" : { - "$ref" : "#/definitions/UserDTO" - } - }, - "xml" : { - "name" : "userEntity" - } - }, - "UserGroupDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "versionedComponentId" : { - "type" : "string", - "description" : "The ID of the corresponding component that is under version control" - }, - "parentGroupId" : { - "type" : "string", - "description" : "The id of parent process group of this component if applicable." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "identity" : { - "type" : "string", - "description" : "The identity of the tenant." - }, - "configurable" : { - "type" : "boolean", - "description" : "Whether this tenant is configurable." - }, - "users" : { - "type" : "array", - "description" : "The users that belong to the user group.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/TenantEntity" - } - }, - "accessPolicies" : { - "type" : "array", - "description" : "The access policies this user group belongs to. This field was incorrectly defined as an AccessPolicyEntity. For compatibility reasons the field will remain of this type, however only the fields that are present in the AccessPolicySummaryEntity will be populated here.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/AccessPolicyEntity" - } - } - } - }, - "UserGroupEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "component" : { - "$ref" : "#/definitions/UserGroupDTO" - } - }, - "xml" : { - "name" : "userGroupEntity" - } - }, - "UserGroupsEntity" : { - "type" : "object", - "properties" : { - "userGroups" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/UserGroupEntity" - } - } - }, - "xml" : { - "name" : "userGroupsEntity" - } - }, - "UsersEntity" : { - "type" : "object", - "properties" : { - "generated" : { - "type" : "string", - "description" : "When this content was generated." - }, - "users" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/UserEntity" - } - } - }, - "xml" : { - "name" : "usersEntity" - } - }, - "VariableDTO" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The name of the variable" - }, - "value" : { - "type" : "string", - "description" : "The value of the variable" - }, - "processGroupId" : { - "type" : "string", - "description" : "The ID of the Process Group where this Variable is defined" - }, - "affectedComponents" : { - "type" : "array", - "description" : "A set of all components that will be affected if the value of this variable is changed", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/AffectedComponentEntity" - } - } - } - }, - "VariableEntity" : { - "type" : "object", - "properties" : { - "variable" : { - "description" : "The variable information", - "$ref" : "#/definitions/VariableDTO" - }, - "canWrite" : { - "type" : "boolean", - "description" : "Indicates whether the user can write a given resource." - } - }, - "xml" : { - "name" : "variableEntity" - } - }, - "VariableRegistryDTO" : { - "type" : "object", - "properties" : { - "variables" : { - "type" : "array", - "description" : "The variables that are available in this Variable Registry", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VariableEntity" - } - }, - "processGroupId" : { - "type" : "string", - "description" : "The UUID of the Process Group that this Variable Registry belongs to" - } - } - }, - "VariableRegistryEntity" : { - "type" : "object", - "properties" : { - "processGroupRevision" : { - "description" : "The revision of the Process Group that the Variable Registry belongs to", - "$ref" : "#/definitions/RevisionDTO" - }, - "variableRegistry" : { - "description" : "The Variable Registry.", - "$ref" : "#/definitions/VariableRegistryDTO" - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - } - }, - "xml" : { - "name" : "variableRegistryEntity" - } - }, - "VariableRegistryUpdateRequestDTO" : { - "type" : "object", - "properties" : { - "requestId" : { - "type" : "string", - "description" : "The ID of the request" - }, - "uri" : { - "type" : "string", - "description" : "The URI for the request" - }, - "submissionTime" : { - "type" : "string", - "format" : "date-time", - "description" : "The timestamp of when the request was submitted" - }, - "lastUpdated" : { - "type" : "string", - "format" : "date-time", - "description" : "The timestamp of when the request was last updated" - }, - "complete" : { - "type" : "boolean", - "description" : "Whether or not the request is completed" - }, - "failureReason" : { - "type" : "string", - "description" : "The reason for the request failing, or null if the request has not failed" - }, - "percentCompleted" : { - "type" : "integer", - "format" : "int32", - "description" : "A value between 0 and 100 (inclusive) indicating how close the request is to completion" - }, - "state" : { - "type" : "string", - "description" : "A description of the current state of the request" - }, - "updateSteps" : { - "type" : "array", - "description" : "The steps that are required in order to complete the request, along with the status of each", - "items" : { - "$ref" : "#/definitions/VariableRegistryUpdateStepDTO" - } - }, - "processGroupId" : { - "type" : "string", - "description" : "The unique ID of the Process Group that the variable registry belongs to" - }, - "affectedComponents" : { - "type" : "array", - "description" : "A set of all components that will be affected if the value of this variable is changed", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/AffectedComponentEntity" - } - } - } - }, - "VariableRegistryUpdateRequestEntity" : { - "type" : "object", - "properties" : { - "request" : { - "description" : "The Variable Registry Update Request", - "$ref" : "#/definitions/VariableRegistryUpdateRequestDTO" - }, - "processGroupRevision" : { - "description" : "The revision for the Process Group that owns this variable registry.", - "$ref" : "#/definitions/RevisionDTO" - } - }, - "xml" : { - "name" : "variableRegistryUpdateRequestEntity" - } - }, - "VariableRegistryUpdateStepDTO" : { - "type" : "object", - "properties" : { - "description" : { - "type" : "string", - "description" : "Explanation of what happens in this step" - }, - "complete" : { - "type" : "boolean", - "description" : "Whether or not this step has completed" - }, - "failureReason" : { - "type" : "string", - "description" : "An explanation of why this step failed, or null if this step did not fail" - } - } - }, - "VerifyConfigRequestDTO" : { - "type" : "object", - "properties" : { - "requestId" : { - "type" : "string", - "description" : "The ID of the request" - }, - "uri" : { - "type" : "string", - "description" : "The URI for the request" - }, - "submissionTime" : { - "type" : "string", - "format" : "date-time", - "description" : "The timestamp of when the request was submitted" - }, - "lastUpdated" : { - "type" : "string", - "format" : "date-time", - "description" : "The timestamp of when the request was last updated" - }, - "complete" : { - "type" : "boolean", - "description" : "Whether or not the request is completed" - }, - "failureReason" : { - "type" : "string", - "description" : "The reason for the request failing, or null if the request has not failed" - }, - "percentCompleted" : { - "type" : "integer", - "format" : "int32", - "description" : "A value between 0 and 100 (inclusive) indicating how close the request is to completion" - }, - "state" : { - "type" : "string", - "description" : "A description of the current state of the request" - }, - "updateSteps" : { - "type" : "array", - "description" : "The steps that are required in order to complete the request, along with the status of each", - "items" : { - "$ref" : "#/definitions/VerifyConfigUpdateStepDTO" - } - }, - "componentId" : { - "type" : "string", - "description" : "The ID of the component whose configuration was verified" - }, - "properties" : { - "type" : "object", - "description" : "The configured component properties", - "additionalProperties" : { - "type" : "string" - } - }, - "attributes" : { - "type" : "object", - "description" : "FlowFile Attributes that should be used to evaluate Expression Language for resolving property values", - "additionalProperties" : { - "type" : "string" - } - }, - "results" : { - "type" : "array", - "description" : "The Results of the verification", - "items" : { - "$ref" : "#/definitions/ConfigVerificationResultDTO" - } - } - } - }, - "VerifyConfigRequestEntity" : { - "type" : "object", - "properties" : { - "request" : { - "description" : "The request", - "$ref" : "#/definitions/VerifyConfigRequestDTO" - } - }, - "xml" : { - "name" : "verifyConfigRequest" - } - }, - "VerifyConfigUpdateStepDTO" : { - "type" : "object", - "properties" : { - "description" : { - "type" : "string", - "description" : "Explanation of what happens in this step" - }, - "complete" : { - "type" : "boolean", - "description" : "Whether or not this step has completed" - }, - "failureReason" : { - "type" : "string", - "description" : "An explanation of why this step failed, or null if this step did not fail" - } - } - }, - "VersionControlComponentMappingEntity" : { - "type" : "object", - "properties" : { - "versionControlComponentMapping" : { - "type" : "object", - "description" : "The mapping of Versioned Component Identifiers to instance ID's", - "additionalProperties" : { - "type" : "string" - } - }, - "processGroupRevision" : { - "description" : "The revision of the Process Group", - "$ref" : "#/definitions/RevisionDTO" - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "versionControlInformation" : { - "description" : "The Version Control information", - "$ref" : "#/definitions/VersionControlInformationDTO" - } - }, - "xml" : { - "name" : "versionControlComponentMappingEntity" - } - }, - "VersionControlInformationDTO" : { - "type" : "object", - "properties" : { - "groupId" : { - "type" : "string", - "description" : "The ID of the Process Group that is under version control" - }, - "registryId" : { - "type" : "string", - "description" : "The ID of the registry that the flow is stored in" - }, - "registryName" : { - "type" : "string", - "description" : "The name of the registry that the flow is stored in" - }, - "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" - }, - "flowId" : { - "type" : "string", - "description" : "The ID of the flow" - }, - "flowName" : { - "type" : "string", - "description" : "The name of the flow" - }, - "flowDescription" : { - "type" : "string", - "description" : "The description of the flow" - }, - "version" : { - "type" : "integer", - "format" : "int32", - "description" : "The version of the flow" - }, - "state" : { - "type" : "string", - "description" : "The current state of the Process Group, as it relates to the Versioned Flow", - "enum" : [ "LOCALLY_MODIFIED", "STALE", "LOCALLY_MODIFIED_AND_STALE", "UP_TO_DATE", "SYNC_FAILURE" ] - }, - "stateExplanation" : { - "type" : "string", - "description" : "Explanation of why the group is in the specified state" - } - } - }, - "VersionControlInformationEntity" : { - "type" : "object", - "properties" : { - "processGroupRevision" : { - "description" : "The Revision for the Process Group", - "$ref" : "#/definitions/RevisionDTO" - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "versionControlInformation" : { - "description" : "The Version Control information", - "$ref" : "#/definitions/VersionControlInformationDTO" - } - }, - "xml" : { - "name" : "versionControlInformationEntity" - } - }, - "VersionInfoDTO" : { - "type" : "object", - "properties" : { - "niFiVersion" : { - "type" : "string", - "description" : "The version of this NiFi." - }, - "javaVendor" : { - "type" : "string", - "description" : "Java JVM vendor" - }, - "javaVersion" : { - "type" : "string", - "description" : "Java version" - }, - "osName" : { - "type" : "string", - "description" : "Host operating system name" - }, - "osVersion" : { - "type" : "string", - "description" : "Host operating system version" - }, - "osArchitecture" : { - "type" : "string", - "description" : "Host operating system architecture" - }, - "buildTag" : { - "type" : "string", - "description" : "Build tag" - }, - "buildRevision" : { - "type" : "string", - "description" : "Build revision or commit hash" - }, - "buildBranch" : { - "type" : "string", - "description" : "Build branch" - }, - "buildTimestamp" : { - "type" : "string", - "format" : "date-time", - "description" : "Build timestamp" - } - } - }, - "VersionedConnection" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The component's unique identifier" - }, - "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" - }, - "comments" : { - "type" : "string", - "description" : "The user-supplied comments for the component" - }, - "position" : { - "description" : "The component's position on the graph", - "$ref" : "#/definitions/Position" - }, - "source" : { - "description" : "The source of the connection.", - "$ref" : "#/definitions/ConnectableComponent" - }, - "destination" : { - "description" : "The destination of the connection.", - "$ref" : "#/definitions/ConnectableComponent" - }, - "labelIndex" : { - "type" : "integer", - "format" : "int32", - "description" : "The index of the bend point where to place the connection label." - }, - "zIndex" : { - "type" : "integer", - "format" : "int64", - "description" : "The z index of the connection." - }, - "selectedRelationships" : { - "type" : "array", - "description" : "The selected relationship that comprise the connection.", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - }, - "backPressureObjectThreshold" : { - "type" : "integer", - "format" : "int64", - "description" : "The object count threshold for determining when back pressure is applied. Updating this value is a passive change in the sense that it won't impact whether existing files over the limit are affected but it does help feeder processors to stop pushing too much into this work queue." - }, - "backPressureDataSizeThreshold" : { - "type" : "string", - "description" : "The object data size threshold for determining when back pressure is applied. Updating this value is a passive change in the sense that it won't impact whether existing files over the limit are affected but it does help feeder processors to stop pushing too much into this work queue." - }, - "flowFileExpiration" : { - "type" : "string", - "description" : "The amount of time a flow file may be in the flow before it will be automatically aged out of the flow. Once a flow file reaches this age it will be terminated from the flow the next time a processor attempts to start work on it." - }, - "prioritizers" : { - "type" : "array", - "description" : "The comparators used to prioritize the queue.", - "items" : { - "type" : "string" - } - }, - "bends" : { - "type" : "array", - "description" : "The bend points on the connection.", - "items" : { - "$ref" : "#/definitions/Position" - } - }, - "loadBalanceStrategy" : { - "type" : "string", - "description" : "The Strategy to use for load balancing data across the cluster, or null, if no Load Balance Strategy has been specified.", - "enum" : [ "DO_NOT_LOAD_BALANCE", "PARTITION_BY_ATTRIBUTE", "ROUND_ROBIN", "SINGLE_NODE" ] - }, - "partitioningAttribute" : { - "type" : "string", - "description" : "The attribute to use for partitioning data as it is load balanced across the cluster. If the Load Balance Strategy is configured to use PARTITION_BY_ATTRIBUTE, the value returned by this method is the name of the FlowFile Attribute that will be used to determine which node in the cluster should receive a given FlowFile. If the Load Balance Strategy is unset or is set to any other value, the Partitioning Attribute has no effect." - }, - "loadBalanceCompression" : { - "type" : "string", - "description" : "Whether or not compression should be used when transferring FlowFiles between nodes", - "enum" : [ "DO_NOT_COMPRESS", "COMPRESS_ATTRIBUTES_ONLY", "COMPRESS_ATTRIBUTES_AND_CONTENT" ] - }, - "componentType" : { - "type" : "string", - "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE", "REPORTING_TASK", "PARAMETER_CONTEXT", "TEMPLATE" ] - }, - "groupIdentifier" : { - "type" : "string", - "description" : "The ID of the Process Group that this component belongs to" - } - } - }, - "VersionedControllerService" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The component's unique identifier" - }, - "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" - }, - "comments" : { - "type" : "string", - "description" : "The user-supplied comments for the component" - }, - "position" : { - "description" : "The component's position on the graph", - "$ref" : "#/definitions/Position" - }, - "type" : { - "type" : "string", - "description" : "The type of the extension component" - }, - "bundle" : { - "description" : "Information about the bundle from which the component came", - "$ref" : "#/definitions/Bundle" - }, - "properties" : { - "type" : "object", - "description" : "The properties for the component. Properties whose value is not set will only contain the property name.", - "additionalProperties" : { - "type" : "string" - } - }, - "propertyDescriptors" : { - "type" : "object", - "description" : "The property descriptors for the component.", - "additionalProperties" : { - "$ref" : "#/definitions/VersionedPropertyDescriptor" - } - }, - "controllerServiceApis" : { - "type" : "array", - "description" : "Lists the APIs this Controller Service implements.", - "items" : { - "$ref" : "#/definitions/ControllerServiceAPI" - } - }, - "annotationData" : { - "type" : "string", - "description" : "The annotation for the controller service. This is how the custom UI relays configuration to the controller service." - }, - "scheduledState" : { - "type" : "string", - "description" : "The ScheduledState denoting whether the Controller Service is ENABLED or DISABLED", - "enum" : [ "ENABLED", "DISABLED", "RUNNING" ] - }, - "bulletinLevel" : { - "type" : "string", - "description" : "The level at which the controller service will report bulletins." - }, - "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", "PARAMETER_CONTEXT", "TEMPLATE" ] - }, - "groupIdentifier" : { - "type" : "string", - "description" : "The ID of the Process Group that this component belongs to" - } - } - }, - "VersionedFlow" : { - "type" : "object", - "required" : [ "bucketIdentifier", "name", "type" ], - "properties" : { - "link" : { - "description" : "An WebLink to this entity.", - "readOnly" : true, - "$ref" : "#/definitions/JaxbLink" - }, - "identifier" : { - "type" : "string", - "description" : "An ID to uniquely identify this object.", - "readOnly" : true - }, - "name" : { - "type" : "string", - "description" : "The name of the item." - }, - "description" : { - "type" : "string", - "description" : "A description of the item." - }, - "bucketIdentifier" : { - "type" : "string", - "description" : "The identifier of the bucket this items belongs to. This cannot be changed after the item is created." - }, - "bucketName" : { - "type" : "string", - "description" : "The name of the bucket this items belongs to.", - "readOnly" : true - }, - "createdTimestamp" : { - "type" : "integer", - "format" : "int64", - "description" : "The timestamp of when the item was created, as milliseconds since epoch.", - "readOnly" : true, - "minimum" : 1 - }, - "modifiedTimestamp" : { - "type" : "integer", - "format" : "int64", - "description" : "The timestamp of when the item was last modified, as milliseconds since epoch.", - "readOnly" : true, - "minimum" : 1 - }, - "type" : { - "type" : "string", - "description" : "The type of item.", - "enum" : [ "Flow", "Bundle" ] - }, - "permissions" : { - "description" : "The access that the current user has to the bucket containing this item.", - "readOnly" : true, - "$ref" : "#/definitions/Permissions" - }, - "versionCount" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of versions of this flow.", - "readOnly" : true, - "minimum" : 0 - }, - "revision" : { - "description" : "The revision of this entity used for optimistic-locking during updates.", - "readOnly" : true, - "$ref" : "#/definitions/RevisionInfo" - } - } - }, - "VersionedFlowCoordinates" : { - "type" : "object", - "properties" : { - "registryUrl" : { - "type" : "string", - "description" : "The URL of the Flow Registry that contains the flow" - }, - "bucketId" : { - "type" : "string", - "description" : "The UUID of the bucket that the flow resides in" - }, - "flowId" : { - "type" : "string", - "description" : "The UUID of the flow" - }, - "version" : { - "type" : "integer", - "format" : "int32", - "description" : "The version of the flow" - }, - "latest" : { - "type" : "boolean", - "description" : "Whether or not these coordinates point to the latest version of the flow" - } - } - }, - "VersionedFlowDTO" : { - "type" : "object", - "properties" : { - "registryId" : { - "type" : "string", - "description" : "The ID of the registry that the flow is tracked to" - }, - "bucketId" : { - "type" : "string", - "description" : "The ID of the bucket where the flow is stored" - }, - "flowId" : { - "type" : "string", - "description" : "The ID of the flow" - }, - "flowName" : { - "type" : "string", - "description" : "The name of the flow" - }, - "description" : { - "type" : "string", - "description" : "A description of the flow" - }, - "comments" : { - "type" : "string", - "description" : "Comments for the changeset" - }, - "action" : { - "type" : "string", - "description" : "The action being performed", - "enum" : [ "COMMIT", "FORCE_COMMIT" ] - } - } - }, - "VersionedFlowEntity" : { - "type" : "object", - "properties" : { - "versionedFlow" : { - "description" : "The versioned flow", - "$ref" : "#/definitions/VersionedFlowDTO" - } - }, - "xml" : { - "name" : "versionedFlowEntity" - } - }, - "VersionedFlowSnapshot" : { - "type" : "object", - "required" : [ "flowContents", "snapshotMetadata" ], - "properties" : { - "snapshotMetadata" : { - "description" : "The metadata for this snapshot", - "$ref" : "#/definitions/VersionedFlowSnapshotMetadata" - }, - "flowContents" : { - "description" : "The contents of the versioned flow", - "$ref" : "#/definitions/VersionedProcessGroup" - }, - "externalControllerServices" : { - "type" : "object", - "description" : "The information about controller services that exist outside this versioned flow, but are referenced by components within the versioned flow.", - "additionalProperties" : { - "$ref" : "#/definitions/ExternalControllerServiceReference" - } - }, - "parameterContexts" : { - "type" : "object", - "description" : "The parameter contexts referenced by process groups in the flow contents. The mapping is from the name of the context to the context instance, and it is expected that any context in this map is referenced by at least one process group in this flow.", - "additionalProperties" : { - "$ref" : "#/definitions/VersionedParameterContext" - } - }, - "flowEncodingVersion" : { - "type" : "string", - "description" : "The optional encoding version of the flow contents." - }, - "flow" : { - "description" : "The flow this snapshot is for", - "readOnly" : true, - "$ref" : "#/definitions/VersionedFlow" - }, - "bucket" : { - "description" : "The bucket where the flow is located", - "readOnly" : true, - "$ref" : "#/definitions/Bucket" - }, - "latest" : { - "type" : "boolean" - } - } - }, - "VersionedFlowSnapshotEntity" : { - "type" : "object", - "properties" : { - "versionedFlowSnapshot" : { - "description" : "The versioned flow snapshot", - "$ref" : "#/definitions/VersionedFlowSnapshot" - }, - "processGroupRevision" : { - "description" : "The Revision of the Process Group under Version Control", - "$ref" : "#/definitions/RevisionDTO" - }, - "registryId" : { - "type" : "string", - "description" : "The ID of the Registry that this flow belongs to" - }, - "updateDescendantVersionedFlows" : { - "type" : "boolean", - "description" : "If the Process Group to be updated has a child or descendant Process Group that is also under Version Control, this specifies whether or not the contents of that child/descendant Process Group should be updated." - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - } - }, - "xml" : { - "name" : "versionedFlowSnapshotEntity" - } - }, - "VersionedFlowSnapshotMetadata" : { - "type" : "object", - "required" : [ "bucketIdentifier", "flowIdentifier", "version" ], - "properties" : { - "link" : { - "description" : "An WebLink to this entity.", - "readOnly" : true, - "$ref" : "#/definitions/JaxbLink" - }, - "bucketIdentifier" : { - "type" : "string", - "description" : "The identifier of the bucket this snapshot belongs to." - }, - "flowIdentifier" : { - "type" : "string", - "description" : "The identifier of the flow this snapshot belongs to." - }, - "version" : { - "type" : "integer", - "format" : "int32", - "description" : "The version of this snapshot of the flow.", - "minimum" : -1 - }, - "timestamp" : { - "type" : "integer", - "format" : "int64", - "description" : "The timestamp when the flow was saved, as milliseconds since epoch.", - "readOnly" : true, - "minimum" : 1 - }, - "author" : { - "type" : "string", - "description" : "The user that created this snapshot of the flow.", - "readOnly" : true - }, - "comments" : { - "type" : "string", - "description" : "The comments provided by the user when creating the snapshot." - } - } - }, - "VersionedFlowSnapshotMetadataEntity" : { - "type" : "object", - "properties" : { - "versionedFlowSnapshotMetadata" : { - "description" : "The collection of versioned flow snapshot metadata", - "$ref" : "#/definitions/VersionedFlowSnapshotMetadata" - }, - "registryId" : { - "type" : "string", - "description" : "The ID of the Registry that this flow belongs to" - } - }, - "xml" : { - "name" : "versionedFlowSnapshotMetadataEntity" - } - }, - "VersionedFlowSnapshotMetadataSetEntity" : { - "type" : "object", - "properties" : { - "versionedFlowSnapshotMetadataSet" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedFlowSnapshotMetadataEntity" - } - } - }, - "xml" : { - "name" : "versionedFlowSnapshotMetadataSetEntity" - } - }, - "VersionedFlowUpdateRequestDTO" : { - "type" : "object", - "properties" : { - "requestId" : { - "type" : "string", - "description" : "The unique ID of this request." - }, - "processGroupId" : { - "type" : "string", - "description" : "The unique ID of the Process Group being updated" - }, - "uri" : { - "type" : "string", - "description" : "The URI for future requests to this drop request." - }, - "lastUpdated" : { - "type" : "string", - "description" : "The last time this request was updated." - }, - "complete" : { - "type" : "boolean", - "description" : "Whether or not this request has completed" - }, - "failureReason" : { - "type" : "string", - "description" : "An explanation of why this request failed, or null if this request has not failed" - }, - "percentCompleted" : { - "type" : "integer", - "format" : "int32", - "description" : "The percentage complete for the request, between 0 and 100" - }, - "state" : { - "type" : "string", - "description" : "The state of the request" - }, - "versionControlInformation" : { - "description" : "The VersionControlInformation that describes where the Versioned Flow is located; this may not be populated until the request is completed.", - "$ref" : "#/definitions/VersionControlInformationDTO" - } - } - }, - "VersionedFlowUpdateRequestEntity" : { - "type" : "object", - "properties" : { - "processGroupRevision" : { - "description" : "The revision for the Process Group being updated.", - "$ref" : "#/definitions/RevisionDTO" - }, - "request" : { - "description" : "The Flow Update Request", - "$ref" : "#/definitions/VersionedFlowUpdateRequestDTO" - } - }, - "xml" : { - "name" : "versionedFlowUpdateRequestEntity" - } - }, - "VersionedFlowsEntity" : { - "type" : "object", - "properties" : { - "versionedFlows" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedFlowEntity" - } - } - }, - "xml" : { - "name" : "versionedFlowsEntity" - } - }, - "VersionedFunnel" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The component's unique identifier" - }, - "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" - }, - "comments" : { - "type" : "string", - "description" : "The user-supplied comments for the component" - }, - "position" : { - "description" : "The component's position on the graph", - "$ref" : "#/definitions/Position" - }, - "componentType" : { - "type" : "string", - "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE", "REPORTING_TASK", "PARAMETER_CONTEXT", "TEMPLATE" ] - }, - "groupIdentifier" : { - "type" : "string", - "description" : "The ID of the Process Group that this component belongs to" - } - } - }, - "VersionedLabel" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The component's unique identifier" - }, - "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" - }, - "comments" : { - "type" : "string", - "description" : "The user-supplied comments for the component" - }, - "position" : { - "description" : "The component's position on the graph", - "$ref" : "#/definitions/Position" - }, - "label" : { - "type" : "string", - "description" : "The text that appears in the label." - }, - "zIndex" : { - "type" : "integer", - "format" : "int64", - "description" : "The z index of the connection." - }, - "width" : { - "type" : "number", - "format" : "double", - "description" : "The width of the label in pixels when at a 1:1 scale." - }, - "height" : { - "type" : "number", - "format" : "double", - "description" : "The height of the label in pixels when at a 1:1 scale." - }, - "style" : { - "type" : "object", - "description" : "The styles for this label (font-size : 12px, background-color : #eee, etc).", - "additionalProperties" : { - "type" : "string" - } - }, - "componentType" : { - "type" : "string", - "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE", "REPORTING_TASK", "PARAMETER_CONTEXT", "TEMPLATE" ] - }, - "groupIdentifier" : { - "type" : "string", - "description" : "The ID of the Process Group that this component belongs to" - } - } - }, - "VersionedParameter" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The name of the parameter" - }, - "description" : { - "type" : "string", - "description" : "The description of the param" - }, - "sensitive" : { - "type" : "boolean", - "description" : "Whether or not the parameter value is sensitive" - }, - "value" : { - "type" : "string", - "description" : "The value of the parameter" - } - } - }, - "VersionedParameterContext" : { - "type" : "object", - "properties" : { - "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" - }, - "comments" : { - "type" : "string", - "description" : "The user-supplied comments for the component" - }, - "position" : { - "description" : "The component's position on the graph", - "$ref" : "#/definitions/Position" - }, - "parameters" : { - "type" : "array", - "description" : "The parameters in the context", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedParameter" - } - }, - "inheritedParameterContexts" : { - "type" : "array", - "description" : "The names of additional parameter contexts from which to inherit parameters", - "items" : { - "type" : "string" - } - }, - "description" : { - "type" : "string", - "description" : "The description of the parameter context" - }, - "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", "PARAMETER_CONTEXT", "TEMPLATE" ] - }, - "groupIdentifier" : { - "type" : "string", - "description" : "The ID of the Process Group that this component belongs to" - } - } - }, - "VersionedPort" : { - "type" : "object", - "properties" : { - "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" - }, - "comments" : { - "type" : "string", - "description" : "The user-supplied comments for the component" - }, - "position" : { - "description" : "The component's position on the graph", - "$ref" : "#/definitions/Position" - }, - "type" : { - "type" : "string", - "description" : "The type of port.", - "enum" : [ "INPUT_PORT", "OUTPUT_PORT" ] - }, - "concurrentlySchedulableTaskCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of tasks that should be concurrently scheduled for the port." - }, - "scheduledState" : { - "type" : "string", - "description" : "The scheduled state of the component", - "enum" : [ "ENABLED", "DISABLED", "RUNNING" ] - }, - "allowRemoteAccess" : { - "type" : "boolean", - "description" : "Whether or not this port allows remote access for site-to-site" - }, - "componentType" : { - "type" : "string", - "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE", "REPORTING_TASK", "PARAMETER_CONTEXT", "TEMPLATE" ] - }, - "groupIdentifier" : { - "type" : "string", - "description" : "The ID of the Process Group that this component belongs to" - } - } - }, - "VersionedProcessGroup" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The component's unique identifier" - }, - "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" - }, - "comments" : { - "type" : "string", - "description" : "The user-supplied comments for the component" - }, - "position" : { - "description" : "The component's position on the graph", - "$ref" : "#/definitions/Position" - }, - "processGroups" : { - "type" : "array", - "description" : "The child Process Groups", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedProcessGroup" - } - }, - "remoteProcessGroups" : { - "type" : "array", - "description" : "The Remote Process Groups", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedRemoteProcessGroup" - } - }, - "processors" : { - "type" : "array", - "description" : "The Processors", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedProcessor" - } - }, - "inputPorts" : { - "type" : "array", - "description" : "The Input Ports", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedPort" - } - }, - "outputPorts" : { - "type" : "array", - "description" : "The Output Ports", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedPort" - } - }, - "connections" : { - "type" : "array", - "description" : "The Connections", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedConnection" - } - }, - "labels" : { - "type" : "array", - "description" : "The Labels", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedLabel" - } - }, - "funnels" : { - "type" : "array", - "description" : "The Funnels", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedFunnel" - } - }, - "controllerServices" : { - "type" : "array", - "description" : "The Controller Services", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedControllerService" - } - }, - "versionedFlowCoordinates" : { - "description" : "The coordinates where the remote flow is stored, or null if the Process Group is not directly under Version Control", - "$ref" : "#/definitions/VersionedFlowCoordinates" - }, - "variables" : { - "type" : "object", - "description" : "The Variables in the Variable Registry for this Process Group (not including any ancestor or descendant Process Groups)", - "additionalProperties" : { - "type" : "string" - } - }, - "parameterContextName" : { - "type" : "string", - "description" : "The name of the parameter context used by this process group" - }, - "defaultFlowFileExpiration" : { - "type" : "string", - "description" : "The default FlowFile Expiration for this Process Group." - }, - "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." - }, - "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." - }, - "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", "PARAMETER_CONTEXT", "TEMPLATE" ] - }, - "flowFileConcurrency" : { - "type" : "string", - "description" : "The configured FlowFile Concurrency for the Process Group" - }, - "flowFileOutboundPolicy" : { - "type" : "string", - "description" : "The FlowFile Outbound Policy for the Process Group" - }, - "groupIdentifier" : { - "type" : "string", - "description" : "The ID of the Process Group that this component belongs to" - } - } - }, - "VersionedProcessor" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The component's unique identifier" - }, - "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" - }, - "comments" : { - "type" : "string", - "description" : "The user-supplied comments for the component" - }, - "position" : { - "description" : "The component's position on the graph", - "$ref" : "#/definitions/Position" - }, - "type" : { - "type" : "string", - "description" : "The type of the extension component" - }, - "bundle" : { - "description" : "Information about the bundle from which the component came", - "$ref" : "#/definitions/Bundle" - }, - "properties" : { - "type" : "object", - "description" : "The properties for the component. Properties whose value is not set will only contain the property name.", - "additionalProperties" : { - "type" : "string" - } - }, - "propertyDescriptors" : { - "type" : "object", - "description" : "The property descriptors for the component.", - "additionalProperties" : { - "$ref" : "#/definitions/VersionedPropertyDescriptor" - } - }, - "style" : { - "type" : "object", - "description" : "Stylistic data for rendering in a UI", - "additionalProperties" : { - "type" : "string" - } - }, - "annotationData" : { - "type" : "string", - "description" : "The annotation data for the processor used to relay configuration between a custom UI and the procesosr." - }, - "schedulingPeriod" : { - "type" : "string", - "description" : "The frequency with which to schedule the processor. The format of the value will depend on th value of schedulingStrategy." - }, - "schedulingStrategy" : { - "type" : "string", - "description" : "Indicates whether the processor should be scheduled to run in event or timer driven mode." - }, - "executionNode" : { - "type" : "string", - "description" : "Indicates the node where the process will execute." - }, - "penaltyDuration" : { - "type" : "string", - "description" : "The amout of time that is used when the process penalizes a flowfile." - }, - "yieldDuration" : { - "type" : "string", - "description" : "The amount of time that must elapse before this processor is scheduled again after yielding." - }, - "bulletinLevel" : { - "type" : "string", - "description" : "The level at which the processor will report bulletins." - }, - "runDurationMillis" : { - "type" : "integer", - "format" : "int64", - "description" : "The run duration for the processor in milliseconds." - }, - "concurrentlySchedulableTaskCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of tasks that should be concurrently schedule for the processor. If the processor doesn't allow parallol processing then any positive input will be ignored." - }, - "autoTerminatedRelationships" : { - "type" : "array", - "description" : "The names of all relationships that cause a flow file to be terminated if the relationship is not connected elsewhere. This property differs from the 'isAutoTerminate' property of the RelationshipDTO in that the RelationshipDTO is meant to depict the current configuration, whereas this property can be set in a DTO when updating a Processor in order to change which Relationships should be auto-terminated.", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - }, - "scheduledState" : { - "type" : "string", - "description" : "The scheduled state of the component", - "enum" : [ "ENABLED", "DISABLED", "RUNNING" ] - }, - "retryCount" : { - "type" : "integer", - "format" : "int32", - "description" : "Overall number of retries." - }, - "retriedRelationships" : { - "type" : "array", - "description" : "All the relationships should be retried.", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - }, - "backoffMechanism" : { - "type" : "string", - "description" : "Determines whether the FlowFile should be penalized or the processor should be yielded between retries.", - "enum" : [ "PENALIZE_FLOWFILE", "YIELD_PROCESSOR" ] - }, - "maxBackoffPeriod" : { - "type" : "string", - "description" : "Maximum amount of time to be waited during a retry period." - }, - "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", "PARAMETER_CONTEXT", "TEMPLATE" ] - }, - "groupIdentifier" : { - "type" : "string", - "description" : "The ID of the Process Group that this component belongs to" - } - } - }, - "VersionedPropertyDescriptor" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The name of the property" - }, - "displayName" : { - "type" : "string", - "description" : "The display name of the property" - }, - "identifiesControllerService" : { - "type" : "boolean", - "description" : "Whether or not the property provides the identifier of a Controller Service" - }, - "sensitive" : { - "type" : "boolean", - "description" : "Whether or not the property is considered sensitive" - }, - "resourceDefinition" : { - "description" : "Returns the Resource Definition that defines which type(s) of resource(s) this property references, if any", - "$ref" : "#/definitions/VersionedResourceDefinition" - } - } - }, - "VersionedRemoteGroupPort" : { - "type" : "object", - "properties" : { - "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" - }, - "comments" : { - "type" : "string", - "description" : "The user-supplied comments for the component" - }, - "position" : { - "description" : "The component's position on the graph", - "$ref" : "#/definitions/Position" - }, - "remoteGroupId" : { - "type" : "string", - "description" : "The id of the remote process group that the port resides in." - }, - "concurrentlySchedulableTaskCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of task that may transmit flowfiles to the target port concurrently." - }, - "useCompression" : { - "type" : "boolean", - "description" : "Whether the flowfiles are compressed when sent to the target port." - }, - "batchSize" : { - "description" : "The batch settings for data transmission.", - "$ref" : "#/definitions/BatchSize" - }, - "componentType" : { - "type" : "string", - "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE", "REPORTING_TASK", "PARAMETER_CONTEXT", "TEMPLATE" ] - }, - "targetId" : { - "type" : "string", - "description" : "The ID of the port on the target NiFi instance" - }, - "scheduledState" : { - "type" : "string", - "description" : "The scheduled state of the component", - "enum" : [ "ENABLED", "DISABLED", "RUNNING" ] - }, - "groupIdentifier" : { - "type" : "string", - "description" : "The ID of the Process Group that this component belongs to" - } - } - }, - "VersionedRemoteProcessGroup" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The component's unique identifier" - }, - "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" - }, - "comments" : { - "type" : "string", - "description" : "The user-supplied comments for the component" - }, - "position" : { - "description" : "The component's position on the graph", - "$ref" : "#/definitions/Position" - }, - "targetUri" : { - "type" : "string", - "description" : "[DEPRECATED] The target URI of the remote process group. If target uri is not set, but uris are set, then returns the first uri in the uris. If neither target uri nor uris are set, then returns null." - }, - "targetUris" : { - "type" : "string", - "description" : "The target URIs of the remote process group. If target uris is not set but target uri is set, then returns the single target uri. If neither target uris nor target uri is set, then returns null." - }, - "communicationsTimeout" : { - "type" : "string", - "description" : "The time period used for the timeout when communicating with the target." - }, - "yieldDuration" : { - "type" : "string", - "description" : "When yielding, this amount of time must elapse before the remote process group is scheduled again." - }, - "transportProtocol" : { - "type" : "string", - "description" : "The Transport Protocol that is used for Site-to-Site communications", - "enum" : [ "RAW", "HTTP" ] - }, - "localNetworkInterface" : { - "type" : "string", - "description" : "The local network interface to send/receive data. If not specified, any local address is used. If clustered, all nodes must have an interface with this identifier." - }, - "proxyHost" : { - "type" : "string" - }, - "proxyPort" : { - "type" : "integer", - "format" : "int32" - }, - "proxyUser" : { - "type" : "string" - }, - "inputPorts" : { - "type" : "array", - "description" : "A Set of Input Ports that can be connected to, in order to send data to the remote NiFi instance", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedRemoteGroupPort" - } - }, - "outputPorts" : { - "type" : "array", - "description" : "A Set of Output Ports that can be connected to, in order to pull data from the remote NiFi instance", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedRemoteGroupPort" - } - }, - "componentType" : { - "type" : "string", - "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE", "REPORTING_TASK", "PARAMETER_CONTEXT", "TEMPLATE" ] - }, - "groupIdentifier" : { - "type" : "string", - "description" : "The ID of the Process Group that this component belongs to" - } - } - }, - "VersionedResourceDefinition" : { - "type" : "object", - "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", - "uniqueItems" : true, - "items" : { - "type" : "string", - "enum" : [ "FILE", "DIRECTORY", "TEXT", "URL" ] - } - } - } - } - } -} \ No newline at end of file diff --git a/resources/client_gen/api_defs/nifi-1.19.0rc1.json b/resources/client_gen/api_defs/nifi-1.19.0rc1.json deleted file mode 100644 index 99d7171c..00000000 --- a/resources/client_gen/api_defs/nifi-1.19.0rc1.json +++ /dev/null @@ -1,25846 +0,0 @@ -{ - "swagger" : "2.0", - "info" : { - "description" : "The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and\n stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description,\n definitions of the expected input and output, potential response codes, and the authorizations required\n to invoke each service.", - "version" : "1.19.0", - "title" : "NiFi Rest API", - "contact" : { - "url" : "https://nifi.apache.org", - "email" : "dev@nifi.apache.org" - }, - "license" : { - "name" : "Apache 2.0", - "url" : "http://www.apache.org/licenses/LICENSE-2.0.html" - } - }, - "basePath" : "/nifi-api", - "tags" : [ { - "name" : "access", - "description" : "Endpoints for obtaining an access token or checking access status." - }, { - "name" : "accessoidc", - "description" : "Endpoints for obtaining an access token or checking access status." - }, { - "name" : "connections", - "description" : "Endpoint for managing a Connection." - }, { - "name" : "controller", - "description" : "Provides realtime command and control of this NiFi instance" - }, { - "name" : "controller-services", - "description" : "Endpoint for managing a Controller Service." - }, { - "name" : "counters", - "description" : "Endpoint for managing counters." - }, { - "name" : "data-transfer", - "description" : "Supports data transfers with this NiFi using HTTP based site to site" - }, { - "name" : "flow", - "description" : "Endpoint for accessing the flow structure and component status." - }, { - "name" : "flowfile-queues", - "description" : "Endpoint for managing a FlowFile Queue." - }, { - "name" : "funnel", - "description" : "Endpoint for managing a Funnel." - }, { - "name" : "input-ports", - "description" : "Endpoint for managing an Input Port." - }, { - "name" : "labels", - "description" : "Endpoint for managing a Label." - }, { - "name" : "output-ports", - "description" : "Endpoint for managing an Output Port." - }, { - "name" : "parameter-contexts", - "description" : "Endpoint for managing version control for a flow" - }, { - "name" : "parameter-providers", - "description" : "Endpoint for managing a Parameter Provider." - }, { - "name" : "policies", - "description" : "Endpoint for managing access policies." - }, { - "name" : "process-groups", - "description" : "Endpoint for managing a Process Group." - }, { - "name" : "processors", - "description" : "Endpoint for managing a Processor." - }, { - "name" : "provenance", - "description" : "Endpoint for accessing data flow provenance." - }, { - "name" : "provenance-events", - "description" : "Endpoint for accessing data flow provenance." - }, { - "name" : "remote-process-groups", - "description" : "Endpoint for managing a Remote Process Group." - }, { - "name" : "reporting-tasks", - "description" : "Endpoint for managing a Reporting Task." - }, { - "name" : "resources", - "description" : "Provides the resources in this NiFi that can have access/authorization policies." - }, { - "name" : "site-to-site", - "description" : "Provide access to site to site with this NiFi" - }, { - "name" : "snippets", - "description" : "Endpoint for accessing dataflow snippets." - }, { - "name" : "system-diagnostics", - "description" : "Endpoint for accessing system diagnostics." - }, { - "name" : "templates", - "description" : "Endpoint for managing a Template." - }, { - "name" : "tenants", - "description" : "Endpoint for managing users and user groups." - }, { - "name" : "versions", - "description" : "Endpoint for managing version control for a flow" - } ], - "schemes" : [ "http", "https" ], - "paths" : { - "/access" : { - "get" : { - "tags" : [ "access" ], - "summary" : "Gets the status the client's access", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getAccessStatus", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/AccessStatusEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Unable to determine access status because the client could not be authenticated." - }, - "403" : { - "description" : "Unable to determine access status because the client is not authorized to make this request." - }, - "409" : { - "description" : "Unable to determine access status because NiFi is not in the appropriate state." - }, - "500" : { - "description" : "Unable to determine access status because an unexpected error occurred." - } - } - } - }, - "/access/config" : { - "get" : { - "tags" : [ "access" ], - "summary" : "Retrieves the access configuration for this NiFi", - "description" : "", - "operationId" : "getLoginConfig", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/AccessConfigurationEntity" - } - } - } - } - }, - "/access/kerberos" : { - "post" : { - "tags" : [ "access" ], - "summary" : "Creates a token for accessing the REST API via Kerberos ticket exchange / SPNEGO negotiation", - "description" : "The token returned is formatted as a JSON Web Token (JWT). The token is base64 encoded and comprised of three parts. The header, the body, and the signature. The expiration of the token is a contained within the body. The token can be used in the Authorization header in the format 'Authorization: Bearer '. It is also stored in the browser as a cookie.", - "operationId" : "createAccessTokenFromTicket", - "consumes" : [ "text/plain" ], - "produces" : [ "text/plain" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "NiFi was unable to complete the request because it did not contain a valid Kerberos ticket in the Authorization header. Retry this request after initializing a ticket with kinit and ensuring your browser is configured to support SPNEGO." - }, - "409" : { - "description" : "Unable to create access token because NiFi is not in the appropriate state. (i.e. may not be configured to support Kerberos login." - }, - "500" : { - "description" : "Unable to create access token because an unexpected error occurred." - } - } - } - }, - "/access/knox/callback" : { - "get" : { - "tags" : [ "access" ], - "summary" : "Redirect/callback URI for processing the result of the Apache Knox login sequence.", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "knoxCallback", - "consumes" : [ "*/*" ], - "produces" : [ "*/*" ], - "responses" : { - "default" : { - "description" : "successful operation" - } - } - } - }, - "/access/knox/logout" : { - "get" : { - "tags" : [ "access" ], - "summary" : "Performs a logout in the Apache Knox.", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "knoxLogout", - "consumes" : [ "*/*" ], - "produces" : [ "*/*" ], - "responses" : { - "default" : { - "description" : "successful operation" - } - } - } - }, - "/access/knox/request" : { - "get" : { - "tags" : [ "access" ], - "summary" : "Initiates a request to authenticate through Apache Knox.", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "knoxRequest", - "consumes" : [ "*/*" ], - "produces" : [ "*/*" ], - "responses" : { - "default" : { - "description" : "successful operation" - } - } - } - }, - "/access/logout" : { - "delete" : { - "tags" : [ "access" ], - "summary" : "Performs a logout for other providers that have been issued a JWT.", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "logOut", - "consumes" : [ "*/*" ], - "produces" : [ "*/*" ], - "responses" : { - "200" : { - "description" : "User was logged out successfully." - }, - "401" : { - "description" : "Authentication token provided was empty or not in the correct JWT format." - }, - "500" : { - "description" : "Client failed to log out." - } - } - } - }, - "/access/logout/complete" : { - "get" : { - "tags" : [ "access" ], - "summary" : "Completes the logout sequence by removing the cached Logout Request and Cookie if they existed and redirects to /nifi/login.", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "logOutComplete", - "consumes" : [ "*/*" ], - "produces" : [ "*/*" ], - "responses" : { - "200" : { - "description" : "User was logged out successfully." - }, - "401" : { - "description" : "Authentication token provided was empty or not in the correct JWT format." - }, - "500" : { - "description" : "Client failed to log out." - } - } - } - }, - "/access/oidc/callback" : { - "get" : { - "tags" : [ "accessoidc" ], - "summary" : "Redirect/callback URI for processing the result of the OpenId Connect login sequence.", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "oidcCallback", - "consumes" : [ "*/*" ], - "produces" : [ "*/*" ], - "responses" : { - "default" : { - "description" : "successful operation" - } - } - } - }, - "/access/oidc/exchange" : { - "post" : { - "tags" : [ "accessoidc" ], - "summary" : "Retrieves a JWT following a successful login sequence using the configured OpenId Connect provider.", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "oidcExchange", - "consumes" : [ "*/*" ], - "produces" : [ "text/plain" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - } - } - } - }, - "/access/oidc/logout" : { - "get" : { - "tags" : [ "accessoidc" ], - "summary" : "Performs a logout in the OpenId Provider.", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "oidcLogout", - "consumes" : [ "*/*" ], - "produces" : [ "*/*" ], - "responses" : { - "default" : { - "description" : "successful operation" - } - } - } - }, - "/access/oidc/logoutCallback" : { - "get" : { - "tags" : [ "accessoidc" ], - "summary" : "Redirect/callback URI for processing the result of the OpenId Connect logout sequence.", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "oidcLogoutCallback", - "consumes" : [ "*/*" ], - "produces" : [ "*/*" ], - "responses" : { - "default" : { - "description" : "successful operation" - } - } - } - }, - "/access/oidc/request" : { - "get" : { - "tags" : [ "accessoidc" ], - "summary" : "Initiates a request to authenticate through the configured OpenId Connect provider.", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "oidcRequest", - "consumes" : [ "*/*" ], - "produces" : [ "*/*" ], - "responses" : { - "default" : { - "description" : "successful operation" - } - } - } - }, - "/access/token" : { - "post" : { - "tags" : [ "access" ], - "summary" : "Creates a token for accessing the REST API via username/password", - "description" : "The token returned is formatted as a JSON Web Token (JWT). The token is base64 encoded and comprised of three parts. The header, the body, and the signature. The expiration of the token is a contained within the body. 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", - "consumes" : [ "application/x-www-form-urlencoded" ], - "produces" : [ "text/plain" ], - "parameters" : [ { - "name" : "username", - "in" : "formData", - "required" : false, - "type" : "string" - }, { - "name" : "password", - "in" : "formData", - "required" : false, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "Unable to create access token because NiFi is not in the appropriate state. (i.e. may not be configured to support username/password login." - }, - "500" : { - "description" : "Unable to create access token because an unexpected error occurred." - } - } - } - }, - "/access/token/expiration" : { - "get" : { - "tags" : [ "access" ], - "summary" : "Get expiration for current Access Token", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getAccessTokenExpiration", - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "Access Token Expiration found", - "schema" : { - "$ref" : "#/definitions/AccessTokenExpirationEntity" - } - }, - "401" : { - "description" : "Access Token not authorized" - }, - "409" : { - "description" : "Access Token not resolved" - } - } - } - }, - "/connections/{id}" : { - "get" : { - "tags" : [ "connections" ], - "summary" : "Gets a connection", - "description" : "", - "operationId" : "getConnection", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The connection id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ConnectionEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read Source - /{component-type}/{uuid}" : [ ] - }, { - "Read Destination - /{component-type}/{uuid}" : [ ] - } ] - }, - "put" : { - "tags" : [ "connections" ], - "summary" : "Updates a connection", - "description" : "", - "operationId" : "updateConnection", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The connection id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The connection configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ConnectionEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ConnectionEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write Source - /{component-type}/{uuid}" : [ ] - }, { - "Write Destination - /{component-type}/{uuid}" : [ ] - }, { - "Write New Destination - /{component-type}/{uuid} - if updating Destination" : [ ] - }, { - "Write Process Group - /process-groups/{uuid} - if updating Destination" : [ ] - } ] - }, - "delete" : { - "tags" : [ "connections" ], - "summary" : "Deletes a connection", - "description" : "", - "operationId" : "deleteConnection", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The revision is used to verify the client is working with the latest version of the flow.", - "required" : false, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The connection id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ConnectionEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write Source - /{component-type}/{uuid}" : [ ] - }, { - "Write - Parent Process Group - /process-groups/{uuid}" : [ ] - }, { - "Write Destination - /{component-type}/{uuid}" : [ ] - } ] - } - }, - "/controller-services/{id}" : { - "get" : { - "tags" : [ "controller-services" ], - "summary" : "Gets a controller service", - "description" : "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", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The controller service id.", - "required" : true, - "type" : "string" - }, { - "name" : "uiOnly", - "in" : "query", - "required" : false, - "type" : "boolean", - "default" : false - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ControllerServiceEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /controller-services/{uuid}" : [ ] - } ] - }, - "put" : { - "tags" : [ "controller-services" ], - "summary" : "Updates a controller service", - "description" : "", - "operationId" : "updateControllerService", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The controller service id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The controller service configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ControllerServiceEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ControllerServiceEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /controller-services/{uuid}" : [ ] - }, { - "Read - any referenced Controller Services if this request changes the reference - /controller-services/{uuid}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "controller-services" ], - "summary" : "Deletes a controller service", - "description" : "", - "operationId" : "removeControllerService", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The revision is used to verify the client is working with the latest version of the flow.", - "required" : false, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The controller service id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ControllerServiceEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /controller-services/{uuid}" : [ ] - }, { - "Write - Parent Process Group if scoped by Process Group - /process-groups/{uuid}" : [ ] - }, { - "Write - Controller if scoped by Controller - /controller" : [ ] - }, { - "Read - any referenced Controller Services - /controller-services/{uuid}" : [ ] - } ] - } - }, - "/controller-services/{id}/config/analysis" : { - "post" : { - "tags" : [ "controller-services" ], - "summary" : "Performs analysis of the component's configuration, providing information about which attributes are referenced.", - "description" : "", - "operationId" : "analyzeConfiguration", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The controller service id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The configuration analysis request.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ConfigurationAnalysisEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/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. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /controller-services/{uuid}" : [ ] - } ] - } - }, - "/controller-services/{id}/config/verification-requests" : { - "post" : { - "tags" : [ "controller-services" ], - "summary" : "Performs verification of the Controller Service's configuration", - "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", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The controller service id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The controller service configuration verification request.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/VerifyConfigRequestEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/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. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /controller-services/{uuid}" : [ ] - } ] - } - }, - "/controller-services/{id}/config/verification-requests/{requestId}" : { - "get" : { - "tags" : [ "controller-services" ], - "summary" : "Returns the Verification Request with the given ID", - "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", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The ID of the Controller Service", - "required" : true, - "type" : "string" - }, { - "name" : "requestId", - "in" : "path", - "description" : "The ID of the Verification Request", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/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. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Only the user that submitted the request can get it" : [ ] - } ] - }, - "delete" : { - "tags" : [ "controller-services" ], - "summary" : "Deletes the Verification Request with the given ID", - "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", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The ID of the Controller Service", - "required" : true, - "type" : "string" - }, { - "name" : "requestId", - "in" : "path", - "description" : "The ID of the Verification Request", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/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. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Only the user that submitted the request can remove it" : [ ] - } ] - } - }, - "/controller-services/{id}/descriptors" : { - "get" : { - "tags" : [ "controller-services" ], - "summary" : "Gets a controller service property descriptor", - "description" : "", - "operationId" : "getPropertyDescriptor", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The controller service id.", - "required" : true, - "type" : "string" - }, { - "name" : "propertyName", - "in" : "query", - "description" : "The property name to return the descriptor for.", - "required" : true, - "type" : "string" - }, { - "name" : "sensitive", - "in" : "query", - "description" : "Property Descriptor requested sensitive status", - "required" : false, - "type" : "boolean", - "default" : false - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/PropertyDescriptorEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /controller-services/{uuid}" : [ ] - } ] - } - }, - "/controller-services/{id}/references" : { - "get" : { - "tags" : [ "controller-services" ], - "summary" : "Gets a controller service", - "description" : "", - "operationId" : "getControllerServiceReferences", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The controller service id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ControllerServiceReferencingComponentsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /controller-services/{uuid}" : [ ] - } ] - }, - "put" : { - "tags" : [ "controller-services" ], - "summary" : "Updates a controller services references", - "description" : "", - "operationId" : "updateControllerServiceReferences", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The controller service id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The controller service request update request.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/UpdateControllerServiceReferenceRequestEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ControllerServiceReferencingComponentsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /{component-type}/{uuid} or /operate/{component-type}/{uuid} - For each referencing component specified" : [ ] - } ] - } - }, - "/controller-services/{id}/run-status" : { - "put" : { - "tags" : [ "controller-services" ], - "summary" : "Updates run status of a controller service", - "description" : "", - "operationId" : "updateRunStatus", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The controller service id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The controller service run status.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ControllerServiceRunStatusEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ControllerServiceEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /controller-services/{uuid} or /operation/controller-services/{uuid}" : [ ] - } ] - } - }, - "/controller-services/{id}/state" : { - "get" : { - "tags" : [ "controller-services" ], - "summary" : "Gets the state for a controller service", - "description" : "", - "operationId" : "getState", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The controller service id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ComponentStateEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /controller-services/{uuid}" : [ ] - } ] - } - }, - "/controller-services/{id}/state/clear-requests" : { - "post" : { - "tags" : [ "controller-services" ], - "summary" : "Clears the state for a controller service", - "description" : "", - "operationId" : "clearState", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The controller service id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ComponentStateEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /controller-services/{uuid}" : [ ] - } ] - } - }, - "/controller/bulletin" : { - "post" : { - "tags" : [ "controller" ], - "summary" : "Creates a new bulletin", - "description" : "", - "operationId" : "createBulletin", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The reporting task configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/BulletinEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /controller" : [ ] - } ] - } - }, - "/controller/cluster" : { - "get" : { - "tags" : [ "controller" ], - "summary" : "Gets the contents of the cluster", - "description" : "Returns the contents of the cluster including all nodes and their status.", - "operationId" : "getCluster", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ClusterEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /controller" : [ ] - } ] - } - }, - "/controller/cluster/nodes/{id}" : { - "get" : { - "tags" : [ "controller" ], - "summary" : "Gets a node in the cluster", - "description" : "", - "operationId" : "getNode", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The node id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/NodeEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /controller" : [ ] - } ] - }, - "put" : { - "tags" : [ "controller" ], - "summary" : "Updates a node in the cluster", - "description" : "", - "operationId" : "updateNode", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The node id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The node configuration. The only configuration that will be honored at this endpoint is the status.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/NodeEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/NodeEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /controller" : [ ] - } ] - }, - "delete" : { - "tags" : [ "controller" ], - "summary" : "Removes a node from the cluster", - "description" : "", - "operationId" : "deleteNode", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The node id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/NodeEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /controller" : [ ] - } ] - } - }, - "/controller/config" : { - "get" : { - "tags" : [ "controller" ], - "summary" : "Retrieves the configuration for this NiFi Controller", - "description" : "", - "operationId" : "getControllerConfig", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ControllerConfigurationEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /controller" : [ ] - } ] - }, - "put" : { - "tags" : [ "controller" ], - "summary" : "Retrieves the configuration for this NiFi", - "description" : "", - "operationId" : "updateControllerConfig", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The controller configuration.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ControllerConfigurationEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ControllerConfigurationEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /controller" : [ ] - } ] - } - }, - "/controller/controller-services" : { - "post" : { - "tags" : [ "controller" ], - "summary" : "Creates a new controller service", - "description" : "", - "operationId" : "createControllerService", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The controller service configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ControllerServiceEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ControllerServiceEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /controller" : [ ] - }, { - "Read - any referenced Controller Services - /controller-services/{uuid}" : [ ] - }, { - "Write - if the Controller Service is restricted - /restricted-components" : [ ] - } ] - } - }, - "/controller/history" : { - "delete" : { - "tags" : [ "controller" ], - "summary" : "Purges history", - "description" : "", - "operationId" : "deleteHistory", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "endDate", - "in" : "query", - "description" : "Purge actions before this date/time.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/HistoryEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /controller" : [ ] - } ] - } - }, - "/controller/parameter-providers" : { - "post" : { - "tags" : [ "controller" ], - "summary" : "Creates a new parameter provider", - "description" : "", - "operationId" : "createParameterProvider", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The parameter provider configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ParameterProviderEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/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. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /controller" : [ ] - }, { - "Read - any referenced Controller Services - /controller-services/{uuid}" : [ ] - }, { - "Write - if the Parameter Provider is restricted - /restricted-components" : [ ] - } ] - } - }, - "/controller/registry-clients" : { - "get" : { - "tags" : [ "controller" ], - "summary" : "Gets the listing of available flow registry clients", - "description" : "", - "operationId" : "getFlowRegistryClients", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/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. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - }, - "post" : { - "tags" : [ "controller" ], - "summary" : "Creates a new flow registry client", - "description" : "", - "operationId" : "createFlowRegistryClient", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The flow registry client configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/FlowRegistryClientEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/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. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /controller" : [ ] - } ] - } - }, - "/controller/registry-clients/{id}" : { - "get" : { - "tags" : [ "controller" ], - "summary" : "Gets a flow registry client", - "description" : "", - "operationId" : "getFlowRegistryClient", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The flow registry client id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/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. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /controller" : [ ] - } ] - }, - "put" : { - "tags" : [ "controller" ], - "summary" : "Updates a flow registry client", - "description" : "", - "operationId" : "updateFlowRegistryClient", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The flow registry client id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The flow registry client configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/FlowRegistryClientEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/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. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /controller" : [ ] - } ] - }, - "delete" : { - "tags" : [ "controller" ], - "summary" : "Deletes a flow registry client", - "description" : "", - "operationId" : "deleteFlowRegistryClient", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The revision is used to verify the client is working with the latest version of the flow.", - "required" : false, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The flow registry client id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/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. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /controller" : [ ] - } ] - } - }, - "/controller/registry-clients/{id}/descriptors" : { - "get" : { - "tags" : [ "controller" ], - "summary" : "Gets a flow registry client property descriptor", - "description" : "", - "operationId" : "getPropertyDescriptor", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The flow registry client id.", - "required" : true, - "type" : "string" - }, { - "name" : "propertyName", - "in" : "query", - "description" : "The property name.", - "required" : true, - "type" : "string" - }, { - "name" : "sensitive", - "in" : "query", - "description" : "Property Descriptor requested sensitive status", - "required" : false, - "type" : "boolean", - "default" : false - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/PropertyDescriptorEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /controller/registry-clients/{uuid}" : [ ] - } ] - } - }, - "/controller/registry-types" : { - "get" : { - "tags" : [ "controller" ], - "summary" : "Retrieves the types of flow that this NiFi supports", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getRegistryClientTypes", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/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. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/controller/reporting-tasks" : { - "post" : { - "tags" : [ "controller" ], - "summary" : "Creates a new reporting task", - "description" : "", - "operationId" : "createReportingTask", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The reporting task configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ReportingTaskEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ReportingTaskEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /controller" : [ ] - }, { - "Read - any referenced Controller Services - /controller-services/{uuid}" : [ ] - }, { - "Write - if the Reporting Task is restricted - /restricted-components" : [ ] - } ] - } - }, - "/controller/status/history" : { - "get" : { - "tags" : [ "controller" ], - "summary" : "Gets status history for the node", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getNodeStatusHistory", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ComponentHistoryEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /controller" : [ ] - } ] - } - }, - "/counters" : { - "get" : { - "tags" : [ "counters" ], - "summary" : "Gets the current counters for this NiFi", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getCounters", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "nodewise", - "in" : "query", - "description" : "Whether or not to include the breakdown per node. Optional, defaults to false", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "clusterNodeId", - "in" : "query", - "description" : "The id of the node where to get the status.", - "required" : false, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/CountersEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /counters" : [ ] - } ] - } - }, - "/counters/{id}" : { - "put" : { - "tags" : [ "counters" ], - "summary" : "Updates the specified counter. This will reset the counter value to 0", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "updateCounter", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The id of the counter.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/CounterEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /counters" : [ ] - } ] - } - }, - "/data-transfer/input-ports/{portId}/transactions/{transactionId}" : { - "put" : { - "tags" : [ "data-transfer" ], - "summary" : "Extend transaction TTL", - "description" : "", - "operationId" : "extendInputPortTransactionTTL", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "portId", - "in" : "path", - "required" : true, - "type" : "string" - }, { - "name" : "transactionId", - "in" : "path", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/TransactionResultEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /data-transfer/input-ports/{uuid}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "data-transfer" ], - "summary" : "Commit or cancel the specified transaction", - "description" : "", - "operationId" : "commitInputPortTransaction", - "consumes" : [ "application/octet-stream" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "responseCode", - "in" : "query", - "description" : "The response code. Available values are BAD_CHECKSUM(19), CONFIRM_TRANSACTION(12) or CANCEL_TRANSACTION(15).", - "required" : true, - "type" : "integer", - "format" : "int32" - }, { - "name" : "portId", - "in" : "path", - "description" : "The input port id.", - "required" : true, - "type" : "string" - }, { - "name" : "transactionId", - "in" : "path", - "description" : "The transaction id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/TransactionResultEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - }, - "503" : { - "description" : "NiFi instance is not ready for serving request, or temporarily overloaded. Retrying the same request later may be successful" - } - }, - "security" : [ { - "Write - /data-transfer/input-ports/{uuid}" : [ ] - } ] - } - }, - "/data-transfer/input-ports/{portId}/transactions/{transactionId}/flow-files" : { - "post" : { - "tags" : [ "data-transfer" ], - "summary" : "Transfer flow files to the input port", - "description" : "", - "operationId" : "receiveFlowFiles", - "consumes" : [ "application/octet-stream" ], - "produces" : [ "text/plain" ], - "parameters" : [ { - "name" : "portId", - "in" : "path", - "description" : "The input port id.", - "required" : true, - "type" : "string" - }, { - "name" : "transactionId", - "in" : "path", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - }, - "503" : { - "description" : "NiFi instance is not ready for serving request, or temporarily overloaded. Retrying the same request later may be successful" - } - }, - "security" : [ { - "Write - /data-transfer/input-ports/{uuid}" : [ ] - } ] - } - }, - "/data-transfer/output-ports/{portId}/transactions/{transactionId}" : { - "put" : { - "tags" : [ "data-transfer" ], - "summary" : "Extend transaction TTL", - "description" : "", - "operationId" : "extendOutputPortTransactionTTL", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "portId", - "in" : "path", - "required" : true, - "type" : "string" - }, { - "name" : "transactionId", - "in" : "path", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/TransactionResultEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - }, - "503" : { - "description" : "NiFi instance is not ready for serving request, or temporarily overloaded. Retrying the same request later may be successful" - } - }, - "security" : [ { - "Write - /data-transfer/output-ports/{uuid}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "data-transfer" ], - "summary" : "Commit or cancel the specified transaction", - "description" : "", - "operationId" : "commitOutputPortTransaction", - "consumes" : [ "application/octet-stream" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "responseCode", - "in" : "query", - "description" : "The response code. Available values are CONFIRM_TRANSACTION(12) or CANCEL_TRANSACTION(15).", - "required" : true, - "type" : "integer", - "format" : "int32" - }, { - "name" : "checksum", - "in" : "query", - "description" : "A checksum calculated at client side using CRC32 to check flow file content integrity. It must match with the value calculated at server side.", - "required" : true, - "type" : "string" - }, { - "name" : "portId", - "in" : "path", - "description" : "The output port id.", - "required" : true, - "type" : "string" - }, { - "name" : "transactionId", - "in" : "path", - "description" : "The transaction id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/TransactionResultEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - }, - "503" : { - "description" : "NiFi instance is not ready for serving request, or temporarily overloaded. Retrying the same request later may be successful" - } - }, - "security" : [ { - "Write - /data-transfer/output-ports/{uuid}" : [ ] - } ] - } - }, - "/data-transfer/output-ports/{portId}/transactions/{transactionId}/flow-files" : { - "get" : { - "tags" : [ "data-transfer" ], - "summary" : "Transfer flow files from the output port", - "description" : "", - "operationId" : "transferFlowFiles", - "consumes" : [ "*/*" ], - "produces" : [ "application/octet-stream" ], - "parameters" : [ { - "name" : "portId", - "in" : "path", - "description" : "The output port id.", - "required" : true, - "type" : "string" - }, { - "name" : "transactionId", - "in" : "path", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "There is no flow file to return.", - "schema" : { - "$ref" : "#/definitions/StreamingOutput" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - }, - "503" : { - "description" : "NiFi instance is not ready for serving request, or temporarily overloaded. Retrying the same request later may be successful" - } - }, - "security" : [ { - "Write - /data-transfer/output-ports/{uuid}" : [ ] - } ] - } - }, - "/data-transfer/{portType}/{portId}/transactions" : { - "post" : { - "tags" : [ "data-transfer" ], - "summary" : "Create a transaction to the specified output port or input port", - "description" : "", - "operationId" : "createPortTransaction", - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "portType", - "in" : "path", - "description" : "The port type.", - "required" : true, - "type" : "string", - "enum" : [ "input-ports", "output-ports" ] - }, { - "name" : "portId", - "in" : "path", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/TransactionResultEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - }, - "503" : { - "description" : "NiFi instance is not ready for serving request, or temporarily overloaded. Retrying the same request later may be successful" - } - }, - "security" : [ { - "Write - /data-transfer/{component-type}/{uuid}" : [ ] - } ] - } - }, - "/flow/about" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Retrieves details about this NiFi to put in the About dialog", - "description" : "", - "operationId" : "getAboutInfo", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/AboutEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/banners" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Retrieves the banners for this NiFi", - "description" : "", - "operationId" : "getBanners", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/BannerEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/bulletin-board" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets current bulletins", - "description" : "", - "operationId" : "getBulletinBoard", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "after", - "in" : "query", - "description" : "Includes bulletins with an id after this value.", - "required" : false, - "type" : "string" - }, { - "name" : "sourceName", - "in" : "query", - "description" : "Includes bulletins originating from this sources whose name match this regular expression.", - "required" : false, - "type" : "string" - }, { - "name" : "message", - "in" : "query", - "description" : "Includes bulletins whose message that match this regular expression.", - "required" : false, - "type" : "string" - }, { - "name" : "sourceId", - "in" : "query", - "description" : "Includes bulletins originating from this sources whose id match this regular expression.", - "required" : false, - "type" : "string" - }, { - "name" : "groupId", - "in" : "query", - "description" : "Includes bulletins originating from this sources whose group id match this regular expression.", - "required" : false, - "type" : "string" - }, { - "name" : "limit", - "in" : "query", - "description" : "The number of bulletins to limit the response to.", - "required" : false, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/BulletinBoardEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - }, { - "Read - /{component-type}/{uuid} - For component specific bulletins" : [ ] - } ] - } - }, - "/flow/client-id" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Generates a client id.", - "description" : "", - "operationId" : "generateClientId", - "consumes" : [ "*/*" ], - "produces" : [ "text/plain" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/cluster/search-results" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Searches the cluster for a node with the specified address", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "searchCluster", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "q", - "in" : "query", - "description" : "Node address to search for.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ClusterSearchResultsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/cluster/summary" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "The cluster summary for this NiFi", - "description" : "", - "operationId" : "getClusterSummary", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ClusteSummaryEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/config" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Retrieves the configuration for this NiFi flow", - "description" : "", - "operationId" : "getFlowConfig", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/FlowConfigurationEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/connections/{id}/statistics" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets statistics for a connection", - "description" : "", - "operationId" : "getConnectionStatistics", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "nodewise", - "in" : "query", - "description" : "Whether or not to include the breakdown per node. Optional, defaults to false", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "clusterNodeId", - "in" : "query", - "description" : "The id of the node where to get the statistics.", - "required" : false, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The connection id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ConnectionStatisticsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/connections/{id}/status" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets status for a connection", - "description" : "", - "operationId" : "getConnectionStatus", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "nodewise", - "in" : "query", - "description" : "Whether or not to include the breakdown per node. Optional, defaults to false", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "clusterNodeId", - "in" : "query", - "description" : "The id of the node where to get the status.", - "required" : false, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The connection id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ConnectionStatusEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/connections/{id}/status/history" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets the status history for a connection", - "description" : "", - "operationId" : "getConnectionStatusHistory", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The connection id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/StatusHistoryEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/controller-service-types" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Retrieves the types of controller services that this NiFi supports", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getControllerServiceTypes", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "serviceType", - "in" : "query", - "description" : "If specified, will only return controller services that are compatible with this type of service.", - "required" : false, - "type" : "string" - }, { - "name" : "serviceBundleGroup", - "in" : "query", - "description" : "If serviceType specified, is the bundle group of the serviceType.", - "required" : false, - "type" : "string" - }, { - "name" : "serviceBundleArtifact", - "in" : "query", - "description" : "If serviceType specified, is the bundle artifact of the serviceType.", - "required" : false, - "type" : "string" - }, { - "name" : "serviceBundleVersion", - "in" : "query", - "description" : "If serviceType specified, is the bundle version of the serviceType.", - "required" : false, - "type" : "string" - }, { - "name" : "bundleGroupFilter", - "in" : "query", - "description" : "If specified, will only return types that are a member of this bundle group.", - "required" : false, - "type" : "string" - }, { - "name" : "bundleArtifactFilter", - "in" : "query", - "description" : "If specified, will only return types that are a member of this bundle artifact.", - "required" : false, - "type" : "string" - }, { - "name" : "typeFilter", - "in" : "query", - "description" : "If specified, will only return types whose fully qualified classname matches.", - "required" : false, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ControllerServiceTypesEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/controller/bulletins" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Retrieves Controller level bulletins", - "description" : "", - "operationId" : "getBulletins", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ControllerBulletinsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - }, { - "Read - /controller - For controller bulletins" : [ ] - }, { - "Read - /controller-services/{uuid} - For controller service bulletins" : [ ] - }, { - "Read - /reporting-tasks/{uuid} - For reporting task bulletins" : [ ] - } ] - } - }, - "/flow/controller/controller-services" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets controller services for reporting tasks", - "description" : "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", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "uiOnly", - "in" : "query", - "required" : false, - "type" : "boolean", - "default" : false - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ControllerServicesEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/current-user" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Retrieves the user identity of the user making the request", - "description" : "", - "operationId" : "getCurrentUser", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/CurrentUserEntity" - } - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/history" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets configuration history", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "queryHistory", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "offset", - "in" : "query", - "description" : "The offset into the result set.", - "required" : true, - "type" : "string" - }, { - "name" : "count", - "in" : "query", - "description" : "The number of actions to return.", - "required" : true, - "type" : "string" - }, { - "name" : "sortColumn", - "in" : "query", - "description" : "The field to sort on.", - "required" : false, - "type" : "string" - }, { - "name" : "sortOrder", - "in" : "query", - "description" : "The direction to sort.", - "required" : false, - "type" : "string" - }, { - "name" : "startDate", - "in" : "query", - "description" : "Include actions after this date.", - "required" : false, - "type" : "string" - }, { - "name" : "endDate", - "in" : "query", - "description" : "Include actions before this date.", - "required" : false, - "type" : "string" - }, { - "name" : "userIdentity", - "in" : "query", - "description" : "Include actions performed by this user.", - "required" : false, - "type" : "string" - }, { - "name" : "sourceId", - "in" : "query", - "description" : "Include actions on this component.", - "required" : false, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/HistoryEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/history/components/{componentId}" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets configuration history for a component", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getComponentHistory", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "componentId", - "in" : "path", - "description" : "The component id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ComponentHistoryEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - }, { - "Read underlying component - /{component-type}/{uuid}" : [ ] - } ] - } - }, - "/flow/history/{id}" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets an action", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getAction", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The action id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ActionEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/input-ports/{id}/status" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets status for an input port", - "description" : "", - "operationId" : "getInputPortStatus", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "nodewise", - "in" : "query", - "description" : "Whether or not to include the breakdown per node. Optional, defaults to false", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "clusterNodeId", - "in" : "query", - "description" : "The id of the node where to get the status.", - "required" : false, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The input port id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/PortStatusEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/metrics/{producer}" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets all metrics for the flow from a particular node", - "description" : "", - "operationId" : "getFlowMetrics", - "consumes" : [ "*/*" ], - "produces" : [ "*/*" ], - "parameters" : [ { - "name" : "producer", - "in" : "path", - "description" : "The producer for flow file metrics. Each producer may have its own output format.", - "required" : true, - "type" : "string", - "enum" : [ "prometheus" ] - }, { - "name" : "includedRegistries", - "in" : "query", - "description" : "Set of included metrics registries", - "required" : false, - "type" : "array", - "items" : { - "type" : "string", - "enum" : [ "NIFI", "JVM", "BULLETIN", "CONNECTION" ] - }, - "collectionFormat" : "multi" - }, { - "name" : "sampleName", - "in" : "query", - "description" : "Regular Expression Pattern to be applied against the sample name field", - "required" : false, - "type" : "string" - }, { - "name" : "sampleLabelValue", - "in" : "query", - "description" : "Regular Expression Pattern to be applied against the sample label value field", - "required" : false, - "type" : "string" - }, { - "name" : "rootFieldName", - "in" : "query", - "description" : "Name of the first field of JSON object. Applicable for JSON producer only.", - "required" : false, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/StreamingOutput" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/output-ports/{id}/status" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets status for an output port", - "description" : "", - "operationId" : "getOutputPortStatus", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "nodewise", - "in" : "query", - "description" : "Whether or not to include the breakdown per node. Optional, defaults to false", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "clusterNodeId", - "in" : "query", - "description" : "The id of the node where to get the status.", - "required" : false, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The output port id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/PortStatusEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/parameter-contexts" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets all Parameter Contexts", - "description" : "", - "operationId" : "getParameterContexts", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ParameterContextsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /parameter-contexts/{id} for each Parameter Context" : [ ] - } ] - } - }, - "/flow/parameter-provider-types" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Retrieves the types of parameter providers that this NiFi supports", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getParameterProviderTypes", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bundleGroupFilter", - "in" : "query", - "description" : "If specified, will only return types that are a member of this bundle group.", - "required" : false, - "type" : "string" - }, { - "name" : "bundleArtifactFilter", - "in" : "query", - "description" : "If specified, will only return types that are a member of this bundle artifact.", - "required" : false, - "type" : "string" - }, { - "name" : "type", - "in" : "query", - "description" : "If specified, will only return types whose fully qualified classname matches.", - "required" : false, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/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. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/parameter-providers" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets all parameter providers", - "description" : "", - "operationId" : "getParameterProviders", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/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. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/prioritizers" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Retrieves the types of prioritizers that this NiFi supports", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getPrioritizers", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/PrioritizerTypesEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/process-groups/{id}" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets a process group", - "description" : "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", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "name" : "uiOnly", - "in" : "query", - "required" : false, - "type" : "boolean", - "default" : false - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessGroupFlowEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - }, - "put" : { - "tags" : [ "flow" ], - "summary" : "Schedule or unschedule components in the specified Process Group.", - "description" : "", - "operationId" : "scheduleComponents", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The request to schedule or unschedule. If the comopnents in the request are not specified, all authorized components will be considered.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ScheduleComponentsEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ScheduleComponentsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - }, { - "Write - /{component-type}/{uuid} or /operation/{component-type}/{uuid} - For every component being scheduled/unscheduled" : [ ] - } ] - } - }, - "/flow/process-groups/{id}/controller-services" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets all controller services", - "description" : "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", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "name" : "includeAncestorGroups", - "in" : "query", - "description" : "Whether or not to include parent/ancestory process groups", - "required" : false, - "type" : "boolean", - "default" : true - }, { - "name" : "includeDescendantGroups", - "in" : "query", - "description" : "Whether or not to include descendant process groups", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "uiOnly", - "in" : "query", - "required" : false, - "type" : "boolean", - "default" : false - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ControllerServicesEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - }, - "put" : { - "tags" : [ "flow" ], - "summary" : "Enable or disable Controller Services in the specified Process Group.", - "description" : "", - "operationId" : "activateControllerServices", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The request to schedule or unschedule. If the comopnents in the request are not specified, all authorized components will be considered.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ActivateControllerServicesEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ActivateControllerServicesEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - }, { - "Write - /{component-type}/{uuid} or /operation/{component-type}/{uuid} - For every service being enabled/disabled" : [ ] - } ] - } - }, - "/flow/process-groups/{id}/status" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets the status for a process group", - "description" : "The status for a process group includes status for all descendent components. When invoked on the root group with recursive set to true, it will return the current status of every component in the flow.", - "operationId" : "getProcessGroupStatus", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "recursive", - "in" : "query", - "description" : "Whether all descendant groups and the status of their content will be included. Optional, defaults to false", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "nodewise", - "in" : "query", - "description" : "Whether or not to include the breakdown per node. Optional, defaults to false", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "clusterNodeId", - "in" : "query", - "description" : "The id of the node where to get the status.", - "required" : false, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessGroupStatusEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/process-groups/{id}/status/history" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets status history for a remote process group", - "description" : "", - "operationId" : "getProcessGroupStatusHistory", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/StatusHistoryEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/processor-types" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Retrieves the types of processors that this NiFi supports", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getProcessorTypes", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bundleGroupFilter", - "in" : "query", - "description" : "If specified, will only return types that are a member of this bundle group.", - "required" : false, - "type" : "string" - }, { - "name" : "bundleArtifactFilter", - "in" : "query", - "description" : "If specified, will only return types that are a member of this bundle artifact.", - "required" : false, - "type" : "string" - }, { - "name" : "type", - "in" : "query", - "description" : "If specified, will only return types whose fully qualified classname matches.", - "required" : false, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessorTypesEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/processors/{id}/status" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets status for a processor", - "description" : "", - "operationId" : "getProcessorStatus", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "nodewise", - "in" : "query", - "description" : "Whether or not to include the breakdown per node. Optional, defaults to false", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "clusterNodeId", - "in" : "query", - "description" : "The id of the node where to get the status.", - "required" : false, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The processor id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessorStatusEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/processors/{id}/status/history" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets status history for a processor", - "description" : "", - "operationId" : "getProcessorStatusHistory", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The processor id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/StatusHistoryEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/registries" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets the listing of available flow registry clients", - "description" : "", - "operationId" : "getRegistryClients", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/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. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/registries/{id}/buckets" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets the buckets from the specified registry for the current user", - "description" : "", - "operationId" : "getBuckets", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The registry id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/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. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/registries/{registry-id}/buckets/{bucket-id}/flows" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets the flows from the specified registry and bucket for the current user", - "description" : "", - "operationId" : "getFlows", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "registry-id", - "in" : "path", - "description" : "The registry client id.", - "required" : true, - "type" : "string" - }, { - "name" : "bucket-id", - "in" : "path", - "description" : "The bucket id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlowsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/registries/{registry-id}/buckets/{bucket-id}/flows/{flow-id}/details" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets the details of a flow from the specified registry and bucket for the specified flow for the current user", - "description" : "", - "operationId" : "getDetails", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "registry-id", - "in" : "path", - "description" : "The registry client id.", - "required" : true, - "type" : "string" - }, { - "name" : "bucket-id", - "in" : "path", - "description" : "The bucket id.", - "required" : true, - "type" : "string" - }, { - "name" : "flow-id", - "in" : "path", - "description" : "The flow id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/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. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/registries/{registry-id}/buckets/{bucket-id}/flows/{flow-id}/versions" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets the flow versions from the specified registry and bucket for the specified flow for the current user", - "description" : "", - "operationId" : "getVersions", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "registry-id", - "in" : "path", - "description" : "The registry client id.", - "required" : true, - "type" : "string" - }, { - "name" : "bucket-id", - "in" : "path", - "description" : "The bucket id.", - "required" : true, - "type" : "string" - }, { - "name" : "flow-id", - "in" : "path", - "description" : "The flow id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlowSnapshotMetadataSetEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/remote-process-groups/{id}/status" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets status for a remote process group", - "description" : "", - "operationId" : "getRemoteProcessGroupStatus", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "nodewise", - "in" : "query", - "description" : "Whether or not to include the breakdown per node. Optional, defaults to false", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "clusterNodeId", - "in" : "query", - "description" : "The id of the node where to get the status.", - "required" : false, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The remote process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/RemoteProcessGroupStatusEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/remote-process-groups/{id}/status/history" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets the status history", - "description" : "", - "operationId" : "getRemoteProcessGroupStatusHistory", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The remote process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/StatusHistoryEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/reporting-task-types" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Retrieves the types of reporting tasks that this NiFi supports", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getReportingTaskTypes", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bundleGroupFilter", - "in" : "query", - "description" : "If specified, will only return types that are a member of this bundle group.", - "required" : false, - "type" : "string" - }, { - "name" : "bundleArtifactFilter", - "in" : "query", - "description" : "If specified, will only return types that are a member of this bundle artifact.", - "required" : false, - "type" : "string" - }, { - "name" : "type", - "in" : "query", - "description" : "If specified, will only return types whose fully qualified classname matches.", - "required" : false, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ReportingTaskTypesEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/reporting-tasks" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets all reporting tasks", - "description" : "", - "operationId" : "getReportingTasks", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ReportingTasksEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/runtime-manifest" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Retrieves the runtime manifest for this NiFi instance.", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getRuntimeManifest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/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. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/search-results" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Performs a search against this NiFi using the specified search term", - "description" : "Only search results from authorized components will be returned.", - "operationId" : "searchFlow", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "q", - "in" : "query", - "required" : false, - "type" : "string" - }, { - "name" : "a", - "in" : "query", - "required" : false, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/SearchResultsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/status" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets the current status of this NiFi", - "description" : "", - "operationId" : "getControllerStatus", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ControllerStatusEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/templates" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets all templates", - "description" : "", - "operationId" : "getTemplates", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/TemplatesEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flowfile-queues/{id}/drop-requests" : { - "post" : { - "tags" : [ "flowfile-queues" ], - "summary" : "Creates a request to drop the contents of the queue in this connection.", - "description" : "", - "operationId" : "createDropRequest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The connection id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/DropRequestEntity" - } - }, - "202" : { - "description" : "The request has been accepted. A HTTP response header will contain the URI where the response can be polled." - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write Source Data - /data/{component-type}/{uuid}" : [ ] - } ] - } - }, - "/flowfile-queues/{id}/drop-requests/{drop-request-id}" : { - "get" : { - "tags" : [ "flowfile-queues" ], - "summary" : "Gets the current status of a drop request for the specified connection.", - "description" : "", - "operationId" : "getDropRequest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The connection id.", - "required" : true, - "type" : "string" - }, { - "name" : "drop-request-id", - "in" : "path", - "description" : "The drop request id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/DropRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write Source Data - /data/{component-type}/{uuid}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "flowfile-queues" ], - "summary" : "Cancels and/or removes a request to drop the contents of this connection.", - "description" : "", - "operationId" : "removeDropRequest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The connection id.", - "required" : true, - "type" : "string" - }, { - "name" : "drop-request-id", - "in" : "path", - "description" : "The drop request id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/DropRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write Source Data - /data/{component-type}/{uuid}" : [ ] - } ] - } - }, - "/flowfile-queues/{id}/flowfiles/{flowfile-uuid}" : { - "get" : { - "tags" : [ "flowfile-queues" ], - "summary" : "Gets a FlowFile from a Connection.", - "description" : "", - "operationId" : "getFlowFile", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The connection id.", - "required" : true, - "type" : "string" - }, { - "name" : "flowfile-uuid", - "in" : "path", - "description" : "The flowfile uuid.", - "required" : true, - "type" : "string" - }, { - "name" : "clusterNodeId", - "in" : "query", - "description" : "The id of the node where the content exists if clustered.", - "required" : false, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/FlowFileEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read Source Data - /data/{component-type}/{uuid}" : [ ] - } ] - } - }, - "/flowfile-queues/{id}/flowfiles/{flowfile-uuid}/content" : { - "get" : { - "tags" : [ "flowfile-queues" ], - "summary" : "Gets the content for a FlowFile in a Connection.", - "description" : "", - "operationId" : "downloadFlowFileContent", - "consumes" : [ "*/*" ], - "produces" : [ "*/*" ], - "parameters" : [ { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The connection id.", - "required" : true, - "type" : "string" - }, { - "name" : "flowfile-uuid", - "in" : "path", - "description" : "The flowfile uuid.", - "required" : true, - "type" : "string" - }, { - "name" : "clusterNodeId", - "in" : "query", - "description" : "The id of the node where the content exists if clustered.", - "required" : false, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/StreamingOutput" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read Source Data - /data/{component-type}/{uuid}" : [ ] - } ] - } - }, - "/flowfile-queues/{id}/listing-requests" : { - "post" : { - "tags" : [ "flowfile-queues" ], - "summary" : "Lists the contents of the queue in this connection.", - "description" : "", - "operationId" : "createFlowFileListing", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The connection id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ListingRequestEntity" - } - }, - "202" : { - "description" : "The request has been accepted. A HTTP response header will contain the URI where the response can be polled." - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read Source Data - /data/{component-type}/{uuid}" : [ ] - } ] - } - }, - "/flowfile-queues/{id}/listing-requests/{listing-request-id}" : { - "get" : { - "tags" : [ "flowfile-queues" ], - "summary" : "Gets the current status of a listing request for the specified connection.", - "description" : "", - "operationId" : "getListingRequest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The connection id.", - "required" : true, - "type" : "string" - }, { - "name" : "listing-request-id", - "in" : "path", - "description" : "The listing request id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ListingRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read Source Data - /data/{component-type}/{uuid}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "flowfile-queues" ], - "summary" : "Cancels and/or removes a request to list the contents of this connection.", - "description" : "", - "operationId" : "deleteListingRequest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The connection id.", - "required" : true, - "type" : "string" - }, { - "name" : "listing-request-id", - "in" : "path", - "description" : "The listing request id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ListingRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read Source Data - /data/{component-type}/{uuid}" : [ ] - } ] - } - }, - "/funnels/{id}" : { - "get" : { - "tags" : [ "funnel" ], - "summary" : "Gets a funnel", - "description" : "", - "operationId" : "getFunnel", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The funnel id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/FunnelEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /funnels/{uuid}" : [ ] - } ] - }, - "put" : { - "tags" : [ "funnel" ], - "summary" : "Updates a funnel", - "description" : "", - "operationId" : "updateFunnel", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The funnel id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The funnel configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/FunnelEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/FunnelEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /funnels/{uuid}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "funnel" ], - "summary" : "Deletes a funnel", - "description" : "", - "operationId" : "removeFunnel", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The revision is used to verify the client is working with the latest version of the flow.", - "required" : false, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The funnel id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/FunnelEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /funnels/{uuid}" : [ ] - }, { - "Write - Parent Process Group - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/input-ports/{id}" : { - "get" : { - "tags" : [ "input-ports" ], - "summary" : "Gets an input port", - "description" : "", - "operationId" : "getInputPort", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The input port id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/PortEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /input-ports/{uuid}" : [ ] - } ] - }, - "put" : { - "tags" : [ "input-ports" ], - "summary" : "Updates an input port", - "description" : "", - "operationId" : "updateInputPort", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The input port id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The input port configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/PortEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/PortEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /input-ports/{uuid}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "input-ports" ], - "summary" : "Deletes an input port", - "description" : "", - "operationId" : "removeInputPort", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The revision is used to verify the client is working with the latest version of the flow.", - "required" : false, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The input port id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/PortEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /input-ports/{uuid}" : [ ] - }, { - "Write - Parent Process Group - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/input-ports/{id}/run-status" : { - "put" : { - "tags" : [ "input-ports" ], - "summary" : "Updates run status of an input-port", - "description" : "", - "operationId" : "updateRunStatus", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The port id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The port run status.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/PortRunStatusEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessorEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /input-ports/{uuid} or /operation/input-ports/{uuid}" : [ ] - } ] - } - }, - "/labels/{id}" : { - "get" : { - "tags" : [ "labels" ], - "summary" : "Gets a label", - "description" : "", - "operationId" : "getLabel", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The label id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/LabelEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /labels/{uuid}" : [ ] - } ] - }, - "put" : { - "tags" : [ "labels" ], - "summary" : "Updates a label", - "description" : "", - "operationId" : "updateLabel", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The label id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The label configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/LabelEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/LabelEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /labels/{uuid}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "labels" ], - "summary" : "Deletes a label", - "description" : "", - "operationId" : "removeLabel", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The revision is used to verify the client is working with the latest version of the flow.", - "required" : false, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The label id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/LabelEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /labels/{uuid}" : [ ] - }, { - "Write - Parent Process Group - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/output-ports/{id}" : { - "get" : { - "tags" : [ "output-ports" ], - "summary" : "Gets an output port", - "description" : "", - "operationId" : "getOutputPort", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The output port id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/PortEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /output-ports/{uuid}" : [ ] - } ] - }, - "put" : { - "tags" : [ "output-ports" ], - "summary" : "Updates an output port", - "description" : "", - "operationId" : "updateOutputPort", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The output port id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The output port configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/PortEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/PortEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /output-ports/{uuid}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "output-ports" ], - "summary" : "Deletes an output port", - "description" : "", - "operationId" : "removeOutputPort", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The revision is used to verify the client is working with the latest version of the flow.", - "required" : false, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The output port id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/PortEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /output-ports/{uuid}" : [ ] - }, { - "Write - Parent Process Group - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/output-ports/{id}/run-status" : { - "put" : { - "tags" : [ "output-ports" ], - "summary" : "Updates run status of an output-port", - "description" : "", - "operationId" : "updateRunStatus", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The port id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The port run status.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/PortRunStatusEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessorEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /output-ports/{uuid} or /operation/output-ports/{uuid}" : [ ] - } ] - } - }, - "/parameter-contexts" : { - "post" : { - "tags" : [ "parameter-contexts" ], - "summary" : "Create a Parameter Context", - "description" : "", - "operationId" : "createParameterContext", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The Parameter Context.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ParameterContextEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ParameterContextEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /parameter-contexts" : [ ] - }, { - "Read - for every inherited parameter context" : [ ] - } ] - } - }, - "/parameter-contexts/{contextId}/update-requests" : { - "post" : { - "tags" : [ "parameter-contexts" ], - "summary" : "Initiate the Update Request of a Parameter Context", - "description" : "This will initiate the process of updating a Parameter Context. Changing the value of a Parameter may require that one or more components be stopped and restarted, so this 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", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "contextId", - "in" : "path", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The updated version of the parameter context.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ParameterContextEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ParameterContextUpdateRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /parameter-contexts/{parameterContextId}" : [ ] - }, { - "Write - /parameter-contexts/{parameterContextId}" : [ ] - }, { - "Read - for every component that is affected by the update" : [ ] - }, { - "Write - for every component that is affected by the update" : [ ] - }, { - "Read - for every currently inherited parameter context" : [ ] - }, { - "Read - for any new inherited parameter context" : [ ] - } ] - } - }, - "/parameter-contexts/{contextId}/update-requests/{requestId}" : { - "get" : { - "tags" : [ "parameter-contexts" ], - "summary" : "Returns the Update Request with the given ID", - "description" : "Returns the Update Request with the given ID. Once an Update Request has been created by performing a POST to /nifi-api/parameter-contexts, that request can subsequently be retrieved via this endpoint, and the request that is fetched will contain the updated state, such as percent complete, the current state of the request, and any failures. ", - "operationId" : "getParameterContextUpdate", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "contextId", - "in" : "path", - "description" : "The ID of the Parameter Context", - "required" : true, - "type" : "string" - }, { - "name" : "requestId", - "in" : "path", - "description" : "The ID of the Update Request", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ParameterContextUpdateRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Only the user that submitted the request can get it" : [ ] - } ] - }, - "delete" : { - "tags" : [ "parameter-contexts" ], - "summary" : "Deletes the Update Request with the given ID", - "description" : "Deletes the Update Request with the given ID. After a request is created via a POST to /nifi-api/parameter-contexts/update-requests, it is expected that the client will properly clean up the request by DELETE'ing it, once the Update process has completed. If the request is deleted before the request completes, then the Update request will finish the step that it is currently performing and then will cancel any subsequent steps.", - "operationId" : "deleteUpdateRequest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "contextId", - "in" : "path", - "description" : "The ID of the ParameterContext", - "required" : true, - "type" : "string" - }, { - "name" : "requestId", - "in" : "path", - "description" : "The ID of the Update Request", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ParameterContextUpdateRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Only the user that submitted the request can remove it" : [ ] - } ] - } - }, - "/parameter-contexts/{contextId}/validation-requests" : { - "post" : { - "tags" : [ "parameter-contexts" ], - "summary" : "Initiate a Validation Request to determine how the validity of components will change if a Parameter Context were to be updated", - "description" : "This will initiate the process of validating all components whose Process Group is bound to the specified Parameter Context. Performing validation against an arbitrary number of components may be expect and take significantly more time than many other REST API actions. As a result, this endpoint will immediately return a ParameterContextValidationRequestEntity, and the process of validating the necessary components will occur asynchronously in the background. The client may then periodically poll the status of the request by issuing a GET request to /parameter-contexts/validation-requests/{requestId}. Once the request is completed, the client is expected to issue a DELETE request to /parameter-contexts/validation-requests/{requestId}.", - "operationId" : "submitValidationRequest", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "contextId", - "in" : "path", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The validation request", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ParameterContextValidationRequestEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ParameterContextValidationRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /parameter-contexts/{parameterContextId}" : [ ] - } ] - } - }, - "/parameter-contexts/{contextId}/validation-requests/{id}" : { - "get" : { - "tags" : [ "parameter-contexts" ], - "summary" : "Returns the Validation Request with the given ID", - "description" : "Returns the Validation Request with the given ID. Once a Validation Request has been created by performing a POST to /nifi-api/validation-contexts, that request can subsequently be retrieved via this endpoint, and the request that is fetched will contain the updated state, such as percent complete, the current state of the request, and any failures. ", - "operationId" : "getValidationRequest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "contextId", - "in" : "path", - "description" : "The ID of the Parameter Context", - "required" : true, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The ID of the Validation Request", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ParameterContextValidationRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Only the user that submitted the request can get it" : [ ] - } ] - }, - "delete" : { - "tags" : [ "parameter-contexts" ], - "summary" : "Deletes the Validation Request with the given ID", - "description" : "Deletes the Validation Request with the given ID. After a request is created via a POST to /nifi-api/validation-contexts, it is expected that the client will properly clean up the request by DELETE'ing it, once the validation process has completed. If the request is deleted before the request completes, then the Validation request will finish the step that it is currently performing and then will cancel any subsequent steps.", - "operationId" : "deleteValidationRequest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "contextId", - "in" : "path", - "description" : "The ID of the Parameter Context", - "required" : true, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The ID of the Update Request", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ParameterContextValidationRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Only the user that submitted the request can remove it" : [ ] - } ] - } - }, - "/parameter-contexts/{id}" : { - "get" : { - "tags" : [ "parameter-contexts" ], - "summary" : "Returns the Parameter Context with the given ID", - "description" : "Returns the Parameter Context with the given ID.", - "operationId" : "getParameterContext", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The ID of the Parameter Context", - "required" : true, - "type" : "string" - }, { - "name" : "includeInheritedParameters", - "in" : "query", - "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.", - "required" : false, - "type" : "boolean", - "default" : false - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ParameterContextEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /parameter-contexts/{id}" : [ ] - } ] - }, - "put" : { - "tags" : [ "parameter-contexts" ], - "summary" : "Modifies a Parameter Context", - "description" : "This endpoint will update a Parameter Context to match the provided entity. However, this request will fail if any component is running and is referencing a Parameter in the Parameter Context. Generally, this endpoint is not called directly. Instead, an update request should be submitted by making a POST to the /parameter-contexts/update-requests endpoint. That endpoint will, in turn, call this endpoint.", - "operationId" : "updateParameterContext", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The updated Parameter Context", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ParameterContextEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ParameterContextEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /parameter-contexts/{id}" : [ ] - }, { - "Write - /parameter-contexts/{id}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "parameter-contexts" ], - "summary" : "Deletes the Parameter Context with the given ID", - "description" : "Deletes the Parameter Context with the given ID.", - "operationId" : "deleteParameterContext", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The version is used to verify the client is working with the latest version of the flow.", - "required" : false, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, a new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The Parameter Context ID.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ParameterContextEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /parameter-contexts/{uuid}" : [ ] - }, { - "Write - /parameter-contexts/{uuid}" : [ ] - }, { - "Read - /process-groups/{uuid}, for any Process Group that is currently bound to the Parameter Context" : [ ] - }, { - "Write - /process-groups/{uuid}, for any Process Group that is currently bound to the Parameter Context" : [ ] - } ] - } - }, - "/parameter-providers/{id}" : { - "get" : { - "tags" : [ "parameter-providers" ], - "summary" : "Gets a parameter provider", - "description" : "", - "operationId" : "getParameterProvider", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The parameter provider id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/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. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /parameter-providers/{uuid}" : [ ] - } ] - }, - "put" : { - "tags" : [ "parameter-providers" ], - "summary" : "Updates a parameter provider", - "description" : "", - "operationId" : "updateParameterProvider", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The parameter provider id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The parameter provider configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ParameterProviderEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/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. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /parameter-providers/{uuid}" : [ ] - }, { - "Read - any referenced Controller Services if this request changes the reference - /controller-services/{uuid}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "parameter-providers" ], - "summary" : "Deletes a parameter provider", - "description" : "", - "operationId" : "removeParameterProvider", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The revision is used to verify the client is working with the latest version of the flow.", - "required" : false, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The parameter provider id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/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. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /parameter-providers/{uuid}" : [ ] - }, { - "Write - /controller" : [ ] - }, { - "Read - any referenced Controller Services - /controller-services/{uuid}" : [ ] - } ] - } - }, - "/parameter-providers/{id}/config/analysis" : { - "post" : { - "tags" : [ "parameter-providers" ], - "summary" : "Performs analysis of the component's configuration, providing information about which attributes are referenced.", - "description" : "", - "operationId" : "analyzeConfiguration", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The parameter provider id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The configuration analysis request.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ConfigurationAnalysisEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/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. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /parameter-providers/{uuid}" : [ ] - } ] - } - }, - "/parameter-providers/{id}/config/verification-requests" : { - "post" : { - "tags" : [ "parameter-providers" ], - "summary" : "Performs verification of the Parameter Provider's configuration", - "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", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The parameter provider id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The parameter provider configuration verification request.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/VerifyConfigRequestEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/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. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /parameter-providers/{uuid}" : [ ] - } ] - } - }, - "/parameter-providers/{id}/config/verification-requests/{requestId}" : { - "get" : { - "tags" : [ "parameter-providers" ], - "summary" : "Returns the Verification Request with the given ID", - "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", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The ID of the Parameter Provider", - "required" : true, - "type" : "string" - }, { - "name" : "requestId", - "in" : "path", - "description" : "The ID of the Verification Request", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/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. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Only the user that submitted the request can get it" : [ ] - } ] - }, - "delete" : { - "tags" : [ "parameter-providers" ], - "summary" : "Deletes the Verification Request with the given ID", - "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", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The ID of the Parameter Provider", - "required" : true, - "type" : "string" - }, { - "name" : "requestId", - "in" : "path", - "description" : "The ID of the Verification Request", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/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. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Only the user that submitted the request can remove it" : [ ] - } ] - } - }, - "/parameter-providers/{id}/descriptors" : { - "get" : { - "tags" : [ "parameter-providers" ], - "summary" : "Gets a parameter provider property descriptor", - "description" : "", - "operationId" : "getPropertyDescriptor", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The parameter provider id.", - "required" : true, - "type" : "string" - }, { - "name" : "propertyName", - "in" : "query", - "description" : "The property name.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/PropertyDescriptorEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /parameter-providers/{uuid}" : [ ] - } ] - } - }, - "/parameter-providers/{id}/parameters/fetch-requests" : { - "post" : { - "tags" : [ "parameter-providers" ], - "summary" : "Fetches and temporarily caches the parameters for a provider", - "description" : "", - "operationId" : "fetchParameters", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The parameter provider id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The parameter fetch request.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ParameterProviderParameterFetchEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/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. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /parameter-providers/{uuid} or or /operation/parameter-providers/{uuid}" : [ ] - } ] - } - }, - "/parameter-providers/{id}/references" : { - "get" : { - "tags" : [ "parameter-providers" ], - "summary" : "Gets all references to a parameter provider", - "description" : "", - "operationId" : "getParameterProviderReferences", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The parameter provider id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/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. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /parameter-providers/{uuid}" : [ ] - } ] - } - }, - "/parameter-providers/{id}/state" : { - "get" : { - "tags" : [ "parameter-providers" ], - "summary" : "Gets the state for a parameter provider", - "description" : "", - "operationId" : "getState", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The parameter provider id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ComponentStateEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /parameter-providers/{uuid}" : [ ] - } ] - } - }, - "/parameter-providers/{id}/state/clear-requests" : { - "post" : { - "tags" : [ "parameter-providers" ], - "summary" : "Clears the state for a parameter provider", - "description" : "", - "operationId" : "clearState", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The parameter provider id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ComponentStateEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /parameter-providers/{uuid}" : [ ] - } ] - } - }, - "/parameter-providers/{providerId}/apply-parameters-requests" : { - "post" : { - "tags" : [ "parameter-providers" ], - "summary" : "Initiate a request to apply the fetched parameters of a Parameter Provider", - "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", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "providerId", - "in" : "path", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The apply parameters request.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ParameterProviderParameterApplicationEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/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. Retrying the same request later may be successful." - } - }, - "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" : [ ] - } ] - } - }, - "/parameter-providers/{providerId}/apply-parameters-requests/{requestId}" : { - "get" : { - "tags" : [ "parameter-providers" ], - "summary" : "Returns the Apply Parameters Request with the given ID", - "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", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "providerId", - "in" : "path", - "description" : "The ID of the Parameter Provider", - "required" : true, - "type" : "string" - }, { - "name" : "requestId", - "in" : "path", - "description" : "The ID of the Apply Parameters Request", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/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. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Only the user that submitted the request can get it" : [ ] - } ] - }, - "delete" : { - "tags" : [ "parameter-providers" ], - "summary" : "Deletes the Apply Parameters Request with the given ID", - "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", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "providerId", - "in" : "path", - "description" : "The ID of the Parameter Provider", - "required" : true, - "type" : "string" - }, { - "name" : "requestId", - "in" : "path", - "description" : "The ID of the Apply Parameters Request", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/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. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Only the user that submitted the request can remove it" : [ ] - } ] - } - }, - "/policies" : { - "post" : { - "tags" : [ "policies" ], - "summary" : "Creates an access policy", - "description" : "", - "operationId" : "createAccessPolicy", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The access policy configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/AccessPolicyEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/AccessPolicyEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /policies/{resource}" : [ ] - } ] - } - }, - "/policies/{action}/{resource}" : { - "get" : { - "tags" : [ "policies" ], - "summary" : "Gets an access policy for the specified action and resource", - "description" : "Will return the effective policy if no component specific policy exists for the specified action and resource. Must have Read permissions to the policy with the desired action and resource. Permissions for the policy that is returned will be indicated in the response. This means the client could be authorized to get the policy for a given component but the effective policy may be inherited from an ancestor Process Group. If the client does not have permissions to that policy, the response will not include the policy and the permissions in the response will be marked accordingly. If the client does not have permissions to the policy of the desired action and resource a 403 response will be returned.", - "operationId" : "getAccessPolicyForResource", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "action", - "in" : "path", - "description" : "The request action.", - "required" : true, - "type" : "string", - "enum" : [ "read", "write" ] - }, { - "name" : "resource", - "in" : "path", - "description" : "The resource of the policy.", - "required" : true, - "type" : "string", - "pattern" : ".+" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/AccessPolicyEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /policies/{resource}" : [ ] - } ] - } - }, - "/policies/{id}" : { - "get" : { - "tags" : [ "policies" ], - "summary" : "Gets an access policy", - "description" : "", - "operationId" : "getAccessPolicy", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The access policy id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/AccessPolicyEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /policies/{resource}" : [ ] - } ] - }, - "put" : { - "tags" : [ "policies" ], - "summary" : "Updates a access policy", - "description" : "", - "operationId" : "updateAccessPolicy", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The access policy id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The access policy configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/AccessPolicyEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/AccessPolicyEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /policies/{resource}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "policies" ], - "summary" : "Deletes an access policy", - "description" : "", - "operationId" : "removeAccessPolicy", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The revision is used to verify the client is working with the latest version of the flow.", - "required" : false, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The access policy id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/AccessPolicyEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /policies/{resource}" : [ ] - }, { - "Write - Policy of the parent resource - /policies/{resource}" : [ ] - } ] - } - }, - "/process-groups/replace-requests/{id}" : { - "get" : { - "tags" : [ "process-groups" ], - "summary" : "Returns the Replace Request with the given ID", - "description" : "Returns the Replace Request with the given ID. Once a Replace Request has been created by performing a POST to /process-groups/{id}/replace-requests, that request can subsequently be retrieved via this endpoint, and the request that is fetched will contain the updated state, such as percent complete, the current state of the request, and any failures. Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getReplaceProcessGroupRequest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The ID of the Replace Request", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessGroupReplaceRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Only the user that submitted the request can get it" : [ ] - } ] - }, - "delete" : { - "tags" : [ "process-groups" ], - "summary" : "Deletes the Replace Request with the given ID", - "description" : "Deletes the Replace Request with the given ID. After a request is created via a POST to /process-groups/{id}/replace-requests, it is expected that the client will properly clean up the request by DELETE'ing it, once the Replace process has completed. If the request is deleted before the request completes, then the Replace request will finish the step that it is currently performing and then will cancel any subsequent steps. Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "deleteReplaceProcessGroupRequest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The ID of the Update Request", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessGroupReplaceRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Only the user that submitted the request can remove it" : [ ] - } ] - } - }, - "/process-groups/{groupId}/variable-registry/update-requests/{updateId}" : { - "get" : { - "tags" : [ "process-groups" ], - "summary" : "Gets a process group's variable registry", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getVariableRegistryUpdateRequest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "groupId", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "name" : "updateId", - "in" : "path", - "description" : "The ID of the Variable Registry Update Request", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VariableRegistryUpdateRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "process-groups" ], - "summary" : "Deletes an update request for a process group's variable registry. If the request is not yet complete, it will automatically be cancelled.", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "deleteVariableRegistryUpdateRequest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "groupId", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "name" : "updateId", - "in" : "path", - "description" : "The ID of the Variable Registry Update Request", - "required" : true, - "type" : "string" - }, { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VariableRegistryUpdateRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/process-groups/{id}" : { - "get" : { - "tags" : [ "process-groups" ], - "summary" : "Gets a process group", - "description" : "", - "operationId" : "getProcessGroup", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessGroupEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - } ] - }, - "put" : { - "tags" : [ "process-groups" ], - "summary" : "Updates a process group", - "description" : "", - "operationId" : "updateProcessGroup", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The process group configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ProcessGroupEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessGroupEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "process-groups" ], - "summary" : "Deletes a process group", - "description" : "", - "operationId" : "removeProcessGroup", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The revision is used to verify the client is working with the latest version of the flow.", - "required" : false, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessGroupEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - }, { - "Write - Parent Process Group - /process-groups/{uuid}" : [ ] - }, { - "Read - any referenced Controller Services by any encapsulated components - /controller-services/{uuid}" : [ ] - }, { - "Write - /{component-type}/{uuid} - For all encapsulated components" : [ ] - } ] - } - }, - "/process-groups/{id}/connections" : { - "get" : { - "tags" : [ "process-groups" ], - "summary" : "Gets all connections", - "description" : "", - "operationId" : "getConnections", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ConnectionsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - } ] - }, - "post" : { - "tags" : [ "process-groups" ], - "summary" : "Creates a connection", - "description" : "", - "operationId" : "createConnection", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The connection configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ConnectionEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ConnectionEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - }, { - "Write Source - /{component-type}/{uuid}" : [ ] - }, { - "Write Destination - /{component-type}/{uuid}" : [ ] - } ] - } - }, - "/process-groups/{id}/controller-services" : { - "post" : { - "tags" : [ "process-groups" ], - "summary" : "Creates a new controller service", - "description" : "", - "operationId" : "createControllerService", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The controller service configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ControllerServiceEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ControllerServiceEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - }, { - "Read - any referenced Controller Services - /controller-services/{uuid}" : [ ] - }, { - "Write - if the Controller Service is restricted - /restricted-components" : [ ] - } ] - } - }, - "/process-groups/{id}/download" : { - "get" : { - "tags" : [ "process-groups" ], - "summary" : "Gets a process group for download", - "description" : "", - "operationId" : "exportProcessGroup", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "name" : "includeReferencedServices", - "in" : "query", - "description" : "If referenced services from outside the target group should be included", - "required" : false, - "type" : "boolean", - "default" : false - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/process-groups/{id}/empty-all-connections-requests" : { - "post" : { - "tags" : [ "process-groups" ], - "summary" : "Creates a request to drop all flowfiles of all connection queues in this process group.", - "description" : "", - "operationId" : "createEmptyAllConnectionsRequest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/DropRequestEntity" - } - }, - "202" : { - "description" : "The request has been accepted. An HTTP response header will contain the URI where the status can be polled." - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid} - For this and all encapsulated process groups" : [ ] - }, { - "Write Source Data - /data/{component-type}/{uuid} - For all encapsulated connections" : [ ] - } ] - } - }, - "/process-groups/{id}/empty-all-connections-requests/{drop-request-id}" : { - "get" : { - "tags" : [ "process-groups" ], - "summary" : "Gets the current status of a drop all flowfiles request.", - "description" : "", - "operationId" : "getDropAllFlowfilesRequest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "name" : "drop-request-id", - "in" : "path", - "description" : "The drop request id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/DropRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid} - For this and all encapsulated process groups" : [ ] - }, { - "Write Source Data - /data/{component-type}/{uuid} - For all encapsulated connections" : [ ] - } ] - }, - "delete" : { - "tags" : [ "process-groups" ], - "summary" : "Cancels and/or removes a request to drop all flowfiles.", - "description" : "", - "operationId" : "removeDropRequest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "name" : "drop-request-id", - "in" : "path", - "description" : "The drop request id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/DropRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid} - For this and all encapsulated process groups" : [ ] - }, { - "Write Source Data - /data/{component-type}/{uuid} - For all encapsulated connections" : [ ] - } ] - } - }, - "/process-groups/{id}/flow-contents" : { - "put" : { - "tags" : [ "process-groups" ], - "summary" : "Replace Process Group contents with the given ID with the specified Process Group contents", - "description" : "This endpoint is used for replication within a cluster, when replacing a flow with a new flow. It expects that the flow beingreplaced is not under version control and that the given snapshot will not modify any Processor that is currently running or any Controller Service that is enabled. Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "replaceProcessGroup", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The process group replace request entity.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ProcessGroupImportEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessGroupImportEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - }, { - "Write - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/process-groups/{id}/funnels" : { - "get" : { - "tags" : [ "process-groups" ], - "summary" : "Gets all funnels", - "description" : "", - "operationId" : "getFunnels", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/FunnelsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - } ] - }, - "post" : { - "tags" : [ "process-groups" ], - "summary" : "Creates a funnel", - "description" : "", - "operationId" : "createFunnel", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The funnel configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/FunnelEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/FunnelEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/process-groups/{id}/input-ports" : { - "get" : { - "tags" : [ "process-groups" ], - "summary" : "Gets all input ports", - "description" : "", - "operationId" : "getInputPorts", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/InputPortsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - } ] - }, - "post" : { - "tags" : [ "process-groups" ], - "summary" : "Creates an input port", - "description" : "", - "operationId" : "createInputPort", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The input port configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/PortEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/PortEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/process-groups/{id}/labels" : { - "get" : { - "tags" : [ "process-groups" ], - "summary" : "Gets all labels", - "description" : "", - "operationId" : "getLabels", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/LabelsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - } ] - }, - "post" : { - "tags" : [ "process-groups" ], - "summary" : "Creates a label", - "description" : "", - "operationId" : "createLabel", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The label configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/LabelEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/LabelEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/process-groups/{id}/local-modifications" : { - "get" : { - "tags" : [ "process-groups" ], - "summary" : "Gets a list of local modifications to the Process Group since it was last synchronized with the Flow Registry", - "description" : "", - "operationId" : "getLocalModifications", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/FlowComparisonEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - }, { - "Read - /{component-type}/{uuid} - For all encapsulated components" : [ ] - } ] - } - }, - "/process-groups/{id}/output-ports" : { - "get" : { - "tags" : [ "process-groups" ], - "summary" : "Gets all output ports", - "description" : "", - "operationId" : "getOutputPorts", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/OutputPortsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - } ] - }, - "post" : { - "tags" : [ "process-groups" ], - "summary" : "Creates an output port", - "description" : "", - "operationId" : "createOutputPort", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The output port configuration.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/PortEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/PortEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/process-groups/{id}/process-groups" : { - "get" : { - "tags" : [ "process-groups" ], - "summary" : "Gets all process groups", - "description" : "", - "operationId" : "getProcessGroups", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessGroupsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - } ] - }, - "post" : { - "tags" : [ "process-groups" ], - "summary" : "Creates a process group", - "description" : "", - "operationId" : "createProcessGroup", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The process group configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ProcessGroupEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessGroupEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/process-groups/{id}/process-groups/import" : { - "post" : { - "tags" : [ "process-groups" ], - "summary" : "Imports a specified process group", - "description" : "", - "operationId" : "importProcessGroup", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessGroupEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/process-groups/{id}/process-groups/upload" : { - "post" : { - "tags" : [ "process-groups" ], - "summary" : "Uploads a versioned flow definition and creates a process group", - "description" : "", - "operationId" : "uploadProcessGroup", - "consumes" : [ "multipart/form-data" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The process group name.", - "required" : true, - "schema" : { - "type" : "string" - } - }, { - "in" : "body", - "name" : "body", - "description" : "The process group X position.", - "required" : true, - "schema" : { - "type" : "number", - "format" : "double" - } - }, { - "in" : "body", - "name" : "body", - "description" : "The process group Y position.", - "required" : true, - "schema" : { - "type" : "number", - "format" : "double" - } - }, { - "in" : "body", - "name" : "body", - "description" : "The client id.", - "required" : true, - "schema" : { - "type" : "string" - } - }, { - "in" : "body", - "name" : "body", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "schema" : { - "type" : "boolean" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessGroupEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/process-groups/{id}/processors" : { - "get" : { - "tags" : [ "process-groups" ], - "summary" : "Gets all processors", - "description" : "", - "operationId" : "getProcessors", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "name" : "includeDescendantGroups", - "in" : "query", - "description" : "Whether or not to include processors from descendant process groups", - "required" : false, - "type" : "boolean", - "default" : false - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessorsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - } ] - }, - "post" : { - "tags" : [ "process-groups" ], - "summary" : "Creates a new processor", - "description" : "", - "operationId" : "createProcessor", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The processor configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ProcessorEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessorEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - }, { - "Read - any referenced Controller Services - /controller-services/{uuid}" : [ ] - }, { - "Write - if the Processor is restricted - /restricted-components" : [ ] - } ] - } - }, - "/process-groups/{id}/remote-process-groups" : { - "get" : { - "tags" : [ "process-groups" ], - "summary" : "Gets all remote process groups", - "description" : "", - "operationId" : "getRemoteProcessGroups", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/RemoteProcessGroupsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - } ] - }, - "post" : { - "tags" : [ "process-groups" ], - "summary" : "Creates a new process group", - "description" : "", - "operationId" : "createRemoteProcessGroup", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The remote process group configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/RemoteProcessGroupEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/RemoteProcessGroupEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/process-groups/{id}/replace-requests" : { - "post" : { - "tags" : [ "process-groups" ], - "summary" : "Initiate the Replace Request of a Process Group with the given ID", - "description" : "This will initiate the action of replacing a process group with the given process group. This can be a lengthy process, as it will stop any Processors and disable any Controller Services necessary to perform the action and then restart them. As a result, the endpoint will immediately return a ProcessGroupReplaceRequestEntity, and the process of replacing the flow will occur asynchronously in the background. The client may then periodically poll the status of the request by issuing a GET request to /process-groups/replace-requests/{requestId}. Once the request is completed, the client is expected to issue a DELETE request to /process-groups/replace-requests/{requestId}. Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "initiateReplaceProcessGroup", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The process group replace request entity", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ProcessGroupImportEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessGroupReplaceRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - }, { - "Write - /process-groups/{uuid}" : [ ] - }, { - "Read - /{component-type}/{uuid} - For all encapsulated components" : [ ] - }, { - "Write - /{component-type}/{uuid} - For all encapsulated components" : [ ] - }, { - "Write - if the template contains any restricted components - /restricted-components" : [ ] - }, { - "Read - /parameter-contexts/{uuid} - For any Parameter Context that is referenced by a Property that is changed, added, or removed" : [ ] - } ] - } - }, - "/process-groups/{id}/snippet-instance" : { - "post" : { - "tags" : [ "process-groups" ], - "summary" : "Copies a snippet and discards it.", - "description" : "", - "operationId" : "copySnippet", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The copy snippet request.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/CopySnippetRequestEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/FlowEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - }, { - "Read - /{component-type}/{uuid} - For each component in the snippet and their descendant components" : [ ] - }, { - "Write - if the snippet contains any restricted Processors - /restricted-components" : [ ] - } ] - } - }, - "/process-groups/{id}/template-instance" : { - "post" : { - "tags" : [ "process-groups" ], - "summary" : "Instantiates a template", - "description" : "", - "operationId" : "instantiateTemplate", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The instantiate template request.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/InstantiateTemplateRequestEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/FlowEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - }, { - "Read - /templates/{uuid}" : [ ] - }, { - "Write - if the template contains any restricted components - /restricted-components" : [ ] - } ] - } - }, - "/process-groups/{id}/templates" : { - "post" : { - "tags" : [ "process-groups" ], - "summary" : "Creates a template and discards the specified snippet.", - "description" : "", - "operationId" : "createTemplate", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The create template request.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/CreateTemplateRequestEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/TemplateEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - }, { - "Read - /{component-type}/{uuid} - For each component in the snippet and their descendant components" : [ ] - } ] - } - }, - "/process-groups/{id}/templates/import" : { - "post" : { - "tags" : [ "process-groups" ], - "summary" : "Imports a template", - "description" : "", - "operationId" : "importTemplate", - "consumes" : [ "application/xml" ], - "produces" : [ "application/xml" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/TemplateEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/process-groups/{id}/templates/upload" : { - "post" : { - "tags" : [ "process-groups" ], - "summary" : "Uploads a template", - "description" : "", - "operationId" : "uploadTemplate", - "consumes" : [ "multipart/form-data" ], - "produces" : [ "application/xml" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "schema" : { - "type" : "boolean" - } - }, { - "name" : "template", - "in" : "formData", - "description" : "The binary content of the template file being uploaded.", - "required" : true, - "type" : "file" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/TemplateEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/process-groups/{id}/variable-registry" : { - "get" : { - "tags" : [ "process-groups" ], - "summary" : "Gets a process group's variable registry", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getVariableRegistry", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "name" : "includeAncestorGroups", - "in" : "query", - "description" : "Whether or not to include ancestor groups", - "required" : false, - "type" : "boolean", - "default" : true - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VariableRegistryEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - } ] - }, - "put" : { - "tags" : [ "process-groups" ], - "summary" : "Updates the contents of a Process Group's variable Registry", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "updateVariableRegistry", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The variable registry configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/VariableRegistryEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VariableRegistryEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/process-groups/{id}/variable-registry/update-requests" : { - "post" : { - "tags" : [ "process-groups" ], - "summary" : "Submits a request to update a process group's variable registry", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "submitUpdateVariableRegistryRequest", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The variable registry configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/VariableRegistryEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VariableRegistryUpdateRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/processors/run-status-details/queries" : { - "post" : { - "tags" : [ "processors" ], - "summary" : "Submits a query to retrieve the run status details of all processors that are in the given list of Processor IDs", - "description" : "", - "operationId" : "getProcessorRunStatusDetails", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The request for the processors that should be included in the results", - "required" : false, - "schema" : { - "$ref" : "#/definitions/RunStatusDetailsRequestEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessorsRunStatusDetailsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /processors/{uuid} for each processor whose run status information is requested" : [ ] - } ] - } - }, - "/processors/{id}" : { - "get" : { - "tags" : [ "processors" ], - "summary" : "Gets a processor", - "description" : "", - "operationId" : "getProcessor", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The processor id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessorEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /processors/{uuid}" : [ ] - } ] - }, - "put" : { - "tags" : [ "processors" ], - "summary" : "Updates a processor", - "description" : "", - "operationId" : "updateProcessor", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The processor id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The processor configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ProcessorEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessorEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /processors/{uuid}" : [ ] - }, { - "Read - any referenced Controller Services if this request changes the reference - /controller-services/{uuid}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "processors" ], - "summary" : "Deletes a processor", - "description" : "", - "operationId" : "deleteProcessor", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The revision is used to verify the client is working with the latest version of the flow.", - "required" : false, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The processor id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessorEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /processors/{uuid}" : [ ] - }, { - "Write - Parent Process Group - /process-groups/{uuid}" : [ ] - }, { - "Read - any referenced Controller Services - /controller-services/{uuid}" : [ ] - } ] - } - }, - "/processors/{id}/config/analysis" : { - "post" : { - "tags" : [ "processors" ], - "summary" : "Performs analysis of the component's configuration, providing information about which attributes are referenced.", - "description" : "", - "operationId" : "analyzeConfiguration", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The processor id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The processor configuration analysis request.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ConfigurationAnalysisEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/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. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /processors/{uuid}" : [ ] - } ] - } - }, - "/processors/{id}/config/verification-requests" : { - "post" : { - "tags" : [ "processors" ], - "summary" : "Performs verification of the Processor's configuration", - "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", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The processor id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The processor configuration verification request.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/VerifyConfigRequestEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/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. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /processors/{uuid}" : [ ] - } ] - } - }, - "/processors/{id}/config/verification-requests/{requestId}" : { - "get" : { - "tags" : [ "processors" ], - "summary" : "Returns the Verification Request with the given ID", - "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", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The ID of the Processor", - "required" : true, - "type" : "string" - }, { - "name" : "requestId", - "in" : "path", - "description" : "The ID of the Verification Request", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/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. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Only the user that submitted the request can get it" : [ ] - } ] - }, - "delete" : { - "tags" : [ "processors" ], - "summary" : "Deletes the Verification Request with the given ID", - "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", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The ID of the Processor", - "required" : true, - "type" : "string" - }, { - "name" : "requestId", - "in" : "path", - "description" : "The ID of the Verification Request", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/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. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Only the user that submitted the request can remove it" : [ ] - } ] - } - }, - "/processors/{id}/descriptors" : { - "get" : { - "tags" : [ "processors" ], - "summary" : "Gets the descriptor for a processor property", - "description" : "", - "operationId" : "getPropertyDescriptor", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The processor id.", - "required" : true, - "type" : "string" - }, { - "name" : "propertyName", - "in" : "query", - "description" : "The property name.", - "required" : true, - "type" : "string" - }, { - "name" : "sensitive", - "in" : "query", - "description" : "Property Descriptor requested sensitive status", - "required" : false, - "type" : "boolean", - "default" : false - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/PropertyDescriptorEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /processors/{uuid}" : [ ] - } ] - } - }, - "/processors/{id}/diagnostics" : { - "get" : { - "tags" : [ "processors" ], - "summary" : "Gets diagnostics information about a processor", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getProcessorDiagnostics", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The processor id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessorEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /processors/{uuid}" : [ ] - } ] - } - }, - "/processors/{id}/run-status" : { - "put" : { - "tags" : [ "processors" ], - "summary" : "Updates run status of a processor", - "description" : "", - "operationId" : "updateRunStatus", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The processor id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The processor run status.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ProcessorRunStatusEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessorEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /processors/{uuid} or /operation/processors/{uuid}" : [ ] - } ] - } - }, - "/processors/{id}/state" : { - "get" : { - "tags" : [ "processors" ], - "summary" : "Gets the state for a processor", - "description" : "", - "operationId" : "getState", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The processor id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ComponentStateEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /processors/{uuid}" : [ ] - } ] - } - }, - "/processors/{id}/state/clear-requests" : { - "post" : { - "tags" : [ "processors" ], - "summary" : "Clears the state for a processor", - "description" : "", - "operationId" : "clearState", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The processor id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ComponentStateEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /processors/{uuid}" : [ ] - } ] - } - }, - "/processors/{id}/threads" : { - "delete" : { - "tags" : [ "processors" ], - "summary" : "Terminates a processor, essentially \"deleting\" its threads and any active tasks", - "description" : "", - "operationId" : "terminateProcessor", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The processor id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessorEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /processors/{uuid} or /operation/processors/{uuid}" : [ ] - } ] - } - }, - "/provenance" : { - "post" : { - "tags" : [ "provenance" ], - "summary" : "Submits a provenance query", - "description" : "Provenance queries may be long running so this endpoint submits a request. The response will include the current state of the query. If the request is not completed the URI in the response can be used at a later time to get the updated state of the query. Once the query has completed the provenance request should be deleted by the client who originally submitted it.", - "operationId" : "submitProvenanceRequest", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The provenance query details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ProvenanceEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProvenanceEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /provenance" : [ ] - }, { - "Read - /data/{component-type}/{uuid}" : [ ] - } ] - } - }, - "/provenance-events/latest/replays" : { - "post" : { - "tags" : [ "provenance-events" ], - "summary" : "Replays content from a provenance event", - "description" : "", - "operationId" : "submitReplayLatestEvent", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The replay request.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ReplayLastEventRequestEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/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. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read Component Provenance Data - /provenance-data/{component-type}/{uuid}" : [ ] - }, { - "Read Component Data - /data/{component-type}/{uuid}" : [ ] - }, { - "Write Component Data - /data/{component-type}/{uuid}" : [ ] - } ] - } - }, - "/provenance-events/replays" : { - "post" : { - "tags" : [ "provenance-events" ], - "summary" : "Replays content from a provenance event", - "description" : "", - "operationId" : "submitReplay", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The replay request.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/SubmitReplayRequestEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProvenanceEventEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read Component Provenance Data - /provenance-data/{component-type}/{uuid}" : [ ] - }, { - "Read Component Data - /data/{component-type}/{uuid}" : [ ] - }, { - "Write Component Data - /data/{component-type}/{uuid}" : [ ] - } ] - } - }, - "/provenance-events/{id}" : { - "get" : { - "tags" : [ "provenance-events" ], - "summary" : "Gets a provenance event", - "description" : "", - "operationId" : "getProvenanceEvent", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "clusterNodeId", - "in" : "query", - "description" : "The id of the node where this event exists if clustered.", - "required" : false, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The provenance event id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProvenanceEventEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read Component Provenance Data - /provenance-data/{component-type}/{uuid}" : [ ] - } ] - } - }, - "/provenance-events/{id}/content/input" : { - "get" : { - "tags" : [ "provenance-events" ], - "summary" : "Gets the input content for a provenance event", - "description" : "", - "operationId" : "getInputContent", - "consumes" : [ "*/*" ], - "produces" : [ "*/*" ], - "parameters" : [ { - "name" : "clusterNodeId", - "in" : "query", - "description" : "The id of the node where the content exists if clustered.", - "required" : false, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The provenance event id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/StreamingOutput" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read Component Provenance Data - /provenance-data/{component-type}/{uuid}" : [ ] - }, { - "Read Component Data - /data/{component-type}/{uuid}" : [ ] - } ] - } - }, - "/provenance-events/{id}/content/output" : { - "get" : { - "tags" : [ "provenance-events" ], - "summary" : "Gets the output content for a provenance event", - "description" : "", - "operationId" : "getOutputContent", - "consumes" : [ "*/*" ], - "produces" : [ "*/*" ], - "parameters" : [ { - "name" : "clusterNodeId", - "in" : "query", - "description" : "The id of the node where the content exists if clustered.", - "required" : false, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The provenance event id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/StreamingOutput" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read Component Provenance Data - /provenance-data/{component-type}/{uuid}" : [ ] - }, { - "Read Component Data - /data/{component-type}/{uuid}" : [ ] - } ] - } - }, - "/provenance/lineage" : { - "post" : { - "tags" : [ "provenance" ], - "summary" : "Submits a lineage query", - "description" : "Lineage queries may be long running so this endpoint submits a request. The response will include the current state of the query. If the request is not completed the URI in the response can be used at a later time to get the updated state of the query. Once the query has completed the lineage request should be deleted by the client who originally submitted it.", - "operationId" : "submitLineageRequest", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The lineage query details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/LineageEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/LineageEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /provenance" : [ ] - }, { - "Read - /data/{component-type}/{uuid}" : [ ] - } ] - } - }, - "/provenance/lineage/{id}" : { - "get" : { - "tags" : [ "provenance" ], - "summary" : "Gets a lineage query", - "description" : "", - "operationId" : "getLineage", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "clusterNodeId", - "in" : "query", - "description" : "The id of the node where this query exists if clustered.", - "required" : false, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The id of the lineage query.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/LineageEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /provenance" : [ ] - }, { - "Read - /data/{component-type}/{uuid}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "provenance" ], - "summary" : "Deletes a lineage query", - "description" : "", - "operationId" : "deleteLineage", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "clusterNodeId", - "in" : "query", - "description" : "The id of the node where this query exists if clustered.", - "required" : false, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The id of the lineage query.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/LineageEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /provenance" : [ ] - } ] - } - }, - "/provenance/search-options" : { - "get" : { - "tags" : [ "provenance" ], - "summary" : "Gets the searchable attributes for provenance events", - "description" : "", - "operationId" : "getSearchOptions", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProvenanceOptionsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /provenance" : [ ] - } ] - } - }, - "/provenance/{id}" : { - "get" : { - "tags" : [ "provenance" ], - "summary" : "Gets a provenance query", - "description" : "", - "operationId" : "getProvenance", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "clusterNodeId", - "in" : "query", - "description" : "The id of the node where this query exists if clustered.", - "required" : false, - "type" : "string" - }, { - "name" : "summarize", - "in" : "query", - "description" : "Whether or not incremental results are returned. If false, provenance events are only returned once the query completes. This property is true by default.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "incrementalResults", - "in" : "query", - "description" : "Whether or not to summarize provenance events returned. This property is false by default.", - "required" : false, - "type" : "boolean", - "default" : true - }, { - "name" : "id", - "in" : "path", - "description" : "The id of the provenance query.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProvenanceEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /provenance" : [ ] - }, { - "Read - /data/{component-type}/{uuid}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "provenance" ], - "summary" : "Deletes a provenance query", - "description" : "", - "operationId" : "deleteProvenance", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "clusterNodeId", - "in" : "query", - "description" : "The id of the node where this query exists if clustered.", - "required" : false, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The id of the provenance query.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProvenanceEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /provenance" : [ ] - } ] - } - }, - "/remote-process-groups/process-group/{id}/run-status" : { - "put" : { - "tags" : [ "remote-process-groups" ], - "summary" : "Updates run status of all remote process groups in a process group (recursively)", - "description" : "", - "operationId" : "updateRemoteProcessGroupRunStatuses", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The remote process groups run status.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/RemotePortRunStatusEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/RemoteProcessGroupEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /remote-process-groups/{uuid} or /operation/remote-process-groups/{uuid}" : [ ] - } ] - } - }, - "/remote-process-groups/{id}" : { - "get" : { - "tags" : [ "remote-process-groups" ], - "summary" : "Gets a remote process group", - "description" : "", - "operationId" : "getRemoteProcessGroup", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The remote process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/RemoteProcessGroupEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /remote-process-groups/{uuid}" : [ ] - } ] - }, - "put" : { - "tags" : [ "remote-process-groups" ], - "summary" : "Updates a remote process group", - "description" : "", - "operationId" : "updateRemoteProcessGroup", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The remote process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The remote process group.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/RemoteProcessGroupEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/RemoteProcessGroupEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /remote-process-groups/{uuid}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "remote-process-groups" ], - "summary" : "Deletes a remote process group", - "description" : "", - "operationId" : "removeRemoteProcessGroup", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The revision is used to verify the client is working with the latest version of the flow.", - "required" : false, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The remote process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/RemoteProcessGroupEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /remote-process-groups/{uuid}" : [ ] - }, { - "Write - Parent Process Group - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/remote-process-groups/{id}/input-ports/{port-id}" : { - "put" : { - "tags" : [ "remote-process-groups" ], - "summary" : "Updates a remote port", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "updateRemoteProcessGroupInputPort", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The remote process group id.", - "required" : true, - "type" : "string" - }, { - "name" : "port-id", - "in" : "path", - "description" : "The remote process group port id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The remote process group port.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/RemoteProcessGroupPortEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/RemoteProcessGroupPortEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /remote-process-groups/{uuid}" : [ ] - } ] - } - }, - "/remote-process-groups/{id}/input-ports/{port-id}/run-status" : { - "put" : { - "tags" : [ "remote-process-groups" ], - "summary" : "Updates run status of a remote port", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "updateRemoteProcessGroupInputPortRunStatus", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The remote process group id.", - "required" : true, - "type" : "string" - }, { - "name" : "port-id", - "in" : "path", - "description" : "The remote process group port id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The remote process group port.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/RemotePortRunStatusEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/RemoteProcessGroupPortEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /remote-process-groups/{uuid} or /operation/remote-process-groups/{uuid}" : [ ] - } ] - } - }, - "/remote-process-groups/{id}/output-ports/{port-id}" : { - "put" : { - "tags" : [ "remote-process-groups" ], - "summary" : "Updates a remote port", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "updateRemoteProcessGroupOutputPort", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The remote process group id.", - "required" : true, - "type" : "string" - }, { - "name" : "port-id", - "in" : "path", - "description" : "The remote process group port id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The remote process group port.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/RemoteProcessGroupPortEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/RemoteProcessGroupPortEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /remote-process-groups/{uuid}" : [ ] - } ] - } - }, - "/remote-process-groups/{id}/output-ports/{port-id}/run-status" : { - "put" : { - "tags" : [ "remote-process-groups" ], - "summary" : "Updates run status of a remote port", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "updateRemoteProcessGroupOutputPortRunStatus", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The remote process group id.", - "required" : true, - "type" : "string" - }, { - "name" : "port-id", - "in" : "path", - "description" : "The remote process group port id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The remote process group port.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/RemotePortRunStatusEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/RemoteProcessGroupPortEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /remote-process-groups/{uuid} or /operation/remote-process-groups/{uuid}" : [ ] - } ] - } - }, - "/remote-process-groups/{id}/run-status" : { - "put" : { - "tags" : [ "remote-process-groups" ], - "summary" : "Updates run status of a remote process group", - "description" : "", - "operationId" : "updateRemoteProcessGroupRunStatus", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The remote process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The remote process group run status.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/RemotePortRunStatusEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/RemoteProcessGroupEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /remote-process-groups/{uuid} or /operation/remote-process-groups/{uuid}" : [ ] - } ] - } - }, - "/remote-process-groups/{id}/state" : { - "get" : { - "tags" : [ "remote-process-groups" ], - "summary" : "Gets the state for a RemoteProcessGroup", - "description" : "", - "operationId" : "getState", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The processor id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ComponentStateEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /remote-process-groups/{uuid}" : [ ] - } ] - } - }, - "/reporting-tasks/{id}" : { - "get" : { - "tags" : [ "reporting-tasks" ], - "summary" : "Gets a reporting task", - "description" : "", - "operationId" : "getReportingTask", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The reporting task id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ReportingTaskEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /reporting-tasks/{uuid}" : [ ] - } ] - }, - "put" : { - "tags" : [ "reporting-tasks" ], - "summary" : "Updates a reporting task", - "description" : "", - "operationId" : "updateReportingTask", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The reporting task id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The reporting task configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ReportingTaskEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ReportingTaskEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /reporting-tasks/{uuid}" : [ ] - }, { - "Read - any referenced Controller Services if this request changes the reference - /controller-services/{uuid}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "reporting-tasks" ], - "summary" : "Deletes a reporting task", - "description" : "", - "operationId" : "removeReportingTask", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The revision is used to verify the client is working with the latest version of the flow.", - "required" : false, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The reporting task id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ReportingTaskEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /reporting-tasks/{uuid}" : [ ] - }, { - "Write - /controller" : [ ] - }, { - "Read - any referenced Controller Services - /controller-services/{uuid}" : [ ] - } ] - } - }, - "/reporting-tasks/{id}/config/analysis" : { - "post" : { - "tags" : [ "reporting-tasks" ], - "summary" : "Performs analysis of the component's configuration, providing information about which attributes are referenced.", - "description" : "", - "operationId" : "analyzeConfiguration", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The reporting task id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The configuration analysis request.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ConfigurationAnalysisEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/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. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /reporting-tasks/{uuid}" : [ ] - } ] - } - }, - "/reporting-tasks/{id}/config/verification-requests" : { - "post" : { - "tags" : [ "reporting-tasks" ], - "summary" : "Performs verification of the Reporting Task's configuration", - "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", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The reporting task id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The reporting task configuration verification request.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/VerifyConfigRequestEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/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. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /reporting-tasks/{uuid}" : [ ] - } ] - } - }, - "/reporting-tasks/{id}/config/verification-requests/{requestId}" : { - "get" : { - "tags" : [ "reporting-tasks" ], - "summary" : "Returns the Verification Request with the given ID", - "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", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The ID of the Reporting Task", - "required" : true, - "type" : "string" - }, { - "name" : "requestId", - "in" : "path", - "description" : "The ID of the Verification Request", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/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. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Only the user that submitted the request can get it" : [ ] - } ] - }, - "delete" : { - "tags" : [ "reporting-tasks" ], - "summary" : "Deletes the Verification Request with the given ID", - "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", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The ID of the Reporting Task", - "required" : true, - "type" : "string" - }, { - "name" : "requestId", - "in" : "path", - "description" : "The ID of the Verification Request", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/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. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Only the user that submitted the request can remove it" : [ ] - } ] - } - }, - "/reporting-tasks/{id}/descriptors" : { - "get" : { - "tags" : [ "reporting-tasks" ], - "summary" : "Gets a reporting task property descriptor", - "description" : "", - "operationId" : "getPropertyDescriptor", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The reporting task id.", - "required" : true, - "type" : "string" - }, { - "name" : "propertyName", - "in" : "query", - "description" : "The property name.", - "required" : true, - "type" : "string" - }, { - "name" : "sensitive", - "in" : "query", - "description" : "Property Descriptor requested sensitive status", - "required" : false, - "type" : "boolean", - "default" : false - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/PropertyDescriptorEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /reporting-tasks/{uuid}" : [ ] - } ] - } - }, - "/reporting-tasks/{id}/run-status" : { - "put" : { - "tags" : [ "reporting-tasks" ], - "summary" : "Updates run status of a reporting task", - "description" : "", - "operationId" : "updateRunStatus", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The reporting task id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The reporting task run status.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ReportingTaskRunStatusEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ReportingTaskEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /reporting-tasks/{uuid} or or /operation/reporting-tasks/{uuid}" : [ ] - } ] - } - }, - "/reporting-tasks/{id}/state" : { - "get" : { - "tags" : [ "reporting-tasks" ], - "summary" : "Gets the state for a reporting task", - "description" : "", - "operationId" : "getState", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The reporting task id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ComponentStateEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /reporting-tasks/{uuid}" : [ ] - } ] - } - }, - "/reporting-tasks/{id}/state/clear-requests" : { - "post" : { - "tags" : [ "reporting-tasks" ], - "summary" : "Clears the state for a reporting task", - "description" : "", - "operationId" : "clearState", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The reporting task id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ComponentStateEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /reporting-tasks/{uuid}" : [ ] - } ] - } - }, - "/resources" : { - "get" : { - "tags" : [ "resources" ], - "summary" : "Gets the available resources that support access/authorization policies", - "description" : "", - "operationId" : "getResources", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ResourcesEntity" - } - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - } - }, - "security" : [ { - "Read - /resources" : [ ] - } ] - } - }, - "/site-to-site" : { - "get" : { - "tags" : [ "site-to-site" ], - "summary" : "Returns the details about this NiFi necessary to communicate via site to site", - "description" : "", - "operationId" : "getSiteToSiteDetails", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ControllerEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /site-to-site" : [ ] - } ] - } - }, - "/site-to-site/peers" : { - "get" : { - "tags" : [ "site-to-site" ], - "summary" : "Returns the available Peers and its status of this NiFi", - "description" : "", - "operationId" : "getPeers", - "consumes" : [ "*/*" ], - "produces" : [ "application/json", "application/xml" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/PeersEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /site-to-site" : [ ] - } ] - } - }, - "/snippets" : { - "post" : { - "tags" : [ "snippets" ], - "summary" : "Creates a snippet. The snippet will be automatically discarded if not used in a subsequent request after 1 minute.", - "description" : "", - "operationId" : "createSnippet", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The snippet configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/SnippetEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/SnippetEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read or Write - /{component-type}/{uuid} - For every component (all Read or all Write) in the Snippet and their descendant components" : [ ] - } ] - } - }, - "/snippets/{id}" : { - "put" : { - "tags" : [ "snippets" ], - "summary" : "Move's the components in this Snippet into a new Process Group and discards the snippet", - "description" : "", - "operationId" : "updateSnippet", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The snippet id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The snippet configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/SnippetEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/SnippetEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write Process Group - /process-groups/{uuid}" : [ ] - }, { - "Write - /{component-type}/{uuid} - For each component in the Snippet and their descendant components" : [ ] - } ] - }, - "delete" : { - "tags" : [ "snippets" ], - "summary" : "Deletes the components in a snippet and discards the snippet", - "description" : "", - "operationId" : "deleteSnippet", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The snippet id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/SnippetEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /{component-type}/{uuid} - For each component in the Snippet and their descendant components" : [ ] - }, { - "Write - Parent Process Group - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/system-diagnostics" : { - "get" : { - "tags" : [ "system-diagnostics" ], - "summary" : "Gets the diagnostics for the system NiFi is running on", - "description" : "", - "operationId" : "getSystemDiagnostics", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "nodewise", - "in" : "query", - "description" : "Whether or not to include the breakdown per node. Optional, defaults to false", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "clusterNodeId", - "in" : "query", - "description" : "The id of the node where to get the status.", - "required" : false, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/SystemDiagnosticsEntity" - } - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - } - }, - "security" : [ { - "Read - /system" : [ ] - } ] - } - }, - "/templates/{id}" : { - "delete" : { - "tags" : [ "templates" ], - "summary" : "Deletes a template", - "description" : "", - "operationId" : "removeTemplate", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The template id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/TemplateEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /templates/{uuid}" : [ ] - }, { - "Write - Parent Process Group - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/templates/{id}/download" : { - "get" : { - "tags" : [ "templates" ], - "summary" : "Exports a template", - "description" : "", - "operationId" : "exportTemplate", - "consumes" : [ "*/*" ], - "produces" : [ "application/xml" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The template id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /templates/{uuid}" : [ ] - } ] - } - }, - "/tenants/search-results" : { - "get" : { - "tags" : [ "tenants" ], - "summary" : "Searches for a tenant with the specified identity", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "searchTenants", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "q", - "in" : "query", - "description" : "Identity to search for.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/TenantsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /tenants" : [ ] - } ] - } - }, - "/tenants/user-groups" : { - "get" : { - "tags" : [ "tenants" ], - "summary" : "Gets all user groups", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getUserGroups", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/UserGroupsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /tenants" : [ ] - } ] - }, - "post" : { - "tags" : [ "tenants" ], - "summary" : "Creates a user group", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "createUserGroup", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The user group configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/UserGroupEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/UserGroupEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /tenants" : [ ] - } ] - } - }, - "/tenants/user-groups/{id}" : { - "get" : { - "tags" : [ "tenants" ], - "summary" : "Gets a user group", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getUserGroup", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The user group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/UserGroupEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /tenants" : [ ] - } ] - }, - "put" : { - "tags" : [ "tenants" ], - "summary" : "Updates a user group", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "updateUserGroup", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The user group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The user group configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/UserGroupEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/UserGroupEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /tenants" : [ ] - } ] - }, - "delete" : { - "tags" : [ "tenants" ], - "summary" : "Deletes a user group", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "removeUserGroup", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The revision is used to verify the client is working with the latest version of the flow.", - "required" : false, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The user group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/UserGroupEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /tenants" : [ ] - } ] - } - }, - "/tenants/users" : { - "get" : { - "tags" : [ "tenants" ], - "summary" : "Gets all users", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getUsers", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/UsersEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /tenants" : [ ] - } ] - }, - "post" : { - "tags" : [ "tenants" ], - "summary" : "Creates a user", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "createUser", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The user configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/UserEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/UserEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /tenants" : [ ] - } ] - } - }, - "/tenants/users/{id}" : { - "get" : { - "tags" : [ "tenants" ], - "summary" : "Gets a user", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getUser", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The user id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/UserEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /tenants" : [ ] - } ] - }, - "put" : { - "tags" : [ "tenants" ], - "summary" : "Updates a user", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "updateUser", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The user id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The user configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/UserEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/UserEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /tenants" : [ ] - } ] - }, - "delete" : { - "tags" : [ "tenants" ], - "summary" : "Deletes a user", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "removeUser", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The revision is used to verify the client is working with the latest version of the flow.", - "required" : false, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The user id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/UserEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /tenants" : [ ] - } ] - } - }, - "/versions/active-requests" : { - "post" : { - "tags" : [ "versions" ], - "summary" : "Create a version control request", - "description" : "Creates a request so that a Process Group can be placed under Version Control or have its Version Control configuration changed. Creating this request will prevent any other threads from simultaneously saving local changes to Version Control. It will not, however, actually save the local flow to the Flow Registry. A POST to /versions/process-groups/{id} should be used to initiate saving of the local flow to the Flow Registry. Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "createVersionControlRequest", - "consumes" : [ "application/json" ], - "produces" : [ "text/plain" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The versioned flow details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/CreateActiveRequestEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/versions/active-requests/{id}" : { - "put" : { - "tags" : [ "versions" ], - "summary" : "Updates the request with the given ID", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "updateVersionControlRequest", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The request ID.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The version control component mapping.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/VersionControlComponentMappingEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionControlInformationEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Only the user that submitted the request can update it" : [ ] - } ] - }, - "delete" : { - "tags" : [ "versions" ], - "summary" : "Deletes the version control request with the given ID", - "description" : "Deletes the Version Control Request with the given ID. This will allow other threads to save flows to the Flow Registry. See also the documentation for POSTing to /versions/active-requests for information regarding why this is done. Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "deleteVersionControlRequest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The request ID.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Only the user that submitted the request can remove it" : [ ] - } ] - } - }, - "/versions/process-groups/{id}" : { - "get" : { - "tags" : [ "versions" ], - "summary" : "Gets the Version Control information for a process group", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getVersionInformation", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionControlInformationEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - } ] - }, - "post" : { - "tags" : [ "versions" ], - "summary" : "Save the Process Group with the given ID", - "description" : "Begins version controlling the Process Group with the given ID or commits changes to the Versioned Flow, depending on if the provided VersionControlInformation includes a flowId. Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "saveToFlowRegistry", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The versioned flow details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/StartVersionControlRequestEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionControlInformationEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - }, { - "Write - /process-groups/{uuid}" : [ ] - }, { - "Read - /{component-type}/{uuid} - For all encapsulated components" : [ ] - }, { - "Read - any referenced Controller Services by any encapsulated components - /controller-services/{uuid}" : [ ] - } ] - }, - "put" : { - "tags" : [ "versions" ], - "summary" : "Update the version of a Process Group with the given ID", - "description" : "For a Process Group that is already under Version Control, this will update the version of the flow to a different version. This endpoint expects that the given snapshot will not modify any Processor that is currently running or any Controller Service that is enabled. Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "updateFlowVersion", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The controller service configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/VersionedFlowSnapshotEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionControlInformationEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - }, { - "Write - /process-groups/{uuid}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "versions" ], - "summary" : "Stops version controlling the Process Group with the given ID", - "description" : "Stops version controlling the Process Group with the given ID. The Process Group will no longer track to any Versioned Flow. Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "stopVersionControl", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The version is used to verify the client is working with the latest version of the flow.", - "required" : false, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, a new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionControlInformationEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - }, { - "Write - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/versions/process-groups/{id}/download" : { - "get" : { - "tags" : [ "versions" ], - "summary" : "Gets the latest version of a Process Group for download", - "description" : "", - "operationId" : "exportFlowVersion", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/versions/revert-requests/process-groups/{id}" : { - "post" : { - "tags" : [ "versions" ], - "summary" : "Initiate the Revert Request of a Process Group with the given ID", - "description" : "For a Process Group that is already under Version Control, this will initiate the action of reverting any local changes that have been made to the Process Group since it was last synchronized with the Flow Registry. This will result in the flow matching the Versioned Flow that exists in the Flow Registry. This can be a lengthy process, as it will stop any Processors and disable any Controller Services necessary to perform the action and then restart them. As a result, the endpoint will immediately return a VersionedFlowUpdateRequestEntity, and the process of updating the flow will occur asynchronously in the background. The client may then periodically poll the status of the request by issuing a GET request to /versions/revert-requests/{requestId}. Once the request is completed, the client is expected to issue a DELETE request to /versions/revert-requests/{requestId}. Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "initiateRevertFlowVersion", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The Version Control Information to revert to.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/VersionControlInformationEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlowUpdateRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - }, { - "Write - /process-groups/{uuid}" : [ ] - }, { - "Read - /{component-type}/{uuid} - For all encapsulated components" : [ ] - }, { - "Write - /{component-type}/{uuid} - For all encapsulated components" : [ ] - }, { - "Write - if the template contains any restricted components - /restricted-components" : [ ] - }, { - "Read - /parameter-contexts/{uuid} - For any Parameter Context that is referenced by a Property that is changed, added, or removed" : [ ] - } ] - } - }, - "/versions/revert-requests/{id}" : { - "get" : { - "tags" : [ "versions" ], - "summary" : "Returns the Revert Request with the given ID", - "description" : "Returns the Revert Request with the given ID. Once a Revert Request has been created by performing a POST to /versions/revert-requests/process-groups/{id}, that request can subsequently be retrieved via this endpoint, and the request that is fetched will contain the updated state, such as percent complete, the current state of the request, and any failures. Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getRevertRequest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The ID of the Revert Request", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlowUpdateRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Only the user that submitted the request can get it" : [ ] - } ] - }, - "delete" : { - "tags" : [ "versions" ], - "summary" : "Deletes the Revert Request with the given ID", - "description" : "Deletes the Revert Request with the given ID. After a request is created via a POST to /versions/revert-requests/process-groups/{id}, it is expected that the client will properly clean up the request by DELETE'ing it, once the Revert process has completed. If the request is deleted before the request completes, then the Revert request will finish the step that it is currently performing and then will cancel any subsequent steps. Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "deleteRevertRequest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The ID of the Revert Request", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlowUpdateRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Only the user that submitted the request can remove it" : [ ] - } ] - } - }, - "/versions/update-requests/process-groups/{id}" : { - "post" : { - "tags" : [ "versions" ], - "summary" : "Initiate the Update Request of a Process Group with the given ID", - "description" : "For a Process Group that is already under Version Control, this will initiate the action of changing from a specific version of the flow in the Flow Registry to a different version of the flow. This can be a lengthy process, as it will stop any Processors and disable any Controller Services necessary to perform the action and then restart them. As a result, the endpoint will immediately return a VersionedFlowUpdateRequestEntity, and the process of updating the flow will occur asynchronously in the background. The client may then periodically poll the status of the request by issuing a GET request to /versions/update-requests/{requestId}. Once the request is completed, the client is expected to issue a DELETE request to /versions/update-requests/{requestId}. Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "initiateVersionControlUpdate", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The controller service configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/VersionControlInformationEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlowUpdateRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - }, { - "Write - /process-groups/{uuid}" : [ ] - }, { - "Read - /{component-type}/{uuid} - For all encapsulated components" : [ ] - }, { - "Write - /{component-type}/{uuid} - For all encapsulated components" : [ ] - }, { - "Write - if the template contains any restricted components - /restricted-components" : [ ] - }, { - "Read - /parameter-contexts/{uuid} - For any Parameter Context that is referenced by a Property that is changed, added, or removed" : [ ] - } ] - } - }, - "/versions/update-requests/{id}" : { - "get" : { - "tags" : [ "versions" ], - "summary" : "Returns the Update Request with the given ID", - "description" : "Returns the Update Request with the given ID. Once an Update Request has been created by performing a POST to /versions/update-requests/process-groups/{id}, that request can subsequently be retrieved via this endpoint, and the request that is fetched will contain the updated state, such as percent complete, the current state of the request, and any failures. Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getUpdateRequest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The ID of the Update Request", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlowUpdateRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Only the user that submitted the request can get it" : [ ] - } ] - }, - "delete" : { - "tags" : [ "versions" ], - "summary" : "Deletes the Update Request with the given ID", - "description" : "Deletes the Update Request with the given ID. After a request is created via a POST to /versions/update-requests/process-groups/{id}, it is expected that the client will properly clean up the request by DELETE'ing it, once the Update process has completed. If the request is deleted before the request completes, then the Update request will finish the step that it is currently performing and then will cancel any subsequent steps. Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "deleteUpdateRequest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The ID of the Update Request", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlowUpdateRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Only the user that submitted the request can remove it" : [ ] - } ] - } - } - }, - "definitions" : { - "AboutDTO" : { - "type" : "object", - "properties" : { - "title" : { - "type" : "string", - "description" : "The title to be used on the page and in the about dialog." - }, - "version" : { - "type" : "string", - "description" : "The version of this NiFi." - }, - "uri" : { - "type" : "string", - "description" : "The URI for the NiFi." - }, - "contentViewerUrl" : { - "type" : "string", - "description" : "The URL for the content viewer if configured." - }, - "timezone" : { - "type" : "string", - "description" : "The timezone of the NiFi instance." - }, - "buildTag" : { - "type" : "string", - "description" : "Build tag" - }, - "buildRevision" : { - "type" : "string", - "description" : "Build revision or commit hash" - }, - "buildBranch" : { - "type" : "string", - "description" : "Build branch" - }, - "buildTimestamp" : { - "type" : "string", - "description" : "Build timestamp" - } - } - }, - "AboutEntity" : { - "type" : "object", - "properties" : { - "about" : { - "$ref" : "#/definitions/AboutDTO" - } - }, - "xml" : { - "name" : "aboutEntity" - } - }, - "AccessConfigurationDTO" : { - "type" : "object", - "properties" : { - "supportsLogin" : { - "type" : "boolean", - "description" : "Indicates whether or not this NiFi supports user login." - } - } - }, - "AccessConfigurationEntity" : { - "type" : "object", - "properties" : { - "config" : { - "$ref" : "#/definitions/AccessConfigurationDTO" - } - }, - "xml" : { - "name" : "accessConfigurationEntity" - } - }, - "AccessPolicyDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "versionedComponentId" : { - "type" : "string", - "description" : "The ID of the corresponding component that is under version control" - }, - "parentGroupId" : { - "type" : "string", - "description" : "The id of parent process group of this component if applicable." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "resource" : { - "type" : "string", - "description" : "The resource for this access policy." - }, - "action" : { - "type" : "string", - "description" : "The action associated with this access policy.", - "enum" : [ "read", "write" ] - }, - "componentReference" : { - "description" : "Component this policy references if applicable.", - "$ref" : "#/definitions/ComponentReferenceEntity" - }, - "configurable" : { - "type" : "boolean", - "description" : "Whether this policy is configurable." - }, - "users" : { - "type" : "array", - "description" : "The set of user IDs associated with this access policy.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/TenantEntity" - } - }, - "userGroups" : { - "type" : "array", - "description" : "The set of user group IDs associated with this access policy.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/TenantEntity" - } - } - } - }, - "AccessPolicyEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "generated" : { - "type" : "string", - "description" : "When this content was generated." - }, - "component" : { - "$ref" : "#/definitions/AccessPolicyDTO" - } - }, - "xml" : { - "name" : "accessPolicyEntity" - } - }, - "AccessPolicySummaryDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "versionedComponentId" : { - "type" : "string", - "description" : "The ID of the corresponding component that is under version control" - }, - "parentGroupId" : { - "type" : "string", - "description" : "The id of parent process group of this component if applicable." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "resource" : { - "type" : "string", - "description" : "The resource for this access policy." - }, - "action" : { - "type" : "string", - "description" : "The action associated with this access policy.", - "enum" : [ "read", "write" ] - }, - "componentReference" : { - "description" : "Component this policy references if applicable.", - "$ref" : "#/definitions/ComponentReferenceEntity" - }, - "configurable" : { - "type" : "boolean", - "description" : "Whether this policy is configurable." - } - } - }, - "AccessPolicySummaryEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "component" : { - "$ref" : "#/definitions/AccessPolicySummaryDTO" - } - }, - "xml" : { - "name" : "accessPolicySummaryEntity" - } - }, - "AccessStatusDTO" : { - "type" : "object", - "properties" : { - "identity" : { - "type" : "string", - "description" : "The user identity." - }, - "status" : { - "type" : "string", - "description" : "The user access status." - }, - "message" : { - "type" : "string", - "description" : "Additional details about the user access status." - } - }, - "xml" : { - "name" : "accessStatus" - } - }, - "AccessStatusEntity" : { - "type" : "object", - "properties" : { - "accessStatus" : { - "$ref" : "#/definitions/AccessStatusDTO" - } - }, - "xml" : { - "name" : "accessStatusEntity" - } - }, - "AccessTokenExpirationDTO" : { - "type" : "object", - "properties" : { - "expiration" : { - "type" : "string", - "description" : "Token Expiration" - } - }, - "xml" : { - "name" : "accessTokenExpiration" - } - }, - "AccessTokenExpirationEntity" : { - "type" : "object", - "properties" : { - "accessTokenExpiration" : { - "$ref" : "#/definitions/AccessTokenExpirationDTO" - } - }, - "xml" : { - "name" : "accessTokenExpirationEntity" - } - }, - "ActionDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "integer", - "format" : "int32", - "description" : "The action id." - }, - "userIdentity" : { - "type" : "string", - "description" : "The identity of the user that performed the action." - }, - "timestamp" : { - "type" : "string", - "description" : "The timestamp of the action." - }, - "sourceId" : { - "type" : "string", - "description" : "The id of the source component." - }, - "sourceName" : { - "type" : "string", - "description" : "The name of the source component." - }, - "sourceType" : { - "type" : "string", - "description" : "The type of the source component." - }, - "componentDetails" : { - "description" : "The details of the source component.", - "$ref" : "#/definitions/ComponentDetailsDTO" - }, - "operation" : { - "type" : "string", - "description" : "The operation that was performed." - }, - "actionDetails" : { - "description" : "The details of the action.", - "$ref" : "#/definitions/ActionDetailsDTO" - } - } - }, - "ActionDetailsDTO" : { - "type" : "object" - }, - "ActionEntity" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "integer", - "format" : "int32" - }, - "timestamp" : { - "type" : "string", - "description" : "The timestamp of the action." - }, - "sourceId" : { - "type" : "string" - }, - "canRead" : { - "type" : "boolean", - "description" : "Indicates whether the user can read a given resource." - }, - "action" : { - "$ref" : "#/definitions/ActionDTO" - } - }, - "xml" : { - "name" : "actionEntity" - } - }, - "ActivateControllerServicesEntity" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the ProcessGroup" - }, - "state" : { - "type" : "string", - "description" : "The desired state of the descendant components", - "enum" : [ "ENABLED", "DISABLED" ] - }, - "components" : { - "type" : "object", - "description" : "Optional services to schedule. If not specified, all authorized descendant controller services will be used.", - "additionalProperties" : { - "$ref" : "#/definitions/RevisionDTO" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - } - }, - "xml" : { - "name" : "activateControllerServicesEntity" - } - }, - "AffectedComponentDTO" : { - "type" : "object", - "properties" : { - "processGroupId" : { - "type" : "string", - "description" : "The UUID of the Process Group that this component is in" - }, - "id" : { - "type" : "string", - "description" : "The UUID of this component" - }, - "referenceType" : { - "type" : "string", - "description" : "The type of this component", - "enum" : [ "PROCESSOR", "CONTROLLER_SERVICE", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT" ] - }, - "name" : { - "type" : "string", - "description" : "The name of this component." - }, - "state" : { - "type" : "string", - "description" : "The scheduled state of a processor or reporting task referencing a controller service. If this component is another controller service, this field represents the controller service state." - }, - "activeThreadCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of active threads for the referencing component." - }, - "validationErrors" : { - "type" : "array", - "description" : "The validation errors for the component.", - "items" : { - "type" : "string" - } - } - } - }, - "AffectedComponentEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "component" : { - "$ref" : "#/definitions/AffectedComponentDTO" - }, - "processGroup" : { - "description" : "The Process Group that the component belongs to", - "$ref" : "#/definitions/ProcessGroupNameDTO" - }, - "referenceType" : { - "type" : "string", - "description" : "The type of component referenced", - "enum" : [ "PROCESSOR", "CONTROLLER_SERVICE", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT" ] - } - }, - "xml" : { - "name" : "affectedComponentEntity" - } - }, - "AllowableValueDTO" : { - "type" : "object", - "properties" : { - "displayName" : { - "type" : "string", - "description" : "A human readable value that is allowed for the property descriptor." - }, - "value" : { - "type" : "string", - "description" : "A value that is allowed for the property descriptor." - }, - "description" : { - "type" : "string", - "description" : "A description for this allowable value." - } - } - }, - "AllowableValueEntity" : { - "type" : "object", - "properties" : { - "allowableValue" : { - "$ref" : "#/definitions/AllowableValueDTO" - }, - "canRead" : { - "type" : "boolean", - "description" : "Indicates whether the user can read a given resource." - } - }, - "xml" : { - "name" : "entity" - } - }, - "AttributeDTO" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The attribute name." - }, - "value" : { - "type" : "string", - "description" : "The attribute value." - }, - "previousValue" : { - "type" : "string", - "description" : "The value of the attribute before the event took place." - } - } - }, - "BannerDTO" : { - "type" : "object", - "properties" : { - "headerText" : { - "type" : "string", - "description" : "The header text." - }, - "footerText" : { - "type" : "string", - "description" : "The footer text." - } - } - }, - "BannerEntity" : { - "type" : "object", - "properties" : { - "banners" : { - "$ref" : "#/definitions/BannerDTO" - } - }, - "xml" : { - "name" : "bannersEntity" - } - }, - "BatchSettingsDTO" : { - "type" : "object", - "properties" : { - "count" : { - "type" : "integer", - "format" : "int32", - "description" : "Preferred number of flow files to include in a transaction." - }, - "size" : { - "type" : "string", - "description" : "Preferred number of bytes to include in a transaction." - }, - "duration" : { - "type" : "string", - "description" : "Preferred amount of time that a transaction should span." - } - } - }, - "BatchSize" : { - "type" : "object", - "properties" : { - "count" : { - "type" : "integer", - "format" : "int32", - "description" : "Preferred number of flow files to include in a transaction." - }, - "size" : { - "type" : "string", - "description" : "Preferred number of bytes to include in a transaction." - }, - "duration" : { - "type" : "string", - "description" : "Preferred amount of time that a transaction should span." - } - } - }, - "BuildInfo" : { - "type" : "object", - "properties" : { - "version" : { - "type" : "string", - "description" : "The version number of the built component." - }, - "revision" : { - "type" : "string", - "description" : "The SCM revision id of the source code used for this build." - }, - "timestamp" : { - "type" : "integer", - "format" : "int64", - "description" : "The timestamp (milliseconds since Epoch) of the build." - }, - "targetArch" : { - "type" : "string", - "description" : "The target architecture of the built component." - }, - "compiler" : { - "type" : "string", - "description" : "The compiler used for the build" - }, - "compilerFlags" : { - "type" : "string", - "description" : "The compiler flags used for the build." - } - } - }, - "BulletinBoardDTO" : { - "type" : "object", - "properties" : { - "bulletins" : { - "type" : "array", - "description" : "The bulletins in the bulletin board, that matches the supplied request.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "generated" : { - "type" : "string", - "description" : "The timestamp when this report was generated." - } - } - }, - "BulletinBoardEntity" : { - "type" : "object", - "properties" : { - "bulletinBoard" : { - "$ref" : "#/definitions/BulletinBoardDTO" - } - }, - "xml" : { - "name" : "bulletinBoardEntity" - } - }, - "BulletinDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "integer", - "format" : "int64", - "description" : "The id of the bulletin." - }, - "nodeAddress" : { - "type" : "string", - "description" : "If clustered, the address of the node from which the bulletin originated." - }, - "category" : { - "type" : "string", - "description" : "The category of this bulletin." - }, - "groupId" : { - "type" : "string", - "description" : "The group id of the source component." - }, - "sourceId" : { - "type" : "string", - "description" : "The id of the source component." - }, - "sourceName" : { - "type" : "string", - "description" : "The name of the source component." - }, - "level" : { - "type" : "string", - "description" : "The level of the bulletin." - }, - "message" : { - "type" : "string", - "description" : "The bulletin message." - }, - "timestamp" : { - "type" : "string", - "description" : "When this bulletin was generated." - } - } - }, - "BulletinEntity" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "integer", - "format" : "int64" - }, - "groupId" : { - "type" : "string" - }, - "sourceId" : { - "type" : "string" - }, - "timestamp" : { - "type" : "string", - "description" : "When this bulletin was generated." - }, - "nodeAddress" : { - "type" : "string" - }, - "canRead" : { - "type" : "boolean", - "description" : "Indicates whether the user can read a given resource." - }, - "bulletin" : { - "$ref" : "#/definitions/BulletinDTO" - } - }, - "xml" : { - "name" : "bulletinEntity" - } - }, - "Bundle" : { - "type" : "object", - "properties" : { - "group" : { - "type" : "string", - "description" : "The group of the bundle" - }, - "artifact" : { - "type" : "string", - "description" : "The artifact of the bundle" - }, - "version" : { - "type" : "string", - "description" : "The version of the bundle" - } - } - }, - "BundleDTO" : { - "type" : "object", - "properties" : { - "group" : { - "type" : "string", - "description" : "The group of the bundle." - }, - "artifact" : { - "type" : "string", - "description" : "The artifact of the bundle." - }, - "version" : { - "type" : "string", - "description" : "The version of the bundle." - } - } - }, - "ClassLoaderDiagnosticsDTO" : { - "type" : "object", - "properties" : { - "bundle" : { - "description" : "Information about the Bundle that the ClassLoader belongs to, if any", - "$ref" : "#/definitions/BundleDTO" - }, - "parentClassLoader" : { - "description" : "A ClassLoaderDiagnosticsDTO that provides information about the parent ClassLoader", - "$ref" : "#/definitions/ClassLoaderDiagnosticsDTO" - } - } - }, - "ClusteSummaryEntity" : { - "type" : "object", - "properties" : { - "clusterSummary" : { - "$ref" : "#/definitions/ClusterSummaryDTO" - } - }, - "xml" : { - "name" : "clusterSummaryEntity" - } - }, - "ClusterDTO" : { - "type" : "object", - "properties" : { - "nodes" : { - "type" : "array", - "description" : "The collection of nodes that are part of the cluster.", - "items" : { - "$ref" : "#/definitions/NodeDTO" - } - }, - "generated" : { - "type" : "string", - "description" : "The timestamp the report was generated." - } - } - }, - "ClusterEntity" : { - "type" : "object", - "properties" : { - "cluster" : { - "$ref" : "#/definitions/ClusterDTO" - } - }, - "xml" : { - "name" : "clusterEntity" - } - }, - "ClusterSearchResultsEntity" : { - "type" : "object", - "properties" : { - "nodeResults" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/NodeSearchResultDTO" - } - } - }, - "xml" : { - "name" : "clusterSearchResultsEntity" - } - }, - "ClusterSummaryDTO" : { - "type" : "object", - "properties" : { - "connectedNodes" : { - "type" : "string", - "description" : "When clustered, reports the number of nodes connected vs the number of nodes in the cluster." - }, - "connectedNodeCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of nodes that are currently connected to the cluster" - }, - "totalNodeCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of nodes in the cluster, regardless of whether or not they are connected" - }, - "clustered" : { - "type" : "boolean", - "description" : "Whether this NiFi instance is clustered." - }, - "connectedToCluster" : { - "type" : "boolean", - "description" : "Whether this NiFi instance is connected to a cluster." - } - } - }, - "ComponentDetailsDTO" : { - "type" : "object" - }, - "ComponentDifferenceDTO" : { - "type" : "object", - "properties" : { - "componentType" : { - "type" : "string", - "description" : "The type of component" - }, - "componentId" : { - "type" : "string", - "description" : "The ID of the component" - }, - "componentName" : { - "type" : "string", - "description" : "The name of the component" - }, - "processGroupId" : { - "type" : "string", - "description" : "The ID of the Process Group that the component belongs to" - }, - "differences" : { - "type" : "array", - "description" : "The differences in the component between the two flows", - "items" : { - "$ref" : "#/definitions/DifferenceDTO" - } - } - } - }, - "ComponentHistoryDTO" : { - "type" : "object", - "properties" : { - "componentId" : { - "type" : "string", - "description" : "The component id." - }, - "propertyHistory" : { - "type" : "object", - "description" : "The history for the properties of the component.", - "additionalProperties" : { - "$ref" : "#/definitions/PropertyHistoryDTO" - } - } - } - }, - "ComponentHistoryEntity" : { - "type" : "object", - "properties" : { - "componentHistory" : { - "$ref" : "#/definitions/ComponentHistoryDTO" - } - }, - "xml" : { - "name" : "componentHistoryEntity" - } - }, - "ComponentLifecycle" : { - "type" : "object" - }, - "ComponentManifest" : { - "type" : "object", - "properties" : { - "apis" : { - "type" : "array", - "description" : "Public interfaces defined in this bundle", - "items" : { - "$ref" : "#/definitions/DefinedType" - } - }, - "controllerServices" : { - "type" : "array", - "description" : "Controller Services provided in this bundle", - "items" : { - "$ref" : "#/definitions/ControllerServiceDefinition" - } - }, - "processors" : { - "type" : "array", - "description" : "Processors provided in this bundle", - "items" : { - "$ref" : "#/definitions/ProcessorDefinition" - } - }, - "reportingTasks" : { - "type" : "array", - "description" : "Reporting Tasks provided in this bundle", - "items" : { - "$ref" : "#/definitions/ReportingTaskDefinition" - } - } - } - }, - "ComponentReferenceDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "versionedComponentId" : { - "type" : "string", - "description" : "The ID of the corresponding component that is under version control" - }, - "parentGroupId" : { - "type" : "string", - "description" : "The id of parent process group of this component if applicable." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "name" : { - "type" : "string", - "description" : "The name of the component." - } - } - }, - "ComponentReferenceEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "parentGroupId" : { - "type" : "string", - "description" : "The id of parent process group of this component if applicable." - }, - "component" : { - "$ref" : "#/definitions/ComponentReferenceDTO" - } - }, - "xml" : { - "name" : "componentReferenceEntity" - } - }, - "ComponentRestrictionPermissionDTO" : { - "type" : "object", - "properties" : { - "requiredPermission" : { - "description" : "The required permission necessary for this restriction.", - "$ref" : "#/definitions/RequiredPermissionDTO" - }, - "permissions" : { - "description" : "The permissions for this component restriction. Note: the read permission are not used and will always be false.", - "$ref" : "#/definitions/PermissionsDTO" - } - } - }, - "ComponentSearchResultDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component that matched the search." - }, - "groupId" : { - "type" : "string", - "description" : "The group id of the component that matched the search." - }, - "parentGroup" : { - "description" : "The parent group of the component that matched the search.", - "$ref" : "#/definitions/SearchResultGroupDTO" - }, - "versionedGroup" : { - "description" : "The nearest versioned ancestor group of the component that matched the search.", - "$ref" : "#/definitions/SearchResultGroupDTO" - }, - "name" : { - "type" : "string", - "description" : "The name of the component that matched the search." - }, - "matches" : { - "type" : "array", - "description" : "What matched the search from the component.", - "items" : { - "type" : "string" - } - } - } - }, - "ComponentStateDTO" : { - "type" : "object", - "properties" : { - "componentId" : { - "type" : "string", - "description" : "The component identifier." - }, - "stateDescription" : { - "type" : "string", - "description" : "Description of the state this component persists." - }, - "clusterState" : { - "description" : "The cluster state for this component, or null if this NiFi is a standalone instance.", - "$ref" : "#/definitions/StateMapDTO" - }, - "localState" : { - "description" : "The local state for this component.", - "$ref" : "#/definitions/StateMapDTO" - } - } - }, - "ComponentStateEntity" : { - "type" : "object", - "properties" : { - "componentState" : { - "description" : "The component state.", - "$ref" : "#/definitions/ComponentStateDTO" - } - }, - "xml" : { - "name" : "componentStateEntity" - } - }, - "ComponentValidationResultDTO" : { - "type" : "object", - "properties" : { - "processGroupId" : { - "type" : "string", - "description" : "The UUID of the Process Group that this component is in" - }, - "id" : { - "type" : "string", - "description" : "The UUID of this component" - }, - "referenceType" : { - "type" : "string", - "description" : "The type of this component", - "enum" : [ "PROCESSOR", "CONTROLLER_SERVICE", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT" ] - }, - "name" : { - "type" : "string", - "description" : "The name of this component." - }, - "state" : { - "type" : "string", - "description" : "The scheduled state of a processor or reporting task referencing a controller service. If this component is another controller service, this field represents the controller service state." - }, - "activeThreadCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of active threads for the referencing component." - }, - "validationErrors" : { - "type" : "array", - "description" : "The validation errors for the component.", - "items" : { - "type" : "string" - } - }, - "currentlyValid" : { - "type" : "boolean", - "description" : "Whether or not the component is currently valid" - }, - "resultsValid" : { - "type" : "boolean", - "description" : "Whether or not the component will be valid if the Parameter Context is changed" - }, - "resultantValidationErrors" : { - "type" : "array", - "description" : "The validation errors that will apply to the component if the Parameter Context is changed", - "items" : { - "type" : "string" - } - } - } - }, - "ComponentValidationResultEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "component" : { - "$ref" : "#/definitions/ComponentValidationResultDTO" - } - }, - "xml" : { - "name" : "componentValidationResultEntity" - } - }, - "ComponentValidationResultsEntity" : { - "type" : "object", - "properties" : { - "validationResults" : { - "type" : "array", - "description" : "A List of ComponentValidationResultEntity, one for each component that is validated", - "items" : { - "$ref" : "#/definitions/ComponentValidationResultEntity" - } - } - }, - "xml" : { - "name" : "componentValidationResults" - } - }, - "ConfigVerificationResultDTO" : { - "type" : "object", - "properties" : { - "outcome" : { - "type" : "string", - "description" : "The outcome of the verification", - "enum" : [ "SUCCESSFUL", "FAILED", "SKIPPED" ] - }, - "verificationStepName" : { - "type" : "string", - "description" : "The name of the verification step" - }, - "explanation" : { - "type" : "string", - "description" : "An explanation of why the step was or was not successful" - } - } - }, - "ConfigurationAnalysisDTO" : { - "type" : "object", - "properties" : { - "componentId" : { - "type" : "string", - "description" : "The ID of the component" - }, - "properties" : { - "type" : "object", - "description" : "The configured properties for the component", - "additionalProperties" : { - "type" : "string" - } - }, - "referencedAttributes" : { - "type" : "object", - "description" : "The attributes that are referenced by the properties, mapped to recently used values", - "additionalProperties" : { - "type" : "string" - } - }, - "supportsVerification" : { - "type" : "boolean", - "description" : "Whether or not the component supports verification" - } - } - }, - "ConfigurationAnalysisEntity" : { - "type" : "object", - "properties" : { - "configurationAnalysis" : { - "description" : "The configuration analysis", - "$ref" : "#/definitions/ConfigurationAnalysisDTO" - } - }, - "xml" : { - "name" : "configurationAnalysis" - } - }, - "ConnectableComponent" : { - "type" : "object", - "required" : [ "groupId", "id", "type" ], - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the connectable component." - }, - "type" : { - "type" : "string", - "description" : "The type of component the connectable is.", - "enum" : [ "PROCESSOR", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "INPUT_PORT", "OUTPUT_PORT", "FUNNEL" ] - }, - "groupId" : { - "type" : "string", - "description" : "The id of the group that the connectable component resides in" - }, - "name" : { - "type" : "string", - "description" : "The name of the connectable component" - }, - "comments" : { - "type" : "string", - "description" : "The comments for the connectable component." - }, - "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" - } - } - }, - "ConnectableDTO" : { - "type" : "object", - "required" : [ "groupId", "id", "type" ], - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the connectable component." - }, - "versionedComponentId" : { - "type" : "string", - "description" : "The ID of the corresponding component that is under version control" - }, - "type" : { - "type" : "string", - "description" : "The type of component the connectable is.", - "enum" : [ "PROCESSOR", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "INPUT_PORT", "OUTPUT_PORT", "FUNNEL" ] - }, - "groupId" : { - "type" : "string", - "description" : "The id of the group that the connectable component resides in" - }, - "name" : { - "type" : "string", - "description" : "The name of the connectable component" - }, - "running" : { - "type" : "boolean", - "description" : "Reflects the current state of the connectable component." - }, - "transmitting" : { - "type" : "boolean", - "description" : "If the connectable component represents a remote port, indicates if the target is configured to transmit." - }, - "exists" : { - "type" : "boolean", - "description" : "If the connectable component represents a remote port, indicates if the target exists." - }, - "comments" : { - "type" : "string", - "description" : "The comments for the connectable component." - } - } - }, - "ConnectionDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "versionedComponentId" : { - "type" : "string", - "description" : "The ID of the corresponding component that is under version control" - }, - "parentGroupId" : { - "type" : "string", - "description" : "The id of parent process group of this component if applicable." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "source" : { - "description" : "The source of the connection.", - "$ref" : "#/definitions/ConnectableDTO" - }, - "destination" : { - "description" : "The destination of the connection.", - "$ref" : "#/definitions/ConnectableDTO" - }, - "name" : { - "type" : "string", - "description" : "The name of the connection." - }, - "labelIndex" : { - "type" : "integer", - "format" : "int32", - "description" : "The index of the bend point where to place the connection label." - }, - "getzIndex" : { - "type" : "integer", - "format" : "int64", - "description" : "The z index of the connection." - }, - "selectedRelationships" : { - "type" : "array", - "description" : "The selected relationship that comprise the connection.", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - }, - "availableRelationships" : { - "type" : "array", - "description" : "The relationships that the source of the connection currently supports.", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - }, - "backPressureObjectThreshold" : { - "type" : "integer", - "format" : "int64", - "description" : "The object count threshold for determining when back pressure is applied. Updating this value is a passive change in the sense that it won't impact whether existing files over the limit are affected but it does help feeder processors to stop pushing too much into this work queue." - }, - "backPressureDataSizeThreshold" : { - "type" : "string", - "description" : "The object data size threshold for determining when back pressure is applied. Updating this value is a passive change in the sense that it won't impact whether existing files over the limit are affected but it does help feeder processors to stop pushing too much into this work queue." - }, - "flowFileExpiration" : { - "type" : "string", - "description" : "The amount of time a flow file may be in the flow before it will be automatically aged out of the flow. Once a flow file reaches this age it will be terminated from the flow the next time a processor attempts to start work on it." - }, - "prioritizers" : { - "type" : "array", - "description" : "The comparators used to prioritize the queue.", - "items" : { - "type" : "string" - } - }, - "bends" : { - "type" : "array", - "description" : "The bend points on the connection.", - "items" : { - "$ref" : "#/definitions/PositionDTO" - } - }, - "loadBalanceStrategy" : { - "type" : "string", - "description" : "How to load balance the data in this Connection across the nodes in the cluster.", - "enum" : [ "DO_NOT_LOAD_BALANCE", "PARTITION_BY_ATTRIBUTE", "ROUND_ROBIN", "SINGLE_NODE" ] - }, - "loadBalancePartitionAttribute" : { - "type" : "string", - "description" : "The FlowFile Attribute to use for determining which node a FlowFile will go to if the Load Balancing Strategy is set to PARTITION_BY_ATTRIBUTE" - }, - "loadBalanceCompression" : { - "type" : "string", - "description" : "Whether or not data should be compressed when being transferred between nodes in the cluster.", - "enum" : [ "DO_NOT_COMPRESS", "COMPRESS_ATTRIBUTES_ONLY", "COMPRESS_ATTRIBUTES_AND_CONTENT" ] - }, - "loadBalanceStatus" : { - "type" : "string", - "description" : "The current status of the Connection's Load Balancing Activities. Status can indicate that Load Balancing is not configured for the connection, that Load Balancing is configured but inactive (not currently transferring data to another node), or that Load Balancing is configured and actively transferring data to another node.", - "enum" : [ "LOAD_BALANCE_NOT_CONFIGURED", "LOAD_BALANCE_INACTIVE", "LOAD_BALANCE_ACTIVE" ] - } - } - }, - "ConnectionDiagnosticsDTO" : { - "type" : "object", - "properties" : { - "connection" : { - "description" : "Details about the connection", - "$ref" : "#/definitions/ConnectionDTO" - }, - "aggregateSnapshot" : { - "description" : "Aggregate values for all nodes in the cluster, or for this instance if not clustered", - "$ref" : "#/definitions/ConnectionDiagnosticsSnapshotDTO" - }, - "nodeSnapshots" : { - "type" : "array", - "description" : "A list of values for each node in the cluster, if clustered.", - "items" : { - "$ref" : "#/definitions/ConnectionDiagnosticsSnapshotDTO" - } - } - } - }, - "ConnectionDiagnosticsSnapshotDTO" : { - "type" : "object", - "properties" : { - "totalFlowFileCount" : { - "type" : "integer", - "format" : "int32", - "description" : "Total number of FlowFiles owned by the Connection" - }, - "totalByteCount" : { - "type" : "integer", - "format" : "int64", - "description" : "Total number of bytes that make up the content for the FlowFiles owned by this Connection" - }, - "nodeIdentifier" : { - "type" : "string", - "description" : "The Node Identifier that this information pertains to" - }, - "localQueuePartition" : { - "description" : "The local queue partition, from which components can pull FlowFiles on this node.", - "$ref" : "#/definitions/LocalQueuePartitionDTO" - }, - "remoteQueuePartitions" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/RemoteQueuePartitionDTO" - } - } - } - }, - "ConnectionEntity" : { - "type" : "object", - "required" : [ "destinationType", "sourceType" ], - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "component" : { - "$ref" : "#/definitions/ConnectionDTO" - }, - "status" : { - "description" : "The status of the connection.", - "$ref" : "#/definitions/ConnectionStatusDTO" - }, - "bends" : { - "type" : "array", - "description" : "The bend points on the connection.", - "items" : { - "$ref" : "#/definitions/PositionDTO" - } - }, - "labelIndex" : { - "type" : "integer", - "format" : "int32", - "description" : "The index of the bend point where to place the connection label." - }, - "getzIndex" : { - "type" : "integer", - "format" : "int64", - "description" : "The z index of the connection." - }, - "sourceId" : { - "type" : "string", - "description" : "The identifier of the source of this connection." - }, - "sourceGroupId" : { - "type" : "string", - "description" : "The identifier of the group of the source of this connection." - }, - "sourceType" : { - "type" : "string", - "description" : "The type of component the source connectable is.", - "enum" : [ "PROCESSOR", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "INPUT_PORT", "OUTPUT_PORT", "FUNNEL" ] - }, - "destinationId" : { - "type" : "string", - "description" : "The identifier of the destination of this connection." - }, - "destinationGroupId" : { - "type" : "string", - "description" : "The identifier of the group of the destination of this connection." - }, - "destinationType" : { - "type" : "string", - "description" : "The type of component the destination connectable is.", - "enum" : [ "PROCESSOR", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "INPUT_PORT", "OUTPUT_PORT", "FUNNEL" ] - } - }, - "xml" : { - "name" : "connectionEntity" - } - }, - "ConnectionStatisticsDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The ID of the connection" - }, - "statsLastRefreshed" : { - "type" : "string", - "description" : "The timestamp of when the stats were last refreshed" - }, - "aggregateSnapshot" : { - "description" : "The status snapshot that represents the aggregate stats of the cluster", - "$ref" : "#/definitions/ConnectionStatisticsSnapshotDTO" - }, - "nodeSnapshots" : { - "type" : "array", - "description" : "A list of status snapshots for each node", - "items" : { - "$ref" : "#/definitions/NodeConnectionStatisticsSnapshotDTO" - } - } - } - }, - "ConnectionStatisticsEntity" : { - "type" : "object", - "properties" : { - "connectionStatistics" : { - "$ref" : "#/definitions/ConnectionStatisticsDTO" - }, - "canRead" : { - "type" : "boolean", - "description" : "Indicates whether the user can read a given resource." - } - }, - "xml" : { - "name" : "connectionStatisticsEntity" - } - }, - "ConnectionStatisticsSnapshotDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the connection." - }, - "predictedMillisUntilCountBackpressure" : { - "type" : "integer", - "format" : "int64", - "description" : "The predicted number of milliseconds before the connection will have backpressure applied, based on the queued count." - }, - "predictedMillisUntilBytesBackpressure" : { - "type" : "integer", - "format" : "int64", - "description" : "The predicted number of milliseconds before the connection will have backpressure applied, based on the total number of bytes in the queue." - }, - "predictedCountAtNextInterval" : { - "type" : "integer", - "format" : "int32", - "description" : "The predicted number of queued objects at the next configured interval." - }, - "predictedBytesAtNextInterval" : { - "type" : "integer", - "format" : "int64", - "description" : "The predicted total number of bytes in the queue at the next configured interval." - }, - "predictedPercentCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The predicted percentage of queued objects at the next configured interval." - }, - "predictedPercentBytes" : { - "type" : "integer", - "format" : "int32", - "description" : "The predicted percentage of bytes in the queue against current threshold at the next configured interval." - }, - "predictionIntervalMillis" : { - "type" : "integer", - "format" : "int64", - "description" : "The prediction interval in seconds" - } - } - }, - "ConnectionStatusDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The ID of the connection" - }, - "groupId" : { - "type" : "string", - "description" : "The ID of the Process Group that the connection belongs to" - }, - "name" : { - "type" : "string", - "description" : "The name of the connection" - }, - "statsLastRefreshed" : { - "type" : "string", - "description" : "The timestamp of when the stats were last refreshed" - }, - "sourceId" : { - "type" : "string", - "description" : "The ID of the source component" - }, - "sourceName" : { - "type" : "string", - "description" : "The name of the source component" - }, - "destinationId" : { - "type" : "string", - "description" : "The ID of the destination component" - }, - "destinationName" : { - "type" : "string", - "description" : "The name of the destination component" - }, - "aggregateSnapshot" : { - "description" : "The status snapshot that represents the aggregate stats of the cluster", - "$ref" : "#/definitions/ConnectionStatusSnapshotDTO" - }, - "nodeSnapshots" : { - "type" : "array", - "description" : "A list of status snapshots for each node", - "items" : { - "$ref" : "#/definitions/NodeConnectionStatusSnapshotDTO" - } - } - } - }, - "ConnectionStatusEntity" : { - "type" : "object", - "properties" : { - "connectionStatus" : { - "$ref" : "#/definitions/ConnectionStatusDTO" - }, - "canRead" : { - "type" : "boolean", - "description" : "Indicates whether the user can read a given resource." - } - }, - "xml" : { - "name" : "connectionStatusEntity" - } - }, - "ConnectionStatusPredictionsSnapshotDTO" : { - "type" : "object", - "properties" : { - "predictedMillisUntilCountBackpressure" : { - "type" : "integer", - "format" : "int64", - "description" : "The predicted number of milliseconds before the connection will have backpressure applied, based on the queued count." - }, - "predictedMillisUntilBytesBackpressure" : { - "type" : "integer", - "format" : "int64", - "description" : "The predicted number of milliseconds before the connection will have backpressure applied, based on the total number of bytes in the queue." - }, - "predictionIntervalSeconds" : { - "type" : "integer", - "format" : "int32", - "description" : "The configured interval (in seconds) for predicting connection queue count and size (and percent usage)." - }, - "predictedCountAtNextInterval" : { - "type" : "integer", - "format" : "int32", - "description" : "The predicted number of queued objects at the next configured interval." - }, - "predictedBytesAtNextInterval" : { - "type" : "integer", - "format" : "int64", - "description" : "The predicted total number of bytes in the queue at the next configured interval." - }, - "predictedPercentCount" : { - "type" : "integer", - "format" : "int32", - "description" : "Predicted connection percent use regarding queued flow files count and backpressure threshold if configured." - }, - "predictedPercentBytes" : { - "type" : "integer", - "format" : "int32", - "description" : "Predicted connection percent use regarding queued flow files size and backpressure threshold if configured." - } - } - }, - "ConnectionStatusSnapshotDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the connection." - }, - "groupId" : { - "type" : "string", - "description" : "The id of the process group the connection belongs to." - }, - "name" : { - "type" : "string", - "description" : "The name of the connection." - }, - "sourceId" : { - "type" : "string", - "description" : "The id of the source of the connection." - }, - "sourceName" : { - "type" : "string", - "description" : "The name of the source of the connection." - }, - "destinationId" : { - "type" : "string", - "description" : "The id of the destination of the connection." - }, - "destinationName" : { - "type" : "string", - "description" : "The name of the destination of the connection." - }, - "predictions" : { - "description" : "Predictions, if available, for this connection (null if not available)", - "$ref" : "#/definitions/ConnectionStatusPredictionsSnapshotDTO" - }, - "flowFilesIn" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of FlowFiles that have come into the connection in the last 5 minutes." - }, - "bytesIn" : { - "type" : "integer", - "format" : "int64", - "description" : "The size of the FlowFiles that have come into the connection in the last 5 minutes." - }, - "input" : { - "type" : "string", - "description" : "The input count/size for the connection in the last 5 minutes, pretty printed." - }, - "flowFilesOut" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of FlowFiles that have left the connection in the last 5 minutes." - }, - "bytesOut" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes that have left the connection in the last 5 minutes." - }, - "output" : { - "type" : "string", - "description" : "The output count/sie for the connection in the last 5 minutes, pretty printed." - }, - "flowFilesQueued" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of FlowFiles that are currently queued in the connection." - }, - "bytesQueued" : { - "type" : "integer", - "format" : "int64", - "description" : "The size of the FlowFiles that are currently queued in the connection." - }, - "queued" : { - "type" : "string", - "description" : "The total count and size of queued flowfiles formatted." - }, - "queuedSize" : { - "type" : "string", - "description" : "The total size of flowfiles that are queued formatted." - }, - "queuedCount" : { - "type" : "string", - "description" : "The number of flowfiles that are queued, pretty printed." - }, - "percentUseCount" : { - "type" : "integer", - "format" : "int32", - "description" : "Connection percent use regarding queued flow files count and backpressure threshold if configured." - }, - "percentUseBytes" : { - "type" : "integer", - "format" : "int32", - "description" : "Connection percent use regarding queued flow files size and backpressure threshold if configured." - }, - "flowFileAvailability" : { - "type" : "string", - "description" : "The availability of FlowFiles in this connection" - } - } - }, - "ConnectionStatusSnapshotEntity" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the connection." - }, - "connectionStatusSnapshot" : { - "$ref" : "#/definitions/ConnectionStatusSnapshotDTO" - }, - "canRead" : { - "type" : "boolean", - "description" : "Indicates whether the user can read a given resource." - } - }, - "xml" : { - "name" : "entity" - } - }, - "ConnectionsEntity" : { - "type" : "object", - "properties" : { - "connections" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ConnectionEntity" - } - } - }, - "xml" : { - "name" : "connectionsEntity" - } - }, - "ControllerBulletinsEntity" : { - "type" : "object", - "properties" : { - "bulletins" : { - "type" : "array", - "description" : "System level bulletins to be reported to the user.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "controllerServiceBulletins" : { - "type" : "array", - "description" : "Controller service bulletins to be reported to the user.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "reportingTaskBulletins" : { - "type" : "array", - "description" : "Reporting task bulletins to be reported to the user.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "parameterProviderBulletins" : { - "type" : "array", - "description" : "Parameter provider bulletins to be reported to the user.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "flowRegistryClientBulletins" : { - "type" : "array", - "description" : "Flow registry client bulletins to be reported to the user.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - } - }, - "xml" : { - "name" : "controllerConfigurationEntity" - } - }, - "ControllerConfigurationDTO" : { - "type" : "object", - "properties" : { - "maxTimerDrivenThreadCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The maximum number of timer driven threads the NiFi has available." - }, - "maxEventDrivenThreadCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The maximum number of event driven threads the NiFi has available." - } - } - }, - "ControllerConfigurationEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "component" : { - "description" : "The controller configuration.", - "$ref" : "#/definitions/ControllerConfigurationDTO" - } - }, - "xml" : { - "name" : "controllerConfigurationEntity" - } - }, - "ControllerDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the NiFi." - }, - "name" : { - "type" : "string", - "description" : "The name of the NiFi." - }, - "comments" : { - "type" : "string", - "description" : "The comments for the NiFi." - }, - "runningCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of running components in the NiFi." - }, - "stoppedCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of stopped components in the NiFi." - }, - "invalidCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of invalid components in the NiFi." - }, - "disabledCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of disabled components in the NiFi." - }, - "activeRemotePortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of active remote ports contained in the NiFi." - }, - "inactiveRemotePortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of inactive remote ports contained in the NiFi." - }, - "inputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of input ports contained in the NiFi." - }, - "outputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of output ports in the NiFi." - }, - "remoteSiteListeningPort" : { - "type" : "integer", - "format" : "int32", - "description" : "The Socket Port on which this instance is listening for Remote Transfers of Flow Files. If this instance is not configured to receive Flow Files from remote instances, this will be null." - }, - "remoteSiteHttpListeningPort" : { - "type" : "integer", - "format" : "int32", - "description" : "The HTTP(S) Port on which this instance is listening for Remote Transfers of Flow Files. If this instance is not configured to receive Flow Files from remote instances, this will be null." - }, - "siteToSiteSecure" : { - "type" : "boolean", - "description" : "Indicates whether or not Site-to-Site communications with this instance is secure (2-way authentication)." - }, - "instanceId" : { - "type" : "string", - "description" : "If clustered, the id of the Cluster Manager, otherwise the id of the NiFi." - }, - "inputPorts" : { - "type" : "array", - "description" : "The input ports available to send data to for the NiFi.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/PortDTO" - } - }, - "outputPorts" : { - "type" : "array", - "description" : "The output ports available to received data from the NiFi.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/PortDTO" - } - } - } - }, - "ControllerEntity" : { - "type" : "object", - "properties" : { - "controller" : { - "$ref" : "#/definitions/ControllerDTO" - } - }, - "xml" : { - "name" : "controllerEntity" - } - }, - "ControllerServiceAPI" : { - "type" : "object", - "properties" : { - "type" : { - "type" : "string", - "description" : "The fully qualified name of the service interface." - }, - "bundle" : { - "description" : "The details of the artifact that bundled this service interface.", - "$ref" : "#/definitions/Bundle" - } - } - }, - "ControllerServiceApiDTO" : { - "type" : "object", - "properties" : { - "type" : { - "type" : "string", - "description" : "The fully qualified name of the service interface." - }, - "bundle" : { - "description" : "The details of the artifact that bundled this service interface.", - "$ref" : "#/definitions/BundleDTO" - } - } - }, - "ControllerServiceDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "versionedComponentId" : { - "type" : "string", - "description" : "The ID of the corresponding component that is under version control" - }, - "parentGroupId" : { - "type" : "string", - "description" : "The id of parent process group of this component if applicable." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "name" : { - "type" : "string", - "description" : "The name of the controller service." - }, - "type" : { - "type" : "string", - "description" : "The type of the controller service." - }, - "bundle" : { - "description" : "The details of the artifact that bundled this processor type.", - "$ref" : "#/definitions/BundleDTO" - }, - "controllerServiceApis" : { - "type" : "array", - "description" : "Lists the APIs this Controller Service implements.", - "items" : { - "$ref" : "#/definitions/ControllerServiceApiDTO" - } - }, - "comments" : { - "type" : "string", - "description" : "The comments for the controller service." - }, - "state" : { - "type" : "string", - "description" : "The state of the controller service.", - "enum" : [ "ENABLED", "ENABLING", "DISABLED", "DISABLING" ] - }, - "persistsState" : { - "type" : "boolean", - "description" : "Whether the controller service persists state." - }, - "restricted" : { - "type" : "boolean", - "description" : "Whether the controller service requires elevated privileges." - }, - "deprecated" : { - "type" : "boolean", - "description" : "Whether the ontroller service has been deprecated." - }, - "multipleVersionsAvailable" : { - "type" : "boolean", - "description" : "Whether the controller service has multiple versions available." - }, - "supportsSensitiveDynamicProperties" : { - "type" : "boolean", - "description" : "Whether the controller service supports sensitive dynamic properties." - }, - "properties" : { - "type" : "object", - "description" : "The properties of the controller service.", - "additionalProperties" : { - "type" : "string" - } - }, - "descriptors" : { - "type" : "object", - "description" : "The descriptors for the controller service properties.", - "additionalProperties" : { - "$ref" : "#/definitions/PropertyDescriptorDTO" - } - }, - "sensitiveDynamicPropertyNames" : { - "type" : "array", - "description" : "Set of sensitive dynamic property names", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - }, - "customUiUrl" : { - "type" : "string", - "description" : "The URL for the controller services custom configuration UI if applicable." - }, - "annotationData" : { - "type" : "string", - "description" : "The annotation for the controller service. This is how the custom UI relays configuration to the controller service." - }, - "referencingComponents" : { - "type" : "array", - "description" : "All components referencing this controller service.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ControllerServiceReferencingComponentEntity" - } - }, - "validationErrors" : { - "type" : "array", - "description" : "The validation errors from the controller service. These validation errors represent the problems with the controller service that must be resolved before it can be enabled.", - "items" : { - "type" : "string" - } - }, - "validationStatus" : { - "type" : "string", - "description" : "Indicates whether the ControllerService is valid, invalid, or still in the process of validating (i.e., it is unknown whether or not the ControllerService is valid)", - "enum" : [ "VALID", "INVALID", "VALIDATING" ] - }, - "bulletinLevel" : { - "type" : "string", - "description" : "The level at which the controller service will report bulletins." - }, - "extensionMissing" : { - "type" : "boolean", - "description" : "Whether the underlying extension is missing." - } - } - }, - "ControllerServiceDefinition" : { - "type" : "object", - "required" : [ "type" ], - "properties" : { - "group" : { - "type" : "string", - "description" : "The group name of the bundle that provides the referenced type." - }, - "artifact" : { - "type" : "string", - "description" : "The artifact name of the bundle that provides the referenced type." - }, - "version" : { - "type" : "string", - "description" : "The version 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." - }, - "buildInfo" : { - "description" : "The build metadata for this component", - "$ref" : "#/definitions/BuildInfo" - }, - "providedApiImplementations" : { - "type" : "array", - "description" : "If this type represents a provider for an interface, this lists the APIs it implements", - "items" : { - "$ref" : "#/definitions/DefinedType" - } - }, - "tags" : { - "type" : "array", - "description" : "The tags associated with this type", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - }, - "deprecated" : { - "type" : "boolean", - "description" : "Whether or not the component has been deprecated" - }, - "deprecationReason" : { - "type" : "string", - "description" : "If this component has been deprecated, this optional field can be used to provide an explanation" - }, - "restricted" : { - "type" : "boolean", - "description" : "Whether or not the component has a general restriction" - }, - "restrictedExplanation" : { - "type" : "string", - "description" : "An optional description of the general restriction" - }, - "explicitRestrictions" : { - "type" : "array", - "description" : "Explicit restrictions that indicate a require permission to use the component", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/Restriction" - } - }, - "stateful" : { - "$ref" : "#/definitions/Stateful" - }, - "propertyDescriptors" : { - "type" : "object", - "description" : "Descriptions of configuration properties applicable to this component.", - "additionalProperties" : { - "$ref" : "#/definitions/PropertyDescriptor" - } - }, - "supportsDynamicProperties" : { - "type" : "boolean", - "description" : "Whether or not this component makes use of dynamic (user-set) properties." - } - } - }, - "ControllerServiceDiagnosticsDTO" : { - "type" : "object", - "properties" : { - "controllerService" : { - "description" : "The Controller Service", - "$ref" : "#/definitions/ControllerServiceEntity" - }, - "classLoaderDiagnostics" : { - "description" : "Information about the Controller Service's Class Loader", - "$ref" : "#/definitions/ClassLoaderDiagnosticsDTO" - } - } - }, - "ControllerServiceEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "parentGroupId" : { - "type" : "string", - "description" : "The id of parent process group of this ControllerService." - }, - "component" : { - "$ref" : "#/definitions/ControllerServiceDTO" - }, - "operatePermissions" : { - "description" : "The permissions for this component operations.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "status" : { - "description" : "The status for this ControllerService.", - "$ref" : "#/definitions/ControllerServiceStatusDTO" - } - }, - "xml" : { - "name" : "controllerServiceEntity" - } - }, - "ControllerServiceReferencingComponentDTO" : { - "type" : "object", - "properties" : { - "groupId" : { - "type" : "string", - "description" : "The group id for the component referencing a controller service. If this component is another controller service or a reporting task, this field is blank." - }, - "id" : { - "type" : "string", - "description" : "The id of the component referencing a controller service." - }, - "name" : { - "type" : "string", - "description" : "The name of the component referencing a controller service." - }, - "type" : { - "type" : "string", - "description" : "The type of the component referencing a controller service in simple Java class name format without package name." - }, - "state" : { - "type" : "string", - "description" : "The scheduled state of a processor or reporting task referencing a controller service. If this component is another controller service, this field represents the controller service state." - }, - "properties" : { - "type" : "object", - "description" : "The properties for the component.", - "additionalProperties" : { - "type" : "string" - } - }, - "descriptors" : { - "type" : "object", - "description" : "The descriptors for the component properties.", - "additionalProperties" : { - "$ref" : "#/definitions/PropertyDescriptorDTO" - } - }, - "validationErrors" : { - "type" : "array", - "description" : "The validation errors for the component.", - "items" : { - "type" : "string" - } - }, - "referenceType" : { - "type" : "string", - "description" : "The type of reference this is.", - "enum" : [ "Processor", "ControllerService", "ReportingTask" ] - }, - "activeThreadCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of active threads for the referencing component." - }, - "referenceCycle" : { - "type" : "boolean", - "description" : "If the referencing component represents a controller service, this indicates whether it has already been represented in this hierarchy." - }, - "referencingComponents" : { - "type" : "array", - "description" : "If the referencing component represents a controller service, these are the components that reference it.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ControllerServiceReferencingComponentEntity" - } - } - } - }, - "ControllerServiceReferencingComponentEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "component" : { - "$ref" : "#/definitions/ControllerServiceReferencingComponentDTO" - }, - "operatePermissions" : { - "description" : "The permissions for this component operations.", - "$ref" : "#/definitions/PermissionsDTO" - } - }, - "xml" : { - "name" : "controllerServiceReferencingComponentEntity" - } - }, - "ControllerServiceReferencingComponentsEntity" : { - "type" : "object", - "properties" : { - "controllerServiceReferencingComponents" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ControllerServiceReferencingComponentEntity" - } - } - }, - "xml" : { - "name" : "controllerServiceReferencingComponentsEntity" - } - }, - "ControllerServiceRunStatusEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "state" : { - "type" : "string", - "description" : "The run status of the ControllerService.", - "enum" : [ "ENABLED", "DISABLED" ] - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "uiOnly" : { - "type" : "boolean", - "description" : "Indicates whether or not responses should only include fields necessary for rendering the NiFi User Interface. As such, when this value is set to true, some fields may be returned as null values, and the selected fields may change at any time without notice. As a result, this value should not be set to true by any client other than the UI." - } - }, - "xml" : { - "name" : "entity" - } - }, - "ControllerServiceStatusDTO" : { - "type" : "object", - "properties" : { - "runStatus" : { - "type" : "string", - "description" : "The run status of this ControllerService", - "enum" : [ "ENABLED", "ENABLING", "DISABLED", "DISABLING" ] - }, - "validationStatus" : { - "type" : "string", - "description" : "Indicates whether the component is valid, invalid, or still in the process of validating (i.e., it is unknown whether or not the component is valid)", - "enum" : [ "VALID", "INVALID", "VALIDATING" ] - }, - "activeThreadCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of active threads for the component." - } - } - }, - "ControllerServiceTypesEntity" : { - "type" : "object", - "properties" : { - "controllerServiceTypes" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/DocumentedTypeDTO" - } - } - }, - "xml" : { - "name" : "controllerServiceTypesEntity" - } - }, - "ControllerServicesEntity" : { - "type" : "object", - "properties" : { - "currentTime" : { - "type" : "string", - "description" : "The current time on the system." - }, - "controllerServices" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ControllerServiceEntity" - } - } - }, - "xml" : { - "name" : "controllerServicesEntity" - } - }, - "ControllerStatusDTO" : { - "type" : "object", - "properties" : { - "activeThreadCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of active threads in the NiFi." - }, - "terminatedThreadCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of terminated threads in the NiFi." - }, - "queued" : { - "type" : "string", - "description" : "The number of flowfiles queued in the NiFi." - }, - "flowFilesQueued" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of FlowFiles queued across the entire flow" - }, - "bytesQueued" : { - "type" : "integer", - "format" : "int64", - "description" : "The size of the FlowFiles queued across the entire flow" - }, - "runningCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of running components in the NiFi." - }, - "stoppedCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of stopped components in the NiFi." - }, - "invalidCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of invalid components in the NiFi." - }, - "disabledCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of disabled components in the NiFi." - }, - "activeRemotePortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of active remote ports in the NiFi." - }, - "inactiveRemotePortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of inactive remote ports in the NiFi." - }, - "upToDateCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of up to date versioned process groups in the NiFi." - }, - "locallyModifiedCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of locally modified versioned process groups in the NiFi." - }, - "staleCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of stale versioned process groups in the NiFi." - }, - "locallyModifiedAndStaleCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of locally modified and stale versioned process groups in the NiFi." - }, - "syncFailureCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of versioned process groups in the NiFi that are unable to sync to a registry." - } - } - }, - "ControllerStatusEntity" : { - "type" : "object", - "properties" : { - "controllerStatus" : { - "$ref" : "#/definitions/ControllerStatusDTO" - } - }, - "xml" : { - "name" : "controllerStatusEntity" - } - }, - "CopySnippetRequestEntity" : { - "type" : "object", - "properties" : { - "snippetId" : { - "type" : "string", - "description" : "The identifier of the snippet." - }, - "originX" : { - "type" : "number", - "format" : "double", - "description" : "The x coordinate of the origin of the bounding box where the new components will be placed." - }, - "originY" : { - "type" : "number", - "format" : "double", - "description" : "The y coordinate of the origin of the bounding box where the new components will be placed." - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - } - }, - "xml" : { - "name" : "copySnippetRequestEntity" - } - }, - "CounterDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the counter." - }, - "context" : { - "type" : "string", - "description" : "The context of the counter." - }, - "name" : { - "type" : "string", - "description" : "The name of the counter." - }, - "valueCount" : { - "type" : "integer", - "format" : "int64", - "description" : "The value count." - }, - "value" : { - "type" : "string", - "description" : "The value of the counter." - } - } - }, - "CounterEntity" : { - "type" : "object", - "properties" : { - "counter" : { - "$ref" : "#/definitions/CounterDTO" - } - }, - "xml" : { - "name" : "counterEntity" - } - }, - "CountersDTO" : { - "type" : "object", - "properties" : { - "aggregateSnapshot" : { - "description" : "A Counters snapshot that represents the aggregate values of all nodes in the cluster. If the NiFi instance is a standalone instance, rather than a cluster, this represents the stats of the single instance.", - "$ref" : "#/definitions/CountersSnapshotDTO" - }, - "nodeSnapshots" : { - "type" : "array", - "description" : "A Counters snapshot for each node in the cluster. If the NiFi instance is a standalone instance, rather than a cluster, this may be null.", - "items" : { - "$ref" : "#/definitions/NodeCountersSnapshotDTO" - } - } - } - }, - "CountersEntity" : { - "type" : "object", - "properties" : { - "counters" : { - "$ref" : "#/definitions/CountersDTO" - } - }, - "xml" : { - "name" : "countersEntity" - } - }, - "CountersSnapshotDTO" : { - "type" : "object", - "properties" : { - "generated" : { - "type" : "string", - "description" : "The timestamp when the report was generated." - }, - "counters" : { - "type" : "array", - "description" : "All counters in the NiFi.", - "items" : { - "$ref" : "#/definitions/CounterDTO" - } - } - } - }, - "CreateActiveRequestEntity" : { - "type" : "object", - "properties" : { - "processGroupId" : { - "type" : "string", - "description" : "The Process Group ID that this active request will update" - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - } - }, - "xml" : { - "name" : "createActiveRequestEntity" - } - }, - "CreateTemplateRequestEntity" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The name of the template." - }, - "description" : { - "type" : "string", - "description" : "The description of the template." - }, - "snippetId" : { - "type" : "string", - "description" : "The identifier of the snippet." - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - } - }, - "xml" : { - "name" : "createTemplateRequestEntity" - } - }, - "CurrentUserEntity" : { - "type" : "object", - "properties" : { - "identity" : { - "type" : "string", - "description" : "The user identity being serialized." - }, - "anonymous" : { - "type" : "boolean", - "description" : "Whether the current user is anonymous." - }, - "provenancePermissions" : { - "description" : "Permissions for querying provenance.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "countersPermissions" : { - "description" : "Permissions for accessing counters.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "tenantsPermissions" : { - "description" : "Permissions for accessing tenants.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "controllerPermissions" : { - "description" : "Permissions for accessing the controller.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "policiesPermissions" : { - "description" : "Permissions for accessing the policies.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "systemPermissions" : { - "description" : "Permissions for accessing system.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "parameterContextPermissions" : { - "description" : "Permissions for accessing parameter contexts.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "restrictedComponentsPermissions" : { - "description" : "Permissions for accessing restricted components. Note: the read permission are not used and will always be false.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "componentRestrictionPermissions" : { - "type" : "array", - "description" : "Permissions for specific component restrictions.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ComponentRestrictionPermissionDTO" - } - }, - "canVersionFlows" : { - "type" : "boolean", - "description" : "Whether the current user can version flows." - } - }, - "xml" : { - "name" : "currentEntity" - } - }, - "DefinedType" : { - "type" : "object", - "required" : [ "type" ], - "properties" : { - "group" : { - "type" : "string", - "description" : "The group name of the bundle that provides the referenced type." - }, - "artifact" : { - "type" : "string", - "description" : "The artifact name of the bundle that provides the referenced type." - }, - "version" : { - "type" : "string", - "description" : "The version 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." - } - } - }, - "DifferenceDTO" : { - "type" : "object", - "properties" : { - "differenceType" : { - "type" : "string", - "description" : "The type of difference" - }, - "difference" : { - "type" : "string", - "description" : "Description of the difference" - } - } - }, - "DimensionsDTO" : { - "type" : "object", - "properties" : { - "width" : { - "type" : "number", - "format" : "double", - "description" : "The width of the label in pixels when at a 1:1 scale." - }, - "height" : { - "type" : "number", - "format" : "double", - "description" : "The height of the label in pixels when at a 1:1 scale." - } - } - }, - "DocumentedTypeDTO" : { - "type" : "object", - "properties" : { - "type" : { - "type" : "string", - "description" : "The fully qualified name of the type." - }, - "bundle" : { - "description" : "The details of the artifact that bundled this type.", - "$ref" : "#/definitions/BundleDTO" - }, - "controllerServiceApis" : { - "type" : "array", - "description" : "If this type represents a ControllerService, this lists the APIs it implements.", - "items" : { - "$ref" : "#/definitions/ControllerServiceApiDTO" - } - }, - "description" : { - "type" : "string", - "description" : "The description of the type." - }, - "restricted" : { - "type" : "boolean", - "description" : "Whether this type is restricted." - }, - "usageRestriction" : { - "type" : "string", - "description" : "The optional description of why the usage of this component is restricted." - }, - "explicitRestrictions" : { - "type" : "array", - "description" : "An optional collection of explicit restrictions. If specified, these explicit restrictions will be enfored.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ExplicitRestrictionDTO" - } - }, - "deprecationReason" : { - "type" : "string", - "description" : "The description of why the usage of this component is restricted." - }, - "tags" : { - "type" : "array", - "description" : "The tags associated with this type.", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - } - } - }, - "DropRequestDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id for this drop request." - }, - "uri" : { - "type" : "string", - "description" : "The URI for future requests to this drop request." - }, - "submissionTime" : { - "type" : "string", - "description" : "The timestamp when the query was submitted." - }, - "lastUpdated" : { - "type" : "string", - "description" : "The last time this drop request was updated." - }, - "percentCompleted" : { - "type" : "integer", - "format" : "int32", - "description" : "The current percent complete." - }, - "finished" : { - "type" : "boolean", - "description" : "Whether the query has finished." - }, - "failureReason" : { - "type" : "string", - "description" : "The reason, if any, that this drop request failed." - }, - "currentCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of flow files currently queued." - }, - "currentSize" : { - "type" : "integer", - "format" : "int64", - "description" : "The size of flow files currently queued in bytes." - }, - "current" : { - "type" : "string", - "description" : "The count and size of flow files currently queued." - }, - "originalCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of flow files to be dropped as a result of this request." - }, - "originalSize" : { - "type" : "integer", - "format" : "int64", - "description" : "The size of flow files to be dropped as a result of this request in bytes." - }, - "original" : { - "type" : "string", - "description" : "The count and size of flow files to be dropped as a result of this request." - }, - "droppedCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of flow files that have been dropped thus far." - }, - "droppedSize" : { - "type" : "integer", - "format" : "int64", - "description" : "The size of flow files that have been dropped thus far in bytes." - }, - "dropped" : { - "type" : "string", - "description" : "The count and size of flow files that have been dropped thus far." - }, - "state" : { - "type" : "string", - "description" : "The current state of the drop request." - } - } - }, - "DropRequestEntity" : { - "type" : "object", - "properties" : { - "dropRequest" : { - "$ref" : "#/definitions/DropRequestDTO" - } - }, - "xml" : { - "name" : "dropRequestEntity" - } - }, - "DtoFactory" : { - "type" : "object" - }, - "Entity" : { - "type" : "object", - "xml" : { - "name" : "entity" - } - }, - "ExplicitRestrictionDTO" : { - "type" : "object", - "properties" : { - "requiredPermission" : { - "description" : "The required permission necessary for this restriction.", - "$ref" : "#/definitions/RequiredPermissionDTO" - }, - "explanation" : { - "type" : "string", - "description" : "The description of why the usage of this component is restricted for this required permission." - } - } - }, - "ExternalControllerServiceReference" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The identifier of the controller service" - }, - "name" : { - "type" : "string", - "description" : "The name of the controller service" - } - } - }, - "FlowBreadcrumbDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the group." - }, - "name" : { - "type" : "string", - "description" : "The id of the group." - }, - "versionControlInformation" : { - "description" : "The process group version control information or null if not version controlled.", - "$ref" : "#/definitions/VersionControlInformationDTO" - } - } - }, - "FlowBreadcrumbEntity" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of this ancestor ProcessGroup." - }, - "permissions" : { - "description" : "The permissions for this ancestor ProcessGroup.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "versionedFlowState" : { - "type" : "string", - "description" : "The current state of the Process Group, as it relates to the Versioned Flow", - "enum" : [ "LOCALLY_MODIFIED", "STALE", "LOCALLY_MODIFIED_AND_STALE", "UP_TO_DATE", "SYNC_FAILURE" ] - }, - "breadcrumb" : { - "description" : "This breadcrumb.", - "$ref" : "#/definitions/FlowBreadcrumbDTO" - }, - "parentBreadcrumb" : { - "description" : "The parent breadcrumb for this breadcrumb.", - "$ref" : "#/definitions/FlowBreadcrumbEntity" - } - }, - "xml" : { - "name" : "flowEntity" - } - }, - "FlowComparisonEntity" : { - "type" : "object", - "properties" : { - "componentDifferences" : { - "type" : "array", - "description" : "The list of differences for each component in the flow that is not the same between the two flows", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ComponentDifferenceDTO" - } - } - }, - "xml" : { - "name" : "flowComparisonEntity" - } - }, - "FlowConfigurationDTO" : { - "type" : "object", - "properties" : { - "supportsManagedAuthorizer" : { - "type" : "boolean", - "description" : "Whether this NiFi supports a managed authorizer. Managed authorizers can visualize users, groups, and policies in the UI." - }, - "supportsConfigurableAuthorizer" : { - "type" : "boolean", - "description" : "Whether this NiFi supports a configurable authorizer." - }, - "supportsConfigurableUsersAndGroups" : { - "type" : "boolean", - "description" : "Whether this NiFi supports configurable users and groups." - }, - "autoRefreshIntervalSeconds" : { - "type" : "integer", - "format" : "int64", - "description" : "The interval in seconds between the automatic NiFi refresh requests." - }, - "currentTime" : { - "type" : "string", - "description" : "The current time on the system." - }, - "timeOffset" : { - "type" : "integer", - "format" : "int32", - "description" : "The time offset of the system." - }, - "defaultBackPressureObjectThreshold" : { - "type" : "integer", - "format" : "int64", - "description" : "The default back pressure object threshold." - }, - "defaultBackPressureDataSizeThreshold" : { - "type" : "string", - "description" : "The default back pressure data size threshold." - } - } - }, - "FlowConfigurationEntity" : { - "type" : "object", - "properties" : { - "flowConfiguration" : { - "description" : "The controller configuration.", - "$ref" : "#/definitions/FlowConfigurationDTO" - } - }, - "xml" : { - "name" : "flowConfigurationEntity" - } - }, - "FlowDTO" : { - "type" : "object", - "properties" : { - "processGroups" : { - "type" : "array", - "description" : "The process groups in this flow.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ProcessGroupEntity" - } - }, - "remoteProcessGroups" : { - "type" : "array", - "description" : "The remote process groups in this flow.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/RemoteProcessGroupEntity" - } - }, - "processors" : { - "type" : "array", - "description" : "The processors in this flow.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ProcessorEntity" - } - }, - "inputPorts" : { - "type" : "array", - "description" : "The input ports in this flow.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/PortEntity" - } - }, - "outputPorts" : { - "type" : "array", - "description" : "The output ports in this flow.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/PortEntity" - } - }, - "connections" : { - "type" : "array", - "description" : "The connections in this flow.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ConnectionEntity" - } - }, - "labels" : { - "type" : "array", - "description" : "The labels in this flow.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/LabelEntity" - } - }, - "funnels" : { - "type" : "array", - "description" : "The funnels in this flow.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/FunnelEntity" - } - } - } - }, - "FlowEntity" : { - "type" : "object", - "properties" : { - "flow" : { - "$ref" : "#/definitions/FlowDTO" - } - }, - "xml" : { - "name" : "flowEntity" - } - }, - "FlowFileDTO" : { - "type" : "object", - "properties" : { - "uri" : { - "type" : "string", - "description" : "The URI that can be used to access this FlowFile." - }, - "uuid" : { - "type" : "string", - "description" : "The FlowFile UUID." - }, - "filename" : { - "type" : "string", - "description" : "The FlowFile filename." - }, - "position" : { - "type" : "integer", - "format" : "int32", - "description" : "The FlowFile's position in the queue." - }, - "size" : { - "type" : "integer", - "format" : "int64", - "description" : "The FlowFile file size." - }, - "queuedDuration" : { - "type" : "integer", - "format" : "int64", - "description" : "How long this FlowFile has been enqueued." - }, - "lineageDuration" : { - "type" : "integer", - "format" : "int64", - "description" : "Duration since the FlowFile's greatest ancestor entered the flow." - }, - "penaltyExpiresIn" : { - "type" : "integer", - "format" : "int64", - "description" : "How long in milliseconds until the FlowFile penalty expires." - }, - "clusterNodeId" : { - "type" : "string", - "description" : "The id of the node where this FlowFile resides." - }, - "clusterNodeAddress" : { - "type" : "string", - "description" : "The label for the node where this FlowFile resides." - }, - "attributes" : { - "type" : "object", - "description" : "The FlowFile attributes.", - "additionalProperties" : { - "type" : "string" - } - }, - "contentClaimSection" : { - "type" : "string", - "description" : "The section in which the content claim lives." - }, - "contentClaimContainer" : { - "type" : "string", - "description" : "The container in which the content claim lives." - }, - "contentClaimIdentifier" : { - "type" : "string", - "description" : "The identifier of the content claim." - }, - "contentClaimOffset" : { - "type" : "integer", - "format" : "int64", - "description" : "The offset into the content claim where the flowfile's content begins." - }, - "contentClaimFileSize" : { - "type" : "string", - "description" : "The file size of the content claim formatted." - }, - "contentClaimFileSizeBytes" : { - "type" : "integer", - "format" : "int64", - "description" : "The file size of the content claim in bytes." - }, - "penalized" : { - "type" : "boolean", - "description" : "If the FlowFile is penalized." - } - } - }, - "FlowFileEntity" : { - "type" : "object", - "properties" : { - "flowFile" : { - "$ref" : "#/definitions/FlowFileDTO" - } - }, - "xml" : { - "name" : "flowFileEntity" - } - }, - "FlowFileSummaryDTO" : { - "type" : "object", - "properties" : { - "uri" : { - "type" : "string", - "description" : "The URI that can be used to access this FlowFile." - }, - "uuid" : { - "type" : "string", - "description" : "The FlowFile UUID." - }, - "filename" : { - "type" : "string", - "description" : "The FlowFile filename." - }, - "position" : { - "type" : "integer", - "format" : "int32", - "description" : "The FlowFile's position in the queue." - }, - "size" : { - "type" : "integer", - "format" : "int64", - "description" : "The FlowFile file size." - }, - "queuedDuration" : { - "type" : "integer", - "format" : "int64", - "description" : "How long this FlowFile has been enqueued." - }, - "lineageDuration" : { - "type" : "integer", - "format" : "int64", - "description" : "Duration since the FlowFile's greatest ancestor entered the flow." - }, - "penaltyExpiresIn" : { - "type" : "integer", - "format" : "int64", - "description" : "How long in milliseconds until the FlowFile penalty expires." - }, - "clusterNodeId" : { - "type" : "string", - "description" : "The id of the node where this FlowFile resides." - }, - "clusterNodeAddress" : { - "type" : "string", - "description" : "The label for the node where this FlowFile resides." - }, - "penalized" : { - "type" : "boolean", - "description" : "If the FlowFile is penalized." - } - } - }, - "FlowRegistryBucket" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string" - }, - "name" : { - "type" : "string" - }, - "description" : { - "type" : "string" - }, - "createdTimestamp" : { - "type" : "integer", - "format" : "int64" - }, - "permissions" : { - "$ref" : "#/definitions/FlowRegistryPermissions" - } - } - }, - "FlowRegistryBucketDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The bucket identifier" - }, - "name" : { - "type" : "string", - "description" : "The bucket name" - }, - "description" : { - "type" : "string", - "description" : "The bucket description" - }, - "created" : { - "type" : "integer", - "format" : "int64", - "description" : "The created timestamp of this bucket" - } - } - }, - "FlowRegistryBucketEntity" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string" - }, - "bucket" : { - "$ref" : "#/definitions/FlowRegistryBucketDTO" - }, - "permissions" : { - "$ref" : "#/definitions/PermissionsDTO" - } - }, - "xml" : { - "name" : "bucketEntity" - } - }, - "FlowRegistryBucketsEntity" : { - "type" : "object", - "properties" : { - "buckets" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/FlowRegistryBucketEntity" - } - } - }, - "xml" : { - "name" : "bucketsEntity" - } - }, - "FlowRegistryClientDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The registry identifier" - }, - "name" : { - "type" : "string", - "description" : "The registry name" - }, - "description" : { - "type" : "string", - "description" : "The registry description" - }, - "uri" : { - "type" : "string" - }, - "type" : { - "type" : "string", - "description" : "The type of the controller service." - }, - "bundle" : { - "description" : "The details of the artifact that bundled this processor type.", - "$ref" : "#/definitions/BundleDTO" - }, - "properties" : { - "type" : "object", - "description" : "The properties of the controller service.", - "additionalProperties" : { - "type" : "string" - } - }, - "descriptors" : { - "type" : "object", - "description" : "The descriptors for the controller service properties.", - "additionalProperties" : { - "$ref" : "#/definitions/PropertyDescriptorDTO" - } - }, - "sensitiveDynamicPropertyNames" : { - "type" : "array", - "description" : "Set of sensitive dynamic property names", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - }, - "supportsSensitiveDynamicProperties" : { - "type" : "boolean", - "description" : "Whether the reporting task supports sensitive dynamic properties." - }, - "restricted" : { - "type" : "boolean", - "description" : "Whether the reporting task requires elevated privileges." - }, - "deprecated" : { - "type" : "boolean", - "description" : "Whether the reporting task has been deprecated." - }, - "validationErrors" : { - "type" : "array", - "description" : "Gets the validation errors from the reporting task. These validation errors represent the problems with the reporting task that must be resolved before it can be scheduled to run.", - "items" : { - "type" : "string" - } - }, - "validationStatus" : { - "type" : "string", - "description" : "Indicates whether the Processor is valid, invalid, or still in the process of validating (i.e., it is unknown whether or not the Processor is valid)", - "enum" : [ "VALID", "INVALID", "VALIDATING" ] - }, - "annotationData" : { - "type" : "string", - "description" : "The annotation data for the repoting task. This is how the custom UI relays configuration to the reporting task." - }, - "extensionMissing" : { - "type" : "boolean", - "description" : "Whether the underlying extension is missing." - }, - "multipleVersionsAvailable" : { - "type" : "boolean", - "description" : "Whether the flow registry client has multiple versions available." - } - } - }, - "FlowRegistryClientEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "registry" : { - "$ref" : "#/definitions/FlowRegistryClientDTO" - }, - "operatePermissions" : { - "$ref" : "#/definitions/PermissionsDTO" - }, - "component" : { - "$ref" : "#/definitions/FlowRegistryClientDTO" - } - }, - "xml" : { - "name" : "registryClientEntity" - } - }, - "FlowRegistryClientTypesEntity" : { - "type" : "object", - "properties" : { - "flowRegistryClientTypes" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/DocumentedTypeDTO" - } - } - }, - "xml" : { - "name" : "flowRegistryClientTypesEntity" - } - }, - "FlowRegistryClientsEntity" : { - "type" : "object", - "properties" : { - "registries" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/FlowRegistryClientEntity" - } - } - }, - "xml" : { - "name" : "registryClientsEntity" - } - }, - "FlowRegistryPermissions" : { - "type" : "object", - "properties" : { - "canRead" : { - "type" : "boolean" - }, - "canWrite" : { - "type" : "boolean" - }, - "canDelete" : { - "type" : "boolean" - } - } - }, - "FlowSnippetDTO" : { - "type" : "object", - "properties" : { - "processGroups" : { - "type" : "array", - "description" : "The process groups in this flow snippet.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ProcessGroupDTO" - } - }, - "remoteProcessGroups" : { - "type" : "array", - "description" : "The remote process groups in this flow snippet.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/RemoteProcessGroupDTO" - } - }, - "processors" : { - "type" : "array", - "description" : "The processors in this flow snippet.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ProcessorDTO" - } - }, - "inputPorts" : { - "type" : "array", - "description" : "The input ports in this flow snippet.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/PortDTO" - } - }, - "outputPorts" : { - "type" : "array", - "description" : "The output ports in this flow snippet.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/PortDTO" - } - }, - "connections" : { - "type" : "array", - "description" : "The connections in this flow snippet.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ConnectionDTO" - } - }, - "labels" : { - "type" : "array", - "description" : "The labels in this flow snippet.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/LabelDTO" - } - }, - "funnels" : { - "type" : "array", - "description" : "The funnels in this flow snippet.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/FunnelDTO" - } - }, - "controllerServices" : { - "type" : "array", - "description" : "The controller services in this flow snippet.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ControllerServiceDTO" - } - } - } - }, - "FunnelDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "versionedComponentId" : { - "type" : "string", - "description" : "The ID of the corresponding component that is under version control" - }, - "parentGroupId" : { - "type" : "string", - "description" : "The id of parent process group of this component if applicable." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - } - } - }, - "FunnelEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "component" : { - "$ref" : "#/definitions/FunnelDTO" - } - }, - "xml" : { - "name" : "funnelEntity" - } - }, - "FunnelsEntity" : { - "type" : "object", - "properties" : { - "funnels" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/FunnelEntity" - } - } - }, - "xml" : { - "name" : "funnelsEntity" - } - }, - "GCDiagnosticsSnapshotDTO" : { - "type" : "object", - "properties" : { - "timestamp" : { - "type" : "string", - "format" : "date-time", - "description" : "The timestamp of when the Snapshot was taken" - }, - "collectionCount" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of times that Garbage Collection has occurred" - }, - "collectionMillis" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of milliseconds that the Garbage Collector spent performing Garbage Collection duties" - } - } - }, - "GarbageCollectionDTO" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The name of the garbage collector." - }, - "collectionCount" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of times garbage collection has run." - }, - "collectionTime" : { - "type" : "string", - "description" : "The total amount of time spent garbage collecting." - }, - "collectionMillis" : { - "type" : "integer", - "format" : "int64", - "description" : "The total number of milliseconds spent garbage collecting." - } - } - }, - "GarbageCollectionDiagnosticsDTO" : { - "type" : "object", - "properties" : { - "memoryManagerName" : { - "type" : "string", - "description" : "The name of the Memory Manager that this Garbage Collection information pertains to" - }, - "snapshots" : { - "type" : "array", - "description" : "A list of snapshots that have been taken to determine the health of the JVM's heap", - "items" : { - "$ref" : "#/definitions/GCDiagnosticsSnapshotDTO" - } - } - } - }, - "HistoryDTO" : { - "type" : "object", - "properties" : { - "total" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of number of actions that matched the search criteria.." - }, - "lastRefreshed" : { - "type" : "string", - "description" : "The timestamp when the report was generated." - }, - "actions" : { - "type" : "array", - "description" : "The actions.", - "items" : { - "$ref" : "#/definitions/ActionEntity" - } - } - } - }, - "HistoryEntity" : { - "type" : "object", - "properties" : { - "history" : { - "$ref" : "#/definitions/HistoryDTO" - } - }, - "xml" : { - "name" : "historyEntity" - } - }, - "InputPortsEntity" : { - "type" : "object", - "properties" : { - "inputPorts" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/PortEntity" - } - } - }, - "xml" : { - "name" : "inputPortsEntity" - } - }, - "InputStream" : { - "type" : "object" - }, - "InstantiateTemplateRequestEntity" : { - "type" : "object", - "properties" : { - "originX" : { - "type" : "number", - "format" : "double", - "description" : "The x coordinate of the origin of the bounding box where the new components will be placed." - }, - "originY" : { - "type" : "number", - "format" : "double", - "description" : "The y coordinate of the origin of the bounding box where the new components will be placed." - }, - "templateId" : { - "type" : "string", - "description" : "The identifier of the template." - }, - "encodingVersion" : { - "type" : "string", - "description" : "The encoding version of the flow snippet. If not specified, this is automatically populated by the node receiving the user request. If the snippet is specified, the version will be the latest. If the snippet is not specified, the version will come from the underlying template. These details need to be replicated throughout the cluster to ensure consistency." - }, - "snippet" : { - "description" : "A flow snippet of the template contents. If not specified, this is automatically populated by the node receiving the user request. These details need to be replicated throughout the cluster to ensure consistency.", - "$ref" : "#/definitions/FlowSnippetDTO" - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - } - }, - "xml" : { - "name" : "instantiateTemplateRequestEntity" - } - }, - "JVMControllerDiagnosticsSnapshotDTO" : { - "type" : "object", - "properties" : { - "primaryNode" : { - "type" : "boolean", - "description" : "Whether or not this node is primary node" - }, - "clusterCoordinator" : { - "type" : "boolean", - "description" : "Whether or not this node is cluster coordinator" - }, - "maxTimerDrivenThreads" : { - "type" : "integer", - "format" : "int32", - "description" : "The maximum number of timer-driven threads" - }, - "maxEventDrivenThreads" : { - "type" : "integer", - "format" : "int32", - "description" : "The maximum number of event-driven threads" - } - } - }, - "JVMDiagnosticsDTO" : { - "type" : "object", - "properties" : { - "clustered" : { - "type" : "boolean", - "description" : "Whether or not the NiFi instance is clustered" - }, - "connected" : { - "type" : "boolean", - "description" : "Whether or not the node is connected to the cluster" - }, - "aggregateSnapshot" : { - "description" : "Aggregate JVM diagnostic information about the entire cluster", - "$ref" : "#/definitions/JVMDiagnosticsSnapshotDTO" - }, - "nodeSnapshots" : { - "type" : "array", - "description" : "Node-wise breakdown of JVM diagnostic information", - "items" : { - "$ref" : "#/definitions/NodeJVMDiagnosticsSnapshotDTO" - } - } - } - }, - "JVMDiagnosticsSnapshotDTO" : { - "type" : "object", - "properties" : { - "systemDiagnosticsDto" : { - "description" : "System-related diagnostics information", - "$ref" : "#/definitions/JVMSystemDiagnosticsSnapshotDTO" - }, - "flowDiagnosticsDto" : { - "description" : "Flow-related diagnostics information", - "$ref" : "#/definitions/JVMFlowDiagnosticsSnapshotDTO" - }, - "controllerDiagnostics" : { - "description" : "Controller-related diagnostics information", - "$ref" : "#/definitions/JVMControllerDiagnosticsSnapshotDTO" - } - } - }, - "JVMFlowDiagnosticsSnapshotDTO" : { - "type" : "object", - "properties" : { - "uptime" : { - "type" : "string", - "description" : "How long this node has been running, formatted as hours:minutes:seconds.milliseconds" - }, - "timeZone" : { - "type" : "string", - "description" : "The name of the Time Zone that is configured, if available" - }, - "activeTimerDrivenThreads" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of timer-driven threads that are active" - }, - "activeEventDrivenThreads" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of event-driven threads that are active" - }, - "bundlesLoaded" : { - "type" : "array", - "description" : "The NiFi Bundles (NARs) that are loaded by NiFi", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/BundleDTO" - } - } - } - }, - "JVMSystemDiagnosticsSnapshotDTO" : { - "type" : "object", - "properties" : { - "flowFileRepositoryStorageUsage" : { - "description" : "Information about the FlowFile Repository's usage", - "$ref" : "#/definitions/RepositoryUsageDTO" - }, - "contentRepositoryStorageUsage" : { - "type" : "array", - "description" : "Information about the Content Repository's usage", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/RepositoryUsageDTO" - } - }, - "provenanceRepositoryStorageUsage" : { - "type" : "array", - "description" : "Information about the Provenance Repository's usage", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/RepositoryUsageDTO" - } - }, - "maxHeapBytes" : { - "type" : "integer", - "format" : "int64", - "description" : "The maximum number of bytes that the JVM heap is configured to use for heap" - }, - "maxHeap" : { - "type" : "string", - "description" : "The maximum number of bytes that the JVM heap is configured to use, as a human-readable value" - }, - "garbageCollectionDiagnostics" : { - "type" : "array", - "description" : "Diagnostic information about the JVM's garbage collections", - "items" : { - "$ref" : "#/definitions/GarbageCollectionDiagnosticsDTO" - } - }, - "cpuCores" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of CPU Cores available on the system" - }, - "cpuLoadAverage" : { - "type" : "number", - "format" : "double", - "description" : "The 1-minute CPU Load Average" - }, - "physicalMemoryBytes" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes of RAM available on the system" - }, - "physicalMemory" : { - "type" : "string", - "description" : "The number of bytes of RAM available on the system as a human-readable value" - }, - "openFileDescriptors" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of files that are open by the NiFi process" - }, - "maxOpenFileDescriptors" : { - "type" : "integer", - "format" : "int64", - "description" : "The maximum number of open file descriptors that are available to each process" - } - } - }, - "LabelDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "versionedComponentId" : { - "type" : "string", - "description" : "The ID of the corresponding component that is under version control" - }, - "parentGroupId" : { - "type" : "string", - "description" : "The id of parent process group of this component if applicable." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "label" : { - "type" : "string", - "description" : "The text that appears in the label." - }, - "width" : { - "type" : "number", - "format" : "double", - "description" : "The width of the label in pixels when at a 1:1 scale." - }, - "height" : { - "type" : "number", - "format" : "double", - "description" : "The height of the label in pixels when at a 1:1 scale." - }, - "getzIndex" : { - "type" : "integer", - "format" : "int64", - "description" : "The z index of the label." - }, - "style" : { - "type" : "object", - "description" : "The styles for this label (font-size : 12px, background-color : #eee, etc).", - "additionalProperties" : { - "type" : "string" - } - } - } - }, - "LabelEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "dimensions" : { - "$ref" : "#/definitions/DimensionsDTO" - }, - "getzIndex" : { - "type" : "integer", - "format" : "int64", - "description" : "The z index of the label." - }, - "component" : { - "$ref" : "#/definitions/LabelDTO" - } - }, - "xml" : { - "name" : "labelEntity" - } - }, - "LabelsEntity" : { - "type" : "object", - "properties" : { - "labels" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/LabelEntity" - } - } - }, - "xml" : { - "name" : "labelsEntity" - } - }, - "LineageDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of this lineage query." - }, - "uri" : { - "type" : "string", - "description" : "The URI for this lineage query for later retrieval and deletion." - }, - "submissionTime" : { - "type" : "string", - "description" : "When the lineage query was submitted." - }, - "expiration" : { - "type" : "string", - "description" : "When the lineage query will expire." - }, - "percentCompleted" : { - "type" : "integer", - "format" : "int32", - "description" : "The percent complete for the lineage query." - }, - "finished" : { - "type" : "boolean", - "description" : "Whether the lineage query has finished." - }, - "request" : { - "description" : "The initial lineage result.", - "$ref" : "#/definitions/LineageRequestDTO" - }, - "results" : { - "description" : "The results of the lineage query.", - "$ref" : "#/definitions/LineageResultsDTO" - } - } - }, - "LineageEntity" : { - "type" : "object", - "properties" : { - "lineage" : { - "$ref" : "#/definitions/LineageDTO" - } - }, - "xml" : { - "name" : "lineageEntity" - } - }, - "LineageRequestDTO" : { - "type" : "object", - "properties" : { - "eventId" : { - "type" : "integer", - "format" : "int64", - "description" : "The event id that was used to generate this lineage, if applicable. The event id is allowed for any type of lineageRequestType. If the lineageRequestType is FLOWFILE and the flowfile uuid is also included in the request, the event id will be ignored." - }, - "lineageRequestType" : { - "type" : "string", - "description" : "The type of lineage request. PARENTS will return the lineage for the flowfiles that are parents of the specified event. CHILDREN will return the lineage for the flowfiles that are children of the specified event. FLOWFILE will return the lineage for the specified flowfile.", - "enum" : [ "PARENTS", "CHILDREN", "and FLOWFILE" ] - }, - "uuid" : { - "type" : "string", - "description" : "The flowfile uuid that was used to generate the lineage. The flowfile uuid is only allowed when the lineageRequestType is FLOWFILE and will take precedence over event id." - }, - "clusterNodeId" : { - "type" : "string", - "description" : "The id of the node where this lineage originated if clustered." - } - } - }, - "LineageResultsDTO" : { - "type" : "object", - "properties" : { - "errors" : { - "type" : "array", - "description" : "Any errors that occurred while generating the lineage.", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - }, - "nodes" : { - "type" : "array", - "description" : "The nodes in the lineage.", - "items" : { - "$ref" : "#/definitions/ProvenanceNodeDTO" - } - }, - "links" : { - "type" : "array", - "description" : "The links between the nodes in the lineage.", - "items" : { - "$ref" : "#/definitions/ProvenanceLinkDTO" - } - } - } - }, - "ListingRequestDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id for this listing request." - }, - "uri" : { - "type" : "string", - "description" : "The URI for future requests to this listing request." - }, - "submissionTime" : { - "type" : "string", - "description" : "The timestamp when the query was submitted." - }, - "lastUpdated" : { - "type" : "string", - "description" : "The last time this listing request was updated." - }, - "percentCompleted" : { - "type" : "integer", - "format" : "int32", - "description" : "The current percent complete." - }, - "finished" : { - "type" : "boolean", - "description" : "Whether the query has finished." - }, - "failureReason" : { - "type" : "string", - "description" : "The reason, if any, that this listing request failed." - }, - "maxResults" : { - "type" : "integer", - "format" : "int32", - "description" : "The maximum number of FlowFileSummary objects to return" - }, - "state" : { - "type" : "string", - "description" : "The current state of the listing request." - }, - "queueSize" : { - "description" : "The size of the queue", - "$ref" : "#/definitions/QueueSizeDTO" - }, - "flowFileSummaries" : { - "type" : "array", - "description" : "The FlowFile summaries. The summaries will be populated once the request has completed.", - "items" : { - "$ref" : "#/definitions/FlowFileSummaryDTO" - } - }, - "sourceRunning" : { - "type" : "boolean", - "description" : "Whether the source of the connection is running" - }, - "destinationRunning" : { - "type" : "boolean", - "description" : "Whether the destination of the connection is running" - } - } - }, - "ListingRequestEntity" : { - "type" : "object", - "properties" : { - "listingRequest" : { - "$ref" : "#/definitions/ListingRequestDTO" - } - }, - "xml" : { - "name" : "listingRequestEntity" - } - }, - "LocalQueuePartitionDTO" : { - "type" : "object", - "properties" : { - "totalFlowFileCount" : { - "type" : "integer", - "format" : "int32", - "description" : "Total number of FlowFiles owned by the Connection" - }, - "totalByteCount" : { - "type" : "integer", - "format" : "int64", - "description" : "Total number of bytes that make up the content for the FlowFiles owned by this Connection" - }, - "activeQueueFlowFileCount" : { - "type" : "integer", - "format" : "int32", - "description" : "Total number of FlowFiles that exist in the Connection's Active Queue, immediately available to be offered up to a component" - }, - "activeQueueByteCount" : { - "type" : "integer", - "format" : "int64", - "description" : "Total number of bytes that make up the content for the FlowFiles that are present in the Connection's Active Queue" - }, - "swapFlowFileCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The total number of FlowFiles that are swapped out for this Connection" - }, - "swapByteCount" : { - "type" : "integer", - "format" : "int64", - "description" : "Total number of bytes that make up the content for the FlowFiles that are swapped out to disk for the Connection" - }, - "swapFiles" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of Swap Files that exist for this Connection" - }, - "inFlightFlowFileCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of In-Flight FlowFiles for this Connection. These are FlowFiles that belong to the connection but are currently being operated on by a Processor, Port, etc." - }, - "inFlightByteCount" : { - "type" : "integer", - "format" : "int64", - "description" : "The number bytes that make up the content of the FlowFiles that are In-Flight" - }, - "allActiveQueueFlowFilesPenalized" : { - "type" : "boolean", - "description" : "Whether or not all of the FlowFiles in the Active Queue are penalized" - }, - "anyActiveQueueFlowFilesPenalized" : { - "type" : "boolean", - "description" : "Whether or not any of the FlowFiles in the Active Queue are penalized" - } - } - }, - "NodeConnectionStatisticsSnapshotDTO" : { - "type" : "object", - "properties" : { - "nodeId" : { - "type" : "string", - "description" : "The unique ID that identifies the node" - }, - "address" : { - "type" : "string", - "description" : "The API address of the node" - }, - "apiPort" : { - "type" : "integer", - "format" : "int32", - "description" : "The API port used to communicate with the node" - }, - "statisticsSnapshot" : { - "description" : "The connection status snapshot from the node.", - "$ref" : "#/definitions/ConnectionStatisticsSnapshotDTO" - } - } - }, - "NodeConnectionStatusSnapshotDTO" : { - "type" : "object", - "properties" : { - "nodeId" : { - "type" : "string", - "description" : "The unique ID that identifies the node" - }, - "address" : { - "type" : "string", - "description" : "The API address of the node" - }, - "apiPort" : { - "type" : "integer", - "format" : "int32", - "description" : "The API port used to communicate with the node" - }, - "statusSnapshot" : { - "description" : "The connection status snapshot from the node.", - "$ref" : "#/definitions/ConnectionStatusSnapshotDTO" - } - } - }, - "NodeCountersSnapshotDTO" : { - "type" : "object", - "properties" : { - "nodeId" : { - "type" : "string", - "description" : "The unique ID that identifies the node" - }, - "address" : { - "type" : "string", - "description" : "The API address of the node" - }, - "apiPort" : { - "type" : "integer", - "format" : "int32", - "description" : "The API port used to communicate with the node" - }, - "snapshot" : { - "description" : "The counters from the node.", - "$ref" : "#/definitions/CountersSnapshotDTO" - } - } - }, - "NodeDTO" : { - "type" : "object", - "properties" : { - "nodeId" : { - "type" : "string", - "description" : "The id of the node." - }, - "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." - }, - "status" : { - "type" : "string", - "description" : "The node's status." - }, - "heartbeat" : { - "type" : "string", - "description" : "the time of the nodes's last heartbeat." - }, - "connectionRequested" : { - "type" : "string", - "description" : "The time of the node's last connection request." - }, - "roles" : { - "type" : "array", - "description" : "The roles of this node.", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - }, - "activeThreadCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The active threads for the NiFi on the node." - }, - "queued" : { - "type" : "string", - "description" : "The queue the NiFi on the node." - }, - "events" : { - "type" : "array", - "description" : "The node's events.", - "items" : { - "$ref" : "#/definitions/NodeEventDTO" - } - }, - "nodeStartTime" : { - "type" : "string", - "description" : "The time at which this Node was last refreshed." - } - } - }, - "NodeEntity" : { - "type" : "object", - "properties" : { - "node" : { - "$ref" : "#/definitions/NodeDTO" - } - }, - "xml" : { - "name" : "nodeEntity" - } - }, - "NodeEventDTO" : { - "type" : "object", - "properties" : { - "timestamp" : { - "type" : "string", - "description" : "The timestamp of the node event." - }, - "category" : { - "type" : "string", - "description" : "The category of the node event." - }, - "message" : { - "type" : "string", - "description" : "The message in the node event." - } - } - }, - "NodeIdentifier" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string" - }, - "apiAddress" : { - "type" : "string" - }, - "apiPort" : { - "type" : "integer", - "format" : "int32" - }, - "socketAddress" : { - "type" : "string" - }, - "socketPort" : { - "type" : "integer", - "format" : "int32" - }, - "loadBalanceAddress" : { - "type" : "string" - }, - "loadBalancePort" : { - "type" : "integer", - "format" : "int32" - }, - "siteToSiteAddress" : { - "type" : "string" - }, - "siteToSitePort" : { - "type" : "integer", - "format" : "int32" - }, - "siteToSiteHttpApiPort" : { - "type" : "integer", - "format" : "int32" - }, - "siteToSiteSecure" : { - "type" : "boolean" - }, - "nodeIdentities" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - }, - "fullDescription" : { - "type" : "string" - } - } - }, - "NodeJVMDiagnosticsSnapshotDTO" : { - "type" : "object", - "properties" : { - "nodeId" : { - "type" : "string", - "description" : "The unique ID that identifies the node" - }, - "address" : { - "type" : "string", - "description" : "The API address of the node" - }, - "apiPort" : { - "type" : "integer", - "format" : "int32", - "description" : "The API port used to communicate with the node" - }, - "snapshot" : { - "description" : "The JVM Diagnostics Snapshot", - "$ref" : "#/definitions/JVMDiagnosticsSnapshotDTO" - } - } - }, - "NodePortStatusSnapshotDTO" : { - "type" : "object", - "properties" : { - "nodeId" : { - "type" : "string", - "description" : "The unique ID that identifies the node" - }, - "address" : { - "type" : "string", - "description" : "The API address of the node" - }, - "apiPort" : { - "type" : "integer", - "format" : "int32", - "description" : "The API port used to communicate with the node" - }, - "statusSnapshot" : { - "description" : "The port status snapshot from the node.", - "$ref" : "#/definitions/PortStatusSnapshotDTO" - } - } - }, - "NodeProcessGroupStatusSnapshotDTO" : { - "type" : "object", - "properties" : { - "nodeId" : { - "type" : "string", - "description" : "The unique ID that identifies the node" - }, - "address" : { - "type" : "string", - "description" : "The API address of the node" - }, - "apiPort" : { - "type" : "integer", - "format" : "int32", - "description" : "The API port used to communicate with the node" - }, - "statusSnapshot" : { - "description" : "The process group status snapshot from the node.", - "$ref" : "#/definitions/ProcessGroupStatusSnapshotDTO" - } - } - }, - "NodeProcessorStatusSnapshotDTO" : { - "type" : "object", - "properties" : { - "nodeId" : { - "type" : "string", - "description" : "The unique ID that identifies the node" - }, - "address" : { - "type" : "string", - "description" : "The API address of the node" - }, - "apiPort" : { - "type" : "integer", - "format" : "int32", - "description" : "The API port used to communicate with the node" - }, - "statusSnapshot" : { - "description" : "The processor status snapshot from the node.", - "$ref" : "#/definitions/ProcessorStatusSnapshotDTO" - } - } - }, - "NodeRemoteProcessGroupStatusSnapshotDTO" : { - "type" : "object", - "properties" : { - "nodeId" : { - "type" : "string", - "description" : "The unique ID that identifies the node" - }, - "address" : { - "type" : "string", - "description" : "The API address of the node" - }, - "apiPort" : { - "type" : "integer", - "format" : "int32", - "description" : "The API port used to communicate with the node" - }, - "statusSnapshot" : { - "description" : "The remote process group status snapshot from the node.", - "$ref" : "#/definitions/RemoteProcessGroupStatusSnapshotDTO" - } - } - }, - "NodeReplayLastEventSnapshotDTO" : { - "type" : "object", - "properties" : { - "nodeId" : { - "type" : "string", - "description" : "The unique ID that identifies the node" - }, - "address" : { - "type" : "string", - "description" : "The API address of the node" - }, - "apiPort" : { - "type" : "integer", - "format" : "int32", - "description" : "The API port used to communicate with the node" - }, - "snapshot" : { - "description" : "The snapshot from the node", - "$ref" : "#/definitions/ReplayLastEventSnapshotDTO" - } - }, - "xml" : { - "name" : "nodeReplayLastEventSnapshot" - } - }, - "NodeResponse" : { - "type" : "object", - "properties" : { - "httpMethod" : { - "type" : "string" - }, - "requestUri" : { - "type" : "string", - "format" : "uri" - }, - "response" : { - "$ref" : "#/definitions/Response" - }, - "nodeId" : { - "$ref" : "#/definitions/NodeIdentifier" - }, - "throwable" : { - "$ref" : "#/definitions/Throwable" - }, - "updatedEntity" : { - "$ref" : "#/definitions/Entity" - }, - "requestId" : { - "type" : "string" - }, - "status" : { - "type" : "integer", - "format" : "int32" - }, - "inputStream" : { - "$ref" : "#/definitions/InputStream" - }, - "clientResponse" : { - "$ref" : "#/definitions/Response" - }, - "is2xx" : { - "type" : "boolean" - }, - "is5xx" : { - "type" : "boolean" - } - } - }, - "NodeSearchResultDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the node that matched the search." - }, - "address" : { - "type" : "string", - "description" : "The address of the node that matched the search." - } - } - }, - "NodeStatusSnapshotsDTO" : { - "type" : "object", - "properties" : { - "nodeId" : { - "type" : "string", - "description" : "The id of the node." - }, - "address" : { - "type" : "string", - "description" : "The node's host/ip address." - }, - "apiPort" : { - "type" : "integer", - "format" : "int32", - "description" : "The port the node is listening for API requests." - }, - "statusSnapshots" : { - "type" : "array", - "description" : "A list of StatusSnapshotDTO objects that provide the actual metric values for the component for this node.", - "items" : { - "$ref" : "#/definitions/StatusSnapshotDTO" - } - } - } - }, - "NodeSystemDiagnosticsSnapshotDTO" : { - "type" : "object", - "properties" : { - "nodeId" : { - "type" : "string", - "description" : "The unique ID that identifies the node" - }, - "address" : { - "type" : "string", - "description" : "The API address of the node" - }, - "apiPort" : { - "type" : "integer", - "format" : "int32", - "description" : "The API port used to communicate with the node" - }, - "snapshot" : { - "description" : "The System Diagnostics snapshot from the node.", - "$ref" : "#/definitions/SystemDiagnosticsSnapshotDTO" - } - } - }, - "OutputPortsEntity" : { - "type" : "object", - "properties" : { - "outputPorts" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/PortEntity" - } - } - }, - "xml" : { - "name" : "outputPortsEntity" - } - }, - "ParameterContextDTO" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The Name of the Parameter Context." - }, - "description" : { - "type" : "string", - "description" : "The Description of the Parameter Context." - }, - "parameters" : { - "type" : "array", - "description" : "The Parameters for the Parameter Context", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ParameterEntity" - } - }, - "boundProcessGroups" : { - "type" : "array", - "description" : "The Process Groups that are bound to this Parameter Context", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ProcessGroupEntity" - } - }, - "inheritedParameterContexts" : { - "type" : "array", - "description" : "A list of references of Parameter Contexts from which this one inherits parameters", - "items" : { - "$ref" : "#/definitions/ParameterContextReferenceEntity" - } - }, - "parameterProviderConfiguration" : { - "description" : "Optional configuration for a Parameter Provider", - "$ref" : "#/definitions/ParameterProviderConfigurationEntity" - }, - "id" : { - "type" : "string", - "description" : "The ID the Parameter Context." - } - } - }, - "ParameterContextEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "component" : { - "description" : "The Parameter Context", - "$ref" : "#/definitions/ParameterContextDTO" - } - }, - "xml" : { - "name" : "parameterContextEntity" - } - }, - "ParameterContextReferenceDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The ID of the Parameter Context" - }, - "name" : { - "type" : "string", - "description" : "The name of the Parameter Context" - } - } - }, - "ParameterContextReferenceEntity" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "component" : { - "$ref" : "#/definitions/ParameterContextReferenceDTO" - } - }, - "xml" : { - "name" : "parameterContextReferenceEntity" - } - }, - "ParameterContextUpdateEntity" : { - "type" : "object", - "properties" : { - "parameterContextRevision" : { - "description" : "The Revision of the Parameter Context", - "$ref" : "#/definitions/RevisionDTO" - }, - "parameterContext" : { - "description" : "The Parameter Context that is being operated on. This may not be populated until the request has successfully completed.", - "$ref" : "#/definitions/ParameterContextDTO" - }, - "referencingComponents" : { - "type" : "array", - "description" : "The components that are referenced by the update.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/AffectedComponentEntity" - } - } - }, - "xml" : { - "name" : "parameterContextUpdateEntity" - } - }, - "ParameterContextUpdateRequestDTO" : { - "type" : "object", - "properties" : { - "requestId" : { - "type" : "string", - "description" : "The ID of the request" - }, - "uri" : { - "type" : "string", - "description" : "The URI for the request" - }, - "submissionTime" : { - "type" : "string", - "format" : "date-time", - "description" : "The timestamp of when the request was submitted" - }, - "lastUpdated" : { - "type" : "string", - "format" : "date-time", - "description" : "The timestamp of when the request was last updated" - }, - "complete" : { - "type" : "boolean", - "description" : "Whether or not the request is completed" - }, - "failureReason" : { - "type" : "string", - "description" : "The reason for the request failing, or null if the request has not failed" - }, - "percentCompleted" : { - "type" : "integer", - "format" : "int32", - "description" : "A value between 0 and 100 (inclusive) indicating how close the request is to completion" - }, - "state" : { - "type" : "string", - "description" : "A description of the current state of the request" - }, - "updateSteps" : { - "type" : "array", - "description" : "The steps that are required in order to complete the request, along with the status of each", - "items" : { - "$ref" : "#/definitions/ParameterContextUpdateStepDTO" - } - }, - "parameterContext" : { - "description" : "The Parameter Context that is being operated on. This may not be populated until the request has successfully completed.", - "$ref" : "#/definitions/ParameterContextDTO" - }, - "referencingComponents" : { - "type" : "array", - "description" : "The components that are referenced by the update.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/AffectedComponentEntity" - } - } - } - }, - "ParameterContextUpdateRequestEntity" : { - "type" : "object", - "properties" : { - "parameterContextRevision" : { - "description" : "The Revision of the Parameter Context", - "$ref" : "#/definitions/RevisionDTO" - }, - "request" : { - "description" : "The Update Request", - "$ref" : "#/definitions/ParameterContextUpdateRequestDTO" - } - }, - "xml" : { - "name" : "parameterContextUpdateRequestEntity" - } - }, - "ParameterContextUpdateStepDTO" : { - "type" : "object", - "properties" : { - "description" : { - "type" : "string", - "description" : "Explanation of what happens in this step" - }, - "complete" : { - "type" : "boolean", - "description" : "Whether or not this step has completed" - }, - "failureReason" : { - "type" : "string", - "description" : "An explanation of why this step failed, or null if this step did not fail" - } - } - }, - "ParameterContextValidationRequestDTO" : { - "type" : "object", - "properties" : { - "requestId" : { - "type" : "string", - "description" : "The ID of the request" - }, - "uri" : { - "type" : "string", - "description" : "The URI for the request" - }, - "submissionTime" : { - "type" : "string", - "format" : "date-time", - "description" : "The timestamp of when the request was submitted" - }, - "lastUpdated" : { - "type" : "string", - "format" : "date-time", - "description" : "The timestamp of when the request was last updated" - }, - "complete" : { - "type" : "boolean", - "description" : "Whether or not the request is completed" - }, - "failureReason" : { - "type" : "string", - "description" : "The reason for the request failing, or null if the request has not failed" - }, - "percentCompleted" : { - "type" : "integer", - "format" : "int32", - "description" : "A value between 0 and 100 (inclusive) indicating how close the request is to completion" - }, - "state" : { - "type" : "string", - "description" : "A description of the current state of the request" - }, - "updateSteps" : { - "type" : "array", - "description" : "The steps that are required in order to complete the request, along with the status of each", - "items" : { - "$ref" : "#/definitions/ParameterContextValidationStepDTO" - } - }, - "parameterContext" : { - "description" : "The Parameter Context that is being operated on.", - "$ref" : "#/definitions/ParameterContextDTO" - }, - "componentValidationResults" : { - "description" : "The Validation Results that were calculated for each component. This value may not be set until the request completes.", - "$ref" : "#/definitions/ComponentValidationResultsEntity" - } - } - }, - "ParameterContextValidationRequestEntity" : { - "type" : "object", - "properties" : { - "request" : { - "description" : "The Update Request", - "$ref" : "#/definitions/ParameterContextValidationRequestDTO" - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - } - }, - "xml" : { - "name" : "parameterContextValidationRequestEntity" - } - }, - "ParameterContextValidationStepDTO" : { - "type" : "object", - "properties" : { - "description" : { - "type" : "string", - "description" : "Explanation of what happens in this step" - }, - "complete" : { - "type" : "boolean", - "description" : "Whether or not this step has completed" - }, - "failureReason" : { - "type" : "string", - "description" : "An explanation of why this step failed, or null if this step did not fail" - } - } - }, - "ParameterContextsEntity" : { - "type" : "object", - "properties" : { - "parameterContexts" : { - "type" : "array", - "description" : "The Parameter Contexts", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ParameterContextEntity" - } - }, - "currentTime" : { - "type" : "string", - "description" : "The current time on the system." - } - }, - "xml" : { - "name" : "parameterContexts" - } - }, - "ParameterDTO" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The name of the Parameter" - }, - "description" : { - "type" : "string", - "description" : "The description of the Parameter" - }, - "sensitive" : { - "type" : "boolean", - "description" : "Whether or not the Parameter is sensitive" - }, - "value" : { - "type" : "string", - "description" : "The value of the Parameter" - }, - "valueRemoved" : { - "type" : "boolean", - "description" : "Whether or not the value of the Parameter was removed. When a request is made to change a parameter, the value may be null. The 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). This denotes which of the two scenarios is being encountered." - }, - "provided" : { - "type" : "boolean", - "description" : "Whether or not the Parameter is provided by a ParameterProvider" - }, - "referencingComponents" : { - "type" : "array", - "description" : "The set of all components in the flow that are referencing this Parameter", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/AffectedComponentEntity" - } - }, - "parameterContext" : { - "description" : "A reference to the Parameter Context that contains this one", - "$ref" : "#/definitions/ParameterContextReferenceEntity" - }, - "inherited" : { - "type" : "boolean", - "description" : "Whether or not the Parameter is inherited from another context" - } - } - }, - "ParameterEntity" : { - "type" : "object", - "properties" : { - "canWrite" : { - "type" : "boolean", - "description" : "Indicates whether the user can write a given resource." - }, - "parameter" : { - "description" : "The parameter information", - "$ref" : "#/definitions/ParameterDTO" - } - }, - "xml" : { - "name" : "parameterEntity" - } - }, - "ParameterGroupConfigurationEntity" : { - "type" : "object", - "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", - "description" : "All fetched parameter names that should be applied.", - "additionalProperties" : { - "type" : "string", - "enum" : [ "SENSITIVE", "NON_SENSITIVE" ] - } - }, - "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", - "properties" : { - "requestId" : { - "type" : "string", - "description" : "The ID of the request" - }, - "uri" : { - "type" : "string", - "description" : "The URI for the request" - }, - "submissionTime" : { - "type" : "string", - "format" : "date-time", - "description" : "The timestamp of when the request was submitted" - }, - "lastUpdated" : { - "type" : "string", - "format" : "date-time", - "description" : "The timestamp of when the request was last updated" - }, - "complete" : { - "type" : "boolean", - "description" : "Whether or not the request is completed" - }, - "failureReason" : { - "type" : "string", - "description" : "The reason for the request failing, or null if the request has not failed" - }, - "percentCompleted" : { - "type" : "integer", - "format" : "int32", - "description" : "A value between 0 and 100 (inclusive) indicating how close the request is to completion" - }, - "state" : { - "type" : "string", - "description" : "A description of the current state of the request" - }, - "updateSteps" : { - "type" : "array", - "description" : "The steps that are required in order to complete the request, along with the status of each", - "items" : { - "$ref" : "#/definitions/ParameterProviderApplyParametersUpdateStepDTO" - } - }, - "parameterProvider" : { - "description" : "The Parameter Provider that is being operated on. This may not be populated until the request has successfully completed.", - "$ref" : "#/definitions/ParameterProviderDTO" - }, - "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" : "#/definitions/ParameterContextUpdateEntity" - } - }, - "referencingComponents" : { - "type" : "array", - "description" : "The components that are referenced by the update.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/AffectedComponentEntity" - } - } - } - }, - "ParameterProviderApplyParametersRequestEntity" : { - "type" : "object", - "properties" : { - "request" : { - "description" : "The Apply Parameters Request", - "$ref" : "#/definitions/ParameterProviderApplyParametersRequestDTO" - } - }, - "xml" : { - "name" : "parameterProviderApplyParametersRequestEntity" - } - }, - "ParameterProviderApplyParametersUpdateStepDTO" : { - "type" : "object", - "properties" : { - "description" : { - "type" : "string", - "description" : "Explanation of what happens in this step" - }, - "complete" : { - "type" : "boolean", - "description" : "Whether or not this step has completed" - }, - "failureReason" : { - "type" : "string", - "description" : "An explanation of why this step failed, or null if this step did not fail" - } - } - }, - "ParameterProviderConfigurationDTO" : { - "type" : "object", - "properties" : { - "parameterProviderId" : { - "type" : "string", - "description" : "The ID of the Parameter Provider" - }, - "parameterProviderName" : { - "type" : "string", - "description" : "The name of the Parameter Provider" - }, - "parameterGroupName" : { - "type" : "string", - "description" : "The Parameter Group name that maps to the Parameter Context" - }, - "synchronized" : { - "type" : "boolean", - "description" : "True if the Parameter Context should receive the parameters from the mapped Parameter Group" - } - } - }, - "ParameterProviderConfigurationEntity" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "component" : { - "$ref" : "#/definitions/ParameterProviderConfigurationDTO" - } - }, - "xml" : { - "name" : "parameterProviderConfigurationEntity" - } - }, - "ParameterProviderDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "versionedComponentId" : { - "type" : "string", - "description" : "The ID of the corresponding component that is under version control" - }, - "parentGroupId" : { - "type" : "string", - "description" : "The id of parent process group of this component if applicable." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "name" : { - "type" : "string", - "description" : "The name of the parameter provider." - }, - "type" : { - "type" : "string", - "description" : "The fully qualified type of the parameter provider." - }, - "bundle" : { - "description" : "The details of the artifact that bundled this parameter provider type.", - "$ref" : "#/definitions/BundleDTO" - }, - "comments" : { - "type" : "string", - "description" : "The comments of the parameter provider." - }, - "persistsState" : { - "type" : "boolean", - "description" : "Whether the parameter provider persists state." - }, - "restricted" : { - "type" : "boolean", - "description" : "Whether the parameter provider requires elevated privileges." - }, - "deprecated" : { - "type" : "boolean", - "description" : "Whether the parameter provider has been deprecated." - }, - "multipleVersionsAvailable" : { - "type" : "boolean", - "description" : "Whether the parameter provider has multiple versions available." - }, - "properties" : { - "type" : "object", - "description" : "The properties of the parameter provider.", - "additionalProperties" : { - "type" : "string" - } - }, - "descriptors" : { - "type" : "object", - "description" : "The descriptors for the parameter providers properties.", - "additionalProperties" : { - "$ref" : "#/definitions/PropertyDescriptorDTO" - } - }, - "parameterGroupConfigurations" : { - "type" : "array", - "description" : "Configuration for any fetched parameter groups.", - "items" : { - "$ref" : "#/definitions/ParameterGroupConfigurationEntity" - } - }, - "affectedComponents" : { - "type" : "array", - "description" : "The set of all components in the flow that are referencing Parameters provided by this provider", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/AffectedComponentEntity" - } - }, - "parameterStatus" : { - "type" : "array", - "description" : "The status of all provided parameters for this parameter provider", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ParameterStatusDTO" - } - }, - "referencingParameterContexts" : { - "type" : "array", - "description" : "The Parameter Contexts that reference this Parameter Provider", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ParameterProviderReferencingComponentEntity" - } - }, - "customUiUrl" : { - "type" : "string", - "description" : "The URL for the custom configuration UI for the parameter provider." - }, - "annotationData" : { - "type" : "string", - "description" : "The annotation data for the parameter provider. This is how the custom UI relays configuration to 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" - } - }, - "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" ] - }, - "extensionMissing" : { - "type" : "boolean", - "description" : "Whether the underlying extension is missing." - } - } - }, - "ParameterProviderEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "component" : { - "$ref" : "#/definitions/ParameterProviderDTO" - } - }, - "xml" : { - "name" : "parameterProviderEntity" - } - }, - "ParameterProviderParameterApplicationEntity" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the parameter provider." - }, - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "parameterGroupConfigurations" : { - "type" : "array", - "description" : "Configuration for the fetched Parameter Groups", - "items" : { - "$ref" : "#/definitions/ParameterGroupConfigurationEntity" - } - } - }, - "xml" : { - "name" : "entity" - } - }, - "ParameterProviderParameterFetchEntity" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the parameter provider." - }, - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - } - }, - "xml" : { - "name" : "entity" - } - }, - "ParameterProviderReference" : { - "type" : "object", - "properties" : { - "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." - }, - "bundle" : { - "description" : "The details of the artifact that bundled this parameter provider.", - "$ref" : "#/definitions/Bundle" - } - } - }, - "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", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "component" : { - "$ref" : "#/definitions/ParameterProviderReferencingComponentDTO" - } - }, - "xml" : { - "name" : "parameterProviderReferencingComponentEntity" - } - }, - "ParameterProviderReferencingComponentsEntity" : { - "type" : "object", - "properties" : { - "parameterProviderReferencingComponents" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ParameterProviderReferencingComponentEntity" - } - } - }, - "xml" : { - "name" : "parameterProviderReferencingComponentsEntity" - } - }, - "ParameterProviderTypesEntity" : { - "type" : "object", - "properties" : { - "parameterProviderTypes" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/DocumentedTypeDTO" - } - } - }, - "xml" : { - "name" : "parameterProviderTypesEntity" - } - }, - "ParameterProvidersEntity" : { - "type" : "object", - "properties" : { - "parameterProviders" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ParameterProviderEntity" - } - } - }, - "xml" : { - "name" : "parameterProvidersEntity" - } - }, - "ParameterStatusDTO" : { - "type" : "object", - "properties" : { - "parameter" : { - "description" : "The name of the Parameter", - "$ref" : "#/definitions/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" ] - } - } - }, - "PeerDTO" : { - "type" : "object", - "properties" : { - "hostname" : { - "type" : "string", - "description" : "The hostname of this peer." - }, - "port" : { - "type" : "integer", - "format" : "int32", - "description" : "The port number of this peer." - }, - "secure" : { - "type" : "boolean", - "description" : "Returns if this peer connection is secure." - }, - "flowFileCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of flowFiles this peer holds." - } - } - }, - "PeersEntity" : { - "type" : "object", - "properties" : { - "peers" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/PeerDTO" - } - } - }, - "xml" : { - "name" : "peersEntity" - } - }, - "PermissionsDTO" : { - "type" : "object", - "properties" : { - "canRead" : { - "type" : "boolean", - "description" : "Indicates whether the user can read a given resource." - }, - "canWrite" : { - "type" : "boolean", - "description" : "Indicates whether the user can write a given resource." - } - } - }, - "PortDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "versionedComponentId" : { - "type" : "string", - "description" : "The ID of the corresponding component that is under version control" - }, - "parentGroupId" : { - "type" : "string", - "description" : "The id of parent process group of this component if applicable." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "name" : { - "type" : "string", - "description" : "The name of the port." - }, - "comments" : { - "type" : "string", - "description" : "The comments for the port." - }, - "state" : { - "type" : "string", - "description" : "The state of the port.", - "enum" : [ "RUNNING", "STOPPED", "DISABLED" ] - }, - "type" : { - "type" : "string", - "description" : "The type of port.", - "enum" : [ "INPUT_PORT", "OUTPUT_PORT" ] - }, - "transmitting" : { - "type" : "boolean", - "description" : "Whether the port has incoming or output connections to a remote NiFi. This is only applicable when the port is allowed to be accessed remotely." - }, - "concurrentlySchedulableTaskCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of tasks that should be concurrently scheduled for the port." - }, - "userAccessControl" : { - "type" : "array", - "description" : "The users that are allowed to access the port.", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - }, - "groupAccessControl" : { - "type" : "array", - "description" : "The user groups that are allowed to access the port.", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - }, - "allowRemoteAccess" : { - "type" : "boolean", - "description" : "Whether this port can be accessed remotely via Site-to-Site protocol." - }, - "validationErrors" : { - "type" : "array", - "description" : "Gets the validation errors from this port. These validation errors represent the problems with the port that must be resolved before it can be started.", - "items" : { - "type" : "string" - } - } - } - }, - "PortEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "component" : { - "$ref" : "#/definitions/PortDTO" - }, - "status" : { - "description" : "The status of the port.", - "$ref" : "#/definitions/PortStatusDTO" - }, - "portType" : { - "type" : "string" - }, - "operatePermissions" : { - "description" : "The permissions for this component operations.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "allowRemoteAccess" : { - "type" : "boolean", - "description" : "Whether this port can be accessed remotely via Site-to-Site protocol." - } - }, - "xml" : { - "name" : "portEntity" - } - }, - "PortRunStatusEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "state" : { - "type" : "string", - "description" : "The run status of the Port.", - "enum" : [ "RUNNING", "STOPPED", "DISABLED" ] - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - } - }, - "xml" : { - "name" : "entity" - } - }, - "PortStatusDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the port." - }, - "groupId" : { - "type" : "string", - "description" : "The id of the parent process group of the port." - }, - "name" : { - "type" : "string", - "description" : "The name of the port." - }, - "transmitting" : { - "type" : "boolean", - "description" : "Whether the port has incoming or outgoing connections to a remote NiFi." - }, - "runStatus" : { - "type" : "string", - "description" : "The run status of the port.", - "enum" : [ "Running", "Stopped", "Validating", "Disabled", "Invalid" ] - }, - "statsLastRefreshed" : { - "type" : "string", - "description" : "The time the status for the process group was last refreshed." - }, - "aggregateSnapshot" : { - "description" : "A status snapshot that represents the aggregate stats of all nodes in the cluster. If the NiFi instance is a standalone instance, rather than a cluster, this represents the stats of the single instance.", - "$ref" : "#/definitions/PortStatusSnapshotDTO" - }, - "nodeSnapshots" : { - "type" : "array", - "description" : "A status snapshot for each node in the cluster. If the NiFi instance is a standalone instance, rather than a cluster, this may be null.", - "items" : { - "$ref" : "#/definitions/NodePortStatusSnapshotDTO" - } - } - } - }, - "PortStatusEntity" : { - "type" : "object", - "properties" : { - "portStatus" : { - "$ref" : "#/definitions/PortStatusDTO" - }, - "canRead" : { - "type" : "boolean", - "description" : "Indicates whether the user can read a given resource." - } - }, - "xml" : { - "name" : "portStatusEntity" - } - }, - "PortStatusSnapshotDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the port." - }, - "groupId" : { - "type" : "string", - "description" : "The id of the parent process group of the port." - }, - "name" : { - "type" : "string", - "description" : "The name of the port." - }, - "activeThreadCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The active thread count for the port." - }, - "flowFilesIn" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of FlowFiles that have been accepted in the last 5 minutes." - }, - "bytesIn" : { - "type" : "integer", - "format" : "int64", - "description" : "The size of hte FlowFiles that have been accepted in the last 5 minutes." - }, - "input" : { - "type" : "string", - "description" : "The count/size of flowfiles that have been accepted in the last 5 minutes." - }, - "flowFilesOut" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of FlowFiles that have been processed in the last 5 minutes." - }, - "bytesOut" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes that have been processed in the last 5 minutes." - }, - "output" : { - "type" : "string", - "description" : "The count/size of flowfiles that have been processed in the last 5 minutes." - }, - "transmitting" : { - "type" : "boolean", - "description" : "Whether the port has incoming or outgoing connections to a remote NiFi." - }, - "runStatus" : { - "type" : "string", - "description" : "The run status of the port.", - "enum" : [ "Running", "Stopped", "Validating", "Disabled", "Invalid" ] - } - } - }, - "PortStatusSnapshotEntity" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the port." - }, - "portStatusSnapshot" : { - "$ref" : "#/definitions/PortStatusSnapshotDTO" - }, - "canRead" : { - "type" : "boolean", - "description" : "Indicates whether the user can read a given resource." - } - }, - "xml" : { - "name" : "entity" - } - }, - "Position" : { - "type" : "object", - "properties" : { - "x" : { - "type" : "number", - "format" : "double", - "description" : "The x coordinate." - }, - "y" : { - "type" : "number", - "format" : "double", - "description" : "The y coordinate." - } - }, - "description" : "The position of a component on the graph" - }, - "PositionDTO" : { - "type" : "object", - "properties" : { - "x" : { - "type" : "number", - "format" : "double", - "description" : "The x coordinate." - }, - "y" : { - "type" : "number", - "format" : "double", - "description" : "The y coordinate." - } - } - }, - "PreviousValueDTO" : { - "type" : "object", - "properties" : { - "previousValue" : { - "type" : "string", - "description" : "The previous value." - }, - "timestamp" : { - "type" : "string", - "description" : "The timestamp when the value was modified." - }, - "userIdentity" : { - "type" : "string", - "description" : "The user who changed the previous value." - } - } - }, - "PrioritizerTypesEntity" : { - "type" : "object", - "properties" : { - "prioritizerTypes" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/DocumentedTypeDTO" - } - } - }, - "xml" : { - "name" : "prioritizerTypesEntity" - } - }, - "ProcessGroupDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "versionedComponentId" : { - "type" : "string", - "description" : "The ID of the corresponding component that is under version control" - }, - "parentGroupId" : { - "type" : "string", - "description" : "The id of parent process group of this component if applicable." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "name" : { - "type" : "string", - "description" : "The name of the process group." - }, - "comments" : { - "type" : "string", - "description" : "The comments for the process group." - }, - "variables" : { - "type" : "object", - "description" : "The variables that are configured for the Process Group. Note that this map contains only those variables that are defined on this Process Group and not any variables that are defined in the parent Process Group, etc. I.e., this Map will not contain all variables that are accessible by components in this Process Group by rather only the variables that are defined for this Process Group itself.", - "additionalProperties" : { - "type" : "string" - } - }, - "versionControlInformation" : { - "description" : "The Version Control information that indicates which Flow Registry, and where in the Flow Registry, this Process Group is tracking to; or null if this Process Group is not under version control", - "$ref" : "#/definitions/VersionControlInformationDTO" - }, - "parameterContext" : { - "description" : "The Parameter Context that this Process Group is bound to.", - "$ref" : "#/definitions/ParameterContextReferenceEntity" - }, - "flowfileConcurrency" : { - "type" : "string", - "description" : "The FlowFile Concurrency for this Process Group.", - "enum" : [ "UNBOUNDED", "SINGLE_FLOWFILE_PER_NODE", "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" ] - }, - "defaultFlowFileExpiration" : { - "type" : "string", - "description" : "The default FlowFile Expiration for this Process Group." - }, - "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." - }, - "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." - }, - "runningCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of running components in this process group." - }, - "stoppedCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of stopped components in the process group." - }, - "invalidCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of invalid components in the process group." - }, - "disabledCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of disabled components in the process group." - }, - "activeRemotePortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of active remote ports in the process group." - }, - "inactiveRemotePortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of inactive remote ports in the process group." - }, - "upToDateCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of up to date versioned process groups in the process group." - }, - "locallyModifiedCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of locally modified versioned process groups in the process group." - }, - "staleCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of stale versioned process groups in the process group." - }, - "locallyModifiedAndStaleCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of locally modified and stale versioned process groups in the process group." - }, - "syncFailureCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of versioned process groups in the process group that are unable to sync to a registry." - }, - "localInputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of local input ports in the process group." - }, - "localOutputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of local output ports in the process group." - }, - "publicInputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of public input ports in the process group." - }, - "publicOutputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of public output ports in the process group." - }, - "contents" : { - "description" : "The contents of this process group.", - "$ref" : "#/definitions/FlowSnippetDTO" - }, - "inputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of input ports in the process group." - }, - "outputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of output ports in the process group." - } - } - }, - "ProcessGroupEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "component" : { - "$ref" : "#/definitions/ProcessGroupDTO" - }, - "status" : { - "description" : "The status of the process group.", - "$ref" : "#/definitions/ProcessGroupStatusDTO" - }, - "versionedFlowSnapshot" : { - "description" : "Returns the Versioned Flow that describes the contents of the Versioned Flow to be imported", - "$ref" : "#/definitions/RegisteredFlowSnapshot" - }, - "runningCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of running components in this process group." - }, - "stoppedCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of stopped components in the process group." - }, - "invalidCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of invalid components in the process group." - }, - "disabledCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of disabled components in the process group." - }, - "activeRemotePortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of active remote ports in the process group." - }, - "inactiveRemotePortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of inactive remote ports in the process group." - }, - "versionedFlowState" : { - "type" : "string", - "description" : "The current state of the Process Group, as it relates to the Versioned Flow", - "enum" : [ "LOCALLY_MODIFIED", "STALE", "LOCALLY_MODIFIED_AND_STALE", "UP_TO_DATE", "SYNC_FAILURE" ] - }, - "upToDateCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of up to date versioned process groups in the process group." - }, - "locallyModifiedCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of locally modified versioned process groups in the process group." - }, - "staleCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of stale versioned process groups in the process group." - }, - "locallyModifiedAndStaleCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of locally modified and stale versioned process groups in the process group." - }, - "syncFailureCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of versioned process groups in the process group that are unable to sync to a registry." - }, - "localInputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of local input ports in the process group." - }, - "localOutputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of local output ports in the process group." - }, - "publicInputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of public input ports in the process group." - }, - "publicOutputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of public output ports in the process group." - }, - "parameterContext" : { - "description" : "The Parameter Context, or null if no Parameter Context has been bound to the Process Group", - "$ref" : "#/definitions/ParameterContextReferenceEntity" - }, - "inputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of input ports in the process group." - }, - "outputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of output ports in the process group." - } - }, - "xml" : { - "name" : "processGroupEntity" - } - }, - "ProcessGroupFlowDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "parentGroupId" : { - "type" : "string", - "description" : "The id of parent process group of this component if applicable." - }, - "parameterContext" : { - "description" : "The Parameter Context, or null if no Parameter Context has been bound to the Process Group", - "$ref" : "#/definitions/ParameterContextReferenceEntity" - }, - "breadcrumb" : { - "description" : "The breadcrumb of the process group.", - "$ref" : "#/definitions/FlowBreadcrumbEntity" - }, - "flow" : { - "description" : "The flow structure starting at this Process Group.", - "$ref" : "#/definitions/FlowDTO" - }, - "lastRefreshed" : { - "type" : "string", - "description" : "The time the flow for the process group was last refreshed." - } - } - }, - "ProcessGroupFlowEntity" : { - "type" : "object", - "properties" : { - "permissions" : { - "description" : "The access policy for this process group.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "processGroupFlow" : { - "$ref" : "#/definitions/ProcessGroupFlowDTO" - } - }, - "xml" : { - "name" : "processGroupFlowEntity" - } - }, - "ProcessGroupImportEntity" : { - "type" : "object", - "properties" : { - "processGroupRevision" : { - "description" : "The Revision for the Process Group", - "$ref" : "#/definitions/RevisionDTO" - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "versionedFlowSnapshot" : { - "description" : "The Versioned Flow Snapshot to import", - "$ref" : "#/definitions/RegisteredFlowSnapshot" - } - }, - "xml" : { - "name" : "processGroupImportEntity" - } - }, - "ProcessGroupNameDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The ID of the Process Group" - }, - "name" : { - "type" : "string", - "description" : "The name of the Process Group, or the ID of the Process Group if the user does not have the READ policy for the Process Group" - } - } - }, - "ProcessGroupReplaceRequestDTO" : { - "type" : "object", - "properties" : { - "requestId" : { - "type" : "string", - "description" : "The unique ID of this request." - }, - "processGroupId" : { - "type" : "string", - "description" : "The unique ID of the Process Group being updated" - }, - "uri" : { - "type" : "string", - "description" : "The URI for future requests to this drop request." - }, - "lastUpdated" : { - "type" : "string", - "description" : "The last time this request was updated." - }, - "complete" : { - "type" : "boolean", - "description" : "Whether or not this request has completed" - }, - "failureReason" : { - "type" : "string", - "description" : "An explanation of why this request failed, or null if this request has not failed" - }, - "percentCompleted" : { - "type" : "integer", - "format" : "int32", - "description" : "The percentage complete for the request, between 0 and 100" - }, - "state" : { - "type" : "string", - "description" : "The state of the request" - } - } - }, - "ProcessGroupReplaceRequestEntity" : { - "type" : "object", - "properties" : { - "processGroupRevision" : { - "description" : "The revision for the Process Group being updated.", - "$ref" : "#/definitions/RevisionDTO" - }, - "request" : { - "description" : "The Process Group Change Request", - "$ref" : "#/definitions/ProcessGroupReplaceRequestDTO" - }, - "versionedFlowSnapshot" : { - "description" : "Returns the Versioned Flow to replace with", - "$ref" : "#/definitions/RegisteredFlowSnapshot" - } - }, - "xml" : { - "name" : "processGroupReplaceRequestEntity" - } - }, - "ProcessGroupStatusDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The ID of the Process Group" - }, - "name" : { - "type" : "string", - "description" : "The name of the Process Group" - }, - "statsLastRefreshed" : { - "type" : "string", - "description" : "The time the status for the process group was last refreshed." - }, - "aggregateSnapshot" : { - "description" : "The aggregate status of all nodes in the cluster", - "$ref" : "#/definitions/ProcessGroupStatusSnapshotDTO" - }, - "nodeSnapshots" : { - "type" : "array", - "description" : "The status reported by each node in the cluster. If the NiFi instance is a standalone instance, rather than a clustered instance, this value may be null.", - "items" : { - "$ref" : "#/definitions/NodeProcessGroupStatusSnapshotDTO" - } - } - } - }, - "ProcessGroupStatusEntity" : { - "type" : "object", - "properties" : { - "processGroupStatus" : { - "$ref" : "#/definitions/ProcessGroupStatusDTO" - }, - "canRead" : { - "type" : "boolean", - "description" : "Indicates whether the user can read a given resource." - } - }, - "xml" : { - "name" : "processGroupStatusEntity" - } - }, - "ProcessGroupStatusSnapshotDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the process group." - }, - "name" : { - "type" : "string", - "description" : "The name of this process group." - }, - "connectionStatusSnapshots" : { - "type" : "array", - "description" : "The status of all connections in the process group.", - "items" : { - "$ref" : "#/definitions/ConnectionStatusSnapshotEntity" - } - }, - "processorStatusSnapshots" : { - "type" : "array", - "description" : "The status of all processors in the process group.", - "items" : { - "$ref" : "#/definitions/ProcessorStatusSnapshotEntity" - } - }, - "processGroupStatusSnapshots" : { - "type" : "array", - "description" : "The status of all process groups in the process group.", - "items" : { - "$ref" : "#/definitions/ProcessGroupStatusSnapshotEntity" - } - }, - "remoteProcessGroupStatusSnapshots" : { - "type" : "array", - "description" : "The status of all remote process groups in the process group.", - "items" : { - "$ref" : "#/definitions/RemoteProcessGroupStatusSnapshotEntity" - } - }, - "inputPortStatusSnapshots" : { - "type" : "array", - "description" : "The status of all input ports in the process group.", - "items" : { - "$ref" : "#/definitions/PortStatusSnapshotEntity" - } - }, - "outputPortStatusSnapshots" : { - "type" : "array", - "description" : "The status of all output ports in the process group.", - "items" : { - "$ref" : "#/definitions/PortStatusSnapshotEntity" - } - }, - "versionedFlowState" : { - "type" : "string", - "description" : "The current state of the Process Group, as it relates to the Versioned Flow", - "enum" : [ "LOCALLY_MODIFIED", "STALE", "LOCALLY_MODIFIED_AND_STALE", "UP_TO_DATE", "SYNC_FAILURE" ] - }, - "flowFilesIn" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of FlowFiles that have come into this ProcessGroup in the last 5 minutes" - }, - "bytesIn" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes that have come into this ProcessGroup in the last 5 minutes" - }, - "input" : { - "type" : "string", - "description" : "The input count/size for the process group in the last 5 minutes (pretty printed)." - }, - "flowFilesQueued" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of FlowFiles that are queued up in this ProcessGroup right now" - }, - "bytesQueued" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes that are queued up in this ProcessGroup right now" - }, - "queued" : { - "type" : "string", - "description" : "The count/size that is queued in the the process group." - }, - "queuedCount" : { - "type" : "string", - "description" : "The count that is queued for the process group." - }, - "queuedSize" : { - "type" : "string", - "description" : "The size that is queued for the process group." - }, - "bytesRead" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes read by components in this ProcessGroup in the last 5 minutes" - }, - "read" : { - "type" : "string", - "description" : "The number of bytes read in the last 5 minutes." - }, - "bytesWritten" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes written by components in this ProcessGroup in the last 5 minutes" - }, - "written" : { - "type" : "string", - "description" : "The number of bytes written in the last 5 minutes." - }, - "flowFilesOut" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of FlowFiles transferred out of this ProcessGroup in the last 5 minutes" - }, - "bytesOut" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes transferred out of this ProcessGroup in the last 5 minutes" - }, - "output" : { - "type" : "string", - "description" : "The output count/size for the process group in the last 5 minutes." - }, - "flowFilesTransferred" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of FlowFiles transferred in this ProcessGroup in the last 5 minutes" - }, - "bytesTransferred" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes transferred in this ProcessGroup in the last 5 minutes" - }, - "transferred" : { - "type" : "string", - "description" : "The count/size transferred to/from queues in the process group in the last 5 minutes." - }, - "bytesReceived" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes received from external sources by components within this ProcessGroup in the last 5 minutes" - }, - "flowFilesReceived" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of FlowFiles received from external sources by components within this ProcessGroup in the last 5 minutes" - }, - "received" : { - "type" : "string", - "description" : "The count/size sent to the process group in the last 5 minutes." - }, - "bytesSent" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes sent to an external sink by components within this ProcessGroup in the last 5 minutes" - }, - "flowFilesSent" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of FlowFiles sent to an external sink by components within this ProcessGroup in the last 5 minutes" - }, - "sent" : { - "type" : "string", - "description" : "The count/size sent from this process group in the last 5 minutes." - }, - "activeThreadCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The active thread count for this process group." - }, - "terminatedThreadCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of threads currently terminated for the process group." - } - } - }, - "ProcessGroupStatusSnapshotEntity" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the process group." - }, - "processGroupStatusSnapshot" : { - "$ref" : "#/definitions/ProcessGroupStatusSnapshotDTO" - }, - "canRead" : { - "type" : "boolean", - "description" : "Indicates whether the user can read a given resource." - } - }, - "xml" : { - "name" : "entity" - } - }, - "ProcessGroupsEntity" : { - "type" : "object", - "properties" : { - "processGroups" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ProcessGroupEntity" - } - } - }, - "xml" : { - "name" : "processGroupsEntity" - } - }, - "ProcessorConfigDTO" : { - "type" : "object", - "properties" : { - "properties" : { - "type" : "object", - "description" : "The properties for the processor. Properties whose value is not set will only contain the property name.", - "additionalProperties" : { - "type" : "string" - } - }, - "descriptors" : { - "type" : "object", - "description" : "Descriptors for the processor's properties.", - "additionalProperties" : { - "$ref" : "#/definitions/PropertyDescriptorDTO" - } - }, - "sensitiveDynamicPropertyNames" : { - "type" : "array", - "description" : "Set of sensitive dynamic property names", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - }, - "schedulingPeriod" : { - "type" : "string", - "description" : "The frequency with which to schedule the processor. The format of the value will depend on th value of schedulingStrategy." - }, - "schedulingStrategy" : { - "type" : "string", - "description" : "Indcates whether the prcessor should be scheduled to run in event or timer driven mode." - }, - "executionNode" : { - "type" : "string", - "description" : "Indicates the node where the process will execute." - }, - "penaltyDuration" : { - "type" : "string", - "description" : "The amount of time that is used when the process penalizes a flowfile." - }, - "yieldDuration" : { - "type" : "string", - "description" : "The amount of time that must elapse before this processor is scheduled again after yielding." - }, - "bulletinLevel" : { - "type" : "string", - "description" : "The level at which the processor will report bulletins." - }, - "runDurationMillis" : { - "type" : "integer", - "format" : "int64", - "description" : "The run duration for the processor in milliseconds." - }, - "concurrentlySchedulableTaskCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of tasks that should be concurrently schedule for the processor. If the processor doesn't allow parallol processing then any positive input will be ignored." - }, - "autoTerminatedRelationships" : { - "type" : "array", - "description" : "The names of all relationships that cause a flow file to be terminated if the relationship is not connected elsewhere. This property differs from the 'isAutoTerminate' property of the RelationshipDTO in that the RelationshipDTO is meant to depict the current configuration, whereas this property can be set in a DTO when updating a Processor in order to change which Relationships should be auto-terminated.", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - }, - "comments" : { - "type" : "string", - "description" : "The comments for the processor." - }, - "customUiUrl" : { - "type" : "string", - "description" : "The URL for the processor's custom configuration UI if applicable." - }, - "lossTolerant" : { - "type" : "boolean", - "description" : "Whether the processor is loss tolerant." - }, - "annotationData" : { - "type" : "string", - "description" : "The annotation data for the processor used to relay configuration between a custom UI and the procesosr." - }, - "defaultConcurrentTasks" : { - "type" : "object", - "description" : "Maps default values for concurrent tasks for each applicable scheduling strategy.", - "additionalProperties" : { - "type" : "string" - } - }, - "defaultSchedulingPeriod" : { - "type" : "object", - "description" : "Maps default values for scheduling period for each applicable scheduling strategy.", - "additionalProperties" : { - "type" : "string" - } - }, - "retryCount" : { - "type" : "integer", - "format" : "int32", - "description" : "Overall number of retries." - }, - "retriedRelationships" : { - "type" : "array", - "description" : "All the relationships should be retried.", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - }, - "backoffMechanism" : { - "type" : "string", - "description" : "Determines whether the FlowFile should be penalized or the processor should be yielded between retries.", - "enum" : [ "PENALIZE_FLOWFILE", "YIELD_PROCESSOR" ] - }, - "maxBackoffPeriod" : { - "type" : "string", - "description" : "Maximum amount of time to be waited during a retry period." - } - } - }, - "ProcessorDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "versionedComponentId" : { - "type" : "string", - "description" : "The ID of the corresponding component that is under version control" - }, - "parentGroupId" : { - "type" : "string", - "description" : "The id of parent process group of this component if applicable." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "name" : { - "type" : "string", - "description" : "The name of the processor." - }, - "type" : { - "type" : "string", - "description" : "The type of the processor." - }, - "bundle" : { - "description" : "The details of the artifact that bundled this processor type.", - "$ref" : "#/definitions/BundleDTO" - }, - "state" : { - "type" : "string", - "description" : "The state of the processor", - "enum" : [ "RUNNING", "STOPPED", "DISABLED" ] - }, - "style" : { - "type" : "object", - "description" : "Styles for the processor (background-color : #eee).", - "additionalProperties" : { - "type" : "string" - } - }, - "relationships" : { - "type" : "array", - "description" : "The available relationships that the processor currently supports.", - "items" : { - "$ref" : "#/definitions/RelationshipDTO" - } - }, - "description" : { - "type" : "string", - "description" : "The description of the processor." - }, - "supportsParallelProcessing" : { - "type" : "boolean", - "description" : "Whether the processor supports parallel processing." - }, - "supportsEventDriven" : { - "type" : "boolean", - "description" : "Whether the processor supports event driven scheduling." - }, - "supportsBatching" : { - "type" : "boolean", - "description" : "Whether the processor supports batching. This makes the run duration settings available." - }, - "supportsSensitiveDynamicProperties" : { - "type" : "boolean", - "description" : "Whether the processor supports sensitive dynamic properties." - }, - "persistsState" : { - "type" : "boolean", - "description" : "Whether the processor persists state." - }, - "restricted" : { - "type" : "boolean", - "description" : "Whether the processor requires elevated privileges." - }, - "deprecated" : { - "type" : "boolean", - "description" : "Whether the processor has been deprecated." - }, - "executionNodeRestricted" : { - "type" : "boolean", - "description" : "Indicates if the execution node of a processor is restricted to run only on the primary node" - }, - "multipleVersionsAvailable" : { - "type" : "boolean", - "description" : "Whether the processor has multiple versions available." - }, - "inputRequirement" : { - "type" : "string", - "description" : "The input requirement for this processor." - }, - "config" : { - "description" : "The configuration details for the processor. These details will be included in a response if the verbose flag is included in a request.", - "$ref" : "#/definitions/ProcessorConfigDTO" - }, - "validationErrors" : { - "type" : "array", - "description" : "The validation errors for the processor. These validation errors represent the problems with the processor that must be resolved before it can be started.", - "items" : { - "type" : "string" - } - }, - "validationStatus" : { - "type" : "string", - "description" : "Indicates whether the Processor is valid, invalid, or still in the process of validating (i.e., it is unknown whether or not the Processor is valid)", - "enum" : [ "VALID", "INVALID", "VALIDATING" ] - }, - "extensionMissing" : { - "type" : "boolean", - "description" : "Whether the underlying extension is missing." - } - } - }, - "ProcessorDefinition" : { - "type" : "object", - "required" : [ "type" ], - "properties" : { - "group" : { - "type" : "string", - "description" : "The group name of the bundle that provides the referenced type." - }, - "artifact" : { - "type" : "string", - "description" : "The artifact name of the bundle that provides the referenced type." - }, - "version" : { - "type" : "string", - "description" : "The version 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." - }, - "buildInfo" : { - "description" : "The build metadata for this component", - "$ref" : "#/definitions/BuildInfo" - }, - "providedApiImplementations" : { - "type" : "array", - "description" : "If this type represents a provider for an interface, this lists the APIs it implements", - "items" : { - "$ref" : "#/definitions/DefinedType" - } - }, - "tags" : { - "type" : "array", - "description" : "The tags associated with this type", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - }, - "deprecated" : { - "type" : "boolean", - "description" : "Whether or not the component has been deprecated" - }, - "deprecationReason" : { - "type" : "string", - "description" : "If this component has been deprecated, this optional field can be used to provide an explanation" - }, - "restricted" : { - "type" : "boolean", - "description" : "Whether or not the component has a general restriction" - }, - "restrictedExplanation" : { - "type" : "string", - "description" : "An optional description of the general restriction" - }, - "explicitRestrictions" : { - "type" : "array", - "description" : "Explicit restrictions that indicate a require permission to use the component", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/Restriction" - } - }, - "stateful" : { - "$ref" : "#/definitions/Stateful" - }, - "propertyDescriptors" : { - "type" : "object", - "description" : "Descriptions of configuration properties applicable to this component.", - "additionalProperties" : { - "$ref" : "#/definitions/PropertyDescriptor" - } - }, - "supportsDynamicProperties" : { - "type" : "boolean", - "description" : "Whether or not this component makes use of dynamic (user-set) properties." - }, - "inputRequirement" : { - "type" : "string", - "description" : "Any input requirements this processor has.", - "enum" : [ "INPUT_REQUIRED", "INPUT_ALLOWED", "INPUT_FORBIDDEN" ] - }, - "supportedRelationships" : { - "type" : "array", - "description" : "The supported relationships for this processor.", - "items" : { - "$ref" : "#/definitions/Relationship" - } - }, - "supportsDynamicRelationships" : { - "type" : "boolean", - "description" : "Whether or not this processor supports dynamic relationships." - }, - "triggerSerially" : { - "type" : "boolean", - "description" : "Whether or not this processor should be triggered serially (i.e. no concurrent execution)." - }, - "triggerWhenEmpty" : { - "type" : "boolean", - "description" : "Whether or not this processor should be triggered when incoming queues are empty." - }, - "triggerWhenAnyDestinationAvailable" : { - "type" : "boolean", - "description" : "Whether or not this processor should be triggered when any destination queue has room." - }, - "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." - }, - "supportsEventDriven" : { - "type" : "boolean", - "description" : "Whether or not this processor supports event driven scheduling. Indicates to the framework that the Processor is eligible to be scheduled to run based on the occurrence of an \"Event\" (e.g., when a FlowFile is enqueued in an incoming Connection), rather than being triggered periodically." - }, - "primaryNodeOnly" : { - "type" : "boolean", - "description" : "Whether or not this processor should be scheduled only on the primary node in a cluster." - }, - "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." - }, - "supportedSchedulingStrategies" : { - "type" : "array", - "description" : "The supported scheduling strategies, such as TIME_DRIVER, CRON, or EVENT_DRIVEN.", - "items" : { - "type" : "string" - } - }, - "defaultSchedulingStrategy" : { - "type" : "string", - "description" : "The default scheduling strategy for the processor." - }, - "defaultConcurrentTasksBySchedulingStrategy" : { - "type" : "object", - "description" : "The default concurrent tasks for each scheduling strategy.", - "additionalProperties" : { - "type" : "integer", - "format" : "int32" - } - }, - "defaultSchedulingPeriodBySchedulingStrategy" : { - "type" : "object", - "description" : "The default scheduling period for each scheduling strategy. The scheduling period is expected to be a time period, such as \"30 sec\".", - "additionalProperties" : { - "type" : "string" - } - }, - "defaultPenaltyDuration" : { - "type" : "string", - "description" : "The default penalty duration as a time period, such as \"30 sec\"." - }, - "defaultYieldDuration" : { - "type" : "string", - "description" : "The default yield duration as a time period, such as \"1 sec\"." - }, - "defaultBulletinLevel" : { - "type" : "string", - "description" : "The default bulletin level, such as WARN, INFO, DEBUG, etc." - } - } - }, - "ProcessorDiagnosticsDTO" : { - "type" : "object", - "properties" : { - "processor" : { - "description" : "Information about the Processor for which the Diagnostic Report is generated", - "$ref" : "#/definitions/ProcessorDTO" - }, - "processorStatus" : { - "description" : "The Status for the Processor for which the Diagnostic Report is generated", - "$ref" : "#/definitions/ProcessorStatusDTO" - }, - "referencedControllerServices" : { - "type" : "array", - "description" : "Diagnostic Information about all Controller Services that the Processor is referencing", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ControllerServiceDiagnosticsDTO" - } - }, - "incomingConnections" : { - "type" : "array", - "description" : "Diagnostic Information about all incoming Connections", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ConnectionDiagnosticsDTO" - } - }, - "outgoingConnections" : { - "type" : "array", - "description" : "Diagnostic Information about all outgoing Connections", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ConnectionDiagnosticsDTO" - } - }, - "jvmDiagnostics" : { - "description" : "Diagnostic Information about the JVM and system-level diagnostics", - "$ref" : "#/definitions/JVMDiagnosticsDTO" - }, - "threadDumps" : { - "type" : "array", - "description" : "Thread Dumps that were taken of the threads that are active in the Processor", - "items" : { - "$ref" : "#/definitions/ThreadDumpDTO" - } - }, - "classLoaderDiagnostics" : { - "description" : "Information about the Controller Service's Class Loader", - "$ref" : "#/definitions/ClassLoaderDiagnosticsDTO" - } - } - }, - "ProcessorDiagnosticsEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "component" : { - "description" : "The Processor Diagnostics", - "$ref" : "#/definitions/ProcessorDiagnosticsDTO" - } - }, - "xml" : { - "name" : "processorDiagnosticsEntity" - } - }, - "ProcessorEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "component" : { - "$ref" : "#/definitions/ProcessorDTO" - }, - "inputRequirement" : { - "type" : "string", - "description" : "The input requirement for this processor." - }, - "status" : { - "$ref" : "#/definitions/ProcessorStatusDTO" - }, - "operatePermissions" : { - "description" : "The permissions for this component operations.", - "$ref" : "#/definitions/PermissionsDTO" - } - }, - "xml" : { - "name" : "processorEntity" - } - }, - "ProcessorRunStatusDetailsDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The ID of the processor" - }, - "name" : { - "type" : "string", - "description" : "The name of the processor" - }, - "runStatus" : { - "type" : "string", - "description" : "The run status of the processor", - "enum" : [ "Running", "Stopped", "Invalid", "Validating", "Disabled" ] - }, - "validationErrors" : { - "type" : "array", - "description" : "The processor's validation errors", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - }, - "activeThreadCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The current number of threads that the processor is currently using" - } - } - }, - "ProcessorRunStatusDetailsEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for the Processor.", - "$ref" : "#/definitions/RevisionDTO" - }, - "permissions" : { - "description" : "The permissions for the Processor.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "runStatusDetails" : { - "description" : "The details of a Processor's run status", - "$ref" : "#/definitions/ProcessorRunStatusDetailsDTO" - } - }, - "xml" : { - "name" : "entity" - } - }, - "ProcessorRunStatusEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "state" : { - "type" : "string", - "description" : "The run status of the Processor.", - "enum" : [ "RUNNING", "STOPPED", "DISABLED", "RUN_ONCE" ] - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - } - }, - "xml" : { - "name" : "entity" - } - }, - "ProcessorStatusDTO" : { - "type" : "object", - "properties" : { - "groupId" : { - "type" : "string", - "description" : "The unique ID of the process group that the Processor belongs to" - }, - "id" : { - "type" : "string", - "description" : "The unique ID of the Processor" - }, - "name" : { - "type" : "string", - "description" : "The name of the Processor" - }, - "type" : { - "type" : "string", - "description" : "The type of the Processor" - }, - "runStatus" : { - "type" : "string", - "description" : "The run status of the Processor", - "enum" : [ "Running", "Stopped", "Validating", "Disabled", "Invalid" ] - }, - "statsLastRefreshed" : { - "type" : "string", - "description" : "The timestamp of when the stats were last refreshed" - }, - "aggregateSnapshot" : { - "description" : "A status snapshot that represents the aggregate stats of all nodes in the cluster. If the NiFi instance is a standalone instance, rather than a cluster, this represents the stats of the single instance.", - "$ref" : "#/definitions/ProcessorStatusSnapshotDTO" - }, - "nodeSnapshots" : { - "type" : "array", - "description" : "A status snapshot for each node in the cluster. If the NiFi instance is a standalone instance, rather than a cluster, this may be null.", - "items" : { - "$ref" : "#/definitions/NodeProcessorStatusSnapshotDTO" - } - } - } - }, - "ProcessorStatusEntity" : { - "type" : "object", - "properties" : { - "processorStatus" : { - "$ref" : "#/definitions/ProcessorStatusDTO" - }, - "canRead" : { - "type" : "boolean", - "description" : "Indicates whether the user can read a given resource." - } - }, - "xml" : { - "name" : "processorStatusEntity" - } - }, - "ProcessorStatusSnapshotDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the processor." - }, - "groupId" : { - "type" : "string", - "description" : "The id of the parent process group to which the processor belongs." - }, - "name" : { - "type" : "string", - "description" : "The name of the prcessor." - }, - "type" : { - "type" : "string", - "description" : "The type of the processor." - }, - "runStatus" : { - "type" : "string", - "description" : "The state of the processor.", - "enum" : [ "Running", "Stopped", "Validating", "Disabled", "Invalid" ] - }, - "executionNode" : { - "type" : "string", - "description" : "Indicates the node where the process will execute.", - "enum" : [ "ALL", "PRIMARY" ] - }, - "bytesRead" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes read by this Processor in the last 5 mintues" - }, - "bytesWritten" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes written by this Processor in the last 5 minutes" - }, - "read" : { - "type" : "string", - "description" : "The number of bytes read in the last 5 minutes." - }, - "written" : { - "type" : "string", - "description" : "The number of bytes written in the last 5 minutes." - }, - "flowFilesIn" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of FlowFiles that have been accepted in the last 5 minutes" - }, - "bytesIn" : { - "type" : "integer", - "format" : "int64", - "description" : "The size of the FlowFiles that have been accepted in the last 5 minutes" - }, - "input" : { - "type" : "string", - "description" : "The count/size of flowfiles that have been accepted in the last 5 minutes." - }, - "flowFilesOut" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of FlowFiles transferred to a Connection in the last 5 minutes" - }, - "bytesOut" : { - "type" : "integer", - "format" : "int64", - "description" : "The size of the FlowFiles transferred to a Connection in the last 5 minutes" - }, - "output" : { - "type" : "string", - "description" : "The count/size of flowfiles that have been processed in the last 5 minutes." - }, - "taskCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of times this Processor has run in the last 5 minutes" - }, - "tasksDurationNanos" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of nanoseconds that this Processor has spent running in the last 5 minutes" - }, - "tasks" : { - "type" : "string", - "description" : "The total number of task this connectable has completed over the last 5 minutes." - }, - "tasksDuration" : { - "type" : "string", - "description" : "The total duration of all tasks for this connectable over the last 5 minutes." - }, - "activeThreadCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of threads currently executing in the processor." - }, - "terminatedThreadCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of threads currently terminated for the processor." - } - } - }, - "ProcessorStatusSnapshotEntity" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the processor." - }, - "processorStatusSnapshot" : { - "$ref" : "#/definitions/ProcessorStatusSnapshotDTO" - }, - "canRead" : { - "type" : "boolean", - "description" : "Indicates whether the user can read a given resource." - } - }, - "xml" : { - "name" : "entity" - } - }, - "ProcessorTypesEntity" : { - "type" : "object", - "properties" : { - "processorTypes" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/DocumentedTypeDTO" - } - } - }, - "xml" : { - "name" : "processorTypesEntity" - } - }, - "ProcessorsEntity" : { - "type" : "object", - "properties" : { - "processors" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ProcessorEntity" - } - } - }, - "xml" : { - "name" : "processorsEntity" - } - }, - "ProcessorsRunStatusDetailsEntity" : { - "type" : "object", - "properties" : { - "runStatusDetails" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/ProcessorRunStatusDetailsEntity" - } - } - }, - "xml" : { - "name" : "processorsRunStatusDetails" - } - }, - "PropertyAllowableValue" : { - "type" : "object", - "required" : [ "value" ], - "properties" : { - "value" : { - "type" : "string", - "description" : "The internal value" - }, - "displayName" : { - "type" : "string", - "description" : "The display name of the value, if different from the internal value" - }, - "description" : { - "type" : "string", - "description" : "The description of the value, e.g., the behavior it produces." - } - } - }, - "PropertyDependency" : { - "type" : "object", - "properties" : { - "propertyName" : { - "type" : "string", - "description" : "The name of the property that is depended upon" - }, - "propertyDisplayName" : { - "type" : "string", - "description" : "The name of the property that is depended upon" - }, - "dependentValues" : { - "type" : "array", - "description" : "The values that satisfy the dependency", - "items" : { - "type" : "string" - } - } - } - }, - "PropertyDependencyDTO" : { - "type" : "object", - "properties" : { - "propertyName" : { - "type" : "string", - "description" : "The name of the property that is being depended upon" - }, - "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", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - } - } - }, - "PropertyDescriptor" : { - "type" : "object", - "required" : [ "name" ], - "properties" : { - "name" : { - "type" : "string", - "description" : "The name of the property key" - }, - "displayName" : { - "type" : "string", - "description" : "The display name of the property key, if different from the name" - }, - "description" : { - "type" : "string", - "description" : "The description of what the property does" - }, - "allowableValues" : { - "type" : "array", - "description" : "A list of the allowable values for the property", - "items" : { - "$ref" : "#/definitions/PropertyAllowableValue" - } - }, - "defaultValue" : { - "type" : "string", - "description" : "The default value if a user-set value is not specified" - }, - "required" : { - "type" : "boolean", - "description" : "Whether or not the property is required for the component" - }, - "sensitive" : { - "type" : "boolean", - "description" : "Whether or not the value of the property is considered sensitive (e.g., passwords and keys)" - }, - "expressionLanguageScope" : { - "type" : "string", - "description" : "The scope of expression language supported by this property", - "enum" : [ "NONE", "VARIABLE_REGISTRY", "FLOWFILE_ATTRIBUTES" ] - }, - "expressionLanguageScopeDescription" : { - "type" : "string", - "description" : "The description of the expression language scope supported by this property", - "readOnly" : true - }, - "typeProvidedByValue" : { - "description" : "Indicates that this property is for selecting a controller service of the specified type", - "$ref" : "#/definitions/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" - }, - "dynamic" : { - "type" : "boolean", - "description" : "Whether or not the descriptor is for a dynamically added property" - }, - "resourceDefinition" : { - "description" : "Indicates that this property references external resources", - "$ref" : "#/definitions/PropertyResourceDefinition" - }, - "dependencies" : { - "type" : "array", - "description" : "The dependencies that this property has on other properties", - "items" : { - "$ref" : "#/definitions/PropertyDependency" - } - } - } - }, - "PropertyDescriptorDTO" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The name for the property." - }, - "displayName" : { - "type" : "string", - "description" : "The human readable name for the property." - }, - "description" : { - "type" : "string", - "description" : "The description for the property. Used to relay additional details to a user or provide a mechanism of documenting intent." - }, - "defaultValue" : { - "type" : "string", - "description" : "The default value for the property." - }, - "allowableValues" : { - "type" : "array", - "description" : "Allowable values for the property. If empty then the allowed values are not constrained.", - "items" : { - "$ref" : "#/definitions/AllowableValueEntity" - } - }, - "required" : { - "type" : "boolean", - "description" : "Whether the property is required." - }, - "sensitive" : { - "type" : "boolean", - "description" : "Whether the property is sensitive and protected whenever stored or represented." - }, - "dynamic" : { - "type" : "boolean", - "description" : "Whether the property is dynamic (user-defined)." - }, - "supportsEl" : { - "type" : "boolean", - "description" : "Whether the property supports expression language." - }, - "expressionLanguageScope" : { - "type" : "string", - "description" : "Scope of the Expression Language evaluation for the property." - }, - "identifiesControllerService" : { - "type" : "string", - "description" : "If the property identifies a controller service this returns the fully qualified type." - }, - "identifiesControllerServiceBundle" : { - "description" : "If the property identifies a controller service this returns the bundle of the type, null otherwise.", - "$ref" : "#/definitions/BundleDTO" - }, - "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" : "#/definitions/PropertyDependencyDTO" - } - } - } - }, - "PropertyDescriptorEntity" : { - "type" : "object", - "properties" : { - "propertyDescriptor" : { - "$ref" : "#/definitions/PropertyDescriptorDTO" - } - }, - "xml" : { - "name" : "propertyDescriptor" - } - }, - "PropertyHistoryDTO" : { - "type" : "object", - "properties" : { - "previousValues" : { - "type" : "array", - "description" : "Previous values for a given property.", - "items" : { - "$ref" : "#/definitions/PreviousValueDTO" - } - } - } - }, - "PropertyResourceDefinition" : { - "type" : "object", - "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", - "uniqueItems" : true, - "items" : { - "type" : "string", - "enum" : [ "FILE", "DIRECTORY", "TEXT", "URL" ] - } - } - } - }, - "ProvenanceDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the provenance query." - }, - "uri" : { - "type" : "string", - "description" : "The URI for this query. Used for obtaining/deleting the request at a later time" - }, - "submissionTime" : { - "type" : "string", - "description" : "The timestamp when the query was submitted." - }, - "expiration" : { - "type" : "string", - "description" : "The timestamp when the query will expire." - }, - "percentCompleted" : { - "type" : "integer", - "format" : "int32", - "description" : "The current percent complete." - }, - "finished" : { - "type" : "boolean", - "description" : "Whether the query has finished." - }, - "request" : { - "description" : "The provenance request.", - "$ref" : "#/definitions/ProvenanceRequestDTO" - }, - "results" : { - "description" : "The provenance results.", - "$ref" : "#/definitions/ProvenanceResultsDTO" - } - } - }, - "ProvenanceEntity" : { - "type" : "object", - "properties" : { - "provenance" : { - "$ref" : "#/definitions/ProvenanceDTO" - } - }, - "xml" : { - "name" : "provenanceEntity" - } - }, - "ProvenanceEventDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The event uuid." - }, - "eventId" : { - "type" : "integer", - "format" : "int64", - "description" : "The event id. This is a one up number thats unique per node." - }, - "eventTime" : { - "type" : "string", - "description" : "The timestamp of the event." - }, - "eventDuration" : { - "type" : "integer", - "format" : "int64", - "description" : "The event duration in milliseconds." - }, - "lineageDuration" : { - "type" : "integer", - "format" : "int64", - "description" : "The duration since the lineage began, in milliseconds." - }, - "eventType" : { - "type" : "string", - "description" : "The type of the event." - }, - "flowFileUuid" : { - "type" : "string", - "description" : "The uuid of the flowfile for the event." - }, - "fileSize" : { - "type" : "string", - "description" : "The size of the flowfile for the event." - }, - "fileSizeBytes" : { - "type" : "integer", - "format" : "int64", - "description" : "The size of the flowfile in bytes for the event." - }, - "clusterNodeId" : { - "type" : "string", - "description" : "The identifier for the node where the event originated." - }, - "clusterNodeAddress" : { - "type" : "string", - "description" : "The label for the node where the event originated." - }, - "groupId" : { - "type" : "string", - "description" : "The id of the group that the component resides in. If the component is no longer in the flow, the group id will not be set." - }, - "componentId" : { - "type" : "string", - "description" : "The id of the component that generated the event." - }, - "componentType" : { - "type" : "string", - "description" : "The type of the component that generated the event." - }, - "componentName" : { - "type" : "string", - "description" : "The name of the component that generated the event." - }, - "sourceSystemFlowFileId" : { - "type" : "string", - "description" : "The source system flowfile id." - }, - "alternateIdentifierUri" : { - "type" : "string", - "description" : "The alternate identifier uri for the fileflow for the event." - }, - "attributes" : { - "type" : "array", - "description" : "The attributes of the flowfile for the event.", - "items" : { - "$ref" : "#/definitions/AttributeDTO" - } - }, - "parentUuids" : { - "type" : "array", - "description" : "The parent uuids for the event.", - "items" : { - "type" : "string" - } - }, - "childUuids" : { - "type" : "array", - "description" : "The child uuids for the event.", - "items" : { - "type" : "string" - } - }, - "transitUri" : { - "type" : "string", - "description" : "The source/destination system uri if the event was a RECEIVE/SEND." - }, - "relationship" : { - "type" : "string", - "description" : "The relationship to which the flowfile was routed if the event is of type ROUTE." - }, - "details" : { - "type" : "string", - "description" : "The event details." - }, - "contentEqual" : { - "type" : "boolean", - "description" : "Whether the input and output content claim is the same." - }, - "inputContentAvailable" : { - "type" : "boolean", - "description" : "Whether the input content is still available." - }, - "inputContentClaimSection" : { - "type" : "string", - "description" : "The section in which the input content claim lives." - }, - "inputContentClaimContainer" : { - "type" : "string", - "description" : "The container in which the input content claim lives." - }, - "inputContentClaimIdentifier" : { - "type" : "string", - "description" : "The identifier of the input content claim." - }, - "inputContentClaimOffset" : { - "type" : "integer", - "format" : "int64", - "description" : "The offset into the input content claim where the flowfiles content begins." - }, - "inputContentClaimFileSize" : { - "type" : "string", - "description" : "The file size of the input content claim formatted." - }, - "inputContentClaimFileSizeBytes" : { - "type" : "integer", - "format" : "int64", - "description" : "The file size of the intput content claim in bytes." - }, - "outputContentAvailable" : { - "type" : "boolean", - "description" : "Whether the output content is still available." - }, - "outputContentClaimSection" : { - "type" : "string", - "description" : "The section in which the output content claim lives." - }, - "outputContentClaimContainer" : { - "type" : "string", - "description" : "The container in which the output content claim lives." - }, - "outputContentClaimIdentifier" : { - "type" : "string", - "description" : "The identifier of the output content claim." - }, - "outputContentClaimOffset" : { - "type" : "integer", - "format" : "int64", - "description" : "The offset into the output content claim where the flowfiles content begins." - }, - "outputContentClaimFileSize" : { - "type" : "string", - "description" : "The file size of the output content claim formatted." - }, - "outputContentClaimFileSizeBytes" : { - "type" : "integer", - "format" : "int64", - "description" : "The file size of the output content claim in bytes." - }, - "replayAvailable" : { - "type" : "boolean", - "description" : "Whether or not replay is available." - }, - "replayExplanation" : { - "type" : "string", - "description" : "Explanation as to why replay is unavailable." - }, - "sourceConnectionIdentifier" : { - "type" : "string", - "description" : "The identifier of the queue/connection from which the flowfile was pulled to genereate this event. May be null if the queue/connection is unknown or the flowfile was generated from this event." - } - } - }, - "ProvenanceEventEntity" : { - "type" : "object", - "properties" : { - "provenanceEvent" : { - "$ref" : "#/definitions/ProvenanceEventDTO" - } - }, - "xml" : { - "name" : "provenanceEventEntity" - } - }, - "ProvenanceLinkDTO" : { - "type" : "object", - "properties" : { - "sourceId" : { - "type" : "string", - "description" : "The source node id of the link." - }, - "targetId" : { - "type" : "string", - "description" : "The target node id of the link." - }, - "flowFileUuid" : { - "type" : "string", - "description" : "The flowfile uuid that traversed the link." - }, - "timestamp" : { - "type" : "string", - "description" : "The timestamp of the link (based on the destination)." - }, - "millis" : { - "type" : "integer", - "format" : "int64", - "description" : "The timestamp of this link in milliseconds." - } - } - }, - "ProvenanceNodeDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the node." - }, - "flowFileUuid" : { - "type" : "string", - "description" : "The uuid of the flowfile associated with the provenance event." - }, - "parentUuids" : { - "type" : "array", - "description" : "The uuid of the parent flowfiles of the provenance event.", - "items" : { - "type" : "string" - } - }, - "childUuids" : { - "type" : "array", - "description" : "The uuid of the childrent flowfiles of the provenance event.", - "items" : { - "type" : "string" - } - }, - "clusterNodeIdentifier" : { - "type" : "string", - "description" : "The identifier of the node that this event/flowfile originated from." - }, - "type" : { - "type" : "string", - "description" : "The type of the node.", - "enum" : [ "FLOWFILE", "EVENT" ] - }, - "eventType" : { - "type" : "string", - "description" : "If the type is EVENT, this is the type of event." - }, - "millis" : { - "type" : "integer", - "format" : "int64", - "description" : "The timestamp of the node in milliseconds." - }, - "timestamp" : { - "type" : "string", - "description" : "The timestamp of the node formatted." - } - } - }, - "ProvenanceOptionsDTO" : { - "type" : "object", - "properties" : { - "searchableFields" : { - "type" : "array", - "description" : "The available searchable field for the NiFi.", - "items" : { - "$ref" : "#/definitions/ProvenanceSearchableFieldDTO" - } - } - } - }, - "ProvenanceOptionsEntity" : { - "type" : "object", - "properties" : { - "provenanceOptions" : { - "$ref" : "#/definitions/ProvenanceOptionsDTO" - } - }, - "xml" : { - "name" : "provenanceOptionsEntity" - } - }, - "ProvenanceRequestDTO" : { - "type" : "object", - "properties" : { - "searchTerms" : { - "type" : "object", - "description" : "The search terms used to perform the search.", - "additionalProperties" : { - "$ref" : "#/definitions/ProvenanceSearchValueDTO" - } - }, - "clusterNodeId" : { - "type" : "string", - "description" : "The id of the node in the cluster where this provenance originated." - }, - "startDate" : { - "type" : "string", - "description" : "The earliest event time to include in the query." - }, - "endDate" : { - "type" : "string", - "description" : "The latest event time to include in the query." - }, - "minimumFileSize" : { - "type" : "string", - "description" : "The minimum file size to include in the query." - }, - "maximumFileSize" : { - "type" : "string", - "description" : "The maximum file size to include in the query." - }, - "maxResults" : { - "type" : "integer", - "format" : "int32", - "description" : "The maximum number of results to include." - }, - "summarize" : { - "type" : "boolean", - "description" : "Whether or not to summarize provenance events returned. This property is false by default." - }, - "incrementalResults" : { - "type" : "boolean", - "description" : "Whether or not incremental results are returned. If false, provenance events are only returned once the query completes. This property is true by default." - } - } - }, - "ProvenanceResultsDTO" : { - "type" : "object", - "properties" : { - "provenanceEvents" : { - "type" : "array", - "description" : "The provenance events that matched the search criteria.", - "items" : { - "$ref" : "#/definitions/ProvenanceEventDTO" - } - }, - "total" : { - "type" : "string", - "description" : "The total number of results formatted." - }, - "totalCount" : { - "type" : "integer", - "format" : "int64", - "description" : "The total number of results." - }, - "generated" : { - "type" : "string", - "description" : "Then the search was performed." - }, - "oldestEvent" : { - "type" : "string", - "description" : "The oldest event available in the provenance repository." - }, - "timeOffset" : { - "type" : "integer", - "format" : "int32", - "description" : "The time offset of the server that's used for event time." - }, - "errors" : { - "type" : "array", - "description" : "Any errors that occurred while performing the provenance request.", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - } - } - }, - "ProvenanceSearchValueDTO" : { - "type" : "object", - "properties" : { - "value" : { - "type" : "string", - "description" : "The search value." - }, - "inverse" : { - "type" : "boolean", - "description" : "Query for all except for search value." - } - } - }, - "ProvenanceSearchableFieldDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the searchable field." - }, - "field" : { - "type" : "string", - "description" : "The searchable field." - }, - "label" : { - "type" : "string", - "description" : "The label for the searchable field." - }, - "type" : { - "type" : "string", - "description" : "The type of the searchable field." - } - } - }, - "QueueSizeDTO" : { - "type" : "object", - "properties" : { - "byteCount" : { - "type" : "integer", - "format" : "int64", - "description" : "The size of objects in a queue." - }, - "objectCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The count of objects in a queue." - } - } - }, - "RegisteredFlow" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string" - }, - "name" : { - "type" : "string" - }, - "description" : { - "type" : "string" - }, - "bucketIdentifier" : { - "type" : "string" - }, - "bucketName" : { - "type" : "string" - }, - "createdTimestamp" : { - "type" : "integer", - "format" : "int64" - }, - "lastModifiedTimestamp" : { - "type" : "integer", - "format" : "int64" - }, - "permissions" : { - "$ref" : "#/definitions/FlowRegistryPermissions" - }, - "versionCount" : { - "type" : "integer", - "format" : "int64" - }, - "versionInfo" : { - "$ref" : "#/definitions/RegisteredFlowVersionInfo" - } - } - }, - "RegisteredFlowSnapshot" : { - "type" : "object", - "properties" : { - "snapshotMetadata" : { - "$ref" : "#/definitions/RegisteredFlowSnapshotMetadata" - }, - "flow" : { - "$ref" : "#/definitions/RegisteredFlow" - }, - "bucket" : { - "$ref" : "#/definitions/FlowRegistryBucket" - }, - "flowContents" : { - "$ref" : "#/definitions/VersionedProcessGroup" - }, - "externalControllerServices" : { - "type" : "object", - "additionalProperties" : { - "$ref" : "#/definitions/ExternalControllerServiceReference" - } - }, - "parameterContexts" : { - "type" : "object", - "additionalProperties" : { - "$ref" : "#/definitions/VersionedParameterContext" - } - }, - "flowEncodingVersion" : { - "type" : "string" - }, - "parameterProviders" : { - "type" : "object", - "additionalProperties" : { - "$ref" : "#/definitions/ParameterProviderReference" - } - }, - "latest" : { - "type" : "boolean" - } - } - }, - "RegisteredFlowSnapshotMetadata" : { - "type" : "object", - "properties" : { - "bucketIdentifier" : { - "type" : "string" - }, - "flowIdentifier" : { - "type" : "string" - }, - "version" : { - "type" : "integer", - "format" : "int32" - }, - "timestamp" : { - "type" : "integer", - "format" : "int64" - }, - "author" : { - "type" : "string" - }, - "comments" : { - "type" : "string" - } - } - }, - "RegisteredFlowVersionInfo" : { - "type" : "object", - "properties" : { - "version" : { - "type" : "integer", - "format" : "int64" - } - } - }, - "Relationship" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The name of the relationship" - }, - "description" : { - "type" : "string", - "description" : "The description of the relationship" - } - } - }, - "RelationshipDTO" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The relationship name." - }, - "description" : { - "type" : "string", - "description" : "The relationship description." - }, - "autoTerminate" : { - "type" : "boolean", - "description" : "Whether or not flowfiles sent to this relationship should auto terminate." - }, - "retry" : { - "type" : "boolean", - "description" : "Whether or not flowfiles sent to this relationship should retry." - } - } - }, - "RemotePortRunStatusEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "state" : { - "type" : "string", - "description" : "The run status of the RemotePort.", - "enum" : [ "TRANSMITTING", "STOPPED" ] - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - } - }, - "xml" : { - "name" : "entity" - } - }, - "RemoteProcessGroupContentsDTO" : { - "type" : "object", - "properties" : { - "inputPorts" : { - "type" : "array", - "description" : "The input ports to which data can be sent.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/RemoteProcessGroupPortDTO" - } - }, - "outputPorts" : { - "type" : "array", - "description" : "The output ports from which data can be retrieved.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/RemoteProcessGroupPortDTO" - } - } - } - }, - "RemoteProcessGroupDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "versionedComponentId" : { - "type" : "string", - "description" : "The ID of the corresponding component that is under version control" - }, - "parentGroupId" : { - "type" : "string", - "description" : "The id of parent process group of this component if applicable." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "targetUri" : { - "type" : "string", - "description" : "The target URI of the remote process group. If target uri is not set, but uris are set, then returns the first url in the urls. If neither target uri nor uris are set, then returns null." - }, - "targetUris" : { - "type" : "string", - "description" : "The target URI of the remote process group. If target uris is not set but target uri is set, then returns a collection containing the single target uri. If neither target uris nor uris are set, then returns null." - }, - "targetSecure" : { - "type" : "boolean", - "description" : "Whether the target is running securely." - }, - "name" : { - "type" : "string", - "description" : "The name of the remote process group." - }, - "comments" : { - "type" : "string", - "description" : "The comments for the remote process group." - }, - "communicationsTimeout" : { - "type" : "string", - "description" : "The time period used for the timeout when communicating with the target." - }, - "yieldDuration" : { - "type" : "string", - "description" : "When yielding, this amount of time must elapse before the remote process group is scheduled again." - }, - "transportProtocol" : { - "type" : "string" - }, - "localNetworkInterface" : { - "type" : "string", - "description" : "The local network interface to send/receive data. If not specified, any local address is used. If clustered, all nodes must have an interface with this identifier." - }, - "proxyHost" : { - "type" : "string" - }, - "proxyPort" : { - "type" : "integer", - "format" : "int32" - }, - "proxyUser" : { - "type" : "string" - }, - "proxyPassword" : { - "type" : "string" - }, - "authorizationIssues" : { - "type" : "array", - "description" : "Any remote authorization issues for the remote process group.", - "items" : { - "type" : "string" - } - }, - "validationErrors" : { - "type" : "array", - "description" : "The validation errors for the remote process group. These validation errors represent the problems with the remote process group that must be resolved before it can transmit.", - "items" : { - "type" : "string" - } - }, - "transmitting" : { - "type" : "boolean", - "description" : "Whether the remote process group is actively transmitting." - }, - "inputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of remote input ports currently available on the target." - }, - "outputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of remote output ports currently available on the target." - }, - "activeRemoteInputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of active remote input ports." - }, - "inactiveRemoteInputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of inactive remote input ports." - }, - "activeRemoteOutputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of active remote output ports." - }, - "inactiveRemoteOutputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of inactive remote output ports." - }, - "flowRefreshed" : { - "type" : "string", - "description" : "The timestamp when this remote process group was last refreshed." - }, - "contents" : { - "description" : "The contents of the remote process group. Will contain available input/output ports.", - "$ref" : "#/definitions/RemoteProcessGroupContentsDTO" - } - } - }, - "RemoteProcessGroupEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "component" : { - "$ref" : "#/definitions/RemoteProcessGroupDTO" - }, - "status" : { - "description" : "The status of the remote process group.", - "$ref" : "#/definitions/RemoteProcessGroupStatusDTO" - }, - "inputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of remote input ports currently available on the target." - }, - "outputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of remote output ports currently available on the target." - }, - "operatePermissions" : { - "description" : "The permissions for this component operations.", - "$ref" : "#/definitions/PermissionsDTO" - } - }, - "xml" : { - "name" : "remoteProcessGroupEntity" - } - }, - "RemoteProcessGroupPortDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the port." - }, - "targetId" : { - "type" : "string", - "description" : "The id of the target port." - }, - "versionedComponentId" : { - "type" : "string", - "description" : "The ID of the corresponding component that is under version control" - }, - "groupId" : { - "type" : "string", - "description" : "The id of the remote process group that the port resides in." - }, - "name" : { - "type" : "string", - "description" : "The name of the target port." - }, - "comments" : { - "type" : "string", - "description" : "The comments as configured on the target port." - }, - "concurrentlySchedulableTaskCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of task that may transmit flowfiles to the target port concurrently." - }, - "transmitting" : { - "type" : "boolean", - "description" : "Whether the remote port is configured for transmission." - }, - "useCompression" : { - "type" : "boolean", - "description" : "Whether the flowfiles are compressed when sent to the target port." - }, - "exists" : { - "type" : "boolean", - "description" : "Whether the target port exists." - }, - "targetRunning" : { - "type" : "boolean", - "description" : "Whether the target port is running." - }, - "connected" : { - "type" : "boolean", - "description" : "Whether the port has either an incoming or outgoing connection." - }, - "batchSettings" : { - "description" : "The batch settings for data transmission.", - "$ref" : "#/definitions/BatchSettingsDTO" - } - } - }, - "RemoteProcessGroupPortEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "remoteProcessGroupPort" : { - "$ref" : "#/definitions/RemoteProcessGroupPortDTO" - }, - "operatePermissions" : { - "description" : "The permissions for this component operations.", - "$ref" : "#/definitions/PermissionsDTO" - } - }, - "xml" : { - "name" : "remoteProcessGroupPortEntity" - } - }, - "RemoteProcessGroupStatusDTO" : { - "type" : "object", - "properties" : { - "groupId" : { - "type" : "string", - "description" : "The unique ID of the process group that the Processor belongs to" - }, - "id" : { - "type" : "string", - "description" : "The unique ID of the Processor" - }, - "name" : { - "type" : "string", - "description" : "The name of the remote process group." - }, - "targetUri" : { - "type" : "string", - "description" : "The URI of the target system." - }, - "transmissionStatus" : { - "type" : "string", - "description" : "The transmission status of the remote process group." - }, - "statsLastRefreshed" : { - "type" : "string", - "description" : "The time the status for the process group was last refreshed." - }, - "validationStatus" : { - "type" : "string", - "description" : "Indicates whether the component is valid, invalid, or still in the process of validating (i.e., it is unknown whether or not the component is valid)", - "enum" : [ "VALID", "INVALID", "VALIDATING" ] - }, - "aggregateSnapshot" : { - "description" : "A status snapshot that represents the aggregate stats of all nodes in the cluster. If the NiFi instance is a standalone instance, rather than a cluster, this represents the stats of the single instance.", - "$ref" : "#/definitions/RemoteProcessGroupStatusSnapshotDTO" - }, - "nodeSnapshots" : { - "type" : "array", - "description" : "A status snapshot for each node in the cluster. If the NiFi instance is a standalone instance, rather than a cluster, this may be null.", - "items" : { - "$ref" : "#/definitions/NodeRemoteProcessGroupStatusSnapshotDTO" - } - } - } - }, - "RemoteProcessGroupStatusEntity" : { - "type" : "object", - "properties" : { - "remoteProcessGroupStatus" : { - "$ref" : "#/definitions/RemoteProcessGroupStatusDTO" - }, - "canRead" : { - "type" : "boolean", - "description" : "Indicates whether the user can read a given resource." - } - }, - "xml" : { - "name" : "remoteProcessGroupStatusEntity" - } - }, - "RemoteProcessGroupStatusSnapshotDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the remote process group." - }, - "groupId" : { - "type" : "string", - "description" : "The id of the parent process group the remote process group resides in." - }, - "name" : { - "type" : "string", - "description" : "The name of the remote process group." - }, - "targetUri" : { - "type" : "string", - "description" : "The URI of the target system." - }, - "transmissionStatus" : { - "type" : "string", - "description" : "The transmission status of the remote process group." - }, - "activeThreadCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of active threads for the remote process group." - }, - "flowFilesSent" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of FlowFiles sent to the remote process group in the last 5 minutes." - }, - "bytesSent" : { - "type" : "integer", - "format" : "int64", - "description" : "The size of the FlowFiles sent to the remote process group in the last 5 minutes." - }, - "sent" : { - "type" : "string", - "description" : "The count/size of the flowfiles sent to the remote process group in the last 5 minutes." - }, - "flowFilesReceived" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of FlowFiles received from the remote process group in the last 5 minutes." - }, - "bytesReceived" : { - "type" : "integer", - "format" : "int64", - "description" : "The size of the FlowFiles received from the remote process group in the last 5 minutes." - }, - "received" : { - "type" : "string", - "description" : "The count/size of the flowfiles received from the remote process group in the last 5 minutes." - } - } - }, - "RemoteProcessGroupStatusSnapshotEntity" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the remote process group." - }, - "remoteProcessGroupStatusSnapshot" : { - "$ref" : "#/definitions/RemoteProcessGroupStatusSnapshotDTO" - }, - "canRead" : { - "type" : "boolean", - "description" : "Indicates whether the user can read a given resource." - } - }, - "xml" : { - "name" : "entity" - } - }, - "RemoteProcessGroupsEntity" : { - "type" : "object", - "properties" : { - "remoteProcessGroups" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/RemoteProcessGroupEntity" - } - } - }, - "xml" : { - "name" : "remoteProcessGroupsEntity" - } - }, - "RemoteQueuePartitionDTO" : { - "type" : "object", - "properties" : { - "totalFlowFileCount" : { - "type" : "integer", - "format" : "int32", - "description" : "Total number of FlowFiles owned by the Connection" - }, - "totalByteCount" : { - "type" : "integer", - "format" : "int64", - "description" : "Total number of bytes that make up the content for the FlowFiles owned by this Connection" - }, - "activeQueueFlowFileCount" : { - "type" : "integer", - "format" : "int32", - "description" : "Total number of FlowFiles that exist in the Connection's Active Queue, immediately available to be offered up to a component" - }, - "activeQueueByteCount" : { - "type" : "integer", - "format" : "int64", - "description" : "Total number of bytes that make up the content for the FlowFiles that are present in the Connection's Active Queue" - }, - "swapFlowFileCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The total number of FlowFiles that are swapped out for this Connection" - }, - "swapByteCount" : { - "type" : "integer", - "format" : "int64", - "description" : "Total number of bytes that make up the content for the FlowFiles that are swapped out to disk for the Connection" - }, - "swapFiles" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of Swap Files that exist for this Connection" - }, - "inFlightFlowFileCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of In-Flight FlowFiles for this Connection. These are FlowFiles that belong to the connection but are currently being operated on by a Processor, Port, etc." - }, - "inFlightByteCount" : { - "type" : "integer", - "format" : "int64", - "description" : "The number bytes that make up the content of the FlowFiles that are In-Flight" - }, - "nodeIdentifier" : { - "type" : "string", - "description" : "The Node Identifier that this queue partition is sending to" - } - } - }, - "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" : { - "componentId" : { - "type" : "string", - "description" : "The UUID of the component whose last event should be replayed." - }, - "nodes" : { - "type" : "string", - "description" : "Which nodes were requested to replay their last provenance event.", - "enum" : [ "ALL", "PRIMARY" ] - }, - "aggregateSnapshot" : { - "description" : "The aggregate result of all nodes' responses", - "$ref" : "#/definitions/ReplayLastEventSnapshotDTO" - }, - "nodeSnapshots" : { - "type" : "array", - "description" : "The node-wise results", - "items" : { - "$ref" : "#/definitions/NodeReplayLastEventSnapshotDTO" - } - } - }, - "xml" : { - "name" : "replayLastEventResponseEntity" - } - }, - "ReplayLastEventSnapshotDTO" : { - "type" : "object", - "properties" : { - "eventsReplayed" : { - "type" : "array", - "description" : "The IDs of the events that were successfully replayed", - "items" : { - "type" : "integer", - "format" : "int64" - } - }, - "failureExplanation" : { - "type" : "string", - "description" : "If unable to replay an event, specifies why the event could not be replayed" - }, - "eventAvailable" : { - "type" : "boolean", - "description" : "Whether or not an event was available. This may not be populated if there was a failure." - } - }, - "xml" : { - "name" : "replayLastEventSnapshot" - } - }, - "ReportingTaskDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "versionedComponentId" : { - "type" : "string", - "description" : "The ID of the corresponding component that is under version control" - }, - "parentGroupId" : { - "type" : "string", - "description" : "The id of parent process group of this component if applicable." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "name" : { - "type" : "string", - "description" : "The name of the reporting task." - }, - "type" : { - "type" : "string", - "description" : "The fully qualified type of the reporting task." - }, - "bundle" : { - "description" : "The details of the artifact that bundled this reporting task type.", - "$ref" : "#/definitions/BundleDTO" - }, - "state" : { - "type" : "string", - "description" : "The state of the reporting task.", - "enum" : [ "RUNNING", "STOPPED", "DISABLED" ] - }, - "comments" : { - "type" : "string", - "description" : "The comments of the reporting task." - }, - "persistsState" : { - "type" : "boolean", - "description" : "Whether the reporting task persists state." - }, - "restricted" : { - "type" : "boolean", - "description" : "Whether the reporting task requires elevated privileges." - }, - "deprecated" : { - "type" : "boolean", - "description" : "Whether the reporting task has been deprecated." - }, - "multipleVersionsAvailable" : { - "type" : "boolean", - "description" : "Whether the reporting task has multiple versions available." - }, - "supportsSensitiveDynamicProperties" : { - "type" : "boolean", - "description" : "Whether the reporting task supports sensitive dynamic properties." - }, - "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." - }, - "defaultSchedulingPeriod" : { - "type" : "object", - "description" : "The default scheduling period for the different scheduling strategies.", - "additionalProperties" : { - "type" : "string" - } - }, - "properties" : { - "type" : "object", - "description" : "The properties of the reporting task.", - "additionalProperties" : { - "type" : "string" - } - }, - "descriptors" : { - "type" : "object", - "description" : "The descriptors for the reporting tasks properties.", - "additionalProperties" : { - "$ref" : "#/definitions/PropertyDescriptorDTO" - } - }, - "sensitiveDynamicPropertyNames" : { - "type" : "array", - "description" : "Set of sensitive dynamic property names", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - }, - "customUiUrl" : { - "type" : "string", - "description" : "The URL for the custom configuration UI for the reporting task." - }, - "annotationData" : { - "type" : "string", - "description" : "The annotation data for the repoting task. This is how the custom UI relays configuration to the reporting task." - }, - "validationErrors" : { - "type" : "array", - "description" : "Gets the validation errors from the reporting task. These validation errors represent the problems with the reporting task that must be resolved before it can be scheduled to run.", - "items" : { - "type" : "string" - } - }, - "validationStatus" : { - "type" : "string", - "description" : "Indicates whether the 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" ] - }, - "activeThreadCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of active threads for the reporting task." - }, - "extensionMissing" : { - "type" : "boolean", - "description" : "Whether the underlying extension is missing." - } - } - }, - "ReportingTaskDefinition" : { - "type" : "object", - "required" : [ "type" ], - "properties" : { - "group" : { - "type" : "string", - "description" : "The group name of the bundle that provides the referenced type." - }, - "artifact" : { - "type" : "string", - "description" : "The artifact name of the bundle that provides the referenced type." - }, - "version" : { - "type" : "string", - "description" : "The version 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." - }, - "buildInfo" : { - "description" : "The build metadata for this component", - "$ref" : "#/definitions/BuildInfo" - }, - "providedApiImplementations" : { - "type" : "array", - "description" : "If this type represents a provider for an interface, this lists the APIs it implements", - "items" : { - "$ref" : "#/definitions/DefinedType" - } - }, - "tags" : { - "type" : "array", - "description" : "The tags associated with this type", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - }, - "deprecated" : { - "type" : "boolean", - "description" : "Whether or not the component has been deprecated" - }, - "deprecationReason" : { - "type" : "string", - "description" : "If this component has been deprecated, this optional field can be used to provide an explanation" - }, - "restricted" : { - "type" : "boolean", - "description" : "Whether or not the component has a general restriction" - }, - "restrictedExplanation" : { - "type" : "string", - "description" : "An optional description of the general restriction" - }, - "explicitRestrictions" : { - "type" : "array", - "description" : "Explicit restrictions that indicate a require permission to use the component", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/Restriction" - } - }, - "stateful" : { - "$ref" : "#/definitions/Stateful" - }, - "propertyDescriptors" : { - "type" : "object", - "description" : "Descriptions of configuration properties applicable to this component.", - "additionalProperties" : { - "$ref" : "#/definitions/PropertyDescriptor" - } - }, - "supportsDynamicProperties" : { - "type" : "boolean", - "description" : "Whether or not this component makes use of dynamic (user-set) properties." - }, - "supportedSchedulingStrategies" : { - "type" : "array", - "description" : "The supported scheduling strategies, such as TIME_DRIVER or CRON.", - "items" : { - "type" : "string" - } - }, - "defaultSchedulingStrategy" : { - "type" : "string", - "description" : "The default scheduling strategy for the reporting task." - }, - "defaultSchedulingPeriodBySchedulingStrategy" : { - "type" : "object", - "description" : "The default scheduling period for each scheduling strategy. The scheduling period is expected to be a time period, such as \"30 sec\".", - "additionalProperties" : { - "type" : "string" - } - } - } - }, - "ReportingTaskEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "component" : { - "$ref" : "#/definitions/ReportingTaskDTO" - }, - "operatePermissions" : { - "description" : "The permissions for this component operations.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "status" : { - "description" : "The status for this ReportingTask.", - "$ref" : "#/definitions/ReportingTaskStatusDTO" - } - }, - "xml" : { - "name" : "reportingTaskEntity" - } - }, - "ReportingTaskRunStatusEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "state" : { - "type" : "string", - "description" : "The run status of the ReportingTask.", - "enum" : [ "RUNNING", "STOPPED" ] - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - } - }, - "xml" : { - "name" : "entity" - } - }, - "ReportingTaskStatusDTO" : { - "type" : "object", - "properties" : { - "runStatus" : { - "type" : "string", - "description" : "The run status of this ReportingTask", - "enum" : [ "RUNNING", "STOPPED", "DISABLED" ] - }, - "validationStatus" : { - "type" : "string", - "description" : "Indicates whether the component is valid, invalid, or still in the process of validating (i.e., it is unknown whether or not the component is valid)", - "enum" : [ "VALID", "INVALID", "VALIDATING" ] - }, - "activeThreadCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of active threads for the component." - } - } - }, - "ReportingTaskTypesEntity" : { - "type" : "object", - "properties" : { - "reportingTaskTypes" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/DocumentedTypeDTO" - } - } - }, - "xml" : { - "name" : "reportingTaskTypesEntity" - } - }, - "ReportingTasksEntity" : { - "type" : "object", - "properties" : { - "reportingTasks" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ReportingTaskEntity" - } - } - }, - "xml" : { - "name" : "reportingTasksEntity" - } - }, - "RepositoryUsageDTO" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The name of the repository" - }, - "fileStoreHash" : { - "type" : "string", - "description" : "A SHA-256 hash of the File Store name/path that is used to store the repository's data. This information is exposed as a hash in order to avoid exposing potentially sensitive information that is not generally relevant. What is typically relevant is whether or not multiple repositories on the same node are using the same File Store, as this indicates that the repositories are competing for the resources of the backing disk/storage mechanism." - }, - "freeSpace" : { - "type" : "string", - "description" : "Amount of free space." - }, - "totalSpace" : { - "type" : "string", - "description" : "Amount of total space." - }, - "freeSpaceBytes" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes of free space." - }, - "totalSpaceBytes" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes of total space." - }, - "utilization" : { - "type" : "string", - "description" : "Utilization of this storage location." - } - } - }, - "RequiredPermissionDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The required sub-permission necessary for this restriction." - }, - "label" : { - "type" : "string", - "description" : "The label for the required sub-permission necessary for this restriction." - } - } - }, - "ResourceDTO" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The identifier of the resource." - }, - "name" : { - "type" : "string", - "description" : "The name of the resource." - } - } - }, - "ResourcesEntity" : { - "type" : "object", - "properties" : { - "resources" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/ResourceDTO" - } - } - }, - "xml" : { - "name" : "resourcesEntity" - } - }, - "Response" : { - "type" : "object", - "properties" : { - "entity" : { - "type" : "object" - }, - "status" : { - "type" : "integer", - "format" : "int32" - }, - "metadata" : { - "type" : "object", - "additionalProperties" : { - "type" : "array", - "items" : { - "type" : "object" - } - } - } - } - }, - "Restriction" : { - "type" : "object", - "properties" : { - "requiredPermission" : { - "type" : "string", - "description" : "The permission required for this restriction" - }, - "explanation" : { - "type" : "string", - "description" : "The explanation of this restriction" - } - } - }, - "RevisionDTO" : { - "type" : "object", - "properties" : { - "clientId" : { - "type" : "string", - "description" : "A client identifier used to make a request. By including a client identifier, the API can allow multiple requests without needing the current revision. Due to the asynchronous nature of requests/responses this was implemented to allow the client to make numerous requests without having to wait for the previous response to come back" - }, - "version" : { - "type" : "integer", - "format" : "int64", - "description" : "NiFi employs an optimistic locking strategy where the client must include a revision in their request when performing an update. In a response to a mutable flow request, this field represents the updated base version." - }, - "lastModifier" : { - "type" : "string", - "description" : "The user that last modified the flow." - } - } - }, - "RunStatusDetailsRequestEntity" : { - "type" : "object", - "properties" : { - "processorIds" : { - "type" : "array", - "description" : "The IDs of all processors whose run status details should be provided", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - } - }, - "xml" : { - "name" : "runStatusDetailsRequest" - } - }, - "RuntimeManifest" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "A unique identifier for the manifest" - }, - "agentType" : { - "type" : "string", - "description" : "The type of the runtime binary, e.g., 'minifi-java' or 'minifi-cpp'" - }, - "version" : { - "type" : "string", - "description" : "The version of the runtime binary, e.g., '1.0.1'" - }, - "buildInfo" : { - "description" : "Build summary for this runtime binary", - "$ref" : "#/definitions/BuildInfo" - }, - "bundles" : { - "type" : "array", - "description" : "All extension bundles included with this runtime", - "items" : { - "$ref" : "#/definitions/Bundle" - } - }, - "schedulingDefaults" : { - "description" : "Scheduling defaults for components defined in this manifest", - "$ref" : "#/definitions/SchedulingDefaults" - } - } - }, - "RuntimeManifestEntity" : { - "type" : "object", - "properties" : { - "runtimeManifest" : { - "$ref" : "#/definitions/RuntimeManifest" - } - }, - "xml" : { - "name" : "runtimeManifestEntity" - } - }, - "ScheduleComponentsEntity" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the ProcessGroup" - }, - "state" : { - "type" : "string", - "description" : "The desired state of the descendant components", - "enum" : [ "RUNNING", "STOPPED", "ENABLED", "DISABLED" ] - }, - "components" : { - "type" : "object", - "description" : "Optional components to schedule. If not specified, all authorized descendant components will be used.", - "additionalProperties" : { - "$ref" : "#/definitions/RevisionDTO" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - } - }, - "xml" : { - "name" : "scheduleComponentEntity" - } - }, - "SchedulingDefaults" : { - "type" : "object", - "properties" : { - "defaultSchedulingStrategy" : { - "type" : "string", - "description" : "The name of the default scheduling strategy", - "enum" : [ "EVENT_DRIVEN", "TIMER_DRIVEN", "PRIMARY_NODE_ONLY", "CRON_DRIVEN" ] - }, - "defaultSchedulingPeriodMillis" : { - "type" : "integer", - "format" : "int64", - "description" : "The default scheduling period in milliseconds" - }, - "penalizationPeriodMillis" : { - "type" : "integer", - "format" : "int64", - "description" : "The default penalization period in milliseconds" - }, - "yieldDurationMillis" : { - "type" : "integer", - "format" : "int64", - "description" : "The default yield duration in milliseconds" - }, - "defaultRunDurationNanos" : { - "type" : "integer", - "format" : "int64", - "description" : "The default run duration in nano-seconds" - }, - "defaultMaxConcurrentTasks" : { - "type" : "string", - "description" : "The default concurrent tasks" - }, - "defaultConcurrentTasksBySchedulingStrategy" : { - "type" : "object", - "description" : "The default concurrent tasks for each scheduling strategy", - "additionalProperties" : { - "type" : "integer", - "format" : "int32" - } - }, - "defaultSchedulingPeriodsBySchedulingStrategy" : { - "type" : "object", - "description" : "The default scheduling period for each scheduling strategy", - "additionalProperties" : { - "type" : "string" - } - } - } - }, - "SearchResultGroupDTO" : { - "type" : "object", - "required" : [ "id" ], - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the group." - }, - "name" : { - "type" : "string", - "description" : "The name of the group." - } - } - }, - "SearchResultsDTO" : { - "type" : "object", - "properties" : { - "processorResults" : { - "type" : "array", - "description" : "The processors that matched the search.", - "items" : { - "$ref" : "#/definitions/ComponentSearchResultDTO" - } - }, - "connectionResults" : { - "type" : "array", - "description" : "The connections that matched the search.", - "items" : { - "$ref" : "#/definitions/ComponentSearchResultDTO" - } - }, - "processGroupResults" : { - "type" : "array", - "description" : "The process groups that matched the search.", - "items" : { - "$ref" : "#/definitions/ComponentSearchResultDTO" - } - }, - "inputPortResults" : { - "type" : "array", - "description" : "The input ports that matched the search.", - "items" : { - "$ref" : "#/definitions/ComponentSearchResultDTO" - } - }, - "outputPortResults" : { - "type" : "array", - "description" : "The output ports that matched the search.", - "items" : { - "$ref" : "#/definitions/ComponentSearchResultDTO" - } - }, - "remoteProcessGroupResults" : { - "type" : "array", - "description" : "The remote process groups that matched the search.", - "items" : { - "$ref" : "#/definitions/ComponentSearchResultDTO" - } - }, - "funnelResults" : { - "type" : "array", - "description" : "The funnels that matched the search.", - "items" : { - "$ref" : "#/definitions/ComponentSearchResultDTO" - } - }, - "labelResults" : { - "type" : "array", - "description" : "The labels that matched the search.", - "items" : { - "$ref" : "#/definitions/ComponentSearchResultDTO" - } - }, - "controllerServiceNodeResults" : { - "type" : "array", - "description" : "The controller service nodes that matched the search", - "items" : { - "$ref" : "#/definitions/ComponentSearchResultDTO" - } - }, - "parameterContextResults" : { - "type" : "array", - "description" : "The parameter contexts that matched the search.", - "items" : { - "$ref" : "#/definitions/ComponentSearchResultDTO" - } - }, - "parameterProviderNodeResults" : { - "type" : "array", - "description" : "The parameter provider nodes that matched the search", - "items" : { - "$ref" : "#/definitions/ComponentSearchResultDTO" - } - }, - "parameterResults" : { - "type" : "array", - "description" : "The parameters that matched the search.", - "items" : { - "$ref" : "#/definitions/ComponentSearchResultDTO" - } - } - } - }, - "SearchResultsEntity" : { - "type" : "object", - "properties" : { - "searchResultsDTO" : { - "$ref" : "#/definitions/SearchResultsDTO" - } - }, - "xml" : { - "name" : "searchResultsEntity" - } - }, - "SnippetDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the snippet." - }, - "uri" : { - "type" : "string", - "description" : "The URI of the snippet." - }, - "parentGroupId" : { - "type" : "string", - "description" : "The group id for the components in the snippet." - }, - "processGroups" : { - "type" : "object", - "description" : "The ids of the process groups in this snippet. These ids will be populated within each response. They can be specified when creating a snippet. However, once a snippet has been created its contents cannot be modified (these ids are ignored during update requests).", - "additionalProperties" : { - "$ref" : "#/definitions/RevisionDTO" - } - }, - "remoteProcessGroups" : { - "type" : "object", - "description" : "The ids of the remote process groups in this snippet. These ids will be populated within each response. They can be specified when creating a snippet. However, once a snippet has been created its contents cannot be modified (these ids are ignored during update requests).", - "additionalProperties" : { - "$ref" : "#/definitions/RevisionDTO" - } - }, - "processors" : { - "type" : "object", - "description" : "The ids of the processors in this snippet. These ids will be populated within each response. They can be specified when creating a snippet. However, once a snippet has been created its contents cannot be modified (these ids are ignored during update requests).", - "additionalProperties" : { - "$ref" : "#/definitions/RevisionDTO" - } - }, - "inputPorts" : { - "type" : "object", - "description" : "The ids of the input ports in this snippet. These ids will be populated within each response. They can be specified when creating a snippet. However, once a snippet has been created its contents cannot be modified (these ids are ignored during update requests).", - "additionalProperties" : { - "$ref" : "#/definitions/RevisionDTO" - } - }, - "outputPorts" : { - "type" : "object", - "description" : "The ids of the output ports in this snippet. These ids will be populated within each response. They can be specified when creating a snippet. However, once a snippet has been created its contents cannot be modified (these ids are ignored during update requests).", - "additionalProperties" : { - "$ref" : "#/definitions/RevisionDTO" - } - }, - "connections" : { - "type" : "object", - "description" : "The ids of the connections in this snippet. These ids will be populated within each response. They can be specified when creating a snippet. However, once a snippet has been created its contents cannot be modified (these ids are ignored during update requests).", - "additionalProperties" : { - "$ref" : "#/definitions/RevisionDTO" - } - }, - "labels" : { - "type" : "object", - "description" : "The ids of the labels in this snippet. These ids will be populated within each response. They can be specified when creating a snippet. However, once a snippet has been created its contents cannot be modified (these ids are ignored during update requests).", - "additionalProperties" : { - "$ref" : "#/definitions/RevisionDTO" - } - }, - "funnels" : { - "type" : "object", - "description" : "The ids of the funnels in this snippet. These ids will be populated within each response. They can be specified when creating a snippet. However, once a snippet has been created its contents cannot be modified (these ids are ignored during update requests).", - "additionalProperties" : { - "$ref" : "#/definitions/RevisionDTO" - } - } - } - }, - "SnippetEntity" : { - "type" : "object", - "properties" : { - "snippet" : { - "description" : "The snippet.", - "$ref" : "#/definitions/SnippetDTO" - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - } - }, - "xml" : { - "name" : "snippetEntity" - } - }, - "StackTraceElement" : { - "type" : "object", - "properties" : { - "methodName" : { - "type" : "string" - }, - "fileName" : { - "type" : "string" - }, - "lineNumber" : { - "type" : "integer", - "format" : "int32" - }, - "className" : { - "type" : "string" - }, - "nativeMethod" : { - "type" : "boolean" - } - } - }, - "StartVersionControlRequestEntity" : { - "type" : "object", - "properties" : { - "versionedFlow" : { - "description" : "The versioned flow", - "$ref" : "#/definitions/VersionedFlowDTO" - }, - "processGroupRevision" : { - "description" : "The Revision of the Process Group under Version Control", - "$ref" : "#/definitions/RevisionDTO" - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - } - }, - "xml" : { - "name" : "startVersionControlRequestEntity" - } - }, - "StateEntryDTO" : { - "type" : "object", - "properties" : { - "key" : { - "type" : "string", - "description" : "The key for this state." - }, - "value" : { - "type" : "string", - "description" : "The value for this state." - }, - "clusterNodeId" : { - "type" : "string", - "description" : "The identifier for the node where the state originated." - }, - "clusterNodeAddress" : { - "type" : "string", - "description" : "The label for the node where the state originated." - } - } - }, - "StateMapDTO" : { - "type" : "object", - "properties" : { - "scope" : { - "type" : "string", - "description" : "The scope of this StateMap." - }, - "totalEntryCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The total number of state entries. When the state map is lengthy, only of portion of the entries are returned." - }, - "state" : { - "type" : "array", - "description" : "The state.", - "items" : { - "$ref" : "#/definitions/StateEntryDTO" - } - } - } - }, - "Stateful" : { - "type" : "object", - "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", - "uniqueItems" : true, - "items" : { - "type" : "string", - "enum" : [ "CLUSTER", "LOCAL" ] - } - } - } - }, - "StatusDescriptorDTO" : { - "type" : "object", - "properties" : { - "field" : { - "type" : "string", - "description" : "The name of the status field." - }, - "label" : { - "type" : "string", - "description" : "The label for the status field." - }, - "description" : { - "type" : "string", - "description" : "The description of the status field." - }, - "formatter" : { - "type" : "string", - "description" : "The formatter for the status descriptor." - } - } - }, - "StatusHistoryDTO" : { - "type" : "object", - "properties" : { - "generated" : { - "type" : "string", - "description" : "When the status history was generated." - }, - "componentDetails" : { - "type" : "object", - "description" : "A Map of key/value pairs that describe the component that the status history belongs to", - "additionalProperties" : { - "type" : "string" - } - }, - "fieldDescriptors" : { - "type" : "array", - "description" : "The Descriptors that provide information on each of the metrics provided in the status history", - "items" : { - "$ref" : "#/definitions/StatusDescriptorDTO" - } - }, - "aggregateSnapshots" : { - "type" : "array", - "description" : "A list of StatusSnapshotDTO objects that provide the actual metric values for the component. If the NiFi instance is clustered, this will represent the aggregate status across all nodes. If the NiFi instance is not clustered, this will represent the status of the entire NiFi instance.", - "items" : { - "$ref" : "#/definitions/StatusSnapshotDTO" - } - }, - "nodeSnapshots" : { - "type" : "array", - "description" : "The NodeStatusSnapshotsDTO objects that provide the actual metric values for the component, for each node. If the NiFi instance is not clustered, this value will be null.", - "items" : { - "$ref" : "#/definitions/NodeStatusSnapshotsDTO" - } - } - } - }, - "StatusHistoryEntity" : { - "type" : "object", - "properties" : { - "statusHistory" : { - "$ref" : "#/definitions/StatusHistoryDTO" - }, - "canRead" : { - "type" : "boolean", - "description" : "Indicates whether the user can read a given resource." - } - }, - "xml" : { - "name" : "statusHistoryEntity" - } - }, - "StatusSnapshotDTO" : { - "type" : "object", - "properties" : { - "timestamp" : { - "type" : "string", - "format" : "date-time", - "description" : "The timestamp of the snapshot." - }, - "statusMetrics" : { - "type" : "object", - "description" : "The status metrics.", - "additionalProperties" : { - "type" : "integer", - "format" : "int64" - } - } - } - }, - "StorageUsageDTO" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The identifier of this storage location. The identifier will correspond to the identifier keyed in the storage configuration." - }, - "freeSpace" : { - "type" : "string", - "description" : "Amount of free space." - }, - "totalSpace" : { - "type" : "string", - "description" : "Amount of total space." - }, - "usedSpace" : { - "type" : "string", - "description" : "Amount of used space." - }, - "freeSpaceBytes" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes of free space." - }, - "totalSpaceBytes" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes of total space." - }, - "usedSpaceBytes" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes of used space." - }, - "utilization" : { - "type" : "string", - "description" : "Utilization of this storage location." - } - } - }, - "StreamingOutput" : { - "type" : "object" - }, - "SubmitReplayRequestEntity" : { - "type" : "object", - "properties" : { - "eventId" : { - "type" : "integer", - "format" : "int64", - "description" : "The event identifier" - }, - "clusterNodeId" : { - "type" : "string", - "description" : "The identifier of the node where to submit the replay request." - } - }, - "xml" : { - "name" : "copySnippetRequestEntity" - } - }, - "SystemDiagnosticsDTO" : { - "type" : "object", - "properties" : { - "aggregateSnapshot" : { - "description" : "A systems diagnostic snapshot that represents the aggregate values of all nodes in the cluster. If the NiFi instance is a standalone instance, rather than a cluster, this represents the stats of the single instance.", - "$ref" : "#/definitions/SystemDiagnosticsSnapshotDTO" - }, - "nodeSnapshots" : { - "type" : "array", - "description" : "A systems diagnostics snapshot for each node in the cluster. If the NiFi instance is a standalone instance, rather than a cluster, this may be null.", - "items" : { - "$ref" : "#/definitions/NodeSystemDiagnosticsSnapshotDTO" - } - } - } - }, - "SystemDiagnosticsEntity" : { - "type" : "object", - "properties" : { - "systemDiagnostics" : { - "$ref" : "#/definitions/SystemDiagnosticsDTO" - } - }, - "xml" : { - "name" : "systemDiagnosticsEntity" - } - }, - "SystemDiagnosticsSnapshotDTO" : { - "type" : "object", - "properties" : { - "totalNonHeap" : { - "type" : "string", - "description" : "Total size of non heap." - }, - "totalNonHeapBytes" : { - "type" : "integer", - "format" : "int64", - "description" : "Total number of bytes allocated to the JVM not used for heap" - }, - "usedNonHeap" : { - "type" : "string", - "description" : "Amount of use non heap." - }, - "usedNonHeapBytes" : { - "type" : "integer", - "format" : "int64", - "description" : "Total number of bytes used by the JVM not in the heap space" - }, - "freeNonHeap" : { - "type" : "string", - "description" : "Amount of free non heap." - }, - "freeNonHeapBytes" : { - "type" : "integer", - "format" : "int64", - "description" : "Total number of free non-heap bytes available to the JVM" - }, - "maxNonHeap" : { - "type" : "string", - "description" : "Maximum size of non heap." - }, - "maxNonHeapBytes" : { - "type" : "integer", - "format" : "int64", - "description" : "The maximum number of bytes that the JVM can use for non-heap purposes" - }, - "nonHeapUtilization" : { - "type" : "string", - "description" : "Utilization of non heap." - }, - "totalHeap" : { - "type" : "string", - "description" : "Total size of heap." - }, - "totalHeapBytes" : { - "type" : "integer", - "format" : "int64", - "description" : "The total number of bytes that are available for the JVM heap to use" - }, - "usedHeap" : { - "type" : "string", - "description" : "Amount of used heap." - }, - "usedHeapBytes" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes of JVM heap that are currently being used" - }, - "freeHeap" : { - "type" : "string", - "description" : "Amount of free heap." - }, - "freeHeapBytes" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes that are allocated to the JVM heap but not currently being used" - }, - "maxHeap" : { - "type" : "string", - "description" : "Maximum size of heap." - }, - "maxHeapBytes" : { - "type" : "integer", - "format" : "int64", - "description" : "The maximum number of bytes that can be used by the JVM" - }, - "heapUtilization" : { - "type" : "string", - "description" : "Utilization of heap." - }, - "availableProcessors" : { - "type" : "integer", - "format" : "int32", - "description" : "Number of available processors if supported by the underlying system." - }, - "processorLoadAverage" : { - "type" : "number", - "format" : "double", - "description" : "The processor load average if supported by the underlying system." - }, - "totalThreads" : { - "type" : "integer", - "format" : "int32", - "description" : "Total number of threads." - }, - "daemonThreads" : { - "type" : "integer", - "format" : "int32", - "description" : "Number of daemon threads." - }, - "uptime" : { - "type" : "string", - "description" : "The uptime of the Java virtual machine" - }, - "flowFileRepositoryStorageUsage" : { - "description" : "The flowfile repository storage usage.", - "$ref" : "#/definitions/StorageUsageDTO" - }, - "contentRepositoryStorageUsage" : { - "type" : "array", - "description" : "The content repository storage usage.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/StorageUsageDTO" - } - }, - "provenanceRepositoryStorageUsage" : { - "type" : "array", - "description" : "The provenance repository storage usage.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/StorageUsageDTO" - } - }, - "garbageCollection" : { - "type" : "array", - "description" : "The garbage collection details.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/GarbageCollectionDTO" - } - }, - "statsLastRefreshed" : { - "type" : "string", - "description" : "When the diagnostics were generated." - }, - "versionInfo" : { - "description" : "The nifi, os, java, and build version information", - "$ref" : "#/definitions/VersionInfoDTO" - } - } - }, - "TemplateDTO" : { - "type" : "object", - "properties" : { - "uri" : { - "type" : "string", - "description" : "The URI for the template." - }, - "id" : { - "type" : "string", - "description" : "The id of the template." - }, - "groupId" : { - "type" : "string", - "description" : "The id of the Process Group that the template belongs to." - }, - "name" : { - "type" : "string", - "description" : "The name of the template." - }, - "description" : { - "type" : "string", - "description" : "The description of the template." - }, - "timestamp" : { - "type" : "string", - "description" : "The timestamp when this template was created." - }, - "encodingVersion" : { - "type" : "string", - "xml" : { - "name" : "encoding-version", - "attribute" : true - }, - "description" : "The encoding version of this template." - }, - "snippet" : { - "description" : "The contents of the template.", - "$ref" : "#/definitions/FlowSnippetDTO" - } - }, - "xml" : { - "name" : "template" - } - }, - "TemplateEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "template" : { - "$ref" : "#/definitions/TemplateDTO" - } - }, - "xml" : { - "name" : "templateEntity" - } - }, - "TemplatesEntity" : { - "type" : "object", - "properties" : { - "templates" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/TemplateEntity" - } - }, - "generated" : { - "type" : "string", - "description" : "When this content was generated." - } - }, - "xml" : { - "name" : "templatesEntity" - } - }, - "TenantDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "versionedComponentId" : { - "type" : "string", - "description" : "The ID of the corresponding component that is under version control" - }, - "parentGroupId" : { - "type" : "string", - "description" : "The id of parent process group of this component if applicable." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "identity" : { - "type" : "string", - "description" : "The identity of the tenant." - }, - "configurable" : { - "type" : "boolean", - "description" : "Whether this tenant is configurable." - } - } - }, - "TenantEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "component" : { - "$ref" : "#/definitions/TenantDTO" - } - }, - "xml" : { - "name" : "tenantEntity" - } - }, - "TenantsEntity" : { - "type" : "object", - "properties" : { - "users" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/TenantEntity" - } - }, - "userGroups" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/TenantEntity" - } - } - }, - "xml" : { - "name" : "tenantsEntity" - } - }, - "ThreadDumpDTO" : { - "type" : "object", - "properties" : { - "nodeId" : { - "type" : "string", - "description" : "The ID of the node in the cluster" - }, - "nodeAddress" : { - "type" : "string", - "description" : "The address of the node in the cluster" - }, - "apiPort" : { - "type" : "integer", - "format" : "int32", - "description" : "The port the node is listening for API requests." - }, - "stackTrace" : { - "type" : "string", - "description" : "The stack trace for the thread" - }, - "threadName" : { - "type" : "string", - "description" : "The name of the thread" - }, - "threadActiveMillis" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of milliseconds that the thread has been executing in the Processor" - }, - "taskTerminated" : { - "type" : "boolean", - "description" : "Indicates whether or not the user has requested that the task be terminated. If this is true, it may indicate that the thread is in a state where it will continue running indefinitely without returning." - } - } - }, - "Throwable" : { - "type" : "object", - "properties" : { - "cause" : { - "$ref" : "#/definitions/Throwable" - }, - "stackTrace" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/StackTraceElement" - } - }, - "message" : { - "type" : "string" - }, - "localizedMessage" : { - "type" : "string" - }, - "suppressed" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/Throwable" - } - } - } - }, - "TransactionResultEntity" : { - "type" : "object", - "properties" : { - "flowFileSent" : { - "type" : "integer", - "format" : "int32" - }, - "responseCode" : { - "type" : "integer", - "format" : "int32" - }, - "message" : { - "type" : "string" - } - }, - "xml" : { - "name" : "transactionResultEntity" - } - }, - "UpdateControllerServiceReferenceRequestEntity" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The identifier of the Controller Service." - }, - "state" : { - "type" : "string", - "description" : "The new state of the references for the controller service.", - "enum" : [ "ENABLED", "DISABLED", "RUNNING", "STOPPED" ] - }, - "referencingComponentRevisions" : { - "type" : "object", - "description" : "The revisions for all referencing components.", - "additionalProperties" : { - "$ref" : "#/definitions/RevisionDTO" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "uiOnly" : { - "type" : "boolean", - "description" : "Indicates whether or not the response should only include fields necessary for rendering the NiFi User Interface. As such, when this value is set to true, some fields may be returned as null values, and the selected fields may change at any time without notice. As a result, this value should not be set to true by any client other than the UI." - } - }, - "xml" : { - "name" : "updateControllerServiceReferenceRequestEntity" - } - }, - "UserDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "versionedComponentId" : { - "type" : "string", - "description" : "The ID of the corresponding component that is under version control" - }, - "parentGroupId" : { - "type" : "string", - "description" : "The id of parent process group of this component if applicable." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "identity" : { - "type" : "string", - "description" : "The identity of the tenant." - }, - "configurable" : { - "type" : "boolean", - "description" : "Whether this tenant is configurable." - }, - "userGroups" : { - "type" : "array", - "description" : "The groups to which the user belongs. This field is read only and it provided for convenience.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/TenantEntity" - } - }, - "accessPolicies" : { - "type" : "array", - "description" : "The access policies this user belongs to.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/AccessPolicySummaryEntity" - } - } - } - }, - "UserEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "component" : { - "$ref" : "#/definitions/UserDTO" - } - }, - "xml" : { - "name" : "userEntity" - } - }, - "UserGroupDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "versionedComponentId" : { - "type" : "string", - "description" : "The ID of the corresponding component that is under version control" - }, - "parentGroupId" : { - "type" : "string", - "description" : "The id of parent process group of this component if applicable." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "identity" : { - "type" : "string", - "description" : "The identity of the tenant." - }, - "configurable" : { - "type" : "boolean", - "description" : "Whether this tenant is configurable." - }, - "users" : { - "type" : "array", - "description" : "The users that belong to the user group.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/TenantEntity" - } - }, - "accessPolicies" : { - "type" : "array", - "description" : "The access policies this user group belongs to. This field was incorrectly defined as an AccessPolicyEntity. For compatibility reasons the field will remain of this type, however only the fields that are present in the AccessPolicySummaryEntity will be populated here.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/AccessPolicyEntity" - } - } - } - }, - "UserGroupEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "component" : { - "$ref" : "#/definitions/UserGroupDTO" - } - }, - "xml" : { - "name" : "userGroupEntity" - } - }, - "UserGroupsEntity" : { - "type" : "object", - "properties" : { - "userGroups" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/UserGroupEntity" - } - } - }, - "xml" : { - "name" : "userGroupsEntity" - } - }, - "UsersEntity" : { - "type" : "object", - "properties" : { - "generated" : { - "type" : "string", - "description" : "When this content was generated." - }, - "users" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/UserEntity" - } - } - }, - "xml" : { - "name" : "usersEntity" - } - }, - "VariableDTO" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The name of the variable" - }, - "value" : { - "type" : "string", - "description" : "The value of the variable" - }, - "processGroupId" : { - "type" : "string", - "description" : "The ID of the Process Group where this Variable is defined" - }, - "affectedComponents" : { - "type" : "array", - "description" : "A set of all components that will be affected if the value of this variable is changed", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/AffectedComponentEntity" - } - } - } - }, - "VariableEntity" : { - "type" : "object", - "properties" : { - "variable" : { - "description" : "The variable information", - "$ref" : "#/definitions/VariableDTO" - }, - "canWrite" : { - "type" : "boolean", - "description" : "Indicates whether the user can write a given resource." - } - }, - "xml" : { - "name" : "variableEntity" - } - }, - "VariableRegistryDTO" : { - "type" : "object", - "properties" : { - "variables" : { - "type" : "array", - "description" : "The variables that are available in this Variable Registry", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VariableEntity" - } - }, - "processGroupId" : { - "type" : "string", - "description" : "The UUID of the Process Group that this Variable Registry belongs to" - } - } - }, - "VariableRegistryEntity" : { - "type" : "object", - "properties" : { - "processGroupRevision" : { - "description" : "The revision of the Process Group that the Variable Registry belongs to", - "$ref" : "#/definitions/RevisionDTO" - }, - "variableRegistry" : { - "description" : "The Variable Registry.", - "$ref" : "#/definitions/VariableRegistryDTO" - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - } - }, - "xml" : { - "name" : "variableRegistryEntity" - } - }, - "VariableRegistryUpdateRequestDTO" : { - "type" : "object", - "properties" : { - "requestId" : { - "type" : "string", - "description" : "The ID of the request" - }, - "uri" : { - "type" : "string", - "description" : "The URI for the request" - }, - "submissionTime" : { - "type" : "string", - "format" : "date-time", - "description" : "The timestamp of when the request was submitted" - }, - "lastUpdated" : { - "type" : "string", - "format" : "date-time", - "description" : "The timestamp of when the request was last updated" - }, - "complete" : { - "type" : "boolean", - "description" : "Whether or not the request is completed" - }, - "failureReason" : { - "type" : "string", - "description" : "The reason for the request failing, or null if the request has not failed" - }, - "percentCompleted" : { - "type" : "integer", - "format" : "int32", - "description" : "A value between 0 and 100 (inclusive) indicating how close the request is to completion" - }, - "state" : { - "type" : "string", - "description" : "A description of the current state of the request" - }, - "updateSteps" : { - "type" : "array", - "description" : "The steps that are required in order to complete the request, along with the status of each", - "items" : { - "$ref" : "#/definitions/VariableRegistryUpdateStepDTO" - } - }, - "processGroupId" : { - "type" : "string", - "description" : "The unique ID of the Process Group that the variable registry belongs to" - }, - "affectedComponents" : { - "type" : "array", - "description" : "A set of all components that will be affected if the value of this variable is changed", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/AffectedComponentEntity" - } - } - } - }, - "VariableRegistryUpdateRequestEntity" : { - "type" : "object", - "properties" : { - "request" : { - "description" : "The Variable Registry Update Request", - "$ref" : "#/definitions/VariableRegistryUpdateRequestDTO" - }, - "processGroupRevision" : { - "description" : "The revision for the Process Group that owns this variable registry.", - "$ref" : "#/definitions/RevisionDTO" - } - }, - "xml" : { - "name" : "variableRegistryUpdateRequestEntity" - } - }, - "VariableRegistryUpdateStepDTO" : { - "type" : "object", - "properties" : { - "description" : { - "type" : "string", - "description" : "Explanation of what happens in this step" - }, - "complete" : { - "type" : "boolean", - "description" : "Whether or not this step has completed" - }, - "failureReason" : { - "type" : "string", - "description" : "An explanation of why this step failed, or null if this step did not fail" - } - } - }, - "VerifyConfigRequestDTO" : { - "type" : "object", - "properties" : { - "requestId" : { - "type" : "string", - "description" : "The ID of the request" - }, - "uri" : { - "type" : "string", - "description" : "The URI for the request" - }, - "submissionTime" : { - "type" : "string", - "format" : "date-time", - "description" : "The timestamp of when the request was submitted" - }, - "lastUpdated" : { - "type" : "string", - "format" : "date-time", - "description" : "The timestamp of when the request was last updated" - }, - "complete" : { - "type" : "boolean", - "description" : "Whether or not the request is completed" - }, - "failureReason" : { - "type" : "string", - "description" : "The reason for the request failing, or null if the request has not failed" - }, - "percentCompleted" : { - "type" : "integer", - "format" : "int32", - "description" : "A value between 0 and 100 (inclusive) indicating how close the request is to completion" - }, - "state" : { - "type" : "string", - "description" : "A description of the current state of the request" - }, - "updateSteps" : { - "type" : "array", - "description" : "The steps that are required in order to complete the request, along with the status of each", - "items" : { - "$ref" : "#/definitions/VerifyConfigUpdateStepDTO" - } - }, - "componentId" : { - "type" : "string", - "description" : "The ID of the component whose configuration was verified" - }, - "properties" : { - "type" : "object", - "description" : "The configured component properties", - "additionalProperties" : { - "type" : "string" - } - }, - "attributes" : { - "type" : "object", - "description" : "FlowFile Attributes that should be used to evaluate Expression Language for resolving property values", - "additionalProperties" : { - "type" : "string" - } - }, - "results" : { - "type" : "array", - "description" : "The Results of the verification", - "items" : { - "$ref" : "#/definitions/ConfigVerificationResultDTO" - } - } - } - }, - "VerifyConfigRequestEntity" : { - "type" : "object", - "properties" : { - "request" : { - "description" : "The request", - "$ref" : "#/definitions/VerifyConfigRequestDTO" - } - }, - "xml" : { - "name" : "verifyConfigRequest" - } - }, - "VerifyConfigUpdateStepDTO" : { - "type" : "object", - "properties" : { - "description" : { - "type" : "string", - "description" : "Explanation of what happens in this step" - }, - "complete" : { - "type" : "boolean", - "description" : "Whether or not this step has completed" - }, - "failureReason" : { - "type" : "string", - "description" : "An explanation of why this step failed, or null if this step did not fail" - } - } - }, - "VersionControlComponentMappingEntity" : { - "type" : "object", - "properties" : { - "versionControlComponentMapping" : { - "type" : "object", - "description" : "The mapping of Versioned Component Identifiers to instance ID's", - "additionalProperties" : { - "type" : "string" - } - }, - "processGroupRevision" : { - "description" : "The revision of the Process Group", - "$ref" : "#/definitions/RevisionDTO" - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "versionControlInformation" : { - "description" : "The Version Control information", - "$ref" : "#/definitions/VersionControlInformationDTO" - } - }, - "xml" : { - "name" : "versionControlComponentMappingEntity" - } - }, - "VersionControlInformationDTO" : { - "type" : "object", - "properties" : { - "groupId" : { - "type" : "string", - "description" : "The ID of the Process Group that is under version control" - }, - "registryId" : { - "type" : "string", - "description" : "The ID of the registry that the flow is stored in" - }, - "registryName" : { - "type" : "string", - "description" : "The name of the registry that the flow is stored in" - }, - "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" - }, - "flowId" : { - "type" : "string", - "description" : "The ID of the flow" - }, - "flowName" : { - "type" : "string", - "description" : "The name of the flow" - }, - "flowDescription" : { - "type" : "string", - "description" : "The description of the flow" - }, - "version" : { - "type" : "integer", - "format" : "int32", - "description" : "The version of the flow" - }, - "storageLocation" : { - "type" : "string", - "description" : "The storage location" - }, - "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" ] - }, - "stateExplanation" : { - "type" : "string", - "description" : "Explanation of why the group is in the specified state" - } - } - }, - "VersionControlInformationEntity" : { - "type" : "object", - "properties" : { - "processGroupRevision" : { - "description" : "The Revision for the Process Group", - "$ref" : "#/definitions/RevisionDTO" - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "versionControlInformation" : { - "description" : "The Version Control information", - "$ref" : "#/definitions/VersionControlInformationDTO" - } - }, - "xml" : { - "name" : "versionControlInformationEntity" - } - }, - "VersionInfoDTO" : { - "type" : "object", - "properties" : { - "niFiVersion" : { - "type" : "string", - "description" : "The version of this NiFi." - }, - "javaVendor" : { - "type" : "string", - "description" : "Java JVM vendor" - }, - "javaVersion" : { - "type" : "string", - "description" : "Java version" - }, - "osName" : { - "type" : "string", - "description" : "Host operating system name" - }, - "osVersion" : { - "type" : "string", - "description" : "Host operating system version" - }, - "osArchitecture" : { - "type" : "string", - "description" : "Host operating system architecture" - }, - "buildTag" : { - "type" : "string", - "description" : "Build tag" - }, - "buildRevision" : { - "type" : "string", - "description" : "Build revision or commit hash" - }, - "buildBranch" : { - "type" : "string", - "description" : "Build branch" - }, - "buildTimestamp" : { - "type" : "string", - "format" : "date-time", - "description" : "Build timestamp" - } - } - }, - "VersionedConnection" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The component's unique identifier" - }, - "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" - }, - "comments" : { - "type" : "string", - "description" : "The user-supplied comments for the component" - }, - "position" : { - "description" : "The component's position on the graph", - "$ref" : "#/definitions/Position" - }, - "source" : { - "description" : "The source of the connection.", - "$ref" : "#/definitions/ConnectableComponent" - }, - "destination" : { - "description" : "The destination of the connection.", - "$ref" : "#/definitions/ConnectableComponent" - }, - "labelIndex" : { - "type" : "integer", - "format" : "int32", - "description" : "The index of the bend point where to place the connection label." - }, - "zIndex" : { - "type" : "integer", - "format" : "int64", - "description" : "The z index of the connection." - }, - "selectedRelationships" : { - "type" : "array", - "description" : "The selected relationship that comprise the connection.", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - }, - "backPressureObjectThreshold" : { - "type" : "integer", - "format" : "int64", - "description" : "The object count threshold for determining when back pressure is applied. Updating this value is a passive change in the sense that it won't impact whether existing files over the limit are affected but it does help feeder processors to stop pushing too much into this work queue." - }, - "backPressureDataSizeThreshold" : { - "type" : "string", - "description" : "The object data size threshold for determining when back pressure is applied. Updating this value is a passive change in the sense that it won't impact whether existing files over the limit are affected but it does help feeder processors to stop pushing too much into this work queue." - }, - "flowFileExpiration" : { - "type" : "string", - "description" : "The amount of time a flow file may be in the flow before it will be automatically aged out of the flow. Once a flow file reaches this age it will be terminated from the flow the next time a processor attempts to start work on it." - }, - "prioritizers" : { - "type" : "array", - "description" : "The comparators used to prioritize the queue.", - "items" : { - "type" : "string" - } - }, - "bends" : { - "type" : "array", - "description" : "The bend points on the connection.", - "items" : { - "$ref" : "#/definitions/Position" - } - }, - "loadBalanceStrategy" : { - "type" : "string", - "description" : "The Strategy to use for load balancing data across the cluster, or null, if no Load Balance Strategy has been specified.", - "enum" : [ "DO_NOT_LOAD_BALANCE", "PARTITION_BY_ATTRIBUTE", "ROUND_ROBIN", "SINGLE_NODE" ] - }, - "partitioningAttribute" : { - "type" : "string", - "description" : "The attribute to use for partitioning data as it is load balanced across the cluster. If the Load Balance Strategy is configured to use PARTITION_BY_ATTRIBUTE, the value returned by this method is the name of the FlowFile Attribute that will be used to determine which node in the cluster should receive a given FlowFile. If the Load Balance Strategy is unset or is set to any other value, the Partitioning Attribute has no effect." - }, - "loadBalanceCompression" : { - "type" : "string", - "description" : "Whether or not compression should be used when transferring FlowFiles between nodes", - "enum" : [ "DO_NOT_COMPRESS", "COMPRESS_ATTRIBUTES_ONLY", "COMPRESS_ATTRIBUTES_AND_CONTENT" ] - }, - "componentType" : { - "type" : "string", - "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE", "REPORTING_TASK", "PARAMETER_CONTEXT", "PARAMETER_PROVIDER", "TEMPLATE", "FLOW_REGISTRY_CLIENT" ] - }, - "groupIdentifier" : { - "type" : "string", - "description" : "The ID of the Process Group that this component belongs to" - } - } - }, - "VersionedControllerService" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The component's unique identifier" - }, - "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" - }, - "comments" : { - "type" : "string", - "description" : "The user-supplied comments for the component" - }, - "position" : { - "description" : "The component's position on the graph", - "$ref" : "#/definitions/Position" - }, - "type" : { - "type" : "string", - "description" : "The type of the extension component" - }, - "bundle" : { - "description" : "Information about the bundle from which the component came", - "$ref" : "#/definitions/Bundle" - }, - "properties" : { - "type" : "object", - "description" : "The properties for the component. Properties whose value is not set will only contain the property name.", - "additionalProperties" : { - "type" : "string" - } - }, - "propertyDescriptors" : { - "type" : "object", - "description" : "The property descriptors for the component.", - "additionalProperties" : { - "$ref" : "#/definitions/VersionedPropertyDescriptor" - } - }, - "controllerServiceApis" : { - "type" : "array", - "description" : "Lists the APIs this Controller Service implements.", - "items" : { - "$ref" : "#/definitions/ControllerServiceAPI" - } - }, - "annotationData" : { - "type" : "string", - "description" : "The annotation for the controller service. This is how the custom UI relays configuration to the controller service." - }, - "scheduledState" : { - "type" : "string", - "description" : "The ScheduledState denoting whether the Controller Service is ENABLED or DISABLED", - "enum" : [ "ENABLED", "DISABLED", "RUNNING" ] - }, - "bulletinLevel" : { - "type" : "string", - "description" : "The level at which the controller service will report bulletins." - }, - "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", "PARAMETER_CONTEXT", "PARAMETER_PROVIDER", "TEMPLATE", "FLOW_REGISTRY_CLIENT" ] - }, - "groupIdentifier" : { - "type" : "string", - "description" : "The ID of the Process Group that this component belongs to" - } - } - }, - "VersionedFlowCoordinates" : { - "type" : "object", - "properties" : { - "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" - }, - "registryUrl" : { - "type" : "string", - "description" : "The URL of the Flow Registry that contains the flow" - }, - "bucketId" : { - "type" : "string", - "description" : "The UUID of the bucket that the flow resides in" - }, - "flowId" : { - "type" : "string", - "description" : "The UUID of the flow" - }, - "version" : { - "type" : "integer", - "format" : "int32", - "description" : "The version of the flow" - }, - "latest" : { - "type" : "boolean", - "description" : "Whether or not these coordinates point to the latest version of the flow" - } - } - }, - "VersionedFlowDTO" : { - "type" : "object", - "properties" : { - "registryId" : { - "type" : "string", - "description" : "The ID of the registry that the flow is tracked to" - }, - "bucketId" : { - "type" : "string", - "description" : "The ID of the bucket where the flow is stored" - }, - "flowId" : { - "type" : "string", - "description" : "The ID of the flow" - }, - "flowName" : { - "type" : "string", - "description" : "The name of the flow" - }, - "description" : { - "type" : "string", - "description" : "A description of the flow" - }, - "comments" : { - "type" : "string", - "description" : "Comments for the changeset" - }, - "action" : { - "type" : "string", - "description" : "The action being performed", - "enum" : [ "COMMIT", "FORCE_COMMIT" ] - } - } - }, - "VersionedFlowEntity" : { - "type" : "object", - "properties" : { - "versionedFlow" : { - "description" : "The versioned flow", - "$ref" : "#/definitions/VersionedFlowDTO" - } - }, - "xml" : { - "name" : "versionedFlowEntity" - } - }, - "VersionedFlowSnapshotEntity" : { - "type" : "object", - "properties" : { - "versionedFlowSnapshot" : { - "description" : "The versioned flow snapshot", - "$ref" : "#/definitions/RegisteredFlowSnapshot" - }, - "processGroupRevision" : { - "description" : "The Revision of the Process Group under Version Control", - "$ref" : "#/definitions/RevisionDTO" - }, - "registryId" : { - "type" : "string", - "description" : "The ID of the Registry that this flow belongs to" - }, - "updateDescendantVersionedFlows" : { - "type" : "boolean", - "description" : "If the Process Group to be updated has a child or descendant Process Group that is also under Version Control, this specifies whether or not the contents of that child/descendant Process Group should be updated." - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - } - }, - "xml" : { - "name" : "versionedFlowSnapshotEntity" - } - }, - "VersionedFlowSnapshotMetadataEntity" : { - "type" : "object", - "properties" : { - "versionedFlowSnapshotMetadata" : { - "description" : "The collection of registered flow snapshot metadata", - "$ref" : "#/definitions/RegisteredFlowSnapshotMetadata" - }, - "registryId" : { - "type" : "string", - "description" : "The ID of the Registry that this flow belongs to" - } - }, - "xml" : { - "name" : "versionedFlowSnapshotMetadataEntity" - } - }, - "VersionedFlowSnapshotMetadataSetEntity" : { - "type" : "object", - "properties" : { - "versionedFlowSnapshotMetadataSet" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedFlowSnapshotMetadataEntity" - } - } - }, - "xml" : { - "name" : "versionedFlowSnapshotMetadataSetEntity" - } - }, - "VersionedFlowUpdateRequestDTO" : { - "type" : "object", - "properties" : { - "requestId" : { - "type" : "string", - "description" : "The unique ID of this request." - }, - "processGroupId" : { - "type" : "string", - "description" : "The unique ID of the Process Group being updated" - }, - "uri" : { - "type" : "string", - "description" : "The URI for future requests to this drop request." - }, - "lastUpdated" : { - "type" : "string", - "description" : "The last time this request was updated." - }, - "complete" : { - "type" : "boolean", - "description" : "Whether or not this request has completed" - }, - "failureReason" : { - "type" : "string", - "description" : "An explanation of why this request failed, or null if this request has not failed" - }, - "percentCompleted" : { - "type" : "integer", - "format" : "int32", - "description" : "The percentage complete for the request, between 0 and 100" - }, - "state" : { - "type" : "string", - "description" : "The state of the request" - }, - "versionControlInformation" : { - "description" : "The VersionControlInformation that describes where the Versioned Flow is located; this may not be populated until the request is completed.", - "$ref" : "#/definitions/VersionControlInformationDTO" - } - } - }, - "VersionedFlowUpdateRequestEntity" : { - "type" : "object", - "properties" : { - "processGroupRevision" : { - "description" : "The revision for the Process Group being updated.", - "$ref" : "#/definitions/RevisionDTO" - }, - "request" : { - "description" : "The Flow Update Request", - "$ref" : "#/definitions/VersionedFlowUpdateRequestDTO" - } - }, - "xml" : { - "name" : "registeredFlowUpdateRequestEntity" - } - }, - "VersionedFlowsEntity" : { - "type" : "object", - "properties" : { - "versionedFlows" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedFlowEntity" - } - } - }, - "xml" : { - "name" : "versionedFlowsEntity" - } - }, - "VersionedFunnel" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The component's unique identifier" - }, - "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" - }, - "comments" : { - "type" : "string", - "description" : "The user-supplied comments for the component" - }, - "position" : { - "description" : "The component's position on the graph", - "$ref" : "#/definitions/Position" - }, - "componentType" : { - "type" : "string", - "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE", "REPORTING_TASK", "PARAMETER_CONTEXT", "PARAMETER_PROVIDER", "TEMPLATE", "FLOW_REGISTRY_CLIENT" ] - }, - "groupIdentifier" : { - "type" : "string", - "description" : "The ID of the Process Group that this component belongs to" - } - } - }, - "VersionedLabel" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The component's unique identifier" - }, - "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" - }, - "comments" : { - "type" : "string", - "description" : "The user-supplied comments for the component" - }, - "position" : { - "description" : "The component's position on the graph", - "$ref" : "#/definitions/Position" - }, - "label" : { - "type" : "string", - "description" : "The text that appears in the label." - }, - "zIndex" : { - "type" : "integer", - "format" : "int64", - "description" : "The z index of the connection." - }, - "width" : { - "type" : "number", - "format" : "double", - "description" : "The width of the label in pixels when at a 1:1 scale." - }, - "height" : { - "type" : "number", - "format" : "double", - "description" : "The height of the label in pixels when at a 1:1 scale." - }, - "style" : { - "type" : "object", - "description" : "The styles for this label (font-size : 12px, background-color : #eee, etc).", - "additionalProperties" : { - "type" : "string" - } - }, - "componentType" : { - "type" : "string", - "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE", "REPORTING_TASK", "PARAMETER_CONTEXT", "PARAMETER_PROVIDER", "TEMPLATE", "FLOW_REGISTRY_CLIENT" ] - }, - "groupIdentifier" : { - "type" : "string", - "description" : "The ID of the Process Group that this component belongs to" - } - } - }, - "VersionedParameter" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The name of the parameter" - }, - "description" : { - "type" : "string", - "description" : "The description of the param" - }, - "sensitive" : { - "type" : "boolean", - "description" : "Whether or not the parameter value is sensitive" - }, - "provided" : { - "type" : "boolean", - "description" : "Whether or not the parameter value is provided by a ParameterProvider" - }, - "value" : { - "type" : "string", - "description" : "The value of the parameter" - } - } - }, - "VersionedParameterContext" : { - "type" : "object", - "properties" : { - "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" - }, - "comments" : { - "type" : "string", - "description" : "The user-supplied comments for the component" - }, - "position" : { - "description" : "The component's position on the graph", - "$ref" : "#/definitions/Position" - }, - "parameters" : { - "type" : "array", - "description" : "The parameters in the context", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedParameter" - } - }, - "inheritedParameterContexts" : { - "type" : "array", - "description" : "The names of additional parameter contexts from which to inherit parameters", - "items" : { - "type" : "string" - } - }, - "description" : { - "type" : "string", - "description" : "The description of the parameter context" - }, - "parameterProvider" : { - "type" : "string", - "description" : "The identifier of an optional parameter provider" - }, - "parameterGroupName" : { - "type" : "string", - "description" : "The corresponding parameter group name fetched from the parameter provider, if applicable" - }, - "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", "PARAMETER_CONTEXT", "PARAMETER_PROVIDER", "TEMPLATE", "FLOW_REGISTRY_CLIENT" ] - }, - "synchronized" : { - "type" : "boolean", - "description" : "True if the parameter provider is set and the context should receive updates when its parameters are next fetched" - }, - "groupIdentifier" : { - "type" : "string", - "description" : "The ID of the Process Group that this component belongs to" - } - } - }, - "VersionedPort" : { - "type" : "object", - "properties" : { - "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" - }, - "comments" : { - "type" : "string", - "description" : "The user-supplied comments for the component" - }, - "position" : { - "description" : "The component's position on the graph", - "$ref" : "#/definitions/Position" - }, - "type" : { - "type" : "string", - "description" : "The type of port.", - "enum" : [ "INPUT_PORT", "OUTPUT_PORT" ] - }, - "concurrentlySchedulableTaskCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of tasks that should be concurrently scheduled for the port." - }, - "scheduledState" : { - "type" : "string", - "description" : "The scheduled state of the component", - "enum" : [ "ENABLED", "DISABLED", "RUNNING" ] - }, - "allowRemoteAccess" : { - "type" : "boolean", - "description" : "Whether or not this port allows remote access for site-to-site" - }, - "componentType" : { - "type" : "string", - "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE", "REPORTING_TASK", "PARAMETER_CONTEXT", "PARAMETER_PROVIDER", "TEMPLATE", "FLOW_REGISTRY_CLIENT" ] - }, - "groupIdentifier" : { - "type" : "string", - "description" : "The ID of the Process Group that this component belongs to" - } - } - }, - "VersionedProcessGroup" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The component's unique identifier" - }, - "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" - }, - "comments" : { - "type" : "string", - "description" : "The user-supplied comments for the component" - }, - "position" : { - "description" : "The component's position on the graph", - "$ref" : "#/definitions/Position" - }, - "processGroups" : { - "type" : "array", - "description" : "The child Process Groups", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedProcessGroup" - } - }, - "remoteProcessGroups" : { - "type" : "array", - "description" : "The Remote Process Groups", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedRemoteProcessGroup" - } - }, - "processors" : { - "type" : "array", - "description" : "The Processors", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedProcessor" - } - }, - "inputPorts" : { - "type" : "array", - "description" : "The Input Ports", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedPort" - } - }, - "outputPorts" : { - "type" : "array", - "description" : "The Output Ports", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedPort" - } - }, - "connections" : { - "type" : "array", - "description" : "The Connections", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedConnection" - } - }, - "labels" : { - "type" : "array", - "description" : "The Labels", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedLabel" - } - }, - "funnels" : { - "type" : "array", - "description" : "The Funnels", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedFunnel" - } - }, - "controllerServices" : { - "type" : "array", - "description" : "The Controller Services", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedControllerService" - } - }, - "versionedFlowCoordinates" : { - "description" : "The coordinates where the remote flow is stored, or null if the Process Group is not directly under Version Control", - "$ref" : "#/definitions/VersionedFlowCoordinates" - }, - "variables" : { - "type" : "object", - "description" : "The Variables in the Variable Registry for this Process Group (not including any ancestor or descendant Process Groups)", - "additionalProperties" : { - "type" : "string" - } - }, - "parameterContextName" : { - "type" : "string", - "description" : "The name of the parameter context used by this process group" - }, - "defaultFlowFileExpiration" : { - "type" : "string", - "description" : "The default FlowFile Expiration for this Process Group." - }, - "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." - }, - "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." - }, - "flowFileConcurrency" : { - "type" : "string", - "description" : "The configured FlowFile Concurrency for the Process Group" - }, - "flowFileOutboundPolicy" : { - "type" : "string", - "description" : "The FlowFile Outbound Policy for the Process Group" - }, - "componentType" : { - "type" : "string", - "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE", "REPORTING_TASK", "PARAMETER_CONTEXT", "PARAMETER_PROVIDER", "TEMPLATE", "FLOW_REGISTRY_CLIENT" ] - }, - "groupIdentifier" : { - "type" : "string", - "description" : "The ID of the Process Group that this component belongs to" - } - } - }, - "VersionedProcessor" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The component's unique identifier" - }, - "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" - }, - "comments" : { - "type" : "string", - "description" : "The user-supplied comments for the component" - }, - "position" : { - "description" : "The component's position on the graph", - "$ref" : "#/definitions/Position" - }, - "type" : { - "type" : "string", - "description" : "The type of the extension component" - }, - "bundle" : { - "description" : "Information about the bundle from which the component came", - "$ref" : "#/definitions/Bundle" - }, - "properties" : { - "type" : "object", - "description" : "The properties for the component. Properties whose value is not set will only contain the property name.", - "additionalProperties" : { - "type" : "string" - } - }, - "propertyDescriptors" : { - "type" : "object", - "description" : "The property descriptors for the component.", - "additionalProperties" : { - "$ref" : "#/definitions/VersionedPropertyDescriptor" - } - }, - "style" : { - "type" : "object", - "description" : "Stylistic data for rendering in a UI", - "additionalProperties" : { - "type" : "string" - } - }, - "annotationData" : { - "type" : "string", - "description" : "The annotation data for the processor used to relay configuration between a custom UI and the procesosr." - }, - "schedulingPeriod" : { - "type" : "string", - "description" : "The frequency with which to schedule the processor. The format of the value will depend on th value of schedulingStrategy." - }, - "schedulingStrategy" : { - "type" : "string", - "description" : "Indicates whether the processor should be scheduled to run in event or timer driven mode." - }, - "executionNode" : { - "type" : "string", - "description" : "Indicates the node where the process will execute." - }, - "penaltyDuration" : { - "type" : "string", - "description" : "The amout of time that is used when the process penalizes a flowfile." - }, - "yieldDuration" : { - "type" : "string", - "description" : "The amount of time that must elapse before this processor is scheduled again after yielding." - }, - "bulletinLevel" : { - "type" : "string", - "description" : "The level at which the processor will report bulletins." - }, - "runDurationMillis" : { - "type" : "integer", - "format" : "int64", - "description" : "The run duration for the processor in milliseconds." - }, - "concurrentlySchedulableTaskCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of tasks that should be concurrently schedule for the processor. If the processor doesn't allow parallol processing then any positive input will be ignored." - }, - "autoTerminatedRelationships" : { - "type" : "array", - "description" : "The names of all relationships that cause a flow file to be terminated if the relationship is not connected elsewhere. This property differs from the 'isAutoTerminate' property of the RelationshipDTO in that the RelationshipDTO is meant to depict the current configuration, whereas this property can be set in a DTO when updating a Processor in order to change which Relationships should be auto-terminated.", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - }, - "scheduledState" : { - "type" : "string", - "description" : "The scheduled state of the component", - "enum" : [ "ENABLED", "DISABLED", "RUNNING" ] - }, - "retryCount" : { - "type" : "integer", - "format" : "int32", - "description" : "Overall number of retries." - }, - "retriedRelationships" : { - "type" : "array", - "description" : "All the relationships should be retried.", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - }, - "backoffMechanism" : { - "type" : "string", - "description" : "Determines whether the FlowFile should be penalized or the processor should be yielded between retries.", - "enum" : [ "PENALIZE_FLOWFILE", "YIELD_PROCESSOR" ] - }, - "maxBackoffPeriod" : { - "type" : "string", - "description" : "Maximum amount of time to be waited during a retry period." - }, - "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", "PARAMETER_CONTEXT", "PARAMETER_PROVIDER", "TEMPLATE", "FLOW_REGISTRY_CLIENT" ] - }, - "groupIdentifier" : { - "type" : "string", - "description" : "The ID of the Process Group that this component belongs to" - } - } - }, - "VersionedPropertyDescriptor" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The name of the property" - }, - "displayName" : { - "type" : "string", - "description" : "The display name of the property" - }, - "identifiesControllerService" : { - "type" : "boolean", - "description" : "Whether or not the property provides the identifier of a Controller Service" - }, - "sensitive" : { - "type" : "boolean", - "description" : "Whether or not the property is considered sensitive" - }, - "resourceDefinition" : { - "description" : "Returns the Resource Definition that defines which type(s) of resource(s) this property references, if any", - "$ref" : "#/definitions/VersionedResourceDefinition" - } - } - }, - "VersionedRemoteGroupPort" : { - "type" : "object", - "properties" : { - "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" - }, - "comments" : { - "type" : "string", - "description" : "The user-supplied comments for the component" - }, - "position" : { - "description" : "The component's position on the graph", - "$ref" : "#/definitions/Position" - }, - "remoteGroupId" : { - "type" : "string", - "description" : "The id of the remote process group that the port resides in." - }, - "concurrentlySchedulableTaskCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of task that may transmit flowfiles to the target port concurrently." - }, - "useCompression" : { - "type" : "boolean", - "description" : "Whether the flowfiles are compressed when sent to the target port." - }, - "batchSize" : { - "description" : "The batch settings for data transmission.", - "$ref" : "#/definitions/BatchSize" - }, - "componentType" : { - "type" : "string", - "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE", "REPORTING_TASK", "PARAMETER_CONTEXT", "PARAMETER_PROVIDER", "TEMPLATE", "FLOW_REGISTRY_CLIENT" ] - }, - "targetId" : { - "type" : "string", - "description" : "The ID of the port on the target NiFi instance" - }, - "scheduledState" : { - "type" : "string", - "description" : "The scheduled state of the component", - "enum" : [ "ENABLED", "DISABLED", "RUNNING" ] - }, - "groupIdentifier" : { - "type" : "string", - "description" : "The ID of the Process Group that this component belongs to" - } - } - }, - "VersionedRemoteProcessGroup" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The component's unique identifier" - }, - "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" - }, - "comments" : { - "type" : "string", - "description" : "The user-supplied comments for the component" - }, - "position" : { - "description" : "The component's position on the graph", - "$ref" : "#/definitions/Position" - }, - "targetUri" : { - "type" : "string", - "description" : "[DEPRECATED] The target URI of the remote process group. If target uri is not set, but uris are set, then returns the first uri in the uris. If neither target uri nor uris are set, then returns null." - }, - "targetUris" : { - "type" : "string", - "description" : "The target URIs of the remote process group. If target uris is not set but target uri is set, then returns the single target uri. If neither target uris nor target uri is set, then returns null." - }, - "communicationsTimeout" : { - "type" : "string", - "description" : "The time period used for the timeout when communicating with the target." - }, - "yieldDuration" : { - "type" : "string", - "description" : "When yielding, this amount of time must elapse before the remote process group is scheduled again." - }, - "transportProtocol" : { - "type" : "string", - "description" : "The Transport Protocol that is used for Site-to-Site communications", - "enum" : [ "RAW", "HTTP" ] - }, - "localNetworkInterface" : { - "type" : "string", - "description" : "The local network interface to send/receive data. If not specified, any local address is used. If clustered, all nodes must have an interface with this identifier." - }, - "proxyHost" : { - "type" : "string" - }, - "proxyPort" : { - "type" : "integer", - "format" : "int32" - }, - "proxyUser" : { - "type" : "string" - }, - "proxyPassword" : { - "type" : "string" - }, - "inputPorts" : { - "type" : "array", - "description" : "A Set of Input Ports that can be connected to, in order to send data to the remote NiFi instance", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedRemoteGroupPort" - } - }, - "outputPorts" : { - "type" : "array", - "description" : "A Set of Output Ports that can be connected to, in order to pull data from the remote NiFi instance", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedRemoteGroupPort" - } - }, - "componentType" : { - "type" : "string", - "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE", "REPORTING_TASK", "PARAMETER_CONTEXT", "PARAMETER_PROVIDER", "TEMPLATE", "FLOW_REGISTRY_CLIENT" ] - }, - "groupIdentifier" : { - "type" : "string", - "description" : "The ID of the Process Group that this component belongs to" - } - } - }, - "VersionedResourceDefinition" : { - "type" : "object", - "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", - "uniqueItems" : true, - "items" : { - "type" : "string", - "enum" : [ "FILE", "DIRECTORY", "TEXT", "URL" ] - } - } - } - } - } -} \ No newline at end of file diff --git a/resources/client_gen/api_defs/nifi-1.23.2.json b/resources/client_gen/api_defs/nifi-1.23.2.json deleted file mode 100644 index 8cb9c648..00000000 --- a/resources/client_gen/api_defs/nifi-1.23.2.json +++ /dev/null @@ -1,26078 +0,0 @@ -{ - "swagger" : "2.0", - "info" : { - "description" : "The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and\n stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description,\n definitions of the expected input and output, potential response codes, and the authorizations required\n to invoke each service.", - "version" : "1.23.2", - "title" : "NiFi Rest API", - "contact" : { - "url" : "https://nifi.apache.org", - "email" : "dev@nifi.apache.org" - }, - "license" : { - "name" : "Apache 2.0", - "url" : "http://www.apache.org/licenses/LICENSE-2.0.html" - } - }, - "basePath" : "/nifi-api", - "tags" : [ { - "name" : "access", - "description" : "Endpoints for obtaining an access token or checking access status." - }, { - "name" : "connections", - "description" : "Endpoint for managing a Connection." - }, { - "name" : "controller", - "description" : "Provides realtime command and control of this NiFi instance" - }, { - "name" : "controller-services", - "description" : "Endpoint for managing a Controller Service." - }, { - "name" : "counters", - "description" : "Endpoint for managing counters." - }, { - "name" : "data-transfer", - "description" : "Supports data transfers with this NiFi using HTTP based site to site" - }, { - "name" : "flow", - "description" : "Endpoint for accessing the flow structure and component status." - }, { - "name" : "flowfile-queues", - "description" : "Endpoint for managing a FlowFile Queue." - }, { - "name" : "funnel", - "description" : "Endpoint for managing a Funnel." - }, { - "name" : "input-ports", - "description" : "Endpoint for managing an Input Port." - }, { - "name" : "labels", - "description" : "Endpoint for managing a Label." - }, { - "name" : "output-ports", - "description" : "Endpoint for managing an Output Port." - }, { - "name" : "parameter-contexts", - "description" : "Endpoint for managing version control for a flow" - }, { - "name" : "parameter-providers", - "description" : "Endpoint for managing a Parameter Provider." - }, { - "name" : "policies", - "description" : "Endpoint for managing access policies." - }, { - "name" : "process-groups", - "description" : "Endpoint for managing a Process Group." - }, { - "name" : "processors", - "description" : "Endpoint for managing a Processor." - }, { - "name" : "provenance", - "description" : "Endpoint for accessing data flow provenance." - }, { - "name" : "provenance-events", - "description" : "Endpoint for accessing data flow provenance." - }, { - "name" : "remote-process-groups", - "description" : "Endpoint for managing a Remote Process Group." - }, { - "name" : "reporting-tasks", - "description" : "Endpoint for managing a Reporting Task." - }, { - "name" : "resources", - "description" : "Provides the resources in this NiFi that can have access/authorization policies." - }, { - "name" : "site-to-site", - "description" : "Provide access to site to site with this NiFi" - }, { - "name" : "snippets", - "description" : "Endpoint for accessing dataflow snippets." - }, { - "name" : "system-diagnostics", - "description" : "Endpoint for accessing system diagnostics." - }, { - "name" : "templates", - "description" : "Endpoint for managing a Template." - }, { - "name" : "tenants", - "description" : "Endpoint for managing users and user groups." - }, { - "name" : "versions", - "description" : "Endpoint for managing version control for a flow" - } ], - "schemes" : [ "http", "https" ], - "paths" : { - "/access" : { - "get" : { - "tags" : [ "access" ], - "summary" : "Gets the status the client's access", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getAccessStatus", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/AccessStatusEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Unable to determine access status because the client could not be authenticated." - }, - "403" : { - "description" : "Unable to determine access status because the client is not authorized to make this request." - }, - "409" : { - "description" : "Unable to determine access status because NiFi is not in the appropriate state." - }, - "500" : { - "description" : "Unable to determine access status because an unexpected error occurred." - } - } - } - }, - "/access/config" : { - "get" : { - "tags" : [ "access" ], - "summary" : "Retrieves the access configuration for this NiFi", - "description" : "", - "operationId" : "getLoginConfig", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/AccessConfigurationEntity" - } - } - } - } - }, - "/access/kerberos" : { - "post" : { - "tags" : [ "access" ], - "summary" : "Creates a token for accessing the REST API via Kerberos ticket exchange / SPNEGO negotiation", - "description" : "The token returned is formatted as a JSON Web Token (JWT). The token is base64 encoded and comprised of three parts. The header, the body, and the signature. The expiration of the token is a contained within the body. The token can be used in the Authorization header in the format 'Authorization: Bearer '. It is also stored in the browser as a cookie.", - "operationId" : "createAccessTokenFromTicket", - "consumes" : [ "text/plain" ], - "produces" : [ "text/plain" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "NiFi was unable to complete the request because it did not contain a valid Kerberos ticket in the Authorization header. Retry this request after initializing a ticket with kinit and ensuring your browser is configured to support SPNEGO." - }, - "409" : { - "description" : "Unable to create access token because NiFi is not in the appropriate state. (i.e. may not be configured to support Kerberos login." - }, - "500" : { - "description" : "Unable to create access token because an unexpected error occurred." - } - } - } - }, - "/access/knox/callback" : { - "get" : { - "tags" : [ "access" ], - "summary" : "Redirect/callback URI for processing the result of the Apache Knox login sequence.", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "knoxCallback", - "consumes" : [ "*/*" ], - "produces" : [ "*/*" ], - "responses" : { - "default" : { - "description" : "successful operation" - } - } - } - }, - "/access/knox/logout" : { - "get" : { - "tags" : [ "access" ], - "summary" : "Performs a logout in the Apache Knox.", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "knoxLogout", - "consumes" : [ "*/*" ], - "produces" : [ "*/*" ], - "responses" : { - "default" : { - "description" : "successful operation" - } - } - } - }, - "/access/knox/request" : { - "get" : { - "tags" : [ "access" ], - "summary" : "Initiates a request to authenticate through Apache Knox.", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "knoxRequest", - "consumes" : [ "*/*" ], - "produces" : [ "*/*" ], - "responses" : { - "default" : { - "description" : "successful operation" - } - } - } - }, - "/access/logout" : { - "delete" : { - "tags" : [ "access" ], - "summary" : "Performs a logout for other providers that have been issued a JWT.", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "logOut", - "consumes" : [ "*/*" ], - "produces" : [ "*/*" ], - "responses" : { - "200" : { - "description" : "User was logged out successfully." - }, - "401" : { - "description" : "Authentication token provided was empty or not in the correct JWT format." - }, - "500" : { - "description" : "Client failed to log out." - } - } - } - }, - "/access/logout/complete" : { - "get" : { - "tags" : [ "access" ], - "summary" : "Completes the logout sequence by removing the cached Logout Request and Cookie if they existed and redirects to /nifi/login.", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "logOutComplete", - "consumes" : [ "*/*" ], - "produces" : [ "*/*" ], - "responses" : { - "200" : { - "description" : "User was logged out successfully." - }, - "401" : { - "description" : "Authentication token provided was empty or not in the correct JWT format." - }, - "500" : { - "description" : "Client failed to log out." - } - } - } - }, - "/access/token" : { - "post" : { - "tags" : [ "access" ], - "summary" : "Creates a token for accessing the REST API via username/password", - "description" : "The token returned is formatted as a JSON Web Token (JWT). The token is base64 encoded and comprised of three parts. The header, the body, and the signature. The expiration of the token is a contained within the body. 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", - "consumes" : [ "application/x-www-form-urlencoded" ], - "produces" : [ "text/plain" ], - "parameters" : [ { - "name" : "username", - "in" : "formData", - "required" : false, - "type" : "string" - }, { - "name" : "password", - "in" : "formData", - "required" : false, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "Unable to create access token because NiFi is not in the appropriate state. (i.e. may not be configured to support username/password login." - }, - "500" : { - "description" : "Unable to create access token because an unexpected error occurred." - } - } - } - }, - "/access/token/expiration" : { - "get" : { - "tags" : [ "access" ], - "summary" : "Get expiration for current Access Token", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getAccessTokenExpiration", - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "Access Token Expiration found", - "schema" : { - "$ref" : "#/definitions/AccessTokenExpirationEntity" - } - }, - "401" : { - "description" : "Access Token not authorized" - }, - "409" : { - "description" : "Access Token not resolved" - } - } - } - }, - "/connections/{id}" : { - "get" : { - "tags" : [ "connections" ], - "summary" : "Gets a connection", - "description" : "", - "operationId" : "getConnection", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The connection id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ConnectionEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read Source - /{component-type}/{uuid}" : [ ] - }, { - "Read Destination - /{component-type}/{uuid}" : [ ] - } ] - }, - "put" : { - "tags" : [ "connections" ], - "summary" : "Updates a connection", - "description" : "", - "operationId" : "updateConnection", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The connection id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The connection configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ConnectionEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ConnectionEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write Source - /{component-type}/{uuid}" : [ ] - }, { - "Write Destination - /{component-type}/{uuid}" : [ ] - }, { - "Write New Destination - /{component-type}/{uuid} - if updating Destination" : [ ] - }, { - "Write Process Group - /process-groups/{uuid} - if updating Destination" : [ ] - } ] - }, - "delete" : { - "tags" : [ "connections" ], - "summary" : "Deletes a connection", - "description" : "", - "operationId" : "deleteConnection", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The revision is used to verify the client is working with the latest version of the flow.", - "required" : false, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The connection id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ConnectionEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write Source - /{component-type}/{uuid}" : [ ] - }, { - "Write - Parent Process Group - /process-groups/{uuid}" : [ ] - }, { - "Write Destination - /{component-type}/{uuid}" : [ ] - } ] - } - }, - "/controller-services/{id}" : { - "get" : { - "tags" : [ "controller-services" ], - "summary" : "Gets a controller service", - "description" : "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", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The controller service id.", - "required" : true, - "type" : "string" - }, { - "name" : "uiOnly", - "in" : "query", - "required" : false, - "type" : "boolean", - "default" : false - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ControllerServiceEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /controller-services/{uuid}" : [ ] - } ] - }, - "put" : { - "tags" : [ "controller-services" ], - "summary" : "Updates a controller service", - "description" : "", - "operationId" : "updateControllerService", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The controller service id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The controller service configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ControllerServiceEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ControllerServiceEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /controller-services/{uuid}" : [ ] - }, { - "Read - any referenced Controller Services if this request changes the reference - /controller-services/{uuid}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "controller-services" ], - "summary" : "Deletes a controller service", - "description" : "", - "operationId" : "removeControllerService", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The revision is used to verify the client is working with the latest version of the flow.", - "required" : false, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The controller service id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ControllerServiceEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /controller-services/{uuid}" : [ ] - }, { - "Write - Parent Process Group if scoped by Process Group - /process-groups/{uuid}" : [ ] - }, { - "Write - Controller if scoped by Controller - /controller" : [ ] - }, { - "Read - any referenced Controller Services - /controller-services/{uuid}" : [ ] - } ] - } - }, - "/controller-services/{id}/config/analysis" : { - "post" : { - "tags" : [ "controller-services" ], - "summary" : "Performs analysis of the component's configuration, providing information about which attributes are referenced.", - "description" : "", - "operationId" : "analyzeConfiguration", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The controller service id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The configuration analysis request.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ConfigurationAnalysisEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/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. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /controller-services/{uuid}" : [ ] - } ] - } - }, - "/controller-services/{id}/config/verification-requests" : { - "post" : { - "tags" : [ "controller-services" ], - "summary" : "Performs verification of the Controller Service's configuration", - "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", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The controller service id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The controller service configuration verification request.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/VerifyConfigRequestEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/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. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /controller-services/{uuid}" : [ ] - } ] - } - }, - "/controller-services/{id}/config/verification-requests/{requestId}" : { - "get" : { - "tags" : [ "controller-services" ], - "summary" : "Returns the Verification Request with the given ID", - "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", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The ID of the Controller Service", - "required" : true, - "type" : "string" - }, { - "name" : "requestId", - "in" : "path", - "description" : "The ID of the Verification Request", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/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. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Only the user that submitted the request can get it" : [ ] - } ] - }, - "delete" : { - "tags" : [ "controller-services" ], - "summary" : "Deletes the Verification Request with the given ID", - "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", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The ID of the Controller Service", - "required" : true, - "type" : "string" - }, { - "name" : "requestId", - "in" : "path", - "description" : "The ID of the Verification Request", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/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. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Only the user that submitted the request can remove it" : [ ] - } ] - } - }, - "/controller-services/{id}/descriptors" : { - "get" : { - "tags" : [ "controller-services" ], - "summary" : "Gets a controller service property descriptor", - "description" : "", - "operationId" : "getPropertyDescriptor", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The controller service id.", - "required" : true, - "type" : "string" - }, { - "name" : "propertyName", - "in" : "query", - "description" : "The property name to return the descriptor for.", - "required" : true, - "type" : "string" - }, { - "name" : "sensitive", - "in" : "query", - "description" : "Property Descriptor requested sensitive status", - "required" : false, - "type" : "boolean", - "default" : false - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/PropertyDescriptorEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /controller-services/{uuid}" : [ ] - } ] - } - }, - "/controller-services/{id}/references" : { - "get" : { - "tags" : [ "controller-services" ], - "summary" : "Gets a controller service", - "description" : "", - "operationId" : "getControllerServiceReferences", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The controller service id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ControllerServiceReferencingComponentsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /controller-services/{uuid}" : [ ] - } ] - }, - "put" : { - "tags" : [ "controller-services" ], - "summary" : "Updates a controller services references", - "description" : "", - "operationId" : "updateControllerServiceReferences", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The controller service id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The controller service request update request.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/UpdateControllerServiceReferenceRequestEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ControllerServiceReferencingComponentsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /{component-type}/{uuid} or /operate/{component-type}/{uuid} - For each referencing component specified" : [ ] - } ] - } - }, - "/controller-services/{id}/run-status" : { - "put" : { - "tags" : [ "controller-services" ], - "summary" : "Updates run status of a controller service", - "description" : "", - "operationId" : "updateRunStatus", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The controller service id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The controller service run status.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ControllerServiceRunStatusEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ControllerServiceEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /controller-services/{uuid} or /operation/controller-services/{uuid}" : [ ] - } ] - } - }, - "/controller-services/{id}/state" : { - "get" : { - "tags" : [ "controller-services" ], - "summary" : "Gets the state for a controller service", - "description" : "", - "operationId" : "getState", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The controller service id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ComponentStateEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /controller-services/{uuid}" : [ ] - } ] - } - }, - "/controller-services/{id}/state/clear-requests" : { - "post" : { - "tags" : [ "controller-services" ], - "summary" : "Clears the state for a controller service", - "description" : "", - "operationId" : "clearState", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The controller service id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ComponentStateEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /controller-services/{uuid}" : [ ] - } ] - } - }, - "/controller/bulletin" : { - "post" : { - "tags" : [ "controller" ], - "summary" : "Creates a new bulletin", - "description" : "", - "operationId" : "createBulletin", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The reporting task configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/BulletinEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /controller" : [ ] - } ] - } - }, - "/controller/cluster" : { - "get" : { - "tags" : [ "controller" ], - "summary" : "Gets the contents of the cluster", - "description" : "Returns the contents of the cluster including all nodes and their status.", - "operationId" : "getCluster", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ClusterEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /controller" : [ ] - } ] - } - }, - "/controller/cluster/nodes/{id}" : { - "get" : { - "tags" : [ "controller" ], - "summary" : "Gets a node in the cluster", - "description" : "", - "operationId" : "getNode", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The node id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/NodeEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /controller" : [ ] - } ] - }, - "put" : { - "tags" : [ "controller" ], - "summary" : "Updates a node in the cluster", - "description" : "", - "operationId" : "updateNode", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The node id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The node configuration. The only configuration that will be honored at this endpoint is the status.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/NodeEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/NodeEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /controller" : [ ] - } ] - }, - "delete" : { - "tags" : [ "controller" ], - "summary" : "Removes a node from the cluster", - "description" : "", - "operationId" : "deleteNode", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The node id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/NodeEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /controller" : [ ] - } ] - } - }, - "/controller/config" : { - "get" : { - "tags" : [ "controller" ], - "summary" : "Retrieves the configuration for this NiFi Controller", - "description" : "", - "operationId" : "getControllerConfig", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ControllerConfigurationEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /controller" : [ ] - } ] - }, - "put" : { - "tags" : [ "controller" ], - "summary" : "Retrieves the configuration for this NiFi", - "description" : "", - "operationId" : "updateControllerConfig", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The controller configuration.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ControllerConfigurationEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ControllerConfigurationEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /controller" : [ ] - } ] - } - }, - "/controller/controller-services" : { - "post" : { - "tags" : [ "controller" ], - "summary" : "Creates a new controller service", - "description" : "", - "operationId" : "createControllerService", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The controller service configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ControllerServiceEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ControllerServiceEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /controller" : [ ] - }, { - "Read - any referenced Controller Services - /controller-services/{uuid}" : [ ] - }, { - "Write - if the Controller Service is restricted - /restricted-components" : [ ] - } ] - } - }, - "/controller/history" : { - "delete" : { - "tags" : [ "controller" ], - "summary" : "Purges history", - "description" : "", - "operationId" : "deleteHistory", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "endDate", - "in" : "query", - "description" : "Purge actions before this date/time.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/HistoryEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /controller" : [ ] - } ] - } - }, - "/controller/parameter-providers" : { - "post" : { - "tags" : [ "controller" ], - "summary" : "Creates a new parameter provider", - "description" : "", - "operationId" : "createParameterProvider", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The parameter provider configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ParameterProviderEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/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. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /controller" : [ ] - }, { - "Read - any referenced Controller Services - /controller-services/{uuid}" : [ ] - }, { - "Write - if the Parameter Provider is restricted - /restricted-components" : [ ] - } ] - } - }, - "/controller/registry-clients" : { - "get" : { - "tags" : [ "controller" ], - "summary" : "Gets the listing of available flow registry clients", - "description" : "", - "operationId" : "getFlowRegistryClients", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/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. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - }, - "post" : { - "tags" : [ "controller" ], - "summary" : "Creates a new flow registry client", - "description" : "", - "operationId" : "createFlowRegistryClient", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The flow registry client configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/FlowRegistryClientEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/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. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /controller" : [ ] - } ] - } - }, - "/controller/registry-clients/{id}" : { - "get" : { - "tags" : [ "controller" ], - "summary" : "Gets a flow registry client", - "description" : "", - "operationId" : "getFlowRegistryClient", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The flow registry client id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/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. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /controller" : [ ] - } ] - }, - "put" : { - "tags" : [ "controller" ], - "summary" : "Updates a flow registry client", - "description" : "", - "operationId" : "updateFlowRegistryClient", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The flow registry client id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The flow registry client configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/FlowRegistryClientEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/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. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /controller" : [ ] - } ] - }, - "delete" : { - "tags" : [ "controller" ], - "summary" : "Deletes a flow registry client", - "description" : "", - "operationId" : "deleteFlowRegistryClient", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The revision is used to verify the client is working with the latest version of the flow.", - "required" : false, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The flow registry client id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/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. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /controller" : [ ] - } ] - } - }, - "/controller/registry-clients/{id}/descriptors" : { - "get" : { - "tags" : [ "controller" ], - "summary" : "Gets a flow registry client property descriptor", - "description" : "", - "operationId" : "getPropertyDescriptor", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The flow registry client id.", - "required" : true, - "type" : "string" - }, { - "name" : "propertyName", - "in" : "query", - "description" : "The property name.", - "required" : true, - "type" : "string" - }, { - "name" : "sensitive", - "in" : "query", - "description" : "Property Descriptor requested sensitive status", - "required" : false, - "type" : "boolean", - "default" : false - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/PropertyDescriptorEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /controller/registry-clients/{uuid}" : [ ] - } ] - } - }, - "/controller/registry-types" : { - "get" : { - "tags" : [ "controller" ], - "summary" : "Retrieves the types of flow that this NiFi supports", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getRegistryClientTypes", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/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. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/controller/reporting-tasks" : { - "post" : { - "tags" : [ "controller" ], - "summary" : "Creates a new reporting task", - "description" : "", - "operationId" : "createReportingTask", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The reporting task configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ReportingTaskEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ReportingTaskEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /controller" : [ ] - }, { - "Read - any referenced Controller Services - /controller-services/{uuid}" : [ ] - }, { - "Write - if the Reporting Task is restricted - /restricted-components" : [ ] - } ] - } - }, - "/controller/status/history" : { - "get" : { - "tags" : [ "controller" ], - "summary" : "Gets status history for the node", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getNodeStatusHistory", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ComponentHistoryEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /controller" : [ ] - } ] - } - }, - "/counters" : { - "get" : { - "tags" : [ "counters" ], - "summary" : "Gets the current counters for this NiFi", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getCounters", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "nodewise", - "in" : "query", - "description" : "Whether or not to include the breakdown per node. Optional, defaults to false", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "clusterNodeId", - "in" : "query", - "description" : "The id of the node where to get the status.", - "required" : false, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/CountersEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /counters" : [ ] - } ] - } - }, - "/counters/{id}" : { - "put" : { - "tags" : [ "counters" ], - "summary" : "Updates the specified counter. This will reset the counter value to 0", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "updateCounter", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The id of the counter.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/CounterEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /counters" : [ ] - } ] - } - }, - "/data-transfer/input-ports/{portId}/transactions/{transactionId}" : { - "put" : { - "tags" : [ "data-transfer" ], - "summary" : "Extend transaction TTL", - "description" : "", - "operationId" : "extendInputPortTransactionTTL", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "portId", - "in" : "path", - "required" : true, - "type" : "string" - }, { - "name" : "transactionId", - "in" : "path", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/TransactionResultEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /data-transfer/input-ports/{uuid}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "data-transfer" ], - "summary" : "Commit or cancel the specified transaction", - "description" : "", - "operationId" : "commitInputPortTransaction", - "consumes" : [ "application/octet-stream" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "responseCode", - "in" : "query", - "description" : "The response code. Available values are BAD_CHECKSUM(19), CONFIRM_TRANSACTION(12) or CANCEL_TRANSACTION(15).", - "required" : true, - "type" : "integer", - "format" : "int32" - }, { - "name" : "portId", - "in" : "path", - "description" : "The input port id.", - "required" : true, - "type" : "string" - }, { - "name" : "transactionId", - "in" : "path", - "description" : "The transaction id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/TransactionResultEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - }, - "503" : { - "description" : "NiFi instance is not ready for serving request, or temporarily overloaded. Retrying the same request later may be successful" - } - }, - "security" : [ { - "Write - /data-transfer/input-ports/{uuid}" : [ ] - } ] - } - }, - "/data-transfer/input-ports/{portId}/transactions/{transactionId}/flow-files" : { - "post" : { - "tags" : [ "data-transfer" ], - "summary" : "Transfer flow files to the input port", - "description" : "", - "operationId" : "receiveFlowFiles", - "consumes" : [ "application/octet-stream" ], - "produces" : [ "text/plain" ], - "parameters" : [ { - "name" : "portId", - "in" : "path", - "description" : "The input port id.", - "required" : true, - "type" : "string" - }, { - "name" : "transactionId", - "in" : "path", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - }, - "503" : { - "description" : "NiFi instance is not ready for serving request, or temporarily overloaded. Retrying the same request later may be successful" - } - }, - "security" : [ { - "Write - /data-transfer/input-ports/{uuid}" : [ ] - } ] - } - }, - "/data-transfer/output-ports/{portId}/transactions/{transactionId}" : { - "put" : { - "tags" : [ "data-transfer" ], - "summary" : "Extend transaction TTL", - "description" : "", - "operationId" : "extendOutputPortTransactionTTL", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "portId", - "in" : "path", - "required" : true, - "type" : "string" - }, { - "name" : "transactionId", - "in" : "path", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/TransactionResultEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - }, - "503" : { - "description" : "NiFi instance is not ready for serving request, or temporarily overloaded. Retrying the same request later may be successful" - } - }, - "security" : [ { - "Write - /data-transfer/output-ports/{uuid}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "data-transfer" ], - "summary" : "Commit or cancel the specified transaction", - "description" : "", - "operationId" : "commitOutputPortTransaction", - "consumes" : [ "application/octet-stream" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "responseCode", - "in" : "query", - "description" : "The response code. Available values are CONFIRM_TRANSACTION(12) or CANCEL_TRANSACTION(15).", - "required" : true, - "type" : "integer", - "format" : "int32" - }, { - "name" : "checksum", - "in" : "query", - "description" : "A checksum calculated at client side using CRC32 to check flow file content integrity. It must match with the value calculated at server side.", - "required" : true, - "type" : "string" - }, { - "name" : "portId", - "in" : "path", - "description" : "The output port id.", - "required" : true, - "type" : "string" - }, { - "name" : "transactionId", - "in" : "path", - "description" : "The transaction id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/TransactionResultEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - }, - "503" : { - "description" : "NiFi instance is not ready for serving request, or temporarily overloaded. Retrying the same request later may be successful" - } - }, - "security" : [ { - "Write - /data-transfer/output-ports/{uuid}" : [ ] - } ] - } - }, - "/data-transfer/output-ports/{portId}/transactions/{transactionId}/flow-files" : { - "get" : { - "tags" : [ "data-transfer" ], - "summary" : "Transfer flow files from the output port", - "description" : "", - "operationId" : "transferFlowFiles", - "consumes" : [ "*/*" ], - "produces" : [ "application/octet-stream" ], - "parameters" : [ { - "name" : "portId", - "in" : "path", - "description" : "The output port id.", - "required" : true, - "type" : "string" - }, { - "name" : "transactionId", - "in" : "path", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "There is no flow file to return.", - "schema" : { - "$ref" : "#/definitions/StreamingOutput" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - }, - "503" : { - "description" : "NiFi instance is not ready for serving request, or temporarily overloaded. Retrying the same request later may be successful" - } - }, - "security" : [ { - "Write - /data-transfer/output-ports/{uuid}" : [ ] - } ] - } - }, - "/data-transfer/{portType}/{portId}/transactions" : { - "post" : { - "tags" : [ "data-transfer" ], - "summary" : "Create a transaction to the specified output port or input port", - "description" : "", - "operationId" : "createPortTransaction", - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "portType", - "in" : "path", - "description" : "The port type.", - "required" : true, - "type" : "string", - "enum" : [ "input-ports", "output-ports" ] - }, { - "name" : "portId", - "in" : "path", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/TransactionResultEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - }, - "503" : { - "description" : "NiFi instance is not ready for serving request, or temporarily overloaded. Retrying the same request later may be successful" - } - }, - "security" : [ { - "Write - /data-transfer/{component-type}/{uuid}" : [ ] - } ] - } - }, - "/flow/about" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Retrieves details about this NiFi to put in the About dialog", - "description" : "", - "operationId" : "getAboutInfo", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/AboutEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/banners" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Retrieves the banners for this NiFi", - "description" : "", - "operationId" : "getBanners", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/BannerEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/bulletin-board" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets current bulletins", - "description" : "", - "operationId" : "getBulletinBoard", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "after", - "in" : "query", - "description" : "Includes bulletins with an id after this value.", - "required" : false, - "type" : "string" - }, { - "name" : "sourceName", - "in" : "query", - "description" : "Includes bulletins originating from this sources whose name match this regular expression.", - "required" : false, - "type" : "string" - }, { - "name" : "message", - "in" : "query", - "description" : "Includes bulletins whose message that match this regular expression.", - "required" : false, - "type" : "string" - }, { - "name" : "sourceId", - "in" : "query", - "description" : "Includes bulletins originating from this sources whose id match this regular expression.", - "required" : false, - "type" : "string" - }, { - "name" : "groupId", - "in" : "query", - "description" : "Includes bulletins originating from this sources whose group id match this regular expression.", - "required" : false, - "type" : "string" - }, { - "name" : "limit", - "in" : "query", - "description" : "The number of bulletins to limit the response to.", - "required" : false, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/BulletinBoardEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - }, { - "Read - /{component-type}/{uuid} - For component specific bulletins" : [ ] - } ] - } - }, - "/flow/client-id" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Generates a client id.", - "description" : "", - "operationId" : "generateClientId", - "consumes" : [ "*/*" ], - "produces" : [ "text/plain" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/cluster/search-results" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Searches the cluster for a node with the specified address", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "searchCluster", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "q", - "in" : "query", - "description" : "Node address to search for.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ClusterSearchResultsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/cluster/summary" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "The cluster summary for this NiFi", - "description" : "", - "operationId" : "getClusterSummary", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ClusteSummaryEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/config" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Retrieves the configuration for this NiFi flow", - "description" : "", - "operationId" : "getFlowConfig", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/FlowConfigurationEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/connections/{id}/statistics" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets statistics for a connection", - "description" : "", - "operationId" : "getConnectionStatistics", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "nodewise", - "in" : "query", - "description" : "Whether or not to include the breakdown per node. Optional, defaults to false", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "clusterNodeId", - "in" : "query", - "description" : "The id of the node where to get the statistics.", - "required" : false, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The connection id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ConnectionStatisticsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/connections/{id}/status" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets status for a connection", - "description" : "", - "operationId" : "getConnectionStatus", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "nodewise", - "in" : "query", - "description" : "Whether or not to include the breakdown per node. Optional, defaults to false", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "clusterNodeId", - "in" : "query", - "description" : "The id of the node where to get the status.", - "required" : false, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The connection id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ConnectionStatusEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/connections/{id}/status/history" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets the status history for a connection", - "description" : "", - "operationId" : "getConnectionStatusHistory", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The connection id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/StatusHistoryEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/controller-service-types" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Retrieves the types of controller services that this NiFi supports", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getControllerServiceTypes", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "serviceType", - "in" : "query", - "description" : "If specified, will only return controller services that are compatible with this type of service.", - "required" : false, - "type" : "string" - }, { - "name" : "serviceBundleGroup", - "in" : "query", - "description" : "If serviceType specified, is the bundle group of the serviceType.", - "required" : false, - "type" : "string" - }, { - "name" : "serviceBundleArtifact", - "in" : "query", - "description" : "If serviceType specified, is the bundle artifact of the serviceType.", - "required" : false, - "type" : "string" - }, { - "name" : "serviceBundleVersion", - "in" : "query", - "description" : "If serviceType specified, is the bundle version of the serviceType.", - "required" : false, - "type" : "string" - }, { - "name" : "bundleGroupFilter", - "in" : "query", - "description" : "If specified, will only return types that are a member of this bundle group.", - "required" : false, - "type" : "string" - }, { - "name" : "bundleArtifactFilter", - "in" : "query", - "description" : "If specified, will only return types that are a member of this bundle artifact.", - "required" : false, - "type" : "string" - }, { - "name" : "typeFilter", - "in" : "query", - "description" : "If specified, will only return types whose fully qualified classname matches.", - "required" : false, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ControllerServiceTypesEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/controller/bulletins" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Retrieves Controller level bulletins", - "description" : "", - "operationId" : "getBulletins", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ControllerBulletinsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - }, { - "Read - /controller - For controller bulletins" : [ ] - }, { - "Read - /controller-services/{uuid} - For controller service bulletins" : [ ] - }, { - "Read - /reporting-tasks/{uuid} - For reporting task bulletins" : [ ] - } ] - } - }, - "/flow/controller/controller-services" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets controller services for reporting tasks", - "description" : "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", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "uiOnly", - "in" : "query", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "includeReferencingComponents", - "in" : "query", - "description" : "Whether or not to include services' referencing components in the response", - "required" : false, - "type" : "boolean", - "default" : true - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ControllerServicesEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/current-user" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Retrieves the user identity of the user making the request", - "description" : "", - "operationId" : "getCurrentUser", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/CurrentUserEntity" - } - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/history" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets configuration history", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "queryHistory", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "offset", - "in" : "query", - "description" : "The offset into the result set.", - "required" : true, - "type" : "string" - }, { - "name" : "count", - "in" : "query", - "description" : "The number of actions to return.", - "required" : true, - "type" : "string" - }, { - "name" : "sortColumn", - "in" : "query", - "description" : "The field to sort on.", - "required" : false, - "type" : "string" - }, { - "name" : "sortOrder", - "in" : "query", - "description" : "The direction to sort.", - "required" : false, - "type" : "string" - }, { - "name" : "startDate", - "in" : "query", - "description" : "Include actions after this date.", - "required" : false, - "type" : "string" - }, { - "name" : "endDate", - "in" : "query", - "description" : "Include actions before this date.", - "required" : false, - "type" : "string" - }, { - "name" : "userIdentity", - "in" : "query", - "description" : "Include actions performed by this user.", - "required" : false, - "type" : "string" - }, { - "name" : "sourceId", - "in" : "query", - "description" : "Include actions on this component.", - "required" : false, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/HistoryEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/history/components/{componentId}" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets configuration history for a component", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getComponentHistory", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "componentId", - "in" : "path", - "description" : "The component id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ComponentHistoryEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - }, { - "Read underlying component - /{component-type}/{uuid}" : [ ] - } ] - } - }, - "/flow/history/{id}" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets an action", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getAction", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The action id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ActionEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/input-ports/{id}/status" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets status for an input port", - "description" : "", - "operationId" : "getInputPortStatus", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "nodewise", - "in" : "query", - "description" : "Whether or not to include the breakdown per node. Optional, defaults to false", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "clusterNodeId", - "in" : "query", - "description" : "The id of the node where to get the status.", - "required" : false, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The input port id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/PortStatusEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/metrics/{producer}" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets all metrics for the flow from a particular node", - "description" : "", - "operationId" : "getFlowMetrics", - "consumes" : [ "*/*" ], - "produces" : [ "*/*" ], - "parameters" : [ { - "name" : "producer", - "in" : "path", - "description" : "The producer for flow file metrics. Each producer may have its own output format.", - "required" : true, - "type" : "string", - "enum" : [ "prometheus" ] - }, { - "name" : "includedRegistries", - "in" : "query", - "description" : "Set of included metrics registries", - "required" : false, - "type" : "array", - "items" : { - "type" : "string", - "enum" : [ "NIFI", "JVM", "BULLETIN", "CONNECTION" ] - }, - "collectionFormat" : "multi" - }, { - "name" : "sampleName", - "in" : "query", - "description" : "Regular Expression Pattern to be applied against the sample name field", - "required" : false, - "type" : "string" - }, { - "name" : "sampleLabelValue", - "in" : "query", - "description" : "Regular Expression Pattern to be applied against the sample label value field", - "required" : false, - "type" : "string" - }, { - "name" : "rootFieldName", - "in" : "query", - "description" : "Name of the first field of JSON object. Applicable for JSON producer only.", - "required" : false, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/StreamingOutput" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/output-ports/{id}/status" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets status for an output port", - "description" : "", - "operationId" : "getOutputPortStatus", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "nodewise", - "in" : "query", - "description" : "Whether or not to include the breakdown per node. Optional, defaults to false", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "clusterNodeId", - "in" : "query", - "description" : "The id of the node where to get the status.", - "required" : false, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The output port id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/PortStatusEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/parameter-contexts" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets all Parameter Contexts", - "description" : "", - "operationId" : "getParameterContexts", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ParameterContextsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /parameter-contexts/{id} for each Parameter Context" : [ ] - } ] - } - }, - "/flow/parameter-provider-types" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Retrieves the types of parameter providers that this NiFi supports", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getParameterProviderTypes", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bundleGroupFilter", - "in" : "query", - "description" : "If specified, will only return types that are a member of this bundle group.", - "required" : false, - "type" : "string" - }, { - "name" : "bundleArtifactFilter", - "in" : "query", - "description" : "If specified, will only return types that are a member of this bundle artifact.", - "required" : false, - "type" : "string" - }, { - "name" : "type", - "in" : "query", - "description" : "If specified, will only return types whose fully qualified classname matches.", - "required" : false, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/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. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/parameter-providers" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets all parameter providers", - "description" : "", - "operationId" : "getParameterProviders", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/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. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/prioritizers" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Retrieves the types of prioritizers that this NiFi supports", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getPrioritizers", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/PrioritizerTypesEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/process-groups/{id}" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets a process group", - "description" : "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", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "name" : "uiOnly", - "in" : "query", - "required" : false, - "type" : "boolean", - "default" : false - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessGroupFlowEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - }, - "put" : { - "tags" : [ "flow" ], - "summary" : "Schedule or unschedule components in the specified Process Group.", - "description" : "", - "operationId" : "scheduleComponents", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The request to schedule or unschedule. If the comopnents in the request are not specified, all authorized components will be considered.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ScheduleComponentsEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ScheduleComponentsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - }, { - "Write - /{component-type}/{uuid} or /operation/{component-type}/{uuid} - For every component being scheduled/unscheduled" : [ ] - } ] - } - }, - "/flow/process-groups/{id}/controller-services" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets all controller services", - "description" : "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", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "name" : "includeAncestorGroups", - "in" : "query", - "description" : "Whether or not to include parent/ancestor process groups", - "required" : false, - "type" : "boolean", - "default" : true - }, { - "name" : "includeDescendantGroups", - "in" : "query", - "description" : "Whether or not to include descendant process groups", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "includeReferencingComponents", - "in" : "query", - "description" : "Whether or not to include services' referencing components in the response", - "required" : false, - "type" : "boolean", - "default" : true - }, { - "name" : "uiOnly", - "in" : "query", - "required" : false, - "type" : "boolean", - "default" : false - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ControllerServicesEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - }, - "put" : { - "tags" : [ "flow" ], - "summary" : "Enable or disable Controller Services in the specified Process Group.", - "description" : "", - "operationId" : "activateControllerServices", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The request to schedule or unschedule. If the comopnents in the request are not specified, all authorized components will be considered.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ActivateControllerServicesEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ActivateControllerServicesEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - }, { - "Write - /{component-type}/{uuid} or /operation/{component-type}/{uuid} - For every service being enabled/disabled" : [ ] - } ] - } - }, - "/flow/process-groups/{id}/status" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets the status for a process group", - "description" : "The status for a process group includes status for all descendent components. When invoked on the root group with recursive set to true, it will return the current status of every component in the flow.", - "operationId" : "getProcessGroupStatus", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "recursive", - "in" : "query", - "description" : "Whether all descendant groups and the status of their content will be included. Optional, defaults to false", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "nodewise", - "in" : "query", - "description" : "Whether or not to include the breakdown per node. Optional, defaults to false", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "clusterNodeId", - "in" : "query", - "description" : "The id of the node where to get the status.", - "required" : false, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessGroupStatusEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/process-groups/{id}/status/history" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets status history for a remote process group", - "description" : "", - "operationId" : "getProcessGroupStatusHistory", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/StatusHistoryEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/processor-types" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Retrieves the types of processors that this NiFi supports", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getProcessorTypes", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bundleGroupFilter", - "in" : "query", - "description" : "If specified, will only return types that are a member of this bundle group.", - "required" : false, - "type" : "string" - }, { - "name" : "bundleArtifactFilter", - "in" : "query", - "description" : "If specified, will only return types that are a member of this bundle artifact.", - "required" : false, - "type" : "string" - }, { - "name" : "type", - "in" : "query", - "description" : "If specified, will only return types whose fully qualified classname matches.", - "required" : false, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessorTypesEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/processors/{id}/status" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets status for a processor", - "description" : "", - "operationId" : "getProcessorStatus", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "nodewise", - "in" : "query", - "description" : "Whether or not to include the breakdown per node. Optional, defaults to false", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "clusterNodeId", - "in" : "query", - "description" : "The id of the node where to get the status.", - "required" : false, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The processor id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessorStatusEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/processors/{id}/status/history" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets status history for a processor", - "description" : "", - "operationId" : "getProcessorStatusHistory", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The processor id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/StatusHistoryEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/registries" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets the listing of available flow registry clients", - "description" : "", - "operationId" : "getRegistryClients", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/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. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/registries/{id}/buckets" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets the buckets from the specified registry for the current user", - "description" : "", - "operationId" : "getBuckets", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The registry id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/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. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/registries/{registry-id}/buckets/{bucket-id}/flows" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets the flows from the specified registry and bucket for the current user", - "description" : "", - "operationId" : "getFlows", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "registry-id", - "in" : "path", - "description" : "The registry client id.", - "required" : true, - "type" : "string" - }, { - "name" : "bucket-id", - "in" : "path", - "description" : "The bucket id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlowsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/registries/{registry-id}/buckets/{bucket-id}/flows/{flow-id}/details" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets the details of a flow from the specified registry and bucket for the specified flow for the current user", - "description" : "", - "operationId" : "getDetails", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "registry-id", - "in" : "path", - "description" : "The registry client id.", - "required" : true, - "type" : "string" - }, { - "name" : "bucket-id", - "in" : "path", - "description" : "The bucket id.", - "required" : true, - "type" : "string" - }, { - "name" : "flow-id", - "in" : "path", - "description" : "The flow id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/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. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/registries/{registry-id}/buckets/{bucket-id}/flows/{flow-id}/versions" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets the flow versions from the specified registry and bucket for the specified flow for the current user", - "description" : "", - "operationId" : "getVersions", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "registry-id", - "in" : "path", - "description" : "The registry client id.", - "required" : true, - "type" : "string" - }, { - "name" : "bucket-id", - "in" : "path", - "description" : "The bucket id.", - "required" : true, - "type" : "string" - }, { - "name" : "flow-id", - "in" : "path", - "description" : "The flow id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlowSnapshotMetadataSetEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/remote-process-groups/{id}/status" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets status for a remote process group", - "description" : "", - "operationId" : "getRemoteProcessGroupStatus", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "nodewise", - "in" : "query", - "description" : "Whether or not to include the breakdown per node. Optional, defaults to false", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "clusterNodeId", - "in" : "query", - "description" : "The id of the node where to get the status.", - "required" : false, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The remote process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/RemoteProcessGroupStatusEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/remote-process-groups/{id}/status/history" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets the status history", - "description" : "", - "operationId" : "getRemoteProcessGroupStatusHistory", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The remote process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/StatusHistoryEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/reporting-task-types" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Retrieves the types of reporting tasks that this NiFi supports", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getReportingTaskTypes", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bundleGroupFilter", - "in" : "query", - "description" : "If specified, will only return types that are a member of this bundle group.", - "required" : false, - "type" : "string" - }, { - "name" : "bundleArtifactFilter", - "in" : "query", - "description" : "If specified, will only return types that are a member of this bundle artifact.", - "required" : false, - "type" : "string" - }, { - "name" : "type", - "in" : "query", - "description" : "If specified, will only return types whose fully qualified classname matches.", - "required" : false, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ReportingTaskTypesEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/reporting-tasks" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets all reporting tasks", - "description" : "", - "operationId" : "getReportingTasks", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ReportingTasksEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/runtime-manifest" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Retrieves the runtime manifest for this NiFi instance.", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getRuntimeManifest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/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. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/search-results" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Performs a search against this NiFi using the specified search term", - "description" : "Only search results from authorized components will be returned.", - "operationId" : "searchFlow", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "q", - "in" : "query", - "required" : false, - "type" : "string" - }, { - "name" : "a", - "in" : "query", - "required" : false, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/SearchResultsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/status" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets the current status of this NiFi", - "description" : "", - "operationId" : "getControllerStatus", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ControllerStatusEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/templates" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets all templates", - "description" : "", - "operationId" : "getTemplates", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/TemplatesEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flowfile-queues/{id}/drop-requests" : { - "post" : { - "tags" : [ "flowfile-queues" ], - "summary" : "Creates a request to drop the contents of the queue in this connection.", - "description" : "", - "operationId" : "createDropRequest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The connection id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/DropRequestEntity" - } - }, - "202" : { - "description" : "The request has been accepted. A HTTP response header will contain the URI where the response can be polled." - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write Source Data - /data/{component-type}/{uuid}" : [ ] - } ] - } - }, - "/flowfile-queues/{id}/drop-requests/{drop-request-id}" : { - "get" : { - "tags" : [ "flowfile-queues" ], - "summary" : "Gets the current status of a drop request for the specified connection.", - "description" : "", - "operationId" : "getDropRequest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The connection id.", - "required" : true, - "type" : "string" - }, { - "name" : "drop-request-id", - "in" : "path", - "description" : "The drop request id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/DropRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write Source Data - /data/{component-type}/{uuid}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "flowfile-queues" ], - "summary" : "Cancels and/or removes a request to drop the contents of this connection.", - "description" : "", - "operationId" : "removeDropRequest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The connection id.", - "required" : true, - "type" : "string" - }, { - "name" : "drop-request-id", - "in" : "path", - "description" : "The drop request id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/DropRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write Source Data - /data/{component-type}/{uuid}" : [ ] - } ] - } - }, - "/flowfile-queues/{id}/flowfiles/{flowfile-uuid}" : { - "get" : { - "tags" : [ "flowfile-queues" ], - "summary" : "Gets a FlowFile from a Connection.", - "description" : "", - "operationId" : "getFlowFile", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The connection id.", - "required" : true, - "type" : "string" - }, { - "name" : "flowfile-uuid", - "in" : "path", - "description" : "The flowfile uuid.", - "required" : true, - "type" : "string" - }, { - "name" : "clusterNodeId", - "in" : "query", - "description" : "The id of the node where the content exists if clustered.", - "required" : false, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/FlowFileEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read Source Data - /data/{component-type}/{uuid}" : [ ] - } ] - } - }, - "/flowfile-queues/{id}/flowfiles/{flowfile-uuid}/content" : { - "get" : { - "tags" : [ "flowfile-queues" ], - "summary" : "Gets the content for a FlowFile in a Connection.", - "description" : "", - "operationId" : "downloadFlowFileContent", - "consumes" : [ "*/*" ], - "produces" : [ "*/*" ], - "parameters" : [ { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The connection id.", - "required" : true, - "type" : "string" - }, { - "name" : "flowfile-uuid", - "in" : "path", - "description" : "The flowfile uuid.", - "required" : true, - "type" : "string" - }, { - "name" : "clusterNodeId", - "in" : "query", - "description" : "The id of the node where the content exists if clustered.", - "required" : false, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/StreamingOutput" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read Source Data - /data/{component-type}/{uuid}" : [ ] - } ] - } - }, - "/flowfile-queues/{id}/listing-requests" : { - "post" : { - "tags" : [ "flowfile-queues" ], - "summary" : "Lists the contents of the queue in this connection.", - "description" : "", - "operationId" : "createFlowFileListing", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The connection id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ListingRequestEntity" - } - }, - "202" : { - "description" : "The request has been accepted. A HTTP response header will contain the URI where the response can be polled." - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read Source Data - /data/{component-type}/{uuid}" : [ ] - } ] - } - }, - "/flowfile-queues/{id}/listing-requests/{listing-request-id}" : { - "get" : { - "tags" : [ "flowfile-queues" ], - "summary" : "Gets the current status of a listing request for the specified connection.", - "description" : "", - "operationId" : "getListingRequest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The connection id.", - "required" : true, - "type" : "string" - }, { - "name" : "listing-request-id", - "in" : "path", - "description" : "The listing request id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ListingRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read Source Data - /data/{component-type}/{uuid}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "flowfile-queues" ], - "summary" : "Cancels and/or removes a request to list the contents of this connection.", - "description" : "", - "operationId" : "deleteListingRequest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The connection id.", - "required" : true, - "type" : "string" - }, { - "name" : "listing-request-id", - "in" : "path", - "description" : "The listing request id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ListingRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read Source Data - /data/{component-type}/{uuid}" : [ ] - } ] - } - }, - "/funnels/{id}" : { - "get" : { - "tags" : [ "funnel" ], - "summary" : "Gets a funnel", - "description" : "", - "operationId" : "getFunnel", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The funnel id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/FunnelEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /funnels/{uuid}" : [ ] - } ] - }, - "put" : { - "tags" : [ "funnel" ], - "summary" : "Updates a funnel", - "description" : "", - "operationId" : "updateFunnel", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The funnel id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The funnel configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/FunnelEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/FunnelEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /funnels/{uuid}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "funnel" ], - "summary" : "Deletes a funnel", - "description" : "", - "operationId" : "removeFunnel", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The revision is used to verify the client is working with the latest version of the flow.", - "required" : false, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The funnel id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/FunnelEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /funnels/{uuid}" : [ ] - }, { - "Write - Parent Process Group - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/input-ports/{id}" : { - "get" : { - "tags" : [ "input-ports" ], - "summary" : "Gets an input port", - "description" : "", - "operationId" : "getInputPort", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The input port id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/PortEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /input-ports/{uuid}" : [ ] - } ] - }, - "put" : { - "tags" : [ "input-ports" ], - "summary" : "Updates an input port", - "description" : "", - "operationId" : "updateInputPort", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The input port id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The input port configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/PortEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/PortEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /input-ports/{uuid}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "input-ports" ], - "summary" : "Deletes an input port", - "description" : "", - "operationId" : "removeInputPort", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The revision is used to verify the client is working with the latest version of the flow.", - "required" : false, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The input port id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/PortEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /input-ports/{uuid}" : [ ] - }, { - "Write - Parent Process Group - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/input-ports/{id}/run-status" : { - "put" : { - "tags" : [ "input-ports" ], - "summary" : "Updates run status of an input-port", - "description" : "", - "operationId" : "updateRunStatus", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The port id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The port run status.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/PortRunStatusEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessorEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /input-ports/{uuid} or /operation/input-ports/{uuid}" : [ ] - } ] - } - }, - "/labels/{id}" : { - "get" : { - "tags" : [ "labels" ], - "summary" : "Gets a label", - "description" : "", - "operationId" : "getLabel", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The label id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/LabelEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /labels/{uuid}" : [ ] - } ] - }, - "put" : { - "tags" : [ "labels" ], - "summary" : "Updates a label", - "description" : "", - "operationId" : "updateLabel", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The label id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The label configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/LabelEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/LabelEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /labels/{uuid}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "labels" ], - "summary" : "Deletes a label", - "description" : "", - "operationId" : "removeLabel", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The revision is used to verify the client is working with the latest version of the flow.", - "required" : false, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The label id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/LabelEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /labels/{uuid}" : [ ] - }, { - "Write - Parent Process Group - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/output-ports/{id}" : { - "get" : { - "tags" : [ "output-ports" ], - "summary" : "Gets an output port", - "description" : "", - "operationId" : "getOutputPort", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The output port id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/PortEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /output-ports/{uuid}" : [ ] - } ] - }, - "put" : { - "tags" : [ "output-ports" ], - "summary" : "Updates an output port", - "description" : "", - "operationId" : "updateOutputPort", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The output port id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The output port configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/PortEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/PortEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /output-ports/{uuid}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "output-ports" ], - "summary" : "Deletes an output port", - "description" : "", - "operationId" : "removeOutputPort", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The revision is used to verify the client is working with the latest version of the flow.", - "required" : false, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The output port id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/PortEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /output-ports/{uuid}" : [ ] - }, { - "Write - Parent Process Group - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/output-ports/{id}/run-status" : { - "put" : { - "tags" : [ "output-ports" ], - "summary" : "Updates run status of an output-port", - "description" : "", - "operationId" : "updateRunStatus", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The port id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The port run status.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/PortRunStatusEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessorEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /output-ports/{uuid} or /operation/output-ports/{uuid}" : [ ] - } ] - } - }, - "/parameter-contexts" : { - "post" : { - "tags" : [ "parameter-contexts" ], - "summary" : "Create a Parameter Context", - "description" : "", - "operationId" : "createParameterContext", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The Parameter Context.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ParameterContextEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ParameterContextEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /parameter-contexts" : [ ] - }, { - "Read - for every inherited parameter context" : [ ] - } ] - } - }, - "/parameter-contexts/{contextId}/update-requests" : { - "post" : { - "tags" : [ "parameter-contexts" ], - "summary" : "Initiate the Update Request of a Parameter Context", - "description" : "This will initiate the process of updating a Parameter Context. Changing the value of a Parameter may require that one or more components be stopped and restarted, so this 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", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "contextId", - "in" : "path", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The updated version of the parameter context.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ParameterContextEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ParameterContextUpdateRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /parameter-contexts/{parameterContextId}" : [ ] - }, { - "Write - /parameter-contexts/{parameterContextId}" : [ ] - }, { - "Read - for every component that is affected by the update" : [ ] - }, { - "Write - for every component that is affected by the update" : [ ] - }, { - "Read - for every currently inherited parameter context" : [ ] - }, { - "Read - for any new inherited parameter context" : [ ] - } ] - } - }, - "/parameter-contexts/{contextId}/update-requests/{requestId}" : { - "get" : { - "tags" : [ "parameter-contexts" ], - "summary" : "Returns the Update Request with the given ID", - "description" : "Returns the Update Request with the given ID. Once an Update Request has been created by performing a POST to /nifi-api/parameter-contexts, that request can subsequently be retrieved via this endpoint, and the request that is fetched will contain the updated state, such as percent complete, the current state of the request, and any failures. ", - "operationId" : "getParameterContextUpdate", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "contextId", - "in" : "path", - "description" : "The ID of the Parameter Context", - "required" : true, - "type" : "string" - }, { - "name" : "requestId", - "in" : "path", - "description" : "The ID of the Update Request", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ParameterContextUpdateRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Only the user that submitted the request can get it" : [ ] - } ] - }, - "delete" : { - "tags" : [ "parameter-contexts" ], - "summary" : "Deletes the Update Request with the given ID", - "description" : "Deletes the Update Request with the given ID. After a request is created via a POST to /nifi-api/parameter-contexts/update-requests, it is expected that the client will properly clean up the request by DELETE'ing it, once the Update process has completed. If the request is deleted before the request completes, then the Update request will finish the step that it is currently performing and then will cancel any subsequent steps.", - "operationId" : "deleteUpdateRequest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "contextId", - "in" : "path", - "description" : "The ID of the ParameterContext", - "required" : true, - "type" : "string" - }, { - "name" : "requestId", - "in" : "path", - "description" : "The ID of the Update Request", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ParameterContextUpdateRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Only the user that submitted the request can remove it" : [ ] - } ] - } - }, - "/parameter-contexts/{contextId}/validation-requests" : { - "post" : { - "tags" : [ "parameter-contexts" ], - "summary" : "Initiate a Validation Request to determine how the validity of components will change if a Parameter Context were to be updated", - "description" : "This will initiate the process of validating all components whose Process Group is bound to the specified Parameter Context. Performing validation against an arbitrary number of components may be expect and take significantly more time than many other REST API actions. As a result, this endpoint will immediately return a ParameterContextValidationRequestEntity, and the process of validating the necessary components will occur asynchronously in the background. The client may then periodically poll the status of the request by issuing a GET request to /parameter-contexts/validation-requests/{requestId}. Once the request is completed, the client is expected to issue a DELETE request to /parameter-contexts/validation-requests/{requestId}.", - "operationId" : "submitValidationRequest", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "contextId", - "in" : "path", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The validation request", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ParameterContextValidationRequestEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ParameterContextValidationRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /parameter-contexts/{parameterContextId}" : [ ] - } ] - } - }, - "/parameter-contexts/{contextId}/validation-requests/{id}" : { - "get" : { - "tags" : [ "parameter-contexts" ], - "summary" : "Returns the Validation Request with the given ID", - "description" : "Returns the Validation Request with the given ID. Once a Validation Request has been created by performing a POST to /nifi-api/validation-contexts, that request can subsequently be retrieved via this endpoint, and the request that is fetched will contain the updated state, such as percent complete, the current state of the request, and any failures. ", - "operationId" : "getValidationRequest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "contextId", - "in" : "path", - "description" : "The ID of the Parameter Context", - "required" : true, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The ID of the Validation Request", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ParameterContextValidationRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Only the user that submitted the request can get it" : [ ] - } ] - }, - "delete" : { - "tags" : [ "parameter-contexts" ], - "summary" : "Deletes the Validation Request with the given ID", - "description" : "Deletes the Validation Request with the given ID. After a request is created via a POST to /nifi-api/validation-contexts, it is expected that the client will properly clean up the request by DELETE'ing it, once the validation process has completed. If the request is deleted before the request completes, then the Validation request will finish the step that it is currently performing and then will cancel any subsequent steps.", - "operationId" : "deleteValidationRequest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "contextId", - "in" : "path", - "description" : "The ID of the Parameter Context", - "required" : true, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The ID of the Update Request", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ParameterContextValidationRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Only the user that submitted the request can remove it" : [ ] - } ] - } - }, - "/parameter-contexts/{id}" : { - "get" : { - "tags" : [ "parameter-contexts" ], - "summary" : "Returns the Parameter Context with the given ID", - "description" : "Returns the Parameter Context with the given ID.", - "operationId" : "getParameterContext", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The ID of the Parameter Context", - "required" : true, - "type" : "string" - }, { - "name" : "includeInheritedParameters", - "in" : "query", - "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.", - "required" : false, - "type" : "boolean", - "default" : false - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ParameterContextEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /parameter-contexts/{id}" : [ ] - } ] - }, - "put" : { - "tags" : [ "parameter-contexts" ], - "summary" : "Modifies a Parameter Context", - "description" : "This endpoint will update a Parameter Context to match the provided entity. However, this request will fail if any component is running and is referencing a Parameter in the Parameter Context. Generally, this endpoint is not called directly. Instead, an update request should be submitted by making a POST to the /parameter-contexts/update-requests endpoint. That endpoint will, in turn, call this endpoint.", - "operationId" : "updateParameterContext", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The updated Parameter Context", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ParameterContextEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ParameterContextEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /parameter-contexts/{id}" : [ ] - }, { - "Write - /parameter-contexts/{id}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "parameter-contexts" ], - "summary" : "Deletes the Parameter Context with the given ID", - "description" : "Deletes the Parameter Context with the given ID.", - "operationId" : "deleteParameterContext", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The version is used to verify the client is working with the latest version of the flow.", - "required" : false, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, a new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The Parameter Context ID.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ParameterContextEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /parameter-contexts/{uuid}" : [ ] - }, { - "Write - /parameter-contexts/{uuid}" : [ ] - }, { - "Read - /process-groups/{uuid}, for any Process Group that is currently bound to the Parameter Context" : [ ] - }, { - "Write - /process-groups/{uuid}, for any Process Group that is currently bound to the Parameter Context" : [ ] - } ] - } - }, - "/parameter-providers/{id}" : { - "get" : { - "tags" : [ "parameter-providers" ], - "summary" : "Gets a parameter provider", - "description" : "", - "operationId" : "getParameterProvider", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The parameter provider id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/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. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /parameter-providers/{uuid}" : [ ] - } ] - }, - "put" : { - "tags" : [ "parameter-providers" ], - "summary" : "Updates a parameter provider", - "description" : "", - "operationId" : "updateParameterProvider", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The parameter provider id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The parameter provider configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ParameterProviderEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/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. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /parameter-providers/{uuid}" : [ ] - }, { - "Read - any referenced Controller Services if this request changes the reference - /controller-services/{uuid}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "parameter-providers" ], - "summary" : "Deletes a parameter provider", - "description" : "", - "operationId" : "removeParameterProvider", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The revision is used to verify the client is working with the latest version of the flow.", - "required" : false, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The parameter provider id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/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. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /parameter-providers/{uuid}" : [ ] - }, { - "Write - /controller" : [ ] - }, { - "Read - any referenced Controller Services - /controller-services/{uuid}" : [ ] - } ] - } - }, - "/parameter-providers/{id}/config/analysis" : { - "post" : { - "tags" : [ "parameter-providers" ], - "summary" : "Performs analysis of the component's configuration, providing information about which attributes are referenced.", - "description" : "", - "operationId" : "analyzeConfiguration", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The parameter provider id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The configuration analysis request.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ConfigurationAnalysisEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/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. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /parameter-providers/{uuid}" : [ ] - } ] - } - }, - "/parameter-providers/{id}/config/verification-requests" : { - "post" : { - "tags" : [ "parameter-providers" ], - "summary" : "Performs verification of the Parameter Provider's configuration", - "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", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The parameter provider id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The parameter provider configuration verification request.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/VerifyConfigRequestEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/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. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /parameter-providers/{uuid}" : [ ] - } ] - } - }, - "/parameter-providers/{id}/config/verification-requests/{requestId}" : { - "get" : { - "tags" : [ "parameter-providers" ], - "summary" : "Returns the Verification Request with the given ID", - "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", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The ID of the Parameter Provider", - "required" : true, - "type" : "string" - }, { - "name" : "requestId", - "in" : "path", - "description" : "The ID of the Verification Request", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/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. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Only the user that submitted the request can get it" : [ ] - } ] - }, - "delete" : { - "tags" : [ "parameter-providers" ], - "summary" : "Deletes the Verification Request with the given ID", - "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", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The ID of the Parameter Provider", - "required" : true, - "type" : "string" - }, { - "name" : "requestId", - "in" : "path", - "description" : "The ID of the Verification Request", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/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. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Only the user that submitted the request can remove it" : [ ] - } ] - } - }, - "/parameter-providers/{id}/descriptors" : { - "get" : { - "tags" : [ "parameter-providers" ], - "summary" : "Gets a parameter provider property descriptor", - "description" : "", - "operationId" : "getPropertyDescriptor", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The parameter provider id.", - "required" : true, - "type" : "string" - }, { - "name" : "propertyName", - "in" : "query", - "description" : "The property name.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/PropertyDescriptorEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /parameter-providers/{uuid}" : [ ] - } ] - } - }, - "/parameter-providers/{id}/parameters/fetch-requests" : { - "post" : { - "tags" : [ "parameter-providers" ], - "summary" : "Fetches and temporarily caches the parameters for a provider", - "description" : "", - "operationId" : "fetchParameters", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The parameter provider id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The parameter fetch request.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ParameterProviderParameterFetchEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/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. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /parameter-providers/{uuid} or or /operation/parameter-providers/{uuid}" : [ ] - } ] - } - }, - "/parameter-providers/{id}/references" : { - "get" : { - "tags" : [ "parameter-providers" ], - "summary" : "Gets all references to a parameter provider", - "description" : "", - "operationId" : "getParameterProviderReferences", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The parameter provider id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/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. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /parameter-providers/{uuid}" : [ ] - } ] - } - }, - "/parameter-providers/{id}/state" : { - "get" : { - "tags" : [ "parameter-providers" ], - "summary" : "Gets the state for a parameter provider", - "description" : "", - "operationId" : "getState", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The parameter provider id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ComponentStateEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /parameter-providers/{uuid}" : [ ] - } ] - } - }, - "/parameter-providers/{id}/state/clear-requests" : { - "post" : { - "tags" : [ "parameter-providers" ], - "summary" : "Clears the state for a parameter provider", - "description" : "", - "operationId" : "clearState", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The parameter provider id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ComponentStateEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /parameter-providers/{uuid}" : [ ] - } ] - } - }, - "/parameter-providers/{providerId}/apply-parameters-requests" : { - "post" : { - "tags" : [ "parameter-providers" ], - "summary" : "Initiate a request to apply the fetched parameters of a Parameter Provider", - "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", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "providerId", - "in" : "path", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The apply parameters request.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ParameterProviderParameterApplicationEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/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. Retrying the same request later may be successful." - } - }, - "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" : [ ] - } ] - } - }, - "/parameter-providers/{providerId}/apply-parameters-requests/{requestId}" : { - "get" : { - "tags" : [ "parameter-providers" ], - "summary" : "Returns the Apply Parameters Request with the given ID", - "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", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "providerId", - "in" : "path", - "description" : "The ID of the Parameter Provider", - "required" : true, - "type" : "string" - }, { - "name" : "requestId", - "in" : "path", - "description" : "The ID of the Apply Parameters Request", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/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. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Only the user that submitted the request can get it" : [ ] - } ] - }, - "delete" : { - "tags" : [ "parameter-providers" ], - "summary" : "Deletes the Apply Parameters Request with the given ID", - "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", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "providerId", - "in" : "path", - "description" : "The ID of the Parameter Provider", - "required" : true, - "type" : "string" - }, { - "name" : "requestId", - "in" : "path", - "description" : "The ID of the Apply Parameters Request", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/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. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Only the user that submitted the request can remove it" : [ ] - } ] - } - }, - "/policies" : { - "post" : { - "tags" : [ "policies" ], - "summary" : "Creates an access policy", - "description" : "", - "operationId" : "createAccessPolicy", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The access policy configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/AccessPolicyEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/AccessPolicyEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /policies/{resource}" : [ ] - } ] - } - }, - "/policies/{action}/{resource}" : { - "get" : { - "tags" : [ "policies" ], - "summary" : "Gets an access policy for the specified action and resource", - "description" : "Will return the effective policy if no component specific policy exists for the specified action and resource. Must have Read permissions to the policy with the desired action and resource. Permissions for the policy that is returned will be indicated in the response. This means the client could be authorized to get the policy for a given component but the effective policy may be inherited from an ancestor Process Group. If the client does not have permissions to that policy, the response will not include the policy and the permissions in the response will be marked accordingly. If the client does not have permissions to the policy of the desired action and resource a 403 response will be returned.", - "operationId" : "getAccessPolicyForResource", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "action", - "in" : "path", - "description" : "The request action.", - "required" : true, - "type" : "string", - "enum" : [ "read", "write" ] - }, { - "name" : "resource", - "in" : "path", - "description" : "The resource of the policy.", - "required" : true, - "type" : "string", - "pattern" : ".+" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/AccessPolicyEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /policies/{resource}" : [ ] - } ] - } - }, - "/policies/{id}" : { - "get" : { - "tags" : [ "policies" ], - "summary" : "Gets an access policy", - "description" : "", - "operationId" : "getAccessPolicy", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The access policy id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/AccessPolicyEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /policies/{resource}" : [ ] - } ] - }, - "put" : { - "tags" : [ "policies" ], - "summary" : "Updates a access policy", - "description" : "", - "operationId" : "updateAccessPolicy", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The access policy id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The access policy configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/AccessPolicyEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/AccessPolicyEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /policies/{resource}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "policies" ], - "summary" : "Deletes an access policy", - "description" : "", - "operationId" : "removeAccessPolicy", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The revision is used to verify the client is working with the latest version of the flow.", - "required" : false, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The access policy id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/AccessPolicyEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /policies/{resource}" : [ ] - }, { - "Write - Policy of the parent resource - /policies/{resource}" : [ ] - } ] - } - }, - "/process-groups/replace-requests/{id}" : { - "get" : { - "tags" : [ "process-groups" ], - "summary" : "Returns the Replace Request with the given ID", - "description" : "Returns the Replace Request with the given ID. Once a Replace Request has been created by performing a POST to /process-groups/{id}/replace-requests, that request can subsequently be retrieved via this endpoint, and the request that is fetched will contain the updated state, such as percent complete, the current state of the request, and any failures. Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getReplaceProcessGroupRequest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The ID of the Replace Request", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessGroupReplaceRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Only the user that submitted the request can get it" : [ ] - } ] - }, - "delete" : { - "tags" : [ "process-groups" ], - "summary" : "Deletes the Replace Request with the given ID", - "description" : "Deletes the Replace Request with the given ID. After a request is created via a POST to /process-groups/{id}/replace-requests, it is expected that the client will properly clean up the request by DELETE'ing it, once the Replace process has completed. If the request is deleted before the request completes, then the Replace request will finish the step that it is currently performing and then will cancel any subsequent steps. Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "deleteReplaceProcessGroupRequest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The ID of the Update Request", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessGroupReplaceRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Only the user that submitted the request can remove it" : [ ] - } ] - } - }, - "/process-groups/{groupId}/variable-registry/update-requests/{updateId}" : { - "get" : { - "tags" : [ "process-groups" ], - "summary" : "Gets a process group's variable registry", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getVariableRegistryUpdateRequest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "groupId", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "name" : "updateId", - "in" : "path", - "description" : "The ID of the Variable Registry Update Request", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VariableRegistryUpdateRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "process-groups" ], - "summary" : "Deletes an update request for a process group's variable registry. If the request is not yet complete, it will automatically be cancelled.", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "deleteVariableRegistryUpdateRequest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "groupId", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "name" : "updateId", - "in" : "path", - "description" : "The ID of the Variable Registry Update Request", - "required" : true, - "type" : "string" - }, { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VariableRegistryUpdateRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/process-groups/{id}" : { - "get" : { - "tags" : [ "process-groups" ], - "summary" : "Gets a process group", - "description" : "", - "operationId" : "getProcessGroup", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessGroupEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - } ] - }, - "put" : { - "tags" : [ "process-groups" ], - "summary" : "Updates a process group", - "description" : "", - "operationId" : "updateProcessGroup", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The process group configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ProcessGroupEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessGroupEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "process-groups" ], - "summary" : "Deletes a process group", - "description" : "", - "operationId" : "removeProcessGroup", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The revision is used to verify the client is working with the latest version of the flow.", - "required" : false, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessGroupEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - }, { - "Write - Parent Process Group - /process-groups/{uuid}" : [ ] - }, { - "Read - any referenced Controller Services by any encapsulated components - /controller-services/{uuid}" : [ ] - }, { - "Write - /{component-type}/{uuid} - For all encapsulated components" : [ ] - } ] - } - }, - "/process-groups/{id}/connections" : { - "get" : { - "tags" : [ "process-groups" ], - "summary" : "Gets all connections", - "description" : "", - "operationId" : "getConnections", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ConnectionsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - } ] - }, - "post" : { - "tags" : [ "process-groups" ], - "summary" : "Creates a connection", - "description" : "", - "operationId" : "createConnection", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The connection configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ConnectionEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ConnectionEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - }, { - "Write Source - /{component-type}/{uuid}" : [ ] - }, { - "Write Destination - /{component-type}/{uuid}" : [ ] - } ] - } - }, - "/process-groups/{id}/controller-services" : { - "post" : { - "tags" : [ "process-groups" ], - "summary" : "Creates a new controller service", - "description" : "", - "operationId" : "createControllerService", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The controller service configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ControllerServiceEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ControllerServiceEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - }, { - "Read - any referenced Controller Services - /controller-services/{uuid}" : [ ] - }, { - "Write - if the Controller Service is restricted - /restricted-components" : [ ] - } ] - } - }, - "/process-groups/{id}/download" : { - "get" : { - "tags" : [ "process-groups" ], - "summary" : "Gets a process group for download", - "description" : "", - "operationId" : "exportProcessGroup", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "name" : "includeReferencedServices", - "in" : "query", - "description" : "If referenced services from outside the target group should be included", - "required" : false, - "type" : "boolean", - "default" : false - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/process-groups/{id}/empty-all-connections-requests" : { - "post" : { - "tags" : [ "process-groups" ], - "summary" : "Creates a request to drop all flowfiles of all connection queues in this process group.", - "description" : "", - "operationId" : "createEmptyAllConnectionsRequest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/DropRequestEntity" - } - }, - "202" : { - "description" : "The request has been accepted. An HTTP response header will contain the URI where the status can be polled." - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid} - For this and all encapsulated process groups" : [ ] - }, { - "Write Source Data - /data/{component-type}/{uuid} - For all encapsulated connections" : [ ] - } ] - } - }, - "/process-groups/{id}/empty-all-connections-requests/{drop-request-id}" : { - "get" : { - "tags" : [ "process-groups" ], - "summary" : "Gets the current status of a drop all flowfiles request.", - "description" : "", - "operationId" : "getDropAllFlowfilesRequest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "name" : "drop-request-id", - "in" : "path", - "description" : "The drop request id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/DropRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid} - For this and all encapsulated process groups" : [ ] - }, { - "Write Source Data - /data/{component-type}/{uuid} - For all encapsulated connections" : [ ] - } ] - }, - "delete" : { - "tags" : [ "process-groups" ], - "summary" : "Cancels and/or removes a request to drop all flowfiles.", - "description" : "", - "operationId" : "removeDropRequest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "name" : "drop-request-id", - "in" : "path", - "description" : "The drop request id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/DropRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid} - For this and all encapsulated process groups" : [ ] - }, { - "Write Source Data - /data/{component-type}/{uuid} - For all encapsulated connections" : [ ] - } ] - } - }, - "/process-groups/{id}/flow-contents" : { - "put" : { - "tags" : [ "process-groups" ], - "summary" : "Replace Process Group contents with the given ID with the specified Process Group contents", - "description" : "This endpoint is used for replication within a cluster, when replacing a flow with a new flow. It expects that the flow beingreplaced is not under version control and that the given snapshot will not modify any Processor that is currently running or any Controller Service that is enabled. Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "replaceProcessGroup", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The process group replace request entity.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ProcessGroupImportEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessGroupImportEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - }, { - "Write - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/process-groups/{id}/funnels" : { - "get" : { - "tags" : [ "process-groups" ], - "summary" : "Gets all funnels", - "description" : "", - "operationId" : "getFunnels", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/FunnelsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - } ] - }, - "post" : { - "tags" : [ "process-groups" ], - "summary" : "Creates a funnel", - "description" : "", - "operationId" : "createFunnel", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The funnel configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/FunnelEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/FunnelEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/process-groups/{id}/input-ports" : { - "get" : { - "tags" : [ "process-groups" ], - "summary" : "Gets all input ports", - "description" : "", - "operationId" : "getInputPorts", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/InputPortsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - } ] - }, - "post" : { - "tags" : [ "process-groups" ], - "summary" : "Creates an input port", - "description" : "", - "operationId" : "createInputPort", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The input port configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/PortEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/PortEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/process-groups/{id}/labels" : { - "get" : { - "tags" : [ "process-groups" ], - "summary" : "Gets all labels", - "description" : "", - "operationId" : "getLabels", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/LabelsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - } ] - }, - "post" : { - "tags" : [ "process-groups" ], - "summary" : "Creates a label", - "description" : "", - "operationId" : "createLabel", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The label configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/LabelEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/LabelEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/process-groups/{id}/local-modifications" : { - "get" : { - "tags" : [ "process-groups" ], - "summary" : "Gets a list of local modifications to the Process Group since it was last synchronized with the Flow Registry", - "description" : "", - "operationId" : "getLocalModifications", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/FlowComparisonEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - }, { - "Read - /{component-type}/{uuid} - For all encapsulated components" : [ ] - } ] - } - }, - "/process-groups/{id}/output-ports" : { - "get" : { - "tags" : [ "process-groups" ], - "summary" : "Gets all output ports", - "description" : "", - "operationId" : "getOutputPorts", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/OutputPortsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - } ] - }, - "post" : { - "tags" : [ "process-groups" ], - "summary" : "Creates an output port", - "description" : "", - "operationId" : "createOutputPort", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The output port configuration.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/PortEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/PortEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/process-groups/{id}/process-groups" : { - "get" : { - "tags" : [ "process-groups" ], - "summary" : "Gets all process groups", - "description" : "", - "operationId" : "getProcessGroups", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessGroupsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - } ] - }, - "post" : { - "tags" : [ "process-groups" ], - "summary" : "Creates a process group", - "description" : "", - "operationId" : "createProcessGroup", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The process group configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ProcessGroupEntity" - } - }, { - "name" : "parameterContextHandlingStrategy", - "in" : "query", - "description" : "Handling Strategy controls whether to keep or replace Parameter Contexts", - "required" : false, - "type" : "string", - "default" : "KEEP_EXISTING", - "enum" : [ "KEEP_EXISTING", "REPLACE" ] - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessGroupEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/process-groups/{id}/process-groups/import" : { - "post" : { - "tags" : [ "process-groups" ], - "summary" : "Imports a specified process group", - "description" : "", - "operationId" : "importProcessGroup", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessGroupEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/process-groups/{id}/process-groups/upload" : { - "post" : { - "tags" : [ "process-groups" ], - "summary" : "Uploads a versioned flow definition and creates a process group", - "description" : "", - "operationId" : "uploadProcessGroup", - "consumes" : [ "multipart/form-data" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The process group name.", - "required" : true, - "schema" : { - "type" : "string" - } - }, { - "in" : "body", - "name" : "body", - "description" : "The process group X position.", - "required" : true, - "schema" : { - "type" : "number", - "format" : "double" - } - }, { - "in" : "body", - "name" : "body", - "description" : "The process group Y position.", - "required" : true, - "schema" : { - "type" : "number", - "format" : "double" - } - }, { - "in" : "body", - "name" : "body", - "description" : "The client id.", - "required" : true, - "schema" : { - "type" : "string" - } - }, { - "in" : "body", - "name" : "body", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "schema" : { - "type" : "boolean" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessGroupEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/process-groups/{id}/processors" : { - "get" : { - "tags" : [ "process-groups" ], - "summary" : "Gets all processors", - "description" : "", - "operationId" : "getProcessors", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "name" : "includeDescendantGroups", - "in" : "query", - "description" : "Whether or not to include processors from descendant process groups", - "required" : false, - "type" : "boolean", - "default" : false - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessorsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - } ] - }, - "post" : { - "tags" : [ "process-groups" ], - "summary" : "Creates a new processor", - "description" : "", - "operationId" : "createProcessor", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The processor configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ProcessorEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessorEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - }, { - "Read - any referenced Controller Services - /controller-services/{uuid}" : [ ] - }, { - "Write - if the Processor is restricted - /restricted-components" : [ ] - } ] - } - }, - "/process-groups/{id}/remote-process-groups" : { - "get" : { - "tags" : [ "process-groups" ], - "summary" : "Gets all remote process groups", - "description" : "", - "operationId" : "getRemoteProcessGroups", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/RemoteProcessGroupsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - } ] - }, - "post" : { - "tags" : [ "process-groups" ], - "summary" : "Creates a new process group", - "description" : "", - "operationId" : "createRemoteProcessGroup", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The remote process group configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/RemoteProcessGroupEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/RemoteProcessGroupEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/process-groups/{id}/replace-requests" : { - "post" : { - "tags" : [ "process-groups" ], - "summary" : "Initiate the Replace Request of a Process Group with the given ID", - "description" : "This will initiate the action of replacing a process group with the given process group. This can be a lengthy process, as it will stop any Processors and disable any Controller Services necessary to perform the action and then restart them. As a result, the endpoint will immediately return a ProcessGroupReplaceRequestEntity, and the process of replacing the flow will occur asynchronously in the background. The client may then periodically poll the status of the request by issuing a GET request to /process-groups/replace-requests/{requestId}. Once the request is completed, the client is expected to issue a DELETE request to /process-groups/replace-requests/{requestId}. Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "initiateReplaceProcessGroup", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The process group replace request entity", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ProcessGroupImportEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessGroupReplaceRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - }, { - "Write - /process-groups/{uuid}" : [ ] - }, { - "Read - /{component-type}/{uuid} - For all encapsulated components" : [ ] - }, { - "Write - /{component-type}/{uuid} - For all encapsulated components" : [ ] - }, { - "Write - if the template contains any restricted components - /restricted-components" : [ ] - }, { - "Read - /parameter-contexts/{uuid} - For any Parameter Context that is referenced by a Property that is changed, added, or removed" : [ ] - } ] - } - }, - "/process-groups/{id}/snippet-instance" : { - "post" : { - "tags" : [ "process-groups" ], - "summary" : "Copies a snippet and discards it.", - "description" : "", - "operationId" : "copySnippet", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The copy snippet request.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/CopySnippetRequestEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/FlowEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - }, { - "Read - /{component-type}/{uuid} - For each component in the snippet and their descendant components" : [ ] - }, { - "Write - if the snippet contains any restricted Processors - /restricted-components" : [ ] - } ] - } - }, - "/process-groups/{id}/template-instance" : { - "post" : { - "tags" : [ "process-groups" ], - "summary" : "Instantiates a template", - "description" : "", - "operationId" : "instantiateTemplate", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The instantiate template request.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/InstantiateTemplateRequestEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/FlowEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - }, { - "Read - /templates/{uuid}" : [ ] - }, { - "Write - if the template contains any restricted components - /restricted-components" : [ ] - } ] - } - }, - "/process-groups/{id}/templates" : { - "post" : { - "tags" : [ "process-groups" ], - "summary" : "Creates a template and discards the specified snippet.", - "description" : "", - "operationId" : "createTemplate", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The create template request.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/CreateTemplateRequestEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/TemplateEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - }, { - "Read - /{component-type}/{uuid} - For each component in the snippet and their descendant components" : [ ] - } ] - } - }, - "/process-groups/{id}/templates/import" : { - "post" : { - "tags" : [ "process-groups" ], - "summary" : "Imports a template", - "description" : "", - "operationId" : "importTemplate", - "consumes" : [ "application/xml" ], - "produces" : [ "application/xml" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/TemplateEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/process-groups/{id}/templates/upload" : { - "post" : { - "tags" : [ "process-groups" ], - "summary" : "Uploads a template", - "description" : "", - "operationId" : "uploadTemplate", - "consumes" : [ "multipart/form-data" ], - "produces" : [ "application/xml" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "schema" : { - "type" : "boolean" - } - }, { - "name" : "template", - "in" : "formData", - "description" : "The binary content of the template file being uploaded.", - "required" : true, - "type" : "file" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/TemplateEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/process-groups/{id}/variable-registry" : { - "get" : { - "tags" : [ "process-groups" ], - "summary" : "Gets a process group's variable registry", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getVariableRegistry", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "name" : "includeAncestorGroups", - "in" : "query", - "description" : "Whether or not to include ancestor groups", - "required" : false, - "type" : "boolean", - "default" : true - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VariableRegistryEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - } ] - }, - "put" : { - "tags" : [ "process-groups" ], - "summary" : "Updates the contents of a Process Group's variable Registry", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "updateVariableRegistry", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The variable registry configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/VariableRegistryEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VariableRegistryEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/process-groups/{id}/variable-registry/update-requests" : { - "post" : { - "tags" : [ "process-groups" ], - "summary" : "Submits a request to update a process group's variable registry", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "submitUpdateVariableRegistryRequest", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The variable registry configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/VariableRegistryEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VariableRegistryUpdateRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/processors/run-status-details/queries" : { - "post" : { - "tags" : [ "processors" ], - "summary" : "Submits a query to retrieve the run status details of all processors that are in the given list of Processor IDs", - "description" : "", - "operationId" : "getProcessorRunStatusDetails", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The request for the processors that should be included in the results", - "required" : false, - "schema" : { - "$ref" : "#/definitions/RunStatusDetailsRequestEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessorsRunStatusDetailsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /processors/{uuid} for each processor whose run status information is requested" : [ ] - } ] - } - }, - "/processors/{id}" : { - "get" : { - "tags" : [ "processors" ], - "summary" : "Gets a processor", - "description" : "", - "operationId" : "getProcessor", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The processor id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessorEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /processors/{uuid}" : [ ] - } ] - }, - "put" : { - "tags" : [ "processors" ], - "summary" : "Updates a processor", - "description" : "", - "operationId" : "updateProcessor", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The processor id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The processor configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ProcessorEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessorEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /processors/{uuid}" : [ ] - }, { - "Read - any referenced Controller Services if this request changes the reference - /controller-services/{uuid}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "processors" ], - "summary" : "Deletes a processor", - "description" : "", - "operationId" : "deleteProcessor", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The revision is used to verify the client is working with the latest version of the flow.", - "required" : false, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The processor id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessorEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /processors/{uuid}" : [ ] - }, { - "Write - Parent Process Group - /process-groups/{uuid}" : [ ] - }, { - "Read - any referenced Controller Services - /controller-services/{uuid}" : [ ] - } ] - } - }, - "/processors/{id}/config/analysis" : { - "post" : { - "tags" : [ "processors" ], - "summary" : "Performs analysis of the component's configuration, providing information about which attributes are referenced.", - "description" : "", - "operationId" : "analyzeConfiguration", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The processor id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The processor configuration analysis request.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ConfigurationAnalysisEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/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. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /processors/{uuid}" : [ ] - } ] - } - }, - "/processors/{id}/config/verification-requests" : { - "post" : { - "tags" : [ "processors" ], - "summary" : "Performs verification of the Processor's configuration", - "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", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The processor id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The processor configuration verification request.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/VerifyConfigRequestEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/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. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /processors/{uuid}" : [ ] - } ] - } - }, - "/processors/{id}/config/verification-requests/{requestId}" : { - "get" : { - "tags" : [ "processors" ], - "summary" : "Returns the Verification Request with the given ID", - "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", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The ID of the Processor", - "required" : true, - "type" : "string" - }, { - "name" : "requestId", - "in" : "path", - "description" : "The ID of the Verification Request", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/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. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Only the user that submitted the request can get it" : [ ] - } ] - }, - "delete" : { - "tags" : [ "processors" ], - "summary" : "Deletes the Verification Request with the given ID", - "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", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The ID of the Processor", - "required" : true, - "type" : "string" - }, { - "name" : "requestId", - "in" : "path", - "description" : "The ID of the Verification Request", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/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. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Only the user that submitted the request can remove it" : [ ] - } ] - } - }, - "/processors/{id}/descriptors" : { - "get" : { - "tags" : [ "processors" ], - "summary" : "Gets the descriptor for a processor property", - "description" : "", - "operationId" : "getPropertyDescriptor", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The processor id.", - "required" : true, - "type" : "string" - }, { - "name" : "propertyName", - "in" : "query", - "description" : "The property name.", - "required" : true, - "type" : "string" - }, { - "name" : "sensitive", - "in" : "query", - "description" : "Property Descriptor requested sensitive status", - "required" : false, - "type" : "boolean", - "default" : false - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/PropertyDescriptorEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /processors/{uuid}" : [ ] - } ] - } - }, - "/processors/{id}/diagnostics" : { - "get" : { - "tags" : [ "processors" ], - "summary" : "Gets diagnostics information about a processor", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getProcessorDiagnostics", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The processor id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessorEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /processors/{uuid}" : [ ] - } ] - } - }, - "/processors/{id}/run-status" : { - "put" : { - "tags" : [ "processors" ], - "summary" : "Updates run status of a processor", - "description" : "", - "operationId" : "updateRunStatus", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The processor id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The processor run status.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ProcessorRunStatusEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessorEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /processors/{uuid} or /operation/processors/{uuid}" : [ ] - } ] - } - }, - "/processors/{id}/state" : { - "get" : { - "tags" : [ "processors" ], - "summary" : "Gets the state for a processor", - "description" : "", - "operationId" : "getState", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The processor id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ComponentStateEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /processors/{uuid}" : [ ] - } ] - } - }, - "/processors/{id}/state/clear-requests" : { - "post" : { - "tags" : [ "processors" ], - "summary" : "Clears the state for a processor", - "description" : "", - "operationId" : "clearState", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The processor id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ComponentStateEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /processors/{uuid}" : [ ] - } ] - } - }, - "/processors/{id}/threads" : { - "delete" : { - "tags" : [ "processors" ], - "summary" : "Terminates a processor, essentially \"deleting\" its threads and any active tasks", - "description" : "", - "operationId" : "terminateProcessor", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The processor id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessorEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /processors/{uuid} or /operation/processors/{uuid}" : [ ] - } ] - } - }, - "/provenance" : { - "post" : { - "tags" : [ "provenance" ], - "summary" : "Submits a provenance query", - "description" : "Provenance queries may be long running so this endpoint submits a request. The response will include the current state of the query. If the request is not completed the URI in the response can be used at a later time to get the updated state of the query. Once the query has completed the provenance request should be deleted by the client who originally submitted it.", - "operationId" : "submitProvenanceRequest", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The provenance query details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ProvenanceEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProvenanceEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /provenance" : [ ] - }, { - "Read - /data/{component-type}/{uuid}" : [ ] - } ] - } - }, - "/provenance-events/latest/replays" : { - "post" : { - "tags" : [ "provenance-events" ], - "summary" : "Replays content from a provenance event", - "description" : "", - "operationId" : "submitReplayLatestEvent", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The replay request.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ReplayLastEventRequestEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/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. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read Component Provenance Data - /provenance-data/{component-type}/{uuid}" : [ ] - }, { - "Read Component Data - /data/{component-type}/{uuid}" : [ ] - }, { - "Write Component Data - /data/{component-type}/{uuid}" : [ ] - } ] - } - }, - "/provenance-events/replays" : { - "post" : { - "tags" : [ "provenance-events" ], - "summary" : "Replays content from a provenance event", - "description" : "", - "operationId" : "submitReplay", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The replay request.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/SubmitReplayRequestEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProvenanceEventEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read Component Provenance Data - /provenance-data/{component-type}/{uuid}" : [ ] - }, { - "Read Component Data - /data/{component-type}/{uuid}" : [ ] - }, { - "Write Component Data - /data/{component-type}/{uuid}" : [ ] - } ] - } - }, - "/provenance-events/{id}" : { - "get" : { - "tags" : [ "provenance-events" ], - "summary" : "Gets a provenance event", - "description" : "", - "operationId" : "getProvenanceEvent", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "clusterNodeId", - "in" : "query", - "description" : "The id of the node where this event exists if clustered.", - "required" : false, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The provenance event id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProvenanceEventEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read Component Provenance Data - /provenance-data/{component-type}/{uuid}" : [ ] - } ] - } - }, - "/provenance-events/{id}/content/input" : { - "get" : { - "tags" : [ "provenance-events" ], - "summary" : "Gets the input content for a provenance event", - "description" : "", - "operationId" : "getInputContent", - "consumes" : [ "*/*" ], - "produces" : [ "*/*" ], - "parameters" : [ { - "name" : "clusterNodeId", - "in" : "query", - "description" : "The id of the node where the content exists if clustered.", - "required" : false, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The provenance event id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/StreamingOutput" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read Component Provenance Data - /provenance-data/{component-type}/{uuid}" : [ ] - }, { - "Read Component Data - /data/{component-type}/{uuid}" : [ ] - } ] - } - }, - "/provenance-events/{id}/content/output" : { - "get" : { - "tags" : [ "provenance-events" ], - "summary" : "Gets the output content for a provenance event", - "description" : "", - "operationId" : "getOutputContent", - "consumes" : [ "*/*" ], - "produces" : [ "*/*" ], - "parameters" : [ { - "name" : "clusterNodeId", - "in" : "query", - "description" : "The id of the node where the content exists if clustered.", - "required" : false, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The provenance event id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/StreamingOutput" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read Component Provenance Data - /provenance-data/{component-type}/{uuid}" : [ ] - }, { - "Read Component Data - /data/{component-type}/{uuid}" : [ ] - } ] - } - }, - "/provenance/lineage" : { - "post" : { - "tags" : [ "provenance" ], - "summary" : "Submits a lineage query", - "description" : "Lineage queries may be long running so this endpoint submits a request. The response will include the current state of the query. If the request is not completed the URI in the response can be used at a later time to get the updated state of the query. Once the query has completed the lineage request should be deleted by the client who originally submitted it.", - "operationId" : "submitLineageRequest", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The lineage query details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/LineageEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/LineageEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /provenance" : [ ] - }, { - "Read - /data/{component-type}/{uuid}" : [ ] - } ] - } - }, - "/provenance/lineage/{id}" : { - "get" : { - "tags" : [ "provenance" ], - "summary" : "Gets a lineage query", - "description" : "", - "operationId" : "getLineage", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "clusterNodeId", - "in" : "query", - "description" : "The id of the node where this query exists if clustered.", - "required" : false, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The id of the lineage query.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/LineageEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /provenance" : [ ] - }, { - "Read - /data/{component-type}/{uuid}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "provenance" ], - "summary" : "Deletes a lineage query", - "description" : "", - "operationId" : "deleteLineage", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "clusterNodeId", - "in" : "query", - "description" : "The id of the node where this query exists if clustered.", - "required" : false, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The id of the lineage query.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/LineageEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /provenance" : [ ] - } ] - } - }, - "/provenance/search-options" : { - "get" : { - "tags" : [ "provenance" ], - "summary" : "Gets the searchable attributes for provenance events", - "description" : "", - "operationId" : "getSearchOptions", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProvenanceOptionsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /provenance" : [ ] - } ] - } - }, - "/provenance/{id}" : { - "get" : { - "tags" : [ "provenance" ], - "summary" : "Gets a provenance query", - "description" : "", - "operationId" : "getProvenance", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "clusterNodeId", - "in" : "query", - "description" : "The id of the node where this query exists if clustered.", - "required" : false, - "type" : "string" - }, { - "name" : "summarize", - "in" : "query", - "description" : "Whether or not incremental results are returned. If false, provenance events are only returned once the query completes. This property is true by default.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "incrementalResults", - "in" : "query", - "description" : "Whether or not to summarize provenance events returned. This property is false by default.", - "required" : false, - "type" : "boolean", - "default" : true - }, { - "name" : "id", - "in" : "path", - "description" : "The id of the provenance query.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProvenanceEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /provenance" : [ ] - }, { - "Read - /data/{component-type}/{uuid}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "provenance" ], - "summary" : "Deletes a provenance query", - "description" : "", - "operationId" : "deleteProvenance", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "clusterNodeId", - "in" : "query", - "description" : "The id of the node where this query exists if clustered.", - "required" : false, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The id of the provenance query.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProvenanceEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /provenance" : [ ] - } ] - } - }, - "/remote-process-groups/process-group/{id}/run-status" : { - "put" : { - "tags" : [ "remote-process-groups" ], - "summary" : "Updates run status of all remote process groups in a process group (recursively)", - "description" : "", - "operationId" : "updateRemoteProcessGroupRunStatuses", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The remote process groups run status.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/RemotePortRunStatusEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/RemoteProcessGroupEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /remote-process-groups/{uuid} or /operation/remote-process-groups/{uuid}" : [ ] - } ] - } - }, - "/remote-process-groups/{id}" : { - "get" : { - "tags" : [ "remote-process-groups" ], - "summary" : "Gets a remote process group", - "description" : "", - "operationId" : "getRemoteProcessGroup", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The remote process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/RemoteProcessGroupEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /remote-process-groups/{uuid}" : [ ] - } ] - }, - "put" : { - "tags" : [ "remote-process-groups" ], - "summary" : "Updates a remote process group", - "description" : "", - "operationId" : "updateRemoteProcessGroup", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The remote process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The remote process group.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/RemoteProcessGroupEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/RemoteProcessGroupEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /remote-process-groups/{uuid}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "remote-process-groups" ], - "summary" : "Deletes a remote process group", - "description" : "", - "operationId" : "removeRemoteProcessGroup", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The revision is used to verify the client is working with the latest version of the flow.", - "required" : false, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The remote process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/RemoteProcessGroupEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /remote-process-groups/{uuid}" : [ ] - }, { - "Write - Parent Process Group - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/remote-process-groups/{id}/input-ports/{port-id}" : { - "put" : { - "tags" : [ "remote-process-groups" ], - "summary" : "Updates a remote port", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "updateRemoteProcessGroupInputPort", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The remote process group id.", - "required" : true, - "type" : "string" - }, { - "name" : "port-id", - "in" : "path", - "description" : "The remote process group port id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The remote process group port.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/RemoteProcessGroupPortEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/RemoteProcessGroupPortEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /remote-process-groups/{uuid}" : [ ] - } ] - } - }, - "/remote-process-groups/{id}/input-ports/{port-id}/run-status" : { - "put" : { - "tags" : [ "remote-process-groups" ], - "summary" : "Updates run status of a remote port", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "updateRemoteProcessGroupInputPortRunStatus", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The remote process group id.", - "required" : true, - "type" : "string" - }, { - "name" : "port-id", - "in" : "path", - "description" : "The remote process group port id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The remote process group port.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/RemotePortRunStatusEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/RemoteProcessGroupPortEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /remote-process-groups/{uuid} or /operation/remote-process-groups/{uuid}" : [ ] - } ] - } - }, - "/remote-process-groups/{id}/output-ports/{port-id}" : { - "put" : { - "tags" : [ "remote-process-groups" ], - "summary" : "Updates a remote port", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "updateRemoteProcessGroupOutputPort", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The remote process group id.", - "required" : true, - "type" : "string" - }, { - "name" : "port-id", - "in" : "path", - "description" : "The remote process group port id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The remote process group port.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/RemoteProcessGroupPortEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/RemoteProcessGroupPortEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /remote-process-groups/{uuid}" : [ ] - } ] - } - }, - "/remote-process-groups/{id}/output-ports/{port-id}/run-status" : { - "put" : { - "tags" : [ "remote-process-groups" ], - "summary" : "Updates run status of a remote port", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "updateRemoteProcessGroupOutputPortRunStatus", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The remote process group id.", - "required" : true, - "type" : "string" - }, { - "name" : "port-id", - "in" : "path", - "description" : "The remote process group port id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The remote process group port.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/RemotePortRunStatusEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/RemoteProcessGroupPortEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /remote-process-groups/{uuid} or /operation/remote-process-groups/{uuid}" : [ ] - } ] - } - }, - "/remote-process-groups/{id}/run-status" : { - "put" : { - "tags" : [ "remote-process-groups" ], - "summary" : "Updates run status of a remote process group", - "description" : "", - "operationId" : "updateRemoteProcessGroupRunStatus", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The remote process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The remote process group run status.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/RemotePortRunStatusEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/RemoteProcessGroupEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /remote-process-groups/{uuid} or /operation/remote-process-groups/{uuid}" : [ ] - } ] - } - }, - "/remote-process-groups/{id}/state" : { - "get" : { - "tags" : [ "remote-process-groups" ], - "summary" : "Gets the state for a RemoteProcessGroup", - "description" : "", - "operationId" : "getState", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The processor id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ComponentStateEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /remote-process-groups/{uuid}" : [ ] - } ] - } - }, - "/reporting-tasks/{id}" : { - "get" : { - "tags" : [ "reporting-tasks" ], - "summary" : "Gets a reporting task", - "description" : "", - "operationId" : "getReportingTask", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The reporting task id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ReportingTaskEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /reporting-tasks/{uuid}" : [ ] - } ] - }, - "put" : { - "tags" : [ "reporting-tasks" ], - "summary" : "Updates a reporting task", - "description" : "", - "operationId" : "updateReportingTask", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The reporting task id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The reporting task configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ReportingTaskEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ReportingTaskEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /reporting-tasks/{uuid}" : [ ] - }, { - "Read - any referenced Controller Services if this request changes the reference - /controller-services/{uuid}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "reporting-tasks" ], - "summary" : "Deletes a reporting task", - "description" : "", - "operationId" : "removeReportingTask", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The revision is used to verify the client is working with the latest version of the flow.", - "required" : false, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The reporting task id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ReportingTaskEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /reporting-tasks/{uuid}" : [ ] - }, { - "Write - /controller" : [ ] - }, { - "Read - any referenced Controller Services - /controller-services/{uuid}" : [ ] - } ] - } - }, - "/reporting-tasks/{id}/config/analysis" : { - "post" : { - "tags" : [ "reporting-tasks" ], - "summary" : "Performs analysis of the component's configuration, providing information about which attributes are referenced.", - "description" : "", - "operationId" : "analyzeConfiguration", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The reporting task id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The configuration analysis request.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ConfigurationAnalysisEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/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. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /reporting-tasks/{uuid}" : [ ] - } ] - } - }, - "/reporting-tasks/{id}/config/verification-requests" : { - "post" : { - "tags" : [ "reporting-tasks" ], - "summary" : "Performs verification of the Reporting Task's configuration", - "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", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The reporting task id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The reporting task configuration verification request.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/VerifyConfigRequestEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/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. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /reporting-tasks/{uuid}" : [ ] - } ] - } - }, - "/reporting-tasks/{id}/config/verification-requests/{requestId}" : { - "get" : { - "tags" : [ "reporting-tasks" ], - "summary" : "Returns the Verification Request with the given ID", - "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", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The ID of the Reporting Task", - "required" : true, - "type" : "string" - }, { - "name" : "requestId", - "in" : "path", - "description" : "The ID of the Verification Request", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/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. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Only the user that submitted the request can get it" : [ ] - } ] - }, - "delete" : { - "tags" : [ "reporting-tasks" ], - "summary" : "Deletes the Verification Request with the given ID", - "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", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The ID of the Reporting Task", - "required" : true, - "type" : "string" - }, { - "name" : "requestId", - "in" : "path", - "description" : "The ID of the Verification Request", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/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. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Only the user that submitted the request can remove it" : [ ] - } ] - } - }, - "/reporting-tasks/{id}/descriptors" : { - "get" : { - "tags" : [ "reporting-tasks" ], - "summary" : "Gets a reporting task property descriptor", - "description" : "", - "operationId" : "getPropertyDescriptor", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The reporting task id.", - "required" : true, - "type" : "string" - }, { - "name" : "propertyName", - "in" : "query", - "description" : "The property name.", - "required" : true, - "type" : "string" - }, { - "name" : "sensitive", - "in" : "query", - "description" : "Property Descriptor requested sensitive status", - "required" : false, - "type" : "boolean", - "default" : false - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/PropertyDescriptorEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /reporting-tasks/{uuid}" : [ ] - } ] - } - }, - "/reporting-tasks/{id}/run-status" : { - "put" : { - "tags" : [ "reporting-tasks" ], - "summary" : "Updates run status of a reporting task", - "description" : "", - "operationId" : "updateRunStatus", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The reporting task id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The reporting task run status.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ReportingTaskRunStatusEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ReportingTaskEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /reporting-tasks/{uuid} or or /operation/reporting-tasks/{uuid}" : [ ] - } ] - } - }, - "/reporting-tasks/{id}/state" : { - "get" : { - "tags" : [ "reporting-tasks" ], - "summary" : "Gets the state for a reporting task", - "description" : "", - "operationId" : "getState", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The reporting task id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ComponentStateEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /reporting-tasks/{uuid}" : [ ] - } ] - } - }, - "/reporting-tasks/{id}/state/clear-requests" : { - "post" : { - "tags" : [ "reporting-tasks" ], - "summary" : "Clears the state for a reporting task", - "description" : "", - "operationId" : "clearState", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The reporting task id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ComponentStateEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /reporting-tasks/{uuid}" : [ ] - } ] - } - }, - "/resources" : { - "get" : { - "tags" : [ "resources" ], - "summary" : "Gets the available resources that support access/authorization policies", - "description" : "", - "operationId" : "getResources", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ResourcesEntity" - } - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - } - }, - "security" : [ { - "Read - /resources" : [ ] - } ] - } - }, - "/site-to-site" : { - "get" : { - "tags" : [ "site-to-site" ], - "summary" : "Returns the details about this NiFi necessary to communicate via site to site", - "description" : "", - "operationId" : "getSiteToSiteDetails", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ControllerEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /site-to-site" : [ ] - } ] - } - }, - "/site-to-site/peers" : { - "get" : { - "tags" : [ "site-to-site" ], - "summary" : "Returns the available Peers and its status of this NiFi", - "description" : "", - "operationId" : "getPeers", - "consumes" : [ "*/*" ], - "produces" : [ "application/json", "application/xml" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/PeersEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /site-to-site" : [ ] - } ] - } - }, - "/snippets" : { - "post" : { - "tags" : [ "snippets" ], - "summary" : "Creates a snippet. The snippet will be automatically discarded if not used in a subsequent request after 1 minute.", - "description" : "", - "operationId" : "createSnippet", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The snippet configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/SnippetEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/SnippetEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read or Write - /{component-type}/{uuid} - For every component (all Read or all Write) in the Snippet and their descendant components" : [ ] - } ] - } - }, - "/snippets/{id}" : { - "put" : { - "tags" : [ "snippets" ], - "summary" : "Move's the components in this Snippet into a new Process Group and discards the snippet", - "description" : "", - "operationId" : "updateSnippet", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The snippet id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The snippet configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/SnippetEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/SnippetEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write Process Group - /process-groups/{uuid}" : [ ] - }, { - "Write - /{component-type}/{uuid} - For each component in the Snippet and their descendant components" : [ ] - } ] - }, - "delete" : { - "tags" : [ "snippets" ], - "summary" : "Deletes the components in a snippet and discards the snippet", - "description" : "", - "operationId" : "deleteSnippet", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The snippet id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/SnippetEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /{component-type}/{uuid} - For each component in the Snippet and their descendant components" : [ ] - }, { - "Write - Parent Process Group - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/system-diagnostics" : { - "get" : { - "tags" : [ "system-diagnostics" ], - "summary" : "Gets the diagnostics for the system NiFi is running on", - "description" : "", - "operationId" : "getSystemDiagnostics", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "nodewise", - "in" : "query", - "description" : "Whether or not to include the breakdown per node. Optional, defaults to false", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "clusterNodeId", - "in" : "query", - "description" : "The id of the node where to get the status.", - "required" : false, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/SystemDiagnosticsEntity" - } - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - } - }, - "security" : [ { - "Read - /system" : [ ] - } ] - } - }, - "/system-diagnostics/jmx-metrics" : { - "get" : { - "tags" : [ "system-diagnostics" ], - "summary" : "Retrieve available JMX metrics", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getJmxMetrics", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "beanNameFilter", - "in" : "query", - "description" : "Regular Expression Pattern to be applied against the ObjectName", - "required" : false, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/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. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /system" : [ ] - } ] - } - }, - "/templates/{id}" : { - "delete" : { - "tags" : [ "templates" ], - "summary" : "Deletes a template", - "description" : "", - "operationId" : "removeTemplate", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The template id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/TemplateEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /templates/{uuid}" : [ ] - }, { - "Write - Parent Process Group - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/templates/{id}/download" : { - "get" : { - "tags" : [ "templates" ], - "summary" : "Exports a template", - "description" : "", - "operationId" : "exportTemplate", - "consumes" : [ "*/*" ], - "produces" : [ "application/xml" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The template id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /templates/{uuid}" : [ ] - } ] - } - }, - "/tenants/search-results" : { - "get" : { - "tags" : [ "tenants" ], - "summary" : "Searches for a tenant with the specified identity", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "searchTenants", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "q", - "in" : "query", - "description" : "Identity to search for.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/TenantsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /tenants" : [ ] - } ] - } - }, - "/tenants/user-groups" : { - "get" : { - "tags" : [ "tenants" ], - "summary" : "Gets all user groups", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getUserGroups", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/UserGroupsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /tenants" : [ ] - } ] - }, - "post" : { - "tags" : [ "tenants" ], - "summary" : "Creates a user group", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "createUserGroup", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The user group configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/UserGroupEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/UserGroupEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /tenants" : [ ] - } ] - } - }, - "/tenants/user-groups/{id}" : { - "get" : { - "tags" : [ "tenants" ], - "summary" : "Gets a user group", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getUserGroup", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The user group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/UserGroupEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /tenants" : [ ] - } ] - }, - "put" : { - "tags" : [ "tenants" ], - "summary" : "Updates a user group", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "updateUserGroup", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The user group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The user group configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/UserGroupEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/UserGroupEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /tenants" : [ ] - } ] - }, - "delete" : { - "tags" : [ "tenants" ], - "summary" : "Deletes a user group", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "removeUserGroup", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The revision is used to verify the client is working with the latest version of the flow.", - "required" : false, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The user group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/UserGroupEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /tenants" : [ ] - } ] - } - }, - "/tenants/users" : { - "get" : { - "tags" : [ "tenants" ], - "summary" : "Gets all users", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getUsers", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/UsersEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /tenants" : [ ] - } ] - }, - "post" : { - "tags" : [ "tenants" ], - "summary" : "Creates a user", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "createUser", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The user configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/UserEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/UserEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /tenants" : [ ] - } ] - } - }, - "/tenants/users/{id}" : { - "get" : { - "tags" : [ "tenants" ], - "summary" : "Gets a user", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getUser", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The user id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/UserEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /tenants" : [ ] - } ] - }, - "put" : { - "tags" : [ "tenants" ], - "summary" : "Updates a user", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "updateUser", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The user id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The user configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/UserEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/UserEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /tenants" : [ ] - } ] - }, - "delete" : { - "tags" : [ "tenants" ], - "summary" : "Deletes a user", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "removeUser", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The revision is used to verify the client is working with the latest version of the flow.", - "required" : false, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The user id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/UserEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /tenants" : [ ] - } ] - } - }, - "/versions/active-requests" : { - "post" : { - "tags" : [ "versions" ], - "summary" : "Create a version control request", - "description" : "Creates a request so that a Process Group can be placed under Version Control or have its Version Control configuration changed. Creating this request will prevent any other threads from simultaneously saving local changes to Version Control. It will not, however, actually save the local flow to the Flow Registry. A POST to /versions/process-groups/{id} should be used to initiate saving of the local flow to the Flow Registry. Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "createVersionControlRequest", - "consumes" : [ "application/json" ], - "produces" : [ "text/plain" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The versioned flow details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/CreateActiveRequestEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/versions/active-requests/{id}" : { - "put" : { - "tags" : [ "versions" ], - "summary" : "Updates the request with the given ID", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "updateVersionControlRequest", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The request ID.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The version control component mapping.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/VersionControlComponentMappingEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionControlInformationEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Only the user that submitted the request can update it" : [ ] - } ] - }, - "delete" : { - "tags" : [ "versions" ], - "summary" : "Deletes the version control request with the given ID", - "description" : "Deletes the Version Control Request with the given ID. This will allow other threads to save flows to the Flow Registry. See also the documentation for POSTing to /versions/active-requests for information regarding why this is done. Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "deleteVersionControlRequest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The request ID.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Only the user that submitted the request can remove it" : [ ] - } ] - } - }, - "/versions/process-groups/{id}" : { - "get" : { - "tags" : [ "versions" ], - "summary" : "Gets the Version Control information for a process group", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getVersionInformation", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionControlInformationEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - } ] - }, - "post" : { - "tags" : [ "versions" ], - "summary" : "Save the Process Group with the given ID", - "description" : "Begins version controlling the Process Group with the given ID or commits changes to the Versioned Flow, depending on if the provided VersionControlInformation includes a flowId. Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "saveToFlowRegistry", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The versioned flow details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/StartVersionControlRequestEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionControlInformationEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - }, { - "Write - /process-groups/{uuid}" : [ ] - }, { - "Read - /{component-type}/{uuid} - For all encapsulated components" : [ ] - }, { - "Read - any referenced Controller Services by any encapsulated components - /controller-services/{uuid}" : [ ] - } ] - }, - "put" : { - "tags" : [ "versions" ], - "summary" : "Update the version of a Process Group with the given ID", - "description" : "For a Process Group that is already under Version Control, this will update the version of the flow to a different version. This endpoint expects that the given snapshot will not modify any Processor that is currently running or any Controller Service that is enabled. Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "updateFlowVersion", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The controller service configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/VersionedFlowSnapshotEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionControlInformationEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - }, { - "Write - /process-groups/{uuid}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "versions" ], - "summary" : "Stops version controlling the Process Group with the given ID", - "description" : "Stops version controlling the Process Group with the given ID. The Process Group will no longer track to any Versioned Flow. Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "stopVersionControl", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The version is used to verify the client is working with the latest version of the flow.", - "required" : false, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, a new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionControlInformationEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - }, { - "Write - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/versions/process-groups/{id}/download" : { - "get" : { - "tags" : [ "versions" ], - "summary" : "Gets the latest version of a Process Group for download", - "description" : "", - "operationId" : "exportFlowVersion", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/versions/revert-requests/process-groups/{id}" : { - "post" : { - "tags" : [ "versions" ], - "summary" : "Initiate the Revert Request of a Process Group with the given ID", - "description" : "For a Process Group that is already under Version Control, this will initiate the action of reverting any local changes that have been made to the Process Group since it was last synchronized with the Flow Registry. This will result in the flow matching the Versioned Flow that exists in the Flow Registry. This can be a lengthy process, as it will stop any Processors and disable any Controller Services necessary to perform the action and then restart them. As a result, the endpoint will immediately return a VersionedFlowUpdateRequestEntity, and the process of updating the flow will occur asynchronously in the background. The client may then periodically poll the status of the request by issuing a GET request to /versions/revert-requests/{requestId}. Once the request is completed, the client is expected to issue a DELETE request to /versions/revert-requests/{requestId}. Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "initiateRevertFlowVersion", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The Version Control Information to revert to.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/VersionControlInformationEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlowUpdateRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - }, { - "Write - /process-groups/{uuid}" : [ ] - }, { - "Read - /{component-type}/{uuid} - For all encapsulated components" : [ ] - }, { - "Write - /{component-type}/{uuid} - For all encapsulated components" : [ ] - }, { - "Write - if the template contains any restricted components - /restricted-components" : [ ] - }, { - "Read - /parameter-contexts/{uuid} - For any Parameter Context that is referenced by a Property that is changed, added, or removed" : [ ] - } ] - } - }, - "/versions/revert-requests/{id}" : { - "get" : { - "tags" : [ "versions" ], - "summary" : "Returns the Revert Request with the given ID", - "description" : "Returns the Revert Request with the given ID. Once a Revert Request has been created by performing a POST to /versions/revert-requests/process-groups/{id}, that request can subsequently be retrieved via this endpoint, and the request that is fetched will contain the updated state, such as percent complete, the current state of the request, and any failures. Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getRevertRequest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The ID of the Revert Request", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlowUpdateRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Only the user that submitted the request can get it" : [ ] - } ] - }, - "delete" : { - "tags" : [ "versions" ], - "summary" : "Deletes the Revert Request with the given ID", - "description" : "Deletes the Revert Request with the given ID. After a request is created via a POST to /versions/revert-requests/process-groups/{id}, it is expected that the client will properly clean up the request by DELETE'ing it, once the Revert process has completed. If the request is deleted before the request completes, then the Revert request will finish the step that it is currently performing and then will cancel any subsequent steps. Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "deleteRevertRequest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The ID of the Revert Request", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlowUpdateRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Only the user that submitted the request can remove it" : [ ] - } ] - } - }, - "/versions/update-requests/process-groups/{id}" : { - "post" : { - "tags" : [ "versions" ], - "summary" : "Initiate the Update Request of a Process Group with the given ID", - "description" : "For a Process Group that is already under Version Control, this will initiate the action of changing from a specific version of the flow in the Flow Registry to a different version of the flow. This can be a lengthy process, as it will stop any Processors and disable any Controller Services necessary to perform the action and then restart them. As a result, the endpoint will immediately return a VersionedFlowUpdateRequestEntity, and the process of updating the flow will occur asynchronously in the background. The client may then periodically poll the status of the request by issuing a GET request to /versions/update-requests/{requestId}. Once the request is completed, the client is expected to issue a DELETE request to /versions/update-requests/{requestId}. Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "initiateVersionControlUpdate", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The controller service configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/VersionControlInformationEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlowUpdateRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - }, { - "Write - /process-groups/{uuid}" : [ ] - }, { - "Read - /{component-type}/{uuid} - For all encapsulated components" : [ ] - }, { - "Write - /{component-type}/{uuid} - For all encapsulated components" : [ ] - }, { - "Write - if the template contains any restricted components - /restricted-components" : [ ] - }, { - "Read - /parameter-contexts/{uuid} - For any Parameter Context that is referenced by a Property that is changed, added, or removed" : [ ] - } ] - } - }, - "/versions/update-requests/{id}" : { - "get" : { - "tags" : [ "versions" ], - "summary" : "Returns the Update Request with the given ID", - "description" : "Returns the Update Request with the given ID. Once an Update Request has been created by performing a POST to /versions/update-requests/process-groups/{id}, that request can subsequently be retrieved via this endpoint, and the request that is fetched will contain the updated state, such as percent complete, the current state of the request, and any failures. Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getUpdateRequest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The ID of the Update Request", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlowUpdateRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Only the user that submitted the request can get it" : [ ] - } ] - }, - "delete" : { - "tags" : [ "versions" ], - "summary" : "Deletes the Update Request with the given ID", - "description" : "Deletes the Update Request with the given ID. After a request is created via a POST to /versions/update-requests/process-groups/{id}, it is expected that the client will properly clean up the request by DELETE'ing it, once the Update process has completed. If the request is deleted before the request completes, then the Update request will finish the step that it is currently performing and then will cancel any subsequent steps. Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "deleteUpdateRequest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The ID of the Update Request", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlowUpdateRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Only the user that submitted the request can remove it" : [ ] - } ] - } - } - }, - "definitions" : { - "AboutDTO" : { - "type" : "object", - "properties" : { - "title" : { - "type" : "string", - "description" : "The title to be used on the page and in the about dialog." - }, - "version" : { - "type" : "string", - "description" : "The version of this NiFi." - }, - "uri" : { - "type" : "string", - "description" : "The URI for the NiFi." - }, - "contentViewerUrl" : { - "type" : "string", - "description" : "The URL for the content viewer if configured." - }, - "timezone" : { - "type" : "string", - "description" : "The timezone of the NiFi instance." - }, - "buildTag" : { - "type" : "string", - "description" : "Build tag" - }, - "buildRevision" : { - "type" : "string", - "description" : "Build revision or commit hash" - }, - "buildBranch" : { - "type" : "string", - "description" : "Build branch" - }, - "buildTimestamp" : { - "type" : "string", - "description" : "Build timestamp" - } - } - }, - "AboutEntity" : { - "type" : "object", - "properties" : { - "about" : { - "$ref" : "#/definitions/AboutDTO" - } - }, - "xml" : { - "name" : "aboutEntity" - } - }, - "AccessConfigurationDTO" : { - "type" : "object", - "properties" : { - "supportsLogin" : { - "type" : "boolean", - "description" : "Indicates whether or not this NiFi supports user login." - } - } - }, - "AccessConfigurationEntity" : { - "type" : "object", - "properties" : { - "config" : { - "$ref" : "#/definitions/AccessConfigurationDTO" - } - }, - "xml" : { - "name" : "accessConfigurationEntity" - } - }, - "AccessPolicyDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "versionedComponentId" : { - "type" : "string", - "description" : "The ID of the corresponding component that is under version control" - }, - "parentGroupId" : { - "type" : "string", - "description" : "The id of parent process group of this component if applicable." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "resource" : { - "type" : "string", - "description" : "The resource for this access policy." - }, - "action" : { - "type" : "string", - "description" : "The action associated with this access policy.", - "enum" : [ "read", "write" ] - }, - "componentReference" : { - "description" : "Component this policy references if applicable.", - "$ref" : "#/definitions/ComponentReferenceEntity" - }, - "configurable" : { - "type" : "boolean", - "description" : "Whether this policy is configurable." - }, - "users" : { - "type" : "array", - "description" : "The set of user IDs associated with this access policy.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/TenantEntity" - } - }, - "userGroups" : { - "type" : "array", - "description" : "The set of user group IDs associated with this access policy.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/TenantEntity" - } - } - } - }, - "AccessPolicyEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "generated" : { - "type" : "string", - "description" : "When this content was generated." - }, - "component" : { - "$ref" : "#/definitions/AccessPolicyDTO" - } - }, - "xml" : { - "name" : "accessPolicyEntity" - } - }, - "AccessPolicySummaryDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "versionedComponentId" : { - "type" : "string", - "description" : "The ID of the corresponding component that is under version control" - }, - "parentGroupId" : { - "type" : "string", - "description" : "The id of parent process group of this component if applicable." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "resource" : { - "type" : "string", - "description" : "The resource for this access policy." - }, - "action" : { - "type" : "string", - "description" : "The action associated with this access policy.", - "enum" : [ "read", "write" ] - }, - "componentReference" : { - "description" : "Component this policy references if applicable.", - "$ref" : "#/definitions/ComponentReferenceEntity" - }, - "configurable" : { - "type" : "boolean", - "description" : "Whether this policy is configurable." - } - } - }, - "AccessPolicySummaryEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "component" : { - "$ref" : "#/definitions/AccessPolicySummaryDTO" - } - }, - "xml" : { - "name" : "accessPolicySummaryEntity" - } - }, - "AccessStatusDTO" : { - "type" : "object", - "properties" : { - "identity" : { - "type" : "string", - "description" : "The user identity." - }, - "status" : { - "type" : "string", - "description" : "The user access status." - }, - "message" : { - "type" : "string", - "description" : "Additional details about the user access status." - } - }, - "xml" : { - "name" : "accessStatus" - } - }, - "AccessStatusEntity" : { - "type" : "object", - "properties" : { - "accessStatus" : { - "$ref" : "#/definitions/AccessStatusDTO" - } - }, - "xml" : { - "name" : "accessStatusEntity" - } - }, - "AccessTokenExpirationDTO" : { - "type" : "object", - "properties" : { - "expiration" : { - "type" : "string", - "description" : "Token Expiration" - } - }, - "xml" : { - "name" : "accessTokenExpiration" - } - }, - "AccessTokenExpirationEntity" : { - "type" : "object", - "properties" : { - "accessTokenExpiration" : { - "$ref" : "#/definitions/AccessTokenExpirationDTO" - } - }, - "xml" : { - "name" : "accessTokenExpirationEntity" - } - }, - "ActionDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "integer", - "format" : "int32", - "description" : "The action id." - }, - "userIdentity" : { - "type" : "string", - "description" : "The identity of the user that performed the action." - }, - "timestamp" : { - "type" : "string", - "description" : "The timestamp of the action." - }, - "sourceId" : { - "type" : "string", - "description" : "The id of the source component." - }, - "sourceName" : { - "type" : "string", - "description" : "The name of the source component." - }, - "sourceType" : { - "type" : "string", - "description" : "The type of the source component." - }, - "componentDetails" : { - "description" : "The details of the source component.", - "$ref" : "#/definitions/ComponentDetailsDTO" - }, - "operation" : { - "type" : "string", - "description" : "The operation that was performed." - }, - "actionDetails" : { - "description" : "The details of the action.", - "$ref" : "#/definitions/ActionDetailsDTO" - } - } - }, - "ActionDetailsDTO" : { - "type" : "object" - }, - "ActionEntity" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "integer", - "format" : "int32" - }, - "timestamp" : { - "type" : "string", - "description" : "The timestamp of the action." - }, - "sourceId" : { - "type" : "string" - }, - "canRead" : { - "type" : "boolean", - "description" : "Indicates whether the user can read a given resource." - }, - "action" : { - "$ref" : "#/definitions/ActionDTO" - } - }, - "xml" : { - "name" : "actionEntity" - } - }, - "ActivateControllerServicesEntity" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the ProcessGroup" - }, - "state" : { - "type" : "string", - "description" : "The desired state of the descendant components", - "enum" : [ "ENABLED", "DISABLED" ] - }, - "components" : { - "type" : "object", - "description" : "Optional services to schedule. If not specified, all authorized descendant controller services will be used.", - "additionalProperties" : { - "$ref" : "#/definitions/RevisionDTO" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - } - }, - "xml" : { - "name" : "activateControllerServicesEntity" - } - }, - "AffectedComponentDTO" : { - "type" : "object", - "properties" : { - "processGroupId" : { - "type" : "string", - "description" : "The UUID of the Process Group that this component is in" - }, - "id" : { - "type" : "string", - "description" : "The UUID of this component" - }, - "referenceType" : { - "type" : "string", - "description" : "The type of this component", - "enum" : [ "PROCESSOR", "CONTROLLER_SERVICE", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT" ] - }, - "name" : { - "type" : "string", - "description" : "The name of this component." - }, - "state" : { - "type" : "string", - "description" : "The scheduled state of a processor or reporting task referencing a controller service. If this component is another controller service, this field represents the controller service state." - }, - "activeThreadCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of active threads for the referencing component." - }, - "validationErrors" : { - "type" : "array", - "description" : "The validation errors for the component.", - "items" : { - "type" : "string" - } - } - } - }, - "AffectedComponentEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "component" : { - "$ref" : "#/definitions/AffectedComponentDTO" - }, - "processGroup" : { - "description" : "The Process Group that the component belongs to", - "$ref" : "#/definitions/ProcessGroupNameDTO" - }, - "referenceType" : { - "type" : "string", - "description" : "The type of component referenced", - "enum" : [ "PROCESSOR", "CONTROLLER_SERVICE", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT" ] - } - }, - "xml" : { - "name" : "affectedComponentEntity" - } - }, - "AllowableValueDTO" : { - "type" : "object", - "properties" : { - "displayName" : { - "type" : "string", - "description" : "A human readable value that is allowed for the property descriptor." - }, - "value" : { - "type" : "string", - "description" : "A value that is allowed for the property descriptor." - }, - "description" : { - "type" : "string", - "description" : "A description for this allowable value." - } - } - }, - "AllowableValueEntity" : { - "type" : "object", - "properties" : { - "allowableValue" : { - "$ref" : "#/definitions/AllowableValueDTO" - }, - "canRead" : { - "type" : "boolean", - "description" : "Indicates whether the user can read a given resource." - } - }, - "xml" : { - "name" : "entity" - } - }, - "Attribute" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The name of the attribute" - }, - "description" : { - "type" : "string", - "description" : "The description of the attribute" - } - } - }, - "AttributeDTO" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The attribute name." - }, - "value" : { - "type" : "string", - "description" : "The attribute value." - }, - "previousValue" : { - "type" : "string", - "description" : "The value of the attribute before the event took place." - } - } - }, - "BannerDTO" : { - "type" : "object", - "properties" : { - "headerText" : { - "type" : "string", - "description" : "The header text." - }, - "footerText" : { - "type" : "string", - "description" : "The footer text." - } - } - }, - "BannerEntity" : { - "type" : "object", - "properties" : { - "banners" : { - "$ref" : "#/definitions/BannerDTO" - } - }, - "xml" : { - "name" : "bannersEntity" - } - }, - "BatchSettingsDTO" : { - "type" : "object", - "properties" : { - "count" : { - "type" : "integer", - "format" : "int32", - "description" : "Preferred number of flow files to include in a transaction." - }, - "size" : { - "type" : "string", - "description" : "Preferred number of bytes to include in a transaction." - }, - "duration" : { - "type" : "string", - "description" : "Preferred amount of time that a transaction should span." - } - } - }, - "BatchSize" : { - "type" : "object", - "properties" : { - "count" : { - "type" : "integer", - "format" : "int32", - "description" : "Preferred number of flow files to include in a transaction." - }, - "size" : { - "type" : "string", - "description" : "Preferred number of bytes to include in a transaction." - }, - "duration" : { - "type" : "string", - "description" : "Preferred amount of time that a transaction should span." - } - } - }, - "BuildInfo" : { - "type" : "object", - "properties" : { - "version" : { - "type" : "string", - "description" : "The version number of the built component." - }, - "revision" : { - "type" : "string", - "description" : "The SCM revision id of the source code used for this build." - }, - "timestamp" : { - "type" : "integer", - "format" : "int64", - "description" : "The timestamp (milliseconds since Epoch) of the build." - }, - "targetArch" : { - "type" : "string", - "description" : "The target architecture of the built component." - }, - "compiler" : { - "type" : "string", - "description" : "The compiler used for the build" - }, - "compilerFlags" : { - "type" : "string", - "description" : "The compiler flags used for the build." - } - } - }, - "BulletinBoardDTO" : { - "type" : "object", - "properties" : { - "bulletins" : { - "type" : "array", - "description" : "The bulletins in the bulletin board, that matches the supplied request.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "generated" : { - "type" : "string", - "description" : "The timestamp when this report was generated." - } - } - }, - "BulletinBoardEntity" : { - "type" : "object", - "properties" : { - "bulletinBoard" : { - "$ref" : "#/definitions/BulletinBoardDTO" - } - }, - "xml" : { - "name" : "bulletinBoardEntity" - } - }, - "BulletinDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "integer", - "format" : "int64", - "description" : "The id of the bulletin." - }, - "nodeAddress" : { - "type" : "string", - "description" : "If clustered, the address of the node from which the bulletin originated." - }, - "category" : { - "type" : "string", - "description" : "The category of this bulletin." - }, - "groupId" : { - "type" : "string", - "description" : "The group id of the source component." - }, - "sourceId" : { - "type" : "string", - "description" : "The id of the source component." - }, - "sourceName" : { - "type" : "string", - "description" : "The name of the source component." - }, - "level" : { - "type" : "string", - "description" : "The level of the bulletin." - }, - "message" : { - "type" : "string", - "description" : "The bulletin message." - }, - "timestamp" : { - "type" : "string", - "description" : "When this bulletin was generated." - } - } - }, - "BulletinEntity" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "integer", - "format" : "int64" - }, - "groupId" : { - "type" : "string" - }, - "sourceId" : { - "type" : "string" - }, - "timestamp" : { - "type" : "string", - "description" : "When this bulletin was generated." - }, - "nodeAddress" : { - "type" : "string" - }, - "canRead" : { - "type" : "boolean", - "description" : "Indicates whether the user can read a given resource." - }, - "bulletin" : { - "$ref" : "#/definitions/BulletinDTO" - } - }, - "xml" : { - "name" : "bulletinEntity" - } - }, - "Bundle" : { - "type" : "object", - "properties" : { - "group" : { - "type" : "string", - "description" : "The group of the bundle" - }, - "artifact" : { - "type" : "string", - "description" : "The artifact of the bundle" - }, - "version" : { - "type" : "string", - "description" : "The version of the bundle" - } - } - }, - "BundleDTO" : { - "type" : "object", - "properties" : { - "group" : { - "type" : "string", - "description" : "The group of the bundle." - }, - "artifact" : { - "type" : "string", - "description" : "The artifact of the bundle." - }, - "version" : { - "type" : "string", - "description" : "The version of the bundle." - } - } - }, - "ClassLoaderDiagnosticsDTO" : { - "type" : "object", - "properties" : { - "bundle" : { - "description" : "Information about the Bundle that the ClassLoader belongs to, if any", - "$ref" : "#/definitions/BundleDTO" - }, - "parentClassLoader" : { - "description" : "A ClassLoaderDiagnosticsDTO that provides information about the parent ClassLoader", - "$ref" : "#/definitions/ClassLoaderDiagnosticsDTO" - } - } - }, - "ClusteSummaryEntity" : { - "type" : "object", - "properties" : { - "clusterSummary" : { - "$ref" : "#/definitions/ClusterSummaryDTO" - } - }, - "xml" : { - "name" : "clusterSummaryEntity" - } - }, - "ClusterDTO" : { - "type" : "object", - "properties" : { - "nodes" : { - "type" : "array", - "description" : "The collection of nodes that are part of the cluster.", - "items" : { - "$ref" : "#/definitions/NodeDTO" - } - }, - "generated" : { - "type" : "string", - "description" : "The timestamp the report was generated." - } - } - }, - "ClusterEntity" : { - "type" : "object", - "properties" : { - "cluster" : { - "$ref" : "#/definitions/ClusterDTO" - } - }, - "xml" : { - "name" : "clusterEntity" - } - }, - "ClusterSearchResultsEntity" : { - "type" : "object", - "properties" : { - "nodeResults" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/NodeSearchResultDTO" - } - } - }, - "xml" : { - "name" : "clusterSearchResultsEntity" - } - }, - "ClusterSummaryDTO" : { - "type" : "object", - "properties" : { - "connectedNodes" : { - "type" : "string", - "description" : "When clustered, reports the number of nodes connected vs the number of nodes in the cluster." - }, - "connectedNodeCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of nodes that are currently connected to the cluster" - }, - "totalNodeCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of nodes in the cluster, regardless of whether or not they are connected" - }, - "clustered" : { - "type" : "boolean", - "description" : "Whether this NiFi instance is clustered." - }, - "connectedToCluster" : { - "type" : "boolean", - "description" : "Whether this NiFi instance is connected to a cluster." - } - } - }, - "ComponentDetailsDTO" : { - "type" : "object" - }, - "ComponentDifferenceDTO" : { - "type" : "object", - "properties" : { - "componentType" : { - "type" : "string", - "description" : "The type of component" - }, - "componentId" : { - "type" : "string", - "description" : "The ID of the component" - }, - "componentName" : { - "type" : "string", - "description" : "The name of the component" - }, - "processGroupId" : { - "type" : "string", - "description" : "The ID of the Process Group that the component belongs to" - }, - "differences" : { - "type" : "array", - "description" : "The differences in the component between the two flows", - "items" : { - "$ref" : "#/definitions/DifferenceDTO" - } - } - } - }, - "ComponentHistoryDTO" : { - "type" : "object", - "properties" : { - "componentId" : { - "type" : "string", - "description" : "The component id." - }, - "propertyHistory" : { - "type" : "object", - "description" : "The history for the properties of the component.", - "additionalProperties" : { - "$ref" : "#/definitions/PropertyHistoryDTO" - } - } - } - }, - "ComponentHistoryEntity" : { - "type" : "object", - "properties" : { - "componentHistory" : { - "$ref" : "#/definitions/ComponentHistoryDTO" - } - }, - "xml" : { - "name" : "componentHistoryEntity" - } - }, - "ComponentLifecycle" : { - "type" : "object" - }, - "ComponentManifest" : { - "type" : "object", - "properties" : { - "apis" : { - "type" : "array", - "description" : "Public interfaces defined in this bundle", - "items" : { - "$ref" : "#/definitions/DefinedType" - } - }, - "controllerServices" : { - "type" : "array", - "description" : "Controller Services provided in this bundle", - "items" : { - "$ref" : "#/definitions/ControllerServiceDefinition" - } - }, - "processors" : { - "type" : "array", - "description" : "Processors provided in this bundle", - "items" : { - "$ref" : "#/definitions/ProcessorDefinition" - } - }, - "reportingTasks" : { - "type" : "array", - "description" : "Reporting Tasks provided in this bundle", - "items" : { - "$ref" : "#/definitions/ReportingTaskDefinition" - } - } - } - }, - "ComponentReferenceDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "versionedComponentId" : { - "type" : "string", - "description" : "The ID of the corresponding component that is under version control" - }, - "parentGroupId" : { - "type" : "string", - "description" : "The id of parent process group of this component if applicable." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "name" : { - "type" : "string", - "description" : "The name of the component." - } - } - }, - "ComponentReferenceEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "parentGroupId" : { - "type" : "string", - "description" : "The id of parent process group of this component if applicable." - }, - "component" : { - "$ref" : "#/definitions/ComponentReferenceDTO" - } - }, - "xml" : { - "name" : "componentReferenceEntity" - } - }, - "ComponentRestrictionPermissionDTO" : { - "type" : "object", - "properties" : { - "requiredPermission" : { - "description" : "The required permission necessary for this restriction.", - "$ref" : "#/definitions/RequiredPermissionDTO" - }, - "permissions" : { - "description" : "The permissions for this component restriction. Note: the read permission are not used and will always be false.", - "$ref" : "#/definitions/PermissionsDTO" - } - } - }, - "ComponentSearchResultDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component that matched the search." - }, - "groupId" : { - "type" : "string", - "description" : "The group id of the component that matched the search." - }, - "parentGroup" : { - "description" : "The parent group of the component that matched the search.", - "$ref" : "#/definitions/SearchResultGroupDTO" - }, - "versionedGroup" : { - "description" : "The nearest versioned ancestor group of the component that matched the search.", - "$ref" : "#/definitions/SearchResultGroupDTO" - }, - "name" : { - "type" : "string", - "description" : "The name of the component that matched the search." - }, - "matches" : { - "type" : "array", - "description" : "What matched the search from the component.", - "items" : { - "type" : "string" - } - } - } - }, - "ComponentStateDTO" : { - "type" : "object", - "properties" : { - "componentId" : { - "type" : "string", - "description" : "The component identifier." - }, - "stateDescription" : { - "type" : "string", - "description" : "Description of the state this component persists." - }, - "clusterState" : { - "description" : "The cluster state for this component, or null if this NiFi is a standalone instance.", - "$ref" : "#/definitions/StateMapDTO" - }, - "localState" : { - "description" : "The local state for this component.", - "$ref" : "#/definitions/StateMapDTO" - } - } - }, - "ComponentStateEntity" : { - "type" : "object", - "properties" : { - "componentState" : { - "description" : "The component state.", - "$ref" : "#/definitions/ComponentStateDTO" - } - }, - "xml" : { - "name" : "componentStateEntity" - } - }, - "ComponentValidationResultDTO" : { - "type" : "object", - "properties" : { - "processGroupId" : { - "type" : "string", - "description" : "The UUID of the Process Group that this component is in" - }, - "id" : { - "type" : "string", - "description" : "The UUID of this component" - }, - "referenceType" : { - "type" : "string", - "description" : "The type of this component", - "enum" : [ "PROCESSOR", "CONTROLLER_SERVICE", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT" ] - }, - "name" : { - "type" : "string", - "description" : "The name of this component." - }, - "state" : { - "type" : "string", - "description" : "The scheduled state of a processor or reporting task referencing a controller service. If this component is another controller service, this field represents the controller service state." - }, - "activeThreadCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of active threads for the referencing component." - }, - "validationErrors" : { - "type" : "array", - "description" : "The validation errors for the component.", - "items" : { - "type" : "string" - } - }, - "currentlyValid" : { - "type" : "boolean", - "description" : "Whether or not the component is currently valid" - }, - "resultsValid" : { - "type" : "boolean", - "description" : "Whether or not the component will be valid if the Parameter Context is changed" - }, - "resultantValidationErrors" : { - "type" : "array", - "description" : "The validation errors that will apply to the component if the Parameter Context is changed", - "items" : { - "type" : "string" - } - } - } - }, - "ComponentValidationResultEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "component" : { - "$ref" : "#/definitions/ComponentValidationResultDTO" - } - }, - "xml" : { - "name" : "componentValidationResultEntity" - } - }, - "ComponentValidationResultsEntity" : { - "type" : "object", - "properties" : { - "validationResults" : { - "type" : "array", - "description" : "A List of ComponentValidationResultEntity, one for each component that is validated", - "items" : { - "$ref" : "#/definitions/ComponentValidationResultEntity" - } - } - }, - "xml" : { - "name" : "componentValidationResults" - } - }, - "ConfigVerificationResultDTO" : { - "type" : "object", - "properties" : { - "outcome" : { - "type" : "string", - "description" : "The outcome of the verification", - "enum" : [ "SUCCESSFUL", "FAILED", "SKIPPED" ] - }, - "verificationStepName" : { - "type" : "string", - "description" : "The name of the verification step" - }, - "explanation" : { - "type" : "string", - "description" : "An explanation of why the step was or was not successful" - } - } - }, - "ConfigurationAnalysisDTO" : { - "type" : "object", - "properties" : { - "componentId" : { - "type" : "string", - "description" : "The ID of the component" - }, - "properties" : { - "type" : "object", - "description" : "The configured properties for the component", - "additionalProperties" : { - "type" : "string" - } - }, - "referencedAttributes" : { - "type" : "object", - "description" : "The attributes that are referenced by the properties, mapped to recently used values", - "additionalProperties" : { - "type" : "string" - } - }, - "supportsVerification" : { - "type" : "boolean", - "description" : "Whether or not the component supports verification" - } - } - }, - "ConfigurationAnalysisEntity" : { - "type" : "object", - "properties" : { - "configurationAnalysis" : { - "description" : "The configuration analysis", - "$ref" : "#/definitions/ConfigurationAnalysisDTO" - } - }, - "xml" : { - "name" : "configurationAnalysis" - } - }, - "ConnectableComponent" : { - "type" : "object", - "required" : [ "groupId", "id", "type" ], - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the connectable component." - }, - "type" : { - "type" : "string", - "description" : "The type of component the connectable is.", - "enum" : [ "PROCESSOR", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "INPUT_PORT", "OUTPUT_PORT", "FUNNEL" ] - }, - "groupId" : { - "type" : "string", - "description" : "The id of the group that the connectable component resides in" - }, - "name" : { - "type" : "string", - "description" : "The name of the connectable component" - }, - "comments" : { - "type" : "string", - "description" : "The comments for the connectable component." - }, - "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" - } - } - }, - "ConnectableDTO" : { - "type" : "object", - "required" : [ "groupId", "id", "type" ], - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the connectable component." - }, - "versionedComponentId" : { - "type" : "string", - "description" : "The ID of the corresponding component that is under version control" - }, - "type" : { - "type" : "string", - "description" : "The type of component the connectable is.", - "enum" : [ "PROCESSOR", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "INPUT_PORT", "OUTPUT_PORT", "FUNNEL" ] - }, - "groupId" : { - "type" : "string", - "description" : "The id of the group that the connectable component resides in" - }, - "name" : { - "type" : "string", - "description" : "The name of the connectable component" - }, - "running" : { - "type" : "boolean", - "description" : "Reflects the current state of the connectable component." - }, - "transmitting" : { - "type" : "boolean", - "description" : "If the connectable component represents a remote port, indicates if the target is configured to transmit." - }, - "exists" : { - "type" : "boolean", - "description" : "If the connectable component represents a remote port, indicates if the target exists." - }, - "comments" : { - "type" : "string", - "description" : "The comments for the connectable component." - } - } - }, - "ConnectionDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "versionedComponentId" : { - "type" : "string", - "description" : "The ID of the corresponding component that is under version control" - }, - "parentGroupId" : { - "type" : "string", - "description" : "The id of parent process group of this component if applicable." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "source" : { - "description" : "The source of the connection.", - "$ref" : "#/definitions/ConnectableDTO" - }, - "destination" : { - "description" : "The destination of the connection.", - "$ref" : "#/definitions/ConnectableDTO" - }, - "name" : { - "type" : "string", - "description" : "The name of the connection." - }, - "labelIndex" : { - "type" : "integer", - "format" : "int32", - "description" : "The index of the bend point where to place the connection label." - }, - "getzIndex" : { - "type" : "integer", - "format" : "int64", - "description" : "The z index of the connection." - }, - "selectedRelationships" : { - "type" : "array", - "description" : "The selected relationship that comprise the connection.", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - }, - "availableRelationships" : { - "type" : "array", - "description" : "The relationships that the source of the connection currently supports.", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - }, - "backPressureObjectThreshold" : { - "type" : "integer", - "format" : "int64", - "description" : "The object count threshold for determining when back pressure is applied. Updating this value is a passive change in the sense that it won't impact whether existing files over the limit are affected but it does help feeder processors to stop pushing too much into this work queue." - }, - "backPressureDataSizeThreshold" : { - "type" : "string", - "description" : "The object data size threshold for determining when back pressure is applied. Updating this value is a passive change in the sense that it won't impact whether existing files over the limit are affected but it does help feeder processors to stop pushing too much into this work queue." - }, - "flowFileExpiration" : { - "type" : "string", - "description" : "The amount of time a flow file may be in the flow before it will be automatically aged out of the flow. Once a flow file reaches this age it will be terminated from the flow the next time a processor attempts to start work on it." - }, - "prioritizers" : { - "type" : "array", - "description" : "The comparators used to prioritize the queue.", - "items" : { - "type" : "string" - } - }, - "bends" : { - "type" : "array", - "description" : "The bend points on the connection.", - "items" : { - "$ref" : "#/definitions/PositionDTO" - } - }, - "loadBalanceStrategy" : { - "type" : "string", - "description" : "How to load balance the data in this Connection across the nodes in the cluster.", - "enum" : [ "DO_NOT_LOAD_BALANCE", "PARTITION_BY_ATTRIBUTE", "ROUND_ROBIN", "SINGLE_NODE" ] - }, - "loadBalancePartitionAttribute" : { - "type" : "string", - "description" : "The FlowFile Attribute to use for determining which node a FlowFile will go to if the Load Balancing Strategy is set to PARTITION_BY_ATTRIBUTE" - }, - "loadBalanceCompression" : { - "type" : "string", - "description" : "Whether or not data should be compressed when being transferred between nodes in the cluster.", - "enum" : [ "DO_NOT_COMPRESS", "COMPRESS_ATTRIBUTES_ONLY", "COMPRESS_ATTRIBUTES_AND_CONTENT" ] - }, - "loadBalanceStatus" : { - "type" : "string", - "description" : "The current status of the Connection's Load Balancing Activities. Status can indicate that Load Balancing is not configured for the connection, that Load Balancing is configured but inactive (not currently transferring data to another node), or that Load Balancing is configured and actively transferring data to another node.", - "enum" : [ "LOAD_BALANCE_NOT_CONFIGURED", "LOAD_BALANCE_INACTIVE", "LOAD_BALANCE_ACTIVE" ] - } - } - }, - "ConnectionDiagnosticsDTO" : { - "type" : "object", - "properties" : { - "connection" : { - "description" : "Details about the connection", - "$ref" : "#/definitions/ConnectionDTO" - }, - "aggregateSnapshot" : { - "description" : "Aggregate values for all nodes in the cluster, or for this instance if not clustered", - "$ref" : "#/definitions/ConnectionDiagnosticsSnapshotDTO" - }, - "nodeSnapshots" : { - "type" : "array", - "description" : "A list of values for each node in the cluster, if clustered.", - "items" : { - "$ref" : "#/definitions/ConnectionDiagnosticsSnapshotDTO" - } - } - } - }, - "ConnectionDiagnosticsSnapshotDTO" : { - "type" : "object", - "properties" : { - "totalFlowFileCount" : { - "type" : "integer", - "format" : "int32", - "description" : "Total number of FlowFiles owned by the Connection" - }, - "totalByteCount" : { - "type" : "integer", - "format" : "int64", - "description" : "Total number of bytes that make up the content for the FlowFiles owned by this Connection" - }, - "nodeIdentifier" : { - "type" : "string", - "description" : "The Node Identifier that this information pertains to" - }, - "localQueuePartition" : { - "description" : "The local queue partition, from which components can pull FlowFiles on this node.", - "$ref" : "#/definitions/LocalQueuePartitionDTO" - }, - "remoteQueuePartitions" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/RemoteQueuePartitionDTO" - } - } - } - }, - "ConnectionEntity" : { - "type" : "object", - "required" : [ "destinationType", "sourceType" ], - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "component" : { - "$ref" : "#/definitions/ConnectionDTO" - }, - "status" : { - "description" : "The status of the connection.", - "$ref" : "#/definitions/ConnectionStatusDTO" - }, - "bends" : { - "type" : "array", - "description" : "The bend points on the connection.", - "items" : { - "$ref" : "#/definitions/PositionDTO" - } - }, - "labelIndex" : { - "type" : "integer", - "format" : "int32", - "description" : "The index of the bend point where to place the connection label." - }, - "getzIndex" : { - "type" : "integer", - "format" : "int64", - "description" : "The z index of the connection." - }, - "sourceId" : { - "type" : "string", - "description" : "The identifier of the source of this connection." - }, - "sourceGroupId" : { - "type" : "string", - "description" : "The identifier of the group of the source of this connection." - }, - "sourceType" : { - "type" : "string", - "description" : "The type of component the source connectable is.", - "enum" : [ "PROCESSOR", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "INPUT_PORT", "OUTPUT_PORT", "FUNNEL" ] - }, - "destinationId" : { - "type" : "string", - "description" : "The identifier of the destination of this connection." - }, - "destinationGroupId" : { - "type" : "string", - "description" : "The identifier of the group of the destination of this connection." - }, - "destinationType" : { - "type" : "string", - "description" : "The type of component the destination connectable is.", - "enum" : [ "PROCESSOR", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "INPUT_PORT", "OUTPUT_PORT", "FUNNEL" ] - } - }, - "xml" : { - "name" : "connectionEntity" - } - }, - "ConnectionStatisticsDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The ID of the connection" - }, - "statsLastRefreshed" : { - "type" : "string", - "description" : "The timestamp of when the stats were last refreshed" - }, - "aggregateSnapshot" : { - "description" : "The status snapshot that represents the aggregate stats of the cluster", - "$ref" : "#/definitions/ConnectionStatisticsSnapshotDTO" - }, - "nodeSnapshots" : { - "type" : "array", - "description" : "A list of status snapshots for each node", - "items" : { - "$ref" : "#/definitions/NodeConnectionStatisticsSnapshotDTO" - } - } - } - }, - "ConnectionStatisticsEntity" : { - "type" : "object", - "properties" : { - "connectionStatistics" : { - "$ref" : "#/definitions/ConnectionStatisticsDTO" - }, - "canRead" : { - "type" : "boolean", - "description" : "Indicates whether the user can read a given resource." - } - }, - "xml" : { - "name" : "connectionStatisticsEntity" - } - }, - "ConnectionStatisticsSnapshotDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the connection." - }, - "predictedMillisUntilCountBackpressure" : { - "type" : "integer", - "format" : "int64", - "description" : "The predicted number of milliseconds before the connection will have backpressure applied, based on the queued count." - }, - "predictedMillisUntilBytesBackpressure" : { - "type" : "integer", - "format" : "int64", - "description" : "The predicted number of milliseconds before the connection will have backpressure applied, based on the total number of bytes in the queue." - }, - "predictedCountAtNextInterval" : { - "type" : "integer", - "format" : "int32", - "description" : "The predicted number of queued objects at the next configured interval." - }, - "predictedBytesAtNextInterval" : { - "type" : "integer", - "format" : "int64", - "description" : "The predicted total number of bytes in the queue at the next configured interval." - }, - "predictedPercentCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The predicted percentage of queued objects at the next configured interval." - }, - "predictedPercentBytes" : { - "type" : "integer", - "format" : "int32", - "description" : "The predicted percentage of bytes in the queue against current threshold at the next configured interval." - }, - "predictionIntervalMillis" : { - "type" : "integer", - "format" : "int64", - "description" : "The prediction interval in seconds" - } - } - }, - "ConnectionStatusDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The ID of the connection" - }, - "groupId" : { - "type" : "string", - "description" : "The ID of the Process Group that the connection belongs to" - }, - "name" : { - "type" : "string", - "description" : "The name of the connection" - }, - "statsLastRefreshed" : { - "type" : "string", - "description" : "The timestamp of when the stats were last refreshed" - }, - "sourceId" : { - "type" : "string", - "description" : "The ID of the source component" - }, - "sourceName" : { - "type" : "string", - "description" : "The name of the source component" - }, - "destinationId" : { - "type" : "string", - "description" : "The ID of the destination component" - }, - "destinationName" : { - "type" : "string", - "description" : "The name of the destination component" - }, - "aggregateSnapshot" : { - "description" : "The status snapshot that represents the aggregate stats of the cluster", - "$ref" : "#/definitions/ConnectionStatusSnapshotDTO" - }, - "nodeSnapshots" : { - "type" : "array", - "description" : "A list of status snapshots for each node", - "items" : { - "$ref" : "#/definitions/NodeConnectionStatusSnapshotDTO" - } - } - } - }, - "ConnectionStatusEntity" : { - "type" : "object", - "properties" : { - "connectionStatus" : { - "$ref" : "#/definitions/ConnectionStatusDTO" - }, - "canRead" : { - "type" : "boolean", - "description" : "Indicates whether the user can read a given resource." - } - }, - "xml" : { - "name" : "connectionStatusEntity" - } - }, - "ConnectionStatusPredictionsSnapshotDTO" : { - "type" : "object", - "properties" : { - "predictedMillisUntilCountBackpressure" : { - "type" : "integer", - "format" : "int64", - "description" : "The predicted number of milliseconds before the connection will have backpressure applied, based on the queued count." - }, - "predictedMillisUntilBytesBackpressure" : { - "type" : "integer", - "format" : "int64", - "description" : "The predicted number of milliseconds before the connection will have backpressure applied, based on the total number of bytes in the queue." - }, - "predictionIntervalSeconds" : { - "type" : "integer", - "format" : "int32", - "description" : "The configured interval (in seconds) for predicting connection queue count and size (and percent usage)." - }, - "predictedCountAtNextInterval" : { - "type" : "integer", - "format" : "int32", - "description" : "The predicted number of queued objects at the next configured interval." - }, - "predictedBytesAtNextInterval" : { - "type" : "integer", - "format" : "int64", - "description" : "The predicted total number of bytes in the queue at the next configured interval." - }, - "predictedPercentCount" : { - "type" : "integer", - "format" : "int32", - "description" : "Predicted connection percent use regarding queued flow files count and backpressure threshold if configured." - }, - "predictedPercentBytes" : { - "type" : "integer", - "format" : "int32", - "description" : "Predicted connection percent use regarding queued flow files size and backpressure threshold if configured." - } - } - }, - "ConnectionStatusSnapshotDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the connection." - }, - "groupId" : { - "type" : "string", - "description" : "The id of the process group the connection belongs to." - }, - "name" : { - "type" : "string", - "description" : "The name of the connection." - }, - "sourceId" : { - "type" : "string", - "description" : "The id of the source of the connection." - }, - "sourceName" : { - "type" : "string", - "description" : "The name of the source of the connection." - }, - "destinationId" : { - "type" : "string", - "description" : "The id of the destination of the connection." - }, - "destinationName" : { - "type" : "string", - "description" : "The name of the destination of the connection." - }, - "predictions" : { - "description" : "Predictions, if available, for this connection (null if not available)", - "$ref" : "#/definitions/ConnectionStatusPredictionsSnapshotDTO" - }, - "flowFilesIn" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of FlowFiles that have come into the connection in the last 5 minutes." - }, - "bytesIn" : { - "type" : "integer", - "format" : "int64", - "description" : "The size of the FlowFiles that have come into the connection in the last 5 minutes." - }, - "input" : { - "type" : "string", - "description" : "The input count/size for the connection in the last 5 minutes, pretty printed." - }, - "flowFilesOut" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of FlowFiles that have left the connection in the last 5 minutes." - }, - "bytesOut" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes that have left the connection in the last 5 minutes." - }, - "output" : { - "type" : "string", - "description" : "The output count/sie for the connection in the last 5 minutes, pretty printed." - }, - "flowFilesQueued" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of FlowFiles that are currently queued in the connection." - }, - "bytesQueued" : { - "type" : "integer", - "format" : "int64", - "description" : "The size of the FlowFiles that are currently queued in the connection." - }, - "queued" : { - "type" : "string", - "description" : "The total count and size of queued flowfiles formatted." - }, - "queuedSize" : { - "type" : "string", - "description" : "The total size of flowfiles that are queued formatted." - }, - "queuedCount" : { - "type" : "string", - "description" : "The number of flowfiles that are queued, pretty printed." - }, - "percentUseCount" : { - "type" : "integer", - "format" : "int32", - "description" : "Connection percent use regarding queued flow files count and backpressure threshold if configured." - }, - "percentUseBytes" : { - "type" : "integer", - "format" : "int32", - "description" : "Connection percent use regarding queued flow files size and backpressure threshold if configured." - }, - "flowFileAvailability" : { - "type" : "string", - "description" : "The availability of FlowFiles in this connection" - } - } - }, - "ConnectionStatusSnapshotEntity" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the connection." - }, - "connectionStatusSnapshot" : { - "$ref" : "#/definitions/ConnectionStatusSnapshotDTO" - }, - "canRead" : { - "type" : "boolean", - "description" : "Indicates whether the user can read a given resource." - } - }, - "xml" : { - "name" : "entity" - } - }, - "ConnectionsEntity" : { - "type" : "object", - "properties" : { - "connections" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ConnectionEntity" - } - } - }, - "xml" : { - "name" : "connectionsEntity" - } - }, - "ControllerBulletinsEntity" : { - "type" : "object", - "properties" : { - "bulletins" : { - "type" : "array", - "description" : "System level bulletins to be reported to the user.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "controllerServiceBulletins" : { - "type" : "array", - "description" : "Controller service bulletins to be reported to the user.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "reportingTaskBulletins" : { - "type" : "array", - "description" : "Reporting task bulletins to be reported to the user.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "parameterProviderBulletins" : { - "type" : "array", - "description" : "Parameter provider bulletins to be reported to the user.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "flowRegistryClientBulletins" : { - "type" : "array", - "description" : "Flow registry client bulletins to be reported to the user.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - } - }, - "xml" : { - "name" : "controllerConfigurationEntity" - } - }, - "ControllerConfigurationDTO" : { - "type" : "object", - "properties" : { - "maxTimerDrivenThreadCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The maximum number of timer driven threads the NiFi has available." - }, - "maxEventDrivenThreadCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The maximum number of event driven threads the NiFi has available." - } - } - }, - "ControllerConfigurationEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "component" : { - "description" : "The controller configuration.", - "$ref" : "#/definitions/ControllerConfigurationDTO" - } - }, - "xml" : { - "name" : "controllerConfigurationEntity" - } - }, - "ControllerDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the NiFi." - }, - "name" : { - "type" : "string", - "description" : "The name of the NiFi." - }, - "comments" : { - "type" : "string", - "description" : "The comments for the NiFi." - }, - "runningCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of running components in the NiFi." - }, - "stoppedCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of stopped components in the NiFi." - }, - "invalidCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of invalid components in the NiFi." - }, - "disabledCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of disabled components in the NiFi." - }, - "activeRemotePortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of active remote ports contained in the NiFi." - }, - "inactiveRemotePortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of inactive remote ports contained in the NiFi." - }, - "inputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of input ports contained in the NiFi." - }, - "outputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of output ports in the NiFi." - }, - "remoteSiteListeningPort" : { - "type" : "integer", - "format" : "int32", - "description" : "The Socket Port on which this instance is listening for Remote Transfers of Flow Files. If this instance is not configured to receive Flow Files from remote instances, this will be null." - }, - "remoteSiteHttpListeningPort" : { - "type" : "integer", - "format" : "int32", - "description" : "The HTTP(S) Port on which this instance is listening for Remote Transfers of Flow Files. If this instance is not configured to receive Flow Files from remote instances, this will be null." - }, - "siteToSiteSecure" : { - "type" : "boolean", - "description" : "Indicates whether or not Site-to-Site communications with this instance is secure (2-way authentication)." - }, - "instanceId" : { - "type" : "string", - "description" : "If clustered, the id of the Cluster Manager, otherwise the id of the NiFi." - }, - "inputPorts" : { - "type" : "array", - "description" : "The input ports available to send data to for the NiFi.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/PortDTO" - } - }, - "outputPorts" : { - "type" : "array", - "description" : "The output ports available to received data from the NiFi.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/PortDTO" - } - } - } - }, - "ControllerEntity" : { - "type" : "object", - "properties" : { - "controller" : { - "$ref" : "#/definitions/ControllerDTO" - } - }, - "xml" : { - "name" : "controllerEntity" - } - }, - "ControllerServiceAPI" : { - "type" : "object", - "properties" : { - "type" : { - "type" : "string", - "description" : "The fully qualified name of the service interface." - }, - "bundle" : { - "description" : "The details of the artifact that bundled this service interface.", - "$ref" : "#/definitions/Bundle" - } - } - }, - "ControllerServiceApiDTO" : { - "type" : "object", - "properties" : { - "type" : { - "type" : "string", - "description" : "The fully qualified name of the service interface." - }, - "bundle" : { - "description" : "The details of the artifact that bundled this service interface.", - "$ref" : "#/definitions/BundleDTO" - } - } - }, - "ControllerServiceDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "versionedComponentId" : { - "type" : "string", - "description" : "The ID of the corresponding component that is under version control" - }, - "parentGroupId" : { - "type" : "string", - "description" : "The id of parent process group of this component if applicable." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "name" : { - "type" : "string", - "description" : "The name of the controller service." - }, - "type" : { - "type" : "string", - "description" : "The type of the controller service." - }, - "bundle" : { - "description" : "The details of the artifact that bundled this processor type.", - "$ref" : "#/definitions/BundleDTO" - }, - "controllerServiceApis" : { - "type" : "array", - "description" : "Lists the APIs this Controller Service implements.", - "items" : { - "$ref" : "#/definitions/ControllerServiceApiDTO" - } - }, - "comments" : { - "type" : "string", - "description" : "The comments for the controller service." - }, - "state" : { - "type" : "string", - "description" : "The state of the controller service.", - "enum" : [ "ENABLED", "ENABLING", "DISABLED", "DISABLING" ] - }, - "persistsState" : { - "type" : "boolean", - "description" : "Whether the controller service persists state." - }, - "restricted" : { - "type" : "boolean", - "description" : "Whether the controller service requires elevated privileges." - }, - "deprecated" : { - "type" : "boolean", - "description" : "Whether the ontroller service has been deprecated." - }, - "multipleVersionsAvailable" : { - "type" : "boolean", - "description" : "Whether the controller service has multiple versions available." - }, - "supportsSensitiveDynamicProperties" : { - "type" : "boolean", - "description" : "Whether the controller service supports sensitive dynamic properties." - }, - "properties" : { - "type" : "object", - "description" : "The properties of the controller service.", - "additionalProperties" : { - "type" : "string" - } - }, - "descriptors" : { - "type" : "object", - "description" : "The descriptors for the controller service properties.", - "additionalProperties" : { - "$ref" : "#/definitions/PropertyDescriptorDTO" - } - }, - "sensitiveDynamicPropertyNames" : { - "type" : "array", - "description" : "Set of sensitive dynamic property names", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - }, - "customUiUrl" : { - "type" : "string", - "description" : "The URL for the controller services custom configuration UI if applicable." - }, - "annotationData" : { - "type" : "string", - "description" : "The annotation for the controller service. This is how the custom UI relays configuration to the controller service." - }, - "referencingComponents" : { - "type" : "array", - "description" : "All components referencing this controller service.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ControllerServiceReferencingComponentEntity" - } - }, - "validationErrors" : { - "type" : "array", - "description" : "The validation errors from the controller service. These validation errors represent the problems with the controller service that must be resolved before it can be enabled.", - "items" : { - "type" : "string" - } - }, - "validationStatus" : { - "type" : "string", - "description" : "Indicates whether the ControllerService is valid, invalid, or still in the process of validating (i.e., it is unknown whether or not the ControllerService is valid)", - "enum" : [ "VALID", "INVALID", "VALIDATING" ] - }, - "bulletinLevel" : { - "type" : "string", - "description" : "The level at which the controller service will report bulletins." - }, - "extensionMissing" : { - "type" : "boolean", - "description" : "Whether the underlying extension is missing." - } - } - }, - "ControllerServiceDefinition" : { - "type" : "object", - "required" : [ "type" ], - "properties" : { - "group" : { - "type" : "string", - "description" : "The group name of the bundle that provides the referenced type." - }, - "artifact" : { - "type" : "string", - "description" : "The artifact name of the bundle that provides the referenced type." - }, - "version" : { - "type" : "string", - "description" : "The version 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." - }, - "buildInfo" : { - "description" : "The build metadata for this component", - "$ref" : "#/definitions/BuildInfo" - }, - "providedApiImplementations" : { - "type" : "array", - "description" : "If this type represents a provider for an interface, this lists the APIs it implements", - "items" : { - "$ref" : "#/definitions/DefinedType" - } - }, - "tags" : { - "type" : "array", - "description" : "The tags associated with this type", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - }, - "seeAlso" : { - "type" : "array", - "description" : "The names of other component types that may be related", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - }, - "deprecated" : { - "type" : "boolean", - "description" : "Whether or not the component has been deprecated" - }, - "deprecationReason" : { - "type" : "string", - "description" : "If this component has been deprecated, this optional field can be used to provide an explanation" - }, - "deprecationAlternatives" : { - "type" : "array", - "description" : "If this component has been deprecated, this optional field provides alternatives to use", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - }, - "restricted" : { - "type" : "boolean", - "description" : "Whether or not the component has a general restriction" - }, - "restrictedExplanation" : { - "type" : "string", - "description" : "An optional description of the general restriction" - }, - "explicitRestrictions" : { - "type" : "array", - "description" : "Explicit restrictions that indicate a require permission to use the component", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/Restriction" - } - }, - "stateful" : { - "description" : "Indicates if the component stores state", - "$ref" : "#/definitions/Stateful" - }, - "systemResourceConsiderations" : { - "type" : "array", - "description" : "The system resource considerations for the given component", - "items" : { - "$ref" : "#/definitions/SystemResourceConsideration" - } - }, - "additionalDetails" : { - "type" : "boolean", - "description" : "Indicates if the component has additional details documentation" - }, - "propertyDescriptors" : { - "type" : "object", - "description" : "Descriptions of configuration properties applicable to this component.", - "additionalProperties" : { - "$ref" : "#/definitions/PropertyDescriptor" - } - }, - "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." - }, - "dynamicProperties" : { - "type" : "array", - "description" : "Describes the dynamic properties supported by this component", - "items" : { - "$ref" : "#/definitions/DynamicProperty" - } - } - } - }, - "ControllerServiceDiagnosticsDTO" : { - "type" : "object", - "properties" : { - "controllerService" : { - "description" : "The Controller Service", - "$ref" : "#/definitions/ControllerServiceEntity" - }, - "classLoaderDiagnostics" : { - "description" : "Information about the Controller Service's Class Loader", - "$ref" : "#/definitions/ClassLoaderDiagnosticsDTO" - } - } - }, - "ControllerServiceEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "parentGroupId" : { - "type" : "string", - "description" : "The id of parent process group of this ControllerService." - }, - "component" : { - "$ref" : "#/definitions/ControllerServiceDTO" - }, - "operatePermissions" : { - "description" : "The permissions for this component operations.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "status" : { - "description" : "The status for this ControllerService.", - "$ref" : "#/definitions/ControllerServiceStatusDTO" - } - }, - "xml" : { - "name" : "controllerServiceEntity" - } - }, - "ControllerServiceReferencingComponentDTO" : { - "type" : "object", - "properties" : { - "groupId" : { - "type" : "string", - "description" : "The group id for the component referencing a controller service. If this component is another controller service or a reporting task, this field is blank." - }, - "id" : { - "type" : "string", - "description" : "The id of the component referencing a controller service." - }, - "name" : { - "type" : "string", - "description" : "The name of the component referencing a controller service." - }, - "type" : { - "type" : "string", - "description" : "The type of the component referencing a controller service in simple Java class name format without package name." - }, - "state" : { - "type" : "string", - "description" : "The scheduled state of a processor or reporting task referencing a controller service. If this component is another controller service, this field represents the controller service state." - }, - "properties" : { - "type" : "object", - "description" : "The properties for the component.", - "additionalProperties" : { - "type" : "string" - } - }, - "descriptors" : { - "type" : "object", - "description" : "The descriptors for the component properties.", - "additionalProperties" : { - "$ref" : "#/definitions/PropertyDescriptorDTO" - } - }, - "validationErrors" : { - "type" : "array", - "description" : "The validation errors for the component.", - "items" : { - "type" : "string" - } - }, - "referenceType" : { - "type" : "string", - "description" : "The type of reference this is.", - "enum" : [ "Processor", "ControllerService", "ReportingTask", "FlowRegistryClient" ] - }, - "activeThreadCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of active threads for the referencing component." - }, - "referenceCycle" : { - "type" : "boolean", - "description" : "If the referencing component represents a controller service, this indicates whether it has already been represented in this hierarchy." - }, - "referencingComponents" : { - "type" : "array", - "description" : "If the referencing component represents a controller service, these are the components that reference it.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ControllerServiceReferencingComponentEntity" - } - } - } - }, - "ControllerServiceReferencingComponentEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "component" : { - "$ref" : "#/definitions/ControllerServiceReferencingComponentDTO" - }, - "operatePermissions" : { - "description" : "The permissions for this component operations.", - "$ref" : "#/definitions/PermissionsDTO" - } - }, - "xml" : { - "name" : "controllerServiceReferencingComponentEntity" - } - }, - "ControllerServiceReferencingComponentsEntity" : { - "type" : "object", - "properties" : { - "controllerServiceReferencingComponents" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ControllerServiceReferencingComponentEntity" - } - } - }, - "xml" : { - "name" : "controllerServiceReferencingComponentsEntity" - } - }, - "ControllerServiceRunStatusEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "state" : { - "type" : "string", - "description" : "The run status of the ControllerService.", - "enum" : [ "ENABLED", "DISABLED" ] - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "uiOnly" : { - "type" : "boolean", - "description" : "Indicates whether or not responses should only include fields necessary for rendering the NiFi User Interface. As such, when this value is set to true, some fields may be returned as null values, and the selected fields may change at any time without notice. As a result, this value should not be set to true by any client other than the UI." - } - }, - "xml" : { - "name" : "entity" - } - }, - "ControllerServiceStatusDTO" : { - "type" : "object", - "properties" : { - "runStatus" : { - "type" : "string", - "description" : "The run status of this ControllerService", - "enum" : [ "ENABLED", "ENABLING", "DISABLED", "DISABLING" ] - }, - "validationStatus" : { - "type" : "string", - "description" : "Indicates whether the component is valid, invalid, or still in the process of validating (i.e., it is unknown whether or not the component is valid)", - "enum" : [ "VALID", "INVALID", "VALIDATING" ] - }, - "activeThreadCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of active threads for the component." - } - } - }, - "ControllerServiceTypesEntity" : { - "type" : "object", - "properties" : { - "controllerServiceTypes" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/DocumentedTypeDTO" - } - } - }, - "xml" : { - "name" : "controllerServiceTypesEntity" - } - }, - "ControllerServicesEntity" : { - "type" : "object", - "properties" : { - "currentTime" : { - "type" : "string", - "description" : "The current time on the system." - }, - "controllerServices" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ControllerServiceEntity" - } - } - }, - "xml" : { - "name" : "controllerServicesEntity" - } - }, - "ControllerStatusDTO" : { - "type" : "object", - "properties" : { - "activeThreadCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of active threads in the NiFi." - }, - "terminatedThreadCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of terminated threads in the NiFi." - }, - "queued" : { - "type" : "string", - "description" : "The number of flowfiles queued in the NiFi." - }, - "flowFilesQueued" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of FlowFiles queued across the entire flow" - }, - "bytesQueued" : { - "type" : "integer", - "format" : "int64", - "description" : "The size of the FlowFiles queued across the entire flow" - }, - "runningCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of running components in the NiFi." - }, - "stoppedCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of stopped components in the NiFi." - }, - "invalidCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of invalid components in the NiFi." - }, - "disabledCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of disabled components in the NiFi." - }, - "activeRemotePortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of active remote ports in the NiFi." - }, - "inactiveRemotePortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of inactive remote ports in the NiFi." - }, - "upToDateCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of up to date versioned process groups in the NiFi." - }, - "locallyModifiedCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of locally modified versioned process groups in the NiFi." - }, - "staleCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of stale versioned process groups in the NiFi." - }, - "locallyModifiedAndStaleCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of locally modified and stale versioned process groups in the NiFi." - }, - "syncFailureCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of versioned process groups in the NiFi that are unable to sync to a registry." - } - } - }, - "ControllerStatusEntity" : { - "type" : "object", - "properties" : { - "controllerStatus" : { - "$ref" : "#/definitions/ControllerStatusDTO" - } - }, - "xml" : { - "name" : "controllerStatusEntity" - } - }, - "CopySnippetRequestEntity" : { - "type" : "object", - "properties" : { - "snippetId" : { - "type" : "string", - "description" : "The identifier of the snippet." - }, - "originX" : { - "type" : "number", - "format" : "double", - "description" : "The x coordinate of the origin of the bounding box where the new components will be placed." - }, - "originY" : { - "type" : "number", - "format" : "double", - "description" : "The y coordinate of the origin of the bounding box where the new components will be placed." - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - } - }, - "xml" : { - "name" : "copySnippetRequestEntity" - } - }, - "CounterDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the counter." - }, - "context" : { - "type" : "string", - "description" : "The context of the counter." - }, - "name" : { - "type" : "string", - "description" : "The name of the counter." - }, - "valueCount" : { - "type" : "integer", - "format" : "int64", - "description" : "The value count." - }, - "value" : { - "type" : "string", - "description" : "The value of the counter." - } - } - }, - "CounterEntity" : { - "type" : "object", - "properties" : { - "counter" : { - "$ref" : "#/definitions/CounterDTO" - } - }, - "xml" : { - "name" : "counterEntity" - } - }, - "CountersDTO" : { - "type" : "object", - "properties" : { - "aggregateSnapshot" : { - "description" : "A Counters snapshot that represents the aggregate values of all nodes in the cluster. If the NiFi instance is a standalone instance, rather than a cluster, this represents the stats of the single instance.", - "$ref" : "#/definitions/CountersSnapshotDTO" - }, - "nodeSnapshots" : { - "type" : "array", - "description" : "A Counters snapshot for each node in the cluster. If the NiFi instance is a standalone instance, rather than a cluster, this may be null.", - "items" : { - "$ref" : "#/definitions/NodeCountersSnapshotDTO" - } - } - } - }, - "CountersEntity" : { - "type" : "object", - "properties" : { - "counters" : { - "$ref" : "#/definitions/CountersDTO" - } - }, - "xml" : { - "name" : "countersEntity" - } - }, - "CountersSnapshotDTO" : { - "type" : "object", - "properties" : { - "generated" : { - "type" : "string", - "description" : "The timestamp when the report was generated." - }, - "counters" : { - "type" : "array", - "description" : "All counters in the NiFi.", - "items" : { - "$ref" : "#/definitions/CounterDTO" - } - } - } - }, - "CreateActiveRequestEntity" : { - "type" : "object", - "properties" : { - "processGroupId" : { - "type" : "string", - "description" : "The Process Group ID that this active request will update" - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - } - }, - "xml" : { - "name" : "createActiveRequestEntity" - } - }, - "CreateTemplateRequestEntity" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The name of the template." - }, - "description" : { - "type" : "string", - "description" : "The description of the template." - }, - "snippetId" : { - "type" : "string", - "description" : "The identifier of the snippet." - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - } - }, - "xml" : { - "name" : "createTemplateRequestEntity" - } - }, - "CurrentUserEntity" : { - "type" : "object", - "properties" : { - "identity" : { - "type" : "string", - "description" : "The user identity being serialized." - }, - "anonymous" : { - "type" : "boolean", - "description" : "Whether the current user is anonymous." - }, - "provenancePermissions" : { - "description" : "Permissions for querying provenance.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "countersPermissions" : { - "description" : "Permissions for accessing counters.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "tenantsPermissions" : { - "description" : "Permissions for accessing tenants.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "controllerPermissions" : { - "description" : "Permissions for accessing the controller.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "policiesPermissions" : { - "description" : "Permissions for accessing the policies.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "systemPermissions" : { - "description" : "Permissions for accessing system.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "parameterContextPermissions" : { - "description" : "Permissions for accessing parameter contexts.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "restrictedComponentsPermissions" : { - "description" : "Permissions for accessing restricted components. Note: the read permission are not used and will always be false.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "componentRestrictionPermissions" : { - "type" : "array", - "description" : "Permissions for specific component restrictions.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ComponentRestrictionPermissionDTO" - } - }, - "canVersionFlows" : { - "type" : "boolean", - "description" : "Whether the current user can version flows." - } - }, - "xml" : { - "name" : "currentEntity" - } - }, - "DefinedType" : { - "type" : "object", - "required" : [ "type" ], - "properties" : { - "group" : { - "type" : "string", - "description" : "The group name of the bundle that provides the referenced type." - }, - "artifact" : { - "type" : "string", - "description" : "The artifact name of the bundle that provides the referenced type." - }, - "version" : { - "type" : "string", - "description" : "The version 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." - } - } - }, - "DifferenceDTO" : { - "type" : "object", - "properties" : { - "differenceType" : { - "type" : "string", - "description" : "The type of difference" - }, - "difference" : { - "type" : "string", - "description" : "Description of the difference" - } - } - }, - "DimensionsDTO" : { - "type" : "object", - "properties" : { - "width" : { - "type" : "number", - "format" : "double", - "description" : "The width of the label in pixels when at a 1:1 scale." - }, - "height" : { - "type" : "number", - "format" : "double", - "description" : "The height of the label in pixels when at a 1:1 scale." - } - } - }, - "DocumentedTypeDTO" : { - "type" : "object", - "properties" : { - "type" : { - "type" : "string", - "description" : "The fully qualified name of the type." - }, - "bundle" : { - "description" : "The details of the artifact that bundled this type.", - "$ref" : "#/definitions/BundleDTO" - }, - "controllerServiceApis" : { - "type" : "array", - "description" : "If this type represents a ControllerService, this lists the APIs it implements.", - "items" : { - "$ref" : "#/definitions/ControllerServiceApiDTO" - } - }, - "description" : { - "type" : "string", - "description" : "The description of the type." - }, - "restricted" : { - "type" : "boolean", - "description" : "Whether this type is restricted." - }, - "usageRestriction" : { - "type" : "string", - "description" : "The optional description of why the usage of this component is restricted." - }, - "explicitRestrictions" : { - "type" : "array", - "description" : "An optional collection of explicit restrictions. If specified, these explicit restrictions will be enfored.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ExplicitRestrictionDTO" - } - }, - "deprecationReason" : { - "type" : "string", - "description" : "The description of why the usage of this component is restricted." - }, - "tags" : { - "type" : "array", - "description" : "The tags associated with this type.", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - } - } - }, - "DropRequestDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id for this drop request." - }, - "uri" : { - "type" : "string", - "description" : "The URI for future requests to this drop request." - }, - "submissionTime" : { - "type" : "string", - "description" : "The timestamp when the query was submitted." - }, - "lastUpdated" : { - "type" : "string", - "description" : "The last time this drop request was updated." - }, - "percentCompleted" : { - "type" : "integer", - "format" : "int32", - "description" : "The current percent complete." - }, - "finished" : { - "type" : "boolean", - "description" : "Whether the query has finished." - }, - "failureReason" : { - "type" : "string", - "description" : "The reason, if any, that this drop request failed." - }, - "currentCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of flow files currently queued." - }, - "currentSize" : { - "type" : "integer", - "format" : "int64", - "description" : "The size of flow files currently queued in bytes." - }, - "current" : { - "type" : "string", - "description" : "The count and size of flow files currently queued." - }, - "originalCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of flow files to be dropped as a result of this request." - }, - "originalSize" : { - "type" : "integer", - "format" : "int64", - "description" : "The size of flow files to be dropped as a result of this request in bytes." - }, - "original" : { - "type" : "string", - "description" : "The count and size of flow files to be dropped as a result of this request." - }, - "droppedCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of flow files that have been dropped thus far." - }, - "droppedSize" : { - "type" : "integer", - "format" : "int64", - "description" : "The size of flow files that have been dropped thus far in bytes." - }, - "dropped" : { - "type" : "string", - "description" : "The count and size of flow files that have been dropped thus far." - }, - "state" : { - "type" : "string", - "description" : "The current state of the drop request." - } - } - }, - "DropRequestEntity" : { - "type" : "object", - "properties" : { - "dropRequest" : { - "$ref" : "#/definitions/DropRequestDTO" - } - }, - "xml" : { - "name" : "dropRequestEntity" - } - }, - "DtoFactory" : { - "type" : "object" - }, - "DynamicProperty" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The description of the dynamic property name" - }, - "value" : { - "type" : "string", - "description" : "The description of the dynamic property value" - }, - "description" : { - "type" : "string", - "description" : "The description of the dynamic property" - }, - "expressionLanguageScope" : { - "type" : "string", - "description" : "The scope of the expression language support", - "enum" : [ "NONE", "VARIABLE_REGISTRY", "FLOWFILE_ATTRIBUTES" ] - } - } - }, - "DynamicRelationship" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The description of the dynamic relationship name" - }, - "description" : { - "type" : "string", - "description" : "The description of the dynamic relationship" - } - } - }, - "Entity" : { - "type" : "object", - "xml" : { - "name" : "entity" - } - }, - "ExplicitRestrictionDTO" : { - "type" : "object", - "properties" : { - "requiredPermission" : { - "description" : "The required permission necessary for this restriction.", - "$ref" : "#/definitions/RequiredPermissionDTO" - }, - "explanation" : { - "type" : "string", - "description" : "The description of why the usage of this component is restricted for this required permission." - } - } - }, - "ExternalControllerServiceReference" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The identifier of the controller service" - }, - "name" : { - "type" : "string", - "description" : "The name of the controller service" - } - } - }, - "FlowBreadcrumbDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the group." - }, - "name" : { - "type" : "string", - "description" : "The id of the group." - }, - "versionControlInformation" : { - "description" : "The process group version control information or null if not version controlled.", - "$ref" : "#/definitions/VersionControlInformationDTO" - } - } - }, - "FlowBreadcrumbEntity" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of this ancestor ProcessGroup." - }, - "permissions" : { - "description" : "The permissions for this ancestor ProcessGroup.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "versionedFlowState" : { - "type" : "string", - "description" : "The current state of the Process Group, as it relates to the Versioned Flow", - "enum" : [ "LOCALLY_MODIFIED", "STALE", "LOCALLY_MODIFIED_AND_STALE", "UP_TO_DATE", "SYNC_FAILURE" ] - }, - "breadcrumb" : { - "description" : "This breadcrumb.", - "$ref" : "#/definitions/FlowBreadcrumbDTO" - }, - "parentBreadcrumb" : { - "description" : "The parent breadcrumb for this breadcrumb.", - "$ref" : "#/definitions/FlowBreadcrumbEntity" - } - }, - "xml" : { - "name" : "flowEntity" - } - }, - "FlowComparisonEntity" : { - "type" : "object", - "properties" : { - "componentDifferences" : { - "type" : "array", - "description" : "The list of differences for each component in the flow that is not the same between the two flows", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ComponentDifferenceDTO" - } - } - }, - "xml" : { - "name" : "flowComparisonEntity" - } - }, - "FlowConfigurationDTO" : { - "type" : "object", - "properties" : { - "supportsManagedAuthorizer" : { - "type" : "boolean", - "description" : "Whether this NiFi supports a managed authorizer. Managed authorizers can visualize users, groups, and policies in the UI." - }, - "supportsConfigurableAuthorizer" : { - "type" : "boolean", - "description" : "Whether this NiFi supports a configurable authorizer." - }, - "supportsConfigurableUsersAndGroups" : { - "type" : "boolean", - "description" : "Whether this NiFi supports configurable users and groups." - }, - "autoRefreshIntervalSeconds" : { - "type" : "integer", - "format" : "int64", - "description" : "The interval in seconds between the automatic NiFi refresh requests." - }, - "currentTime" : { - "type" : "string", - "description" : "The current time on the system." - }, - "timeOffset" : { - "type" : "integer", - "format" : "int32", - "description" : "The time offset of the system." - }, - "defaultBackPressureObjectThreshold" : { - "type" : "integer", - "format" : "int64", - "description" : "The default back pressure object threshold." - }, - "defaultBackPressureDataSizeThreshold" : { - "type" : "string", - "description" : "The default back pressure data size threshold." - } - } - }, - "FlowConfigurationEntity" : { - "type" : "object", - "properties" : { - "flowConfiguration" : { - "description" : "The controller configuration.", - "$ref" : "#/definitions/FlowConfigurationDTO" - } - }, - "xml" : { - "name" : "flowConfigurationEntity" - } - }, - "FlowDTO" : { - "type" : "object", - "properties" : { - "processGroups" : { - "type" : "array", - "description" : "The process groups in this flow.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ProcessGroupEntity" - } - }, - "remoteProcessGroups" : { - "type" : "array", - "description" : "The remote process groups in this flow.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/RemoteProcessGroupEntity" - } - }, - "processors" : { - "type" : "array", - "description" : "The processors in this flow.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ProcessorEntity" - } - }, - "inputPorts" : { - "type" : "array", - "description" : "The input ports in this flow.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/PortEntity" - } - }, - "outputPorts" : { - "type" : "array", - "description" : "The output ports in this flow.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/PortEntity" - } - }, - "connections" : { - "type" : "array", - "description" : "The connections in this flow.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ConnectionEntity" - } - }, - "labels" : { - "type" : "array", - "description" : "The labels in this flow.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/LabelEntity" - } - }, - "funnels" : { - "type" : "array", - "description" : "The funnels in this flow.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/FunnelEntity" - } - } - } - }, - "FlowEntity" : { - "type" : "object", - "properties" : { - "flow" : { - "$ref" : "#/definitions/FlowDTO" - } - }, - "xml" : { - "name" : "flowEntity" - } - }, - "FlowFileDTO" : { - "type" : "object", - "properties" : { - "uri" : { - "type" : "string", - "description" : "The URI that can be used to access this FlowFile." - }, - "uuid" : { - "type" : "string", - "description" : "The FlowFile UUID." - }, - "filename" : { - "type" : "string", - "description" : "The FlowFile filename." - }, - "position" : { - "type" : "integer", - "format" : "int32", - "description" : "The FlowFile's position in the queue." - }, - "size" : { - "type" : "integer", - "format" : "int64", - "description" : "The FlowFile file size." - }, - "queuedDuration" : { - "type" : "integer", - "format" : "int64", - "description" : "How long this FlowFile has been enqueued." - }, - "lineageDuration" : { - "type" : "integer", - "format" : "int64", - "description" : "Duration since the FlowFile's greatest ancestor entered the flow." - }, - "penaltyExpiresIn" : { - "type" : "integer", - "format" : "int64", - "description" : "How long in milliseconds until the FlowFile penalty expires." - }, - "clusterNodeId" : { - "type" : "string", - "description" : "The id of the node where this FlowFile resides." - }, - "clusterNodeAddress" : { - "type" : "string", - "description" : "The label for the node where this FlowFile resides." - }, - "attributes" : { - "type" : "object", - "description" : "The FlowFile attributes.", - "additionalProperties" : { - "type" : "string" - } - }, - "contentClaimSection" : { - "type" : "string", - "description" : "The section in which the content claim lives." - }, - "contentClaimContainer" : { - "type" : "string", - "description" : "The container in which the content claim lives." - }, - "contentClaimIdentifier" : { - "type" : "string", - "description" : "The identifier of the content claim." - }, - "contentClaimOffset" : { - "type" : "integer", - "format" : "int64", - "description" : "The offset into the content claim where the flowfile's content begins." - }, - "contentClaimFileSize" : { - "type" : "string", - "description" : "The file size of the content claim formatted." - }, - "contentClaimFileSizeBytes" : { - "type" : "integer", - "format" : "int64", - "description" : "The file size of the content claim in bytes." - }, - "penalized" : { - "type" : "boolean", - "description" : "If the FlowFile is penalized." - } - } - }, - "FlowFileEntity" : { - "type" : "object", - "properties" : { - "flowFile" : { - "$ref" : "#/definitions/FlowFileDTO" - } - }, - "xml" : { - "name" : "flowFileEntity" - } - }, - "FlowFileSummaryDTO" : { - "type" : "object", - "properties" : { - "uri" : { - "type" : "string", - "description" : "The URI that can be used to access this FlowFile." - }, - "uuid" : { - "type" : "string", - "description" : "The FlowFile UUID." - }, - "filename" : { - "type" : "string", - "description" : "The FlowFile filename." - }, - "position" : { - "type" : "integer", - "format" : "int32", - "description" : "The FlowFile's position in the queue." - }, - "size" : { - "type" : "integer", - "format" : "int64", - "description" : "The FlowFile file size." - }, - "queuedDuration" : { - "type" : "integer", - "format" : "int64", - "description" : "How long this FlowFile has been enqueued." - }, - "lineageDuration" : { - "type" : "integer", - "format" : "int64", - "description" : "Duration since the FlowFile's greatest ancestor entered the flow." - }, - "penaltyExpiresIn" : { - "type" : "integer", - "format" : "int64", - "description" : "How long in milliseconds until the FlowFile penalty expires." - }, - "clusterNodeId" : { - "type" : "string", - "description" : "The id of the node where this FlowFile resides." - }, - "clusterNodeAddress" : { - "type" : "string", - "description" : "The label for the node where this FlowFile resides." - }, - "penalized" : { - "type" : "boolean", - "description" : "If the FlowFile is penalized." - } - } - }, - "FlowRegistryBucket" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string" - }, - "name" : { - "type" : "string" - }, - "description" : { - "type" : "string" - }, - "createdTimestamp" : { - "type" : "integer", - "format" : "int64" - }, - "permissions" : { - "$ref" : "#/definitions/FlowRegistryPermissions" - } - } - }, - "FlowRegistryBucketDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The bucket identifier" - }, - "name" : { - "type" : "string", - "description" : "The bucket name" - }, - "description" : { - "type" : "string", - "description" : "The bucket description" - }, - "created" : { - "type" : "integer", - "format" : "int64", - "description" : "The created timestamp of this bucket" - } - } - }, - "FlowRegistryBucketEntity" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string" - }, - "bucket" : { - "$ref" : "#/definitions/FlowRegistryBucketDTO" - }, - "permissions" : { - "$ref" : "#/definitions/PermissionsDTO" - } - }, - "xml" : { - "name" : "bucketEntity" - } - }, - "FlowRegistryBucketsEntity" : { - "type" : "object", - "properties" : { - "buckets" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/FlowRegistryBucketEntity" - } - } - }, - "xml" : { - "name" : "bucketsEntity" - } - }, - "FlowRegistryClientDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The registry identifier" - }, - "name" : { - "type" : "string", - "description" : "The registry name" - }, - "description" : { - "type" : "string", - "description" : "The registry description" - }, - "uri" : { - "type" : "string" - }, - "type" : { - "type" : "string", - "description" : "The type of the controller service." - }, - "bundle" : { - "description" : "The details of the artifact that bundled this processor type.", - "$ref" : "#/definitions/BundleDTO" - }, - "properties" : { - "type" : "object", - "description" : "The properties of the controller service.", - "additionalProperties" : { - "type" : "string" - } - }, - "descriptors" : { - "type" : "object", - "description" : "The descriptors for the controller service properties.", - "additionalProperties" : { - "$ref" : "#/definitions/PropertyDescriptorDTO" - } - }, - "sensitiveDynamicPropertyNames" : { - "type" : "array", - "description" : "Set of sensitive dynamic property names", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - }, - "supportsSensitiveDynamicProperties" : { - "type" : "boolean", - "description" : "Whether the reporting task supports sensitive dynamic properties." - }, - "restricted" : { - "type" : "boolean", - "description" : "Whether the reporting task requires elevated privileges." - }, - "deprecated" : { - "type" : "boolean", - "description" : "Whether the reporting task has been deprecated." - }, - "validationErrors" : { - "type" : "array", - "description" : "Gets the validation errors from the reporting task. These validation errors represent the problems with the reporting task that must be resolved before it can be scheduled to run.", - "items" : { - "type" : "string" - } - }, - "validationStatus" : { - "type" : "string", - "description" : "Indicates whether the Processor is valid, invalid, or still in the process of validating (i.e., it is unknown whether or not the Processor is valid)", - "enum" : [ "VALID", "INVALID", "VALIDATING" ] - }, - "annotationData" : { - "type" : "string", - "description" : "The annotation data for the repoting task. This is how the custom UI relays configuration to the reporting task." - }, - "extensionMissing" : { - "type" : "boolean", - "description" : "Whether the underlying extension is missing." - }, - "multipleVersionsAvailable" : { - "type" : "boolean", - "description" : "Whether the flow registry client has multiple versions available." - } - } - }, - "FlowRegistryClientEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "registry" : { - "$ref" : "#/definitions/FlowRegistryClientDTO" - }, - "operatePermissions" : { - "$ref" : "#/definitions/PermissionsDTO" - }, - "component" : { - "$ref" : "#/definitions/FlowRegistryClientDTO" - } - }, - "xml" : { - "name" : "registryClientEntity" - } - }, - "FlowRegistryClientTypesEntity" : { - "type" : "object", - "properties" : { - "flowRegistryClientTypes" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/DocumentedTypeDTO" - } - } - }, - "xml" : { - "name" : "flowRegistryClientTypesEntity" - } - }, - "FlowRegistryClientsEntity" : { - "type" : "object", - "properties" : { - "registries" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/FlowRegistryClientEntity" - } - } - }, - "xml" : { - "name" : "registryClientsEntity" - } - }, - "FlowRegistryPermissions" : { - "type" : "object", - "properties" : { - "canRead" : { - "type" : "boolean" - }, - "canWrite" : { - "type" : "boolean" - }, - "canDelete" : { - "type" : "boolean" - } - } - }, - "FlowSnippetDTO" : { - "type" : "object", - "properties" : { - "processGroups" : { - "type" : "array", - "description" : "The process groups in this flow snippet.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ProcessGroupDTO" - } - }, - "remoteProcessGroups" : { - "type" : "array", - "description" : "The remote process groups in this flow snippet.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/RemoteProcessGroupDTO" - } - }, - "processors" : { - "type" : "array", - "description" : "The processors in this flow snippet.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ProcessorDTO" - } - }, - "inputPorts" : { - "type" : "array", - "description" : "The input ports in this flow snippet.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/PortDTO" - } - }, - "outputPorts" : { - "type" : "array", - "description" : "The output ports in this flow snippet.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/PortDTO" - } - }, - "connections" : { - "type" : "array", - "description" : "The connections in this flow snippet.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ConnectionDTO" - } - }, - "labels" : { - "type" : "array", - "description" : "The labels in this flow snippet.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/LabelDTO" - } - }, - "funnels" : { - "type" : "array", - "description" : "The funnels in this flow snippet.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/FunnelDTO" - } - }, - "controllerServices" : { - "type" : "array", - "description" : "The controller services in this flow snippet.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ControllerServiceDTO" - } - } - } - }, - "FunnelDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "versionedComponentId" : { - "type" : "string", - "description" : "The ID of the corresponding component that is under version control" - }, - "parentGroupId" : { - "type" : "string", - "description" : "The id of parent process group of this component if applicable." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - } - } - }, - "FunnelEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "component" : { - "$ref" : "#/definitions/FunnelDTO" - } - }, - "xml" : { - "name" : "funnelEntity" - } - }, - "FunnelsEntity" : { - "type" : "object", - "properties" : { - "funnels" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/FunnelEntity" - } - } - }, - "xml" : { - "name" : "funnelsEntity" - } - }, - "GCDiagnosticsSnapshotDTO" : { - "type" : "object", - "properties" : { - "timestamp" : { - "type" : "string", - "format" : "date-time", - "description" : "The timestamp of when the Snapshot was taken" - }, - "collectionCount" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of times that Garbage Collection has occurred" - }, - "collectionMillis" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of milliseconds that the Garbage Collector spent performing Garbage Collection duties" - } - } - }, - "GarbageCollectionDTO" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The name of the garbage collector." - }, - "collectionCount" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of times garbage collection has run." - }, - "collectionTime" : { - "type" : "string", - "description" : "The total amount of time spent garbage collecting." - }, - "collectionMillis" : { - "type" : "integer", - "format" : "int64", - "description" : "The total number of milliseconds spent garbage collecting." - } - } - }, - "GarbageCollectionDiagnosticsDTO" : { - "type" : "object", - "properties" : { - "memoryManagerName" : { - "type" : "string", - "description" : "The name of the Memory Manager that this Garbage Collection information pertains to" - }, - "snapshots" : { - "type" : "array", - "description" : "A list of snapshots that have been taken to determine the health of the JVM's heap", - "items" : { - "$ref" : "#/definitions/GCDiagnosticsSnapshotDTO" - } - } - } - }, - "HistoryDTO" : { - "type" : "object", - "properties" : { - "total" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of number of actions that matched the search criteria.." - }, - "lastRefreshed" : { - "type" : "string", - "description" : "The timestamp when the report was generated." - }, - "actions" : { - "type" : "array", - "description" : "The actions.", - "items" : { - "$ref" : "#/definitions/ActionEntity" - } - } - } - }, - "HistoryEntity" : { - "type" : "object", - "properties" : { - "history" : { - "$ref" : "#/definitions/HistoryDTO" - } - }, - "xml" : { - "name" : "historyEntity" - } - }, - "InputPortsEntity" : { - "type" : "object", - "properties" : { - "inputPorts" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/PortEntity" - } - } - }, - "xml" : { - "name" : "inputPortsEntity" - } - }, - "InputStream" : { - "type" : "object" - }, - "InstantiateTemplateRequestEntity" : { - "type" : "object", - "properties" : { - "originX" : { - "type" : "number", - "format" : "double", - "description" : "The x coordinate of the origin of the bounding box where the new components will be placed." - }, - "originY" : { - "type" : "number", - "format" : "double", - "description" : "The y coordinate of the origin of the bounding box where the new components will be placed." - }, - "templateId" : { - "type" : "string", - "description" : "The identifier of the template." - }, - "encodingVersion" : { - "type" : "string", - "description" : "The encoding version of the flow snippet. If not specified, this is automatically populated by the node receiving the user request. If the snippet is specified, the version will be the latest. If the snippet is not specified, the version will come from the underlying template. These details need to be replicated throughout the cluster to ensure consistency." - }, - "snippet" : { - "description" : "A flow snippet of the template contents. If not specified, this is automatically populated by the node receiving the user request. These details need to be replicated throughout the cluster to ensure consistency.", - "$ref" : "#/definitions/FlowSnippetDTO" - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - } - }, - "xml" : { - "name" : "instantiateTemplateRequestEntity" - } - }, - "JVMControllerDiagnosticsSnapshotDTO" : { - "type" : "object", - "properties" : { - "primaryNode" : { - "type" : "boolean", - "description" : "Whether or not this node is primary node" - }, - "clusterCoordinator" : { - "type" : "boolean", - "description" : "Whether or not this node is cluster coordinator" - }, - "maxTimerDrivenThreads" : { - "type" : "integer", - "format" : "int32", - "description" : "The maximum number of timer-driven threads" - }, - "maxEventDrivenThreads" : { - "type" : "integer", - "format" : "int32", - "description" : "The maximum number of event-driven threads" - } - } - }, - "JVMDiagnosticsDTO" : { - "type" : "object", - "properties" : { - "clustered" : { - "type" : "boolean", - "description" : "Whether or not the NiFi instance is clustered" - }, - "connected" : { - "type" : "boolean", - "description" : "Whether or not the node is connected to the cluster" - }, - "aggregateSnapshot" : { - "description" : "Aggregate JVM diagnostic information about the entire cluster", - "$ref" : "#/definitions/JVMDiagnosticsSnapshotDTO" - }, - "nodeSnapshots" : { - "type" : "array", - "description" : "Node-wise breakdown of JVM diagnostic information", - "items" : { - "$ref" : "#/definitions/NodeJVMDiagnosticsSnapshotDTO" - } - } - } - }, - "JVMDiagnosticsSnapshotDTO" : { - "type" : "object", - "properties" : { - "systemDiagnosticsDto" : { - "description" : "System-related diagnostics information", - "$ref" : "#/definitions/JVMSystemDiagnosticsSnapshotDTO" - }, - "flowDiagnosticsDto" : { - "description" : "Flow-related diagnostics information", - "$ref" : "#/definitions/JVMFlowDiagnosticsSnapshotDTO" - }, - "controllerDiagnostics" : { - "description" : "Controller-related diagnostics information", - "$ref" : "#/definitions/JVMControllerDiagnosticsSnapshotDTO" - } - } - }, - "JVMFlowDiagnosticsSnapshotDTO" : { - "type" : "object", - "properties" : { - "uptime" : { - "type" : "string", - "description" : "How long this node has been running, formatted as hours:minutes:seconds.milliseconds" - }, - "timeZone" : { - "type" : "string", - "description" : "The name of the Time Zone that is configured, if available" - }, - "activeTimerDrivenThreads" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of timer-driven threads that are active" - }, - "activeEventDrivenThreads" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of event-driven threads that are active" - }, - "bundlesLoaded" : { - "type" : "array", - "description" : "The NiFi Bundles (NARs) that are loaded by NiFi", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/BundleDTO" - } - } - } - }, - "JVMSystemDiagnosticsSnapshotDTO" : { - "type" : "object", - "properties" : { - "flowFileRepositoryStorageUsage" : { - "description" : "Information about the FlowFile Repository's usage", - "$ref" : "#/definitions/RepositoryUsageDTO" - }, - "contentRepositoryStorageUsage" : { - "type" : "array", - "description" : "Information about the Content Repository's usage", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/RepositoryUsageDTO" - } - }, - "provenanceRepositoryStorageUsage" : { - "type" : "array", - "description" : "Information about the Provenance Repository's usage", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/RepositoryUsageDTO" - } - }, - "maxHeapBytes" : { - "type" : "integer", - "format" : "int64", - "description" : "The maximum number of bytes that the JVM heap is configured to use for heap" - }, - "maxHeap" : { - "type" : "string", - "description" : "The maximum number of bytes that the JVM heap is configured to use, as a human-readable value" - }, - "garbageCollectionDiagnostics" : { - "type" : "array", - "description" : "Diagnostic information about the JVM's garbage collections", - "items" : { - "$ref" : "#/definitions/GarbageCollectionDiagnosticsDTO" - } - }, - "cpuCores" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of CPU Cores available on the system" - }, - "cpuLoadAverage" : { - "type" : "number", - "format" : "double", - "description" : "The 1-minute CPU Load Average" - }, - "physicalMemoryBytes" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes of RAM available on the system" - }, - "physicalMemory" : { - "type" : "string", - "description" : "The number of bytes of RAM available on the system as a human-readable value" - }, - "openFileDescriptors" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of files that are open by the NiFi process" - }, - "maxOpenFileDescriptors" : { - "type" : "integer", - "format" : "int64", - "description" : "The maximum number of open file descriptors that are available to each process" - } - } - }, - "JmxMetricsResultDTO" : { - "type" : "object", - "properties" : { - "beanName" : { - "type" : "string", - "description" : "The bean name of the metrics bean." - }, - "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" - } - } - }, - "JmxMetricsResultsEntity" : { - "type" : "object", - "properties" : { - "jmxMetricsResults" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/JmxMetricsResultDTO" - } - } - }, - "xml" : { - "name" : "jmxMetricsResult" - } - }, - "LabelDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "versionedComponentId" : { - "type" : "string", - "description" : "The ID of the corresponding component that is under version control" - }, - "parentGroupId" : { - "type" : "string", - "description" : "The id of parent process group of this component if applicable." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "label" : { - "type" : "string", - "description" : "The text that appears in the label." - }, - "width" : { - "type" : "number", - "format" : "double", - "description" : "The width of the label in pixels when at a 1:1 scale." - }, - "height" : { - "type" : "number", - "format" : "double", - "description" : "The height of the label in pixels when at a 1:1 scale." - }, - "getzIndex" : { - "type" : "integer", - "format" : "int64", - "description" : "The z index of the label." - }, - "style" : { - "type" : "object", - "description" : "The styles for this label (font-size : 12px, background-color : #eee, etc).", - "additionalProperties" : { - "type" : "string" - } - } - } - }, - "LabelEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "dimensions" : { - "$ref" : "#/definitions/DimensionsDTO" - }, - "getzIndex" : { - "type" : "integer", - "format" : "int64", - "description" : "The z index of the label." - }, - "component" : { - "$ref" : "#/definitions/LabelDTO" - } - }, - "xml" : { - "name" : "labelEntity" - } - }, - "LabelsEntity" : { - "type" : "object", - "properties" : { - "labels" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/LabelEntity" - } - } - }, - "xml" : { - "name" : "labelsEntity" - } - }, - "LineageDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of this lineage query." - }, - "uri" : { - "type" : "string", - "description" : "The URI for this lineage query for later retrieval and deletion." - }, - "submissionTime" : { - "type" : "string", - "description" : "When the lineage query was submitted." - }, - "expiration" : { - "type" : "string", - "description" : "When the lineage query will expire." - }, - "percentCompleted" : { - "type" : "integer", - "format" : "int32", - "description" : "The percent complete for the lineage query." - }, - "finished" : { - "type" : "boolean", - "description" : "Whether the lineage query has finished." - }, - "request" : { - "description" : "The initial lineage result.", - "$ref" : "#/definitions/LineageRequestDTO" - }, - "results" : { - "description" : "The results of the lineage query.", - "$ref" : "#/definitions/LineageResultsDTO" - } - } - }, - "LineageEntity" : { - "type" : "object", - "properties" : { - "lineage" : { - "$ref" : "#/definitions/LineageDTO" - } - }, - "xml" : { - "name" : "lineageEntity" - } - }, - "LineageRequestDTO" : { - "type" : "object", - "properties" : { - "eventId" : { - "type" : "integer", - "format" : "int64", - "description" : "The event id that was used to generate this lineage, if applicable. The event id is allowed for any type of lineageRequestType. If the lineageRequestType is FLOWFILE and the flowfile uuid is also included in the request, the event id will be ignored." - }, - "lineageRequestType" : { - "type" : "string", - "description" : "The type of lineage request. PARENTS will return the lineage for the flowfiles that are parents of the specified event. CHILDREN will return the lineage for the flowfiles that are children of the specified event. FLOWFILE will return the lineage for the specified flowfile.", - "enum" : [ "PARENTS", "CHILDREN", "and FLOWFILE" ] - }, - "uuid" : { - "type" : "string", - "description" : "The flowfile uuid that was used to generate the lineage. The flowfile uuid is only allowed when the lineageRequestType is FLOWFILE and will take precedence over event id." - }, - "clusterNodeId" : { - "type" : "string", - "description" : "The id of the node where this lineage originated if clustered." - } - } - }, - "LineageResultsDTO" : { - "type" : "object", - "properties" : { - "errors" : { - "type" : "array", - "description" : "Any errors that occurred while generating the lineage.", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - }, - "nodes" : { - "type" : "array", - "description" : "The nodes in the lineage.", - "items" : { - "$ref" : "#/definitions/ProvenanceNodeDTO" - } - }, - "links" : { - "type" : "array", - "description" : "The links between the nodes in the lineage.", - "items" : { - "$ref" : "#/definitions/ProvenanceLinkDTO" - } - } - } - }, - "ListingRequestDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id for this listing request." - }, - "uri" : { - "type" : "string", - "description" : "The URI for future requests to this listing request." - }, - "submissionTime" : { - "type" : "string", - "description" : "The timestamp when the query was submitted." - }, - "lastUpdated" : { - "type" : "string", - "description" : "The last time this listing request was updated." - }, - "percentCompleted" : { - "type" : "integer", - "format" : "int32", - "description" : "The current percent complete." - }, - "finished" : { - "type" : "boolean", - "description" : "Whether the query has finished." - }, - "failureReason" : { - "type" : "string", - "description" : "The reason, if any, that this listing request failed." - }, - "maxResults" : { - "type" : "integer", - "format" : "int32", - "description" : "The maximum number of FlowFileSummary objects to return" - }, - "state" : { - "type" : "string", - "description" : "The current state of the listing request." - }, - "queueSize" : { - "description" : "The size of the queue", - "$ref" : "#/definitions/QueueSizeDTO" - }, - "flowFileSummaries" : { - "type" : "array", - "description" : "The FlowFile summaries. The summaries will be populated once the request has completed.", - "items" : { - "$ref" : "#/definitions/FlowFileSummaryDTO" - } - }, - "sourceRunning" : { - "type" : "boolean", - "description" : "Whether the source of the connection is running" - }, - "destinationRunning" : { - "type" : "boolean", - "description" : "Whether the destination of the connection is running" - } - } - }, - "ListingRequestEntity" : { - "type" : "object", - "properties" : { - "listingRequest" : { - "$ref" : "#/definitions/ListingRequestDTO" - } - }, - "xml" : { - "name" : "listingRequestEntity" - } - }, - "LocalQueuePartitionDTO" : { - "type" : "object", - "properties" : { - "totalFlowFileCount" : { - "type" : "integer", - "format" : "int32", - "description" : "Total number of FlowFiles owned by the Connection" - }, - "totalByteCount" : { - "type" : "integer", - "format" : "int64", - "description" : "Total number of bytes that make up the content for the FlowFiles owned by this Connection" - }, - "activeQueueFlowFileCount" : { - "type" : "integer", - "format" : "int32", - "description" : "Total number of FlowFiles that exist in the Connection's Active Queue, immediately available to be offered up to a component" - }, - "activeQueueByteCount" : { - "type" : "integer", - "format" : "int64", - "description" : "Total number of bytes that make up the content for the FlowFiles that are present in the Connection's Active Queue" - }, - "swapFlowFileCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The total number of FlowFiles that are swapped out for this Connection" - }, - "swapByteCount" : { - "type" : "integer", - "format" : "int64", - "description" : "Total number of bytes that make up the content for the FlowFiles that are swapped out to disk for the Connection" - }, - "swapFiles" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of Swap Files that exist for this Connection" - }, - "inFlightFlowFileCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of In-Flight FlowFiles for this Connection. These are FlowFiles that belong to the connection but are currently being operated on by a Processor, Port, etc." - }, - "inFlightByteCount" : { - "type" : "integer", - "format" : "int64", - "description" : "The number bytes that make up the content of the FlowFiles that are In-Flight" - }, - "allActiveQueueFlowFilesPenalized" : { - "type" : "boolean", - "description" : "Whether or not all of the FlowFiles in the Active Queue are penalized" - }, - "anyActiveQueueFlowFilesPenalized" : { - "type" : "boolean", - "description" : "Whether or not any of the FlowFiles in the Active Queue are penalized" - } - } - }, - "NodeConnectionStatisticsSnapshotDTO" : { - "type" : "object", - "properties" : { - "nodeId" : { - "type" : "string", - "description" : "The unique ID that identifies the node" - }, - "address" : { - "type" : "string", - "description" : "The API address of the node" - }, - "apiPort" : { - "type" : "integer", - "format" : "int32", - "description" : "The API port used to communicate with the node" - }, - "statisticsSnapshot" : { - "description" : "The connection status snapshot from the node.", - "$ref" : "#/definitions/ConnectionStatisticsSnapshotDTO" - } - } - }, - "NodeConnectionStatusSnapshotDTO" : { - "type" : "object", - "properties" : { - "nodeId" : { - "type" : "string", - "description" : "The unique ID that identifies the node" - }, - "address" : { - "type" : "string", - "description" : "The API address of the node" - }, - "apiPort" : { - "type" : "integer", - "format" : "int32", - "description" : "The API port used to communicate with the node" - }, - "statusSnapshot" : { - "description" : "The connection status snapshot from the node.", - "$ref" : "#/definitions/ConnectionStatusSnapshotDTO" - } - } - }, - "NodeCountersSnapshotDTO" : { - "type" : "object", - "properties" : { - "nodeId" : { - "type" : "string", - "description" : "The unique ID that identifies the node" - }, - "address" : { - "type" : "string", - "description" : "The API address of the node" - }, - "apiPort" : { - "type" : "integer", - "format" : "int32", - "description" : "The API port used to communicate with the node" - }, - "snapshot" : { - "description" : "The counters from the node.", - "$ref" : "#/definitions/CountersSnapshotDTO" - } - } - }, - "NodeDTO" : { - "type" : "object", - "properties" : { - "nodeId" : { - "type" : "string", - "description" : "The id of the node." - }, - "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." - }, - "status" : { - "type" : "string", - "description" : "The node's status." - }, - "heartbeat" : { - "type" : "string", - "description" : "the time of the nodes's last heartbeat." - }, - "connectionRequested" : { - "type" : "string", - "description" : "The time of the node's last connection request." - }, - "roles" : { - "type" : "array", - "description" : "The roles of this node.", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - }, - "activeThreadCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The active threads for the NiFi on the node." - }, - "queued" : { - "type" : "string", - "description" : "The queue the NiFi on the node." - }, - "events" : { - "type" : "array", - "description" : "The node's events.", - "items" : { - "$ref" : "#/definitions/NodeEventDTO" - } - }, - "nodeStartTime" : { - "type" : "string", - "description" : "The time at which this Node was last refreshed." - } - } - }, - "NodeEntity" : { - "type" : "object", - "properties" : { - "node" : { - "$ref" : "#/definitions/NodeDTO" - } - }, - "xml" : { - "name" : "nodeEntity" - } - }, - "NodeEventDTO" : { - "type" : "object", - "properties" : { - "timestamp" : { - "type" : "string", - "description" : "The timestamp of the node event." - }, - "category" : { - "type" : "string", - "description" : "The category of the node event." - }, - "message" : { - "type" : "string", - "description" : "The message in the node event." - } - } - }, - "NodeIdentifier" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string" - }, - "apiAddress" : { - "type" : "string" - }, - "apiPort" : { - "type" : "integer", - "format" : "int32" - }, - "socketAddress" : { - "type" : "string" - }, - "socketPort" : { - "type" : "integer", - "format" : "int32" - }, - "loadBalanceAddress" : { - "type" : "string" - }, - "loadBalancePort" : { - "type" : "integer", - "format" : "int32" - }, - "siteToSiteAddress" : { - "type" : "string" - }, - "siteToSitePort" : { - "type" : "integer", - "format" : "int32" - }, - "siteToSiteHttpApiPort" : { - "type" : "integer", - "format" : "int32" - }, - "siteToSiteSecure" : { - "type" : "boolean" - }, - "nodeIdentities" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - }, - "fullDescription" : { - "type" : "string" - } - } - }, - "NodeJVMDiagnosticsSnapshotDTO" : { - "type" : "object", - "properties" : { - "nodeId" : { - "type" : "string", - "description" : "The unique ID that identifies the node" - }, - "address" : { - "type" : "string", - "description" : "The API address of the node" - }, - "apiPort" : { - "type" : "integer", - "format" : "int32", - "description" : "The API port used to communicate with the node" - }, - "snapshot" : { - "description" : "The JVM Diagnostics Snapshot", - "$ref" : "#/definitions/JVMDiagnosticsSnapshotDTO" - } - } - }, - "NodePortStatusSnapshotDTO" : { - "type" : "object", - "properties" : { - "nodeId" : { - "type" : "string", - "description" : "The unique ID that identifies the node" - }, - "address" : { - "type" : "string", - "description" : "The API address of the node" - }, - "apiPort" : { - "type" : "integer", - "format" : "int32", - "description" : "The API port used to communicate with the node" - }, - "statusSnapshot" : { - "description" : "The port status snapshot from the node.", - "$ref" : "#/definitions/PortStatusSnapshotDTO" - } - } - }, - "NodeProcessGroupStatusSnapshotDTO" : { - "type" : "object", - "properties" : { - "nodeId" : { - "type" : "string", - "description" : "The unique ID that identifies the node" - }, - "address" : { - "type" : "string", - "description" : "The API address of the node" - }, - "apiPort" : { - "type" : "integer", - "format" : "int32", - "description" : "The API port used to communicate with the node" - }, - "statusSnapshot" : { - "description" : "The process group status snapshot from the node.", - "$ref" : "#/definitions/ProcessGroupStatusSnapshotDTO" - } - } - }, - "NodeProcessorStatusSnapshotDTO" : { - "type" : "object", - "properties" : { - "nodeId" : { - "type" : "string", - "description" : "The unique ID that identifies the node" - }, - "address" : { - "type" : "string", - "description" : "The API address of the node" - }, - "apiPort" : { - "type" : "integer", - "format" : "int32", - "description" : "The API port used to communicate with the node" - }, - "statusSnapshot" : { - "description" : "The processor status snapshot from the node.", - "$ref" : "#/definitions/ProcessorStatusSnapshotDTO" - } - } - }, - "NodeRemoteProcessGroupStatusSnapshotDTO" : { - "type" : "object", - "properties" : { - "nodeId" : { - "type" : "string", - "description" : "The unique ID that identifies the node" - }, - "address" : { - "type" : "string", - "description" : "The API address of the node" - }, - "apiPort" : { - "type" : "integer", - "format" : "int32", - "description" : "The API port used to communicate with the node" - }, - "statusSnapshot" : { - "description" : "The remote process group status snapshot from the node.", - "$ref" : "#/definitions/RemoteProcessGroupStatusSnapshotDTO" - } - } - }, - "NodeReplayLastEventSnapshotDTO" : { - "type" : "object", - "properties" : { - "nodeId" : { - "type" : "string", - "description" : "The unique ID that identifies the node" - }, - "address" : { - "type" : "string", - "description" : "The API address of the node" - }, - "apiPort" : { - "type" : "integer", - "format" : "int32", - "description" : "The API port used to communicate with the node" - }, - "snapshot" : { - "description" : "The snapshot from the node", - "$ref" : "#/definitions/ReplayLastEventSnapshotDTO" - } - }, - "xml" : { - "name" : "nodeReplayLastEventSnapshot" - } - }, - "NodeResponse" : { - "type" : "object", - "properties" : { - "httpMethod" : { - "type" : "string" - }, - "requestUri" : { - "type" : "string", - "format" : "uri" - }, - "response" : { - "$ref" : "#/definitions/Response" - }, - "nodeId" : { - "$ref" : "#/definitions/NodeIdentifier" - }, - "throwable" : { - "$ref" : "#/definitions/Throwable" - }, - "updatedEntity" : { - "$ref" : "#/definitions/Entity" - }, - "requestId" : { - "type" : "string" - }, - "inputStream" : { - "$ref" : "#/definitions/InputStream" - }, - "clientResponse" : { - "$ref" : "#/definitions/Response" - }, - "is2xx" : { - "type" : "boolean" - }, - "is5xx" : { - "type" : "boolean" - }, - "status" : { - "type" : "integer", - "format" : "int32" - } - } - }, - "NodeSearchResultDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the node that matched the search." - }, - "address" : { - "type" : "string", - "description" : "The address of the node that matched the search." - } - } - }, - "NodeStatusSnapshotsDTO" : { - "type" : "object", - "properties" : { - "nodeId" : { - "type" : "string", - "description" : "The id of the node." - }, - "address" : { - "type" : "string", - "description" : "The node's host/ip address." - }, - "apiPort" : { - "type" : "integer", - "format" : "int32", - "description" : "The port the node is listening for API requests." - }, - "statusSnapshots" : { - "type" : "array", - "description" : "A list of StatusSnapshotDTO objects that provide the actual metric values for the component for this node.", - "items" : { - "$ref" : "#/definitions/StatusSnapshotDTO" - } - } - } - }, - "NodeSystemDiagnosticsSnapshotDTO" : { - "type" : "object", - "properties" : { - "nodeId" : { - "type" : "string", - "description" : "The unique ID that identifies the node" - }, - "address" : { - "type" : "string", - "description" : "The API address of the node" - }, - "apiPort" : { - "type" : "integer", - "format" : "int32", - "description" : "The API port used to communicate with the node" - }, - "snapshot" : { - "description" : "The System Diagnostics snapshot from the node.", - "$ref" : "#/definitions/SystemDiagnosticsSnapshotDTO" - } - } - }, - "OutputPortsEntity" : { - "type" : "object", - "properties" : { - "outputPorts" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/PortEntity" - } - } - }, - "xml" : { - "name" : "outputPortsEntity" - } - }, - "ParameterContextDTO" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The Name of the Parameter Context." - }, - "description" : { - "type" : "string", - "description" : "The Description of the Parameter Context." - }, - "parameters" : { - "type" : "array", - "description" : "The Parameters for the Parameter Context", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ParameterEntity" - } - }, - "boundProcessGroups" : { - "type" : "array", - "description" : "The Process Groups that are bound to this Parameter Context", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ProcessGroupEntity" - } - }, - "inheritedParameterContexts" : { - "type" : "array", - "description" : "A list of references of Parameter Contexts from which this one inherits parameters", - "items" : { - "$ref" : "#/definitions/ParameterContextReferenceEntity" - } - }, - "parameterProviderConfiguration" : { - "description" : "Optional configuration for a Parameter Provider", - "$ref" : "#/definitions/ParameterProviderConfigurationEntity" - }, - "id" : { - "type" : "string", - "description" : "The ID the Parameter Context." - } - } - }, - "ParameterContextEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "component" : { - "description" : "The Parameter Context", - "$ref" : "#/definitions/ParameterContextDTO" - } - }, - "xml" : { - "name" : "parameterContextEntity" - } - }, - "ParameterContextReferenceDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The ID of the Parameter Context" - }, - "name" : { - "type" : "string", - "description" : "The name of the Parameter Context" - } - } - }, - "ParameterContextReferenceEntity" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "component" : { - "$ref" : "#/definitions/ParameterContextReferenceDTO" - } - }, - "xml" : { - "name" : "parameterContextReferenceEntity" - } - }, - "ParameterContextUpdateEntity" : { - "type" : "object", - "properties" : { - "parameterContextRevision" : { - "description" : "The Revision of the Parameter Context", - "$ref" : "#/definitions/RevisionDTO" - }, - "parameterContext" : { - "description" : "The Parameter Context that is being operated on. This may not be populated until the request has successfully completed.", - "$ref" : "#/definitions/ParameterContextDTO" - }, - "referencingComponents" : { - "type" : "array", - "description" : "The components that are referenced by the update.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/AffectedComponentEntity" - } - } - }, - "xml" : { - "name" : "parameterContextUpdateEntity" - } - }, - "ParameterContextUpdateRequestDTO" : { - "type" : "object", - "properties" : { - "requestId" : { - "type" : "string", - "description" : "The ID of the request" - }, - "uri" : { - "type" : "string", - "description" : "The URI for the request" - }, - "submissionTime" : { - "type" : "string", - "format" : "date-time", - "description" : "The timestamp of when the request was submitted" - }, - "lastUpdated" : { - "type" : "string", - "format" : "date-time", - "description" : "The timestamp of when the request was last updated" - }, - "complete" : { - "type" : "boolean", - "description" : "Whether or not the request is completed" - }, - "failureReason" : { - "type" : "string", - "description" : "The reason for the request failing, or null if the request has not failed" - }, - "percentCompleted" : { - "type" : "integer", - "format" : "int32", - "description" : "A value between 0 and 100 (inclusive) indicating how close the request is to completion" - }, - "state" : { - "type" : "string", - "description" : "A description of the current state of the request" - }, - "updateSteps" : { - "type" : "array", - "description" : "The steps that are required in order to complete the request, along with the status of each", - "items" : { - "$ref" : "#/definitions/ParameterContextUpdateStepDTO" - } - }, - "parameterContext" : { - "description" : "The Parameter Context that is being operated on. This may not be populated until the request has successfully completed.", - "$ref" : "#/definitions/ParameterContextDTO" - }, - "referencingComponents" : { - "type" : "array", - "description" : "The components that are referenced by the update.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/AffectedComponentEntity" - } - } - } - }, - "ParameterContextUpdateRequestEntity" : { - "type" : "object", - "properties" : { - "parameterContextRevision" : { - "description" : "The Revision of the Parameter Context", - "$ref" : "#/definitions/RevisionDTO" - }, - "request" : { - "description" : "The Update Request", - "$ref" : "#/definitions/ParameterContextUpdateRequestDTO" - } - }, - "xml" : { - "name" : "parameterContextUpdateRequestEntity" - } - }, - "ParameterContextUpdateStepDTO" : { - "type" : "object", - "properties" : { - "description" : { - "type" : "string", - "description" : "Explanation of what happens in this step" - }, - "complete" : { - "type" : "boolean", - "description" : "Whether or not this step has completed" - }, - "failureReason" : { - "type" : "string", - "description" : "An explanation of why this step failed, or null if this step did not fail" - } - } - }, - "ParameterContextValidationRequestDTO" : { - "type" : "object", - "properties" : { - "requestId" : { - "type" : "string", - "description" : "The ID of the request" - }, - "uri" : { - "type" : "string", - "description" : "The URI for the request" - }, - "submissionTime" : { - "type" : "string", - "format" : "date-time", - "description" : "The timestamp of when the request was submitted" - }, - "lastUpdated" : { - "type" : "string", - "format" : "date-time", - "description" : "The timestamp of when the request was last updated" - }, - "complete" : { - "type" : "boolean", - "description" : "Whether or not the request is completed" - }, - "failureReason" : { - "type" : "string", - "description" : "The reason for the request failing, or null if the request has not failed" - }, - "percentCompleted" : { - "type" : "integer", - "format" : "int32", - "description" : "A value between 0 and 100 (inclusive) indicating how close the request is to completion" - }, - "state" : { - "type" : "string", - "description" : "A description of the current state of the request" - }, - "updateSteps" : { - "type" : "array", - "description" : "The steps that are required in order to complete the request, along with the status of each", - "items" : { - "$ref" : "#/definitions/ParameterContextValidationStepDTO" - } - }, - "parameterContext" : { - "description" : "The Parameter Context that is being operated on.", - "$ref" : "#/definitions/ParameterContextDTO" - }, - "componentValidationResults" : { - "description" : "The Validation Results that were calculated for each component. This value may not be set until the request completes.", - "$ref" : "#/definitions/ComponentValidationResultsEntity" - } - } - }, - "ParameterContextValidationRequestEntity" : { - "type" : "object", - "properties" : { - "request" : { - "description" : "The Update Request", - "$ref" : "#/definitions/ParameterContextValidationRequestDTO" - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - } - }, - "xml" : { - "name" : "parameterContextValidationRequestEntity" - } - }, - "ParameterContextValidationStepDTO" : { - "type" : "object", - "properties" : { - "description" : { - "type" : "string", - "description" : "Explanation of what happens in this step" - }, - "complete" : { - "type" : "boolean", - "description" : "Whether or not this step has completed" - }, - "failureReason" : { - "type" : "string", - "description" : "An explanation of why this step failed, or null if this step did not fail" - } - } - }, - "ParameterContextsEntity" : { - "type" : "object", - "properties" : { - "parameterContexts" : { - "type" : "array", - "description" : "The Parameter Contexts", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ParameterContextEntity" - } - }, - "currentTime" : { - "type" : "string", - "description" : "The current time on the system." - } - }, - "xml" : { - "name" : "parameterContexts" - } - }, - "ParameterDTO" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The name of the Parameter" - }, - "description" : { - "type" : "string", - "description" : "The description of the Parameter" - }, - "sensitive" : { - "type" : "boolean", - "description" : "Whether or not the Parameter is sensitive" - }, - "value" : { - "type" : "string", - "description" : "The value of the Parameter" - }, - "valueRemoved" : { - "type" : "boolean", - "description" : "Whether or not the value of the Parameter was removed. When a request is made to change a parameter, the value may be null. The 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). This denotes which of the two scenarios is being encountered." - }, - "provided" : { - "type" : "boolean", - "description" : "Whether or not the Parameter is provided by a ParameterProvider" - }, - "referencingComponents" : { - "type" : "array", - "description" : "The set of all components in the flow that are referencing this Parameter", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/AffectedComponentEntity" - } - }, - "parameterContext" : { - "description" : "A reference to the Parameter Context that contains this one", - "$ref" : "#/definitions/ParameterContextReferenceEntity" - }, - "inherited" : { - "type" : "boolean", - "description" : "Whether or not the Parameter is inherited from another context" - } - } - }, - "ParameterEntity" : { - "type" : "object", - "properties" : { - "canWrite" : { - "type" : "boolean", - "description" : "Indicates whether the user can write a given resource." - }, - "parameter" : { - "description" : "The parameter information", - "$ref" : "#/definitions/ParameterDTO" - } - }, - "xml" : { - "name" : "parameterEntity" - } - }, - "ParameterGroupConfigurationEntity" : { - "type" : "object", - "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", - "description" : "All fetched parameter names that should be applied.", - "additionalProperties" : { - "type" : "string", - "enum" : [ "SENSITIVE", "NON_SENSITIVE" ] - } - }, - "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", - "properties" : { - "requestId" : { - "type" : "string", - "description" : "The ID of the request" - }, - "uri" : { - "type" : "string", - "description" : "The URI for the request" - }, - "submissionTime" : { - "type" : "string", - "format" : "date-time", - "description" : "The timestamp of when the request was submitted" - }, - "lastUpdated" : { - "type" : "string", - "format" : "date-time", - "description" : "The timestamp of when the request was last updated" - }, - "complete" : { - "type" : "boolean", - "description" : "Whether or not the request is completed" - }, - "failureReason" : { - "type" : "string", - "description" : "The reason for the request failing, or null if the request has not failed" - }, - "percentCompleted" : { - "type" : "integer", - "format" : "int32", - "description" : "A value between 0 and 100 (inclusive) indicating how close the request is to completion" - }, - "state" : { - "type" : "string", - "description" : "A description of the current state of the request" - }, - "updateSteps" : { - "type" : "array", - "description" : "The steps that are required in order to complete the request, along with the status of each", - "items" : { - "$ref" : "#/definitions/ParameterProviderApplyParametersUpdateStepDTO" - } - }, - "parameterProvider" : { - "description" : "The Parameter Provider that is being operated on. This may not be populated until the request has successfully completed.", - "$ref" : "#/definitions/ParameterProviderDTO" - }, - "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" : "#/definitions/ParameterContextUpdateEntity" - } - }, - "referencingComponents" : { - "type" : "array", - "description" : "The components that are referenced by the update.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/AffectedComponentEntity" - } - } - } - }, - "ParameterProviderApplyParametersRequestEntity" : { - "type" : "object", - "properties" : { - "request" : { - "description" : "The Apply Parameters Request", - "$ref" : "#/definitions/ParameterProviderApplyParametersRequestDTO" - } - }, - "xml" : { - "name" : "parameterProviderApplyParametersRequestEntity" - } - }, - "ParameterProviderApplyParametersUpdateStepDTO" : { - "type" : "object", - "properties" : { - "description" : { - "type" : "string", - "description" : "Explanation of what happens in this step" - }, - "complete" : { - "type" : "boolean", - "description" : "Whether or not this step has completed" - }, - "failureReason" : { - "type" : "string", - "description" : "An explanation of why this step failed, or null if this step did not fail" - } - } - }, - "ParameterProviderConfigurationDTO" : { - "type" : "object", - "properties" : { - "parameterProviderId" : { - "type" : "string", - "description" : "The ID of the Parameter Provider" - }, - "parameterProviderName" : { - "type" : "string", - "description" : "The name of the Parameter Provider" - }, - "parameterGroupName" : { - "type" : "string", - "description" : "The Parameter Group name that maps to the Parameter Context" - }, - "synchronized" : { - "type" : "boolean", - "description" : "True if the Parameter Context should receive the parameters from the mapped Parameter Group" - } - } - }, - "ParameterProviderConfigurationEntity" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "component" : { - "$ref" : "#/definitions/ParameterProviderConfigurationDTO" - } - }, - "xml" : { - "name" : "parameterProviderConfigurationEntity" - } - }, - "ParameterProviderDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "versionedComponentId" : { - "type" : "string", - "description" : "The ID of the corresponding component that is under version control" - }, - "parentGroupId" : { - "type" : "string", - "description" : "The id of parent process group of this component if applicable." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "name" : { - "type" : "string", - "description" : "The name of the parameter provider." - }, - "type" : { - "type" : "string", - "description" : "The fully qualified type of the parameter provider." - }, - "bundle" : { - "description" : "The details of the artifact that bundled this parameter provider type.", - "$ref" : "#/definitions/BundleDTO" - }, - "comments" : { - "type" : "string", - "description" : "The comments of the parameter provider." - }, - "persistsState" : { - "type" : "boolean", - "description" : "Whether the parameter provider persists state." - }, - "restricted" : { - "type" : "boolean", - "description" : "Whether the parameter provider requires elevated privileges." - }, - "deprecated" : { - "type" : "boolean", - "description" : "Whether the parameter provider has been deprecated." - }, - "multipleVersionsAvailable" : { - "type" : "boolean", - "description" : "Whether the parameter provider has multiple versions available." - }, - "properties" : { - "type" : "object", - "description" : "The properties of the parameter provider.", - "additionalProperties" : { - "type" : "string" - } - }, - "descriptors" : { - "type" : "object", - "description" : "The descriptors for the parameter providers properties.", - "additionalProperties" : { - "$ref" : "#/definitions/PropertyDescriptorDTO" - } - }, - "parameterGroupConfigurations" : { - "type" : "array", - "description" : "Configuration for any fetched parameter groups.", - "items" : { - "$ref" : "#/definitions/ParameterGroupConfigurationEntity" - } - }, - "affectedComponents" : { - "type" : "array", - "description" : "The set of all components in the flow that are referencing Parameters provided by this provider", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/AffectedComponentEntity" - } - }, - "parameterStatus" : { - "type" : "array", - "description" : "The status of all provided parameters for this parameter provider", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ParameterStatusDTO" - } - }, - "referencingParameterContexts" : { - "type" : "array", - "description" : "The Parameter Contexts that reference this Parameter Provider", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ParameterProviderReferencingComponentEntity" - } - }, - "customUiUrl" : { - "type" : "string", - "description" : "The URL for the custom configuration UI for the parameter provider." - }, - "annotationData" : { - "type" : "string", - "description" : "The annotation data for the parameter provider. This is how the custom UI relays configuration to 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" - } - }, - "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" ] - }, - "extensionMissing" : { - "type" : "boolean", - "description" : "Whether the underlying extension is missing." - } - } - }, - "ParameterProviderEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "component" : { - "$ref" : "#/definitions/ParameterProviderDTO" - } - }, - "xml" : { - "name" : "parameterProviderEntity" - } - }, - "ParameterProviderParameterApplicationEntity" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the parameter provider." - }, - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "parameterGroupConfigurations" : { - "type" : "array", - "description" : "Configuration for the fetched Parameter Groups", - "items" : { - "$ref" : "#/definitions/ParameterGroupConfigurationEntity" - } - } - }, - "xml" : { - "name" : "entity" - } - }, - "ParameterProviderParameterFetchEntity" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the parameter provider." - }, - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - } - }, - "xml" : { - "name" : "entity" - } - }, - "ParameterProviderReference" : { - "type" : "object", - "properties" : { - "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." - }, - "bundle" : { - "description" : "The details of the artifact that bundled this parameter provider.", - "$ref" : "#/definitions/Bundle" - } - } - }, - "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", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "component" : { - "$ref" : "#/definitions/ParameterProviderReferencingComponentDTO" - } - }, - "xml" : { - "name" : "parameterProviderReferencingComponentEntity" - } - }, - "ParameterProviderReferencingComponentsEntity" : { - "type" : "object", - "properties" : { - "parameterProviderReferencingComponents" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ParameterProviderReferencingComponentEntity" - } - } - }, - "xml" : { - "name" : "parameterProviderReferencingComponentsEntity" - } - }, - "ParameterProviderTypesEntity" : { - "type" : "object", - "properties" : { - "parameterProviderTypes" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/DocumentedTypeDTO" - } - } - }, - "xml" : { - "name" : "parameterProviderTypesEntity" - } - }, - "ParameterProvidersEntity" : { - "type" : "object", - "properties" : { - "parameterProviders" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ParameterProviderEntity" - } - } - }, - "xml" : { - "name" : "parameterProvidersEntity" - } - }, - "ParameterStatusDTO" : { - "type" : "object", - "properties" : { - "parameter" : { - "description" : "The name of the Parameter", - "$ref" : "#/definitions/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" ] - } - } - }, - "PeerDTO" : { - "type" : "object", - "properties" : { - "hostname" : { - "type" : "string", - "description" : "The hostname of this peer." - }, - "port" : { - "type" : "integer", - "format" : "int32", - "description" : "The port number of this peer." - }, - "secure" : { - "type" : "boolean", - "description" : "Returns if this peer connection is secure." - }, - "flowFileCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of flowFiles this peer holds." - } - } - }, - "PeersEntity" : { - "type" : "object", - "properties" : { - "peers" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/PeerDTO" - } - } - }, - "xml" : { - "name" : "peersEntity" - } - }, - "PermissionsDTO" : { - "type" : "object", - "properties" : { - "canRead" : { - "type" : "boolean", - "description" : "Indicates whether the user can read a given resource." - }, - "canWrite" : { - "type" : "boolean", - "description" : "Indicates whether the user can write a given resource." - } - } - }, - "PortDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "versionedComponentId" : { - "type" : "string", - "description" : "The ID of the corresponding component that is under version control" - }, - "parentGroupId" : { - "type" : "string", - "description" : "The id of parent process group of this component if applicable." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "name" : { - "type" : "string", - "description" : "The name of the port." - }, - "comments" : { - "type" : "string", - "description" : "The comments for the port." - }, - "state" : { - "type" : "string", - "description" : "The state of the port.", - "enum" : [ "RUNNING", "STOPPED", "DISABLED" ] - }, - "type" : { - "type" : "string", - "description" : "The type of port.", - "enum" : [ "INPUT_PORT", "OUTPUT_PORT" ] - }, - "transmitting" : { - "type" : "boolean", - "description" : "Whether the port has incoming or output connections to a remote NiFi. This is only applicable when the port is allowed to be accessed remotely." - }, - "concurrentlySchedulableTaskCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of tasks that should be concurrently scheduled for the port." - }, - "userAccessControl" : { - "type" : "array", - "description" : "The users that are allowed to access the port.", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - }, - "groupAccessControl" : { - "type" : "array", - "description" : "The user groups that are allowed to access the port.", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - }, - "allowRemoteAccess" : { - "type" : "boolean", - "description" : "Whether this port can be accessed remotely via Site-to-Site protocol." - }, - "validationErrors" : { - "type" : "array", - "description" : "Gets the validation errors from this port. These validation errors represent the problems with the port that must be resolved before it can be started.", - "items" : { - "type" : "string" - } - } - } - }, - "PortEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "component" : { - "$ref" : "#/definitions/PortDTO" - }, - "status" : { - "description" : "The status of the port.", - "$ref" : "#/definitions/PortStatusDTO" - }, - "portType" : { - "type" : "string" - }, - "operatePermissions" : { - "description" : "The permissions for this component operations.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "allowRemoteAccess" : { - "type" : "boolean", - "description" : "Whether this port can be accessed remotely via Site-to-Site protocol." - } - }, - "xml" : { - "name" : "portEntity" - } - }, - "PortRunStatusEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "state" : { - "type" : "string", - "description" : "The run status of the Port.", - "enum" : [ "RUNNING", "STOPPED", "DISABLED" ] - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - } - }, - "xml" : { - "name" : "entity" - } - }, - "PortStatusDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the port." - }, - "groupId" : { - "type" : "string", - "description" : "The id of the parent process group of the port." - }, - "name" : { - "type" : "string", - "description" : "The name of the port." - }, - "transmitting" : { - "type" : "boolean", - "description" : "Whether the port has incoming or outgoing connections to a remote NiFi." - }, - "runStatus" : { - "type" : "string", - "description" : "The run status of the port.", - "enum" : [ "Running", "Stopped", "Validating", "Disabled", "Invalid" ] - }, - "statsLastRefreshed" : { - "type" : "string", - "description" : "The time the status for the process group was last refreshed." - }, - "aggregateSnapshot" : { - "description" : "A status snapshot that represents the aggregate stats of all nodes in the cluster. If the NiFi instance is a standalone instance, rather than a cluster, this represents the stats of the single instance.", - "$ref" : "#/definitions/PortStatusSnapshotDTO" - }, - "nodeSnapshots" : { - "type" : "array", - "description" : "A status snapshot for each node in the cluster. If the NiFi instance is a standalone instance, rather than a cluster, this may be null.", - "items" : { - "$ref" : "#/definitions/NodePortStatusSnapshotDTO" - } - } - } - }, - "PortStatusEntity" : { - "type" : "object", - "properties" : { - "portStatus" : { - "$ref" : "#/definitions/PortStatusDTO" - }, - "canRead" : { - "type" : "boolean", - "description" : "Indicates whether the user can read a given resource." - } - }, - "xml" : { - "name" : "portStatusEntity" - } - }, - "PortStatusSnapshotDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the port." - }, - "groupId" : { - "type" : "string", - "description" : "The id of the parent process group of the port." - }, - "name" : { - "type" : "string", - "description" : "The name of the port." - }, - "activeThreadCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The active thread count for the port." - }, - "flowFilesIn" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of FlowFiles that have been accepted in the last 5 minutes." - }, - "bytesIn" : { - "type" : "integer", - "format" : "int64", - "description" : "The size of hte FlowFiles that have been accepted in the last 5 minutes." - }, - "input" : { - "type" : "string", - "description" : "The count/size of flowfiles that have been accepted in the last 5 minutes." - }, - "flowFilesOut" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of FlowFiles that have been processed in the last 5 minutes." - }, - "bytesOut" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes that have been processed in the last 5 minutes." - }, - "output" : { - "type" : "string", - "description" : "The count/size of flowfiles that have been processed in the last 5 minutes." - }, - "transmitting" : { - "type" : "boolean", - "description" : "Whether the port has incoming or outgoing connections to a remote NiFi." - }, - "runStatus" : { - "type" : "string", - "description" : "The run status of the port.", - "enum" : [ "Running", "Stopped", "Validating", "Disabled", "Invalid" ] - } - } - }, - "PortStatusSnapshotEntity" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the port." - }, - "portStatusSnapshot" : { - "$ref" : "#/definitions/PortStatusSnapshotDTO" - }, - "canRead" : { - "type" : "boolean", - "description" : "Indicates whether the user can read a given resource." - } - }, - "xml" : { - "name" : "entity" - } - }, - "Position" : { - "type" : "object", - "properties" : { - "x" : { - "type" : "number", - "format" : "double", - "description" : "The x coordinate." - }, - "y" : { - "type" : "number", - "format" : "double", - "description" : "The y coordinate." - } - }, - "description" : "The position of a component on the graph" - }, - "PositionDTO" : { - "type" : "object", - "properties" : { - "x" : { - "type" : "number", - "format" : "double", - "description" : "The x coordinate." - }, - "y" : { - "type" : "number", - "format" : "double", - "description" : "The y coordinate." - } - } - }, - "PreviousValueDTO" : { - "type" : "object", - "properties" : { - "previousValue" : { - "type" : "string", - "description" : "The previous value." - }, - "timestamp" : { - "type" : "string", - "description" : "The timestamp when the value was modified." - }, - "userIdentity" : { - "type" : "string", - "description" : "The user who changed the previous value." - } - } - }, - "PrioritizerTypesEntity" : { - "type" : "object", - "properties" : { - "prioritizerTypes" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/DocumentedTypeDTO" - } - } - }, - "xml" : { - "name" : "prioritizerTypesEntity" - } - }, - "ProcessGroupDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "versionedComponentId" : { - "type" : "string", - "description" : "The ID of the corresponding component that is under version control" - }, - "parentGroupId" : { - "type" : "string", - "description" : "The id of parent process group of this component if applicable." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "name" : { - "type" : "string", - "description" : "The name of the process group." - }, - "comments" : { - "type" : "string", - "description" : "The comments for the process group." - }, - "variables" : { - "type" : "object", - "description" : "The variables that are configured for the Process Group. Note that this map contains only those variables that are defined on this Process Group and not any variables that are defined in the parent Process Group, etc. I.e., this Map will not contain all variables that are accessible by components in this Process Group by rather only the variables that are defined for this Process Group itself.", - "additionalProperties" : { - "type" : "string" - } - }, - "versionControlInformation" : { - "description" : "The Version Control information that indicates which Flow Registry, and where in the Flow Registry, this Process Group is tracking to; or null if this Process Group is not under version control", - "$ref" : "#/definitions/VersionControlInformationDTO" - }, - "parameterContext" : { - "description" : "The Parameter Context that this Process Group is bound to.", - "$ref" : "#/definitions/ParameterContextReferenceEntity" - }, - "flowfileConcurrency" : { - "type" : "string", - "description" : "The FlowFile Concurrency for this Process Group.", - "enum" : [ "UNBOUNDED", "SINGLE_FLOWFILE_PER_NODE", "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" ] - }, - "defaultFlowFileExpiration" : { - "type" : "string", - "description" : "The default FlowFile Expiration for this Process Group." - }, - "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." - }, - "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." - }, - "logFileSuffix" : { - "type" : "string", - "description" : "The log file suffix for this Process Group for dedicated logging." - }, - "runningCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of running components in this process group." - }, - "stoppedCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of stopped components in the process group." - }, - "invalidCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of invalid components in the process group." - }, - "disabledCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of disabled components in the process group." - }, - "activeRemotePortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of active remote ports in the process group." - }, - "inactiveRemotePortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of inactive remote ports in the process group." - }, - "upToDateCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of up to date versioned process groups in the process group." - }, - "locallyModifiedCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of locally modified versioned process groups in the process group." - }, - "staleCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of stale versioned process groups in the process group." - }, - "locallyModifiedAndStaleCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of locally modified and stale versioned process groups in the process group." - }, - "syncFailureCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of versioned process groups in the process group that are unable to sync to a registry." - }, - "localInputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of local input ports in the process group." - }, - "localOutputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of local output ports in the process group." - }, - "publicInputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of public input ports in the process group." - }, - "publicOutputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of public output ports in the process group." - }, - "contents" : { - "description" : "The contents of this process group.", - "$ref" : "#/definitions/FlowSnippetDTO" - }, - "inputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of input ports in the process group." - }, - "outputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of output ports in the process group." - } - } - }, - "ProcessGroupEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "component" : { - "$ref" : "#/definitions/ProcessGroupDTO" - }, - "status" : { - "description" : "The status of the process group.", - "$ref" : "#/definitions/ProcessGroupStatusDTO" - }, - "versionedFlowSnapshot" : { - "description" : "Returns the Versioned Flow that describes the contents of the Versioned Flow to be imported", - "$ref" : "#/definitions/RegisteredFlowSnapshot" - }, - "runningCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of running components in this process group." - }, - "stoppedCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of stopped components in the process group." - }, - "invalidCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of invalid components in the process group." - }, - "disabledCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of disabled components in the process group." - }, - "activeRemotePortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of active remote ports in the process group." - }, - "inactiveRemotePortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of inactive remote ports in the process group." - }, - "versionedFlowState" : { - "type" : "string", - "description" : "The current state of the Process Group, as it relates to the Versioned Flow", - "enum" : [ "LOCALLY_MODIFIED", "STALE", "LOCALLY_MODIFIED_AND_STALE", "UP_TO_DATE", "SYNC_FAILURE" ] - }, - "upToDateCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of up to date versioned process groups in the process group." - }, - "locallyModifiedCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of locally modified versioned process groups in the process group." - }, - "staleCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of stale versioned process groups in the process group." - }, - "locallyModifiedAndStaleCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of locally modified and stale versioned process groups in the process group." - }, - "syncFailureCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of versioned process groups in the process group that are unable to sync to a registry." - }, - "localInputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of local input ports in the process group." - }, - "localOutputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of local output ports in the process group." - }, - "publicInputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of public input ports in the process group." - }, - "publicOutputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of public output ports in the process group." - }, - "parameterContext" : { - "description" : "The Parameter Context, or null if no Parameter Context has been bound to the Process Group", - "$ref" : "#/definitions/ParameterContextReferenceEntity" - }, - "inputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of input ports in the process group." - }, - "outputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of output ports in the process group." - } - }, - "xml" : { - "name" : "processGroupEntity" - } - }, - "ProcessGroupFlowDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "parentGroupId" : { - "type" : "string", - "description" : "The id of parent process group of this component if applicable." - }, - "parameterContext" : { - "description" : "The Parameter Context, or null if no Parameter Context has been bound to the Process Group", - "$ref" : "#/definitions/ParameterContextReferenceEntity" - }, - "breadcrumb" : { - "description" : "The breadcrumb of the process group.", - "$ref" : "#/definitions/FlowBreadcrumbEntity" - }, - "flow" : { - "description" : "The flow structure starting at this Process Group.", - "$ref" : "#/definitions/FlowDTO" - }, - "lastRefreshed" : { - "type" : "string", - "description" : "The time the flow for the process group was last refreshed." - } - } - }, - "ProcessGroupFlowEntity" : { - "type" : "object", - "properties" : { - "permissions" : { - "description" : "The access policy for this process group.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "processGroupFlow" : { - "$ref" : "#/definitions/ProcessGroupFlowDTO" - } - }, - "xml" : { - "name" : "processGroupFlowEntity" - } - }, - "ProcessGroupImportEntity" : { - "type" : "object", - "properties" : { - "processGroupRevision" : { - "description" : "The Revision for the Process Group", - "$ref" : "#/definitions/RevisionDTO" - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "versionedFlowSnapshot" : { - "description" : "The Versioned Flow Snapshot to import", - "$ref" : "#/definitions/RegisteredFlowSnapshot" - } - }, - "xml" : { - "name" : "processGroupImportEntity" - } - }, - "ProcessGroupNameDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The ID of the Process Group" - }, - "name" : { - "type" : "string", - "description" : "The name of the Process Group, or the ID of the Process Group if the user does not have the READ policy for the Process Group" - } - } - }, - "ProcessGroupReplaceRequestDTO" : { - "type" : "object", - "properties" : { - "requestId" : { - "type" : "string", - "description" : "The unique ID of this request." - }, - "processGroupId" : { - "type" : "string", - "description" : "The unique ID of the Process Group being updated" - }, - "uri" : { - "type" : "string", - "description" : "The URI for future requests to this drop request." - }, - "lastUpdated" : { - "type" : "string", - "description" : "The last time this request was updated." - }, - "complete" : { - "type" : "boolean", - "description" : "Whether or not this request has completed" - }, - "failureReason" : { - "type" : "string", - "description" : "An explanation of why this request failed, or null if this request has not failed" - }, - "percentCompleted" : { - "type" : "integer", - "format" : "int32", - "description" : "The percentage complete for the request, between 0 and 100" - }, - "state" : { - "type" : "string", - "description" : "The state of the request" - } - } - }, - "ProcessGroupReplaceRequestEntity" : { - "type" : "object", - "properties" : { - "processGroupRevision" : { - "description" : "The revision for the Process Group being updated.", - "$ref" : "#/definitions/RevisionDTO" - }, - "request" : { - "description" : "The Process Group Change Request", - "$ref" : "#/definitions/ProcessGroupReplaceRequestDTO" - }, - "versionedFlowSnapshot" : { - "description" : "Returns the Versioned Flow to replace with", - "$ref" : "#/definitions/RegisteredFlowSnapshot" - } - }, - "xml" : { - "name" : "processGroupReplaceRequestEntity" - } - }, - "ProcessGroupStatusDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The ID of the Process Group" - }, - "name" : { - "type" : "string", - "description" : "The name of the Process Group" - }, - "statsLastRefreshed" : { - "type" : "string", - "description" : "The time the status for the process group was last refreshed." - }, - "aggregateSnapshot" : { - "description" : "The aggregate status of all nodes in the cluster", - "$ref" : "#/definitions/ProcessGroupStatusSnapshotDTO" - }, - "nodeSnapshots" : { - "type" : "array", - "description" : "The status reported by each node in the cluster. If the NiFi instance is a standalone instance, rather than a clustered instance, this value may be null.", - "items" : { - "$ref" : "#/definitions/NodeProcessGroupStatusSnapshotDTO" - } - } - } - }, - "ProcessGroupStatusEntity" : { - "type" : "object", - "properties" : { - "processGroupStatus" : { - "$ref" : "#/definitions/ProcessGroupStatusDTO" - }, - "canRead" : { - "type" : "boolean", - "description" : "Indicates whether the user can read a given resource." - } - }, - "xml" : { - "name" : "processGroupStatusEntity" - } - }, - "ProcessGroupStatusSnapshotDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the process group." - }, - "name" : { - "type" : "string", - "description" : "The name of this process group." - }, - "connectionStatusSnapshots" : { - "type" : "array", - "description" : "The status of all connections in the process group.", - "items" : { - "$ref" : "#/definitions/ConnectionStatusSnapshotEntity" - } - }, - "processorStatusSnapshots" : { - "type" : "array", - "description" : "The status of all processors in the process group.", - "items" : { - "$ref" : "#/definitions/ProcessorStatusSnapshotEntity" - } - }, - "processGroupStatusSnapshots" : { - "type" : "array", - "description" : "The status of all process groups in the process group.", - "items" : { - "$ref" : "#/definitions/ProcessGroupStatusSnapshotEntity" - } - }, - "remoteProcessGroupStatusSnapshots" : { - "type" : "array", - "description" : "The status of all remote process groups in the process group.", - "items" : { - "$ref" : "#/definitions/RemoteProcessGroupStatusSnapshotEntity" - } - }, - "inputPortStatusSnapshots" : { - "type" : "array", - "description" : "The status of all input ports in the process group.", - "items" : { - "$ref" : "#/definitions/PortStatusSnapshotEntity" - } - }, - "outputPortStatusSnapshots" : { - "type" : "array", - "description" : "The status of all output ports in the process group.", - "items" : { - "$ref" : "#/definitions/PortStatusSnapshotEntity" - } - }, - "versionedFlowState" : { - "type" : "string", - "description" : "The current state of the Process Group, as it relates to the Versioned Flow", - "enum" : [ "LOCALLY_MODIFIED", "STALE", "LOCALLY_MODIFIED_AND_STALE", "UP_TO_DATE", "SYNC_FAILURE" ] - }, - "flowFilesIn" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of FlowFiles that have come into this ProcessGroup in the last 5 minutes" - }, - "bytesIn" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes that have come into this ProcessGroup in the last 5 minutes" - }, - "input" : { - "type" : "string", - "description" : "The input count/size for the process group in the last 5 minutes (pretty printed)." - }, - "flowFilesQueued" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of FlowFiles that are queued up in this ProcessGroup right now" - }, - "bytesQueued" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes that are queued up in this ProcessGroup right now" - }, - "queued" : { - "type" : "string", - "description" : "The count/size that is queued in the the process group." - }, - "queuedCount" : { - "type" : "string", - "description" : "The count that is queued for the process group." - }, - "queuedSize" : { - "type" : "string", - "description" : "The size that is queued for the process group." - }, - "bytesRead" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes read by components in this ProcessGroup in the last 5 minutes" - }, - "read" : { - "type" : "string", - "description" : "The number of bytes read in the last 5 minutes." - }, - "bytesWritten" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes written by components in this ProcessGroup in the last 5 minutes" - }, - "written" : { - "type" : "string", - "description" : "The number of bytes written in the last 5 minutes." - }, - "flowFilesOut" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of FlowFiles transferred out of this ProcessGroup in the last 5 minutes" - }, - "bytesOut" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes transferred out of this ProcessGroup in the last 5 minutes" - }, - "output" : { - "type" : "string", - "description" : "The output count/size for the process group in the last 5 minutes." - }, - "flowFilesTransferred" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of FlowFiles transferred in this ProcessGroup in the last 5 minutes" - }, - "bytesTransferred" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes transferred in this ProcessGroup in the last 5 minutes" - }, - "transferred" : { - "type" : "string", - "description" : "The count/size transferred to/from queues in the process group in the last 5 minutes." - }, - "bytesReceived" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes received from external sources by components within this ProcessGroup in the last 5 minutes" - }, - "flowFilesReceived" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of FlowFiles received from external sources by components within this ProcessGroup in the last 5 minutes" - }, - "received" : { - "type" : "string", - "description" : "The count/size sent to the process group in the last 5 minutes." - }, - "bytesSent" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes sent to an external sink by components within this ProcessGroup in the last 5 minutes" - }, - "flowFilesSent" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of FlowFiles sent to an external sink by components within this ProcessGroup in the last 5 minutes" - }, - "sent" : { - "type" : "string", - "description" : "The count/size sent from this process group in the last 5 minutes." - }, - "activeThreadCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The active thread count for this process group." - }, - "terminatedThreadCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of threads currently terminated for the process group." - }, - "processingNanos" : { - "type" : "integer", - "format" : "int64" - } - } - }, - "ProcessGroupStatusSnapshotEntity" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the process group." - }, - "processGroupStatusSnapshot" : { - "$ref" : "#/definitions/ProcessGroupStatusSnapshotDTO" - }, - "canRead" : { - "type" : "boolean", - "description" : "Indicates whether the user can read a given resource." - } - }, - "xml" : { - "name" : "entity" - } - }, - "ProcessGroupsEntity" : { - "type" : "object", - "properties" : { - "processGroups" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ProcessGroupEntity" - } - } - }, - "xml" : { - "name" : "processGroupsEntity" - } - }, - "ProcessorConfigDTO" : { - "type" : "object", - "properties" : { - "properties" : { - "type" : "object", - "description" : "The properties for the processor. Properties whose value is not set will only contain the property name.", - "additionalProperties" : { - "type" : "string" - } - }, - "descriptors" : { - "type" : "object", - "description" : "Descriptors for the processor's properties.", - "additionalProperties" : { - "$ref" : "#/definitions/PropertyDescriptorDTO" - } - }, - "sensitiveDynamicPropertyNames" : { - "type" : "array", - "description" : "Set of sensitive dynamic property names", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - }, - "schedulingPeriod" : { - "type" : "string", - "description" : "The frequency with which to schedule the processor. The format of the value will depend on th value of schedulingStrategy." - }, - "schedulingStrategy" : { - "type" : "string", - "description" : "Indcates whether the prcessor should be scheduled to run in event or timer driven mode." - }, - "executionNode" : { - "type" : "string", - "description" : "Indicates the node where the process will execute." - }, - "penaltyDuration" : { - "type" : "string", - "description" : "The amount of time that is used when the process penalizes a flowfile." - }, - "yieldDuration" : { - "type" : "string", - "description" : "The amount of time that must elapse before this processor is scheduled again after yielding." - }, - "bulletinLevel" : { - "type" : "string", - "description" : "The level at which the processor will report bulletins." - }, - "runDurationMillis" : { - "type" : "integer", - "format" : "int64", - "description" : "The run duration for the processor in milliseconds." - }, - "concurrentlySchedulableTaskCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of tasks that should be concurrently schedule for the processor. If the processor doesn't allow parallol processing then any positive input will be ignored." - }, - "autoTerminatedRelationships" : { - "type" : "array", - "description" : "The names of all relationships that cause a flow file to be terminated if the relationship is not connected elsewhere. This property differs from the 'isAutoTerminate' property of the RelationshipDTO in that the RelationshipDTO is meant to depict the current configuration, whereas this property can be set in a DTO when updating a Processor in order to change which Relationships should be auto-terminated.", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - }, - "comments" : { - "type" : "string", - "description" : "The comments for the processor." - }, - "customUiUrl" : { - "type" : "string", - "description" : "The URL for the processor's custom configuration UI if applicable." - }, - "lossTolerant" : { - "type" : "boolean", - "description" : "Whether the processor is loss tolerant." - }, - "annotationData" : { - "type" : "string", - "description" : "The annotation data for the processor used to relay configuration between a custom UI and the procesosr." - }, - "defaultConcurrentTasks" : { - "type" : "object", - "description" : "Maps default values for concurrent tasks for each applicable scheduling strategy.", - "additionalProperties" : { - "type" : "string" - } - }, - "defaultSchedulingPeriod" : { - "type" : "object", - "description" : "Maps default values for scheduling period for each applicable scheduling strategy.", - "additionalProperties" : { - "type" : "string" - } - }, - "retryCount" : { - "type" : "integer", - "format" : "int32", - "description" : "Overall number of retries." - }, - "retriedRelationships" : { - "type" : "array", - "description" : "All the relationships should be retried.", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - }, - "backoffMechanism" : { - "type" : "string", - "description" : "Determines whether the FlowFile should be penalized or the processor should be yielded between retries.", - "enum" : [ "PENALIZE_FLOWFILE", "YIELD_PROCESSOR" ] - }, - "maxBackoffPeriod" : { - "type" : "string", - "description" : "Maximum amount of time to be waited during a retry period." - } - } - }, - "ProcessorDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "versionedComponentId" : { - "type" : "string", - "description" : "The ID of the corresponding component that is under version control" - }, - "parentGroupId" : { - "type" : "string", - "description" : "The id of parent process group of this component if applicable." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "name" : { - "type" : "string", - "description" : "The name of the processor." - }, - "type" : { - "type" : "string", - "description" : "The type of the processor." - }, - "bundle" : { - "description" : "The details of the artifact that bundled this processor type.", - "$ref" : "#/definitions/BundleDTO" - }, - "state" : { - "type" : "string", - "description" : "The state of the processor", - "enum" : [ "RUNNING", "STOPPED", "DISABLED" ] - }, - "style" : { - "type" : "object", - "description" : "Styles for the processor (background-color : #eee).", - "additionalProperties" : { - "type" : "string" - } - }, - "relationships" : { - "type" : "array", - "description" : "The available relationships that the processor currently supports.", - "items" : { - "$ref" : "#/definitions/RelationshipDTO" - } - }, - "description" : { - "type" : "string", - "description" : "The description of the processor." - }, - "supportsParallelProcessing" : { - "type" : "boolean", - "description" : "Whether the processor supports parallel processing." - }, - "supportsEventDriven" : { - "type" : "boolean", - "description" : "Whether the processor supports event driven scheduling." - }, - "supportsBatching" : { - "type" : "boolean", - "description" : "Whether the processor supports batching. This makes the run duration settings available." - }, - "supportsSensitiveDynamicProperties" : { - "type" : "boolean", - "description" : "Whether the processor supports sensitive dynamic properties." - }, - "persistsState" : { - "type" : "boolean", - "description" : "Whether the processor persists state." - }, - "restricted" : { - "type" : "boolean", - "description" : "Whether the processor requires elevated privileges." - }, - "deprecated" : { - "type" : "boolean", - "description" : "Whether the processor has been deprecated." - }, - "executionNodeRestricted" : { - "type" : "boolean", - "description" : "Indicates if the execution node of a processor is restricted to run only on the primary node" - }, - "multipleVersionsAvailable" : { - "type" : "boolean", - "description" : "Whether the processor has multiple versions available." - }, - "inputRequirement" : { - "type" : "string", - "description" : "The input requirement for this processor." - }, - "config" : { - "description" : "The configuration details for the processor. These details will be included in a response if the verbose flag is included in a request.", - "$ref" : "#/definitions/ProcessorConfigDTO" - }, - "validationErrors" : { - "type" : "array", - "description" : "The validation errors for the processor. These validation errors represent the problems with the processor that must be resolved before it can be started.", - "items" : { - "type" : "string" - } - }, - "validationStatus" : { - "type" : "string", - "description" : "Indicates whether the Processor is valid, invalid, or still in the process of validating (i.e., it is unknown whether or not the Processor is valid)", - "enum" : [ "VALID", "INVALID", "VALIDATING" ] - }, - "extensionMissing" : { - "type" : "boolean", - "description" : "Whether the underlying extension is missing." - } - } - }, - "ProcessorDefinition" : { - "type" : "object", - "required" : [ "type" ], - "properties" : { - "group" : { - "type" : "string", - "description" : "The group name of the bundle that provides the referenced type." - }, - "artifact" : { - "type" : "string", - "description" : "The artifact name of the bundle that provides the referenced type." - }, - "version" : { - "type" : "string", - "description" : "The version 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." - }, - "buildInfo" : { - "description" : "The build metadata for this component", - "$ref" : "#/definitions/BuildInfo" - }, - "providedApiImplementations" : { - "type" : "array", - "description" : "If this type represents a provider for an interface, this lists the APIs it implements", - "items" : { - "$ref" : "#/definitions/DefinedType" - } - }, - "tags" : { - "type" : "array", - "description" : "The tags associated with this type", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - }, - "seeAlso" : { - "type" : "array", - "description" : "The names of other component types that may be related", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - }, - "deprecated" : { - "type" : "boolean", - "description" : "Whether or not the component has been deprecated" - }, - "deprecationReason" : { - "type" : "string", - "description" : "If this component has been deprecated, this optional field can be used to provide an explanation" - }, - "deprecationAlternatives" : { - "type" : "array", - "description" : "If this component has been deprecated, this optional field provides alternatives to use", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - }, - "restricted" : { - "type" : "boolean", - "description" : "Whether or not the component has a general restriction" - }, - "restrictedExplanation" : { - "type" : "string", - "description" : "An optional description of the general restriction" - }, - "explicitRestrictions" : { - "type" : "array", - "description" : "Explicit restrictions that indicate a require permission to use the component", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/Restriction" - } - }, - "stateful" : { - "description" : "Indicates if the component stores state", - "$ref" : "#/definitions/Stateful" - }, - "systemResourceConsiderations" : { - "type" : "array", - "description" : "The system resource considerations for the given component", - "items" : { - "$ref" : "#/definitions/SystemResourceConsideration" - } - }, - "additionalDetails" : { - "type" : "boolean", - "description" : "Indicates if the component has additional details documentation" - }, - "propertyDescriptors" : { - "type" : "object", - "description" : "Descriptions of configuration properties applicable to this component.", - "additionalProperties" : { - "$ref" : "#/definitions/PropertyDescriptor" - } - }, - "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." - }, - "dynamicProperties" : { - "type" : "array", - "description" : "Describes the dynamic properties supported by this component", - "items" : { - "$ref" : "#/definitions/DynamicProperty" - } - }, - "inputRequirement" : { - "type" : "string", - "description" : "Any input requirements this processor has.", - "enum" : [ "INPUT_REQUIRED", "INPUT_ALLOWED", "INPUT_FORBIDDEN" ] - }, - "supportedRelationships" : { - "type" : "array", - "description" : "The supported relationships for this processor.", - "items" : { - "$ref" : "#/definitions/Relationship" - } - }, - "supportsDynamicRelationships" : { - "type" : "boolean", - "description" : "Whether or not this processor supports dynamic relationships." - }, - "dynamicRelationship" : { - "description" : "If the processor supports dynamic relationships, this describes the dynamic relationship", - "$ref" : "#/definitions/DynamicRelationship" - }, - "triggerSerially" : { - "type" : "boolean", - "description" : "Whether or not this processor should be triggered serially (i.e. no concurrent execution)." - }, - "triggerWhenEmpty" : { - "type" : "boolean", - "description" : "Whether or not this processor should be triggered when incoming queues are empty." - }, - "triggerWhenAnyDestinationAvailable" : { - "type" : "boolean", - "description" : "Whether or not this processor should be triggered when any destination queue has room." - }, - "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." - }, - "supportsEventDriven" : { - "type" : "boolean", - "description" : "Whether or not this processor supports event driven scheduling. Indicates to the framework that the Processor is eligible to be scheduled to run based on the occurrence of an \"Event\" (e.g., when a FlowFile is enqueued in an incoming Connection), rather than being triggered periodically." - }, - "primaryNodeOnly" : { - "type" : "boolean", - "description" : "Whether or not this processor should be scheduled only on the primary node in a cluster." - }, - "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." - }, - "supportedSchedulingStrategies" : { - "type" : "array", - "description" : "The supported scheduling strategies, such as TIME_DRIVER, CRON, or EVENT_DRIVEN.", - "items" : { - "type" : "string" - } - }, - "defaultSchedulingStrategy" : { - "type" : "string", - "description" : "The default scheduling strategy for the processor." - }, - "defaultConcurrentTasksBySchedulingStrategy" : { - "type" : "object", - "description" : "The default concurrent tasks for each scheduling strategy.", - "additionalProperties" : { - "type" : "integer", - "format" : "int32" - } - }, - "defaultSchedulingPeriodBySchedulingStrategy" : { - "type" : "object", - "description" : "The default scheduling period for each scheduling strategy. The scheduling period is expected to be a time period, such as \"30 sec\".", - "additionalProperties" : { - "type" : "string" - } - }, - "defaultPenaltyDuration" : { - "type" : "string", - "description" : "The default penalty duration as a time period, such as \"30 sec\"." - }, - "defaultYieldDuration" : { - "type" : "string", - "description" : "The default yield duration as a time period, such as \"1 sec\"." - }, - "defaultBulletinLevel" : { - "type" : "string", - "description" : "The default bulletin level, such as WARN, INFO, DEBUG, etc." - }, - "readsAttributes" : { - "type" : "array", - "description" : "The FlowFile attributes this processor reads", - "items" : { - "$ref" : "#/definitions/Attribute" - } - }, - "writesAttributes" : { - "type" : "array", - "description" : "The FlowFile attributes this processor writes/updates", - "items" : { - "$ref" : "#/definitions/Attribute" - } - } - } - }, - "ProcessorDiagnosticsDTO" : { - "type" : "object", - "properties" : { - "processor" : { - "description" : "Information about the Processor for which the Diagnostic Report is generated", - "$ref" : "#/definitions/ProcessorDTO" - }, - "processorStatus" : { - "description" : "The Status for the Processor for which the Diagnostic Report is generated", - "$ref" : "#/definitions/ProcessorStatusDTO" - }, - "referencedControllerServices" : { - "type" : "array", - "description" : "Diagnostic Information about all Controller Services that the Processor is referencing", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ControllerServiceDiagnosticsDTO" - } - }, - "incomingConnections" : { - "type" : "array", - "description" : "Diagnostic Information about all incoming Connections", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ConnectionDiagnosticsDTO" - } - }, - "outgoingConnections" : { - "type" : "array", - "description" : "Diagnostic Information about all outgoing Connections", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ConnectionDiagnosticsDTO" - } - }, - "jvmDiagnostics" : { - "description" : "Diagnostic Information about the JVM and system-level diagnostics", - "$ref" : "#/definitions/JVMDiagnosticsDTO" - }, - "threadDumps" : { - "type" : "array", - "description" : "Thread Dumps that were taken of the threads that are active in the Processor", - "items" : { - "$ref" : "#/definitions/ThreadDumpDTO" - } - }, - "classLoaderDiagnostics" : { - "description" : "Information about the Controller Service's Class Loader", - "$ref" : "#/definitions/ClassLoaderDiagnosticsDTO" - } - } - }, - "ProcessorDiagnosticsEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "component" : { - "description" : "The Processor Diagnostics", - "$ref" : "#/definitions/ProcessorDiagnosticsDTO" - } - }, - "xml" : { - "name" : "processorDiagnosticsEntity" - } - }, - "ProcessorEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "component" : { - "$ref" : "#/definitions/ProcessorDTO" - }, - "inputRequirement" : { - "type" : "string", - "description" : "The input requirement for this processor." - }, - "status" : { - "$ref" : "#/definitions/ProcessorStatusDTO" - }, - "operatePermissions" : { - "description" : "The permissions for this component operations.", - "$ref" : "#/definitions/PermissionsDTO" - } - }, - "xml" : { - "name" : "processorEntity" - } - }, - "ProcessorRunStatusDetailsDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The ID of the processor" - }, - "name" : { - "type" : "string", - "description" : "The name of the processor" - }, - "runStatus" : { - "type" : "string", - "description" : "The run status of the processor", - "enum" : [ "Running", "Stopped", "Invalid", "Validating", "Disabled" ] - }, - "validationErrors" : { - "type" : "array", - "description" : "The processor's validation errors", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - }, - "activeThreadCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The current number of threads that the processor is currently using" - } - } - }, - "ProcessorRunStatusDetailsEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for the Processor.", - "$ref" : "#/definitions/RevisionDTO" - }, - "permissions" : { - "description" : "The permissions for the Processor.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "runStatusDetails" : { - "description" : "The details of a Processor's run status", - "$ref" : "#/definitions/ProcessorRunStatusDetailsDTO" - } - }, - "xml" : { - "name" : "entity" - } - }, - "ProcessorRunStatusEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "state" : { - "type" : "string", - "description" : "The run status of the Processor.", - "enum" : [ "RUNNING", "STOPPED", "DISABLED", "RUN_ONCE" ] - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - } - }, - "xml" : { - "name" : "entity" - } - }, - "ProcessorStatusDTO" : { - "type" : "object", - "properties" : { - "groupId" : { - "type" : "string", - "description" : "The unique ID of the process group that the Processor belongs to" - }, - "id" : { - "type" : "string", - "description" : "The unique ID of the Processor" - }, - "name" : { - "type" : "string", - "description" : "The name of the Processor" - }, - "type" : { - "type" : "string", - "description" : "The type of the Processor" - }, - "runStatus" : { - "type" : "string", - "description" : "The run status of the Processor", - "enum" : [ "Running", "Stopped", "Validating", "Disabled", "Invalid" ] - }, - "statsLastRefreshed" : { - "type" : "string", - "description" : "The timestamp of when the stats were last refreshed" - }, - "aggregateSnapshot" : { - "description" : "A status snapshot that represents the aggregate stats of all nodes in the cluster. If the NiFi instance is a standalone instance, rather than a cluster, this represents the stats of the single instance.", - "$ref" : "#/definitions/ProcessorStatusSnapshotDTO" - }, - "nodeSnapshots" : { - "type" : "array", - "description" : "A status snapshot for each node in the cluster. If the NiFi instance is a standalone instance, rather than a cluster, this may be null.", - "items" : { - "$ref" : "#/definitions/NodeProcessorStatusSnapshotDTO" - } - } - } - }, - "ProcessorStatusEntity" : { - "type" : "object", - "properties" : { - "processorStatus" : { - "$ref" : "#/definitions/ProcessorStatusDTO" - }, - "canRead" : { - "type" : "boolean", - "description" : "Indicates whether the user can read a given resource." - } - }, - "xml" : { - "name" : "processorStatusEntity" - } - }, - "ProcessorStatusSnapshotDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the processor." - }, - "groupId" : { - "type" : "string", - "description" : "The id of the parent process group to which the processor belongs." - }, - "name" : { - "type" : "string", - "description" : "The name of the prcessor." - }, - "type" : { - "type" : "string", - "description" : "The type of the processor." - }, - "runStatus" : { - "type" : "string", - "description" : "The state of the processor.", - "enum" : [ "Running", "Stopped", "Validating", "Disabled", "Invalid" ] - }, - "executionNode" : { - "type" : "string", - "description" : "Indicates the node where the process will execute.", - "enum" : [ "ALL", "PRIMARY" ] - }, - "bytesRead" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes read by this Processor in the last 5 mintues" - }, - "bytesWritten" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes written by this Processor in the last 5 minutes" - }, - "read" : { - "type" : "string", - "description" : "The number of bytes read in the last 5 minutes." - }, - "written" : { - "type" : "string", - "description" : "The number of bytes written in the last 5 minutes." - }, - "flowFilesIn" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of FlowFiles that have been accepted in the last 5 minutes" - }, - "bytesIn" : { - "type" : "integer", - "format" : "int64", - "description" : "The size of the FlowFiles that have been accepted in the last 5 minutes" - }, - "input" : { - "type" : "string", - "description" : "The count/size of flowfiles that have been accepted in the last 5 minutes." - }, - "flowFilesOut" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of FlowFiles transferred to a Connection in the last 5 minutes" - }, - "bytesOut" : { - "type" : "integer", - "format" : "int64", - "description" : "The size of the FlowFiles transferred to a Connection in the last 5 minutes" - }, - "output" : { - "type" : "string", - "description" : "The count/size of flowfiles that have been processed in the last 5 minutes." - }, - "taskCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of times this Processor has run in the last 5 minutes" - }, - "tasksDurationNanos" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of nanoseconds that this Processor has spent running in the last 5 minutes" - }, - "tasks" : { - "type" : "string", - "description" : "The total number of task this connectable has completed over the last 5 minutes." - }, - "tasksDuration" : { - "type" : "string", - "description" : "The total duration of all tasks for this connectable over the last 5 minutes." - }, - "activeThreadCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of threads currently executing in the processor." - }, - "terminatedThreadCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of threads currently terminated for the processor." - } - } - }, - "ProcessorStatusSnapshotEntity" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the processor." - }, - "processorStatusSnapshot" : { - "$ref" : "#/definitions/ProcessorStatusSnapshotDTO" - }, - "canRead" : { - "type" : "boolean", - "description" : "Indicates whether the user can read a given resource." - } - }, - "xml" : { - "name" : "entity" - } - }, - "ProcessorTypesEntity" : { - "type" : "object", - "properties" : { - "processorTypes" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/DocumentedTypeDTO" - } - } - }, - "xml" : { - "name" : "processorTypesEntity" - } - }, - "ProcessorsEntity" : { - "type" : "object", - "properties" : { - "processors" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ProcessorEntity" - } - } - }, - "xml" : { - "name" : "processorsEntity" - } - }, - "ProcessorsRunStatusDetailsEntity" : { - "type" : "object", - "properties" : { - "runStatusDetails" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/ProcessorRunStatusDetailsEntity" - } - } - }, - "xml" : { - "name" : "processorsRunStatusDetails" - } - }, - "PropertyAllowableValue" : { - "type" : "object", - "required" : [ "value" ], - "properties" : { - "value" : { - "type" : "string", - "description" : "The internal value" - }, - "displayName" : { - "type" : "string", - "description" : "The display name of the value, if different from the internal value" - }, - "description" : { - "type" : "string", - "description" : "The description of the value, e.g., the behavior it produces." - } - } - }, - "PropertyDependency" : { - "type" : "object", - "properties" : { - "propertyName" : { - "type" : "string", - "description" : "The name of the property that is depended upon" - }, - "propertyDisplayName" : { - "type" : "string", - "description" : "The name of the property that is depended upon" - }, - "dependentValues" : { - "type" : "array", - "description" : "The values that satisfy the dependency", - "items" : { - "type" : "string" - } - } - } - }, - "PropertyDependencyDTO" : { - "type" : "object", - "properties" : { - "propertyName" : { - "type" : "string", - "description" : "The name of the property that is being depended upon" - }, - "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", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - } - } - }, - "PropertyDescriptor" : { - "type" : "object", - "required" : [ "name" ], - "properties" : { - "name" : { - "type" : "string", - "description" : "The name of the property key" - }, - "displayName" : { - "type" : "string", - "description" : "The display name of the property key, if different from the name" - }, - "description" : { - "type" : "string", - "description" : "The description of what the property does" - }, - "allowableValues" : { - "type" : "array", - "description" : "A list of the allowable values for the property", - "items" : { - "$ref" : "#/definitions/PropertyAllowableValue" - } - }, - "defaultValue" : { - "type" : "string", - "description" : "The default value if a user-set value is not specified" - }, - "required" : { - "type" : "boolean", - "description" : "Whether or not the property is required for the component" - }, - "sensitive" : { - "type" : "boolean", - "description" : "Whether or not the value of the property is considered sensitive (e.g., passwords and keys)" - }, - "expressionLanguageScope" : { - "type" : "string", - "description" : "The scope of expression language supported by this property", - "enum" : [ "NONE", "VARIABLE_REGISTRY", "FLOWFILE_ATTRIBUTES" ] - }, - "expressionLanguageScopeDescription" : { - "type" : "string", - "description" : "The description of the expression language scope supported by this property", - "readOnly" : true - }, - "typeProvidedByValue" : { - "description" : "Indicates that this property is for selecting a controller service of the specified type", - "$ref" : "#/definitions/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" - }, - "dynamic" : { - "type" : "boolean", - "description" : "Whether or not the descriptor is for a dynamically added property" - }, - "resourceDefinition" : { - "description" : "Indicates that this property references external resources", - "$ref" : "#/definitions/PropertyResourceDefinition" - }, - "dependencies" : { - "type" : "array", - "description" : "The dependencies that this property has on other properties", - "items" : { - "$ref" : "#/definitions/PropertyDependency" - } - } - } - }, - "PropertyDescriptorDTO" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The name for the property." - }, - "displayName" : { - "type" : "string", - "description" : "The human readable name for the property." - }, - "description" : { - "type" : "string", - "description" : "The description for the property. Used to relay additional details to a user or provide a mechanism of documenting intent." - }, - "defaultValue" : { - "type" : "string", - "description" : "The default value for the property." - }, - "allowableValues" : { - "type" : "array", - "description" : "Allowable values for the property. If empty then the allowed values are not constrained.", - "items" : { - "$ref" : "#/definitions/AllowableValueEntity" - } - }, - "required" : { - "type" : "boolean", - "description" : "Whether the property is required." - }, - "sensitive" : { - "type" : "boolean", - "description" : "Whether the property is sensitive and protected whenever stored or represented." - }, - "dynamic" : { - "type" : "boolean", - "description" : "Whether the property is dynamic (user-defined)." - }, - "supportsEl" : { - "type" : "boolean", - "description" : "Whether the property supports expression language." - }, - "expressionLanguageScope" : { - "type" : "string", - "description" : "Scope of the Expression Language evaluation for the property." - }, - "identifiesControllerService" : { - "type" : "string", - "description" : "If the property identifies a controller service this returns the fully qualified type." - }, - "identifiesControllerServiceBundle" : { - "description" : "If the property identifies a controller service this returns the bundle of the type, null otherwise.", - "$ref" : "#/definitions/BundleDTO" - }, - "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" : "#/definitions/PropertyDependencyDTO" - } - } - } - }, - "PropertyDescriptorEntity" : { - "type" : "object", - "properties" : { - "propertyDescriptor" : { - "$ref" : "#/definitions/PropertyDescriptorDTO" - } - }, - "xml" : { - "name" : "propertyDescriptor" - } - }, - "PropertyHistoryDTO" : { - "type" : "object", - "properties" : { - "previousValues" : { - "type" : "array", - "description" : "Previous values for a given property.", - "items" : { - "$ref" : "#/definitions/PreviousValueDTO" - } - } - } - }, - "PropertyResourceDefinition" : { - "type" : "object", - "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", - "uniqueItems" : true, - "items" : { - "type" : "string", - "enum" : [ "FILE", "DIRECTORY", "TEXT", "URL" ] - } - } - } - }, - "ProvenanceDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the provenance query." - }, - "uri" : { - "type" : "string", - "description" : "The URI for this query. Used for obtaining/deleting the request at a later time" - }, - "submissionTime" : { - "type" : "string", - "description" : "The timestamp when the query was submitted." - }, - "expiration" : { - "type" : "string", - "description" : "The timestamp when the query will expire." - }, - "percentCompleted" : { - "type" : "integer", - "format" : "int32", - "description" : "The current percent complete." - }, - "finished" : { - "type" : "boolean", - "description" : "Whether the query has finished." - }, - "request" : { - "description" : "The provenance request.", - "$ref" : "#/definitions/ProvenanceRequestDTO" - }, - "results" : { - "description" : "The provenance results.", - "$ref" : "#/definitions/ProvenanceResultsDTO" - } - } - }, - "ProvenanceEntity" : { - "type" : "object", - "properties" : { - "provenance" : { - "$ref" : "#/definitions/ProvenanceDTO" - } - }, - "xml" : { - "name" : "provenanceEntity" - } - }, - "ProvenanceEventDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The event uuid." - }, - "eventId" : { - "type" : "integer", - "format" : "int64", - "description" : "The event id. This is a one up number thats unique per node." - }, - "eventTime" : { - "type" : "string", - "description" : "The timestamp of the event." - }, - "eventDuration" : { - "type" : "integer", - "format" : "int64", - "description" : "The event duration in milliseconds." - }, - "lineageDuration" : { - "type" : "integer", - "format" : "int64", - "description" : "The duration since the lineage began, in milliseconds." - }, - "eventType" : { - "type" : "string", - "description" : "The type of the event." - }, - "flowFileUuid" : { - "type" : "string", - "description" : "The uuid of the flowfile for the event." - }, - "fileSize" : { - "type" : "string", - "description" : "The size of the flowfile for the event." - }, - "fileSizeBytes" : { - "type" : "integer", - "format" : "int64", - "description" : "The size of the flowfile in bytes for the event." - }, - "clusterNodeId" : { - "type" : "string", - "description" : "The identifier for the node where the event originated." - }, - "clusterNodeAddress" : { - "type" : "string", - "description" : "The label for the node where the event originated." - }, - "groupId" : { - "type" : "string", - "description" : "The id of the group that the component resides in. If the component is no longer in the flow, the group id will not be set." - }, - "componentId" : { - "type" : "string", - "description" : "The id of the component that generated the event." - }, - "componentType" : { - "type" : "string", - "description" : "The type of the component that generated the event." - }, - "componentName" : { - "type" : "string", - "description" : "The name of the component that generated the event." - }, - "sourceSystemFlowFileId" : { - "type" : "string", - "description" : "The source system flowfile id." - }, - "alternateIdentifierUri" : { - "type" : "string", - "description" : "The alternate identifier uri for the fileflow for the event." - }, - "attributes" : { - "type" : "array", - "description" : "The attributes of the flowfile for the event.", - "items" : { - "$ref" : "#/definitions/AttributeDTO" - } - }, - "parentUuids" : { - "type" : "array", - "description" : "The parent uuids for the event.", - "items" : { - "type" : "string" - } - }, - "childUuids" : { - "type" : "array", - "description" : "The child uuids for the event.", - "items" : { - "type" : "string" - } - }, - "transitUri" : { - "type" : "string", - "description" : "The source/destination system uri if the event was a RECEIVE/SEND." - }, - "relationship" : { - "type" : "string", - "description" : "The relationship to which the flowfile was routed if the event is of type ROUTE." - }, - "details" : { - "type" : "string", - "description" : "The event details." - }, - "contentEqual" : { - "type" : "boolean", - "description" : "Whether the input and output content claim is the same." - }, - "inputContentAvailable" : { - "type" : "boolean", - "description" : "Whether the input content is still available." - }, - "inputContentClaimSection" : { - "type" : "string", - "description" : "The section in which the input content claim lives." - }, - "inputContentClaimContainer" : { - "type" : "string", - "description" : "The container in which the input content claim lives." - }, - "inputContentClaimIdentifier" : { - "type" : "string", - "description" : "The identifier of the input content claim." - }, - "inputContentClaimOffset" : { - "type" : "integer", - "format" : "int64", - "description" : "The offset into the input content claim where the flowfiles content begins." - }, - "inputContentClaimFileSize" : { - "type" : "string", - "description" : "The file size of the input content claim formatted." - }, - "inputContentClaimFileSizeBytes" : { - "type" : "integer", - "format" : "int64", - "description" : "The file size of the intput content claim in bytes." - }, - "outputContentAvailable" : { - "type" : "boolean", - "description" : "Whether the output content is still available." - }, - "outputContentClaimSection" : { - "type" : "string", - "description" : "The section in which the output content claim lives." - }, - "outputContentClaimContainer" : { - "type" : "string", - "description" : "The container in which the output content claim lives." - }, - "outputContentClaimIdentifier" : { - "type" : "string", - "description" : "The identifier of the output content claim." - }, - "outputContentClaimOffset" : { - "type" : "integer", - "format" : "int64", - "description" : "The offset into the output content claim where the flowfiles content begins." - }, - "outputContentClaimFileSize" : { - "type" : "string", - "description" : "The file size of the output content claim formatted." - }, - "outputContentClaimFileSizeBytes" : { - "type" : "integer", - "format" : "int64", - "description" : "The file size of the output content claim in bytes." - }, - "replayAvailable" : { - "type" : "boolean", - "description" : "Whether or not replay is available." - }, - "replayExplanation" : { - "type" : "string", - "description" : "Explanation as to why replay is unavailable." - }, - "sourceConnectionIdentifier" : { - "type" : "string", - "description" : "The identifier of the queue/connection from which the flowfile was pulled to genereate this event. May be null if the queue/connection is unknown or the flowfile was generated from this event." - } - } - }, - "ProvenanceEventEntity" : { - "type" : "object", - "properties" : { - "provenanceEvent" : { - "$ref" : "#/definitions/ProvenanceEventDTO" - } - }, - "xml" : { - "name" : "provenanceEventEntity" - } - }, - "ProvenanceLinkDTO" : { - "type" : "object", - "properties" : { - "sourceId" : { - "type" : "string", - "description" : "The source node id of the link." - }, - "targetId" : { - "type" : "string", - "description" : "The target node id of the link." - }, - "flowFileUuid" : { - "type" : "string", - "description" : "The flowfile uuid that traversed the link." - }, - "timestamp" : { - "type" : "string", - "description" : "The timestamp of the link (based on the destination)." - }, - "millis" : { - "type" : "integer", - "format" : "int64", - "description" : "The timestamp of this link in milliseconds." - } - } - }, - "ProvenanceNodeDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the node." - }, - "flowFileUuid" : { - "type" : "string", - "description" : "The uuid of the flowfile associated with the provenance event." - }, - "parentUuids" : { - "type" : "array", - "description" : "The uuid of the parent flowfiles of the provenance event.", - "items" : { - "type" : "string" - } - }, - "childUuids" : { - "type" : "array", - "description" : "The uuid of the childrent flowfiles of the provenance event.", - "items" : { - "type" : "string" - } - }, - "clusterNodeIdentifier" : { - "type" : "string", - "description" : "The identifier of the node that this event/flowfile originated from." - }, - "type" : { - "type" : "string", - "description" : "The type of the node.", - "enum" : [ "FLOWFILE", "EVENT" ] - }, - "eventType" : { - "type" : "string", - "description" : "If the type is EVENT, this is the type of event." - }, - "millis" : { - "type" : "integer", - "format" : "int64", - "description" : "The timestamp of the node in milliseconds." - }, - "timestamp" : { - "type" : "string", - "description" : "The timestamp of the node formatted." - } - } - }, - "ProvenanceOptionsDTO" : { - "type" : "object", - "properties" : { - "searchableFields" : { - "type" : "array", - "description" : "The available searchable field for the NiFi.", - "items" : { - "$ref" : "#/definitions/ProvenanceSearchableFieldDTO" - } - } - } - }, - "ProvenanceOptionsEntity" : { - "type" : "object", - "properties" : { - "provenanceOptions" : { - "$ref" : "#/definitions/ProvenanceOptionsDTO" - } - }, - "xml" : { - "name" : "provenanceOptionsEntity" - } - }, - "ProvenanceRequestDTO" : { - "type" : "object", - "properties" : { - "searchTerms" : { - "type" : "object", - "description" : "The search terms used to perform the search.", - "additionalProperties" : { - "$ref" : "#/definitions/ProvenanceSearchValueDTO" - } - }, - "clusterNodeId" : { - "type" : "string", - "description" : "The id of the node in the cluster where this provenance originated." - }, - "startDate" : { - "type" : "string", - "description" : "The earliest event time to include in the query." - }, - "endDate" : { - "type" : "string", - "description" : "The latest event time to include in the query." - }, - "minimumFileSize" : { - "type" : "string", - "description" : "The minimum file size to include in the query." - }, - "maximumFileSize" : { - "type" : "string", - "description" : "The maximum file size to include in the query." - }, - "maxResults" : { - "type" : "integer", - "format" : "int32", - "description" : "The maximum number of results to include." - }, - "summarize" : { - "type" : "boolean", - "description" : "Whether or not to summarize provenance events returned. This property is false by default." - }, - "incrementalResults" : { - "type" : "boolean", - "description" : "Whether or not incremental results are returned. If false, provenance events are only returned once the query completes. This property is true by default." - } - } - }, - "ProvenanceResultsDTO" : { - "type" : "object", - "properties" : { - "provenanceEvents" : { - "type" : "array", - "description" : "The provenance events that matched the search criteria.", - "items" : { - "$ref" : "#/definitions/ProvenanceEventDTO" - } - }, - "total" : { - "type" : "string", - "description" : "The total number of results formatted." - }, - "totalCount" : { - "type" : "integer", - "format" : "int64", - "description" : "The total number of results." - }, - "generated" : { - "type" : "string", - "description" : "Then the search was performed." - }, - "oldestEvent" : { - "type" : "string", - "description" : "The oldest event available in the provenance repository." - }, - "timeOffset" : { - "type" : "integer", - "format" : "int32", - "description" : "The time offset of the server that's used for event time." - }, - "errors" : { - "type" : "array", - "description" : "Any errors that occurred while performing the provenance request.", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - } - } - }, - "ProvenanceSearchValueDTO" : { - "type" : "object", - "properties" : { - "value" : { - "type" : "string", - "description" : "The search value." - }, - "inverse" : { - "type" : "boolean", - "description" : "Query for all except for search value." - } - } - }, - "ProvenanceSearchableFieldDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the searchable field." - }, - "field" : { - "type" : "string", - "description" : "The searchable field." - }, - "label" : { - "type" : "string", - "description" : "The label for the searchable field." - }, - "type" : { - "type" : "string", - "description" : "The type of the searchable field." - } - } - }, - "QueueSizeDTO" : { - "type" : "object", - "properties" : { - "byteCount" : { - "type" : "integer", - "format" : "int64", - "description" : "The size of objects in a queue." - }, - "objectCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The count of objects in a queue." - } - } - }, - "RegisteredFlow" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string" - }, - "name" : { - "type" : "string" - }, - "description" : { - "type" : "string" - }, - "bucketIdentifier" : { - "type" : "string" - }, - "bucketName" : { - "type" : "string" - }, - "createdTimestamp" : { - "type" : "integer", - "format" : "int64" - }, - "lastModifiedTimestamp" : { - "type" : "integer", - "format" : "int64" - }, - "permissions" : { - "$ref" : "#/definitions/FlowRegistryPermissions" - }, - "versionCount" : { - "type" : "integer", - "format" : "int64" - }, - "versionInfo" : { - "$ref" : "#/definitions/RegisteredFlowVersionInfo" - } - } - }, - "RegisteredFlowSnapshot" : { - "type" : "object", - "properties" : { - "snapshotMetadata" : { - "$ref" : "#/definitions/RegisteredFlowSnapshotMetadata" - }, - "flow" : { - "$ref" : "#/definitions/RegisteredFlow" - }, - "bucket" : { - "$ref" : "#/definitions/FlowRegistryBucket" - }, - "flowContents" : { - "$ref" : "#/definitions/VersionedProcessGroup" - }, - "externalControllerServices" : { - "type" : "object", - "additionalProperties" : { - "$ref" : "#/definitions/ExternalControllerServiceReference" - } - }, - "parameterContexts" : { - "type" : "object", - "additionalProperties" : { - "$ref" : "#/definitions/VersionedParameterContext" - } - }, - "flowEncodingVersion" : { - "type" : "string" - }, - "parameterProviders" : { - "type" : "object", - "additionalProperties" : { - "$ref" : "#/definitions/ParameterProviderReference" - } - }, - "latest" : { - "type" : "boolean" - } - } - }, - "RegisteredFlowSnapshotMetadata" : { - "type" : "object", - "properties" : { - "bucketIdentifier" : { - "type" : "string" - }, - "flowIdentifier" : { - "type" : "string" - }, - "version" : { - "type" : "integer", - "format" : "int32" - }, - "timestamp" : { - "type" : "integer", - "format" : "int64" - }, - "author" : { - "type" : "string" - }, - "comments" : { - "type" : "string" - } - } - }, - "RegisteredFlowVersionInfo" : { - "type" : "object", - "properties" : { - "version" : { - "type" : "integer", - "format" : "int64" - } - } - }, - "Relationship" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The name of the relationship" - }, - "description" : { - "type" : "string", - "description" : "The description of the relationship" - } - } - }, - "RelationshipDTO" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The relationship name." - }, - "description" : { - "type" : "string", - "description" : "The relationship description." - }, - "autoTerminate" : { - "type" : "boolean", - "description" : "Whether or not flowfiles sent to this relationship should auto terminate." - }, - "retry" : { - "type" : "boolean", - "description" : "Whether or not flowfiles sent to this relationship should retry." - } - } - }, - "RemotePortRunStatusEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "state" : { - "type" : "string", - "description" : "The run status of the RemotePort.", - "enum" : [ "TRANSMITTING", "STOPPED" ] - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - } - }, - "xml" : { - "name" : "entity" - } - }, - "RemoteProcessGroupContentsDTO" : { - "type" : "object", - "properties" : { - "inputPorts" : { - "type" : "array", - "description" : "The input ports to which data can be sent.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/RemoteProcessGroupPortDTO" - } - }, - "outputPorts" : { - "type" : "array", - "description" : "The output ports from which data can be retrieved.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/RemoteProcessGroupPortDTO" - } - } - } - }, - "RemoteProcessGroupDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "versionedComponentId" : { - "type" : "string", - "description" : "The ID of the corresponding component that is under version control" - }, - "parentGroupId" : { - "type" : "string", - "description" : "The id of parent process group of this component if applicable." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "targetUri" : { - "type" : "string", - "description" : "The target URI of the remote process group. If target uri is not set, but uris are set, then returns the first url in the urls. If neither target uri nor uris are set, then returns null." - }, - "targetUris" : { - "type" : "string", - "description" : "The target URI of the remote process group. If target uris is not set but target uri is set, then returns a collection containing the single target uri. If neither target uris nor uris are set, then returns null." - }, - "targetSecure" : { - "type" : "boolean", - "description" : "Whether the target is running securely." - }, - "name" : { - "type" : "string", - "description" : "The name of the remote process group." - }, - "comments" : { - "type" : "string", - "description" : "The comments for the remote process group." - }, - "communicationsTimeout" : { - "type" : "string", - "description" : "The time period used for the timeout when communicating with the target." - }, - "yieldDuration" : { - "type" : "string", - "description" : "When yielding, this amount of time must elapse before the remote process group is scheduled again." - }, - "transportProtocol" : { - "type" : "string" - }, - "localNetworkInterface" : { - "type" : "string", - "description" : "The local network interface to send/receive data. If not specified, any local address is used. If clustered, all nodes must have an interface with this identifier." - }, - "proxyHost" : { - "type" : "string" - }, - "proxyPort" : { - "type" : "integer", - "format" : "int32" - }, - "proxyUser" : { - "type" : "string" - }, - "proxyPassword" : { - "type" : "string" - }, - "authorizationIssues" : { - "type" : "array", - "description" : "Any remote authorization issues for the remote process group.", - "items" : { - "type" : "string" - } - }, - "validationErrors" : { - "type" : "array", - "description" : "The validation errors for the remote process group. These validation errors represent the problems with the remote process group that must be resolved before it can transmit.", - "items" : { - "type" : "string" - } - }, - "transmitting" : { - "type" : "boolean", - "description" : "Whether the remote process group is actively transmitting." - }, - "inputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of remote input ports currently available on the target." - }, - "outputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of remote output ports currently available on the target." - }, - "activeRemoteInputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of active remote input ports." - }, - "inactiveRemoteInputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of inactive remote input ports." - }, - "activeRemoteOutputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of active remote output ports." - }, - "inactiveRemoteOutputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of inactive remote output ports." - }, - "flowRefreshed" : { - "type" : "string", - "description" : "The timestamp when this remote process group was last refreshed." - }, - "contents" : { - "description" : "The contents of the remote process group. Will contain available input/output ports.", - "$ref" : "#/definitions/RemoteProcessGroupContentsDTO" - } - } - }, - "RemoteProcessGroupEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "component" : { - "$ref" : "#/definitions/RemoteProcessGroupDTO" - }, - "status" : { - "description" : "The status of the remote process group.", - "$ref" : "#/definitions/RemoteProcessGroupStatusDTO" - }, - "inputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of remote input ports currently available on the target." - }, - "outputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of remote output ports currently available on the target." - }, - "operatePermissions" : { - "description" : "The permissions for this component operations.", - "$ref" : "#/definitions/PermissionsDTO" - } - }, - "xml" : { - "name" : "remoteProcessGroupEntity" - } - }, - "RemoteProcessGroupPortDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the port." - }, - "targetId" : { - "type" : "string", - "description" : "The id of the target port." - }, - "versionedComponentId" : { - "type" : "string", - "description" : "The ID of the corresponding component that is under version control" - }, - "groupId" : { - "type" : "string", - "description" : "The id of the remote process group that the port resides in." - }, - "name" : { - "type" : "string", - "description" : "The name of the target port." - }, - "comments" : { - "type" : "string", - "description" : "The comments as configured on the target port." - }, - "concurrentlySchedulableTaskCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of task that may transmit flowfiles to the target port concurrently." - }, - "transmitting" : { - "type" : "boolean", - "description" : "Whether the remote port is configured for transmission." - }, - "useCompression" : { - "type" : "boolean", - "description" : "Whether the flowfiles are compressed when sent to the target port." - }, - "exists" : { - "type" : "boolean", - "description" : "Whether the target port exists." - }, - "targetRunning" : { - "type" : "boolean", - "description" : "Whether the target port is running." - }, - "connected" : { - "type" : "boolean", - "description" : "Whether the port has either an incoming or outgoing connection." - }, - "batchSettings" : { - "description" : "The batch settings for data transmission.", - "$ref" : "#/definitions/BatchSettingsDTO" - } - } - }, - "RemoteProcessGroupPortEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "remoteProcessGroupPort" : { - "$ref" : "#/definitions/RemoteProcessGroupPortDTO" - }, - "operatePermissions" : { - "description" : "The permissions for this component operations.", - "$ref" : "#/definitions/PermissionsDTO" - } - }, - "xml" : { - "name" : "remoteProcessGroupPortEntity" - } - }, - "RemoteProcessGroupStatusDTO" : { - "type" : "object", - "properties" : { - "groupId" : { - "type" : "string", - "description" : "The unique ID of the process group that the Processor belongs to" - }, - "id" : { - "type" : "string", - "description" : "The unique ID of the Processor" - }, - "name" : { - "type" : "string", - "description" : "The name of the remote process group." - }, - "targetUri" : { - "type" : "string", - "description" : "The URI of the target system." - }, - "transmissionStatus" : { - "type" : "string", - "description" : "The transmission status of the remote process group." - }, - "statsLastRefreshed" : { - "type" : "string", - "description" : "The time the status for the process group was last refreshed." - }, - "validationStatus" : { - "type" : "string", - "description" : "Indicates whether the component is valid, invalid, or still in the process of validating (i.e., it is unknown whether or not the component is valid)", - "enum" : [ "VALID", "INVALID", "VALIDATING" ] - }, - "aggregateSnapshot" : { - "description" : "A status snapshot that represents the aggregate stats of all nodes in the cluster. If the NiFi instance is a standalone instance, rather than a cluster, this represents the stats of the single instance.", - "$ref" : "#/definitions/RemoteProcessGroupStatusSnapshotDTO" - }, - "nodeSnapshots" : { - "type" : "array", - "description" : "A status snapshot for each node in the cluster. If the NiFi instance is a standalone instance, rather than a cluster, this may be null.", - "items" : { - "$ref" : "#/definitions/NodeRemoteProcessGroupStatusSnapshotDTO" - } - } - } - }, - "RemoteProcessGroupStatusEntity" : { - "type" : "object", - "properties" : { - "remoteProcessGroupStatus" : { - "$ref" : "#/definitions/RemoteProcessGroupStatusDTO" - }, - "canRead" : { - "type" : "boolean", - "description" : "Indicates whether the user can read a given resource." - } - }, - "xml" : { - "name" : "remoteProcessGroupStatusEntity" - } - }, - "RemoteProcessGroupStatusSnapshotDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the remote process group." - }, - "groupId" : { - "type" : "string", - "description" : "The id of the parent process group the remote process group resides in." - }, - "name" : { - "type" : "string", - "description" : "The name of the remote process group." - }, - "targetUri" : { - "type" : "string", - "description" : "The URI of the target system." - }, - "transmissionStatus" : { - "type" : "string", - "description" : "The transmission status of the remote process group." - }, - "activeThreadCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of active threads for the remote process group." - }, - "flowFilesSent" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of FlowFiles sent to the remote process group in the last 5 minutes." - }, - "bytesSent" : { - "type" : "integer", - "format" : "int64", - "description" : "The size of the FlowFiles sent to the remote process group in the last 5 minutes." - }, - "sent" : { - "type" : "string", - "description" : "The count/size of the flowfiles sent to the remote process group in the last 5 minutes." - }, - "flowFilesReceived" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of FlowFiles received from the remote process group in the last 5 minutes." - }, - "bytesReceived" : { - "type" : "integer", - "format" : "int64", - "description" : "The size of the FlowFiles received from the remote process group in the last 5 minutes." - }, - "received" : { - "type" : "string", - "description" : "The count/size of the flowfiles received from the remote process group in the last 5 minutes." - } - } - }, - "RemoteProcessGroupStatusSnapshotEntity" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the remote process group." - }, - "remoteProcessGroupStatusSnapshot" : { - "$ref" : "#/definitions/RemoteProcessGroupStatusSnapshotDTO" - }, - "canRead" : { - "type" : "boolean", - "description" : "Indicates whether the user can read a given resource." - } - }, - "xml" : { - "name" : "entity" - } - }, - "RemoteProcessGroupsEntity" : { - "type" : "object", - "properties" : { - "remoteProcessGroups" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/RemoteProcessGroupEntity" - } - } - }, - "xml" : { - "name" : "remoteProcessGroupsEntity" - } - }, - "RemoteQueuePartitionDTO" : { - "type" : "object", - "properties" : { - "totalFlowFileCount" : { - "type" : "integer", - "format" : "int32", - "description" : "Total number of FlowFiles owned by the Connection" - }, - "totalByteCount" : { - "type" : "integer", - "format" : "int64", - "description" : "Total number of bytes that make up the content for the FlowFiles owned by this Connection" - }, - "activeQueueFlowFileCount" : { - "type" : "integer", - "format" : "int32", - "description" : "Total number of FlowFiles that exist in the Connection's Active Queue, immediately available to be offered up to a component" - }, - "activeQueueByteCount" : { - "type" : "integer", - "format" : "int64", - "description" : "Total number of bytes that make up the content for the FlowFiles that are present in the Connection's Active Queue" - }, - "swapFlowFileCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The total number of FlowFiles that are swapped out for this Connection" - }, - "swapByteCount" : { - "type" : "integer", - "format" : "int64", - "description" : "Total number of bytes that make up the content for the FlowFiles that are swapped out to disk for the Connection" - }, - "swapFiles" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of Swap Files that exist for this Connection" - }, - "inFlightFlowFileCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of In-Flight FlowFiles for this Connection. These are FlowFiles that belong to the connection but are currently being operated on by a Processor, Port, etc." - }, - "inFlightByteCount" : { - "type" : "integer", - "format" : "int64", - "description" : "The number bytes that make up the content of the FlowFiles that are In-Flight" - }, - "nodeIdentifier" : { - "type" : "string", - "description" : "The Node Identifier that this queue partition is sending to" - } - } - }, - "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" : { - "componentId" : { - "type" : "string", - "description" : "The UUID of the component whose last event should be replayed." - }, - "nodes" : { - "type" : "string", - "description" : "Which nodes were requested to replay their last provenance event.", - "enum" : [ "ALL", "PRIMARY" ] - }, - "aggregateSnapshot" : { - "description" : "The aggregate result of all nodes' responses", - "$ref" : "#/definitions/ReplayLastEventSnapshotDTO" - }, - "nodeSnapshots" : { - "type" : "array", - "description" : "The node-wise results", - "items" : { - "$ref" : "#/definitions/NodeReplayLastEventSnapshotDTO" - } - } - }, - "xml" : { - "name" : "replayLastEventResponseEntity" - } - }, - "ReplayLastEventSnapshotDTO" : { - "type" : "object", - "properties" : { - "eventsReplayed" : { - "type" : "array", - "description" : "The IDs of the events that were successfully replayed", - "items" : { - "type" : "integer", - "format" : "int64" - } - }, - "failureExplanation" : { - "type" : "string", - "description" : "If unable to replay an event, specifies why the event could not be replayed" - }, - "eventAvailable" : { - "type" : "boolean", - "description" : "Whether or not an event was available. This may not be populated if there was a failure." - } - }, - "xml" : { - "name" : "replayLastEventSnapshot" - } - }, - "ReportingTaskDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "versionedComponentId" : { - "type" : "string", - "description" : "The ID of the corresponding component that is under version control" - }, - "parentGroupId" : { - "type" : "string", - "description" : "The id of parent process group of this component if applicable." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "name" : { - "type" : "string", - "description" : "The name of the reporting task." - }, - "type" : { - "type" : "string", - "description" : "The fully qualified type of the reporting task." - }, - "bundle" : { - "description" : "The details of the artifact that bundled this reporting task type.", - "$ref" : "#/definitions/BundleDTO" - }, - "state" : { - "type" : "string", - "description" : "The state of the reporting task.", - "enum" : [ "RUNNING", "STOPPED", "DISABLED" ] - }, - "comments" : { - "type" : "string", - "description" : "The comments of the reporting task." - }, - "persistsState" : { - "type" : "boolean", - "description" : "Whether the reporting task persists state." - }, - "restricted" : { - "type" : "boolean", - "description" : "Whether the reporting task requires elevated privileges." - }, - "deprecated" : { - "type" : "boolean", - "description" : "Whether the reporting task has been deprecated." - }, - "multipleVersionsAvailable" : { - "type" : "boolean", - "description" : "Whether the reporting task has multiple versions available." - }, - "supportsSensitiveDynamicProperties" : { - "type" : "boolean", - "description" : "Whether the reporting task supports sensitive dynamic properties." - }, - "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." - }, - "defaultSchedulingPeriod" : { - "type" : "object", - "description" : "The default scheduling period for the different scheduling strategies.", - "additionalProperties" : { - "type" : "string" - } - }, - "properties" : { - "type" : "object", - "description" : "The properties of the reporting task.", - "additionalProperties" : { - "type" : "string" - } - }, - "descriptors" : { - "type" : "object", - "description" : "The descriptors for the reporting tasks properties.", - "additionalProperties" : { - "$ref" : "#/definitions/PropertyDescriptorDTO" - } - }, - "sensitiveDynamicPropertyNames" : { - "type" : "array", - "description" : "Set of sensitive dynamic property names", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - }, - "customUiUrl" : { - "type" : "string", - "description" : "The URL for the custom configuration UI for the reporting task." - }, - "annotationData" : { - "type" : "string", - "description" : "The annotation data for the repoting task. This is how the custom UI relays configuration to the reporting task." - }, - "validationErrors" : { - "type" : "array", - "description" : "Gets the validation errors from the reporting task. These validation errors represent the problems with the reporting task that must be resolved before it can be scheduled to run.", - "items" : { - "type" : "string" - } - }, - "validationStatus" : { - "type" : "string", - "description" : "Indicates whether the 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" ] - }, - "activeThreadCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of active threads for the reporting task." - }, - "extensionMissing" : { - "type" : "boolean", - "description" : "Whether the underlying extension is missing." - } - } - }, - "ReportingTaskDefinition" : { - "type" : "object", - "required" : [ "type" ], - "properties" : { - "group" : { - "type" : "string", - "description" : "The group name of the bundle that provides the referenced type." - }, - "artifact" : { - "type" : "string", - "description" : "The artifact name of the bundle that provides the referenced type." - }, - "version" : { - "type" : "string", - "description" : "The version 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." - }, - "buildInfo" : { - "description" : "The build metadata for this component", - "$ref" : "#/definitions/BuildInfo" - }, - "providedApiImplementations" : { - "type" : "array", - "description" : "If this type represents a provider for an interface, this lists the APIs it implements", - "items" : { - "$ref" : "#/definitions/DefinedType" - } - }, - "tags" : { - "type" : "array", - "description" : "The tags associated with this type", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - }, - "seeAlso" : { - "type" : "array", - "description" : "The names of other component types that may be related", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - }, - "deprecated" : { - "type" : "boolean", - "description" : "Whether or not the component has been deprecated" - }, - "deprecationReason" : { - "type" : "string", - "description" : "If this component has been deprecated, this optional field can be used to provide an explanation" - }, - "deprecationAlternatives" : { - "type" : "array", - "description" : "If this component has been deprecated, this optional field provides alternatives to use", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - }, - "restricted" : { - "type" : "boolean", - "description" : "Whether or not the component has a general restriction" - }, - "restrictedExplanation" : { - "type" : "string", - "description" : "An optional description of the general restriction" - }, - "explicitRestrictions" : { - "type" : "array", - "description" : "Explicit restrictions that indicate a require permission to use the component", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/Restriction" - } - }, - "stateful" : { - "description" : "Indicates if the component stores state", - "$ref" : "#/definitions/Stateful" - }, - "systemResourceConsiderations" : { - "type" : "array", - "description" : "The system resource considerations for the given component", - "items" : { - "$ref" : "#/definitions/SystemResourceConsideration" - } - }, - "additionalDetails" : { - "type" : "boolean", - "description" : "Indicates if the component has additional details documentation" - }, - "propertyDescriptors" : { - "type" : "object", - "description" : "Descriptions of configuration properties applicable to this component.", - "additionalProperties" : { - "$ref" : "#/definitions/PropertyDescriptor" - } - }, - "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." - }, - "dynamicProperties" : { - "type" : "array", - "description" : "Describes the dynamic properties supported by this component", - "items" : { - "$ref" : "#/definitions/DynamicProperty" - } - }, - "supportedSchedulingStrategies" : { - "type" : "array", - "description" : "The supported scheduling strategies, such as TIME_DRIVER or CRON.", - "items" : { - "type" : "string" - } - }, - "defaultSchedulingStrategy" : { - "type" : "string", - "description" : "The default scheduling strategy for the reporting task." - }, - "defaultSchedulingPeriodBySchedulingStrategy" : { - "type" : "object", - "description" : "The default scheduling period for each scheduling strategy. The scheduling period is expected to be a time period, such as \"30 sec\".", - "additionalProperties" : { - "type" : "string" - } - } - } - }, - "ReportingTaskEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "component" : { - "$ref" : "#/definitions/ReportingTaskDTO" - }, - "operatePermissions" : { - "description" : "The permissions for this component operations.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "status" : { - "description" : "The status for this ReportingTask.", - "$ref" : "#/definitions/ReportingTaskStatusDTO" - } - }, - "xml" : { - "name" : "reportingTaskEntity" - } - }, - "ReportingTaskRunStatusEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "state" : { - "type" : "string", - "description" : "The run status of the ReportingTask.", - "enum" : [ "RUNNING", "STOPPED" ] - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - } - }, - "xml" : { - "name" : "entity" - } - }, - "ReportingTaskStatusDTO" : { - "type" : "object", - "properties" : { - "runStatus" : { - "type" : "string", - "description" : "The run status of this ReportingTask", - "enum" : [ "RUNNING", "STOPPED", "DISABLED" ] - }, - "validationStatus" : { - "type" : "string", - "description" : "Indicates whether the component is valid, invalid, or still in the process of validating (i.e., it is unknown whether or not the component is valid)", - "enum" : [ "VALID", "INVALID", "VALIDATING" ] - }, - "activeThreadCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of active threads for the component." - } - } - }, - "ReportingTaskTypesEntity" : { - "type" : "object", - "properties" : { - "reportingTaskTypes" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/DocumentedTypeDTO" - } - } - }, - "xml" : { - "name" : "reportingTaskTypesEntity" - } - }, - "ReportingTasksEntity" : { - "type" : "object", - "properties" : { - "reportingTasks" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ReportingTaskEntity" - } - } - }, - "xml" : { - "name" : "reportingTasksEntity" - } - }, - "RepositoryUsageDTO" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The name of the repository" - }, - "fileStoreHash" : { - "type" : "string", - "description" : "A SHA-256 hash of the File Store name/path that is used to store the repository's data. This information is exposed as a hash in order to avoid exposing potentially sensitive information that is not generally relevant. What is typically relevant is whether or not multiple repositories on the same node are using the same File Store, as this indicates that the repositories are competing for the resources of the backing disk/storage mechanism." - }, - "freeSpace" : { - "type" : "string", - "description" : "Amount of free space." - }, - "totalSpace" : { - "type" : "string", - "description" : "Amount of total space." - }, - "freeSpaceBytes" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes of free space." - }, - "totalSpaceBytes" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes of total space." - }, - "utilization" : { - "type" : "string", - "description" : "Utilization of this storage location." - } - } - }, - "RequiredPermissionDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The required sub-permission necessary for this restriction." - }, - "label" : { - "type" : "string", - "description" : "The label for the required sub-permission necessary for this restriction." - } - } - }, - "ResourceDTO" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The identifier of the resource." - }, - "name" : { - "type" : "string", - "description" : "The name of the resource." - } - } - }, - "ResourcesEntity" : { - "type" : "object", - "properties" : { - "resources" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/ResourceDTO" - } - } - }, - "xml" : { - "name" : "resourcesEntity" - } - }, - "Response" : { - "type" : "object", - "properties" : { - "status" : { - "type" : "integer", - "format" : "int32" - }, - "metadata" : { - "type" : "object", - "additionalProperties" : { - "type" : "array", - "items" : { - "type" : "object" - } - } - }, - "entity" : { - "type" : "object" - } - } - }, - "Restriction" : { - "type" : "object", - "properties" : { - "requiredPermission" : { - "type" : "string", - "description" : "The permission required for this restriction" - }, - "explanation" : { - "type" : "string", - "description" : "The explanation of this restriction" - } - } - }, - "RevisionDTO" : { - "type" : "object", - "properties" : { - "clientId" : { - "type" : "string", - "description" : "A client identifier used to make a request. By including a client identifier, the API can allow multiple requests without needing the current revision. Due to the asynchronous nature of requests/responses this was implemented to allow the client to make numerous requests without having to wait for the previous response to come back" - }, - "version" : { - "type" : "integer", - "format" : "int64", - "description" : "NiFi employs an optimistic locking strategy where the client must include a revision in their request when performing an update. In a response to a mutable flow request, this field represents the updated base version." - }, - "lastModifier" : { - "type" : "string", - "description" : "The user that last modified the flow." - } - } - }, - "RunStatusDetailsRequestEntity" : { - "type" : "object", - "properties" : { - "processorIds" : { - "type" : "array", - "description" : "The IDs of all processors whose run status details should be provided", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - } - }, - "xml" : { - "name" : "runStatusDetailsRequest" - } - }, - "RuntimeManifest" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "A unique identifier for the manifest" - }, - "agentType" : { - "type" : "string", - "description" : "The type of the runtime binary, e.g., 'minifi-java' or 'minifi-cpp'" - }, - "version" : { - "type" : "string", - "description" : "The version of the runtime binary, e.g., '1.0.1'" - }, - "buildInfo" : { - "description" : "Build summary for this runtime binary", - "$ref" : "#/definitions/BuildInfo" - }, - "bundles" : { - "type" : "array", - "description" : "All extension bundles included with this runtime", - "items" : { - "$ref" : "#/definitions/Bundle" - } - }, - "schedulingDefaults" : { - "description" : "Scheduling defaults for components defined in this manifest", - "$ref" : "#/definitions/SchedulingDefaults" - } - } - }, - "RuntimeManifestEntity" : { - "type" : "object", - "properties" : { - "runtimeManifest" : { - "$ref" : "#/definitions/RuntimeManifest" - } - }, - "xml" : { - "name" : "runtimeManifestEntity" - } - }, - "ScheduleComponentsEntity" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the ProcessGroup" - }, - "state" : { - "type" : "string", - "description" : "The desired state of the descendant components", - "enum" : [ "RUNNING", "STOPPED", "ENABLED", "DISABLED" ] - }, - "components" : { - "type" : "object", - "description" : "Optional components to schedule. If not specified, all authorized descendant components will be used.", - "additionalProperties" : { - "$ref" : "#/definitions/RevisionDTO" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - } - }, - "xml" : { - "name" : "scheduleComponentEntity" - } - }, - "SchedulingDefaults" : { - "type" : "object", - "properties" : { - "defaultSchedulingStrategy" : { - "type" : "string", - "description" : "The name of the default scheduling strategy", - "enum" : [ "EVENT_DRIVEN", "TIMER_DRIVEN", "PRIMARY_NODE_ONLY", "CRON_DRIVEN" ] - }, - "defaultSchedulingPeriodMillis" : { - "type" : "integer", - "format" : "int64", - "description" : "The default scheduling period in milliseconds" - }, - "penalizationPeriodMillis" : { - "type" : "integer", - "format" : "int64", - "description" : "The default penalization period in milliseconds" - }, - "yieldDurationMillis" : { - "type" : "integer", - "format" : "int64", - "description" : "The default yield duration in milliseconds" - }, - "defaultRunDurationNanos" : { - "type" : "integer", - "format" : "int64", - "description" : "The default run duration in nano-seconds" - }, - "defaultMaxConcurrentTasks" : { - "type" : "string", - "description" : "The default concurrent tasks" - }, - "defaultConcurrentTasksBySchedulingStrategy" : { - "type" : "object", - "description" : "The default concurrent tasks for each scheduling strategy", - "additionalProperties" : { - "type" : "integer", - "format" : "int32" - } - }, - "defaultSchedulingPeriodsBySchedulingStrategy" : { - "type" : "object", - "description" : "The default scheduling period for each scheduling strategy", - "additionalProperties" : { - "type" : "string" - } - } - } - }, - "SearchResultGroupDTO" : { - "type" : "object", - "required" : [ "id" ], - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the group." - }, - "name" : { - "type" : "string", - "description" : "The name of the group." - } - } - }, - "SearchResultsDTO" : { - "type" : "object", - "properties" : { - "processorResults" : { - "type" : "array", - "description" : "The processors that matched the search.", - "items" : { - "$ref" : "#/definitions/ComponentSearchResultDTO" - } - }, - "connectionResults" : { - "type" : "array", - "description" : "The connections that matched the search.", - "items" : { - "$ref" : "#/definitions/ComponentSearchResultDTO" - } - }, - "processGroupResults" : { - "type" : "array", - "description" : "The process groups that matched the search.", - "items" : { - "$ref" : "#/definitions/ComponentSearchResultDTO" - } - }, - "inputPortResults" : { - "type" : "array", - "description" : "The input ports that matched the search.", - "items" : { - "$ref" : "#/definitions/ComponentSearchResultDTO" - } - }, - "outputPortResults" : { - "type" : "array", - "description" : "The output ports that matched the search.", - "items" : { - "$ref" : "#/definitions/ComponentSearchResultDTO" - } - }, - "remoteProcessGroupResults" : { - "type" : "array", - "description" : "The remote process groups that matched the search.", - "items" : { - "$ref" : "#/definitions/ComponentSearchResultDTO" - } - }, - "funnelResults" : { - "type" : "array", - "description" : "The funnels that matched the search.", - "items" : { - "$ref" : "#/definitions/ComponentSearchResultDTO" - } - }, - "labelResults" : { - "type" : "array", - "description" : "The labels that matched the search.", - "items" : { - "$ref" : "#/definitions/ComponentSearchResultDTO" - } - }, - "controllerServiceNodeResults" : { - "type" : "array", - "description" : "The controller service nodes that matched the search", - "items" : { - "$ref" : "#/definitions/ComponentSearchResultDTO" - } - }, - "parameterContextResults" : { - "type" : "array", - "description" : "The parameter contexts that matched the search.", - "items" : { - "$ref" : "#/definitions/ComponentSearchResultDTO" - } - }, - "parameterProviderNodeResults" : { - "type" : "array", - "description" : "The parameter provider nodes that matched the search", - "items" : { - "$ref" : "#/definitions/ComponentSearchResultDTO" - } - }, - "parameterResults" : { - "type" : "array", - "description" : "The parameters that matched the search.", - "items" : { - "$ref" : "#/definitions/ComponentSearchResultDTO" - } - } - } - }, - "SearchResultsEntity" : { - "type" : "object", - "properties" : { - "searchResultsDTO" : { - "$ref" : "#/definitions/SearchResultsDTO" - } - }, - "xml" : { - "name" : "searchResultsEntity" - } - }, - "SnippetDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the snippet." - }, - "uri" : { - "type" : "string", - "description" : "The URI of the snippet." - }, - "parentGroupId" : { - "type" : "string", - "description" : "The group id for the components in the snippet." - }, - "processGroups" : { - "type" : "object", - "description" : "The ids of the process groups in this snippet. These ids will be populated within each response. They can be specified when creating a snippet. However, once a snippet has been created its contents cannot be modified (these ids are ignored during update requests).", - "additionalProperties" : { - "$ref" : "#/definitions/RevisionDTO" - } - }, - "remoteProcessGroups" : { - "type" : "object", - "description" : "The ids of the remote process groups in this snippet. These ids will be populated within each response. They can be specified when creating a snippet. However, once a snippet has been created its contents cannot be modified (these ids are ignored during update requests).", - "additionalProperties" : { - "$ref" : "#/definitions/RevisionDTO" - } - }, - "processors" : { - "type" : "object", - "description" : "The ids of the processors in this snippet. These ids will be populated within each response. They can be specified when creating a snippet. However, once a snippet has been created its contents cannot be modified (these ids are ignored during update requests).", - "additionalProperties" : { - "$ref" : "#/definitions/RevisionDTO" - } - }, - "inputPorts" : { - "type" : "object", - "description" : "The ids of the input ports in this snippet. These ids will be populated within each response. They can be specified when creating a snippet. However, once a snippet has been created its contents cannot be modified (these ids are ignored during update requests).", - "additionalProperties" : { - "$ref" : "#/definitions/RevisionDTO" - } - }, - "outputPorts" : { - "type" : "object", - "description" : "The ids of the output ports in this snippet. These ids will be populated within each response. They can be specified when creating a snippet. However, once a snippet has been created its contents cannot be modified (these ids are ignored during update requests).", - "additionalProperties" : { - "$ref" : "#/definitions/RevisionDTO" - } - }, - "connections" : { - "type" : "object", - "description" : "The ids of the connections in this snippet. These ids will be populated within each response. They can be specified when creating a snippet. However, once a snippet has been created its contents cannot be modified (these ids are ignored during update requests).", - "additionalProperties" : { - "$ref" : "#/definitions/RevisionDTO" - } - }, - "labels" : { - "type" : "object", - "description" : "The ids of the labels in this snippet. These ids will be populated within each response. They can be specified when creating a snippet. However, once a snippet has been created its contents cannot be modified (these ids are ignored during update requests).", - "additionalProperties" : { - "$ref" : "#/definitions/RevisionDTO" - } - }, - "funnels" : { - "type" : "object", - "description" : "The ids of the funnels in this snippet. These ids will be populated within each response. They can be specified when creating a snippet. However, once a snippet has been created its contents cannot be modified (these ids are ignored during update requests).", - "additionalProperties" : { - "$ref" : "#/definitions/RevisionDTO" - } - } - } - }, - "SnippetEntity" : { - "type" : "object", - "properties" : { - "snippet" : { - "description" : "The snippet.", - "$ref" : "#/definitions/SnippetDTO" - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - } - }, - "xml" : { - "name" : "snippetEntity" - } - }, - "StackTraceElement" : { - "type" : "object", - "properties" : { - "classLoaderName" : { - "type" : "string" - }, - "moduleName" : { - "type" : "string" - }, - "moduleVersion" : { - "type" : "string" - }, - "methodName" : { - "type" : "string" - }, - "fileName" : { - "type" : "string" - }, - "lineNumber" : { - "type" : "integer", - "format" : "int32" - }, - "className" : { - "type" : "string" - }, - "nativeMethod" : { - "type" : "boolean" - } - } - }, - "StartVersionControlRequestEntity" : { - "type" : "object", - "properties" : { - "versionedFlow" : { - "description" : "The versioned flow", - "$ref" : "#/definitions/VersionedFlowDTO" - }, - "processGroupRevision" : { - "description" : "The Revision of the Process Group under Version Control", - "$ref" : "#/definitions/RevisionDTO" - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - } - }, - "xml" : { - "name" : "startVersionControlRequestEntity" - } - }, - "StateEntryDTO" : { - "type" : "object", - "properties" : { - "key" : { - "type" : "string", - "description" : "The key for this state." - }, - "value" : { - "type" : "string", - "description" : "The value for this state." - }, - "clusterNodeId" : { - "type" : "string", - "description" : "The identifier for the node where the state originated." - }, - "clusterNodeAddress" : { - "type" : "string", - "description" : "The label for the node where the state originated." - } - } - }, - "StateMapDTO" : { - "type" : "object", - "properties" : { - "scope" : { - "type" : "string", - "description" : "The scope of this StateMap." - }, - "totalEntryCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The total number of state entries. When the state map is lengthy, only of portion of the entries are returned." - }, - "state" : { - "type" : "array", - "description" : "The state.", - "items" : { - "$ref" : "#/definitions/StateEntryDTO" - } - } - } - }, - "Stateful" : { - "type" : "object", - "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", - "uniqueItems" : true, - "items" : { - "type" : "string", - "enum" : [ "CLUSTER", "LOCAL" ] - } - } - } - }, - "StatusDescriptorDTO" : { - "type" : "object", - "properties" : { - "field" : { - "type" : "string", - "description" : "The name of the status field." - }, - "label" : { - "type" : "string", - "description" : "The label for the status field." - }, - "description" : { - "type" : "string", - "description" : "The description of the status field." - }, - "formatter" : { - "type" : "string", - "description" : "The formatter for the status descriptor." - } - } - }, - "StatusHistoryDTO" : { - "type" : "object", - "properties" : { - "generated" : { - "type" : "string", - "description" : "When the status history was generated." - }, - "componentDetails" : { - "type" : "object", - "description" : "A Map of key/value pairs that describe the component that the status history belongs to", - "additionalProperties" : { - "type" : "string" - } - }, - "fieldDescriptors" : { - "type" : "array", - "description" : "The Descriptors that provide information on each of the metrics provided in the status history", - "items" : { - "$ref" : "#/definitions/StatusDescriptorDTO" - } - }, - "aggregateSnapshots" : { - "type" : "array", - "description" : "A list of StatusSnapshotDTO objects that provide the actual metric values for the component. If the NiFi instance is clustered, this will represent the aggregate status across all nodes. If the NiFi instance is not clustered, this will represent the status of the entire NiFi instance.", - "items" : { - "$ref" : "#/definitions/StatusSnapshotDTO" - } - }, - "nodeSnapshots" : { - "type" : "array", - "description" : "The NodeStatusSnapshotsDTO objects that provide the actual metric values for the component, for each node. If the NiFi instance is not clustered, this value will be null.", - "items" : { - "$ref" : "#/definitions/NodeStatusSnapshotsDTO" - } - } - } - }, - "StatusHistoryEntity" : { - "type" : "object", - "properties" : { - "statusHistory" : { - "$ref" : "#/definitions/StatusHistoryDTO" - }, - "canRead" : { - "type" : "boolean", - "description" : "Indicates whether the user can read a given resource." - } - }, - "xml" : { - "name" : "statusHistoryEntity" - } - }, - "StatusSnapshotDTO" : { - "type" : "object", - "properties" : { - "timestamp" : { - "type" : "string", - "format" : "date-time", - "description" : "The timestamp of the snapshot." - }, - "statusMetrics" : { - "type" : "object", - "description" : "The status metrics.", - "additionalProperties" : { - "type" : "integer", - "format" : "int64" - } - } - } - }, - "StorageUsageDTO" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The identifier of this storage location. The identifier will correspond to the identifier keyed in the storage configuration." - }, - "freeSpace" : { - "type" : "string", - "description" : "Amount of free space." - }, - "totalSpace" : { - "type" : "string", - "description" : "Amount of total space." - }, - "usedSpace" : { - "type" : "string", - "description" : "Amount of used space." - }, - "freeSpaceBytes" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes of free space." - }, - "totalSpaceBytes" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes of total space." - }, - "usedSpaceBytes" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes of used space." - }, - "utilization" : { - "type" : "string", - "description" : "Utilization of this storage location." - } - } - }, - "StreamingOutput" : { - "type" : "object" - }, - "SubmitReplayRequestEntity" : { - "type" : "object", - "properties" : { - "eventId" : { - "type" : "integer", - "format" : "int64", - "description" : "The event identifier" - }, - "clusterNodeId" : { - "type" : "string", - "description" : "The identifier of the node where to submit the replay request." - } - }, - "xml" : { - "name" : "copySnippetRequestEntity" - } - }, - "SystemDiagnosticsDTO" : { - "type" : "object", - "properties" : { - "aggregateSnapshot" : { - "description" : "A systems diagnostic snapshot that represents the aggregate values of all nodes in the cluster. If the NiFi instance is a standalone instance, rather than a cluster, this represents the stats of the single instance.", - "$ref" : "#/definitions/SystemDiagnosticsSnapshotDTO" - }, - "nodeSnapshots" : { - "type" : "array", - "description" : "A systems diagnostics snapshot for each node in the cluster. If the NiFi instance is a standalone instance, rather than a cluster, this may be null.", - "items" : { - "$ref" : "#/definitions/NodeSystemDiagnosticsSnapshotDTO" - } - } - } - }, - "SystemDiagnosticsEntity" : { - "type" : "object", - "properties" : { - "systemDiagnostics" : { - "$ref" : "#/definitions/SystemDiagnosticsDTO" - } - }, - "xml" : { - "name" : "systemDiagnosticsEntity" - } - }, - "SystemDiagnosticsSnapshotDTO" : { - "type" : "object", - "properties" : { - "totalNonHeap" : { - "type" : "string", - "description" : "Total size of non heap." - }, - "totalNonHeapBytes" : { - "type" : "integer", - "format" : "int64", - "description" : "Total number of bytes allocated to the JVM not used for heap" - }, - "usedNonHeap" : { - "type" : "string", - "description" : "Amount of use non heap." - }, - "usedNonHeapBytes" : { - "type" : "integer", - "format" : "int64", - "description" : "Total number of bytes used by the JVM not in the heap space" - }, - "freeNonHeap" : { - "type" : "string", - "description" : "Amount of free non heap." - }, - "freeNonHeapBytes" : { - "type" : "integer", - "format" : "int64", - "description" : "Total number of free non-heap bytes available to the JVM" - }, - "maxNonHeap" : { - "type" : "string", - "description" : "Maximum size of non heap." - }, - "maxNonHeapBytes" : { - "type" : "integer", - "format" : "int64", - "description" : "The maximum number of bytes that the JVM can use for non-heap purposes" - }, - "nonHeapUtilization" : { - "type" : "string", - "description" : "Utilization of non heap." - }, - "totalHeap" : { - "type" : "string", - "description" : "Total size of heap." - }, - "totalHeapBytes" : { - "type" : "integer", - "format" : "int64", - "description" : "The total number of bytes that are available for the JVM heap to use" - }, - "usedHeap" : { - "type" : "string", - "description" : "Amount of used heap." - }, - "usedHeapBytes" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes of JVM heap that are currently being used" - }, - "freeHeap" : { - "type" : "string", - "description" : "Amount of free heap." - }, - "freeHeapBytes" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes that are allocated to the JVM heap but not currently being used" - }, - "maxHeap" : { - "type" : "string", - "description" : "Maximum size of heap." - }, - "maxHeapBytes" : { - "type" : "integer", - "format" : "int64", - "description" : "The maximum number of bytes that can be used by the JVM" - }, - "heapUtilization" : { - "type" : "string", - "description" : "Utilization of heap." - }, - "availableProcessors" : { - "type" : "integer", - "format" : "int32", - "description" : "Number of available processors if supported by the underlying system." - }, - "processorLoadAverage" : { - "type" : "number", - "format" : "double", - "description" : "The processor load average if supported by the underlying system." - }, - "totalThreads" : { - "type" : "integer", - "format" : "int32", - "description" : "Total number of threads." - }, - "daemonThreads" : { - "type" : "integer", - "format" : "int32", - "description" : "Number of daemon threads." - }, - "uptime" : { - "type" : "string", - "description" : "The uptime of the Java virtual machine" - }, - "flowFileRepositoryStorageUsage" : { - "description" : "The flowfile repository storage usage.", - "$ref" : "#/definitions/StorageUsageDTO" - }, - "contentRepositoryStorageUsage" : { - "type" : "array", - "description" : "The content repository storage usage.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/StorageUsageDTO" - } - }, - "provenanceRepositoryStorageUsage" : { - "type" : "array", - "description" : "The provenance repository storage usage.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/StorageUsageDTO" - } - }, - "garbageCollection" : { - "type" : "array", - "description" : "The garbage collection details.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/GarbageCollectionDTO" - } - }, - "statsLastRefreshed" : { - "type" : "string", - "description" : "When the diagnostics were generated." - }, - "versionInfo" : { - "description" : "The nifi, os, java, and build version information", - "$ref" : "#/definitions/VersionInfoDTO" - } - } - }, - "SystemResourceConsideration" : { - "type" : "object", - "properties" : { - "resource" : { - "type" : "string", - "description" : "The resource to consider" - }, - "description" : { - "type" : "string", - "description" : "The description of how the resource is affected" - } - } - }, - "TemplateDTO" : { - "type" : "object", - "properties" : { - "uri" : { - "type" : "string", - "description" : "The URI for the template." - }, - "id" : { - "type" : "string", - "description" : "The id of the template." - }, - "groupId" : { - "type" : "string", - "description" : "The id of the Process Group that the template belongs to." - }, - "name" : { - "type" : "string", - "description" : "The name of the template." - }, - "description" : { - "type" : "string", - "description" : "The description of the template." - }, - "timestamp" : { - "type" : "string", - "description" : "The timestamp when this template was created." - }, - "encodingVersion" : { - "type" : "string", - "xml" : { - "name" : "encoding-version", - "attribute" : true - }, - "description" : "The encoding version of this template." - }, - "snippet" : { - "description" : "The contents of the template.", - "$ref" : "#/definitions/FlowSnippetDTO" - } - }, - "xml" : { - "name" : "template" - } - }, - "TemplateEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "template" : { - "$ref" : "#/definitions/TemplateDTO" - } - }, - "xml" : { - "name" : "templateEntity" - } - }, - "TemplatesEntity" : { - "type" : "object", - "properties" : { - "templates" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/TemplateEntity" - } - }, - "generated" : { - "type" : "string", - "description" : "When this content was generated." - } - }, - "xml" : { - "name" : "templatesEntity" - } - }, - "TenantDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "versionedComponentId" : { - "type" : "string", - "description" : "The ID of the corresponding component that is under version control" - }, - "parentGroupId" : { - "type" : "string", - "description" : "The id of parent process group of this component if applicable." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "identity" : { - "type" : "string", - "description" : "The identity of the tenant." - }, - "configurable" : { - "type" : "boolean", - "description" : "Whether this tenant is configurable." - } - } - }, - "TenantEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "component" : { - "$ref" : "#/definitions/TenantDTO" - } - }, - "xml" : { - "name" : "tenantEntity" - } - }, - "TenantsEntity" : { - "type" : "object", - "properties" : { - "users" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/TenantEntity" - } - }, - "userGroups" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/TenantEntity" - } - } - }, - "xml" : { - "name" : "tenantsEntity" - } - }, - "ThreadDumpDTO" : { - "type" : "object", - "properties" : { - "nodeId" : { - "type" : "string", - "description" : "The ID of the node in the cluster" - }, - "nodeAddress" : { - "type" : "string", - "description" : "The address of the node in the cluster" - }, - "apiPort" : { - "type" : "integer", - "format" : "int32", - "description" : "The port the node is listening for API requests." - }, - "stackTrace" : { - "type" : "string", - "description" : "The stack trace for the thread" - }, - "threadName" : { - "type" : "string", - "description" : "The name of the thread" - }, - "threadActiveMillis" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of milliseconds that the thread has been executing in the Processor" - }, - "taskTerminated" : { - "type" : "boolean", - "description" : "Indicates whether or not the user has requested that the task be terminated. If this is true, it may indicate that the thread is in a state where it will continue running indefinitely without returning." - } - } - }, - "Throwable" : { - "type" : "object", - "properties" : { - "cause" : { - "$ref" : "#/definitions/Throwable" - }, - "stackTrace" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/StackTraceElement" - } - }, - "message" : { - "type" : "string" - }, - "suppressed" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/Throwable" - } - }, - "localizedMessage" : { - "type" : "string" - } - } - }, - "TransactionResultEntity" : { - "type" : "object", - "properties" : { - "flowFileSent" : { - "type" : "integer", - "format" : "int32" - }, - "responseCode" : { - "type" : "integer", - "format" : "int32" - }, - "message" : { - "type" : "string" - } - }, - "xml" : { - "name" : "transactionResultEntity" - } - }, - "UpdateControllerServiceReferenceRequestEntity" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The identifier of the Controller Service." - }, - "state" : { - "type" : "string", - "description" : "The new state of the references for the controller service.", - "enum" : [ "ENABLED", "DISABLED", "RUNNING", "STOPPED" ] - }, - "referencingComponentRevisions" : { - "type" : "object", - "description" : "The revisions for all referencing components.", - "additionalProperties" : { - "$ref" : "#/definitions/RevisionDTO" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "uiOnly" : { - "type" : "boolean", - "description" : "Indicates whether or not the response should only include fields necessary for rendering the NiFi User Interface. As such, when this value is set to true, some fields may be returned as null values, and the selected fields may change at any time without notice. As a result, this value should not be set to true by any client other than the UI." - } - }, - "xml" : { - "name" : "updateControllerServiceReferenceRequestEntity" - } - }, - "UserDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "versionedComponentId" : { - "type" : "string", - "description" : "The ID of the corresponding component that is under version control" - }, - "parentGroupId" : { - "type" : "string", - "description" : "The id of parent process group of this component if applicable." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "identity" : { - "type" : "string", - "description" : "The identity of the tenant." - }, - "configurable" : { - "type" : "boolean", - "description" : "Whether this tenant is configurable." - }, - "userGroups" : { - "type" : "array", - "description" : "The groups to which the user belongs. This field is read only and it provided for convenience.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/TenantEntity" - } - }, - "accessPolicies" : { - "type" : "array", - "description" : "The access policies this user belongs to.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/AccessPolicySummaryEntity" - } - } - } - }, - "UserEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "component" : { - "$ref" : "#/definitions/UserDTO" - } - }, - "xml" : { - "name" : "userEntity" - } - }, - "UserGroupDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "versionedComponentId" : { - "type" : "string", - "description" : "The ID of the corresponding component that is under version control" - }, - "parentGroupId" : { - "type" : "string", - "description" : "The id of parent process group of this component if applicable." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "identity" : { - "type" : "string", - "description" : "The identity of the tenant." - }, - "configurable" : { - "type" : "boolean", - "description" : "Whether this tenant is configurable." - }, - "users" : { - "type" : "array", - "description" : "The users that belong to the user group.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/TenantEntity" - } - }, - "accessPolicies" : { - "type" : "array", - "description" : "The access policies this user group belongs to. This field was incorrectly defined as an AccessPolicyEntity. For compatibility reasons the field will remain of this type, however only the fields that are present in the AccessPolicySummaryEntity will be populated here.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/AccessPolicyEntity" - } - } - } - }, - "UserGroupEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "component" : { - "$ref" : "#/definitions/UserGroupDTO" - } - }, - "xml" : { - "name" : "userGroupEntity" - } - }, - "UserGroupsEntity" : { - "type" : "object", - "properties" : { - "userGroups" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/UserGroupEntity" - } - } - }, - "xml" : { - "name" : "userGroupsEntity" - } - }, - "UsersEntity" : { - "type" : "object", - "properties" : { - "generated" : { - "type" : "string", - "description" : "When this content was generated." - }, - "users" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/UserEntity" - } - } - }, - "xml" : { - "name" : "usersEntity" - } - }, - "VariableDTO" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The name of the variable" - }, - "value" : { - "type" : "string", - "description" : "The value of the variable" - }, - "processGroupId" : { - "type" : "string", - "description" : "The ID of the Process Group where this Variable is defined" - }, - "affectedComponents" : { - "type" : "array", - "description" : "A set of all components that will be affected if the value of this variable is changed", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/AffectedComponentEntity" - } - } - } - }, - "VariableEntity" : { - "type" : "object", - "properties" : { - "variable" : { - "description" : "The variable information", - "$ref" : "#/definitions/VariableDTO" - }, - "canWrite" : { - "type" : "boolean", - "description" : "Indicates whether the user can write a given resource." - } - }, - "xml" : { - "name" : "variableEntity" - } - }, - "VariableRegistryDTO" : { - "type" : "object", - "properties" : { - "variables" : { - "type" : "array", - "description" : "The variables that are available in this Variable Registry", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VariableEntity" - } - }, - "processGroupId" : { - "type" : "string", - "description" : "The UUID of the Process Group that this Variable Registry belongs to" - } - } - }, - "VariableRegistryEntity" : { - "type" : "object", - "properties" : { - "processGroupRevision" : { - "description" : "The revision of the Process Group that the Variable Registry belongs to", - "$ref" : "#/definitions/RevisionDTO" - }, - "variableRegistry" : { - "description" : "The Variable Registry.", - "$ref" : "#/definitions/VariableRegistryDTO" - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - } - }, - "xml" : { - "name" : "variableRegistryEntity" - } - }, - "VariableRegistryUpdateRequestDTO" : { - "type" : "object", - "properties" : { - "requestId" : { - "type" : "string", - "description" : "The ID of the request" - }, - "uri" : { - "type" : "string", - "description" : "The URI for the request" - }, - "submissionTime" : { - "type" : "string", - "format" : "date-time", - "description" : "The timestamp of when the request was submitted" - }, - "lastUpdated" : { - "type" : "string", - "format" : "date-time", - "description" : "The timestamp of when the request was last updated" - }, - "complete" : { - "type" : "boolean", - "description" : "Whether or not the request is completed" - }, - "failureReason" : { - "type" : "string", - "description" : "The reason for the request failing, or null if the request has not failed" - }, - "percentCompleted" : { - "type" : "integer", - "format" : "int32", - "description" : "A value between 0 and 100 (inclusive) indicating how close the request is to completion" - }, - "state" : { - "type" : "string", - "description" : "A description of the current state of the request" - }, - "updateSteps" : { - "type" : "array", - "description" : "The steps that are required in order to complete the request, along with the status of each", - "items" : { - "$ref" : "#/definitions/VariableRegistryUpdateStepDTO" - } - }, - "processGroupId" : { - "type" : "string", - "description" : "The unique ID of the Process Group that the variable registry belongs to" - }, - "affectedComponents" : { - "type" : "array", - "description" : "A set of all components that will be affected if the value of this variable is changed", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/AffectedComponentEntity" - } - } - } - }, - "VariableRegistryUpdateRequestEntity" : { - "type" : "object", - "properties" : { - "request" : { - "description" : "The Variable Registry Update Request", - "$ref" : "#/definitions/VariableRegistryUpdateRequestDTO" - }, - "processGroupRevision" : { - "description" : "The revision for the Process Group that owns this variable registry.", - "$ref" : "#/definitions/RevisionDTO" - } - }, - "xml" : { - "name" : "variableRegistryUpdateRequestEntity" - } - }, - "VariableRegistryUpdateStepDTO" : { - "type" : "object", - "properties" : { - "description" : { - "type" : "string", - "description" : "Explanation of what happens in this step" - }, - "complete" : { - "type" : "boolean", - "description" : "Whether or not this step has completed" - }, - "failureReason" : { - "type" : "string", - "description" : "An explanation of why this step failed, or null if this step did not fail" - } - } - }, - "VerifyConfigRequestDTO" : { - "type" : "object", - "properties" : { - "requestId" : { - "type" : "string", - "description" : "The ID of the request" - }, - "uri" : { - "type" : "string", - "description" : "The URI for the request" - }, - "submissionTime" : { - "type" : "string", - "format" : "date-time", - "description" : "The timestamp of when the request was submitted" - }, - "lastUpdated" : { - "type" : "string", - "format" : "date-time", - "description" : "The timestamp of when the request was last updated" - }, - "complete" : { - "type" : "boolean", - "description" : "Whether or not the request is completed" - }, - "failureReason" : { - "type" : "string", - "description" : "The reason for the request failing, or null if the request has not failed" - }, - "percentCompleted" : { - "type" : "integer", - "format" : "int32", - "description" : "A value between 0 and 100 (inclusive) indicating how close the request is to completion" - }, - "state" : { - "type" : "string", - "description" : "A description of the current state of the request" - }, - "updateSteps" : { - "type" : "array", - "description" : "The steps that are required in order to complete the request, along with the status of each", - "items" : { - "$ref" : "#/definitions/VerifyConfigUpdateStepDTO" - } - }, - "componentId" : { - "type" : "string", - "description" : "The ID of the component whose configuration was verified" - }, - "properties" : { - "type" : "object", - "description" : "The configured component properties", - "additionalProperties" : { - "type" : "string" - } - }, - "attributes" : { - "type" : "object", - "description" : "FlowFile Attributes that should be used to evaluate Expression Language for resolving property values", - "additionalProperties" : { - "type" : "string" - } - }, - "results" : { - "type" : "array", - "description" : "The Results of the verification", - "items" : { - "$ref" : "#/definitions/ConfigVerificationResultDTO" - } - } - } - }, - "VerifyConfigRequestEntity" : { - "type" : "object", - "properties" : { - "request" : { - "description" : "The request", - "$ref" : "#/definitions/VerifyConfigRequestDTO" - } - }, - "xml" : { - "name" : "verifyConfigRequest" - } - }, - "VerifyConfigUpdateStepDTO" : { - "type" : "object", - "properties" : { - "description" : { - "type" : "string", - "description" : "Explanation of what happens in this step" - }, - "complete" : { - "type" : "boolean", - "description" : "Whether or not this step has completed" - }, - "failureReason" : { - "type" : "string", - "description" : "An explanation of why this step failed, or null if this step did not fail" - } - } - }, - "VersionControlComponentMappingEntity" : { - "type" : "object", - "properties" : { - "versionControlComponentMapping" : { - "type" : "object", - "description" : "The mapping of Versioned Component Identifiers to instance ID's", - "additionalProperties" : { - "type" : "string" - } - }, - "processGroupRevision" : { - "description" : "The revision of the Process Group", - "$ref" : "#/definitions/RevisionDTO" - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "versionControlInformation" : { - "description" : "The Version Control information", - "$ref" : "#/definitions/VersionControlInformationDTO" - } - }, - "xml" : { - "name" : "versionControlComponentMappingEntity" - } - }, - "VersionControlInformationDTO" : { - "type" : "object", - "properties" : { - "groupId" : { - "type" : "string", - "description" : "The ID of the Process Group that is under version control" - }, - "registryId" : { - "type" : "string", - "description" : "The ID of the registry that the flow is stored in" - }, - "registryName" : { - "type" : "string", - "description" : "The name of the registry that the flow is stored in" - }, - "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" - }, - "flowId" : { - "type" : "string", - "description" : "The ID of the flow" - }, - "flowName" : { - "type" : "string", - "description" : "The name of the flow" - }, - "flowDescription" : { - "type" : "string", - "description" : "The description of the flow" - }, - "version" : { - "type" : "integer", - "format" : "int32", - "description" : "The version of the flow" - }, - "storageLocation" : { - "type" : "string", - "description" : "The storage location" - }, - "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" ] - }, - "stateExplanation" : { - "type" : "string", - "description" : "Explanation of why the group is in the specified state" - } - } - }, - "VersionControlInformationEntity" : { - "type" : "object", - "properties" : { - "processGroupRevision" : { - "description" : "The Revision for the Process Group", - "$ref" : "#/definitions/RevisionDTO" - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "versionControlInformation" : { - "description" : "The Version Control information", - "$ref" : "#/definitions/VersionControlInformationDTO" - } - }, - "xml" : { - "name" : "versionControlInformationEntity" - } - }, - "VersionInfoDTO" : { - "type" : "object", - "properties" : { - "niFiVersion" : { - "type" : "string", - "description" : "The version of this NiFi." - }, - "javaVendor" : { - "type" : "string", - "description" : "Java JVM vendor" - }, - "javaVersion" : { - "type" : "string", - "description" : "Java version" - }, - "osName" : { - "type" : "string", - "description" : "Host operating system name" - }, - "osVersion" : { - "type" : "string", - "description" : "Host operating system version" - }, - "osArchitecture" : { - "type" : "string", - "description" : "Host operating system architecture" - }, - "buildTag" : { - "type" : "string", - "description" : "Build tag" - }, - "buildRevision" : { - "type" : "string", - "description" : "Build revision or commit hash" - }, - "buildBranch" : { - "type" : "string", - "description" : "Build branch" - }, - "buildTimestamp" : { - "type" : "string", - "format" : "date-time", - "description" : "Build timestamp" - } - } - }, - "VersionedConnection" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The component's unique identifier" - }, - "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" - }, - "comments" : { - "type" : "string", - "description" : "The user-supplied comments for the component" - }, - "position" : { - "description" : "The component's position on the graph", - "$ref" : "#/definitions/Position" - }, - "source" : { - "description" : "The source of the connection.", - "$ref" : "#/definitions/ConnectableComponent" - }, - "destination" : { - "description" : "The destination of the connection.", - "$ref" : "#/definitions/ConnectableComponent" - }, - "labelIndex" : { - "type" : "integer", - "format" : "int32", - "description" : "The index of the bend point where to place the connection label." - }, - "zIndex" : { - "type" : "integer", - "format" : "int64", - "description" : "The z index of the connection." - }, - "selectedRelationships" : { - "type" : "array", - "description" : "The selected relationship that comprise the connection.", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - }, - "backPressureObjectThreshold" : { - "type" : "integer", - "format" : "int64", - "description" : "The object count threshold for determining when back pressure is applied. Updating this value is a passive change in the sense that it won't impact whether existing files over the limit are affected but it does help feeder processors to stop pushing too much into this work queue." - }, - "backPressureDataSizeThreshold" : { - "type" : "string", - "description" : "The object data size threshold for determining when back pressure is applied. Updating this value is a passive change in the sense that it won't impact whether existing files over the limit are affected but it does help feeder processors to stop pushing too much into this work queue." - }, - "flowFileExpiration" : { - "type" : "string", - "description" : "The amount of time a flow file may be in the flow before it will be automatically aged out of the flow. Once a flow file reaches this age it will be terminated from the flow the next time a processor attempts to start work on it." - }, - "prioritizers" : { - "type" : "array", - "description" : "The comparators used to prioritize the queue.", - "items" : { - "type" : "string" - } - }, - "bends" : { - "type" : "array", - "description" : "The bend points on the connection.", - "items" : { - "$ref" : "#/definitions/Position" - } - }, - "loadBalanceStrategy" : { - "type" : "string", - "description" : "The Strategy to use for load balancing data across the cluster, or null, if no Load Balance Strategy has been specified.", - "enum" : [ "DO_NOT_LOAD_BALANCE", "PARTITION_BY_ATTRIBUTE", "ROUND_ROBIN", "SINGLE_NODE" ] - }, - "partitioningAttribute" : { - "type" : "string", - "description" : "The attribute to use for partitioning data as it is load balanced across the cluster. If the Load Balance Strategy is configured to use PARTITION_BY_ATTRIBUTE, the value returned by this method is the name of the FlowFile Attribute that will be used to determine which node in the cluster should receive a given FlowFile. If the Load Balance Strategy is unset or is set to any other value, the Partitioning Attribute has no effect." - }, - "loadBalanceCompression" : { - "type" : "string", - "description" : "Whether or not compression should be used when transferring FlowFiles between nodes", - "enum" : [ "DO_NOT_COMPRESS", "COMPRESS_ATTRIBUTES_ONLY", "COMPRESS_ATTRIBUTES_AND_CONTENT" ] - }, - "componentType" : { - "type" : "string", - "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE", "REPORTING_TASK", "PARAMETER_CONTEXT", "PARAMETER_PROVIDER", "TEMPLATE", "FLOW_REGISTRY_CLIENT" ] - }, - "groupIdentifier" : { - "type" : "string", - "description" : "The ID of the Process Group that this component belongs to" - } - } - }, - "VersionedControllerService" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The component's unique identifier" - }, - "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" - }, - "comments" : { - "type" : "string", - "description" : "The user-supplied comments for the component" - }, - "position" : { - "description" : "The component's position on the graph", - "$ref" : "#/definitions/Position" - }, - "type" : { - "type" : "string", - "description" : "The type of the extension component" - }, - "bundle" : { - "description" : "Information about the bundle from which the component came", - "$ref" : "#/definitions/Bundle" - }, - "properties" : { - "type" : "object", - "description" : "The properties for the component. Properties whose value is not set will only contain the property name.", - "additionalProperties" : { - "type" : "string" - } - }, - "propertyDescriptors" : { - "type" : "object", - "description" : "The property descriptors for the component.", - "additionalProperties" : { - "$ref" : "#/definitions/VersionedPropertyDescriptor" - } - }, - "controllerServiceApis" : { - "type" : "array", - "description" : "Lists the APIs this Controller Service implements.", - "items" : { - "$ref" : "#/definitions/ControllerServiceAPI" - } - }, - "annotationData" : { - "type" : "string", - "description" : "The annotation for the controller service. This is how the custom UI relays configuration to the controller service." - }, - "scheduledState" : { - "type" : "string", - "description" : "The ScheduledState denoting whether the Controller Service is ENABLED or DISABLED", - "enum" : [ "ENABLED", "DISABLED", "RUNNING" ] - }, - "bulletinLevel" : { - "type" : "string", - "description" : "The level at which the controller service will report bulletins." - }, - "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", "PARAMETER_CONTEXT", "PARAMETER_PROVIDER", "TEMPLATE", "FLOW_REGISTRY_CLIENT" ] - }, - "groupIdentifier" : { - "type" : "string", - "description" : "The ID of the Process Group that this component belongs to" - } - } - }, - "VersionedFlowCoordinates" : { - "type" : "object", - "properties" : { - "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" - }, - "registryUrl" : { - "type" : "string", - "description" : "The URL of the Flow Registry that contains the flow" - }, - "bucketId" : { - "type" : "string", - "description" : "The UUID of the bucket that the flow resides in" - }, - "flowId" : { - "type" : "string", - "description" : "The UUID of the flow" - }, - "version" : { - "type" : "integer", - "format" : "int32", - "description" : "The version of the flow" - }, - "latest" : { - "type" : "boolean", - "description" : "Whether or not these coordinates point to the latest version of the flow" - } - } - }, - "VersionedFlowDTO" : { - "type" : "object", - "properties" : { - "registryId" : { - "type" : "string", - "description" : "The ID of the registry that the flow is tracked to" - }, - "bucketId" : { - "type" : "string", - "description" : "The ID of the bucket where the flow is stored" - }, - "flowId" : { - "type" : "string", - "description" : "The ID of the flow" - }, - "flowName" : { - "type" : "string", - "description" : "The name of the flow" - }, - "description" : { - "type" : "string", - "description" : "A description of the flow" - }, - "comments" : { - "type" : "string", - "description" : "Comments for the changeset" - }, - "action" : { - "type" : "string", - "description" : "The action being performed", - "enum" : [ "COMMIT", "FORCE_COMMIT" ] - } - } - }, - "VersionedFlowEntity" : { - "type" : "object", - "properties" : { - "versionedFlow" : { - "description" : "The versioned flow", - "$ref" : "#/definitions/VersionedFlowDTO" - } - }, - "xml" : { - "name" : "versionedFlowEntity" - } - }, - "VersionedFlowSnapshotEntity" : { - "type" : "object", - "properties" : { - "versionedFlowSnapshot" : { - "description" : "The versioned flow snapshot", - "$ref" : "#/definitions/RegisteredFlowSnapshot" - }, - "processGroupRevision" : { - "description" : "The Revision of the Process Group under Version Control", - "$ref" : "#/definitions/RevisionDTO" - }, - "registryId" : { - "type" : "string", - "description" : "The ID of the Registry that this flow belongs to" - }, - "updateDescendantVersionedFlows" : { - "type" : "boolean", - "description" : "If the Process Group to be updated has a child or descendant Process Group that is also under Version Control, this specifies whether or not the contents of that child/descendant Process Group should be updated." - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - } - }, - "xml" : { - "name" : "versionedFlowSnapshotEntity" - } - }, - "VersionedFlowSnapshotMetadataEntity" : { - "type" : "object", - "properties" : { - "versionedFlowSnapshotMetadata" : { - "description" : "The collection of registered flow snapshot metadata", - "$ref" : "#/definitions/RegisteredFlowSnapshotMetadata" - }, - "registryId" : { - "type" : "string", - "description" : "The ID of the Registry that this flow belongs to" - } - }, - "xml" : { - "name" : "versionedFlowSnapshotMetadataEntity" - } - }, - "VersionedFlowSnapshotMetadataSetEntity" : { - "type" : "object", - "properties" : { - "versionedFlowSnapshotMetadataSet" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedFlowSnapshotMetadataEntity" - } - } - }, - "xml" : { - "name" : "versionedFlowSnapshotMetadataSetEntity" - } - }, - "VersionedFlowUpdateRequestDTO" : { - "type" : "object", - "properties" : { - "requestId" : { - "type" : "string", - "description" : "The unique ID of this request." - }, - "processGroupId" : { - "type" : "string", - "description" : "The unique ID of the Process Group being updated" - }, - "uri" : { - "type" : "string", - "description" : "The URI for future requests to this drop request." - }, - "lastUpdated" : { - "type" : "string", - "description" : "The last time this request was updated." - }, - "complete" : { - "type" : "boolean", - "description" : "Whether or not this request has completed" - }, - "failureReason" : { - "type" : "string", - "description" : "An explanation of why this request failed, or null if this request has not failed" - }, - "percentCompleted" : { - "type" : "integer", - "format" : "int32", - "description" : "The percentage complete for the request, between 0 and 100" - }, - "state" : { - "type" : "string", - "description" : "The state of the request" - }, - "versionControlInformation" : { - "description" : "The VersionControlInformation that describes where the Versioned Flow is located; this may not be populated until the request is completed.", - "$ref" : "#/definitions/VersionControlInformationDTO" - } - } - }, - "VersionedFlowUpdateRequestEntity" : { - "type" : "object", - "properties" : { - "processGroupRevision" : { - "description" : "The revision for the Process Group being updated.", - "$ref" : "#/definitions/RevisionDTO" - }, - "request" : { - "description" : "The Flow Update Request", - "$ref" : "#/definitions/VersionedFlowUpdateRequestDTO" - } - }, - "xml" : { - "name" : "registeredFlowUpdateRequestEntity" - } - }, - "VersionedFlowsEntity" : { - "type" : "object", - "properties" : { - "versionedFlows" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedFlowEntity" - } - } - }, - "xml" : { - "name" : "versionedFlowsEntity" - } - }, - "VersionedFunnel" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The component's unique identifier" - }, - "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" - }, - "comments" : { - "type" : "string", - "description" : "The user-supplied comments for the component" - }, - "position" : { - "description" : "The component's position on the graph", - "$ref" : "#/definitions/Position" - }, - "componentType" : { - "type" : "string", - "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE", "REPORTING_TASK", "PARAMETER_CONTEXT", "PARAMETER_PROVIDER", "TEMPLATE", "FLOW_REGISTRY_CLIENT" ] - }, - "groupIdentifier" : { - "type" : "string", - "description" : "The ID of the Process Group that this component belongs to" - } - } - }, - "VersionedLabel" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The component's unique identifier" - }, - "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" - }, - "comments" : { - "type" : "string", - "description" : "The user-supplied comments for the component" - }, - "position" : { - "description" : "The component's position on the graph", - "$ref" : "#/definitions/Position" - }, - "label" : { - "type" : "string", - "description" : "The text that appears in the label." - }, - "zIndex" : { - "type" : "integer", - "format" : "int64", - "description" : "The z index of the connection." - }, - "width" : { - "type" : "number", - "format" : "double", - "description" : "The width of the label in pixels when at a 1:1 scale." - }, - "height" : { - "type" : "number", - "format" : "double", - "description" : "The height of the label in pixels when at a 1:1 scale." - }, - "style" : { - "type" : "object", - "description" : "The styles for this label (font-size : 12px, background-color : #eee, etc).", - "additionalProperties" : { - "type" : "string" - } - }, - "componentType" : { - "type" : "string", - "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE", "REPORTING_TASK", "PARAMETER_CONTEXT", "PARAMETER_PROVIDER", "TEMPLATE", "FLOW_REGISTRY_CLIENT" ] - }, - "groupIdentifier" : { - "type" : "string", - "description" : "The ID of the Process Group that this component belongs to" - } - } - }, - "VersionedParameter" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The name of the parameter" - }, - "description" : { - "type" : "string", - "description" : "The description of the param" - }, - "sensitive" : { - "type" : "boolean", - "description" : "Whether or not the parameter value is sensitive" - }, - "provided" : { - "type" : "boolean", - "description" : "Whether or not the parameter value is provided by a ParameterProvider" - }, - "value" : { - "type" : "string", - "description" : "The value of the parameter" - } - } - }, - "VersionedParameterContext" : { - "type" : "object", - "properties" : { - "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" - }, - "comments" : { - "type" : "string", - "description" : "The user-supplied comments for the component" - }, - "position" : { - "description" : "The component's position on the graph", - "$ref" : "#/definitions/Position" - }, - "parameters" : { - "type" : "array", - "description" : "The parameters in the context", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedParameter" - } - }, - "inheritedParameterContexts" : { - "type" : "array", - "description" : "The names of additional parameter contexts from which to inherit parameters", - "items" : { - "type" : "string" - } - }, - "description" : { - "type" : "string", - "description" : "The description of the parameter context" - }, - "parameterProvider" : { - "type" : "string", - "description" : "The identifier of an optional parameter provider" - }, - "parameterGroupName" : { - "type" : "string", - "description" : "The corresponding parameter group name fetched from the parameter provider, if applicable" - }, - "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", "PARAMETER_CONTEXT", "PARAMETER_PROVIDER", "TEMPLATE", "FLOW_REGISTRY_CLIENT" ] - }, - "synchronized" : { - "type" : "boolean", - "description" : "True if the parameter provider is set and the context should receive updates when its parameters are next fetched" - }, - "groupIdentifier" : { - "type" : "string", - "description" : "The ID of the Process Group that this component belongs to" - } - } - }, - "VersionedPort" : { - "type" : "object", - "properties" : { - "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" - }, - "comments" : { - "type" : "string", - "description" : "The user-supplied comments for the component" - }, - "position" : { - "description" : "The component's position on the graph", - "$ref" : "#/definitions/Position" - }, - "type" : { - "type" : "string", - "description" : "The type of port.", - "enum" : [ "INPUT_PORT", "OUTPUT_PORT" ] - }, - "concurrentlySchedulableTaskCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of tasks that should be concurrently scheduled for the port." - }, - "scheduledState" : { - "type" : "string", - "description" : "The scheduled state of the component", - "enum" : [ "ENABLED", "DISABLED", "RUNNING" ] - }, - "allowRemoteAccess" : { - "type" : "boolean", - "description" : "Whether or not this port allows remote access for site-to-site" - }, - "componentType" : { - "type" : "string", - "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE", "REPORTING_TASK", "PARAMETER_CONTEXT", "PARAMETER_PROVIDER", "TEMPLATE", "FLOW_REGISTRY_CLIENT" ] - }, - "groupIdentifier" : { - "type" : "string", - "description" : "The ID of the Process Group that this component belongs to" - } - } - }, - "VersionedProcessGroup" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The component's unique identifier" - }, - "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" - }, - "comments" : { - "type" : "string", - "description" : "The user-supplied comments for the component" - }, - "position" : { - "description" : "The component's position on the graph", - "$ref" : "#/definitions/Position" - }, - "processGroups" : { - "type" : "array", - "description" : "The child Process Groups", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedProcessGroup" - } - }, - "remoteProcessGroups" : { - "type" : "array", - "description" : "The Remote Process Groups", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedRemoteProcessGroup" - } - }, - "processors" : { - "type" : "array", - "description" : "The Processors", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedProcessor" - } - }, - "inputPorts" : { - "type" : "array", - "description" : "The Input Ports", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedPort" - } - }, - "outputPorts" : { - "type" : "array", - "description" : "The Output Ports", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedPort" - } - }, - "connections" : { - "type" : "array", - "description" : "The Connections", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedConnection" - } - }, - "labels" : { - "type" : "array", - "description" : "The Labels", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedLabel" - } - }, - "funnels" : { - "type" : "array", - "description" : "The Funnels", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedFunnel" - } - }, - "controllerServices" : { - "type" : "array", - "description" : "The Controller Services", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedControllerService" - } - }, - "versionedFlowCoordinates" : { - "description" : "The coordinates where the remote flow is stored, or null if the Process Group is not directly under Version Control", - "$ref" : "#/definitions/VersionedFlowCoordinates" - }, - "variables" : { - "type" : "object", - "description" : "The Variables in the Variable Registry for this Process Group (not including any ancestor or descendant Process Groups)", - "additionalProperties" : { - "type" : "string" - } - }, - "parameterContextName" : { - "type" : "string", - "description" : "The name of the parameter context used by this process group" - }, - "defaultFlowFileExpiration" : { - "type" : "string", - "description" : "The default FlowFile Expiration for this Process Group." - }, - "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." - }, - "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." - }, - "logFileSuffix" : { - "type" : "string", - "description" : "The log file suffix for this Process Group for dedicated logging." - }, - "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", "PARAMETER_CONTEXT", "PARAMETER_PROVIDER", "TEMPLATE", "FLOW_REGISTRY_CLIENT" ] - }, - "flowFileConcurrency" : { - "type" : "string", - "description" : "The configured FlowFile Concurrency for the Process Group" - }, - "flowFileOutboundPolicy" : { - "type" : "string", - "description" : "The FlowFile Outbound Policy for the Process Group" - }, - "groupIdentifier" : { - "type" : "string", - "description" : "The ID of the Process Group that this component belongs to" - } - } - }, - "VersionedProcessor" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The component's unique identifier" - }, - "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" - }, - "comments" : { - "type" : "string", - "description" : "The user-supplied comments for the component" - }, - "position" : { - "description" : "The component's position on the graph", - "$ref" : "#/definitions/Position" - }, - "type" : { - "type" : "string", - "description" : "The type of the extension component" - }, - "bundle" : { - "description" : "Information about the bundle from which the component came", - "$ref" : "#/definitions/Bundle" - }, - "properties" : { - "type" : "object", - "description" : "The properties for the component. Properties whose value is not set will only contain the property name.", - "additionalProperties" : { - "type" : "string" - } - }, - "propertyDescriptors" : { - "type" : "object", - "description" : "The property descriptors for the component.", - "additionalProperties" : { - "$ref" : "#/definitions/VersionedPropertyDescriptor" - } - }, - "style" : { - "type" : "object", - "description" : "Stylistic data for rendering in a UI", - "additionalProperties" : { - "type" : "string" - } - }, - "annotationData" : { - "type" : "string", - "description" : "The annotation data for the processor used to relay configuration between a custom UI and the procesosr." - }, - "schedulingPeriod" : { - "type" : "string", - "description" : "The frequency with which to schedule the processor. The format of the value will depend on th value of schedulingStrategy." - }, - "schedulingStrategy" : { - "type" : "string", - "description" : "Indicates whether the processor should be scheduled to run in event or timer driven mode." - }, - "executionNode" : { - "type" : "string", - "description" : "Indicates the node where the process will execute." - }, - "penaltyDuration" : { - "type" : "string", - "description" : "The amout of time that is used when the process penalizes a flowfile." - }, - "yieldDuration" : { - "type" : "string", - "description" : "The amount of time that must elapse before this processor is scheduled again after yielding." - }, - "bulletinLevel" : { - "type" : "string", - "description" : "The level at which the processor will report bulletins." - }, - "runDurationMillis" : { - "type" : "integer", - "format" : "int64", - "description" : "The run duration for the processor in milliseconds." - }, - "concurrentlySchedulableTaskCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of tasks that should be concurrently schedule for the processor. If the processor doesn't allow parallol processing then any positive input will be ignored." - }, - "autoTerminatedRelationships" : { - "type" : "array", - "description" : "The names of all relationships that cause a flow file to be terminated if the relationship is not connected elsewhere. This property differs from the 'isAutoTerminate' property of the RelationshipDTO in that the RelationshipDTO is meant to depict the current configuration, whereas this property can be set in a DTO when updating a Processor in order to change which Relationships should be auto-terminated.", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - }, - "scheduledState" : { - "type" : "string", - "description" : "The scheduled state of the component", - "enum" : [ "ENABLED", "DISABLED", "RUNNING" ] - }, - "retryCount" : { - "type" : "integer", - "format" : "int32", - "description" : "Overall number of retries." - }, - "retriedRelationships" : { - "type" : "array", - "description" : "All the relationships should be retried.", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - }, - "backoffMechanism" : { - "type" : "string", - "description" : "Determines whether the FlowFile should be penalized or the processor should be yielded between retries.", - "enum" : [ "PENALIZE_FLOWFILE", "YIELD_PROCESSOR" ] - }, - "maxBackoffPeriod" : { - "type" : "string", - "description" : "Maximum amount of time to be waited during a retry period." - }, - "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", "PARAMETER_CONTEXT", "PARAMETER_PROVIDER", "TEMPLATE", "FLOW_REGISTRY_CLIENT" ] - }, - "groupIdentifier" : { - "type" : "string", - "description" : "The ID of the Process Group that this component belongs to" - } - } - }, - "VersionedPropertyDescriptor" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The name of the property" - }, - "displayName" : { - "type" : "string", - "description" : "The display name of the property" - }, - "identifiesControllerService" : { - "type" : "boolean", - "description" : "Whether or not the property provides the identifier of a Controller Service" - }, - "sensitive" : { - "type" : "boolean", - "description" : "Whether or not the property is considered sensitive" - }, - "resourceDefinition" : { - "description" : "Returns the Resource Definition that defines which type(s) of resource(s) this property references, if any", - "$ref" : "#/definitions/VersionedResourceDefinition" - } - } - }, - "VersionedRemoteGroupPort" : { - "type" : "object", - "properties" : { - "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" - }, - "comments" : { - "type" : "string", - "description" : "The user-supplied comments for the component" - }, - "position" : { - "description" : "The component's position on the graph", - "$ref" : "#/definitions/Position" - }, - "remoteGroupId" : { - "type" : "string", - "description" : "The id of the remote process group that the port resides in." - }, - "concurrentlySchedulableTaskCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of task that may transmit flowfiles to the target port concurrently." - }, - "useCompression" : { - "type" : "boolean", - "description" : "Whether the flowfiles are compressed when sent to the target port." - }, - "batchSize" : { - "description" : "The batch settings for data transmission.", - "$ref" : "#/definitions/BatchSize" - }, - "componentType" : { - "type" : "string", - "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE", "REPORTING_TASK", "PARAMETER_CONTEXT", "PARAMETER_PROVIDER", "TEMPLATE", "FLOW_REGISTRY_CLIENT" ] - }, - "targetId" : { - "type" : "string", - "description" : "The ID of the port on the target NiFi instance" - }, - "scheduledState" : { - "type" : "string", - "description" : "The scheduled state of the component", - "enum" : [ "ENABLED", "DISABLED", "RUNNING" ] - }, - "groupIdentifier" : { - "type" : "string", - "description" : "The ID of the Process Group that this component belongs to" - } - } - }, - "VersionedRemoteProcessGroup" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The component's unique identifier" - }, - "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" - }, - "comments" : { - "type" : "string", - "description" : "The user-supplied comments for the component" - }, - "position" : { - "description" : "The component's position on the graph", - "$ref" : "#/definitions/Position" - }, - "targetUri" : { - "type" : "string", - "description" : "[DEPRECATED] The target URI of the remote process group. If target uri is not set, but uris are set, then returns the first uri in the uris. If neither target uri nor uris are set, then returns null." - }, - "targetUris" : { - "type" : "string", - "description" : "The target URIs of the remote process group. If target uris is not set but target uri is set, then returns the single target uri. If neither target uris nor target uri is set, then returns null." - }, - "communicationsTimeout" : { - "type" : "string", - "description" : "The time period used for the timeout when communicating with the target." - }, - "yieldDuration" : { - "type" : "string", - "description" : "When yielding, this amount of time must elapse before the remote process group is scheduled again." - }, - "transportProtocol" : { - "type" : "string", - "description" : "The Transport Protocol that is used for Site-to-Site communications", - "enum" : [ "RAW", "HTTP" ] - }, - "localNetworkInterface" : { - "type" : "string", - "description" : "The local network interface to send/receive data. If not specified, any local address is used. If clustered, all nodes must have an interface with this identifier." - }, - "proxyHost" : { - "type" : "string" - }, - "proxyPort" : { - "type" : "integer", - "format" : "int32" - }, - "proxyUser" : { - "type" : "string" - }, - "proxyPassword" : { - "type" : "string" - }, - "inputPorts" : { - "type" : "array", - "description" : "A Set of Input Ports that can be connected to, in order to send data to the remote NiFi instance", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedRemoteGroupPort" - } - }, - "outputPorts" : { - "type" : "array", - "description" : "A Set of Output Ports that can be connected to, in order to pull data from the remote NiFi instance", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedRemoteGroupPort" - } - }, - "componentType" : { - "type" : "string", - "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE", "REPORTING_TASK", "PARAMETER_CONTEXT", "PARAMETER_PROVIDER", "TEMPLATE", "FLOW_REGISTRY_CLIENT" ] - }, - "groupIdentifier" : { - "type" : "string", - "description" : "The ID of the Process Group that this component belongs to" - } - } - }, - "VersionedResourceDefinition" : { - "type" : "object", - "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", - "uniqueItems" : true, - "items" : { - "type" : "string", - "enum" : [ "FILE", "DIRECTORY", "TEXT", "URL" ] - } - } - } - } - } -} \ No newline at end of file diff --git a/resources/client_gen/api_defs/nifi-1.27.0.json b/resources/client_gen/api_defs/nifi-1.27.0.json deleted file mode 100644 index cdf5a50b..00000000 --- a/resources/client_gen/api_defs/nifi-1.27.0.json +++ /dev/null @@ -1,26499 +0,0 @@ -{ - "swagger" : "2.0", - "info" : { - "description" : "The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and\n stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description,\n definitions of the expected input and output, potential response codes, and the authorizations required\n to invoke each service.", - "version" : "1.27.0", - "title" : "NiFi Rest API", - "contact" : { - "url" : "https://nifi.apache.org", - "email" : "dev@nifi.apache.org" - }, - "license" : { - "name" : "Apache 2.0", - "url" : "http://www.apache.org/licenses/LICENSE-2.0.html" - } - }, - "basePath" : "/nifi-api", - "tags" : [ { - "name" : "access", - "description" : "Endpoints for obtaining an access token or checking access status." - }, { - "name" : "connections", - "description" : "Endpoint for managing a Connection." - }, { - "name" : "controller", - "description" : "Provides realtime command and control of this NiFi instance" - }, { - "name" : "controller-services", - "description" : "Endpoint for managing a Controller Service." - }, { - "name" : "counters", - "description" : "Endpoint for managing counters." - }, { - "name" : "data-transfer", - "description" : "Supports data transfers with this NiFi using HTTP based site to site" - }, { - "name" : "flow", - "description" : "Endpoint for accessing the flow structure and component status." - }, { - "name" : "flowfile-queues", - "description" : "Endpoint for managing a FlowFile Queue." - }, { - "name" : "funnel", - "description" : "Endpoint for managing a Funnel." - }, { - "name" : "input-ports", - "description" : "Endpoint for managing an Input Port." - }, { - "name" : "labels", - "description" : "Endpoint for managing a Label." - }, { - "name" : "output-ports", - "description" : "Endpoint for managing an Output Port." - }, { - "name" : "parameter-contexts", - "description" : "Endpoint for managing version control for a flow" - }, { - "name" : "parameter-providers", - "description" : "Endpoint for managing a Parameter Provider." - }, { - "name" : "policies", - "description" : "Endpoint for managing access policies." - }, { - "name" : "process-groups", - "description" : "Endpoint for managing a Process Group." - }, { - "name" : "processors", - "description" : "Endpoint for managing a Processor." - }, { - "name" : "provenance", - "description" : "Endpoint for accessing data flow provenance." - }, { - "name" : "provenance-events", - "description" : "Endpoint for accessing data flow provenance." - }, { - "name" : "remote-process-groups", - "description" : "Endpoint for managing a Remote Process Group." - }, { - "name" : "reporting-tasks", - "description" : "Endpoint for managing a Reporting Task." - }, { - "name" : "resources", - "description" : "Provides the resources in this NiFi that can have access/authorization policies." - }, { - "name" : "site-to-site", - "description" : "Provide access to site to site with this NiFi" - }, { - "name" : "snippets", - "description" : "Endpoint for accessing dataflow snippets." - }, { - "name" : "system-diagnostics", - "description" : "Endpoint for accessing system diagnostics." - }, { - "name" : "templates", - "description" : "Endpoint for managing a Template." - }, { - "name" : "tenants", - "description" : "Endpoint for managing users and user groups." - }, { - "name" : "versions", - "description" : "Endpoint for managing version control for a flow" - } ], - "schemes" : [ "http", "https" ], - "paths" : { - "/access" : { - "get" : { - "tags" : [ "access" ], - "summary" : "Gets the status the client's access", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getAccessStatus", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/AccessStatusEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Unable to determine access status because the client could not be authenticated." - }, - "403" : { - "description" : "Unable to determine access status because the client is not authorized to make this request." - }, - "409" : { - "description" : "Unable to determine access status because NiFi is not in the appropriate state." - }, - "500" : { - "description" : "Unable to determine access status because an unexpected error occurred." - } - } - } - }, - "/access/config" : { - "get" : { - "tags" : [ "access" ], - "summary" : "Retrieves the access configuration for this NiFi", - "description" : "", - "operationId" : "getLoginConfig", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/AccessConfigurationEntity" - } - } - } - } - }, - "/access/kerberos" : { - "post" : { - "tags" : [ "access" ], - "summary" : "Creates a token for accessing the REST API via Kerberos ticket exchange / SPNEGO negotiation", - "description" : "The token returned is formatted as a JSON Web Token (JWT). The token is base64 encoded and comprised of three parts. The header, the body, and the signature. The expiration of the token is a contained within the body. The token can be used in the Authorization header in the format 'Authorization: Bearer '. It is also stored in the browser as a cookie.", - "operationId" : "createAccessTokenFromTicket", - "consumes" : [ "text/plain" ], - "produces" : [ "text/plain" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "NiFi was unable to complete the request because it did not contain a valid Kerberos ticket in the Authorization header. Retry this request after initializing a ticket with kinit and ensuring your browser is configured to support SPNEGO." - }, - "409" : { - "description" : "Unable to create access token because NiFi is not in the appropriate state. (i.e. may not be configured to support Kerberos login." - }, - "500" : { - "description" : "Unable to create access token because an unexpected error occurred." - } - } - } - }, - "/access/knox/callback" : { - "get" : { - "tags" : [ "access" ], - "summary" : "Redirect/callback URI for processing the result of the Apache Knox login sequence.", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "knoxCallback", - "consumes" : [ "*/*" ], - "produces" : [ "*/*" ], - "responses" : { - "default" : { - "description" : "successful operation" - } - } - } - }, - "/access/knox/logout" : { - "get" : { - "tags" : [ "access" ], - "summary" : "Performs a logout in the Apache Knox.", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "knoxLogout", - "consumes" : [ "*/*" ], - "produces" : [ "*/*" ], - "responses" : { - "default" : { - "description" : "successful operation" - } - } - } - }, - "/access/knox/request" : { - "get" : { - "tags" : [ "access" ], - "summary" : "Initiates a request to authenticate through Apache Knox.", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "knoxRequest", - "consumes" : [ "*/*" ], - "produces" : [ "*/*" ], - "responses" : { - "default" : { - "description" : "successful operation" - } - } - } - }, - "/access/logout" : { - "delete" : { - "tags" : [ "access" ], - "summary" : "Performs a logout for other providers that have been issued a JWT.", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "logOut", - "consumes" : [ "*/*" ], - "produces" : [ "*/*" ], - "responses" : { - "200" : { - "description" : "User was logged out successfully." - }, - "401" : { - "description" : "Authentication token provided was empty or not in the correct JWT format." - }, - "500" : { - "description" : "Client failed to log out." - } - } - } - }, - "/access/logout/complete" : { - "get" : { - "tags" : [ "access" ], - "summary" : "Completes the logout sequence by removing the cached Logout Request and Cookie if they existed and redirects to /nifi/login.", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "logOutComplete", - "consumes" : [ "*/*" ], - "produces" : [ "*/*" ], - "responses" : { - "200" : { - "description" : "User was logged out successfully." - }, - "401" : { - "description" : "Authentication token provided was empty or not in the correct JWT format." - }, - "500" : { - "description" : "Client failed to log out." - } - } - } - }, - "/access/token" : { - "post" : { - "tags" : [ "access" ], - "summary" : "Creates a token for accessing the REST API via username/password", - "description" : "The token returned is formatted as a JSON Web Token (JWT). The token is base64 encoded and comprised of three parts. The header, the body, and the signature. The expiration of the token is a contained within the body. 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", - "consumes" : [ "application/x-www-form-urlencoded" ], - "produces" : [ "text/plain" ], - "parameters" : [ { - "name" : "username", - "in" : "formData", - "required" : false, - "type" : "string" - }, { - "name" : "password", - "in" : "formData", - "required" : false, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "Unable to create access token because NiFi is not in the appropriate state. (i.e. may not be configured to support username/password login." - }, - "500" : { - "description" : "Unable to create access token because an unexpected error occurred." - } - } - } - }, - "/access/token/expiration" : { - "get" : { - "tags" : [ "access" ], - "summary" : "Get expiration for current Access Token", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getAccessTokenExpiration", - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "Access Token Expiration found", - "schema" : { - "$ref" : "#/definitions/AccessTokenExpirationEntity" - } - }, - "401" : { - "description" : "Access Token not authorized" - }, - "409" : { - "description" : "Access Token not resolved" - } - } - } - }, - "/connections/{id}" : { - "get" : { - "tags" : [ "connections" ], - "summary" : "Gets a connection", - "description" : "", - "operationId" : "getConnection", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The connection id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ConnectionEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read Source - /{component-type}/{uuid}" : [ ] - }, { - "Read Destination - /{component-type}/{uuid}" : [ ] - } ] - }, - "put" : { - "tags" : [ "connections" ], - "summary" : "Updates a connection", - "description" : "", - "operationId" : "updateConnection", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The connection id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The connection configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ConnectionEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ConnectionEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write Source - /{component-type}/{uuid}" : [ ] - }, { - "Write Destination - /{component-type}/{uuid}" : [ ] - }, { - "Write New Destination - /{component-type}/{uuid} - if updating Destination" : [ ] - }, { - "Write Process Group - /process-groups/{uuid} - if updating Destination" : [ ] - } ] - }, - "delete" : { - "tags" : [ "connections" ], - "summary" : "Deletes a connection", - "description" : "", - "operationId" : "deleteConnection", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The revision is used to verify the client is working with the latest version of the flow.", - "required" : false, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The connection id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ConnectionEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write Source - /{component-type}/{uuid}" : [ ] - }, { - "Write - Parent Process Group - /process-groups/{uuid}" : [ ] - }, { - "Write Destination - /{component-type}/{uuid}" : [ ] - } ] - } - }, - "/controller-services/{id}" : { - "get" : { - "tags" : [ "controller-services" ], - "summary" : "Gets a controller service", - "description" : "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", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The controller service id.", - "required" : true, - "type" : "string" - }, { - "name" : "uiOnly", - "in" : "query", - "required" : false, - "type" : "boolean", - "default" : false - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ControllerServiceEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /controller-services/{uuid}" : [ ] - } ] - }, - "put" : { - "tags" : [ "controller-services" ], - "summary" : "Updates a controller service", - "description" : "", - "operationId" : "updateControllerService", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The controller service id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The controller service configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ControllerServiceEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ControllerServiceEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /controller-services/{uuid}" : [ ] - }, { - "Read - any referenced Controller Services if this request changes the reference - /controller-services/{uuid}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "controller-services" ], - "summary" : "Deletes a controller service", - "description" : "", - "operationId" : "removeControllerService", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The revision is used to verify the client is working with the latest version of the flow.", - "required" : false, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The controller service id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ControllerServiceEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /controller-services/{uuid}" : [ ] - }, { - "Write - Parent Process Group if scoped by Process Group - /process-groups/{uuid}" : [ ] - }, { - "Write - Controller if scoped by Controller - /controller" : [ ] - }, { - "Read - any referenced Controller Services - /controller-services/{uuid}" : [ ] - } ] - } - }, - "/controller-services/{id}/config/analysis" : { - "post" : { - "tags" : [ "controller-services" ], - "summary" : "Performs analysis of the component's configuration, providing information about which attributes are referenced.", - "description" : "", - "operationId" : "analyzeConfiguration", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The controller service id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The configuration analysis request.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ConfigurationAnalysisEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/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. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /controller-services/{uuid}" : [ ] - } ] - } - }, - "/controller-services/{id}/config/verification-requests" : { - "post" : { - "tags" : [ "controller-services" ], - "summary" : "Performs verification of the Controller Service's configuration", - "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", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The controller service id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The controller service configuration verification request.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/VerifyConfigRequestEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/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. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /controller-services/{uuid}" : [ ] - } ] - } - }, - "/controller-services/{id}/config/verification-requests/{requestId}" : { - "get" : { - "tags" : [ "controller-services" ], - "summary" : "Returns the Verification Request with the given ID", - "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", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The ID of the Controller Service", - "required" : true, - "type" : "string" - }, { - "name" : "requestId", - "in" : "path", - "description" : "The ID of the Verification Request", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/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. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Only the user that submitted the request can get it" : [ ] - } ] - }, - "delete" : { - "tags" : [ "controller-services" ], - "summary" : "Deletes the Verification Request with the given ID", - "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", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The ID of the Controller Service", - "required" : true, - "type" : "string" - }, { - "name" : "requestId", - "in" : "path", - "description" : "The ID of the Verification Request", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/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. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Only the user that submitted the request can remove it" : [ ] - } ] - } - }, - "/controller-services/{id}/descriptors" : { - "get" : { - "tags" : [ "controller-services" ], - "summary" : "Gets a controller service property descriptor", - "description" : "", - "operationId" : "getPropertyDescriptor", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The controller service id.", - "required" : true, - "type" : "string" - }, { - "name" : "propertyName", - "in" : "query", - "description" : "The property name to return the descriptor for.", - "required" : true, - "type" : "string" - }, { - "name" : "sensitive", - "in" : "query", - "description" : "Property Descriptor requested sensitive status", - "required" : false, - "type" : "boolean", - "default" : false - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/PropertyDescriptorEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /controller-services/{uuid}" : [ ] - } ] - } - }, - "/controller-services/{id}/references" : { - "get" : { - "tags" : [ "controller-services" ], - "summary" : "Gets a controller service", - "description" : "", - "operationId" : "getControllerServiceReferences", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The controller service id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ControllerServiceReferencingComponentsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /controller-services/{uuid}" : [ ] - } ] - }, - "put" : { - "tags" : [ "controller-services" ], - "summary" : "Updates a controller services references", - "description" : "", - "operationId" : "updateControllerServiceReferences", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The controller service id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The controller service request update request.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/UpdateControllerServiceReferenceRequestEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ControllerServiceReferencingComponentsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /{component-type}/{uuid} or /operate/{component-type}/{uuid} - For each referencing component specified" : [ ] - } ] - } - }, - "/controller-services/{id}/run-status" : { - "put" : { - "tags" : [ "controller-services" ], - "summary" : "Updates run status of a controller service", - "description" : "", - "operationId" : "updateRunStatus", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The controller service id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The controller service run status.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ControllerServiceRunStatusEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ControllerServiceEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /controller-services/{uuid} or /operation/controller-services/{uuid}" : [ ] - } ] - } - }, - "/controller-services/{id}/state" : { - "get" : { - "tags" : [ "controller-services" ], - "summary" : "Gets the state for a controller service", - "description" : "", - "operationId" : "getState", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The controller service id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ComponentStateEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /controller-services/{uuid}" : [ ] - } ] - } - }, - "/controller-services/{id}/state/clear-requests" : { - "post" : { - "tags" : [ "controller-services" ], - "summary" : "Clears the state for a controller service", - "description" : "", - "operationId" : "clearState", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The controller service id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ComponentStateEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /controller-services/{uuid}" : [ ] - } ] - } - }, - "/controller/bulletin" : { - "post" : { - "tags" : [ "controller" ], - "summary" : "Creates a new bulletin", - "description" : "", - "operationId" : "createBulletin", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The reporting task configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/BulletinEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /controller" : [ ] - } ] - } - }, - "/controller/cluster" : { - "get" : { - "tags" : [ "controller" ], - "summary" : "Gets the contents of the cluster", - "description" : "Returns the contents of the cluster including all nodes and their status.", - "operationId" : "getCluster", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ClusterEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /controller" : [ ] - } ] - } - }, - "/controller/cluster/nodes/{id}" : { - "get" : { - "tags" : [ "controller" ], - "summary" : "Gets a node in the cluster", - "description" : "", - "operationId" : "getNode", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The node id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/NodeEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /controller" : [ ] - } ] - }, - "put" : { - "tags" : [ "controller" ], - "summary" : "Updates a node in the cluster", - "description" : "", - "operationId" : "updateNode", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The node id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The node configuration. The only configuration that will be honored at this endpoint is the status.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/NodeEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/NodeEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /controller" : [ ] - } ] - }, - "delete" : { - "tags" : [ "controller" ], - "summary" : "Removes a node from the cluster", - "description" : "", - "operationId" : "deleteNode", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The node id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/NodeEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /controller" : [ ] - } ] - } - }, - "/controller/config" : { - "get" : { - "tags" : [ "controller" ], - "summary" : "Retrieves the configuration for this NiFi Controller", - "description" : "", - "operationId" : "getControllerConfig", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ControllerConfigurationEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /controller" : [ ] - } ] - }, - "put" : { - "tags" : [ "controller" ], - "summary" : "Retrieves the configuration for this NiFi", - "description" : "", - "operationId" : "updateControllerConfig", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The controller configuration.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ControllerConfigurationEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ControllerConfigurationEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /controller" : [ ] - } ] - } - }, - "/controller/controller-services" : { - "post" : { - "tags" : [ "controller" ], - "summary" : "Creates a new controller service", - "description" : "", - "operationId" : "createControllerService", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The controller service configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ControllerServiceEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ControllerServiceEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /controller" : [ ] - }, { - "Read - any referenced Controller Services - /controller-services/{uuid}" : [ ] - }, { - "Write - if the Controller Service is restricted - /restricted-components" : [ ] - } ] - } - }, - "/controller/history" : { - "delete" : { - "tags" : [ "controller" ], - "summary" : "Purges history", - "description" : "", - "operationId" : "deleteHistory", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "endDate", - "in" : "query", - "description" : "Purge actions before this date/time.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/HistoryEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /controller" : [ ] - } ] - } - }, - "/controller/parameter-providers" : { - "post" : { - "tags" : [ "controller" ], - "summary" : "Creates a new parameter provider", - "description" : "", - "operationId" : "createParameterProvider", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The parameter provider configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ParameterProviderEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/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. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /controller" : [ ] - }, { - "Read - any referenced Controller Services - /controller-services/{uuid}" : [ ] - }, { - "Write - if the Parameter Provider is restricted - /restricted-components" : [ ] - } ] - } - }, - "/controller/registry-clients" : { - "get" : { - "tags" : [ "controller" ], - "summary" : "Gets the listing of available flow registry clients", - "description" : "", - "operationId" : "getFlowRegistryClients", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/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. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - }, - "post" : { - "tags" : [ "controller" ], - "summary" : "Creates a new flow registry client", - "description" : "", - "operationId" : "createFlowRegistryClient", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The flow registry client configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/FlowRegistryClientEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/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. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /controller" : [ ] - } ] - } - }, - "/controller/registry-clients/{id}" : { - "get" : { - "tags" : [ "controller" ], - "summary" : "Gets a flow registry client", - "description" : "", - "operationId" : "getFlowRegistryClient", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The flow registry client id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/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. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /controller" : [ ] - } ] - }, - "put" : { - "tags" : [ "controller" ], - "summary" : "Updates a flow registry client", - "description" : "", - "operationId" : "updateFlowRegistryClient", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The flow registry client id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The flow registry client configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/FlowRegistryClientEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/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. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /controller" : [ ] - } ] - }, - "delete" : { - "tags" : [ "controller" ], - "summary" : "Deletes a flow registry client", - "description" : "", - "operationId" : "deleteFlowRegistryClient", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The revision is used to verify the client is working with the latest version of the flow.", - "required" : false, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The flow registry client id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/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. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /controller" : [ ] - } ] - } - }, - "/controller/registry-clients/{id}/descriptors" : { - "get" : { - "tags" : [ "controller" ], - "summary" : "Gets a flow registry client property descriptor", - "description" : "", - "operationId" : "getPropertyDescriptor", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The flow registry client id.", - "required" : true, - "type" : "string" - }, { - "name" : "propertyName", - "in" : "query", - "description" : "The property name.", - "required" : true, - "type" : "string" - }, { - "name" : "sensitive", - "in" : "query", - "description" : "Property Descriptor requested sensitive status", - "required" : false, - "type" : "boolean", - "default" : false - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/PropertyDescriptorEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /controller/registry-clients/{uuid}" : [ ] - } ] - } - }, - "/controller/registry-types" : { - "get" : { - "tags" : [ "controller" ], - "summary" : "Retrieves the types of flow that this NiFi supports", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getRegistryClientTypes", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/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. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/controller/reporting-tasks" : { - "post" : { - "tags" : [ "controller" ], - "summary" : "Creates a new reporting task", - "description" : "", - "operationId" : "createReportingTask", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The reporting task configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ReportingTaskEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ReportingTaskEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /controller" : [ ] - }, { - "Read - any referenced Controller Services - /controller-services/{uuid}" : [ ] - }, { - "Write - if the Reporting Task is restricted - /restricted-components" : [ ] - } ] - } - }, - "/controller/status/history" : { - "get" : { - "tags" : [ "controller" ], - "summary" : "Gets status history for the node", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getNodeStatusHistory", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ComponentHistoryEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /controller" : [ ] - } ] - } - }, - "/counters" : { - "get" : { - "tags" : [ "counters" ], - "summary" : "Gets the current counters for this NiFi", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getCounters", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "nodewise", - "in" : "query", - "description" : "Whether or not to include the breakdown per node. Optional, defaults to false", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "clusterNodeId", - "in" : "query", - "description" : "The id of the node where to get the status.", - "required" : false, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/CountersEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /counters" : [ ] - } ] - } - }, - "/counters/{id}" : { - "put" : { - "tags" : [ "counters" ], - "summary" : "Updates the specified counter. This will reset the counter value to 0", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "updateCounter", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The id of the counter.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/CounterEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /counters" : [ ] - } ] - } - }, - "/data-transfer/input-ports/{portId}/transactions/{transactionId}" : { - "put" : { - "tags" : [ "data-transfer" ], - "summary" : "Extend transaction TTL", - "description" : "", - "operationId" : "extendInputPortTransactionTTL", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "portId", - "in" : "path", - "required" : true, - "type" : "string" - }, { - "name" : "transactionId", - "in" : "path", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/TransactionResultEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /data-transfer/input-ports/{uuid}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "data-transfer" ], - "summary" : "Commit or cancel the specified transaction", - "description" : "", - "operationId" : "commitInputPortTransaction", - "consumes" : [ "application/octet-stream" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "responseCode", - "in" : "query", - "description" : "The response code. Available values are BAD_CHECKSUM(19), CONFIRM_TRANSACTION(12) or CANCEL_TRANSACTION(15).", - "required" : true, - "type" : "integer", - "format" : "int32" - }, { - "name" : "portId", - "in" : "path", - "description" : "The input port id.", - "required" : true, - "type" : "string" - }, { - "name" : "transactionId", - "in" : "path", - "description" : "The transaction id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/TransactionResultEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - }, - "503" : { - "description" : "NiFi instance is not ready for serving request, or temporarily overloaded. Retrying the same request later may be successful" - } - }, - "security" : [ { - "Write - /data-transfer/input-ports/{uuid}" : [ ] - } ] - } - }, - "/data-transfer/input-ports/{portId}/transactions/{transactionId}/flow-files" : { - "post" : { - "tags" : [ "data-transfer" ], - "summary" : "Transfer flow files to the input port", - "description" : "", - "operationId" : "receiveFlowFiles", - "consumes" : [ "application/octet-stream" ], - "produces" : [ "text/plain" ], - "parameters" : [ { - "name" : "portId", - "in" : "path", - "description" : "The input port id.", - "required" : true, - "type" : "string" - }, { - "name" : "transactionId", - "in" : "path", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - }, - "503" : { - "description" : "NiFi instance is not ready for serving request, or temporarily overloaded. Retrying the same request later may be successful" - } - }, - "security" : [ { - "Write - /data-transfer/input-ports/{uuid}" : [ ] - } ] - } - }, - "/data-transfer/output-ports/{portId}/transactions/{transactionId}" : { - "put" : { - "tags" : [ "data-transfer" ], - "summary" : "Extend transaction TTL", - "description" : "", - "operationId" : "extendOutputPortTransactionTTL", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "portId", - "in" : "path", - "required" : true, - "type" : "string" - }, { - "name" : "transactionId", - "in" : "path", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/TransactionResultEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - }, - "503" : { - "description" : "NiFi instance is not ready for serving request, or temporarily overloaded. Retrying the same request later may be successful" - } - }, - "security" : [ { - "Write - /data-transfer/output-ports/{uuid}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "data-transfer" ], - "summary" : "Commit or cancel the specified transaction", - "description" : "", - "operationId" : "commitOutputPortTransaction", - "consumes" : [ "application/octet-stream" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "responseCode", - "in" : "query", - "description" : "The response code. Available values are CONFIRM_TRANSACTION(12) or CANCEL_TRANSACTION(15).", - "required" : true, - "type" : "integer", - "format" : "int32" - }, { - "name" : "checksum", - "in" : "query", - "description" : "A checksum calculated at client side using CRC32 to check flow file content integrity. It must match with the value calculated at server side.", - "required" : true, - "type" : "string" - }, { - "name" : "portId", - "in" : "path", - "description" : "The output port id.", - "required" : true, - "type" : "string" - }, { - "name" : "transactionId", - "in" : "path", - "description" : "The transaction id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/TransactionResultEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - }, - "503" : { - "description" : "NiFi instance is not ready for serving request, or temporarily overloaded. Retrying the same request later may be successful" - } - }, - "security" : [ { - "Write - /data-transfer/output-ports/{uuid}" : [ ] - } ] - } - }, - "/data-transfer/output-ports/{portId}/transactions/{transactionId}/flow-files" : { - "get" : { - "tags" : [ "data-transfer" ], - "summary" : "Transfer flow files from the output port", - "description" : "", - "operationId" : "transferFlowFiles", - "consumes" : [ "*/*" ], - "produces" : [ "application/octet-stream" ], - "parameters" : [ { - "name" : "portId", - "in" : "path", - "description" : "The output port id.", - "required" : true, - "type" : "string" - }, { - "name" : "transactionId", - "in" : "path", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "There is no flow file to return.", - "schema" : { - "$ref" : "#/definitions/StreamingOutput" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - }, - "503" : { - "description" : "NiFi instance is not ready for serving request, or temporarily overloaded. Retrying the same request later may be successful" - } - }, - "security" : [ { - "Write - /data-transfer/output-ports/{uuid}" : [ ] - } ] - } - }, - "/data-transfer/{portType}/{portId}/transactions" : { - "post" : { - "tags" : [ "data-transfer" ], - "summary" : "Create a transaction to the specified output port or input port", - "description" : "", - "operationId" : "createPortTransaction", - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "portType", - "in" : "path", - "description" : "The port type.", - "required" : true, - "type" : "string", - "enum" : [ "input-ports", "output-ports" ] - }, { - "name" : "portId", - "in" : "path", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/TransactionResultEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - }, - "503" : { - "description" : "NiFi instance is not ready for serving request, or temporarily overloaded. Retrying the same request later may be successful" - } - }, - "security" : [ { - "Write - /data-transfer/{component-type}/{uuid}" : [ ] - } ] - } - }, - "/flow/about" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Retrieves details about this NiFi to put in the About dialog", - "description" : "", - "operationId" : "getAboutInfo", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/AboutEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/banners" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Retrieves the banners for this NiFi", - "description" : "", - "operationId" : "getBanners", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/BannerEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/bulletin-board" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets current bulletins", - "description" : "", - "operationId" : "getBulletinBoard", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "after", - "in" : "query", - "description" : "Includes bulletins with an id after this value.", - "required" : false, - "type" : "string" - }, { - "name" : "sourceName", - "in" : "query", - "description" : "Includes bulletins originating from this sources whose name match this regular expression.", - "required" : false, - "type" : "string" - }, { - "name" : "message", - "in" : "query", - "description" : "Includes bulletins whose message that match this regular expression.", - "required" : false, - "type" : "string" - }, { - "name" : "sourceId", - "in" : "query", - "description" : "Includes bulletins originating from this sources whose id match this regular expression.", - "required" : false, - "type" : "string" - }, { - "name" : "groupId", - "in" : "query", - "description" : "Includes bulletins originating from this sources whose group id match this regular expression.", - "required" : false, - "type" : "string" - }, { - "name" : "limit", - "in" : "query", - "description" : "The number of bulletins to limit the response to.", - "required" : false, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/BulletinBoardEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - }, { - "Read - /{component-type}/{uuid} - For component specific bulletins" : [ ] - } ] - } - }, - "/flow/client-id" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Generates a client id.", - "description" : "", - "operationId" : "generateClientId", - "consumes" : [ "*/*" ], - "produces" : [ "text/plain" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/cluster/search-results" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Searches the cluster for a node with the specified address", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "searchCluster", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "q", - "in" : "query", - "description" : "Node address to search for.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ClusterSearchResultsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/cluster/summary" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "The cluster summary for this NiFi", - "description" : "", - "operationId" : "getClusterSummary", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ClusteSummaryEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/config" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Retrieves the configuration for this NiFi flow", - "description" : "", - "operationId" : "getFlowConfig", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/FlowConfigurationEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/connections/{id}/statistics" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets statistics for a connection", - "description" : "", - "operationId" : "getConnectionStatistics", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "nodewise", - "in" : "query", - "description" : "Whether or not to include the breakdown per node. Optional, defaults to false", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "clusterNodeId", - "in" : "query", - "description" : "The id of the node where to get the statistics.", - "required" : false, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The connection id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ConnectionStatisticsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/connections/{id}/status" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets status for a connection", - "description" : "", - "operationId" : "getConnectionStatus", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "nodewise", - "in" : "query", - "description" : "Whether or not to include the breakdown per node. Optional, defaults to false", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "clusterNodeId", - "in" : "query", - "description" : "The id of the node where to get the status.", - "required" : false, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The connection id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ConnectionStatusEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/connections/{id}/status/history" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets the status history for a connection", - "description" : "", - "operationId" : "getConnectionStatusHistory", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The connection id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/StatusHistoryEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/controller-service-types" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Retrieves the types of controller services that this NiFi supports", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getControllerServiceTypes", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "serviceType", - "in" : "query", - "description" : "If specified, will only return controller services that are compatible with this type of service.", - "required" : false, - "type" : "string" - }, { - "name" : "serviceBundleGroup", - "in" : "query", - "description" : "If serviceType specified, is the bundle group of the serviceType.", - "required" : false, - "type" : "string" - }, { - "name" : "serviceBundleArtifact", - "in" : "query", - "description" : "If serviceType specified, is the bundle artifact of the serviceType.", - "required" : false, - "type" : "string" - }, { - "name" : "serviceBundleVersion", - "in" : "query", - "description" : "If serviceType specified, is the bundle version of the serviceType.", - "required" : false, - "type" : "string" - }, { - "name" : "bundleGroupFilter", - "in" : "query", - "description" : "If specified, will only return types that are a member of this bundle group.", - "required" : false, - "type" : "string" - }, { - "name" : "bundleArtifactFilter", - "in" : "query", - "description" : "If specified, will only return types that are a member of this bundle artifact.", - "required" : false, - "type" : "string" - }, { - "name" : "typeFilter", - "in" : "query", - "description" : "If specified, will only return types whose fully qualified classname matches.", - "required" : false, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ControllerServiceTypesEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/controller/bulletins" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Retrieves Controller level bulletins", - "description" : "", - "operationId" : "getBulletins", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ControllerBulletinsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - }, { - "Read - /controller - For controller bulletins" : [ ] - }, { - "Read - /controller-services/{uuid} - For controller service bulletins" : [ ] - }, { - "Read - /reporting-tasks/{uuid} - For reporting task bulletins" : [ ] - } ] - } - }, - "/flow/controller/controller-services" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets controller services for reporting tasks", - "description" : "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", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "uiOnly", - "in" : "query", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "includeReferencingComponents", - "in" : "query", - "description" : "Whether or not to include services' referencing components in the response", - "required" : false, - "type" : "boolean", - "default" : true - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ControllerServicesEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/current-user" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Retrieves the user identity of the user making the request", - "description" : "", - "operationId" : "getCurrentUser", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/CurrentUserEntity" - } - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/history" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets configuration history", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "queryHistory", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "offset", - "in" : "query", - "description" : "The offset into the result set.", - "required" : true, - "type" : "string" - }, { - "name" : "count", - "in" : "query", - "description" : "The number of actions to return.", - "required" : true, - "type" : "string" - }, { - "name" : "sortColumn", - "in" : "query", - "description" : "The field to sort on.", - "required" : false, - "type" : "string" - }, { - "name" : "sortOrder", - "in" : "query", - "description" : "The direction to sort.", - "required" : false, - "type" : "string" - }, { - "name" : "startDate", - "in" : "query", - "description" : "Include actions after this date.", - "required" : false, - "type" : "string" - }, { - "name" : "endDate", - "in" : "query", - "description" : "Include actions before this date.", - "required" : false, - "type" : "string" - }, { - "name" : "userIdentity", - "in" : "query", - "description" : "Include actions performed by this user.", - "required" : false, - "type" : "string" - }, { - "name" : "sourceId", - "in" : "query", - "description" : "Include actions on this component.", - "required" : false, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/HistoryEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/history/components/{componentId}" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets configuration history for a component", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getComponentHistory", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "componentId", - "in" : "path", - "description" : "The component id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ComponentHistoryEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - }, { - "Read underlying component - /{component-type}/{uuid}" : [ ] - } ] - } - }, - "/flow/history/{id}" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets an action", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getAction", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The action id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ActionEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/input-ports/{id}/status" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets status for an input port", - "description" : "", - "operationId" : "getInputPortStatus", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "nodewise", - "in" : "query", - "description" : "Whether or not to include the breakdown per node. Optional, defaults to false", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "clusterNodeId", - "in" : "query", - "description" : "The id of the node where to get the status.", - "required" : false, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The input port id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/PortStatusEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/metrics/{producer}" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets all metrics for the flow from a particular node", - "description" : "", - "operationId" : "getFlowMetrics", - "consumes" : [ "*/*" ], - "produces" : [ "*/*" ], - "parameters" : [ { - "name" : "producer", - "in" : "path", - "description" : "The producer for flow file metrics. Each producer may have its own output format.", - "required" : true, - "type" : "string", - "enum" : [ "prometheus" ] - }, { - "name" : "includedRegistries", - "in" : "query", - "description" : "Set of included metrics registries", - "required" : false, - "type" : "array", - "items" : { - "type" : "string", - "enum" : [ "NIFI", "JVM", "BULLETIN", "CONNECTION" ] - }, - "collectionFormat" : "multi" - }, { - "name" : "sampleName", - "in" : "query", - "description" : "Regular Expression Pattern to be applied against the sample name field", - "required" : false, - "type" : "string" - }, { - "name" : "sampleLabelValue", - "in" : "query", - "description" : "Regular Expression Pattern to be applied against the sample label value field", - "required" : false, - "type" : "string" - }, { - "name" : "rootFieldName", - "in" : "query", - "description" : "Name of the first field of JSON object. Applicable for JSON producer only.", - "required" : false, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/StreamingOutput" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/output-ports/{id}/status" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets status for an output port", - "description" : "", - "operationId" : "getOutputPortStatus", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "nodewise", - "in" : "query", - "description" : "Whether or not to include the breakdown per node. Optional, defaults to false", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "clusterNodeId", - "in" : "query", - "description" : "The id of the node where to get the status.", - "required" : false, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The output port id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/PortStatusEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/parameter-contexts" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets all Parameter Contexts", - "description" : "", - "operationId" : "getParameterContexts", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ParameterContextsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /parameter-contexts/{id} for each Parameter Context" : [ ] - } ] - } - }, - "/flow/parameter-provider-types" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Retrieves the types of parameter providers that this NiFi supports", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getParameterProviderTypes", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bundleGroupFilter", - "in" : "query", - "description" : "If specified, will only return types that are a member of this bundle group.", - "required" : false, - "type" : "string" - }, { - "name" : "bundleArtifactFilter", - "in" : "query", - "description" : "If specified, will only return types that are a member of this bundle artifact.", - "required" : false, - "type" : "string" - }, { - "name" : "type", - "in" : "query", - "description" : "If specified, will only return types whose fully qualified classname matches.", - "required" : false, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/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. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/parameter-providers" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets all parameter providers", - "description" : "", - "operationId" : "getParameterProviders", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/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. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/prioritizers" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Retrieves the types of prioritizers that this NiFi supports", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getPrioritizers", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/PrioritizerTypesEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/process-groups/{id}" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets a process group", - "description" : "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", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "name" : "uiOnly", - "in" : "query", - "required" : false, - "type" : "boolean", - "default" : false - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessGroupFlowEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - }, - "put" : { - "tags" : [ "flow" ], - "summary" : "Schedule or unschedule components in the specified Process Group.", - "description" : "", - "operationId" : "scheduleComponents", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The request to schedule or unschedule. If the comopnents in the request are not specified, all authorized components will be considered.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ScheduleComponentsEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ScheduleComponentsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - }, { - "Write - /{component-type}/{uuid} or /operation/{component-type}/{uuid} - For every component being scheduled/unscheduled" : [ ] - } ] - } - }, - "/flow/process-groups/{id}/controller-services" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets all controller services", - "description" : "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", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "name" : "includeAncestorGroups", - "in" : "query", - "description" : "Whether or not to include parent/ancestor process groups", - "required" : false, - "type" : "boolean", - "default" : true - }, { - "name" : "includeDescendantGroups", - "in" : "query", - "description" : "Whether or not to include descendant process groups", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "includeReferencingComponents", - "in" : "query", - "description" : "Whether or not to include services' referencing components in the response", - "required" : false, - "type" : "boolean", - "default" : true - }, { - "name" : "uiOnly", - "in" : "query", - "required" : false, - "type" : "boolean", - "default" : false - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ControllerServicesEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - }, - "put" : { - "tags" : [ "flow" ], - "summary" : "Enable or disable Controller Services in the specified Process Group.", - "description" : "", - "operationId" : "activateControllerServices", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The request to schedule or unschedule. If the comopnents in the request are not specified, all authorized components will be considered.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ActivateControllerServicesEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ActivateControllerServicesEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - }, { - "Write - /{component-type}/{uuid} or /operation/{component-type}/{uuid} - For every service being enabled/disabled" : [ ] - } ] - } - }, - "/flow/process-groups/{id}/status" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets the status for a process group", - "description" : "The status for a process group includes status for all descendent components. When invoked on the root group with recursive set to true, it will return the current status of every component in the flow.", - "operationId" : "getProcessGroupStatus", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "recursive", - "in" : "query", - "description" : "Whether all descendant groups and the status of their content will be included. Optional, defaults to false", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "nodewise", - "in" : "query", - "description" : "Whether or not to include the breakdown per node. Optional, defaults to false", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "clusterNodeId", - "in" : "query", - "description" : "The id of the node where to get the status.", - "required" : false, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessGroupStatusEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/process-groups/{id}/status/history" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets status history for a remote process group", - "description" : "", - "operationId" : "getProcessGroupStatusHistory", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/StatusHistoryEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/processor-types" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Retrieves the types of processors that this NiFi supports", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getProcessorTypes", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bundleGroupFilter", - "in" : "query", - "description" : "If specified, will only return types that are a member of this bundle group.", - "required" : false, - "type" : "string" - }, { - "name" : "bundleArtifactFilter", - "in" : "query", - "description" : "If specified, will only return types that are a member of this bundle artifact.", - "required" : false, - "type" : "string" - }, { - "name" : "type", - "in" : "query", - "description" : "If specified, will only return types whose fully qualified classname matches.", - "required" : false, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessorTypesEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/processors/{id}/status" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets status for a processor", - "description" : "", - "operationId" : "getProcessorStatus", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "nodewise", - "in" : "query", - "description" : "Whether or not to include the breakdown per node. Optional, defaults to false", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "clusterNodeId", - "in" : "query", - "description" : "The id of the node where to get the status.", - "required" : false, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The processor id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessorStatusEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/processors/{id}/status/history" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets status history for a processor", - "description" : "", - "operationId" : "getProcessorStatusHistory", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The processor id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/StatusHistoryEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/registries" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets the listing of available flow registry clients", - "description" : "", - "operationId" : "getRegistryClients", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/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. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/registries/{id}/buckets" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets the buckets from the specified registry for the current user", - "description" : "", - "operationId" : "getBuckets", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The registry id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/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. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/registries/{registry-id}/buckets/{bucket-id}/flows" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets the flows from the specified registry and bucket for the current user", - "description" : "", - "operationId" : "getFlows", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "registry-id", - "in" : "path", - "description" : "The registry client id.", - "required" : true, - "type" : "string" - }, { - "name" : "bucket-id", - "in" : "path", - "description" : "The bucket id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlowsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/registries/{registry-id}/buckets/{bucket-id}/flows/{flow-id}/details" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets the details of a flow from the specified registry and bucket for the specified flow for the current user", - "description" : "", - "operationId" : "getDetails", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "registry-id", - "in" : "path", - "description" : "The registry client id.", - "required" : true, - "type" : "string" - }, { - "name" : "bucket-id", - "in" : "path", - "description" : "The bucket id.", - "required" : true, - "type" : "string" - }, { - "name" : "flow-id", - "in" : "path", - "description" : "The flow id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/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. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/registries/{registry-id}/buckets/{bucket-id}/flows/{flow-id}/versions" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets the flow versions from the specified registry and bucket for the specified flow for the current user", - "description" : "", - "operationId" : "getVersions", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "registry-id", - "in" : "path", - "description" : "The registry client id.", - "required" : true, - "type" : "string" - }, { - "name" : "bucket-id", - "in" : "path", - "description" : "The bucket id.", - "required" : true, - "type" : "string" - }, { - "name" : "flow-id", - "in" : "path", - "description" : "The flow id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlowSnapshotMetadataSetEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/registries/{registry-id}/buckets/{bucket-id}/flows/{flow-id}/{version-a}/diff/{version-b}" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets the differences between two versions of the same versioned flow, the basis of the comparison will be the first version", - "description" : "", - "operationId" : "getVersionDifferences", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "registry-id", - "in" : "path", - "description" : "The registry client id.", - "required" : true, - "type" : "string" - }, { - "name" : "bucket-id", - "in" : "path", - "description" : "The bucket id.", - "required" : true, - "type" : "string" - }, { - "name" : "flow-id", - "in" : "path", - "description" : "The flow id.", - "required" : true, - "type" : "string" - }, { - "name" : "version-a", - "in" : "path", - "description" : "The base version.", - "required" : true, - "type" : "integer", - "format" : "int32" - }, { - "name" : "version-b", - "in" : "path", - "description" : "The compared version.", - "required" : true, - "type" : "integer", - "format" : "int32" - }, { - "name" : "offset", - "in" : "query", - "description" : "Must be a non-negative number. Specifies the starting point of the listing. 0 means start from the beginning.", - "required" : false, - "type" : "integer", - "default" : 0, - "format" : "int32" - }, { - "name" : "limit", - "in" : "query", - "description" : "Limits the number of differences listed. This might lead to partial result. 0 means no limitation is applied.", - "required" : false, - "type" : "integer", - "default" : 1000, - "format" : "int32" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/FlowComparisonEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/remote-process-groups/{id}/status" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets status for a remote process group", - "description" : "", - "operationId" : "getRemoteProcessGroupStatus", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "nodewise", - "in" : "query", - "description" : "Whether or not to include the breakdown per node. Optional, defaults to false", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "clusterNodeId", - "in" : "query", - "description" : "The id of the node where to get the status.", - "required" : false, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The remote process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/RemoteProcessGroupStatusEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/remote-process-groups/{id}/status/history" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets the status history", - "description" : "", - "operationId" : "getRemoteProcessGroupStatusHistory", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The remote process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/StatusHistoryEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/reporting-task-types" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Retrieves the types of reporting tasks that this NiFi supports", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getReportingTaskTypes", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bundleGroupFilter", - "in" : "query", - "description" : "If specified, will only return types that are a member of this bundle group.", - "required" : false, - "type" : "string" - }, { - "name" : "bundleArtifactFilter", - "in" : "query", - "description" : "If specified, will only return types that are a member of this bundle artifact.", - "required" : false, - "type" : "string" - }, { - "name" : "type", - "in" : "query", - "description" : "If specified, will only return types whose fully qualified classname matches.", - "required" : false, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ReportingTaskTypesEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/reporting-tasks" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets all reporting tasks", - "description" : "", - "operationId" : "getReportingTasks", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ReportingTasksEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/reporting-tasks/download" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Download a snapshot of the given reporting tasks and any controller services they use", - "description" : "", - "operationId" : "downloadReportingTaskSnapshot", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "reportingTaskId", - "in" : "query", - "description" : "Specifies a reporting task id to export. If not specified, all reporting tasks will be exported.", - "required" : false, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "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. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/reporting-tasks/snapshot" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Get a snapshot of the given reporting tasks and any controller services they use", - "description" : "", - "operationId" : "getReportingTaskSnapshot", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "reportingTaskId", - "in" : "query", - "description" : "Specifies a reporting task id to export. If not specified, all reporting tasks will be exported.", - "required" : false, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/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. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/runtime-manifest" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Retrieves the runtime manifest for this NiFi instance.", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getRuntimeManifest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/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. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/search-results" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Performs a search against this NiFi using the specified search term", - "description" : "Only search results from authorized components will be returned.", - "operationId" : "searchFlow", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "q", - "in" : "query", - "required" : false, - "type" : "string" - }, { - "name" : "a", - "in" : "query", - "required" : false, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/SearchResultsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/status" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets the current status of this NiFi", - "description" : "", - "operationId" : "getControllerStatus", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ControllerStatusEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/templates" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets all templates", - "description" : "", - "operationId" : "getTemplates", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/TemplatesEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flowfile-queues/{id}/drop-requests" : { - "post" : { - "tags" : [ "flowfile-queues" ], - "summary" : "Creates a request to drop the contents of the queue in this connection.", - "description" : "", - "operationId" : "createDropRequest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The connection id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/DropRequestEntity" - } - }, - "202" : { - "description" : "The request has been accepted. A HTTP response header will contain the URI where the response can be polled." - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write Source Data - /data/{component-type}/{uuid}" : [ ] - } ] - } - }, - "/flowfile-queues/{id}/drop-requests/{drop-request-id}" : { - "get" : { - "tags" : [ "flowfile-queues" ], - "summary" : "Gets the current status of a drop request for the specified connection.", - "description" : "", - "operationId" : "getDropRequest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The connection id.", - "required" : true, - "type" : "string" - }, { - "name" : "drop-request-id", - "in" : "path", - "description" : "The drop request id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/DropRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write Source Data - /data/{component-type}/{uuid}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "flowfile-queues" ], - "summary" : "Cancels and/or removes a request to drop the contents of this connection.", - "description" : "", - "operationId" : "removeDropRequest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The connection id.", - "required" : true, - "type" : "string" - }, { - "name" : "drop-request-id", - "in" : "path", - "description" : "The drop request id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/DropRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write Source Data - /data/{component-type}/{uuid}" : [ ] - } ] - } - }, - "/flowfile-queues/{id}/flowfiles/{flowfile-uuid}" : { - "get" : { - "tags" : [ "flowfile-queues" ], - "summary" : "Gets a FlowFile from a Connection.", - "description" : "", - "operationId" : "getFlowFile", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The connection id.", - "required" : true, - "type" : "string" - }, { - "name" : "flowfile-uuid", - "in" : "path", - "description" : "The flowfile uuid.", - "required" : true, - "type" : "string" - }, { - "name" : "clusterNodeId", - "in" : "query", - "description" : "The id of the node where the content exists if clustered.", - "required" : false, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/FlowFileEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read Source Data - /data/{component-type}/{uuid}" : [ ] - } ] - } - }, - "/flowfile-queues/{id}/flowfiles/{flowfile-uuid}/content" : { - "get" : { - "tags" : [ "flowfile-queues" ], - "summary" : "Gets the content for a FlowFile in a Connection.", - "description" : "", - "operationId" : "downloadFlowFileContent", - "consumes" : [ "*/*" ], - "produces" : [ "*/*" ], - "parameters" : [ { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The connection id.", - "required" : true, - "type" : "string" - }, { - "name" : "flowfile-uuid", - "in" : "path", - "description" : "The flowfile uuid.", - "required" : true, - "type" : "string" - }, { - "name" : "clusterNodeId", - "in" : "query", - "description" : "The id of the node where the content exists if clustered.", - "required" : false, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/StreamingOutput" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read Source Data - /data/{component-type}/{uuid}" : [ ] - } ] - } - }, - "/flowfile-queues/{id}/listing-requests" : { - "post" : { - "tags" : [ "flowfile-queues" ], - "summary" : "Lists the contents of the queue in this connection.", - "description" : "", - "operationId" : "createFlowFileListing", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The connection id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ListingRequestEntity" - } - }, - "202" : { - "description" : "The request has been accepted. A HTTP response header will contain the URI where the response can be polled." - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read Source Data - /data/{component-type}/{uuid}" : [ ] - } ] - } - }, - "/flowfile-queues/{id}/listing-requests/{listing-request-id}" : { - "get" : { - "tags" : [ "flowfile-queues" ], - "summary" : "Gets the current status of a listing request for the specified connection.", - "description" : "", - "operationId" : "getListingRequest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The connection id.", - "required" : true, - "type" : "string" - }, { - "name" : "listing-request-id", - "in" : "path", - "description" : "The listing request id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ListingRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read Source Data - /data/{component-type}/{uuid}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "flowfile-queues" ], - "summary" : "Cancels and/or removes a request to list the contents of this connection.", - "description" : "", - "operationId" : "deleteListingRequest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The connection id.", - "required" : true, - "type" : "string" - }, { - "name" : "listing-request-id", - "in" : "path", - "description" : "The listing request id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ListingRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read Source Data - /data/{component-type}/{uuid}" : [ ] - } ] - } - }, - "/funnels/{id}" : { - "get" : { - "tags" : [ "funnel" ], - "summary" : "Gets a funnel", - "description" : "", - "operationId" : "getFunnel", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The funnel id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/FunnelEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /funnels/{uuid}" : [ ] - } ] - }, - "put" : { - "tags" : [ "funnel" ], - "summary" : "Updates a funnel", - "description" : "", - "operationId" : "updateFunnel", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The funnel id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The funnel configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/FunnelEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/FunnelEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /funnels/{uuid}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "funnel" ], - "summary" : "Deletes a funnel", - "description" : "", - "operationId" : "removeFunnel", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The revision is used to verify the client is working with the latest version of the flow.", - "required" : false, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The funnel id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/FunnelEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /funnels/{uuid}" : [ ] - }, { - "Write - Parent Process Group - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/input-ports/{id}" : { - "get" : { - "tags" : [ "input-ports" ], - "summary" : "Gets an input port", - "description" : "", - "operationId" : "getInputPort", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The input port id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/PortEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /input-ports/{uuid}" : [ ] - } ] - }, - "put" : { - "tags" : [ "input-ports" ], - "summary" : "Updates an input port", - "description" : "", - "operationId" : "updateInputPort", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The input port id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The input port configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/PortEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/PortEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /input-ports/{uuid}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "input-ports" ], - "summary" : "Deletes an input port", - "description" : "", - "operationId" : "removeInputPort", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The revision is used to verify the client is working with the latest version of the flow.", - "required" : false, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The input port id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/PortEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /input-ports/{uuid}" : [ ] - }, { - "Write - Parent Process Group - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/input-ports/{id}/run-status" : { - "put" : { - "tags" : [ "input-ports" ], - "summary" : "Updates run status of an input-port", - "description" : "", - "operationId" : "updateRunStatus", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The port id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The port run status.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/PortRunStatusEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessorEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /input-ports/{uuid} or /operation/input-ports/{uuid}" : [ ] - } ] - } - }, - "/labels/{id}" : { - "get" : { - "tags" : [ "labels" ], - "summary" : "Gets a label", - "description" : "", - "operationId" : "getLabel", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The label id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/LabelEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /labels/{uuid}" : [ ] - } ] - }, - "put" : { - "tags" : [ "labels" ], - "summary" : "Updates a label", - "description" : "", - "operationId" : "updateLabel", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The label id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The label configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/LabelEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/LabelEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /labels/{uuid}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "labels" ], - "summary" : "Deletes a label", - "description" : "", - "operationId" : "removeLabel", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The revision is used to verify the client is working with the latest version of the flow.", - "required" : false, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The label id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/LabelEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /labels/{uuid}" : [ ] - }, { - "Write - Parent Process Group - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/output-ports/{id}" : { - "get" : { - "tags" : [ "output-ports" ], - "summary" : "Gets an output port", - "description" : "", - "operationId" : "getOutputPort", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The output port id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/PortEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /output-ports/{uuid}" : [ ] - } ] - }, - "put" : { - "tags" : [ "output-ports" ], - "summary" : "Updates an output port", - "description" : "", - "operationId" : "updateOutputPort", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The output port id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The output port configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/PortEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/PortEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /output-ports/{uuid}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "output-ports" ], - "summary" : "Deletes an output port", - "description" : "", - "operationId" : "removeOutputPort", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The revision is used to verify the client is working with the latest version of the flow.", - "required" : false, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The output port id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/PortEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /output-ports/{uuid}" : [ ] - }, { - "Write - Parent Process Group - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/output-ports/{id}/run-status" : { - "put" : { - "tags" : [ "output-ports" ], - "summary" : "Updates run status of an output-port", - "description" : "", - "operationId" : "updateRunStatus", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The port id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The port run status.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/PortRunStatusEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessorEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /output-ports/{uuid} or /operation/output-ports/{uuid}" : [ ] - } ] - } - }, - "/parameter-contexts" : { - "post" : { - "tags" : [ "parameter-contexts" ], - "summary" : "Create a Parameter Context", - "description" : "", - "operationId" : "createParameterContext", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The Parameter Context.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ParameterContextEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ParameterContextEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /parameter-contexts" : [ ] - }, { - "Read - for every inherited parameter context" : [ ] - } ] - } - }, - "/parameter-contexts/{contextId}/update-requests" : { - "post" : { - "tags" : [ "parameter-contexts" ], - "summary" : "Initiate the Update Request of a Parameter Context", - "description" : "This will initiate the process of updating a Parameter Context. Changing the value of a Parameter may require that one or more components be stopped and restarted, so this 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", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "contextId", - "in" : "path", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The updated version of the parameter context.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ParameterContextEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ParameterContextUpdateRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /parameter-contexts/{parameterContextId}" : [ ] - }, { - "Write - /parameter-contexts/{parameterContextId}" : [ ] - }, { - "Read - for every component that is affected by the update" : [ ] - }, { - "Write - for every component that is affected by the update" : [ ] - }, { - "Read - for every currently inherited parameter context" : [ ] - }, { - "Read - for any new inherited parameter context" : [ ] - } ] - } - }, - "/parameter-contexts/{contextId}/update-requests/{requestId}" : { - "get" : { - "tags" : [ "parameter-contexts" ], - "summary" : "Returns the Update Request with the given ID", - "description" : "Returns the Update Request with the given ID. Once an Update Request has been created by performing a POST to /nifi-api/parameter-contexts, that request can subsequently be retrieved via this endpoint, and the request that is fetched will contain the updated state, such as percent complete, the current state of the request, and any failures. ", - "operationId" : "getParameterContextUpdate", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "contextId", - "in" : "path", - "description" : "The ID of the Parameter Context", - "required" : true, - "type" : "string" - }, { - "name" : "requestId", - "in" : "path", - "description" : "The ID of the Update Request", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ParameterContextUpdateRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Only the user that submitted the request can get it" : [ ] - } ] - }, - "delete" : { - "tags" : [ "parameter-contexts" ], - "summary" : "Deletes the Update Request with the given ID", - "description" : "Deletes the Update Request with the given ID. After a request is created via a POST to /nifi-api/parameter-contexts/update-requests, it is expected that the client will properly clean up the request by DELETE'ing it, once the Update process has completed. If the request is deleted before the request completes, then the Update request will finish the step that it is currently performing and then will cancel any subsequent steps.", - "operationId" : "deleteUpdateRequest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "contextId", - "in" : "path", - "description" : "The ID of the ParameterContext", - "required" : true, - "type" : "string" - }, { - "name" : "requestId", - "in" : "path", - "description" : "The ID of the Update Request", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ParameterContextUpdateRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Only the user that submitted the request can remove it" : [ ] - } ] - } - }, - "/parameter-contexts/{contextId}/validation-requests" : { - "post" : { - "tags" : [ "parameter-contexts" ], - "summary" : "Initiate a Validation Request to determine how the validity of components will change if a Parameter Context were to be updated", - "description" : "This will initiate the process of validating all components whose Process Group is bound to the specified Parameter Context. Performing validation against an arbitrary number of components may be expect and take significantly more time than many other REST API actions. As a result, this endpoint will immediately return a ParameterContextValidationRequestEntity, and the process of validating the necessary components will occur asynchronously in the background. The client may then periodically poll the status of the request by issuing a GET request to /parameter-contexts/validation-requests/{requestId}. Once the request is completed, the client is expected to issue a DELETE request to /parameter-contexts/validation-requests/{requestId}.", - "operationId" : "submitValidationRequest", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "contextId", - "in" : "path", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The validation request", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ParameterContextValidationRequestEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ParameterContextValidationRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /parameter-contexts/{parameterContextId}" : [ ] - } ] - } - }, - "/parameter-contexts/{contextId}/validation-requests/{id}" : { - "get" : { - "tags" : [ "parameter-contexts" ], - "summary" : "Returns the Validation Request with the given ID", - "description" : "Returns the Validation Request with the given ID. Once a Validation Request has been created by performing a POST to /nifi-api/validation-contexts, that request can subsequently be retrieved via this endpoint, and the request that is fetched will contain the updated state, such as percent complete, the current state of the request, and any failures. ", - "operationId" : "getValidationRequest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "contextId", - "in" : "path", - "description" : "The ID of the Parameter Context", - "required" : true, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The ID of the Validation Request", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ParameterContextValidationRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Only the user that submitted the request can get it" : [ ] - } ] - }, - "delete" : { - "tags" : [ "parameter-contexts" ], - "summary" : "Deletes the Validation Request with the given ID", - "description" : "Deletes the Validation Request with the given ID. After a request is created via a POST to /nifi-api/validation-contexts, it is expected that the client will properly clean up the request by DELETE'ing it, once the validation process has completed. If the request is deleted before the request completes, then the Validation request will finish the step that it is currently performing and then will cancel any subsequent steps.", - "operationId" : "deleteValidationRequest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "contextId", - "in" : "path", - "description" : "The ID of the Parameter Context", - "required" : true, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The ID of the Update Request", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ParameterContextValidationRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Only the user that submitted the request can remove it" : [ ] - } ] - } - }, - "/parameter-contexts/{id}" : { - "get" : { - "tags" : [ "parameter-contexts" ], - "summary" : "Returns the Parameter Context with the given ID", - "description" : "Returns the Parameter Context with the given ID.", - "operationId" : "getParameterContext", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The ID of the Parameter Context", - "required" : true, - "type" : "string" - }, { - "name" : "includeInheritedParameters", - "in" : "query", - "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.", - "required" : false, - "type" : "boolean", - "default" : false - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ParameterContextEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /parameter-contexts/{id}" : [ ] - } ] - }, - "put" : { - "tags" : [ "parameter-contexts" ], - "summary" : "Modifies a Parameter Context", - "description" : "This endpoint will update a Parameter Context to match the provided entity. However, this request will fail if any component is running and is referencing a Parameter in the Parameter Context. Generally, this endpoint is not called directly. Instead, an update request should be submitted by making a POST to the /parameter-contexts/update-requests endpoint. That endpoint will, in turn, call this endpoint.", - "operationId" : "updateParameterContext", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The updated Parameter Context", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ParameterContextEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ParameterContextEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /parameter-contexts/{id}" : [ ] - }, { - "Write - /parameter-contexts/{id}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "parameter-contexts" ], - "summary" : "Deletes the Parameter Context with the given ID", - "description" : "Deletes the Parameter Context with the given ID.", - "operationId" : "deleteParameterContext", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The version is used to verify the client is working with the latest version of the flow.", - "required" : false, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, a new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The Parameter Context ID.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ParameterContextEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /parameter-contexts/{uuid}" : [ ] - }, { - "Write - /parameter-contexts/{uuid}" : [ ] - }, { - "Read - /process-groups/{uuid}, for any Process Group that is currently bound to the Parameter Context" : [ ] - }, { - "Write - /process-groups/{uuid}, for any Process Group that is currently bound to the Parameter Context" : [ ] - } ] - } - }, - "/parameter-providers/{id}" : { - "get" : { - "tags" : [ "parameter-providers" ], - "summary" : "Gets a parameter provider", - "description" : "", - "operationId" : "getParameterProvider", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The parameter provider id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/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. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /parameter-providers/{uuid}" : [ ] - } ] - }, - "put" : { - "tags" : [ "parameter-providers" ], - "summary" : "Updates a parameter provider", - "description" : "", - "operationId" : "updateParameterProvider", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The parameter provider id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The parameter provider configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ParameterProviderEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/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. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /parameter-providers/{uuid}" : [ ] - }, { - "Read - any referenced Controller Services if this request changes the reference - /controller-services/{uuid}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "parameter-providers" ], - "summary" : "Deletes a parameter provider", - "description" : "", - "operationId" : "removeParameterProvider", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The revision is used to verify the client is working with the latest version of the flow.", - "required" : false, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The parameter provider id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/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. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /parameter-providers/{uuid}" : [ ] - }, { - "Write - /controller" : [ ] - }, { - "Read - any referenced Controller Services - /controller-services/{uuid}" : [ ] - } ] - } - }, - "/parameter-providers/{id}/config/analysis" : { - "post" : { - "tags" : [ "parameter-providers" ], - "summary" : "Performs analysis of the component's configuration, providing information about which attributes are referenced.", - "description" : "", - "operationId" : "analyzeConfiguration", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The parameter provider id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The configuration analysis request.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ConfigurationAnalysisEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/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. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /parameter-providers/{uuid}" : [ ] - } ] - } - }, - "/parameter-providers/{id}/config/verification-requests" : { - "post" : { - "tags" : [ "parameter-providers" ], - "summary" : "Performs verification of the Parameter Provider's configuration", - "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", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The parameter provider id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The parameter provider configuration verification request.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/VerifyConfigRequestEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/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. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /parameter-providers/{uuid}" : [ ] - } ] - } - }, - "/parameter-providers/{id}/config/verification-requests/{requestId}" : { - "get" : { - "tags" : [ "parameter-providers" ], - "summary" : "Returns the Verification Request with the given ID", - "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", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The ID of the Parameter Provider", - "required" : true, - "type" : "string" - }, { - "name" : "requestId", - "in" : "path", - "description" : "The ID of the Verification Request", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/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. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Only the user that submitted the request can get it" : [ ] - } ] - }, - "delete" : { - "tags" : [ "parameter-providers" ], - "summary" : "Deletes the Verification Request with the given ID", - "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", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The ID of the Parameter Provider", - "required" : true, - "type" : "string" - }, { - "name" : "requestId", - "in" : "path", - "description" : "The ID of the Verification Request", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/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. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Only the user that submitted the request can remove it" : [ ] - } ] - } - }, - "/parameter-providers/{id}/descriptors" : { - "get" : { - "tags" : [ "parameter-providers" ], - "summary" : "Gets a parameter provider property descriptor", - "description" : "", - "operationId" : "getPropertyDescriptor", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The parameter provider id.", - "required" : true, - "type" : "string" - }, { - "name" : "propertyName", - "in" : "query", - "description" : "The property name.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/PropertyDescriptorEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /parameter-providers/{uuid}" : [ ] - } ] - } - }, - "/parameter-providers/{id}/parameters/fetch-requests" : { - "post" : { - "tags" : [ "parameter-providers" ], - "summary" : "Fetches and temporarily caches the parameters for a provider", - "description" : "", - "operationId" : "fetchParameters", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The parameter provider id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The parameter fetch request.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ParameterProviderParameterFetchEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/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. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /parameter-providers/{uuid} or or /operation/parameter-providers/{uuid}" : [ ] - } ] - } - }, - "/parameter-providers/{id}/references" : { - "get" : { - "tags" : [ "parameter-providers" ], - "summary" : "Gets all references to a parameter provider", - "description" : "", - "operationId" : "getParameterProviderReferences", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The parameter provider id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/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. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /parameter-providers/{uuid}" : [ ] - } ] - } - }, - "/parameter-providers/{id}/state" : { - "get" : { - "tags" : [ "parameter-providers" ], - "summary" : "Gets the state for a parameter provider", - "description" : "", - "operationId" : "getState", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The parameter provider id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ComponentStateEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /parameter-providers/{uuid}" : [ ] - } ] - } - }, - "/parameter-providers/{id}/state/clear-requests" : { - "post" : { - "tags" : [ "parameter-providers" ], - "summary" : "Clears the state for a parameter provider", - "description" : "", - "operationId" : "clearState", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The parameter provider id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ComponentStateEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /parameter-providers/{uuid}" : [ ] - } ] - } - }, - "/parameter-providers/{providerId}/apply-parameters-requests" : { - "post" : { - "tags" : [ "parameter-providers" ], - "summary" : "Initiate a request to apply the fetched parameters of a Parameter Provider", - "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", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "providerId", - "in" : "path", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The apply parameters request.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ParameterProviderParameterApplicationEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/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. Retrying the same request later may be successful." - } - }, - "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" : [ ] - } ] - } - }, - "/parameter-providers/{providerId}/apply-parameters-requests/{requestId}" : { - "get" : { - "tags" : [ "parameter-providers" ], - "summary" : "Returns the Apply Parameters Request with the given ID", - "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", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "providerId", - "in" : "path", - "description" : "The ID of the Parameter Provider", - "required" : true, - "type" : "string" - }, { - "name" : "requestId", - "in" : "path", - "description" : "The ID of the Apply Parameters Request", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/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. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Only the user that submitted the request can get it" : [ ] - } ] - }, - "delete" : { - "tags" : [ "parameter-providers" ], - "summary" : "Deletes the Apply Parameters Request with the given ID", - "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", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "providerId", - "in" : "path", - "description" : "The ID of the Parameter Provider", - "required" : true, - "type" : "string" - }, { - "name" : "requestId", - "in" : "path", - "description" : "The ID of the Apply Parameters Request", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/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. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Only the user that submitted the request can remove it" : [ ] - } ] - } - }, - "/policies" : { - "post" : { - "tags" : [ "policies" ], - "summary" : "Creates an access policy", - "description" : "", - "operationId" : "createAccessPolicy", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The access policy configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/AccessPolicyEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/AccessPolicyEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /policies/{resource}" : [ ] - } ] - } - }, - "/policies/{action}/{resource}" : { - "get" : { - "tags" : [ "policies" ], - "summary" : "Gets an access policy for the specified action and resource", - "description" : "Will return the effective policy if no component specific policy exists for the specified action and resource. Must have Read permissions to the policy with the desired action and resource. Permissions for the policy that is returned will be indicated in the response. This means the client could be authorized to get the policy for a given component but the effective policy may be inherited from an ancestor Process Group. If the client does not have permissions to that policy, the response will not include the policy and the permissions in the response will be marked accordingly. If the client does not have permissions to the policy of the desired action and resource a 403 response will be returned.", - "operationId" : "getAccessPolicyForResource", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "action", - "in" : "path", - "description" : "The request action.", - "required" : true, - "type" : "string", - "enum" : [ "read", "write" ] - }, { - "name" : "resource", - "in" : "path", - "description" : "The resource of the policy.", - "required" : true, - "type" : "string", - "pattern" : ".+" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/AccessPolicyEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /policies/{resource}" : [ ] - } ] - } - }, - "/policies/{id}" : { - "get" : { - "tags" : [ "policies" ], - "summary" : "Gets an access policy", - "description" : "", - "operationId" : "getAccessPolicy", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The access policy id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/AccessPolicyEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /policies/{resource}" : [ ] - } ] - }, - "put" : { - "tags" : [ "policies" ], - "summary" : "Updates a access policy", - "description" : "", - "operationId" : "updateAccessPolicy", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The access policy id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The access policy configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/AccessPolicyEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/AccessPolicyEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /policies/{resource}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "policies" ], - "summary" : "Deletes an access policy", - "description" : "", - "operationId" : "removeAccessPolicy", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The revision is used to verify the client is working with the latest version of the flow.", - "required" : false, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The access policy id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/AccessPolicyEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /policies/{resource}" : [ ] - }, { - "Write - Policy of the parent resource - /policies/{resource}" : [ ] - } ] - } - }, - "/process-groups/replace-requests/{id}" : { - "get" : { - "tags" : [ "process-groups" ], - "summary" : "Returns the Replace Request with the given ID", - "description" : "Returns the Replace Request with the given ID. Once a Replace Request has been created by performing a POST to /process-groups/{id}/replace-requests, that request can subsequently be retrieved via this endpoint, and the request that is fetched will contain the updated state, such as percent complete, the current state of the request, and any failures. Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getReplaceProcessGroupRequest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The ID of the Replace Request", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessGroupReplaceRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Only the user that submitted the request can get it" : [ ] - } ] - }, - "delete" : { - "tags" : [ "process-groups" ], - "summary" : "Deletes the Replace Request with the given ID", - "description" : "Deletes the Replace Request with the given ID. After a request is created via a POST to /process-groups/{id}/replace-requests, it is expected that the client will properly clean up the request by DELETE'ing it, once the Replace process has completed. If the request is deleted before the request completes, then the Replace request will finish the step that it is currently performing and then will cancel any subsequent steps. Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "deleteReplaceProcessGroupRequest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The ID of the Update Request", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessGroupReplaceRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Only the user that submitted the request can remove it" : [ ] - } ] - } - }, - "/process-groups/{groupId}/variable-registry/update-requests/{updateId}" : { - "get" : { - "tags" : [ "process-groups" ], - "summary" : "Gets a process group's variable registry", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getVariableRegistryUpdateRequest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "groupId", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "name" : "updateId", - "in" : "path", - "description" : "The ID of the Variable Registry Update Request", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VariableRegistryUpdateRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "process-groups" ], - "summary" : "Deletes an update request for a process group's variable registry. If the request is not yet complete, it will automatically be cancelled.", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "deleteVariableRegistryUpdateRequest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "groupId", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "name" : "updateId", - "in" : "path", - "description" : "The ID of the Variable Registry Update Request", - "required" : true, - "type" : "string" - }, { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VariableRegistryUpdateRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/process-groups/{id}" : { - "get" : { - "tags" : [ "process-groups" ], - "summary" : "Gets a process group", - "description" : "", - "operationId" : "getProcessGroup", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessGroupEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - } ] - }, - "put" : { - "tags" : [ "process-groups" ], - "summary" : "Updates a process group", - "description" : "", - "operationId" : "updateProcessGroup", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The process group configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ProcessGroupEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessGroupEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "process-groups" ], - "summary" : "Deletes a process group", - "description" : "", - "operationId" : "removeProcessGroup", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The revision is used to verify the client is working with the latest version of the flow.", - "required" : false, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessGroupEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - }, { - "Write - Parent Process Group - /process-groups/{uuid}" : [ ] - }, { - "Read - any referenced Controller Services by any encapsulated components - /controller-services/{uuid}" : [ ] - }, { - "Write - /{component-type}/{uuid} - For all encapsulated components" : [ ] - } ] - } - }, - "/process-groups/{id}/connections" : { - "get" : { - "tags" : [ "process-groups" ], - "summary" : "Gets all connections", - "description" : "", - "operationId" : "getConnections", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ConnectionsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - } ] - }, - "post" : { - "tags" : [ "process-groups" ], - "summary" : "Creates a connection", - "description" : "", - "operationId" : "createConnection", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The connection configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ConnectionEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ConnectionEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - }, { - "Write Source - /{component-type}/{uuid}" : [ ] - }, { - "Write Destination - /{component-type}/{uuid}" : [ ] - } ] - } - }, - "/process-groups/{id}/controller-services" : { - "post" : { - "tags" : [ "process-groups" ], - "summary" : "Creates a new controller service", - "description" : "", - "operationId" : "createControllerService", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The controller service configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ControllerServiceEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ControllerServiceEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - }, { - "Read - any referenced Controller Services - /controller-services/{uuid}" : [ ] - }, { - "Write - if the Controller Service is restricted - /restricted-components" : [ ] - } ] - } - }, - "/process-groups/{id}/download" : { - "get" : { - "tags" : [ "process-groups" ], - "summary" : "Gets a process group for download", - "description" : "", - "operationId" : "exportProcessGroup", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "name" : "includeReferencedServices", - "in" : "query", - "description" : "If referenced services from outside the target group should be included", - "required" : false, - "type" : "boolean", - "default" : false - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/process-groups/{id}/empty-all-connections-requests" : { - "post" : { - "tags" : [ "process-groups" ], - "summary" : "Creates a request to drop all flowfiles of all connection queues in this process group.", - "description" : "", - "operationId" : "createEmptyAllConnectionsRequest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/DropRequestEntity" - } - }, - "202" : { - "description" : "The request has been accepted. An HTTP response header will contain the URI where the status can be polled." - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid} - For this and all encapsulated process groups" : [ ] - }, { - "Write Source Data - /data/{component-type}/{uuid} - For all encapsulated connections" : [ ] - } ] - } - }, - "/process-groups/{id}/empty-all-connections-requests/{drop-request-id}" : { - "get" : { - "tags" : [ "process-groups" ], - "summary" : "Gets the current status of a drop all flowfiles request.", - "description" : "", - "operationId" : "getDropAllFlowfilesRequest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "name" : "drop-request-id", - "in" : "path", - "description" : "The drop request id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/DropRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid} - For this and all encapsulated process groups" : [ ] - }, { - "Write Source Data - /data/{component-type}/{uuid} - For all encapsulated connections" : [ ] - } ] - }, - "delete" : { - "tags" : [ "process-groups" ], - "summary" : "Cancels and/or removes a request to drop all flowfiles.", - "description" : "", - "operationId" : "removeDropRequest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "name" : "drop-request-id", - "in" : "path", - "description" : "The drop request id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/DropRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid} - For this and all encapsulated process groups" : [ ] - }, { - "Write Source Data - /data/{component-type}/{uuid} - For all encapsulated connections" : [ ] - } ] - } - }, - "/process-groups/{id}/flow-contents" : { - "put" : { - "tags" : [ "process-groups" ], - "summary" : "Replace Process Group contents with the given ID with the specified Process Group contents", - "description" : "This endpoint is used for replication within a cluster, when replacing a flow with a new flow. It expects that the flow beingreplaced is not under version control and that the given snapshot will not modify any Processor that is currently running or any Controller Service that is enabled. Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "replaceProcessGroup", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The process group replace request entity.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ProcessGroupImportEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessGroupImportEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - }, { - "Write - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/process-groups/{id}/funnels" : { - "get" : { - "tags" : [ "process-groups" ], - "summary" : "Gets all funnels", - "description" : "", - "operationId" : "getFunnels", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/FunnelsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - } ] - }, - "post" : { - "tags" : [ "process-groups" ], - "summary" : "Creates a funnel", - "description" : "", - "operationId" : "createFunnel", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The funnel configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/FunnelEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/FunnelEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/process-groups/{id}/input-ports" : { - "get" : { - "tags" : [ "process-groups" ], - "summary" : "Gets all input ports", - "description" : "", - "operationId" : "getInputPorts", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/InputPortsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - } ] - }, - "post" : { - "tags" : [ "process-groups" ], - "summary" : "Creates an input port", - "description" : "", - "operationId" : "createInputPort", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The input port configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/PortEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/PortEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/process-groups/{id}/labels" : { - "get" : { - "tags" : [ "process-groups" ], - "summary" : "Gets all labels", - "description" : "", - "operationId" : "getLabels", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/LabelsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - } ] - }, - "post" : { - "tags" : [ "process-groups" ], - "summary" : "Creates a label", - "description" : "", - "operationId" : "createLabel", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The label configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/LabelEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/LabelEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/process-groups/{id}/local-modifications" : { - "get" : { - "tags" : [ "process-groups" ], - "summary" : "Gets a list of local modifications to the Process Group since it was last synchronized with the Flow Registry", - "description" : "", - "operationId" : "getLocalModifications", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/FlowComparisonEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - }, { - "Read - /{component-type}/{uuid} - For all encapsulated components" : [ ] - } ] - } - }, - "/process-groups/{id}/output-ports" : { - "get" : { - "tags" : [ "process-groups" ], - "summary" : "Gets all output ports", - "description" : "", - "operationId" : "getOutputPorts", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/OutputPortsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - } ] - }, - "post" : { - "tags" : [ "process-groups" ], - "summary" : "Creates an output port", - "description" : "", - "operationId" : "createOutputPort", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The output port configuration.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/PortEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/PortEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/process-groups/{id}/process-groups" : { - "get" : { - "tags" : [ "process-groups" ], - "summary" : "Gets all process groups", - "description" : "", - "operationId" : "getProcessGroups", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessGroupsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - } ] - }, - "post" : { - "tags" : [ "process-groups" ], - "summary" : "Creates a process group", - "description" : "", - "operationId" : "createProcessGroup", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The process group configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ProcessGroupEntity" - } - }, { - "name" : "parameterContextHandlingStrategy", - "in" : "query", - "description" : "Handling Strategy controls whether to keep or replace Parameter Contexts", - "required" : false, - "type" : "string", - "default" : "KEEP_EXISTING", - "enum" : [ "KEEP_EXISTING", "REPLACE" ] - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessGroupEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/process-groups/{id}/process-groups/import" : { - "post" : { - "tags" : [ "process-groups" ], - "summary" : "Imports a specified process group", - "description" : "", - "operationId" : "importProcessGroup", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessGroupEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/process-groups/{id}/process-groups/upload" : { - "post" : { - "tags" : [ "process-groups" ], - "summary" : "Uploads a versioned flow definition and creates a process group", - "description" : "", - "operationId" : "uploadProcessGroup", - "consumes" : [ "multipart/form-data" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "name" : "groupName", - "in" : "formData", - "description" : "The process group name.", - "required" : true, - "type" : "string" - }, { - "name" : "positionX", - "in" : "formData", - "description" : "The process group X position.", - "required" : true, - "type" : "number" - }, { - "name" : "positionY", - "in" : "formData", - "description" : "The process group Y position.", - "required" : true, - "type" : "number" - }, { - "name" : "clientId", - "in" : "formData", - "description" : "The client id.", - "required" : true, - "type" : "string" - }, { - "name" : "disconnectedNodeAcknowledged", - "in" : "formData", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "file", - "in" : "formData", - "description" : "The binary content of the versioned flow definition file being uploaded.", - "required" : true, - "type" : "file" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessGroupEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/process-groups/{id}/processors" : { - "get" : { - "tags" : [ "process-groups" ], - "summary" : "Gets all processors", - "description" : "", - "operationId" : "getProcessors", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "name" : "includeDescendantGroups", - "in" : "query", - "description" : "Whether or not to include processors from descendant process groups", - "required" : false, - "type" : "boolean", - "default" : false - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessorsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - } ] - }, - "post" : { - "tags" : [ "process-groups" ], - "summary" : "Creates a new processor", - "description" : "", - "operationId" : "createProcessor", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The processor configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ProcessorEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessorEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - }, { - "Read - any referenced Controller Services - /controller-services/{uuid}" : [ ] - }, { - "Write - if the Processor is restricted - /restricted-components" : [ ] - } ] - } - }, - "/process-groups/{id}/remote-process-groups" : { - "get" : { - "tags" : [ "process-groups" ], - "summary" : "Gets all remote process groups", - "description" : "", - "operationId" : "getRemoteProcessGroups", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/RemoteProcessGroupsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - } ] - }, - "post" : { - "tags" : [ "process-groups" ], - "summary" : "Creates a new process group", - "description" : "", - "operationId" : "createRemoteProcessGroup", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The remote process group configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/RemoteProcessGroupEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/RemoteProcessGroupEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/process-groups/{id}/replace-requests" : { - "post" : { - "tags" : [ "process-groups" ], - "summary" : "Initiate the Replace Request of a Process Group with the given ID", - "description" : "This will initiate the action of replacing a process group with the given process group. This can be a lengthy process, as it will stop any Processors and disable any Controller Services necessary to perform the action and then restart them. As a result, the endpoint will immediately return a ProcessGroupReplaceRequestEntity, and the process of replacing the flow will occur asynchronously in the background. The client may then periodically poll the status of the request by issuing a GET request to /process-groups/replace-requests/{requestId}. Once the request is completed, the client is expected to issue a DELETE request to /process-groups/replace-requests/{requestId}. Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "initiateReplaceProcessGroup", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The process group replace request entity", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ProcessGroupImportEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessGroupReplaceRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - }, { - "Write - /process-groups/{uuid}" : [ ] - }, { - "Read - /{component-type}/{uuid} - For all encapsulated components" : [ ] - }, { - "Write - /{component-type}/{uuid} - For all encapsulated components" : [ ] - }, { - "Write - if the template contains any restricted components - /restricted-components" : [ ] - }, { - "Read - /parameter-contexts/{uuid} - For any Parameter Context that is referenced by a Property that is changed, added, or removed" : [ ] - } ] - } - }, - "/process-groups/{id}/snippet-instance" : { - "post" : { - "tags" : [ "process-groups" ], - "summary" : "Copies a snippet and discards it.", - "description" : "", - "operationId" : "copySnippet", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The copy snippet request.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/CopySnippetRequestEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/FlowEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - }, { - "Read - /{component-type}/{uuid} - For each component in the snippet and their descendant components" : [ ] - }, { - "Write - if the snippet contains any restricted Processors - /restricted-components" : [ ] - } ] - } - }, - "/process-groups/{id}/template-instance" : { - "post" : { - "tags" : [ "process-groups" ], - "summary" : "Instantiates a template", - "description" : "", - "operationId" : "instantiateTemplate", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The instantiate template request.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/InstantiateTemplateRequestEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/FlowEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - }, { - "Read - /templates/{uuid}" : [ ] - }, { - "Write - if the template contains any restricted components - /restricted-components" : [ ] - } ] - } - }, - "/process-groups/{id}/templates" : { - "post" : { - "tags" : [ "process-groups" ], - "summary" : "Creates a template and discards the specified snippet.", - "description" : "", - "operationId" : "createTemplate", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The create template request.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/CreateTemplateRequestEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/TemplateEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - }, { - "Read - /{component-type}/{uuid} - For each component in the snippet and their descendant components" : [ ] - } ] - } - }, - "/process-groups/{id}/templates/import" : { - "post" : { - "tags" : [ "process-groups" ], - "summary" : "Imports a template", - "description" : "", - "operationId" : "importTemplate", - "consumes" : [ "application/xml" ], - "produces" : [ "application/xml" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/TemplateEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/process-groups/{id}/templates/upload" : { - "post" : { - "tags" : [ "process-groups" ], - "summary" : "Uploads a template", - "description" : "", - "operationId" : "uploadTemplate", - "consumes" : [ "multipart/form-data" ], - "produces" : [ "application/xml" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "name" : "disconnectedNodeAcknowledged", - "in" : "formData", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "template", - "in" : "formData", - "description" : "The binary content of the template file being uploaded.", - "required" : true, - "type" : "file" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/TemplateEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/process-groups/{id}/variable-registry" : { - "get" : { - "tags" : [ "process-groups" ], - "summary" : "Gets a process group's variable registry", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getVariableRegistry", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "name" : "includeAncestorGroups", - "in" : "query", - "description" : "Whether or not to include ancestor groups", - "required" : false, - "type" : "boolean", - "default" : true - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VariableRegistryEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - } ] - }, - "put" : { - "tags" : [ "process-groups" ], - "summary" : "Updates the contents of a Process Group's variable Registry", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "updateVariableRegistry", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The variable registry configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/VariableRegistryEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VariableRegistryEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/process-groups/{id}/variable-registry/update-requests" : { - "post" : { - "tags" : [ "process-groups" ], - "summary" : "Submits a request to update a process group's variable registry", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "submitUpdateVariableRegistryRequest", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The variable registry configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/VariableRegistryEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VariableRegistryUpdateRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/processors/run-status-details/queries" : { - "post" : { - "tags" : [ "processors" ], - "summary" : "Submits a query to retrieve the run status details of all processors that are in the given list of Processor IDs", - "description" : "", - "operationId" : "getProcessorRunStatusDetails", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The request for the processors that should be included in the results", - "required" : false, - "schema" : { - "$ref" : "#/definitions/RunStatusDetailsRequestEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessorsRunStatusDetailsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /processors/{uuid} for each processor whose run status information is requested" : [ ] - } ] - } - }, - "/processors/{id}" : { - "get" : { - "tags" : [ "processors" ], - "summary" : "Gets a processor", - "description" : "", - "operationId" : "getProcessor", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The processor id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessorEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /processors/{uuid}" : [ ] - } ] - }, - "put" : { - "tags" : [ "processors" ], - "summary" : "Updates a processor", - "description" : "", - "operationId" : "updateProcessor", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The processor id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The processor configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ProcessorEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessorEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /processors/{uuid}" : [ ] - }, { - "Read - any referenced Controller Services if this request changes the reference - /controller-services/{uuid}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "processors" ], - "summary" : "Deletes a processor", - "description" : "", - "operationId" : "deleteProcessor", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The revision is used to verify the client is working with the latest version of the flow.", - "required" : false, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The processor id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessorEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /processors/{uuid}" : [ ] - }, { - "Write - Parent Process Group - /process-groups/{uuid}" : [ ] - }, { - "Read - any referenced Controller Services - /controller-services/{uuid}" : [ ] - } ] - } - }, - "/processors/{id}/config/analysis" : { - "post" : { - "tags" : [ "processors" ], - "summary" : "Performs analysis of the component's configuration, providing information about which attributes are referenced.", - "description" : "", - "operationId" : "analyzeConfiguration", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The processor id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The processor configuration analysis request.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ConfigurationAnalysisEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/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. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /processors/{uuid}" : [ ] - } ] - } - }, - "/processors/{id}/config/verification-requests" : { - "post" : { - "tags" : [ "processors" ], - "summary" : "Performs verification of the Processor's configuration", - "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", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The processor id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The processor configuration verification request.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/VerifyConfigRequestEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/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. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /processors/{uuid}" : [ ] - } ] - } - }, - "/processors/{id}/config/verification-requests/{requestId}" : { - "get" : { - "tags" : [ "processors" ], - "summary" : "Returns the Verification Request with the given ID", - "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", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The ID of the Processor", - "required" : true, - "type" : "string" - }, { - "name" : "requestId", - "in" : "path", - "description" : "The ID of the Verification Request", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/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. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Only the user that submitted the request can get it" : [ ] - } ] - }, - "delete" : { - "tags" : [ "processors" ], - "summary" : "Deletes the Verification Request with the given ID", - "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", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The ID of the Processor", - "required" : true, - "type" : "string" - }, { - "name" : "requestId", - "in" : "path", - "description" : "The ID of the Verification Request", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/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. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Only the user that submitted the request can remove it" : [ ] - } ] - } - }, - "/processors/{id}/descriptors" : { - "get" : { - "tags" : [ "processors" ], - "summary" : "Gets the descriptor for a processor property", - "description" : "", - "operationId" : "getPropertyDescriptor", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The processor id.", - "required" : true, - "type" : "string" - }, { - "name" : "propertyName", - "in" : "query", - "description" : "The property name.", - "required" : true, - "type" : "string" - }, { - "name" : "sensitive", - "in" : "query", - "description" : "Property Descriptor requested sensitive status", - "required" : false, - "type" : "boolean", - "default" : false - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/PropertyDescriptorEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /processors/{uuid}" : [ ] - } ] - } - }, - "/processors/{id}/diagnostics" : { - "get" : { - "tags" : [ "processors" ], - "summary" : "Gets diagnostics information about a processor", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getProcessorDiagnostics", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The processor id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessorEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /processors/{uuid}" : [ ] - } ] - } - }, - "/processors/{id}/run-status" : { - "put" : { - "tags" : [ "processors" ], - "summary" : "Updates run status of a processor", - "description" : "", - "operationId" : "updateRunStatus", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The processor id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The processor run status.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ProcessorRunStatusEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessorEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /processors/{uuid} or /operation/processors/{uuid}" : [ ] - } ] - } - }, - "/processors/{id}/state" : { - "get" : { - "tags" : [ "processors" ], - "summary" : "Gets the state for a processor", - "description" : "", - "operationId" : "getState", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The processor id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ComponentStateEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /processors/{uuid}" : [ ] - } ] - } - }, - "/processors/{id}/state/clear-requests" : { - "post" : { - "tags" : [ "processors" ], - "summary" : "Clears the state for a processor", - "description" : "", - "operationId" : "clearState", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The processor id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ComponentStateEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /processors/{uuid}" : [ ] - } ] - } - }, - "/processors/{id}/threads" : { - "delete" : { - "tags" : [ "processors" ], - "summary" : "Terminates a processor, essentially \"deleting\" its threads and any active tasks", - "description" : "", - "operationId" : "terminateProcessor", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The processor id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessorEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /processors/{uuid} or /operation/processors/{uuid}" : [ ] - } ] - } - }, - "/provenance" : { - "post" : { - "tags" : [ "provenance" ], - "summary" : "Submits a provenance query", - "description" : "Provenance queries may be long running so this endpoint submits a request. The response will include the current state of the query. If the request is not completed the URI in the response can be used at a later time to get the updated state of the query. Once the query has completed the provenance request should be deleted by the client who originally submitted it.", - "operationId" : "submitProvenanceRequest", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The provenance query details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ProvenanceEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProvenanceEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /provenance" : [ ] - }, { - "Read - /data/{component-type}/{uuid}" : [ ] - } ] - } - }, - "/provenance-events/latest/replays" : { - "post" : { - "tags" : [ "provenance-events" ], - "summary" : "Replays content from a provenance event", - "description" : "", - "operationId" : "submitReplayLatestEvent", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The replay request.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ReplayLastEventRequestEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/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. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read Component Provenance Data - /provenance-data/{component-type}/{uuid}" : [ ] - }, { - "Read Component Data - /data/{component-type}/{uuid}" : [ ] - }, { - "Write Component Data - /data/{component-type}/{uuid}" : [ ] - } ] - } - }, - "/provenance-events/replays" : { - "post" : { - "tags" : [ "provenance-events" ], - "summary" : "Replays content from a provenance event", - "description" : "", - "operationId" : "submitReplay", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The replay request.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/SubmitReplayRequestEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProvenanceEventEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read Component Provenance Data - /provenance-data/{component-type}/{uuid}" : [ ] - }, { - "Read Component Data - /data/{component-type}/{uuid}" : [ ] - }, { - "Write Component Data - /data/{component-type}/{uuid}" : [ ] - } ] - } - }, - "/provenance-events/{id}" : { - "get" : { - "tags" : [ "provenance-events" ], - "summary" : "Gets a provenance event", - "description" : "", - "operationId" : "getProvenanceEvent", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "clusterNodeId", - "in" : "query", - "description" : "The id of the node where this event exists if clustered.", - "required" : false, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The provenance event id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProvenanceEventEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read Component Provenance Data - /provenance-data/{component-type}/{uuid}" : [ ] - } ] - } - }, - "/provenance-events/{id}/content/input" : { - "get" : { - "tags" : [ "provenance-events" ], - "summary" : "Gets the input content for a provenance event", - "description" : "", - "operationId" : "getInputContent", - "consumes" : [ "*/*" ], - "produces" : [ "*/*" ], - "parameters" : [ { - "name" : "clusterNodeId", - "in" : "query", - "description" : "The id of the node where the content exists if clustered.", - "required" : false, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The provenance event id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/StreamingOutput" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read Component Provenance Data - /provenance-data/{component-type}/{uuid}" : [ ] - }, { - "Read Component Data - /data/{component-type}/{uuid}" : [ ] - } ] - } - }, - "/provenance-events/{id}/content/output" : { - "get" : { - "tags" : [ "provenance-events" ], - "summary" : "Gets the output content for a provenance event", - "description" : "", - "operationId" : "getOutputContent", - "consumes" : [ "*/*" ], - "produces" : [ "*/*" ], - "parameters" : [ { - "name" : "clusterNodeId", - "in" : "query", - "description" : "The id of the node where the content exists if clustered.", - "required" : false, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The provenance event id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/StreamingOutput" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read Component Provenance Data - /provenance-data/{component-type}/{uuid}" : [ ] - }, { - "Read Component Data - /data/{component-type}/{uuid}" : [ ] - } ] - } - }, - "/provenance/lineage" : { - "post" : { - "tags" : [ "provenance" ], - "summary" : "Submits a lineage query", - "description" : "Lineage queries may be long running so this endpoint submits a request. The response will include the current state of the query. If the request is not completed the URI in the response can be used at a later time to get the updated state of the query. Once the query has completed the lineage request should be deleted by the client who originally submitted it.", - "operationId" : "submitLineageRequest", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The lineage query details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/LineageEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/LineageEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /provenance" : [ ] - }, { - "Read - /data/{component-type}/{uuid}" : [ ] - } ] - } - }, - "/provenance/lineage/{id}" : { - "get" : { - "tags" : [ "provenance" ], - "summary" : "Gets a lineage query", - "description" : "", - "operationId" : "getLineage", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "clusterNodeId", - "in" : "query", - "description" : "The id of the node where this query exists if clustered.", - "required" : false, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The id of the lineage query.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/LineageEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /provenance" : [ ] - }, { - "Read - /data/{component-type}/{uuid}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "provenance" ], - "summary" : "Deletes a lineage query", - "description" : "", - "operationId" : "deleteLineage", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "clusterNodeId", - "in" : "query", - "description" : "The id of the node where this query exists if clustered.", - "required" : false, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The id of the lineage query.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/LineageEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /provenance" : [ ] - } ] - } - }, - "/provenance/search-options" : { - "get" : { - "tags" : [ "provenance" ], - "summary" : "Gets the searchable attributes for provenance events", - "description" : "", - "operationId" : "getSearchOptions", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProvenanceOptionsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /provenance" : [ ] - } ] - } - }, - "/provenance/{id}" : { - "get" : { - "tags" : [ "provenance" ], - "summary" : "Gets a provenance query", - "description" : "", - "operationId" : "getProvenance", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "clusterNodeId", - "in" : "query", - "description" : "The id of the node where this query exists if clustered.", - "required" : false, - "type" : "string" - }, { - "name" : "summarize", - "in" : "query", - "description" : "Whether or not incremental results are returned. If false, provenance events are only returned once the query completes. This property is true by default.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "incrementalResults", - "in" : "query", - "description" : "Whether or not to summarize provenance events returned. This property is false by default.", - "required" : false, - "type" : "boolean", - "default" : true - }, { - "name" : "id", - "in" : "path", - "description" : "The id of the provenance query.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProvenanceEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /provenance" : [ ] - }, { - "Read - /data/{component-type}/{uuid}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "provenance" ], - "summary" : "Deletes a provenance query", - "description" : "", - "operationId" : "deleteProvenance", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "clusterNodeId", - "in" : "query", - "description" : "The id of the node where this query exists if clustered.", - "required" : false, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The id of the provenance query.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProvenanceEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /provenance" : [ ] - } ] - } - }, - "/remote-process-groups/process-group/{id}/run-status" : { - "put" : { - "tags" : [ "remote-process-groups" ], - "summary" : "Updates run status of all remote process groups in a process group (recursively)", - "description" : "", - "operationId" : "updateRemoteProcessGroupRunStatuses", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The remote process groups run status.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/RemotePortRunStatusEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/RemoteProcessGroupEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /remote-process-groups/{uuid} or /operation/remote-process-groups/{uuid}" : [ ] - } ] - } - }, - "/remote-process-groups/{id}" : { - "get" : { - "tags" : [ "remote-process-groups" ], - "summary" : "Gets a remote process group", - "description" : "", - "operationId" : "getRemoteProcessGroup", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The remote process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/RemoteProcessGroupEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /remote-process-groups/{uuid}" : [ ] - } ] - }, - "put" : { - "tags" : [ "remote-process-groups" ], - "summary" : "Updates a remote process group", - "description" : "", - "operationId" : "updateRemoteProcessGroup", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The remote process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The remote process group.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/RemoteProcessGroupEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/RemoteProcessGroupEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /remote-process-groups/{uuid}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "remote-process-groups" ], - "summary" : "Deletes a remote process group", - "description" : "", - "operationId" : "removeRemoteProcessGroup", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The revision is used to verify the client is working with the latest version of the flow.", - "required" : false, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The remote process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/RemoteProcessGroupEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /remote-process-groups/{uuid}" : [ ] - }, { - "Write - Parent Process Group - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/remote-process-groups/{id}/input-ports/{port-id}" : { - "put" : { - "tags" : [ "remote-process-groups" ], - "summary" : "Updates a remote port", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "updateRemoteProcessGroupInputPort", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The remote process group id.", - "required" : true, - "type" : "string" - }, { - "name" : "port-id", - "in" : "path", - "description" : "The remote process group port id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The remote process group port.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/RemoteProcessGroupPortEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/RemoteProcessGroupPortEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /remote-process-groups/{uuid}" : [ ] - } ] - } - }, - "/remote-process-groups/{id}/input-ports/{port-id}/run-status" : { - "put" : { - "tags" : [ "remote-process-groups" ], - "summary" : "Updates run status of a remote port", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "updateRemoteProcessGroupInputPortRunStatus", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The remote process group id.", - "required" : true, - "type" : "string" - }, { - "name" : "port-id", - "in" : "path", - "description" : "The remote process group port id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The remote process group port.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/RemotePortRunStatusEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/RemoteProcessGroupPortEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /remote-process-groups/{uuid} or /operation/remote-process-groups/{uuid}" : [ ] - } ] - } - }, - "/remote-process-groups/{id}/output-ports/{port-id}" : { - "put" : { - "tags" : [ "remote-process-groups" ], - "summary" : "Updates a remote port", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "updateRemoteProcessGroupOutputPort", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The remote process group id.", - "required" : true, - "type" : "string" - }, { - "name" : "port-id", - "in" : "path", - "description" : "The remote process group port id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The remote process group port.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/RemoteProcessGroupPortEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/RemoteProcessGroupPortEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /remote-process-groups/{uuid}" : [ ] - } ] - } - }, - "/remote-process-groups/{id}/output-ports/{port-id}/run-status" : { - "put" : { - "tags" : [ "remote-process-groups" ], - "summary" : "Updates run status of a remote port", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "updateRemoteProcessGroupOutputPortRunStatus", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The remote process group id.", - "required" : true, - "type" : "string" - }, { - "name" : "port-id", - "in" : "path", - "description" : "The remote process group port id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The remote process group port.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/RemotePortRunStatusEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/RemoteProcessGroupPortEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /remote-process-groups/{uuid} or /operation/remote-process-groups/{uuid}" : [ ] - } ] - } - }, - "/remote-process-groups/{id}/run-status" : { - "put" : { - "tags" : [ "remote-process-groups" ], - "summary" : "Updates run status of a remote process group", - "description" : "", - "operationId" : "updateRemoteProcessGroupRunStatus", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The remote process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The remote process group run status.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/RemotePortRunStatusEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/RemoteProcessGroupEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /remote-process-groups/{uuid} or /operation/remote-process-groups/{uuid}" : [ ] - } ] - } - }, - "/remote-process-groups/{id}/state" : { - "get" : { - "tags" : [ "remote-process-groups" ], - "summary" : "Gets the state for a RemoteProcessGroup", - "description" : "", - "operationId" : "getState", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The processor id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ComponentStateEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /remote-process-groups/{uuid}" : [ ] - } ] - } - }, - "/reporting-tasks/{id}" : { - "get" : { - "tags" : [ "reporting-tasks" ], - "summary" : "Gets a reporting task", - "description" : "", - "operationId" : "getReportingTask", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The reporting task id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ReportingTaskEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /reporting-tasks/{uuid}" : [ ] - } ] - }, - "put" : { - "tags" : [ "reporting-tasks" ], - "summary" : "Updates a reporting task", - "description" : "", - "operationId" : "updateReportingTask", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The reporting task id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The reporting task configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ReportingTaskEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ReportingTaskEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /reporting-tasks/{uuid}" : [ ] - }, { - "Read - any referenced Controller Services if this request changes the reference - /controller-services/{uuid}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "reporting-tasks" ], - "summary" : "Deletes a reporting task", - "description" : "", - "operationId" : "removeReportingTask", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The revision is used to verify the client is working with the latest version of the flow.", - "required" : false, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The reporting task id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ReportingTaskEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /reporting-tasks/{uuid}" : [ ] - }, { - "Write - /controller" : [ ] - }, { - "Read - any referenced Controller Services - /controller-services/{uuid}" : [ ] - } ] - } - }, - "/reporting-tasks/{id}/config/analysis" : { - "post" : { - "tags" : [ "reporting-tasks" ], - "summary" : "Performs analysis of the component's configuration, providing information about which attributes are referenced.", - "description" : "", - "operationId" : "analyzeConfiguration", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The reporting task id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The configuration analysis request.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ConfigurationAnalysisEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/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. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /reporting-tasks/{uuid}" : [ ] - } ] - } - }, - "/reporting-tasks/{id}/config/verification-requests" : { - "post" : { - "tags" : [ "reporting-tasks" ], - "summary" : "Performs verification of the Reporting Task's configuration", - "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", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The reporting task id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The reporting task configuration verification request.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/VerifyConfigRequestEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/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. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /reporting-tasks/{uuid}" : [ ] - } ] - } - }, - "/reporting-tasks/{id}/config/verification-requests/{requestId}" : { - "get" : { - "tags" : [ "reporting-tasks" ], - "summary" : "Returns the Verification Request with the given ID", - "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", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The ID of the Reporting Task", - "required" : true, - "type" : "string" - }, { - "name" : "requestId", - "in" : "path", - "description" : "The ID of the Verification Request", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/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. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Only the user that submitted the request can get it" : [ ] - } ] - }, - "delete" : { - "tags" : [ "reporting-tasks" ], - "summary" : "Deletes the Verification Request with the given ID", - "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", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The ID of the Reporting Task", - "required" : true, - "type" : "string" - }, { - "name" : "requestId", - "in" : "path", - "description" : "The ID of the Verification Request", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/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. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Only the user that submitted the request can remove it" : [ ] - } ] - } - }, - "/reporting-tasks/{id}/descriptors" : { - "get" : { - "tags" : [ "reporting-tasks" ], - "summary" : "Gets a reporting task property descriptor", - "description" : "", - "operationId" : "getPropertyDescriptor", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The reporting task id.", - "required" : true, - "type" : "string" - }, { - "name" : "propertyName", - "in" : "query", - "description" : "The property name.", - "required" : true, - "type" : "string" - }, { - "name" : "sensitive", - "in" : "query", - "description" : "Property Descriptor requested sensitive status", - "required" : false, - "type" : "boolean", - "default" : false - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/PropertyDescriptorEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /reporting-tasks/{uuid}" : [ ] - } ] - } - }, - "/reporting-tasks/{id}/run-status" : { - "put" : { - "tags" : [ "reporting-tasks" ], - "summary" : "Updates run status of a reporting task", - "description" : "", - "operationId" : "updateRunStatus", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The reporting task id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The reporting task run status.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ReportingTaskRunStatusEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ReportingTaskEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /reporting-tasks/{uuid} or or /operation/reporting-tasks/{uuid}" : [ ] - } ] - } - }, - "/reporting-tasks/{id}/state" : { - "get" : { - "tags" : [ "reporting-tasks" ], - "summary" : "Gets the state for a reporting task", - "description" : "", - "operationId" : "getState", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The reporting task id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ComponentStateEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /reporting-tasks/{uuid}" : [ ] - } ] - } - }, - "/reporting-tasks/{id}/state/clear-requests" : { - "post" : { - "tags" : [ "reporting-tasks" ], - "summary" : "Clears the state for a reporting task", - "description" : "", - "operationId" : "clearState", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The reporting task id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ComponentStateEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /reporting-tasks/{uuid}" : [ ] - } ] - } - }, - "/resources" : { - "get" : { - "tags" : [ "resources" ], - "summary" : "Gets the available resources that support access/authorization policies", - "description" : "", - "operationId" : "getResources", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ResourcesEntity" - } - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - } - }, - "security" : [ { - "Read - /resources" : [ ] - } ] - } - }, - "/site-to-site" : { - "get" : { - "tags" : [ "site-to-site" ], - "summary" : "Returns the details about this NiFi necessary to communicate via site to site", - "description" : "", - "operationId" : "getSiteToSiteDetails", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ControllerEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /site-to-site" : [ ] - } ] - } - }, - "/site-to-site/peers" : { - "get" : { - "tags" : [ "site-to-site" ], - "summary" : "Returns the available Peers and its status of this NiFi", - "description" : "", - "operationId" : "getPeers", - "consumes" : [ "*/*" ], - "produces" : [ "application/json", "application/xml" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/PeersEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /site-to-site" : [ ] - } ] - } - }, - "/snippets" : { - "post" : { - "tags" : [ "snippets" ], - "summary" : "Creates a snippet. The snippet will be automatically discarded if not used in a subsequent request after 1 minute.", - "description" : "", - "operationId" : "createSnippet", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The snippet configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/SnippetEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/SnippetEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read or Write - /{component-type}/{uuid} - For every component (all Read or all Write) in the Snippet and their descendant components" : [ ] - } ] - } - }, - "/snippets/{id}" : { - "put" : { - "tags" : [ "snippets" ], - "summary" : "Move's the components in this Snippet into a new Process Group and discards the snippet", - "description" : "", - "operationId" : "updateSnippet", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The snippet id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The snippet configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/SnippetEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/SnippetEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write Process Group - /process-groups/{uuid}" : [ ] - }, { - "Write - /{component-type}/{uuid} - For each component in the Snippet and their descendant components" : [ ] - } ] - }, - "delete" : { - "tags" : [ "snippets" ], - "summary" : "Deletes the components in a snippet and discards the snippet", - "description" : "", - "operationId" : "deleteSnippet", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The snippet id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/SnippetEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /{component-type}/{uuid} - For each component in the Snippet and their descendant components" : [ ] - }, { - "Write - Parent Process Group - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/system-diagnostics" : { - "get" : { - "tags" : [ "system-diagnostics" ], - "summary" : "Gets the diagnostics for the system NiFi is running on", - "description" : "", - "operationId" : "getSystemDiagnostics", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "nodewise", - "in" : "query", - "description" : "Whether or not to include the breakdown per node. Optional, defaults to false", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "clusterNodeId", - "in" : "query", - "description" : "The id of the node where to get the status.", - "required" : false, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/SystemDiagnosticsEntity" - } - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - } - }, - "security" : [ { - "Read - /system" : [ ] - } ] - } - }, - "/system-diagnostics/jmx-metrics" : { - "get" : { - "tags" : [ "system-diagnostics" ], - "summary" : "Retrieve available JMX metrics", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getJmxMetrics", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "beanNameFilter", - "in" : "query", - "description" : "Regular Expression Pattern to be applied against the ObjectName", - "required" : false, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/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. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /system" : [ ] - } ] - } - }, - "/templates/{id}" : { - "delete" : { - "tags" : [ "templates" ], - "summary" : "Deletes a template", - "description" : "", - "operationId" : "removeTemplate", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The template id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/TemplateEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /templates/{uuid}" : [ ] - }, { - "Write - Parent Process Group - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/templates/{id}/download" : { - "get" : { - "tags" : [ "templates" ], - "summary" : "Exports a template", - "description" : "", - "operationId" : "exportTemplate", - "consumes" : [ "*/*" ], - "produces" : [ "application/xml" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The template id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /templates/{uuid}" : [ ] - } ] - } - }, - "/tenants/search-results" : { - "get" : { - "tags" : [ "tenants" ], - "summary" : "Searches for a tenant with the specified identity", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "searchTenants", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "q", - "in" : "query", - "description" : "Identity to search for.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/TenantsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /tenants" : [ ] - } ] - } - }, - "/tenants/user-groups" : { - "get" : { - "tags" : [ "tenants" ], - "summary" : "Gets all user groups", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getUserGroups", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/UserGroupsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /tenants" : [ ] - } ] - }, - "post" : { - "tags" : [ "tenants" ], - "summary" : "Creates a user group", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "createUserGroup", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The user group configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/UserGroupEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/UserGroupEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /tenants" : [ ] - } ] - } - }, - "/tenants/user-groups/{id}" : { - "get" : { - "tags" : [ "tenants" ], - "summary" : "Gets a user group", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getUserGroup", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The user group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/UserGroupEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /tenants" : [ ] - } ] - }, - "put" : { - "tags" : [ "tenants" ], - "summary" : "Updates a user group", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "updateUserGroup", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The user group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The user group configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/UserGroupEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/UserGroupEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /tenants" : [ ] - } ] - }, - "delete" : { - "tags" : [ "tenants" ], - "summary" : "Deletes a user group", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "removeUserGroup", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The revision is used to verify the client is working with the latest version of the flow.", - "required" : false, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The user group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/UserGroupEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /tenants" : [ ] - } ] - } - }, - "/tenants/users" : { - "get" : { - "tags" : [ "tenants" ], - "summary" : "Gets all users", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getUsers", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/UsersEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /tenants" : [ ] - } ] - }, - "post" : { - "tags" : [ "tenants" ], - "summary" : "Creates a user", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "createUser", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The user configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/UserEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/UserEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /tenants" : [ ] - } ] - } - }, - "/tenants/users/{id}" : { - "get" : { - "tags" : [ "tenants" ], - "summary" : "Gets a user", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getUser", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The user id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/UserEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /tenants" : [ ] - } ] - }, - "put" : { - "tags" : [ "tenants" ], - "summary" : "Updates a user", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "updateUser", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The user id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The user configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/UserEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/UserEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /tenants" : [ ] - } ] - }, - "delete" : { - "tags" : [ "tenants" ], - "summary" : "Deletes a user", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "removeUser", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The revision is used to verify the client is working with the latest version of the flow.", - "required" : false, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The user id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/UserEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /tenants" : [ ] - } ] - } - }, - "/versions/active-requests" : { - "post" : { - "tags" : [ "versions" ], - "summary" : "Create a version control request", - "description" : "Creates a request so that a Process Group can be placed under Version Control or have its Version Control configuration changed. Creating this request will prevent any other threads from simultaneously saving local changes to Version Control. It will not, however, actually save the local flow to the Flow Registry. A POST to /versions/process-groups/{id} should be used to initiate saving of the local flow to the Flow Registry. Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "createVersionControlRequest", - "consumes" : [ "application/json" ], - "produces" : [ "text/plain" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The versioned flow details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/CreateActiveRequestEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/versions/active-requests/{id}" : { - "put" : { - "tags" : [ "versions" ], - "summary" : "Updates the request with the given ID", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "updateVersionControlRequest", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The request ID.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The version control component mapping.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/VersionControlComponentMappingEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionControlInformationEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Only the user that submitted the request can update it" : [ ] - } ] - }, - "delete" : { - "tags" : [ "versions" ], - "summary" : "Deletes the version control request with the given ID", - "description" : "Deletes the Version Control Request with the given ID. This will allow other threads to save flows to the Flow Registry. See also the documentation for POSTing to /versions/active-requests for information regarding why this is done. Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "deleteVersionControlRequest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The request ID.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Only the user that submitted the request can remove it" : [ ] - } ] - } - }, - "/versions/process-groups/{id}" : { - "get" : { - "tags" : [ "versions" ], - "summary" : "Gets the Version Control information for a process group", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getVersionInformation", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionControlInformationEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - } ] - }, - "post" : { - "tags" : [ "versions" ], - "summary" : "Save the Process Group with the given ID", - "description" : "Begins version controlling the Process Group with the given ID or commits changes to the Versioned Flow, depending on if the provided VersionControlInformation includes a flowId. Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "saveToFlowRegistry", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The versioned flow details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/StartVersionControlRequestEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionControlInformationEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - }, { - "Write - /process-groups/{uuid}" : [ ] - }, { - "Read - /{component-type}/{uuid} - For all encapsulated components" : [ ] - }, { - "Read - any referenced Controller Services by any encapsulated components - /controller-services/{uuid}" : [ ] - } ] - }, - "put" : { - "tags" : [ "versions" ], - "summary" : "Update the version of a Process Group with the given ID", - "description" : "For a Process Group that is already under Version Control, this will update the version of the flow to a different version. This endpoint expects that the given snapshot will not modify any Processor that is currently running or any Controller Service that is enabled. Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "updateFlowVersion", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The controller service configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/VersionedFlowSnapshotEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionControlInformationEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - }, { - "Write - /process-groups/{uuid}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "versions" ], - "summary" : "Stops version controlling the Process Group with the given ID", - "description" : "Stops version controlling the Process Group with the given ID. The Process Group will no longer track to any Versioned Flow. Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "stopVersionControl", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The version is used to verify the client is working with the latest version of the flow.", - "required" : false, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, a new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionControlInformationEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - }, { - "Write - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/versions/process-groups/{id}/download" : { - "get" : { - "tags" : [ "versions" ], - "summary" : "Gets the latest version of a Process Group for download", - "description" : "", - "operationId" : "exportFlowVersion", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/versions/revert-requests/process-groups/{id}" : { - "post" : { - "tags" : [ "versions" ], - "summary" : "Initiate the Revert Request of a Process Group with the given ID", - "description" : "For a Process Group that is already under Version Control, this will initiate the action of reverting any local changes that have been made to the Process Group since it was last synchronized with the Flow Registry. This will result in the flow matching the Versioned Flow that exists in the Flow Registry. This can be a lengthy process, as it will stop any Processors and disable any Controller Services necessary to perform the action and then restart them. As a result, the endpoint will immediately return a VersionedFlowUpdateRequestEntity, and the process of updating the flow will occur asynchronously in the background. The client may then periodically poll the status of the request by issuing a GET request to /versions/revert-requests/{requestId}. Once the request is completed, the client is expected to issue a DELETE request to /versions/revert-requests/{requestId}. Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "initiateRevertFlowVersion", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The Version Control Information to revert to.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/VersionControlInformationEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlowUpdateRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - }, { - "Write - /process-groups/{uuid}" : [ ] - }, { - "Read - /{component-type}/{uuid} - For all encapsulated components" : [ ] - }, { - "Write - /{component-type}/{uuid} - For all encapsulated components" : [ ] - }, { - "Write - if the template contains any restricted components - /restricted-components" : [ ] - }, { - "Read - /parameter-contexts/{uuid} - For any Parameter Context that is referenced by a Property that is changed, added, or removed" : [ ] - } ] - } - }, - "/versions/revert-requests/{id}" : { - "get" : { - "tags" : [ "versions" ], - "summary" : "Returns the Revert Request with the given ID", - "description" : "Returns the Revert Request with the given ID. Once a Revert Request has been created by performing a POST to /versions/revert-requests/process-groups/{id}, that request can subsequently be retrieved via this endpoint, and the request that is fetched will contain the updated state, such as percent complete, the current state of the request, and any failures. Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getRevertRequest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The ID of the Revert Request", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlowUpdateRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Only the user that submitted the request can get it" : [ ] - } ] - }, - "delete" : { - "tags" : [ "versions" ], - "summary" : "Deletes the Revert Request with the given ID", - "description" : "Deletes the Revert Request with the given ID. After a request is created via a POST to /versions/revert-requests/process-groups/{id}, it is expected that the client will properly clean up the request by DELETE'ing it, once the Revert process has completed. If the request is deleted before the request completes, then the Revert request will finish the step that it is currently performing and then will cancel any subsequent steps. Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "deleteRevertRequest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The ID of the Revert Request", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlowUpdateRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Only the user that submitted the request can remove it" : [ ] - } ] - } - }, - "/versions/update-requests/process-groups/{id}" : { - "post" : { - "tags" : [ "versions" ], - "summary" : "Initiate the Update Request of a Process Group with the given ID", - "description" : "For a Process Group that is already under Version Control, this will initiate the action of changing from a specific version of the flow in the Flow Registry to a different version of the flow. This can be a lengthy process, as it will stop any Processors and disable any Controller Services necessary to perform the action and then restart them. As a result, the endpoint will immediately return a VersionedFlowUpdateRequestEntity, and the process of updating the flow will occur asynchronously in the background. The client may then periodically poll the status of the request by issuing a GET request to /versions/update-requests/{requestId}. Once the request is completed, the client is expected to issue a DELETE request to /versions/update-requests/{requestId}. Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "initiateVersionControlUpdate", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The controller service configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/VersionControlInformationEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlowUpdateRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - }, { - "Write - /process-groups/{uuid}" : [ ] - }, { - "Read - /{component-type}/{uuid} - For all encapsulated components" : [ ] - }, { - "Write - /{component-type}/{uuid} - For all encapsulated components" : [ ] - }, { - "Write - if the template contains any restricted components - /restricted-components" : [ ] - }, { - "Read - /parameter-contexts/{uuid} - For any Parameter Context that is referenced by a Property that is changed, added, or removed" : [ ] - } ] - } - }, - "/versions/update-requests/{id}" : { - "get" : { - "tags" : [ "versions" ], - "summary" : "Returns the Update Request with the given ID", - "description" : "Returns the Update Request with the given ID. Once an Update Request has been created by performing a POST to /versions/update-requests/process-groups/{id}, that request can subsequently be retrieved via this endpoint, and the request that is fetched will contain the updated state, such as percent complete, the current state of the request, and any failures. Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getUpdateRequest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The ID of the Update Request", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlowUpdateRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Only the user that submitted the request can get it" : [ ] - } ] - }, - "delete" : { - "tags" : [ "versions" ], - "summary" : "Deletes the Update Request with the given ID", - "description" : "Deletes the Update Request with the given ID. After a request is created via a POST to /versions/update-requests/process-groups/{id}, it is expected that the client will properly clean up the request by DELETE'ing it, once the Update process has completed. If the request is deleted before the request completes, then the Update request will finish the step that it is currently performing and then will cancel any subsequent steps. Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "deleteUpdateRequest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The ID of the Update Request", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlowUpdateRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Only the user that submitted the request can remove it" : [ ] - } ] - } - } - }, - "definitions" : { - "AboutDTO" : { - "type" : "object", - "properties" : { - "title" : { - "type" : "string", - "description" : "The title to be used on the page and in the about dialog." - }, - "version" : { - "type" : "string", - "description" : "The version of this NiFi." - }, - "uri" : { - "type" : "string", - "description" : "The URI for the NiFi." - }, - "contentViewerUrl" : { - "type" : "string", - "description" : "The URL for the content viewer if configured." - }, - "timezone" : { - "type" : "string", - "description" : "The timezone of the NiFi instance.", - "readOnly" : true - }, - "buildTag" : { - "type" : "string", - "description" : "Build tag" - }, - "buildRevision" : { - "type" : "string", - "description" : "Build revision or commit hash" - }, - "buildBranch" : { - "type" : "string", - "description" : "Build branch" - }, - "buildTimestamp" : { - "type" : "string", - "description" : "Build timestamp" - } - } - }, - "AboutEntity" : { - "type" : "object", - "properties" : { - "about" : { - "$ref" : "#/definitions/AboutDTO" - } - }, - "xml" : { - "name" : "aboutEntity" - } - }, - "AccessConfigurationDTO" : { - "type" : "object", - "properties" : { - "supportsLogin" : { - "type" : "boolean", - "description" : "Indicates whether or not this NiFi supports user login.", - "readOnly" : true - } - } - }, - "AccessConfigurationEntity" : { - "type" : "object", - "properties" : { - "config" : { - "$ref" : "#/definitions/AccessConfigurationDTO" - } - }, - "xml" : { - "name" : "accessConfigurationEntity" - } - }, - "AccessPolicyDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "versionedComponentId" : { - "type" : "string", - "description" : "The ID of the corresponding component that is under version control" - }, - "parentGroupId" : { - "type" : "string", - "description" : "The id of parent process group of this component if applicable." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "resource" : { - "type" : "string", - "description" : "The resource for this access policy." - }, - "action" : { - "type" : "string", - "description" : "The action associated with this access policy.", - "enum" : [ "read", "write" ] - }, - "componentReference" : { - "description" : "Component this policy references if applicable.", - "$ref" : "#/definitions/ComponentReferenceEntity" - }, - "configurable" : { - "type" : "boolean", - "description" : "Whether this policy is configurable." - }, - "users" : { - "type" : "array", - "description" : "The set of user IDs associated with this access policy.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/TenantEntity" - } - }, - "userGroups" : { - "type" : "array", - "description" : "The set of user group IDs associated with this access policy.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/TenantEntity" - } - } - } - }, - "AccessPolicyEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "generated" : { - "type" : "string", - "description" : "When this content was generated." - }, - "component" : { - "$ref" : "#/definitions/AccessPolicyDTO" - } - }, - "xml" : { - "name" : "accessPolicyEntity" - } - }, - "AccessPolicySummaryDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "versionedComponentId" : { - "type" : "string", - "description" : "The ID of the corresponding component that is under version control" - }, - "parentGroupId" : { - "type" : "string", - "description" : "The id of parent process group of this component if applicable." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "resource" : { - "type" : "string", - "description" : "The resource for this access policy." - }, - "action" : { - "type" : "string", - "description" : "The action associated with this access policy.", - "enum" : [ "read", "write" ] - }, - "componentReference" : { - "description" : "Component this policy references if applicable.", - "$ref" : "#/definitions/ComponentReferenceEntity" - }, - "configurable" : { - "type" : "boolean", - "description" : "Whether this policy is configurable." - } - } - }, - "AccessPolicySummaryEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "component" : { - "$ref" : "#/definitions/AccessPolicySummaryDTO" - } - }, - "xml" : { - "name" : "accessPolicySummaryEntity" - } - }, - "AccessStatusDTO" : { - "type" : "object", - "properties" : { - "identity" : { - "type" : "string", - "description" : "The user identity.", - "readOnly" : true - }, - "status" : { - "type" : "string", - "description" : "The user access status.", - "readOnly" : true - }, - "message" : { - "type" : "string", - "description" : "Additional details about the user access status.", - "readOnly" : true - } - }, - "xml" : { - "name" : "accessStatus" - } - }, - "AccessStatusEntity" : { - "type" : "object", - "properties" : { - "accessStatus" : { - "$ref" : "#/definitions/AccessStatusDTO" - } - }, - "xml" : { - "name" : "accessStatusEntity" - } - }, - "AccessTokenExpirationDTO" : { - "type" : "object", - "properties" : { - "expiration" : { - "type" : "string", - "description" : "Token Expiration", - "readOnly" : true - } - }, - "xml" : { - "name" : "accessTokenExpiration" - } - }, - "AccessTokenExpirationEntity" : { - "type" : "object", - "properties" : { - "accessTokenExpiration" : { - "$ref" : "#/definitions/AccessTokenExpirationDTO" - } - }, - "xml" : { - "name" : "accessTokenExpirationEntity" - } - }, - "ActionDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "integer", - "format" : "int32", - "description" : "The action id." - }, - "userIdentity" : { - "type" : "string", - "description" : "The identity of the user that performed the action." - }, - "timestamp" : { - "type" : "string", - "description" : "The timestamp of the action." - }, - "sourceId" : { - "type" : "string", - "description" : "The id of the source component." - }, - "sourceName" : { - "type" : "string", - "description" : "The name of the source component." - }, - "sourceType" : { - "type" : "string", - "description" : "The type of the source component." - }, - "componentDetails" : { - "description" : "The details of the source component.", - "$ref" : "#/definitions/ComponentDetailsDTO" - }, - "operation" : { - "type" : "string", - "description" : "The operation that was performed." - }, - "actionDetails" : { - "description" : "The details of the action.", - "$ref" : "#/definitions/ActionDetailsDTO" - } - } - }, - "ActionDetailsDTO" : { - "type" : "object" - }, - "ActionEntity" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "integer", - "format" : "int32" - }, - "timestamp" : { - "type" : "string", - "description" : "The timestamp of the action." - }, - "sourceId" : { - "type" : "string" - }, - "canRead" : { - "type" : "boolean", - "description" : "Indicates whether the user can read a given resource.", - "readOnly" : true - }, - "action" : { - "$ref" : "#/definitions/ActionDTO" - } - }, - "xml" : { - "name" : "actionEntity" - } - }, - "ActivateControllerServicesEntity" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the ProcessGroup" - }, - "state" : { - "type" : "string", - "description" : "The desired state of the descendant components", - "enum" : [ "ENABLED", "DISABLED" ] - }, - "components" : { - "type" : "object", - "description" : "Optional services to schedule. If not specified, all authorized descendant controller services will be used.", - "additionalProperties" : { - "$ref" : "#/definitions/RevisionDTO" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - } - }, - "xml" : { - "name" : "activateControllerServicesEntity" - } - }, - "AffectedComponentDTO" : { - "type" : "object", - "properties" : { - "processGroupId" : { - "type" : "string", - "description" : "The UUID of the Process Group that this component is in" - }, - "id" : { - "type" : "string", - "description" : "The UUID of this component" - }, - "referenceType" : { - "type" : "string", - "description" : "The type of this component", - "enum" : [ "PROCESSOR", "CONTROLLER_SERVICE", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT" ] - }, - "name" : { - "type" : "string", - "description" : "The name of this component." - }, - "state" : { - "type" : "string", - "description" : "The scheduled state of a processor or reporting task referencing a controller service. If this component is another controller service, this field represents the controller service state." - }, - "activeThreadCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of active threads for the referencing component." - }, - "validationErrors" : { - "type" : "array", - "description" : "The validation errors for the component.", - "items" : { - "type" : "string" - } - } - } - }, - "AffectedComponentEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "component" : { - "$ref" : "#/definitions/AffectedComponentDTO" - }, - "processGroup" : { - "description" : "The Process Group that the component belongs to", - "$ref" : "#/definitions/ProcessGroupNameDTO" - }, - "referenceType" : { - "type" : "string", - "description" : "The type of component referenced", - "enum" : [ "PROCESSOR", "CONTROLLER_SERVICE", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT" ] - } - }, - "xml" : { - "name" : "affectedComponentEntity" - } - }, - "AllowableValueDTO" : { - "type" : "object", - "properties" : { - "displayName" : { - "type" : "string", - "description" : "A human readable value that is allowed for the property descriptor." - }, - "value" : { - "type" : "string", - "description" : "A value that is allowed for the property descriptor." - }, - "description" : { - "type" : "string", - "description" : "A description for this allowable value." - } - } - }, - "AllowableValueEntity" : { - "type" : "object", - "properties" : { - "allowableValue" : { - "$ref" : "#/definitions/AllowableValueDTO" - }, - "canRead" : { - "type" : "boolean", - "description" : "Indicates whether the user can read a given resource.", - "readOnly" : true - } - }, - "xml" : { - "name" : "entity" - } - }, - "Attribute" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The name of the attribute" - }, - "description" : { - "type" : "string", - "description" : "The description of the attribute" - } - } - }, - "AttributeDTO" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The attribute name." - }, - "value" : { - "type" : "string", - "description" : "The attribute value." - }, - "previousValue" : { - "type" : "string", - "description" : "The value of the attribute before the event took place." - } - } - }, - "BannerDTO" : { - "type" : "object", - "properties" : { - "headerText" : { - "type" : "string", - "description" : "The header text." - }, - "footerText" : { - "type" : "string", - "description" : "The footer text." - } - } - }, - "BannerEntity" : { - "type" : "object", - "properties" : { - "banners" : { - "$ref" : "#/definitions/BannerDTO" - } - }, - "xml" : { - "name" : "bannersEntity" - } - }, - "BatchSettingsDTO" : { - "type" : "object", - "properties" : { - "count" : { - "type" : "integer", - "format" : "int32", - "description" : "Preferred number of flow files to include in a transaction." - }, - "size" : { - "type" : "string", - "description" : "Preferred number of bytes to include in a transaction." - }, - "duration" : { - "type" : "string", - "description" : "Preferred amount of time that a transaction should span." - } - } - }, - "BatchSize" : { - "type" : "object", - "properties" : { - "count" : { - "type" : "integer", - "format" : "int32", - "description" : "Preferred number of flow files to include in a transaction." - }, - "size" : { - "type" : "string", - "description" : "Preferred number of bytes to include in a transaction." - }, - "duration" : { - "type" : "string", - "description" : "Preferred amount of time that a transaction should span." - } - } - }, - "BuildInfo" : { - "type" : "object", - "properties" : { - "version" : { - "type" : "string", - "description" : "The version number of the built component." - }, - "revision" : { - "type" : "string", - "description" : "The SCM revision id of the source code used for this build." - }, - "timestamp" : { - "type" : "integer", - "format" : "int64", - "description" : "The timestamp (milliseconds since Epoch) of the build." - }, - "targetArch" : { - "type" : "string", - "description" : "The target architecture of the built component." - }, - "compiler" : { - "type" : "string", - "description" : "The compiler used for the build" - }, - "compilerFlags" : { - "type" : "string", - "description" : "The compiler flags used for the build." - } - } - }, - "BulletinBoardDTO" : { - "type" : "object", - "properties" : { - "bulletins" : { - "type" : "array", - "description" : "The bulletins in the bulletin board, that matches the supplied request.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "generated" : { - "type" : "string", - "description" : "The timestamp when this report was generated." - } - } - }, - "BulletinBoardEntity" : { - "type" : "object", - "properties" : { - "bulletinBoard" : { - "$ref" : "#/definitions/BulletinBoardDTO" - } - }, - "xml" : { - "name" : "bulletinBoardEntity" - } - }, - "BulletinDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "integer", - "format" : "int64", - "description" : "The id of the bulletin." - }, - "nodeAddress" : { - "type" : "string", - "description" : "If clustered, the address of the node from which the bulletin originated." - }, - "category" : { - "type" : "string", - "description" : "The category of this bulletin." - }, - "groupId" : { - "type" : "string", - "description" : "The group id of the source component." - }, - "sourceId" : { - "type" : "string", - "description" : "The id of the source component." - }, - "sourceName" : { - "type" : "string", - "description" : "The name of the source component." - }, - "level" : { - "type" : "string", - "description" : "The level of the bulletin." - }, - "message" : { - "type" : "string", - "description" : "The bulletin message." - }, - "timestamp" : { - "type" : "string", - "description" : "When this bulletin was generated." - } - } - }, - "BulletinEntity" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "integer", - "format" : "int64" - }, - "groupId" : { - "type" : "string" - }, - "sourceId" : { - "type" : "string" - }, - "timestamp" : { - "type" : "string", - "description" : "When this bulletin was generated." - }, - "nodeAddress" : { - "type" : "string" - }, - "canRead" : { - "type" : "boolean", - "description" : "Indicates whether the user can read a given resource.", - "readOnly" : true - }, - "bulletin" : { - "$ref" : "#/definitions/BulletinDTO" - } - }, - "xml" : { - "name" : "bulletinEntity" - } - }, - "Bundle" : { - "type" : "object", - "properties" : { - "group" : { - "type" : "string", - "description" : "The group of the bundle" - }, - "artifact" : { - "type" : "string", - "description" : "The artifact of the bundle" - }, - "version" : { - "type" : "string", - "description" : "The version of the bundle" - } - } - }, - "BundleDTO" : { - "type" : "object", - "properties" : { - "group" : { - "type" : "string", - "description" : "The group of the bundle." - }, - "artifact" : { - "type" : "string", - "description" : "The artifact of the bundle." - }, - "version" : { - "type" : "string", - "description" : "The version of the bundle." - } - } - }, - "ClassLoaderDiagnosticsDTO" : { - "type" : "object", - "properties" : { - "bundle" : { - "description" : "Information about the Bundle that the ClassLoader belongs to, if any", - "$ref" : "#/definitions/BundleDTO" - }, - "parentClassLoader" : { - "description" : "A ClassLoaderDiagnosticsDTO that provides information about the parent ClassLoader", - "$ref" : "#/definitions/ClassLoaderDiagnosticsDTO" - } - } - }, - "ClusteSummaryEntity" : { - "type" : "object", - "properties" : { - "clusterSummary" : { - "$ref" : "#/definitions/ClusterSummaryDTO" - } - }, - "xml" : { - "name" : "clusterSummaryEntity" - } - }, - "ClusterDTO" : { - "type" : "object", - "properties" : { - "nodes" : { - "type" : "array", - "description" : "The collection of nodes that are part of the cluster.", - "items" : { - "$ref" : "#/definitions/NodeDTO" - } - }, - "generated" : { - "type" : "string", - "description" : "The timestamp the report was generated." - } - } - }, - "ClusterEntity" : { - "type" : "object", - "properties" : { - "cluster" : { - "$ref" : "#/definitions/ClusterDTO" - } - }, - "xml" : { - "name" : "clusterEntity" - } - }, - "ClusterSearchResultsEntity" : { - "type" : "object", - "properties" : { - "nodeResults" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/NodeSearchResultDTO" - } - } - }, - "xml" : { - "name" : "clusterSearchResultsEntity" - } - }, - "ClusterSummaryDTO" : { - "type" : "object", - "properties" : { - "connectedNodes" : { - "type" : "string", - "description" : "When clustered, reports the number of nodes connected vs the number of nodes in the cluster." - }, - "connectedNodeCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of nodes that are currently connected to the cluster" - }, - "totalNodeCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of nodes in the cluster, regardless of whether or not they are connected" - }, - "clustered" : { - "type" : "boolean", - "description" : "Whether this NiFi instance is clustered." - }, - "connectedToCluster" : { - "type" : "boolean", - "description" : "Whether this NiFi instance is connected to a cluster." - } - } - }, - "ComponentDetailsDTO" : { - "type" : "object" - }, - "ComponentDifferenceDTO" : { - "type" : "object", - "properties" : { - "componentType" : { - "type" : "string", - "description" : "The type of component" - }, - "componentId" : { - "type" : "string", - "description" : "The ID of the component" - }, - "componentName" : { - "type" : "string", - "description" : "The name of the component" - }, - "processGroupId" : { - "type" : "string", - "description" : "The ID of the Process Group that the component belongs to" - }, - "differences" : { - "type" : "array", - "description" : "The differences in the component between the two flows", - "items" : { - "$ref" : "#/definitions/DifferenceDTO" - } - } - } - }, - "ComponentHistoryDTO" : { - "type" : "object", - "properties" : { - "componentId" : { - "type" : "string", - "description" : "The component id." - }, - "propertyHistory" : { - "type" : "object", - "description" : "The history for the properties of the component.", - "additionalProperties" : { - "$ref" : "#/definitions/PropertyHistoryDTO" - } - } - } - }, - "ComponentHistoryEntity" : { - "type" : "object", - "properties" : { - "componentHistory" : { - "$ref" : "#/definitions/ComponentHistoryDTO" - } - }, - "xml" : { - "name" : "componentHistoryEntity" - } - }, - "ComponentLifecycle" : { - "type" : "object" - }, - "ComponentManifest" : { - "type" : "object", - "properties" : { - "apis" : { - "type" : "array", - "description" : "Public interfaces defined in this bundle", - "items" : { - "$ref" : "#/definitions/DefinedType" - } - }, - "controllerServices" : { - "type" : "array", - "description" : "Controller Services provided in this bundle", - "items" : { - "$ref" : "#/definitions/ControllerServiceDefinition" - } - }, - "processors" : { - "type" : "array", - "description" : "Processors provided in this bundle", - "items" : { - "$ref" : "#/definitions/ProcessorDefinition" - } - }, - "reportingTasks" : { - "type" : "array", - "description" : "Reporting Tasks provided in this bundle", - "items" : { - "$ref" : "#/definitions/ReportingTaskDefinition" - } - } - } - }, - "ComponentReferenceDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "versionedComponentId" : { - "type" : "string", - "description" : "The ID of the corresponding component that is under version control" - }, - "parentGroupId" : { - "type" : "string", - "description" : "The id of parent process group of this component if applicable." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "name" : { - "type" : "string", - "description" : "The name of the component." - } - } - }, - "ComponentReferenceEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "parentGroupId" : { - "type" : "string", - "description" : "The id of parent process group of this component if applicable." - }, - "component" : { - "$ref" : "#/definitions/ComponentReferenceDTO" - } - }, - "xml" : { - "name" : "componentReferenceEntity" - } - }, - "ComponentRestrictionPermissionDTO" : { - "type" : "object", - "properties" : { - "requiredPermission" : { - "description" : "The required permission necessary for this restriction.", - "$ref" : "#/definitions/RequiredPermissionDTO" - }, - "permissions" : { - "description" : "The permissions for this component restriction. Note: the read permission are not used and will always be false.", - "$ref" : "#/definitions/PermissionsDTO" - } - } - }, - "ComponentSearchResultDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component that matched the search." - }, - "groupId" : { - "type" : "string", - "description" : "The group id of the component that matched the search." - }, - "parentGroup" : { - "description" : "The parent group of the component that matched the search.", - "$ref" : "#/definitions/SearchResultGroupDTO" - }, - "versionedGroup" : { - "description" : "The nearest versioned ancestor group of the component that matched the search.", - "$ref" : "#/definitions/SearchResultGroupDTO" - }, - "name" : { - "type" : "string", - "description" : "The name of the component that matched the search." - }, - "matches" : { - "type" : "array", - "description" : "What matched the search from the component.", - "items" : { - "type" : "string" - } - } - } - }, - "ComponentStateDTO" : { - "type" : "object", - "properties" : { - "componentId" : { - "type" : "string", - "description" : "The component identifier." - }, - "stateDescription" : { - "type" : "string", - "description" : "Description of the state this component persists." - }, - "clusterState" : { - "description" : "The cluster state for this component, or null if this NiFi is a standalone instance.", - "$ref" : "#/definitions/StateMapDTO" - }, - "localState" : { - "description" : "The local state for this component.", - "$ref" : "#/definitions/StateMapDTO" - } - } - }, - "ComponentStateEntity" : { - "type" : "object", - "properties" : { - "componentState" : { - "description" : "The component state.", - "$ref" : "#/definitions/ComponentStateDTO" - } - }, - "xml" : { - "name" : "componentStateEntity" - } - }, - "ComponentValidationResultDTO" : { - "type" : "object", - "properties" : { - "processGroupId" : { - "type" : "string", - "description" : "The UUID of the Process Group that this component is in" - }, - "id" : { - "type" : "string", - "description" : "The UUID of this component" - }, - "referenceType" : { - "type" : "string", - "description" : "The type of this component", - "enum" : [ "PROCESSOR", "CONTROLLER_SERVICE", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT" ] - }, - "name" : { - "type" : "string", - "description" : "The name of this component." - }, - "state" : { - "type" : "string", - "description" : "The scheduled state of a processor or reporting task referencing a controller service. If this component is another controller service, this field represents the controller service state." - }, - "activeThreadCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of active threads for the referencing component." - }, - "validationErrors" : { - "type" : "array", - "description" : "The validation errors for the component.", - "items" : { - "type" : "string" - } - }, - "currentlyValid" : { - "type" : "boolean", - "description" : "Whether or not the component is currently valid" - }, - "resultsValid" : { - "type" : "boolean", - "description" : "Whether or not the component will be valid if the Parameter Context is changed" - }, - "resultantValidationErrors" : { - "type" : "array", - "description" : "The validation errors that will apply to the component if the Parameter Context is changed", - "items" : { - "type" : "string" - } - } - } - }, - "ComponentValidationResultEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "component" : { - "$ref" : "#/definitions/ComponentValidationResultDTO" - } - }, - "xml" : { - "name" : "componentValidationResultEntity" - } - }, - "ComponentValidationResultsEntity" : { - "type" : "object", - "properties" : { - "validationResults" : { - "type" : "array", - "description" : "A List of ComponentValidationResultEntity, one for each component that is validated", - "items" : { - "$ref" : "#/definitions/ComponentValidationResultEntity" - } - } - }, - "xml" : { - "name" : "componentValidationResults" - } - }, - "ConfigVerificationResultDTO" : { - "type" : "object", - "properties" : { - "outcome" : { - "type" : "string", - "description" : "The outcome of the verification", - "enum" : [ "SUCCESSFUL", "FAILED", "SKIPPED" ] - }, - "verificationStepName" : { - "type" : "string", - "description" : "The name of the verification step" - }, - "explanation" : { - "type" : "string", - "description" : "An explanation of why the step was or was not successful" - } - } - }, - "ConfigurationAnalysisDTO" : { - "type" : "object", - "properties" : { - "componentId" : { - "type" : "string", - "description" : "The ID of the component" - }, - "properties" : { - "type" : "object", - "description" : "The configured properties for the component", - "additionalProperties" : { - "type" : "string" - } - }, - "referencedAttributes" : { - "type" : "object", - "description" : "The attributes that are referenced by the properties, mapped to recently used values", - "additionalProperties" : { - "type" : "string" - } - }, - "supportsVerification" : { - "type" : "boolean", - "description" : "Whether or not the component supports verification" - } - } - }, - "ConfigurationAnalysisEntity" : { - "type" : "object", - "properties" : { - "configurationAnalysis" : { - "description" : "The configuration analysis", - "$ref" : "#/definitions/ConfigurationAnalysisDTO" - } - }, - "xml" : { - "name" : "configurationAnalysis" - } - }, - "ConnectableComponent" : { - "type" : "object", - "required" : [ "groupId", "id", "type" ], - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the connectable component." - }, - "type" : { - "type" : "string", - "description" : "The type of component the connectable is.", - "enum" : [ "PROCESSOR", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "INPUT_PORT", "OUTPUT_PORT", "FUNNEL" ] - }, - "groupId" : { - "type" : "string", - "description" : "The id of the group that the connectable component resides in" - }, - "name" : { - "type" : "string", - "description" : "The name of the connectable component" - }, - "comments" : { - "type" : "string", - "description" : "The comments for the connectable component." - }, - "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" - } - } - }, - "ConnectableDTO" : { - "type" : "object", - "required" : [ "groupId", "id", "type" ], - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the connectable component." - }, - "versionedComponentId" : { - "type" : "string", - "description" : "The ID of the corresponding component that is under version control" - }, - "type" : { - "type" : "string", - "description" : "The type of component the connectable is.", - "enum" : [ "PROCESSOR", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "INPUT_PORT", "OUTPUT_PORT", "FUNNEL" ] - }, - "groupId" : { - "type" : "string", - "description" : "The id of the group that the connectable component resides in" - }, - "name" : { - "type" : "string", - "description" : "The name of the connectable component" - }, - "running" : { - "type" : "boolean", - "description" : "Reflects the current state of the connectable component." - }, - "transmitting" : { - "type" : "boolean", - "description" : "If the connectable component represents a remote port, indicates if the target is configured to transmit." - }, - "exists" : { - "type" : "boolean", - "description" : "If the connectable component represents a remote port, indicates if the target exists." - }, - "comments" : { - "type" : "string", - "description" : "The comments for the connectable component." - } - } - }, - "ConnectionDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "versionedComponentId" : { - "type" : "string", - "description" : "The ID of the corresponding component that is under version control" - }, - "parentGroupId" : { - "type" : "string", - "description" : "The id of parent process group of this component if applicable." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "source" : { - "description" : "The source of the connection.", - "$ref" : "#/definitions/ConnectableDTO" - }, - "destination" : { - "description" : "The destination of the connection.", - "$ref" : "#/definitions/ConnectableDTO" - }, - "name" : { - "type" : "string", - "description" : "The name of the connection." - }, - "labelIndex" : { - "type" : "integer", - "format" : "int32", - "description" : "The index of the bend point where to place the connection label." - }, - "getzIndex" : { - "type" : "integer", - "format" : "int64", - "description" : "The z index of the connection." - }, - "selectedRelationships" : { - "type" : "array", - "description" : "The selected relationship that comprise the connection.", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - }, - "availableRelationships" : { - "type" : "array", - "description" : "The relationships that the source of the connection currently supports.", - "readOnly" : true, - "uniqueItems" : true, - "items" : { - "type" : "string" - } - }, - "backPressureObjectThreshold" : { - "type" : "integer", - "format" : "int64", - "description" : "The object count threshold for determining when back pressure is applied. Updating this value is a passive change in the sense that it won't impact whether existing files over the limit are affected but it does help feeder processors to stop pushing too much into this work queue." - }, - "backPressureDataSizeThreshold" : { - "type" : "string", - "description" : "The object data size threshold for determining when back pressure is applied. Updating this value is a passive change in the sense that it won't impact whether existing files over the limit are affected but it does help feeder processors to stop pushing too much into this work queue." - }, - "flowFileExpiration" : { - "type" : "string", - "description" : "The amount of time a flow file may be in the flow before it will be automatically aged out of the flow. Once a flow file reaches this age it will be terminated from the flow the next time a processor attempts to start work on it." - }, - "prioritizers" : { - "type" : "array", - "description" : "The comparators used to prioritize the queue.", - "items" : { - "type" : "string" - } - }, - "bends" : { - "type" : "array", - "description" : "The bend points on the connection.", - "items" : { - "$ref" : "#/definitions/PositionDTO" - } - }, - "loadBalanceStrategy" : { - "type" : "string", - "description" : "How to load balance the data in this Connection across the nodes in the cluster.", - "enum" : [ "DO_NOT_LOAD_BALANCE", "PARTITION_BY_ATTRIBUTE", "ROUND_ROBIN", "SINGLE_NODE" ] - }, - "loadBalancePartitionAttribute" : { - "type" : "string", - "description" : "The FlowFile Attribute to use for determining which node a FlowFile will go to if the Load Balancing Strategy is set to PARTITION_BY_ATTRIBUTE" - }, - "loadBalanceCompression" : { - "type" : "string", - "description" : "Whether or not data should be compressed when being transferred between nodes in the cluster.", - "enum" : [ "DO_NOT_COMPRESS", "COMPRESS_ATTRIBUTES_ONLY", "COMPRESS_ATTRIBUTES_AND_CONTENT" ] - }, - "loadBalanceStatus" : { - "type" : "string", - "description" : "The current status of the Connection's Load Balancing Activities. Status can indicate that Load Balancing is not configured for the connection, that Load Balancing is configured but inactive (not currently transferring data to another node), or that Load Balancing is configured and actively transferring data to another node.", - "readOnly" : true, - "enum" : [ "LOAD_BALANCE_NOT_CONFIGURED", "LOAD_BALANCE_INACTIVE", "LOAD_BALANCE_ACTIVE" ] - } - } - }, - "ConnectionDiagnosticsDTO" : { - "type" : "object", - "properties" : { - "connection" : { - "description" : "Details about the connection", - "readOnly" : true, - "$ref" : "#/definitions/ConnectionDTO" - }, - "aggregateSnapshot" : { - "description" : "Aggregate values for all nodes in the cluster, or for this instance if not clustered", - "readOnly" : true, - "$ref" : "#/definitions/ConnectionDiagnosticsSnapshotDTO" - }, - "nodeSnapshots" : { - "type" : "array", - "description" : "A list of values for each node in the cluster, if clustered.", - "readOnly" : true, - "items" : { - "$ref" : "#/definitions/ConnectionDiagnosticsSnapshotDTO" - } - } - } - }, - "ConnectionDiagnosticsSnapshotDTO" : { - "type" : "object", - "properties" : { - "totalFlowFileCount" : { - "type" : "integer", - "format" : "int32", - "description" : "Total number of FlowFiles owned by the Connection" - }, - "totalByteCount" : { - "type" : "integer", - "format" : "int64", - "description" : "Total number of bytes that make up the content for the FlowFiles owned by this Connection" - }, - "nodeIdentifier" : { - "type" : "string", - "description" : "The Node Identifier that this information pertains to" - }, - "localQueuePartition" : { - "description" : "The local queue partition, from which components can pull FlowFiles on this node.", - "$ref" : "#/definitions/LocalQueuePartitionDTO" - }, - "remoteQueuePartitions" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/RemoteQueuePartitionDTO" - } - } - } - }, - "ConnectionEntity" : { - "type" : "object", - "required" : [ "destinationType", "sourceType" ], - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "component" : { - "$ref" : "#/definitions/ConnectionDTO" - }, - "status" : { - "description" : "The status of the connection.", - "$ref" : "#/definitions/ConnectionStatusDTO" - }, - "bends" : { - "type" : "array", - "description" : "The bend points on the connection.", - "items" : { - "$ref" : "#/definitions/PositionDTO" - } - }, - "labelIndex" : { - "type" : "integer", - "format" : "int32", - "description" : "The index of the bend point where to place the connection label." - }, - "getzIndex" : { - "type" : "integer", - "format" : "int64", - "description" : "The z index of the connection." - }, - "sourceId" : { - "type" : "string", - "description" : "The identifier of the source of this connection." - }, - "sourceGroupId" : { - "type" : "string", - "description" : "The identifier of the group of the source of this connection." - }, - "sourceType" : { - "type" : "string", - "description" : "The type of component the source connectable is.", - "enum" : [ "PROCESSOR", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "INPUT_PORT", "OUTPUT_PORT", "FUNNEL" ] - }, - "destinationId" : { - "type" : "string", - "description" : "The identifier of the destination of this connection." - }, - "destinationGroupId" : { - "type" : "string", - "description" : "The identifier of the group of the destination of this connection." - }, - "destinationType" : { - "type" : "string", - "description" : "The type of component the destination connectable is.", - "enum" : [ "PROCESSOR", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "INPUT_PORT", "OUTPUT_PORT", "FUNNEL" ] - } - }, - "xml" : { - "name" : "connectionEntity" - } - }, - "ConnectionStatisticsDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The ID of the connection" - }, - "statsLastRefreshed" : { - "type" : "string", - "description" : "The timestamp of when the stats were last refreshed" - }, - "aggregateSnapshot" : { - "description" : "The status snapshot that represents the aggregate stats of the cluster", - "$ref" : "#/definitions/ConnectionStatisticsSnapshotDTO" - }, - "nodeSnapshots" : { - "type" : "array", - "description" : "A list of status snapshots for each node", - "items" : { - "$ref" : "#/definitions/NodeConnectionStatisticsSnapshotDTO" - } - } - } - }, - "ConnectionStatisticsEntity" : { - "type" : "object", - "properties" : { - "connectionStatistics" : { - "$ref" : "#/definitions/ConnectionStatisticsDTO" - }, - "canRead" : { - "type" : "boolean", - "description" : "Indicates whether the user can read a given resource.", - "readOnly" : true - } - }, - "xml" : { - "name" : "connectionStatisticsEntity" - } - }, - "ConnectionStatisticsSnapshotDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the connection." - }, - "predictedMillisUntilCountBackpressure" : { - "type" : "integer", - "format" : "int64", - "description" : "The predicted number of milliseconds before the connection will have backpressure applied, based on the queued count." - }, - "predictedMillisUntilBytesBackpressure" : { - "type" : "integer", - "format" : "int64", - "description" : "The predicted number of milliseconds before the connection will have backpressure applied, based on the total number of bytes in the queue." - }, - "predictedCountAtNextInterval" : { - "type" : "integer", - "format" : "int32", - "description" : "The predicted number of queued objects at the next configured interval." - }, - "predictedBytesAtNextInterval" : { - "type" : "integer", - "format" : "int64", - "description" : "The predicted total number of bytes in the queue at the next configured interval." - }, - "predictedPercentCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The predicted percentage of queued objects at the next configured interval." - }, - "predictedPercentBytes" : { - "type" : "integer", - "format" : "int32", - "description" : "The predicted percentage of bytes in the queue against current threshold at the next configured interval." - }, - "predictionIntervalMillis" : { - "type" : "integer", - "format" : "int64", - "description" : "The prediction interval in seconds" - } - } - }, - "ConnectionStatusDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The ID of the connection" - }, - "groupId" : { - "type" : "string", - "description" : "The ID of the Process Group that the connection belongs to" - }, - "name" : { - "type" : "string", - "description" : "The name of the connection" - }, - "statsLastRefreshed" : { - "type" : "string", - "description" : "The timestamp of when the stats were last refreshed" - }, - "sourceId" : { - "type" : "string", - "description" : "The ID of the source component" - }, - "sourceName" : { - "type" : "string", - "description" : "The name of the source component" - }, - "destinationId" : { - "type" : "string", - "description" : "The ID of the destination component" - }, - "destinationName" : { - "type" : "string", - "description" : "The name of the destination component" - }, - "aggregateSnapshot" : { - "description" : "The status snapshot that represents the aggregate stats of the cluster", - "$ref" : "#/definitions/ConnectionStatusSnapshotDTO" - }, - "nodeSnapshots" : { - "type" : "array", - "description" : "A list of status snapshots for each node", - "items" : { - "$ref" : "#/definitions/NodeConnectionStatusSnapshotDTO" - } - } - } - }, - "ConnectionStatusEntity" : { - "type" : "object", - "properties" : { - "connectionStatus" : { - "$ref" : "#/definitions/ConnectionStatusDTO" - }, - "canRead" : { - "type" : "boolean", - "description" : "Indicates whether the user can read a given resource.", - "readOnly" : true - } - }, - "xml" : { - "name" : "connectionStatusEntity" - } - }, - "ConnectionStatusPredictionsSnapshotDTO" : { - "type" : "object", - "properties" : { - "predictedMillisUntilCountBackpressure" : { - "type" : "integer", - "format" : "int64", - "description" : "The predicted number of milliseconds before the connection will have backpressure applied, based on the queued count." - }, - "predictedMillisUntilBytesBackpressure" : { - "type" : "integer", - "format" : "int64", - "description" : "The predicted number of milliseconds before the connection will have backpressure applied, based on the total number of bytes in the queue." - }, - "predictionIntervalSeconds" : { - "type" : "integer", - "format" : "int32", - "description" : "The configured interval (in seconds) for predicting connection queue count and size (and percent usage)." - }, - "predictedCountAtNextInterval" : { - "type" : "integer", - "format" : "int32", - "description" : "The predicted number of queued objects at the next configured interval." - }, - "predictedBytesAtNextInterval" : { - "type" : "integer", - "format" : "int64", - "description" : "The predicted total number of bytes in the queue at the next configured interval." - }, - "predictedPercentCount" : { - "type" : "integer", - "format" : "int32", - "description" : "Predicted connection percent use regarding queued flow files count and backpressure threshold if configured." - }, - "predictedPercentBytes" : { - "type" : "integer", - "format" : "int32", - "description" : "Predicted connection percent use regarding queued flow files size and backpressure threshold if configured." - } - } - }, - "ConnectionStatusSnapshotDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the connection." - }, - "groupId" : { - "type" : "string", - "description" : "The id of the process group the connection belongs to." - }, - "name" : { - "type" : "string", - "description" : "The name of the connection." - }, - "sourceId" : { - "type" : "string", - "description" : "The id of the source of the connection." - }, - "sourceName" : { - "type" : "string", - "description" : "The name of the source of the connection." - }, - "destinationId" : { - "type" : "string", - "description" : "The id of the destination of the connection." - }, - "destinationName" : { - "type" : "string", - "description" : "The name of the destination of the connection." - }, - "predictions" : { - "description" : "Predictions, if available, for this connection (null if not available)", - "$ref" : "#/definitions/ConnectionStatusPredictionsSnapshotDTO" - }, - "flowFilesIn" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of FlowFiles that have come into the connection in the last 5 minutes." - }, - "bytesIn" : { - "type" : "integer", - "format" : "int64", - "description" : "The size of the FlowFiles that have come into the connection in the last 5 minutes." - }, - "input" : { - "type" : "string", - "description" : "The input count/size for the connection in the last 5 minutes, pretty printed." - }, - "flowFilesOut" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of FlowFiles that have left the connection in the last 5 minutes." - }, - "bytesOut" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes that have left the connection in the last 5 minutes." - }, - "output" : { - "type" : "string", - "description" : "The output count/sie for the connection in the last 5 minutes, pretty printed." - }, - "flowFilesQueued" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of FlowFiles that are currently queued in the connection." - }, - "bytesQueued" : { - "type" : "integer", - "format" : "int64", - "description" : "The size of the FlowFiles that are currently queued in the connection." - }, - "queued" : { - "type" : "string", - "description" : "The total count and size of queued flowfiles formatted." - }, - "queuedSize" : { - "type" : "string", - "description" : "The total size of flowfiles that are queued formatted." - }, - "queuedCount" : { - "type" : "string", - "description" : "The number of flowfiles that are queued, pretty printed." - }, - "percentUseCount" : { - "type" : "integer", - "format" : "int32", - "description" : "Connection percent use regarding queued flow files count and backpressure threshold if configured." - }, - "percentUseBytes" : { - "type" : "integer", - "format" : "int32", - "description" : "Connection percent use regarding queued flow files size and backpressure threshold if configured." - }, - "flowFileAvailability" : { - "type" : "string", - "description" : "The availability of FlowFiles in this connection" - } - } - }, - "ConnectionStatusSnapshotEntity" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the connection." - }, - "connectionStatusSnapshot" : { - "$ref" : "#/definitions/ConnectionStatusSnapshotDTO" - }, - "canRead" : { - "type" : "boolean", - "description" : "Indicates whether the user can read a given resource.", - "readOnly" : true - } - }, - "xml" : { - "name" : "entity" - } - }, - "ConnectionsEntity" : { - "type" : "object", - "properties" : { - "connections" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ConnectionEntity" - } - } - }, - "xml" : { - "name" : "connectionsEntity" - } - }, - "ControllerBulletinsEntity" : { - "type" : "object", - "properties" : { - "bulletins" : { - "type" : "array", - "description" : "System level bulletins to be reported to the user.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "controllerServiceBulletins" : { - "type" : "array", - "description" : "Controller service bulletins to be reported to the user.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "reportingTaskBulletins" : { - "type" : "array", - "description" : "Reporting task bulletins to be reported to the user.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "parameterProviderBulletins" : { - "type" : "array", - "description" : "Parameter provider bulletins to be reported to the user.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "flowRegistryClientBulletins" : { - "type" : "array", - "description" : "Flow registry client bulletins to be reported to the user.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - } - }, - "xml" : { - "name" : "controllerConfigurationEntity" - } - }, - "ControllerConfigurationDTO" : { - "type" : "object", - "properties" : { - "maxTimerDrivenThreadCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The maximum number of timer driven threads the NiFi has available." - }, - "maxEventDrivenThreadCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The maximum number of event driven threads the NiFi has available." - } - } - }, - "ControllerConfigurationEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "component" : { - "description" : "The controller configuration.", - "$ref" : "#/definitions/ControllerConfigurationDTO" - } - }, - "xml" : { - "name" : "controllerConfigurationEntity" - } - }, - "ControllerDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the NiFi." - }, - "name" : { - "type" : "string", - "description" : "The name of the NiFi." - }, - "comments" : { - "type" : "string", - "description" : "The comments for the NiFi." - }, - "runningCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of running components in the NiFi." - }, - "stoppedCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of stopped components in the NiFi." - }, - "invalidCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of invalid components in the NiFi." - }, - "disabledCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of disabled components in the NiFi." - }, - "activeRemotePortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of active remote ports contained in the NiFi." - }, - "inactiveRemotePortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of inactive remote ports contained in the NiFi." - }, - "inputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of input ports contained in the NiFi." - }, - "outputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of output ports in the NiFi." - }, - "remoteSiteListeningPort" : { - "type" : "integer", - "format" : "int32", - "description" : "The Socket Port on which this instance is listening for Remote Transfers of Flow Files. If this instance is not configured to receive Flow Files from remote instances, this will be null." - }, - "remoteSiteHttpListeningPort" : { - "type" : "integer", - "format" : "int32", - "description" : "The HTTP(S) Port on which this instance is listening for Remote Transfers of Flow Files. If this instance is not configured to receive Flow Files from remote instances, this will be null." - }, - "siteToSiteSecure" : { - "type" : "boolean", - "description" : "Indicates whether or not Site-to-Site communications with this instance is secure (2-way authentication)." - }, - "instanceId" : { - "type" : "string", - "description" : "If clustered, the id of the Cluster Manager, otherwise the id of the NiFi." - }, - "inputPorts" : { - "type" : "array", - "description" : "The input ports available to send data to for the NiFi.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/PortDTO" - } - }, - "outputPorts" : { - "type" : "array", - "description" : "The output ports available to received data from the NiFi.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/PortDTO" - } - } - } - }, - "ControllerEntity" : { - "type" : "object", - "properties" : { - "controller" : { - "$ref" : "#/definitions/ControllerDTO" - } - }, - "xml" : { - "name" : "controllerEntity" - } - }, - "ControllerServiceAPI" : { - "type" : "object", - "properties" : { - "type" : { - "type" : "string", - "description" : "The fully qualified name of the service interface." - }, - "bundle" : { - "description" : "The details of the artifact that bundled this service interface.", - "$ref" : "#/definitions/Bundle" - } - } - }, - "ControllerServiceApiDTO" : { - "type" : "object", - "properties" : { - "type" : { - "type" : "string", - "description" : "The fully qualified name of the service interface." - }, - "bundle" : { - "description" : "The details of the artifact that bundled this service interface.", - "$ref" : "#/definitions/BundleDTO" - } - } - }, - "ControllerServiceDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "versionedComponentId" : { - "type" : "string", - "description" : "The ID of the corresponding component that is under version control" - }, - "parentGroupId" : { - "type" : "string", - "description" : "The id of parent process group of this component if applicable." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "name" : { - "type" : "string", - "description" : "The name of the controller service." - }, - "type" : { - "type" : "string", - "description" : "The type of the controller service." - }, - "bundle" : { - "description" : "The details of the artifact that bundled this processor type.", - "$ref" : "#/definitions/BundleDTO" - }, - "controllerServiceApis" : { - "type" : "array", - "description" : "Lists the APIs this Controller Service implements.", - "items" : { - "$ref" : "#/definitions/ControllerServiceApiDTO" - } - }, - "comments" : { - "type" : "string", - "description" : "The comments for the controller service." - }, - "state" : { - "type" : "string", - "description" : "The state of the controller service.", - "enum" : [ "ENABLED", "ENABLING", "DISABLED", "DISABLING" ] - }, - "persistsState" : { - "type" : "boolean", - "description" : "Whether the controller service persists state." - }, - "restricted" : { - "type" : "boolean", - "description" : "Whether the controller service requires elevated privileges." - }, - "deprecated" : { - "type" : "boolean", - "description" : "Whether the ontroller service has been deprecated." - }, - "multipleVersionsAvailable" : { - "type" : "boolean", - "description" : "Whether the controller service has multiple versions available." - }, - "supportsSensitiveDynamicProperties" : { - "type" : "boolean", - "description" : "Whether the controller service supports sensitive dynamic properties." - }, - "properties" : { - "type" : "object", - "description" : "The properties of the controller service.", - "additionalProperties" : { - "type" : "string" - } - }, - "descriptors" : { - "type" : "object", - "description" : "The descriptors for the controller service properties.", - "additionalProperties" : { - "$ref" : "#/definitions/PropertyDescriptorDTO" - } - }, - "sensitiveDynamicPropertyNames" : { - "type" : "array", - "description" : "Set of sensitive dynamic property names", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - }, - "customUiUrl" : { - "type" : "string", - "description" : "The URL for the controller services custom configuration UI if applicable." - }, - "annotationData" : { - "type" : "string", - "description" : "The annotation for the controller service. This is how the custom UI relays configuration to the controller service." - }, - "referencingComponents" : { - "type" : "array", - "description" : "All components referencing this controller service.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ControllerServiceReferencingComponentEntity" - } - }, - "validationErrors" : { - "type" : "array", - "description" : "The validation errors from the controller service. These validation errors represent the problems with the controller service that must be resolved before it can be enabled.", - "items" : { - "type" : "string" - } - }, - "validationStatus" : { - "type" : "string", - "description" : "Indicates whether the ControllerService is valid, invalid, or still in the process of validating (i.e., it is unknown whether or not the ControllerService is valid)", - "readOnly" : true, - "enum" : [ "VALID", "INVALID", "VALIDATING" ] - }, - "bulletinLevel" : { - "type" : "string", - "description" : "The level at which the controller service will report bulletins." - }, - "extensionMissing" : { - "type" : "boolean", - "description" : "Whether the underlying extension is missing." - } - } - }, - "ControllerServiceDefinition" : { - "type" : "object", - "required" : [ "type" ], - "properties" : { - "group" : { - "type" : "string", - "description" : "The group name of the bundle that provides the referenced type." - }, - "artifact" : { - "type" : "string", - "description" : "The artifact name of the bundle that provides the referenced type." - }, - "version" : { - "type" : "string", - "description" : "The version 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." - }, - "buildInfo" : { - "description" : "The build metadata for this component", - "$ref" : "#/definitions/BuildInfo" - }, - "providedApiImplementations" : { - "type" : "array", - "description" : "If this type represents a provider for an interface, this lists the APIs it implements", - "items" : { - "$ref" : "#/definitions/DefinedType" - } - }, - "tags" : { - "type" : "array", - "description" : "The tags associated with this type", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - }, - "seeAlso" : { - "type" : "array", - "description" : "The names of other component types that may be related", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - }, - "deprecated" : { - "type" : "boolean", - "description" : "Whether or not the component has been deprecated" - }, - "deprecationReason" : { - "type" : "string", - "description" : "If this component has been deprecated, this optional field can be used to provide an explanation" - }, - "deprecationAlternatives" : { - "type" : "array", - "description" : "If this component has been deprecated, this optional field provides alternatives to use", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - }, - "restricted" : { - "type" : "boolean", - "description" : "Whether or not the component has a general restriction" - }, - "restrictedExplanation" : { - "type" : "string", - "description" : "An optional description of the general restriction" - }, - "explicitRestrictions" : { - "type" : "array", - "description" : "Explicit restrictions that indicate a require permission to use the component", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/Restriction" - } - }, - "stateful" : { - "description" : "Indicates if the component stores state", - "$ref" : "#/definitions/Stateful" - }, - "systemResourceConsiderations" : { - "type" : "array", - "description" : "The system resource considerations for the given component", - "items" : { - "$ref" : "#/definitions/SystemResourceConsideration" - } - }, - "additionalDetails" : { - "type" : "boolean", - "description" : "Indicates if the component has additional details documentation" - }, - "propertyDescriptors" : { - "type" : "object", - "description" : "Descriptions of configuration properties applicable to this component.", - "additionalProperties" : { - "$ref" : "#/definitions/PropertyDescriptor" - } - }, - "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." - }, - "dynamicProperties" : { - "type" : "array", - "description" : "Describes the dynamic properties supported by this component", - "items" : { - "$ref" : "#/definitions/DynamicProperty" - } - } - } - }, - "ControllerServiceDiagnosticsDTO" : { - "type" : "object", - "properties" : { - "controllerService" : { - "description" : "The Controller Service", - "$ref" : "#/definitions/ControllerServiceEntity" - }, - "classLoaderDiagnostics" : { - "description" : "Information about the Controller Service's Class Loader", - "$ref" : "#/definitions/ClassLoaderDiagnosticsDTO" - } - } - }, - "ControllerServiceEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "parentGroupId" : { - "type" : "string", - "description" : "The id of parent process group of this ControllerService." - }, - "component" : { - "$ref" : "#/definitions/ControllerServiceDTO" - }, - "operatePermissions" : { - "description" : "The permissions for this component operations.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "status" : { - "description" : "The status for this ControllerService.", - "readOnly" : true, - "$ref" : "#/definitions/ControllerServiceStatusDTO" - } - }, - "xml" : { - "name" : "controllerServiceEntity" - } - }, - "ControllerServiceReferencingComponentDTO" : { - "type" : "object", - "properties" : { - "groupId" : { - "type" : "string", - "description" : "The group id for the component referencing a controller service. If this component is another controller service or a reporting task, this field is blank." - }, - "id" : { - "type" : "string", - "description" : "The id of the component referencing a controller service." - }, - "name" : { - "type" : "string", - "description" : "The name of the component referencing a controller service." - }, - "type" : { - "type" : "string", - "description" : "The type of the component referencing a controller service in simple Java class name format without package name." - }, - "state" : { - "type" : "string", - "description" : "The scheduled state of a processor or reporting task referencing a controller service. If this component is another controller service, this field represents the controller service state." - }, - "properties" : { - "type" : "object", - "description" : "The properties for the component.", - "additionalProperties" : { - "type" : "string" - } - }, - "descriptors" : { - "type" : "object", - "description" : "The descriptors for the component properties.", - "additionalProperties" : { - "$ref" : "#/definitions/PropertyDescriptorDTO" - } - }, - "validationErrors" : { - "type" : "array", - "description" : "The validation errors for the component.", - "items" : { - "type" : "string" - } - }, - "referenceType" : { - "type" : "string", - "description" : "The type of reference this is.", - "enum" : [ "Processor", "ControllerService", "ReportingTask", "FlowRegistryClient" ] - }, - "activeThreadCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of active threads for the referencing component." - }, - "referenceCycle" : { - "type" : "boolean", - "description" : "If the referencing component represents a controller service, this indicates whether it has already been represented in this hierarchy." - }, - "referencingComponents" : { - "type" : "array", - "description" : "If the referencing component represents a controller service, these are the components that reference it.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ControllerServiceReferencingComponentEntity" - } - } - } - }, - "ControllerServiceReferencingComponentEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "component" : { - "$ref" : "#/definitions/ControllerServiceReferencingComponentDTO" - }, - "operatePermissions" : { - "description" : "The permissions for this component operations.", - "$ref" : "#/definitions/PermissionsDTO" - } - }, - "xml" : { - "name" : "controllerServiceReferencingComponentEntity" - } - }, - "ControllerServiceReferencingComponentsEntity" : { - "type" : "object", - "properties" : { - "controllerServiceReferencingComponents" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ControllerServiceReferencingComponentEntity" - } - } - }, - "xml" : { - "name" : "controllerServiceReferencingComponentsEntity" - } - }, - "ControllerServiceRunStatusEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "state" : { - "type" : "string", - "description" : "The run status of the ControllerService.", - "enum" : [ "ENABLED", "DISABLED" ] - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "uiOnly" : { - "type" : "boolean", - "description" : "Indicates whether or not responses should only include fields necessary for rendering the NiFi User Interface. As such, when this value is set to true, some fields may be returned as null values, and the selected fields may change at any time without notice. As a result, this value should not be set to true by any client other than the UI." - } - }, - "xml" : { - "name" : "entity" - } - }, - "ControllerServiceStatusDTO" : { - "type" : "object", - "properties" : { - "runStatus" : { - "type" : "string", - "description" : "The run status of this ControllerService", - "readOnly" : true, - "enum" : [ "ENABLED", "ENABLING", "DISABLED", "DISABLING" ] - }, - "validationStatus" : { - "type" : "string", - "description" : "Indicates whether the component is valid, invalid, or still in the process of validating (i.e., it is unknown whether or not the component is valid)", - "readOnly" : true, - "enum" : [ "VALID", "INVALID", "VALIDATING" ] - }, - "activeThreadCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of active threads for the component." - } - } - }, - "ControllerServiceTypesEntity" : { - "type" : "object", - "properties" : { - "controllerServiceTypes" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/DocumentedTypeDTO" - } - } - }, - "xml" : { - "name" : "controllerServiceTypesEntity" - } - }, - "ControllerServicesEntity" : { - "type" : "object", - "properties" : { - "currentTime" : { - "type" : "string", - "description" : "The current time on the system." - }, - "controllerServices" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ControllerServiceEntity" - } - } - }, - "xml" : { - "name" : "controllerServicesEntity" - } - }, - "ControllerStatusDTO" : { - "type" : "object", - "properties" : { - "activeThreadCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of active threads in the NiFi." - }, - "terminatedThreadCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of terminated threads in the NiFi." - }, - "queued" : { - "type" : "string", - "description" : "The number of flowfiles queued in the NiFi." - }, - "flowFilesQueued" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of FlowFiles queued across the entire flow" - }, - "bytesQueued" : { - "type" : "integer", - "format" : "int64", - "description" : "The size of the FlowFiles queued across the entire flow" - }, - "runningCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of running components in the NiFi." - }, - "stoppedCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of stopped components in the NiFi." - }, - "invalidCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of invalid components in the NiFi." - }, - "disabledCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of disabled components in the NiFi." - }, - "activeRemotePortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of active remote ports in the NiFi." - }, - "inactiveRemotePortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of inactive remote ports in the NiFi." - }, - "upToDateCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of up to date versioned process groups in the NiFi." - }, - "locallyModifiedCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of locally modified versioned process groups in the NiFi." - }, - "staleCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of stale versioned process groups in the NiFi." - }, - "locallyModifiedAndStaleCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of locally modified and stale versioned process groups in the NiFi." - }, - "syncFailureCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of versioned process groups in the NiFi that are unable to sync to a registry." - } - } - }, - "ControllerStatusEntity" : { - "type" : "object", - "properties" : { - "controllerStatus" : { - "$ref" : "#/definitions/ControllerStatusDTO" - } - }, - "xml" : { - "name" : "controllerStatusEntity" - } - }, - "CopySnippetRequestEntity" : { - "type" : "object", - "properties" : { - "snippetId" : { - "type" : "string", - "description" : "The identifier of the snippet." - }, - "originX" : { - "type" : "number", - "format" : "double", - "description" : "The x coordinate of the origin of the bounding box where the new components will be placed." - }, - "originY" : { - "type" : "number", - "format" : "double", - "description" : "The y coordinate of the origin of the bounding box where the new components will be placed." - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - } - }, - "xml" : { - "name" : "copySnippetRequestEntity" - } - }, - "CounterDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the counter." - }, - "context" : { - "type" : "string", - "description" : "The context of the counter." - }, - "name" : { - "type" : "string", - "description" : "The name of the counter." - }, - "valueCount" : { - "type" : "integer", - "format" : "int64", - "description" : "The value count." - }, - "value" : { - "type" : "string", - "description" : "The value of the counter." - } - } - }, - "CounterEntity" : { - "type" : "object", - "properties" : { - "counter" : { - "$ref" : "#/definitions/CounterDTO" - } - }, - "xml" : { - "name" : "counterEntity" - } - }, - "CountersDTO" : { - "type" : "object", - "properties" : { - "aggregateSnapshot" : { - "description" : "A Counters snapshot that represents the aggregate values of all nodes in the cluster. If the NiFi instance is a standalone instance, rather than a cluster, this represents the stats of the single instance.", - "$ref" : "#/definitions/CountersSnapshotDTO" - }, - "nodeSnapshots" : { - "type" : "array", - "description" : "A Counters snapshot for each node in the cluster. If the NiFi instance is a standalone instance, rather than a cluster, this may be null.", - "items" : { - "$ref" : "#/definitions/NodeCountersSnapshotDTO" - } - } - } - }, - "CountersEntity" : { - "type" : "object", - "properties" : { - "counters" : { - "$ref" : "#/definitions/CountersDTO" - } - }, - "xml" : { - "name" : "countersEntity" - } - }, - "CountersSnapshotDTO" : { - "type" : "object", - "properties" : { - "generated" : { - "type" : "string", - "description" : "The timestamp when the report was generated." - }, - "counters" : { - "type" : "array", - "description" : "All counters in the NiFi.", - "items" : { - "$ref" : "#/definitions/CounterDTO" - } - } - } - }, - "CreateActiveRequestEntity" : { - "type" : "object", - "properties" : { - "processGroupId" : { - "type" : "string", - "description" : "The Process Group ID that this active request will update" - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - } - }, - "xml" : { - "name" : "createActiveRequestEntity" - } - }, - "CreateTemplateRequestEntity" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The name of the template." - }, - "description" : { - "type" : "string", - "description" : "The description of the template." - }, - "snippetId" : { - "type" : "string", - "description" : "The identifier of the snippet." - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - } - }, - "xml" : { - "name" : "createTemplateRequestEntity" - } - }, - "CurrentUserEntity" : { - "type" : "object", - "properties" : { - "identity" : { - "type" : "string", - "description" : "The user identity being serialized." - }, - "anonymous" : { - "type" : "boolean", - "description" : "Whether the current user is anonymous." - }, - "provenancePermissions" : { - "description" : "Permissions for querying provenance.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "countersPermissions" : { - "description" : "Permissions for accessing counters.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "tenantsPermissions" : { - "description" : "Permissions for accessing tenants.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "controllerPermissions" : { - "description" : "Permissions for accessing the controller.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "policiesPermissions" : { - "description" : "Permissions for accessing the policies.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "systemPermissions" : { - "description" : "Permissions for accessing system.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "parameterContextPermissions" : { - "description" : "Permissions for accessing parameter contexts.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "restrictedComponentsPermissions" : { - "description" : "Permissions for accessing restricted components. Note: the read permission are not used and will always be false.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "componentRestrictionPermissions" : { - "type" : "array", - "description" : "Permissions for specific component restrictions.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ComponentRestrictionPermissionDTO" - } - }, - "canVersionFlows" : { - "type" : "boolean", - "description" : "Whether the current user can version flows." - } - }, - "xml" : { - "name" : "currentEntity" - } - }, - "DefinedType" : { - "type" : "object", - "required" : [ "type" ], - "properties" : { - "group" : { - "type" : "string", - "description" : "The group name of the bundle that provides the referenced type." - }, - "artifact" : { - "type" : "string", - "description" : "The artifact name of the bundle that provides the referenced type." - }, - "version" : { - "type" : "string", - "description" : "The version 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." - } - } - }, - "DifferenceDTO" : { - "type" : "object", - "properties" : { - "differenceType" : { - "type" : "string", - "description" : "The type of difference" - }, - "difference" : { - "type" : "string", - "description" : "Description of the difference" - } - } - }, - "DimensionsDTO" : { - "type" : "object", - "properties" : { - "width" : { - "type" : "number", - "format" : "double", - "description" : "The width of the label in pixels when at a 1:1 scale." - }, - "height" : { - "type" : "number", - "format" : "double", - "description" : "The height of the label in pixels when at a 1:1 scale." - } - } - }, - "DocumentedTypeDTO" : { - "type" : "object", - "properties" : { - "type" : { - "type" : "string", - "description" : "The fully qualified name of the type." - }, - "bundle" : { - "description" : "The details of the artifact that bundled this type.", - "$ref" : "#/definitions/BundleDTO" - }, - "controllerServiceApis" : { - "type" : "array", - "description" : "If this type represents a ControllerService, this lists the APIs it implements.", - "items" : { - "$ref" : "#/definitions/ControllerServiceApiDTO" - } - }, - "description" : { - "type" : "string", - "description" : "The description of the type." - }, - "restricted" : { - "type" : "boolean", - "description" : "Whether this type is restricted." - }, - "usageRestriction" : { - "type" : "string", - "description" : "The optional description of why the usage of this component is restricted." - }, - "explicitRestrictions" : { - "type" : "array", - "description" : "An optional collection of explicit restrictions. If specified, these explicit restrictions will be enfored.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ExplicitRestrictionDTO" - } - }, - "deprecationReason" : { - "type" : "string", - "description" : "The description of why the usage of this component is restricted." - }, - "tags" : { - "type" : "array", - "description" : "The tags associated with this type.", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - } - } - }, - "DropRequestDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id for this drop request." - }, - "uri" : { - "type" : "string", - "description" : "The URI for future requests to this drop request." - }, - "submissionTime" : { - "type" : "string", - "description" : "The timestamp when the query was submitted." - }, - "lastUpdated" : { - "type" : "string", - "description" : "The last time this drop request was updated." - }, - "percentCompleted" : { - "type" : "integer", - "format" : "int32", - "description" : "The current percent complete." - }, - "finished" : { - "type" : "boolean", - "description" : "Whether the query has finished." - }, - "failureReason" : { - "type" : "string", - "description" : "The reason, if any, that this drop request failed." - }, - "currentCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of flow files currently queued." - }, - "currentSize" : { - "type" : "integer", - "format" : "int64", - "description" : "The size of flow files currently queued in bytes." - }, - "current" : { - "type" : "string", - "description" : "The count and size of flow files currently queued." - }, - "originalCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of flow files to be dropped as a result of this request." - }, - "originalSize" : { - "type" : "integer", - "format" : "int64", - "description" : "The size of flow files to be dropped as a result of this request in bytes." - }, - "original" : { - "type" : "string", - "description" : "The count and size of flow files to be dropped as a result of this request." - }, - "droppedCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of flow files that have been dropped thus far." - }, - "droppedSize" : { - "type" : "integer", - "format" : "int64", - "description" : "The size of flow files that have been dropped thus far in bytes." - }, - "dropped" : { - "type" : "string", - "description" : "The count and size of flow files that have been dropped thus far." - }, - "state" : { - "type" : "string", - "description" : "The current state of the drop request." - } - } - }, - "DropRequestEntity" : { - "type" : "object", - "properties" : { - "dropRequest" : { - "$ref" : "#/definitions/DropRequestDTO" - } - }, - "xml" : { - "name" : "dropRequestEntity" - } - }, - "DtoFactory" : { - "type" : "object" - }, - "DynamicProperty" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The description of the dynamic property name" - }, - "value" : { - "type" : "string", - "description" : "The description of the dynamic property value" - }, - "description" : { - "type" : "string", - "description" : "The description of the dynamic property" - }, - "expressionLanguageScope" : { - "type" : "string", - "description" : "The scope of the expression language support", - "enum" : [ "NONE", "VARIABLE_REGISTRY", "FLOWFILE_ATTRIBUTES" ] - } - } - }, - "DynamicRelationship" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The description of the dynamic relationship name" - }, - "description" : { - "type" : "string", - "description" : "The description of the dynamic relationship" - } - } - }, - "Entity" : { - "type" : "object", - "xml" : { - "name" : "entity" - } - }, - "ExplicitRestrictionDTO" : { - "type" : "object", - "properties" : { - "requiredPermission" : { - "description" : "The required permission necessary for this restriction.", - "$ref" : "#/definitions/RequiredPermissionDTO" - }, - "explanation" : { - "type" : "string", - "description" : "The description of why the usage of this component is restricted for this required permission." - } - } - }, - "ExternalControllerServiceReference" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The identifier of the controller service" - }, - "name" : { - "type" : "string", - "description" : "The name of the controller service" - } - } - }, - "FlowBreadcrumbDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the group." - }, - "name" : { - "type" : "string", - "description" : "The id of the group." - }, - "versionControlInformation" : { - "description" : "The process group version control information or null if not version controlled.", - "$ref" : "#/definitions/VersionControlInformationDTO" - } - } - }, - "FlowBreadcrumbEntity" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of this ancestor ProcessGroup." - }, - "permissions" : { - "description" : "The permissions for this ancestor ProcessGroup.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "versionedFlowState" : { - "type" : "string", - "description" : "The current state of the Process Group, as it relates to the Versioned Flow", - "readOnly" : true, - "enum" : [ "LOCALLY_MODIFIED", "STALE", "LOCALLY_MODIFIED_AND_STALE", "UP_TO_DATE", "SYNC_FAILURE" ] - }, - "breadcrumb" : { - "description" : "This breadcrumb.", - "$ref" : "#/definitions/FlowBreadcrumbDTO" - }, - "parentBreadcrumb" : { - "description" : "The parent breadcrumb for this breadcrumb.", - "$ref" : "#/definitions/FlowBreadcrumbEntity" - } - }, - "xml" : { - "name" : "flowEntity" - } - }, - "FlowComparisonEntity" : { - "type" : "object", - "properties" : { - "componentDifferences" : { - "type" : "array", - "description" : "The list of differences for each component in the flow that is not the same between the two flows", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ComponentDifferenceDTO" - } - } - }, - "xml" : { - "name" : "flowComparisonEntity" - } - }, - "FlowConfigurationDTO" : { - "type" : "object", - "properties" : { - "supportsManagedAuthorizer" : { - "type" : "boolean", - "description" : "Whether this NiFi supports a managed authorizer. Managed authorizers can visualize users, groups, and policies in the UI.", - "readOnly" : true - }, - "supportsConfigurableAuthorizer" : { - "type" : "boolean", - "description" : "Whether this NiFi supports a configurable authorizer.", - "readOnly" : true - }, - "supportsConfigurableUsersAndGroups" : { - "type" : "boolean", - "description" : "Whether this NiFi supports configurable users and groups.", - "readOnly" : true - }, - "autoRefreshIntervalSeconds" : { - "type" : "integer", - "format" : "int64", - "description" : "The interval in seconds between the automatic NiFi refresh requests.", - "readOnly" : true - }, - "currentTime" : { - "type" : "string", - "description" : "The current time on the system." - }, - "timeOffset" : { - "type" : "integer", - "format" : "int32", - "description" : "The time offset of the system." - }, - "defaultBackPressureObjectThreshold" : { - "type" : "integer", - "format" : "int64", - "description" : "The default back pressure object threshold." - }, - "defaultBackPressureDataSizeThreshold" : { - "type" : "string", - "description" : "The default back pressure data size threshold." - } - } - }, - "FlowConfigurationEntity" : { - "type" : "object", - "properties" : { - "flowConfiguration" : { - "description" : "The controller configuration.", - "$ref" : "#/definitions/FlowConfigurationDTO" - } - }, - "xml" : { - "name" : "flowConfigurationEntity" - } - }, - "FlowDTO" : { - "type" : "object", - "properties" : { - "processGroups" : { - "type" : "array", - "description" : "The process groups in this flow.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ProcessGroupEntity" - } - }, - "remoteProcessGroups" : { - "type" : "array", - "description" : "The remote process groups in this flow.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/RemoteProcessGroupEntity" - } - }, - "processors" : { - "type" : "array", - "description" : "The processors in this flow.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ProcessorEntity" - } - }, - "inputPorts" : { - "type" : "array", - "description" : "The input ports in this flow.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/PortEntity" - } - }, - "outputPorts" : { - "type" : "array", - "description" : "The output ports in this flow.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/PortEntity" - } - }, - "connections" : { - "type" : "array", - "description" : "The connections in this flow.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ConnectionEntity" - } - }, - "labels" : { - "type" : "array", - "description" : "The labels in this flow.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/LabelEntity" - } - }, - "funnels" : { - "type" : "array", - "description" : "The funnels in this flow.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/FunnelEntity" - } - } - } - }, - "FlowEntity" : { - "type" : "object", - "properties" : { - "flow" : { - "$ref" : "#/definitions/FlowDTO" - } - }, - "xml" : { - "name" : "flowEntity" - } - }, - "FlowFileDTO" : { - "type" : "object", - "properties" : { - "uri" : { - "type" : "string", - "description" : "The URI that can be used to access this FlowFile." - }, - "uuid" : { - "type" : "string", - "description" : "The FlowFile UUID." - }, - "filename" : { - "type" : "string", - "description" : "The FlowFile filename." - }, - "position" : { - "type" : "integer", - "format" : "int32", - "description" : "The FlowFile's position in the queue." - }, - "size" : { - "type" : "integer", - "format" : "int64", - "description" : "The FlowFile file size." - }, - "queuedDuration" : { - "type" : "integer", - "format" : "int64", - "description" : "How long this FlowFile has been enqueued." - }, - "lineageDuration" : { - "type" : "integer", - "format" : "int64", - "description" : "Duration since the FlowFile's greatest ancestor entered the flow." - }, - "penaltyExpiresIn" : { - "type" : "integer", - "format" : "int64", - "description" : "How long in milliseconds until the FlowFile penalty expires." - }, - "clusterNodeId" : { - "type" : "string", - "description" : "The id of the node where this FlowFile resides." - }, - "clusterNodeAddress" : { - "type" : "string", - "description" : "The label for the node where this FlowFile resides." - }, - "attributes" : { - "type" : "object", - "description" : "The FlowFile attributes.", - "additionalProperties" : { - "type" : "string" - } - }, - "contentClaimSection" : { - "type" : "string", - "description" : "The section in which the content claim lives." - }, - "contentClaimContainer" : { - "type" : "string", - "description" : "The container in which the content claim lives." - }, - "contentClaimIdentifier" : { - "type" : "string", - "description" : "The identifier of the content claim." - }, - "contentClaimOffset" : { - "type" : "integer", - "format" : "int64", - "description" : "The offset into the content claim where the flowfile's content begins." - }, - "contentClaimFileSize" : { - "type" : "string", - "description" : "The file size of the content claim formatted." - }, - "contentClaimFileSizeBytes" : { - "type" : "integer", - "format" : "int64", - "description" : "The file size of the content claim in bytes." - }, - "penalized" : { - "type" : "boolean", - "description" : "If the FlowFile is penalized." - } - } - }, - "FlowFileEntity" : { - "type" : "object", - "properties" : { - "flowFile" : { - "$ref" : "#/definitions/FlowFileDTO" - } - }, - "xml" : { - "name" : "flowFileEntity" - } - }, - "FlowFileSummaryDTO" : { - "type" : "object", - "properties" : { - "uri" : { - "type" : "string", - "description" : "The URI that can be used to access this FlowFile." - }, - "uuid" : { - "type" : "string", - "description" : "The FlowFile UUID." - }, - "filename" : { - "type" : "string", - "description" : "The FlowFile filename." - }, - "position" : { - "type" : "integer", - "format" : "int32", - "description" : "The FlowFile's position in the queue." - }, - "size" : { - "type" : "integer", - "format" : "int64", - "description" : "The FlowFile file size." - }, - "queuedDuration" : { - "type" : "integer", - "format" : "int64", - "description" : "How long this FlowFile has been enqueued." - }, - "lineageDuration" : { - "type" : "integer", - "format" : "int64", - "description" : "Duration since the FlowFile's greatest ancestor entered the flow." - }, - "penaltyExpiresIn" : { - "type" : "integer", - "format" : "int64", - "description" : "How long in milliseconds until the FlowFile penalty expires." - }, - "clusterNodeId" : { - "type" : "string", - "description" : "The id of the node where this FlowFile resides." - }, - "clusterNodeAddress" : { - "type" : "string", - "description" : "The label for the node where this FlowFile resides." - }, - "penalized" : { - "type" : "boolean", - "description" : "If the FlowFile is penalized." - } - } - }, - "FlowRegistryBucket" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string" - }, - "name" : { - "type" : "string" - }, - "description" : { - "type" : "string" - }, - "createdTimestamp" : { - "type" : "integer", - "format" : "int64" - }, - "permissions" : { - "$ref" : "#/definitions/FlowRegistryPermissions" - } - } - }, - "FlowRegistryBucketDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The bucket identifier" - }, - "name" : { - "type" : "string", - "description" : "The bucket name" - }, - "description" : { - "type" : "string", - "description" : "The bucket description" - }, - "created" : { - "type" : "integer", - "format" : "int64", - "description" : "The created timestamp of this bucket" - } - } - }, - "FlowRegistryBucketEntity" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string" - }, - "bucket" : { - "$ref" : "#/definitions/FlowRegistryBucketDTO" - }, - "permissions" : { - "$ref" : "#/definitions/PermissionsDTO" - } - }, - "xml" : { - "name" : "bucketEntity" - } - }, - "FlowRegistryBucketsEntity" : { - "type" : "object", - "properties" : { - "buckets" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/FlowRegistryBucketEntity" - } - } - }, - "xml" : { - "name" : "bucketsEntity" - } - }, - "FlowRegistryClientDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The registry identifier" - }, - "name" : { - "type" : "string", - "description" : "The registry name" - }, - "description" : { - "type" : "string", - "description" : "The registry description" - }, - "uri" : { - "type" : "string" - }, - "type" : { - "type" : "string", - "description" : "The type of the controller service." - }, - "bundle" : { - "description" : "The details of the artifact that bundled this processor type.", - "$ref" : "#/definitions/BundleDTO" - }, - "properties" : { - "type" : "object", - "description" : "The properties of the controller service.", - "additionalProperties" : { - "type" : "string" - } - }, - "descriptors" : { - "type" : "object", - "description" : "The descriptors for the controller service properties.", - "additionalProperties" : { - "$ref" : "#/definitions/PropertyDescriptorDTO" - } - }, - "sensitiveDynamicPropertyNames" : { - "type" : "array", - "description" : "Set of sensitive dynamic property names", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - }, - "supportsSensitiveDynamicProperties" : { - "type" : "boolean", - "description" : "Whether the reporting task supports sensitive dynamic properties." - }, - "restricted" : { - "type" : "boolean", - "description" : "Whether the reporting task requires elevated privileges." - }, - "deprecated" : { - "type" : "boolean", - "description" : "Whether the reporting task has been deprecated." - }, - "validationErrors" : { - "type" : "array", - "description" : "Gets the validation errors from the reporting task. These validation errors represent the problems with the reporting task that must be resolved before it can be scheduled to run.", - "items" : { - "type" : "string" - } - }, - "validationStatus" : { - "type" : "string", - "description" : "Indicates whether the Processor is valid, invalid, or still in the process of validating (i.e., it is unknown whether or not the Processor is valid)", - "readOnly" : true, - "enum" : [ "VALID", "INVALID", "VALIDATING" ] - }, - "annotationData" : { - "type" : "string", - "description" : "The annotation data for the repoting task. This is how the custom UI relays configuration to the reporting task." - }, - "multipleVersionsAvailable" : { - "type" : "boolean", - "description" : "Whether the flow registry client has multiple versions available." - }, - "extensionMissing" : { - "type" : "boolean", - "description" : "Whether the underlying extension is missing." - } - } - }, - "FlowRegistryClientEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "registry" : { - "$ref" : "#/definitions/FlowRegistryClientDTO" - }, - "operatePermissions" : { - "$ref" : "#/definitions/PermissionsDTO" - }, - "component" : { - "$ref" : "#/definitions/FlowRegistryClientDTO" - } - }, - "xml" : { - "name" : "registryClientEntity" - } - }, - "FlowRegistryClientTypesEntity" : { - "type" : "object", - "properties" : { - "flowRegistryClientTypes" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/DocumentedTypeDTO" - } - } - }, - "xml" : { - "name" : "flowRegistryClientTypesEntity" - } - }, - "FlowRegistryClientsEntity" : { - "type" : "object", - "properties" : { - "registries" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/FlowRegistryClientEntity" - } - } - }, - "xml" : { - "name" : "registryClientsEntity" - } - }, - "FlowRegistryPermissions" : { - "type" : "object", - "properties" : { - "canRead" : { - "type" : "boolean" - }, - "canWrite" : { - "type" : "boolean" - }, - "canDelete" : { - "type" : "boolean" - } - } - }, - "FlowSnippetDTO" : { - "type" : "object", - "properties" : { - "processGroups" : { - "type" : "array", - "description" : "The process groups in this flow snippet.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ProcessGroupDTO" - } - }, - "remoteProcessGroups" : { - "type" : "array", - "description" : "The remote process groups in this flow snippet.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/RemoteProcessGroupDTO" - } - }, - "processors" : { - "type" : "array", - "description" : "The processors in this flow snippet.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ProcessorDTO" - } - }, - "inputPorts" : { - "type" : "array", - "description" : "The input ports in this flow snippet.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/PortDTO" - } - }, - "outputPorts" : { - "type" : "array", - "description" : "The output ports in this flow snippet.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/PortDTO" - } - }, - "connections" : { - "type" : "array", - "description" : "The connections in this flow snippet.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ConnectionDTO" - } - }, - "labels" : { - "type" : "array", - "description" : "The labels in this flow snippet.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/LabelDTO" - } - }, - "funnels" : { - "type" : "array", - "description" : "The funnels in this flow snippet.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/FunnelDTO" - } - }, - "controllerServices" : { - "type" : "array", - "description" : "The controller services in this flow snippet.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ControllerServiceDTO" - } - } - } - }, - "FunnelDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "versionedComponentId" : { - "type" : "string", - "description" : "The ID of the corresponding component that is under version control" - }, - "parentGroupId" : { - "type" : "string", - "description" : "The id of parent process group of this component if applicable." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - } - } - }, - "FunnelEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "component" : { - "$ref" : "#/definitions/FunnelDTO" - } - }, - "xml" : { - "name" : "funnelEntity" - } - }, - "FunnelsEntity" : { - "type" : "object", - "properties" : { - "funnels" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/FunnelEntity" - } - } - }, - "xml" : { - "name" : "funnelsEntity" - } - }, - "GCDiagnosticsSnapshotDTO" : { - "type" : "object", - "properties" : { - "timestamp" : { - "type" : "string", - "format" : "date-time", - "description" : "The timestamp of when the Snapshot was taken" - }, - "collectionCount" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of times that Garbage Collection has occurred" - }, - "collectionMillis" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of milliseconds that the Garbage Collector spent performing Garbage Collection duties" - } - } - }, - "GarbageCollectionDTO" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The name of the garbage collector." - }, - "collectionCount" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of times garbage collection has run." - }, - "collectionTime" : { - "type" : "string", - "description" : "The total amount of time spent garbage collecting." - }, - "collectionMillis" : { - "type" : "integer", - "format" : "int64", - "description" : "The total number of milliseconds spent garbage collecting." - } - } - }, - "GarbageCollectionDiagnosticsDTO" : { - "type" : "object", - "properties" : { - "memoryManagerName" : { - "type" : "string", - "description" : "The name of the Memory Manager that this Garbage Collection information pertains to" - }, - "snapshots" : { - "type" : "array", - "description" : "A list of snapshots that have been taken to determine the health of the JVM's heap", - "items" : { - "$ref" : "#/definitions/GCDiagnosticsSnapshotDTO" - } - } - } - }, - "HistoryDTO" : { - "type" : "object", - "properties" : { - "total" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of number of actions that matched the search criteria.." - }, - "lastRefreshed" : { - "type" : "string", - "description" : "The timestamp when the report was generated." - }, - "actions" : { - "type" : "array", - "description" : "The actions.", - "items" : { - "$ref" : "#/definitions/ActionEntity" - } - } - } - }, - "HistoryEntity" : { - "type" : "object", - "properties" : { - "history" : { - "$ref" : "#/definitions/HistoryDTO" - } - }, - "xml" : { - "name" : "historyEntity" - } - }, - "InputPortsEntity" : { - "type" : "object", - "properties" : { - "inputPorts" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/PortEntity" - } - } - }, - "xml" : { - "name" : "inputPortsEntity" - } - }, - "InputStream" : { - "type" : "object" - }, - "InstantiateTemplateRequestEntity" : { - "type" : "object", - "properties" : { - "originX" : { - "type" : "number", - "format" : "double", - "description" : "The x coordinate of the origin of the bounding box where the new components will be placed." - }, - "originY" : { - "type" : "number", - "format" : "double", - "description" : "The y coordinate of the origin of the bounding box where the new components will be placed." - }, - "templateId" : { - "type" : "string", - "description" : "The identifier of the template." - }, - "encodingVersion" : { - "type" : "string", - "description" : "The encoding version of the flow snippet. If not specified, this is automatically populated by the node receiving the user request. If the snippet is specified, the version will be the latest. If the snippet is not specified, the version will come from the underlying template. These details need to be replicated throughout the cluster to ensure consistency." - }, - "snippet" : { - "description" : "A flow snippet of the template contents. If not specified, this is automatically populated by the node receiving the user request. These details need to be replicated throughout the cluster to ensure consistency.", - "$ref" : "#/definitions/FlowSnippetDTO" - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - } - }, - "xml" : { - "name" : "instantiateTemplateRequestEntity" - } - }, - "JVMControllerDiagnosticsSnapshotDTO" : { - "type" : "object", - "properties" : { - "primaryNode" : { - "type" : "boolean", - "description" : "Whether or not this node is primary node" - }, - "clusterCoordinator" : { - "type" : "boolean", - "description" : "Whether or not this node is cluster coordinator" - }, - "maxTimerDrivenThreads" : { - "type" : "integer", - "format" : "int32", - "description" : "The maximum number of timer-driven threads" - }, - "maxEventDrivenThreads" : { - "type" : "integer", - "format" : "int32", - "description" : "The maximum number of event-driven threads" - } - } - }, - "JVMDiagnosticsDTO" : { - "type" : "object", - "properties" : { - "clustered" : { - "type" : "boolean", - "description" : "Whether or not the NiFi instance is clustered" - }, - "connected" : { - "type" : "boolean", - "description" : "Whether or not the node is connected to the cluster" - }, - "aggregateSnapshot" : { - "description" : "Aggregate JVM diagnostic information about the entire cluster", - "$ref" : "#/definitions/JVMDiagnosticsSnapshotDTO" - }, - "nodeSnapshots" : { - "type" : "array", - "description" : "Node-wise breakdown of JVM diagnostic information", - "items" : { - "$ref" : "#/definitions/NodeJVMDiagnosticsSnapshotDTO" - } - } - } - }, - "JVMDiagnosticsSnapshotDTO" : { - "type" : "object", - "properties" : { - "systemDiagnosticsDto" : { - "description" : "System-related diagnostics information", - "$ref" : "#/definitions/JVMSystemDiagnosticsSnapshotDTO" - }, - "flowDiagnosticsDto" : { - "description" : "Flow-related diagnostics information", - "$ref" : "#/definitions/JVMFlowDiagnosticsSnapshotDTO" - }, - "controllerDiagnostics" : { - "description" : "Controller-related diagnostics information", - "$ref" : "#/definitions/JVMControllerDiagnosticsSnapshotDTO" - } - } - }, - "JVMFlowDiagnosticsSnapshotDTO" : { - "type" : "object", - "properties" : { - "uptime" : { - "type" : "string", - "description" : "How long this node has been running, formatted as hours:minutes:seconds.milliseconds" - }, - "timeZone" : { - "type" : "string", - "description" : "The name of the Time Zone that is configured, if available" - }, - "activeTimerDrivenThreads" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of timer-driven threads that are active" - }, - "activeEventDrivenThreads" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of event-driven threads that are active" - }, - "bundlesLoaded" : { - "type" : "array", - "description" : "The NiFi Bundles (NARs) that are loaded by NiFi", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/BundleDTO" - } - } - } - }, - "JVMSystemDiagnosticsSnapshotDTO" : { - "type" : "object", - "properties" : { - "flowFileRepositoryStorageUsage" : { - "description" : "Information about the FlowFile Repository's usage", - "$ref" : "#/definitions/RepositoryUsageDTO" - }, - "contentRepositoryStorageUsage" : { - "type" : "array", - "description" : "Information about the Content Repository's usage", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/RepositoryUsageDTO" - } - }, - "provenanceRepositoryStorageUsage" : { - "type" : "array", - "description" : "Information about the Provenance Repository's usage", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/RepositoryUsageDTO" - } - }, - "maxHeapBytes" : { - "type" : "integer", - "format" : "int64", - "description" : "The maximum number of bytes that the JVM heap is configured to use for heap" - }, - "maxHeap" : { - "type" : "string", - "description" : "The maximum number of bytes that the JVM heap is configured to use, as a human-readable value" - }, - "garbageCollectionDiagnostics" : { - "type" : "array", - "description" : "Diagnostic information about the JVM's garbage collections", - "items" : { - "$ref" : "#/definitions/GarbageCollectionDiagnosticsDTO" - } - }, - "cpuCores" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of CPU Cores available on the system" - }, - "cpuLoadAverage" : { - "type" : "number", - "format" : "double", - "description" : "The 1-minute CPU Load Average" - }, - "physicalMemoryBytes" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes of RAM available on the system" - }, - "physicalMemory" : { - "type" : "string", - "description" : "The number of bytes of RAM available on the system as a human-readable value" - }, - "openFileDescriptors" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of files that are open by the NiFi process" - }, - "maxOpenFileDescriptors" : { - "type" : "integer", - "format" : "int64", - "description" : "The maximum number of open file descriptors that are available to each process" - } - } - }, - "JmxMetricsResultDTO" : { - "type" : "object", - "properties" : { - "beanName" : { - "type" : "string", - "description" : "The bean name of the metrics bean." - }, - "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" - } - } - }, - "JmxMetricsResultsEntity" : { - "type" : "object", - "properties" : { - "jmxMetricsResults" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/JmxMetricsResultDTO" - } - } - }, - "xml" : { - "name" : "jmxMetricsResult" - } - }, - "LabelDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "versionedComponentId" : { - "type" : "string", - "description" : "The ID of the corresponding component that is under version control" - }, - "parentGroupId" : { - "type" : "string", - "description" : "The id of parent process group of this component if applicable." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "label" : { - "type" : "string", - "description" : "The text that appears in the label." - }, - "width" : { - "type" : "number", - "format" : "double", - "description" : "The width of the label in pixels when at a 1:1 scale." - }, - "height" : { - "type" : "number", - "format" : "double", - "description" : "The height of the label in pixels when at a 1:1 scale." - }, - "getzIndex" : { - "type" : "integer", - "format" : "int64", - "description" : "The z index of the label." - }, - "style" : { - "type" : "object", - "description" : "The styles for this label (font-size : 12px, background-color : #eee, etc).", - "additionalProperties" : { - "type" : "string" - } - } - } - }, - "LabelEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "dimensions" : { - "$ref" : "#/definitions/DimensionsDTO" - }, - "getzIndex" : { - "type" : "integer", - "format" : "int64", - "description" : "The z index of the label." - }, - "component" : { - "$ref" : "#/definitions/LabelDTO" - } - }, - "xml" : { - "name" : "labelEntity" - } - }, - "LabelsEntity" : { - "type" : "object", - "properties" : { - "labels" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/LabelEntity" - } - } - }, - "xml" : { - "name" : "labelsEntity" - } - }, - "LineageDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of this lineage query." - }, - "uri" : { - "type" : "string", - "description" : "The URI for this lineage query for later retrieval and deletion." - }, - "submissionTime" : { - "type" : "string", - "description" : "When the lineage query was submitted." - }, - "expiration" : { - "type" : "string", - "description" : "When the lineage query will expire." - }, - "percentCompleted" : { - "type" : "integer", - "format" : "int32", - "description" : "The percent complete for the lineage query." - }, - "finished" : { - "type" : "boolean", - "description" : "Whether the lineage query has finished." - }, - "request" : { - "description" : "The initial lineage result.", - "$ref" : "#/definitions/LineageRequestDTO" - }, - "results" : { - "description" : "The results of the lineage query.", - "$ref" : "#/definitions/LineageResultsDTO" - } - } - }, - "LineageEntity" : { - "type" : "object", - "properties" : { - "lineage" : { - "$ref" : "#/definitions/LineageDTO" - } - }, - "xml" : { - "name" : "lineageEntity" - } - }, - "LineageRequestDTO" : { - "type" : "object", - "properties" : { - "eventId" : { - "type" : "integer", - "format" : "int64", - "description" : "The event id that was used to generate this lineage, if applicable. The event id is allowed for any type of lineageRequestType. If the lineageRequestType is FLOWFILE and the flowfile uuid is also included in the request, the event id will be ignored." - }, - "lineageRequestType" : { - "type" : "string", - "description" : "The type of lineage request. PARENTS will return the lineage for the flowfiles that are parents of the specified event. CHILDREN will return the lineage for the flowfiles that are children of the specified event. FLOWFILE will return the lineage for the specified flowfile.", - "enum" : [ "PARENTS", "CHILDREN", "and FLOWFILE" ] - }, - "uuid" : { - "type" : "string", - "description" : "The flowfile uuid that was used to generate the lineage. The flowfile uuid is only allowed when the lineageRequestType is FLOWFILE and will take precedence over event id." - }, - "clusterNodeId" : { - "type" : "string", - "description" : "The id of the node where this lineage originated if clustered." - } - } - }, - "LineageResultsDTO" : { - "type" : "object", - "properties" : { - "errors" : { - "type" : "array", - "description" : "Any errors that occurred while generating the lineage.", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - }, - "nodes" : { - "type" : "array", - "description" : "The nodes in the lineage.", - "items" : { - "$ref" : "#/definitions/ProvenanceNodeDTO" - } - }, - "links" : { - "type" : "array", - "description" : "The links between the nodes in the lineage.", - "items" : { - "$ref" : "#/definitions/ProvenanceLinkDTO" - } - } - } - }, - "ListingRequestDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id for this listing request." - }, - "uri" : { - "type" : "string", - "description" : "The URI for future requests to this listing request." - }, - "submissionTime" : { - "type" : "string", - "description" : "The timestamp when the query was submitted." - }, - "lastUpdated" : { - "type" : "string", - "description" : "The last time this listing request was updated." - }, - "percentCompleted" : { - "type" : "integer", - "format" : "int32", - "description" : "The current percent complete." - }, - "finished" : { - "type" : "boolean", - "description" : "Whether the query has finished." - }, - "failureReason" : { - "type" : "string", - "description" : "The reason, if any, that this listing request failed." - }, - "maxResults" : { - "type" : "integer", - "format" : "int32", - "description" : "The maximum number of FlowFileSummary objects to return" - }, - "state" : { - "type" : "string", - "description" : "The current state of the listing request." - }, - "queueSize" : { - "description" : "The size of the queue", - "$ref" : "#/definitions/QueueSizeDTO" - }, - "flowFileSummaries" : { - "type" : "array", - "description" : "The FlowFile summaries. The summaries will be populated once the request has completed.", - "items" : { - "$ref" : "#/definitions/FlowFileSummaryDTO" - } - }, - "destinationRunning" : { - "type" : "boolean", - "description" : "Whether the destination of the connection is running" - }, - "sourceRunning" : { - "type" : "boolean", - "description" : "Whether the source of the connection is running" - } - } - }, - "ListingRequestEntity" : { - "type" : "object", - "properties" : { - "listingRequest" : { - "$ref" : "#/definitions/ListingRequestDTO" - } - }, - "xml" : { - "name" : "listingRequestEntity" - } - }, - "LocalQueuePartitionDTO" : { - "type" : "object", - "properties" : { - "totalFlowFileCount" : { - "type" : "integer", - "format" : "int32", - "description" : "Total number of FlowFiles owned by the Connection" - }, - "totalByteCount" : { - "type" : "integer", - "format" : "int64", - "description" : "Total number of bytes that make up the content for the FlowFiles owned by this Connection" - }, - "activeQueueFlowFileCount" : { - "type" : "integer", - "format" : "int32", - "description" : "Total number of FlowFiles that exist in the Connection's Active Queue, immediately available to be offered up to a component" - }, - "activeQueueByteCount" : { - "type" : "integer", - "format" : "int64", - "description" : "Total number of bytes that make up the content for the FlowFiles that are present in the Connection's Active Queue" - }, - "swapFlowFileCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The total number of FlowFiles that are swapped out for this Connection" - }, - "swapByteCount" : { - "type" : "integer", - "format" : "int64", - "description" : "Total number of bytes that make up the content for the FlowFiles that are swapped out to disk for the Connection" - }, - "swapFiles" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of Swap Files that exist for this Connection" - }, - "inFlightFlowFileCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of In-Flight FlowFiles for this Connection. These are FlowFiles that belong to the connection but are currently being operated on by a Processor, Port, etc." - }, - "inFlightByteCount" : { - "type" : "integer", - "format" : "int64", - "description" : "The number bytes that make up the content of the FlowFiles that are In-Flight" - }, - "allActiveQueueFlowFilesPenalized" : { - "type" : "boolean", - "description" : "Whether or not all of the FlowFiles in the Active Queue are penalized" - }, - "anyActiveQueueFlowFilesPenalized" : { - "type" : "boolean", - "description" : "Whether or not any of the FlowFiles in the Active Queue are penalized" - } - } - }, - "NodeConnectionStatisticsSnapshotDTO" : { - "type" : "object", - "properties" : { - "nodeId" : { - "type" : "string", - "description" : "The unique ID that identifies the node" - }, - "address" : { - "type" : "string", - "description" : "The API address of the node" - }, - "apiPort" : { - "type" : "integer", - "format" : "int32", - "description" : "The API port used to communicate with the node" - }, - "statisticsSnapshot" : { - "description" : "The connection status snapshot from the node.", - "$ref" : "#/definitions/ConnectionStatisticsSnapshotDTO" - } - } - }, - "NodeConnectionStatusSnapshotDTO" : { - "type" : "object", - "properties" : { - "nodeId" : { - "type" : "string", - "description" : "The unique ID that identifies the node" - }, - "address" : { - "type" : "string", - "description" : "The API address of the node" - }, - "apiPort" : { - "type" : "integer", - "format" : "int32", - "description" : "The API port used to communicate with the node" - }, - "statusSnapshot" : { - "description" : "The connection status snapshot from the node.", - "$ref" : "#/definitions/ConnectionStatusSnapshotDTO" - } - } - }, - "NodeCountersSnapshotDTO" : { - "type" : "object", - "properties" : { - "nodeId" : { - "type" : "string", - "description" : "The unique ID that identifies the node" - }, - "address" : { - "type" : "string", - "description" : "The API address of the node" - }, - "apiPort" : { - "type" : "integer", - "format" : "int32", - "description" : "The API port used to communicate with the node" - }, - "snapshot" : { - "description" : "The counters from the node.", - "$ref" : "#/definitions/CountersSnapshotDTO" - } - } - }, - "NodeDTO" : { - "type" : "object", - "properties" : { - "nodeId" : { - "type" : "string", - "description" : "The id of the node.", - "readOnly" : true - }, - "address" : { - "type" : "string", - "description" : "The node's host/ip address.", - "readOnly" : true - }, - "apiPort" : { - "type" : "integer", - "format" : "int32", - "description" : "The port the node is listening for API requests.", - "readOnly" : true - }, - "status" : { - "type" : "string", - "description" : "The node's status." - }, - "heartbeat" : { - "type" : "string", - "description" : "the time of the nodes's last heartbeat.", - "readOnly" : true - }, - "connectionRequested" : { - "type" : "string", - "description" : "The time of the node's last connection request.", - "readOnly" : true - }, - "roles" : { - "type" : "array", - "description" : "The roles of this node.", - "readOnly" : true, - "uniqueItems" : true, - "items" : { - "type" : "string" - } - }, - "activeThreadCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The active threads for the NiFi on the node.", - "readOnly" : true - }, - "queued" : { - "type" : "string", - "description" : "The queue the NiFi on the node.", - "readOnly" : true - }, - "events" : { - "type" : "array", - "description" : "The node's events.", - "readOnly" : true, - "items" : { - "$ref" : "#/definitions/NodeEventDTO" - } - }, - "nodeStartTime" : { - "type" : "string", - "description" : "The time at which this Node was last refreshed.", - "readOnly" : true - } - } - }, - "NodeEntity" : { - "type" : "object", - "properties" : { - "node" : { - "$ref" : "#/definitions/NodeDTO" - } - }, - "xml" : { - "name" : "nodeEntity" - } - }, - "NodeEventDTO" : { - "type" : "object", - "properties" : { - "timestamp" : { - "type" : "string", - "description" : "The timestamp of the node event." - }, - "category" : { - "type" : "string", - "description" : "The category of the node event." - }, - "message" : { - "type" : "string", - "description" : "The message in the node event." - } - } - }, - "NodeIdentifier" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string" - }, - "apiAddress" : { - "type" : "string" - }, - "apiPort" : { - "type" : "integer", - "format" : "int32" - }, - "socketAddress" : { - "type" : "string" - }, - "socketPort" : { - "type" : "integer", - "format" : "int32" - }, - "loadBalanceAddress" : { - "type" : "string" - }, - "loadBalancePort" : { - "type" : "integer", - "format" : "int32" - }, - "siteToSiteAddress" : { - "type" : "string" - }, - "siteToSitePort" : { - "type" : "integer", - "format" : "int32" - }, - "siteToSiteHttpApiPort" : { - "type" : "integer", - "format" : "int32" - }, - "siteToSiteSecure" : { - "type" : "boolean" - }, - "nodeIdentities" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - }, - "fullDescription" : { - "type" : "string" - } - } - }, - "NodeJVMDiagnosticsSnapshotDTO" : { - "type" : "object", - "properties" : { - "nodeId" : { - "type" : "string", - "description" : "The unique ID that identifies the node" - }, - "address" : { - "type" : "string", - "description" : "The API address of the node" - }, - "apiPort" : { - "type" : "integer", - "format" : "int32", - "description" : "The API port used to communicate with the node" - }, - "snapshot" : { - "description" : "The JVM Diagnostics Snapshot", - "$ref" : "#/definitions/JVMDiagnosticsSnapshotDTO" - } - } - }, - "NodePortStatusSnapshotDTO" : { - "type" : "object", - "properties" : { - "nodeId" : { - "type" : "string", - "description" : "The unique ID that identifies the node" - }, - "address" : { - "type" : "string", - "description" : "The API address of the node" - }, - "apiPort" : { - "type" : "integer", - "format" : "int32", - "description" : "The API port used to communicate with the node" - }, - "statusSnapshot" : { - "description" : "The port status snapshot from the node.", - "$ref" : "#/definitions/PortStatusSnapshotDTO" - } - } - }, - "NodeProcessGroupStatusSnapshotDTO" : { - "type" : "object", - "properties" : { - "nodeId" : { - "type" : "string", - "description" : "The unique ID that identifies the node" - }, - "address" : { - "type" : "string", - "description" : "The API address of the node" - }, - "apiPort" : { - "type" : "integer", - "format" : "int32", - "description" : "The API port used to communicate with the node" - }, - "statusSnapshot" : { - "description" : "The process group status snapshot from the node.", - "$ref" : "#/definitions/ProcessGroupStatusSnapshotDTO" - } - } - }, - "NodeProcessorStatusSnapshotDTO" : { - "type" : "object", - "properties" : { - "nodeId" : { - "type" : "string", - "description" : "The unique ID that identifies the node" - }, - "address" : { - "type" : "string", - "description" : "The API address of the node" - }, - "apiPort" : { - "type" : "integer", - "format" : "int32", - "description" : "The API port used to communicate with the node" - }, - "statusSnapshot" : { - "description" : "The processor status snapshot from the node.", - "$ref" : "#/definitions/ProcessorStatusSnapshotDTO" - } - } - }, - "NodeRemoteProcessGroupStatusSnapshotDTO" : { - "type" : "object", - "properties" : { - "nodeId" : { - "type" : "string", - "description" : "The unique ID that identifies the node" - }, - "address" : { - "type" : "string", - "description" : "The API address of the node" - }, - "apiPort" : { - "type" : "integer", - "format" : "int32", - "description" : "The API port used to communicate with the node" - }, - "statusSnapshot" : { - "description" : "The remote process group status snapshot from the node.", - "$ref" : "#/definitions/RemoteProcessGroupStatusSnapshotDTO" - } - } - }, - "NodeReplayLastEventSnapshotDTO" : { - "type" : "object", - "properties" : { - "nodeId" : { - "type" : "string", - "description" : "The unique ID that identifies the node" - }, - "address" : { - "type" : "string", - "description" : "The API address of the node" - }, - "apiPort" : { - "type" : "integer", - "format" : "int32", - "description" : "The API port used to communicate with the node" - }, - "snapshot" : { - "description" : "The snapshot from the node", - "$ref" : "#/definitions/ReplayLastEventSnapshotDTO" - } - }, - "xml" : { - "name" : "nodeReplayLastEventSnapshot" - } - }, - "NodeResponse" : { - "type" : "object", - "properties" : { - "httpMethod" : { - "type" : "string" - }, - "requestUri" : { - "type" : "string", - "format" : "uri" - }, - "response" : { - "$ref" : "#/definitions/Response" - }, - "nodeId" : { - "$ref" : "#/definitions/NodeIdentifier" - }, - "throwable" : { - "$ref" : "#/definitions/Throwable" - }, - "updatedEntity" : { - "$ref" : "#/definitions/Entity" - }, - "requestId" : { - "type" : "string" - }, - "inputStream" : { - "$ref" : "#/definitions/InputStream" - }, - "clientResponse" : { - "$ref" : "#/definitions/Response" - }, - "status" : { - "type" : "integer", - "format" : "int32" - }, - "is2xx" : { - "type" : "boolean" - }, - "is5xx" : { - "type" : "boolean" - } - } - }, - "NodeSearchResultDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the node that matched the search." - }, - "address" : { - "type" : "string", - "description" : "The address of the node that matched the search." - } - } - }, - "NodeStatusSnapshotsDTO" : { - "type" : "object", - "properties" : { - "nodeId" : { - "type" : "string", - "description" : "The id of the node." - }, - "address" : { - "type" : "string", - "description" : "The node's host/ip address." - }, - "apiPort" : { - "type" : "integer", - "format" : "int32", - "description" : "The port the node is listening for API requests." - }, - "statusSnapshots" : { - "type" : "array", - "description" : "A list of StatusSnapshotDTO objects that provide the actual metric values for the component for this node.", - "items" : { - "$ref" : "#/definitions/StatusSnapshotDTO" - } - } - } - }, - "NodeSystemDiagnosticsSnapshotDTO" : { - "type" : "object", - "properties" : { - "nodeId" : { - "type" : "string", - "description" : "The unique ID that identifies the node" - }, - "address" : { - "type" : "string", - "description" : "The API address of the node" - }, - "apiPort" : { - "type" : "integer", - "format" : "int32", - "description" : "The API port used to communicate with the node" - }, - "snapshot" : { - "description" : "The System Diagnostics snapshot from the node.", - "$ref" : "#/definitions/SystemDiagnosticsSnapshotDTO" - } - } - }, - "OutputPortsEntity" : { - "type" : "object", - "properties" : { - "outputPorts" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/PortEntity" - } - } - }, - "xml" : { - "name" : "outputPortsEntity" - } - }, - "ParameterContextDTO" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The Name of the Parameter Context." - }, - "description" : { - "type" : "string", - "description" : "The Description of the Parameter Context." - }, - "parameters" : { - "type" : "array", - "description" : "The Parameters for the Parameter Context", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ParameterEntity" - } - }, - "boundProcessGroups" : { - "type" : "array", - "description" : "The Process Groups that are bound to this Parameter Context", - "readOnly" : true, - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ProcessGroupEntity" - } - }, - "inheritedParameterContexts" : { - "type" : "array", - "description" : "A list of references of Parameter Contexts from which this one inherits parameters", - "items" : { - "$ref" : "#/definitions/ParameterContextReferenceEntity" - } - }, - "parameterProviderConfiguration" : { - "description" : "Optional configuration for a Parameter Provider", - "$ref" : "#/definitions/ParameterProviderConfigurationEntity" - }, - "id" : { - "type" : "string", - "description" : "The ID the Parameter Context.", - "readOnly" : true - } - } - }, - "ParameterContextEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "component" : { - "description" : "The Parameter Context", - "$ref" : "#/definitions/ParameterContextDTO" - } - }, - "xml" : { - "name" : "parameterContextEntity" - } - }, - "ParameterContextReferenceDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The ID of the Parameter Context" - }, - "name" : { - "type" : "string", - "description" : "The name of the Parameter Context" - } - } - }, - "ParameterContextReferenceEntity" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "component" : { - "$ref" : "#/definitions/ParameterContextReferenceDTO" - } - }, - "xml" : { - "name" : "parameterContextReferenceEntity" - } - }, - "ParameterContextUpdateEntity" : { - "type" : "object", - "properties" : { - "parameterContextRevision" : { - "description" : "The Revision of the Parameter Context", - "$ref" : "#/definitions/RevisionDTO" - }, - "parameterContext" : { - "description" : "The Parameter Context that is being operated on. This may not be populated until the request has successfully completed.", - "readOnly" : true, - "$ref" : "#/definitions/ParameterContextDTO" - }, - "referencingComponents" : { - "type" : "array", - "description" : "The components that are referenced by the update.", - "readOnly" : true, - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/AffectedComponentEntity" - } - } - }, - "xml" : { - "name" : "parameterContextUpdateEntity" - } - }, - "ParameterContextUpdateRequestDTO" : { - "type" : "object", - "properties" : { - "requestId" : { - "type" : "string", - "description" : "The ID of the request", - "readOnly" : true - }, - "uri" : { - "type" : "string", - "description" : "The URI for the request", - "readOnly" : true - }, - "submissionTime" : { - "type" : "string", - "format" : "date-time", - "description" : "The timestamp of when the request was submitted", - "readOnly" : true - }, - "lastUpdated" : { - "type" : "string", - "format" : "date-time", - "description" : "The timestamp of when the request was last updated", - "readOnly" : true - }, - "complete" : { - "type" : "boolean", - "description" : "Whether or not the request is completed", - "readOnly" : true - }, - "failureReason" : { - "type" : "string", - "description" : "The reason for the request failing, or null if the request has not failed", - "readOnly" : true - }, - "percentCompleted" : { - "type" : "integer", - "format" : "int32", - "description" : "A value between 0 and 100 (inclusive) indicating how close the request is to completion", - "readOnly" : true - }, - "state" : { - "type" : "string", - "description" : "A description of the current state of the request", - "readOnly" : true - }, - "updateSteps" : { - "type" : "array", - "description" : "The steps that are required in order to complete the request, along with the status of each", - "readOnly" : true, - "items" : { - "$ref" : "#/definitions/ParameterContextUpdateStepDTO" - } - }, - "parameterContext" : { - "description" : "The Parameter Context that is being operated on. This may not be populated until the request has successfully completed.", - "readOnly" : true, - "$ref" : "#/definitions/ParameterContextDTO" - }, - "referencingComponents" : { - "type" : "array", - "description" : "The components that are referenced by the update.", - "readOnly" : true, - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/AffectedComponentEntity" - } - } - } - }, - "ParameterContextUpdateRequestEntity" : { - "type" : "object", - "properties" : { - "parameterContextRevision" : { - "description" : "The Revision of the Parameter Context", - "$ref" : "#/definitions/RevisionDTO" - }, - "request" : { - "description" : "The Update Request", - "$ref" : "#/definitions/ParameterContextUpdateRequestDTO" - } - }, - "xml" : { - "name" : "parameterContextUpdateRequestEntity" - } - }, - "ParameterContextUpdateStepDTO" : { - "type" : "object", - "properties" : { - "description" : { - "type" : "string", - "description" : "Explanation of what happens in this step", - "readOnly" : true - }, - "complete" : { - "type" : "boolean", - "description" : "Whether or not this step has completed", - "readOnly" : true - }, - "failureReason" : { - "type" : "string", - "description" : "An explanation of why this step failed, or null if this step did not fail", - "readOnly" : true - } - } - }, - "ParameterContextValidationRequestDTO" : { - "type" : "object", - "properties" : { - "requestId" : { - "type" : "string", - "description" : "The ID of the request", - "readOnly" : true - }, - "uri" : { - "type" : "string", - "description" : "The URI for the request", - "readOnly" : true - }, - "submissionTime" : { - "type" : "string", - "format" : "date-time", - "description" : "The timestamp of when the request was submitted", - "readOnly" : true - }, - "lastUpdated" : { - "type" : "string", - "format" : "date-time", - "description" : "The timestamp of when the request was last updated", - "readOnly" : true - }, - "complete" : { - "type" : "boolean", - "description" : "Whether or not the request is completed", - "readOnly" : true - }, - "failureReason" : { - "type" : "string", - "description" : "The reason for the request failing, or null if the request has not failed", - "readOnly" : true - }, - "percentCompleted" : { - "type" : "integer", - "format" : "int32", - "description" : "A value between 0 and 100 (inclusive) indicating how close the request is to completion", - "readOnly" : true - }, - "state" : { - "type" : "string", - "description" : "A description of the current state of the request", - "readOnly" : true - }, - "updateSteps" : { - "type" : "array", - "description" : "The steps that are required in order to complete the request, along with the status of each", - "readOnly" : true, - "items" : { - "$ref" : "#/definitions/ParameterContextValidationStepDTO" - } - }, - "parameterContext" : { - "description" : "The Parameter Context that is being operated on.", - "$ref" : "#/definitions/ParameterContextDTO" - }, - "componentValidationResults" : { - "description" : "The Validation Results that were calculated for each component. This value may not be set until the request completes.", - "readOnly" : true, - "$ref" : "#/definitions/ComponentValidationResultsEntity" - } - } - }, - "ParameterContextValidationRequestEntity" : { - "type" : "object", - "properties" : { - "request" : { - "description" : "The Update Request", - "$ref" : "#/definitions/ParameterContextValidationRequestDTO" - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - } - }, - "xml" : { - "name" : "parameterContextValidationRequestEntity" - } - }, - "ParameterContextValidationStepDTO" : { - "type" : "object", - "properties" : { - "description" : { - "type" : "string", - "description" : "Explanation of what happens in this step", - "readOnly" : true - }, - "complete" : { - "type" : "boolean", - "description" : "Whether or not this step has completed", - "readOnly" : true - }, - "failureReason" : { - "type" : "string", - "description" : "An explanation of why this step failed, or null if this step did not fail", - "readOnly" : true - } - } - }, - "ParameterContextsEntity" : { - "type" : "object", - "properties" : { - "parameterContexts" : { - "type" : "array", - "description" : "The Parameter Contexts", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ParameterContextEntity" - } - }, - "currentTime" : { - "type" : "string", - "description" : "The current time on the system.", - "readOnly" : true - } - }, - "xml" : { - "name" : "parameterContexts" - } - }, - "ParameterDTO" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The name of the Parameter" - }, - "description" : { - "type" : "string", - "description" : "The description of the Parameter" - }, - "sensitive" : { - "type" : "boolean", - "description" : "Whether or not the Parameter is sensitive" - }, - "value" : { - "type" : "string", - "description" : "The value of the Parameter" - }, - "valueRemoved" : { - "type" : "boolean", - "description" : "Whether or not the value of the Parameter was removed. When a request is made to change a parameter, the value may be null. The 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). This denotes which of the two scenarios is being encountered." - }, - "provided" : { - "type" : "boolean", - "description" : "Whether or not the Parameter is provided by a ParameterProvider" - }, - "referencingComponents" : { - "type" : "array", - "description" : "The set of all components in the flow that are referencing this Parameter", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/AffectedComponentEntity" - } - }, - "parameterContext" : { - "description" : "A reference to the Parameter Context that contains this one", - "$ref" : "#/definitions/ParameterContextReferenceEntity" - }, - "inherited" : { - "type" : "boolean", - "description" : "Whether or not the Parameter is inherited from another context", - "readOnly" : true - } - } - }, - "ParameterEntity" : { - "type" : "object", - "properties" : { - "canWrite" : { - "type" : "boolean", - "description" : "Indicates whether the user can write a given resource.", - "readOnly" : true - }, - "parameter" : { - "description" : "The parameter information", - "$ref" : "#/definitions/ParameterDTO" - } - }, - "xml" : { - "name" : "parameterEntity" - } - }, - "ParameterGroupConfigurationEntity" : { - "type" : "object", - "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", - "description" : "All fetched parameter names that should be applied.", - "additionalProperties" : { - "type" : "string", - "enum" : [ "SENSITIVE", "NON_SENSITIVE" ] - } - }, - "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", - "properties" : { - "requestId" : { - "type" : "string", - "description" : "The ID of the request", - "readOnly" : true - }, - "uri" : { - "type" : "string", - "description" : "The URI for the request", - "readOnly" : true - }, - "submissionTime" : { - "type" : "string", - "format" : "date-time", - "description" : "The timestamp of when the request was submitted", - "readOnly" : true - }, - "lastUpdated" : { - "type" : "string", - "format" : "date-time", - "description" : "The timestamp of when the request was last updated", - "readOnly" : true - }, - "complete" : { - "type" : "boolean", - "description" : "Whether or not the request is completed", - "readOnly" : true - }, - "failureReason" : { - "type" : "string", - "description" : "The reason for the request failing, or null if the request has not failed", - "readOnly" : true - }, - "percentCompleted" : { - "type" : "integer", - "format" : "int32", - "description" : "A value between 0 and 100 (inclusive) indicating how close the request is to completion", - "readOnly" : true - }, - "state" : { - "type" : "string", - "description" : "A description of the current state of the request", - "readOnly" : true - }, - "updateSteps" : { - "type" : "array", - "description" : "The steps that are required in order to complete the request, along with the status of each", - "readOnly" : true, - "items" : { - "$ref" : "#/definitions/ParameterProviderApplyParametersUpdateStepDTO" - } - }, - "parameterProvider" : { - "description" : "The Parameter Provider that is being operated on. This may not be populated until the request has successfully completed.", - "readOnly" : true, - "$ref" : "#/definitions/ParameterProviderDTO" - }, - "parameterContextUpdates" : { - "type" : "array", - "description" : "The Parameter Contexts updated by this Parameter Provider. This may not be populated until the request has successfully completed.", - "readOnly" : true, - "items" : { - "$ref" : "#/definitions/ParameterContextUpdateEntity" - } - }, - "referencingComponents" : { - "type" : "array", - "description" : "The components that are referenced by the update.", - "readOnly" : true, - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/AffectedComponentEntity" - } - } - } - }, - "ParameterProviderApplyParametersRequestEntity" : { - "type" : "object", - "properties" : { - "request" : { - "description" : "The Apply Parameters Request", - "$ref" : "#/definitions/ParameterProviderApplyParametersRequestDTO" - } - }, - "xml" : { - "name" : "parameterProviderApplyParametersRequestEntity" - } - }, - "ParameterProviderApplyParametersUpdateStepDTO" : { - "type" : "object", - "properties" : { - "description" : { - "type" : "string", - "description" : "Explanation of what happens in this step", - "readOnly" : true - }, - "complete" : { - "type" : "boolean", - "description" : "Whether or not this step has completed", - "readOnly" : true - }, - "failureReason" : { - "type" : "string", - "description" : "An explanation of why this step failed, or null if this step did not fail", - "readOnly" : true - } - } - }, - "ParameterProviderConfigurationDTO" : { - "type" : "object", - "properties" : { - "parameterProviderId" : { - "type" : "string", - "description" : "The ID of the Parameter Provider" - }, - "parameterProviderName" : { - "type" : "string", - "description" : "The name of the Parameter Provider" - }, - "parameterGroupName" : { - "type" : "string", - "description" : "The Parameter Group name that maps to the Parameter Context" - }, - "synchronized" : { - "type" : "boolean", - "description" : "True if the Parameter Context should receive the parameters from the mapped Parameter Group" - } - } - }, - "ParameterProviderConfigurationEntity" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "component" : { - "$ref" : "#/definitions/ParameterProviderConfigurationDTO" - } - }, - "xml" : { - "name" : "parameterProviderConfigurationEntity" - } - }, - "ParameterProviderDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "versionedComponentId" : { - "type" : "string", - "description" : "The ID of the corresponding component that is under version control" - }, - "parentGroupId" : { - "type" : "string", - "description" : "The id of parent process group of this component if applicable." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "name" : { - "type" : "string", - "description" : "The name of the parameter provider." - }, - "type" : { - "type" : "string", - "description" : "The fully qualified type of the parameter provider." - }, - "bundle" : { - "description" : "The details of the artifact that bundled this parameter provider type.", - "$ref" : "#/definitions/BundleDTO" - }, - "comments" : { - "type" : "string", - "description" : "The comments of the parameter provider." - }, - "persistsState" : { - "type" : "boolean", - "description" : "Whether the parameter provider persists state." - }, - "restricted" : { - "type" : "boolean", - "description" : "Whether the parameter provider requires elevated privileges." - }, - "deprecated" : { - "type" : "boolean", - "description" : "Whether the parameter provider has been deprecated." - }, - "multipleVersionsAvailable" : { - "type" : "boolean", - "description" : "Whether the parameter provider has multiple versions available." - }, - "properties" : { - "type" : "object", - "description" : "The properties of the parameter provider.", - "additionalProperties" : { - "type" : "string" - } - }, - "descriptors" : { - "type" : "object", - "description" : "The descriptors for the parameter providers properties.", - "additionalProperties" : { - "$ref" : "#/definitions/PropertyDescriptorDTO" - } - }, - "parameterGroupConfigurations" : { - "type" : "array", - "description" : "Configuration for any fetched parameter groups.", - "items" : { - "$ref" : "#/definitions/ParameterGroupConfigurationEntity" - } - }, - "affectedComponents" : { - "type" : "array", - "description" : "The set of all components in the flow that are referencing Parameters provided by this provider", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/AffectedComponentEntity" - } - }, - "parameterStatus" : { - "type" : "array", - "description" : "The status of all provided parameters for this parameter provider", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ParameterStatusDTO" - } - }, - "referencingParameterContexts" : { - "type" : "array", - "description" : "The Parameter Contexts that reference this Parameter Provider", - "readOnly" : true, - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ParameterProviderReferencingComponentEntity" - } - }, - "customUiUrl" : { - "type" : "string", - "description" : "The URL for the custom configuration UI for the parameter provider." - }, - "annotationData" : { - "type" : "string", - "description" : "The annotation data for the parameter provider. This is how the custom UI relays configuration to 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" - } - }, - "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)", - "readOnly" : true, - "enum" : [ "VALID", "INVALID", "VALIDATING" ] - }, - "extensionMissing" : { - "type" : "boolean", - "description" : "Whether the underlying extension is missing." - } - } - }, - "ParameterProviderEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "component" : { - "$ref" : "#/definitions/ParameterProviderDTO" - } - }, - "xml" : { - "name" : "parameterProviderEntity" - } - }, - "ParameterProviderParameterApplicationEntity" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the parameter provider." - }, - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "parameterGroupConfigurations" : { - "type" : "array", - "description" : "Configuration for the fetched Parameter Groups", - "items" : { - "$ref" : "#/definitions/ParameterGroupConfigurationEntity" - } - } - }, - "xml" : { - "name" : "entity" - } - }, - "ParameterProviderParameterFetchEntity" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the parameter provider." - }, - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - } - }, - "xml" : { - "name" : "entity" - } - }, - "ParameterProviderReference" : { - "type" : "object", - "properties" : { - "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." - }, - "bundle" : { - "description" : "The details of the artifact that bundled this parameter provider.", - "$ref" : "#/definitions/Bundle" - } - } - }, - "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", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "component" : { - "$ref" : "#/definitions/ParameterProviderReferencingComponentDTO" - } - }, - "xml" : { - "name" : "parameterProviderReferencingComponentEntity" - } - }, - "ParameterProviderReferencingComponentsEntity" : { - "type" : "object", - "properties" : { - "parameterProviderReferencingComponents" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ParameterProviderReferencingComponentEntity" - } - } - }, - "xml" : { - "name" : "parameterProviderReferencingComponentsEntity" - } - }, - "ParameterProviderTypesEntity" : { - "type" : "object", - "properties" : { - "parameterProviderTypes" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/DocumentedTypeDTO" - } - } - }, - "xml" : { - "name" : "parameterProviderTypesEntity" - } - }, - "ParameterProvidersEntity" : { - "type" : "object", - "properties" : { - "parameterProviders" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ParameterProviderEntity" - } - } - }, - "xml" : { - "name" : "parameterProvidersEntity" - } - }, - "ParameterStatusDTO" : { - "type" : "object", - "properties" : { - "parameter" : { - "description" : "The name of the Parameter", - "$ref" : "#/definitions/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" ] - } - } - }, - "PeerDTO" : { - "type" : "object", - "properties" : { - "hostname" : { - "type" : "string", - "description" : "The hostname of this peer." - }, - "port" : { - "type" : "integer", - "format" : "int32", - "description" : "The port number of this peer." - }, - "secure" : { - "type" : "boolean", - "description" : "Returns if this peer connection is secure." - }, - "flowFileCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of flowFiles this peer holds." - } - } - }, - "PeersEntity" : { - "type" : "object", - "properties" : { - "peers" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/PeerDTO" - } - } - }, - "xml" : { - "name" : "peersEntity" - } - }, - "PermissionsDTO" : { - "type" : "object", - "properties" : { - "canRead" : { - "type" : "boolean", - "description" : "Indicates whether the user can read a given resource.", - "readOnly" : true - }, - "canWrite" : { - "type" : "boolean", - "description" : "Indicates whether the user can write a given resource.", - "readOnly" : true - } - } - }, - "PortDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "versionedComponentId" : { - "type" : "string", - "description" : "The ID of the corresponding component that is under version control" - }, - "parentGroupId" : { - "type" : "string", - "description" : "The id of parent process group of this component if applicable." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "name" : { - "type" : "string", - "description" : "The name of the port." - }, - "comments" : { - "type" : "string", - "description" : "The comments for the port." - }, - "state" : { - "type" : "string", - "description" : "The state of the port.", - "enum" : [ "RUNNING", "STOPPED", "DISABLED" ] - }, - "type" : { - "type" : "string", - "description" : "The type of port.", - "enum" : [ "INPUT_PORT", "OUTPUT_PORT" ] - }, - "transmitting" : { - "type" : "boolean", - "description" : "Whether the port has incoming or output connections to a remote NiFi. This is only applicable when the port is allowed to be accessed remotely." - }, - "concurrentlySchedulableTaskCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of tasks that should be concurrently scheduled for the port." - }, - "userAccessControl" : { - "type" : "array", - "description" : "The users that are allowed to access the port.", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - }, - "groupAccessControl" : { - "type" : "array", - "description" : "The user groups that are allowed to access the port.", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - }, - "allowRemoteAccess" : { - "type" : "boolean", - "description" : "Whether this port can be accessed remotely via Site-to-Site protocol." - }, - "validationErrors" : { - "type" : "array", - "description" : "Gets the validation errors from this port. These validation errors represent the problems with the port that must be resolved before it can be started.", - "items" : { - "type" : "string" - } - } - } - }, - "PortEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "component" : { - "$ref" : "#/definitions/PortDTO" - }, - "status" : { - "description" : "The status of the port.", - "$ref" : "#/definitions/PortStatusDTO" - }, - "portType" : { - "type" : "string" - }, - "operatePermissions" : { - "description" : "The permissions for this component operations.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "allowRemoteAccess" : { - "type" : "boolean", - "description" : "Whether this port can be accessed remotely via Site-to-Site protocol." - } - }, - "xml" : { - "name" : "portEntity" - } - }, - "PortRunStatusEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "state" : { - "type" : "string", - "description" : "The run status of the Port.", - "enum" : [ "RUNNING", "STOPPED", "DISABLED" ] - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - } - }, - "xml" : { - "name" : "entity" - } - }, - "PortStatusDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the port." - }, - "groupId" : { - "type" : "string", - "description" : "The id of the parent process group of the port." - }, - "name" : { - "type" : "string", - "description" : "The name of the port." - }, - "transmitting" : { - "type" : "boolean", - "description" : "Whether the port has incoming or outgoing connections to a remote NiFi." - }, - "runStatus" : { - "type" : "string", - "description" : "The run status of the port.", - "enum" : [ "Running", "Stopped", "Validating", "Disabled", "Invalid" ] - }, - "statsLastRefreshed" : { - "type" : "string", - "description" : "The time the status for the process group was last refreshed." - }, - "aggregateSnapshot" : { - "description" : "A status snapshot that represents the aggregate stats of all nodes in the cluster. If the NiFi instance is a standalone instance, rather than a cluster, this represents the stats of the single instance.", - "$ref" : "#/definitions/PortStatusSnapshotDTO" - }, - "nodeSnapshots" : { - "type" : "array", - "description" : "A status snapshot for each node in the cluster. If the NiFi instance is a standalone instance, rather than a cluster, this may be null.", - "items" : { - "$ref" : "#/definitions/NodePortStatusSnapshotDTO" - } - } - } - }, - "PortStatusEntity" : { - "type" : "object", - "properties" : { - "portStatus" : { - "$ref" : "#/definitions/PortStatusDTO" - }, - "canRead" : { - "type" : "boolean", - "description" : "Indicates whether the user can read a given resource.", - "readOnly" : true - } - }, - "xml" : { - "name" : "portStatusEntity" - } - }, - "PortStatusSnapshotDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the port." - }, - "groupId" : { - "type" : "string", - "description" : "The id of the parent process group of the port." - }, - "name" : { - "type" : "string", - "description" : "The name of the port." - }, - "activeThreadCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The active thread count for the port." - }, - "flowFilesIn" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of FlowFiles that have been accepted in the last 5 minutes." - }, - "bytesIn" : { - "type" : "integer", - "format" : "int64", - "description" : "The size of hte FlowFiles that have been accepted in the last 5 minutes." - }, - "input" : { - "type" : "string", - "description" : "The count/size of flowfiles that have been accepted in the last 5 minutes." - }, - "flowFilesOut" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of FlowFiles that have been processed in the last 5 minutes." - }, - "bytesOut" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes that have been processed in the last 5 minutes." - }, - "output" : { - "type" : "string", - "description" : "The count/size of flowfiles that have been processed in the last 5 minutes." - }, - "transmitting" : { - "type" : "boolean", - "description" : "Whether the port has incoming or outgoing connections to a remote NiFi." - }, - "runStatus" : { - "type" : "string", - "description" : "The run status of the port.", - "enum" : [ "Running", "Stopped", "Validating", "Disabled", "Invalid" ] - } - } - }, - "PortStatusSnapshotEntity" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the port." - }, - "portStatusSnapshot" : { - "$ref" : "#/definitions/PortStatusSnapshotDTO" - }, - "canRead" : { - "type" : "boolean", - "description" : "Indicates whether the user can read a given resource.", - "readOnly" : true - } - }, - "xml" : { - "name" : "entity" - } - }, - "Position" : { - "type" : "object", - "properties" : { - "x" : { - "type" : "number", - "format" : "double", - "description" : "The x coordinate." - }, - "y" : { - "type" : "number", - "format" : "double", - "description" : "The y coordinate." - } - }, - "description" : "The position of a component on the graph" - }, - "PositionDTO" : { - "type" : "object", - "properties" : { - "x" : { - "type" : "number", - "format" : "double", - "description" : "The x coordinate." - }, - "y" : { - "type" : "number", - "format" : "double", - "description" : "The y coordinate." - } - } - }, - "PreviousValueDTO" : { - "type" : "object", - "properties" : { - "previousValue" : { - "type" : "string", - "description" : "The previous value." - }, - "timestamp" : { - "type" : "string", - "description" : "The timestamp when the value was modified." - }, - "userIdentity" : { - "type" : "string", - "description" : "The user who changed the previous value." - } - } - }, - "PrioritizerTypesEntity" : { - "type" : "object", - "properties" : { - "prioritizerTypes" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/DocumentedTypeDTO" - } - } - }, - "xml" : { - "name" : "prioritizerTypesEntity" - } - }, - "ProcessGroupDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "versionedComponentId" : { - "type" : "string", - "description" : "The ID of the corresponding component that is under version control" - }, - "parentGroupId" : { - "type" : "string", - "description" : "The id of parent process group of this component if applicable." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "name" : { - "type" : "string", - "description" : "The name of the process group." - }, - "comments" : { - "type" : "string", - "description" : "The comments for the process group." - }, - "variables" : { - "type" : "object", - "description" : "The variables that are configured for the Process Group. Note that this map contains only those variables that are defined on this Process Group and not any variables that are defined in the parent Process Group, etc. I.e., this Map will not contain all variables that are accessible by components in this Process Group by rather only the variables that are defined for this Process Group itself.", - "readOnly" : true, - "additionalProperties" : { - "type" : "string" - } - }, - "versionControlInformation" : { - "description" : "The Version Control information that indicates which Flow Registry, and where in the Flow Registry, this Process Group is tracking to; or null if this Process Group is not under version control", - "$ref" : "#/definitions/VersionControlInformationDTO" - }, - "parameterContext" : { - "description" : "The Parameter Context that this Process Group is bound to.", - "$ref" : "#/definitions/ParameterContextReferenceEntity" - }, - "flowfileConcurrency" : { - "type" : "string", - "description" : "The FlowFile Concurrency for this Process Group.", - "enum" : [ "UNBOUNDED", "SINGLE_FLOWFILE_PER_NODE", "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" ] - }, - "defaultFlowFileExpiration" : { - "type" : "string", - "description" : "The default FlowFile Expiration for this Process Group." - }, - "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." - }, - "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." - }, - "logFileSuffix" : { - "type" : "string", - "description" : "The log file suffix for this Process Group for dedicated logging." - }, - "runningCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of running components in this process group." - }, - "stoppedCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of stopped components in the process group." - }, - "invalidCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of invalid components in the process group." - }, - "disabledCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of disabled components in the process group." - }, - "activeRemotePortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of active remote ports in the process group." - }, - "inactiveRemotePortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of inactive remote ports in the process group." - }, - "upToDateCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of up to date versioned process groups in the process group." - }, - "locallyModifiedCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of locally modified versioned process groups in the process group." - }, - "staleCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of stale versioned process groups in the process group." - }, - "locallyModifiedAndStaleCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of locally modified and stale versioned process groups in the process group." - }, - "syncFailureCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of versioned process groups in the process group that are unable to sync to a registry." - }, - "localInputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of local input ports in the process group." - }, - "localOutputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of local output ports in the process group." - }, - "publicInputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of public input ports in the process group." - }, - "publicOutputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of public output ports in the process group." - }, - "contents" : { - "description" : "The contents of this process group.", - "$ref" : "#/definitions/FlowSnippetDTO" - }, - "inputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of input ports in the process group.", - "readOnly" : true - }, - "outputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of output ports in the process group.", - "readOnly" : true - } - } - }, - "ProcessGroupEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "component" : { - "$ref" : "#/definitions/ProcessGroupDTO" - }, - "status" : { - "description" : "The status of the process group.", - "$ref" : "#/definitions/ProcessGroupStatusDTO" - }, - "versionedFlowSnapshot" : { - "description" : "Returns the Versioned Flow that describes the contents of the Versioned Flow to be imported", - "readOnly" : true, - "$ref" : "#/definitions/RegisteredFlowSnapshot" - }, - "runningCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of running components in this process group." - }, - "stoppedCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of stopped components in the process group." - }, - "invalidCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of invalid components in the process group." - }, - "disabledCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of disabled components in the process group." - }, - "activeRemotePortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of active remote ports in the process group." - }, - "inactiveRemotePortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of inactive remote ports in the process group." - }, - "versionedFlowState" : { - "type" : "string", - "description" : "The current state of the Process Group, as it relates to the Versioned Flow", - "readOnly" : true, - "enum" : [ "LOCALLY_MODIFIED", "STALE", "LOCALLY_MODIFIED_AND_STALE", "UP_TO_DATE", "SYNC_FAILURE" ] - }, - "upToDateCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of up to date versioned process groups in the process group." - }, - "locallyModifiedCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of locally modified versioned process groups in the process group." - }, - "staleCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of stale versioned process groups in the process group." - }, - "locallyModifiedAndStaleCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of locally modified and stale versioned process groups in the process group." - }, - "syncFailureCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of versioned process groups in the process group that are unable to sync to a registry." - }, - "localInputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of local input ports in the process group." - }, - "localOutputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of local output ports in the process group." - }, - "publicInputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of public input ports in the process group." - }, - "publicOutputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of public output ports in the process group." - }, - "parameterContext" : { - "description" : "The Parameter Context, or null if no Parameter Context has been bound to the Process Group", - "$ref" : "#/definitions/ParameterContextReferenceEntity" - }, - "processGroupUpdateStrategy" : { - "type" : "string", - "description" : "Determines the process group update strategy", - "enum" : [ "DIRECT_CHILDREN", "ALL_DESCENDANTS" ] - }, - "inputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of input ports in the process group.", - "readOnly" : true - }, - "outputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of output ports in the process group.", - "readOnly" : true - } - }, - "xml" : { - "name" : "processGroupEntity" - } - }, - "ProcessGroupFlowDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "parentGroupId" : { - "type" : "string", - "description" : "The id of parent process group of this component if applicable." - }, - "parameterContext" : { - "description" : "The Parameter Context, or null if no Parameter Context has been bound to the Process Group", - "$ref" : "#/definitions/ParameterContextReferenceEntity" - }, - "breadcrumb" : { - "description" : "The breadcrumb of the process group.", - "$ref" : "#/definitions/FlowBreadcrumbEntity" - }, - "flow" : { - "description" : "The flow structure starting at this Process Group.", - "$ref" : "#/definitions/FlowDTO" - }, - "lastRefreshed" : { - "type" : "string", - "description" : "The time the flow for the process group was last refreshed." - } - } - }, - "ProcessGroupFlowEntity" : { - "type" : "object", - "properties" : { - "permissions" : { - "description" : "The access policy for this process group.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "processGroupFlow" : { - "$ref" : "#/definitions/ProcessGroupFlowDTO" - } - }, - "xml" : { - "name" : "processGroupFlowEntity" - } - }, - "ProcessGroupImportEntity" : { - "type" : "object", - "properties" : { - "processGroupRevision" : { - "description" : "The Revision for the Process Group", - "$ref" : "#/definitions/RevisionDTO" - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "versionedFlowSnapshot" : { - "description" : "The Versioned Flow Snapshot to import", - "$ref" : "#/definitions/RegisteredFlowSnapshot" - } - }, - "xml" : { - "name" : "processGroupImportEntity" - } - }, - "ProcessGroupNameDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The ID of the Process Group" - }, - "name" : { - "type" : "string", - "description" : "The name of the Process Group, or the ID of the Process Group if the user does not have the READ policy for the Process Group" - } - } - }, - "ProcessGroupReplaceRequestDTO" : { - "type" : "object", - "properties" : { - "requestId" : { - "type" : "string", - "description" : "The unique ID of this request.", - "readOnly" : true - }, - "processGroupId" : { - "type" : "string", - "description" : "The unique ID of the Process Group being updated" - }, - "uri" : { - "type" : "string", - "description" : "The URI for future requests to this drop request.", - "readOnly" : true - }, - "lastUpdated" : { - "type" : "string", - "description" : "The last time this request was updated.", - "readOnly" : true - }, - "complete" : { - "type" : "boolean", - "description" : "Whether or not this request has completed", - "readOnly" : true - }, - "failureReason" : { - "type" : "string", - "description" : "An explanation of why this request failed, or null if this request has not failed", - "readOnly" : true - }, - "percentCompleted" : { - "type" : "integer", - "format" : "int32", - "description" : "The percentage complete for the request, between 0 and 100", - "readOnly" : true - }, - "state" : { - "type" : "string", - "description" : "The state of the request", - "readOnly" : true - } - } - }, - "ProcessGroupReplaceRequestEntity" : { - "type" : "object", - "properties" : { - "processGroupRevision" : { - "description" : "The revision for the Process Group being updated.", - "$ref" : "#/definitions/RevisionDTO" - }, - "request" : { - "description" : "The Process Group Change Request", - "$ref" : "#/definitions/ProcessGroupReplaceRequestDTO" - }, - "versionedFlowSnapshot" : { - "description" : "Returns the Versioned Flow to replace with", - "readOnly" : true, - "$ref" : "#/definitions/RegisteredFlowSnapshot" - } - }, - "xml" : { - "name" : "processGroupReplaceRequestEntity" - } - }, - "ProcessGroupStatusDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The ID of the Process Group" - }, - "name" : { - "type" : "string", - "description" : "The name of the Process Group" - }, - "statsLastRefreshed" : { - "type" : "string", - "description" : "The time the status for the process group was last refreshed." - }, - "aggregateSnapshot" : { - "description" : "The aggregate status of all nodes in the cluster", - "$ref" : "#/definitions/ProcessGroupStatusSnapshotDTO" - }, - "nodeSnapshots" : { - "type" : "array", - "description" : "The status reported by each node in the cluster. If the NiFi instance is a standalone instance, rather than a clustered instance, this value may be null.", - "items" : { - "$ref" : "#/definitions/NodeProcessGroupStatusSnapshotDTO" - } - } - } - }, - "ProcessGroupStatusEntity" : { - "type" : "object", - "properties" : { - "processGroupStatus" : { - "$ref" : "#/definitions/ProcessGroupStatusDTO" - }, - "canRead" : { - "type" : "boolean", - "description" : "Indicates whether the user can read a given resource.", - "readOnly" : true - } - }, - "xml" : { - "name" : "processGroupStatusEntity" - } - }, - "ProcessGroupStatusSnapshotDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the process group." - }, - "name" : { - "type" : "string", - "description" : "The name of this process group." - }, - "connectionStatusSnapshots" : { - "type" : "array", - "description" : "The status of all connections in the process group.", - "items" : { - "$ref" : "#/definitions/ConnectionStatusSnapshotEntity" - } - }, - "processorStatusSnapshots" : { - "type" : "array", - "description" : "The status of all processors in the process group.", - "items" : { - "$ref" : "#/definitions/ProcessorStatusSnapshotEntity" - } - }, - "processGroupStatusSnapshots" : { - "type" : "array", - "description" : "The status of all process groups in the process group.", - "items" : { - "$ref" : "#/definitions/ProcessGroupStatusSnapshotEntity" - } - }, - "remoteProcessGroupStatusSnapshots" : { - "type" : "array", - "description" : "The status of all remote process groups in the process group.", - "items" : { - "$ref" : "#/definitions/RemoteProcessGroupStatusSnapshotEntity" - } - }, - "inputPortStatusSnapshots" : { - "type" : "array", - "description" : "The status of all input ports in the process group.", - "items" : { - "$ref" : "#/definitions/PortStatusSnapshotEntity" - } - }, - "outputPortStatusSnapshots" : { - "type" : "array", - "description" : "The status of all output ports in the process group.", - "items" : { - "$ref" : "#/definitions/PortStatusSnapshotEntity" - } - }, - "versionedFlowState" : { - "type" : "string", - "description" : "The current state of the Process Group, as it relates to the Versioned Flow", - "readOnly" : true, - "enum" : [ "LOCALLY_MODIFIED", "STALE", "LOCALLY_MODIFIED_AND_STALE", "UP_TO_DATE", "SYNC_FAILURE" ] - }, - "flowFilesIn" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of FlowFiles that have come into this ProcessGroup in the last 5 minutes" - }, - "bytesIn" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes that have come into this ProcessGroup in the last 5 minutes" - }, - "input" : { - "type" : "string", - "description" : "The input count/size for the process group in the last 5 minutes (pretty printed)." - }, - "flowFilesQueued" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of FlowFiles that are queued up in this ProcessGroup right now" - }, - "bytesQueued" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes that are queued up in this ProcessGroup right now" - }, - "queued" : { - "type" : "string", - "description" : "The count/size that is queued in the the process group." - }, - "queuedCount" : { - "type" : "string", - "description" : "The count that is queued for the process group." - }, - "queuedSize" : { - "type" : "string", - "description" : "The size that is queued for the process group." - }, - "bytesRead" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes read by components in this ProcessGroup in the last 5 minutes" - }, - "read" : { - "type" : "string", - "description" : "The number of bytes read in the last 5 minutes." - }, - "bytesWritten" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes written by components in this ProcessGroup in the last 5 minutes" - }, - "written" : { - "type" : "string", - "description" : "The number of bytes written in the last 5 minutes." - }, - "flowFilesOut" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of FlowFiles transferred out of this ProcessGroup in the last 5 minutes" - }, - "bytesOut" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes transferred out of this ProcessGroup in the last 5 minutes" - }, - "output" : { - "type" : "string", - "description" : "The output count/size for the process group in the last 5 minutes." - }, - "flowFilesTransferred" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of FlowFiles transferred in this ProcessGroup in the last 5 minutes" - }, - "bytesTransferred" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes transferred in this ProcessGroup in the last 5 minutes" - }, - "transferred" : { - "type" : "string", - "description" : "The count/size transferred to/from queues in the process group in the last 5 minutes." - }, - "bytesReceived" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes received from external sources by components within this ProcessGroup in the last 5 minutes" - }, - "flowFilesReceived" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of FlowFiles received from external sources by components within this ProcessGroup in the last 5 minutes" - }, - "received" : { - "type" : "string", - "description" : "The count/size sent to the process group in the last 5 minutes." - }, - "bytesSent" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes sent to an external sink by components within this ProcessGroup in the last 5 minutes" - }, - "flowFilesSent" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of FlowFiles sent to an external sink by components within this ProcessGroup in the last 5 minutes" - }, - "sent" : { - "type" : "string", - "description" : "The count/size sent from this process group in the last 5 minutes." - }, - "activeThreadCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The active thread count for this process group." - }, - "terminatedThreadCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of threads currently terminated for the process group." - }, - "processingNanos" : { - "type" : "integer", - "format" : "int64" - } - } - }, - "ProcessGroupStatusSnapshotEntity" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the process group." - }, - "processGroupStatusSnapshot" : { - "$ref" : "#/definitions/ProcessGroupStatusSnapshotDTO" - }, - "canRead" : { - "type" : "boolean", - "description" : "Indicates whether the user can read a given resource.", - "readOnly" : true - } - }, - "xml" : { - "name" : "entity" - } - }, - "ProcessGroupsEntity" : { - "type" : "object", - "properties" : { - "processGroups" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ProcessGroupEntity" - } - } - }, - "xml" : { - "name" : "processGroupsEntity" - } - }, - "ProcessorConfigDTO" : { - "type" : "object", - "properties" : { - "properties" : { - "type" : "object", - "description" : "The properties for the processor. Properties whose value is not set will only contain the property name.", - "additionalProperties" : { - "type" : "string" - } - }, - "descriptors" : { - "type" : "object", - "description" : "Descriptors for the processor's properties.", - "additionalProperties" : { - "$ref" : "#/definitions/PropertyDescriptorDTO" - } - }, - "sensitiveDynamicPropertyNames" : { - "type" : "array", - "description" : "Set of sensitive dynamic property names", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - }, - "schedulingPeriod" : { - "type" : "string", - "description" : "The frequency with which to schedule the processor. The format of the value will depend on th value of schedulingStrategy." - }, - "schedulingStrategy" : { - "type" : "string", - "description" : "Indcates whether the prcessor should be scheduled to run in event or timer driven mode." - }, - "executionNode" : { - "type" : "string", - "description" : "Indicates the node where the process will execute." - }, - "penaltyDuration" : { - "type" : "string", - "description" : "The amount of time that is used when the process penalizes a flowfile." - }, - "yieldDuration" : { - "type" : "string", - "description" : "The amount of time that must elapse before this processor is scheduled again after yielding." - }, - "bulletinLevel" : { - "type" : "string", - "description" : "The level at which the processor will report bulletins." - }, - "runDurationMillis" : { - "type" : "integer", - "format" : "int64", - "description" : "The run duration for the processor in milliseconds." - }, - "concurrentlySchedulableTaskCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of tasks that should be concurrently schedule for the processor. If the processor doesn't allow parallol processing then any positive input will be ignored." - }, - "autoTerminatedRelationships" : { - "type" : "array", - "description" : "The names of all relationships that cause a flow file to be terminated if the relationship is not connected elsewhere. This property differs from the 'isAutoTerminate' property of the RelationshipDTO in that the RelationshipDTO is meant to depict the current configuration, whereas this property can be set in a DTO when updating a Processor in order to change which Relationships should be auto-terminated.", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - }, - "comments" : { - "type" : "string", - "description" : "The comments for the processor." - }, - "customUiUrl" : { - "type" : "string", - "description" : "The URL for the processor's custom configuration UI if applicable." - }, - "lossTolerant" : { - "type" : "boolean", - "description" : "Whether the processor is loss tolerant." - }, - "annotationData" : { - "type" : "string", - "description" : "The annotation data for the processor used to relay configuration between a custom UI and the procesosr." - }, - "defaultConcurrentTasks" : { - "type" : "object", - "description" : "Maps default values for concurrent tasks for each applicable scheduling strategy.", - "additionalProperties" : { - "type" : "string" - } - }, - "defaultSchedulingPeriod" : { - "type" : "object", - "description" : "Maps default values for scheduling period for each applicable scheduling strategy.", - "additionalProperties" : { - "type" : "string" - } - }, - "retryCount" : { - "type" : "integer", - "format" : "int32", - "description" : "Overall number of retries." - }, - "retriedRelationships" : { - "type" : "array", - "description" : "All the relationships should be retried.", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - }, - "backoffMechanism" : { - "type" : "string", - "description" : "Determines whether the FlowFile should be penalized or the processor should be yielded between retries.", - "readOnly" : true, - "enum" : [ "PENALIZE_FLOWFILE", "YIELD_PROCESSOR" ] - }, - "maxBackoffPeriod" : { - "type" : "string", - "description" : "Maximum amount of time to be waited during a retry period." - } - } - }, - "ProcessorDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "versionedComponentId" : { - "type" : "string", - "description" : "The ID of the corresponding component that is under version control" - }, - "parentGroupId" : { - "type" : "string", - "description" : "The id of parent process group of this component if applicable." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "name" : { - "type" : "string", - "description" : "The name of the processor." - }, - "type" : { - "type" : "string", - "description" : "The type of the processor." - }, - "bundle" : { - "description" : "The details of the artifact that bundled this processor type.", - "$ref" : "#/definitions/BundleDTO" - }, - "state" : { - "type" : "string", - "description" : "The state of the processor", - "enum" : [ "RUNNING", "STOPPED", "DISABLED" ] - }, - "style" : { - "type" : "object", - "description" : "Styles for the processor (background-color : #eee).", - "additionalProperties" : { - "type" : "string" - } - }, - "relationships" : { - "type" : "array", - "description" : "The available relationships that the processor currently supports.", - "readOnly" : true, - "items" : { - "$ref" : "#/definitions/RelationshipDTO" - } - }, - "description" : { - "type" : "string", - "description" : "The description of the processor." - }, - "supportsParallelProcessing" : { - "type" : "boolean", - "description" : "Whether the processor supports parallel processing." - }, - "supportsEventDriven" : { - "type" : "boolean", - "description" : "Whether the processor supports event driven scheduling." - }, - "supportsBatching" : { - "type" : "boolean", - "description" : "Whether the processor supports batching. This makes the run duration settings available." - }, - "supportsSensitiveDynamicProperties" : { - "type" : "boolean", - "description" : "Whether the processor supports sensitive dynamic properties." - }, - "persistsState" : { - "type" : "boolean", - "description" : "Whether the processor persists state." - }, - "restricted" : { - "type" : "boolean", - "description" : "Whether the processor requires elevated privileges." - }, - "deprecated" : { - "type" : "boolean", - "description" : "Whether the processor has been deprecated." - }, - "executionNodeRestricted" : { - "type" : "boolean", - "description" : "Indicates if the execution node of a processor is restricted to run only on the primary node" - }, - "multipleVersionsAvailable" : { - "type" : "boolean", - "description" : "Whether the processor has multiple versions available." - }, - "inputRequirement" : { - "type" : "string", - "description" : "The input requirement for this processor." - }, - "config" : { - "description" : "The configuration details for the processor. These details will be included in a response if the verbose flag is included in a request.", - "$ref" : "#/definitions/ProcessorConfigDTO" - }, - "validationErrors" : { - "type" : "array", - "description" : "The validation errors for the processor. These validation errors represent the problems with the processor that must be resolved before it can be started.", - "items" : { - "type" : "string" - } - }, - "validationStatus" : { - "type" : "string", - "description" : "Indicates whether the Processor is valid, invalid, or still in the process of validating (i.e., it is unknown whether or not the Processor is valid)", - "readOnly" : true, - "enum" : [ "VALID", "INVALID", "VALIDATING" ] - }, - "extensionMissing" : { - "type" : "boolean", - "description" : "Whether the underlying extension is missing." - } - } - }, - "ProcessorDefinition" : { - "type" : "object", - "required" : [ "type" ], - "properties" : { - "group" : { - "type" : "string", - "description" : "The group name of the bundle that provides the referenced type." - }, - "artifact" : { - "type" : "string", - "description" : "The artifact name of the bundle that provides the referenced type." - }, - "version" : { - "type" : "string", - "description" : "The version 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." - }, - "buildInfo" : { - "description" : "The build metadata for this component", - "$ref" : "#/definitions/BuildInfo" - }, - "providedApiImplementations" : { - "type" : "array", - "description" : "If this type represents a provider for an interface, this lists the APIs it implements", - "items" : { - "$ref" : "#/definitions/DefinedType" - } - }, - "tags" : { - "type" : "array", - "description" : "The tags associated with this type", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - }, - "seeAlso" : { - "type" : "array", - "description" : "The names of other component types that may be related", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - }, - "deprecated" : { - "type" : "boolean", - "description" : "Whether or not the component has been deprecated" - }, - "deprecationReason" : { - "type" : "string", - "description" : "If this component has been deprecated, this optional field can be used to provide an explanation" - }, - "deprecationAlternatives" : { - "type" : "array", - "description" : "If this component has been deprecated, this optional field provides alternatives to use", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - }, - "restricted" : { - "type" : "boolean", - "description" : "Whether or not the component has a general restriction" - }, - "restrictedExplanation" : { - "type" : "string", - "description" : "An optional description of the general restriction" - }, - "explicitRestrictions" : { - "type" : "array", - "description" : "Explicit restrictions that indicate a require permission to use the component", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/Restriction" - } - }, - "stateful" : { - "description" : "Indicates if the component stores state", - "$ref" : "#/definitions/Stateful" - }, - "systemResourceConsiderations" : { - "type" : "array", - "description" : "The system resource considerations for the given component", - "items" : { - "$ref" : "#/definitions/SystemResourceConsideration" - } - }, - "additionalDetails" : { - "type" : "boolean", - "description" : "Indicates if the component has additional details documentation" - }, - "propertyDescriptors" : { - "type" : "object", - "description" : "Descriptions of configuration properties applicable to this component.", - "additionalProperties" : { - "$ref" : "#/definitions/PropertyDescriptor" - } - }, - "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." - }, - "dynamicProperties" : { - "type" : "array", - "description" : "Describes the dynamic properties supported by this component", - "items" : { - "$ref" : "#/definitions/DynamicProperty" - } - }, - "inputRequirement" : { - "type" : "string", - "description" : "Any input requirements this processor has.", - "enum" : [ "INPUT_REQUIRED", "INPUT_ALLOWED", "INPUT_FORBIDDEN" ] - }, - "supportedRelationships" : { - "type" : "array", - "description" : "The supported relationships for this processor.", - "items" : { - "$ref" : "#/definitions/Relationship" - } - }, - "supportsDynamicRelationships" : { - "type" : "boolean", - "description" : "Whether or not this processor supports dynamic relationships." - }, - "dynamicRelationship" : { - "description" : "If the processor supports dynamic relationships, this describes the dynamic relationship", - "$ref" : "#/definitions/DynamicRelationship" - }, - "triggerSerially" : { - "type" : "boolean", - "description" : "Whether or not this processor should be triggered serially (i.e. no concurrent execution)." - }, - "triggerWhenEmpty" : { - "type" : "boolean", - "description" : "Whether or not this processor should be triggered when incoming queues are empty." - }, - "triggerWhenAnyDestinationAvailable" : { - "type" : "boolean", - "description" : "Whether or not this processor should be triggered when any destination queue has room." - }, - "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." - }, - "supportsEventDriven" : { - "type" : "boolean", - "description" : "Whether or not this processor supports event driven scheduling. Indicates to the framework that the Processor is eligible to be scheduled to run based on the occurrence of an \"Event\" (e.g., when a FlowFile is enqueued in an incoming Connection), rather than being triggered periodically." - }, - "primaryNodeOnly" : { - "type" : "boolean", - "description" : "Whether or not this processor should be scheduled only on the primary node in a cluster." - }, - "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." - }, - "supportedSchedulingStrategies" : { - "type" : "array", - "description" : "The supported scheduling strategies, such as TIME_DRIVER, CRON, or EVENT_DRIVEN.", - "items" : { - "type" : "string" - } - }, - "defaultSchedulingStrategy" : { - "type" : "string", - "description" : "The default scheduling strategy for the processor." - }, - "defaultConcurrentTasksBySchedulingStrategy" : { - "type" : "object", - "description" : "The default concurrent tasks for each scheduling strategy.", - "additionalProperties" : { - "type" : "integer", - "format" : "int32" - } - }, - "defaultSchedulingPeriodBySchedulingStrategy" : { - "type" : "object", - "description" : "The default scheduling period for each scheduling strategy. The scheduling period is expected to be a time period, such as \"30 sec\".", - "additionalProperties" : { - "type" : "string" - } - }, - "defaultPenaltyDuration" : { - "type" : "string", - "description" : "The default penalty duration as a time period, such as \"30 sec\"." - }, - "defaultYieldDuration" : { - "type" : "string", - "description" : "The default yield duration as a time period, such as \"1 sec\"." - }, - "defaultBulletinLevel" : { - "type" : "string", - "description" : "The default bulletin level, such as WARN, INFO, DEBUG, etc." - }, - "readsAttributes" : { - "type" : "array", - "description" : "The FlowFile attributes this processor reads", - "items" : { - "$ref" : "#/definitions/Attribute" - } - }, - "writesAttributes" : { - "type" : "array", - "description" : "The FlowFile attributes this processor writes/updates", - "items" : { - "$ref" : "#/definitions/Attribute" - } - } - } - }, - "ProcessorDiagnosticsDTO" : { - "type" : "object", - "properties" : { - "processor" : { - "description" : "Information about the Processor for which the Diagnostic Report is generated", - "$ref" : "#/definitions/ProcessorDTO" - }, - "processorStatus" : { - "description" : "The Status for the Processor for which the Diagnostic Report is generated", - "$ref" : "#/definitions/ProcessorStatusDTO" - }, - "referencedControllerServices" : { - "type" : "array", - "description" : "Diagnostic Information about all Controller Services that the Processor is referencing", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ControllerServiceDiagnosticsDTO" - } - }, - "incomingConnections" : { - "type" : "array", - "description" : "Diagnostic Information about all incoming Connections", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ConnectionDiagnosticsDTO" - } - }, - "outgoingConnections" : { - "type" : "array", - "description" : "Diagnostic Information about all outgoing Connections", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ConnectionDiagnosticsDTO" - } - }, - "jvmDiagnostics" : { - "description" : "Diagnostic Information about the JVM and system-level diagnostics", - "$ref" : "#/definitions/JVMDiagnosticsDTO" - }, - "threadDumps" : { - "type" : "array", - "description" : "Thread Dumps that were taken of the threads that are active in the Processor", - "items" : { - "$ref" : "#/definitions/ThreadDumpDTO" - } - }, - "classLoaderDiagnostics" : { - "description" : "Information about the Controller Service's Class Loader", - "$ref" : "#/definitions/ClassLoaderDiagnosticsDTO" - } - } - }, - "ProcessorDiagnosticsEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "component" : { - "description" : "The Processor Diagnostics", - "$ref" : "#/definitions/ProcessorDiagnosticsDTO" - } - }, - "xml" : { - "name" : "processorDiagnosticsEntity" - } - }, - "ProcessorEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "component" : { - "$ref" : "#/definitions/ProcessorDTO" - }, - "inputRequirement" : { - "type" : "string", - "description" : "The input requirement for this processor." - }, - "status" : { - "$ref" : "#/definitions/ProcessorStatusDTO" - }, - "operatePermissions" : { - "description" : "The permissions for this component operations.", - "$ref" : "#/definitions/PermissionsDTO" - } - }, - "xml" : { - "name" : "processorEntity" - } - }, - "ProcessorRunStatusDetailsDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The ID of the processor" - }, - "name" : { - "type" : "string", - "description" : "The name of the processor" - }, - "runStatus" : { - "type" : "string", - "description" : "The run status of the processor", - "enum" : [ "Running", "Stopped", "Invalid", "Validating", "Disabled" ] - }, - "validationErrors" : { - "type" : "array", - "description" : "The processor's validation errors", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - }, - "activeThreadCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The current number of threads that the processor is currently using" - } - } - }, - "ProcessorRunStatusDetailsEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for the Processor.", - "$ref" : "#/definitions/RevisionDTO" - }, - "permissions" : { - "description" : "The permissions for the Processor.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "runStatusDetails" : { - "description" : "The details of a Processor's run status", - "$ref" : "#/definitions/ProcessorRunStatusDetailsDTO" - } - }, - "xml" : { - "name" : "entity" - } - }, - "ProcessorRunStatusEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "state" : { - "type" : "string", - "description" : "The run status of the Processor.", - "enum" : [ "RUNNING", "STOPPED", "DISABLED", "RUN_ONCE" ] - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - } - }, - "xml" : { - "name" : "entity" - } - }, - "ProcessorStatusDTO" : { - "type" : "object", - "properties" : { - "groupId" : { - "type" : "string", - "description" : "The unique ID of the process group that the Processor belongs to" - }, - "id" : { - "type" : "string", - "description" : "The unique ID of the Processor" - }, - "name" : { - "type" : "string", - "description" : "The name of the Processor" - }, - "type" : { - "type" : "string", - "description" : "The type of the Processor" - }, - "runStatus" : { - "type" : "string", - "description" : "The run status of the Processor", - "enum" : [ "Running", "Stopped", "Validating", "Disabled", "Invalid" ] - }, - "statsLastRefreshed" : { - "type" : "string", - "description" : "The timestamp of when the stats were last refreshed" - }, - "aggregateSnapshot" : { - "description" : "A status snapshot that represents the aggregate stats of all nodes in the cluster. If the NiFi instance is a standalone instance, rather than a cluster, this represents the stats of the single instance.", - "$ref" : "#/definitions/ProcessorStatusSnapshotDTO" - }, - "nodeSnapshots" : { - "type" : "array", - "description" : "A status snapshot for each node in the cluster. If the NiFi instance is a standalone instance, rather than a cluster, this may be null.", - "items" : { - "$ref" : "#/definitions/NodeProcessorStatusSnapshotDTO" - } - } - } - }, - "ProcessorStatusEntity" : { - "type" : "object", - "properties" : { - "processorStatus" : { - "$ref" : "#/definitions/ProcessorStatusDTO" - }, - "canRead" : { - "type" : "boolean", - "description" : "Indicates whether the user can read a given resource.", - "readOnly" : true - } - }, - "xml" : { - "name" : "processorStatusEntity" - } - }, - "ProcessorStatusSnapshotDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the processor." - }, - "groupId" : { - "type" : "string", - "description" : "The id of the parent process group to which the processor belongs." - }, - "name" : { - "type" : "string", - "description" : "The name of the prcessor." - }, - "type" : { - "type" : "string", - "description" : "The type of the processor." - }, - "runStatus" : { - "type" : "string", - "description" : "The state of the processor.", - "enum" : [ "Running", "Stopped", "Validating", "Disabled", "Invalid" ] - }, - "executionNode" : { - "type" : "string", - "description" : "Indicates the node where the process will execute.", - "enum" : [ "ALL", "PRIMARY" ] - }, - "bytesRead" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes read by this Processor in the last 5 mintues" - }, - "bytesWritten" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes written by this Processor in the last 5 minutes" - }, - "read" : { - "type" : "string", - "description" : "The number of bytes read in the last 5 minutes." - }, - "written" : { - "type" : "string", - "description" : "The number of bytes written in the last 5 minutes." - }, - "flowFilesIn" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of FlowFiles that have been accepted in the last 5 minutes" - }, - "bytesIn" : { - "type" : "integer", - "format" : "int64", - "description" : "The size of the FlowFiles that have been accepted in the last 5 minutes" - }, - "input" : { - "type" : "string", - "description" : "The count/size of flowfiles that have been accepted in the last 5 minutes." - }, - "flowFilesOut" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of FlowFiles transferred to a Connection in the last 5 minutes" - }, - "bytesOut" : { - "type" : "integer", - "format" : "int64", - "description" : "The size of the FlowFiles transferred to a Connection in the last 5 minutes" - }, - "output" : { - "type" : "string", - "description" : "The count/size of flowfiles that have been processed in the last 5 minutes." - }, - "taskCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of times this Processor has run in the last 5 minutes" - }, - "tasksDurationNanos" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of nanoseconds that this Processor has spent running in the last 5 minutes" - }, - "tasks" : { - "type" : "string", - "description" : "The total number of task this connectable has completed over the last 5 minutes." - }, - "tasksDuration" : { - "type" : "string", - "description" : "The total duration of all tasks for this connectable over the last 5 minutes." - }, - "activeThreadCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of threads currently executing in the processor." - }, - "terminatedThreadCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of threads currently terminated for the processor." - } - } - }, - "ProcessorStatusSnapshotEntity" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the processor." - }, - "processorStatusSnapshot" : { - "$ref" : "#/definitions/ProcessorStatusSnapshotDTO" - }, - "canRead" : { - "type" : "boolean", - "description" : "Indicates whether the user can read a given resource.", - "readOnly" : true - } - }, - "xml" : { - "name" : "entity" - } - }, - "ProcessorTypesEntity" : { - "type" : "object", - "properties" : { - "processorTypes" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/DocumentedTypeDTO" - } - } - }, - "xml" : { - "name" : "processorTypesEntity" - } - }, - "ProcessorsEntity" : { - "type" : "object", - "properties" : { - "processors" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ProcessorEntity" - } - } - }, - "xml" : { - "name" : "processorsEntity" - } - }, - "ProcessorsRunStatusDetailsEntity" : { - "type" : "object", - "properties" : { - "runStatusDetails" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/ProcessorRunStatusDetailsEntity" - } - } - }, - "xml" : { - "name" : "processorsRunStatusDetails" - } - }, - "PropertyAllowableValue" : { - "type" : "object", - "required" : [ "value" ], - "properties" : { - "value" : { - "type" : "string", - "description" : "The internal value" - }, - "displayName" : { - "type" : "string", - "description" : "The display name of the value, if different from the internal value" - }, - "description" : { - "type" : "string", - "description" : "The description of the value, e.g., the behavior it produces." - } - } - }, - "PropertyDependency" : { - "type" : "object", - "properties" : { - "propertyName" : { - "type" : "string", - "description" : "The name of the property that is depended upon" - }, - "propertyDisplayName" : { - "type" : "string", - "description" : "The name of the property that is depended upon" - }, - "dependentValues" : { - "type" : "array", - "description" : "The values that satisfy the dependency", - "items" : { - "type" : "string" - } - } - } - }, - "PropertyDependencyDTO" : { - "type" : "object", - "properties" : { - "propertyName" : { - "type" : "string", - "description" : "The name of the property that is being depended upon" - }, - "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", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - } - } - }, - "PropertyDescriptor" : { - "type" : "object", - "required" : [ "name" ], - "properties" : { - "name" : { - "type" : "string", - "description" : "The name of the property key" - }, - "displayName" : { - "type" : "string", - "description" : "The display name of the property key, if different from the name" - }, - "description" : { - "type" : "string", - "description" : "The description of what the property does" - }, - "allowableValues" : { - "type" : "array", - "description" : "A list of the allowable values for the property", - "items" : { - "$ref" : "#/definitions/PropertyAllowableValue" - } - }, - "defaultValue" : { - "type" : "string", - "description" : "The default value if a user-set value is not specified" - }, - "required" : { - "type" : "boolean", - "description" : "Whether or not the property is required for the component" - }, - "sensitive" : { - "type" : "boolean", - "description" : "Whether or not the value of the property is considered sensitive (e.g., passwords and keys)" - }, - "expressionLanguageScope" : { - "type" : "string", - "description" : "The scope of expression language supported by this property", - "enum" : [ "NONE", "VARIABLE_REGISTRY", "FLOWFILE_ATTRIBUTES" ] - }, - "expressionLanguageScopeDescription" : { - "type" : "string", - "description" : "The description of the expression language scope supported by this property", - "readOnly" : true - }, - "typeProvidedByValue" : { - "description" : "Indicates that this property is for selecting a controller service of the specified type", - "$ref" : "#/definitions/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" - }, - "dynamic" : { - "type" : "boolean", - "description" : "Whether or not the descriptor is for a dynamically added property" - }, - "resourceDefinition" : { - "description" : "Indicates that this property references external resources", - "$ref" : "#/definitions/PropertyResourceDefinition" - }, - "dependencies" : { - "type" : "array", - "description" : "The dependencies that this property has on other properties", - "items" : { - "$ref" : "#/definitions/PropertyDependency" - } - } - } - }, - "PropertyDescriptorDTO" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The name for the property." - }, - "displayName" : { - "type" : "string", - "description" : "The human readable name for the property." - }, - "description" : { - "type" : "string", - "description" : "The description for the property. Used to relay additional details to a user or provide a mechanism of documenting intent." - }, - "defaultValue" : { - "type" : "string", - "description" : "The default value for the property." - }, - "allowableValues" : { - "type" : "array", - "description" : "Allowable values for the property. If empty then the allowed values are not constrained.", - "items" : { - "$ref" : "#/definitions/AllowableValueEntity" - } - }, - "required" : { - "type" : "boolean", - "description" : "Whether the property is required." - }, - "sensitive" : { - "type" : "boolean", - "description" : "Whether the property is sensitive and protected whenever stored or represented." - }, - "dynamic" : { - "type" : "boolean", - "description" : "Whether the property is dynamic (user-defined)." - }, - "supportsEl" : { - "type" : "boolean", - "description" : "Whether the property supports expression language." - }, - "expressionLanguageScope" : { - "type" : "string", - "description" : "Scope of the Expression Language evaluation for the property." - }, - "identifiesControllerService" : { - "type" : "string", - "description" : "If the property identifies a controller service this returns the fully qualified type." - }, - "identifiesControllerServiceBundle" : { - "description" : "If the property identifies a controller service this returns the bundle of the type, null otherwise.", - "$ref" : "#/definitions/BundleDTO" - }, - "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" : "#/definitions/PropertyDependencyDTO" - } - } - } - }, - "PropertyDescriptorEntity" : { - "type" : "object", - "properties" : { - "propertyDescriptor" : { - "$ref" : "#/definitions/PropertyDescriptorDTO" - } - }, - "xml" : { - "name" : "propertyDescriptor" - } - }, - "PropertyHistoryDTO" : { - "type" : "object", - "properties" : { - "previousValues" : { - "type" : "array", - "description" : "Previous values for a given property.", - "items" : { - "$ref" : "#/definitions/PreviousValueDTO" - } - } - } - }, - "PropertyResourceDefinition" : { - "type" : "object", - "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", - "uniqueItems" : true, - "items" : { - "type" : "string", - "enum" : [ "FILE", "DIRECTORY", "TEXT", "URL" ] - } - } - } - }, - "ProvenanceDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the provenance query." - }, - "uri" : { - "type" : "string", - "description" : "The URI for this query. Used for obtaining/deleting the request at a later time" - }, - "submissionTime" : { - "type" : "string", - "description" : "The timestamp when the query was submitted." - }, - "expiration" : { - "type" : "string", - "description" : "The timestamp when the query will expire." - }, - "percentCompleted" : { - "type" : "integer", - "format" : "int32", - "description" : "The current percent complete." - }, - "finished" : { - "type" : "boolean", - "description" : "Whether the query has finished." - }, - "request" : { - "description" : "The provenance request.", - "$ref" : "#/definitions/ProvenanceRequestDTO" - }, - "results" : { - "description" : "The provenance results.", - "$ref" : "#/definitions/ProvenanceResultsDTO" - } - } - }, - "ProvenanceEntity" : { - "type" : "object", - "properties" : { - "provenance" : { - "$ref" : "#/definitions/ProvenanceDTO" - } - }, - "xml" : { - "name" : "provenanceEntity" - } - }, - "ProvenanceEventDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The event uuid." - }, - "eventId" : { - "type" : "integer", - "format" : "int64", - "description" : "The event id. This is a one up number thats unique per node." - }, - "eventTime" : { - "type" : "string", - "description" : "The timestamp of the event." - }, - "eventDuration" : { - "type" : "integer", - "format" : "int64", - "description" : "The event duration in milliseconds." - }, - "lineageDuration" : { - "type" : "integer", - "format" : "int64", - "description" : "The duration since the lineage began, in milliseconds." - }, - "eventType" : { - "type" : "string", - "description" : "The type of the event." - }, - "flowFileUuid" : { - "type" : "string", - "description" : "The uuid of the flowfile for the event." - }, - "fileSize" : { - "type" : "string", - "description" : "The size of the flowfile for the event." - }, - "fileSizeBytes" : { - "type" : "integer", - "format" : "int64", - "description" : "The size of the flowfile in bytes for the event." - }, - "clusterNodeId" : { - "type" : "string", - "description" : "The identifier for the node where the event originated." - }, - "clusterNodeAddress" : { - "type" : "string", - "description" : "The label for the node where the event originated." - }, - "groupId" : { - "type" : "string", - "description" : "The id of the group that the component resides in. If the component is no longer in the flow, the group id will not be set." - }, - "componentId" : { - "type" : "string", - "description" : "The id of the component that generated the event." - }, - "componentType" : { - "type" : "string", - "description" : "The type of the component that generated the event." - }, - "componentName" : { - "type" : "string", - "description" : "The name of the component that generated the event." - }, - "sourceSystemFlowFileId" : { - "type" : "string", - "description" : "The source system flowfile id." - }, - "alternateIdentifierUri" : { - "type" : "string", - "description" : "The alternate identifier uri for the fileflow for the event." - }, - "attributes" : { - "type" : "array", - "description" : "The attributes of the flowfile for the event.", - "items" : { - "$ref" : "#/definitions/AttributeDTO" - } - }, - "parentUuids" : { - "type" : "array", - "description" : "The parent uuids for the event.", - "items" : { - "type" : "string" - } - }, - "childUuids" : { - "type" : "array", - "description" : "The child uuids for the event.", - "items" : { - "type" : "string" - } - }, - "transitUri" : { - "type" : "string", - "description" : "The source/destination system uri if the event was a RECEIVE/SEND." - }, - "relationship" : { - "type" : "string", - "description" : "The relationship to which the flowfile was routed if the event is of type ROUTE." - }, - "details" : { - "type" : "string", - "description" : "The event details." - }, - "contentEqual" : { - "type" : "boolean", - "description" : "Whether the input and output content claim is the same." - }, - "inputContentAvailable" : { - "type" : "boolean", - "description" : "Whether the input content is still available." - }, - "inputContentClaimSection" : { - "type" : "string", - "description" : "The section in which the input content claim lives." - }, - "inputContentClaimContainer" : { - "type" : "string", - "description" : "The container in which the input content claim lives." - }, - "inputContentClaimIdentifier" : { - "type" : "string", - "description" : "The identifier of the input content claim." - }, - "inputContentClaimOffset" : { - "type" : "integer", - "format" : "int64", - "description" : "The offset into the input content claim where the flowfiles content begins." - }, - "inputContentClaimFileSize" : { - "type" : "string", - "description" : "The file size of the input content claim formatted." - }, - "inputContentClaimFileSizeBytes" : { - "type" : "integer", - "format" : "int64", - "description" : "The file size of the intput content claim in bytes." - }, - "outputContentAvailable" : { - "type" : "boolean", - "description" : "Whether the output content is still available." - }, - "outputContentClaimSection" : { - "type" : "string", - "description" : "The section in which the output content claim lives." - }, - "outputContentClaimContainer" : { - "type" : "string", - "description" : "The container in which the output content claim lives." - }, - "outputContentClaimIdentifier" : { - "type" : "string", - "description" : "The identifier of the output content claim." - }, - "outputContentClaimOffset" : { - "type" : "integer", - "format" : "int64", - "description" : "The offset into the output content claim where the flowfiles content begins." - }, - "outputContentClaimFileSize" : { - "type" : "string", - "description" : "The file size of the output content claim formatted." - }, - "outputContentClaimFileSizeBytes" : { - "type" : "integer", - "format" : "int64", - "description" : "The file size of the output content claim in bytes." - }, - "replayAvailable" : { - "type" : "boolean", - "description" : "Whether or not replay is available." - }, - "replayExplanation" : { - "type" : "string", - "description" : "Explanation as to why replay is unavailable." - }, - "sourceConnectionIdentifier" : { - "type" : "string", - "description" : "The identifier of the queue/connection from which the flowfile was pulled to genereate this event. May be null if the queue/connection is unknown or the flowfile was generated from this event." - } - } - }, - "ProvenanceEventEntity" : { - "type" : "object", - "properties" : { - "provenanceEvent" : { - "$ref" : "#/definitions/ProvenanceEventDTO" - } - }, - "xml" : { - "name" : "provenanceEventEntity" - } - }, - "ProvenanceLinkDTO" : { - "type" : "object", - "properties" : { - "sourceId" : { - "type" : "string", - "description" : "The source node id of the link." - }, - "targetId" : { - "type" : "string", - "description" : "The target node id of the link." - }, - "flowFileUuid" : { - "type" : "string", - "description" : "The flowfile uuid that traversed the link." - }, - "timestamp" : { - "type" : "string", - "description" : "The timestamp of the link (based on the destination)." - }, - "millis" : { - "type" : "integer", - "format" : "int64", - "description" : "The timestamp of this link in milliseconds." - } - } - }, - "ProvenanceNodeDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the node." - }, - "flowFileUuid" : { - "type" : "string", - "description" : "The uuid of the flowfile associated with the provenance event." - }, - "parentUuids" : { - "type" : "array", - "description" : "The uuid of the parent flowfiles of the provenance event.", - "items" : { - "type" : "string" - } - }, - "childUuids" : { - "type" : "array", - "description" : "The uuid of the childrent flowfiles of the provenance event.", - "items" : { - "type" : "string" - } - }, - "clusterNodeIdentifier" : { - "type" : "string", - "description" : "The identifier of the node that this event/flowfile originated from." - }, - "type" : { - "type" : "string", - "description" : "The type of the node.", - "enum" : [ "FLOWFILE", "EVENT" ] - }, - "eventType" : { - "type" : "string", - "description" : "If the type is EVENT, this is the type of event." - }, - "millis" : { - "type" : "integer", - "format" : "int64", - "description" : "The timestamp of the node in milliseconds." - }, - "timestamp" : { - "type" : "string", - "description" : "The timestamp of the node formatted." - } - } - }, - "ProvenanceOptionsDTO" : { - "type" : "object", - "properties" : { - "searchableFields" : { - "type" : "array", - "description" : "The available searchable field for the NiFi.", - "items" : { - "$ref" : "#/definitions/ProvenanceSearchableFieldDTO" - } - } - } - }, - "ProvenanceOptionsEntity" : { - "type" : "object", - "properties" : { - "provenanceOptions" : { - "$ref" : "#/definitions/ProvenanceOptionsDTO" - } - }, - "xml" : { - "name" : "provenanceOptionsEntity" - } - }, - "ProvenanceRequestDTO" : { - "type" : "object", - "properties" : { - "searchTerms" : { - "type" : "object", - "description" : "The search terms used to perform the search.", - "additionalProperties" : { - "$ref" : "#/definitions/ProvenanceSearchValueDTO" - } - }, - "clusterNodeId" : { - "type" : "string", - "description" : "The id of the node in the cluster where this provenance originated." - }, - "startDate" : { - "type" : "string", - "description" : "The earliest event time to include in the query." - }, - "endDate" : { - "type" : "string", - "description" : "The latest event time to include in the query." - }, - "minimumFileSize" : { - "type" : "string", - "description" : "The minimum file size to include in the query." - }, - "maximumFileSize" : { - "type" : "string", - "description" : "The maximum file size to include in the query." - }, - "maxResults" : { - "type" : "integer", - "format" : "int32", - "description" : "The maximum number of results to include." - }, - "summarize" : { - "type" : "boolean", - "description" : "Whether or not to summarize provenance events returned. This property is false by default." - }, - "incrementalResults" : { - "type" : "boolean", - "description" : "Whether or not incremental results are returned. If false, provenance events are only returned once the query completes. This property is true by default." - } - } - }, - "ProvenanceResultsDTO" : { - "type" : "object", - "properties" : { - "provenanceEvents" : { - "type" : "array", - "description" : "The provenance events that matched the search criteria.", - "items" : { - "$ref" : "#/definitions/ProvenanceEventDTO" - } - }, - "total" : { - "type" : "string", - "description" : "The total number of results formatted." - }, - "totalCount" : { - "type" : "integer", - "format" : "int64", - "description" : "The total number of results." - }, - "generated" : { - "type" : "string", - "description" : "Then the search was performed." - }, - "oldestEvent" : { - "type" : "string", - "description" : "The oldest event available in the provenance repository." - }, - "timeOffset" : { - "type" : "integer", - "format" : "int32", - "description" : "The time offset of the server that's used for event time." - }, - "errors" : { - "type" : "array", - "description" : "Any errors that occurred while performing the provenance request.", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - } - } - }, - "ProvenanceSearchValueDTO" : { - "type" : "object", - "properties" : { - "value" : { - "type" : "string", - "description" : "The search value." - }, - "inverse" : { - "type" : "boolean", - "description" : "Query for all except for search value." - } - } - }, - "ProvenanceSearchableFieldDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the searchable field." - }, - "field" : { - "type" : "string", - "description" : "The searchable field." - }, - "label" : { - "type" : "string", - "description" : "The label for the searchable field." - }, - "type" : { - "type" : "string", - "description" : "The type of the searchable field." - } - } - }, - "QueueSizeDTO" : { - "type" : "object", - "properties" : { - "byteCount" : { - "type" : "integer", - "format" : "int64", - "description" : "The size of objects in a queue." - }, - "objectCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The count of objects in a queue." - } - } - }, - "RegisteredFlow" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string" - }, - "name" : { - "type" : "string" - }, - "description" : { - "type" : "string" - }, - "bucketIdentifier" : { - "type" : "string" - }, - "bucketName" : { - "type" : "string" - }, - "createdTimestamp" : { - "type" : "integer", - "format" : "int64" - }, - "lastModifiedTimestamp" : { - "type" : "integer", - "format" : "int64" - }, - "permissions" : { - "$ref" : "#/definitions/FlowRegistryPermissions" - }, - "versionCount" : { - "type" : "integer", - "format" : "int64" - }, - "versionInfo" : { - "$ref" : "#/definitions/RegisteredFlowVersionInfo" - } - } - }, - "RegisteredFlowSnapshot" : { - "type" : "object", - "properties" : { - "snapshotMetadata" : { - "$ref" : "#/definitions/RegisteredFlowSnapshotMetadata" - }, - "flow" : { - "$ref" : "#/definitions/RegisteredFlow" - }, - "bucket" : { - "$ref" : "#/definitions/FlowRegistryBucket" - }, - "flowContents" : { - "$ref" : "#/definitions/VersionedProcessGroup" - }, - "externalControllerServices" : { - "type" : "object", - "additionalProperties" : { - "$ref" : "#/definitions/ExternalControllerServiceReference" - } - }, - "parameterContexts" : { - "type" : "object", - "additionalProperties" : { - "$ref" : "#/definitions/VersionedParameterContext" - } - }, - "flowEncodingVersion" : { - "type" : "string" - }, - "parameterProviders" : { - "type" : "object", - "additionalProperties" : { - "$ref" : "#/definitions/ParameterProviderReference" - } - }, - "latest" : { - "type" : "boolean" - } - } - }, - "RegisteredFlowSnapshotMetadata" : { - "type" : "object", - "properties" : { - "bucketIdentifier" : { - "type" : "string" - }, - "flowIdentifier" : { - "type" : "string" - }, - "version" : { - "type" : "integer", - "format" : "int32" - }, - "timestamp" : { - "type" : "integer", - "format" : "int64" - }, - "author" : { - "type" : "string" - }, - "comments" : { - "type" : "string" - } - } - }, - "RegisteredFlowVersionInfo" : { - "type" : "object", - "properties" : { - "version" : { - "type" : "integer", - "format" : "int64" - } - } - }, - "Relationship" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The name of the relationship" - }, - "description" : { - "type" : "string", - "description" : "The description of the relationship" - } - } - }, - "RelationshipDTO" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The relationship name." - }, - "description" : { - "type" : "string", - "description" : "The relationship description." - }, - "autoTerminate" : { - "type" : "boolean", - "description" : "Whether or not flowfiles sent to this relationship should auto terminate." - }, - "retry" : { - "type" : "boolean", - "description" : "Whether or not flowfiles sent to this relationship should retry." - } - } - }, - "RemotePortRunStatusEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "state" : { - "type" : "string", - "description" : "The run status of the RemotePort.", - "enum" : [ "TRANSMITTING", "STOPPED" ] - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - } - }, - "xml" : { - "name" : "entity" - } - }, - "RemoteProcessGroupContentsDTO" : { - "type" : "object", - "properties" : { - "inputPorts" : { - "type" : "array", - "description" : "The input ports to which data can be sent.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/RemoteProcessGroupPortDTO" - } - }, - "outputPorts" : { - "type" : "array", - "description" : "The output ports from which data can be retrieved.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/RemoteProcessGroupPortDTO" - } - } - } - }, - "RemoteProcessGroupDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "versionedComponentId" : { - "type" : "string", - "description" : "The ID of the corresponding component that is under version control" - }, - "parentGroupId" : { - "type" : "string", - "description" : "The id of parent process group of this component if applicable." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "targetUri" : { - "type" : "string", - "description" : "The target URI of the remote process group. If target uri is not set, but uris are set, then returns the first url in the urls. If neither target uri nor uris are set, then returns null." - }, - "targetUris" : { - "type" : "string", - "description" : "The target URI of the remote process group. If target uris is not set but target uri is set, then returns a collection containing the single target uri. If neither target uris nor uris are set, then returns null." - }, - "targetSecure" : { - "type" : "boolean", - "description" : "Whether the target is running securely." - }, - "name" : { - "type" : "string", - "description" : "The name of the remote process group." - }, - "comments" : { - "type" : "string", - "description" : "The comments for the remote process group." - }, - "communicationsTimeout" : { - "type" : "string", - "description" : "The time period used for the timeout when communicating with the target." - }, - "yieldDuration" : { - "type" : "string", - "description" : "When yielding, this amount of time must elapse before the remote process group is scheduled again." - }, - "transportProtocol" : { - "type" : "string" - }, - "localNetworkInterface" : { - "type" : "string", - "description" : "The local network interface to send/receive data. If not specified, any local address is used. If clustered, all nodes must have an interface with this identifier." - }, - "proxyHost" : { - "type" : "string" - }, - "proxyPort" : { - "type" : "integer", - "format" : "int32" - }, - "proxyUser" : { - "type" : "string" - }, - "proxyPassword" : { - "type" : "string" - }, - "authorizationIssues" : { - "type" : "array", - "description" : "Any remote authorization issues for the remote process group.", - "items" : { - "type" : "string" - } - }, - "validationErrors" : { - "type" : "array", - "description" : "The validation errors for the remote process group. These validation errors represent the problems with the remote process group that must be resolved before it can transmit.", - "items" : { - "type" : "string" - } - }, - "transmitting" : { - "type" : "boolean", - "description" : "Whether the remote process group is actively transmitting." - }, - "inputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of remote input ports currently available on the target." - }, - "outputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of remote output ports currently available on the target." - }, - "activeRemoteInputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of active remote input ports." - }, - "inactiveRemoteInputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of inactive remote input ports." - }, - "activeRemoteOutputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of active remote output ports." - }, - "inactiveRemoteOutputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of inactive remote output ports." - }, - "flowRefreshed" : { - "type" : "string", - "description" : "The timestamp when this remote process group was last refreshed." - }, - "contents" : { - "description" : "The contents of the remote process group. Will contain available input/output ports.", - "$ref" : "#/definitions/RemoteProcessGroupContentsDTO" - } - } - }, - "RemoteProcessGroupEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "component" : { - "$ref" : "#/definitions/RemoteProcessGroupDTO" - }, - "status" : { - "description" : "The status of the remote process group.", - "$ref" : "#/definitions/RemoteProcessGroupStatusDTO" - }, - "inputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of remote input ports currently available on the target." - }, - "outputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of remote output ports currently available on the target." - }, - "operatePermissions" : { - "description" : "The permissions for this component operations.", - "$ref" : "#/definitions/PermissionsDTO" - } - }, - "xml" : { - "name" : "remoteProcessGroupEntity" - } - }, - "RemoteProcessGroupPortDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the port." - }, - "targetId" : { - "type" : "string", - "description" : "The id of the target port." - }, - "versionedComponentId" : { - "type" : "string", - "description" : "The ID of the corresponding component that is under version control" - }, - "groupId" : { - "type" : "string", - "description" : "The id of the remote process group that the port resides in." - }, - "name" : { - "type" : "string", - "description" : "The name of the target port." - }, - "comments" : { - "type" : "string", - "description" : "The comments as configured on the target port." - }, - "concurrentlySchedulableTaskCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of task that may transmit flowfiles to the target port concurrently." - }, - "transmitting" : { - "type" : "boolean", - "description" : "Whether the remote port is configured for transmission." - }, - "useCompression" : { - "type" : "boolean", - "description" : "Whether the flowfiles are compressed when sent to the target port." - }, - "exists" : { - "type" : "boolean", - "description" : "Whether the target port exists." - }, - "targetRunning" : { - "type" : "boolean", - "description" : "Whether the target port is running." - }, - "connected" : { - "type" : "boolean", - "description" : "Whether the port has either an incoming or outgoing connection." - }, - "batchSettings" : { - "description" : "The batch settings for data transmission.", - "$ref" : "#/definitions/BatchSettingsDTO" - } - } - }, - "RemoteProcessGroupPortEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "remoteProcessGroupPort" : { - "$ref" : "#/definitions/RemoteProcessGroupPortDTO" - }, - "operatePermissions" : { - "description" : "The permissions for this component operations.", - "$ref" : "#/definitions/PermissionsDTO" - } - }, - "xml" : { - "name" : "remoteProcessGroupPortEntity" - } - }, - "RemoteProcessGroupStatusDTO" : { - "type" : "object", - "properties" : { - "groupId" : { - "type" : "string", - "description" : "The unique ID of the process group that the Processor belongs to" - }, - "id" : { - "type" : "string", - "description" : "The unique ID of the Processor" - }, - "name" : { - "type" : "string", - "description" : "The name of the remote process group." - }, - "targetUri" : { - "type" : "string", - "description" : "The URI of the target system." - }, - "transmissionStatus" : { - "type" : "string", - "description" : "The transmission status of the remote process group." - }, - "statsLastRefreshed" : { - "type" : "string", - "description" : "The time the status for the process group was last refreshed." - }, - "validationStatus" : { - "type" : "string", - "description" : "Indicates whether the component is valid, invalid, or still in the process of validating (i.e., it is unknown whether or not the component is valid)", - "readOnly" : true, - "enum" : [ "VALID", "INVALID", "VALIDATING" ] - }, - "aggregateSnapshot" : { - "description" : "A status snapshot that represents the aggregate stats of all nodes in the cluster. If the NiFi instance is a standalone instance, rather than a cluster, this represents the stats of the single instance.", - "$ref" : "#/definitions/RemoteProcessGroupStatusSnapshotDTO" - }, - "nodeSnapshots" : { - "type" : "array", - "description" : "A status snapshot for each node in the cluster. If the NiFi instance is a standalone instance, rather than a cluster, this may be null.", - "items" : { - "$ref" : "#/definitions/NodeRemoteProcessGroupStatusSnapshotDTO" - } - } - } - }, - "RemoteProcessGroupStatusEntity" : { - "type" : "object", - "properties" : { - "remoteProcessGroupStatus" : { - "$ref" : "#/definitions/RemoteProcessGroupStatusDTO" - }, - "canRead" : { - "type" : "boolean", - "description" : "Indicates whether the user can read a given resource.", - "readOnly" : true - } - }, - "xml" : { - "name" : "remoteProcessGroupStatusEntity" - } - }, - "RemoteProcessGroupStatusSnapshotDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the remote process group." - }, - "groupId" : { - "type" : "string", - "description" : "The id of the parent process group the remote process group resides in." - }, - "name" : { - "type" : "string", - "description" : "The name of the remote process group." - }, - "targetUri" : { - "type" : "string", - "description" : "The URI of the target system." - }, - "transmissionStatus" : { - "type" : "string", - "description" : "The transmission status of the remote process group." - }, - "activeThreadCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of active threads for the remote process group." - }, - "flowFilesSent" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of FlowFiles sent to the remote process group in the last 5 minutes." - }, - "bytesSent" : { - "type" : "integer", - "format" : "int64", - "description" : "The size of the FlowFiles sent to the remote process group in the last 5 minutes." - }, - "sent" : { - "type" : "string", - "description" : "The count/size of the flowfiles sent to the remote process group in the last 5 minutes." - }, - "flowFilesReceived" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of FlowFiles received from the remote process group in the last 5 minutes." - }, - "bytesReceived" : { - "type" : "integer", - "format" : "int64", - "description" : "The size of the FlowFiles received from the remote process group in the last 5 minutes." - }, - "received" : { - "type" : "string", - "description" : "The count/size of the flowfiles received from the remote process group in the last 5 minutes." - } - } - }, - "RemoteProcessGroupStatusSnapshotEntity" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the remote process group." - }, - "remoteProcessGroupStatusSnapshot" : { - "$ref" : "#/definitions/RemoteProcessGroupStatusSnapshotDTO" - }, - "canRead" : { - "type" : "boolean", - "description" : "Indicates whether the user can read a given resource.", - "readOnly" : true - } - }, - "xml" : { - "name" : "entity" - } - }, - "RemoteProcessGroupsEntity" : { - "type" : "object", - "properties" : { - "remoteProcessGroups" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/RemoteProcessGroupEntity" - } - } - }, - "xml" : { - "name" : "remoteProcessGroupsEntity" - } - }, - "RemoteQueuePartitionDTO" : { - "type" : "object", - "properties" : { - "totalFlowFileCount" : { - "type" : "integer", - "format" : "int32", - "description" : "Total number of FlowFiles owned by the Connection" - }, - "totalByteCount" : { - "type" : "integer", - "format" : "int64", - "description" : "Total number of bytes that make up the content for the FlowFiles owned by this Connection" - }, - "activeQueueFlowFileCount" : { - "type" : "integer", - "format" : "int32", - "description" : "Total number of FlowFiles that exist in the Connection's Active Queue, immediately available to be offered up to a component" - }, - "activeQueueByteCount" : { - "type" : "integer", - "format" : "int64", - "description" : "Total number of bytes that make up the content for the FlowFiles that are present in the Connection's Active Queue" - }, - "swapFlowFileCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The total number of FlowFiles that are swapped out for this Connection" - }, - "swapByteCount" : { - "type" : "integer", - "format" : "int64", - "description" : "Total number of bytes that make up the content for the FlowFiles that are swapped out to disk for the Connection" - }, - "swapFiles" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of Swap Files that exist for this Connection" - }, - "inFlightFlowFileCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of In-Flight FlowFiles for this Connection. These are FlowFiles that belong to the connection but are currently being operated on by a Processor, Port, etc." - }, - "inFlightByteCount" : { - "type" : "integer", - "format" : "int64", - "description" : "The number bytes that make up the content of the FlowFiles that are In-Flight" - }, - "nodeIdentifier" : { - "type" : "string", - "description" : "The Node Identifier that this queue partition is sending to" - } - } - }, - "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" : { - "componentId" : { - "type" : "string", - "description" : "The UUID of the component whose last event should be replayed." - }, - "nodes" : { - "type" : "string", - "description" : "Which nodes were requested to replay their last provenance event.", - "enum" : [ "ALL", "PRIMARY" ] - }, - "aggregateSnapshot" : { - "description" : "The aggregate result of all nodes' responses", - "$ref" : "#/definitions/ReplayLastEventSnapshotDTO" - }, - "nodeSnapshots" : { - "type" : "array", - "description" : "The node-wise results", - "items" : { - "$ref" : "#/definitions/NodeReplayLastEventSnapshotDTO" - } - } - }, - "xml" : { - "name" : "replayLastEventResponseEntity" - } - }, - "ReplayLastEventSnapshotDTO" : { - "type" : "object", - "properties" : { - "eventsReplayed" : { - "type" : "array", - "description" : "The IDs of the events that were successfully replayed", - "items" : { - "type" : "integer", - "format" : "int64" - } - }, - "failureExplanation" : { - "type" : "string", - "description" : "If unable to replay an event, specifies why the event could not be replayed" - }, - "eventAvailable" : { - "type" : "boolean", - "description" : "Whether or not an event was available. This may not be populated if there was a failure." - } - }, - "xml" : { - "name" : "replayLastEventSnapshot" - } - }, - "ReportingTaskDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "versionedComponentId" : { - "type" : "string", - "description" : "The ID of the corresponding component that is under version control" - }, - "parentGroupId" : { - "type" : "string", - "description" : "The id of parent process group of this component if applicable." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "name" : { - "type" : "string", - "description" : "The name of the reporting task." - }, - "type" : { - "type" : "string", - "description" : "The fully qualified type of the reporting task." - }, - "bundle" : { - "description" : "The details of the artifact that bundled this reporting task type.", - "$ref" : "#/definitions/BundleDTO" - }, - "state" : { - "type" : "string", - "description" : "The state of the reporting task.", - "enum" : [ "RUNNING", "STOPPED", "DISABLED" ] - }, - "comments" : { - "type" : "string", - "description" : "The comments of the reporting task." - }, - "persistsState" : { - "type" : "boolean", - "description" : "Whether the reporting task persists state." - }, - "restricted" : { - "type" : "boolean", - "description" : "Whether the reporting task requires elevated privileges." - }, - "deprecated" : { - "type" : "boolean", - "description" : "Whether the reporting task has been deprecated." - }, - "multipleVersionsAvailable" : { - "type" : "boolean", - "description" : "Whether the reporting task has multiple versions available." - }, - "supportsSensitiveDynamicProperties" : { - "type" : "boolean", - "description" : "Whether the reporting task supports sensitive dynamic properties." - }, - "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." - }, - "defaultSchedulingPeriod" : { - "type" : "object", - "description" : "The default scheduling period for the different scheduling strategies.", - "additionalProperties" : { - "type" : "string" - } - }, - "properties" : { - "type" : "object", - "description" : "The properties of the reporting task.", - "additionalProperties" : { - "type" : "string" - } - }, - "descriptors" : { - "type" : "object", - "description" : "The descriptors for the reporting tasks properties.", - "additionalProperties" : { - "$ref" : "#/definitions/PropertyDescriptorDTO" - } - }, - "sensitiveDynamicPropertyNames" : { - "type" : "array", - "description" : "Set of sensitive dynamic property names", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - }, - "customUiUrl" : { - "type" : "string", - "description" : "The URL for the custom configuration UI for the reporting task." - }, - "annotationData" : { - "type" : "string", - "description" : "The annotation data for the repoting task. This is how the custom UI relays configuration to the reporting task." - }, - "validationErrors" : { - "type" : "array", - "description" : "Gets the validation errors from the reporting task. These validation errors represent the problems with the reporting task that must be resolved before it can be scheduled to run.", - "items" : { - "type" : "string" - } - }, - "validationStatus" : { - "type" : "string", - "description" : "Indicates whether the 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)", - "readOnly" : true, - "enum" : [ "VALID", "INVALID", "VALIDATING" ] - }, - "activeThreadCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of active threads for the reporting task." - }, - "extensionMissing" : { - "type" : "boolean", - "description" : "Whether the underlying extension is missing." - } - } - }, - "ReportingTaskDefinition" : { - "type" : "object", - "required" : [ "type" ], - "properties" : { - "group" : { - "type" : "string", - "description" : "The group name of the bundle that provides the referenced type." - }, - "artifact" : { - "type" : "string", - "description" : "The artifact name of the bundle that provides the referenced type." - }, - "version" : { - "type" : "string", - "description" : "The version 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." - }, - "buildInfo" : { - "description" : "The build metadata for this component", - "$ref" : "#/definitions/BuildInfo" - }, - "providedApiImplementations" : { - "type" : "array", - "description" : "If this type represents a provider for an interface, this lists the APIs it implements", - "items" : { - "$ref" : "#/definitions/DefinedType" - } - }, - "tags" : { - "type" : "array", - "description" : "The tags associated with this type", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - }, - "seeAlso" : { - "type" : "array", - "description" : "The names of other component types that may be related", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - }, - "deprecated" : { - "type" : "boolean", - "description" : "Whether or not the component has been deprecated" - }, - "deprecationReason" : { - "type" : "string", - "description" : "If this component has been deprecated, this optional field can be used to provide an explanation" - }, - "deprecationAlternatives" : { - "type" : "array", - "description" : "If this component has been deprecated, this optional field provides alternatives to use", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - }, - "restricted" : { - "type" : "boolean", - "description" : "Whether or not the component has a general restriction" - }, - "restrictedExplanation" : { - "type" : "string", - "description" : "An optional description of the general restriction" - }, - "explicitRestrictions" : { - "type" : "array", - "description" : "Explicit restrictions that indicate a require permission to use the component", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/Restriction" - } - }, - "stateful" : { - "description" : "Indicates if the component stores state", - "$ref" : "#/definitions/Stateful" - }, - "systemResourceConsiderations" : { - "type" : "array", - "description" : "The system resource considerations for the given component", - "items" : { - "$ref" : "#/definitions/SystemResourceConsideration" - } - }, - "additionalDetails" : { - "type" : "boolean", - "description" : "Indicates if the component has additional details documentation" - }, - "propertyDescriptors" : { - "type" : "object", - "description" : "Descriptions of configuration properties applicable to this component.", - "additionalProperties" : { - "$ref" : "#/definitions/PropertyDescriptor" - } - }, - "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." - }, - "dynamicProperties" : { - "type" : "array", - "description" : "Describes the dynamic properties supported by this component", - "items" : { - "$ref" : "#/definitions/DynamicProperty" - } - }, - "supportedSchedulingStrategies" : { - "type" : "array", - "description" : "The supported scheduling strategies, such as TIME_DRIVER or CRON.", - "items" : { - "type" : "string" - } - }, - "defaultSchedulingStrategy" : { - "type" : "string", - "description" : "The default scheduling strategy for the reporting task." - }, - "defaultSchedulingPeriodBySchedulingStrategy" : { - "type" : "object", - "description" : "The default scheduling period for each scheduling strategy. The scheduling period is expected to be a time period, such as \"30 sec\".", - "additionalProperties" : { - "type" : "string" - } - } - } - }, - "ReportingTaskEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "component" : { - "$ref" : "#/definitions/ReportingTaskDTO" - }, - "operatePermissions" : { - "description" : "The permissions for this component operations.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "status" : { - "description" : "The status for this ReportingTask.", - "readOnly" : true, - "$ref" : "#/definitions/ReportingTaskStatusDTO" - } - }, - "xml" : { - "name" : "reportingTaskEntity" - } - }, - "ReportingTaskRunStatusEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "state" : { - "type" : "string", - "description" : "The run status of the ReportingTask.", - "enum" : [ "RUNNING", "STOPPED" ] - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - } - }, - "xml" : { - "name" : "entity" - } - }, - "ReportingTaskStatusDTO" : { - "type" : "object", - "properties" : { - "runStatus" : { - "type" : "string", - "description" : "The run status of this ReportingTask", - "readOnly" : true, - "enum" : [ "RUNNING", "STOPPED", "DISABLED" ] - }, - "validationStatus" : { - "type" : "string", - "description" : "Indicates whether the component is valid, invalid, or still in the process of validating (i.e., it is unknown whether or not the component is valid)", - "readOnly" : true, - "enum" : [ "VALID", "INVALID", "VALIDATING" ] - }, - "activeThreadCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of active threads for the component." - } - } - }, - "ReportingTaskTypesEntity" : { - "type" : "object", - "properties" : { - "reportingTaskTypes" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/DocumentedTypeDTO" - } - } - }, - "xml" : { - "name" : "reportingTaskTypesEntity" - } - }, - "ReportingTasksEntity" : { - "type" : "object", - "properties" : { - "reportingTasks" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ReportingTaskEntity" - } - } - }, - "xml" : { - "name" : "reportingTasksEntity" - } - }, - "RepositoryUsageDTO" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The name of the repository" - }, - "fileStoreHash" : { - "type" : "string", - "description" : "A SHA-256 hash of the File Store name/path that is used to store the repository's data. This information is exposed as a hash in order to avoid exposing potentially sensitive information that is not generally relevant. What is typically relevant is whether or not multiple repositories on the same node are using the same File Store, as this indicates that the repositories are competing for the resources of the backing disk/storage mechanism." - }, - "freeSpace" : { - "type" : "string", - "description" : "Amount of free space." - }, - "totalSpace" : { - "type" : "string", - "description" : "Amount of total space." - }, - "freeSpaceBytes" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes of free space." - }, - "totalSpaceBytes" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes of total space." - }, - "utilization" : { - "type" : "string", - "description" : "Utilization of this storage location." - } - } - }, - "RequiredPermissionDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The required sub-permission necessary for this restriction." - }, - "label" : { - "type" : "string", - "description" : "The label for the required sub-permission necessary for this restriction." - } - } - }, - "ResourceDTO" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The identifier of the resource." - }, - "name" : { - "type" : "string", - "description" : "The name of the resource." - } - } - }, - "ResourcesEntity" : { - "type" : "object", - "properties" : { - "resources" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/ResourceDTO" - } - } - }, - "xml" : { - "name" : "resourcesEntity" - } - }, - "Response" : { - "type" : "object", - "properties" : { - "metadata" : { - "type" : "object", - "additionalProperties" : { - "type" : "array", - "items" : { - "type" : "object" - } - } - }, - "status" : { - "type" : "integer", - "format" : "int32" - }, - "entity" : { - "type" : "object" - } - } - }, - "Restriction" : { - "type" : "object", - "properties" : { - "requiredPermission" : { - "type" : "string", - "description" : "The permission required for this restriction" - }, - "explanation" : { - "type" : "string", - "description" : "The explanation of this restriction" - } - } - }, - "RevisionDTO" : { - "type" : "object", - "properties" : { - "clientId" : { - "type" : "string", - "description" : "A client identifier used to make a request. By including a client identifier, the API can allow multiple requests without needing the current revision. Due to the asynchronous nature of requests/responses this was implemented to allow the client to make numerous requests without having to wait for the previous response to come back" - }, - "version" : { - "type" : "integer", - "format" : "int64", - "description" : "NiFi employs an optimistic locking strategy where the client must include a revision in their request when performing an update. In a response to a mutable flow request, this field represents the updated base version." - }, - "lastModifier" : { - "type" : "string", - "description" : "The user that last modified the flow.", - "readOnly" : true - } - } - }, - "RunStatusDetailsRequestEntity" : { - "type" : "object", - "properties" : { - "processorIds" : { - "type" : "array", - "description" : "The IDs of all processors whose run status details should be provided", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - } - }, - "xml" : { - "name" : "runStatusDetailsRequest" - } - }, - "RuntimeManifest" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "A unique identifier for the manifest" - }, - "agentType" : { - "type" : "string", - "description" : "The type of the runtime binary, e.g., 'minifi-java' or 'minifi-cpp'" - }, - "version" : { - "type" : "string", - "description" : "The version of the runtime binary, e.g., '1.0.1'" - }, - "buildInfo" : { - "description" : "Build summary for this runtime binary", - "$ref" : "#/definitions/BuildInfo" - }, - "bundles" : { - "type" : "array", - "description" : "All extension bundles included with this runtime", - "items" : { - "$ref" : "#/definitions/Bundle" - } - }, - "schedulingDefaults" : { - "description" : "Scheduling defaults for components defined in this manifest", - "$ref" : "#/definitions/SchedulingDefaults" - } - } - }, - "RuntimeManifestEntity" : { - "type" : "object", - "properties" : { - "runtimeManifest" : { - "$ref" : "#/definitions/RuntimeManifest" - } - }, - "xml" : { - "name" : "runtimeManifestEntity" - } - }, - "ScheduleComponentsEntity" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the ProcessGroup" - }, - "state" : { - "type" : "string", - "description" : "The desired state of the descendant components", - "enum" : [ "RUNNING", "STOPPED", "ENABLED", "DISABLED" ] - }, - "components" : { - "type" : "object", - "description" : "Optional components to schedule. If not specified, all authorized descendant components will be used.", - "additionalProperties" : { - "$ref" : "#/definitions/RevisionDTO" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - } - }, - "xml" : { - "name" : "scheduleComponentEntity" - } - }, - "SchedulingDefaults" : { - "type" : "object", - "properties" : { - "defaultSchedulingStrategy" : { - "type" : "string", - "description" : "The name of the default scheduling strategy", - "enum" : [ "EVENT_DRIVEN", "TIMER_DRIVEN", "PRIMARY_NODE_ONLY", "CRON_DRIVEN" ] - }, - "defaultSchedulingPeriodMillis" : { - "type" : "integer", - "format" : "int64", - "description" : "The default scheduling period in milliseconds" - }, - "penalizationPeriodMillis" : { - "type" : "integer", - "format" : "int64", - "description" : "The default penalization period in milliseconds" - }, - "yieldDurationMillis" : { - "type" : "integer", - "format" : "int64", - "description" : "The default yield duration in milliseconds" - }, - "defaultRunDurationNanos" : { - "type" : "integer", - "format" : "int64", - "description" : "The default run duration in nano-seconds" - }, - "defaultMaxConcurrentTasks" : { - "type" : "string", - "description" : "The default concurrent tasks" - }, - "defaultConcurrentTasksBySchedulingStrategy" : { - "type" : "object", - "description" : "The default concurrent tasks for each scheduling strategy", - "additionalProperties" : { - "type" : "integer", - "format" : "int32" - } - }, - "defaultSchedulingPeriodsBySchedulingStrategy" : { - "type" : "object", - "description" : "The default scheduling period for each scheduling strategy", - "additionalProperties" : { - "type" : "string" - } - } - } - }, - "SearchResultGroupDTO" : { - "type" : "object", - "required" : [ "id" ], - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the group." - }, - "name" : { - "type" : "string", - "description" : "The name of the group." - } - } - }, - "SearchResultsDTO" : { - "type" : "object", - "properties" : { - "processorResults" : { - "type" : "array", - "description" : "The processors that matched the search.", - "items" : { - "$ref" : "#/definitions/ComponentSearchResultDTO" - } - }, - "connectionResults" : { - "type" : "array", - "description" : "The connections that matched the search.", - "items" : { - "$ref" : "#/definitions/ComponentSearchResultDTO" - } - }, - "processGroupResults" : { - "type" : "array", - "description" : "The process groups that matched the search.", - "items" : { - "$ref" : "#/definitions/ComponentSearchResultDTO" - } - }, - "inputPortResults" : { - "type" : "array", - "description" : "The input ports that matched the search.", - "items" : { - "$ref" : "#/definitions/ComponentSearchResultDTO" - } - }, - "outputPortResults" : { - "type" : "array", - "description" : "The output ports that matched the search.", - "items" : { - "$ref" : "#/definitions/ComponentSearchResultDTO" - } - }, - "remoteProcessGroupResults" : { - "type" : "array", - "description" : "The remote process groups that matched the search.", - "items" : { - "$ref" : "#/definitions/ComponentSearchResultDTO" - } - }, - "funnelResults" : { - "type" : "array", - "description" : "The funnels that matched the search.", - "items" : { - "$ref" : "#/definitions/ComponentSearchResultDTO" - } - }, - "labelResults" : { - "type" : "array", - "description" : "The labels that matched the search.", - "items" : { - "$ref" : "#/definitions/ComponentSearchResultDTO" - } - }, - "controllerServiceNodeResults" : { - "type" : "array", - "description" : "The controller service nodes that matched the search", - "items" : { - "$ref" : "#/definitions/ComponentSearchResultDTO" - } - }, - "parameterContextResults" : { - "type" : "array", - "description" : "The parameter contexts that matched the search.", - "items" : { - "$ref" : "#/definitions/ComponentSearchResultDTO" - } - }, - "parameterProviderNodeResults" : { - "type" : "array", - "description" : "The parameter provider nodes that matched the search", - "items" : { - "$ref" : "#/definitions/ComponentSearchResultDTO" - } - }, - "parameterResults" : { - "type" : "array", - "description" : "The parameters that matched the search.", - "items" : { - "$ref" : "#/definitions/ComponentSearchResultDTO" - } - } - } - }, - "SearchResultsEntity" : { - "type" : "object", - "properties" : { - "searchResultsDTO" : { - "$ref" : "#/definitions/SearchResultsDTO" - } - }, - "xml" : { - "name" : "searchResultsEntity" - } - }, - "SnippetDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the snippet." - }, - "uri" : { - "type" : "string", - "description" : "The URI of the snippet." - }, - "parentGroupId" : { - "type" : "string", - "description" : "The group id for the components in the snippet." - }, - "processGroups" : { - "type" : "object", - "description" : "The ids of the process groups in this snippet. These ids will be populated within each response. They can be specified when creating a snippet. However, once a snippet has been created its contents cannot be modified (these ids are ignored during update requests).", - "additionalProperties" : { - "$ref" : "#/definitions/RevisionDTO" - } - }, - "remoteProcessGroups" : { - "type" : "object", - "description" : "The ids of the remote process groups in this snippet. These ids will be populated within each response. They can be specified when creating a snippet. However, once a snippet has been created its contents cannot be modified (these ids are ignored during update requests).", - "additionalProperties" : { - "$ref" : "#/definitions/RevisionDTO" - } - }, - "processors" : { - "type" : "object", - "description" : "The ids of the processors in this snippet. These ids will be populated within each response. They can be specified when creating a snippet. However, once a snippet has been created its contents cannot be modified (these ids are ignored during update requests).", - "additionalProperties" : { - "$ref" : "#/definitions/RevisionDTO" - } - }, - "inputPorts" : { - "type" : "object", - "description" : "The ids of the input ports in this snippet. These ids will be populated within each response. They can be specified when creating a snippet. However, once a snippet has been created its contents cannot be modified (these ids are ignored during update requests).", - "additionalProperties" : { - "$ref" : "#/definitions/RevisionDTO" - } - }, - "outputPorts" : { - "type" : "object", - "description" : "The ids of the output ports in this snippet. These ids will be populated within each response. They can be specified when creating a snippet. However, once a snippet has been created its contents cannot be modified (these ids are ignored during update requests).", - "additionalProperties" : { - "$ref" : "#/definitions/RevisionDTO" - } - }, - "connections" : { - "type" : "object", - "description" : "The ids of the connections in this snippet. These ids will be populated within each response. They can be specified when creating a snippet. However, once a snippet has been created its contents cannot be modified (these ids are ignored during update requests).", - "additionalProperties" : { - "$ref" : "#/definitions/RevisionDTO" - } - }, - "labels" : { - "type" : "object", - "description" : "The ids of the labels in this snippet. These ids will be populated within each response. They can be specified when creating a snippet. However, once a snippet has been created its contents cannot be modified (these ids are ignored during update requests).", - "additionalProperties" : { - "$ref" : "#/definitions/RevisionDTO" - } - }, - "funnels" : { - "type" : "object", - "description" : "The ids of the funnels in this snippet. These ids will be populated within each response. They can be specified when creating a snippet. However, once a snippet has been created its contents cannot be modified (these ids are ignored during update requests).", - "additionalProperties" : { - "$ref" : "#/definitions/RevisionDTO" - } - } - } - }, - "SnippetEntity" : { - "type" : "object", - "properties" : { - "snippet" : { - "description" : "The snippet.", - "$ref" : "#/definitions/SnippetDTO" - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - } - }, - "xml" : { - "name" : "snippetEntity" - } - }, - "StackTraceElement" : { - "type" : "object", - "properties" : { - "classLoaderName" : { - "type" : "string" - }, - "moduleName" : { - "type" : "string" - }, - "moduleVersion" : { - "type" : "string" - }, - "methodName" : { - "type" : "string" - }, - "fileName" : { - "type" : "string" - }, - "lineNumber" : { - "type" : "integer", - "format" : "int32" - }, - "nativeMethod" : { - "type" : "boolean" - }, - "className" : { - "type" : "string" - } - } - }, - "StartVersionControlRequestEntity" : { - "type" : "object", - "properties" : { - "versionedFlow" : { - "description" : "The versioned flow", - "$ref" : "#/definitions/VersionedFlowDTO" - }, - "processGroupRevision" : { - "description" : "The Revision of the Process Group under Version Control", - "$ref" : "#/definitions/RevisionDTO" - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - } - }, - "xml" : { - "name" : "startVersionControlRequestEntity" - } - }, - "StateEntryDTO" : { - "type" : "object", - "properties" : { - "key" : { - "type" : "string", - "description" : "The key for this state." - }, - "value" : { - "type" : "string", - "description" : "The value for this state." - }, - "clusterNodeId" : { - "type" : "string", - "description" : "The identifier for the node where the state originated." - }, - "clusterNodeAddress" : { - "type" : "string", - "description" : "The label for the node where the state originated." - } - } - }, - "StateMapDTO" : { - "type" : "object", - "properties" : { - "scope" : { - "type" : "string", - "description" : "The scope of this StateMap." - }, - "totalEntryCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The total number of state entries. When the state map is lengthy, only of portion of the entries are returned." - }, - "state" : { - "type" : "array", - "description" : "The state.", - "items" : { - "$ref" : "#/definitions/StateEntryDTO" - } - } - } - }, - "Stateful" : { - "type" : "object", - "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", - "uniqueItems" : true, - "items" : { - "type" : "string", - "enum" : [ "CLUSTER", "LOCAL" ] - } - } - } - }, - "StatusDescriptorDTO" : { - "type" : "object", - "properties" : { - "field" : { - "type" : "string", - "description" : "The name of the status field." - }, - "label" : { - "type" : "string", - "description" : "The label for the status field." - }, - "description" : { - "type" : "string", - "description" : "The description of the status field." - }, - "formatter" : { - "type" : "string", - "description" : "The formatter for the status descriptor." - } - } - }, - "StatusHistoryDTO" : { - "type" : "object", - "properties" : { - "generated" : { - "type" : "string", - "description" : "When the status history was generated." - }, - "componentDetails" : { - "type" : "object", - "description" : "A Map of key/value pairs that describe the component that the status history belongs to", - "additionalProperties" : { - "type" : "string" - } - }, - "fieldDescriptors" : { - "type" : "array", - "description" : "The Descriptors that provide information on each of the metrics provided in the status history", - "items" : { - "$ref" : "#/definitions/StatusDescriptorDTO" - } - }, - "aggregateSnapshots" : { - "type" : "array", - "description" : "A list of StatusSnapshotDTO objects that provide the actual metric values for the component. If the NiFi instance is clustered, this will represent the aggregate status across all nodes. If the NiFi instance is not clustered, this will represent the status of the entire NiFi instance.", - "items" : { - "$ref" : "#/definitions/StatusSnapshotDTO" - } - }, - "nodeSnapshots" : { - "type" : "array", - "description" : "The NodeStatusSnapshotsDTO objects that provide the actual metric values for the component, for each node. If the NiFi instance is not clustered, this value will be null.", - "items" : { - "$ref" : "#/definitions/NodeStatusSnapshotsDTO" - } - } - } - }, - "StatusHistoryEntity" : { - "type" : "object", - "properties" : { - "statusHistory" : { - "$ref" : "#/definitions/StatusHistoryDTO" - }, - "canRead" : { - "type" : "boolean", - "description" : "Indicates whether the user can read a given resource.", - "readOnly" : true - } - }, - "xml" : { - "name" : "statusHistoryEntity" - } - }, - "StatusSnapshotDTO" : { - "type" : "object", - "properties" : { - "timestamp" : { - "type" : "string", - "format" : "date-time", - "description" : "The timestamp of the snapshot." - }, - "statusMetrics" : { - "type" : "object", - "description" : "The status metrics.", - "additionalProperties" : { - "type" : "integer", - "format" : "int64" - } - } - } - }, - "StorageUsageDTO" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The identifier of this storage location. The identifier will correspond to the identifier keyed in the storage configuration." - }, - "freeSpace" : { - "type" : "string", - "description" : "Amount of free space." - }, - "totalSpace" : { - "type" : "string", - "description" : "Amount of total space." - }, - "usedSpace" : { - "type" : "string", - "description" : "Amount of used space." - }, - "freeSpaceBytes" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes of free space." - }, - "totalSpaceBytes" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes of total space." - }, - "usedSpaceBytes" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes of used space." - }, - "utilization" : { - "type" : "string", - "description" : "Utilization of this storage location." - } - } - }, - "StreamingOutput" : { - "type" : "object" - }, - "SubmitReplayRequestEntity" : { - "type" : "object", - "properties" : { - "eventId" : { - "type" : "integer", - "format" : "int64", - "description" : "The event identifier" - }, - "clusterNodeId" : { - "type" : "string", - "description" : "The identifier of the node where to submit the replay request." - } - }, - "xml" : { - "name" : "copySnippetRequestEntity" - } - }, - "SystemDiagnosticsDTO" : { - "type" : "object", - "properties" : { - "aggregateSnapshot" : { - "description" : "A systems diagnostic snapshot that represents the aggregate values of all nodes in the cluster. If the NiFi instance is a standalone instance, rather than a cluster, this represents the stats of the single instance.", - "$ref" : "#/definitions/SystemDiagnosticsSnapshotDTO" - }, - "nodeSnapshots" : { - "type" : "array", - "description" : "A systems diagnostics snapshot for each node in the cluster. If the NiFi instance is a standalone instance, rather than a cluster, this may be null.", - "items" : { - "$ref" : "#/definitions/NodeSystemDiagnosticsSnapshotDTO" - } - } - } - }, - "SystemDiagnosticsEntity" : { - "type" : "object", - "properties" : { - "systemDiagnostics" : { - "$ref" : "#/definitions/SystemDiagnosticsDTO" - } - }, - "xml" : { - "name" : "systemDiagnosticsEntity" - } - }, - "SystemDiagnosticsSnapshotDTO" : { - "type" : "object", - "properties" : { - "totalNonHeap" : { - "type" : "string", - "description" : "Total size of non heap." - }, - "totalNonHeapBytes" : { - "type" : "integer", - "format" : "int64", - "description" : "Total number of bytes allocated to the JVM not used for heap" - }, - "usedNonHeap" : { - "type" : "string", - "description" : "Amount of use non heap." - }, - "usedNonHeapBytes" : { - "type" : "integer", - "format" : "int64", - "description" : "Total number of bytes used by the JVM not in the heap space" - }, - "freeNonHeap" : { - "type" : "string", - "description" : "Amount of free non heap." - }, - "freeNonHeapBytes" : { - "type" : "integer", - "format" : "int64", - "description" : "Total number of free non-heap bytes available to the JVM" - }, - "maxNonHeap" : { - "type" : "string", - "description" : "Maximum size of non heap." - }, - "maxNonHeapBytes" : { - "type" : "integer", - "format" : "int64", - "description" : "The maximum number of bytes that the JVM can use for non-heap purposes" - }, - "nonHeapUtilization" : { - "type" : "string", - "description" : "Utilization of non heap." - }, - "totalHeap" : { - "type" : "string", - "description" : "Total size of heap." - }, - "totalHeapBytes" : { - "type" : "integer", - "format" : "int64", - "description" : "The total number of bytes that are available for the JVM heap to use" - }, - "usedHeap" : { - "type" : "string", - "description" : "Amount of used heap." - }, - "usedHeapBytes" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes of JVM heap that are currently being used" - }, - "freeHeap" : { - "type" : "string", - "description" : "Amount of free heap." - }, - "freeHeapBytes" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes that are allocated to the JVM heap but not currently being used" - }, - "maxHeap" : { - "type" : "string", - "description" : "Maximum size of heap." - }, - "maxHeapBytes" : { - "type" : "integer", - "format" : "int64", - "description" : "The maximum number of bytes that can be used by the JVM" - }, - "heapUtilization" : { - "type" : "string", - "description" : "Utilization of heap." - }, - "availableProcessors" : { - "type" : "integer", - "format" : "int32", - "description" : "Number of available processors if supported by the underlying system." - }, - "processorLoadAverage" : { - "type" : "number", - "format" : "double", - "description" : "The processor load average if supported by the underlying system." - }, - "totalThreads" : { - "type" : "integer", - "format" : "int32", - "description" : "Total number of threads." - }, - "daemonThreads" : { - "type" : "integer", - "format" : "int32", - "description" : "Number of daemon threads." - }, - "uptime" : { - "type" : "string", - "description" : "The uptime of the Java virtual machine" - }, - "flowFileRepositoryStorageUsage" : { - "description" : "The flowfile repository storage usage.", - "$ref" : "#/definitions/StorageUsageDTO" - }, - "contentRepositoryStorageUsage" : { - "type" : "array", - "description" : "The content repository storage usage.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/StorageUsageDTO" - } - }, - "provenanceRepositoryStorageUsage" : { - "type" : "array", - "description" : "The provenance repository storage usage.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/StorageUsageDTO" - } - }, - "garbageCollection" : { - "type" : "array", - "description" : "The garbage collection details.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/GarbageCollectionDTO" - } - }, - "statsLastRefreshed" : { - "type" : "string", - "description" : "When the diagnostics were generated." - }, - "versionInfo" : { - "description" : "The nifi, os, java, and build version information", - "$ref" : "#/definitions/VersionInfoDTO" - } - } - }, - "SystemResourceConsideration" : { - "type" : "object", - "properties" : { - "resource" : { - "type" : "string", - "description" : "The resource to consider" - }, - "description" : { - "type" : "string", - "description" : "The description of how the resource is affected" - } - } - }, - "TemplateDTO" : { - "type" : "object", - "properties" : { - "uri" : { - "type" : "string", - "description" : "The URI for the template." - }, - "id" : { - "type" : "string", - "description" : "The id of the template." - }, - "groupId" : { - "type" : "string", - "description" : "The id of the Process Group that the template belongs to." - }, - "name" : { - "type" : "string", - "description" : "The name of the template." - }, - "description" : { - "type" : "string", - "description" : "The description of the template." - }, - "timestamp" : { - "type" : "string", - "description" : "The timestamp when this template was created." - }, - "encodingVersion" : { - "type" : "string", - "xml" : { - "name" : "encoding-version", - "attribute" : true - }, - "description" : "The encoding version of this template." - }, - "snippet" : { - "description" : "The contents of the template.", - "$ref" : "#/definitions/FlowSnippetDTO" - } - }, - "xml" : { - "name" : "template" - } - }, - "TemplateEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "template" : { - "$ref" : "#/definitions/TemplateDTO" - } - }, - "xml" : { - "name" : "templateEntity" - } - }, - "TemplatesEntity" : { - "type" : "object", - "properties" : { - "templates" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/TemplateEntity" - } - }, - "generated" : { - "type" : "string", - "description" : "When this content was generated." - } - }, - "xml" : { - "name" : "templatesEntity" - } - }, - "TenantDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "versionedComponentId" : { - "type" : "string", - "description" : "The ID of the corresponding component that is under version control" - }, - "parentGroupId" : { - "type" : "string", - "description" : "The id of parent process group of this component if applicable." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "identity" : { - "type" : "string", - "description" : "The identity of the tenant." - }, - "configurable" : { - "type" : "boolean", - "description" : "Whether this tenant is configurable." - } - } - }, - "TenantEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "component" : { - "$ref" : "#/definitions/TenantDTO" - } - }, - "xml" : { - "name" : "tenantEntity" - } - }, - "TenantsEntity" : { - "type" : "object", - "properties" : { - "users" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/TenantEntity" - } - }, - "userGroups" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/TenantEntity" - } - } - }, - "xml" : { - "name" : "tenantsEntity" - } - }, - "ThreadDumpDTO" : { - "type" : "object", - "properties" : { - "nodeId" : { - "type" : "string", - "description" : "The ID of the node in the cluster" - }, - "nodeAddress" : { - "type" : "string", - "description" : "The address of the node in the cluster" - }, - "apiPort" : { - "type" : "integer", - "format" : "int32", - "description" : "The port the node is listening for API requests." - }, - "stackTrace" : { - "type" : "string", - "description" : "The stack trace for the thread" - }, - "threadName" : { - "type" : "string", - "description" : "The name of the thread" - }, - "threadActiveMillis" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of milliseconds that the thread has been executing in the Processor" - }, - "taskTerminated" : { - "type" : "boolean", - "description" : "Indicates whether or not the user has requested that the task be terminated. If this is true, it may indicate that the thread is in a state where it will continue running indefinitely without returning." - } - } - }, - "Throwable" : { - "type" : "object", - "properties" : { - "cause" : { - "$ref" : "#/definitions/Throwable" - }, - "stackTrace" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/StackTraceElement" - } - }, - "message" : { - "type" : "string" - }, - "suppressed" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/Throwable" - } - }, - "localizedMessage" : { - "type" : "string" - } - } - }, - "TransactionResultEntity" : { - "type" : "object", - "properties" : { - "flowFileSent" : { - "type" : "integer", - "format" : "int32" - }, - "responseCode" : { - "type" : "integer", - "format" : "int32" - }, - "message" : { - "type" : "string" - } - }, - "xml" : { - "name" : "transactionResultEntity" - } - }, - "UpdateControllerServiceReferenceRequestEntity" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The identifier of the Controller Service." - }, - "state" : { - "type" : "string", - "description" : "The new state of the references for the controller service.", - "enum" : [ "ENABLED", "DISABLED", "RUNNING", "STOPPED" ] - }, - "referencingComponentRevisions" : { - "type" : "object", - "description" : "The revisions for all referencing components.", - "additionalProperties" : { - "$ref" : "#/definitions/RevisionDTO" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "uiOnly" : { - "type" : "boolean", - "description" : "Indicates whether or not the response should only include fields necessary for rendering the NiFi User Interface. As such, when this value is set to true, some fields may be returned as null values, and the selected fields may change at any time without notice. As a result, this value should not be set to true by any client other than the UI." - } - }, - "xml" : { - "name" : "updateControllerServiceReferenceRequestEntity" - } - }, - "UserDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "versionedComponentId" : { - "type" : "string", - "description" : "The ID of the corresponding component that is under version control" - }, - "parentGroupId" : { - "type" : "string", - "description" : "The id of parent process group of this component if applicable." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "identity" : { - "type" : "string", - "description" : "The identity of the tenant." - }, - "configurable" : { - "type" : "boolean", - "description" : "Whether this tenant is configurable." - }, - "userGroups" : { - "type" : "array", - "description" : "The groups to which the user belongs. This field is read only and it provided for convenience.", - "readOnly" : true, - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/TenantEntity" - } - }, - "accessPolicies" : { - "type" : "array", - "description" : "The access policies this user belongs to.", - "readOnly" : true, - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/AccessPolicySummaryEntity" - } - } - } - }, - "UserEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "component" : { - "$ref" : "#/definitions/UserDTO" - } - }, - "xml" : { - "name" : "userEntity" - } - }, - "UserGroupDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "versionedComponentId" : { - "type" : "string", - "description" : "The ID of the corresponding component that is under version control" - }, - "parentGroupId" : { - "type" : "string", - "description" : "The id of parent process group of this component if applicable." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "identity" : { - "type" : "string", - "description" : "The identity of the tenant." - }, - "configurable" : { - "type" : "boolean", - "description" : "Whether this tenant is configurable." - }, - "users" : { - "type" : "array", - "description" : "The users that belong to the user group.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/TenantEntity" - } - }, - "accessPolicies" : { - "type" : "array", - "description" : "The access policies this user group belongs to. This field was incorrectly defined as an AccessPolicyEntity. For compatibility reasons the field will remain of this type, however only the fields that are present in the AccessPolicySummaryEntity will be populated here.", - "readOnly" : true, - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/AccessPolicyEntity" - } - } - } - }, - "UserGroupEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "component" : { - "$ref" : "#/definitions/UserGroupDTO" - } - }, - "xml" : { - "name" : "userGroupEntity" - } - }, - "UserGroupsEntity" : { - "type" : "object", - "properties" : { - "userGroups" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/UserGroupEntity" - } - } - }, - "xml" : { - "name" : "userGroupsEntity" - } - }, - "UsersEntity" : { - "type" : "object", - "properties" : { - "generated" : { - "type" : "string", - "description" : "When this content was generated." - }, - "users" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/UserEntity" - } - } - }, - "xml" : { - "name" : "usersEntity" - } - }, - "VariableDTO" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The name of the variable" - }, - "value" : { - "type" : "string", - "description" : "The value of the variable" - }, - "processGroupId" : { - "type" : "string", - "description" : "The ID of the Process Group where this Variable is defined", - "readOnly" : true - }, - "affectedComponents" : { - "type" : "array", - "description" : "A set of all components that will be affected if the value of this variable is changed", - "readOnly" : true, - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/AffectedComponentEntity" - } - } - } - }, - "VariableEntity" : { - "type" : "object", - "properties" : { - "variable" : { - "description" : "The variable information", - "$ref" : "#/definitions/VariableDTO" - }, - "canWrite" : { - "type" : "boolean", - "description" : "Indicates whether the user can write a given resource.", - "readOnly" : true - } - }, - "xml" : { - "name" : "variableEntity" - } - }, - "VariableRegistryDTO" : { - "type" : "object", - "properties" : { - "variables" : { - "type" : "array", - "description" : "The variables that are available in this Variable Registry", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VariableEntity" - } - }, - "processGroupId" : { - "type" : "string", - "description" : "The UUID of the Process Group that this Variable Registry belongs to" - } - } - }, - "VariableRegistryEntity" : { - "type" : "object", - "properties" : { - "processGroupRevision" : { - "description" : "The revision of the Process Group that the Variable Registry belongs to", - "$ref" : "#/definitions/RevisionDTO" - }, - "variableRegistry" : { - "description" : "The Variable Registry.", - "$ref" : "#/definitions/VariableRegistryDTO" - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - } - }, - "xml" : { - "name" : "variableRegistryEntity" - } - }, - "VariableRegistryUpdateRequestDTO" : { - "type" : "object", - "properties" : { - "requestId" : { - "type" : "string", - "description" : "The ID of the request", - "readOnly" : true - }, - "uri" : { - "type" : "string", - "description" : "The URI for the request", - "readOnly" : true - }, - "submissionTime" : { - "type" : "string", - "format" : "date-time", - "description" : "The timestamp of when the request was submitted", - "readOnly" : true - }, - "lastUpdated" : { - "type" : "string", - "format" : "date-time", - "description" : "The timestamp of when the request was last updated", - "readOnly" : true - }, - "complete" : { - "type" : "boolean", - "description" : "Whether or not the request is completed", - "readOnly" : true - }, - "failureReason" : { - "type" : "string", - "description" : "The reason for the request failing, or null if the request has not failed", - "readOnly" : true - }, - "percentCompleted" : { - "type" : "integer", - "format" : "int32", - "description" : "A value between 0 and 100 (inclusive) indicating how close the request is to completion", - "readOnly" : true - }, - "state" : { - "type" : "string", - "description" : "A description of the current state of the request", - "readOnly" : true - }, - "updateSteps" : { - "type" : "array", - "description" : "The steps that are required in order to complete the request, along with the status of each", - "readOnly" : true, - "items" : { - "$ref" : "#/definitions/VariableRegistryUpdateStepDTO" - } - }, - "processGroupId" : { - "type" : "string", - "description" : "The unique ID of the Process Group that the variable registry belongs to" - }, - "affectedComponents" : { - "type" : "array", - "description" : "A set of all components that will be affected if the value of this variable is changed", - "readOnly" : true, - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/AffectedComponentEntity" - } - } - } - }, - "VariableRegistryUpdateRequestEntity" : { - "type" : "object", - "properties" : { - "request" : { - "description" : "The Variable Registry Update Request", - "$ref" : "#/definitions/VariableRegistryUpdateRequestDTO" - }, - "processGroupRevision" : { - "description" : "The revision for the Process Group that owns this variable registry.", - "$ref" : "#/definitions/RevisionDTO" - } - }, - "xml" : { - "name" : "variableRegistryUpdateRequestEntity" - } - }, - "VariableRegistryUpdateStepDTO" : { - "type" : "object", - "properties" : { - "description" : { - "type" : "string", - "description" : "Explanation of what happens in this step", - "readOnly" : true - }, - "complete" : { - "type" : "boolean", - "description" : "Whether or not this step has completed", - "readOnly" : true - }, - "failureReason" : { - "type" : "string", - "description" : "An explanation of why this step failed, or null if this step did not fail", - "readOnly" : true - } - } - }, - "VerifyConfigRequestDTO" : { - "type" : "object", - "properties" : { - "requestId" : { - "type" : "string", - "description" : "The ID of the request", - "readOnly" : true - }, - "uri" : { - "type" : "string", - "description" : "The URI for the request", - "readOnly" : true - }, - "submissionTime" : { - "type" : "string", - "format" : "date-time", - "description" : "The timestamp of when the request was submitted", - "readOnly" : true - }, - "lastUpdated" : { - "type" : "string", - "format" : "date-time", - "description" : "The timestamp of when the request was last updated", - "readOnly" : true - }, - "complete" : { - "type" : "boolean", - "description" : "Whether or not the request is completed", - "readOnly" : true - }, - "failureReason" : { - "type" : "string", - "description" : "The reason for the request failing, or null if the request has not failed", - "readOnly" : true - }, - "percentCompleted" : { - "type" : "integer", - "format" : "int32", - "description" : "A value between 0 and 100 (inclusive) indicating how close the request is to completion", - "readOnly" : true - }, - "state" : { - "type" : "string", - "description" : "A description of the current state of the request", - "readOnly" : true - }, - "updateSteps" : { - "type" : "array", - "description" : "The steps that are required in order to complete the request, along with the status of each", - "readOnly" : true, - "items" : { - "$ref" : "#/definitions/VerifyConfigUpdateStepDTO" - } - }, - "componentId" : { - "type" : "string", - "description" : "The ID of the component whose configuration was verified" - }, - "properties" : { - "type" : "object", - "description" : "The configured component properties", - "additionalProperties" : { - "type" : "string" - } - }, - "attributes" : { - "type" : "object", - "description" : "FlowFile Attributes that should be used to evaluate Expression Language for resolving property values", - "additionalProperties" : { - "type" : "string" - } - }, - "results" : { - "type" : "array", - "description" : "The Results of the verification", - "readOnly" : true, - "items" : { - "$ref" : "#/definitions/ConfigVerificationResultDTO" - } - } - } - }, - "VerifyConfigRequestEntity" : { - "type" : "object", - "properties" : { - "request" : { - "description" : "The request", - "$ref" : "#/definitions/VerifyConfigRequestDTO" - } - }, - "xml" : { - "name" : "verifyConfigRequest" - } - }, - "VerifyConfigUpdateStepDTO" : { - "type" : "object", - "properties" : { - "description" : { - "type" : "string", - "description" : "Explanation of what happens in this step", - "readOnly" : true - }, - "complete" : { - "type" : "boolean", - "description" : "Whether or not this step has completed", - "readOnly" : true - }, - "failureReason" : { - "type" : "string", - "description" : "An explanation of why this step failed, or null if this step did not fail", - "readOnly" : true - } - } - }, - "VersionControlComponentMappingEntity" : { - "type" : "object", - "properties" : { - "versionControlComponentMapping" : { - "type" : "object", - "description" : "The mapping of Versioned Component Identifiers to instance ID's", - "additionalProperties" : { - "type" : "string" - } - }, - "processGroupRevision" : { - "description" : "The revision of the Process Group", - "$ref" : "#/definitions/RevisionDTO" - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "versionControlInformation" : { - "description" : "The Version Control information", - "$ref" : "#/definitions/VersionControlInformationDTO" - } - }, - "xml" : { - "name" : "versionControlComponentMappingEntity" - } - }, - "VersionControlInformationDTO" : { - "type" : "object", - "properties" : { - "groupId" : { - "type" : "string", - "description" : "The ID of the Process Group that is under version control" - }, - "registryId" : { - "type" : "string", - "description" : "The ID of the registry that the flow is stored in" - }, - "registryName" : { - "type" : "string", - "description" : "The name of the registry that the flow is stored in", - "readOnly" : true - }, - "bucketId" : { - "type" : "string", - "description" : "The ID of the bucket that the flow is stored in" - }, - "bucketName" : { - "type" : "string", - "description" : "The name of the bucket that the flow is stored in", - "readOnly" : true - }, - "flowId" : { - "type" : "string", - "description" : "The ID of the flow" - }, - "flowName" : { - "type" : "string", - "description" : "The name of the flow" - }, - "flowDescription" : { - "type" : "string", - "description" : "The description of the flow" - }, - "version" : { - "type" : "integer", - "format" : "int32", - "description" : "The version of the flow" - }, - "storageLocation" : { - "type" : "string", - "description" : "The storage location" - }, - "state" : { - "type" : "string", - "description" : "The current state of the Process Group, as it relates to the Versioned Flow", - "readOnly" : true, - "enum" : [ "LOCALLY_MODIFIED", "STALE", "LOCALLY_MODIFIED_AND_STALE", "UP_TO_DATE", "SYNC_FAILURE" ] - }, - "stateExplanation" : { - "type" : "string", - "description" : "Explanation of why the group is in the specified state", - "readOnly" : true - } - } - }, - "VersionControlInformationEntity" : { - "type" : "object", - "properties" : { - "processGroupRevision" : { - "description" : "The Revision for the Process Group", - "$ref" : "#/definitions/RevisionDTO" - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "versionControlInformation" : { - "description" : "The Version Control information", - "$ref" : "#/definitions/VersionControlInformationDTO" - } - }, - "xml" : { - "name" : "versionControlInformationEntity" - } - }, - "VersionInfoDTO" : { - "type" : "object", - "properties" : { - "niFiVersion" : { - "type" : "string", - "description" : "The version of this NiFi." - }, - "javaVendor" : { - "type" : "string", - "description" : "Java JVM vendor" - }, - "javaVersion" : { - "type" : "string", - "description" : "Java version" - }, - "osName" : { - "type" : "string", - "description" : "Host operating system name" - }, - "osVersion" : { - "type" : "string", - "description" : "Host operating system version" - }, - "osArchitecture" : { - "type" : "string", - "description" : "Host operating system architecture" - }, - "buildTag" : { - "type" : "string", - "description" : "Build tag" - }, - "buildRevision" : { - "type" : "string", - "description" : "Build revision or commit hash" - }, - "buildBranch" : { - "type" : "string", - "description" : "Build branch" - }, - "buildTimestamp" : { - "type" : "string", - "format" : "date-time", - "description" : "Build timestamp" - } - } - }, - "VersionedConnection" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The component's unique identifier" - }, - "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" - }, - "comments" : { - "type" : "string", - "description" : "The user-supplied comments for the component" - }, - "position" : { - "description" : "The component's position on the graph", - "$ref" : "#/definitions/Position" - }, - "source" : { - "description" : "The source of the connection.", - "$ref" : "#/definitions/ConnectableComponent" - }, - "destination" : { - "description" : "The destination of the connection.", - "$ref" : "#/definitions/ConnectableComponent" - }, - "labelIndex" : { - "type" : "integer", - "format" : "int32", - "description" : "The index of the bend point where to place the connection label." - }, - "zIndex" : { - "type" : "integer", - "format" : "int64", - "description" : "The z index of the connection." - }, - "selectedRelationships" : { - "type" : "array", - "description" : "The selected relationship that comprise the connection.", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - }, - "backPressureObjectThreshold" : { - "type" : "integer", - "format" : "int64", - "description" : "The object count threshold for determining when back pressure is applied. Updating this value is a passive change in the sense that it won't impact whether existing files over the limit are affected but it does help feeder processors to stop pushing too much into this work queue." - }, - "backPressureDataSizeThreshold" : { - "type" : "string", - "description" : "The object data size threshold for determining when back pressure is applied. Updating this value is a passive change in the sense that it won't impact whether existing files over the limit are affected but it does help feeder processors to stop pushing too much into this work queue." - }, - "flowFileExpiration" : { - "type" : "string", - "description" : "The amount of time a flow file may be in the flow before it will be automatically aged out of the flow. Once a flow file reaches this age it will be terminated from the flow the next time a processor attempts to start work on it." - }, - "prioritizers" : { - "type" : "array", - "description" : "The comparators used to prioritize the queue.", - "items" : { - "type" : "string" - } - }, - "bends" : { - "type" : "array", - "description" : "The bend points on the connection.", - "items" : { - "$ref" : "#/definitions/Position" - } - }, - "loadBalanceStrategy" : { - "type" : "string", - "description" : "The Strategy to use for load balancing data across the cluster, or null, if no Load Balance Strategy has been specified.", - "enum" : [ "DO_NOT_LOAD_BALANCE", "PARTITION_BY_ATTRIBUTE", "ROUND_ROBIN", "SINGLE_NODE" ] - }, - "partitioningAttribute" : { - "type" : "string", - "description" : "The attribute to use for partitioning data as it is load balanced across the cluster. If the Load Balance Strategy is configured to use PARTITION_BY_ATTRIBUTE, the value returned by this method is the name of the FlowFile Attribute that will be used to determine which node in the cluster should receive a given FlowFile. If the Load Balance Strategy is unset or is set to any other value, the Partitioning Attribute has no effect." - }, - "loadBalanceCompression" : { - "type" : "string", - "description" : "Whether or not compression should be used when transferring FlowFiles between nodes", - "enum" : [ "DO_NOT_COMPRESS", "COMPRESS_ATTRIBUTES_ONLY", "COMPRESS_ATTRIBUTES_AND_CONTENT" ] - }, - "componentType" : { - "type" : "string", - "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE", "REPORTING_TASK", "PARAMETER_CONTEXT", "PARAMETER_PROVIDER", "TEMPLATE", "FLOW_REGISTRY_CLIENT" ] - }, - "groupIdentifier" : { - "type" : "string", - "description" : "The ID of the Process Group that this component belongs to" - } - } - }, - "VersionedControllerService" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The component's unique identifier" - }, - "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" - }, - "comments" : { - "type" : "string", - "description" : "The user-supplied comments for the component" - }, - "position" : { - "description" : "The component's position on the graph", - "$ref" : "#/definitions/Position" - }, - "type" : { - "type" : "string", - "description" : "The type of the extension component" - }, - "bundle" : { - "description" : "Information about the bundle from which the component came", - "$ref" : "#/definitions/Bundle" - }, - "properties" : { - "type" : "object", - "description" : "The properties for the component. Properties whose value is not set will only contain the property name.", - "additionalProperties" : { - "type" : "string" - } - }, - "propertyDescriptors" : { - "type" : "object", - "description" : "The property descriptors for the component.", - "additionalProperties" : { - "$ref" : "#/definitions/VersionedPropertyDescriptor" - } - }, - "controllerServiceApis" : { - "type" : "array", - "description" : "Lists the APIs this Controller Service implements.", - "items" : { - "$ref" : "#/definitions/ControllerServiceAPI" - } - }, - "annotationData" : { - "type" : "string", - "description" : "The annotation for the controller service. This is how the custom UI relays configuration to the controller service." - }, - "scheduledState" : { - "type" : "string", - "description" : "The ScheduledState denoting whether the Controller Service is ENABLED or DISABLED", - "enum" : [ "ENABLED", "DISABLED", "RUNNING" ] - }, - "bulletinLevel" : { - "type" : "string", - "description" : "The level at which the controller service will report bulletins." - }, - "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", "PARAMETER_CONTEXT", "PARAMETER_PROVIDER", "TEMPLATE", "FLOW_REGISTRY_CLIENT" ] - }, - "groupIdentifier" : { - "type" : "string", - "description" : "The ID of the Process Group that this component belongs to" - } - } - }, - "VersionedFlowCoordinates" : { - "type" : "object", - "properties" : { - "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" - }, - "registryUrl" : { - "type" : "string", - "description" : "The URL of the Flow Registry that contains the flow" - }, - "bucketId" : { - "type" : "string", - "description" : "The UUID of the bucket that the flow resides in" - }, - "flowId" : { - "type" : "string", - "description" : "The UUID of the flow" - }, - "version" : { - "type" : "integer", - "format" : "int32", - "description" : "The version of the flow" - }, - "latest" : { - "type" : "boolean", - "description" : "Whether or not these coordinates point to the latest version of the flow" - } - } - }, - "VersionedFlowDTO" : { - "type" : "object", - "properties" : { - "registryId" : { - "type" : "string", - "description" : "The ID of the registry that the flow is tracked to" - }, - "bucketId" : { - "type" : "string", - "description" : "The ID of the bucket where the flow is stored" - }, - "flowId" : { - "type" : "string", - "description" : "The ID of the flow" - }, - "flowName" : { - "type" : "string", - "description" : "The name of the flow" - }, - "description" : { - "type" : "string", - "description" : "A description of the flow" - }, - "comments" : { - "type" : "string", - "description" : "Comments for the changeset" - }, - "action" : { - "type" : "string", - "description" : "The action being performed", - "enum" : [ "COMMIT", "FORCE_COMMIT" ] - } - } - }, - "VersionedFlowEntity" : { - "type" : "object", - "properties" : { - "versionedFlow" : { - "description" : "The versioned flow", - "$ref" : "#/definitions/VersionedFlowDTO" - } - }, - "xml" : { - "name" : "versionedFlowEntity" - } - }, - "VersionedFlowSnapshotEntity" : { - "type" : "object", - "properties" : { - "versionedFlowSnapshot" : { - "description" : "The versioned flow snapshot", - "$ref" : "#/definitions/RegisteredFlowSnapshot" - }, - "processGroupRevision" : { - "description" : "The Revision of the Process Group under Version Control", - "$ref" : "#/definitions/RevisionDTO" - }, - "registryId" : { - "type" : "string", - "description" : "The ID of the Registry that this flow belongs to" - }, - "updateDescendantVersionedFlows" : { - "type" : "boolean", - "description" : "If the Process Group to be updated has a child or descendant Process Group that is also under Version Control, this specifies whether or not the contents of that child/descendant Process Group should be updated." - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - } - }, - "xml" : { - "name" : "versionedFlowSnapshotEntity" - } - }, - "VersionedFlowSnapshotMetadataEntity" : { - "type" : "object", - "properties" : { - "versionedFlowSnapshotMetadata" : { - "description" : "The collection of registered flow snapshot metadata", - "$ref" : "#/definitions/RegisteredFlowSnapshotMetadata" - }, - "registryId" : { - "type" : "string", - "description" : "The ID of the Registry that this flow belongs to" - } - }, - "xml" : { - "name" : "versionedFlowSnapshotMetadataEntity" - } - }, - "VersionedFlowSnapshotMetadataSetEntity" : { - "type" : "object", - "properties" : { - "versionedFlowSnapshotMetadataSet" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedFlowSnapshotMetadataEntity" - } - } - }, - "xml" : { - "name" : "versionedFlowSnapshotMetadataSetEntity" - } - }, - "VersionedFlowUpdateRequestDTO" : { - "type" : "object", - "properties" : { - "requestId" : { - "type" : "string", - "description" : "The unique ID of this request.", - "readOnly" : true - }, - "processGroupId" : { - "type" : "string", - "description" : "The unique ID of the Process Group being updated" - }, - "uri" : { - "type" : "string", - "description" : "The URI for future requests to this drop request.", - "readOnly" : true - }, - "lastUpdated" : { - "type" : "string", - "description" : "The last time this request was updated.", - "readOnly" : true - }, - "complete" : { - "type" : "boolean", - "description" : "Whether or not this request has completed", - "readOnly" : true - }, - "failureReason" : { - "type" : "string", - "description" : "An explanation of why this request failed, or null if this request has not failed", - "readOnly" : true - }, - "percentCompleted" : { - "type" : "integer", - "format" : "int32", - "description" : "The percentage complete for the request, between 0 and 100", - "readOnly" : true - }, - "state" : { - "type" : "string", - "description" : "The state of the request", - "readOnly" : true - }, - "versionControlInformation" : { - "description" : "The VersionControlInformation that describes where the Versioned Flow is located; this may not be populated until the request is completed.", - "readOnly" : true, - "$ref" : "#/definitions/VersionControlInformationDTO" - } - } - }, - "VersionedFlowUpdateRequestEntity" : { - "type" : "object", - "properties" : { - "processGroupRevision" : { - "description" : "The revision for the Process Group being updated.", - "$ref" : "#/definitions/RevisionDTO" - }, - "request" : { - "description" : "The Flow Update Request", - "$ref" : "#/definitions/VersionedFlowUpdateRequestDTO" - } - }, - "xml" : { - "name" : "registeredFlowUpdateRequestEntity" - } - }, - "VersionedFlowsEntity" : { - "type" : "object", - "properties" : { - "versionedFlows" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedFlowEntity" - } - } - }, - "xml" : { - "name" : "versionedFlowsEntity" - } - }, - "VersionedFunnel" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The component's unique identifier" - }, - "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" - }, - "comments" : { - "type" : "string", - "description" : "The user-supplied comments for the component" - }, - "position" : { - "description" : "The component's position on the graph", - "$ref" : "#/definitions/Position" - }, - "componentType" : { - "type" : "string", - "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE", "REPORTING_TASK", "PARAMETER_CONTEXT", "PARAMETER_PROVIDER", "TEMPLATE", "FLOW_REGISTRY_CLIENT" ] - }, - "groupIdentifier" : { - "type" : "string", - "description" : "The ID of the Process Group that this component belongs to" - } - } - }, - "VersionedLabel" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The component's unique identifier" - }, - "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" - }, - "comments" : { - "type" : "string", - "description" : "The user-supplied comments for the component" - }, - "position" : { - "description" : "The component's position on the graph", - "$ref" : "#/definitions/Position" - }, - "label" : { - "type" : "string", - "description" : "The text that appears in the label." - }, - "zIndex" : { - "type" : "integer", - "format" : "int64", - "description" : "The z index of the connection." - }, - "width" : { - "type" : "number", - "format" : "double", - "description" : "The width of the label in pixels when at a 1:1 scale." - }, - "height" : { - "type" : "number", - "format" : "double", - "description" : "The height of the label in pixels when at a 1:1 scale." - }, - "style" : { - "type" : "object", - "description" : "The styles for this label (font-size : 12px, background-color : #eee, etc).", - "additionalProperties" : { - "type" : "string" - } - }, - "componentType" : { - "type" : "string", - "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE", "REPORTING_TASK", "PARAMETER_CONTEXT", "PARAMETER_PROVIDER", "TEMPLATE", "FLOW_REGISTRY_CLIENT" ] - }, - "groupIdentifier" : { - "type" : "string", - "description" : "The ID of the Process Group that this component belongs to" - } - } - }, - "VersionedParameter" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The name of the parameter" - }, - "description" : { - "type" : "string", - "description" : "The description of the param" - }, - "sensitive" : { - "type" : "boolean", - "description" : "Whether or not the parameter value is sensitive" - }, - "provided" : { - "type" : "boolean", - "description" : "Whether or not the parameter value is provided by a ParameterProvider" - }, - "value" : { - "type" : "string", - "description" : "The value of the parameter" - } - } - }, - "VersionedParameterContext" : { - "type" : "object", - "properties" : { - "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" - }, - "comments" : { - "type" : "string", - "description" : "The user-supplied comments for the component" - }, - "position" : { - "description" : "The component's position on the graph", - "$ref" : "#/definitions/Position" - }, - "parameters" : { - "type" : "array", - "description" : "The parameters in the context", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedParameter" - } - }, - "inheritedParameterContexts" : { - "type" : "array", - "description" : "The names of additional parameter contexts from which to inherit parameters", - "items" : { - "type" : "string" - } - }, - "description" : { - "type" : "string", - "description" : "The description of the parameter context" - }, - "parameterProvider" : { - "type" : "string", - "description" : "The identifier of an optional parameter provider" - }, - "parameterGroupName" : { - "type" : "string", - "description" : "The corresponding parameter group name fetched from the parameter provider, if applicable" - }, - "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", "PARAMETER_CONTEXT", "PARAMETER_PROVIDER", "TEMPLATE", "FLOW_REGISTRY_CLIENT" ] - }, - "synchronized" : { - "type" : "boolean", - "description" : "True if the parameter provider is set and the context should receive updates when its parameters are next fetched" - }, - "groupIdentifier" : { - "type" : "string", - "description" : "The ID of the Process Group that this component belongs to" - } - } - }, - "VersionedPort" : { - "type" : "object", - "properties" : { - "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" - }, - "comments" : { - "type" : "string", - "description" : "The user-supplied comments for the component" - }, - "position" : { - "description" : "The component's position on the graph", - "$ref" : "#/definitions/Position" - }, - "type" : { - "type" : "string", - "description" : "The type of port.", - "enum" : [ "INPUT_PORT", "OUTPUT_PORT" ] - }, - "concurrentlySchedulableTaskCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of tasks that should be concurrently scheduled for the port." - }, - "scheduledState" : { - "type" : "string", - "description" : "The scheduled state of the component", - "enum" : [ "ENABLED", "DISABLED", "RUNNING" ] - }, - "allowRemoteAccess" : { - "type" : "boolean", - "description" : "Whether or not this port allows remote access for site-to-site" - }, - "componentType" : { - "type" : "string", - "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE", "REPORTING_TASK", "PARAMETER_CONTEXT", "PARAMETER_PROVIDER", "TEMPLATE", "FLOW_REGISTRY_CLIENT" ] - }, - "groupIdentifier" : { - "type" : "string", - "description" : "The ID of the Process Group that this component belongs to" - } - } - }, - "VersionedProcessGroup" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The component's unique identifier" - }, - "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" - }, - "comments" : { - "type" : "string", - "description" : "The user-supplied comments for the component" - }, - "position" : { - "description" : "The component's position on the graph", - "$ref" : "#/definitions/Position" - }, - "processGroups" : { - "type" : "array", - "description" : "The child Process Groups", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedProcessGroup" - } - }, - "remoteProcessGroups" : { - "type" : "array", - "description" : "The Remote Process Groups", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedRemoteProcessGroup" - } - }, - "processors" : { - "type" : "array", - "description" : "The Processors", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedProcessor" - } - }, - "inputPorts" : { - "type" : "array", - "description" : "The Input Ports", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedPort" - } - }, - "outputPorts" : { - "type" : "array", - "description" : "The Output Ports", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedPort" - } - }, - "connections" : { - "type" : "array", - "description" : "The Connections", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedConnection" - } - }, - "labels" : { - "type" : "array", - "description" : "The Labels", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedLabel" - } - }, - "funnels" : { - "type" : "array", - "description" : "The Funnels", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedFunnel" - } - }, - "controllerServices" : { - "type" : "array", - "description" : "The Controller Services", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedControllerService" - } - }, - "versionedFlowCoordinates" : { - "description" : "The coordinates where the remote flow is stored, or null if the Process Group is not directly under Version Control", - "$ref" : "#/definitions/VersionedFlowCoordinates" - }, - "variables" : { - "type" : "object", - "description" : "The Variables in the Variable Registry for this Process Group (not including any ancestor or descendant Process Groups)", - "additionalProperties" : { - "type" : "string" - } - }, - "parameterContextName" : { - "type" : "string", - "description" : "The name of the parameter context used by this process group" - }, - "defaultFlowFileExpiration" : { - "type" : "string", - "description" : "The default FlowFile Expiration for this Process Group." - }, - "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." - }, - "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." - }, - "logFileSuffix" : { - "type" : "string", - "description" : "The log file suffix for this Process Group for dedicated logging." - }, - "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", "PARAMETER_CONTEXT", "PARAMETER_PROVIDER", "TEMPLATE", "FLOW_REGISTRY_CLIENT" ] - }, - "flowFileOutboundPolicy" : { - "type" : "string", - "description" : "The FlowFile Outbound Policy for the Process Group" - }, - "flowFileConcurrency" : { - "type" : "string", - "description" : "The configured FlowFile Concurrency for the Process Group" - }, - "groupIdentifier" : { - "type" : "string", - "description" : "The ID of the Process Group that this component belongs to" - } - } - }, - "VersionedProcessor" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The component's unique identifier" - }, - "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" - }, - "comments" : { - "type" : "string", - "description" : "The user-supplied comments for the component" - }, - "position" : { - "description" : "The component's position on the graph", - "$ref" : "#/definitions/Position" - }, - "type" : { - "type" : "string", - "description" : "The type of the extension component" - }, - "bundle" : { - "description" : "Information about the bundle from which the component came", - "$ref" : "#/definitions/Bundle" - }, - "properties" : { - "type" : "object", - "description" : "The properties for the component. Properties whose value is not set will only contain the property name.", - "additionalProperties" : { - "type" : "string" - } - }, - "propertyDescriptors" : { - "type" : "object", - "description" : "The property descriptors for the component.", - "additionalProperties" : { - "$ref" : "#/definitions/VersionedPropertyDescriptor" - } - }, - "style" : { - "type" : "object", - "description" : "Stylistic data for rendering in a UI", - "additionalProperties" : { - "type" : "string" - } - }, - "annotationData" : { - "type" : "string", - "description" : "The annotation data for the processor used to relay configuration between a custom UI and the procesosr." - }, - "schedulingPeriod" : { - "type" : "string", - "description" : "The frequency with which to schedule the processor. The format of the value will depend on th value of schedulingStrategy." - }, - "schedulingStrategy" : { - "type" : "string", - "description" : "Indicates whether the processor should be scheduled to run in event or timer driven mode." - }, - "executionNode" : { - "type" : "string", - "description" : "Indicates the node where the process will execute." - }, - "penaltyDuration" : { - "type" : "string", - "description" : "The amout of time that is used when the process penalizes a flowfile." - }, - "yieldDuration" : { - "type" : "string", - "description" : "The amount of time that must elapse before this processor is scheduled again after yielding." - }, - "bulletinLevel" : { - "type" : "string", - "description" : "The level at which the processor will report bulletins." - }, - "runDurationMillis" : { - "type" : "integer", - "format" : "int64", - "description" : "The run duration for the processor in milliseconds." - }, - "concurrentlySchedulableTaskCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of tasks that should be concurrently schedule for the processor. If the processor doesn't allow parallol processing then any positive input will be ignored." - }, - "autoTerminatedRelationships" : { - "type" : "array", - "description" : "The names of all relationships that cause a flow file to be terminated if the relationship is not connected elsewhere. This property differs from the 'isAutoTerminate' property of the RelationshipDTO in that the RelationshipDTO is meant to depict the current configuration, whereas this property can be set in a DTO when updating a Processor in order to change which Relationships should be auto-terminated.", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - }, - "scheduledState" : { - "type" : "string", - "description" : "The scheduled state of the component", - "enum" : [ "ENABLED", "DISABLED", "RUNNING" ] - }, - "retryCount" : { - "type" : "integer", - "format" : "int32", - "description" : "Overall number of retries." - }, - "retriedRelationships" : { - "type" : "array", - "description" : "All the relationships should be retried.", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - }, - "backoffMechanism" : { - "type" : "string", - "description" : "Determines whether the FlowFile should be penalized or the processor should be yielded between retries.", - "enum" : [ "PENALIZE_FLOWFILE", "YIELD_PROCESSOR" ] - }, - "maxBackoffPeriod" : { - "type" : "string", - "description" : "Maximum amount of time to be waited during a retry period." - }, - "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", "PARAMETER_CONTEXT", "PARAMETER_PROVIDER", "TEMPLATE", "FLOW_REGISTRY_CLIENT" ] - }, - "groupIdentifier" : { - "type" : "string", - "description" : "The ID of the Process Group that this component belongs to" - } - } - }, - "VersionedPropertyDescriptor" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The name of the property" - }, - "displayName" : { - "type" : "string", - "description" : "The display name of the property" - }, - "identifiesControllerService" : { - "type" : "boolean", - "description" : "Whether or not the property provides the identifier of a Controller Service" - }, - "sensitive" : { - "type" : "boolean", - "description" : "Whether or not the property is considered sensitive" - }, - "resourceDefinition" : { - "description" : "Returns the Resource Definition that defines which type(s) of resource(s) this property references, if any", - "$ref" : "#/definitions/VersionedResourceDefinition" - } - } - }, - "VersionedRemoteGroupPort" : { - "type" : "object", - "properties" : { - "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" - }, - "comments" : { - "type" : "string", - "description" : "The user-supplied comments for the component" - }, - "position" : { - "description" : "The component's position on the graph", - "$ref" : "#/definitions/Position" - }, - "remoteGroupId" : { - "type" : "string", - "description" : "The id of the remote process group that the port resides in." - }, - "concurrentlySchedulableTaskCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of task that may transmit flowfiles to the target port concurrently." - }, - "useCompression" : { - "type" : "boolean", - "description" : "Whether the flowfiles are compressed when sent to the target port." - }, - "batchSize" : { - "description" : "The batch settings for data transmission.", - "$ref" : "#/definitions/BatchSize" - }, - "componentType" : { - "type" : "string", - "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE", "REPORTING_TASK", "PARAMETER_CONTEXT", "PARAMETER_PROVIDER", "TEMPLATE", "FLOW_REGISTRY_CLIENT" ] - }, - "targetId" : { - "type" : "string", - "description" : "The ID of the port on the target NiFi instance" - }, - "scheduledState" : { - "type" : "string", - "description" : "The scheduled state of the component", - "enum" : [ "ENABLED", "DISABLED", "RUNNING" ] - }, - "groupIdentifier" : { - "type" : "string", - "description" : "The ID of the Process Group that this component belongs to" - } - } - }, - "VersionedRemoteProcessGroup" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The component's unique identifier" - }, - "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" - }, - "comments" : { - "type" : "string", - "description" : "The user-supplied comments for the component" - }, - "position" : { - "description" : "The component's position on the graph", - "$ref" : "#/definitions/Position" - }, - "targetUri" : { - "type" : "string", - "description" : "[DEPRECATED] The target URI of the remote process group. If target uri is not set, but uris are set, then returns the first uri in the uris. If neither target uri nor uris are set, then returns null." - }, - "targetUris" : { - "type" : "string", - "description" : "The target URIs of the remote process group. If target uris is not set but target uri is set, then returns the single target uri. If neither target uris nor target uri is set, then returns null." - }, - "communicationsTimeout" : { - "type" : "string", - "description" : "The time period used for the timeout when communicating with the target." - }, - "yieldDuration" : { - "type" : "string", - "description" : "When yielding, this amount of time must elapse before the remote process group is scheduled again." - }, - "transportProtocol" : { - "type" : "string", - "description" : "The Transport Protocol that is used for Site-to-Site communications", - "enum" : [ "RAW", "HTTP" ] - }, - "localNetworkInterface" : { - "type" : "string", - "description" : "The local network interface to send/receive data. If not specified, any local address is used. If clustered, all nodes must have an interface with this identifier." - }, - "proxyHost" : { - "type" : "string" - }, - "proxyPort" : { - "type" : "integer", - "format" : "int32" - }, - "proxyUser" : { - "type" : "string" - }, - "proxyPassword" : { - "type" : "string" - }, - "inputPorts" : { - "type" : "array", - "description" : "A Set of Input Ports that can be connected to, in order to send data to the remote NiFi instance", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedRemoteGroupPort" - } - }, - "outputPorts" : { - "type" : "array", - "description" : "A Set of Output Ports that can be connected to, in order to pull data from the remote NiFi instance", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedRemoteGroupPort" - } - }, - "componentType" : { - "type" : "string", - "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE", "REPORTING_TASK", "PARAMETER_CONTEXT", "PARAMETER_PROVIDER", "TEMPLATE", "FLOW_REGISTRY_CLIENT" ] - }, - "groupIdentifier" : { - "type" : "string", - "description" : "The ID of the Process Group that this component belongs to" - } - } - }, - "VersionedReportingTask" : { - "type" : "object", - "properties" : { - "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" - }, - "comments" : { - "type" : "string", - "description" : "The user-supplied comments for the component" - }, - "position" : { - "description" : "The component's position on the graph", - "$ref" : "#/definitions/Position" - }, - "type" : { - "type" : "string", - "description" : "The type of the extension component" - }, - "bundle" : { - "description" : "Information about the bundle from which the component came", - "$ref" : "#/definitions/Bundle" - }, - "properties" : { - "type" : "object", - "description" : "The properties for the component. Properties whose value is not set will only contain the property name.", - "additionalProperties" : { - "type" : "string" - } - }, - "propertyDescriptors" : { - "type" : "object", - "description" : "The property descriptors for the component.", - "additionalProperties" : { - "$ref" : "#/definitions/VersionedPropertyDescriptor" - } - }, - "annotationData" : { - "type" : "string", - "description" : "The annotation for the reporting task. This is how the custom UI relays configuration to the reporting task." - }, - "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." - }, - "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", "PARAMETER_CONTEXT", "PARAMETER_PROVIDER", "TEMPLATE", "FLOW_REGISTRY_CLIENT" ] - }, - "groupIdentifier" : { - "type" : "string", - "description" : "The ID of the Process Group that this component belongs to" - } - } - }, - "VersionedReportingTaskSnapshot" : { - "type" : "object", - "properties" : { - "reportingTasks" : { - "type" : "array", - "description" : "The reporting tasks", - "items" : { - "$ref" : "#/definitions/VersionedReportingTask" - } - }, - "controllerServices" : { - "type" : "array", - "description" : "The controller services", - "items" : { - "$ref" : "#/definitions/VersionedControllerService" - } - } - } - }, - "VersionedResourceDefinition" : { - "type" : "object", - "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", - "uniqueItems" : true, - "items" : { - "type" : "string", - "enum" : [ "FILE", "DIRECTORY", "TEXT", "URL" ] - } - } - } - } - } -} \ No newline at end of file diff --git a/resources/client_gen/api_defs/nifi-1.28.1.json b/resources/client_gen/api_defs/nifi-1.28.1.json deleted file mode 100644 index ce2ea289..00000000 --- a/resources/client_gen/api_defs/nifi-1.28.1.json +++ /dev/null @@ -1,26541 +0,0 @@ -{ - "swagger" : "2.0", - "info" : { - "description" : "The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and\n stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description,\n definitions of the expected input and output, potential response codes, and the authorizations required\n to invoke each service.", - "version" : "1.28.1", - "title" : "NiFi Rest API", - "contact" : { - "url" : "https://nifi.apache.org", - "email" : "dev@nifi.apache.org" - }, - "license" : { - "name" : "Apache 2.0", - "url" : "http://www.apache.org/licenses/LICENSE-2.0.html" - } - }, - "basePath" : "/nifi-api", - "tags" : [ { - "name" : "access", - "description" : "Endpoints for obtaining an access token or checking access status." - }, { - "name" : "connections", - "description" : "Endpoint for managing a Connection." - }, { - "name" : "controller", - "description" : "Provides realtime command and control of this NiFi instance" - }, { - "name" : "controller-services", - "description" : "Endpoint for managing a Controller Service." - }, { - "name" : "counters", - "description" : "Endpoint for managing counters." - }, { - "name" : "data-transfer", - "description" : "Supports data transfers with this NiFi using HTTP based site to site" - }, { - "name" : "flow", - "description" : "Endpoint for accessing the flow structure and component status." - }, { - "name" : "flowfile-queues", - "description" : "Endpoint for managing a FlowFile Queue." - }, { - "name" : "funnel", - "description" : "Endpoint for managing a Funnel." - }, { - "name" : "input-ports", - "description" : "Endpoint for managing an Input Port." - }, { - "name" : "labels", - "description" : "Endpoint for managing a Label." - }, { - "name" : "output-ports", - "description" : "Endpoint for managing an Output Port." - }, { - "name" : "parameter-contexts", - "description" : "Endpoint for managing version control for a flow" - }, { - "name" : "parameter-providers", - "description" : "Endpoint for managing a Parameter Provider." - }, { - "name" : "policies", - "description" : "Endpoint for managing access policies." - }, { - "name" : "process-groups", - "description" : "Endpoint for managing a Process Group." - }, { - "name" : "processors", - "description" : "Endpoint for managing a Processor." - }, { - "name" : "provenance", - "description" : "Endpoint for accessing data flow provenance." - }, { - "name" : "provenance-events", - "description" : "Endpoint for accessing data flow provenance." - }, { - "name" : "remote-process-groups", - "description" : "Endpoint for managing a Remote Process Group." - }, { - "name" : "reporting-tasks", - "description" : "Endpoint for managing a Reporting Task." - }, { - "name" : "resources", - "description" : "Provides the resources in this NiFi that can have access/authorization policies." - }, { - "name" : "site-to-site", - "description" : "Provide access to site to site with this NiFi" - }, { - "name" : "snippets", - "description" : "Endpoint for accessing dataflow snippets." - }, { - "name" : "system-diagnostics", - "description" : "Endpoint for accessing system diagnostics." - }, { - "name" : "templates", - "description" : "Endpoint for managing a Template." - }, { - "name" : "tenants", - "description" : "Endpoint for managing users and user groups." - }, { - "name" : "versions", - "description" : "Endpoint for managing version control for a flow" - } ], - "schemes" : [ "http", "https" ], - "paths" : { - "/access" : { - "get" : { - "tags" : [ "access" ], - "summary" : "Gets the status the client's access", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getAccessStatus", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/AccessStatusEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Unable to determine access status because the client could not be authenticated." - }, - "403" : { - "description" : "Unable to determine access status because the client is not authorized to make this request." - }, - "409" : { - "description" : "Unable to determine access status because NiFi is not in the appropriate state." - }, - "500" : { - "description" : "Unable to determine access status because an unexpected error occurred." - } - } - } - }, - "/access/config" : { - "get" : { - "tags" : [ "access" ], - "summary" : "Retrieves the access configuration for this NiFi", - "description" : "", - "operationId" : "getLoginConfig", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/AccessConfigurationEntity" - } - } - } - } - }, - "/access/kerberos" : { - "post" : { - "tags" : [ "access" ], - "summary" : "Creates a token for accessing the REST API via Kerberos ticket exchange / SPNEGO negotiation", - "description" : "The token returned is formatted as a JSON Web Token (JWT). The token is base64 encoded and comprised of three parts. The header, the body, and the signature. The expiration of the token is a contained within the body. The token can be used in the Authorization header in the format 'Authorization: Bearer '. It is also stored in the browser as a cookie.", - "operationId" : "createAccessTokenFromTicket", - "consumes" : [ "text/plain" ], - "produces" : [ "text/plain" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "NiFi was unable to complete the request because it did not contain a valid Kerberos ticket in the Authorization header. Retry this request after initializing a ticket with kinit and ensuring your browser is configured to support SPNEGO." - }, - "409" : { - "description" : "Unable to create access token because NiFi is not in the appropriate state. (i.e. may not be configured to support Kerberos login." - }, - "500" : { - "description" : "Unable to create access token because an unexpected error occurred." - } - } - } - }, - "/access/knox/callback" : { - "get" : { - "tags" : [ "access" ], - "summary" : "Redirect/callback URI for processing the result of the Apache Knox login sequence.", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "knoxCallback", - "consumes" : [ "*/*" ], - "produces" : [ "*/*" ], - "responses" : { - "default" : { - "description" : "successful operation" - } - } - } - }, - "/access/knox/logout" : { - "get" : { - "tags" : [ "access" ], - "summary" : "Performs a logout in the Apache Knox.", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "knoxLogout", - "consumes" : [ "*/*" ], - "produces" : [ "*/*" ], - "responses" : { - "default" : { - "description" : "successful operation" - } - } - } - }, - "/access/knox/request" : { - "get" : { - "tags" : [ "access" ], - "summary" : "Initiates a request to authenticate through Apache Knox.", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "knoxRequest", - "consumes" : [ "*/*" ], - "produces" : [ "*/*" ], - "responses" : { - "default" : { - "description" : "successful operation" - } - } - } - }, - "/access/logout" : { - "delete" : { - "tags" : [ "access" ], - "summary" : "Performs a logout for other providers that have been issued a JWT.", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "logOut", - "consumes" : [ "*/*" ], - "produces" : [ "*/*" ], - "responses" : { - "200" : { - "description" : "User was logged out successfully." - }, - "401" : { - "description" : "Authentication token provided was empty or not in the correct JWT format." - }, - "500" : { - "description" : "Client failed to log out." - } - } - } - }, - "/access/logout/complete" : { - "get" : { - "tags" : [ "access" ], - "summary" : "Completes the logout sequence by removing the cached Logout Request and Cookie if they existed and redirects to /nifi/login.", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "logOutComplete", - "consumes" : [ "*/*" ], - "produces" : [ "*/*" ], - "responses" : { - "200" : { - "description" : "User was logged out successfully." - }, - "401" : { - "description" : "Authentication token provided was empty or not in the correct JWT format." - }, - "500" : { - "description" : "Client failed to log out." - } - } - } - }, - "/access/token" : { - "post" : { - "tags" : [ "access" ], - "summary" : "Creates a token for accessing the REST API via username/password", - "description" : "The token returned is formatted as a JSON Web Token (JWT). The token is base64 encoded and comprised of three parts. The header, the body, and the signature. The expiration of the token is a contained within the body. 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", - "consumes" : [ "application/x-www-form-urlencoded" ], - "produces" : [ "text/plain" ], - "parameters" : [ { - "name" : "username", - "in" : "formData", - "required" : false, - "type" : "string" - }, { - "name" : "password", - "in" : "formData", - "required" : false, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "Unable to create access token because NiFi is not in the appropriate state. (i.e. may not be configured to support username/password login." - }, - "500" : { - "description" : "Unable to create access token because an unexpected error occurred." - } - } - } - }, - "/access/token/expiration" : { - "get" : { - "tags" : [ "access" ], - "summary" : "Get expiration for current Access Token", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getAccessTokenExpiration", - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "Access Token Expiration found", - "schema" : { - "$ref" : "#/definitions/AccessTokenExpirationEntity" - } - }, - "401" : { - "description" : "Access Token not authorized" - }, - "409" : { - "description" : "Access Token not resolved" - } - } - } - }, - "/connections/{id}" : { - "get" : { - "tags" : [ "connections" ], - "summary" : "Gets a connection", - "description" : "", - "operationId" : "getConnection", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The connection id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ConnectionEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read Source - /{component-type}/{uuid}" : [ ] - }, { - "Read Destination - /{component-type}/{uuid}" : [ ] - } ] - }, - "put" : { - "tags" : [ "connections" ], - "summary" : "Updates a connection", - "description" : "", - "operationId" : "updateConnection", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The connection id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The connection configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ConnectionEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ConnectionEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write Source - /{component-type}/{uuid}" : [ ] - }, { - "Write Destination - /{component-type}/{uuid}" : [ ] - }, { - "Write New Destination - /{component-type}/{uuid} - if updating Destination" : [ ] - }, { - "Write Process Group - /process-groups/{uuid} - if updating Destination" : [ ] - } ] - }, - "delete" : { - "tags" : [ "connections" ], - "summary" : "Deletes a connection", - "description" : "", - "operationId" : "deleteConnection", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The revision is used to verify the client is working with the latest version of the flow.", - "required" : false, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The connection id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ConnectionEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write Source - /{component-type}/{uuid}" : [ ] - }, { - "Write - Parent Process Group - /process-groups/{uuid}" : [ ] - }, { - "Write Destination - /{component-type}/{uuid}" : [ ] - } ] - } - }, - "/controller-services/{id}" : { - "get" : { - "tags" : [ "controller-services" ], - "summary" : "Gets a controller service", - "description" : "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", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The controller service id.", - "required" : true, - "type" : "string" - }, { - "name" : "uiOnly", - "in" : "query", - "required" : false, - "type" : "boolean", - "default" : false - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ControllerServiceEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /controller-services/{uuid}" : [ ] - } ] - }, - "put" : { - "tags" : [ "controller-services" ], - "summary" : "Updates a controller service", - "description" : "", - "operationId" : "updateControllerService", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The controller service id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The controller service configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ControllerServiceEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ControllerServiceEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /controller-services/{uuid}" : [ ] - }, { - "Read - any referenced Controller Services if this request changes the reference - /controller-services/{uuid}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "controller-services" ], - "summary" : "Deletes a controller service", - "description" : "", - "operationId" : "removeControllerService", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The revision is used to verify the client is working with the latest version of the flow.", - "required" : false, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The controller service id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ControllerServiceEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /controller-services/{uuid}" : [ ] - }, { - "Write - Parent Process Group if scoped by Process Group - /process-groups/{uuid}" : [ ] - }, { - "Write - Controller if scoped by Controller - /controller" : [ ] - }, { - "Read - any referenced Controller Services - /controller-services/{uuid}" : [ ] - } ] - } - }, - "/controller-services/{id}/config/analysis" : { - "post" : { - "tags" : [ "controller-services" ], - "summary" : "Performs analysis of the component's configuration, providing information about which attributes are referenced.", - "description" : "", - "operationId" : "analyzeConfiguration", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The controller service id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The configuration analysis request.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ConfigurationAnalysisEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/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. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /controller-services/{uuid}" : [ ] - } ] - } - }, - "/controller-services/{id}/config/verification-requests" : { - "post" : { - "tags" : [ "controller-services" ], - "summary" : "Performs verification of the Controller Service's configuration", - "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", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The controller service id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The controller service configuration verification request.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/VerifyConfigRequestEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/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. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /controller-services/{uuid}" : [ ] - } ] - } - }, - "/controller-services/{id}/config/verification-requests/{requestId}" : { - "get" : { - "tags" : [ "controller-services" ], - "summary" : "Returns the Verification Request with the given ID", - "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", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The ID of the Controller Service", - "required" : true, - "type" : "string" - }, { - "name" : "requestId", - "in" : "path", - "description" : "The ID of the Verification Request", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/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. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Only the user that submitted the request can get it" : [ ] - } ] - }, - "delete" : { - "tags" : [ "controller-services" ], - "summary" : "Deletes the Verification Request with the given ID", - "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", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The ID of the Controller Service", - "required" : true, - "type" : "string" - }, { - "name" : "requestId", - "in" : "path", - "description" : "The ID of the Verification Request", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/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. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Only the user that submitted the request can remove it" : [ ] - } ] - } - }, - "/controller-services/{id}/descriptors" : { - "get" : { - "tags" : [ "controller-services" ], - "summary" : "Gets a controller service property descriptor", - "description" : "", - "operationId" : "getPropertyDescriptor", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The controller service id.", - "required" : true, - "type" : "string" - }, { - "name" : "propertyName", - "in" : "query", - "description" : "The property name to return the descriptor for.", - "required" : true, - "type" : "string" - }, { - "name" : "sensitive", - "in" : "query", - "description" : "Property Descriptor requested sensitive status", - "required" : false, - "type" : "boolean", - "default" : false - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/PropertyDescriptorEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /controller-services/{uuid}" : [ ] - } ] - } - }, - "/controller-services/{id}/references" : { - "get" : { - "tags" : [ "controller-services" ], - "summary" : "Gets a controller service", - "description" : "", - "operationId" : "getControllerServiceReferences", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The controller service id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ControllerServiceReferencingComponentsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /controller-services/{uuid}" : [ ] - } ] - }, - "put" : { - "tags" : [ "controller-services" ], - "summary" : "Updates a controller services references", - "description" : "", - "operationId" : "updateControllerServiceReferences", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The controller service id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The controller service request update request.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/UpdateControllerServiceReferenceRequestEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ControllerServiceReferencingComponentsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /{component-type}/{uuid} or /operate/{component-type}/{uuid} - For each referencing component specified" : [ ] - } ] - } - }, - "/controller-services/{id}/run-status" : { - "put" : { - "tags" : [ "controller-services" ], - "summary" : "Updates run status of a controller service", - "description" : "", - "operationId" : "updateRunStatus", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The controller service id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The controller service run status.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ControllerServiceRunStatusEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ControllerServiceEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /controller-services/{uuid} or /operation/controller-services/{uuid}" : [ ] - } ] - } - }, - "/controller-services/{id}/state" : { - "get" : { - "tags" : [ "controller-services" ], - "summary" : "Gets the state for a controller service", - "description" : "", - "operationId" : "getState", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The controller service id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ComponentStateEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /controller-services/{uuid}" : [ ] - } ] - } - }, - "/controller-services/{id}/state/clear-requests" : { - "post" : { - "tags" : [ "controller-services" ], - "summary" : "Clears the state for a controller service", - "description" : "", - "operationId" : "clearState", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The controller service id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ComponentStateEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /controller-services/{uuid}" : [ ] - } ] - } - }, - "/controller/bulletin" : { - "post" : { - "tags" : [ "controller" ], - "summary" : "Creates a new bulletin", - "description" : "", - "operationId" : "createBulletin", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The reporting task configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/BulletinEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /controller" : [ ] - } ] - } - }, - "/controller/cluster" : { - "get" : { - "tags" : [ "controller" ], - "summary" : "Gets the contents of the cluster", - "description" : "Returns the contents of the cluster including all nodes and their status.", - "operationId" : "getCluster", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ClusterEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /controller" : [ ] - } ] - } - }, - "/controller/cluster/nodes/{id}" : { - "get" : { - "tags" : [ "controller" ], - "summary" : "Gets a node in the cluster", - "description" : "", - "operationId" : "getNode", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The node id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/NodeEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /controller" : [ ] - } ] - }, - "put" : { - "tags" : [ "controller" ], - "summary" : "Updates a node in the cluster", - "description" : "", - "operationId" : "updateNode", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The node id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The node configuration. The only configuration that will be honored at this endpoint is the status.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/NodeEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/NodeEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /controller" : [ ] - } ] - }, - "delete" : { - "tags" : [ "controller" ], - "summary" : "Removes a node from the cluster", - "description" : "", - "operationId" : "deleteNode", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The node id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/NodeEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /controller" : [ ] - } ] - } - }, - "/controller/config" : { - "get" : { - "tags" : [ "controller" ], - "summary" : "Retrieves the configuration for this NiFi Controller", - "description" : "", - "operationId" : "getControllerConfig", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ControllerConfigurationEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /controller" : [ ] - } ] - }, - "put" : { - "tags" : [ "controller" ], - "summary" : "Retrieves the configuration for this NiFi", - "description" : "", - "operationId" : "updateControllerConfig", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The controller configuration.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ControllerConfigurationEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ControllerConfigurationEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /controller" : [ ] - } ] - } - }, - "/controller/controller-services" : { - "post" : { - "tags" : [ "controller" ], - "summary" : "Creates a new controller service", - "description" : "", - "operationId" : "createControllerService", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The controller service configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ControllerServiceEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ControllerServiceEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /controller" : [ ] - }, { - "Read - any referenced Controller Services - /controller-services/{uuid}" : [ ] - }, { - "Write - if the Controller Service is restricted - /restricted-components" : [ ] - } ] - } - }, - "/controller/history" : { - "delete" : { - "tags" : [ "controller" ], - "summary" : "Purges history", - "description" : "", - "operationId" : "deleteHistory", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "endDate", - "in" : "query", - "description" : "Purge actions before this date/time.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/HistoryEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /controller" : [ ] - } ] - } - }, - "/controller/parameter-providers" : { - "post" : { - "tags" : [ "controller" ], - "summary" : "Creates a new parameter provider", - "description" : "", - "operationId" : "createParameterProvider", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The parameter provider configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ParameterProviderEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/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. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /controller" : [ ] - }, { - "Read - any referenced Controller Services - /controller-services/{uuid}" : [ ] - }, { - "Write - if the Parameter Provider is restricted - /restricted-components" : [ ] - } ] - } - }, - "/controller/registry-clients" : { - "get" : { - "tags" : [ "controller" ], - "summary" : "Gets the listing of available flow registry clients", - "description" : "", - "operationId" : "getFlowRegistryClients", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/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. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - }, - "post" : { - "tags" : [ "controller" ], - "summary" : "Creates a new flow registry client", - "description" : "", - "operationId" : "createFlowRegistryClient", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The flow registry client configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/FlowRegistryClientEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/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. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /controller" : [ ] - } ] - } - }, - "/controller/registry-clients/{id}" : { - "get" : { - "tags" : [ "controller" ], - "summary" : "Gets a flow registry client", - "description" : "", - "operationId" : "getFlowRegistryClient", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The flow registry client id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/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. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /controller" : [ ] - } ] - }, - "put" : { - "tags" : [ "controller" ], - "summary" : "Updates a flow registry client", - "description" : "", - "operationId" : "updateFlowRegistryClient", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The flow registry client id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The flow registry client configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/FlowRegistryClientEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/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. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /controller" : [ ] - } ] - }, - "delete" : { - "tags" : [ "controller" ], - "summary" : "Deletes a flow registry client", - "description" : "", - "operationId" : "deleteFlowRegistryClient", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The revision is used to verify the client is working with the latest version of the flow.", - "required" : false, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The flow registry client id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/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. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /controller" : [ ] - } ] - } - }, - "/controller/registry-clients/{id}/descriptors" : { - "get" : { - "tags" : [ "controller" ], - "summary" : "Gets a flow registry client property descriptor", - "description" : "", - "operationId" : "getPropertyDescriptor", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The flow registry client id.", - "required" : true, - "type" : "string" - }, { - "name" : "propertyName", - "in" : "query", - "description" : "The property name.", - "required" : true, - "type" : "string" - }, { - "name" : "sensitive", - "in" : "query", - "description" : "Property Descriptor requested sensitive status", - "required" : false, - "type" : "boolean", - "default" : false - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/PropertyDescriptorEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /controller/registry-clients/{uuid}" : [ ] - } ] - } - }, - "/controller/registry-types" : { - "get" : { - "tags" : [ "controller" ], - "summary" : "Retrieves the types of flow that this NiFi supports", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getRegistryClientTypes", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/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. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/controller/reporting-tasks" : { - "post" : { - "tags" : [ "controller" ], - "summary" : "Creates a new reporting task", - "description" : "", - "operationId" : "createReportingTask", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The reporting task configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ReportingTaskEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ReportingTaskEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /controller" : [ ] - }, { - "Read - any referenced Controller Services - /controller-services/{uuid}" : [ ] - }, { - "Write - if the Reporting Task is restricted - /restricted-components" : [ ] - } ] - } - }, - "/controller/status/history" : { - "get" : { - "tags" : [ "controller" ], - "summary" : "Gets status history for the node", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getNodeStatusHistory", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ComponentHistoryEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /controller" : [ ] - } ] - } - }, - "/counters" : { - "get" : { - "tags" : [ "counters" ], - "summary" : "Gets the current counters for this NiFi", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getCounters", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "nodewise", - "in" : "query", - "description" : "Whether or not to include the breakdown per node. Optional, defaults to false", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "clusterNodeId", - "in" : "query", - "description" : "The id of the node where to get the status.", - "required" : false, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/CountersEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /counters" : [ ] - } ] - } - }, - "/counters/{id}" : { - "put" : { - "tags" : [ "counters" ], - "summary" : "Updates the specified counter. This will reset the counter value to 0", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "updateCounter", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The id of the counter.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/CounterEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /counters" : [ ] - } ] - } - }, - "/data-transfer/input-ports/{portId}/transactions/{transactionId}" : { - "put" : { - "tags" : [ "data-transfer" ], - "summary" : "Extend transaction TTL", - "description" : "", - "operationId" : "extendInputPortTransactionTTL", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "portId", - "in" : "path", - "required" : true, - "type" : "string" - }, { - "name" : "transactionId", - "in" : "path", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/TransactionResultEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /data-transfer/input-ports/{uuid}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "data-transfer" ], - "summary" : "Commit or cancel the specified transaction", - "description" : "", - "operationId" : "commitInputPortTransaction", - "consumes" : [ "application/octet-stream" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "responseCode", - "in" : "query", - "description" : "The response code. Available values are BAD_CHECKSUM(19), CONFIRM_TRANSACTION(12) or CANCEL_TRANSACTION(15).", - "required" : true, - "type" : "integer", - "format" : "int32" - }, { - "name" : "portId", - "in" : "path", - "description" : "The input port id.", - "required" : true, - "type" : "string" - }, { - "name" : "transactionId", - "in" : "path", - "description" : "The transaction id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/TransactionResultEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - }, - "503" : { - "description" : "NiFi instance is not ready for serving request, or temporarily overloaded. Retrying the same request later may be successful" - } - }, - "security" : [ { - "Write - /data-transfer/input-ports/{uuid}" : [ ] - } ] - } - }, - "/data-transfer/input-ports/{portId}/transactions/{transactionId}/flow-files" : { - "post" : { - "tags" : [ "data-transfer" ], - "summary" : "Transfer flow files to the input port", - "description" : "", - "operationId" : "receiveFlowFiles", - "consumes" : [ "application/octet-stream" ], - "produces" : [ "text/plain" ], - "parameters" : [ { - "name" : "portId", - "in" : "path", - "description" : "The input port id.", - "required" : true, - "type" : "string" - }, { - "name" : "transactionId", - "in" : "path", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - }, - "503" : { - "description" : "NiFi instance is not ready for serving request, or temporarily overloaded. Retrying the same request later may be successful" - } - }, - "security" : [ { - "Write - /data-transfer/input-ports/{uuid}" : [ ] - } ] - } - }, - "/data-transfer/output-ports/{portId}/transactions/{transactionId}" : { - "put" : { - "tags" : [ "data-transfer" ], - "summary" : "Extend transaction TTL", - "description" : "", - "operationId" : "extendOutputPortTransactionTTL", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "portId", - "in" : "path", - "required" : true, - "type" : "string" - }, { - "name" : "transactionId", - "in" : "path", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/TransactionResultEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - }, - "503" : { - "description" : "NiFi instance is not ready for serving request, or temporarily overloaded. Retrying the same request later may be successful" - } - }, - "security" : [ { - "Write - /data-transfer/output-ports/{uuid}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "data-transfer" ], - "summary" : "Commit or cancel the specified transaction", - "description" : "", - "operationId" : "commitOutputPortTransaction", - "consumes" : [ "application/octet-stream" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "responseCode", - "in" : "query", - "description" : "The response code. Available values are CONFIRM_TRANSACTION(12) or CANCEL_TRANSACTION(15).", - "required" : true, - "type" : "integer", - "format" : "int32" - }, { - "name" : "checksum", - "in" : "query", - "description" : "A checksum calculated at client side using CRC32 to check flow file content integrity. It must match with the value calculated at server side.", - "required" : true, - "type" : "string" - }, { - "name" : "portId", - "in" : "path", - "description" : "The output port id.", - "required" : true, - "type" : "string" - }, { - "name" : "transactionId", - "in" : "path", - "description" : "The transaction id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/TransactionResultEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - }, - "503" : { - "description" : "NiFi instance is not ready for serving request, or temporarily overloaded. Retrying the same request later may be successful" - } - }, - "security" : [ { - "Write - /data-transfer/output-ports/{uuid}" : [ ] - } ] - } - }, - "/data-transfer/output-ports/{portId}/transactions/{transactionId}/flow-files" : { - "get" : { - "tags" : [ "data-transfer" ], - "summary" : "Transfer flow files from the output port", - "description" : "", - "operationId" : "transferFlowFiles", - "consumes" : [ "*/*" ], - "produces" : [ "application/octet-stream" ], - "parameters" : [ { - "name" : "portId", - "in" : "path", - "description" : "The output port id.", - "required" : true, - "type" : "string" - }, { - "name" : "transactionId", - "in" : "path", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "There is no flow file to return.", - "schema" : { - "$ref" : "#/definitions/StreamingOutput" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - }, - "503" : { - "description" : "NiFi instance is not ready for serving request, or temporarily overloaded. Retrying the same request later may be successful" - } - }, - "security" : [ { - "Write - /data-transfer/output-ports/{uuid}" : [ ] - } ] - } - }, - "/data-transfer/{portType}/{portId}/transactions" : { - "post" : { - "tags" : [ "data-transfer" ], - "summary" : "Create a transaction to the specified output port or input port", - "description" : "", - "operationId" : "createPortTransaction", - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "portType", - "in" : "path", - "description" : "The port type.", - "required" : true, - "type" : "string", - "enum" : [ "input-ports", "output-ports" ] - }, { - "name" : "portId", - "in" : "path", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/TransactionResultEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - }, - "503" : { - "description" : "NiFi instance is not ready for serving request, or temporarily overloaded. Retrying the same request later may be successful" - } - }, - "security" : [ { - "Write - /data-transfer/{component-type}/{uuid}" : [ ] - } ] - } - }, - "/flow/about" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Retrieves details about this NiFi to put in the About dialog", - "description" : "", - "operationId" : "getAboutInfo", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/AboutEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/banners" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Retrieves the banners for this NiFi", - "description" : "", - "operationId" : "getBanners", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/BannerEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/bulletin-board" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets current bulletins", - "description" : "", - "operationId" : "getBulletinBoard", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "after", - "in" : "query", - "description" : "Includes bulletins with an id after this value.", - "required" : false, - "type" : "string" - }, { - "name" : "sourceName", - "in" : "query", - "description" : "Includes bulletins originating from this sources whose name match this regular expression.", - "required" : false, - "type" : "string" - }, { - "name" : "message", - "in" : "query", - "description" : "Includes bulletins whose message that match this regular expression.", - "required" : false, - "type" : "string" - }, { - "name" : "sourceId", - "in" : "query", - "description" : "Includes bulletins originating from this sources whose id match this regular expression.", - "required" : false, - "type" : "string" - }, { - "name" : "groupId", - "in" : "query", - "description" : "Includes bulletins originating from this sources whose group id match this regular expression.", - "required" : false, - "type" : "string" - }, { - "name" : "limit", - "in" : "query", - "description" : "The number of bulletins to limit the response to.", - "required" : false, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/BulletinBoardEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - }, { - "Read - /{component-type}/{uuid} - For component specific bulletins" : [ ] - } ] - } - }, - "/flow/client-id" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Generates a client id.", - "description" : "", - "operationId" : "generateClientId", - "consumes" : [ "*/*" ], - "produces" : [ "text/plain" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/cluster/search-results" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Searches the cluster for a node with the specified address", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "searchCluster", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "q", - "in" : "query", - "description" : "Node address to search for.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ClusterSearchResultsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/cluster/summary" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "The cluster summary for this NiFi", - "description" : "", - "operationId" : "getClusterSummary", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ClusteSummaryEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/config" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Retrieves the configuration for this NiFi flow", - "description" : "", - "operationId" : "getFlowConfig", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/FlowConfigurationEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/connections/{id}/statistics" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets statistics for a connection", - "description" : "", - "operationId" : "getConnectionStatistics", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "nodewise", - "in" : "query", - "description" : "Whether or not to include the breakdown per node. Optional, defaults to false", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "clusterNodeId", - "in" : "query", - "description" : "The id of the node where to get the statistics.", - "required" : false, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The connection id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ConnectionStatisticsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/connections/{id}/status" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets status for a connection", - "description" : "", - "operationId" : "getConnectionStatus", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "nodewise", - "in" : "query", - "description" : "Whether or not to include the breakdown per node. Optional, defaults to false", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "clusterNodeId", - "in" : "query", - "description" : "The id of the node where to get the status.", - "required" : false, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The connection id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ConnectionStatusEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/connections/{id}/status/history" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets the status history for a connection", - "description" : "", - "operationId" : "getConnectionStatusHistory", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The connection id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/StatusHistoryEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/controller-service-types" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Retrieves the types of controller services that this NiFi supports", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getControllerServiceTypes", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "serviceType", - "in" : "query", - "description" : "If specified, will only return controller services that are compatible with this type of service.", - "required" : false, - "type" : "string" - }, { - "name" : "serviceBundleGroup", - "in" : "query", - "description" : "If serviceType specified, is the bundle group of the serviceType.", - "required" : false, - "type" : "string" - }, { - "name" : "serviceBundleArtifact", - "in" : "query", - "description" : "If serviceType specified, is the bundle artifact of the serviceType.", - "required" : false, - "type" : "string" - }, { - "name" : "serviceBundleVersion", - "in" : "query", - "description" : "If serviceType specified, is the bundle version of the serviceType.", - "required" : false, - "type" : "string" - }, { - "name" : "bundleGroupFilter", - "in" : "query", - "description" : "If specified, will only return types that are a member of this bundle group.", - "required" : false, - "type" : "string" - }, { - "name" : "bundleArtifactFilter", - "in" : "query", - "description" : "If specified, will only return types that are a member of this bundle artifact.", - "required" : false, - "type" : "string" - }, { - "name" : "typeFilter", - "in" : "query", - "description" : "If specified, will only return types whose fully qualified classname matches.", - "required" : false, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ControllerServiceTypesEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/controller/bulletins" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Retrieves Controller level bulletins", - "description" : "", - "operationId" : "getBulletins", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ControllerBulletinsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - }, { - "Read - /controller - For controller bulletins" : [ ] - }, { - "Read - /controller-services/{uuid} - For controller service bulletins" : [ ] - }, { - "Read - /reporting-tasks/{uuid} - For reporting task bulletins" : [ ] - } ] - } - }, - "/flow/controller/controller-services" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets controller services for reporting tasks", - "description" : "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", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "uiOnly", - "in" : "query", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "includeReferencingComponents", - "in" : "query", - "description" : "Whether or not to include services' referencing components in the response", - "required" : false, - "type" : "boolean", - "default" : true - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ControllerServicesEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/current-user" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Retrieves the user identity of the user making the request", - "description" : "", - "operationId" : "getCurrentUser", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/CurrentUserEntity" - } - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/history" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets configuration history", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "queryHistory", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "offset", - "in" : "query", - "description" : "The offset into the result set.", - "required" : true, - "type" : "string" - }, { - "name" : "count", - "in" : "query", - "description" : "The number of actions to return.", - "required" : true, - "type" : "string" - }, { - "name" : "sortColumn", - "in" : "query", - "description" : "The field to sort on.", - "required" : false, - "type" : "string" - }, { - "name" : "sortOrder", - "in" : "query", - "description" : "The direction to sort.", - "required" : false, - "type" : "string" - }, { - "name" : "startDate", - "in" : "query", - "description" : "Include actions after this date.", - "required" : false, - "type" : "string" - }, { - "name" : "endDate", - "in" : "query", - "description" : "Include actions before this date.", - "required" : false, - "type" : "string" - }, { - "name" : "userIdentity", - "in" : "query", - "description" : "Include actions performed by this user.", - "required" : false, - "type" : "string" - }, { - "name" : "sourceId", - "in" : "query", - "description" : "Include actions on this component.", - "required" : false, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/HistoryEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/history/components/{componentId}" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets configuration history for a component", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getComponentHistory", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "componentId", - "in" : "path", - "description" : "The component id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ComponentHistoryEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - }, { - "Read underlying component - /{component-type}/{uuid}" : [ ] - } ] - } - }, - "/flow/history/{id}" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets an action", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getAction", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The action id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ActionEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/input-ports/{id}/status" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets status for an input port", - "description" : "", - "operationId" : "getInputPortStatus", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "nodewise", - "in" : "query", - "description" : "Whether or not to include the breakdown per node. Optional, defaults to false", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "clusterNodeId", - "in" : "query", - "description" : "The id of the node where to get the status.", - "required" : false, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The input port id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/PortStatusEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/metrics/{producer}" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets all metrics for the flow from a particular node", - "description" : "", - "operationId" : "getFlowMetrics", - "consumes" : [ "*/*" ], - "produces" : [ "*/*" ], - "parameters" : [ { - "name" : "producer", - "in" : "path", - "description" : "The producer for flow file metrics. Each producer may have its own output format.", - "required" : true, - "type" : "string", - "enum" : [ "prometheus" ] - }, { - "name" : "includedRegistries", - "in" : "query", - "description" : "Set of included metrics registries", - "required" : false, - "type" : "array", - "items" : { - "type" : "string", - "enum" : [ "NIFI", "JVM", "BULLETIN", "CONNECTION" ] - }, - "collectionFormat" : "multi" - }, { - "name" : "sampleName", - "in" : "query", - "description" : "Regular Expression Pattern to be applied against the sample name field", - "required" : false, - "type" : "string" - }, { - "name" : "sampleLabelValue", - "in" : "query", - "description" : "Regular Expression Pattern to be applied against the sample label value field", - "required" : false, - "type" : "string" - }, { - "name" : "rootFieldName", - "in" : "query", - "description" : "Name of the first field of JSON object. Applicable for JSON producer only.", - "required" : false, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/StreamingOutput" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/output-ports/{id}/status" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets status for an output port", - "description" : "", - "operationId" : "getOutputPortStatus", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "nodewise", - "in" : "query", - "description" : "Whether or not to include the breakdown per node. Optional, defaults to false", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "clusterNodeId", - "in" : "query", - "description" : "The id of the node where to get the status.", - "required" : false, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The output port id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/PortStatusEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/parameter-contexts" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets all Parameter Contexts", - "description" : "", - "operationId" : "getParameterContexts", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ParameterContextsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /parameter-contexts/{id} for each Parameter Context" : [ ] - } ] - } - }, - "/flow/parameter-provider-types" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Retrieves the types of parameter providers that this NiFi supports", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getParameterProviderTypes", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bundleGroupFilter", - "in" : "query", - "description" : "If specified, will only return types that are a member of this bundle group.", - "required" : false, - "type" : "string" - }, { - "name" : "bundleArtifactFilter", - "in" : "query", - "description" : "If specified, will only return types that are a member of this bundle artifact.", - "required" : false, - "type" : "string" - }, { - "name" : "type", - "in" : "query", - "description" : "If specified, will only return types whose fully qualified classname matches.", - "required" : false, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/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. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/parameter-providers" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets all parameter providers", - "description" : "", - "operationId" : "getParameterProviders", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/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. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/prioritizers" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Retrieves the types of prioritizers that this NiFi supports", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getPrioritizers", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/PrioritizerTypesEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/process-groups/{id}" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets a process group", - "description" : "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", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "name" : "uiOnly", - "in" : "query", - "required" : false, - "type" : "boolean", - "default" : false - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessGroupFlowEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - }, - "put" : { - "tags" : [ "flow" ], - "summary" : "Schedule or unschedule components in the specified Process Group.", - "description" : "", - "operationId" : "scheduleComponents", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The request to schedule or unschedule. If the comopnents in the request are not specified, all authorized components will be considered.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ScheduleComponentsEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ScheduleComponentsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - }, { - "Write - /{component-type}/{uuid} or /operation/{component-type}/{uuid} - For every component being scheduled/unscheduled" : [ ] - } ] - } - }, - "/flow/process-groups/{id}/controller-services" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets all controller services", - "description" : "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", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "name" : "includeAncestorGroups", - "in" : "query", - "description" : "Whether or not to include parent/ancestor process groups", - "required" : false, - "type" : "boolean", - "default" : true - }, { - "name" : "includeDescendantGroups", - "in" : "query", - "description" : "Whether or not to include descendant process groups", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "includeReferencingComponents", - "in" : "query", - "description" : "Whether or not to include services' referencing components in the response", - "required" : false, - "type" : "boolean", - "default" : true - }, { - "name" : "uiOnly", - "in" : "query", - "required" : false, - "type" : "boolean", - "default" : false - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ControllerServicesEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - }, - "put" : { - "tags" : [ "flow" ], - "summary" : "Enable or disable Controller Services in the specified Process Group.", - "description" : "", - "operationId" : "activateControllerServices", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The request to schedule or unschedule. If the comopnents in the request are not specified, all authorized components will be considered.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ActivateControllerServicesEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ActivateControllerServicesEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - }, { - "Write - /{component-type}/{uuid} or /operation/{component-type}/{uuid} - For every service being enabled/disabled" : [ ] - } ] - } - }, - "/flow/process-groups/{id}/status" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets the status for a process group", - "description" : "The status for a process group includes status for all descendent components. When invoked on the root group with recursive set to true, it will return the current status of every component in the flow.", - "operationId" : "getProcessGroupStatus", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "recursive", - "in" : "query", - "description" : "Whether all descendant groups and the status of their content will be included. Optional, defaults to false", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "nodewise", - "in" : "query", - "description" : "Whether or not to include the breakdown per node. Optional, defaults to false", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "clusterNodeId", - "in" : "query", - "description" : "The id of the node where to get the status.", - "required" : false, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessGroupStatusEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/process-groups/{id}/status/history" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets status history for a remote process group", - "description" : "", - "operationId" : "getProcessGroupStatusHistory", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/StatusHistoryEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/processor-types" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Retrieves the types of processors that this NiFi supports", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getProcessorTypes", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bundleGroupFilter", - "in" : "query", - "description" : "If specified, will only return types that are a member of this bundle group.", - "required" : false, - "type" : "string" - }, { - "name" : "bundleArtifactFilter", - "in" : "query", - "description" : "If specified, will only return types that are a member of this bundle artifact.", - "required" : false, - "type" : "string" - }, { - "name" : "type", - "in" : "query", - "description" : "If specified, will only return types whose fully qualified classname matches.", - "required" : false, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessorTypesEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/processors/{id}/status" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets status for a processor", - "description" : "", - "operationId" : "getProcessorStatus", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "nodewise", - "in" : "query", - "description" : "Whether or not to include the breakdown per node. Optional, defaults to false", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "clusterNodeId", - "in" : "query", - "description" : "The id of the node where to get the status.", - "required" : false, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The processor id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessorStatusEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/processors/{id}/status/history" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets status history for a processor", - "description" : "", - "operationId" : "getProcessorStatusHistory", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The processor id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/StatusHistoryEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/registries" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets the listing of available flow registry clients", - "description" : "", - "operationId" : "getRegistryClients", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/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. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/registries/{id}/buckets" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets the buckets from the specified registry for the current user", - "description" : "", - "operationId" : "getBuckets", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The registry id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/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. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/registries/{registry-id}/buckets/{bucket-id}/flows" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets the flows from the specified registry and bucket for the current user", - "description" : "", - "operationId" : "getFlows", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "registry-id", - "in" : "path", - "description" : "The registry client id.", - "required" : true, - "type" : "string" - }, { - "name" : "bucket-id", - "in" : "path", - "description" : "The bucket id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlowsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/registries/{registry-id}/buckets/{bucket-id}/flows/{flow-id}/details" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets the details of a flow from the specified registry and bucket for the specified flow for the current user", - "description" : "", - "operationId" : "getDetails", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "registry-id", - "in" : "path", - "description" : "The registry client id.", - "required" : true, - "type" : "string" - }, { - "name" : "bucket-id", - "in" : "path", - "description" : "The bucket id.", - "required" : true, - "type" : "string" - }, { - "name" : "flow-id", - "in" : "path", - "description" : "The flow id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/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. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/registries/{registry-id}/buckets/{bucket-id}/flows/{flow-id}/versions" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets the flow versions from the specified registry and bucket for the specified flow for the current user", - "description" : "", - "operationId" : "getVersions", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "registry-id", - "in" : "path", - "description" : "The registry client id.", - "required" : true, - "type" : "string" - }, { - "name" : "bucket-id", - "in" : "path", - "description" : "The bucket id.", - "required" : true, - "type" : "string" - }, { - "name" : "flow-id", - "in" : "path", - "description" : "The flow id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlowSnapshotMetadataSetEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/registries/{registry-id}/buckets/{bucket-id}/flows/{flow-id}/{version-a}/diff/{version-b}" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets the differences between two versions of the same versioned flow, the basis of the comparison will be the first version", - "description" : "", - "operationId" : "getVersionDifferences", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "registry-id", - "in" : "path", - "description" : "The registry client id.", - "required" : true, - "type" : "string" - }, { - "name" : "bucket-id", - "in" : "path", - "description" : "The bucket id.", - "required" : true, - "type" : "string" - }, { - "name" : "flow-id", - "in" : "path", - "description" : "The flow id.", - "required" : true, - "type" : "string" - }, { - "name" : "version-a", - "in" : "path", - "description" : "The base version.", - "required" : true, - "type" : "integer", - "format" : "int32" - }, { - "name" : "version-b", - "in" : "path", - "description" : "The compared version.", - "required" : true, - "type" : "integer", - "format" : "int32" - }, { - "name" : "offset", - "in" : "query", - "description" : "Must be a non-negative number. Specifies the starting point of the listing. 0 means start from the beginning.", - "required" : false, - "type" : "integer", - "default" : 0, - "format" : "int32" - }, { - "name" : "limit", - "in" : "query", - "description" : "Limits the number of differences listed. This might lead to partial result. 0 means no limitation is applied.", - "required" : false, - "type" : "integer", - "default" : 1000, - "format" : "int32" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/FlowComparisonEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/remote-process-groups/{id}/status" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets status for a remote process group", - "description" : "", - "operationId" : "getRemoteProcessGroupStatus", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "nodewise", - "in" : "query", - "description" : "Whether or not to include the breakdown per node. Optional, defaults to false", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "clusterNodeId", - "in" : "query", - "description" : "The id of the node where to get the status.", - "required" : false, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The remote process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/RemoteProcessGroupStatusEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/remote-process-groups/{id}/status/history" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets the status history", - "description" : "", - "operationId" : "getRemoteProcessGroupStatusHistory", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The remote process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/StatusHistoryEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/reporting-task-types" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Retrieves the types of reporting tasks that this NiFi supports", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getReportingTaskTypes", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bundleGroupFilter", - "in" : "query", - "description" : "If specified, will only return types that are a member of this bundle group.", - "required" : false, - "type" : "string" - }, { - "name" : "bundleArtifactFilter", - "in" : "query", - "description" : "If specified, will only return types that are a member of this bundle artifact.", - "required" : false, - "type" : "string" - }, { - "name" : "type", - "in" : "query", - "description" : "If specified, will only return types whose fully qualified classname matches.", - "required" : false, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ReportingTaskTypesEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/reporting-tasks" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets all reporting tasks", - "description" : "", - "operationId" : "getReportingTasks", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ReportingTasksEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/reporting-tasks/download" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Download a snapshot of the given reporting tasks and any controller services they use", - "description" : "", - "operationId" : "downloadReportingTaskSnapshot", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "reportingTaskId", - "in" : "query", - "description" : "Specifies a reporting task id to export. If not specified, all reporting tasks will be exported.", - "required" : false, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "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. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/reporting-tasks/snapshot" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Get a snapshot of the given reporting tasks and any controller services they use", - "description" : "", - "operationId" : "getReportingTaskSnapshot", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "reportingTaskId", - "in" : "query", - "description" : "Specifies a reporting task id to export. If not specified, all reporting tasks will be exported.", - "required" : false, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/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. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/runtime-manifest" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Retrieves the runtime manifest for this NiFi instance.", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getRuntimeManifest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/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. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/search-results" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Performs a search against this NiFi using the specified search term", - "description" : "Only search results from authorized components will be returned.", - "operationId" : "searchFlow", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "q", - "in" : "query", - "required" : false, - "type" : "string" - }, { - "name" : "a", - "in" : "query", - "required" : false, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/SearchResultsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/status" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets the current status of this NiFi", - "description" : "", - "operationId" : "getControllerStatus", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ControllerStatusEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/templates" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets all templates", - "description" : "", - "operationId" : "getTemplates", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/TemplatesEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flowfile-queues/{id}/drop-requests" : { - "post" : { - "tags" : [ "flowfile-queues" ], - "summary" : "Creates a request to drop the contents of the queue in this connection.", - "description" : "", - "operationId" : "createDropRequest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The connection id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/DropRequestEntity" - } - }, - "202" : { - "description" : "The request has been accepted. A HTTP response header will contain the URI where the response can be polled." - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write Source Data - /data/{component-type}/{uuid}" : [ ] - } ] - } - }, - "/flowfile-queues/{id}/drop-requests/{drop-request-id}" : { - "get" : { - "tags" : [ "flowfile-queues" ], - "summary" : "Gets the current status of a drop request for the specified connection.", - "description" : "", - "operationId" : "getDropRequest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The connection id.", - "required" : true, - "type" : "string" - }, { - "name" : "drop-request-id", - "in" : "path", - "description" : "The drop request id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/DropRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write Source Data - /data/{component-type}/{uuid}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "flowfile-queues" ], - "summary" : "Cancels and/or removes a request to drop the contents of this connection.", - "description" : "", - "operationId" : "removeDropRequest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The connection id.", - "required" : true, - "type" : "string" - }, { - "name" : "drop-request-id", - "in" : "path", - "description" : "The drop request id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/DropRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write Source Data - /data/{component-type}/{uuid}" : [ ] - } ] - } - }, - "/flowfile-queues/{id}/flowfiles/{flowfile-uuid}" : { - "get" : { - "tags" : [ "flowfile-queues" ], - "summary" : "Gets a FlowFile from a Connection.", - "description" : "", - "operationId" : "getFlowFile", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The connection id.", - "required" : true, - "type" : "string" - }, { - "name" : "flowfile-uuid", - "in" : "path", - "description" : "The flowfile uuid.", - "required" : true, - "type" : "string" - }, { - "name" : "clusterNodeId", - "in" : "query", - "description" : "The id of the node where the content exists if clustered.", - "required" : false, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/FlowFileEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read Source Data - /data/{component-type}/{uuid}" : [ ] - } ] - } - }, - "/flowfile-queues/{id}/flowfiles/{flowfile-uuid}/content" : { - "get" : { - "tags" : [ "flowfile-queues" ], - "summary" : "Gets the content for a FlowFile in a Connection.", - "description" : "", - "operationId" : "downloadFlowFileContent", - "consumes" : [ "*/*" ], - "produces" : [ "*/*" ], - "parameters" : [ { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The connection id.", - "required" : true, - "type" : "string" - }, { - "name" : "flowfile-uuid", - "in" : "path", - "description" : "The flowfile uuid.", - "required" : true, - "type" : "string" - }, { - "name" : "clusterNodeId", - "in" : "query", - "description" : "The id of the node where the content exists if clustered.", - "required" : false, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/StreamingOutput" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read Source Data - /data/{component-type}/{uuid}" : [ ] - } ] - } - }, - "/flowfile-queues/{id}/listing-requests" : { - "post" : { - "tags" : [ "flowfile-queues" ], - "summary" : "Lists the contents of the queue in this connection.", - "description" : "", - "operationId" : "createFlowFileListing", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The connection id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ListingRequestEntity" - } - }, - "202" : { - "description" : "The request has been accepted. A HTTP response header will contain the URI where the response can be polled." - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read Source Data - /data/{component-type}/{uuid}" : [ ] - } ] - } - }, - "/flowfile-queues/{id}/listing-requests/{listing-request-id}" : { - "get" : { - "tags" : [ "flowfile-queues" ], - "summary" : "Gets the current status of a listing request for the specified connection.", - "description" : "", - "operationId" : "getListingRequest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The connection id.", - "required" : true, - "type" : "string" - }, { - "name" : "listing-request-id", - "in" : "path", - "description" : "The listing request id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ListingRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read Source Data - /data/{component-type}/{uuid}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "flowfile-queues" ], - "summary" : "Cancels and/or removes a request to list the contents of this connection.", - "description" : "", - "operationId" : "deleteListingRequest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The connection id.", - "required" : true, - "type" : "string" - }, { - "name" : "listing-request-id", - "in" : "path", - "description" : "The listing request id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ListingRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read Source Data - /data/{component-type}/{uuid}" : [ ] - } ] - } - }, - "/funnels/{id}" : { - "get" : { - "tags" : [ "funnel" ], - "summary" : "Gets a funnel", - "description" : "", - "operationId" : "getFunnel", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The funnel id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/FunnelEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /funnels/{uuid}" : [ ] - } ] - }, - "put" : { - "tags" : [ "funnel" ], - "summary" : "Updates a funnel", - "description" : "", - "operationId" : "updateFunnel", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The funnel id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The funnel configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/FunnelEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/FunnelEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /funnels/{uuid}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "funnel" ], - "summary" : "Deletes a funnel", - "description" : "", - "operationId" : "removeFunnel", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The revision is used to verify the client is working with the latest version of the flow.", - "required" : false, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The funnel id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/FunnelEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /funnels/{uuid}" : [ ] - }, { - "Write - Parent Process Group - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/input-ports/{id}" : { - "get" : { - "tags" : [ "input-ports" ], - "summary" : "Gets an input port", - "description" : "", - "operationId" : "getInputPort", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The input port id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/PortEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /input-ports/{uuid}" : [ ] - } ] - }, - "put" : { - "tags" : [ "input-ports" ], - "summary" : "Updates an input port", - "description" : "", - "operationId" : "updateInputPort", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The input port id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The input port configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/PortEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/PortEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /input-ports/{uuid}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "input-ports" ], - "summary" : "Deletes an input port", - "description" : "", - "operationId" : "removeInputPort", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The revision is used to verify the client is working with the latest version of the flow.", - "required" : false, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The input port id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/PortEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /input-ports/{uuid}" : [ ] - }, { - "Write - Parent Process Group - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/input-ports/{id}/run-status" : { - "put" : { - "tags" : [ "input-ports" ], - "summary" : "Updates run status of an input-port", - "description" : "", - "operationId" : "updateRunStatus", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The port id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The port run status.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/PortRunStatusEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessorEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /input-ports/{uuid} or /operation/input-ports/{uuid}" : [ ] - } ] - } - }, - "/labels/{id}" : { - "get" : { - "tags" : [ "labels" ], - "summary" : "Gets a label", - "description" : "", - "operationId" : "getLabel", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The label id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/LabelEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /labels/{uuid}" : [ ] - } ] - }, - "put" : { - "tags" : [ "labels" ], - "summary" : "Updates a label", - "description" : "", - "operationId" : "updateLabel", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The label id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The label configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/LabelEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/LabelEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /labels/{uuid}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "labels" ], - "summary" : "Deletes a label", - "description" : "", - "operationId" : "removeLabel", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The revision is used to verify the client is working with the latest version of the flow.", - "required" : false, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The label id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/LabelEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /labels/{uuid}" : [ ] - }, { - "Write - Parent Process Group - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/output-ports/{id}" : { - "get" : { - "tags" : [ "output-ports" ], - "summary" : "Gets an output port", - "description" : "", - "operationId" : "getOutputPort", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The output port id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/PortEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /output-ports/{uuid}" : [ ] - } ] - }, - "put" : { - "tags" : [ "output-ports" ], - "summary" : "Updates an output port", - "description" : "", - "operationId" : "updateOutputPort", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The output port id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The output port configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/PortEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/PortEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /output-ports/{uuid}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "output-ports" ], - "summary" : "Deletes an output port", - "description" : "", - "operationId" : "removeOutputPort", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The revision is used to verify the client is working with the latest version of the flow.", - "required" : false, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The output port id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/PortEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /output-ports/{uuid}" : [ ] - }, { - "Write - Parent Process Group - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/output-ports/{id}/run-status" : { - "put" : { - "tags" : [ "output-ports" ], - "summary" : "Updates run status of an output-port", - "description" : "", - "operationId" : "updateRunStatus", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The port id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The port run status.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/PortRunStatusEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessorEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /output-ports/{uuid} or /operation/output-ports/{uuid}" : [ ] - } ] - } - }, - "/parameter-contexts" : { - "post" : { - "tags" : [ "parameter-contexts" ], - "summary" : "Create a Parameter Context", - "description" : "", - "operationId" : "createParameterContext", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The Parameter Context.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ParameterContextEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ParameterContextEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /parameter-contexts" : [ ] - }, { - "Read - for every inherited parameter context" : [ ] - } ] - } - }, - "/parameter-contexts/{contextId}/update-requests" : { - "post" : { - "tags" : [ "parameter-contexts" ], - "summary" : "Initiate the Update Request of a Parameter Context", - "description" : "This will initiate the process of updating a Parameter Context. Changing the value of a Parameter may require that one or more components be stopped and restarted, so this 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", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "contextId", - "in" : "path", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The updated version of the parameter context.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ParameterContextEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ParameterContextUpdateRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /parameter-contexts/{parameterContextId}" : [ ] - }, { - "Write - /parameter-contexts/{parameterContextId}" : [ ] - }, { - "Read - for every component that is affected by the update" : [ ] - }, { - "Write - for every component that is affected by the update" : [ ] - }, { - "Read - for every currently inherited parameter context" : [ ] - }, { - "Read - for any new inherited parameter context" : [ ] - } ] - } - }, - "/parameter-contexts/{contextId}/update-requests/{requestId}" : { - "get" : { - "tags" : [ "parameter-contexts" ], - "summary" : "Returns the Update Request with the given ID", - "description" : "Returns the Update Request with the given ID. Once an Update Request has been created by performing a POST to /nifi-api/parameter-contexts, that request can subsequently be retrieved via this endpoint, and the request that is fetched will contain the updated state, such as percent complete, the current state of the request, and any failures. ", - "operationId" : "getParameterContextUpdate", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "contextId", - "in" : "path", - "description" : "The ID of the Parameter Context", - "required" : true, - "type" : "string" - }, { - "name" : "requestId", - "in" : "path", - "description" : "The ID of the Update Request", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ParameterContextUpdateRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Only the user that submitted the request can get it" : [ ] - } ] - }, - "delete" : { - "tags" : [ "parameter-contexts" ], - "summary" : "Deletes the Update Request with the given ID", - "description" : "Deletes the Update Request with the given ID. After a request is created via a POST to /nifi-api/parameter-contexts/update-requests, it is expected that the client will properly clean up the request by DELETE'ing it, once the Update process has completed. If the request is deleted before the request completes, then the Update request will finish the step that it is currently performing and then will cancel any subsequent steps.", - "operationId" : "deleteUpdateRequest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "contextId", - "in" : "path", - "description" : "The ID of the ParameterContext", - "required" : true, - "type" : "string" - }, { - "name" : "requestId", - "in" : "path", - "description" : "The ID of the Update Request", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ParameterContextUpdateRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Only the user that submitted the request can remove it" : [ ] - } ] - } - }, - "/parameter-contexts/{contextId}/validation-requests" : { - "post" : { - "tags" : [ "parameter-contexts" ], - "summary" : "Initiate a Validation Request to determine how the validity of components will change if a Parameter Context were to be updated", - "description" : "This will initiate the process of validating all components whose Process Group is bound to the specified Parameter Context. Performing validation against an arbitrary number of components may be expect and take significantly more time than many other REST API actions. As a result, this endpoint will immediately return a ParameterContextValidationRequestEntity, and the process of validating the necessary components will occur asynchronously in the background. The client may then periodically poll the status of the request by issuing a GET request to /parameter-contexts/validation-requests/{requestId}. Once the request is completed, the client is expected to issue a DELETE request to /parameter-contexts/validation-requests/{requestId}.", - "operationId" : "submitValidationRequest", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "contextId", - "in" : "path", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The validation request", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ParameterContextValidationRequestEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ParameterContextValidationRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /parameter-contexts/{parameterContextId}" : [ ] - } ] - } - }, - "/parameter-contexts/{contextId}/validation-requests/{id}" : { - "get" : { - "tags" : [ "parameter-contexts" ], - "summary" : "Returns the Validation Request with the given ID", - "description" : "Returns the Validation Request with the given ID. Once a Validation Request has been created by performing a POST to /nifi-api/validation-contexts, that request can subsequently be retrieved via this endpoint, and the request that is fetched will contain the updated state, such as percent complete, the current state of the request, and any failures. ", - "operationId" : "getValidationRequest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "contextId", - "in" : "path", - "description" : "The ID of the Parameter Context", - "required" : true, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The ID of the Validation Request", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ParameterContextValidationRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Only the user that submitted the request can get it" : [ ] - } ] - }, - "delete" : { - "tags" : [ "parameter-contexts" ], - "summary" : "Deletes the Validation Request with the given ID", - "description" : "Deletes the Validation Request with the given ID. After a request is created via a POST to /nifi-api/validation-contexts, it is expected that the client will properly clean up the request by DELETE'ing it, once the validation process has completed. If the request is deleted before the request completes, then the Validation request will finish the step that it is currently performing and then will cancel any subsequent steps.", - "operationId" : "deleteValidationRequest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "contextId", - "in" : "path", - "description" : "The ID of the Parameter Context", - "required" : true, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The ID of the Update Request", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ParameterContextValidationRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Only the user that submitted the request can remove it" : [ ] - } ] - } - }, - "/parameter-contexts/{id}" : { - "get" : { - "tags" : [ "parameter-contexts" ], - "summary" : "Returns the Parameter Context with the given ID", - "description" : "Returns the Parameter Context with the given ID.", - "operationId" : "getParameterContext", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The ID of the Parameter Context", - "required" : true, - "type" : "string" - }, { - "name" : "includeInheritedParameters", - "in" : "query", - "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.", - "required" : false, - "type" : "boolean", - "default" : false - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ParameterContextEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /parameter-contexts/{id}" : [ ] - } ] - }, - "put" : { - "tags" : [ "parameter-contexts" ], - "summary" : "Modifies a Parameter Context", - "description" : "This endpoint will update a Parameter Context to match the provided entity. However, this request will fail if any component is running and is referencing a Parameter in the Parameter Context. Generally, this endpoint is not called directly. Instead, an update request should be submitted by making a POST to the /parameter-contexts/update-requests endpoint. That endpoint will, in turn, call this endpoint.", - "operationId" : "updateParameterContext", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The updated Parameter Context", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ParameterContextEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ParameterContextEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /parameter-contexts/{id}" : [ ] - }, { - "Write - /parameter-contexts/{id}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "parameter-contexts" ], - "summary" : "Deletes the Parameter Context with the given ID", - "description" : "Deletes the Parameter Context with the given ID.", - "operationId" : "deleteParameterContext", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The version is used to verify the client is working with the latest version of the flow.", - "required" : false, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, a new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The Parameter Context ID.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ParameterContextEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /parameter-contexts/{uuid}" : [ ] - }, { - "Write - /parameter-contexts/{uuid}" : [ ] - }, { - "Read - /process-groups/{uuid}, for any Process Group that is currently bound to the Parameter Context" : [ ] - }, { - "Write - /process-groups/{uuid}, for any Process Group that is currently bound to the Parameter Context" : [ ] - } ] - } - }, - "/parameter-providers/{id}" : { - "get" : { - "tags" : [ "parameter-providers" ], - "summary" : "Gets a parameter provider", - "description" : "", - "operationId" : "getParameterProvider", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The parameter provider id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/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. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /parameter-providers/{uuid}" : [ ] - } ] - }, - "put" : { - "tags" : [ "parameter-providers" ], - "summary" : "Updates a parameter provider", - "description" : "", - "operationId" : "updateParameterProvider", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The parameter provider id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The parameter provider configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ParameterProviderEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/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. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /parameter-providers/{uuid}" : [ ] - }, { - "Read - any referenced Controller Services if this request changes the reference - /controller-services/{uuid}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "parameter-providers" ], - "summary" : "Deletes a parameter provider", - "description" : "", - "operationId" : "removeParameterProvider", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The revision is used to verify the client is working with the latest version of the flow.", - "required" : false, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The parameter provider id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/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. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /parameter-providers/{uuid}" : [ ] - }, { - "Write - /controller" : [ ] - }, { - "Read - any referenced Controller Services - /controller-services/{uuid}" : [ ] - } ] - } - }, - "/parameter-providers/{id}/config/analysis" : { - "post" : { - "tags" : [ "parameter-providers" ], - "summary" : "Performs analysis of the component's configuration, providing information about which attributes are referenced.", - "description" : "", - "operationId" : "analyzeConfiguration", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The parameter provider id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The configuration analysis request.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ConfigurationAnalysisEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/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. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /parameter-providers/{uuid}" : [ ] - } ] - } - }, - "/parameter-providers/{id}/config/verification-requests" : { - "post" : { - "tags" : [ "parameter-providers" ], - "summary" : "Performs verification of the Parameter Provider's configuration", - "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", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The parameter provider id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The parameter provider configuration verification request.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/VerifyConfigRequestEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/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. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /parameter-providers/{uuid}" : [ ] - } ] - } - }, - "/parameter-providers/{id}/config/verification-requests/{requestId}" : { - "get" : { - "tags" : [ "parameter-providers" ], - "summary" : "Returns the Verification Request with the given ID", - "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", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The ID of the Parameter Provider", - "required" : true, - "type" : "string" - }, { - "name" : "requestId", - "in" : "path", - "description" : "The ID of the Verification Request", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/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. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Only the user that submitted the request can get it" : [ ] - } ] - }, - "delete" : { - "tags" : [ "parameter-providers" ], - "summary" : "Deletes the Verification Request with the given ID", - "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", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The ID of the Parameter Provider", - "required" : true, - "type" : "string" - }, { - "name" : "requestId", - "in" : "path", - "description" : "The ID of the Verification Request", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/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. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Only the user that submitted the request can remove it" : [ ] - } ] - } - }, - "/parameter-providers/{id}/descriptors" : { - "get" : { - "tags" : [ "parameter-providers" ], - "summary" : "Gets a parameter provider property descriptor", - "description" : "", - "operationId" : "getPropertyDescriptor", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The parameter provider id.", - "required" : true, - "type" : "string" - }, { - "name" : "propertyName", - "in" : "query", - "description" : "The property name.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/PropertyDescriptorEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /parameter-providers/{uuid}" : [ ] - } ] - } - }, - "/parameter-providers/{id}/parameters/fetch-requests" : { - "post" : { - "tags" : [ "parameter-providers" ], - "summary" : "Fetches and temporarily caches the parameters for a provider", - "description" : "", - "operationId" : "fetchParameters", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The parameter provider id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The parameter fetch request.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ParameterProviderParameterFetchEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/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. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /parameter-providers/{uuid} or or /operation/parameter-providers/{uuid}" : [ ] - } ] - } - }, - "/parameter-providers/{id}/references" : { - "get" : { - "tags" : [ "parameter-providers" ], - "summary" : "Gets all references to a parameter provider", - "description" : "", - "operationId" : "getParameterProviderReferences", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The parameter provider id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/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. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /parameter-providers/{uuid}" : [ ] - } ] - } - }, - "/parameter-providers/{id}/state" : { - "get" : { - "tags" : [ "parameter-providers" ], - "summary" : "Gets the state for a parameter provider", - "description" : "", - "operationId" : "getState", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The parameter provider id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ComponentStateEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /parameter-providers/{uuid}" : [ ] - } ] - } - }, - "/parameter-providers/{id}/state/clear-requests" : { - "post" : { - "tags" : [ "parameter-providers" ], - "summary" : "Clears the state for a parameter provider", - "description" : "", - "operationId" : "clearState", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The parameter provider id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ComponentStateEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /parameter-providers/{uuid}" : [ ] - } ] - } - }, - "/parameter-providers/{providerId}/apply-parameters-requests" : { - "post" : { - "tags" : [ "parameter-providers" ], - "summary" : "Initiate a request to apply the fetched parameters of a Parameter Provider", - "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", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "providerId", - "in" : "path", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The apply parameters request.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ParameterProviderParameterApplicationEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/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. Retrying the same request later may be successful." - } - }, - "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" : [ ] - } ] - } - }, - "/parameter-providers/{providerId}/apply-parameters-requests/{requestId}" : { - "get" : { - "tags" : [ "parameter-providers" ], - "summary" : "Returns the Apply Parameters Request with the given ID", - "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", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "providerId", - "in" : "path", - "description" : "The ID of the Parameter Provider", - "required" : true, - "type" : "string" - }, { - "name" : "requestId", - "in" : "path", - "description" : "The ID of the Apply Parameters Request", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/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. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Only the user that submitted the request can get it" : [ ] - } ] - }, - "delete" : { - "tags" : [ "parameter-providers" ], - "summary" : "Deletes the Apply Parameters Request with the given ID", - "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", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "providerId", - "in" : "path", - "description" : "The ID of the Parameter Provider", - "required" : true, - "type" : "string" - }, { - "name" : "requestId", - "in" : "path", - "description" : "The ID of the Apply Parameters Request", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/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. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Only the user that submitted the request can remove it" : [ ] - } ] - } - }, - "/policies" : { - "post" : { - "tags" : [ "policies" ], - "summary" : "Creates an access policy", - "description" : "", - "operationId" : "createAccessPolicy", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The access policy configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/AccessPolicyEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/AccessPolicyEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /policies/{resource}" : [ ] - } ] - } - }, - "/policies/{action}/{resource}" : { - "get" : { - "tags" : [ "policies" ], - "summary" : "Gets an access policy for the specified action and resource", - "description" : "Will return the effective policy if no component specific policy exists for the specified action and resource. Must have Read permissions to the policy with the desired action and resource. Permissions for the policy that is returned will be indicated in the response. This means the client could be authorized to get the policy for a given component but the effective policy may be inherited from an ancestor Process Group. If the client does not have permissions to that policy, the response will not include the policy and the permissions in the response will be marked accordingly. If the client does not have permissions to the policy of the desired action and resource a 403 response will be returned.", - "operationId" : "getAccessPolicyForResource", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "action", - "in" : "path", - "description" : "The request action.", - "required" : true, - "type" : "string", - "enum" : [ "read", "write" ] - }, { - "name" : "resource", - "in" : "path", - "description" : "The resource of the policy.", - "required" : true, - "type" : "string", - "pattern" : ".+" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/AccessPolicyEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /policies/{resource}" : [ ] - } ] - } - }, - "/policies/{id}" : { - "get" : { - "tags" : [ "policies" ], - "summary" : "Gets an access policy", - "description" : "", - "operationId" : "getAccessPolicy", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The access policy id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/AccessPolicyEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /policies/{resource}" : [ ] - } ] - }, - "put" : { - "tags" : [ "policies" ], - "summary" : "Updates a access policy", - "description" : "", - "operationId" : "updateAccessPolicy", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The access policy id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The access policy configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/AccessPolicyEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/AccessPolicyEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /policies/{resource}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "policies" ], - "summary" : "Deletes an access policy", - "description" : "", - "operationId" : "removeAccessPolicy", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The revision is used to verify the client is working with the latest version of the flow.", - "required" : false, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The access policy id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/AccessPolicyEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /policies/{resource}" : [ ] - }, { - "Write - Policy of the parent resource - /policies/{resource}" : [ ] - } ] - } - }, - "/process-groups/replace-requests/{id}" : { - "get" : { - "tags" : [ "process-groups" ], - "summary" : "Returns the Replace Request with the given ID", - "description" : "Returns the Replace Request with the given ID. Once a Replace Request has been created by performing a POST to /process-groups/{id}/replace-requests, that request can subsequently be retrieved via this endpoint, and the request that is fetched will contain the updated state, such as percent complete, the current state of the request, and any failures. Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getReplaceProcessGroupRequest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The ID of the Replace Request", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessGroupReplaceRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Only the user that submitted the request can get it" : [ ] - } ] - }, - "delete" : { - "tags" : [ "process-groups" ], - "summary" : "Deletes the Replace Request with the given ID", - "description" : "Deletes the Replace Request with the given ID. After a request is created via a POST to /process-groups/{id}/replace-requests, it is expected that the client will properly clean up the request by DELETE'ing it, once the Replace process has completed. If the request is deleted before the request completes, then the Replace request will finish the step that it is currently performing and then will cancel any subsequent steps. Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "deleteReplaceProcessGroupRequest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The ID of the Update Request", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessGroupReplaceRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Only the user that submitted the request can remove it" : [ ] - } ] - } - }, - "/process-groups/{groupId}/variable-registry/update-requests/{updateId}" : { - "get" : { - "tags" : [ "process-groups" ], - "summary" : "Gets a process group's variable registry", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getVariableRegistryUpdateRequest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "groupId", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "name" : "updateId", - "in" : "path", - "description" : "The ID of the Variable Registry Update Request", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VariableRegistryUpdateRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "process-groups" ], - "summary" : "Deletes an update request for a process group's variable registry. If the request is not yet complete, it will automatically be cancelled.", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "deleteVariableRegistryUpdateRequest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "groupId", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "name" : "updateId", - "in" : "path", - "description" : "The ID of the Variable Registry Update Request", - "required" : true, - "type" : "string" - }, { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VariableRegistryUpdateRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/process-groups/{id}" : { - "get" : { - "tags" : [ "process-groups" ], - "summary" : "Gets a process group", - "description" : "", - "operationId" : "getProcessGroup", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessGroupEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - } ] - }, - "put" : { - "tags" : [ "process-groups" ], - "summary" : "Updates a process group", - "description" : "", - "operationId" : "updateProcessGroup", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The process group configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ProcessGroupEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessGroupEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "process-groups" ], - "summary" : "Deletes a process group", - "description" : "", - "operationId" : "removeProcessGroup", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The revision is used to verify the client is working with the latest version of the flow.", - "required" : false, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessGroupEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - }, { - "Write - Parent Process Group - /process-groups/{uuid}" : [ ] - }, { - "Read - any referenced Controller Services by any encapsulated components - /controller-services/{uuid}" : [ ] - }, { - "Write - /{component-type}/{uuid} - For all encapsulated components" : [ ] - } ] - } - }, - "/process-groups/{id}/connections" : { - "get" : { - "tags" : [ "process-groups" ], - "summary" : "Gets all connections", - "description" : "", - "operationId" : "getConnections", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ConnectionsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - } ] - }, - "post" : { - "tags" : [ "process-groups" ], - "summary" : "Creates a connection", - "description" : "", - "operationId" : "createConnection", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The connection configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ConnectionEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ConnectionEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - }, { - "Write Source - /{component-type}/{uuid}" : [ ] - }, { - "Write Destination - /{component-type}/{uuid}" : [ ] - } ] - } - }, - "/process-groups/{id}/controller-services" : { - "post" : { - "tags" : [ "process-groups" ], - "summary" : "Creates a new controller service", - "description" : "", - "operationId" : "createControllerService", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The controller service configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ControllerServiceEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ControllerServiceEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - }, { - "Read - any referenced Controller Services - /controller-services/{uuid}" : [ ] - }, { - "Write - if the Controller Service is restricted - /restricted-components" : [ ] - } ] - } - }, - "/process-groups/{id}/download" : { - "get" : { - "tags" : [ "process-groups" ], - "summary" : "Gets a process group for download", - "description" : "", - "operationId" : "exportProcessGroup", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "name" : "includeReferencedServices", - "in" : "query", - "description" : "If referenced services from outside the target group should be included", - "required" : false, - "type" : "boolean", - "default" : false - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/process-groups/{id}/empty-all-connections-requests" : { - "post" : { - "tags" : [ "process-groups" ], - "summary" : "Creates a request to drop all flowfiles of all connection queues in this process group.", - "description" : "", - "operationId" : "createEmptyAllConnectionsRequest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/DropRequestEntity" - } - }, - "202" : { - "description" : "The request has been accepted. An HTTP response header will contain the URI where the status can be polled." - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid} - For this and all encapsulated process groups" : [ ] - }, { - "Write Source Data - /data/{component-type}/{uuid} - For all encapsulated connections" : [ ] - } ] - } - }, - "/process-groups/{id}/empty-all-connections-requests/{drop-request-id}" : { - "get" : { - "tags" : [ "process-groups" ], - "summary" : "Gets the current status of a drop all flowfiles request.", - "description" : "", - "operationId" : "getDropAllFlowfilesRequest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "name" : "drop-request-id", - "in" : "path", - "description" : "The drop request id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/DropRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid} - For this and all encapsulated process groups" : [ ] - }, { - "Write Source Data - /data/{component-type}/{uuid} - For all encapsulated connections" : [ ] - } ] - }, - "delete" : { - "tags" : [ "process-groups" ], - "summary" : "Cancels and/or removes a request to drop all flowfiles.", - "description" : "", - "operationId" : "removeDropRequest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "name" : "drop-request-id", - "in" : "path", - "description" : "The drop request id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/DropRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid} - For this and all encapsulated process groups" : [ ] - }, { - "Write Source Data - /data/{component-type}/{uuid} - For all encapsulated connections" : [ ] - } ] - } - }, - "/process-groups/{id}/flow-contents" : { - "put" : { - "tags" : [ "process-groups" ], - "summary" : "Replace Process Group contents with the given ID with the specified Process Group contents", - "description" : "This endpoint is used for replication within a cluster, when replacing a flow with a new flow. It expects that the flow beingreplaced is not under version control and that the given snapshot will not modify any Processor that is currently running or any Controller Service that is enabled. Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "replaceProcessGroup", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The process group replace request entity.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ProcessGroupImportEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessGroupImportEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - }, { - "Write - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/process-groups/{id}/funnels" : { - "get" : { - "tags" : [ "process-groups" ], - "summary" : "Gets all funnels", - "description" : "", - "operationId" : "getFunnels", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/FunnelsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - } ] - }, - "post" : { - "tags" : [ "process-groups" ], - "summary" : "Creates a funnel", - "description" : "", - "operationId" : "createFunnel", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The funnel configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/FunnelEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/FunnelEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/process-groups/{id}/input-ports" : { - "get" : { - "tags" : [ "process-groups" ], - "summary" : "Gets all input ports", - "description" : "", - "operationId" : "getInputPorts", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/InputPortsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - } ] - }, - "post" : { - "tags" : [ "process-groups" ], - "summary" : "Creates an input port", - "description" : "", - "operationId" : "createInputPort", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The input port configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/PortEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/PortEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/process-groups/{id}/labels" : { - "get" : { - "tags" : [ "process-groups" ], - "summary" : "Gets all labels", - "description" : "", - "operationId" : "getLabels", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/LabelsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - } ] - }, - "post" : { - "tags" : [ "process-groups" ], - "summary" : "Creates a label", - "description" : "", - "operationId" : "createLabel", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The label configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/LabelEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/LabelEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/process-groups/{id}/local-modifications" : { - "get" : { - "tags" : [ "process-groups" ], - "summary" : "Gets a list of local modifications to the Process Group since it was last synchronized with the Flow Registry", - "description" : "", - "operationId" : "getLocalModifications", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/FlowComparisonEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - }, { - "Read - /{component-type}/{uuid} - For all encapsulated components" : [ ] - } ] - } - }, - "/process-groups/{id}/output-ports" : { - "get" : { - "tags" : [ "process-groups" ], - "summary" : "Gets all output ports", - "description" : "", - "operationId" : "getOutputPorts", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/OutputPortsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - } ] - }, - "post" : { - "tags" : [ "process-groups" ], - "summary" : "Creates an output port", - "description" : "", - "operationId" : "createOutputPort", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The output port configuration.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/PortEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/PortEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/process-groups/{id}/process-groups" : { - "get" : { - "tags" : [ "process-groups" ], - "summary" : "Gets all process groups", - "description" : "", - "operationId" : "getProcessGroups", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessGroupsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - } ] - }, - "post" : { - "tags" : [ "process-groups" ], - "summary" : "Creates a process group", - "description" : "", - "operationId" : "createProcessGroup", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The process group configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ProcessGroupEntity" - } - }, { - "name" : "parameterContextHandlingStrategy", - "in" : "query", - "description" : "Handling Strategy controls whether to keep or replace Parameter Contexts", - "required" : false, - "type" : "string", - "default" : "KEEP_EXISTING", - "enum" : [ "KEEP_EXISTING", "REPLACE" ] - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessGroupEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/process-groups/{id}/process-groups/import" : { - "post" : { - "tags" : [ "process-groups" ], - "summary" : "Imports a specified process group", - "description" : "", - "operationId" : "importProcessGroup", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessGroupEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/process-groups/{id}/process-groups/upload" : { - "post" : { - "tags" : [ "process-groups" ], - "summary" : "Uploads a versioned flow definition and creates a process group", - "description" : "", - "operationId" : "uploadProcessGroup", - "consumes" : [ "multipart/form-data" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "name" : "groupName", - "in" : "formData", - "description" : "The process group name.", - "required" : true, - "type" : "string" - }, { - "name" : "positionX", - "in" : "formData", - "description" : "The process group X position.", - "required" : true, - "type" : "number" - }, { - "name" : "positionY", - "in" : "formData", - "description" : "The process group Y position.", - "required" : true, - "type" : "number" - }, { - "name" : "clientId", - "in" : "formData", - "description" : "The client id.", - "required" : true, - "type" : "string" - }, { - "name" : "disconnectedNodeAcknowledged", - "in" : "formData", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "file", - "in" : "formData", - "description" : "The binary content of the versioned flow definition file being uploaded.", - "required" : true, - "type" : "file" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessGroupEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/process-groups/{id}/processors" : { - "get" : { - "tags" : [ "process-groups" ], - "summary" : "Gets all processors", - "description" : "", - "operationId" : "getProcessors", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "name" : "includeDescendantGroups", - "in" : "query", - "description" : "Whether or not to include processors from descendant process groups", - "required" : false, - "type" : "boolean", - "default" : false - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessorsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - } ] - }, - "post" : { - "tags" : [ "process-groups" ], - "summary" : "Creates a new processor", - "description" : "", - "operationId" : "createProcessor", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The processor configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ProcessorEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessorEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - }, { - "Read - any referenced Controller Services - /controller-services/{uuid}" : [ ] - }, { - "Write - if the Processor is restricted - /restricted-components" : [ ] - } ] - } - }, - "/process-groups/{id}/remote-process-groups" : { - "get" : { - "tags" : [ "process-groups" ], - "summary" : "Gets all remote process groups", - "description" : "", - "operationId" : "getRemoteProcessGroups", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/RemoteProcessGroupsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - } ] - }, - "post" : { - "tags" : [ "process-groups" ], - "summary" : "Creates a new process group", - "description" : "", - "operationId" : "createRemoteProcessGroup", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The remote process group configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/RemoteProcessGroupEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/RemoteProcessGroupEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/process-groups/{id}/replace-requests" : { - "post" : { - "tags" : [ "process-groups" ], - "summary" : "Initiate the Replace Request of a Process Group with the given ID", - "description" : "This will initiate the action of replacing a process group with the given process group. This can be a lengthy process, as it will stop any Processors and disable any Controller Services necessary to perform the action and then restart them. As a result, the endpoint will immediately return a ProcessGroupReplaceRequestEntity, and the process of replacing the flow will occur asynchronously in the background. The client may then periodically poll the status of the request by issuing a GET request to /process-groups/replace-requests/{requestId}. Once the request is completed, the client is expected to issue a DELETE request to /process-groups/replace-requests/{requestId}. Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "initiateReplaceProcessGroup", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The process group replace request entity", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ProcessGroupImportEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessGroupReplaceRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - }, { - "Write - /process-groups/{uuid}" : [ ] - }, { - "Read - /{component-type}/{uuid} - For all encapsulated components" : [ ] - }, { - "Write - /{component-type}/{uuid} - For all encapsulated components" : [ ] - }, { - "Write - if the template contains any restricted components - /restricted-components" : [ ] - }, { - "Read - /parameter-contexts/{uuid} - For any Parameter Context that is referenced by a Property that is changed, added, or removed" : [ ] - } ] - } - }, - "/process-groups/{id}/snippet-instance" : { - "post" : { - "tags" : [ "process-groups" ], - "summary" : "Copies a snippet and discards it.", - "description" : "", - "operationId" : "copySnippet", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The copy snippet request.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/CopySnippetRequestEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/FlowEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - }, { - "Read - /{component-type}/{uuid} - For each component in the snippet and their descendant components" : [ ] - }, { - "Write - if the snippet contains any restricted Processors - /restricted-components" : [ ] - } ] - } - }, - "/process-groups/{id}/template-instance" : { - "post" : { - "tags" : [ "process-groups" ], - "summary" : "Instantiates a template", - "description" : "", - "operationId" : "instantiateTemplate", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The instantiate template request.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/InstantiateTemplateRequestEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/FlowEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - }, { - "Read - /templates/{uuid}" : [ ] - }, { - "Write - if the template contains any restricted components - /restricted-components" : [ ] - } ] - } - }, - "/process-groups/{id}/templates" : { - "post" : { - "tags" : [ "process-groups" ], - "summary" : "Creates a template and discards the specified snippet.", - "description" : "", - "operationId" : "createTemplate", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The create template request.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/CreateTemplateRequestEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/TemplateEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - }, { - "Read - /{component-type}/{uuid} - For each component in the snippet and their descendant components" : [ ] - } ] - } - }, - "/process-groups/{id}/templates/import" : { - "post" : { - "tags" : [ "process-groups" ], - "summary" : "Imports a template", - "description" : "", - "operationId" : "importTemplate", - "consumes" : [ "application/xml" ], - "produces" : [ "application/xml" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/TemplateEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/process-groups/{id}/templates/upload" : { - "post" : { - "tags" : [ "process-groups" ], - "summary" : "Uploads a template", - "description" : "", - "operationId" : "uploadTemplate", - "consumes" : [ "multipart/form-data" ], - "produces" : [ "application/xml" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "name" : "disconnectedNodeAcknowledged", - "in" : "formData", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "template", - "in" : "formData", - "description" : "The binary content of the template file being uploaded.", - "required" : true, - "type" : "file" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/TemplateEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/process-groups/{id}/variable-registry" : { - "get" : { - "tags" : [ "process-groups" ], - "summary" : "Gets a process group's variable registry", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getVariableRegistry", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "name" : "includeAncestorGroups", - "in" : "query", - "description" : "Whether or not to include ancestor groups", - "required" : false, - "type" : "boolean", - "default" : true - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VariableRegistryEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - } ] - }, - "put" : { - "tags" : [ "process-groups" ], - "summary" : "Updates the contents of a Process Group's variable Registry", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "updateVariableRegistry", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The variable registry configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/VariableRegistryEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VariableRegistryEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/process-groups/{id}/variable-registry/update-requests" : { - "post" : { - "tags" : [ "process-groups" ], - "summary" : "Submits a request to update a process group's variable registry", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "submitUpdateVariableRegistryRequest", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The variable registry configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/VariableRegistryEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VariableRegistryUpdateRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/processors/run-status-details/queries" : { - "post" : { - "tags" : [ "processors" ], - "summary" : "Submits a query to retrieve the run status details of all processors that are in the given list of Processor IDs", - "description" : "", - "operationId" : "getProcessorRunStatusDetails", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The request for the processors that should be included in the results", - "required" : false, - "schema" : { - "$ref" : "#/definitions/RunStatusDetailsRequestEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessorsRunStatusDetailsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /processors/{uuid} for each processor whose run status information is requested" : [ ] - } ] - } - }, - "/processors/{id}" : { - "get" : { - "tags" : [ "processors" ], - "summary" : "Gets a processor", - "description" : "", - "operationId" : "getProcessor", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The processor id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessorEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /processors/{uuid}" : [ ] - } ] - }, - "put" : { - "tags" : [ "processors" ], - "summary" : "Updates a processor", - "description" : "", - "operationId" : "updateProcessor", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The processor id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The processor configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ProcessorEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessorEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /processors/{uuid}" : [ ] - }, { - "Read - any referenced Controller Services if this request changes the reference - /controller-services/{uuid}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "processors" ], - "summary" : "Deletes a processor", - "description" : "", - "operationId" : "deleteProcessor", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The revision is used to verify the client is working with the latest version of the flow.", - "required" : false, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The processor id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessorEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /processors/{uuid}" : [ ] - }, { - "Write - Parent Process Group - /process-groups/{uuid}" : [ ] - }, { - "Read - any referenced Controller Services - /controller-services/{uuid}" : [ ] - } ] - } - }, - "/processors/{id}/config/analysis" : { - "post" : { - "tags" : [ "processors" ], - "summary" : "Performs analysis of the component's configuration, providing information about which attributes are referenced.", - "description" : "", - "operationId" : "analyzeConfiguration", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The processor id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The processor configuration analysis request.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ConfigurationAnalysisEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/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. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /processors/{uuid}" : [ ] - } ] - } - }, - "/processors/{id}/config/verification-requests" : { - "post" : { - "tags" : [ "processors" ], - "summary" : "Performs verification of the Processor's configuration", - "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", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The processor id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The processor configuration verification request.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/VerifyConfigRequestEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/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. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /processors/{uuid}" : [ ] - } ] - } - }, - "/processors/{id}/config/verification-requests/{requestId}" : { - "get" : { - "tags" : [ "processors" ], - "summary" : "Returns the Verification Request with the given ID", - "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", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The ID of the Processor", - "required" : true, - "type" : "string" - }, { - "name" : "requestId", - "in" : "path", - "description" : "The ID of the Verification Request", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/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. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Only the user that submitted the request can get it" : [ ] - } ] - }, - "delete" : { - "tags" : [ "processors" ], - "summary" : "Deletes the Verification Request with the given ID", - "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", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The ID of the Processor", - "required" : true, - "type" : "string" - }, { - "name" : "requestId", - "in" : "path", - "description" : "The ID of the Verification Request", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/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. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Only the user that submitted the request can remove it" : [ ] - } ] - } - }, - "/processors/{id}/descriptors" : { - "get" : { - "tags" : [ "processors" ], - "summary" : "Gets the descriptor for a processor property", - "description" : "", - "operationId" : "getPropertyDescriptor", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The processor id.", - "required" : true, - "type" : "string" - }, { - "name" : "propertyName", - "in" : "query", - "description" : "The property name.", - "required" : true, - "type" : "string" - }, { - "name" : "sensitive", - "in" : "query", - "description" : "Property Descriptor requested sensitive status", - "required" : false, - "type" : "boolean", - "default" : false - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/PropertyDescriptorEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /processors/{uuid}" : [ ] - } ] - } - }, - "/processors/{id}/diagnostics" : { - "get" : { - "tags" : [ "processors" ], - "summary" : "Gets diagnostics information about a processor", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getProcessorDiagnostics", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The processor id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessorEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /processors/{uuid}" : [ ] - } ] - } - }, - "/processors/{id}/run-status" : { - "put" : { - "tags" : [ "processors" ], - "summary" : "Updates run status of a processor", - "description" : "", - "operationId" : "updateRunStatus", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The processor id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The processor run status.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ProcessorRunStatusEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessorEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /processors/{uuid} or /operation/processors/{uuid}" : [ ] - } ] - } - }, - "/processors/{id}/state" : { - "get" : { - "tags" : [ "processors" ], - "summary" : "Gets the state for a processor", - "description" : "", - "operationId" : "getState", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The processor id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ComponentStateEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /processors/{uuid}" : [ ] - } ] - } - }, - "/processors/{id}/state/clear-requests" : { - "post" : { - "tags" : [ "processors" ], - "summary" : "Clears the state for a processor", - "description" : "", - "operationId" : "clearState", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The processor id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ComponentStateEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /processors/{uuid}" : [ ] - } ] - } - }, - "/processors/{id}/threads" : { - "delete" : { - "tags" : [ "processors" ], - "summary" : "Terminates a processor, essentially \"deleting\" its threads and any active tasks", - "description" : "", - "operationId" : "terminateProcessor", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The processor id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessorEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /processors/{uuid} or /operation/processors/{uuid}" : [ ] - } ] - } - }, - "/provenance" : { - "post" : { - "tags" : [ "provenance" ], - "summary" : "Submits a provenance query", - "description" : "Provenance queries may be long running so this endpoint submits a request. The response will include the current state of the query. If the request is not completed the URI in the response can be used at a later time to get the updated state of the query. Once the query has completed the provenance request should be deleted by the client who originally submitted it.", - "operationId" : "submitProvenanceRequest", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The provenance query details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ProvenanceEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProvenanceEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /provenance" : [ ] - }, { - "Read - /data/{component-type}/{uuid}" : [ ] - } ] - } - }, - "/provenance-events/latest/replays" : { - "post" : { - "tags" : [ "provenance-events" ], - "summary" : "Replays content from a provenance event", - "description" : "", - "operationId" : "submitReplayLatestEvent", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The replay request.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ReplayLastEventRequestEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/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. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read Component Provenance Data - /provenance-data/{component-type}/{uuid}" : [ ] - }, { - "Read Component Data - /data/{component-type}/{uuid}" : [ ] - }, { - "Write Component Data - /data/{component-type}/{uuid}" : [ ] - } ] - } - }, - "/provenance-events/replays" : { - "post" : { - "tags" : [ "provenance-events" ], - "summary" : "Replays content from a provenance event", - "description" : "", - "operationId" : "submitReplay", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The replay request.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/SubmitReplayRequestEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProvenanceEventEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read Component Provenance Data - /provenance-data/{component-type}/{uuid}" : [ ] - }, { - "Read Component Data - /data/{component-type}/{uuid}" : [ ] - }, { - "Write Component Data - /data/{component-type}/{uuid}" : [ ] - } ] - } - }, - "/provenance-events/{id}" : { - "get" : { - "tags" : [ "provenance-events" ], - "summary" : "Gets a provenance event", - "description" : "", - "operationId" : "getProvenanceEvent", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "clusterNodeId", - "in" : "query", - "description" : "The id of the node where this event exists if clustered.", - "required" : false, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The provenance event id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProvenanceEventEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read Component Provenance Data - /provenance-data/{component-type}/{uuid}" : [ ] - } ] - } - }, - "/provenance-events/{id}/content/input" : { - "get" : { - "tags" : [ "provenance-events" ], - "summary" : "Gets the input content for a provenance event", - "description" : "", - "operationId" : "getInputContent", - "consumes" : [ "*/*" ], - "produces" : [ "*/*" ], - "parameters" : [ { - "name" : "clusterNodeId", - "in" : "query", - "description" : "The id of the node where the content exists if clustered.", - "required" : false, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The provenance event id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/StreamingOutput" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read Component Provenance Data - /provenance-data/{component-type}/{uuid}" : [ ] - }, { - "Read Component Data - /data/{component-type}/{uuid}" : [ ] - } ] - } - }, - "/provenance-events/{id}/content/output" : { - "get" : { - "tags" : [ "provenance-events" ], - "summary" : "Gets the output content for a provenance event", - "description" : "", - "operationId" : "getOutputContent", - "consumes" : [ "*/*" ], - "produces" : [ "*/*" ], - "parameters" : [ { - "name" : "clusterNodeId", - "in" : "query", - "description" : "The id of the node where the content exists if clustered.", - "required" : false, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The provenance event id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/StreamingOutput" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read Component Provenance Data - /provenance-data/{component-type}/{uuid}" : [ ] - }, { - "Read Component Data - /data/{component-type}/{uuid}" : [ ] - } ] - } - }, - "/provenance/lineage" : { - "post" : { - "tags" : [ "provenance" ], - "summary" : "Submits a lineage query", - "description" : "Lineage queries may be long running so this endpoint submits a request. The response will include the current state of the query. If the request is not completed the URI in the response can be used at a later time to get the updated state of the query. Once the query has completed the lineage request should be deleted by the client who originally submitted it.", - "operationId" : "submitLineageRequest", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The lineage query details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/LineageEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/LineageEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /provenance" : [ ] - }, { - "Read - /data/{component-type}/{uuid}" : [ ] - } ] - } - }, - "/provenance/lineage/{id}" : { - "get" : { - "tags" : [ "provenance" ], - "summary" : "Gets a lineage query", - "description" : "", - "operationId" : "getLineage", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "clusterNodeId", - "in" : "query", - "description" : "The id of the node where this query exists if clustered.", - "required" : false, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The id of the lineage query.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/LineageEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /provenance" : [ ] - }, { - "Read - /data/{component-type}/{uuid}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "provenance" ], - "summary" : "Deletes a lineage query", - "description" : "", - "operationId" : "deleteLineage", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "clusterNodeId", - "in" : "query", - "description" : "The id of the node where this query exists if clustered.", - "required" : false, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The id of the lineage query.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/LineageEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /provenance" : [ ] - } ] - } - }, - "/provenance/search-options" : { - "get" : { - "tags" : [ "provenance" ], - "summary" : "Gets the searchable attributes for provenance events", - "description" : "", - "operationId" : "getSearchOptions", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProvenanceOptionsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /provenance" : [ ] - } ] - } - }, - "/provenance/{id}" : { - "get" : { - "tags" : [ "provenance" ], - "summary" : "Gets a provenance query", - "description" : "", - "operationId" : "getProvenance", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "clusterNodeId", - "in" : "query", - "description" : "The id of the node where this query exists if clustered.", - "required" : false, - "type" : "string" - }, { - "name" : "summarize", - "in" : "query", - "description" : "Whether or not incremental results are returned. If false, provenance events are only returned once the query completes. This property is true by default.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "incrementalResults", - "in" : "query", - "description" : "Whether or not to summarize provenance events returned. This property is false by default.", - "required" : false, - "type" : "boolean", - "default" : true - }, { - "name" : "id", - "in" : "path", - "description" : "The id of the provenance query.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProvenanceEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /provenance" : [ ] - }, { - "Read - /data/{component-type}/{uuid}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "provenance" ], - "summary" : "Deletes a provenance query", - "description" : "", - "operationId" : "deleteProvenance", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "clusterNodeId", - "in" : "query", - "description" : "The id of the node where this query exists if clustered.", - "required" : false, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The id of the provenance query.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProvenanceEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /provenance" : [ ] - } ] - } - }, - "/remote-process-groups/process-group/{id}/run-status" : { - "put" : { - "tags" : [ "remote-process-groups" ], - "summary" : "Updates run status of all remote process groups in a process group (recursively)", - "description" : "", - "operationId" : "updateRemoteProcessGroupRunStatuses", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The remote process groups run status.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/RemotePortRunStatusEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/RemoteProcessGroupEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /remote-process-groups/{uuid} or /operation/remote-process-groups/{uuid}" : [ ] - } ] - } - }, - "/remote-process-groups/{id}" : { - "get" : { - "tags" : [ "remote-process-groups" ], - "summary" : "Gets a remote process group", - "description" : "", - "operationId" : "getRemoteProcessGroup", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The remote process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/RemoteProcessGroupEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /remote-process-groups/{uuid}" : [ ] - } ] - }, - "put" : { - "tags" : [ "remote-process-groups" ], - "summary" : "Updates a remote process group", - "description" : "", - "operationId" : "updateRemoteProcessGroup", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The remote process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The remote process group.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/RemoteProcessGroupEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/RemoteProcessGroupEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /remote-process-groups/{uuid}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "remote-process-groups" ], - "summary" : "Deletes a remote process group", - "description" : "", - "operationId" : "removeRemoteProcessGroup", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The revision is used to verify the client is working with the latest version of the flow.", - "required" : false, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The remote process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/RemoteProcessGroupEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /remote-process-groups/{uuid}" : [ ] - }, { - "Write - Parent Process Group - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/remote-process-groups/{id}/input-ports/{port-id}" : { - "put" : { - "tags" : [ "remote-process-groups" ], - "summary" : "Updates a remote port", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "updateRemoteProcessGroupInputPort", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The remote process group id.", - "required" : true, - "type" : "string" - }, { - "name" : "port-id", - "in" : "path", - "description" : "The remote process group port id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The remote process group port.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/RemoteProcessGroupPortEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/RemoteProcessGroupPortEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /remote-process-groups/{uuid}" : [ ] - } ] - } - }, - "/remote-process-groups/{id}/input-ports/{port-id}/run-status" : { - "put" : { - "tags" : [ "remote-process-groups" ], - "summary" : "Updates run status of a remote port", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "updateRemoteProcessGroupInputPortRunStatus", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The remote process group id.", - "required" : true, - "type" : "string" - }, { - "name" : "port-id", - "in" : "path", - "description" : "The remote process group port id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The remote process group port.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/RemotePortRunStatusEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/RemoteProcessGroupPortEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /remote-process-groups/{uuid} or /operation/remote-process-groups/{uuid}" : [ ] - } ] - } - }, - "/remote-process-groups/{id}/output-ports/{port-id}" : { - "put" : { - "tags" : [ "remote-process-groups" ], - "summary" : "Updates a remote port", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "updateRemoteProcessGroupOutputPort", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The remote process group id.", - "required" : true, - "type" : "string" - }, { - "name" : "port-id", - "in" : "path", - "description" : "The remote process group port id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The remote process group port.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/RemoteProcessGroupPortEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/RemoteProcessGroupPortEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /remote-process-groups/{uuid}" : [ ] - } ] - } - }, - "/remote-process-groups/{id}/output-ports/{port-id}/run-status" : { - "put" : { - "tags" : [ "remote-process-groups" ], - "summary" : "Updates run status of a remote port", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "updateRemoteProcessGroupOutputPortRunStatus", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The remote process group id.", - "required" : true, - "type" : "string" - }, { - "name" : "port-id", - "in" : "path", - "description" : "The remote process group port id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The remote process group port.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/RemotePortRunStatusEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/RemoteProcessGroupPortEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /remote-process-groups/{uuid} or /operation/remote-process-groups/{uuid}" : [ ] - } ] - } - }, - "/remote-process-groups/{id}/run-status" : { - "put" : { - "tags" : [ "remote-process-groups" ], - "summary" : "Updates run status of a remote process group", - "description" : "", - "operationId" : "updateRemoteProcessGroupRunStatus", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The remote process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The remote process group run status.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/RemotePortRunStatusEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/RemoteProcessGroupEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /remote-process-groups/{uuid} or /operation/remote-process-groups/{uuid}" : [ ] - } ] - } - }, - "/remote-process-groups/{id}/state" : { - "get" : { - "tags" : [ "remote-process-groups" ], - "summary" : "Gets the state for a RemoteProcessGroup", - "description" : "", - "operationId" : "getState", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The processor id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ComponentStateEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /remote-process-groups/{uuid}" : [ ] - } ] - } - }, - "/reporting-tasks/{id}" : { - "get" : { - "tags" : [ "reporting-tasks" ], - "summary" : "Gets a reporting task", - "description" : "", - "operationId" : "getReportingTask", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The reporting task id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ReportingTaskEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /reporting-tasks/{uuid}" : [ ] - } ] - }, - "put" : { - "tags" : [ "reporting-tasks" ], - "summary" : "Updates a reporting task", - "description" : "", - "operationId" : "updateReportingTask", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The reporting task id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The reporting task configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ReportingTaskEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ReportingTaskEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /reporting-tasks/{uuid}" : [ ] - }, { - "Read - any referenced Controller Services if this request changes the reference - /controller-services/{uuid}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "reporting-tasks" ], - "summary" : "Deletes a reporting task", - "description" : "", - "operationId" : "removeReportingTask", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The revision is used to verify the client is working with the latest version of the flow.", - "required" : false, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The reporting task id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ReportingTaskEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /reporting-tasks/{uuid}" : [ ] - }, { - "Write - /controller" : [ ] - }, { - "Read - any referenced Controller Services - /controller-services/{uuid}" : [ ] - } ] - } - }, - "/reporting-tasks/{id}/config/analysis" : { - "post" : { - "tags" : [ "reporting-tasks" ], - "summary" : "Performs analysis of the component's configuration, providing information about which attributes are referenced.", - "description" : "", - "operationId" : "analyzeConfiguration", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The reporting task id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The configuration analysis request.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ConfigurationAnalysisEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/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. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /reporting-tasks/{uuid}" : [ ] - } ] - } - }, - "/reporting-tasks/{id}/config/verification-requests" : { - "post" : { - "tags" : [ "reporting-tasks" ], - "summary" : "Performs verification of the Reporting Task's configuration", - "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", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The reporting task id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The reporting task configuration verification request.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/VerifyConfigRequestEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/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. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /reporting-tasks/{uuid}" : [ ] - } ] - } - }, - "/reporting-tasks/{id}/config/verification-requests/{requestId}" : { - "get" : { - "tags" : [ "reporting-tasks" ], - "summary" : "Returns the Verification Request with the given ID", - "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", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The ID of the Reporting Task", - "required" : true, - "type" : "string" - }, { - "name" : "requestId", - "in" : "path", - "description" : "The ID of the Verification Request", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/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. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Only the user that submitted the request can get it" : [ ] - } ] - }, - "delete" : { - "tags" : [ "reporting-tasks" ], - "summary" : "Deletes the Verification Request with the given ID", - "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", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The ID of the Reporting Task", - "required" : true, - "type" : "string" - }, { - "name" : "requestId", - "in" : "path", - "description" : "The ID of the Verification Request", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/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. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Only the user that submitted the request can remove it" : [ ] - } ] - } - }, - "/reporting-tasks/{id}/descriptors" : { - "get" : { - "tags" : [ "reporting-tasks" ], - "summary" : "Gets a reporting task property descriptor", - "description" : "", - "operationId" : "getPropertyDescriptor", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The reporting task id.", - "required" : true, - "type" : "string" - }, { - "name" : "propertyName", - "in" : "query", - "description" : "The property name.", - "required" : true, - "type" : "string" - }, { - "name" : "sensitive", - "in" : "query", - "description" : "Property Descriptor requested sensitive status", - "required" : false, - "type" : "boolean", - "default" : false - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/PropertyDescriptorEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /reporting-tasks/{uuid}" : [ ] - } ] - } - }, - "/reporting-tasks/{id}/run-status" : { - "put" : { - "tags" : [ "reporting-tasks" ], - "summary" : "Updates run status of a reporting task", - "description" : "", - "operationId" : "updateRunStatus", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The reporting task id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The reporting task run status.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ReportingTaskRunStatusEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ReportingTaskEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /reporting-tasks/{uuid} or or /operation/reporting-tasks/{uuid}" : [ ] - } ] - } - }, - "/reporting-tasks/{id}/state" : { - "get" : { - "tags" : [ "reporting-tasks" ], - "summary" : "Gets the state for a reporting task", - "description" : "", - "operationId" : "getState", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The reporting task id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ComponentStateEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /reporting-tasks/{uuid}" : [ ] - } ] - } - }, - "/reporting-tasks/{id}/state/clear-requests" : { - "post" : { - "tags" : [ "reporting-tasks" ], - "summary" : "Clears the state for a reporting task", - "description" : "", - "operationId" : "clearState", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The reporting task id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ComponentStateEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /reporting-tasks/{uuid}" : [ ] - } ] - } - }, - "/resources" : { - "get" : { - "tags" : [ "resources" ], - "summary" : "Gets the available resources that support access/authorization policies", - "description" : "", - "operationId" : "getResources", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ResourcesEntity" - } - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - } - }, - "security" : [ { - "Read - /resources" : [ ] - } ] - } - }, - "/site-to-site" : { - "get" : { - "tags" : [ "site-to-site" ], - "summary" : "Returns the details about this NiFi necessary to communicate via site to site", - "description" : "", - "operationId" : "getSiteToSiteDetails", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ControllerEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /site-to-site" : [ ] - } ] - } - }, - "/site-to-site/peers" : { - "get" : { - "tags" : [ "site-to-site" ], - "summary" : "Returns the available Peers and its status of this NiFi", - "description" : "", - "operationId" : "getPeers", - "consumes" : [ "*/*" ], - "produces" : [ "application/json", "application/xml" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/PeersEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /site-to-site" : [ ] - } ] - } - }, - "/snippets" : { - "post" : { - "tags" : [ "snippets" ], - "summary" : "Creates a snippet. The snippet will be automatically discarded if not used in a subsequent request after 1 minute.", - "description" : "", - "operationId" : "createSnippet", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The snippet configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/SnippetEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/SnippetEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read or Write - /{component-type}/{uuid} - For every component (all Read or all Write) in the Snippet and their descendant components" : [ ] - } ] - } - }, - "/snippets/{id}" : { - "put" : { - "tags" : [ "snippets" ], - "summary" : "Move's the components in this Snippet into a new Process Group and discards the snippet", - "description" : "", - "operationId" : "updateSnippet", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The snippet id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The snippet configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/SnippetEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/SnippetEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write Process Group - /process-groups/{uuid}" : [ ] - }, { - "Write - /{component-type}/{uuid} - For each component in the Snippet and their descendant components" : [ ] - } ] - }, - "delete" : { - "tags" : [ "snippets" ], - "summary" : "Deletes the components in a snippet and discards the snippet", - "description" : "", - "operationId" : "deleteSnippet", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The snippet id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/SnippetEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /{component-type}/{uuid} - For each component in the Snippet and their descendant components" : [ ] - }, { - "Write - Parent Process Group - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/system-diagnostics" : { - "get" : { - "tags" : [ "system-diagnostics" ], - "summary" : "Gets the diagnostics for the system NiFi is running on", - "description" : "", - "operationId" : "getSystemDiagnostics", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "nodewise", - "in" : "query", - "description" : "Whether or not to include the breakdown per node. Optional, defaults to false", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "clusterNodeId", - "in" : "query", - "description" : "The id of the node where to get the status.", - "required" : false, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/SystemDiagnosticsEntity" - } - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - } - }, - "security" : [ { - "Read - /system" : [ ] - } ] - } - }, - "/system-diagnostics/jmx-metrics" : { - "get" : { - "tags" : [ "system-diagnostics" ], - "summary" : "Retrieve available JMX metrics", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getJmxMetrics", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "beanNameFilter", - "in" : "query", - "description" : "Regular Expression Pattern to be applied against the ObjectName", - "required" : false, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/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. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /system" : [ ] - } ] - } - }, - "/templates/{id}" : { - "delete" : { - "tags" : [ "templates" ], - "summary" : "Deletes a template", - "description" : "", - "operationId" : "removeTemplate", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The template id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/TemplateEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /templates/{uuid}" : [ ] - }, { - "Write - Parent Process Group - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/templates/{id}/download" : { - "get" : { - "tags" : [ "templates" ], - "summary" : "Exports a template", - "description" : "", - "operationId" : "exportTemplate", - "consumes" : [ "*/*" ], - "produces" : [ "application/xml" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The template id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /templates/{uuid}" : [ ] - } ] - } - }, - "/tenants/search-results" : { - "get" : { - "tags" : [ "tenants" ], - "summary" : "Searches for a tenant with the specified identity", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "searchTenants", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "q", - "in" : "query", - "description" : "Identity to search for.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/TenantsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /tenants" : [ ] - } ] - } - }, - "/tenants/user-groups" : { - "get" : { - "tags" : [ "tenants" ], - "summary" : "Gets all user groups", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getUserGroups", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/UserGroupsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /tenants" : [ ] - } ] - }, - "post" : { - "tags" : [ "tenants" ], - "summary" : "Creates a user group", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "createUserGroup", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The user group configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/UserGroupEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/UserGroupEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /tenants" : [ ] - } ] - } - }, - "/tenants/user-groups/{id}" : { - "get" : { - "tags" : [ "tenants" ], - "summary" : "Gets a user group", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getUserGroup", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The user group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/UserGroupEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /tenants" : [ ] - } ] - }, - "put" : { - "tags" : [ "tenants" ], - "summary" : "Updates a user group", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "updateUserGroup", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The user group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The user group configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/UserGroupEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/UserGroupEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /tenants" : [ ] - } ] - }, - "delete" : { - "tags" : [ "tenants" ], - "summary" : "Deletes a user group", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "removeUserGroup", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The revision is used to verify the client is working with the latest version of the flow.", - "required" : false, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The user group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/UserGroupEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /tenants" : [ ] - } ] - } - }, - "/tenants/users" : { - "get" : { - "tags" : [ "tenants" ], - "summary" : "Gets all users", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getUsers", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/UsersEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /tenants" : [ ] - } ] - }, - "post" : { - "tags" : [ "tenants" ], - "summary" : "Creates a user", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "createUser", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The user configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/UserEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/UserEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /tenants" : [ ] - } ] - } - }, - "/tenants/users/{id}" : { - "get" : { - "tags" : [ "tenants" ], - "summary" : "Gets a user", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getUser", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The user id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/UserEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /tenants" : [ ] - } ] - }, - "put" : { - "tags" : [ "tenants" ], - "summary" : "Updates a user", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "updateUser", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The user id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The user configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/UserEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/UserEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /tenants" : [ ] - } ] - }, - "delete" : { - "tags" : [ "tenants" ], - "summary" : "Deletes a user", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "removeUser", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The revision is used to verify the client is working with the latest version of the flow.", - "required" : false, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The user id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/UserEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /tenants" : [ ] - } ] - } - }, - "/versions/active-requests" : { - "post" : { - "tags" : [ "versions" ], - "summary" : "Create a version control request", - "description" : "Creates a request so that a Process Group can be placed under Version Control or have its Version Control configuration changed. Creating this request will prevent any other threads from simultaneously saving local changes to Version Control. It will not, however, actually save the local flow to the Flow Registry. A POST to /versions/process-groups/{id} should be used to initiate saving of the local flow to the Flow Registry. Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "createVersionControlRequest", - "consumes" : [ "application/json" ], - "produces" : [ "text/plain" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The versioned flow details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/CreateActiveRequestEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/versions/active-requests/{id}" : { - "put" : { - "tags" : [ "versions" ], - "summary" : "Updates the request with the given ID", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "updateVersionControlRequest", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The request ID.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The version control component mapping.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/VersionControlComponentMappingEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionControlInformationEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Only the user that submitted the request can update it" : [ ] - } ] - }, - "delete" : { - "tags" : [ "versions" ], - "summary" : "Deletes the version control request with the given ID", - "description" : "Deletes the Version Control Request with the given ID. This will allow other threads to save flows to the Flow Registry. See also the documentation for POSTing to /versions/active-requests for information regarding why this is done. Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "deleteVersionControlRequest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The request ID.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Only the user that submitted the request can remove it" : [ ] - } ] - } - }, - "/versions/process-groups/{id}" : { - "get" : { - "tags" : [ "versions" ], - "summary" : "Gets the Version Control information for a process group", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getVersionInformation", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionControlInformationEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - } ] - }, - "post" : { - "tags" : [ "versions" ], - "summary" : "Save the Process Group with the given ID", - "description" : "Begins version controlling the Process Group with the given ID or commits changes to the Versioned Flow, depending on if the provided VersionControlInformation includes a flowId. Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "saveToFlowRegistry", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The versioned flow details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/StartVersionControlRequestEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionControlInformationEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - }, { - "Write - /process-groups/{uuid}" : [ ] - }, { - "Read - /{component-type}/{uuid} - For all encapsulated components" : [ ] - }, { - "Read - any referenced Controller Services by any encapsulated components - /controller-services/{uuid}" : [ ] - } ] - }, - "put" : { - "tags" : [ "versions" ], - "summary" : "Update the version of a Process Group with the given ID", - "description" : "For a Process Group that is already under Version Control, this will update the version of the flow to a different version. This endpoint expects that the given snapshot will not modify any Processor that is currently running or any Controller Service that is enabled. Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "updateFlowVersion", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The controller service configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/VersionedFlowSnapshotEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionControlInformationEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - }, { - "Write - /process-groups/{uuid}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "versions" ], - "summary" : "Stops version controlling the Process Group with the given ID", - "description" : "Stops version controlling the Process Group with the given ID. The Process Group will no longer track to any Versioned Flow. Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "stopVersionControl", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The version is used to verify the client is working with the latest version of the flow.", - "required" : false, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, a new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionControlInformationEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - }, { - "Write - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/versions/process-groups/{id}/download" : { - "get" : { - "tags" : [ "versions" ], - "summary" : "Gets the latest version of a Process Group for download", - "description" : "", - "operationId" : "exportFlowVersion", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/versions/revert-requests/process-groups/{id}" : { - "post" : { - "tags" : [ "versions" ], - "summary" : "Initiate the Revert Request of a Process Group with the given ID", - "description" : "For a Process Group that is already under Version Control, this will initiate the action of reverting any local changes that have been made to the Process Group since it was last synchronized with the Flow Registry. This will result in the flow matching the Versioned Flow that exists in the Flow Registry. This can be a lengthy process, as it will stop any Processors and disable any Controller Services necessary to perform the action and then restart them. As a result, the endpoint will immediately return a VersionedFlowUpdateRequestEntity, and the process of updating the flow will occur asynchronously in the background. The client may then periodically poll the status of the request by issuing a GET request to /versions/revert-requests/{requestId}. Once the request is completed, the client is expected to issue a DELETE request to /versions/revert-requests/{requestId}. Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "initiateRevertFlowVersion", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The Version Control Information to revert to.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/VersionControlInformationEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlowUpdateRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - }, { - "Write - /process-groups/{uuid}" : [ ] - }, { - "Read - /{component-type}/{uuid} - For all encapsulated components" : [ ] - }, { - "Write - /{component-type}/{uuid} - For all encapsulated components" : [ ] - }, { - "Write - if the template contains any restricted components - /restricted-components" : [ ] - }, { - "Read - /parameter-contexts/{uuid} - For any Parameter Context that is referenced by a Property that is changed, added, or removed" : [ ] - } ] - } - }, - "/versions/revert-requests/{id}" : { - "get" : { - "tags" : [ "versions" ], - "summary" : "Returns the Revert Request with the given ID", - "description" : "Returns the Revert Request with the given ID. Once a Revert Request has been created by performing a POST to /versions/revert-requests/process-groups/{id}, that request can subsequently be retrieved via this endpoint, and the request that is fetched will contain the updated state, such as percent complete, the current state of the request, and any failures. Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getRevertRequest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The ID of the Revert Request", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlowUpdateRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Only the user that submitted the request can get it" : [ ] - } ] - }, - "delete" : { - "tags" : [ "versions" ], - "summary" : "Deletes the Revert Request with the given ID", - "description" : "Deletes the Revert Request with the given ID. After a request is created via a POST to /versions/revert-requests/process-groups/{id}, it is expected that the client will properly clean up the request by DELETE'ing it, once the Revert process has completed. If the request is deleted before the request completes, then the Revert request will finish the step that it is currently performing and then will cancel any subsequent steps. Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "deleteRevertRequest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The ID of the Revert Request", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlowUpdateRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Only the user that submitted the request can remove it" : [ ] - } ] - } - }, - "/versions/update-requests/process-groups/{id}" : { - "post" : { - "tags" : [ "versions" ], - "summary" : "Initiate the Update Request of a Process Group with the given ID", - "description" : "For a Process Group that is already under Version Control, this will initiate the action of changing from a specific version of the flow in the Flow Registry to a different version of the flow. This can be a lengthy process, as it will stop any Processors and disable any Controller Services necessary to perform the action and then restart them. As a result, the endpoint will immediately return a VersionedFlowUpdateRequestEntity, and the process of updating the flow will occur asynchronously in the background. The client may then periodically poll the status of the request by issuing a GET request to /versions/update-requests/{requestId}. Once the request is completed, the client is expected to issue a DELETE request to /versions/update-requests/{requestId}. Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "initiateVersionControlUpdate", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The controller service configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/VersionControlInformationEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlowUpdateRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - }, { - "Write - /process-groups/{uuid}" : [ ] - }, { - "Read - /{component-type}/{uuid} - For all encapsulated components" : [ ] - }, { - "Write - /{component-type}/{uuid} - For all encapsulated components" : [ ] - }, { - "Write - if the template contains any restricted components - /restricted-components" : [ ] - }, { - "Read - /parameter-contexts/{uuid} - For any Parameter Context that is referenced by a Property that is changed, added, or removed" : [ ] - } ] - } - }, - "/versions/update-requests/{id}" : { - "get" : { - "tags" : [ "versions" ], - "summary" : "Returns the Update Request with the given ID", - "description" : "Returns the Update Request with the given ID. Once an Update Request has been created by performing a POST to /versions/update-requests/process-groups/{id}, that request can subsequently be retrieved via this endpoint, and the request that is fetched will contain the updated state, such as percent complete, the current state of the request, and any failures. Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getUpdateRequest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The ID of the Update Request", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlowUpdateRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Only the user that submitted the request can get it" : [ ] - } ] - }, - "delete" : { - "tags" : [ "versions" ], - "summary" : "Deletes the Update Request with the given ID", - "description" : "Deletes the Update Request with the given ID. After a request is created via a POST to /versions/update-requests/process-groups/{id}, it is expected that the client will properly clean up the request by DELETE'ing it, once the Update process has completed. If the request is deleted before the request completes, then the Update request will finish the step that it is currently performing and then will cancel any subsequent steps. Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "deleteUpdateRequest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The ID of the Update Request", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlowUpdateRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Only the user that submitted the request can remove it" : [ ] - } ] - } - } - }, - "definitions" : { - "AboutDTO" : { - "type" : "object", - "properties" : { - "title" : { - "type" : "string", - "description" : "The title to be used on the page and in the about dialog." - }, - "version" : { - "type" : "string", - "description" : "The version of this NiFi." - }, - "uri" : { - "type" : "string", - "description" : "The URI for the NiFi." - }, - "contentViewerUrl" : { - "type" : "string", - "description" : "The URL for the content viewer if configured." - }, - "timezone" : { - "type" : "string", - "description" : "The timezone of the NiFi instance.", - "readOnly" : true - }, - "buildTag" : { - "type" : "string", - "description" : "Build tag" - }, - "buildRevision" : { - "type" : "string", - "description" : "Build revision or commit hash" - }, - "buildBranch" : { - "type" : "string", - "description" : "Build branch" - }, - "buildTimestamp" : { - "type" : "string", - "description" : "Build timestamp" - } - } - }, - "AboutEntity" : { - "type" : "object", - "properties" : { - "about" : { - "$ref" : "#/definitions/AboutDTO" - } - }, - "xml" : { - "name" : "aboutEntity" - } - }, - "AccessConfigurationDTO" : { - "type" : "object", - "properties" : { - "supportsLogin" : { - "type" : "boolean", - "description" : "Indicates whether or not this NiFi supports user login.", - "readOnly" : true - } - } - }, - "AccessConfigurationEntity" : { - "type" : "object", - "properties" : { - "config" : { - "$ref" : "#/definitions/AccessConfigurationDTO" - } - }, - "xml" : { - "name" : "accessConfigurationEntity" - } - }, - "AccessPolicyDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "versionedComponentId" : { - "type" : "string", - "description" : "The ID of the corresponding component that is under version control" - }, - "parentGroupId" : { - "type" : "string", - "description" : "The id of parent process group of this component if applicable." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "resource" : { - "type" : "string", - "description" : "The resource for this access policy." - }, - "action" : { - "type" : "string", - "description" : "The action associated with this access policy.", - "enum" : [ "read", "write" ] - }, - "componentReference" : { - "description" : "Component this policy references if applicable.", - "$ref" : "#/definitions/ComponentReferenceEntity" - }, - "configurable" : { - "type" : "boolean", - "description" : "Whether this policy is configurable." - }, - "users" : { - "type" : "array", - "description" : "The set of user IDs associated with this access policy.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/TenantEntity" - } - }, - "userGroups" : { - "type" : "array", - "description" : "The set of user group IDs associated with this access policy.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/TenantEntity" - } - } - } - }, - "AccessPolicyEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "generated" : { - "type" : "string", - "description" : "When this content was generated." - }, - "component" : { - "$ref" : "#/definitions/AccessPolicyDTO" - } - }, - "xml" : { - "name" : "accessPolicyEntity" - } - }, - "AccessPolicySummaryDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "versionedComponentId" : { - "type" : "string", - "description" : "The ID of the corresponding component that is under version control" - }, - "parentGroupId" : { - "type" : "string", - "description" : "The id of parent process group of this component if applicable." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "resource" : { - "type" : "string", - "description" : "The resource for this access policy." - }, - "action" : { - "type" : "string", - "description" : "The action associated with this access policy.", - "enum" : [ "read", "write" ] - }, - "componentReference" : { - "description" : "Component this policy references if applicable.", - "$ref" : "#/definitions/ComponentReferenceEntity" - }, - "configurable" : { - "type" : "boolean", - "description" : "Whether this policy is configurable." - } - } - }, - "AccessPolicySummaryEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "component" : { - "$ref" : "#/definitions/AccessPolicySummaryDTO" - } - }, - "xml" : { - "name" : "accessPolicySummaryEntity" - } - }, - "AccessStatusDTO" : { - "type" : "object", - "properties" : { - "identity" : { - "type" : "string", - "description" : "The user identity.", - "readOnly" : true - }, - "status" : { - "type" : "string", - "description" : "The user access status.", - "readOnly" : true - }, - "message" : { - "type" : "string", - "description" : "Additional details about the user access status.", - "readOnly" : true - } - }, - "xml" : { - "name" : "accessStatus" - } - }, - "AccessStatusEntity" : { - "type" : "object", - "properties" : { - "accessStatus" : { - "$ref" : "#/definitions/AccessStatusDTO" - } - }, - "xml" : { - "name" : "accessStatusEntity" - } - }, - "AccessTokenExpirationDTO" : { - "type" : "object", - "properties" : { - "expiration" : { - "type" : "string", - "description" : "Token Expiration", - "readOnly" : true - } - }, - "xml" : { - "name" : "accessTokenExpiration" - } - }, - "AccessTokenExpirationEntity" : { - "type" : "object", - "properties" : { - "accessTokenExpiration" : { - "$ref" : "#/definitions/AccessTokenExpirationDTO" - } - }, - "xml" : { - "name" : "accessTokenExpirationEntity" - } - }, - "ActionDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "integer", - "format" : "int32", - "description" : "The action id." - }, - "userIdentity" : { - "type" : "string", - "description" : "The identity of the user that performed the action." - }, - "timestamp" : { - "type" : "string", - "description" : "The timestamp of the action." - }, - "sourceId" : { - "type" : "string", - "description" : "The id of the source component." - }, - "sourceName" : { - "type" : "string", - "description" : "The name of the source component." - }, - "sourceType" : { - "type" : "string", - "description" : "The type of the source component." - }, - "componentDetails" : { - "description" : "The details of the source component.", - "$ref" : "#/definitions/ComponentDetailsDTO" - }, - "operation" : { - "type" : "string", - "description" : "The operation that was performed." - }, - "actionDetails" : { - "description" : "The details of the action.", - "$ref" : "#/definitions/ActionDetailsDTO" - } - } - }, - "ActionDetailsDTO" : { - "type" : "object" - }, - "ActionEntity" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "integer", - "format" : "int32" - }, - "timestamp" : { - "type" : "string", - "description" : "The timestamp of the action." - }, - "sourceId" : { - "type" : "string" - }, - "canRead" : { - "type" : "boolean", - "description" : "Indicates whether the user can read a given resource.", - "readOnly" : true - }, - "action" : { - "$ref" : "#/definitions/ActionDTO" - } - }, - "xml" : { - "name" : "actionEntity" - } - }, - "ActivateControllerServicesEntity" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the ProcessGroup" - }, - "state" : { - "type" : "string", - "description" : "The desired state of the descendant components", - "enum" : [ "ENABLED", "DISABLED" ] - }, - "components" : { - "type" : "object", - "description" : "Optional services to schedule. If not specified, all authorized descendant controller services will be used.", - "additionalProperties" : { - "$ref" : "#/definitions/RevisionDTO" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - } - }, - "xml" : { - "name" : "activateControllerServicesEntity" - } - }, - "AffectedComponentDTO" : { - "type" : "object", - "properties" : { - "processGroupId" : { - "type" : "string", - "description" : "The UUID of the Process Group that this component is in" - }, - "id" : { - "type" : "string", - "description" : "The UUID of this component" - }, - "referenceType" : { - "type" : "string", - "description" : "The type of this component", - "enum" : [ "PROCESSOR", "CONTROLLER_SERVICE", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT" ] - }, - "name" : { - "type" : "string", - "description" : "The name of this component." - }, - "state" : { - "type" : "string", - "description" : "The scheduled state of a processor or reporting task referencing a controller service. If this component is another controller service, this field represents the controller service state." - }, - "activeThreadCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of active threads for the referencing component." - }, - "validationErrors" : { - "type" : "array", - "description" : "The validation errors for the component.", - "items" : { - "type" : "string" - } - } - } - }, - "AffectedComponentEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "component" : { - "$ref" : "#/definitions/AffectedComponentDTO" - }, - "processGroup" : { - "description" : "The Process Group that the component belongs to", - "$ref" : "#/definitions/ProcessGroupNameDTO" - }, - "referenceType" : { - "type" : "string", - "description" : "The type of component referenced", - "enum" : [ "PROCESSOR", "CONTROLLER_SERVICE", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT" ] - } - }, - "xml" : { - "name" : "affectedComponentEntity" - } - }, - "AllowableValueDTO" : { - "type" : "object", - "properties" : { - "displayName" : { - "type" : "string", - "description" : "A human readable value that is allowed for the property descriptor." - }, - "value" : { - "type" : "string", - "description" : "A value that is allowed for the property descriptor." - }, - "description" : { - "type" : "string", - "description" : "A description for this allowable value." - } - } - }, - "AllowableValueEntity" : { - "type" : "object", - "properties" : { - "allowableValue" : { - "$ref" : "#/definitions/AllowableValueDTO" - }, - "canRead" : { - "type" : "boolean", - "description" : "Indicates whether the user can read a given resource.", - "readOnly" : true - } - }, - "xml" : { - "name" : "entity" - } - }, - "Attribute" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The name of the attribute" - }, - "description" : { - "type" : "string", - "description" : "The description of the attribute" - } - } - }, - "AttributeDTO" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The attribute name." - }, - "value" : { - "type" : "string", - "description" : "The attribute value." - }, - "previousValue" : { - "type" : "string", - "description" : "The value of the attribute before the event took place." - } - } - }, - "BannerDTO" : { - "type" : "object", - "properties" : { - "headerText" : { - "type" : "string", - "description" : "The header text." - }, - "footerText" : { - "type" : "string", - "description" : "The footer text." - } - } - }, - "BannerEntity" : { - "type" : "object", - "properties" : { - "banners" : { - "$ref" : "#/definitions/BannerDTO" - } - }, - "xml" : { - "name" : "bannersEntity" - } - }, - "BatchSettingsDTO" : { - "type" : "object", - "properties" : { - "count" : { - "type" : "integer", - "format" : "int32", - "description" : "Preferred number of flow files to include in a transaction." - }, - "size" : { - "type" : "string", - "description" : "Preferred number of bytes to include in a transaction." - }, - "duration" : { - "type" : "string", - "description" : "Preferred amount of time that a transaction should span." - } - } - }, - "BatchSize" : { - "type" : "object", - "properties" : { - "count" : { - "type" : "integer", - "format" : "int32", - "description" : "Preferred number of flow files to include in a transaction." - }, - "size" : { - "type" : "string", - "description" : "Preferred number of bytes to include in a transaction." - }, - "duration" : { - "type" : "string", - "description" : "Preferred amount of time that a transaction should span." - } - } - }, - "BuildInfo" : { - "type" : "object", - "properties" : { - "version" : { - "type" : "string", - "description" : "The version number of the built component." - }, - "revision" : { - "type" : "string", - "description" : "The SCM revision id of the source code used for this build." - }, - "timestamp" : { - "type" : "integer", - "format" : "int64", - "description" : "The timestamp (milliseconds since Epoch) of the build." - }, - "targetArch" : { - "type" : "string", - "description" : "The target architecture of the built component." - }, - "compiler" : { - "type" : "string", - "description" : "The compiler used for the build" - }, - "compilerFlags" : { - "type" : "string", - "description" : "The compiler flags used for the build." - } - } - }, - "BulletinBoardDTO" : { - "type" : "object", - "properties" : { - "bulletins" : { - "type" : "array", - "description" : "The bulletins in the bulletin board, that matches the supplied request.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "generated" : { - "type" : "string", - "description" : "The timestamp when this report was generated." - } - } - }, - "BulletinBoardEntity" : { - "type" : "object", - "properties" : { - "bulletinBoard" : { - "$ref" : "#/definitions/BulletinBoardDTO" - } - }, - "xml" : { - "name" : "bulletinBoardEntity" - } - }, - "BulletinDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "integer", - "format" : "int64", - "description" : "The id of the bulletin." - }, - "nodeAddress" : { - "type" : "string", - "description" : "If clustered, the address of the node from which the bulletin originated." - }, - "category" : { - "type" : "string", - "description" : "The category of this bulletin." - }, - "groupId" : { - "type" : "string", - "description" : "The group id of the source component." - }, - "sourceId" : { - "type" : "string", - "description" : "The id of the source component." - }, - "sourceName" : { - "type" : "string", - "description" : "The name of the source component." - }, - "level" : { - "type" : "string", - "description" : "The level of the bulletin." - }, - "message" : { - "type" : "string", - "description" : "The bulletin message." - }, - "timestamp" : { - "type" : "string", - "description" : "When this bulletin was generated." - } - } - }, - "BulletinEntity" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "integer", - "format" : "int64" - }, - "groupId" : { - "type" : "string" - }, - "sourceId" : { - "type" : "string" - }, - "timestamp" : { - "type" : "string", - "description" : "When this bulletin was generated." - }, - "nodeAddress" : { - "type" : "string" - }, - "canRead" : { - "type" : "boolean", - "description" : "Indicates whether the user can read a given resource.", - "readOnly" : true - }, - "bulletin" : { - "$ref" : "#/definitions/BulletinDTO" - } - }, - "xml" : { - "name" : "bulletinEntity" - } - }, - "Bundle" : { - "type" : "object", - "properties" : { - "group" : { - "type" : "string", - "description" : "The group of the bundle" - }, - "artifact" : { - "type" : "string", - "description" : "The artifact of the bundle" - }, - "version" : { - "type" : "string", - "description" : "The version of the bundle" - } - } - }, - "BundleDTO" : { - "type" : "object", - "properties" : { - "group" : { - "type" : "string", - "description" : "The group of the bundle." - }, - "artifact" : { - "type" : "string", - "description" : "The artifact of the bundle." - }, - "version" : { - "type" : "string", - "description" : "The version of the bundle." - } - } - }, - "ClassLoaderDiagnosticsDTO" : { - "type" : "object", - "properties" : { - "bundle" : { - "description" : "Information about the Bundle that the ClassLoader belongs to, if any", - "$ref" : "#/definitions/BundleDTO" - }, - "parentClassLoader" : { - "description" : "A ClassLoaderDiagnosticsDTO that provides information about the parent ClassLoader", - "$ref" : "#/definitions/ClassLoaderDiagnosticsDTO" - } - } - }, - "ClusteSummaryEntity" : { - "type" : "object", - "properties" : { - "clusterSummary" : { - "$ref" : "#/definitions/ClusterSummaryDTO" - } - }, - "xml" : { - "name" : "clusterSummaryEntity" - } - }, - "ClusterDTO" : { - "type" : "object", - "properties" : { - "nodes" : { - "type" : "array", - "description" : "The collection of nodes that are part of the cluster.", - "items" : { - "$ref" : "#/definitions/NodeDTO" - } - }, - "generated" : { - "type" : "string", - "description" : "The timestamp the report was generated." - } - } - }, - "ClusterEntity" : { - "type" : "object", - "properties" : { - "cluster" : { - "$ref" : "#/definitions/ClusterDTO" - } - }, - "xml" : { - "name" : "clusterEntity" - } - }, - "ClusterSearchResultsEntity" : { - "type" : "object", - "properties" : { - "nodeResults" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/NodeSearchResultDTO" - } - } - }, - "xml" : { - "name" : "clusterSearchResultsEntity" - } - }, - "ClusterSummaryDTO" : { - "type" : "object", - "properties" : { - "connectedNodes" : { - "type" : "string", - "description" : "When clustered, reports the number of nodes connected vs the number of nodes in the cluster." - }, - "connectedNodeCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of nodes that are currently connected to the cluster" - }, - "totalNodeCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of nodes in the cluster, regardless of whether or not they are connected" - }, - "connectedToCluster" : { - "type" : "boolean", - "description" : "Whether this NiFi instance is connected to a cluster." - }, - "clustered" : { - "type" : "boolean", - "description" : "Whether this NiFi instance is clustered." - } - } - }, - "ComponentDetailsDTO" : { - "type" : "object" - }, - "ComponentDifferenceDTO" : { - "type" : "object", - "properties" : { - "componentType" : { - "type" : "string", - "description" : "The type of component" - }, - "componentId" : { - "type" : "string", - "description" : "The ID of the component" - }, - "componentName" : { - "type" : "string", - "description" : "The name of the component" - }, - "processGroupId" : { - "type" : "string", - "description" : "The ID of the Process Group that the component belongs to" - }, - "differences" : { - "type" : "array", - "description" : "The differences in the component between the two flows", - "items" : { - "$ref" : "#/definitions/DifferenceDTO" - } - } - } - }, - "ComponentHistoryDTO" : { - "type" : "object", - "properties" : { - "componentId" : { - "type" : "string", - "description" : "The component id." - }, - "propertyHistory" : { - "type" : "object", - "description" : "The history for the properties of the component.", - "additionalProperties" : { - "$ref" : "#/definitions/PropertyHistoryDTO" - } - } - } - }, - "ComponentHistoryEntity" : { - "type" : "object", - "properties" : { - "componentHistory" : { - "$ref" : "#/definitions/ComponentHistoryDTO" - } - }, - "xml" : { - "name" : "componentHistoryEntity" - } - }, - "ComponentLifecycle" : { - "type" : "object" - }, - "ComponentManifest" : { - "type" : "object", - "properties" : { - "apis" : { - "type" : "array", - "description" : "Public interfaces defined in this bundle", - "items" : { - "$ref" : "#/definitions/DefinedType" - } - }, - "controllerServices" : { - "type" : "array", - "description" : "Controller Services provided in this bundle", - "items" : { - "$ref" : "#/definitions/ControllerServiceDefinition" - } - }, - "processors" : { - "type" : "array", - "description" : "Processors provided in this bundle", - "items" : { - "$ref" : "#/definitions/ProcessorDefinition" - } - }, - "reportingTasks" : { - "type" : "array", - "description" : "Reporting Tasks provided in this bundle", - "items" : { - "$ref" : "#/definitions/ReportingTaskDefinition" - } - } - } - }, - "ComponentReferenceDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "versionedComponentId" : { - "type" : "string", - "description" : "The ID of the corresponding component that is under version control" - }, - "parentGroupId" : { - "type" : "string", - "description" : "The id of parent process group of this component if applicable." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "name" : { - "type" : "string", - "description" : "The name of the component." - } - } - }, - "ComponentReferenceEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "parentGroupId" : { - "type" : "string", - "description" : "The id of parent process group of this component if applicable." - }, - "component" : { - "$ref" : "#/definitions/ComponentReferenceDTO" - } - }, - "xml" : { - "name" : "componentReferenceEntity" - } - }, - "ComponentRestrictionPermissionDTO" : { - "type" : "object", - "properties" : { - "requiredPermission" : { - "description" : "The required permission necessary for this restriction.", - "$ref" : "#/definitions/RequiredPermissionDTO" - }, - "permissions" : { - "description" : "The permissions for this component restriction. Note: the read permission are not used and will always be false.", - "$ref" : "#/definitions/PermissionsDTO" - } - } - }, - "ComponentSearchResultDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component that matched the search." - }, - "groupId" : { - "type" : "string", - "description" : "The group id of the component that matched the search." - }, - "parentGroup" : { - "description" : "The parent group of the component that matched the search.", - "$ref" : "#/definitions/SearchResultGroupDTO" - }, - "versionedGroup" : { - "description" : "The nearest versioned ancestor group of the component that matched the search.", - "$ref" : "#/definitions/SearchResultGroupDTO" - }, - "name" : { - "type" : "string", - "description" : "The name of the component that matched the search." - }, - "matches" : { - "type" : "array", - "description" : "What matched the search from the component.", - "items" : { - "type" : "string" - } - } - } - }, - "ComponentStateDTO" : { - "type" : "object", - "properties" : { - "componentId" : { - "type" : "string", - "description" : "The component identifier." - }, - "stateDescription" : { - "type" : "string", - "description" : "Description of the state this component persists." - }, - "clusterState" : { - "description" : "The cluster state for this component, or null if this NiFi is a standalone instance.", - "$ref" : "#/definitions/StateMapDTO" - }, - "localState" : { - "description" : "The local state for this component.", - "$ref" : "#/definitions/StateMapDTO" - } - } - }, - "ComponentStateEntity" : { - "type" : "object", - "properties" : { - "componentState" : { - "description" : "The component state.", - "$ref" : "#/definitions/ComponentStateDTO" - } - }, - "xml" : { - "name" : "componentStateEntity" - } - }, - "ComponentValidationResultDTO" : { - "type" : "object", - "properties" : { - "processGroupId" : { - "type" : "string", - "description" : "The UUID of the Process Group that this component is in" - }, - "id" : { - "type" : "string", - "description" : "The UUID of this component" - }, - "referenceType" : { - "type" : "string", - "description" : "The type of this component", - "enum" : [ "PROCESSOR", "CONTROLLER_SERVICE", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT" ] - }, - "name" : { - "type" : "string", - "description" : "The name of this component." - }, - "state" : { - "type" : "string", - "description" : "The scheduled state of a processor or reporting task referencing a controller service. If this component is another controller service, this field represents the controller service state." - }, - "activeThreadCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of active threads for the referencing component." - }, - "validationErrors" : { - "type" : "array", - "description" : "The validation errors for the component.", - "items" : { - "type" : "string" - } - }, - "currentlyValid" : { - "type" : "boolean", - "description" : "Whether or not the component is currently valid" - }, - "resultsValid" : { - "type" : "boolean", - "description" : "Whether or not the component will be valid if the Parameter Context is changed" - }, - "resultantValidationErrors" : { - "type" : "array", - "description" : "The validation errors that will apply to the component if the Parameter Context is changed", - "items" : { - "type" : "string" - } - } - } - }, - "ComponentValidationResultEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "component" : { - "$ref" : "#/definitions/ComponentValidationResultDTO" - } - }, - "xml" : { - "name" : "componentValidationResultEntity" - } - }, - "ComponentValidationResultsEntity" : { - "type" : "object", - "properties" : { - "validationResults" : { - "type" : "array", - "description" : "A List of ComponentValidationResultEntity, one for each component that is validated", - "items" : { - "$ref" : "#/definitions/ComponentValidationResultEntity" - } - } - }, - "xml" : { - "name" : "componentValidationResults" - } - }, - "ConfigVerificationResultDTO" : { - "type" : "object", - "properties" : { - "outcome" : { - "type" : "string", - "description" : "The outcome of the verification", - "enum" : [ "SUCCESSFUL", "FAILED", "SKIPPED" ] - }, - "verificationStepName" : { - "type" : "string", - "description" : "The name of the verification step" - }, - "explanation" : { - "type" : "string", - "description" : "An explanation of why the step was or was not successful" - } - } - }, - "ConfigurationAnalysisDTO" : { - "type" : "object", - "properties" : { - "componentId" : { - "type" : "string", - "description" : "The ID of the component" - }, - "properties" : { - "type" : "object", - "description" : "The configured properties for the component", - "additionalProperties" : { - "type" : "string" - } - }, - "referencedAttributes" : { - "type" : "object", - "description" : "The attributes that are referenced by the properties, mapped to recently used values", - "additionalProperties" : { - "type" : "string" - } - }, - "supportsVerification" : { - "type" : "boolean", - "description" : "Whether or not the component supports verification" - } - } - }, - "ConfigurationAnalysisEntity" : { - "type" : "object", - "properties" : { - "configurationAnalysis" : { - "description" : "The configuration analysis", - "$ref" : "#/definitions/ConfigurationAnalysisDTO" - } - }, - "xml" : { - "name" : "configurationAnalysis" - } - }, - "ConnectableComponent" : { - "type" : "object", - "required" : [ "groupId", "id", "type" ], - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the connectable component." - }, - "type" : { - "type" : "string", - "description" : "The type of component the connectable is.", - "enum" : [ "PROCESSOR", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "INPUT_PORT", "OUTPUT_PORT", "FUNNEL" ] - }, - "groupId" : { - "type" : "string", - "description" : "The id of the group that the connectable component resides in" - }, - "name" : { - "type" : "string", - "description" : "The name of the connectable component" - }, - "comments" : { - "type" : "string", - "description" : "The comments for the connectable component." - }, - "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" - } - } - }, - "ConnectableDTO" : { - "type" : "object", - "required" : [ "groupId", "id", "type" ], - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the connectable component." - }, - "versionedComponentId" : { - "type" : "string", - "description" : "The ID of the corresponding component that is under version control" - }, - "type" : { - "type" : "string", - "description" : "The type of component the connectable is.", - "enum" : [ "PROCESSOR", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "INPUT_PORT", "OUTPUT_PORT", "FUNNEL" ] - }, - "groupId" : { - "type" : "string", - "description" : "The id of the group that the connectable component resides in" - }, - "name" : { - "type" : "string", - "description" : "The name of the connectable component" - }, - "running" : { - "type" : "boolean", - "description" : "Reflects the current state of the connectable component." - }, - "transmitting" : { - "type" : "boolean", - "description" : "If the connectable component represents a remote port, indicates if the target is configured to transmit." - }, - "exists" : { - "type" : "boolean", - "description" : "If the connectable component represents a remote port, indicates if the target exists." - }, - "comments" : { - "type" : "string", - "description" : "The comments for the connectable component." - } - } - }, - "ConnectionDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "versionedComponentId" : { - "type" : "string", - "description" : "The ID of the corresponding component that is under version control" - }, - "parentGroupId" : { - "type" : "string", - "description" : "The id of parent process group of this component if applicable." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "source" : { - "description" : "The source of the connection.", - "$ref" : "#/definitions/ConnectableDTO" - }, - "destination" : { - "description" : "The destination of the connection.", - "$ref" : "#/definitions/ConnectableDTO" - }, - "name" : { - "type" : "string", - "description" : "The name of the connection." - }, - "labelIndex" : { - "type" : "integer", - "format" : "int32", - "description" : "The index of the bend point where to place the connection label." - }, - "getzIndex" : { - "type" : "integer", - "format" : "int64", - "description" : "The z index of the connection." - }, - "selectedRelationships" : { - "type" : "array", - "description" : "The selected relationship that comprise the connection.", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - }, - "availableRelationships" : { - "type" : "array", - "description" : "The relationships that the source of the connection currently supports.", - "readOnly" : true, - "uniqueItems" : true, - "items" : { - "type" : "string" - } - }, - "backPressureObjectThreshold" : { - "type" : "integer", - "format" : "int64", - "description" : "The object count threshold for determining when back pressure is applied. Updating this value is a passive change in the sense that it won't impact whether existing files over the limit are affected but it does help feeder processors to stop pushing too much into this work queue." - }, - "backPressureDataSizeThreshold" : { - "type" : "string", - "description" : "The object data size threshold for determining when back pressure is applied. Updating this value is a passive change in the sense that it won't impact whether existing files over the limit are affected but it does help feeder processors to stop pushing too much into this work queue." - }, - "flowFileExpiration" : { - "type" : "string", - "description" : "The amount of time a flow file may be in the flow before it will be automatically aged out of the flow. Once a flow file reaches this age it will be terminated from the flow the next time a processor attempts to start work on it." - }, - "prioritizers" : { - "type" : "array", - "description" : "The comparators used to prioritize the queue.", - "items" : { - "type" : "string" - } - }, - "bends" : { - "type" : "array", - "description" : "The bend points on the connection.", - "items" : { - "$ref" : "#/definitions/PositionDTO" - } - }, - "loadBalanceStrategy" : { - "type" : "string", - "description" : "How to load balance the data in this Connection across the nodes in the cluster.", - "enum" : [ "DO_NOT_LOAD_BALANCE", "PARTITION_BY_ATTRIBUTE", "ROUND_ROBIN", "SINGLE_NODE" ] - }, - "loadBalancePartitionAttribute" : { - "type" : "string", - "description" : "The FlowFile Attribute to use for determining which node a FlowFile will go to if the Load Balancing Strategy is set to PARTITION_BY_ATTRIBUTE" - }, - "loadBalanceCompression" : { - "type" : "string", - "description" : "Whether or not data should be compressed when being transferred between nodes in the cluster.", - "enum" : [ "DO_NOT_COMPRESS", "COMPRESS_ATTRIBUTES_ONLY", "COMPRESS_ATTRIBUTES_AND_CONTENT" ] - }, - "loadBalanceStatus" : { - "type" : "string", - "description" : "The current status of the Connection's Load Balancing Activities. Status can indicate that Load Balancing is not configured for the connection, that Load Balancing is configured but inactive (not currently transferring data to another node), or that Load Balancing is configured and actively transferring data to another node.", - "readOnly" : true, - "enum" : [ "LOAD_BALANCE_NOT_CONFIGURED", "LOAD_BALANCE_INACTIVE", "LOAD_BALANCE_ACTIVE" ] - } - } - }, - "ConnectionDiagnosticsDTO" : { - "type" : "object", - "properties" : { - "connection" : { - "description" : "Details about the connection", - "readOnly" : true, - "$ref" : "#/definitions/ConnectionDTO" - }, - "aggregateSnapshot" : { - "description" : "Aggregate values for all nodes in the cluster, or for this instance if not clustered", - "readOnly" : true, - "$ref" : "#/definitions/ConnectionDiagnosticsSnapshotDTO" - }, - "nodeSnapshots" : { - "type" : "array", - "description" : "A list of values for each node in the cluster, if clustered.", - "readOnly" : true, - "items" : { - "$ref" : "#/definitions/ConnectionDiagnosticsSnapshotDTO" - } - } - } - }, - "ConnectionDiagnosticsSnapshotDTO" : { - "type" : "object", - "properties" : { - "totalFlowFileCount" : { - "type" : "integer", - "format" : "int32", - "description" : "Total number of FlowFiles owned by the Connection" - }, - "totalByteCount" : { - "type" : "integer", - "format" : "int64", - "description" : "Total number of bytes that make up the content for the FlowFiles owned by this Connection" - }, - "nodeIdentifier" : { - "type" : "string", - "description" : "The Node Identifier that this information pertains to" - }, - "localQueuePartition" : { - "description" : "The local queue partition, from which components can pull FlowFiles on this node.", - "$ref" : "#/definitions/LocalQueuePartitionDTO" - }, - "remoteQueuePartitions" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/RemoteQueuePartitionDTO" - } - } - } - }, - "ConnectionEntity" : { - "type" : "object", - "required" : [ "destinationType", "sourceType" ], - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "component" : { - "$ref" : "#/definitions/ConnectionDTO" - }, - "status" : { - "description" : "The status of the connection.", - "$ref" : "#/definitions/ConnectionStatusDTO" - }, - "bends" : { - "type" : "array", - "description" : "The bend points on the connection.", - "items" : { - "$ref" : "#/definitions/PositionDTO" - } - }, - "labelIndex" : { - "type" : "integer", - "format" : "int32", - "description" : "The index of the bend point where to place the connection label." - }, - "getzIndex" : { - "type" : "integer", - "format" : "int64", - "description" : "The z index of the connection." - }, - "sourceId" : { - "type" : "string", - "description" : "The identifier of the source of this connection." - }, - "sourceGroupId" : { - "type" : "string", - "description" : "The identifier of the group of the source of this connection." - }, - "sourceType" : { - "type" : "string", - "description" : "The type of component the source connectable is.", - "enum" : [ "PROCESSOR", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "INPUT_PORT", "OUTPUT_PORT", "FUNNEL" ] - }, - "destinationId" : { - "type" : "string", - "description" : "The identifier of the destination of this connection." - }, - "destinationGroupId" : { - "type" : "string", - "description" : "The identifier of the group of the destination of this connection." - }, - "destinationType" : { - "type" : "string", - "description" : "The type of component the destination connectable is.", - "enum" : [ "PROCESSOR", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "INPUT_PORT", "OUTPUT_PORT", "FUNNEL" ] - } - }, - "xml" : { - "name" : "connectionEntity" - } - }, - "ConnectionStatisticsDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The ID of the connection" - }, - "statsLastRefreshed" : { - "type" : "string", - "description" : "The timestamp of when the stats were last refreshed" - }, - "aggregateSnapshot" : { - "description" : "The status snapshot that represents the aggregate stats of the cluster", - "$ref" : "#/definitions/ConnectionStatisticsSnapshotDTO" - }, - "nodeSnapshots" : { - "type" : "array", - "description" : "A list of status snapshots for each node", - "items" : { - "$ref" : "#/definitions/NodeConnectionStatisticsSnapshotDTO" - } - } - } - }, - "ConnectionStatisticsEntity" : { - "type" : "object", - "properties" : { - "connectionStatistics" : { - "$ref" : "#/definitions/ConnectionStatisticsDTO" - }, - "canRead" : { - "type" : "boolean", - "description" : "Indicates whether the user can read a given resource.", - "readOnly" : true - } - }, - "xml" : { - "name" : "connectionStatisticsEntity" - } - }, - "ConnectionStatisticsSnapshotDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the connection." - }, - "predictedMillisUntilCountBackpressure" : { - "type" : "integer", - "format" : "int64", - "description" : "The predicted number of milliseconds before the connection will have backpressure applied, based on the queued count." - }, - "predictedMillisUntilBytesBackpressure" : { - "type" : "integer", - "format" : "int64", - "description" : "The predicted number of milliseconds before the connection will have backpressure applied, based on the total number of bytes in the queue." - }, - "predictedCountAtNextInterval" : { - "type" : "integer", - "format" : "int32", - "description" : "The predicted number of queued objects at the next configured interval." - }, - "predictedBytesAtNextInterval" : { - "type" : "integer", - "format" : "int64", - "description" : "The predicted total number of bytes in the queue at the next configured interval." - }, - "predictedPercentCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The predicted percentage of queued objects at the next configured interval." - }, - "predictedPercentBytes" : { - "type" : "integer", - "format" : "int32", - "description" : "The predicted percentage of bytes in the queue against current threshold at the next configured interval." - }, - "predictionIntervalMillis" : { - "type" : "integer", - "format" : "int64", - "description" : "The prediction interval in seconds" - } - } - }, - "ConnectionStatusDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The ID of the connection" - }, - "groupId" : { - "type" : "string", - "description" : "The ID of the Process Group that the connection belongs to" - }, - "name" : { - "type" : "string", - "description" : "The name of the connection" - }, - "statsLastRefreshed" : { - "type" : "string", - "description" : "The timestamp of when the stats were last refreshed" - }, - "sourceId" : { - "type" : "string", - "description" : "The ID of the source component" - }, - "sourceName" : { - "type" : "string", - "description" : "The name of the source component" - }, - "destinationId" : { - "type" : "string", - "description" : "The ID of the destination component" - }, - "destinationName" : { - "type" : "string", - "description" : "The name of the destination component" - }, - "aggregateSnapshot" : { - "description" : "The status snapshot that represents the aggregate stats of the cluster", - "$ref" : "#/definitions/ConnectionStatusSnapshotDTO" - }, - "nodeSnapshots" : { - "type" : "array", - "description" : "A list of status snapshots for each node", - "items" : { - "$ref" : "#/definitions/NodeConnectionStatusSnapshotDTO" - } - } - } - }, - "ConnectionStatusEntity" : { - "type" : "object", - "properties" : { - "connectionStatus" : { - "$ref" : "#/definitions/ConnectionStatusDTO" - }, - "canRead" : { - "type" : "boolean", - "description" : "Indicates whether the user can read a given resource.", - "readOnly" : true - } - }, - "xml" : { - "name" : "connectionStatusEntity" - } - }, - "ConnectionStatusPredictionsSnapshotDTO" : { - "type" : "object", - "properties" : { - "predictedMillisUntilCountBackpressure" : { - "type" : "integer", - "format" : "int64", - "description" : "The predicted number of milliseconds before the connection will have backpressure applied, based on the queued count." - }, - "predictedMillisUntilBytesBackpressure" : { - "type" : "integer", - "format" : "int64", - "description" : "The predicted number of milliseconds before the connection will have backpressure applied, based on the total number of bytes in the queue." - }, - "predictionIntervalSeconds" : { - "type" : "integer", - "format" : "int32", - "description" : "The configured interval (in seconds) for predicting connection queue count and size (and percent usage)." - }, - "predictedCountAtNextInterval" : { - "type" : "integer", - "format" : "int32", - "description" : "The predicted number of queued objects at the next configured interval." - }, - "predictedBytesAtNextInterval" : { - "type" : "integer", - "format" : "int64", - "description" : "The predicted total number of bytes in the queue at the next configured interval." - }, - "predictedPercentCount" : { - "type" : "integer", - "format" : "int32", - "description" : "Predicted connection percent use regarding queued flow files count and backpressure threshold if configured." - }, - "predictedPercentBytes" : { - "type" : "integer", - "format" : "int32", - "description" : "Predicted connection percent use regarding queued flow files size and backpressure threshold if configured." - } - } - }, - "ConnectionStatusSnapshotDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the connection." - }, - "groupId" : { - "type" : "string", - "description" : "The id of the process group the connection belongs to." - }, - "name" : { - "type" : "string", - "description" : "The name of the connection." - }, - "sourceId" : { - "type" : "string", - "description" : "The id of the source of the connection." - }, - "sourceName" : { - "type" : "string", - "description" : "The name of the source of the connection." - }, - "destinationId" : { - "type" : "string", - "description" : "The id of the destination of the connection." - }, - "destinationName" : { - "type" : "string", - "description" : "The name of the destination of the connection." - }, - "predictions" : { - "description" : "Predictions, if available, for this connection (null if not available)", - "$ref" : "#/definitions/ConnectionStatusPredictionsSnapshotDTO" - }, - "flowFilesIn" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of FlowFiles that have come into the connection in the last 5 minutes." - }, - "bytesIn" : { - "type" : "integer", - "format" : "int64", - "description" : "The size of the FlowFiles that have come into the connection in the last 5 minutes." - }, - "input" : { - "type" : "string", - "description" : "The input count/size for the connection in the last 5 minutes, pretty printed." - }, - "flowFilesOut" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of FlowFiles that have left the connection in the last 5 minutes." - }, - "bytesOut" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes that have left the connection in the last 5 minutes." - }, - "output" : { - "type" : "string", - "description" : "The output count/sie for the connection in the last 5 minutes, pretty printed." - }, - "flowFilesQueued" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of FlowFiles that are currently queued in the connection." - }, - "bytesQueued" : { - "type" : "integer", - "format" : "int64", - "description" : "The size of the FlowFiles that are currently queued in the connection." - }, - "queued" : { - "type" : "string", - "description" : "The total count and size of queued flowfiles formatted." - }, - "queuedSize" : { - "type" : "string", - "description" : "The total size of flowfiles that are queued formatted." - }, - "queuedCount" : { - "type" : "string", - "description" : "The number of flowfiles that are queued, pretty printed." - }, - "percentUseCount" : { - "type" : "integer", - "format" : "int32", - "description" : "Connection percent use regarding queued flow files count and backpressure threshold if configured." - }, - "percentUseBytes" : { - "type" : "integer", - "format" : "int32", - "description" : "Connection percent use regarding queued flow files size and backpressure threshold if configured." - }, - "flowFileAvailability" : { - "type" : "string", - "description" : "The availability of FlowFiles in this connection" - } - } - }, - "ConnectionStatusSnapshotEntity" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the connection." - }, - "connectionStatusSnapshot" : { - "$ref" : "#/definitions/ConnectionStatusSnapshotDTO" - }, - "canRead" : { - "type" : "boolean", - "description" : "Indicates whether the user can read a given resource.", - "readOnly" : true - } - }, - "xml" : { - "name" : "entity" - } - }, - "ConnectionsEntity" : { - "type" : "object", - "properties" : { - "connections" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ConnectionEntity" - } - } - }, - "xml" : { - "name" : "connectionsEntity" - } - }, - "ControllerBulletinsEntity" : { - "type" : "object", - "properties" : { - "bulletins" : { - "type" : "array", - "description" : "System level bulletins to be reported to the user.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "controllerServiceBulletins" : { - "type" : "array", - "description" : "Controller service bulletins to be reported to the user.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "reportingTaskBulletins" : { - "type" : "array", - "description" : "Reporting task bulletins to be reported to the user.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "parameterProviderBulletins" : { - "type" : "array", - "description" : "Parameter provider bulletins to be reported to the user.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "flowRegistryClientBulletins" : { - "type" : "array", - "description" : "Flow registry client bulletins to be reported to the user.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - } - }, - "xml" : { - "name" : "controllerConfigurationEntity" - } - }, - "ControllerConfigurationDTO" : { - "type" : "object", - "properties" : { - "maxTimerDrivenThreadCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The maximum number of timer driven threads the NiFi has available." - }, - "maxEventDrivenThreadCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The maximum number of event driven threads the NiFi has available." - } - } - }, - "ControllerConfigurationEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "component" : { - "description" : "The controller configuration.", - "$ref" : "#/definitions/ControllerConfigurationDTO" - } - }, - "xml" : { - "name" : "controllerConfigurationEntity" - } - }, - "ControllerDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the NiFi." - }, - "name" : { - "type" : "string", - "description" : "The name of the NiFi." - }, - "comments" : { - "type" : "string", - "description" : "The comments for the NiFi." - }, - "runningCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of running components in the NiFi." - }, - "stoppedCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of stopped components in the NiFi." - }, - "invalidCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of invalid components in the NiFi." - }, - "disabledCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of disabled components in the NiFi." - }, - "activeRemotePortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of active remote ports contained in the NiFi." - }, - "inactiveRemotePortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of inactive remote ports contained in the NiFi." - }, - "inputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of input ports contained in the NiFi." - }, - "outputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of output ports in the NiFi." - }, - "remoteSiteListeningPort" : { - "type" : "integer", - "format" : "int32", - "description" : "The Socket Port on which this instance is listening for Remote Transfers of Flow Files. If this instance is not configured to receive Flow Files from remote instances, this will be null." - }, - "remoteSiteHttpListeningPort" : { - "type" : "integer", - "format" : "int32", - "description" : "The HTTP(S) Port on which this instance is listening for Remote Transfers of Flow Files. If this instance is not configured to receive Flow Files from remote instances, this will be null." - }, - "siteToSiteSecure" : { - "type" : "boolean", - "description" : "Indicates whether or not Site-to-Site communications with this instance is secure (2-way authentication)." - }, - "instanceId" : { - "type" : "string", - "description" : "If clustered, the id of the Cluster Manager, otherwise the id of the NiFi." - }, - "inputPorts" : { - "type" : "array", - "description" : "The input ports available to send data to for the NiFi.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/PortDTO" - } - }, - "outputPorts" : { - "type" : "array", - "description" : "The output ports available to received data from the NiFi.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/PortDTO" - } - } - } - }, - "ControllerEntity" : { - "type" : "object", - "properties" : { - "controller" : { - "$ref" : "#/definitions/ControllerDTO" - } - }, - "xml" : { - "name" : "controllerEntity" - } - }, - "ControllerServiceAPI" : { - "type" : "object", - "properties" : { - "type" : { - "type" : "string", - "description" : "The fully qualified name of the service interface." - }, - "bundle" : { - "description" : "The details of the artifact that bundled this service interface.", - "$ref" : "#/definitions/Bundle" - } - } - }, - "ControllerServiceApiDTO" : { - "type" : "object", - "properties" : { - "type" : { - "type" : "string", - "description" : "The fully qualified name of the service interface." - }, - "bundle" : { - "description" : "The details of the artifact that bundled this service interface.", - "$ref" : "#/definitions/BundleDTO" - } - } - }, - "ControllerServiceDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "versionedComponentId" : { - "type" : "string", - "description" : "The ID of the corresponding component that is under version control" - }, - "parentGroupId" : { - "type" : "string", - "description" : "The id of parent process group of this component if applicable." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "name" : { - "type" : "string", - "description" : "The name of the controller service." - }, - "type" : { - "type" : "string", - "description" : "The type of the controller service." - }, - "bundle" : { - "description" : "The details of the artifact that bundled this processor type.", - "$ref" : "#/definitions/BundleDTO" - }, - "controllerServiceApis" : { - "type" : "array", - "description" : "Lists the APIs this Controller Service implements.", - "items" : { - "$ref" : "#/definitions/ControllerServiceApiDTO" - } - }, - "comments" : { - "type" : "string", - "description" : "The comments for the controller service." - }, - "state" : { - "type" : "string", - "description" : "The state of the controller service.", - "enum" : [ "ENABLED", "ENABLING", "DISABLED", "DISABLING" ] - }, - "persistsState" : { - "type" : "boolean", - "description" : "Whether the controller service persists state." - }, - "restricted" : { - "type" : "boolean", - "description" : "Whether the controller service requires elevated privileges." - }, - "deprecated" : { - "type" : "boolean", - "description" : "Whether the ontroller service has been deprecated." - }, - "multipleVersionsAvailable" : { - "type" : "boolean", - "description" : "Whether the controller service has multiple versions available." - }, - "supportsSensitiveDynamicProperties" : { - "type" : "boolean", - "description" : "Whether the controller service supports sensitive dynamic properties." - }, - "properties" : { - "type" : "object", - "description" : "The properties of the controller service.", - "additionalProperties" : { - "type" : "string" - } - }, - "descriptors" : { - "type" : "object", - "description" : "The descriptors for the controller service properties.", - "additionalProperties" : { - "$ref" : "#/definitions/PropertyDescriptorDTO" - } - }, - "sensitiveDynamicPropertyNames" : { - "type" : "array", - "description" : "Set of sensitive dynamic property names", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - }, - "customUiUrl" : { - "type" : "string", - "description" : "The URL for the controller services custom configuration UI if applicable." - }, - "annotationData" : { - "type" : "string", - "description" : "The annotation for the controller service. This is how the custom UI relays configuration to the controller service." - }, - "referencingComponents" : { - "type" : "array", - "description" : "All components referencing this controller service.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ControllerServiceReferencingComponentEntity" - } - }, - "validationErrors" : { - "type" : "array", - "description" : "The validation errors from the controller service. These validation errors represent the problems with the controller service that must be resolved before it can be enabled.", - "items" : { - "type" : "string" - } - }, - "validationStatus" : { - "type" : "string", - "description" : "Indicates whether the ControllerService is valid, invalid, or still in the process of validating (i.e., it is unknown whether or not the ControllerService is valid)", - "readOnly" : true, - "enum" : [ "VALID", "INVALID", "VALIDATING" ] - }, - "bulletinLevel" : { - "type" : "string", - "description" : "The level at which the controller service will report bulletins." - }, - "extensionMissing" : { - "type" : "boolean", - "description" : "Whether the underlying extension is missing." - } - } - }, - "ControllerServiceDefinition" : { - "type" : "object", - "required" : [ "type" ], - "properties" : { - "group" : { - "type" : "string", - "description" : "The group name of the bundle that provides the referenced type." - }, - "artifact" : { - "type" : "string", - "description" : "The artifact name of the bundle that provides the referenced type." - }, - "version" : { - "type" : "string", - "description" : "The version 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." - }, - "buildInfo" : { - "description" : "The build metadata for this component", - "$ref" : "#/definitions/BuildInfo" - }, - "providedApiImplementations" : { - "type" : "array", - "description" : "If this type represents a provider for an interface, this lists the APIs it implements", - "items" : { - "$ref" : "#/definitions/DefinedType" - } - }, - "tags" : { - "type" : "array", - "description" : "The tags associated with this type", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - }, - "seeAlso" : { - "type" : "array", - "description" : "The names of other component types that may be related", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - }, - "deprecated" : { - "type" : "boolean", - "description" : "Whether or not the component has been deprecated" - }, - "deprecationReason" : { - "type" : "string", - "description" : "If this component has been deprecated, this optional field can be used to provide an explanation" - }, - "deprecationAlternatives" : { - "type" : "array", - "description" : "If this component has been deprecated, this optional field provides alternatives to use", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - }, - "restricted" : { - "type" : "boolean", - "description" : "Whether or not the component has a general restriction" - }, - "restrictedExplanation" : { - "type" : "string", - "description" : "An optional description of the general restriction" - }, - "explicitRestrictions" : { - "type" : "array", - "description" : "Explicit restrictions that indicate a require permission to use the component", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/Restriction" - } - }, - "stateful" : { - "description" : "Indicates if the component stores state", - "$ref" : "#/definitions/Stateful" - }, - "systemResourceConsiderations" : { - "type" : "array", - "description" : "The system resource considerations for the given component", - "items" : { - "$ref" : "#/definitions/SystemResourceConsideration" - } - }, - "additionalDetails" : { - "type" : "boolean", - "description" : "Indicates if the component has additional details documentation" - }, - "propertyDescriptors" : { - "type" : "object", - "description" : "Descriptions of configuration properties applicable to this component.", - "additionalProperties" : { - "$ref" : "#/definitions/PropertyDescriptor" - } - }, - "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." - }, - "dynamicProperties" : { - "type" : "array", - "description" : "Describes the dynamic properties supported by this component", - "items" : { - "$ref" : "#/definitions/DynamicProperty" - } - } - } - }, - "ControllerServiceDiagnosticsDTO" : { - "type" : "object", - "properties" : { - "controllerService" : { - "description" : "The Controller Service", - "$ref" : "#/definitions/ControllerServiceEntity" - }, - "classLoaderDiagnostics" : { - "description" : "Information about the Controller Service's Class Loader", - "$ref" : "#/definitions/ClassLoaderDiagnosticsDTO" - } - } - }, - "ControllerServiceEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "parentGroupId" : { - "type" : "string", - "description" : "The id of parent process group of this ControllerService." - }, - "component" : { - "$ref" : "#/definitions/ControllerServiceDTO" - }, - "operatePermissions" : { - "description" : "The permissions for this component operations.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "status" : { - "description" : "The status for this ControllerService.", - "readOnly" : true, - "$ref" : "#/definitions/ControllerServiceStatusDTO" - } - }, - "xml" : { - "name" : "controllerServiceEntity" - } - }, - "ControllerServiceReferencingComponentDTO" : { - "type" : "object", - "properties" : { - "groupId" : { - "type" : "string", - "description" : "The group id for the component referencing a controller service. If this component is another controller service or a reporting task, this field is blank." - }, - "id" : { - "type" : "string", - "description" : "The id of the component referencing a controller service." - }, - "name" : { - "type" : "string", - "description" : "The name of the component referencing a controller service." - }, - "type" : { - "type" : "string", - "description" : "The type of the component referencing a controller service in simple Java class name format without package name." - }, - "state" : { - "type" : "string", - "description" : "The scheduled state of a processor or reporting task referencing a controller service. If this component is another controller service, this field represents the controller service state." - }, - "properties" : { - "type" : "object", - "description" : "The properties for the component.", - "additionalProperties" : { - "type" : "string" - } - }, - "descriptors" : { - "type" : "object", - "description" : "The descriptors for the component properties.", - "additionalProperties" : { - "$ref" : "#/definitions/PropertyDescriptorDTO" - } - }, - "validationErrors" : { - "type" : "array", - "description" : "The validation errors for the component.", - "items" : { - "type" : "string" - } - }, - "referenceType" : { - "type" : "string", - "description" : "The type of reference this is.", - "enum" : [ "Processor", "ControllerService", "ReportingTask", "FlowRegistryClient" ] - }, - "activeThreadCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of active threads for the referencing component." - }, - "referenceCycle" : { - "type" : "boolean", - "description" : "If the referencing component represents a controller service, this indicates whether it has already been represented in this hierarchy." - }, - "referencingComponents" : { - "type" : "array", - "description" : "If the referencing component represents a controller service, these are the components that reference it.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ControllerServiceReferencingComponentEntity" - } - } - } - }, - "ControllerServiceReferencingComponentEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "component" : { - "$ref" : "#/definitions/ControllerServiceReferencingComponentDTO" - }, - "operatePermissions" : { - "description" : "The permissions for this component operations.", - "$ref" : "#/definitions/PermissionsDTO" - } - }, - "xml" : { - "name" : "controllerServiceReferencingComponentEntity" - } - }, - "ControllerServiceReferencingComponentsEntity" : { - "type" : "object", - "properties" : { - "controllerServiceReferencingComponents" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ControllerServiceReferencingComponentEntity" - } - } - }, - "xml" : { - "name" : "controllerServiceReferencingComponentsEntity" - } - }, - "ControllerServiceRunStatusEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "state" : { - "type" : "string", - "description" : "The run status of the ControllerService.", - "enum" : [ "ENABLED", "DISABLED" ] - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "uiOnly" : { - "type" : "boolean", - "description" : "Indicates whether or not responses should only include fields necessary for rendering the NiFi User Interface. As such, when this value is set to true, some fields may be returned as null values, and the selected fields may change at any time without notice. As a result, this value should not be set to true by any client other than the UI." - } - }, - "xml" : { - "name" : "entity" - } - }, - "ControllerServiceStatusDTO" : { - "type" : "object", - "properties" : { - "runStatus" : { - "type" : "string", - "description" : "The run status of this ControllerService", - "readOnly" : true, - "enum" : [ "ENABLED", "ENABLING", "DISABLED", "DISABLING" ] - }, - "validationStatus" : { - "type" : "string", - "description" : "Indicates whether the component is valid, invalid, or still in the process of validating (i.e., it is unknown whether or not the component is valid)", - "readOnly" : true, - "enum" : [ "VALID", "INVALID", "VALIDATING" ] - }, - "activeThreadCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of active threads for the component." - } - } - }, - "ControllerServiceTypesEntity" : { - "type" : "object", - "properties" : { - "controllerServiceTypes" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/DocumentedTypeDTO" - } - } - }, - "xml" : { - "name" : "controllerServiceTypesEntity" - } - }, - "ControllerServicesEntity" : { - "type" : "object", - "properties" : { - "currentTime" : { - "type" : "string", - "description" : "The current time on the system." - }, - "controllerServices" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ControllerServiceEntity" - } - } - }, - "xml" : { - "name" : "controllerServicesEntity" - } - }, - "ControllerStatusDTO" : { - "type" : "object", - "properties" : { - "activeThreadCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of active threads in the NiFi." - }, - "terminatedThreadCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of terminated threads in the NiFi." - }, - "queued" : { - "type" : "string", - "description" : "The number of flowfiles queued in the NiFi." - }, - "flowFilesQueued" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of FlowFiles queued across the entire flow" - }, - "bytesQueued" : { - "type" : "integer", - "format" : "int64", - "description" : "The size of the FlowFiles queued across the entire flow" - }, - "runningCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of running components in the NiFi." - }, - "stoppedCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of stopped components in the NiFi." - }, - "invalidCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of invalid components in the NiFi." - }, - "disabledCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of disabled components in the NiFi." - }, - "activeRemotePortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of active remote ports in the NiFi." - }, - "inactiveRemotePortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of inactive remote ports in the NiFi." - }, - "upToDateCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of up to date versioned process groups in the NiFi." - }, - "locallyModifiedCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of locally modified versioned process groups in the NiFi." - }, - "staleCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of stale versioned process groups in the NiFi." - }, - "locallyModifiedAndStaleCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of locally modified and stale versioned process groups in the NiFi." - }, - "syncFailureCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of versioned process groups in the NiFi that are unable to sync to a registry." - } - } - }, - "ControllerStatusEntity" : { - "type" : "object", - "properties" : { - "controllerStatus" : { - "$ref" : "#/definitions/ControllerStatusDTO" - } - }, - "xml" : { - "name" : "controllerStatusEntity" - } - }, - "CopySnippetRequestEntity" : { - "type" : "object", - "properties" : { - "snippetId" : { - "type" : "string", - "description" : "The identifier of the snippet." - }, - "originX" : { - "type" : "number", - "format" : "double", - "description" : "The x coordinate of the origin of the bounding box where the new components will be placed." - }, - "originY" : { - "type" : "number", - "format" : "double", - "description" : "The y coordinate of the origin of the bounding box where the new components will be placed." - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - } - }, - "xml" : { - "name" : "copySnippetRequestEntity" - } - }, - "CounterDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the counter." - }, - "context" : { - "type" : "string", - "description" : "The context of the counter." - }, - "name" : { - "type" : "string", - "description" : "The name of the counter." - }, - "valueCount" : { - "type" : "integer", - "format" : "int64", - "description" : "The value count." - }, - "value" : { - "type" : "string", - "description" : "The value of the counter." - } - } - }, - "CounterEntity" : { - "type" : "object", - "properties" : { - "counter" : { - "$ref" : "#/definitions/CounterDTO" - } - }, - "xml" : { - "name" : "counterEntity" - } - }, - "CountersDTO" : { - "type" : "object", - "properties" : { - "aggregateSnapshot" : { - "description" : "A Counters snapshot that represents the aggregate values of all nodes in the cluster. If the NiFi instance is a standalone instance, rather than a cluster, this represents the stats of the single instance.", - "$ref" : "#/definitions/CountersSnapshotDTO" - }, - "nodeSnapshots" : { - "type" : "array", - "description" : "A Counters snapshot for each node in the cluster. If the NiFi instance is a standalone instance, rather than a cluster, this may be null.", - "items" : { - "$ref" : "#/definitions/NodeCountersSnapshotDTO" - } - } - } - }, - "CountersEntity" : { - "type" : "object", - "properties" : { - "counters" : { - "$ref" : "#/definitions/CountersDTO" - } - }, - "xml" : { - "name" : "countersEntity" - } - }, - "CountersSnapshotDTO" : { - "type" : "object", - "properties" : { - "generated" : { - "type" : "string", - "description" : "The timestamp when the report was generated." - }, - "counters" : { - "type" : "array", - "description" : "All counters in the NiFi.", - "items" : { - "$ref" : "#/definitions/CounterDTO" - } - } - } - }, - "CreateActiveRequestEntity" : { - "type" : "object", - "properties" : { - "processGroupId" : { - "type" : "string", - "description" : "The Process Group ID that this active request will update" - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - } - }, - "xml" : { - "name" : "createActiveRequestEntity" - } - }, - "CreateTemplateRequestEntity" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The name of the template." - }, - "description" : { - "type" : "string", - "description" : "The description of the template." - }, - "snippetId" : { - "type" : "string", - "description" : "The identifier of the snippet." - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - } - }, - "xml" : { - "name" : "createTemplateRequestEntity" - } - }, - "CurrentUserEntity" : { - "type" : "object", - "properties" : { - "identity" : { - "type" : "string", - "description" : "The user identity being serialized." - }, - "anonymous" : { - "type" : "boolean", - "description" : "Whether the current user is anonymous." - }, - "provenancePermissions" : { - "description" : "Permissions for querying provenance.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "countersPermissions" : { - "description" : "Permissions for accessing counters.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "tenantsPermissions" : { - "description" : "Permissions for accessing tenants.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "controllerPermissions" : { - "description" : "Permissions for accessing the controller.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "policiesPermissions" : { - "description" : "Permissions for accessing the policies.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "systemPermissions" : { - "description" : "Permissions for accessing system.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "parameterContextPermissions" : { - "description" : "Permissions for accessing parameter contexts.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "restrictedComponentsPermissions" : { - "description" : "Permissions for accessing restricted components. Note: the read permission are not used and will always be false.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "componentRestrictionPermissions" : { - "type" : "array", - "description" : "Permissions for specific component restrictions.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ComponentRestrictionPermissionDTO" - } - }, - "canVersionFlows" : { - "type" : "boolean", - "description" : "Whether the current user can version flows." - } - }, - "xml" : { - "name" : "currentEntity" - } - }, - "DefinedType" : { - "type" : "object", - "required" : [ "type" ], - "properties" : { - "group" : { - "type" : "string", - "description" : "The group name of the bundle that provides the referenced type." - }, - "artifact" : { - "type" : "string", - "description" : "The artifact name of the bundle that provides the referenced type." - }, - "version" : { - "type" : "string", - "description" : "The version 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." - } - } - }, - "DifferenceDTO" : { - "type" : "object", - "properties" : { - "differenceType" : { - "type" : "string", - "description" : "The type of difference" - }, - "difference" : { - "type" : "string", - "description" : "Description of the difference" - } - } - }, - "DimensionsDTO" : { - "type" : "object", - "properties" : { - "width" : { - "type" : "number", - "format" : "double", - "description" : "The width of the label in pixels when at a 1:1 scale." - }, - "height" : { - "type" : "number", - "format" : "double", - "description" : "The height of the label in pixels when at a 1:1 scale." - } - } - }, - "DocumentedTypeDTO" : { - "type" : "object", - "properties" : { - "type" : { - "type" : "string", - "description" : "The fully qualified name of the type." - }, - "bundle" : { - "description" : "The details of the artifact that bundled this type.", - "$ref" : "#/definitions/BundleDTO" - }, - "controllerServiceApis" : { - "type" : "array", - "description" : "If this type represents a ControllerService, this lists the APIs it implements.", - "items" : { - "$ref" : "#/definitions/ControllerServiceApiDTO" - } - }, - "description" : { - "type" : "string", - "description" : "The description of the type." - }, - "restricted" : { - "type" : "boolean", - "description" : "Whether this type is restricted." - }, - "usageRestriction" : { - "type" : "string", - "description" : "The optional description of why the usage of this component is restricted." - }, - "explicitRestrictions" : { - "type" : "array", - "description" : "An optional collection of explicit restrictions. If specified, these explicit restrictions will be enfored.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ExplicitRestrictionDTO" - } - }, - "deprecationReason" : { - "type" : "string", - "description" : "The description of why the usage of this component is restricted." - }, - "tags" : { - "type" : "array", - "description" : "The tags associated with this type.", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - } - } - }, - "DropRequestDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id for this drop request." - }, - "uri" : { - "type" : "string", - "description" : "The URI for future requests to this drop request." - }, - "submissionTime" : { - "type" : "string", - "description" : "The timestamp when the query was submitted." - }, - "lastUpdated" : { - "type" : "string", - "description" : "The last time this drop request was updated." - }, - "percentCompleted" : { - "type" : "integer", - "format" : "int32", - "description" : "The current percent complete." - }, - "finished" : { - "type" : "boolean", - "description" : "Whether the query has finished." - }, - "failureReason" : { - "type" : "string", - "description" : "The reason, if any, that this drop request failed." - }, - "currentCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of flow files currently queued." - }, - "currentSize" : { - "type" : "integer", - "format" : "int64", - "description" : "The size of flow files currently queued in bytes." - }, - "current" : { - "type" : "string", - "description" : "The count and size of flow files currently queued." - }, - "originalCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of flow files to be dropped as a result of this request." - }, - "originalSize" : { - "type" : "integer", - "format" : "int64", - "description" : "The size of flow files to be dropped as a result of this request in bytes." - }, - "original" : { - "type" : "string", - "description" : "The count and size of flow files to be dropped as a result of this request." - }, - "droppedCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of flow files that have been dropped thus far." - }, - "droppedSize" : { - "type" : "integer", - "format" : "int64", - "description" : "The size of flow files that have been dropped thus far in bytes." - }, - "dropped" : { - "type" : "string", - "description" : "The count and size of flow files that have been dropped thus far." - }, - "state" : { - "type" : "string", - "description" : "The current state of the drop request." - } - } - }, - "DropRequestEntity" : { - "type" : "object", - "properties" : { - "dropRequest" : { - "$ref" : "#/definitions/DropRequestDTO" - } - }, - "xml" : { - "name" : "dropRequestEntity" - } - }, - "DtoFactory" : { - "type" : "object" - }, - "DynamicProperty" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The description of the dynamic property name" - }, - "value" : { - "type" : "string", - "description" : "The description of the dynamic property value" - }, - "description" : { - "type" : "string", - "description" : "The description of the dynamic property" - }, - "expressionLanguageScope" : { - "type" : "string", - "description" : "The scope of the expression language support", - "enum" : [ "NONE", "VARIABLE_REGISTRY", "FLOWFILE_ATTRIBUTES" ] - } - } - }, - "DynamicRelationship" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The description of the dynamic relationship name" - }, - "description" : { - "type" : "string", - "description" : "The description of the dynamic relationship" - } - } - }, - "Entity" : { - "type" : "object", - "xml" : { - "name" : "entity" - } - }, - "ExplicitRestrictionDTO" : { - "type" : "object", - "properties" : { - "requiredPermission" : { - "description" : "The required permission necessary for this restriction.", - "$ref" : "#/definitions/RequiredPermissionDTO" - }, - "explanation" : { - "type" : "string", - "description" : "The description of why the usage of this component is restricted for this required permission." - } - } - }, - "ExternalControllerServiceReference" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The identifier of the controller service" - }, - "name" : { - "type" : "string", - "description" : "The name of the controller service" - } - } - }, - "FlowBreadcrumbDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the group." - }, - "name" : { - "type" : "string", - "description" : "The id of the group." - }, - "versionControlInformation" : { - "description" : "The process group version control information or null if not version controlled.", - "$ref" : "#/definitions/VersionControlInformationDTO" - } - } - }, - "FlowBreadcrumbEntity" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of this ancestor ProcessGroup." - }, - "permissions" : { - "description" : "The permissions for this ancestor ProcessGroup.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "versionedFlowState" : { - "type" : "string", - "description" : "The current state of the Process Group, as it relates to the Versioned Flow", - "readOnly" : true, - "enum" : [ "LOCALLY_MODIFIED", "STALE", "LOCALLY_MODIFIED_AND_STALE", "UP_TO_DATE", "SYNC_FAILURE" ] - }, - "breadcrumb" : { - "description" : "This breadcrumb.", - "$ref" : "#/definitions/FlowBreadcrumbDTO" - }, - "parentBreadcrumb" : { - "description" : "The parent breadcrumb for this breadcrumb.", - "$ref" : "#/definitions/FlowBreadcrumbEntity" - } - }, - "xml" : { - "name" : "flowEntity" - } - }, - "FlowComparisonEntity" : { - "type" : "object", - "properties" : { - "componentDifferences" : { - "type" : "array", - "description" : "The list of differences for each component in the flow that is not the same between the two flows", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ComponentDifferenceDTO" - } - } - }, - "xml" : { - "name" : "flowComparisonEntity" - } - }, - "FlowConfigurationDTO" : { - "type" : "object", - "properties" : { - "supportsManagedAuthorizer" : { - "type" : "boolean", - "description" : "Whether this NiFi supports a managed authorizer. Managed authorizers can visualize users, groups, and policies in the UI.", - "readOnly" : true - }, - "supportsConfigurableAuthorizer" : { - "type" : "boolean", - "description" : "Whether this NiFi supports a configurable authorizer.", - "readOnly" : true - }, - "supportsConfigurableUsersAndGroups" : { - "type" : "boolean", - "description" : "Whether this NiFi supports configurable users and groups.", - "readOnly" : true - }, - "autoRefreshIntervalSeconds" : { - "type" : "integer", - "format" : "int64", - "description" : "The interval in seconds between the automatic NiFi refresh requests.", - "readOnly" : true - }, - "currentTime" : { - "type" : "string", - "description" : "The current time on the system." - }, - "timeOffset" : { - "type" : "integer", - "format" : "int32", - "description" : "The time offset of the system." - }, - "defaultBackPressureObjectThreshold" : { - "type" : "integer", - "format" : "int64", - "description" : "The default back pressure object threshold." - }, - "defaultBackPressureDataSizeThreshold" : { - "type" : "string", - "description" : "The default back pressure data size threshold." - } - } - }, - "FlowConfigurationEntity" : { - "type" : "object", - "properties" : { - "flowConfiguration" : { - "description" : "The controller configuration.", - "$ref" : "#/definitions/FlowConfigurationDTO" - } - }, - "xml" : { - "name" : "flowConfigurationEntity" - } - }, - "FlowDTO" : { - "type" : "object", - "properties" : { - "processGroups" : { - "type" : "array", - "description" : "The process groups in this flow.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ProcessGroupEntity" - } - }, - "remoteProcessGroups" : { - "type" : "array", - "description" : "The remote process groups in this flow.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/RemoteProcessGroupEntity" - } - }, - "processors" : { - "type" : "array", - "description" : "The processors in this flow.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ProcessorEntity" - } - }, - "inputPorts" : { - "type" : "array", - "description" : "The input ports in this flow.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/PortEntity" - } - }, - "outputPorts" : { - "type" : "array", - "description" : "The output ports in this flow.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/PortEntity" - } - }, - "connections" : { - "type" : "array", - "description" : "The connections in this flow.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ConnectionEntity" - } - }, - "labels" : { - "type" : "array", - "description" : "The labels in this flow.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/LabelEntity" - } - }, - "funnels" : { - "type" : "array", - "description" : "The funnels in this flow.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/FunnelEntity" - } - } - } - }, - "FlowEntity" : { - "type" : "object", - "properties" : { - "flow" : { - "$ref" : "#/definitions/FlowDTO" - } - }, - "xml" : { - "name" : "flowEntity" - } - }, - "FlowFileDTO" : { - "type" : "object", - "properties" : { - "uri" : { - "type" : "string", - "description" : "The URI that can be used to access this FlowFile." - }, - "uuid" : { - "type" : "string", - "description" : "The FlowFile UUID." - }, - "filename" : { - "type" : "string", - "description" : "The FlowFile filename." - }, - "position" : { - "type" : "integer", - "format" : "int32", - "description" : "The FlowFile's position in the queue." - }, - "size" : { - "type" : "integer", - "format" : "int64", - "description" : "The FlowFile file size." - }, - "queuedDuration" : { - "type" : "integer", - "format" : "int64", - "description" : "How long this FlowFile has been enqueued." - }, - "lineageDuration" : { - "type" : "integer", - "format" : "int64", - "description" : "Duration since the FlowFile's greatest ancestor entered the flow." - }, - "penaltyExpiresIn" : { - "type" : "integer", - "format" : "int64", - "description" : "How long in milliseconds until the FlowFile penalty expires." - }, - "clusterNodeId" : { - "type" : "string", - "description" : "The id of the node where this FlowFile resides." - }, - "clusterNodeAddress" : { - "type" : "string", - "description" : "The label for the node where this FlowFile resides." - }, - "attributes" : { - "type" : "object", - "description" : "The FlowFile attributes.", - "additionalProperties" : { - "type" : "string" - } - }, - "contentClaimSection" : { - "type" : "string", - "description" : "The section in which the content claim lives." - }, - "contentClaimContainer" : { - "type" : "string", - "description" : "The container in which the content claim lives." - }, - "contentClaimIdentifier" : { - "type" : "string", - "description" : "The identifier of the content claim." - }, - "contentClaimOffset" : { - "type" : "integer", - "format" : "int64", - "description" : "The offset into the content claim where the flowfile's content begins." - }, - "contentClaimFileSize" : { - "type" : "string", - "description" : "The file size of the content claim formatted." - }, - "contentClaimFileSizeBytes" : { - "type" : "integer", - "format" : "int64", - "description" : "The file size of the content claim in bytes." - }, - "penalized" : { - "type" : "boolean", - "description" : "If the FlowFile is penalized." - } - } - }, - "FlowFileEntity" : { - "type" : "object", - "properties" : { - "flowFile" : { - "$ref" : "#/definitions/FlowFileDTO" - } - }, - "xml" : { - "name" : "flowFileEntity" - } - }, - "FlowFileSummaryDTO" : { - "type" : "object", - "properties" : { - "uri" : { - "type" : "string", - "description" : "The URI that can be used to access this FlowFile." - }, - "uuid" : { - "type" : "string", - "description" : "The FlowFile UUID." - }, - "filename" : { - "type" : "string", - "description" : "The FlowFile filename." - }, - "position" : { - "type" : "integer", - "format" : "int32", - "description" : "The FlowFile's position in the queue." - }, - "size" : { - "type" : "integer", - "format" : "int64", - "description" : "The FlowFile file size." - }, - "queuedDuration" : { - "type" : "integer", - "format" : "int64", - "description" : "How long this FlowFile has been enqueued." - }, - "lineageDuration" : { - "type" : "integer", - "format" : "int64", - "description" : "Duration since the FlowFile's greatest ancestor entered the flow." - }, - "penaltyExpiresIn" : { - "type" : "integer", - "format" : "int64", - "description" : "How long in milliseconds until the FlowFile penalty expires." - }, - "clusterNodeId" : { - "type" : "string", - "description" : "The id of the node where this FlowFile resides." - }, - "clusterNodeAddress" : { - "type" : "string", - "description" : "The label for the node where this FlowFile resides." - }, - "penalized" : { - "type" : "boolean", - "description" : "If the FlowFile is penalized." - } - } - }, - "FlowRegistryBucket" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string" - }, - "name" : { - "type" : "string" - }, - "description" : { - "type" : "string" - }, - "createdTimestamp" : { - "type" : "integer", - "format" : "int64" - }, - "permissions" : { - "$ref" : "#/definitions/FlowRegistryPermissions" - } - } - }, - "FlowRegistryBucketDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The bucket identifier" - }, - "name" : { - "type" : "string", - "description" : "The bucket name" - }, - "description" : { - "type" : "string", - "description" : "The bucket description" - }, - "created" : { - "type" : "integer", - "format" : "int64", - "description" : "The created timestamp of this bucket" - } - } - }, - "FlowRegistryBucketEntity" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string" - }, - "bucket" : { - "$ref" : "#/definitions/FlowRegistryBucketDTO" - }, - "permissions" : { - "$ref" : "#/definitions/PermissionsDTO" - } - }, - "xml" : { - "name" : "bucketEntity" - } - }, - "FlowRegistryBucketsEntity" : { - "type" : "object", - "properties" : { - "buckets" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/FlowRegistryBucketEntity" - } - } - }, - "xml" : { - "name" : "bucketsEntity" - } - }, - "FlowRegistryClientDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The registry identifier" - }, - "name" : { - "type" : "string", - "description" : "The registry name" - }, - "description" : { - "type" : "string", - "description" : "The registry description" - }, - "uri" : { - "type" : "string" - }, - "type" : { - "type" : "string", - "description" : "The type of the controller service." - }, - "bundle" : { - "description" : "The details of the artifact that bundled this processor type.", - "$ref" : "#/definitions/BundleDTO" - }, - "properties" : { - "type" : "object", - "description" : "The properties of the controller service.", - "additionalProperties" : { - "type" : "string" - } - }, - "descriptors" : { - "type" : "object", - "description" : "The descriptors for the controller service properties.", - "additionalProperties" : { - "$ref" : "#/definitions/PropertyDescriptorDTO" - } - }, - "sensitiveDynamicPropertyNames" : { - "type" : "array", - "description" : "Set of sensitive dynamic property names", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - }, - "supportsSensitiveDynamicProperties" : { - "type" : "boolean", - "description" : "Whether the reporting task supports sensitive dynamic properties." - }, - "restricted" : { - "type" : "boolean", - "description" : "Whether the reporting task requires elevated privileges." - }, - "deprecated" : { - "type" : "boolean", - "description" : "Whether the reporting task has been deprecated." - }, - "validationErrors" : { - "type" : "array", - "description" : "Gets the validation errors from the reporting task. These validation errors represent the problems with the reporting task that must be resolved before it can be scheduled to run.", - "items" : { - "type" : "string" - } - }, - "validationStatus" : { - "type" : "string", - "description" : "Indicates whether the Processor is valid, invalid, or still in the process of validating (i.e., it is unknown whether or not the Processor is valid)", - "readOnly" : true, - "enum" : [ "VALID", "INVALID", "VALIDATING" ] - }, - "annotationData" : { - "type" : "string", - "description" : "The annotation data for the repoting task. This is how the custom UI relays configuration to the reporting task." - }, - "extensionMissing" : { - "type" : "boolean", - "description" : "Whether the underlying extension is missing." - }, - "multipleVersionsAvailable" : { - "type" : "boolean", - "description" : "Whether the flow registry client has multiple versions available." - } - } - }, - "FlowRegistryClientEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "registry" : { - "$ref" : "#/definitions/FlowRegistryClientDTO" - }, - "operatePermissions" : { - "$ref" : "#/definitions/PermissionsDTO" - }, - "component" : { - "$ref" : "#/definitions/FlowRegistryClientDTO" - } - }, - "xml" : { - "name" : "registryClientEntity" - } - }, - "FlowRegistryClientTypesEntity" : { - "type" : "object", - "properties" : { - "flowRegistryClientTypes" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/DocumentedTypeDTO" - } - } - }, - "xml" : { - "name" : "flowRegistryClientTypesEntity" - } - }, - "FlowRegistryClientsEntity" : { - "type" : "object", - "properties" : { - "registries" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/FlowRegistryClientEntity" - } - } - }, - "xml" : { - "name" : "registryClientsEntity" - } - }, - "FlowRegistryPermissions" : { - "type" : "object", - "properties" : { - "canRead" : { - "type" : "boolean" - }, - "canWrite" : { - "type" : "boolean" - }, - "canDelete" : { - "type" : "boolean" - } - } - }, - "FlowSnippetDTO" : { - "type" : "object", - "properties" : { - "processGroups" : { - "type" : "array", - "description" : "The process groups in this flow snippet.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ProcessGroupDTO" - } - }, - "remoteProcessGroups" : { - "type" : "array", - "description" : "The remote process groups in this flow snippet.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/RemoteProcessGroupDTO" - } - }, - "processors" : { - "type" : "array", - "description" : "The processors in this flow snippet.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ProcessorDTO" - } - }, - "inputPorts" : { - "type" : "array", - "description" : "The input ports in this flow snippet.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/PortDTO" - } - }, - "outputPorts" : { - "type" : "array", - "description" : "The output ports in this flow snippet.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/PortDTO" - } - }, - "connections" : { - "type" : "array", - "description" : "The connections in this flow snippet.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ConnectionDTO" - } - }, - "labels" : { - "type" : "array", - "description" : "The labels in this flow snippet.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/LabelDTO" - } - }, - "funnels" : { - "type" : "array", - "description" : "The funnels in this flow snippet.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/FunnelDTO" - } - }, - "controllerServices" : { - "type" : "array", - "description" : "The controller services in this flow snippet.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ControllerServiceDTO" - } - } - } - }, - "FunnelDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "versionedComponentId" : { - "type" : "string", - "description" : "The ID of the corresponding component that is under version control" - }, - "parentGroupId" : { - "type" : "string", - "description" : "The id of parent process group of this component if applicable." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - } - } - }, - "FunnelEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "component" : { - "$ref" : "#/definitions/FunnelDTO" - } - }, - "xml" : { - "name" : "funnelEntity" - } - }, - "FunnelsEntity" : { - "type" : "object", - "properties" : { - "funnels" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/FunnelEntity" - } - } - }, - "xml" : { - "name" : "funnelsEntity" - } - }, - "GCDiagnosticsSnapshotDTO" : { - "type" : "object", - "properties" : { - "timestamp" : { - "type" : "string", - "format" : "date-time", - "description" : "The timestamp of when the Snapshot was taken" - }, - "collectionCount" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of times that Garbage Collection has occurred" - }, - "collectionMillis" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of milliseconds that the Garbage Collector spent performing Garbage Collection duties" - } - } - }, - "GarbageCollectionDTO" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The name of the garbage collector." - }, - "collectionCount" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of times garbage collection has run." - }, - "collectionTime" : { - "type" : "string", - "description" : "The total amount of time spent garbage collecting." - }, - "collectionMillis" : { - "type" : "integer", - "format" : "int64", - "description" : "The total number of milliseconds spent garbage collecting." - } - } - }, - "GarbageCollectionDiagnosticsDTO" : { - "type" : "object", - "properties" : { - "memoryManagerName" : { - "type" : "string", - "description" : "The name of the Memory Manager that this Garbage Collection information pertains to" - }, - "snapshots" : { - "type" : "array", - "description" : "A list of snapshots that have been taken to determine the health of the JVM's heap", - "items" : { - "$ref" : "#/definitions/GCDiagnosticsSnapshotDTO" - } - } - } - }, - "HistoryDTO" : { - "type" : "object", - "properties" : { - "total" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of number of actions that matched the search criteria.." - }, - "lastRefreshed" : { - "type" : "string", - "description" : "The timestamp when the report was generated." - }, - "actions" : { - "type" : "array", - "description" : "The actions.", - "items" : { - "$ref" : "#/definitions/ActionEntity" - } - } - } - }, - "HistoryEntity" : { - "type" : "object", - "properties" : { - "history" : { - "$ref" : "#/definitions/HistoryDTO" - } - }, - "xml" : { - "name" : "historyEntity" - } - }, - "InputPortsEntity" : { - "type" : "object", - "properties" : { - "inputPorts" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/PortEntity" - } - } - }, - "xml" : { - "name" : "inputPortsEntity" - } - }, - "InputStream" : { - "type" : "object" - }, - "InstantiateTemplateRequestEntity" : { - "type" : "object", - "properties" : { - "originX" : { - "type" : "number", - "format" : "double", - "description" : "The x coordinate of the origin of the bounding box where the new components will be placed." - }, - "originY" : { - "type" : "number", - "format" : "double", - "description" : "The y coordinate of the origin of the bounding box where the new components will be placed." - }, - "templateId" : { - "type" : "string", - "description" : "The identifier of the template." - }, - "encodingVersion" : { - "type" : "string", - "description" : "The encoding version of the flow snippet. If not specified, this is automatically populated by the node receiving the user request. If the snippet is specified, the version will be the latest. If the snippet is not specified, the version will come from the underlying template. These details need to be replicated throughout the cluster to ensure consistency." - }, - "snippet" : { - "description" : "A flow snippet of the template contents. If not specified, this is automatically populated by the node receiving the user request. These details need to be replicated throughout the cluster to ensure consistency.", - "$ref" : "#/definitions/FlowSnippetDTO" - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - } - }, - "xml" : { - "name" : "instantiateTemplateRequestEntity" - } - }, - "JVMControllerDiagnosticsSnapshotDTO" : { - "type" : "object", - "properties" : { - "primaryNode" : { - "type" : "boolean", - "description" : "Whether or not this node is primary node" - }, - "clusterCoordinator" : { - "type" : "boolean", - "description" : "Whether or not this node is cluster coordinator" - }, - "maxTimerDrivenThreads" : { - "type" : "integer", - "format" : "int32", - "description" : "The maximum number of timer-driven threads" - }, - "maxEventDrivenThreads" : { - "type" : "integer", - "format" : "int32", - "description" : "The maximum number of event-driven threads" - } - } - }, - "JVMDiagnosticsDTO" : { - "type" : "object", - "properties" : { - "clustered" : { - "type" : "boolean", - "description" : "Whether or not the NiFi instance is clustered" - }, - "connected" : { - "type" : "boolean", - "description" : "Whether or not the node is connected to the cluster" - }, - "aggregateSnapshot" : { - "description" : "Aggregate JVM diagnostic information about the entire cluster", - "$ref" : "#/definitions/JVMDiagnosticsSnapshotDTO" - }, - "nodeSnapshots" : { - "type" : "array", - "description" : "Node-wise breakdown of JVM diagnostic information", - "items" : { - "$ref" : "#/definitions/NodeJVMDiagnosticsSnapshotDTO" - } - } - } - }, - "JVMDiagnosticsSnapshotDTO" : { - "type" : "object", - "properties" : { - "systemDiagnosticsDto" : { - "description" : "System-related diagnostics information", - "$ref" : "#/definitions/JVMSystemDiagnosticsSnapshotDTO" - }, - "flowDiagnosticsDto" : { - "description" : "Flow-related diagnostics information", - "$ref" : "#/definitions/JVMFlowDiagnosticsSnapshotDTO" - }, - "controllerDiagnostics" : { - "description" : "Controller-related diagnostics information", - "$ref" : "#/definitions/JVMControllerDiagnosticsSnapshotDTO" - } - } - }, - "JVMFlowDiagnosticsSnapshotDTO" : { - "type" : "object", - "properties" : { - "uptime" : { - "type" : "string", - "description" : "How long this node has been running, formatted as hours:minutes:seconds.milliseconds" - }, - "timeZone" : { - "type" : "string", - "description" : "The name of the Time Zone that is configured, if available" - }, - "activeTimerDrivenThreads" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of timer-driven threads that are active" - }, - "activeEventDrivenThreads" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of event-driven threads that are active" - }, - "bundlesLoaded" : { - "type" : "array", - "description" : "The NiFi Bundles (NARs) that are loaded by NiFi", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/BundleDTO" - } - } - } - }, - "JVMSystemDiagnosticsSnapshotDTO" : { - "type" : "object", - "properties" : { - "flowFileRepositoryStorageUsage" : { - "description" : "Information about the FlowFile Repository's usage", - "$ref" : "#/definitions/RepositoryUsageDTO" - }, - "contentRepositoryStorageUsage" : { - "type" : "array", - "description" : "Information about the Content Repository's usage", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/RepositoryUsageDTO" - } - }, - "provenanceRepositoryStorageUsage" : { - "type" : "array", - "description" : "Information about the Provenance Repository's usage", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/RepositoryUsageDTO" - } - }, - "maxHeapBytes" : { - "type" : "integer", - "format" : "int64", - "description" : "The maximum number of bytes that the JVM heap is configured to use for heap" - }, - "maxHeap" : { - "type" : "string", - "description" : "The maximum number of bytes that the JVM heap is configured to use, as a human-readable value" - }, - "garbageCollectionDiagnostics" : { - "type" : "array", - "description" : "Diagnostic information about the JVM's garbage collections", - "items" : { - "$ref" : "#/definitions/GarbageCollectionDiagnosticsDTO" - } - }, - "cpuCores" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of CPU Cores available on the system" - }, - "cpuLoadAverage" : { - "type" : "number", - "format" : "double", - "description" : "The 1-minute CPU Load Average" - }, - "physicalMemoryBytes" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes of RAM available on the system" - }, - "physicalMemory" : { - "type" : "string", - "description" : "The number of bytes of RAM available on the system as a human-readable value" - }, - "openFileDescriptors" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of files that are open by the NiFi process" - }, - "maxOpenFileDescriptors" : { - "type" : "integer", - "format" : "int64", - "description" : "The maximum number of open file descriptors that are available to each process" - } - } - }, - "JmxMetricsResultDTO" : { - "type" : "object", - "properties" : { - "beanName" : { - "type" : "string", - "description" : "The bean name of the metrics bean." - }, - "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" - } - } - }, - "JmxMetricsResultsEntity" : { - "type" : "object", - "properties" : { - "jmxMetricsResults" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/JmxMetricsResultDTO" - } - } - }, - "xml" : { - "name" : "jmxMetricsResult" - } - }, - "LabelDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "versionedComponentId" : { - "type" : "string", - "description" : "The ID of the corresponding component that is under version control" - }, - "parentGroupId" : { - "type" : "string", - "description" : "The id of parent process group of this component if applicable." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "label" : { - "type" : "string", - "description" : "The text that appears in the label." - }, - "width" : { - "type" : "number", - "format" : "double", - "description" : "The width of the label in pixels when at a 1:1 scale." - }, - "height" : { - "type" : "number", - "format" : "double", - "description" : "The height of the label in pixels when at a 1:1 scale." - }, - "getzIndex" : { - "type" : "integer", - "format" : "int64", - "description" : "The z index of the label." - }, - "style" : { - "type" : "object", - "description" : "The styles for this label (font-size : 12px, background-color : #eee, etc).", - "additionalProperties" : { - "type" : "string" - } - } - } - }, - "LabelEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "dimensions" : { - "$ref" : "#/definitions/DimensionsDTO" - }, - "getzIndex" : { - "type" : "integer", - "format" : "int64", - "description" : "The z index of the label." - }, - "component" : { - "$ref" : "#/definitions/LabelDTO" - } - }, - "xml" : { - "name" : "labelEntity" - } - }, - "LabelsEntity" : { - "type" : "object", - "properties" : { - "labels" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/LabelEntity" - } - } - }, - "xml" : { - "name" : "labelsEntity" - } - }, - "LineageDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of this lineage query." - }, - "uri" : { - "type" : "string", - "description" : "The URI for this lineage query for later retrieval and deletion." - }, - "submissionTime" : { - "type" : "string", - "description" : "When the lineage query was submitted." - }, - "expiration" : { - "type" : "string", - "description" : "When the lineage query will expire." - }, - "percentCompleted" : { - "type" : "integer", - "format" : "int32", - "description" : "The percent complete for the lineage query." - }, - "finished" : { - "type" : "boolean", - "description" : "Whether the lineage query has finished." - }, - "request" : { - "description" : "The initial lineage result.", - "$ref" : "#/definitions/LineageRequestDTO" - }, - "results" : { - "description" : "The results of the lineage query.", - "$ref" : "#/definitions/LineageResultsDTO" - } - } - }, - "LineageEntity" : { - "type" : "object", - "properties" : { - "lineage" : { - "$ref" : "#/definitions/LineageDTO" - } - }, - "xml" : { - "name" : "lineageEntity" - } - }, - "LineageRequestDTO" : { - "type" : "object", - "properties" : { - "eventId" : { - "type" : "integer", - "format" : "int64", - "description" : "The event id that was used to generate this lineage, if applicable. The event id is allowed for any type of lineageRequestType. If the lineageRequestType is FLOWFILE and the flowfile uuid is also included in the request, the event id will be ignored." - }, - "lineageRequestType" : { - "type" : "string", - "description" : "The type of lineage request. PARENTS will return the lineage for the flowfiles that are parents of the specified event. CHILDREN will return the lineage for the flowfiles that are children of the specified event. FLOWFILE will return the lineage for the specified flowfile.", - "enum" : [ "PARENTS", "CHILDREN", "and FLOWFILE" ] - }, - "uuid" : { - "type" : "string", - "description" : "The flowfile uuid that was used to generate the lineage. The flowfile uuid is only allowed when the lineageRequestType is FLOWFILE and will take precedence over event id." - }, - "clusterNodeId" : { - "type" : "string", - "description" : "The id of the node where this lineage originated if clustered." - } - } - }, - "LineageResultsDTO" : { - "type" : "object", - "properties" : { - "errors" : { - "type" : "array", - "description" : "Any errors that occurred while generating the lineage.", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - }, - "nodes" : { - "type" : "array", - "description" : "The nodes in the lineage.", - "items" : { - "$ref" : "#/definitions/ProvenanceNodeDTO" - } - }, - "links" : { - "type" : "array", - "description" : "The links between the nodes in the lineage.", - "items" : { - "$ref" : "#/definitions/ProvenanceLinkDTO" - } - } - } - }, - "ListingRequestDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id for this listing request." - }, - "uri" : { - "type" : "string", - "description" : "The URI for future requests to this listing request." - }, - "submissionTime" : { - "type" : "string", - "description" : "The timestamp when the query was submitted." - }, - "lastUpdated" : { - "type" : "string", - "description" : "The last time this listing request was updated." - }, - "percentCompleted" : { - "type" : "integer", - "format" : "int32", - "description" : "The current percent complete." - }, - "finished" : { - "type" : "boolean", - "description" : "Whether the query has finished." - }, - "failureReason" : { - "type" : "string", - "description" : "The reason, if any, that this listing request failed." - }, - "maxResults" : { - "type" : "integer", - "format" : "int32", - "description" : "The maximum number of FlowFileSummary objects to return" - }, - "state" : { - "type" : "string", - "description" : "The current state of the listing request." - }, - "queueSize" : { - "description" : "The size of the queue", - "$ref" : "#/definitions/QueueSizeDTO" - }, - "flowFileSummaries" : { - "type" : "array", - "description" : "The FlowFile summaries. The summaries will be populated once the request has completed.", - "items" : { - "$ref" : "#/definitions/FlowFileSummaryDTO" - } - }, - "destinationRunning" : { - "type" : "boolean", - "description" : "Whether the destination of the connection is running" - }, - "sourceRunning" : { - "type" : "boolean", - "description" : "Whether the source of the connection is running" - } - } - }, - "ListingRequestEntity" : { - "type" : "object", - "properties" : { - "listingRequest" : { - "$ref" : "#/definitions/ListingRequestDTO" - } - }, - "xml" : { - "name" : "listingRequestEntity" - } - }, - "LocalQueuePartitionDTO" : { - "type" : "object", - "properties" : { - "totalFlowFileCount" : { - "type" : "integer", - "format" : "int32", - "description" : "Total number of FlowFiles owned by the Connection" - }, - "totalByteCount" : { - "type" : "integer", - "format" : "int64", - "description" : "Total number of bytes that make up the content for the FlowFiles owned by this Connection" - }, - "activeQueueFlowFileCount" : { - "type" : "integer", - "format" : "int32", - "description" : "Total number of FlowFiles that exist in the Connection's Active Queue, immediately available to be offered up to a component" - }, - "activeQueueByteCount" : { - "type" : "integer", - "format" : "int64", - "description" : "Total number of bytes that make up the content for the FlowFiles that are present in the Connection's Active Queue" - }, - "swapFlowFileCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The total number of FlowFiles that are swapped out for this Connection" - }, - "swapByteCount" : { - "type" : "integer", - "format" : "int64", - "description" : "Total number of bytes that make up the content for the FlowFiles that are swapped out to disk for the Connection" - }, - "swapFiles" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of Swap Files that exist for this Connection" - }, - "inFlightFlowFileCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of In-Flight FlowFiles for this Connection. These are FlowFiles that belong to the connection but are currently being operated on by a Processor, Port, etc." - }, - "inFlightByteCount" : { - "type" : "integer", - "format" : "int64", - "description" : "The number bytes that make up the content of the FlowFiles that are In-Flight" - }, - "allActiveQueueFlowFilesPenalized" : { - "type" : "boolean", - "description" : "Whether or not all of the FlowFiles in the Active Queue are penalized" - }, - "anyActiveQueueFlowFilesPenalized" : { - "type" : "boolean", - "description" : "Whether or not any of the FlowFiles in the Active Queue are penalized" - } - } - }, - "NodeConnectionStatisticsSnapshotDTO" : { - "type" : "object", - "properties" : { - "nodeId" : { - "type" : "string", - "description" : "The unique ID that identifies the node" - }, - "address" : { - "type" : "string", - "description" : "The API address of the node" - }, - "apiPort" : { - "type" : "integer", - "format" : "int32", - "description" : "The API port used to communicate with the node" - }, - "statisticsSnapshot" : { - "description" : "The connection status snapshot from the node.", - "$ref" : "#/definitions/ConnectionStatisticsSnapshotDTO" - } - } - }, - "NodeConnectionStatusSnapshotDTO" : { - "type" : "object", - "properties" : { - "nodeId" : { - "type" : "string", - "description" : "The unique ID that identifies the node" - }, - "address" : { - "type" : "string", - "description" : "The API address of the node" - }, - "apiPort" : { - "type" : "integer", - "format" : "int32", - "description" : "The API port used to communicate with the node" - }, - "statusSnapshot" : { - "description" : "The connection status snapshot from the node.", - "$ref" : "#/definitions/ConnectionStatusSnapshotDTO" - } - } - }, - "NodeCountersSnapshotDTO" : { - "type" : "object", - "properties" : { - "nodeId" : { - "type" : "string", - "description" : "The unique ID that identifies the node" - }, - "address" : { - "type" : "string", - "description" : "The API address of the node" - }, - "apiPort" : { - "type" : "integer", - "format" : "int32", - "description" : "The API port used to communicate with the node" - }, - "snapshot" : { - "description" : "The counters from the node.", - "$ref" : "#/definitions/CountersSnapshotDTO" - } - } - }, - "NodeDTO" : { - "type" : "object", - "properties" : { - "nodeId" : { - "type" : "string", - "description" : "The id of the node.", - "readOnly" : true - }, - "address" : { - "type" : "string", - "description" : "The node's host/ip address.", - "readOnly" : true - }, - "apiPort" : { - "type" : "integer", - "format" : "int32", - "description" : "The port the node is listening for API requests.", - "readOnly" : true - }, - "status" : { - "type" : "string", - "description" : "The node's status." - }, - "heartbeat" : { - "type" : "string", - "description" : "the time of the nodes's last heartbeat.", - "readOnly" : true - }, - "connectionRequested" : { - "type" : "string", - "description" : "The time of the node's last connection request.", - "readOnly" : true - }, - "roles" : { - "type" : "array", - "description" : "The roles of this node.", - "readOnly" : true, - "uniqueItems" : true, - "items" : { - "type" : "string" - } - }, - "activeThreadCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The active threads for the NiFi on the node.", - "readOnly" : true - }, - "queued" : { - "type" : "string", - "description" : "The queue the NiFi on the node.", - "readOnly" : true - }, - "events" : { - "type" : "array", - "description" : "The node's events.", - "readOnly" : true, - "items" : { - "$ref" : "#/definitions/NodeEventDTO" - } - }, - "nodeStartTime" : { - "type" : "string", - "description" : "The time at which this Node was last refreshed.", - "readOnly" : true - } - } - }, - "NodeEntity" : { - "type" : "object", - "properties" : { - "node" : { - "$ref" : "#/definitions/NodeDTO" - } - }, - "xml" : { - "name" : "nodeEntity" - } - }, - "NodeEventDTO" : { - "type" : "object", - "properties" : { - "timestamp" : { - "type" : "string", - "description" : "The timestamp of the node event." - }, - "category" : { - "type" : "string", - "description" : "The category of the node event." - }, - "message" : { - "type" : "string", - "description" : "The message in the node event." - } - } - }, - "NodeIdentifier" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string" - }, - "apiAddress" : { - "type" : "string" - }, - "apiPort" : { - "type" : "integer", - "format" : "int32" - }, - "socketAddress" : { - "type" : "string" - }, - "socketPort" : { - "type" : "integer", - "format" : "int32" - }, - "loadBalanceAddress" : { - "type" : "string" - }, - "loadBalancePort" : { - "type" : "integer", - "format" : "int32" - }, - "siteToSiteAddress" : { - "type" : "string" - }, - "siteToSitePort" : { - "type" : "integer", - "format" : "int32" - }, - "siteToSiteHttpApiPort" : { - "type" : "integer", - "format" : "int32" - }, - "siteToSiteSecure" : { - "type" : "boolean" - }, - "nodeIdentities" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - }, - "fullDescription" : { - "type" : "string" - } - } - }, - "NodeJVMDiagnosticsSnapshotDTO" : { - "type" : "object", - "properties" : { - "nodeId" : { - "type" : "string", - "description" : "The unique ID that identifies the node" - }, - "address" : { - "type" : "string", - "description" : "The API address of the node" - }, - "apiPort" : { - "type" : "integer", - "format" : "int32", - "description" : "The API port used to communicate with the node" - }, - "snapshot" : { - "description" : "The JVM Diagnostics Snapshot", - "$ref" : "#/definitions/JVMDiagnosticsSnapshotDTO" - } - } - }, - "NodePortStatusSnapshotDTO" : { - "type" : "object", - "properties" : { - "nodeId" : { - "type" : "string", - "description" : "The unique ID that identifies the node" - }, - "address" : { - "type" : "string", - "description" : "The API address of the node" - }, - "apiPort" : { - "type" : "integer", - "format" : "int32", - "description" : "The API port used to communicate with the node" - }, - "statusSnapshot" : { - "description" : "The port status snapshot from the node.", - "$ref" : "#/definitions/PortStatusSnapshotDTO" - } - } - }, - "NodeProcessGroupStatusSnapshotDTO" : { - "type" : "object", - "properties" : { - "nodeId" : { - "type" : "string", - "description" : "The unique ID that identifies the node" - }, - "address" : { - "type" : "string", - "description" : "The API address of the node" - }, - "apiPort" : { - "type" : "integer", - "format" : "int32", - "description" : "The API port used to communicate with the node" - }, - "statusSnapshot" : { - "description" : "The process group status snapshot from the node.", - "$ref" : "#/definitions/ProcessGroupStatusSnapshotDTO" - } - } - }, - "NodeProcessorStatusSnapshotDTO" : { - "type" : "object", - "properties" : { - "nodeId" : { - "type" : "string", - "description" : "The unique ID that identifies the node" - }, - "address" : { - "type" : "string", - "description" : "The API address of the node" - }, - "apiPort" : { - "type" : "integer", - "format" : "int32", - "description" : "The API port used to communicate with the node" - }, - "statusSnapshot" : { - "description" : "The processor status snapshot from the node.", - "$ref" : "#/definitions/ProcessorStatusSnapshotDTO" - } - } - }, - "NodeRemoteProcessGroupStatusSnapshotDTO" : { - "type" : "object", - "properties" : { - "nodeId" : { - "type" : "string", - "description" : "The unique ID that identifies the node" - }, - "address" : { - "type" : "string", - "description" : "The API address of the node" - }, - "apiPort" : { - "type" : "integer", - "format" : "int32", - "description" : "The API port used to communicate with the node" - }, - "statusSnapshot" : { - "description" : "The remote process group status snapshot from the node.", - "$ref" : "#/definitions/RemoteProcessGroupStatusSnapshotDTO" - } - } - }, - "NodeReplayLastEventSnapshotDTO" : { - "type" : "object", - "properties" : { - "nodeId" : { - "type" : "string", - "description" : "The unique ID that identifies the node" - }, - "address" : { - "type" : "string", - "description" : "The API address of the node" - }, - "apiPort" : { - "type" : "integer", - "format" : "int32", - "description" : "The API port used to communicate with the node" - }, - "snapshot" : { - "description" : "The snapshot from the node", - "$ref" : "#/definitions/ReplayLastEventSnapshotDTO" - } - }, - "xml" : { - "name" : "nodeReplayLastEventSnapshot" - } - }, - "NodeResponse" : { - "type" : "object", - "properties" : { - "httpMethod" : { - "type" : "string" - }, - "requestUri" : { - "type" : "string", - "format" : "uri" - }, - "response" : { - "$ref" : "#/definitions/Response" - }, - "nodeId" : { - "$ref" : "#/definitions/NodeIdentifier" - }, - "throwable" : { - "$ref" : "#/definitions/Throwable" - }, - "updatedEntity" : { - "$ref" : "#/definitions/Entity" - }, - "requestId" : { - "type" : "string" - }, - "inputStream" : { - "$ref" : "#/definitions/InputStream" - }, - "status" : { - "type" : "integer", - "format" : "int32" - }, - "clientResponse" : { - "$ref" : "#/definitions/Response" - }, - "is5xx" : { - "type" : "boolean" - }, - "is2xx" : { - "type" : "boolean" - } - } - }, - "NodeSearchResultDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the node that matched the search." - }, - "address" : { - "type" : "string", - "description" : "The address of the node that matched the search." - } - } - }, - "NodeStatusSnapshotsDTO" : { - "type" : "object", - "properties" : { - "nodeId" : { - "type" : "string", - "description" : "The id of the node." - }, - "address" : { - "type" : "string", - "description" : "The node's host/ip address." - }, - "apiPort" : { - "type" : "integer", - "format" : "int32", - "description" : "The port the node is listening for API requests." - }, - "statusSnapshots" : { - "type" : "array", - "description" : "A list of StatusSnapshotDTO objects that provide the actual metric values for the component for this node.", - "items" : { - "$ref" : "#/definitions/StatusSnapshotDTO" - } - } - } - }, - "NodeSystemDiagnosticsSnapshotDTO" : { - "type" : "object", - "properties" : { - "nodeId" : { - "type" : "string", - "description" : "The unique ID that identifies the node" - }, - "address" : { - "type" : "string", - "description" : "The API address of the node" - }, - "apiPort" : { - "type" : "integer", - "format" : "int32", - "description" : "The API port used to communicate with the node" - }, - "snapshot" : { - "description" : "The System Diagnostics snapshot from the node.", - "$ref" : "#/definitions/SystemDiagnosticsSnapshotDTO" - } - } - }, - "OutputPortsEntity" : { - "type" : "object", - "properties" : { - "outputPorts" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/PortEntity" - } - } - }, - "xml" : { - "name" : "outputPortsEntity" - } - }, - "ParameterContextDTO" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The Name of the Parameter Context." - }, - "description" : { - "type" : "string", - "description" : "The Description of the Parameter Context." - }, - "parameters" : { - "type" : "array", - "description" : "The Parameters for the Parameter Context", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ParameterEntity" - } - }, - "boundProcessGroups" : { - "type" : "array", - "description" : "The Process Groups that are bound to this Parameter Context", - "readOnly" : true, - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ProcessGroupEntity" - } - }, - "inheritedParameterContexts" : { - "type" : "array", - "description" : "A list of references of Parameter Contexts from which this one inherits parameters", - "items" : { - "$ref" : "#/definitions/ParameterContextReferenceEntity" - } - }, - "parameterProviderConfiguration" : { - "description" : "Optional configuration for a Parameter Provider", - "$ref" : "#/definitions/ParameterProviderConfigurationEntity" - }, - "id" : { - "type" : "string", - "description" : "The ID the Parameter Context.", - "readOnly" : true - } - } - }, - "ParameterContextEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "component" : { - "description" : "The Parameter Context", - "$ref" : "#/definitions/ParameterContextDTO" - } - }, - "xml" : { - "name" : "parameterContextEntity" - } - }, - "ParameterContextReferenceDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The ID of the Parameter Context" - }, - "name" : { - "type" : "string", - "description" : "The name of the Parameter Context" - } - } - }, - "ParameterContextReferenceEntity" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "component" : { - "$ref" : "#/definitions/ParameterContextReferenceDTO" - } - }, - "xml" : { - "name" : "parameterContextReferenceEntity" - } - }, - "ParameterContextUpdateEntity" : { - "type" : "object", - "properties" : { - "parameterContextRevision" : { - "description" : "The Revision of the Parameter Context", - "$ref" : "#/definitions/RevisionDTO" - }, - "parameterContext" : { - "description" : "The Parameter Context that is being operated on. This may not be populated until the request has successfully completed.", - "readOnly" : true, - "$ref" : "#/definitions/ParameterContextDTO" - }, - "referencingComponents" : { - "type" : "array", - "description" : "The components that are referenced by the update.", - "readOnly" : true, - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/AffectedComponentEntity" - } - } - }, - "xml" : { - "name" : "parameterContextUpdateEntity" - } - }, - "ParameterContextUpdateRequestDTO" : { - "type" : "object", - "properties" : { - "requestId" : { - "type" : "string", - "description" : "The ID of the request", - "readOnly" : true - }, - "uri" : { - "type" : "string", - "description" : "The URI for the request", - "readOnly" : true - }, - "submissionTime" : { - "type" : "string", - "format" : "date-time", - "description" : "The timestamp of when the request was submitted", - "readOnly" : true - }, - "lastUpdated" : { - "type" : "string", - "format" : "date-time", - "description" : "The timestamp of when the request was last updated", - "readOnly" : true - }, - "complete" : { - "type" : "boolean", - "description" : "Whether or not the request is completed", - "readOnly" : true - }, - "failureReason" : { - "type" : "string", - "description" : "The reason for the request failing, or null if the request has not failed", - "readOnly" : true - }, - "percentCompleted" : { - "type" : "integer", - "format" : "int32", - "description" : "A value between 0 and 100 (inclusive) indicating how close the request is to completion", - "readOnly" : true - }, - "state" : { - "type" : "string", - "description" : "A description of the current state of the request", - "readOnly" : true - }, - "updateSteps" : { - "type" : "array", - "description" : "The steps that are required in order to complete the request, along with the status of each", - "readOnly" : true, - "items" : { - "$ref" : "#/definitions/ParameterContextUpdateStepDTO" - } - }, - "parameterContext" : { - "description" : "The Parameter Context that is being operated on. This may not be populated until the request has successfully completed.", - "readOnly" : true, - "$ref" : "#/definitions/ParameterContextDTO" - }, - "referencingComponents" : { - "type" : "array", - "description" : "The components that are referenced by the update.", - "readOnly" : true, - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/AffectedComponentEntity" - } - } - } - }, - "ParameterContextUpdateRequestEntity" : { - "type" : "object", - "properties" : { - "parameterContextRevision" : { - "description" : "The Revision of the Parameter Context", - "$ref" : "#/definitions/RevisionDTO" - }, - "request" : { - "description" : "The Update Request", - "$ref" : "#/definitions/ParameterContextUpdateRequestDTO" - } - }, - "xml" : { - "name" : "parameterContextUpdateRequestEntity" - } - }, - "ParameterContextUpdateStepDTO" : { - "type" : "object", - "properties" : { - "description" : { - "type" : "string", - "description" : "Explanation of what happens in this step", - "readOnly" : true - }, - "complete" : { - "type" : "boolean", - "description" : "Whether or not this step has completed", - "readOnly" : true - }, - "failureReason" : { - "type" : "string", - "description" : "An explanation of why this step failed, or null if this step did not fail", - "readOnly" : true - } - } - }, - "ParameterContextValidationRequestDTO" : { - "type" : "object", - "properties" : { - "requestId" : { - "type" : "string", - "description" : "The ID of the request", - "readOnly" : true - }, - "uri" : { - "type" : "string", - "description" : "The URI for the request", - "readOnly" : true - }, - "submissionTime" : { - "type" : "string", - "format" : "date-time", - "description" : "The timestamp of when the request was submitted", - "readOnly" : true - }, - "lastUpdated" : { - "type" : "string", - "format" : "date-time", - "description" : "The timestamp of when the request was last updated", - "readOnly" : true - }, - "complete" : { - "type" : "boolean", - "description" : "Whether or not the request is completed", - "readOnly" : true - }, - "failureReason" : { - "type" : "string", - "description" : "The reason for the request failing, or null if the request has not failed", - "readOnly" : true - }, - "percentCompleted" : { - "type" : "integer", - "format" : "int32", - "description" : "A value between 0 and 100 (inclusive) indicating how close the request is to completion", - "readOnly" : true - }, - "state" : { - "type" : "string", - "description" : "A description of the current state of the request", - "readOnly" : true - }, - "updateSteps" : { - "type" : "array", - "description" : "The steps that are required in order to complete the request, along with the status of each", - "readOnly" : true, - "items" : { - "$ref" : "#/definitions/ParameterContextValidationStepDTO" - } - }, - "parameterContext" : { - "description" : "The Parameter Context that is being operated on.", - "$ref" : "#/definitions/ParameterContextDTO" - }, - "componentValidationResults" : { - "description" : "The Validation Results that were calculated for each component. This value may not be set until the request completes.", - "readOnly" : true, - "$ref" : "#/definitions/ComponentValidationResultsEntity" - } - } - }, - "ParameterContextValidationRequestEntity" : { - "type" : "object", - "properties" : { - "request" : { - "description" : "The Update Request", - "$ref" : "#/definitions/ParameterContextValidationRequestDTO" - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - } - }, - "xml" : { - "name" : "parameterContextValidationRequestEntity" - } - }, - "ParameterContextValidationStepDTO" : { - "type" : "object", - "properties" : { - "description" : { - "type" : "string", - "description" : "Explanation of what happens in this step", - "readOnly" : true - }, - "complete" : { - "type" : "boolean", - "description" : "Whether or not this step has completed", - "readOnly" : true - }, - "failureReason" : { - "type" : "string", - "description" : "An explanation of why this step failed, or null if this step did not fail", - "readOnly" : true - } - } - }, - "ParameterContextsEntity" : { - "type" : "object", - "properties" : { - "parameterContexts" : { - "type" : "array", - "description" : "The Parameter Contexts", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ParameterContextEntity" - } - }, - "currentTime" : { - "type" : "string", - "description" : "The current time on the system.", - "readOnly" : true - } - }, - "xml" : { - "name" : "parameterContexts" - } - }, - "ParameterDTO" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The name of the Parameter" - }, - "description" : { - "type" : "string", - "description" : "The description of the Parameter" - }, - "sensitive" : { - "type" : "boolean", - "description" : "Whether or not the Parameter is sensitive" - }, - "value" : { - "type" : "string", - "description" : "The value of the Parameter" - }, - "valueRemoved" : { - "type" : "boolean", - "description" : "Whether or not the value of the Parameter was removed. When a request is made to change a parameter, the value may be null. The 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). This denotes which of the two scenarios is being encountered." - }, - "provided" : { - "type" : "boolean", - "description" : "Whether or not the Parameter is provided by a ParameterProvider" - }, - "referencingComponents" : { - "type" : "array", - "description" : "The set of all components in the flow that are referencing this Parameter", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/AffectedComponentEntity" - } - }, - "parameterContext" : { - "description" : "A reference to the Parameter Context that contains this one", - "$ref" : "#/definitions/ParameterContextReferenceEntity" - }, - "inherited" : { - "type" : "boolean", - "description" : "Whether or not the Parameter is inherited from another context", - "readOnly" : true - } - } - }, - "ParameterEntity" : { - "type" : "object", - "properties" : { - "canWrite" : { - "type" : "boolean", - "description" : "Indicates whether the user can write a given resource.", - "readOnly" : true - }, - "parameter" : { - "description" : "The parameter information", - "$ref" : "#/definitions/ParameterDTO" - } - }, - "xml" : { - "name" : "parameterEntity" - } - }, - "ParameterGroupConfigurationEntity" : { - "type" : "object", - "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", - "description" : "All fetched parameter names that should be applied.", - "additionalProperties" : { - "type" : "string", - "enum" : [ "SENSITIVE", "NON_SENSITIVE" ] - } - }, - "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", - "properties" : { - "requestId" : { - "type" : "string", - "description" : "The ID of the request", - "readOnly" : true - }, - "uri" : { - "type" : "string", - "description" : "The URI for the request", - "readOnly" : true - }, - "submissionTime" : { - "type" : "string", - "format" : "date-time", - "description" : "The timestamp of when the request was submitted", - "readOnly" : true - }, - "lastUpdated" : { - "type" : "string", - "format" : "date-time", - "description" : "The timestamp of when the request was last updated", - "readOnly" : true - }, - "complete" : { - "type" : "boolean", - "description" : "Whether or not the request is completed", - "readOnly" : true - }, - "failureReason" : { - "type" : "string", - "description" : "The reason for the request failing, or null if the request has not failed", - "readOnly" : true - }, - "percentCompleted" : { - "type" : "integer", - "format" : "int32", - "description" : "A value between 0 and 100 (inclusive) indicating how close the request is to completion", - "readOnly" : true - }, - "state" : { - "type" : "string", - "description" : "A description of the current state of the request", - "readOnly" : true - }, - "updateSteps" : { - "type" : "array", - "description" : "The steps that are required in order to complete the request, along with the status of each", - "readOnly" : true, - "items" : { - "$ref" : "#/definitions/ParameterProviderApplyParametersUpdateStepDTO" - } - }, - "parameterProvider" : { - "description" : "The Parameter Provider that is being operated on. This may not be populated until the request has successfully completed.", - "readOnly" : true, - "$ref" : "#/definitions/ParameterProviderDTO" - }, - "parameterContextUpdates" : { - "type" : "array", - "description" : "The Parameter Contexts updated by this Parameter Provider. This may not be populated until the request has successfully completed.", - "readOnly" : true, - "items" : { - "$ref" : "#/definitions/ParameterContextUpdateEntity" - } - }, - "referencingComponents" : { - "type" : "array", - "description" : "The components that are referenced by the update.", - "readOnly" : true, - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/AffectedComponentEntity" - } - } - } - }, - "ParameterProviderApplyParametersRequestEntity" : { - "type" : "object", - "properties" : { - "request" : { - "description" : "The Apply Parameters Request", - "$ref" : "#/definitions/ParameterProviderApplyParametersRequestDTO" - } - }, - "xml" : { - "name" : "parameterProviderApplyParametersRequestEntity" - } - }, - "ParameterProviderApplyParametersUpdateStepDTO" : { - "type" : "object", - "properties" : { - "description" : { - "type" : "string", - "description" : "Explanation of what happens in this step", - "readOnly" : true - }, - "complete" : { - "type" : "boolean", - "description" : "Whether or not this step has completed", - "readOnly" : true - }, - "failureReason" : { - "type" : "string", - "description" : "An explanation of why this step failed, or null if this step did not fail", - "readOnly" : true - } - } - }, - "ParameterProviderConfigurationDTO" : { - "type" : "object", - "properties" : { - "parameterProviderId" : { - "type" : "string", - "description" : "The ID of the Parameter Provider" - }, - "parameterProviderName" : { - "type" : "string", - "description" : "The name of the Parameter Provider" - }, - "parameterGroupName" : { - "type" : "string", - "description" : "The Parameter Group name that maps to the Parameter Context" - }, - "synchronized" : { - "type" : "boolean", - "description" : "True if the Parameter Context should receive the parameters from the mapped Parameter Group" - } - } - }, - "ParameterProviderConfigurationEntity" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "component" : { - "$ref" : "#/definitions/ParameterProviderConfigurationDTO" - } - }, - "xml" : { - "name" : "parameterProviderConfigurationEntity" - } - }, - "ParameterProviderDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "versionedComponentId" : { - "type" : "string", - "description" : "The ID of the corresponding component that is under version control" - }, - "parentGroupId" : { - "type" : "string", - "description" : "The id of parent process group of this component if applicable." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "name" : { - "type" : "string", - "description" : "The name of the parameter provider." - }, - "type" : { - "type" : "string", - "description" : "The fully qualified type of the parameter provider." - }, - "bundle" : { - "description" : "The details of the artifact that bundled this parameter provider type.", - "$ref" : "#/definitions/BundleDTO" - }, - "comments" : { - "type" : "string", - "description" : "The comments of the parameter provider." - }, - "persistsState" : { - "type" : "boolean", - "description" : "Whether the parameter provider persists state." - }, - "restricted" : { - "type" : "boolean", - "description" : "Whether the parameter provider requires elevated privileges." - }, - "deprecated" : { - "type" : "boolean", - "description" : "Whether the parameter provider has been deprecated." - }, - "multipleVersionsAvailable" : { - "type" : "boolean", - "description" : "Whether the parameter provider has multiple versions available." - }, - "properties" : { - "type" : "object", - "description" : "The properties of the parameter provider.", - "additionalProperties" : { - "type" : "string" - } - }, - "descriptors" : { - "type" : "object", - "description" : "The descriptors for the parameter providers properties.", - "additionalProperties" : { - "$ref" : "#/definitions/PropertyDescriptorDTO" - } - }, - "parameterGroupConfigurations" : { - "type" : "array", - "description" : "Configuration for any fetched parameter groups.", - "items" : { - "$ref" : "#/definitions/ParameterGroupConfigurationEntity" - } - }, - "affectedComponents" : { - "type" : "array", - "description" : "The set of all components in the flow that are referencing Parameters provided by this provider", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/AffectedComponentEntity" - } - }, - "parameterStatus" : { - "type" : "array", - "description" : "The status of all provided parameters for this parameter provider", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ParameterStatusDTO" - } - }, - "referencingParameterContexts" : { - "type" : "array", - "description" : "The Parameter Contexts that reference this Parameter Provider", - "readOnly" : true, - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ParameterProviderReferencingComponentEntity" - } - }, - "customUiUrl" : { - "type" : "string", - "description" : "The URL for the custom configuration UI for the parameter provider." - }, - "annotationData" : { - "type" : "string", - "description" : "The annotation data for the parameter provider. This is how the custom UI relays configuration to 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" - } - }, - "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)", - "readOnly" : true, - "enum" : [ "VALID", "INVALID", "VALIDATING" ] - }, - "extensionMissing" : { - "type" : "boolean", - "description" : "Whether the underlying extension is missing." - } - } - }, - "ParameterProviderEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "component" : { - "$ref" : "#/definitions/ParameterProviderDTO" - } - }, - "xml" : { - "name" : "parameterProviderEntity" - } - }, - "ParameterProviderParameterApplicationEntity" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the parameter provider." - }, - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "parameterGroupConfigurations" : { - "type" : "array", - "description" : "Configuration for the fetched Parameter Groups", - "items" : { - "$ref" : "#/definitions/ParameterGroupConfigurationEntity" - } - } - }, - "xml" : { - "name" : "entity" - } - }, - "ParameterProviderParameterFetchEntity" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the parameter provider." - }, - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - } - }, - "xml" : { - "name" : "entity" - } - }, - "ParameterProviderReference" : { - "type" : "object", - "properties" : { - "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." - }, - "bundle" : { - "description" : "The details of the artifact that bundled this parameter provider.", - "$ref" : "#/definitions/Bundle" - } - } - }, - "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", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "component" : { - "$ref" : "#/definitions/ParameterProviderReferencingComponentDTO" - } - }, - "xml" : { - "name" : "parameterProviderReferencingComponentEntity" - } - }, - "ParameterProviderReferencingComponentsEntity" : { - "type" : "object", - "properties" : { - "parameterProviderReferencingComponents" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ParameterProviderReferencingComponentEntity" - } - } - }, - "xml" : { - "name" : "parameterProviderReferencingComponentsEntity" - } - }, - "ParameterProviderTypesEntity" : { - "type" : "object", - "properties" : { - "parameterProviderTypes" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/DocumentedTypeDTO" - } - } - }, - "xml" : { - "name" : "parameterProviderTypesEntity" - } - }, - "ParameterProvidersEntity" : { - "type" : "object", - "properties" : { - "parameterProviders" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ParameterProviderEntity" - } - } - }, - "xml" : { - "name" : "parameterProvidersEntity" - } - }, - "ParameterStatusDTO" : { - "type" : "object", - "properties" : { - "parameter" : { - "description" : "The name of the Parameter", - "$ref" : "#/definitions/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" ] - } - } - }, - "PeerDTO" : { - "type" : "object", - "properties" : { - "hostname" : { - "type" : "string", - "description" : "The hostname of this peer." - }, - "port" : { - "type" : "integer", - "format" : "int32", - "description" : "The port number of this peer." - }, - "secure" : { - "type" : "boolean", - "description" : "Returns if this peer connection is secure." - }, - "flowFileCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of flowFiles this peer holds." - } - } - }, - "PeersEntity" : { - "type" : "object", - "properties" : { - "peers" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/PeerDTO" - } - } - }, - "xml" : { - "name" : "peersEntity" - } - }, - "PermissionsDTO" : { - "type" : "object", - "properties" : { - "canRead" : { - "type" : "boolean", - "description" : "Indicates whether the user can read a given resource.", - "readOnly" : true - }, - "canWrite" : { - "type" : "boolean", - "description" : "Indicates whether the user can write a given resource.", - "readOnly" : true - } - } - }, - "PortDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "versionedComponentId" : { - "type" : "string", - "description" : "The ID of the corresponding component that is under version control" - }, - "parentGroupId" : { - "type" : "string", - "description" : "The id of parent process group of this component if applicable." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "name" : { - "type" : "string", - "description" : "The name of the port." - }, - "comments" : { - "type" : "string", - "description" : "The comments for the port." - }, - "state" : { - "type" : "string", - "description" : "The state of the port.", - "enum" : [ "RUNNING", "STOPPED", "DISABLED" ] - }, - "type" : { - "type" : "string", - "description" : "The type of port.", - "enum" : [ "INPUT_PORT", "OUTPUT_PORT" ] - }, - "transmitting" : { - "type" : "boolean", - "description" : "Whether the port has incoming or output connections to a remote NiFi. This is only applicable when the port is allowed to be accessed remotely." - }, - "concurrentlySchedulableTaskCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of tasks that should be concurrently scheduled for the port." - }, - "userAccessControl" : { - "type" : "array", - "description" : "The users that are allowed to access the port.", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - }, - "groupAccessControl" : { - "type" : "array", - "description" : "The user groups that are allowed to access the port.", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - }, - "allowRemoteAccess" : { - "type" : "boolean", - "description" : "Whether this port can be accessed remotely via Site-to-Site protocol." - }, - "validationErrors" : { - "type" : "array", - "description" : "Gets the validation errors from this port. These validation errors represent the problems with the port that must be resolved before it can be started.", - "items" : { - "type" : "string" - } - } - } - }, - "PortEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "component" : { - "$ref" : "#/definitions/PortDTO" - }, - "status" : { - "description" : "The status of the port.", - "$ref" : "#/definitions/PortStatusDTO" - }, - "portType" : { - "type" : "string" - }, - "operatePermissions" : { - "description" : "The permissions for this component operations.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "allowRemoteAccess" : { - "type" : "boolean", - "description" : "Whether this port can be accessed remotely via Site-to-Site protocol." - } - }, - "xml" : { - "name" : "portEntity" - } - }, - "PortRunStatusEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "state" : { - "type" : "string", - "description" : "The run status of the Port.", - "enum" : [ "RUNNING", "STOPPED", "DISABLED" ] - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - } - }, - "xml" : { - "name" : "entity" - } - }, - "PortStatusDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the port." - }, - "groupId" : { - "type" : "string", - "description" : "The id of the parent process group of the port." - }, - "name" : { - "type" : "string", - "description" : "The name of the port." - }, - "transmitting" : { - "type" : "boolean", - "description" : "Whether the port has incoming or outgoing connections to a remote NiFi." - }, - "runStatus" : { - "type" : "string", - "description" : "The run status of the port.", - "enum" : [ "Running", "Stopped", "Validating", "Disabled", "Invalid" ] - }, - "statsLastRefreshed" : { - "type" : "string", - "description" : "The time the status for the process group was last refreshed." - }, - "aggregateSnapshot" : { - "description" : "A status snapshot that represents the aggregate stats of all nodes in the cluster. If the NiFi instance is a standalone instance, rather than a cluster, this represents the stats of the single instance.", - "$ref" : "#/definitions/PortStatusSnapshotDTO" - }, - "nodeSnapshots" : { - "type" : "array", - "description" : "A status snapshot for each node in the cluster. If the NiFi instance is a standalone instance, rather than a cluster, this may be null.", - "items" : { - "$ref" : "#/definitions/NodePortStatusSnapshotDTO" - } - } - } - }, - "PortStatusEntity" : { - "type" : "object", - "properties" : { - "portStatus" : { - "$ref" : "#/definitions/PortStatusDTO" - }, - "canRead" : { - "type" : "boolean", - "description" : "Indicates whether the user can read a given resource.", - "readOnly" : true - } - }, - "xml" : { - "name" : "portStatusEntity" - } - }, - "PortStatusSnapshotDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the port." - }, - "groupId" : { - "type" : "string", - "description" : "The id of the parent process group of the port." - }, - "name" : { - "type" : "string", - "description" : "The name of the port." - }, - "activeThreadCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The active thread count for the port." - }, - "flowFilesIn" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of FlowFiles that have been accepted in the last 5 minutes." - }, - "bytesIn" : { - "type" : "integer", - "format" : "int64", - "description" : "The size of hte FlowFiles that have been accepted in the last 5 minutes." - }, - "input" : { - "type" : "string", - "description" : "The count/size of flowfiles that have been accepted in the last 5 minutes." - }, - "flowFilesOut" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of FlowFiles that have been processed in the last 5 minutes." - }, - "bytesOut" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes that have been processed in the last 5 minutes." - }, - "output" : { - "type" : "string", - "description" : "The count/size of flowfiles that have been processed in the last 5 minutes." - }, - "transmitting" : { - "type" : "boolean", - "description" : "Whether the port has incoming or outgoing connections to a remote NiFi." - }, - "runStatus" : { - "type" : "string", - "description" : "The run status of the port.", - "enum" : [ "Running", "Stopped", "Validating", "Disabled", "Invalid" ] - } - } - }, - "PortStatusSnapshotEntity" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the port." - }, - "portStatusSnapshot" : { - "$ref" : "#/definitions/PortStatusSnapshotDTO" - }, - "canRead" : { - "type" : "boolean", - "description" : "Indicates whether the user can read a given resource.", - "readOnly" : true - } - }, - "xml" : { - "name" : "entity" - } - }, - "Position" : { - "type" : "object", - "properties" : { - "x" : { - "type" : "number", - "format" : "double", - "description" : "The x coordinate." - }, - "y" : { - "type" : "number", - "format" : "double", - "description" : "The y coordinate." - } - }, - "description" : "The position of a component on the graph" - }, - "PositionDTO" : { - "type" : "object", - "properties" : { - "x" : { - "type" : "number", - "format" : "double", - "description" : "The x coordinate." - }, - "y" : { - "type" : "number", - "format" : "double", - "description" : "The y coordinate." - } - } - }, - "PreviousValueDTO" : { - "type" : "object", - "properties" : { - "previousValue" : { - "type" : "string", - "description" : "The previous value." - }, - "timestamp" : { - "type" : "string", - "description" : "The timestamp when the value was modified." - }, - "userIdentity" : { - "type" : "string", - "description" : "The user who changed the previous value." - } - } - }, - "PrioritizerTypesEntity" : { - "type" : "object", - "properties" : { - "prioritizerTypes" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/DocumentedTypeDTO" - } - } - }, - "xml" : { - "name" : "prioritizerTypesEntity" - } - }, - "ProcessGroupDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "versionedComponentId" : { - "type" : "string", - "description" : "The ID of the corresponding component that is under version control" - }, - "parentGroupId" : { - "type" : "string", - "description" : "The id of parent process group of this component if applicable." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "name" : { - "type" : "string", - "description" : "The name of the process group." - }, - "comments" : { - "type" : "string", - "description" : "The comments for the process group." - }, - "variables" : { - "type" : "object", - "description" : "The variables that are configured for the Process Group. Note that this map contains only those variables that are defined on this Process Group and not any variables that are defined in the parent Process Group, etc. I.e., this Map will not contain all variables that are accessible by components in this Process Group by rather only the variables that are defined for this Process Group itself.", - "readOnly" : true, - "additionalProperties" : { - "type" : "string" - } - }, - "versionControlInformation" : { - "description" : "The Version Control information that indicates which Flow Registry, and where in the Flow Registry, this Process Group is tracking to; or null if this Process Group is not under version control", - "$ref" : "#/definitions/VersionControlInformationDTO" - }, - "parameterContext" : { - "description" : "The Parameter Context that this Process Group is bound to.", - "$ref" : "#/definitions/ParameterContextReferenceEntity" - }, - "flowfileConcurrency" : { - "type" : "string", - "description" : "The FlowFile Concurrency for this Process Group.", - "enum" : [ "UNBOUNDED", "SINGLE_FLOWFILE_PER_NODE", "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" ] - }, - "defaultFlowFileExpiration" : { - "type" : "string", - "description" : "The default FlowFile Expiration for this Process Group." - }, - "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." - }, - "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." - }, - "logFileSuffix" : { - "type" : "string", - "description" : "The log file suffix for this Process Group for dedicated logging." - }, - "runningCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of running components in this process group." - }, - "stoppedCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of stopped components in the process group." - }, - "invalidCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of invalid components in the process group." - }, - "disabledCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of disabled components in the process group." - }, - "activeRemotePortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of active remote ports in the process group." - }, - "inactiveRemotePortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of inactive remote ports in the process group." - }, - "upToDateCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of up to date versioned process groups in the process group." - }, - "locallyModifiedCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of locally modified versioned process groups in the process group." - }, - "staleCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of stale versioned process groups in the process group." - }, - "locallyModifiedAndStaleCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of locally modified and stale versioned process groups in the process group." - }, - "syncFailureCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of versioned process groups in the process group that are unable to sync to a registry." - }, - "localInputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of local input ports in the process group." - }, - "localOutputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of local output ports in the process group." - }, - "publicInputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of public input ports in the process group." - }, - "publicOutputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of public output ports in the process group." - }, - "contents" : { - "description" : "The contents of this process group.", - "$ref" : "#/definitions/FlowSnippetDTO" - }, - "inputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of input ports in the process group.", - "readOnly" : true - }, - "outputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of output ports in the process group.", - "readOnly" : true - } - } - }, - "ProcessGroupEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "component" : { - "$ref" : "#/definitions/ProcessGroupDTO" - }, - "status" : { - "description" : "The status of the process group.", - "$ref" : "#/definitions/ProcessGroupStatusDTO" - }, - "versionedFlowSnapshot" : { - "description" : "Returns the Versioned Flow that describes the contents of the Versioned Flow to be imported", - "readOnly" : true, - "$ref" : "#/definitions/RegisteredFlowSnapshot" - }, - "runningCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of running components in this process group." - }, - "stoppedCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of stopped components in the process group." - }, - "invalidCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of invalid components in the process group." - }, - "disabledCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of disabled components in the process group." - }, - "activeRemotePortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of active remote ports in the process group." - }, - "inactiveRemotePortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of inactive remote ports in the process group." - }, - "versionedFlowState" : { - "type" : "string", - "description" : "The current state of the Process Group, as it relates to the Versioned Flow", - "readOnly" : true, - "enum" : [ "LOCALLY_MODIFIED", "STALE", "LOCALLY_MODIFIED_AND_STALE", "UP_TO_DATE", "SYNC_FAILURE" ] - }, - "upToDateCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of up to date versioned process groups in the process group." - }, - "locallyModifiedCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of locally modified versioned process groups in the process group." - }, - "staleCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of stale versioned process groups in the process group." - }, - "locallyModifiedAndStaleCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of locally modified and stale versioned process groups in the process group." - }, - "syncFailureCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of versioned process groups in the process group that are unable to sync to a registry." - }, - "localInputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of local input ports in the process group." - }, - "localOutputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of local output ports in the process group." - }, - "publicInputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of public input ports in the process group." - }, - "publicOutputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of public output ports in the process group." - }, - "parameterContext" : { - "description" : "The Parameter Context, or null if no Parameter Context has been bound to the Process Group", - "$ref" : "#/definitions/ParameterContextReferenceEntity" - }, - "processGroupUpdateStrategy" : { - "type" : "string", - "description" : "Determines the process group update strategy", - "enum" : [ "DIRECT_CHILDREN", "ALL_DESCENDANTS" ] - }, - "inputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of input ports in the process group.", - "readOnly" : true - }, - "outputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of output ports in the process group.", - "readOnly" : true - } - }, - "xml" : { - "name" : "processGroupEntity" - } - }, - "ProcessGroupFlowDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "parentGroupId" : { - "type" : "string", - "description" : "The id of parent process group of this component if applicable." - }, - "parameterContext" : { - "description" : "The Parameter Context, or null if no Parameter Context has been bound to the Process Group", - "$ref" : "#/definitions/ParameterContextReferenceEntity" - }, - "breadcrumb" : { - "description" : "The breadcrumb of the process group.", - "$ref" : "#/definitions/FlowBreadcrumbEntity" - }, - "flow" : { - "description" : "The flow structure starting at this Process Group.", - "$ref" : "#/definitions/FlowDTO" - }, - "lastRefreshed" : { - "type" : "string", - "description" : "The time the flow for the process group was last refreshed." - } - } - }, - "ProcessGroupFlowEntity" : { - "type" : "object", - "properties" : { - "permissions" : { - "description" : "The access policy for this process group.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "processGroupFlow" : { - "$ref" : "#/definitions/ProcessGroupFlowDTO" - } - }, - "xml" : { - "name" : "processGroupFlowEntity" - } - }, - "ProcessGroupImportEntity" : { - "type" : "object", - "properties" : { - "processGroupRevision" : { - "description" : "The Revision for the Process Group", - "$ref" : "#/definitions/RevisionDTO" - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "versionedFlowSnapshot" : { - "description" : "The Versioned Flow Snapshot to import", - "$ref" : "#/definitions/RegisteredFlowSnapshot" - } - }, - "xml" : { - "name" : "processGroupImportEntity" - } - }, - "ProcessGroupNameDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The ID of the Process Group" - }, - "name" : { - "type" : "string", - "description" : "The name of the Process Group, or the ID of the Process Group if the user does not have the READ policy for the Process Group" - } - } - }, - "ProcessGroupReplaceRequestDTO" : { - "type" : "object", - "properties" : { - "requestId" : { - "type" : "string", - "description" : "The unique ID of this request.", - "readOnly" : true - }, - "processGroupId" : { - "type" : "string", - "description" : "The unique ID of the Process Group being updated" - }, - "uri" : { - "type" : "string", - "description" : "The URI for future requests to this drop request.", - "readOnly" : true - }, - "lastUpdated" : { - "type" : "string", - "description" : "The last time this request was updated.", - "readOnly" : true - }, - "complete" : { - "type" : "boolean", - "description" : "Whether or not this request has completed", - "readOnly" : true - }, - "failureReason" : { - "type" : "string", - "description" : "An explanation of why this request failed, or null if this request has not failed", - "readOnly" : true - }, - "percentCompleted" : { - "type" : "integer", - "format" : "int32", - "description" : "The percentage complete for the request, between 0 and 100", - "readOnly" : true - }, - "state" : { - "type" : "string", - "description" : "The state of the request", - "readOnly" : true - } - } - }, - "ProcessGroupReplaceRequestEntity" : { - "type" : "object", - "properties" : { - "processGroupRevision" : { - "description" : "The revision for the Process Group being updated.", - "$ref" : "#/definitions/RevisionDTO" - }, - "request" : { - "description" : "The Process Group Change Request", - "$ref" : "#/definitions/ProcessGroupReplaceRequestDTO" - }, - "versionedFlowSnapshot" : { - "description" : "Returns the Versioned Flow to replace with", - "readOnly" : true, - "$ref" : "#/definitions/RegisteredFlowSnapshot" - } - }, - "xml" : { - "name" : "processGroupReplaceRequestEntity" - } - }, - "ProcessGroupStatusDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The ID of the Process Group" - }, - "name" : { - "type" : "string", - "description" : "The name of the Process Group" - }, - "statsLastRefreshed" : { - "type" : "string", - "description" : "The time the status for the process group was last refreshed." - }, - "aggregateSnapshot" : { - "description" : "The aggregate status of all nodes in the cluster", - "$ref" : "#/definitions/ProcessGroupStatusSnapshotDTO" - }, - "nodeSnapshots" : { - "type" : "array", - "description" : "The status reported by each node in the cluster. If the NiFi instance is a standalone instance, rather than a clustered instance, this value may be null.", - "items" : { - "$ref" : "#/definitions/NodeProcessGroupStatusSnapshotDTO" - } - } - } - }, - "ProcessGroupStatusEntity" : { - "type" : "object", - "properties" : { - "processGroupStatus" : { - "$ref" : "#/definitions/ProcessGroupStatusDTO" - }, - "canRead" : { - "type" : "boolean", - "description" : "Indicates whether the user can read a given resource.", - "readOnly" : true - } - }, - "xml" : { - "name" : "processGroupStatusEntity" - } - }, - "ProcessGroupStatusSnapshotDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the process group." - }, - "name" : { - "type" : "string", - "description" : "The name of this process group." - }, - "connectionStatusSnapshots" : { - "type" : "array", - "description" : "The status of all connections in the process group.", - "items" : { - "$ref" : "#/definitions/ConnectionStatusSnapshotEntity" - } - }, - "processorStatusSnapshots" : { - "type" : "array", - "description" : "The status of all processors in the process group.", - "items" : { - "$ref" : "#/definitions/ProcessorStatusSnapshotEntity" - } - }, - "processGroupStatusSnapshots" : { - "type" : "array", - "description" : "The status of all process groups in the process group.", - "items" : { - "$ref" : "#/definitions/ProcessGroupStatusSnapshotEntity" - } - }, - "remoteProcessGroupStatusSnapshots" : { - "type" : "array", - "description" : "The status of all remote process groups in the process group.", - "items" : { - "$ref" : "#/definitions/RemoteProcessGroupStatusSnapshotEntity" - } - }, - "inputPortStatusSnapshots" : { - "type" : "array", - "description" : "The status of all input ports in the process group.", - "items" : { - "$ref" : "#/definitions/PortStatusSnapshotEntity" - } - }, - "outputPortStatusSnapshots" : { - "type" : "array", - "description" : "The status of all output ports in the process group.", - "items" : { - "$ref" : "#/definitions/PortStatusSnapshotEntity" - } - }, - "versionedFlowState" : { - "type" : "string", - "description" : "The current state of the Process Group, as it relates to the Versioned Flow", - "readOnly" : true, - "enum" : [ "LOCALLY_MODIFIED", "STALE", "LOCALLY_MODIFIED_AND_STALE", "UP_TO_DATE", "SYNC_FAILURE" ] - }, - "flowFilesIn" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of FlowFiles that have come into this ProcessGroup in the last 5 minutes" - }, - "bytesIn" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes that have come into this ProcessGroup in the last 5 minutes" - }, - "input" : { - "type" : "string", - "description" : "The input count/size for the process group in the last 5 minutes (pretty printed)." - }, - "flowFilesQueued" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of FlowFiles that are queued up in this ProcessGroup right now" - }, - "bytesQueued" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes that are queued up in this ProcessGroup right now" - }, - "queued" : { - "type" : "string", - "description" : "The count/size that is queued in the the process group." - }, - "queuedCount" : { - "type" : "string", - "description" : "The count that is queued for the process group." - }, - "queuedSize" : { - "type" : "string", - "description" : "The size that is queued for the process group." - }, - "bytesRead" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes read by components in this ProcessGroup in the last 5 minutes" - }, - "read" : { - "type" : "string", - "description" : "The number of bytes read in the last 5 minutes." - }, - "bytesWritten" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes written by components in this ProcessGroup in the last 5 minutes" - }, - "written" : { - "type" : "string", - "description" : "The number of bytes written in the last 5 minutes." - }, - "flowFilesOut" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of FlowFiles transferred out of this ProcessGroup in the last 5 minutes" - }, - "bytesOut" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes transferred out of this ProcessGroup in the last 5 minutes" - }, - "output" : { - "type" : "string", - "description" : "The output count/size for the process group in the last 5 minutes." - }, - "flowFilesTransferred" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of FlowFiles transferred in this ProcessGroup in the last 5 minutes" - }, - "bytesTransferred" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes transferred in this ProcessGroup in the last 5 minutes" - }, - "transferred" : { - "type" : "string", - "description" : "The count/size transferred to/from queues in the process group in the last 5 minutes." - }, - "bytesReceived" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes received from external sources by components within this ProcessGroup in the last 5 minutes" - }, - "flowFilesReceived" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of FlowFiles received from external sources by components within this ProcessGroup in the last 5 minutes" - }, - "received" : { - "type" : "string", - "description" : "The count/size sent to the process group in the last 5 minutes." - }, - "bytesSent" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes sent to an external sink by components within this ProcessGroup in the last 5 minutes" - }, - "flowFilesSent" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of FlowFiles sent to an external sink by components within this ProcessGroup in the last 5 minutes" - }, - "sent" : { - "type" : "string", - "description" : "The count/size sent from this process group in the last 5 minutes." - }, - "activeThreadCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The active thread count for this process group." - }, - "terminatedThreadCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of threads currently terminated for the process group." - }, - "processingNanos" : { - "type" : "integer", - "format" : "int64" - }, - "processingPerformanceStatus" : { - "description" : "Represents the processing performance for all the processors in the given process group.", - "$ref" : "#/definitions/ProcessingPerformanceStatusDTO" - } - } - }, - "ProcessGroupStatusSnapshotEntity" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the process group." - }, - "processGroupStatusSnapshot" : { - "$ref" : "#/definitions/ProcessGroupStatusSnapshotDTO" - }, - "canRead" : { - "type" : "boolean", - "description" : "Indicates whether the user can read a given resource.", - "readOnly" : true - } - }, - "xml" : { - "name" : "entity" - } - }, - "ProcessGroupsEntity" : { - "type" : "object", - "properties" : { - "processGroups" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ProcessGroupEntity" - } - } - }, - "xml" : { - "name" : "processGroupsEntity" - } - }, - "ProcessingPerformanceStatusDTO" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The unique ID of the process group that the Processor belongs to" - }, - "cpuDuration" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of nanoseconds has spent on CPU usage in the last 5 minutes." - }, - "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." - }, - "sessionCommitDuration" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of nanoseconds has spent running to commit sessions the last 5 minutes." - }, - "garbageCollectionDuration" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of nanoseconds has spent running garbage collection in the last 5 minutes." - } - } - }, - "ProcessorConfigDTO" : { - "type" : "object", - "properties" : { - "properties" : { - "type" : "object", - "description" : "The properties for the processor. Properties whose value is not set will only contain the property name.", - "additionalProperties" : { - "type" : "string" - } - }, - "descriptors" : { - "type" : "object", - "description" : "Descriptors for the processor's properties.", - "additionalProperties" : { - "$ref" : "#/definitions/PropertyDescriptorDTO" - } - }, - "sensitiveDynamicPropertyNames" : { - "type" : "array", - "description" : "Set of sensitive dynamic property names", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - }, - "schedulingPeriod" : { - "type" : "string", - "description" : "The frequency with which to schedule the processor. The format of the value will depend on th value of schedulingStrategy." - }, - "schedulingStrategy" : { - "type" : "string", - "description" : "Indcates whether the prcessor should be scheduled to run in event or timer driven mode." - }, - "executionNode" : { - "type" : "string", - "description" : "Indicates the node where the process will execute." - }, - "penaltyDuration" : { - "type" : "string", - "description" : "The amount of time that is used when the process penalizes a flowfile." - }, - "yieldDuration" : { - "type" : "string", - "description" : "The amount of time that must elapse before this processor is scheduled again after yielding." - }, - "bulletinLevel" : { - "type" : "string", - "description" : "The level at which the processor will report bulletins." - }, - "runDurationMillis" : { - "type" : "integer", - "format" : "int64", - "description" : "The run duration for the processor in milliseconds." - }, - "concurrentlySchedulableTaskCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of tasks that should be concurrently schedule for the processor. If the processor doesn't allow parallol processing then any positive input will be ignored." - }, - "autoTerminatedRelationships" : { - "type" : "array", - "description" : "The names of all relationships that cause a flow file to be terminated if the relationship is not connected elsewhere. This property differs from the 'isAutoTerminate' property of the RelationshipDTO in that the RelationshipDTO is meant to depict the current configuration, whereas this property can be set in a DTO when updating a Processor in order to change which Relationships should be auto-terminated.", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - }, - "comments" : { - "type" : "string", - "description" : "The comments for the processor." - }, - "customUiUrl" : { - "type" : "string", - "description" : "The URL for the processor's custom configuration UI if applicable." - }, - "lossTolerant" : { - "type" : "boolean", - "description" : "Whether the processor is loss tolerant." - }, - "annotationData" : { - "type" : "string", - "description" : "The annotation data for the processor used to relay configuration between a custom UI and the procesosr." - }, - "defaultConcurrentTasks" : { - "type" : "object", - "description" : "Maps default values for concurrent tasks for each applicable scheduling strategy.", - "additionalProperties" : { - "type" : "string" - } - }, - "defaultSchedulingPeriod" : { - "type" : "object", - "description" : "Maps default values for scheduling period for each applicable scheduling strategy.", - "additionalProperties" : { - "type" : "string" - } - }, - "retryCount" : { - "type" : "integer", - "format" : "int32", - "description" : "Overall number of retries." - }, - "retriedRelationships" : { - "type" : "array", - "description" : "All the relationships should be retried.", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - }, - "backoffMechanism" : { - "type" : "string", - "description" : "Determines whether the FlowFile should be penalized or the processor should be yielded between retries.", - "readOnly" : true, - "enum" : [ "PENALIZE_FLOWFILE", "YIELD_PROCESSOR" ] - }, - "maxBackoffPeriod" : { - "type" : "string", - "description" : "Maximum amount of time to be waited during a retry period." - } - } - }, - "ProcessorDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "versionedComponentId" : { - "type" : "string", - "description" : "The ID of the corresponding component that is under version control" - }, - "parentGroupId" : { - "type" : "string", - "description" : "The id of parent process group of this component if applicable." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "name" : { - "type" : "string", - "description" : "The name of the processor." - }, - "type" : { - "type" : "string", - "description" : "The type of the processor." - }, - "bundle" : { - "description" : "The details of the artifact that bundled this processor type.", - "$ref" : "#/definitions/BundleDTO" - }, - "state" : { - "type" : "string", - "description" : "The state of the processor", - "enum" : [ "RUNNING", "STOPPED", "DISABLED" ] - }, - "style" : { - "type" : "object", - "description" : "Styles for the processor (background-color : #eee).", - "additionalProperties" : { - "type" : "string" - } - }, - "relationships" : { - "type" : "array", - "description" : "The available relationships that the processor currently supports.", - "readOnly" : true, - "items" : { - "$ref" : "#/definitions/RelationshipDTO" - } - }, - "description" : { - "type" : "string", - "description" : "The description of the processor." - }, - "supportsParallelProcessing" : { - "type" : "boolean", - "description" : "Whether the processor supports parallel processing." - }, - "supportsEventDriven" : { - "type" : "boolean", - "description" : "Whether the processor supports event driven scheduling." - }, - "supportsBatching" : { - "type" : "boolean", - "description" : "Whether the processor supports batching. This makes the run duration settings available." - }, - "supportsSensitiveDynamicProperties" : { - "type" : "boolean", - "description" : "Whether the processor supports sensitive dynamic properties." - }, - "persistsState" : { - "type" : "boolean", - "description" : "Whether the processor persists state." - }, - "restricted" : { - "type" : "boolean", - "description" : "Whether the processor requires elevated privileges." - }, - "deprecated" : { - "type" : "boolean", - "description" : "Whether the processor has been deprecated." - }, - "executionNodeRestricted" : { - "type" : "boolean", - "description" : "Indicates if the execution node of a processor is restricted to run only on the primary node" - }, - "multipleVersionsAvailable" : { - "type" : "boolean", - "description" : "Whether the processor has multiple versions available." - }, - "inputRequirement" : { - "type" : "string", - "description" : "The input requirement for this processor." - }, - "config" : { - "description" : "The configuration details for the processor. These details will be included in a response if the verbose flag is included in a request.", - "$ref" : "#/definitions/ProcessorConfigDTO" - }, - "validationErrors" : { - "type" : "array", - "description" : "The validation errors for the processor. These validation errors represent the problems with the processor that must be resolved before it can be started.", - "items" : { - "type" : "string" - } - }, - "validationStatus" : { - "type" : "string", - "description" : "Indicates whether the Processor is valid, invalid, or still in the process of validating (i.e., it is unknown whether or not the Processor is valid)", - "readOnly" : true, - "enum" : [ "VALID", "INVALID", "VALIDATING" ] - }, - "extensionMissing" : { - "type" : "boolean", - "description" : "Whether the underlying extension is missing." - } - } - }, - "ProcessorDefinition" : { - "type" : "object", - "required" : [ "type" ], - "properties" : { - "group" : { - "type" : "string", - "description" : "The group name of the bundle that provides the referenced type." - }, - "artifact" : { - "type" : "string", - "description" : "The artifact name of the bundle that provides the referenced type." - }, - "version" : { - "type" : "string", - "description" : "The version 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." - }, - "buildInfo" : { - "description" : "The build metadata for this component", - "$ref" : "#/definitions/BuildInfo" - }, - "providedApiImplementations" : { - "type" : "array", - "description" : "If this type represents a provider for an interface, this lists the APIs it implements", - "items" : { - "$ref" : "#/definitions/DefinedType" - } - }, - "tags" : { - "type" : "array", - "description" : "The tags associated with this type", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - }, - "seeAlso" : { - "type" : "array", - "description" : "The names of other component types that may be related", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - }, - "deprecated" : { - "type" : "boolean", - "description" : "Whether or not the component has been deprecated" - }, - "deprecationReason" : { - "type" : "string", - "description" : "If this component has been deprecated, this optional field can be used to provide an explanation" - }, - "deprecationAlternatives" : { - "type" : "array", - "description" : "If this component has been deprecated, this optional field provides alternatives to use", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - }, - "restricted" : { - "type" : "boolean", - "description" : "Whether or not the component has a general restriction" - }, - "restrictedExplanation" : { - "type" : "string", - "description" : "An optional description of the general restriction" - }, - "explicitRestrictions" : { - "type" : "array", - "description" : "Explicit restrictions that indicate a require permission to use the component", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/Restriction" - } - }, - "stateful" : { - "description" : "Indicates if the component stores state", - "$ref" : "#/definitions/Stateful" - }, - "systemResourceConsiderations" : { - "type" : "array", - "description" : "The system resource considerations for the given component", - "items" : { - "$ref" : "#/definitions/SystemResourceConsideration" - } - }, - "additionalDetails" : { - "type" : "boolean", - "description" : "Indicates if the component has additional details documentation" - }, - "propertyDescriptors" : { - "type" : "object", - "description" : "Descriptions of configuration properties applicable to this component.", - "additionalProperties" : { - "$ref" : "#/definitions/PropertyDescriptor" - } - }, - "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." - }, - "dynamicProperties" : { - "type" : "array", - "description" : "Describes the dynamic properties supported by this component", - "items" : { - "$ref" : "#/definitions/DynamicProperty" - } - }, - "inputRequirement" : { - "type" : "string", - "description" : "Any input requirements this processor has.", - "enum" : [ "INPUT_REQUIRED", "INPUT_ALLOWED", "INPUT_FORBIDDEN" ] - }, - "supportedRelationships" : { - "type" : "array", - "description" : "The supported relationships for this processor.", - "items" : { - "$ref" : "#/definitions/Relationship" - } - }, - "supportsDynamicRelationships" : { - "type" : "boolean", - "description" : "Whether or not this processor supports dynamic relationships." - }, - "dynamicRelationship" : { - "description" : "If the processor supports dynamic relationships, this describes the dynamic relationship", - "$ref" : "#/definitions/DynamicRelationship" - }, - "triggerSerially" : { - "type" : "boolean", - "description" : "Whether or not this processor should be triggered serially (i.e. no concurrent execution)." - }, - "triggerWhenEmpty" : { - "type" : "boolean", - "description" : "Whether or not this processor should be triggered when incoming queues are empty." - }, - "triggerWhenAnyDestinationAvailable" : { - "type" : "boolean", - "description" : "Whether or not this processor should be triggered when any destination queue has room." - }, - "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." - }, - "supportsEventDriven" : { - "type" : "boolean", - "description" : "Whether or not this processor supports event driven scheduling. Indicates to the framework that the Processor is eligible to be scheduled to run based on the occurrence of an \"Event\" (e.g., when a FlowFile is enqueued in an incoming Connection), rather than being triggered periodically." - }, - "primaryNodeOnly" : { - "type" : "boolean", - "description" : "Whether or not this processor should be scheduled only on the primary node in a cluster." - }, - "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." - }, - "supportedSchedulingStrategies" : { - "type" : "array", - "description" : "The supported scheduling strategies, such as TIME_DRIVER, CRON, or EVENT_DRIVEN.", - "items" : { - "type" : "string" - } - }, - "defaultSchedulingStrategy" : { - "type" : "string", - "description" : "The default scheduling strategy for the processor." - }, - "defaultConcurrentTasksBySchedulingStrategy" : { - "type" : "object", - "description" : "The default concurrent tasks for each scheduling strategy.", - "additionalProperties" : { - "type" : "integer", - "format" : "int32" - } - }, - "defaultSchedulingPeriodBySchedulingStrategy" : { - "type" : "object", - "description" : "The default scheduling period for each scheduling strategy. The scheduling period is expected to be a time period, such as \"30 sec\".", - "additionalProperties" : { - "type" : "string" - } - }, - "defaultPenaltyDuration" : { - "type" : "string", - "description" : "The default penalty duration as a time period, such as \"30 sec\"." - }, - "defaultYieldDuration" : { - "type" : "string", - "description" : "The default yield duration as a time period, such as \"1 sec\"." - }, - "defaultBulletinLevel" : { - "type" : "string", - "description" : "The default bulletin level, such as WARN, INFO, DEBUG, etc." - }, - "readsAttributes" : { - "type" : "array", - "description" : "The FlowFile attributes this processor reads", - "items" : { - "$ref" : "#/definitions/Attribute" - } - }, - "writesAttributes" : { - "type" : "array", - "description" : "The FlowFile attributes this processor writes/updates", - "items" : { - "$ref" : "#/definitions/Attribute" - } - } - } - }, - "ProcessorDiagnosticsDTO" : { - "type" : "object", - "properties" : { - "processor" : { - "description" : "Information about the Processor for which the Diagnostic Report is generated", - "$ref" : "#/definitions/ProcessorDTO" - }, - "processorStatus" : { - "description" : "The Status for the Processor for which the Diagnostic Report is generated", - "$ref" : "#/definitions/ProcessorStatusDTO" - }, - "referencedControllerServices" : { - "type" : "array", - "description" : "Diagnostic Information about all Controller Services that the Processor is referencing", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ControllerServiceDiagnosticsDTO" - } - }, - "incomingConnections" : { - "type" : "array", - "description" : "Diagnostic Information about all incoming Connections", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ConnectionDiagnosticsDTO" - } - }, - "outgoingConnections" : { - "type" : "array", - "description" : "Diagnostic Information about all outgoing Connections", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ConnectionDiagnosticsDTO" - } - }, - "jvmDiagnostics" : { - "description" : "Diagnostic Information about the JVM and system-level diagnostics", - "$ref" : "#/definitions/JVMDiagnosticsDTO" - }, - "threadDumps" : { - "type" : "array", - "description" : "Thread Dumps that were taken of the threads that are active in the Processor", - "items" : { - "$ref" : "#/definitions/ThreadDumpDTO" - } - }, - "classLoaderDiagnostics" : { - "description" : "Information about the Controller Service's Class Loader", - "$ref" : "#/definitions/ClassLoaderDiagnosticsDTO" - } - } - }, - "ProcessorDiagnosticsEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "component" : { - "description" : "The Processor Diagnostics", - "$ref" : "#/definitions/ProcessorDiagnosticsDTO" - } - }, - "xml" : { - "name" : "processorDiagnosticsEntity" - } - }, - "ProcessorEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "component" : { - "$ref" : "#/definitions/ProcessorDTO" - }, - "inputRequirement" : { - "type" : "string", - "description" : "The input requirement for this processor." - }, - "status" : { - "$ref" : "#/definitions/ProcessorStatusDTO" - }, - "operatePermissions" : { - "description" : "The permissions for this component operations.", - "$ref" : "#/definitions/PermissionsDTO" - } - }, - "xml" : { - "name" : "processorEntity" - } - }, - "ProcessorRunStatusDetailsDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The ID of the processor" - }, - "name" : { - "type" : "string", - "description" : "The name of the processor" - }, - "runStatus" : { - "type" : "string", - "description" : "The run status of the processor", - "enum" : [ "Running", "Stopped", "Invalid", "Validating", "Disabled" ] - }, - "validationErrors" : { - "type" : "array", - "description" : "The processor's validation errors", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - }, - "activeThreadCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The current number of threads that the processor is currently using" - } - } - }, - "ProcessorRunStatusDetailsEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for the Processor.", - "$ref" : "#/definitions/RevisionDTO" - }, - "permissions" : { - "description" : "The permissions for the Processor.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "runStatusDetails" : { - "description" : "The details of a Processor's run status", - "$ref" : "#/definitions/ProcessorRunStatusDetailsDTO" - } - }, - "xml" : { - "name" : "entity" - } - }, - "ProcessorRunStatusEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "state" : { - "type" : "string", - "description" : "The run status of the Processor.", - "enum" : [ "RUNNING", "STOPPED", "DISABLED", "RUN_ONCE" ] - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - } - }, - "xml" : { - "name" : "entity" - } - }, - "ProcessorStatusDTO" : { - "type" : "object", - "properties" : { - "groupId" : { - "type" : "string", - "description" : "The unique ID of the process group that the Processor belongs to" - }, - "id" : { - "type" : "string", - "description" : "The unique ID of the Processor" - }, - "name" : { - "type" : "string", - "description" : "The name of the Processor" - }, - "type" : { - "type" : "string", - "description" : "The type of the Processor" - }, - "runStatus" : { - "type" : "string", - "description" : "The run status of the Processor", - "enum" : [ "Running", "Stopped", "Validating", "Disabled", "Invalid" ] - }, - "statsLastRefreshed" : { - "type" : "string", - "description" : "The timestamp of when the stats were last refreshed" - }, - "aggregateSnapshot" : { - "description" : "A status snapshot that represents the aggregate stats of all nodes in the cluster. If the NiFi instance is a standalone instance, rather than a cluster, this represents the stats of the single instance.", - "$ref" : "#/definitions/ProcessorStatusSnapshotDTO" - }, - "nodeSnapshots" : { - "type" : "array", - "description" : "A status snapshot for each node in the cluster. If the NiFi instance is a standalone instance, rather than a cluster, this may be null.", - "items" : { - "$ref" : "#/definitions/NodeProcessorStatusSnapshotDTO" - } - } - } - }, - "ProcessorStatusEntity" : { - "type" : "object", - "properties" : { - "processorStatus" : { - "$ref" : "#/definitions/ProcessorStatusDTO" - }, - "canRead" : { - "type" : "boolean", - "description" : "Indicates whether the user can read a given resource.", - "readOnly" : true - } - }, - "xml" : { - "name" : "processorStatusEntity" - } - }, - "ProcessorStatusSnapshotDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the processor." - }, - "groupId" : { - "type" : "string", - "description" : "The id of the parent process group to which the processor belongs." - }, - "name" : { - "type" : "string", - "description" : "The name of the prcessor." - }, - "type" : { - "type" : "string", - "description" : "The type of the processor." - }, - "runStatus" : { - "type" : "string", - "description" : "The state of the processor.", - "enum" : [ "Running", "Stopped", "Validating", "Disabled", "Invalid" ] - }, - "executionNode" : { - "type" : "string", - "description" : "Indicates the node where the process will execute.", - "enum" : [ "ALL", "PRIMARY" ] - }, - "bytesRead" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes read by this Processor in the last 5 mintues" - }, - "bytesWritten" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes written by this Processor in the last 5 minutes" - }, - "read" : { - "type" : "string", - "description" : "The number of bytes read in the last 5 minutes." - }, - "written" : { - "type" : "string", - "description" : "The number of bytes written in the last 5 minutes." - }, - "flowFilesIn" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of FlowFiles that have been accepted in the last 5 minutes" - }, - "bytesIn" : { - "type" : "integer", - "format" : "int64", - "description" : "The size of the FlowFiles that have been accepted in the last 5 minutes" - }, - "input" : { - "type" : "string", - "description" : "The count/size of flowfiles that have been accepted in the last 5 minutes." - }, - "flowFilesOut" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of FlowFiles transferred to a Connection in the last 5 minutes" - }, - "bytesOut" : { - "type" : "integer", - "format" : "int64", - "description" : "The size of the FlowFiles transferred to a Connection in the last 5 minutes" - }, - "output" : { - "type" : "string", - "description" : "The count/size of flowfiles that have been processed in the last 5 minutes." - }, - "taskCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of times this Processor has run in the last 5 minutes" - }, - "tasksDurationNanos" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of nanoseconds that this Processor has spent running in the last 5 minutes" - }, - "tasks" : { - "type" : "string", - "description" : "The total number of task this connectable has completed over the last 5 minutes." - }, - "tasksDuration" : { - "type" : "string", - "description" : "The total duration of all tasks for this connectable over the last 5 minutes." - }, - "activeThreadCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of threads currently executing in the processor." - }, - "terminatedThreadCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of threads currently terminated for the processor." - }, - "processingPerformanceStatus" : { - "description" : "Represents the processor's processing performance.", - "$ref" : "#/definitions/ProcessingPerformanceStatusDTO" - } - } - }, - "ProcessorStatusSnapshotEntity" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the processor." - }, - "processorStatusSnapshot" : { - "$ref" : "#/definitions/ProcessorStatusSnapshotDTO" - }, - "canRead" : { - "type" : "boolean", - "description" : "Indicates whether the user can read a given resource.", - "readOnly" : true - } - }, - "xml" : { - "name" : "entity" - } - }, - "ProcessorTypesEntity" : { - "type" : "object", - "properties" : { - "processorTypes" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/DocumentedTypeDTO" - } - } - }, - "xml" : { - "name" : "processorTypesEntity" - } - }, - "ProcessorsEntity" : { - "type" : "object", - "properties" : { - "processors" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ProcessorEntity" - } - } - }, - "xml" : { - "name" : "processorsEntity" - } - }, - "ProcessorsRunStatusDetailsEntity" : { - "type" : "object", - "properties" : { - "runStatusDetails" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/ProcessorRunStatusDetailsEntity" - } - } - }, - "xml" : { - "name" : "processorsRunStatusDetails" - } - }, - "PropertyAllowableValue" : { - "type" : "object", - "required" : [ "value" ], - "properties" : { - "value" : { - "type" : "string", - "description" : "The internal value" - }, - "displayName" : { - "type" : "string", - "description" : "The display name of the value, if different from the internal value" - }, - "description" : { - "type" : "string", - "description" : "The description of the value, e.g., the behavior it produces." - } - } - }, - "PropertyDependency" : { - "type" : "object", - "properties" : { - "propertyName" : { - "type" : "string", - "description" : "The name of the property that is depended upon" - }, - "propertyDisplayName" : { - "type" : "string", - "description" : "The name of the property that is depended upon" - }, - "dependentValues" : { - "type" : "array", - "description" : "The values that satisfy the dependency", - "items" : { - "type" : "string" - } - } - } - }, - "PropertyDependencyDTO" : { - "type" : "object", - "properties" : { - "propertyName" : { - "type" : "string", - "description" : "The name of the property that is being depended upon" - }, - "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", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - } - } - }, - "PropertyDescriptor" : { - "type" : "object", - "required" : [ "name" ], - "properties" : { - "name" : { - "type" : "string", - "description" : "The name of the property key" - }, - "displayName" : { - "type" : "string", - "description" : "The display name of the property key, if different from the name" - }, - "description" : { - "type" : "string", - "description" : "The description of what the property does" - }, - "allowableValues" : { - "type" : "array", - "description" : "A list of the allowable values for the property", - "items" : { - "$ref" : "#/definitions/PropertyAllowableValue" - } - }, - "defaultValue" : { - "type" : "string", - "description" : "The default value if a user-set value is not specified" - }, - "required" : { - "type" : "boolean", - "description" : "Whether or not the property is required for the component" - }, - "sensitive" : { - "type" : "boolean", - "description" : "Whether or not the value of the property is considered sensitive (e.g., passwords and keys)" - }, - "expressionLanguageScope" : { - "type" : "string", - "description" : "The scope of expression language supported by this property", - "enum" : [ "NONE", "VARIABLE_REGISTRY", "FLOWFILE_ATTRIBUTES" ] - }, - "expressionLanguageScopeDescription" : { - "type" : "string", - "description" : "The description of the expression language scope supported by this property", - "readOnly" : true - }, - "typeProvidedByValue" : { - "description" : "Indicates that this property is for selecting a controller service of the specified type", - "$ref" : "#/definitions/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" - }, - "dynamic" : { - "type" : "boolean", - "description" : "Whether or not the descriptor is for a dynamically added property" - }, - "resourceDefinition" : { - "description" : "Indicates that this property references external resources", - "$ref" : "#/definitions/PropertyResourceDefinition" - }, - "dependencies" : { - "type" : "array", - "description" : "The dependencies that this property has on other properties", - "items" : { - "$ref" : "#/definitions/PropertyDependency" - } - } - } - }, - "PropertyDescriptorDTO" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The name for the property." - }, - "displayName" : { - "type" : "string", - "description" : "The human readable name for the property." - }, - "description" : { - "type" : "string", - "description" : "The description for the property. Used to relay additional details to a user or provide a mechanism of documenting intent." - }, - "defaultValue" : { - "type" : "string", - "description" : "The default value for the property." - }, - "allowableValues" : { - "type" : "array", - "description" : "Allowable values for the property. If empty then the allowed values are not constrained.", - "items" : { - "$ref" : "#/definitions/AllowableValueEntity" - } - }, - "required" : { - "type" : "boolean", - "description" : "Whether the property is required." - }, - "sensitive" : { - "type" : "boolean", - "description" : "Whether the property is sensitive and protected whenever stored or represented." - }, - "dynamic" : { - "type" : "boolean", - "description" : "Whether the property is dynamic (user-defined)." - }, - "supportsEl" : { - "type" : "boolean", - "description" : "Whether the property supports expression language." - }, - "expressionLanguageScope" : { - "type" : "string", - "description" : "Scope of the Expression Language evaluation for the property." - }, - "identifiesControllerService" : { - "type" : "string", - "description" : "If the property identifies a controller service this returns the fully qualified type." - }, - "identifiesControllerServiceBundle" : { - "description" : "If the property identifies a controller service this returns the bundle of the type, null otherwise.", - "$ref" : "#/definitions/BundleDTO" - }, - "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" : "#/definitions/PropertyDependencyDTO" - } - } - } - }, - "PropertyDescriptorEntity" : { - "type" : "object", - "properties" : { - "propertyDescriptor" : { - "$ref" : "#/definitions/PropertyDescriptorDTO" - } - }, - "xml" : { - "name" : "propertyDescriptor" - } - }, - "PropertyHistoryDTO" : { - "type" : "object", - "properties" : { - "previousValues" : { - "type" : "array", - "description" : "Previous values for a given property.", - "items" : { - "$ref" : "#/definitions/PreviousValueDTO" - } - } - } - }, - "PropertyResourceDefinition" : { - "type" : "object", - "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", - "uniqueItems" : true, - "items" : { - "type" : "string", - "enum" : [ "FILE", "DIRECTORY", "TEXT", "URL" ] - } - } - } - }, - "ProvenanceDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the provenance query." - }, - "uri" : { - "type" : "string", - "description" : "The URI for this query. Used for obtaining/deleting the request at a later time" - }, - "submissionTime" : { - "type" : "string", - "description" : "The timestamp when the query was submitted." - }, - "expiration" : { - "type" : "string", - "description" : "The timestamp when the query will expire." - }, - "percentCompleted" : { - "type" : "integer", - "format" : "int32", - "description" : "The current percent complete." - }, - "finished" : { - "type" : "boolean", - "description" : "Whether the query has finished." - }, - "request" : { - "description" : "The provenance request.", - "$ref" : "#/definitions/ProvenanceRequestDTO" - }, - "results" : { - "description" : "The provenance results.", - "$ref" : "#/definitions/ProvenanceResultsDTO" - } - } - }, - "ProvenanceEntity" : { - "type" : "object", - "properties" : { - "provenance" : { - "$ref" : "#/definitions/ProvenanceDTO" - } - }, - "xml" : { - "name" : "provenanceEntity" - } - }, - "ProvenanceEventDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The event uuid." - }, - "eventId" : { - "type" : "integer", - "format" : "int64", - "description" : "The event id. This is a one up number thats unique per node." - }, - "eventTime" : { - "type" : "string", - "description" : "The timestamp of the event." - }, - "eventDuration" : { - "type" : "integer", - "format" : "int64", - "description" : "The event duration in milliseconds." - }, - "lineageDuration" : { - "type" : "integer", - "format" : "int64", - "description" : "The duration since the lineage began, in milliseconds." - }, - "eventType" : { - "type" : "string", - "description" : "The type of the event." - }, - "flowFileUuid" : { - "type" : "string", - "description" : "The uuid of the flowfile for the event." - }, - "fileSize" : { - "type" : "string", - "description" : "The size of the flowfile for the event." - }, - "fileSizeBytes" : { - "type" : "integer", - "format" : "int64", - "description" : "The size of the flowfile in bytes for the event." - }, - "clusterNodeId" : { - "type" : "string", - "description" : "The identifier for the node where the event originated." - }, - "clusterNodeAddress" : { - "type" : "string", - "description" : "The label for the node where the event originated." - }, - "groupId" : { - "type" : "string", - "description" : "The id of the group that the component resides in. If the component is no longer in the flow, the group id will not be set." - }, - "componentId" : { - "type" : "string", - "description" : "The id of the component that generated the event." - }, - "componentType" : { - "type" : "string", - "description" : "The type of the component that generated the event." - }, - "componentName" : { - "type" : "string", - "description" : "The name of the component that generated the event." - }, - "sourceSystemFlowFileId" : { - "type" : "string", - "description" : "The source system flowfile id." - }, - "alternateIdentifierUri" : { - "type" : "string", - "description" : "The alternate identifier uri for the fileflow for the event." - }, - "attributes" : { - "type" : "array", - "description" : "The attributes of the flowfile for the event.", - "items" : { - "$ref" : "#/definitions/AttributeDTO" - } - }, - "parentUuids" : { - "type" : "array", - "description" : "The parent uuids for the event.", - "items" : { - "type" : "string" - } - }, - "childUuids" : { - "type" : "array", - "description" : "The child uuids for the event.", - "items" : { - "type" : "string" - } - }, - "transitUri" : { - "type" : "string", - "description" : "The source/destination system uri if the event was a RECEIVE/SEND." - }, - "relationship" : { - "type" : "string", - "description" : "The relationship to which the flowfile was routed if the event is of type ROUTE." - }, - "details" : { - "type" : "string", - "description" : "The event details." - }, - "contentEqual" : { - "type" : "boolean", - "description" : "Whether the input and output content claim is the same." - }, - "inputContentAvailable" : { - "type" : "boolean", - "description" : "Whether the input content is still available." - }, - "inputContentClaimSection" : { - "type" : "string", - "description" : "The section in which the input content claim lives." - }, - "inputContentClaimContainer" : { - "type" : "string", - "description" : "The container in which the input content claim lives." - }, - "inputContentClaimIdentifier" : { - "type" : "string", - "description" : "The identifier of the input content claim." - }, - "inputContentClaimOffset" : { - "type" : "integer", - "format" : "int64", - "description" : "The offset into the input content claim where the flowfiles content begins." - }, - "inputContentClaimFileSize" : { - "type" : "string", - "description" : "The file size of the input content claim formatted." - }, - "inputContentClaimFileSizeBytes" : { - "type" : "integer", - "format" : "int64", - "description" : "The file size of the intput content claim in bytes." - }, - "outputContentAvailable" : { - "type" : "boolean", - "description" : "Whether the output content is still available." - }, - "outputContentClaimSection" : { - "type" : "string", - "description" : "The section in which the output content claim lives." - }, - "outputContentClaimContainer" : { - "type" : "string", - "description" : "The container in which the output content claim lives." - }, - "outputContentClaimIdentifier" : { - "type" : "string", - "description" : "The identifier of the output content claim." - }, - "outputContentClaimOffset" : { - "type" : "integer", - "format" : "int64", - "description" : "The offset into the output content claim where the flowfiles content begins." - }, - "outputContentClaimFileSize" : { - "type" : "string", - "description" : "The file size of the output content claim formatted." - }, - "outputContentClaimFileSizeBytes" : { - "type" : "integer", - "format" : "int64", - "description" : "The file size of the output content claim in bytes." - }, - "replayAvailable" : { - "type" : "boolean", - "description" : "Whether or not replay is available." - }, - "replayExplanation" : { - "type" : "string", - "description" : "Explanation as to why replay is unavailable." - }, - "sourceConnectionIdentifier" : { - "type" : "string", - "description" : "The identifier of the queue/connection from which the flowfile was pulled to genereate this event. May be null if the queue/connection is unknown or the flowfile was generated from this event." - } - } - }, - "ProvenanceEventEntity" : { - "type" : "object", - "properties" : { - "provenanceEvent" : { - "$ref" : "#/definitions/ProvenanceEventDTO" - } - }, - "xml" : { - "name" : "provenanceEventEntity" - } - }, - "ProvenanceLinkDTO" : { - "type" : "object", - "properties" : { - "sourceId" : { - "type" : "string", - "description" : "The source node id of the link." - }, - "targetId" : { - "type" : "string", - "description" : "The target node id of the link." - }, - "flowFileUuid" : { - "type" : "string", - "description" : "The flowfile uuid that traversed the link." - }, - "timestamp" : { - "type" : "string", - "description" : "The timestamp of the link (based on the destination)." - }, - "millis" : { - "type" : "integer", - "format" : "int64", - "description" : "The timestamp of this link in milliseconds." - } - } - }, - "ProvenanceNodeDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the node." - }, - "flowFileUuid" : { - "type" : "string", - "description" : "The uuid of the flowfile associated with the provenance event." - }, - "parentUuids" : { - "type" : "array", - "description" : "The uuid of the parent flowfiles of the provenance event.", - "items" : { - "type" : "string" - } - }, - "childUuids" : { - "type" : "array", - "description" : "The uuid of the childrent flowfiles of the provenance event.", - "items" : { - "type" : "string" - } - }, - "clusterNodeIdentifier" : { - "type" : "string", - "description" : "The identifier of the node that this event/flowfile originated from." - }, - "type" : { - "type" : "string", - "description" : "The type of the node.", - "enum" : [ "FLOWFILE", "EVENT" ] - }, - "eventType" : { - "type" : "string", - "description" : "If the type is EVENT, this is the type of event." - }, - "millis" : { - "type" : "integer", - "format" : "int64", - "description" : "The timestamp of the node in milliseconds." - }, - "timestamp" : { - "type" : "string", - "description" : "The timestamp of the node formatted." - } - } - }, - "ProvenanceOptionsDTO" : { - "type" : "object", - "properties" : { - "searchableFields" : { - "type" : "array", - "description" : "The available searchable field for the NiFi.", - "items" : { - "$ref" : "#/definitions/ProvenanceSearchableFieldDTO" - } - } - } - }, - "ProvenanceOptionsEntity" : { - "type" : "object", - "properties" : { - "provenanceOptions" : { - "$ref" : "#/definitions/ProvenanceOptionsDTO" - } - }, - "xml" : { - "name" : "provenanceOptionsEntity" - } - }, - "ProvenanceRequestDTO" : { - "type" : "object", - "properties" : { - "searchTerms" : { - "type" : "object", - "description" : "The search terms used to perform the search.", - "additionalProperties" : { - "$ref" : "#/definitions/ProvenanceSearchValueDTO" - } - }, - "clusterNodeId" : { - "type" : "string", - "description" : "The id of the node in the cluster where this provenance originated." - }, - "startDate" : { - "type" : "string", - "description" : "The earliest event time to include in the query." - }, - "endDate" : { - "type" : "string", - "description" : "The latest event time to include in the query." - }, - "minimumFileSize" : { - "type" : "string", - "description" : "The minimum file size to include in the query." - }, - "maximumFileSize" : { - "type" : "string", - "description" : "The maximum file size to include in the query." - }, - "maxResults" : { - "type" : "integer", - "format" : "int32", - "description" : "The maximum number of results to include." - }, - "summarize" : { - "type" : "boolean", - "description" : "Whether or not to summarize provenance events returned. This property is false by default." - }, - "incrementalResults" : { - "type" : "boolean", - "description" : "Whether or not incremental results are returned. If false, provenance events are only returned once the query completes. This property is true by default." - } - } - }, - "ProvenanceResultsDTO" : { - "type" : "object", - "properties" : { - "provenanceEvents" : { - "type" : "array", - "description" : "The provenance events that matched the search criteria.", - "items" : { - "$ref" : "#/definitions/ProvenanceEventDTO" - } - }, - "total" : { - "type" : "string", - "description" : "The total number of results formatted." - }, - "totalCount" : { - "type" : "integer", - "format" : "int64", - "description" : "The total number of results." - }, - "generated" : { - "type" : "string", - "description" : "Then the search was performed." - }, - "oldestEvent" : { - "type" : "string", - "description" : "The oldest event available in the provenance repository." - }, - "timeOffset" : { - "type" : "integer", - "format" : "int32", - "description" : "The time offset of the server that's used for event time." - }, - "errors" : { - "type" : "array", - "description" : "Any errors that occurred while performing the provenance request.", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - } - } - }, - "ProvenanceSearchValueDTO" : { - "type" : "object", - "properties" : { - "value" : { - "type" : "string", - "description" : "The search value." - }, - "inverse" : { - "type" : "boolean", - "description" : "Query for all except for search value." - } - } - }, - "ProvenanceSearchableFieldDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the searchable field." - }, - "field" : { - "type" : "string", - "description" : "The searchable field." - }, - "label" : { - "type" : "string", - "description" : "The label for the searchable field." - }, - "type" : { - "type" : "string", - "description" : "The type of the searchable field." - } - } - }, - "QueueSizeDTO" : { - "type" : "object", - "properties" : { - "byteCount" : { - "type" : "integer", - "format" : "int64", - "description" : "The size of objects in a queue." - }, - "objectCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The count of objects in a queue." - } - } - }, - "RegisteredFlow" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string" - }, - "name" : { - "type" : "string" - }, - "description" : { - "type" : "string" - }, - "bucketIdentifier" : { - "type" : "string" - }, - "bucketName" : { - "type" : "string" - }, - "createdTimestamp" : { - "type" : "integer", - "format" : "int64" - }, - "lastModifiedTimestamp" : { - "type" : "integer", - "format" : "int64" - }, - "permissions" : { - "$ref" : "#/definitions/FlowRegistryPermissions" - }, - "versionCount" : { - "type" : "integer", - "format" : "int64" - }, - "versionInfo" : { - "$ref" : "#/definitions/RegisteredFlowVersionInfo" - } - } - }, - "RegisteredFlowSnapshot" : { - "type" : "object", - "properties" : { - "snapshotMetadata" : { - "$ref" : "#/definitions/RegisteredFlowSnapshotMetadata" - }, - "flow" : { - "$ref" : "#/definitions/RegisteredFlow" - }, - "bucket" : { - "$ref" : "#/definitions/FlowRegistryBucket" - }, - "flowContents" : { - "$ref" : "#/definitions/VersionedProcessGroup" - }, - "externalControllerServices" : { - "type" : "object", - "additionalProperties" : { - "$ref" : "#/definitions/ExternalControllerServiceReference" - } - }, - "parameterContexts" : { - "type" : "object", - "additionalProperties" : { - "$ref" : "#/definitions/VersionedParameterContext" - } - }, - "flowEncodingVersion" : { - "type" : "string" - }, - "parameterProviders" : { - "type" : "object", - "additionalProperties" : { - "$ref" : "#/definitions/ParameterProviderReference" - } - }, - "latest" : { - "type" : "boolean" - } - } - }, - "RegisteredFlowSnapshotMetadata" : { - "type" : "object", - "properties" : { - "bucketIdentifier" : { - "type" : "string" - }, - "flowIdentifier" : { - "type" : "string" - }, - "version" : { - "type" : "integer", - "format" : "int32" - }, - "timestamp" : { - "type" : "integer", - "format" : "int64" - }, - "author" : { - "type" : "string" - }, - "comments" : { - "type" : "string" - } - } - }, - "RegisteredFlowVersionInfo" : { - "type" : "object", - "properties" : { - "version" : { - "type" : "integer", - "format" : "int64" - } - } - }, - "Relationship" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The name of the relationship" - }, - "description" : { - "type" : "string", - "description" : "The description of the relationship" - } - } - }, - "RelationshipDTO" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The relationship name." - }, - "description" : { - "type" : "string", - "description" : "The relationship description." - }, - "autoTerminate" : { - "type" : "boolean", - "description" : "Whether or not flowfiles sent to this relationship should auto terminate." - }, - "retry" : { - "type" : "boolean", - "description" : "Whether or not flowfiles sent to this relationship should retry." - } - } - }, - "RemotePortRunStatusEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "state" : { - "type" : "string", - "description" : "The run status of the RemotePort.", - "enum" : [ "TRANSMITTING", "STOPPED" ] - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - } - }, - "xml" : { - "name" : "entity" - } - }, - "RemoteProcessGroupContentsDTO" : { - "type" : "object", - "properties" : { - "inputPorts" : { - "type" : "array", - "description" : "The input ports to which data can be sent.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/RemoteProcessGroupPortDTO" - } - }, - "outputPorts" : { - "type" : "array", - "description" : "The output ports from which data can be retrieved.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/RemoteProcessGroupPortDTO" - } - } - } - }, - "RemoteProcessGroupDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "versionedComponentId" : { - "type" : "string", - "description" : "The ID of the corresponding component that is under version control" - }, - "parentGroupId" : { - "type" : "string", - "description" : "The id of parent process group of this component if applicable." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "targetUri" : { - "type" : "string", - "description" : "The target URI of the remote process group. If target uri is not set, but uris are set, then returns the first url in the urls. If neither target uri nor uris are set, then returns null." - }, - "targetUris" : { - "type" : "string", - "description" : "The target URI of the remote process group. If target uris is not set but target uri is set, then returns a collection containing the single target uri. If neither target uris nor uris are set, then returns null." - }, - "targetSecure" : { - "type" : "boolean", - "description" : "Whether the target is running securely." - }, - "name" : { - "type" : "string", - "description" : "The name of the remote process group." - }, - "comments" : { - "type" : "string", - "description" : "The comments for the remote process group." - }, - "communicationsTimeout" : { - "type" : "string", - "description" : "The time period used for the timeout when communicating with the target." - }, - "yieldDuration" : { - "type" : "string", - "description" : "When yielding, this amount of time must elapse before the remote process group is scheduled again." - }, - "transportProtocol" : { - "type" : "string" - }, - "localNetworkInterface" : { - "type" : "string", - "description" : "The local network interface to send/receive data. If not specified, any local address is used. If clustered, all nodes must have an interface with this identifier." - }, - "proxyHost" : { - "type" : "string" - }, - "proxyPort" : { - "type" : "integer", - "format" : "int32" - }, - "proxyUser" : { - "type" : "string" - }, - "proxyPassword" : { - "type" : "string" - }, - "authorizationIssues" : { - "type" : "array", - "description" : "Any remote authorization issues for the remote process group.", - "items" : { - "type" : "string" - } - }, - "validationErrors" : { - "type" : "array", - "description" : "The validation errors for the remote process group. These validation errors represent the problems with the remote process group that must be resolved before it can transmit.", - "items" : { - "type" : "string" - } - }, - "transmitting" : { - "type" : "boolean", - "description" : "Whether the remote process group is actively transmitting." - }, - "inputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of remote input ports currently available on the target." - }, - "outputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of remote output ports currently available on the target." - }, - "activeRemoteInputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of active remote input ports." - }, - "inactiveRemoteInputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of inactive remote input ports." - }, - "activeRemoteOutputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of active remote output ports." - }, - "inactiveRemoteOutputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of inactive remote output ports." - }, - "flowRefreshed" : { - "type" : "string", - "description" : "The timestamp when this remote process group was last refreshed." - }, - "contents" : { - "description" : "The contents of the remote process group. Will contain available input/output ports.", - "$ref" : "#/definitions/RemoteProcessGroupContentsDTO" - } - } - }, - "RemoteProcessGroupEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "component" : { - "$ref" : "#/definitions/RemoteProcessGroupDTO" - }, - "status" : { - "description" : "The status of the remote process group.", - "$ref" : "#/definitions/RemoteProcessGroupStatusDTO" - }, - "inputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of remote input ports currently available on the target." - }, - "outputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of remote output ports currently available on the target." - }, - "operatePermissions" : { - "description" : "The permissions for this component operations.", - "$ref" : "#/definitions/PermissionsDTO" - } - }, - "xml" : { - "name" : "remoteProcessGroupEntity" - } - }, - "RemoteProcessGroupPortDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the port." - }, - "targetId" : { - "type" : "string", - "description" : "The id of the target port." - }, - "versionedComponentId" : { - "type" : "string", - "description" : "The ID of the corresponding component that is under version control" - }, - "groupId" : { - "type" : "string", - "description" : "The id of the remote process group that the port resides in." - }, - "name" : { - "type" : "string", - "description" : "The name of the target port." - }, - "comments" : { - "type" : "string", - "description" : "The comments as configured on the target port." - }, - "concurrentlySchedulableTaskCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of task that may transmit flowfiles to the target port concurrently." - }, - "transmitting" : { - "type" : "boolean", - "description" : "Whether the remote port is configured for transmission." - }, - "useCompression" : { - "type" : "boolean", - "description" : "Whether the flowfiles are compressed when sent to the target port." - }, - "exists" : { - "type" : "boolean", - "description" : "Whether the target port exists." - }, - "targetRunning" : { - "type" : "boolean", - "description" : "Whether the target port is running." - }, - "connected" : { - "type" : "boolean", - "description" : "Whether the port has either an incoming or outgoing connection." - }, - "batchSettings" : { - "description" : "The batch settings for data transmission.", - "$ref" : "#/definitions/BatchSettingsDTO" - } - } - }, - "RemoteProcessGroupPortEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "remoteProcessGroupPort" : { - "$ref" : "#/definitions/RemoteProcessGroupPortDTO" - }, - "operatePermissions" : { - "description" : "The permissions for this component operations.", - "$ref" : "#/definitions/PermissionsDTO" - } - }, - "xml" : { - "name" : "remoteProcessGroupPortEntity" - } - }, - "RemoteProcessGroupStatusDTO" : { - "type" : "object", - "properties" : { - "groupId" : { - "type" : "string", - "description" : "The unique ID of the process group that the Processor belongs to" - }, - "id" : { - "type" : "string", - "description" : "The unique ID of the Processor" - }, - "name" : { - "type" : "string", - "description" : "The name of the remote process group." - }, - "targetUri" : { - "type" : "string", - "description" : "The URI of the target system." - }, - "transmissionStatus" : { - "type" : "string", - "description" : "The transmission status of the remote process group." - }, - "statsLastRefreshed" : { - "type" : "string", - "description" : "The time the status for the process group was last refreshed." - }, - "validationStatus" : { - "type" : "string", - "description" : "Indicates whether the component is valid, invalid, or still in the process of validating (i.e., it is unknown whether or not the component is valid)", - "readOnly" : true, - "enum" : [ "VALID", "INVALID", "VALIDATING" ] - }, - "aggregateSnapshot" : { - "description" : "A status snapshot that represents the aggregate stats of all nodes in the cluster. If the NiFi instance is a standalone instance, rather than a cluster, this represents the stats of the single instance.", - "$ref" : "#/definitions/RemoteProcessGroupStatusSnapshotDTO" - }, - "nodeSnapshots" : { - "type" : "array", - "description" : "A status snapshot for each node in the cluster. If the NiFi instance is a standalone instance, rather than a cluster, this may be null.", - "items" : { - "$ref" : "#/definitions/NodeRemoteProcessGroupStatusSnapshotDTO" - } - } - } - }, - "RemoteProcessGroupStatusEntity" : { - "type" : "object", - "properties" : { - "remoteProcessGroupStatus" : { - "$ref" : "#/definitions/RemoteProcessGroupStatusDTO" - }, - "canRead" : { - "type" : "boolean", - "description" : "Indicates whether the user can read a given resource.", - "readOnly" : true - } - }, - "xml" : { - "name" : "remoteProcessGroupStatusEntity" - } - }, - "RemoteProcessGroupStatusSnapshotDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the remote process group." - }, - "groupId" : { - "type" : "string", - "description" : "The id of the parent process group the remote process group resides in." - }, - "name" : { - "type" : "string", - "description" : "The name of the remote process group." - }, - "targetUri" : { - "type" : "string", - "description" : "The URI of the target system." - }, - "transmissionStatus" : { - "type" : "string", - "description" : "The transmission status of the remote process group." - }, - "activeThreadCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of active threads for the remote process group." - }, - "flowFilesSent" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of FlowFiles sent to the remote process group in the last 5 minutes." - }, - "bytesSent" : { - "type" : "integer", - "format" : "int64", - "description" : "The size of the FlowFiles sent to the remote process group in the last 5 minutes." - }, - "sent" : { - "type" : "string", - "description" : "The count/size of the flowfiles sent to the remote process group in the last 5 minutes." - }, - "flowFilesReceived" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of FlowFiles received from the remote process group in the last 5 minutes." - }, - "bytesReceived" : { - "type" : "integer", - "format" : "int64", - "description" : "The size of the FlowFiles received from the remote process group in the last 5 minutes." - }, - "received" : { - "type" : "string", - "description" : "The count/size of the flowfiles received from the remote process group in the last 5 minutes." - } - } - }, - "RemoteProcessGroupStatusSnapshotEntity" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the remote process group." - }, - "remoteProcessGroupStatusSnapshot" : { - "$ref" : "#/definitions/RemoteProcessGroupStatusSnapshotDTO" - }, - "canRead" : { - "type" : "boolean", - "description" : "Indicates whether the user can read a given resource.", - "readOnly" : true - } - }, - "xml" : { - "name" : "entity" - } - }, - "RemoteProcessGroupsEntity" : { - "type" : "object", - "properties" : { - "remoteProcessGroups" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/RemoteProcessGroupEntity" - } - } - }, - "xml" : { - "name" : "remoteProcessGroupsEntity" - } - }, - "RemoteQueuePartitionDTO" : { - "type" : "object", - "properties" : { - "totalFlowFileCount" : { - "type" : "integer", - "format" : "int32", - "description" : "Total number of FlowFiles owned by the Connection" - }, - "totalByteCount" : { - "type" : "integer", - "format" : "int64", - "description" : "Total number of bytes that make up the content for the FlowFiles owned by this Connection" - }, - "activeQueueFlowFileCount" : { - "type" : "integer", - "format" : "int32", - "description" : "Total number of FlowFiles that exist in the Connection's Active Queue, immediately available to be offered up to a component" - }, - "activeQueueByteCount" : { - "type" : "integer", - "format" : "int64", - "description" : "Total number of bytes that make up the content for the FlowFiles that are present in the Connection's Active Queue" - }, - "swapFlowFileCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The total number of FlowFiles that are swapped out for this Connection" - }, - "swapByteCount" : { - "type" : "integer", - "format" : "int64", - "description" : "Total number of bytes that make up the content for the FlowFiles that are swapped out to disk for the Connection" - }, - "swapFiles" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of Swap Files that exist for this Connection" - }, - "inFlightFlowFileCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of In-Flight FlowFiles for this Connection. These are FlowFiles that belong to the connection but are currently being operated on by a Processor, Port, etc." - }, - "inFlightByteCount" : { - "type" : "integer", - "format" : "int64", - "description" : "The number bytes that make up the content of the FlowFiles that are In-Flight" - }, - "nodeIdentifier" : { - "type" : "string", - "description" : "The Node Identifier that this queue partition is sending to" - } - } - }, - "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" : { - "componentId" : { - "type" : "string", - "description" : "The UUID of the component whose last event should be replayed." - }, - "nodes" : { - "type" : "string", - "description" : "Which nodes were requested to replay their last provenance event.", - "enum" : [ "ALL", "PRIMARY" ] - }, - "aggregateSnapshot" : { - "description" : "The aggregate result of all nodes' responses", - "$ref" : "#/definitions/ReplayLastEventSnapshotDTO" - }, - "nodeSnapshots" : { - "type" : "array", - "description" : "The node-wise results", - "items" : { - "$ref" : "#/definitions/NodeReplayLastEventSnapshotDTO" - } - } - }, - "xml" : { - "name" : "replayLastEventResponseEntity" - } - }, - "ReplayLastEventSnapshotDTO" : { - "type" : "object", - "properties" : { - "eventsReplayed" : { - "type" : "array", - "description" : "The IDs of the events that were successfully replayed", - "items" : { - "type" : "integer", - "format" : "int64" - } - }, - "failureExplanation" : { - "type" : "string", - "description" : "If unable to replay an event, specifies why the event could not be replayed" - }, - "eventAvailable" : { - "type" : "boolean", - "description" : "Whether or not an event was available. This may not be populated if there was a failure." - } - }, - "xml" : { - "name" : "replayLastEventSnapshot" - } - }, - "ReportingTaskDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "versionedComponentId" : { - "type" : "string", - "description" : "The ID of the corresponding component that is under version control" - }, - "parentGroupId" : { - "type" : "string", - "description" : "The id of parent process group of this component if applicable." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "name" : { - "type" : "string", - "description" : "The name of the reporting task." - }, - "type" : { - "type" : "string", - "description" : "The fully qualified type of the reporting task." - }, - "bundle" : { - "description" : "The details of the artifact that bundled this reporting task type.", - "$ref" : "#/definitions/BundleDTO" - }, - "state" : { - "type" : "string", - "description" : "The state of the reporting task.", - "enum" : [ "RUNNING", "STOPPED", "DISABLED" ] - }, - "comments" : { - "type" : "string", - "description" : "The comments of the reporting task." - }, - "persistsState" : { - "type" : "boolean", - "description" : "Whether the reporting task persists state." - }, - "restricted" : { - "type" : "boolean", - "description" : "Whether the reporting task requires elevated privileges." - }, - "deprecated" : { - "type" : "boolean", - "description" : "Whether the reporting task has been deprecated." - }, - "multipleVersionsAvailable" : { - "type" : "boolean", - "description" : "Whether the reporting task has multiple versions available." - }, - "supportsSensitiveDynamicProperties" : { - "type" : "boolean", - "description" : "Whether the reporting task supports sensitive dynamic properties." - }, - "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." - }, - "defaultSchedulingPeriod" : { - "type" : "object", - "description" : "The default scheduling period for the different scheduling strategies.", - "additionalProperties" : { - "type" : "string" - } - }, - "properties" : { - "type" : "object", - "description" : "The properties of the reporting task.", - "additionalProperties" : { - "type" : "string" - } - }, - "descriptors" : { - "type" : "object", - "description" : "The descriptors for the reporting tasks properties.", - "additionalProperties" : { - "$ref" : "#/definitions/PropertyDescriptorDTO" - } - }, - "sensitiveDynamicPropertyNames" : { - "type" : "array", - "description" : "Set of sensitive dynamic property names", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - }, - "customUiUrl" : { - "type" : "string", - "description" : "The URL for the custom configuration UI for the reporting task." - }, - "annotationData" : { - "type" : "string", - "description" : "The annotation data for the repoting task. This is how the custom UI relays configuration to the reporting task." - }, - "validationErrors" : { - "type" : "array", - "description" : "Gets the validation errors from the reporting task. These validation errors represent the problems with the reporting task that must be resolved before it can be scheduled to run.", - "items" : { - "type" : "string" - } - }, - "validationStatus" : { - "type" : "string", - "description" : "Indicates whether the 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)", - "readOnly" : true, - "enum" : [ "VALID", "INVALID", "VALIDATING" ] - }, - "activeThreadCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of active threads for the reporting task." - }, - "extensionMissing" : { - "type" : "boolean", - "description" : "Whether the underlying extension is missing." - } - } - }, - "ReportingTaskDefinition" : { - "type" : "object", - "required" : [ "type" ], - "properties" : { - "group" : { - "type" : "string", - "description" : "The group name of the bundle that provides the referenced type." - }, - "artifact" : { - "type" : "string", - "description" : "The artifact name of the bundle that provides the referenced type." - }, - "version" : { - "type" : "string", - "description" : "The version 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." - }, - "buildInfo" : { - "description" : "The build metadata for this component", - "$ref" : "#/definitions/BuildInfo" - }, - "providedApiImplementations" : { - "type" : "array", - "description" : "If this type represents a provider for an interface, this lists the APIs it implements", - "items" : { - "$ref" : "#/definitions/DefinedType" - } - }, - "tags" : { - "type" : "array", - "description" : "The tags associated with this type", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - }, - "seeAlso" : { - "type" : "array", - "description" : "The names of other component types that may be related", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - }, - "deprecated" : { - "type" : "boolean", - "description" : "Whether or not the component has been deprecated" - }, - "deprecationReason" : { - "type" : "string", - "description" : "If this component has been deprecated, this optional field can be used to provide an explanation" - }, - "deprecationAlternatives" : { - "type" : "array", - "description" : "If this component has been deprecated, this optional field provides alternatives to use", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - }, - "restricted" : { - "type" : "boolean", - "description" : "Whether or not the component has a general restriction" - }, - "restrictedExplanation" : { - "type" : "string", - "description" : "An optional description of the general restriction" - }, - "explicitRestrictions" : { - "type" : "array", - "description" : "Explicit restrictions that indicate a require permission to use the component", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/Restriction" - } - }, - "stateful" : { - "description" : "Indicates if the component stores state", - "$ref" : "#/definitions/Stateful" - }, - "systemResourceConsiderations" : { - "type" : "array", - "description" : "The system resource considerations for the given component", - "items" : { - "$ref" : "#/definitions/SystemResourceConsideration" - } - }, - "additionalDetails" : { - "type" : "boolean", - "description" : "Indicates if the component has additional details documentation" - }, - "propertyDescriptors" : { - "type" : "object", - "description" : "Descriptions of configuration properties applicable to this component.", - "additionalProperties" : { - "$ref" : "#/definitions/PropertyDescriptor" - } - }, - "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." - }, - "dynamicProperties" : { - "type" : "array", - "description" : "Describes the dynamic properties supported by this component", - "items" : { - "$ref" : "#/definitions/DynamicProperty" - } - }, - "supportedSchedulingStrategies" : { - "type" : "array", - "description" : "The supported scheduling strategies, such as TIME_DRIVER or CRON.", - "items" : { - "type" : "string" - } - }, - "defaultSchedulingStrategy" : { - "type" : "string", - "description" : "The default scheduling strategy for the reporting task." - }, - "defaultSchedulingPeriodBySchedulingStrategy" : { - "type" : "object", - "description" : "The default scheduling period for each scheduling strategy. The scheduling period is expected to be a time period, such as \"30 sec\".", - "additionalProperties" : { - "type" : "string" - } - } - } - }, - "ReportingTaskEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "component" : { - "$ref" : "#/definitions/ReportingTaskDTO" - }, - "operatePermissions" : { - "description" : "The permissions for this component operations.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "status" : { - "description" : "The status for this ReportingTask.", - "readOnly" : true, - "$ref" : "#/definitions/ReportingTaskStatusDTO" - } - }, - "xml" : { - "name" : "reportingTaskEntity" - } - }, - "ReportingTaskRunStatusEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "state" : { - "type" : "string", - "description" : "The run status of the ReportingTask.", - "enum" : [ "RUNNING", "STOPPED" ] - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - } - }, - "xml" : { - "name" : "entity" - } - }, - "ReportingTaskStatusDTO" : { - "type" : "object", - "properties" : { - "runStatus" : { - "type" : "string", - "description" : "The run status of this ReportingTask", - "readOnly" : true, - "enum" : [ "RUNNING", "STOPPED", "DISABLED" ] - }, - "validationStatus" : { - "type" : "string", - "description" : "Indicates whether the component is valid, invalid, or still in the process of validating (i.e., it is unknown whether or not the component is valid)", - "readOnly" : true, - "enum" : [ "VALID", "INVALID", "VALIDATING" ] - }, - "activeThreadCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of active threads for the component." - } - } - }, - "ReportingTaskTypesEntity" : { - "type" : "object", - "properties" : { - "reportingTaskTypes" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/DocumentedTypeDTO" - } - } - }, - "xml" : { - "name" : "reportingTaskTypesEntity" - } - }, - "ReportingTasksEntity" : { - "type" : "object", - "properties" : { - "reportingTasks" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ReportingTaskEntity" - } - } - }, - "xml" : { - "name" : "reportingTasksEntity" - } - }, - "RepositoryUsageDTO" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The name of the repository" - }, - "fileStoreHash" : { - "type" : "string", - "description" : "A SHA-256 hash of the File Store name/path that is used to store the repository's data. This information is exposed as a hash in order to avoid exposing potentially sensitive information that is not generally relevant. What is typically relevant is whether or not multiple repositories on the same node are using the same File Store, as this indicates that the repositories are competing for the resources of the backing disk/storage mechanism." - }, - "freeSpace" : { - "type" : "string", - "description" : "Amount of free space." - }, - "totalSpace" : { - "type" : "string", - "description" : "Amount of total space." - }, - "freeSpaceBytes" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes of free space." - }, - "totalSpaceBytes" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes of total space." - }, - "utilization" : { - "type" : "string", - "description" : "Utilization of this storage location." - } - } - }, - "RequiredPermissionDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The required sub-permission necessary for this restriction." - }, - "label" : { - "type" : "string", - "description" : "The label for the required sub-permission necessary for this restriction." - } - } - }, - "ResourceDTO" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The identifier of the resource." - }, - "name" : { - "type" : "string", - "description" : "The name of the resource." - } - } - }, - "ResourcesEntity" : { - "type" : "object", - "properties" : { - "resources" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/ResourceDTO" - } - } - }, - "xml" : { - "name" : "resourcesEntity" - } - }, - "Response" : { - "type" : "object", - "properties" : { - "status" : { - "type" : "integer", - "format" : "int32" - }, - "metadata" : { - "type" : "object", - "additionalProperties" : { - "type" : "array", - "items" : { - "type" : "object" - } - } - }, - "entity" : { - "type" : "object" - } - } - }, - "Restriction" : { - "type" : "object", - "properties" : { - "requiredPermission" : { - "type" : "string", - "description" : "The permission required for this restriction" - }, - "explanation" : { - "type" : "string", - "description" : "The explanation of this restriction" - } - } - }, - "RevisionDTO" : { - "type" : "object", - "properties" : { - "clientId" : { - "type" : "string", - "description" : "A client identifier used to make a request. By including a client identifier, the API can allow multiple requests without needing the current revision. Due to the asynchronous nature of requests/responses this was implemented to allow the client to make numerous requests without having to wait for the previous response to come back" - }, - "version" : { - "type" : "integer", - "format" : "int64", - "description" : "NiFi employs an optimistic locking strategy where the client must include a revision in their request when performing an update. In a response to a mutable flow request, this field represents the updated base version." - }, - "lastModifier" : { - "type" : "string", - "description" : "The user that last modified the flow.", - "readOnly" : true - } - } - }, - "RunStatusDetailsRequestEntity" : { - "type" : "object", - "properties" : { - "processorIds" : { - "type" : "array", - "description" : "The IDs of all processors whose run status details should be provided", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - } - }, - "xml" : { - "name" : "runStatusDetailsRequest" - } - }, - "RuntimeManifest" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "A unique identifier for the manifest" - }, - "agentType" : { - "type" : "string", - "description" : "The type of the runtime binary, e.g., 'minifi-java' or 'minifi-cpp'" - }, - "version" : { - "type" : "string", - "description" : "The version of the runtime binary, e.g., '1.0.1'" - }, - "buildInfo" : { - "description" : "Build summary for this runtime binary", - "$ref" : "#/definitions/BuildInfo" - }, - "bundles" : { - "type" : "array", - "description" : "All extension bundles included with this runtime", - "items" : { - "$ref" : "#/definitions/Bundle" - } - }, - "schedulingDefaults" : { - "description" : "Scheduling defaults for components defined in this manifest", - "$ref" : "#/definitions/SchedulingDefaults" - } - } - }, - "RuntimeManifestEntity" : { - "type" : "object", - "properties" : { - "runtimeManifest" : { - "$ref" : "#/definitions/RuntimeManifest" - } - }, - "xml" : { - "name" : "runtimeManifestEntity" - } - }, - "ScheduleComponentsEntity" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the ProcessGroup" - }, - "state" : { - "type" : "string", - "description" : "The desired state of the descendant components", - "enum" : [ "RUNNING", "STOPPED", "ENABLED", "DISABLED" ] - }, - "components" : { - "type" : "object", - "description" : "Optional components to schedule. If not specified, all authorized descendant components will be used.", - "additionalProperties" : { - "$ref" : "#/definitions/RevisionDTO" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - } - }, - "xml" : { - "name" : "scheduleComponentEntity" - } - }, - "SchedulingDefaults" : { - "type" : "object", - "properties" : { - "defaultSchedulingStrategy" : { - "type" : "string", - "description" : "The name of the default scheduling strategy", - "enum" : [ "EVENT_DRIVEN", "TIMER_DRIVEN", "PRIMARY_NODE_ONLY", "CRON_DRIVEN" ] - }, - "defaultSchedulingPeriodMillis" : { - "type" : "integer", - "format" : "int64", - "description" : "The default scheduling period in milliseconds" - }, - "penalizationPeriodMillis" : { - "type" : "integer", - "format" : "int64", - "description" : "The default penalization period in milliseconds" - }, - "yieldDurationMillis" : { - "type" : "integer", - "format" : "int64", - "description" : "The default yield duration in milliseconds" - }, - "defaultRunDurationNanos" : { - "type" : "integer", - "format" : "int64", - "description" : "The default run duration in nano-seconds" - }, - "defaultMaxConcurrentTasks" : { - "type" : "string", - "description" : "The default concurrent tasks" - }, - "defaultConcurrentTasksBySchedulingStrategy" : { - "type" : "object", - "description" : "The default concurrent tasks for each scheduling strategy", - "additionalProperties" : { - "type" : "integer", - "format" : "int32" - } - }, - "defaultSchedulingPeriodsBySchedulingStrategy" : { - "type" : "object", - "description" : "The default scheduling period for each scheduling strategy", - "additionalProperties" : { - "type" : "string" - } - } - } - }, - "SearchResultGroupDTO" : { - "type" : "object", - "required" : [ "id" ], - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the group." - }, - "name" : { - "type" : "string", - "description" : "The name of the group." - } - } - }, - "SearchResultsDTO" : { - "type" : "object", - "properties" : { - "processorResults" : { - "type" : "array", - "description" : "The processors that matched the search.", - "items" : { - "$ref" : "#/definitions/ComponentSearchResultDTO" - } - }, - "connectionResults" : { - "type" : "array", - "description" : "The connections that matched the search.", - "items" : { - "$ref" : "#/definitions/ComponentSearchResultDTO" - } - }, - "processGroupResults" : { - "type" : "array", - "description" : "The process groups that matched the search.", - "items" : { - "$ref" : "#/definitions/ComponentSearchResultDTO" - } - }, - "inputPortResults" : { - "type" : "array", - "description" : "The input ports that matched the search.", - "items" : { - "$ref" : "#/definitions/ComponentSearchResultDTO" - } - }, - "outputPortResults" : { - "type" : "array", - "description" : "The output ports that matched the search.", - "items" : { - "$ref" : "#/definitions/ComponentSearchResultDTO" - } - }, - "remoteProcessGroupResults" : { - "type" : "array", - "description" : "The remote process groups that matched the search.", - "items" : { - "$ref" : "#/definitions/ComponentSearchResultDTO" - } - }, - "funnelResults" : { - "type" : "array", - "description" : "The funnels that matched the search.", - "items" : { - "$ref" : "#/definitions/ComponentSearchResultDTO" - } - }, - "labelResults" : { - "type" : "array", - "description" : "The labels that matched the search.", - "items" : { - "$ref" : "#/definitions/ComponentSearchResultDTO" - } - }, - "controllerServiceNodeResults" : { - "type" : "array", - "description" : "The controller service nodes that matched the search", - "items" : { - "$ref" : "#/definitions/ComponentSearchResultDTO" - } - }, - "parameterContextResults" : { - "type" : "array", - "description" : "The parameter contexts that matched the search.", - "items" : { - "$ref" : "#/definitions/ComponentSearchResultDTO" - } - }, - "parameterProviderNodeResults" : { - "type" : "array", - "description" : "The parameter provider nodes that matched the search", - "items" : { - "$ref" : "#/definitions/ComponentSearchResultDTO" - } - }, - "parameterResults" : { - "type" : "array", - "description" : "The parameters that matched the search.", - "items" : { - "$ref" : "#/definitions/ComponentSearchResultDTO" - } - } - } - }, - "SearchResultsEntity" : { - "type" : "object", - "properties" : { - "searchResultsDTO" : { - "$ref" : "#/definitions/SearchResultsDTO" - } - }, - "xml" : { - "name" : "searchResultsEntity" - } - }, - "SnippetDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the snippet." - }, - "uri" : { - "type" : "string", - "description" : "The URI of the snippet." - }, - "parentGroupId" : { - "type" : "string", - "description" : "The group id for the components in the snippet." - }, - "processGroups" : { - "type" : "object", - "description" : "The ids of the process groups in this snippet. These ids will be populated within each response. They can be specified when creating a snippet. However, once a snippet has been created its contents cannot be modified (these ids are ignored during update requests).", - "additionalProperties" : { - "$ref" : "#/definitions/RevisionDTO" - } - }, - "remoteProcessGroups" : { - "type" : "object", - "description" : "The ids of the remote process groups in this snippet. These ids will be populated within each response. They can be specified when creating a snippet. However, once a snippet has been created its contents cannot be modified (these ids are ignored during update requests).", - "additionalProperties" : { - "$ref" : "#/definitions/RevisionDTO" - } - }, - "processors" : { - "type" : "object", - "description" : "The ids of the processors in this snippet. These ids will be populated within each response. They can be specified when creating a snippet. However, once a snippet has been created its contents cannot be modified (these ids are ignored during update requests).", - "additionalProperties" : { - "$ref" : "#/definitions/RevisionDTO" - } - }, - "inputPorts" : { - "type" : "object", - "description" : "The ids of the input ports in this snippet. These ids will be populated within each response. They can be specified when creating a snippet. However, once a snippet has been created its contents cannot be modified (these ids are ignored during update requests).", - "additionalProperties" : { - "$ref" : "#/definitions/RevisionDTO" - } - }, - "outputPorts" : { - "type" : "object", - "description" : "The ids of the output ports in this snippet. These ids will be populated within each response. They can be specified when creating a snippet. However, once a snippet has been created its contents cannot be modified (these ids are ignored during update requests).", - "additionalProperties" : { - "$ref" : "#/definitions/RevisionDTO" - } - }, - "connections" : { - "type" : "object", - "description" : "The ids of the connections in this snippet. These ids will be populated within each response. They can be specified when creating a snippet. However, once a snippet has been created its contents cannot be modified (these ids are ignored during update requests).", - "additionalProperties" : { - "$ref" : "#/definitions/RevisionDTO" - } - }, - "labels" : { - "type" : "object", - "description" : "The ids of the labels in this snippet. These ids will be populated within each response. They can be specified when creating a snippet. However, once a snippet has been created its contents cannot be modified (these ids are ignored during update requests).", - "additionalProperties" : { - "$ref" : "#/definitions/RevisionDTO" - } - }, - "funnels" : { - "type" : "object", - "description" : "The ids of the funnels in this snippet. These ids will be populated within each response. They can be specified when creating a snippet. However, once a snippet has been created its contents cannot be modified (these ids are ignored during update requests).", - "additionalProperties" : { - "$ref" : "#/definitions/RevisionDTO" - } - } - } - }, - "SnippetEntity" : { - "type" : "object", - "properties" : { - "snippet" : { - "description" : "The snippet.", - "$ref" : "#/definitions/SnippetDTO" - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - } - }, - "xml" : { - "name" : "snippetEntity" - } - }, - "StackTraceElement" : { - "type" : "object", - "properties" : { - "classLoaderName" : { - "type" : "string" - }, - "moduleName" : { - "type" : "string" - }, - "moduleVersion" : { - "type" : "string" - }, - "methodName" : { - "type" : "string" - }, - "fileName" : { - "type" : "string" - }, - "lineNumber" : { - "type" : "integer", - "format" : "int32" - }, - "nativeMethod" : { - "type" : "boolean" - }, - "className" : { - "type" : "string" - } - } - }, - "StartVersionControlRequestEntity" : { - "type" : "object", - "properties" : { - "versionedFlow" : { - "description" : "The versioned flow", - "$ref" : "#/definitions/VersionedFlowDTO" - }, - "processGroupRevision" : { - "description" : "The Revision of the Process Group under Version Control", - "$ref" : "#/definitions/RevisionDTO" - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - } - }, - "xml" : { - "name" : "startVersionControlRequestEntity" - } - }, - "StateEntryDTO" : { - "type" : "object", - "properties" : { - "key" : { - "type" : "string", - "description" : "The key for this state." - }, - "value" : { - "type" : "string", - "description" : "The value for this state." - }, - "clusterNodeId" : { - "type" : "string", - "description" : "The identifier for the node where the state originated." - }, - "clusterNodeAddress" : { - "type" : "string", - "description" : "The label for the node where the state originated." - } - } - }, - "StateMapDTO" : { - "type" : "object", - "properties" : { - "scope" : { - "type" : "string", - "description" : "The scope of this StateMap." - }, - "totalEntryCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The total number of state entries. When the state map is lengthy, only of portion of the entries are returned." - }, - "state" : { - "type" : "array", - "description" : "The state.", - "items" : { - "$ref" : "#/definitions/StateEntryDTO" - } - } - } - }, - "Stateful" : { - "type" : "object", - "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", - "uniqueItems" : true, - "items" : { - "type" : "string", - "enum" : [ "CLUSTER", "LOCAL" ] - } - } - } - }, - "StatusDescriptorDTO" : { - "type" : "object", - "properties" : { - "field" : { - "type" : "string", - "description" : "The name of the status field." - }, - "label" : { - "type" : "string", - "description" : "The label for the status field." - }, - "description" : { - "type" : "string", - "description" : "The description of the status field." - }, - "formatter" : { - "type" : "string", - "description" : "The formatter for the status descriptor." - } - } - }, - "StatusHistoryDTO" : { - "type" : "object", - "properties" : { - "generated" : { - "type" : "string", - "description" : "When the status history was generated." - }, - "componentDetails" : { - "type" : "object", - "description" : "A Map of key/value pairs that describe the component that the status history belongs to", - "additionalProperties" : { - "type" : "string" - } - }, - "fieldDescriptors" : { - "type" : "array", - "description" : "The Descriptors that provide information on each of the metrics provided in the status history", - "items" : { - "$ref" : "#/definitions/StatusDescriptorDTO" - } - }, - "aggregateSnapshots" : { - "type" : "array", - "description" : "A list of StatusSnapshotDTO objects that provide the actual metric values for the component. If the NiFi instance is clustered, this will represent the aggregate status across all nodes. If the NiFi instance is not clustered, this will represent the status of the entire NiFi instance.", - "items" : { - "$ref" : "#/definitions/StatusSnapshotDTO" - } - }, - "nodeSnapshots" : { - "type" : "array", - "description" : "The NodeStatusSnapshotsDTO objects that provide the actual metric values for the component, for each node. If the NiFi instance is not clustered, this value will be null.", - "items" : { - "$ref" : "#/definitions/NodeStatusSnapshotsDTO" - } - } - } - }, - "StatusHistoryEntity" : { - "type" : "object", - "properties" : { - "statusHistory" : { - "$ref" : "#/definitions/StatusHistoryDTO" - }, - "canRead" : { - "type" : "boolean", - "description" : "Indicates whether the user can read a given resource.", - "readOnly" : true - } - }, - "xml" : { - "name" : "statusHistoryEntity" - } - }, - "StatusSnapshotDTO" : { - "type" : "object", - "properties" : { - "timestamp" : { - "type" : "string", - "format" : "date-time", - "description" : "The timestamp of the snapshot." - }, - "statusMetrics" : { - "type" : "object", - "description" : "The status metrics.", - "additionalProperties" : { - "type" : "integer", - "format" : "int64" - } - } - } - }, - "StorageUsageDTO" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The identifier of this storage location. The identifier will correspond to the identifier keyed in the storage configuration." - }, - "freeSpace" : { - "type" : "string", - "description" : "Amount of free space." - }, - "totalSpace" : { - "type" : "string", - "description" : "Amount of total space." - }, - "usedSpace" : { - "type" : "string", - "description" : "Amount of used space." - }, - "freeSpaceBytes" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes of free space." - }, - "totalSpaceBytes" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes of total space." - }, - "usedSpaceBytes" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes of used space." - }, - "utilization" : { - "type" : "string", - "description" : "Utilization of this storage location." - } - } - }, - "StreamingOutput" : { - "type" : "object" - }, - "SubmitReplayRequestEntity" : { - "type" : "object", - "properties" : { - "eventId" : { - "type" : "integer", - "format" : "int64", - "description" : "The event identifier" - }, - "clusterNodeId" : { - "type" : "string", - "description" : "The identifier of the node where to submit the replay request." - } - }, - "xml" : { - "name" : "copySnippetRequestEntity" - } - }, - "SystemDiagnosticsDTO" : { - "type" : "object", - "properties" : { - "aggregateSnapshot" : { - "description" : "A systems diagnostic snapshot that represents the aggregate values of all nodes in the cluster. If the NiFi instance is a standalone instance, rather than a cluster, this represents the stats of the single instance.", - "$ref" : "#/definitions/SystemDiagnosticsSnapshotDTO" - }, - "nodeSnapshots" : { - "type" : "array", - "description" : "A systems diagnostics snapshot for each node in the cluster. If the NiFi instance is a standalone instance, rather than a cluster, this may be null.", - "items" : { - "$ref" : "#/definitions/NodeSystemDiagnosticsSnapshotDTO" - } - } - } - }, - "SystemDiagnosticsEntity" : { - "type" : "object", - "properties" : { - "systemDiagnostics" : { - "$ref" : "#/definitions/SystemDiagnosticsDTO" - } - }, - "xml" : { - "name" : "systemDiagnosticsEntity" - } - }, - "SystemDiagnosticsSnapshotDTO" : { - "type" : "object", - "properties" : { - "totalNonHeap" : { - "type" : "string", - "description" : "Total size of non heap." - }, - "totalNonHeapBytes" : { - "type" : "integer", - "format" : "int64", - "description" : "Total number of bytes allocated to the JVM not used for heap" - }, - "usedNonHeap" : { - "type" : "string", - "description" : "Amount of use non heap." - }, - "usedNonHeapBytes" : { - "type" : "integer", - "format" : "int64", - "description" : "Total number of bytes used by the JVM not in the heap space" - }, - "freeNonHeap" : { - "type" : "string", - "description" : "Amount of free non heap." - }, - "freeNonHeapBytes" : { - "type" : "integer", - "format" : "int64", - "description" : "Total number of free non-heap bytes available to the JVM" - }, - "maxNonHeap" : { - "type" : "string", - "description" : "Maximum size of non heap." - }, - "maxNonHeapBytes" : { - "type" : "integer", - "format" : "int64", - "description" : "The maximum number of bytes that the JVM can use for non-heap purposes" - }, - "nonHeapUtilization" : { - "type" : "string", - "description" : "Utilization of non heap." - }, - "totalHeap" : { - "type" : "string", - "description" : "Total size of heap." - }, - "totalHeapBytes" : { - "type" : "integer", - "format" : "int64", - "description" : "The total number of bytes that are available for the JVM heap to use" - }, - "usedHeap" : { - "type" : "string", - "description" : "Amount of used heap." - }, - "usedHeapBytes" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes of JVM heap that are currently being used" - }, - "freeHeap" : { - "type" : "string", - "description" : "Amount of free heap." - }, - "freeHeapBytes" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes that are allocated to the JVM heap but not currently being used" - }, - "maxHeap" : { - "type" : "string", - "description" : "Maximum size of heap." - }, - "maxHeapBytes" : { - "type" : "integer", - "format" : "int64", - "description" : "The maximum number of bytes that can be used by the JVM" - }, - "heapUtilization" : { - "type" : "string", - "description" : "Utilization of heap." - }, - "availableProcessors" : { - "type" : "integer", - "format" : "int32", - "description" : "Number of available processors if supported by the underlying system." - }, - "processorLoadAverage" : { - "type" : "number", - "format" : "double", - "description" : "The processor load average if supported by the underlying system." - }, - "totalThreads" : { - "type" : "integer", - "format" : "int32", - "description" : "Total number of threads." - }, - "daemonThreads" : { - "type" : "integer", - "format" : "int32", - "description" : "Number of daemon threads." - }, - "uptime" : { - "type" : "string", - "description" : "The uptime of the Java virtual machine" - }, - "flowFileRepositoryStorageUsage" : { - "description" : "The flowfile repository storage usage.", - "$ref" : "#/definitions/StorageUsageDTO" - }, - "contentRepositoryStorageUsage" : { - "type" : "array", - "description" : "The content repository storage usage.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/StorageUsageDTO" - } - }, - "provenanceRepositoryStorageUsage" : { - "type" : "array", - "description" : "The provenance repository storage usage.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/StorageUsageDTO" - } - }, - "garbageCollection" : { - "type" : "array", - "description" : "The garbage collection details.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/GarbageCollectionDTO" - } - }, - "statsLastRefreshed" : { - "type" : "string", - "description" : "When the diagnostics were generated." - }, - "versionInfo" : { - "description" : "The nifi, os, java, and build version information", - "$ref" : "#/definitions/VersionInfoDTO" - } - } - }, - "SystemResourceConsideration" : { - "type" : "object", - "properties" : { - "resource" : { - "type" : "string", - "description" : "The resource to consider" - }, - "description" : { - "type" : "string", - "description" : "The description of how the resource is affected" - } - } - }, - "TemplateDTO" : { - "type" : "object", - "properties" : { - "uri" : { - "type" : "string", - "description" : "The URI for the template." - }, - "id" : { - "type" : "string", - "description" : "The id of the template." - }, - "groupId" : { - "type" : "string", - "description" : "The id of the Process Group that the template belongs to." - }, - "name" : { - "type" : "string", - "description" : "The name of the template." - }, - "description" : { - "type" : "string", - "description" : "The description of the template." - }, - "timestamp" : { - "type" : "string", - "description" : "The timestamp when this template was created." - }, - "encodingVersion" : { - "type" : "string", - "xml" : { - "name" : "encoding-version", - "attribute" : true - }, - "description" : "The encoding version of this template." - }, - "snippet" : { - "description" : "The contents of the template.", - "$ref" : "#/definitions/FlowSnippetDTO" - } - }, - "xml" : { - "name" : "template" - } - }, - "TemplateEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "template" : { - "$ref" : "#/definitions/TemplateDTO" - } - }, - "xml" : { - "name" : "templateEntity" - } - }, - "TemplatesEntity" : { - "type" : "object", - "properties" : { - "templates" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/TemplateEntity" - } - }, - "generated" : { - "type" : "string", - "description" : "When this content was generated." - } - }, - "xml" : { - "name" : "templatesEntity" - } - }, - "TenantDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "versionedComponentId" : { - "type" : "string", - "description" : "The ID of the corresponding component that is under version control" - }, - "parentGroupId" : { - "type" : "string", - "description" : "The id of parent process group of this component if applicable." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "identity" : { - "type" : "string", - "description" : "The identity of the tenant." - }, - "configurable" : { - "type" : "boolean", - "description" : "Whether this tenant is configurable." - } - } - }, - "TenantEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "component" : { - "$ref" : "#/definitions/TenantDTO" - } - }, - "xml" : { - "name" : "tenantEntity" - } - }, - "TenantsEntity" : { - "type" : "object", - "properties" : { - "users" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/TenantEntity" - } - }, - "userGroups" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/TenantEntity" - } - } - }, - "xml" : { - "name" : "tenantsEntity" - } - }, - "ThreadDumpDTO" : { - "type" : "object", - "properties" : { - "nodeId" : { - "type" : "string", - "description" : "The ID of the node in the cluster" - }, - "nodeAddress" : { - "type" : "string", - "description" : "The address of the node in the cluster" - }, - "apiPort" : { - "type" : "integer", - "format" : "int32", - "description" : "The port the node is listening for API requests." - }, - "stackTrace" : { - "type" : "string", - "description" : "The stack trace for the thread" - }, - "threadName" : { - "type" : "string", - "description" : "The name of the thread" - }, - "threadActiveMillis" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of milliseconds that the thread has been executing in the Processor" - }, - "taskTerminated" : { - "type" : "boolean", - "description" : "Indicates whether or not the user has requested that the task be terminated. If this is true, it may indicate that the thread is in a state where it will continue running indefinitely without returning." - } - } - }, - "Throwable" : { - "type" : "object", - "properties" : { - "cause" : { - "$ref" : "#/definitions/Throwable" - }, - "stackTrace" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/StackTraceElement" - } - }, - "message" : { - "type" : "string" - }, - "suppressed" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/Throwable" - } - }, - "localizedMessage" : { - "type" : "string" - } - } - }, - "TransactionResultEntity" : { - "type" : "object", - "properties" : { - "flowFileSent" : { - "type" : "integer", - "format" : "int32" - }, - "responseCode" : { - "type" : "integer", - "format" : "int32" - }, - "message" : { - "type" : "string" - } - }, - "xml" : { - "name" : "transactionResultEntity" - } - }, - "UpdateControllerServiceReferenceRequestEntity" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The identifier of the Controller Service." - }, - "state" : { - "type" : "string", - "description" : "The new state of the references for the controller service.", - "enum" : [ "ENABLED", "DISABLED", "RUNNING", "STOPPED" ] - }, - "referencingComponentRevisions" : { - "type" : "object", - "description" : "The revisions for all referencing components.", - "additionalProperties" : { - "$ref" : "#/definitions/RevisionDTO" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "uiOnly" : { - "type" : "boolean", - "description" : "Indicates whether or not the response should only include fields necessary for rendering the NiFi User Interface. As such, when this value is set to true, some fields may be returned as null values, and the selected fields may change at any time without notice. As a result, this value should not be set to true by any client other than the UI." - } - }, - "xml" : { - "name" : "updateControllerServiceReferenceRequestEntity" - } - }, - "UserDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "versionedComponentId" : { - "type" : "string", - "description" : "The ID of the corresponding component that is under version control" - }, - "parentGroupId" : { - "type" : "string", - "description" : "The id of parent process group of this component if applicable." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "identity" : { - "type" : "string", - "description" : "The identity of the tenant." - }, - "configurable" : { - "type" : "boolean", - "description" : "Whether this tenant is configurable." - }, - "userGroups" : { - "type" : "array", - "description" : "The groups to which the user belongs. This field is read only and it provided for convenience.", - "readOnly" : true, - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/TenantEntity" - } - }, - "accessPolicies" : { - "type" : "array", - "description" : "The access policies this user belongs to.", - "readOnly" : true, - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/AccessPolicySummaryEntity" - } - } - } - }, - "UserEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "component" : { - "$ref" : "#/definitions/UserDTO" - } - }, - "xml" : { - "name" : "userEntity" - } - }, - "UserGroupDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "versionedComponentId" : { - "type" : "string", - "description" : "The ID of the corresponding component that is under version control" - }, - "parentGroupId" : { - "type" : "string", - "description" : "The id of parent process group of this component if applicable." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "identity" : { - "type" : "string", - "description" : "The identity of the tenant." - }, - "configurable" : { - "type" : "boolean", - "description" : "Whether this tenant is configurable." - }, - "users" : { - "type" : "array", - "description" : "The users that belong to the user group.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/TenantEntity" - } - }, - "accessPolicies" : { - "type" : "array", - "description" : "The access policies this user group belongs to. This field was incorrectly defined as an AccessPolicyEntity. For compatibility reasons the field will remain of this type, however only the fields that are present in the AccessPolicySummaryEntity will be populated here.", - "readOnly" : true, - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/AccessPolicyEntity" - } - } - } - }, - "UserGroupEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "component" : { - "$ref" : "#/definitions/UserGroupDTO" - } - }, - "xml" : { - "name" : "userGroupEntity" - } - }, - "UserGroupsEntity" : { - "type" : "object", - "properties" : { - "userGroups" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/UserGroupEntity" - } - } - }, - "xml" : { - "name" : "userGroupsEntity" - } - }, - "UsersEntity" : { - "type" : "object", - "properties" : { - "generated" : { - "type" : "string", - "description" : "When this content was generated." - }, - "users" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/UserEntity" - } - } - }, - "xml" : { - "name" : "usersEntity" - } - }, - "VariableDTO" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The name of the variable" - }, - "value" : { - "type" : "string", - "description" : "The value of the variable" - }, - "processGroupId" : { - "type" : "string", - "description" : "The ID of the Process Group where this Variable is defined", - "readOnly" : true - }, - "affectedComponents" : { - "type" : "array", - "description" : "A set of all components that will be affected if the value of this variable is changed", - "readOnly" : true, - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/AffectedComponentEntity" - } - } - } - }, - "VariableEntity" : { - "type" : "object", - "properties" : { - "variable" : { - "description" : "The variable information", - "$ref" : "#/definitions/VariableDTO" - }, - "canWrite" : { - "type" : "boolean", - "description" : "Indicates whether the user can write a given resource.", - "readOnly" : true - } - }, - "xml" : { - "name" : "variableEntity" - } - }, - "VariableRegistryDTO" : { - "type" : "object", - "properties" : { - "variables" : { - "type" : "array", - "description" : "The variables that are available in this Variable Registry", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VariableEntity" - } - }, - "processGroupId" : { - "type" : "string", - "description" : "The UUID of the Process Group that this Variable Registry belongs to" - } - } - }, - "VariableRegistryEntity" : { - "type" : "object", - "properties" : { - "processGroupRevision" : { - "description" : "The revision of the Process Group that the Variable Registry belongs to", - "$ref" : "#/definitions/RevisionDTO" - }, - "variableRegistry" : { - "description" : "The Variable Registry.", - "$ref" : "#/definitions/VariableRegistryDTO" - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - } - }, - "xml" : { - "name" : "variableRegistryEntity" - } - }, - "VariableRegistryUpdateRequestDTO" : { - "type" : "object", - "properties" : { - "requestId" : { - "type" : "string", - "description" : "The ID of the request", - "readOnly" : true - }, - "uri" : { - "type" : "string", - "description" : "The URI for the request", - "readOnly" : true - }, - "submissionTime" : { - "type" : "string", - "format" : "date-time", - "description" : "The timestamp of when the request was submitted", - "readOnly" : true - }, - "lastUpdated" : { - "type" : "string", - "format" : "date-time", - "description" : "The timestamp of when the request was last updated", - "readOnly" : true - }, - "complete" : { - "type" : "boolean", - "description" : "Whether or not the request is completed", - "readOnly" : true - }, - "failureReason" : { - "type" : "string", - "description" : "The reason for the request failing, or null if the request has not failed", - "readOnly" : true - }, - "percentCompleted" : { - "type" : "integer", - "format" : "int32", - "description" : "A value between 0 and 100 (inclusive) indicating how close the request is to completion", - "readOnly" : true - }, - "state" : { - "type" : "string", - "description" : "A description of the current state of the request", - "readOnly" : true - }, - "updateSteps" : { - "type" : "array", - "description" : "The steps that are required in order to complete the request, along with the status of each", - "readOnly" : true, - "items" : { - "$ref" : "#/definitions/VariableRegistryUpdateStepDTO" - } - }, - "processGroupId" : { - "type" : "string", - "description" : "The unique ID of the Process Group that the variable registry belongs to" - }, - "affectedComponents" : { - "type" : "array", - "description" : "A set of all components that will be affected if the value of this variable is changed", - "readOnly" : true, - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/AffectedComponentEntity" - } - } - } - }, - "VariableRegistryUpdateRequestEntity" : { - "type" : "object", - "properties" : { - "request" : { - "description" : "The Variable Registry Update Request", - "$ref" : "#/definitions/VariableRegistryUpdateRequestDTO" - }, - "processGroupRevision" : { - "description" : "The revision for the Process Group that owns this variable registry.", - "$ref" : "#/definitions/RevisionDTO" - } - }, - "xml" : { - "name" : "variableRegistryUpdateRequestEntity" - } - }, - "VariableRegistryUpdateStepDTO" : { - "type" : "object", - "properties" : { - "description" : { - "type" : "string", - "description" : "Explanation of what happens in this step", - "readOnly" : true - }, - "complete" : { - "type" : "boolean", - "description" : "Whether or not this step has completed", - "readOnly" : true - }, - "failureReason" : { - "type" : "string", - "description" : "An explanation of why this step failed, or null if this step did not fail", - "readOnly" : true - } - } - }, - "VerifyConfigRequestDTO" : { - "type" : "object", - "properties" : { - "requestId" : { - "type" : "string", - "description" : "The ID of the request", - "readOnly" : true - }, - "uri" : { - "type" : "string", - "description" : "The URI for the request", - "readOnly" : true - }, - "submissionTime" : { - "type" : "string", - "format" : "date-time", - "description" : "The timestamp of when the request was submitted", - "readOnly" : true - }, - "lastUpdated" : { - "type" : "string", - "format" : "date-time", - "description" : "The timestamp of when the request was last updated", - "readOnly" : true - }, - "complete" : { - "type" : "boolean", - "description" : "Whether or not the request is completed", - "readOnly" : true - }, - "failureReason" : { - "type" : "string", - "description" : "The reason for the request failing, or null if the request has not failed", - "readOnly" : true - }, - "percentCompleted" : { - "type" : "integer", - "format" : "int32", - "description" : "A value between 0 and 100 (inclusive) indicating how close the request is to completion", - "readOnly" : true - }, - "state" : { - "type" : "string", - "description" : "A description of the current state of the request", - "readOnly" : true - }, - "updateSteps" : { - "type" : "array", - "description" : "The steps that are required in order to complete the request, along with the status of each", - "readOnly" : true, - "items" : { - "$ref" : "#/definitions/VerifyConfigUpdateStepDTO" - } - }, - "componentId" : { - "type" : "string", - "description" : "The ID of the component whose configuration was verified" - }, - "properties" : { - "type" : "object", - "description" : "The configured component properties", - "additionalProperties" : { - "type" : "string" - } - }, - "attributes" : { - "type" : "object", - "description" : "FlowFile Attributes that should be used to evaluate Expression Language for resolving property values", - "additionalProperties" : { - "type" : "string" - } - }, - "results" : { - "type" : "array", - "description" : "The Results of the verification", - "readOnly" : true, - "items" : { - "$ref" : "#/definitions/ConfigVerificationResultDTO" - } - } - } - }, - "VerifyConfigRequestEntity" : { - "type" : "object", - "properties" : { - "request" : { - "description" : "The request", - "$ref" : "#/definitions/VerifyConfigRequestDTO" - } - }, - "xml" : { - "name" : "verifyConfigRequest" - } - }, - "VerifyConfigUpdateStepDTO" : { - "type" : "object", - "properties" : { - "description" : { - "type" : "string", - "description" : "Explanation of what happens in this step", - "readOnly" : true - }, - "complete" : { - "type" : "boolean", - "description" : "Whether or not this step has completed", - "readOnly" : true - }, - "failureReason" : { - "type" : "string", - "description" : "An explanation of why this step failed, or null if this step did not fail", - "readOnly" : true - } - } - }, - "VersionControlComponentMappingEntity" : { - "type" : "object", - "properties" : { - "versionControlComponentMapping" : { - "type" : "object", - "description" : "The mapping of Versioned Component Identifiers to instance ID's", - "additionalProperties" : { - "type" : "string" - } - }, - "processGroupRevision" : { - "description" : "The revision of the Process Group", - "$ref" : "#/definitions/RevisionDTO" - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "versionControlInformation" : { - "description" : "The Version Control information", - "$ref" : "#/definitions/VersionControlInformationDTO" - } - }, - "xml" : { - "name" : "versionControlComponentMappingEntity" - } - }, - "VersionControlInformationDTO" : { - "type" : "object", - "properties" : { - "groupId" : { - "type" : "string", - "description" : "The ID of the Process Group that is under version control" - }, - "registryId" : { - "type" : "string", - "description" : "The ID of the registry that the flow is stored in" - }, - "registryName" : { - "type" : "string", - "description" : "The name of the registry that the flow is stored in", - "readOnly" : true - }, - "bucketId" : { - "type" : "string", - "description" : "The ID of the bucket that the flow is stored in" - }, - "bucketName" : { - "type" : "string", - "description" : "The name of the bucket that the flow is stored in", - "readOnly" : true - }, - "flowId" : { - "type" : "string", - "description" : "The ID of the flow" - }, - "flowName" : { - "type" : "string", - "description" : "The name of the flow" - }, - "flowDescription" : { - "type" : "string", - "description" : "The description of the flow" - }, - "version" : { - "type" : "integer", - "format" : "int32", - "description" : "The version of the flow" - }, - "storageLocation" : { - "type" : "string", - "description" : "The storage location" - }, - "state" : { - "type" : "string", - "description" : "The current state of the Process Group, as it relates to the Versioned Flow", - "readOnly" : true, - "enum" : [ "LOCALLY_MODIFIED", "STALE", "LOCALLY_MODIFIED_AND_STALE", "UP_TO_DATE", "SYNC_FAILURE" ] - }, - "stateExplanation" : { - "type" : "string", - "description" : "Explanation of why the group is in the specified state", - "readOnly" : true - } - } - }, - "VersionControlInformationEntity" : { - "type" : "object", - "properties" : { - "processGroupRevision" : { - "description" : "The Revision for the Process Group", - "$ref" : "#/definitions/RevisionDTO" - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "versionControlInformation" : { - "description" : "The Version Control information", - "$ref" : "#/definitions/VersionControlInformationDTO" - } - }, - "xml" : { - "name" : "versionControlInformationEntity" - } - }, - "VersionInfoDTO" : { - "type" : "object", - "properties" : { - "niFiVersion" : { - "type" : "string", - "description" : "The version of this NiFi." - }, - "javaVendor" : { - "type" : "string", - "description" : "Java JVM vendor" - }, - "javaVersion" : { - "type" : "string", - "description" : "Java version" - }, - "osName" : { - "type" : "string", - "description" : "Host operating system name" - }, - "osVersion" : { - "type" : "string", - "description" : "Host operating system version" - }, - "osArchitecture" : { - "type" : "string", - "description" : "Host operating system architecture" - }, - "buildTag" : { - "type" : "string", - "description" : "Build tag" - }, - "buildRevision" : { - "type" : "string", - "description" : "Build revision or commit hash" - }, - "buildBranch" : { - "type" : "string", - "description" : "Build branch" - }, - "buildTimestamp" : { - "type" : "string", - "format" : "date-time", - "description" : "Build timestamp" - } - } - }, - "VersionedConnection" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The component's unique identifier" - }, - "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" - }, - "comments" : { - "type" : "string", - "description" : "The user-supplied comments for the component" - }, - "position" : { - "description" : "The component's position on the graph", - "$ref" : "#/definitions/Position" - }, - "source" : { - "description" : "The source of the connection.", - "$ref" : "#/definitions/ConnectableComponent" - }, - "destination" : { - "description" : "The destination of the connection.", - "$ref" : "#/definitions/ConnectableComponent" - }, - "labelIndex" : { - "type" : "integer", - "format" : "int32", - "description" : "The index of the bend point where to place the connection label." - }, - "zIndex" : { - "type" : "integer", - "format" : "int64", - "description" : "The z index of the connection." - }, - "selectedRelationships" : { - "type" : "array", - "description" : "The selected relationship that comprise the connection.", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - }, - "backPressureObjectThreshold" : { - "type" : "integer", - "format" : "int64", - "description" : "The object count threshold for determining when back pressure is applied. Updating this value is a passive change in the sense that it won't impact whether existing files over the limit are affected but it does help feeder processors to stop pushing too much into this work queue." - }, - "backPressureDataSizeThreshold" : { - "type" : "string", - "description" : "The object data size threshold for determining when back pressure is applied. Updating this value is a passive change in the sense that it won't impact whether existing files over the limit are affected but it does help feeder processors to stop pushing too much into this work queue." - }, - "flowFileExpiration" : { - "type" : "string", - "description" : "The amount of time a flow file may be in the flow before it will be automatically aged out of the flow. Once a flow file reaches this age it will be terminated from the flow the next time a processor attempts to start work on it." - }, - "prioritizers" : { - "type" : "array", - "description" : "The comparators used to prioritize the queue.", - "items" : { - "type" : "string" - } - }, - "bends" : { - "type" : "array", - "description" : "The bend points on the connection.", - "items" : { - "$ref" : "#/definitions/Position" - } - }, - "loadBalanceStrategy" : { - "type" : "string", - "description" : "The Strategy to use for load balancing data across the cluster, or null, if no Load Balance Strategy has been specified.", - "enum" : [ "DO_NOT_LOAD_BALANCE", "PARTITION_BY_ATTRIBUTE", "ROUND_ROBIN", "SINGLE_NODE" ] - }, - "partitioningAttribute" : { - "type" : "string", - "description" : "The attribute to use for partitioning data as it is load balanced across the cluster. If the Load Balance Strategy is configured to use PARTITION_BY_ATTRIBUTE, the value returned by this method is the name of the FlowFile Attribute that will be used to determine which node in the cluster should receive a given FlowFile. If the Load Balance Strategy is unset or is set to any other value, the Partitioning Attribute has no effect." - }, - "loadBalanceCompression" : { - "type" : "string", - "description" : "Whether or not compression should be used when transferring FlowFiles between nodes", - "enum" : [ "DO_NOT_COMPRESS", "COMPRESS_ATTRIBUTES_ONLY", "COMPRESS_ATTRIBUTES_AND_CONTENT" ] - }, - "componentType" : { - "type" : "string", - "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE", "REPORTING_TASK", "PARAMETER_CONTEXT", "PARAMETER_PROVIDER", "TEMPLATE", "FLOW_REGISTRY_CLIENT" ] - }, - "groupIdentifier" : { - "type" : "string", - "description" : "The ID of the Process Group that this component belongs to" - } - } - }, - "VersionedControllerService" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The component's unique identifier" - }, - "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" - }, - "comments" : { - "type" : "string", - "description" : "The user-supplied comments for the component" - }, - "position" : { - "description" : "The component's position on the graph", - "$ref" : "#/definitions/Position" - }, - "type" : { - "type" : "string", - "description" : "The type of the extension component" - }, - "bundle" : { - "description" : "Information about the bundle from which the component came", - "$ref" : "#/definitions/Bundle" - }, - "properties" : { - "type" : "object", - "description" : "The properties for the component. Properties whose value is not set will only contain the property name.", - "additionalProperties" : { - "type" : "string" - } - }, - "propertyDescriptors" : { - "type" : "object", - "description" : "The property descriptors for the component.", - "additionalProperties" : { - "$ref" : "#/definitions/VersionedPropertyDescriptor" - } - }, - "controllerServiceApis" : { - "type" : "array", - "description" : "Lists the APIs this Controller Service implements.", - "items" : { - "$ref" : "#/definitions/ControllerServiceAPI" - } - }, - "annotationData" : { - "type" : "string", - "description" : "The annotation for the controller service. This is how the custom UI relays configuration to the controller service." - }, - "scheduledState" : { - "type" : "string", - "description" : "The ScheduledState denoting whether the Controller Service is ENABLED or DISABLED", - "enum" : [ "ENABLED", "DISABLED", "RUNNING" ] - }, - "bulletinLevel" : { - "type" : "string", - "description" : "The level at which the controller service will report bulletins." - }, - "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", "PARAMETER_CONTEXT", "PARAMETER_PROVIDER", "TEMPLATE", "FLOW_REGISTRY_CLIENT" ] - }, - "groupIdentifier" : { - "type" : "string", - "description" : "The ID of the Process Group that this component belongs to" - } - } - }, - "VersionedFlowCoordinates" : { - "type" : "object", - "properties" : { - "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" - }, - "registryUrl" : { - "type" : "string", - "description" : "The URL of the Flow Registry that contains the flow" - }, - "bucketId" : { - "type" : "string", - "description" : "The UUID of the bucket that the flow resides in" - }, - "flowId" : { - "type" : "string", - "description" : "The UUID of the flow" - }, - "version" : { - "type" : "integer", - "format" : "int32", - "description" : "The version of the flow" - }, - "latest" : { - "type" : "boolean", - "description" : "Whether or not these coordinates point to the latest version of the flow" - } - } - }, - "VersionedFlowDTO" : { - "type" : "object", - "properties" : { - "registryId" : { - "type" : "string", - "description" : "The ID of the registry that the flow is tracked to" - }, - "bucketId" : { - "type" : "string", - "description" : "The ID of the bucket where the flow is stored" - }, - "flowId" : { - "type" : "string", - "description" : "The ID of the flow" - }, - "flowName" : { - "type" : "string", - "description" : "The name of the flow" - }, - "description" : { - "type" : "string", - "description" : "A description of the flow" - }, - "comments" : { - "type" : "string", - "description" : "Comments for the changeset" - }, - "action" : { - "type" : "string", - "description" : "The action being performed", - "enum" : [ "COMMIT", "FORCE_COMMIT" ] - } - } - }, - "VersionedFlowEntity" : { - "type" : "object", - "properties" : { - "versionedFlow" : { - "description" : "The versioned flow", - "$ref" : "#/definitions/VersionedFlowDTO" - } - }, - "xml" : { - "name" : "versionedFlowEntity" - } - }, - "VersionedFlowSnapshotEntity" : { - "type" : "object", - "properties" : { - "versionedFlowSnapshot" : { - "description" : "The versioned flow snapshot", - "$ref" : "#/definitions/RegisteredFlowSnapshot" - }, - "processGroupRevision" : { - "description" : "The Revision of the Process Group under Version Control", - "$ref" : "#/definitions/RevisionDTO" - }, - "registryId" : { - "type" : "string", - "description" : "The ID of the Registry that this flow belongs to" - }, - "updateDescendantVersionedFlows" : { - "type" : "boolean", - "description" : "If the Process Group to be updated has a child or descendant Process Group that is also under Version Control, this specifies whether or not the contents of that child/descendant Process Group should be updated." - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - } - }, - "xml" : { - "name" : "versionedFlowSnapshotEntity" - } - }, - "VersionedFlowSnapshotMetadataEntity" : { - "type" : "object", - "properties" : { - "versionedFlowSnapshotMetadata" : { - "description" : "The collection of registered flow snapshot metadata", - "$ref" : "#/definitions/RegisteredFlowSnapshotMetadata" - }, - "registryId" : { - "type" : "string", - "description" : "The ID of the Registry that this flow belongs to" - } - }, - "xml" : { - "name" : "versionedFlowSnapshotMetadataEntity" - } - }, - "VersionedFlowSnapshotMetadataSetEntity" : { - "type" : "object", - "properties" : { - "versionedFlowSnapshotMetadataSet" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedFlowSnapshotMetadataEntity" - } - } - }, - "xml" : { - "name" : "versionedFlowSnapshotMetadataSetEntity" - } - }, - "VersionedFlowUpdateRequestDTO" : { - "type" : "object", - "properties" : { - "requestId" : { - "type" : "string", - "description" : "The unique ID of this request.", - "readOnly" : true - }, - "processGroupId" : { - "type" : "string", - "description" : "The unique ID of the Process Group being updated" - }, - "uri" : { - "type" : "string", - "description" : "The URI for future requests to this drop request.", - "readOnly" : true - }, - "lastUpdated" : { - "type" : "string", - "description" : "The last time this request was updated.", - "readOnly" : true - }, - "complete" : { - "type" : "boolean", - "description" : "Whether or not this request has completed", - "readOnly" : true - }, - "failureReason" : { - "type" : "string", - "description" : "An explanation of why this request failed, or null if this request has not failed", - "readOnly" : true - }, - "percentCompleted" : { - "type" : "integer", - "format" : "int32", - "description" : "The percentage complete for the request, between 0 and 100", - "readOnly" : true - }, - "state" : { - "type" : "string", - "description" : "The state of the request", - "readOnly" : true - }, - "versionControlInformation" : { - "description" : "The VersionControlInformation that describes where the Versioned Flow is located; this may not be populated until the request is completed.", - "readOnly" : true, - "$ref" : "#/definitions/VersionControlInformationDTO" - } - } - }, - "VersionedFlowUpdateRequestEntity" : { - "type" : "object", - "properties" : { - "processGroupRevision" : { - "description" : "The revision for the Process Group being updated.", - "$ref" : "#/definitions/RevisionDTO" - }, - "request" : { - "description" : "The Flow Update Request", - "$ref" : "#/definitions/VersionedFlowUpdateRequestDTO" - } - }, - "xml" : { - "name" : "registeredFlowUpdateRequestEntity" - } - }, - "VersionedFlowsEntity" : { - "type" : "object", - "properties" : { - "versionedFlows" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedFlowEntity" - } - } - }, - "xml" : { - "name" : "versionedFlowsEntity" - } - }, - "VersionedFunnel" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The component's unique identifier" - }, - "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" - }, - "comments" : { - "type" : "string", - "description" : "The user-supplied comments for the component" - }, - "position" : { - "description" : "The component's position on the graph", - "$ref" : "#/definitions/Position" - }, - "componentType" : { - "type" : "string", - "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE", "REPORTING_TASK", "PARAMETER_CONTEXT", "PARAMETER_PROVIDER", "TEMPLATE", "FLOW_REGISTRY_CLIENT" ] - }, - "groupIdentifier" : { - "type" : "string", - "description" : "The ID of the Process Group that this component belongs to" - } - } - }, - "VersionedLabel" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The component's unique identifier" - }, - "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" - }, - "comments" : { - "type" : "string", - "description" : "The user-supplied comments for the component" - }, - "position" : { - "description" : "The component's position on the graph", - "$ref" : "#/definitions/Position" - }, - "label" : { - "type" : "string", - "description" : "The text that appears in the label." - }, - "zIndex" : { - "type" : "integer", - "format" : "int64", - "description" : "The z index of the connection." - }, - "width" : { - "type" : "number", - "format" : "double", - "description" : "The width of the label in pixels when at a 1:1 scale." - }, - "height" : { - "type" : "number", - "format" : "double", - "description" : "The height of the label in pixels when at a 1:1 scale." - }, - "style" : { - "type" : "object", - "description" : "The styles for this label (font-size : 12px, background-color : #eee, etc).", - "additionalProperties" : { - "type" : "string" - } - }, - "componentType" : { - "type" : "string", - "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE", "REPORTING_TASK", "PARAMETER_CONTEXT", "PARAMETER_PROVIDER", "TEMPLATE", "FLOW_REGISTRY_CLIENT" ] - }, - "groupIdentifier" : { - "type" : "string", - "description" : "The ID of the Process Group that this component belongs to" - } - } - }, - "VersionedParameter" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The name of the parameter" - }, - "description" : { - "type" : "string", - "description" : "The description of the param" - }, - "sensitive" : { - "type" : "boolean", - "description" : "Whether or not the parameter value is sensitive" - }, - "provided" : { - "type" : "boolean", - "description" : "Whether or not the parameter value is provided by a ParameterProvider" - }, - "value" : { - "type" : "string", - "description" : "The value of the parameter" - } - } - }, - "VersionedParameterContext" : { - "type" : "object", - "properties" : { - "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" - }, - "comments" : { - "type" : "string", - "description" : "The user-supplied comments for the component" - }, - "position" : { - "description" : "The component's position on the graph", - "$ref" : "#/definitions/Position" - }, - "parameters" : { - "type" : "array", - "description" : "The parameters in the context", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedParameter" - } - }, - "inheritedParameterContexts" : { - "type" : "array", - "description" : "The names of additional parameter contexts from which to inherit parameters", - "items" : { - "type" : "string" - } - }, - "description" : { - "type" : "string", - "description" : "The description of the parameter context" - }, - "parameterProvider" : { - "type" : "string", - "description" : "The identifier of an optional parameter provider" - }, - "parameterGroupName" : { - "type" : "string", - "description" : "The corresponding parameter group name fetched from the parameter provider, if applicable" - }, - "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", "PARAMETER_CONTEXT", "PARAMETER_PROVIDER", "TEMPLATE", "FLOW_REGISTRY_CLIENT" ] - }, - "synchronized" : { - "type" : "boolean", - "description" : "True if the parameter provider is set and the context should receive updates when its parameters are next fetched" - }, - "groupIdentifier" : { - "type" : "string", - "description" : "The ID of the Process Group that this component belongs to" - } - } - }, - "VersionedPort" : { - "type" : "object", - "properties" : { - "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" - }, - "comments" : { - "type" : "string", - "description" : "The user-supplied comments for the component" - }, - "position" : { - "description" : "The component's position on the graph", - "$ref" : "#/definitions/Position" - }, - "type" : { - "type" : "string", - "description" : "The type of port.", - "enum" : [ "INPUT_PORT", "OUTPUT_PORT" ] - }, - "concurrentlySchedulableTaskCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of tasks that should be concurrently scheduled for the port." - }, - "scheduledState" : { - "type" : "string", - "description" : "The scheduled state of the component", - "enum" : [ "ENABLED", "DISABLED", "RUNNING" ] - }, - "allowRemoteAccess" : { - "type" : "boolean", - "description" : "Whether or not this port allows remote access for site-to-site" - }, - "componentType" : { - "type" : "string", - "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE", "REPORTING_TASK", "PARAMETER_CONTEXT", "PARAMETER_PROVIDER", "TEMPLATE", "FLOW_REGISTRY_CLIENT" ] - }, - "groupIdentifier" : { - "type" : "string", - "description" : "The ID of the Process Group that this component belongs to" - } - } - }, - "VersionedProcessGroup" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The component's unique identifier" - }, - "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" - }, - "comments" : { - "type" : "string", - "description" : "The user-supplied comments for the component" - }, - "position" : { - "description" : "The component's position on the graph", - "$ref" : "#/definitions/Position" - }, - "processGroups" : { - "type" : "array", - "description" : "The child Process Groups", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedProcessGroup" - } - }, - "remoteProcessGroups" : { - "type" : "array", - "description" : "The Remote Process Groups", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedRemoteProcessGroup" - } - }, - "processors" : { - "type" : "array", - "description" : "The Processors", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedProcessor" - } - }, - "inputPorts" : { - "type" : "array", - "description" : "The Input Ports", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedPort" - } - }, - "outputPorts" : { - "type" : "array", - "description" : "The Output Ports", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedPort" - } - }, - "connections" : { - "type" : "array", - "description" : "The Connections", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedConnection" - } - }, - "labels" : { - "type" : "array", - "description" : "The Labels", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedLabel" - } - }, - "funnels" : { - "type" : "array", - "description" : "The Funnels", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedFunnel" - } - }, - "controllerServices" : { - "type" : "array", - "description" : "The Controller Services", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedControllerService" - } - }, - "versionedFlowCoordinates" : { - "description" : "The coordinates where the remote flow is stored, or null if the Process Group is not directly under Version Control", - "$ref" : "#/definitions/VersionedFlowCoordinates" - }, - "variables" : { - "type" : "object", - "description" : "The Variables in the Variable Registry for this Process Group (not including any ancestor or descendant Process Groups)", - "additionalProperties" : { - "type" : "string" - } - }, - "parameterContextName" : { - "type" : "string", - "description" : "The name of the parameter context used by this process group" - }, - "defaultFlowFileExpiration" : { - "type" : "string", - "description" : "The default FlowFile Expiration for this Process Group." - }, - "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." - }, - "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." - }, - "logFileSuffix" : { - "type" : "string", - "description" : "The log file suffix for this Process Group for dedicated logging." - }, - "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", "PARAMETER_CONTEXT", "PARAMETER_PROVIDER", "TEMPLATE", "FLOW_REGISTRY_CLIENT" ] - }, - "flowFileConcurrency" : { - "type" : "string", - "description" : "The configured FlowFile Concurrency for the Process Group" - }, - "flowFileOutboundPolicy" : { - "type" : "string", - "description" : "The FlowFile Outbound Policy for the Process Group" - }, - "groupIdentifier" : { - "type" : "string", - "description" : "The ID of the Process Group that this component belongs to" - } - } - }, - "VersionedProcessor" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The component's unique identifier" - }, - "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" - }, - "comments" : { - "type" : "string", - "description" : "The user-supplied comments for the component" - }, - "position" : { - "description" : "The component's position on the graph", - "$ref" : "#/definitions/Position" - }, - "type" : { - "type" : "string", - "description" : "The type of the extension component" - }, - "bundle" : { - "description" : "Information about the bundle from which the component came", - "$ref" : "#/definitions/Bundle" - }, - "properties" : { - "type" : "object", - "description" : "The properties for the component. Properties whose value is not set will only contain the property name.", - "additionalProperties" : { - "type" : "string" - } - }, - "propertyDescriptors" : { - "type" : "object", - "description" : "The property descriptors for the component.", - "additionalProperties" : { - "$ref" : "#/definitions/VersionedPropertyDescriptor" - } - }, - "style" : { - "type" : "object", - "description" : "Stylistic data for rendering in a UI", - "additionalProperties" : { - "type" : "string" - } - }, - "annotationData" : { - "type" : "string", - "description" : "The annotation data for the processor used to relay configuration between a custom UI and the procesosr." - }, - "schedulingPeriod" : { - "type" : "string", - "description" : "The frequency with which to schedule the processor. The format of the value will depend on th value of schedulingStrategy." - }, - "schedulingStrategy" : { - "type" : "string", - "description" : "Indicates whether the processor should be scheduled to run in event or timer driven mode." - }, - "executionNode" : { - "type" : "string", - "description" : "Indicates the node where the process will execute." - }, - "penaltyDuration" : { - "type" : "string", - "description" : "The amout of time that is used when the process penalizes a flowfile." - }, - "yieldDuration" : { - "type" : "string", - "description" : "The amount of time that must elapse before this processor is scheduled again after yielding." - }, - "bulletinLevel" : { - "type" : "string", - "description" : "The level at which the processor will report bulletins." - }, - "runDurationMillis" : { - "type" : "integer", - "format" : "int64", - "description" : "The run duration for the processor in milliseconds." - }, - "concurrentlySchedulableTaskCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of tasks that should be concurrently schedule for the processor. If the processor doesn't allow parallol processing then any positive input will be ignored." - }, - "autoTerminatedRelationships" : { - "type" : "array", - "description" : "The names of all relationships that cause a flow file to be terminated if the relationship is not connected elsewhere. This property differs from the 'isAutoTerminate' property of the RelationshipDTO in that the RelationshipDTO is meant to depict the current configuration, whereas this property can be set in a DTO when updating a Processor in order to change which Relationships should be auto-terminated.", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - }, - "scheduledState" : { - "type" : "string", - "description" : "The scheduled state of the component", - "enum" : [ "ENABLED", "DISABLED", "RUNNING" ] - }, - "retryCount" : { - "type" : "integer", - "format" : "int32", - "description" : "Overall number of retries." - }, - "retriedRelationships" : { - "type" : "array", - "description" : "All the relationships should be retried.", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - }, - "backoffMechanism" : { - "type" : "string", - "description" : "Determines whether the FlowFile should be penalized or the processor should be yielded between retries.", - "enum" : [ "PENALIZE_FLOWFILE", "YIELD_PROCESSOR" ] - }, - "maxBackoffPeriod" : { - "type" : "string", - "description" : "Maximum amount of time to be waited during a retry period." - }, - "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", "PARAMETER_CONTEXT", "PARAMETER_PROVIDER", "TEMPLATE", "FLOW_REGISTRY_CLIENT" ] - }, - "groupIdentifier" : { - "type" : "string", - "description" : "The ID of the Process Group that this component belongs to" - } - } - }, - "VersionedPropertyDescriptor" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The name of the property" - }, - "displayName" : { - "type" : "string", - "description" : "The display name of the property" - }, - "identifiesControllerService" : { - "type" : "boolean", - "description" : "Whether or not the property provides the identifier of a Controller Service" - }, - "sensitive" : { - "type" : "boolean", - "description" : "Whether or not the property is considered sensitive" - }, - "resourceDefinition" : { - "description" : "Returns the Resource Definition that defines which type(s) of resource(s) this property references, if any", - "$ref" : "#/definitions/VersionedResourceDefinition" - } - } - }, - "VersionedRemoteGroupPort" : { - "type" : "object", - "properties" : { - "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" - }, - "comments" : { - "type" : "string", - "description" : "The user-supplied comments for the component" - }, - "position" : { - "description" : "The component's position on the graph", - "$ref" : "#/definitions/Position" - }, - "remoteGroupId" : { - "type" : "string", - "description" : "The id of the remote process group that the port resides in." - }, - "concurrentlySchedulableTaskCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of task that may transmit flowfiles to the target port concurrently." - }, - "useCompression" : { - "type" : "boolean", - "description" : "Whether the flowfiles are compressed when sent to the target port." - }, - "batchSize" : { - "description" : "The batch settings for data transmission.", - "$ref" : "#/definitions/BatchSize" - }, - "componentType" : { - "type" : "string", - "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE", "REPORTING_TASK", "PARAMETER_CONTEXT", "PARAMETER_PROVIDER", "TEMPLATE", "FLOW_REGISTRY_CLIENT" ] - }, - "targetId" : { - "type" : "string", - "description" : "The ID of the port on the target NiFi instance" - }, - "scheduledState" : { - "type" : "string", - "description" : "The scheduled state of the component", - "enum" : [ "ENABLED", "DISABLED", "RUNNING" ] - }, - "groupIdentifier" : { - "type" : "string", - "description" : "The ID of the Process Group that this component belongs to" - } - } - }, - "VersionedRemoteProcessGroup" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The component's unique identifier" - }, - "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" - }, - "comments" : { - "type" : "string", - "description" : "The user-supplied comments for the component" - }, - "position" : { - "description" : "The component's position on the graph", - "$ref" : "#/definitions/Position" - }, - "targetUri" : { - "type" : "string", - "description" : "[DEPRECATED] The target URI of the remote process group. If target uri is not set, but uris are set, then returns the first uri in the uris. If neither target uri nor uris are set, then returns null." - }, - "targetUris" : { - "type" : "string", - "description" : "The target URIs of the remote process group. If target uris is not set but target uri is set, then returns the single target uri. If neither target uris nor target uri is set, then returns null." - }, - "communicationsTimeout" : { - "type" : "string", - "description" : "The time period used for the timeout when communicating with the target." - }, - "yieldDuration" : { - "type" : "string", - "description" : "When yielding, this amount of time must elapse before the remote process group is scheduled again." - }, - "transportProtocol" : { - "type" : "string", - "description" : "The Transport Protocol that is used for Site-to-Site communications", - "enum" : [ "RAW", "HTTP" ] - }, - "localNetworkInterface" : { - "type" : "string", - "description" : "The local network interface to send/receive data. If not specified, any local address is used. If clustered, all nodes must have an interface with this identifier." - }, - "proxyHost" : { - "type" : "string" - }, - "proxyPort" : { - "type" : "integer", - "format" : "int32" - }, - "proxyUser" : { - "type" : "string" - }, - "proxyPassword" : { - "type" : "string" - }, - "inputPorts" : { - "type" : "array", - "description" : "A Set of Input Ports that can be connected to, in order to send data to the remote NiFi instance", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedRemoteGroupPort" - } - }, - "outputPorts" : { - "type" : "array", - "description" : "A Set of Output Ports that can be connected to, in order to pull data from the remote NiFi instance", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedRemoteGroupPort" - } - }, - "componentType" : { - "type" : "string", - "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE", "REPORTING_TASK", "PARAMETER_CONTEXT", "PARAMETER_PROVIDER", "TEMPLATE", "FLOW_REGISTRY_CLIENT" ] - }, - "groupIdentifier" : { - "type" : "string", - "description" : "The ID of the Process Group that this component belongs to" - } - } - }, - "VersionedReportingTask" : { - "type" : "object", - "properties" : { - "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" - }, - "comments" : { - "type" : "string", - "description" : "The user-supplied comments for the component" - }, - "position" : { - "description" : "The component's position on the graph", - "$ref" : "#/definitions/Position" - }, - "type" : { - "type" : "string", - "description" : "The type of the extension component" - }, - "bundle" : { - "description" : "Information about the bundle from which the component came", - "$ref" : "#/definitions/Bundle" - }, - "properties" : { - "type" : "object", - "description" : "The properties for the component. Properties whose value is not set will only contain the property name.", - "additionalProperties" : { - "type" : "string" - } - }, - "propertyDescriptors" : { - "type" : "object", - "description" : "The property descriptors for the component.", - "additionalProperties" : { - "$ref" : "#/definitions/VersionedPropertyDescriptor" - } - }, - "annotationData" : { - "type" : "string", - "description" : "The annotation for the reporting task. This is how the custom UI relays configuration to the reporting task." - }, - "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." - }, - "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", "PARAMETER_CONTEXT", "PARAMETER_PROVIDER", "TEMPLATE", "FLOW_REGISTRY_CLIENT" ] - }, - "groupIdentifier" : { - "type" : "string", - "description" : "The ID of the Process Group that this component belongs to" - } - } - }, - "VersionedReportingTaskSnapshot" : { - "type" : "object", - "properties" : { - "reportingTasks" : { - "type" : "array", - "description" : "The reporting tasks", - "items" : { - "$ref" : "#/definitions/VersionedReportingTask" - } - }, - "controllerServices" : { - "type" : "array", - "description" : "The controller services", - "items" : { - "$ref" : "#/definitions/VersionedControllerService" - } - } - } - }, - "VersionedResourceDefinition" : { - "type" : "object", - "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", - "uniqueItems" : true, - "items" : { - "type" : "string", - "enum" : [ "FILE", "DIRECTORY", "TEXT", "URL" ] - } - } - } - } - } -} \ No newline at end of file diff --git a/resources/client_gen/api_defs/nifi-1.7.1.json b/resources/client_gen/api_defs/nifi-1.7.1.json deleted file mode 100644 index 5ff6874e..00000000 --- a/resources/client_gen/api_defs/nifi-1.7.1.json +++ /dev/null @@ -1,18380 +0,0 @@ -{ - "swagger" : "2.0", - "info" : { - "description" : "The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and \n stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description,\n definitions of the expected input and output, potential response codes, and the authorizations required\n to invoke each service.", - "version" : "1.7.1", - "title" : "NiFi Rest Api", - "contact" : { - "url" : "https://nifi.apache.org", - "email" : "dev@nifi.apache.org" - }, - "license" : { - "name" : "Apache 2.0", - "url" : "http://www.apache.org/licenses/LICENSE-2.0.html" - } - }, - "basePath" : "/nifi-api", - "tags" : [ { - "name" : "access", - "description" : "Endpoints for obtaining an access token or checking access status." - }, { - "name" : "connections", - "description" : "Endpoint for managing a Connection." - }, { - "name" : "controller", - "description" : "Provides realtime command and control of this NiFi instance" - }, { - "name" : "controller-services", - "description" : "Endpoint for managing a Controller Service." - }, { - "name" : "counters", - "description" : "Endpoint for managing counters." - }, { - "name" : "data-transfer", - "description" : "Supports data transfers with this NiFi using HTTP based site to site" - }, { - "name" : "flow", - "description" : "Endpoint for accessing the flow structure and component status." - }, { - "name" : "flowfile-queues", - "description" : "Endpoint for managing a FlowFile Queue." - }, { - "name" : "funnel", - "description" : "Endpoint for managing a Funnel." - }, { - "name" : "input-ports", - "description" : "Endpoint for managing an Input Port." - }, { - "name" : "labels", - "description" : "Endpoint for managing a Label." - }, { - "name" : "output-ports", - "description" : "Endpoint for managing an Output Port." - }, { - "name" : "policies", - "description" : "Endpoint for managing access policies." - }, { - "name" : "process-groups", - "description" : "Endpoint for managing a Process Group." - }, { - "name" : "processors", - "description" : "Endpoint for managing a Processor." - }, { - "name" : "provenance", - "description" : "Endpoint for accessing data flow provenance." - }, { - "name" : "provenance-events", - "description" : "Endpoint for accessing data flow provenance." - }, { - "name" : "remote-process-groups", - "description" : "Endpoint for managing a Remote Process Group." - }, { - "name" : "reporting-tasks", - "description" : "Endpoint for managing a Reporting Task." - }, { - "name" : "resources", - "description" : "Provides the resources in this NiFi that can have access/authorization policies." - }, { - "name" : "site-to-site", - "description" : "Provide access to site to site with this NiFi" - }, { - "name" : "snippets", - "description" : "Endpoint for accessing dataflow snippets." - }, { - "name" : "system-diagnostics", - "description" : "Endpoint for accessing system diagnostics." - }, { - "name" : "templates", - "description" : "Endpoint for managing a Template." - }, { - "name" : "tenants", - "description" : "Endpoint for managing users and user groups." - }, { - "name" : "versions", - "description" : "Endpoint for managing version control for a flow" - } ], - "schemes" : [ "http", "https" ], - "paths" : { - "/access" : { - "get" : { - "tags" : [ "access" ], - "summary" : "Gets the status the client's access", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getAccessStatus", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/AccessStatusEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Unable to determine access status because the client could not be authenticated." - }, - "403" : { - "description" : "Unable to determine access status because the client is not authorized to make this request." - }, - "409" : { - "description" : "Unable to determine access status because NiFi is not in the appropriate state." - }, - "500" : { - "description" : "Unable to determine access status because an unexpected error occurred." - } - } - } - }, - "/access/config" : { - "get" : { - "tags" : [ "access" ], - "summary" : "Retrieves the access configuration for this NiFi", - "description" : "", - "operationId" : "getLoginConfig", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/AccessConfigurationEntity" - } - } - } - } - }, - "/access/download-token" : { - "post" : { - "tags" : [ "access" ], - "summary" : "Creates a single use access token for downloading FlowFile content.", - "description" : "The token returned is a base64 encoded string. It is valid for a single request up to five minutes from being issued. It is used as a query parameter name 'access_token'.", - "operationId" : "createDownloadToken", - "consumes" : [ "application/x-www-form-urlencoded" ], - "produces" : [ "text/plain" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "Unable to create the download token because NiFi is not in the appropriate state. (i.e. may not have any tokens to grant or be configured to support username/password login)" - }, - "500" : { - "description" : "Unable to create download token because an unexpected error occurred." - } - } - } - }, - "/access/kerberos" : { - "post" : { - "tags" : [ "access" ], - "summary" : "Creates a token for accessing the REST API via Kerberos ticket exchange / SPNEGO negotiation", - "description" : "The token returned is formatted as a JSON Web Token (JWT). The token is base64 encoded and comprised of three parts. The header, the body, and the signature. The expiration of the token is a contained within the body. The token can be used in the Authorization header in the format 'Authorization: Bearer '.", - "operationId" : "createAccessTokenFromTicket", - "consumes" : [ "text/plain" ], - "produces" : [ "text/plain" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "NiFi was unable to complete the request because it did not contain a valid Kerberos ticket in the Authorization header. Retry this request after initializing a ticket with kinit and ensuring your browser is configured to support SPNEGO." - }, - "409" : { - "description" : "Unable to create access token because NiFi is not in the appropriate state. (i.e. may not be configured to support Kerberos login." - }, - "500" : { - "description" : "Unable to create access token because an unexpected error occurred." - } - } - } - }, - "/access/knox/callback" : { - "get" : { - "tags" : [ "access" ], - "summary" : "Redirect/callback URI for processing the result of the Apache Knox login sequence.", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "knoxCallback", - "consumes" : [ "*/*" ], - "produces" : [ "*/*" ], - "responses" : { - "default" : { - "description" : "successful operation" - } - } - } - }, - "/access/knox/request" : { - "get" : { - "tags" : [ "access" ], - "summary" : "Initiates a request to authenticate through Apache Knox.", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "knoxRequest", - "consumes" : [ "*/*" ], - "produces" : [ "*/*" ], - "responses" : { - "default" : { - "description" : "successful operation" - } - } - } - }, - "/access/oidc/callback" : { - "get" : { - "tags" : [ "access" ], - "summary" : "Redirect/callback URI for processing the result of the OpenId Connect login sequence.", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "oidcCallback", - "consumes" : [ "*/*" ], - "produces" : [ "*/*" ], - "responses" : { - "default" : { - "description" : "successful operation" - } - } - } - }, - "/access/oidc/exchange" : { - "post" : { - "tags" : [ "access" ], - "summary" : "Retrieves a JWT following a successful login sequence using the configured OpenId Connect provider.", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "oidcExchange", - "consumes" : [ "*/*" ], - "produces" : [ "text/plain" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - } - } - } - }, - "/access/oidc/request" : { - "get" : { - "tags" : [ "access" ], - "summary" : "Initiates a request to authenticate through the configured OpenId Connect provider.", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "oidcRequest", - "consumes" : [ "*/*" ], - "produces" : [ "*/*" ], - "responses" : { - "default" : { - "description" : "successful operation" - } - } - } - }, - "/access/token" : { - "post" : { - "tags" : [ "access" ], - "summary" : "Creates a token for accessing the REST API via username/password", - "description" : "The token returned is formatted as a JSON Web Token (JWT). The token is base64 encoded and comprised of three parts. The header, the body, and the signature. The expiration of the token is a contained within the body. The token can be used in the Authorization header in the format 'Authorization: Bearer '.", - "operationId" : "createAccessToken", - "consumes" : [ "application/x-www-form-urlencoded" ], - "produces" : [ "text/plain" ], - "parameters" : [ { - "name" : "username", - "in" : "formData", - "required" : false, - "type" : "string" - }, { - "name" : "password", - "in" : "formData", - "required" : false, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "Unable to create access token because NiFi is not in the appropriate state. (i.e. may not be configured to support username/password login." - }, - "500" : { - "description" : "Unable to create access token because an unexpected error occurred." - } - } - } - }, - "/access/ui-extension-token" : { - "post" : { - "tags" : [ "access" ], - "summary" : "Creates a single use access token for accessing a NiFi UI extension.", - "description" : "The token returned is a base64 encoded string. It is valid for a single request up to five minutes from being issued. It is used as a query parameter name 'access_token'.", - "operationId" : "createUiExtensionToken", - "consumes" : [ "application/x-www-form-urlencoded" ], - "produces" : [ "text/plain" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "Unable to create the download token because NiFi is not in the appropriate state. (i.e. may not have any tokens to grant or be configured to support username/password login)" - }, - "500" : { - "description" : "Unable to create download token because an unexpected error occurred." - } - } - } - }, - "/connections/{id}" : { - "get" : { - "tags" : [ "connections" ], - "summary" : "Gets a connection", - "description" : "", - "operationId" : "getConnection", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The connection id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ConnectionEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read Source - /{component-type}/{uuid}" : [ ] - }, { - "Read Destination - /{component-type}/{uuid}" : [ ] - } ] - }, - "put" : { - "tags" : [ "connections" ], - "summary" : "Updates a connection", - "description" : "", - "operationId" : "updateConnection", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The connection id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The connection configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ConnectionEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ConnectionEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write Source - /{component-type}/{uuid}" : [ ] - }, { - "Write Destination - /{component-type}/{uuid}" : [ ] - }, { - "Write New Destination - /{component-type}/{uuid} - if updating Destination" : [ ] - }, { - "Write Process Group - /process-groups/{uuid} - if updating Destination" : [ ] - } ] - }, - "delete" : { - "tags" : [ "connections" ], - "summary" : "Deletes a connection", - "description" : "", - "operationId" : "deleteConnection", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The revision is used to verify the client is working with the latest version of the flow.", - "required" : false, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The connection id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ConnectionEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write Source - /{component-type}/{uuid}" : [ ] - }, { - "Write - Parent Process Group - /process-groups/{uuid}" : [ ] - }, { - "Write Destination - /{component-type}/{uuid}" : [ ] - } ] - } - }, - "/controller-services/{id}" : { - "get" : { - "tags" : [ "controller-services" ], - "summary" : "Gets a controller service", - "description" : "", - "operationId" : "getControllerService", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The controller service id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ControllerServiceEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /controller-services/{uuid}" : [ ] - } ] - }, - "put" : { - "tags" : [ "controller-services" ], - "summary" : "Updates a controller service", - "description" : "", - "operationId" : "updateControllerService", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The controller service id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The controller service configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ControllerServiceEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ControllerServiceEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /controller-services/{uuid}" : [ ] - }, { - "Read - any referenced Controller Services if this request changes the reference - /controller-services/{uuid}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "controller-services" ], - "summary" : "Deletes a controller service", - "description" : "", - "operationId" : "removeControllerService", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The revision is used to verify the client is working with the latest version of the flow.", - "required" : false, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The controller service id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ControllerServiceEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /controller-services/{uuid}" : [ ] - }, { - "Write - Parent Process Group if scoped by Process Group - /process-groups/{uuid}" : [ ] - }, { - "Write - Controller if scoped by Controller - /controller" : [ ] - }, { - "Read - any referenced Controller Services - /controller-services/{uuid}" : [ ] - } ] - } - }, - "/controller-services/{id}/descriptors" : { - "get" : { - "tags" : [ "controller-services" ], - "summary" : "Gets a controller service property descriptor", - "description" : "", - "operationId" : "getPropertyDescriptor", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The controller service id.", - "required" : true, - "type" : "string" - }, { - "name" : "propertyName", - "in" : "query", - "description" : "The property name to return the descriptor for.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/PropertyDescriptorEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /controller-services/{uuid}" : [ ] - } ] - } - }, - "/controller-services/{id}/references" : { - "get" : { - "tags" : [ "controller-services" ], - "summary" : "Gets a controller service", - "description" : "", - "operationId" : "getControllerServiceReferences", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The controller service id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ControllerServiceReferencingComponentsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /controller-services/{uuid}" : [ ] - } ] - }, - "put" : { - "tags" : [ "controller-services" ], - "summary" : "Updates a controller services references", - "description" : "", - "operationId" : "updateControllerServiceReferences", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The controller service id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The controller service request update request.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/UpdateControllerServiceReferenceRequestEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ControllerServiceReferencingComponentsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /{component-type}/{uuid} - For each referencing component specified" : [ ] - } ] - } - }, - "/controller-services/{id}/state" : { - "get" : { - "tags" : [ "controller-services" ], - "summary" : "Gets the state for a controller service", - "description" : "", - "operationId" : "getState", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The controller service id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ComponentStateEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /controller-services/{uuid}" : [ ] - } ] - } - }, - "/controller-services/{id}/state/clear-requests" : { - "post" : { - "tags" : [ "controller-services" ], - "summary" : "Clears the state for a controller service", - "description" : "", - "operationId" : "clearState", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The controller service id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ComponentStateEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /controller-services/{uuid}" : [ ] - } ] - } - }, - "/controller/bulletin" : { - "post" : { - "tags" : [ "controller" ], - "summary" : "Creates a new bulletin", - "description" : "", - "operationId" : "createBulletin", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The reporting task configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/BulletinEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /controller" : [ ] - } ] - } - }, - "/controller/cluster" : { - "get" : { - "tags" : [ "controller" ], - "summary" : "Gets the contents of the cluster", - "description" : "Returns the contents of the cluster including all nodes and their status.", - "operationId" : "getCluster", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ClusterEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /controller" : [ ] - } ] - } - }, - "/controller/cluster/nodes/{id}" : { - "get" : { - "tags" : [ "controller" ], - "summary" : "Gets a node in the cluster", - "description" : "", - "operationId" : "getNode", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The node id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/NodeEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /controller" : [ ] - } ] - }, - "put" : { - "tags" : [ "controller" ], - "summary" : "Updates a node in the cluster", - "description" : "", - "operationId" : "updateNode", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The node id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The node configuration. The only configuration that will be honored at this endpoint is the status.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/NodeEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/NodeEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /controller" : [ ] - } ] - }, - "delete" : { - "tags" : [ "controller" ], - "summary" : "Removes a node from the cluster", - "description" : "", - "operationId" : "deleteNode", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The node id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/NodeEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /controller" : [ ] - } ] - } - }, - "/controller/config" : { - "get" : { - "tags" : [ "controller" ], - "summary" : "Retrieves the configuration for this NiFi Controller", - "description" : "", - "operationId" : "getControllerConfig", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ControllerConfigurationEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /controller" : [ ] - } ] - }, - "put" : { - "tags" : [ "controller" ], - "summary" : "Retrieves the configuration for this NiFi", - "description" : "", - "operationId" : "updateControllerConfig", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The controller configuration.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ControllerConfigurationEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ControllerConfigurationEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /controller" : [ ] - } ] - } - }, - "/controller/controller-services" : { - "post" : { - "tags" : [ "controller" ], - "summary" : "Creates a new controller service", - "description" : "", - "operationId" : "createControllerService", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The controller service configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ControllerServiceEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ControllerServiceEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /controller" : [ ] - }, { - "Read - any referenced Controller Services - /controller-services/{uuid}" : [ ] - }, { - "Write - if the Controller Service is restricted - /restricted-components" : [ ] - } ] - } - }, - "/controller/history" : { - "delete" : { - "tags" : [ "controller" ], - "summary" : "Purges history", - "description" : "", - "operationId" : "deleteHistory", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "endDate", - "in" : "query", - "description" : "Purge actions before this date/time.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/HistoryEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /controller" : [ ] - } ] - } - }, - "/controller/registry-clients" : { - "get" : { - "tags" : [ "controller" ], - "summary" : "Gets the listing of available registry clients", - "description" : "", - "operationId" : "getRegistryClients", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/RegistryClientsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - }, - "post" : { - "tags" : [ "controller" ], - "summary" : "Creates a new registry client", - "description" : "", - "operationId" : "createRegistryClient", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The registry configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/RegistryClientEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/RegistryClientEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /controller" : [ ] - } ] - } - }, - "/controller/registry-clients/{id}" : { - "get" : { - "tags" : [ "controller" ], - "summary" : "Gets a registry client", - "description" : "", - "operationId" : "getRegistryClient", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The registry id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/RegistryClientEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /controller" : [ ] - } ] - }, - "put" : { - "tags" : [ "controller" ], - "summary" : "Updates a registry client", - "description" : "", - "operationId" : "updateRegistryClient", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The registry id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The registry configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/RegistryClientEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/RegistryClientEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /controller" : [ ] - } ] - }, - "delete" : { - "tags" : [ "controller" ], - "summary" : "Deletes a registry client", - "description" : "", - "operationId" : "deleteRegistryClient", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The revision is used to verify the client is working with the latest version of the flow.", - "required" : false, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The registry id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/RegistryClientEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /controller" : [ ] - } ] - } - }, - "/controller/reporting-tasks" : { - "post" : { - "tags" : [ "controller" ], - "summary" : "Creates a new reporting task", - "description" : "", - "operationId" : "createReportingTask", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The reporting task configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ReportingTaskEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ReportingTaskEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /controller" : [ ] - }, { - "Read - any referenced Controller Services - /controller-services/{uuid}" : [ ] - }, { - "Write - if the Reporting Task is restricted - /restricted-components" : [ ] - } ] - } - }, - "/counters" : { - "get" : { - "tags" : [ "counters" ], - "summary" : "Gets the current counters for this NiFi", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getCounters", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "nodewise", - "in" : "query", - "description" : "Whether or not to include the breakdown per node. Optional, defaults to false", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "clusterNodeId", - "in" : "query", - "description" : "The id of the node where to get the status.", - "required" : false, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/CountersEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /counters" : [ ] - } ] - } - }, - "/counters/{id}" : { - "put" : { - "tags" : [ "counters" ], - "summary" : "Updates the specified counter. This will reset the counter value to 0", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "updateCounter", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The id of the counter.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/CounterEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /counters" : [ ] - } ] - } - }, - "/data-transfer/input-ports/{portId}/transactions/{transactionId}" : { - "put" : { - "tags" : [ "data-transfer" ], - "summary" : "Extend transaction TTL", - "description" : "", - "operationId" : "extendInputPortTransactionTTL", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "portId", - "in" : "path", - "required" : true, - "type" : "string" - }, { - "name" : "transactionId", - "in" : "path", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/TransactionResultEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /data-transfer/input-ports/{uuid}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "data-transfer" ], - "summary" : "Commit or cancel the specified transaction", - "description" : "", - "operationId" : "commitInputPortTransaction", - "consumes" : [ "application/octet-stream" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "responseCode", - "in" : "query", - "description" : "The response code. Available values are BAD_CHECKSUM(19), CONFIRM_TRANSACTION(12) or CANCEL_TRANSACTION(15).", - "required" : true, - "type" : "integer", - "format" : "int32" - }, { - "name" : "portId", - "in" : "path", - "description" : "The input port id.", - "required" : true, - "type" : "string" - }, { - "name" : "transactionId", - "in" : "path", - "description" : "The transaction id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/TransactionResultEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - }, - "503" : { - "description" : "NiFi instance is not ready for serving request, or temporarily overloaded. Retrying the same request later may be successful" - } - }, - "security" : [ { - "Write - /data-transfer/input-ports/{uuid}" : [ ] - } ] - } - }, - "/data-transfer/input-ports/{portId}/transactions/{transactionId}/flow-files" : { - "post" : { - "tags" : [ "data-transfer" ], - "summary" : "Transfer flow files to the input port", - "description" : "", - "operationId" : "receiveFlowFiles", - "consumes" : [ "application/octet-stream" ], - "produces" : [ "text/plain" ], - "parameters" : [ { - "name" : "portId", - "in" : "path", - "description" : "The input port id.", - "required" : true, - "type" : "string" - }, { - "name" : "transactionId", - "in" : "path", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - }, - "503" : { - "description" : "NiFi instance is not ready for serving request, or temporarily overloaded. Retrying the same request later may be successful" - } - }, - "security" : [ { - "Write - /data-transfer/input-ports/{uuid}" : [ ] - } ] - } - }, - "/data-transfer/output-ports/{portId}/transactions/{transactionId}" : { - "put" : { - "tags" : [ "data-transfer" ], - "summary" : "Extend transaction TTL", - "description" : "", - "operationId" : "extendOutputPortTransactionTTL", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "portId", - "in" : "path", - "required" : true, - "type" : "string" - }, { - "name" : "transactionId", - "in" : "path", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/TransactionResultEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - }, - "503" : { - "description" : "NiFi instance is not ready for serving request, or temporarily overloaded. Retrying the same request later may be successful" - } - }, - "security" : [ { - "Write - /data-transfer/output-ports/{uuid}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "data-transfer" ], - "summary" : "Commit or cancel the specified transaction", - "description" : "", - "operationId" : "commitOutputPortTransaction", - "consumes" : [ "application/octet-stream" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "responseCode", - "in" : "query", - "description" : "The response code. Available values are CONFIRM_TRANSACTION(12) or CANCEL_TRANSACTION(15).", - "required" : true, - "type" : "integer", - "format" : "int32" - }, { - "name" : "checksum", - "in" : "query", - "description" : "A checksum calculated at client side using CRC32 to check flow file content integrity. It must match with the value calculated at server side.", - "required" : true, - "type" : "string" - }, { - "name" : "portId", - "in" : "path", - "description" : "The output port id.", - "required" : true, - "type" : "string" - }, { - "name" : "transactionId", - "in" : "path", - "description" : "The transaction id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/TransactionResultEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - }, - "503" : { - "description" : "NiFi instance is not ready for serving request, or temporarily overloaded. Retrying the same request later may be successful" - } - }, - "security" : [ { - "Write - /data-transfer/output-ports/{uuid}" : [ ] - } ] - } - }, - "/data-transfer/output-ports/{portId}/transactions/{transactionId}/flow-files" : { - "get" : { - "tags" : [ "data-transfer" ], - "summary" : "Transfer flow files from the output port", - "description" : "", - "operationId" : "transferFlowFiles", - "consumes" : [ "*/*" ], - "produces" : [ "application/octet-stream" ], - "parameters" : [ { - "name" : "portId", - "in" : "path", - "description" : "The output port id.", - "required" : true, - "type" : "string" - }, { - "name" : "transactionId", - "in" : "path", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "There is no flow file to return.", - "schema" : { - "$ref" : "#/definitions/StreamingOutput" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - }, - "503" : { - "description" : "NiFi instance is not ready for serving request, or temporarily overloaded. Retrying the same request later may be successful" - } - }, - "security" : [ { - "Write - /data-transfer/output-ports/{uuid}" : [ ] - } ] - } - }, - "/data-transfer/{portType}/{portId}/transactions" : { - "post" : { - "tags" : [ "data-transfer" ], - "summary" : "Create a transaction to the specified output port or input port", - "description" : "", - "operationId" : "createPortTransaction", - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "portType", - "in" : "path", - "description" : "The port type.", - "required" : true, - "type" : "string", - "enum" : [ "input-ports", "output-ports" ] - }, { - "name" : "portId", - "in" : "path", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/TransactionResultEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - }, - "503" : { - "description" : "NiFi instance is not ready for serving request, or temporarily overloaded. Retrying the same request later may be successful" - } - }, - "security" : [ { - "Write - /data-transfer/{component-type}/{uuid}" : [ ] - } ] - } - }, - "/flow/about" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Retrieves details about this NiFi to put in the About dialog", - "description" : "", - "operationId" : "getAboutInfo", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/AboutEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/banners" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Retrieves the banners for this NiFi", - "description" : "", - "operationId" : "getBanners", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/BannerEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/bulletin-board" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets current bulletins", - "description" : "", - "operationId" : "getBulletinBoard", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "after", - "in" : "query", - "description" : "Includes bulletins with an id after this value.", - "required" : false, - "type" : "string" - }, { - "name" : "sourceName", - "in" : "query", - "description" : "Includes bulletins originating from this sources whose name match this regular expression.", - "required" : false, - "type" : "string" - }, { - "name" : "message", - "in" : "query", - "description" : "Includes bulletins whose message that match this regular expression.", - "required" : false, - "type" : "string" - }, { - "name" : "sourceId", - "in" : "query", - "description" : "Includes bulletins originating from this sources whose id match this regular expression.", - "required" : false, - "type" : "string" - }, { - "name" : "groupId", - "in" : "query", - "description" : "Includes bulletins originating from this sources whose group id match this regular expression.", - "required" : false, - "type" : "string" - }, { - "name" : "limit", - "in" : "query", - "description" : "The number of bulletins to limit the response to.", - "required" : false, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/BulletinBoardEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - }, { - "Read - /{component-type}/{uuid} - For component specific bulletins" : [ ] - } ] - } - }, - "/flow/client-id" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Generates a client id.", - "description" : "", - "operationId" : "generateClientId", - "consumes" : [ "*/*" ], - "produces" : [ "text/plain" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/cluster/search-results" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Searches the cluster for a node with the specified address", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "searchCluster", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "q", - "in" : "query", - "description" : "Node address to search for.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ClusterSearchResultsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/cluster/summary" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "The cluster summary for this NiFi", - "description" : "", - "operationId" : "getClusterSummary", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ClusteSummaryEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/config" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Retrieves the configuration for this NiFi flow", - "description" : "", - "operationId" : "getFlowConfig", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/FlowConfigurationEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/connections/{id}/status" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets status for a connection", - "description" : "", - "operationId" : "getConnectionStatus", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "nodewise", - "in" : "query", - "description" : "Whether or not to include the breakdown per node. Optional, defaults to false", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "clusterNodeId", - "in" : "query", - "description" : "The id of the node where to get the status.", - "required" : false, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The connection id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ConnectionStatusEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/connections/{id}/status/history" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets the status history for a connection", - "description" : "", - "operationId" : "getConnectionStatusHistory", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The connection id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/StatusHistoryEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/controller-service-types" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Retrieves the types of controller services that this NiFi supports", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getControllerServiceTypes", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "serviceType", - "in" : "query", - "description" : "If specified, will only return controller services that are compatible with this type of service.", - "required" : false, - "type" : "string" - }, { - "name" : "serviceBundleGroup", - "in" : "query", - "description" : "If serviceType specified, is the bundle group of the serviceType.", - "required" : false, - "type" : "string" - }, { - "name" : "serviceBundleArtifact", - "in" : "query", - "description" : "If serviceType specified, is the bundle artifact of the serviceType.", - "required" : false, - "type" : "string" - }, { - "name" : "serviceBundleVersion", - "in" : "query", - "description" : "If serviceType specified, is the bundle version of the serviceType.", - "required" : false, - "type" : "string" - }, { - "name" : "bundleGroupFilter", - "in" : "query", - "description" : "If specified, will only return types that are a member of this bundle group.", - "required" : false, - "type" : "string" - }, { - "name" : "bundleArtifactFilter", - "in" : "query", - "description" : "If specified, will only return types that are a member of this bundle artifact.", - "required" : false, - "type" : "string" - }, { - "name" : "typeFilter", - "in" : "query", - "description" : "If specified, will only return types whose fully qualified classname matches.", - "required" : false, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ControllerServiceTypesEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/controller/bulletins" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Retrieves Controller level bulletins", - "description" : "", - "operationId" : "getBulletins", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ControllerBulletinsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - }, { - "Read - /controller - For controller bulletins" : [ ] - }, { - "Read - /controller-services/{uuid} - For controller service bulletins" : [ ] - }, { - "Read - /reporting-tasks/{uuid} - For reporting task bulletins" : [ ] - } ] - } - }, - "/flow/controller/controller-services" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets all controller services", - "description" : "", - "operationId" : "getControllerServicesFromController", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ControllerServicesEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/current-user" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Retrieves the user identity of the user making the request", - "description" : "", - "operationId" : "getCurrentUser", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/CurrentUserEntity" - } - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/history" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets configuration history", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "queryHistory", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "offset", - "in" : "query", - "description" : "The offset into the result set.", - "required" : true, - "type" : "string" - }, { - "name" : "count", - "in" : "query", - "description" : "The number of actions to return.", - "required" : true, - "type" : "string" - }, { - "name" : "sortColumn", - "in" : "query", - "description" : "The field to sort on.", - "required" : false, - "type" : "string" - }, { - "name" : "sortOrder", - "in" : "query", - "description" : "The direction to sort.", - "required" : false, - "type" : "string" - }, { - "name" : "startDate", - "in" : "query", - "description" : "Include actions after this date.", - "required" : false, - "type" : "string" - }, { - "name" : "endDate", - "in" : "query", - "description" : "Include actions before this date.", - "required" : false, - "type" : "string" - }, { - "name" : "userIdentity", - "in" : "query", - "description" : "Include actions performed by this user.", - "required" : false, - "type" : "string" - }, { - "name" : "sourceId", - "in" : "query", - "description" : "Include actions on this component.", - "required" : false, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/HistoryEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/history/components/{componentId}" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets configuration history for a component", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getComponentHistory", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "componentId", - "in" : "path", - "description" : "The component id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ComponentHistoryEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - }, { - "Read underlying component - /{component-type}/{uuid}" : [ ] - } ] - } - }, - "/flow/history/{id}" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets an action", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getAction", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The action id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ActionEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/input-ports/{id}/status" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets status for an input port", - "description" : "", - "operationId" : "getInputPortStatus", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "nodewise", - "in" : "query", - "description" : "Whether or not to include the breakdown per node. Optional, defaults to false", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "clusterNodeId", - "in" : "query", - "description" : "The id of the node where to get the status.", - "required" : false, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The input port id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/PortStatusEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/output-ports/{id}/status" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets status for an output port", - "description" : "", - "operationId" : "getOutputPortStatus", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "nodewise", - "in" : "query", - "description" : "Whether or not to include the breakdown per node. Optional, defaults to false", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "clusterNodeId", - "in" : "query", - "description" : "The id of the node where to get the status.", - "required" : false, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The output port id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/PortStatusEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/prioritizers" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Retrieves the types of prioritizers that this NiFi supports", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getPrioritizers", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/PrioritizerTypesEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/process-groups/{id}" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets a process group", - "description" : "", - "operationId" : "getFlow", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessGroupFlowEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - }, - "put" : { - "tags" : [ "flow" ], - "summary" : "Schedule or unschedule components in the specified Process Group.", - "description" : "", - "operationId" : "scheduleComponents", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The request to schedule or unschedule. If the comopnents in the request are not specified, all authorized components will be considered.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ScheduleComponentsEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ScheduleComponentsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - }, { - "Write - /{component-type}/{uuid} - For every component being scheduled/unscheduled" : [ ] - } ] - } - }, - "/flow/process-groups/{id}/controller-services" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets all controller services", - "description" : "", - "operationId" : "getControllerServicesFromGroup", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "name" : "includeAncestorGroups", - "in" : "query", - "description" : "Whether or not to include parent/ancestory process groups", - "required" : false, - "type" : "boolean", - "default" : true - }, { - "name" : "includeDescendantGroups", - "in" : "query", - "description" : "Whether or not to include descendant process groups", - "required" : false, - "type" : "boolean", - "default" : false - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ControllerServicesEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - }, - "put" : { - "tags" : [ "flow" ], - "summary" : "Enable or disable Controller Services in the specified Process Group.", - "description" : "", - "operationId" : "activateControllerServices", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The request to schedule or unschedule. If the comopnents in the request are not specified, all authorized components will be considered.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ActivateControllerServicesEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ActivateControllerServicesEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - }, { - "Write - /{component-type}/{uuid} - For every service being enabled/disabled" : [ ] - } ] - } - }, - "/flow/process-groups/{id}/status" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets the status for a process group", - "description" : "The status for a process group includes status for all descendent components. When invoked on the root group with recursive set to true, it will return the current status of every component in the flow.", - "operationId" : "getProcessGroupStatus", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "recursive", - "in" : "query", - "description" : "Whether all descendant groups and the status of their content will be included. Optional, defaults to false", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "nodewise", - "in" : "query", - "description" : "Whether or not to include the breakdown per node. Optional, defaults to false", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "clusterNodeId", - "in" : "query", - "description" : "The id of the node where to get the status.", - "required" : false, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessGroupStatusEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/process-groups/{id}/status/history" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets status history for a remote process group", - "description" : "", - "operationId" : "getProcessGroupStatusHistory", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/StatusHistoryEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/processor-types" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Retrieves the types of processors that this NiFi supports", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getProcessorTypes", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bundleGroupFilter", - "in" : "query", - "description" : "If specified, will only return types that are a member of this bundle group.", - "required" : false, - "type" : "string" - }, { - "name" : "bundleArtifactFilter", - "in" : "query", - "description" : "If specified, will only return types that are a member of this bundle artifact.", - "required" : false, - "type" : "string" - }, { - "name" : "type", - "in" : "query", - "description" : "If specified, will only return types whose fully qualified classname matches.", - "required" : false, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessorTypesEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/processors/{id}/status" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets status for a processor", - "description" : "", - "operationId" : "getProcessorStatus", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "nodewise", - "in" : "query", - "description" : "Whether or not to include the breakdown per node. Optional, defaults to false", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "clusterNodeId", - "in" : "query", - "description" : "The id of the node where to get the status.", - "required" : false, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The processor id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessorStatusEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/processors/{id}/status/history" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets status history for a processor", - "description" : "", - "operationId" : "getProcessorStatusHistory", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The processor id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/StatusHistoryEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/registries" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets the listing of available registries", - "description" : "", - "operationId" : "getRegistries", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/RegistryClientsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/registries/{id}/buckets" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets the buckets from the specified registry for the current user", - "description" : "", - "operationId" : "getBuckets", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The registry id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/BucketsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/registries/{registry-id}/buckets/{bucket-id}/flows" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets the flows from the specified registry and bucket for the current user", - "description" : "", - "operationId" : "getFlows", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "registry-id", - "in" : "path", - "description" : "The registry id.", - "required" : true, - "type" : "string" - }, { - "name" : "bucket-id", - "in" : "path", - "description" : "The bucket id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlowsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/registries/{registry-id}/buckets/{bucket-id}/flows/{flow-id}/versions" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets the flow versions from the specified registry and bucket for the specified flow for the current user", - "description" : "", - "operationId" : "getVersions", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "registry-id", - "in" : "path", - "description" : "The registry id.", - "required" : true, - "type" : "string" - }, { - "name" : "bucket-id", - "in" : "path", - "description" : "The bucket id.", - "required" : true, - "type" : "string" - }, { - "name" : "flow-id", - "in" : "path", - "description" : "The flow id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlowSnapshotMetadataSetEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/remote-process-groups/{id}/status" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets status for a remote process group", - "description" : "", - "operationId" : "getRemoteProcessGroupStatus", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "nodewise", - "in" : "query", - "description" : "Whether or not to include the breakdown per node. Optional, defaults to false", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "clusterNodeId", - "in" : "query", - "description" : "The id of the node where to get the status.", - "required" : false, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The remote process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/RemoteProcessGroupStatusEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/remote-process-groups/{id}/status/history" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets the status history", - "description" : "", - "operationId" : "getRemoteProcessGroupStatusHistory", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The remote process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/StatusHistoryEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/reporting-task-types" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Retrieves the types of reporting tasks that this NiFi supports", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getReportingTaskTypes", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bundleGroupFilter", - "in" : "query", - "description" : "If specified, will only return types that are a member of this bundle group.", - "required" : false, - "type" : "string" - }, { - "name" : "bundleArtifactFilter", - "in" : "query", - "description" : "If specified, will only return types that are a member of this bundle artifact.", - "required" : false, - "type" : "string" - }, { - "name" : "type", - "in" : "query", - "description" : "If specified, will only return types whose fully qualified classname matches.", - "required" : false, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ReportingTaskTypesEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/reporting-tasks" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets all reporting tasks", - "description" : "", - "operationId" : "getReportingTasks", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ReportingTasksEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/search-results" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Performs a search against this NiFi using the specified search term", - "description" : "Only search results from authorized components will be returned.", - "operationId" : "searchFlow", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "q", - "in" : "query", - "required" : false, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/SearchResultsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/status" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets the current status of this NiFi", - "description" : "", - "operationId" : "getControllerStatus", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ControllerStatusEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/templates" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets all templates", - "description" : "", - "operationId" : "getTemplates", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/TemplatesEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flowfile-queues/{id}/drop-requests" : { - "post" : { - "tags" : [ "flowfile-queues" ], - "summary" : "Creates a request to drop the contents of the queue in this connection.", - "description" : "", - "operationId" : "createDropRequest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The connection id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/DropRequestEntity" - } - }, - "202" : { - "description" : "The request has been accepted. A HTTP response header will contain the URI where the response can be polled." - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write Source Data - /data/{component-type}/{uuid}" : [ ] - } ] - } - }, - "/flowfile-queues/{id}/drop-requests/{drop-request-id}" : { - "get" : { - "tags" : [ "flowfile-queues" ], - "summary" : "Gets the current status of a drop request for the specified connection.", - "description" : "", - "operationId" : "getDropRequest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The connection id.", - "required" : true, - "type" : "string" - }, { - "name" : "drop-request-id", - "in" : "path", - "description" : "The drop request id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/DropRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write Source Data - /data/{component-type}/{uuid}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "flowfile-queues" ], - "summary" : "Cancels and/or removes a request to drop the contents of this connection.", - "description" : "", - "operationId" : "removeDropRequest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The connection id.", - "required" : true, - "type" : "string" - }, { - "name" : "drop-request-id", - "in" : "path", - "description" : "The drop request id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/DropRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write Source Data - /data/{component-type}/{uuid}" : [ ] - } ] - } - }, - "/flowfile-queues/{id}/flowfiles/{flowfile-uuid}" : { - "get" : { - "tags" : [ "flowfile-queues" ], - "summary" : "Gets a FlowFile from a Connection.", - "description" : "", - "operationId" : "getFlowFile", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The connection id.", - "required" : true, - "type" : "string" - }, { - "name" : "flowfile-uuid", - "in" : "path", - "description" : "The flowfile uuid.", - "required" : true, - "type" : "string" - }, { - "name" : "clusterNodeId", - "in" : "query", - "description" : "The id of the node where the content exists if clustered.", - "required" : false, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/FlowFileEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read Source Data - /data/{component-type}/{uuid}" : [ ] - } ] - } - }, - "/flowfile-queues/{id}/flowfiles/{flowfile-uuid}/content" : { - "get" : { - "tags" : [ "flowfile-queues" ], - "summary" : "Gets the content for a FlowFile in a Connection.", - "description" : "", - "operationId" : "downloadFlowFileContent", - "consumes" : [ "*/*" ], - "produces" : [ "*/*" ], - "parameters" : [ { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The connection id.", - "required" : true, - "type" : "string" - }, { - "name" : "flowfile-uuid", - "in" : "path", - "description" : "The flowfile uuid.", - "required" : true, - "type" : "string" - }, { - "name" : "clusterNodeId", - "in" : "query", - "description" : "The id of the node where the content exists if clustered.", - "required" : false, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/StreamingOutput" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read Source Data - /data/{component-type}/{uuid}" : [ ] - } ] - } - }, - "/flowfile-queues/{id}/listing-requests" : { - "post" : { - "tags" : [ "flowfile-queues" ], - "summary" : "Lists the contents of the queue in this connection.", - "description" : "", - "operationId" : "createFlowFileListing", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The connection id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ListingRequestEntity" - } - }, - "202" : { - "description" : "The request has been accepted. A HTTP response header will contain the URI where the response can be polled." - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read Source Data - /data/{component-type}/{uuid}" : [ ] - } ] - } - }, - "/flowfile-queues/{id}/listing-requests/{listing-request-id}" : { - "get" : { - "tags" : [ "flowfile-queues" ], - "summary" : "Gets the current status of a listing request for the specified connection.", - "description" : "", - "operationId" : "getListingRequest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The connection id.", - "required" : true, - "type" : "string" - }, { - "name" : "listing-request-id", - "in" : "path", - "description" : "The listing request id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ListingRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read Source Data - /data/{component-type}/{uuid}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "flowfile-queues" ], - "summary" : "Cancels and/or removes a request to list the contents of this connection.", - "description" : "", - "operationId" : "deleteListingRequest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The connection id.", - "required" : true, - "type" : "string" - }, { - "name" : "listing-request-id", - "in" : "path", - "description" : "The listing request id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ListingRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read Source Data - /data/{component-type}/{uuid}" : [ ] - } ] - } - }, - "/funnels/{id}" : { - "get" : { - "tags" : [ "funnel" ], - "summary" : "Gets a funnel", - "description" : "", - "operationId" : "getFunnel", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The funnel id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/FunnelEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /funnels/{uuid}" : [ ] - } ] - }, - "put" : { - "tags" : [ "funnel" ], - "summary" : "Updates a funnel", - "description" : "", - "operationId" : "updateFunnel", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The funnel id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The funnel configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/FunnelEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/FunnelEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /funnels/{uuid}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "funnel" ], - "summary" : "Deletes a funnel", - "description" : "", - "operationId" : "removeFunnel", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The revision is used to verify the client is working with the latest version of the flow.", - "required" : false, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The funnel id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/FunnelEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /funnels/{uuid}" : [ ] - }, { - "Write - Parent Process Group - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/input-ports/{id}" : { - "get" : { - "tags" : [ "input-ports" ], - "summary" : "Gets an input port", - "description" : "", - "operationId" : "getInputPort", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The input port id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/PortEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /input-ports/{uuid}" : [ ] - } ] - }, - "put" : { - "tags" : [ "input-ports" ], - "summary" : "Updates an input port", - "description" : "", - "operationId" : "updateInputPort", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The input port id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The input port configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/PortEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/PortEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /input-ports/{uuid}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "input-ports" ], - "summary" : "Deletes an input port", - "description" : "", - "operationId" : "removeInputPort", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The revision is used to verify the client is working with the latest version of the flow.", - "required" : false, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The input port id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/PortEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /input-ports/{uuid}" : [ ] - }, { - "Write - Parent Process Group - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/labels/{id}" : { - "get" : { - "tags" : [ "labels" ], - "summary" : "Gets a label", - "description" : "", - "operationId" : "getLabel", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The label id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/LabelEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /labels/{uuid}" : [ ] - } ] - }, - "put" : { - "tags" : [ "labels" ], - "summary" : "Updates a label", - "description" : "", - "operationId" : "updateLabel", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The label id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The label configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/LabelEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/LabelEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /labels/{uuid}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "labels" ], - "summary" : "Deletes a label", - "description" : "", - "operationId" : "removeLabel", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The revision is used to verify the client is working with the latest version of the flow.", - "required" : false, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The label id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/LabelEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /labels/{uuid}" : [ ] - }, { - "Write - Parent Process Group - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/output-ports/{id}" : { - "get" : { - "tags" : [ "output-ports" ], - "summary" : "Gets an output port", - "description" : "", - "operationId" : "getOutputPort", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The output port id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/PortEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /output-ports/{uuid}" : [ ] - } ] - }, - "put" : { - "tags" : [ "output-ports" ], - "summary" : "Updates an output port", - "description" : "", - "operationId" : "updateOutputPort", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The output port id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The output port configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/PortEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/PortEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /output-ports/{uuid}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "output-ports" ], - "summary" : "Deletes an output port", - "description" : "", - "operationId" : "removeOutputPort", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The revision is used to verify the client is working with the latest version of the flow.", - "required" : false, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The output port id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/PortEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /output-ports/{uuid}" : [ ] - }, { - "Write - Parent Process Group - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/policies" : { - "post" : { - "tags" : [ "policies" ], - "summary" : "Creates an access policy", - "description" : "", - "operationId" : "createAccessPolicy", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The access policy configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/AccessPolicyEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/AccessPolicyEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /policies/{resource}" : [ ] - } ] - } - }, - "/policies/{action}/{resource}" : { - "get" : { - "tags" : [ "policies" ], - "summary" : "Gets an access policy for the specified action and resource", - "description" : "Will return the effective policy if no component specific policy exists for the specified action and resource. Must have Read permissions to the policy with the desired action and resource. Permissions for the policy that is returned will be indicated in the response. This means the client could be authorized to get the policy for a given component but the effective policy may be inherited from an ancestor Process Group. If the client does not have permissions to that policy, the response will not include the policy and the permissions in the response will be marked accordingly. If the client does not have permissions to the policy of the desired action and resource a 403 response will be returned.", - "operationId" : "getAccessPolicyForResource", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "action", - "in" : "path", - "description" : "The request action.", - "required" : true, - "type" : "string", - "enum" : [ "read", "write" ] - }, { - "name" : "resource", - "in" : "path", - "description" : "The resource of the policy.", - "required" : true, - "type" : "string", - "pattern" : ".+" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/AccessPolicyEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /policies/{resource}" : [ ] - } ] - } - }, - "/policies/{id}" : { - "get" : { - "tags" : [ "policies" ], - "summary" : "Gets an access policy", - "description" : "", - "operationId" : "getAccessPolicy", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The access policy id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/AccessPolicyEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /policies/{resource}" : [ ] - } ] - }, - "put" : { - "tags" : [ "policies" ], - "summary" : "Updates a access policy", - "description" : "", - "operationId" : "updateAccessPolicy", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The access policy id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The access policy configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/AccessPolicyEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/AccessPolicyEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /policies/{resource}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "policies" ], - "summary" : "Deletes an access policy", - "description" : "", - "operationId" : "removeAccessPolicy", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The revision is used to verify the client is working with the latest version of the flow.", - "required" : false, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The access policy id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/AccessPolicyEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /policies/{resource}" : [ ] - }, { - "Write - Policy of the parent resource - /policies/{resource}" : [ ] - } ] - } - }, - "/process-groups/{groupId}/variable-registry/update-requests/{updateId}" : { - "get" : { - "tags" : [ "process-groups" ], - "summary" : "Gets a process group's variable registry", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getVariableRegistryUpdateRequest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "groupId", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "name" : "updateId", - "in" : "path", - "description" : "The ID of the Variable Registry Update Request", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VariableRegistryUpdateRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "process-groups" ], - "summary" : "Deletes an update request for a process group's variable registry. If the request is not yet complete, it will automatically be cancelled.", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "deleteVariableRegistryUpdateRequest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "groupId", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "name" : "updateId", - "in" : "path", - "description" : "The ID of the Variable Registry Update Request", - "required" : true, - "type" : "string" - }, { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VariableRegistryUpdateRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/process-groups/{id}" : { - "get" : { - "tags" : [ "process-groups" ], - "summary" : "Gets a process group", - "description" : "", - "operationId" : "getProcessGroup", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessGroupEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - } ] - }, - "put" : { - "tags" : [ "process-groups" ], - "summary" : "Updates a process group", - "description" : "", - "operationId" : "updateProcessGroup", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The process group configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ProcessGroupEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessGroupEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "process-groups" ], - "summary" : "Deletes a process group", - "description" : "", - "operationId" : "removeProcessGroup", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The revision is used to verify the client is working with the latest version of the flow.", - "required" : false, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessGroupEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - }, { - "Write - Parent Process Group - /process-groups/{uuid}" : [ ] - }, { - "Read - any referenced Controller Services by any encapsulated components - /controller-services/{uuid}" : [ ] - }, { - "Write - /{component-type}/{uuid} - For all encapsulated components" : [ ] - } ] - } - }, - "/process-groups/{id}/connections" : { - "get" : { - "tags" : [ "process-groups" ], - "summary" : "Gets all connections", - "description" : "", - "operationId" : "getConnections", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ConnectionsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - } ] - }, - "post" : { - "tags" : [ "process-groups" ], - "summary" : "Creates a connection", - "description" : "", - "operationId" : "createConnection", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The connection configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ConnectionEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ConnectionEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - }, { - "Write Source - /{component-type}/{uuid}" : [ ] - }, { - "Write Destination - /{component-type}/{uuid}" : [ ] - } ] - } - }, - "/process-groups/{id}/controller-services" : { - "post" : { - "tags" : [ "process-groups" ], - "summary" : "Creates a new controller service", - "description" : "", - "operationId" : "createControllerService", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The controller service configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ControllerServiceEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ControllerServiceEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - }, { - "Read - any referenced Controller Services - /controller-services/{uuid}" : [ ] - }, { - "Write - if the Controller Service is restricted - /restricted-components" : [ ] - } ] - } - }, - "/process-groups/{id}/funnels" : { - "get" : { - "tags" : [ "process-groups" ], - "summary" : "Gets all funnels", - "description" : "", - "operationId" : "getFunnels", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/FunnelsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - } ] - }, - "post" : { - "tags" : [ "process-groups" ], - "summary" : "Creates a funnel", - "description" : "", - "operationId" : "createFunnel", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The funnel configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/FunnelEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/FunnelEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/process-groups/{id}/input-ports" : { - "get" : { - "tags" : [ "process-groups" ], - "summary" : "Gets all input ports", - "description" : "", - "operationId" : "getInputPorts", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/InputPortsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - } ] - }, - "post" : { - "tags" : [ "process-groups" ], - "summary" : "Creates an input port", - "description" : "", - "operationId" : "createInputPort", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The input port configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/PortEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/PortEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/process-groups/{id}/labels" : { - "get" : { - "tags" : [ "process-groups" ], - "summary" : "Gets all labels", - "description" : "", - "operationId" : "getLabels", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/LabelsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - } ] - }, - "post" : { - "tags" : [ "process-groups" ], - "summary" : "Creates a label", - "description" : "", - "operationId" : "createLabel", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The label configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/LabelEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/LabelEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/process-groups/{id}/local-modifications" : { - "get" : { - "tags" : [ "process-groups" ], - "summary" : "Gets a list of local modifications to the Process Group since it was last synchronized with the Flow Registry", - "description" : "", - "operationId" : "getLocalModifications", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/FlowComparisonEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - }, { - "Read - /{component-type}/{uuid} - For all encapsulated components" : [ ] - } ] - } - }, - "/process-groups/{id}/output-ports" : { - "get" : { - "tags" : [ "process-groups" ], - "summary" : "Gets all output ports", - "description" : "", - "operationId" : "getOutputPorts", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/OutputPortsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - } ] - }, - "post" : { - "tags" : [ "process-groups" ], - "summary" : "Creates an output port", - "description" : "", - "operationId" : "createOutputPort", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The output port configuration.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/PortEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/PortEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/process-groups/{id}/process-groups" : { - "get" : { - "tags" : [ "process-groups" ], - "summary" : "Gets all process groups", - "description" : "", - "operationId" : "getProcessGroups", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessGroupsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - } ] - }, - "post" : { - "tags" : [ "process-groups" ], - "summary" : "Creates a process group", - "description" : "", - "operationId" : "createProcessGroup", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The process group configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ProcessGroupEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessGroupEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/process-groups/{id}/processors" : { - "get" : { - "tags" : [ "process-groups" ], - "summary" : "Gets all processors", - "description" : "", - "operationId" : "getProcessors", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "name" : "includeDescendantGroups", - "in" : "query", - "description" : "Whether or not to include processors from descendant process groups", - "required" : false, - "type" : "boolean", - "default" : false - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessorsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - } ] - }, - "post" : { - "tags" : [ "process-groups" ], - "summary" : "Creates a new processor", - "description" : "", - "operationId" : "createProcessor", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The processor configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ProcessorEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessorEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - }, { - "Read - any referenced Controller Services - /controller-services/{uuid}" : [ ] - }, { - "Write - if the Processor is restricted - /restricted-components" : [ ] - } ] - } - }, - "/process-groups/{id}/remote-process-groups" : { - "get" : { - "tags" : [ "process-groups" ], - "summary" : "Gets all remote process groups", - "description" : "", - "operationId" : "getRemoteProcessGroups", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/RemoteProcessGroupsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - } ] - }, - "post" : { - "tags" : [ "process-groups" ], - "summary" : "Creates a new process group", - "description" : "", - "operationId" : "createRemoteProcessGroup", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The remote process group configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/RemoteProcessGroupEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/RemoteProcessGroupEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/process-groups/{id}/snippet-instance" : { - "post" : { - "tags" : [ "process-groups" ], - "summary" : "Copies a snippet and discards it.", - "description" : "", - "operationId" : "copySnippet", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The copy snippet request.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/CopySnippetRequestEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/FlowEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - }, { - "Read - /{component-type}/{uuid} - For each component in the snippet and their descendant components" : [ ] - }, { - "Write - if the snippet contains any restricted Processors - /restricted-components" : [ ] - } ] - } - }, - "/process-groups/{id}/template-instance" : { - "post" : { - "tags" : [ "process-groups" ], - "summary" : "Instantiates a template", - "description" : "", - "operationId" : "instantiateTemplate", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The instantiate template request.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/InstantiateTemplateRequestEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/FlowEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - }, { - "Read - /templates/{uuid}" : [ ] - }, { - "Write - if the template contains any restricted components - /restricted-components" : [ ] - } ] - } - }, - "/process-groups/{id}/templates" : { - "post" : { - "tags" : [ "process-groups" ], - "summary" : "Creates a template and discards the specified snippet.", - "description" : "", - "operationId" : "createTemplate", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The create template request.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/CreateTemplateRequestEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/TemplateEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - }, { - "Read - /{component-type}/{uuid} - For each component in the snippet and their descendant components" : [ ] - } ] - } - }, - "/process-groups/{id}/templates/import" : { - "post" : { - "tags" : [ "process-groups" ], - "summary" : "Imports a template", - "description" : "", - "operationId" : "importTemplate", - "consumes" : [ "application/xml" ], - "produces" : [ "application/xml" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/TemplateEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/process-groups/{id}/templates/upload" : { - "post" : { - "tags" : [ "process-groups" ], - "summary" : "Uploads a template", - "description" : "", - "operationId" : "uploadTemplate", - "consumes" : [ "multipart/form-data" ], - "produces" : [ "application/xml" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "schema" : { - "type" : "boolean" - } - }, { - "name" : "template", - "in" : "formData", - "description" : "The binary content of the template file being uploaded.", - "required" : true, - "type" : "file" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/TemplateEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/process-groups/{id}/variable-registry" : { - "get" : { - "tags" : [ "process-groups" ], - "summary" : "Gets a process group's variable registry", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getVariableRegistry", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "name" : "includeAncestorGroups", - "in" : "query", - "description" : "Whether or not to include ancestor groups", - "required" : false, - "type" : "boolean", - "default" : true - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VariableRegistryEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - } ] - }, - "put" : { - "tags" : [ "process-groups" ], - "summary" : "Updates the contents of a Process Group's variable Registry", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "updateVariableRegistry", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The variable registry configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/VariableRegistryEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VariableRegistryEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/process-groups/{id}/variable-registry/update-requests" : { - "post" : { - "tags" : [ "process-groups" ], - "summary" : "Submits a request to update a process group's variable registry", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "submitUpdateVariableRegistryRequest", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The variable registry configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/VariableRegistryEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VariableRegistryUpdateRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/processors/{id}" : { - "get" : { - "tags" : [ "processors" ], - "summary" : "Gets a processor", - "description" : "", - "operationId" : "getProcessor", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The processor id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessorEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /processors/{uuid}" : [ ] - } ] - }, - "put" : { - "tags" : [ "processors" ], - "summary" : "Updates a processor", - "description" : "", - "operationId" : "updateProcessor", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The processor id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The processor configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ProcessorEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessorEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /processors/{uuid}" : [ ] - }, { - "Read - any referenced Controller Services if this request changes the reference - /controller-services/{uuid}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "processors" ], - "summary" : "Deletes a processor", - "description" : "", - "operationId" : "deleteProcessor", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The revision is used to verify the client is working with the latest version of the flow.", - "required" : false, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The processor id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessorEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /processors/{uuid}" : [ ] - }, { - "Write - Parent Process Group - /process-groups/{uuid}" : [ ] - }, { - "Read - any referenced Controller Services - /controller-services/{uuid}" : [ ] - } ] - } - }, - "/processors/{id}/descriptors" : { - "get" : { - "tags" : [ "processors" ], - "summary" : "Gets the descriptor for a processor property", - "description" : "", - "operationId" : "getPropertyDescriptor", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The processor id.", - "required" : true, - "type" : "string" - }, { - "name" : "propertyName", - "in" : "query", - "description" : "The property name.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/PropertyDescriptorEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /processors/{uuid}" : [ ] - } ] - } - }, - "/processors/{id}/diagnostics" : { - "get" : { - "tags" : [ "processors" ], - "summary" : "Gets diagnostics information about a processor", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getProcessorDiagnostics", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The processor id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessorEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /processors/{uuid}" : [ ] - } ] - } - }, - "/processors/{id}/state" : { - "get" : { - "tags" : [ "processors" ], - "summary" : "Gets the state for a processor", - "description" : "", - "operationId" : "getState", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The processor id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ComponentStateEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /processors/{uuid}" : [ ] - } ] - } - }, - "/processors/{id}/state/clear-requests" : { - "post" : { - "tags" : [ "processors" ], - "summary" : "Clears the state for a processor", - "description" : "", - "operationId" : "clearState", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The processor id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ComponentStateEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /processors/{uuid}" : [ ] - } ] - } - }, - "/processors/{id}/threads" : { - "delete" : { - "tags" : [ "processors" ], - "summary" : "Terminates a processor, essentially \"deleting\" its threads and any active tasks", - "description" : "", - "operationId" : "terminateProcessor", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The processor id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessorEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /processors/{uuid}" : [ ] - } ] - } - }, - "/provenance" : { - "post" : { - "tags" : [ "provenance" ], - "summary" : "Submits a provenance query", - "description" : "Provenance queries may be long running so this endpoint submits a request. The response will include the current state of the query. If the request is not completed the URI in the response can be used at a later time to get the updated state of the query. Once the query has completed the provenance request should be deleted by the client who originally submitted it.", - "operationId" : "submitProvenanceRequest", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The provenance query details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ProvenanceEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProvenanceEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /provenance" : [ ] - }, { - "Read - /data/{component-type}/{uuid}" : [ ] - } ] - } - }, - "/provenance-events/replays" : { - "post" : { - "tags" : [ "provenance-events" ], - "summary" : "Replays content from a provenance event", - "description" : "", - "operationId" : "submitReplay", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The replay request.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/SubmitReplayRequestEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProvenanceEventEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read Component Provenance Data - /provenance-data/{component-type}/{uuid}" : [ ] - }, { - "Read Component Data - /data/{component-type}/{uuid}" : [ ] - }, { - "Write Component Data - /data/{component-type}/{uuid}" : [ ] - } ] - } - }, - "/provenance-events/{id}" : { - "get" : { - "tags" : [ "provenance-events" ], - "summary" : "Gets a provenance event", - "description" : "", - "operationId" : "getProvenanceEvent", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "clusterNodeId", - "in" : "query", - "description" : "The id of the node where this event exists if clustered.", - "required" : false, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The provenance event id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProvenanceEventEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read Component Provenance Data - /provenance-data/{component-type}/{uuid}" : [ ] - } ] - } - }, - "/provenance-events/{id}/content/input" : { - "get" : { - "tags" : [ "provenance-events" ], - "summary" : "Gets the input content for a provenance event", - "description" : "", - "operationId" : "getInputContent", - "consumes" : [ "*/*" ], - "produces" : [ "*/*" ], - "parameters" : [ { - "name" : "clusterNodeId", - "in" : "query", - "description" : "The id of the node where the content exists if clustered.", - "required" : false, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The provenance event id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/StreamingOutput" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read Component Provenance Data - /provenance-data/{component-type}/{uuid}" : [ ] - }, { - "Read Component Data - /data/{component-type}/{uuid}" : [ ] - } ] - } - }, - "/provenance-events/{id}/content/output" : { - "get" : { - "tags" : [ "provenance-events" ], - "summary" : "Gets the output content for a provenance event", - "description" : "", - "operationId" : "getOutputContent", - "consumes" : [ "*/*" ], - "produces" : [ "*/*" ], - "parameters" : [ { - "name" : "clusterNodeId", - "in" : "query", - "description" : "The id of the node where the content exists if clustered.", - "required" : false, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The provenance event id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/StreamingOutput" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read Component Provenance Data - /provenance-data/{component-type}/{uuid}" : [ ] - }, { - "Read Component Data - /data/{component-type}/{uuid}" : [ ] - } ] - } - }, - "/provenance/lineage" : { - "post" : { - "tags" : [ "provenance" ], - "summary" : "Submits a lineage query", - "description" : "Lineage queries may be long running so this endpoint submits a request. The response will include the current state of the query. If the request is not completed the URI in the response can be used at a later time to get the updated state of the query. Once the query has completed the lineage request should be deleted by the client who originally submitted it.", - "operationId" : "submitLineageRequest", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The lineage query details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/LineageEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/LineageEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /provenance" : [ ] - }, { - "Read - /data/{component-type}/{uuid}" : [ ] - } ] - } - }, - "/provenance/lineage/{id}" : { - "get" : { - "tags" : [ "provenance" ], - "summary" : "Gets a lineage query", - "description" : "", - "operationId" : "getLineage", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "clusterNodeId", - "in" : "query", - "description" : "The id of the node where this query exists if clustered.", - "required" : false, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The id of the lineage query.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/LineageEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /provenance" : [ ] - }, { - "Read - /data/{component-type}/{uuid}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "provenance" ], - "summary" : "Deletes a lineage query", - "description" : "", - "operationId" : "deleteLineage", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "clusterNodeId", - "in" : "query", - "description" : "The id of the node where this query exists if clustered.", - "required" : false, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The id of the lineage query.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/LineageEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /provenance" : [ ] - } ] - } - }, - "/provenance/search-options" : { - "get" : { - "tags" : [ "provenance" ], - "summary" : "Gets the searchable attributes for provenance events", - "description" : "", - "operationId" : "getSearchOptions", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProvenanceOptionsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /provenance" : [ ] - } ] - } - }, - "/provenance/{id}" : { - "get" : { - "tags" : [ "provenance" ], - "summary" : "Gets a provenance query", - "description" : "", - "operationId" : "getProvenance", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "clusterNodeId", - "in" : "query", - "description" : "The id of the node where this query exists if clustered.", - "required" : false, - "type" : "string" - }, { - "name" : "summarize", - "in" : "query", - "description" : "Whether or not incremental results are returned. If false, provenance events are only returned once the query completes. This property is true by default.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "incrementalResults", - "in" : "query", - "description" : "Whether or not to summarize provenance events returned. This property is false by default.", - "required" : false, - "type" : "boolean", - "default" : true - }, { - "name" : "id", - "in" : "path", - "description" : "The id of the provenance query.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProvenanceEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /provenance" : [ ] - }, { - "Read - /data/{component-type}/{uuid}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "provenance" ], - "summary" : "Deletes a provenance query", - "description" : "", - "operationId" : "deleteProvenance", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "clusterNodeId", - "in" : "query", - "description" : "The id of the node where this query exists if clustered.", - "required" : false, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The id of the provenance query.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProvenanceEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /provenance" : [ ] - } ] - } - }, - "/remote-process-groups/{id}" : { - "get" : { - "tags" : [ "remote-process-groups" ], - "summary" : "Gets a remote process group", - "description" : "", - "operationId" : "getRemoteProcessGroup", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The remote process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/RemoteProcessGroupEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /remote-process-groups/{uuid}" : [ ] - } ] - }, - "put" : { - "tags" : [ "remote-process-groups" ], - "summary" : "Updates a remote process group", - "description" : "", - "operationId" : "updateRemoteProcessGroup", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The remote process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The remote process group.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/RemoteProcessGroupEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/RemoteProcessGroupEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /remote-process-groups/{uuid}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "remote-process-groups" ], - "summary" : "Deletes a remote process group", - "description" : "", - "operationId" : "removeRemoteProcessGroup", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The revision is used to verify the client is working with the latest version of the flow.", - "required" : false, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The remote process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/RemoteProcessGroupEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /remote-process-groups/{uuid}" : [ ] - }, { - "Write - Parent Process Group - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/remote-process-groups/{id}/input-ports/{port-id}" : { - "put" : { - "tags" : [ "remote-process-groups" ], - "summary" : "Updates a remote port", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "updateRemoteProcessGroupInputPort", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The remote process group id.", - "required" : true, - "type" : "string" - }, { - "name" : "port-id", - "in" : "path", - "description" : "The remote process group port id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The remote process group port.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/RemoteProcessGroupPortEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/RemoteProcessGroupPortEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /remote-process-groups/{uuid}" : [ ] - } ] - } - }, - "/remote-process-groups/{id}/output-ports/{port-id}" : { - "put" : { - "tags" : [ "remote-process-groups" ], - "summary" : "Updates a remote port", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "updateRemoteProcessGroupOutputPort", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The remote process group id.", - "required" : true, - "type" : "string" - }, { - "name" : "port-id", - "in" : "path", - "description" : "The remote process group port id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The remote process group port.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/RemoteProcessGroupPortEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/RemoteProcessGroupPortEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /remote-process-groups/{uuid}" : [ ] - } ] - } - }, - "/reporting-tasks/{id}" : { - "get" : { - "tags" : [ "reporting-tasks" ], - "summary" : "Gets a reporting task", - "description" : "", - "operationId" : "getReportingTask", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The reporting task id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ReportingTaskEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /reporting-tasks/{uuid}" : [ ] - } ] - }, - "put" : { - "tags" : [ "reporting-tasks" ], - "summary" : "Updates a reporting task", - "description" : "", - "operationId" : "updateReportingTask", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The reporting task id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The reporting task configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ReportingTaskEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ReportingTaskEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /reporting-tasks/{uuid}" : [ ] - }, { - "Read - any referenced Controller Services if this request changes the reference - /controller-services/{uuid}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "reporting-tasks" ], - "summary" : "Deletes a reporting task", - "description" : "", - "operationId" : "removeReportingTask", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The revision is used to verify the client is working with the latest version of the flow.", - "required" : false, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The reporting task id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ReportingTaskEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /reporting-tasks/{uuid}" : [ ] - }, { - "Write - /controller" : [ ] - }, { - "Read - any referenced Controller Services - /controller-services/{uuid}" : [ ] - } ] - } - }, - "/reporting-tasks/{id}/descriptors" : { - "get" : { - "tags" : [ "reporting-tasks" ], - "summary" : "Gets a reporting task property descriptor", - "description" : "", - "operationId" : "getPropertyDescriptor", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The reporting task id.", - "required" : true, - "type" : "string" - }, { - "name" : "propertyName", - "in" : "query", - "description" : "The property name.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/PropertyDescriptorEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /reporting-tasks/{uuid}" : [ ] - } ] - } - }, - "/reporting-tasks/{id}/state" : { - "get" : { - "tags" : [ "reporting-tasks" ], - "summary" : "Gets the state for a reporting task", - "description" : "", - "operationId" : "getState", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The reporting task id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ComponentStateEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /reporting-tasks/{uuid}" : [ ] - } ] - } - }, - "/reporting-tasks/{id}/state/clear-requests" : { - "post" : { - "tags" : [ "reporting-tasks" ], - "summary" : "Clears the state for a reporting task", - "description" : "", - "operationId" : "clearState", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The reporting task id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ComponentStateEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /reporting-tasks/{uuid}" : [ ] - } ] - } - }, - "/resources" : { - "get" : { - "tags" : [ "resources" ], - "summary" : "Gets the available resources that support access/authorization policies", - "description" : "", - "operationId" : "getResources", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ResourcesEntity" - } - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - } - }, - "security" : [ { - "Read - /resources" : [ ] - } ] - } - }, - "/site-to-site" : { - "get" : { - "tags" : [ "site-to-site" ], - "summary" : "Returns the details about this NiFi necessary to communicate via site to site", - "description" : "", - "operationId" : "getSiteToSiteDetails", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ControllerEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /site-to-site" : [ ] - } ] - } - }, - "/site-to-site/peers" : { - "get" : { - "tags" : [ "site-to-site" ], - "summary" : "Returns the available Peers and its status of this NiFi", - "description" : "", - "operationId" : "getPeers", - "consumes" : [ "*/*" ], - "produces" : [ "application/json", "application/xml" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/PeersEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /site-to-site" : [ ] - } ] - } - }, - "/snippets" : { - "post" : { - "tags" : [ "snippets" ], - "summary" : "Creates a snippet. The snippet will be automatically discarded if not used in a subsequent request after 1 minute.", - "description" : "", - "operationId" : "createSnippet", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The snippet configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/SnippetEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/SnippetEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read or Write - /{component-type}/{uuid} - For every component (all Read or all Write) in the Snippet and their descendant components" : [ ] - } ] - } - }, - "/snippets/{id}" : { - "put" : { - "tags" : [ "snippets" ], - "summary" : "Move's the components in this Snippet into a new Process Group and discards the snippet", - "description" : "", - "operationId" : "updateSnippet", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The snippet id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The snippet configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/SnippetEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/SnippetEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write Process Group - /process-groups/{uuid}" : [ ] - }, { - "Write - /{component-type}/{uuid} - For each component in the Snippet and their descendant components" : [ ] - } ] - }, - "delete" : { - "tags" : [ "snippets" ], - "summary" : "Deletes the components in a snippet and discards the snippet", - "description" : "", - "operationId" : "deleteSnippet", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The snippet id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/SnippetEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /{component-type}/{uuid} - For each component in the Snippet and their descendant components" : [ ] - }, { - "Write - Parent Process Group - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/system-diagnostics" : { - "get" : { - "tags" : [ "system-diagnostics" ], - "summary" : "Gets the diagnostics for the system NiFi is running on", - "description" : "", - "operationId" : "getSystemDiagnostics", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "nodewise", - "in" : "query", - "description" : "Whether or not to include the breakdown per node. Optional, defaults to false", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "clusterNodeId", - "in" : "query", - "description" : "The id of the node where to get the status.", - "required" : false, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/SystemDiagnosticsEntity" - } - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - } - }, - "security" : [ { - "Read - /system" : [ ] - } ] - } - }, - "/templates/{id}" : { - "delete" : { - "tags" : [ "templates" ], - "summary" : "Deletes a template", - "description" : "", - "operationId" : "removeTemplate", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The template id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/TemplateEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /templates/{uuid}" : [ ] - }, { - "Write - Parent Process Group - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/templates/{id}/download" : { - "get" : { - "tags" : [ "templates" ], - "summary" : "Exports a template", - "description" : "", - "operationId" : "exportTemplate", - "consumes" : [ "*/*" ], - "produces" : [ "application/xml" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The template id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /templates/{uuid}" : [ ] - } ] - } - }, - "/tenants/search-results" : { - "get" : { - "tags" : [ "tenants" ], - "summary" : "Searches for a tenant with the specified identity", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "searchTenants", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "q", - "in" : "query", - "description" : "Identity to search for.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/TenantsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /tenants" : [ ] - } ] - } - }, - "/tenants/user-groups" : { - "get" : { - "tags" : [ "tenants" ], - "summary" : "Gets all user groups", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getUserGroups", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/UserGroupsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /tenants" : [ ] - } ] - }, - "post" : { - "tags" : [ "tenants" ], - "summary" : "Creates a user group", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "createUserGroup", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The user group configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/UserGroupEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/UserGroupEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /tenants" : [ ] - } ] - } - }, - "/tenants/user-groups/{id}" : { - "get" : { - "tags" : [ "tenants" ], - "summary" : "Gets a user group", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getUserGroup", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The user group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/UserGroupEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /tenants" : [ ] - } ] - }, - "put" : { - "tags" : [ "tenants" ], - "summary" : "Updates a user group", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "updateUserGroup", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The user group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The user group configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/UserGroupEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/UserGroupEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /tenants" : [ ] - } ] - }, - "delete" : { - "tags" : [ "tenants" ], - "summary" : "Deletes a user group", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "removeUserGroup", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The revision is used to verify the client is working with the latest version of the flow.", - "required" : false, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The user group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/UserGroupEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /tenants" : [ ] - } ] - } - }, - "/tenants/users" : { - "get" : { - "tags" : [ "tenants" ], - "summary" : "Gets all users", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getUsers", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/UsersEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /tenants" : [ ] - } ] - }, - "post" : { - "tags" : [ "tenants" ], - "summary" : "Creates a user", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "createUser", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The user configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/UserEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/UserEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /tenants" : [ ] - } ] - } - }, - "/tenants/users/{id}" : { - "get" : { - "tags" : [ "tenants" ], - "summary" : "Gets a user", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getUser", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The user id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/UserEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /tenants" : [ ] - } ] - }, - "put" : { - "tags" : [ "tenants" ], - "summary" : "Updates a user", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "updateUser", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The user id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The user configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/UserEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/UserEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /tenants" : [ ] - } ] - }, - "delete" : { - "tags" : [ "tenants" ], - "summary" : "Deletes a user", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "removeUser", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The revision is used to verify the client is working with the latest version of the flow.", - "required" : false, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The user id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/UserEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /tenants" : [ ] - } ] - } - }, - "/versions/active-requests" : { - "post" : { - "tags" : [ "versions" ], - "summary" : "Create a version control request", - "description" : "Creates a request so that a Process Group can be placed under Version Control or have its Version Control configuration changed. Creating this request will prevent any other threads from simultaneously saving local changes to Version Control. It will not, however, actually save the local flow to the Flow Registry. A POST to /versions/process-groups/{id} should be used to initiate saving of the local flow to the Flow Registry. Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "createVersionControlRequest", - "consumes" : [ "application/json" ], - "produces" : [ "text/plain" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The versioned flow details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/CreateActiveRequestEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/versions/active-requests/{id}" : { - "put" : { - "tags" : [ "versions" ], - "summary" : "Updates the request with the given ID", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "updateVersionControlRequest", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The request ID.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The version control component mapping.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/VersionControlComponentMappingEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionControlInformationEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Only the user that submitted the request can update it" : [ ] - } ] - }, - "delete" : { - "tags" : [ "versions" ], - "summary" : "Deletes the version control request with the given ID", - "description" : "Deletes the Version Control Request with the given ID. This will allow other threads to save flows to the Flow Registry. See also the documentation for POSTing to /versions/active-requests for information regarding why this is done. Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "deleteVersionControlRequest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The request ID.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Only the user that submitted the request can remove it" : [ ] - } ] - } - }, - "/versions/process-groups/{id}" : { - "get" : { - "tags" : [ "versions" ], - "summary" : "Gets the Version Control information for a process group", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getVersionInformation", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionControlInformationEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - } ] - }, - "post" : { - "tags" : [ "versions" ], - "summary" : "Save the Process Group with the given ID", - "description" : "Begins version controlling the Process Group with the given ID or commits changes to the Versioned Flow, depending on if the provided VersionControlInformation includes a flowId. Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "saveToFlowRegistry", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The versioned flow details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/StartVersionControlRequestEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionControlInformationEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - }, { - "Write - /process-groups/{uuid}" : [ ] - }, { - "Read - /{component-type}/{uuid} - For all encapsulated components" : [ ] - }, { - "Read - any referenced Controller Services by any encapsulated components - /controller-services/{uuid}" : [ ] - } ] - }, - "put" : { - "tags" : [ "versions" ], - "summary" : "Update the version of a Process Group with the given ID", - "description" : "For a Process Group that is already under Version Control, this will update the version of the flow to a different version. This endpoint expects that the given snapshot will not modify any Processor that is currently running or any Controller Service that is enabled. Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "updateFlowVersion", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The controller service configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/VersionedFlowSnapshotEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionControlInformationEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - }, { - "Write - /process-groups/{uuid}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "versions" ], - "summary" : "Stops version controlling the Process Group with the given ID", - "description" : "Stops version controlling the Process Group with the given ID. The Process Group will no longer track to any Versioned Flow. Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "stopVersionControl", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The version is used to verify the client is working with the latest version of the flow.", - "required" : false, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, a new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionControlInformationEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - }, { - "Write - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/versions/revert-requests/process-groups/{id}" : { - "post" : { - "tags" : [ "versions" ], - "summary" : "Initiate the Revert Request of a Process Group with the given ID", - "description" : "For a Process Group that is already under Version Control, this will initiate the action of reverting any local changes that have been made to the Process Group since it was last synchronized with the Flow Registry. This will result in the flow matching the Versioned Flow that exists in the Flow Registry. This can be a lengthy process, as it will stop any Processors and disable any Controller Services necessary to perform the action and then restart them. As a result, the endpoint will immediately return a VersionedFlowUpdateRequestEntity, and the process of updating the flow will occur asynchronously in the background. The client may then periodically poll the status of the request by issuing a GET request to /versions/revert-requests/{requestId}. Once the request is completed, the client is expected to issue a DELETE request to /versions/revert-requests/{requestId}. Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "initiateRevertFlowVersion", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The controller service configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/VersionControlInformationEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlowUpdateRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - }, { - "Write - /process-groups/{uuid}" : [ ] - }, { - "Read - /{component-type}/{uuid} - For all encapsulated components" : [ ] - }, { - "Write - /{component-type}/{uuid} - For all encapsulated components" : [ ] - }, { - "Write - if the template contains any restricted components - /restricted-components" : [ ] - } ] - } - }, - "/versions/revert-requests/{id}" : { - "get" : { - "tags" : [ "versions" ], - "summary" : "Returns the Revert Request with the given ID", - "description" : "Returns the Revert Request with the given ID. Once a Revert Request has been created by performing a POST to /versions/revert-requests/process-groups/{id}, that request can subsequently be retrieved via this endpoint, and the request that is fetched will contain the updated state, such as percent complete, the current state of the request, and any failures. Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getRevertRequest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The ID of the Revert Request", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlowUpdateRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Only the user that submitted the request can get it" : [ ] - } ] - }, - "delete" : { - "tags" : [ "versions" ], - "summary" : "Deletes the Revert Request with the given ID", - "description" : "Deletes the Revert Request with the given ID. After a request is created via a POST to /versions/revert-requests/process-groups/{id}, it is expected that the client will properly clean up the request by DELETE'ing it, once the Revert process has completed. If the request is deleted before the request completes, then the Revert request will finish the step that it is currently performing and then will cancel any subsequent steps. Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "deleteRevertRequest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The ID of the Revert Request", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlowUpdateRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Only the user that submitted the request can remove it" : [ ] - } ] - } - }, - "/versions/update-requests/process-groups/{id}" : { - "post" : { - "tags" : [ "versions" ], - "summary" : "Initiate the Update Request of a Process Group with the given ID", - "description" : "For a Process Group that is already under Version Control, this will initiate the action of changing from a specific version of the flow in the Flow Registry to a different version of the flow. This can be a lengthy process, as it will stop any Processors and disable any Controller Services necessary to perform the action and then restart them. As a result, the endpoint will immediately return a VersionedFlowUpdateRequestEntity, and the process of updating the flow will occur asynchronously in the background. The client may then periodically poll the status of the request by issuing a GET request to /versions/update-requests/{requestId}. Once the request is completed, the client is expected to issue a DELETE request to /versions/update-requests/{requestId}. Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "initiateVersionControlUpdate", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The controller service configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/VersionControlInformationEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlowUpdateRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - }, { - "Write - /process-groups/{uuid}" : [ ] - }, { - "Read - /{component-type}/{uuid} - For all encapsulated components" : [ ] - }, { - "Write - /{component-type}/{uuid} - For all encapsulated components" : [ ] - }, { - "Write - if the template contains any restricted components - /restricted-components" : [ ] - } ] - } - }, - "/versions/update-requests/{id}" : { - "get" : { - "tags" : [ "versions" ], - "summary" : "Returns the Update Request with the given ID", - "description" : "Returns the Update Request with the given ID. Once an Update Request has been created by performing a POST to /versions/update-requests/process-groups/{id}, that request can subsequently be retrieved via this endpoint, and the request that is fetched will contain the updated state, such as percent complete, the current state of the request, and any failures. Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getUpdateRequest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The ID of the Update Request", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlowUpdateRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Only the user that submitted the request can get it" : [ ] - } ] - }, - "delete" : { - "tags" : [ "versions" ], - "summary" : "Deletes the Update Request with the given ID", - "description" : "Deletes the Update Request with the given ID. After a request is created via a POST to /versions/update-requests/process-groups/{id}, it is expected that the client will properly clean up the request by DELETE'ing it, once the Update process has completed. If the request is deleted before the request completes, then the Update request will finish the step that it is currently performing and then will cancel any subsequent steps. Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "deleteUpdateRequest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The ID of the Update Request", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlowUpdateRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Only the user that submitted the request can remove it" : [ ] - } ] - } - } - }, - "definitions" : { - "AboutDTO" : { - "type" : "object", - "properties" : { - "title" : { - "type" : "string", - "description" : "The title to be used on the page and in the about dialog." - }, - "version" : { - "type" : "string", - "description" : "The version of this NiFi." - }, - "uri" : { - "type" : "string", - "description" : "The URI for the NiFi." - }, - "contentViewerUrl" : { - "type" : "string", - "description" : "The URL for the content viewer if configured." - }, - "timezone" : { - "type" : "string", - "description" : "The timezone of the NiFi instance.", - "readOnly" : true - }, - "buildTag" : { - "type" : "string", - "description" : "Build tag" - }, - "buildRevision" : { - "type" : "string", - "description" : "Build revision or commit hash" - }, - "buildBranch" : { - "type" : "string", - "description" : "Build branch" - }, - "buildTimestamp" : { - "type" : "string", - "description" : "Build timestamp" - } - } - }, - "AboutEntity" : { - "type" : "object", - "properties" : { - "about" : { - "$ref" : "#/definitions/AboutDTO" - } - }, - "xml" : { - "name" : "aboutEntity" - } - }, - "AccessConfigurationDTO" : { - "type" : "object", - "properties" : { - "supportsLogin" : { - "type" : "boolean", - "description" : "Indicates whether or not this NiFi supports user login.", - "readOnly" : true - } - } - }, - "AccessConfigurationEntity" : { - "type" : "object", - "properties" : { - "config" : { - "$ref" : "#/definitions/AccessConfigurationDTO" - } - }, - "xml" : { - "name" : "accessConfigurationEntity" - } - }, - "AccessPolicyDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "versionedComponentId" : { - "type" : "string", - "description" : "The ID of the corresponding component that is under version control" - }, - "parentGroupId" : { - "type" : "string", - "description" : "The id of parent process group of this component if applicable." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "resource" : { - "type" : "string", - "description" : "The resource for this access policy." - }, - "action" : { - "type" : "string", - "description" : "The action associated with this access policy.", - "enum" : [ "read", "write" ] - }, - "componentReference" : { - "description" : "Component this policy references if applicable.", - "$ref" : "#/definitions/ComponentReferenceEntity" - }, - "configurable" : { - "type" : "boolean", - "description" : "Whether this policy is configurable." - }, - "users" : { - "type" : "array", - "description" : "The set of user IDs associated with this access policy.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/TenantEntity" - } - }, - "userGroups" : { - "type" : "array", - "description" : "The set of user group IDs associated with this access policy.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/TenantEntity" - } - } - } - }, - "AccessPolicyEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "generated" : { - "type" : "string", - "description" : "When this content was generated." - }, - "component" : { - "$ref" : "#/definitions/AccessPolicyDTO" - } - }, - "xml" : { - "name" : "accessPolicyEntity" - } - }, - "AccessPolicySummaryDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "versionedComponentId" : { - "type" : "string", - "description" : "The ID of the corresponding component that is under version control" - }, - "parentGroupId" : { - "type" : "string", - "description" : "The id of parent process group of this component if applicable." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "resource" : { - "type" : "string", - "description" : "The resource for this access policy." - }, - "action" : { - "type" : "string", - "description" : "The action associated with this access policy.", - "enum" : [ "read", "write" ] - }, - "componentReference" : { - "description" : "Component this policy references if applicable.", - "$ref" : "#/definitions/ComponentReferenceEntity" - }, - "configurable" : { - "type" : "boolean", - "description" : "Whether this policy is configurable." - } - } - }, - "AccessPolicySummaryEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "component" : { - "$ref" : "#/definitions/AccessPolicySummaryDTO" - } - }, - "xml" : { - "name" : "accessPolicySummaryEntity" - } - }, - "AccessStatusDTO" : { - "type" : "object", - "properties" : { - "identity" : { - "type" : "string", - "description" : "The user identity.", - "readOnly" : true - }, - "status" : { - "type" : "string", - "description" : "The user access status.", - "readOnly" : true - }, - "message" : { - "type" : "string", - "description" : "Additional details about the user access status.", - "readOnly" : true - } - }, - "xml" : { - "name" : "accessStatus" - } - }, - "AccessStatusEntity" : { - "type" : "object", - "properties" : { - "accessStatus" : { - "$ref" : "#/definitions/AccessStatusDTO" - } - }, - "xml" : { - "name" : "accessStatusEntity" - } - }, - "ActionDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "integer", - "format" : "int32", - "description" : "The action id." - }, - "userIdentity" : { - "type" : "string", - "description" : "The identity of the user that performed the action." - }, - "timestamp" : { - "type" : "string", - "description" : "The timestamp of the action." - }, - "sourceId" : { - "type" : "string", - "description" : "The id of the source component." - }, - "sourceName" : { - "type" : "string", - "description" : "The name of the source component." - }, - "sourceType" : { - "type" : "string", - "description" : "The type of the source component." - }, - "componentDetails" : { - "description" : "The details of the source component.", - "$ref" : "#/definitions/ComponentDetailsDTO" - }, - "operation" : { - "type" : "string", - "description" : "The operation that was performed." - }, - "actionDetails" : { - "description" : "The details of the action.", - "$ref" : "#/definitions/ActionDetailsDTO" - } - } - }, - "ActionDetailsDTO" : { - "type" : "object" - }, - "ActionEntity" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "integer", - "format" : "int32" - }, - "timestamp" : { - "type" : "string", - "description" : "The timestamp of the action." - }, - "sourceId" : { - "type" : "string" - }, - "canRead" : { - "type" : "boolean", - "description" : "Indicates whether the user can read a given resource.", - "readOnly" : true - }, - "action" : { - "$ref" : "#/definitions/ActionDTO" - } - }, - "xml" : { - "name" : "actionEntity" - } - }, - "ActivateControllerServicesEntity" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the ProcessGroup" - }, - "state" : { - "type" : "string", - "description" : "The desired state of the descendant components", - "enum" : [ "ENABLED", "DISABLED" ] - }, - "components" : { - "type" : "object", - "description" : "Optional services to schedule. If not specified, all authorized descendant controller services will be used.", - "additionalProperties" : { - "$ref" : "#/definitions/RevisionDTO" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - } - }, - "xml" : { - "name" : "activateControllerServicesEntity" - } - }, - "AffectedComponentDTO" : { - "type" : "object", - "properties" : { - "processGroupId" : { - "type" : "string", - "description" : "The UUID of the Process Group that this component is in" - }, - "id" : { - "type" : "string", - "description" : "The UUID of this component" - }, - "referenceType" : { - "type" : "string", - "description" : "The type of this component", - "enum" : [ "PROCESSOR", "CONTROLLER_SERVICE", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT" ] - }, - "name" : { - "type" : "string", - "description" : "The name of this component." - }, - "state" : { - "type" : "string", - "description" : "The scheduled state of a processor or reporting task referencing a controller service. If this component is another controller service, this field represents the controller service state." - }, - "activeThreadCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of active threads for the referencing component." - }, - "validationErrors" : { - "type" : "array", - "description" : "The validation errors for the component.", - "items" : { - "type" : "string" - } - } - } - }, - "AffectedComponentEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "component" : { - "$ref" : "#/definitions/AffectedComponentDTO" - } - }, - "xml" : { - "name" : "affectComponentEntity" - } - }, - "AllowableValueDTO" : { - "type" : "object", - "properties" : { - "displayName" : { - "type" : "string", - "description" : "A human readable value that is allowed for the property descriptor." - }, - "value" : { - "type" : "string", - "description" : "A value that is allowed for the property descriptor." - }, - "description" : { - "type" : "string", - "description" : "A description for this allowable value." - } - } - }, - "AllowableValueEntity" : { - "type" : "object", - "properties" : { - "allowableValue" : { - "$ref" : "#/definitions/AllowableValueDTO" - }, - "canRead" : { - "type" : "boolean", - "description" : "Indicates whether the user can read a given resource.", - "readOnly" : true - } - }, - "xml" : { - "name" : "entity" - } - }, - "AttributeDTO" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The attribute name." - }, - "value" : { - "type" : "string", - "description" : "The attribute value." - }, - "previousValue" : { - "type" : "string", - "description" : "The value of the attribute before the event took place." - } - } - }, - "BannerDTO" : { - "type" : "object", - "properties" : { - "headerText" : { - "type" : "string", - "description" : "The header text." - }, - "footerText" : { - "type" : "string", - "description" : "The footer text." - } - } - }, - "BannerEntity" : { - "type" : "object", - "properties" : { - "banners" : { - "$ref" : "#/definitions/BannerDTO" - } - }, - "xml" : { - "name" : "bannersEntity" - } - }, - "BatchSettingsDTO" : { - "type" : "object", - "properties" : { - "count" : { - "type" : "integer", - "format" : "int32", - "description" : "Preferred number of flow files to include in a transaction." - }, - "size" : { - "type" : "string", - "description" : "Preferred number of bytes to include in a transaction." - }, - "duration" : { - "type" : "string", - "description" : "Preferred amount of time that a transaction should span." - } - } - }, - "BatchSize" : { - "type" : "object", - "properties" : { - "count" : { - "type" : "integer", - "format" : "int32", - "description" : "Preferred number of flow files to include in a transaction." - }, - "size" : { - "type" : "string", - "description" : "Preferred number of bytes to include in a transaction." - }, - "duration" : { - "type" : "string", - "description" : "Preferred amount of time that a transaction should span." - } - } - }, - "BucketDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The bucket identifier" - }, - "name" : { - "type" : "string", - "description" : "The bucket name" - }, - "description" : { - "type" : "string", - "description" : "The bucket description" - }, - "created" : { - "type" : "integer", - "format" : "int64", - "description" : "The created timestamp of this bucket" - } - } - }, - "BucketEntity" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string" - }, - "bucket" : { - "$ref" : "#/definitions/BucketDTO" - }, - "permissions" : { - "$ref" : "#/definitions/PermissionsDTO" - } - }, - "xml" : { - "name" : "bucketEntity" - } - }, - "BucketsEntity" : { - "type" : "object", - "properties" : { - "buckets" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/BucketEntity" - } - } - }, - "xml" : { - "name" : "bucketsEntity" - } - }, - "BulletinBoardDTO" : { - "type" : "object", - "properties" : { - "bulletins" : { - "type" : "array", - "description" : "The bulletins in the bulletin board, that matches the supplied request.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "generated" : { - "type" : "string", - "description" : "The timestamp when this report was generated." - } - } - }, - "BulletinBoardEntity" : { - "type" : "object", - "properties" : { - "bulletinBoard" : { - "$ref" : "#/definitions/BulletinBoardDTO" - } - }, - "xml" : { - "name" : "bulletinBoardEntity" - } - }, - "BulletinDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "integer", - "format" : "int64", - "description" : "The id of the bulletin." - }, - "nodeAddress" : { - "type" : "string", - "description" : "If clustered, the address of the node from which the bulletin originated." - }, - "category" : { - "type" : "string", - "description" : "The category of this bulletin." - }, - "groupId" : { - "type" : "string", - "description" : "The group id of the source component." - }, - "sourceId" : { - "type" : "string", - "description" : "The id of the source component." - }, - "sourceName" : { - "type" : "string", - "description" : "The name of the source component." - }, - "level" : { - "type" : "string", - "description" : "The level of the bulletin." - }, - "message" : { - "type" : "string", - "description" : "The bulletin message." - }, - "timestamp" : { - "type" : "string", - "description" : "When this bulletin was generated." - } - } - }, - "BulletinEntity" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "integer", - "format" : "int64" - }, - "groupId" : { - "type" : "string" - }, - "sourceId" : { - "type" : "string" - }, - "timestamp" : { - "type" : "string", - "description" : "When this bulletin was generated." - }, - "nodeAddress" : { - "type" : "string" - }, - "canRead" : { - "type" : "boolean", - "description" : "Indicates whether the user can read a given resource.", - "readOnly" : true - }, - "bulletin" : { - "$ref" : "#/definitions/BulletinDTO" - } - }, - "xml" : { - "name" : "bulletinEntity" - } - }, - "Bundle" : { - "type" : "object", - "properties" : { - "group" : { - "type" : "string", - "description" : "The group of the bundle" - }, - "artifact" : { - "type" : "string", - "description" : "The artifact of the bundle" - }, - "version" : { - "type" : "string", - "description" : "The version of the bundle" - } - } - }, - "BundleDTO" : { - "type" : "object", - "properties" : { - "group" : { - "type" : "string", - "description" : "The group of the bundle." - }, - "artifact" : { - "type" : "string", - "description" : "The artifact of the bundle." - }, - "version" : { - "type" : "string", - "description" : "The version of the bundle." - } - } - }, - "ClusteSummaryEntity" : { - "type" : "object", - "properties" : { - "clusterSummary" : { - "$ref" : "#/definitions/ClusterSummaryDTO" - } - }, - "xml" : { - "name" : "clusterSummaryEntity" - } - }, - "ClusterDTO" : { - "type" : "object", - "properties" : { - "nodes" : { - "type" : "array", - "description" : "The collection of nodes that are part of the cluster.", - "items" : { - "$ref" : "#/definitions/NodeDTO" - } - }, - "generated" : { - "type" : "string", - "description" : "The timestamp the report was generated." - } - } - }, - "ClusterEntity" : { - "type" : "object", - "properties" : { - "cluster" : { - "$ref" : "#/definitions/ClusterDTO" - } - }, - "xml" : { - "name" : "clusterEntity" - } - }, - "ClusterSearchResultsEntity" : { - "type" : "object", - "properties" : { - "nodeResults" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/NodeSearchResultDTO" - } - } - }, - "xml" : { - "name" : "clusterSearchResultsEntity" - } - }, - "ClusterSummaryDTO" : { - "type" : "object", - "properties" : { - "connectedNodes" : { - "type" : "string", - "description" : "When clustered, reports the number of nodes connected vs the number of nodes in the cluster." - }, - "connectedNodeCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of nodes that are currently connected to the cluster" - }, - "totalNodeCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of nodes in the cluster, regardless of whether or not they are connected" - }, - "clustered" : { - "type" : "boolean", - "description" : "Whether this NiFi instance is clustered." - }, - "connectedToCluster" : { - "type" : "boolean", - "description" : "Whether this NiFi instance is connected to a cluster." - } - } - }, - "ComponentDetailsDTO" : { - "type" : "object" - }, - "ComponentDifferenceDTO" : { - "type" : "object", - "properties" : { - "componentType" : { - "type" : "string", - "description" : "The type of component" - }, - "componentId" : { - "type" : "string", - "description" : "The ID of the component" - }, - "componentName" : { - "type" : "string", - "description" : "The name of the component" - }, - "processGroupId" : { - "type" : "string", - "description" : "The ID of the Process Group that the component belongs to" - }, - "differences" : { - "type" : "array", - "description" : "The differences in the component between the two flows", - "items" : { - "$ref" : "#/definitions/DifferenceDTO" - } - } - } - }, - "ComponentHistoryDTO" : { - "type" : "object", - "properties" : { - "componentId" : { - "type" : "string", - "description" : "The component id." - }, - "propertyHistory" : { - "type" : "object", - "description" : "The history for the properties of the component.", - "additionalProperties" : { - "$ref" : "#/definitions/PropertyHistoryDTO" - } - } - } - }, - "ComponentHistoryEntity" : { - "type" : "object", - "properties" : { - "componentHistory" : { - "$ref" : "#/definitions/ComponentHistoryDTO" - } - }, - "xml" : { - "name" : "componentHistoryEntity" - } - }, - "ComponentReferenceDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "versionedComponentId" : { - "type" : "string", - "description" : "The ID of the corresponding component that is under version control" - }, - "parentGroupId" : { - "type" : "string", - "description" : "The id of parent process group of this component if applicable." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "name" : { - "type" : "string", - "description" : "The name of the component." - } - } - }, - "ComponentReferenceEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "parentGroupId" : { - "type" : "string", - "description" : "The id of parent process group of this component if applicable." - }, - "component" : { - "$ref" : "#/definitions/ComponentReferenceDTO" - } - }, - "xml" : { - "name" : "componentReferenceEntity" - } - }, - "ComponentRestrictionPermissionDTO" : { - "type" : "object", - "properties" : { - "requiredPermission" : { - "description" : "The required permission necessary for this restriction.", - "$ref" : "#/definitions/RequiredPermissionDTO" - }, - "permissions" : { - "description" : "The permissions for this component restriction. Note: the read permission are not used and will always be false.", - "$ref" : "#/definitions/PermissionsDTO" - } - } - }, - "ComponentSearchResultDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component that matched the search." - }, - "groupId" : { - "type" : "string", - "description" : "The group id of the component that matched the search." - }, - "parentGroup" : { - "description" : "The parent group of the component that matched the search.", - "$ref" : "#/definitions/SearchResultGroupDTO" - }, - "versionedGroup" : { - "description" : "The nearest versioned ancestor group of the component that matched the search.", - "$ref" : "#/definitions/SearchResultGroupDTO" - }, - "name" : { - "type" : "string", - "description" : "The name of the component that matched the search." - }, - "matches" : { - "type" : "array", - "description" : "What matched the search from the component.", - "items" : { - "type" : "string" - } - } - } - }, - "ComponentStateDTO" : { - "type" : "object", - "properties" : { - "componentId" : { - "type" : "string", - "description" : "The component identifier." - }, - "stateDescription" : { - "type" : "string", - "description" : "Description of the state this component persists." - }, - "clusterState" : { - "description" : "The cluster state for this component, or null if this NiFi is a standalone instance.", - "$ref" : "#/definitions/StateMapDTO" - }, - "localState" : { - "description" : "The local state for this component.", - "$ref" : "#/definitions/StateMapDTO" - } - } - }, - "ComponentStateEntity" : { - "type" : "object", - "properties" : { - "componentState" : { - "description" : "The component state.", - "$ref" : "#/definitions/ComponentStateDTO" - } - }, - "xml" : { - "name" : "componentStateEntity" - } - }, - "ConnectableComponent" : { - "type" : "object", - "required" : [ "groupId", "id", "type" ], - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the connectable component." - }, - "type" : { - "type" : "string", - "description" : "The type of component the connectable is.", - "enum" : [ "PROCESSOR", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "INPUT_PORT", "OUTPUT_PORT", "FUNNEL" ] - }, - "groupId" : { - "type" : "string", - "description" : "The id of the group that the connectable component resides in" - }, - "name" : { - "type" : "string", - "description" : "The name of the connectable component" - }, - "comments" : { - "type" : "string", - "description" : "The comments for the connectable component." - } - } - }, - "ConnectableDTO" : { - "type" : "object", - "required" : [ "groupId", "id", "type" ], - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the connectable component." - }, - "versionedComponentId" : { - "type" : "string", - "description" : "The ID of the corresponding component that is under version control" - }, - "type" : { - "type" : "string", - "description" : "The type of component the connectable is.", - "enum" : [ "PROCESSOR", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "INPUT_PORT", "OUTPUT_PORT", "FUNNEL" ] - }, - "groupId" : { - "type" : "string", - "description" : "The id of the group that the connectable component resides in" - }, - "name" : { - "type" : "string", - "description" : "The name of the connectable component" - }, - "running" : { - "type" : "boolean", - "description" : "Reflects the current state of the connectable component." - }, - "transmitting" : { - "type" : "boolean", - "description" : "If the connectable component represents a remote port, indicates if the target is configured to transmit." - }, - "exists" : { - "type" : "boolean", - "description" : "If the connectable component represents a remote port, indicates if the target exists." - }, - "comments" : { - "type" : "string", - "description" : "The comments for the connectable component." - } - } - }, - "ConnectionDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "versionedComponentId" : { - "type" : "string", - "description" : "The ID of the corresponding component that is under version control" - }, - "parentGroupId" : { - "type" : "string", - "description" : "The id of parent process group of this component if applicable." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "source" : { - "description" : "The source of the connection.", - "$ref" : "#/definitions/ConnectableDTO" - }, - "destination" : { - "description" : "The destination of the connection.", - "$ref" : "#/definitions/ConnectableDTO" - }, - "name" : { - "type" : "string", - "description" : "The name of the connection." - }, - "labelIndex" : { - "type" : "integer", - "format" : "int32", - "description" : "The index of the bend point where to place the connection label." - }, - "getzIndex" : { - "type" : "integer", - "format" : "int64", - "description" : "The z index of the connection." - }, - "selectedRelationships" : { - "type" : "array", - "description" : "The selected relationship that comprise the connection.", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - }, - "availableRelationships" : { - "type" : "array", - "description" : "The relationships that the source of the connection currently supports.", - "readOnly" : true, - "uniqueItems" : true, - "items" : { - "type" : "string" - } - }, - "backPressureObjectThreshold" : { - "type" : "integer", - "format" : "int64", - "description" : "The object count threshold for determining when back pressure is applied. Updating this value is a passive change in the sense that it won't impact whether existing files over the limit are affected but it does help feeder processors to stop pushing too much into this work queue." - }, - "backPressureDataSizeThreshold" : { - "type" : "string", - "description" : "The object data size threshold for determining when back pressure is applied. Updating this value is a passive change in the sense that it won't impact whether existing files over the limit are affected but it does help feeder processors to stop pushing too much into this work queue." - }, - "flowFileExpiration" : { - "type" : "string", - "description" : "The amount of time a flow file may be in the flow before it will be automatically aged out of the flow. Once a flow file reaches this age it will be terminated from the flow the next time a processor attempts to start work on it." - }, - "prioritizers" : { - "type" : "array", - "description" : "The comparators used to prioritize the queue.", - "items" : { - "type" : "string" - } - }, - "bends" : { - "type" : "array", - "description" : "The bend points on the connection.", - "items" : { - "$ref" : "#/definitions/PositionDTO" - } - } - } - }, - "ConnectionEntity" : { - "type" : "object", - "required" : [ "destinationType", "sourceType" ], - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "component" : { - "$ref" : "#/definitions/ConnectionDTO" - }, - "status" : { - "description" : "The status of the connection.", - "$ref" : "#/definitions/ConnectionStatusDTO" - }, - "bends" : { - "type" : "array", - "description" : "The bend points on the connection.", - "items" : { - "$ref" : "#/definitions/PositionDTO" - } - }, - "labelIndex" : { - "type" : "integer", - "format" : "int32", - "description" : "The index of the bend point where to place the connection label." - }, - "getzIndex" : { - "type" : "integer", - "format" : "int64", - "description" : "The z index of the connection." - }, - "sourceId" : { - "type" : "string", - "description" : "The identifier of the source of this connection." - }, - "sourceGroupId" : { - "type" : "string", - "description" : "The identifier of the group of the source of this connection." - }, - "sourceType" : { - "type" : "string", - "description" : "The type of component the source connectable is.", - "enum" : [ "PROCESSOR", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "INPUT_PORT", "OUTPUT_PORT", "FUNNEL" ] - }, - "destinationId" : { - "type" : "string", - "description" : "The identifier of the destination of this connection." - }, - "destinationGroupId" : { - "type" : "string", - "description" : "The identifier of the group of the destination of this connection." - }, - "destinationType" : { - "type" : "string", - "description" : "The type of component the destination connectable is.", - "enum" : [ "PROCESSOR", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "INPUT_PORT", "OUTPUT_PORT", "FUNNEL" ] - } - }, - "xml" : { - "name" : "connectionEntity" - } - }, - "ConnectionStatusDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The ID of the connection" - }, - "groupId" : { - "type" : "string", - "description" : "The ID of the Process Group that the connection belongs to" - }, - "name" : { - "type" : "string", - "description" : "The name of the connection" - }, - "statsLastRefreshed" : { - "type" : "string", - "description" : "The timestamp of when the stats were last refreshed" - }, - "sourceId" : { - "type" : "string", - "description" : "The ID of the source component" - }, - "sourceName" : { - "type" : "string", - "description" : "The name of the source component" - }, - "destinationId" : { - "type" : "string", - "description" : "The ID of the destination component" - }, - "destinationName" : { - "type" : "string", - "description" : "The name of the destination component" - }, - "aggregateSnapshot" : { - "description" : "The status snapshot that represents the aggregate stats of the cluster", - "$ref" : "#/definitions/ConnectionStatusSnapshotDTO" - }, - "nodeSnapshots" : { - "type" : "array", - "description" : "A list of status snapshots for each node", - "items" : { - "$ref" : "#/definitions/NodeConnectionStatusSnapshotDTO" - } - } - } - }, - "ConnectionStatusEntity" : { - "type" : "object", - "properties" : { - "connectionStatus" : { - "$ref" : "#/definitions/ConnectionStatusDTO" - }, - "canRead" : { - "type" : "boolean", - "description" : "Indicates whether the user can read a given resource.", - "readOnly" : true - } - }, - "xml" : { - "name" : "connectionStatusEntity" - } - }, - "ConnectionStatusSnapshotDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the connection." - }, - "groupId" : { - "type" : "string", - "description" : "The id of the process group the connection belongs to." - }, - "name" : { - "type" : "string", - "description" : "The name of the connection." - }, - "sourceId" : { - "type" : "string", - "description" : "The id of the source of the connection." - }, - "sourceName" : { - "type" : "string", - "description" : "The name of the source of the connection." - }, - "destinationId" : { - "type" : "string", - "description" : "The id of the destination of the connection." - }, - "destinationName" : { - "type" : "string", - "description" : "The name of the destination of the connection." - }, - "flowFilesIn" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of FlowFiles that have come into the connection in the last 5 minutes." - }, - "bytesIn" : { - "type" : "integer", - "format" : "int64", - "description" : "The size of the FlowFiles that have come into the connection in the last 5 minutes." - }, - "input" : { - "type" : "string", - "description" : "The input count/size for the connection in the last 5 minutes, pretty printed." - }, - "flowFilesOut" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of FlowFiles that have left the connection in the last 5 minutes." - }, - "bytesOut" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes that have left the connection in the last 5 minutes." - }, - "output" : { - "type" : "string", - "description" : "The output count/sie for the connection in the last 5 minutes, pretty printed." - }, - "flowFilesQueued" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of FlowFiles that are currently queued in the connection." - }, - "bytesQueued" : { - "type" : "integer", - "format" : "int64", - "description" : "The size of the FlowFiles that are currently queued in the connection." - }, - "queued" : { - "type" : "string", - "description" : "The total count and size of queued flowfiles formatted." - }, - "queuedSize" : { - "type" : "string", - "description" : "The total size of flowfiles that are queued formatted." - }, - "queuedCount" : { - "type" : "string", - "description" : "The number of flowfiles that are queued, pretty printed." - }, - "percentUseCount" : { - "type" : "integer", - "format" : "int32", - "description" : "Connection percent use regarding queued flow files count and backpressure threshold if configured." - }, - "percentUseBytes" : { - "type" : "integer", - "format" : "int32", - "description" : "Connection percent use regarding queued flow files size and backpressure threshold if configured." - } - } - }, - "ConnectionStatusSnapshotEntity" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the connection." - }, - "connectionStatusSnapshot" : { - "$ref" : "#/definitions/ConnectionStatusSnapshotDTO" - }, - "canRead" : { - "type" : "boolean", - "description" : "Indicates whether the user can read a given resource.", - "readOnly" : true - } - }, - "xml" : { - "name" : "entity" - } - }, - "ConnectionsEntity" : { - "type" : "object", - "properties" : { - "connections" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ConnectionEntity" - } - } - }, - "xml" : { - "name" : "connectionsEntity" - } - }, - "ControllerBulletinsEntity" : { - "type" : "object", - "properties" : { - "bulletins" : { - "type" : "array", - "description" : "System level bulletins to be reported to the user.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "controllerServiceBulletins" : { - "type" : "array", - "description" : "Controller service bulletins to be reported to the user.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "reportingTaskBulletins" : { - "type" : "array", - "description" : "Reporting task bulletins to be reported to the user.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - } - }, - "xml" : { - "name" : "controllerConfigurationEntity" - } - }, - "ControllerConfigurationDTO" : { - "type" : "object", - "properties" : { - "maxTimerDrivenThreadCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The maximum number of timer driven threads the NiFi has available." - }, - "maxEventDrivenThreadCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The maximum number of event driven threads the NiFi has available." - } - } - }, - "ControllerConfigurationEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "component" : { - "description" : "The controller configuration.", - "$ref" : "#/definitions/ControllerConfigurationDTO" - } - }, - "xml" : { - "name" : "controllerConfigurationEntity" - } - }, - "ControllerDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the NiFi." - }, - "name" : { - "type" : "string", - "description" : "The name of the NiFi." - }, - "comments" : { - "type" : "string", - "description" : "The comments for the NiFi." - }, - "runningCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of running components in the NiFi." - }, - "stoppedCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of stopped components in the NiFi." - }, - "invalidCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of invalid components in the NiFi." - }, - "disabledCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of disabled components in the NiFi." - }, - "activeRemotePortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of active remote ports contained in the NiFi." - }, - "inactiveRemotePortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of inactive remote ports contained in the NiFi." - }, - "inputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of input ports contained in the NiFi." - }, - "outputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of output ports in the NiFi." - }, - "remoteSiteListeningPort" : { - "type" : "integer", - "format" : "int32", - "description" : "The Socket Port on which this instance is listening for Remote Transfers of Flow Files. If this instance is not configured to receive Flow Files from remote instances, this will be null." - }, - "remoteSiteHttpListeningPort" : { - "type" : "integer", - "format" : "int32", - "description" : "The HTTP(S) Port on which this instance is listening for Remote Transfers of Flow Files. If this instance is not configured to receive Flow Files from remote instances, this will be null." - }, - "siteToSiteSecure" : { - "type" : "boolean", - "description" : "Indicates whether or not Site-to-Site communications with this instance is secure (2-way authentication)." - }, - "instanceId" : { - "type" : "string", - "description" : "If clustered, the id of the Cluster Manager, otherwise the id of the NiFi." - }, - "inputPorts" : { - "type" : "array", - "description" : "The input ports available to send data to for the NiFi.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/PortDTO" - } - }, - "outputPorts" : { - "type" : "array", - "description" : "The output ports available to received data from the NiFi.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/PortDTO" - } - } - } - }, - "ControllerEntity" : { - "type" : "object", - "properties" : { - "controller" : { - "$ref" : "#/definitions/ControllerDTO" - } - }, - "xml" : { - "name" : "controllerEntity" - } - }, - "ControllerServiceAPI" : { - "type" : "object", - "properties" : { - "type" : { - "type" : "string", - "description" : "The fully qualified name of the service interface." - }, - "bundle" : { - "description" : "The details of the artifact that bundled this service interface.", - "$ref" : "#/definitions/Bundle" - } - } - }, - "ControllerServiceApiDTO" : { - "type" : "object", - "properties" : { - "type" : { - "type" : "string", - "description" : "The fully qualified name of the service interface." - }, - "bundle" : { - "description" : "The details of the artifact that bundled this service interface.", - "$ref" : "#/definitions/BundleDTO" - } - } - }, - "ControllerServiceDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "versionedComponentId" : { - "type" : "string", - "description" : "The ID of the corresponding component that is under version control" - }, - "parentGroupId" : { - "type" : "string", - "description" : "The id of parent process group of this component if applicable." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "name" : { - "type" : "string", - "description" : "The name of the controller service." - }, - "type" : { - "type" : "string", - "description" : "The type of the controller service." - }, - "bundle" : { - "description" : "The details of the artifact that bundled this processor type.", - "$ref" : "#/definitions/BundleDTO" - }, - "controllerServiceApis" : { - "type" : "array", - "description" : "Lists the APIs this Controller Service implements.", - "items" : { - "$ref" : "#/definitions/ControllerServiceApiDTO" - } - }, - "comments" : { - "type" : "string", - "description" : "The comments for the controller service." - }, - "state" : { - "type" : "string", - "description" : "The state of the controller service.", - "enum" : [ "ENABLED", "ENABLING", "DISABLED", "DISABLING" ] - }, - "persistsState" : { - "type" : "boolean", - "description" : "Whether the controller service persists state." - }, - "restricted" : { - "type" : "boolean", - "description" : "Whether the controller service requires elevated privileges." - }, - "deprecated" : { - "type" : "boolean", - "description" : "Whether the ontroller service has been deprecated." - }, - "multipleVersionsAvailable" : { - "type" : "boolean", - "description" : "Whether the controller service has multiple versions available." - }, - "properties" : { - "type" : "object", - "description" : "The properties of the controller service.", - "additionalProperties" : { - "type" : "string" - } - }, - "descriptors" : { - "type" : "object", - "description" : "The descriptors for the controller service properties.", - "additionalProperties" : { - "$ref" : "#/definitions/PropertyDescriptorDTO" - } - }, - "customUiUrl" : { - "type" : "string", - "description" : "The URL for the controller services custom configuration UI if applicable." - }, - "annotationData" : { - "type" : "string", - "description" : "The annotation for the controller service. This is how the custom UI relays configuration to the controller service." - }, - "referencingComponents" : { - "type" : "array", - "description" : "All components referencing this controller service.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ControllerServiceReferencingComponentEntity" - } - }, - "validationErrors" : { - "type" : "array", - "description" : "The validation errors from the controller service. These validation errors represent the problems with the controller service that must be resolved before it can be enabled.", - "items" : { - "type" : "string" - } - }, - "validationStatus" : { - "type" : "string", - "description" : "Indicates whether the Processor is valid, invalid, or still in the process of validating (i.e., it is unknown whether or not the Processor is valid)", - "readOnly" : true, - "enum" : [ "VALID", "INVALID", "VALIDATING" ] - }, - "extensionMissing" : { - "type" : "boolean", - "description" : "Whether the underlying extension is missing." - } - } - }, - "ControllerServiceEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "component" : { - "$ref" : "#/definitions/ControllerServiceDTO" - } - }, - "xml" : { - "name" : "controllerServiceEntity" - } - }, - "ControllerServiceReferencingComponentDTO" : { - "type" : "object", - "properties" : { - "groupId" : { - "type" : "string", - "description" : "The group id for the component referencing a controller service. If this component is another controller service or a reporting task, this field is blank." - }, - "id" : { - "type" : "string", - "description" : "The id of the component referencing a controller service." - }, - "name" : { - "type" : "string", - "description" : "The name of the component referencing a controller service." - }, - "type" : { - "type" : "string", - "description" : "The type of the component referencing a controller service." - }, - "state" : { - "type" : "string", - "description" : "The scheduled state of a processor or reporting task referencing a controller service. If this component is another controller service, this field represents the controller service state." - }, - "properties" : { - "type" : "object", - "description" : "The properties for the component.", - "additionalProperties" : { - "type" : "string" - } - }, - "descriptors" : { - "type" : "object", - "description" : "The descriptors for the component properties.", - "additionalProperties" : { - "$ref" : "#/definitions/PropertyDescriptorDTO" - } - }, - "validationErrors" : { - "type" : "array", - "description" : "The validation errors for the component.", - "items" : { - "type" : "string" - } - }, - "referenceType" : { - "type" : "string", - "description" : "The type of reference this is.", - "enum" : [ "Processor", "ControllerService", "or ReportingTask" ] - }, - "activeThreadCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of active threads for the referencing component." - }, - "referenceCycle" : { - "type" : "boolean", - "description" : "If the referencing component represents a controller service, this indicates whether it has already been represented in this hierarchy." - }, - "referencingComponents" : { - "type" : "array", - "description" : "If the referencing component represents a controller service, these are the components that reference it.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ControllerServiceReferencingComponentEntity" - } - } - } - }, - "ControllerServiceReferencingComponentEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "component" : { - "$ref" : "#/definitions/ControllerServiceReferencingComponentDTO" - } - }, - "xml" : { - "name" : "controllerServiceReferencingComponentEntity" - } - }, - "ControllerServiceReferencingComponentsEntity" : { - "type" : "object", - "properties" : { - "controllerServiceReferencingComponents" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ControllerServiceReferencingComponentEntity" - } - } - }, - "xml" : { - "name" : "controllerServiceReferencingComponentsEntity" - } - }, - "ControllerServiceTypesEntity" : { - "type" : "object", - "properties" : { - "controllerServiceTypes" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/DocumentedTypeDTO" - } - } - }, - "xml" : { - "name" : "controllerServiceTypesEntity" - } - }, - "ControllerServicesEntity" : { - "type" : "object", - "properties" : { - "currentTime" : { - "type" : "string", - "description" : "The current time on the system." - }, - "controllerServices" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ControllerServiceEntity" - } - } - }, - "xml" : { - "name" : "controllerServicesEntity" - } - }, - "ControllerStatusDTO" : { - "type" : "object", - "properties" : { - "activeThreadCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of active threads in the NiFi." - }, - "terminatedThreadCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of terminated threads in the NiFi." - }, - "queued" : { - "type" : "string", - "description" : "The number of flowfiles queued in the NiFi." - }, - "flowFilesQueued" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of FlowFiles queued across the entire flow" - }, - "bytesQueued" : { - "type" : "integer", - "format" : "int64", - "description" : "The size of the FlowFiles queued across the entire flow" - }, - "runningCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of running components in the NiFi." - }, - "stoppedCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of stopped components in the NiFi." - }, - "invalidCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of invalid components in the NiFi." - }, - "disabledCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of disabled components in the NiFi." - }, - "activeRemotePortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of active remote ports in the NiFi." - }, - "inactiveRemotePortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of inactive remote ports in the NiFi." - }, - "upToDateCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of up to date versioned process groups in the NiFi." - }, - "locallyModifiedCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of locally modified versioned process groups in the NiFi." - }, - "staleCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of stale versioned process groups in the NiFi." - }, - "locallyModifiedAndStaleCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of locally modified and stale versioned process groups in the NiFi." - }, - "syncFailureCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of versioned process groups in the NiFi that are unable to sync to a registry." - } - } - }, - "ControllerStatusEntity" : { - "type" : "object", - "properties" : { - "controllerStatus" : { - "$ref" : "#/definitions/ControllerStatusDTO" - } - }, - "xml" : { - "name" : "controllerStatusEntity" - } - }, - "CopySnippetRequestEntity" : { - "type" : "object", - "properties" : { - "snippetId" : { - "type" : "string", - "description" : "The identifier of the snippet." - }, - "originX" : { - "type" : "number", - "format" : "double", - "description" : "The x coordinate of the origin of the bounding box where the new components will be placed." - }, - "originY" : { - "type" : "number", - "format" : "double", - "description" : "The y coordinate of the origin of the bounding box where the new components will be placed." - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - } - }, - "xml" : { - "name" : "copySnippetRequestEntity" - } - }, - "CounterDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the counter." - }, - "context" : { - "type" : "string", - "description" : "The context of the counter." - }, - "name" : { - "type" : "string", - "description" : "The name of the counter." - }, - "valueCount" : { - "type" : "integer", - "format" : "int64", - "description" : "The value count." - }, - "value" : { - "type" : "string", - "description" : "The value of the counter." - } - } - }, - "CounterEntity" : { - "type" : "object", - "properties" : { - "counter" : { - "$ref" : "#/definitions/CounterDTO" - } - }, - "xml" : { - "name" : "counterEntity" - } - }, - "CountersDTO" : { - "type" : "object", - "properties" : { - "aggregateSnapshot" : { - "description" : "A Counters snapshot that represents the aggregate values of all nodes in the cluster. If the NiFi instance is a standalone instance, rather than a cluster, this represents the stats of the single instance.", - "$ref" : "#/definitions/CountersSnapshotDTO" - }, - "nodeSnapshots" : { - "type" : "array", - "description" : "A Counters snapshot for each node in the cluster. If the NiFi instance is a standalone instance, rather than a cluster, this may be null.", - "items" : { - "$ref" : "#/definitions/NodeCountersSnapshotDTO" - } - } - } - }, - "CountersEntity" : { - "type" : "object", - "properties" : { - "counters" : { - "$ref" : "#/definitions/CountersDTO" - } - }, - "xml" : { - "name" : "countersEntity" - } - }, - "CountersSnapshotDTO" : { - "type" : "object", - "properties" : { - "generated" : { - "type" : "string", - "description" : "The timestamp when the report was generated." - }, - "counters" : { - "type" : "array", - "description" : "All counters in the NiFi.", - "items" : { - "$ref" : "#/definitions/CounterDTO" - } - } - } - }, - "CreateActiveRequestEntity" : { - "type" : "object", - "properties" : { - "processGroupId" : { - "type" : "string", - "description" : "The Process Group ID that this active request will update" - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - } - }, - "xml" : { - "name" : "createActiveRequestEntity" - } - }, - "CreateTemplateRequestEntity" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The name of the template." - }, - "description" : { - "type" : "string", - "description" : "The description of the template." - }, - "snippetId" : { - "type" : "string", - "description" : "The identifier of the snippet." - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - } - }, - "xml" : { - "name" : "createTemplateRequestEntity" - } - }, - "CurrentUserEntity" : { - "type" : "object", - "properties" : { - "identity" : { - "type" : "string", - "description" : "The user identity being serialized." - }, - "anonymous" : { - "type" : "boolean", - "description" : "Whether the current user is anonymous." - }, - "provenancePermissions" : { - "description" : "Permissions for querying provenance.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "countersPermissions" : { - "description" : "Permissions for accessing counters.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "tenantsPermissions" : { - "description" : "Permissions for accessing tenants.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "controllerPermissions" : { - "description" : "Permissions for accessing the controller.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "policiesPermissions" : { - "description" : "Permissions for accessing the policies.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "systemPermissions" : { - "description" : "Permissions for accessing system.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "restrictedComponentsPermissions" : { - "description" : "Permissions for accessing restricted components. Note: the read permission are not used and will always be false.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "componentRestrictionPermissions" : { - "type" : "array", - "description" : "Permissions for specific component restrictions.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ComponentRestrictionPermissionDTO" - } - }, - "canVersionFlows" : { - "type" : "boolean", - "description" : "Whether the current user can version flows." - } - }, - "xml" : { - "name" : "currentEntity" - } - }, - "DifferenceDTO" : { - "type" : "object", - "properties" : { - "differenceType" : { - "type" : "string", - "description" : "The type of difference" - }, - "difference" : { - "type" : "string", - "description" : "Description of the difference" - } - } - }, - "DimensionsDTO" : { - "type" : "object", - "properties" : { - "width" : { - "type" : "number", - "format" : "double", - "description" : "The width of the label in pixels when at a 1:1 scale." - }, - "height" : { - "type" : "number", - "format" : "double", - "description" : "The height of the label in pixels when at a 1:1 scale." - } - } - }, - "DocumentedTypeDTO" : { - "type" : "object", - "properties" : { - "type" : { - "type" : "string", - "description" : "The fully qualified name of the type." - }, - "bundle" : { - "description" : "The details of the artifact that bundled this type.", - "$ref" : "#/definitions/BundleDTO" - }, - "controllerServiceApis" : { - "type" : "array", - "description" : "If this type represents a ControllerService, this lists the APIs it implements.", - "items" : { - "$ref" : "#/definitions/ControllerServiceApiDTO" - } - }, - "description" : { - "type" : "string", - "description" : "The description of the type." - }, - "restricted" : { - "type" : "boolean", - "description" : "Whether this type is restricted." - }, - "usageRestriction" : { - "type" : "string", - "description" : "The optional description of why the usage of this component is restricted." - }, - "explicitRestrictions" : { - "type" : "array", - "description" : "An optional collection of explicit restrictions. If specified, these explicit restrictions will be enfored.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ExplicitRestrictionDTO" - } - }, - "deprecationReason" : { - "type" : "string", - "description" : "The description of why the usage of this component is restricted." - }, - "tags" : { - "type" : "array", - "description" : "The tags associated with this type.", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - } - } - }, - "DropRequestDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id for this drop request." - }, - "uri" : { - "type" : "string", - "description" : "The URI for future requests to this drop request." - }, - "submissionTime" : { - "type" : "string", - "description" : "The timestamp when the query was submitted." - }, - "lastUpdated" : { - "type" : "string", - "description" : "The last time this drop request was updated." - }, - "percentCompleted" : { - "type" : "integer", - "format" : "int32", - "description" : "The current percent complete." - }, - "finished" : { - "type" : "boolean", - "description" : "Whether the query has finished." - }, - "failureReason" : { - "type" : "string", - "description" : "The reason, if any, that this drop request failed." - }, - "currentCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of flow files currently queued." - }, - "currentSize" : { - "type" : "integer", - "format" : "int64", - "description" : "The size of flow files currently queued in bytes." - }, - "current" : { - "type" : "string", - "description" : "The count and size of flow files currently queued." - }, - "originalCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of flow files to be dropped as a result of this request." - }, - "originalSize" : { - "type" : "integer", - "format" : "int64", - "description" : "The size of flow files to be dropped as a result of this request in bytes." - }, - "original" : { - "type" : "string", - "description" : "The count and size of flow files to be dropped as a result of this request." - }, - "droppedCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of flow files that have been dropped thus far." - }, - "droppedSize" : { - "type" : "integer", - "format" : "int64", - "description" : "The size of flow files that have been dropped thus far in bytes." - }, - "dropped" : { - "type" : "string", - "description" : "The count and size of flow files that have been dropped thus far." - }, - "state" : { - "type" : "string", - "description" : "The current state of the drop request." - } - } - }, - "DropRequestEntity" : { - "type" : "object", - "properties" : { - "dropRequest" : { - "$ref" : "#/definitions/DropRequestDTO" - } - }, - "xml" : { - "name" : "dropRequestEntity" - } - }, - "ExplicitRestrictionDTO" : { - "type" : "object", - "properties" : { - "requiredPermission" : { - "description" : "The required permission necessary for this restriction.", - "$ref" : "#/definitions/RequiredPermissionDTO" - }, - "explanation" : { - "type" : "string", - "description" : "The description of why the usage of this component is restricted for this required permission." - } - } - }, - "FlowBreadcrumbDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the group." - }, - "name" : { - "type" : "string", - "description" : "The id of the group." - }, - "versionControlInformation" : { - "description" : "The process group version control information or null if not version controlled.", - "$ref" : "#/definitions/VersionControlInformationDTO" - } - } - }, - "FlowBreadcrumbEntity" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of this ancestor ProcessGroup." - }, - "permissions" : { - "description" : "The permissions for this ancestor ProcessGroup.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "versionedFlowState" : { - "type" : "string", - "description" : "The current state of the Process Group, as it relates to the Versioned Flow", - "readOnly" : true, - "enum" : [ "LOCALLY_MODIFIED", "STALE", "LOCALLY_MODIFIED_AND_STALE", "UP_TO_DATE", "SYNC_FAILURE" ] - }, - "breadcrumb" : { - "description" : "This breadcrumb.", - "$ref" : "#/definitions/FlowBreadcrumbDTO" - }, - "parentBreadcrumb" : { - "description" : "The parent breadcrumb for this breadcrumb.", - "$ref" : "#/definitions/FlowBreadcrumbEntity" - } - }, - "xml" : { - "name" : "flowEntity" - } - }, - "FlowComparisonEntity" : { - "type" : "object", - "properties" : { - "componentDifferences" : { - "type" : "array", - "description" : "The list of differences for each component in the flow that is not the same between the two flows", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ComponentDifferenceDTO" - } - } - }, - "xml" : { - "name" : "flowComparisonEntity" - } - }, - "FlowConfigurationDTO" : { - "type" : "object", - "properties" : { - "supportsManagedAuthorizer" : { - "type" : "boolean", - "description" : "Whether this NiFi supports a managed authorizer. Managed authorizers can visualize users, groups, and policies in the UI.", - "readOnly" : true - }, - "supportsConfigurableAuthorizer" : { - "type" : "boolean", - "description" : "Whether this NiFi supports a configurable authorizer.", - "readOnly" : true - }, - "supportsConfigurableUsersAndGroups" : { - "type" : "boolean", - "description" : "Whether this NiFi supports configurable users and groups.", - "readOnly" : true - }, - "autoRefreshIntervalSeconds" : { - "type" : "integer", - "format" : "int64", - "description" : "The interval in seconds between the automatic NiFi refresh requests.", - "readOnly" : true - }, - "currentTime" : { - "type" : "string", - "description" : "The current time on the system." - }, - "timeOffset" : { - "type" : "integer", - "format" : "int32", - "description" : "The time offset of the system." - }, - "defaultBackPressureObjectThreshold" : { - "type" : "integer", - "format" : "int64", - "description" : "The default back pressure object threshold." - }, - "defaultBackPressureDataSizeThreshold" : { - "type" : "string", - "description" : "The default back pressure data size threshold." - } - } - }, - "FlowConfigurationEntity" : { - "type" : "object", - "properties" : { - "flowConfiguration" : { - "description" : "The controller configuration.", - "$ref" : "#/definitions/FlowConfigurationDTO" - } - }, - "xml" : { - "name" : "flowConfigurationEntity" - } - }, - "FlowDTO" : { - "type" : "object", - "properties" : { - "processGroups" : { - "type" : "array", - "description" : "The process groups in this flow.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ProcessGroupEntity" - } - }, - "remoteProcessGroups" : { - "type" : "array", - "description" : "The remote process groups in this flow.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/RemoteProcessGroupEntity" - } - }, - "processors" : { - "type" : "array", - "description" : "The processors in this flow.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ProcessorEntity" - } - }, - "inputPorts" : { - "type" : "array", - "description" : "The input ports in this flow.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/PortEntity" - } - }, - "outputPorts" : { - "type" : "array", - "description" : "The output ports in this flow.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/PortEntity" - } - }, - "connections" : { - "type" : "array", - "description" : "The connections in this flow.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ConnectionEntity" - } - }, - "labels" : { - "type" : "array", - "description" : "The labels in this flow.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/LabelEntity" - } - }, - "funnels" : { - "type" : "array", - "description" : "The funnels in this flow.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/FunnelEntity" - } - } - } - }, - "FlowEntity" : { - "type" : "object", - "properties" : { - "flow" : { - "$ref" : "#/definitions/FlowDTO" - } - }, - "xml" : { - "name" : "flowEntity" - } - }, - "FlowFileDTO" : { - "type" : "object", - "properties" : { - "uri" : { - "type" : "string", - "description" : "The URI that can be used to access this FlowFile." - }, - "uuid" : { - "type" : "string", - "description" : "The FlowFile UUID." - }, - "filename" : { - "type" : "string", - "description" : "The FlowFile filename." - }, - "position" : { - "type" : "integer", - "format" : "int32", - "description" : "The FlowFile's position in the queue." - }, - "size" : { - "type" : "integer", - "format" : "int64", - "description" : "The FlowFile file size." - }, - "queuedDuration" : { - "type" : "integer", - "format" : "int64", - "description" : "How long this FlowFile has been enqueued." - }, - "lineageDuration" : { - "type" : "integer", - "format" : "int64", - "description" : "Duration since the FlowFile's greatest ancestor entered the flow." - }, - "clusterNodeId" : { - "type" : "string", - "description" : "The id of the node where this FlowFile resides." - }, - "clusterNodeAddress" : { - "type" : "string", - "description" : "The label for the node where this FlowFile resides." - }, - "attributes" : { - "type" : "object", - "description" : "The FlowFile attributes.", - "additionalProperties" : { - "type" : "string" - } - }, - "contentClaimSection" : { - "type" : "string", - "description" : "The section in which the content claim lives." - }, - "contentClaimContainer" : { - "type" : "string", - "description" : "The container in which the content claim lives." - }, - "contentClaimIdentifier" : { - "type" : "string", - "description" : "The identifier of the content claim." - }, - "contentClaimOffset" : { - "type" : "integer", - "format" : "int64", - "description" : "The offset into the content claim where the flowfile's content begins." - }, - "contentClaimFileSize" : { - "type" : "string", - "description" : "The file size of the content claim formatted." - }, - "contentClaimFileSizeBytes" : { - "type" : "integer", - "format" : "int64", - "description" : "The file size of the content claim in bytes." - }, - "penalized" : { - "type" : "boolean", - "description" : "If the FlowFile is penalized." - } - } - }, - "FlowFileEntity" : { - "type" : "object", - "properties" : { - "flowFile" : { - "$ref" : "#/definitions/FlowFileDTO" - } - }, - "xml" : { - "name" : "flowFileEntity" - } - }, - "FlowFileSummaryDTO" : { - "type" : "object", - "properties" : { - "uri" : { - "type" : "string", - "description" : "The URI that can be used to access this FlowFile." - }, - "uuid" : { - "type" : "string", - "description" : "The FlowFile UUID." - }, - "filename" : { - "type" : "string", - "description" : "The FlowFile filename." - }, - "position" : { - "type" : "integer", - "format" : "int32", - "description" : "The FlowFile's position in the queue." - }, - "size" : { - "type" : "integer", - "format" : "int64", - "description" : "The FlowFile file size." - }, - "queuedDuration" : { - "type" : "integer", - "format" : "int64", - "description" : "How long this FlowFile has been enqueued." - }, - "lineageDuration" : { - "type" : "integer", - "format" : "int64", - "description" : "Duration since the FlowFile's greatest ancestor entered the flow." - }, - "clusterNodeId" : { - "type" : "string", - "description" : "The id of the node where this FlowFile resides." - }, - "clusterNodeAddress" : { - "type" : "string", - "description" : "The label for the node where this FlowFile resides." - }, - "penalized" : { - "type" : "boolean", - "description" : "If the FlowFile is penalized." - } - } - }, - "FlowSnippetDTO" : { - "type" : "object", - "properties" : { - "processGroups" : { - "type" : "array", - "description" : "The process groups in this flow snippet.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ProcessGroupDTO" - } - }, - "remoteProcessGroups" : { - "type" : "array", - "description" : "The remote process groups in this flow snippet.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/RemoteProcessGroupDTO" - } - }, - "processors" : { - "type" : "array", - "description" : "The processors in this flow snippet.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ProcessorDTO" - } - }, - "inputPorts" : { - "type" : "array", - "description" : "The input ports in this flow snippet.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/PortDTO" - } - }, - "outputPorts" : { - "type" : "array", - "description" : "The output ports in this flow snippet.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/PortDTO" - } - }, - "connections" : { - "type" : "array", - "description" : "The connections in this flow snippet.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ConnectionDTO" - } - }, - "labels" : { - "type" : "array", - "description" : "The labels in this flow snippet.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/LabelDTO" - } - }, - "funnels" : { - "type" : "array", - "description" : "The funnels in this flow snippet.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/FunnelDTO" - } - }, - "controllerServices" : { - "type" : "array", - "description" : "The controller services in this flow snippet.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ControllerServiceDTO" - } - } - } - }, - "FunnelDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "versionedComponentId" : { - "type" : "string", - "description" : "The ID of the corresponding component that is under version control" - }, - "parentGroupId" : { - "type" : "string", - "description" : "The id of parent process group of this component if applicable." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - } - } - }, - "FunnelEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "component" : { - "$ref" : "#/definitions/FunnelDTO" - } - }, - "xml" : { - "name" : "funnelEntity" - } - }, - "FunnelsEntity" : { - "type" : "object", - "properties" : { - "funnels" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/FunnelEntity" - } - } - }, - "xml" : { - "name" : "funnelsEntity" - } - }, - "GarbageCollectionDTO" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The name of the garbage collector." - }, - "collectionCount" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of times garbage collection has run." - }, - "collectionTime" : { - "type" : "string", - "description" : "The total amount of time spent garbage collecting." - }, - "collectionMillis" : { - "type" : "integer", - "format" : "int64", - "description" : "The total number of milliseconds spent garbage collecting." - } - } - }, - "HistoryDTO" : { - "type" : "object", - "properties" : { - "total" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of number of actions that matched the search criteria.." - }, - "lastRefreshed" : { - "type" : "string", - "description" : "The timestamp when the report was generated." - }, - "actions" : { - "type" : "array", - "description" : "The actions.", - "items" : { - "$ref" : "#/definitions/ActionEntity" - } - } - } - }, - "HistoryEntity" : { - "type" : "object", - "properties" : { - "history" : { - "$ref" : "#/definitions/HistoryDTO" - } - }, - "xml" : { - "name" : "historyEntity" - } - }, - "InputPortsEntity" : { - "type" : "object", - "properties" : { - "inputPorts" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/PortEntity" - } - } - }, - "xml" : { - "name" : "inputPortsEntity" - } - }, - "InstantiateTemplateRequestEntity" : { - "type" : "object", - "properties" : { - "originX" : { - "type" : "number", - "format" : "double", - "description" : "The x coordinate of the origin of the bounding box where the new components will be placed." - }, - "originY" : { - "type" : "number", - "format" : "double", - "description" : "The y coordinate of the origin of the bounding box where the new components will be placed." - }, - "templateId" : { - "type" : "string", - "description" : "The identifier of the template." - }, - "encodingVersion" : { - "type" : "string", - "description" : "The encoding version of the flow snippet. If not specified, this is automatically populated by the node receiving the user request. If the snippet is specified, the version will be the latest. If the snippet is not specified, the version will come from the underlying template. These details need to be replicated throughout the cluster to ensure consistency." - }, - "snippet" : { - "description" : "A flow snippet of the template contents. If not specified, this is automatically populated by the node receiving the user request. These details need to be replicated throughout the cluster to ensure consistency.", - "$ref" : "#/definitions/FlowSnippetDTO" - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - } - }, - "xml" : { - "name" : "instantiateTemplateRequestEntity" - } - }, - "LabelDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "versionedComponentId" : { - "type" : "string", - "description" : "The ID of the corresponding component that is under version control" - }, - "parentGroupId" : { - "type" : "string", - "description" : "The id of parent process group of this component if applicable." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "label" : { - "type" : "string", - "description" : "The text that appears in the label." - }, - "width" : { - "type" : "number", - "format" : "double", - "description" : "The width of the label in pixels when at a 1:1 scale." - }, - "height" : { - "type" : "number", - "format" : "double", - "description" : "The height of the label in pixels when at a 1:1 scale." - }, - "style" : { - "type" : "object", - "description" : "The styles for this label (font-size : 12px, background-color : #eee, etc).", - "additionalProperties" : { - "type" : "string" - } - } - } - }, - "LabelEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "dimensions" : { - "$ref" : "#/definitions/DimensionsDTO" - }, - "component" : { - "$ref" : "#/definitions/LabelDTO" - } - }, - "xml" : { - "name" : "labelEntity" - } - }, - "LabelsEntity" : { - "type" : "object", - "properties" : { - "labels" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/LabelEntity" - } - } - }, - "xml" : { - "name" : "labelsEntity" - } - }, - "LineageDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of this lineage query." - }, - "uri" : { - "type" : "string", - "description" : "The URI for this lineage query for later retrieval and deletion." - }, - "submissionTime" : { - "type" : "string", - "description" : "When the lineage query was submitted." - }, - "expiration" : { - "type" : "string", - "description" : "When the lineage query will expire." - }, - "percentCompleted" : { - "type" : "integer", - "format" : "int32", - "description" : "The percent complete for the lineage query." - }, - "finished" : { - "type" : "boolean", - "description" : "Whether the lineage query has finished." - }, - "request" : { - "description" : "The initial lineage result.", - "$ref" : "#/definitions/LineageRequestDTO" - }, - "results" : { - "description" : "The results of the lineage query.", - "$ref" : "#/definitions/LineageResultsDTO" - } - } - }, - "LineageEntity" : { - "type" : "object", - "properties" : { - "lineage" : { - "$ref" : "#/definitions/LineageDTO" - } - }, - "xml" : { - "name" : "lineageEntity" - } - }, - "LineageRequestDTO" : { - "type" : "object", - "properties" : { - "eventId" : { - "type" : "integer", - "format" : "int64", - "description" : "The event id that was used to generate this lineage, if applicable. The event id is allowed for any type of lineageRequestType. If the lineageRequestType is FLOWFILE and the flowfile uuid is also included in the request, the event id will be ignored." - }, - "lineageRequestType" : { - "type" : "string", - "description" : "The type of lineage request. PARENTS will return the lineage for the flowfiles that are parents of the specified event. CHILDREN will return the lineage for the flowfiles that are children of the specified event. FLOWFILE will return the lineage for the specified flowfile.", - "enum" : [ "PARENTS", "CHILDREN", "and FLOWFILE" ] - }, - "uuid" : { - "type" : "string", - "description" : "The flowfile uuid that was used to generate the lineage. The flowfile uuid is only allowed when the lineageRequestType is FLOWFILE and will take precedence over event id." - }, - "clusterNodeId" : { - "type" : "string", - "description" : "The id of the node where this lineage originated if clustered." - } - } - }, - "LineageResultsDTO" : { - "type" : "object", - "properties" : { - "errors" : { - "type" : "array", - "description" : "Any errors that occurred while generating the lineage.", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - }, - "nodes" : { - "type" : "array", - "description" : "The nodes in the lineage.", - "items" : { - "$ref" : "#/definitions/ProvenanceNodeDTO" - } - }, - "links" : { - "type" : "array", - "description" : "The links between the nodes in the lineage.", - "items" : { - "$ref" : "#/definitions/ProvenanceLinkDTO" - } - } - } - }, - "Link" : { - "type" : "object", - "properties" : { - "type" : { - "type" : "string" - }, - "params" : { - "type" : "object", - "additionalProperties" : { - "type" : "string" - } - }, - "title" : { - "type" : "string" - }, - "rels" : { - "type" : "array", - "items" : { - "type" : "string" - } - }, - "uriBuilder" : { - "$ref" : "#/definitions/UriBuilder" - }, - "rel" : { - "type" : "string" - }, - "uri" : { - "type" : "string", - "format" : "uri" - } - } - }, - "ListingRequestDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id for this listing request." - }, - "uri" : { - "type" : "string", - "description" : "The URI for future requests to this listing request." - }, - "submissionTime" : { - "type" : "string", - "description" : "The timestamp when the query was submitted." - }, - "lastUpdated" : { - "type" : "string", - "description" : "The last time this listing request was updated." - }, - "percentCompleted" : { - "type" : "integer", - "format" : "int32", - "description" : "The current percent complete." - }, - "finished" : { - "type" : "boolean", - "description" : "Whether the query has finished." - }, - "failureReason" : { - "type" : "string", - "description" : "The reason, if any, that this listing request failed." - }, - "maxResults" : { - "type" : "integer", - "format" : "int32", - "description" : "The maximum number of FlowFileSummary objects to return" - }, - "state" : { - "type" : "string", - "description" : "The current state of the listing request." - }, - "queueSize" : { - "description" : "The size of the queue", - "$ref" : "#/definitions/QueueSizeDTO" - }, - "flowFileSummaries" : { - "type" : "array", - "description" : "The FlowFile summaries. The summaries will be populated once the request has completed.", - "items" : { - "$ref" : "#/definitions/FlowFileSummaryDTO" - } - }, - "sourceRunning" : { - "type" : "boolean", - "description" : "Whether the source of the connection is running" - }, - "destinationRunning" : { - "type" : "boolean", - "description" : "Whether the destination of the connection is running" - } - } - }, - "ListingRequestEntity" : { - "type" : "object", - "properties" : { - "listingRequest" : { - "$ref" : "#/definitions/ListingRequestDTO" - } - }, - "xml" : { - "name" : "listingRequestEntity" - } - }, - "NodeConnectionStatusSnapshotDTO" : { - "type" : "object", - "properties" : { - "nodeId" : { - "type" : "string", - "description" : "The unique ID that identifies the node" - }, - "address" : { - "type" : "string", - "description" : "The API address of the node" - }, - "apiPort" : { - "type" : "integer", - "format" : "int32", - "description" : "The API port used to communicate with the node" - }, - "statusSnapshot" : { - "description" : "The connection status snapshot from the node.", - "$ref" : "#/definitions/ConnectionStatusSnapshotDTO" - } - } - }, - "NodeCountersSnapshotDTO" : { - "type" : "object", - "properties" : { - "nodeId" : { - "type" : "string", - "description" : "The unique ID that identifies the node" - }, - "address" : { - "type" : "string", - "description" : "The API address of the node" - }, - "apiPort" : { - "type" : "integer", - "format" : "int32", - "description" : "The API port used to communicate with the node" - }, - "snapshot" : { - "description" : "The counters from the node.", - "$ref" : "#/definitions/CountersSnapshotDTO" - } - } - }, - "NodeDTO" : { - "type" : "object", - "properties" : { - "nodeId" : { - "type" : "string", - "description" : "The id of the node.", - "readOnly" : true - }, - "address" : { - "type" : "string", - "description" : "The node's host/ip address.", - "readOnly" : true - }, - "apiPort" : { - "type" : "integer", - "format" : "int32", - "description" : "The port the node is listening for API requests.", - "readOnly" : true - }, - "status" : { - "type" : "string", - "description" : "The node's status." - }, - "heartbeat" : { - "type" : "string", - "description" : "the time of the nodes's last heartbeat.", - "readOnly" : true - }, - "connectionRequested" : { - "type" : "string", - "description" : "The time of the node's last connection request.", - "readOnly" : true - }, - "roles" : { - "type" : "array", - "description" : "The roles of this node.", - "readOnly" : true, - "uniqueItems" : true, - "items" : { - "type" : "string" - } - }, - "activeThreadCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The active threads for the NiFi on the node.", - "readOnly" : true - }, - "queued" : { - "type" : "string", - "description" : "The queue the NiFi on the node.", - "readOnly" : true - }, - "events" : { - "type" : "array", - "description" : "The node's events.", - "readOnly" : true, - "items" : { - "$ref" : "#/definitions/NodeEventDTO" - } - }, - "nodeStartTime" : { - "type" : "string", - "description" : "The time at which this Node was last refreshed.", - "readOnly" : true - } - } - }, - "NodeEntity" : { - "type" : "object", - "properties" : { - "node" : { - "$ref" : "#/definitions/NodeDTO" - } - }, - "xml" : { - "name" : "nodeEntity" - } - }, - "NodeEventDTO" : { - "type" : "object", - "properties" : { - "timestamp" : { - "type" : "string", - "description" : "The timestamp of the node event." - }, - "category" : { - "type" : "string", - "description" : "The category of the node event." - }, - "message" : { - "type" : "string", - "description" : "The message in the node event." - } - } - }, - "NodePortStatusSnapshotDTO" : { - "type" : "object", - "properties" : { - "nodeId" : { - "type" : "string", - "description" : "The unique ID that identifies the node" - }, - "address" : { - "type" : "string", - "description" : "The API address of the node" - }, - "apiPort" : { - "type" : "integer", - "format" : "int32", - "description" : "The API port used to communicate with the node" - }, - "statusSnapshot" : { - "description" : "The port status snapshot from the node.", - "$ref" : "#/definitions/PortStatusSnapshotDTO" - } - } - }, - "NodeProcessGroupStatusSnapshotDTO" : { - "type" : "object", - "properties" : { - "nodeId" : { - "type" : "string", - "description" : "The unique ID that identifies the node" - }, - "address" : { - "type" : "string", - "description" : "The API address of the node" - }, - "apiPort" : { - "type" : "integer", - "format" : "int32", - "description" : "The API port used to communicate with the node" - }, - "statusSnapshot" : { - "description" : "The process group status snapshot from the node.", - "$ref" : "#/definitions/ProcessGroupStatusSnapshotDTO" - } - } - }, - "NodeProcessorStatusSnapshotDTO" : { - "type" : "object", - "properties" : { - "nodeId" : { - "type" : "string", - "description" : "The unique ID that identifies the node" - }, - "address" : { - "type" : "string", - "description" : "The API address of the node" - }, - "apiPort" : { - "type" : "integer", - "format" : "int32", - "description" : "The API port used to communicate with the node" - }, - "statusSnapshot" : { - "description" : "The processor status snapshot from the node.", - "$ref" : "#/definitions/ProcessorStatusSnapshotDTO" - } - } - }, - "NodeRemoteProcessGroupStatusSnapshotDTO" : { - "type" : "object", - "properties" : { - "nodeId" : { - "type" : "string", - "description" : "The unique ID that identifies the node" - }, - "address" : { - "type" : "string", - "description" : "The API address of the node" - }, - "apiPort" : { - "type" : "integer", - "format" : "int32", - "description" : "The API port used to communicate with the node" - }, - "statusSnapshot" : { - "description" : "The remote process group status snapshot from the node.", - "$ref" : "#/definitions/RemoteProcessGroupStatusSnapshotDTO" - } - } - }, - "NodeSearchResultDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the node that matched the search." - }, - "address" : { - "type" : "string", - "description" : "The address of the node that matched the search." - } - } - }, - "NodeStatusSnapshotsDTO" : { - "type" : "object", - "properties" : { - "nodeId" : { - "type" : "string", - "description" : "The id of the node." - }, - "address" : { - "type" : "string", - "description" : "The node's host/ip address." - }, - "apiPort" : { - "type" : "integer", - "format" : "int32", - "description" : "The port the node is listening for API requests." - }, - "statusSnapshots" : { - "type" : "array", - "description" : "A list of StatusSnapshotDTO objects that provide the actual metric values for the component for this node.", - "items" : { - "$ref" : "#/definitions/StatusSnapshotDTO" - } - } - } - }, - "NodeSystemDiagnosticsSnapshotDTO" : { - "type" : "object", - "properties" : { - "nodeId" : { - "type" : "string", - "description" : "The unique ID that identifies the node" - }, - "address" : { - "type" : "string", - "description" : "The API address of the node" - }, - "apiPort" : { - "type" : "integer", - "format" : "int32", - "description" : "The API port used to communicate with the node" - }, - "snapshot" : { - "description" : "The System Diagnostics snapshot from the node.", - "$ref" : "#/definitions/SystemDiagnosticsSnapshotDTO" - } - } - }, - "OutputPortsEntity" : { - "type" : "object", - "properties" : { - "outputPorts" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/PortEntity" - } - } - }, - "xml" : { - "name" : "outputPortsEntity" - } - }, - "PeerDTO" : { - "type" : "object", - "properties" : { - "hostname" : { - "type" : "string", - "description" : "The hostname of this peer." - }, - "port" : { - "type" : "integer", - "format" : "int32", - "description" : "The port number of this peer." - }, - "secure" : { - "type" : "boolean", - "description" : "Returns if this peer connection is secure." - }, - "flowFileCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of flowFiles this peer holds." - } - } - }, - "PeersEntity" : { - "type" : "object", - "properties" : { - "peers" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/PeerDTO" - } - } - }, - "xml" : { - "name" : "peersEntity" - } - }, - "PermissionsDTO" : { - "type" : "object", - "properties" : { - "canRead" : { - "type" : "boolean", - "description" : "Indicates whether the user can read a given resource.", - "readOnly" : true - }, - "canWrite" : { - "type" : "boolean", - "description" : "Indicates whether the user can write a given resource.", - "readOnly" : true - } - } - }, - "PortDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "versionedComponentId" : { - "type" : "string", - "description" : "The ID of the corresponding component that is under version control" - }, - "parentGroupId" : { - "type" : "string", - "description" : "The id of parent process group of this component if applicable." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "name" : { - "type" : "string", - "description" : "The name of the port." - }, - "comments" : { - "type" : "string", - "description" : "The comments for the port." - }, - "state" : { - "type" : "string", - "description" : "The state of the port.", - "enum" : [ "RUNNING", "STOPPED", "DISABLED" ] - }, - "type" : { - "type" : "string", - "description" : "The type of port.", - "enum" : [ "INPUT_PORT", "OUTPUT_PORT" ] - }, - "transmitting" : { - "type" : "boolean", - "description" : "Whether the port has incoming or output connections to a remote NiFi. This is only applicable when the port is running in the root group." - }, - "concurrentlySchedulableTaskCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of tasks that should be concurrently scheduled for the port." - }, - "userAccessControl" : { - "type" : "array", - "description" : "The users that are allowed to access the port.", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - }, - "groupAccessControl" : { - "type" : "array", - "description" : "The user groups that are allowed to access the port.", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - }, - "validationErrors" : { - "type" : "array", - "description" : "Gets the validation errors from this port. These validation errors represent the problems with the port that must be resolved before it can be started.", - "items" : { - "type" : "string" - } - } - } - }, - "PortEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "component" : { - "$ref" : "#/definitions/PortDTO" - }, - "status" : { - "description" : "The status of the port.", - "$ref" : "#/definitions/PortStatusDTO" - }, - "portType" : { - "type" : "string" - } - }, - "xml" : { - "name" : "portEntity" - } - }, - "PortStatusDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the port." - }, - "groupId" : { - "type" : "string", - "description" : "The id of the parent process group of the port." - }, - "name" : { - "type" : "string", - "description" : "The name of the port." - }, - "transmitting" : { - "type" : "boolean", - "description" : "Whether the port has incoming or outgoing connections to a remote NiFi." - }, - "runStatus" : { - "type" : "string", - "description" : "The run status of the port." - }, - "statsLastRefreshed" : { - "type" : "string", - "description" : "The time the status for the process group was last refreshed." - }, - "aggregateSnapshot" : { - "description" : "A status snapshot that represents the aggregate stats of all nodes in the cluster. If the NiFi instance is a standalone instance, rather than a cluster, this represents the stats of the single instance.", - "$ref" : "#/definitions/PortStatusSnapshotDTO" - }, - "nodeSnapshots" : { - "type" : "array", - "description" : "A status snapshot for each node in the cluster. If the NiFi instance is a standalone instance, rather than a cluster, this may be null.", - "items" : { - "$ref" : "#/definitions/NodePortStatusSnapshotDTO" - } - } - } - }, - "PortStatusEntity" : { - "type" : "object", - "properties" : { - "portStatus" : { - "$ref" : "#/definitions/PortStatusDTO" - }, - "canRead" : { - "type" : "boolean", - "description" : "Indicates whether the user can read a given resource.", - "readOnly" : true - } - }, - "xml" : { - "name" : "portStatusEntity" - } - }, - "PortStatusSnapshotDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the port." - }, - "groupId" : { - "type" : "string", - "description" : "The id of the parent process group of the port." - }, - "name" : { - "type" : "string", - "description" : "The name of the port." - }, - "activeThreadCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The active thread count for the port." - }, - "flowFilesIn" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of FlowFiles that have been accepted in the last 5 minutes." - }, - "bytesIn" : { - "type" : "integer", - "format" : "int64", - "description" : "The size of hte FlowFiles that have been accepted in the last 5 minutes." - }, - "input" : { - "type" : "string", - "description" : "The count/size of flowfiles that have been accepted in the last 5 minutes." - }, - "flowFilesOut" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of FlowFiles that have been processed in the last 5 minutes." - }, - "bytesOut" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes that have been processed in the last 5 minutes." - }, - "output" : { - "type" : "string", - "description" : "The count/size of flowfiles that have been processed in the last 5 minutes." - }, - "transmitting" : { - "type" : "boolean", - "description" : "Whether the port has incoming or outgoing connections to a remote NiFi." - }, - "runStatus" : { - "type" : "string", - "description" : "The run status of the port." - } - } - }, - "PortStatusSnapshotEntity" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the port." - }, - "portStatusSnapshot" : { - "$ref" : "#/definitions/PortStatusSnapshotDTO" - }, - "canRead" : { - "type" : "boolean", - "description" : "Indicates whether the user can read a given resource.", - "readOnly" : true - } - }, - "xml" : { - "name" : "entity" - } - }, - "Position" : { - "type" : "object", - "properties" : { - "x" : { - "type" : "number", - "format" : "double", - "description" : "The x coordinate." - }, - "y" : { - "type" : "number", - "format" : "double", - "description" : "The y coordinate." - } - }, - "description" : "The position of a component on the graph" - }, - "PositionDTO" : { - "type" : "object", - "properties" : { - "x" : { - "type" : "number", - "format" : "double", - "description" : "The x coordinate." - }, - "y" : { - "type" : "number", - "format" : "double", - "description" : "The y coordinate." - } - } - }, - "PreviousValueDTO" : { - "type" : "object", - "properties" : { - "previousValue" : { - "type" : "string", - "description" : "The previous value." - }, - "timestamp" : { - "type" : "string", - "description" : "The timestamp when the value was modified." - }, - "userIdentity" : { - "type" : "string", - "description" : "The user who changed the previous value." - } - } - }, - "PrioritizerTypesEntity" : { - "type" : "object", - "properties" : { - "prioritizerTypes" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/DocumentedTypeDTO" - } - } - }, - "xml" : { - "name" : "prioritizerTypesEntity" - } - }, - "ProcessGroupDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "versionedComponentId" : { - "type" : "string", - "description" : "The ID of the corresponding component that is under version control" - }, - "parentGroupId" : { - "type" : "string", - "description" : "The id of parent process group of this component if applicable." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "name" : { - "type" : "string", - "description" : "The name of the process group." - }, - "comments" : { - "type" : "string", - "description" : "The comments for the process group." - }, - "variables" : { - "type" : "object", - "description" : "The variables that are configured for the Process Group. Note that this map contains only those variables that are defined on this Process Group and not any variables that are defined in the parent Process Group, etc. I.e., this Map will not contain all variables that are accessible by components in this Process Group by rather only the variables that are defined for this Process Group itself.", - "readOnly" : true, - "additionalProperties" : { - "type" : "string" - } - }, - "versionControlInformation" : { - "description" : "The Version Control information that indicates which Flow Registry, and where in the Flow Registry, this Process Group is tracking to; or null if this Process Group is not under version control", - "$ref" : "#/definitions/VersionControlInformationDTO" - }, - "runningCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of running components in this process group." - }, - "stoppedCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of stopped components in the process group." - }, - "invalidCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of invalid components in the process group." - }, - "disabledCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of disabled components in the process group." - }, - "activeRemotePortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of active remote ports in the process group." - }, - "inactiveRemotePortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of inactive remote ports in the process group." - }, - "upToDateCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of up to date versioned process groups in the process group." - }, - "locallyModifiedCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of locally modified versioned process groups in the process group." - }, - "staleCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of stale versioned process groups in the process group." - }, - "locallyModifiedAndStaleCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of locally modified and stale versioned process groups in the process group." - }, - "syncFailureCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of versioned process groups in the process group that are unable to sync to a registry." - }, - "inputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of input ports in the process group." - }, - "outputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of output ports in the process group." - }, - "contents" : { - "description" : "The contents of this process group.", - "$ref" : "#/definitions/FlowSnippetDTO" - } - } - }, - "ProcessGroupEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "component" : { - "$ref" : "#/definitions/ProcessGroupDTO" - }, - "status" : { - "description" : "The status of the process group.", - "$ref" : "#/definitions/ProcessGroupStatusDTO" - }, - "versionedFlowSnapshot" : { - "description" : "Returns the Versioned Flow that describes the contents of the Versioned Flow to be imported", - "readOnly" : true, - "$ref" : "#/definitions/versionedFlowSnapshot" - }, - "runningCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of running components in this process group." - }, - "stoppedCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of stopped components in the process group." - }, - "invalidCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of invalid components in the process group." - }, - "disabledCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of disabled components in the process group." - }, - "activeRemotePortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of active remote ports in the process group." - }, - "inactiveRemotePortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of inactive remote ports in the process group." - }, - "versionedFlowState" : { - "type" : "string", - "description" : "The current state of the Process Group, as it relates to the Versioned Flow", - "readOnly" : true, - "enum" : [ "LOCALLY_MODIFIED", "STALE", "LOCALLY_MODIFIED_AND_STALE", "UP_TO_DATE", "SYNC_FAILURE" ] - }, - "upToDateCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of up to date versioned process groups in the process group." - }, - "locallyModifiedCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of locally modified versioned process groups in the process group." - }, - "staleCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of stale versioned process groups in the process group." - }, - "locallyModifiedAndStaleCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of locally modified and stale versioned process groups in the process group." - }, - "syncFailureCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of versioned process groups in the process group that are unable to sync to a registry." - }, - "inputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of input ports in the process group." - }, - "outputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of output ports in the process group." - } - }, - "xml" : { - "name" : "processGroupEntity" - } - }, - "ProcessGroupFlowDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "parentGroupId" : { - "type" : "string", - "description" : "The id of parent process group of this component if applicable." - }, - "breadcrumb" : { - "description" : "The breadcrumb of the process group.", - "$ref" : "#/definitions/FlowBreadcrumbEntity" - }, - "flow" : { - "description" : "The flow structure starting at this Process Group.", - "$ref" : "#/definitions/FlowDTO" - }, - "lastRefreshed" : { - "type" : "string", - "description" : "The time the flow for the process group was last refreshed." - } - } - }, - "ProcessGroupFlowEntity" : { - "type" : "object", - "properties" : { - "permissions" : { - "description" : "The access policy for this process group.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "processGroupFlow" : { - "$ref" : "#/definitions/ProcessGroupFlowDTO" - } - }, - "xml" : { - "name" : "processGroupFlowEntity" - } - }, - "ProcessGroupStatusDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The ID of the Process Group" - }, - "name" : { - "type" : "string", - "description" : "The name of the Process Group" - }, - "statsLastRefreshed" : { - "type" : "string", - "description" : "The time the status for the process group was last refreshed." - }, - "aggregateSnapshot" : { - "description" : "The aggregate status of all nodes in the cluster", - "$ref" : "#/definitions/ProcessGroupStatusSnapshotDTO" - }, - "nodeSnapshots" : { - "type" : "array", - "description" : "The status reported by each node in the cluster. If the NiFi instance is a standalone instance, rather than a clustered instance, this value may be null.", - "items" : { - "$ref" : "#/definitions/NodeProcessGroupStatusSnapshotDTO" - } - } - } - }, - "ProcessGroupStatusEntity" : { - "type" : "object", - "properties" : { - "processGroupStatus" : { - "$ref" : "#/definitions/ProcessGroupStatusDTO" - }, - "canRead" : { - "type" : "boolean", - "description" : "Indicates whether the user can read a given resource.", - "readOnly" : true - } - }, - "xml" : { - "name" : "processGroupStatusEntity" - } - }, - "ProcessGroupStatusSnapshotDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the process group." - }, - "name" : { - "type" : "string", - "description" : "The name of this process group." - }, - "connectionStatusSnapshots" : { - "type" : "array", - "description" : "The status of all connections in the process group.", - "items" : { - "$ref" : "#/definitions/ConnectionStatusSnapshotEntity" - } - }, - "processorStatusSnapshots" : { - "type" : "array", - "description" : "The status of all processors in the process group.", - "items" : { - "$ref" : "#/definitions/ProcessorStatusSnapshotEntity" - } - }, - "processGroupStatusSnapshots" : { - "type" : "array", - "description" : "The status of all process groups in the process group.", - "items" : { - "$ref" : "#/definitions/ProcessGroupStatusSnapshotEntity" - } - }, - "remoteProcessGroupStatusSnapshots" : { - "type" : "array", - "description" : "The status of all remote process groups in the process group.", - "items" : { - "$ref" : "#/definitions/RemoteProcessGroupStatusSnapshotEntity" - } - }, - "inputPortStatusSnapshots" : { - "type" : "array", - "description" : "The status of all input ports in the process group.", - "items" : { - "$ref" : "#/definitions/PortStatusSnapshotEntity" - } - }, - "outputPortStatusSnapshots" : { - "type" : "array", - "description" : "The status of all output ports in the process group.", - "items" : { - "$ref" : "#/definitions/PortStatusSnapshotEntity" - } - }, - "versionedFlowState" : { - "type" : "string", - "description" : "The current state of the Process Group, as it relates to the Versioned Flow", - "readOnly" : true, - "enum" : [ "LOCALLY_MODIFIED", "STALE", "LOCALLY_MODIFIED_AND_STALE", "UP_TO_DATE", "SYNC_FAILURE" ] - }, - "flowFilesIn" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of FlowFiles that have come into this ProcessGroup in the last 5 minutes" - }, - "bytesIn" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes that have come into this ProcessGroup in the last 5 minutes" - }, - "input" : { - "type" : "string", - "description" : "The input count/size for the process group in the last 5 minutes (pretty printed)." - }, - "flowFilesQueued" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of FlowFiles that are queued up in this ProcessGroup right now" - }, - "bytesQueued" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes that are queued up in this ProcessGroup right now" - }, - "queued" : { - "type" : "string", - "description" : "The count/size that is queued in the the process group." - }, - "queuedCount" : { - "type" : "string", - "description" : "The count that is queued for the process group." - }, - "queuedSize" : { - "type" : "string", - "description" : "The size that is queued for the process group." - }, - "bytesRead" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes read by components in this ProcessGroup in the last 5 minutes" - }, - "read" : { - "type" : "string", - "description" : "The number of bytes read in the last 5 minutes." - }, - "bytesWritten" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes written by components in this ProcessGroup in the last 5 minutes" - }, - "written" : { - "type" : "string", - "description" : "The number of bytes written in the last 5 minutes." - }, - "flowFilesOut" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of FlowFiles transferred out of this ProcessGroup in the last 5 minutes" - }, - "bytesOut" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes transferred out of this ProcessGroup in the last 5 minutes" - }, - "output" : { - "type" : "string", - "description" : "The output count/size for the process group in the last 5 minutes." - }, - "flowFilesTransferred" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of FlowFiles transferred in this ProcessGroup in the last 5 minutes" - }, - "bytesTransferred" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes transferred in this ProcessGroup in the last 5 minutes" - }, - "transferred" : { - "type" : "string", - "description" : "The count/size transferred to/from queues in the process group in the last 5 minutes." - }, - "bytesReceived" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes received from external sources by components within this ProcessGroup in the last 5 minutes" - }, - "flowFilesReceived" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of FlowFiles received from external sources by components within this ProcessGroup in the last 5 minutes" - }, - "received" : { - "type" : "string", - "description" : "The count/size sent to the process group in the last 5 minutes." - }, - "bytesSent" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes sent to an external sink by components within this ProcessGroup in the last 5 minutes" - }, - "flowFilesSent" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of FlowFiles sent to an external sink by components within this ProcessGroup in the last 5 minutes" - }, - "sent" : { - "type" : "string", - "description" : "The count/size sent from this process group in the last 5 minutes." - }, - "activeThreadCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The active thread count for this process group." - }, - "terminatedThreadCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of threads currently terminated for the process group." - } - } - }, - "ProcessGroupStatusSnapshotEntity" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the process group." - }, - "processGroupStatusSnapshot" : { - "$ref" : "#/definitions/ProcessGroupStatusSnapshotDTO" - }, - "canRead" : { - "type" : "boolean", - "description" : "Indicates whether the user can read a given resource.", - "readOnly" : true - } - }, - "xml" : { - "name" : "entity" - } - }, - "ProcessGroupsEntity" : { - "type" : "object", - "properties" : { - "processGroups" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ProcessGroupEntity" - } - } - }, - "xml" : { - "name" : "processGroupsEntity" - } - }, - "ProcessorConfigDTO" : { - "type" : "object", - "properties" : { - "properties" : { - "type" : "object", - "description" : "The properties for the processor. Properties whose value is not set will only contain the property name.", - "additionalProperties" : { - "type" : "string" - } - }, - "descriptors" : { - "type" : "object", - "description" : "Descriptors for the processor's properties.", - "additionalProperties" : { - "$ref" : "#/definitions/PropertyDescriptorDTO" - } - }, - "schedulingPeriod" : { - "type" : "string", - "description" : "The frequency with which to schedule the processor. The format of the value will depend on th value of schedulingStrategy." - }, - "schedulingStrategy" : { - "type" : "string", - "description" : "Indcates whether the prcessor should be scheduled to run in event or timer driven mode." - }, - "executionNode" : { - "type" : "string", - "description" : "Indicates the node where the process will execute." - }, - "penaltyDuration" : { - "type" : "string", - "description" : "The amount of time that is used when the process penalizes a flowfile." - }, - "yieldDuration" : { - "type" : "string", - "description" : "The amount of time that must elapse before this processor is scheduled again after yielding." - }, - "bulletinLevel" : { - "type" : "string", - "description" : "The level at which the processor will report bulletins." - }, - "runDurationMillis" : { - "type" : "integer", - "format" : "int64", - "description" : "The run duration for the processor in milliseconds." - }, - "concurrentlySchedulableTaskCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of tasks that should be concurrently schedule for the processor. If the processor doesn't allow parallol processing then any positive input will be ignored." - }, - "autoTerminatedRelationships" : { - "type" : "array", - "description" : "The names of all relationships that cause a flow file to be terminated if the relationship is not connected elsewhere. This property differs from the 'isAutoTerminate' property of the RelationshipDTO in that the RelationshipDTO is meant to depict the current configuration, whereas this property can be set in a DTO when updating a Processor in order to change which Relationships should be auto-terminated.", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - }, - "comments" : { - "type" : "string", - "description" : "The comments for the processor." - }, - "customUiUrl" : { - "type" : "string", - "description" : "The URL for the processor's custom configuration UI if applicable." - }, - "lossTolerant" : { - "type" : "boolean", - "description" : "Whether the processor is loss tolerant." - }, - "annotationData" : { - "type" : "string", - "description" : "The annotation data for the processor used to relay configuration between a custom UI and the procesosr." - }, - "defaultConcurrentTasks" : { - "type" : "object", - "description" : "Maps default values for concurrent tasks for each applicable scheduling strategy.", - "additionalProperties" : { - "type" : "string" - } - }, - "defaultSchedulingPeriod" : { - "type" : "object", - "description" : "Maps default values for scheduling period for each applicable scheduling strategy.", - "additionalProperties" : { - "type" : "string" - } - } - } - }, - "ProcessorDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "versionedComponentId" : { - "type" : "string", - "description" : "The ID of the corresponding component that is under version control" - }, - "parentGroupId" : { - "type" : "string", - "description" : "The id of parent process group of this component if applicable." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "name" : { - "type" : "string", - "description" : "The name of the processor." - }, - "type" : { - "type" : "string", - "description" : "The type of the processor." - }, - "bundle" : { - "description" : "The details of the artifact that bundled this processor type.", - "$ref" : "#/definitions/BundleDTO" - }, - "state" : { - "type" : "string", - "description" : "The state of the processor", - "enum" : [ "RUNNING", "STOPPED", "DISABLED" ] - }, - "style" : { - "type" : "object", - "description" : "Styles for the processor (background-color : #eee).", - "additionalProperties" : { - "type" : "string" - } - }, - "relationships" : { - "type" : "array", - "description" : "The available relationships that the processor currently supports.", - "readOnly" : true, - "items" : { - "$ref" : "#/definitions/RelationshipDTO" - } - }, - "description" : { - "type" : "string", - "description" : "The description of the processor." - }, - "supportsParallelProcessing" : { - "type" : "boolean", - "description" : "Whether the processor supports parallel processing." - }, - "supportsEventDriven" : { - "type" : "boolean", - "description" : "Whether the processor supports event driven scheduling." - }, - "supportsBatching" : { - "type" : "boolean", - "description" : "Whether the processor supports batching. This makes the run duration settings available." - }, - "persistsState" : { - "type" : "boolean", - "description" : "Whether the processor persists state." - }, - "restricted" : { - "type" : "boolean", - "description" : "Whether the processor requires elevated privileges." - }, - "deprecated" : { - "type" : "boolean", - "description" : "Whether the processor has been deprecated." - }, - "executionNodeRestricted" : { - "type" : "boolean", - "description" : "Indicates if the execution node of a processor is restricted to run only on the primary node" - }, - "multipleVersionsAvailable" : { - "type" : "boolean", - "description" : "Whether the processor has multiple versions available." - }, - "inputRequirement" : { - "type" : "string", - "description" : "The input requirement for this processor." - }, - "config" : { - "description" : "The configuration details for the processor. These details will be included in a response if the verbose flag is included in a request.", - "$ref" : "#/definitions/ProcessorConfigDTO" - }, - "validationErrors" : { - "type" : "array", - "description" : "The validation errors for the processor. These validation errors represent the problems with the processor that must be resolved before it can be started.", - "items" : { - "type" : "string" - } - }, - "validationStatus" : { - "type" : "string", - "description" : "Indicates whether the Processor is valid, invalid, or still in the process of validating (i.e., it is unknown whether or not the Processor is valid)", - "readOnly" : true, - "enum" : [ "VALID", "INVALID", "VALIDATING" ] - }, - "extensionMissing" : { - "type" : "boolean", - "description" : "Whether the underlying extension is missing." - } - } - }, - "ProcessorEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "component" : { - "$ref" : "#/definitions/ProcessorDTO" - }, - "inputRequirement" : { - "type" : "string", - "description" : "The input requirement for this processor." - }, - "status" : { - "$ref" : "#/definitions/ProcessorStatusDTO" - } - }, - "xml" : { - "name" : "processorEntity" - } - }, - "ProcessorStatusDTO" : { - "type" : "object", - "properties" : { - "groupId" : { - "type" : "string", - "description" : "The unique ID of the process group that the Processor belongs to" - }, - "id" : { - "type" : "string", - "description" : "The unique ID of the Processor" - }, - "name" : { - "type" : "string", - "description" : "The name of the Processor" - }, - "type" : { - "type" : "string", - "description" : "The type of the Processor" - }, - "runStatus" : { - "type" : "string", - "description" : "The run status of the Processor", - "enum" : [ "Running", "Stopped", "Disabled", "Invalid" ] - }, - "statsLastRefreshed" : { - "type" : "string", - "description" : "The timestamp of when the stats were last refreshed" - }, - "aggregateSnapshot" : { - "description" : "A status snapshot that represents the aggregate stats of all nodes in the cluster. If the NiFi instance is a standalone instance, rather than a cluster, this represents the stats of the single instance.", - "$ref" : "#/definitions/ProcessorStatusSnapshotDTO" - }, - "nodeSnapshots" : { - "type" : "array", - "description" : "A status snapshot for each node in the cluster. If the NiFi instance is a standalone instance, rather than a cluster, this may be null.", - "items" : { - "$ref" : "#/definitions/NodeProcessorStatusSnapshotDTO" - } - } - } - }, - "ProcessorStatusEntity" : { - "type" : "object", - "properties" : { - "processorStatus" : { - "$ref" : "#/definitions/ProcessorStatusDTO" - }, - "canRead" : { - "type" : "boolean", - "description" : "Indicates whether the user can read a given resource.", - "readOnly" : true - } - }, - "xml" : { - "name" : "processorStatusEntity" - } - }, - "ProcessorStatusSnapshotDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the processor." - }, - "groupId" : { - "type" : "string", - "description" : "The id of the parent process group to which the processor belongs." - }, - "name" : { - "type" : "string", - "description" : "The name of the prcessor." - }, - "type" : { - "type" : "string", - "description" : "The type of the processor." - }, - "runStatus" : { - "type" : "string", - "description" : "The state of the processor.", - "enum" : [ "Running", "Stopped", "Disabled", "Invalid" ] - }, - "executionNode" : { - "type" : "string", - "description" : "Indicates the node where the process will execute.", - "enum" : [ "ALL", "PRIMARY" ] - }, - "bytesRead" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes read by this Processor in the last 5 mintues" - }, - "bytesWritten" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes written by this Processor in the last 5 minutes" - }, - "read" : { - "type" : "string", - "description" : "The number of bytes read in the last 5 minutes." - }, - "written" : { - "type" : "string", - "description" : "The number of bytes written in the last 5 minutes." - }, - "flowFilesIn" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of FlowFiles that have been accepted in the last 5 minutes" - }, - "bytesIn" : { - "type" : "integer", - "format" : "int64", - "description" : "The size of the FlowFiles that have been accepted in the last 5 minutes" - }, - "input" : { - "type" : "string", - "description" : "The count/size of flowfiles that have been accepted in the last 5 minutes." - }, - "flowFilesOut" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of FlowFiles transferred to a Connection in the last 5 minutes" - }, - "bytesOut" : { - "type" : "integer", - "format" : "int64", - "description" : "The size of the FlowFiles transferred to a Connection in the last 5 minutes" - }, - "output" : { - "type" : "string", - "description" : "The count/size of flowfiles that have been processed in the last 5 minutes." - }, - "taskCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of times this Processor has run in the last 5 minutes" - }, - "tasksDurationNanos" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of nanoseconds that this Processor has spent running in the last 5 minutes" - }, - "tasks" : { - "type" : "string", - "description" : "The total number of task this connectable has completed over the last 5 minutes." - }, - "tasksDuration" : { - "type" : "string", - "description" : "The total duration of all tasks for this connectable over the last 5 minutes." - }, - "activeThreadCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of threads currently executing in the processor." - }, - "terminatedThreadCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of threads currently terminated for the processor." - } - } - }, - "ProcessorStatusSnapshotEntity" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the processor." - }, - "processorStatusSnapshot" : { - "$ref" : "#/definitions/ProcessorStatusSnapshotDTO" - }, - "canRead" : { - "type" : "boolean", - "description" : "Indicates whether the user can read a given resource.", - "readOnly" : true - } - }, - "xml" : { - "name" : "entity" - } - }, - "ProcessorTypesEntity" : { - "type" : "object", - "properties" : { - "processorTypes" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/DocumentedTypeDTO" - } - } - }, - "xml" : { - "name" : "processorTypesEntity" - } - }, - "ProcessorsEntity" : { - "type" : "object", - "properties" : { - "processors" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ProcessorEntity" - } - } - }, - "xml" : { - "name" : "processorsEntity" - } - }, - "PropertyDescriptorDTO" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The name for the property." - }, - "displayName" : { - "type" : "string", - "description" : "The human readable name for the property." - }, - "description" : { - "type" : "string", - "description" : "The description for the property. Used to relay additional details to a user or provide a mechanism of documenting intent." - }, - "defaultValue" : { - "type" : "string", - "description" : "The default value for the property." - }, - "allowableValues" : { - "type" : "array", - "description" : "Allowable values for the property. If empty then the allowed values are not constrained.", - "items" : { - "$ref" : "#/definitions/AllowableValueEntity" - } - }, - "required" : { - "type" : "boolean", - "description" : "Whether the property is required." - }, - "sensitive" : { - "type" : "boolean", - "description" : "Whether the property is sensitive and protected whenever stored or represented." - }, - "dynamic" : { - "type" : "boolean", - "description" : "Whether the property is dynamic (user-defined)." - }, - "supportsEl" : { - "type" : "boolean", - "description" : "Whether the property supports expression language." - }, - "expressionLanguageScope" : { - "type" : "string", - "description" : "Scope of the Expression Language evaluation for the property." - }, - "identifiesControllerService" : { - "type" : "string", - "description" : "If the property identifies a controller service this returns the fully qualified type." - }, - "identifiesControllerServiceBundle" : { - "description" : "If the property identifies a controller service this returns the bundle of the type, null otherwise.", - "$ref" : "#/definitions/BundleDTO" - } - } - }, - "PropertyDescriptorEntity" : { - "type" : "object", - "properties" : { - "propertyDescriptor" : { - "$ref" : "#/definitions/PropertyDescriptorDTO" - } - }, - "xml" : { - "name" : "propertyDescriptor" - } - }, - "PropertyHistoryDTO" : { - "type" : "object", - "properties" : { - "previousValues" : { - "type" : "array", - "description" : "Previous values for a given property.", - "items" : { - "$ref" : "#/definitions/PreviousValueDTO" - } - } - } - }, - "ProvenanceDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the provenance query." - }, - "uri" : { - "type" : "string", - "description" : "The URI for this query. Used for obtaining/deleting the request at a later time" - }, - "submissionTime" : { - "type" : "string", - "description" : "The timestamp when the query was submitted." - }, - "expiration" : { - "type" : "string", - "description" : "The timestamp when the query will expire." - }, - "percentCompleted" : { - "type" : "integer", - "format" : "int32", - "description" : "The current percent complete." - }, - "finished" : { - "type" : "boolean", - "description" : "Whether the query has finished." - }, - "request" : { - "description" : "The provenance request.", - "$ref" : "#/definitions/ProvenanceRequestDTO" - }, - "results" : { - "description" : "The provenance results.", - "$ref" : "#/definitions/ProvenanceResultsDTO" - } - } - }, - "ProvenanceEntity" : { - "type" : "object", - "properties" : { - "provenance" : { - "$ref" : "#/definitions/ProvenanceDTO" - } - }, - "xml" : { - "name" : "provenanceEntity" - } - }, - "ProvenanceEventDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The event uuid." - }, - "eventId" : { - "type" : "integer", - "format" : "int64", - "description" : "The event id. This is a one up number thats unique per node." - }, - "eventTime" : { - "type" : "string", - "description" : "The timestamp of the event." - }, - "eventDuration" : { - "type" : "integer", - "format" : "int64", - "description" : "The event duration in milliseconds." - }, - "lineageDuration" : { - "type" : "integer", - "format" : "int64", - "description" : "The duration since the lineage began, in milliseconds." - }, - "eventType" : { - "type" : "string", - "description" : "The type of the event." - }, - "flowFileUuid" : { - "type" : "string", - "description" : "The uuid of the flowfile for the event." - }, - "fileSize" : { - "type" : "string", - "description" : "The size of the flowfile for the event." - }, - "fileSizeBytes" : { - "type" : "integer", - "format" : "int64", - "description" : "The size of the flowfile in bytes for the event." - }, - "clusterNodeId" : { - "type" : "string", - "description" : "The identifier for the node where the event originated." - }, - "clusterNodeAddress" : { - "type" : "string", - "description" : "The label for the node where the event originated." - }, - "groupId" : { - "type" : "string", - "description" : "The id of the group that the component resides in. If the component is no longer in the flow, the group id will not be set." - }, - "componentId" : { - "type" : "string", - "description" : "The id of the component that generated the event." - }, - "componentType" : { - "type" : "string", - "description" : "The type of the component that generated the event." - }, - "componentName" : { - "type" : "string", - "description" : "The name of the component that generated the event." - }, - "sourceSystemFlowFileId" : { - "type" : "string", - "description" : "The source system flowfile id." - }, - "alternateIdentifierUri" : { - "type" : "string", - "description" : "The alternate identifier uri for the fileflow for the event." - }, - "attributes" : { - "type" : "array", - "description" : "The attributes of the flowfile for the event.", - "items" : { - "$ref" : "#/definitions/AttributeDTO" - } - }, - "parentUuids" : { - "type" : "array", - "description" : "The parent uuids for the event.", - "items" : { - "type" : "string" - } - }, - "childUuids" : { - "type" : "array", - "description" : "The child uuids for the event.", - "items" : { - "type" : "string" - } - }, - "transitUri" : { - "type" : "string", - "description" : "The source/destination system uri if the event was a RECEIVE/SEND." - }, - "relationship" : { - "type" : "string", - "description" : "The relationship to which the flowfile was routed if the event is of type ROUTE." - }, - "details" : { - "type" : "string", - "description" : "The event details." - }, - "contentEqual" : { - "type" : "boolean", - "description" : "Whether the input and output content claim is the same." - }, - "inputContentAvailable" : { - "type" : "boolean", - "description" : "Whether the input content is still available." - }, - "inputContentClaimSection" : { - "type" : "string", - "description" : "The section in which the input content claim lives." - }, - "inputContentClaimContainer" : { - "type" : "string", - "description" : "The container in which the input content claim lives." - }, - "inputContentClaimIdentifier" : { - "type" : "string", - "description" : "The identifier of the input content claim." - }, - "inputContentClaimOffset" : { - "type" : "integer", - "format" : "int64", - "description" : "The offset into the input content claim where the flowfiles content begins." - }, - "inputContentClaimFileSize" : { - "type" : "string", - "description" : "The file size of the input content claim formatted." - }, - "inputContentClaimFileSizeBytes" : { - "type" : "integer", - "format" : "int64", - "description" : "The file size of the intput content claim in bytes." - }, - "outputContentAvailable" : { - "type" : "boolean", - "description" : "Whether the output content is still available." - }, - "outputContentClaimSection" : { - "type" : "string", - "description" : "The section in which the output content claim lives." - }, - "outputContentClaimContainer" : { - "type" : "string", - "description" : "The container in which the output content claim lives." - }, - "outputContentClaimIdentifier" : { - "type" : "string", - "description" : "The identifier of the output content claim." - }, - "outputContentClaimOffset" : { - "type" : "integer", - "format" : "int64", - "description" : "The offset into the output content claim where the flowfiles content begins." - }, - "outputContentClaimFileSize" : { - "type" : "string", - "description" : "The file size of the output content claim formatted." - }, - "outputContentClaimFileSizeBytes" : { - "type" : "integer", - "format" : "int64", - "description" : "The file size of the output content claim in bytes." - }, - "replayAvailable" : { - "type" : "boolean", - "description" : "Whether or not replay is available." - }, - "replayExplanation" : { - "type" : "string", - "description" : "Explanation as to why replay is unavailable." - }, - "sourceConnectionIdentifier" : { - "type" : "string", - "description" : "The identifier of the queue/connection from which the flowfile was pulled to genereate this event. May be null if the queue/connection is unknown or the flowfile was generated from this event." - } - } - }, - "ProvenanceEventEntity" : { - "type" : "object", - "properties" : { - "provenanceEvent" : { - "$ref" : "#/definitions/ProvenanceEventDTO" - } - }, - "xml" : { - "name" : "provenanceEventEntity" - } - }, - "ProvenanceLinkDTO" : { - "type" : "object", - "properties" : { - "sourceId" : { - "type" : "string", - "description" : "The source node id of the link." - }, - "targetId" : { - "type" : "string", - "description" : "The target node id of the link." - }, - "flowFileUuid" : { - "type" : "string", - "description" : "The flowfile uuid that traversed the link." - }, - "timestamp" : { - "type" : "string", - "description" : "The timestamp of the link (based on the destination)." - }, - "millis" : { - "type" : "integer", - "format" : "int64", - "description" : "The timestamp of this link in milliseconds." - } - } - }, - "ProvenanceNodeDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the node." - }, - "flowFileUuid" : { - "type" : "string", - "description" : "The uuid of the flowfile associated with the provenance event." - }, - "parentUuids" : { - "type" : "array", - "description" : "The uuid of the parent flowfiles of the provenance event.", - "items" : { - "type" : "string" - } - }, - "childUuids" : { - "type" : "array", - "description" : "The uuid of the childrent flowfiles of the provenance event.", - "items" : { - "type" : "string" - } - }, - "clusterNodeIdentifier" : { - "type" : "string", - "description" : "The identifier of the node that this event/flowfile originated from." - }, - "type" : { - "type" : "string", - "description" : "The type of the node.", - "enum" : [ "FLOWFILE", "EVENT" ] - }, - "eventType" : { - "type" : "string", - "description" : "If the type is EVENT, this is the type of event." - }, - "millis" : { - "type" : "integer", - "format" : "int64", - "description" : "The timestamp of the node in milliseconds." - }, - "timestamp" : { - "type" : "string", - "description" : "The timestamp of the node formatted." - } - } - }, - "ProvenanceOptionsDTO" : { - "type" : "object", - "properties" : { - "searchableFields" : { - "type" : "array", - "description" : "The available searchable field for the NiFi.", - "items" : { - "$ref" : "#/definitions/ProvenanceSearchableFieldDTO" - } - } - } - }, - "ProvenanceOptionsEntity" : { - "type" : "object", - "properties" : { - "provenanceOptions" : { - "$ref" : "#/definitions/ProvenanceOptionsDTO" - } - }, - "xml" : { - "name" : "provenanceOptionsEntity" - } - }, - "ProvenanceRequestDTO" : { - "type" : "object", - "properties" : { - "searchTerms" : { - "type" : "object", - "description" : "The search terms used to perform the search.", - "additionalProperties" : { - "type" : "string" - } - }, - "clusterNodeId" : { - "type" : "string", - "description" : "The id of the node in the cluster where this provenance originated." - }, - "startDate" : { - "type" : "string", - "description" : "The earliest event time to include in the query." - }, - "endDate" : { - "type" : "string", - "description" : "The latest event time to include in the query." - }, - "minimumFileSize" : { - "type" : "string", - "description" : "The minimum file size to include in the query." - }, - "maximumFileSize" : { - "type" : "string", - "description" : "The maximum file size to include in the query." - }, - "maxResults" : { - "type" : "integer", - "format" : "int32", - "description" : "The maximum number of results to include." - }, - "summarize" : { - "type" : "boolean", - "description" : "Whether or not to summarize provenance events returned. This property is false by default." - }, - "incrementalResults" : { - "type" : "boolean", - "description" : "Whether or not incremental results are returned. If false, provenance events are only returned once the query completes. This property is true by default." - } - } - }, - "ProvenanceResultsDTO" : { - "type" : "object", - "properties" : { - "provenanceEvents" : { - "type" : "array", - "description" : "The provenance events that matched the search criteria.", - "items" : { - "$ref" : "#/definitions/ProvenanceEventDTO" - } - }, - "total" : { - "type" : "string", - "description" : "The total number of results formatted." - }, - "totalCount" : { - "type" : "integer", - "format" : "int64", - "description" : "The total number of results." - }, - "generated" : { - "type" : "string", - "description" : "Then the search was performed." - }, - "oldestEvent" : { - "type" : "string", - "description" : "The oldest event available in the provenance repository." - }, - "timeOffset" : { - "type" : "integer", - "format" : "int32", - "description" : "The time offset of the server that's used for event time." - }, - "errors" : { - "type" : "array", - "description" : "Any errors that occurred while performing the provenance request.", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - } - } - }, - "ProvenanceSearchableFieldDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the searchable field." - }, - "field" : { - "type" : "string", - "description" : "The searchable field." - }, - "label" : { - "type" : "string", - "description" : "The label for the searchable field." - }, - "type" : { - "type" : "string", - "description" : "The type of the searchable field." - } - } - }, - "QueueSizeDTO" : { - "type" : "object", - "properties" : { - "byteCount" : { - "type" : "integer", - "format" : "int64", - "description" : "The size of objects in a queue." - }, - "objectCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The count of objects in a queue." - } - } - }, - "RegistryClientEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "component" : { - "$ref" : "#/definitions/RegistryDTO" - } - }, - "xml" : { - "name" : "registryClientEntity" - } - }, - "RegistryClientsEntity" : { - "type" : "object", - "properties" : { - "registries" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/RegistryClientEntity" - } - } - }, - "xml" : { - "name" : "registryClientsEntity" - } - }, - "RegistryDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The registry identifier" - }, - "name" : { - "type" : "string", - "description" : "The registry name" - }, - "description" : { - "type" : "string", - "description" : "The registry description" - }, - "uri" : { - "type" : "string", - "description" : "The registry URI" - } - } - }, - "RelationshipDTO" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The relationship name." - }, - "description" : { - "type" : "string", - "description" : "The relationship description." - }, - "autoTerminate" : { - "type" : "boolean", - "description" : "Whether or not flowfiles sent to this relationship should auto terminate." - } - } - }, - "RemoteProcessGroupContentsDTO" : { - "type" : "object", - "properties" : { - "inputPorts" : { - "type" : "array", - "description" : "The input ports to which data can be sent.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/RemoteProcessGroupPortDTO" - } - }, - "outputPorts" : { - "type" : "array", - "description" : "The output ports from which data can be retrieved.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/RemoteProcessGroupPortDTO" - } - } - } - }, - "RemoteProcessGroupDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "versionedComponentId" : { - "type" : "string", - "description" : "The ID of the corresponding component that is under version control" - }, - "parentGroupId" : { - "type" : "string", - "description" : "The id of parent process group of this component if applicable." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "targetUri" : { - "type" : "string", - "description" : "The target URI of the remote process group. If target uri is not set, but uris are set, then returns the first url in the urls. If neither target uri nor uris are set, then returns null." - }, - "targetUris" : { - "type" : "string", - "description" : "The target URI of the remote process group. If target uris is not set but target uri is set, then returns a collection containing the single target uri. If neither target uris nor uris are set, then returns null." - }, - "targetSecure" : { - "type" : "boolean", - "description" : "Whether the target is running securely." - }, - "name" : { - "type" : "string", - "description" : "The name of the remote process group." - }, - "comments" : { - "type" : "string", - "description" : "The comments for the remote process group." - }, - "communicationsTimeout" : { - "type" : "string", - "description" : "The time period used for the timeout when communicating with the target." - }, - "yieldDuration" : { - "type" : "string", - "description" : "When yielding, this amount of time must elapse before the remote process group is scheduled again." - }, - "transportProtocol" : { - "type" : "string" - }, - "localNetworkInterface" : { - "type" : "string", - "description" : "The local network interface to send/receive data. If not specified, any local address is used. If clustered, all nodes must have an interface with this identifier." - }, - "proxyHost" : { - "type" : "string" - }, - "proxyPort" : { - "type" : "integer", - "format" : "int32" - }, - "proxyUser" : { - "type" : "string" - }, - "proxyPassword" : { - "type" : "string" - }, - "authorizationIssues" : { - "type" : "array", - "description" : "Any remote authorization issues for the remote process group.", - "items" : { - "type" : "string" - } - }, - "validationErrors" : { - "type" : "array", - "description" : "The validation errors for the remote process group. These validation errors represent the problems with the remote process group that must be resolved before it can transmit.", - "items" : { - "type" : "string" - } - }, - "transmitting" : { - "type" : "boolean", - "description" : "Whether the remote process group is actively transmitting." - }, - "inputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of remote input ports currently available on the target." - }, - "outputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of remote output ports currently available on the target." - }, - "activeRemoteInputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of active remote input ports." - }, - "inactiveRemoteInputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of inactive remote input ports." - }, - "activeRemoteOutputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of active remote output ports." - }, - "inactiveRemoteOutputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of inactive remote output ports." - }, - "flowRefreshed" : { - "type" : "string", - "description" : "The timestamp when this remote process group was last refreshed." - }, - "contents" : { - "description" : "The contents of the remote process group. Will contain available input/output ports.", - "$ref" : "#/definitions/RemoteProcessGroupContentsDTO" - } - } - }, - "RemoteProcessGroupEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "component" : { - "$ref" : "#/definitions/RemoteProcessGroupDTO" - }, - "status" : { - "description" : "The status of the remote process group.", - "$ref" : "#/definitions/RemoteProcessGroupStatusDTO" - }, - "inputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of remote input ports currently available on the target." - }, - "outputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of remote output ports currently available on the target." - } - }, - "xml" : { - "name" : "remoteProcessGroupEntity" - } - }, - "RemoteProcessGroupPortDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the port." - }, - "targetId" : { - "type" : "string", - "description" : "The id of the target port." - }, - "versionedComponentId" : { - "type" : "string", - "description" : "The ID of the corresponding component that is under version control" - }, - "groupId" : { - "type" : "string", - "description" : "The id of the remote process group that the port resides in." - }, - "name" : { - "type" : "string", - "description" : "The name of the target port." - }, - "comments" : { - "type" : "string", - "description" : "The comments as configured on the target port." - }, - "concurrentlySchedulableTaskCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of task that may transmit flowfiles to the target port concurrently." - }, - "transmitting" : { - "type" : "boolean", - "description" : "Whether the remote port is configured for transmission." - }, - "useCompression" : { - "type" : "boolean", - "description" : "Whether the flowfiles are compressed when sent to the target port." - }, - "exists" : { - "type" : "boolean", - "description" : "Whether the target port exists." - }, - "targetRunning" : { - "type" : "boolean", - "description" : "Whether the target port is running." - }, - "connected" : { - "type" : "boolean", - "description" : "Whether the port has either an incoming or outgoing connection." - }, - "batchSettings" : { - "description" : "The batch settings for data transmission.", - "$ref" : "#/definitions/BatchSettingsDTO" - } - } - }, - "RemoteProcessGroupPortEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "remoteProcessGroupPort" : { - "$ref" : "#/definitions/RemoteProcessGroupPortDTO" - } - }, - "xml" : { - "name" : "remoteProcessGroupPortEntity" - } - }, - "RemoteProcessGroupStatusDTO" : { - "type" : "object", - "properties" : { - "groupId" : { - "type" : "string", - "description" : "The unique ID of the process group that the Processor belongs to" - }, - "id" : { - "type" : "string", - "description" : "The unique ID of the Processor" - }, - "name" : { - "type" : "string", - "description" : "The name of the remote process group." - }, - "targetUri" : { - "type" : "string", - "description" : "The URI of the target system." - }, - "transmissionStatus" : { - "type" : "string", - "description" : "The transmission status of the remote process group." - }, - "statsLastRefreshed" : { - "type" : "string", - "description" : "The time the status for the process group was last refreshed." - }, - "aggregateSnapshot" : { - "description" : "A status snapshot that represents the aggregate stats of all nodes in the cluster. If the NiFi instance is a standalone instance, rather than a cluster, this represents the stats of the single instance.", - "$ref" : "#/definitions/RemoteProcessGroupStatusSnapshotDTO" - }, - "nodeSnapshots" : { - "type" : "array", - "description" : "A status snapshot for each node in the cluster. If the NiFi instance is a standalone instance, rather than a cluster, this may be null.", - "items" : { - "$ref" : "#/definitions/NodeRemoteProcessGroupStatusSnapshotDTO" - } - } - } - }, - "RemoteProcessGroupStatusEntity" : { - "type" : "object", - "properties" : { - "remoteProcessGroupStatus" : { - "$ref" : "#/definitions/RemoteProcessGroupStatusDTO" - }, - "canRead" : { - "type" : "boolean", - "description" : "Indicates whether the user can read a given resource.", - "readOnly" : true - } - }, - "xml" : { - "name" : "remoteProcessGroupStatusEntity" - } - }, - "RemoteProcessGroupStatusSnapshotDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the remote process group." - }, - "groupId" : { - "type" : "string", - "description" : "The id of the parent process group the remote process group resides in." - }, - "name" : { - "type" : "string", - "description" : "The name of the remote process group." - }, - "targetUri" : { - "type" : "string", - "description" : "The URI of the target system." - }, - "transmissionStatus" : { - "type" : "string", - "description" : "The transmission status of the remote process group." - }, - "activeThreadCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of active threads for the remote process group." - }, - "flowFilesSent" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of FlowFiles sent to the remote process group in the last 5 minutes." - }, - "bytesSent" : { - "type" : "integer", - "format" : "int64", - "description" : "The size of the FlowFiles sent to the remote process group in the last 5 minutes." - }, - "sent" : { - "type" : "string", - "description" : "The count/size of the flowfiles sent to the remote process group in the last 5 minutes." - }, - "flowFilesReceived" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of FlowFiles received from the remote process group in the last 5 minutes." - }, - "bytesReceived" : { - "type" : "integer", - "format" : "int64", - "description" : "The size of the FlowFiles received from the remote process group in the last 5 minutes." - }, - "received" : { - "type" : "string", - "description" : "The count/size of the flowfiles received from the remote process group in the last 5 minutes." - } - } - }, - "RemoteProcessGroupStatusSnapshotEntity" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the remote process group." - }, - "remoteProcessGroupStatusSnapshot" : { - "$ref" : "#/definitions/RemoteProcessGroupStatusSnapshotDTO" - }, - "canRead" : { - "type" : "boolean", - "description" : "Indicates whether the user can read a given resource.", - "readOnly" : true - } - }, - "xml" : { - "name" : "entity" - } - }, - "RemoteProcessGroupsEntity" : { - "type" : "object", - "properties" : { - "remoteProcessGroups" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/RemoteProcessGroupEntity" - } - } - }, - "xml" : { - "name" : "remoteProcessGroupsEntity" - } - }, - "ReportingTaskDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "versionedComponentId" : { - "type" : "string", - "description" : "The ID of the corresponding component that is under version control" - }, - "parentGroupId" : { - "type" : "string", - "description" : "The id of parent process group of this component if applicable." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "name" : { - "type" : "string", - "description" : "The name of the reporting task." - }, - "type" : { - "type" : "string", - "description" : "The fully qualified type of the reporting task." - }, - "bundle" : { - "description" : "The details of the artifact that bundled this processor type.", - "$ref" : "#/definitions/BundleDTO" - }, - "state" : { - "type" : "string", - "description" : "The state of the reporting task.", - "enum" : [ "RUNNING", "STOPPED", "DISABLED" ] - }, - "comments" : { - "type" : "string", - "description" : "The comments of the reporting task." - }, - "persistsState" : { - "type" : "boolean", - "description" : "Whether the reporting task persists state." - }, - "restricted" : { - "type" : "boolean", - "description" : "Whether the reporting task requires elevated privileges." - }, - "deprecated" : { - "type" : "boolean", - "description" : "Whether the reporting task has been deprecated." - }, - "multipleVersionsAvailable" : { - "type" : "boolean", - "description" : "Whether the reporting task has multiple versions available." - }, - "schedulingPeriod" : { - "type" : "string", - "description" : "The frequency with which to schedule the reporting task. The format of the value willd epend on the valud of the schedulingStrategy." - }, - "schedulingStrategy" : { - "type" : "string", - "description" : "The scheduling strategy that determines how the schedulingPeriod value should be interpreted." - }, - "defaultSchedulingPeriod" : { - "type" : "object", - "description" : "The default scheduling period for the different scheduling strategies.", - "additionalProperties" : { - "type" : "string" - } - }, - "properties" : { - "type" : "object", - "description" : "The properties of the reporting task.", - "additionalProperties" : { - "type" : "string" - } - }, - "descriptors" : { - "type" : "object", - "description" : "The descriptors for the reporting tasks properties.", - "additionalProperties" : { - "$ref" : "#/definitions/PropertyDescriptorDTO" - } - }, - "customUiUrl" : { - "type" : "string", - "description" : "The URL for the custom configuration UI for the reporting task." - }, - "annotationData" : { - "type" : "string", - "description" : "The annotation data for the repoting task. This is how the custom UI relays configuration to the reporting task." - }, - "validationErrors" : { - "type" : "array", - "description" : "Gets the validation errors from the reporting task. These validation errors represent the problems with the reporting task that must be resolved before it can be scheduled to run.", - "items" : { - "type" : "string" - } - }, - "validationStatus" : { - "type" : "string", - "description" : "Indicates whether the Processor is valid, invalid, or still in the process of validating (i.e., it is unknown whether or not the Processor is valid)", - "readOnly" : true, - "enum" : [ "VALID", "INVALID", "VALIDATING" ] - }, - "activeThreadCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of active threads for the reporting task." - }, - "extensionMissing" : { - "type" : "boolean", - "description" : "Whether the underlying extension is missing." - } - } - }, - "ReportingTaskEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "component" : { - "$ref" : "#/definitions/ReportingTaskDTO" - } - }, - "xml" : { - "name" : "reportingTaskEntity" - } - }, - "ReportingTaskTypesEntity" : { - "type" : "object", - "properties" : { - "reportingTaskTypes" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/DocumentedTypeDTO" - } - } - }, - "xml" : { - "name" : "reportingTaskTypesEntity" - } - }, - "ReportingTasksEntity" : { - "type" : "object", - "properties" : { - "reportingTasks" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ReportingTaskEntity" - } - } - }, - "xml" : { - "name" : "reportingTasksEntity" - } - }, - "RequiredPermissionDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The required sub-permission necessary for this restriction." - }, - "label" : { - "type" : "string", - "description" : "The label for the required sub-permission necessary for this restriction." - } - } - }, - "ResourceDTO" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The identifier of the resource." - }, - "name" : { - "type" : "string", - "description" : "The name of the resource." - } - } - }, - "ResourcesEntity" : { - "type" : "object", - "properties" : { - "resources" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/ResourceDTO" - } - } - }, - "xml" : { - "name" : "resourcesEntity" - } - }, - "RevisionDTO" : { - "type" : "object", - "properties" : { - "clientId" : { - "type" : "string", - "description" : "A client identifier used to make a request. By including a client identifier, the API can allow multiple requests without needing the current revision. Due to the asynchronous nature of requests/responses this was implemented to allow the client to make numerous requests without having to wait for the previous response to come back" - }, - "version" : { - "type" : "integer", - "format" : "int64", - "description" : "NiFi employs an optimistic locking strategy where the client must include a revision in their request when performing an update. In a response to a mutable flow request, this field represents the updated base version." - }, - "lastModifier" : { - "type" : "string", - "description" : "The user that last modified the flow.", - "readOnly" : true - } - } - }, - "ScheduleComponentsEntity" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the ProcessGroup" - }, - "state" : { - "type" : "string", - "description" : "The desired state of the descendant components", - "enum" : [ "RUNNING", "STOPPED", "ENABLED", "DISABLED" ] - }, - "components" : { - "type" : "object", - "description" : "Optional components to schedule. If not specified, all authorized descendant components will be used.", - "additionalProperties" : { - "$ref" : "#/definitions/RevisionDTO" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - } - }, - "xml" : { - "name" : "scheduleComponentEntity" - } - }, - "SearchResultGroupDTO" : { - "type" : "object", - "required" : [ "id" ], - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the group." - }, - "name" : { - "type" : "string", - "description" : "The name of the group." - } - } - }, - "SearchResultsDTO" : { - "type" : "object", - "properties" : { - "processorResults" : { - "type" : "array", - "description" : "The processors that matched the search.", - "items" : { - "$ref" : "#/definitions/ComponentSearchResultDTO" - } - }, - "connectionResults" : { - "type" : "array", - "description" : "The connections that matched the search.", - "items" : { - "$ref" : "#/definitions/ComponentSearchResultDTO" - } - }, - "processGroupResults" : { - "type" : "array", - "description" : "The process groups that matched the search.", - "items" : { - "$ref" : "#/definitions/ComponentSearchResultDTO" - } - }, - "inputPortResults" : { - "type" : "array", - "description" : "The input ports that matched the search.", - "items" : { - "$ref" : "#/definitions/ComponentSearchResultDTO" - } - }, - "outputPortResults" : { - "type" : "array", - "description" : "The output ports that matched the search.", - "items" : { - "$ref" : "#/definitions/ComponentSearchResultDTO" - } - }, - "remoteProcessGroupResults" : { - "type" : "array", - "description" : "The remote process groups that matched the search.", - "items" : { - "$ref" : "#/definitions/ComponentSearchResultDTO" - } - }, - "funnelResults" : { - "type" : "array", - "description" : "The funnels that matched the search.", - "items" : { - "$ref" : "#/definitions/ComponentSearchResultDTO" - } - } - } - }, - "SearchResultsEntity" : { - "type" : "object", - "properties" : { - "searchResultsDTO" : { - "$ref" : "#/definitions/SearchResultsDTO" - } - }, - "xml" : { - "name" : "searchResultsEntity" - } - }, - "SnippetDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the snippet." - }, - "uri" : { - "type" : "string", - "description" : "The URI of the snippet." - }, - "parentGroupId" : { - "type" : "string", - "description" : "The group id for the components in the snippet." - }, - "processGroups" : { - "type" : "object", - "description" : "The ids of the process groups in this snippet. These ids will be populated within each response. They can be specified when creating a snippet. However, once a snippet has been created its contents cannot be modified (these ids are ignored during update requests).", - "additionalProperties" : { - "$ref" : "#/definitions/RevisionDTO" - } - }, - "remoteProcessGroups" : { - "type" : "object", - "description" : "The ids of the remote process groups in this snippet. These ids will be populated within each response. They can be specified when creating a snippet. However, once a snippet has been created its contents cannot be modified (these ids are ignored during update requests).", - "additionalProperties" : { - "$ref" : "#/definitions/RevisionDTO" - } - }, - "processors" : { - "type" : "object", - "description" : "The ids of the processors in this snippet. These ids will be populated within each response. They can be specified when creating a snippet. However, once a snippet has been created its contents cannot be modified (these ids are ignored during update requests).", - "additionalProperties" : { - "$ref" : "#/definitions/RevisionDTO" - } - }, - "inputPorts" : { - "type" : "object", - "description" : "The ids of the input ports in this snippet. These ids will be populated within each response. They can be specified when creating a snippet. However, once a snippet has been created its contents cannot be modified (these ids are ignored during update requests).", - "additionalProperties" : { - "$ref" : "#/definitions/RevisionDTO" - } - }, - "outputPorts" : { - "type" : "object", - "description" : "The ids of the output ports in this snippet. These ids will be populated within each response. They can be specified when creating a snippet. However, once a snippet has been created its contents cannot be modified (these ids are ignored during update requests).", - "additionalProperties" : { - "$ref" : "#/definitions/RevisionDTO" - } - }, - "connections" : { - "type" : "object", - "description" : "The ids of the connections in this snippet. These ids will be populated within each response. They can be specified when creating a snippet. However, once a snippet has been created its contents cannot be modified (these ids are ignored during update requests).", - "additionalProperties" : { - "$ref" : "#/definitions/RevisionDTO" - } - }, - "labels" : { - "type" : "object", - "description" : "The ids of the labels in this snippet. These ids will be populated within each response. They can be specified when creating a snippet. However, once a snippet has been created its contents cannot be modified (these ids are ignored during update requests).", - "additionalProperties" : { - "$ref" : "#/definitions/RevisionDTO" - } - }, - "funnels" : { - "type" : "object", - "description" : "The ids of the funnels in this snippet. These ids will be populated within each response. They can be specified when creating a snippet. However, once a snippet has been created its contents cannot be modified (these ids are ignored during update requests).", - "additionalProperties" : { - "$ref" : "#/definitions/RevisionDTO" - } - } - } - }, - "SnippetEntity" : { - "type" : "object", - "properties" : { - "snippet" : { - "description" : "The snippet.", - "$ref" : "#/definitions/SnippetDTO" - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - } - }, - "xml" : { - "name" : "snippetEntity" - } - }, - "StartVersionControlRequestEntity" : { - "type" : "object", - "properties" : { - "versionedFlow" : { - "description" : "The versioned flow", - "$ref" : "#/definitions/VersionedFlowDTO" - }, - "processGroupRevision" : { - "description" : "The Revision of the Process Group under Version Control", - "$ref" : "#/definitions/RevisionDTO" - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - } - }, - "xml" : { - "name" : "startVersionControlRequestEntity" - } - }, - "StateEntryDTO" : { - "type" : "object", - "properties" : { - "key" : { - "type" : "string", - "description" : "The key for this state." - }, - "value" : { - "type" : "string", - "description" : "The value for this state." - }, - "clusterNodeId" : { - "type" : "string", - "description" : "The identifier for the node where the state originated." - }, - "clusterNodeAddress" : { - "type" : "string", - "description" : "The label for the node where the state originated." - } - } - }, - "StateMapDTO" : { - "type" : "object", - "properties" : { - "scope" : { - "type" : "string", - "description" : "The scope of this StateMap." - }, - "totalEntryCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The total number of state entries. When the state map is lengthy, only of portion of the entries are returned." - }, - "state" : { - "type" : "array", - "description" : "The state.", - "items" : { - "$ref" : "#/definitions/StateEntryDTO" - } - } - } - }, - "StatusDescriptorDTO" : { - "type" : "object", - "properties" : { - "field" : { - "type" : "string", - "description" : "The name of the status field." - }, - "label" : { - "type" : "string", - "description" : "The label for the status field." - }, - "description" : { - "type" : "string", - "description" : "The description of the status field." - }, - "formatter" : { - "type" : "string", - "description" : "The formatter for the status descriptor." - } - } - }, - "StatusHistoryDTO" : { - "type" : "object", - "properties" : { - "generated" : { - "type" : "string", - "description" : "When the status history was generated." - }, - "componentDetails" : { - "type" : "object", - "description" : "A Map of key/value pairs that describe the component that the status history belongs to", - "additionalProperties" : { - "type" : "string" - } - }, - "fieldDescriptors" : { - "type" : "array", - "description" : "The Descriptors that provide information on each of the metrics provided in the status history", - "items" : { - "$ref" : "#/definitions/StatusDescriptorDTO" - } - }, - "aggregateSnapshots" : { - "type" : "array", - "description" : "A list of StatusSnapshotDTO objects that provide the actual metric values for the component. If the NiFi instance is clustered, this will represent the aggregate status across all nodes. If the NiFi instance is not clustered, this will represent the status of the entire NiFi instance.", - "items" : { - "$ref" : "#/definitions/StatusSnapshotDTO" - } - }, - "nodeSnapshots" : { - "type" : "array", - "description" : "The NodeStatusSnapshotsDTO objects that provide the actual metric values for the component, for each node. If the NiFi instance is not clustered, this value will be null.", - "items" : { - "$ref" : "#/definitions/NodeStatusSnapshotsDTO" - } - } - } - }, - "StatusHistoryEntity" : { - "type" : "object", - "properties" : { - "statusHistory" : { - "$ref" : "#/definitions/StatusHistoryDTO" - }, - "canRead" : { - "type" : "boolean", - "description" : "Indicates whether the user can read a given resource.", - "readOnly" : true - } - }, - "xml" : { - "name" : "statusHistoryEntity" - } - }, - "StatusSnapshotDTO" : { - "type" : "object", - "properties" : { - "timestamp" : { - "type" : "string", - "format" : "date-time", - "description" : "The timestamp of the snapshot." - }, - "statusMetrics" : { - "type" : "object", - "description" : "The status metrics.", - "additionalProperties" : { - "type" : "integer", - "format" : "int64" - } - } - } - }, - "StorageUsageDTO" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The identifier of this storage location. The identifier will correspond to the identifier keyed in the storage configuration." - }, - "freeSpace" : { - "type" : "string", - "description" : "Amount of free space." - }, - "totalSpace" : { - "type" : "string", - "description" : "Amount of total space." - }, - "usedSpace" : { - "type" : "string", - "description" : "Amount of used space." - }, - "freeSpaceBytes" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes of free space." - }, - "totalSpaceBytes" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes of total space." - }, - "usedSpaceBytes" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes of used space." - }, - "utilization" : { - "type" : "string", - "description" : "Utilization of this storage location." - } - } - }, - "StreamingOutput" : { - "type" : "object" - }, - "SubmitReplayRequestEntity" : { - "type" : "object", - "properties" : { - "eventId" : { - "type" : "integer", - "format" : "int64", - "description" : "The event identifier" - }, - "clusterNodeId" : { - "type" : "string", - "description" : "The identifier of the node where to submit the replay request." - } - }, - "xml" : { - "name" : "copySnippetRequestEntity" - } - }, - "SystemDiagnosticsDTO" : { - "type" : "object", - "properties" : { - "aggregateSnapshot" : { - "description" : "A systems diagnostic snapshot that represents the aggregate values of all nodes in the cluster. If the NiFi instance is a standalone instance, rather than a cluster, this represents the stats of the single instance.", - "$ref" : "#/definitions/SystemDiagnosticsSnapshotDTO" - }, - "nodeSnapshots" : { - "type" : "array", - "description" : "A systems diagnostics snapshot for each node in the cluster. If the NiFi instance is a standalone instance, rather than a cluster, this may be null.", - "items" : { - "$ref" : "#/definitions/NodeSystemDiagnosticsSnapshotDTO" - } - } - } - }, - "SystemDiagnosticsEntity" : { - "type" : "object", - "properties" : { - "systemDiagnostics" : { - "$ref" : "#/definitions/SystemDiagnosticsDTO" - } - }, - "xml" : { - "name" : "systemDiagnosticsEntity" - } - }, - "SystemDiagnosticsSnapshotDTO" : { - "type" : "object", - "properties" : { - "totalNonHeap" : { - "type" : "string", - "description" : "Total size of non heap." - }, - "totalNonHeapBytes" : { - "type" : "integer", - "format" : "int64", - "description" : "Total number of bytes allocated to the JVM not used for heap" - }, - "usedNonHeap" : { - "type" : "string", - "description" : "Amount of use non heap." - }, - "usedNonHeapBytes" : { - "type" : "integer", - "format" : "int64", - "description" : "Total number of bytes used by the JVM not in the heap space" - }, - "freeNonHeap" : { - "type" : "string", - "description" : "Amount of free non heap." - }, - "freeNonHeapBytes" : { - "type" : "integer", - "format" : "int64", - "description" : "Total number of free non-heap bytes available to the JVM" - }, - "maxNonHeap" : { - "type" : "string", - "description" : "Maximum size of non heap." - }, - "maxNonHeapBytes" : { - "type" : "integer", - "format" : "int64", - "description" : "The maximum number of bytes that the JVM can use for non-heap purposes" - }, - "nonHeapUtilization" : { - "type" : "string", - "description" : "Utilization of non heap." - }, - "totalHeap" : { - "type" : "string", - "description" : "Total size of heap." - }, - "totalHeapBytes" : { - "type" : "integer", - "format" : "int64", - "description" : "The total number of bytes that are available for the JVM heap to use" - }, - "usedHeap" : { - "type" : "string", - "description" : "Amount of used heap." - }, - "usedHeapBytes" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes of JVM heap that are currently being used" - }, - "freeHeap" : { - "type" : "string", - "description" : "Amount of free heap." - }, - "freeHeapBytes" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes that are allocated to the JVM heap but not currently being used" - }, - "maxHeap" : { - "type" : "string", - "description" : "Maximum size of heap." - }, - "maxHeapBytes" : { - "type" : "integer", - "format" : "int64", - "description" : "The maximum number of bytes that can be used by the JVM" - }, - "heapUtilization" : { - "type" : "string", - "description" : "Utilization of heap." - }, - "availableProcessors" : { - "type" : "integer", - "format" : "int32", - "description" : "Number of available processors if supported by the underlying system." - }, - "processorLoadAverage" : { - "type" : "number", - "format" : "double", - "description" : "The processor load average if supported by the underlying system." - }, - "totalThreads" : { - "type" : "integer", - "format" : "int32", - "description" : "Total number of threads." - }, - "daemonThreads" : { - "type" : "integer", - "format" : "int32", - "description" : "Number of daemon threads." - }, - "uptime" : { - "type" : "string", - "description" : "The uptime of the Java virtual machine" - }, - "flowFileRepositoryStorageUsage" : { - "description" : "The flowfile repository storage usage.", - "$ref" : "#/definitions/StorageUsageDTO" - }, - "contentRepositoryStorageUsage" : { - "type" : "array", - "description" : "The content repository storage usage.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/StorageUsageDTO" - } - }, - "provenanceRepositoryStorageUsage" : { - "type" : "array", - "description" : "The provenance repository storage usage.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/StorageUsageDTO" - } - }, - "garbageCollection" : { - "type" : "array", - "description" : "The garbage collection details.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/GarbageCollectionDTO" - } - }, - "statsLastRefreshed" : { - "type" : "string", - "description" : "When the diagnostics were generated." - }, - "versionInfo" : { - "description" : "The nifi, os, java, and build version information", - "$ref" : "#/definitions/VersionInfoDTO" - } - } - }, - "TemplateDTO" : { - "type" : "object", - "properties" : { - "uri" : { - "type" : "string", - "description" : "The URI for the template." - }, - "id" : { - "type" : "string", - "description" : "The id of the template." - }, - "groupId" : { - "type" : "string", - "description" : "The id of the Process Group that the template belongs to." - }, - "name" : { - "type" : "string", - "description" : "The name of the template." - }, - "description" : { - "type" : "string", - "description" : "The description of the template." - }, - "timestamp" : { - "type" : "string", - "description" : "The timestamp when this template was created." - }, - "encodingVersion" : { - "type" : "string", - "xml" : { - "name" : "encoding-version", - "attribute" : true - }, - "description" : "The encoding version of this template." - }, - "snippet" : { - "description" : "The contents of the template.", - "$ref" : "#/definitions/FlowSnippetDTO" - } - }, - "xml" : { - "name" : "template" - } - }, - "TemplateEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "template" : { - "$ref" : "#/definitions/TemplateDTO" - } - }, - "xml" : { - "name" : "templateEntity" - } - }, - "TemplatesEntity" : { - "type" : "object", - "properties" : { - "templates" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/TemplateEntity" - } - }, - "generated" : { - "type" : "string", - "description" : "When this content was generated." - } - }, - "xml" : { - "name" : "templatesEntity" - } - }, - "TenantDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "versionedComponentId" : { - "type" : "string", - "description" : "The ID of the corresponding component that is under version control" - }, - "parentGroupId" : { - "type" : "string", - "description" : "The id of parent process group of this component if applicable." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "identity" : { - "type" : "string", - "description" : "The identity of the tenant." - }, - "configurable" : { - "type" : "boolean", - "description" : "Whether this tenant is configurable." - } - } - }, - "TenantEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "component" : { - "$ref" : "#/definitions/TenantDTO" - } - }, - "xml" : { - "name" : "tenantEntity" - } - }, - "TenantsEntity" : { - "type" : "object", - "properties" : { - "users" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/TenantEntity" - } - }, - "userGroups" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/TenantEntity" - } - } - }, - "xml" : { - "name" : "tenantsEntity" - } - }, - "TransactionResultEntity" : { - "type" : "object", - "properties" : { - "flowFileSent" : { - "type" : "integer", - "format" : "int32" - }, - "responseCode" : { - "type" : "integer", - "format" : "int32" - }, - "message" : { - "type" : "string" - } - }, - "xml" : { - "name" : "transactionResultEntity" - } - }, - "UpdateControllerServiceReferenceRequestEntity" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The identifier of the Controller Service." - }, - "state" : { - "type" : "string", - "description" : "The new state of the references for the controller service.", - "enum" : [ "ENABLED", "DISABLED", "RUNNING", "STOPPED" ] - }, - "referencingComponentRevisions" : { - "type" : "object", - "description" : "The revisions for all referencing components.", - "additionalProperties" : { - "$ref" : "#/definitions/RevisionDTO" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - } - }, - "xml" : { - "name" : "updateControllerServiceReferenceRequestEntity" - } - }, - "UriBuilder" : { - "type" : "object" - }, - "UserDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "versionedComponentId" : { - "type" : "string", - "description" : "The ID of the corresponding component that is under version control" - }, - "parentGroupId" : { - "type" : "string", - "description" : "The id of parent process group of this component if applicable." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "identity" : { - "type" : "string", - "description" : "The identity of the tenant." - }, - "configurable" : { - "type" : "boolean", - "description" : "Whether this tenant is configurable." - }, - "userGroups" : { - "type" : "array", - "description" : "The groups to which the user belongs. This field is read only and it provided for convenience.", - "readOnly" : true, - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/TenantEntity" - } - }, - "accessPolicies" : { - "type" : "array", - "description" : "The access policies this user belongs to.", - "readOnly" : true, - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/AccessPolicySummaryEntity" - } - } - } - }, - "UserEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "component" : { - "$ref" : "#/definitions/UserDTO" - } - }, - "xml" : { - "name" : "userEntity" - } - }, - "UserGroupDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "versionedComponentId" : { - "type" : "string", - "description" : "The ID of the corresponding component that is under version control" - }, - "parentGroupId" : { - "type" : "string", - "description" : "The id of parent process group of this component if applicable." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "identity" : { - "type" : "string", - "description" : "The identity of the tenant." - }, - "configurable" : { - "type" : "boolean", - "description" : "Whether this tenant is configurable." - }, - "users" : { - "type" : "array", - "description" : "The users that belong to the user group.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/TenantEntity" - } - }, - "accessPolicies" : { - "type" : "array", - "description" : "The access policies this user group belongs to. This field was incorrectly defined as an AccessPolicyEntity. For compatibility reasons the field will remain of this type, however only the fields that are present in the AccessPolicySummaryEntity will be populated here.", - "readOnly" : true, - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/AccessPolicyEntity" - } - } - } - }, - "UserGroupEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "component" : { - "$ref" : "#/definitions/UserGroupDTO" - } - }, - "xml" : { - "name" : "userGroupEntity" - } - }, - "UserGroupsEntity" : { - "type" : "object", - "properties" : { - "userGroups" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/UserGroupEntity" - } - } - }, - "xml" : { - "name" : "userGroupsEntity" - } - }, - "UsersEntity" : { - "type" : "object", - "properties" : { - "generated" : { - "type" : "string", - "description" : "When this content was generated." - }, - "users" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/UserEntity" - } - } - }, - "xml" : { - "name" : "usersEntity" - } - }, - "VariableDTO" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The name of the variable" - }, - "value" : { - "type" : "string", - "description" : "The value of the variable" - }, - "processGroupId" : { - "type" : "string", - "description" : "The ID of the Process Group where this Variable is defined", - "readOnly" : true - }, - "affectedComponents" : { - "type" : "array", - "description" : "A set of all components that will be affected if the value of this variable is changed", - "readOnly" : true, - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/AffectedComponentEntity" - } - } - } - }, - "VariableEntity" : { - "type" : "object", - "properties" : { - "variable" : { - "description" : "The variable information", - "$ref" : "#/definitions/VariableDTO" - }, - "canWrite" : { - "type" : "boolean", - "description" : "Indicates whether the user can write a given resource.", - "readOnly" : true - } - }, - "xml" : { - "name" : "variableEntity" - } - }, - "VariableRegistryDTO" : { - "type" : "object", - "properties" : { - "variables" : { - "type" : "array", - "description" : "The variables that are available in this Variable Registry", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VariableEntity" - } - }, - "processGroupId" : { - "type" : "string", - "description" : "The UUID of the Process Group that this Variable Registry belongs to" - } - } - }, - "VariableRegistryEntity" : { - "type" : "object", - "properties" : { - "processGroupRevision" : { - "description" : "The revision of the Process Group that the Variable Registry belongs to", - "$ref" : "#/definitions/RevisionDTO" - }, - "variableRegistry" : { - "description" : "The Variable Registry.", - "$ref" : "#/definitions/VariableRegistryDTO" - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - } - }, - "xml" : { - "name" : "variableRegistryEntity" - } - }, - "VariableRegistryUpdateRequestDTO" : { - "type" : "object", - "properties" : { - "requestId" : { - "type" : "string", - "description" : "The unique ID of this request.", - "readOnly" : true - }, - "processGroupId" : { - "type" : "string", - "description" : "The unique ID of the Process Group that the variable registry belongs to" - }, - "uri" : { - "type" : "string", - "description" : "The URI for future requests to this drop request.", - "readOnly" : true - }, - "submissionTime" : { - "type" : "string", - "description" : "The time at which this request was submitted.", - "readOnly" : true - }, - "lastUpdated" : { - "type" : "string", - "description" : "The last time this request was updated.", - "readOnly" : true - }, - "complete" : { - "type" : "boolean", - "description" : "Whether or not this request has completed", - "readOnly" : true - }, - "failureReason" : { - "type" : "string", - "description" : "An explanation of why this request failed, or null if this request has not failed", - "readOnly" : true - }, - "updateSteps" : { - "type" : "array", - "description" : "The steps that are required in order to complete the request, along with the status of each", - "readOnly" : true, - "items" : { - "$ref" : "#/definitions/VariableRegistryUpdateStepDTO" - } - }, - "affectedComponents" : { - "type" : "array", - "description" : "A set of all components that will be affected if the value of this variable is changed", - "readOnly" : true, - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/AffectedComponentEntity" - } - } - } - }, - "VariableRegistryUpdateRequestEntity" : { - "type" : "object", - "properties" : { - "request" : { - "description" : "The Variable Registry Update Request", - "$ref" : "#/definitions/VariableRegistryUpdateRequestDTO" - }, - "processGroupRevision" : { - "description" : "The revision for the Process Group that owns this variable registry.", - "$ref" : "#/definitions/RevisionDTO" - } - }, - "xml" : { - "name" : "variableRegistryUpdateRequestEntity" - } - }, - "VariableRegistryUpdateStepDTO" : { - "type" : "object", - "properties" : { - "description" : { - "type" : "string", - "description" : "Explanation of what happens in this step", - "readOnly" : true - }, - "complete" : { - "type" : "boolean", - "description" : "Whether or not this step has completed", - "readOnly" : true - }, - "failureReason" : { - "type" : "string", - "description" : "An explanation of why this step failed, or null if this step did not fail", - "readOnly" : true - } - } - }, - "VersionControlComponentMappingEntity" : { - "type" : "object", - "properties" : { - "versionControlComponentMapping" : { - "type" : "object", - "description" : "The mapping of Versioned Component Identifiers to instance ID's", - "additionalProperties" : { - "type" : "string" - } - }, - "processGroupRevision" : { - "description" : "The revision of the Process Group", - "$ref" : "#/definitions/RevisionDTO" - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "versionControlInformation" : { - "description" : "The Version Control information", - "$ref" : "#/definitions/VersionControlInformationDTO" - } - }, - "xml" : { - "name" : "versionControlComponentMappingEntity" - } - }, - "VersionControlInformationDTO" : { - "type" : "object", - "properties" : { - "groupId" : { - "type" : "string", - "description" : "The ID of the Process Group that is under version control" - }, - "registryId" : { - "type" : "string", - "description" : "The ID of the registry that the flow is stored in" - }, - "registryName" : { - "type" : "string", - "description" : "The name of the registry that the flow is stored in", - "readOnly" : true - }, - "bucketId" : { - "type" : "string", - "description" : "The ID of the bucket that the flow is stored in" - }, - "bucketName" : { - "type" : "string", - "description" : "The name of the bucket that the flow is stored in", - "readOnly" : true - }, - "flowId" : { - "type" : "string", - "description" : "The ID of the flow" - }, - "flowName" : { - "type" : "string", - "description" : "The name of the flow" - }, - "flowDescription" : { - "type" : "string", - "description" : "The description of the flow" - }, - "version" : { - "type" : "integer", - "format" : "int32", - "description" : "The version of the flow" - }, - "state" : { - "type" : "string", - "description" : "The current state of the Process Group, as it relates to the Versioned Flow", - "readOnly" : true, - "enum" : [ "LOCALLY_MODIFIED", "STALE", "LOCALLY_MODIFIED_AND_STALE", "UP_TO_DATE", "SYNC_FAILURE" ] - }, - "stateExplanation" : { - "type" : "string", - "description" : "Explanation of why the group is in the specified state", - "readOnly" : true - } - } - }, - "VersionControlInformationEntity" : { - "type" : "object", - "properties" : { - "versionControlInformation" : { - "description" : "The Version Control information", - "$ref" : "#/definitions/VersionControlInformationDTO" - }, - "processGroupRevision" : { - "description" : "The Revision for the Process Group", - "$ref" : "#/definitions/RevisionDTO" - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - } - }, - "xml" : { - "name" : "versionControlInformationEntity" - } - }, - "VersionInfoDTO" : { - "type" : "object", - "properties" : { - "niFiVersion" : { - "type" : "string", - "description" : "The version of this NiFi." - }, - "javaVendor" : { - "type" : "string", - "description" : "Java JVM vendor" - }, - "javaVersion" : { - "type" : "string", - "description" : "Java version" - }, - "osName" : { - "type" : "string", - "description" : "Host operating system name" - }, - "osVersion" : { - "type" : "string", - "description" : "Host operating system version" - }, - "osArchitecture" : { - "type" : "string", - "description" : "Host operating system architecture" - }, - "buildTag" : { - "type" : "string", - "description" : "Build tag" - }, - "buildRevision" : { - "type" : "string", - "description" : "Build revision or commit hash" - }, - "buildBranch" : { - "type" : "string", - "description" : "Build branch" - }, - "buildTimestamp" : { - "type" : "string", - "format" : "date-time", - "description" : "Build timestamp" - } - } - }, - "VersionedConnection" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The component's unique identifier" - }, - "name" : { - "type" : "string", - "description" : "The component's name" - }, - "comments" : { - "type" : "string", - "description" : "The user-supplied comments for the component" - }, - "position" : { - "description" : "The component's position on the graph", - "$ref" : "#/definitions/Position" - }, - "source" : { - "description" : "The source of the connection.", - "$ref" : "#/definitions/ConnectableComponent" - }, - "destination" : { - "description" : "The destination of the connection.", - "$ref" : "#/definitions/ConnectableComponent" - }, - "labelIndex" : { - "type" : "integer", - "format" : "int32", - "description" : "The index of the bend point where to place the connection label." - }, - "zIndex" : { - "type" : "integer", - "format" : "int64", - "description" : "The z index of the connection." - }, - "selectedRelationships" : { - "type" : "array", - "description" : "The selected relationship that comprise the connection.", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - }, - "backPressureObjectThreshold" : { - "type" : "integer", - "format" : "int64", - "description" : "The object count threshold for determining when back pressure is applied. Updating this value is a passive change in the sense that it won't impact whether existing files over the limit are affected but it does help feeder processors to stop pushing too much into this work queue." - }, - "backPressureDataSizeThreshold" : { - "type" : "string", - "description" : "The object data size threshold for determining when back pressure is applied. Updating this value is a passive change in the sense that it won't impact whether existing files over the limit are affected but it does help feeder processors to stop pushing too much into this work queue." - }, - "flowFileExpiration" : { - "type" : "string", - "description" : "The amount of time a flow file may be in the flow before it will be automatically aged out of the flow. Once a flow file reaches this age it will be terminated from the flow the next time a processor attempts to start work on it." - }, - "prioritizers" : { - "type" : "array", - "description" : "The comparators used to prioritize the queue.", - "items" : { - "type" : "string" - } - }, - "bends" : { - "type" : "array", - "description" : "The bend points on the connection.", - "items" : { - "$ref" : "#/definitions/Position" - } - }, - "componentType" : { - "type" : "string", - "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE" ] - }, - "groupIdentifier" : { - "type" : "string", - "description" : "The ID of the Process Group that this component belongs to" - } - } - }, - "VersionedControllerService" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The component's unique identifier" - }, - "name" : { - "type" : "string", - "description" : "The component's name" - }, - "comments" : { - "type" : "string", - "description" : "The user-supplied comments for the component" - }, - "position" : { - "description" : "The component's position on the graph", - "$ref" : "#/definitions/Position" - }, - "type" : { - "type" : "string", - "description" : "The type of the controller service." - }, - "bundle" : { - "description" : "The details of the artifact that bundled this processor type.", - "$ref" : "#/definitions/Bundle" - }, - "controllerServiceApis" : { - "type" : "array", - "description" : "Lists the APIs this Controller Service implements.", - "items" : { - "$ref" : "#/definitions/ControllerServiceAPI" - } - }, - "properties" : { - "type" : "object", - "description" : "The properties of the controller service.", - "additionalProperties" : { - "type" : "string" - } - }, - "propertyDescriptors" : { - "type" : "object", - "description" : "The property descriptors for the processor.", - "additionalProperties" : { - "$ref" : "#/definitions/VersionedPropertyDescriptor" - } - }, - "annotationData" : { - "type" : "string", - "description" : "The annotation for the controller service. This is how the custom UI relays configuration to the controller service." - }, - "componentType" : { - "type" : "string", - "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE" ] - }, - "groupIdentifier" : { - "type" : "string", - "description" : "The ID of the Process Group that this component belongs to" - } - } - }, - "VersionedFlowCoordinates" : { - "type" : "object", - "properties" : { - "registryUrl" : { - "type" : "string", - "description" : "The URL of the Flow Registry that contains the flow" - }, - "bucketId" : { - "type" : "string", - "description" : "The UUID of the bucket that the flow resides in" - }, - "flowId" : { - "type" : "string", - "description" : "The UUID of the flow" - }, - "version" : { - "type" : "integer", - "format" : "int32", - "description" : "The version of the flow" - }, - "latest" : { - "type" : "boolean", - "description" : "Whether or not these coordinates point to the latest version of the flow" - } - } - }, - "VersionedFlowDTO" : { - "type" : "object", - "properties" : { - "registryId" : { - "type" : "string", - "description" : "The ID of the registry that the flow is tracked to" - }, - "bucketId" : { - "type" : "string", - "description" : "The ID of the bucket where the flow is stored" - }, - "flowId" : { - "type" : "string", - "description" : "The ID of the flow" - }, - "flowName" : { - "type" : "string", - "description" : "The name of the flow" - }, - "description" : { - "type" : "string", - "description" : "A description of the flow" - }, - "comments" : { - "type" : "string", - "description" : "Comments for the changeset" - } - } - }, - "VersionedFlowEntity" : { - "type" : "object", - "properties" : { - "versionedFlow" : { - "description" : "The versioned flow", - "$ref" : "#/definitions/VersionedFlowDTO" - } - }, - "xml" : { - "name" : "versionedFlowEntity" - } - }, - "VersionedFlowSnapshotEntity" : { - "type" : "object", - "properties" : { - "versionedFlowSnapshot" : { - "description" : "The versioned flow snapshot", - "$ref" : "#/definitions/versionedFlowSnapshot" - }, - "processGroupRevision" : { - "description" : "The Revision of the Process Group under Version Control", - "$ref" : "#/definitions/RevisionDTO" - }, - "registryId" : { - "type" : "string", - "description" : "The ID of the Registry that this flow belongs to" - }, - "updateDescendantVersionedFlows" : { - "type" : "boolean", - "description" : "If the Process Group to be updated has a child or descendant Process Group that is also under Version Control, this specifies whether or not the contents of that child/descendant Process Group should be updated." - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - } - }, - "xml" : { - "name" : "versionedFlowSnapshotEntity" - } - }, - "VersionedFlowSnapshotMetadataEntity" : { - "type" : "object", - "properties" : { - "versionedFlowSnapshotMetadata" : { - "description" : "The collection of versioned flow snapshot metadata", - "$ref" : "#/definitions/versionedFlowSnapshotMetadata" - }, - "registryId" : { - "type" : "string", - "description" : "The ID of the Registry that this flow belongs to" - } - }, - "xml" : { - "name" : "versionedFlowSnapshotMetadataEntity" - } - }, - "VersionedFlowSnapshotMetadataSetEntity" : { - "type" : "object", - "properties" : { - "versionedFlowSnapshotMetadataSet" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedFlowSnapshotMetadataEntity" - } - } - }, - "xml" : { - "name" : "versionedFlowSnapshotMetadataSetEntity" - } - }, - "VersionedFlowUpdateRequestDTO" : { - "type" : "object", - "properties" : { - "requestId" : { - "type" : "string", - "description" : "The unique ID of this request.", - "readOnly" : true - }, - "processGroupId" : { - "type" : "string", - "description" : "The unique ID of the Process Group that the variable registry belongs to" - }, - "uri" : { - "type" : "string", - "description" : "The URI for future requests to this drop request.", - "readOnly" : true - }, - "lastUpdated" : { - "type" : "string", - "description" : "The last time this request was updated.", - "readOnly" : true - }, - "complete" : { - "type" : "boolean", - "description" : "Whether or not this request has completed", - "readOnly" : true - }, - "failureReason" : { - "type" : "string", - "description" : "An explanation of why this request failed, or null if this request has not failed", - "readOnly" : true - }, - "percentCompleted" : { - "type" : "integer", - "format" : "int32", - "description" : "The percentage complete for the request, between 0 and 100", - "readOnly" : true - }, - "state" : { - "type" : "string", - "description" : "The state of the request", - "readOnly" : true - }, - "versionControlInformation" : { - "description" : "The VersionControlInformation that describes where the Versioned Flow is located; this may not be populated until the request is completed.", - "readOnly" : true, - "$ref" : "#/definitions/VersionControlInformationDTO" - } - } - }, - "VersionedFlowUpdateRequestEntity" : { - "type" : "object", - "properties" : { - "request" : { - "description" : "The Versioned Flow Update Request", - "$ref" : "#/definitions/VersionedFlowUpdateRequestDTO" - }, - "processGroupRevision" : { - "description" : "The revision for the Process Group that owns this variable registry.", - "$ref" : "#/definitions/RevisionDTO" - } - }, - "xml" : { - "name" : "versionedFlowUpdateRequestEntity" - } - }, - "VersionedFlowsEntity" : { - "type" : "object", - "properties" : { - "versionedFlows" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedFlowEntity" - } - } - }, - "xml" : { - "name" : "versionedFlowsEntity" - } - }, - "VersionedFunnel" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The component's unique identifier" - }, - "name" : { - "type" : "string", - "description" : "The component's name" - }, - "comments" : { - "type" : "string", - "description" : "The user-supplied comments for the component" - }, - "position" : { - "description" : "The component's position on the graph", - "$ref" : "#/definitions/Position" - }, - "componentType" : { - "type" : "string", - "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE" ] - }, - "groupIdentifier" : { - "type" : "string", - "description" : "The ID of the Process Group that this component belongs to" - } - } - }, - "VersionedLabel" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The component's unique identifier" - }, - "name" : { - "type" : "string", - "description" : "The component's name" - }, - "comments" : { - "type" : "string", - "description" : "The user-supplied comments for the component" - }, - "position" : { - "description" : "The component's position on the graph", - "$ref" : "#/definitions/Position" - }, - "label" : { - "type" : "string", - "description" : "The text that appears in the label." - }, - "width" : { - "type" : "number", - "format" : "double", - "description" : "The width of the label in pixels when at a 1:1 scale." - }, - "height" : { - "type" : "number", - "format" : "double", - "description" : "The height of the label in pixels when at a 1:1 scale." - }, - "style" : { - "type" : "object", - "description" : "The styles for this label (font-size : 12px, background-color : #eee, etc).", - "additionalProperties" : { - "type" : "string" - } - }, - "componentType" : { - "type" : "string", - "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE" ] - }, - "groupIdentifier" : { - "type" : "string", - "description" : "The ID of the Process Group that this component belongs to" - } - } - }, - "VersionedPort" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The component's unique identifier" - }, - "name" : { - "type" : "string", - "description" : "The component's name" - }, - "comments" : { - "type" : "string", - "description" : "The user-supplied comments for the component" - }, - "position" : { - "description" : "The component's position on the graph", - "$ref" : "#/definitions/Position" - }, - "type" : { - "type" : "string", - "description" : "The type of port.", - "enum" : [ "INPUT_PORT", "OUTPUT_PORT" ] - }, - "concurrentlySchedulableTaskCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of tasks that should be concurrently scheduled for the port." - }, - "componentType" : { - "type" : "string", - "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE" ] - }, - "groupIdentifier" : { - "type" : "string", - "description" : "The ID of the Process Group that this component belongs to" - } - } - }, - "VersionedProcessGroup" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The component's unique identifier" - }, - "name" : { - "type" : "string", - "description" : "The component's name" - }, - "comments" : { - "type" : "string", - "description" : "The user-supplied comments for the component" - }, - "position" : { - "description" : "The component's position on the graph", - "$ref" : "#/definitions/Position" - }, - "processGroups" : { - "type" : "array", - "description" : "The child Process Groups", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedProcessGroup" - } - }, - "remoteProcessGroups" : { - "type" : "array", - "description" : "The Remote Process Groups", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedRemoteProcessGroup" - } - }, - "processors" : { - "type" : "array", - "description" : "The Processors", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedProcessor" - } - }, - "inputPorts" : { - "type" : "array", - "description" : "The Input Ports", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedPort" - } - }, - "outputPorts" : { - "type" : "array", - "description" : "The Output Ports", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedPort" - } - }, - "connections" : { - "type" : "array", - "description" : "The Connections", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedConnection" - } - }, - "labels" : { - "type" : "array", - "description" : "The Labels", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedLabel" - } - }, - "funnels" : { - "type" : "array", - "description" : "The Funnels", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedFunnel" - } - }, - "controllerServices" : { - "type" : "array", - "description" : "The Controller Services", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedControllerService" - } - }, - "versionedFlowCoordinates" : { - "description" : "The coordinates where the remote flow is stored, or null if the Process Group is not directly under Version Control", - "$ref" : "#/definitions/VersionedFlowCoordinates" - }, - "variables" : { - "type" : "object", - "description" : "The Variables in the Variable Registry for this Process Group (not including any ancestor or descendant Process Groups)", - "additionalProperties" : { - "type" : "string" - } - }, - "componentType" : { - "type" : "string", - "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE" ] - }, - "groupIdentifier" : { - "type" : "string", - "description" : "The ID of the Process Group that this component belongs to" - } - } - }, - "VersionedProcessor" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The component's unique identifier" - }, - "name" : { - "type" : "string", - "description" : "The component's name" - }, - "comments" : { - "type" : "string", - "description" : "The user-supplied comments for the component" - }, - "position" : { - "description" : "The component's position on the graph", - "$ref" : "#/definitions/Position" - }, - "bundle" : { - "description" : "Information about the bundle from which the component came", - "$ref" : "#/definitions/Bundle" - }, - "style" : { - "type" : "object", - "description" : "Stylistic data for rendering in a UI", - "additionalProperties" : { - "type" : "string" - } - }, - "type" : { - "type" : "string", - "description" : "The type of Processor" - }, - "properties" : { - "type" : "object", - "description" : "The properties for the processor. Properties whose value is not set will only contain the property name.", - "additionalProperties" : { - "type" : "string" - } - }, - "propertyDescriptors" : { - "type" : "object", - "description" : "The property descriptors for the processor.", - "additionalProperties" : { - "$ref" : "#/definitions/VersionedPropertyDescriptor" - } - }, - "annotationData" : { - "type" : "string", - "description" : "The annotation data for the processor used to relay configuration between a custom UI and the procesosr." - }, - "schedulingPeriod" : { - "type" : "string", - "description" : "The frequency with which to schedule the processor. The format of the value will depend on th value of schedulingStrategy." - }, - "schedulingStrategy" : { - "type" : "string", - "description" : "Indcates whether the prcessor should be scheduled to run in event or timer driven mode." - }, - "executionNode" : { - "type" : "string", - "description" : "Indicates the node where the process will execute." - }, - "penaltyDuration" : { - "type" : "string", - "description" : "The amout of time that is used when the process penalizes a flowfile." - }, - "yieldDuration" : { - "type" : "string", - "description" : "The amount of time that must elapse before this processor is scheduled again after yielding." - }, - "bulletinLevel" : { - "type" : "string", - "description" : "The level at which the processor will report bulletins." - }, - "runDurationMillis" : { - "type" : "integer", - "format" : "int64", - "description" : "The run duration for the processor in milliseconds." - }, - "concurrentlySchedulableTaskCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of tasks that should be concurrently schedule for the processor. If the processor doesn't allow parallol processing then any positive input will be ignored." - }, - "autoTerminatedRelationships" : { - "type" : "array", - "description" : "The names of all relationships that cause a flow file to be terminated if the relationship is not connected elsewhere. This property differs from the 'isAutoTerminate' property of the RelationshipDTO in that the RelationshipDTO is meant to depict the current configuration, whereas this property can be set in a DTO when updating a Processor in order to change which Relationships should be auto-terminated.", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - }, - "componentType" : { - "type" : "string", - "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE" ] - }, - "groupIdentifier" : { - "type" : "string", - "description" : "The ID of the Process Group that this component belongs to" - } - } - }, - "VersionedPropertyDescriptor" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The name of the property" - }, - "displayName" : { - "type" : "string", - "description" : "The display name of the property" - }, - "identifiesControllerService" : { - "type" : "boolean", - "description" : "Whether or not the property provides the identifier of a Controller Service" - }, - "sensitive" : { - "type" : "boolean", - "description" : "Whether or not the property is considered sensitive" - } - } - }, - "VersionedRemoteGroupPort" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The component's unique identifier" - }, - "name" : { - "type" : "string", - "description" : "The component's name" - }, - "comments" : { - "type" : "string", - "description" : "The user-supplied comments for the component" - }, - "position" : { - "description" : "The component's position on the graph", - "$ref" : "#/definitions/Position" - }, - "remoteGroupId" : { - "type" : "string", - "description" : "The id of the remote process group that the port resides in." - }, - "concurrentlySchedulableTaskCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of task that may transmit flowfiles to the target port concurrently." - }, - "useCompression" : { - "type" : "boolean", - "description" : "Whether the flowfiles are compressed when sent to the target port." - }, - "batchSize" : { - "description" : "The batch settings for data transmission.", - "$ref" : "#/definitions/BatchSize" - }, - "componentType" : { - "type" : "string", - "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE" ] - }, - "targetId" : { - "type" : "string", - "description" : "The ID of the port on the target NiFi instance" - }, - "groupIdentifier" : { - "type" : "string", - "description" : "The ID of the Process Group that this component belongs to" - } - } - }, - "VersionedRemoteProcessGroup" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The component's unique identifier" - }, - "name" : { - "type" : "string", - "description" : "The component's name" - }, - "comments" : { - "type" : "string", - "description" : "The user-supplied comments for the component" - }, - "position" : { - "description" : "The component's position on the graph", - "$ref" : "#/definitions/Position" - }, - "targetUri" : { - "type" : "string", - "description" : "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 the single target uri. If neither target uris nor target uri is set, then returns null." - }, - "communicationsTimeout" : { - "type" : "string", - "description" : "The time period used for the timeout when communicating with the target." - }, - "yieldDuration" : { - "type" : "string", - "description" : "When yielding, this amount of time must elapse before the remote process group is scheduled again." - }, - "transportProtocol" : { - "type" : "string", - "description" : "The Transport Protocol that is used for Site-to-Site communications", - "enum" : [ "RAW", "HTTP" ] - }, - "localNetworkInterface" : { - "type" : "string", - "description" : "The local network interface to send/receive data. If not specified, any local address is used. If clustered, all nodes must have an interface with this identifier." - }, - "proxyHost" : { - "type" : "string" - }, - "proxyPort" : { - "type" : "integer", - "format" : "int32" - }, - "proxyUser" : { - "type" : "string" - }, - "inputPorts" : { - "type" : "array", - "description" : "A Set of Input Ports that can be connected to, in order to send data to the remote NiFi instance", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedRemoteGroupPort" - } - }, - "outputPorts" : { - "type" : "array", - "description" : "A Set of Output Ports that can be connected to, in order to pull data from the remote NiFi instance", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedRemoteGroupPort" - } - }, - "componentType" : { - "type" : "string", - "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE" ] - }, - "groupIdentifier" : { - "type" : "string", - "description" : "The ID of the Process Group that this component belongs to" - } - } - }, - "bucket" : { - "type" : "object", - "required" : [ "name" ], - "properties" : { - "link" : { - "description" : "An WebLink to this entity.", - "readOnly" : true, - "$ref" : "#/definitions/Link" - }, - "identifier" : { - "type" : "string", - "description" : "An ID to uniquely identify this object.", - "readOnly" : true - }, - "name" : { - "type" : "string", - "description" : "The name of the bucket." - }, - "createdTimestamp" : { - "type" : "integer", - "format" : "int64", - "description" : "The timestamp of when the bucket was first created. This is set by the server at creation time.", - "readOnly" : true, - "minimum" : 1 - }, - "description" : { - "type" : "string", - "description" : "A description of the bucket." - }, - "permissions" : { - "description" : "The access that the current user has to this bucket.", - "readOnly" : true, - "$ref" : "#/definitions/permissions" - } - } - }, - "permissions" : { - "type" : "object", - "properties" : { - "canRead" : { - "type" : "boolean", - "description" : "Indicates whether the user can read a given resource.", - "readOnly" : true - }, - "canWrite" : { - "type" : "boolean", - "description" : "Indicates whether the user can write a given resource.", - "readOnly" : true - }, - "canDelete" : { - "type" : "boolean", - "description" : "Indicates whether the user can delete a given resource.", - "readOnly" : true - } - } - }, - "versionedFlow" : { - "type" : "object", - "required" : [ "bucketIdentifier", "name", "type" ], - "properties" : { - "link" : { - "description" : "An WebLink to this entity.", - "readOnly" : true, - "$ref" : "#/definitions/Link" - }, - "identifier" : { - "type" : "string", - "description" : "An ID to uniquely identify this object.", - "readOnly" : true - }, - "name" : { - "type" : "string", - "description" : "The name of the item." - }, - "description" : { - "type" : "string", - "description" : "A description of the item." - }, - "bucketIdentifier" : { - "type" : "string", - "description" : "The identifier of the bucket this items belongs to. This cannot be changed after the item is created." - }, - "bucketName" : { - "type" : "string", - "description" : "The name of the bucket this items belongs to.", - "readOnly" : true - }, - "createdTimestamp" : { - "type" : "integer", - "format" : "int64", - "description" : "The timestamp of when the item was created, as milliseconds since epoch.", - "readOnly" : true, - "minimum" : 1 - }, - "modifiedTimestamp" : { - "type" : "integer", - "format" : "int64", - "description" : "The timestamp of when the item was last modified, as milliseconds since epoch.", - "readOnly" : true, - "minimum" : 1 - }, - "type" : { - "type" : "string", - "description" : "The type of item.", - "enum" : [ "Flow" ] - }, - "permissions" : { - "description" : "The access that the current user has to the bucket containing this item.", - "readOnly" : true, - "$ref" : "#/definitions/permissions" - }, - "versionCount" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of versions of this flow.", - "readOnly" : true, - "minimum" : 0 - } - } - }, - "versionedFlowSnapshot" : { - "type" : "object", - "required" : [ "flowContents", "snapshotMetadata" ], - "properties" : { - "snapshotMetadata" : { - "description" : "The metadata for this snapshot", - "$ref" : "#/definitions/versionedFlowSnapshotMetadata" - }, - "flowContents" : { - "description" : "The contents of the versioned flow", - "$ref" : "#/definitions/VersionedProcessGroup" - }, - "flow" : { - "description" : "The flow this snapshot is for", - "readOnly" : true, - "$ref" : "#/definitions/versionedFlow" - }, - "bucket" : { - "description" : "The bucket where the flow is located", - "readOnly" : true, - "$ref" : "#/definitions/bucket" - }, - "latest" : { - "type" : "boolean" - } - } - }, - "versionedFlowSnapshotMetadata" : { - "type" : "object", - "required" : [ "bucketIdentifier", "flowIdentifier", "version" ], - "properties" : { - "link" : { - "description" : "An WebLink to this entity.", - "readOnly" : true, - "$ref" : "#/definitions/Link" - }, - "bucketIdentifier" : { - "type" : "string", - "description" : "The identifier of the bucket this snapshot belongs to." - }, - "flowIdentifier" : { - "type" : "string", - "description" : "The identifier of the flow this snapshot belongs to." - }, - "version" : { - "type" : "integer", - "format" : "int32", - "description" : "The version of this snapshot of the flow.", - "minimum" : 1 - }, - "timestamp" : { - "type" : "integer", - "format" : "int64", - "description" : "The timestamp when the flow was saved, as milliseconds since epoch.", - "readOnly" : true, - "minimum" : 1 - }, - "author" : { - "type" : "string", - "description" : "The user that created this snapshot of the flow.", - "readOnly" : true - }, - "comments" : { - "type" : "string", - "description" : "The comments provided by the user when creating the snapshot." - } - } - } - } -} \ No newline at end of file diff --git a/resources/client_gen/api_defs/nifi-1.8.0.json b/resources/client_gen/api_defs/nifi-1.8.0.json deleted file mode 100644 index 213c81ae..00000000 --- a/resources/client_gen/api_defs/nifi-1.8.0.json +++ /dev/null @@ -1,19063 +0,0 @@ -{ - "swagger" : "2.0", - "info" : { - "description" : "The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and \n stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description,\n definitions of the expected input and output, potential response codes, and the authorizations required\n to invoke each service.", - "version" : "1.8.0", - "title" : "NiFi Rest Api", - "contact" : { - "url" : "https://nifi.apache.org", - "email" : "dev@nifi.apache.org" - }, - "license" : { - "name" : "Apache 2.0", - "url" : "http://www.apache.org/licenses/LICENSE-2.0.html" - } - }, - "basePath" : "/nifi-api", - "tags" : [ { - "name" : "access", - "description" : "Endpoints for obtaining an access token or checking access status." - }, { - "name" : "connections", - "description" : "Endpoint for managing a Connection." - }, { - "name" : "controller", - "description" : "Provides realtime command and control of this NiFi instance" - }, { - "name" : "controller-services", - "description" : "Endpoint for managing a Controller Service." - }, { - "name" : "counters", - "description" : "Endpoint for managing counters." - }, { - "name" : "data-transfer", - "description" : "Supports data transfers with this NiFi using HTTP based site to site" - }, { - "name" : "flow", - "description" : "Endpoint for accessing the flow structure and component status." - }, { - "name" : "flowfile-queues", - "description" : "Endpoint for managing a FlowFile Queue." - }, { - "name" : "funnel", - "description" : "Endpoint for managing a Funnel." - }, { - "name" : "input-ports", - "description" : "Endpoint for managing an Input Port." - }, { - "name" : "labels", - "description" : "Endpoint for managing a Label." - }, { - "name" : "output-ports", - "description" : "Endpoint for managing an Output Port." - }, { - "name" : "policies", - "description" : "Endpoint for managing access policies." - }, { - "name" : "process-groups", - "description" : "Endpoint for managing a Process Group." - }, { - "name" : "processors", - "description" : "Endpoint for managing a Processor." - }, { - "name" : "provenance", - "description" : "Endpoint for accessing data flow provenance." - }, { - "name" : "provenance-events", - "description" : "Endpoint for accessing data flow provenance." - }, { - "name" : "remote-process-groups", - "description" : "Endpoint for managing a Remote Process Group." - }, { - "name" : "reporting-tasks", - "description" : "Endpoint for managing a Reporting Task." - }, { - "name" : "resources", - "description" : "Provides the resources in this NiFi that can have access/authorization policies." - }, { - "name" : "site-to-site", - "description" : "Provide access to site to site with this NiFi" - }, { - "name" : "snippets", - "description" : "Endpoint for accessing dataflow snippets." - }, { - "name" : "system-diagnostics", - "description" : "Endpoint for accessing system diagnostics." - }, { - "name" : "templates", - "description" : "Endpoint for managing a Template." - }, { - "name" : "tenants", - "description" : "Endpoint for managing users and user groups." - }, { - "name" : "versions", - "description" : "Endpoint for managing version control for a flow" - } ], - "schemes" : [ "http", "https" ], - "paths" : { - "/access" : { - "get" : { - "tags" : [ "access" ], - "summary" : "Gets the status the client's access", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getAccessStatus", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/AccessStatusEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Unable to determine access status because the client could not be authenticated." - }, - "403" : { - "description" : "Unable to determine access status because the client is not authorized to make this request." - }, - "409" : { - "description" : "Unable to determine access status because NiFi is not in the appropriate state." - }, - "500" : { - "description" : "Unable to determine access status because an unexpected error occurred." - } - } - } - }, - "/access/config" : { - "get" : { - "tags" : [ "access" ], - "summary" : "Retrieves the access configuration for this NiFi", - "description" : "", - "operationId" : "getLoginConfig", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/AccessConfigurationEntity" - } - } - } - } - }, - "/access/download-token" : { - "post" : { - "tags" : [ "access" ], - "summary" : "Creates a single use access token for downloading FlowFile content.", - "description" : "The token returned is a base64 encoded string. It is valid for a single request up to five minutes from being issued. It is used as a query parameter name 'access_token'.", - "operationId" : "createDownloadToken", - "consumes" : [ "application/x-www-form-urlencoded" ], - "produces" : [ "text/plain" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "Unable to create the download token because NiFi is not in the appropriate state. (i.e. may not have any tokens to grant or be configured to support username/password login)" - }, - "500" : { - "description" : "Unable to create download token because an unexpected error occurred." - } - } - } - }, - "/access/kerberos" : { - "post" : { - "tags" : [ "access" ], - "summary" : "Creates a token for accessing the REST API via Kerberos ticket exchange / SPNEGO negotiation", - "description" : "The token returned is formatted as a JSON Web Token (JWT). The token is base64 encoded and comprised of three parts. The header, the body, and the signature. The expiration of the token is a contained within the body. The token can be used in the Authorization header in the format 'Authorization: Bearer '.", - "operationId" : "createAccessTokenFromTicket", - "consumes" : [ "text/plain" ], - "produces" : [ "text/plain" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "NiFi was unable to complete the request because it did not contain a valid Kerberos ticket in the Authorization header. Retry this request after initializing a ticket with kinit and ensuring your browser is configured to support SPNEGO." - }, - "409" : { - "description" : "Unable to create access token because NiFi is not in the appropriate state. (i.e. may not be configured to support Kerberos login." - }, - "500" : { - "description" : "Unable to create access token because an unexpected error occurred." - } - } - } - }, - "/access/knox/callback" : { - "get" : { - "tags" : [ "access" ], - "summary" : "Redirect/callback URI for processing the result of the Apache Knox login sequence.", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "knoxCallback", - "consumes" : [ "*/*" ], - "produces" : [ "*/*" ], - "responses" : { - "default" : { - "description" : "successful operation" - } - } - } - }, - "/access/knox/logout" : { - "get" : { - "tags" : [ "access" ], - "summary" : "Performs a logout in the Apache Knox.", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "knoxLogout", - "consumes" : [ "*/*" ], - "produces" : [ "*/*" ], - "responses" : { - "default" : { - "description" : "successful operation" - } - } - } - }, - "/access/knox/request" : { - "get" : { - "tags" : [ "access" ], - "summary" : "Initiates a request to authenticate through Apache Knox.", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "knoxRequest", - "consumes" : [ "*/*" ], - "produces" : [ "*/*" ], - "responses" : { - "default" : { - "description" : "successful operation" - } - } - } - }, - "/access/oidc/callback" : { - "get" : { - "tags" : [ "access" ], - "summary" : "Redirect/callback URI for processing the result of the OpenId Connect login sequence.", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "oidcCallback", - "consumes" : [ "*/*" ], - "produces" : [ "*/*" ], - "responses" : { - "default" : { - "description" : "successful operation" - } - } - } - }, - "/access/oidc/exchange" : { - "post" : { - "tags" : [ "access" ], - "summary" : "Retrieves a JWT following a successful login sequence using the configured OpenId Connect provider.", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "oidcExchange", - "consumes" : [ "*/*" ], - "produces" : [ "text/plain" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - } - } - } - }, - "/access/oidc/logout" : { - "get" : { - "tags" : [ "access" ], - "summary" : "Performs a logout in the OpenId Provider.", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "oidcLogout", - "consumes" : [ "*/*" ], - "produces" : [ "*/*" ], - "responses" : { - "default" : { - "description" : "successful operation" - } - } - } - }, - "/access/oidc/request" : { - "get" : { - "tags" : [ "access" ], - "summary" : "Initiates a request to authenticate through the configured OpenId Connect provider.", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "oidcRequest", - "consumes" : [ "*/*" ], - "produces" : [ "*/*" ], - "responses" : { - "default" : { - "description" : "successful operation" - } - } - } - }, - "/access/token" : { - "post" : { - "tags" : [ "access" ], - "summary" : "Creates a token for accessing the REST API via username/password", - "description" : "The token returned is formatted as a JSON Web Token (JWT). The token is base64 encoded and comprised of three parts. The header, the body, and the signature. The expiration of the token is a contained within the body. The token can be used in the Authorization header in the format 'Authorization: Bearer '.", - "operationId" : "createAccessToken", - "consumes" : [ "application/x-www-form-urlencoded" ], - "produces" : [ "text/plain" ], - "parameters" : [ { - "name" : "username", - "in" : "formData", - "required" : false, - "type" : "string" - }, { - "name" : "password", - "in" : "formData", - "required" : false, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "Unable to create access token because NiFi is not in the appropriate state. (i.e. may not be configured to support username/password login." - }, - "500" : { - "description" : "Unable to create access token because an unexpected error occurred." - } - } - } - }, - "/access/ui-extension-token" : { - "post" : { - "tags" : [ "access" ], - "summary" : "Creates a single use access token for accessing a NiFi UI extension.", - "description" : "The token returned is a base64 encoded string. It is valid for a single request up to five minutes from being issued. It is used as a query parameter name 'access_token'.", - "operationId" : "createUiExtensionToken", - "consumes" : [ "application/x-www-form-urlencoded" ], - "produces" : [ "text/plain" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "Unable to create the download token because NiFi is not in the appropriate state. (i.e. may not have any tokens to grant or be configured to support username/password login)" - }, - "500" : { - "description" : "Unable to create download token because an unexpected error occurred." - } - } - } - }, - "/connections/{id}" : { - "get" : { - "tags" : [ "connections" ], - "summary" : "Gets a connection", - "description" : "", - "operationId" : "getConnection", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The connection id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ConnectionEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read Source - /{component-type}/{uuid}" : [ ] - }, { - "Read Destination - /{component-type}/{uuid}" : [ ] - } ] - }, - "put" : { - "tags" : [ "connections" ], - "summary" : "Updates a connection", - "description" : "", - "operationId" : "updateConnection", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The connection id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The connection configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ConnectionEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ConnectionEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write Source - /{component-type}/{uuid}" : [ ] - }, { - "Write Destination - /{component-type}/{uuid}" : [ ] - }, { - "Write New Destination - /{component-type}/{uuid} - if updating Destination" : [ ] - }, { - "Write Process Group - /process-groups/{uuid} - if updating Destination" : [ ] - } ] - }, - "delete" : { - "tags" : [ "connections" ], - "summary" : "Deletes a connection", - "description" : "", - "operationId" : "deleteConnection", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The revision is used to verify the client is working with the latest version of the flow.", - "required" : false, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The connection id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ConnectionEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write Source - /{component-type}/{uuid}" : [ ] - }, { - "Write - Parent Process Group - /process-groups/{uuid}" : [ ] - }, { - "Write Destination - /{component-type}/{uuid}" : [ ] - } ] - } - }, - "/controller-services/{id}" : { - "get" : { - "tags" : [ "controller-services" ], - "summary" : "Gets a controller service", - "description" : "", - "operationId" : "getControllerService", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The controller service id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ControllerServiceEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /controller-services/{uuid}" : [ ] - } ] - }, - "put" : { - "tags" : [ "controller-services" ], - "summary" : "Updates a controller service", - "description" : "", - "operationId" : "updateControllerService", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The controller service id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The controller service configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ControllerServiceEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ControllerServiceEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /controller-services/{uuid}" : [ ] - }, { - "Read - any referenced Controller Services if this request changes the reference - /controller-services/{uuid}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "controller-services" ], - "summary" : "Deletes a controller service", - "description" : "", - "operationId" : "removeControllerService", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The revision is used to verify the client is working with the latest version of the flow.", - "required" : false, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The controller service id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ControllerServiceEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /controller-services/{uuid}" : [ ] - }, { - "Write - Parent Process Group if scoped by Process Group - /process-groups/{uuid}" : [ ] - }, { - "Write - Controller if scoped by Controller - /controller" : [ ] - }, { - "Read - any referenced Controller Services - /controller-services/{uuid}" : [ ] - } ] - } - }, - "/controller-services/{id}/descriptors" : { - "get" : { - "tags" : [ "controller-services" ], - "summary" : "Gets a controller service property descriptor", - "description" : "", - "operationId" : "getPropertyDescriptor", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The controller service id.", - "required" : true, - "type" : "string" - }, { - "name" : "propertyName", - "in" : "query", - "description" : "The property name to return the descriptor for.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/PropertyDescriptorEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /controller-services/{uuid}" : [ ] - } ] - } - }, - "/controller-services/{id}/references" : { - "get" : { - "tags" : [ "controller-services" ], - "summary" : "Gets a controller service", - "description" : "", - "operationId" : "getControllerServiceReferences", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The controller service id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ControllerServiceReferencingComponentsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /controller-services/{uuid}" : [ ] - } ] - }, - "put" : { - "tags" : [ "controller-services" ], - "summary" : "Updates a controller services references", - "description" : "", - "operationId" : "updateControllerServiceReferences", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The controller service id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The controller service request update request.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/UpdateControllerServiceReferenceRequestEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ControllerServiceReferencingComponentsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /{component-type}/{uuid} or /operate/{component-type}/{uuid} - For each referencing component specified" : [ ] - } ] - } - }, - "/controller-services/{id}/run-status" : { - "put" : { - "tags" : [ "controller-services" ], - "summary" : "Updates run status of a controller service", - "description" : "", - "operationId" : "updateRunStatus", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The controller service id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The controller service run status.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ControllerServiceRunStatusEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ControllerServiceEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /controller-services/{uuid} or /operation/controller-services/{uuid}" : [ ] - } ] - } - }, - "/controller-services/{id}/state" : { - "get" : { - "tags" : [ "controller-services" ], - "summary" : "Gets the state for a controller service", - "description" : "", - "operationId" : "getState", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The controller service id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ComponentStateEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /controller-services/{uuid}" : [ ] - } ] - } - }, - "/controller-services/{id}/state/clear-requests" : { - "post" : { - "tags" : [ "controller-services" ], - "summary" : "Clears the state for a controller service", - "description" : "", - "operationId" : "clearState", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The controller service id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ComponentStateEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /controller-services/{uuid}" : [ ] - } ] - } - }, - "/controller/bulletin" : { - "post" : { - "tags" : [ "controller" ], - "summary" : "Creates a new bulletin", - "description" : "", - "operationId" : "createBulletin", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The reporting task configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/BulletinEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /controller" : [ ] - } ] - } - }, - "/controller/cluster" : { - "get" : { - "tags" : [ "controller" ], - "summary" : "Gets the contents of the cluster", - "description" : "Returns the contents of the cluster including all nodes and their status.", - "operationId" : "getCluster", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ClusterEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /controller" : [ ] - } ] - } - }, - "/controller/cluster/nodes/{id}" : { - "get" : { - "tags" : [ "controller" ], - "summary" : "Gets a node in the cluster", - "description" : "", - "operationId" : "getNode", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The node id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/NodeEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /controller" : [ ] - } ] - }, - "put" : { - "tags" : [ "controller" ], - "summary" : "Updates a node in the cluster", - "description" : "", - "operationId" : "updateNode", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The node id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The node configuration. The only configuration that will be honored at this endpoint is the status.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/NodeEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/NodeEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /controller" : [ ] - } ] - }, - "delete" : { - "tags" : [ "controller" ], - "summary" : "Removes a node from the cluster", - "description" : "", - "operationId" : "deleteNode", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The node id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/NodeEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /controller" : [ ] - } ] - } - }, - "/controller/config" : { - "get" : { - "tags" : [ "controller" ], - "summary" : "Retrieves the configuration for this NiFi Controller", - "description" : "", - "operationId" : "getControllerConfig", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ControllerConfigurationEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /controller" : [ ] - } ] - }, - "put" : { - "tags" : [ "controller" ], - "summary" : "Retrieves the configuration for this NiFi", - "description" : "", - "operationId" : "updateControllerConfig", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The controller configuration.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ControllerConfigurationEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ControllerConfigurationEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /controller" : [ ] - } ] - } - }, - "/controller/controller-services" : { - "post" : { - "tags" : [ "controller" ], - "summary" : "Creates a new controller service", - "description" : "", - "operationId" : "createControllerService", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The controller service configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ControllerServiceEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ControllerServiceEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /controller" : [ ] - }, { - "Read - any referenced Controller Services - /controller-services/{uuid}" : [ ] - }, { - "Write - if the Controller Service is restricted - /restricted-components" : [ ] - } ] - } - }, - "/controller/history" : { - "delete" : { - "tags" : [ "controller" ], - "summary" : "Purges history", - "description" : "", - "operationId" : "deleteHistory", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "endDate", - "in" : "query", - "description" : "Purge actions before this date/time.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/HistoryEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /controller" : [ ] - } ] - } - }, - "/controller/registry-clients" : { - "get" : { - "tags" : [ "controller" ], - "summary" : "Gets the listing of available registry clients", - "description" : "", - "operationId" : "getRegistryClients", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/RegistryClientsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - }, - "post" : { - "tags" : [ "controller" ], - "summary" : "Creates a new registry client", - "description" : "", - "operationId" : "createRegistryClient", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The registry configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/RegistryClientEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/RegistryClientEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /controller" : [ ] - } ] - } - }, - "/controller/registry-clients/{id}" : { - "get" : { - "tags" : [ "controller" ], - "summary" : "Gets a registry client", - "description" : "", - "operationId" : "getRegistryClient", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The registry id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/RegistryClientEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /controller" : [ ] - } ] - }, - "put" : { - "tags" : [ "controller" ], - "summary" : "Updates a registry client", - "description" : "", - "operationId" : "updateRegistryClient", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The registry id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The registry configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/RegistryClientEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/RegistryClientEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /controller" : [ ] - } ] - }, - "delete" : { - "tags" : [ "controller" ], - "summary" : "Deletes a registry client", - "description" : "", - "operationId" : "deleteRegistryClient", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The revision is used to verify the client is working with the latest version of the flow.", - "required" : false, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The registry id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/RegistryClientEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /controller" : [ ] - } ] - } - }, - "/controller/reporting-tasks" : { - "post" : { - "tags" : [ "controller" ], - "summary" : "Creates a new reporting task", - "description" : "", - "operationId" : "createReportingTask", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The reporting task configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ReportingTaskEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ReportingTaskEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /controller" : [ ] - }, { - "Read - any referenced Controller Services - /controller-services/{uuid}" : [ ] - }, { - "Write - if the Reporting Task is restricted - /restricted-components" : [ ] - } ] - } - }, - "/counters" : { - "get" : { - "tags" : [ "counters" ], - "summary" : "Gets the current counters for this NiFi", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getCounters", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "nodewise", - "in" : "query", - "description" : "Whether or not to include the breakdown per node. Optional, defaults to false", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "clusterNodeId", - "in" : "query", - "description" : "The id of the node where to get the status.", - "required" : false, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/CountersEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /counters" : [ ] - } ] - } - }, - "/counters/{id}" : { - "put" : { - "tags" : [ "counters" ], - "summary" : "Updates the specified counter. This will reset the counter value to 0", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "updateCounter", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The id of the counter.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/CounterEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /counters" : [ ] - } ] - } - }, - "/data-transfer/input-ports/{portId}/transactions/{transactionId}" : { - "put" : { - "tags" : [ "data-transfer" ], - "summary" : "Extend transaction TTL", - "description" : "", - "operationId" : "extendInputPortTransactionTTL", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "portId", - "in" : "path", - "required" : true, - "type" : "string" - }, { - "name" : "transactionId", - "in" : "path", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/TransactionResultEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /data-transfer/input-ports/{uuid}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "data-transfer" ], - "summary" : "Commit or cancel the specified transaction", - "description" : "", - "operationId" : "commitInputPortTransaction", - "consumes" : [ "application/octet-stream" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "responseCode", - "in" : "query", - "description" : "The response code. Available values are BAD_CHECKSUM(19), CONFIRM_TRANSACTION(12) or CANCEL_TRANSACTION(15).", - "required" : true, - "type" : "integer", - "format" : "int32" - }, { - "name" : "portId", - "in" : "path", - "description" : "The input port id.", - "required" : true, - "type" : "string" - }, { - "name" : "transactionId", - "in" : "path", - "description" : "The transaction id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/TransactionResultEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - }, - "503" : { - "description" : "NiFi instance is not ready for serving request, or temporarily overloaded. Retrying the same request later may be successful" - } - }, - "security" : [ { - "Write - /data-transfer/input-ports/{uuid}" : [ ] - } ] - } - }, - "/data-transfer/input-ports/{portId}/transactions/{transactionId}/flow-files" : { - "post" : { - "tags" : [ "data-transfer" ], - "summary" : "Transfer flow files to the input port", - "description" : "", - "operationId" : "receiveFlowFiles", - "consumes" : [ "application/octet-stream" ], - "produces" : [ "text/plain" ], - "parameters" : [ { - "name" : "portId", - "in" : "path", - "description" : "The input port id.", - "required" : true, - "type" : "string" - }, { - "name" : "transactionId", - "in" : "path", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - }, - "503" : { - "description" : "NiFi instance is not ready for serving request, or temporarily overloaded. Retrying the same request later may be successful" - } - }, - "security" : [ { - "Write - /data-transfer/input-ports/{uuid}" : [ ] - } ] - } - }, - "/data-transfer/output-ports/{portId}/transactions/{transactionId}" : { - "put" : { - "tags" : [ "data-transfer" ], - "summary" : "Extend transaction TTL", - "description" : "", - "operationId" : "extendOutputPortTransactionTTL", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "portId", - "in" : "path", - "required" : true, - "type" : "string" - }, { - "name" : "transactionId", - "in" : "path", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/TransactionResultEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - }, - "503" : { - "description" : "NiFi instance is not ready for serving request, or temporarily overloaded. Retrying the same request later may be successful" - } - }, - "security" : [ { - "Write - /data-transfer/output-ports/{uuid}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "data-transfer" ], - "summary" : "Commit or cancel the specified transaction", - "description" : "", - "operationId" : "commitOutputPortTransaction", - "consumes" : [ "application/octet-stream" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "responseCode", - "in" : "query", - "description" : "The response code. Available values are CONFIRM_TRANSACTION(12) or CANCEL_TRANSACTION(15).", - "required" : true, - "type" : "integer", - "format" : "int32" - }, { - "name" : "checksum", - "in" : "query", - "description" : "A checksum calculated at client side using CRC32 to check flow file content integrity. It must match with the value calculated at server side.", - "required" : true, - "type" : "string" - }, { - "name" : "portId", - "in" : "path", - "description" : "The output port id.", - "required" : true, - "type" : "string" - }, { - "name" : "transactionId", - "in" : "path", - "description" : "The transaction id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/TransactionResultEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - }, - "503" : { - "description" : "NiFi instance is not ready for serving request, or temporarily overloaded. Retrying the same request later may be successful" - } - }, - "security" : [ { - "Write - /data-transfer/output-ports/{uuid}" : [ ] - } ] - } - }, - "/data-transfer/output-ports/{portId}/transactions/{transactionId}/flow-files" : { - "get" : { - "tags" : [ "data-transfer" ], - "summary" : "Transfer flow files from the output port", - "description" : "", - "operationId" : "transferFlowFiles", - "consumes" : [ "*/*" ], - "produces" : [ "application/octet-stream" ], - "parameters" : [ { - "name" : "portId", - "in" : "path", - "description" : "The output port id.", - "required" : true, - "type" : "string" - }, { - "name" : "transactionId", - "in" : "path", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "There is no flow file to return.", - "schema" : { - "$ref" : "#/definitions/StreamingOutput" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - }, - "503" : { - "description" : "NiFi instance is not ready for serving request, or temporarily overloaded. Retrying the same request later may be successful" - } - }, - "security" : [ { - "Write - /data-transfer/output-ports/{uuid}" : [ ] - } ] - } - }, - "/data-transfer/{portType}/{portId}/transactions" : { - "post" : { - "tags" : [ "data-transfer" ], - "summary" : "Create a transaction to the specified output port or input port", - "description" : "", - "operationId" : "createPortTransaction", - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "portType", - "in" : "path", - "description" : "The port type.", - "required" : true, - "type" : "string", - "enum" : [ "input-ports", "output-ports" ] - }, { - "name" : "portId", - "in" : "path", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/TransactionResultEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - }, - "503" : { - "description" : "NiFi instance is not ready for serving request, or temporarily overloaded. Retrying the same request later may be successful" - } - }, - "security" : [ { - "Write - /data-transfer/{component-type}/{uuid}" : [ ] - } ] - } - }, - "/flow/about" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Retrieves details about this NiFi to put in the About dialog", - "description" : "", - "operationId" : "getAboutInfo", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/AboutEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/banners" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Retrieves the banners for this NiFi", - "description" : "", - "operationId" : "getBanners", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/BannerEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/bulletin-board" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets current bulletins", - "description" : "", - "operationId" : "getBulletinBoard", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "after", - "in" : "query", - "description" : "Includes bulletins with an id after this value.", - "required" : false, - "type" : "string" - }, { - "name" : "sourceName", - "in" : "query", - "description" : "Includes bulletins originating from this sources whose name match this regular expression.", - "required" : false, - "type" : "string" - }, { - "name" : "message", - "in" : "query", - "description" : "Includes bulletins whose message that match this regular expression.", - "required" : false, - "type" : "string" - }, { - "name" : "sourceId", - "in" : "query", - "description" : "Includes bulletins originating from this sources whose id match this regular expression.", - "required" : false, - "type" : "string" - }, { - "name" : "groupId", - "in" : "query", - "description" : "Includes bulletins originating from this sources whose group id match this regular expression.", - "required" : false, - "type" : "string" - }, { - "name" : "limit", - "in" : "query", - "description" : "The number of bulletins to limit the response to.", - "required" : false, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/BulletinBoardEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - }, { - "Read - /{component-type}/{uuid} - For component specific bulletins" : [ ] - } ] - } - }, - "/flow/client-id" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Generates a client id.", - "description" : "", - "operationId" : "generateClientId", - "consumes" : [ "*/*" ], - "produces" : [ "text/plain" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/cluster/search-results" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Searches the cluster for a node with the specified address", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "searchCluster", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "q", - "in" : "query", - "description" : "Node address to search for.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ClusterSearchResultsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/cluster/summary" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "The cluster summary for this NiFi", - "description" : "", - "operationId" : "getClusterSummary", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ClusteSummaryEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/config" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Retrieves the configuration for this NiFi flow", - "description" : "", - "operationId" : "getFlowConfig", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/FlowConfigurationEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/connections/{id}/status" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets status for a connection", - "description" : "", - "operationId" : "getConnectionStatus", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "nodewise", - "in" : "query", - "description" : "Whether or not to include the breakdown per node. Optional, defaults to false", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "clusterNodeId", - "in" : "query", - "description" : "The id of the node where to get the status.", - "required" : false, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The connection id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ConnectionStatusEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/connections/{id}/status/history" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets the status history for a connection", - "description" : "", - "operationId" : "getConnectionStatusHistory", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The connection id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/StatusHistoryEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/controller-service-types" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Retrieves the types of controller services that this NiFi supports", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getControllerServiceTypes", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "serviceType", - "in" : "query", - "description" : "If specified, will only return controller services that are compatible with this type of service.", - "required" : false, - "type" : "string" - }, { - "name" : "serviceBundleGroup", - "in" : "query", - "description" : "If serviceType specified, is the bundle group of the serviceType.", - "required" : false, - "type" : "string" - }, { - "name" : "serviceBundleArtifact", - "in" : "query", - "description" : "If serviceType specified, is the bundle artifact of the serviceType.", - "required" : false, - "type" : "string" - }, { - "name" : "serviceBundleVersion", - "in" : "query", - "description" : "If serviceType specified, is the bundle version of the serviceType.", - "required" : false, - "type" : "string" - }, { - "name" : "bundleGroupFilter", - "in" : "query", - "description" : "If specified, will only return types that are a member of this bundle group.", - "required" : false, - "type" : "string" - }, { - "name" : "bundleArtifactFilter", - "in" : "query", - "description" : "If specified, will only return types that are a member of this bundle artifact.", - "required" : false, - "type" : "string" - }, { - "name" : "typeFilter", - "in" : "query", - "description" : "If specified, will only return types whose fully qualified classname matches.", - "required" : false, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ControllerServiceTypesEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/controller/bulletins" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Retrieves Controller level bulletins", - "description" : "", - "operationId" : "getBulletins", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ControllerBulletinsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - }, { - "Read - /controller - For controller bulletins" : [ ] - }, { - "Read - /controller-services/{uuid} - For controller service bulletins" : [ ] - }, { - "Read - /reporting-tasks/{uuid} - For reporting task bulletins" : [ ] - } ] - } - }, - "/flow/controller/controller-services" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets controller services for reporting tasks", - "description" : "", - "operationId" : "getControllerServicesFromController", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ControllerServicesEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/current-user" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Retrieves the user identity of the user making the request", - "description" : "", - "operationId" : "getCurrentUser", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/CurrentUserEntity" - } - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/history" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets configuration history", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "queryHistory", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "offset", - "in" : "query", - "description" : "The offset into the result set.", - "required" : true, - "type" : "string" - }, { - "name" : "count", - "in" : "query", - "description" : "The number of actions to return.", - "required" : true, - "type" : "string" - }, { - "name" : "sortColumn", - "in" : "query", - "description" : "The field to sort on.", - "required" : false, - "type" : "string" - }, { - "name" : "sortOrder", - "in" : "query", - "description" : "The direction to sort.", - "required" : false, - "type" : "string" - }, { - "name" : "startDate", - "in" : "query", - "description" : "Include actions after this date.", - "required" : false, - "type" : "string" - }, { - "name" : "endDate", - "in" : "query", - "description" : "Include actions before this date.", - "required" : false, - "type" : "string" - }, { - "name" : "userIdentity", - "in" : "query", - "description" : "Include actions performed by this user.", - "required" : false, - "type" : "string" - }, { - "name" : "sourceId", - "in" : "query", - "description" : "Include actions on this component.", - "required" : false, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/HistoryEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/history/components/{componentId}" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets configuration history for a component", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getComponentHistory", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "componentId", - "in" : "path", - "description" : "The component id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ComponentHistoryEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - }, { - "Read underlying component - /{component-type}/{uuid}" : [ ] - } ] - } - }, - "/flow/history/{id}" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets an action", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getAction", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The action id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ActionEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/input-ports/{id}/status" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets status for an input port", - "description" : "", - "operationId" : "getInputPortStatus", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "nodewise", - "in" : "query", - "description" : "Whether or not to include the breakdown per node. Optional, defaults to false", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "clusterNodeId", - "in" : "query", - "description" : "The id of the node where to get the status.", - "required" : false, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The input port id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/PortStatusEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/output-ports/{id}/status" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets status for an output port", - "description" : "", - "operationId" : "getOutputPortStatus", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "nodewise", - "in" : "query", - "description" : "Whether or not to include the breakdown per node. Optional, defaults to false", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "clusterNodeId", - "in" : "query", - "description" : "The id of the node where to get the status.", - "required" : false, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The output port id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/PortStatusEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/prioritizers" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Retrieves the types of prioritizers that this NiFi supports", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getPrioritizers", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/PrioritizerTypesEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/process-groups/{id}" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets a process group", - "description" : "", - "operationId" : "getFlow", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessGroupFlowEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - }, - "put" : { - "tags" : [ "flow" ], - "summary" : "Schedule or unschedule components in the specified Process Group.", - "description" : "", - "operationId" : "scheduleComponents", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The request to schedule or unschedule. If the comopnents in the request are not specified, all authorized components will be considered.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ScheduleComponentsEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ScheduleComponentsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - }, { - "Write - /{component-type}/{uuid} or /operation/{component-type}/{uuid} - For every component being scheduled/unscheduled" : [ ] - } ] - } - }, - "/flow/process-groups/{id}/controller-services" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets all controller services", - "description" : "", - "operationId" : "getControllerServicesFromGroup", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "name" : "includeAncestorGroups", - "in" : "query", - "description" : "Whether or not to include parent/ancestory process groups", - "required" : false, - "type" : "boolean", - "default" : true - }, { - "name" : "includeDescendantGroups", - "in" : "query", - "description" : "Whether or not to include descendant process groups", - "required" : false, - "type" : "boolean", - "default" : false - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ControllerServicesEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - }, - "put" : { - "tags" : [ "flow" ], - "summary" : "Enable or disable Controller Services in the specified Process Group.", - "description" : "", - "operationId" : "activateControllerServices", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The request to schedule or unschedule. If the comopnents in the request are not specified, all authorized components will be considered.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ActivateControllerServicesEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ActivateControllerServicesEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - }, { - "Write - /{component-type}/{uuid} or /operation/{component-type}/{uuid} - For every service being enabled/disabled" : [ ] - } ] - } - }, - "/flow/process-groups/{id}/status" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets the status for a process group", - "description" : "The status for a process group includes status for all descendent components. When invoked on the root group with recursive set to true, it will return the current status of every component in the flow.", - "operationId" : "getProcessGroupStatus", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "recursive", - "in" : "query", - "description" : "Whether all descendant groups and the status of their content will be included. Optional, defaults to false", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "nodewise", - "in" : "query", - "description" : "Whether or not to include the breakdown per node. Optional, defaults to false", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "clusterNodeId", - "in" : "query", - "description" : "The id of the node where to get the status.", - "required" : false, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessGroupStatusEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/process-groups/{id}/status/history" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets status history for a remote process group", - "description" : "", - "operationId" : "getProcessGroupStatusHistory", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/StatusHistoryEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/processor-types" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Retrieves the types of processors that this NiFi supports", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getProcessorTypes", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bundleGroupFilter", - "in" : "query", - "description" : "If specified, will only return types that are a member of this bundle group.", - "required" : false, - "type" : "string" - }, { - "name" : "bundleArtifactFilter", - "in" : "query", - "description" : "If specified, will only return types that are a member of this bundle artifact.", - "required" : false, - "type" : "string" - }, { - "name" : "type", - "in" : "query", - "description" : "If specified, will only return types whose fully qualified classname matches.", - "required" : false, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessorTypesEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/processors/{id}/status" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets status for a processor", - "description" : "", - "operationId" : "getProcessorStatus", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "nodewise", - "in" : "query", - "description" : "Whether or not to include the breakdown per node. Optional, defaults to false", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "clusterNodeId", - "in" : "query", - "description" : "The id of the node where to get the status.", - "required" : false, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The processor id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessorStatusEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/processors/{id}/status/history" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets status history for a processor", - "description" : "", - "operationId" : "getProcessorStatusHistory", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The processor id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/StatusHistoryEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/registries" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets the listing of available registries", - "description" : "", - "operationId" : "getRegistries", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/RegistryClientsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/registries/{id}/buckets" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets the buckets from the specified registry for the current user", - "description" : "", - "operationId" : "getBuckets", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The registry id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/BucketsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/registries/{registry-id}/buckets/{bucket-id}/flows" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets the flows from the specified registry and bucket for the current user", - "description" : "", - "operationId" : "getFlows", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "registry-id", - "in" : "path", - "description" : "The registry id.", - "required" : true, - "type" : "string" - }, { - "name" : "bucket-id", - "in" : "path", - "description" : "The bucket id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlowsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/registries/{registry-id}/buckets/{bucket-id}/flows/{flow-id}/versions" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets the flow versions from the specified registry and bucket for the specified flow for the current user", - "description" : "", - "operationId" : "getVersions", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "registry-id", - "in" : "path", - "description" : "The registry id.", - "required" : true, - "type" : "string" - }, { - "name" : "bucket-id", - "in" : "path", - "description" : "The bucket id.", - "required" : true, - "type" : "string" - }, { - "name" : "flow-id", - "in" : "path", - "description" : "The flow id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlowSnapshotMetadataSetEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/remote-process-groups/{id}/status" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets status for a remote process group", - "description" : "", - "operationId" : "getRemoteProcessGroupStatus", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "nodewise", - "in" : "query", - "description" : "Whether or not to include the breakdown per node. Optional, defaults to false", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "clusterNodeId", - "in" : "query", - "description" : "The id of the node where to get the status.", - "required" : false, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The remote process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/RemoteProcessGroupStatusEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/remote-process-groups/{id}/status/history" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets the status history", - "description" : "", - "operationId" : "getRemoteProcessGroupStatusHistory", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The remote process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/StatusHistoryEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/reporting-task-types" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Retrieves the types of reporting tasks that this NiFi supports", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getReportingTaskTypes", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bundleGroupFilter", - "in" : "query", - "description" : "If specified, will only return types that are a member of this bundle group.", - "required" : false, - "type" : "string" - }, { - "name" : "bundleArtifactFilter", - "in" : "query", - "description" : "If specified, will only return types that are a member of this bundle artifact.", - "required" : false, - "type" : "string" - }, { - "name" : "type", - "in" : "query", - "description" : "If specified, will only return types whose fully qualified classname matches.", - "required" : false, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ReportingTaskTypesEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/reporting-tasks" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets all reporting tasks", - "description" : "", - "operationId" : "getReportingTasks", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ReportingTasksEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/search-results" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Performs a search against this NiFi using the specified search term", - "description" : "Only search results from authorized components will be returned.", - "operationId" : "searchFlow", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "q", - "in" : "query", - "required" : false, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/SearchResultsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/status" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets the current status of this NiFi", - "description" : "", - "operationId" : "getControllerStatus", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ControllerStatusEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/templates" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets all templates", - "description" : "", - "operationId" : "getTemplates", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/TemplatesEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flowfile-queues/{id}/drop-requests" : { - "post" : { - "tags" : [ "flowfile-queues" ], - "summary" : "Creates a request to drop the contents of the queue in this connection.", - "description" : "", - "operationId" : "createDropRequest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The connection id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/DropRequestEntity" - } - }, - "202" : { - "description" : "The request has been accepted. A HTTP response header will contain the URI where the response can be polled." - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write Source Data - /data/{component-type}/{uuid}" : [ ] - } ] - } - }, - "/flowfile-queues/{id}/drop-requests/{drop-request-id}" : { - "get" : { - "tags" : [ "flowfile-queues" ], - "summary" : "Gets the current status of a drop request for the specified connection.", - "description" : "", - "operationId" : "getDropRequest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The connection id.", - "required" : true, - "type" : "string" - }, { - "name" : "drop-request-id", - "in" : "path", - "description" : "The drop request id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/DropRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write Source Data - /data/{component-type}/{uuid}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "flowfile-queues" ], - "summary" : "Cancels and/or removes a request to drop the contents of this connection.", - "description" : "", - "operationId" : "removeDropRequest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The connection id.", - "required" : true, - "type" : "string" - }, { - "name" : "drop-request-id", - "in" : "path", - "description" : "The drop request id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/DropRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write Source Data - /data/{component-type}/{uuid}" : [ ] - } ] - } - }, - "/flowfile-queues/{id}/flowfiles/{flowfile-uuid}" : { - "get" : { - "tags" : [ "flowfile-queues" ], - "summary" : "Gets a FlowFile from a Connection.", - "description" : "", - "operationId" : "getFlowFile", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The connection id.", - "required" : true, - "type" : "string" - }, { - "name" : "flowfile-uuid", - "in" : "path", - "description" : "The flowfile uuid.", - "required" : true, - "type" : "string" - }, { - "name" : "clusterNodeId", - "in" : "query", - "description" : "The id of the node where the content exists if clustered.", - "required" : false, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/FlowFileEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read Source Data - /data/{component-type}/{uuid}" : [ ] - } ] - } - }, - "/flowfile-queues/{id}/flowfiles/{flowfile-uuid}/content" : { - "get" : { - "tags" : [ "flowfile-queues" ], - "summary" : "Gets the content for a FlowFile in a Connection.", - "description" : "", - "operationId" : "downloadFlowFileContent", - "consumes" : [ "*/*" ], - "produces" : [ "*/*" ], - "parameters" : [ { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The connection id.", - "required" : true, - "type" : "string" - }, { - "name" : "flowfile-uuid", - "in" : "path", - "description" : "The flowfile uuid.", - "required" : true, - "type" : "string" - }, { - "name" : "clusterNodeId", - "in" : "query", - "description" : "The id of the node where the content exists if clustered.", - "required" : false, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/StreamingOutput" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read Source Data - /data/{component-type}/{uuid}" : [ ] - } ] - } - }, - "/flowfile-queues/{id}/listing-requests" : { - "post" : { - "tags" : [ "flowfile-queues" ], - "summary" : "Lists the contents of the queue in this connection.", - "description" : "", - "operationId" : "createFlowFileListing", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The connection id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ListingRequestEntity" - } - }, - "202" : { - "description" : "The request has been accepted. A HTTP response header will contain the URI where the response can be polled." - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read Source Data - /data/{component-type}/{uuid}" : [ ] - } ] - } - }, - "/flowfile-queues/{id}/listing-requests/{listing-request-id}" : { - "get" : { - "tags" : [ "flowfile-queues" ], - "summary" : "Gets the current status of a listing request for the specified connection.", - "description" : "", - "operationId" : "getListingRequest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The connection id.", - "required" : true, - "type" : "string" - }, { - "name" : "listing-request-id", - "in" : "path", - "description" : "The listing request id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ListingRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read Source Data - /data/{component-type}/{uuid}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "flowfile-queues" ], - "summary" : "Cancels and/or removes a request to list the contents of this connection.", - "description" : "", - "operationId" : "deleteListingRequest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The connection id.", - "required" : true, - "type" : "string" - }, { - "name" : "listing-request-id", - "in" : "path", - "description" : "The listing request id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ListingRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read Source Data - /data/{component-type}/{uuid}" : [ ] - } ] - } - }, - "/funnels/{id}" : { - "get" : { - "tags" : [ "funnel" ], - "summary" : "Gets a funnel", - "description" : "", - "operationId" : "getFunnel", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The funnel id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/FunnelEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /funnels/{uuid}" : [ ] - } ] - }, - "put" : { - "tags" : [ "funnel" ], - "summary" : "Updates a funnel", - "description" : "", - "operationId" : "updateFunnel", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The funnel id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The funnel configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/FunnelEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/FunnelEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /funnels/{uuid}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "funnel" ], - "summary" : "Deletes a funnel", - "description" : "", - "operationId" : "removeFunnel", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The revision is used to verify the client is working with the latest version of the flow.", - "required" : false, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The funnel id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/FunnelEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /funnels/{uuid}" : [ ] - }, { - "Write - Parent Process Group - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/input-ports/{id}" : { - "get" : { - "tags" : [ "input-ports" ], - "summary" : "Gets an input port", - "description" : "", - "operationId" : "getInputPort", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The input port id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/PortEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /input-ports/{uuid}" : [ ] - } ] - }, - "put" : { - "tags" : [ "input-ports" ], - "summary" : "Updates an input port", - "description" : "", - "operationId" : "updateInputPort", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The input port id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The input port configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/PortEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/PortEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /input-ports/{uuid}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "input-ports" ], - "summary" : "Deletes an input port", - "description" : "", - "operationId" : "removeInputPort", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The revision is used to verify the client is working with the latest version of the flow.", - "required" : false, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The input port id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/PortEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /input-ports/{uuid}" : [ ] - }, { - "Write - Parent Process Group - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/input-ports/{id}/run-status" : { - "put" : { - "tags" : [ "input-ports" ], - "summary" : "Updates run status of an input-port", - "description" : "", - "operationId" : "updateRunStatus", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The port id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The port run status.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/PortRunStatusEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessorEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /input-ports/{uuid} or /operation/input-ports/{uuid}" : [ ] - } ] - } - }, - "/labels/{id}" : { - "get" : { - "tags" : [ "labels" ], - "summary" : "Gets a label", - "description" : "", - "operationId" : "getLabel", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The label id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/LabelEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /labels/{uuid}" : [ ] - } ] - }, - "put" : { - "tags" : [ "labels" ], - "summary" : "Updates a label", - "description" : "", - "operationId" : "updateLabel", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The label id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The label configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/LabelEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/LabelEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /labels/{uuid}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "labels" ], - "summary" : "Deletes a label", - "description" : "", - "operationId" : "removeLabel", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The revision is used to verify the client is working with the latest version of the flow.", - "required" : false, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The label id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/LabelEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /labels/{uuid}" : [ ] - }, { - "Write - Parent Process Group - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/output-ports/{id}" : { - "get" : { - "tags" : [ "output-ports" ], - "summary" : "Gets an output port", - "description" : "", - "operationId" : "getOutputPort", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The output port id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/PortEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /output-ports/{uuid}" : [ ] - } ] - }, - "put" : { - "tags" : [ "output-ports" ], - "summary" : "Updates an output port", - "description" : "", - "operationId" : "updateOutputPort", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The output port id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The output port configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/PortEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/PortEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /output-ports/{uuid}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "output-ports" ], - "summary" : "Deletes an output port", - "description" : "", - "operationId" : "removeOutputPort", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The revision is used to verify the client is working with the latest version of the flow.", - "required" : false, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The output port id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/PortEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /output-ports/{uuid}" : [ ] - }, { - "Write - Parent Process Group - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/output-ports/{id}/run-status" : { - "put" : { - "tags" : [ "output-ports" ], - "summary" : "Updates run status of an output-port", - "description" : "", - "operationId" : "updateRunStatus", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The port id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The port run status.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/PortRunStatusEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessorEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /output-ports/{uuid} or /operation/output-ports/{uuid}" : [ ] - } ] - } - }, - "/policies" : { - "post" : { - "tags" : [ "policies" ], - "summary" : "Creates an access policy", - "description" : "", - "operationId" : "createAccessPolicy", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The access policy configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/AccessPolicyEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/AccessPolicyEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /policies/{resource}" : [ ] - } ] - } - }, - "/policies/{action}/{resource}" : { - "get" : { - "tags" : [ "policies" ], - "summary" : "Gets an access policy for the specified action and resource", - "description" : "Will return the effective policy if no component specific policy exists for the specified action and resource. Must have Read permissions to the policy with the desired action and resource. Permissions for the policy that is returned will be indicated in the response. This means the client could be authorized to get the policy for a given component but the effective policy may be inherited from an ancestor Process Group. If the client does not have permissions to that policy, the response will not include the policy and the permissions in the response will be marked accordingly. If the client does not have permissions to the policy of the desired action and resource a 403 response will be returned.", - "operationId" : "getAccessPolicyForResource", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "action", - "in" : "path", - "description" : "The request action.", - "required" : true, - "type" : "string", - "enum" : [ "read", "write" ] - }, { - "name" : "resource", - "in" : "path", - "description" : "The resource of the policy.", - "required" : true, - "type" : "string", - "pattern" : ".+" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/AccessPolicyEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /policies/{resource}" : [ ] - } ] - } - }, - "/policies/{id}" : { - "get" : { - "tags" : [ "policies" ], - "summary" : "Gets an access policy", - "description" : "", - "operationId" : "getAccessPolicy", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The access policy id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/AccessPolicyEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /policies/{resource}" : [ ] - } ] - }, - "put" : { - "tags" : [ "policies" ], - "summary" : "Updates a access policy", - "description" : "", - "operationId" : "updateAccessPolicy", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The access policy id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The access policy configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/AccessPolicyEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/AccessPolicyEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /policies/{resource}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "policies" ], - "summary" : "Deletes an access policy", - "description" : "", - "operationId" : "removeAccessPolicy", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The revision is used to verify the client is working with the latest version of the flow.", - "required" : false, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The access policy id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/AccessPolicyEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /policies/{resource}" : [ ] - }, { - "Write - Policy of the parent resource - /policies/{resource}" : [ ] - } ] - } - }, - "/process-groups/{groupId}/variable-registry/update-requests/{updateId}" : { - "get" : { - "tags" : [ "process-groups" ], - "summary" : "Gets a process group's variable registry", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getVariableRegistryUpdateRequest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "groupId", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "name" : "updateId", - "in" : "path", - "description" : "The ID of the Variable Registry Update Request", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VariableRegistryUpdateRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "process-groups" ], - "summary" : "Deletes an update request for a process group's variable registry. If the request is not yet complete, it will automatically be cancelled.", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "deleteVariableRegistryUpdateRequest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "groupId", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "name" : "updateId", - "in" : "path", - "description" : "The ID of the Variable Registry Update Request", - "required" : true, - "type" : "string" - }, { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VariableRegistryUpdateRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/process-groups/{id}" : { - "get" : { - "tags" : [ "process-groups" ], - "summary" : "Gets a process group", - "description" : "", - "operationId" : "getProcessGroup", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessGroupEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - } ] - }, - "put" : { - "tags" : [ "process-groups" ], - "summary" : "Updates a process group", - "description" : "", - "operationId" : "updateProcessGroup", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The process group configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ProcessGroupEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessGroupEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "process-groups" ], - "summary" : "Deletes a process group", - "description" : "", - "operationId" : "removeProcessGroup", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The revision is used to verify the client is working with the latest version of the flow.", - "required" : false, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessGroupEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - }, { - "Write - Parent Process Group - /process-groups/{uuid}" : [ ] - }, { - "Read - any referenced Controller Services by any encapsulated components - /controller-services/{uuid}" : [ ] - }, { - "Write - /{component-type}/{uuid} - For all encapsulated components" : [ ] - } ] - } - }, - "/process-groups/{id}/connections" : { - "get" : { - "tags" : [ "process-groups" ], - "summary" : "Gets all connections", - "description" : "", - "operationId" : "getConnections", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ConnectionsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - } ] - }, - "post" : { - "tags" : [ "process-groups" ], - "summary" : "Creates a connection", - "description" : "", - "operationId" : "createConnection", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The connection configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ConnectionEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ConnectionEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - }, { - "Write Source - /{component-type}/{uuid}" : [ ] - }, { - "Write Destination - /{component-type}/{uuid}" : [ ] - } ] - } - }, - "/process-groups/{id}/controller-services" : { - "post" : { - "tags" : [ "process-groups" ], - "summary" : "Creates a new controller service", - "description" : "", - "operationId" : "createControllerService", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The controller service configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ControllerServiceEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ControllerServiceEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - }, { - "Read - any referenced Controller Services - /controller-services/{uuid}" : [ ] - }, { - "Write - if the Controller Service is restricted - /restricted-components" : [ ] - } ] - } - }, - "/process-groups/{id}/funnels" : { - "get" : { - "tags" : [ "process-groups" ], - "summary" : "Gets all funnels", - "description" : "", - "operationId" : "getFunnels", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/FunnelsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - } ] - }, - "post" : { - "tags" : [ "process-groups" ], - "summary" : "Creates a funnel", - "description" : "", - "operationId" : "createFunnel", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The funnel configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/FunnelEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/FunnelEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/process-groups/{id}/input-ports" : { - "get" : { - "tags" : [ "process-groups" ], - "summary" : "Gets all input ports", - "description" : "", - "operationId" : "getInputPorts", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/InputPortsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - } ] - }, - "post" : { - "tags" : [ "process-groups" ], - "summary" : "Creates an input port", - "description" : "", - "operationId" : "createInputPort", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The input port configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/PortEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/PortEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/process-groups/{id}/labels" : { - "get" : { - "tags" : [ "process-groups" ], - "summary" : "Gets all labels", - "description" : "", - "operationId" : "getLabels", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/LabelsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - } ] - }, - "post" : { - "tags" : [ "process-groups" ], - "summary" : "Creates a label", - "description" : "", - "operationId" : "createLabel", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The label configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/LabelEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/LabelEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/process-groups/{id}/local-modifications" : { - "get" : { - "tags" : [ "process-groups" ], - "summary" : "Gets a list of local modifications to the Process Group since it was last synchronized with the Flow Registry", - "description" : "", - "operationId" : "getLocalModifications", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/FlowComparisonEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - }, { - "Read - /{component-type}/{uuid} - For all encapsulated components" : [ ] - } ] - } - }, - "/process-groups/{id}/output-ports" : { - "get" : { - "tags" : [ "process-groups" ], - "summary" : "Gets all output ports", - "description" : "", - "operationId" : "getOutputPorts", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/OutputPortsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - } ] - }, - "post" : { - "tags" : [ "process-groups" ], - "summary" : "Creates an output port", - "description" : "", - "operationId" : "createOutputPort", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The output port configuration.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/PortEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/PortEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/process-groups/{id}/process-groups" : { - "get" : { - "tags" : [ "process-groups" ], - "summary" : "Gets all process groups", - "description" : "", - "operationId" : "getProcessGroups", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessGroupsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - } ] - }, - "post" : { - "tags" : [ "process-groups" ], - "summary" : "Creates a process group", - "description" : "", - "operationId" : "createProcessGroup", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The process group configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ProcessGroupEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessGroupEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/process-groups/{id}/processors" : { - "get" : { - "tags" : [ "process-groups" ], - "summary" : "Gets all processors", - "description" : "", - "operationId" : "getProcessors", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "name" : "includeDescendantGroups", - "in" : "query", - "description" : "Whether or not to include processors from descendant process groups", - "required" : false, - "type" : "boolean", - "default" : false - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessorsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - } ] - }, - "post" : { - "tags" : [ "process-groups" ], - "summary" : "Creates a new processor", - "description" : "", - "operationId" : "createProcessor", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The processor configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ProcessorEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessorEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - }, { - "Read - any referenced Controller Services - /controller-services/{uuid}" : [ ] - }, { - "Write - if the Processor is restricted - /restricted-components" : [ ] - } ] - } - }, - "/process-groups/{id}/remote-process-groups" : { - "get" : { - "tags" : [ "process-groups" ], - "summary" : "Gets all remote process groups", - "description" : "", - "operationId" : "getRemoteProcessGroups", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/RemoteProcessGroupsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - } ] - }, - "post" : { - "tags" : [ "process-groups" ], - "summary" : "Creates a new process group", - "description" : "", - "operationId" : "createRemoteProcessGroup", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The remote process group configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/RemoteProcessGroupEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/RemoteProcessGroupEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/process-groups/{id}/snippet-instance" : { - "post" : { - "tags" : [ "process-groups" ], - "summary" : "Copies a snippet and discards it.", - "description" : "", - "operationId" : "copySnippet", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The copy snippet request.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/CopySnippetRequestEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/FlowEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - }, { - "Read - /{component-type}/{uuid} - For each component in the snippet and their descendant components" : [ ] - }, { - "Write - if the snippet contains any restricted Processors - /restricted-components" : [ ] - } ] - } - }, - "/process-groups/{id}/template-instance" : { - "post" : { - "tags" : [ "process-groups" ], - "summary" : "Instantiates a template", - "description" : "", - "operationId" : "instantiateTemplate", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The instantiate template request.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/InstantiateTemplateRequestEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/FlowEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - }, { - "Read - /templates/{uuid}" : [ ] - }, { - "Write - if the template contains any restricted components - /restricted-components" : [ ] - } ] - } - }, - "/process-groups/{id}/templates" : { - "post" : { - "tags" : [ "process-groups" ], - "summary" : "Creates a template and discards the specified snippet.", - "description" : "", - "operationId" : "createTemplate", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The create template request.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/CreateTemplateRequestEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/TemplateEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - }, { - "Read - /{component-type}/{uuid} - For each component in the snippet and their descendant components" : [ ] - } ] - } - }, - "/process-groups/{id}/templates/import" : { - "post" : { - "tags" : [ "process-groups" ], - "summary" : "Imports a template", - "description" : "", - "operationId" : "importTemplate", - "consumes" : [ "application/xml" ], - "produces" : [ "application/xml" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/TemplateEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/process-groups/{id}/templates/upload" : { - "post" : { - "tags" : [ "process-groups" ], - "summary" : "Uploads a template", - "description" : "", - "operationId" : "uploadTemplate", - "consumes" : [ "multipart/form-data" ], - "produces" : [ "application/xml" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "schema" : { - "type" : "boolean" - } - }, { - "name" : "template", - "in" : "formData", - "description" : "The binary content of the template file being uploaded.", - "required" : true, - "type" : "file" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/TemplateEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/process-groups/{id}/variable-registry" : { - "get" : { - "tags" : [ "process-groups" ], - "summary" : "Gets a process group's variable registry", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getVariableRegistry", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "name" : "includeAncestorGroups", - "in" : "query", - "description" : "Whether or not to include ancestor groups", - "required" : false, - "type" : "boolean", - "default" : true - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VariableRegistryEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - } ] - }, - "put" : { - "tags" : [ "process-groups" ], - "summary" : "Updates the contents of a Process Group's variable Registry", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "updateVariableRegistry", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The variable registry configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/VariableRegistryEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VariableRegistryEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/process-groups/{id}/variable-registry/update-requests" : { - "post" : { - "tags" : [ "process-groups" ], - "summary" : "Submits a request to update a process group's variable registry", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "submitUpdateVariableRegistryRequest", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The variable registry configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/VariableRegistryEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VariableRegistryUpdateRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/processors/{id}" : { - "get" : { - "tags" : [ "processors" ], - "summary" : "Gets a processor", - "description" : "", - "operationId" : "getProcessor", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The processor id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessorEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /processors/{uuid}" : [ ] - } ] - }, - "put" : { - "tags" : [ "processors" ], - "summary" : "Updates a processor", - "description" : "", - "operationId" : "updateProcessor", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The processor id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The processor configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ProcessorEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessorEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /processors/{uuid}" : [ ] - }, { - "Read - any referenced Controller Services if this request changes the reference - /controller-services/{uuid}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "processors" ], - "summary" : "Deletes a processor", - "description" : "", - "operationId" : "deleteProcessor", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The revision is used to verify the client is working with the latest version of the flow.", - "required" : false, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The processor id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessorEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /processors/{uuid}" : [ ] - }, { - "Write - Parent Process Group - /process-groups/{uuid}" : [ ] - }, { - "Read - any referenced Controller Services - /controller-services/{uuid}" : [ ] - } ] - } - }, - "/processors/{id}/descriptors" : { - "get" : { - "tags" : [ "processors" ], - "summary" : "Gets the descriptor for a processor property", - "description" : "", - "operationId" : "getPropertyDescriptor", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The processor id.", - "required" : true, - "type" : "string" - }, { - "name" : "propertyName", - "in" : "query", - "description" : "The property name.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/PropertyDescriptorEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /processors/{uuid}" : [ ] - } ] - } - }, - "/processors/{id}/diagnostics" : { - "get" : { - "tags" : [ "processors" ], - "summary" : "Gets diagnostics information about a processor", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getProcessorDiagnostics", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The processor id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessorEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /processors/{uuid}" : [ ] - } ] - } - }, - "/processors/{id}/run-status" : { - "put" : { - "tags" : [ "processors" ], - "summary" : "Updates run status of a processor", - "description" : "", - "operationId" : "updateRunStatus", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The processor id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The processor run status.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ProcessorRunStatusEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessorEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /processors/{uuid} or /operation/processors/{uuid}" : [ ] - } ] - } - }, - "/processors/{id}/state" : { - "get" : { - "tags" : [ "processors" ], - "summary" : "Gets the state for a processor", - "description" : "", - "operationId" : "getState", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The processor id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ComponentStateEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /processors/{uuid}" : [ ] - } ] - } - }, - "/processors/{id}/state/clear-requests" : { - "post" : { - "tags" : [ "processors" ], - "summary" : "Clears the state for a processor", - "description" : "", - "operationId" : "clearState", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The processor id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ComponentStateEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /processors/{uuid}" : [ ] - } ] - } - }, - "/processors/{id}/threads" : { - "delete" : { - "tags" : [ "processors" ], - "summary" : "Terminates a processor, essentially \"deleting\" its threads and any active tasks", - "description" : "", - "operationId" : "terminateProcessor", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The processor id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessorEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /processors/{uuid} or /operation/processors/{uuid}" : [ ] - } ] - } - }, - "/provenance" : { - "post" : { - "tags" : [ "provenance" ], - "summary" : "Submits a provenance query", - "description" : "Provenance queries may be long running so this endpoint submits a request. The response will include the current state of the query. If the request is not completed the URI in the response can be used at a later time to get the updated state of the query. Once the query has completed the provenance request should be deleted by the client who originally submitted it.", - "operationId" : "submitProvenanceRequest", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The provenance query details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ProvenanceEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProvenanceEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /provenance" : [ ] - }, { - "Read - /data/{component-type}/{uuid}" : [ ] - } ] - } - }, - "/provenance-events/replays" : { - "post" : { - "tags" : [ "provenance-events" ], - "summary" : "Replays content from a provenance event", - "description" : "", - "operationId" : "submitReplay", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The replay request.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/SubmitReplayRequestEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProvenanceEventEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read Component Provenance Data - /provenance-data/{component-type}/{uuid}" : [ ] - }, { - "Read Component Data - /data/{component-type}/{uuid}" : [ ] - }, { - "Write Component Data - /data/{component-type}/{uuid}" : [ ] - } ] - } - }, - "/provenance-events/{id}" : { - "get" : { - "tags" : [ "provenance-events" ], - "summary" : "Gets a provenance event", - "description" : "", - "operationId" : "getProvenanceEvent", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "clusterNodeId", - "in" : "query", - "description" : "The id of the node where this event exists if clustered.", - "required" : false, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The provenance event id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProvenanceEventEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read Component Provenance Data - /provenance-data/{component-type}/{uuid}" : [ ] - } ] - } - }, - "/provenance-events/{id}/content/input" : { - "get" : { - "tags" : [ "provenance-events" ], - "summary" : "Gets the input content for a provenance event", - "description" : "", - "operationId" : "getInputContent", - "consumes" : [ "*/*" ], - "produces" : [ "*/*" ], - "parameters" : [ { - "name" : "clusterNodeId", - "in" : "query", - "description" : "The id of the node where the content exists if clustered.", - "required" : false, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The provenance event id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/StreamingOutput" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read Component Provenance Data - /provenance-data/{component-type}/{uuid}" : [ ] - }, { - "Read Component Data - /data/{component-type}/{uuid}" : [ ] - } ] - } - }, - "/provenance-events/{id}/content/output" : { - "get" : { - "tags" : [ "provenance-events" ], - "summary" : "Gets the output content for a provenance event", - "description" : "", - "operationId" : "getOutputContent", - "consumes" : [ "*/*" ], - "produces" : [ "*/*" ], - "parameters" : [ { - "name" : "clusterNodeId", - "in" : "query", - "description" : "The id of the node where the content exists if clustered.", - "required" : false, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The provenance event id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/StreamingOutput" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read Component Provenance Data - /provenance-data/{component-type}/{uuid}" : [ ] - }, { - "Read Component Data - /data/{component-type}/{uuid}" : [ ] - } ] - } - }, - "/provenance/lineage" : { - "post" : { - "tags" : [ "provenance" ], - "summary" : "Submits a lineage query", - "description" : "Lineage queries may be long running so this endpoint submits a request. The response will include the current state of the query. If the request is not completed the URI in the response can be used at a later time to get the updated state of the query. Once the query has completed the lineage request should be deleted by the client who originally submitted it.", - "operationId" : "submitLineageRequest", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The lineage query details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/LineageEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/LineageEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /provenance" : [ ] - }, { - "Read - /data/{component-type}/{uuid}" : [ ] - } ] - } - }, - "/provenance/lineage/{id}" : { - "get" : { - "tags" : [ "provenance" ], - "summary" : "Gets a lineage query", - "description" : "", - "operationId" : "getLineage", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "clusterNodeId", - "in" : "query", - "description" : "The id of the node where this query exists if clustered.", - "required" : false, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The id of the lineage query.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/LineageEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /provenance" : [ ] - }, { - "Read - /data/{component-type}/{uuid}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "provenance" ], - "summary" : "Deletes a lineage query", - "description" : "", - "operationId" : "deleteLineage", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "clusterNodeId", - "in" : "query", - "description" : "The id of the node where this query exists if clustered.", - "required" : false, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The id of the lineage query.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/LineageEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /provenance" : [ ] - } ] - } - }, - "/provenance/search-options" : { - "get" : { - "tags" : [ "provenance" ], - "summary" : "Gets the searchable attributes for provenance events", - "description" : "", - "operationId" : "getSearchOptions", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProvenanceOptionsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /provenance" : [ ] - } ] - } - }, - "/provenance/{id}" : { - "get" : { - "tags" : [ "provenance" ], - "summary" : "Gets a provenance query", - "description" : "", - "operationId" : "getProvenance", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "clusterNodeId", - "in" : "query", - "description" : "The id of the node where this query exists if clustered.", - "required" : false, - "type" : "string" - }, { - "name" : "summarize", - "in" : "query", - "description" : "Whether or not incremental results are returned. If false, provenance events are only returned once the query completes. This property is true by default.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "incrementalResults", - "in" : "query", - "description" : "Whether or not to summarize provenance events returned. This property is false by default.", - "required" : false, - "type" : "boolean", - "default" : true - }, { - "name" : "id", - "in" : "path", - "description" : "The id of the provenance query.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProvenanceEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /provenance" : [ ] - }, { - "Read - /data/{component-type}/{uuid}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "provenance" ], - "summary" : "Deletes a provenance query", - "description" : "", - "operationId" : "deleteProvenance", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "clusterNodeId", - "in" : "query", - "description" : "The id of the node where this query exists if clustered.", - "required" : false, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The id of the provenance query.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProvenanceEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /provenance" : [ ] - } ] - } - }, - "/remote-process-groups/{id}" : { - "get" : { - "tags" : [ "remote-process-groups" ], - "summary" : "Gets a remote process group", - "description" : "", - "operationId" : "getRemoteProcessGroup", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The remote process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/RemoteProcessGroupEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /remote-process-groups/{uuid}" : [ ] - } ] - }, - "put" : { - "tags" : [ "remote-process-groups" ], - "summary" : "Updates a remote process group", - "description" : "", - "operationId" : "updateRemoteProcessGroup", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The remote process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The remote process group.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/RemoteProcessGroupEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/RemoteProcessGroupEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /remote-process-groups/{uuid}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "remote-process-groups" ], - "summary" : "Deletes a remote process group", - "description" : "", - "operationId" : "removeRemoteProcessGroup", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The revision is used to verify the client is working with the latest version of the flow.", - "required" : false, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The remote process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/RemoteProcessGroupEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /remote-process-groups/{uuid}" : [ ] - }, { - "Write - Parent Process Group - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/remote-process-groups/{id}/input-ports/{port-id}" : { - "put" : { - "tags" : [ "remote-process-groups" ], - "summary" : "Updates a remote port", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "updateRemoteProcessGroupInputPort", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The remote process group id.", - "required" : true, - "type" : "string" - }, { - "name" : "port-id", - "in" : "path", - "description" : "The remote process group port id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The remote process group port.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/RemoteProcessGroupPortEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/RemoteProcessGroupPortEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /remote-process-groups/{uuid}" : [ ] - } ] - } - }, - "/remote-process-groups/{id}/input-ports/{port-id}/run-status" : { - "put" : { - "tags" : [ "remote-process-groups" ], - "summary" : "Updates run status of a remote port", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "updateRemoteProcessGroupInputPortRunStatus", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The remote process group id.", - "required" : true, - "type" : "string" - }, { - "name" : "port-id", - "in" : "path", - "description" : "The remote process group port id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The remote process group port.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/RemotePortRunStatusEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/RemoteProcessGroupPortEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /remote-process-groups/{uuid} or /operation/remote-process-groups/{uuid}" : [ ] - } ] - } - }, - "/remote-process-groups/{id}/output-ports/{port-id}" : { - "put" : { - "tags" : [ "remote-process-groups" ], - "summary" : "Updates a remote port", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "updateRemoteProcessGroupOutputPort", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The remote process group id.", - "required" : true, - "type" : "string" - }, { - "name" : "port-id", - "in" : "path", - "description" : "The remote process group port id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The remote process group port.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/RemoteProcessGroupPortEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/RemoteProcessGroupPortEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /remote-process-groups/{uuid}" : [ ] - } ] - } - }, - "/remote-process-groups/{id}/output-ports/{port-id}/run-status" : { - "put" : { - "tags" : [ "remote-process-groups" ], - "summary" : "Updates run status of a remote port", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "updateRemoteProcessGroupOutputPortRunStatus", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The remote process group id.", - "required" : true, - "type" : "string" - }, { - "name" : "port-id", - "in" : "path", - "description" : "The remote process group port id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The remote process group port.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/RemotePortRunStatusEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/RemoteProcessGroupPortEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /remote-process-groups/{uuid} or /operation/remote-process-groups/{uuid}" : [ ] - } ] - } - }, - "/remote-process-groups/{id}/run-status" : { - "put" : { - "tags" : [ "remote-process-groups" ], - "summary" : "Updates run status of a remote process group", - "description" : "", - "operationId" : "updateRemoteProcessGroupRunStatus", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The remote process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The remote process group run status.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/RemotePortRunStatusEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/RemoteProcessGroupEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /remote-process-groups/{uuid} or /operation/remote-process-groups/{uuid}" : [ ] - } ] - } - }, - "/reporting-tasks/{id}" : { - "get" : { - "tags" : [ "reporting-tasks" ], - "summary" : "Gets a reporting task", - "description" : "", - "operationId" : "getReportingTask", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The reporting task id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ReportingTaskEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /reporting-tasks/{uuid}" : [ ] - } ] - }, - "put" : { - "tags" : [ "reporting-tasks" ], - "summary" : "Updates a reporting task", - "description" : "", - "operationId" : "updateReportingTask", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The reporting task id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The reporting task configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ReportingTaskEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ReportingTaskEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /reporting-tasks/{uuid}" : [ ] - }, { - "Read - any referenced Controller Services if this request changes the reference - /controller-services/{uuid}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "reporting-tasks" ], - "summary" : "Deletes a reporting task", - "description" : "", - "operationId" : "removeReportingTask", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The revision is used to verify the client is working with the latest version of the flow.", - "required" : false, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The reporting task id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ReportingTaskEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /reporting-tasks/{uuid}" : [ ] - }, { - "Write - /controller" : [ ] - }, { - "Read - any referenced Controller Services - /controller-services/{uuid}" : [ ] - } ] - } - }, - "/reporting-tasks/{id}/descriptors" : { - "get" : { - "tags" : [ "reporting-tasks" ], - "summary" : "Gets a reporting task property descriptor", - "description" : "", - "operationId" : "getPropertyDescriptor", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The reporting task id.", - "required" : true, - "type" : "string" - }, { - "name" : "propertyName", - "in" : "query", - "description" : "The property name.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/PropertyDescriptorEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /reporting-tasks/{uuid}" : [ ] - } ] - } - }, - "/reporting-tasks/{id}/run-status" : { - "put" : { - "tags" : [ "reporting-tasks" ], - "summary" : "Updates run status of a reporting task", - "description" : "", - "operationId" : "updateRunStatus", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The reporting task id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The reporting task run status.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ReportingTaskRunStatusEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ReportingTaskEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /reporting-tasks/{uuid} or or /operation/reporting-tasks/{uuid}" : [ ] - } ] - } - }, - "/reporting-tasks/{id}/state" : { - "get" : { - "tags" : [ "reporting-tasks" ], - "summary" : "Gets the state for a reporting task", - "description" : "", - "operationId" : "getState", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The reporting task id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ComponentStateEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /reporting-tasks/{uuid}" : [ ] - } ] - } - }, - "/reporting-tasks/{id}/state/clear-requests" : { - "post" : { - "tags" : [ "reporting-tasks" ], - "summary" : "Clears the state for a reporting task", - "description" : "", - "operationId" : "clearState", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The reporting task id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ComponentStateEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /reporting-tasks/{uuid}" : [ ] - } ] - } - }, - "/resources" : { - "get" : { - "tags" : [ "resources" ], - "summary" : "Gets the available resources that support access/authorization policies", - "description" : "", - "operationId" : "getResources", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ResourcesEntity" - } - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - } - }, - "security" : [ { - "Read - /resources" : [ ] - } ] - } - }, - "/site-to-site" : { - "get" : { - "tags" : [ "site-to-site" ], - "summary" : "Returns the details about this NiFi necessary to communicate via site to site", - "description" : "", - "operationId" : "getSiteToSiteDetails", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ControllerEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /site-to-site" : [ ] - } ] - } - }, - "/site-to-site/peers" : { - "get" : { - "tags" : [ "site-to-site" ], - "summary" : "Returns the available Peers and its status of this NiFi", - "description" : "", - "operationId" : "getPeers", - "consumes" : [ "*/*" ], - "produces" : [ "application/json", "application/xml" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/PeersEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /site-to-site" : [ ] - } ] - } - }, - "/snippets" : { - "post" : { - "tags" : [ "snippets" ], - "summary" : "Creates a snippet. The snippet will be automatically discarded if not used in a subsequent request after 1 minute.", - "description" : "", - "operationId" : "createSnippet", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The snippet configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/SnippetEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/SnippetEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read or Write - /{component-type}/{uuid} - For every component (all Read or all Write) in the Snippet and their descendant components" : [ ] - } ] - } - }, - "/snippets/{id}" : { - "put" : { - "tags" : [ "snippets" ], - "summary" : "Move's the components in this Snippet into a new Process Group and discards the snippet", - "description" : "", - "operationId" : "updateSnippet", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The snippet id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The snippet configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/SnippetEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/SnippetEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write Process Group - /process-groups/{uuid}" : [ ] - }, { - "Write - /{component-type}/{uuid} - For each component in the Snippet and their descendant components" : [ ] - } ] - }, - "delete" : { - "tags" : [ "snippets" ], - "summary" : "Deletes the components in a snippet and discards the snippet", - "description" : "", - "operationId" : "deleteSnippet", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The snippet id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/SnippetEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /{component-type}/{uuid} - For each component in the Snippet and their descendant components" : [ ] - }, { - "Write - Parent Process Group - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/system-diagnostics" : { - "get" : { - "tags" : [ "system-diagnostics" ], - "summary" : "Gets the diagnostics for the system NiFi is running on", - "description" : "", - "operationId" : "getSystemDiagnostics", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "nodewise", - "in" : "query", - "description" : "Whether or not to include the breakdown per node. Optional, defaults to false", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "clusterNodeId", - "in" : "query", - "description" : "The id of the node where to get the status.", - "required" : false, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/SystemDiagnosticsEntity" - } - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - } - }, - "security" : [ { - "Read - /system" : [ ] - } ] - } - }, - "/templates/{id}" : { - "delete" : { - "tags" : [ "templates" ], - "summary" : "Deletes a template", - "description" : "", - "operationId" : "removeTemplate", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The template id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/TemplateEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /templates/{uuid}" : [ ] - }, { - "Write - Parent Process Group - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/templates/{id}/download" : { - "get" : { - "tags" : [ "templates" ], - "summary" : "Exports a template", - "description" : "", - "operationId" : "exportTemplate", - "consumes" : [ "*/*" ], - "produces" : [ "application/xml" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The template id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /templates/{uuid}" : [ ] - } ] - } - }, - "/tenants/search-results" : { - "get" : { - "tags" : [ "tenants" ], - "summary" : "Searches for a tenant with the specified identity", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "searchTenants", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "q", - "in" : "query", - "description" : "Identity to search for.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/TenantsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /tenants" : [ ] - } ] - } - }, - "/tenants/user-groups" : { - "get" : { - "tags" : [ "tenants" ], - "summary" : "Gets all user groups", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getUserGroups", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/UserGroupsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /tenants" : [ ] - } ] - }, - "post" : { - "tags" : [ "tenants" ], - "summary" : "Creates a user group", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "createUserGroup", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The user group configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/UserGroupEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/UserGroupEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /tenants" : [ ] - } ] - } - }, - "/tenants/user-groups/{id}" : { - "get" : { - "tags" : [ "tenants" ], - "summary" : "Gets a user group", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getUserGroup", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The user group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/UserGroupEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /tenants" : [ ] - } ] - }, - "put" : { - "tags" : [ "tenants" ], - "summary" : "Updates a user group", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "updateUserGroup", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The user group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The user group configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/UserGroupEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/UserGroupEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /tenants" : [ ] - } ] - }, - "delete" : { - "tags" : [ "tenants" ], - "summary" : "Deletes a user group", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "removeUserGroup", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The revision is used to verify the client is working with the latest version of the flow.", - "required" : false, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The user group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/UserGroupEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /tenants" : [ ] - } ] - } - }, - "/tenants/users" : { - "get" : { - "tags" : [ "tenants" ], - "summary" : "Gets all users", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getUsers", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/UsersEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /tenants" : [ ] - } ] - }, - "post" : { - "tags" : [ "tenants" ], - "summary" : "Creates a user", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "createUser", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The user configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/UserEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/UserEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /tenants" : [ ] - } ] - } - }, - "/tenants/users/{id}" : { - "get" : { - "tags" : [ "tenants" ], - "summary" : "Gets a user", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getUser", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The user id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/UserEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /tenants" : [ ] - } ] - }, - "put" : { - "tags" : [ "tenants" ], - "summary" : "Updates a user", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "updateUser", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The user id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The user configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/UserEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/UserEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /tenants" : [ ] - } ] - }, - "delete" : { - "tags" : [ "tenants" ], - "summary" : "Deletes a user", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "removeUser", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The revision is used to verify the client is working with the latest version of the flow.", - "required" : false, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The user id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/UserEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /tenants" : [ ] - } ] - } - }, - "/versions/active-requests" : { - "post" : { - "tags" : [ "versions" ], - "summary" : "Create a version control request", - "description" : "Creates a request so that a Process Group can be placed under Version Control or have its Version Control configuration changed. Creating this request will prevent any other threads from simultaneously saving local changes to Version Control. It will not, however, actually save the local flow to the Flow Registry. A POST to /versions/process-groups/{id} should be used to initiate saving of the local flow to the Flow Registry. Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "createVersionControlRequest", - "consumes" : [ "application/json" ], - "produces" : [ "text/plain" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The versioned flow details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/CreateActiveRequestEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/versions/active-requests/{id}" : { - "put" : { - "tags" : [ "versions" ], - "summary" : "Updates the request with the given ID", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "updateVersionControlRequest", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The request ID.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The version control component mapping.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/VersionControlComponentMappingEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionControlInformationEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Only the user that submitted the request can update it" : [ ] - } ] - }, - "delete" : { - "tags" : [ "versions" ], - "summary" : "Deletes the version control request with the given ID", - "description" : "Deletes the Version Control Request with the given ID. This will allow other threads to save flows to the Flow Registry. See also the documentation for POSTing to /versions/active-requests for information regarding why this is done. Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "deleteVersionControlRequest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The request ID.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Only the user that submitted the request can remove it" : [ ] - } ] - } - }, - "/versions/process-groups/{id}" : { - "get" : { - "tags" : [ "versions" ], - "summary" : "Gets the Version Control information for a process group", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getVersionInformation", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionControlInformationEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - } ] - }, - "post" : { - "tags" : [ "versions" ], - "summary" : "Save the Process Group with the given ID", - "description" : "Begins version controlling the Process Group with the given ID or commits changes to the Versioned Flow, depending on if the provided VersionControlInformation includes a flowId. Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "saveToFlowRegistry", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The versioned flow details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/StartVersionControlRequestEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionControlInformationEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - }, { - "Write - /process-groups/{uuid}" : [ ] - }, { - "Read - /{component-type}/{uuid} - For all encapsulated components" : [ ] - }, { - "Read - any referenced Controller Services by any encapsulated components - /controller-services/{uuid}" : [ ] - } ] - }, - "put" : { - "tags" : [ "versions" ], - "summary" : "Update the version of a Process Group with the given ID", - "description" : "For a Process Group that is already under Version Control, this will update the version of the flow to a different version. This endpoint expects that the given snapshot will not modify any Processor that is currently running or any Controller Service that is enabled. Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "updateFlowVersion", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The controller service configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/VersionedFlowSnapshotEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionControlInformationEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - }, { - "Write - /process-groups/{uuid}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "versions" ], - "summary" : "Stops version controlling the Process Group with the given ID", - "description" : "Stops version controlling the Process Group with the given ID. The Process Group will no longer track to any Versioned Flow. Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "stopVersionControl", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The version is used to verify the client is working with the latest version of the flow.", - "required" : false, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, a new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionControlInformationEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - }, { - "Write - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/versions/revert-requests/process-groups/{id}" : { - "post" : { - "tags" : [ "versions" ], - "summary" : "Initiate the Revert Request of a Process Group with the given ID", - "description" : "For a Process Group that is already under Version Control, this will initiate the action of reverting any local changes that have been made to the Process Group since it was last synchronized with the Flow Registry. This will result in the flow matching the Versioned Flow that exists in the Flow Registry. This can be a lengthy process, as it will stop any Processors and disable any Controller Services necessary to perform the action and then restart them. As a result, the endpoint will immediately return a VersionedFlowUpdateRequestEntity, and the process of updating the flow will occur asynchronously in the background. The client may then periodically poll the status of the request by issuing a GET request to /versions/revert-requests/{requestId}. Once the request is completed, the client is expected to issue a DELETE request to /versions/revert-requests/{requestId}. Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "initiateRevertFlowVersion", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The controller service configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/VersionControlInformationEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlowUpdateRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - }, { - "Write - /process-groups/{uuid}" : [ ] - }, { - "Read - /{component-type}/{uuid} - For all encapsulated components" : [ ] - }, { - "Write - /{component-type}/{uuid} - For all encapsulated components" : [ ] - }, { - "Write - if the template contains any restricted components - /restricted-components" : [ ] - } ] - } - }, - "/versions/revert-requests/{id}" : { - "get" : { - "tags" : [ "versions" ], - "summary" : "Returns the Revert Request with the given ID", - "description" : "Returns the Revert Request with the given ID. Once a Revert Request has been created by performing a POST to /versions/revert-requests/process-groups/{id}, that request can subsequently be retrieved via this endpoint, and the request that is fetched will contain the updated state, such as percent complete, the current state of the request, and any failures. Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getRevertRequest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The ID of the Revert Request", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlowUpdateRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Only the user that submitted the request can get it" : [ ] - } ] - }, - "delete" : { - "tags" : [ "versions" ], - "summary" : "Deletes the Revert Request with the given ID", - "description" : "Deletes the Revert Request with the given ID. After a request is created via a POST to /versions/revert-requests/process-groups/{id}, it is expected that the client will properly clean up the request by DELETE'ing it, once the Revert process has completed. If the request is deleted before the request completes, then the Revert request will finish the step that it is currently performing and then will cancel any subsequent steps. Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "deleteRevertRequest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The ID of the Revert Request", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlowUpdateRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Only the user that submitted the request can remove it" : [ ] - } ] - } - }, - "/versions/update-requests/process-groups/{id}" : { - "post" : { - "tags" : [ "versions" ], - "summary" : "Initiate the Update Request of a Process Group with the given ID", - "description" : "For a Process Group that is already under Version Control, this will initiate the action of changing from a specific version of the flow in the Flow Registry to a different version of the flow. This can be a lengthy process, as it will stop any Processors and disable any Controller Services necessary to perform the action and then restart them. As a result, the endpoint will immediately return a VersionedFlowUpdateRequestEntity, and the process of updating the flow will occur asynchronously in the background. The client may then periodically poll the status of the request by issuing a GET request to /versions/update-requests/{requestId}. Once the request is completed, the client is expected to issue a DELETE request to /versions/update-requests/{requestId}. Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "initiateVersionControlUpdate", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The controller service configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/VersionControlInformationEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlowUpdateRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - }, { - "Write - /process-groups/{uuid}" : [ ] - }, { - "Read - /{component-type}/{uuid} - For all encapsulated components" : [ ] - }, { - "Write - /{component-type}/{uuid} - For all encapsulated components" : [ ] - }, { - "Write - if the template contains any restricted components - /restricted-components" : [ ] - } ] - } - }, - "/versions/update-requests/{id}" : { - "get" : { - "tags" : [ "versions" ], - "summary" : "Returns the Update Request with the given ID", - "description" : "Returns the Update Request with the given ID. Once an Update Request has been created by performing a POST to /versions/update-requests/process-groups/{id}, that request can subsequently be retrieved via this endpoint, and the request that is fetched will contain the updated state, such as percent complete, the current state of the request, and any failures. Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getUpdateRequest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The ID of the Update Request", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlowUpdateRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Only the user that submitted the request can get it" : [ ] - } ] - }, - "delete" : { - "tags" : [ "versions" ], - "summary" : "Deletes the Update Request with the given ID", - "description" : "Deletes the Update Request with the given ID. After a request is created via a POST to /versions/update-requests/process-groups/{id}, it is expected that the client will properly clean up the request by DELETE'ing it, once the Update process has completed. If the request is deleted before the request completes, then the Update request will finish the step that it is currently performing and then will cancel any subsequent steps. Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "deleteUpdateRequest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The ID of the Update Request", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlowUpdateRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Only the user that submitted the request can remove it" : [ ] - } ] - } - } - }, - "definitions" : { - "AboutDTO" : { - "type" : "object", - "properties" : { - "title" : { - "type" : "string", - "description" : "The title to be used on the page and in the about dialog." - }, - "version" : { - "type" : "string", - "description" : "The version of this NiFi." - }, - "uri" : { - "type" : "string", - "description" : "The URI for the NiFi." - }, - "contentViewerUrl" : { - "type" : "string", - "description" : "The URL for the content viewer if configured." - }, - "timezone" : { - "type" : "string", - "description" : "The timezone of the NiFi instance.", - "readOnly" : true - }, - "buildTag" : { - "type" : "string", - "description" : "Build tag" - }, - "buildRevision" : { - "type" : "string", - "description" : "Build revision or commit hash" - }, - "buildBranch" : { - "type" : "string", - "description" : "Build branch" - }, - "buildTimestamp" : { - "type" : "string", - "description" : "Build timestamp" - } - } - }, - "AboutEntity" : { - "type" : "object", - "properties" : { - "about" : { - "$ref" : "#/definitions/AboutDTO" - } - }, - "xml" : { - "name" : "aboutEntity" - } - }, - "AccessConfigurationDTO" : { - "type" : "object", - "properties" : { - "supportsLogin" : { - "type" : "boolean", - "description" : "Indicates whether or not this NiFi supports user login.", - "readOnly" : true - } - } - }, - "AccessConfigurationEntity" : { - "type" : "object", - "properties" : { - "config" : { - "$ref" : "#/definitions/AccessConfigurationDTO" - } - }, - "xml" : { - "name" : "accessConfigurationEntity" - } - }, - "AccessPolicyDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "versionedComponentId" : { - "type" : "string", - "description" : "The ID of the corresponding component that is under version control" - }, - "parentGroupId" : { - "type" : "string", - "description" : "The id of parent process group of this component if applicable." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "resource" : { - "type" : "string", - "description" : "The resource for this access policy." - }, - "action" : { - "type" : "string", - "description" : "The action associated with this access policy.", - "enum" : [ "read", "write" ] - }, - "componentReference" : { - "description" : "Component this policy references if applicable.", - "$ref" : "#/definitions/ComponentReferenceEntity" - }, - "configurable" : { - "type" : "boolean", - "description" : "Whether this policy is configurable." - }, - "users" : { - "type" : "array", - "description" : "The set of user IDs associated with this access policy.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/TenantEntity" - } - }, - "userGroups" : { - "type" : "array", - "description" : "The set of user group IDs associated with this access policy.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/TenantEntity" - } - } - } - }, - "AccessPolicyEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "generated" : { - "type" : "string", - "description" : "When this content was generated." - }, - "component" : { - "$ref" : "#/definitions/AccessPolicyDTO" - } - }, - "xml" : { - "name" : "accessPolicyEntity" - } - }, - "AccessPolicySummaryDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "versionedComponentId" : { - "type" : "string", - "description" : "The ID of the corresponding component that is under version control" - }, - "parentGroupId" : { - "type" : "string", - "description" : "The id of parent process group of this component if applicable." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "resource" : { - "type" : "string", - "description" : "The resource for this access policy." - }, - "action" : { - "type" : "string", - "description" : "The action associated with this access policy.", - "enum" : [ "read", "write" ] - }, - "componentReference" : { - "description" : "Component this policy references if applicable.", - "$ref" : "#/definitions/ComponentReferenceEntity" - }, - "configurable" : { - "type" : "boolean", - "description" : "Whether this policy is configurable." - } - } - }, - "AccessPolicySummaryEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "component" : { - "$ref" : "#/definitions/AccessPolicySummaryDTO" - } - }, - "xml" : { - "name" : "accessPolicySummaryEntity" - } - }, - "AccessStatusDTO" : { - "type" : "object", - "properties" : { - "identity" : { - "type" : "string", - "description" : "The user identity.", - "readOnly" : true - }, - "status" : { - "type" : "string", - "description" : "The user access status.", - "readOnly" : true - }, - "message" : { - "type" : "string", - "description" : "Additional details about the user access status.", - "readOnly" : true - } - }, - "xml" : { - "name" : "accessStatus" - } - }, - "AccessStatusEntity" : { - "type" : "object", - "properties" : { - "accessStatus" : { - "$ref" : "#/definitions/AccessStatusDTO" - } - }, - "xml" : { - "name" : "accessStatusEntity" - } - }, - "ActionDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "integer", - "format" : "int32", - "description" : "The action id." - }, - "userIdentity" : { - "type" : "string", - "description" : "The identity of the user that performed the action." - }, - "timestamp" : { - "type" : "string", - "description" : "The timestamp of the action." - }, - "sourceId" : { - "type" : "string", - "description" : "The id of the source component." - }, - "sourceName" : { - "type" : "string", - "description" : "The name of the source component." - }, - "sourceType" : { - "type" : "string", - "description" : "The type of the source component." - }, - "componentDetails" : { - "description" : "The details of the source component.", - "$ref" : "#/definitions/ComponentDetailsDTO" - }, - "operation" : { - "type" : "string", - "description" : "The operation that was performed." - }, - "actionDetails" : { - "description" : "The details of the action.", - "$ref" : "#/definitions/ActionDetailsDTO" - } - } - }, - "ActionDetailsDTO" : { - "type" : "object" - }, - "ActionEntity" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "integer", - "format" : "int32" - }, - "timestamp" : { - "type" : "string", - "description" : "The timestamp of the action." - }, - "sourceId" : { - "type" : "string" - }, - "canRead" : { - "type" : "boolean", - "description" : "Indicates whether the user can read a given resource.", - "readOnly" : true - }, - "action" : { - "$ref" : "#/definitions/ActionDTO" - } - }, - "xml" : { - "name" : "actionEntity" - } - }, - "ActivateControllerServicesEntity" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the ProcessGroup" - }, - "state" : { - "type" : "string", - "description" : "The desired state of the descendant components", - "enum" : [ "ENABLED", "DISABLED" ] - }, - "components" : { - "type" : "object", - "description" : "Optional services to schedule. If not specified, all authorized descendant controller services will be used.", - "additionalProperties" : { - "$ref" : "#/definitions/RevisionDTO" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - } - }, - "xml" : { - "name" : "activateControllerServicesEntity" - } - }, - "AffectedComponentDTO" : { - "type" : "object", - "properties" : { - "processGroupId" : { - "type" : "string", - "description" : "The UUID of the Process Group that this component is in" - }, - "id" : { - "type" : "string", - "description" : "The UUID of this component" - }, - "referenceType" : { - "type" : "string", - "description" : "The type of this component", - "enum" : [ "PROCESSOR", "CONTROLLER_SERVICE", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT" ] - }, - "name" : { - "type" : "string", - "description" : "The name of this component." - }, - "state" : { - "type" : "string", - "description" : "The scheduled state of a processor or reporting task referencing a controller service. If this component is another controller service, this field represents the controller service state." - }, - "activeThreadCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of active threads for the referencing component." - }, - "validationErrors" : { - "type" : "array", - "description" : "The validation errors for the component.", - "items" : { - "type" : "string" - } - } - } - }, - "AffectedComponentEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "component" : { - "$ref" : "#/definitions/AffectedComponentDTO" - } - }, - "xml" : { - "name" : "affectComponentEntity" - } - }, - "AllowableValueDTO" : { - "type" : "object", - "properties" : { - "displayName" : { - "type" : "string", - "description" : "A human readable value that is allowed for the property descriptor." - }, - "value" : { - "type" : "string", - "description" : "A value that is allowed for the property descriptor." - }, - "description" : { - "type" : "string", - "description" : "A description for this allowable value." - } - } - }, - "AllowableValueEntity" : { - "type" : "object", - "properties" : { - "allowableValue" : { - "$ref" : "#/definitions/AllowableValueDTO" - }, - "canRead" : { - "type" : "boolean", - "description" : "Indicates whether the user can read a given resource.", - "readOnly" : true - } - }, - "xml" : { - "name" : "entity" - } - }, - "AttributeDTO" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The attribute name." - }, - "value" : { - "type" : "string", - "description" : "The attribute value." - }, - "previousValue" : { - "type" : "string", - "description" : "The value of the attribute before the event took place." - } - } - }, - "BannerDTO" : { - "type" : "object", - "properties" : { - "headerText" : { - "type" : "string", - "description" : "The header text." - }, - "footerText" : { - "type" : "string", - "description" : "The footer text." - } - } - }, - "BannerEntity" : { - "type" : "object", - "properties" : { - "banners" : { - "$ref" : "#/definitions/BannerDTO" - } - }, - "xml" : { - "name" : "bannersEntity" - } - }, - "BatchSettingsDTO" : { - "type" : "object", - "properties" : { - "count" : { - "type" : "integer", - "format" : "int32", - "description" : "Preferred number of flow files to include in a transaction." - }, - "size" : { - "type" : "string", - "description" : "Preferred number of bytes to include in a transaction." - }, - "duration" : { - "type" : "string", - "description" : "Preferred amount of time that a transaction should span." - } - } - }, - "BatchSize" : { - "type" : "object", - "properties" : { - "count" : { - "type" : "integer", - "format" : "int32", - "description" : "Preferred number of flow files to include in a transaction." - }, - "size" : { - "type" : "string", - "description" : "Preferred number of bytes to include in a transaction." - }, - "duration" : { - "type" : "string", - "description" : "Preferred amount of time that a transaction should span." - } - } - }, - "BucketDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The bucket identifier" - }, - "name" : { - "type" : "string", - "description" : "The bucket name" - }, - "description" : { - "type" : "string", - "description" : "The bucket description" - }, - "created" : { - "type" : "integer", - "format" : "int64", - "description" : "The created timestamp of this bucket" - } - } - }, - "BucketEntity" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string" - }, - "bucket" : { - "$ref" : "#/definitions/BucketDTO" - }, - "permissions" : { - "$ref" : "#/definitions/PermissionsDTO" - } - }, - "xml" : { - "name" : "bucketEntity" - } - }, - "BucketsEntity" : { - "type" : "object", - "properties" : { - "buckets" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/BucketEntity" - } - } - }, - "xml" : { - "name" : "bucketsEntity" - } - }, - "BulletinBoardDTO" : { - "type" : "object", - "properties" : { - "bulletins" : { - "type" : "array", - "description" : "The bulletins in the bulletin board, that matches the supplied request.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "generated" : { - "type" : "string", - "description" : "The timestamp when this report was generated." - } - } - }, - "BulletinBoardEntity" : { - "type" : "object", - "properties" : { - "bulletinBoard" : { - "$ref" : "#/definitions/BulletinBoardDTO" - } - }, - "xml" : { - "name" : "bulletinBoardEntity" - } - }, - "BulletinDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "integer", - "format" : "int64", - "description" : "The id of the bulletin." - }, - "nodeAddress" : { - "type" : "string", - "description" : "If clustered, the address of the node from which the bulletin originated." - }, - "category" : { - "type" : "string", - "description" : "The category of this bulletin." - }, - "groupId" : { - "type" : "string", - "description" : "The group id of the source component." - }, - "sourceId" : { - "type" : "string", - "description" : "The id of the source component." - }, - "sourceName" : { - "type" : "string", - "description" : "The name of the source component." - }, - "level" : { - "type" : "string", - "description" : "The level of the bulletin." - }, - "message" : { - "type" : "string", - "description" : "The bulletin message." - }, - "timestamp" : { - "type" : "string", - "description" : "When this bulletin was generated." - } - } - }, - "BulletinEntity" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "integer", - "format" : "int64" - }, - "groupId" : { - "type" : "string" - }, - "sourceId" : { - "type" : "string" - }, - "timestamp" : { - "type" : "string", - "description" : "When this bulletin was generated." - }, - "nodeAddress" : { - "type" : "string" - }, - "canRead" : { - "type" : "boolean", - "description" : "Indicates whether the user can read a given resource.", - "readOnly" : true - }, - "bulletin" : { - "$ref" : "#/definitions/BulletinDTO" - } - }, - "xml" : { - "name" : "bulletinEntity" - } - }, - "Bundle" : { - "type" : "object", - "properties" : { - "group" : { - "type" : "string", - "description" : "The group of the bundle" - }, - "artifact" : { - "type" : "string", - "description" : "The artifact of the bundle" - }, - "version" : { - "type" : "string", - "description" : "The version of the bundle" - } - } - }, - "BundleDTO" : { - "type" : "object", - "properties" : { - "group" : { - "type" : "string", - "description" : "The group of the bundle." - }, - "artifact" : { - "type" : "string", - "description" : "The artifact of the bundle." - }, - "version" : { - "type" : "string", - "description" : "The version of the bundle." - } - } - }, - "ClusteSummaryEntity" : { - "type" : "object", - "properties" : { - "clusterSummary" : { - "$ref" : "#/definitions/ClusterSummaryDTO" - } - }, - "xml" : { - "name" : "clusterSummaryEntity" - } - }, - "ClusterDTO" : { - "type" : "object", - "properties" : { - "nodes" : { - "type" : "array", - "description" : "The collection of nodes that are part of the cluster.", - "items" : { - "$ref" : "#/definitions/NodeDTO" - } - }, - "generated" : { - "type" : "string", - "description" : "The timestamp the report was generated." - } - } - }, - "ClusterEntity" : { - "type" : "object", - "properties" : { - "cluster" : { - "$ref" : "#/definitions/ClusterDTO" - } - }, - "xml" : { - "name" : "clusterEntity" - } - }, - "ClusterSearchResultsEntity" : { - "type" : "object", - "properties" : { - "nodeResults" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/NodeSearchResultDTO" - } - } - }, - "xml" : { - "name" : "clusterSearchResultsEntity" - } - }, - "ClusterSummaryDTO" : { - "type" : "object", - "properties" : { - "connectedNodes" : { - "type" : "string", - "description" : "When clustered, reports the number of nodes connected vs the number of nodes in the cluster." - }, - "connectedNodeCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of nodes that are currently connected to the cluster" - }, - "totalNodeCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of nodes in the cluster, regardless of whether or not they are connected" - }, - "clustered" : { - "type" : "boolean", - "description" : "Whether this NiFi instance is clustered." - }, - "connectedToCluster" : { - "type" : "boolean", - "description" : "Whether this NiFi instance is connected to a cluster." - } - } - }, - "ComponentDetailsDTO" : { - "type" : "object" - }, - "ComponentDifferenceDTO" : { - "type" : "object", - "properties" : { - "componentType" : { - "type" : "string", - "description" : "The type of component" - }, - "componentId" : { - "type" : "string", - "description" : "The ID of the component" - }, - "componentName" : { - "type" : "string", - "description" : "The name of the component" - }, - "processGroupId" : { - "type" : "string", - "description" : "The ID of the Process Group that the component belongs to" - }, - "differences" : { - "type" : "array", - "description" : "The differences in the component between the two flows", - "items" : { - "$ref" : "#/definitions/DifferenceDTO" - } - } - } - }, - "ComponentHistoryDTO" : { - "type" : "object", - "properties" : { - "componentId" : { - "type" : "string", - "description" : "The component id." - }, - "propertyHistory" : { - "type" : "object", - "description" : "The history for the properties of the component.", - "additionalProperties" : { - "$ref" : "#/definitions/PropertyHistoryDTO" - } - } - } - }, - "ComponentHistoryEntity" : { - "type" : "object", - "properties" : { - "componentHistory" : { - "$ref" : "#/definitions/ComponentHistoryDTO" - } - }, - "xml" : { - "name" : "componentHistoryEntity" - } - }, - "ComponentReferenceDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "versionedComponentId" : { - "type" : "string", - "description" : "The ID of the corresponding component that is under version control" - }, - "parentGroupId" : { - "type" : "string", - "description" : "The id of parent process group of this component if applicable." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "name" : { - "type" : "string", - "description" : "The name of the component." - } - } - }, - "ComponentReferenceEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "parentGroupId" : { - "type" : "string", - "description" : "The id of parent process group of this component if applicable." - }, - "component" : { - "$ref" : "#/definitions/ComponentReferenceDTO" - } - }, - "xml" : { - "name" : "componentReferenceEntity" - } - }, - "ComponentRestrictionPermissionDTO" : { - "type" : "object", - "properties" : { - "requiredPermission" : { - "description" : "The required permission necessary for this restriction.", - "$ref" : "#/definitions/RequiredPermissionDTO" - }, - "permissions" : { - "description" : "The permissions for this component restriction. Note: the read permission are not used and will always be false.", - "$ref" : "#/definitions/PermissionsDTO" - } - } - }, - "ComponentSearchResultDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component that matched the search." - }, - "groupId" : { - "type" : "string", - "description" : "The group id of the component that matched the search." - }, - "parentGroup" : { - "description" : "The parent group of the component that matched the search.", - "$ref" : "#/definitions/SearchResultGroupDTO" - }, - "versionedGroup" : { - "description" : "The nearest versioned ancestor group of the component that matched the search.", - "$ref" : "#/definitions/SearchResultGroupDTO" - }, - "name" : { - "type" : "string", - "description" : "The name of the component that matched the search." - }, - "matches" : { - "type" : "array", - "description" : "What matched the search from the component.", - "items" : { - "type" : "string" - } - } - } - }, - "ComponentStateDTO" : { - "type" : "object", - "properties" : { - "componentId" : { - "type" : "string", - "description" : "The component identifier." - }, - "stateDescription" : { - "type" : "string", - "description" : "Description of the state this component persists." - }, - "clusterState" : { - "description" : "The cluster state for this component, or null if this NiFi is a standalone instance.", - "$ref" : "#/definitions/StateMapDTO" - }, - "localState" : { - "description" : "The local state for this component.", - "$ref" : "#/definitions/StateMapDTO" - } - } - }, - "ComponentStateEntity" : { - "type" : "object", - "properties" : { - "componentState" : { - "description" : "The component state.", - "$ref" : "#/definitions/ComponentStateDTO" - } - }, - "xml" : { - "name" : "componentStateEntity" - } - }, - "ConnectableComponent" : { - "type" : "object", - "required" : [ "groupId", "id", "type" ], - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the connectable component." - }, - "type" : { - "type" : "string", - "description" : "The type of component the connectable is.", - "enum" : [ "PROCESSOR", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "INPUT_PORT", "OUTPUT_PORT", "FUNNEL" ] - }, - "groupId" : { - "type" : "string", - "description" : "The id of the group that the connectable component resides in" - }, - "name" : { - "type" : "string", - "description" : "The name of the connectable component" - }, - "comments" : { - "type" : "string", - "description" : "The comments for the connectable component." - } - } - }, - "ConnectableDTO" : { - "type" : "object", - "required" : [ "groupId", "id", "type" ], - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the connectable component." - }, - "versionedComponentId" : { - "type" : "string", - "description" : "The ID of the corresponding component that is under version control" - }, - "type" : { - "type" : "string", - "description" : "The type of component the connectable is.", - "enum" : [ "PROCESSOR", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "INPUT_PORT", "OUTPUT_PORT", "FUNNEL" ] - }, - "groupId" : { - "type" : "string", - "description" : "The id of the group that the connectable component resides in" - }, - "name" : { - "type" : "string", - "description" : "The name of the connectable component" - }, - "running" : { - "type" : "boolean", - "description" : "Reflects the current state of the connectable component." - }, - "transmitting" : { - "type" : "boolean", - "description" : "If the connectable component represents a remote port, indicates if the target is configured to transmit." - }, - "exists" : { - "type" : "boolean", - "description" : "If the connectable component represents a remote port, indicates if the target exists." - }, - "comments" : { - "type" : "string", - "description" : "The comments for the connectable component." - } - } - }, - "ConnectionDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "versionedComponentId" : { - "type" : "string", - "description" : "The ID of the corresponding component that is under version control" - }, - "parentGroupId" : { - "type" : "string", - "description" : "The id of parent process group of this component if applicable." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "source" : { - "description" : "The source of the connection.", - "$ref" : "#/definitions/ConnectableDTO" - }, - "destination" : { - "description" : "The destination of the connection.", - "$ref" : "#/definitions/ConnectableDTO" - }, - "name" : { - "type" : "string", - "description" : "The name of the connection." - }, - "labelIndex" : { - "type" : "integer", - "format" : "int32", - "description" : "The index of the bend point where to place the connection label." - }, - "getzIndex" : { - "type" : "integer", - "format" : "int64", - "description" : "The z index of the connection." - }, - "selectedRelationships" : { - "type" : "array", - "description" : "The selected relationship that comprise the connection.", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - }, - "availableRelationships" : { - "type" : "array", - "description" : "The relationships that the source of the connection currently supports.", - "readOnly" : true, - "uniqueItems" : true, - "items" : { - "type" : "string" - } - }, - "backPressureObjectThreshold" : { - "type" : "integer", - "format" : "int64", - "description" : "The object count threshold for determining when back pressure is applied. Updating this value is a passive change in the sense that it won't impact whether existing files over the limit are affected but it does help feeder processors to stop pushing too much into this work queue." - }, - "backPressureDataSizeThreshold" : { - "type" : "string", - "description" : "The object data size threshold for determining when back pressure is applied. Updating this value is a passive change in the sense that it won't impact whether existing files over the limit are affected but it does help feeder processors to stop pushing too much into this work queue." - }, - "flowFileExpiration" : { - "type" : "string", - "description" : "The amount of time a flow file may be in the flow before it will be automatically aged out of the flow. Once a flow file reaches this age it will be terminated from the flow the next time a processor attempts to start work on it." - }, - "prioritizers" : { - "type" : "array", - "description" : "The comparators used to prioritize the queue.", - "items" : { - "type" : "string" - } - }, - "bends" : { - "type" : "array", - "description" : "The bend points on the connection.", - "items" : { - "$ref" : "#/definitions/PositionDTO" - } - }, - "loadBalanceStrategy" : { - "type" : "string", - "description" : "How to load balance the data in this Connection across the nodes in the cluster.", - "enum" : [ "DO_NOT_LOAD_BALANCE", "PARTITION_BY_ATTRIBUTE", "ROUND_ROBIN", "SINGLE_NODE" ] - }, - "loadBalancePartitionAttribute" : { - "type" : "string", - "description" : "The FlowFile Attribute to use for determining which node a FlowFile will go to if the Load Balancing Strategy is set to PARTITION_BY_ATTRIBUTE" - }, - "loadBalanceCompression" : { - "type" : "string", - "description" : "Whether or not data should be compressed when being transferred between nodes in the cluster.", - "enum" : [ "DO_NOT_COMPRESS", "COMPRESS_ATTRIBUTES_ONLY", "COMPRESS_ATTRIBUTES_AND_CONTENT" ] - }, - "loadBalanceStatus" : { - "type" : "string", - "description" : "The current status of the Connection's Load Balancing Activities. Status can indicate that Load Balancing is not configured for the connection, that Load Balancing is configured but inactive (not currently transferring data to another node), or that Load Balancing is configured and actively transferring data to another node.", - "readOnly" : true, - "enum" : [ "LOAD_BALANCE_NOT_CONFIGURED", "LOAD_BALANCE_INACTIVE", "LOAD_BALANCE_ACTIVE" ] - } - } - }, - "ConnectionEntity" : { - "type" : "object", - "required" : [ "destinationType", "sourceType" ], - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "component" : { - "$ref" : "#/definitions/ConnectionDTO" - }, - "status" : { - "description" : "The status of the connection.", - "$ref" : "#/definitions/ConnectionStatusDTO" - }, - "bends" : { - "type" : "array", - "description" : "The bend points on the connection.", - "items" : { - "$ref" : "#/definitions/PositionDTO" - } - }, - "labelIndex" : { - "type" : "integer", - "format" : "int32", - "description" : "The index of the bend point where to place the connection label." - }, - "getzIndex" : { - "type" : "integer", - "format" : "int64", - "description" : "The z index of the connection." - }, - "sourceId" : { - "type" : "string", - "description" : "The identifier of the source of this connection." - }, - "sourceGroupId" : { - "type" : "string", - "description" : "The identifier of the group of the source of this connection." - }, - "sourceType" : { - "type" : "string", - "description" : "The type of component the source connectable is.", - "enum" : [ "PROCESSOR", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "INPUT_PORT", "OUTPUT_PORT", "FUNNEL" ] - }, - "destinationId" : { - "type" : "string", - "description" : "The identifier of the destination of this connection." - }, - "destinationGroupId" : { - "type" : "string", - "description" : "The identifier of the group of the destination of this connection." - }, - "destinationType" : { - "type" : "string", - "description" : "The type of component the destination connectable is.", - "enum" : [ "PROCESSOR", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "INPUT_PORT", "OUTPUT_PORT", "FUNNEL" ] - } - }, - "xml" : { - "name" : "connectionEntity" - } - }, - "ConnectionStatusDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The ID of the connection" - }, - "groupId" : { - "type" : "string", - "description" : "The ID of the Process Group that the connection belongs to" - }, - "name" : { - "type" : "string", - "description" : "The name of the connection" - }, - "statsLastRefreshed" : { - "type" : "string", - "description" : "The timestamp of when the stats were last refreshed" - }, - "sourceId" : { - "type" : "string", - "description" : "The ID of the source component" - }, - "sourceName" : { - "type" : "string", - "description" : "The name of the source component" - }, - "destinationId" : { - "type" : "string", - "description" : "The ID of the destination component" - }, - "destinationName" : { - "type" : "string", - "description" : "The name of the destination component" - }, - "aggregateSnapshot" : { - "description" : "The status snapshot that represents the aggregate stats of the cluster", - "$ref" : "#/definitions/ConnectionStatusSnapshotDTO" - }, - "nodeSnapshots" : { - "type" : "array", - "description" : "A list of status snapshots for each node", - "items" : { - "$ref" : "#/definitions/NodeConnectionStatusSnapshotDTO" - } - } - } - }, - "ConnectionStatusEntity" : { - "type" : "object", - "properties" : { - "connectionStatus" : { - "$ref" : "#/definitions/ConnectionStatusDTO" - }, - "canRead" : { - "type" : "boolean", - "description" : "Indicates whether the user can read a given resource.", - "readOnly" : true - } - }, - "xml" : { - "name" : "connectionStatusEntity" - } - }, - "ConnectionStatusSnapshotDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the connection." - }, - "groupId" : { - "type" : "string", - "description" : "The id of the process group the connection belongs to." - }, - "name" : { - "type" : "string", - "description" : "The name of the connection." - }, - "sourceId" : { - "type" : "string", - "description" : "The id of the source of the connection." - }, - "sourceName" : { - "type" : "string", - "description" : "The name of the source of the connection." - }, - "destinationId" : { - "type" : "string", - "description" : "The id of the destination of the connection." - }, - "destinationName" : { - "type" : "string", - "description" : "The name of the destination of the connection." - }, - "flowFilesIn" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of FlowFiles that have come into the connection in the last 5 minutes." - }, - "bytesIn" : { - "type" : "integer", - "format" : "int64", - "description" : "The size of the FlowFiles that have come into the connection in the last 5 minutes." - }, - "input" : { - "type" : "string", - "description" : "The input count/size for the connection in the last 5 minutes, pretty printed." - }, - "flowFilesOut" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of FlowFiles that have left the connection in the last 5 minutes." - }, - "bytesOut" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes that have left the connection in the last 5 minutes." - }, - "output" : { - "type" : "string", - "description" : "The output count/sie for the connection in the last 5 minutes, pretty printed." - }, - "flowFilesQueued" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of FlowFiles that are currently queued in the connection." - }, - "bytesQueued" : { - "type" : "integer", - "format" : "int64", - "description" : "The size of the FlowFiles that are currently queued in the connection." - }, - "queued" : { - "type" : "string", - "description" : "The total count and size of queued flowfiles formatted." - }, - "queuedSize" : { - "type" : "string", - "description" : "The total size of flowfiles that are queued formatted." - }, - "queuedCount" : { - "type" : "string", - "description" : "The number of flowfiles that are queued, pretty printed." - }, - "percentUseCount" : { - "type" : "integer", - "format" : "int32", - "description" : "Connection percent use regarding queued flow files count and backpressure threshold if configured." - }, - "percentUseBytes" : { - "type" : "integer", - "format" : "int32", - "description" : "Connection percent use regarding queued flow files size and backpressure threshold if configured." - } - } - }, - "ConnectionStatusSnapshotEntity" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the connection." - }, - "connectionStatusSnapshot" : { - "$ref" : "#/definitions/ConnectionStatusSnapshotDTO" - }, - "canRead" : { - "type" : "boolean", - "description" : "Indicates whether the user can read a given resource.", - "readOnly" : true - } - }, - "xml" : { - "name" : "entity" - } - }, - "ConnectionsEntity" : { - "type" : "object", - "properties" : { - "connections" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ConnectionEntity" - } - } - }, - "xml" : { - "name" : "connectionsEntity" - } - }, - "ControllerBulletinsEntity" : { - "type" : "object", - "properties" : { - "bulletins" : { - "type" : "array", - "description" : "System level bulletins to be reported to the user.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "controllerServiceBulletins" : { - "type" : "array", - "description" : "Controller service bulletins to be reported to the user.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "reportingTaskBulletins" : { - "type" : "array", - "description" : "Reporting task bulletins to be reported to the user.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - } - }, - "xml" : { - "name" : "controllerConfigurationEntity" - } - }, - "ControllerConfigurationDTO" : { - "type" : "object", - "properties" : { - "maxTimerDrivenThreadCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The maximum number of timer driven threads the NiFi has available." - }, - "maxEventDrivenThreadCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The maximum number of event driven threads the NiFi has available." - } - } - }, - "ControllerConfigurationEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "component" : { - "description" : "The controller configuration.", - "$ref" : "#/definitions/ControllerConfigurationDTO" - } - }, - "xml" : { - "name" : "controllerConfigurationEntity" - } - }, - "ControllerDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the NiFi." - }, - "name" : { - "type" : "string", - "description" : "The name of the NiFi." - }, - "comments" : { - "type" : "string", - "description" : "The comments for the NiFi." - }, - "runningCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of running components in the NiFi." - }, - "stoppedCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of stopped components in the NiFi." - }, - "invalidCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of invalid components in the NiFi." - }, - "disabledCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of disabled components in the NiFi." - }, - "activeRemotePortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of active remote ports contained in the NiFi." - }, - "inactiveRemotePortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of inactive remote ports contained in the NiFi." - }, - "inputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of input ports contained in the NiFi." - }, - "outputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of output ports in the NiFi." - }, - "remoteSiteListeningPort" : { - "type" : "integer", - "format" : "int32", - "description" : "The Socket Port on which this instance is listening for Remote Transfers of Flow Files. If this instance is not configured to receive Flow Files from remote instances, this will be null." - }, - "remoteSiteHttpListeningPort" : { - "type" : "integer", - "format" : "int32", - "description" : "The HTTP(S) Port on which this instance is listening for Remote Transfers of Flow Files. If this instance is not configured to receive Flow Files from remote instances, this will be null." - }, - "siteToSiteSecure" : { - "type" : "boolean", - "description" : "Indicates whether or not Site-to-Site communications with this instance is secure (2-way authentication)." - }, - "instanceId" : { - "type" : "string", - "description" : "If clustered, the id of the Cluster Manager, otherwise the id of the NiFi." - }, - "inputPorts" : { - "type" : "array", - "description" : "The input ports available to send data to for the NiFi.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/PortDTO" - } - }, - "outputPorts" : { - "type" : "array", - "description" : "The output ports available to received data from the NiFi.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/PortDTO" - } - } - } - }, - "ControllerEntity" : { - "type" : "object", - "properties" : { - "controller" : { - "$ref" : "#/definitions/ControllerDTO" - } - }, - "xml" : { - "name" : "controllerEntity" - } - }, - "ControllerServiceAPI" : { - "type" : "object", - "properties" : { - "type" : { - "type" : "string", - "description" : "The fully qualified name of the service interface." - }, - "bundle" : { - "description" : "The details of the artifact that bundled this service interface.", - "$ref" : "#/definitions/Bundle" - } - } - }, - "ControllerServiceApiDTO" : { - "type" : "object", - "properties" : { - "type" : { - "type" : "string", - "description" : "The fully qualified name of the service interface." - }, - "bundle" : { - "description" : "The details of the artifact that bundled this service interface.", - "$ref" : "#/definitions/BundleDTO" - } - } - }, - "ControllerServiceDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "versionedComponentId" : { - "type" : "string", - "description" : "The ID of the corresponding component that is under version control" - }, - "parentGroupId" : { - "type" : "string", - "description" : "The id of parent process group of this component if applicable." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "name" : { - "type" : "string", - "description" : "The name of the controller service." - }, - "type" : { - "type" : "string", - "description" : "The type of the controller service." - }, - "bundle" : { - "description" : "The details of the artifact that bundled this processor type.", - "$ref" : "#/definitions/BundleDTO" - }, - "controllerServiceApis" : { - "type" : "array", - "description" : "Lists the APIs this Controller Service implements.", - "items" : { - "$ref" : "#/definitions/ControllerServiceApiDTO" - } - }, - "comments" : { - "type" : "string", - "description" : "The comments for the controller service." - }, - "state" : { - "type" : "string", - "description" : "The state of the controller service.", - "enum" : [ "ENABLED", "ENABLING", "DISABLED", "DISABLING" ] - }, - "persistsState" : { - "type" : "boolean", - "description" : "Whether the controller service persists state." - }, - "restricted" : { - "type" : "boolean", - "description" : "Whether the controller service requires elevated privileges." - }, - "deprecated" : { - "type" : "boolean", - "description" : "Whether the ontroller service has been deprecated." - }, - "multipleVersionsAvailable" : { - "type" : "boolean", - "description" : "Whether the controller service has multiple versions available." - }, - "properties" : { - "type" : "object", - "description" : "The properties of the controller service.", - "additionalProperties" : { - "type" : "string" - } - }, - "descriptors" : { - "type" : "object", - "description" : "The descriptors for the controller service properties.", - "additionalProperties" : { - "$ref" : "#/definitions/PropertyDescriptorDTO" - } - }, - "customUiUrl" : { - "type" : "string", - "description" : "The URL for the controller services custom configuration UI if applicable." - }, - "annotationData" : { - "type" : "string", - "description" : "The annotation for the controller service. This is how the custom UI relays configuration to the controller service." - }, - "referencingComponents" : { - "type" : "array", - "description" : "All components referencing this controller service.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ControllerServiceReferencingComponentEntity" - } - }, - "validationErrors" : { - "type" : "array", - "description" : "The validation errors from the controller service. These validation errors represent the problems with the controller service that must be resolved before it can be enabled.", - "items" : { - "type" : "string" - } - }, - "validationStatus" : { - "type" : "string", - "description" : "Indicates whether the ControllerService is valid, invalid, or still in the process of validating (i.e., it is unknown whether or not the ControllerService is valid)", - "readOnly" : true, - "enum" : [ "VALID", "INVALID", "VALIDATING" ] - }, - "extensionMissing" : { - "type" : "boolean", - "description" : "Whether the underlying extension is missing." - } - } - }, - "ControllerServiceEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "parentGroupId" : { - "type" : "string", - "description" : "The id of parent process group of this ControllerService." - }, - "component" : { - "$ref" : "#/definitions/ControllerServiceDTO" - }, - "operatePermissions" : { - "description" : "The permissions for this component operations.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "status" : { - "description" : "The status for this ControllerService.", - "readOnly" : true, - "$ref" : "#/definitions/ControllerServiceStatusDTO" - } - }, - "xml" : { - "name" : "controllerServiceEntity" - } - }, - "ControllerServiceReferencingComponentDTO" : { - "type" : "object", - "properties" : { - "groupId" : { - "type" : "string", - "description" : "The group id for the component referencing a controller service. If this component is another controller service or a reporting task, this field is blank." - }, - "id" : { - "type" : "string", - "description" : "The id of the component referencing a controller service." - }, - "name" : { - "type" : "string", - "description" : "The name of the component referencing a controller service." - }, - "type" : { - "type" : "string", - "description" : "The type of the component referencing a controller service in simple Java class name format without package name." - }, - "state" : { - "type" : "string", - "description" : "The scheduled state of a processor or reporting task referencing a controller service. If this component is another controller service, this field represents the controller service state." - }, - "properties" : { - "type" : "object", - "description" : "The properties for the component.", - "additionalProperties" : { - "type" : "string" - } - }, - "descriptors" : { - "type" : "object", - "description" : "The descriptors for the component properties.", - "additionalProperties" : { - "$ref" : "#/definitions/PropertyDescriptorDTO" - } - }, - "validationErrors" : { - "type" : "array", - "description" : "The validation errors for the component.", - "items" : { - "type" : "string" - } - }, - "referenceType" : { - "type" : "string", - "description" : "The type of reference this is.", - "enum" : [ "Processor", "ControllerService", "or ReportingTask" ] - }, - "activeThreadCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of active threads for the referencing component." - }, - "referenceCycle" : { - "type" : "boolean", - "description" : "If the referencing component represents a controller service, this indicates whether it has already been represented in this hierarchy." - }, - "referencingComponents" : { - "type" : "array", - "description" : "If the referencing component represents a controller service, these are the components that reference it.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ControllerServiceReferencingComponentEntity" - } - } - } - }, - "ControllerServiceReferencingComponentEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "component" : { - "$ref" : "#/definitions/ControllerServiceReferencingComponentDTO" - }, - "operatePermissions" : { - "description" : "The permissions for this component operations.", - "$ref" : "#/definitions/PermissionsDTO" - } - }, - "xml" : { - "name" : "controllerServiceReferencingComponentEntity" - } - }, - "ControllerServiceReferencingComponentsEntity" : { - "type" : "object", - "properties" : { - "controllerServiceReferencingComponents" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ControllerServiceReferencingComponentEntity" - } - } - }, - "xml" : { - "name" : "controllerServiceReferencingComponentsEntity" - } - }, - "ControllerServiceRunStatusEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "state" : { - "type" : "string", - "description" : "The run status of the ControllerService.", - "enum" : [ "ENABLED", "DISABLED" ] - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - } - }, - "xml" : { - "name" : "entity" - } - }, - "ControllerServiceStatusDTO" : { - "type" : "object", - "properties" : { - "runStatus" : { - "type" : "string", - "description" : "The run status of this ControllerService", - "readOnly" : true, - "enum" : [ "ENABLED", "ENABLING", "DISABLED", "DISABLING" ] - }, - "validationStatus" : { - "type" : "string", - "description" : "Indicates whether the component is valid, invalid, or still in the process of validating (i.e., it is unknown whether or not the component is valid)", - "readOnly" : true, - "enum" : [ "VALID", "INVALID", "VALIDATING" ] - }, - "activeThreadCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of active threads for the component." - } - } - }, - "ControllerServiceTypesEntity" : { - "type" : "object", - "properties" : { - "controllerServiceTypes" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/DocumentedTypeDTO" - } - } - }, - "xml" : { - "name" : "controllerServiceTypesEntity" - } - }, - "ControllerServicesEntity" : { - "type" : "object", - "properties" : { - "currentTime" : { - "type" : "string", - "description" : "The current time on the system." - }, - "controllerServices" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ControllerServiceEntity" - } - } - }, - "xml" : { - "name" : "controllerServicesEntity" - } - }, - "ControllerStatusDTO" : { - "type" : "object", - "properties" : { - "activeThreadCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of active threads in the NiFi." - }, - "terminatedThreadCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of terminated threads in the NiFi." - }, - "queued" : { - "type" : "string", - "description" : "The number of flowfiles queued in the NiFi." - }, - "flowFilesQueued" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of FlowFiles queued across the entire flow" - }, - "bytesQueued" : { - "type" : "integer", - "format" : "int64", - "description" : "The size of the FlowFiles queued across the entire flow" - }, - "runningCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of running components in the NiFi." - }, - "stoppedCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of stopped components in the NiFi." - }, - "invalidCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of invalid components in the NiFi." - }, - "disabledCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of disabled components in the NiFi." - }, - "activeRemotePortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of active remote ports in the NiFi." - }, - "inactiveRemotePortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of inactive remote ports in the NiFi." - }, - "upToDateCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of up to date versioned process groups in the NiFi." - }, - "locallyModifiedCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of locally modified versioned process groups in the NiFi." - }, - "staleCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of stale versioned process groups in the NiFi." - }, - "locallyModifiedAndStaleCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of locally modified and stale versioned process groups in the NiFi." - }, - "syncFailureCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of versioned process groups in the NiFi that are unable to sync to a registry." - } - } - }, - "ControllerStatusEntity" : { - "type" : "object", - "properties" : { - "controllerStatus" : { - "$ref" : "#/definitions/ControllerStatusDTO" - } - }, - "xml" : { - "name" : "controllerStatusEntity" - } - }, - "CopySnippetRequestEntity" : { - "type" : "object", - "properties" : { - "snippetId" : { - "type" : "string", - "description" : "The identifier of the snippet." - }, - "originX" : { - "type" : "number", - "format" : "double", - "description" : "The x coordinate of the origin of the bounding box where the new components will be placed." - }, - "originY" : { - "type" : "number", - "format" : "double", - "description" : "The y coordinate of the origin of the bounding box where the new components will be placed." - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - } - }, - "xml" : { - "name" : "copySnippetRequestEntity" - } - }, - "CounterDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the counter." - }, - "context" : { - "type" : "string", - "description" : "The context of the counter." - }, - "name" : { - "type" : "string", - "description" : "The name of the counter." - }, - "valueCount" : { - "type" : "integer", - "format" : "int64", - "description" : "The value count." - }, - "value" : { - "type" : "string", - "description" : "The value of the counter." - } - } - }, - "CounterEntity" : { - "type" : "object", - "properties" : { - "counter" : { - "$ref" : "#/definitions/CounterDTO" - } - }, - "xml" : { - "name" : "counterEntity" - } - }, - "CountersDTO" : { - "type" : "object", - "properties" : { - "aggregateSnapshot" : { - "description" : "A Counters snapshot that represents the aggregate values of all nodes in the cluster. If the NiFi instance is a standalone instance, rather than a cluster, this represents the stats of the single instance.", - "$ref" : "#/definitions/CountersSnapshotDTO" - }, - "nodeSnapshots" : { - "type" : "array", - "description" : "A Counters snapshot for each node in the cluster. If the NiFi instance is a standalone instance, rather than a cluster, this may be null.", - "items" : { - "$ref" : "#/definitions/NodeCountersSnapshotDTO" - } - } - } - }, - "CountersEntity" : { - "type" : "object", - "properties" : { - "counters" : { - "$ref" : "#/definitions/CountersDTO" - } - }, - "xml" : { - "name" : "countersEntity" - } - }, - "CountersSnapshotDTO" : { - "type" : "object", - "properties" : { - "generated" : { - "type" : "string", - "description" : "The timestamp when the report was generated." - }, - "counters" : { - "type" : "array", - "description" : "All counters in the NiFi.", - "items" : { - "$ref" : "#/definitions/CounterDTO" - } - } - } - }, - "CreateActiveRequestEntity" : { - "type" : "object", - "properties" : { - "processGroupId" : { - "type" : "string", - "description" : "The Process Group ID that this active request will update" - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - } - }, - "xml" : { - "name" : "createActiveRequestEntity" - } - }, - "CreateTemplateRequestEntity" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The name of the template." - }, - "description" : { - "type" : "string", - "description" : "The description of the template." - }, - "snippetId" : { - "type" : "string", - "description" : "The identifier of the snippet." - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - } - }, - "xml" : { - "name" : "createTemplateRequestEntity" - } - }, - "CurrentUserEntity" : { - "type" : "object", - "properties" : { - "identity" : { - "type" : "string", - "description" : "The user identity being serialized." - }, - "anonymous" : { - "type" : "boolean", - "description" : "Whether the current user is anonymous." - }, - "provenancePermissions" : { - "description" : "Permissions for querying provenance.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "countersPermissions" : { - "description" : "Permissions for accessing counters.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "tenantsPermissions" : { - "description" : "Permissions for accessing tenants.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "controllerPermissions" : { - "description" : "Permissions for accessing the controller.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "policiesPermissions" : { - "description" : "Permissions for accessing the policies.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "systemPermissions" : { - "description" : "Permissions for accessing system.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "restrictedComponentsPermissions" : { - "description" : "Permissions for accessing restricted components. Note: the read permission are not used and will always be false.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "componentRestrictionPermissions" : { - "type" : "array", - "description" : "Permissions for specific component restrictions.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ComponentRestrictionPermissionDTO" - } - }, - "canVersionFlows" : { - "type" : "boolean", - "description" : "Whether the current user can version flows." - } - }, - "xml" : { - "name" : "currentEntity" - } - }, - "DifferenceDTO" : { - "type" : "object", - "properties" : { - "differenceType" : { - "type" : "string", - "description" : "The type of difference" - }, - "difference" : { - "type" : "string", - "description" : "Description of the difference" - } - } - }, - "DimensionsDTO" : { - "type" : "object", - "properties" : { - "width" : { - "type" : "number", - "format" : "double", - "description" : "The width of the label in pixels when at a 1:1 scale." - }, - "height" : { - "type" : "number", - "format" : "double", - "description" : "The height of the label in pixels when at a 1:1 scale." - } - } - }, - "DocumentedTypeDTO" : { - "type" : "object", - "properties" : { - "type" : { - "type" : "string", - "description" : "The fully qualified name of the type." - }, - "bundle" : { - "description" : "The details of the artifact that bundled this type.", - "$ref" : "#/definitions/BundleDTO" - }, - "controllerServiceApis" : { - "type" : "array", - "description" : "If this type represents a ControllerService, this lists the APIs it implements.", - "items" : { - "$ref" : "#/definitions/ControllerServiceApiDTO" - } - }, - "description" : { - "type" : "string", - "description" : "The description of the type." - }, - "restricted" : { - "type" : "boolean", - "description" : "Whether this type is restricted." - }, - "usageRestriction" : { - "type" : "string", - "description" : "The optional description of why the usage of this component is restricted." - }, - "explicitRestrictions" : { - "type" : "array", - "description" : "An optional collection of explicit restrictions. If specified, these explicit restrictions will be enfored.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ExplicitRestrictionDTO" - } - }, - "deprecationReason" : { - "type" : "string", - "description" : "The description of why the usage of this component is restricted." - }, - "tags" : { - "type" : "array", - "description" : "The tags associated with this type.", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - } - } - }, - "DropRequestDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id for this drop request." - }, - "uri" : { - "type" : "string", - "description" : "The URI for future requests to this drop request." - }, - "submissionTime" : { - "type" : "string", - "description" : "The timestamp when the query was submitted." - }, - "lastUpdated" : { - "type" : "string", - "description" : "The last time this drop request was updated." - }, - "percentCompleted" : { - "type" : "integer", - "format" : "int32", - "description" : "The current percent complete." - }, - "finished" : { - "type" : "boolean", - "description" : "Whether the query has finished." - }, - "failureReason" : { - "type" : "string", - "description" : "The reason, if any, that this drop request failed." - }, - "currentCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of flow files currently queued." - }, - "currentSize" : { - "type" : "integer", - "format" : "int64", - "description" : "The size of flow files currently queued in bytes." - }, - "current" : { - "type" : "string", - "description" : "The count and size of flow files currently queued." - }, - "originalCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of flow files to be dropped as a result of this request." - }, - "originalSize" : { - "type" : "integer", - "format" : "int64", - "description" : "The size of flow files to be dropped as a result of this request in bytes." - }, - "original" : { - "type" : "string", - "description" : "The count and size of flow files to be dropped as a result of this request." - }, - "droppedCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of flow files that have been dropped thus far." - }, - "droppedSize" : { - "type" : "integer", - "format" : "int64", - "description" : "The size of flow files that have been dropped thus far in bytes." - }, - "dropped" : { - "type" : "string", - "description" : "The count and size of flow files that have been dropped thus far." - }, - "state" : { - "type" : "string", - "description" : "The current state of the drop request." - } - } - }, - "DropRequestEntity" : { - "type" : "object", - "properties" : { - "dropRequest" : { - "$ref" : "#/definitions/DropRequestDTO" - } - }, - "xml" : { - "name" : "dropRequestEntity" - } - }, - "ExplicitRestrictionDTO" : { - "type" : "object", - "properties" : { - "requiredPermission" : { - "description" : "The required permission necessary for this restriction.", - "$ref" : "#/definitions/RequiredPermissionDTO" - }, - "explanation" : { - "type" : "string", - "description" : "The description of why the usage of this component is restricted for this required permission." - } - } - }, - "FlowBreadcrumbDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the group." - }, - "name" : { - "type" : "string", - "description" : "The id of the group." - }, - "versionControlInformation" : { - "description" : "The process group version control information or null if not version controlled.", - "$ref" : "#/definitions/VersionControlInformationDTO" - } - } - }, - "FlowBreadcrumbEntity" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of this ancestor ProcessGroup." - }, - "permissions" : { - "description" : "The permissions for this ancestor ProcessGroup.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "versionedFlowState" : { - "type" : "string", - "description" : "The current state of the Process Group, as it relates to the Versioned Flow", - "readOnly" : true, - "enum" : [ "LOCALLY_MODIFIED", "STALE", "LOCALLY_MODIFIED_AND_STALE", "UP_TO_DATE", "SYNC_FAILURE" ] - }, - "breadcrumb" : { - "description" : "This breadcrumb.", - "$ref" : "#/definitions/FlowBreadcrumbDTO" - }, - "parentBreadcrumb" : { - "description" : "The parent breadcrumb for this breadcrumb.", - "$ref" : "#/definitions/FlowBreadcrumbEntity" - } - }, - "xml" : { - "name" : "flowEntity" - } - }, - "FlowComparisonEntity" : { - "type" : "object", - "properties" : { - "componentDifferences" : { - "type" : "array", - "description" : "The list of differences for each component in the flow that is not the same between the two flows", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ComponentDifferenceDTO" - } - } - }, - "xml" : { - "name" : "flowComparisonEntity" - } - }, - "FlowConfigurationDTO" : { - "type" : "object", - "properties" : { - "supportsManagedAuthorizer" : { - "type" : "boolean", - "description" : "Whether this NiFi supports a managed authorizer. Managed authorizers can visualize users, groups, and policies in the UI.", - "readOnly" : true - }, - "supportsConfigurableAuthorizer" : { - "type" : "boolean", - "description" : "Whether this NiFi supports a configurable authorizer.", - "readOnly" : true - }, - "supportsConfigurableUsersAndGroups" : { - "type" : "boolean", - "description" : "Whether this NiFi supports configurable users and groups.", - "readOnly" : true - }, - "autoRefreshIntervalSeconds" : { - "type" : "integer", - "format" : "int64", - "description" : "The interval in seconds between the automatic NiFi refresh requests.", - "readOnly" : true - }, - "currentTime" : { - "type" : "string", - "description" : "The current time on the system." - }, - "timeOffset" : { - "type" : "integer", - "format" : "int32", - "description" : "The time offset of the system." - }, - "defaultBackPressureObjectThreshold" : { - "type" : "integer", - "format" : "int64", - "description" : "The default back pressure object threshold." - }, - "defaultBackPressureDataSizeThreshold" : { - "type" : "string", - "description" : "The default back pressure data size threshold." - } - } - }, - "FlowConfigurationEntity" : { - "type" : "object", - "properties" : { - "flowConfiguration" : { - "description" : "The controller configuration.", - "$ref" : "#/definitions/FlowConfigurationDTO" - } - }, - "xml" : { - "name" : "flowConfigurationEntity" - } - }, - "FlowDTO" : { - "type" : "object", - "properties" : { - "processGroups" : { - "type" : "array", - "description" : "The process groups in this flow.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ProcessGroupEntity" - } - }, - "remoteProcessGroups" : { - "type" : "array", - "description" : "The remote process groups in this flow.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/RemoteProcessGroupEntity" - } - }, - "processors" : { - "type" : "array", - "description" : "The processors in this flow.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ProcessorEntity" - } - }, - "inputPorts" : { - "type" : "array", - "description" : "The input ports in this flow.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/PortEntity" - } - }, - "outputPorts" : { - "type" : "array", - "description" : "The output ports in this flow.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/PortEntity" - } - }, - "connections" : { - "type" : "array", - "description" : "The connections in this flow.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ConnectionEntity" - } - }, - "labels" : { - "type" : "array", - "description" : "The labels in this flow.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/LabelEntity" - } - }, - "funnels" : { - "type" : "array", - "description" : "The funnels in this flow.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/FunnelEntity" - } - } - } - }, - "FlowEntity" : { - "type" : "object", - "properties" : { - "flow" : { - "$ref" : "#/definitions/FlowDTO" - } - }, - "xml" : { - "name" : "flowEntity" - } - }, - "FlowFileDTO" : { - "type" : "object", - "properties" : { - "uri" : { - "type" : "string", - "description" : "The URI that can be used to access this FlowFile." - }, - "uuid" : { - "type" : "string", - "description" : "The FlowFile UUID." - }, - "filename" : { - "type" : "string", - "description" : "The FlowFile filename." - }, - "position" : { - "type" : "integer", - "format" : "int32", - "description" : "The FlowFile's position in the queue." - }, - "size" : { - "type" : "integer", - "format" : "int64", - "description" : "The FlowFile file size." - }, - "queuedDuration" : { - "type" : "integer", - "format" : "int64", - "description" : "How long this FlowFile has been enqueued." - }, - "lineageDuration" : { - "type" : "integer", - "format" : "int64", - "description" : "Duration since the FlowFile's greatest ancestor entered the flow." - }, - "clusterNodeId" : { - "type" : "string", - "description" : "The id of the node where this FlowFile resides." - }, - "clusterNodeAddress" : { - "type" : "string", - "description" : "The label for the node where this FlowFile resides." - }, - "attributes" : { - "type" : "object", - "description" : "The FlowFile attributes.", - "additionalProperties" : { - "type" : "string" - } - }, - "contentClaimSection" : { - "type" : "string", - "description" : "The section in which the content claim lives." - }, - "contentClaimContainer" : { - "type" : "string", - "description" : "The container in which the content claim lives." - }, - "contentClaimIdentifier" : { - "type" : "string", - "description" : "The identifier of the content claim." - }, - "contentClaimOffset" : { - "type" : "integer", - "format" : "int64", - "description" : "The offset into the content claim where the flowfile's content begins." - }, - "contentClaimFileSize" : { - "type" : "string", - "description" : "The file size of the content claim formatted." - }, - "contentClaimFileSizeBytes" : { - "type" : "integer", - "format" : "int64", - "description" : "The file size of the content claim in bytes." - }, - "penalized" : { - "type" : "boolean", - "description" : "If the FlowFile is penalized." - } - } - }, - "FlowFileEntity" : { - "type" : "object", - "properties" : { - "flowFile" : { - "$ref" : "#/definitions/FlowFileDTO" - } - }, - "xml" : { - "name" : "flowFileEntity" - } - }, - "FlowFileSummaryDTO" : { - "type" : "object", - "properties" : { - "uri" : { - "type" : "string", - "description" : "The URI that can be used to access this FlowFile." - }, - "uuid" : { - "type" : "string", - "description" : "The FlowFile UUID." - }, - "filename" : { - "type" : "string", - "description" : "The FlowFile filename." - }, - "position" : { - "type" : "integer", - "format" : "int32", - "description" : "The FlowFile's position in the queue." - }, - "size" : { - "type" : "integer", - "format" : "int64", - "description" : "The FlowFile file size." - }, - "queuedDuration" : { - "type" : "integer", - "format" : "int64", - "description" : "How long this FlowFile has been enqueued." - }, - "lineageDuration" : { - "type" : "integer", - "format" : "int64", - "description" : "Duration since the FlowFile's greatest ancestor entered the flow." - }, - "clusterNodeId" : { - "type" : "string", - "description" : "The id of the node where this FlowFile resides." - }, - "clusterNodeAddress" : { - "type" : "string", - "description" : "The label for the node where this FlowFile resides." - }, - "penalized" : { - "type" : "boolean", - "description" : "If the FlowFile is penalized." - } - } - }, - "FlowSnippetDTO" : { - "type" : "object", - "properties" : { - "processGroups" : { - "type" : "array", - "description" : "The process groups in this flow snippet.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ProcessGroupDTO" - } - }, - "remoteProcessGroups" : { - "type" : "array", - "description" : "The remote process groups in this flow snippet.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/RemoteProcessGroupDTO" - } - }, - "processors" : { - "type" : "array", - "description" : "The processors in this flow snippet.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ProcessorDTO" - } - }, - "inputPorts" : { - "type" : "array", - "description" : "The input ports in this flow snippet.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/PortDTO" - } - }, - "outputPorts" : { - "type" : "array", - "description" : "The output ports in this flow snippet.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/PortDTO" - } - }, - "connections" : { - "type" : "array", - "description" : "The connections in this flow snippet.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ConnectionDTO" - } - }, - "labels" : { - "type" : "array", - "description" : "The labels in this flow snippet.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/LabelDTO" - } - }, - "funnels" : { - "type" : "array", - "description" : "The funnels in this flow snippet.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/FunnelDTO" - } - }, - "controllerServices" : { - "type" : "array", - "description" : "The controller services in this flow snippet.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ControllerServiceDTO" - } - } - } - }, - "FunnelDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "versionedComponentId" : { - "type" : "string", - "description" : "The ID of the corresponding component that is under version control" - }, - "parentGroupId" : { - "type" : "string", - "description" : "The id of parent process group of this component if applicable." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - } - } - }, - "FunnelEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "component" : { - "$ref" : "#/definitions/FunnelDTO" - } - }, - "xml" : { - "name" : "funnelEntity" - } - }, - "FunnelsEntity" : { - "type" : "object", - "properties" : { - "funnels" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/FunnelEntity" - } - } - }, - "xml" : { - "name" : "funnelsEntity" - } - }, - "GarbageCollectionDTO" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The name of the garbage collector." - }, - "collectionCount" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of times garbage collection has run." - }, - "collectionTime" : { - "type" : "string", - "description" : "The total amount of time spent garbage collecting." - }, - "collectionMillis" : { - "type" : "integer", - "format" : "int64", - "description" : "The total number of milliseconds spent garbage collecting." - } - } - }, - "HistoryDTO" : { - "type" : "object", - "properties" : { - "total" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of number of actions that matched the search criteria.." - }, - "lastRefreshed" : { - "type" : "string", - "description" : "The timestamp when the report was generated." - }, - "actions" : { - "type" : "array", - "description" : "The actions.", - "items" : { - "$ref" : "#/definitions/ActionEntity" - } - } - } - }, - "HistoryEntity" : { - "type" : "object", - "properties" : { - "history" : { - "$ref" : "#/definitions/HistoryDTO" - } - }, - "xml" : { - "name" : "historyEntity" - } - }, - "InputPortsEntity" : { - "type" : "object", - "properties" : { - "inputPorts" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/PortEntity" - } - } - }, - "xml" : { - "name" : "inputPortsEntity" - } - }, - "InstantiateTemplateRequestEntity" : { - "type" : "object", - "properties" : { - "originX" : { - "type" : "number", - "format" : "double", - "description" : "The x coordinate of the origin of the bounding box where the new components will be placed." - }, - "originY" : { - "type" : "number", - "format" : "double", - "description" : "The y coordinate of the origin of the bounding box where the new components will be placed." - }, - "templateId" : { - "type" : "string", - "description" : "The identifier of the template." - }, - "encodingVersion" : { - "type" : "string", - "description" : "The encoding version of the flow snippet. If not specified, this is automatically populated by the node receiving the user request. If the snippet is specified, the version will be the latest. If the snippet is not specified, the version will come from the underlying template. These details need to be replicated throughout the cluster to ensure consistency." - }, - "snippet" : { - "description" : "A flow snippet of the template contents. If not specified, this is automatically populated by the node receiving the user request. These details need to be replicated throughout the cluster to ensure consistency.", - "$ref" : "#/definitions/FlowSnippetDTO" - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - } - }, - "xml" : { - "name" : "instantiateTemplateRequestEntity" - } - }, - "LabelDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "versionedComponentId" : { - "type" : "string", - "description" : "The ID of the corresponding component that is under version control" - }, - "parentGroupId" : { - "type" : "string", - "description" : "The id of parent process group of this component if applicable." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "label" : { - "type" : "string", - "description" : "The text that appears in the label." - }, - "width" : { - "type" : "number", - "format" : "double", - "description" : "The width of the label in pixels when at a 1:1 scale." - }, - "height" : { - "type" : "number", - "format" : "double", - "description" : "The height of the label in pixels when at a 1:1 scale." - }, - "style" : { - "type" : "object", - "description" : "The styles for this label (font-size : 12px, background-color : #eee, etc).", - "additionalProperties" : { - "type" : "string" - } - } - } - }, - "LabelEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "dimensions" : { - "$ref" : "#/definitions/DimensionsDTO" - }, - "component" : { - "$ref" : "#/definitions/LabelDTO" - } - }, - "xml" : { - "name" : "labelEntity" - } - }, - "LabelsEntity" : { - "type" : "object", - "properties" : { - "labels" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/LabelEntity" - } - } - }, - "xml" : { - "name" : "labelsEntity" - } - }, - "LineageDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of this lineage query." - }, - "uri" : { - "type" : "string", - "description" : "The URI for this lineage query for later retrieval and deletion." - }, - "submissionTime" : { - "type" : "string", - "description" : "When the lineage query was submitted." - }, - "expiration" : { - "type" : "string", - "description" : "When the lineage query will expire." - }, - "percentCompleted" : { - "type" : "integer", - "format" : "int32", - "description" : "The percent complete for the lineage query." - }, - "finished" : { - "type" : "boolean", - "description" : "Whether the lineage query has finished." - }, - "request" : { - "description" : "The initial lineage result.", - "$ref" : "#/definitions/LineageRequestDTO" - }, - "results" : { - "description" : "The results of the lineage query.", - "$ref" : "#/definitions/LineageResultsDTO" - } - } - }, - "LineageEntity" : { - "type" : "object", - "properties" : { - "lineage" : { - "$ref" : "#/definitions/LineageDTO" - } - }, - "xml" : { - "name" : "lineageEntity" - } - }, - "LineageRequestDTO" : { - "type" : "object", - "properties" : { - "eventId" : { - "type" : "integer", - "format" : "int64", - "description" : "The event id that was used to generate this lineage, if applicable. The event id is allowed for any type of lineageRequestType. If the lineageRequestType is FLOWFILE and the flowfile uuid is also included in the request, the event id will be ignored." - }, - "lineageRequestType" : { - "type" : "string", - "description" : "The type of lineage request. PARENTS will return the lineage for the flowfiles that are parents of the specified event. CHILDREN will return the lineage for the flowfiles that are children of the specified event. FLOWFILE will return the lineage for the specified flowfile.", - "enum" : [ "PARENTS", "CHILDREN", "and FLOWFILE" ] - }, - "uuid" : { - "type" : "string", - "description" : "The flowfile uuid that was used to generate the lineage. The flowfile uuid is only allowed when the lineageRequestType is FLOWFILE and will take precedence over event id." - }, - "clusterNodeId" : { - "type" : "string", - "description" : "The id of the node where this lineage originated if clustered." - } - } - }, - "LineageResultsDTO" : { - "type" : "object", - "properties" : { - "errors" : { - "type" : "array", - "description" : "Any errors that occurred while generating the lineage.", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - }, - "nodes" : { - "type" : "array", - "description" : "The nodes in the lineage.", - "items" : { - "$ref" : "#/definitions/ProvenanceNodeDTO" - } - }, - "links" : { - "type" : "array", - "description" : "The links between the nodes in the lineage.", - "items" : { - "$ref" : "#/definitions/ProvenanceLinkDTO" - } - } - } - }, - "Link" : { - "type" : "object", - "properties" : { - "type" : { - "type" : "string" - }, - "title" : { - "type" : "string" - }, - "params" : { - "type" : "object", - "additionalProperties" : { - "type" : "string" - } - }, - "uri" : { - "type" : "string", - "format" : "uri" - }, - "rels" : { - "type" : "array", - "items" : { - "type" : "string" - } - }, - "uriBuilder" : { - "$ref" : "#/definitions/UriBuilder" - }, - "rel" : { - "type" : "string" - } - } - }, - "ListingRequestDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id for this listing request." - }, - "uri" : { - "type" : "string", - "description" : "The URI for future requests to this listing request." - }, - "submissionTime" : { - "type" : "string", - "description" : "The timestamp when the query was submitted." - }, - "lastUpdated" : { - "type" : "string", - "description" : "The last time this listing request was updated." - }, - "percentCompleted" : { - "type" : "integer", - "format" : "int32", - "description" : "The current percent complete." - }, - "finished" : { - "type" : "boolean", - "description" : "Whether the query has finished." - }, - "failureReason" : { - "type" : "string", - "description" : "The reason, if any, that this listing request failed." - }, - "maxResults" : { - "type" : "integer", - "format" : "int32", - "description" : "The maximum number of FlowFileSummary objects to return" - }, - "state" : { - "type" : "string", - "description" : "The current state of the listing request." - }, - "queueSize" : { - "description" : "The size of the queue", - "$ref" : "#/definitions/QueueSizeDTO" - }, - "flowFileSummaries" : { - "type" : "array", - "description" : "The FlowFile summaries. The summaries will be populated once the request has completed.", - "items" : { - "$ref" : "#/definitions/FlowFileSummaryDTO" - } - }, - "sourceRunning" : { - "type" : "boolean", - "description" : "Whether the source of the connection is running" - }, - "destinationRunning" : { - "type" : "boolean", - "description" : "Whether the destination of the connection is running" - } - } - }, - "ListingRequestEntity" : { - "type" : "object", - "properties" : { - "listingRequest" : { - "$ref" : "#/definitions/ListingRequestDTO" - } - }, - "xml" : { - "name" : "listingRequestEntity" - } - }, - "NodeConnectionStatusSnapshotDTO" : { - "type" : "object", - "properties" : { - "nodeId" : { - "type" : "string", - "description" : "The unique ID that identifies the node" - }, - "address" : { - "type" : "string", - "description" : "The API address of the node" - }, - "apiPort" : { - "type" : "integer", - "format" : "int32", - "description" : "The API port used to communicate with the node" - }, - "statusSnapshot" : { - "description" : "The connection status snapshot from the node.", - "$ref" : "#/definitions/ConnectionStatusSnapshotDTO" - } - } - }, - "NodeCountersSnapshotDTO" : { - "type" : "object", - "properties" : { - "nodeId" : { - "type" : "string", - "description" : "The unique ID that identifies the node" - }, - "address" : { - "type" : "string", - "description" : "The API address of the node" - }, - "apiPort" : { - "type" : "integer", - "format" : "int32", - "description" : "The API port used to communicate with the node" - }, - "snapshot" : { - "description" : "The counters from the node.", - "$ref" : "#/definitions/CountersSnapshotDTO" - } - } - }, - "NodeDTO" : { - "type" : "object", - "properties" : { - "nodeId" : { - "type" : "string", - "description" : "The id of the node.", - "readOnly" : true - }, - "address" : { - "type" : "string", - "description" : "The node's host/ip address.", - "readOnly" : true - }, - "apiPort" : { - "type" : "integer", - "format" : "int32", - "description" : "The port the node is listening for API requests.", - "readOnly" : true - }, - "status" : { - "type" : "string", - "description" : "The node's status." - }, - "heartbeat" : { - "type" : "string", - "description" : "the time of the nodes's last heartbeat.", - "readOnly" : true - }, - "connectionRequested" : { - "type" : "string", - "description" : "The time of the node's last connection request.", - "readOnly" : true - }, - "roles" : { - "type" : "array", - "description" : "The roles of this node.", - "readOnly" : true, - "uniqueItems" : true, - "items" : { - "type" : "string" - } - }, - "activeThreadCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The active threads for the NiFi on the node.", - "readOnly" : true - }, - "queued" : { - "type" : "string", - "description" : "The queue the NiFi on the node.", - "readOnly" : true - }, - "events" : { - "type" : "array", - "description" : "The node's events.", - "readOnly" : true, - "items" : { - "$ref" : "#/definitions/NodeEventDTO" - } - }, - "nodeStartTime" : { - "type" : "string", - "description" : "The time at which this Node was last refreshed.", - "readOnly" : true - } - } - }, - "NodeEntity" : { - "type" : "object", - "properties" : { - "node" : { - "$ref" : "#/definitions/NodeDTO" - } - }, - "xml" : { - "name" : "nodeEntity" - } - }, - "NodeEventDTO" : { - "type" : "object", - "properties" : { - "timestamp" : { - "type" : "string", - "description" : "The timestamp of the node event." - }, - "category" : { - "type" : "string", - "description" : "The category of the node event." - }, - "message" : { - "type" : "string", - "description" : "The message in the node event." - } - } - }, - "NodePortStatusSnapshotDTO" : { - "type" : "object", - "properties" : { - "nodeId" : { - "type" : "string", - "description" : "The unique ID that identifies the node" - }, - "address" : { - "type" : "string", - "description" : "The API address of the node" - }, - "apiPort" : { - "type" : "integer", - "format" : "int32", - "description" : "The API port used to communicate with the node" - }, - "statusSnapshot" : { - "description" : "The port status snapshot from the node.", - "$ref" : "#/definitions/PortStatusSnapshotDTO" - } - } - }, - "NodeProcessGroupStatusSnapshotDTO" : { - "type" : "object", - "properties" : { - "nodeId" : { - "type" : "string", - "description" : "The unique ID that identifies the node" - }, - "address" : { - "type" : "string", - "description" : "The API address of the node" - }, - "apiPort" : { - "type" : "integer", - "format" : "int32", - "description" : "The API port used to communicate with the node" - }, - "statusSnapshot" : { - "description" : "The process group status snapshot from the node.", - "$ref" : "#/definitions/ProcessGroupStatusSnapshotDTO" - } - } - }, - "NodeProcessorStatusSnapshotDTO" : { - "type" : "object", - "properties" : { - "nodeId" : { - "type" : "string", - "description" : "The unique ID that identifies the node" - }, - "address" : { - "type" : "string", - "description" : "The API address of the node" - }, - "apiPort" : { - "type" : "integer", - "format" : "int32", - "description" : "The API port used to communicate with the node" - }, - "statusSnapshot" : { - "description" : "The processor status snapshot from the node.", - "$ref" : "#/definitions/ProcessorStatusSnapshotDTO" - } - } - }, - "NodeRemoteProcessGroupStatusSnapshotDTO" : { - "type" : "object", - "properties" : { - "nodeId" : { - "type" : "string", - "description" : "The unique ID that identifies the node" - }, - "address" : { - "type" : "string", - "description" : "The API address of the node" - }, - "apiPort" : { - "type" : "integer", - "format" : "int32", - "description" : "The API port used to communicate with the node" - }, - "statusSnapshot" : { - "description" : "The remote process group status snapshot from the node.", - "$ref" : "#/definitions/RemoteProcessGroupStatusSnapshotDTO" - } - } - }, - "NodeSearchResultDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the node that matched the search." - }, - "address" : { - "type" : "string", - "description" : "The address of the node that matched the search." - } - } - }, - "NodeStatusSnapshotsDTO" : { - "type" : "object", - "properties" : { - "nodeId" : { - "type" : "string", - "description" : "The id of the node." - }, - "address" : { - "type" : "string", - "description" : "The node's host/ip address." - }, - "apiPort" : { - "type" : "integer", - "format" : "int32", - "description" : "The port the node is listening for API requests." - }, - "statusSnapshots" : { - "type" : "array", - "description" : "A list of StatusSnapshotDTO objects that provide the actual metric values for the component for this node.", - "items" : { - "$ref" : "#/definitions/StatusSnapshotDTO" - } - } - } - }, - "NodeSystemDiagnosticsSnapshotDTO" : { - "type" : "object", - "properties" : { - "nodeId" : { - "type" : "string", - "description" : "The unique ID that identifies the node" - }, - "address" : { - "type" : "string", - "description" : "The API address of the node" - }, - "apiPort" : { - "type" : "integer", - "format" : "int32", - "description" : "The API port used to communicate with the node" - }, - "snapshot" : { - "description" : "The System Diagnostics snapshot from the node.", - "$ref" : "#/definitions/SystemDiagnosticsSnapshotDTO" - } - } - }, - "OutputPortsEntity" : { - "type" : "object", - "properties" : { - "outputPorts" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/PortEntity" - } - } - }, - "xml" : { - "name" : "outputPortsEntity" - } - }, - "PeerDTO" : { - "type" : "object", - "properties" : { - "hostname" : { - "type" : "string", - "description" : "The hostname of this peer." - }, - "port" : { - "type" : "integer", - "format" : "int32", - "description" : "The port number of this peer." - }, - "secure" : { - "type" : "boolean", - "description" : "Returns if this peer connection is secure." - }, - "flowFileCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of flowFiles this peer holds." - } - } - }, - "PeersEntity" : { - "type" : "object", - "properties" : { - "peers" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/PeerDTO" - } - } - }, - "xml" : { - "name" : "peersEntity" - } - }, - "PermissionsDTO" : { - "type" : "object", - "properties" : { - "canRead" : { - "type" : "boolean", - "description" : "Indicates whether the user can read a given resource.", - "readOnly" : true - }, - "canWrite" : { - "type" : "boolean", - "description" : "Indicates whether the user can write a given resource.", - "readOnly" : true - } - } - }, - "PortDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "versionedComponentId" : { - "type" : "string", - "description" : "The ID of the corresponding component that is under version control" - }, - "parentGroupId" : { - "type" : "string", - "description" : "The id of parent process group of this component if applicable." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "name" : { - "type" : "string", - "description" : "The name of the port." - }, - "comments" : { - "type" : "string", - "description" : "The comments for the port." - }, - "state" : { - "type" : "string", - "description" : "The state of the port.", - "enum" : [ "RUNNING", "STOPPED", "DISABLED" ] - }, - "type" : { - "type" : "string", - "description" : "The type of port.", - "enum" : [ "INPUT_PORT", "OUTPUT_PORT" ] - }, - "transmitting" : { - "type" : "boolean", - "description" : "Whether the port has incoming or output connections to a remote NiFi. This is only applicable when the port is running in the root group." - }, - "concurrentlySchedulableTaskCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of tasks that should be concurrently scheduled for the port." - }, - "userAccessControl" : { - "type" : "array", - "description" : "The users that are allowed to access the port.", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - }, - "groupAccessControl" : { - "type" : "array", - "description" : "The user groups that are allowed to access the port.", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - }, - "validationErrors" : { - "type" : "array", - "description" : "Gets the validation errors from this port. These validation errors represent the problems with the port that must be resolved before it can be started.", - "items" : { - "type" : "string" - } - } - } - }, - "PortEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "component" : { - "$ref" : "#/definitions/PortDTO" - }, - "status" : { - "description" : "The status of the port.", - "$ref" : "#/definitions/PortStatusDTO" - }, - "portType" : { - "type" : "string" - }, - "operatePermissions" : { - "description" : "The permissions for this component operations.", - "$ref" : "#/definitions/PermissionsDTO" - } - }, - "xml" : { - "name" : "portEntity" - } - }, - "PortRunStatusEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "state" : { - "type" : "string", - "description" : "The run status of the Port.", - "enum" : [ "RUNNING", "STOPPED", "DISABLED" ] - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - } - }, - "xml" : { - "name" : "entity" - } - }, - "PortStatusDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the port." - }, - "groupId" : { - "type" : "string", - "description" : "The id of the parent process group of the port." - }, - "name" : { - "type" : "string", - "description" : "The name of the port." - }, - "transmitting" : { - "type" : "boolean", - "description" : "Whether the port has incoming or outgoing connections to a remote NiFi." - }, - "runStatus" : { - "type" : "string", - "description" : "The run status of the port.", - "enum" : [ "Running", "Stopped", "Validating", "Disabled", "Invalid" ] - }, - "statsLastRefreshed" : { - "type" : "string", - "description" : "The time the status for the process group was last refreshed." - }, - "aggregateSnapshot" : { - "description" : "A status snapshot that represents the aggregate stats of all nodes in the cluster. If the NiFi instance is a standalone instance, rather than a cluster, this represents the stats of the single instance.", - "$ref" : "#/definitions/PortStatusSnapshotDTO" - }, - "nodeSnapshots" : { - "type" : "array", - "description" : "A status snapshot for each node in the cluster. If the NiFi instance is a standalone instance, rather than a cluster, this may be null.", - "items" : { - "$ref" : "#/definitions/NodePortStatusSnapshotDTO" - } - } - } - }, - "PortStatusEntity" : { - "type" : "object", - "properties" : { - "portStatus" : { - "$ref" : "#/definitions/PortStatusDTO" - }, - "canRead" : { - "type" : "boolean", - "description" : "Indicates whether the user can read a given resource.", - "readOnly" : true - } - }, - "xml" : { - "name" : "portStatusEntity" - } - }, - "PortStatusSnapshotDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the port." - }, - "groupId" : { - "type" : "string", - "description" : "The id of the parent process group of the port." - }, - "name" : { - "type" : "string", - "description" : "The name of the port." - }, - "activeThreadCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The active thread count for the port." - }, - "flowFilesIn" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of FlowFiles that have been accepted in the last 5 minutes." - }, - "bytesIn" : { - "type" : "integer", - "format" : "int64", - "description" : "The size of hte FlowFiles that have been accepted in the last 5 minutes." - }, - "input" : { - "type" : "string", - "description" : "The count/size of flowfiles that have been accepted in the last 5 minutes." - }, - "flowFilesOut" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of FlowFiles that have been processed in the last 5 minutes." - }, - "bytesOut" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes that have been processed in the last 5 minutes." - }, - "output" : { - "type" : "string", - "description" : "The count/size of flowfiles that have been processed in the last 5 minutes." - }, - "transmitting" : { - "type" : "boolean", - "description" : "Whether the port has incoming or outgoing connections to a remote NiFi." - }, - "runStatus" : { - "type" : "string", - "description" : "The run status of the port.", - "enum" : [ "Running", "Stopped", "Validating", "Disabled", "Invalid" ] - } - } - }, - "PortStatusSnapshotEntity" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the port." - }, - "portStatusSnapshot" : { - "$ref" : "#/definitions/PortStatusSnapshotDTO" - }, - "canRead" : { - "type" : "boolean", - "description" : "Indicates whether the user can read a given resource.", - "readOnly" : true - } - }, - "xml" : { - "name" : "entity" - } - }, - "Position" : { - "type" : "object", - "properties" : { - "x" : { - "type" : "number", - "format" : "double", - "description" : "The x coordinate." - }, - "y" : { - "type" : "number", - "format" : "double", - "description" : "The y coordinate." - } - }, - "description" : "The position of a component on the graph" - }, - "PositionDTO" : { - "type" : "object", - "properties" : { - "x" : { - "type" : "number", - "format" : "double", - "description" : "The x coordinate." - }, - "y" : { - "type" : "number", - "format" : "double", - "description" : "The y coordinate." - } - } - }, - "PreviousValueDTO" : { - "type" : "object", - "properties" : { - "previousValue" : { - "type" : "string", - "description" : "The previous value." - }, - "timestamp" : { - "type" : "string", - "description" : "The timestamp when the value was modified." - }, - "userIdentity" : { - "type" : "string", - "description" : "The user who changed the previous value." - } - } - }, - "PrioritizerTypesEntity" : { - "type" : "object", - "properties" : { - "prioritizerTypes" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/DocumentedTypeDTO" - } - } - }, - "xml" : { - "name" : "prioritizerTypesEntity" - } - }, - "ProcessGroupDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "versionedComponentId" : { - "type" : "string", - "description" : "The ID of the corresponding component that is under version control" - }, - "parentGroupId" : { - "type" : "string", - "description" : "The id of parent process group of this component if applicable." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "name" : { - "type" : "string", - "description" : "The name of the process group." - }, - "comments" : { - "type" : "string", - "description" : "The comments for the process group." - }, - "variables" : { - "type" : "object", - "description" : "The variables that are configured for the Process Group. Note that this map contains only those variables that are defined on this Process Group and not any variables that are defined in the parent Process Group, etc. I.e., this Map will not contain all variables that are accessible by components in this Process Group by rather only the variables that are defined for this Process Group itself.", - "readOnly" : true, - "additionalProperties" : { - "type" : "string" - } - }, - "versionControlInformation" : { - "description" : "The Version Control information that indicates which Flow Registry, and where in the Flow Registry, this Process Group is tracking to; or null if this Process Group is not under version control", - "$ref" : "#/definitions/VersionControlInformationDTO" - }, - "runningCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of running components in this process group." - }, - "stoppedCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of stopped components in the process group." - }, - "invalidCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of invalid components in the process group." - }, - "disabledCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of disabled components in the process group." - }, - "activeRemotePortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of active remote ports in the process group." - }, - "inactiveRemotePortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of inactive remote ports in the process group." - }, - "upToDateCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of up to date versioned process groups in the process group." - }, - "locallyModifiedCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of locally modified versioned process groups in the process group." - }, - "staleCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of stale versioned process groups in the process group." - }, - "locallyModifiedAndStaleCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of locally modified and stale versioned process groups in the process group." - }, - "syncFailureCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of versioned process groups in the process group that are unable to sync to a registry." - }, - "inputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of input ports in the process group." - }, - "outputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of output ports in the process group." - }, - "contents" : { - "description" : "The contents of this process group.", - "$ref" : "#/definitions/FlowSnippetDTO" - } - } - }, - "ProcessGroupEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "component" : { - "$ref" : "#/definitions/ProcessGroupDTO" - }, - "status" : { - "description" : "The status of the process group.", - "$ref" : "#/definitions/ProcessGroupStatusDTO" - }, - "versionedFlowSnapshot" : { - "description" : "Returns the Versioned Flow that describes the contents of the Versioned Flow to be imported", - "readOnly" : true, - "$ref" : "#/definitions/versionedFlowSnapshot" - }, - "runningCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of running components in this process group." - }, - "stoppedCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of stopped components in the process group." - }, - "invalidCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of invalid components in the process group." - }, - "disabledCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of disabled components in the process group." - }, - "activeRemotePortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of active remote ports in the process group." - }, - "inactiveRemotePortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of inactive remote ports in the process group." - }, - "versionedFlowState" : { - "type" : "string", - "description" : "The current state of the Process Group, as it relates to the Versioned Flow", - "readOnly" : true, - "enum" : [ "LOCALLY_MODIFIED", "STALE", "LOCALLY_MODIFIED_AND_STALE", "UP_TO_DATE", "SYNC_FAILURE" ] - }, - "upToDateCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of up to date versioned process groups in the process group." - }, - "locallyModifiedCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of locally modified versioned process groups in the process group." - }, - "staleCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of stale versioned process groups in the process group." - }, - "locallyModifiedAndStaleCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of locally modified and stale versioned process groups in the process group." - }, - "syncFailureCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of versioned process groups in the process group that are unable to sync to a registry." - }, - "inputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of input ports in the process group." - }, - "outputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of output ports in the process group." - } - }, - "xml" : { - "name" : "processGroupEntity" - } - }, - "ProcessGroupFlowDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "parentGroupId" : { - "type" : "string", - "description" : "The id of parent process group of this component if applicable." - }, - "breadcrumb" : { - "description" : "The breadcrumb of the process group.", - "$ref" : "#/definitions/FlowBreadcrumbEntity" - }, - "flow" : { - "description" : "The flow structure starting at this Process Group.", - "$ref" : "#/definitions/FlowDTO" - }, - "lastRefreshed" : { - "type" : "string", - "description" : "The time the flow for the process group was last refreshed." - } - } - }, - "ProcessGroupFlowEntity" : { - "type" : "object", - "properties" : { - "permissions" : { - "description" : "The access policy for this process group.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "processGroupFlow" : { - "$ref" : "#/definitions/ProcessGroupFlowDTO" - } - }, - "xml" : { - "name" : "processGroupFlowEntity" - } - }, - "ProcessGroupStatusDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The ID of the Process Group" - }, - "name" : { - "type" : "string", - "description" : "The name of the Process Group" - }, - "statsLastRefreshed" : { - "type" : "string", - "description" : "The time the status for the process group was last refreshed." - }, - "aggregateSnapshot" : { - "description" : "The aggregate status of all nodes in the cluster", - "$ref" : "#/definitions/ProcessGroupStatusSnapshotDTO" - }, - "nodeSnapshots" : { - "type" : "array", - "description" : "The status reported by each node in the cluster. If the NiFi instance is a standalone instance, rather than a clustered instance, this value may be null.", - "items" : { - "$ref" : "#/definitions/NodeProcessGroupStatusSnapshotDTO" - } - } - } - }, - "ProcessGroupStatusEntity" : { - "type" : "object", - "properties" : { - "processGroupStatus" : { - "$ref" : "#/definitions/ProcessGroupStatusDTO" - }, - "canRead" : { - "type" : "boolean", - "description" : "Indicates whether the user can read a given resource.", - "readOnly" : true - } - }, - "xml" : { - "name" : "processGroupStatusEntity" - } - }, - "ProcessGroupStatusSnapshotDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the process group." - }, - "name" : { - "type" : "string", - "description" : "The name of this process group." - }, - "connectionStatusSnapshots" : { - "type" : "array", - "description" : "The status of all connections in the process group.", - "items" : { - "$ref" : "#/definitions/ConnectionStatusSnapshotEntity" - } - }, - "processorStatusSnapshots" : { - "type" : "array", - "description" : "The status of all processors in the process group.", - "items" : { - "$ref" : "#/definitions/ProcessorStatusSnapshotEntity" - } - }, - "processGroupStatusSnapshots" : { - "type" : "array", - "description" : "The status of all process groups in the process group.", - "items" : { - "$ref" : "#/definitions/ProcessGroupStatusSnapshotEntity" - } - }, - "remoteProcessGroupStatusSnapshots" : { - "type" : "array", - "description" : "The status of all remote process groups in the process group.", - "items" : { - "$ref" : "#/definitions/RemoteProcessGroupStatusSnapshotEntity" - } - }, - "inputPortStatusSnapshots" : { - "type" : "array", - "description" : "The status of all input ports in the process group.", - "items" : { - "$ref" : "#/definitions/PortStatusSnapshotEntity" - } - }, - "outputPortStatusSnapshots" : { - "type" : "array", - "description" : "The status of all output ports in the process group.", - "items" : { - "$ref" : "#/definitions/PortStatusSnapshotEntity" - } - }, - "versionedFlowState" : { - "type" : "string", - "description" : "The current state of the Process Group, as it relates to the Versioned Flow", - "readOnly" : true, - "enum" : [ "LOCALLY_MODIFIED", "STALE", "LOCALLY_MODIFIED_AND_STALE", "UP_TO_DATE", "SYNC_FAILURE" ] - }, - "flowFilesIn" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of FlowFiles that have come into this ProcessGroup in the last 5 minutes" - }, - "bytesIn" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes that have come into this ProcessGroup in the last 5 minutes" - }, - "input" : { - "type" : "string", - "description" : "The input count/size for the process group in the last 5 minutes (pretty printed)." - }, - "flowFilesQueued" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of FlowFiles that are queued up in this ProcessGroup right now" - }, - "bytesQueued" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes that are queued up in this ProcessGroup right now" - }, - "queued" : { - "type" : "string", - "description" : "The count/size that is queued in the the process group." - }, - "queuedCount" : { - "type" : "string", - "description" : "The count that is queued for the process group." - }, - "queuedSize" : { - "type" : "string", - "description" : "The size that is queued for the process group." - }, - "bytesRead" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes read by components in this ProcessGroup in the last 5 minutes" - }, - "read" : { - "type" : "string", - "description" : "The number of bytes read in the last 5 minutes." - }, - "bytesWritten" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes written by components in this ProcessGroup in the last 5 minutes" - }, - "written" : { - "type" : "string", - "description" : "The number of bytes written in the last 5 minutes." - }, - "flowFilesOut" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of FlowFiles transferred out of this ProcessGroup in the last 5 minutes" - }, - "bytesOut" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes transferred out of this ProcessGroup in the last 5 minutes" - }, - "output" : { - "type" : "string", - "description" : "The output count/size for the process group in the last 5 minutes." - }, - "flowFilesTransferred" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of FlowFiles transferred in this ProcessGroup in the last 5 minutes" - }, - "bytesTransferred" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes transferred in this ProcessGroup in the last 5 minutes" - }, - "transferred" : { - "type" : "string", - "description" : "The count/size transferred to/from queues in the process group in the last 5 minutes." - }, - "bytesReceived" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes received from external sources by components within this ProcessGroup in the last 5 minutes" - }, - "flowFilesReceived" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of FlowFiles received from external sources by components within this ProcessGroup in the last 5 minutes" - }, - "received" : { - "type" : "string", - "description" : "The count/size sent to the process group in the last 5 minutes." - }, - "bytesSent" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes sent to an external sink by components within this ProcessGroup in the last 5 minutes" - }, - "flowFilesSent" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of FlowFiles sent to an external sink by components within this ProcessGroup in the last 5 minutes" - }, - "sent" : { - "type" : "string", - "description" : "The count/size sent from this process group in the last 5 minutes." - }, - "activeThreadCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The active thread count for this process group." - }, - "terminatedThreadCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of threads currently terminated for the process group." - } - } - }, - "ProcessGroupStatusSnapshotEntity" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the process group." - }, - "processGroupStatusSnapshot" : { - "$ref" : "#/definitions/ProcessGroupStatusSnapshotDTO" - }, - "canRead" : { - "type" : "boolean", - "description" : "Indicates whether the user can read a given resource.", - "readOnly" : true - } - }, - "xml" : { - "name" : "entity" - } - }, - "ProcessGroupsEntity" : { - "type" : "object", - "properties" : { - "processGroups" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ProcessGroupEntity" - } - } - }, - "xml" : { - "name" : "processGroupsEntity" - } - }, - "ProcessorConfigDTO" : { - "type" : "object", - "properties" : { - "properties" : { - "type" : "object", - "description" : "The properties for the processor. Properties whose value is not set will only contain the property name.", - "additionalProperties" : { - "type" : "string" - } - }, - "descriptors" : { - "type" : "object", - "description" : "Descriptors for the processor's properties.", - "additionalProperties" : { - "$ref" : "#/definitions/PropertyDescriptorDTO" - } - }, - "schedulingPeriod" : { - "type" : "string", - "description" : "The frequency with which to schedule the processor. The format of the value will depend on th value of schedulingStrategy." - }, - "schedulingStrategy" : { - "type" : "string", - "description" : "Indcates whether the prcessor should be scheduled to run in event or timer driven mode." - }, - "executionNode" : { - "type" : "string", - "description" : "Indicates the node where the process will execute." - }, - "penaltyDuration" : { - "type" : "string", - "description" : "The amount of time that is used when the process penalizes a flowfile." - }, - "yieldDuration" : { - "type" : "string", - "description" : "The amount of time that must elapse before this processor is scheduled again after yielding." - }, - "bulletinLevel" : { - "type" : "string", - "description" : "The level at which the processor will report bulletins." - }, - "runDurationMillis" : { - "type" : "integer", - "format" : "int64", - "description" : "The run duration for the processor in milliseconds." - }, - "concurrentlySchedulableTaskCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of tasks that should be concurrently schedule for the processor. If the processor doesn't allow parallol processing then any positive input will be ignored." - }, - "autoTerminatedRelationships" : { - "type" : "array", - "description" : "The names of all relationships that cause a flow file to be terminated if the relationship is not connected elsewhere. This property differs from the 'isAutoTerminate' property of the RelationshipDTO in that the RelationshipDTO is meant to depict the current configuration, whereas this property can be set in a DTO when updating a Processor in order to change which Relationships should be auto-terminated.", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - }, - "comments" : { - "type" : "string", - "description" : "The comments for the processor." - }, - "customUiUrl" : { - "type" : "string", - "description" : "The URL for the processor's custom configuration UI if applicable." - }, - "lossTolerant" : { - "type" : "boolean", - "description" : "Whether the processor is loss tolerant." - }, - "annotationData" : { - "type" : "string", - "description" : "The annotation data for the processor used to relay configuration between a custom UI and the procesosr." - }, - "defaultConcurrentTasks" : { - "type" : "object", - "description" : "Maps default values for concurrent tasks for each applicable scheduling strategy.", - "additionalProperties" : { - "type" : "string" - } - }, - "defaultSchedulingPeriod" : { - "type" : "object", - "description" : "Maps default values for scheduling period for each applicable scheduling strategy.", - "additionalProperties" : { - "type" : "string" - } - } - } - }, - "ProcessorDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "versionedComponentId" : { - "type" : "string", - "description" : "The ID of the corresponding component that is under version control" - }, - "parentGroupId" : { - "type" : "string", - "description" : "The id of parent process group of this component if applicable." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "name" : { - "type" : "string", - "description" : "The name of the processor." - }, - "type" : { - "type" : "string", - "description" : "The type of the processor." - }, - "bundle" : { - "description" : "The details of the artifact that bundled this processor type.", - "$ref" : "#/definitions/BundleDTO" - }, - "state" : { - "type" : "string", - "description" : "The state of the processor", - "enum" : [ "RUNNING", "STOPPED", "DISABLED" ] - }, - "style" : { - "type" : "object", - "description" : "Styles for the processor (background-color : #eee).", - "additionalProperties" : { - "type" : "string" - } - }, - "relationships" : { - "type" : "array", - "description" : "The available relationships that the processor currently supports.", - "readOnly" : true, - "items" : { - "$ref" : "#/definitions/RelationshipDTO" - } - }, - "description" : { - "type" : "string", - "description" : "The description of the processor." - }, - "supportsParallelProcessing" : { - "type" : "boolean", - "description" : "Whether the processor supports parallel processing." - }, - "supportsEventDriven" : { - "type" : "boolean", - "description" : "Whether the processor supports event driven scheduling." - }, - "supportsBatching" : { - "type" : "boolean", - "description" : "Whether the processor supports batching. This makes the run duration settings available." - }, - "persistsState" : { - "type" : "boolean", - "description" : "Whether the processor persists state." - }, - "restricted" : { - "type" : "boolean", - "description" : "Whether the processor requires elevated privileges." - }, - "deprecated" : { - "type" : "boolean", - "description" : "Whether the processor has been deprecated." - }, - "executionNodeRestricted" : { - "type" : "boolean", - "description" : "Indicates if the execution node of a processor is restricted to run only on the primary node" - }, - "multipleVersionsAvailable" : { - "type" : "boolean", - "description" : "Whether the processor has multiple versions available." - }, - "inputRequirement" : { - "type" : "string", - "description" : "The input requirement for this processor." - }, - "config" : { - "description" : "The configuration details for the processor. These details will be included in a response if the verbose flag is included in a request.", - "$ref" : "#/definitions/ProcessorConfigDTO" - }, - "validationErrors" : { - "type" : "array", - "description" : "The validation errors for the processor. These validation errors represent the problems with the processor that must be resolved before it can be started.", - "items" : { - "type" : "string" - } - }, - "validationStatus" : { - "type" : "string", - "description" : "Indicates whether the Processor is valid, invalid, or still in the process of validating (i.e., it is unknown whether or not the Processor is valid)", - "readOnly" : true, - "enum" : [ "VALID", "INVALID", "VALIDATING" ] - }, - "extensionMissing" : { - "type" : "boolean", - "description" : "Whether the underlying extension is missing." - } - } - }, - "ProcessorEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "component" : { - "$ref" : "#/definitions/ProcessorDTO" - }, - "inputRequirement" : { - "type" : "string", - "description" : "The input requirement for this processor." - }, - "status" : { - "$ref" : "#/definitions/ProcessorStatusDTO" - }, - "operatePermissions" : { - "description" : "The permissions for this component operations.", - "$ref" : "#/definitions/PermissionsDTO" - } - }, - "xml" : { - "name" : "processorEntity" - } - }, - "ProcessorRunStatusEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "state" : { - "type" : "string", - "description" : "The run status of the Processor.", - "enum" : [ "RUNNING", "STOPPED", "DISABLED" ] - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - } - }, - "xml" : { - "name" : "entity" - } - }, - "ProcessorStatusDTO" : { - "type" : "object", - "properties" : { - "groupId" : { - "type" : "string", - "description" : "The unique ID of the process group that the Processor belongs to" - }, - "id" : { - "type" : "string", - "description" : "The unique ID of the Processor" - }, - "name" : { - "type" : "string", - "description" : "The name of the Processor" - }, - "type" : { - "type" : "string", - "description" : "The type of the Processor" - }, - "runStatus" : { - "type" : "string", - "description" : "The run status of the Processor", - "enum" : [ "Running", "Stopped", "Validating", "Disabled", "Invalid" ] - }, - "statsLastRefreshed" : { - "type" : "string", - "description" : "The timestamp of when the stats were last refreshed" - }, - "aggregateSnapshot" : { - "description" : "A status snapshot that represents the aggregate stats of all nodes in the cluster. If the NiFi instance is a standalone instance, rather than a cluster, this represents the stats of the single instance.", - "$ref" : "#/definitions/ProcessorStatusSnapshotDTO" - }, - "nodeSnapshots" : { - "type" : "array", - "description" : "A status snapshot for each node in the cluster. If the NiFi instance is a standalone instance, rather than a cluster, this may be null.", - "items" : { - "$ref" : "#/definitions/NodeProcessorStatusSnapshotDTO" - } - } - } - }, - "ProcessorStatusEntity" : { - "type" : "object", - "properties" : { - "processorStatus" : { - "$ref" : "#/definitions/ProcessorStatusDTO" - }, - "canRead" : { - "type" : "boolean", - "description" : "Indicates whether the user can read a given resource.", - "readOnly" : true - } - }, - "xml" : { - "name" : "processorStatusEntity" - } - }, - "ProcessorStatusSnapshotDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the processor." - }, - "groupId" : { - "type" : "string", - "description" : "The id of the parent process group to which the processor belongs." - }, - "name" : { - "type" : "string", - "description" : "The name of the prcessor." - }, - "type" : { - "type" : "string", - "description" : "The type of the processor." - }, - "runStatus" : { - "type" : "string", - "description" : "The state of the processor.", - "enum" : [ "Running", "Stopped", "Validating", "Disabled", "Invalid" ] - }, - "executionNode" : { - "type" : "string", - "description" : "Indicates the node where the process will execute.", - "enum" : [ "ALL", "PRIMARY" ] - }, - "bytesRead" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes read by this Processor in the last 5 mintues" - }, - "bytesWritten" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes written by this Processor in the last 5 minutes" - }, - "read" : { - "type" : "string", - "description" : "The number of bytes read in the last 5 minutes." - }, - "written" : { - "type" : "string", - "description" : "The number of bytes written in the last 5 minutes." - }, - "flowFilesIn" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of FlowFiles that have been accepted in the last 5 minutes" - }, - "bytesIn" : { - "type" : "integer", - "format" : "int64", - "description" : "The size of the FlowFiles that have been accepted in the last 5 minutes" - }, - "input" : { - "type" : "string", - "description" : "The count/size of flowfiles that have been accepted in the last 5 minutes." - }, - "flowFilesOut" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of FlowFiles transferred to a Connection in the last 5 minutes" - }, - "bytesOut" : { - "type" : "integer", - "format" : "int64", - "description" : "The size of the FlowFiles transferred to a Connection in the last 5 minutes" - }, - "output" : { - "type" : "string", - "description" : "The count/size of flowfiles that have been processed in the last 5 minutes." - }, - "taskCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of times this Processor has run in the last 5 minutes" - }, - "tasksDurationNanos" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of nanoseconds that this Processor has spent running in the last 5 minutes" - }, - "tasks" : { - "type" : "string", - "description" : "The total number of task this connectable has completed over the last 5 minutes." - }, - "tasksDuration" : { - "type" : "string", - "description" : "The total duration of all tasks for this connectable over the last 5 minutes." - }, - "activeThreadCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of threads currently executing in the processor." - }, - "terminatedThreadCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of threads currently terminated for the processor." - } - } - }, - "ProcessorStatusSnapshotEntity" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the processor." - }, - "processorStatusSnapshot" : { - "$ref" : "#/definitions/ProcessorStatusSnapshotDTO" - }, - "canRead" : { - "type" : "boolean", - "description" : "Indicates whether the user can read a given resource.", - "readOnly" : true - } - }, - "xml" : { - "name" : "entity" - } - }, - "ProcessorTypesEntity" : { - "type" : "object", - "properties" : { - "processorTypes" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/DocumentedTypeDTO" - } - } - }, - "xml" : { - "name" : "processorTypesEntity" - } - }, - "ProcessorsEntity" : { - "type" : "object", - "properties" : { - "processors" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ProcessorEntity" - } - } - }, - "xml" : { - "name" : "processorsEntity" - } - }, - "PropertyDescriptorDTO" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The name for the property." - }, - "displayName" : { - "type" : "string", - "description" : "The human readable name for the property." - }, - "description" : { - "type" : "string", - "description" : "The description for the property. Used to relay additional details to a user or provide a mechanism of documenting intent." - }, - "defaultValue" : { - "type" : "string", - "description" : "The default value for the property." - }, - "allowableValues" : { - "type" : "array", - "description" : "Allowable values for the property. If empty then the allowed values are not constrained.", - "items" : { - "$ref" : "#/definitions/AllowableValueEntity" - } - }, - "required" : { - "type" : "boolean", - "description" : "Whether the property is required." - }, - "sensitive" : { - "type" : "boolean", - "description" : "Whether the property is sensitive and protected whenever stored or represented." - }, - "dynamic" : { - "type" : "boolean", - "description" : "Whether the property is dynamic (user-defined)." - }, - "supportsEl" : { - "type" : "boolean", - "description" : "Whether the property supports expression language." - }, - "expressionLanguageScope" : { - "type" : "string", - "description" : "Scope of the Expression Language evaluation for the property." - }, - "identifiesControllerService" : { - "type" : "string", - "description" : "If the property identifies a controller service this returns the fully qualified type." - }, - "identifiesControllerServiceBundle" : { - "description" : "If the property identifies a controller service this returns the bundle of the type, null otherwise.", - "$ref" : "#/definitions/BundleDTO" - } - } - }, - "PropertyDescriptorEntity" : { - "type" : "object", - "properties" : { - "propertyDescriptor" : { - "$ref" : "#/definitions/PropertyDescriptorDTO" - } - }, - "xml" : { - "name" : "propertyDescriptor" - } - }, - "PropertyHistoryDTO" : { - "type" : "object", - "properties" : { - "previousValues" : { - "type" : "array", - "description" : "Previous values for a given property.", - "items" : { - "$ref" : "#/definitions/PreviousValueDTO" - } - } - } - }, - "ProvenanceDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the provenance query." - }, - "uri" : { - "type" : "string", - "description" : "The URI for this query. Used for obtaining/deleting the request at a later time" - }, - "submissionTime" : { - "type" : "string", - "description" : "The timestamp when the query was submitted." - }, - "expiration" : { - "type" : "string", - "description" : "The timestamp when the query will expire." - }, - "percentCompleted" : { - "type" : "integer", - "format" : "int32", - "description" : "The current percent complete." - }, - "finished" : { - "type" : "boolean", - "description" : "Whether the query has finished." - }, - "request" : { - "description" : "The provenance request.", - "$ref" : "#/definitions/ProvenanceRequestDTO" - }, - "results" : { - "description" : "The provenance results.", - "$ref" : "#/definitions/ProvenanceResultsDTO" - } - } - }, - "ProvenanceEntity" : { - "type" : "object", - "properties" : { - "provenance" : { - "$ref" : "#/definitions/ProvenanceDTO" - } - }, - "xml" : { - "name" : "provenanceEntity" - } - }, - "ProvenanceEventDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The event uuid." - }, - "eventId" : { - "type" : "integer", - "format" : "int64", - "description" : "The event id. This is a one up number thats unique per node." - }, - "eventTime" : { - "type" : "string", - "description" : "The timestamp of the event." - }, - "eventDuration" : { - "type" : "integer", - "format" : "int64", - "description" : "The event duration in milliseconds." - }, - "lineageDuration" : { - "type" : "integer", - "format" : "int64", - "description" : "The duration since the lineage began, in milliseconds." - }, - "eventType" : { - "type" : "string", - "description" : "The type of the event." - }, - "flowFileUuid" : { - "type" : "string", - "description" : "The uuid of the flowfile for the event." - }, - "fileSize" : { - "type" : "string", - "description" : "The size of the flowfile for the event." - }, - "fileSizeBytes" : { - "type" : "integer", - "format" : "int64", - "description" : "The size of the flowfile in bytes for the event." - }, - "clusterNodeId" : { - "type" : "string", - "description" : "The identifier for the node where the event originated." - }, - "clusterNodeAddress" : { - "type" : "string", - "description" : "The label for the node where the event originated." - }, - "groupId" : { - "type" : "string", - "description" : "The id of the group that the component resides in. If the component is no longer in the flow, the group id will not be set." - }, - "componentId" : { - "type" : "string", - "description" : "The id of the component that generated the event." - }, - "componentType" : { - "type" : "string", - "description" : "The type of the component that generated the event." - }, - "componentName" : { - "type" : "string", - "description" : "The name of the component that generated the event." - }, - "sourceSystemFlowFileId" : { - "type" : "string", - "description" : "The source system flowfile id." - }, - "alternateIdentifierUri" : { - "type" : "string", - "description" : "The alternate identifier uri for the fileflow for the event." - }, - "attributes" : { - "type" : "array", - "description" : "The attributes of the flowfile for the event.", - "items" : { - "$ref" : "#/definitions/AttributeDTO" - } - }, - "parentUuids" : { - "type" : "array", - "description" : "The parent uuids for the event.", - "items" : { - "type" : "string" - } - }, - "childUuids" : { - "type" : "array", - "description" : "The child uuids for the event.", - "items" : { - "type" : "string" - } - }, - "transitUri" : { - "type" : "string", - "description" : "The source/destination system uri if the event was a RECEIVE/SEND." - }, - "relationship" : { - "type" : "string", - "description" : "The relationship to which the flowfile was routed if the event is of type ROUTE." - }, - "details" : { - "type" : "string", - "description" : "The event details." - }, - "contentEqual" : { - "type" : "boolean", - "description" : "Whether the input and output content claim is the same." - }, - "inputContentAvailable" : { - "type" : "boolean", - "description" : "Whether the input content is still available." - }, - "inputContentClaimSection" : { - "type" : "string", - "description" : "The section in which the input content claim lives." - }, - "inputContentClaimContainer" : { - "type" : "string", - "description" : "The container in which the input content claim lives." - }, - "inputContentClaimIdentifier" : { - "type" : "string", - "description" : "The identifier of the input content claim." - }, - "inputContentClaimOffset" : { - "type" : "integer", - "format" : "int64", - "description" : "The offset into the input content claim where the flowfiles content begins." - }, - "inputContentClaimFileSize" : { - "type" : "string", - "description" : "The file size of the input content claim formatted." - }, - "inputContentClaimFileSizeBytes" : { - "type" : "integer", - "format" : "int64", - "description" : "The file size of the intput content claim in bytes." - }, - "outputContentAvailable" : { - "type" : "boolean", - "description" : "Whether the output content is still available." - }, - "outputContentClaimSection" : { - "type" : "string", - "description" : "The section in which the output content claim lives." - }, - "outputContentClaimContainer" : { - "type" : "string", - "description" : "The container in which the output content claim lives." - }, - "outputContentClaimIdentifier" : { - "type" : "string", - "description" : "The identifier of the output content claim." - }, - "outputContentClaimOffset" : { - "type" : "integer", - "format" : "int64", - "description" : "The offset into the output content claim where the flowfiles content begins." - }, - "outputContentClaimFileSize" : { - "type" : "string", - "description" : "The file size of the output content claim formatted." - }, - "outputContentClaimFileSizeBytes" : { - "type" : "integer", - "format" : "int64", - "description" : "The file size of the output content claim in bytes." - }, - "replayAvailable" : { - "type" : "boolean", - "description" : "Whether or not replay is available." - }, - "replayExplanation" : { - "type" : "string", - "description" : "Explanation as to why replay is unavailable." - }, - "sourceConnectionIdentifier" : { - "type" : "string", - "description" : "The identifier of the queue/connection from which the flowfile was pulled to genereate this event. May be null if the queue/connection is unknown or the flowfile was generated from this event." - } - } - }, - "ProvenanceEventEntity" : { - "type" : "object", - "properties" : { - "provenanceEvent" : { - "$ref" : "#/definitions/ProvenanceEventDTO" - } - }, - "xml" : { - "name" : "provenanceEventEntity" - } - }, - "ProvenanceLinkDTO" : { - "type" : "object", - "properties" : { - "sourceId" : { - "type" : "string", - "description" : "The source node id of the link." - }, - "targetId" : { - "type" : "string", - "description" : "The target node id of the link." - }, - "flowFileUuid" : { - "type" : "string", - "description" : "The flowfile uuid that traversed the link." - }, - "timestamp" : { - "type" : "string", - "description" : "The timestamp of the link (based on the destination)." - }, - "millis" : { - "type" : "integer", - "format" : "int64", - "description" : "The timestamp of this link in milliseconds." - } - } - }, - "ProvenanceNodeDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the node." - }, - "flowFileUuid" : { - "type" : "string", - "description" : "The uuid of the flowfile associated with the provenance event." - }, - "parentUuids" : { - "type" : "array", - "description" : "The uuid of the parent flowfiles of the provenance event.", - "items" : { - "type" : "string" - } - }, - "childUuids" : { - "type" : "array", - "description" : "The uuid of the childrent flowfiles of the provenance event.", - "items" : { - "type" : "string" - } - }, - "clusterNodeIdentifier" : { - "type" : "string", - "description" : "The identifier of the node that this event/flowfile originated from." - }, - "type" : { - "type" : "string", - "description" : "The type of the node.", - "enum" : [ "FLOWFILE", "EVENT" ] - }, - "eventType" : { - "type" : "string", - "description" : "If the type is EVENT, this is the type of event." - }, - "millis" : { - "type" : "integer", - "format" : "int64", - "description" : "The timestamp of the node in milliseconds." - }, - "timestamp" : { - "type" : "string", - "description" : "The timestamp of the node formatted." - } - } - }, - "ProvenanceOptionsDTO" : { - "type" : "object", - "properties" : { - "searchableFields" : { - "type" : "array", - "description" : "The available searchable field for the NiFi.", - "items" : { - "$ref" : "#/definitions/ProvenanceSearchableFieldDTO" - } - } - } - }, - "ProvenanceOptionsEntity" : { - "type" : "object", - "properties" : { - "provenanceOptions" : { - "$ref" : "#/definitions/ProvenanceOptionsDTO" - } - }, - "xml" : { - "name" : "provenanceOptionsEntity" - } - }, - "ProvenanceRequestDTO" : { - "type" : "object", - "properties" : { - "searchTerms" : { - "type" : "object", - "description" : "The search terms used to perform the search.", - "additionalProperties" : { - "type" : "string" - } - }, - "clusterNodeId" : { - "type" : "string", - "description" : "The id of the node in the cluster where this provenance originated." - }, - "startDate" : { - "type" : "string", - "description" : "The earliest event time to include in the query." - }, - "endDate" : { - "type" : "string", - "description" : "The latest event time to include in the query." - }, - "minimumFileSize" : { - "type" : "string", - "description" : "The minimum file size to include in the query." - }, - "maximumFileSize" : { - "type" : "string", - "description" : "The maximum file size to include in the query." - }, - "maxResults" : { - "type" : "integer", - "format" : "int32", - "description" : "The maximum number of results to include." - }, - "summarize" : { - "type" : "boolean", - "description" : "Whether or not to summarize provenance events returned. This property is false by default." - }, - "incrementalResults" : { - "type" : "boolean", - "description" : "Whether or not incremental results are returned. If false, provenance events are only returned once the query completes. This property is true by default." - } - } - }, - "ProvenanceResultsDTO" : { - "type" : "object", - "properties" : { - "provenanceEvents" : { - "type" : "array", - "description" : "The provenance events that matched the search criteria.", - "items" : { - "$ref" : "#/definitions/ProvenanceEventDTO" - } - }, - "total" : { - "type" : "string", - "description" : "The total number of results formatted." - }, - "totalCount" : { - "type" : "integer", - "format" : "int64", - "description" : "The total number of results." - }, - "generated" : { - "type" : "string", - "description" : "Then the search was performed." - }, - "oldestEvent" : { - "type" : "string", - "description" : "The oldest event available in the provenance repository." - }, - "timeOffset" : { - "type" : "integer", - "format" : "int32", - "description" : "The time offset of the server that's used for event time." - }, - "errors" : { - "type" : "array", - "description" : "Any errors that occurred while performing the provenance request.", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - } - } - }, - "ProvenanceSearchableFieldDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the searchable field." - }, - "field" : { - "type" : "string", - "description" : "The searchable field." - }, - "label" : { - "type" : "string", - "description" : "The label for the searchable field." - }, - "type" : { - "type" : "string", - "description" : "The type of the searchable field." - } - } - }, - "QueueSizeDTO" : { - "type" : "object", - "properties" : { - "byteCount" : { - "type" : "integer", - "format" : "int64", - "description" : "The size of objects in a queue." - }, - "objectCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The count of objects in a queue." - } - } - }, - "RegistryClientEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "component" : { - "$ref" : "#/definitions/RegistryDTO" - } - }, - "xml" : { - "name" : "registryClientEntity" - } - }, - "RegistryClientsEntity" : { - "type" : "object", - "properties" : { - "registries" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/RegistryClientEntity" - } - } - }, - "xml" : { - "name" : "registryClientsEntity" - } - }, - "RegistryDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The registry identifier" - }, - "name" : { - "type" : "string", - "description" : "The registry name" - }, - "description" : { - "type" : "string", - "description" : "The registry description" - }, - "uri" : { - "type" : "string", - "description" : "The registry URI" - } - } - }, - "RelationshipDTO" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The relationship name." - }, - "description" : { - "type" : "string", - "description" : "The relationship description." - }, - "autoTerminate" : { - "type" : "boolean", - "description" : "Whether or not flowfiles sent to this relationship should auto terminate." - } - } - }, - "RemotePortRunStatusEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "state" : { - "type" : "string", - "description" : "The run status of the RemotePort.", - "enum" : [ "TRANSMITTING", "STOPPED" ] - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - } - }, - "xml" : { - "name" : "entity" - } - }, - "RemoteProcessGroupContentsDTO" : { - "type" : "object", - "properties" : { - "inputPorts" : { - "type" : "array", - "description" : "The input ports to which data can be sent.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/RemoteProcessGroupPortDTO" - } - }, - "outputPorts" : { - "type" : "array", - "description" : "The output ports from which data can be retrieved.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/RemoteProcessGroupPortDTO" - } - } - } - }, - "RemoteProcessGroupDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "versionedComponentId" : { - "type" : "string", - "description" : "The ID of the corresponding component that is under version control" - }, - "parentGroupId" : { - "type" : "string", - "description" : "The id of parent process group of this component if applicable." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "targetUri" : { - "type" : "string", - "description" : "The target URI of the remote process group. If target uri is not set, but uris are set, then returns the first url in the urls. If neither target uri nor uris are set, then returns null." - }, - "targetUris" : { - "type" : "string", - "description" : "The target URI of the remote process group. If target uris is not set but target uri is set, then returns a collection containing the single target uri. If neither target uris nor uris are set, then returns null." - }, - "targetSecure" : { - "type" : "boolean", - "description" : "Whether the target is running securely." - }, - "name" : { - "type" : "string", - "description" : "The name of the remote process group." - }, - "comments" : { - "type" : "string", - "description" : "The comments for the remote process group." - }, - "communicationsTimeout" : { - "type" : "string", - "description" : "The time period used for the timeout when communicating with the target." - }, - "yieldDuration" : { - "type" : "string", - "description" : "When yielding, this amount of time must elapse before the remote process group is scheduled again." - }, - "transportProtocol" : { - "type" : "string" - }, - "localNetworkInterface" : { - "type" : "string", - "description" : "The local network interface to send/receive data. If not specified, any local address is used. If clustered, all nodes must have an interface with this identifier." - }, - "proxyHost" : { - "type" : "string" - }, - "proxyPort" : { - "type" : "integer", - "format" : "int32" - }, - "proxyUser" : { - "type" : "string" - }, - "proxyPassword" : { - "type" : "string" - }, - "authorizationIssues" : { - "type" : "array", - "description" : "Any remote authorization issues for the remote process group.", - "items" : { - "type" : "string" - } - }, - "validationErrors" : { - "type" : "array", - "description" : "The validation errors for the remote process group. These validation errors represent the problems with the remote process group that must be resolved before it can transmit.", - "items" : { - "type" : "string" - } - }, - "transmitting" : { - "type" : "boolean", - "description" : "Whether the remote process group is actively transmitting." - }, - "inputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of remote input ports currently available on the target." - }, - "outputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of remote output ports currently available on the target." - }, - "activeRemoteInputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of active remote input ports." - }, - "inactiveRemoteInputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of inactive remote input ports." - }, - "activeRemoteOutputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of active remote output ports." - }, - "inactiveRemoteOutputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of inactive remote output ports." - }, - "flowRefreshed" : { - "type" : "string", - "description" : "The timestamp when this remote process group was last refreshed." - }, - "contents" : { - "description" : "The contents of the remote process group. Will contain available input/output ports.", - "$ref" : "#/definitions/RemoteProcessGroupContentsDTO" - } - } - }, - "RemoteProcessGroupEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "component" : { - "$ref" : "#/definitions/RemoteProcessGroupDTO" - }, - "status" : { - "description" : "The status of the remote process group.", - "$ref" : "#/definitions/RemoteProcessGroupStatusDTO" - }, - "inputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of remote input ports currently available on the target." - }, - "outputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of remote output ports currently available on the target." - }, - "operatePermissions" : { - "description" : "The permissions for this component operations.", - "$ref" : "#/definitions/PermissionsDTO" - } - }, - "xml" : { - "name" : "remoteProcessGroupEntity" - } - }, - "RemoteProcessGroupPortDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the port." - }, - "targetId" : { - "type" : "string", - "description" : "The id of the target port." - }, - "versionedComponentId" : { - "type" : "string", - "description" : "The ID of the corresponding component that is under version control" - }, - "groupId" : { - "type" : "string", - "description" : "The id of the remote process group that the port resides in." - }, - "name" : { - "type" : "string", - "description" : "The name of the target port." - }, - "comments" : { - "type" : "string", - "description" : "The comments as configured on the target port." - }, - "concurrentlySchedulableTaskCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of task that may transmit flowfiles to the target port concurrently." - }, - "transmitting" : { - "type" : "boolean", - "description" : "Whether the remote port is configured for transmission." - }, - "useCompression" : { - "type" : "boolean", - "description" : "Whether the flowfiles are compressed when sent to the target port." - }, - "exists" : { - "type" : "boolean", - "description" : "Whether the target port exists." - }, - "targetRunning" : { - "type" : "boolean", - "description" : "Whether the target port is running." - }, - "connected" : { - "type" : "boolean", - "description" : "Whether the port has either an incoming or outgoing connection." - }, - "batchSettings" : { - "description" : "The batch settings for data transmission.", - "$ref" : "#/definitions/BatchSettingsDTO" - } - } - }, - "RemoteProcessGroupPortEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "remoteProcessGroupPort" : { - "$ref" : "#/definitions/RemoteProcessGroupPortDTO" - }, - "operatePermissions" : { - "description" : "The permissions for this component operations.", - "$ref" : "#/definitions/PermissionsDTO" - } - }, - "xml" : { - "name" : "remoteProcessGroupPortEntity" - } - }, - "RemoteProcessGroupStatusDTO" : { - "type" : "object", - "properties" : { - "groupId" : { - "type" : "string", - "description" : "The unique ID of the process group that the Processor belongs to" - }, - "id" : { - "type" : "string", - "description" : "The unique ID of the Processor" - }, - "name" : { - "type" : "string", - "description" : "The name of the remote process group." - }, - "targetUri" : { - "type" : "string", - "description" : "The URI of the target system." - }, - "transmissionStatus" : { - "type" : "string", - "description" : "The transmission status of the remote process group." - }, - "statsLastRefreshed" : { - "type" : "string", - "description" : "The time the status for the process group was last refreshed." - }, - "validationStatus" : { - "type" : "string", - "description" : "Indicates whether the component is valid, invalid, or still in the process of validating (i.e., it is unknown whether or not the component is valid)", - "readOnly" : true, - "enum" : [ "VALID", "INVALID", "VALIDATING" ] - }, - "aggregateSnapshot" : { - "description" : "A status snapshot that represents the aggregate stats of all nodes in the cluster. If the NiFi instance is a standalone instance, rather than a cluster, this represents the stats of the single instance.", - "$ref" : "#/definitions/RemoteProcessGroupStatusSnapshotDTO" - }, - "nodeSnapshots" : { - "type" : "array", - "description" : "A status snapshot for each node in the cluster. If the NiFi instance is a standalone instance, rather than a cluster, this may be null.", - "items" : { - "$ref" : "#/definitions/NodeRemoteProcessGroupStatusSnapshotDTO" - } - } - } - }, - "RemoteProcessGroupStatusEntity" : { - "type" : "object", - "properties" : { - "remoteProcessGroupStatus" : { - "$ref" : "#/definitions/RemoteProcessGroupStatusDTO" - }, - "canRead" : { - "type" : "boolean", - "description" : "Indicates whether the user can read a given resource.", - "readOnly" : true - } - }, - "xml" : { - "name" : "remoteProcessGroupStatusEntity" - } - }, - "RemoteProcessGroupStatusSnapshotDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the remote process group." - }, - "groupId" : { - "type" : "string", - "description" : "The id of the parent process group the remote process group resides in." - }, - "name" : { - "type" : "string", - "description" : "The name of the remote process group." - }, - "targetUri" : { - "type" : "string", - "description" : "The URI of the target system." - }, - "transmissionStatus" : { - "type" : "string", - "description" : "The transmission status of the remote process group." - }, - "activeThreadCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of active threads for the remote process group." - }, - "flowFilesSent" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of FlowFiles sent to the remote process group in the last 5 minutes." - }, - "bytesSent" : { - "type" : "integer", - "format" : "int64", - "description" : "The size of the FlowFiles sent to the remote process group in the last 5 minutes." - }, - "sent" : { - "type" : "string", - "description" : "The count/size of the flowfiles sent to the remote process group in the last 5 minutes." - }, - "flowFilesReceived" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of FlowFiles received from the remote process group in the last 5 minutes." - }, - "bytesReceived" : { - "type" : "integer", - "format" : "int64", - "description" : "The size of the FlowFiles received from the remote process group in the last 5 minutes." - }, - "received" : { - "type" : "string", - "description" : "The count/size of the flowfiles received from the remote process group in the last 5 minutes." - } - } - }, - "RemoteProcessGroupStatusSnapshotEntity" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the remote process group." - }, - "remoteProcessGroupStatusSnapshot" : { - "$ref" : "#/definitions/RemoteProcessGroupStatusSnapshotDTO" - }, - "canRead" : { - "type" : "boolean", - "description" : "Indicates whether the user can read a given resource.", - "readOnly" : true - } - }, - "xml" : { - "name" : "entity" - } - }, - "RemoteProcessGroupsEntity" : { - "type" : "object", - "properties" : { - "remoteProcessGroups" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/RemoteProcessGroupEntity" - } - } - }, - "xml" : { - "name" : "remoteProcessGroupsEntity" - } - }, - "ReportingTaskDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "versionedComponentId" : { - "type" : "string", - "description" : "The ID of the corresponding component that is under version control" - }, - "parentGroupId" : { - "type" : "string", - "description" : "The id of parent process group of this component if applicable." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "name" : { - "type" : "string", - "description" : "The name of the reporting task." - }, - "type" : { - "type" : "string", - "description" : "The fully qualified type of the reporting task." - }, - "bundle" : { - "description" : "The details of the artifact that bundled this processor type.", - "$ref" : "#/definitions/BundleDTO" - }, - "state" : { - "type" : "string", - "description" : "The state of the reporting task.", - "enum" : [ "RUNNING", "STOPPED", "DISABLED" ] - }, - "comments" : { - "type" : "string", - "description" : "The comments of the reporting task." - }, - "persistsState" : { - "type" : "boolean", - "description" : "Whether the reporting task persists state." - }, - "restricted" : { - "type" : "boolean", - "description" : "Whether the reporting task requires elevated privileges." - }, - "deprecated" : { - "type" : "boolean", - "description" : "Whether the reporting task has been deprecated." - }, - "multipleVersionsAvailable" : { - "type" : "boolean", - "description" : "Whether the reporting task has multiple versions available." - }, - "schedulingPeriod" : { - "type" : "string", - "description" : "The frequency with which to schedule the reporting task. The format of the value willd epend on the valud of the schedulingStrategy." - }, - "schedulingStrategy" : { - "type" : "string", - "description" : "The scheduling strategy that determines how the schedulingPeriod value should be interpreted." - }, - "defaultSchedulingPeriod" : { - "type" : "object", - "description" : "The default scheduling period for the different scheduling strategies.", - "additionalProperties" : { - "type" : "string" - } - }, - "properties" : { - "type" : "object", - "description" : "The properties of the reporting task.", - "additionalProperties" : { - "type" : "string" - } - }, - "descriptors" : { - "type" : "object", - "description" : "The descriptors for the reporting tasks properties.", - "additionalProperties" : { - "$ref" : "#/definitions/PropertyDescriptorDTO" - } - }, - "customUiUrl" : { - "type" : "string", - "description" : "The URL for the custom configuration UI for the reporting task." - }, - "annotationData" : { - "type" : "string", - "description" : "The annotation data for the repoting task. This is how the custom UI relays configuration to the reporting task." - }, - "validationErrors" : { - "type" : "array", - "description" : "Gets the validation errors from the reporting task. These validation errors represent the problems with the reporting task that must be resolved before it can be scheduled to run.", - "items" : { - "type" : "string" - } - }, - "validationStatus" : { - "type" : "string", - "description" : "Indicates whether the Processor is valid, invalid, or still in the process of validating (i.e., it is unknown whether or not the Processor is valid)", - "readOnly" : true, - "enum" : [ "VALID", "INVALID", "VALIDATING" ] - }, - "activeThreadCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of active threads for the reporting task." - }, - "extensionMissing" : { - "type" : "boolean", - "description" : "Whether the underlying extension is missing." - } - } - }, - "ReportingTaskEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "component" : { - "$ref" : "#/definitions/ReportingTaskDTO" - }, - "operatePermissions" : { - "description" : "The permissions for this component operations.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "status" : { - "description" : "The status for this ReportingTask.", - "readOnly" : true, - "$ref" : "#/definitions/ReportingTaskStatusDTO" - } - }, - "xml" : { - "name" : "reportingTaskEntity" - } - }, - "ReportingTaskRunStatusEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "state" : { - "type" : "string", - "description" : "The run status of the ReportingTask.", - "enum" : [ "RUNNING", "STOPPED" ] - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - } - }, - "xml" : { - "name" : "entity" - } - }, - "ReportingTaskStatusDTO" : { - "type" : "object", - "properties" : { - "runStatus" : { - "type" : "string", - "description" : "The run status of this ReportingTask", - "readOnly" : true, - "enum" : [ "RUNNING", "STOPPED", "DISABLED" ] - }, - "validationStatus" : { - "type" : "string", - "description" : "Indicates whether the component is valid, invalid, or still in the process of validating (i.e., it is unknown whether or not the component is valid)", - "readOnly" : true, - "enum" : [ "VALID", "INVALID", "VALIDATING" ] - }, - "activeThreadCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of active threads for the component." - } - } - }, - "ReportingTaskTypesEntity" : { - "type" : "object", - "properties" : { - "reportingTaskTypes" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/DocumentedTypeDTO" - } - } - }, - "xml" : { - "name" : "reportingTaskTypesEntity" - } - }, - "ReportingTasksEntity" : { - "type" : "object", - "properties" : { - "reportingTasks" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ReportingTaskEntity" - } - } - }, - "xml" : { - "name" : "reportingTasksEntity" - } - }, - "RequiredPermissionDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The required sub-permission necessary for this restriction." - }, - "label" : { - "type" : "string", - "description" : "The label for the required sub-permission necessary for this restriction." - } - } - }, - "ResourceDTO" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The identifier of the resource." - }, - "name" : { - "type" : "string", - "description" : "The name of the resource." - } - } - }, - "ResourcesEntity" : { - "type" : "object", - "properties" : { - "resources" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/ResourceDTO" - } - } - }, - "xml" : { - "name" : "resourcesEntity" - } - }, - "RevisionDTO" : { - "type" : "object", - "properties" : { - "clientId" : { - "type" : "string", - "description" : "A client identifier used to make a request. By including a client identifier, the API can allow multiple requests without needing the current revision. Due to the asynchronous nature of requests/responses this was implemented to allow the client to make numerous requests without having to wait for the previous response to come back" - }, - "version" : { - "type" : "integer", - "format" : "int64", - "description" : "NiFi employs an optimistic locking strategy where the client must include a revision in their request when performing an update. In a response to a mutable flow request, this field represents the updated base version." - }, - "lastModifier" : { - "type" : "string", - "description" : "The user that last modified the flow.", - "readOnly" : true - } - } - }, - "ScheduleComponentsEntity" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the ProcessGroup" - }, - "state" : { - "type" : "string", - "description" : "The desired state of the descendant components", - "enum" : [ "RUNNING", "STOPPED", "ENABLED", "DISABLED" ] - }, - "components" : { - "type" : "object", - "description" : "Optional components to schedule. If not specified, all authorized descendant components will be used.", - "additionalProperties" : { - "$ref" : "#/definitions/RevisionDTO" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - } - }, - "xml" : { - "name" : "scheduleComponentEntity" - } - }, - "SearchResultGroupDTO" : { - "type" : "object", - "required" : [ "id" ], - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the group." - }, - "name" : { - "type" : "string", - "description" : "The name of the group." - } - } - }, - "SearchResultsDTO" : { - "type" : "object", - "properties" : { - "processorResults" : { - "type" : "array", - "description" : "The processors that matched the search.", - "items" : { - "$ref" : "#/definitions/ComponentSearchResultDTO" - } - }, - "connectionResults" : { - "type" : "array", - "description" : "The connections that matched the search.", - "items" : { - "$ref" : "#/definitions/ComponentSearchResultDTO" - } - }, - "processGroupResults" : { - "type" : "array", - "description" : "The process groups that matched the search.", - "items" : { - "$ref" : "#/definitions/ComponentSearchResultDTO" - } - }, - "inputPortResults" : { - "type" : "array", - "description" : "The input ports that matched the search.", - "items" : { - "$ref" : "#/definitions/ComponentSearchResultDTO" - } - }, - "outputPortResults" : { - "type" : "array", - "description" : "The output ports that matched the search.", - "items" : { - "$ref" : "#/definitions/ComponentSearchResultDTO" - } - }, - "remoteProcessGroupResults" : { - "type" : "array", - "description" : "The remote process groups that matched the search.", - "items" : { - "$ref" : "#/definitions/ComponentSearchResultDTO" - } - }, - "funnelResults" : { - "type" : "array", - "description" : "The funnels that matched the search.", - "items" : { - "$ref" : "#/definitions/ComponentSearchResultDTO" - } - } - } - }, - "SearchResultsEntity" : { - "type" : "object", - "properties" : { - "searchResultsDTO" : { - "$ref" : "#/definitions/SearchResultsDTO" - } - }, - "xml" : { - "name" : "searchResultsEntity" - } - }, - "SnippetDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the snippet." - }, - "uri" : { - "type" : "string", - "description" : "The URI of the snippet." - }, - "parentGroupId" : { - "type" : "string", - "description" : "The group id for the components in the snippet." - }, - "processGroups" : { - "type" : "object", - "description" : "The ids of the process groups in this snippet. These ids will be populated within each response. They can be specified when creating a snippet. However, once a snippet has been created its contents cannot be modified (these ids are ignored during update requests).", - "additionalProperties" : { - "$ref" : "#/definitions/RevisionDTO" - } - }, - "remoteProcessGroups" : { - "type" : "object", - "description" : "The ids of the remote process groups in this snippet. These ids will be populated within each response. They can be specified when creating a snippet. However, once a snippet has been created its contents cannot be modified (these ids are ignored during update requests).", - "additionalProperties" : { - "$ref" : "#/definitions/RevisionDTO" - } - }, - "processors" : { - "type" : "object", - "description" : "The ids of the processors in this snippet. These ids will be populated within each response. They can be specified when creating a snippet. However, once a snippet has been created its contents cannot be modified (these ids are ignored during update requests).", - "additionalProperties" : { - "$ref" : "#/definitions/RevisionDTO" - } - }, - "inputPorts" : { - "type" : "object", - "description" : "The ids of the input ports in this snippet. These ids will be populated within each response. They can be specified when creating a snippet. However, once a snippet has been created its contents cannot be modified (these ids are ignored during update requests).", - "additionalProperties" : { - "$ref" : "#/definitions/RevisionDTO" - } - }, - "outputPorts" : { - "type" : "object", - "description" : "The ids of the output ports in this snippet. These ids will be populated within each response. They can be specified when creating a snippet. However, once a snippet has been created its contents cannot be modified (these ids are ignored during update requests).", - "additionalProperties" : { - "$ref" : "#/definitions/RevisionDTO" - } - }, - "connections" : { - "type" : "object", - "description" : "The ids of the connections in this snippet. These ids will be populated within each response. They can be specified when creating a snippet. However, once a snippet has been created its contents cannot be modified (these ids are ignored during update requests).", - "additionalProperties" : { - "$ref" : "#/definitions/RevisionDTO" - } - }, - "labels" : { - "type" : "object", - "description" : "The ids of the labels in this snippet. These ids will be populated within each response. They can be specified when creating a snippet. However, once a snippet has been created its contents cannot be modified (these ids are ignored during update requests).", - "additionalProperties" : { - "$ref" : "#/definitions/RevisionDTO" - } - }, - "funnels" : { - "type" : "object", - "description" : "The ids of the funnels in this snippet. These ids will be populated within each response. They can be specified when creating a snippet. However, once a snippet has been created its contents cannot be modified (these ids are ignored during update requests).", - "additionalProperties" : { - "$ref" : "#/definitions/RevisionDTO" - } - } - } - }, - "SnippetEntity" : { - "type" : "object", - "properties" : { - "snippet" : { - "description" : "The snippet.", - "$ref" : "#/definitions/SnippetDTO" - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - } - }, - "xml" : { - "name" : "snippetEntity" - } - }, - "StartVersionControlRequestEntity" : { - "type" : "object", - "properties" : { - "versionedFlow" : { - "description" : "The versioned flow", - "$ref" : "#/definitions/VersionedFlowDTO" - }, - "processGroupRevision" : { - "description" : "The Revision of the Process Group under Version Control", - "$ref" : "#/definitions/RevisionDTO" - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - } - }, - "xml" : { - "name" : "startVersionControlRequestEntity" - } - }, - "StateEntryDTO" : { - "type" : "object", - "properties" : { - "key" : { - "type" : "string", - "description" : "The key for this state." - }, - "value" : { - "type" : "string", - "description" : "The value for this state." - }, - "clusterNodeId" : { - "type" : "string", - "description" : "The identifier for the node where the state originated." - }, - "clusterNodeAddress" : { - "type" : "string", - "description" : "The label for the node where the state originated." - } - } - }, - "StateMapDTO" : { - "type" : "object", - "properties" : { - "scope" : { - "type" : "string", - "description" : "The scope of this StateMap." - }, - "totalEntryCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The total number of state entries. When the state map is lengthy, only of portion of the entries are returned." - }, - "state" : { - "type" : "array", - "description" : "The state.", - "items" : { - "$ref" : "#/definitions/StateEntryDTO" - } - } - } - }, - "StatusDescriptorDTO" : { - "type" : "object", - "properties" : { - "field" : { - "type" : "string", - "description" : "The name of the status field." - }, - "label" : { - "type" : "string", - "description" : "The label for the status field." - }, - "description" : { - "type" : "string", - "description" : "The description of the status field." - }, - "formatter" : { - "type" : "string", - "description" : "The formatter for the status descriptor." - } - } - }, - "StatusHistoryDTO" : { - "type" : "object", - "properties" : { - "generated" : { - "type" : "string", - "description" : "When the status history was generated." - }, - "componentDetails" : { - "type" : "object", - "description" : "A Map of key/value pairs that describe the component that the status history belongs to", - "additionalProperties" : { - "type" : "string" - } - }, - "fieldDescriptors" : { - "type" : "array", - "description" : "The Descriptors that provide information on each of the metrics provided in the status history", - "items" : { - "$ref" : "#/definitions/StatusDescriptorDTO" - } - }, - "aggregateSnapshots" : { - "type" : "array", - "description" : "A list of StatusSnapshotDTO objects that provide the actual metric values for the component. If the NiFi instance is clustered, this will represent the aggregate status across all nodes. If the NiFi instance is not clustered, this will represent the status of the entire NiFi instance.", - "items" : { - "$ref" : "#/definitions/StatusSnapshotDTO" - } - }, - "nodeSnapshots" : { - "type" : "array", - "description" : "The NodeStatusSnapshotsDTO objects that provide the actual metric values for the component, for each node. If the NiFi instance is not clustered, this value will be null.", - "items" : { - "$ref" : "#/definitions/NodeStatusSnapshotsDTO" - } - } - } - }, - "StatusHistoryEntity" : { - "type" : "object", - "properties" : { - "statusHistory" : { - "$ref" : "#/definitions/StatusHistoryDTO" - }, - "canRead" : { - "type" : "boolean", - "description" : "Indicates whether the user can read a given resource.", - "readOnly" : true - } - }, - "xml" : { - "name" : "statusHistoryEntity" - } - }, - "StatusSnapshotDTO" : { - "type" : "object", - "properties" : { - "timestamp" : { - "type" : "string", - "format" : "date-time", - "description" : "The timestamp of the snapshot." - }, - "statusMetrics" : { - "type" : "object", - "description" : "The status metrics.", - "additionalProperties" : { - "type" : "integer", - "format" : "int64" - } - } - } - }, - "StorageUsageDTO" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The identifier of this storage location. The identifier will correspond to the identifier keyed in the storage configuration." - }, - "freeSpace" : { - "type" : "string", - "description" : "Amount of free space." - }, - "totalSpace" : { - "type" : "string", - "description" : "Amount of total space." - }, - "usedSpace" : { - "type" : "string", - "description" : "Amount of used space." - }, - "freeSpaceBytes" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes of free space." - }, - "totalSpaceBytes" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes of total space." - }, - "usedSpaceBytes" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes of used space." - }, - "utilization" : { - "type" : "string", - "description" : "Utilization of this storage location." - } - } - }, - "StreamingOutput" : { - "type" : "object" - }, - "SubmitReplayRequestEntity" : { - "type" : "object", - "properties" : { - "eventId" : { - "type" : "integer", - "format" : "int64", - "description" : "The event identifier" - }, - "clusterNodeId" : { - "type" : "string", - "description" : "The identifier of the node where to submit the replay request." - } - }, - "xml" : { - "name" : "copySnippetRequestEntity" - } - }, - "SystemDiagnosticsDTO" : { - "type" : "object", - "properties" : { - "aggregateSnapshot" : { - "description" : "A systems diagnostic snapshot that represents the aggregate values of all nodes in the cluster. If the NiFi instance is a standalone instance, rather than a cluster, this represents the stats of the single instance.", - "$ref" : "#/definitions/SystemDiagnosticsSnapshotDTO" - }, - "nodeSnapshots" : { - "type" : "array", - "description" : "A systems diagnostics snapshot for each node in the cluster. If the NiFi instance is a standalone instance, rather than a cluster, this may be null.", - "items" : { - "$ref" : "#/definitions/NodeSystemDiagnosticsSnapshotDTO" - } - } - } - }, - "SystemDiagnosticsEntity" : { - "type" : "object", - "properties" : { - "systemDiagnostics" : { - "$ref" : "#/definitions/SystemDiagnosticsDTO" - } - }, - "xml" : { - "name" : "systemDiagnosticsEntity" - } - }, - "SystemDiagnosticsSnapshotDTO" : { - "type" : "object", - "properties" : { - "totalNonHeap" : { - "type" : "string", - "description" : "Total size of non heap." - }, - "totalNonHeapBytes" : { - "type" : "integer", - "format" : "int64", - "description" : "Total number of bytes allocated to the JVM not used for heap" - }, - "usedNonHeap" : { - "type" : "string", - "description" : "Amount of use non heap." - }, - "usedNonHeapBytes" : { - "type" : "integer", - "format" : "int64", - "description" : "Total number of bytes used by the JVM not in the heap space" - }, - "freeNonHeap" : { - "type" : "string", - "description" : "Amount of free non heap." - }, - "freeNonHeapBytes" : { - "type" : "integer", - "format" : "int64", - "description" : "Total number of free non-heap bytes available to the JVM" - }, - "maxNonHeap" : { - "type" : "string", - "description" : "Maximum size of non heap." - }, - "maxNonHeapBytes" : { - "type" : "integer", - "format" : "int64", - "description" : "The maximum number of bytes that the JVM can use for non-heap purposes" - }, - "nonHeapUtilization" : { - "type" : "string", - "description" : "Utilization of non heap." - }, - "totalHeap" : { - "type" : "string", - "description" : "Total size of heap." - }, - "totalHeapBytes" : { - "type" : "integer", - "format" : "int64", - "description" : "The total number of bytes that are available for the JVM heap to use" - }, - "usedHeap" : { - "type" : "string", - "description" : "Amount of used heap." - }, - "usedHeapBytes" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes of JVM heap that are currently being used" - }, - "freeHeap" : { - "type" : "string", - "description" : "Amount of free heap." - }, - "freeHeapBytes" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes that are allocated to the JVM heap but not currently being used" - }, - "maxHeap" : { - "type" : "string", - "description" : "Maximum size of heap." - }, - "maxHeapBytes" : { - "type" : "integer", - "format" : "int64", - "description" : "The maximum number of bytes that can be used by the JVM" - }, - "heapUtilization" : { - "type" : "string", - "description" : "Utilization of heap." - }, - "availableProcessors" : { - "type" : "integer", - "format" : "int32", - "description" : "Number of available processors if supported by the underlying system." - }, - "processorLoadAverage" : { - "type" : "number", - "format" : "double", - "description" : "The processor load average if supported by the underlying system." - }, - "totalThreads" : { - "type" : "integer", - "format" : "int32", - "description" : "Total number of threads." - }, - "daemonThreads" : { - "type" : "integer", - "format" : "int32", - "description" : "Number of daemon threads." - }, - "uptime" : { - "type" : "string", - "description" : "The uptime of the Java virtual machine" - }, - "flowFileRepositoryStorageUsage" : { - "description" : "The flowfile repository storage usage.", - "$ref" : "#/definitions/StorageUsageDTO" - }, - "contentRepositoryStorageUsage" : { - "type" : "array", - "description" : "The content repository storage usage.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/StorageUsageDTO" - } - }, - "provenanceRepositoryStorageUsage" : { - "type" : "array", - "description" : "The provenance repository storage usage.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/StorageUsageDTO" - } - }, - "garbageCollection" : { - "type" : "array", - "description" : "The garbage collection details.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/GarbageCollectionDTO" - } - }, - "statsLastRefreshed" : { - "type" : "string", - "description" : "When the diagnostics were generated." - }, - "versionInfo" : { - "description" : "The nifi, os, java, and build version information", - "$ref" : "#/definitions/VersionInfoDTO" - } - } - }, - "TemplateDTO" : { - "type" : "object", - "properties" : { - "uri" : { - "type" : "string", - "description" : "The URI for the template." - }, - "id" : { - "type" : "string", - "description" : "The id of the template." - }, - "groupId" : { - "type" : "string", - "description" : "The id of the Process Group that the template belongs to." - }, - "name" : { - "type" : "string", - "description" : "The name of the template." - }, - "description" : { - "type" : "string", - "description" : "The description of the template." - }, - "timestamp" : { - "type" : "string", - "description" : "The timestamp when this template was created." - }, - "encodingVersion" : { - "type" : "string", - "xml" : { - "name" : "encoding-version", - "attribute" : true - }, - "description" : "The encoding version of this template." - }, - "snippet" : { - "description" : "The contents of the template.", - "$ref" : "#/definitions/FlowSnippetDTO" - } - }, - "xml" : { - "name" : "template" - } - }, - "TemplateEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "template" : { - "$ref" : "#/definitions/TemplateDTO" - } - }, - "xml" : { - "name" : "templateEntity" - } - }, - "TemplatesEntity" : { - "type" : "object", - "properties" : { - "templates" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/TemplateEntity" - } - }, - "generated" : { - "type" : "string", - "description" : "When this content was generated." - } - }, - "xml" : { - "name" : "templatesEntity" - } - }, - "TenantDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "versionedComponentId" : { - "type" : "string", - "description" : "The ID of the corresponding component that is under version control" - }, - "parentGroupId" : { - "type" : "string", - "description" : "The id of parent process group of this component if applicable." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "identity" : { - "type" : "string", - "description" : "The identity of the tenant." - }, - "configurable" : { - "type" : "boolean", - "description" : "Whether this tenant is configurable." - } - } - }, - "TenantEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "component" : { - "$ref" : "#/definitions/TenantDTO" - } - }, - "xml" : { - "name" : "tenantEntity" - } - }, - "TenantsEntity" : { - "type" : "object", - "properties" : { - "users" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/TenantEntity" - } - }, - "userGroups" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/TenantEntity" - } - } - }, - "xml" : { - "name" : "tenantsEntity" - } - }, - "TransactionResultEntity" : { - "type" : "object", - "properties" : { - "flowFileSent" : { - "type" : "integer", - "format" : "int32" - }, - "responseCode" : { - "type" : "integer", - "format" : "int32" - }, - "message" : { - "type" : "string" - } - }, - "xml" : { - "name" : "transactionResultEntity" - } - }, - "UpdateControllerServiceReferenceRequestEntity" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The identifier of the Controller Service." - }, - "state" : { - "type" : "string", - "description" : "The new state of the references for the controller service.", - "enum" : [ "ENABLED", "DISABLED", "RUNNING", "STOPPED" ] - }, - "referencingComponentRevisions" : { - "type" : "object", - "description" : "The revisions for all referencing components.", - "additionalProperties" : { - "$ref" : "#/definitions/RevisionDTO" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - } - }, - "xml" : { - "name" : "updateControllerServiceReferenceRequestEntity" - } - }, - "UriBuilder" : { - "type" : "object" - }, - "UserDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "versionedComponentId" : { - "type" : "string", - "description" : "The ID of the corresponding component that is under version control" - }, - "parentGroupId" : { - "type" : "string", - "description" : "The id of parent process group of this component if applicable." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "identity" : { - "type" : "string", - "description" : "The identity of the tenant." - }, - "configurable" : { - "type" : "boolean", - "description" : "Whether this tenant is configurable." - }, - "userGroups" : { - "type" : "array", - "description" : "The groups to which the user belongs. This field is read only and it provided for convenience.", - "readOnly" : true, - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/TenantEntity" - } - }, - "accessPolicies" : { - "type" : "array", - "description" : "The access policies this user belongs to.", - "readOnly" : true, - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/AccessPolicySummaryEntity" - } - } - } - }, - "UserEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "component" : { - "$ref" : "#/definitions/UserDTO" - } - }, - "xml" : { - "name" : "userEntity" - } - }, - "UserGroupDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "versionedComponentId" : { - "type" : "string", - "description" : "The ID of the corresponding component that is under version control" - }, - "parentGroupId" : { - "type" : "string", - "description" : "The id of parent process group of this component if applicable." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "identity" : { - "type" : "string", - "description" : "The identity of the tenant." - }, - "configurable" : { - "type" : "boolean", - "description" : "Whether this tenant is configurable." - }, - "users" : { - "type" : "array", - "description" : "The users that belong to the user group.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/TenantEntity" - } - }, - "accessPolicies" : { - "type" : "array", - "description" : "The access policies this user group belongs to. This field was incorrectly defined as an AccessPolicyEntity. For compatibility reasons the field will remain of this type, however only the fields that are present in the AccessPolicySummaryEntity will be populated here.", - "readOnly" : true, - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/AccessPolicyEntity" - } - } - } - }, - "UserGroupEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "component" : { - "$ref" : "#/definitions/UserGroupDTO" - } - }, - "xml" : { - "name" : "userGroupEntity" - } - }, - "UserGroupsEntity" : { - "type" : "object", - "properties" : { - "userGroups" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/UserGroupEntity" - } - } - }, - "xml" : { - "name" : "userGroupsEntity" - } - }, - "UsersEntity" : { - "type" : "object", - "properties" : { - "generated" : { - "type" : "string", - "description" : "When this content was generated." - }, - "users" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/UserEntity" - } - } - }, - "xml" : { - "name" : "usersEntity" - } - }, - "VariableDTO" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The name of the variable" - }, - "value" : { - "type" : "string", - "description" : "The value of the variable" - }, - "processGroupId" : { - "type" : "string", - "description" : "The ID of the Process Group where this Variable is defined", - "readOnly" : true - }, - "affectedComponents" : { - "type" : "array", - "description" : "A set of all components that will be affected if the value of this variable is changed", - "readOnly" : true, - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/AffectedComponentEntity" - } - } - } - }, - "VariableEntity" : { - "type" : "object", - "properties" : { - "variable" : { - "description" : "The variable information", - "$ref" : "#/definitions/VariableDTO" - }, - "canWrite" : { - "type" : "boolean", - "description" : "Indicates whether the user can write a given resource.", - "readOnly" : true - } - }, - "xml" : { - "name" : "variableEntity" - } - }, - "VariableRegistryDTO" : { - "type" : "object", - "properties" : { - "variables" : { - "type" : "array", - "description" : "The variables that are available in this Variable Registry", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VariableEntity" - } - }, - "processGroupId" : { - "type" : "string", - "description" : "The UUID of the Process Group that this Variable Registry belongs to" - } - } - }, - "VariableRegistryEntity" : { - "type" : "object", - "properties" : { - "processGroupRevision" : { - "description" : "The revision of the Process Group that the Variable Registry belongs to", - "$ref" : "#/definitions/RevisionDTO" - }, - "variableRegistry" : { - "description" : "The Variable Registry.", - "$ref" : "#/definitions/VariableRegistryDTO" - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - } - }, - "xml" : { - "name" : "variableRegistryEntity" - } - }, - "VariableRegistryUpdateRequestDTO" : { - "type" : "object", - "properties" : { - "requestId" : { - "type" : "string", - "description" : "The unique ID of this request.", - "readOnly" : true - }, - "processGroupId" : { - "type" : "string", - "description" : "The unique ID of the Process Group that the variable registry belongs to" - }, - "uri" : { - "type" : "string", - "description" : "The URI for future requests to this drop request.", - "readOnly" : true - }, - "submissionTime" : { - "type" : "string", - "description" : "The time at which this request was submitted.", - "readOnly" : true - }, - "lastUpdated" : { - "type" : "string", - "description" : "The last time this request was updated.", - "readOnly" : true - }, - "complete" : { - "type" : "boolean", - "description" : "Whether or not this request has completed", - "readOnly" : true - }, - "failureReason" : { - "type" : "string", - "description" : "An explanation of why this request failed, or null if this request has not failed", - "readOnly" : true - }, - "updateSteps" : { - "type" : "array", - "description" : "The steps that are required in order to complete the request, along with the status of each", - "readOnly" : true, - "items" : { - "$ref" : "#/definitions/VariableRegistryUpdateStepDTO" - } - }, - "affectedComponents" : { - "type" : "array", - "description" : "A set of all components that will be affected if the value of this variable is changed", - "readOnly" : true, - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/AffectedComponentEntity" - } - } - } - }, - "VariableRegistryUpdateRequestEntity" : { - "type" : "object", - "properties" : { - "request" : { - "description" : "The Variable Registry Update Request", - "$ref" : "#/definitions/VariableRegistryUpdateRequestDTO" - }, - "processGroupRevision" : { - "description" : "The revision for the Process Group that owns this variable registry.", - "$ref" : "#/definitions/RevisionDTO" - } - }, - "xml" : { - "name" : "variableRegistryUpdateRequestEntity" - } - }, - "VariableRegistryUpdateStepDTO" : { - "type" : "object", - "properties" : { - "description" : { - "type" : "string", - "description" : "Explanation of what happens in this step", - "readOnly" : true - }, - "complete" : { - "type" : "boolean", - "description" : "Whether or not this step has completed", - "readOnly" : true - }, - "failureReason" : { - "type" : "string", - "description" : "An explanation of why this step failed, or null if this step did not fail", - "readOnly" : true - } - } - }, - "VersionControlComponentMappingEntity" : { - "type" : "object", - "properties" : { - "versionControlComponentMapping" : { - "type" : "object", - "description" : "The mapping of Versioned Component Identifiers to instance ID's", - "additionalProperties" : { - "type" : "string" - } - }, - "processGroupRevision" : { - "description" : "The revision of the Process Group", - "$ref" : "#/definitions/RevisionDTO" - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "versionControlInformation" : { - "description" : "The Version Control information", - "$ref" : "#/definitions/VersionControlInformationDTO" - } - }, - "xml" : { - "name" : "versionControlComponentMappingEntity" - } - }, - "VersionControlInformationDTO" : { - "type" : "object", - "properties" : { - "groupId" : { - "type" : "string", - "description" : "The ID of the Process Group that is under version control" - }, - "registryId" : { - "type" : "string", - "description" : "The ID of the registry that the flow is stored in" - }, - "registryName" : { - "type" : "string", - "description" : "The name of the registry that the flow is stored in", - "readOnly" : true - }, - "bucketId" : { - "type" : "string", - "description" : "The ID of the bucket that the flow is stored in" - }, - "bucketName" : { - "type" : "string", - "description" : "The name of the bucket that the flow is stored in", - "readOnly" : true - }, - "flowId" : { - "type" : "string", - "description" : "The ID of the flow" - }, - "flowName" : { - "type" : "string", - "description" : "The name of the flow" - }, - "flowDescription" : { - "type" : "string", - "description" : "The description of the flow" - }, - "version" : { - "type" : "integer", - "format" : "int32", - "description" : "The version of the flow" - }, - "state" : { - "type" : "string", - "description" : "The current state of the Process Group, as it relates to the Versioned Flow", - "readOnly" : true, - "enum" : [ "LOCALLY_MODIFIED", "STALE", "LOCALLY_MODIFIED_AND_STALE", "UP_TO_DATE", "SYNC_FAILURE" ] - }, - "stateExplanation" : { - "type" : "string", - "description" : "Explanation of why the group is in the specified state", - "readOnly" : true - } - } - }, - "VersionControlInformationEntity" : { - "type" : "object", - "properties" : { - "versionControlInformation" : { - "description" : "The Version Control information", - "$ref" : "#/definitions/VersionControlInformationDTO" - }, - "processGroupRevision" : { - "description" : "The Revision for the Process Group", - "$ref" : "#/definitions/RevisionDTO" - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - } - }, - "xml" : { - "name" : "versionControlInformationEntity" - } - }, - "VersionInfoDTO" : { - "type" : "object", - "properties" : { - "niFiVersion" : { - "type" : "string", - "description" : "The version of this NiFi." - }, - "javaVendor" : { - "type" : "string", - "description" : "Java JVM vendor" - }, - "javaVersion" : { - "type" : "string", - "description" : "Java version" - }, - "osName" : { - "type" : "string", - "description" : "Host operating system name" - }, - "osVersion" : { - "type" : "string", - "description" : "Host operating system version" - }, - "osArchitecture" : { - "type" : "string", - "description" : "Host operating system architecture" - }, - "buildTag" : { - "type" : "string", - "description" : "Build tag" - }, - "buildRevision" : { - "type" : "string", - "description" : "Build revision or commit hash" - }, - "buildBranch" : { - "type" : "string", - "description" : "Build branch" - }, - "buildTimestamp" : { - "type" : "string", - "format" : "date-time", - "description" : "Build timestamp" - } - } - }, - "VersionedConnection" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The component's unique identifier" - }, - "name" : { - "type" : "string", - "description" : "The component's name" - }, - "comments" : { - "type" : "string", - "description" : "The user-supplied comments for the component" - }, - "position" : { - "description" : "The component's position on the graph", - "$ref" : "#/definitions/Position" - }, - "source" : { - "description" : "The source of the connection.", - "$ref" : "#/definitions/ConnectableComponent" - }, - "destination" : { - "description" : "The destination of the connection.", - "$ref" : "#/definitions/ConnectableComponent" - }, - "labelIndex" : { - "type" : "integer", - "format" : "int32", - "description" : "The index of the bend point where to place the connection label." - }, - "zIndex" : { - "type" : "integer", - "format" : "int64", - "description" : "The z index of the connection." - }, - "selectedRelationships" : { - "type" : "array", - "description" : "The selected relationship that comprise the connection.", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - }, - "backPressureObjectThreshold" : { - "type" : "integer", - "format" : "int64", - "description" : "The object count threshold for determining when back pressure is applied. Updating this value is a passive change in the sense that it won't impact whether existing files over the limit are affected but it does help feeder processors to stop pushing too much into this work queue." - }, - "backPressureDataSizeThreshold" : { - "type" : "string", - "description" : "The object data size threshold for determining when back pressure is applied. Updating this value is a passive change in the sense that it won't impact whether existing files over the limit are affected but it does help feeder processors to stop pushing too much into this work queue." - }, - "flowFileExpiration" : { - "type" : "string", - "description" : "The amount of time a flow file may be in the flow before it will be automatically aged out of the flow. Once a flow file reaches this age it will be terminated from the flow the next time a processor attempts to start work on it." - }, - "prioritizers" : { - "type" : "array", - "description" : "The comparators used to prioritize the queue.", - "items" : { - "type" : "string" - } - }, - "bends" : { - "type" : "array", - "description" : "The bend points on the connection.", - "items" : { - "$ref" : "#/definitions/Position" - } - }, - "loadBalanceStrategy" : { - "type" : "string", - "description" : "The Strategy to use for load balancing data across the cluster, or null, if no Load Balance Strategy has been specified.", - "enum" : [ "DO_NOT_LOAD_BALANCE", "PARTITION_BY_ATTRIBUTE", "ROUND_ROBIN", "SINGLE_NODE" ] - }, - "partitioningAttribute" : { - "type" : "string", - "description" : "The attribute to use for partitioning data as it is load balanced across the cluster. If the Load Balance Strategy is configured to use PARTITION_BY_ATTRIBUTE, the value returned by this method is the name of the FlowFile Attribute that will be used to determine which node in the cluster should receive a given FlowFile. If the Load Balance Strategy is unset or is set to any other value, the Partitioning Attribute has no effect." - }, - "loadBalanceCompression" : { - "type" : "string", - "description" : "Whether or not compression should be used when transferring FlowFiles between nodes", - "enum" : [ "DO_NOT_COMPRESS", "COMPRESS_ATTRIBUTES_ONLY", "COMPRESS_ATTRIBUTES_AND_CONTENT" ] - }, - "componentType" : { - "type" : "string", - "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE" ] - }, - "groupIdentifier" : { - "type" : "string", - "description" : "The ID of the Process Group that this component belongs to" - } - } - }, - "VersionedControllerService" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The component's unique identifier" - }, - "name" : { - "type" : "string", - "description" : "The component's name" - }, - "comments" : { - "type" : "string", - "description" : "The user-supplied comments for the component" - }, - "position" : { - "description" : "The component's position on the graph", - "$ref" : "#/definitions/Position" - }, - "type" : { - "type" : "string", - "description" : "The type of the controller service." - }, - "bundle" : { - "description" : "The details of the artifact that bundled this processor type.", - "$ref" : "#/definitions/Bundle" - }, - "controllerServiceApis" : { - "type" : "array", - "description" : "Lists the APIs this Controller Service implements.", - "items" : { - "$ref" : "#/definitions/ControllerServiceAPI" - } - }, - "properties" : { - "type" : "object", - "description" : "The properties of the controller service.", - "additionalProperties" : { - "type" : "string" - } - }, - "propertyDescriptors" : { - "type" : "object", - "description" : "The property descriptors for the processor.", - "additionalProperties" : { - "$ref" : "#/definitions/VersionedPropertyDescriptor" - } - }, - "annotationData" : { - "type" : "string", - "description" : "The annotation for the controller service. This is how the custom UI relays configuration to the controller service." - }, - "componentType" : { - "type" : "string", - "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE" ] - }, - "groupIdentifier" : { - "type" : "string", - "description" : "The ID of the Process Group that this component belongs to" - } - } - }, - "VersionedFlowCoordinates" : { - "type" : "object", - "properties" : { - "registryUrl" : { - "type" : "string", - "description" : "The URL of the Flow Registry that contains the flow" - }, - "bucketId" : { - "type" : "string", - "description" : "The UUID of the bucket that the flow resides in" - }, - "flowId" : { - "type" : "string", - "description" : "The UUID of the flow" - }, - "version" : { - "type" : "integer", - "format" : "int32", - "description" : "The version of the flow" - }, - "latest" : { - "type" : "boolean", - "description" : "Whether or not these coordinates point to the latest version of the flow" - } - } - }, - "VersionedFlowDTO" : { - "type" : "object", - "properties" : { - "registryId" : { - "type" : "string", - "description" : "The ID of the registry that the flow is tracked to" - }, - "bucketId" : { - "type" : "string", - "description" : "The ID of the bucket where the flow is stored" - }, - "flowId" : { - "type" : "string", - "description" : "The ID of the flow" - }, - "flowName" : { - "type" : "string", - "description" : "The name of the flow" - }, - "description" : { - "type" : "string", - "description" : "A description of the flow" - }, - "comments" : { - "type" : "string", - "description" : "Comments for the changeset" - } - } - }, - "VersionedFlowEntity" : { - "type" : "object", - "properties" : { - "versionedFlow" : { - "description" : "The versioned flow", - "$ref" : "#/definitions/VersionedFlowDTO" - } - }, - "xml" : { - "name" : "versionedFlowEntity" - } - }, - "VersionedFlowSnapshotEntity" : { - "type" : "object", - "properties" : { - "versionedFlowSnapshot" : { - "description" : "The versioned flow snapshot", - "$ref" : "#/definitions/versionedFlowSnapshot" - }, - "processGroupRevision" : { - "description" : "The Revision of the Process Group under Version Control", - "$ref" : "#/definitions/RevisionDTO" - }, - "registryId" : { - "type" : "string", - "description" : "The ID of the Registry that this flow belongs to" - }, - "updateDescendantVersionedFlows" : { - "type" : "boolean", - "description" : "If the Process Group to be updated has a child or descendant Process Group that is also under Version Control, this specifies whether or not the contents of that child/descendant Process Group should be updated." - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - } - }, - "xml" : { - "name" : "versionedFlowSnapshotEntity" - } - }, - "VersionedFlowSnapshotMetadataEntity" : { - "type" : "object", - "properties" : { - "versionedFlowSnapshotMetadata" : { - "description" : "The collection of versioned flow snapshot metadata", - "$ref" : "#/definitions/versionedFlowSnapshotMetadata" - }, - "registryId" : { - "type" : "string", - "description" : "The ID of the Registry that this flow belongs to" - } - }, - "xml" : { - "name" : "versionedFlowSnapshotMetadataEntity" - } - }, - "VersionedFlowSnapshotMetadataSetEntity" : { - "type" : "object", - "properties" : { - "versionedFlowSnapshotMetadataSet" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedFlowSnapshotMetadataEntity" - } - } - }, - "xml" : { - "name" : "versionedFlowSnapshotMetadataSetEntity" - } - }, - "VersionedFlowUpdateRequestDTO" : { - "type" : "object", - "properties" : { - "requestId" : { - "type" : "string", - "description" : "The unique ID of this request.", - "readOnly" : true - }, - "processGroupId" : { - "type" : "string", - "description" : "The unique ID of the Process Group that the variable registry belongs to" - }, - "uri" : { - "type" : "string", - "description" : "The URI for future requests to this drop request.", - "readOnly" : true - }, - "lastUpdated" : { - "type" : "string", - "description" : "The last time this request was updated.", - "readOnly" : true - }, - "complete" : { - "type" : "boolean", - "description" : "Whether or not this request has completed", - "readOnly" : true - }, - "failureReason" : { - "type" : "string", - "description" : "An explanation of why this request failed, or null if this request has not failed", - "readOnly" : true - }, - "percentCompleted" : { - "type" : "integer", - "format" : "int32", - "description" : "The percentage complete for the request, between 0 and 100", - "readOnly" : true - }, - "state" : { - "type" : "string", - "description" : "The state of the request", - "readOnly" : true - }, - "versionControlInformation" : { - "description" : "The VersionControlInformation that describes where the Versioned Flow is located; this may not be populated until the request is completed.", - "readOnly" : true, - "$ref" : "#/definitions/VersionControlInformationDTO" - } - } - }, - "VersionedFlowUpdateRequestEntity" : { - "type" : "object", - "properties" : { - "request" : { - "description" : "The Versioned Flow Update Request", - "$ref" : "#/definitions/VersionedFlowUpdateRequestDTO" - }, - "processGroupRevision" : { - "description" : "The revision for the Process Group that owns this variable registry.", - "$ref" : "#/definitions/RevisionDTO" - } - }, - "xml" : { - "name" : "versionedFlowUpdateRequestEntity" - } - }, - "VersionedFlowsEntity" : { - "type" : "object", - "properties" : { - "versionedFlows" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedFlowEntity" - } - } - }, - "xml" : { - "name" : "versionedFlowsEntity" - } - }, - "VersionedFunnel" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The component's unique identifier" - }, - "name" : { - "type" : "string", - "description" : "The component's name" - }, - "comments" : { - "type" : "string", - "description" : "The user-supplied comments for the component" - }, - "position" : { - "description" : "The component's position on the graph", - "$ref" : "#/definitions/Position" - }, - "componentType" : { - "type" : "string", - "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE" ] - }, - "groupIdentifier" : { - "type" : "string", - "description" : "The ID of the Process Group that this component belongs to" - } - } - }, - "VersionedLabel" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The component's unique identifier" - }, - "name" : { - "type" : "string", - "description" : "The component's name" - }, - "comments" : { - "type" : "string", - "description" : "The user-supplied comments for the component" - }, - "position" : { - "description" : "The component's position on the graph", - "$ref" : "#/definitions/Position" - }, - "label" : { - "type" : "string", - "description" : "The text that appears in the label." - }, - "width" : { - "type" : "number", - "format" : "double", - "description" : "The width of the label in pixels when at a 1:1 scale." - }, - "height" : { - "type" : "number", - "format" : "double", - "description" : "The height of the label in pixels when at a 1:1 scale." - }, - "style" : { - "type" : "object", - "description" : "The styles for this label (font-size : 12px, background-color : #eee, etc).", - "additionalProperties" : { - "type" : "string" - } - }, - "componentType" : { - "type" : "string", - "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE" ] - }, - "groupIdentifier" : { - "type" : "string", - "description" : "The ID of the Process Group that this component belongs to" - } - } - }, - "VersionedPort" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The component's unique identifier" - }, - "name" : { - "type" : "string", - "description" : "The component's name" - }, - "comments" : { - "type" : "string", - "description" : "The user-supplied comments for the component" - }, - "position" : { - "description" : "The component's position on the graph", - "$ref" : "#/definitions/Position" - }, - "type" : { - "type" : "string", - "description" : "The type of port.", - "enum" : [ "INPUT_PORT", "OUTPUT_PORT" ] - }, - "concurrentlySchedulableTaskCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of tasks that should be concurrently scheduled for the port." - }, - "componentType" : { - "type" : "string", - "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE" ] - }, - "groupIdentifier" : { - "type" : "string", - "description" : "The ID of the Process Group that this component belongs to" - } - } - }, - "VersionedProcessGroup" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The component's unique identifier" - }, - "name" : { - "type" : "string", - "description" : "The component's name" - }, - "comments" : { - "type" : "string", - "description" : "The user-supplied comments for the component" - }, - "position" : { - "description" : "The component's position on the graph", - "$ref" : "#/definitions/Position" - }, - "processGroups" : { - "type" : "array", - "description" : "The child Process Groups", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedProcessGroup" - } - }, - "remoteProcessGroups" : { - "type" : "array", - "description" : "The Remote Process Groups", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedRemoteProcessGroup" - } - }, - "processors" : { - "type" : "array", - "description" : "The Processors", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedProcessor" - } - }, - "inputPorts" : { - "type" : "array", - "description" : "The Input Ports", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedPort" - } - }, - "outputPorts" : { - "type" : "array", - "description" : "The Output Ports", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedPort" - } - }, - "connections" : { - "type" : "array", - "description" : "The Connections", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedConnection" - } - }, - "labels" : { - "type" : "array", - "description" : "The Labels", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedLabel" - } - }, - "funnels" : { - "type" : "array", - "description" : "The Funnels", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedFunnel" - } - }, - "controllerServices" : { - "type" : "array", - "description" : "The Controller Services", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedControllerService" - } - }, - "versionedFlowCoordinates" : { - "description" : "The coordinates where the remote flow is stored, or null if the Process Group is not directly under Version Control", - "$ref" : "#/definitions/VersionedFlowCoordinates" - }, - "variables" : { - "type" : "object", - "description" : "The Variables in the Variable Registry for this Process Group (not including any ancestor or descendant Process Groups)", - "additionalProperties" : { - "type" : "string" - } - }, - "componentType" : { - "type" : "string", - "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE" ] - }, - "groupIdentifier" : { - "type" : "string", - "description" : "The ID of the Process Group that this component belongs to" - } - } - }, - "VersionedProcessor" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The component's unique identifier" - }, - "name" : { - "type" : "string", - "description" : "The component's name" - }, - "comments" : { - "type" : "string", - "description" : "The user-supplied comments for the component" - }, - "position" : { - "description" : "The component's position on the graph", - "$ref" : "#/definitions/Position" - }, - "bundle" : { - "description" : "Information about the bundle from which the component came", - "$ref" : "#/definitions/Bundle" - }, - "style" : { - "type" : "object", - "description" : "Stylistic data for rendering in a UI", - "additionalProperties" : { - "type" : "string" - } - }, - "type" : { - "type" : "string", - "description" : "The type of Processor" - }, - "properties" : { - "type" : "object", - "description" : "The properties for the processor. Properties whose value is not set will only contain the property name.", - "additionalProperties" : { - "type" : "string" - } - }, - "propertyDescriptors" : { - "type" : "object", - "description" : "The property descriptors for the processor.", - "additionalProperties" : { - "$ref" : "#/definitions/VersionedPropertyDescriptor" - } - }, - "annotationData" : { - "type" : "string", - "description" : "The annotation data for the processor used to relay configuration between a custom UI and the procesosr." - }, - "schedulingPeriod" : { - "type" : "string", - "description" : "The frequency with which to schedule the processor. The format of the value will depend on th value of schedulingStrategy." - }, - "schedulingStrategy" : { - "type" : "string", - "description" : "Indcates whether the prcessor should be scheduled to run in event or timer driven mode." - }, - "executionNode" : { - "type" : "string", - "description" : "Indicates the node where the process will execute." - }, - "penaltyDuration" : { - "type" : "string", - "description" : "The amout of time that is used when the process penalizes a flowfile." - }, - "yieldDuration" : { - "type" : "string", - "description" : "The amount of time that must elapse before this processor is scheduled again after yielding." - }, - "bulletinLevel" : { - "type" : "string", - "description" : "The level at which the processor will report bulletins." - }, - "runDurationMillis" : { - "type" : "integer", - "format" : "int64", - "description" : "The run duration for the processor in milliseconds." - }, - "concurrentlySchedulableTaskCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of tasks that should be concurrently schedule for the processor. If the processor doesn't allow parallol processing then any positive input will be ignored." - }, - "autoTerminatedRelationships" : { - "type" : "array", - "description" : "The names of all relationships that cause a flow file to be terminated if the relationship is not connected elsewhere. This property differs from the 'isAutoTerminate' property of the RelationshipDTO in that the RelationshipDTO is meant to depict the current configuration, whereas this property can be set in a DTO when updating a Processor in order to change which Relationships should be auto-terminated.", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - }, - "componentType" : { - "type" : "string", - "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE" ] - }, - "groupIdentifier" : { - "type" : "string", - "description" : "The ID of the Process Group that this component belongs to" - } - } - }, - "VersionedPropertyDescriptor" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The name of the property" - }, - "displayName" : { - "type" : "string", - "description" : "The display name of the property" - }, - "identifiesControllerService" : { - "type" : "boolean", - "description" : "Whether or not the property provides the identifier of a Controller Service" - }, - "sensitive" : { - "type" : "boolean", - "description" : "Whether or not the property is considered sensitive" - } - } - }, - "VersionedRemoteGroupPort" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The component's unique identifier" - }, - "name" : { - "type" : "string", - "description" : "The component's name" - }, - "comments" : { - "type" : "string", - "description" : "The user-supplied comments for the component" - }, - "position" : { - "description" : "The component's position on the graph", - "$ref" : "#/definitions/Position" - }, - "remoteGroupId" : { - "type" : "string", - "description" : "The id of the remote process group that the port resides in." - }, - "concurrentlySchedulableTaskCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of task that may transmit flowfiles to the target port concurrently." - }, - "useCompression" : { - "type" : "boolean", - "description" : "Whether the flowfiles are compressed when sent to the target port." - }, - "batchSize" : { - "description" : "The batch settings for data transmission.", - "$ref" : "#/definitions/BatchSize" - }, - "componentType" : { - "type" : "string", - "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE" ] - }, - "targetId" : { - "type" : "string", - "description" : "The ID of the port on the target NiFi instance" - }, - "groupIdentifier" : { - "type" : "string", - "description" : "The ID of the Process Group that this component belongs to" - } - } - }, - "VersionedRemoteProcessGroup" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The component's unique identifier" - }, - "name" : { - "type" : "string", - "description" : "The component's name" - }, - "comments" : { - "type" : "string", - "description" : "The user-supplied comments for the component" - }, - "position" : { - "description" : "The component's position on the graph", - "$ref" : "#/definitions/Position" - }, - "targetUri" : { - "type" : "string", - "description" : "[DEPRECATED] The target URI of the remote process group. If target uri is not set, but uris are set, then returns the first uri in the uris. If neither target uri nor uris are set, then returns null." - }, - "targetUris" : { - "type" : "string", - "description" : "The target URIs of the remote process group. If target uris is not set but target uri is set, then returns the single target uri. If neither target uris nor target uri is set, then returns null." - }, - "communicationsTimeout" : { - "type" : "string", - "description" : "The time period used for the timeout when communicating with the target." - }, - "yieldDuration" : { - "type" : "string", - "description" : "When yielding, this amount of time must elapse before the remote process group is scheduled again." - }, - "transportProtocol" : { - "type" : "string", - "description" : "The Transport Protocol that is used for Site-to-Site communications", - "enum" : [ "RAW", "HTTP" ] - }, - "localNetworkInterface" : { - "type" : "string", - "description" : "The local network interface to send/receive data. If not specified, any local address is used. If clustered, all nodes must have an interface with this identifier." - }, - "proxyHost" : { - "type" : "string" - }, - "proxyPort" : { - "type" : "integer", - "format" : "int32" - }, - "proxyUser" : { - "type" : "string" - }, - "inputPorts" : { - "type" : "array", - "description" : "A Set of Input Ports that can be connected to, in order to send data to the remote NiFi instance", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedRemoteGroupPort" - } - }, - "outputPorts" : { - "type" : "array", - "description" : "A Set of Output Ports that can be connected to, in order to pull data from the remote NiFi instance", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedRemoteGroupPort" - } - }, - "componentType" : { - "type" : "string", - "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE" ] - }, - "groupIdentifier" : { - "type" : "string", - "description" : "The ID of the Process Group that this component belongs to" - } - } - }, - "bucket" : { - "type" : "object", - "required" : [ "name" ], - "properties" : { - "link" : { - "description" : "An WebLink to this entity.", - "readOnly" : true, - "$ref" : "#/definitions/Link" - }, - "identifier" : { - "type" : "string", - "description" : "An ID to uniquely identify this object.", - "readOnly" : true - }, - "name" : { - "type" : "string", - "description" : "The name of the bucket." - }, - "createdTimestamp" : { - "type" : "integer", - "format" : "int64", - "description" : "The timestamp of when the bucket was first created. This is set by the server at creation time.", - "readOnly" : true, - "minimum" : 1 - }, - "description" : { - "type" : "string", - "description" : "A description of the bucket." - }, - "permissions" : { - "description" : "The access that the current user has to this bucket.", - "readOnly" : true, - "$ref" : "#/definitions/permissions" - } - } - }, - "permissions" : { - "type" : "object", - "properties" : { - "canRead" : { - "type" : "boolean", - "description" : "Indicates whether the user can read a given resource.", - "readOnly" : true - }, - "canWrite" : { - "type" : "boolean", - "description" : "Indicates whether the user can write a given resource.", - "readOnly" : true - }, - "canDelete" : { - "type" : "boolean", - "description" : "Indicates whether the user can delete a given resource.", - "readOnly" : true - } - } - }, - "versionedFlow" : { - "type" : "object", - "required" : [ "bucketIdentifier", "name", "type" ], - "properties" : { - "link" : { - "description" : "An WebLink to this entity.", - "readOnly" : true, - "$ref" : "#/definitions/Link" - }, - "identifier" : { - "type" : "string", - "description" : "An ID to uniquely identify this object.", - "readOnly" : true - }, - "name" : { - "type" : "string", - "description" : "The name of the item." - }, - "description" : { - "type" : "string", - "description" : "A description of the item." - }, - "bucketIdentifier" : { - "type" : "string", - "description" : "The identifier of the bucket this items belongs to. This cannot be changed after the item is created." - }, - "bucketName" : { - "type" : "string", - "description" : "The name of the bucket this items belongs to.", - "readOnly" : true - }, - "createdTimestamp" : { - "type" : "integer", - "format" : "int64", - "description" : "The timestamp of when the item was created, as milliseconds since epoch.", - "readOnly" : true, - "minimum" : 1 - }, - "modifiedTimestamp" : { - "type" : "integer", - "format" : "int64", - "description" : "The timestamp of when the item was last modified, as milliseconds since epoch.", - "readOnly" : true, - "minimum" : 1 - }, - "type" : { - "type" : "string", - "description" : "The type of item.", - "enum" : [ "Flow" ] - }, - "permissions" : { - "description" : "The access that the current user has to the bucket containing this item.", - "readOnly" : true, - "$ref" : "#/definitions/permissions" - }, - "versionCount" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of versions of this flow.", - "readOnly" : true, - "minimum" : 0 - } - } - }, - "versionedFlowSnapshot" : { - "type" : "object", - "required" : [ "flowContents", "snapshotMetadata" ], - "properties" : { - "snapshotMetadata" : { - "description" : "The metadata for this snapshot", - "$ref" : "#/definitions/versionedFlowSnapshotMetadata" - }, - "flowContents" : { - "description" : "The contents of the versioned flow", - "$ref" : "#/definitions/VersionedProcessGroup" - }, - "flow" : { - "description" : "The flow this snapshot is for", - "readOnly" : true, - "$ref" : "#/definitions/versionedFlow" - }, - "bucket" : { - "description" : "The bucket where the flow is located", - "readOnly" : true, - "$ref" : "#/definitions/bucket" - }, - "latest" : { - "type" : "boolean" - } - } - }, - "versionedFlowSnapshotMetadata" : { - "type" : "object", - "required" : [ "bucketIdentifier", "flowIdentifier", "version" ], - "properties" : { - "link" : { - "description" : "An WebLink to this entity.", - "readOnly" : true, - "$ref" : "#/definitions/Link" - }, - "bucketIdentifier" : { - "type" : "string", - "description" : "The identifier of the bucket this snapshot belongs to." - }, - "flowIdentifier" : { - "type" : "string", - "description" : "The identifier of the flow this snapshot belongs to." - }, - "version" : { - "type" : "integer", - "format" : "int32", - "description" : "The version of this snapshot of the flow.", - "minimum" : 1 - }, - "timestamp" : { - "type" : "integer", - "format" : "int64", - "description" : "The timestamp when the flow was saved, as milliseconds since epoch.", - "readOnly" : true, - "minimum" : 1 - }, - "author" : { - "type" : "string", - "description" : "The user that created this snapshot of the flow.", - "readOnly" : true - }, - "comments" : { - "type" : "string", - "description" : "The comments provided by the user when creating the snapshot." - } - } - } - } -} \ No newline at end of file diff --git a/resources/client_gen/api_defs/nifi-1.9.1.json b/resources/client_gen/api_defs/nifi-1.9.1.json deleted file mode 100644 index acdc5882..00000000 --- a/resources/client_gen/api_defs/nifi-1.9.1.json +++ /dev/null @@ -1,19073 +0,0 @@ -{ - "swagger" : "2.0", - "info" : { - "description" : "The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and \n stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description,\n definitions of the expected input and output, potential response codes, and the authorizations required\n to invoke each service.", - "version" : "1.9.1", - "title" : "NiFi Rest Api", - "contact" : { - "url" : "https://nifi.apache.org", - "email" : "dev@nifi.apache.org" - }, - "license" : { - "name" : "Apache 2.0", - "url" : "http://www.apache.org/licenses/LICENSE-2.0.html" - } - }, - "basePath" : "/nifi-api", - "tags" : [ { - "name" : "access", - "description" : "Endpoints for obtaining an access token or checking access status." - }, { - "name" : "connections", - "description" : "Endpoint for managing a Connection." - }, { - "name" : "controller", - "description" : "Provides realtime command and control of this NiFi instance" - }, { - "name" : "controller-services", - "description" : "Endpoint for managing a Controller Service." - }, { - "name" : "counters", - "description" : "Endpoint for managing counters." - }, { - "name" : "data-transfer", - "description" : "Supports data transfers with this NiFi using HTTP based site to site" - }, { - "name" : "flow", - "description" : "Endpoint for accessing the flow structure and component status." - }, { - "name" : "flowfile-queues", - "description" : "Endpoint for managing a FlowFile Queue." - }, { - "name" : "funnel", - "description" : "Endpoint for managing a Funnel." - }, { - "name" : "input-ports", - "description" : "Endpoint for managing an Input Port." - }, { - "name" : "labels", - "description" : "Endpoint for managing a Label." - }, { - "name" : "output-ports", - "description" : "Endpoint for managing an Output Port." - }, { - "name" : "policies", - "description" : "Endpoint for managing access policies." - }, { - "name" : "process-groups", - "description" : "Endpoint for managing a Process Group." - }, { - "name" : "processors", - "description" : "Endpoint for managing a Processor." - }, { - "name" : "provenance", - "description" : "Endpoint for accessing data flow provenance." - }, { - "name" : "provenance-events", - "description" : "Endpoint for accessing data flow provenance." - }, { - "name" : "remote-process-groups", - "description" : "Endpoint for managing a Remote Process Group." - }, { - "name" : "reporting-tasks", - "description" : "Endpoint for managing a Reporting Task." - }, { - "name" : "resources", - "description" : "Provides the resources in this NiFi that can have access/authorization policies." - }, { - "name" : "site-to-site", - "description" : "Provide access to site to site with this NiFi" - }, { - "name" : "snippets", - "description" : "Endpoint for accessing dataflow snippets." - }, { - "name" : "system-diagnostics", - "description" : "Endpoint for accessing system diagnostics." - }, { - "name" : "templates", - "description" : "Endpoint for managing a Template." - }, { - "name" : "tenants", - "description" : "Endpoint for managing users and user groups." - }, { - "name" : "versions", - "description" : "Endpoint for managing version control for a flow" - } ], - "schemes" : [ "http", "https" ], - "paths" : { - "/access" : { - "get" : { - "tags" : [ "access" ], - "summary" : "Gets the status the client's access", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getAccessStatus", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/AccessStatusEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Unable to determine access status because the client could not be authenticated." - }, - "403" : { - "description" : "Unable to determine access status because the client is not authorized to make this request." - }, - "409" : { - "description" : "Unable to determine access status because NiFi is not in the appropriate state." - }, - "500" : { - "description" : "Unable to determine access status because an unexpected error occurred." - } - } - } - }, - "/access/config" : { - "get" : { - "tags" : [ "access" ], - "summary" : "Retrieves the access configuration for this NiFi", - "description" : "", - "operationId" : "getLoginConfig", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/AccessConfigurationEntity" - } - } - } - } - }, - "/access/download-token" : { - "post" : { - "tags" : [ "access" ], - "summary" : "Creates a single use access token for downloading FlowFile content.", - "description" : "The token returned is a base64 encoded string. It is valid for a single request up to five minutes from being issued. It is used as a query parameter name 'access_token'.", - "operationId" : "createDownloadToken", - "consumes" : [ "application/x-www-form-urlencoded" ], - "produces" : [ "text/plain" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "Unable to create the download token because NiFi is not in the appropriate state. (i.e. may not have any tokens to grant or be configured to support username/password login)" - }, - "500" : { - "description" : "Unable to create download token because an unexpected error occurred." - } - } - } - }, - "/access/kerberos" : { - "post" : { - "tags" : [ "access" ], - "summary" : "Creates a token for accessing the REST API via Kerberos ticket exchange / SPNEGO negotiation", - "description" : "The token returned is formatted as a JSON Web Token (JWT). The token is base64 encoded and comprised of three parts. The header, the body, and the signature. The expiration of the token is a contained within the body. The token can be used in the Authorization header in the format 'Authorization: Bearer '.", - "operationId" : "createAccessTokenFromTicket", - "consumes" : [ "text/plain" ], - "produces" : [ "text/plain" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "NiFi was unable to complete the request because it did not contain a valid Kerberos ticket in the Authorization header. Retry this request after initializing a ticket with kinit and ensuring your browser is configured to support SPNEGO." - }, - "409" : { - "description" : "Unable to create access token because NiFi is not in the appropriate state. (i.e. may not be configured to support Kerberos login." - }, - "500" : { - "description" : "Unable to create access token because an unexpected error occurred." - } - } - } - }, - "/access/knox/callback" : { - "get" : { - "tags" : [ "access" ], - "summary" : "Redirect/callback URI for processing the result of the Apache Knox login sequence.", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "knoxCallback", - "consumes" : [ "*/*" ], - "produces" : [ "*/*" ], - "responses" : { - "default" : { - "description" : "successful operation" - } - } - } - }, - "/access/knox/logout" : { - "get" : { - "tags" : [ "access" ], - "summary" : "Performs a logout in the Apache Knox.", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "knoxLogout", - "consumes" : [ "*/*" ], - "produces" : [ "*/*" ], - "responses" : { - "default" : { - "description" : "successful operation" - } - } - } - }, - "/access/knox/request" : { - "get" : { - "tags" : [ "access" ], - "summary" : "Initiates a request to authenticate through Apache Knox.", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "knoxRequest", - "consumes" : [ "*/*" ], - "produces" : [ "*/*" ], - "responses" : { - "default" : { - "description" : "successful operation" - } - } - } - }, - "/access/oidc/callback" : { - "get" : { - "tags" : [ "access" ], - "summary" : "Redirect/callback URI for processing the result of the OpenId Connect login sequence.", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "oidcCallback", - "consumes" : [ "*/*" ], - "produces" : [ "*/*" ], - "responses" : { - "default" : { - "description" : "successful operation" - } - } - } - }, - "/access/oidc/exchange" : { - "post" : { - "tags" : [ "access" ], - "summary" : "Retrieves a JWT following a successful login sequence using the configured OpenId Connect provider.", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "oidcExchange", - "consumes" : [ "*/*" ], - "produces" : [ "text/plain" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - } - } - } - }, - "/access/oidc/logout" : { - "get" : { - "tags" : [ "access" ], - "summary" : "Performs a logout in the OpenId Provider.", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "oidcLogout", - "consumes" : [ "*/*" ], - "produces" : [ "*/*" ], - "responses" : { - "default" : { - "description" : "successful operation" - } - } - } - }, - "/access/oidc/request" : { - "get" : { - "tags" : [ "access" ], - "summary" : "Initiates a request to authenticate through the configured OpenId Connect provider.", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "oidcRequest", - "consumes" : [ "*/*" ], - "produces" : [ "*/*" ], - "responses" : { - "default" : { - "description" : "successful operation" - } - } - } - }, - "/access/token" : { - "post" : { - "tags" : [ "access" ], - "summary" : "Creates a token for accessing the REST API via username/password", - "description" : "The token returned is formatted as a JSON Web Token (JWT). The token is base64 encoded and comprised of three parts. The header, the body, and the signature. The expiration of the token is a contained within the body. The token can be used in the Authorization header in the format 'Authorization: Bearer '.", - "operationId" : "createAccessToken", - "consumes" : [ "application/x-www-form-urlencoded" ], - "produces" : [ "text/plain" ], - "parameters" : [ { - "name" : "username", - "in" : "formData", - "required" : false, - "type" : "string" - }, { - "name" : "password", - "in" : "formData", - "required" : false, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "Unable to create access token because NiFi is not in the appropriate state. (i.e. may not be configured to support username/password login." - }, - "500" : { - "description" : "Unable to create access token because an unexpected error occurred." - } - } - } - }, - "/access/ui-extension-token" : { - "post" : { - "tags" : [ "access" ], - "summary" : "Creates a single use access token for accessing a NiFi UI extension.", - "description" : "The token returned is a base64 encoded string. It is valid for a single request up to five minutes from being issued. It is used as a query parameter name 'access_token'.", - "operationId" : "createUiExtensionToken", - "consumes" : [ "application/x-www-form-urlencoded" ], - "produces" : [ "text/plain" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "Unable to create the download token because NiFi is not in the appropriate state. (i.e. may not have any tokens to grant or be configured to support username/password login)" - }, - "500" : { - "description" : "Unable to create download token because an unexpected error occurred." - } - } - } - }, - "/connections/{id}" : { - "get" : { - "tags" : [ "connections" ], - "summary" : "Gets a connection", - "description" : "", - "operationId" : "getConnection", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The connection id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ConnectionEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read Source - /{component-type}/{uuid}" : [ ] - }, { - "Read Destination - /{component-type}/{uuid}" : [ ] - } ] - }, - "put" : { - "tags" : [ "connections" ], - "summary" : "Updates a connection", - "description" : "", - "operationId" : "updateConnection", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The connection id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The connection configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ConnectionEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ConnectionEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write Source - /{component-type}/{uuid}" : [ ] - }, { - "Write Destination - /{component-type}/{uuid}" : [ ] - }, { - "Write New Destination - /{component-type}/{uuid} - if updating Destination" : [ ] - }, { - "Write Process Group - /process-groups/{uuid} - if updating Destination" : [ ] - } ] - }, - "delete" : { - "tags" : [ "connections" ], - "summary" : "Deletes a connection", - "description" : "", - "operationId" : "deleteConnection", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The revision is used to verify the client is working with the latest version of the flow.", - "required" : false, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The connection id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ConnectionEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write Source - /{component-type}/{uuid}" : [ ] - }, { - "Write - Parent Process Group - /process-groups/{uuid}" : [ ] - }, { - "Write Destination - /{component-type}/{uuid}" : [ ] - } ] - } - }, - "/controller-services/{id}" : { - "get" : { - "tags" : [ "controller-services" ], - "summary" : "Gets a controller service", - "description" : "", - "operationId" : "getControllerService", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The controller service id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ControllerServiceEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /controller-services/{uuid}" : [ ] - } ] - }, - "put" : { - "tags" : [ "controller-services" ], - "summary" : "Updates a controller service", - "description" : "", - "operationId" : "updateControllerService", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The controller service id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The controller service configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ControllerServiceEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ControllerServiceEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /controller-services/{uuid}" : [ ] - }, { - "Read - any referenced Controller Services if this request changes the reference - /controller-services/{uuid}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "controller-services" ], - "summary" : "Deletes a controller service", - "description" : "", - "operationId" : "removeControllerService", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The revision is used to verify the client is working with the latest version of the flow.", - "required" : false, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The controller service id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ControllerServiceEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /controller-services/{uuid}" : [ ] - }, { - "Write - Parent Process Group if scoped by Process Group - /process-groups/{uuid}" : [ ] - }, { - "Write - Controller if scoped by Controller - /controller" : [ ] - }, { - "Read - any referenced Controller Services - /controller-services/{uuid}" : [ ] - } ] - } - }, - "/controller-services/{id}/descriptors" : { - "get" : { - "tags" : [ "controller-services" ], - "summary" : "Gets a controller service property descriptor", - "description" : "", - "operationId" : "getPropertyDescriptor", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The controller service id.", - "required" : true, - "type" : "string" - }, { - "name" : "propertyName", - "in" : "query", - "description" : "The property name to return the descriptor for.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/PropertyDescriptorEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /controller-services/{uuid}" : [ ] - } ] - } - }, - "/controller-services/{id}/references" : { - "get" : { - "tags" : [ "controller-services" ], - "summary" : "Gets a controller service", - "description" : "", - "operationId" : "getControllerServiceReferences", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The controller service id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ControllerServiceReferencingComponentsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /controller-services/{uuid}" : [ ] - } ] - }, - "put" : { - "tags" : [ "controller-services" ], - "summary" : "Updates a controller services references", - "description" : "", - "operationId" : "updateControllerServiceReferences", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The controller service id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The controller service request update request.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/UpdateControllerServiceReferenceRequestEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ControllerServiceReferencingComponentsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /{component-type}/{uuid} or /operate/{component-type}/{uuid} - For each referencing component specified" : [ ] - } ] - } - }, - "/controller-services/{id}/run-status" : { - "put" : { - "tags" : [ "controller-services" ], - "summary" : "Updates run status of a controller service", - "description" : "", - "operationId" : "updateRunStatus", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The controller service id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The controller service run status.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ControllerServiceRunStatusEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ControllerServiceEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /controller-services/{uuid} or /operation/controller-services/{uuid}" : [ ] - } ] - } - }, - "/controller-services/{id}/state" : { - "get" : { - "tags" : [ "controller-services" ], - "summary" : "Gets the state for a controller service", - "description" : "", - "operationId" : "getState", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The controller service id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ComponentStateEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /controller-services/{uuid}" : [ ] - } ] - } - }, - "/controller-services/{id}/state/clear-requests" : { - "post" : { - "tags" : [ "controller-services" ], - "summary" : "Clears the state for a controller service", - "description" : "", - "operationId" : "clearState", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The controller service id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ComponentStateEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /controller-services/{uuid}" : [ ] - } ] - } - }, - "/controller/bulletin" : { - "post" : { - "tags" : [ "controller" ], - "summary" : "Creates a new bulletin", - "description" : "", - "operationId" : "createBulletin", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The reporting task configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/BulletinEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /controller" : [ ] - } ] - } - }, - "/controller/cluster" : { - "get" : { - "tags" : [ "controller" ], - "summary" : "Gets the contents of the cluster", - "description" : "Returns the contents of the cluster including all nodes and their status.", - "operationId" : "getCluster", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ClusterEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /controller" : [ ] - } ] - } - }, - "/controller/cluster/nodes/{id}" : { - "get" : { - "tags" : [ "controller" ], - "summary" : "Gets a node in the cluster", - "description" : "", - "operationId" : "getNode", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The node id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/NodeEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /controller" : [ ] - } ] - }, - "put" : { - "tags" : [ "controller" ], - "summary" : "Updates a node in the cluster", - "description" : "", - "operationId" : "updateNode", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The node id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The node configuration. The only configuration that will be honored at this endpoint is the status.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/NodeEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/NodeEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /controller" : [ ] - } ] - }, - "delete" : { - "tags" : [ "controller" ], - "summary" : "Removes a node from the cluster", - "description" : "", - "operationId" : "deleteNode", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The node id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/NodeEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /controller" : [ ] - } ] - } - }, - "/controller/config" : { - "get" : { - "tags" : [ "controller" ], - "summary" : "Retrieves the configuration for this NiFi Controller", - "description" : "", - "operationId" : "getControllerConfig", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ControllerConfigurationEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /controller" : [ ] - } ] - }, - "put" : { - "tags" : [ "controller" ], - "summary" : "Retrieves the configuration for this NiFi", - "description" : "", - "operationId" : "updateControllerConfig", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The controller configuration.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ControllerConfigurationEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ControllerConfigurationEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /controller" : [ ] - } ] - } - }, - "/controller/controller-services" : { - "post" : { - "tags" : [ "controller" ], - "summary" : "Creates a new controller service", - "description" : "", - "operationId" : "createControllerService", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The controller service configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ControllerServiceEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ControllerServiceEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /controller" : [ ] - }, { - "Read - any referenced Controller Services - /controller-services/{uuid}" : [ ] - }, { - "Write - if the Controller Service is restricted - /restricted-components" : [ ] - } ] - } - }, - "/controller/history" : { - "delete" : { - "tags" : [ "controller" ], - "summary" : "Purges history", - "description" : "", - "operationId" : "deleteHistory", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "endDate", - "in" : "query", - "description" : "Purge actions before this date/time.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/HistoryEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /controller" : [ ] - } ] - } - }, - "/controller/registry-clients" : { - "get" : { - "tags" : [ "controller" ], - "summary" : "Gets the listing of available registry clients", - "description" : "", - "operationId" : "getRegistryClients", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/RegistryClientsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - }, - "post" : { - "tags" : [ "controller" ], - "summary" : "Creates a new registry client", - "description" : "", - "operationId" : "createRegistryClient", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The registry configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/RegistryClientEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/RegistryClientEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /controller" : [ ] - } ] - } - }, - "/controller/registry-clients/{id}" : { - "get" : { - "tags" : [ "controller" ], - "summary" : "Gets a registry client", - "description" : "", - "operationId" : "getRegistryClient", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The registry id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/RegistryClientEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /controller" : [ ] - } ] - }, - "put" : { - "tags" : [ "controller" ], - "summary" : "Updates a registry client", - "description" : "", - "operationId" : "updateRegistryClient", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The registry id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The registry configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/RegistryClientEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/RegistryClientEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /controller" : [ ] - } ] - }, - "delete" : { - "tags" : [ "controller" ], - "summary" : "Deletes a registry client", - "description" : "", - "operationId" : "deleteRegistryClient", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The revision is used to verify the client is working with the latest version of the flow.", - "required" : false, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The registry id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/RegistryClientEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /controller" : [ ] - } ] - } - }, - "/controller/reporting-tasks" : { - "post" : { - "tags" : [ "controller" ], - "summary" : "Creates a new reporting task", - "description" : "", - "operationId" : "createReportingTask", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The reporting task configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ReportingTaskEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ReportingTaskEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /controller" : [ ] - }, { - "Read - any referenced Controller Services - /controller-services/{uuid}" : [ ] - }, { - "Write - if the Reporting Task is restricted - /restricted-components" : [ ] - } ] - } - }, - "/counters" : { - "get" : { - "tags" : [ "counters" ], - "summary" : "Gets the current counters for this NiFi", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getCounters", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "nodewise", - "in" : "query", - "description" : "Whether or not to include the breakdown per node. Optional, defaults to false", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "clusterNodeId", - "in" : "query", - "description" : "The id of the node where to get the status.", - "required" : false, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/CountersEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /counters" : [ ] - } ] - } - }, - "/counters/{id}" : { - "put" : { - "tags" : [ "counters" ], - "summary" : "Updates the specified counter. This will reset the counter value to 0", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "updateCounter", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The id of the counter.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/CounterEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /counters" : [ ] - } ] - } - }, - "/data-transfer/input-ports/{portId}/transactions/{transactionId}" : { - "put" : { - "tags" : [ "data-transfer" ], - "summary" : "Extend transaction TTL", - "description" : "", - "operationId" : "extendInputPortTransactionTTL", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "portId", - "in" : "path", - "required" : true, - "type" : "string" - }, { - "name" : "transactionId", - "in" : "path", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/TransactionResultEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /data-transfer/input-ports/{uuid}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "data-transfer" ], - "summary" : "Commit or cancel the specified transaction", - "description" : "", - "operationId" : "commitInputPortTransaction", - "consumes" : [ "application/octet-stream" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "responseCode", - "in" : "query", - "description" : "The response code. Available values are BAD_CHECKSUM(19), CONFIRM_TRANSACTION(12) or CANCEL_TRANSACTION(15).", - "required" : true, - "type" : "integer", - "format" : "int32" - }, { - "name" : "portId", - "in" : "path", - "description" : "The input port id.", - "required" : true, - "type" : "string" - }, { - "name" : "transactionId", - "in" : "path", - "description" : "The transaction id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/TransactionResultEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - }, - "503" : { - "description" : "NiFi instance is not ready for serving request, or temporarily overloaded. Retrying the same request later may be successful" - } - }, - "security" : [ { - "Write - /data-transfer/input-ports/{uuid}" : [ ] - } ] - } - }, - "/data-transfer/input-ports/{portId}/transactions/{transactionId}/flow-files" : { - "post" : { - "tags" : [ "data-transfer" ], - "summary" : "Transfer flow files to the input port", - "description" : "", - "operationId" : "receiveFlowFiles", - "consumes" : [ "application/octet-stream" ], - "produces" : [ "text/plain" ], - "parameters" : [ { - "name" : "portId", - "in" : "path", - "description" : "The input port id.", - "required" : true, - "type" : "string" - }, { - "name" : "transactionId", - "in" : "path", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - }, - "503" : { - "description" : "NiFi instance is not ready for serving request, or temporarily overloaded. Retrying the same request later may be successful" - } - }, - "security" : [ { - "Write - /data-transfer/input-ports/{uuid}" : [ ] - } ] - } - }, - "/data-transfer/output-ports/{portId}/transactions/{transactionId}" : { - "put" : { - "tags" : [ "data-transfer" ], - "summary" : "Extend transaction TTL", - "description" : "", - "operationId" : "extendOutputPortTransactionTTL", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "portId", - "in" : "path", - "required" : true, - "type" : "string" - }, { - "name" : "transactionId", - "in" : "path", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/TransactionResultEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - }, - "503" : { - "description" : "NiFi instance is not ready for serving request, or temporarily overloaded. Retrying the same request later may be successful" - } - }, - "security" : [ { - "Write - /data-transfer/output-ports/{uuid}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "data-transfer" ], - "summary" : "Commit or cancel the specified transaction", - "description" : "", - "operationId" : "commitOutputPortTransaction", - "consumes" : [ "application/octet-stream" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "responseCode", - "in" : "query", - "description" : "The response code. Available values are CONFIRM_TRANSACTION(12) or CANCEL_TRANSACTION(15).", - "required" : true, - "type" : "integer", - "format" : "int32" - }, { - "name" : "checksum", - "in" : "query", - "description" : "A checksum calculated at client side using CRC32 to check flow file content integrity. It must match with the value calculated at server side.", - "required" : true, - "type" : "string" - }, { - "name" : "portId", - "in" : "path", - "description" : "The output port id.", - "required" : true, - "type" : "string" - }, { - "name" : "transactionId", - "in" : "path", - "description" : "The transaction id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/TransactionResultEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - }, - "503" : { - "description" : "NiFi instance is not ready for serving request, or temporarily overloaded. Retrying the same request later may be successful" - } - }, - "security" : [ { - "Write - /data-transfer/output-ports/{uuid}" : [ ] - } ] - } - }, - "/data-transfer/output-ports/{portId}/transactions/{transactionId}/flow-files" : { - "get" : { - "tags" : [ "data-transfer" ], - "summary" : "Transfer flow files from the output port", - "description" : "", - "operationId" : "transferFlowFiles", - "consumes" : [ "*/*" ], - "produces" : [ "application/octet-stream" ], - "parameters" : [ { - "name" : "portId", - "in" : "path", - "description" : "The output port id.", - "required" : true, - "type" : "string" - }, { - "name" : "transactionId", - "in" : "path", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "There is no flow file to return.", - "schema" : { - "$ref" : "#/definitions/StreamingOutput" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - }, - "503" : { - "description" : "NiFi instance is not ready for serving request, or temporarily overloaded. Retrying the same request later may be successful" - } - }, - "security" : [ { - "Write - /data-transfer/output-ports/{uuid}" : [ ] - } ] - } - }, - "/data-transfer/{portType}/{portId}/transactions" : { - "post" : { - "tags" : [ "data-transfer" ], - "summary" : "Create a transaction to the specified output port or input port", - "description" : "", - "operationId" : "createPortTransaction", - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "portType", - "in" : "path", - "description" : "The port type.", - "required" : true, - "type" : "string", - "enum" : [ "input-ports", "output-ports" ] - }, { - "name" : "portId", - "in" : "path", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/TransactionResultEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - }, - "503" : { - "description" : "NiFi instance is not ready for serving request, or temporarily overloaded. Retrying the same request later may be successful" - } - }, - "security" : [ { - "Write - /data-transfer/{component-type}/{uuid}" : [ ] - } ] - } - }, - "/flow/about" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Retrieves details about this NiFi to put in the About dialog", - "description" : "", - "operationId" : "getAboutInfo", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/AboutEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/banners" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Retrieves the banners for this NiFi", - "description" : "", - "operationId" : "getBanners", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/BannerEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/bulletin-board" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets current bulletins", - "description" : "", - "operationId" : "getBulletinBoard", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "after", - "in" : "query", - "description" : "Includes bulletins with an id after this value.", - "required" : false, - "type" : "string" - }, { - "name" : "sourceName", - "in" : "query", - "description" : "Includes bulletins originating from this sources whose name match this regular expression.", - "required" : false, - "type" : "string" - }, { - "name" : "message", - "in" : "query", - "description" : "Includes bulletins whose message that match this regular expression.", - "required" : false, - "type" : "string" - }, { - "name" : "sourceId", - "in" : "query", - "description" : "Includes bulletins originating from this sources whose id match this regular expression.", - "required" : false, - "type" : "string" - }, { - "name" : "groupId", - "in" : "query", - "description" : "Includes bulletins originating from this sources whose group id match this regular expression.", - "required" : false, - "type" : "string" - }, { - "name" : "limit", - "in" : "query", - "description" : "The number of bulletins to limit the response to.", - "required" : false, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/BulletinBoardEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - }, { - "Read - /{component-type}/{uuid} - For component specific bulletins" : [ ] - } ] - } - }, - "/flow/client-id" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Generates a client id.", - "description" : "", - "operationId" : "generateClientId", - "consumes" : [ "*/*" ], - "produces" : [ "text/plain" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/cluster/search-results" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Searches the cluster for a node with the specified address", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "searchCluster", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "q", - "in" : "query", - "description" : "Node address to search for.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ClusterSearchResultsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/cluster/summary" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "The cluster summary for this NiFi", - "description" : "", - "operationId" : "getClusterSummary", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ClusteSummaryEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/config" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Retrieves the configuration for this NiFi flow", - "description" : "", - "operationId" : "getFlowConfig", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/FlowConfigurationEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/connections/{id}/status" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets status for a connection", - "description" : "", - "operationId" : "getConnectionStatus", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "nodewise", - "in" : "query", - "description" : "Whether or not to include the breakdown per node. Optional, defaults to false", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "clusterNodeId", - "in" : "query", - "description" : "The id of the node where to get the status.", - "required" : false, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The connection id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ConnectionStatusEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/connections/{id}/status/history" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets the status history for a connection", - "description" : "", - "operationId" : "getConnectionStatusHistory", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The connection id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/StatusHistoryEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/controller-service-types" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Retrieves the types of controller services that this NiFi supports", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getControllerServiceTypes", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "serviceType", - "in" : "query", - "description" : "If specified, will only return controller services that are compatible with this type of service.", - "required" : false, - "type" : "string" - }, { - "name" : "serviceBundleGroup", - "in" : "query", - "description" : "If serviceType specified, is the bundle group of the serviceType.", - "required" : false, - "type" : "string" - }, { - "name" : "serviceBundleArtifact", - "in" : "query", - "description" : "If serviceType specified, is the bundle artifact of the serviceType.", - "required" : false, - "type" : "string" - }, { - "name" : "serviceBundleVersion", - "in" : "query", - "description" : "If serviceType specified, is the bundle version of the serviceType.", - "required" : false, - "type" : "string" - }, { - "name" : "bundleGroupFilter", - "in" : "query", - "description" : "If specified, will only return types that are a member of this bundle group.", - "required" : false, - "type" : "string" - }, { - "name" : "bundleArtifactFilter", - "in" : "query", - "description" : "If specified, will only return types that are a member of this bundle artifact.", - "required" : false, - "type" : "string" - }, { - "name" : "typeFilter", - "in" : "query", - "description" : "If specified, will only return types whose fully qualified classname matches.", - "required" : false, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ControllerServiceTypesEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/controller/bulletins" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Retrieves Controller level bulletins", - "description" : "", - "operationId" : "getBulletins", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ControllerBulletinsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - }, { - "Read - /controller - For controller bulletins" : [ ] - }, { - "Read - /controller-services/{uuid} - For controller service bulletins" : [ ] - }, { - "Read - /reporting-tasks/{uuid} - For reporting task bulletins" : [ ] - } ] - } - }, - "/flow/controller/controller-services" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets controller services for reporting tasks", - "description" : "", - "operationId" : "getControllerServicesFromController", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ControllerServicesEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/current-user" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Retrieves the user identity of the user making the request", - "description" : "", - "operationId" : "getCurrentUser", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/CurrentUserEntity" - } - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/history" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets configuration history", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "queryHistory", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "offset", - "in" : "query", - "description" : "The offset into the result set.", - "required" : true, - "type" : "string" - }, { - "name" : "count", - "in" : "query", - "description" : "The number of actions to return.", - "required" : true, - "type" : "string" - }, { - "name" : "sortColumn", - "in" : "query", - "description" : "The field to sort on.", - "required" : false, - "type" : "string" - }, { - "name" : "sortOrder", - "in" : "query", - "description" : "The direction to sort.", - "required" : false, - "type" : "string" - }, { - "name" : "startDate", - "in" : "query", - "description" : "Include actions after this date.", - "required" : false, - "type" : "string" - }, { - "name" : "endDate", - "in" : "query", - "description" : "Include actions before this date.", - "required" : false, - "type" : "string" - }, { - "name" : "userIdentity", - "in" : "query", - "description" : "Include actions performed by this user.", - "required" : false, - "type" : "string" - }, { - "name" : "sourceId", - "in" : "query", - "description" : "Include actions on this component.", - "required" : false, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/HistoryEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/history/components/{componentId}" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets configuration history for a component", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getComponentHistory", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "componentId", - "in" : "path", - "description" : "The component id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ComponentHistoryEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - }, { - "Read underlying component - /{component-type}/{uuid}" : [ ] - } ] - } - }, - "/flow/history/{id}" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets an action", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getAction", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The action id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ActionEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/input-ports/{id}/status" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets status for an input port", - "description" : "", - "operationId" : "getInputPortStatus", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "nodewise", - "in" : "query", - "description" : "Whether or not to include the breakdown per node. Optional, defaults to false", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "clusterNodeId", - "in" : "query", - "description" : "The id of the node where to get the status.", - "required" : false, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The input port id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/PortStatusEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/output-ports/{id}/status" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets status for an output port", - "description" : "", - "operationId" : "getOutputPortStatus", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "nodewise", - "in" : "query", - "description" : "Whether or not to include the breakdown per node. Optional, defaults to false", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "clusterNodeId", - "in" : "query", - "description" : "The id of the node where to get the status.", - "required" : false, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The output port id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/PortStatusEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/prioritizers" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Retrieves the types of prioritizers that this NiFi supports", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getPrioritizers", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/PrioritizerTypesEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/process-groups/{id}" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets a process group", - "description" : "", - "operationId" : "getFlow", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessGroupFlowEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - }, - "put" : { - "tags" : [ "flow" ], - "summary" : "Schedule or unschedule components in the specified Process Group.", - "description" : "", - "operationId" : "scheduleComponents", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The request to schedule or unschedule. If the comopnents in the request are not specified, all authorized components will be considered.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ScheduleComponentsEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ScheduleComponentsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - }, { - "Write - /{component-type}/{uuid} or /operation/{component-type}/{uuid} - For every component being scheduled/unscheduled" : [ ] - } ] - } - }, - "/flow/process-groups/{id}/controller-services" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets all controller services", - "description" : "", - "operationId" : "getControllerServicesFromGroup", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "name" : "includeAncestorGroups", - "in" : "query", - "description" : "Whether or not to include parent/ancestory process groups", - "required" : false, - "type" : "boolean", - "default" : true - }, { - "name" : "includeDescendantGroups", - "in" : "query", - "description" : "Whether or not to include descendant process groups", - "required" : false, - "type" : "boolean", - "default" : false - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ControllerServicesEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - }, - "put" : { - "tags" : [ "flow" ], - "summary" : "Enable or disable Controller Services in the specified Process Group.", - "description" : "", - "operationId" : "activateControllerServices", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The request to schedule or unschedule. If the comopnents in the request are not specified, all authorized components will be considered.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ActivateControllerServicesEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ActivateControllerServicesEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - }, { - "Write - /{component-type}/{uuid} or /operation/{component-type}/{uuid} - For every service being enabled/disabled" : [ ] - } ] - } - }, - "/flow/process-groups/{id}/status" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets the status for a process group", - "description" : "The status for a process group includes status for all descendent components. When invoked on the root group with recursive set to true, it will return the current status of every component in the flow.", - "operationId" : "getProcessGroupStatus", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "recursive", - "in" : "query", - "description" : "Whether all descendant groups and the status of their content will be included. Optional, defaults to false", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "nodewise", - "in" : "query", - "description" : "Whether or not to include the breakdown per node. Optional, defaults to false", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "clusterNodeId", - "in" : "query", - "description" : "The id of the node where to get the status.", - "required" : false, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessGroupStatusEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/process-groups/{id}/status/history" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets status history for a remote process group", - "description" : "", - "operationId" : "getProcessGroupStatusHistory", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/StatusHistoryEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/processor-types" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Retrieves the types of processors that this NiFi supports", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getProcessorTypes", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bundleGroupFilter", - "in" : "query", - "description" : "If specified, will only return types that are a member of this bundle group.", - "required" : false, - "type" : "string" - }, { - "name" : "bundleArtifactFilter", - "in" : "query", - "description" : "If specified, will only return types that are a member of this bundle artifact.", - "required" : false, - "type" : "string" - }, { - "name" : "type", - "in" : "query", - "description" : "If specified, will only return types whose fully qualified classname matches.", - "required" : false, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessorTypesEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/processors/{id}/status" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets status for a processor", - "description" : "", - "operationId" : "getProcessorStatus", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "nodewise", - "in" : "query", - "description" : "Whether or not to include the breakdown per node. Optional, defaults to false", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "clusterNodeId", - "in" : "query", - "description" : "The id of the node where to get the status.", - "required" : false, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The processor id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessorStatusEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/processors/{id}/status/history" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets status history for a processor", - "description" : "", - "operationId" : "getProcessorStatusHistory", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The processor id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/StatusHistoryEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/registries" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets the listing of available registries", - "description" : "", - "operationId" : "getRegistries", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/RegistryClientsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/registries/{id}/buckets" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets the buckets from the specified registry for the current user", - "description" : "", - "operationId" : "getBuckets", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The registry id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/BucketsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/registries/{registry-id}/buckets/{bucket-id}/flows" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets the flows from the specified registry and bucket for the current user", - "description" : "", - "operationId" : "getFlows", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "registry-id", - "in" : "path", - "description" : "The registry id.", - "required" : true, - "type" : "string" - }, { - "name" : "bucket-id", - "in" : "path", - "description" : "The bucket id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlowsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/registries/{registry-id}/buckets/{bucket-id}/flows/{flow-id}/versions" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets the flow versions from the specified registry and bucket for the specified flow for the current user", - "description" : "", - "operationId" : "getVersions", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "registry-id", - "in" : "path", - "description" : "The registry id.", - "required" : true, - "type" : "string" - }, { - "name" : "bucket-id", - "in" : "path", - "description" : "The bucket id.", - "required" : true, - "type" : "string" - }, { - "name" : "flow-id", - "in" : "path", - "description" : "The flow id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlowSnapshotMetadataSetEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/remote-process-groups/{id}/status" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets status for a remote process group", - "description" : "", - "operationId" : "getRemoteProcessGroupStatus", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "nodewise", - "in" : "query", - "description" : "Whether or not to include the breakdown per node. Optional, defaults to false", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "clusterNodeId", - "in" : "query", - "description" : "The id of the node where to get the status.", - "required" : false, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The remote process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/RemoteProcessGroupStatusEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/remote-process-groups/{id}/status/history" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets the status history", - "description" : "", - "operationId" : "getRemoteProcessGroupStatusHistory", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The remote process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/StatusHistoryEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/reporting-task-types" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Retrieves the types of reporting tasks that this NiFi supports", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getReportingTaskTypes", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bundleGroupFilter", - "in" : "query", - "description" : "If specified, will only return types that are a member of this bundle group.", - "required" : false, - "type" : "string" - }, { - "name" : "bundleArtifactFilter", - "in" : "query", - "description" : "If specified, will only return types that are a member of this bundle artifact.", - "required" : false, - "type" : "string" - }, { - "name" : "type", - "in" : "query", - "description" : "If specified, will only return types whose fully qualified classname matches.", - "required" : false, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ReportingTaskTypesEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/reporting-tasks" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets all reporting tasks", - "description" : "", - "operationId" : "getReportingTasks", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ReportingTasksEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/search-results" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Performs a search against this NiFi using the specified search term", - "description" : "Only search results from authorized components will be returned.", - "operationId" : "searchFlow", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "q", - "in" : "query", - "required" : false, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/SearchResultsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/status" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets the current status of this NiFi", - "description" : "", - "operationId" : "getControllerStatus", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ControllerStatusEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flow/templates" : { - "get" : { - "tags" : [ "flow" ], - "summary" : "Gets all templates", - "description" : "", - "operationId" : "getTemplates", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/TemplatesEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /flow" : [ ] - } ] - } - }, - "/flowfile-queues/{id}/drop-requests" : { - "post" : { - "tags" : [ "flowfile-queues" ], - "summary" : "Creates a request to drop the contents of the queue in this connection.", - "description" : "", - "operationId" : "createDropRequest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The connection id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/DropRequestEntity" - } - }, - "202" : { - "description" : "The request has been accepted. A HTTP response header will contain the URI where the response can be polled." - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write Source Data - /data/{component-type}/{uuid}" : [ ] - } ] - } - }, - "/flowfile-queues/{id}/drop-requests/{drop-request-id}" : { - "get" : { - "tags" : [ "flowfile-queues" ], - "summary" : "Gets the current status of a drop request for the specified connection.", - "description" : "", - "operationId" : "getDropRequest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The connection id.", - "required" : true, - "type" : "string" - }, { - "name" : "drop-request-id", - "in" : "path", - "description" : "The drop request id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/DropRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write Source Data - /data/{component-type}/{uuid}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "flowfile-queues" ], - "summary" : "Cancels and/or removes a request to drop the contents of this connection.", - "description" : "", - "operationId" : "removeDropRequest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The connection id.", - "required" : true, - "type" : "string" - }, { - "name" : "drop-request-id", - "in" : "path", - "description" : "The drop request id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/DropRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write Source Data - /data/{component-type}/{uuid}" : [ ] - } ] - } - }, - "/flowfile-queues/{id}/flowfiles/{flowfile-uuid}" : { - "get" : { - "tags" : [ "flowfile-queues" ], - "summary" : "Gets a FlowFile from a Connection.", - "description" : "", - "operationId" : "getFlowFile", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The connection id.", - "required" : true, - "type" : "string" - }, { - "name" : "flowfile-uuid", - "in" : "path", - "description" : "The flowfile uuid.", - "required" : true, - "type" : "string" - }, { - "name" : "clusterNodeId", - "in" : "query", - "description" : "The id of the node where the content exists if clustered.", - "required" : false, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/FlowFileEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read Source Data - /data/{component-type}/{uuid}" : [ ] - } ] - } - }, - "/flowfile-queues/{id}/flowfiles/{flowfile-uuid}/content" : { - "get" : { - "tags" : [ "flowfile-queues" ], - "summary" : "Gets the content for a FlowFile in a Connection.", - "description" : "", - "operationId" : "downloadFlowFileContent", - "consumes" : [ "*/*" ], - "produces" : [ "*/*" ], - "parameters" : [ { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The connection id.", - "required" : true, - "type" : "string" - }, { - "name" : "flowfile-uuid", - "in" : "path", - "description" : "The flowfile uuid.", - "required" : true, - "type" : "string" - }, { - "name" : "clusterNodeId", - "in" : "query", - "description" : "The id of the node where the content exists if clustered.", - "required" : false, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/StreamingOutput" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read Source Data - /data/{component-type}/{uuid}" : [ ] - } ] - } - }, - "/flowfile-queues/{id}/listing-requests" : { - "post" : { - "tags" : [ "flowfile-queues" ], - "summary" : "Lists the contents of the queue in this connection.", - "description" : "", - "operationId" : "createFlowFileListing", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The connection id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ListingRequestEntity" - } - }, - "202" : { - "description" : "The request has been accepted. A HTTP response header will contain the URI where the response can be polled." - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read Source Data - /data/{component-type}/{uuid}" : [ ] - } ] - } - }, - "/flowfile-queues/{id}/listing-requests/{listing-request-id}" : { - "get" : { - "tags" : [ "flowfile-queues" ], - "summary" : "Gets the current status of a listing request for the specified connection.", - "description" : "", - "operationId" : "getListingRequest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The connection id.", - "required" : true, - "type" : "string" - }, { - "name" : "listing-request-id", - "in" : "path", - "description" : "The listing request id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ListingRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read Source Data - /data/{component-type}/{uuid}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "flowfile-queues" ], - "summary" : "Cancels and/or removes a request to list the contents of this connection.", - "description" : "", - "operationId" : "deleteListingRequest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The connection id.", - "required" : true, - "type" : "string" - }, { - "name" : "listing-request-id", - "in" : "path", - "description" : "The listing request id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ListingRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read Source Data - /data/{component-type}/{uuid}" : [ ] - } ] - } - }, - "/funnels/{id}" : { - "get" : { - "tags" : [ "funnel" ], - "summary" : "Gets a funnel", - "description" : "", - "operationId" : "getFunnel", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The funnel id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/FunnelEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /funnels/{uuid}" : [ ] - } ] - }, - "put" : { - "tags" : [ "funnel" ], - "summary" : "Updates a funnel", - "description" : "", - "operationId" : "updateFunnel", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The funnel id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The funnel configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/FunnelEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/FunnelEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /funnels/{uuid}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "funnel" ], - "summary" : "Deletes a funnel", - "description" : "", - "operationId" : "removeFunnel", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The revision is used to verify the client is working with the latest version of the flow.", - "required" : false, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The funnel id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/FunnelEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /funnels/{uuid}" : [ ] - }, { - "Write - Parent Process Group - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/input-ports/{id}" : { - "get" : { - "tags" : [ "input-ports" ], - "summary" : "Gets an input port", - "description" : "", - "operationId" : "getInputPort", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The input port id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/PortEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /input-ports/{uuid}" : [ ] - } ] - }, - "put" : { - "tags" : [ "input-ports" ], - "summary" : "Updates an input port", - "description" : "", - "operationId" : "updateInputPort", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The input port id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The input port configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/PortEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/PortEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /input-ports/{uuid}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "input-ports" ], - "summary" : "Deletes an input port", - "description" : "", - "operationId" : "removeInputPort", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The revision is used to verify the client is working with the latest version of the flow.", - "required" : false, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The input port id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/PortEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /input-ports/{uuid}" : [ ] - }, { - "Write - Parent Process Group - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/input-ports/{id}/run-status" : { - "put" : { - "tags" : [ "input-ports" ], - "summary" : "Updates run status of an input-port", - "description" : "", - "operationId" : "updateRunStatus", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The port id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The port run status.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/PortRunStatusEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessorEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /input-ports/{uuid} or /operation/input-ports/{uuid}" : [ ] - } ] - } - }, - "/labels/{id}" : { - "get" : { - "tags" : [ "labels" ], - "summary" : "Gets a label", - "description" : "", - "operationId" : "getLabel", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The label id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/LabelEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /labels/{uuid}" : [ ] - } ] - }, - "put" : { - "tags" : [ "labels" ], - "summary" : "Updates a label", - "description" : "", - "operationId" : "updateLabel", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The label id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The label configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/LabelEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/LabelEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /labels/{uuid}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "labels" ], - "summary" : "Deletes a label", - "description" : "", - "operationId" : "removeLabel", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The revision is used to verify the client is working with the latest version of the flow.", - "required" : false, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The label id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/LabelEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /labels/{uuid}" : [ ] - }, { - "Write - Parent Process Group - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/output-ports/{id}" : { - "get" : { - "tags" : [ "output-ports" ], - "summary" : "Gets an output port", - "description" : "", - "operationId" : "getOutputPort", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The output port id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/PortEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /output-ports/{uuid}" : [ ] - } ] - }, - "put" : { - "tags" : [ "output-ports" ], - "summary" : "Updates an output port", - "description" : "", - "operationId" : "updateOutputPort", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The output port id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The output port configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/PortEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/PortEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /output-ports/{uuid}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "output-ports" ], - "summary" : "Deletes an output port", - "description" : "", - "operationId" : "removeOutputPort", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The revision is used to verify the client is working with the latest version of the flow.", - "required" : false, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The output port id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/PortEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /output-ports/{uuid}" : [ ] - }, { - "Write - Parent Process Group - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/output-ports/{id}/run-status" : { - "put" : { - "tags" : [ "output-ports" ], - "summary" : "Updates run status of an output-port", - "description" : "", - "operationId" : "updateRunStatus", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The port id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The port run status.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/PortRunStatusEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessorEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /output-ports/{uuid} or /operation/output-ports/{uuid}" : [ ] - } ] - } - }, - "/policies" : { - "post" : { - "tags" : [ "policies" ], - "summary" : "Creates an access policy", - "description" : "", - "operationId" : "createAccessPolicy", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The access policy configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/AccessPolicyEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/AccessPolicyEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /policies/{resource}" : [ ] - } ] - } - }, - "/policies/{action}/{resource}" : { - "get" : { - "tags" : [ "policies" ], - "summary" : "Gets an access policy for the specified action and resource", - "description" : "Will return the effective policy if no component specific policy exists for the specified action and resource. Must have Read permissions to the policy with the desired action and resource. Permissions for the policy that is returned will be indicated in the response. This means the client could be authorized to get the policy for a given component but the effective policy may be inherited from an ancestor Process Group. If the client does not have permissions to that policy, the response will not include the policy and the permissions in the response will be marked accordingly. If the client does not have permissions to the policy of the desired action and resource a 403 response will be returned.", - "operationId" : "getAccessPolicyForResource", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "action", - "in" : "path", - "description" : "The request action.", - "required" : true, - "type" : "string", - "enum" : [ "read", "write" ] - }, { - "name" : "resource", - "in" : "path", - "description" : "The resource of the policy.", - "required" : true, - "type" : "string", - "pattern" : ".+" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/AccessPolicyEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /policies/{resource}" : [ ] - } ] - } - }, - "/policies/{id}" : { - "get" : { - "tags" : [ "policies" ], - "summary" : "Gets an access policy", - "description" : "", - "operationId" : "getAccessPolicy", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The access policy id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/AccessPolicyEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /policies/{resource}" : [ ] - } ] - }, - "put" : { - "tags" : [ "policies" ], - "summary" : "Updates a access policy", - "description" : "", - "operationId" : "updateAccessPolicy", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The access policy id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The access policy configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/AccessPolicyEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/AccessPolicyEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /policies/{resource}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "policies" ], - "summary" : "Deletes an access policy", - "description" : "", - "operationId" : "removeAccessPolicy", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The revision is used to verify the client is working with the latest version of the flow.", - "required" : false, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The access policy id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/AccessPolicyEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /policies/{resource}" : [ ] - }, { - "Write - Policy of the parent resource - /policies/{resource}" : [ ] - } ] - } - }, - "/process-groups/{groupId}/variable-registry/update-requests/{updateId}" : { - "get" : { - "tags" : [ "process-groups" ], - "summary" : "Gets a process group's variable registry", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getVariableRegistryUpdateRequest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "groupId", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "name" : "updateId", - "in" : "path", - "description" : "The ID of the Variable Registry Update Request", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VariableRegistryUpdateRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "process-groups" ], - "summary" : "Deletes an update request for a process group's variable registry. If the request is not yet complete, it will automatically be cancelled.", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "deleteVariableRegistryUpdateRequest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "groupId", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "name" : "updateId", - "in" : "path", - "description" : "The ID of the Variable Registry Update Request", - "required" : true, - "type" : "string" - }, { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VariableRegistryUpdateRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/process-groups/{id}" : { - "get" : { - "tags" : [ "process-groups" ], - "summary" : "Gets a process group", - "description" : "", - "operationId" : "getProcessGroup", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessGroupEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - } ] - }, - "put" : { - "tags" : [ "process-groups" ], - "summary" : "Updates a process group", - "description" : "", - "operationId" : "updateProcessGroup", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The process group configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ProcessGroupEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessGroupEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "process-groups" ], - "summary" : "Deletes a process group", - "description" : "", - "operationId" : "removeProcessGroup", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The revision is used to verify the client is working with the latest version of the flow.", - "required" : false, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessGroupEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - }, { - "Write - Parent Process Group - /process-groups/{uuid}" : [ ] - }, { - "Read - any referenced Controller Services by any encapsulated components - /controller-services/{uuid}" : [ ] - }, { - "Write - /{component-type}/{uuid} - For all encapsulated components" : [ ] - } ] - } - }, - "/process-groups/{id}/connections" : { - "get" : { - "tags" : [ "process-groups" ], - "summary" : "Gets all connections", - "description" : "", - "operationId" : "getConnections", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ConnectionsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - } ] - }, - "post" : { - "tags" : [ "process-groups" ], - "summary" : "Creates a connection", - "description" : "", - "operationId" : "createConnection", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The connection configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ConnectionEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ConnectionEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - }, { - "Write Source - /{component-type}/{uuid}" : [ ] - }, { - "Write Destination - /{component-type}/{uuid}" : [ ] - } ] - } - }, - "/process-groups/{id}/controller-services" : { - "post" : { - "tags" : [ "process-groups" ], - "summary" : "Creates a new controller service", - "description" : "", - "operationId" : "createControllerService", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The controller service configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ControllerServiceEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ControllerServiceEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - }, { - "Read - any referenced Controller Services - /controller-services/{uuid}" : [ ] - }, { - "Write - if the Controller Service is restricted - /restricted-components" : [ ] - } ] - } - }, - "/process-groups/{id}/funnels" : { - "get" : { - "tags" : [ "process-groups" ], - "summary" : "Gets all funnels", - "description" : "", - "operationId" : "getFunnels", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/FunnelsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - } ] - }, - "post" : { - "tags" : [ "process-groups" ], - "summary" : "Creates a funnel", - "description" : "", - "operationId" : "createFunnel", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The funnel configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/FunnelEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/FunnelEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/process-groups/{id}/input-ports" : { - "get" : { - "tags" : [ "process-groups" ], - "summary" : "Gets all input ports", - "description" : "", - "operationId" : "getInputPorts", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/InputPortsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - } ] - }, - "post" : { - "tags" : [ "process-groups" ], - "summary" : "Creates an input port", - "description" : "", - "operationId" : "createInputPort", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The input port configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/PortEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/PortEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/process-groups/{id}/labels" : { - "get" : { - "tags" : [ "process-groups" ], - "summary" : "Gets all labels", - "description" : "", - "operationId" : "getLabels", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/LabelsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - } ] - }, - "post" : { - "tags" : [ "process-groups" ], - "summary" : "Creates a label", - "description" : "", - "operationId" : "createLabel", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The label configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/LabelEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/LabelEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/process-groups/{id}/local-modifications" : { - "get" : { - "tags" : [ "process-groups" ], - "summary" : "Gets a list of local modifications to the Process Group since it was last synchronized with the Flow Registry", - "description" : "", - "operationId" : "getLocalModifications", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/FlowComparisonEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - }, { - "Read - /{component-type}/{uuid} - For all encapsulated components" : [ ] - } ] - } - }, - "/process-groups/{id}/output-ports" : { - "get" : { - "tags" : [ "process-groups" ], - "summary" : "Gets all output ports", - "description" : "", - "operationId" : "getOutputPorts", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/OutputPortsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - } ] - }, - "post" : { - "tags" : [ "process-groups" ], - "summary" : "Creates an output port", - "description" : "", - "operationId" : "createOutputPort", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The output port configuration.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/PortEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/PortEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/process-groups/{id}/process-groups" : { - "get" : { - "tags" : [ "process-groups" ], - "summary" : "Gets all process groups", - "description" : "", - "operationId" : "getProcessGroups", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessGroupsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - } ] - }, - "post" : { - "tags" : [ "process-groups" ], - "summary" : "Creates a process group", - "description" : "", - "operationId" : "createProcessGroup", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The process group configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ProcessGroupEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessGroupEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/process-groups/{id}/processors" : { - "get" : { - "tags" : [ "process-groups" ], - "summary" : "Gets all processors", - "description" : "", - "operationId" : "getProcessors", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "name" : "includeDescendantGroups", - "in" : "query", - "description" : "Whether or not to include processors from descendant process groups", - "required" : false, - "type" : "boolean", - "default" : false - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessorsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - } ] - }, - "post" : { - "tags" : [ "process-groups" ], - "summary" : "Creates a new processor", - "description" : "", - "operationId" : "createProcessor", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The processor configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ProcessorEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessorEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - }, { - "Read - any referenced Controller Services - /controller-services/{uuid}" : [ ] - }, { - "Write - if the Processor is restricted - /restricted-components" : [ ] - } ] - } - }, - "/process-groups/{id}/remote-process-groups" : { - "get" : { - "tags" : [ "process-groups" ], - "summary" : "Gets all remote process groups", - "description" : "", - "operationId" : "getRemoteProcessGroups", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/RemoteProcessGroupsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - } ] - }, - "post" : { - "tags" : [ "process-groups" ], - "summary" : "Creates a new process group", - "description" : "", - "operationId" : "createRemoteProcessGroup", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The remote process group configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/RemoteProcessGroupEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/RemoteProcessGroupEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/process-groups/{id}/snippet-instance" : { - "post" : { - "tags" : [ "process-groups" ], - "summary" : "Copies a snippet and discards it.", - "description" : "", - "operationId" : "copySnippet", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The copy snippet request.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/CopySnippetRequestEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/FlowEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - }, { - "Read - /{component-type}/{uuid} - For each component in the snippet and their descendant components" : [ ] - }, { - "Write - if the snippet contains any restricted Processors - /restricted-components" : [ ] - } ] - } - }, - "/process-groups/{id}/template-instance" : { - "post" : { - "tags" : [ "process-groups" ], - "summary" : "Instantiates a template", - "description" : "", - "operationId" : "instantiateTemplate", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The instantiate template request.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/InstantiateTemplateRequestEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/FlowEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - }, { - "Read - /templates/{uuid}" : [ ] - }, { - "Write - if the template contains any restricted components - /restricted-components" : [ ] - } ] - } - }, - "/process-groups/{id}/templates" : { - "post" : { - "tags" : [ "process-groups" ], - "summary" : "Creates a template and discards the specified snippet.", - "description" : "", - "operationId" : "createTemplate", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The create template request.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/CreateTemplateRequestEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/TemplateEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - }, { - "Read - /{component-type}/{uuid} - For each component in the snippet and their descendant components" : [ ] - } ] - } - }, - "/process-groups/{id}/templates/import" : { - "post" : { - "tags" : [ "process-groups" ], - "summary" : "Imports a template", - "description" : "", - "operationId" : "importTemplate", - "consumes" : [ "application/xml" ], - "produces" : [ "application/xml" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/TemplateEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/process-groups/{id}/templates/upload" : { - "post" : { - "tags" : [ "process-groups" ], - "summary" : "Uploads a template", - "description" : "", - "operationId" : "uploadTemplate", - "consumes" : [ "multipart/form-data" ], - "produces" : [ "application/xml" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "schema" : { - "type" : "boolean" - } - }, { - "name" : "template", - "in" : "formData", - "description" : "The binary content of the template file being uploaded.", - "required" : true, - "type" : "file" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/TemplateEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/process-groups/{id}/variable-registry" : { - "get" : { - "tags" : [ "process-groups" ], - "summary" : "Gets a process group's variable registry", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getVariableRegistry", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "name" : "includeAncestorGroups", - "in" : "query", - "description" : "Whether or not to include ancestor groups", - "required" : false, - "type" : "boolean", - "default" : true - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VariableRegistryEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - } ] - }, - "put" : { - "tags" : [ "process-groups" ], - "summary" : "Updates the contents of a Process Group's variable Registry", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "updateVariableRegistry", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The variable registry configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/VariableRegistryEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VariableRegistryEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/process-groups/{id}/variable-registry/update-requests" : { - "post" : { - "tags" : [ "process-groups" ], - "summary" : "Submits a request to update a process group's variable registry", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "submitUpdateVariableRegistryRequest", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The variable registry configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/VariableRegistryEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VariableRegistryUpdateRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/processors/{id}" : { - "get" : { - "tags" : [ "processors" ], - "summary" : "Gets a processor", - "description" : "", - "operationId" : "getProcessor", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The processor id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessorEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /processors/{uuid}" : [ ] - } ] - }, - "put" : { - "tags" : [ "processors" ], - "summary" : "Updates a processor", - "description" : "", - "operationId" : "updateProcessor", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The processor id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The processor configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ProcessorEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessorEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /processors/{uuid}" : [ ] - }, { - "Read - any referenced Controller Services if this request changes the reference - /controller-services/{uuid}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "processors" ], - "summary" : "Deletes a processor", - "description" : "", - "operationId" : "deleteProcessor", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The revision is used to verify the client is working with the latest version of the flow.", - "required" : false, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The processor id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessorEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /processors/{uuid}" : [ ] - }, { - "Write - Parent Process Group - /process-groups/{uuid}" : [ ] - }, { - "Read - any referenced Controller Services - /controller-services/{uuid}" : [ ] - } ] - } - }, - "/processors/{id}/descriptors" : { - "get" : { - "tags" : [ "processors" ], - "summary" : "Gets the descriptor for a processor property", - "description" : "", - "operationId" : "getPropertyDescriptor", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The processor id.", - "required" : true, - "type" : "string" - }, { - "name" : "propertyName", - "in" : "query", - "description" : "The property name.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/PropertyDescriptorEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /processors/{uuid}" : [ ] - } ] - } - }, - "/processors/{id}/diagnostics" : { - "get" : { - "tags" : [ "processors" ], - "summary" : "Gets diagnostics information about a processor", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getProcessorDiagnostics", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The processor id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessorEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /processors/{uuid}" : [ ] - } ] - } - }, - "/processors/{id}/run-status" : { - "put" : { - "tags" : [ "processors" ], - "summary" : "Updates run status of a processor", - "description" : "", - "operationId" : "updateRunStatus", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The processor id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The processor run status.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ProcessorRunStatusEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessorEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /processors/{uuid} or /operation/processors/{uuid}" : [ ] - } ] - } - }, - "/processors/{id}/state" : { - "get" : { - "tags" : [ "processors" ], - "summary" : "Gets the state for a processor", - "description" : "", - "operationId" : "getState", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The processor id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ComponentStateEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /processors/{uuid}" : [ ] - } ] - } - }, - "/processors/{id}/state/clear-requests" : { - "post" : { - "tags" : [ "processors" ], - "summary" : "Clears the state for a processor", - "description" : "", - "operationId" : "clearState", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The processor id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ComponentStateEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /processors/{uuid}" : [ ] - } ] - } - }, - "/processors/{id}/threads" : { - "delete" : { - "tags" : [ "processors" ], - "summary" : "Terminates a processor, essentially \"deleting\" its threads and any active tasks", - "description" : "", - "operationId" : "terminateProcessor", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The processor id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessorEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /processors/{uuid} or /operation/processors/{uuid}" : [ ] - } ] - } - }, - "/provenance" : { - "post" : { - "tags" : [ "provenance" ], - "summary" : "Submits a provenance query", - "description" : "Provenance queries may be long running so this endpoint submits a request. The response will include the current state of the query. If the request is not completed the URI in the response can be used at a later time to get the updated state of the query. Once the query has completed the provenance request should be deleted by the client who originally submitted it.", - "operationId" : "submitProvenanceRequest", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The provenance query details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ProvenanceEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProvenanceEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /provenance" : [ ] - }, { - "Read - /data/{component-type}/{uuid}" : [ ] - } ] - } - }, - "/provenance-events/replays" : { - "post" : { - "tags" : [ "provenance-events" ], - "summary" : "Replays content from a provenance event", - "description" : "", - "operationId" : "submitReplay", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The replay request.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/SubmitReplayRequestEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProvenanceEventEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read Component Provenance Data - /provenance-data/{component-type}/{uuid}" : [ ] - }, { - "Read Component Data - /data/{component-type}/{uuid}" : [ ] - }, { - "Write Component Data - /data/{component-type}/{uuid}" : [ ] - } ] - } - }, - "/provenance-events/{id}" : { - "get" : { - "tags" : [ "provenance-events" ], - "summary" : "Gets a provenance event", - "description" : "", - "operationId" : "getProvenanceEvent", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "clusterNodeId", - "in" : "query", - "description" : "The id of the node where this event exists if clustered.", - "required" : false, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The provenance event id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProvenanceEventEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read Component Provenance Data - /provenance-data/{component-type}/{uuid}" : [ ] - } ] - } - }, - "/provenance-events/{id}/content/input" : { - "get" : { - "tags" : [ "provenance-events" ], - "summary" : "Gets the input content for a provenance event", - "description" : "", - "operationId" : "getInputContent", - "consumes" : [ "*/*" ], - "produces" : [ "*/*" ], - "parameters" : [ { - "name" : "clusterNodeId", - "in" : "query", - "description" : "The id of the node where the content exists if clustered.", - "required" : false, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The provenance event id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/StreamingOutput" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read Component Provenance Data - /provenance-data/{component-type}/{uuid}" : [ ] - }, { - "Read Component Data - /data/{component-type}/{uuid}" : [ ] - } ] - } - }, - "/provenance-events/{id}/content/output" : { - "get" : { - "tags" : [ "provenance-events" ], - "summary" : "Gets the output content for a provenance event", - "description" : "", - "operationId" : "getOutputContent", - "consumes" : [ "*/*" ], - "produces" : [ "*/*" ], - "parameters" : [ { - "name" : "clusterNodeId", - "in" : "query", - "description" : "The id of the node where the content exists if clustered.", - "required" : false, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The provenance event id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/StreamingOutput" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read Component Provenance Data - /provenance-data/{component-type}/{uuid}" : [ ] - }, { - "Read Component Data - /data/{component-type}/{uuid}" : [ ] - } ] - } - }, - "/provenance/lineage" : { - "post" : { - "tags" : [ "provenance" ], - "summary" : "Submits a lineage query", - "description" : "Lineage queries may be long running so this endpoint submits a request. The response will include the current state of the query. If the request is not completed the URI in the response can be used at a later time to get the updated state of the query. Once the query has completed the lineage request should be deleted by the client who originally submitted it.", - "operationId" : "submitLineageRequest", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The lineage query details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/LineageEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/LineageEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /provenance" : [ ] - }, { - "Read - /data/{component-type}/{uuid}" : [ ] - } ] - } - }, - "/provenance/lineage/{id}" : { - "get" : { - "tags" : [ "provenance" ], - "summary" : "Gets a lineage query", - "description" : "", - "operationId" : "getLineage", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "clusterNodeId", - "in" : "query", - "description" : "The id of the node where this query exists if clustered.", - "required" : false, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The id of the lineage query.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/LineageEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /provenance" : [ ] - }, { - "Read - /data/{component-type}/{uuid}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "provenance" ], - "summary" : "Deletes a lineage query", - "description" : "", - "operationId" : "deleteLineage", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "clusterNodeId", - "in" : "query", - "description" : "The id of the node where this query exists if clustered.", - "required" : false, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The id of the lineage query.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/LineageEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /provenance" : [ ] - } ] - } - }, - "/provenance/search-options" : { - "get" : { - "tags" : [ "provenance" ], - "summary" : "Gets the searchable attributes for provenance events", - "description" : "", - "operationId" : "getSearchOptions", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProvenanceOptionsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /provenance" : [ ] - } ] - } - }, - "/provenance/{id}" : { - "get" : { - "tags" : [ "provenance" ], - "summary" : "Gets a provenance query", - "description" : "", - "operationId" : "getProvenance", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "clusterNodeId", - "in" : "query", - "description" : "The id of the node where this query exists if clustered.", - "required" : false, - "type" : "string" - }, { - "name" : "summarize", - "in" : "query", - "description" : "Whether or not incremental results are returned. If false, provenance events are only returned once the query completes. This property is true by default.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "incrementalResults", - "in" : "query", - "description" : "Whether or not to summarize provenance events returned. This property is false by default.", - "required" : false, - "type" : "boolean", - "default" : true - }, { - "name" : "id", - "in" : "path", - "description" : "The id of the provenance query.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProvenanceEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /provenance" : [ ] - }, { - "Read - /data/{component-type}/{uuid}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "provenance" ], - "summary" : "Deletes a provenance query", - "description" : "", - "operationId" : "deleteProvenance", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "clusterNodeId", - "in" : "query", - "description" : "The id of the node where this query exists if clustered.", - "required" : false, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The id of the provenance query.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProvenanceEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /provenance" : [ ] - } ] - } - }, - "/remote-process-groups/{id}" : { - "get" : { - "tags" : [ "remote-process-groups" ], - "summary" : "Gets a remote process group", - "description" : "", - "operationId" : "getRemoteProcessGroup", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The remote process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/RemoteProcessGroupEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /remote-process-groups/{uuid}" : [ ] - } ] - }, - "put" : { - "tags" : [ "remote-process-groups" ], - "summary" : "Updates a remote process group", - "description" : "", - "operationId" : "updateRemoteProcessGroup", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The remote process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The remote process group.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/RemoteProcessGroupEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/RemoteProcessGroupEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /remote-process-groups/{uuid}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "remote-process-groups" ], - "summary" : "Deletes a remote process group", - "description" : "", - "operationId" : "removeRemoteProcessGroup", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The revision is used to verify the client is working with the latest version of the flow.", - "required" : false, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The remote process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/RemoteProcessGroupEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /remote-process-groups/{uuid}" : [ ] - }, { - "Write - Parent Process Group - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/remote-process-groups/{id}/input-ports/{port-id}" : { - "put" : { - "tags" : [ "remote-process-groups" ], - "summary" : "Updates a remote port", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "updateRemoteProcessGroupInputPort", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The remote process group id.", - "required" : true, - "type" : "string" - }, { - "name" : "port-id", - "in" : "path", - "description" : "The remote process group port id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The remote process group port.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/RemoteProcessGroupPortEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/RemoteProcessGroupPortEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /remote-process-groups/{uuid}" : [ ] - } ] - } - }, - "/remote-process-groups/{id}/input-ports/{port-id}/run-status" : { - "put" : { - "tags" : [ "remote-process-groups" ], - "summary" : "Updates run status of a remote port", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "updateRemoteProcessGroupInputPortRunStatus", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The remote process group id.", - "required" : true, - "type" : "string" - }, { - "name" : "port-id", - "in" : "path", - "description" : "The remote process group port id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The remote process group port.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/RemotePortRunStatusEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/RemoteProcessGroupPortEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /remote-process-groups/{uuid} or /operation/remote-process-groups/{uuid}" : [ ] - } ] - } - }, - "/remote-process-groups/{id}/output-ports/{port-id}" : { - "put" : { - "tags" : [ "remote-process-groups" ], - "summary" : "Updates a remote port", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "updateRemoteProcessGroupOutputPort", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The remote process group id.", - "required" : true, - "type" : "string" - }, { - "name" : "port-id", - "in" : "path", - "description" : "The remote process group port id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The remote process group port.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/RemoteProcessGroupPortEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/RemoteProcessGroupPortEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /remote-process-groups/{uuid}" : [ ] - } ] - } - }, - "/remote-process-groups/{id}/output-ports/{port-id}/run-status" : { - "put" : { - "tags" : [ "remote-process-groups" ], - "summary" : "Updates run status of a remote port", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "updateRemoteProcessGroupOutputPortRunStatus", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The remote process group id.", - "required" : true, - "type" : "string" - }, { - "name" : "port-id", - "in" : "path", - "description" : "The remote process group port id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The remote process group port.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/RemotePortRunStatusEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/RemoteProcessGroupPortEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /remote-process-groups/{uuid} or /operation/remote-process-groups/{uuid}" : [ ] - } ] - } - }, - "/remote-process-groups/{id}/run-status" : { - "put" : { - "tags" : [ "remote-process-groups" ], - "summary" : "Updates run status of a remote process group", - "description" : "", - "operationId" : "updateRemoteProcessGroupRunStatus", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The remote process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The remote process group run status.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/RemotePortRunStatusEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/RemoteProcessGroupEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /remote-process-groups/{uuid} or /operation/remote-process-groups/{uuid}" : [ ] - } ] - } - }, - "/reporting-tasks/{id}" : { - "get" : { - "tags" : [ "reporting-tasks" ], - "summary" : "Gets a reporting task", - "description" : "", - "operationId" : "getReportingTask", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The reporting task id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ReportingTaskEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /reporting-tasks/{uuid}" : [ ] - } ] - }, - "put" : { - "tags" : [ "reporting-tasks" ], - "summary" : "Updates a reporting task", - "description" : "", - "operationId" : "updateReportingTask", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The reporting task id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The reporting task configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ReportingTaskEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ReportingTaskEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /reporting-tasks/{uuid}" : [ ] - }, { - "Read - any referenced Controller Services if this request changes the reference - /controller-services/{uuid}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "reporting-tasks" ], - "summary" : "Deletes a reporting task", - "description" : "", - "operationId" : "removeReportingTask", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The revision is used to verify the client is working with the latest version of the flow.", - "required" : false, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The reporting task id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ReportingTaskEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /reporting-tasks/{uuid}" : [ ] - }, { - "Write - /controller" : [ ] - }, { - "Read - any referenced Controller Services - /controller-services/{uuid}" : [ ] - } ] - } - }, - "/reporting-tasks/{id}/descriptors" : { - "get" : { - "tags" : [ "reporting-tasks" ], - "summary" : "Gets a reporting task property descriptor", - "description" : "", - "operationId" : "getPropertyDescriptor", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The reporting task id.", - "required" : true, - "type" : "string" - }, { - "name" : "propertyName", - "in" : "query", - "description" : "The property name.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/PropertyDescriptorEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /reporting-tasks/{uuid}" : [ ] - } ] - } - }, - "/reporting-tasks/{id}/run-status" : { - "put" : { - "tags" : [ "reporting-tasks" ], - "summary" : "Updates run status of a reporting task", - "description" : "", - "operationId" : "updateRunStatus", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The reporting task id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The reporting task run status.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/ReportingTaskRunStatusEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ReportingTaskEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /reporting-tasks/{uuid} or or /operation/reporting-tasks/{uuid}" : [ ] - } ] - } - }, - "/reporting-tasks/{id}/state" : { - "get" : { - "tags" : [ "reporting-tasks" ], - "summary" : "Gets the state for a reporting task", - "description" : "", - "operationId" : "getState", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The reporting task id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ComponentStateEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /reporting-tasks/{uuid}" : [ ] - } ] - } - }, - "/reporting-tasks/{id}/state/clear-requests" : { - "post" : { - "tags" : [ "reporting-tasks" ], - "summary" : "Clears the state for a reporting task", - "description" : "", - "operationId" : "clearState", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The reporting task id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ComponentStateEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /reporting-tasks/{uuid}" : [ ] - } ] - } - }, - "/resources" : { - "get" : { - "tags" : [ "resources" ], - "summary" : "Gets the available resources that support access/authorization policies", - "description" : "", - "operationId" : "getResources", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ResourcesEntity" - } - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - } - }, - "security" : [ { - "Read - /resources" : [ ] - } ] - } - }, - "/site-to-site" : { - "get" : { - "tags" : [ "site-to-site" ], - "summary" : "Returns the details about this NiFi necessary to communicate via site to site", - "description" : "", - "operationId" : "getSiteToSiteDetails", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ControllerEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /site-to-site" : [ ] - } ] - } - }, - "/site-to-site/peers" : { - "get" : { - "tags" : [ "site-to-site" ], - "summary" : "Returns the available Peers and its status of this NiFi", - "description" : "", - "operationId" : "getPeers", - "consumes" : [ "*/*" ], - "produces" : [ "application/json", "application/xml" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/PeersEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /site-to-site" : [ ] - } ] - } - }, - "/snippets" : { - "post" : { - "tags" : [ "snippets" ], - "summary" : "Creates a snippet. The snippet will be automatically discarded if not used in a subsequent request after 1 minute.", - "description" : "", - "operationId" : "createSnippet", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The snippet configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/SnippetEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/SnippetEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read or Write - /{component-type}/{uuid} - For every component (all Read or all Write) in the Snippet and their descendant components" : [ ] - } ] - } - }, - "/snippets/{id}" : { - "put" : { - "tags" : [ "snippets" ], - "summary" : "Move's the components in this Snippet into a new Process Group and discards the snippet", - "description" : "", - "operationId" : "updateSnippet", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The snippet id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The snippet configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/SnippetEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/SnippetEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write Process Group - /process-groups/{uuid}" : [ ] - }, { - "Write - /{component-type}/{uuid} - For each component in the Snippet and their descendant components" : [ ] - } ] - }, - "delete" : { - "tags" : [ "snippets" ], - "summary" : "Deletes the components in a snippet and discards the snippet", - "description" : "", - "operationId" : "deleteSnippet", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The snippet id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/SnippetEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /{component-type}/{uuid} - For each component in the Snippet and their descendant components" : [ ] - }, { - "Write - Parent Process Group - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/system-diagnostics" : { - "get" : { - "tags" : [ "system-diagnostics" ], - "summary" : "Gets the diagnostics for the system NiFi is running on", - "description" : "", - "operationId" : "getSystemDiagnostics", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "nodewise", - "in" : "query", - "description" : "Whether or not to include the breakdown per node. Optional, defaults to false", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "clusterNodeId", - "in" : "query", - "description" : "The id of the node where to get the status.", - "required" : false, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/SystemDiagnosticsEntity" - } - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - } - }, - "security" : [ { - "Read - /system" : [ ] - } ] - } - }, - "/templates/{id}" : { - "delete" : { - "tags" : [ "templates" ], - "summary" : "Deletes a template", - "description" : "", - "operationId" : "removeTemplate", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The template id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/TemplateEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /templates/{uuid}" : [ ] - }, { - "Write - Parent Process Group - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/templates/{id}/download" : { - "get" : { - "tags" : [ "templates" ], - "summary" : "Exports a template", - "description" : "", - "operationId" : "exportTemplate", - "consumes" : [ "*/*" ], - "produces" : [ "application/xml" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The template id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /templates/{uuid}" : [ ] - } ] - } - }, - "/tenants/search-results" : { - "get" : { - "tags" : [ "tenants" ], - "summary" : "Searches for a tenant with the specified identity", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "searchTenants", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "q", - "in" : "query", - "description" : "Identity to search for.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/TenantsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /tenants" : [ ] - } ] - } - }, - "/tenants/user-groups" : { - "get" : { - "tags" : [ "tenants" ], - "summary" : "Gets all user groups", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getUserGroups", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/UserGroupsEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /tenants" : [ ] - } ] - }, - "post" : { - "tags" : [ "tenants" ], - "summary" : "Creates a user group", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "createUserGroup", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The user group configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/UserGroupEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/UserGroupEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /tenants" : [ ] - } ] - } - }, - "/tenants/user-groups/{id}" : { - "get" : { - "tags" : [ "tenants" ], - "summary" : "Gets a user group", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getUserGroup", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The user group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/UserGroupEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /tenants" : [ ] - } ] - }, - "put" : { - "tags" : [ "tenants" ], - "summary" : "Updates a user group", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "updateUserGroup", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The user group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The user group configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/UserGroupEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/UserGroupEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /tenants" : [ ] - } ] - }, - "delete" : { - "tags" : [ "tenants" ], - "summary" : "Deletes a user group", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "removeUserGroup", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The revision is used to verify the client is working with the latest version of the flow.", - "required" : false, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The user group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/UserGroupEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /tenants" : [ ] - } ] - } - }, - "/tenants/users" : { - "get" : { - "tags" : [ "tenants" ], - "summary" : "Gets all users", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getUsers", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/UsersEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /tenants" : [ ] - } ] - }, - "post" : { - "tags" : [ "tenants" ], - "summary" : "Creates a user", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "createUser", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The user configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/UserEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/UserEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /tenants" : [ ] - } ] - } - }, - "/tenants/users/{id}" : { - "get" : { - "tags" : [ "tenants" ], - "summary" : "Gets a user", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getUser", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The user id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/UserEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /tenants" : [ ] - } ] - }, - "put" : { - "tags" : [ "tenants" ], - "summary" : "Updates a user", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "updateUser", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The user id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The user configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/UserEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/UserEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /tenants" : [ ] - } ] - }, - "delete" : { - "tags" : [ "tenants" ], - "summary" : "Deletes a user", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "removeUser", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The revision is used to verify the client is working with the latest version of the flow.", - "required" : false, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The user id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/UserEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /tenants" : [ ] - } ] - } - }, - "/versions/active-requests" : { - "post" : { - "tags" : [ "versions" ], - "summary" : "Create a version control request", - "description" : "Creates a request so that a Process Group can be placed under Version Control or have its Version Control configuration changed. Creating this request will prevent any other threads from simultaneously saving local changes to Version Control. It will not, however, actually save the local flow to the Flow Registry. A POST to /versions/process-groups/{id} should be used to initiate saving of the local flow to the Flow Registry. Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "createVersionControlRequest", - "consumes" : [ "application/json" ], - "produces" : [ "text/plain" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The versioned flow details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/CreateActiveRequestEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Write - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/versions/active-requests/{id}" : { - "put" : { - "tags" : [ "versions" ], - "summary" : "Updates the request with the given ID", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "updateVersionControlRequest", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The request ID.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The version control component mapping.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/VersionControlComponentMappingEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionControlInformationEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Only the user that submitted the request can update it" : [ ] - } ] - }, - "delete" : { - "tags" : [ "versions" ], - "summary" : "Deletes the version control request with the given ID", - "description" : "Deletes the Version Control Request with the given ID. This will allow other threads to save flows to the Flow Registry. See also the documentation for POSTing to /versions/active-requests for information regarding why this is done. Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "deleteVersionControlRequest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The request ID.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Only the user that submitted the request can remove it" : [ ] - } ] - } - }, - "/versions/process-groups/{id}" : { - "get" : { - "tags" : [ "versions" ], - "summary" : "Gets the Version Control information for a process group", - "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getVersionInformation", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionControlInformationEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - } ] - }, - "post" : { - "tags" : [ "versions" ], - "summary" : "Save the Process Group with the given ID", - "description" : "Begins version controlling the Process Group with the given ID or commits changes to the Versioned Flow, depending on if the provided VersionControlInformation includes a flowId. Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "saveToFlowRegistry", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The versioned flow details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/StartVersionControlRequestEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionControlInformationEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - }, { - "Write - /process-groups/{uuid}" : [ ] - }, { - "Read - /{component-type}/{uuid} - For all encapsulated components" : [ ] - }, { - "Read - any referenced Controller Services by any encapsulated components - /controller-services/{uuid}" : [ ] - } ] - }, - "put" : { - "tags" : [ "versions" ], - "summary" : "Update the version of a Process Group with the given ID", - "description" : "For a Process Group that is already under Version Control, this will update the version of the flow to a different version. This endpoint expects that the given snapshot will not modify any Processor that is currently running or any Controller Service that is enabled. Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "updateFlowVersion", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The controller service configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/VersionedFlowSnapshotEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionControlInformationEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - }, { - "Write - /process-groups/{uuid}" : [ ] - } ] - }, - "delete" : { - "tags" : [ "versions" ], - "summary" : "Stops version controlling the Process Group with the given ID", - "description" : "Stops version controlling the Process Group with the given ID. The Process Group will no longer track to any Versioned Flow. Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "stopVersionControl", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The version is used to verify the client is working with the latest version of the flow.", - "required" : false, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, a new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionControlInformationEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - }, { - "Write - /process-groups/{uuid}" : [ ] - } ] - } - }, - "/versions/revert-requests/process-groups/{id}" : { - "post" : { - "tags" : [ "versions" ], - "summary" : "Initiate the Revert Request of a Process Group with the given ID", - "description" : "For a Process Group that is already under Version Control, this will initiate the action of reverting any local changes that have been made to the Process Group since it was last synchronized with the Flow Registry. This will result in the flow matching the Versioned Flow that exists in the Flow Registry. This can be a lengthy process, as it will stop any Processors and disable any Controller Services necessary to perform the action and then restart them. As a result, the endpoint will immediately return a VersionedFlowUpdateRequestEntity, and the process of updating the flow will occur asynchronously in the background. The client may then periodically poll the status of the request by issuing a GET request to /versions/revert-requests/{requestId}. Once the request is completed, the client is expected to issue a DELETE request to /versions/revert-requests/{requestId}. Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "initiateRevertFlowVersion", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The controller service configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/VersionControlInformationEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlowUpdateRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - }, { - "Write - /process-groups/{uuid}" : [ ] - }, { - "Read - /{component-type}/{uuid} - For all encapsulated components" : [ ] - }, { - "Write - /{component-type}/{uuid} - For all encapsulated components" : [ ] - }, { - "Write - if the template contains any restricted components - /restricted-components" : [ ] - } ] - } - }, - "/versions/revert-requests/{id}" : { - "get" : { - "tags" : [ "versions" ], - "summary" : "Returns the Revert Request with the given ID", - "description" : "Returns the Revert Request with the given ID. Once a Revert Request has been created by performing a POST to /versions/revert-requests/process-groups/{id}, that request can subsequently be retrieved via this endpoint, and the request that is fetched will contain the updated state, such as percent complete, the current state of the request, and any failures. Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getRevertRequest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The ID of the Revert Request", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlowUpdateRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Only the user that submitted the request can get it" : [ ] - } ] - }, - "delete" : { - "tags" : [ "versions" ], - "summary" : "Deletes the Revert Request with the given ID", - "description" : "Deletes the Revert Request with the given ID. After a request is created via a POST to /versions/revert-requests/process-groups/{id}, it is expected that the client will properly clean up the request by DELETE'ing it, once the Revert process has completed. If the request is deleted before the request completes, then the Revert request will finish the step that it is currently performing and then will cancel any subsequent steps. Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "deleteRevertRequest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The ID of the Revert Request", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlowUpdateRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Only the user that submitted the request can remove it" : [ ] - } ] - } - }, - "/versions/update-requests/process-groups/{id}" : { - "post" : { - "tags" : [ "versions" ], - "summary" : "Initiate the Update Request of a Process Group with the given ID", - "description" : "For a Process Group that is already under Version Control, this will initiate the action of changing from a specific version of the flow in the Flow Registry to a different version of the flow. This can be a lengthy process, as it will stop any Processors and disable any Controller Services necessary to perform the action and then restart them. As a result, the endpoint will immediately return a VersionedFlowUpdateRequestEntity, and the process of updating the flow will occur asynchronously in the background. The client may then periodically poll the status of the request by issuing a GET request to /versions/update-requests/{requestId}. Once the request is completed, the client is expected to issue a DELETE request to /versions/update-requests/{requestId}. Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "initiateVersionControlUpdate", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The process group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The controller service configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/VersionControlInformationEntity" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlowUpdateRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Read - /process-groups/{uuid}" : [ ] - }, { - "Write - /process-groups/{uuid}" : [ ] - }, { - "Read - /{component-type}/{uuid} - For all encapsulated components" : [ ] - }, { - "Write - /{component-type}/{uuid} - For all encapsulated components" : [ ] - }, { - "Write - if the template contains any restricted components - /restricted-components" : [ ] - } ] - } - }, - "/versions/update-requests/{id}" : { - "get" : { - "tags" : [ "versions" ], - "summary" : "Returns the Update Request with the given ID", - "description" : "Returns the Update Request with the given ID. Once an Update Request has been created by performing a POST to /versions/update-requests/process-groups/{id}, that request can subsequently be retrieved via this endpoint, and the request that is fetched will contain the updated state, such as percent complete, the current state of the request, and any failures. Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "getUpdateRequest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The ID of the Update Request", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlowUpdateRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Only the user that submitted the request can get it" : [ ] - } ] - }, - "delete" : { - "tags" : [ "versions" ], - "summary" : "Deletes the Update Request with the given ID", - "description" : "Deletes the Update Request with the given ID. After a request is created via a POST to /versions/update-requests/process-groups/{id}, it is expected that the client will properly clean up the request by DELETE'ing it, once the Update process has completed. If the request is deleted before the request completes, then the Update request will finish the step that it is currently performing and then will cancel any subsequent steps. Note: This endpoint is subject to change as NiFi and it's REST API evolve.", - "operationId" : "deleteUpdateRequest", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "disconnectedNodeAcknowledged", - "in" : "query", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", - "required" : false, - "type" : "boolean", - "default" : false - }, { - "name" : "id", - "in" : "path", - "description" : "The ID of the Update Request", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlowUpdateRequestEntity" - } - }, - "400" : { - "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." - } - }, - "security" : [ { - "Only the user that submitted the request can remove it" : [ ] - } ] - } - } - }, - "definitions" : { - "AboutDTO" : { - "type" : "object", - "properties" : { - "title" : { - "type" : "string", - "description" : "The title to be used on the page and in the about dialog." - }, - "version" : { - "type" : "string", - "description" : "The version of this NiFi." - }, - "uri" : { - "type" : "string", - "description" : "The URI for the NiFi." - }, - "contentViewerUrl" : { - "type" : "string", - "description" : "The URL for the content viewer if configured." - }, - "timezone" : { - "type" : "string", - "description" : "The timezone of the NiFi instance.", - "readOnly" : true - }, - "buildTag" : { - "type" : "string", - "description" : "Build tag" - }, - "buildRevision" : { - "type" : "string", - "description" : "Build revision or commit hash" - }, - "buildBranch" : { - "type" : "string", - "description" : "Build branch" - }, - "buildTimestamp" : { - "type" : "string", - "description" : "Build timestamp" - } - } - }, - "AboutEntity" : { - "type" : "object", - "properties" : { - "about" : { - "$ref" : "#/definitions/AboutDTO" - } - }, - "xml" : { - "name" : "aboutEntity" - } - }, - "AccessConfigurationDTO" : { - "type" : "object", - "properties" : { - "supportsLogin" : { - "type" : "boolean", - "description" : "Indicates whether or not this NiFi supports user login.", - "readOnly" : true - } - } - }, - "AccessConfigurationEntity" : { - "type" : "object", - "properties" : { - "config" : { - "$ref" : "#/definitions/AccessConfigurationDTO" - } - }, - "xml" : { - "name" : "accessConfigurationEntity" - } - }, - "AccessPolicyDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "versionedComponentId" : { - "type" : "string", - "description" : "The ID of the corresponding component that is under version control" - }, - "parentGroupId" : { - "type" : "string", - "description" : "The id of parent process group of this component if applicable." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "resource" : { - "type" : "string", - "description" : "The resource for this access policy." - }, - "action" : { - "type" : "string", - "description" : "The action associated with this access policy.", - "enum" : [ "read", "write" ] - }, - "componentReference" : { - "description" : "Component this policy references if applicable.", - "$ref" : "#/definitions/ComponentReferenceEntity" - }, - "configurable" : { - "type" : "boolean", - "description" : "Whether this policy is configurable." - }, - "users" : { - "type" : "array", - "description" : "The set of user IDs associated with this access policy.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/TenantEntity" - } - }, - "userGroups" : { - "type" : "array", - "description" : "The set of user group IDs associated with this access policy.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/TenantEntity" - } - } - } - }, - "AccessPolicyEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "generated" : { - "type" : "string", - "description" : "When this content was generated." - }, - "component" : { - "$ref" : "#/definitions/AccessPolicyDTO" - } - }, - "xml" : { - "name" : "accessPolicyEntity" - } - }, - "AccessPolicySummaryDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "versionedComponentId" : { - "type" : "string", - "description" : "The ID of the corresponding component that is under version control" - }, - "parentGroupId" : { - "type" : "string", - "description" : "The id of parent process group of this component if applicable." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "resource" : { - "type" : "string", - "description" : "The resource for this access policy." - }, - "action" : { - "type" : "string", - "description" : "The action associated with this access policy.", - "enum" : [ "read", "write" ] - }, - "componentReference" : { - "description" : "Component this policy references if applicable.", - "$ref" : "#/definitions/ComponentReferenceEntity" - }, - "configurable" : { - "type" : "boolean", - "description" : "Whether this policy is configurable." - } - } - }, - "AccessPolicySummaryEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "component" : { - "$ref" : "#/definitions/AccessPolicySummaryDTO" - } - }, - "xml" : { - "name" : "accessPolicySummaryEntity" - } - }, - "AccessStatusDTO" : { - "type" : "object", - "properties" : { - "identity" : { - "type" : "string", - "description" : "The user identity.", - "readOnly" : true - }, - "status" : { - "type" : "string", - "description" : "The user access status.", - "readOnly" : true - }, - "message" : { - "type" : "string", - "description" : "Additional details about the user access status.", - "readOnly" : true - } - }, - "xml" : { - "name" : "accessStatus" - } - }, - "AccessStatusEntity" : { - "type" : "object", - "properties" : { - "accessStatus" : { - "$ref" : "#/definitions/AccessStatusDTO" - } - }, - "xml" : { - "name" : "accessStatusEntity" - } - }, - "ActionDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "integer", - "format" : "int32", - "description" : "The action id." - }, - "userIdentity" : { - "type" : "string", - "description" : "The identity of the user that performed the action." - }, - "timestamp" : { - "type" : "string", - "description" : "The timestamp of the action." - }, - "sourceId" : { - "type" : "string", - "description" : "The id of the source component." - }, - "sourceName" : { - "type" : "string", - "description" : "The name of the source component." - }, - "sourceType" : { - "type" : "string", - "description" : "The type of the source component." - }, - "componentDetails" : { - "description" : "The details of the source component.", - "$ref" : "#/definitions/ComponentDetailsDTO" - }, - "operation" : { - "type" : "string", - "description" : "The operation that was performed." - }, - "actionDetails" : { - "description" : "The details of the action.", - "$ref" : "#/definitions/ActionDetailsDTO" - } - } - }, - "ActionDetailsDTO" : { - "type" : "object" - }, - "ActionEntity" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "integer", - "format" : "int32" - }, - "timestamp" : { - "type" : "string", - "description" : "The timestamp of the action." - }, - "sourceId" : { - "type" : "string" - }, - "canRead" : { - "type" : "boolean", - "description" : "Indicates whether the user can read a given resource.", - "readOnly" : true - }, - "action" : { - "$ref" : "#/definitions/ActionDTO" - } - }, - "xml" : { - "name" : "actionEntity" - } - }, - "ActivateControllerServicesEntity" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the ProcessGroup" - }, - "state" : { - "type" : "string", - "description" : "The desired state of the descendant components", - "enum" : [ "ENABLED", "DISABLED" ] - }, - "components" : { - "type" : "object", - "description" : "Optional services to schedule. If not specified, all authorized descendant controller services will be used.", - "additionalProperties" : { - "$ref" : "#/definitions/RevisionDTO" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - } - }, - "xml" : { - "name" : "activateControllerServicesEntity" - } - }, - "AffectedComponentDTO" : { - "type" : "object", - "properties" : { - "processGroupId" : { - "type" : "string", - "description" : "The UUID of the Process Group that this component is in" - }, - "id" : { - "type" : "string", - "description" : "The UUID of this component" - }, - "referenceType" : { - "type" : "string", - "description" : "The type of this component", - "enum" : [ "PROCESSOR", "CONTROLLER_SERVICE", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT" ] - }, - "name" : { - "type" : "string", - "description" : "The name of this component." - }, - "state" : { - "type" : "string", - "description" : "The scheduled state of a processor or reporting task referencing a controller service. If this component is another controller service, this field represents the controller service state." - }, - "activeThreadCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of active threads for the referencing component." - }, - "validationErrors" : { - "type" : "array", - "description" : "The validation errors for the component.", - "items" : { - "type" : "string" - } - } - } - }, - "AffectedComponentEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "component" : { - "$ref" : "#/definitions/AffectedComponentDTO" - } - }, - "xml" : { - "name" : "affectComponentEntity" - } - }, - "AllowableValueDTO" : { - "type" : "object", - "properties" : { - "displayName" : { - "type" : "string", - "description" : "A human readable value that is allowed for the property descriptor." - }, - "value" : { - "type" : "string", - "description" : "A value that is allowed for the property descriptor." - }, - "description" : { - "type" : "string", - "description" : "A description for this allowable value." - } - } - }, - "AllowableValueEntity" : { - "type" : "object", - "properties" : { - "allowableValue" : { - "$ref" : "#/definitions/AllowableValueDTO" - }, - "canRead" : { - "type" : "boolean", - "description" : "Indicates whether the user can read a given resource.", - "readOnly" : true - } - }, - "xml" : { - "name" : "entity" - } - }, - "AttributeDTO" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The attribute name." - }, - "value" : { - "type" : "string", - "description" : "The attribute value." - }, - "previousValue" : { - "type" : "string", - "description" : "The value of the attribute before the event took place." - } - } - }, - "BannerDTO" : { - "type" : "object", - "properties" : { - "headerText" : { - "type" : "string", - "description" : "The header text." - }, - "footerText" : { - "type" : "string", - "description" : "The footer text." - } - } - }, - "BannerEntity" : { - "type" : "object", - "properties" : { - "banners" : { - "$ref" : "#/definitions/BannerDTO" - } - }, - "xml" : { - "name" : "bannersEntity" - } - }, - "BatchSettingsDTO" : { - "type" : "object", - "properties" : { - "count" : { - "type" : "integer", - "format" : "int32", - "description" : "Preferred number of flow files to include in a transaction." - }, - "size" : { - "type" : "string", - "description" : "Preferred number of bytes to include in a transaction." - }, - "duration" : { - "type" : "string", - "description" : "Preferred amount of time that a transaction should span." - } - } - }, - "BatchSize" : { - "type" : "object", - "properties" : { - "count" : { - "type" : "integer", - "format" : "int32", - "description" : "Preferred number of flow files to include in a transaction." - }, - "size" : { - "type" : "string", - "description" : "Preferred number of bytes to include in a transaction." - }, - "duration" : { - "type" : "string", - "description" : "Preferred amount of time that a transaction should span." - } - } - }, - "BucketDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The bucket identifier" - }, - "name" : { - "type" : "string", - "description" : "The bucket name" - }, - "description" : { - "type" : "string", - "description" : "The bucket description" - }, - "created" : { - "type" : "integer", - "format" : "int64", - "description" : "The created timestamp of this bucket" - } - } - }, - "BucketEntity" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string" - }, - "bucket" : { - "$ref" : "#/definitions/BucketDTO" - }, - "permissions" : { - "$ref" : "#/definitions/PermissionsDTO" - } - }, - "xml" : { - "name" : "bucketEntity" - } - }, - "BucketsEntity" : { - "type" : "object", - "properties" : { - "buckets" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/BucketEntity" - } - } - }, - "xml" : { - "name" : "bucketsEntity" - } - }, - "BulletinBoardDTO" : { - "type" : "object", - "properties" : { - "bulletins" : { - "type" : "array", - "description" : "The bulletins in the bulletin board, that matches the supplied request.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "generated" : { - "type" : "string", - "description" : "The timestamp when this report was generated." - } - } - }, - "BulletinBoardEntity" : { - "type" : "object", - "properties" : { - "bulletinBoard" : { - "$ref" : "#/definitions/BulletinBoardDTO" - } - }, - "xml" : { - "name" : "bulletinBoardEntity" - } - }, - "BulletinDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "integer", - "format" : "int64", - "description" : "The id of the bulletin." - }, - "nodeAddress" : { - "type" : "string", - "description" : "If clustered, the address of the node from which the bulletin originated." - }, - "category" : { - "type" : "string", - "description" : "The category of this bulletin." - }, - "groupId" : { - "type" : "string", - "description" : "The group id of the source component." - }, - "sourceId" : { - "type" : "string", - "description" : "The id of the source component." - }, - "sourceName" : { - "type" : "string", - "description" : "The name of the source component." - }, - "level" : { - "type" : "string", - "description" : "The level of the bulletin." - }, - "message" : { - "type" : "string", - "description" : "The bulletin message." - }, - "timestamp" : { - "type" : "string", - "description" : "When this bulletin was generated." - } - } - }, - "BulletinEntity" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "integer", - "format" : "int64" - }, - "groupId" : { - "type" : "string" - }, - "sourceId" : { - "type" : "string" - }, - "timestamp" : { - "type" : "string", - "description" : "When this bulletin was generated." - }, - "nodeAddress" : { - "type" : "string" - }, - "canRead" : { - "type" : "boolean", - "description" : "Indicates whether the user can read a given resource.", - "readOnly" : true - }, - "bulletin" : { - "$ref" : "#/definitions/BulletinDTO" - } - }, - "xml" : { - "name" : "bulletinEntity" - } - }, - "Bundle" : { - "type" : "object", - "properties" : { - "group" : { - "type" : "string", - "description" : "The group of the bundle" - }, - "artifact" : { - "type" : "string", - "description" : "The artifact of the bundle" - }, - "version" : { - "type" : "string", - "description" : "The version of the bundle" - } - } - }, - "BundleDTO" : { - "type" : "object", - "properties" : { - "group" : { - "type" : "string", - "description" : "The group of the bundle." - }, - "artifact" : { - "type" : "string", - "description" : "The artifact of the bundle." - }, - "version" : { - "type" : "string", - "description" : "The version of the bundle." - } - } - }, - "ClusteSummaryEntity" : { - "type" : "object", - "properties" : { - "clusterSummary" : { - "$ref" : "#/definitions/ClusterSummaryDTO" - } - }, - "xml" : { - "name" : "clusterSummaryEntity" - } - }, - "ClusterDTO" : { - "type" : "object", - "properties" : { - "nodes" : { - "type" : "array", - "description" : "The collection of nodes that are part of the cluster.", - "items" : { - "$ref" : "#/definitions/NodeDTO" - } - }, - "generated" : { - "type" : "string", - "description" : "The timestamp the report was generated." - } - } - }, - "ClusterEntity" : { - "type" : "object", - "properties" : { - "cluster" : { - "$ref" : "#/definitions/ClusterDTO" - } - }, - "xml" : { - "name" : "clusterEntity" - } - }, - "ClusterSearchResultsEntity" : { - "type" : "object", - "properties" : { - "nodeResults" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/NodeSearchResultDTO" - } - } - }, - "xml" : { - "name" : "clusterSearchResultsEntity" - } - }, - "ClusterSummaryDTO" : { - "type" : "object", - "properties" : { - "connectedNodes" : { - "type" : "string", - "description" : "When clustered, reports the number of nodes connected vs the number of nodes in the cluster." - }, - "connectedNodeCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of nodes that are currently connected to the cluster" - }, - "totalNodeCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of nodes in the cluster, regardless of whether or not they are connected" - }, - "clustered" : { - "type" : "boolean", - "description" : "Whether this NiFi instance is clustered." - }, - "connectedToCluster" : { - "type" : "boolean", - "description" : "Whether this NiFi instance is connected to a cluster." - } - } - }, - "ComponentDetailsDTO" : { - "type" : "object" - }, - "ComponentDifferenceDTO" : { - "type" : "object", - "properties" : { - "componentType" : { - "type" : "string", - "description" : "The type of component" - }, - "componentId" : { - "type" : "string", - "description" : "The ID of the component" - }, - "componentName" : { - "type" : "string", - "description" : "The name of the component" - }, - "processGroupId" : { - "type" : "string", - "description" : "The ID of the Process Group that the component belongs to" - }, - "differences" : { - "type" : "array", - "description" : "The differences in the component between the two flows", - "items" : { - "$ref" : "#/definitions/DifferenceDTO" - } - } - } - }, - "ComponentHistoryDTO" : { - "type" : "object", - "properties" : { - "componentId" : { - "type" : "string", - "description" : "The component id." - }, - "propertyHistory" : { - "type" : "object", - "description" : "The history for the properties of the component.", - "additionalProperties" : { - "$ref" : "#/definitions/PropertyHistoryDTO" - } - } - } - }, - "ComponentHistoryEntity" : { - "type" : "object", - "properties" : { - "componentHistory" : { - "$ref" : "#/definitions/ComponentHistoryDTO" - } - }, - "xml" : { - "name" : "componentHistoryEntity" - } - }, - "ComponentReferenceDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "versionedComponentId" : { - "type" : "string", - "description" : "The ID of the corresponding component that is under version control" - }, - "parentGroupId" : { - "type" : "string", - "description" : "The id of parent process group of this component if applicable." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "name" : { - "type" : "string", - "description" : "The name of the component." - } - } - }, - "ComponentReferenceEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "parentGroupId" : { - "type" : "string", - "description" : "The id of parent process group of this component if applicable." - }, - "component" : { - "$ref" : "#/definitions/ComponentReferenceDTO" - } - }, - "xml" : { - "name" : "componentReferenceEntity" - } - }, - "ComponentRestrictionPermissionDTO" : { - "type" : "object", - "properties" : { - "requiredPermission" : { - "description" : "The required permission necessary for this restriction.", - "$ref" : "#/definitions/RequiredPermissionDTO" - }, - "permissions" : { - "description" : "The permissions for this component restriction. Note: the read permission are not used and will always be false.", - "$ref" : "#/definitions/PermissionsDTO" - } - } - }, - "ComponentSearchResultDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component that matched the search." - }, - "groupId" : { - "type" : "string", - "description" : "The group id of the component that matched the search." - }, - "parentGroup" : { - "description" : "The parent group of the component that matched the search.", - "$ref" : "#/definitions/SearchResultGroupDTO" - }, - "versionedGroup" : { - "description" : "The nearest versioned ancestor group of the component that matched the search.", - "$ref" : "#/definitions/SearchResultGroupDTO" - }, - "name" : { - "type" : "string", - "description" : "The name of the component that matched the search." - }, - "matches" : { - "type" : "array", - "description" : "What matched the search from the component.", - "items" : { - "type" : "string" - } - } - } - }, - "ComponentStateDTO" : { - "type" : "object", - "properties" : { - "componentId" : { - "type" : "string", - "description" : "The component identifier." - }, - "stateDescription" : { - "type" : "string", - "description" : "Description of the state this component persists." - }, - "clusterState" : { - "description" : "The cluster state for this component, or null if this NiFi is a standalone instance.", - "$ref" : "#/definitions/StateMapDTO" - }, - "localState" : { - "description" : "The local state for this component.", - "$ref" : "#/definitions/StateMapDTO" - } - } - }, - "ComponentStateEntity" : { - "type" : "object", - "properties" : { - "componentState" : { - "description" : "The component state.", - "$ref" : "#/definitions/ComponentStateDTO" - } - }, - "xml" : { - "name" : "componentStateEntity" - } - }, - "ConnectableComponent" : { - "type" : "object", - "required" : [ "groupId", "id", "type" ], - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the connectable component." - }, - "type" : { - "type" : "string", - "description" : "The type of component the connectable is.", - "enum" : [ "PROCESSOR", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "INPUT_PORT", "OUTPUT_PORT", "FUNNEL" ] - }, - "groupId" : { - "type" : "string", - "description" : "The id of the group that the connectable component resides in" - }, - "name" : { - "type" : "string", - "description" : "The name of the connectable component" - }, - "comments" : { - "type" : "string", - "description" : "The comments for the connectable component." - } - } - }, - "ConnectableDTO" : { - "type" : "object", - "required" : [ "groupId", "id", "type" ], - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the connectable component." - }, - "versionedComponentId" : { - "type" : "string", - "description" : "The ID of the corresponding component that is under version control" - }, - "type" : { - "type" : "string", - "description" : "The type of component the connectable is.", - "enum" : [ "PROCESSOR", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "INPUT_PORT", "OUTPUT_PORT", "FUNNEL" ] - }, - "groupId" : { - "type" : "string", - "description" : "The id of the group that the connectable component resides in" - }, - "name" : { - "type" : "string", - "description" : "The name of the connectable component" - }, - "running" : { - "type" : "boolean", - "description" : "Reflects the current state of the connectable component." - }, - "transmitting" : { - "type" : "boolean", - "description" : "If the connectable component represents a remote port, indicates if the target is configured to transmit." - }, - "exists" : { - "type" : "boolean", - "description" : "If the connectable component represents a remote port, indicates if the target exists." - }, - "comments" : { - "type" : "string", - "description" : "The comments for the connectable component." - } - } - }, - "ConnectionDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "versionedComponentId" : { - "type" : "string", - "description" : "The ID of the corresponding component that is under version control" - }, - "parentGroupId" : { - "type" : "string", - "description" : "The id of parent process group of this component if applicable." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "source" : { - "description" : "The source of the connection.", - "$ref" : "#/definitions/ConnectableDTO" - }, - "destination" : { - "description" : "The destination of the connection.", - "$ref" : "#/definitions/ConnectableDTO" - }, - "name" : { - "type" : "string", - "description" : "The name of the connection." - }, - "labelIndex" : { - "type" : "integer", - "format" : "int32", - "description" : "The index of the bend point where to place the connection label." - }, - "getzIndex" : { - "type" : "integer", - "format" : "int64", - "description" : "The z index of the connection." - }, - "selectedRelationships" : { - "type" : "array", - "description" : "The selected relationship that comprise the connection.", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - }, - "availableRelationships" : { - "type" : "array", - "description" : "The relationships that the source of the connection currently supports.", - "readOnly" : true, - "uniqueItems" : true, - "items" : { - "type" : "string" - } - }, - "backPressureObjectThreshold" : { - "type" : "integer", - "format" : "int64", - "description" : "The object count threshold for determining when back pressure is applied. Updating this value is a passive change in the sense that it won't impact whether existing files over the limit are affected but it does help feeder processors to stop pushing too much into this work queue." - }, - "backPressureDataSizeThreshold" : { - "type" : "string", - "description" : "The object data size threshold for determining when back pressure is applied. Updating this value is a passive change in the sense that it won't impact whether existing files over the limit are affected but it does help feeder processors to stop pushing too much into this work queue." - }, - "flowFileExpiration" : { - "type" : "string", - "description" : "The amount of time a flow file may be in the flow before it will be automatically aged out of the flow. Once a flow file reaches this age it will be terminated from the flow the next time a processor attempts to start work on it." - }, - "prioritizers" : { - "type" : "array", - "description" : "The comparators used to prioritize the queue.", - "items" : { - "type" : "string" - } - }, - "bends" : { - "type" : "array", - "description" : "The bend points on the connection.", - "items" : { - "$ref" : "#/definitions/PositionDTO" - } - }, - "loadBalanceStrategy" : { - "type" : "string", - "description" : "How to load balance the data in this Connection across the nodes in the cluster.", - "enum" : [ "DO_NOT_LOAD_BALANCE", "PARTITION_BY_ATTRIBUTE", "ROUND_ROBIN", "SINGLE_NODE" ] - }, - "loadBalancePartitionAttribute" : { - "type" : "string", - "description" : "The FlowFile Attribute to use for determining which node a FlowFile will go to if the Load Balancing Strategy is set to PARTITION_BY_ATTRIBUTE" - }, - "loadBalanceCompression" : { - "type" : "string", - "description" : "Whether or not data should be compressed when being transferred between nodes in the cluster.", - "enum" : [ "DO_NOT_COMPRESS", "COMPRESS_ATTRIBUTES_ONLY", "COMPRESS_ATTRIBUTES_AND_CONTENT" ] - }, - "loadBalanceStatus" : { - "type" : "string", - "description" : "The current status of the Connection's Load Balancing Activities. Status can indicate that Load Balancing is not configured for the connection, that Load Balancing is configured but inactive (not currently transferring data to another node), or that Load Balancing is configured and actively transferring data to another node.", - "readOnly" : true, - "enum" : [ "LOAD_BALANCE_NOT_CONFIGURED", "LOAD_BALANCE_INACTIVE", "LOAD_BALANCE_ACTIVE" ] - } - } - }, - "ConnectionEntity" : { - "type" : "object", - "required" : [ "destinationType", "sourceType" ], - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "component" : { - "$ref" : "#/definitions/ConnectionDTO" - }, - "status" : { - "description" : "The status of the connection.", - "$ref" : "#/definitions/ConnectionStatusDTO" - }, - "bends" : { - "type" : "array", - "description" : "The bend points on the connection.", - "items" : { - "$ref" : "#/definitions/PositionDTO" - } - }, - "labelIndex" : { - "type" : "integer", - "format" : "int32", - "description" : "The index of the bend point where to place the connection label." - }, - "getzIndex" : { - "type" : "integer", - "format" : "int64", - "description" : "The z index of the connection." - }, - "sourceId" : { - "type" : "string", - "description" : "The identifier of the source of this connection." - }, - "sourceGroupId" : { - "type" : "string", - "description" : "The identifier of the group of the source of this connection." - }, - "sourceType" : { - "type" : "string", - "description" : "The type of component the source connectable is.", - "enum" : [ "PROCESSOR", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "INPUT_PORT", "OUTPUT_PORT", "FUNNEL" ] - }, - "destinationId" : { - "type" : "string", - "description" : "The identifier of the destination of this connection." - }, - "destinationGroupId" : { - "type" : "string", - "description" : "The identifier of the group of the destination of this connection." - }, - "destinationType" : { - "type" : "string", - "description" : "The type of component the destination connectable is.", - "enum" : [ "PROCESSOR", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "INPUT_PORT", "OUTPUT_PORT", "FUNNEL" ] - } - }, - "xml" : { - "name" : "connectionEntity" - } - }, - "ConnectionStatusDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The ID of the connection" - }, - "groupId" : { - "type" : "string", - "description" : "The ID of the Process Group that the connection belongs to" - }, - "name" : { - "type" : "string", - "description" : "The name of the connection" - }, - "statsLastRefreshed" : { - "type" : "string", - "description" : "The timestamp of when the stats were last refreshed" - }, - "sourceId" : { - "type" : "string", - "description" : "The ID of the source component" - }, - "sourceName" : { - "type" : "string", - "description" : "The name of the source component" - }, - "destinationId" : { - "type" : "string", - "description" : "The ID of the destination component" - }, - "destinationName" : { - "type" : "string", - "description" : "The name of the destination component" - }, - "aggregateSnapshot" : { - "description" : "The status snapshot that represents the aggregate stats of the cluster", - "$ref" : "#/definitions/ConnectionStatusSnapshotDTO" - }, - "nodeSnapshots" : { - "type" : "array", - "description" : "A list of status snapshots for each node", - "items" : { - "$ref" : "#/definitions/NodeConnectionStatusSnapshotDTO" - } - } - } - }, - "ConnectionStatusEntity" : { - "type" : "object", - "properties" : { - "connectionStatus" : { - "$ref" : "#/definitions/ConnectionStatusDTO" - }, - "canRead" : { - "type" : "boolean", - "description" : "Indicates whether the user can read a given resource.", - "readOnly" : true - } - }, - "xml" : { - "name" : "connectionStatusEntity" - } - }, - "ConnectionStatusSnapshotDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the connection." - }, - "groupId" : { - "type" : "string", - "description" : "The id of the process group the connection belongs to." - }, - "name" : { - "type" : "string", - "description" : "The name of the connection." - }, - "sourceId" : { - "type" : "string", - "description" : "The id of the source of the connection." - }, - "sourceName" : { - "type" : "string", - "description" : "The name of the source of the connection." - }, - "destinationId" : { - "type" : "string", - "description" : "The id of the destination of the connection." - }, - "destinationName" : { - "type" : "string", - "description" : "The name of the destination of the connection." - }, - "flowFilesIn" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of FlowFiles that have come into the connection in the last 5 minutes." - }, - "bytesIn" : { - "type" : "integer", - "format" : "int64", - "description" : "The size of the FlowFiles that have come into the connection in the last 5 minutes." - }, - "input" : { - "type" : "string", - "description" : "The input count/size for the connection in the last 5 minutes, pretty printed." - }, - "flowFilesOut" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of FlowFiles that have left the connection in the last 5 minutes." - }, - "bytesOut" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes that have left the connection in the last 5 minutes." - }, - "output" : { - "type" : "string", - "description" : "The output count/sie for the connection in the last 5 minutes, pretty printed." - }, - "flowFilesQueued" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of FlowFiles that are currently queued in the connection." - }, - "bytesQueued" : { - "type" : "integer", - "format" : "int64", - "description" : "The size of the FlowFiles that are currently queued in the connection." - }, - "queued" : { - "type" : "string", - "description" : "The total count and size of queued flowfiles formatted." - }, - "queuedSize" : { - "type" : "string", - "description" : "The total size of flowfiles that are queued formatted." - }, - "queuedCount" : { - "type" : "string", - "description" : "The number of flowfiles that are queued, pretty printed." - }, - "percentUseCount" : { - "type" : "integer", - "format" : "int32", - "description" : "Connection percent use regarding queued flow files count and backpressure threshold if configured." - }, - "percentUseBytes" : { - "type" : "integer", - "format" : "int32", - "description" : "Connection percent use regarding queued flow files size and backpressure threshold if configured." - } - } - }, - "ConnectionStatusSnapshotEntity" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the connection." - }, - "connectionStatusSnapshot" : { - "$ref" : "#/definitions/ConnectionStatusSnapshotDTO" - }, - "canRead" : { - "type" : "boolean", - "description" : "Indicates whether the user can read a given resource.", - "readOnly" : true - } - }, - "xml" : { - "name" : "entity" - } - }, - "ConnectionsEntity" : { - "type" : "object", - "properties" : { - "connections" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ConnectionEntity" - } - } - }, - "xml" : { - "name" : "connectionsEntity" - } - }, - "ControllerBulletinsEntity" : { - "type" : "object", - "properties" : { - "bulletins" : { - "type" : "array", - "description" : "System level bulletins to be reported to the user.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "controllerServiceBulletins" : { - "type" : "array", - "description" : "Controller service bulletins to be reported to the user.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "reportingTaskBulletins" : { - "type" : "array", - "description" : "Reporting task bulletins to be reported to the user.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - } - }, - "xml" : { - "name" : "controllerConfigurationEntity" - } - }, - "ControllerConfigurationDTO" : { - "type" : "object", - "properties" : { - "maxTimerDrivenThreadCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The maximum number of timer driven threads the NiFi has available." - }, - "maxEventDrivenThreadCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The maximum number of event driven threads the NiFi has available." - } - } - }, - "ControllerConfigurationEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "component" : { - "description" : "The controller configuration.", - "$ref" : "#/definitions/ControllerConfigurationDTO" - } - }, - "xml" : { - "name" : "controllerConfigurationEntity" - } - }, - "ControllerDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the NiFi." - }, - "name" : { - "type" : "string", - "description" : "The name of the NiFi." - }, - "comments" : { - "type" : "string", - "description" : "The comments for the NiFi." - }, - "runningCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of running components in the NiFi." - }, - "stoppedCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of stopped components in the NiFi." - }, - "invalidCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of invalid components in the NiFi." - }, - "disabledCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of disabled components in the NiFi." - }, - "activeRemotePortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of active remote ports contained in the NiFi." - }, - "inactiveRemotePortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of inactive remote ports contained in the NiFi." - }, - "inputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of input ports contained in the NiFi." - }, - "outputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of output ports in the NiFi." - }, - "remoteSiteListeningPort" : { - "type" : "integer", - "format" : "int32", - "description" : "The Socket Port on which this instance is listening for Remote Transfers of Flow Files. If this instance is not configured to receive Flow Files from remote instances, this will be null." - }, - "remoteSiteHttpListeningPort" : { - "type" : "integer", - "format" : "int32", - "description" : "The HTTP(S) Port on which this instance is listening for Remote Transfers of Flow Files. If this instance is not configured to receive Flow Files from remote instances, this will be null." - }, - "siteToSiteSecure" : { - "type" : "boolean", - "description" : "Indicates whether or not Site-to-Site communications with this instance is secure (2-way authentication)." - }, - "instanceId" : { - "type" : "string", - "description" : "If clustered, the id of the Cluster Manager, otherwise the id of the NiFi." - }, - "inputPorts" : { - "type" : "array", - "description" : "The input ports available to send data to for the NiFi.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/PortDTO" - } - }, - "outputPorts" : { - "type" : "array", - "description" : "The output ports available to received data from the NiFi.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/PortDTO" - } - } - } - }, - "ControllerEntity" : { - "type" : "object", - "properties" : { - "controller" : { - "$ref" : "#/definitions/ControllerDTO" - } - }, - "xml" : { - "name" : "controllerEntity" - } - }, - "ControllerServiceAPI" : { - "type" : "object", - "properties" : { - "type" : { - "type" : "string", - "description" : "The fully qualified name of the service interface." - }, - "bundle" : { - "description" : "The details of the artifact that bundled this service interface.", - "$ref" : "#/definitions/Bundle" - } - } - }, - "ControllerServiceApiDTO" : { - "type" : "object", - "properties" : { - "type" : { - "type" : "string", - "description" : "The fully qualified name of the service interface." - }, - "bundle" : { - "description" : "The details of the artifact that bundled this service interface.", - "$ref" : "#/definitions/BundleDTO" - } - } - }, - "ControllerServiceDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "versionedComponentId" : { - "type" : "string", - "description" : "The ID of the corresponding component that is under version control" - }, - "parentGroupId" : { - "type" : "string", - "description" : "The id of parent process group of this component if applicable." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "name" : { - "type" : "string", - "description" : "The name of the controller service." - }, - "type" : { - "type" : "string", - "description" : "The type of the controller service." - }, - "bundle" : { - "description" : "The details of the artifact that bundled this processor type.", - "$ref" : "#/definitions/BundleDTO" - }, - "controllerServiceApis" : { - "type" : "array", - "description" : "Lists the APIs this Controller Service implements.", - "items" : { - "$ref" : "#/definitions/ControllerServiceApiDTO" - } - }, - "comments" : { - "type" : "string", - "description" : "The comments for the controller service." - }, - "state" : { - "type" : "string", - "description" : "The state of the controller service.", - "enum" : [ "ENABLED", "ENABLING", "DISABLED", "DISABLING" ] - }, - "persistsState" : { - "type" : "boolean", - "description" : "Whether the controller service persists state." - }, - "restricted" : { - "type" : "boolean", - "description" : "Whether the controller service requires elevated privileges." - }, - "deprecated" : { - "type" : "boolean", - "description" : "Whether the ontroller service has been deprecated." - }, - "multipleVersionsAvailable" : { - "type" : "boolean", - "description" : "Whether the controller service has multiple versions available." - }, - "properties" : { - "type" : "object", - "description" : "The properties of the controller service.", - "additionalProperties" : { - "type" : "string" - } - }, - "descriptors" : { - "type" : "object", - "description" : "The descriptors for the controller service properties.", - "additionalProperties" : { - "$ref" : "#/definitions/PropertyDescriptorDTO" - } - }, - "customUiUrl" : { - "type" : "string", - "description" : "The URL for the controller services custom configuration UI if applicable." - }, - "annotationData" : { - "type" : "string", - "description" : "The annotation for the controller service. This is how the custom UI relays configuration to the controller service." - }, - "referencingComponents" : { - "type" : "array", - "description" : "All components referencing this controller service.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ControllerServiceReferencingComponentEntity" - } - }, - "validationErrors" : { - "type" : "array", - "description" : "The validation errors from the controller service. These validation errors represent the problems with the controller service that must be resolved before it can be enabled.", - "items" : { - "type" : "string" - } - }, - "validationStatus" : { - "type" : "string", - "description" : "Indicates whether the ControllerService is valid, invalid, or still in the process of validating (i.e., it is unknown whether or not the ControllerService is valid)", - "readOnly" : true, - "enum" : [ "VALID", "INVALID", "VALIDATING" ] - }, - "extensionMissing" : { - "type" : "boolean", - "description" : "Whether the underlying extension is missing." - } - } - }, - "ControllerServiceEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "parentGroupId" : { - "type" : "string", - "description" : "The id of parent process group of this ControllerService." - }, - "component" : { - "$ref" : "#/definitions/ControllerServiceDTO" - }, - "operatePermissions" : { - "description" : "The permissions for this component operations.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "status" : { - "description" : "The status for this ControllerService.", - "readOnly" : true, - "$ref" : "#/definitions/ControllerServiceStatusDTO" - } - }, - "xml" : { - "name" : "controllerServiceEntity" - } - }, - "ControllerServiceReferencingComponentDTO" : { - "type" : "object", - "properties" : { - "groupId" : { - "type" : "string", - "description" : "The group id for the component referencing a controller service. If this component is another controller service or a reporting task, this field is blank." - }, - "id" : { - "type" : "string", - "description" : "The id of the component referencing a controller service." - }, - "name" : { - "type" : "string", - "description" : "The name of the component referencing a controller service." - }, - "type" : { - "type" : "string", - "description" : "The type of the component referencing a controller service in simple Java class name format without package name." - }, - "state" : { - "type" : "string", - "description" : "The scheduled state of a processor or reporting task referencing a controller service. If this component is another controller service, this field represents the controller service state." - }, - "properties" : { - "type" : "object", - "description" : "The properties for the component.", - "additionalProperties" : { - "type" : "string" - } - }, - "descriptors" : { - "type" : "object", - "description" : "The descriptors for the component properties.", - "additionalProperties" : { - "$ref" : "#/definitions/PropertyDescriptorDTO" - } - }, - "validationErrors" : { - "type" : "array", - "description" : "The validation errors for the component.", - "items" : { - "type" : "string" - } - }, - "referenceType" : { - "type" : "string", - "description" : "The type of reference this is.", - "enum" : [ "Processor", "ControllerService", "or ReportingTask" ] - }, - "activeThreadCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of active threads for the referencing component." - }, - "referenceCycle" : { - "type" : "boolean", - "description" : "If the referencing component represents a controller service, this indicates whether it has already been represented in this hierarchy." - }, - "referencingComponents" : { - "type" : "array", - "description" : "If the referencing component represents a controller service, these are the components that reference it.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ControllerServiceReferencingComponentEntity" - } - } - } - }, - "ControllerServiceReferencingComponentEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "component" : { - "$ref" : "#/definitions/ControllerServiceReferencingComponentDTO" - }, - "operatePermissions" : { - "description" : "The permissions for this component operations.", - "$ref" : "#/definitions/PermissionsDTO" - } - }, - "xml" : { - "name" : "controllerServiceReferencingComponentEntity" - } - }, - "ControllerServiceReferencingComponentsEntity" : { - "type" : "object", - "properties" : { - "controllerServiceReferencingComponents" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ControllerServiceReferencingComponentEntity" - } - } - }, - "xml" : { - "name" : "controllerServiceReferencingComponentsEntity" - } - }, - "ControllerServiceRunStatusEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "state" : { - "type" : "string", - "description" : "The run status of the ControllerService.", - "enum" : [ "ENABLED", "DISABLED" ] - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - } - }, - "xml" : { - "name" : "entity" - } - }, - "ControllerServiceStatusDTO" : { - "type" : "object", - "properties" : { - "runStatus" : { - "type" : "string", - "description" : "The run status of this ControllerService", - "readOnly" : true, - "enum" : [ "ENABLED", "ENABLING", "DISABLED", "DISABLING" ] - }, - "validationStatus" : { - "type" : "string", - "description" : "Indicates whether the component is valid, invalid, or still in the process of validating (i.e., it is unknown whether or not the component is valid)", - "readOnly" : true, - "enum" : [ "VALID", "INVALID", "VALIDATING" ] - }, - "activeThreadCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of active threads for the component." - } - } - }, - "ControllerServiceTypesEntity" : { - "type" : "object", - "properties" : { - "controllerServiceTypes" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/DocumentedTypeDTO" - } - } - }, - "xml" : { - "name" : "controllerServiceTypesEntity" - } - }, - "ControllerServicesEntity" : { - "type" : "object", - "properties" : { - "currentTime" : { - "type" : "string", - "description" : "The current time on the system." - }, - "controllerServices" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ControllerServiceEntity" - } - } - }, - "xml" : { - "name" : "controllerServicesEntity" - } - }, - "ControllerStatusDTO" : { - "type" : "object", - "properties" : { - "activeThreadCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of active threads in the NiFi." - }, - "terminatedThreadCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of terminated threads in the NiFi." - }, - "queued" : { - "type" : "string", - "description" : "The number of flowfiles queued in the NiFi." - }, - "flowFilesQueued" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of FlowFiles queued across the entire flow" - }, - "bytesQueued" : { - "type" : "integer", - "format" : "int64", - "description" : "The size of the FlowFiles queued across the entire flow" - }, - "runningCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of running components in the NiFi." - }, - "stoppedCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of stopped components in the NiFi." - }, - "invalidCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of invalid components in the NiFi." - }, - "disabledCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of disabled components in the NiFi." - }, - "activeRemotePortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of active remote ports in the NiFi." - }, - "inactiveRemotePortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of inactive remote ports in the NiFi." - }, - "upToDateCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of up to date versioned process groups in the NiFi." - }, - "locallyModifiedCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of locally modified versioned process groups in the NiFi." - }, - "staleCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of stale versioned process groups in the NiFi." - }, - "locallyModifiedAndStaleCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of locally modified and stale versioned process groups in the NiFi." - }, - "syncFailureCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of versioned process groups in the NiFi that are unable to sync to a registry." - } - } - }, - "ControllerStatusEntity" : { - "type" : "object", - "properties" : { - "controllerStatus" : { - "$ref" : "#/definitions/ControllerStatusDTO" - } - }, - "xml" : { - "name" : "controllerStatusEntity" - } - }, - "CopySnippetRequestEntity" : { - "type" : "object", - "properties" : { - "snippetId" : { - "type" : "string", - "description" : "The identifier of the snippet." - }, - "originX" : { - "type" : "number", - "format" : "double", - "description" : "The x coordinate of the origin of the bounding box where the new components will be placed." - }, - "originY" : { - "type" : "number", - "format" : "double", - "description" : "The y coordinate of the origin of the bounding box where the new components will be placed." - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - } - }, - "xml" : { - "name" : "copySnippetRequestEntity" - } - }, - "CounterDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the counter." - }, - "context" : { - "type" : "string", - "description" : "The context of the counter." - }, - "name" : { - "type" : "string", - "description" : "The name of the counter." - }, - "valueCount" : { - "type" : "integer", - "format" : "int64", - "description" : "The value count." - }, - "value" : { - "type" : "string", - "description" : "The value of the counter." - } - } - }, - "CounterEntity" : { - "type" : "object", - "properties" : { - "counter" : { - "$ref" : "#/definitions/CounterDTO" - } - }, - "xml" : { - "name" : "counterEntity" - } - }, - "CountersDTO" : { - "type" : "object", - "properties" : { - "aggregateSnapshot" : { - "description" : "A Counters snapshot that represents the aggregate values of all nodes in the cluster. If the NiFi instance is a standalone instance, rather than a cluster, this represents the stats of the single instance.", - "$ref" : "#/definitions/CountersSnapshotDTO" - }, - "nodeSnapshots" : { - "type" : "array", - "description" : "A Counters snapshot for each node in the cluster. If the NiFi instance is a standalone instance, rather than a cluster, this may be null.", - "items" : { - "$ref" : "#/definitions/NodeCountersSnapshotDTO" - } - } - } - }, - "CountersEntity" : { - "type" : "object", - "properties" : { - "counters" : { - "$ref" : "#/definitions/CountersDTO" - } - }, - "xml" : { - "name" : "countersEntity" - } - }, - "CountersSnapshotDTO" : { - "type" : "object", - "properties" : { - "generated" : { - "type" : "string", - "description" : "The timestamp when the report was generated." - }, - "counters" : { - "type" : "array", - "description" : "All counters in the NiFi.", - "items" : { - "$ref" : "#/definitions/CounterDTO" - } - } - } - }, - "CreateActiveRequestEntity" : { - "type" : "object", - "properties" : { - "processGroupId" : { - "type" : "string", - "description" : "The Process Group ID that this active request will update" - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - } - }, - "xml" : { - "name" : "createActiveRequestEntity" - } - }, - "CreateTemplateRequestEntity" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The name of the template." - }, - "description" : { - "type" : "string", - "description" : "The description of the template." - }, - "snippetId" : { - "type" : "string", - "description" : "The identifier of the snippet." - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - } - }, - "xml" : { - "name" : "createTemplateRequestEntity" - } - }, - "CurrentUserEntity" : { - "type" : "object", - "properties" : { - "identity" : { - "type" : "string", - "description" : "The user identity being serialized." - }, - "anonymous" : { - "type" : "boolean", - "description" : "Whether the current user is anonymous." - }, - "provenancePermissions" : { - "description" : "Permissions for querying provenance.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "countersPermissions" : { - "description" : "Permissions for accessing counters.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "tenantsPermissions" : { - "description" : "Permissions for accessing tenants.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "controllerPermissions" : { - "description" : "Permissions for accessing the controller.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "policiesPermissions" : { - "description" : "Permissions for accessing the policies.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "systemPermissions" : { - "description" : "Permissions for accessing system.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "restrictedComponentsPermissions" : { - "description" : "Permissions for accessing restricted components. Note: the read permission are not used and will always be false.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "componentRestrictionPermissions" : { - "type" : "array", - "description" : "Permissions for specific component restrictions.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ComponentRestrictionPermissionDTO" - } - }, - "canVersionFlows" : { - "type" : "boolean", - "description" : "Whether the current user can version flows." - } - }, - "xml" : { - "name" : "currentEntity" - } - }, - "DifferenceDTO" : { - "type" : "object", - "properties" : { - "differenceType" : { - "type" : "string", - "description" : "The type of difference" - }, - "difference" : { - "type" : "string", - "description" : "Description of the difference" - } - } - }, - "DimensionsDTO" : { - "type" : "object", - "properties" : { - "width" : { - "type" : "number", - "format" : "double", - "description" : "The width of the label in pixels when at a 1:1 scale." - }, - "height" : { - "type" : "number", - "format" : "double", - "description" : "The height of the label in pixels when at a 1:1 scale." - } - } - }, - "DocumentedTypeDTO" : { - "type" : "object", - "properties" : { - "type" : { - "type" : "string", - "description" : "The fully qualified name of the type." - }, - "bundle" : { - "description" : "The details of the artifact that bundled this type.", - "$ref" : "#/definitions/BundleDTO" - }, - "controllerServiceApis" : { - "type" : "array", - "description" : "If this type represents a ControllerService, this lists the APIs it implements.", - "items" : { - "$ref" : "#/definitions/ControllerServiceApiDTO" - } - }, - "description" : { - "type" : "string", - "description" : "The description of the type." - }, - "restricted" : { - "type" : "boolean", - "description" : "Whether this type is restricted." - }, - "usageRestriction" : { - "type" : "string", - "description" : "The optional description of why the usage of this component is restricted." - }, - "explicitRestrictions" : { - "type" : "array", - "description" : "An optional collection of explicit restrictions. If specified, these explicit restrictions will be enfored.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ExplicitRestrictionDTO" - } - }, - "deprecationReason" : { - "type" : "string", - "description" : "The description of why the usage of this component is restricted." - }, - "tags" : { - "type" : "array", - "description" : "The tags associated with this type.", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - } - } - }, - "DropRequestDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id for this drop request." - }, - "uri" : { - "type" : "string", - "description" : "The URI for future requests to this drop request." - }, - "submissionTime" : { - "type" : "string", - "description" : "The timestamp when the query was submitted." - }, - "lastUpdated" : { - "type" : "string", - "description" : "The last time this drop request was updated." - }, - "percentCompleted" : { - "type" : "integer", - "format" : "int32", - "description" : "The current percent complete." - }, - "finished" : { - "type" : "boolean", - "description" : "Whether the query has finished." - }, - "failureReason" : { - "type" : "string", - "description" : "The reason, if any, that this drop request failed." - }, - "currentCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of flow files currently queued." - }, - "currentSize" : { - "type" : "integer", - "format" : "int64", - "description" : "The size of flow files currently queued in bytes." - }, - "current" : { - "type" : "string", - "description" : "The count and size of flow files currently queued." - }, - "originalCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of flow files to be dropped as a result of this request." - }, - "originalSize" : { - "type" : "integer", - "format" : "int64", - "description" : "The size of flow files to be dropped as a result of this request in bytes." - }, - "original" : { - "type" : "string", - "description" : "The count and size of flow files to be dropped as a result of this request." - }, - "droppedCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of flow files that have been dropped thus far." - }, - "droppedSize" : { - "type" : "integer", - "format" : "int64", - "description" : "The size of flow files that have been dropped thus far in bytes." - }, - "dropped" : { - "type" : "string", - "description" : "The count and size of flow files that have been dropped thus far." - }, - "state" : { - "type" : "string", - "description" : "The current state of the drop request." - } - } - }, - "DropRequestEntity" : { - "type" : "object", - "properties" : { - "dropRequest" : { - "$ref" : "#/definitions/DropRequestDTO" - } - }, - "xml" : { - "name" : "dropRequestEntity" - } - }, - "ExplicitRestrictionDTO" : { - "type" : "object", - "properties" : { - "requiredPermission" : { - "description" : "The required permission necessary for this restriction.", - "$ref" : "#/definitions/RequiredPermissionDTO" - }, - "explanation" : { - "type" : "string", - "description" : "The description of why the usage of this component is restricted for this required permission." - } - } - }, - "FlowBreadcrumbDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the group." - }, - "name" : { - "type" : "string", - "description" : "The id of the group." - }, - "versionControlInformation" : { - "description" : "The process group version control information or null if not version controlled.", - "$ref" : "#/definitions/VersionControlInformationDTO" - } - } - }, - "FlowBreadcrumbEntity" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of this ancestor ProcessGroup." - }, - "permissions" : { - "description" : "The permissions for this ancestor ProcessGroup.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "versionedFlowState" : { - "type" : "string", - "description" : "The current state of the Process Group, as it relates to the Versioned Flow", - "readOnly" : true, - "enum" : [ "LOCALLY_MODIFIED", "STALE", "LOCALLY_MODIFIED_AND_STALE", "UP_TO_DATE", "SYNC_FAILURE" ] - }, - "breadcrumb" : { - "description" : "This breadcrumb.", - "$ref" : "#/definitions/FlowBreadcrumbDTO" - }, - "parentBreadcrumb" : { - "description" : "The parent breadcrumb for this breadcrumb.", - "$ref" : "#/definitions/FlowBreadcrumbEntity" - } - }, - "xml" : { - "name" : "flowEntity" - } - }, - "FlowComparisonEntity" : { - "type" : "object", - "properties" : { - "componentDifferences" : { - "type" : "array", - "description" : "The list of differences for each component in the flow that is not the same between the two flows", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ComponentDifferenceDTO" - } - } - }, - "xml" : { - "name" : "flowComparisonEntity" - } - }, - "FlowConfigurationDTO" : { - "type" : "object", - "properties" : { - "supportsManagedAuthorizer" : { - "type" : "boolean", - "description" : "Whether this NiFi supports a managed authorizer. Managed authorizers can visualize users, groups, and policies in the UI.", - "readOnly" : true - }, - "supportsConfigurableAuthorizer" : { - "type" : "boolean", - "description" : "Whether this NiFi supports a configurable authorizer.", - "readOnly" : true - }, - "supportsConfigurableUsersAndGroups" : { - "type" : "boolean", - "description" : "Whether this NiFi supports configurable users and groups.", - "readOnly" : true - }, - "autoRefreshIntervalSeconds" : { - "type" : "integer", - "format" : "int64", - "description" : "The interval in seconds between the automatic NiFi refresh requests.", - "readOnly" : true - }, - "currentTime" : { - "type" : "string", - "description" : "The current time on the system." - }, - "timeOffset" : { - "type" : "integer", - "format" : "int32", - "description" : "The time offset of the system." - }, - "defaultBackPressureObjectThreshold" : { - "type" : "integer", - "format" : "int64", - "description" : "The default back pressure object threshold." - }, - "defaultBackPressureDataSizeThreshold" : { - "type" : "string", - "description" : "The default back pressure data size threshold." - } - } - }, - "FlowConfigurationEntity" : { - "type" : "object", - "properties" : { - "flowConfiguration" : { - "description" : "The controller configuration.", - "$ref" : "#/definitions/FlowConfigurationDTO" - } - }, - "xml" : { - "name" : "flowConfigurationEntity" - } - }, - "FlowDTO" : { - "type" : "object", - "properties" : { - "processGroups" : { - "type" : "array", - "description" : "The process groups in this flow.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ProcessGroupEntity" - } - }, - "remoteProcessGroups" : { - "type" : "array", - "description" : "The remote process groups in this flow.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/RemoteProcessGroupEntity" - } - }, - "processors" : { - "type" : "array", - "description" : "The processors in this flow.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ProcessorEntity" - } - }, - "inputPorts" : { - "type" : "array", - "description" : "The input ports in this flow.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/PortEntity" - } - }, - "outputPorts" : { - "type" : "array", - "description" : "The output ports in this flow.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/PortEntity" - } - }, - "connections" : { - "type" : "array", - "description" : "The connections in this flow.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ConnectionEntity" - } - }, - "labels" : { - "type" : "array", - "description" : "The labels in this flow.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/LabelEntity" - } - }, - "funnels" : { - "type" : "array", - "description" : "The funnels in this flow.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/FunnelEntity" - } - } - } - }, - "FlowEntity" : { - "type" : "object", - "properties" : { - "flow" : { - "$ref" : "#/definitions/FlowDTO" - } - }, - "xml" : { - "name" : "flowEntity" - } - }, - "FlowFileDTO" : { - "type" : "object", - "properties" : { - "uri" : { - "type" : "string", - "description" : "The URI that can be used to access this FlowFile." - }, - "uuid" : { - "type" : "string", - "description" : "The FlowFile UUID." - }, - "filename" : { - "type" : "string", - "description" : "The FlowFile filename." - }, - "position" : { - "type" : "integer", - "format" : "int32", - "description" : "The FlowFile's position in the queue." - }, - "size" : { - "type" : "integer", - "format" : "int64", - "description" : "The FlowFile file size." - }, - "queuedDuration" : { - "type" : "integer", - "format" : "int64", - "description" : "How long this FlowFile has been enqueued." - }, - "lineageDuration" : { - "type" : "integer", - "format" : "int64", - "description" : "Duration since the FlowFile's greatest ancestor entered the flow." - }, - "penaltyExpiresIn" : { - "type" : "integer", - "format" : "int64", - "description" : "How long in milliseconds until the FlowFile penalty expires." - }, - "clusterNodeId" : { - "type" : "string", - "description" : "The id of the node where this FlowFile resides." - }, - "clusterNodeAddress" : { - "type" : "string", - "description" : "The label for the node where this FlowFile resides." - }, - "attributes" : { - "type" : "object", - "description" : "The FlowFile attributes.", - "additionalProperties" : { - "type" : "string" - } - }, - "contentClaimSection" : { - "type" : "string", - "description" : "The section in which the content claim lives." - }, - "contentClaimContainer" : { - "type" : "string", - "description" : "The container in which the content claim lives." - }, - "contentClaimIdentifier" : { - "type" : "string", - "description" : "The identifier of the content claim." - }, - "contentClaimOffset" : { - "type" : "integer", - "format" : "int64", - "description" : "The offset into the content claim where the flowfile's content begins." - }, - "contentClaimFileSize" : { - "type" : "string", - "description" : "The file size of the content claim formatted." - }, - "contentClaimFileSizeBytes" : { - "type" : "integer", - "format" : "int64", - "description" : "The file size of the content claim in bytes." - }, - "penalized" : { - "type" : "boolean", - "description" : "If the FlowFile is penalized." - } - } - }, - "FlowFileEntity" : { - "type" : "object", - "properties" : { - "flowFile" : { - "$ref" : "#/definitions/FlowFileDTO" - } - }, - "xml" : { - "name" : "flowFileEntity" - } - }, - "FlowFileSummaryDTO" : { - "type" : "object", - "properties" : { - "uri" : { - "type" : "string", - "description" : "The URI that can be used to access this FlowFile." - }, - "uuid" : { - "type" : "string", - "description" : "The FlowFile UUID." - }, - "filename" : { - "type" : "string", - "description" : "The FlowFile filename." - }, - "position" : { - "type" : "integer", - "format" : "int32", - "description" : "The FlowFile's position in the queue." - }, - "size" : { - "type" : "integer", - "format" : "int64", - "description" : "The FlowFile file size." - }, - "queuedDuration" : { - "type" : "integer", - "format" : "int64", - "description" : "How long this FlowFile has been enqueued." - }, - "lineageDuration" : { - "type" : "integer", - "format" : "int64", - "description" : "Duration since the FlowFile's greatest ancestor entered the flow." - }, - "penaltyExpiresIn" : { - "type" : "integer", - "format" : "int64", - "description" : "How long in milliseconds until the FlowFile penalty expires." - }, - "clusterNodeId" : { - "type" : "string", - "description" : "The id of the node where this FlowFile resides." - }, - "clusterNodeAddress" : { - "type" : "string", - "description" : "The label for the node where this FlowFile resides." - }, - "penalized" : { - "type" : "boolean", - "description" : "If the FlowFile is penalized." - } - } - }, - "FlowSnippetDTO" : { - "type" : "object", - "properties" : { - "processGroups" : { - "type" : "array", - "description" : "The process groups in this flow snippet.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ProcessGroupDTO" - } - }, - "remoteProcessGroups" : { - "type" : "array", - "description" : "The remote process groups in this flow snippet.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/RemoteProcessGroupDTO" - } - }, - "processors" : { - "type" : "array", - "description" : "The processors in this flow snippet.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ProcessorDTO" - } - }, - "inputPorts" : { - "type" : "array", - "description" : "The input ports in this flow snippet.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/PortDTO" - } - }, - "outputPorts" : { - "type" : "array", - "description" : "The output ports in this flow snippet.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/PortDTO" - } - }, - "connections" : { - "type" : "array", - "description" : "The connections in this flow snippet.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ConnectionDTO" - } - }, - "labels" : { - "type" : "array", - "description" : "The labels in this flow snippet.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/LabelDTO" - } - }, - "funnels" : { - "type" : "array", - "description" : "The funnels in this flow snippet.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/FunnelDTO" - } - }, - "controllerServices" : { - "type" : "array", - "description" : "The controller services in this flow snippet.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ControllerServiceDTO" - } - } - } - }, - "FunnelDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "versionedComponentId" : { - "type" : "string", - "description" : "The ID of the corresponding component that is under version control" - }, - "parentGroupId" : { - "type" : "string", - "description" : "The id of parent process group of this component if applicable." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - } - } - }, - "FunnelEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "component" : { - "$ref" : "#/definitions/FunnelDTO" - } - }, - "xml" : { - "name" : "funnelEntity" - } - }, - "FunnelsEntity" : { - "type" : "object", - "properties" : { - "funnels" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/FunnelEntity" - } - } - }, - "xml" : { - "name" : "funnelsEntity" - } - }, - "GarbageCollectionDTO" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The name of the garbage collector." - }, - "collectionCount" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of times garbage collection has run." - }, - "collectionTime" : { - "type" : "string", - "description" : "The total amount of time spent garbage collecting." - }, - "collectionMillis" : { - "type" : "integer", - "format" : "int64", - "description" : "The total number of milliseconds spent garbage collecting." - } - } - }, - "HistoryDTO" : { - "type" : "object", - "properties" : { - "total" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of number of actions that matched the search criteria.." - }, - "lastRefreshed" : { - "type" : "string", - "description" : "The timestamp when the report was generated." - }, - "actions" : { - "type" : "array", - "description" : "The actions.", - "items" : { - "$ref" : "#/definitions/ActionEntity" - } - } - } - }, - "HistoryEntity" : { - "type" : "object", - "properties" : { - "history" : { - "$ref" : "#/definitions/HistoryDTO" - } - }, - "xml" : { - "name" : "historyEntity" - } - }, - "InputPortsEntity" : { - "type" : "object", - "properties" : { - "inputPorts" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/PortEntity" - } - } - }, - "xml" : { - "name" : "inputPortsEntity" - } - }, - "InstantiateTemplateRequestEntity" : { - "type" : "object", - "properties" : { - "originX" : { - "type" : "number", - "format" : "double", - "description" : "The x coordinate of the origin of the bounding box where the new components will be placed." - }, - "originY" : { - "type" : "number", - "format" : "double", - "description" : "The y coordinate of the origin of the bounding box where the new components will be placed." - }, - "templateId" : { - "type" : "string", - "description" : "The identifier of the template." - }, - "encodingVersion" : { - "type" : "string", - "description" : "The encoding version of the flow snippet. If not specified, this is automatically populated by the node receiving the user request. If the snippet is specified, the version will be the latest. If the snippet is not specified, the version will come from the underlying template. These details need to be replicated throughout the cluster to ensure consistency." - }, - "snippet" : { - "description" : "A flow snippet of the template contents. If not specified, this is automatically populated by the node receiving the user request. These details need to be replicated throughout the cluster to ensure consistency.", - "$ref" : "#/definitions/FlowSnippetDTO" - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - } - }, - "xml" : { - "name" : "instantiateTemplateRequestEntity" - } - }, - "LabelDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "versionedComponentId" : { - "type" : "string", - "description" : "The ID of the corresponding component that is under version control" - }, - "parentGroupId" : { - "type" : "string", - "description" : "The id of parent process group of this component if applicable." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "label" : { - "type" : "string", - "description" : "The text that appears in the label." - }, - "width" : { - "type" : "number", - "format" : "double", - "description" : "The width of the label in pixels when at a 1:1 scale." - }, - "height" : { - "type" : "number", - "format" : "double", - "description" : "The height of the label in pixels when at a 1:1 scale." - }, - "style" : { - "type" : "object", - "description" : "The styles for this label (font-size : 12px, background-color : #eee, etc).", - "additionalProperties" : { - "type" : "string" - } - } - } - }, - "LabelEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "dimensions" : { - "$ref" : "#/definitions/DimensionsDTO" - }, - "component" : { - "$ref" : "#/definitions/LabelDTO" - } - }, - "xml" : { - "name" : "labelEntity" - } - }, - "LabelsEntity" : { - "type" : "object", - "properties" : { - "labels" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/LabelEntity" - } - } - }, - "xml" : { - "name" : "labelsEntity" - } - }, - "LineageDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of this lineage query." - }, - "uri" : { - "type" : "string", - "description" : "The URI for this lineage query for later retrieval and deletion." - }, - "submissionTime" : { - "type" : "string", - "description" : "When the lineage query was submitted." - }, - "expiration" : { - "type" : "string", - "description" : "When the lineage query will expire." - }, - "percentCompleted" : { - "type" : "integer", - "format" : "int32", - "description" : "The percent complete for the lineage query." - }, - "finished" : { - "type" : "boolean", - "description" : "Whether the lineage query has finished." - }, - "request" : { - "description" : "The initial lineage result.", - "$ref" : "#/definitions/LineageRequestDTO" - }, - "results" : { - "description" : "The results of the lineage query.", - "$ref" : "#/definitions/LineageResultsDTO" - } - } - }, - "LineageEntity" : { - "type" : "object", - "properties" : { - "lineage" : { - "$ref" : "#/definitions/LineageDTO" - } - }, - "xml" : { - "name" : "lineageEntity" - } - }, - "LineageRequestDTO" : { - "type" : "object", - "properties" : { - "eventId" : { - "type" : "integer", - "format" : "int64", - "description" : "The event id that was used to generate this lineage, if applicable. The event id is allowed for any type of lineageRequestType. If the lineageRequestType is FLOWFILE and the flowfile uuid is also included in the request, the event id will be ignored." - }, - "lineageRequestType" : { - "type" : "string", - "description" : "The type of lineage request. PARENTS will return the lineage for the flowfiles that are parents of the specified event. CHILDREN will return the lineage for the flowfiles that are children of the specified event. FLOWFILE will return the lineage for the specified flowfile.", - "enum" : [ "PARENTS", "CHILDREN", "and FLOWFILE" ] - }, - "uuid" : { - "type" : "string", - "description" : "The flowfile uuid that was used to generate the lineage. The flowfile uuid is only allowed when the lineageRequestType is FLOWFILE and will take precedence over event id." - }, - "clusterNodeId" : { - "type" : "string", - "description" : "The id of the node where this lineage originated if clustered." - } - } - }, - "LineageResultsDTO" : { - "type" : "object", - "properties" : { - "errors" : { - "type" : "array", - "description" : "Any errors that occurred while generating the lineage.", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - }, - "nodes" : { - "type" : "array", - "description" : "The nodes in the lineage.", - "items" : { - "$ref" : "#/definitions/ProvenanceNodeDTO" - } - }, - "links" : { - "type" : "array", - "description" : "The links between the nodes in the lineage.", - "items" : { - "$ref" : "#/definitions/ProvenanceLinkDTO" - } - } - } - }, - "Link" : { - "type" : "object", - "properties" : { - "type" : { - "type" : "string" - }, - "title" : { - "type" : "string" - }, - "rel" : { - "type" : "string" - }, - "rels" : { - "type" : "array", - "items" : { - "type" : "string" - } - }, - "uriBuilder" : { - "$ref" : "#/definitions/UriBuilder" - }, - "params" : { - "type" : "object", - "additionalProperties" : { - "type" : "string" - } - }, - "uri" : { - "type" : "string", - "format" : "uri" - } - } - }, - "ListingRequestDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id for this listing request." - }, - "uri" : { - "type" : "string", - "description" : "The URI for future requests to this listing request." - }, - "submissionTime" : { - "type" : "string", - "description" : "The timestamp when the query was submitted." - }, - "lastUpdated" : { - "type" : "string", - "description" : "The last time this listing request was updated." - }, - "percentCompleted" : { - "type" : "integer", - "format" : "int32", - "description" : "The current percent complete." - }, - "finished" : { - "type" : "boolean", - "description" : "Whether the query has finished." - }, - "failureReason" : { - "type" : "string", - "description" : "The reason, if any, that this listing request failed." - }, - "maxResults" : { - "type" : "integer", - "format" : "int32", - "description" : "The maximum number of FlowFileSummary objects to return" - }, - "state" : { - "type" : "string", - "description" : "The current state of the listing request." - }, - "queueSize" : { - "description" : "The size of the queue", - "$ref" : "#/definitions/QueueSizeDTO" - }, - "flowFileSummaries" : { - "type" : "array", - "description" : "The FlowFile summaries. The summaries will be populated once the request has completed.", - "items" : { - "$ref" : "#/definitions/FlowFileSummaryDTO" - } - }, - "sourceRunning" : { - "type" : "boolean", - "description" : "Whether the source of the connection is running" - }, - "destinationRunning" : { - "type" : "boolean", - "description" : "Whether the destination of the connection is running" - } - } - }, - "ListingRequestEntity" : { - "type" : "object", - "properties" : { - "listingRequest" : { - "$ref" : "#/definitions/ListingRequestDTO" - } - }, - "xml" : { - "name" : "listingRequestEntity" - } - }, - "NodeConnectionStatusSnapshotDTO" : { - "type" : "object", - "properties" : { - "nodeId" : { - "type" : "string", - "description" : "The unique ID that identifies the node" - }, - "address" : { - "type" : "string", - "description" : "The API address of the node" - }, - "apiPort" : { - "type" : "integer", - "format" : "int32", - "description" : "The API port used to communicate with the node" - }, - "statusSnapshot" : { - "description" : "The connection status snapshot from the node.", - "$ref" : "#/definitions/ConnectionStatusSnapshotDTO" - } - } - }, - "NodeCountersSnapshotDTO" : { - "type" : "object", - "properties" : { - "nodeId" : { - "type" : "string", - "description" : "The unique ID that identifies the node" - }, - "address" : { - "type" : "string", - "description" : "The API address of the node" - }, - "apiPort" : { - "type" : "integer", - "format" : "int32", - "description" : "The API port used to communicate with the node" - }, - "snapshot" : { - "description" : "The counters from the node.", - "$ref" : "#/definitions/CountersSnapshotDTO" - } - } - }, - "NodeDTO" : { - "type" : "object", - "properties" : { - "nodeId" : { - "type" : "string", - "description" : "The id of the node.", - "readOnly" : true - }, - "address" : { - "type" : "string", - "description" : "The node's host/ip address.", - "readOnly" : true - }, - "apiPort" : { - "type" : "integer", - "format" : "int32", - "description" : "The port the node is listening for API requests.", - "readOnly" : true - }, - "status" : { - "type" : "string", - "description" : "The node's status." - }, - "heartbeat" : { - "type" : "string", - "description" : "the time of the nodes's last heartbeat.", - "readOnly" : true - }, - "connectionRequested" : { - "type" : "string", - "description" : "The time of the node's last connection request.", - "readOnly" : true - }, - "roles" : { - "type" : "array", - "description" : "The roles of this node.", - "readOnly" : true, - "uniqueItems" : true, - "items" : { - "type" : "string" - } - }, - "activeThreadCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The active threads for the NiFi on the node.", - "readOnly" : true - }, - "queued" : { - "type" : "string", - "description" : "The queue the NiFi on the node.", - "readOnly" : true - }, - "events" : { - "type" : "array", - "description" : "The node's events.", - "readOnly" : true, - "items" : { - "$ref" : "#/definitions/NodeEventDTO" - } - }, - "nodeStartTime" : { - "type" : "string", - "description" : "The time at which this Node was last refreshed.", - "readOnly" : true - } - } - }, - "NodeEntity" : { - "type" : "object", - "properties" : { - "node" : { - "$ref" : "#/definitions/NodeDTO" - } - }, - "xml" : { - "name" : "nodeEntity" - } - }, - "NodeEventDTO" : { - "type" : "object", - "properties" : { - "timestamp" : { - "type" : "string", - "description" : "The timestamp of the node event." - }, - "category" : { - "type" : "string", - "description" : "The category of the node event." - }, - "message" : { - "type" : "string", - "description" : "The message in the node event." - } - } - }, - "NodePortStatusSnapshotDTO" : { - "type" : "object", - "properties" : { - "nodeId" : { - "type" : "string", - "description" : "The unique ID that identifies the node" - }, - "address" : { - "type" : "string", - "description" : "The API address of the node" - }, - "apiPort" : { - "type" : "integer", - "format" : "int32", - "description" : "The API port used to communicate with the node" - }, - "statusSnapshot" : { - "description" : "The port status snapshot from the node.", - "$ref" : "#/definitions/PortStatusSnapshotDTO" - } - } - }, - "NodeProcessGroupStatusSnapshotDTO" : { - "type" : "object", - "properties" : { - "nodeId" : { - "type" : "string", - "description" : "The unique ID that identifies the node" - }, - "address" : { - "type" : "string", - "description" : "The API address of the node" - }, - "apiPort" : { - "type" : "integer", - "format" : "int32", - "description" : "The API port used to communicate with the node" - }, - "statusSnapshot" : { - "description" : "The process group status snapshot from the node.", - "$ref" : "#/definitions/ProcessGroupStatusSnapshotDTO" - } - } - }, - "NodeProcessorStatusSnapshotDTO" : { - "type" : "object", - "properties" : { - "nodeId" : { - "type" : "string", - "description" : "The unique ID that identifies the node" - }, - "address" : { - "type" : "string", - "description" : "The API address of the node" - }, - "apiPort" : { - "type" : "integer", - "format" : "int32", - "description" : "The API port used to communicate with the node" - }, - "statusSnapshot" : { - "description" : "The processor status snapshot from the node.", - "$ref" : "#/definitions/ProcessorStatusSnapshotDTO" - } - } - }, - "NodeRemoteProcessGroupStatusSnapshotDTO" : { - "type" : "object", - "properties" : { - "nodeId" : { - "type" : "string", - "description" : "The unique ID that identifies the node" - }, - "address" : { - "type" : "string", - "description" : "The API address of the node" - }, - "apiPort" : { - "type" : "integer", - "format" : "int32", - "description" : "The API port used to communicate with the node" - }, - "statusSnapshot" : { - "description" : "The remote process group status snapshot from the node.", - "$ref" : "#/definitions/RemoteProcessGroupStatusSnapshotDTO" - } - } - }, - "NodeSearchResultDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the node that matched the search." - }, - "address" : { - "type" : "string", - "description" : "The address of the node that matched the search." - } - } - }, - "NodeStatusSnapshotsDTO" : { - "type" : "object", - "properties" : { - "nodeId" : { - "type" : "string", - "description" : "The id of the node." - }, - "address" : { - "type" : "string", - "description" : "The node's host/ip address." - }, - "apiPort" : { - "type" : "integer", - "format" : "int32", - "description" : "The port the node is listening for API requests." - }, - "statusSnapshots" : { - "type" : "array", - "description" : "A list of StatusSnapshotDTO objects that provide the actual metric values for the component for this node.", - "items" : { - "$ref" : "#/definitions/StatusSnapshotDTO" - } - } - } - }, - "NodeSystemDiagnosticsSnapshotDTO" : { - "type" : "object", - "properties" : { - "nodeId" : { - "type" : "string", - "description" : "The unique ID that identifies the node" - }, - "address" : { - "type" : "string", - "description" : "The API address of the node" - }, - "apiPort" : { - "type" : "integer", - "format" : "int32", - "description" : "The API port used to communicate with the node" - }, - "snapshot" : { - "description" : "The System Diagnostics snapshot from the node.", - "$ref" : "#/definitions/SystemDiagnosticsSnapshotDTO" - } - } - }, - "OutputPortsEntity" : { - "type" : "object", - "properties" : { - "outputPorts" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/PortEntity" - } - } - }, - "xml" : { - "name" : "outputPortsEntity" - } - }, - "PeerDTO" : { - "type" : "object", - "properties" : { - "hostname" : { - "type" : "string", - "description" : "The hostname of this peer." - }, - "port" : { - "type" : "integer", - "format" : "int32", - "description" : "The port number of this peer." - }, - "secure" : { - "type" : "boolean", - "description" : "Returns if this peer connection is secure." - }, - "flowFileCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of flowFiles this peer holds." - } - } - }, - "PeersEntity" : { - "type" : "object", - "properties" : { - "peers" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/PeerDTO" - } - } - }, - "xml" : { - "name" : "peersEntity" - } - }, - "PermissionsDTO" : { - "type" : "object", - "properties" : { - "canRead" : { - "type" : "boolean", - "description" : "Indicates whether the user can read a given resource.", - "readOnly" : true - }, - "canWrite" : { - "type" : "boolean", - "description" : "Indicates whether the user can write a given resource.", - "readOnly" : true - } - } - }, - "PortDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "versionedComponentId" : { - "type" : "string", - "description" : "The ID of the corresponding component that is under version control" - }, - "parentGroupId" : { - "type" : "string", - "description" : "The id of parent process group of this component if applicable." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "name" : { - "type" : "string", - "description" : "The name of the port." - }, - "comments" : { - "type" : "string", - "description" : "The comments for the port." - }, - "state" : { - "type" : "string", - "description" : "The state of the port.", - "enum" : [ "RUNNING", "STOPPED", "DISABLED" ] - }, - "type" : { - "type" : "string", - "description" : "The type of port.", - "enum" : [ "INPUT_PORT", "OUTPUT_PORT" ] - }, - "transmitting" : { - "type" : "boolean", - "description" : "Whether the port has incoming or output connections to a remote NiFi. This is only applicable when the port is running in the root group." - }, - "concurrentlySchedulableTaskCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of tasks that should be concurrently scheduled for the port." - }, - "userAccessControl" : { - "type" : "array", - "description" : "The users that are allowed to access the port.", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - }, - "groupAccessControl" : { - "type" : "array", - "description" : "The user groups that are allowed to access the port.", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - }, - "validationErrors" : { - "type" : "array", - "description" : "Gets the validation errors from this port. These validation errors represent the problems with the port that must be resolved before it can be started.", - "items" : { - "type" : "string" - } - } - } - }, - "PortEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "component" : { - "$ref" : "#/definitions/PortDTO" - }, - "status" : { - "description" : "The status of the port.", - "$ref" : "#/definitions/PortStatusDTO" - }, - "portType" : { - "type" : "string" - }, - "operatePermissions" : { - "description" : "The permissions for this component operations.", - "$ref" : "#/definitions/PermissionsDTO" - } - }, - "xml" : { - "name" : "portEntity" - } - }, - "PortRunStatusEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "state" : { - "type" : "string", - "description" : "The run status of the Port.", - "enum" : [ "RUNNING", "STOPPED", "DISABLED" ] - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - } - }, - "xml" : { - "name" : "entity" - } - }, - "PortStatusDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the port." - }, - "groupId" : { - "type" : "string", - "description" : "The id of the parent process group of the port." - }, - "name" : { - "type" : "string", - "description" : "The name of the port." - }, - "transmitting" : { - "type" : "boolean", - "description" : "Whether the port has incoming or outgoing connections to a remote NiFi." - }, - "runStatus" : { - "type" : "string", - "description" : "The run status of the port.", - "enum" : [ "Running", "Stopped", "Validating", "Disabled", "Invalid" ] - }, - "statsLastRefreshed" : { - "type" : "string", - "description" : "The time the status for the process group was last refreshed." - }, - "aggregateSnapshot" : { - "description" : "A status snapshot that represents the aggregate stats of all nodes in the cluster. If the NiFi instance is a standalone instance, rather than a cluster, this represents the stats of the single instance.", - "$ref" : "#/definitions/PortStatusSnapshotDTO" - }, - "nodeSnapshots" : { - "type" : "array", - "description" : "A status snapshot for each node in the cluster. If the NiFi instance is a standalone instance, rather than a cluster, this may be null.", - "items" : { - "$ref" : "#/definitions/NodePortStatusSnapshotDTO" - } - } - } - }, - "PortStatusEntity" : { - "type" : "object", - "properties" : { - "portStatus" : { - "$ref" : "#/definitions/PortStatusDTO" - }, - "canRead" : { - "type" : "boolean", - "description" : "Indicates whether the user can read a given resource.", - "readOnly" : true - } - }, - "xml" : { - "name" : "portStatusEntity" - } - }, - "PortStatusSnapshotDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the port." - }, - "groupId" : { - "type" : "string", - "description" : "The id of the parent process group of the port." - }, - "name" : { - "type" : "string", - "description" : "The name of the port." - }, - "activeThreadCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The active thread count for the port." - }, - "flowFilesIn" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of FlowFiles that have been accepted in the last 5 minutes." - }, - "bytesIn" : { - "type" : "integer", - "format" : "int64", - "description" : "The size of hte FlowFiles that have been accepted in the last 5 minutes." - }, - "input" : { - "type" : "string", - "description" : "The count/size of flowfiles that have been accepted in the last 5 minutes." - }, - "flowFilesOut" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of FlowFiles that have been processed in the last 5 minutes." - }, - "bytesOut" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes that have been processed in the last 5 minutes." - }, - "output" : { - "type" : "string", - "description" : "The count/size of flowfiles that have been processed in the last 5 minutes." - }, - "transmitting" : { - "type" : "boolean", - "description" : "Whether the port has incoming or outgoing connections to a remote NiFi." - }, - "runStatus" : { - "type" : "string", - "description" : "The run status of the port.", - "enum" : [ "Running", "Stopped", "Validating", "Disabled", "Invalid" ] - } - } - }, - "PortStatusSnapshotEntity" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the port." - }, - "portStatusSnapshot" : { - "$ref" : "#/definitions/PortStatusSnapshotDTO" - }, - "canRead" : { - "type" : "boolean", - "description" : "Indicates whether the user can read a given resource.", - "readOnly" : true - } - }, - "xml" : { - "name" : "entity" - } - }, - "Position" : { - "type" : "object", - "properties" : { - "x" : { - "type" : "number", - "format" : "double", - "description" : "The x coordinate." - }, - "y" : { - "type" : "number", - "format" : "double", - "description" : "The y coordinate." - } - }, - "description" : "The position of a component on the graph" - }, - "PositionDTO" : { - "type" : "object", - "properties" : { - "x" : { - "type" : "number", - "format" : "double", - "description" : "The x coordinate." - }, - "y" : { - "type" : "number", - "format" : "double", - "description" : "The y coordinate." - } - } - }, - "PreviousValueDTO" : { - "type" : "object", - "properties" : { - "previousValue" : { - "type" : "string", - "description" : "The previous value." - }, - "timestamp" : { - "type" : "string", - "description" : "The timestamp when the value was modified." - }, - "userIdentity" : { - "type" : "string", - "description" : "The user who changed the previous value." - } - } - }, - "PrioritizerTypesEntity" : { - "type" : "object", - "properties" : { - "prioritizerTypes" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/DocumentedTypeDTO" - } - } - }, - "xml" : { - "name" : "prioritizerTypesEntity" - } - }, - "ProcessGroupDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "versionedComponentId" : { - "type" : "string", - "description" : "The ID of the corresponding component that is under version control" - }, - "parentGroupId" : { - "type" : "string", - "description" : "The id of parent process group of this component if applicable." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "name" : { - "type" : "string", - "description" : "The name of the process group." - }, - "comments" : { - "type" : "string", - "description" : "The comments for the process group." - }, - "variables" : { - "type" : "object", - "description" : "The variables that are configured for the Process Group. Note that this map contains only those variables that are defined on this Process Group and not any variables that are defined in the parent Process Group, etc. I.e., this Map will not contain all variables that are accessible by components in this Process Group by rather only the variables that are defined for this Process Group itself.", - "readOnly" : true, - "additionalProperties" : { - "type" : "string" - } - }, - "versionControlInformation" : { - "description" : "The Version Control information that indicates which Flow Registry, and where in the Flow Registry, this Process Group is tracking to; or null if this Process Group is not under version control", - "$ref" : "#/definitions/VersionControlInformationDTO" - }, - "runningCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of running components in this process group." - }, - "stoppedCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of stopped components in the process group." - }, - "invalidCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of invalid components in the process group." - }, - "disabledCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of disabled components in the process group." - }, - "activeRemotePortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of active remote ports in the process group." - }, - "inactiveRemotePortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of inactive remote ports in the process group." - }, - "upToDateCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of up to date versioned process groups in the process group." - }, - "locallyModifiedCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of locally modified versioned process groups in the process group." - }, - "staleCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of stale versioned process groups in the process group." - }, - "locallyModifiedAndStaleCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of locally modified and stale versioned process groups in the process group." - }, - "syncFailureCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of versioned process groups in the process group that are unable to sync to a registry." - }, - "inputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of input ports in the process group." - }, - "outputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of output ports in the process group." - }, - "contents" : { - "description" : "The contents of this process group.", - "$ref" : "#/definitions/FlowSnippetDTO" - } - } - }, - "ProcessGroupEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "component" : { - "$ref" : "#/definitions/ProcessGroupDTO" - }, - "status" : { - "description" : "The status of the process group.", - "$ref" : "#/definitions/ProcessGroupStatusDTO" - }, - "versionedFlowSnapshot" : { - "description" : "Returns the Versioned Flow that describes the contents of the Versioned Flow to be imported", - "readOnly" : true, - "$ref" : "#/definitions/versionedFlowSnapshot" - }, - "runningCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of running components in this process group." - }, - "stoppedCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of stopped components in the process group." - }, - "invalidCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of invalid components in the process group." - }, - "disabledCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of disabled components in the process group." - }, - "activeRemotePortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of active remote ports in the process group." - }, - "inactiveRemotePortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of inactive remote ports in the process group." - }, - "versionedFlowState" : { - "type" : "string", - "description" : "The current state of the Process Group, as it relates to the Versioned Flow", - "readOnly" : true, - "enum" : [ "LOCALLY_MODIFIED", "STALE", "LOCALLY_MODIFIED_AND_STALE", "UP_TO_DATE", "SYNC_FAILURE" ] - }, - "upToDateCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of up to date versioned process groups in the process group." - }, - "locallyModifiedCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of locally modified versioned process groups in the process group." - }, - "staleCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of stale versioned process groups in the process group." - }, - "locallyModifiedAndStaleCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of locally modified and stale versioned process groups in the process group." - }, - "syncFailureCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of versioned process groups in the process group that are unable to sync to a registry." - }, - "inputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of input ports in the process group." - }, - "outputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of output ports in the process group." - } - }, - "xml" : { - "name" : "processGroupEntity" - } - }, - "ProcessGroupFlowDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "parentGroupId" : { - "type" : "string", - "description" : "The id of parent process group of this component if applicable." - }, - "breadcrumb" : { - "description" : "The breadcrumb of the process group.", - "$ref" : "#/definitions/FlowBreadcrumbEntity" - }, - "flow" : { - "description" : "The flow structure starting at this Process Group.", - "$ref" : "#/definitions/FlowDTO" - }, - "lastRefreshed" : { - "type" : "string", - "description" : "The time the flow for the process group was last refreshed." - } - } - }, - "ProcessGroupFlowEntity" : { - "type" : "object", - "properties" : { - "permissions" : { - "description" : "The access policy for this process group.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "processGroupFlow" : { - "$ref" : "#/definitions/ProcessGroupFlowDTO" - } - }, - "xml" : { - "name" : "processGroupFlowEntity" - } - }, - "ProcessGroupStatusDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The ID of the Process Group" - }, - "name" : { - "type" : "string", - "description" : "The name of the Process Group" - }, - "statsLastRefreshed" : { - "type" : "string", - "description" : "The time the status for the process group was last refreshed." - }, - "aggregateSnapshot" : { - "description" : "The aggregate status of all nodes in the cluster", - "$ref" : "#/definitions/ProcessGroupStatusSnapshotDTO" - }, - "nodeSnapshots" : { - "type" : "array", - "description" : "The status reported by each node in the cluster. If the NiFi instance is a standalone instance, rather than a clustered instance, this value may be null.", - "items" : { - "$ref" : "#/definitions/NodeProcessGroupStatusSnapshotDTO" - } - } - } - }, - "ProcessGroupStatusEntity" : { - "type" : "object", - "properties" : { - "processGroupStatus" : { - "$ref" : "#/definitions/ProcessGroupStatusDTO" - }, - "canRead" : { - "type" : "boolean", - "description" : "Indicates whether the user can read a given resource.", - "readOnly" : true - } - }, - "xml" : { - "name" : "processGroupStatusEntity" - } - }, - "ProcessGroupStatusSnapshotDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the process group." - }, - "name" : { - "type" : "string", - "description" : "The name of this process group." - }, - "connectionStatusSnapshots" : { - "type" : "array", - "description" : "The status of all connections in the process group.", - "items" : { - "$ref" : "#/definitions/ConnectionStatusSnapshotEntity" - } - }, - "processorStatusSnapshots" : { - "type" : "array", - "description" : "The status of all processors in the process group.", - "items" : { - "$ref" : "#/definitions/ProcessorStatusSnapshotEntity" - } - }, - "processGroupStatusSnapshots" : { - "type" : "array", - "description" : "The status of all process groups in the process group.", - "items" : { - "$ref" : "#/definitions/ProcessGroupStatusSnapshotEntity" - } - }, - "remoteProcessGroupStatusSnapshots" : { - "type" : "array", - "description" : "The status of all remote process groups in the process group.", - "items" : { - "$ref" : "#/definitions/RemoteProcessGroupStatusSnapshotEntity" - } - }, - "inputPortStatusSnapshots" : { - "type" : "array", - "description" : "The status of all input ports in the process group.", - "items" : { - "$ref" : "#/definitions/PortStatusSnapshotEntity" - } - }, - "outputPortStatusSnapshots" : { - "type" : "array", - "description" : "The status of all output ports in the process group.", - "items" : { - "$ref" : "#/definitions/PortStatusSnapshotEntity" - } - }, - "versionedFlowState" : { - "type" : "string", - "description" : "The current state of the Process Group, as it relates to the Versioned Flow", - "readOnly" : true, - "enum" : [ "LOCALLY_MODIFIED", "STALE", "LOCALLY_MODIFIED_AND_STALE", "UP_TO_DATE", "SYNC_FAILURE" ] - }, - "flowFilesIn" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of FlowFiles that have come into this ProcessGroup in the last 5 minutes" - }, - "bytesIn" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes that have come into this ProcessGroup in the last 5 minutes" - }, - "input" : { - "type" : "string", - "description" : "The input count/size for the process group in the last 5 minutes (pretty printed)." - }, - "flowFilesQueued" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of FlowFiles that are queued up in this ProcessGroup right now" - }, - "bytesQueued" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes that are queued up in this ProcessGroup right now" - }, - "queued" : { - "type" : "string", - "description" : "The count/size that is queued in the the process group." - }, - "queuedCount" : { - "type" : "string", - "description" : "The count that is queued for the process group." - }, - "queuedSize" : { - "type" : "string", - "description" : "The size that is queued for the process group." - }, - "bytesRead" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes read by components in this ProcessGroup in the last 5 minutes" - }, - "read" : { - "type" : "string", - "description" : "The number of bytes read in the last 5 minutes." - }, - "bytesWritten" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes written by components in this ProcessGroup in the last 5 minutes" - }, - "written" : { - "type" : "string", - "description" : "The number of bytes written in the last 5 minutes." - }, - "flowFilesOut" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of FlowFiles transferred out of this ProcessGroup in the last 5 minutes" - }, - "bytesOut" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes transferred out of this ProcessGroup in the last 5 minutes" - }, - "output" : { - "type" : "string", - "description" : "The output count/size for the process group in the last 5 minutes." - }, - "flowFilesTransferred" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of FlowFiles transferred in this ProcessGroup in the last 5 minutes" - }, - "bytesTransferred" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes transferred in this ProcessGroup in the last 5 minutes" - }, - "transferred" : { - "type" : "string", - "description" : "The count/size transferred to/from queues in the process group in the last 5 minutes." - }, - "bytesReceived" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes received from external sources by components within this ProcessGroup in the last 5 minutes" - }, - "flowFilesReceived" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of FlowFiles received from external sources by components within this ProcessGroup in the last 5 minutes" - }, - "received" : { - "type" : "string", - "description" : "The count/size sent to the process group in the last 5 minutes." - }, - "bytesSent" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes sent to an external sink by components within this ProcessGroup in the last 5 minutes" - }, - "flowFilesSent" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of FlowFiles sent to an external sink by components within this ProcessGroup in the last 5 minutes" - }, - "sent" : { - "type" : "string", - "description" : "The count/size sent from this process group in the last 5 minutes." - }, - "activeThreadCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The active thread count for this process group." - }, - "terminatedThreadCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of threads currently terminated for the process group." - } - } - }, - "ProcessGroupStatusSnapshotEntity" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the process group." - }, - "processGroupStatusSnapshot" : { - "$ref" : "#/definitions/ProcessGroupStatusSnapshotDTO" - }, - "canRead" : { - "type" : "boolean", - "description" : "Indicates whether the user can read a given resource.", - "readOnly" : true - } - }, - "xml" : { - "name" : "entity" - } - }, - "ProcessGroupsEntity" : { - "type" : "object", - "properties" : { - "processGroups" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ProcessGroupEntity" - } - } - }, - "xml" : { - "name" : "processGroupsEntity" - } - }, - "ProcessorConfigDTO" : { - "type" : "object", - "properties" : { - "properties" : { - "type" : "object", - "description" : "The properties for the processor. Properties whose value is not set will only contain the property name.", - "additionalProperties" : { - "type" : "string" - } - }, - "descriptors" : { - "type" : "object", - "description" : "Descriptors for the processor's properties.", - "additionalProperties" : { - "$ref" : "#/definitions/PropertyDescriptorDTO" - } - }, - "schedulingPeriod" : { - "type" : "string", - "description" : "The frequency with which to schedule the processor. The format of the value will depend on th value of schedulingStrategy." - }, - "schedulingStrategy" : { - "type" : "string", - "description" : "Indcates whether the prcessor should be scheduled to run in event or timer driven mode." - }, - "executionNode" : { - "type" : "string", - "description" : "Indicates the node where the process will execute." - }, - "penaltyDuration" : { - "type" : "string", - "description" : "The amount of time that is used when the process penalizes a flowfile." - }, - "yieldDuration" : { - "type" : "string", - "description" : "The amount of time that must elapse before this processor is scheduled again after yielding." - }, - "bulletinLevel" : { - "type" : "string", - "description" : "The level at which the processor will report bulletins." - }, - "runDurationMillis" : { - "type" : "integer", - "format" : "int64", - "description" : "The run duration for the processor in milliseconds." - }, - "concurrentlySchedulableTaskCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of tasks that should be concurrently schedule for the processor. If the processor doesn't allow parallol processing then any positive input will be ignored." - }, - "autoTerminatedRelationships" : { - "type" : "array", - "description" : "The names of all relationships that cause a flow file to be terminated if the relationship is not connected elsewhere. This property differs from the 'isAutoTerminate' property of the RelationshipDTO in that the RelationshipDTO is meant to depict the current configuration, whereas this property can be set in a DTO when updating a Processor in order to change which Relationships should be auto-terminated.", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - }, - "comments" : { - "type" : "string", - "description" : "The comments for the processor." - }, - "customUiUrl" : { - "type" : "string", - "description" : "The URL for the processor's custom configuration UI if applicable." - }, - "lossTolerant" : { - "type" : "boolean", - "description" : "Whether the processor is loss tolerant." - }, - "annotationData" : { - "type" : "string", - "description" : "The annotation data for the processor used to relay configuration between a custom UI and the procesosr." - }, - "defaultConcurrentTasks" : { - "type" : "object", - "description" : "Maps default values for concurrent tasks for each applicable scheduling strategy.", - "additionalProperties" : { - "type" : "string" - } - }, - "defaultSchedulingPeriod" : { - "type" : "object", - "description" : "Maps default values for scheduling period for each applicable scheduling strategy.", - "additionalProperties" : { - "type" : "string" - } - } - } - }, - "ProcessorDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "versionedComponentId" : { - "type" : "string", - "description" : "The ID of the corresponding component that is under version control" - }, - "parentGroupId" : { - "type" : "string", - "description" : "The id of parent process group of this component if applicable." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "name" : { - "type" : "string", - "description" : "The name of the processor." - }, - "type" : { - "type" : "string", - "description" : "The type of the processor." - }, - "bundle" : { - "description" : "The details of the artifact that bundled this processor type.", - "$ref" : "#/definitions/BundleDTO" - }, - "state" : { - "type" : "string", - "description" : "The state of the processor", - "enum" : [ "RUNNING", "STOPPED", "DISABLED" ] - }, - "style" : { - "type" : "object", - "description" : "Styles for the processor (background-color : #eee).", - "additionalProperties" : { - "type" : "string" - } - }, - "relationships" : { - "type" : "array", - "description" : "The available relationships that the processor currently supports.", - "readOnly" : true, - "items" : { - "$ref" : "#/definitions/RelationshipDTO" - } - }, - "description" : { - "type" : "string", - "description" : "The description of the processor." - }, - "supportsParallelProcessing" : { - "type" : "boolean", - "description" : "Whether the processor supports parallel processing." - }, - "supportsEventDriven" : { - "type" : "boolean", - "description" : "Whether the processor supports event driven scheduling." - }, - "supportsBatching" : { - "type" : "boolean", - "description" : "Whether the processor supports batching. This makes the run duration settings available." - }, - "persistsState" : { - "type" : "boolean", - "description" : "Whether the processor persists state." - }, - "restricted" : { - "type" : "boolean", - "description" : "Whether the processor requires elevated privileges." - }, - "deprecated" : { - "type" : "boolean", - "description" : "Whether the processor has been deprecated." - }, - "executionNodeRestricted" : { - "type" : "boolean", - "description" : "Indicates if the execution node of a processor is restricted to run only on the primary node" - }, - "multipleVersionsAvailable" : { - "type" : "boolean", - "description" : "Whether the processor has multiple versions available." - }, - "inputRequirement" : { - "type" : "string", - "description" : "The input requirement for this processor." - }, - "config" : { - "description" : "The configuration details for the processor. These details will be included in a response if the verbose flag is included in a request.", - "$ref" : "#/definitions/ProcessorConfigDTO" - }, - "validationErrors" : { - "type" : "array", - "description" : "The validation errors for the processor. These validation errors represent the problems with the processor that must be resolved before it can be started.", - "items" : { - "type" : "string" - } - }, - "validationStatus" : { - "type" : "string", - "description" : "Indicates whether the Processor is valid, invalid, or still in the process of validating (i.e., it is unknown whether or not the Processor is valid)", - "readOnly" : true, - "enum" : [ "VALID", "INVALID", "VALIDATING" ] - }, - "extensionMissing" : { - "type" : "boolean", - "description" : "Whether the underlying extension is missing." - } - } - }, - "ProcessorEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "component" : { - "$ref" : "#/definitions/ProcessorDTO" - }, - "inputRequirement" : { - "type" : "string", - "description" : "The input requirement for this processor." - }, - "status" : { - "$ref" : "#/definitions/ProcessorStatusDTO" - }, - "operatePermissions" : { - "description" : "The permissions for this component operations.", - "$ref" : "#/definitions/PermissionsDTO" - } - }, - "xml" : { - "name" : "processorEntity" - } - }, - "ProcessorRunStatusEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "state" : { - "type" : "string", - "description" : "The run status of the Processor.", - "enum" : [ "RUNNING", "STOPPED", "DISABLED" ] - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - } - }, - "xml" : { - "name" : "entity" - } - }, - "ProcessorStatusDTO" : { - "type" : "object", - "properties" : { - "groupId" : { - "type" : "string", - "description" : "The unique ID of the process group that the Processor belongs to" - }, - "id" : { - "type" : "string", - "description" : "The unique ID of the Processor" - }, - "name" : { - "type" : "string", - "description" : "The name of the Processor" - }, - "type" : { - "type" : "string", - "description" : "The type of the Processor" - }, - "runStatus" : { - "type" : "string", - "description" : "The run status of the Processor", - "enum" : [ "Running", "Stopped", "Validating", "Disabled", "Invalid" ] - }, - "statsLastRefreshed" : { - "type" : "string", - "description" : "The timestamp of when the stats were last refreshed" - }, - "aggregateSnapshot" : { - "description" : "A status snapshot that represents the aggregate stats of all nodes in the cluster. If the NiFi instance is a standalone instance, rather than a cluster, this represents the stats of the single instance.", - "$ref" : "#/definitions/ProcessorStatusSnapshotDTO" - }, - "nodeSnapshots" : { - "type" : "array", - "description" : "A status snapshot for each node in the cluster. If the NiFi instance is a standalone instance, rather than a cluster, this may be null.", - "items" : { - "$ref" : "#/definitions/NodeProcessorStatusSnapshotDTO" - } - } - } - }, - "ProcessorStatusEntity" : { - "type" : "object", - "properties" : { - "processorStatus" : { - "$ref" : "#/definitions/ProcessorStatusDTO" - }, - "canRead" : { - "type" : "boolean", - "description" : "Indicates whether the user can read a given resource.", - "readOnly" : true - } - }, - "xml" : { - "name" : "processorStatusEntity" - } - }, - "ProcessorStatusSnapshotDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the processor." - }, - "groupId" : { - "type" : "string", - "description" : "The id of the parent process group to which the processor belongs." - }, - "name" : { - "type" : "string", - "description" : "The name of the prcessor." - }, - "type" : { - "type" : "string", - "description" : "The type of the processor." - }, - "runStatus" : { - "type" : "string", - "description" : "The state of the processor.", - "enum" : [ "Running", "Stopped", "Validating", "Disabled", "Invalid" ] - }, - "executionNode" : { - "type" : "string", - "description" : "Indicates the node where the process will execute.", - "enum" : [ "ALL", "PRIMARY" ] - }, - "bytesRead" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes read by this Processor in the last 5 mintues" - }, - "bytesWritten" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes written by this Processor in the last 5 minutes" - }, - "read" : { - "type" : "string", - "description" : "The number of bytes read in the last 5 minutes." - }, - "written" : { - "type" : "string", - "description" : "The number of bytes written in the last 5 minutes." - }, - "flowFilesIn" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of FlowFiles that have been accepted in the last 5 minutes" - }, - "bytesIn" : { - "type" : "integer", - "format" : "int64", - "description" : "The size of the FlowFiles that have been accepted in the last 5 minutes" - }, - "input" : { - "type" : "string", - "description" : "The count/size of flowfiles that have been accepted in the last 5 minutes." - }, - "flowFilesOut" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of FlowFiles transferred to a Connection in the last 5 minutes" - }, - "bytesOut" : { - "type" : "integer", - "format" : "int64", - "description" : "The size of the FlowFiles transferred to a Connection in the last 5 minutes" - }, - "output" : { - "type" : "string", - "description" : "The count/size of flowfiles that have been processed in the last 5 minutes." - }, - "taskCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of times this Processor has run in the last 5 minutes" - }, - "tasksDurationNanos" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of nanoseconds that this Processor has spent running in the last 5 minutes" - }, - "tasks" : { - "type" : "string", - "description" : "The total number of task this connectable has completed over the last 5 minutes." - }, - "tasksDuration" : { - "type" : "string", - "description" : "The total duration of all tasks for this connectable over the last 5 minutes." - }, - "activeThreadCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of threads currently executing in the processor." - }, - "terminatedThreadCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of threads currently terminated for the processor." - } - } - }, - "ProcessorStatusSnapshotEntity" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the processor." - }, - "processorStatusSnapshot" : { - "$ref" : "#/definitions/ProcessorStatusSnapshotDTO" - }, - "canRead" : { - "type" : "boolean", - "description" : "Indicates whether the user can read a given resource.", - "readOnly" : true - } - }, - "xml" : { - "name" : "entity" - } - }, - "ProcessorTypesEntity" : { - "type" : "object", - "properties" : { - "processorTypes" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/DocumentedTypeDTO" - } - } - }, - "xml" : { - "name" : "processorTypesEntity" - } - }, - "ProcessorsEntity" : { - "type" : "object", - "properties" : { - "processors" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ProcessorEntity" - } - } - }, - "xml" : { - "name" : "processorsEntity" - } - }, - "PropertyDescriptorDTO" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The name for the property." - }, - "displayName" : { - "type" : "string", - "description" : "The human readable name for the property." - }, - "description" : { - "type" : "string", - "description" : "The description for the property. Used to relay additional details to a user or provide a mechanism of documenting intent." - }, - "defaultValue" : { - "type" : "string", - "description" : "The default value for the property." - }, - "allowableValues" : { - "type" : "array", - "description" : "Allowable values for the property. If empty then the allowed values are not constrained.", - "items" : { - "$ref" : "#/definitions/AllowableValueEntity" - } - }, - "required" : { - "type" : "boolean", - "description" : "Whether the property is required." - }, - "sensitive" : { - "type" : "boolean", - "description" : "Whether the property is sensitive and protected whenever stored or represented." - }, - "dynamic" : { - "type" : "boolean", - "description" : "Whether the property is dynamic (user-defined)." - }, - "supportsEl" : { - "type" : "boolean", - "description" : "Whether the property supports expression language." - }, - "expressionLanguageScope" : { - "type" : "string", - "description" : "Scope of the Expression Language evaluation for the property." - }, - "identifiesControllerService" : { - "type" : "string", - "description" : "If the property identifies a controller service this returns the fully qualified type." - }, - "identifiesControllerServiceBundle" : { - "description" : "If the property identifies a controller service this returns the bundle of the type, null otherwise.", - "$ref" : "#/definitions/BundleDTO" - } - } - }, - "PropertyDescriptorEntity" : { - "type" : "object", - "properties" : { - "propertyDescriptor" : { - "$ref" : "#/definitions/PropertyDescriptorDTO" - } - }, - "xml" : { - "name" : "propertyDescriptor" - } - }, - "PropertyHistoryDTO" : { - "type" : "object", - "properties" : { - "previousValues" : { - "type" : "array", - "description" : "Previous values for a given property.", - "items" : { - "$ref" : "#/definitions/PreviousValueDTO" - } - } - } - }, - "ProvenanceDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the provenance query." - }, - "uri" : { - "type" : "string", - "description" : "The URI for this query. Used for obtaining/deleting the request at a later time" - }, - "submissionTime" : { - "type" : "string", - "description" : "The timestamp when the query was submitted." - }, - "expiration" : { - "type" : "string", - "description" : "The timestamp when the query will expire." - }, - "percentCompleted" : { - "type" : "integer", - "format" : "int32", - "description" : "The current percent complete." - }, - "finished" : { - "type" : "boolean", - "description" : "Whether the query has finished." - }, - "request" : { - "description" : "The provenance request.", - "$ref" : "#/definitions/ProvenanceRequestDTO" - }, - "results" : { - "description" : "The provenance results.", - "$ref" : "#/definitions/ProvenanceResultsDTO" - } - } - }, - "ProvenanceEntity" : { - "type" : "object", - "properties" : { - "provenance" : { - "$ref" : "#/definitions/ProvenanceDTO" - } - }, - "xml" : { - "name" : "provenanceEntity" - } - }, - "ProvenanceEventDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The event uuid." - }, - "eventId" : { - "type" : "integer", - "format" : "int64", - "description" : "The event id. This is a one up number thats unique per node." - }, - "eventTime" : { - "type" : "string", - "description" : "The timestamp of the event." - }, - "eventDuration" : { - "type" : "integer", - "format" : "int64", - "description" : "The event duration in milliseconds." - }, - "lineageDuration" : { - "type" : "integer", - "format" : "int64", - "description" : "The duration since the lineage began, in milliseconds." - }, - "eventType" : { - "type" : "string", - "description" : "The type of the event." - }, - "flowFileUuid" : { - "type" : "string", - "description" : "The uuid of the flowfile for the event." - }, - "fileSize" : { - "type" : "string", - "description" : "The size of the flowfile for the event." - }, - "fileSizeBytes" : { - "type" : "integer", - "format" : "int64", - "description" : "The size of the flowfile in bytes for the event." - }, - "clusterNodeId" : { - "type" : "string", - "description" : "The identifier for the node where the event originated." - }, - "clusterNodeAddress" : { - "type" : "string", - "description" : "The label for the node where the event originated." - }, - "groupId" : { - "type" : "string", - "description" : "The id of the group that the component resides in. If the component is no longer in the flow, the group id will not be set." - }, - "componentId" : { - "type" : "string", - "description" : "The id of the component that generated the event." - }, - "componentType" : { - "type" : "string", - "description" : "The type of the component that generated the event." - }, - "componentName" : { - "type" : "string", - "description" : "The name of the component that generated the event." - }, - "sourceSystemFlowFileId" : { - "type" : "string", - "description" : "The source system flowfile id." - }, - "alternateIdentifierUri" : { - "type" : "string", - "description" : "The alternate identifier uri for the fileflow for the event." - }, - "attributes" : { - "type" : "array", - "description" : "The attributes of the flowfile for the event.", - "items" : { - "$ref" : "#/definitions/AttributeDTO" - } - }, - "parentUuids" : { - "type" : "array", - "description" : "The parent uuids for the event.", - "items" : { - "type" : "string" - } - }, - "childUuids" : { - "type" : "array", - "description" : "The child uuids for the event.", - "items" : { - "type" : "string" - } - }, - "transitUri" : { - "type" : "string", - "description" : "The source/destination system uri if the event was a RECEIVE/SEND." - }, - "relationship" : { - "type" : "string", - "description" : "The relationship to which the flowfile was routed if the event is of type ROUTE." - }, - "details" : { - "type" : "string", - "description" : "The event details." - }, - "contentEqual" : { - "type" : "boolean", - "description" : "Whether the input and output content claim is the same." - }, - "inputContentAvailable" : { - "type" : "boolean", - "description" : "Whether the input content is still available." - }, - "inputContentClaimSection" : { - "type" : "string", - "description" : "The section in which the input content claim lives." - }, - "inputContentClaimContainer" : { - "type" : "string", - "description" : "The container in which the input content claim lives." - }, - "inputContentClaimIdentifier" : { - "type" : "string", - "description" : "The identifier of the input content claim." - }, - "inputContentClaimOffset" : { - "type" : "integer", - "format" : "int64", - "description" : "The offset into the input content claim where the flowfiles content begins." - }, - "inputContentClaimFileSize" : { - "type" : "string", - "description" : "The file size of the input content claim formatted." - }, - "inputContentClaimFileSizeBytes" : { - "type" : "integer", - "format" : "int64", - "description" : "The file size of the intput content claim in bytes." - }, - "outputContentAvailable" : { - "type" : "boolean", - "description" : "Whether the output content is still available." - }, - "outputContentClaimSection" : { - "type" : "string", - "description" : "The section in which the output content claim lives." - }, - "outputContentClaimContainer" : { - "type" : "string", - "description" : "The container in which the output content claim lives." - }, - "outputContentClaimIdentifier" : { - "type" : "string", - "description" : "The identifier of the output content claim." - }, - "outputContentClaimOffset" : { - "type" : "integer", - "format" : "int64", - "description" : "The offset into the output content claim where the flowfiles content begins." - }, - "outputContentClaimFileSize" : { - "type" : "string", - "description" : "The file size of the output content claim formatted." - }, - "outputContentClaimFileSizeBytes" : { - "type" : "integer", - "format" : "int64", - "description" : "The file size of the output content claim in bytes." - }, - "replayAvailable" : { - "type" : "boolean", - "description" : "Whether or not replay is available." - }, - "replayExplanation" : { - "type" : "string", - "description" : "Explanation as to why replay is unavailable." - }, - "sourceConnectionIdentifier" : { - "type" : "string", - "description" : "The identifier of the queue/connection from which the flowfile was pulled to genereate this event. May be null if the queue/connection is unknown or the flowfile was generated from this event." - } - } - }, - "ProvenanceEventEntity" : { - "type" : "object", - "properties" : { - "provenanceEvent" : { - "$ref" : "#/definitions/ProvenanceEventDTO" - } - }, - "xml" : { - "name" : "provenanceEventEntity" - } - }, - "ProvenanceLinkDTO" : { - "type" : "object", - "properties" : { - "sourceId" : { - "type" : "string", - "description" : "The source node id of the link." - }, - "targetId" : { - "type" : "string", - "description" : "The target node id of the link." - }, - "flowFileUuid" : { - "type" : "string", - "description" : "The flowfile uuid that traversed the link." - }, - "timestamp" : { - "type" : "string", - "description" : "The timestamp of the link (based on the destination)." - }, - "millis" : { - "type" : "integer", - "format" : "int64", - "description" : "The timestamp of this link in milliseconds." - } - } - }, - "ProvenanceNodeDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the node." - }, - "flowFileUuid" : { - "type" : "string", - "description" : "The uuid of the flowfile associated with the provenance event." - }, - "parentUuids" : { - "type" : "array", - "description" : "The uuid of the parent flowfiles of the provenance event.", - "items" : { - "type" : "string" - } - }, - "childUuids" : { - "type" : "array", - "description" : "The uuid of the childrent flowfiles of the provenance event.", - "items" : { - "type" : "string" - } - }, - "clusterNodeIdentifier" : { - "type" : "string", - "description" : "The identifier of the node that this event/flowfile originated from." - }, - "type" : { - "type" : "string", - "description" : "The type of the node.", - "enum" : [ "FLOWFILE", "EVENT" ] - }, - "eventType" : { - "type" : "string", - "description" : "If the type is EVENT, this is the type of event." - }, - "millis" : { - "type" : "integer", - "format" : "int64", - "description" : "The timestamp of the node in milliseconds." - }, - "timestamp" : { - "type" : "string", - "description" : "The timestamp of the node formatted." - } - } - }, - "ProvenanceOptionsDTO" : { - "type" : "object", - "properties" : { - "searchableFields" : { - "type" : "array", - "description" : "The available searchable field for the NiFi.", - "items" : { - "$ref" : "#/definitions/ProvenanceSearchableFieldDTO" - } - } - } - }, - "ProvenanceOptionsEntity" : { - "type" : "object", - "properties" : { - "provenanceOptions" : { - "$ref" : "#/definitions/ProvenanceOptionsDTO" - } - }, - "xml" : { - "name" : "provenanceOptionsEntity" - } - }, - "ProvenanceRequestDTO" : { - "type" : "object", - "properties" : { - "searchTerms" : { - "type" : "object", - "description" : "The search terms used to perform the search.", - "additionalProperties" : { - "type" : "string" - } - }, - "clusterNodeId" : { - "type" : "string", - "description" : "The id of the node in the cluster where this provenance originated." - }, - "startDate" : { - "type" : "string", - "description" : "The earliest event time to include in the query." - }, - "endDate" : { - "type" : "string", - "description" : "The latest event time to include in the query." - }, - "minimumFileSize" : { - "type" : "string", - "description" : "The minimum file size to include in the query." - }, - "maximumFileSize" : { - "type" : "string", - "description" : "The maximum file size to include in the query." - }, - "maxResults" : { - "type" : "integer", - "format" : "int32", - "description" : "The maximum number of results to include." - }, - "summarize" : { - "type" : "boolean", - "description" : "Whether or not to summarize provenance events returned. This property is false by default." - }, - "incrementalResults" : { - "type" : "boolean", - "description" : "Whether or not incremental results are returned. If false, provenance events are only returned once the query completes. This property is true by default." - } - } - }, - "ProvenanceResultsDTO" : { - "type" : "object", - "properties" : { - "provenanceEvents" : { - "type" : "array", - "description" : "The provenance events that matched the search criteria.", - "items" : { - "$ref" : "#/definitions/ProvenanceEventDTO" - } - }, - "total" : { - "type" : "string", - "description" : "The total number of results formatted." - }, - "totalCount" : { - "type" : "integer", - "format" : "int64", - "description" : "The total number of results." - }, - "generated" : { - "type" : "string", - "description" : "Then the search was performed." - }, - "oldestEvent" : { - "type" : "string", - "description" : "The oldest event available in the provenance repository." - }, - "timeOffset" : { - "type" : "integer", - "format" : "int32", - "description" : "The time offset of the server that's used for event time." - }, - "errors" : { - "type" : "array", - "description" : "Any errors that occurred while performing the provenance request.", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - } - } - }, - "ProvenanceSearchableFieldDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the searchable field." - }, - "field" : { - "type" : "string", - "description" : "The searchable field." - }, - "label" : { - "type" : "string", - "description" : "The label for the searchable field." - }, - "type" : { - "type" : "string", - "description" : "The type of the searchable field." - } - } - }, - "QueueSizeDTO" : { - "type" : "object", - "properties" : { - "byteCount" : { - "type" : "integer", - "format" : "int64", - "description" : "The size of objects in a queue." - }, - "objectCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The count of objects in a queue." - } - } - }, - "RegistryClientEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "component" : { - "$ref" : "#/definitions/RegistryDTO" - } - }, - "xml" : { - "name" : "registryClientEntity" - } - }, - "RegistryClientsEntity" : { - "type" : "object", - "properties" : { - "registries" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/RegistryClientEntity" - } - } - }, - "xml" : { - "name" : "registryClientsEntity" - } - }, - "RegistryDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The registry identifier" - }, - "name" : { - "type" : "string", - "description" : "The registry name" - }, - "description" : { - "type" : "string", - "description" : "The registry description" - }, - "uri" : { - "type" : "string", - "description" : "The registry URI" - } - } - }, - "RelationshipDTO" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The relationship name." - }, - "description" : { - "type" : "string", - "description" : "The relationship description." - }, - "autoTerminate" : { - "type" : "boolean", - "description" : "Whether or not flowfiles sent to this relationship should auto terminate." - } - } - }, - "RemotePortRunStatusEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "state" : { - "type" : "string", - "description" : "The run status of the RemotePort.", - "enum" : [ "TRANSMITTING", "STOPPED" ] - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - } - }, - "xml" : { - "name" : "entity" - } - }, - "RemoteProcessGroupContentsDTO" : { - "type" : "object", - "properties" : { - "inputPorts" : { - "type" : "array", - "description" : "The input ports to which data can be sent.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/RemoteProcessGroupPortDTO" - } - }, - "outputPorts" : { - "type" : "array", - "description" : "The output ports from which data can be retrieved.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/RemoteProcessGroupPortDTO" - } - } - } - }, - "RemoteProcessGroupDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "versionedComponentId" : { - "type" : "string", - "description" : "The ID of the corresponding component that is under version control" - }, - "parentGroupId" : { - "type" : "string", - "description" : "The id of parent process group of this component if applicable." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "targetUri" : { - "type" : "string", - "description" : "The target URI of the remote process group. If target uri is not set, but uris are set, then returns the first url in the urls. If neither target uri nor uris are set, then returns null." - }, - "targetUris" : { - "type" : "string", - "description" : "The target URI of the remote process group. If target uris is not set but target uri is set, then returns a collection containing the single target uri. If neither target uris nor uris are set, then returns null." - }, - "targetSecure" : { - "type" : "boolean", - "description" : "Whether the target is running securely." - }, - "name" : { - "type" : "string", - "description" : "The name of the remote process group." - }, - "comments" : { - "type" : "string", - "description" : "The comments for the remote process group." - }, - "communicationsTimeout" : { - "type" : "string", - "description" : "The time period used for the timeout when communicating with the target." - }, - "yieldDuration" : { - "type" : "string", - "description" : "When yielding, this amount of time must elapse before the remote process group is scheduled again." - }, - "transportProtocol" : { - "type" : "string" - }, - "localNetworkInterface" : { - "type" : "string", - "description" : "The local network interface to send/receive data. If not specified, any local address is used. If clustered, all nodes must have an interface with this identifier." - }, - "proxyHost" : { - "type" : "string" - }, - "proxyPort" : { - "type" : "integer", - "format" : "int32" - }, - "proxyUser" : { - "type" : "string" - }, - "proxyPassword" : { - "type" : "string" - }, - "authorizationIssues" : { - "type" : "array", - "description" : "Any remote authorization issues for the remote process group.", - "items" : { - "type" : "string" - } - }, - "validationErrors" : { - "type" : "array", - "description" : "The validation errors for the remote process group. These validation errors represent the problems with the remote process group that must be resolved before it can transmit.", - "items" : { - "type" : "string" - } - }, - "transmitting" : { - "type" : "boolean", - "description" : "Whether the remote process group is actively transmitting." - }, - "inputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of remote input ports currently available on the target." - }, - "outputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of remote output ports currently available on the target." - }, - "activeRemoteInputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of active remote input ports." - }, - "inactiveRemoteInputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of inactive remote input ports." - }, - "activeRemoteOutputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of active remote output ports." - }, - "inactiveRemoteOutputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of inactive remote output ports." - }, - "flowRefreshed" : { - "type" : "string", - "description" : "The timestamp when this remote process group was last refreshed." - }, - "contents" : { - "description" : "The contents of the remote process group. Will contain available input/output ports.", - "$ref" : "#/definitions/RemoteProcessGroupContentsDTO" - } - } - }, - "RemoteProcessGroupEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "component" : { - "$ref" : "#/definitions/RemoteProcessGroupDTO" - }, - "status" : { - "description" : "The status of the remote process group.", - "$ref" : "#/definitions/RemoteProcessGroupStatusDTO" - }, - "inputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of remote input ports currently available on the target." - }, - "outputPortCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of remote output ports currently available on the target." - }, - "operatePermissions" : { - "description" : "The permissions for this component operations.", - "$ref" : "#/definitions/PermissionsDTO" - } - }, - "xml" : { - "name" : "remoteProcessGroupEntity" - } - }, - "RemoteProcessGroupPortDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the port." - }, - "targetId" : { - "type" : "string", - "description" : "The id of the target port." - }, - "versionedComponentId" : { - "type" : "string", - "description" : "The ID of the corresponding component that is under version control" - }, - "groupId" : { - "type" : "string", - "description" : "The id of the remote process group that the port resides in." - }, - "name" : { - "type" : "string", - "description" : "The name of the target port." - }, - "comments" : { - "type" : "string", - "description" : "The comments as configured on the target port." - }, - "concurrentlySchedulableTaskCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of task that may transmit flowfiles to the target port concurrently." - }, - "transmitting" : { - "type" : "boolean", - "description" : "Whether the remote port is configured for transmission." - }, - "useCompression" : { - "type" : "boolean", - "description" : "Whether the flowfiles are compressed when sent to the target port." - }, - "exists" : { - "type" : "boolean", - "description" : "Whether the target port exists." - }, - "targetRunning" : { - "type" : "boolean", - "description" : "Whether the target port is running." - }, - "connected" : { - "type" : "boolean", - "description" : "Whether the port has either an incoming or outgoing connection." - }, - "batchSettings" : { - "description" : "The batch settings for data transmission.", - "$ref" : "#/definitions/BatchSettingsDTO" - } - } - }, - "RemoteProcessGroupPortEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "remoteProcessGroupPort" : { - "$ref" : "#/definitions/RemoteProcessGroupPortDTO" - }, - "operatePermissions" : { - "description" : "The permissions for this component operations.", - "$ref" : "#/definitions/PermissionsDTO" - } - }, - "xml" : { - "name" : "remoteProcessGroupPortEntity" - } - }, - "RemoteProcessGroupStatusDTO" : { - "type" : "object", - "properties" : { - "groupId" : { - "type" : "string", - "description" : "The unique ID of the process group that the Processor belongs to" - }, - "id" : { - "type" : "string", - "description" : "The unique ID of the Processor" - }, - "name" : { - "type" : "string", - "description" : "The name of the remote process group." - }, - "targetUri" : { - "type" : "string", - "description" : "The URI of the target system." - }, - "transmissionStatus" : { - "type" : "string", - "description" : "The transmission status of the remote process group." - }, - "statsLastRefreshed" : { - "type" : "string", - "description" : "The time the status for the process group was last refreshed." - }, - "validationStatus" : { - "type" : "string", - "description" : "Indicates whether the component is valid, invalid, or still in the process of validating (i.e., it is unknown whether or not the component is valid)", - "readOnly" : true, - "enum" : [ "VALID", "INVALID", "VALIDATING" ] - }, - "aggregateSnapshot" : { - "description" : "A status snapshot that represents the aggregate stats of all nodes in the cluster. If the NiFi instance is a standalone instance, rather than a cluster, this represents the stats of the single instance.", - "$ref" : "#/definitions/RemoteProcessGroupStatusSnapshotDTO" - }, - "nodeSnapshots" : { - "type" : "array", - "description" : "A status snapshot for each node in the cluster. If the NiFi instance is a standalone instance, rather than a cluster, this may be null.", - "items" : { - "$ref" : "#/definitions/NodeRemoteProcessGroupStatusSnapshotDTO" - } - } - } - }, - "RemoteProcessGroupStatusEntity" : { - "type" : "object", - "properties" : { - "remoteProcessGroupStatus" : { - "$ref" : "#/definitions/RemoteProcessGroupStatusDTO" - }, - "canRead" : { - "type" : "boolean", - "description" : "Indicates whether the user can read a given resource.", - "readOnly" : true - } - }, - "xml" : { - "name" : "remoteProcessGroupStatusEntity" - } - }, - "RemoteProcessGroupStatusSnapshotDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the remote process group." - }, - "groupId" : { - "type" : "string", - "description" : "The id of the parent process group the remote process group resides in." - }, - "name" : { - "type" : "string", - "description" : "The name of the remote process group." - }, - "targetUri" : { - "type" : "string", - "description" : "The URI of the target system." - }, - "transmissionStatus" : { - "type" : "string", - "description" : "The transmission status of the remote process group." - }, - "activeThreadCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of active threads for the remote process group." - }, - "flowFilesSent" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of FlowFiles sent to the remote process group in the last 5 minutes." - }, - "bytesSent" : { - "type" : "integer", - "format" : "int64", - "description" : "The size of the FlowFiles sent to the remote process group in the last 5 minutes." - }, - "sent" : { - "type" : "string", - "description" : "The count/size of the flowfiles sent to the remote process group in the last 5 minutes." - }, - "flowFilesReceived" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of FlowFiles received from the remote process group in the last 5 minutes." - }, - "bytesReceived" : { - "type" : "integer", - "format" : "int64", - "description" : "The size of the FlowFiles received from the remote process group in the last 5 minutes." - }, - "received" : { - "type" : "string", - "description" : "The count/size of the flowfiles received from the remote process group in the last 5 minutes." - } - } - }, - "RemoteProcessGroupStatusSnapshotEntity" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the remote process group." - }, - "remoteProcessGroupStatusSnapshot" : { - "$ref" : "#/definitions/RemoteProcessGroupStatusSnapshotDTO" - }, - "canRead" : { - "type" : "boolean", - "description" : "Indicates whether the user can read a given resource.", - "readOnly" : true - } - }, - "xml" : { - "name" : "entity" - } - }, - "RemoteProcessGroupsEntity" : { - "type" : "object", - "properties" : { - "remoteProcessGroups" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/RemoteProcessGroupEntity" - } - } - }, - "xml" : { - "name" : "remoteProcessGroupsEntity" - } - }, - "ReportingTaskDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "versionedComponentId" : { - "type" : "string", - "description" : "The ID of the corresponding component that is under version control" - }, - "parentGroupId" : { - "type" : "string", - "description" : "The id of parent process group of this component if applicable." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "name" : { - "type" : "string", - "description" : "The name of the reporting task." - }, - "type" : { - "type" : "string", - "description" : "The fully qualified type of the reporting task." - }, - "bundle" : { - "description" : "The details of the artifact that bundled this processor type.", - "$ref" : "#/definitions/BundleDTO" - }, - "state" : { - "type" : "string", - "description" : "The state of the reporting task.", - "enum" : [ "RUNNING", "STOPPED", "DISABLED" ] - }, - "comments" : { - "type" : "string", - "description" : "The comments of the reporting task." - }, - "persistsState" : { - "type" : "boolean", - "description" : "Whether the reporting task persists state." - }, - "restricted" : { - "type" : "boolean", - "description" : "Whether the reporting task requires elevated privileges." - }, - "deprecated" : { - "type" : "boolean", - "description" : "Whether the reporting task has been deprecated." - }, - "multipleVersionsAvailable" : { - "type" : "boolean", - "description" : "Whether the reporting task has multiple versions available." - }, - "schedulingPeriod" : { - "type" : "string", - "description" : "The frequency with which to schedule the reporting task. The format of the value willd epend on the valud of the schedulingStrategy." - }, - "schedulingStrategy" : { - "type" : "string", - "description" : "The scheduling strategy that determines how the schedulingPeriod value should be interpreted." - }, - "defaultSchedulingPeriod" : { - "type" : "object", - "description" : "The default scheduling period for the different scheduling strategies.", - "additionalProperties" : { - "type" : "string" - } - }, - "properties" : { - "type" : "object", - "description" : "The properties of the reporting task.", - "additionalProperties" : { - "type" : "string" - } - }, - "descriptors" : { - "type" : "object", - "description" : "The descriptors for the reporting tasks properties.", - "additionalProperties" : { - "$ref" : "#/definitions/PropertyDescriptorDTO" - } - }, - "customUiUrl" : { - "type" : "string", - "description" : "The URL for the custom configuration UI for the reporting task." - }, - "annotationData" : { - "type" : "string", - "description" : "The annotation data for the repoting task. This is how the custom UI relays configuration to the reporting task." - }, - "validationErrors" : { - "type" : "array", - "description" : "Gets the validation errors from the reporting task. These validation errors represent the problems with the reporting task that must be resolved before it can be scheduled to run.", - "items" : { - "type" : "string" - } - }, - "validationStatus" : { - "type" : "string", - "description" : "Indicates whether the Processor is valid, invalid, or still in the process of validating (i.e., it is unknown whether or not the Processor is valid)", - "readOnly" : true, - "enum" : [ "VALID", "INVALID", "VALIDATING" ] - }, - "activeThreadCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of active threads for the reporting task." - }, - "extensionMissing" : { - "type" : "boolean", - "description" : "Whether the underlying extension is missing." - } - } - }, - "ReportingTaskEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "component" : { - "$ref" : "#/definitions/ReportingTaskDTO" - }, - "operatePermissions" : { - "description" : "The permissions for this component operations.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "status" : { - "description" : "The status for this ReportingTask.", - "readOnly" : true, - "$ref" : "#/definitions/ReportingTaskStatusDTO" - } - }, - "xml" : { - "name" : "reportingTaskEntity" - } - }, - "ReportingTaskRunStatusEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "state" : { - "type" : "string", - "description" : "The run status of the ReportingTask.", - "enum" : [ "RUNNING", "STOPPED" ] - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - } - }, - "xml" : { - "name" : "entity" - } - }, - "ReportingTaskStatusDTO" : { - "type" : "object", - "properties" : { - "runStatus" : { - "type" : "string", - "description" : "The run status of this ReportingTask", - "readOnly" : true, - "enum" : [ "RUNNING", "STOPPED", "DISABLED" ] - }, - "validationStatus" : { - "type" : "string", - "description" : "Indicates whether the component is valid, invalid, or still in the process of validating (i.e., it is unknown whether or not the component is valid)", - "readOnly" : true, - "enum" : [ "VALID", "INVALID", "VALIDATING" ] - }, - "activeThreadCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of active threads for the component." - } - } - }, - "ReportingTaskTypesEntity" : { - "type" : "object", - "properties" : { - "reportingTaskTypes" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/DocumentedTypeDTO" - } - } - }, - "xml" : { - "name" : "reportingTaskTypesEntity" - } - }, - "ReportingTasksEntity" : { - "type" : "object", - "properties" : { - "reportingTasks" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ReportingTaskEntity" - } - } - }, - "xml" : { - "name" : "reportingTasksEntity" - } - }, - "RequiredPermissionDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The required sub-permission necessary for this restriction." - }, - "label" : { - "type" : "string", - "description" : "The label for the required sub-permission necessary for this restriction." - } - } - }, - "ResourceDTO" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The identifier of the resource." - }, - "name" : { - "type" : "string", - "description" : "The name of the resource." - } - } - }, - "ResourcesEntity" : { - "type" : "object", - "properties" : { - "resources" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/ResourceDTO" - } - } - }, - "xml" : { - "name" : "resourcesEntity" - } - }, - "RevisionDTO" : { - "type" : "object", - "properties" : { - "clientId" : { - "type" : "string", - "description" : "A client identifier used to make a request. By including a client identifier, the API can allow multiple requests without needing the current revision. Due to the asynchronous nature of requests/responses this was implemented to allow the client to make numerous requests without having to wait for the previous response to come back" - }, - "version" : { - "type" : "integer", - "format" : "int64", - "description" : "NiFi employs an optimistic locking strategy where the client must include a revision in their request when performing an update. In a response to a mutable flow request, this field represents the updated base version." - }, - "lastModifier" : { - "type" : "string", - "description" : "The user that last modified the flow.", - "readOnly" : true - } - } - }, - "ScheduleComponentsEntity" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the ProcessGroup" - }, - "state" : { - "type" : "string", - "description" : "The desired state of the descendant components", - "enum" : [ "RUNNING", "STOPPED", "ENABLED", "DISABLED" ] - }, - "components" : { - "type" : "object", - "description" : "Optional components to schedule. If not specified, all authorized descendant components will be used.", - "additionalProperties" : { - "$ref" : "#/definitions/RevisionDTO" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - } - }, - "xml" : { - "name" : "scheduleComponentEntity" - } - }, - "SearchResultGroupDTO" : { - "type" : "object", - "required" : [ "id" ], - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the group." - }, - "name" : { - "type" : "string", - "description" : "The name of the group." - } - } - }, - "SearchResultsDTO" : { - "type" : "object", - "properties" : { - "processorResults" : { - "type" : "array", - "description" : "The processors that matched the search.", - "items" : { - "$ref" : "#/definitions/ComponentSearchResultDTO" - } - }, - "connectionResults" : { - "type" : "array", - "description" : "The connections that matched the search.", - "items" : { - "$ref" : "#/definitions/ComponentSearchResultDTO" - } - }, - "processGroupResults" : { - "type" : "array", - "description" : "The process groups that matched the search.", - "items" : { - "$ref" : "#/definitions/ComponentSearchResultDTO" - } - }, - "inputPortResults" : { - "type" : "array", - "description" : "The input ports that matched the search.", - "items" : { - "$ref" : "#/definitions/ComponentSearchResultDTO" - } - }, - "outputPortResults" : { - "type" : "array", - "description" : "The output ports that matched the search.", - "items" : { - "$ref" : "#/definitions/ComponentSearchResultDTO" - } - }, - "remoteProcessGroupResults" : { - "type" : "array", - "description" : "The remote process groups that matched the search.", - "items" : { - "$ref" : "#/definitions/ComponentSearchResultDTO" - } - }, - "funnelResults" : { - "type" : "array", - "description" : "The funnels that matched the search.", - "items" : { - "$ref" : "#/definitions/ComponentSearchResultDTO" - } - } - } - }, - "SearchResultsEntity" : { - "type" : "object", - "properties" : { - "searchResultsDTO" : { - "$ref" : "#/definitions/SearchResultsDTO" - } - }, - "xml" : { - "name" : "searchResultsEntity" - } - }, - "SnippetDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the snippet." - }, - "uri" : { - "type" : "string", - "description" : "The URI of the snippet." - }, - "parentGroupId" : { - "type" : "string", - "description" : "The group id for the components in the snippet." - }, - "processGroups" : { - "type" : "object", - "description" : "The ids of the process groups in this snippet. These ids will be populated within each response. They can be specified when creating a snippet. However, once a snippet has been created its contents cannot be modified (these ids are ignored during update requests).", - "additionalProperties" : { - "$ref" : "#/definitions/RevisionDTO" - } - }, - "remoteProcessGroups" : { - "type" : "object", - "description" : "The ids of the remote process groups in this snippet. These ids will be populated within each response. They can be specified when creating a snippet. However, once a snippet has been created its contents cannot be modified (these ids are ignored during update requests).", - "additionalProperties" : { - "$ref" : "#/definitions/RevisionDTO" - } - }, - "processors" : { - "type" : "object", - "description" : "The ids of the processors in this snippet. These ids will be populated within each response. They can be specified when creating a snippet. However, once a snippet has been created its contents cannot be modified (these ids are ignored during update requests).", - "additionalProperties" : { - "$ref" : "#/definitions/RevisionDTO" - } - }, - "inputPorts" : { - "type" : "object", - "description" : "The ids of the input ports in this snippet. These ids will be populated within each response. They can be specified when creating a snippet. However, once a snippet has been created its contents cannot be modified (these ids are ignored during update requests).", - "additionalProperties" : { - "$ref" : "#/definitions/RevisionDTO" - } - }, - "outputPorts" : { - "type" : "object", - "description" : "The ids of the output ports in this snippet. These ids will be populated within each response. They can be specified when creating a snippet. However, once a snippet has been created its contents cannot be modified (these ids are ignored during update requests).", - "additionalProperties" : { - "$ref" : "#/definitions/RevisionDTO" - } - }, - "connections" : { - "type" : "object", - "description" : "The ids of the connections in this snippet. These ids will be populated within each response. They can be specified when creating a snippet. However, once a snippet has been created its contents cannot be modified (these ids are ignored during update requests).", - "additionalProperties" : { - "$ref" : "#/definitions/RevisionDTO" - } - }, - "labels" : { - "type" : "object", - "description" : "The ids of the labels in this snippet. These ids will be populated within each response. They can be specified when creating a snippet. However, once a snippet has been created its contents cannot be modified (these ids are ignored during update requests).", - "additionalProperties" : { - "$ref" : "#/definitions/RevisionDTO" - } - }, - "funnels" : { - "type" : "object", - "description" : "The ids of the funnels in this snippet. These ids will be populated within each response. They can be specified when creating a snippet. However, once a snippet has been created its contents cannot be modified (these ids are ignored during update requests).", - "additionalProperties" : { - "$ref" : "#/definitions/RevisionDTO" - } - } - } - }, - "SnippetEntity" : { - "type" : "object", - "properties" : { - "snippet" : { - "description" : "The snippet.", - "$ref" : "#/definitions/SnippetDTO" - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - } - }, - "xml" : { - "name" : "snippetEntity" - } - }, - "StartVersionControlRequestEntity" : { - "type" : "object", - "properties" : { - "versionedFlow" : { - "description" : "The versioned flow", - "$ref" : "#/definitions/VersionedFlowDTO" - }, - "processGroupRevision" : { - "description" : "The Revision of the Process Group under Version Control", - "$ref" : "#/definitions/RevisionDTO" - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - } - }, - "xml" : { - "name" : "startVersionControlRequestEntity" - } - }, - "StateEntryDTO" : { - "type" : "object", - "properties" : { - "key" : { - "type" : "string", - "description" : "The key for this state." - }, - "value" : { - "type" : "string", - "description" : "The value for this state." - }, - "clusterNodeId" : { - "type" : "string", - "description" : "The identifier for the node where the state originated." - }, - "clusterNodeAddress" : { - "type" : "string", - "description" : "The label for the node where the state originated." - } - } - }, - "StateMapDTO" : { - "type" : "object", - "properties" : { - "scope" : { - "type" : "string", - "description" : "The scope of this StateMap." - }, - "totalEntryCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The total number of state entries. When the state map is lengthy, only of portion of the entries are returned." - }, - "state" : { - "type" : "array", - "description" : "The state.", - "items" : { - "$ref" : "#/definitions/StateEntryDTO" - } - } - } - }, - "StatusDescriptorDTO" : { - "type" : "object", - "properties" : { - "field" : { - "type" : "string", - "description" : "The name of the status field." - }, - "label" : { - "type" : "string", - "description" : "The label for the status field." - }, - "description" : { - "type" : "string", - "description" : "The description of the status field." - }, - "formatter" : { - "type" : "string", - "description" : "The formatter for the status descriptor." - } - } - }, - "StatusHistoryDTO" : { - "type" : "object", - "properties" : { - "generated" : { - "type" : "string", - "description" : "When the status history was generated." - }, - "componentDetails" : { - "type" : "object", - "description" : "A Map of key/value pairs that describe the component that the status history belongs to", - "additionalProperties" : { - "type" : "string" - } - }, - "fieldDescriptors" : { - "type" : "array", - "description" : "The Descriptors that provide information on each of the metrics provided in the status history", - "items" : { - "$ref" : "#/definitions/StatusDescriptorDTO" - } - }, - "aggregateSnapshots" : { - "type" : "array", - "description" : "A list of StatusSnapshotDTO objects that provide the actual metric values for the component. If the NiFi instance is clustered, this will represent the aggregate status across all nodes. If the NiFi instance is not clustered, this will represent the status of the entire NiFi instance.", - "items" : { - "$ref" : "#/definitions/StatusSnapshotDTO" - } - }, - "nodeSnapshots" : { - "type" : "array", - "description" : "The NodeStatusSnapshotsDTO objects that provide the actual metric values for the component, for each node. If the NiFi instance is not clustered, this value will be null.", - "items" : { - "$ref" : "#/definitions/NodeStatusSnapshotsDTO" - } - } - } - }, - "StatusHistoryEntity" : { - "type" : "object", - "properties" : { - "statusHistory" : { - "$ref" : "#/definitions/StatusHistoryDTO" - }, - "canRead" : { - "type" : "boolean", - "description" : "Indicates whether the user can read a given resource.", - "readOnly" : true - } - }, - "xml" : { - "name" : "statusHistoryEntity" - } - }, - "StatusSnapshotDTO" : { - "type" : "object", - "properties" : { - "timestamp" : { - "type" : "string", - "format" : "date-time", - "description" : "The timestamp of the snapshot." - }, - "statusMetrics" : { - "type" : "object", - "description" : "The status metrics.", - "additionalProperties" : { - "type" : "integer", - "format" : "int64" - } - } - } - }, - "StorageUsageDTO" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The identifier of this storage location. The identifier will correspond to the identifier keyed in the storage configuration." - }, - "freeSpace" : { - "type" : "string", - "description" : "Amount of free space." - }, - "totalSpace" : { - "type" : "string", - "description" : "Amount of total space." - }, - "usedSpace" : { - "type" : "string", - "description" : "Amount of used space." - }, - "freeSpaceBytes" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes of free space." - }, - "totalSpaceBytes" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes of total space." - }, - "usedSpaceBytes" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes of used space." - }, - "utilization" : { - "type" : "string", - "description" : "Utilization of this storage location." - } - } - }, - "StreamingOutput" : { - "type" : "object" - }, - "SubmitReplayRequestEntity" : { - "type" : "object", - "properties" : { - "eventId" : { - "type" : "integer", - "format" : "int64", - "description" : "The event identifier" - }, - "clusterNodeId" : { - "type" : "string", - "description" : "The identifier of the node where to submit the replay request." - } - }, - "xml" : { - "name" : "copySnippetRequestEntity" - } - }, - "SystemDiagnosticsDTO" : { - "type" : "object", - "properties" : { - "aggregateSnapshot" : { - "description" : "A systems diagnostic snapshot that represents the aggregate values of all nodes in the cluster. If the NiFi instance is a standalone instance, rather than a cluster, this represents the stats of the single instance.", - "$ref" : "#/definitions/SystemDiagnosticsSnapshotDTO" - }, - "nodeSnapshots" : { - "type" : "array", - "description" : "A systems diagnostics snapshot for each node in the cluster. If the NiFi instance is a standalone instance, rather than a cluster, this may be null.", - "items" : { - "$ref" : "#/definitions/NodeSystemDiagnosticsSnapshotDTO" - } - } - } - }, - "SystemDiagnosticsEntity" : { - "type" : "object", - "properties" : { - "systemDiagnostics" : { - "$ref" : "#/definitions/SystemDiagnosticsDTO" - } - }, - "xml" : { - "name" : "systemDiagnosticsEntity" - } - }, - "SystemDiagnosticsSnapshotDTO" : { - "type" : "object", - "properties" : { - "totalNonHeap" : { - "type" : "string", - "description" : "Total size of non heap." - }, - "totalNonHeapBytes" : { - "type" : "integer", - "format" : "int64", - "description" : "Total number of bytes allocated to the JVM not used for heap" - }, - "usedNonHeap" : { - "type" : "string", - "description" : "Amount of use non heap." - }, - "usedNonHeapBytes" : { - "type" : "integer", - "format" : "int64", - "description" : "Total number of bytes used by the JVM not in the heap space" - }, - "freeNonHeap" : { - "type" : "string", - "description" : "Amount of free non heap." - }, - "freeNonHeapBytes" : { - "type" : "integer", - "format" : "int64", - "description" : "Total number of free non-heap bytes available to the JVM" - }, - "maxNonHeap" : { - "type" : "string", - "description" : "Maximum size of non heap." - }, - "maxNonHeapBytes" : { - "type" : "integer", - "format" : "int64", - "description" : "The maximum number of bytes that the JVM can use for non-heap purposes" - }, - "nonHeapUtilization" : { - "type" : "string", - "description" : "Utilization of non heap." - }, - "totalHeap" : { - "type" : "string", - "description" : "Total size of heap." - }, - "totalHeapBytes" : { - "type" : "integer", - "format" : "int64", - "description" : "The total number of bytes that are available for the JVM heap to use" - }, - "usedHeap" : { - "type" : "string", - "description" : "Amount of used heap." - }, - "usedHeapBytes" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes of JVM heap that are currently being used" - }, - "freeHeap" : { - "type" : "string", - "description" : "Amount of free heap." - }, - "freeHeapBytes" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of bytes that are allocated to the JVM heap but not currently being used" - }, - "maxHeap" : { - "type" : "string", - "description" : "Maximum size of heap." - }, - "maxHeapBytes" : { - "type" : "integer", - "format" : "int64", - "description" : "The maximum number of bytes that can be used by the JVM" - }, - "heapUtilization" : { - "type" : "string", - "description" : "Utilization of heap." - }, - "availableProcessors" : { - "type" : "integer", - "format" : "int32", - "description" : "Number of available processors if supported by the underlying system." - }, - "processorLoadAverage" : { - "type" : "number", - "format" : "double", - "description" : "The processor load average if supported by the underlying system." - }, - "totalThreads" : { - "type" : "integer", - "format" : "int32", - "description" : "Total number of threads." - }, - "daemonThreads" : { - "type" : "integer", - "format" : "int32", - "description" : "Number of daemon threads." - }, - "uptime" : { - "type" : "string", - "description" : "The uptime of the Java virtual machine" - }, - "flowFileRepositoryStorageUsage" : { - "description" : "The flowfile repository storage usage.", - "$ref" : "#/definitions/StorageUsageDTO" - }, - "contentRepositoryStorageUsage" : { - "type" : "array", - "description" : "The content repository storage usage.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/StorageUsageDTO" - } - }, - "provenanceRepositoryStorageUsage" : { - "type" : "array", - "description" : "The provenance repository storage usage.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/StorageUsageDTO" - } - }, - "garbageCollection" : { - "type" : "array", - "description" : "The garbage collection details.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/GarbageCollectionDTO" - } - }, - "statsLastRefreshed" : { - "type" : "string", - "description" : "When the diagnostics were generated." - }, - "versionInfo" : { - "description" : "The nifi, os, java, and build version information", - "$ref" : "#/definitions/VersionInfoDTO" - } - } - }, - "TemplateDTO" : { - "type" : "object", - "properties" : { - "uri" : { - "type" : "string", - "description" : "The URI for the template." - }, - "id" : { - "type" : "string", - "description" : "The id of the template." - }, - "groupId" : { - "type" : "string", - "description" : "The id of the Process Group that the template belongs to." - }, - "name" : { - "type" : "string", - "description" : "The name of the template." - }, - "description" : { - "type" : "string", - "description" : "The description of the template." - }, - "timestamp" : { - "type" : "string", - "description" : "The timestamp when this template was created." - }, - "encodingVersion" : { - "type" : "string", - "xml" : { - "name" : "encoding-version", - "attribute" : true - }, - "description" : "The encoding version of this template." - }, - "snippet" : { - "description" : "The contents of the template.", - "$ref" : "#/definitions/FlowSnippetDTO" - } - }, - "xml" : { - "name" : "template" - } - }, - "TemplateEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "template" : { - "$ref" : "#/definitions/TemplateDTO" - } - }, - "xml" : { - "name" : "templateEntity" - } - }, - "TemplatesEntity" : { - "type" : "object", - "properties" : { - "templates" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/TemplateEntity" - } - }, - "generated" : { - "type" : "string", - "description" : "When this content was generated." - } - }, - "xml" : { - "name" : "templatesEntity" - } - }, - "TenantDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "versionedComponentId" : { - "type" : "string", - "description" : "The ID of the corresponding component that is under version control" - }, - "parentGroupId" : { - "type" : "string", - "description" : "The id of parent process group of this component if applicable." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "identity" : { - "type" : "string", - "description" : "The identity of the tenant." - }, - "configurable" : { - "type" : "boolean", - "description" : "Whether this tenant is configurable." - } - } - }, - "TenantEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "component" : { - "$ref" : "#/definitions/TenantDTO" - } - }, - "xml" : { - "name" : "tenantEntity" - } - }, - "TenantsEntity" : { - "type" : "object", - "properties" : { - "users" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/TenantEntity" - } - }, - "userGroups" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/TenantEntity" - } - } - }, - "xml" : { - "name" : "tenantsEntity" - } - }, - "TransactionResultEntity" : { - "type" : "object", - "properties" : { - "flowFileSent" : { - "type" : "integer", - "format" : "int32" - }, - "responseCode" : { - "type" : "integer", - "format" : "int32" - }, - "message" : { - "type" : "string" - } - }, - "xml" : { - "name" : "transactionResultEntity" - } - }, - "UpdateControllerServiceReferenceRequestEntity" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The identifier of the Controller Service." - }, - "state" : { - "type" : "string", - "description" : "The new state of the references for the controller service.", - "enum" : [ "ENABLED", "DISABLED", "RUNNING", "STOPPED" ] - }, - "referencingComponentRevisions" : { - "type" : "object", - "description" : "The revisions for all referencing components.", - "additionalProperties" : { - "$ref" : "#/definitions/RevisionDTO" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - } - }, - "xml" : { - "name" : "updateControllerServiceReferenceRequestEntity" - } - }, - "UriBuilder" : { - "type" : "object" - }, - "UserDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "versionedComponentId" : { - "type" : "string", - "description" : "The ID of the corresponding component that is under version control" - }, - "parentGroupId" : { - "type" : "string", - "description" : "The id of parent process group of this component if applicable." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "identity" : { - "type" : "string", - "description" : "The identity of the tenant." - }, - "configurable" : { - "type" : "boolean", - "description" : "Whether this tenant is configurable." - }, - "userGroups" : { - "type" : "array", - "description" : "The groups to which the user belongs. This field is read only and it provided for convenience.", - "readOnly" : true, - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/TenantEntity" - } - }, - "accessPolicies" : { - "type" : "array", - "description" : "The access policies this user belongs to.", - "readOnly" : true, - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/AccessPolicySummaryEntity" - } - } - } - }, - "UserEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "component" : { - "$ref" : "#/definitions/UserDTO" - } - }, - "xml" : { - "name" : "userEntity" - } - }, - "UserGroupDTO" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "versionedComponentId" : { - "type" : "string", - "description" : "The ID of the corresponding component that is under version control" - }, - "parentGroupId" : { - "type" : "string", - "description" : "The id of parent process group of this component if applicable." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "identity" : { - "type" : "string", - "description" : "The identity of the tenant." - }, - "configurable" : { - "type" : "boolean", - "description" : "Whether this tenant is configurable." - }, - "users" : { - "type" : "array", - "description" : "The users that belong to the user group.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/TenantEntity" - } - }, - "accessPolicies" : { - "type" : "array", - "description" : "The access policies this user group belongs to. This field was incorrectly defined as an AccessPolicyEntity. For compatibility reasons the field will remain of this type, however only the fields that are present in the AccessPolicySummaryEntity will be populated here.", - "readOnly" : true, - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/AccessPolicyEntity" - } - } - } - }, - "UserGroupEntity" : { - "type" : "object", - "properties" : { - "revision" : { - "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", - "$ref" : "#/definitions/RevisionDTO" - }, - "id" : { - "type" : "string", - "description" : "The id of the component." - }, - "uri" : { - "type" : "string", - "description" : "The URI for futures requests to the component." - }, - "position" : { - "description" : "The position of this component in the UI if applicable.", - "$ref" : "#/definitions/PositionDTO" - }, - "permissions" : { - "description" : "The permissions for this component.", - "$ref" : "#/definitions/PermissionsDTO" - }, - "bulletins" : { - "type" : "array", - "description" : "The bulletins for this component.", - "items" : { - "$ref" : "#/definitions/BulletinEntity" - } - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "component" : { - "$ref" : "#/definitions/UserGroupDTO" - } - }, - "xml" : { - "name" : "userGroupEntity" - } - }, - "UserGroupsEntity" : { - "type" : "object", - "properties" : { - "userGroups" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/UserGroupEntity" - } - } - }, - "xml" : { - "name" : "userGroupsEntity" - } - }, - "UsersEntity" : { - "type" : "object", - "properties" : { - "generated" : { - "type" : "string", - "description" : "When this content was generated." - }, - "users" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/UserEntity" - } - } - }, - "xml" : { - "name" : "usersEntity" - } - }, - "VariableDTO" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The name of the variable" - }, - "value" : { - "type" : "string", - "description" : "The value of the variable" - }, - "processGroupId" : { - "type" : "string", - "description" : "The ID of the Process Group where this Variable is defined", - "readOnly" : true - }, - "affectedComponents" : { - "type" : "array", - "description" : "A set of all components that will be affected if the value of this variable is changed", - "readOnly" : true, - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/AffectedComponentEntity" - } - } - } - }, - "VariableEntity" : { - "type" : "object", - "properties" : { - "variable" : { - "description" : "The variable information", - "$ref" : "#/definitions/VariableDTO" - }, - "canWrite" : { - "type" : "boolean", - "description" : "Indicates whether the user can write a given resource.", - "readOnly" : true - } - }, - "xml" : { - "name" : "variableEntity" - } - }, - "VariableRegistryDTO" : { - "type" : "object", - "properties" : { - "variables" : { - "type" : "array", - "description" : "The variables that are available in this Variable Registry", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VariableEntity" - } - }, - "processGroupId" : { - "type" : "string", - "description" : "The UUID of the Process Group that this Variable Registry belongs to" - } - } - }, - "VariableRegistryEntity" : { - "type" : "object", - "properties" : { - "processGroupRevision" : { - "description" : "The revision of the Process Group that the Variable Registry belongs to", - "$ref" : "#/definitions/RevisionDTO" - }, - "variableRegistry" : { - "description" : "The Variable Registry.", - "$ref" : "#/definitions/VariableRegistryDTO" - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - } - }, - "xml" : { - "name" : "variableRegistryEntity" - } - }, - "VariableRegistryUpdateRequestDTO" : { - "type" : "object", - "properties" : { - "requestId" : { - "type" : "string", - "description" : "The unique ID of this request.", - "readOnly" : true - }, - "processGroupId" : { - "type" : "string", - "description" : "The unique ID of the Process Group that the variable registry belongs to" - }, - "uri" : { - "type" : "string", - "description" : "The URI for future requests to this drop request.", - "readOnly" : true - }, - "submissionTime" : { - "type" : "string", - "description" : "The time at which this request was submitted.", - "readOnly" : true - }, - "lastUpdated" : { - "type" : "string", - "description" : "The last time this request was updated.", - "readOnly" : true - }, - "complete" : { - "type" : "boolean", - "description" : "Whether or not this request has completed", - "readOnly" : true - }, - "failureReason" : { - "type" : "string", - "description" : "An explanation of why this request failed, or null if this request has not failed", - "readOnly" : true - }, - "updateSteps" : { - "type" : "array", - "description" : "The steps that are required in order to complete the request, along with the status of each", - "readOnly" : true, - "items" : { - "$ref" : "#/definitions/VariableRegistryUpdateStepDTO" - } - }, - "affectedComponents" : { - "type" : "array", - "description" : "A set of all components that will be affected if the value of this variable is changed", - "readOnly" : true, - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/AffectedComponentEntity" - } - } - } - }, - "VariableRegistryUpdateRequestEntity" : { - "type" : "object", - "properties" : { - "request" : { - "description" : "The Variable Registry Update Request", - "$ref" : "#/definitions/VariableRegistryUpdateRequestDTO" - }, - "processGroupRevision" : { - "description" : "The revision for the Process Group that owns this variable registry.", - "$ref" : "#/definitions/RevisionDTO" - } - }, - "xml" : { - "name" : "variableRegistryUpdateRequestEntity" - } - }, - "VariableRegistryUpdateStepDTO" : { - "type" : "object", - "properties" : { - "description" : { - "type" : "string", - "description" : "Explanation of what happens in this step", - "readOnly" : true - }, - "complete" : { - "type" : "boolean", - "description" : "Whether or not this step has completed", - "readOnly" : true - }, - "failureReason" : { - "type" : "string", - "description" : "An explanation of why this step failed, or null if this step did not fail", - "readOnly" : true - } - } - }, - "VersionControlComponentMappingEntity" : { - "type" : "object", - "properties" : { - "versionControlComponentMapping" : { - "type" : "object", - "description" : "The mapping of Versioned Component Identifiers to instance ID's", - "additionalProperties" : { - "type" : "string" - } - }, - "processGroupRevision" : { - "description" : "The revision of the Process Group", - "$ref" : "#/definitions/RevisionDTO" - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - }, - "versionControlInformation" : { - "description" : "The Version Control information", - "$ref" : "#/definitions/VersionControlInformationDTO" - } - }, - "xml" : { - "name" : "versionControlComponentMappingEntity" - } - }, - "VersionControlInformationDTO" : { - "type" : "object", - "properties" : { - "groupId" : { - "type" : "string", - "description" : "The ID of the Process Group that is under version control" - }, - "registryId" : { - "type" : "string", - "description" : "The ID of the registry that the flow is stored in" - }, - "registryName" : { - "type" : "string", - "description" : "The name of the registry that the flow is stored in", - "readOnly" : true - }, - "bucketId" : { - "type" : "string", - "description" : "The ID of the bucket that the flow is stored in" - }, - "bucketName" : { - "type" : "string", - "description" : "The name of the bucket that the flow is stored in", - "readOnly" : true - }, - "flowId" : { - "type" : "string", - "description" : "The ID of the flow" - }, - "flowName" : { - "type" : "string", - "description" : "The name of the flow" - }, - "flowDescription" : { - "type" : "string", - "description" : "The description of the flow" - }, - "version" : { - "type" : "integer", - "format" : "int32", - "description" : "The version of the flow" - }, - "state" : { - "type" : "string", - "description" : "The current state of the Process Group, as it relates to the Versioned Flow", - "readOnly" : true, - "enum" : [ "LOCALLY_MODIFIED", "STALE", "LOCALLY_MODIFIED_AND_STALE", "UP_TO_DATE", "SYNC_FAILURE" ] - }, - "stateExplanation" : { - "type" : "string", - "description" : "Explanation of why the group is in the specified state", - "readOnly" : true - } - } - }, - "VersionControlInformationEntity" : { - "type" : "object", - "properties" : { - "versionControlInformation" : { - "description" : "The Version Control information", - "$ref" : "#/definitions/VersionControlInformationDTO" - }, - "processGroupRevision" : { - "description" : "The Revision for the Process Group", - "$ref" : "#/definitions/RevisionDTO" - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - } - }, - "xml" : { - "name" : "versionControlInformationEntity" - } - }, - "VersionInfoDTO" : { - "type" : "object", - "properties" : { - "niFiVersion" : { - "type" : "string", - "description" : "The version of this NiFi." - }, - "javaVendor" : { - "type" : "string", - "description" : "Java JVM vendor" - }, - "javaVersion" : { - "type" : "string", - "description" : "Java version" - }, - "osName" : { - "type" : "string", - "description" : "Host operating system name" - }, - "osVersion" : { - "type" : "string", - "description" : "Host operating system version" - }, - "osArchitecture" : { - "type" : "string", - "description" : "Host operating system architecture" - }, - "buildTag" : { - "type" : "string", - "description" : "Build tag" - }, - "buildRevision" : { - "type" : "string", - "description" : "Build revision or commit hash" - }, - "buildBranch" : { - "type" : "string", - "description" : "Build branch" - }, - "buildTimestamp" : { - "type" : "string", - "format" : "date-time", - "description" : "Build timestamp" - } - } - }, - "VersionedConnection" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The component's unique identifier" - }, - "name" : { - "type" : "string", - "description" : "The component's name" - }, - "comments" : { - "type" : "string", - "description" : "The user-supplied comments for the component" - }, - "position" : { - "description" : "The component's position on the graph", - "$ref" : "#/definitions/Position" - }, - "source" : { - "description" : "The source of the connection.", - "$ref" : "#/definitions/ConnectableComponent" - }, - "destination" : { - "description" : "The destination of the connection.", - "$ref" : "#/definitions/ConnectableComponent" - }, - "labelIndex" : { - "type" : "integer", - "format" : "int32", - "description" : "The index of the bend point where to place the connection label." - }, - "zIndex" : { - "type" : "integer", - "format" : "int64", - "description" : "The z index of the connection." - }, - "selectedRelationships" : { - "type" : "array", - "description" : "The selected relationship that comprise the connection.", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - }, - "backPressureObjectThreshold" : { - "type" : "integer", - "format" : "int64", - "description" : "The object count threshold for determining when back pressure is applied. Updating this value is a passive change in the sense that it won't impact whether existing files over the limit are affected but it does help feeder processors to stop pushing too much into this work queue." - }, - "backPressureDataSizeThreshold" : { - "type" : "string", - "description" : "The object data size threshold for determining when back pressure is applied. Updating this value is a passive change in the sense that it won't impact whether existing files over the limit are affected but it does help feeder processors to stop pushing too much into this work queue." - }, - "flowFileExpiration" : { - "type" : "string", - "description" : "The amount of time a flow file may be in the flow before it will be automatically aged out of the flow. Once a flow file reaches this age it will be terminated from the flow the next time a processor attempts to start work on it." - }, - "prioritizers" : { - "type" : "array", - "description" : "The comparators used to prioritize the queue.", - "items" : { - "type" : "string" - } - }, - "bends" : { - "type" : "array", - "description" : "The bend points on the connection.", - "items" : { - "$ref" : "#/definitions/Position" - } - }, - "loadBalanceStrategy" : { - "type" : "string", - "description" : "The Strategy to use for load balancing data across the cluster, or null, if no Load Balance Strategy has been specified.", - "enum" : [ "DO_NOT_LOAD_BALANCE", "PARTITION_BY_ATTRIBUTE", "ROUND_ROBIN", "SINGLE_NODE" ] - }, - "partitioningAttribute" : { - "type" : "string", - "description" : "The attribute to use for partitioning data as it is load balanced across the cluster. If the Load Balance Strategy is configured to use PARTITION_BY_ATTRIBUTE, the value returned by this method is the name of the FlowFile Attribute that will be used to determine which node in the cluster should receive a given FlowFile. If the Load Balance Strategy is unset or is set to any other value, the Partitioning Attribute has no effect." - }, - "loadBalanceCompression" : { - "type" : "string", - "description" : "Whether or not compression should be used when transferring FlowFiles between nodes", - "enum" : [ "DO_NOT_COMPRESS", "COMPRESS_ATTRIBUTES_ONLY", "COMPRESS_ATTRIBUTES_AND_CONTENT" ] - }, - "componentType" : { - "type" : "string", - "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE" ] - }, - "groupIdentifier" : { - "type" : "string", - "description" : "The ID of the Process Group that this component belongs to" - } - } - }, - "VersionedControllerService" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The component's unique identifier" - }, - "name" : { - "type" : "string", - "description" : "The component's name" - }, - "comments" : { - "type" : "string", - "description" : "The user-supplied comments for the component" - }, - "position" : { - "description" : "The component's position on the graph", - "$ref" : "#/definitions/Position" - }, - "type" : { - "type" : "string", - "description" : "The type of the controller service." - }, - "bundle" : { - "description" : "The details of the artifact that bundled this processor type.", - "$ref" : "#/definitions/Bundle" - }, - "controllerServiceApis" : { - "type" : "array", - "description" : "Lists the APIs this Controller Service implements.", - "items" : { - "$ref" : "#/definitions/ControllerServiceAPI" - } - }, - "properties" : { - "type" : "object", - "description" : "The properties of the controller service.", - "additionalProperties" : { - "type" : "string" - } - }, - "propertyDescriptors" : { - "type" : "object", - "description" : "The property descriptors for the processor.", - "additionalProperties" : { - "$ref" : "#/definitions/VersionedPropertyDescriptor" - } - }, - "annotationData" : { - "type" : "string", - "description" : "The annotation for the controller service. This is how the custom UI relays configuration to the controller service." - }, - "componentType" : { - "type" : "string", - "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE" ] - }, - "groupIdentifier" : { - "type" : "string", - "description" : "The ID of the Process Group that this component belongs to" - } - } - }, - "VersionedFlowCoordinates" : { - "type" : "object", - "properties" : { - "registryUrl" : { - "type" : "string", - "description" : "The URL of the Flow Registry that contains the flow" - }, - "bucketId" : { - "type" : "string", - "description" : "The UUID of the bucket that the flow resides in" - }, - "flowId" : { - "type" : "string", - "description" : "The UUID of the flow" - }, - "version" : { - "type" : "integer", - "format" : "int32", - "description" : "The version of the flow" - }, - "latest" : { - "type" : "boolean", - "description" : "Whether or not these coordinates point to the latest version of the flow" - } - } - }, - "VersionedFlowDTO" : { - "type" : "object", - "properties" : { - "registryId" : { - "type" : "string", - "description" : "The ID of the registry that the flow is tracked to" - }, - "bucketId" : { - "type" : "string", - "description" : "The ID of the bucket where the flow is stored" - }, - "flowId" : { - "type" : "string", - "description" : "The ID of the flow" - }, - "flowName" : { - "type" : "string", - "description" : "The name of the flow" - }, - "description" : { - "type" : "string", - "description" : "A description of the flow" - }, - "comments" : { - "type" : "string", - "description" : "Comments for the changeset" - } - } - }, - "VersionedFlowEntity" : { - "type" : "object", - "properties" : { - "versionedFlow" : { - "description" : "The versioned flow", - "$ref" : "#/definitions/VersionedFlowDTO" - } - }, - "xml" : { - "name" : "versionedFlowEntity" - } - }, - "VersionedFlowSnapshotEntity" : { - "type" : "object", - "properties" : { - "versionedFlowSnapshot" : { - "description" : "The versioned flow snapshot", - "$ref" : "#/definitions/versionedFlowSnapshot" - }, - "processGroupRevision" : { - "description" : "The Revision of the Process Group under Version Control", - "$ref" : "#/definitions/RevisionDTO" - }, - "registryId" : { - "type" : "string", - "description" : "The ID of the Registry that this flow belongs to" - }, - "updateDescendantVersionedFlows" : { - "type" : "boolean", - "description" : "If the Process Group to be updated has a child or descendant Process Group that is also under Version Control, this specifies whether or not the contents of that child/descendant Process Group should be updated." - }, - "disconnectedNodeAcknowledged" : { - "type" : "boolean", - "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." - } - }, - "xml" : { - "name" : "versionedFlowSnapshotEntity" - } - }, - "VersionedFlowSnapshotMetadataEntity" : { - "type" : "object", - "properties" : { - "versionedFlowSnapshotMetadata" : { - "description" : "The collection of versioned flow snapshot metadata", - "$ref" : "#/definitions/versionedFlowSnapshotMetadata" - }, - "registryId" : { - "type" : "string", - "description" : "The ID of the Registry that this flow belongs to" - } - }, - "xml" : { - "name" : "versionedFlowSnapshotMetadataEntity" - } - }, - "VersionedFlowSnapshotMetadataSetEntity" : { - "type" : "object", - "properties" : { - "versionedFlowSnapshotMetadataSet" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedFlowSnapshotMetadataEntity" - } - } - }, - "xml" : { - "name" : "versionedFlowSnapshotMetadataSetEntity" - } - }, - "VersionedFlowUpdateRequestDTO" : { - "type" : "object", - "properties" : { - "requestId" : { - "type" : "string", - "description" : "The unique ID of this request.", - "readOnly" : true - }, - "processGroupId" : { - "type" : "string", - "description" : "The unique ID of the Process Group that the variable registry belongs to" - }, - "uri" : { - "type" : "string", - "description" : "The URI for future requests to this drop request.", - "readOnly" : true - }, - "lastUpdated" : { - "type" : "string", - "description" : "The last time this request was updated.", - "readOnly" : true - }, - "complete" : { - "type" : "boolean", - "description" : "Whether or not this request has completed", - "readOnly" : true - }, - "failureReason" : { - "type" : "string", - "description" : "An explanation of why this request failed, or null if this request has not failed", - "readOnly" : true - }, - "percentCompleted" : { - "type" : "integer", - "format" : "int32", - "description" : "The percentage complete for the request, between 0 and 100", - "readOnly" : true - }, - "state" : { - "type" : "string", - "description" : "The state of the request", - "readOnly" : true - }, - "versionControlInformation" : { - "description" : "The VersionControlInformation that describes where the Versioned Flow is located; this may not be populated until the request is completed.", - "readOnly" : true, - "$ref" : "#/definitions/VersionControlInformationDTO" - } - } - }, - "VersionedFlowUpdateRequestEntity" : { - "type" : "object", - "properties" : { - "request" : { - "description" : "The Versioned Flow Update Request", - "$ref" : "#/definitions/VersionedFlowUpdateRequestDTO" - }, - "processGroupRevision" : { - "description" : "The revision for the Process Group that owns this variable registry.", - "$ref" : "#/definitions/RevisionDTO" - } - }, - "xml" : { - "name" : "versionedFlowUpdateRequestEntity" - } - }, - "VersionedFlowsEntity" : { - "type" : "object", - "properties" : { - "versionedFlows" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedFlowEntity" - } - } - }, - "xml" : { - "name" : "versionedFlowsEntity" - } - }, - "VersionedFunnel" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The component's unique identifier" - }, - "name" : { - "type" : "string", - "description" : "The component's name" - }, - "comments" : { - "type" : "string", - "description" : "The user-supplied comments for the component" - }, - "position" : { - "description" : "The component's position on the graph", - "$ref" : "#/definitions/Position" - }, - "componentType" : { - "type" : "string", - "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE" ] - }, - "groupIdentifier" : { - "type" : "string", - "description" : "The ID of the Process Group that this component belongs to" - } - } - }, - "VersionedLabel" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The component's unique identifier" - }, - "name" : { - "type" : "string", - "description" : "The component's name" - }, - "comments" : { - "type" : "string", - "description" : "The user-supplied comments for the component" - }, - "position" : { - "description" : "The component's position on the graph", - "$ref" : "#/definitions/Position" - }, - "label" : { - "type" : "string", - "description" : "The text that appears in the label." - }, - "width" : { - "type" : "number", - "format" : "double", - "description" : "The width of the label in pixels when at a 1:1 scale." - }, - "height" : { - "type" : "number", - "format" : "double", - "description" : "The height of the label in pixels when at a 1:1 scale." - }, - "style" : { - "type" : "object", - "description" : "The styles for this label (font-size : 12px, background-color : #eee, etc).", - "additionalProperties" : { - "type" : "string" - } - }, - "componentType" : { - "type" : "string", - "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE" ] - }, - "groupIdentifier" : { - "type" : "string", - "description" : "The ID of the Process Group that this component belongs to" - } - } - }, - "VersionedPort" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The component's unique identifier" - }, - "name" : { - "type" : "string", - "description" : "The component's name" - }, - "comments" : { - "type" : "string", - "description" : "The user-supplied comments for the component" - }, - "position" : { - "description" : "The component's position on the graph", - "$ref" : "#/definitions/Position" - }, - "type" : { - "type" : "string", - "description" : "The type of port.", - "enum" : [ "INPUT_PORT", "OUTPUT_PORT" ] - }, - "concurrentlySchedulableTaskCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of tasks that should be concurrently scheduled for the port." - }, - "componentType" : { - "type" : "string", - "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE" ] - }, - "groupIdentifier" : { - "type" : "string", - "description" : "The ID of the Process Group that this component belongs to" - } - } - }, - "VersionedProcessGroup" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The component's unique identifier" - }, - "name" : { - "type" : "string", - "description" : "The component's name" - }, - "comments" : { - "type" : "string", - "description" : "The user-supplied comments for the component" - }, - "position" : { - "description" : "The component's position on the graph", - "$ref" : "#/definitions/Position" - }, - "processGroups" : { - "type" : "array", - "description" : "The child Process Groups", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedProcessGroup" - } - }, - "remoteProcessGroups" : { - "type" : "array", - "description" : "The Remote Process Groups", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedRemoteProcessGroup" - } - }, - "processors" : { - "type" : "array", - "description" : "The Processors", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedProcessor" - } - }, - "inputPorts" : { - "type" : "array", - "description" : "The Input Ports", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedPort" - } - }, - "outputPorts" : { - "type" : "array", - "description" : "The Output Ports", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedPort" - } - }, - "connections" : { - "type" : "array", - "description" : "The Connections", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedConnection" - } - }, - "labels" : { - "type" : "array", - "description" : "The Labels", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedLabel" - } - }, - "funnels" : { - "type" : "array", - "description" : "The Funnels", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedFunnel" - } - }, - "controllerServices" : { - "type" : "array", - "description" : "The Controller Services", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedControllerService" - } - }, - "versionedFlowCoordinates" : { - "description" : "The coordinates where the remote flow is stored, or null if the Process Group is not directly under Version Control", - "$ref" : "#/definitions/VersionedFlowCoordinates" - }, - "variables" : { - "type" : "object", - "description" : "The Variables in the Variable Registry for this Process Group (not including any ancestor or descendant Process Groups)", - "additionalProperties" : { - "type" : "string" - } - }, - "componentType" : { - "type" : "string", - "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE" ] - }, - "groupIdentifier" : { - "type" : "string", - "description" : "The ID of the Process Group that this component belongs to" - } - } - }, - "VersionedProcessor" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The component's unique identifier" - }, - "name" : { - "type" : "string", - "description" : "The component's name" - }, - "comments" : { - "type" : "string", - "description" : "The user-supplied comments for the component" - }, - "position" : { - "description" : "The component's position on the graph", - "$ref" : "#/definitions/Position" - }, - "bundle" : { - "description" : "Information about the bundle from which the component came", - "$ref" : "#/definitions/Bundle" - }, - "style" : { - "type" : "object", - "description" : "Stylistic data for rendering in a UI", - "additionalProperties" : { - "type" : "string" - } - }, - "type" : { - "type" : "string", - "description" : "The type of Processor" - }, - "properties" : { - "type" : "object", - "description" : "The properties for the processor. Properties whose value is not set will only contain the property name.", - "additionalProperties" : { - "type" : "string" - } - }, - "propertyDescriptors" : { - "type" : "object", - "description" : "The property descriptors for the processor.", - "additionalProperties" : { - "$ref" : "#/definitions/VersionedPropertyDescriptor" - } - }, - "annotationData" : { - "type" : "string", - "description" : "The annotation data for the processor used to relay configuration between a custom UI and the procesosr." - }, - "schedulingPeriod" : { - "type" : "string", - "description" : "The frequency with which to schedule the processor. The format of the value will depend on th value of schedulingStrategy." - }, - "schedulingStrategy" : { - "type" : "string", - "description" : "Indcates whether the prcessor should be scheduled to run in event or timer driven mode." - }, - "executionNode" : { - "type" : "string", - "description" : "Indicates the node where the process will execute." - }, - "penaltyDuration" : { - "type" : "string", - "description" : "The amout of time that is used when the process penalizes a flowfile." - }, - "yieldDuration" : { - "type" : "string", - "description" : "The amount of time that must elapse before this processor is scheduled again after yielding." - }, - "bulletinLevel" : { - "type" : "string", - "description" : "The level at which the processor will report bulletins." - }, - "runDurationMillis" : { - "type" : "integer", - "format" : "int64", - "description" : "The run duration for the processor in milliseconds." - }, - "concurrentlySchedulableTaskCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of tasks that should be concurrently schedule for the processor. If the processor doesn't allow parallol processing then any positive input will be ignored." - }, - "autoTerminatedRelationships" : { - "type" : "array", - "description" : "The names of all relationships that cause a flow file to be terminated if the relationship is not connected elsewhere. This property differs from the 'isAutoTerminate' property of the RelationshipDTO in that the RelationshipDTO is meant to depict the current configuration, whereas this property can be set in a DTO when updating a Processor in order to change which Relationships should be auto-terminated.", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - }, - "componentType" : { - "type" : "string", - "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE" ] - }, - "groupIdentifier" : { - "type" : "string", - "description" : "The ID of the Process Group that this component belongs to" - } - } - }, - "VersionedPropertyDescriptor" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The name of the property" - }, - "displayName" : { - "type" : "string", - "description" : "The display name of the property" - }, - "identifiesControllerService" : { - "type" : "boolean", - "description" : "Whether or not the property provides the identifier of a Controller Service" - }, - "sensitive" : { - "type" : "boolean", - "description" : "Whether or not the property is considered sensitive" - } - } - }, - "VersionedRemoteGroupPort" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The component's unique identifier" - }, - "name" : { - "type" : "string", - "description" : "The component's name" - }, - "comments" : { - "type" : "string", - "description" : "The user-supplied comments for the component" - }, - "position" : { - "description" : "The component's position on the graph", - "$ref" : "#/definitions/Position" - }, - "remoteGroupId" : { - "type" : "string", - "description" : "The id of the remote process group that the port resides in." - }, - "concurrentlySchedulableTaskCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of task that may transmit flowfiles to the target port concurrently." - }, - "useCompression" : { - "type" : "boolean", - "description" : "Whether the flowfiles are compressed when sent to the target port." - }, - "batchSize" : { - "description" : "The batch settings for data transmission.", - "$ref" : "#/definitions/BatchSize" - }, - "componentType" : { - "type" : "string", - "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE" ] - }, - "targetId" : { - "type" : "string", - "description" : "The ID of the port on the target NiFi instance" - }, - "groupIdentifier" : { - "type" : "string", - "description" : "The ID of the Process Group that this component belongs to" - } - } - }, - "VersionedRemoteProcessGroup" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The component's unique identifier" - }, - "name" : { - "type" : "string", - "description" : "The component's name" - }, - "comments" : { - "type" : "string", - "description" : "The user-supplied comments for the component" - }, - "position" : { - "description" : "The component's position on the graph", - "$ref" : "#/definitions/Position" - }, - "targetUri" : { - "type" : "string", - "description" : "[DEPRECATED] The target URI of the remote process group. If target uri is not set, but uris are set, then returns the first uri in the uris. If neither target uri nor uris are set, then returns null." - }, - "targetUris" : { - "type" : "string", - "description" : "The target URIs of the remote process group. If target uris is not set but target uri is set, then returns the single target uri. If neither target uris nor target uri is set, then returns null." - }, - "communicationsTimeout" : { - "type" : "string", - "description" : "The time period used for the timeout when communicating with the target." - }, - "yieldDuration" : { - "type" : "string", - "description" : "When yielding, this amount of time must elapse before the remote process group is scheduled again." - }, - "transportProtocol" : { - "type" : "string", - "description" : "The Transport Protocol that is used for Site-to-Site communications", - "enum" : [ "RAW", "HTTP" ] - }, - "localNetworkInterface" : { - "type" : "string", - "description" : "The local network interface to send/receive data. If not specified, any local address is used. If clustered, all nodes must have an interface with this identifier." - }, - "proxyHost" : { - "type" : "string" - }, - "proxyPort" : { - "type" : "integer", - "format" : "int32" - }, - "proxyUser" : { - "type" : "string" - }, - "inputPorts" : { - "type" : "array", - "description" : "A Set of Input Ports that can be connected to, in order to send data to the remote NiFi instance", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedRemoteGroupPort" - } - }, - "outputPorts" : { - "type" : "array", - "description" : "A Set of Output Ports that can be connected to, in order to pull data from the remote NiFi instance", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedRemoteGroupPort" - } - }, - "componentType" : { - "type" : "string", - "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE" ] - }, - "groupIdentifier" : { - "type" : "string", - "description" : "The ID of the Process Group that this component belongs to" - } - } - }, - "bucket" : { - "type" : "object", - "required" : [ "name" ], - "properties" : { - "link" : { - "description" : "An WebLink to this entity.", - "readOnly" : true, - "$ref" : "#/definitions/Link" - }, - "identifier" : { - "type" : "string", - "description" : "An ID to uniquely identify this object.", - "readOnly" : true - }, - "name" : { - "type" : "string", - "description" : "The name of the bucket." - }, - "createdTimestamp" : { - "type" : "integer", - "format" : "int64", - "description" : "The timestamp of when the bucket was first created. This is set by the server at creation time.", - "readOnly" : true, - "minimum" : 1 - }, - "description" : { - "type" : "string", - "description" : "A description of the bucket." - }, - "permissions" : { - "description" : "The access that the current user has to this bucket.", - "readOnly" : true, - "$ref" : "#/definitions/permissions" - } - } - }, - "permissions" : { - "type" : "object", - "properties" : { - "canRead" : { - "type" : "boolean", - "description" : "Indicates whether the user can read a given resource.", - "readOnly" : true - }, - "canWrite" : { - "type" : "boolean", - "description" : "Indicates whether the user can write a given resource.", - "readOnly" : true - }, - "canDelete" : { - "type" : "boolean", - "description" : "Indicates whether the user can delete a given resource.", - "readOnly" : true - } - } - }, - "versionedFlow" : { - "type" : "object", - "required" : [ "bucketIdentifier", "name", "type" ], - "properties" : { - "link" : { - "description" : "An WebLink to this entity.", - "readOnly" : true, - "$ref" : "#/definitions/Link" - }, - "identifier" : { - "type" : "string", - "description" : "An ID to uniquely identify this object.", - "readOnly" : true - }, - "name" : { - "type" : "string", - "description" : "The name of the item." - }, - "description" : { - "type" : "string", - "description" : "A description of the item." - }, - "bucketIdentifier" : { - "type" : "string", - "description" : "The identifier of the bucket this items belongs to. This cannot be changed after the item is created." - }, - "bucketName" : { - "type" : "string", - "description" : "The name of the bucket this items belongs to.", - "readOnly" : true - }, - "createdTimestamp" : { - "type" : "integer", - "format" : "int64", - "description" : "The timestamp of when the item was created, as milliseconds since epoch.", - "readOnly" : true, - "minimum" : 1 - }, - "modifiedTimestamp" : { - "type" : "integer", - "format" : "int64", - "description" : "The timestamp of when the item was last modified, as milliseconds since epoch.", - "readOnly" : true, - "minimum" : 1 - }, - "type" : { - "type" : "string", - "description" : "The type of item.", - "enum" : [ "Flow" ] - }, - "permissions" : { - "description" : "The access that the current user has to the bucket containing this item.", - "readOnly" : true, - "$ref" : "#/definitions/permissions" - }, - "versionCount" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of versions of this flow.", - "readOnly" : true, - "minimum" : 0 - } - } - }, - "versionedFlowSnapshot" : { - "type" : "object", - "required" : [ "flowContents", "snapshotMetadata" ], - "properties" : { - "snapshotMetadata" : { - "description" : "The metadata for this snapshot", - "$ref" : "#/definitions/versionedFlowSnapshotMetadata" - }, - "flowContents" : { - "description" : "The contents of the versioned flow", - "$ref" : "#/definitions/VersionedProcessGroup" - }, - "flow" : { - "description" : "The flow this snapshot is for", - "readOnly" : true, - "$ref" : "#/definitions/versionedFlow" - }, - "bucket" : { - "description" : "The bucket where the flow is located", - "readOnly" : true, - "$ref" : "#/definitions/bucket" - }, - "latest" : { - "type" : "boolean" - } - } - }, - "versionedFlowSnapshotMetadata" : { - "type" : "object", - "required" : [ "bucketIdentifier", "flowIdentifier", "version" ], - "properties" : { - "link" : { - "description" : "An WebLink to this entity.", - "readOnly" : true, - "$ref" : "#/definitions/Link" - }, - "bucketIdentifier" : { - "type" : "string", - "description" : "The identifier of the bucket this snapshot belongs to." - }, - "flowIdentifier" : { - "type" : "string", - "description" : "The identifier of the flow this snapshot belongs to." - }, - "version" : { - "type" : "integer", - "format" : "int32", - "description" : "The version of this snapshot of the flow.", - "minimum" : 1 - }, - "timestamp" : { - "type" : "integer", - "format" : "int64", - "description" : "The timestamp when the flow was saved, as milliseconds since epoch.", - "readOnly" : true, - "minimum" : 1 - }, - "author" : { - "type" : "string", - "description" : "The user that created this snapshot of the flow.", - "readOnly" : true - }, - "comments" : { - "type" : "string", - "description" : "The comments provided by the user when creating the snapshot." - } - } - } - } -} diff --git a/resources/client_gen/api_defs/nifi-2.5.0.json b/resources/client_gen/api_defs/nifi-2.5.0.json new file mode 100644 index 00000000..cb716d3d --- /dev/null +++ b/resources/client_gen/api_defs/nifi-2.5.0.json @@ -0,0 +1,29222 @@ +{ + "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.5.0" + }, + "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." + } + }, + "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" + } + } + } + } + }, + "summary" : "Retrieves the authentication configuration endpoint 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" ] + } + }, + "/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}/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" : [ { + "Read - /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_1", + "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" + } + } ], + "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" : "Retrieves 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}" : [ ] + }, { + "Write - if the Controller Service is restricted - /restricted-components" : [ ] + } ], + "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}" : [ ] + }, { + "Write - if the Flow Analysis Rule is restricted - /restricted-components" : [ ] + } ], + "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}/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" : [ { + "Read - /flow-analysis-rules/{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", + "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" + } + } ], + "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" : [ { + "in" : "query", + "name" : "disconnectedNodeAcknowledged", + "schema" : { + "type" : "boolean", + "default" : false + } + }, { + "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}" : [ ] + }, { + "Write - if the Parameter Provider is restricted - /restricted-components" : [ ] + } ], + "summary" : "Creates a new 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}/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 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}" : [ ] + }, { + "Write - if the Reporting Task is restricted - /restricted-components" : [ ] + } ], + "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" ] + } + }, + "/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" : [ { + "in" : "path", + "name" : "portId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "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" + } + }, { + "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 flow files 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" : [ { + "in" : "path", + "name" : "portId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "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" + } + }, { + "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 flow files 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" + } + }, { + "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.", + "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/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" : [ { + "in" : "query", + "name" : "uiOnly", + "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." + }, + "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" + } + } + } + } + }, + "security" : [ { + "Read - /flow" : [ ] + } ], + "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/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/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" : "array", + "enum" : [ "NIFI", "JVM", "BULLETIN", "CONNECTION", "CLUSTER" ], + "items" : { + "type" : "string", + "enum" : [ "NIFI", "JVM", "BULLETIN", "CONNECTION", "CLUSTER", "NIFI", "JVM", "BULLETIN", "CONNECTION", "CLUSTER" ] + }, + "uniqueItems" : true + } + }, { + "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" + } + } ], + "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", + "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}/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 comopnents 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" : [ { + "in" : "query", + "name" : "q", + "schema" : { + "type" : "string", + "default" : "" + } + }, { + "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" ] + } + }, + "/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}/run-status" : { + "put" : { + "operationId" : "updateRunStatus_2", + "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}/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 - /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" : { + "description" : "Lists the assets that belong to the Parameter Context with the given ID.", + "operationId" : "getAssets", + "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", + "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" : [ { + "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", + "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" : [ { + "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}" : [ ] + } ], + "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}" : [ ] + } ], + "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}/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" : [ { + "Read - /parameter-providers/{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" + } + } ], + "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" : [ { + "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}" : [ ] + }, { + "Write - if the Controller Service is restricted - /restricted-components" : [ ] + } ], + "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 + } + } ], + "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 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}" : [ ] + } ], + "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" + } + } + } + }, + "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" + }, + "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}" : [ ] + }, { + "Write - if the Processor is restricted - /restricted-components" : [ ] + } ], + "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" : [ ] + }, { + "Write - if the snapshot contains any restricted components - /restricted-components" : [ ] + }, { + "Read - /parameter-contexts/{uuid} - For any Parameter Context that is referenced by a Property that is changed, added, or removed" : [ ] + } ], + "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" : [ ] + }, { + "Write - if the snippet contains any restricted Processors - /restricted-components" : [ ] + } ], + "summary" : "Copies a snippet and discards it.", + "tags" : [ "ProcessGroups" ] + } + }, + "/processors/run-status-details/queries" : { + "post" : { + "operationId" : "getProcessorRunStatusDetails", + "requestBody" : { + "content" : { + "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}/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" : [ { + "Read - /processors/{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_4", + "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" + } + } ], + "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 incremental results are returned. If false, provenance events are only returned once the query completes. This property is true by default.", + "in" : "query", + "name" : "summarize", + "schema" : { + "type" : "boolean", + "default" : false + } + }, { + "description" : "Whether or not to summarize provenance events returned. This property is false 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.", + "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}/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.", + "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.", + "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 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.", + "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.", + "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 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}/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" : [ { + "Read - /reporting-tasks/{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_5", + "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" + } + } ], + "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" : "Whether or not to include verbose details. Optional, defaults to false", + "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}" : [ ] + } ], + "summary" : "Update the version of a Process Group with the given ID", + "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/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" : [ ] + }, { + "Write - if the template contains any restricted components - /restricted-components" : [ ] + }, { + "Read - /parameter-contexts/{uuid} - For any Parameter Context that is referenced by a Property that is changed, added, or removed" : [ ] + } ], + "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" : [ ] + }, { + "Write - if the template contains any restricted components - /restricted-components" : [ ] + }, { + "Read - /parameter-contexts/{uuid} - For any Parameter Context that is referenced by a Property that is changed, added, or removed" : [ ] + } ], + "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." + }, + "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" + } + }, + "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 flow files 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 flow files 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" + }, + "timestamp" : { + "type" : "string", + "description" : "When this bulletin was generated." + } + } + }, + "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." + } + }, + "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." + } + } + }, + "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 list of differences for each component in the flow that is not the same between the two flows", + "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" + } + }, + "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" + } + }, + "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." + }, + "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" ] + }, + "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" + } + }, + "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.", + "enum" : [ "DO_NOT_COMPRESS", "COMPRESS_ATTRIBUTES_ONLY", "COMPRESS_ATTRIBUTES_AND_CONTENT" ] + }, + "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.", + "enum" : [ "LOAD_BALANCE_NOT_CONFIGURED", "LOAD_BALANCE_INACTIVE", "LOAD_BALANCE_ACTIVE" ], + "readOnly" : true + }, + "loadBalanceStrategy" : { + "type" : "string", + "description" : "How to load balance the data in this Connection across the nodes in the cluster.", + "enum" : [ "DO_NOT_LOAD_BALANCE", "PARTITION_BY_ATTRIBUTE", "ROUND_ROBIN", "SINGLE_NODE" ] + }, + "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." + } + }, + "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 flow files size and backpressure threshold if configured." + }, + "predictedPercentCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Predicted connection percent use regarding queued flow files 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." + }, + "name" : { + "type" : "string", + "description" : "The name of the connection." + }, + "output" : { + "type" : "string", + "description" : "The output count/sie for the connection in the last 5 minutes, pretty printed." + }, + "percentUseBytes" : { + "type" : "integer", + "format" : "int32", + "description" : "Connection percent use regarding queued flow files size and backpressure threshold if configured." + }, + "percentUseCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Connection percent use regarding queued flow files 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" + } + }, + "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 Flow Files. If this instance is not configured to receive Flow Files 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 Flow Files. If this instance is not configured to receive Flow Files 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 ontroller 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" ] + }, + "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" + } + }, + "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 + }, + "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" : "Indicates that this property is for selecting a controller service of the specified type", + "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" + } + } + }, + "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 enfored.", + "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 flow files currently queued." + }, + "currentCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of flow files currently queued." + }, + "currentSize" : { + "type" : "integer", + "format" : "int64", + "description" : "The size of flow files currently queued in bytes." + }, + "dropped" : { + "type" : "string", + "description" : "The count and size of flow files that have been dropped thus far." + }, + "droppedCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of flow files that have been dropped thus far." + }, + "droppedSize" : { + "type" : "integer", + "format" : "int64", + "description" : "The size of flow files that have been dropped thus far in bytes." + }, + "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 flow files to be dropped as a result of this request." + }, + "originalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of flow files to be dropped as a result of this request." + }, + "originalSize" : { + "type" : "integer", + "format" : "int64", + "description" : "The size of flow files to be dropped as a result of this request in bytes." + }, + "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 enfored.", + "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 + } + } + }, + "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", "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" + } + } + } + }, + "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" + } + } + }, + "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" : { + "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" + } + } + }, + "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 procesosr." + }, + "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.", + "enum" : [ "PENALIZE_FLOWFILE", "YIELD_PROCESSOR" ] + }, + "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 parallol 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." + }, + "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" ] + }, + "style" : { + "type" : "object", + "additionalProperties" : { + "type" : "string", + "description" : "Styles for the processor (background-color : #eee)." + }, + "description" : "Styles for the processor (background-color : #eee)." + }, + "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" + }, + "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 mintues" + }, + "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 prcessor." + }, + "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" : "A list of the allowable values for the 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 + }, + "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" + } + }, + "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" + } + } + } + }, + "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." + }, + "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 thats unique per node." + }, + "eventTime" : { + "type" : "string", + "description" : "The timestamp of the event." + }, + "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 genereate 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 childrent flowfiles of the provenance event.", + "items" : { + "type" : "string", + "description" : "The uuid of the childrent flowfiles of the provenance event." + } + }, + "clusterNodeIdentifier" : { + "type" : "string", + "description" : "The identifier of the node that this event/flowfile originated from." + }, + "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." + } + } + }, + "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" + }, + "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 repoting 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" + } + }, + "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." + } + } + }, + "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 + }, + "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" + } + } + }, + "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" ] + }, + "destination" : { + "$ref" : "#/components/schemas/ConnectableComponent" + }, + "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." + }, + "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", + "enum" : [ "DO_NOT_COMPRESS, COMPRESS_ATTRIBUTES_ONLY, COMPRESS_ATTRIBUTES_AND_CONTENT" ] + }, + "loadBalanceStrategy" : { + "type" : "string", + "description" : "The Strategy to use for load balancing data across the cluster, or null, if no Load Balance Strategy has been specified.", + "enum" : [ "DO_NOT_LOAD_BALANCE, PARTITION_BY_ATTRIBUTE, ROUND_ROBIN, SINGLE_NODE" ] + }, + "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" + }, + "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" ] + }, + "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" + } + }, + "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" ] + }, + "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" ] + }, + "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." + } + } + }, + "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" ] + }, + "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" ] + }, + "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" ] + }, + "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 procesosr." + }, + "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.", + "enum" : [ "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" + }, + "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" ] + }, + "concurrentlySchedulableTaskCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of tasks that should be concurrently schedule for the processor. If the processor doesn't allow parallol processing then any positive input will be ignored." + }, + "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 amout 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" + }, + "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" ] + }, + "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" ] + }, + "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", + "enum" : [ "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" + }, + "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" ] + }, + "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 + } + } + } + } + } +} \ No newline at end of file diff --git a/resources/client_gen/api_defs/registry-0.3.0.json b/resources/client_gen/api_defs/registry-0.3.0.json deleted file mode 100644 index b2e2ef19..00000000 --- a/resources/client_gen/api_defs/registry-0.3.0.json +++ /dev/null @@ -1,3658 +0,0 @@ -{ - "swagger" : "2.0", - "info" : { - "description" : "The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components.", - "version" : "0.3.0", - "title" : "NiFi Registry REST API", - "contact" : { - "name" : "Apache NiFi Registry", - "url" : "https://nifi.apache.org", - "email" : "dev@nifi.apache.org" - }, - "license" : { - "name" : "Apache 2.0 License", - "url" : "http://www.apache.org/licenses/LICENSE-2.0.html" - } - }, - "basePath" : "/nifi-registry-api", - "tags" : [ { - "name" : "access", - "description" : "Endpoints for obtaining an access token or checking access status." - }, { - "name" : "bucket_flows", - "description" : "Create flows scoped to an existing bucket in the registry." - }, { - "name" : "buckets", - "description" : "Create named buckets in the registry to store NiFi objects such flows and extensions. Search for and retrieve existing buckets." - }, { - "name" : "config", - "description" : "Retrieves the configuration for this NiFi Registry." - }, { - "name" : "flows", - "description" : "Gets metadata about flows." - }, { - "name" : "items", - "description" : "Retrieve items across all buckets for which the user is authorized." - }, { - "name" : "policies", - "description" : "Endpoint for managing access policies." - }, { - "name" : "tenants", - "description" : "Endpoint for managing users and user groups." - } ], - "schemes" : [ "http", "https" ], - "paths" : { - "/access" : { - "get" : { - "tags" : [ "access" ], - "summary" : "Returns the current client's authenticated identity and permissions to top-level resources", - "description" : "", - "operationId" : "getAccessStatus", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/currentUser" - } - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid. The NiFi Registry might be running unsecured." - } - }, - "security" : [ { - "Authorization" : [ ] - } ] - } - }, - "/access/token" : { - "post" : { - "tags" : [ "access" ], - "summary" : "Creates a token for accessing the REST API via auto-detected method of verifying client identity claim credentials", - "description" : "The token returned is formatted as a JSON Web Token (JWT). The token is base64 encoded and comprised of three parts. The header, the body, and the signature. The expiration of the token is a contained within the body. The token can be used in the Authorization header in the format 'Authorization: Bearer '.", - "operationId" : "createAccessTokenByTryingAllProviders", - "consumes" : [ "*/*" ], - "produces" : [ "text/plain" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid. The NiFi Registry may not be configured to support login with username/password." - }, - "500" : { - "description" : "NiFi Registry was unable to complete the request because an unexpected error occurred." - } - } - } - }, - "/access/token/identity-provider" : { - "post" : { - "tags" : [ "access" ], - "summary" : "Creates a token for accessing the REST API via a custom identity provider.", - "description" : "The user credentials must be passed in a format understood by the custom identity provider, e.g., a third-party auth token in an HTTP header. The exact format of the user credentials expected by the custom identity provider can be discovered by 'GET /access/token/identity-provider/usage'. The token returned is formatted as a JSON Web Token (JWT). The token is base64 encoded and comprised of three parts. The header, the body, and the signature. The expiration of the token is a contained within the body. The token can be used in the Authorization header in the format 'Authorization: Bearer '.", - "operationId" : "createAccessTokenUsingIdentityProviderCredentials", - "consumes" : [ "*/*" ], - "produces" : [ "text/plain" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid. The NiFi Registry may not be configured to support login with customized credentials." - }, - "500" : { - "description" : "NiFi Registry was unable to complete the request because an unexpected error occurred." - } - } - } - }, - "/access/token/identity-provider/test" : { - "post" : { - "tags" : [ "access" ], - "summary" : "Tests the format of the credentials against this identity provider without preforming authentication on the credentials to validate them.", - "description" : "The user credentials should be passed in a format understood by the custom identity provider as defined by 'GET /access/token/identity-provider/usage'.", - "operationId" : "testIdentityProviderRecognizesCredentialsFormat", - "consumes" : [ "*/*" ], - "produces" : [ "text/plain" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "The format of the credentials were not recognized by the currently configured identity provider." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid. The NiFi Registry may not be configured to support login with customized credentials." - }, - "500" : { - "description" : "NiFi Registry was unable to complete the request because an unexpected error occurred." - } - } - } - }, - "/access/token/identity-provider/usage" : { - "get" : { - "tags" : [ "access" ], - "summary" : "Provides a description of how the currently configured identity provider expects credentials to be passed to POST /access/token/identity-provider", - "description" : "", - "operationId" : "getIdentityProviderUsageInstructions", - "consumes" : [ "*/*" ], - "produces" : [ "text/plain" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid. The NiFi Registry may not be configured to support login with customized credentials." - }, - "500" : { - "description" : "NiFi Registry was unable to complete the request because an unexpected error occurred." - } - } - } - }, - "/access/token/kerberos" : { - "post" : { - "tags" : [ "access" ], - "summary" : "Creates a token for accessing the REST API via Kerberos Service Tickets or SPNEGO Tokens (which includes Kerberos Service Tickets)", - "description" : "The token returned is formatted as a JSON Web Token (JWT). The token is base64 encoded and comprised of three parts. The header, the body, and the signature. The expiration of the token is a contained within the body. The token can be used in the Authorization header in the format 'Authorization: Bearer '.", - "operationId" : "createAccessTokenUsingKerberosTicket", - "consumes" : [ "*/*" ], - "produces" : [ "text/plain" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid. The NiFi Registry may not be configured to support login Kerberos credentials." - }, - "500" : { - "description" : "NiFi Registry was unable to complete the request because an unexpected error occurred." - } - } - } - }, - "/access/token/login" : { - "post" : { - "tags" : [ "access" ], - "summary" : "Creates a token for accessing the REST API via username/password", - "description" : "The user credentials must be passed in standard HTTP Basic Auth format. That is: 'Authorization: Basic ', where is the base64 encoded value of ':'. The token returned is formatted as a JSON Web Token (JWT). The token is base64 encoded and comprised of three parts. The header, the body, and the signature. The expiration of the token is a contained within the body. The token can be used in the Authorization header in the format 'Authorization: Bearer '.", - "operationId" : "createAccessTokenUsingBasicAuthCredentials", - "consumes" : [ "*/*" ], - "produces" : [ "text/plain" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid. The NiFi Registry may not be configured to support login with username/password." - }, - "500" : { - "description" : "NiFi Registry was unable to complete the request because an unexpected error occurred." - } - }, - "security" : [ { - "BasicAuth" : [ ] - } ] - } - }, - "/buckets" : { - "get" : { - "tags" : [ "buckets" ], - "summary" : "Gets all buckets", - "description" : "The returned list will include only buckets for which the user is authorized.If the user is not authorized for any buckets, this returns an empty list.", - "operationId" : "getBuckets", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/bucket" - } - } - }, - "401" : { - "description" : "Client could not be authenticated." - } - }, - "security" : [ { - "Authorization" : [ ] - } ] - }, - "post" : { - "tags" : [ "buckets" ], - "summary" : "Creates a bucket", - "description" : "", - "operationId" : "createBucket", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The bucket to create", - "required" : true, - "schema" : { - "$ref" : "#/definitions/bucket" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/bucket" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets", - "action" : "write" - } - } - }, - "/buckets/fields" : { - "get" : { - "tags" : [ "buckets" ], - "summary" : "Retrieves field names for searching or sorting on buckets.", - "description" : "", - "operationId" : "getAvailableBucketFields", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/Fields" - } - } - }, - "security" : [ { - "Authorization" : [ ] - } ] - } - }, - "/buckets/{bucketId}" : { - "get" : { - "tags" : [ "buckets" ], - "summary" : "Gets a bucket", - "description" : "", - "operationId" : "getBucket", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketId", - "in" : "path", - "description" : "The bucket identifier", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/bucket" - } - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - }, - "put" : { - "tags" : [ "buckets" ], - "summary" : "Updates a bucket", - "description" : "", - "operationId" : "updateBucket", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketId", - "in" : "path", - "description" : "The bucket identifier", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The updated bucket", - "required" : true, - "schema" : { - "$ref" : "#/definitions/bucket" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/bucket" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "write" - } - }, - "delete" : { - "tags" : [ "buckets" ], - "summary" : "Deletes a bucket along with all objects stored in the bucket", - "description" : "", - "operationId" : "deleteBucket", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketId", - "in" : "path", - "description" : "The bucket identifier", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/bucket" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "delete" - } - } - }, - "/buckets/{bucketId}/flows" : { - "get" : { - "tags" : [ "bucket_flows" ], - "summary" : "Gets all flows in the given bucket", - "description" : "", - "operationId" : "getFlows", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketId", - "in" : "path", - "description" : "The bucket identifier", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/versionedFlow" - } - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - }, - "post" : { - "tags" : [ "bucket_flows" ], - "summary" : "Creates a flow", - "description" : "The flow id is created by the server and populated in the returned entity.", - "operationId" : "createFlow", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketId", - "in" : "path", - "description" : "The bucket identifier", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The details of the flow to create.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/versionedFlow" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/versionedFlow" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "write" - } - } - }, - "/buckets/{bucketId}/flows/{flowId}" : { - "get" : { - "tags" : [ "bucket_flows" ], - "summary" : "Gets a flow", - "description" : "", - "operationId" : "getFlow", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketId", - "in" : "path", - "description" : "The bucket identifier", - "required" : true, - "type" : "string" - }, { - "name" : "flowId", - "in" : "path", - "description" : "The flow identifier", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/versionedFlow" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - }, - "put" : { - "tags" : [ "bucket_flows" ], - "summary" : "Updates a flow", - "description" : "", - "operationId" : "updateFlow", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketId", - "in" : "path", - "description" : "The bucket identifier", - "required" : true, - "type" : "string" - }, { - "name" : "flowId", - "in" : "path", - "description" : "The flow identifier", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The updated flow", - "required" : true, - "schema" : { - "$ref" : "#/definitions/versionedFlow" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/versionedFlow" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "write" - } - }, - "delete" : { - "tags" : [ "bucket_flows" ], - "summary" : "Deletes a flow, including all saved versions of that flow.", - "description" : "", - "operationId" : "deleteFlow", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketId", - "in" : "path", - "description" : "The bucket identifier", - "required" : true, - "type" : "string" - }, { - "name" : "flowId", - "in" : "path", - "description" : "The flow identifier", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/versionedFlow" - } - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "delete" - } - } - }, - "/buckets/{bucketId}/flows/{flowId}/diff/{versionA}/{versionB}" : { - "get" : { - "tags" : [ "bucket_flows" ], - "summary" : "Returns a list of differences between 2 versions of a flow", - "description" : "", - "operationId" : "getFlowDiff", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketId", - "in" : "path", - "description" : "The bucket identifier", - "required" : true, - "type" : "string" - }, { - "name" : "flowId", - "in" : "path", - "description" : "The flow identifier", - "required" : true, - "type" : "string" - }, { - "name" : "versionA", - "in" : "path", - "description" : "The first version number", - "required" : true, - "type" : "integer", - "pattern" : "\\d+", - "format" : "int32" - }, { - "name" : "versionB", - "in" : "path", - "description" : "The second version number", - "required" : true, - "type" : "integer", - "pattern" : "\\d+", - "format" : "int32" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlowDifference" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/buckets/{bucketId}/flows/{flowId}/versions" : { - "get" : { - "tags" : [ "bucket_flows" ], - "summary" : "Gets summary information for all versions of a flow. Versions are ordered newest->oldest.", - "description" : "", - "operationId" : "getFlowVersions", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketId", - "in" : "path", - "description" : "The bucket identifier", - "required" : true, - "type" : "string" - }, { - "name" : "flowId", - "in" : "path", - "description" : "The flow identifier", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/versionedFlowSnapshotMetadata" - } - } - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - }, - "post" : { - "tags" : [ "bucket_flows" ], - "summary" : "Creates the next version of a flow", - "description" : "The version number of the object being created must be the next available version integer. Flow versions are immutable after they are created.", - "operationId" : "createFlowVersion", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketId", - "in" : "path", - "description" : "The bucket identifier", - "required" : true, - "type" : "string" - }, { - "name" : "flowId", - "in" : "path", - "description" : "The flow identifier", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The new versioned flow snapshot.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/versionedFlowSnapshot" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/versionedFlowSnapshot" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "write" - } - } - }, - "/buckets/{bucketId}/flows/{flowId}/versions/latest" : { - "get" : { - "tags" : [ "bucket_flows" ], - "summary" : "Get the latest version of a flow", - "description" : "", - "operationId" : "getLatestFlowVersion", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketId", - "in" : "path", - "description" : "The bucket identifier", - "required" : true, - "type" : "string" - }, { - "name" : "flowId", - "in" : "path", - "description" : "The flow identifier", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/versionedFlowSnapshot" - } - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/buckets/{bucketId}/flows/{flowId}/versions/latest/metadata" : { - "get" : { - "tags" : [ "bucket_flows" ], - "summary" : "Get the metadata for the latest version of a flow", - "description" : "", - "operationId" : "getLatestFlowVersionMetadata", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketId", - "in" : "path", - "description" : "The bucket identifier", - "required" : true, - "type" : "string" - }, { - "name" : "flowId", - "in" : "path", - "description" : "The flow identifier", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/versionedFlowSnapshotMetadata" - } - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/buckets/{bucketId}/flows/{flowId}/versions/{versionNumber}" : { - "get" : { - "tags" : [ "bucket_flows" ], - "summary" : "Gets the given version of a flow", - "description" : "", - "operationId" : "getFlowVersion", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketId", - "in" : "path", - "description" : "The bucket identifier", - "required" : true, - "type" : "string" - }, { - "name" : "flowId", - "in" : "path", - "description" : "The flow identifier", - "required" : true, - "type" : "string" - }, { - "name" : "versionNumber", - "in" : "path", - "description" : "The version number", - "required" : true, - "type" : "integer", - "pattern" : "\\d+", - "format" : "int32" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/versionedFlowSnapshot" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/config" : { - "get" : { - "tags" : [ "config" ], - "summary" : "Gets NiFi Registry configurations", - "description" : "", - "operationId" : "getConfiguration", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/registryConfiguration" - } - }, - "401" : { - "description" : "Client could not be authenticated." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/policies,/tenants", - "action" : "read" - } - } - }, - "/flows/fields" : { - "get" : { - "tags" : [ "flows" ], - "summary" : "Retrieves the available field names that can be used for searching or sorting on flows.", - "description" : "", - "operationId" : "getAvailableFlowFields", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/Fields" - } - } - }, - "security" : [ { - "Authorization" : [ ] - } ] - } - }, - "/flows/{flowId}" : { - "get" : { - "tags" : [ "flows" ], - "summary" : "Gets a flow", - "description" : "", - "operationId" : "globalGetFlow", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "flowId", - "in" : "path", - "description" : "The flow identifier", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/versionedFlow" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/flows/{flowId}/versions" : { - "get" : { - "tags" : [ "flows" ], - "summary" : "Gets summary information for all versions of a flow. Versions are ordered newest->oldest.", - "description" : "", - "operationId" : "globalGetFlowVersions", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "flowId", - "in" : "path", - "description" : "The flow identifier", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/versionedFlowSnapshotMetadata" - } - } - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/flows/{flowId}/versions/latest" : { - "get" : { - "tags" : [ "flows" ], - "summary" : "Get the latest version of a flow", - "description" : "", - "operationId" : "globalGetLatestFlowVersion", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "flowId", - "in" : "path", - "description" : "The flow identifier", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/versionedFlowSnapshot" - } - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/flows/{flowId}/versions/latest/metadata" : { - "get" : { - "tags" : [ "flows" ], - "summary" : "Get the metadata for the latest version of a flow", - "description" : "", - "operationId" : "globalGetLatestFlowVersionMetadata", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "flowId", - "in" : "path", - "description" : "The flow identifier", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/versionedFlowSnapshotMetadata" - } - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/flows/{flowId}/versions/{versionNumber}" : { - "get" : { - "tags" : [ "flows" ], - "summary" : "Gets the given version of a flow", - "description" : "", - "operationId" : "globalGetFlowVersion", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "flowId", - "in" : "path", - "description" : "The flow identifier", - "required" : true, - "type" : "string" - }, { - "name" : "versionNumber", - "in" : "path", - "description" : "The version number", - "required" : true, - "type" : "integer", - "pattern" : "\\d+", - "format" : "int32" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/versionedFlowSnapshot" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/items" : { - "get" : { - "tags" : [ "items" ], - "summary" : "Get items across all buckets", - "description" : "The returned items will include only items from buckets for which the user is authorized. If the user is not authorized to any buckets, an empty list will be returned.", - "operationId" : "getItems", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/bucketItem" - } - } - }, - "401" : { - "description" : "Client could not be authenticated." - } - }, - "security" : [ { - "Authorization" : [ ] - } ] - } - }, - "/items/fields" : { - "get" : { - "tags" : [ "items" ], - "summary" : "Retrieves the available field names for searching or sorting on bucket items.", - "description" : "", - "operationId" : "getAvailableBucketItemFields", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/Fields" - } - } - }, - "security" : [ { - "Authorization" : [ ] - } ] - } - }, - "/items/{bucketId}" : { - "get" : { - "tags" : [ "items" ], - "summary" : "Gets items of the given bucket", - "description" : "", - "operationId" : "getItemsInBucket", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketId", - "in" : "path", - "description" : "The bucket identifier", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/bucketItem" - } - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/policies" : { - "get" : { - "tags" : [ "policies" ], - "summary" : "Gets all access policies", - "description" : "", - "operationId" : "getAccessPolicies", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/accessPolicy" - } - } - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/policies", - "action" : "read" - } - }, - "post" : { - "tags" : [ "policies" ], - "summary" : "Creates an access policy", - "description" : "", - "operationId" : "createAccessPolicy", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The access policy configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/accessPolicy" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/accessPolicy" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid. The NiFi Registry might not be configured to use a ConfigurableAccessPolicyProvider." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/policies", - "action" : "write" - } - } - }, - "/policies/resources" : { - "get" : { - "tags" : [ "policies" ], - "summary" : "Gets the available resources that support access/authorization policies", - "description" : "", - "operationId" : "getResources", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/resource" - } - } - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/policies", - "action" : "read" - } - } - }, - "/policies/{action}/{resource}" : { - "get" : { - "tags" : [ "policies" ], - "summary" : "Gets an access policy for the specified action and resource", - "description" : "", - "operationId" : "getAccessPolicyForResource", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "action", - "in" : "path", - "description" : "The request action.", - "required" : true, - "type" : "string", - "enum" : [ "read", "write", "delete" ] - }, { - "name" : "resource", - "in" : "path", - "description" : "The resource of the policy.", - "required" : true, - "type" : "string", - "pattern" : ".+" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/accessPolicy" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/policies", - "action" : "read" - } - } - }, - "/policies/{id}" : { - "get" : { - "tags" : [ "policies" ], - "summary" : "Gets an access policy", - "description" : "", - "operationId" : "getAccessPolicy", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The access policy id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/accessPolicy" - } - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/policies", - "action" : "read" - } - }, - "put" : { - "tags" : [ "policies" ], - "summary" : "Updates a access policy", - "description" : "", - "operationId" : "updateAccessPolicy", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The access policy id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The access policy configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/accessPolicy" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/accessPolicy" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid. The NiFi Registry might not be configured to use a ConfigurableAccessPolicyProvider." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/policies", - "action" : "write" - } - }, - "delete" : { - "tags" : [ "policies" ], - "summary" : "Deletes an access policy", - "description" : "", - "operationId" : "removeAccessPolicy", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The access policy id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/accessPolicy" - } - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid. The NiFi Registry might not be configured to use a ConfigurableAccessPolicyProvider." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/policies", - "action" : "delete" - } - } - }, - "/tenants/user-groups" : { - "get" : { - "tags" : [ "tenants" ], - "summary" : "Gets all user groups", - "description" : "Note: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getUserGroups", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/userGroup" - } - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/tenants", - "action" : "read" - } - }, - "post" : { - "tags" : [ "tenants" ], - "summary" : "Creates a user group", - "description" : "Note: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "createUserGroup", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The user group configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/userGroup" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/userGroup" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/tenants", - "action" : "write" - } - } - }, - "/tenants/user-groups/{id}" : { - "get" : { - "tags" : [ "tenants" ], - "summary" : "Gets a user group", - "description" : "Note: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getUserGroup", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The user group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/userGroup" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/tenants", - "action" : "read" - } - }, - "put" : { - "tags" : [ "tenants" ], - "summary" : "Updates a user group", - "description" : "Note: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "updateUserGroup", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The user group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The user group configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/userGroup" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/userGroup" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/tenants", - "action" : "write" - } - }, - "delete" : { - "tags" : [ "tenants" ], - "summary" : "Deletes a user group", - "description" : "Note: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "removeUserGroup", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The user group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/userGroup" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/tenants", - "action" : "delete" - } - } - }, - "/tenants/users" : { - "get" : { - "tags" : [ "tenants" ], - "summary" : "Gets all users", - "description" : "Note: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getUsers", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/user" - } - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/tenants", - "action" : "read" - } - }, - "post" : { - "tags" : [ "tenants" ], - "summary" : "Creates a user", - "description" : "Note: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "createUser", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The user configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/user" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/user" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/tenants", - "action" : "write" - } - } - }, - "/tenants/users/{id}" : { - "get" : { - "tags" : [ "tenants" ], - "summary" : "Gets a user", - "description" : "Note: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getUser", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The user id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/user" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/tenants", - "action" : "read" - } - }, - "put" : { - "tags" : [ "tenants" ], - "summary" : "Updates a user", - "description" : "Note: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "updateUser", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The user id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The user configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/user" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/user" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/tenants", - "action" : "write" - } - }, - "delete" : { - "tags" : [ "tenants" ], - "summary" : "Deletes a user", - "description" : "Note: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "removeUser", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The user id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/user" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/tenants", - "action" : "delete" - } - } - } - }, - "securityDefinitions" : { - "Authorization" : { - "description" : "NiFi Registry Auth Token (JWT)", - "type" : "apiKey", - "name" : "Authorization", - "in" : "header" - }, - "BasicAuth" : { - "description" : "HTTP Basic Auth", - "type" : "basic" - } - }, - "definitions" : { - "BatchSize" : { - "type" : "object", - "properties" : { - "count" : { - "type" : "integer", - "format" : "int32", - "description" : "Preferred number of flow files to include in a transaction." - }, - "size" : { - "type" : "string", - "description" : "Preferred number of bytes to include in a transaction." - }, - "duration" : { - "type" : "string", - "description" : "Preferred amount of time that a transaction should span." - } - } - }, - "Bundle" : { - "type" : "object", - "properties" : { - "group" : { - "type" : "string", - "description" : "The group of the bundle" - }, - "artifact" : { - "type" : "string", - "description" : "The artifact of the bundle" - }, - "version" : { - "type" : "string", - "description" : "The version of the bundle" - } - } - }, - "ComponentDifference" : { - "type" : "object", - "properties" : { - "valueA" : { - "type" : "string", - "description" : "The earlier value from the difference." - }, - "valueB" : { - "type" : "string", - "description" : "The newer value from the difference." - }, - "changeDescription" : { - "type" : "string", - "description" : "The description of the change." - }, - "differenceType" : { - "type" : "string", - "description" : "The key to the difference." - }, - "differenceTypeDescription" : { - "type" : "string", - "description" : "The description of the change type." - } - } - }, - "ComponentDifferenceGroup" : { - "type" : "object", - "properties" : { - "componentId" : { - "type" : "string", - "description" : "The id of the component whose changes are grouped together." - }, - "componentName" : { - "type" : "string", - "description" : "The name of the component whose changes are grouped together." - }, - "componentType" : { - "type" : "string", - "description" : "The type of component these changes relate to." - }, - "processGroupId" : { - "type" : "string", - "description" : "The process group id for this component." - }, - "differences" : { - "type" : "array", - "description" : "The list of changes related to this component between the 2 versions.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ComponentDifference" - } - } - } - }, - "ConnectableComponent" : { - "type" : "object", - "required" : [ "groupId", "id", "type" ], - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the connectable component." - }, - "type" : { - "type" : "string", - "description" : "The type of component the connectable is.", - "enum" : [ "PROCESSOR", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "INPUT_PORT", "OUTPUT_PORT", "FUNNEL" ] - }, - "groupId" : { - "type" : "string", - "description" : "The id of the group that the connectable component resides in" - }, - "name" : { - "type" : "string", - "description" : "The name of the connectable component" - }, - "comments" : { - "type" : "string", - "description" : "The comments for the connectable component." - } - } - }, - "ControllerServiceAPI" : { - "type" : "object", - "properties" : { - "type" : { - "type" : "string", - "description" : "The fully qualified name of the service interface." - }, - "bundle" : { - "description" : "The details of the artifact that bundled this service interface.", - "$ref" : "#/definitions/Bundle" - } - } - }, - "Fields" : { - "type" : "object", - "properties" : { - "fields" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - } - } - }, - "Link" : { - "type" : "object", - "properties" : { - "type" : { - "type" : "string" - }, - "params" : { - "type" : "object", - "additionalProperties" : { - "type" : "string" - } - }, - "title" : { - "type" : "string" - }, - "uri" : { - "type" : "string", - "format" : "uri" - }, - "uriBuilder" : { - "$ref" : "#/definitions/UriBuilder" - }, - "rel" : { - "type" : "string" - }, - "rels" : { - "type" : "array", - "items" : { - "type" : "string" - } - } - } - }, - "Position" : { - "type" : "object", - "properties" : { - "x" : { - "type" : "number", - "format" : "double", - "description" : "The x coordinate." - }, - "y" : { - "type" : "number", - "format" : "double", - "description" : "The y coordinate." - } - }, - "description" : "The position of a component on the graph" - }, - "UriBuilder" : { - "type" : "object" - }, - "VersionedConnection" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The component's unique identifier" - }, - "name" : { - "type" : "string", - "description" : "The component's name" - }, - "comments" : { - "type" : "string", - "description" : "The user-supplied comments for the component" - }, - "position" : { - "description" : "The component's position on the graph", - "$ref" : "#/definitions/Position" - }, - "source" : { - "description" : "The source of the connection.", - "$ref" : "#/definitions/ConnectableComponent" - }, - "destination" : { - "description" : "The destination of the connection.", - "$ref" : "#/definitions/ConnectableComponent" - }, - "labelIndex" : { - "type" : "integer", - "format" : "int32", - "description" : "The index of the bend point where to place the connection label." - }, - "zIndex" : { - "type" : "integer", - "format" : "int64", - "description" : "The z index of the connection." - }, - "selectedRelationships" : { - "type" : "array", - "description" : "The selected relationship that comprise the connection.", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - }, - "backPressureObjectThreshold" : { - "type" : "integer", - "format" : "int64", - "description" : "The object count threshold for determining when back pressure is applied. Updating this value is a passive change in the sense that it won't impact whether existing files over the limit are affected but it does help feeder processors to stop pushing too much into this work queue." - }, - "backPressureDataSizeThreshold" : { - "type" : "string", - "description" : "The object data size threshold for determining when back pressure is applied. Updating this value is a passive change in the sense that it won't impact whether existing files over the limit are affected but it does help feeder processors to stop pushing too much into this work queue." - }, - "flowFileExpiration" : { - "type" : "string", - "description" : "The amount of time a flow file may be in the flow before it will be automatically aged out of the flow. Once a flow file reaches this age it will be terminated from the flow the next time a processor attempts to start work on it." - }, - "prioritizers" : { - "type" : "array", - "description" : "The comparators used to prioritize the queue.", - "items" : { - "type" : "string" - } - }, - "bends" : { - "type" : "array", - "description" : "The bend points on the connection.", - "items" : { - "$ref" : "#/definitions/Position" - } - }, - "loadBalanceStrategy" : { - "type" : "string", - "description" : "The Strategy to use for load balancing data across the cluster, or null, if no Load Balance Strategy has been specified.", - "enum" : [ "DO_NOT_LOAD_BALANCE", "PARTITION_BY_ATTRIBUTE", "ROUND_ROBIN", "SINGLE_NODE" ] - }, - "partitioningAttribute" : { - "type" : "string", - "description" : "The attribute to use for partitioning data as it is load balanced across the cluster. If the Load Balance Strategy is configured to use PARTITION_BY_ATTRIBUTE, the value returned by this method is the name of the FlowFile Attribute that will be used to determine which node in the cluster should receive a given FlowFile. If the Load Balance Strategy is unset or is set to any other value, the Partitioning Attribute has no effect." - }, - "loadBalanceCompression" : { - "type" : "string", - "description" : "Whether or not compression should be used when transferring FlowFiles between nodes", - "enum" : [ "DO_NOT_COMPRESS", "COMPRESS_ATTRIBUTES_ONLY", "COMPRESS_ATTRIBUTES_AND_CONTENT" ] - }, - "componentType" : { - "type" : "string", - "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE" ] - }, - "groupIdentifier" : { - "type" : "string", - "description" : "The ID of the Process Group that this component belongs to" - } - } - }, - "VersionedControllerService" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The component's unique identifier" - }, - "name" : { - "type" : "string", - "description" : "The component's name" - }, - "comments" : { - "type" : "string", - "description" : "The user-supplied comments for the component" - }, - "position" : { - "description" : "The component's position on the graph", - "$ref" : "#/definitions/Position" - }, - "type" : { - "type" : "string", - "description" : "The type of the controller service." - }, - "bundle" : { - "description" : "The details of the artifact that bundled this processor type.", - "$ref" : "#/definitions/Bundle" - }, - "controllerServiceApis" : { - "type" : "array", - "description" : "Lists the APIs this Controller Service implements.", - "items" : { - "$ref" : "#/definitions/ControllerServiceAPI" - } - }, - "properties" : { - "type" : "object", - "description" : "The properties of the controller service.", - "additionalProperties" : { - "type" : "string" - } - }, - "propertyDescriptors" : { - "type" : "object", - "description" : "The property descriptors for the processor.", - "additionalProperties" : { - "$ref" : "#/definitions/VersionedPropertyDescriptor" - } - }, - "annotationData" : { - "type" : "string", - "description" : "The annotation for the controller service. This is how the custom UI relays configuration to the controller service." - }, - "componentType" : { - "type" : "string", - "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE" ] - }, - "groupIdentifier" : { - "type" : "string", - "description" : "The ID of the Process Group that this component belongs to" - } - } - }, - "VersionedFlowCoordinates" : { - "type" : "object", - "properties" : { - "registryUrl" : { - "type" : "string", - "description" : "The URL of the Flow Registry that contains the flow" - }, - "bucketId" : { - "type" : "string", - "description" : "The UUID of the bucket that the flow resides in" - }, - "flowId" : { - "type" : "string", - "description" : "The UUID of the flow" - }, - "version" : { - "type" : "integer", - "format" : "int32", - "description" : "The version of the flow" - }, - "latest" : { - "type" : "boolean", - "description" : "Whether or not these coordinates point to the latest version of the flow" - } - } - }, - "VersionedFlowDifference" : { - "type" : "object", - "properties" : { - "bucketId" : { - "type" : "string", - "description" : "The id of the bucket that the flow is stored in." - }, - "flowId" : { - "type" : "string", - "description" : "The id of the flow that is being examined." - }, - "versionA" : { - "type" : "integer", - "format" : "int32", - "description" : "The earlier version from the diff operation." - }, - "versionB" : { - "type" : "integer", - "format" : "int32", - "description" : "The latter version from the diff operation." - }, - "componentDifferenceGroups" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ComponentDifferenceGroup" - } - } - } - }, - "VersionedFunnel" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The component's unique identifier" - }, - "name" : { - "type" : "string", - "description" : "The component's name" - }, - "comments" : { - "type" : "string", - "description" : "The user-supplied comments for the component" - }, - "position" : { - "description" : "The component's position on the graph", - "$ref" : "#/definitions/Position" - }, - "componentType" : { - "type" : "string", - "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE" ] - }, - "groupIdentifier" : { - "type" : "string", - "description" : "The ID of the Process Group that this component belongs to" - } - } - }, - "VersionedLabel" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The component's unique identifier" - }, - "name" : { - "type" : "string", - "description" : "The component's name" - }, - "comments" : { - "type" : "string", - "description" : "The user-supplied comments for the component" - }, - "position" : { - "description" : "The component's position on the graph", - "$ref" : "#/definitions/Position" - }, - "label" : { - "type" : "string", - "description" : "The text that appears in the label." - }, - "width" : { - "type" : "number", - "format" : "double", - "description" : "The width of the label in pixels when at a 1:1 scale." - }, - "height" : { - "type" : "number", - "format" : "double", - "description" : "The height of the label in pixels when at a 1:1 scale." - }, - "style" : { - "type" : "object", - "description" : "The styles for this label (font-size : 12px, background-color : #eee, etc).", - "additionalProperties" : { - "type" : "string" - } - }, - "componentType" : { - "type" : "string", - "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE" ] - }, - "groupIdentifier" : { - "type" : "string", - "description" : "The ID of the Process Group that this component belongs to" - } - } - }, - "VersionedPort" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The component's unique identifier" - }, - "name" : { - "type" : "string", - "description" : "The component's name" - }, - "comments" : { - "type" : "string", - "description" : "The user-supplied comments for the component" - }, - "position" : { - "description" : "The component's position on the graph", - "$ref" : "#/definitions/Position" - }, - "type" : { - "type" : "string", - "description" : "The type of port.", - "enum" : [ "INPUT_PORT", "OUTPUT_PORT" ] - }, - "concurrentlySchedulableTaskCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of tasks that should be concurrently scheduled for the port." - }, - "componentType" : { - "type" : "string", - "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE" ] - }, - "groupIdentifier" : { - "type" : "string", - "description" : "The ID of the Process Group that this component belongs to" - } - } - }, - "VersionedProcessGroup" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The component's unique identifier" - }, - "name" : { - "type" : "string", - "description" : "The component's name" - }, - "comments" : { - "type" : "string", - "description" : "The user-supplied comments for the component" - }, - "position" : { - "description" : "The component's position on the graph", - "$ref" : "#/definitions/Position" - }, - "processGroups" : { - "type" : "array", - "description" : "The child Process Groups", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedProcessGroup" - } - }, - "remoteProcessGroups" : { - "type" : "array", - "description" : "The Remote Process Groups", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedRemoteProcessGroup" - } - }, - "processors" : { - "type" : "array", - "description" : "The Processors", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedProcessor" - } - }, - "inputPorts" : { - "type" : "array", - "description" : "The Input Ports", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedPort" - } - }, - "outputPorts" : { - "type" : "array", - "description" : "The Output Ports", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedPort" - } - }, - "connections" : { - "type" : "array", - "description" : "The Connections", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedConnection" - } - }, - "labels" : { - "type" : "array", - "description" : "The Labels", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedLabel" - } - }, - "funnels" : { - "type" : "array", - "description" : "The Funnels", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedFunnel" - } - }, - "controllerServices" : { - "type" : "array", - "description" : "The Controller Services", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedControllerService" - } - }, - "versionedFlowCoordinates" : { - "description" : "The coordinates where the remote flow is stored, or null if the Process Group is not directly under Version Control", - "$ref" : "#/definitions/VersionedFlowCoordinates" - }, - "variables" : { - "type" : "object", - "description" : "The Variables in the Variable Registry for this Process Group (not including any ancestor or descendant Process Groups)", - "additionalProperties" : { - "type" : "string" - } - }, - "componentType" : { - "type" : "string", - "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE" ] - }, - "groupIdentifier" : { - "type" : "string", - "description" : "The ID of the Process Group that this component belongs to" - } - } - }, - "VersionedProcessor" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The component's unique identifier" - }, - "name" : { - "type" : "string", - "description" : "The component's name" - }, - "comments" : { - "type" : "string", - "description" : "The user-supplied comments for the component" - }, - "position" : { - "description" : "The component's position on the graph", - "$ref" : "#/definitions/Position" - }, - "bundle" : { - "description" : "Information about the bundle from which the component came", - "$ref" : "#/definitions/Bundle" - }, - "style" : { - "type" : "object", - "description" : "Stylistic data for rendering in a UI", - "additionalProperties" : { - "type" : "string" - } - }, - "type" : { - "type" : "string", - "description" : "The type of Processor" - }, - "properties" : { - "type" : "object", - "description" : "The properties for the processor. Properties whose value is not set will only contain the property name.", - "additionalProperties" : { - "type" : "string" - } - }, - "propertyDescriptors" : { - "type" : "object", - "description" : "The property descriptors for the processor.", - "additionalProperties" : { - "$ref" : "#/definitions/VersionedPropertyDescriptor" - } - }, - "annotationData" : { - "type" : "string", - "description" : "The annotation data for the processor used to relay configuration between a custom UI and the procesosr." - }, - "schedulingPeriod" : { - "type" : "string", - "description" : "The frequency with which to schedule the processor. The format of the value will depend on th value of schedulingStrategy." - }, - "schedulingStrategy" : { - "type" : "string", - "description" : "Indcates whether the prcessor should be scheduled to run in event or timer driven mode." - }, - "executionNode" : { - "type" : "string", - "description" : "Indicates the node where the process will execute." - }, - "penaltyDuration" : { - "type" : "string", - "description" : "The amout of time that is used when the process penalizes a flowfile." - }, - "yieldDuration" : { - "type" : "string", - "description" : "The amount of time that must elapse before this processor is scheduled again after yielding." - }, - "bulletinLevel" : { - "type" : "string", - "description" : "The level at which the processor will report bulletins." - }, - "runDurationMillis" : { - "type" : "integer", - "format" : "int64", - "description" : "The run duration for the processor in milliseconds." - }, - "concurrentlySchedulableTaskCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of tasks that should be concurrently schedule for the processor. If the processor doesn't allow parallol processing then any positive input will be ignored." - }, - "autoTerminatedRelationships" : { - "type" : "array", - "description" : "The names of all relationships that cause a flow file to be terminated if the relationship is not connected elsewhere. This property differs from the 'isAutoTerminate' property of the RelationshipDTO in that the RelationshipDTO is meant to depict the current configuration, whereas this property can be set in a DTO when updating a Processor in order to change which Relationships should be auto-terminated.", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - }, - "componentType" : { - "type" : "string", - "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE" ] - }, - "groupIdentifier" : { - "type" : "string", - "description" : "The ID of the Process Group that this component belongs to" - } - } - }, - "VersionedPropertyDescriptor" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The name of the property" - }, - "displayName" : { - "type" : "string", - "description" : "The display name of the property" - }, - "identifiesControllerService" : { - "type" : "boolean", - "description" : "Whether or not the property provides the identifier of a Controller Service" - }, - "sensitive" : { - "type" : "boolean", - "description" : "Whether or not the property is considered sensitive" - } - } - }, - "VersionedRemoteGroupPort" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The component's unique identifier" - }, - "name" : { - "type" : "string", - "description" : "The component's name" - }, - "comments" : { - "type" : "string", - "description" : "The user-supplied comments for the component" - }, - "position" : { - "description" : "The component's position on the graph", - "$ref" : "#/definitions/Position" - }, - "remoteGroupId" : { - "type" : "string", - "description" : "The id of the remote process group that the port resides in." - }, - "concurrentlySchedulableTaskCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of task that may transmit flowfiles to the target port concurrently." - }, - "useCompression" : { - "type" : "boolean", - "description" : "Whether the flowfiles are compressed when sent to the target port." - }, - "batchSize" : { - "description" : "The batch settings for data transmission.", - "$ref" : "#/definitions/BatchSize" - }, - "componentType" : { - "type" : "string", - "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE" ] - }, - "targetId" : { - "type" : "string", - "description" : "The ID of the port on the target NiFi instance" - }, - "groupIdentifier" : { - "type" : "string", - "description" : "The ID of the Process Group that this component belongs to" - } - } - }, - "VersionedRemoteProcessGroup" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The component's unique identifier" - }, - "name" : { - "type" : "string", - "description" : "The component's name" - }, - "comments" : { - "type" : "string", - "description" : "The user-supplied comments for the component" - }, - "position" : { - "description" : "The component's position on the graph", - "$ref" : "#/definitions/Position" - }, - "targetUri" : { - "type" : "string", - "description" : "[DEPRECATED] The target URI of the remote process group. If target uri is not set, but uris are set, then returns the first uri in the uris. If neither target uri nor uris are set, then returns null." - }, - "targetUris" : { - "type" : "string", - "description" : "The target URIs of the remote process group. If target uris is not set but target uri is set, then returns the single target uri. If neither target uris nor target uri is set, then returns null." - }, - "communicationsTimeout" : { - "type" : "string", - "description" : "The time period used for the timeout when communicating with the target." - }, - "yieldDuration" : { - "type" : "string", - "description" : "When yielding, this amount of time must elapse before the remote process group is scheduled again." - }, - "transportProtocol" : { - "type" : "string", - "description" : "The Transport Protocol that is used for Site-to-Site communications", - "enum" : [ "RAW", "HTTP" ] - }, - "localNetworkInterface" : { - "type" : "string", - "description" : "The local network interface to send/receive data. If not specified, any local address is used. If clustered, all nodes must have an interface with this identifier." - }, - "proxyHost" : { - "type" : "string" - }, - "proxyPort" : { - "type" : "integer", - "format" : "int32" - }, - "proxyUser" : { - "type" : "string" - }, - "inputPorts" : { - "type" : "array", - "description" : "A Set of Input Ports that can be connected to, in order to send data to the remote NiFi instance", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedRemoteGroupPort" - } - }, - "outputPorts" : { - "type" : "array", - "description" : "A Set of Output Ports that can be connected to, in order to pull data from the remote NiFi instance", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedRemoteGroupPort" - } - }, - "componentType" : { - "type" : "string", - "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE" ] - }, - "groupIdentifier" : { - "type" : "string", - "description" : "The ID of the Process Group that this component belongs to" - } - } - }, - "accessPolicy" : { - "type" : "object", - "required" : [ "action", "resource" ], - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The id of the policy. Set by server at creation time.", - "readOnly" : true - }, - "resource" : { - "type" : "string", - "description" : "The resource for this access policy." - }, - "action" : { - "type" : "string", - "description" : "The action associated with this access policy.", - "enum" : [ "read", "write", "delete" ] - }, - "configurable" : { - "type" : "boolean", - "description" : "Indicates if this access policy is configurable, based on which Authorizer has been configured to manage it.", - "readOnly" : true - }, - "users" : { - "type" : "array", - "description" : "The set of user IDs associated with this access policy.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/tenant" - } - }, - "userGroups" : { - "type" : "array", - "description" : "The set of user group IDs associated with this access policy.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/tenant" - } - } - } - }, - "accessPolicySummary" : { - "type" : "object", - "required" : [ "action", "resource" ], - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The id of the policy. Set by server at creation time.", - "readOnly" : true - }, - "resource" : { - "type" : "string", - "description" : "The resource for this access policy." - }, - "action" : { - "type" : "string", - "description" : "The action associated with this access policy.", - "enum" : [ "read", "write", "delete" ] - }, - "configurable" : { - "type" : "boolean", - "description" : "Indicates if this access policy is configurable, based on which Authorizer has been configured to manage it.", - "readOnly" : true - } - } - }, - "bucket" : { - "type" : "object", - "required" : [ "name" ], - "properties" : { - "link" : { - "description" : "An WebLink to this entity.", - "readOnly" : true, - "$ref" : "#/definitions/Link" - }, - "identifier" : { - "type" : "string", - "description" : "An ID to uniquely identify this object.", - "readOnly" : true - }, - "name" : { - "type" : "string", - "description" : "The name of the bucket." - }, - "createdTimestamp" : { - "type" : "integer", - "format" : "int64", - "description" : "The timestamp of when the bucket was first created. This is set by the server at creation time.", - "readOnly" : true, - "minimum" : 1 - }, - "description" : { - "type" : "string", - "description" : "A description of the bucket." - }, - "permissions" : { - "description" : "The access that the current user has to this bucket.", - "readOnly" : true, - "$ref" : "#/definitions/permissions" - } - } - }, - "bucketItem" : { - "type" : "object", - "required" : [ "bucketIdentifier", "name", "type" ], - "properties" : { - "link" : { - "description" : "An WebLink to this entity.", - "readOnly" : true, - "$ref" : "#/definitions/Link" - }, - "identifier" : { - "type" : "string", - "description" : "An ID to uniquely identify this object.", - "readOnly" : true - }, - "name" : { - "type" : "string", - "description" : "The name of the item." - }, - "description" : { - "type" : "string", - "description" : "A description of the item." - }, - "bucketIdentifier" : { - "type" : "string", - "description" : "The identifier of the bucket this items belongs to. This cannot be changed after the item is created." - }, - "bucketName" : { - "type" : "string", - "description" : "The name of the bucket this items belongs to.", - "readOnly" : true - }, - "createdTimestamp" : { - "type" : "integer", - "format" : "int64", - "description" : "The timestamp of when the item was created, as milliseconds since epoch.", - "readOnly" : true, - "minimum" : 1 - }, - "modifiedTimestamp" : { - "type" : "integer", - "format" : "int64", - "description" : "The timestamp of when the item was last modified, as milliseconds since epoch.", - "readOnly" : true, - "minimum" : 1 - }, - "type" : { - "type" : "string", - "description" : "The type of item.", - "enum" : [ "Flow" ] - }, - "permissions" : { - "description" : "The access that the current user has to the bucket containing this item.", - "readOnly" : true, - "$ref" : "#/definitions/permissions" - } - } - }, - "currentUser" : { - "type" : "object", - "properties" : { - "identity" : { - "type" : "string", - "description" : "The identity of the current user", - "readOnly" : true - }, - "anonymous" : { - "type" : "boolean", - "description" : "Indicates if the current user is anonymous", - "readOnly" : true - }, - "resourcePermissions" : { - "description" : "The access that the current user has to top level resources", - "readOnly" : true, - "$ref" : "#/definitions/resourcePermissions" - } - } - }, - "permissions" : { - "type" : "object", - "properties" : { - "canRead" : { - "type" : "boolean", - "description" : "Indicates whether the user can read a given resource.", - "readOnly" : true - }, - "canWrite" : { - "type" : "boolean", - "description" : "Indicates whether the user can write a given resource.", - "readOnly" : true - }, - "canDelete" : { - "type" : "boolean", - "description" : "Indicates whether the user can delete a given resource.", - "readOnly" : true - } - } - }, - "registryConfiguration" : { - "type" : "object", - "properties" : { - "supportsManagedAuthorizer" : { - "type" : "boolean", - "description" : "Whether this NiFi Registry supports a managed authorizer. Managed authorizers can visualize users, groups, and policies in the UI.", - "readOnly" : true - }, - "supportsConfigurableAuthorizer" : { - "type" : "boolean", - "description" : "Whether this NiFi Registry supports a configurable authorizer.", - "readOnly" : true - }, - "supportsConfigurableUsersAndGroups" : { - "type" : "boolean", - "description" : "Whether this NiFi Registry supports configurable users and groups.", - "readOnly" : true - } - } - }, - "resource" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The identifier of the resource.", - "readOnly" : true - }, - "name" : { - "type" : "string", - "description" : "The name of the resource.", - "readOnly" : true - } - } - }, - "resourcePermissions" : { - "type" : "object", - "properties" : { - "buckets" : { - "description" : "The access that the current user has to the top level /buckets resource of this NiFi Registry (i.e., access to all buckets)", - "readOnly" : true, - "$ref" : "#/definitions/permissions" - }, - "tenants" : { - "description" : "The access that the current user has to the top level /tenants resource of this NiFi Registry", - "readOnly" : true, - "$ref" : "#/definitions/permissions" - }, - "policies" : { - "description" : "The access that the current user has to the top level /policies resource of this NiFi Registry", - "readOnly" : true, - "$ref" : "#/definitions/permissions" - }, - "proxy" : { - "description" : "The access that the current user has to the top level /proxy resource of this NiFi Registry", - "readOnly" : true, - "$ref" : "#/definitions/permissions" - }, - "anyTopLevelResource" : { - "description" : "The access that the current user has to any top level resources (a logical 'OR' of all other values)", - "readOnly" : true, - "$ref" : "#/definitions/permissions" - } - } - }, - "tenant" : { - "type" : "object", - "required" : [ "identity" ], - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The computer-generated identifier of the tenant.", - "readOnly" : true - }, - "identity" : { - "type" : "string", - "description" : "The human-facing identity of the tenant. This can only be changed if the tenant is configurable." - }, - "configurable" : { - "type" : "boolean", - "description" : "Indicates if this tenant is configurable, based on which UserGroupProvider has been configured to manage it.", - "readOnly" : true - }, - "resourcePermissions" : { - "description" : "A summary top-level resource access policies granted to this tenant.", - "readOnly" : true, - "$ref" : "#/definitions/resourcePermissions" - }, - "accessPolicies" : { - "type" : "array", - "description" : "The access policies granted to this tenant.", - "readOnly" : true, - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/accessPolicySummary" - } - } - } - }, - "user" : { - "type" : "object", - "required" : [ "identity" ], - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The computer-generated identifier of the tenant.", - "readOnly" : true - }, - "identity" : { - "type" : "string", - "description" : "The human-facing identity of the tenant. This can only be changed if the tenant is configurable." - }, - "configurable" : { - "type" : "boolean", - "description" : "Indicates if this tenant is configurable, based on which UserGroupProvider has been configured to manage it.", - "readOnly" : true - }, - "resourcePermissions" : { - "description" : "A summary top-level resource access policies granted to this tenant.", - "readOnly" : true, - "$ref" : "#/definitions/resourcePermissions" - }, - "accessPolicies" : { - "type" : "array", - "description" : "The access policies granted to this tenant.", - "readOnly" : true, - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/accessPolicySummary" - } - }, - "userGroups" : { - "type" : "array", - "description" : "The groups to which the user belongs.", - "readOnly" : true, - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/tenant" - } - } - } - }, - "userGroup" : { - "type" : "object", - "required" : [ "identity" ], - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The computer-generated identifier of the tenant.", - "readOnly" : true - }, - "identity" : { - "type" : "string", - "description" : "The human-facing identity of the tenant. This can only be changed if the tenant is configurable." - }, - "configurable" : { - "type" : "boolean", - "description" : "Indicates if this tenant is configurable, based on which UserGroupProvider has been configured to manage it.", - "readOnly" : true - }, - "resourcePermissions" : { - "description" : "A summary top-level resource access policies granted to this tenant.", - "readOnly" : true, - "$ref" : "#/definitions/resourcePermissions" - }, - "accessPolicies" : { - "type" : "array", - "description" : "The access policies granted to this tenant.", - "readOnly" : true, - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/accessPolicySummary" - } - }, - "users" : { - "type" : "array", - "description" : "The users that belong to this user group. This can only be changed if this group is configurable.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/tenant" - } - } - } - }, - "versionedFlow" : { - "type" : "object", - "required" : [ "bucketIdentifier", "name", "type" ], - "properties" : { - "link" : { - "description" : "An WebLink to this entity.", - "readOnly" : true, - "$ref" : "#/definitions/Link" - }, - "identifier" : { - "type" : "string", - "description" : "An ID to uniquely identify this object.", - "readOnly" : true - }, - "name" : { - "type" : "string", - "description" : "The name of the item." - }, - "description" : { - "type" : "string", - "description" : "A description of the item." - }, - "bucketIdentifier" : { - "type" : "string", - "description" : "The identifier of the bucket this items belongs to. This cannot be changed after the item is created." - }, - "bucketName" : { - "type" : "string", - "description" : "The name of the bucket this items belongs to.", - "readOnly" : true - }, - "createdTimestamp" : { - "type" : "integer", - "format" : "int64", - "description" : "The timestamp of when the item was created, as milliseconds since epoch.", - "readOnly" : true, - "minimum" : 1 - }, - "modifiedTimestamp" : { - "type" : "integer", - "format" : "int64", - "description" : "The timestamp of when the item was last modified, as milliseconds since epoch.", - "readOnly" : true, - "minimum" : 1 - }, - "type" : { - "type" : "string", - "description" : "The type of item.", - "enum" : [ "Flow" ] - }, - "permissions" : { - "description" : "The access that the current user has to the bucket containing this item.", - "readOnly" : true, - "$ref" : "#/definitions/permissions" - }, - "versionCount" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of versions of this flow.", - "readOnly" : true, - "minimum" : 0 - } - } - }, - "versionedFlowSnapshot" : { - "type" : "object", - "required" : [ "flowContents", "snapshotMetadata" ], - "properties" : { - "snapshotMetadata" : { - "description" : "The metadata for this snapshot", - "$ref" : "#/definitions/versionedFlowSnapshotMetadata" - }, - "flowContents" : { - "description" : "The contents of the versioned flow", - "$ref" : "#/definitions/VersionedProcessGroup" - }, - "flow" : { - "description" : "The flow this snapshot is for", - "readOnly" : true, - "$ref" : "#/definitions/versionedFlow" - }, - "bucket" : { - "description" : "The bucket where the flow is located", - "readOnly" : true, - "$ref" : "#/definitions/bucket" - }, - "latest" : { - "type" : "boolean" - } - } - }, - "versionedFlowSnapshotMetadata" : { - "type" : "object", - "required" : [ "bucketIdentifier", "flowIdentifier", "version" ], - "properties" : { - "link" : { - "description" : "An WebLink to this entity.", - "readOnly" : true, - "$ref" : "#/definitions/Link" - }, - "bucketIdentifier" : { - "type" : "string", - "description" : "The identifier of the bucket this snapshot belongs to." - }, - "flowIdentifier" : { - "type" : "string", - "description" : "The identifier of the flow this snapshot belongs to." - }, - "version" : { - "type" : "integer", - "format" : "int32", - "description" : "The version of this snapshot of the flow.", - "minimum" : 1 - }, - "timestamp" : { - "type" : "integer", - "format" : "int64", - "description" : "The timestamp when the flow was saved, as milliseconds since epoch.", - "readOnly" : true, - "minimum" : 1 - }, - "author" : { - "type" : "string", - "description" : "The user that created this snapshot of the flow.", - "readOnly" : true - }, - "comments" : { - "type" : "string", - "description" : "The comments provided by the user when creating the snapshot." - } - } - } - } -} \ No newline at end of file diff --git a/resources/client_gen/api_defs/registry-0.4.0-JIRA245.json b/resources/client_gen/api_defs/registry-0.4.0-JIRA245.json deleted file mode 100644 index 329daa7a..00000000 --- a/resources/client_gen/api_defs/registry-0.4.0-JIRA245.json +++ /dev/null @@ -1,6253 +0,0 @@ -{ - "swagger" : "2.0", - "info" : { - "description" : "The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components.", - "version" : "0.4.0-SNAPSHOT", - "title" : "Apache NiFi Registry REST API", - "termsOfService" : "As described in the license", - "contact" : { - "name" : "Apache NiFi Registry", - "url" : "https://nifi.apache.org", - "email" : "dev@nifi.apache.org" - }, - "license" : { - "name" : "Apache 2.0 License", - "url" : "http://www.apache.org/licenses/LICENSE-2.0.html" - } - }, - "basePath" : "/nifi-registry-api", - "tags" : [ { - "name" : "access", - "description" : "Endpoints for obtaining an access token or checking access status." - }, { - "name" : "bucket bundles", - "description" : "Create extension bundles scoped to an existing bucket in the registry. \n\nNOTE: This resource is subject to change as NiFi Registry and its REST API evolve." - }, { - "name" : "bucket flows", - "description" : "Create flows scoped to an existing bucket in the registry." - }, { - "name" : "buckets", - "description" : "Create named buckets in the registry to store NiFi objects such flows and extensions. Search for and retrieve existing buckets." - }, { - "name" : "bundles", - "description" : "Gets metadata about extension bundles and their versions. \n\nNOTE: This resource is subject to change as NiFi Registry and its REST API evolve." - }, { - "name" : "config", - "description" : "Retrieves the configuration for this NiFi Registry." - }, { - "name" : "extension repository", - "description" : "Interact with extension bundles via the hierarchy of bucket/group/artifact/version. \n\nNOTE: This resource is subject to change as NiFi Registry and its REST API evolve." - }, { - "name" : "extensions", - "description" : "Find and retrieve extensions. \n\nNOTE: This resource is subject to change as NiFi Registry and its REST API evolve." - }, { - "name" : "flows", - "description" : "Gets metadata about flows." - }, { - "name" : "items", - "description" : "Retrieve items across all buckets for which the user is authorized." - }, { - "name" : "policies", - "description" : "Endpoint for managing access policies." - }, { - "name" : "tenants", - "description" : "Endpoint for managing users and user groups." - } ], - "schemes" : [ "http", "https" ], - "paths" : { - "/access" : { - "get" : { - "tags" : [ "access" ], - "summary" : "Get access status", - "description" : "Returns the current client's authenticated identity and permissions to top-level resources", - "operationId" : "getAccessStatus", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/CurrentUser" - } - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid. The NiFi Registry might be running unsecured." - } - }, - "security" : [ { - "Authorization" : [ ] - } ] - } - }, - "/access/token" : { - "post" : { - "tags" : [ "access" ], - "summary" : "Create token trying all providers", - "description" : "Creates a token for accessing the REST API via auto-detected method of verifying client identity claim credentials. The token returned is formatted as a JSON Web Token (JWT). The token is base64 encoded and comprised of three parts. The header, the body, and the signature. The expiration of the token is a contained within the body. The token can be used in the Authorization header in the format 'Authorization: Bearer '.", - "operationId" : "createAccessTokenByTryingAllProviders", - "consumes" : [ "*/*" ], - "produces" : [ "text/plain" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid. The NiFi Registry may not be configured to support login with username/password." - }, - "500" : { - "description" : "NiFi Registry was unable to complete the request because an unexpected error occurred." - } - } - } - }, - "/access/token/identity-provider" : { - "post" : { - "tags" : [ "access" ], - "summary" : "Create token using identity provider", - "description" : "Creates a token for accessing the REST API via a custom identity provider. The user credentials must be passed in a format understood by the custom identity provider, e.g., a third-party auth token in an HTTP header. The exact format of the user credentials expected by the custom identity provider can be discovered by 'GET /access/token/identity-provider/usage'. The token returned is formatted as a JSON Web Token (JWT). The token is base64 encoded and comprised of three parts. The header, the body, and the signature. The expiration of the token is a contained within the body. The token can be used in the Authorization header in the format 'Authorization: Bearer '.", - "operationId" : "createAccessTokenUsingIdentityProviderCredentials", - "consumes" : [ "*/*" ], - "produces" : [ "text/plain" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid. The NiFi Registry may not be configured to support login with customized credentials." - }, - "500" : { - "description" : "NiFi Registry was unable to complete the request because an unexpected error occurred." - } - } - } - }, - "/access/token/identity-provider/test" : { - "post" : { - "tags" : [ "access" ], - "summary" : "Test identity provider", - "description" : "Tests the format of the credentials against this identity provider without preforming authentication on the credentials to validate them. The user credentials should be passed in a format understood by the custom identity provider as defined by 'GET /access/token/identity-provider/usage'.", - "operationId" : "testIdentityProviderRecognizesCredentialsFormat", - "consumes" : [ "*/*" ], - "produces" : [ "text/plain" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "The format of the credentials were not recognized by the currently configured identity provider." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid. The NiFi Registry may not be configured to support login with customized credentials." - }, - "500" : { - "description" : "NiFi Registry was unable to complete the request because an unexpected error occurred." - } - } - } - }, - "/access/token/identity-provider/usage" : { - "get" : { - "tags" : [ "access" ], - "summary" : "Get identity provider usage", - "description" : "Provides a description of how the currently configured identity provider expects credentials to be passed to POST /access/token/identity-provider", - "operationId" : "getIdentityProviderUsageInstructions", - "consumes" : [ "*/*" ], - "produces" : [ "text/plain" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid. The NiFi Registry may not be configured to support login with customized credentials." - }, - "500" : { - "description" : "NiFi Registry was unable to complete the request because an unexpected error occurred." - } - } - } - }, - "/access/token/kerberos" : { - "post" : { - "tags" : [ "access" ], - "summary" : "Create token using kerberos", - "description" : "Creates a token for accessing the REST API via Kerberos Service Tickets or SPNEGO Tokens (which includes Kerberos Service Tickets). The token returned is formatted as a JSON Web Token (JWT). The token is base64 encoded and comprised of three parts. The header, the body, and the signature. The expiration of the token is a contained within the body. The token can be used in the Authorization header in the format 'Authorization: Bearer '.", - "operationId" : "createAccessTokenUsingKerberosTicket", - "consumes" : [ "*/*" ], - "produces" : [ "text/plain" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid. The NiFi Registry may not be configured to support login Kerberos credentials." - }, - "500" : { - "description" : "NiFi Registry was unable to complete the request because an unexpected error occurred." - } - } - } - }, - "/access/token/login" : { - "post" : { - "tags" : [ "access" ], - "summary" : "Create token using basic auth", - "description" : "Creates a token for accessing the REST API via username/password. The user credentials must be passed in standard HTTP Basic Auth format. That is: 'Authorization: Basic ', where is the base64 encoded value of ':'. The token returned is formatted as a JSON Web Token (JWT). The token is base64 encoded and comprised of three parts. The header, the body, and the signature. The expiration of the token is a contained within the body. The token can be used in the Authorization header in the format 'Authorization: Bearer '.", - "operationId" : "createAccessTokenUsingBasicAuthCredentials", - "consumes" : [ "*/*" ], - "produces" : [ "text/plain" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid. The NiFi Registry may not be configured to support login with username/password." - }, - "500" : { - "description" : "NiFi Registry was unable to complete the request because an unexpected error occurred." - } - }, - "security" : [ { - "BasicAuth" : [ ] - } ] - } - }, - "/buckets" : { - "get" : { - "tags" : [ "buckets" ], - "summary" : "Get all buckets", - "description" : "The returned list will include only buckets for which the user is authorized.If the user is not authorized for any buckets, this returns an empty list.", - "operationId" : "getBuckets", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/Bucket" - } - } - }, - "401" : { - "description" : "Client could not be authenticated." - } - }, - "security" : [ { - "Authorization" : [ ] - } ] - }, - "post" : { - "tags" : [ "buckets" ], - "summary" : "Create bucket", - "description" : "", - "operationId" : "createBucket", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The bucket to create", - "required" : true, - "schema" : { - "$ref" : "#/definitions/Bucket" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/Bucket" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets", - "action" : "write" - } - } - }, - "/buckets/fields" : { - "get" : { - "tags" : [ "buckets" ], - "summary" : "Get bucket fields", - "description" : "Retrieves bucket field names for searching or sorting on buckets.", - "operationId" : "getAvailableBucketFields", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/Fields" - } - } - }, - "security" : [ { - "Authorization" : [ ] - } ] - } - }, - "/buckets/{bucketId}" : { - "get" : { - "tags" : [ "buckets" ], - "summary" : "Get bucket", - "description" : "Gets the bucket with the given id.", - "operationId" : "getBucket", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketId", - "in" : "path", - "description" : "The bucket identifier", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/Bucket" - } - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - }, - "put" : { - "tags" : [ "buckets" ], - "summary" : "Update bucket", - "description" : "Updates the bucket with the given id.", - "operationId" : "updateBucket", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketId", - "in" : "path", - "description" : "The bucket identifier", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The updated bucket", - "required" : true, - "schema" : { - "$ref" : "#/definitions/Bucket" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/Bucket" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "write" - } - }, - "delete" : { - "tags" : [ "buckets" ], - "summary" : "Delete bucket", - "description" : "Deletes the bucket with the given id, along with all objects stored in the bucket", - "operationId" : "deleteBucket", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketId", - "in" : "path", - "description" : "The bucket identifier", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/Bucket" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "delete" - } - } - }, - "/buckets/{bucketId}/bundles" : { - "get" : { - "tags" : [ "bucket bundles" ], - "summary" : "Get extension bundles by bucket", - "description" : "\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getExtensionBundles", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketId", - "in" : "path", - "description" : "The bucket identifier", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/ExtensionBundle" - } - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/buckets/{bucketId}/bundles/{bundleType}" : { - "post" : { - "tags" : [ "bucket bundles" ], - "summary" : "Create extension bundle version", - "description" : "Creates a version of an extension bundle by uploading a binary artifact. If an extension bundle already exists in the given bucket with the same group id and artifact id as that of the bundle being uploaded, then it will be added as a new version to the existing bundle. If an extension bundle does not already exist in the given bucket with the same group id and artifact id, then a new extension bundle will be created and this version will be added to the new bundle. Client's may optionally supply a SHA-256 in hex format through the multi-part form field 'sha256'. If supplied, then this value will be compared against the SHA-256 computed by the server, and the bundle will be rejected if the values do not match. If not supplied, the bundle will be accepted, but will be marked to indicate that the client did not supply a SHA-256 during creation. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "createExtensionBundleVersion", - "consumes" : [ "multipart/form-data" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketId", - "in" : "path", - "description" : "The bucket identifier", - "required" : true, - "type" : "string" - }, { - "name" : "bundleType", - "in" : "path", - "description" : "The type of the bundle", - "required" : true, - "type" : "string", - "enum" : [ "nifi-nar", "minifi-cpp" ] - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/BundleVersion" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "write" - } - } - }, - "/buckets/{bucketId}/flows" : { - "get" : { - "tags" : [ "bucket flows" ], - "summary" : "Get bucket flows", - "description" : "Retrieves all flows in the given bucket.", - "operationId" : "getFlows", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketId", - "in" : "path", - "description" : "The bucket identifier", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/VersionedFlow" - } - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - }, - "post" : { - "tags" : [ "bucket flows" ], - "summary" : "Create flow", - "description" : "Creates a flow in the given bucket. The flow id is created by the server and populated in the returned entity.", - "operationId" : "createFlow", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketId", - "in" : "path", - "description" : "The bucket identifier", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The details of the flow to create.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/VersionedFlow" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlow" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "write" - } - } - }, - "/buckets/{bucketId}/flows/{flowId}" : { - "get" : { - "tags" : [ "bucket flows" ], - "summary" : "Get bucket flow", - "description" : "Retrieves the flow with the given id in the given bucket.", - "operationId" : "getFlow", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketId", - "in" : "path", - "description" : "The bucket identifier", - "required" : true, - "type" : "string" - }, { - "name" : "flowId", - "in" : "path", - "description" : "The flow identifier", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlow" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - }, - "put" : { - "tags" : [ "bucket flows" ], - "summary" : "Update bucket flow", - "description" : "Updates the flow with the given id in the given bucket.", - "operationId" : "updateFlow", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketId", - "in" : "path", - "description" : "The bucket identifier", - "required" : true, - "type" : "string" - }, { - "name" : "flowId", - "in" : "path", - "description" : "The flow identifier", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The updated flow", - "required" : true, - "schema" : { - "$ref" : "#/definitions/VersionedFlow" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlow" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "write" - } - }, - "delete" : { - "tags" : [ "bucket flows" ], - "summary" : "Delete bucket flow", - "description" : "Deletes a flow, including all saved versions of that flow.", - "operationId" : "deleteFlow", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketId", - "in" : "path", - "description" : "The bucket identifier", - "required" : true, - "type" : "string" - }, { - "name" : "flowId", - "in" : "path", - "description" : "The flow identifier", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlow" - } - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "delete" - } - } - }, - "/buckets/{bucketId}/flows/{flowId}/diff/{versionA}/{versionB}" : { - "get" : { - "tags" : [ "bucket flows" ], - "summary" : "Get bucket flow diff", - "description" : "Computes the differences between two given versions of a flow.", - "operationId" : "getFlowDiff", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketId", - "in" : "path", - "description" : "The bucket identifier", - "required" : true, - "type" : "string" - }, { - "name" : "flowId", - "in" : "path", - "description" : "The flow identifier", - "required" : true, - "type" : "string" - }, { - "name" : "versionA", - "in" : "path", - "description" : "The first version number", - "required" : true, - "type" : "integer", - "pattern" : "\\d+", - "format" : "int32" - }, { - "name" : "versionB", - "in" : "path", - "description" : "The second version number", - "required" : true, - "type" : "integer", - "pattern" : "\\d+", - "format" : "int32" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlowDifference" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/buckets/{bucketId}/flows/{flowId}/versions" : { - "get" : { - "tags" : [ "bucket flows" ], - "summary" : "Get bucket flow versions", - "description" : "Gets summary information for all versions of a flow. Versions are ordered newest->oldest.", - "operationId" : "getFlowVersions", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketId", - "in" : "path", - "description" : "The bucket identifier", - "required" : true, - "type" : "string" - }, { - "name" : "flowId", - "in" : "path", - "description" : "The flow identifier", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/VersionedFlowSnapshotMetadata" - } - } - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - }, - "post" : { - "tags" : [ "bucket flows" ], - "summary" : "Create flow version", - "description" : "Creates the next version of a flow. The version number of the object being created must be the next available version integer. Flow versions are immutable after they are created.", - "operationId" : "createFlowVersion", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketId", - "in" : "path", - "description" : "The bucket identifier", - "required" : true, - "type" : "string" - }, { - "name" : "flowId", - "in" : "path", - "description" : "The flow identifier", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The new versioned flow snapshot.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/VersionedFlowSnapshot" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlowSnapshot" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "write" - } - } - }, - "/buckets/{bucketId}/flows/{flowId}/versions/latest" : { - "get" : { - "tags" : [ "bucket flows" ], - "summary" : "Get latest bucket flow version content", - "description" : "Gets the latest version of a flow, including the metadata and content of the flow.", - "operationId" : "getLatestFlowVersion", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketId", - "in" : "path", - "description" : "The bucket identifier", - "required" : true, - "type" : "string" - }, { - "name" : "flowId", - "in" : "path", - "description" : "The flow identifier", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlowSnapshot" - } - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/buckets/{bucketId}/flows/{flowId}/versions/latest/metadata" : { - "get" : { - "tags" : [ "bucket flows" ], - "summary" : "Get latest bucket flow version metadata", - "description" : "Gets the metadata for the latest version of a flow.", - "operationId" : "getLatestFlowVersionMetadata", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketId", - "in" : "path", - "description" : "The bucket identifier", - "required" : true, - "type" : "string" - }, { - "name" : "flowId", - "in" : "path", - "description" : "The flow identifier", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlowSnapshotMetadata" - } - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/buckets/{bucketId}/flows/{flowId}/versions/{versionNumber}" : { - "get" : { - "tags" : [ "bucket flows" ], - "summary" : "Get bucket flow version", - "description" : "Gets the given version of a flow, including the metadata and content for the version.", - "operationId" : "getFlowVersion", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketId", - "in" : "path", - "description" : "The bucket identifier", - "required" : true, - "type" : "string" - }, { - "name" : "flowId", - "in" : "path", - "description" : "The flow identifier", - "required" : true, - "type" : "string" - }, { - "name" : "versionNumber", - "in" : "path", - "description" : "The version number", - "required" : true, - "type" : "integer", - "pattern" : "\\d+", - "format" : "int32" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlowSnapshot" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/bundles" : { - "get" : { - "tags" : [ "bundles" ], - "summary" : "Get all bundles", - "description" : "Gets the metadata for all bundles across all authorized buckets with optional filters applied. The returned results will include only items from buckets for which the user is authorized. If the user is not authorized to any buckets, an empty list will be returned. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getBundles", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketName", - "in" : "query", - "description" : "Optional bucket name to filter results. The value may be an exact match, or a wildcard, such as 'My Bucket%' to select all bundles where the bucket name starts with 'My Bucket'.", - "required" : false, - "type" : "string" - }, { - "name" : "groupId", - "in" : "query", - "description" : "Optional groupId to filter results. The value may be an exact match, or a wildcard, such as 'com.%' to select all bundles where the groupId starts with 'com.'.", - "required" : false, - "type" : "string" - }, { - "name" : "artifactId", - "in" : "query", - "description" : "Optional artifactId to filter results. The value may be an exact match, or a wildcard, such as 'nifi-%' to select all bundles where the artifactId starts with 'nifi-'.", - "required" : false, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/ExtensionBundle" - } - } - }, - "401" : { - "description" : "Client could not be authenticated." - } - }, - "security" : [ { - "Authorization" : [ ] - } ] - } - }, - "/bundles/versions" : { - "get" : { - "tags" : [ "bundles" ], - "summary" : "Get all bundle versions", - "description" : "Gets the metadata about extension bundle versions across all authorized buckets with optional filters applied. If the user is not authorized to any buckets, an empty list will be returned. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getBundleVersions", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "groupId", - "in" : "query", - "description" : "Optional groupId to filter results. The value may be an exact match, or a wildcard, such as 'com.%' to select all bundle versions where the groupId starts with 'com.'.", - "required" : false, - "type" : "string" - }, { - "name" : "artifactId", - "in" : "query", - "description" : "Optional artifactId to filter results. The value may be an exact match, or a wildcard, such as 'nifi-%' to select all bundle versions where the artifactId starts with 'nifi-'.", - "required" : false, - "type" : "string" - }, { - "name" : "version", - "in" : "query", - "description" : "Optional version to filter results. The value maye be an exact match, or a wildcard, such as '1.0.%' to select all bundle versions where the version starts with '1.0.'.", - "required" : false, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/BundleVersionMetadata" - } - } - }, - "401" : { - "description" : "Client could not be authenticated." - } - }, - "security" : [ { - "Authorization" : [ ] - } ] - } - }, - "/bundles/{bundleId}" : { - "get" : { - "tags" : [ "bundles" ], - "summary" : "Get bundle", - "description" : "Gets the metadata about an extension bundle. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "globalGetExtensionBundle", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bundleId", - "in" : "path", - "description" : "The extension bundle identifier", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ExtensionBundle" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - }, - "delete" : { - "tags" : [ "bundles" ], - "summary" : "Delete bundle", - "description" : "Deletes the given extension bundle and all of it's versions. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "globalDeleteExtensionBundle", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bundleId", - "in" : "path", - "description" : "The extension bundle identifier", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ExtensionBundle" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "write" - } - } - }, - "/bundles/{bundleId}/versions" : { - "get" : { - "tags" : [ "bundles" ], - "summary" : "Get bundle versions", - "description" : "Gets the metadata for the versions of the given extension bundle. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "globalGetBundleVersions", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bundleId", - "in" : "path", - "description" : "The extension bundle identifier", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/BundleVersionMetadata" - } - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/bundles/{bundleId}/versions/{version}" : { - "get" : { - "tags" : [ "bundles" ], - "summary" : "Get bundle version", - "description" : "Gets the descriptor for the given version of the given extension bundle. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "globalGetBundleVersion", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bundleId", - "in" : "path", - "description" : "The extension bundle identifier", - "required" : true, - "type" : "string" - }, { - "name" : "version", - "in" : "path", - "description" : "The version of the bundle", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/BundleVersion" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - }, - "delete" : { - "tags" : [ "bundles" ], - "summary" : "Delete bundle version", - "description" : "Deletes the given extension bundle version and it's associated binary content. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "globalDeleteBundleVersion", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bundleId", - "in" : "path", - "description" : "The extension bundle identifier", - "required" : true, - "type" : "string" - }, { - "name" : "version", - "in" : "path", - "description" : "The version of the bundle", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/BundleVersion" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "write" - } - } - }, - "/bundles/{bundleId}/versions/{version}/content" : { - "get" : { - "tags" : [ "bundles" ], - "summary" : "Get bundle version content", - "description" : "Gets the binary content for the given version of the given extension bundle. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "globalGetBundleVersionContent", - "consumes" : [ "*/*" ], - "produces" : [ "application/octet-stream" ], - "parameters" : [ { - "name" : "bundleId", - "in" : "path", - "description" : "The extension bundle identifier", - "required" : true, - "type" : "string" - }, { - "name" : "version", - "in" : "path", - "description" : "The version of the bundle", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "type" : "string", - "format" : "byte" - } - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/bundles/{bundleId}/versions/{version}/extensions" : { - "get" : { - "tags" : [ "bundles" ], - "summary" : "Get bundle version extensions", - "description" : "Gets the metadata about the extensions in the given extension bundle version. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "globalGetBundleVersionExtensions", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bundleId", - "in" : "path", - "description" : "The extension bundle identifier", - "required" : true, - "type" : "string" - }, { - "name" : "version", - "in" : "path", - "description" : "The version of the bundle", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/ExtensionMetadata" - } - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/bundles/{bundleId}/versions/{version}/extensions/{name}" : { - "get" : { - "tags" : [ "bundles" ], - "summary" : "Get bundle version extension", - "description" : "Gets the metadata about the extension with the given name in the given extension bundle version. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "globalGetBundleVersionExtension", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bundleId", - "in" : "path", - "description" : "The extension bundle identifier", - "required" : true, - "type" : "string" - }, { - "name" : "version", - "in" : "path", - "description" : "The version of the bundle", - "required" : true, - "type" : "string" - }, { - "name" : "name", - "in" : "path", - "description" : "The fully qualified name of the extension", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/Extension" - } - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/bundles/{bundleId}/versions/{version}/extensions/{name}/docs" : { - "get" : { - "tags" : [ "bundles" ], - "summary" : "Get bundle version extension docs", - "description" : "Gets the documentation for the given extension in the given extension bundle version. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getBundleVersionExtensionDocs", - "consumes" : [ "*/*" ], - "produces" : [ "text/html" ], - "parameters" : [ { - "name" : "bundleId", - "in" : "path", - "description" : "The extension bundle identifier", - "required" : true, - "type" : "string" - }, { - "name" : "version", - "in" : "path", - "description" : "The version of the bundle", - "required" : true, - "type" : "string" - }, { - "name" : "name", - "in" : "path", - "description" : "The fully qualified name of the extension", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/bundles/{bundleId}/versions/{version}/extensions/{name}/docs/additional-details" : { - "get" : { - "tags" : [ "bundles" ], - "summary" : "Get bundle version extension docs details", - "description" : "Gets the additional details documentation for the given extension in the given extension bundle version. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getBundleVersionExtensionAdditionalDetailsDocs", - "consumes" : [ "*/*" ], - "produces" : [ "text/html" ], - "parameters" : [ { - "name" : "bundleId", - "in" : "path", - "description" : "The extension bundle identifier", - "required" : true, - "type" : "string" - }, { - "name" : "version", - "in" : "path", - "description" : "The version of the bundle", - "required" : true, - "type" : "string" - }, { - "name" : "name", - "in" : "path", - "description" : "The fully qualified name of the extension", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/config" : { - "get" : { - "tags" : [ "config" ], - "summary" : "Get configration", - "description" : "Gets the NiFi Registry configurations.", - "operationId" : "getConfiguration", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/RegistryConfiguration" - } - }, - "401" : { - "description" : "Client could not be authenticated." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/policies,/tenants", - "action" : "read" - } - } - }, - "/extension-repository" : { - "get" : { - "tags" : [ "extension repository" ], - "summary" : "Get extension repo buckets", - "description" : "Gets the names of the buckets the current user is authorized for in order to browse the repo by bucket. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getExtensionRepoBuckets", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/ExtensionRepoBucket" - } - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ] - } - }, - "/extension-repository/{bucketName}" : { - "get" : { - "tags" : [ "extension repository" ], - "summary" : "Get extension repo groups", - "description" : "Gets the groups in the extension repository in the given bucket. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getExtensionRepoGroups", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketName", - "in" : "path", - "description" : "The bucket name", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/ExtensionRepoGroup" - } - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/extension-repository/{bucketName}/{groupId}" : { - "get" : { - "tags" : [ "extension repository" ], - "summary" : "Get extension repo artifacts", - "description" : "Gets the artifacts in the extension repository in the given bucket and group. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getExtensionRepoArtifacts", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketName", - "in" : "path", - "description" : "The bucket name", - "required" : true, - "type" : "string" - }, { - "name" : "groupId", - "in" : "path", - "description" : "The group id", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/ExtensionRepoArtifact" - } - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/extension-repository/{bucketName}/{groupId}/{artifactId}" : { - "get" : { - "tags" : [ "extension repository" ], - "summary" : "Get extension repo versions", - "description" : "Gets the versions in the extension repository for the given bucket, group, and artifact. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getExtensionRepoVersions", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketName", - "in" : "path", - "description" : "The bucket name", - "required" : true, - "type" : "string" - }, { - "name" : "groupId", - "in" : "path", - "description" : "The group identifier", - "required" : true, - "type" : "string" - }, { - "name" : "artifactId", - "in" : "path", - "description" : "The artifact identifier", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/ExtensionRepoVersionSummary" - } - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/extension-repository/{bucketName}/{groupId}/{artifactId}/{version}" : { - "get" : { - "tags" : [ "extension repository" ], - "summary" : "Get extension repo version", - "description" : "Gets information about the version in the given bucket, group, and artifact. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getExtensionRepoVersion", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketName", - "in" : "path", - "description" : "The bucket name", - "required" : true, - "type" : "string" - }, { - "name" : "groupId", - "in" : "path", - "description" : "The group identifier", - "required" : true, - "type" : "string" - }, { - "name" : "artifactId", - "in" : "path", - "description" : "The artifact identifier", - "required" : true, - "type" : "string" - }, { - "name" : "version", - "in" : "path", - "description" : "The version", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ExtensionRepoVersion" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/extension-repository/{bucketName}/{groupId}/{artifactId}/{version}/content" : { - "get" : { - "tags" : [ "extension repository" ], - "summary" : "Get extension repo version content", - "description" : "Gets the binary content of the bundle with the given bucket, group, artifact, and version. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getExtensionRepoVersionContent", - "consumes" : [ "*/*" ], - "produces" : [ "application/octet-stream" ], - "parameters" : [ { - "name" : "bucketName", - "in" : "path", - "description" : "The bucket name", - "required" : true, - "type" : "string" - }, { - "name" : "groupId", - "in" : "path", - "description" : "The group identifier", - "required" : true, - "type" : "string" - }, { - "name" : "artifactId", - "in" : "path", - "description" : "The artifact identifier", - "required" : true, - "type" : "string" - }, { - "name" : "version", - "in" : "path", - "description" : "The version", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "type" : "string", - "format" : "byte" - } - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/extension-repository/{bucketName}/{groupId}/{artifactId}/{version}/extensions" : { - "get" : { - "tags" : [ "extension repository" ], - "summary" : "Get extension repo extensions", - "description" : "Gets information about the extensions in the given bucket, group, artifact, and version. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getExtensionRepoVersionExtensions", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketName", - "in" : "path", - "description" : "The bucket name", - "required" : true, - "type" : "string" - }, { - "name" : "groupId", - "in" : "path", - "description" : "The group identifier", - "required" : true, - "type" : "string" - }, { - "name" : "artifactId", - "in" : "path", - "description" : "The artifact identifier", - "required" : true, - "type" : "string" - }, { - "name" : "version", - "in" : "path", - "description" : "The version", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/ExtensionMetadata" - } - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/extension-repository/{bucketName}/{groupId}/{artifactId}/{version}/extensions/{name}" : { - "get" : { - "tags" : [ "extension repository" ], - "summary" : "Get extension repo extension", - "description" : "Gets information about the extension with the given name in the given bucket, group, artifact, and version. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getExtensionRepoVersionExtension", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketName", - "in" : "path", - "description" : "The bucket name", - "required" : true, - "type" : "string" - }, { - "name" : "groupId", - "in" : "path", - "description" : "The group identifier", - "required" : true, - "type" : "string" - }, { - "name" : "artifactId", - "in" : "path", - "description" : "The artifact identifier", - "required" : true, - "type" : "string" - }, { - "name" : "version", - "in" : "path", - "description" : "The version", - "required" : true, - "type" : "string" - }, { - "name" : "name", - "in" : "path", - "description" : "The fully qualified name of the extension", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/Extension" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/extension-repository/{bucketName}/{groupId}/{artifactId}/{version}/extensions/{name}/docs" : { - "get" : { - "tags" : [ "extension repository" ], - "summary" : "Get extension repo extension docs", - "description" : "Gets the documentation for the extension with the given name in the given bucket, group, artifact, and version. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getExtensionRepoVersionExtensionDocs", - "consumes" : [ "*/*" ], - "produces" : [ "text/html" ], - "parameters" : [ { - "name" : "bucketName", - "in" : "path", - "description" : "The bucket name", - "required" : true, - "type" : "string" - }, { - "name" : "groupId", - "in" : "path", - "description" : "The group identifier", - "required" : true, - "type" : "string" - }, { - "name" : "artifactId", - "in" : "path", - "description" : "The artifact identifier", - "required" : true, - "type" : "string" - }, { - "name" : "version", - "in" : "path", - "description" : "The version", - "required" : true, - "type" : "string" - }, { - "name" : "name", - "in" : "path", - "description" : "The fully qualified name of the extension", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/extension-repository/{bucketName}/{groupId}/{artifactId}/{version}/extensions/{name}/docs/additional-details" : { - "get" : { - "tags" : [ "extension repository" ], - "summary" : "Get extension repo extension details", - "description" : "Gets the additional details documentation for the extension with the given name in the given bucket, group, artifact, and version. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getExtensionRepoVersionExtensionAdditionalDetailsDocs", - "consumes" : [ "*/*" ], - "produces" : [ "text/html" ], - "parameters" : [ { - "name" : "bucketName", - "in" : "path", - "description" : "The bucket name", - "required" : true, - "type" : "string" - }, { - "name" : "groupId", - "in" : "path", - "description" : "The group identifier", - "required" : true, - "type" : "string" - }, { - "name" : "artifactId", - "in" : "path", - "description" : "The artifact identifier", - "required" : true, - "type" : "string" - }, { - "name" : "version", - "in" : "path", - "description" : "The version", - "required" : true, - "type" : "string" - }, { - "name" : "name", - "in" : "path", - "description" : "The fully qualified name of the extension", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/extension-repository/{bucketName}/{groupId}/{artifactId}/{version}/sha256" : { - "get" : { - "tags" : [ "extension repository" ], - "summary" : "Get extension repo version checksum", - "description" : "Gets the hex representation of the SHA-256 digest for the binary content of the bundle with the given bucket, group, artifact, and version.\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getExtensionRepoVersionSha256", - "consumes" : [ "*/*" ], - "produces" : [ "text/plain" ], - "parameters" : [ { - "name" : "bucketName", - "in" : "path", - "description" : "The bucket name", - "required" : true, - "type" : "string" - }, { - "name" : "groupId", - "in" : "path", - "description" : "The group identifier", - "required" : true, - "type" : "string" - }, { - "name" : "artifactId", - "in" : "path", - "description" : "The artifact identifier", - "required" : true, - "type" : "string" - }, { - "name" : "version", - "in" : "path", - "description" : "The version", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/extension-repository/{groupId}/{artifactId}/{version}/sha256" : { - "get" : { - "tags" : [ "extension repository" ], - "summary" : "Get global extension repo version checksum", - "description" : "Gets the hex representation of the SHA-256 digest for the binary content with the given bucket, group, artifact, and version. Since the same group-artifact-version can exist in multiple buckets, this will return the checksum of the first one returned. This will be consistent since the checksum must be the same when existing in multiple buckets. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getExtensionRepoVersionSha256", - "consumes" : [ "*/*" ], - "produces" : [ "text/plain" ], - "parameters" : [ { - "name" : "groupId", - "in" : "path", - "description" : "The group identifier", - "required" : true, - "type" : "string" - }, { - "name" : "artifactId", - "in" : "path", - "description" : "The artifact identifier", - "required" : true, - "type" : "string" - }, { - "name" : "version", - "in" : "path", - "description" : "The version", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ] - } - }, - "/extensions" : { - "get" : { - "tags" : [ "extensions" ], - "summary" : "Get all extensions", - "description" : "Gets the metadata for all extensions that match the filter params and are part of bundles located in buckets the current user is authorized for. If the user is not authorized to any buckets, an empty result set will be returned.\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getExtensions", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bundleType", - "in" : "query", - "description" : "The type of bundles to return", - "required" : false, - "type" : "string", - "enum" : [ "nifi-nar", "minifi-cpp" ] - }, { - "name" : "extensionType", - "in" : "query", - "description" : "The type of extensions to return", - "required" : false, - "type" : "string", - "enum" : [ "PROCESSOR", "CONTROLLER_SERVICE", "REPORTING_TASK" ] - }, { - "name" : "tag", - "in" : "query", - "description" : "The tags to filter on, will be used in an OR statement", - "required" : false, - "type" : "array", - "items" : { - "type" : "string" - }, - "collectionFormat" : "multi" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ExtensionMetadataContainer" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ] - } - }, - "/extensions/provided-service-api" : { - "get" : { - "tags" : [ "extensions" ], - "summary" : "Get extensions providing service API", - "description" : "Gets the metadata for extensions that provide the specified API and are part of bundles located in buckets the current user is authorized for. If the user is not authorized to any buckets, an empty result set will be returned.\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getExtensionsProvidingServiceAPI", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "className", - "in" : "query", - "description" : "The name of the service API class", - "required" : true, - "type" : "string" - }, { - "name" : "groupId", - "in" : "query", - "description" : "The groupId of the bundle containing the service API class", - "required" : true, - "type" : "string" - }, { - "name" : "artifactId", - "in" : "query", - "description" : "The artifactId of the bundle containing the service API class", - "required" : true, - "type" : "string" - }, { - "name" : "version", - "in" : "query", - "description" : "The version of the bundle containing the service API class", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ExtensionMetadataContainer" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ] - } - }, - "/extensions/tags" : { - "get" : { - "tags" : [ "extensions" ], - "summary" : "Get extension tags", - "description" : "Gets all the extension tags known to this NiFi Registry instance, along with the number of extensions that have the given tag.\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getTags", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/TagCount" - } - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ] - } - }, - "/flows/fields" : { - "get" : { - "tags" : [ "flows" ], - "summary" : "Get flow fields", - "description" : "Retrieves the flow field names that can be used for searching or sorting on flows.", - "operationId" : "getAvailableFlowFields", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/Fields" - } - } - }, - "security" : [ { - "Authorization" : [ ] - } ] - } - }, - "/flows/{flowId}" : { - "get" : { - "tags" : [ "flows" ], - "summary" : "Get flow", - "description" : "Gets a flow by id.", - "operationId" : "globalGetFlow", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "flowId", - "in" : "path", - "description" : "The flow identifier", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlow" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/flows/{flowId}/versions" : { - "get" : { - "tags" : [ "flows" ], - "summary" : "Get flow versions", - "description" : "Gets summary information for all versions of a given flow. Versions are ordered newest->oldest.", - "operationId" : "globalGetFlowVersions", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "flowId", - "in" : "path", - "description" : "The flow identifier", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/VersionedFlowSnapshotMetadata" - } - } - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/flows/{flowId}/versions/latest" : { - "get" : { - "tags" : [ "flows" ], - "summary" : "Get latest flow version", - "description" : "Gets the latest version of a flow, including metadata and flow content.", - "operationId" : "globalGetLatestFlowVersion", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "flowId", - "in" : "path", - "description" : "The flow identifier", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlowSnapshot" - } - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/flows/{flowId}/versions/latest/metadata" : { - "get" : { - "tags" : [ "flows" ], - "summary" : "Get latest flow version metadata", - "description" : "Gets the metadata for the latest version of a flow.", - "operationId" : "globalGetLatestFlowVersionMetadata", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "flowId", - "in" : "path", - "description" : "The flow identifier", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlowSnapshotMetadata" - } - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/flows/{flowId}/versions/{versionNumber}" : { - "get" : { - "tags" : [ "flows" ], - "summary" : "Get flow version", - "description" : "Gets the given version of a flow, including metadata and flow content.", - "operationId" : "globalGetFlowVersion", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "flowId", - "in" : "path", - "description" : "The flow identifier", - "required" : true, - "type" : "string" - }, { - "name" : "versionNumber", - "in" : "path", - "description" : "The version number", - "required" : true, - "type" : "integer", - "pattern" : "\\d+", - "format" : "int32" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlowSnapshot" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/items" : { - "get" : { - "tags" : [ "items" ], - "summary" : "Get all items", - "description" : "Get items across all buckets. The returned items will include only items from buckets for which the user is authorized. If the user is not authorized to any buckets, an empty list will be returned.", - "operationId" : "getItems", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/BucketItem" - } - } - }, - "401" : { - "description" : "Client could not be authenticated." - } - }, - "security" : [ { - "Authorization" : [ ] - } ] - } - }, - "/items/fields" : { - "get" : { - "tags" : [ "items" ], - "summary" : "Get item fields", - "description" : "Retrieves the item field names for searching or sorting on bucket items.", - "operationId" : "getAvailableBucketItemFields", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/Fields" - } - } - }, - "security" : [ { - "Authorization" : [ ] - } ] - } - }, - "/items/{bucketId}" : { - "get" : { - "tags" : [ "items" ], - "summary" : "Get bucket items", - "description" : "Gets the items located in the given bucket.", - "operationId" : "getItemsInBucket", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketId", - "in" : "path", - "description" : "The bucket identifier", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/BucketItem" - } - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/policies" : { - "get" : { - "tags" : [ "policies" ], - "summary" : "Get all access policies", - "description" : "", - "operationId" : "getAccessPolicies", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/AccessPolicy" - } - } - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/policies", - "action" : "read" - } - }, - "post" : { - "tags" : [ "policies" ], - "summary" : "Create access policy", - "description" : "", - "operationId" : "createAccessPolicy", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The access policy configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/AccessPolicy" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/AccessPolicy" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid. The NiFi Registry might not be configured to use a ConfigurableAccessPolicyProvider." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/policies", - "action" : "write" - } - } - }, - "/policies/resources" : { - "get" : { - "tags" : [ "policies" ], - "summary" : "Get available resources", - "description" : "Gets the available resources that support access/authorization policies", - "operationId" : "getResources", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/Resource" - } - } - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/policies", - "action" : "read" - } - } - }, - "/policies/{action}/{resource}" : { - "get" : { - "tags" : [ "policies" ], - "summary" : "Get access policy for resource", - "description" : "Gets an access policy for the specified action and resource", - "operationId" : "getAccessPolicyForResource", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "action", - "in" : "path", - "description" : "The request action.", - "required" : true, - "type" : "string", - "enum" : [ "read", "write", "delete" ] - }, { - "name" : "resource", - "in" : "path", - "description" : "The resource of the policy.", - "required" : true, - "type" : "string", - "pattern" : ".+" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/AccessPolicy" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/policies", - "action" : "read" - } - } - }, - "/policies/{id}" : { - "get" : { - "tags" : [ "policies" ], - "summary" : "Get access policy", - "description" : "", - "operationId" : "getAccessPolicy", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The access policy id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/AccessPolicy" - } - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/policies", - "action" : "read" - } - }, - "put" : { - "tags" : [ "policies" ], - "summary" : "Update access policy", - "description" : "", - "operationId" : "updateAccessPolicy", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The access policy id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The access policy configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/AccessPolicy" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/AccessPolicy" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid. The NiFi Registry might not be configured to use a ConfigurableAccessPolicyProvider." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/policies", - "action" : "write" - } - }, - "delete" : { - "tags" : [ "policies" ], - "summary" : "Delete access policy", - "description" : "", - "operationId" : "removeAccessPolicy", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The access policy id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/AccessPolicy" - } - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid. The NiFi Registry might not be configured to use a ConfigurableAccessPolicyProvider." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/policies", - "action" : "delete" - } - } - }, - "/tenants/user-groups" : { - "get" : { - "tags" : [ "tenants" ], - "summary" : "Get user groups", - "description" : "\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getUserGroups", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/UserGroup" - } - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/tenants", - "action" : "read" - } - }, - "post" : { - "tags" : [ "tenants" ], - "summary" : "Create user group", - "description" : "\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "createUserGroup", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The user group configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/UserGroup" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/UserGroup" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/tenants", - "action" : "write" - } - } - }, - "/tenants/user-groups/{id}" : { - "get" : { - "tags" : [ "tenants" ], - "summary" : "Get user group", - "description" : "\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getUserGroup", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The user group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/UserGroup" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/tenants", - "action" : "read" - } - }, - "put" : { - "tags" : [ "tenants" ], - "summary" : "Update user group", - "description" : "\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "updateUserGroup", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The user group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The user group configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/UserGroup" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/UserGroup" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/tenants", - "action" : "write" - } - }, - "delete" : { - "tags" : [ "tenants" ], - "summary" : "Delete user group", - "description" : "\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "removeUserGroup", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The user group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/UserGroup" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/tenants", - "action" : "delete" - } - } - }, - "/tenants/users" : { - "get" : { - "tags" : [ "tenants" ], - "summary" : "Get all users", - "description" : "\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getUsers", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/User" - } - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/tenants", - "action" : "read" - } - }, - "post" : { - "tags" : [ "tenants" ], - "summary" : "Create user", - "description" : "\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "createUser", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The user configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/User" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/User" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/tenants", - "action" : "write" - } - } - }, - "/tenants/users/{id}" : { - "get" : { - "tags" : [ "tenants" ], - "summary" : "Get user", - "description" : "\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getUser", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The user id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/User" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/tenants", - "action" : "read" - } - }, - "put" : { - "tags" : [ "tenants" ], - "summary" : "Update user", - "description" : "\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "updateUser", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The user id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The user configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/User" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/User" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/tenants", - "action" : "write" - } - }, - "delete" : { - "tags" : [ "tenants" ], - "summary" : "Delete user", - "description" : "\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "removeUser", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The user id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/User" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/tenants", - "action" : "delete" - } - } - } - }, - "securityDefinitions" : { - "Authorization" : { - "description" : "NiFi Registry Auth Token (JWT)", - "type" : "apiKey", - "name" : "Authorization", - "in" : "header" - }, - "BasicAuth" : { - "description" : "HTTP Basic Auth", - "type" : "basic" - } - }, - "definitions" : { - "AccessPolicy" : { - "type" : "object", - "required" : [ "action", "resource" ], - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The id of the policy. Set by server at creation time.", - "readOnly" : true - }, - "resource" : { - "type" : "string", - "description" : "The resource for this access policy." - }, - "action" : { - "type" : "string", - "description" : "The action associated with this access policy.", - "enum" : [ "read", "write", "delete" ] - }, - "configurable" : { - "type" : "boolean", - "description" : "Indicates if this access policy is configurable, based on which Authorizer has been configured to manage it.", - "readOnly" : true - }, - "users" : { - "type" : "array", - "description" : "The set of user IDs associated with this access policy.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/Tenant" - } - }, - "userGroups" : { - "type" : "array", - "description" : "The set of user group IDs associated with this access policy.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/Tenant" - } - } - } - }, - "AccessPolicySummary" : { - "type" : "object", - "required" : [ "action", "resource" ], - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The id of the policy. Set by server at creation time.", - "readOnly" : true - }, - "resource" : { - "type" : "string", - "description" : "The resource for this access policy." - }, - "action" : { - "type" : "string", - "description" : "The action associated with this access policy.", - "enum" : [ "read", "write", "delete" ] - }, - "configurable" : { - "type" : "boolean", - "description" : "Indicates if this access policy is configurable, based on which Authorizer has been configured to manage it.", - "readOnly" : true - } - } - }, - "AllowableValue" : { - "type" : "object", - "properties" : { - "value" : { - "type" : "string", - "description" : "The value of the allowable value" - }, - "displayName" : { - "type" : "string", - "description" : "The display name of the allowable value" - }, - "description" : { - "type" : "string", - "description" : "The description of the allowable value" - } - } - }, - "Attribute" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The name of the attribute" - }, - "description" : { - "type" : "string", - "description" : "The description of the attribute" - } - } - }, - "BatchSize" : { - "type" : "object", - "properties" : { - "count" : { - "type" : "integer", - "format" : "int32", - "description" : "Preferred number of flow files to include in a transaction." - }, - "size" : { - "type" : "string", - "description" : "Preferred number of bytes to include in a transaction." - }, - "duration" : { - "type" : "string", - "description" : "Preferred amount of time that a transaction should span." - } - } - }, - "Bucket" : { - "type" : "object", - "required" : [ "name" ], - "properties" : { - "link" : { - "description" : "An WebLink to this entity.", - "readOnly" : true, - "$ref" : "#/definitions/Link" - }, - "identifier" : { - "type" : "string", - "description" : "An ID to uniquely identify this object.", - "readOnly" : true - }, - "name" : { - "type" : "string", - "description" : "The name of the bucket." - }, - "createdTimestamp" : { - "type" : "integer", - "format" : "int64", - "description" : "The timestamp of when the bucket was first created. This is set by the server at creation time.", - "readOnly" : true, - "minimum" : 1 - }, - "description" : { - "type" : "string", - "description" : "A description of the bucket." - }, - "allowExtensionBundleRedeploy" : { - "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." - }, - "permissions" : { - "description" : "The access that the current user has to this bucket.", - "readOnly" : true, - "$ref" : "#/definitions/Permissions" - } - } - }, - "BucketItem" : { - "type" : "object", - "required" : [ "bucketIdentifier", "name", "type" ], - "properties" : { - "link" : { - "description" : "An WebLink to this entity.", - "readOnly" : true, - "$ref" : "#/definitions/Link" - }, - "identifier" : { - "type" : "string", - "description" : "An ID to uniquely identify this object.", - "readOnly" : true - }, - "name" : { - "type" : "string", - "description" : "The name of the item." - }, - "description" : { - "type" : "string", - "description" : "A description of the item." - }, - "bucketIdentifier" : { - "type" : "string", - "description" : "The identifier of the bucket this items belongs to. This cannot be changed after the item is created." - }, - "bucketName" : { - "type" : "string", - "description" : "The name of the bucket this items belongs to.", - "readOnly" : true - }, - "createdTimestamp" : { - "type" : "integer", - "format" : "int64", - "description" : "The timestamp of when the item was created, as milliseconds since epoch.", - "readOnly" : true, - "minimum" : 1 - }, - "modifiedTimestamp" : { - "type" : "integer", - "format" : "int64", - "description" : "The timestamp of when the item was last modified, as milliseconds since epoch.", - "readOnly" : true, - "minimum" : 1 - }, - "type" : { - "type" : "string", - "description" : "The type of item.", - "enum" : [ "Flow", "Extension_Bundle" ] - }, - "permissions" : { - "description" : "The access that the current user has to the bucket containing this item.", - "readOnly" : true, - "$ref" : "#/definitions/Permissions" - } - } - }, - "BuildInfo" : { - "type" : "object", - "properties" : { - "buildTool" : { - "type" : "string", - "description" : "The tool used to build the version of the bundle" - }, - "buildFlags" : { - "type" : "string", - "description" : "The flags used to build the version of the bundle" - }, - "buildBranch" : { - "type" : "string", - "description" : "The branch used to build the version of the bundle" - }, - "buildTag" : { - "type" : "string", - "description" : "The tag used to build the version of the bundle" - }, - "buildRevision" : { - "type" : "string", - "description" : "The revision used to build the version of the bundle" - }, - "built" : { - "type" : "integer", - "format" : "int64", - "description" : "The timestamp the version of the bundle was built" - }, - "builtBy" : { - "type" : "string", - "description" : "The identity of the user that performed the build" - } - } - }, - "Bundle" : { - "type" : "object", - "properties" : { - "group" : { - "type" : "string", - "description" : "The group of the bundle" - }, - "artifact" : { - "type" : "string", - "description" : "The artifact of the bundle" - }, - "version" : { - "type" : "string", - "description" : "The version of the bundle" - } - } - }, - "BundleInfo" : { - "type" : "object", - "properties" : { - "bucketId" : { - "type" : "string", - "description" : "The id of the bucket where the bundle is located" - }, - "bucketName" : { - "type" : "string", - "description" : "The name of the bucket where the bundle is located" - }, - "bundleId" : { - "type" : "string", - "description" : "The id of the bundle" - }, - "bundleType" : { - "type" : "string", - "description" : "The type of bundle (i.e. a NiFi NAR vs MiNiFi CPP)", - "enum" : [ "NIFI_NAR", "MINIFI_CPP" ] - }, - "groupId" : { - "type" : "string", - "description" : "The group id of the bundle" - }, - "artifactId" : { - "type" : "string", - "description" : "The artifact id of the bundle" - }, - "version" : { - "type" : "string", - "description" : "The version of the bundle" - }, - "systemApiVersion" : { - "type" : "string", - "description" : "The version of the system API the bundle was built against" - } - } - }, - "BundleVersion" : { - "type" : "object", - "required" : [ "versionMetadata" ], - "properties" : { - "link" : { - "description" : "An WebLink to this entity.", - "readOnly" : true, - "$ref" : "#/definitions/Link" - }, - "versionMetadata" : { - "description" : "The metadata about this version of the extension bundle", - "$ref" : "#/definitions/BundleVersionMetadata" - }, - "dependencies" : { - "type" : "array", - "description" : "The set of other bundle versions that this version is dependent on", - "readOnly" : true, - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/BundleVersionDependency" - } - }, - "bundle" : { - "description" : "The bundle this version is for", - "readOnly" : true, - "$ref" : "#/definitions/ExtensionBundle" - }, - "bucket" : { - "description" : "The bucket that the extension bundle belongs to", - "$ref" : "#/definitions/Bucket" - }, - "filename" : { - "type" : "string" - } - } - }, - "BundleVersionDependency" : { - "type" : "object", - "properties" : { - "groupId" : { - "type" : "string", - "description" : "The group id of the bundle dependency" - }, - "artifactId" : { - "type" : "string", - "description" : "The artifact id of the bundle dependency" - }, - "version" : { - "type" : "string", - "description" : "The version of the bundle dependency" - } - } - }, - "BundleVersionMetadata" : { - "type" : "object", - "required" : [ "bucketId", "buildInfo", "contentSize", "sha256Supplied" ], - "properties" : { - "link" : { - "description" : "An WebLink to this entity.", - "readOnly" : true, - "$ref" : "#/definitions/Link" - }, - "id" : { - "type" : "string", - "description" : "The id of this version of the extension bundle" - }, - "bundleId" : { - "type" : "string", - "description" : "The id of the extension bundle this version is for" - }, - "bucketId" : { - "type" : "string", - "description" : "The id of the bucket the extension bundle belongs to" - }, - "version" : { - "type" : "string", - "description" : "The version of the extension bundle" - }, - "timestamp" : { - "type" : "integer", - "format" : "int64", - "description" : "The timestamp of the create date of this version", - "minimum" : 1 - }, - "author" : { - "type" : "string", - "description" : "The identity that created this version" - }, - "description" : { - "type" : "string", - "description" : "The description for this version" - }, - "sha256" : { - "type" : "string", - "description" : "The hex representation of the SHA-256 digest of the binary content for this version" - }, - "sha256Supplied" : { - "type" : "boolean", - "description" : "Whether or not the client supplied a SHA-256 when uploading the bundle" - }, - "contentSize" : { - "type" : "integer", - "format" : "int64", - "description" : "The size of the binary content for this version in bytes", - "minimum" : 0 - }, - "systemApiVersion" : { - "type" : "string", - "description" : "The version of the system API that this bundle version was built against" - }, - "buildInfo" : { - "description" : "The build information about this version", - "$ref" : "#/definitions/BuildInfo" - } - } - }, - "ComponentDifference" : { - "type" : "object", - "properties" : { - "valueA" : { - "type" : "string", - "description" : "The earlier value from the difference." - }, - "valueB" : { - "type" : "string", - "description" : "The newer value from the difference." - }, - "changeDescription" : { - "type" : "string", - "description" : "The description of the change." - }, - "differenceType" : { - "type" : "string", - "description" : "The key to the difference." - }, - "differenceTypeDescription" : { - "type" : "string", - "description" : "The description of the change type." - } - } - }, - "ComponentDifferenceGroup" : { - "type" : "object", - "properties" : { - "componentId" : { - "type" : "string", - "description" : "The id of the component whose changes are grouped together." - }, - "componentName" : { - "type" : "string", - "description" : "The name of the component whose changes are grouped together." - }, - "componentType" : { - "type" : "string", - "description" : "The type of component these changes relate to." - }, - "processGroupId" : { - "type" : "string", - "description" : "The process group id for this component." - }, - "differences" : { - "type" : "array", - "description" : "The list of changes related to this component between the 2 versions.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ComponentDifference" - } - } - } - }, - "ConnectableComponent" : { - "type" : "object", - "required" : [ "groupId", "id", "type" ], - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the connectable component." - }, - "type" : { - "type" : "string", - "description" : "The type of component the connectable is.", - "enum" : [ "PROCESSOR", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "INPUT_PORT", "OUTPUT_PORT", "FUNNEL" ] - }, - "groupId" : { - "type" : "string", - "description" : "The id of the group that the connectable component resides in" - }, - "name" : { - "type" : "string", - "description" : "The name of the connectable component" - }, - "comments" : { - "type" : "string", - "description" : "The comments for the connectable component." - } - } - }, - "ControllerServiceAPI" : { - "type" : "object", - "properties" : { - "type" : { - "type" : "string", - "description" : "The fully qualified name of the service interface." - }, - "bundle" : { - "description" : "The details of the artifact that bundled this service interface.", - "$ref" : "#/definitions/Bundle" - } - } - }, - "ControllerServiceDefinition" : { - "type" : "object", - "properties" : { - "className" : { - "type" : "string", - "description" : "The class name of the service API" - }, - "groupId" : { - "type" : "string", - "description" : "The group id of the service API" - }, - "artifactId" : { - "type" : "string", - "description" : "The artifact id of the service API" - }, - "version" : { - "type" : "string", - "description" : "The version of the service API" - } - } - }, - "CurrentUser" : { - "type" : "object", - "properties" : { - "identity" : { - "type" : "string", - "description" : "The identity of the current user", - "readOnly" : true - }, - "anonymous" : { - "type" : "boolean", - "description" : "Indicates if the current user is anonymous", - "readOnly" : true - }, - "resourcePermissions" : { - "description" : "The access that the current user has to top level resources", - "readOnly" : true, - "$ref" : "#/definitions/ResourcePermissions" - } - } - }, - "DeprecationNotice" : { - "type" : "object", - "properties" : { - "reason" : { - "type" : "string", - "description" : "The reason for the deprecation" - }, - "alternatives" : { - "type" : "array", - "xml" : { - "wrapped" : true - }, - "description" : "The alternatives to use", - "items" : { - "type" : "string", - "xml" : { - "name" : "alternative" - } - } - } - } - }, - "DynamicProperty" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The description of the dynamic property name" - }, - "value" : { - "type" : "string", - "description" : "The description of the dynamic property value" - }, - "description" : { - "type" : "string", - "description" : "The description of the dynamic property" - }, - "expressionLanguageScope" : { - "type" : "string", - "description" : "The scope of the expression language support", - "enum" : [ "NONE", "VARIABLE_REGISTRY", "FLOWFILE_ATTRIBUTES" ] - }, - "expressionLanguageSupported" : { - "type" : "boolean", - "description" : "Whether or not expression language is supported" - } - } - }, - "DynamicRelationship" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The description of the dynamic relationship name" - }, - "description" : { - "type" : "string", - "description" : "The description of the dynamic relationship" - } - } - }, - "Extension" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The name of the extension" - }, - "type" : { - "type" : "string", - "description" : "The type of the extension", - "enum" : [ "PROCESSOR", "CONTROLLER_SERVICE", "REPORTING_TASK" ] - }, - "deprecationNotice" : { - "description" : "The deprecation notice of the extension", - "$ref" : "#/definitions/DeprecationNotice" - }, - "description" : { - "type" : "string", - "description" : "The description of the extension" - }, - "tags" : { - "type" : "array", - "xml" : { - "wrapped" : true - }, - "description" : "The tags of the extension", - "items" : { - "type" : "string", - "xml" : { - "name" : "tag" - } - } - }, - "properties" : { - "type" : "array", - "xml" : { - "wrapped" : true - }, - "description" : "The properties of the extension", - "items" : { - "xml" : { - "name" : "property" - }, - "$ref" : "#/definitions/Property" - } - }, - "dynamicProperties" : { - "type" : "array", - "xml" : { - "wrapped" : true - }, - "description" : "The dynamic properties of the extension", - "items" : { - "xml" : { - "name" : "dynamicProperty" - }, - "$ref" : "#/definitions/DynamicProperty" - } - }, - "relationships" : { - "type" : "array", - "xml" : { - "wrapped" : true - }, - "description" : "The relationships of the extension", - "items" : { - "xml" : { - "name" : "relationship" - }, - "$ref" : "#/definitions/Relationship" - } - }, - "dynamicRelationship" : { - "description" : "The dynamic relationships of the extension", - "$ref" : "#/definitions/DynamicRelationship" - }, - "readsAttributes" : { - "type" : "array", - "xml" : { - "wrapped" : true - }, - "description" : "The attributes read from flow files by the extension", - "items" : { - "xml" : { - "name" : "readsAttribute" - }, - "$ref" : "#/definitions/Attribute" - } - }, - "writesAttributes" : { - "type" : "array", - "xml" : { - "wrapped" : true - }, - "description" : "The attributes written to flow files by the extension", - "items" : { - "xml" : { - "name" : "writesAttribute" - }, - "$ref" : "#/definitions/Attribute" - } - }, - "stateful" : { - "description" : "The information about how the extension stores state", - "$ref" : "#/definitions/Stateful" - }, - "restricted" : { - "description" : "The restrictions of the extension", - "$ref" : "#/definitions/Restricted" - }, - "inputRequirement" : { - "type" : "string", - "description" : "The input requirement of the extension", - "enum" : [ "INPUT_REQUIRED", "INPUT_ALLOWED", "INPUT_FORBIDDEN" ] - }, - "systemResourceConsiderations" : { - "type" : "array", - "xml" : { - "wrapped" : true - }, - "description" : "The resource considerations of the extension", - "items" : { - "xml" : { - "name" : "systemResourceConsideration" - }, - "$ref" : "#/definitions/SystemResourceConsideration" - } - }, - "seeAlso" : { - "type" : "array", - "xml" : { - "wrapped" : true - }, - "description" : "The names of other extensions to see", - "items" : { - "type" : "string", - "xml" : { - "name" : "see" - } - } - }, - "providedServiceAPIs" : { - "type" : "array", - "xml" : { - "wrapped" : true - }, - "description" : "The service APIs provided by this extension", - "items" : { - "xml" : { - "name" : "providedServiceAPI" - }, - "$ref" : "#/definitions/ProvidedServiceAPI" - } - } - } - }, - "ExtensionBundle" : { - "type" : "object", - "required" : [ "bucketIdentifier", "bundleType", "name", "type" ], - "properties" : { - "link" : { - "description" : "An WebLink to this entity.", - "readOnly" : true, - "$ref" : "#/definitions/Link" - }, - "identifier" : { - "type" : "string", - "description" : "An ID to uniquely identify this object.", - "readOnly" : true - }, - "name" : { - "type" : "string", - "description" : "The name of the item." - }, - "description" : { - "type" : "string", - "description" : "A description of the item." - }, - "bucketIdentifier" : { - "type" : "string", - "description" : "The identifier of the bucket this items belongs to. This cannot be changed after the item is created." - }, - "bucketName" : { - "type" : "string", - "description" : "The name of the bucket this items belongs to.", - "readOnly" : true - }, - "createdTimestamp" : { - "type" : "integer", - "format" : "int64", - "description" : "The timestamp of when the item was created, as milliseconds since epoch.", - "readOnly" : true, - "minimum" : 1 - }, - "modifiedTimestamp" : { - "type" : "integer", - "format" : "int64", - "description" : "The timestamp of when the item was last modified, as milliseconds since epoch.", - "readOnly" : true, - "minimum" : 1 - }, - "type" : { - "type" : "string", - "description" : "The type of item.", - "enum" : [ "Flow", "Extension_Bundle" ] - }, - "permissions" : { - "description" : "The access that the current user has to the bucket containing this item.", - "readOnly" : true, - "$ref" : "#/definitions/Permissions" - }, - "bundleType" : { - "type" : "string", - "description" : "The type of the extension bundle", - "enum" : [ "NIFI_NAR", "MINIFI_CPP" ] - }, - "groupId" : { - "type" : "string", - "description" : "The group id of the extension bundle" - }, - "artifactId" : { - "type" : "string", - "description" : "The artifact id of the extension bundle" - }, - "versionCount" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of versions of this extension bundle.", - "readOnly" : true, - "minimum" : 0 - } - } - }, - "ExtensionFilterParams" : { - "type" : "object", - "properties" : { - "bundleType" : { - "type" : "string", - "description" : "The type of bundle", - "enum" : [ "NIFI_NAR", "MINIFI_CPP" ] - }, - "extensionType" : { - "type" : "string", - "description" : "The type of extension", - "enum" : [ "PROCESSOR", "CONTROLLER_SERVICE", "REPORTING_TASK" ] - }, - "tags" : { - "type" : "array", - "description" : "The tags", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - } - } - }, - "ExtensionMetadata" : { - "type" : "object", - "properties" : { - "link" : { - "description" : "An WebLink to this entity.", - "readOnly" : true, - "$ref" : "#/definitions/Link" - }, - "name" : { - "type" : "string", - "description" : "The name of the extension" - }, - "displayName" : { - "type" : "string", - "description" : "The display name of the extension" - }, - "type" : { - "type" : "string", - "description" : "The type of the extension", - "enum" : [ "PROCESSOR", "CONTROLLER_SERVICE", "REPORTING_TASK" ] - }, - "description" : { - "type" : "string", - "description" : "The description of the extension" - }, - "deprecationNotice" : { - "description" : "The deprecation notice of the extension", - "$ref" : "#/definitions/DeprecationNotice" - }, - "tags" : { - "type" : "array", - "description" : "The tags of the extension", - "items" : { - "type" : "string" - } - }, - "restricted" : { - "description" : "The restrictions of the extension", - "$ref" : "#/definitions/Restricted" - }, - "providedServiceAPIs" : { - "type" : "array", - "description" : "The service APIs provided by the extension", - "items" : { - "$ref" : "#/definitions/ProvidedServiceAPI" - } - }, - "bundleInfo" : { - "description" : "The information for the bundle where this extension is located", - "$ref" : "#/definitions/BundleInfo" - }, - "hasAdditionalDetails" : { - "type" : "boolean", - "description" : "Whether or not the extension has additional detail documentation" - }, - "linkDocs" : { - "description" : "A WebLink to the documentation for this extension.", - "readOnly" : true, - "$ref" : "#/definitions/Link" - } - } - }, - "ExtensionMetadataContainer" : { - "type" : "object", - "properties" : { - "numResults" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of extensions in the response" - }, - "filterParams" : { - "description" : "The filter parameters submitted for the request", - "$ref" : "#/definitions/ExtensionFilterParams" - }, - "extensions" : { - "type" : "array", - "description" : "The metadata for the extensions", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ExtensionMetadata" - } - } - } - }, - "ExtensionRepoArtifact" : { - "type" : "object", - "properties" : { - "link" : { - "description" : "An WebLink to this entity.", - "readOnly" : true, - "$ref" : "#/definitions/Link" - }, - "bucketName" : { - "type" : "string", - "description" : "The bucket name" - }, - "groupId" : { - "type" : "string", - "description" : "The group id" - }, - "artifactId" : { - "type" : "string", - "description" : "The artifact id" - } - } - }, - "ExtensionRepoBucket" : { - "type" : "object", - "properties" : { - "link" : { - "description" : "An WebLink to this entity.", - "readOnly" : true, - "$ref" : "#/definitions/Link" - }, - "bucketName" : { - "type" : "string", - "description" : "The name of the bucket" - } - } - }, - "ExtensionRepoGroup" : { - "type" : "object", - "properties" : { - "link" : { - "description" : "An WebLink to this entity.", - "readOnly" : true, - "$ref" : "#/definitions/Link" - }, - "bucketName" : { - "type" : "string", - "description" : "The bucket name" - }, - "groupId" : { - "type" : "string", - "description" : "The group id" - } - } - }, - "ExtensionRepoVersion" : { - "type" : "object", - "properties" : { - "extensionsLink" : { - "description" : "The WebLink to view the metadata about the extensions contained in the extension bundle.", - "readOnly" : true, - "$ref" : "#/definitions/Link" - }, - "downloadLink" : { - "description" : "The WebLink to download this version of the extension bundle.", - "readOnly" : true, - "$ref" : "#/definitions/Link" - }, - "sha256Link" : { - "description" : "The WebLink to retrieve the SHA-256 digest for this version of the extension bundle.", - "readOnly" : true, - "$ref" : "#/definitions/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" : { - "link" : { - "description" : "An WebLink to this entity.", - "readOnly" : true, - "$ref" : "#/definitions/Link" - }, - "bucketName" : { - "type" : "string", - "description" : "The bucket name" - }, - "groupId" : { - "type" : "string", - "description" : "The group id" - }, - "artifactId" : { - "type" : "string", - "description" : "The artifact id" - }, - "version" : { - "type" : "string", - "description" : "The version" - }, - "author" : { - "type" : "string", - "description" : "The identity of the user that created this version" - }, - "timestamp" : { - "type" : "integer", - "format" : "int64", - "description" : "The timestamp of when this version was created" - } - } - }, - "Fields" : { - "type" : "object", - "properties" : { - "fields" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - } - } - }, - "Link" : { - "type" : "object", - "properties" : { - "type" : { - "type" : "string" - }, - "params" : { - "type" : "object", - "additionalProperties" : { - "type" : "string" - } - }, - "title" : { - "type" : "string" - }, - "uriBuilder" : { - "$ref" : "#/definitions/UriBuilder" - }, - "rel" : { - "type" : "string" - }, - "rels" : { - "type" : "array", - "items" : { - "type" : "string" - } - }, - "uri" : { - "type" : "string", - "format" : "uri" - } - } - }, - "Permissions" : { - "type" : "object", - "properties" : { - "canRead" : { - "type" : "boolean", - "description" : "Indicates whether the user can read a given resource.", - "readOnly" : true - }, - "canWrite" : { - "type" : "boolean", - "description" : "Indicates whether the user can write a given resource.", - "readOnly" : true - }, - "canDelete" : { - "type" : "boolean", - "description" : "Indicates whether the user can delete a given resource.", - "readOnly" : true - } - } - }, - "Position" : { - "type" : "object", - "properties" : { - "x" : { - "type" : "number", - "format" : "double", - "description" : "The x coordinate." - }, - "y" : { - "type" : "number", - "format" : "double", - "description" : "The y coordinate." - } - }, - "description" : "The position of a component on the graph" - }, - "Property" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The name of the property" - }, - "displayName" : { - "type" : "string", - "description" : "The display name" - }, - "description" : { - "type" : "string", - "description" : "The description" - }, - "defaultValue" : { - "type" : "string", - "description" : "The default value" - }, - "controllerServiceDefinition" : { - "description" : "The controller service required by this property, or null if none is required", - "$ref" : "#/definitions/ControllerServiceDefinition" - }, - "allowableValues" : { - "type" : "array", - "xml" : { - "wrapped" : true - }, - "description" : "The allowable values for this property", - "items" : { - "xml" : { - "name" : "allowableValue" - }, - "$ref" : "#/definitions/AllowableValue" - } - }, - "required" : { - "type" : "boolean", - "description" : "Whether or not the property is required" - }, - "sensitive" : { - "type" : "boolean", - "description" : "Whether or not the property is sensitive" - }, - "expressionLanguageSupported" : { - "type" : "boolean", - "description" : "Whether or not expression language is supported" - }, - "expressionLanguageScope" : { - "type" : "string", - "description" : "The scope of expression language support", - "enum" : [ "NONE", "VARIABLE_REGISTRY", "FLOWFILE_ATTRIBUTES" ] - }, - "dynamicallyModifiesClasspath" : { - "type" : "boolean", - "description" : "Whether or not the processor dynamically modifies the classpath" - }, - "dynamic" : { - "type" : "boolean", - "description" : "Whether or not the processor is dynamic" - } - } - }, - "ProvidedServiceAPI" : { - "type" : "object", - "properties" : { - "className" : { - "type" : "string", - "description" : "The class name of the service API being provided" - }, - "groupId" : { - "type" : "string", - "description" : "The group id of the service API being provided" - }, - "artifactId" : { - "type" : "string", - "description" : "The artifact id of the service API being provided" - }, - "version" : { - "type" : "string", - "description" : "The version of the service API being provided" - } - } - }, - "RegistryConfiguration" : { - "type" : "object", - "properties" : { - "supportsManagedAuthorizer" : { - "type" : "boolean", - "description" : "Whether this NiFi Registry supports a managed authorizer. Managed authorizers can visualize users, groups, and policies in the UI.", - "readOnly" : true - }, - "supportsConfigurableAuthorizer" : { - "type" : "boolean", - "description" : "Whether this NiFi Registry supports a configurable authorizer.", - "readOnly" : true - }, - "supportsConfigurableUsersAndGroups" : { - "type" : "boolean", - "description" : "Whether this NiFi Registry supports configurable users and groups.", - "readOnly" : true - } - } - }, - "Relationship" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The name of the relationship" - }, - "description" : { - "type" : "string", - "description" : "The description of the relationship" - }, - "autoTerminated" : { - "type" : "boolean", - "description" : "Whether or not the relationship is auto-terminated by default" - } - } - }, - "Resource" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The identifier of the resource.", - "readOnly" : true - }, - "name" : { - "type" : "string", - "description" : "The name of the resource.", - "readOnly" : true - } - } - }, - "ResourcePermissions" : { - "type" : "object", - "properties" : { - "buckets" : { - "description" : "The access that the current user has to the top level /buckets resource of this NiFi Registry (i.e., access to all buckets)", - "readOnly" : true, - "$ref" : "#/definitions/Permissions" - }, - "tenants" : { - "description" : "The access that the current user has to the top level /tenants resource of this NiFi Registry", - "readOnly" : true, - "$ref" : "#/definitions/Permissions" - }, - "policies" : { - "description" : "The access that the current user has to the top level /policies resource of this NiFi Registry", - "readOnly" : true, - "$ref" : "#/definitions/Permissions" - }, - "proxy" : { - "description" : "The access that the current user has to the top level /proxy resource of this NiFi Registry", - "readOnly" : true, - "$ref" : "#/definitions/Permissions" - }, - "anyTopLevelResource" : { - "description" : "The access that the current user has to any top level resources (a logical 'OR' of all other values)", - "readOnly" : true, - "$ref" : "#/definitions/Permissions" - } - } - }, - "Restricted" : { - "type" : "object", - "properties" : { - "generalRestrictionExplanation" : { - "type" : "string", - "description" : "The general restriction for the extension, or null if only specific restrictions exist" - }, - "restrictions" : { - "type" : "array", - "xml" : { - "wrapped" : true - }, - "description" : "The specific restrictions", - "items" : { - "xml" : { - "name" : "restriction" - }, - "$ref" : "#/definitions/Restriction" - } - } - } - }, - "Restriction" : { - "type" : "object", - "properties" : { - "requiredPermission" : { - "type" : "string", - "description" : "The permission required for this restriction" - }, - "explanation" : { - "type" : "string", - "description" : "The explanation of this restriction" - } - } - }, - "Stateful" : { - "type" : "object", - "properties" : { - "description" : { - "type" : "string", - "description" : "The description for how the extension stores state" - }, - "scopes" : { - "type" : "array", - "xml" : { - "wrapped" : true - }, - "description" : "The scopes used to store state", - "items" : { - "type" : "string", - "xml" : { - "name" : "scope" - }, - "enum" : [ "CLUSTER", "LOCAL" ] - } - } - } - }, - "SystemResourceConsideration" : { - "type" : "object", - "properties" : { - "resource" : { - "type" : "string", - "description" : "The resource to consider" - }, - "description" : { - "type" : "string", - "description" : "The description of how the resource is affected" - } - } - }, - "TagCount" : { - "type" : "object", - "properties" : { - "tag" : { - "type" : "string", - "description" : "The tag label" - }, - "count" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of occurrences of the given tag" - } - } - }, - "Tenant" : { - "type" : "object", - "required" : [ "identity" ], - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The computer-generated identifier of the tenant.", - "readOnly" : true - }, - "identity" : { - "type" : "string", - "description" : "The human-facing identity of the tenant. This can only be changed if the tenant is configurable." - }, - "configurable" : { - "type" : "boolean", - "description" : "Indicates if this tenant is configurable, based on which UserGroupProvider has been configured to manage it.", - "readOnly" : true - }, - "resourcePermissions" : { - "description" : "A summary top-level resource access policies granted to this tenant.", - "readOnly" : true, - "$ref" : "#/definitions/ResourcePermissions" - }, - "accessPolicies" : { - "type" : "array", - "description" : "The access policies granted to this tenant.", - "readOnly" : true, - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/AccessPolicySummary" - } - } - } - }, - "UriBuilder" : { - "type" : "object" - }, - "User" : { - "type" : "object", - "required" : [ "identity" ], - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The computer-generated identifier of the tenant.", - "readOnly" : true - }, - "identity" : { - "type" : "string", - "description" : "The human-facing identity of the tenant. This can only be changed if the tenant is configurable." - }, - "configurable" : { - "type" : "boolean", - "description" : "Indicates if this tenant is configurable, based on which UserGroupProvider has been configured to manage it.", - "readOnly" : true - }, - "resourcePermissions" : { - "description" : "A summary top-level resource access policies granted to this tenant.", - "readOnly" : true, - "$ref" : "#/definitions/ResourcePermissions" - }, - "accessPolicies" : { - "type" : "array", - "description" : "The access policies granted to this tenant.", - "readOnly" : true, - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/AccessPolicySummary" - } - }, - "userGroups" : { - "type" : "array", - "description" : "The groups to which the user belongs.", - "readOnly" : true, - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/Tenant" - } - } - } - }, - "UserGroup" : { - "type" : "object", - "required" : [ "identity" ], - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The computer-generated identifier of the tenant.", - "readOnly" : true - }, - "identity" : { - "type" : "string", - "description" : "The human-facing identity of the tenant. This can only be changed if the tenant is configurable." - }, - "configurable" : { - "type" : "boolean", - "description" : "Indicates if this tenant is configurable, based on which UserGroupProvider has been configured to manage it.", - "readOnly" : true - }, - "resourcePermissions" : { - "description" : "A summary top-level resource access policies granted to this tenant.", - "readOnly" : true, - "$ref" : "#/definitions/ResourcePermissions" - }, - "accessPolicies" : { - "type" : "array", - "description" : "The access policies granted to this tenant.", - "readOnly" : true, - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/AccessPolicySummary" - } - }, - "users" : { - "type" : "array", - "description" : "The users that belong to this user group. This can only be changed if this group is configurable.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/Tenant" - } - } - } - }, - "VersionedConnection" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The component's unique identifier" - }, - "name" : { - "type" : "string", - "description" : "The component's name" - }, - "comments" : { - "type" : "string", - "description" : "The user-supplied comments for the component" - }, - "position" : { - "description" : "The component's position on the graph", - "$ref" : "#/definitions/Position" - }, - "source" : { - "description" : "The source of the connection.", - "$ref" : "#/definitions/ConnectableComponent" - }, - "destination" : { - "description" : "The destination of the connection.", - "$ref" : "#/definitions/ConnectableComponent" - }, - "labelIndex" : { - "type" : "integer", - "format" : "int32", - "description" : "The index of the bend point where to place the connection label." - }, - "zIndex" : { - "type" : "integer", - "format" : "int64", - "description" : "The z index of the connection." - }, - "selectedRelationships" : { - "type" : "array", - "description" : "The selected relationship that comprise the connection.", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - }, - "backPressureObjectThreshold" : { - "type" : "integer", - "format" : "int64", - "description" : "The object count threshold for determining when back pressure is applied. Updating this value is a passive change in the sense that it won't impact whether existing files over the limit are affected but it does help feeder processors to stop pushing too much into this work queue." - }, - "backPressureDataSizeThreshold" : { - "type" : "string", - "description" : "The object data size threshold for determining when back pressure is applied. Updating this value is a passive change in the sense that it won't impact whether existing files over the limit are affected but it does help feeder processors to stop pushing too much into this work queue." - }, - "flowFileExpiration" : { - "type" : "string", - "description" : "The amount of time a flow file may be in the flow before it will be automatically aged out of the flow. Once a flow file reaches this age it will be terminated from the flow the next time a processor attempts to start work on it." - }, - "prioritizers" : { - "type" : "array", - "description" : "The comparators used to prioritize the queue.", - "items" : { - "type" : "string" - } - }, - "bends" : { - "type" : "array", - "description" : "The bend points on the connection.", - "items" : { - "$ref" : "#/definitions/Position" - } - }, - "loadBalanceStrategy" : { - "type" : "string", - "description" : "The Strategy to use for load balancing data across the cluster, or null, if no Load Balance Strategy has been specified.", - "enum" : [ "DO_NOT_LOAD_BALANCE", "PARTITION_BY_ATTRIBUTE", "ROUND_ROBIN", "SINGLE_NODE" ] - }, - "partitioningAttribute" : { - "type" : "string", - "description" : "The attribute to use for partitioning data as it is load balanced across the cluster. If the Load Balance Strategy is configured to use PARTITION_BY_ATTRIBUTE, the value returned by this method is the name of the FlowFile Attribute that will be used to determine which node in the cluster should receive a given FlowFile. If the Load Balance Strategy is unset or is set to any other value, the Partitioning Attribute has no effect." - }, - "loadBalanceCompression" : { - "type" : "string", - "description" : "Whether or not compression should be used when transferring FlowFiles between nodes", - "enum" : [ "DO_NOT_COMPRESS", "COMPRESS_ATTRIBUTES_ONLY", "COMPRESS_ATTRIBUTES_AND_CONTENT" ] - }, - "componentType" : { - "type" : "string", - "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE" ] - }, - "groupIdentifier" : { - "type" : "string", - "description" : "The ID of the Process Group that this component belongs to" - } - } - }, - "VersionedControllerService" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The component's unique identifier" - }, - "name" : { - "type" : "string", - "description" : "The component's name" - }, - "comments" : { - "type" : "string", - "description" : "The user-supplied comments for the component" - }, - "position" : { - "description" : "The component's position on the graph", - "$ref" : "#/definitions/Position" - }, - "type" : { - "type" : "string", - "description" : "The type of the controller service." - }, - "bundle" : { - "description" : "The details of the artifact that bundled this processor type.", - "$ref" : "#/definitions/Bundle" - }, - "controllerServiceApis" : { - "type" : "array", - "description" : "Lists the APIs this Controller Service implements.", - "items" : { - "$ref" : "#/definitions/ControllerServiceAPI" - } - }, - "properties" : { - "type" : "object", - "description" : "The properties of the controller service.", - "additionalProperties" : { - "type" : "string" - } - }, - "propertyDescriptors" : { - "type" : "object", - "description" : "The property descriptors for the processor.", - "additionalProperties" : { - "$ref" : "#/definitions/VersionedPropertyDescriptor" - } - }, - "annotationData" : { - "type" : "string", - "description" : "The annotation for the controller service. This is how the custom UI relays configuration to the controller service." - }, - "componentType" : { - "type" : "string", - "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE" ] - }, - "groupIdentifier" : { - "type" : "string", - "description" : "The ID of the Process Group that this component belongs to" - } - } - }, - "VersionedFlow" : { - "type" : "object", - "required" : [ "bucketIdentifier", "name", "type" ], - "properties" : { - "link" : { - "description" : "An WebLink to this entity.", - "readOnly" : true, - "$ref" : "#/definitions/Link" - }, - "identifier" : { - "type" : "string", - "description" : "An ID to uniquely identify this object.", - "readOnly" : true - }, - "name" : { - "type" : "string", - "description" : "The name of the item." - }, - "description" : { - "type" : "string", - "description" : "A description of the item." - }, - "bucketIdentifier" : { - "type" : "string", - "description" : "The identifier of the bucket this items belongs to. This cannot be changed after the item is created." - }, - "bucketName" : { - "type" : "string", - "description" : "The name of the bucket this items belongs to.", - "readOnly" : true - }, - "createdTimestamp" : { - "type" : "integer", - "format" : "int64", - "description" : "The timestamp of when the item was created, as milliseconds since epoch.", - "readOnly" : true, - "minimum" : 1 - }, - "modifiedTimestamp" : { - "type" : "integer", - "format" : "int64", - "description" : "The timestamp of when the item was last modified, as milliseconds since epoch.", - "readOnly" : true, - "minimum" : 1 - }, - "type" : { - "type" : "string", - "description" : "The type of item.", - "enum" : [ "Flow", "Extension_Bundle" ] - }, - "permissions" : { - "description" : "The access that the current user has to the bucket containing this item.", - "readOnly" : true, - "$ref" : "#/definitions/Permissions" - }, - "versionCount" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of versions of this flow.", - "readOnly" : true, - "minimum" : 0 - } - } - }, - "VersionedFlowCoordinates" : { - "type" : "object", - "properties" : { - "registryUrl" : { - "type" : "string", - "description" : "The URL of the Flow Registry that contains the flow" - }, - "bucketId" : { - "type" : "string", - "description" : "The UUID of the bucket that the flow resides in" - }, - "flowId" : { - "type" : "string", - "description" : "The UUID of the flow" - }, - "version" : { - "type" : "integer", - "format" : "int32", - "description" : "The version of the flow" - }, - "latest" : { - "type" : "boolean", - "description" : "Whether or not these coordinates point to the latest version of the flow" - } - } - }, - "VersionedFlowDifference" : { - "type" : "object", - "properties" : { - "bucketId" : { - "type" : "string", - "description" : "The id of the bucket that the flow is stored in." - }, - "flowId" : { - "type" : "string", - "description" : "The id of the flow that is being examined." - }, - "versionA" : { - "type" : "integer", - "format" : "int32", - "description" : "The earlier version from the diff operation." - }, - "versionB" : { - "type" : "integer", - "format" : "int32", - "description" : "The latter version from the diff operation." - }, - "componentDifferenceGroups" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ComponentDifferenceGroup" - } - } - } - }, - "VersionedFlowSnapshot" : { - "type" : "object", - "required" : [ "flowContents", "snapshotMetadata" ], - "properties" : { - "snapshotMetadata" : { - "description" : "The metadata for this snapshot", - "$ref" : "#/definitions/VersionedFlowSnapshotMetadata" - }, - "flowContents" : { - "description" : "The contents of the versioned flow", - "$ref" : "#/definitions/VersionedProcessGroup" - }, - "flow" : { - "description" : "The flow this snapshot is for", - "readOnly" : true, - "$ref" : "#/definitions/VersionedFlow" - }, - "bucket" : { - "description" : "The bucket where the flow is located", - "readOnly" : true, - "$ref" : "#/definitions/Bucket" - }, - "latest" : { - "type" : "boolean" - } - } - }, - "VersionedFlowSnapshotMetadata" : { - "type" : "object", - "required" : [ "bucketIdentifier", "flowIdentifier", "version" ], - "properties" : { - "link" : { - "description" : "An WebLink to this entity.", - "readOnly" : true, - "$ref" : "#/definitions/Link" - }, - "bucketIdentifier" : { - "type" : "string", - "description" : "The identifier of the bucket this snapshot belongs to." - }, - "flowIdentifier" : { - "type" : "string", - "description" : "The identifier of the flow this snapshot belongs to." - }, - "version" : { - "type" : "integer", - "format" : "int32", - "description" : "The version of this snapshot of the flow.", - "minimum" : 1 - }, - "timestamp" : { - "type" : "integer", - "format" : "int64", - "description" : "The timestamp when the flow was saved, as milliseconds since epoch.", - "readOnly" : true, - "minimum" : 1 - }, - "author" : { - "type" : "string", - "description" : "The user that created this snapshot of the flow.", - "readOnly" : true - }, - "comments" : { - "type" : "string", - "description" : "The comments provided by the user when creating the snapshot." - } - } - }, - "VersionedFunnel" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The component's unique identifier" - }, - "name" : { - "type" : "string", - "description" : "The component's name" - }, - "comments" : { - "type" : "string", - "description" : "The user-supplied comments for the component" - }, - "position" : { - "description" : "The component's position on the graph", - "$ref" : "#/definitions/Position" - }, - "componentType" : { - "type" : "string", - "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE" ] - }, - "groupIdentifier" : { - "type" : "string", - "description" : "The ID of the Process Group that this component belongs to" - } - } - }, - "VersionedLabel" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The component's unique identifier" - }, - "name" : { - "type" : "string", - "description" : "The component's name" - }, - "comments" : { - "type" : "string", - "description" : "The user-supplied comments for the component" - }, - "position" : { - "description" : "The component's position on the graph", - "$ref" : "#/definitions/Position" - }, - "label" : { - "type" : "string", - "description" : "The text that appears in the label." - }, - "width" : { - "type" : "number", - "format" : "double", - "description" : "The width of the label in pixels when at a 1:1 scale." - }, - "height" : { - "type" : "number", - "format" : "double", - "description" : "The height of the label in pixels when at a 1:1 scale." - }, - "style" : { - "type" : "object", - "description" : "The styles for this label (font-size : 12px, background-color : #eee, etc).", - "additionalProperties" : { - "type" : "string" - } - }, - "componentType" : { - "type" : "string", - "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE" ] - }, - "groupIdentifier" : { - "type" : "string", - "description" : "The ID of the Process Group that this component belongs to" - } - } - }, - "VersionedPort" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The component's unique identifier" - }, - "name" : { - "type" : "string", - "description" : "The component's name" - }, - "comments" : { - "type" : "string", - "description" : "The user-supplied comments for the component" - }, - "position" : { - "description" : "The component's position on the graph", - "$ref" : "#/definitions/Position" - }, - "type" : { - "type" : "string", - "description" : "The type of port.", - "enum" : [ "INPUT_PORT", "OUTPUT_PORT" ] - }, - "concurrentlySchedulableTaskCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of tasks that should be concurrently scheduled for the port." - }, - "componentType" : { - "type" : "string", - "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE" ] - }, - "groupIdentifier" : { - "type" : "string", - "description" : "The ID of the Process Group that this component belongs to" - } - } - }, - "VersionedProcessGroup" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The component's unique identifier" - }, - "name" : { - "type" : "string", - "description" : "The component's name" - }, - "comments" : { - "type" : "string", - "description" : "The user-supplied comments for the component" - }, - "position" : { - "description" : "The component's position on the graph", - "$ref" : "#/definitions/Position" - }, - "processGroups" : { - "type" : "array", - "description" : "The child Process Groups", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedProcessGroup" - } - }, - "remoteProcessGroups" : { - "type" : "array", - "description" : "The Remote Process Groups", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedRemoteProcessGroup" - } - }, - "processors" : { - "type" : "array", - "description" : "The Processors", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedProcessor" - } - }, - "inputPorts" : { - "type" : "array", - "description" : "The Input Ports", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedPort" - } - }, - "outputPorts" : { - "type" : "array", - "description" : "The Output Ports", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedPort" - } - }, - "connections" : { - "type" : "array", - "description" : "The Connections", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedConnection" - } - }, - "labels" : { - "type" : "array", - "description" : "The Labels", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedLabel" - } - }, - "funnels" : { - "type" : "array", - "description" : "The Funnels", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedFunnel" - } - }, - "controllerServices" : { - "type" : "array", - "description" : "The Controller Services", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedControllerService" - } - }, - "versionedFlowCoordinates" : { - "description" : "The coordinates where the remote flow is stored, or null if the Process Group is not directly under Version Control", - "$ref" : "#/definitions/VersionedFlowCoordinates" - }, - "variables" : { - "type" : "object", - "description" : "The Variables in the Variable Registry for this Process Group (not including any ancestor or descendant Process Groups)", - "additionalProperties" : { - "type" : "string" - } - }, - "componentType" : { - "type" : "string", - "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE" ] - }, - "groupIdentifier" : { - "type" : "string", - "description" : "The ID of the Process Group that this component belongs to" - } - } - }, - "VersionedProcessor" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The component's unique identifier" - }, - "name" : { - "type" : "string", - "description" : "The component's name" - }, - "comments" : { - "type" : "string", - "description" : "The user-supplied comments for the component" - }, - "position" : { - "description" : "The component's position on the graph", - "$ref" : "#/definitions/Position" - }, - "bundle" : { - "description" : "Information about the bundle from which the component came", - "$ref" : "#/definitions/Bundle" - }, - "style" : { - "type" : "object", - "description" : "Stylistic data for rendering in a UI", - "additionalProperties" : { - "type" : "string" - } - }, - "type" : { - "type" : "string", - "description" : "The type of Processor" - }, - "properties" : { - "type" : "object", - "description" : "The properties for the processor. Properties whose value is not set will only contain the property name.", - "additionalProperties" : { - "type" : "string" - } - }, - "propertyDescriptors" : { - "type" : "object", - "description" : "The property descriptors for the processor.", - "additionalProperties" : { - "$ref" : "#/definitions/VersionedPropertyDescriptor" - } - }, - "annotationData" : { - "type" : "string", - "description" : "The annotation data for the processor used to relay configuration between a custom UI and the procesosr." - }, - "schedulingPeriod" : { - "type" : "string", - "description" : "The frequency with which to schedule the processor. The format of the value will depend on th value of schedulingStrategy." - }, - "schedulingStrategy" : { - "type" : "string", - "description" : "Indcates whether the prcessor should be scheduled to run in event or timer driven mode." - }, - "executionNode" : { - "type" : "string", - "description" : "Indicates the node where the process will execute." - }, - "penaltyDuration" : { - "type" : "string", - "description" : "The amout of time that is used when the process penalizes a flowfile." - }, - "yieldDuration" : { - "type" : "string", - "description" : "The amount of time that must elapse before this processor is scheduled again after yielding." - }, - "bulletinLevel" : { - "type" : "string", - "description" : "The level at which the processor will report bulletins." - }, - "runDurationMillis" : { - "type" : "integer", - "format" : "int64", - "description" : "The run duration for the processor in milliseconds." - }, - "concurrentlySchedulableTaskCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of tasks that should be concurrently schedule for the processor. If the processor doesn't allow parallol processing then any positive input will be ignored." - }, - "autoTerminatedRelationships" : { - "type" : "array", - "description" : "The names of all relationships that cause a flow file to be terminated if the relationship is not connected elsewhere. This property differs from the 'isAutoTerminate' property of the RelationshipDTO in that the RelationshipDTO is meant to depict the current configuration, whereas this property can be set in a DTO when updating a Processor in order to change which Relationships should be auto-terminated.", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - }, - "componentType" : { - "type" : "string", - "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE" ] - }, - "groupIdentifier" : { - "type" : "string", - "description" : "The ID of the Process Group that this component belongs to" - } - } - }, - "VersionedPropertyDescriptor" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The name of the property" - }, - "displayName" : { - "type" : "string", - "description" : "The display name of the property" - }, - "identifiesControllerService" : { - "type" : "boolean", - "description" : "Whether or not the property provides the identifier of a Controller Service" - }, - "sensitive" : { - "type" : "boolean", - "description" : "Whether or not the property is considered sensitive" - } - } - }, - "VersionedRemoteGroupPort" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The component's unique identifier" - }, - "name" : { - "type" : "string", - "description" : "The component's name" - }, - "comments" : { - "type" : "string", - "description" : "The user-supplied comments for the component" - }, - "position" : { - "description" : "The component's position on the graph", - "$ref" : "#/definitions/Position" - }, - "remoteGroupId" : { - "type" : "string", - "description" : "The id of the remote process group that the port resides in." - }, - "concurrentlySchedulableTaskCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of task that may transmit flowfiles to the target port concurrently." - }, - "useCompression" : { - "type" : "boolean", - "description" : "Whether the flowfiles are compressed when sent to the target port." - }, - "batchSize" : { - "description" : "The batch settings for data transmission.", - "$ref" : "#/definitions/BatchSize" - }, - "componentType" : { - "type" : "string", - "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE" ] - }, - "targetId" : { - "type" : "string", - "description" : "The ID of the port on the target NiFi instance" - }, - "groupIdentifier" : { - "type" : "string", - "description" : "The ID of the Process Group that this component belongs to" - } - } - }, - "VersionedRemoteProcessGroup" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The component's unique identifier" - }, - "name" : { - "type" : "string", - "description" : "The component's name" - }, - "comments" : { - "type" : "string", - "description" : "The user-supplied comments for the component" - }, - "position" : { - "description" : "The component's position on the graph", - "$ref" : "#/definitions/Position" - }, - "targetUri" : { - "type" : "string", - "description" : "[DEPRECATED] The target URI of the remote process group. If target uri is not set, but uris are set, then returns the first uri in the uris. If neither target uri nor uris are set, then returns null." - }, - "targetUris" : { - "type" : "string", - "description" : "The target URIs of the remote process group. If target uris is not set but target uri is set, then returns the single target uri. If neither target uris nor target uri is set, then returns null." - }, - "communicationsTimeout" : { - "type" : "string", - "description" : "The time period used for the timeout when communicating with the target." - }, - "yieldDuration" : { - "type" : "string", - "description" : "When yielding, this amount of time must elapse before the remote process group is scheduled again." - }, - "transportProtocol" : { - "type" : "string", - "description" : "The Transport Protocol that is used for Site-to-Site communications", - "enum" : [ "RAW", "HTTP" ] - }, - "localNetworkInterface" : { - "type" : "string", - "description" : "The local network interface to send/receive data. If not specified, any local address is used. If clustered, all nodes must have an interface with this identifier." - }, - "proxyHost" : { - "type" : "string" - }, - "proxyPort" : { - "type" : "integer", - "format" : "int32" - }, - "proxyUser" : { - "type" : "string" - }, - "inputPorts" : { - "type" : "array", - "description" : "A Set of Input Ports that can be connected to, in order to send data to the remote NiFi instance", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedRemoteGroupPort" - } - }, - "outputPorts" : { - "type" : "array", - "description" : "A Set of Output Ports that can be connected to, in order to pull data from the remote NiFi instance", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedRemoteGroupPort" - } - }, - "componentType" : { - "type" : "string", - "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE" ] - }, - "groupIdentifier" : { - "type" : "string", - "description" : "The ID of the Process Group that this component belongs to" - } - } - } - } -} diff --git a/resources/client_gen/api_defs/registry-0.5.0.json b/resources/client_gen/api_defs/registry-0.5.0.json deleted file mode 100644 index 0b5ea737..00000000 --- a/resources/client_gen/api_defs/registry-0.5.0.json +++ /dev/null @@ -1,6341 +0,0 @@ -{ - "swagger" : "2.0", - "info" : { - "description" : "The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components.", - "version" : "0.5.0", - "title" : "Apache NiFi Registry REST API", - "termsOfService" : "As described in the license", - "contact" : { - "name" : "Apache NiFi Registry", - "url" : "https://nifi.apache.org", - "email" : "dev@nifi.apache.org" - }, - "license" : { - "name" : "Apache 2.0 License", - "url" : "https://www.apache.org/licenses/LICENSE-2.0.html" - } - }, - "basePath" : "/nifi-registry-api", - "tags" : [ { - "name" : "access", - "description" : "Endpoints for obtaining an access token or checking access status." - }, { - "name" : "bucket bundles", - "description" : "Create extension bundles scoped to an existing bucket in the registry. " - }, { - "name" : "bucket flows", - "description" : "Create flows scoped to an existing bucket in the registry." - }, { - "name" : "buckets", - "description" : "Create named buckets in the registry to store NiFi objects such flows and extensions. Search for and retrieve existing buckets." - }, { - "name" : "bundles", - "description" : "Gets metadata about extension bundles and their versions. " - }, { - "name" : "config", - "description" : "Retrieves the configuration for this NiFi Registry." - }, { - "name" : "extension repository", - "description" : "Interact with extension bundles via the hierarchy of bucket/group/artifact/version. " - }, { - "name" : "extensions", - "description" : "Find and retrieve extensions. " - }, { - "name" : "flows", - "description" : "Gets metadata about flows." - }, { - "name" : "items", - "description" : "Retrieve items across all buckets for which the user is authorized." - }, { - "name" : "policies", - "description" : "Endpoint for managing access policies." - }, { - "name" : "tenants", - "description" : "Endpoint for managing users and user groups." - } ], - "schemes" : [ "http", "https" ], - "paths" : { - "/access" : { - "get" : { - "tags" : [ "access" ], - "summary" : "Get access status", - "description" : "Returns the current client's authenticated identity and permissions to top-level resources", - "operationId" : "getAccessStatus", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/CurrentUser" - } - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid. The NiFi Registry might be running unsecured." - } - }, - "security" : [ { - "Authorization" : [ ] - } ] - } - }, - "/access/token" : { - "post" : { - "tags" : [ "access" ], - "summary" : "Create token trying all providers", - "description" : "Creates a token for accessing the REST API via auto-detected method of verifying client identity claim credentials. The token returned is formatted as a JSON Web Token (JWT). The token is base64 encoded and comprised of three parts. The header, the body, and the signature. The expiration of the token is a contained within the body. The token can be used in the Authorization header in the format 'Authorization: Bearer '.", - "operationId" : "createAccessTokenByTryingAllProviders", - "consumes" : [ "*/*" ], - "produces" : [ "text/plain" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid. The NiFi Registry may not be configured to support login with username/password." - }, - "500" : { - "description" : "NiFi Registry was unable to complete the request because an unexpected error occurred." - } - } - } - }, - "/access/token/identity-provider" : { - "post" : { - "tags" : [ "access" ], - "summary" : "Create token using identity provider", - "description" : "Creates a token for accessing the REST API via a custom identity provider. The user credentials must be passed in a format understood by the custom identity provider, e.g., a third-party auth token in an HTTP header. The exact format of the user credentials expected by the custom identity provider can be discovered by 'GET /access/token/identity-provider/usage'. The token returned is formatted as a JSON Web Token (JWT). The token is base64 encoded and comprised of three parts. The header, the body, and the signature. The expiration of the token is a contained within the body. The token can be used in the Authorization header in the format 'Authorization: Bearer '.", - "operationId" : "createAccessTokenUsingIdentityProviderCredentials", - "consumes" : [ "*/*" ], - "produces" : [ "text/plain" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid. The NiFi Registry may not be configured to support login with customized credentials." - }, - "500" : { - "description" : "NiFi Registry was unable to complete the request because an unexpected error occurred." - } - } - } - }, - "/access/token/identity-provider/test" : { - "post" : { - "tags" : [ "access" ], - "summary" : "Test identity provider", - "description" : "Tests the format of the credentials against this identity provider without preforming authentication on the credentials to validate them. The user credentials should be passed in a format understood by the custom identity provider as defined by 'GET /access/token/identity-provider/usage'.", - "operationId" : "testIdentityProviderRecognizesCredentialsFormat", - "consumes" : [ "*/*" ], - "produces" : [ "text/plain" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "The format of the credentials were not recognized by the currently configured identity provider." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid. The NiFi Registry may not be configured to support login with customized credentials." - }, - "500" : { - "description" : "NiFi Registry was unable to complete the request because an unexpected error occurred." - } - } - } - }, - "/access/token/identity-provider/usage" : { - "get" : { - "tags" : [ "access" ], - "summary" : "Get identity provider usage", - "description" : "Provides a description of how the currently configured identity provider expects credentials to be passed to POST /access/token/identity-provider", - "operationId" : "getIdentityProviderUsageInstructions", - "consumes" : [ "*/*" ], - "produces" : [ "text/plain" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid. The NiFi Registry may not be configured to support login with customized credentials." - }, - "500" : { - "description" : "NiFi Registry was unable to complete the request because an unexpected error occurred." - } - } - } - }, - "/access/token/kerberos" : { - "post" : { - "tags" : [ "access" ], - "summary" : "Create token using kerberos", - "description" : "Creates a token for accessing the REST API via Kerberos Service Tickets or SPNEGO Tokens (which includes Kerberos Service Tickets). The token returned is formatted as a JSON Web Token (JWT). The token is base64 encoded and comprised of three parts. The header, the body, and the signature. The expiration of the token is a contained within the body. The token can be used in the Authorization header in the format 'Authorization: Bearer '.", - "operationId" : "createAccessTokenUsingKerberosTicket", - "consumes" : [ "*/*" ], - "produces" : [ "text/plain" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid. The NiFi Registry may not be configured to support login Kerberos credentials." - }, - "500" : { - "description" : "NiFi Registry was unable to complete the request because an unexpected error occurred." - } - } - } - }, - "/access/token/login" : { - "post" : { - "tags" : [ "access" ], - "summary" : "Create token using basic auth", - "description" : "Creates a token for accessing the REST API via username/password. The user credentials must be passed in standard HTTP Basic Auth format. That is: 'Authorization: Basic ', where is the base64 encoded value of ':'. The token returned is formatted as a JSON Web Token (JWT). The token is base64 encoded and comprised of three parts. The header, the body, and the signature. The expiration of the token is a contained within the body. The token can be used in the Authorization header in the format 'Authorization: Bearer '.", - "operationId" : "createAccessTokenUsingBasicAuthCredentials", - "consumes" : [ "*/*" ], - "produces" : [ "text/plain" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid. The NiFi Registry may not be configured to support login with username/password." - }, - "500" : { - "description" : "NiFi Registry was unable to complete the request because an unexpected error occurred." - } - }, - "security" : [ { - "BasicAuth" : [ ] - } ] - } - }, - "/buckets" : { - "get" : { - "tags" : [ "buckets" ], - "summary" : "Get all buckets", - "description" : "The returned list will include only buckets for which the user is authorized.If the user is not authorized for any buckets, this returns an empty list.", - "operationId" : "getBuckets", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/Bucket" - } - } - }, - "401" : { - "description" : "Client could not be authenticated." - } - }, - "security" : [ { - "Authorization" : [ ] - } ] - }, - "post" : { - "tags" : [ "buckets" ], - "summary" : "Create bucket", - "description" : "", - "operationId" : "createBucket", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The bucket to create", - "required" : true, - "schema" : { - "$ref" : "#/definitions/Bucket" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/Bucket" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets", - "action" : "write" - } - } - }, - "/buckets/fields" : { - "get" : { - "tags" : [ "buckets" ], - "summary" : "Get bucket fields", - "description" : "Retrieves bucket field names for searching or sorting on buckets.", - "operationId" : "getAvailableBucketFields", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/Fields" - } - } - }, - "security" : [ { - "Authorization" : [ ] - } ] - } - }, - "/buckets/{bucketId}" : { - "get" : { - "tags" : [ "buckets" ], - "summary" : "Get bucket", - "description" : "Gets the bucket with the given id.", - "operationId" : "getBucket", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketId", - "in" : "path", - "description" : "The bucket identifier", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/Bucket" - } - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - }, - "put" : { - "tags" : [ "buckets" ], - "summary" : "Update bucket", - "description" : "Updates the bucket with the given id.", - "operationId" : "updateBucket", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketId", - "in" : "path", - "description" : "The bucket identifier", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The updated bucket", - "required" : true, - "schema" : { - "$ref" : "#/definitions/Bucket" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/Bucket" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "write" - } - }, - "delete" : { - "tags" : [ "buckets" ], - "summary" : "Delete bucket", - "description" : "Deletes the bucket with the given id, along with all objects stored in the bucket", - "operationId" : "deleteBucket", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketId", - "in" : "path", - "description" : "The bucket identifier", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/Bucket" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "delete" - } - } - }, - "/buckets/{bucketId}/bundles" : { - "get" : { - "tags" : [ "bucket bundles" ], - "summary" : "Get extension bundles by bucket", - "description" : "\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getExtensionBundles", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketId", - "in" : "path", - "description" : "The bucket identifier", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/ExtensionBundle" - } - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/buckets/{bucketId}/bundles/{bundleType}" : { - "post" : { - "tags" : [ "bucket bundles" ], - "summary" : "Create extension bundle version", - "description" : "Creates a version of an extension bundle by uploading a binary artifact. If an extension bundle already exists in the given bucket with the same group id and artifact id as that of the bundle being uploaded, then it will be added as a new version to the existing bundle. If an extension bundle does not already exist in the given bucket with the same group id and artifact id, then a new extension bundle will be created and this version will be added to the new bundle. Client's may optionally supply a SHA-256 in hex format through the multi-part form field 'sha256'. If supplied, then this value will be compared against the SHA-256 computed by the server, and the bundle will be rejected if the values do not match. If not supplied, the bundle will be accepted, but will be marked to indicate that the client did not supply a SHA-256 during creation. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "createExtensionBundleVersion", - "consumes" : [ "multipart/form-data" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketId", - "in" : "path", - "description" : "The bucket identifier", - "required" : true, - "type" : "string" - }, { - "name" : "bundleType", - "in" : "path", - "description" : "The type of the bundle", - "required" : true, - "type" : "string", - "enum" : [ "nifi-nar", "minifi-cpp" ] - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/BundleVersion" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "write" - } - } - }, - "/buckets/{bucketId}/flows" : { - "get" : { - "tags" : [ "bucket flows" ], - "summary" : "Get bucket flows", - "description" : "Retrieves all flows in the given bucket.", - "operationId" : "getFlows", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketId", - "in" : "path", - "description" : "The bucket identifier", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/VersionedFlow" - } - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - }, - "post" : { - "tags" : [ "bucket flows" ], - "summary" : "Create flow", - "description" : "Creates a flow in the given bucket. The flow id is created by the server and populated in the returned entity.", - "operationId" : "createFlow", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketId", - "in" : "path", - "description" : "The bucket identifier", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The details of the flow to create.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/VersionedFlow" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlow" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "write" - } - } - }, - "/buckets/{bucketId}/flows/{flowId}" : { - "get" : { - "tags" : [ "bucket flows" ], - "summary" : "Get bucket flow", - "description" : "Retrieves the flow with the given id in the given bucket.", - "operationId" : "getFlow", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketId", - "in" : "path", - "description" : "The bucket identifier", - "required" : true, - "type" : "string" - }, { - "name" : "flowId", - "in" : "path", - "description" : "The flow identifier", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlow" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - }, - "put" : { - "tags" : [ "bucket flows" ], - "summary" : "Update bucket flow", - "description" : "Updates the flow with the given id in the given bucket.", - "operationId" : "updateFlow", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketId", - "in" : "path", - "description" : "The bucket identifier", - "required" : true, - "type" : "string" - }, { - "name" : "flowId", - "in" : "path", - "description" : "The flow identifier", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The updated flow", - "required" : true, - "schema" : { - "$ref" : "#/definitions/VersionedFlow" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlow" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "write" - } - }, - "delete" : { - "tags" : [ "bucket flows" ], - "summary" : "Delete bucket flow", - "description" : "Deletes a flow, including all saved versions of that flow.", - "operationId" : "deleteFlow", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketId", - "in" : "path", - "description" : "The bucket identifier", - "required" : true, - "type" : "string" - }, { - "name" : "flowId", - "in" : "path", - "description" : "The flow identifier", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlow" - } - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "delete" - } - } - }, - "/buckets/{bucketId}/flows/{flowId}/diff/{versionA}/{versionB}" : { - "get" : { - "tags" : [ "bucket flows" ], - "summary" : "Get bucket flow diff", - "description" : "Computes the differences between two given versions of a flow.", - "operationId" : "getFlowDiff", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketId", - "in" : "path", - "description" : "The bucket identifier", - "required" : true, - "type" : "string" - }, { - "name" : "flowId", - "in" : "path", - "description" : "The flow identifier", - "required" : true, - "type" : "string" - }, { - "name" : "versionA", - "in" : "path", - "description" : "The first version number", - "required" : true, - "type" : "integer", - "pattern" : "\\d+", - "format" : "int32" - }, { - "name" : "versionB", - "in" : "path", - "description" : "The second version number", - "required" : true, - "type" : "integer", - "pattern" : "\\d+", - "format" : "int32" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlowDifference" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/buckets/{bucketId}/flows/{flowId}/versions" : { - "get" : { - "tags" : [ "bucket flows" ], - "summary" : "Get bucket flow versions", - "description" : "Gets summary information for all versions of a flow. Versions are ordered newest->oldest.", - "operationId" : "getFlowVersions", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketId", - "in" : "path", - "description" : "The bucket identifier", - "required" : true, - "type" : "string" - }, { - "name" : "flowId", - "in" : "path", - "description" : "The flow identifier", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/VersionedFlowSnapshotMetadata" - } - } - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - }, - "post" : { - "tags" : [ "bucket flows" ], - "summary" : "Create flow version", - "description" : "Creates the next version of a flow. The version number of the object being created must be the next available version integer. Flow versions are immutable after they are created.", - "operationId" : "createFlowVersion", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketId", - "in" : "path", - "description" : "The bucket identifier", - "required" : true, - "type" : "string" - }, { - "name" : "flowId", - "in" : "path", - "description" : "The flow identifier", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The new versioned flow snapshot.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/VersionedFlowSnapshot" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlowSnapshot" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "write" - } - } - }, - "/buckets/{bucketId}/flows/{flowId}/versions/latest" : { - "get" : { - "tags" : [ "bucket flows" ], - "summary" : "Get latest bucket flow version content", - "description" : "Gets the latest version of a flow, including the metadata and content of the flow.", - "operationId" : "getLatestFlowVersion", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketId", - "in" : "path", - "description" : "The bucket identifier", - "required" : true, - "type" : "string" - }, { - "name" : "flowId", - "in" : "path", - "description" : "The flow identifier", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlowSnapshot" - } - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/buckets/{bucketId}/flows/{flowId}/versions/latest/metadata" : { - "get" : { - "tags" : [ "bucket flows" ], - "summary" : "Get latest bucket flow version metadata", - "description" : "Gets the metadata for the latest version of a flow.", - "operationId" : "getLatestFlowVersionMetadata", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketId", - "in" : "path", - "description" : "The bucket identifier", - "required" : true, - "type" : "string" - }, { - "name" : "flowId", - "in" : "path", - "description" : "The flow identifier", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlowSnapshotMetadata" - } - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/buckets/{bucketId}/flows/{flowId}/versions/{versionNumber}" : { - "get" : { - "tags" : [ "bucket flows" ], - "summary" : "Get bucket flow version", - "description" : "Gets the given version of a flow, including the metadata and content for the version.", - "operationId" : "getFlowVersion", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketId", - "in" : "path", - "description" : "The bucket identifier", - "required" : true, - "type" : "string" - }, { - "name" : "flowId", - "in" : "path", - "description" : "The flow identifier", - "required" : true, - "type" : "string" - }, { - "name" : "versionNumber", - "in" : "path", - "description" : "The version number", - "required" : true, - "type" : "integer", - "pattern" : "\\d+", - "format" : "int32" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlowSnapshot" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/bundles" : { - "get" : { - "tags" : [ "bundles" ], - "summary" : "Get all bundles", - "description" : "Gets the metadata for all bundles across all authorized buckets with optional filters applied. The returned results will include only items from buckets for which the user is authorized. If the user is not authorized to any buckets, an empty list will be returned. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getBundles", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketName", - "in" : "query", - "description" : "Optional bucket name to filter results. The value may be an exact match, or a wildcard, such as 'My Bucket%' to select all bundles where the bucket name starts with 'My Bucket'.", - "required" : false, - "type" : "string" - }, { - "name" : "groupId", - "in" : "query", - "description" : "Optional groupId to filter results. The value may be an exact match, or a wildcard, such as 'com.%' to select all bundles where the groupId starts with 'com.'.", - "required" : false, - "type" : "string" - }, { - "name" : "artifactId", - "in" : "query", - "description" : "Optional artifactId to filter results. The value may be an exact match, or a wildcard, such as 'nifi-%' to select all bundles where the artifactId starts with 'nifi-'.", - "required" : false, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/ExtensionBundle" - } - } - }, - "401" : { - "description" : "Client could not be authenticated." - } - }, - "security" : [ { - "Authorization" : [ ] - } ] - } - }, - "/bundles/versions" : { - "get" : { - "tags" : [ "bundles" ], - "summary" : "Get all bundle versions", - "description" : "Gets the metadata about extension bundle versions across all authorized buckets with optional filters applied. If the user is not authorized to any buckets, an empty list will be returned. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getBundleVersions", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "groupId", - "in" : "query", - "description" : "Optional groupId to filter results. The value may be an exact match, or a wildcard, such as 'com.%' to select all bundle versions where the groupId starts with 'com.'.", - "required" : false, - "type" : "string" - }, { - "name" : "artifactId", - "in" : "query", - "description" : "Optional artifactId to filter results. The value may be an exact match, or a wildcard, such as 'nifi-%' to select all bundle versions where the artifactId starts with 'nifi-'.", - "required" : false, - "type" : "string" - }, { - "name" : "version", - "in" : "query", - "description" : "Optional version to filter results. The value maye be an exact match, or a wildcard, such as '1.0.%' to select all bundle versions where the version starts with '1.0.'.", - "required" : false, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/BundleVersionMetadata" - } - } - }, - "401" : { - "description" : "Client could not be authenticated." - } - }, - "security" : [ { - "Authorization" : [ ] - } ] - } - }, - "/bundles/{bundleId}" : { - "get" : { - "tags" : [ "bundles" ], - "summary" : "Get bundle", - "description" : "Gets the metadata about an extension bundle. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "globalGetExtensionBundle", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bundleId", - "in" : "path", - "description" : "The extension bundle identifier", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ExtensionBundle" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - }, - "delete" : { - "tags" : [ "bundles" ], - "summary" : "Delete bundle", - "description" : "Deletes the given extension bundle and all of it's versions. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "globalDeleteExtensionBundle", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bundleId", - "in" : "path", - "description" : "The extension bundle identifier", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ExtensionBundle" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "write" - } - } - }, - "/bundles/{bundleId}/versions" : { - "get" : { - "tags" : [ "bundles" ], - "summary" : "Get bundle versions", - "description" : "Gets the metadata for the versions of the given extension bundle. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "globalGetBundleVersions", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bundleId", - "in" : "path", - "description" : "The extension bundle identifier", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/BundleVersionMetadata" - } - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/bundles/{bundleId}/versions/{version}" : { - "get" : { - "tags" : [ "bundles" ], - "summary" : "Get bundle version", - "description" : "Gets the descriptor for the given version of the given extension bundle. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "globalGetBundleVersion", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bundleId", - "in" : "path", - "description" : "The extension bundle identifier", - "required" : true, - "type" : "string" - }, { - "name" : "version", - "in" : "path", - "description" : "The version of the bundle", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/BundleVersion" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - }, - "delete" : { - "tags" : [ "bundles" ], - "summary" : "Delete bundle version", - "description" : "Deletes the given extension bundle version and it's associated binary content. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "globalDeleteBundleVersion", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bundleId", - "in" : "path", - "description" : "The extension bundle identifier", - "required" : true, - "type" : "string" - }, { - "name" : "version", - "in" : "path", - "description" : "The version of the bundle", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/BundleVersion" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "write" - } - } - }, - "/bundles/{bundleId}/versions/{version}/content" : { - "get" : { - "tags" : [ "bundles" ], - "summary" : "Get bundle version content", - "description" : "Gets the binary content for the given version of the given extension bundle. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "globalGetBundleVersionContent", - "consumes" : [ "*/*" ], - "produces" : [ "application/octet-stream" ], - "parameters" : [ { - "name" : "bundleId", - "in" : "path", - "description" : "The extension bundle identifier", - "required" : true, - "type" : "string" - }, { - "name" : "version", - "in" : "path", - "description" : "The version of the bundle", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "type" : "string", - "format" : "byte" - } - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/bundles/{bundleId}/versions/{version}/extensions" : { - "get" : { - "tags" : [ "bundles" ], - "summary" : "Get bundle version extensions", - "description" : "Gets the metadata about the extensions in the given extension bundle version. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "globalGetBundleVersionExtensions", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bundleId", - "in" : "path", - "description" : "The extension bundle identifier", - "required" : true, - "type" : "string" - }, { - "name" : "version", - "in" : "path", - "description" : "The version of the bundle", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/ExtensionMetadata" - } - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/bundles/{bundleId}/versions/{version}/extensions/{name}" : { - "get" : { - "tags" : [ "bundles" ], - "summary" : "Get bundle version extension", - "description" : "Gets the metadata about the extension with the given name in the given extension bundle version. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "globalGetBundleVersionExtension", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bundleId", - "in" : "path", - "description" : "The extension bundle identifier", - "required" : true, - "type" : "string" - }, { - "name" : "version", - "in" : "path", - "description" : "The version of the bundle", - "required" : true, - "type" : "string" - }, { - "name" : "name", - "in" : "path", - "description" : "The fully qualified name of the extension", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/Extension" - } - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/bundles/{bundleId}/versions/{version}/extensions/{name}/docs" : { - "get" : { - "tags" : [ "bundles" ], - "summary" : "Get bundle version extension docs", - "description" : "Gets the documentation for the given extension in the given extension bundle version. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getBundleVersionExtensionDocs", - "consumes" : [ "*/*" ], - "produces" : [ "text/html" ], - "parameters" : [ { - "name" : "bundleId", - "in" : "path", - "description" : "The extension bundle identifier", - "required" : true, - "type" : "string" - }, { - "name" : "version", - "in" : "path", - "description" : "The version of the bundle", - "required" : true, - "type" : "string" - }, { - "name" : "name", - "in" : "path", - "description" : "The fully qualified name of the extension", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/bundles/{bundleId}/versions/{version}/extensions/{name}/docs/additional-details" : { - "get" : { - "tags" : [ "bundles" ], - "summary" : "Get bundle version extension docs details", - "description" : "Gets the additional details documentation for the given extension in the given extension bundle version. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getBundleVersionExtensionAdditionalDetailsDocs", - "consumes" : [ "*/*" ], - "produces" : [ "text/html" ], - "parameters" : [ { - "name" : "bundleId", - "in" : "path", - "description" : "The extension bundle identifier", - "required" : true, - "type" : "string" - }, { - "name" : "version", - "in" : "path", - "description" : "The version of the bundle", - "required" : true, - "type" : "string" - }, { - "name" : "name", - "in" : "path", - "description" : "The fully qualified name of the extension", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/config" : { - "get" : { - "tags" : [ "config" ], - "summary" : "Get configration", - "description" : "Gets the NiFi Registry configurations.", - "operationId" : "getConfiguration", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/RegistryConfiguration" - } - }, - "401" : { - "description" : "Client could not be authenticated." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/policies,/tenants", - "action" : "read" - } - } - }, - "/extension-repository" : { - "get" : { - "tags" : [ "extension repository" ], - "summary" : "Get extension repo buckets", - "description" : "Gets the names of the buckets the current user is authorized for in order to browse the repo by bucket. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getExtensionRepoBuckets", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/ExtensionRepoBucket" - } - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ] - } - }, - "/extension-repository/{bucketName}" : { - "get" : { - "tags" : [ "extension repository" ], - "summary" : "Get extension repo groups", - "description" : "Gets the groups in the extension repository in the given bucket. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getExtensionRepoGroups", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketName", - "in" : "path", - "description" : "The bucket name", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/ExtensionRepoGroup" - } - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/extension-repository/{bucketName}/{groupId}" : { - "get" : { - "tags" : [ "extension repository" ], - "summary" : "Get extension repo artifacts", - "description" : "Gets the artifacts in the extension repository in the given bucket and group. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getExtensionRepoArtifacts", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketName", - "in" : "path", - "description" : "The bucket name", - "required" : true, - "type" : "string" - }, { - "name" : "groupId", - "in" : "path", - "description" : "The group id", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/ExtensionRepoArtifact" - } - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/extension-repository/{bucketName}/{groupId}/{artifactId}" : { - "get" : { - "tags" : [ "extension repository" ], - "summary" : "Get extension repo versions", - "description" : "Gets the versions in the extension repository for the given bucket, group, and artifact. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getExtensionRepoVersions", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketName", - "in" : "path", - "description" : "The bucket name", - "required" : true, - "type" : "string" - }, { - "name" : "groupId", - "in" : "path", - "description" : "The group identifier", - "required" : true, - "type" : "string" - }, { - "name" : "artifactId", - "in" : "path", - "description" : "The artifact identifier", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/ExtensionRepoVersionSummary" - } - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/extension-repository/{bucketName}/{groupId}/{artifactId}/{version}" : { - "get" : { - "tags" : [ "extension repository" ], - "summary" : "Get extension repo version", - "description" : "Gets information about the version in the given bucket, group, and artifact. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getExtensionRepoVersion", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketName", - "in" : "path", - "description" : "The bucket name", - "required" : true, - "type" : "string" - }, { - "name" : "groupId", - "in" : "path", - "description" : "The group identifier", - "required" : true, - "type" : "string" - }, { - "name" : "artifactId", - "in" : "path", - "description" : "The artifact identifier", - "required" : true, - "type" : "string" - }, { - "name" : "version", - "in" : "path", - "description" : "The version", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ExtensionRepoVersion" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/extension-repository/{bucketName}/{groupId}/{artifactId}/{version}/content" : { - "get" : { - "tags" : [ "extension repository" ], - "summary" : "Get extension repo version content", - "description" : "Gets the binary content of the bundle with the given bucket, group, artifact, and version. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getExtensionRepoVersionContent", - "consumes" : [ "*/*" ], - "produces" : [ "application/octet-stream" ], - "parameters" : [ { - "name" : "bucketName", - "in" : "path", - "description" : "The bucket name", - "required" : true, - "type" : "string" - }, { - "name" : "groupId", - "in" : "path", - "description" : "The group identifier", - "required" : true, - "type" : "string" - }, { - "name" : "artifactId", - "in" : "path", - "description" : "The artifact identifier", - "required" : true, - "type" : "string" - }, { - "name" : "version", - "in" : "path", - "description" : "The version", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "type" : "string", - "format" : "byte" - } - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/extension-repository/{bucketName}/{groupId}/{artifactId}/{version}/extensions" : { - "get" : { - "tags" : [ "extension repository" ], - "summary" : "Get extension repo extensions", - "description" : "Gets information about the extensions in the given bucket, group, artifact, and version. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getExtensionRepoVersionExtensions", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketName", - "in" : "path", - "description" : "The bucket name", - "required" : true, - "type" : "string" - }, { - "name" : "groupId", - "in" : "path", - "description" : "The group identifier", - "required" : true, - "type" : "string" - }, { - "name" : "artifactId", - "in" : "path", - "description" : "The artifact identifier", - "required" : true, - "type" : "string" - }, { - "name" : "version", - "in" : "path", - "description" : "The version", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/ExtensionMetadata" - } - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/extension-repository/{bucketName}/{groupId}/{artifactId}/{version}/extensions/{name}" : { - "get" : { - "tags" : [ "extension repository" ], - "summary" : "Get extension repo extension", - "description" : "Gets information about the extension with the given name in the given bucket, group, artifact, and version. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getExtensionRepoVersionExtension", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketName", - "in" : "path", - "description" : "The bucket name", - "required" : true, - "type" : "string" - }, { - "name" : "groupId", - "in" : "path", - "description" : "The group identifier", - "required" : true, - "type" : "string" - }, { - "name" : "artifactId", - "in" : "path", - "description" : "The artifact identifier", - "required" : true, - "type" : "string" - }, { - "name" : "version", - "in" : "path", - "description" : "The version", - "required" : true, - "type" : "string" - }, { - "name" : "name", - "in" : "path", - "description" : "The fully qualified name of the extension", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/Extension" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/extension-repository/{bucketName}/{groupId}/{artifactId}/{version}/extensions/{name}/docs" : { - "get" : { - "tags" : [ "extension repository" ], - "summary" : "Get extension repo extension docs", - "description" : "Gets the documentation for the extension with the given name in the given bucket, group, artifact, and version. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getExtensionRepoVersionExtensionDocs", - "consumes" : [ "*/*" ], - "produces" : [ "text/html" ], - "parameters" : [ { - "name" : "bucketName", - "in" : "path", - "description" : "The bucket name", - "required" : true, - "type" : "string" - }, { - "name" : "groupId", - "in" : "path", - "description" : "The group identifier", - "required" : true, - "type" : "string" - }, { - "name" : "artifactId", - "in" : "path", - "description" : "The artifact identifier", - "required" : true, - "type" : "string" - }, { - "name" : "version", - "in" : "path", - "description" : "The version", - "required" : true, - "type" : "string" - }, { - "name" : "name", - "in" : "path", - "description" : "The fully qualified name of the extension", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/extension-repository/{bucketName}/{groupId}/{artifactId}/{version}/extensions/{name}/docs/additional-details" : { - "get" : { - "tags" : [ "extension repository" ], - "summary" : "Get extension repo extension details", - "description" : "Gets the additional details documentation for the extension with the given name in the given bucket, group, artifact, and version. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getExtensionRepoVersionExtensionAdditionalDetailsDocs", - "consumes" : [ "*/*" ], - "produces" : [ "text/html" ], - "parameters" : [ { - "name" : "bucketName", - "in" : "path", - "description" : "The bucket name", - "required" : true, - "type" : "string" - }, { - "name" : "groupId", - "in" : "path", - "description" : "The group identifier", - "required" : true, - "type" : "string" - }, { - "name" : "artifactId", - "in" : "path", - "description" : "The artifact identifier", - "required" : true, - "type" : "string" - }, { - "name" : "version", - "in" : "path", - "description" : "The version", - "required" : true, - "type" : "string" - }, { - "name" : "name", - "in" : "path", - "description" : "The fully qualified name of the extension", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/extension-repository/{bucketName}/{groupId}/{artifactId}/{version}/sha256" : { - "get" : { - "tags" : [ "extension repository" ], - "summary" : "Get extension repo version checksum", - "description" : "Gets the hex representation of the SHA-256 digest for the binary content of the bundle with the given bucket, group, artifact, and version.\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getExtensionRepoVersionSha256", - "consumes" : [ "*/*" ], - "produces" : [ "text/plain" ], - "parameters" : [ { - "name" : "bucketName", - "in" : "path", - "description" : "The bucket name", - "required" : true, - "type" : "string" - }, { - "name" : "groupId", - "in" : "path", - "description" : "The group identifier", - "required" : true, - "type" : "string" - }, { - "name" : "artifactId", - "in" : "path", - "description" : "The artifact identifier", - "required" : true, - "type" : "string" - }, { - "name" : "version", - "in" : "path", - "description" : "The version", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/extension-repository/{groupId}/{artifactId}/{version}/sha256" : { - "get" : { - "tags" : [ "extension repository" ], - "summary" : "Get global extension repo version checksum", - "description" : "Gets the hex representation of the SHA-256 digest for the binary content with the given bucket, group, artifact, and version. Since the same group-artifact-version can exist in multiple buckets, this will return the checksum of the first one returned. This will be consistent since the checksum must be the same when existing in multiple buckets. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getGlobalExtensionRepoVersionSha256", - "consumes" : [ "*/*" ], - "produces" : [ "text/plain" ], - "parameters" : [ { - "name" : "groupId", - "in" : "path", - "description" : "The group identifier", - "required" : true, - "type" : "string" - }, { - "name" : "artifactId", - "in" : "path", - "description" : "The artifact identifier", - "required" : true, - "type" : "string" - }, { - "name" : "version", - "in" : "path", - "description" : "The version", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ] - } - }, - "/extensions" : { - "get" : { - "tags" : [ "extensions" ], - "summary" : "Get all extensions", - "description" : "Gets the metadata for all extensions that match the filter params and are part of bundles located in buckets the current user is authorized for. If the user is not authorized to any buckets, an empty result set will be returned.\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getExtensions", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bundleType", - "in" : "query", - "description" : "The type of bundles to return", - "required" : false, - "type" : "string", - "enum" : [ "nifi-nar", "minifi-cpp" ] - }, { - "name" : "extensionType", - "in" : "query", - "description" : "The type of extensions to return", - "required" : false, - "type" : "string", - "enum" : [ "PROCESSOR", "CONTROLLER_SERVICE", "REPORTING_TASK" ] - }, { - "name" : "tag", - "in" : "query", - "description" : "The tags to filter on, will be used in an OR statement", - "required" : false, - "type" : "array", - "items" : { - "type" : "string" - }, - "collectionFormat" : "multi" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ExtensionMetadataContainer" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ] - } - }, - "/extensions/provided-service-api" : { - "get" : { - "tags" : [ "extensions" ], - "summary" : "Get extensions providing service API", - "description" : "Gets the metadata for extensions that provide the specified API and are part of bundles located in buckets the current user is authorized for. If the user is not authorized to any buckets, an empty result set will be returned.\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getExtensionsProvidingServiceAPI", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "className", - "in" : "query", - "description" : "The name of the service API class", - "required" : true, - "type" : "string" - }, { - "name" : "groupId", - "in" : "query", - "description" : "The groupId of the bundle containing the service API class", - "required" : true, - "type" : "string" - }, { - "name" : "artifactId", - "in" : "query", - "description" : "The artifactId of the bundle containing the service API class", - "required" : true, - "type" : "string" - }, { - "name" : "version", - "in" : "query", - "description" : "The version of the bundle containing the service API class", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ExtensionMetadataContainer" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ] - } - }, - "/extensions/tags" : { - "get" : { - "tags" : [ "extensions" ], - "summary" : "Get extension tags", - "description" : "Gets all the extension tags known to this NiFi Registry instance, along with the number of extensions that have the given tag.\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getTags", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/TagCount" - } - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ] - } - }, - "/flows/fields" : { - "get" : { - "tags" : [ "flows" ], - "summary" : "Get flow fields", - "description" : "Retrieves the flow field names that can be used for searching or sorting on flows.", - "operationId" : "getAvailableFlowFields", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/Fields" - } - } - }, - "security" : [ { - "Authorization" : [ ] - } ] - } - }, - "/flows/{flowId}" : { - "get" : { - "tags" : [ "flows" ], - "summary" : "Get flow", - "description" : "Gets a flow by id.", - "operationId" : "globalGetFlow", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "flowId", - "in" : "path", - "description" : "The flow identifier", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlow" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/flows/{flowId}/versions" : { - "get" : { - "tags" : [ "flows" ], - "summary" : "Get flow versions", - "description" : "Gets summary information for all versions of a given flow. Versions are ordered newest->oldest.", - "operationId" : "globalGetFlowVersions", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "flowId", - "in" : "path", - "description" : "The flow identifier", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/VersionedFlowSnapshotMetadata" - } - } - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/flows/{flowId}/versions/latest" : { - "get" : { - "tags" : [ "flows" ], - "summary" : "Get latest flow version", - "description" : "Gets the latest version of a flow, including metadata and flow content.", - "operationId" : "globalGetLatestFlowVersion", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "flowId", - "in" : "path", - "description" : "The flow identifier", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlowSnapshot" - } - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/flows/{flowId}/versions/latest/metadata" : { - "get" : { - "tags" : [ "flows" ], - "summary" : "Get latest flow version metadata", - "description" : "Gets the metadata for the latest version of a flow.", - "operationId" : "globalGetLatestFlowVersionMetadata", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "flowId", - "in" : "path", - "description" : "The flow identifier", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlowSnapshotMetadata" - } - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/flows/{flowId}/versions/{versionNumber}" : { - "get" : { - "tags" : [ "flows" ], - "summary" : "Get flow version", - "description" : "Gets the given version of a flow, including metadata and flow content.", - "operationId" : "globalGetFlowVersion", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "flowId", - "in" : "path", - "description" : "The flow identifier", - "required" : true, - "type" : "string" - }, { - "name" : "versionNumber", - "in" : "path", - "description" : "The version number", - "required" : true, - "type" : "integer", - "pattern" : "\\d+", - "format" : "int32" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlowSnapshot" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/items" : { - "get" : { - "tags" : [ "items" ], - "summary" : "Get all items", - "description" : "Get items across all buckets. The returned items will include only items from buckets for which the user is authorized. If the user is not authorized to any buckets, an empty list will be returned.", - "operationId" : "getItems", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/BucketItem" - } - } - }, - "401" : { - "description" : "Client could not be authenticated." - } - }, - "security" : [ { - "Authorization" : [ ] - } ] - } - }, - "/items/fields" : { - "get" : { - "tags" : [ "items" ], - "summary" : "Get item fields", - "description" : "Retrieves the item field names for searching or sorting on bucket items.", - "operationId" : "getAvailableBucketItemFields", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/Fields" - } - } - }, - "security" : [ { - "Authorization" : [ ] - } ] - } - }, - "/items/{bucketId}" : { - "get" : { - "tags" : [ "items" ], - "summary" : "Get bucket items", - "description" : "Gets the items located in the given bucket.", - "operationId" : "getItemsInBucket", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketId", - "in" : "path", - "description" : "The bucket identifier", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/BucketItem" - } - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/policies" : { - "get" : { - "tags" : [ "policies" ], - "summary" : "Get all access policies", - "description" : "", - "operationId" : "getAccessPolicies", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/AccessPolicy" - } - } - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/policies", - "action" : "read" - } - }, - "post" : { - "tags" : [ "policies" ], - "summary" : "Create access policy", - "description" : "", - "operationId" : "createAccessPolicy", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The access policy configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/AccessPolicy" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/AccessPolicy" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid. The NiFi Registry might not be configured to use a ConfigurableAccessPolicyProvider." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/policies", - "action" : "write" - } - } - }, - "/policies/resources" : { - "get" : { - "tags" : [ "policies" ], - "summary" : "Get available resources", - "description" : "Gets the available resources that support access/authorization policies", - "operationId" : "getResources", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/Resource" - } - } - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/policies", - "action" : "read" - } - } - }, - "/policies/{action}/{resource}" : { - "get" : { - "tags" : [ "policies" ], - "summary" : "Get access policy for resource", - "description" : "Gets an access policy for the specified action and resource", - "operationId" : "getAccessPolicyForResource", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "action", - "in" : "path", - "description" : "The request action.", - "required" : true, - "type" : "string", - "enum" : [ "read", "write", "delete" ] - }, { - "name" : "resource", - "in" : "path", - "description" : "The resource of the policy.", - "required" : true, - "type" : "string", - "pattern" : ".+" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/AccessPolicy" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/policies", - "action" : "read" - } - } - }, - "/policies/{id}" : { - "get" : { - "tags" : [ "policies" ], - "summary" : "Get access policy", - "description" : "", - "operationId" : "getAccessPolicy", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The access policy id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/AccessPolicy" - } - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/policies", - "action" : "read" - } - }, - "put" : { - "tags" : [ "policies" ], - "summary" : "Update access policy", - "description" : "", - "operationId" : "updateAccessPolicy", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The access policy id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The access policy configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/AccessPolicy" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/AccessPolicy" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid. The NiFi Registry might not be configured to use a ConfigurableAccessPolicyProvider." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/policies", - "action" : "write" - } - }, - "delete" : { - "tags" : [ "policies" ], - "summary" : "Delete access policy", - "description" : "", - "operationId" : "removeAccessPolicy", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The access policy id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/AccessPolicy" - } - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid. The NiFi Registry might not be configured to use a ConfigurableAccessPolicyProvider." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/policies", - "action" : "delete" - } - } - }, - "/tenants/user-groups" : { - "get" : { - "tags" : [ "tenants" ], - "summary" : "Get user groups", - "description" : "\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getUserGroups", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/UserGroup" - } - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/tenants", - "action" : "read" - } - }, - "post" : { - "tags" : [ "tenants" ], - "summary" : "Create user group", - "description" : "\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "createUserGroup", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The user group configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/UserGroup" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/UserGroup" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/tenants", - "action" : "write" - } - } - }, - "/tenants/user-groups/{id}" : { - "get" : { - "tags" : [ "tenants" ], - "summary" : "Get user group", - "description" : "\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getUserGroup", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The user group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/UserGroup" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/tenants", - "action" : "read" - } - }, - "put" : { - "tags" : [ "tenants" ], - "summary" : "Update user group", - "description" : "\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "updateUserGroup", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The user group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The user group configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/UserGroup" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/UserGroup" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/tenants", - "action" : "write" - } - }, - "delete" : { - "tags" : [ "tenants" ], - "summary" : "Delete user group", - "description" : "\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "removeUserGroup", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The user group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/UserGroup" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/tenants", - "action" : "delete" - } - } - }, - "/tenants/users" : { - "get" : { - "tags" : [ "tenants" ], - "summary" : "Get all users", - "description" : "\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getUsers", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/User" - } - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/tenants", - "action" : "read" - } - }, - "post" : { - "tags" : [ "tenants" ], - "summary" : "Create user", - "description" : "\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "createUser", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The user configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/User" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/User" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/tenants", - "action" : "write" - } - } - }, - "/tenants/users/{id}" : { - "get" : { - "tags" : [ "tenants" ], - "summary" : "Get user", - "description" : "\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getUser", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The user id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/User" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/tenants", - "action" : "read" - } - }, - "put" : { - "tags" : [ "tenants" ], - "summary" : "Update user", - "description" : "\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "updateUser", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The user id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The user configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/User" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/User" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/tenants", - "action" : "write" - } - }, - "delete" : { - "tags" : [ "tenants" ], - "summary" : "Delete user", - "description" : "\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "removeUser", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The user id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/User" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/tenants", - "action" : "delete" - } - } - } - }, - "securityDefinitions" : { - "Authorization" : { - "description" : "NiFi Registry Auth Token (JWT)", - "type" : "apiKey", - "name" : "Authorization", - "in" : "header" - }, - "BasicAuth" : { - "description" : "HTTP Basic Auth", - "type" : "basic" - } - }, - "definitions" : { - "AccessPolicy" : { - "type" : "object", - "required" : [ "action", "resource" ], - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The id of the policy. Set by server at creation time.", - "readOnly" : true - }, - "resource" : { - "type" : "string", - "description" : "The resource for this access policy." - }, - "action" : { - "type" : "string", - "description" : "The action associated with this access policy.", - "enum" : [ "read", "write", "delete" ] - }, - "configurable" : { - "type" : "boolean", - "description" : "Indicates if this access policy is configurable, based on which Authorizer has been configured to manage it.", - "readOnly" : true - }, - "users" : { - "type" : "array", - "description" : "The set of user IDs associated with this access policy.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/Tenant" - } - }, - "userGroups" : { - "type" : "array", - "description" : "The set of user group IDs associated with this access policy.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/Tenant" - } - } - } - }, - "AccessPolicySummary" : { - "type" : "object", - "required" : [ "action", "resource" ], - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The id of the policy. Set by server at creation time.", - "readOnly" : true - }, - "resource" : { - "type" : "string", - "description" : "The resource for this access policy." - }, - "action" : { - "type" : "string", - "description" : "The action associated with this access policy.", - "enum" : [ "read", "write", "delete" ] - }, - "configurable" : { - "type" : "boolean", - "description" : "Indicates if this access policy is configurable, based on which Authorizer has been configured to manage it.", - "readOnly" : true - } - } - }, - "AllowableValue" : { - "type" : "object", - "properties" : { - "value" : { - "type" : "string", - "description" : "The value of the allowable value" - }, - "displayName" : { - "type" : "string", - "description" : "The display name of the allowable value" - }, - "description" : { - "type" : "string", - "description" : "The description of the allowable value" - } - } - }, - "Attribute" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The name of the attribute" - }, - "description" : { - "type" : "string", - "description" : "The description of the attribute" - } - } - }, - "BatchSize" : { - "type" : "object", - "properties" : { - "count" : { - "type" : "integer", - "format" : "int32", - "description" : "Preferred number of flow files to include in a transaction." - }, - "size" : { - "type" : "string", - "description" : "Preferred number of bytes to include in a transaction." - }, - "duration" : { - "type" : "string", - "description" : "Preferred amount of time that a transaction should span." - } - } - }, - "Bucket" : { - "type" : "object", - "required" : [ "name" ], - "properties" : { - "link" : { - "description" : "An WebLink to this entity.", - "readOnly" : true, - "$ref" : "#/definitions/JaxbLink" - }, - "identifier" : { - "type" : "string", - "description" : "An ID to uniquely identify this object.", - "readOnly" : true - }, - "name" : { - "type" : "string", - "description" : "The name of the bucket." - }, - "createdTimestamp" : { - "type" : "integer", - "format" : "int64", - "description" : "The timestamp of when the bucket was first created. This is set by the server at creation time.", - "readOnly" : true, - "minimum" : 1 - }, - "description" : { - "type" : "string", - "description" : "A description of the bucket." - }, - "allowBundleRedeploy" : { - "type" : "boolean", - "description" : "Indicates if this bucket allows the same version of an extension bundle to be redeployed and thus overwrite the existing artifact. By default this is false." - }, - "allowPublicRead" : { - "type" : "boolean", - "description" : "Indicates if this bucket allows read access to unauthenticated anonymous users" - }, - "permissions" : { - "description" : "The access that the current user has to this bucket.", - "readOnly" : true, - "$ref" : "#/definitions/Permissions" - } - } - }, - "BucketItem" : { - "type" : "object", - "required" : [ "bucketIdentifier", "name", "type" ], - "properties" : { - "link" : { - "description" : "An WebLink to this entity.", - "readOnly" : true, - "$ref" : "#/definitions/JaxbLink" - }, - "identifier" : { - "type" : "string", - "description" : "An ID to uniquely identify this object.", - "readOnly" : true - }, - "name" : { - "type" : "string", - "description" : "The name of the item." - }, - "description" : { - "type" : "string", - "description" : "A description of the item." - }, - "bucketIdentifier" : { - "type" : "string", - "description" : "The identifier of the bucket this items belongs to. This cannot be changed after the item is created." - }, - "bucketName" : { - "type" : "string", - "description" : "The name of the bucket this items belongs to.", - "readOnly" : true - }, - "createdTimestamp" : { - "type" : "integer", - "format" : "int64", - "description" : "The timestamp of when the item was created, as milliseconds since epoch.", - "readOnly" : true, - "minimum" : 1 - }, - "modifiedTimestamp" : { - "type" : "integer", - "format" : "int64", - "description" : "The timestamp of when the item was last modified, as milliseconds since epoch.", - "readOnly" : true, - "minimum" : 1 - }, - "type" : { - "type" : "string", - "description" : "The type of item.", - "enum" : [ "Flow", "Bundle" ] - }, - "permissions" : { - "description" : "The access that the current user has to the bucket containing this item.", - "readOnly" : true, - "$ref" : "#/definitions/Permissions" - } - } - }, - "BuildInfo" : { - "type" : "object", - "properties" : { - "buildTool" : { - "type" : "string", - "description" : "The tool used to build the version of the bundle" - }, - "buildFlags" : { - "type" : "string", - "description" : "The flags used to build the version of the bundle" - }, - "buildBranch" : { - "type" : "string", - "description" : "The branch used to build the version of the bundle" - }, - "buildTag" : { - "type" : "string", - "description" : "The tag used to build the version of the bundle" - }, - "buildRevision" : { - "type" : "string", - "description" : "The revision used to build the version of the bundle" - }, - "built" : { - "type" : "integer", - "format" : "int64", - "description" : "The timestamp the version of the bundle was built" - }, - "builtBy" : { - "type" : "string", - "description" : "The identity of the user that performed the build" - } - } - }, - "Bundle" : { - "type" : "object", - "properties" : { - "group" : { - "type" : "string", - "description" : "The group of the bundle" - }, - "artifact" : { - "type" : "string", - "description" : "The artifact of the bundle" - }, - "version" : { - "type" : "string", - "description" : "The version of the bundle" - } - } - }, - "BundleInfo" : { - "type" : "object", - "properties" : { - "bucketId" : { - "type" : "string", - "description" : "The id of the bucket where the bundle is located" - }, - "bucketName" : { - "type" : "string", - "description" : "The name of the bucket where the bundle is located" - }, - "bundleId" : { - "type" : "string", - "description" : "The id of the bundle" - }, - "bundleType" : { - "type" : "string", - "description" : "The type of bundle (i.e. a NiFi NAR vs MiNiFi CPP)", - "enum" : [ "NIFI_NAR", "MINIFI_CPP" ] - }, - "groupId" : { - "type" : "string", - "description" : "The group id of the bundle" - }, - "artifactId" : { - "type" : "string", - "description" : "The artifact id of the bundle" - }, - "version" : { - "type" : "string", - "description" : "The version of the bundle" - }, - "systemApiVersion" : { - "type" : "string", - "description" : "The version of the system API the bundle was built against" - } - } - }, - "BundleVersion" : { - "type" : "object", - "required" : [ "versionMetadata" ], - "properties" : { - "link" : { - "description" : "An WebLink to this entity.", - "readOnly" : true, - "$ref" : "#/definitions/JaxbLink" - }, - "versionMetadata" : { - "description" : "The metadata about this version of the extension bundle", - "$ref" : "#/definitions/BundleVersionMetadata" - }, - "dependencies" : { - "type" : "array", - "description" : "The set of other bundle versions that this version is dependent on", - "readOnly" : true, - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/BundleVersionDependency" - } - }, - "bundle" : { - "description" : "The bundle this version is for", - "readOnly" : true, - "$ref" : "#/definitions/ExtensionBundle" - }, - "bucket" : { - "description" : "The bucket that the extension bundle belongs to", - "$ref" : "#/definitions/Bucket" - }, - "filename" : { - "type" : "string" - } - } - }, - "BundleVersionDependency" : { - "type" : "object", - "properties" : { - "groupId" : { - "type" : "string", - "description" : "The group id of the bundle dependency" - }, - "artifactId" : { - "type" : "string", - "description" : "The artifact id of the bundle dependency" - }, - "version" : { - "type" : "string", - "description" : "The version of the bundle dependency" - } - } - }, - "BundleVersionMetadata" : { - "type" : "object", - "required" : [ "bucketId", "buildInfo", "contentSize", "sha256Supplied" ], - "properties" : { - "link" : { - "description" : "An WebLink to this entity.", - "readOnly" : true, - "$ref" : "#/definitions/JaxbLink" - }, - "id" : { - "type" : "string", - "description" : "The id of this version of the extension bundle" - }, - "bundleId" : { - "type" : "string", - "description" : "The id of the extension bundle this version is for" - }, - "bucketId" : { - "type" : "string", - "description" : "The id of the bucket the extension bundle belongs to" - }, - "version" : { - "type" : "string", - "description" : "The version of the extension bundle" - }, - "timestamp" : { - "type" : "integer", - "format" : "int64", - "description" : "The timestamp of the create date of this version", - "minimum" : 1 - }, - "author" : { - "type" : "string", - "description" : "The identity that created this version" - }, - "description" : { - "type" : "string", - "description" : "The description for this version" - }, - "sha256" : { - "type" : "string", - "description" : "The hex representation of the SHA-256 digest of the binary content for this version" - }, - "sha256Supplied" : { - "type" : "boolean", - "description" : "Whether or not the client supplied a SHA-256 when uploading the bundle" - }, - "contentSize" : { - "type" : "integer", - "format" : "int64", - "description" : "The size of the binary content for this version in bytes", - "minimum" : 0 - }, - "systemApiVersion" : { - "type" : "string", - "description" : "The version of the system API that this bundle version was built against" - }, - "buildInfo" : { - "description" : "The build information about this version", - "$ref" : "#/definitions/BuildInfo" - } - } - }, - "ComponentDifference" : { - "type" : "object", - "properties" : { - "valueA" : { - "type" : "string", - "description" : "The earlier value from the difference." - }, - "valueB" : { - "type" : "string", - "description" : "The newer value from the difference." - }, - "changeDescription" : { - "type" : "string", - "description" : "The description of the change." - }, - "differenceType" : { - "type" : "string", - "description" : "The key to the difference." - }, - "differenceTypeDescription" : { - "type" : "string", - "description" : "The description of the change type." - } - } - }, - "ComponentDifferenceGroup" : { - "type" : "object", - "properties" : { - "componentId" : { - "type" : "string", - "description" : "The id of the component whose changes are grouped together." - }, - "componentName" : { - "type" : "string", - "description" : "The name of the component whose changes are grouped together." - }, - "componentType" : { - "type" : "string", - "description" : "The type of component these changes relate to." - }, - "processGroupId" : { - "type" : "string", - "description" : "The process group id for this component." - }, - "differences" : { - "type" : "array", - "description" : "The list of changes related to this component between the 2 versions.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ComponentDifference" - } - } - } - }, - "ConnectableComponent" : { - "type" : "object", - "required" : [ "groupId", "id", "type" ], - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the connectable component." - }, - "type" : { - "type" : "string", - "description" : "The type of component the connectable is.", - "enum" : [ "PROCESSOR", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "INPUT_PORT", "OUTPUT_PORT", "FUNNEL" ] - }, - "groupId" : { - "type" : "string", - "description" : "The id of the group that the connectable component resides in" - }, - "name" : { - "type" : "string", - "description" : "The name of the connectable component" - }, - "comments" : { - "type" : "string", - "description" : "The comments for the connectable component." - } - } - }, - "ControllerServiceAPI" : { - "type" : "object", - "properties" : { - "type" : { - "type" : "string", - "description" : "The fully qualified name of the service interface." - }, - "bundle" : { - "description" : "The details of the artifact that bundled this service interface.", - "$ref" : "#/definitions/Bundle" - } - } - }, - "ControllerServiceDefinition" : { - "type" : "object", - "properties" : { - "className" : { - "type" : "string", - "description" : "The class name of the service API" - }, - "groupId" : { - "type" : "string", - "description" : "The group id of the service API" - }, - "artifactId" : { - "type" : "string", - "description" : "The artifact id of the service API" - }, - "version" : { - "type" : "string", - "description" : "The version of the service API" - } - } - }, - "CurrentUser" : { - "type" : "object", - "properties" : { - "identity" : { - "type" : "string", - "description" : "The identity of the current user", - "readOnly" : true - }, - "anonymous" : { - "type" : "boolean", - "description" : "Indicates if the current user is anonymous", - "readOnly" : true - }, - "loginSupported" : { - "type" : "boolean", - "description" : "Indicates if the NiFi instance supports logging in" - }, - "resourcePermissions" : { - "description" : "The access that the current user has to top level resources", - "readOnly" : true, - "$ref" : "#/definitions/ResourcePermissions" - } - } - }, - "DeprecationNotice" : { - "type" : "object", - "properties" : { - "reason" : { - "type" : "string", - "description" : "The reason for the deprecation" - }, - "alternatives" : { - "type" : "array", - "xml" : { - "wrapped" : true - }, - "description" : "The alternatives to use", - "items" : { - "type" : "string", - "xml" : { - "name" : "alternative" - } - } - } - } - }, - "DynamicProperty" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The description of the dynamic property name" - }, - "value" : { - "type" : "string", - "description" : "The description of the dynamic property value" - }, - "description" : { - "type" : "string", - "description" : "The description of the dynamic property" - }, - "expressionLanguageScope" : { - "type" : "string", - "description" : "The scope of the expression language support", - "enum" : [ "NONE", "VARIABLE_REGISTRY", "FLOWFILE_ATTRIBUTES" ] - }, - "expressionLanguageSupported" : { - "type" : "boolean", - "description" : "Whether or not expression language is supported" - } - } - }, - "DynamicRelationship" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The description of the dynamic relationship name" - }, - "description" : { - "type" : "string", - "description" : "The description of the dynamic relationship" - } - } - }, - "Extension" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The name of the extension" - }, - "type" : { - "type" : "string", - "description" : "The type of the extension", - "enum" : [ "PROCESSOR", "CONTROLLER_SERVICE", "REPORTING_TASK" ] - }, - "deprecationNotice" : { - "description" : "The deprecation notice of the extension", - "$ref" : "#/definitions/DeprecationNotice" - }, - "description" : { - "type" : "string", - "description" : "The description of the extension" - }, - "tags" : { - "type" : "array", - "xml" : { - "wrapped" : true - }, - "description" : "The tags of the extension", - "items" : { - "type" : "string", - "xml" : { - "name" : "tag" - } - } - }, - "properties" : { - "type" : "array", - "xml" : { - "wrapped" : true - }, - "description" : "The properties of the extension", - "items" : { - "xml" : { - "name" : "property" - }, - "$ref" : "#/definitions/Property" - } - }, - "dynamicProperties" : { - "type" : "array", - "xml" : { - "wrapped" : true - }, - "description" : "The dynamic properties of the extension", - "items" : { - "xml" : { - "name" : "dynamicProperty" - }, - "$ref" : "#/definitions/DynamicProperty" - } - }, - "relationships" : { - "type" : "array", - "xml" : { - "wrapped" : true - }, - "description" : "The relationships of the extension", - "items" : { - "xml" : { - "name" : "relationship" - }, - "$ref" : "#/definitions/Relationship" - } - }, - "dynamicRelationship" : { - "description" : "The dynamic relationships of the extension", - "$ref" : "#/definitions/DynamicRelationship" - }, - "readsAttributes" : { - "type" : "array", - "xml" : { - "wrapped" : true - }, - "description" : "The attributes read from flow files by the extension", - "items" : { - "xml" : { - "name" : "readsAttribute" - }, - "$ref" : "#/definitions/Attribute" - } - }, - "writesAttributes" : { - "type" : "array", - "xml" : { - "wrapped" : true - }, - "description" : "The attributes written to flow files by the extension", - "items" : { - "xml" : { - "name" : "writesAttribute" - }, - "$ref" : "#/definitions/Attribute" - } - }, - "stateful" : { - "description" : "The information about how the extension stores state", - "$ref" : "#/definitions/Stateful" - }, - "restricted" : { - "description" : "The restrictions of the extension", - "$ref" : "#/definitions/Restricted" - }, - "inputRequirement" : { - "type" : "string", - "description" : "The input requirement of the extension", - "enum" : [ "INPUT_REQUIRED", "INPUT_ALLOWED", "INPUT_FORBIDDEN" ] - }, - "systemResourceConsiderations" : { - "type" : "array", - "xml" : { - "wrapped" : true - }, - "description" : "The resource considerations of the extension", - "items" : { - "xml" : { - "name" : "systemResourceConsideration" - }, - "$ref" : "#/definitions/SystemResourceConsideration" - } - }, - "seeAlso" : { - "type" : "array", - "xml" : { - "wrapped" : true - }, - "description" : "The names of other extensions to see", - "items" : { - "type" : "string", - "xml" : { - "name" : "see" - } - } - }, - "providedServiceAPIs" : { - "type" : "array", - "xml" : { - "wrapped" : true - }, - "description" : "The service APIs provided by this extension", - "items" : { - "xml" : { - "name" : "providedServiceAPI" - }, - "$ref" : "#/definitions/ProvidedServiceAPI" - } - } - } - }, - "ExtensionBundle" : { - "type" : "object", - "required" : [ "bucketIdentifier", "bundleType", "name", "type" ], - "properties" : { - "link" : { - "description" : "An WebLink to this entity.", - "readOnly" : true, - "$ref" : "#/definitions/JaxbLink" - }, - "identifier" : { - "type" : "string", - "description" : "An ID to uniquely identify this object.", - "readOnly" : true - }, - "name" : { - "type" : "string", - "description" : "The name of the item." - }, - "description" : { - "type" : "string", - "description" : "A description of the item." - }, - "bucketIdentifier" : { - "type" : "string", - "description" : "The identifier of the bucket this items belongs to. This cannot be changed after the item is created." - }, - "bucketName" : { - "type" : "string", - "description" : "The name of the bucket this items belongs to.", - "readOnly" : true - }, - "createdTimestamp" : { - "type" : "integer", - "format" : "int64", - "description" : "The timestamp of when the item was created, as milliseconds since epoch.", - "readOnly" : true, - "minimum" : 1 - }, - "modifiedTimestamp" : { - "type" : "integer", - "format" : "int64", - "description" : "The timestamp of when the item was last modified, as milliseconds since epoch.", - "readOnly" : true, - "minimum" : 1 - }, - "type" : { - "type" : "string", - "description" : "The type of item.", - "enum" : [ "Flow", "Bundle" ] - }, - "permissions" : { - "description" : "The access that the current user has to the bucket containing this item.", - "readOnly" : true, - "$ref" : "#/definitions/Permissions" - }, - "bundleType" : { - "type" : "string", - "description" : "The type of the extension bundle", - "enum" : [ "NIFI_NAR", "MINIFI_CPP" ] - }, - "groupId" : { - "type" : "string", - "description" : "The group id of the extension bundle" - }, - "artifactId" : { - "type" : "string", - "description" : "The artifact id of the extension bundle" - }, - "versionCount" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of versions of this extension bundle.", - "readOnly" : true, - "minimum" : 0 - } - } - }, - "ExtensionFilterParams" : { - "type" : "object", - "properties" : { - "bundleType" : { - "type" : "string", - "description" : "The type of bundle", - "enum" : [ "NIFI_NAR", "MINIFI_CPP" ] - }, - "extensionType" : { - "type" : "string", - "description" : "The type of extension", - "enum" : [ "PROCESSOR", "CONTROLLER_SERVICE", "REPORTING_TASK" ] - }, - "tags" : { - "type" : "array", - "description" : "The tags", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - } - } - }, - "ExtensionMetadata" : { - "type" : "object", - "properties" : { - "link" : { - "description" : "An WebLink to this entity.", - "readOnly" : true, - "$ref" : "#/definitions/JaxbLink" - }, - "name" : { - "type" : "string", - "description" : "The name of the extension" - }, - "displayName" : { - "type" : "string", - "description" : "The display name of the extension" - }, - "type" : { - "type" : "string", - "description" : "The type of the extension", - "enum" : [ "PROCESSOR", "CONTROLLER_SERVICE", "REPORTING_TASK" ] - }, - "description" : { - "type" : "string", - "description" : "The description of the extension" - }, - "deprecationNotice" : { - "description" : "The deprecation notice of the extension", - "$ref" : "#/definitions/DeprecationNotice" - }, - "tags" : { - "type" : "array", - "description" : "The tags of the extension", - "items" : { - "type" : "string" - } - }, - "restricted" : { - "description" : "The restrictions of the extension", - "$ref" : "#/definitions/Restricted" - }, - "providedServiceAPIs" : { - "type" : "array", - "description" : "The service APIs provided by the extension", - "items" : { - "$ref" : "#/definitions/ProvidedServiceAPI" - } - }, - "bundleInfo" : { - "description" : "The information for the bundle where this extension is located", - "$ref" : "#/definitions/BundleInfo" - }, - "hasAdditionalDetails" : { - "type" : "boolean", - "description" : "Whether or not the extension has additional detail documentation" - }, - "linkDocs" : { - "description" : "A WebLink to the documentation for this extension.", - "readOnly" : true, - "$ref" : "#/definitions/JaxbLink" - } - } - }, - "ExtensionMetadataContainer" : { - "type" : "object", - "properties" : { - "numResults" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of extensions in the response" - }, - "filterParams" : { - "description" : "The filter parameters submitted for the request", - "$ref" : "#/definitions/ExtensionFilterParams" - }, - "extensions" : { - "type" : "array", - "description" : "The metadata for the extensions", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ExtensionMetadata" - } - } - } - }, - "ExtensionRepoArtifact" : { - "type" : "object", - "properties" : { - "link" : { - "description" : "An WebLink to this entity.", - "readOnly" : true, - "$ref" : "#/definitions/JaxbLink" - }, - "bucketName" : { - "type" : "string", - "description" : "The bucket name" - }, - "groupId" : { - "type" : "string", - "description" : "The group id" - }, - "artifactId" : { - "type" : "string", - "description" : "The artifact id" - } - } - }, - "ExtensionRepoBucket" : { - "type" : "object", - "properties" : { - "link" : { - "description" : "An WebLink to this entity.", - "readOnly" : true, - "$ref" : "#/definitions/JaxbLink" - }, - "bucketName" : { - "type" : "string", - "description" : "The name of the bucket" - } - } - }, - "ExtensionRepoGroup" : { - "type" : "object", - "properties" : { - "link" : { - "description" : "An WebLink to this entity.", - "readOnly" : true, - "$ref" : "#/definitions/JaxbLink" - }, - "bucketName" : { - "type" : "string", - "description" : "The bucket name" - }, - "groupId" : { - "type" : "string", - "description" : "The group id" - } - } - }, - "ExtensionRepoVersion" : { - "type" : "object", - "properties" : { - "extensionsLink" : { - "description" : "The WebLink to view the metadata about the extensions contained in the extension bundle.", - "readOnly" : true, - "$ref" : "#/definitions/JaxbLink" - }, - "downloadLink" : { - "description" : "The WebLink to download this version of the extension bundle.", - "readOnly" : true, - "$ref" : "#/definitions/JaxbLink" - }, - "sha256Link" : { - "description" : "The WebLink to retrieve the SHA-256 digest for this version of the extension bundle.", - "readOnly" : true, - "$ref" : "#/definitions/JaxbLink" - }, - "sha256Supplied" : { - "description" : "Indicates if the client supplied a SHA-256 when uploading this version of the extension bundle.", - "readOnly" : true, - "$ref" : "#/definitions/JaxbLink" - } - } - }, - "ExtensionRepoVersionSummary" : { - "type" : "object", - "properties" : { - "link" : { - "description" : "An WebLink to this entity.", - "readOnly" : true, - "$ref" : "#/definitions/JaxbLink" - }, - "bucketName" : { - "type" : "string", - "description" : "The bucket name" - }, - "groupId" : { - "type" : "string", - "description" : "The group id" - }, - "artifactId" : { - "type" : "string", - "description" : "The artifact id" - }, - "version" : { - "type" : "string", - "description" : "The version" - }, - "author" : { - "type" : "string", - "description" : "The identity of the user that created this version" - }, - "timestamp" : { - "type" : "integer", - "format" : "int64", - "description" : "The timestamp of when this version was created" - } - } - }, - "ExternalControllerServiceReference" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The identifier of the controller service" - }, - "name" : { - "type" : "string", - "description" : "The name of the controller service" - } - } - }, - "Fields" : { - "type" : "object", - "properties" : { - "fields" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - } - } - }, - "JaxbLink" : { - "type" : "object", - "properties" : { - "href" : { - "type" : "string", - "format" : "uri", - "xml" : { - "attribute" : true - }, - "description" : "The href for the link" - }, - "params" : { - "type" : "object", - "description" : "The params for the link", - "additionalProperties" : { - "type" : "string" - } - } - } - }, - "Permissions" : { - "type" : "object", - "properties" : { - "canRead" : { - "type" : "boolean", - "description" : "Indicates whether the user can read a given resource.", - "readOnly" : true - }, - "canWrite" : { - "type" : "boolean", - "description" : "Indicates whether the user can write a given resource.", - "readOnly" : true - }, - "canDelete" : { - "type" : "boolean", - "description" : "Indicates whether the user can delete a given resource.", - "readOnly" : true - } - } - }, - "Position" : { - "type" : "object", - "properties" : { - "x" : { - "type" : "number", - "format" : "double", - "description" : "The x coordinate." - }, - "y" : { - "type" : "number", - "format" : "double", - "description" : "The y coordinate." - } - }, - "description" : "The position of a component on the graph" - }, - "Property" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The name of the property" - }, - "displayName" : { - "type" : "string", - "description" : "The display name" - }, - "description" : { - "type" : "string", - "description" : "The description" - }, - "defaultValue" : { - "type" : "string", - "description" : "The default value" - }, - "controllerServiceDefinition" : { - "description" : "The controller service required by this property, or null if none is required", - "$ref" : "#/definitions/ControllerServiceDefinition" - }, - "allowableValues" : { - "type" : "array", - "xml" : { - "wrapped" : true - }, - "description" : "The allowable values for this property", - "items" : { - "xml" : { - "name" : "allowableValue" - }, - "$ref" : "#/definitions/AllowableValue" - } - }, - "required" : { - "type" : "boolean", - "description" : "Whether or not the property is required" - }, - "sensitive" : { - "type" : "boolean", - "description" : "Whether or not the property is sensitive" - }, - "expressionLanguageSupported" : { - "type" : "boolean", - "description" : "Whether or not expression language is supported" - }, - "expressionLanguageScope" : { - "type" : "string", - "description" : "The scope of expression language support", - "enum" : [ "NONE", "VARIABLE_REGISTRY", "FLOWFILE_ATTRIBUTES" ] - }, - "dynamicallyModifiesClasspath" : { - "type" : "boolean", - "description" : "Whether or not the processor dynamically modifies the classpath" - }, - "dynamic" : { - "type" : "boolean", - "description" : "Whether or not the processor is dynamic" - } - } - }, - "ProvidedServiceAPI" : { - "type" : "object", - "properties" : { - "className" : { - "type" : "string", - "description" : "The class name of the service API being provided" - }, - "groupId" : { - "type" : "string", - "description" : "The group id of the service API being provided" - }, - "artifactId" : { - "type" : "string", - "description" : "The artifact id of the service API being provided" - }, - "version" : { - "type" : "string", - "description" : "The version of the service API being provided" - } - } - }, - "RegistryConfiguration" : { - "type" : "object", - "properties" : { - "supportsManagedAuthorizer" : { - "type" : "boolean", - "description" : "Whether this NiFi Registry supports a managed authorizer. Managed authorizers can visualize users, groups, and policies in the UI.", - "readOnly" : true - }, - "supportsConfigurableAuthorizer" : { - "type" : "boolean", - "description" : "Whether this NiFi Registry supports a configurable authorizer.", - "readOnly" : true - }, - "supportsConfigurableUsersAndGroups" : { - "type" : "boolean", - "description" : "Whether this NiFi Registry supports configurable users and groups.", - "readOnly" : true - } - } - }, - "Relationship" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The name of the relationship" - }, - "description" : { - "type" : "string", - "description" : "The description of the relationship" - }, - "autoTerminated" : { - "type" : "boolean", - "description" : "Whether or not the relationship is auto-terminated by default" - } - } - }, - "Resource" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The identifier of the resource.", - "readOnly" : true - }, - "name" : { - "type" : "string", - "description" : "The name of the resource.", - "readOnly" : true - } - } - }, - "ResourcePermissions" : { - "type" : "object", - "properties" : { - "buckets" : { - "description" : "The access that the current user has to the top level /buckets resource of this NiFi Registry (i.e., access to all buckets)", - "readOnly" : true, - "$ref" : "#/definitions/Permissions" - }, - "tenants" : { - "description" : "The access that the current user has to the top level /tenants resource of this NiFi Registry", - "readOnly" : true, - "$ref" : "#/definitions/Permissions" - }, - "policies" : { - "description" : "The access that the current user has to the top level /policies resource of this NiFi Registry", - "readOnly" : true, - "$ref" : "#/definitions/Permissions" - }, - "proxy" : { - "description" : "The access that the current user has to the top level /proxy resource of this NiFi Registry", - "readOnly" : true, - "$ref" : "#/definitions/Permissions" - }, - "anyTopLevelResource" : { - "description" : "The access that the current user has to any top level resources (a logical 'OR' of all other values)", - "readOnly" : true, - "$ref" : "#/definitions/Permissions" - } - } - }, - "Restricted" : { - "type" : "object", - "properties" : { - "generalRestrictionExplanation" : { - "type" : "string", - "description" : "The general restriction for the extension, or null if only specific restrictions exist" - }, - "restrictions" : { - "type" : "array", - "xml" : { - "wrapped" : true - }, - "description" : "The specific restrictions", - "items" : { - "xml" : { - "name" : "restriction" - }, - "$ref" : "#/definitions/Restriction" - } - } - } - }, - "Restriction" : { - "type" : "object", - "properties" : { - "requiredPermission" : { - "type" : "string", - "description" : "The permission required for this restriction" - }, - "explanation" : { - "type" : "string", - "description" : "The explanation of this restriction" - } - } - }, - "Stateful" : { - "type" : "object", - "properties" : { - "description" : { - "type" : "string", - "description" : "The description for how the extension stores state" - }, - "scopes" : { - "type" : "array", - "xml" : { - "wrapped" : true - }, - "description" : "The scopes used to store state", - "items" : { - "type" : "string", - "xml" : { - "name" : "scope" - }, - "enum" : [ "CLUSTER", "LOCAL" ] - } - } - } - }, - "SystemResourceConsideration" : { - "type" : "object", - "properties" : { - "resource" : { - "type" : "string", - "description" : "The resource to consider" - }, - "description" : { - "type" : "string", - "description" : "The description of how the resource is affected" - } - } - }, - "TagCount" : { - "type" : "object", - "properties" : { - "tag" : { - "type" : "string", - "description" : "The tag label" - }, - "count" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of occurrences of the given tag" - } - } - }, - "Tenant" : { - "type" : "object", - "required" : [ "identity" ], - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The computer-generated identifier of the tenant.", - "readOnly" : true - }, - "identity" : { - "type" : "string", - "description" : "The human-facing identity of the tenant. This can only be changed if the tenant is configurable." - }, - "configurable" : { - "type" : "boolean", - "description" : "Indicates if this tenant is configurable, based on which UserGroupProvider has been configured to manage it.", - "readOnly" : true - }, - "resourcePermissions" : { - "description" : "A summary top-level resource access policies granted to this tenant.", - "readOnly" : true, - "$ref" : "#/definitions/ResourcePermissions" - }, - "accessPolicies" : { - "type" : "array", - "description" : "The access policies granted to this tenant.", - "readOnly" : true, - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/AccessPolicySummary" - } - } - } - }, - "User" : { - "type" : "object", - "required" : [ "identity" ], - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The computer-generated identifier of the tenant.", - "readOnly" : true - }, - "identity" : { - "type" : "string", - "description" : "The human-facing identity of the tenant. This can only be changed if the tenant is configurable." - }, - "configurable" : { - "type" : "boolean", - "description" : "Indicates if this tenant is configurable, based on which UserGroupProvider has been configured to manage it.", - "readOnly" : true - }, - "resourcePermissions" : { - "description" : "A summary top-level resource access policies granted to this tenant.", - "readOnly" : true, - "$ref" : "#/definitions/ResourcePermissions" - }, - "accessPolicies" : { - "type" : "array", - "description" : "The access policies granted to this tenant.", - "readOnly" : true, - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/AccessPolicySummary" - } - }, - "userGroups" : { - "type" : "array", - "description" : "The groups to which the user belongs.", - "readOnly" : true, - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/Tenant" - } - } - } - }, - "UserGroup" : { - "type" : "object", - "required" : [ "identity" ], - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The computer-generated identifier of the tenant.", - "readOnly" : true - }, - "identity" : { - "type" : "string", - "description" : "The human-facing identity of the tenant. This can only be changed if the tenant is configurable." - }, - "configurable" : { - "type" : "boolean", - "description" : "Indicates if this tenant is configurable, based on which UserGroupProvider has been configured to manage it.", - "readOnly" : true - }, - "resourcePermissions" : { - "description" : "A summary top-level resource access policies granted to this tenant.", - "readOnly" : true, - "$ref" : "#/definitions/ResourcePermissions" - }, - "accessPolicies" : { - "type" : "array", - "description" : "The access policies granted to this tenant.", - "readOnly" : true, - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/AccessPolicySummary" - } - }, - "users" : { - "type" : "array", - "description" : "The users that belong to this user group. This can only be changed if this group is configurable.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/Tenant" - } - } - } - }, - "VersionedConnection" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The component's unique identifier" - }, - "name" : { - "type" : "string", - "description" : "The component's name" - }, - "comments" : { - "type" : "string", - "description" : "The user-supplied comments for the component" - }, - "position" : { - "description" : "The component's position on the graph", - "$ref" : "#/definitions/Position" - }, - "source" : { - "description" : "The source of the connection.", - "$ref" : "#/definitions/ConnectableComponent" - }, - "destination" : { - "description" : "The destination of the connection.", - "$ref" : "#/definitions/ConnectableComponent" - }, - "labelIndex" : { - "type" : "integer", - "format" : "int32", - "description" : "The index of the bend point where to place the connection label." - }, - "zIndex" : { - "type" : "integer", - "format" : "int64", - "description" : "The z index of the connection." - }, - "selectedRelationships" : { - "type" : "array", - "description" : "The selected relationship that comprise the connection.", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - }, - "backPressureObjectThreshold" : { - "type" : "integer", - "format" : "int64", - "description" : "The object count threshold for determining when back pressure is applied. Updating this value is a passive change in the sense that it won't impact whether existing files over the limit are affected but it does help feeder processors to stop pushing too much into this work queue." - }, - "backPressureDataSizeThreshold" : { - "type" : "string", - "description" : "The object data size threshold for determining when back pressure is applied. Updating this value is a passive change in the sense that it won't impact whether existing files over the limit are affected but it does help feeder processors to stop pushing too much into this work queue." - }, - "flowFileExpiration" : { - "type" : "string", - "description" : "The amount of time a flow file may be in the flow before it will be automatically aged out of the flow. Once a flow file reaches this age it will be terminated from the flow the next time a processor attempts to start work on it." - }, - "prioritizers" : { - "type" : "array", - "description" : "The comparators used to prioritize the queue.", - "items" : { - "type" : "string" - } - }, - "bends" : { - "type" : "array", - "description" : "The bend points on the connection.", - "items" : { - "$ref" : "#/definitions/Position" - } - }, - "loadBalanceStrategy" : { - "type" : "string", - "description" : "The Strategy to use for load balancing data across the cluster, or null, if no Load Balance Strategy has been specified.", - "enum" : [ "DO_NOT_LOAD_BALANCE", "PARTITION_BY_ATTRIBUTE", "ROUND_ROBIN", "SINGLE_NODE" ] - }, - "partitioningAttribute" : { - "type" : "string", - "description" : "The attribute to use for partitioning data as it is load balanced across the cluster. If the Load Balance Strategy is configured to use PARTITION_BY_ATTRIBUTE, the value returned by this method is the name of the FlowFile Attribute that will be used to determine which node in the cluster should receive a given FlowFile. If the Load Balance Strategy is unset or is set to any other value, the Partitioning Attribute has no effect." - }, - "loadBalanceCompression" : { - "type" : "string", - "description" : "Whether or not compression should be used when transferring FlowFiles between nodes", - "enum" : [ "DO_NOT_COMPRESS", "COMPRESS_ATTRIBUTES_ONLY", "COMPRESS_ATTRIBUTES_AND_CONTENT" ] - }, - "componentType" : { - "type" : "string", - "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE" ] - }, - "groupIdentifier" : { - "type" : "string", - "description" : "The ID of the Process Group that this component belongs to" - } - } - }, - "VersionedControllerService" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The component's unique identifier" - }, - "name" : { - "type" : "string", - "description" : "The component's name" - }, - "comments" : { - "type" : "string", - "description" : "The user-supplied comments for the component" - }, - "position" : { - "description" : "The component's position on the graph", - "$ref" : "#/definitions/Position" - }, - "type" : { - "type" : "string", - "description" : "The type of the controller service." - }, - "bundle" : { - "description" : "The details of the artifact that bundled this processor type.", - "$ref" : "#/definitions/Bundle" - }, - "controllerServiceApis" : { - "type" : "array", - "description" : "Lists the APIs this Controller Service implements.", - "items" : { - "$ref" : "#/definitions/ControllerServiceAPI" - } - }, - "properties" : { - "type" : "object", - "description" : "The properties of the controller service.", - "additionalProperties" : { - "type" : "string" - } - }, - "propertyDescriptors" : { - "type" : "object", - "description" : "The property descriptors for the processor.", - "additionalProperties" : { - "$ref" : "#/definitions/VersionedPropertyDescriptor" - } - }, - "annotationData" : { - "type" : "string", - "description" : "The annotation for the controller service. This is how the custom UI relays configuration to the controller service." - }, - "componentType" : { - "type" : "string", - "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE" ] - }, - "groupIdentifier" : { - "type" : "string", - "description" : "The ID of the Process Group that this component belongs to" - } - } - }, - "VersionedFlow" : { - "type" : "object", - "required" : [ "bucketIdentifier", "name", "type" ], - "properties" : { - "link" : { - "description" : "An WebLink to this entity.", - "readOnly" : true, - "$ref" : "#/definitions/JaxbLink" - }, - "identifier" : { - "type" : "string", - "description" : "An ID to uniquely identify this object.", - "readOnly" : true - }, - "name" : { - "type" : "string", - "description" : "The name of the item." - }, - "description" : { - "type" : "string", - "description" : "A description of the item." - }, - "bucketIdentifier" : { - "type" : "string", - "description" : "The identifier of the bucket this items belongs to. This cannot be changed after the item is created." - }, - "bucketName" : { - "type" : "string", - "description" : "The name of the bucket this items belongs to.", - "readOnly" : true - }, - "createdTimestamp" : { - "type" : "integer", - "format" : "int64", - "description" : "The timestamp of when the item was created, as milliseconds since epoch.", - "readOnly" : true, - "minimum" : 1 - }, - "modifiedTimestamp" : { - "type" : "integer", - "format" : "int64", - "description" : "The timestamp of when the item was last modified, as milliseconds since epoch.", - "readOnly" : true, - "minimum" : 1 - }, - "type" : { - "type" : "string", - "description" : "The type of item.", - "enum" : [ "Flow", "Bundle" ] - }, - "permissions" : { - "description" : "The access that the current user has to the bucket containing this item.", - "readOnly" : true, - "$ref" : "#/definitions/Permissions" - }, - "versionCount" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of versions of this flow.", - "readOnly" : true, - "minimum" : 0 - } - } - }, - "VersionedFlowCoordinates" : { - "type" : "object", - "properties" : { - "registryUrl" : { - "type" : "string", - "description" : "The URL of the Flow Registry that contains the flow" - }, - "bucketId" : { - "type" : "string", - "description" : "The UUID of the bucket that the flow resides in" - }, - "flowId" : { - "type" : "string", - "description" : "The UUID of the flow" - }, - "version" : { - "type" : "integer", - "format" : "int32", - "description" : "The version of the flow" - }, - "latest" : { - "type" : "boolean", - "description" : "Whether or not these coordinates point to the latest version of the flow" - } - } - }, - "VersionedFlowDifference" : { - "type" : "object", - "properties" : { - "bucketId" : { - "type" : "string", - "description" : "The id of the bucket that the flow is stored in." - }, - "flowId" : { - "type" : "string", - "description" : "The id of the flow that is being examined." - }, - "versionA" : { - "type" : "integer", - "format" : "int32", - "description" : "The earlier version from the diff operation." - }, - "versionB" : { - "type" : "integer", - "format" : "int32", - "description" : "The latter version from the diff operation." - }, - "componentDifferenceGroups" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ComponentDifferenceGroup" - } - } - } - }, - "VersionedFlowSnapshot" : { - "type" : "object", - "required" : [ "flowContents", "snapshotMetadata" ], - "properties" : { - "snapshotMetadata" : { - "description" : "The metadata for this snapshot", - "$ref" : "#/definitions/VersionedFlowSnapshotMetadata" - }, - "flowContents" : { - "description" : "The contents of the versioned flow", - "$ref" : "#/definitions/VersionedProcessGroup" - }, - "externalControllerServices" : { - "type" : "object", - "description" : "The information about controller services that exist outside this versioned flow, but are referenced by components within the versioned flow.", - "additionalProperties" : { - "$ref" : "#/definitions/ExternalControllerServiceReference" - } - }, - "parameterContexts" : { - "type" : "object", - "description" : "The parameter contexts referenced by process groups in the flow contents. The mapping is from the name of the context to the context instance, and it is expected that any context in this map is referenced by at least one process group in this flow.", - "additionalProperties" : { - "$ref" : "#/definitions/VersionedParameterContext" - } - }, - "flowEncodingVersion" : { - "type" : "string", - "description" : "The optional encoding version of the flow contents." - }, - "flow" : { - "description" : "The flow this snapshot is for", - "readOnly" : true, - "$ref" : "#/definitions/VersionedFlow" - }, - "bucket" : { - "description" : "The bucket where the flow is located", - "readOnly" : true, - "$ref" : "#/definitions/Bucket" - }, - "latest" : { - "type" : "boolean" - } - } - }, - "VersionedFlowSnapshotMetadata" : { - "type" : "object", - "required" : [ "bucketIdentifier", "flowIdentifier", "version" ], - "properties" : { - "link" : { - "description" : "An WebLink to this entity.", - "readOnly" : true, - "$ref" : "#/definitions/JaxbLink" - }, - "bucketIdentifier" : { - "type" : "string", - "description" : "The identifier of the bucket this snapshot belongs to." - }, - "flowIdentifier" : { - "type" : "string", - "description" : "The identifier of the flow this snapshot belongs to." - }, - "version" : { - "type" : "integer", - "format" : "int32", - "description" : "The version of this snapshot of the flow.", - "minimum" : -1 - }, - "timestamp" : { - "type" : "integer", - "format" : "int64", - "description" : "The timestamp when the flow was saved, as milliseconds since epoch.", - "readOnly" : true, - "minimum" : 1 - }, - "author" : { - "type" : "string", - "description" : "The user that created this snapshot of the flow.", - "readOnly" : true - }, - "comments" : { - "type" : "string", - "description" : "The comments provided by the user when creating the snapshot." - } - } - }, - "VersionedFunnel" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The component's unique identifier" - }, - "name" : { - "type" : "string", - "description" : "The component's name" - }, - "comments" : { - "type" : "string", - "description" : "The user-supplied comments for the component" - }, - "position" : { - "description" : "The component's position on the graph", - "$ref" : "#/definitions/Position" - }, - "componentType" : { - "type" : "string", - "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE" ] - }, - "groupIdentifier" : { - "type" : "string", - "description" : "The ID of the Process Group that this component belongs to" - } - } - }, - "VersionedLabel" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The component's unique identifier" - }, - "name" : { - "type" : "string", - "description" : "The component's name" - }, - "comments" : { - "type" : "string", - "description" : "The user-supplied comments for the component" - }, - "position" : { - "description" : "The component's position on the graph", - "$ref" : "#/definitions/Position" - }, - "label" : { - "type" : "string", - "description" : "The text that appears in the label." - }, - "width" : { - "type" : "number", - "format" : "double", - "description" : "The width of the label in pixels when at a 1:1 scale." - }, - "height" : { - "type" : "number", - "format" : "double", - "description" : "The height of the label in pixels when at a 1:1 scale." - }, - "style" : { - "type" : "object", - "description" : "The styles for this label (font-size : 12px, background-color : #eee, etc).", - "additionalProperties" : { - "type" : "string" - } - }, - "componentType" : { - "type" : "string", - "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE" ] - }, - "groupIdentifier" : { - "type" : "string", - "description" : "The ID of the Process Group that this component belongs to" - } - } - }, - "VersionedParameter" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The name of the parameter" - }, - "description" : { - "type" : "string", - "description" : "The description of the param" - }, - "sensitive" : { - "type" : "boolean", - "description" : "Whether or not the parameter value is sensitive" - }, - "value" : { - "type" : "string", - "description" : "The value of the parameter" - } - } - }, - "VersionedParameterContext" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The name of the context" - }, - "description" : { - "type" : "string", - "description" : "The description of the parameter context" - }, - "parameters" : { - "type" : "array", - "description" : "The parameters in the context", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedParameter" - } - } - } - }, - "VersionedPort" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The component's unique identifier" - }, - "name" : { - "type" : "string", - "description" : "The component's name" - }, - "comments" : { - "type" : "string", - "description" : "The user-supplied comments for the component" - }, - "position" : { - "description" : "The component's position on the graph", - "$ref" : "#/definitions/Position" - }, - "type" : { - "type" : "string", - "description" : "The type of port.", - "enum" : [ "INPUT_PORT", "OUTPUT_PORT" ] - }, - "concurrentlySchedulableTaskCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of tasks that should be concurrently scheduled for the port." - }, - "scheduledState" : { - "type" : "string", - "description" : "The scheduled state of the component", - "enum" : [ "ENABLED", "DISABLED" ] - }, - "allowRemoteAccess" : { - "type" : "boolean", - "description" : "Whether or not this port allows remote access for site-to-site" - }, - "componentType" : { - "type" : "string", - "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE" ] - }, - "groupIdentifier" : { - "type" : "string", - "description" : "The ID of the Process Group that this component belongs to" - } - } - }, - "VersionedProcessGroup" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The component's unique identifier" - }, - "name" : { - "type" : "string", - "description" : "The component's name" - }, - "comments" : { - "type" : "string", - "description" : "The user-supplied comments for the component" - }, - "position" : { - "description" : "The component's position on the graph", - "$ref" : "#/definitions/Position" - }, - "processGroups" : { - "type" : "array", - "description" : "The child Process Groups", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedProcessGroup" - } - }, - "remoteProcessGroups" : { - "type" : "array", - "description" : "The Remote Process Groups", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedRemoteProcessGroup" - } - }, - "processors" : { - "type" : "array", - "description" : "The Processors", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedProcessor" - } - }, - "inputPorts" : { - "type" : "array", - "description" : "The Input Ports", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedPort" - } - }, - "outputPorts" : { - "type" : "array", - "description" : "The Output Ports", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedPort" - } - }, - "connections" : { - "type" : "array", - "description" : "The Connections", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedConnection" - } - }, - "labels" : { - "type" : "array", - "description" : "The Labels", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedLabel" - } - }, - "funnels" : { - "type" : "array", - "description" : "The Funnels", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedFunnel" - } - }, - "controllerServices" : { - "type" : "array", - "description" : "The Controller Services", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedControllerService" - } - }, - "versionedFlowCoordinates" : { - "description" : "The coordinates where the remote flow is stored, or null if the Process Group is not directly under Version Control", - "$ref" : "#/definitions/VersionedFlowCoordinates" - }, - "variables" : { - "type" : "object", - "description" : "The Variables in the Variable Registry for this Process Group (not including any ancestor or descendant Process Groups)", - "additionalProperties" : { - "type" : "string" - } - }, - "parameterContextName" : { - "type" : "string", - "description" : "The name of the parameter context used by this process group" - }, - "componentType" : { - "type" : "string", - "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE" ] - }, - "groupIdentifier" : { - "type" : "string", - "description" : "The ID of the Process Group that this component belongs to" - } - } - }, - "VersionedProcessor" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The component's unique identifier" - }, - "name" : { - "type" : "string", - "description" : "The component's name" - }, - "comments" : { - "type" : "string", - "description" : "The user-supplied comments for the component" - }, - "position" : { - "description" : "The component's position on the graph", - "$ref" : "#/definitions/Position" - }, - "bundle" : { - "description" : "Information about the bundle from which the component came", - "$ref" : "#/definitions/Bundle" - }, - "style" : { - "type" : "object", - "description" : "Stylistic data for rendering in a UI", - "additionalProperties" : { - "type" : "string" - } - }, - "type" : { - "type" : "string", - "description" : "The type of Processor" - }, - "properties" : { - "type" : "object", - "description" : "The properties for the processor. Properties whose value is not set will only contain the property name.", - "additionalProperties" : { - "type" : "string" - } - }, - "propertyDescriptors" : { - "type" : "object", - "description" : "The property descriptors for the processor.", - "additionalProperties" : { - "$ref" : "#/definitions/VersionedPropertyDescriptor" - } - }, - "annotationData" : { - "type" : "string", - "description" : "The annotation data for the processor used to relay configuration between a custom UI and the procesosr." - }, - "schedulingPeriod" : { - "type" : "string", - "description" : "The frequency with which to schedule the processor. The format of the value will depend on th value of schedulingStrategy." - }, - "schedulingStrategy" : { - "type" : "string", - "description" : "Indcates whether the prcessor should be scheduled to run in event or timer driven mode." - }, - "executionNode" : { - "type" : "string", - "description" : "Indicates the node where the process will execute." - }, - "penaltyDuration" : { - "type" : "string", - "description" : "The amout of time that is used when the process penalizes a flowfile." - }, - "yieldDuration" : { - "type" : "string", - "description" : "The amount of time that must elapse before this processor is scheduled again after yielding." - }, - "bulletinLevel" : { - "type" : "string", - "description" : "The level at which the processor will report bulletins." - }, - "runDurationMillis" : { - "type" : "integer", - "format" : "int64", - "description" : "The run duration for the processor in milliseconds." - }, - "concurrentlySchedulableTaskCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of tasks that should be concurrently schedule for the processor. If the processor doesn't allow parallol processing then any positive input will be ignored." - }, - "autoTerminatedRelationships" : { - "type" : "array", - "description" : "The names of all relationships that cause a flow file to be terminated if the relationship is not connected elsewhere. This property differs from the 'isAutoTerminate' property of the RelationshipDTO in that the RelationshipDTO is meant to depict the current configuration, whereas this property can be set in a DTO when updating a Processor in order to change which Relationships should be auto-terminated.", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - }, - "scheduledState" : { - "type" : "string", - "description" : "The scheduled state of the component", - "enum" : [ "ENABLED", "DISABLED" ] - }, - "componentType" : { - "type" : "string", - "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE" ] - }, - "groupIdentifier" : { - "type" : "string", - "description" : "The ID of the Process Group that this component belongs to" - } - } - }, - "VersionedPropertyDescriptor" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The name of the property" - }, - "displayName" : { - "type" : "string", - "description" : "The display name of the property" - }, - "identifiesControllerService" : { - "type" : "boolean", - "description" : "Whether or not the property provides the identifier of a Controller Service" - }, - "sensitive" : { - "type" : "boolean", - "description" : "Whether or not the property is considered sensitive" - } - } - }, - "VersionedRemoteGroupPort" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The component's unique identifier" - }, - "name" : { - "type" : "string", - "description" : "The component's name" - }, - "comments" : { - "type" : "string", - "description" : "The user-supplied comments for the component" - }, - "position" : { - "description" : "The component's position on the graph", - "$ref" : "#/definitions/Position" - }, - "remoteGroupId" : { - "type" : "string", - "description" : "The id of the remote process group that the port resides in." - }, - "concurrentlySchedulableTaskCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of task that may transmit flowfiles to the target port concurrently." - }, - "useCompression" : { - "type" : "boolean", - "description" : "Whether the flowfiles are compressed when sent to the target port." - }, - "batchSize" : { - "description" : "The batch settings for data transmission.", - "$ref" : "#/definitions/BatchSize" - }, - "componentType" : { - "type" : "string", - "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE" ] - }, - "targetId" : { - "type" : "string", - "description" : "The ID of the port on the target NiFi instance" - }, - "scheduledState" : { - "type" : "string", - "description" : "The scheduled state of the component", - "enum" : [ "ENABLED", "DISABLED" ] - }, - "groupIdentifier" : { - "type" : "string", - "description" : "The ID of the Process Group that this component belongs to" - } - } - }, - "VersionedRemoteProcessGroup" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The component's unique identifier" - }, - "name" : { - "type" : "string", - "description" : "The component's name" - }, - "comments" : { - "type" : "string", - "description" : "The user-supplied comments for the component" - }, - "position" : { - "description" : "The component's position on the graph", - "$ref" : "#/definitions/Position" - }, - "targetUri" : { - "type" : "string", - "description" : "[DEPRECATED] The target URI of the remote process group. If target uri is not set, but uris are set, then returns the first uri in the uris. If neither target uri nor uris are set, then returns null." - }, - "targetUris" : { - "type" : "string", - "description" : "The target URIs of the remote process group. If target uris is not set but target uri is set, then returns the single target uri. If neither target uris nor target uri is set, then returns null." - }, - "communicationsTimeout" : { - "type" : "string", - "description" : "The time period used for the timeout when communicating with the target." - }, - "yieldDuration" : { - "type" : "string", - "description" : "When yielding, this amount of time must elapse before the remote process group is scheduled again." - }, - "transportProtocol" : { - "type" : "string", - "description" : "The Transport Protocol that is used for Site-to-Site communications", - "enum" : [ "RAW", "HTTP" ] - }, - "localNetworkInterface" : { - "type" : "string", - "description" : "The local network interface to send/receive data. If not specified, any local address is used. If clustered, all nodes must have an interface with this identifier." - }, - "proxyHost" : { - "type" : "string" - }, - "proxyPort" : { - "type" : "integer", - "format" : "int32" - }, - "proxyUser" : { - "type" : "string" - }, - "inputPorts" : { - "type" : "array", - "description" : "A Set of Input Ports that can be connected to, in order to send data to the remote NiFi instance", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedRemoteGroupPort" - } - }, - "outputPorts" : { - "type" : "array", - "description" : "A Set of Output Ports that can be connected to, in order to pull data from the remote NiFi instance", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedRemoteGroupPort" - } - }, - "componentType" : { - "type" : "string", - "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE" ] - }, - "groupIdentifier" : { - "type" : "string", - "description" : "The ID of the Process Group that this component belongs to" - } - } - } - } -} diff --git a/resources/client_gen/api_defs/registry-0.7.0.json b/resources/client_gen/api_defs/registry-0.7.0.json deleted file mode 100644 index 274e1094..00000000 --- a/resources/client_gen/api_defs/registry-0.7.0.json +++ /dev/null @@ -1,6485 +0,0 @@ -{ - "swagger" : "2.0", - "info" : { - "description" : "The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components.", - "version" : "0.7.0", - "title" : "Apache NiFi Registry REST API", - "termsOfService" : "As described in the license", - "contact" : { - "name" : "Apache NiFi Registry", - "url" : "https://nifi.apache.org", - "email" : "dev@nifi.apache.org" - }, - "license" : { - "name" : "Apache 2.0 License", - "url" : "https://www.apache.org/licenses/LICENSE-2.0.html" - } - }, - "basePath" : "/nifi-registry-api", - "tags" : [ { - "name" : "access", - "description" : "Endpoints for obtaining an access token or checking access status." - }, { - "name" : "bucket bundles", - "description" : "Create extension bundles scoped to an existing bucket in the registry. " - }, { - "name" : "bucket flows", - "description" : "Create flows scoped to an existing bucket in the registry." - }, { - "name" : "buckets", - "description" : "Create named buckets in the registry to store NiFi objects such flows and extensions. Search for and retrieve existing buckets." - }, { - "name" : "bundles", - "description" : "Gets metadata about extension bundles and their versions. " - }, { - "name" : "config", - "description" : "Retrieves the configuration for this NiFi Registry." - }, { - "name" : "extension repository", - "description" : "Interact with extension bundles via the hierarchy of bucket/group/artifact/version. " - }, { - "name" : "extensions", - "description" : "Find and retrieve extensions. " - }, { - "name" : "flows", - "description" : "Gets metadata about flows." - }, { - "name" : "items", - "description" : "Retrieve items across all buckets for which the user is authorized." - }, { - "name" : "policies", - "description" : "Endpoint for managing access policies." - }, { - "name" : "tenants", - "description" : "Endpoint for managing users and user groups." - } ], - "schemes" : [ "http", "https" ], - "paths" : { - "/access" : { - "get" : { - "tags" : [ "access" ], - "summary" : "Get access status", - "description" : "Returns the current client's authenticated identity and permissions to top-level resources", - "operationId" : "getAccessStatus", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/CurrentUser" - } - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid. The NiFi Registry might be running unsecured." - } - }, - "security" : [ { - "Authorization" : [ ] - } ] - } - }, - "/access/logout" : { - "delete" : { - "tags" : [ "access" ], - "summary" : "Performs a logout for other providers that have been issued a JWT.", - "description" : "\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "logOut", - "consumes" : [ "*/*" ], - "produces" : [ "*/*" ], - "responses" : { - "200" : { - "description" : "User was logged out successfully." - }, - "401" : { - "description" : "Authentication token provided was empty or not in the correct JWT format." - }, - "500" : { - "description" : "Client failed to log out." - } - } - } - }, - "/access/token" : { - "post" : { - "tags" : [ "access" ], - "summary" : "Create token trying all providers", - "description" : "Creates a token for accessing the REST API via auto-detected method of verifying client identity claim credentials. The token returned is formatted as a JSON Web Token (JWT). The token is base64 encoded and comprised of three parts. The header, the body, and the signature. The expiration of the token is a contained within the body. The token can be used in the Authorization header in the format 'Authorization: Bearer '.", - "operationId" : "createAccessTokenByTryingAllProviders", - "consumes" : [ "*/*" ], - "produces" : [ "text/plain" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid. The NiFi Registry may not be configured to support login with username/password." - }, - "500" : { - "description" : "NiFi Registry was unable to complete the request because an unexpected error occurred." - } - } - } - }, - "/access/token/identity-provider" : { - "post" : { - "tags" : [ "access" ], - "summary" : "Create token using identity provider", - "description" : "Creates a token for accessing the REST API via a custom identity provider. The user credentials must be passed in a format understood by the custom identity provider, e.g., a third-party auth token in an HTTP header. The exact format of the user credentials expected by the custom identity provider can be discovered by 'GET /access/token/identity-provider/usage'. The token returned is formatted as a JSON Web Token (JWT). The token is base64 encoded and comprised of three parts. The header, the body, and the signature. The expiration of the token is a contained within the body. The token can be used in the Authorization header in the format 'Authorization: Bearer '.", - "operationId" : "createAccessTokenUsingIdentityProviderCredentials", - "consumes" : [ "*/*" ], - "produces" : [ "text/plain" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid. The NiFi Registry may not be configured to support login with customized credentials." - }, - "500" : { - "description" : "NiFi Registry was unable to complete the request because an unexpected error occurred." - } - } - } - }, - "/access/token/identity-provider/test" : { - "post" : { - "tags" : [ "access" ], - "summary" : "Test identity provider", - "description" : "Tests the format of the credentials against this identity provider without preforming authentication on the credentials to validate them. The user credentials should be passed in a format understood by the custom identity provider as defined by 'GET /access/token/identity-provider/usage'.", - "operationId" : "testIdentityProviderRecognizesCredentialsFormat", - "consumes" : [ "*/*" ], - "produces" : [ "text/plain" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "The format of the credentials were not recognized by the currently configured identity provider." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid. The NiFi Registry may not be configured to support login with customized credentials." - }, - "500" : { - "description" : "NiFi Registry was unable to complete the request because an unexpected error occurred." - } - } - } - }, - "/access/token/identity-provider/usage" : { - "get" : { - "tags" : [ "access" ], - "summary" : "Get identity provider usage", - "description" : "Provides a description of how the currently configured identity provider expects credentials to be passed to POST /access/token/identity-provider", - "operationId" : "getIdentityProviderUsageInstructions", - "consumes" : [ "*/*" ], - "produces" : [ "text/plain" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid. The NiFi Registry may not be configured to support login with customized credentials." - }, - "500" : { - "description" : "NiFi Registry was unable to complete the request because an unexpected error occurred." - } - } - } - }, - "/access/token/kerberos" : { - "post" : { - "tags" : [ "access" ], - "summary" : "Create token using kerberos", - "description" : "Creates a token for accessing the REST API via Kerberos Service Tickets or SPNEGO Tokens (which includes Kerberos Service Tickets). The token returned is formatted as a JSON Web Token (JWT). The token is base64 encoded and comprised of three parts. The header, the body, and the signature. The expiration of the token is a contained within the body. The token can be used in the Authorization header in the format 'Authorization: Bearer '.", - "operationId" : "createAccessTokenUsingKerberosTicket", - "consumes" : [ "*/*" ], - "produces" : [ "text/plain" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid. The NiFi Registry may not be configured to support login Kerberos credentials." - }, - "500" : { - "description" : "NiFi Registry was unable to complete the request because an unexpected error occurred." - } - } - } - }, - "/access/token/login" : { - "post" : { - "tags" : [ "access" ], - "summary" : "Create token using basic auth", - "description" : "Creates a token for accessing the REST API via username/password. The user credentials must be passed in standard HTTP Basic Auth format. That is: 'Authorization: Basic ', where is the base64 encoded value of ':'. The token returned is formatted as a JSON Web Token (JWT). The token is base64 encoded and comprised of three parts. The header, the body, and the signature. The expiration of the token is a contained within the body. The token can be used in the Authorization header in the format 'Authorization: Bearer '.", - "operationId" : "createAccessTokenUsingBasicAuthCredentials", - "consumes" : [ "*/*" ], - "produces" : [ "text/plain" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid. The NiFi Registry may not be configured to support login with username/password." - }, - "500" : { - "description" : "NiFi Registry was unable to complete the request because an unexpected error occurred." - } - }, - "security" : [ { - "BasicAuth" : [ ] - } ] - } - }, - "/buckets" : { - "get" : { - "tags" : [ "buckets" ], - "summary" : "Get all buckets", - "description" : "The returned list will include only buckets for which the user is authorized.If the user is not authorized for any buckets, this returns an empty list.", - "operationId" : "getBuckets", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/Bucket" - } - } - }, - "401" : { - "description" : "Client could not be authenticated." - } - }, - "security" : [ { - "Authorization" : [ ] - } ] - }, - "post" : { - "tags" : [ "buckets" ], - "summary" : "Create bucket", - "description" : "", - "operationId" : "createBucket", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The bucket to create", - "required" : true, - "schema" : { - "$ref" : "#/definitions/Bucket" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/Bucket" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets", - "action" : "write" - } - } - }, - "/buckets/fields" : { - "get" : { - "tags" : [ "buckets" ], - "summary" : "Get bucket fields", - "description" : "Retrieves bucket field names for searching or sorting on buckets.", - "operationId" : "getAvailableBucketFields", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/Fields" - } - } - }, - "security" : [ { - "Authorization" : [ ] - } ] - } - }, - "/buckets/{bucketId}" : { - "get" : { - "tags" : [ "buckets" ], - "summary" : "Get bucket", - "description" : "Gets the bucket with the given id.", - "operationId" : "getBucket", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketId", - "in" : "path", - "description" : "The bucket identifier", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/Bucket" - } - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - }, - "put" : { - "tags" : [ "buckets" ], - "summary" : "Update bucket", - "description" : "Updates the bucket with the given id.", - "operationId" : "updateBucket", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketId", - "in" : "path", - "description" : "The bucket identifier", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The updated bucket", - "required" : true, - "schema" : { - "$ref" : "#/definitions/Bucket" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/Bucket" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "write" - } - }, - "delete" : { - "tags" : [ "buckets" ], - "summary" : "Delete bucket", - "description" : "Deletes the bucket with the given id, along with all objects stored in the bucket", - "operationId" : "deleteBucket", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The version is used to verify the client is working with the latest version of the entity.", - "required" : false, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "bucketId", - "in" : "path", - "description" : "The bucket identifier", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/Bucket" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "delete" - } - } - }, - "/buckets/{bucketId}/bundles" : { - "get" : { - "tags" : [ "bucket bundles" ], - "summary" : "Get extension bundles by bucket", - "description" : "\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getExtensionBundles", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketId", - "in" : "path", - "description" : "The bucket identifier", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/ExtensionBundle" - } - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/buckets/{bucketId}/bundles/{bundleType}" : { - "post" : { - "tags" : [ "bucket bundles" ], - "summary" : "Create extension bundle version", - "description" : "Creates a version of an extension bundle by uploading a binary artifact. If an extension bundle already exists in the given bucket with the same group id and artifact id as that of the bundle being uploaded, then it will be added as a new version to the existing bundle. If an extension bundle does not already exist in the given bucket with the same group id and artifact id, then a new extension bundle will be created and this version will be added to the new bundle. Client's may optionally supply a SHA-256 in hex format through the multi-part form field 'sha256'. If supplied, then this value will be compared against the SHA-256 computed by the server, and the bundle will be rejected if the values do not match. If not supplied, the bundle will be accepted, but will be marked to indicate that the client did not supply a SHA-256 during creation. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "createExtensionBundleVersion", - "consumes" : [ "multipart/form-data" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketId", - "in" : "path", - "description" : "The bucket identifier", - "required" : true, - "type" : "string" - }, { - "name" : "bundleType", - "in" : "path", - "description" : "The type of the bundle", - "required" : true, - "type" : "string", - "enum" : [ "nifi-nar", "minifi-cpp" ] - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/BundleVersion" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "write" - } - } - }, - "/buckets/{bucketId}/flows" : { - "get" : { - "tags" : [ "bucket flows" ], - "summary" : "Get bucket flows", - "description" : "Retrieves all flows in the given bucket.", - "operationId" : "getFlows", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketId", - "in" : "path", - "description" : "The bucket identifier", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/VersionedFlow" - } - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - }, - "post" : { - "tags" : [ "bucket flows" ], - "summary" : "Create flow", - "description" : "Creates a flow in the given bucket. The flow id is created by the server and populated in the returned entity.", - "operationId" : "createFlow", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketId", - "in" : "path", - "description" : "The bucket identifier", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The details of the flow to create.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/VersionedFlow" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlow" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "write" - } - } - }, - "/buckets/{bucketId}/flows/{flowId}" : { - "get" : { - "tags" : [ "bucket flows" ], - "summary" : "Get bucket flow", - "description" : "Retrieves the flow with the given id in the given bucket.", - "operationId" : "getFlow", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketId", - "in" : "path", - "description" : "The bucket identifier", - "required" : true, - "type" : "string" - }, { - "name" : "flowId", - "in" : "path", - "description" : "The flow identifier", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlow" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - }, - "put" : { - "tags" : [ "bucket flows" ], - "summary" : "Update bucket flow", - "description" : "Updates the flow with the given id in the given bucket.", - "operationId" : "updateFlow", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketId", - "in" : "path", - "description" : "The bucket identifier", - "required" : true, - "type" : "string" - }, { - "name" : "flowId", - "in" : "path", - "description" : "The flow identifier", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The updated flow", - "required" : true, - "schema" : { - "$ref" : "#/definitions/VersionedFlow" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlow" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "write" - } - }, - "delete" : { - "tags" : [ "bucket flows" ], - "summary" : "Delete bucket flow", - "description" : "Deletes a flow, including all saved versions of that flow.", - "operationId" : "deleteFlow", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The version is used to verify the client is working with the latest version of the entity.", - "required" : false, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "bucketId", - "in" : "path", - "description" : "The bucket identifier", - "required" : true, - "type" : "string" - }, { - "name" : "flowId", - "in" : "path", - "description" : "The flow identifier", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlow" - } - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "delete" - } - } - }, - "/buckets/{bucketId}/flows/{flowId}/diff/{versionA}/{versionB}" : { - "get" : { - "tags" : [ "bucket flows" ], - "summary" : "Get bucket flow diff", - "description" : "Computes the differences between two given versions of a flow.", - "operationId" : "getFlowDiff", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketId", - "in" : "path", - "description" : "The bucket identifier", - "required" : true, - "type" : "string" - }, { - "name" : "flowId", - "in" : "path", - "description" : "The flow identifier", - "required" : true, - "type" : "string" - }, { - "name" : "versionA", - "in" : "path", - "description" : "The first version number", - "required" : true, - "type" : "integer", - "pattern" : "\\d+", - "format" : "int32" - }, { - "name" : "versionB", - "in" : "path", - "description" : "The second version number", - "required" : true, - "type" : "integer", - "pattern" : "\\d+", - "format" : "int32" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlowDifference" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/buckets/{bucketId}/flows/{flowId}/versions" : { - "get" : { - "tags" : [ "bucket flows" ], - "summary" : "Get bucket flow versions", - "description" : "Gets summary information for all versions of a flow. Versions are ordered newest->oldest.", - "operationId" : "getFlowVersions", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketId", - "in" : "path", - "description" : "The bucket identifier", - "required" : true, - "type" : "string" - }, { - "name" : "flowId", - "in" : "path", - "description" : "The flow identifier", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/VersionedFlowSnapshotMetadata" - } - } - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - }, - "post" : { - "tags" : [ "bucket flows" ], - "summary" : "Create flow version", - "description" : "Creates the next version of a flow. The version number of the object being created must be the next available version integer. Flow versions are immutable after they are created.", - "operationId" : "createFlowVersion", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketId", - "in" : "path", - "description" : "The bucket identifier", - "required" : true, - "type" : "string" - }, { - "name" : "flowId", - "in" : "path", - "description" : "The flow identifier", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The new versioned flow snapshot.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/VersionedFlowSnapshot" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlowSnapshot" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "write" - } - } - }, - "/buckets/{bucketId}/flows/{flowId}/versions/latest" : { - "get" : { - "tags" : [ "bucket flows" ], - "summary" : "Get latest bucket flow version content", - "description" : "Gets the latest version of a flow, including the metadata and content of the flow.", - "operationId" : "getLatestFlowVersion", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketId", - "in" : "path", - "description" : "The bucket identifier", - "required" : true, - "type" : "string" - }, { - "name" : "flowId", - "in" : "path", - "description" : "The flow identifier", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlowSnapshot" - } - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/buckets/{bucketId}/flows/{flowId}/versions/latest/metadata" : { - "get" : { - "tags" : [ "bucket flows" ], - "summary" : "Get latest bucket flow version metadata", - "description" : "Gets the metadata for the latest version of a flow.", - "operationId" : "getLatestFlowVersionMetadata", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketId", - "in" : "path", - "description" : "The bucket identifier", - "required" : true, - "type" : "string" - }, { - "name" : "flowId", - "in" : "path", - "description" : "The flow identifier", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlowSnapshotMetadata" - } - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/buckets/{bucketId}/flows/{flowId}/versions/{versionNumber}" : { - "get" : { - "tags" : [ "bucket flows" ], - "summary" : "Get bucket flow version", - "description" : "Gets the given version of a flow, including the metadata and content for the version.", - "operationId" : "getFlowVersion", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketId", - "in" : "path", - "description" : "The bucket identifier", - "required" : true, - "type" : "string" - }, { - "name" : "flowId", - "in" : "path", - "description" : "The flow identifier", - "required" : true, - "type" : "string" - }, { - "name" : "versionNumber", - "in" : "path", - "description" : "The version number", - "required" : true, - "type" : "integer", - "pattern" : "\\d+", - "format" : "int32" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlowSnapshot" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/bundles" : { - "get" : { - "tags" : [ "bundles" ], - "summary" : "Get all bundles", - "description" : "Gets the metadata for all bundles across all authorized buckets with optional filters applied. The returned results will include only items from buckets for which the user is authorized. If the user is not authorized to any buckets, an empty list will be returned. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getBundles", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketName", - "in" : "query", - "description" : "Optional bucket name to filter results. The value may be an exact match, or a wildcard, such as 'My Bucket%' to select all bundles where the bucket name starts with 'My Bucket'.", - "required" : false, - "type" : "string" - }, { - "name" : "groupId", - "in" : "query", - "description" : "Optional groupId to filter results. The value may be an exact match, or a wildcard, such as 'com.%' to select all bundles where the groupId starts with 'com.'.", - "required" : false, - "type" : "string" - }, { - "name" : "artifactId", - "in" : "query", - "description" : "Optional artifactId to filter results. The value may be an exact match, or a wildcard, such as 'nifi-%' to select all bundles where the artifactId starts with 'nifi-'.", - "required" : false, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/ExtensionBundle" - } - } - }, - "401" : { - "description" : "Client could not be authenticated." - } - }, - "security" : [ { - "Authorization" : [ ] - } ] - } - }, - "/bundles/versions" : { - "get" : { - "tags" : [ "bundles" ], - "summary" : "Get all bundle versions", - "description" : "Gets the metadata about extension bundle versions across all authorized buckets with optional filters applied. If the user is not authorized to any buckets, an empty list will be returned. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getBundleVersions", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "groupId", - "in" : "query", - "description" : "Optional groupId to filter results. The value may be an exact match, or a wildcard, such as 'com.%' to select all bundle versions where the groupId starts with 'com.'.", - "required" : false, - "type" : "string" - }, { - "name" : "artifactId", - "in" : "query", - "description" : "Optional artifactId to filter results. The value may be an exact match, or a wildcard, such as 'nifi-%' to select all bundle versions where the artifactId starts with 'nifi-'.", - "required" : false, - "type" : "string" - }, { - "name" : "version", - "in" : "query", - "description" : "Optional version to filter results. The value maye be an exact match, or a wildcard, such as '1.0.%' to select all bundle versions where the version starts with '1.0.'.", - "required" : false, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/BundleVersionMetadata" - } - } - }, - "401" : { - "description" : "Client could not be authenticated." - } - }, - "security" : [ { - "Authorization" : [ ] - } ] - } - }, - "/bundles/{bundleId}" : { - "get" : { - "tags" : [ "bundles" ], - "summary" : "Get bundle", - "description" : "Gets the metadata about an extension bundle. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "globalGetExtensionBundle", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bundleId", - "in" : "path", - "description" : "The extension bundle identifier", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ExtensionBundle" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - }, - "delete" : { - "tags" : [ "bundles" ], - "summary" : "Delete bundle", - "description" : "Deletes the given extension bundle and all of it's versions. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "globalDeleteExtensionBundle", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bundleId", - "in" : "path", - "description" : "The extension bundle identifier", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ExtensionBundle" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "write" - } - } - }, - "/bundles/{bundleId}/versions" : { - "get" : { - "tags" : [ "bundles" ], - "summary" : "Get bundle versions", - "description" : "Gets the metadata for the versions of the given extension bundle. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "globalGetBundleVersions", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bundleId", - "in" : "path", - "description" : "The extension bundle identifier", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/BundleVersionMetadata" - } - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/bundles/{bundleId}/versions/{version}" : { - "get" : { - "tags" : [ "bundles" ], - "summary" : "Get bundle version", - "description" : "Gets the descriptor for the given version of the given extension bundle. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "globalGetBundleVersion", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bundleId", - "in" : "path", - "description" : "The extension bundle identifier", - "required" : true, - "type" : "string" - }, { - "name" : "version", - "in" : "path", - "description" : "The version of the bundle", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/BundleVersion" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - }, - "delete" : { - "tags" : [ "bundles" ], - "summary" : "Delete bundle version", - "description" : "Deletes the given extension bundle version and it's associated binary content. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "globalDeleteBundleVersion", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bundleId", - "in" : "path", - "description" : "The extension bundle identifier", - "required" : true, - "type" : "string" - }, { - "name" : "version", - "in" : "path", - "description" : "The version of the bundle", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/BundleVersion" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "write" - } - } - }, - "/bundles/{bundleId}/versions/{version}/content" : { - "get" : { - "tags" : [ "bundles" ], - "summary" : "Get bundle version content", - "description" : "Gets the binary content for the given version of the given extension bundle. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "globalGetBundleVersionContent", - "consumes" : [ "*/*" ], - "produces" : [ "application/octet-stream" ], - "parameters" : [ { - "name" : "bundleId", - "in" : "path", - "description" : "The extension bundle identifier", - "required" : true, - "type" : "string" - }, { - "name" : "version", - "in" : "path", - "description" : "The version of the bundle", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "type" : "string", - "format" : "byte" - } - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/bundles/{bundleId}/versions/{version}/extensions" : { - "get" : { - "tags" : [ "bundles" ], - "summary" : "Get bundle version extensions", - "description" : "Gets the metadata about the extensions in the given extension bundle version. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "globalGetBundleVersionExtensions", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bundleId", - "in" : "path", - "description" : "The extension bundle identifier", - "required" : true, - "type" : "string" - }, { - "name" : "version", - "in" : "path", - "description" : "The version of the bundle", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/ExtensionMetadata" - } - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/bundles/{bundleId}/versions/{version}/extensions/{name}" : { - "get" : { - "tags" : [ "bundles" ], - "summary" : "Get bundle version extension", - "description" : "Gets the metadata about the extension with the given name in the given extension bundle version. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "globalGetBundleVersionExtension", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bundleId", - "in" : "path", - "description" : "The extension bundle identifier", - "required" : true, - "type" : "string" - }, { - "name" : "version", - "in" : "path", - "description" : "The version of the bundle", - "required" : true, - "type" : "string" - }, { - "name" : "name", - "in" : "path", - "description" : "The fully qualified name of the extension", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/Extension" - } - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/bundles/{bundleId}/versions/{version}/extensions/{name}/docs" : { - "get" : { - "tags" : [ "bundles" ], - "summary" : "Get bundle version extension docs", - "description" : "Gets the documentation for the given extension in the given extension bundle version. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getBundleVersionExtensionDocs", - "consumes" : [ "*/*" ], - "produces" : [ "text/html" ], - "parameters" : [ { - "name" : "bundleId", - "in" : "path", - "description" : "The extension bundle identifier", - "required" : true, - "type" : "string" - }, { - "name" : "version", - "in" : "path", - "description" : "The version of the bundle", - "required" : true, - "type" : "string" - }, { - "name" : "name", - "in" : "path", - "description" : "The fully qualified name of the extension", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/bundles/{bundleId}/versions/{version}/extensions/{name}/docs/additional-details" : { - "get" : { - "tags" : [ "bundles" ], - "summary" : "Get bundle version extension docs details", - "description" : "Gets the additional details documentation for the given extension in the given extension bundle version. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getBundleVersionExtensionAdditionalDetailsDocs", - "consumes" : [ "*/*" ], - "produces" : [ "text/html" ], - "parameters" : [ { - "name" : "bundleId", - "in" : "path", - "description" : "The extension bundle identifier", - "required" : true, - "type" : "string" - }, { - "name" : "version", - "in" : "path", - "description" : "The version of the bundle", - "required" : true, - "type" : "string" - }, { - "name" : "name", - "in" : "path", - "description" : "The fully qualified name of the extension", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/config" : { - "get" : { - "tags" : [ "config" ], - "summary" : "Get configration", - "description" : "Gets the NiFi Registry configurations.", - "operationId" : "getConfiguration", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/RegistryConfiguration" - } - }, - "401" : { - "description" : "Client could not be authenticated." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/policies,/tenants", - "action" : "read" - } - } - }, - "/extension-repository" : { - "get" : { - "tags" : [ "extension repository" ], - "summary" : "Get extension repo buckets", - "description" : "Gets the names of the buckets the current user is authorized for in order to browse the repo by bucket. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getExtensionRepoBuckets", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/ExtensionRepoBucket" - } - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ] - } - }, - "/extension-repository/{bucketName}" : { - "get" : { - "tags" : [ "extension repository" ], - "summary" : "Get extension repo groups", - "description" : "Gets the groups in the extension repository in the given bucket. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getExtensionRepoGroups", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketName", - "in" : "path", - "description" : "The bucket name", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/ExtensionRepoGroup" - } - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/extension-repository/{bucketName}/{groupId}" : { - "get" : { - "tags" : [ "extension repository" ], - "summary" : "Get extension repo artifacts", - "description" : "Gets the artifacts in the extension repository in the given bucket and group. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getExtensionRepoArtifacts", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketName", - "in" : "path", - "description" : "The bucket name", - "required" : true, - "type" : "string" - }, { - "name" : "groupId", - "in" : "path", - "description" : "The group id", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/ExtensionRepoArtifact" - } - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/extension-repository/{bucketName}/{groupId}/{artifactId}" : { - "get" : { - "tags" : [ "extension repository" ], - "summary" : "Get extension repo versions", - "description" : "Gets the versions in the extension repository for the given bucket, group, and artifact. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getExtensionRepoVersions", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketName", - "in" : "path", - "description" : "The bucket name", - "required" : true, - "type" : "string" - }, { - "name" : "groupId", - "in" : "path", - "description" : "The group identifier", - "required" : true, - "type" : "string" - }, { - "name" : "artifactId", - "in" : "path", - "description" : "The artifact identifier", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/ExtensionRepoVersionSummary" - } - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/extension-repository/{bucketName}/{groupId}/{artifactId}/{version}" : { - "get" : { - "tags" : [ "extension repository" ], - "summary" : "Get extension repo version", - "description" : "Gets information about the version in the given bucket, group, and artifact. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getExtensionRepoVersion", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketName", - "in" : "path", - "description" : "The bucket name", - "required" : true, - "type" : "string" - }, { - "name" : "groupId", - "in" : "path", - "description" : "The group identifier", - "required" : true, - "type" : "string" - }, { - "name" : "artifactId", - "in" : "path", - "description" : "The artifact identifier", - "required" : true, - "type" : "string" - }, { - "name" : "version", - "in" : "path", - "description" : "The version", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ExtensionRepoVersion" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/extension-repository/{bucketName}/{groupId}/{artifactId}/{version}/content" : { - "get" : { - "tags" : [ "extension repository" ], - "summary" : "Get extension repo version content", - "description" : "Gets the binary content of the bundle with the given bucket, group, artifact, and version. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getExtensionRepoVersionContent", - "consumes" : [ "*/*" ], - "produces" : [ "application/octet-stream" ], - "parameters" : [ { - "name" : "bucketName", - "in" : "path", - "description" : "The bucket name", - "required" : true, - "type" : "string" - }, { - "name" : "groupId", - "in" : "path", - "description" : "The group identifier", - "required" : true, - "type" : "string" - }, { - "name" : "artifactId", - "in" : "path", - "description" : "The artifact identifier", - "required" : true, - "type" : "string" - }, { - "name" : "version", - "in" : "path", - "description" : "The version", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "type" : "string", - "format" : "byte" - } - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/extension-repository/{bucketName}/{groupId}/{artifactId}/{version}/extensions" : { - "get" : { - "tags" : [ "extension repository" ], - "summary" : "Get extension repo extensions", - "description" : "Gets information about the extensions in the given bucket, group, artifact, and version. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getExtensionRepoVersionExtensions", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketName", - "in" : "path", - "description" : "The bucket name", - "required" : true, - "type" : "string" - }, { - "name" : "groupId", - "in" : "path", - "description" : "The group identifier", - "required" : true, - "type" : "string" - }, { - "name" : "artifactId", - "in" : "path", - "description" : "The artifact identifier", - "required" : true, - "type" : "string" - }, { - "name" : "version", - "in" : "path", - "description" : "The version", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/ExtensionMetadata" - } - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/extension-repository/{bucketName}/{groupId}/{artifactId}/{version}/extensions/{name}" : { - "get" : { - "tags" : [ "extension repository" ], - "summary" : "Get extension repo extension", - "description" : "Gets information about the extension with the given name in the given bucket, group, artifact, and version. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getExtensionRepoVersionExtension", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketName", - "in" : "path", - "description" : "The bucket name", - "required" : true, - "type" : "string" - }, { - "name" : "groupId", - "in" : "path", - "description" : "The group identifier", - "required" : true, - "type" : "string" - }, { - "name" : "artifactId", - "in" : "path", - "description" : "The artifact identifier", - "required" : true, - "type" : "string" - }, { - "name" : "version", - "in" : "path", - "description" : "The version", - "required" : true, - "type" : "string" - }, { - "name" : "name", - "in" : "path", - "description" : "The fully qualified name of the extension", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/Extension" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/extension-repository/{bucketName}/{groupId}/{artifactId}/{version}/extensions/{name}/docs" : { - "get" : { - "tags" : [ "extension repository" ], - "summary" : "Get extension repo extension docs", - "description" : "Gets the documentation for the extension with the given name in the given bucket, group, artifact, and version. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getExtensionRepoVersionExtensionDocs", - "consumes" : [ "*/*" ], - "produces" : [ "text/html" ], - "parameters" : [ { - "name" : "bucketName", - "in" : "path", - "description" : "The bucket name", - "required" : true, - "type" : "string" - }, { - "name" : "groupId", - "in" : "path", - "description" : "The group identifier", - "required" : true, - "type" : "string" - }, { - "name" : "artifactId", - "in" : "path", - "description" : "The artifact identifier", - "required" : true, - "type" : "string" - }, { - "name" : "version", - "in" : "path", - "description" : "The version", - "required" : true, - "type" : "string" - }, { - "name" : "name", - "in" : "path", - "description" : "The fully qualified name of the extension", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/extension-repository/{bucketName}/{groupId}/{artifactId}/{version}/extensions/{name}/docs/additional-details" : { - "get" : { - "tags" : [ "extension repository" ], - "summary" : "Get extension repo extension details", - "description" : "Gets the additional details documentation for the extension with the given name in the given bucket, group, artifact, and version. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getExtensionRepoVersionExtensionAdditionalDetailsDocs", - "consumes" : [ "*/*" ], - "produces" : [ "text/html" ], - "parameters" : [ { - "name" : "bucketName", - "in" : "path", - "description" : "The bucket name", - "required" : true, - "type" : "string" - }, { - "name" : "groupId", - "in" : "path", - "description" : "The group identifier", - "required" : true, - "type" : "string" - }, { - "name" : "artifactId", - "in" : "path", - "description" : "The artifact identifier", - "required" : true, - "type" : "string" - }, { - "name" : "version", - "in" : "path", - "description" : "The version", - "required" : true, - "type" : "string" - }, { - "name" : "name", - "in" : "path", - "description" : "The fully qualified name of the extension", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/extension-repository/{bucketName}/{groupId}/{artifactId}/{version}/sha256" : { - "get" : { - "tags" : [ "extension repository" ], - "summary" : "Get extension repo version checksum", - "description" : "Gets the hex representation of the SHA-256 digest for the binary content of the bundle with the given bucket, group, artifact, and version.\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getExtensionRepoVersionSha256", - "consumes" : [ "*/*" ], - "produces" : [ "text/plain" ], - "parameters" : [ { - "name" : "bucketName", - "in" : "path", - "description" : "The bucket name", - "required" : true, - "type" : "string" - }, { - "name" : "groupId", - "in" : "path", - "description" : "The group identifier", - "required" : true, - "type" : "string" - }, { - "name" : "artifactId", - "in" : "path", - "description" : "The artifact identifier", - "required" : true, - "type" : "string" - }, { - "name" : "version", - "in" : "path", - "description" : "The version", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/extension-repository/{groupId}/{artifactId}/{version}/sha256" : { - "get" : { - "tags" : [ "extension repository" ], - "summary" : "Get global extension repo version checksum", - "description" : "Gets the hex representation of the SHA-256 digest for the binary content with the given bucket, group, artifact, and version. Since the same group-artifact-version can exist in multiple buckets, this will return the checksum of the first one returned. This will be consistent since the checksum must be the same when existing in multiple buckets. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getGlobalExtensionRepoVersionSha256", - "consumes" : [ "*/*" ], - "produces" : [ "text/plain" ], - "parameters" : [ { - "name" : "groupId", - "in" : "path", - "description" : "The group identifier", - "required" : true, - "type" : "string" - }, { - "name" : "artifactId", - "in" : "path", - "description" : "The artifact identifier", - "required" : true, - "type" : "string" - }, { - "name" : "version", - "in" : "path", - "description" : "The version", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ] - } - }, - "/extensions" : { - "get" : { - "tags" : [ "extensions" ], - "summary" : "Get all extensions", - "description" : "Gets the metadata for all extensions that match the filter params and are part of bundles located in buckets the current user is authorized for. If the user is not authorized to any buckets, an empty result set will be returned.\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getExtensions", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bundleType", - "in" : "query", - "description" : "The type of bundles to return", - "required" : false, - "type" : "string", - "enum" : [ "nifi-nar", "minifi-cpp" ] - }, { - "name" : "extensionType", - "in" : "query", - "description" : "The type of extensions to return", - "required" : false, - "type" : "string", - "enum" : [ "PROCESSOR", "CONTROLLER_SERVICE", "REPORTING_TASK" ] - }, { - "name" : "tag", - "in" : "query", - "description" : "The tags to filter on, will be used in an OR statement", - "required" : false, - "type" : "array", - "items" : { - "type" : "string" - }, - "collectionFormat" : "multi" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ExtensionMetadataContainer" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ] - } - }, - "/extensions/provided-service-api" : { - "get" : { - "tags" : [ "extensions" ], - "summary" : "Get extensions providing service API", - "description" : "Gets the metadata for extensions that provide the specified API and are part of bundles located in buckets the current user is authorized for. If the user is not authorized to any buckets, an empty result set will be returned.\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getExtensionsProvidingServiceAPI", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "className", - "in" : "query", - "description" : "The name of the service API class", - "required" : true, - "type" : "string" - }, { - "name" : "groupId", - "in" : "query", - "description" : "The groupId of the bundle containing the service API class", - "required" : true, - "type" : "string" - }, { - "name" : "artifactId", - "in" : "query", - "description" : "The artifactId of the bundle containing the service API class", - "required" : true, - "type" : "string" - }, { - "name" : "version", - "in" : "query", - "description" : "The version of the bundle containing the service API class", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ExtensionMetadataContainer" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ] - } - }, - "/extensions/tags" : { - "get" : { - "tags" : [ "extensions" ], - "summary" : "Get extension tags", - "description" : "Gets all the extension tags known to this NiFi Registry instance, along with the number of extensions that have the given tag.\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getTags", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/TagCount" - } - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ] - } - }, - "/flows/fields" : { - "get" : { - "tags" : [ "flows" ], - "summary" : "Get flow fields", - "description" : "Retrieves the flow field names that can be used for searching or sorting on flows.", - "operationId" : "getAvailableFlowFields", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/Fields" - } - } - }, - "security" : [ { - "Authorization" : [ ] - } ] - } - }, - "/flows/{flowId}" : { - "get" : { - "tags" : [ "flows" ], - "summary" : "Get flow", - "description" : "Gets a flow by id.", - "operationId" : "globalGetFlow", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "flowId", - "in" : "path", - "description" : "The flow identifier", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlow" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/flows/{flowId}/versions" : { - "get" : { - "tags" : [ "flows" ], - "summary" : "Get flow versions", - "description" : "Gets summary information for all versions of a given flow. Versions are ordered newest->oldest.", - "operationId" : "globalGetFlowVersions", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "flowId", - "in" : "path", - "description" : "The flow identifier", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/VersionedFlowSnapshotMetadata" - } - } - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/flows/{flowId}/versions/latest" : { - "get" : { - "tags" : [ "flows" ], - "summary" : "Get latest flow version", - "description" : "Gets the latest version of a flow, including metadata and flow content.", - "operationId" : "globalGetLatestFlowVersion", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "flowId", - "in" : "path", - "description" : "The flow identifier", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlowSnapshot" - } - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/flows/{flowId}/versions/latest/metadata" : { - "get" : { - "tags" : [ "flows" ], - "summary" : "Get latest flow version metadata", - "description" : "Gets the metadata for the latest version of a flow.", - "operationId" : "globalGetLatestFlowVersionMetadata", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "flowId", - "in" : "path", - "description" : "The flow identifier", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlowSnapshotMetadata" - } - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/flows/{flowId}/versions/{versionNumber}" : { - "get" : { - "tags" : [ "flows" ], - "summary" : "Get flow version", - "description" : "Gets the given version of a flow, including metadata and flow content.", - "operationId" : "globalGetFlowVersion", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "flowId", - "in" : "path", - "description" : "The flow identifier", - "required" : true, - "type" : "string" - }, { - "name" : "versionNumber", - "in" : "path", - "description" : "The version number", - "required" : true, - "type" : "integer", - "pattern" : "\\d+", - "format" : "int32" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlowSnapshot" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/items" : { - "get" : { - "tags" : [ "items" ], - "summary" : "Get all items", - "description" : "Get items across all buckets. The returned items will include only items from buckets for which the user is authorized. If the user is not authorized to any buckets, an empty list will be returned.", - "operationId" : "getItems", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/BucketItem" - } - } - }, - "401" : { - "description" : "Client could not be authenticated." - } - }, - "security" : [ { - "Authorization" : [ ] - } ] - } - }, - "/items/fields" : { - "get" : { - "tags" : [ "items" ], - "summary" : "Get item fields", - "description" : "Retrieves the item field names for searching or sorting on bucket items.", - "operationId" : "getAvailableBucketItemFields", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/Fields" - } - } - }, - "security" : [ { - "Authorization" : [ ] - } ] - } - }, - "/items/{bucketId}" : { - "get" : { - "tags" : [ "items" ], - "summary" : "Get bucket items", - "description" : "Gets the items located in the given bucket.", - "operationId" : "getItemsInBucket", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketId", - "in" : "path", - "description" : "The bucket identifier", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/BucketItem" - } - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/policies" : { - "get" : { - "tags" : [ "policies" ], - "summary" : "Get all access policies", - "description" : "", - "operationId" : "getAccessPolicies", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/AccessPolicy" - } - } - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/policies", - "action" : "read" - } - }, - "post" : { - "tags" : [ "policies" ], - "summary" : "Create access policy", - "description" : "", - "operationId" : "createAccessPolicy", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The access policy configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/AccessPolicy" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/AccessPolicy" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid. The NiFi Registry might not be configured to use a ConfigurableAccessPolicyProvider." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/policies", - "action" : "write" - } - } - }, - "/policies/resources" : { - "get" : { - "tags" : [ "policies" ], - "summary" : "Get available resources", - "description" : "Gets the available resources that support access/authorization policies", - "operationId" : "getResources", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/Resource" - } - } - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/policies", - "action" : "read" - } - } - }, - "/policies/{action}/{resource}" : { - "get" : { - "tags" : [ "policies" ], - "summary" : "Get access policy for resource", - "description" : "Gets an access policy for the specified action and resource", - "operationId" : "getAccessPolicyForResource", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "action", - "in" : "path", - "description" : "The request action.", - "required" : true, - "type" : "string", - "enum" : [ "read", "write", "delete" ] - }, { - "name" : "resource", - "in" : "path", - "description" : "The resource of the policy.", - "required" : true, - "type" : "string", - "pattern" : ".+" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/AccessPolicy" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/policies", - "action" : "read" - } - } - }, - "/policies/{id}" : { - "get" : { - "tags" : [ "policies" ], - "summary" : "Get access policy", - "description" : "", - "operationId" : "getAccessPolicy", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The access policy id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/AccessPolicy" - } - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/policies", - "action" : "read" - } - }, - "put" : { - "tags" : [ "policies" ], - "summary" : "Update access policy", - "description" : "", - "operationId" : "updateAccessPolicy", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The access policy id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The access policy configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/AccessPolicy" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/AccessPolicy" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid. The NiFi Registry might not be configured to use a ConfigurableAccessPolicyProvider." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/policies", - "action" : "write" - } - }, - "delete" : { - "tags" : [ "policies" ], - "summary" : "Delete access policy", - "description" : "", - "operationId" : "removeAccessPolicy", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The version is used to verify the client is working with the latest version of the entity.", - "required" : false, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The access policy id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/AccessPolicy" - } - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid. The NiFi Registry might not be configured to use a ConfigurableAccessPolicyProvider." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/policies", - "action" : "delete" - } - } - }, - "/tenants/user-groups" : { - "get" : { - "tags" : [ "tenants" ], - "summary" : "Get user groups", - "description" : "\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getUserGroups", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/UserGroup" - } - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/tenants", - "action" : "read" - } - }, - "post" : { - "tags" : [ "tenants" ], - "summary" : "Create user group", - "description" : "\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "createUserGroup", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The user group configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/UserGroup" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/UserGroup" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/tenants", - "action" : "write" - } - } - }, - "/tenants/user-groups/{id}" : { - "get" : { - "tags" : [ "tenants" ], - "summary" : "Get user group", - "description" : "\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getUserGroup", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The user group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/UserGroup" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/tenants", - "action" : "read" - } - }, - "put" : { - "tags" : [ "tenants" ], - "summary" : "Update user group", - "description" : "\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "updateUserGroup", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The user group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The user group configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/UserGroup" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/UserGroup" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/tenants", - "action" : "write" - } - }, - "delete" : { - "tags" : [ "tenants" ], - "summary" : "Delete user group", - "description" : "\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "removeUserGroup", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The version is used to verify the client is working with the latest version of the entity.", - "required" : false, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The user group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/UserGroup" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/tenants", - "action" : "delete" - } - } - }, - "/tenants/users" : { - "get" : { - "tags" : [ "tenants" ], - "summary" : "Get all users", - "description" : "\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getUsers", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/User" - } - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/tenants", - "action" : "read" - } - }, - "post" : { - "tags" : [ "tenants" ], - "summary" : "Create user", - "description" : "\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "createUser", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The user configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/User" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/User" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/tenants", - "action" : "write" - } - } - }, - "/tenants/users/{id}" : { - "get" : { - "tags" : [ "tenants" ], - "summary" : "Get user", - "description" : "\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getUser", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The user id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/User" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/tenants", - "action" : "read" - } - }, - "put" : { - "tags" : [ "tenants" ], - "summary" : "Update user", - "description" : "\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "updateUser", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The user id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The user configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/User" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/User" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/tenants", - "action" : "write" - } - }, - "delete" : { - "tags" : [ "tenants" ], - "summary" : "Delete user", - "description" : "\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "removeUser", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The version is used to verify the client is working with the latest version of the entity.", - "required" : false, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The user id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/User" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/tenants", - "action" : "delete" - } - } - } - }, - "securityDefinitions" : { - "Authorization" : { - "description" : "NiFi Registry Auth Token (JWT)", - "type" : "apiKey", - "name" : "Authorization", - "in" : "header" - }, - "BasicAuth" : { - "description" : "HTTP Basic Auth", - "type" : "basic" - } - }, - "definitions" : { - "AccessPolicy" : { - "type" : "object", - "required" : [ "action", "resource" ], - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The id of the policy. Set by server at creation time.", - "readOnly" : true - }, - "resource" : { - "type" : "string", - "description" : "The resource for this access policy." - }, - "action" : { - "type" : "string", - "description" : "The action associated with this access policy.", - "enum" : [ "read", "write", "delete" ] - }, - "configurable" : { - "type" : "boolean", - "description" : "Indicates if this access policy is configurable, based on which Authorizer has been configured to manage it.", - "readOnly" : true - }, - "revision" : { - "description" : "The revision of this entity used for optimistic-locking during updates.", - "readOnly" : true, - "$ref" : "#/definitions/RevisionInfo" - }, - "users" : { - "type" : "array", - "description" : "The set of user IDs associated with this access policy.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/Tenant" - } - }, - "userGroups" : { - "type" : "array", - "description" : "The set of user group IDs associated with this access policy.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/Tenant" - } - } - } - }, - "AccessPolicySummary" : { - "type" : "object", - "required" : [ "action", "resource" ], - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The id of the policy. Set by server at creation time.", - "readOnly" : true - }, - "resource" : { - "type" : "string", - "description" : "The resource for this access policy." - }, - "action" : { - "type" : "string", - "description" : "The action associated with this access policy.", - "enum" : [ "read", "write", "delete" ] - }, - "configurable" : { - "type" : "boolean", - "description" : "Indicates if this access policy is configurable, based on which Authorizer has been configured to manage it.", - "readOnly" : true - }, - "revision" : { - "description" : "The revision of this entity used for optimistic-locking during updates.", - "readOnly" : true, - "$ref" : "#/definitions/RevisionInfo" - } - } - }, - "AllowableValue" : { - "type" : "object", - "properties" : { - "value" : { - "type" : "string", - "description" : "The value of the allowable value" - }, - "displayName" : { - "type" : "string", - "description" : "The display name of the allowable value" - }, - "description" : { - "type" : "string", - "description" : "The description of the allowable value" - } - } - }, - "Attribute" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The name of the attribute" - }, - "description" : { - "type" : "string", - "description" : "The description of the attribute" - } - } - }, - "BatchSize" : { - "type" : "object", - "properties" : { - "count" : { - "type" : "integer", - "format" : "int32", - "description" : "Preferred number of flow files to include in a transaction." - }, - "size" : { - "type" : "string", - "description" : "Preferred number of bytes to include in a transaction." - }, - "duration" : { - "type" : "string", - "description" : "Preferred amount of time that a transaction should span." - } - } - }, - "Bucket" : { - "type" : "object", - "required" : [ "name" ], - "properties" : { - "link" : { - "description" : "An WebLink to this entity.", - "readOnly" : true, - "$ref" : "#/definitions/JaxbLink" - }, - "identifier" : { - "type" : "string", - "description" : "An ID to uniquely identify this object.", - "readOnly" : true - }, - "name" : { - "type" : "string", - "description" : "The name of the bucket." - }, - "createdTimestamp" : { - "type" : "integer", - "format" : "int64", - "description" : "The timestamp of when the bucket was first created. This is set by the server at creation time.", - "readOnly" : true, - "minimum" : 1 - }, - "description" : { - "type" : "string", - "description" : "A description of the bucket." - }, - "allowBundleRedeploy" : { - "type" : "boolean", - "description" : "Indicates if this bucket allows the same version of an extension bundle to be redeployed and thus overwrite the existing artifact. By default this is false." - }, - "allowPublicRead" : { - "type" : "boolean", - "description" : "Indicates if this bucket allows read access to unauthenticated anonymous users" - }, - "permissions" : { - "description" : "The access that the current user has to this bucket.", - "readOnly" : true, - "$ref" : "#/definitions/Permissions" - }, - "revision" : { - "description" : "The revision of this entity used for optimistic-locking during updates.", - "readOnly" : true, - "$ref" : "#/definitions/RevisionInfo" - } - } - }, - "BucketItem" : { - "type" : "object", - "required" : [ "bucketIdentifier", "name", "type" ], - "properties" : { - "link" : { - "description" : "An WebLink to this entity.", - "readOnly" : true, - "$ref" : "#/definitions/JaxbLink" - }, - "identifier" : { - "type" : "string", - "description" : "An ID to uniquely identify this object.", - "readOnly" : true - }, - "name" : { - "type" : "string", - "description" : "The name of the item." - }, - "description" : { - "type" : "string", - "description" : "A description of the item." - }, - "bucketIdentifier" : { - "type" : "string", - "description" : "The identifier of the bucket this items belongs to. This cannot be changed after the item is created." - }, - "bucketName" : { - "type" : "string", - "description" : "The name of the bucket this items belongs to.", - "readOnly" : true - }, - "createdTimestamp" : { - "type" : "integer", - "format" : "int64", - "description" : "The timestamp of when the item was created, as milliseconds since epoch.", - "readOnly" : true, - "minimum" : 1 - }, - "modifiedTimestamp" : { - "type" : "integer", - "format" : "int64", - "description" : "The timestamp of when the item was last modified, as milliseconds since epoch.", - "readOnly" : true, - "minimum" : 1 - }, - "type" : { - "type" : "string", - "description" : "The type of item.", - "enum" : [ "Flow", "Bundle" ] - }, - "permissions" : { - "description" : "The access that the current user has to the bucket containing this item.", - "readOnly" : true, - "$ref" : "#/definitions/Permissions" - } - } - }, - "BuildInfo" : { - "type" : "object", - "properties" : { - "buildTool" : { - "type" : "string", - "description" : "The tool used to build the version of the bundle" - }, - "buildFlags" : { - "type" : "string", - "description" : "The flags used to build the version of the bundle" - }, - "buildBranch" : { - "type" : "string", - "description" : "The branch used to build the version of the bundle" - }, - "buildTag" : { - "type" : "string", - "description" : "The tag used to build the version of the bundle" - }, - "buildRevision" : { - "type" : "string", - "description" : "The revision used to build the version of the bundle" - }, - "built" : { - "type" : "integer", - "format" : "int64", - "description" : "The timestamp the version of the bundle was built" - }, - "builtBy" : { - "type" : "string", - "description" : "The identity of the user that performed the build" - } - } - }, - "Bundle" : { - "type" : "object", - "properties" : { - "group" : { - "type" : "string", - "description" : "The group of the bundle" - }, - "artifact" : { - "type" : "string", - "description" : "The artifact of the bundle" - }, - "version" : { - "type" : "string", - "description" : "The version of the bundle" - } - } - }, - "BundleInfo" : { - "type" : "object", - "properties" : { - "bucketId" : { - "type" : "string", - "description" : "The id of the bucket where the bundle is located" - }, - "bucketName" : { - "type" : "string", - "description" : "The name of the bucket where the bundle is located" - }, - "bundleId" : { - "type" : "string", - "description" : "The id of the bundle" - }, - "bundleType" : { - "type" : "string", - "description" : "The type of bundle (i.e. a NiFi NAR vs MiNiFi CPP)", - "enum" : [ "NIFI_NAR", "MINIFI_CPP" ] - }, - "groupId" : { - "type" : "string", - "description" : "The group id of the bundle" - }, - "artifactId" : { - "type" : "string", - "description" : "The artifact id of the bundle" - }, - "version" : { - "type" : "string", - "description" : "The version of the bundle" - }, - "systemApiVersion" : { - "type" : "string", - "description" : "The version of the system API the bundle was built against" - } - } - }, - "BundleVersion" : { - "type" : "object", - "required" : [ "versionMetadata" ], - "properties" : { - "link" : { - "description" : "An WebLink to this entity.", - "readOnly" : true, - "$ref" : "#/definitions/JaxbLink" - }, - "versionMetadata" : { - "description" : "The metadata about this version of the extension bundle", - "$ref" : "#/definitions/BundleVersionMetadata" - }, - "dependencies" : { - "type" : "array", - "description" : "The set of other bundle versions that this version is dependent on", - "readOnly" : true, - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/BundleVersionDependency" - } - }, - "bundle" : { - "description" : "The bundle this version is for", - "readOnly" : true, - "$ref" : "#/definitions/ExtensionBundle" - }, - "bucket" : { - "description" : "The bucket that the extension bundle belongs to", - "$ref" : "#/definitions/Bucket" - }, - "filename" : { - "type" : "string" - } - } - }, - "BundleVersionDependency" : { - "type" : "object", - "properties" : { - "groupId" : { - "type" : "string", - "description" : "The group id of the bundle dependency" - }, - "artifactId" : { - "type" : "string", - "description" : "The artifact id of the bundle dependency" - }, - "version" : { - "type" : "string", - "description" : "The version of the bundle dependency" - } - } - }, - "BundleVersionMetadata" : { - "type" : "object", - "required" : [ "bucketId", "buildInfo", "contentSize", "sha256Supplied" ], - "properties" : { - "link" : { - "description" : "An WebLink to this entity.", - "readOnly" : true, - "$ref" : "#/definitions/JaxbLink" - }, - "id" : { - "type" : "string", - "description" : "The id of this version of the extension bundle" - }, - "bundleId" : { - "type" : "string", - "description" : "The id of the extension bundle this version is for" - }, - "bucketId" : { - "type" : "string", - "description" : "The id of the bucket the extension bundle belongs to" - }, - "version" : { - "type" : "string", - "description" : "The version of the extension bundle" - }, - "timestamp" : { - "type" : "integer", - "format" : "int64", - "description" : "The timestamp of the create date of this version", - "minimum" : 1 - }, - "author" : { - "type" : "string", - "description" : "The identity that created this version" - }, - "description" : { - "type" : "string", - "description" : "The description for this version" - }, - "sha256" : { - "type" : "string", - "description" : "The hex representation of the SHA-256 digest of the binary content for this version" - }, - "sha256Supplied" : { - "type" : "boolean", - "description" : "Whether or not the client supplied a SHA-256 when uploading the bundle" - }, - "contentSize" : { - "type" : "integer", - "format" : "int64", - "description" : "The size of the binary content for this version in bytes", - "minimum" : 0 - }, - "systemApiVersion" : { - "type" : "string", - "description" : "The version of the system API that this bundle version was built against" - }, - "buildInfo" : { - "description" : "The build information about this version", - "$ref" : "#/definitions/BuildInfo" - } - } - }, - "ComponentDifference" : { - "type" : "object", - "properties" : { - "valueA" : { - "type" : "string", - "description" : "The earlier value from the difference." - }, - "valueB" : { - "type" : "string", - "description" : "The newer value from the difference." - }, - "changeDescription" : { - "type" : "string", - "description" : "The description of the change." - }, - "differenceType" : { - "type" : "string", - "description" : "The key to the difference." - }, - "differenceTypeDescription" : { - "type" : "string", - "description" : "The description of the change type." - } - } - }, - "ComponentDifferenceGroup" : { - "type" : "object", - "properties" : { - "componentId" : { - "type" : "string", - "description" : "The id of the component whose changes are grouped together." - }, - "componentName" : { - "type" : "string", - "description" : "The name of the component whose changes are grouped together." - }, - "componentType" : { - "type" : "string", - "description" : "The type of component these changes relate to." - }, - "processGroupId" : { - "type" : "string", - "description" : "The process group id for this component." - }, - "differences" : { - "type" : "array", - "description" : "The list of changes related to this component between the 2 versions.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ComponentDifference" - } - } - } - }, - "ConnectableComponent" : { - "type" : "object", - "required" : [ "groupId", "id", "type" ], - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the connectable component." - }, - "type" : { - "type" : "string", - "description" : "The type of component the connectable is.", - "enum" : [ "PROCESSOR", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "INPUT_PORT", "OUTPUT_PORT", "FUNNEL" ] - }, - "groupId" : { - "type" : "string", - "description" : "The id of the group that the connectable component resides in" - }, - "name" : { - "type" : "string", - "description" : "The name of the connectable component" - }, - "comments" : { - "type" : "string", - "description" : "The comments for the connectable component." - } - } - }, - "ControllerServiceAPI" : { - "type" : "object", - "properties" : { - "type" : { - "type" : "string", - "description" : "The fully qualified name of the service interface." - }, - "bundle" : { - "description" : "The details of the artifact that bundled this service interface.", - "$ref" : "#/definitions/Bundle" - } - } - }, - "ControllerServiceDefinition" : { - "type" : "object", - "properties" : { - "className" : { - "type" : "string", - "description" : "The class name of the service API" - }, - "groupId" : { - "type" : "string", - "description" : "The group id of the service API" - }, - "artifactId" : { - "type" : "string", - "description" : "The artifact id of the service API" - }, - "version" : { - "type" : "string", - "description" : "The version of the service API" - } - } - }, - "CurrentUser" : { - "type" : "object", - "properties" : { - "identity" : { - "type" : "string", - "description" : "The identity of the current user", - "readOnly" : true - }, - "anonymous" : { - "type" : "boolean", - "description" : "Indicates if the current user is anonymous", - "readOnly" : true - }, - "loginSupported" : { - "type" : "boolean", - "description" : "Indicates if the NiFi instance supports logging in" - }, - "resourcePermissions" : { - "description" : "The access that the current user has to top level resources", - "readOnly" : true, - "$ref" : "#/definitions/ResourcePermissions" - } - } - }, - "DeprecationNotice" : { - "type" : "object", - "properties" : { - "reason" : { - "type" : "string", - "description" : "The reason for the deprecation" - }, - "alternatives" : { - "type" : "array", - "xml" : { - "wrapped" : true - }, - "description" : "The alternatives to use", - "items" : { - "type" : "string", - "xml" : { - "name" : "alternative" - } - } - } - } - }, - "DynamicProperty" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The description of the dynamic property name" - }, - "value" : { - "type" : "string", - "description" : "The description of the dynamic property value" - }, - "description" : { - "type" : "string", - "description" : "The description of the dynamic property" - }, - "expressionLanguageScope" : { - "type" : "string", - "description" : "The scope of the expression language support", - "enum" : [ "NONE", "VARIABLE_REGISTRY", "FLOWFILE_ATTRIBUTES" ] - }, - "expressionLanguageSupported" : { - "type" : "boolean", - "description" : "Whether or not expression language is supported" - } - } - }, - "DynamicRelationship" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The description of the dynamic relationship name" - }, - "description" : { - "type" : "string", - "description" : "The description of the dynamic relationship" - } - } - }, - "Extension" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The name of the extension" - }, - "type" : { - "type" : "string", - "description" : "The type of the extension", - "enum" : [ "PROCESSOR", "CONTROLLER_SERVICE", "REPORTING_TASK" ] - }, - "deprecationNotice" : { - "description" : "The deprecation notice of the extension", - "$ref" : "#/definitions/DeprecationNotice" - }, - "description" : { - "type" : "string", - "description" : "The description of the extension" - }, - "tags" : { - "type" : "array", - "xml" : { - "wrapped" : true - }, - "description" : "The tags of the extension", - "items" : { - "type" : "string", - "xml" : { - "name" : "tag" - } - } - }, - "properties" : { - "type" : "array", - "xml" : { - "wrapped" : true - }, - "description" : "The properties of the extension", - "items" : { - "xml" : { - "name" : "property" - }, - "$ref" : "#/definitions/Property" - } - }, - "dynamicProperties" : { - "type" : "array", - "xml" : { - "wrapped" : true - }, - "description" : "The dynamic properties of the extension", - "items" : { - "xml" : { - "name" : "dynamicProperty" - }, - "$ref" : "#/definitions/DynamicProperty" - } - }, - "relationships" : { - "type" : "array", - "xml" : { - "wrapped" : true - }, - "description" : "The relationships of the extension", - "items" : { - "xml" : { - "name" : "relationship" - }, - "$ref" : "#/definitions/Relationship" - } - }, - "dynamicRelationship" : { - "description" : "The dynamic relationships of the extension", - "$ref" : "#/definitions/DynamicRelationship" - }, - "readsAttributes" : { - "type" : "array", - "xml" : { - "wrapped" : true - }, - "description" : "The attributes read from flow files by the extension", - "items" : { - "xml" : { - "name" : "readsAttribute" - }, - "$ref" : "#/definitions/Attribute" - } - }, - "writesAttributes" : { - "type" : "array", - "xml" : { - "wrapped" : true - }, - "description" : "The attributes written to flow files by the extension", - "items" : { - "xml" : { - "name" : "writesAttribute" - }, - "$ref" : "#/definitions/Attribute" - } - }, - "stateful" : { - "description" : "The information about how the extension stores state", - "$ref" : "#/definitions/Stateful" - }, - "restricted" : { - "description" : "The restrictions of the extension", - "$ref" : "#/definitions/Restricted" - }, - "inputRequirement" : { - "type" : "string", - "description" : "The input requirement of the extension", - "enum" : [ "INPUT_REQUIRED", "INPUT_ALLOWED", "INPUT_FORBIDDEN" ] - }, - "systemResourceConsiderations" : { - "type" : "array", - "xml" : { - "wrapped" : true - }, - "description" : "The resource considerations of the extension", - "items" : { - "xml" : { - "name" : "systemResourceConsideration" - }, - "$ref" : "#/definitions/SystemResourceConsideration" - } - }, - "seeAlso" : { - "type" : "array", - "xml" : { - "wrapped" : true - }, - "description" : "The names of other extensions to see", - "items" : { - "type" : "string", - "xml" : { - "name" : "see" - } - } - }, - "providedServiceAPIs" : { - "type" : "array", - "xml" : { - "wrapped" : true - }, - "description" : "The service APIs provided by this extension", - "items" : { - "xml" : { - "name" : "providedServiceAPI" - }, - "$ref" : "#/definitions/ProvidedServiceAPI" - } - } - } - }, - "ExtensionBundle" : { - "type" : "object", - "required" : [ "bucketIdentifier", "bundleType", "name", "type" ], - "properties" : { - "link" : { - "description" : "An WebLink to this entity.", - "readOnly" : true, - "$ref" : "#/definitions/JaxbLink" - }, - "identifier" : { - "type" : "string", - "description" : "An ID to uniquely identify this object.", - "readOnly" : true - }, - "name" : { - "type" : "string", - "description" : "The name of the item." - }, - "description" : { - "type" : "string", - "description" : "A description of the item." - }, - "bucketIdentifier" : { - "type" : "string", - "description" : "The identifier of the bucket this items belongs to. This cannot be changed after the item is created." - }, - "bucketName" : { - "type" : "string", - "description" : "The name of the bucket this items belongs to.", - "readOnly" : true - }, - "createdTimestamp" : { - "type" : "integer", - "format" : "int64", - "description" : "The timestamp of when the item was created, as milliseconds since epoch.", - "readOnly" : true, - "minimum" : 1 - }, - "modifiedTimestamp" : { - "type" : "integer", - "format" : "int64", - "description" : "The timestamp of when the item was last modified, as milliseconds since epoch.", - "readOnly" : true, - "minimum" : 1 - }, - "type" : { - "type" : "string", - "description" : "The type of item.", - "enum" : [ "Flow", "Bundle" ] - }, - "permissions" : { - "description" : "The access that the current user has to the bucket containing this item.", - "readOnly" : true, - "$ref" : "#/definitions/Permissions" - }, - "bundleType" : { - "type" : "string", - "description" : "The type of the extension bundle", - "enum" : [ "NIFI_NAR", "MINIFI_CPP" ] - }, - "groupId" : { - "type" : "string", - "description" : "The group id of the extension bundle" - }, - "artifactId" : { - "type" : "string", - "description" : "The artifact id of the extension bundle" - }, - "versionCount" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of versions of this extension bundle.", - "readOnly" : true, - "minimum" : 0 - } - } - }, - "ExtensionFilterParams" : { - "type" : "object", - "properties" : { - "bundleType" : { - "type" : "string", - "description" : "The type of bundle", - "enum" : [ "NIFI_NAR", "MINIFI_CPP" ] - }, - "extensionType" : { - "type" : "string", - "description" : "The type of extension", - "enum" : [ "PROCESSOR", "CONTROLLER_SERVICE", "REPORTING_TASK" ] - }, - "tags" : { - "type" : "array", - "description" : "The tags", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - } - } - }, - "ExtensionMetadata" : { - "type" : "object", - "properties" : { - "link" : { - "description" : "An WebLink to this entity.", - "readOnly" : true, - "$ref" : "#/definitions/JaxbLink" - }, - "name" : { - "type" : "string", - "description" : "The name of the extension" - }, - "displayName" : { - "type" : "string", - "description" : "The display name of the extension" - }, - "type" : { - "type" : "string", - "description" : "The type of the extension", - "enum" : [ "PROCESSOR", "CONTROLLER_SERVICE", "REPORTING_TASK" ] - }, - "description" : { - "type" : "string", - "description" : "The description of the extension" - }, - "deprecationNotice" : { - "description" : "The deprecation notice of the extension", - "$ref" : "#/definitions/DeprecationNotice" - }, - "tags" : { - "type" : "array", - "description" : "The tags of the extension", - "items" : { - "type" : "string" - } - }, - "restricted" : { - "description" : "The restrictions of the extension", - "$ref" : "#/definitions/Restricted" - }, - "providedServiceAPIs" : { - "type" : "array", - "description" : "The service APIs provided by the extension", - "items" : { - "$ref" : "#/definitions/ProvidedServiceAPI" - } - }, - "bundleInfo" : { - "description" : "The information for the bundle where this extension is located", - "$ref" : "#/definitions/BundleInfo" - }, - "hasAdditionalDetails" : { - "type" : "boolean", - "description" : "Whether or not the extension has additional detail documentation" - }, - "linkDocs" : { - "description" : "A WebLink to the documentation for this extension.", - "readOnly" : true, - "$ref" : "#/definitions/JaxbLink" - } - } - }, - "ExtensionMetadataContainer" : { - "type" : "object", - "properties" : { - "numResults" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of extensions in the response" - }, - "filterParams" : { - "description" : "The filter parameters submitted for the request", - "$ref" : "#/definitions/ExtensionFilterParams" - }, - "extensions" : { - "type" : "array", - "description" : "The metadata for the extensions", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ExtensionMetadata" - } - } - } - }, - "ExtensionRepoArtifact" : { - "type" : "object", - "properties" : { - "link" : { - "description" : "An WebLink to this entity.", - "readOnly" : true, - "$ref" : "#/definitions/JaxbLink" - }, - "bucketName" : { - "type" : "string", - "description" : "The bucket name" - }, - "groupId" : { - "type" : "string", - "description" : "The group id" - }, - "artifactId" : { - "type" : "string", - "description" : "The artifact id" - } - } - }, - "ExtensionRepoBucket" : { - "type" : "object", - "properties" : { - "link" : { - "description" : "An WebLink to this entity.", - "readOnly" : true, - "$ref" : "#/definitions/JaxbLink" - }, - "bucketName" : { - "type" : "string", - "description" : "The name of the bucket" - } - } - }, - "ExtensionRepoGroup" : { - "type" : "object", - "properties" : { - "link" : { - "description" : "An WebLink to this entity.", - "readOnly" : true, - "$ref" : "#/definitions/JaxbLink" - }, - "bucketName" : { - "type" : "string", - "description" : "The bucket name" - }, - "groupId" : { - "type" : "string", - "description" : "The group id" - } - } - }, - "ExtensionRepoVersion" : { - "type" : "object", - "properties" : { - "extensionsLink" : { - "description" : "The WebLink to view the metadata about the extensions contained in the extension bundle.", - "readOnly" : true, - "$ref" : "#/definitions/JaxbLink" - }, - "downloadLink" : { - "description" : "The WebLink to download this version of the extension bundle.", - "readOnly" : true, - "$ref" : "#/definitions/JaxbLink" - }, - "sha256Link" : { - "description" : "The WebLink to retrieve the SHA-256 digest for this version of the extension bundle.", - "readOnly" : true, - "$ref" : "#/definitions/JaxbLink" - }, - "sha256Supplied" : { - "description" : "Indicates if the client supplied a SHA-256 when uploading this version of the extension bundle.", - "readOnly" : true, - "$ref" : "#/definitions/JaxbLink" - } - } - }, - "ExtensionRepoVersionSummary" : { - "type" : "object", - "properties" : { - "link" : { - "description" : "An WebLink to this entity.", - "readOnly" : true, - "$ref" : "#/definitions/JaxbLink" - }, - "bucketName" : { - "type" : "string", - "description" : "The bucket name" - }, - "groupId" : { - "type" : "string", - "description" : "The group id" - }, - "artifactId" : { - "type" : "string", - "description" : "The artifact id" - }, - "version" : { - "type" : "string", - "description" : "The version" - }, - "author" : { - "type" : "string", - "description" : "The identity of the user that created this version" - }, - "timestamp" : { - "type" : "integer", - "format" : "int64", - "description" : "The timestamp of when this version was created" - } - } - }, - "ExternalControllerServiceReference" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The identifier of the controller service" - }, - "name" : { - "type" : "string", - "description" : "The name of the controller service" - } - } - }, - "Fields" : { - "type" : "object", - "properties" : { - "fields" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - } - } - }, - "JaxbLink" : { - "type" : "object", - "properties" : { - "href" : { - "type" : "string", - "format" : "uri", - "xml" : { - "attribute" : true - }, - "description" : "The href for the link" - }, - "params" : { - "type" : "object", - "description" : "The params for the link", - "additionalProperties" : { - "type" : "string" - } - } - } - }, - "Permissions" : { - "type" : "object", - "properties" : { - "canRead" : { - "type" : "boolean", - "description" : "Indicates whether the user can read a given resource.", - "readOnly" : true - }, - "canWrite" : { - "type" : "boolean", - "description" : "Indicates whether the user can write a given resource.", - "readOnly" : true - }, - "canDelete" : { - "type" : "boolean", - "description" : "Indicates whether the user can delete a given resource.", - "readOnly" : true - } - } - }, - "Position" : { - "type" : "object", - "properties" : { - "x" : { - "type" : "number", - "format" : "double", - "description" : "The x coordinate." - }, - "y" : { - "type" : "number", - "format" : "double", - "description" : "The y coordinate." - } - }, - "description" : "The position of a component on the graph" - }, - "Property" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The name of the property" - }, - "displayName" : { - "type" : "string", - "description" : "The display name" - }, - "description" : { - "type" : "string", - "description" : "The description" - }, - "defaultValue" : { - "type" : "string", - "description" : "The default value" - }, - "controllerServiceDefinition" : { - "description" : "The controller service required by this property, or null if none is required", - "$ref" : "#/definitions/ControllerServiceDefinition" - }, - "allowableValues" : { - "type" : "array", - "xml" : { - "wrapped" : true - }, - "description" : "The allowable values for this property", - "items" : { - "xml" : { - "name" : "allowableValue" - }, - "$ref" : "#/definitions/AllowableValue" - } - }, - "required" : { - "type" : "boolean", - "description" : "Whether or not the property is required" - }, - "sensitive" : { - "type" : "boolean", - "description" : "Whether or not the property is sensitive" - }, - "expressionLanguageSupported" : { - "type" : "boolean", - "description" : "Whether or not expression language is supported" - }, - "expressionLanguageScope" : { - "type" : "string", - "description" : "The scope of expression language support", - "enum" : [ "NONE", "VARIABLE_REGISTRY", "FLOWFILE_ATTRIBUTES" ] - }, - "dynamicallyModifiesClasspath" : { - "type" : "boolean", - "description" : "Whether or not the processor dynamically modifies the classpath" - }, - "dynamic" : { - "type" : "boolean", - "description" : "Whether or not the processor is dynamic" - } - } - }, - "ProvidedServiceAPI" : { - "type" : "object", - "properties" : { - "className" : { - "type" : "string", - "description" : "The class name of the service API being provided" - }, - "groupId" : { - "type" : "string", - "description" : "The group id of the service API being provided" - }, - "artifactId" : { - "type" : "string", - "description" : "The artifact id of the service API being provided" - }, - "version" : { - "type" : "string", - "description" : "The version of the service API being provided" - } - } - }, - "RegistryConfiguration" : { - "type" : "object", - "properties" : { - "supportsManagedAuthorizer" : { - "type" : "boolean", - "description" : "Whether this NiFi Registry supports a managed authorizer. Managed authorizers can visualize users, groups, and policies in the UI.", - "readOnly" : true - }, - "supportsConfigurableAuthorizer" : { - "type" : "boolean", - "description" : "Whether this NiFi Registry supports a configurable authorizer.", - "readOnly" : true - }, - "supportsConfigurableUsersAndGroups" : { - "type" : "boolean", - "description" : "Whether this NiFi Registry supports configurable users and groups.", - "readOnly" : true - } - } - }, - "Relationship" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The name of the relationship" - }, - "description" : { - "type" : "string", - "description" : "The description of the relationship" - }, - "autoTerminated" : { - "type" : "boolean", - "description" : "Whether or not the relationship is auto-terminated by default" - } - } - }, - "Resource" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The identifier of the resource.", - "readOnly" : true - }, - "name" : { - "type" : "string", - "description" : "The name of the resource.", - "readOnly" : true - } - } - }, - "ResourcePermissions" : { - "type" : "object", - "properties" : { - "buckets" : { - "description" : "The access that the current user has to the top level /buckets resource of this NiFi Registry (i.e., access to all buckets)", - "readOnly" : true, - "$ref" : "#/definitions/Permissions" - }, - "tenants" : { - "description" : "The access that the current user has to the top level /tenants resource of this NiFi Registry", - "readOnly" : true, - "$ref" : "#/definitions/Permissions" - }, - "policies" : { - "description" : "The access that the current user has to the top level /policies resource of this NiFi Registry", - "readOnly" : true, - "$ref" : "#/definitions/Permissions" - }, - "proxy" : { - "description" : "The access that the current user has to the top level /proxy resource of this NiFi Registry", - "readOnly" : true, - "$ref" : "#/definitions/Permissions" - }, - "anyTopLevelResource" : { - "description" : "The access that the current user has to any top level resources (a logical 'OR' of all other values)", - "readOnly" : true, - "$ref" : "#/definitions/Permissions" - } - } - }, - "Restricted" : { - "type" : "object", - "properties" : { - "generalRestrictionExplanation" : { - "type" : "string", - "description" : "The general restriction for the extension, or null if only specific restrictions exist" - }, - "restrictions" : { - "type" : "array", - "xml" : { - "wrapped" : true - }, - "description" : "The specific restrictions", - "items" : { - "xml" : { - "name" : "restriction" - }, - "$ref" : "#/definitions/Restriction" - } - } - } - }, - "Restriction" : { - "type" : "object", - "properties" : { - "requiredPermission" : { - "type" : "string", - "description" : "The permission required for this restriction" - }, - "explanation" : { - "type" : "string", - "description" : "The explanation of this restriction" - } - } - }, - "RevisionInfo" : { - "type" : "object", - "properties" : { - "clientId" : { - "type" : "string", - "description" : "A client identifier used to make a request. By including a client identifier, the API can allow multiple requests without needing the current revision. Due to the asynchronous nature of requests/responses this was implemented to allow the client to make numerous requests without having to wait for the previous response to come back." - }, - "version" : { - "type" : "integer", - "format" : "int64", - "description" : "NiFi Registry employs an optimistic locking strategy where the client must include a revision in their request when performing an update. In a response to a mutable flow request, this field represents the updated base version." - }, - "lastModifier" : { - "type" : "string", - "description" : "The user that last modified the entity.", - "readOnly" : true - } - }, - "description" : "The revision information for an entity managed through the REST API." - }, - "Stateful" : { - "type" : "object", - "properties" : { - "description" : { - "type" : "string", - "description" : "The description for how the extension stores state" - }, - "scopes" : { - "type" : "array", - "xml" : { - "wrapped" : true - }, - "description" : "The scopes used to store state", - "items" : { - "type" : "string", - "xml" : { - "name" : "scope" - }, - "enum" : [ "CLUSTER", "LOCAL" ] - } - } - } - }, - "SystemResourceConsideration" : { - "type" : "object", - "properties" : { - "resource" : { - "type" : "string", - "description" : "The resource to consider" - }, - "description" : { - "type" : "string", - "description" : "The description of how the resource is affected" - } - } - }, - "TagCount" : { - "type" : "object", - "properties" : { - "tag" : { - "type" : "string", - "description" : "The tag label" - }, - "count" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of occurrences of the given tag" - } - } - }, - "Tenant" : { - "type" : "object", - "required" : [ "identity" ], - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The computer-generated identifier of the tenant.", - "readOnly" : true - }, - "identity" : { - "type" : "string", - "description" : "The human-facing identity of the tenant. This can only be changed if the tenant is configurable." - }, - "configurable" : { - "type" : "boolean", - "description" : "Indicates if this tenant is configurable, based on which UserGroupProvider has been configured to manage it.", - "readOnly" : true - }, - "resourcePermissions" : { - "description" : "A summary top-level resource access policies granted to this tenant.", - "readOnly" : true, - "$ref" : "#/definitions/ResourcePermissions" - }, - "accessPolicies" : { - "type" : "array", - "description" : "The access policies granted to this tenant.", - "readOnly" : true, - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/AccessPolicySummary" - } - }, - "revision" : { - "description" : "The revision of this entity used for optimistic-locking during updates.", - "readOnly" : true, - "$ref" : "#/definitions/RevisionInfo" - } - } - }, - "User" : { - "type" : "object", - "required" : [ "identity" ], - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The computer-generated identifier of the tenant.", - "readOnly" : true - }, - "identity" : { - "type" : "string", - "description" : "The human-facing identity of the tenant. This can only be changed if the tenant is configurable." - }, - "configurable" : { - "type" : "boolean", - "description" : "Indicates if this tenant is configurable, based on which UserGroupProvider has been configured to manage it.", - "readOnly" : true - }, - "resourcePermissions" : { - "description" : "A summary top-level resource access policies granted to this tenant.", - "readOnly" : true, - "$ref" : "#/definitions/ResourcePermissions" - }, - "accessPolicies" : { - "type" : "array", - "description" : "The access policies granted to this tenant.", - "readOnly" : true, - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/AccessPolicySummary" - } - }, - "revision" : { - "description" : "The revision of this entity used for optimistic-locking during updates.", - "readOnly" : true, - "$ref" : "#/definitions/RevisionInfo" - }, - "userGroups" : { - "type" : "array", - "description" : "The groups to which the user belongs.", - "readOnly" : true, - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/Tenant" - } - } - } - }, - "UserGroup" : { - "type" : "object", - "required" : [ "identity" ], - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The computer-generated identifier of the tenant.", - "readOnly" : true - }, - "identity" : { - "type" : "string", - "description" : "The human-facing identity of the tenant. This can only be changed if the tenant is configurable." - }, - "configurable" : { - "type" : "boolean", - "description" : "Indicates if this tenant is configurable, based on which UserGroupProvider has been configured to manage it.", - "readOnly" : true - }, - "resourcePermissions" : { - "description" : "A summary top-level resource access policies granted to this tenant.", - "readOnly" : true, - "$ref" : "#/definitions/ResourcePermissions" - }, - "accessPolicies" : { - "type" : "array", - "description" : "The access policies granted to this tenant.", - "readOnly" : true, - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/AccessPolicySummary" - } - }, - "revision" : { - "description" : "The revision of this entity used for optimistic-locking during updates.", - "readOnly" : true, - "$ref" : "#/definitions/RevisionInfo" - }, - "users" : { - "type" : "array", - "description" : "The users that belong to this user group. This can only be changed if this group is configurable.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/Tenant" - } - } - } - }, - "VersionedConnection" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The component's unique identifier" - }, - "name" : { - "type" : "string", - "description" : "The component's name" - }, - "comments" : { - "type" : "string", - "description" : "The user-supplied comments for the component" - }, - "position" : { - "description" : "The component's position on the graph", - "$ref" : "#/definitions/Position" - }, - "source" : { - "description" : "The source of the connection.", - "$ref" : "#/definitions/ConnectableComponent" - }, - "destination" : { - "description" : "The destination of the connection.", - "$ref" : "#/definitions/ConnectableComponent" - }, - "labelIndex" : { - "type" : "integer", - "format" : "int32", - "description" : "The index of the bend point where to place the connection label." - }, - "zIndex" : { - "type" : "integer", - "format" : "int64", - "description" : "The z index of the connection." - }, - "selectedRelationships" : { - "type" : "array", - "description" : "The selected relationship that comprise the connection.", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - }, - "backPressureObjectThreshold" : { - "type" : "integer", - "format" : "int64", - "description" : "The object count threshold for determining when back pressure is applied. Updating this value is a passive change in the sense that it won't impact whether existing files over the limit are affected but it does help feeder processors to stop pushing too much into this work queue." - }, - "backPressureDataSizeThreshold" : { - "type" : "string", - "description" : "The object data size threshold for determining when back pressure is applied. Updating this value is a passive change in the sense that it won't impact whether existing files over the limit are affected but it does help feeder processors to stop pushing too much into this work queue." - }, - "flowFileExpiration" : { - "type" : "string", - "description" : "The amount of time a flow file may be in the flow before it will be automatically aged out of the flow. Once a flow file reaches this age it will be terminated from the flow the next time a processor attempts to start work on it." - }, - "prioritizers" : { - "type" : "array", - "description" : "The comparators used to prioritize the queue.", - "items" : { - "type" : "string" - } - }, - "bends" : { - "type" : "array", - "description" : "The bend points on the connection.", - "items" : { - "$ref" : "#/definitions/Position" - } - }, - "loadBalanceStrategy" : { - "type" : "string", - "description" : "The Strategy to use for load balancing data across the cluster, or null, if no Load Balance Strategy has been specified.", - "enum" : [ "DO_NOT_LOAD_BALANCE", "PARTITION_BY_ATTRIBUTE", "ROUND_ROBIN", "SINGLE_NODE" ] - }, - "partitioningAttribute" : { - "type" : "string", - "description" : "The attribute to use for partitioning data as it is load balanced across the cluster. If the Load Balance Strategy is configured to use PARTITION_BY_ATTRIBUTE, the value returned by this method is the name of the FlowFile Attribute that will be used to determine which node in the cluster should receive a given FlowFile. If the Load Balance Strategy is unset or is set to any other value, the Partitioning Attribute has no effect." - }, - "loadBalanceCompression" : { - "type" : "string", - "description" : "Whether or not compression should be used when transferring FlowFiles between nodes", - "enum" : [ "DO_NOT_COMPRESS", "COMPRESS_ATTRIBUTES_ONLY", "COMPRESS_ATTRIBUTES_AND_CONTENT" ] - }, - "componentType" : { - "type" : "string", - "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE" ] - }, - "groupIdentifier" : { - "type" : "string", - "description" : "The ID of the Process Group that this component belongs to" - } - } - }, - "VersionedControllerService" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The component's unique identifier" - }, - "name" : { - "type" : "string", - "description" : "The component's name" - }, - "comments" : { - "type" : "string", - "description" : "The user-supplied comments for the component" - }, - "position" : { - "description" : "The component's position on the graph", - "$ref" : "#/definitions/Position" - }, - "type" : { - "type" : "string", - "description" : "The type of the controller service." - }, - "bundle" : { - "description" : "The details of the artifact that bundled this processor type.", - "$ref" : "#/definitions/Bundle" - }, - "controllerServiceApis" : { - "type" : "array", - "description" : "Lists the APIs this Controller Service implements.", - "items" : { - "$ref" : "#/definitions/ControllerServiceAPI" - } - }, - "properties" : { - "type" : "object", - "description" : "The properties of the controller service.", - "additionalProperties" : { - "type" : "string" - } - }, - "propertyDescriptors" : { - "type" : "object", - "description" : "The property descriptors for the processor.", - "additionalProperties" : { - "$ref" : "#/definitions/VersionedPropertyDescriptor" - } - }, - "annotationData" : { - "type" : "string", - "description" : "The annotation for the controller service. This is how the custom UI relays configuration to the controller service." - }, - "componentType" : { - "type" : "string", - "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE" ] - }, - "groupIdentifier" : { - "type" : "string", - "description" : "The ID of the Process Group that this component belongs to" - } - } - }, - "VersionedFlow" : { - "type" : "object", - "required" : [ "bucketIdentifier", "name", "type" ], - "properties" : { - "link" : { - "description" : "An WebLink to this entity.", - "readOnly" : true, - "$ref" : "#/definitions/JaxbLink" - }, - "identifier" : { - "type" : "string", - "description" : "An ID to uniquely identify this object.", - "readOnly" : true - }, - "name" : { - "type" : "string", - "description" : "The name of the item." - }, - "description" : { - "type" : "string", - "description" : "A description of the item." - }, - "bucketIdentifier" : { - "type" : "string", - "description" : "The identifier of the bucket this items belongs to. This cannot be changed after the item is created." - }, - "bucketName" : { - "type" : "string", - "description" : "The name of the bucket this items belongs to.", - "readOnly" : true - }, - "createdTimestamp" : { - "type" : "integer", - "format" : "int64", - "description" : "The timestamp of when the item was created, as milliseconds since epoch.", - "readOnly" : true, - "minimum" : 1 - }, - "modifiedTimestamp" : { - "type" : "integer", - "format" : "int64", - "description" : "The timestamp of when the item was last modified, as milliseconds since epoch.", - "readOnly" : true, - "minimum" : 1 - }, - "type" : { - "type" : "string", - "description" : "The type of item.", - "enum" : [ "Flow", "Bundle" ] - }, - "permissions" : { - "description" : "The access that the current user has to the bucket containing this item.", - "readOnly" : true, - "$ref" : "#/definitions/Permissions" - }, - "versionCount" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of versions of this flow.", - "readOnly" : true, - "minimum" : 0 - }, - "revision" : { - "description" : "The revision of this entity used for optimistic-locking during updates.", - "readOnly" : true, - "$ref" : "#/definitions/RevisionInfo" - } - } - }, - "VersionedFlowCoordinates" : { - "type" : "object", - "properties" : { - "registryUrl" : { - "type" : "string", - "description" : "The URL of the Flow Registry that contains the flow" - }, - "bucketId" : { - "type" : "string", - "description" : "The UUID of the bucket that the flow resides in" - }, - "flowId" : { - "type" : "string", - "description" : "The UUID of the flow" - }, - "version" : { - "type" : "integer", - "format" : "int32", - "description" : "The version of the flow" - }, - "latest" : { - "type" : "boolean", - "description" : "Whether or not these coordinates point to the latest version of the flow" - } - } - }, - "VersionedFlowDifference" : { - "type" : "object", - "properties" : { - "bucketId" : { - "type" : "string", - "description" : "The id of the bucket that the flow is stored in." - }, - "flowId" : { - "type" : "string", - "description" : "The id of the flow that is being examined." - }, - "versionA" : { - "type" : "integer", - "format" : "int32", - "description" : "The earlier version from the diff operation." - }, - "versionB" : { - "type" : "integer", - "format" : "int32", - "description" : "The latter version from the diff operation." - }, - "componentDifferenceGroups" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ComponentDifferenceGroup" - } - } - } - }, - "VersionedFlowSnapshot" : { - "type" : "object", - "required" : [ "flowContents", "snapshotMetadata" ], - "properties" : { - "snapshotMetadata" : { - "description" : "The metadata for this snapshot", - "$ref" : "#/definitions/VersionedFlowSnapshotMetadata" - }, - "flowContents" : { - "description" : "The contents of the versioned flow", - "$ref" : "#/definitions/VersionedProcessGroup" - }, - "externalControllerServices" : { - "type" : "object", - "description" : "The information about controller services that exist outside this versioned flow, but are referenced by components within the versioned flow.", - "additionalProperties" : { - "$ref" : "#/definitions/ExternalControllerServiceReference" - } - }, - "parameterContexts" : { - "type" : "object", - "description" : "The parameter contexts referenced by process groups in the flow contents. The mapping is from the name of the context to the context instance, and it is expected that any context in this map is referenced by at least one process group in this flow.", - "additionalProperties" : { - "$ref" : "#/definitions/VersionedParameterContext" - } - }, - "flowEncodingVersion" : { - "type" : "string", - "description" : "The optional encoding version of the flow contents." - }, - "flow" : { - "description" : "The flow this snapshot is for", - "readOnly" : true, - "$ref" : "#/definitions/VersionedFlow" - }, - "bucket" : { - "description" : "The bucket where the flow is located", - "readOnly" : true, - "$ref" : "#/definitions/Bucket" - }, - "latest" : { - "type" : "boolean" - } - } - }, - "VersionedFlowSnapshotMetadata" : { - "type" : "object", - "required" : [ "bucketIdentifier", "flowIdentifier", "version" ], - "properties" : { - "link" : { - "description" : "An WebLink to this entity.", - "readOnly" : true, - "$ref" : "#/definitions/JaxbLink" - }, - "bucketIdentifier" : { - "type" : "string", - "description" : "The identifier of the bucket this snapshot belongs to." - }, - "flowIdentifier" : { - "type" : "string", - "description" : "The identifier of the flow this snapshot belongs to." - }, - "version" : { - "type" : "integer", - "format" : "int32", - "description" : "The version of this snapshot of the flow.", - "minimum" : -1 - }, - "timestamp" : { - "type" : "integer", - "format" : "int64", - "description" : "The timestamp when the flow was saved, as milliseconds since epoch.", - "readOnly" : true, - "minimum" : 1 - }, - "author" : { - "type" : "string", - "description" : "The user that created this snapshot of the flow.", - "readOnly" : true - }, - "comments" : { - "type" : "string", - "description" : "The comments provided by the user when creating the snapshot." - } - } - }, - "VersionedFunnel" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The component's unique identifier" - }, - "name" : { - "type" : "string", - "description" : "The component's name" - }, - "comments" : { - "type" : "string", - "description" : "The user-supplied comments for the component" - }, - "position" : { - "description" : "The component's position on the graph", - "$ref" : "#/definitions/Position" - }, - "componentType" : { - "type" : "string", - "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE" ] - }, - "groupIdentifier" : { - "type" : "string", - "description" : "The ID of the Process Group that this component belongs to" - } - } - }, - "VersionedLabel" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The component's unique identifier" - }, - "name" : { - "type" : "string", - "description" : "The component's name" - }, - "comments" : { - "type" : "string", - "description" : "The user-supplied comments for the component" - }, - "position" : { - "description" : "The component's position on the graph", - "$ref" : "#/definitions/Position" - }, - "label" : { - "type" : "string", - "description" : "The text that appears in the label." - }, - "width" : { - "type" : "number", - "format" : "double", - "description" : "The width of the label in pixels when at a 1:1 scale." - }, - "height" : { - "type" : "number", - "format" : "double", - "description" : "The height of the label in pixels when at a 1:1 scale." - }, - "style" : { - "type" : "object", - "description" : "The styles for this label (font-size : 12px, background-color : #eee, etc).", - "additionalProperties" : { - "type" : "string" - } - }, - "componentType" : { - "type" : "string", - "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE" ] - }, - "groupIdentifier" : { - "type" : "string", - "description" : "The ID of the Process Group that this component belongs to" - } - } - }, - "VersionedParameter" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The name of the parameter" - }, - "description" : { - "type" : "string", - "description" : "The description of the param" - }, - "sensitive" : { - "type" : "boolean", - "description" : "Whether or not the parameter value is sensitive" - }, - "value" : { - "type" : "string", - "description" : "The value of the parameter" - } - } - }, - "VersionedParameterContext" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The name of the context" - }, - "description" : { - "type" : "string", - "description" : "The description of the parameter context" - }, - "parameters" : { - "type" : "array", - "description" : "The parameters in the context", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedParameter" - } - } - } - }, - "VersionedPort" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The component's unique identifier" - }, - "name" : { - "type" : "string", - "description" : "The component's name" - }, - "comments" : { - "type" : "string", - "description" : "The user-supplied comments for the component" - }, - "position" : { - "description" : "The component's position on the graph", - "$ref" : "#/definitions/Position" - }, - "type" : { - "type" : "string", - "description" : "The type of port.", - "enum" : [ "INPUT_PORT", "OUTPUT_PORT" ] - }, - "concurrentlySchedulableTaskCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of tasks that should be concurrently scheduled for the port." - }, - "scheduledState" : { - "type" : "string", - "description" : "The scheduled state of the component", - "enum" : [ "ENABLED", "DISABLED" ] - }, - "allowRemoteAccess" : { - "type" : "boolean", - "description" : "Whether or not this port allows remote access for site-to-site" - }, - "componentType" : { - "type" : "string", - "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE" ] - }, - "groupIdentifier" : { - "type" : "string", - "description" : "The ID of the Process Group that this component belongs to" - } - } - }, - "VersionedProcessGroup" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The component's unique identifier" - }, - "name" : { - "type" : "string", - "description" : "The component's name" - }, - "comments" : { - "type" : "string", - "description" : "The user-supplied comments for the component" - }, - "position" : { - "description" : "The component's position on the graph", - "$ref" : "#/definitions/Position" - }, - "processGroups" : { - "type" : "array", - "description" : "The child Process Groups", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedProcessGroup" - } - }, - "remoteProcessGroups" : { - "type" : "array", - "description" : "The Remote Process Groups", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedRemoteProcessGroup" - } - }, - "processors" : { - "type" : "array", - "description" : "The Processors", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedProcessor" - } - }, - "inputPorts" : { - "type" : "array", - "description" : "The Input Ports", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedPort" - } - }, - "outputPorts" : { - "type" : "array", - "description" : "The Output Ports", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedPort" - } - }, - "connections" : { - "type" : "array", - "description" : "The Connections", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedConnection" - } - }, - "labels" : { - "type" : "array", - "description" : "The Labels", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedLabel" - } - }, - "funnels" : { - "type" : "array", - "description" : "The Funnels", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedFunnel" - } - }, - "controllerServices" : { - "type" : "array", - "description" : "The Controller Services", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedControllerService" - } - }, - "versionedFlowCoordinates" : { - "description" : "The coordinates where the remote flow is stored, or null if the Process Group is not directly under Version Control", - "$ref" : "#/definitions/VersionedFlowCoordinates" - }, - "variables" : { - "type" : "object", - "description" : "The Variables in the Variable Registry for this Process Group (not including any ancestor or descendant Process Groups)", - "additionalProperties" : { - "type" : "string" - } - }, - "parameterContextName" : { - "type" : "string", - "description" : "The name of the parameter context used by this process group" - }, - "componentType" : { - "type" : "string", - "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE" ] - }, - "flowFileOutboundPolicy" : { - "type" : "string", - "description" : "The FlowFile Outbound Policy for the Process Group" - }, - "flowFileConcurrency" : { - "type" : "string", - "description" : "The configured FlowFile Concurrency for the Process Group" - }, - "groupIdentifier" : { - "type" : "string", - "description" : "The ID of the Process Group that this component belongs to" - } - } - }, - "VersionedProcessor" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The component's unique identifier" - }, - "name" : { - "type" : "string", - "description" : "The component's name" - }, - "comments" : { - "type" : "string", - "description" : "The user-supplied comments for the component" - }, - "position" : { - "description" : "The component's position on the graph", - "$ref" : "#/definitions/Position" - }, - "bundle" : { - "description" : "Information about the bundle from which the component came", - "$ref" : "#/definitions/Bundle" - }, - "style" : { - "type" : "object", - "description" : "Stylistic data for rendering in a UI", - "additionalProperties" : { - "type" : "string" - } - }, - "type" : { - "type" : "string", - "description" : "The type of Processor" - }, - "properties" : { - "type" : "object", - "description" : "The properties for the processor. Properties whose value is not set will only contain the property name.", - "additionalProperties" : { - "type" : "string" - } - }, - "propertyDescriptors" : { - "type" : "object", - "description" : "The property descriptors for the processor.", - "additionalProperties" : { - "$ref" : "#/definitions/VersionedPropertyDescriptor" - } - }, - "annotationData" : { - "type" : "string", - "description" : "The annotation data for the processor used to relay configuration between a custom UI and the procesosr." - }, - "schedulingPeriod" : { - "type" : "string", - "description" : "The frequency with which to schedule the processor. The format of the value will depend on th value of schedulingStrategy." - }, - "schedulingStrategy" : { - "type" : "string", - "description" : "Indcates whether the prcessor should be scheduled to run in event or timer driven mode." - }, - "executionNode" : { - "type" : "string", - "description" : "Indicates the node where the process will execute." - }, - "penaltyDuration" : { - "type" : "string", - "description" : "The amout of time that is used when the process penalizes a flowfile." - }, - "yieldDuration" : { - "type" : "string", - "description" : "The amount of time that must elapse before this processor is scheduled again after yielding." - }, - "bulletinLevel" : { - "type" : "string", - "description" : "The level at which the processor will report bulletins." - }, - "runDurationMillis" : { - "type" : "integer", - "format" : "int64", - "description" : "The run duration for the processor in milliseconds." - }, - "concurrentlySchedulableTaskCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of tasks that should be concurrently schedule for the processor. If the processor doesn't allow parallol processing then any positive input will be ignored." - }, - "autoTerminatedRelationships" : { - "type" : "array", - "description" : "The names of all relationships that cause a flow file to be terminated if the relationship is not connected elsewhere. This property differs from the 'isAutoTerminate' property of the RelationshipDTO in that the RelationshipDTO is meant to depict the current configuration, whereas this property can be set in a DTO when updating a Processor in order to change which Relationships should be auto-terminated.", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - }, - "scheduledState" : { - "type" : "string", - "description" : "The scheduled state of the component", - "enum" : [ "ENABLED", "DISABLED" ] - }, - "componentType" : { - "type" : "string", - "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE" ] - }, - "groupIdentifier" : { - "type" : "string", - "description" : "The ID of the Process Group that this component belongs to" - } - } - }, - "VersionedPropertyDescriptor" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The name of the property" - }, - "displayName" : { - "type" : "string", - "description" : "The display name of the property" - }, - "identifiesControllerService" : { - "type" : "boolean", - "description" : "Whether or not the property provides the identifier of a Controller Service" - }, - "sensitive" : { - "type" : "boolean", - "description" : "Whether or not the property is considered sensitive" - } - } - }, - "VersionedRemoteGroupPort" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The component's unique identifier" - }, - "name" : { - "type" : "string", - "description" : "The component's name" - }, - "comments" : { - "type" : "string", - "description" : "The user-supplied comments for the component" - }, - "position" : { - "description" : "The component's position on the graph", - "$ref" : "#/definitions/Position" - }, - "remoteGroupId" : { - "type" : "string", - "description" : "The id of the remote process group that the port resides in." - }, - "concurrentlySchedulableTaskCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of task that may transmit flowfiles to the target port concurrently." - }, - "useCompression" : { - "type" : "boolean", - "description" : "Whether the flowfiles are compressed when sent to the target port." - }, - "batchSize" : { - "description" : "The batch settings for data transmission.", - "$ref" : "#/definitions/BatchSize" - }, - "componentType" : { - "type" : "string", - "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE" ] - }, - "targetId" : { - "type" : "string", - "description" : "The ID of the port on the target NiFi instance" - }, - "scheduledState" : { - "type" : "string", - "description" : "The scheduled state of the component", - "enum" : [ "ENABLED", "DISABLED" ] - }, - "groupIdentifier" : { - "type" : "string", - "description" : "The ID of the Process Group that this component belongs to" - } - } - }, - "VersionedRemoteProcessGroup" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The component's unique identifier" - }, - "name" : { - "type" : "string", - "description" : "The component's name" - }, - "comments" : { - "type" : "string", - "description" : "The user-supplied comments for the component" - }, - "position" : { - "description" : "The component's position on the graph", - "$ref" : "#/definitions/Position" - }, - "targetUri" : { - "type" : "string", - "description" : "[DEPRECATED] The target URI of the remote process group. If target uri is not set, but uris are set, then returns the first uri in the uris. If neither target uri nor uris are set, then returns null." - }, - "targetUris" : { - "type" : "string", - "description" : "The target URIs of the remote process group. If target uris is not set but target uri is set, then returns the single target uri. If neither target uris nor target uri is set, then returns null." - }, - "communicationsTimeout" : { - "type" : "string", - "description" : "The time period used for the timeout when communicating with the target." - }, - "yieldDuration" : { - "type" : "string", - "description" : "When yielding, this amount of time must elapse before the remote process group is scheduled again." - }, - "transportProtocol" : { - "type" : "string", - "description" : "The Transport Protocol that is used for Site-to-Site communications", - "enum" : [ "RAW", "HTTP" ] - }, - "localNetworkInterface" : { - "type" : "string", - "description" : "The local network interface to send/receive data. If not specified, any local address is used. If clustered, all nodes must have an interface with this identifier." - }, - "proxyHost" : { - "type" : "string" - }, - "proxyPort" : { - "type" : "integer", - "format" : "int32" - }, - "proxyUser" : { - "type" : "string" - }, - "inputPorts" : { - "type" : "array", - "description" : "A Set of Input Ports that can be connected to, in order to send data to the remote NiFi instance", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedRemoteGroupPort" - } - }, - "outputPorts" : { - "type" : "array", - "description" : "A Set of Output Ports that can be connected to, in order to pull data from the remote NiFi instance", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedRemoteGroupPort" - } - }, - "componentType" : { - "type" : "string", - "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE" ] - }, - "groupIdentifier" : { - "type" : "string", - "description" : "The ID of the Process Group that this component belongs to" - } - } - } - } -} diff --git a/resources/client_gen/api_defs/registry-0.8.0.json b/resources/client_gen/api_defs/registry-0.8.0.json deleted file mode 100644 index 7a3b01bc..00000000 --- a/resources/client_gen/api_defs/registry-0.8.0.json +++ /dev/null @@ -1,6558 +0,0 @@ -{ - "swagger" : "2.0", - "info" : { - "description" : "The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components.", - "version" : "0.8.0", - "title" : "Apache NiFi Registry REST API", - "termsOfService" : "As described in the license", - "contact" : { - "name" : "Apache NiFi Registry", - "url" : "https://nifi.apache.org", - "email" : "dev@nifi.apache.org" - }, - "license" : { - "name" : "Apache 2.0 License", - "url" : "https://www.apache.org/licenses/LICENSE-2.0.html" - } - }, - "basePath" : "/nifi-registry-api", - "tags" : [ { - "name" : "access", - "description" : "Endpoints for obtaining an access token or checking access status." - }, { - "name" : "bucket bundles", - "description" : "Create extension bundles scoped to an existing bucket in the registry. " - }, { - "name" : "bucket flows", - "description" : "Create flows scoped to an existing bucket in the registry." - }, { - "name" : "buckets", - "description" : "Create named buckets in the registry to store NiFi objects such flows and extensions. Search for and retrieve existing buckets." - }, { - "name" : "bundles", - "description" : "Gets metadata about extension bundles and their versions. " - }, { - "name" : "config", - "description" : "Retrieves the configuration for this NiFi Registry." - }, { - "name" : "extension repository", - "description" : "Interact with extension bundles via the hierarchy of bucket/group/artifact/version. " - }, { - "name" : "extensions", - "description" : "Find and retrieve extensions. " - }, { - "name" : "flows", - "description" : "Gets metadata about flows." - }, { - "name" : "items", - "description" : "Retrieve items across all buckets for which the user is authorized." - }, { - "name" : "policies", - "description" : "Endpoint for managing access policies." - }, { - "name" : "tenants", - "description" : "Endpoint for managing users and user groups." - } ], - "schemes" : [ "http", "https" ], - "paths" : { - "/access" : { - "get" : { - "tags" : [ "access" ], - "summary" : "Get access status", - "description" : "Returns the current client's authenticated identity and permissions to top-level resources", - "operationId" : "getAccessStatus", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/CurrentUser" - } - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid. The NiFi Registry might be running unsecured." - } - }, - "security" : [ { - "Authorization" : [ ] - } ] - } - }, - "/access/logout" : { - "delete" : { - "tags" : [ "access" ], - "summary" : "Performs a logout for other providers that have been issued a JWT.", - "description" : "\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "logOut", - "consumes" : [ "*/*" ], - "produces" : [ "*/*" ], - "responses" : { - "200" : { - "description" : "User was logged out successfully." - }, - "401" : { - "description" : "Authentication token provided was empty or not in the correct JWT format." - }, - "500" : { - "description" : "Client failed to log out." - } - } - } - }, - "/access/oidc/callback" : { - "get" : { - "tags" : [ "access" ], - "summary" : "Redirect/callback URI for processing the result of the OpenId Connect login sequence.", - "description" : "\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "oidcCallback", - "consumes" : [ "*/*" ], - "produces" : [ "*/*" ], - "responses" : { - "default" : { - "description" : "successful operation" - } - } - } - }, - "/access/oidc/exchange" : { - "post" : { - "tags" : [ "access" ], - "summary" : "Retrieves a JWT following a successful login sequence using the configured OpenId Connect provider.", - "description" : "\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "oidcExchange", - "consumes" : [ "*/*" ], - "produces" : [ "text/plain" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - } - } - } - }, - "/access/oidc/logout" : { - "delete" : { - "tags" : [ "access" ], - "summary" : "Performs a logout in the OpenId Provider.", - "description" : "\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "oidcLogout", - "consumes" : [ "*/*" ], - "produces" : [ "*/*" ], - "responses" : { - "default" : { - "description" : "successful operation" - } - } - } - }, - "/access/oidc/request" : { - "get" : { - "tags" : [ "access" ], - "summary" : "Initiates a request to authenticate through the configured OpenId Connect provider.", - "description" : "\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "oidcRequest", - "consumes" : [ "*/*" ], - "produces" : [ "*/*" ], - "responses" : { - "default" : { - "description" : "successful operation" - } - } - } - }, - "/access/token" : { - "post" : { - "tags" : [ "access" ], - "summary" : "Create token trying all providers", - "description" : "Creates a token for accessing the REST API via auto-detected method of verifying client identity claim credentials. The token returned is formatted as a JSON Web Token (JWT). The token is base64 encoded and comprised of three parts. The header, the body, and the signature. The expiration of the token is a contained within the body. The token can be used in the Authorization header in the format 'Authorization: Bearer '.", - "operationId" : "createAccessTokenByTryingAllProviders", - "consumes" : [ "*/*" ], - "produces" : [ "text/plain" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid. The NiFi Registry may not be configured to support login with username/password." - }, - "500" : { - "description" : "NiFi Registry was unable to complete the request because an unexpected error occurred." - } - } - } - }, - "/access/token/identity-provider" : { - "post" : { - "tags" : [ "access" ], - "summary" : "Create token using identity provider", - "description" : "Creates a token for accessing the REST API via a custom identity provider. The user credentials must be passed in a format understood by the custom identity provider, e.g., a third-party auth token in an HTTP header. The exact format of the user credentials expected by the custom identity provider can be discovered by 'GET /access/token/identity-provider/usage'. The token returned is formatted as a JSON Web Token (JWT). The token is base64 encoded and comprised of three parts. The header, the body, and the signature. The expiration of the token is a contained within the body. The token can be used in the Authorization header in the format 'Authorization: Bearer '.", - "operationId" : "createAccessTokenUsingIdentityProviderCredentials", - "consumes" : [ "*/*" ], - "produces" : [ "text/plain" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid. The NiFi Registry may not be configured to support login with customized credentials." - }, - "500" : { - "description" : "NiFi Registry was unable to complete the request because an unexpected error occurred." - } - } - } - }, - "/access/token/identity-provider/test" : { - "post" : { - "tags" : [ "access" ], - "summary" : "Test identity provider", - "description" : "Tests the format of the credentials against this identity provider without preforming authentication on the credentials to validate them. The user credentials should be passed in a format understood by the custom identity provider as defined by 'GET /access/token/identity-provider/usage'.", - "operationId" : "testIdentityProviderRecognizesCredentialsFormat", - "consumes" : [ "*/*" ], - "produces" : [ "text/plain" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "The format of the credentials were not recognized by the currently configured identity provider." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid. The NiFi Registry may not be configured to support login with customized credentials." - }, - "500" : { - "description" : "NiFi Registry was unable to complete the request because an unexpected error occurred." - } - } - } - }, - "/access/token/identity-provider/usage" : { - "get" : { - "tags" : [ "access" ], - "summary" : "Get identity provider usage", - "description" : "Provides a description of how the currently configured identity provider expects credentials to be passed to POST /access/token/identity-provider", - "operationId" : "getIdentityProviderUsageInstructions", - "consumes" : [ "*/*" ], - "produces" : [ "text/plain" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid. The NiFi Registry may not be configured to support login with customized credentials." - }, - "500" : { - "description" : "NiFi Registry was unable to complete the request because an unexpected error occurred." - } - } - } - }, - "/access/token/kerberos" : { - "post" : { - "tags" : [ "access" ], - "summary" : "Create token using kerberos", - "description" : "Creates a token for accessing the REST API via Kerberos Service Tickets or SPNEGO Tokens (which includes Kerberos Service Tickets). The token returned is formatted as a JSON Web Token (JWT). The token is base64 encoded and comprised of three parts. The header, the body, and the signature. The expiration of the token is a contained within the body. The token can be used in the Authorization header in the format 'Authorization: Bearer '.", - "operationId" : "createAccessTokenUsingKerberosTicket", - "consumes" : [ "*/*" ], - "produces" : [ "text/plain" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid. The NiFi Registry may not be configured to support login Kerberos credentials." - }, - "500" : { - "description" : "NiFi Registry was unable to complete the request because an unexpected error occurred." - } - } - } - }, - "/access/token/login" : { - "post" : { - "tags" : [ "access" ], - "summary" : "Create token using basic auth", - "description" : "Creates a token for accessing the REST API via username/password. The user credentials must be passed in standard HTTP Basic Auth format. That is: 'Authorization: Basic ', where is the base64 encoded value of ':'. The token returned is formatted as a JSON Web Token (JWT). The token is base64 encoded and comprised of three parts. The header, the body, and the signature. The expiration of the token is a contained within the body. The token can be used in the Authorization header in the format 'Authorization: Bearer '.", - "operationId" : "createAccessTokenUsingBasicAuthCredentials", - "consumes" : [ "*/*" ], - "produces" : [ "text/plain" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid. The NiFi Registry may not be configured to support login with username/password." - }, - "500" : { - "description" : "NiFi Registry was unable to complete the request because an unexpected error occurred." - } - }, - "security" : [ { - "BasicAuth" : [ ] - } ] - } - }, - "/buckets" : { - "get" : { - "tags" : [ "buckets" ], - "summary" : "Get all buckets", - "description" : "The returned list will include only buckets for which the user is authorized.If the user is not authorized for any buckets, this returns an empty list.", - "operationId" : "getBuckets", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/Bucket" - } - } - }, - "401" : { - "description" : "Client could not be authenticated." - } - }, - "security" : [ { - "Authorization" : [ ] - } ] - }, - "post" : { - "tags" : [ "buckets" ], - "summary" : "Create bucket", - "description" : "", - "operationId" : "createBucket", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The bucket to create", - "required" : true, - "schema" : { - "$ref" : "#/definitions/Bucket" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/Bucket" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets", - "action" : "write" - } - } - }, - "/buckets/fields" : { - "get" : { - "tags" : [ "buckets" ], - "summary" : "Get bucket fields", - "description" : "Retrieves bucket field names for searching or sorting on buckets.", - "operationId" : "getAvailableBucketFields", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/Fields" - } - } - }, - "security" : [ { - "Authorization" : [ ] - } ] - } - }, - "/buckets/{bucketId}" : { - "get" : { - "tags" : [ "buckets" ], - "summary" : "Get bucket", - "description" : "Gets the bucket with the given id.", - "operationId" : "getBucket", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketId", - "in" : "path", - "description" : "The bucket identifier", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/Bucket" - } - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - }, - "put" : { - "tags" : [ "buckets" ], - "summary" : "Update bucket", - "description" : "Updates the bucket with the given id.", - "operationId" : "updateBucket", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketId", - "in" : "path", - "description" : "The bucket identifier", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The updated bucket", - "required" : true, - "schema" : { - "$ref" : "#/definitions/Bucket" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/Bucket" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "write" - } - }, - "delete" : { - "tags" : [ "buckets" ], - "summary" : "Delete bucket", - "description" : "Deletes the bucket with the given id, along with all objects stored in the bucket", - "operationId" : "deleteBucket", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The version is used to verify the client is working with the latest version of the entity.", - "required" : true, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "bucketId", - "in" : "path", - "description" : "The bucket identifier", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/Bucket" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "delete" - } - } - }, - "/buckets/{bucketId}/bundles" : { - "get" : { - "tags" : [ "bucket bundles" ], - "summary" : "Get extension bundles by bucket", - "description" : "\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getExtensionBundles", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketId", - "in" : "path", - "description" : "The bucket identifier", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/ExtensionBundle" - } - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/buckets/{bucketId}/bundles/{bundleType}" : { - "post" : { - "tags" : [ "bucket bundles" ], - "summary" : "Create extension bundle version", - "description" : "Creates a version of an extension bundle by uploading a binary artifact. If an extension bundle already exists in the given bucket with the same group id and artifact id as that of the bundle being uploaded, then it will be added as a new version to the existing bundle. If an extension bundle does not already exist in the given bucket with the same group id and artifact id, then a new extension bundle will be created and this version will be added to the new bundle. Client's may optionally supply a SHA-256 in hex format through the multi-part form field 'sha256'. If supplied, then this value will be compared against the SHA-256 computed by the server, and the bundle will be rejected if the values do not match. If not supplied, the bundle will be accepted, but will be marked to indicate that the client did not supply a SHA-256 during creation. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "createExtensionBundleVersion", - "consumes" : [ "multipart/form-data" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketId", - "in" : "path", - "description" : "The bucket identifier", - "required" : true, - "type" : "string" - }, { - "name" : "bundleType", - "in" : "path", - "description" : "The type of the bundle", - "required" : true, - "type" : "string", - "enum" : [ "nifi-nar", "minifi-cpp" ] - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/BundleVersion" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "write" - } - } - }, - "/buckets/{bucketId}/flows" : { - "get" : { - "tags" : [ "bucket flows" ], - "summary" : "Get bucket flows", - "description" : "Retrieves all flows in the given bucket.", - "operationId" : "getFlows", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketId", - "in" : "path", - "description" : "The bucket identifier", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/VersionedFlow" - } - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - }, - "post" : { - "tags" : [ "bucket flows" ], - "summary" : "Create flow", - "description" : "Creates a flow in the given bucket. The flow id is created by the server and populated in the returned entity.", - "operationId" : "createFlow", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketId", - "in" : "path", - "description" : "The bucket identifier", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The details of the flow to create.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/VersionedFlow" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlow" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "write" - } - } - }, - "/buckets/{bucketId}/flows/{flowId}" : { - "get" : { - "tags" : [ "bucket flows" ], - "summary" : "Get bucket flow", - "description" : "Retrieves the flow with the given id in the given bucket.", - "operationId" : "getFlow", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketId", - "in" : "path", - "description" : "The bucket identifier", - "required" : true, - "type" : "string" - }, { - "name" : "flowId", - "in" : "path", - "description" : "The flow identifier", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlow" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - }, - "put" : { - "tags" : [ "bucket flows" ], - "summary" : "Update bucket flow", - "description" : "Updates the flow with the given id in the given bucket.", - "operationId" : "updateFlow", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketId", - "in" : "path", - "description" : "The bucket identifier", - "required" : true, - "type" : "string" - }, { - "name" : "flowId", - "in" : "path", - "description" : "The flow identifier", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The updated flow", - "required" : true, - "schema" : { - "$ref" : "#/definitions/VersionedFlow" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlow" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "write" - } - }, - "delete" : { - "tags" : [ "bucket flows" ], - "summary" : "Delete bucket flow", - "description" : "Deletes a flow, including all saved versions of that flow.", - "operationId" : "deleteFlow", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The version is used to verify the client is working with the latest version of the entity.", - "required" : true, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "bucketId", - "in" : "path", - "description" : "The bucket identifier", - "required" : true, - "type" : "string" - }, { - "name" : "flowId", - "in" : "path", - "description" : "The flow identifier", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlow" - } - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "delete" - } - } - }, - "/buckets/{bucketId}/flows/{flowId}/diff/{versionA}/{versionB}" : { - "get" : { - "tags" : [ "bucket flows" ], - "summary" : "Get bucket flow diff", - "description" : "Computes the differences between two given versions of a flow.", - "operationId" : "getFlowDiff", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketId", - "in" : "path", - "description" : "The bucket identifier", - "required" : true, - "type" : "string" - }, { - "name" : "flowId", - "in" : "path", - "description" : "The flow identifier", - "required" : true, - "type" : "string" - }, { - "name" : "versionA", - "in" : "path", - "description" : "The first version number", - "required" : true, - "type" : "integer", - "pattern" : "\\d+", - "format" : "int32" - }, { - "name" : "versionB", - "in" : "path", - "description" : "The second version number", - "required" : true, - "type" : "integer", - "pattern" : "\\d+", - "format" : "int32" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlowDifference" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/buckets/{bucketId}/flows/{flowId}/versions" : { - "get" : { - "tags" : [ "bucket flows" ], - "summary" : "Get bucket flow versions", - "description" : "Gets summary information for all versions of a flow. Versions are ordered newest->oldest.", - "operationId" : "getFlowVersions", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketId", - "in" : "path", - "description" : "The bucket identifier", - "required" : true, - "type" : "string" - }, { - "name" : "flowId", - "in" : "path", - "description" : "The flow identifier", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/VersionedFlowSnapshotMetadata" - } - } - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - }, - "post" : { - "tags" : [ "bucket flows" ], - "summary" : "Create flow version", - "description" : "Creates the next version of a flow. The version number of the object being created must be the next available version integer. Flow versions are immutable after they are created.", - "operationId" : "createFlowVersion", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketId", - "in" : "path", - "description" : "The bucket identifier", - "required" : true, - "type" : "string" - }, { - "name" : "flowId", - "in" : "path", - "description" : "The flow identifier", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The new versioned flow snapshot.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/VersionedFlowSnapshot" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlowSnapshot" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "write" - } - } - }, - "/buckets/{bucketId}/flows/{flowId}/versions/latest" : { - "get" : { - "tags" : [ "bucket flows" ], - "summary" : "Get latest bucket flow version content", - "description" : "Gets the latest version of a flow, including the metadata and content of the flow.", - "operationId" : "getLatestFlowVersion", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketId", - "in" : "path", - "description" : "The bucket identifier", - "required" : true, - "type" : "string" - }, { - "name" : "flowId", - "in" : "path", - "description" : "The flow identifier", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlowSnapshot" - } - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/buckets/{bucketId}/flows/{flowId}/versions/latest/metadata" : { - "get" : { - "tags" : [ "bucket flows" ], - "summary" : "Get latest bucket flow version metadata", - "description" : "Gets the metadata for the latest version of a flow.", - "operationId" : "getLatestFlowVersionMetadata", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketId", - "in" : "path", - "description" : "The bucket identifier", - "required" : true, - "type" : "string" - }, { - "name" : "flowId", - "in" : "path", - "description" : "The flow identifier", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlowSnapshotMetadata" - } - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/buckets/{bucketId}/flows/{flowId}/versions/{versionNumber}" : { - "get" : { - "tags" : [ "bucket flows" ], - "summary" : "Get bucket flow version", - "description" : "Gets the given version of a flow, including the metadata and content for the version.", - "operationId" : "getFlowVersion", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketId", - "in" : "path", - "description" : "The bucket identifier", - "required" : true, - "type" : "string" - }, { - "name" : "flowId", - "in" : "path", - "description" : "The flow identifier", - "required" : true, - "type" : "string" - }, { - "name" : "versionNumber", - "in" : "path", - "description" : "The version number", - "required" : true, - "type" : "integer", - "pattern" : "\\d+", - "format" : "int32" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlowSnapshot" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/bundles" : { - "get" : { - "tags" : [ "bundles" ], - "summary" : "Get all bundles", - "description" : "Gets the metadata for all bundles across all authorized buckets with optional filters applied. The returned results will include only items from buckets for which the user is authorized. If the user is not authorized to any buckets, an empty list will be returned. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getBundles", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketName", - "in" : "query", - "description" : "Optional bucket name to filter results. The value may be an exact match, or a wildcard, such as 'My Bucket%' to select all bundles where the bucket name starts with 'My Bucket'.", - "required" : false, - "type" : "string" - }, { - "name" : "groupId", - "in" : "query", - "description" : "Optional groupId to filter results. The value may be an exact match, or a wildcard, such as 'com.%' to select all bundles where the groupId starts with 'com.'.", - "required" : false, - "type" : "string" - }, { - "name" : "artifactId", - "in" : "query", - "description" : "Optional artifactId to filter results. The value may be an exact match, or a wildcard, such as 'nifi-%' to select all bundles where the artifactId starts with 'nifi-'.", - "required" : false, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/ExtensionBundle" - } - } - }, - "401" : { - "description" : "Client could not be authenticated." - } - }, - "security" : [ { - "Authorization" : [ ] - } ] - } - }, - "/bundles/versions" : { - "get" : { - "tags" : [ "bundles" ], - "summary" : "Get all bundle versions", - "description" : "Gets the metadata about extension bundle versions across all authorized buckets with optional filters applied. If the user is not authorized to any buckets, an empty list will be returned. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getBundleVersions", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "groupId", - "in" : "query", - "description" : "Optional groupId to filter results. The value may be an exact match, or a wildcard, such as 'com.%' to select all bundle versions where the groupId starts with 'com.'.", - "required" : false, - "type" : "string" - }, { - "name" : "artifactId", - "in" : "query", - "description" : "Optional artifactId to filter results. The value may be an exact match, or a wildcard, such as 'nifi-%' to select all bundle versions where the artifactId starts with 'nifi-'.", - "required" : false, - "type" : "string" - }, { - "name" : "version", - "in" : "query", - "description" : "Optional version to filter results. The value maye be an exact match, or a wildcard, such as '1.0.%' to select all bundle versions where the version starts with '1.0.'.", - "required" : false, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/BundleVersionMetadata" - } - } - }, - "401" : { - "description" : "Client could not be authenticated." - } - }, - "security" : [ { - "Authorization" : [ ] - } ] - } - }, - "/bundles/{bundleId}" : { - "get" : { - "tags" : [ "bundles" ], - "summary" : "Get bundle", - "description" : "Gets the metadata about an extension bundle. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "globalGetExtensionBundle", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bundleId", - "in" : "path", - "description" : "The extension bundle identifier", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ExtensionBundle" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - }, - "delete" : { - "tags" : [ "bundles" ], - "summary" : "Delete bundle", - "description" : "Deletes the given extension bundle and all of it's versions. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "globalDeleteExtensionBundle", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bundleId", - "in" : "path", - "description" : "The extension bundle identifier", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ExtensionBundle" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "write" - } - } - }, - "/bundles/{bundleId}/versions" : { - "get" : { - "tags" : [ "bundles" ], - "summary" : "Get bundle versions", - "description" : "Gets the metadata for the versions of the given extension bundle. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "globalGetBundleVersions", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bundleId", - "in" : "path", - "description" : "The extension bundle identifier", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/BundleVersionMetadata" - } - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/bundles/{bundleId}/versions/{version}" : { - "get" : { - "tags" : [ "bundles" ], - "summary" : "Get bundle version", - "description" : "Gets the descriptor for the given version of the given extension bundle. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "globalGetBundleVersion", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bundleId", - "in" : "path", - "description" : "The extension bundle identifier", - "required" : true, - "type" : "string" - }, { - "name" : "version", - "in" : "path", - "description" : "The version of the bundle", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/BundleVersion" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - }, - "delete" : { - "tags" : [ "bundles" ], - "summary" : "Delete bundle version", - "description" : "Deletes the given extension bundle version and it's associated binary content. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "globalDeleteBundleVersion", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bundleId", - "in" : "path", - "description" : "The extension bundle identifier", - "required" : true, - "type" : "string" - }, { - "name" : "version", - "in" : "path", - "description" : "The version of the bundle", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/BundleVersion" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "write" - } - } - }, - "/bundles/{bundleId}/versions/{version}/content" : { - "get" : { - "tags" : [ "bundles" ], - "summary" : "Get bundle version content", - "description" : "Gets the binary content for the given version of the given extension bundle. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "globalGetBundleVersionContent", - "consumes" : [ "*/*" ], - "produces" : [ "application/octet-stream" ], - "parameters" : [ { - "name" : "bundleId", - "in" : "path", - "description" : "The extension bundle identifier", - "required" : true, - "type" : "string" - }, { - "name" : "version", - "in" : "path", - "description" : "The version of the bundle", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "type" : "string", - "format" : "byte" - } - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/bundles/{bundleId}/versions/{version}/extensions" : { - "get" : { - "tags" : [ "bundles" ], - "summary" : "Get bundle version extensions", - "description" : "Gets the metadata about the extensions in the given extension bundle version. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "globalGetBundleVersionExtensions", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bundleId", - "in" : "path", - "description" : "The extension bundle identifier", - "required" : true, - "type" : "string" - }, { - "name" : "version", - "in" : "path", - "description" : "The version of the bundle", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/ExtensionMetadata" - } - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/bundles/{bundleId}/versions/{version}/extensions/{name}" : { - "get" : { - "tags" : [ "bundles" ], - "summary" : "Get bundle version extension", - "description" : "Gets the metadata about the extension with the given name in the given extension bundle version. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "globalGetBundleVersionExtension", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bundleId", - "in" : "path", - "description" : "The extension bundle identifier", - "required" : true, - "type" : "string" - }, { - "name" : "version", - "in" : "path", - "description" : "The version of the bundle", - "required" : true, - "type" : "string" - }, { - "name" : "name", - "in" : "path", - "description" : "The fully qualified name of the extension", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/Extension" - } - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/bundles/{bundleId}/versions/{version}/extensions/{name}/docs" : { - "get" : { - "tags" : [ "bundles" ], - "summary" : "Get bundle version extension docs", - "description" : "Gets the documentation for the given extension in the given extension bundle version. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getBundleVersionExtensionDocs", - "consumes" : [ "*/*" ], - "produces" : [ "text/html" ], - "parameters" : [ { - "name" : "bundleId", - "in" : "path", - "description" : "The extension bundle identifier", - "required" : true, - "type" : "string" - }, { - "name" : "version", - "in" : "path", - "description" : "The version of the bundle", - "required" : true, - "type" : "string" - }, { - "name" : "name", - "in" : "path", - "description" : "The fully qualified name of the extension", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/bundles/{bundleId}/versions/{version}/extensions/{name}/docs/additional-details" : { - "get" : { - "tags" : [ "bundles" ], - "summary" : "Get bundle version extension docs details", - "description" : "Gets the additional details documentation for the given extension in the given extension bundle version. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getBundleVersionExtensionAdditionalDetailsDocs", - "consumes" : [ "*/*" ], - "produces" : [ "text/html" ], - "parameters" : [ { - "name" : "bundleId", - "in" : "path", - "description" : "The extension bundle identifier", - "required" : true, - "type" : "string" - }, { - "name" : "version", - "in" : "path", - "description" : "The version of the bundle", - "required" : true, - "type" : "string" - }, { - "name" : "name", - "in" : "path", - "description" : "The fully qualified name of the extension", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/config" : { - "get" : { - "tags" : [ "config" ], - "summary" : "Get configration", - "description" : "Gets the NiFi Registry configurations.", - "operationId" : "getConfiguration", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/RegistryConfiguration" - } - }, - "401" : { - "description" : "Client could not be authenticated." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/policies,/tenants", - "action" : "read" - } - } - }, - "/extension-repository" : { - "get" : { - "tags" : [ "extension repository" ], - "summary" : "Get extension repo buckets", - "description" : "Gets the names of the buckets the current user is authorized for in order to browse the repo by bucket. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getExtensionRepoBuckets", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/ExtensionRepoBucket" - } - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ] - } - }, - "/extension-repository/{bucketName}" : { - "get" : { - "tags" : [ "extension repository" ], - "summary" : "Get extension repo groups", - "description" : "Gets the groups in the extension repository in the given bucket. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getExtensionRepoGroups", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketName", - "in" : "path", - "description" : "The bucket name", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/ExtensionRepoGroup" - } - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/extension-repository/{bucketName}/{groupId}" : { - "get" : { - "tags" : [ "extension repository" ], - "summary" : "Get extension repo artifacts", - "description" : "Gets the artifacts in the extension repository in the given bucket and group. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getExtensionRepoArtifacts", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketName", - "in" : "path", - "description" : "The bucket name", - "required" : true, - "type" : "string" - }, { - "name" : "groupId", - "in" : "path", - "description" : "The group id", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/ExtensionRepoArtifact" - } - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/extension-repository/{bucketName}/{groupId}/{artifactId}" : { - "get" : { - "tags" : [ "extension repository" ], - "summary" : "Get extension repo versions", - "description" : "Gets the versions in the extension repository for the given bucket, group, and artifact. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getExtensionRepoVersions", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketName", - "in" : "path", - "description" : "The bucket name", - "required" : true, - "type" : "string" - }, { - "name" : "groupId", - "in" : "path", - "description" : "The group identifier", - "required" : true, - "type" : "string" - }, { - "name" : "artifactId", - "in" : "path", - "description" : "The artifact identifier", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/ExtensionRepoVersionSummary" - } - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/extension-repository/{bucketName}/{groupId}/{artifactId}/{version}" : { - "get" : { - "tags" : [ "extension repository" ], - "summary" : "Get extension repo version", - "description" : "Gets information about the version in the given bucket, group, and artifact. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getExtensionRepoVersion", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketName", - "in" : "path", - "description" : "The bucket name", - "required" : true, - "type" : "string" - }, { - "name" : "groupId", - "in" : "path", - "description" : "The group identifier", - "required" : true, - "type" : "string" - }, { - "name" : "artifactId", - "in" : "path", - "description" : "The artifact identifier", - "required" : true, - "type" : "string" - }, { - "name" : "version", - "in" : "path", - "description" : "The version", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ExtensionRepoVersion" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/extension-repository/{bucketName}/{groupId}/{artifactId}/{version}/content" : { - "get" : { - "tags" : [ "extension repository" ], - "summary" : "Get extension repo version content", - "description" : "Gets the binary content of the bundle with the given bucket, group, artifact, and version. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getExtensionRepoVersionContent", - "consumes" : [ "*/*" ], - "produces" : [ "application/octet-stream" ], - "parameters" : [ { - "name" : "bucketName", - "in" : "path", - "description" : "The bucket name", - "required" : true, - "type" : "string" - }, { - "name" : "groupId", - "in" : "path", - "description" : "The group identifier", - "required" : true, - "type" : "string" - }, { - "name" : "artifactId", - "in" : "path", - "description" : "The artifact identifier", - "required" : true, - "type" : "string" - }, { - "name" : "version", - "in" : "path", - "description" : "The version", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "type" : "string", - "format" : "byte" - } - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/extension-repository/{bucketName}/{groupId}/{artifactId}/{version}/extensions" : { - "get" : { - "tags" : [ "extension repository" ], - "summary" : "Get extension repo extensions", - "description" : "Gets information about the extensions in the given bucket, group, artifact, and version. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getExtensionRepoVersionExtensions", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketName", - "in" : "path", - "description" : "The bucket name", - "required" : true, - "type" : "string" - }, { - "name" : "groupId", - "in" : "path", - "description" : "The group identifier", - "required" : true, - "type" : "string" - }, { - "name" : "artifactId", - "in" : "path", - "description" : "The artifact identifier", - "required" : true, - "type" : "string" - }, { - "name" : "version", - "in" : "path", - "description" : "The version", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/ExtensionMetadata" - } - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/extension-repository/{bucketName}/{groupId}/{artifactId}/{version}/extensions/{name}" : { - "get" : { - "tags" : [ "extension repository" ], - "summary" : "Get extension repo extension", - "description" : "Gets information about the extension with the given name in the given bucket, group, artifact, and version. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getExtensionRepoVersionExtension", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketName", - "in" : "path", - "description" : "The bucket name", - "required" : true, - "type" : "string" - }, { - "name" : "groupId", - "in" : "path", - "description" : "The group identifier", - "required" : true, - "type" : "string" - }, { - "name" : "artifactId", - "in" : "path", - "description" : "The artifact identifier", - "required" : true, - "type" : "string" - }, { - "name" : "version", - "in" : "path", - "description" : "The version", - "required" : true, - "type" : "string" - }, { - "name" : "name", - "in" : "path", - "description" : "The fully qualified name of the extension", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/Extension" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/extension-repository/{bucketName}/{groupId}/{artifactId}/{version}/extensions/{name}/docs" : { - "get" : { - "tags" : [ "extension repository" ], - "summary" : "Get extension repo extension docs", - "description" : "Gets the documentation for the extension with the given name in the given bucket, group, artifact, and version. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getExtensionRepoVersionExtensionDocs", - "consumes" : [ "*/*" ], - "produces" : [ "text/html" ], - "parameters" : [ { - "name" : "bucketName", - "in" : "path", - "description" : "The bucket name", - "required" : true, - "type" : "string" - }, { - "name" : "groupId", - "in" : "path", - "description" : "The group identifier", - "required" : true, - "type" : "string" - }, { - "name" : "artifactId", - "in" : "path", - "description" : "The artifact identifier", - "required" : true, - "type" : "string" - }, { - "name" : "version", - "in" : "path", - "description" : "The version", - "required" : true, - "type" : "string" - }, { - "name" : "name", - "in" : "path", - "description" : "The fully qualified name of the extension", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/extension-repository/{bucketName}/{groupId}/{artifactId}/{version}/extensions/{name}/docs/additional-details" : { - "get" : { - "tags" : [ "extension repository" ], - "summary" : "Get extension repo extension details", - "description" : "Gets the additional details documentation for the extension with the given name in the given bucket, group, artifact, and version. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getExtensionRepoVersionExtensionAdditionalDetailsDocs", - "consumes" : [ "*/*" ], - "produces" : [ "text/html" ], - "parameters" : [ { - "name" : "bucketName", - "in" : "path", - "description" : "The bucket name", - "required" : true, - "type" : "string" - }, { - "name" : "groupId", - "in" : "path", - "description" : "The group identifier", - "required" : true, - "type" : "string" - }, { - "name" : "artifactId", - "in" : "path", - "description" : "The artifact identifier", - "required" : true, - "type" : "string" - }, { - "name" : "version", - "in" : "path", - "description" : "The version", - "required" : true, - "type" : "string" - }, { - "name" : "name", - "in" : "path", - "description" : "The fully qualified name of the extension", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/extension-repository/{bucketName}/{groupId}/{artifactId}/{version}/sha256" : { - "get" : { - "tags" : [ "extension repository" ], - "summary" : "Get extension repo version checksum", - "description" : "Gets the hex representation of the SHA-256 digest for the binary content of the bundle with the given bucket, group, artifact, and version.\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getExtensionRepoVersionSha256", - "consumes" : [ "*/*" ], - "produces" : [ "text/plain" ], - "parameters" : [ { - "name" : "bucketName", - "in" : "path", - "description" : "The bucket name", - "required" : true, - "type" : "string" - }, { - "name" : "groupId", - "in" : "path", - "description" : "The group identifier", - "required" : true, - "type" : "string" - }, { - "name" : "artifactId", - "in" : "path", - "description" : "The artifact identifier", - "required" : true, - "type" : "string" - }, { - "name" : "version", - "in" : "path", - "description" : "The version", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/extension-repository/{groupId}/{artifactId}/{version}/sha256" : { - "get" : { - "tags" : [ "extension repository" ], - "summary" : "Get global extension repo version checksum", - "description" : "Gets the hex representation of the SHA-256 digest for the binary content with the given bucket, group, artifact, and version. Since the same group-artifact-version can exist in multiple buckets, this will return the checksum of the first one returned. This will be consistent since the checksum must be the same when existing in multiple buckets. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getGlobalExtensionRepoVersionSha256", - "consumes" : [ "*/*" ], - "produces" : [ "text/plain" ], - "parameters" : [ { - "name" : "groupId", - "in" : "path", - "description" : "The group identifier", - "required" : true, - "type" : "string" - }, { - "name" : "artifactId", - "in" : "path", - "description" : "The artifact identifier", - "required" : true, - "type" : "string" - }, { - "name" : "version", - "in" : "path", - "description" : "The version", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ] - } - }, - "/extensions" : { - "get" : { - "tags" : [ "extensions" ], - "summary" : "Get all extensions", - "description" : "Gets the metadata for all extensions that match the filter params and are part of bundles located in buckets the current user is authorized for. If the user is not authorized to any buckets, an empty result set will be returned.\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getExtensions", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bundleType", - "in" : "query", - "description" : "The type of bundles to return", - "required" : false, - "type" : "string", - "enum" : [ "nifi-nar", "minifi-cpp" ] - }, { - "name" : "extensionType", - "in" : "query", - "description" : "The type of extensions to return", - "required" : false, - "type" : "string", - "enum" : [ "PROCESSOR", "CONTROLLER_SERVICE", "REPORTING_TASK" ] - }, { - "name" : "tag", - "in" : "query", - "description" : "The tags to filter on, will be used in an OR statement", - "required" : false, - "type" : "array", - "items" : { - "type" : "string" - }, - "collectionFormat" : "multi" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ExtensionMetadataContainer" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ] - } - }, - "/extensions/provided-service-api" : { - "get" : { - "tags" : [ "extensions" ], - "summary" : "Get extensions providing service API", - "description" : "Gets the metadata for extensions that provide the specified API and are part of bundles located in buckets the current user is authorized for. If the user is not authorized to any buckets, an empty result set will be returned.\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getExtensionsProvidingServiceAPI", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "className", - "in" : "query", - "description" : "The name of the service API class", - "required" : true, - "type" : "string" - }, { - "name" : "groupId", - "in" : "query", - "description" : "The groupId of the bundle containing the service API class", - "required" : true, - "type" : "string" - }, { - "name" : "artifactId", - "in" : "query", - "description" : "The artifactId of the bundle containing the service API class", - "required" : true, - "type" : "string" - }, { - "name" : "version", - "in" : "query", - "description" : "The version of the bundle containing the service API class", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ExtensionMetadataContainer" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ] - } - }, - "/extensions/tags" : { - "get" : { - "tags" : [ "extensions" ], - "summary" : "Get extension tags", - "description" : "Gets all the extension tags known to this NiFi Registry instance, along with the number of extensions that have the given tag.\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getTags", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/TagCount" - } - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ] - } - }, - "/flows/fields" : { - "get" : { - "tags" : [ "flows" ], - "summary" : "Get flow fields", - "description" : "Retrieves the flow field names that can be used for searching or sorting on flows.", - "operationId" : "getAvailableFlowFields", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/Fields" - } - } - }, - "security" : [ { - "Authorization" : [ ] - } ] - } - }, - "/flows/{flowId}" : { - "get" : { - "tags" : [ "flows" ], - "summary" : "Get flow", - "description" : "Gets a flow by id.", - "operationId" : "globalGetFlow", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "flowId", - "in" : "path", - "description" : "The flow identifier", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlow" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/flows/{flowId}/versions" : { - "get" : { - "tags" : [ "flows" ], - "summary" : "Get flow versions", - "description" : "Gets summary information for all versions of a given flow. Versions are ordered newest->oldest.", - "operationId" : "globalGetFlowVersions", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "flowId", - "in" : "path", - "description" : "The flow identifier", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/VersionedFlowSnapshotMetadata" - } - } - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/flows/{flowId}/versions/latest" : { - "get" : { - "tags" : [ "flows" ], - "summary" : "Get latest flow version", - "description" : "Gets the latest version of a flow, including metadata and flow content.", - "operationId" : "globalGetLatestFlowVersion", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "flowId", - "in" : "path", - "description" : "The flow identifier", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlowSnapshot" - } - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/flows/{flowId}/versions/latest/metadata" : { - "get" : { - "tags" : [ "flows" ], - "summary" : "Get latest flow version metadata", - "description" : "Gets the metadata for the latest version of a flow.", - "operationId" : "globalGetLatestFlowVersionMetadata", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "flowId", - "in" : "path", - "description" : "The flow identifier", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlowSnapshotMetadata" - } - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/flows/{flowId}/versions/{versionNumber}" : { - "get" : { - "tags" : [ "flows" ], - "summary" : "Get flow version", - "description" : "Gets the given version of a flow, including metadata and flow content.", - "operationId" : "globalGetFlowVersion", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "flowId", - "in" : "path", - "description" : "The flow identifier", - "required" : true, - "type" : "string" - }, { - "name" : "versionNumber", - "in" : "path", - "description" : "The version number", - "required" : true, - "type" : "integer", - "pattern" : "\\d+", - "format" : "int32" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlowSnapshot" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/items" : { - "get" : { - "tags" : [ "items" ], - "summary" : "Get all items", - "description" : "Get items across all buckets. The returned items will include only items from buckets for which the user is authorized. If the user is not authorized to any buckets, an empty list will be returned.", - "operationId" : "getItems", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/BucketItem" - } - } - }, - "401" : { - "description" : "Client could not be authenticated." - } - }, - "security" : [ { - "Authorization" : [ ] - } ] - } - }, - "/items/fields" : { - "get" : { - "tags" : [ "items" ], - "summary" : "Get item fields", - "description" : "Retrieves the item field names for searching or sorting on bucket items.", - "operationId" : "getAvailableBucketItemFields", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/Fields" - } - } - }, - "security" : [ { - "Authorization" : [ ] - } ] - } - }, - "/items/{bucketId}" : { - "get" : { - "tags" : [ "items" ], - "summary" : "Get bucket items", - "description" : "Gets the items located in the given bucket.", - "operationId" : "getItemsInBucket", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketId", - "in" : "path", - "description" : "The bucket identifier", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/BucketItem" - } - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/policies" : { - "get" : { - "tags" : [ "policies" ], - "summary" : "Get all access policies", - "description" : "", - "operationId" : "getAccessPolicies", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/AccessPolicy" - } - } - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/policies", - "action" : "read" - } - }, - "post" : { - "tags" : [ "policies" ], - "summary" : "Create access policy", - "description" : "", - "operationId" : "createAccessPolicy", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The access policy configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/AccessPolicy" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/AccessPolicy" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid. The NiFi Registry might not be configured to use a ConfigurableAccessPolicyProvider." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/policies", - "action" : "write" - } - } - }, - "/policies/resources" : { - "get" : { - "tags" : [ "policies" ], - "summary" : "Get available resources", - "description" : "Gets the available resources that support access/authorization policies", - "operationId" : "getResources", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/Resource" - } - } - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/policies", - "action" : "read" - } - } - }, - "/policies/{action}/{resource}" : { - "get" : { - "tags" : [ "policies" ], - "summary" : "Get access policy for resource", - "description" : "Gets an access policy for the specified action and resource", - "operationId" : "getAccessPolicyForResource", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "action", - "in" : "path", - "description" : "The request action.", - "required" : true, - "type" : "string", - "enum" : [ "read", "write", "delete" ] - }, { - "name" : "resource", - "in" : "path", - "description" : "The resource of the policy.", - "required" : true, - "type" : "string", - "pattern" : ".+" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/AccessPolicy" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/policies", - "action" : "read" - } - } - }, - "/policies/{id}" : { - "get" : { - "tags" : [ "policies" ], - "summary" : "Get access policy", - "description" : "", - "operationId" : "getAccessPolicy", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The access policy id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/AccessPolicy" - } - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/policies", - "action" : "read" - } - }, - "put" : { - "tags" : [ "policies" ], - "summary" : "Update access policy", - "description" : "", - "operationId" : "updateAccessPolicy", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The access policy id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The access policy configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/AccessPolicy" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/AccessPolicy" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid. The NiFi Registry might not be configured to use a ConfigurableAccessPolicyProvider." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/policies", - "action" : "write" - } - }, - "delete" : { - "tags" : [ "policies" ], - "summary" : "Delete access policy", - "description" : "", - "operationId" : "removeAccessPolicy", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The version is used to verify the client is working with the latest version of the entity.", - "required" : true, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The access policy id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/AccessPolicy" - } - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid. The NiFi Registry might not be configured to use a ConfigurableAccessPolicyProvider." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/policies", - "action" : "delete" - } - } - }, - "/tenants/user-groups" : { - "get" : { - "tags" : [ "tenants" ], - "summary" : "Get user groups", - "description" : "\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getUserGroups", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/UserGroup" - } - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/tenants", - "action" : "read" - } - }, - "post" : { - "tags" : [ "tenants" ], - "summary" : "Create user group", - "description" : "\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "createUserGroup", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The user group configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/UserGroup" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/UserGroup" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/tenants", - "action" : "write" - } - } - }, - "/tenants/user-groups/{id}" : { - "get" : { - "tags" : [ "tenants" ], - "summary" : "Get user group", - "description" : "\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getUserGroup", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The user group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/UserGroup" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/tenants", - "action" : "read" - } - }, - "put" : { - "tags" : [ "tenants" ], - "summary" : "Update user group", - "description" : "\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "updateUserGroup", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The user group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The user group configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/UserGroup" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/UserGroup" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/tenants", - "action" : "write" - } - }, - "delete" : { - "tags" : [ "tenants" ], - "summary" : "Delete user group", - "description" : "\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "removeUserGroup", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The version is used to verify the client is working with the latest version of the entity.", - "required" : true, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The user group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/UserGroup" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/tenants", - "action" : "delete" - } - } - }, - "/tenants/users" : { - "get" : { - "tags" : [ "tenants" ], - "summary" : "Get all users", - "description" : "\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getUsers", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/User" - } - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/tenants", - "action" : "read" - } - }, - "post" : { - "tags" : [ "tenants" ], - "summary" : "Create user", - "description" : "\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "createUser", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The user configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/User" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/User" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/tenants", - "action" : "write" - } - } - }, - "/tenants/users/{id}" : { - "get" : { - "tags" : [ "tenants" ], - "summary" : "Get user", - "description" : "\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getUser", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The user id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/User" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/tenants", - "action" : "read" - } - }, - "put" : { - "tags" : [ "tenants" ], - "summary" : "Update user", - "description" : "\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "updateUser", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The user id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The user configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/User" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/User" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/tenants", - "action" : "write" - } - }, - "delete" : { - "tags" : [ "tenants" ], - "summary" : "Delete user", - "description" : "\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "removeUser", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The version is used to verify the client is working with the latest version of the entity.", - "required" : true, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The user id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/User" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/tenants", - "action" : "delete" - } - } - } - }, - "securityDefinitions" : { - "Authorization" : { - "description" : "NiFi Registry Auth Token (JWT)", - "type" : "apiKey", - "name" : "Authorization", - "in" : "header" - }, - "BasicAuth" : { - "description" : "HTTP Basic Auth", - "type" : "basic" - } - }, - "definitions" : { - "AccessPolicy" : { - "type" : "object", - "required" : [ "action", "resource" ], - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The id of the policy. Set by server at creation time.", - "readOnly" : true - }, - "resource" : { - "type" : "string", - "description" : "The resource for this access policy." - }, - "action" : { - "type" : "string", - "description" : "The action associated with this access policy.", - "enum" : [ "read", "write", "delete" ] - }, - "configurable" : { - "type" : "boolean", - "description" : "Indicates if this access policy is configurable, based on which Authorizer has been configured to manage it.", - "readOnly" : true - }, - "revision" : { - "description" : "The revision of this entity used for optimistic-locking during updates.", - "readOnly" : true, - "$ref" : "#/definitions/RevisionInfo" - }, - "users" : { - "type" : "array", - "description" : "The set of user IDs associated with this access policy.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/Tenant" - } - }, - "userGroups" : { - "type" : "array", - "description" : "The set of user group IDs associated with this access policy.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/Tenant" - } - } - } - }, - "AccessPolicySummary" : { - "type" : "object", - "required" : [ "action", "resource" ], - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The id of the policy. Set by server at creation time.", - "readOnly" : true - }, - "resource" : { - "type" : "string", - "description" : "The resource for this access policy." - }, - "action" : { - "type" : "string", - "description" : "The action associated with this access policy.", - "enum" : [ "read", "write", "delete" ] - }, - "configurable" : { - "type" : "boolean", - "description" : "Indicates if this access policy is configurable, based on which Authorizer has been configured to manage it.", - "readOnly" : true - }, - "revision" : { - "description" : "The revision of this entity used for optimistic-locking during updates.", - "readOnly" : true, - "$ref" : "#/definitions/RevisionInfo" - } - } - }, - "AllowableValue" : { - "type" : "object", - "properties" : { - "value" : { - "type" : "string", - "description" : "The value of the allowable value" - }, - "displayName" : { - "type" : "string", - "description" : "The display name of the allowable value" - }, - "description" : { - "type" : "string", - "description" : "The description of the allowable value" - } - } - }, - "Attribute" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The name of the attribute" - }, - "description" : { - "type" : "string", - "description" : "The description of the attribute" - } - } - }, - "BatchSize" : { - "type" : "object", - "properties" : { - "count" : { - "type" : "integer", - "format" : "int32", - "description" : "Preferred number of flow files to include in a transaction." - }, - "size" : { - "type" : "string", - "description" : "Preferred number of bytes to include in a transaction." - }, - "duration" : { - "type" : "string", - "description" : "Preferred amount of time that a transaction should span." - } - } - }, - "Bucket" : { - "type" : "object", - "required" : [ "name" ], - "properties" : { - "link" : { - "description" : "An WebLink to this entity.", - "readOnly" : true, - "$ref" : "#/definitions/JaxbLink" - }, - "identifier" : { - "type" : "string", - "description" : "An ID to uniquely identify this object.", - "readOnly" : true - }, - "name" : { - "type" : "string", - "description" : "The name of the bucket." - }, - "createdTimestamp" : { - "type" : "integer", - "format" : "int64", - "description" : "The timestamp of when the bucket was first created. This is set by the server at creation time.", - "readOnly" : true, - "minimum" : 1 - }, - "description" : { - "type" : "string", - "description" : "A description of the bucket." - }, - "allowBundleRedeploy" : { - "type" : "boolean", - "description" : "Indicates if this bucket allows the same version of an extension bundle to be redeployed and thus overwrite the existing artifact. By default this is false." - }, - "allowPublicRead" : { - "type" : "boolean", - "description" : "Indicates if this bucket allows read access to unauthenticated anonymous users" - }, - "permissions" : { - "description" : "The access that the current user has to this bucket.", - "readOnly" : true, - "$ref" : "#/definitions/Permissions" - }, - "revision" : { - "description" : "The revision of this entity used for optimistic-locking during updates.", - "readOnly" : true, - "$ref" : "#/definitions/RevisionInfo" - } - } - }, - "BucketItem" : { - "type" : "object", - "required" : [ "bucketIdentifier", "name", "type" ], - "properties" : { - "link" : { - "description" : "An WebLink to this entity.", - "readOnly" : true, - "$ref" : "#/definitions/JaxbLink" - }, - "identifier" : { - "type" : "string", - "description" : "An ID to uniquely identify this object.", - "readOnly" : true - }, - "name" : { - "type" : "string", - "description" : "The name of the item." - }, - "description" : { - "type" : "string", - "description" : "A description of the item." - }, - "bucketIdentifier" : { - "type" : "string", - "description" : "The identifier of the bucket this items belongs to. This cannot be changed after the item is created." - }, - "bucketName" : { - "type" : "string", - "description" : "The name of the bucket this items belongs to.", - "readOnly" : true - }, - "createdTimestamp" : { - "type" : "integer", - "format" : "int64", - "description" : "The timestamp of when the item was created, as milliseconds since epoch.", - "readOnly" : true, - "minimum" : 1 - }, - "modifiedTimestamp" : { - "type" : "integer", - "format" : "int64", - "description" : "The timestamp of when the item was last modified, as milliseconds since epoch.", - "readOnly" : true, - "minimum" : 1 - }, - "type" : { - "type" : "string", - "description" : "The type of item.", - "enum" : [ "Flow", "Bundle" ] - }, - "permissions" : { - "description" : "The access that the current user has to the bucket containing this item.", - "readOnly" : true, - "$ref" : "#/definitions/Permissions" - } - } - }, - "BuildInfo" : { - "type" : "object", - "properties" : { - "buildTool" : { - "type" : "string", - "description" : "The tool used to build the version of the bundle" - }, - "buildFlags" : { - "type" : "string", - "description" : "The flags used to build the version of the bundle" - }, - "buildBranch" : { - "type" : "string", - "description" : "The branch used to build the version of the bundle" - }, - "buildTag" : { - "type" : "string", - "description" : "The tag used to build the version of the bundle" - }, - "buildRevision" : { - "type" : "string", - "description" : "The revision used to build the version of the bundle" - }, - "built" : { - "type" : "integer", - "format" : "int64", - "description" : "The timestamp the version of the bundle was built" - }, - "builtBy" : { - "type" : "string", - "description" : "The identity of the user that performed the build" - } - } - }, - "Bundle" : { - "type" : "object", - "properties" : { - "group" : { - "type" : "string", - "description" : "The group of the bundle" - }, - "artifact" : { - "type" : "string", - "description" : "The artifact of the bundle" - }, - "version" : { - "type" : "string", - "description" : "The version of the bundle" - } - } - }, - "BundleInfo" : { - "type" : "object", - "properties" : { - "bucketId" : { - "type" : "string", - "description" : "The id of the bucket where the bundle is located" - }, - "bucketName" : { - "type" : "string", - "description" : "The name of the bucket where the bundle is located" - }, - "bundleId" : { - "type" : "string", - "description" : "The id of the bundle" - }, - "bundleType" : { - "type" : "string", - "description" : "The type of bundle (i.e. a NiFi NAR vs MiNiFi CPP)", - "enum" : [ "NIFI_NAR", "MINIFI_CPP" ] - }, - "groupId" : { - "type" : "string", - "description" : "The group id of the bundle" - }, - "artifactId" : { - "type" : "string", - "description" : "The artifact id of the bundle" - }, - "version" : { - "type" : "string", - "description" : "The version of the bundle" - }, - "systemApiVersion" : { - "type" : "string", - "description" : "The version of the system API the bundle was built against" - } - } - }, - "BundleVersion" : { - "type" : "object", - "required" : [ "versionMetadata" ], - "properties" : { - "link" : { - "description" : "An WebLink to this entity.", - "readOnly" : true, - "$ref" : "#/definitions/JaxbLink" - }, - "versionMetadata" : { - "description" : "The metadata about this version of the extension bundle", - "$ref" : "#/definitions/BundleVersionMetadata" - }, - "dependencies" : { - "type" : "array", - "description" : "The set of other bundle versions that this version is dependent on", - "readOnly" : true, - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/BundleVersionDependency" - } - }, - "bundle" : { - "description" : "The bundle this version is for", - "readOnly" : true, - "$ref" : "#/definitions/ExtensionBundle" - }, - "bucket" : { - "description" : "The bucket that the extension bundle belongs to", - "$ref" : "#/definitions/Bucket" - }, - "filename" : { - "type" : "string" - } - } - }, - "BundleVersionDependency" : { - "type" : "object", - "properties" : { - "groupId" : { - "type" : "string", - "description" : "The group id of the bundle dependency" - }, - "artifactId" : { - "type" : "string", - "description" : "The artifact id of the bundle dependency" - }, - "version" : { - "type" : "string", - "description" : "The version of the bundle dependency" - } - } - }, - "BundleVersionMetadata" : { - "type" : "object", - "required" : [ "bucketId", "buildInfo", "contentSize", "sha256Supplied" ], - "properties" : { - "link" : { - "description" : "An WebLink to this entity.", - "readOnly" : true, - "$ref" : "#/definitions/JaxbLink" - }, - "id" : { - "type" : "string", - "description" : "The id of this version of the extension bundle" - }, - "bundleId" : { - "type" : "string", - "description" : "The id of the extension bundle this version is for" - }, - "bucketId" : { - "type" : "string", - "description" : "The id of the bucket the extension bundle belongs to" - }, - "groupId" : { - "type" : "string" - }, - "artifactId" : { - "type" : "string" - }, - "version" : { - "type" : "string", - "description" : "The version of the extension bundle" - }, - "timestamp" : { - "type" : "integer", - "format" : "int64", - "description" : "The timestamp of the create date of this version", - "minimum" : 1 - }, - "author" : { - "type" : "string", - "description" : "The identity that created this version" - }, - "description" : { - "type" : "string", - "description" : "The description for this version" - }, - "sha256" : { - "type" : "string", - "description" : "The hex representation of the SHA-256 digest of the binary content for this version" - }, - "sha256Supplied" : { - "type" : "boolean", - "description" : "Whether or not the client supplied a SHA-256 when uploading the bundle" - }, - "contentSize" : { - "type" : "integer", - "format" : "int64", - "description" : "The size of the binary content for this version in bytes", - "minimum" : 0 - }, - "systemApiVersion" : { - "type" : "string", - "description" : "The version of the system API that this bundle version was built against" - }, - "buildInfo" : { - "description" : "The build information about this version", - "$ref" : "#/definitions/BuildInfo" - } - } - }, - "ComponentDifference" : { - "type" : "object", - "properties" : { - "valueA" : { - "type" : "string", - "description" : "The earlier value from the difference." - }, - "valueB" : { - "type" : "string", - "description" : "The newer value from the difference." - }, - "changeDescription" : { - "type" : "string", - "description" : "The description of the change." - }, - "differenceType" : { - "type" : "string", - "description" : "The key to the difference." - }, - "differenceTypeDescription" : { - "type" : "string", - "description" : "The description of the change type." - } - } - }, - "ComponentDifferenceGroup" : { - "type" : "object", - "properties" : { - "componentId" : { - "type" : "string", - "description" : "The id of the component whose changes are grouped together." - }, - "componentName" : { - "type" : "string", - "description" : "The name of the component whose changes are grouped together." - }, - "componentType" : { - "type" : "string", - "description" : "The type of component these changes relate to." - }, - "processGroupId" : { - "type" : "string", - "description" : "The process group id for this component." - }, - "differences" : { - "type" : "array", - "description" : "The list of changes related to this component between the 2 versions.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ComponentDifference" - } - } - } - }, - "ConnectableComponent" : { - "type" : "object", - "required" : [ "groupId", "id", "type" ], - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the connectable component." - }, - "type" : { - "type" : "string", - "description" : "The type of component the connectable is.", - "enum" : [ "PROCESSOR", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "INPUT_PORT", "OUTPUT_PORT", "FUNNEL" ] - }, - "groupId" : { - "type" : "string", - "description" : "The id of the group that the connectable component resides in" - }, - "name" : { - "type" : "string", - "description" : "The name of the connectable component" - }, - "comments" : { - "type" : "string", - "description" : "The comments for the connectable component." - } - } - }, - "ControllerServiceAPI" : { - "type" : "object", - "properties" : { - "type" : { - "type" : "string", - "description" : "The fully qualified name of the service interface." - }, - "bundle" : { - "description" : "The details of the artifact that bundled this service interface.", - "$ref" : "#/definitions/Bundle" - } - } - }, - "ControllerServiceDefinition" : { - "type" : "object", - "properties" : { - "className" : { - "type" : "string", - "description" : "The class name of the service API" - }, - "groupId" : { - "type" : "string", - "description" : "The group id of the service API" - }, - "artifactId" : { - "type" : "string", - "description" : "The artifact id of the service API" - }, - "version" : { - "type" : "string", - "description" : "The version of the service API" - } - } - }, - "CurrentUser" : { - "type" : "object", - "properties" : { - "identity" : { - "type" : "string", - "description" : "The identity of the current user", - "readOnly" : true - }, - "anonymous" : { - "type" : "boolean", - "description" : "Indicates if the current user is anonymous", - "readOnly" : true - }, - "loginSupported" : { - "type" : "boolean", - "description" : "Indicates if the NiFi Registry instance supports logging in" - }, - "resourcePermissions" : { - "description" : "The access that the current user has to top level resources", - "readOnly" : true, - "$ref" : "#/definitions/ResourcePermissions" - }, - "oidcloginSupported" : { - "type" : "boolean", - "description" : "Indicates if the NiFi Registry instance supports logging in with an OIDC provider" - } - } - }, - "DeprecationNotice" : { - "type" : "object", - "properties" : { - "reason" : { - "type" : "string", - "description" : "The reason for the deprecation" - }, - "alternatives" : { - "type" : "array", - "xml" : { - "wrapped" : true - }, - "description" : "The alternatives to use", - "items" : { - "type" : "string", - "xml" : { - "name" : "alternative" - } - } - } - } - }, - "DynamicProperty" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The description of the dynamic property name" - }, - "value" : { - "type" : "string", - "description" : "The description of the dynamic property value" - }, - "description" : { - "type" : "string", - "description" : "The description of the dynamic property" - }, - "expressionLanguageScope" : { - "type" : "string", - "description" : "The scope of the expression language support", - "enum" : [ "NONE", "VARIABLE_REGISTRY", "FLOWFILE_ATTRIBUTES" ] - }, - "expressionLanguageSupported" : { - "type" : "boolean", - "description" : "Whether or not expression language is supported" - } - } - }, - "DynamicRelationship" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The description of the dynamic relationship name" - }, - "description" : { - "type" : "string", - "description" : "The description of the dynamic relationship" - } - } - }, - "Extension" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The name of the extension" - }, - "type" : { - "type" : "string", - "description" : "The type of the extension", - "enum" : [ "PROCESSOR", "CONTROLLER_SERVICE", "REPORTING_TASK" ] - }, - "deprecationNotice" : { - "description" : "The deprecation notice of the extension", - "$ref" : "#/definitions/DeprecationNotice" - }, - "description" : { - "type" : "string", - "description" : "The description of the extension" - }, - "tags" : { - "type" : "array", - "xml" : { - "wrapped" : true - }, - "description" : "The tags of the extension", - "items" : { - "type" : "string", - "xml" : { - "name" : "tag" - } - } - }, - "properties" : { - "type" : "array", - "xml" : { - "wrapped" : true - }, - "description" : "The properties of the extension", - "items" : { - "xml" : { - "name" : "property" - }, - "$ref" : "#/definitions/Property" - } - }, - "dynamicProperties" : { - "type" : "array", - "xml" : { - "wrapped" : true - }, - "description" : "The dynamic properties of the extension", - "items" : { - "xml" : { - "name" : "dynamicProperty" - }, - "$ref" : "#/definitions/DynamicProperty" - } - }, - "relationships" : { - "type" : "array", - "xml" : { - "wrapped" : true - }, - "description" : "The relationships of the extension", - "items" : { - "xml" : { - "name" : "relationship" - }, - "$ref" : "#/definitions/Relationship" - } - }, - "dynamicRelationship" : { - "description" : "The dynamic relationships of the extension", - "$ref" : "#/definitions/DynamicRelationship" - }, - "readsAttributes" : { - "type" : "array", - "xml" : { - "wrapped" : true - }, - "description" : "The attributes read from flow files by the extension", - "items" : { - "xml" : { - "name" : "readsAttribute" - }, - "$ref" : "#/definitions/Attribute" - } - }, - "writesAttributes" : { - "type" : "array", - "xml" : { - "wrapped" : true - }, - "description" : "The attributes written to flow files by the extension", - "items" : { - "xml" : { - "name" : "writesAttribute" - }, - "$ref" : "#/definitions/Attribute" - } - }, - "stateful" : { - "description" : "The information about how the extension stores state", - "$ref" : "#/definitions/Stateful" - }, - "restricted" : { - "description" : "The restrictions of the extension", - "$ref" : "#/definitions/Restricted" - }, - "inputRequirement" : { - "type" : "string", - "description" : "The input requirement of the extension", - "enum" : [ "INPUT_REQUIRED", "INPUT_ALLOWED", "INPUT_FORBIDDEN" ] - }, - "systemResourceConsiderations" : { - "type" : "array", - "xml" : { - "wrapped" : true - }, - "description" : "The resource considerations of the extension", - "items" : { - "xml" : { - "name" : "systemResourceConsideration" - }, - "$ref" : "#/definitions/SystemResourceConsideration" - } - }, - "seeAlso" : { - "type" : "array", - "xml" : { - "wrapped" : true - }, - "description" : "The names of other extensions to see", - "items" : { - "type" : "string", - "xml" : { - "name" : "see" - } - } - }, - "providedServiceAPIs" : { - "type" : "array", - "xml" : { - "wrapped" : true - }, - "description" : "The service APIs provided by this extension", - "items" : { - "xml" : { - "name" : "providedServiceAPI" - }, - "$ref" : "#/definitions/ProvidedServiceAPI" - } - } - } - }, - "ExtensionBundle" : { - "type" : "object", - "required" : [ "bucketIdentifier", "bundleType", "name", "type" ], - "properties" : { - "link" : { - "description" : "An WebLink to this entity.", - "readOnly" : true, - "$ref" : "#/definitions/JaxbLink" - }, - "identifier" : { - "type" : "string", - "description" : "An ID to uniquely identify this object.", - "readOnly" : true - }, - "name" : { - "type" : "string", - "description" : "The name of the item." - }, - "description" : { - "type" : "string", - "description" : "A description of the item." - }, - "bucketIdentifier" : { - "type" : "string", - "description" : "The identifier of the bucket this items belongs to. This cannot be changed after the item is created." - }, - "bucketName" : { - "type" : "string", - "description" : "The name of the bucket this items belongs to.", - "readOnly" : true - }, - "createdTimestamp" : { - "type" : "integer", - "format" : "int64", - "description" : "The timestamp of when the item was created, as milliseconds since epoch.", - "readOnly" : true, - "minimum" : 1 - }, - "modifiedTimestamp" : { - "type" : "integer", - "format" : "int64", - "description" : "The timestamp of when the item was last modified, as milliseconds since epoch.", - "readOnly" : true, - "minimum" : 1 - }, - "type" : { - "type" : "string", - "description" : "The type of item.", - "enum" : [ "Flow", "Bundle" ] - }, - "permissions" : { - "description" : "The access that the current user has to the bucket containing this item.", - "readOnly" : true, - "$ref" : "#/definitions/Permissions" - }, - "bundleType" : { - "type" : "string", - "description" : "The type of the extension bundle", - "enum" : [ "NIFI_NAR", "MINIFI_CPP" ] - }, - "groupId" : { - "type" : "string", - "description" : "The group id of the extension bundle" - }, - "artifactId" : { - "type" : "string", - "description" : "The artifact id of the extension bundle" - }, - "versionCount" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of versions of this extension bundle.", - "readOnly" : true, - "minimum" : 0 - } - } - }, - "ExtensionFilterParams" : { - "type" : "object", - "properties" : { - "bundleType" : { - "type" : "string", - "description" : "The type of bundle", - "enum" : [ "NIFI_NAR", "MINIFI_CPP" ] - }, - "extensionType" : { - "type" : "string", - "description" : "The type of extension", - "enum" : [ "PROCESSOR", "CONTROLLER_SERVICE", "REPORTING_TASK" ] - }, - "tags" : { - "type" : "array", - "description" : "The tags", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - } - } - }, - "ExtensionMetadata" : { - "type" : "object", - "properties" : { - "link" : { - "description" : "An WebLink to this entity.", - "readOnly" : true, - "$ref" : "#/definitions/JaxbLink" - }, - "name" : { - "type" : "string", - "description" : "The name of the extension" - }, - "displayName" : { - "type" : "string", - "description" : "The display name of the extension" - }, - "type" : { - "type" : "string", - "description" : "The type of the extension", - "enum" : [ "PROCESSOR", "CONTROLLER_SERVICE", "REPORTING_TASK" ] - }, - "description" : { - "type" : "string", - "description" : "The description of the extension" - }, - "deprecationNotice" : { - "description" : "The deprecation notice of the extension", - "$ref" : "#/definitions/DeprecationNotice" - }, - "tags" : { - "type" : "array", - "description" : "The tags of the extension", - "items" : { - "type" : "string" - } - }, - "restricted" : { - "description" : "The restrictions of the extension", - "$ref" : "#/definitions/Restricted" - }, - "providedServiceAPIs" : { - "type" : "array", - "description" : "The service APIs provided by the extension", - "items" : { - "$ref" : "#/definitions/ProvidedServiceAPI" - } - }, - "bundleInfo" : { - "description" : "The information for the bundle where this extension is located", - "$ref" : "#/definitions/BundleInfo" - }, - "hasAdditionalDetails" : { - "type" : "boolean", - "description" : "Whether or not the extension has additional detail documentation" - }, - "linkDocs" : { - "description" : "A WebLink to the documentation for this extension.", - "readOnly" : true, - "$ref" : "#/definitions/JaxbLink" - } - } - }, - "ExtensionMetadataContainer" : { - "type" : "object", - "properties" : { - "numResults" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of extensions in the response" - }, - "filterParams" : { - "description" : "The filter parameters submitted for the request", - "$ref" : "#/definitions/ExtensionFilterParams" - }, - "extensions" : { - "type" : "array", - "description" : "The metadata for the extensions", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ExtensionMetadata" - } - } - } - }, - "ExtensionRepoArtifact" : { - "type" : "object", - "properties" : { - "link" : { - "description" : "An WebLink to this entity.", - "readOnly" : true, - "$ref" : "#/definitions/JaxbLink" - }, - "bucketName" : { - "type" : "string", - "description" : "The bucket name" - }, - "groupId" : { - "type" : "string", - "description" : "The group id" - }, - "artifactId" : { - "type" : "string", - "description" : "The artifact id" - } - } - }, - "ExtensionRepoBucket" : { - "type" : "object", - "properties" : { - "link" : { - "description" : "An WebLink to this entity.", - "readOnly" : true, - "$ref" : "#/definitions/JaxbLink" - }, - "bucketName" : { - "type" : "string", - "description" : "The name of the bucket" - } - } - }, - "ExtensionRepoGroup" : { - "type" : "object", - "properties" : { - "link" : { - "description" : "An WebLink to this entity.", - "readOnly" : true, - "$ref" : "#/definitions/JaxbLink" - }, - "bucketName" : { - "type" : "string", - "description" : "The bucket name" - }, - "groupId" : { - "type" : "string", - "description" : "The group id" - } - } - }, - "ExtensionRepoVersion" : { - "type" : "object", - "properties" : { - "extensionsLink" : { - "description" : "The WebLink to view the metadata about the extensions contained in the extension bundle.", - "readOnly" : true, - "$ref" : "#/definitions/JaxbLink" - }, - "downloadLink" : { - "description" : "The WebLink to download this version of the extension bundle.", - "readOnly" : true, - "$ref" : "#/definitions/JaxbLink" - }, - "sha256Link" : { - "description" : "The WebLink to retrieve the SHA-256 digest for this version of the extension bundle.", - "readOnly" : true, - "$ref" : "#/definitions/JaxbLink" - }, - "sha256Supplied" : { - "description" : "Indicates if the client supplied a SHA-256 when uploading this version of the extension bundle.", - "readOnly" : true, - "$ref" : "#/definitions/JaxbLink" - } - } - }, - "ExtensionRepoVersionSummary" : { - "type" : "object", - "properties" : { - "link" : { - "description" : "An WebLink to this entity.", - "readOnly" : true, - "$ref" : "#/definitions/JaxbLink" - }, - "bucketName" : { - "type" : "string", - "description" : "The bucket name" - }, - "groupId" : { - "type" : "string", - "description" : "The group id" - }, - "artifactId" : { - "type" : "string", - "description" : "The artifact id" - }, - "version" : { - "type" : "string", - "description" : "The version" - }, - "author" : { - "type" : "string", - "description" : "The identity of the user that created this version" - }, - "timestamp" : { - "type" : "integer", - "format" : "int64", - "description" : "The timestamp of when this version was created" - } - } - }, - "ExternalControllerServiceReference" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The identifier of the controller service" - }, - "name" : { - "type" : "string", - "description" : "The name of the controller service" - } - } - }, - "Fields" : { - "type" : "object", - "properties" : { - "fields" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - } - } - }, - "JaxbLink" : { - "type" : "object", - "properties" : { - "href" : { - "type" : "string", - "format" : "uri", - "xml" : { - "attribute" : true - }, - "description" : "The href for the link" - }, - "params" : { - "type" : "object", - "description" : "The params for the link", - "additionalProperties" : { - "type" : "string" - } - } - } - }, - "Permissions" : { - "type" : "object", - "properties" : { - "canRead" : { - "type" : "boolean", - "description" : "Indicates whether the user can read a given resource.", - "readOnly" : true - }, - "canWrite" : { - "type" : "boolean", - "description" : "Indicates whether the user can write a given resource.", - "readOnly" : true - }, - "canDelete" : { - "type" : "boolean", - "description" : "Indicates whether the user can delete a given resource.", - "readOnly" : true - } - } - }, - "Position" : { - "type" : "object", - "properties" : { - "x" : { - "type" : "number", - "format" : "double", - "description" : "The x coordinate." - }, - "y" : { - "type" : "number", - "format" : "double", - "description" : "The y coordinate." - } - }, - "description" : "The position of a component on the graph" - }, - "Property" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The name of the property" - }, - "displayName" : { - "type" : "string", - "description" : "The display name" - }, - "description" : { - "type" : "string", - "description" : "The description" - }, - "defaultValue" : { - "type" : "string", - "description" : "The default value" - }, - "controllerServiceDefinition" : { - "description" : "The controller service required by this property, or null if none is required", - "$ref" : "#/definitions/ControllerServiceDefinition" - }, - "allowableValues" : { - "type" : "array", - "xml" : { - "wrapped" : true - }, - "description" : "The allowable values for this property", - "items" : { - "xml" : { - "name" : "allowableValue" - }, - "$ref" : "#/definitions/AllowableValue" - } - }, - "required" : { - "type" : "boolean", - "description" : "Whether or not the property is required" - }, - "sensitive" : { - "type" : "boolean", - "description" : "Whether or not the property is sensitive" - }, - "expressionLanguageSupported" : { - "type" : "boolean", - "description" : "Whether or not expression language is supported" - }, - "expressionLanguageScope" : { - "type" : "string", - "description" : "The scope of expression language support", - "enum" : [ "NONE", "VARIABLE_REGISTRY", "FLOWFILE_ATTRIBUTES" ] - }, - "dynamicallyModifiesClasspath" : { - "type" : "boolean", - "description" : "Whether or not the processor dynamically modifies the classpath" - }, - "dynamic" : { - "type" : "boolean", - "description" : "Whether or not the processor is dynamic" - } - } - }, - "ProvidedServiceAPI" : { - "type" : "object", - "properties" : { - "className" : { - "type" : "string", - "description" : "The class name of the service API being provided" - }, - "groupId" : { - "type" : "string", - "description" : "The group id of the service API being provided" - }, - "artifactId" : { - "type" : "string", - "description" : "The artifact id of the service API being provided" - }, - "version" : { - "type" : "string", - "description" : "The version of the service API being provided" - } - } - }, - "RegistryConfiguration" : { - "type" : "object", - "properties" : { - "supportsManagedAuthorizer" : { - "type" : "boolean", - "description" : "Whether this NiFi Registry supports a managed authorizer. Managed authorizers can visualize users, groups, and policies in the UI.", - "readOnly" : true - }, - "supportsConfigurableAuthorizer" : { - "type" : "boolean", - "description" : "Whether this NiFi Registry supports a configurable authorizer.", - "readOnly" : true - }, - "supportsConfigurableUsersAndGroups" : { - "type" : "boolean", - "description" : "Whether this NiFi Registry supports configurable users and groups.", - "readOnly" : true - } - } - }, - "Relationship" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The name of the relationship" - }, - "description" : { - "type" : "string", - "description" : "The description of the relationship" - }, - "autoTerminated" : { - "type" : "boolean", - "description" : "Whether or not the relationship is auto-terminated by default" - } - } - }, - "Resource" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The identifier of the resource.", - "readOnly" : true - }, - "name" : { - "type" : "string", - "description" : "The name of the resource.", - "readOnly" : true - } - } - }, - "ResourcePermissions" : { - "type" : "object", - "properties" : { - "buckets" : { - "description" : "The access that the current user has to the top level /buckets resource of this NiFi Registry (i.e., access to all buckets)", - "readOnly" : true, - "$ref" : "#/definitions/Permissions" - }, - "tenants" : { - "description" : "The access that the current user has to the top level /tenants resource of this NiFi Registry", - "readOnly" : true, - "$ref" : "#/definitions/Permissions" - }, - "policies" : { - "description" : "The access that the current user has to the top level /policies resource of this NiFi Registry", - "readOnly" : true, - "$ref" : "#/definitions/Permissions" - }, - "proxy" : { - "description" : "The access that the current user has to the top level /proxy resource of this NiFi Registry", - "readOnly" : true, - "$ref" : "#/definitions/Permissions" - }, - "anyTopLevelResource" : { - "description" : "The access that the current user has to any top level resources (a logical 'OR' of all other values)", - "readOnly" : true, - "$ref" : "#/definitions/Permissions" - } - } - }, - "Restricted" : { - "type" : "object", - "properties" : { - "generalRestrictionExplanation" : { - "type" : "string", - "description" : "The general restriction for the extension, or null if only specific restrictions exist" - }, - "restrictions" : { - "type" : "array", - "xml" : { - "wrapped" : true - }, - "description" : "The specific restrictions", - "items" : { - "xml" : { - "name" : "restriction" - }, - "$ref" : "#/definitions/Restriction" - } - } - } - }, - "Restriction" : { - "type" : "object", - "properties" : { - "requiredPermission" : { - "type" : "string", - "description" : "The permission required for this restriction" - }, - "explanation" : { - "type" : "string", - "description" : "The explanation of this restriction" - } - } - }, - "RevisionInfo" : { - "type" : "object", - "properties" : { - "clientId" : { - "type" : "string", - "description" : "A client identifier used to make a request. By including a client identifier, the API can allow multiple requests without needing the current revision. Due to the asynchronous nature of requests/responses this was implemented to allow the client to make numerous requests without having to wait for the previous response to come back." - }, - "version" : { - "type" : "integer", - "format" : "int64", - "description" : "NiFi Registry employs an optimistic locking strategy where the client must include a revision in their request when performing an update. In a response to a mutable flow request, this field represents the updated base version." - }, - "lastModifier" : { - "type" : "string", - "description" : "The user that last modified the entity.", - "readOnly" : true - } - }, - "description" : "The revision information for an entity managed through the REST API." - }, - "Stateful" : { - "type" : "object", - "properties" : { - "description" : { - "type" : "string", - "description" : "The description for how the extension stores state" - }, - "scopes" : { - "type" : "array", - "xml" : { - "wrapped" : true - }, - "description" : "The scopes used to store state", - "items" : { - "type" : "string", - "xml" : { - "name" : "scope" - }, - "enum" : [ "CLUSTER", "LOCAL" ] - } - } - } - }, - "SystemResourceConsideration" : { - "type" : "object", - "properties" : { - "resource" : { - "type" : "string", - "description" : "The resource to consider" - }, - "description" : { - "type" : "string", - "description" : "The description of how the resource is affected" - } - } - }, - "TagCount" : { - "type" : "object", - "properties" : { - "tag" : { - "type" : "string", - "description" : "The tag label" - }, - "count" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of occurrences of the given tag" - } - } - }, - "Tenant" : { - "type" : "object", - "required" : [ "identity" ], - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The computer-generated identifier of the tenant.", - "readOnly" : true - }, - "identity" : { - "type" : "string", - "description" : "The human-facing identity of the tenant. This can only be changed if the tenant is configurable." - }, - "configurable" : { - "type" : "boolean", - "description" : "Indicates if this tenant is configurable, based on which UserGroupProvider has been configured to manage it.", - "readOnly" : true - }, - "resourcePermissions" : { - "description" : "A summary top-level resource access policies granted to this tenant.", - "readOnly" : true, - "$ref" : "#/definitions/ResourcePermissions" - }, - "accessPolicies" : { - "type" : "array", - "description" : "The access policies granted to this tenant.", - "readOnly" : true, - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/AccessPolicySummary" - } - }, - "revision" : { - "description" : "The revision of this entity used for optimistic-locking during updates.", - "readOnly" : true, - "$ref" : "#/definitions/RevisionInfo" - } - } - }, - "User" : { - "type" : "object", - "required" : [ "identity" ], - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The computer-generated identifier of the tenant.", - "readOnly" : true - }, - "identity" : { - "type" : "string", - "description" : "The human-facing identity of the tenant. This can only be changed if the tenant is configurable." - }, - "configurable" : { - "type" : "boolean", - "description" : "Indicates if this tenant is configurable, based on which UserGroupProvider has been configured to manage it.", - "readOnly" : true - }, - "resourcePermissions" : { - "description" : "A summary top-level resource access policies granted to this tenant.", - "readOnly" : true, - "$ref" : "#/definitions/ResourcePermissions" - }, - "accessPolicies" : { - "type" : "array", - "description" : "The access policies granted to this tenant.", - "readOnly" : true, - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/AccessPolicySummary" - } - }, - "revision" : { - "description" : "The revision of this entity used for optimistic-locking during updates.", - "readOnly" : true, - "$ref" : "#/definitions/RevisionInfo" - }, - "userGroups" : { - "type" : "array", - "description" : "The groups to which the user belongs.", - "readOnly" : true, - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/Tenant" - } - } - } - }, - "UserGroup" : { - "type" : "object", - "required" : [ "identity" ], - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The computer-generated identifier of the tenant.", - "readOnly" : true - }, - "identity" : { - "type" : "string", - "description" : "The human-facing identity of the tenant. This can only be changed if the tenant is configurable." - }, - "configurable" : { - "type" : "boolean", - "description" : "Indicates if this tenant is configurable, based on which UserGroupProvider has been configured to manage it.", - "readOnly" : true - }, - "resourcePermissions" : { - "description" : "A summary top-level resource access policies granted to this tenant.", - "readOnly" : true, - "$ref" : "#/definitions/ResourcePermissions" - }, - "accessPolicies" : { - "type" : "array", - "description" : "The access policies granted to this tenant.", - "readOnly" : true, - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/AccessPolicySummary" - } - }, - "revision" : { - "description" : "The revision of this entity used for optimistic-locking during updates.", - "readOnly" : true, - "$ref" : "#/definitions/RevisionInfo" - }, - "users" : { - "type" : "array", - "description" : "The users that belong to this user group. This can only be changed if this group is configurable.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/Tenant" - } - } - } - }, - "VersionedConnection" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The component's unique identifier" - }, - "name" : { - "type" : "string", - "description" : "The component's name" - }, - "comments" : { - "type" : "string", - "description" : "The user-supplied comments for the component" - }, - "position" : { - "description" : "The component's position on the graph", - "$ref" : "#/definitions/Position" - }, - "source" : { - "description" : "The source of the connection.", - "$ref" : "#/definitions/ConnectableComponent" - }, - "destination" : { - "description" : "The destination of the connection.", - "$ref" : "#/definitions/ConnectableComponent" - }, - "labelIndex" : { - "type" : "integer", - "format" : "int32", - "description" : "The index of the bend point where to place the connection label." - }, - "zIndex" : { - "type" : "integer", - "format" : "int64", - "description" : "The z index of the connection." - }, - "selectedRelationships" : { - "type" : "array", - "description" : "The selected relationship that comprise the connection.", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - }, - "backPressureObjectThreshold" : { - "type" : "integer", - "format" : "int64", - "description" : "The object count threshold for determining when back pressure is applied. Updating this value is a passive change in the sense that it won't impact whether existing files over the limit are affected but it does help feeder processors to stop pushing too much into this work queue." - }, - "backPressureDataSizeThreshold" : { - "type" : "string", - "description" : "The object data size threshold for determining when back pressure is applied. Updating this value is a passive change in the sense that it won't impact whether existing files over the limit are affected but it does help feeder processors to stop pushing too much into this work queue." - }, - "flowFileExpiration" : { - "type" : "string", - "description" : "The amount of time a flow file may be in the flow before it will be automatically aged out of the flow. Once a flow file reaches this age it will be terminated from the flow the next time a processor attempts to start work on it." - }, - "prioritizers" : { - "type" : "array", - "description" : "The comparators used to prioritize the queue.", - "items" : { - "type" : "string" - } - }, - "bends" : { - "type" : "array", - "description" : "The bend points on the connection.", - "items" : { - "$ref" : "#/definitions/Position" - } - }, - "loadBalanceStrategy" : { - "type" : "string", - "description" : "The Strategy to use for load balancing data across the cluster, or null, if no Load Balance Strategy has been specified.", - "enum" : [ "DO_NOT_LOAD_BALANCE", "PARTITION_BY_ATTRIBUTE", "ROUND_ROBIN", "SINGLE_NODE" ] - }, - "partitioningAttribute" : { - "type" : "string", - "description" : "The attribute to use for partitioning data as it is load balanced across the cluster. If the Load Balance Strategy is configured to use PARTITION_BY_ATTRIBUTE, the value returned by this method is the name of the FlowFile Attribute that will be used to determine which node in the cluster should receive a given FlowFile. If the Load Balance Strategy is unset or is set to any other value, the Partitioning Attribute has no effect." - }, - "loadBalanceCompression" : { - "type" : "string", - "description" : "Whether or not compression should be used when transferring FlowFiles between nodes", - "enum" : [ "DO_NOT_COMPRESS", "COMPRESS_ATTRIBUTES_ONLY", "COMPRESS_ATTRIBUTES_AND_CONTENT" ] - }, - "componentType" : { - "type" : "string", - "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE" ] - }, - "groupIdentifier" : { - "type" : "string", - "description" : "The ID of the Process Group that this component belongs to" - } - } - }, - "VersionedControllerService" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The component's unique identifier" - }, - "name" : { - "type" : "string", - "description" : "The component's name" - }, - "comments" : { - "type" : "string", - "description" : "The user-supplied comments for the component" - }, - "position" : { - "description" : "The component's position on the graph", - "$ref" : "#/definitions/Position" - }, - "type" : { - "type" : "string", - "description" : "The type of the controller service." - }, - "bundle" : { - "description" : "The details of the artifact that bundled this processor type.", - "$ref" : "#/definitions/Bundle" - }, - "controllerServiceApis" : { - "type" : "array", - "description" : "Lists the APIs this Controller Service implements.", - "items" : { - "$ref" : "#/definitions/ControllerServiceAPI" - } - }, - "properties" : { - "type" : "object", - "description" : "The properties of the controller service.", - "additionalProperties" : { - "type" : "string" - } - }, - "propertyDescriptors" : { - "type" : "object", - "description" : "The property descriptors for the processor.", - "additionalProperties" : { - "$ref" : "#/definitions/VersionedPropertyDescriptor" - } - }, - "annotationData" : { - "type" : "string", - "description" : "The annotation for the controller service. This is how the custom UI relays configuration to the controller service." - }, - "componentType" : { - "type" : "string", - "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE" ] - }, - "groupIdentifier" : { - "type" : "string", - "description" : "The ID of the Process Group that this component belongs to" - } - } - }, - "VersionedFlow" : { - "type" : "object", - "required" : [ "bucketIdentifier", "name", "type" ], - "properties" : { - "link" : { - "description" : "An WebLink to this entity.", - "readOnly" : true, - "$ref" : "#/definitions/JaxbLink" - }, - "identifier" : { - "type" : "string", - "description" : "An ID to uniquely identify this object.", - "readOnly" : true - }, - "name" : { - "type" : "string", - "description" : "The name of the item." - }, - "description" : { - "type" : "string", - "description" : "A description of the item." - }, - "bucketIdentifier" : { - "type" : "string", - "description" : "The identifier of the bucket this items belongs to. This cannot be changed after the item is created." - }, - "bucketName" : { - "type" : "string", - "description" : "The name of the bucket this items belongs to.", - "readOnly" : true - }, - "createdTimestamp" : { - "type" : "integer", - "format" : "int64", - "description" : "The timestamp of when the item was created, as milliseconds since epoch.", - "readOnly" : true, - "minimum" : 1 - }, - "modifiedTimestamp" : { - "type" : "integer", - "format" : "int64", - "description" : "The timestamp of when the item was last modified, as milliseconds since epoch.", - "readOnly" : true, - "minimum" : 1 - }, - "type" : { - "type" : "string", - "description" : "The type of item.", - "enum" : [ "Flow", "Bundle" ] - }, - "permissions" : { - "description" : "The access that the current user has to the bucket containing this item.", - "readOnly" : true, - "$ref" : "#/definitions/Permissions" - }, - "versionCount" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of versions of this flow.", - "readOnly" : true, - "minimum" : 0 - }, - "revision" : { - "description" : "The revision of this entity used for optimistic-locking during updates.", - "readOnly" : true, - "$ref" : "#/definitions/RevisionInfo" - } - } - }, - "VersionedFlowCoordinates" : { - "type" : "object", - "properties" : { - "registryUrl" : { - "type" : "string", - "description" : "The URL of the Flow Registry that contains the flow" - }, - "bucketId" : { - "type" : "string", - "description" : "The UUID of the bucket that the flow resides in" - }, - "flowId" : { - "type" : "string", - "description" : "The UUID of the flow" - }, - "version" : { - "type" : "integer", - "format" : "int32", - "description" : "The version of the flow" - }, - "latest" : { - "type" : "boolean", - "description" : "Whether or not these coordinates point to the latest version of the flow" - } - } - }, - "VersionedFlowDifference" : { - "type" : "object", - "properties" : { - "bucketId" : { - "type" : "string", - "description" : "The id of the bucket that the flow is stored in." - }, - "flowId" : { - "type" : "string", - "description" : "The id of the flow that is being examined." - }, - "versionA" : { - "type" : "integer", - "format" : "int32", - "description" : "The earlier version from the diff operation." - }, - "versionB" : { - "type" : "integer", - "format" : "int32", - "description" : "The latter version from the diff operation." - }, - "componentDifferenceGroups" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ComponentDifferenceGroup" - } - } - } - }, - "VersionedFlowSnapshot" : { - "type" : "object", - "required" : [ "flowContents", "snapshotMetadata" ], - "properties" : { - "snapshotMetadata" : { - "description" : "The metadata for this snapshot", - "$ref" : "#/definitions/VersionedFlowSnapshotMetadata" - }, - "flowContents" : { - "description" : "The contents of the versioned flow", - "$ref" : "#/definitions/VersionedProcessGroup" - }, - "externalControllerServices" : { - "type" : "object", - "description" : "The information about controller services that exist outside this versioned flow, but are referenced by components within the versioned flow.", - "additionalProperties" : { - "$ref" : "#/definitions/ExternalControllerServiceReference" - } - }, - "parameterContexts" : { - "type" : "object", - "description" : "The parameter contexts referenced by process groups in the flow contents. The mapping is from the name of the context to the context instance, and it is expected that any context in this map is referenced by at least one process group in this flow.", - "additionalProperties" : { - "$ref" : "#/definitions/VersionedParameterContext" - } - }, - "flowEncodingVersion" : { - "type" : "string", - "description" : "The optional encoding version of the flow contents." - }, - "flow" : { - "description" : "The flow this snapshot is for", - "readOnly" : true, - "$ref" : "#/definitions/VersionedFlow" - }, - "bucket" : { - "description" : "The bucket where the flow is located", - "readOnly" : true, - "$ref" : "#/definitions/Bucket" - }, - "latest" : { - "type" : "boolean" - } - } - }, - "VersionedFlowSnapshotMetadata" : { - "type" : "object", - "required" : [ "bucketIdentifier", "flowIdentifier", "version" ], - "properties" : { - "link" : { - "description" : "An WebLink to this entity.", - "readOnly" : true, - "$ref" : "#/definitions/JaxbLink" - }, - "bucketIdentifier" : { - "type" : "string", - "description" : "The identifier of the bucket this snapshot belongs to." - }, - "flowIdentifier" : { - "type" : "string", - "description" : "The identifier of the flow this snapshot belongs to." - }, - "version" : { - "type" : "integer", - "format" : "int32", - "description" : "The version of this snapshot of the flow.", - "minimum" : -1 - }, - "timestamp" : { - "type" : "integer", - "format" : "int64", - "description" : "The timestamp when the flow was saved, as milliseconds since epoch.", - "readOnly" : true, - "minimum" : 1 - }, - "author" : { - "type" : "string", - "description" : "The user that created this snapshot of the flow.", - "readOnly" : true - }, - "comments" : { - "type" : "string", - "description" : "The comments provided by the user when creating the snapshot." - } - } - }, - "VersionedFunnel" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The component's unique identifier" - }, - "name" : { - "type" : "string", - "description" : "The component's name" - }, - "comments" : { - "type" : "string", - "description" : "The user-supplied comments for the component" - }, - "position" : { - "description" : "The component's position on the graph", - "$ref" : "#/definitions/Position" - }, - "componentType" : { - "type" : "string", - "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE" ] - }, - "groupIdentifier" : { - "type" : "string", - "description" : "The ID of the Process Group that this component belongs to" - } - } - }, - "VersionedLabel" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The component's unique identifier" - }, - "name" : { - "type" : "string", - "description" : "The component's name" - }, - "comments" : { - "type" : "string", - "description" : "The user-supplied comments for the component" - }, - "position" : { - "description" : "The component's position on the graph", - "$ref" : "#/definitions/Position" - }, - "label" : { - "type" : "string", - "description" : "The text that appears in the label." - }, - "width" : { - "type" : "number", - "format" : "double", - "description" : "The width of the label in pixels when at a 1:1 scale." - }, - "height" : { - "type" : "number", - "format" : "double", - "description" : "The height of the label in pixels when at a 1:1 scale." - }, - "style" : { - "type" : "object", - "description" : "The styles for this label (font-size : 12px, background-color : #eee, etc).", - "additionalProperties" : { - "type" : "string" - } - }, - "componentType" : { - "type" : "string", - "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE" ] - }, - "groupIdentifier" : { - "type" : "string", - "description" : "The ID of the Process Group that this component belongs to" - } - } - }, - "VersionedParameter" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The name of the parameter" - }, - "description" : { - "type" : "string", - "description" : "The description of the param" - }, - "sensitive" : { - "type" : "boolean", - "description" : "Whether or not the parameter value is sensitive" - }, - "value" : { - "type" : "string", - "description" : "The value of the parameter" - } - } - }, - "VersionedParameterContext" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The name of the context" - }, - "description" : { - "type" : "string", - "description" : "The description of the parameter context" - }, - "parameters" : { - "type" : "array", - "description" : "The parameters in the context", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedParameter" - } - } - } - }, - "VersionedPort" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The component's unique identifier" - }, - "name" : { - "type" : "string", - "description" : "The component's name" - }, - "comments" : { - "type" : "string", - "description" : "The user-supplied comments for the component" - }, - "position" : { - "description" : "The component's position on the graph", - "$ref" : "#/definitions/Position" - }, - "type" : { - "type" : "string", - "description" : "The type of port.", - "enum" : [ "INPUT_PORT", "OUTPUT_PORT" ] - }, - "concurrentlySchedulableTaskCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of tasks that should be concurrently scheduled for the port." - }, - "scheduledState" : { - "type" : "string", - "description" : "The scheduled state of the component", - "enum" : [ "ENABLED", "DISABLED" ] - }, - "allowRemoteAccess" : { - "type" : "boolean", - "description" : "Whether or not this port allows remote access for site-to-site" - }, - "componentType" : { - "type" : "string", - "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE" ] - }, - "groupIdentifier" : { - "type" : "string", - "description" : "The ID of the Process Group that this component belongs to" - } - } - }, - "VersionedProcessGroup" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The component's unique identifier" - }, - "name" : { - "type" : "string", - "description" : "The component's name" - }, - "comments" : { - "type" : "string", - "description" : "The user-supplied comments for the component" - }, - "position" : { - "description" : "The component's position on the graph", - "$ref" : "#/definitions/Position" - }, - "processGroups" : { - "type" : "array", - "description" : "The child Process Groups", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedProcessGroup" - } - }, - "remoteProcessGroups" : { - "type" : "array", - "description" : "The Remote Process Groups", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedRemoteProcessGroup" - } - }, - "processors" : { - "type" : "array", - "description" : "The Processors", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedProcessor" - } - }, - "inputPorts" : { - "type" : "array", - "description" : "The Input Ports", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedPort" - } - }, - "outputPorts" : { - "type" : "array", - "description" : "The Output Ports", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedPort" - } - }, - "connections" : { - "type" : "array", - "description" : "The Connections", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedConnection" - } - }, - "labels" : { - "type" : "array", - "description" : "The Labels", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedLabel" - } - }, - "funnels" : { - "type" : "array", - "description" : "The Funnels", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedFunnel" - } - }, - "controllerServices" : { - "type" : "array", - "description" : "The Controller Services", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedControllerService" - } - }, - "versionedFlowCoordinates" : { - "description" : "The coordinates where the remote flow is stored, or null if the Process Group is not directly under Version Control", - "$ref" : "#/definitions/VersionedFlowCoordinates" - }, - "variables" : { - "type" : "object", - "description" : "The Variables in the Variable Registry for this Process Group (not including any ancestor or descendant Process Groups)", - "additionalProperties" : { - "type" : "string" - } - }, - "parameterContextName" : { - "type" : "string", - "description" : "The name of the parameter context used by this process group" - }, - "componentType" : { - "type" : "string", - "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE" ] - }, - "flowFileConcurrency" : { - "type" : "string", - "description" : "The configured FlowFile Concurrency for the Process Group" - }, - "flowFileOutboundPolicy" : { - "type" : "string", - "description" : "The FlowFile Outbound Policy for the Process Group" - }, - "groupIdentifier" : { - "type" : "string", - "description" : "The ID of the Process Group that this component belongs to" - } - } - }, - "VersionedProcessor" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The component's unique identifier" - }, - "name" : { - "type" : "string", - "description" : "The component's name" - }, - "comments" : { - "type" : "string", - "description" : "The user-supplied comments for the component" - }, - "position" : { - "description" : "The component's position on the graph", - "$ref" : "#/definitions/Position" - }, - "bundle" : { - "description" : "Information about the bundle from which the component came", - "$ref" : "#/definitions/Bundle" - }, - "style" : { - "type" : "object", - "description" : "Stylistic data for rendering in a UI", - "additionalProperties" : { - "type" : "string" - } - }, - "type" : { - "type" : "string", - "description" : "The type of Processor" - }, - "properties" : { - "type" : "object", - "description" : "The properties for the processor. Properties whose value is not set will only contain the property name.", - "additionalProperties" : { - "type" : "string" - } - }, - "propertyDescriptors" : { - "type" : "object", - "description" : "The property descriptors for the processor.", - "additionalProperties" : { - "$ref" : "#/definitions/VersionedPropertyDescriptor" - } - }, - "annotationData" : { - "type" : "string", - "description" : "The annotation data for the processor used to relay configuration between a custom UI and the procesosr." - }, - "schedulingPeriod" : { - "type" : "string", - "description" : "The frequency with which to schedule the processor. The format of the value will depend on th value of schedulingStrategy." - }, - "schedulingStrategy" : { - "type" : "string", - "description" : "Indcates whether the prcessor should be scheduled to run in event or timer driven mode." - }, - "executionNode" : { - "type" : "string", - "description" : "Indicates the node where the process will execute." - }, - "penaltyDuration" : { - "type" : "string", - "description" : "The amout of time that is used when the process penalizes a flowfile." - }, - "yieldDuration" : { - "type" : "string", - "description" : "The amount of time that must elapse before this processor is scheduled again after yielding." - }, - "bulletinLevel" : { - "type" : "string", - "description" : "The level at which the processor will report bulletins." - }, - "runDurationMillis" : { - "type" : "integer", - "format" : "int64", - "description" : "The run duration for the processor in milliseconds." - }, - "concurrentlySchedulableTaskCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of tasks that should be concurrently schedule for the processor. If the processor doesn't allow parallol processing then any positive input will be ignored." - }, - "autoTerminatedRelationships" : { - "type" : "array", - "description" : "The names of all relationships that cause a flow file to be terminated if the relationship is not connected elsewhere. This property differs from the 'isAutoTerminate' property of the RelationshipDTO in that the RelationshipDTO is meant to depict the current configuration, whereas this property can be set in a DTO when updating a Processor in order to change which Relationships should be auto-terminated.", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - }, - "scheduledState" : { - "type" : "string", - "description" : "The scheduled state of the component", - "enum" : [ "ENABLED", "DISABLED" ] - }, - "componentType" : { - "type" : "string", - "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE" ] - }, - "groupIdentifier" : { - "type" : "string", - "description" : "The ID of the Process Group that this component belongs to" - } - } - }, - "VersionedPropertyDescriptor" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The name of the property" - }, - "displayName" : { - "type" : "string", - "description" : "The display name of the property" - }, - "identifiesControllerService" : { - "type" : "boolean", - "description" : "Whether or not the property provides the identifier of a Controller Service" - }, - "sensitive" : { - "type" : "boolean", - "description" : "Whether or not the property is considered sensitive" - } - } - }, - "VersionedRemoteGroupPort" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The component's unique identifier" - }, - "name" : { - "type" : "string", - "description" : "The component's name" - }, - "comments" : { - "type" : "string", - "description" : "The user-supplied comments for the component" - }, - "position" : { - "description" : "The component's position on the graph", - "$ref" : "#/definitions/Position" - }, - "remoteGroupId" : { - "type" : "string", - "description" : "The id of the remote process group that the port resides in." - }, - "concurrentlySchedulableTaskCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of task that may transmit flowfiles to the target port concurrently." - }, - "useCompression" : { - "type" : "boolean", - "description" : "Whether the flowfiles are compressed when sent to the target port." - }, - "batchSize" : { - "description" : "The batch settings for data transmission.", - "$ref" : "#/definitions/BatchSize" - }, - "componentType" : { - "type" : "string", - "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE" ] - }, - "targetId" : { - "type" : "string", - "description" : "The ID of the port on the target NiFi instance" - }, - "scheduledState" : { - "type" : "string", - "description" : "The scheduled state of the component", - "enum" : [ "ENABLED", "DISABLED" ] - }, - "groupIdentifier" : { - "type" : "string", - "description" : "The ID of the Process Group that this component belongs to" - } - } - }, - "VersionedRemoteProcessGroup" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The component's unique identifier" - }, - "name" : { - "type" : "string", - "description" : "The component's name" - }, - "comments" : { - "type" : "string", - "description" : "The user-supplied comments for the component" - }, - "position" : { - "description" : "The component's position on the graph", - "$ref" : "#/definitions/Position" - }, - "targetUri" : { - "type" : "string", - "description" : "[DEPRECATED] The target URI of the remote process group. If target uri is not set, but uris are set, then returns the first uri in the uris. If neither target uri nor uris are set, then returns null." - }, - "targetUris" : { - "type" : "string", - "description" : "The target URIs of the remote process group. If target uris is not set but target uri is set, then returns the single target uri. If neither target uris nor target uri is set, then returns null." - }, - "communicationsTimeout" : { - "type" : "string", - "description" : "The time period used for the timeout when communicating with the target." - }, - "yieldDuration" : { - "type" : "string", - "description" : "When yielding, this amount of time must elapse before the remote process group is scheduled again." - }, - "transportProtocol" : { - "type" : "string", - "description" : "The Transport Protocol that is used for Site-to-Site communications", - "enum" : [ "RAW", "HTTP" ] - }, - "localNetworkInterface" : { - "type" : "string", - "description" : "The local network interface to send/receive data. If not specified, any local address is used. If clustered, all nodes must have an interface with this identifier." - }, - "proxyHost" : { - "type" : "string" - }, - "proxyPort" : { - "type" : "integer", - "format" : "int32" - }, - "proxyUser" : { - "type" : "string" - }, - "inputPorts" : { - "type" : "array", - "description" : "A Set of Input Ports that can be connected to, in order to send data to the remote NiFi instance", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedRemoteGroupPort" - } - }, - "outputPorts" : { - "type" : "array", - "description" : "A Set of Output Ports that can be connected to, in order to pull data from the remote NiFi instance", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedRemoteGroupPort" - } - }, - "componentType" : { - "type" : "string", - "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE" ] - }, - "groupIdentifier" : { - "type" : "string", - "description" : "The ID of the Process Group that this component belongs to" - } - } - } - } -} diff --git a/resources/client_gen/api_defs/registry-1.15.0.json b/resources/client_gen/api_defs/registry-1.15.0.json deleted file mode 100644 index 7026a762..00000000 --- a/resources/client_gen/api_defs/registry-1.15.0.json +++ /dev/null @@ -1,6728 +0,0 @@ -{ - "swagger" : "2.0", - "info" : { - "description" : "The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components.", - "version" : "1.15.0", - "title" : "Apache NiFi Registry REST API", - "termsOfService" : "As described in the license", - "contact" : { - "name" : "Apache NiFi Registry", - "url" : "https://nifi.apache.org", - "email" : "dev@nifi.apache.org" - }, - "license" : { - "name" : "Apache 2.0 License", - "url" : "https://www.apache.org/licenses/LICENSE-2.0.html" - } - }, - "basePath" : "/nifi-registry-api", - "tags" : [ { - "name" : "access", - "description" : "Endpoints for obtaining an access token or checking access status." - }, { - "name" : "bucket bundles", - "description" : "Create extension bundles scoped to an existing bucket in the registry. " - }, { - "name" : "bucket flows", - "description" : "Create flows scoped to an existing bucket in the registry." - }, { - "name" : "buckets", - "description" : "Create named buckets in the registry to store NiFi objects such flows and extensions. Search for and retrieve existing buckets." - }, { - "name" : "bundles", - "description" : "Gets metadata about extension bundles and their versions. " - }, { - "name" : "config", - "description" : "Retrieves the configuration for this NiFi Registry." - }, { - "name" : "extension repository", - "description" : "Interact with extension bundles via the hierarchy of bucket/group/artifact/version. " - }, { - "name" : "extensions", - "description" : "Find and retrieve extensions. " - }, { - "name" : "flows", - "description" : "Gets metadata about flows." - }, { - "name" : "items", - "description" : "Retrieve items across all buckets for which the user is authorized." - }, { - "name" : "policies", - "description" : "Endpoint for managing access policies." - }, { - "name" : "tenants", - "description" : "Endpoint for managing users and user groups." - } ], - "schemes" : [ "http", "https" ], - "paths" : { - "/access" : { - "get" : { - "tags" : [ "access" ], - "summary" : "Get access status", - "description" : "Returns the current client's authenticated identity and permissions to top-level resources", - "operationId" : "getAccessStatus", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/CurrentUser" - } - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid. The NiFi Registry might be running unsecured." - } - }, - "security" : [ { - "Authorization" : [ ] - } ] - } - }, - "/access/logout" : { - "delete" : { - "tags" : [ "access" ], - "summary" : "Performs a logout for other providers that have been issued a JWT.", - "description" : "\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "logOut", - "consumes" : [ "*/*" ], - "produces" : [ "*/*" ], - "responses" : { - "200" : { - "description" : "User was logged out successfully." - }, - "401" : { - "description" : "Authentication token provided was empty or not in the correct JWT format." - }, - "500" : { - "description" : "Client failed to log out." - } - } - } - }, - "/access/oidc/callback" : { - "get" : { - "tags" : [ "access" ], - "summary" : "Redirect/callback URI for processing the result of the OpenId Connect login sequence.", - "description" : "\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "oidcCallback", - "consumes" : [ "*/*" ], - "produces" : [ "*/*" ], - "responses" : { - "default" : { - "description" : "successful operation" - } - } - } - }, - "/access/oidc/exchange" : { - "post" : { - "tags" : [ "access" ], - "summary" : "Retrieves a JWT following a successful login sequence using the configured OpenId Connect provider.", - "description" : "\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "oidcExchange", - "consumes" : [ "*/*" ], - "produces" : [ "text/plain" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - } - } - } - }, - "/access/oidc/logout" : { - "delete" : { - "tags" : [ "access" ], - "summary" : "Performs a logout in the OpenId Provider.", - "description" : "\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "oidcLogout", - "consumes" : [ "*/*" ], - "produces" : [ "*/*" ], - "responses" : { - "default" : { - "description" : "successful operation" - } - } - } - }, - "/access/oidc/request" : { - "get" : { - "tags" : [ "access" ], - "summary" : "Initiates a request to authenticate through the configured OpenId Connect provider.", - "description" : "\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "oidcRequest", - "consumes" : [ "*/*" ], - "produces" : [ "*/*" ], - "responses" : { - "default" : { - "description" : "successful operation" - } - } - } - }, - "/access/token" : { - "post" : { - "tags" : [ "access" ], - "summary" : "Create token trying all providers", - "description" : "Creates a token for accessing the REST API via auto-detected method of verifying client identity claim credentials. The token returned is formatted as a JSON Web Token (JWT). The token is base64 encoded and comprised of three parts. The header, the body, and the signature. The expiration of the token is a contained within the body. The token can be used in the Authorization header in the format 'Authorization: Bearer '.", - "operationId" : "createAccessTokenByTryingAllProviders", - "consumes" : [ "*/*" ], - "produces" : [ "text/plain" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid. The NiFi Registry may not be configured to support login with username/password." - }, - "500" : { - "description" : "NiFi Registry was unable to complete the request because an unexpected error occurred." - } - } - } - }, - "/access/token/identity-provider" : { - "post" : { - "tags" : [ "access" ], - "summary" : "Create token using identity provider", - "description" : "Creates a token for accessing the REST API via a custom identity provider. The user credentials must be passed in a format understood by the custom identity provider, e.g., a third-party auth token in an HTTP header. The exact format of the user credentials expected by the custom identity provider can be discovered by 'GET /access/token/identity-provider/usage'. The token returned is formatted as a JSON Web Token (JWT). The token is base64 encoded and comprised of three parts. The header, the body, and the signature. The expiration of the token is a contained within the body. The token can be used in the Authorization header in the format 'Authorization: Bearer '.", - "operationId" : "createAccessTokenUsingIdentityProviderCredentials", - "consumes" : [ "*/*" ], - "produces" : [ "text/plain" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid. The NiFi Registry may not be configured to support login with customized credentials." - }, - "500" : { - "description" : "NiFi Registry was unable to complete the request because an unexpected error occurred." - } - } - } - }, - "/access/token/identity-provider/test" : { - "post" : { - "tags" : [ "access" ], - "summary" : "Test identity provider", - "description" : "Tests the format of the credentials against this identity provider without preforming authentication on the credentials to validate them. The user credentials should be passed in a format understood by the custom identity provider as defined by 'GET /access/token/identity-provider/usage'.", - "operationId" : "testIdentityProviderRecognizesCredentialsFormat", - "consumes" : [ "*/*" ], - "produces" : [ "text/plain" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "The format of the credentials were not recognized by the currently configured identity provider." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid. The NiFi Registry may not be configured to support login with customized credentials." - }, - "500" : { - "description" : "NiFi Registry was unable to complete the request because an unexpected error occurred." - } - } - } - }, - "/access/token/identity-provider/usage" : { - "get" : { - "tags" : [ "access" ], - "summary" : "Get identity provider usage", - "description" : "Provides a description of how the currently configured identity provider expects credentials to be passed to POST /access/token/identity-provider", - "operationId" : "getIdentityProviderUsageInstructions", - "consumes" : [ "*/*" ], - "produces" : [ "text/plain" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid. The NiFi Registry may not be configured to support login with customized credentials." - }, - "500" : { - "description" : "NiFi Registry was unable to complete the request because an unexpected error occurred." - } - } - } - }, - "/access/token/kerberos" : { - "post" : { - "tags" : [ "access" ], - "summary" : "Create token using kerberos", - "description" : "Creates a token for accessing the REST API via Kerberos Service Tickets or SPNEGO Tokens (which includes Kerberos Service Tickets). The token returned is formatted as a JSON Web Token (JWT). The token is base64 encoded and comprised of three parts. The header, the body, and the signature. The expiration of the token is a contained within the body. The token can be used in the Authorization header in the format 'Authorization: Bearer '.", - "operationId" : "createAccessTokenUsingKerberosTicket", - "consumes" : [ "*/*" ], - "produces" : [ "text/plain" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid. The NiFi Registry may not be configured to support login Kerberos credentials." - }, - "500" : { - "description" : "NiFi Registry was unable to complete the request because an unexpected error occurred." - } - } - } - }, - "/access/token/login" : { - "post" : { - "tags" : [ "access" ], - "summary" : "Create token using basic auth", - "description" : "Creates a token for accessing the REST API via username/password. The user credentials must be passed in standard HTTP Basic Auth format. That is: 'Authorization: Basic ', where is the base64 encoded value of ':'. The token returned is formatted as a JSON Web Token (JWT). The token is base64 encoded and comprised of three parts. The header, the body, and the signature. The expiration of the token is a contained within the body. The token can be used in the Authorization header in the format 'Authorization: Bearer '.", - "operationId" : "createAccessTokenUsingBasicAuthCredentials", - "consumes" : [ "*/*" ], - "produces" : [ "text/plain" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid. The NiFi Registry may not be configured to support login with username/password." - }, - "500" : { - "description" : "NiFi Registry was unable to complete the request because an unexpected error occurred." - } - }, - "security" : [ { - "BasicAuth" : [ ] - } ] - } - }, - "/buckets" : { - "get" : { - "tags" : [ "buckets" ], - "summary" : "Get all buckets", - "description" : "The returned list will include only buckets for which the user is authorized.If the user is not authorized for any buckets, this returns an empty list.", - "operationId" : "getBuckets", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/Bucket" - } - } - }, - "401" : { - "description" : "Client could not be authenticated." - } - }, - "security" : [ { - "Authorization" : [ ] - } ] - }, - "post" : { - "tags" : [ "buckets" ], - "summary" : "Create bucket", - "description" : "", - "operationId" : "createBucket", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The bucket to create", - "required" : true, - "schema" : { - "$ref" : "#/definitions/Bucket" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/Bucket" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets", - "action" : "write" - } - } - }, - "/buckets/fields" : { - "get" : { - "tags" : [ "buckets" ], - "summary" : "Get bucket fields", - "description" : "Retrieves bucket field names for searching or sorting on buckets.", - "operationId" : "getAvailableBucketFields", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/Fields" - } - } - }, - "security" : [ { - "Authorization" : [ ] - } ] - } - }, - "/buckets/{bucketId}" : { - "get" : { - "tags" : [ "buckets" ], - "summary" : "Get bucket", - "description" : "Gets the bucket with the given id.", - "operationId" : "getBucket", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketId", - "in" : "path", - "description" : "The bucket identifier", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/Bucket" - } - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - }, - "put" : { - "tags" : [ "buckets" ], - "summary" : "Update bucket", - "description" : "Updates the bucket with the given id.", - "operationId" : "updateBucket", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketId", - "in" : "path", - "description" : "The bucket identifier", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The updated bucket", - "required" : true, - "schema" : { - "$ref" : "#/definitions/Bucket" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/Bucket" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "write" - } - }, - "delete" : { - "tags" : [ "buckets" ], - "summary" : "Delete bucket", - "description" : "Deletes the bucket with the given id, along with all objects stored in the bucket", - "operationId" : "deleteBucket", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The version is used to verify the client is working with the latest version of the entity.", - "required" : true, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "bucketId", - "in" : "path", - "description" : "The bucket identifier", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/Bucket" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "delete" - } - } - }, - "/buckets/{bucketId}/bundles" : { - "get" : { - "tags" : [ "bucket bundles" ], - "summary" : "Get extension bundles by bucket", - "description" : "\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getExtensionBundles", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketId", - "in" : "path", - "description" : "The bucket identifier", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/ExtensionBundle" - } - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/buckets/{bucketId}/bundles/{bundleType}" : { - "post" : { - "tags" : [ "bucket bundles" ], - "summary" : "Create extension bundle version", - "description" : "Creates a version of an extension bundle by uploading a binary artifact. If an extension bundle already exists in the given bucket with the same group id and artifact id as that of the bundle being uploaded, then it will be added as a new version to the existing bundle. If an extension bundle does not already exist in the given bucket with the same group id and artifact id, then a new extension bundle will be created and this version will be added to the new bundle. Client's may optionally supply a SHA-256 in hex format through the multi-part form field 'sha256'. If supplied, then this value will be compared against the SHA-256 computed by the server, and the bundle will be rejected if the values do not match. If not supplied, the bundle will be accepted, but will be marked to indicate that the client did not supply a SHA-256 during creation. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "createExtensionBundleVersion", - "consumes" : [ "multipart/form-data" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketId", - "in" : "path", - "description" : "The bucket identifier", - "required" : true, - "type" : "string" - }, { - "name" : "bundleType", - "in" : "path", - "description" : "The type of the bundle", - "required" : true, - "type" : "string", - "enum" : [ "nifi-nar", "minifi-cpp" ] - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/BundleVersion" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "write" - } - } - }, - "/buckets/{bucketId}/flows" : { - "get" : { - "tags" : [ "bucket flows" ], - "summary" : "Get bucket flows", - "description" : "Retrieves all flows in the given bucket.", - "operationId" : "getFlows", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketId", - "in" : "path", - "description" : "The bucket identifier", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/VersionedFlow" - } - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - }, - "post" : { - "tags" : [ "bucket flows" ], - "summary" : "Create flow", - "description" : "Creates a flow in the given bucket. The flow id is created by the server and populated in the returned entity.", - "operationId" : "createFlow", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketId", - "in" : "path", - "description" : "The bucket identifier", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The details of the flow to create.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/VersionedFlow" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlow" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "write" - } - } - }, - "/buckets/{bucketId}/flows/{flowId}" : { - "get" : { - "tags" : [ "bucket flows" ], - "summary" : "Get bucket flow", - "description" : "Retrieves the flow with the given id in the given bucket.", - "operationId" : "getFlow", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketId", - "in" : "path", - "description" : "The bucket identifier", - "required" : true, - "type" : "string" - }, { - "name" : "flowId", - "in" : "path", - "description" : "The flow identifier", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlow" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - }, - "put" : { - "tags" : [ "bucket flows" ], - "summary" : "Update bucket flow", - "description" : "Updates the flow with the given id in the given bucket.", - "operationId" : "updateFlow", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketId", - "in" : "path", - "description" : "The bucket identifier", - "required" : true, - "type" : "string" - }, { - "name" : "flowId", - "in" : "path", - "description" : "The flow identifier", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The updated flow", - "required" : true, - "schema" : { - "$ref" : "#/definitions/VersionedFlow" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlow" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "write" - } - }, - "delete" : { - "tags" : [ "bucket flows" ], - "summary" : "Delete bucket flow", - "description" : "Deletes a flow, including all saved versions of that flow.", - "operationId" : "deleteFlow", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The version is used to verify the client is working with the latest version of the entity.", - "required" : true, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "bucketId", - "in" : "path", - "description" : "The bucket identifier", - "required" : true, - "type" : "string" - }, { - "name" : "flowId", - "in" : "path", - "description" : "The flow identifier", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlow" - } - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "delete" - } - } - }, - "/buckets/{bucketId}/flows/{flowId}/diff/{versionA}/{versionB}" : { - "get" : { - "tags" : [ "bucket flows" ], - "summary" : "Get bucket flow diff", - "description" : "Computes the differences between two given versions of a flow.", - "operationId" : "getFlowDiff", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketId", - "in" : "path", - "description" : "The bucket identifier", - "required" : true, - "type" : "string" - }, { - "name" : "flowId", - "in" : "path", - "description" : "The flow identifier", - "required" : true, - "type" : "string" - }, { - "name" : "versionA", - "in" : "path", - "description" : "The first version number", - "required" : true, - "type" : "integer", - "pattern" : "\\d+", - "format" : "int32" - }, { - "name" : "versionB", - "in" : "path", - "description" : "The second version number", - "required" : true, - "type" : "integer", - "pattern" : "\\d+", - "format" : "int32" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlowDifference" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/buckets/{bucketId}/flows/{flowId}/versions" : { - "get" : { - "tags" : [ "bucket flows" ], - "summary" : "Get bucket flow versions", - "description" : "Gets summary information for all versions of a flow. Versions are ordered newest->oldest.", - "operationId" : "getFlowVersions", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketId", - "in" : "path", - "description" : "The bucket identifier", - "required" : true, - "type" : "string" - }, { - "name" : "flowId", - "in" : "path", - "description" : "The flow identifier", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/VersionedFlowSnapshotMetadata" - } - } - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - }, - "post" : { - "tags" : [ "bucket flows" ], - "summary" : "Create flow version", - "description" : "Creates the next version of a flow. The version number of the object being created must be the next available version integer. Flow versions are immutable after they are created.", - "operationId" : "createFlowVersion", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketId", - "in" : "path", - "description" : "The bucket identifier", - "required" : true, - "type" : "string" - }, { - "name" : "flowId", - "in" : "path", - "description" : "The flow identifier", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The new versioned flow snapshot.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/VersionedFlowSnapshot" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlowSnapshot" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "write" - } - } - }, - "/buckets/{bucketId}/flows/{flowId}/versions/import" : { - "post" : { - "tags" : [ "bucket flows" ], - "summary" : "Import flow version", - "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", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketId", - "in" : "path", - "description" : "The bucket identifier", - "required" : true, - "type" : "string" - }, { - "name" : "flowId", - "in" : "path", - "description" : "The flow identifier", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "file", - "required" : false, - "schema" : { - "$ref" : "#/definitions/VersionedFlowSnapshot" - } - }, { - "name" : "Comments", - "in" : "header", - "required" : false, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlowSnapshot" - } - }, - "201" : { - "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." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "write" - } - } - }, - "/buckets/{bucketId}/flows/{flowId}/versions/latest" : { - "get" : { - "tags" : [ "bucket flows" ], - "summary" : "Get latest bucket flow version content", - "description" : "Gets the latest version of a flow, including the metadata and content of the flow.", - "operationId" : "getLatestFlowVersion", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketId", - "in" : "path", - "description" : "The bucket identifier", - "required" : true, - "type" : "string" - }, { - "name" : "flowId", - "in" : "path", - "description" : "The flow identifier", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlowSnapshot" - } - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/buckets/{bucketId}/flows/{flowId}/versions/latest/metadata" : { - "get" : { - "tags" : [ "bucket flows" ], - "summary" : "Get latest bucket flow version metadata", - "description" : "Gets the metadata for the latest version of a flow.", - "operationId" : "getLatestFlowVersionMetadata", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketId", - "in" : "path", - "description" : "The bucket identifier", - "required" : true, - "type" : "string" - }, { - "name" : "flowId", - "in" : "path", - "description" : "The flow identifier", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlowSnapshotMetadata" - } - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/buckets/{bucketId}/flows/{flowId}/versions/{versionNumber}" : { - "get" : { - "tags" : [ "bucket flows" ], - "summary" : "Get bucket flow version", - "description" : "Gets the given version of a flow, including the metadata and content for the version.", - "operationId" : "getFlowVersion", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketId", - "in" : "path", - "description" : "The bucket identifier", - "required" : true, - "type" : "string" - }, { - "name" : "flowId", - "in" : "path", - "description" : "The flow identifier", - "required" : true, - "type" : "string" - }, { - "name" : "versionNumber", - "in" : "path", - "description" : "The version number", - "required" : true, - "type" : "integer", - "pattern" : "\\d+", - "format" : "int32" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlowSnapshot" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/buckets/{bucketId}/flows/{flowId}/versions/{versionNumber}/export" : { - "get" : { - "tags" : [ "bucket flows" ], - "summary" : "Exports specified bucket flow version content", - "description" : "Exports the specified version of a flow, including the metadata and content of the flow.", - "operationId" : "exportVersionedFlow", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketId", - "in" : "path", - "description" : "The bucket identifier", - "required" : true, - "type" : "string" - }, { - "name" : "flowId", - "in" : "path", - "description" : "The flow identifier", - "required" : true, - "type" : "string" - }, { - "name" : "versionNumber", - "in" : "path", - "description" : "The version number", - "required" : true, - "type" : "integer", - "pattern" : "\\d+", - "format" : "int32" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlowSnapshot" - } - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/bundles" : { - "get" : { - "tags" : [ "bundles" ], - "summary" : "Get all bundles", - "description" : "Gets the metadata for all bundles across all authorized buckets with optional filters applied. The returned results will include only items from buckets for which the user is authorized. If the user is not authorized to any buckets, an empty list will be returned. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getBundles", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketName", - "in" : "query", - "description" : "Optional bucket name to filter results. The value may be an exact match, or a wildcard, such as 'My Bucket%' to select all bundles where the bucket name starts with 'My Bucket'.", - "required" : false, - "type" : "string" - }, { - "name" : "groupId", - "in" : "query", - "description" : "Optional groupId to filter results. The value may be an exact match, or a wildcard, such as 'com.%' to select all bundles where the groupId starts with 'com.'.", - "required" : false, - "type" : "string" - }, { - "name" : "artifactId", - "in" : "query", - "description" : "Optional artifactId to filter results. The value may be an exact match, or a wildcard, such as 'nifi-%' to select all bundles where the artifactId starts with 'nifi-'.", - "required" : false, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/ExtensionBundle" - } - } - }, - "401" : { - "description" : "Client could not be authenticated." - } - }, - "security" : [ { - "Authorization" : [ ] - } ] - } - }, - "/bundles/versions" : { - "get" : { - "tags" : [ "bundles" ], - "summary" : "Get all bundle versions", - "description" : "Gets the metadata about extension bundle versions across all authorized buckets with optional filters applied. If the user is not authorized to any buckets, an empty list will be returned. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getBundleVersions", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "groupId", - "in" : "query", - "description" : "Optional groupId to filter results. The value may be an exact match, or a wildcard, such as 'com.%' to select all bundle versions where the groupId starts with 'com.'.", - "required" : false, - "type" : "string" - }, { - "name" : "artifactId", - "in" : "query", - "description" : "Optional artifactId to filter results. The value may be an exact match, or a wildcard, such as 'nifi-%' to select all bundle versions where the artifactId starts with 'nifi-'.", - "required" : false, - "type" : "string" - }, { - "name" : "version", - "in" : "query", - "description" : "Optional version to filter results. The value maye be an exact match, or a wildcard, such as '1.0.%' to select all bundle versions where the version starts with '1.0.'.", - "required" : false, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/BundleVersionMetadata" - } - } - }, - "401" : { - "description" : "Client could not be authenticated." - } - }, - "security" : [ { - "Authorization" : [ ] - } ] - } - }, - "/bundles/{bundleId}" : { - "get" : { - "tags" : [ "bundles" ], - "summary" : "Get bundle", - "description" : "Gets the metadata about an extension bundle. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "globalGetExtensionBundle", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bundleId", - "in" : "path", - "description" : "The extension bundle identifier", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ExtensionBundle" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - }, - "delete" : { - "tags" : [ "bundles" ], - "summary" : "Delete bundle", - "description" : "Deletes the given extension bundle and all of it's versions. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "globalDeleteExtensionBundle", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bundleId", - "in" : "path", - "description" : "The extension bundle identifier", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ExtensionBundle" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "write" - } - } - }, - "/bundles/{bundleId}/versions" : { - "get" : { - "tags" : [ "bundles" ], - "summary" : "Get bundle versions", - "description" : "Gets the metadata for the versions of the given extension bundle. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "globalGetBundleVersions", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bundleId", - "in" : "path", - "description" : "The extension bundle identifier", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/BundleVersionMetadata" - } - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/bundles/{bundleId}/versions/{version}" : { - "get" : { - "tags" : [ "bundles" ], - "summary" : "Get bundle version", - "description" : "Gets the descriptor for the given version of the given extension bundle. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "globalGetBundleVersion", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bundleId", - "in" : "path", - "description" : "The extension bundle identifier", - "required" : true, - "type" : "string" - }, { - "name" : "version", - "in" : "path", - "description" : "The version of the bundle", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/BundleVersion" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - }, - "delete" : { - "tags" : [ "bundles" ], - "summary" : "Delete bundle version", - "description" : "Deletes the given extension bundle version and it's associated binary content. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "globalDeleteBundleVersion", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bundleId", - "in" : "path", - "description" : "The extension bundle identifier", - "required" : true, - "type" : "string" - }, { - "name" : "version", - "in" : "path", - "description" : "The version of the bundle", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/BundleVersion" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "write" - } - } - }, - "/bundles/{bundleId}/versions/{version}/content" : { - "get" : { - "tags" : [ "bundles" ], - "summary" : "Get bundle version content", - "description" : "Gets the binary content for the given version of the given extension bundle. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "globalGetBundleVersionContent", - "consumes" : [ "*/*" ], - "produces" : [ "application/octet-stream" ], - "parameters" : [ { - "name" : "bundleId", - "in" : "path", - "description" : "The extension bundle identifier", - "required" : true, - "type" : "string" - }, { - "name" : "version", - "in" : "path", - "description" : "The version of the bundle", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "type" : "string", - "format" : "byte" - } - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/bundles/{bundleId}/versions/{version}/extensions" : { - "get" : { - "tags" : [ "bundles" ], - "summary" : "Get bundle version extensions", - "description" : "Gets the metadata about the extensions in the given extension bundle version. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "globalGetBundleVersionExtensions", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bundleId", - "in" : "path", - "description" : "The extension bundle identifier", - "required" : true, - "type" : "string" - }, { - "name" : "version", - "in" : "path", - "description" : "The version of the bundle", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/ExtensionMetadata" - } - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/bundles/{bundleId}/versions/{version}/extensions/{name}" : { - "get" : { - "tags" : [ "bundles" ], - "summary" : "Get bundle version extension", - "description" : "Gets the metadata about the extension with the given name in the given extension bundle version. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "globalGetBundleVersionExtension", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bundleId", - "in" : "path", - "description" : "The extension bundle identifier", - "required" : true, - "type" : "string" - }, { - "name" : "version", - "in" : "path", - "description" : "The version of the bundle", - "required" : true, - "type" : "string" - }, { - "name" : "name", - "in" : "path", - "description" : "The fully qualified name of the extension", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/Extension" - } - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/bundles/{bundleId}/versions/{version}/extensions/{name}/docs" : { - "get" : { - "tags" : [ "bundles" ], - "summary" : "Get bundle version extension docs", - "description" : "Gets the documentation for the given extension in the given extension bundle version. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getBundleVersionExtensionDocs", - "consumes" : [ "*/*" ], - "produces" : [ "text/html" ], - "parameters" : [ { - "name" : "bundleId", - "in" : "path", - "description" : "The extension bundle identifier", - "required" : true, - "type" : "string" - }, { - "name" : "version", - "in" : "path", - "description" : "The version of the bundle", - "required" : true, - "type" : "string" - }, { - "name" : "name", - "in" : "path", - "description" : "The fully qualified name of the extension", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/bundles/{bundleId}/versions/{version}/extensions/{name}/docs/additional-details" : { - "get" : { - "tags" : [ "bundles" ], - "summary" : "Get bundle version extension docs details", - "description" : "Gets the additional details documentation for the given extension in the given extension bundle version. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getBundleVersionExtensionAdditionalDetailsDocs", - "consumes" : [ "*/*" ], - "produces" : [ "text/html" ], - "parameters" : [ { - "name" : "bundleId", - "in" : "path", - "description" : "The extension bundle identifier", - "required" : true, - "type" : "string" - }, { - "name" : "version", - "in" : "path", - "description" : "The version of the bundle", - "required" : true, - "type" : "string" - }, { - "name" : "name", - "in" : "path", - "description" : "The fully qualified name of the extension", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/config" : { - "get" : { - "tags" : [ "config" ], - "summary" : "Get configration", - "description" : "Gets the NiFi Registry configurations.", - "operationId" : "getConfiguration", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/RegistryConfiguration" - } - }, - "401" : { - "description" : "Client could not be authenticated." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/policies,/tenants", - "action" : "read" - } - } - }, - "/extension-repository" : { - "get" : { - "tags" : [ "extension repository" ], - "summary" : "Get extension repo buckets", - "description" : "Gets the names of the buckets the current user is authorized for in order to browse the repo by bucket. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getExtensionRepoBuckets", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/ExtensionRepoBucket" - } - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ] - } - }, - "/extension-repository/{bucketName}" : { - "get" : { - "tags" : [ "extension repository" ], - "summary" : "Get extension repo groups", - "description" : "Gets the groups in the extension repository in the given bucket. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getExtensionRepoGroups", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketName", - "in" : "path", - "description" : "The bucket name", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/ExtensionRepoGroup" - } - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/extension-repository/{bucketName}/{groupId}" : { - "get" : { - "tags" : [ "extension repository" ], - "summary" : "Get extension repo artifacts", - "description" : "Gets the artifacts in the extension repository in the given bucket and group. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getExtensionRepoArtifacts", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketName", - "in" : "path", - "description" : "The bucket name", - "required" : true, - "type" : "string" - }, { - "name" : "groupId", - "in" : "path", - "description" : "The group id", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/ExtensionRepoArtifact" - } - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/extension-repository/{bucketName}/{groupId}/{artifactId}" : { - "get" : { - "tags" : [ "extension repository" ], - "summary" : "Get extension repo versions", - "description" : "Gets the versions in the extension repository for the given bucket, group, and artifact. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getExtensionRepoVersions", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketName", - "in" : "path", - "description" : "The bucket name", - "required" : true, - "type" : "string" - }, { - "name" : "groupId", - "in" : "path", - "description" : "The group identifier", - "required" : true, - "type" : "string" - }, { - "name" : "artifactId", - "in" : "path", - "description" : "The artifact identifier", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/ExtensionRepoVersionSummary" - } - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/extension-repository/{bucketName}/{groupId}/{artifactId}/{version}" : { - "get" : { - "tags" : [ "extension repository" ], - "summary" : "Get extension repo version", - "description" : "Gets information about the version in the given bucket, group, and artifact. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getExtensionRepoVersion", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketName", - "in" : "path", - "description" : "The bucket name", - "required" : true, - "type" : "string" - }, { - "name" : "groupId", - "in" : "path", - "description" : "The group identifier", - "required" : true, - "type" : "string" - }, { - "name" : "artifactId", - "in" : "path", - "description" : "The artifact identifier", - "required" : true, - "type" : "string" - }, { - "name" : "version", - "in" : "path", - "description" : "The version", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ExtensionRepoVersion" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/extension-repository/{bucketName}/{groupId}/{artifactId}/{version}/content" : { - "get" : { - "tags" : [ "extension repository" ], - "summary" : "Get extension repo version content", - "description" : "Gets the binary content of the bundle with the given bucket, group, artifact, and version. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getExtensionRepoVersionContent", - "consumes" : [ "*/*" ], - "produces" : [ "application/octet-stream" ], - "parameters" : [ { - "name" : "bucketName", - "in" : "path", - "description" : "The bucket name", - "required" : true, - "type" : "string" - }, { - "name" : "groupId", - "in" : "path", - "description" : "The group identifier", - "required" : true, - "type" : "string" - }, { - "name" : "artifactId", - "in" : "path", - "description" : "The artifact identifier", - "required" : true, - "type" : "string" - }, { - "name" : "version", - "in" : "path", - "description" : "The version", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "type" : "string", - "format" : "byte" - } - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/extension-repository/{bucketName}/{groupId}/{artifactId}/{version}/extensions" : { - "get" : { - "tags" : [ "extension repository" ], - "summary" : "Get extension repo extensions", - "description" : "Gets information about the extensions in the given bucket, group, artifact, and version. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getExtensionRepoVersionExtensions", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketName", - "in" : "path", - "description" : "The bucket name", - "required" : true, - "type" : "string" - }, { - "name" : "groupId", - "in" : "path", - "description" : "The group identifier", - "required" : true, - "type" : "string" - }, { - "name" : "artifactId", - "in" : "path", - "description" : "The artifact identifier", - "required" : true, - "type" : "string" - }, { - "name" : "version", - "in" : "path", - "description" : "The version", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/ExtensionMetadata" - } - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/extension-repository/{bucketName}/{groupId}/{artifactId}/{version}/extensions/{name}" : { - "get" : { - "tags" : [ "extension repository" ], - "summary" : "Get extension repo extension", - "description" : "Gets information about the extension with the given name in the given bucket, group, artifact, and version. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getExtensionRepoVersionExtension", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketName", - "in" : "path", - "description" : "The bucket name", - "required" : true, - "type" : "string" - }, { - "name" : "groupId", - "in" : "path", - "description" : "The group identifier", - "required" : true, - "type" : "string" - }, { - "name" : "artifactId", - "in" : "path", - "description" : "The artifact identifier", - "required" : true, - "type" : "string" - }, { - "name" : "version", - "in" : "path", - "description" : "The version", - "required" : true, - "type" : "string" - }, { - "name" : "name", - "in" : "path", - "description" : "The fully qualified name of the extension", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/Extension" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/extension-repository/{bucketName}/{groupId}/{artifactId}/{version}/extensions/{name}/docs" : { - "get" : { - "tags" : [ "extension repository" ], - "summary" : "Get extension repo extension docs", - "description" : "Gets the documentation for the extension with the given name in the given bucket, group, artifact, and version. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getExtensionRepoVersionExtensionDocs", - "consumes" : [ "*/*" ], - "produces" : [ "text/html" ], - "parameters" : [ { - "name" : "bucketName", - "in" : "path", - "description" : "The bucket name", - "required" : true, - "type" : "string" - }, { - "name" : "groupId", - "in" : "path", - "description" : "The group identifier", - "required" : true, - "type" : "string" - }, { - "name" : "artifactId", - "in" : "path", - "description" : "The artifact identifier", - "required" : true, - "type" : "string" - }, { - "name" : "version", - "in" : "path", - "description" : "The version", - "required" : true, - "type" : "string" - }, { - "name" : "name", - "in" : "path", - "description" : "The fully qualified name of the extension", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/extension-repository/{bucketName}/{groupId}/{artifactId}/{version}/extensions/{name}/docs/additional-details" : { - "get" : { - "tags" : [ "extension repository" ], - "summary" : "Get extension repo extension details", - "description" : "Gets the additional details documentation for the extension with the given name in the given bucket, group, artifact, and version. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getExtensionRepoVersionExtensionAdditionalDetailsDocs", - "consumes" : [ "*/*" ], - "produces" : [ "text/html" ], - "parameters" : [ { - "name" : "bucketName", - "in" : "path", - "description" : "The bucket name", - "required" : true, - "type" : "string" - }, { - "name" : "groupId", - "in" : "path", - "description" : "The group identifier", - "required" : true, - "type" : "string" - }, { - "name" : "artifactId", - "in" : "path", - "description" : "The artifact identifier", - "required" : true, - "type" : "string" - }, { - "name" : "version", - "in" : "path", - "description" : "The version", - "required" : true, - "type" : "string" - }, { - "name" : "name", - "in" : "path", - "description" : "The fully qualified name of the extension", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/extension-repository/{bucketName}/{groupId}/{artifactId}/{version}/sha256" : { - "get" : { - "tags" : [ "extension repository" ], - "summary" : "Get extension repo version checksum", - "description" : "Gets the hex representation of the SHA-256 digest for the binary content of the bundle with the given bucket, group, artifact, and version.\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getExtensionRepoVersionSha256", - "consumes" : [ "*/*" ], - "produces" : [ "text/plain" ], - "parameters" : [ { - "name" : "bucketName", - "in" : "path", - "description" : "The bucket name", - "required" : true, - "type" : "string" - }, { - "name" : "groupId", - "in" : "path", - "description" : "The group identifier", - "required" : true, - "type" : "string" - }, { - "name" : "artifactId", - "in" : "path", - "description" : "The artifact identifier", - "required" : true, - "type" : "string" - }, { - "name" : "version", - "in" : "path", - "description" : "The version", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/extension-repository/{groupId}/{artifactId}/{version}/sha256" : { - "get" : { - "tags" : [ "extension repository" ], - "summary" : "Get global extension repo version checksum", - "description" : "Gets the hex representation of the SHA-256 digest for the binary content with the given bucket, group, artifact, and version. Since the same group-artifact-version can exist in multiple buckets, this will return the checksum of the first one returned. This will be consistent since the checksum must be the same when existing in multiple buckets. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getGlobalExtensionRepoVersionSha256", - "consumes" : [ "*/*" ], - "produces" : [ "text/plain" ], - "parameters" : [ { - "name" : "groupId", - "in" : "path", - "description" : "The group identifier", - "required" : true, - "type" : "string" - }, { - "name" : "artifactId", - "in" : "path", - "description" : "The artifact identifier", - "required" : true, - "type" : "string" - }, { - "name" : "version", - "in" : "path", - "description" : "The version", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ] - } - }, - "/extensions" : { - "get" : { - "tags" : [ "extensions" ], - "summary" : "Get all extensions", - "description" : "Gets the metadata for all extensions that match the filter params and are part of bundles located in buckets the current user is authorized for. If the user is not authorized to any buckets, an empty result set will be returned.\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getExtensions", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bundleType", - "in" : "query", - "description" : "The type of bundles to return", - "required" : false, - "type" : "string", - "enum" : [ "nifi-nar", "minifi-cpp" ] - }, { - "name" : "extensionType", - "in" : "query", - "description" : "The type of extensions to return", - "required" : false, - "type" : "string", - "enum" : [ "PROCESSOR", "CONTROLLER_SERVICE", "REPORTING_TASK" ] - }, { - "name" : "tag", - "in" : "query", - "description" : "The tags to filter on, will be used in an OR statement", - "required" : false, - "type" : "array", - "items" : { - "type" : "string" - }, - "collectionFormat" : "multi" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ExtensionMetadataContainer" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ] - } - }, - "/extensions/provided-service-api" : { - "get" : { - "tags" : [ "extensions" ], - "summary" : "Get extensions providing service API", - "description" : "Gets the metadata for extensions that provide the specified API and are part of bundles located in buckets the current user is authorized for. If the user is not authorized to any buckets, an empty result set will be returned.\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getExtensionsProvidingServiceAPI", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "className", - "in" : "query", - "description" : "The name of the service API class", - "required" : true, - "type" : "string" - }, { - "name" : "groupId", - "in" : "query", - "description" : "The groupId of the bundle containing the service API class", - "required" : true, - "type" : "string" - }, { - "name" : "artifactId", - "in" : "query", - "description" : "The artifactId of the bundle containing the service API class", - "required" : true, - "type" : "string" - }, { - "name" : "version", - "in" : "query", - "description" : "The version of the bundle containing the service API class", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ExtensionMetadataContainer" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ] - } - }, - "/extensions/tags" : { - "get" : { - "tags" : [ "extensions" ], - "summary" : "Get extension tags", - "description" : "Gets all the extension tags known to this NiFi Registry instance, along with the number of extensions that have the given tag.\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getTags", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/TagCount" - } - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ] - } - }, - "/flows/fields" : { - "get" : { - "tags" : [ "flows" ], - "summary" : "Get flow fields", - "description" : "Retrieves the flow field names that can be used for searching or sorting on flows.", - "operationId" : "getAvailableFlowFields", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/Fields" - } - } - }, - "security" : [ { - "Authorization" : [ ] - } ] - } - }, - "/flows/{flowId}" : { - "get" : { - "tags" : [ "flows" ], - "summary" : "Get flow", - "description" : "Gets a flow by id.", - "operationId" : "globalGetFlow", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "flowId", - "in" : "path", - "description" : "The flow identifier", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlow" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/flows/{flowId}/versions" : { - "get" : { - "tags" : [ "flows" ], - "summary" : "Get flow versions", - "description" : "Gets summary information for all versions of a given flow. Versions are ordered newest->oldest.", - "operationId" : "globalGetFlowVersions", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "flowId", - "in" : "path", - "description" : "The flow identifier", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/VersionedFlowSnapshotMetadata" - } - } - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/flows/{flowId}/versions/latest" : { - "get" : { - "tags" : [ "flows" ], - "summary" : "Get latest flow version", - "description" : "Gets the latest version of a flow, including metadata and flow content.", - "operationId" : "globalGetLatestFlowVersion", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "flowId", - "in" : "path", - "description" : "The flow identifier", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlowSnapshot" - } - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/flows/{flowId}/versions/latest/metadata" : { - "get" : { - "tags" : [ "flows" ], - "summary" : "Get latest flow version metadata", - "description" : "Gets the metadata for the latest version of a flow.", - "operationId" : "globalGetLatestFlowVersionMetadata", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "flowId", - "in" : "path", - "description" : "The flow identifier", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlowSnapshotMetadata" - } - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/flows/{flowId}/versions/{versionNumber}" : { - "get" : { - "tags" : [ "flows" ], - "summary" : "Get flow version", - "description" : "Gets the given version of a flow, including metadata and flow content.", - "operationId" : "globalGetFlowVersion", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "flowId", - "in" : "path", - "description" : "The flow identifier", - "required" : true, - "type" : "string" - }, { - "name" : "versionNumber", - "in" : "path", - "description" : "The version number", - "required" : true, - "type" : "integer", - "pattern" : "\\d+", - "format" : "int32" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlowSnapshot" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/items" : { - "get" : { - "tags" : [ "items" ], - "summary" : "Get all items", - "description" : "Get items across all buckets. The returned items will include only items from buckets for which the user is authorized. If the user is not authorized to any buckets, an empty list will be returned.", - "operationId" : "getItems", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/BucketItem" - } - } - }, - "401" : { - "description" : "Client could not be authenticated." - } - }, - "security" : [ { - "Authorization" : [ ] - } ] - } - }, - "/items/fields" : { - "get" : { - "tags" : [ "items" ], - "summary" : "Get item fields", - "description" : "Retrieves the item field names for searching or sorting on bucket items.", - "operationId" : "getAvailableBucketItemFields", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/Fields" - } - } - }, - "security" : [ { - "Authorization" : [ ] - } ] - } - }, - "/items/{bucketId}" : { - "get" : { - "tags" : [ "items" ], - "summary" : "Get bucket items", - "description" : "Gets the items located in the given bucket.", - "operationId" : "getItemsInBucket", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketId", - "in" : "path", - "description" : "The bucket identifier", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/BucketItem" - } - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/policies" : { - "get" : { - "tags" : [ "policies" ], - "summary" : "Get all access policies", - "description" : "", - "operationId" : "getAccessPolicies", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/AccessPolicy" - } - } - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/policies", - "action" : "read" - } - }, - "post" : { - "tags" : [ "policies" ], - "summary" : "Create access policy", - "description" : "", - "operationId" : "createAccessPolicy", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The access policy configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/AccessPolicy" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/AccessPolicy" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid. The NiFi Registry might not be configured to use a ConfigurableAccessPolicyProvider." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/policies", - "action" : "write" - } - } - }, - "/policies/resources" : { - "get" : { - "tags" : [ "policies" ], - "summary" : "Get available resources", - "description" : "Gets the available resources that support access/authorization policies", - "operationId" : "getResources", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/Resource" - } - } - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/policies", - "action" : "read" - } - } - }, - "/policies/{action}/{resource}" : { - "get" : { - "tags" : [ "policies" ], - "summary" : "Get access policy for resource", - "description" : "Gets an access policy for the specified action and resource", - "operationId" : "getAccessPolicyForResource", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "action", - "in" : "path", - "description" : "The request action.", - "required" : true, - "type" : "string", - "enum" : [ "read", "write", "delete" ] - }, { - "name" : "resource", - "in" : "path", - "description" : "The resource of the policy.", - "required" : true, - "type" : "string", - "pattern" : ".+" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/AccessPolicy" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/policies", - "action" : "read" - } - } - }, - "/policies/{id}" : { - "get" : { - "tags" : [ "policies" ], - "summary" : "Get access policy", - "description" : "", - "operationId" : "getAccessPolicy", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The access policy id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/AccessPolicy" - } - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/policies", - "action" : "read" - } - }, - "put" : { - "tags" : [ "policies" ], - "summary" : "Update access policy", - "description" : "", - "operationId" : "updateAccessPolicy", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The access policy id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The access policy configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/AccessPolicy" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/AccessPolicy" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid. The NiFi Registry might not be configured to use a ConfigurableAccessPolicyProvider." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/policies", - "action" : "write" - } - }, - "delete" : { - "tags" : [ "policies" ], - "summary" : "Delete access policy", - "description" : "", - "operationId" : "removeAccessPolicy", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The version is used to verify the client is working with the latest version of the entity.", - "required" : true, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The access policy id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/AccessPolicy" - } - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid. The NiFi Registry might not be configured to use a ConfigurableAccessPolicyProvider." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/policies", - "action" : "delete" - } - } - }, - "/tenants/user-groups" : { - "get" : { - "tags" : [ "tenants" ], - "summary" : "Get user groups", - "description" : "\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getUserGroups", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/UserGroup" - } - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/tenants", - "action" : "read" - } - }, - "post" : { - "tags" : [ "tenants" ], - "summary" : "Create user group", - "description" : "\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "createUserGroup", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The user group configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/UserGroup" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/UserGroup" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/tenants", - "action" : "write" - } - } - }, - "/tenants/user-groups/{id}" : { - "get" : { - "tags" : [ "tenants" ], - "summary" : "Get user group", - "description" : "\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getUserGroup", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The user group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/UserGroup" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/tenants", - "action" : "read" - } - }, - "put" : { - "tags" : [ "tenants" ], - "summary" : "Update user group", - "description" : "\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "updateUserGroup", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The user group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The user group configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/UserGroup" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/UserGroup" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/tenants", - "action" : "write" - } - }, - "delete" : { - "tags" : [ "tenants" ], - "summary" : "Delete user group", - "description" : "\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "removeUserGroup", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The version is used to verify the client is working with the latest version of the entity.", - "required" : true, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The user group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/UserGroup" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/tenants", - "action" : "delete" - } - } - }, - "/tenants/users" : { - "get" : { - "tags" : [ "tenants" ], - "summary" : "Get all users", - "description" : "\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getUsers", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/User" - } - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/tenants", - "action" : "read" - } - }, - "post" : { - "tags" : [ "tenants" ], - "summary" : "Create user", - "description" : "\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "createUser", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The user configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/User" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/User" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/tenants", - "action" : "write" - } - } - }, - "/tenants/users/{id}" : { - "get" : { - "tags" : [ "tenants" ], - "summary" : "Get user", - "description" : "\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getUser", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The user id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/User" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/tenants", - "action" : "read" - } - }, - "put" : { - "tags" : [ "tenants" ], - "summary" : "Update user", - "description" : "\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "updateUser", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The user id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The user configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/User" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/User" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/tenants", - "action" : "write" - } - }, - "delete" : { - "tags" : [ "tenants" ], - "summary" : "Delete user", - "description" : "\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "removeUser", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The version is used to verify the client is working with the latest version of the entity.", - "required" : true, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The user id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/User" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/tenants", - "action" : "delete" - } - } - } - }, - "securityDefinitions" : { - "Authorization" : { - "description" : "NiFi Registry Auth Token (JWT)", - "type" : "apiKey", - "name" : "Authorization", - "in" : "header" - }, - "BasicAuth" : { - "description" : "HTTP Basic Auth", - "type" : "basic" - } - }, - "definitions" : { - "AccessPolicy" : { - "type" : "object", - "required" : [ "action", "resource" ], - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The id of the policy. Set by server at creation time.", - "readOnly" : true - }, - "resource" : { - "type" : "string", - "description" : "The resource for this access policy." - }, - "action" : { - "type" : "string", - "description" : "The action associated with this access policy.", - "enum" : [ "read", "write", "delete" ] - }, - "configurable" : { - "type" : "boolean", - "description" : "Indicates if this access policy is configurable, based on which Authorizer has been configured to manage it.", - "readOnly" : true - }, - "revision" : { - "description" : "The revision of this entity used for optimistic-locking during updates.", - "readOnly" : true, - "$ref" : "#/definitions/RevisionInfo" - }, - "users" : { - "type" : "array", - "description" : "The set of user IDs associated with this access policy.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/Tenant" - } - }, - "userGroups" : { - "type" : "array", - "description" : "The set of user group IDs associated with this access policy.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/Tenant" - } - } - } - }, - "AccessPolicySummary" : { - "type" : "object", - "required" : [ "action", "resource" ], - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The id of the policy. Set by server at creation time.", - "readOnly" : true - }, - "resource" : { - "type" : "string", - "description" : "The resource for this access policy." - }, - "action" : { - "type" : "string", - "description" : "The action associated with this access policy.", - "enum" : [ "read", "write", "delete" ] - }, - "configurable" : { - "type" : "boolean", - "description" : "Indicates if this access policy is configurable, based on which Authorizer has been configured to manage it.", - "readOnly" : true - }, - "revision" : { - "description" : "The revision of this entity used for optimistic-locking during updates.", - "readOnly" : true, - "$ref" : "#/definitions/RevisionInfo" - } - } - }, - "AllowableValue" : { - "type" : "object", - "properties" : { - "value" : { - "type" : "string", - "description" : "The value of the allowable value" - }, - "displayName" : { - "type" : "string", - "description" : "The display name of the allowable value" - }, - "description" : { - "type" : "string", - "description" : "The description of the allowable value" - } - } - }, - "Attribute" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The name of the attribute" - }, - "description" : { - "type" : "string", - "description" : "The description of the attribute" - } - } - }, - "BatchSize" : { - "type" : "object", - "properties" : { - "count" : { - "type" : "integer", - "format" : "int32", - "description" : "Preferred number of flow files to include in a transaction." - }, - "size" : { - "type" : "string", - "description" : "Preferred number of bytes to include in a transaction." - }, - "duration" : { - "type" : "string", - "description" : "Preferred amount of time that a transaction should span." - } - } - }, - "Bucket" : { - "type" : "object", - "required" : [ "name" ], - "properties" : { - "link" : { - "description" : "An WebLink to this entity.", - "readOnly" : true, - "$ref" : "#/definitions/JaxbLink" - }, - "identifier" : { - "type" : "string", - "description" : "An ID to uniquely identify this object.", - "readOnly" : true - }, - "name" : { - "type" : "string", - "description" : "The name of the bucket." - }, - "createdTimestamp" : { - "type" : "integer", - "format" : "int64", - "description" : "The timestamp of when the bucket was first created. This is set by the server at creation time.", - "readOnly" : true, - "minimum" : 1 - }, - "description" : { - "type" : "string", - "description" : "A description of the bucket." - }, - "allowBundleRedeploy" : { - "type" : "boolean", - "description" : "Indicates if this bucket allows the same version of an extension bundle to be redeployed and thus overwrite the existing artifact. By default this is false." - }, - "allowPublicRead" : { - "type" : "boolean", - "description" : "Indicates if this bucket allows read access to unauthenticated anonymous users" - }, - "permissions" : { - "description" : "The access that the current user has to this bucket.", - "readOnly" : true, - "$ref" : "#/definitions/Permissions" - }, - "revision" : { - "description" : "The revision of this entity used for optimistic-locking during updates.", - "readOnly" : true, - "$ref" : "#/definitions/RevisionInfo" - } - } - }, - "BucketItem" : { - "type" : "object", - "required" : [ "bucketIdentifier", "name", "type" ], - "properties" : { - "link" : { - "description" : "An WebLink to this entity.", - "readOnly" : true, - "$ref" : "#/definitions/JaxbLink" - }, - "identifier" : { - "type" : "string", - "description" : "An ID to uniquely identify this object.", - "readOnly" : true - }, - "name" : { - "type" : "string", - "description" : "The name of the item." - }, - "description" : { - "type" : "string", - "description" : "A description of the item." - }, - "bucketIdentifier" : { - "type" : "string", - "description" : "The identifier of the bucket this items belongs to. This cannot be changed after the item is created." - }, - "bucketName" : { - "type" : "string", - "description" : "The name of the bucket this items belongs to.", - "readOnly" : true - }, - "createdTimestamp" : { - "type" : "integer", - "format" : "int64", - "description" : "The timestamp of when the item was created, as milliseconds since epoch.", - "readOnly" : true, - "minimum" : 1 - }, - "modifiedTimestamp" : { - "type" : "integer", - "format" : "int64", - "description" : "The timestamp of when the item was last modified, as milliseconds since epoch.", - "readOnly" : true, - "minimum" : 1 - }, - "type" : { - "type" : "string", - "description" : "The type of item.", - "enum" : [ "Flow", "Bundle" ] - }, - "permissions" : { - "description" : "The access that the current user has to the bucket containing this item.", - "readOnly" : true, - "$ref" : "#/definitions/Permissions" - } - } - }, - "BuildInfo" : { - "type" : "object", - "properties" : { - "buildTool" : { - "type" : "string", - "description" : "The tool used to build the version of the bundle" - }, - "buildFlags" : { - "type" : "string", - "description" : "The flags used to build the version of the bundle" - }, - "buildBranch" : { - "type" : "string", - "description" : "The branch used to build the version of the bundle" - }, - "buildTag" : { - "type" : "string", - "description" : "The tag used to build the version of the bundle" - }, - "buildRevision" : { - "type" : "string", - "description" : "The revision used to build the version of the bundle" - }, - "built" : { - "type" : "integer", - "format" : "int64", - "description" : "The timestamp the version of the bundle was built" - }, - "builtBy" : { - "type" : "string", - "description" : "The identity of the user that performed the build" - } - } - }, - "Bundle" : { - "type" : "object", - "properties" : { - "group" : { - "type" : "string", - "description" : "The group of the bundle" - }, - "artifact" : { - "type" : "string", - "description" : "The artifact of the bundle" - }, - "version" : { - "type" : "string", - "description" : "The version of the bundle" - } - } - }, - "BundleInfo" : { - "type" : "object", - "properties" : { - "bucketId" : { - "type" : "string", - "description" : "The id of the bucket where the bundle is located" - }, - "bucketName" : { - "type" : "string", - "description" : "The name of the bucket where the bundle is located" - }, - "bundleId" : { - "type" : "string", - "description" : "The id of the bundle" - }, - "bundleType" : { - "type" : "string", - "description" : "The type of bundle (i.e. a NiFi NAR vs MiNiFi CPP)", - "enum" : [ "NIFI_NAR", "MINIFI_CPP" ] - }, - "groupId" : { - "type" : "string", - "description" : "The group id of the bundle" - }, - "artifactId" : { - "type" : "string", - "description" : "The artifact id of the bundle" - }, - "version" : { - "type" : "string", - "description" : "The version of the bundle" - }, - "systemApiVersion" : { - "type" : "string", - "description" : "The version of the system API the bundle was built against" - } - } - }, - "BundleVersion" : { - "type" : "object", - "required" : [ "versionMetadata" ], - "properties" : { - "link" : { - "description" : "An WebLink to this entity.", - "readOnly" : true, - "$ref" : "#/definitions/JaxbLink" - }, - "versionMetadata" : { - "description" : "The metadata about this version of the extension bundle", - "$ref" : "#/definitions/BundleVersionMetadata" - }, - "dependencies" : { - "type" : "array", - "description" : "The set of other bundle versions that this version is dependent on", - "readOnly" : true, - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/BundleVersionDependency" - } - }, - "bundle" : { - "description" : "The bundle this version is for", - "readOnly" : true, - "$ref" : "#/definitions/ExtensionBundle" - }, - "bucket" : { - "description" : "The bucket that the extension bundle belongs to", - "$ref" : "#/definitions/Bucket" - }, - "filename" : { - "type" : "string" - } - } - }, - "BundleVersionDependency" : { - "type" : "object", - "properties" : { - "groupId" : { - "type" : "string", - "description" : "The group id of the bundle dependency" - }, - "artifactId" : { - "type" : "string", - "description" : "The artifact id of the bundle dependency" - }, - "version" : { - "type" : "string", - "description" : "The version of the bundle dependency" - } - } - }, - "BundleVersionMetadata" : { - "type" : "object", - "required" : [ "bucketId", "buildInfo", "contentSize", "sha256Supplied" ], - "properties" : { - "link" : { - "description" : "An WebLink to this entity.", - "readOnly" : true, - "$ref" : "#/definitions/JaxbLink" - }, - "id" : { - "type" : "string", - "description" : "The id of this version of the extension bundle" - }, - "bundleId" : { - "type" : "string", - "description" : "The id of the extension bundle this version is for" - }, - "bucketId" : { - "type" : "string", - "description" : "The id of the bucket the extension bundle belongs to" - }, - "groupId" : { - "type" : "string" - }, - "artifactId" : { - "type" : "string" - }, - "version" : { - "type" : "string", - "description" : "The version of the extension bundle" - }, - "timestamp" : { - "type" : "integer", - "format" : "int64", - "description" : "The timestamp of the create date of this version", - "minimum" : 1 - }, - "author" : { - "type" : "string", - "description" : "The identity that created this version" - }, - "description" : { - "type" : "string", - "description" : "The description for this version" - }, - "sha256" : { - "type" : "string", - "description" : "The hex representation of the SHA-256 digest of the binary content for this version" - }, - "sha256Supplied" : { - "type" : "boolean", - "description" : "Whether or not the client supplied a SHA-256 when uploading the bundle" - }, - "contentSize" : { - "type" : "integer", - "format" : "int64", - "description" : "The size of the binary content for this version in bytes", - "minimum" : 0 - }, - "systemApiVersion" : { - "type" : "string", - "description" : "The version of the system API that this bundle version was built against" - }, - "buildInfo" : { - "description" : "The build information about this version", - "$ref" : "#/definitions/BuildInfo" - } - } - }, - "ComponentDifference" : { - "type" : "object", - "properties" : { - "valueA" : { - "type" : "string", - "description" : "The earlier value from the difference." - }, - "valueB" : { - "type" : "string", - "description" : "The newer value from the difference." - }, - "changeDescription" : { - "type" : "string", - "description" : "The description of the change." - }, - "differenceType" : { - "type" : "string", - "description" : "The key to the difference." - }, - "differenceTypeDescription" : { - "type" : "string", - "description" : "The description of the change type." - } - } - }, - "ComponentDifferenceGroup" : { - "type" : "object", - "properties" : { - "componentId" : { - "type" : "string", - "description" : "The id of the component whose changes are grouped together." - }, - "componentName" : { - "type" : "string", - "description" : "The name of the component whose changes are grouped together." - }, - "componentType" : { - "type" : "string", - "description" : "The type of component these changes relate to." - }, - "processGroupId" : { - "type" : "string", - "description" : "The process group id for this component." - }, - "differences" : { - "type" : "array", - "description" : "The list of changes related to this component between the 2 versions.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ComponentDifference" - } - } - } - }, - "ConnectableComponent" : { - "type" : "object", - "required" : [ "groupId", "id", "type" ], - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the connectable component." - }, - "type" : { - "type" : "string", - "description" : "The type of component the connectable is.", - "enum" : [ "PROCESSOR", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "INPUT_PORT", "OUTPUT_PORT", "FUNNEL" ] - }, - "groupId" : { - "type" : "string", - "description" : "The id of the group that the connectable component resides in" - }, - "name" : { - "type" : "string", - "description" : "The name of the connectable component" - }, - "comments" : { - "type" : "string", - "description" : "The comments for the connectable component." - } - } - }, - "ControllerServiceAPI" : { - "type" : "object", - "properties" : { - "type" : { - "type" : "string", - "description" : "The fully qualified name of the service interface." - }, - "bundle" : { - "description" : "The details of the artifact that bundled this service interface.", - "$ref" : "#/definitions/Bundle" - } - } - }, - "ControllerServiceDefinition" : { - "type" : "object", - "properties" : { - "className" : { - "type" : "string", - "description" : "The class name of the service API" - }, - "groupId" : { - "type" : "string", - "description" : "The group id of the service API" - }, - "artifactId" : { - "type" : "string", - "description" : "The artifact id of the service API" - }, - "version" : { - "type" : "string", - "description" : "The version of the service API" - } - } - }, - "CurrentUser" : { - "type" : "object", - "properties" : { - "identity" : { - "type" : "string", - "description" : "The identity of the current user", - "readOnly" : true - }, - "anonymous" : { - "type" : "boolean", - "description" : "Indicates if the current user is anonymous", - "readOnly" : true - }, - "loginSupported" : { - "type" : "boolean", - "description" : "Indicates if the NiFi Registry instance supports logging in" - }, - "resourcePermissions" : { - "description" : "The access that the current user has to top level resources", - "readOnly" : true, - "$ref" : "#/definitions/ResourcePermissions" - }, - "oidcloginSupported" : { - "type" : "boolean", - "description" : "Indicates if the NiFi Registry instance supports logging in with an OIDC provider" - } - } - }, - "DeprecationNotice" : { - "type" : "object", - "properties" : { - "reason" : { - "type" : "string", - "description" : "The reason for the deprecation" - }, - "alternatives" : { - "type" : "array", - "xml" : { - "wrapped" : true - }, - "description" : "The alternatives to use", - "items" : { - "type" : "string", - "xml" : { - "name" : "alternative" - } - } - } - } - }, - "DynamicProperty" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The description of the dynamic property name" - }, - "value" : { - "type" : "string", - "description" : "The description of the dynamic property value" - }, - "description" : { - "type" : "string", - "description" : "The description of the dynamic property" - }, - "expressionLanguageScope" : { - "type" : "string", - "description" : "The scope of the expression language support", - "enum" : [ "NONE", "VARIABLE_REGISTRY", "FLOWFILE_ATTRIBUTES" ] - }, - "expressionLanguageSupported" : { - "type" : "boolean", - "description" : "Whether or not expression language is supported" - } - } - }, - "DynamicRelationship" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The description of the dynamic relationship name" - }, - "description" : { - "type" : "string", - "description" : "The description of the dynamic relationship" - } - } - }, - "Extension" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The name of the extension" - }, - "type" : { - "type" : "string", - "description" : "The type of the extension", - "enum" : [ "PROCESSOR", "CONTROLLER_SERVICE", "REPORTING_TASK" ] - }, - "deprecationNotice" : { - "description" : "The deprecation notice of the extension", - "$ref" : "#/definitions/DeprecationNotice" - }, - "description" : { - "type" : "string", - "description" : "The description of the extension" - }, - "tags" : { - "type" : "array", - "xml" : { - "wrapped" : true - }, - "description" : "The tags of the extension", - "items" : { - "type" : "string", - "xml" : { - "name" : "tag" - } - } - }, - "properties" : { - "type" : "array", - "xml" : { - "wrapped" : true - }, - "description" : "The properties of the extension", - "items" : { - "xml" : { - "name" : "property" - }, - "$ref" : "#/definitions/Property" - } - }, - "dynamicProperties" : { - "type" : "array", - "xml" : { - "wrapped" : true - }, - "description" : "The dynamic properties of the extension", - "items" : { - "xml" : { - "name" : "dynamicProperty" - }, - "$ref" : "#/definitions/DynamicProperty" - } - }, - "relationships" : { - "type" : "array", - "xml" : { - "wrapped" : true - }, - "description" : "The relationships of the extension", - "items" : { - "xml" : { - "name" : "relationship" - }, - "$ref" : "#/definitions/Relationship" - } - }, - "dynamicRelationship" : { - "description" : "The dynamic relationships of the extension", - "$ref" : "#/definitions/DynamicRelationship" - }, - "readsAttributes" : { - "type" : "array", - "xml" : { - "wrapped" : true - }, - "description" : "The attributes read from flow files by the extension", - "items" : { - "xml" : { - "name" : "readsAttribute" - }, - "$ref" : "#/definitions/Attribute" - } - }, - "writesAttributes" : { - "type" : "array", - "xml" : { - "wrapped" : true - }, - "description" : "The attributes written to flow files by the extension", - "items" : { - "xml" : { - "name" : "writesAttribute" - }, - "$ref" : "#/definitions/Attribute" - } - }, - "stateful" : { - "description" : "The information about how the extension stores state", - "$ref" : "#/definitions/Stateful" - }, - "restricted" : { - "description" : "The restrictions of the extension", - "$ref" : "#/definitions/Restricted" - }, - "inputRequirement" : { - "type" : "string", - "description" : "The input requirement of the extension", - "enum" : [ "INPUT_REQUIRED", "INPUT_ALLOWED", "INPUT_FORBIDDEN" ] - }, - "systemResourceConsiderations" : { - "type" : "array", - "xml" : { - "wrapped" : true - }, - "description" : "The resource considerations of the extension", - "items" : { - "xml" : { - "name" : "systemResourceConsideration" - }, - "$ref" : "#/definitions/SystemResourceConsideration" - } - }, - "seeAlso" : { - "type" : "array", - "xml" : { - "wrapped" : true - }, - "description" : "The names of other extensions to see", - "items" : { - "type" : "string", - "xml" : { - "name" : "see" - } - } - }, - "providedServiceAPIs" : { - "type" : "array", - "xml" : { - "wrapped" : true - }, - "description" : "The service APIs provided by this extension", - "items" : { - "xml" : { - "name" : "providedServiceAPI" - }, - "$ref" : "#/definitions/ProvidedServiceAPI" - } - } - } - }, - "ExtensionBundle" : { - "type" : "object", - "required" : [ "bucketIdentifier", "bundleType", "name", "type" ], - "properties" : { - "link" : { - "description" : "An WebLink to this entity.", - "readOnly" : true, - "$ref" : "#/definitions/JaxbLink" - }, - "identifier" : { - "type" : "string", - "description" : "An ID to uniquely identify this object.", - "readOnly" : true - }, - "name" : { - "type" : "string", - "description" : "The name of the item." - }, - "description" : { - "type" : "string", - "description" : "A description of the item." - }, - "bucketIdentifier" : { - "type" : "string", - "description" : "The identifier of the bucket this items belongs to. This cannot be changed after the item is created." - }, - "bucketName" : { - "type" : "string", - "description" : "The name of the bucket this items belongs to.", - "readOnly" : true - }, - "createdTimestamp" : { - "type" : "integer", - "format" : "int64", - "description" : "The timestamp of when the item was created, as milliseconds since epoch.", - "readOnly" : true, - "minimum" : 1 - }, - "modifiedTimestamp" : { - "type" : "integer", - "format" : "int64", - "description" : "The timestamp of when the item was last modified, as milliseconds since epoch.", - "readOnly" : true, - "minimum" : 1 - }, - "type" : { - "type" : "string", - "description" : "The type of item.", - "enum" : [ "Flow", "Bundle" ] - }, - "permissions" : { - "description" : "The access that the current user has to the bucket containing this item.", - "readOnly" : true, - "$ref" : "#/definitions/Permissions" - }, - "bundleType" : { - "type" : "string", - "description" : "The type of the extension bundle", - "enum" : [ "NIFI_NAR", "MINIFI_CPP" ] - }, - "groupId" : { - "type" : "string", - "description" : "The group id of the extension bundle" - }, - "artifactId" : { - "type" : "string", - "description" : "The artifact id of the extension bundle" - }, - "versionCount" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of versions of this extension bundle.", - "readOnly" : true, - "minimum" : 0 - } - } - }, - "ExtensionFilterParams" : { - "type" : "object", - "properties" : { - "bundleType" : { - "type" : "string", - "description" : "The type of bundle", - "enum" : [ "NIFI_NAR", "MINIFI_CPP" ] - }, - "extensionType" : { - "type" : "string", - "description" : "The type of extension", - "enum" : [ "PROCESSOR", "CONTROLLER_SERVICE", "REPORTING_TASK" ] - }, - "tags" : { - "type" : "array", - "description" : "The tags", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - } - } - }, - "ExtensionMetadata" : { - "type" : "object", - "properties" : { - "link" : { - "description" : "An WebLink to this entity.", - "readOnly" : true, - "$ref" : "#/definitions/JaxbLink" - }, - "name" : { - "type" : "string", - "description" : "The name of the extension" - }, - "displayName" : { - "type" : "string", - "description" : "The display name of the extension" - }, - "type" : { - "type" : "string", - "description" : "The type of the extension", - "enum" : [ "PROCESSOR", "CONTROLLER_SERVICE", "REPORTING_TASK" ] - }, - "description" : { - "type" : "string", - "description" : "The description of the extension" - }, - "deprecationNotice" : { - "description" : "The deprecation notice of the extension", - "$ref" : "#/definitions/DeprecationNotice" - }, - "tags" : { - "type" : "array", - "description" : "The tags of the extension", - "items" : { - "type" : "string" - } - }, - "restricted" : { - "description" : "The restrictions of the extension", - "$ref" : "#/definitions/Restricted" - }, - "providedServiceAPIs" : { - "type" : "array", - "description" : "The service APIs provided by the extension", - "items" : { - "$ref" : "#/definitions/ProvidedServiceAPI" - } - }, - "bundleInfo" : { - "description" : "The information for the bundle where this extension is located", - "$ref" : "#/definitions/BundleInfo" - }, - "hasAdditionalDetails" : { - "type" : "boolean", - "description" : "Whether or not the extension has additional detail documentation" - }, - "linkDocs" : { - "description" : "A WebLink to the documentation for this extension.", - "readOnly" : true, - "$ref" : "#/definitions/JaxbLink" - } - } - }, - "ExtensionMetadataContainer" : { - "type" : "object", - "properties" : { - "numResults" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of extensions in the response" - }, - "filterParams" : { - "description" : "The filter parameters submitted for the request", - "$ref" : "#/definitions/ExtensionFilterParams" - }, - "extensions" : { - "type" : "array", - "description" : "The metadata for the extensions", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ExtensionMetadata" - } - } - } - }, - "ExtensionRepoArtifact" : { - "type" : "object", - "properties" : { - "link" : { - "description" : "An WebLink to this entity.", - "readOnly" : true, - "$ref" : "#/definitions/JaxbLink" - }, - "bucketName" : { - "type" : "string", - "description" : "The bucket name" - }, - "groupId" : { - "type" : "string", - "description" : "The group id" - }, - "artifactId" : { - "type" : "string", - "description" : "The artifact id" - } - } - }, - "ExtensionRepoBucket" : { - "type" : "object", - "properties" : { - "link" : { - "description" : "An WebLink to this entity.", - "readOnly" : true, - "$ref" : "#/definitions/JaxbLink" - }, - "bucketName" : { - "type" : "string", - "description" : "The name of the bucket" - } - } - }, - "ExtensionRepoGroup" : { - "type" : "object", - "properties" : { - "link" : { - "description" : "An WebLink to this entity.", - "readOnly" : true, - "$ref" : "#/definitions/JaxbLink" - }, - "bucketName" : { - "type" : "string", - "description" : "The bucket name" - }, - "groupId" : { - "type" : "string", - "description" : "The group id" - } - } - }, - "ExtensionRepoVersion" : { - "type" : "object", - "properties" : { - "extensionsLink" : { - "description" : "The WebLink to view the metadata about the extensions contained in the extension bundle.", - "readOnly" : true, - "$ref" : "#/definitions/JaxbLink" - }, - "downloadLink" : { - "description" : "The WebLink to download this version of the extension bundle.", - "readOnly" : true, - "$ref" : "#/definitions/JaxbLink" - }, - "sha256Link" : { - "description" : "The WebLink to retrieve the SHA-256 digest for this version of the extension bundle.", - "readOnly" : true, - "$ref" : "#/definitions/JaxbLink" - }, - "sha256Supplied" : { - "description" : "Indicates if the client supplied a SHA-256 when uploading this version of the extension bundle.", - "readOnly" : true, - "$ref" : "#/definitions/JaxbLink" - } - } - }, - "ExtensionRepoVersionSummary" : { - "type" : "object", - "properties" : { - "link" : { - "description" : "An WebLink to this entity.", - "readOnly" : true, - "$ref" : "#/definitions/JaxbLink" - }, - "bucketName" : { - "type" : "string", - "description" : "The bucket name" - }, - "groupId" : { - "type" : "string", - "description" : "The group id" - }, - "artifactId" : { - "type" : "string", - "description" : "The artifact id" - }, - "version" : { - "type" : "string", - "description" : "The version" - }, - "author" : { - "type" : "string", - "description" : "The identity of the user that created this version" - }, - "timestamp" : { - "type" : "integer", - "format" : "int64", - "description" : "The timestamp of when this version was created" - } - } - }, - "ExternalControllerServiceReference" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The identifier of the controller service" - }, - "name" : { - "type" : "string", - "description" : "The name of the controller service" - } - } - }, - "Fields" : { - "type" : "object", - "properties" : { - "fields" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - } - } - }, - "JaxbLink" : { - "type" : "object", - "properties" : { - "href" : { - "type" : "string", - "format" : "uri", - "xml" : { - "attribute" : true - }, - "description" : "The href for the link" - }, - "params" : { - "type" : "object", - "description" : "The params for the link", - "additionalProperties" : { - "type" : "string" - } - } - } - }, - "Permissions" : { - "type" : "object", - "properties" : { - "canRead" : { - "type" : "boolean", - "description" : "Indicates whether the user can read a given resource.", - "readOnly" : true - }, - "canWrite" : { - "type" : "boolean", - "description" : "Indicates whether the user can write a given resource.", - "readOnly" : true - }, - "canDelete" : { - "type" : "boolean", - "description" : "Indicates whether the user can delete a given resource.", - "readOnly" : true - } - } - }, - "Position" : { - "type" : "object", - "properties" : { - "x" : { - "type" : "number", - "format" : "double", - "description" : "The x coordinate." - }, - "y" : { - "type" : "number", - "format" : "double", - "description" : "The y coordinate." - } - }, - "description" : "The position of a component on the graph" - }, - "Property" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The name of the property" - }, - "displayName" : { - "type" : "string", - "description" : "The display name" - }, - "description" : { - "type" : "string", - "description" : "The description" - }, - "defaultValue" : { - "type" : "string", - "description" : "The default value" - }, - "controllerServiceDefinition" : { - "description" : "The controller service required by this property, or null if none is required", - "$ref" : "#/definitions/ControllerServiceDefinition" - }, - "allowableValues" : { - "type" : "array", - "xml" : { - "wrapped" : true - }, - "description" : "The allowable values for this property", - "items" : { - "xml" : { - "name" : "allowableValue" - }, - "$ref" : "#/definitions/AllowableValue" - } - }, - "required" : { - "type" : "boolean", - "description" : "Whether or not the property is required" - }, - "sensitive" : { - "type" : "boolean", - "description" : "Whether or not the property is sensitive" - }, - "expressionLanguageSupported" : { - "type" : "boolean", - "description" : "Whether or not expression language is supported" - }, - "expressionLanguageScope" : { - "type" : "string", - "description" : "The scope of expression language support", - "enum" : [ "NONE", "VARIABLE_REGISTRY", "FLOWFILE_ATTRIBUTES" ] - }, - "dynamicallyModifiesClasspath" : { - "type" : "boolean", - "description" : "Whether or not the processor dynamically modifies the classpath" - }, - "dynamic" : { - "type" : "boolean", - "description" : "Whether or not the processor is dynamic" - } - } - }, - "ProvidedServiceAPI" : { - "type" : "object", - "properties" : { - "className" : { - "type" : "string", - "description" : "The class name of the service API being provided" - }, - "groupId" : { - "type" : "string", - "description" : "The group id of the service API being provided" - }, - "artifactId" : { - "type" : "string", - "description" : "The artifact id of the service API being provided" - }, - "version" : { - "type" : "string", - "description" : "The version of the service API being provided" - } - } - }, - "RegistryConfiguration" : { - "type" : "object", - "properties" : { - "supportsManagedAuthorizer" : { - "type" : "boolean", - "description" : "Whether this NiFi Registry supports a managed authorizer. Managed authorizers can visualize users, groups, and policies in the UI.", - "readOnly" : true - }, - "supportsConfigurableAuthorizer" : { - "type" : "boolean", - "description" : "Whether this NiFi Registry supports a configurable authorizer.", - "readOnly" : true - }, - "supportsConfigurableUsersAndGroups" : { - "type" : "boolean", - "description" : "Whether this NiFi Registry supports configurable users and groups.", - "readOnly" : true - } - } - }, - "Relationship" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The name of the relationship" - }, - "description" : { - "type" : "string", - "description" : "The description of the relationship" - }, - "autoTerminated" : { - "type" : "boolean", - "description" : "Whether or not the relationship is auto-terminated by default" - } - } - }, - "Resource" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The identifier of the resource.", - "readOnly" : true - }, - "name" : { - "type" : "string", - "description" : "The name of the resource.", - "readOnly" : true - } - } - }, - "ResourcePermissions" : { - "type" : "object", - "properties" : { - "buckets" : { - "description" : "The access that the current user has to the top level /buckets resource of this NiFi Registry (i.e., access to all buckets)", - "readOnly" : true, - "$ref" : "#/definitions/Permissions" - }, - "tenants" : { - "description" : "The access that the current user has to the top level /tenants resource of this NiFi Registry", - "readOnly" : true, - "$ref" : "#/definitions/Permissions" - }, - "policies" : { - "description" : "The access that the current user has to the top level /policies resource of this NiFi Registry", - "readOnly" : true, - "$ref" : "#/definitions/Permissions" - }, - "proxy" : { - "description" : "The access that the current user has to the top level /proxy resource of this NiFi Registry", - "readOnly" : true, - "$ref" : "#/definitions/Permissions" - }, - "anyTopLevelResource" : { - "description" : "The access that the current user has to any top level resources (a logical 'OR' of all other values)", - "readOnly" : true, - "$ref" : "#/definitions/Permissions" - } - } - }, - "Restricted" : { - "type" : "object", - "properties" : { - "generalRestrictionExplanation" : { - "type" : "string", - "description" : "The general restriction for the extension, or null if only specific restrictions exist" - }, - "restrictions" : { - "type" : "array", - "xml" : { - "wrapped" : true - }, - "description" : "The specific restrictions", - "items" : { - "xml" : { - "name" : "restriction" - }, - "$ref" : "#/definitions/Restriction" - } - } - } - }, - "Restriction" : { - "type" : "object", - "properties" : { - "requiredPermission" : { - "type" : "string", - "description" : "The permission required for this restriction" - }, - "explanation" : { - "type" : "string", - "description" : "The explanation of this restriction" - } - } - }, - "RevisionInfo" : { - "type" : "object", - "properties" : { - "clientId" : { - "type" : "string", - "description" : "A client identifier used to make a request. By including a client identifier, the API can allow multiple requests without needing the current revision. Due to the asynchronous nature of requests/responses this was implemented to allow the client to make numerous requests without having to wait for the previous response to come back." - }, - "version" : { - "type" : "integer", - "format" : "int64", - "description" : "NiFi Registry employs an optimistic locking strategy where the client must include a revision in their request when performing an update. In a response to a mutable flow request, this field represents the updated base version." - }, - "lastModifier" : { - "type" : "string", - "description" : "The user that last modified the entity.", - "readOnly" : true - } - }, - "description" : "The revision information for an entity managed through the REST API." - }, - "Stateful" : { - "type" : "object", - "properties" : { - "description" : { - "type" : "string", - "description" : "The description for how the extension stores state" - }, - "scopes" : { - "type" : "array", - "xml" : { - "wrapped" : true - }, - "description" : "The scopes used to store state", - "items" : { - "type" : "string", - "xml" : { - "name" : "scope" - }, - "enum" : [ "CLUSTER", "LOCAL" ] - } - } - } - }, - "SystemResourceConsideration" : { - "type" : "object", - "properties" : { - "resource" : { - "type" : "string", - "description" : "The resource to consider" - }, - "description" : { - "type" : "string", - "description" : "The description of how the resource is affected" - } - } - }, - "TagCount" : { - "type" : "object", - "properties" : { - "tag" : { - "type" : "string", - "description" : "The tag label" - }, - "count" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of occurrences of the given tag" - } - } - }, - "Tenant" : { - "type" : "object", - "required" : [ "identity" ], - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The computer-generated identifier of the tenant.", - "readOnly" : true - }, - "identity" : { - "type" : "string", - "description" : "The human-facing identity of the tenant. This can only be changed if the tenant is configurable." - }, - "configurable" : { - "type" : "boolean", - "description" : "Indicates if this tenant is configurable, based on which UserGroupProvider has been configured to manage it.", - "readOnly" : true - }, - "resourcePermissions" : { - "description" : "A summary top-level resource access policies granted to this tenant.", - "readOnly" : true, - "$ref" : "#/definitions/ResourcePermissions" - }, - "accessPolicies" : { - "type" : "array", - "description" : "The access policies granted to this tenant.", - "readOnly" : true, - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/AccessPolicySummary" - } - }, - "revision" : { - "description" : "The revision of this entity used for optimistic-locking during updates.", - "readOnly" : true, - "$ref" : "#/definitions/RevisionInfo" - } - } - }, - "User" : { - "type" : "object", - "required" : [ "identity" ], - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The computer-generated identifier of the tenant.", - "readOnly" : true - }, - "identity" : { - "type" : "string", - "description" : "The human-facing identity of the tenant. This can only be changed if the tenant is configurable." - }, - "configurable" : { - "type" : "boolean", - "description" : "Indicates if this tenant is configurable, based on which UserGroupProvider has been configured to manage it.", - "readOnly" : true - }, - "resourcePermissions" : { - "description" : "A summary top-level resource access policies granted to this tenant.", - "readOnly" : true, - "$ref" : "#/definitions/ResourcePermissions" - }, - "accessPolicies" : { - "type" : "array", - "description" : "The access policies granted to this tenant.", - "readOnly" : true, - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/AccessPolicySummary" - } - }, - "revision" : { - "description" : "The revision of this entity used for optimistic-locking during updates.", - "readOnly" : true, - "$ref" : "#/definitions/RevisionInfo" - }, - "userGroups" : { - "type" : "array", - "description" : "The groups to which the user belongs.", - "readOnly" : true, - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/Tenant" - } - } - } - }, - "UserGroup" : { - "type" : "object", - "required" : [ "identity" ], - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The computer-generated identifier of the tenant.", - "readOnly" : true - }, - "identity" : { - "type" : "string", - "description" : "The human-facing identity of the tenant. This can only be changed if the tenant is configurable." - }, - "configurable" : { - "type" : "boolean", - "description" : "Indicates if this tenant is configurable, based on which UserGroupProvider has been configured to manage it.", - "readOnly" : true - }, - "resourcePermissions" : { - "description" : "A summary top-level resource access policies granted to this tenant.", - "readOnly" : true, - "$ref" : "#/definitions/ResourcePermissions" - }, - "accessPolicies" : { - "type" : "array", - "description" : "The access policies granted to this tenant.", - "readOnly" : true, - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/AccessPolicySummary" - } - }, - "revision" : { - "description" : "The revision of this entity used for optimistic-locking during updates.", - "readOnly" : true, - "$ref" : "#/definitions/RevisionInfo" - }, - "users" : { - "type" : "array", - "description" : "The users that belong to this user group. This can only be changed if this group is configurable.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/Tenant" - } - } - } - }, - "VersionedConnection" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The component's unique identifier" - }, - "name" : { - "type" : "string", - "description" : "The component's name" - }, - "comments" : { - "type" : "string", - "description" : "The user-supplied comments for the component" - }, - "position" : { - "description" : "The component's position on the graph", - "$ref" : "#/definitions/Position" - }, - "source" : { - "description" : "The source of the connection.", - "$ref" : "#/definitions/ConnectableComponent" - }, - "destination" : { - "description" : "The destination of the connection.", - "$ref" : "#/definitions/ConnectableComponent" - }, - "labelIndex" : { - "type" : "integer", - "format" : "int32", - "description" : "The index of the bend point where to place the connection label." - }, - "zIndex" : { - "type" : "integer", - "format" : "int64", - "description" : "The z index of the connection." - }, - "selectedRelationships" : { - "type" : "array", - "description" : "The selected relationship that comprise the connection.", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - }, - "backPressureObjectThreshold" : { - "type" : "integer", - "format" : "int64", - "description" : "The object count threshold for determining when back pressure is applied. Updating this value is a passive change in the sense that it won't impact whether existing files over the limit are affected but it does help feeder processors to stop pushing too much into this work queue." - }, - "backPressureDataSizeThreshold" : { - "type" : "string", - "description" : "The object data size threshold for determining when back pressure is applied. Updating this value is a passive change in the sense that it won't impact whether existing files over the limit are affected but it does help feeder processors to stop pushing too much into this work queue." - }, - "flowFileExpiration" : { - "type" : "string", - "description" : "The amount of time a flow file may be in the flow before it will be automatically aged out of the flow. Once a flow file reaches this age it will be terminated from the flow the next time a processor attempts to start work on it." - }, - "prioritizers" : { - "type" : "array", - "description" : "The comparators used to prioritize the queue.", - "items" : { - "type" : "string" - } - }, - "bends" : { - "type" : "array", - "description" : "The bend points on the connection.", - "items" : { - "$ref" : "#/definitions/Position" - } - }, - "loadBalanceStrategy" : { - "type" : "string", - "description" : "The Strategy to use for load balancing data across the cluster, or null, if no Load Balance Strategy has been specified.", - "enum" : [ "DO_NOT_LOAD_BALANCE", "PARTITION_BY_ATTRIBUTE", "ROUND_ROBIN", "SINGLE_NODE" ] - }, - "partitioningAttribute" : { - "type" : "string", - "description" : "The attribute to use for partitioning data as it is load balanced across the cluster. If the Load Balance Strategy is configured to use PARTITION_BY_ATTRIBUTE, the value returned by this method is the name of the FlowFile Attribute that will be used to determine which node in the cluster should receive a given FlowFile. If the Load Balance Strategy is unset or is set to any other value, the Partitioning Attribute has no effect." - }, - "loadBalanceCompression" : { - "type" : "string", - "description" : "Whether or not compression should be used when transferring FlowFiles between nodes", - "enum" : [ "DO_NOT_COMPRESS", "COMPRESS_ATTRIBUTES_ONLY", "COMPRESS_ATTRIBUTES_AND_CONTENT" ] - }, - "componentType" : { - "type" : "string", - "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE" ] - }, - "groupIdentifier" : { - "type" : "string", - "description" : "The ID of the Process Group that this component belongs to" - } - } - }, - "VersionedControllerService" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The component's unique identifier" - }, - "name" : { - "type" : "string", - "description" : "The component's name" - }, - "comments" : { - "type" : "string", - "description" : "The user-supplied comments for the component" - }, - "position" : { - "description" : "The component's position on the graph", - "$ref" : "#/definitions/Position" - }, - "type" : { - "type" : "string", - "description" : "The type of the controller service." - }, - "bundle" : { - "description" : "The details of the artifact that bundled this processor type.", - "$ref" : "#/definitions/Bundle" - }, - "controllerServiceApis" : { - "type" : "array", - "description" : "Lists the APIs this Controller Service implements.", - "items" : { - "$ref" : "#/definitions/ControllerServiceAPI" - } - }, - "properties" : { - "type" : "object", - "description" : "The properties of the controller service.", - "additionalProperties" : { - "type" : "string" - } - }, - "propertyDescriptors" : { - "type" : "object", - "description" : "The property descriptors for the processor.", - "additionalProperties" : { - "$ref" : "#/definitions/VersionedPropertyDescriptor" - } - }, - "annotationData" : { - "type" : "string", - "description" : "The annotation for the controller service. This is how the custom UI relays configuration to the controller service." - }, - "componentType" : { - "type" : "string", - "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE" ] - }, - "groupIdentifier" : { - "type" : "string", - "description" : "The ID of the Process Group that this component belongs to" - } - } - }, - "VersionedFlow" : { - "type" : "object", - "required" : [ "bucketIdentifier", "name", "type" ], - "properties" : { - "link" : { - "description" : "An WebLink to this entity.", - "readOnly" : true, - "$ref" : "#/definitions/JaxbLink" - }, - "identifier" : { - "type" : "string", - "description" : "An ID to uniquely identify this object.", - "readOnly" : true - }, - "name" : { - "type" : "string", - "description" : "The name of the item." - }, - "description" : { - "type" : "string", - "description" : "A description of the item." - }, - "bucketIdentifier" : { - "type" : "string", - "description" : "The identifier of the bucket this items belongs to. This cannot be changed after the item is created." - }, - "bucketName" : { - "type" : "string", - "description" : "The name of the bucket this items belongs to.", - "readOnly" : true - }, - "createdTimestamp" : { - "type" : "integer", - "format" : "int64", - "description" : "The timestamp of when the item was created, as milliseconds since epoch.", - "readOnly" : true, - "minimum" : 1 - }, - "modifiedTimestamp" : { - "type" : "integer", - "format" : "int64", - "description" : "The timestamp of when the item was last modified, as milliseconds since epoch.", - "readOnly" : true, - "minimum" : 1 - }, - "type" : { - "type" : "string", - "description" : "The type of item.", - "enum" : [ "Flow", "Bundle" ] - }, - "permissions" : { - "description" : "The access that the current user has to the bucket containing this item.", - "readOnly" : true, - "$ref" : "#/definitions/Permissions" - }, - "versionCount" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of versions of this flow.", - "readOnly" : true, - "minimum" : 0 - }, - "revision" : { - "description" : "The revision of this entity used for optimistic-locking during updates.", - "readOnly" : true, - "$ref" : "#/definitions/RevisionInfo" - } - } - }, - "VersionedFlowCoordinates" : { - "type" : "object", - "properties" : { - "registryUrl" : { - "type" : "string", - "description" : "The URL of the Flow Registry that contains the flow" - }, - "bucketId" : { - "type" : "string", - "description" : "The UUID of the bucket that the flow resides in" - }, - "flowId" : { - "type" : "string", - "description" : "The UUID of the flow" - }, - "version" : { - "type" : "integer", - "format" : "int32", - "description" : "The version of the flow" - }, - "latest" : { - "type" : "boolean", - "description" : "Whether or not these coordinates point to the latest version of the flow" - } - } - }, - "VersionedFlowDifference" : { - "type" : "object", - "properties" : { - "bucketId" : { - "type" : "string", - "description" : "The id of the bucket that the flow is stored in." - }, - "flowId" : { - "type" : "string", - "description" : "The id of the flow that is being examined." - }, - "versionA" : { - "type" : "integer", - "format" : "int32", - "description" : "The earlier version from the diff operation." - }, - "versionB" : { - "type" : "integer", - "format" : "int32", - "description" : "The latter version from the diff operation." - }, - "componentDifferenceGroups" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ComponentDifferenceGroup" - } - } - } - }, - "VersionedFlowSnapshot" : { - "type" : "object", - "required" : [ "flowContents", "snapshotMetadata" ], - "properties" : { - "snapshotMetadata" : { - "description" : "The metadata for this snapshot", - "$ref" : "#/definitions/VersionedFlowSnapshotMetadata" - }, - "flowContents" : { - "description" : "The contents of the versioned flow", - "$ref" : "#/definitions/VersionedProcessGroup" - }, - "externalControllerServices" : { - "type" : "object", - "description" : "The information about controller services that exist outside this versioned flow, but are referenced by components within the versioned flow.", - "additionalProperties" : { - "$ref" : "#/definitions/ExternalControllerServiceReference" - } - }, - "parameterContexts" : { - "type" : "object", - "description" : "The parameter contexts referenced by process groups in the flow contents. The mapping is from the name of the context to the context instance, and it is expected that any context in this map is referenced by at least one process group in this flow.", - "additionalProperties" : { - "$ref" : "#/definitions/VersionedParameterContext" - } - }, - "flowEncodingVersion" : { - "type" : "string", - "description" : "The optional encoding version of the flow contents." - }, - "flow" : { - "description" : "The flow this snapshot is for", - "readOnly" : true, - "$ref" : "#/definitions/VersionedFlow" - }, - "bucket" : { - "description" : "The bucket where the flow is located", - "readOnly" : true, - "$ref" : "#/definitions/Bucket" - }, - "latest" : { - "type" : "boolean" - } - } - }, - "VersionedFlowSnapshotMetadata" : { - "type" : "object", - "required" : [ "bucketIdentifier", "flowIdentifier", "version" ], - "properties" : { - "link" : { - "description" : "An WebLink to this entity.", - "readOnly" : true, - "$ref" : "#/definitions/JaxbLink" - }, - "bucketIdentifier" : { - "type" : "string", - "description" : "The identifier of the bucket this snapshot belongs to." - }, - "flowIdentifier" : { - "type" : "string", - "description" : "The identifier of the flow this snapshot belongs to." - }, - "version" : { - "type" : "integer", - "format" : "int32", - "description" : "The version of this snapshot of the flow.", - "minimum" : -1 - }, - "timestamp" : { - "type" : "integer", - "format" : "int64", - "description" : "The timestamp when the flow was saved, as milliseconds since epoch.", - "readOnly" : true, - "minimum" : 1 - }, - "author" : { - "type" : "string", - "description" : "The user that created this snapshot of the flow.", - "readOnly" : true - }, - "comments" : { - "type" : "string", - "description" : "The comments provided by the user when creating the snapshot." - } - } - }, - "VersionedFunnel" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The component's unique identifier" - }, - "name" : { - "type" : "string", - "description" : "The component's name" - }, - "comments" : { - "type" : "string", - "description" : "The user-supplied comments for the component" - }, - "position" : { - "description" : "The component's position on the graph", - "$ref" : "#/definitions/Position" - }, - "componentType" : { - "type" : "string", - "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE" ] - }, - "groupIdentifier" : { - "type" : "string", - "description" : "The ID of the Process Group that this component belongs to" - } - } - }, - "VersionedLabel" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The component's unique identifier" - }, - "name" : { - "type" : "string", - "description" : "The component's name" - }, - "comments" : { - "type" : "string", - "description" : "The user-supplied comments for the component" - }, - "position" : { - "description" : "The component's position on the graph", - "$ref" : "#/definitions/Position" - }, - "label" : { - "type" : "string", - "description" : "The text that appears in the label." - }, - "width" : { - "type" : "number", - "format" : "double", - "description" : "The width of the label in pixels when at a 1:1 scale." - }, - "height" : { - "type" : "number", - "format" : "double", - "description" : "The height of the label in pixels when at a 1:1 scale." - }, - "style" : { - "type" : "object", - "description" : "The styles for this label (font-size : 12px, background-color : #eee, etc).", - "additionalProperties" : { - "type" : "string" - } - }, - "componentType" : { - "type" : "string", - "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE" ] - }, - "groupIdentifier" : { - "type" : "string", - "description" : "The ID of the Process Group that this component belongs to" - } - } - }, - "VersionedParameter" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The name of the parameter" - }, - "description" : { - "type" : "string", - "description" : "The description of the param" - }, - "sensitive" : { - "type" : "boolean", - "description" : "Whether or not the parameter value is sensitive" - }, - "value" : { - "type" : "string", - "description" : "The value of the parameter" - } - } - }, - "VersionedParameterContext" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The name of the context" - }, - "description" : { - "type" : "string", - "description" : "The description of the parameter context" - }, - "parameters" : { - "type" : "array", - "description" : "The parameters in the context", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedParameter" - } - }, - "inheritedParameterContexts" : { - "type" : "array", - "description" : "The names of additional parameter contexts from which to inherit parameters", - "items" : { - "type" : "string" - } - } - } - }, - "VersionedPort" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The component's unique identifier" - }, - "name" : { - "type" : "string", - "description" : "The component's name" - }, - "comments" : { - "type" : "string", - "description" : "The user-supplied comments for the component" - }, - "position" : { - "description" : "The component's position on the graph", - "$ref" : "#/definitions/Position" - }, - "type" : { - "type" : "string", - "description" : "The type of port.", - "enum" : [ "INPUT_PORT", "OUTPUT_PORT" ] - }, - "concurrentlySchedulableTaskCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of tasks that should be concurrently scheduled for the port." - }, - "scheduledState" : { - "type" : "string", - "description" : "The scheduled state of the component", - "enum" : [ "ENABLED", "DISABLED" ] - }, - "allowRemoteAccess" : { - "type" : "boolean", - "description" : "Whether or not this port allows remote access for site-to-site" - }, - "componentType" : { - "type" : "string", - "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE" ] - }, - "groupIdentifier" : { - "type" : "string", - "description" : "The ID of the Process Group that this component belongs to" - } - } - }, - "VersionedProcessGroup" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The component's unique identifier" - }, - "name" : { - "type" : "string", - "description" : "The component's name" - }, - "comments" : { - "type" : "string", - "description" : "The user-supplied comments for the component" - }, - "position" : { - "description" : "The component's position on the graph", - "$ref" : "#/definitions/Position" - }, - "processGroups" : { - "type" : "array", - "description" : "The child Process Groups", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedProcessGroup" - } - }, - "remoteProcessGroups" : { - "type" : "array", - "description" : "The Remote Process Groups", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedRemoteProcessGroup" - } - }, - "processors" : { - "type" : "array", - "description" : "The Processors", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedProcessor" - } - }, - "inputPorts" : { - "type" : "array", - "description" : "The Input Ports", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedPort" - } - }, - "outputPorts" : { - "type" : "array", - "description" : "The Output Ports", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedPort" - } - }, - "connections" : { - "type" : "array", - "description" : "The Connections", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedConnection" - } - }, - "labels" : { - "type" : "array", - "description" : "The Labels", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedLabel" - } - }, - "funnels" : { - "type" : "array", - "description" : "The Funnels", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedFunnel" - } - }, - "controllerServices" : { - "type" : "array", - "description" : "The Controller Services", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedControllerService" - } - }, - "versionedFlowCoordinates" : { - "description" : "The coordinates where the remote flow is stored, or null if the Process Group is not directly under Version Control", - "$ref" : "#/definitions/VersionedFlowCoordinates" - }, - "variables" : { - "type" : "object", - "description" : "The Variables in the Variable Registry for this Process Group (not including any ancestor or descendant Process Groups)", - "additionalProperties" : { - "type" : "string" - } - }, - "parameterContextName" : { - "type" : "string", - "description" : "The name of the parameter context used by this process group" - }, - "defaultFlowFileExpiration" : { - "type" : "string", - "description" : "The default FlowFile Expiration for this Process Group." - }, - "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." - }, - "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." - }, - "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" ] - }, - "flowFileConcurrency" : { - "type" : "string", - "description" : "The configured FlowFile Concurrency for the Process Group" - }, - "flowFileOutboundPolicy" : { - "type" : "string", - "description" : "The FlowFile Outbound Policy for the Process Group" - }, - "groupIdentifier" : { - "type" : "string", - "description" : "The ID of the Process Group that this component belongs to" - } - } - }, - "VersionedProcessor" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The component's unique identifier" - }, - "name" : { - "type" : "string", - "description" : "The component's name" - }, - "comments" : { - "type" : "string", - "description" : "The user-supplied comments for the component" - }, - "position" : { - "description" : "The component's position on the graph", - "$ref" : "#/definitions/Position" - }, - "bundle" : { - "description" : "Information about the bundle from which the component came", - "$ref" : "#/definitions/Bundle" - }, - "style" : { - "type" : "object", - "description" : "Stylistic data for rendering in a UI", - "additionalProperties" : { - "type" : "string" - } - }, - "type" : { - "type" : "string", - "description" : "The type of Processor" - }, - "properties" : { - "type" : "object", - "description" : "The properties for the processor. Properties whose value is not set will only contain the property name.", - "additionalProperties" : { - "type" : "string" - } - }, - "propertyDescriptors" : { - "type" : "object", - "description" : "The property descriptors for the processor.", - "additionalProperties" : { - "$ref" : "#/definitions/VersionedPropertyDescriptor" - } - }, - "annotationData" : { - "type" : "string", - "description" : "The annotation data for the processor used to relay configuration between a custom UI and the procesosr." - }, - "schedulingPeriod" : { - "type" : "string", - "description" : "The frequency with which to schedule the processor. The format of the value will depend on th value of schedulingStrategy." - }, - "schedulingStrategy" : { - "type" : "string", - "description" : "Indcates whether the prcessor should be scheduled to run in event or timer driven mode." - }, - "executionNode" : { - "type" : "string", - "description" : "Indicates the node where the process will execute." - }, - "penaltyDuration" : { - "type" : "string", - "description" : "The amout of time that is used when the process penalizes a flowfile." - }, - "yieldDuration" : { - "type" : "string", - "description" : "The amount of time that must elapse before this processor is scheduled again after yielding." - }, - "bulletinLevel" : { - "type" : "string", - "description" : "The level at which the processor will report bulletins." - }, - "runDurationMillis" : { - "type" : "integer", - "format" : "int64", - "description" : "The run duration for the processor in milliseconds." - }, - "concurrentlySchedulableTaskCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of tasks that should be concurrently schedule for the processor. If the processor doesn't allow parallol processing then any positive input will be ignored." - }, - "autoTerminatedRelationships" : { - "type" : "array", - "description" : "The names of all relationships that cause a flow file to be terminated if the relationship is not connected elsewhere. This property differs from the 'isAutoTerminate' property of the RelationshipDTO in that the RelationshipDTO is meant to depict the current configuration, whereas this property can be set in a DTO when updating a Processor in order to change which Relationships should be auto-terminated.", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - }, - "scheduledState" : { - "type" : "string", - "description" : "The scheduled state of the component", - "enum" : [ "ENABLED", "DISABLED" ] - }, - "componentType" : { - "type" : "string", - "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE" ] - }, - "groupIdentifier" : { - "type" : "string", - "description" : "The ID of the Process Group that this component belongs to" - } - } - }, - "VersionedPropertyDescriptor" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The name of the property" - }, - "displayName" : { - "type" : "string", - "description" : "The display name of the property" - }, - "identifiesControllerService" : { - "type" : "boolean", - "description" : "Whether or not the property provides the identifier of a Controller Service" - }, - "sensitive" : { - "type" : "boolean", - "description" : "Whether or not the property is considered sensitive" - }, - "resourceDefinition" : { - "description" : "Returns the Resource Definition that defines which type(s) of resource(s) this property references, if any", - "$ref" : "#/definitions/VersionedResourceDefinition" - } - } - }, - "VersionedRemoteGroupPort" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The component's unique identifier" - }, - "name" : { - "type" : "string", - "description" : "The component's name" - }, - "comments" : { - "type" : "string", - "description" : "The user-supplied comments for the component" - }, - "position" : { - "description" : "The component's position on the graph", - "$ref" : "#/definitions/Position" - }, - "remoteGroupId" : { - "type" : "string", - "description" : "The id of the remote process group that the port resides in." - }, - "concurrentlySchedulableTaskCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of task that may transmit flowfiles to the target port concurrently." - }, - "useCompression" : { - "type" : "boolean", - "description" : "Whether the flowfiles are compressed when sent to the target port." - }, - "batchSize" : { - "description" : "The batch settings for data transmission.", - "$ref" : "#/definitions/BatchSize" - }, - "componentType" : { - "type" : "string", - "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE" ] - }, - "targetId" : { - "type" : "string", - "description" : "The ID of the port on the target NiFi instance" - }, - "scheduledState" : { - "type" : "string", - "description" : "The scheduled state of the component", - "enum" : [ "ENABLED", "DISABLED" ] - }, - "groupIdentifier" : { - "type" : "string", - "description" : "The ID of the Process Group that this component belongs to" - } - } - }, - "VersionedRemoteProcessGroup" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The component's unique identifier" - }, - "name" : { - "type" : "string", - "description" : "The component's name" - }, - "comments" : { - "type" : "string", - "description" : "The user-supplied comments for the component" - }, - "position" : { - "description" : "The component's position on the graph", - "$ref" : "#/definitions/Position" - }, - "targetUri" : { - "type" : "string", - "description" : "[DEPRECATED] The target URI of the remote process group. If target uri is not set, but uris are set, then returns the first uri in the uris. If neither target uri nor uris are set, then returns null." - }, - "targetUris" : { - "type" : "string", - "description" : "The target URIs of the remote process group. If target uris is not set but target uri is set, then returns the single target uri. If neither target uris nor target uri is set, then returns null." - }, - "communicationsTimeout" : { - "type" : "string", - "description" : "The time period used for the timeout when communicating with the target." - }, - "yieldDuration" : { - "type" : "string", - "description" : "When yielding, this amount of time must elapse before the remote process group is scheduled again." - }, - "transportProtocol" : { - "type" : "string", - "description" : "The Transport Protocol that is used for Site-to-Site communications", - "enum" : [ "RAW", "HTTP" ] - }, - "localNetworkInterface" : { - "type" : "string", - "description" : "The local network interface to send/receive data. If not specified, any local address is used. If clustered, all nodes must have an interface with this identifier." - }, - "proxyHost" : { - "type" : "string" - }, - "proxyPort" : { - "type" : "integer", - "format" : "int32" - }, - "proxyUser" : { - "type" : "string" - }, - "inputPorts" : { - "type" : "array", - "description" : "A Set of Input Ports that can be connected to, in order to send data to the remote NiFi instance", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedRemoteGroupPort" - } - }, - "outputPorts" : { - "type" : "array", - "description" : "A Set of Output Ports that can be connected to, in order to pull data from the remote NiFi instance", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedRemoteGroupPort" - } - }, - "componentType" : { - "type" : "string", - "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE" ] - }, - "groupIdentifier" : { - "type" : "string", - "description" : "The ID of the Process Group that this component belongs to" - } - } - }, - "VersionedResourceDefinition" : { - "type" : "object", - "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", - "uniqueItems" : true, - "items" : { - "type" : "string", - "enum" : [ "FILE", "DIRECTORY", "TEXT", "URL" ] - } - } - } - } - } -} diff --git a/resources/client_gen/api_defs/registry-1.16.1.json b/resources/client_gen/api_defs/registry-1.16.1.json deleted file mode 100644 index 206a2637..00000000 --- a/resources/client_gen/api_defs/registry-1.16.1.json +++ /dev/null @@ -1,7003 +0,0 @@ -{ - "swagger" : "2.0", - "info" : { - "description" : "The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components.", - "version" : "1.16.1", - "title" : "Apache NiFi Registry REST API", - "termsOfService" : "As described in the license", - "contact" : { - "name" : "Apache NiFi Registry", - "url" : "https://nifi.apache.org", - "email" : "dev@nifi.apache.org" - }, - "license" : { - "name" : "Apache 2.0 License", - "url" : "https://www.apache.org/licenses/LICENSE-2.0.html" - } - }, - "basePath" : "/nifi-registry-api", - "tags" : [ { - "name" : "about", - "description" : "Retrieves the version information for this NiFi Registry." - }, { - "name" : "access", - "description" : "Endpoints for obtaining an access token or checking access status." - }, { - "name" : "bucket bundles", - "description" : "Create extension bundles scoped to an existing bucket in the registry. " - }, { - "name" : "bucket flows", - "description" : "Create flows scoped to an existing bucket in the registry." - }, { - "name" : "buckets", - "description" : "Create named buckets in the registry to store NiFi objects such flows and extensions. Search for and retrieve existing buckets." - }, { - "name" : "bundles", - "description" : "Gets metadata about extension bundles and their versions. " - }, { - "name" : "config", - "description" : "Retrieves the configuration for this NiFi Registry." - }, { - "name" : "extension repository", - "description" : "Interact with extension bundles via the hierarchy of bucket/group/artifact/version. " - }, { - "name" : "extensions", - "description" : "Find and retrieve extensions. " - }, { - "name" : "flows", - "description" : "Gets metadata about flows." - }, { - "name" : "items", - "description" : "Retrieve items across all buckets for which the user is authorized." - }, { - "name" : "policies", - "description" : "Endpoint for managing access policies." - }, { - "name" : "tenants", - "description" : "Endpoint for managing users and user groups." - } ], - "schemes" : [ "http", "https" ], - "paths" : { - "/about" : { - "get" : { - "tags" : [ "about" ], - "summary" : "Get version", - "description" : "Gets the NiFi Registry version.", - "operationId" : "getVersion", - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/RegistryAbout" - } - } - }, - "security" : [ { - "Authorization" : [ ] - } ] - } - }, - "/access" : { - "get" : { - "tags" : [ "access" ], - "summary" : "Get access status", - "description" : "Returns the current client's authenticated identity and permissions to top-level resources", - "operationId" : "getAccessStatus", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/CurrentUser" - } - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid. The NiFi Registry might be running unsecured." - } - }, - "security" : [ { - "Authorization" : [ ] - } ] - } - }, - "/access/logout" : { - "delete" : { - "tags" : [ "access" ], - "summary" : "Performs a logout for other providers that have been issued a JWT.", - "description" : "\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "logOut", - "consumes" : [ "*/*" ], - "produces" : [ "*/*" ], - "responses" : { - "200" : { - "description" : "User was logged out successfully." - }, - "401" : { - "description" : "Authentication token provided was empty or not in the correct JWT format." - }, - "500" : { - "description" : "Client failed to log out." - } - } - } - }, - "/access/oidc/callback" : { - "get" : { - "tags" : [ "access" ], - "summary" : "Redirect/callback URI for processing the result of the OpenId Connect login sequence.", - "description" : "\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "oidcCallback", - "consumes" : [ "*/*" ], - "produces" : [ "*/*" ], - "responses" : { - "default" : { - "description" : "successful operation" - } - } - } - }, - "/access/oidc/exchange" : { - "post" : { - "tags" : [ "access" ], - "summary" : "Retrieves a JWT following a successful login sequence using the configured OpenId Connect provider.", - "description" : "\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "oidcExchange", - "consumes" : [ "*/*" ], - "produces" : [ "text/plain" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - } - } - } - }, - "/access/oidc/logout" : { - "delete" : { - "tags" : [ "access" ], - "summary" : "Performs a logout in the OpenId Provider.", - "description" : "\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "oidcLogout", - "consumes" : [ "*/*" ], - "produces" : [ "*/*" ], - "responses" : { - "default" : { - "description" : "successful operation" - } - } - } - }, - "/access/oidc/request" : { - "get" : { - "tags" : [ "access" ], - "summary" : "Initiates a request to authenticate through the configured OpenId Connect provider.", - "description" : "\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "oidcRequest", - "consumes" : [ "*/*" ], - "produces" : [ "*/*" ], - "responses" : { - "default" : { - "description" : "successful operation" - } - } - } - }, - "/access/token" : { - "post" : { - "tags" : [ "access" ], - "summary" : "Create token trying all providers", - "description" : "Creates a token for accessing the REST API via auto-detected method of verifying client identity claim credentials. The token returned is formatted as a JSON Web Token (JWT). The token is base64 encoded and comprised of three parts. The header, the body, and the signature. The expiration of the token is a contained within the body. The token can be used in the Authorization header in the format 'Authorization: Bearer '.", - "operationId" : "createAccessTokenByTryingAllProviders", - "consumes" : [ "*/*" ], - "produces" : [ "text/plain" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid. The NiFi Registry may not be configured to support login with username/password." - }, - "500" : { - "description" : "NiFi Registry was unable to complete the request because an unexpected error occurred." - } - } - } - }, - "/access/token/identity-provider" : { - "post" : { - "tags" : [ "access" ], - "summary" : "Create token using identity provider", - "description" : "Creates a token for accessing the REST API via a custom identity provider. The user credentials must be passed in a format understood by the custom identity provider, e.g., a third-party auth token in an HTTP header. The exact format of the user credentials expected by the custom identity provider can be discovered by 'GET /access/token/identity-provider/usage'. The token returned is formatted as a JSON Web Token (JWT). The token is base64 encoded and comprised of three parts. The header, the body, and the signature. The expiration of the token is a contained within the body. The token can be used in the Authorization header in the format 'Authorization: Bearer '.", - "operationId" : "createAccessTokenUsingIdentityProviderCredentials", - "consumes" : [ "*/*" ], - "produces" : [ "text/plain" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid. The NiFi Registry may not be configured to support login with customized credentials." - }, - "500" : { - "description" : "NiFi Registry was unable to complete the request because an unexpected error occurred." - } - } - } - }, - "/access/token/identity-provider/test" : { - "post" : { - "tags" : [ "access" ], - "summary" : "Test identity provider", - "description" : "Tests the format of the credentials against this identity provider without preforming authentication on the credentials to validate them. The user credentials should be passed in a format understood by the custom identity provider as defined by 'GET /access/token/identity-provider/usage'.", - "operationId" : "testIdentityProviderRecognizesCredentialsFormat", - "consumes" : [ "*/*" ], - "produces" : [ "text/plain" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "The format of the credentials were not recognized by the currently configured identity provider." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid. The NiFi Registry may not be configured to support login with customized credentials." - }, - "500" : { - "description" : "NiFi Registry was unable to complete the request because an unexpected error occurred." - } - } - } - }, - "/access/token/identity-provider/usage" : { - "get" : { - "tags" : [ "access" ], - "summary" : "Get identity provider usage", - "description" : "Provides a description of how the currently configured identity provider expects credentials to be passed to POST /access/token/identity-provider", - "operationId" : "getIdentityProviderUsageInstructions", - "consumes" : [ "*/*" ], - "produces" : [ "text/plain" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid. The NiFi Registry may not be configured to support login with customized credentials." - }, - "500" : { - "description" : "NiFi Registry was unable to complete the request because an unexpected error occurred." - } - } - } - }, - "/access/token/kerberos" : { - "post" : { - "tags" : [ "access" ], - "summary" : "Create token using kerberos", - "description" : "Creates a token for accessing the REST API via Kerberos Service Tickets or SPNEGO Tokens (which includes Kerberos Service Tickets). The token returned is formatted as a JSON Web Token (JWT). The token is base64 encoded and comprised of three parts. The header, the body, and the signature. The expiration of the token is a contained within the body. The token can be used in the Authorization header in the format 'Authorization: Bearer '.", - "operationId" : "createAccessTokenUsingKerberosTicket", - "consumes" : [ "*/*" ], - "produces" : [ "text/plain" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid. The NiFi Registry may not be configured to support login Kerberos credentials." - }, - "500" : { - "description" : "NiFi Registry was unable to complete the request because an unexpected error occurred." - } - } - } - }, - "/access/token/login" : { - "post" : { - "tags" : [ "access" ], - "summary" : "Create token using basic auth", - "description" : "Creates a token for accessing the REST API via username/password. The user credentials must be passed in standard HTTP Basic Auth format. That is: 'Authorization: Basic ', where is the base64 encoded value of ':'. The token returned is formatted as a JSON Web Token (JWT). The token is base64 encoded and comprised of three parts. The header, the body, and the signature. The expiration of the token is a contained within the body. The token can be used in the Authorization header in the format 'Authorization: Bearer '.", - "operationId" : "createAccessTokenUsingBasicAuthCredentials", - "consumes" : [ "*/*" ], - "produces" : [ "text/plain" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid. The NiFi Registry may not be configured to support login with username/password." - }, - "500" : { - "description" : "NiFi Registry was unable to complete the request because an unexpected error occurred." - } - }, - "security" : [ { - "BasicAuth" : [ ] - } ] - } - }, - "/buckets" : { - "get" : { - "tags" : [ "buckets" ], - "summary" : "Get all buckets", - "description" : "The returned list will include only buckets for which the user is authorized.If the user is not authorized for any buckets, this returns an empty list.", - "operationId" : "getBuckets", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/Bucket" - } - } - }, - "401" : { - "description" : "Client could not be authenticated." - } - }, - "security" : [ { - "Authorization" : [ ] - } ] - }, - "post" : { - "tags" : [ "buckets" ], - "summary" : "Create bucket", - "description" : "", - "operationId" : "createBucket", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The bucket to create", - "required" : true, - "schema" : { - "$ref" : "#/definitions/Bucket" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/Bucket" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets", - "action" : "write" - } - } - }, - "/buckets/fields" : { - "get" : { - "tags" : [ "buckets" ], - "summary" : "Get bucket fields", - "description" : "Retrieves bucket field names for searching or sorting on buckets.", - "operationId" : "getAvailableBucketFields", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/Fields" - } - } - }, - "security" : [ { - "Authorization" : [ ] - } ] - } - }, - "/buckets/{bucketId}" : { - "get" : { - "tags" : [ "buckets" ], - "summary" : "Get bucket", - "description" : "Gets the bucket with the given id.", - "operationId" : "getBucket", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketId", - "in" : "path", - "description" : "The bucket identifier", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/Bucket" - } - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - }, - "put" : { - "tags" : [ "buckets" ], - "summary" : "Update bucket", - "description" : "Updates the bucket with the given id.", - "operationId" : "updateBucket", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketId", - "in" : "path", - "description" : "The bucket identifier", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The updated bucket", - "required" : true, - "schema" : { - "$ref" : "#/definitions/Bucket" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/Bucket" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "write" - } - }, - "delete" : { - "tags" : [ "buckets" ], - "summary" : "Delete bucket", - "description" : "Deletes the bucket with the given id, along with all objects stored in the bucket", - "operationId" : "deleteBucket", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The version is used to verify the client is working with the latest version of the entity.", - "required" : true, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "bucketId", - "in" : "path", - "description" : "The bucket identifier", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/Bucket" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "delete" - } - } - }, - "/buckets/{bucketId}/bundles" : { - "get" : { - "tags" : [ "bucket bundles" ], - "summary" : "Get extension bundles by bucket", - "description" : "\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getExtensionBundles", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketId", - "in" : "path", - "description" : "The bucket identifier", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/ExtensionBundle" - } - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/buckets/{bucketId}/bundles/{bundleType}" : { - "post" : { - "tags" : [ "bucket bundles" ], - "summary" : "Create extension bundle version", - "description" : "Creates a version of an extension bundle by uploading a binary artifact. If an extension bundle already exists in the given bucket with the same group id and artifact id as that of the bundle being uploaded, then it will be added as a new version to the existing bundle. If an extension bundle does not already exist in the given bucket with the same group id and artifact id, then a new extension bundle will be created and this version will be added to the new bundle. Client's may optionally supply a SHA-256 in hex format through the multi-part form field 'sha256'. If supplied, then this value will be compared against the SHA-256 computed by the server, and the bundle will be rejected if the values do not match. If not supplied, the bundle will be accepted, but will be marked to indicate that the client did not supply a SHA-256 during creation. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "createExtensionBundleVersion", - "consumes" : [ "multipart/form-data" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketId", - "in" : "path", - "description" : "The bucket identifier", - "required" : true, - "type" : "string" - }, { - "name" : "bundleType", - "in" : "path", - "description" : "The type of the bundle", - "required" : true, - "type" : "string", - "enum" : [ "nifi-nar", "minifi-cpp" ] - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/BundleVersion" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "write" - } - } - }, - "/buckets/{bucketId}/flows" : { - "get" : { - "tags" : [ "bucket flows" ], - "summary" : "Get bucket flows", - "description" : "Retrieves all flows in the given bucket.", - "operationId" : "getFlows", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketId", - "in" : "path", - "description" : "The bucket identifier", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/VersionedFlow" - } - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - }, - "post" : { - "tags" : [ "bucket flows" ], - "summary" : "Create flow", - "description" : "Creates a flow in the given bucket. The flow id is created by the server and populated in the returned entity.", - "operationId" : "createFlow", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketId", - "in" : "path", - "description" : "The bucket identifier", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The details of the flow to create.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/VersionedFlow" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlow" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "write" - } - } - }, - "/buckets/{bucketId}/flows/{flowId}" : { - "get" : { - "tags" : [ "bucket flows" ], - "summary" : "Get bucket flow", - "description" : "Retrieves the flow with the given id in the given bucket.", - "operationId" : "getFlow", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketId", - "in" : "path", - "description" : "The bucket identifier", - "required" : true, - "type" : "string" - }, { - "name" : "flowId", - "in" : "path", - "description" : "The flow identifier", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlow" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - }, - "put" : { - "tags" : [ "bucket flows" ], - "summary" : "Update bucket flow", - "description" : "Updates the flow with the given id in the given bucket.", - "operationId" : "updateFlow", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketId", - "in" : "path", - "description" : "The bucket identifier", - "required" : true, - "type" : "string" - }, { - "name" : "flowId", - "in" : "path", - "description" : "The flow identifier", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The updated flow", - "required" : true, - "schema" : { - "$ref" : "#/definitions/VersionedFlow" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlow" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "write" - } - }, - "delete" : { - "tags" : [ "bucket flows" ], - "summary" : "Delete bucket flow", - "description" : "Deletes a flow, including all saved versions of that flow.", - "operationId" : "deleteFlow", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The version is used to verify the client is working with the latest version of the entity.", - "required" : true, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "bucketId", - "in" : "path", - "description" : "The bucket identifier", - "required" : true, - "type" : "string" - }, { - "name" : "flowId", - "in" : "path", - "description" : "The flow identifier", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlow" - } - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "delete" - } - } - }, - "/buckets/{bucketId}/flows/{flowId}/diff/{versionA}/{versionB}" : { - "get" : { - "tags" : [ "bucket flows" ], - "summary" : "Get bucket flow diff", - "description" : "Computes the differences between two given versions of a flow.", - "operationId" : "getFlowDiff", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketId", - "in" : "path", - "description" : "The bucket identifier", - "required" : true, - "type" : "string" - }, { - "name" : "flowId", - "in" : "path", - "description" : "The flow identifier", - "required" : true, - "type" : "string" - }, { - "name" : "versionA", - "in" : "path", - "description" : "The first version number", - "required" : true, - "type" : "integer", - "pattern" : "\\d+", - "format" : "int32" - }, { - "name" : "versionB", - "in" : "path", - "description" : "The second version number", - "required" : true, - "type" : "integer", - "pattern" : "\\d+", - "format" : "int32" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlowDifference" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/buckets/{bucketId}/flows/{flowId}/versions" : { - "get" : { - "tags" : [ "bucket flows" ], - "summary" : "Get bucket flow versions", - "description" : "Gets summary information for all versions of a flow. Versions are ordered newest->oldest.", - "operationId" : "getFlowVersions", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketId", - "in" : "path", - "description" : "The bucket identifier", - "required" : true, - "type" : "string" - }, { - "name" : "flowId", - "in" : "path", - "description" : "The flow identifier", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/VersionedFlowSnapshotMetadata" - } - } - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - }, - "post" : { - "tags" : [ "bucket flows" ], - "summary" : "Create flow version", - "description" : "Creates the next version of a flow. The version number of the object being created must be the next available version integer. Flow versions are immutable after they are created.", - "operationId" : "createFlowVersion", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketId", - "in" : "path", - "description" : "The bucket identifier", - "required" : true, - "type" : "string" - }, { - "name" : "flowId", - "in" : "path", - "description" : "The flow identifier", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The new versioned flow snapshot.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/VersionedFlowSnapshot" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlowSnapshot" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "write" - } - } - }, - "/buckets/{bucketId}/flows/{flowId}/versions/import" : { - "post" : { - "tags" : [ "bucket flows" ], - "summary" : "Import flow version", - "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", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketId", - "in" : "path", - "description" : "The bucket identifier", - "required" : true, - "type" : "string" - }, { - "name" : "flowId", - "in" : "path", - "description" : "The flow identifier", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "file", - "required" : false, - "schema" : { - "$ref" : "#/definitions/VersionedFlowSnapshot" - } - }, { - "name" : "Comments", - "in" : "header", - "required" : false, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlowSnapshot" - } - }, - "201" : { - "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." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "write" - } - } - }, - "/buckets/{bucketId}/flows/{flowId}/versions/latest" : { - "get" : { - "tags" : [ "bucket flows" ], - "summary" : "Get latest bucket flow version content", - "description" : "Gets the latest version of a flow, including the metadata and content of the flow.", - "operationId" : "getLatestFlowVersion", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketId", - "in" : "path", - "description" : "The bucket identifier", - "required" : true, - "type" : "string" - }, { - "name" : "flowId", - "in" : "path", - "description" : "The flow identifier", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlowSnapshot" - } - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/buckets/{bucketId}/flows/{flowId}/versions/latest/metadata" : { - "get" : { - "tags" : [ "bucket flows" ], - "summary" : "Get latest bucket flow version metadata", - "description" : "Gets the metadata for the latest version of a flow.", - "operationId" : "getLatestFlowVersionMetadata", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketId", - "in" : "path", - "description" : "The bucket identifier", - "required" : true, - "type" : "string" - }, { - "name" : "flowId", - "in" : "path", - "description" : "The flow identifier", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlowSnapshotMetadata" - } - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/buckets/{bucketId}/flows/{flowId}/versions/{versionNumber}" : { - "get" : { - "tags" : [ "bucket flows" ], - "summary" : "Get bucket flow version", - "description" : "Gets the given version of a flow, including the metadata and content for the version.", - "operationId" : "getFlowVersion", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketId", - "in" : "path", - "description" : "The bucket identifier", - "required" : true, - "type" : "string" - }, { - "name" : "flowId", - "in" : "path", - "description" : "The flow identifier", - "required" : true, - "type" : "string" - }, { - "name" : "versionNumber", - "in" : "path", - "description" : "The version number", - "required" : true, - "type" : "integer", - "pattern" : "\\d+", - "format" : "int32" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlowSnapshot" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/buckets/{bucketId}/flows/{flowId}/versions/{versionNumber}/export" : { - "get" : { - "tags" : [ "bucket flows" ], - "summary" : "Exports specified bucket flow version content", - "description" : "Exports the specified version of a flow, including the metadata and content of the flow.", - "operationId" : "exportVersionedFlow", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketId", - "in" : "path", - "description" : "The bucket identifier", - "required" : true, - "type" : "string" - }, { - "name" : "flowId", - "in" : "path", - "description" : "The flow identifier", - "required" : true, - "type" : "string" - }, { - "name" : "versionNumber", - "in" : "path", - "description" : "The version number", - "required" : true, - "type" : "integer", - "pattern" : "\\d+", - "format" : "int32" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlowSnapshot" - } - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/bundles" : { - "get" : { - "tags" : [ "bundles" ], - "summary" : "Get all bundles", - "description" : "Gets the metadata for all bundles across all authorized buckets with optional filters applied. The returned results will include only items from buckets for which the user is authorized. If the user is not authorized to any buckets, an empty list will be returned. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getBundles", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketName", - "in" : "query", - "description" : "Optional bucket name to filter results. The value may be an exact match, or a wildcard, such as 'My Bucket%' to select all bundles where the bucket name starts with 'My Bucket'.", - "required" : false, - "type" : "string" - }, { - "name" : "groupId", - "in" : "query", - "description" : "Optional groupId to filter results. The value may be an exact match, or a wildcard, such as 'com.%' to select all bundles where the groupId starts with 'com.'.", - "required" : false, - "type" : "string" - }, { - "name" : "artifactId", - "in" : "query", - "description" : "Optional artifactId to filter results. The value may be an exact match, or a wildcard, such as 'nifi-%' to select all bundles where the artifactId starts with 'nifi-'.", - "required" : false, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/ExtensionBundle" - } - } - }, - "401" : { - "description" : "Client could not be authenticated." - } - }, - "security" : [ { - "Authorization" : [ ] - } ] - } - }, - "/bundles/versions" : { - "get" : { - "tags" : [ "bundles" ], - "summary" : "Get all bundle versions", - "description" : "Gets the metadata about extension bundle versions across all authorized buckets with optional filters applied. If the user is not authorized to any buckets, an empty list will be returned. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getBundleVersions", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "groupId", - "in" : "query", - "description" : "Optional groupId to filter results. The value may be an exact match, or a wildcard, such as 'com.%' to select all bundle versions where the groupId starts with 'com.'.", - "required" : false, - "type" : "string" - }, { - "name" : "artifactId", - "in" : "query", - "description" : "Optional artifactId to filter results. The value may be an exact match, or a wildcard, such as 'nifi-%' to select all bundle versions where the artifactId starts with 'nifi-'.", - "required" : false, - "type" : "string" - }, { - "name" : "version", - "in" : "query", - "description" : "Optional version to filter results. The value maye be an exact match, or a wildcard, such as '1.0.%' to select all bundle versions where the version starts with '1.0.'.", - "required" : false, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/BundleVersionMetadata" - } - } - }, - "401" : { - "description" : "Client could not be authenticated." - } - }, - "security" : [ { - "Authorization" : [ ] - } ] - } - }, - "/bundles/{bundleId}" : { - "get" : { - "tags" : [ "bundles" ], - "summary" : "Get bundle", - "description" : "Gets the metadata about an extension bundle. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "globalGetExtensionBundle", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bundleId", - "in" : "path", - "description" : "The extension bundle identifier", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ExtensionBundle" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - }, - "delete" : { - "tags" : [ "bundles" ], - "summary" : "Delete bundle", - "description" : "Deletes the given extension bundle and all of it's versions. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "globalDeleteExtensionBundle", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bundleId", - "in" : "path", - "description" : "The extension bundle identifier", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ExtensionBundle" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "write" - } - } - }, - "/bundles/{bundleId}/versions" : { - "get" : { - "tags" : [ "bundles" ], - "summary" : "Get bundle versions", - "description" : "Gets the metadata for the versions of the given extension bundle. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "globalGetBundleVersions", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bundleId", - "in" : "path", - "description" : "The extension bundle identifier", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/BundleVersionMetadata" - } - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/bundles/{bundleId}/versions/{version}" : { - "get" : { - "tags" : [ "bundles" ], - "summary" : "Get bundle version", - "description" : "Gets the descriptor for the given version of the given extension bundle. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "globalGetBundleVersion", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bundleId", - "in" : "path", - "description" : "The extension bundle identifier", - "required" : true, - "type" : "string" - }, { - "name" : "version", - "in" : "path", - "description" : "The version of the bundle", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/BundleVersion" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - }, - "delete" : { - "tags" : [ "bundles" ], - "summary" : "Delete bundle version", - "description" : "Deletes the given extension bundle version and it's associated binary content. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "globalDeleteBundleVersion", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bundleId", - "in" : "path", - "description" : "The extension bundle identifier", - "required" : true, - "type" : "string" - }, { - "name" : "version", - "in" : "path", - "description" : "The version of the bundle", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/BundleVersion" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "write" - } - } - }, - "/bundles/{bundleId}/versions/{version}/content" : { - "get" : { - "tags" : [ "bundles" ], - "summary" : "Get bundle version content", - "description" : "Gets the binary content for the given version of the given extension bundle. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "globalGetBundleVersionContent", - "consumes" : [ "*/*" ], - "produces" : [ "application/octet-stream" ], - "parameters" : [ { - "name" : "bundleId", - "in" : "path", - "description" : "The extension bundle identifier", - "required" : true, - "type" : "string" - }, { - "name" : "version", - "in" : "path", - "description" : "The version of the bundle", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "type" : "string", - "format" : "byte" - } - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/bundles/{bundleId}/versions/{version}/extensions" : { - "get" : { - "tags" : [ "bundles" ], - "summary" : "Get bundle version extensions", - "description" : "Gets the metadata about the extensions in the given extension bundle version. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "globalGetBundleVersionExtensions", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bundleId", - "in" : "path", - "description" : "The extension bundle identifier", - "required" : true, - "type" : "string" - }, { - "name" : "version", - "in" : "path", - "description" : "The version of the bundle", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/ExtensionMetadata" - } - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/bundles/{bundleId}/versions/{version}/extensions/{name}" : { - "get" : { - "tags" : [ "bundles" ], - "summary" : "Get bundle version extension", - "description" : "Gets the metadata about the extension with the given name in the given extension bundle version. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "globalGetBundleVersionExtension", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bundleId", - "in" : "path", - "description" : "The extension bundle identifier", - "required" : true, - "type" : "string" - }, { - "name" : "version", - "in" : "path", - "description" : "The version of the bundle", - "required" : true, - "type" : "string" - }, { - "name" : "name", - "in" : "path", - "description" : "The fully qualified name of the extension", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/Extension" - } - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/bundles/{bundleId}/versions/{version}/extensions/{name}/docs" : { - "get" : { - "tags" : [ "bundles" ], - "summary" : "Get bundle version extension docs", - "description" : "Gets the documentation for the given extension in the given extension bundle version. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getBundleVersionExtensionDocs", - "consumes" : [ "*/*" ], - "produces" : [ "text/html" ], - "parameters" : [ { - "name" : "bundleId", - "in" : "path", - "description" : "The extension bundle identifier", - "required" : true, - "type" : "string" - }, { - "name" : "version", - "in" : "path", - "description" : "The version of the bundle", - "required" : true, - "type" : "string" - }, { - "name" : "name", - "in" : "path", - "description" : "The fully qualified name of the extension", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/bundles/{bundleId}/versions/{version}/extensions/{name}/docs/additional-details" : { - "get" : { - "tags" : [ "bundles" ], - "summary" : "Get bundle version extension docs details", - "description" : "Gets the additional details documentation for the given extension in the given extension bundle version. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getBundleVersionExtensionAdditionalDetailsDocs", - "consumes" : [ "*/*" ], - "produces" : [ "text/html" ], - "parameters" : [ { - "name" : "bundleId", - "in" : "path", - "description" : "The extension bundle identifier", - "required" : true, - "type" : "string" - }, { - "name" : "version", - "in" : "path", - "description" : "The version of the bundle", - "required" : true, - "type" : "string" - }, { - "name" : "name", - "in" : "path", - "description" : "The fully qualified name of the extension", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/config" : { - "get" : { - "tags" : [ "config" ], - "summary" : "Get configration", - "description" : "Gets the NiFi Registry configurations.", - "operationId" : "getConfiguration", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/RegistryConfiguration" - } - }, - "401" : { - "description" : "Client could not be authenticated." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/policies,/tenants", - "action" : "read" - } - } - }, - "/extension-repository" : { - "get" : { - "tags" : [ "extension repository" ], - "summary" : "Get extension repo buckets", - "description" : "Gets the names of the buckets the current user is authorized for in order to browse the repo by bucket. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getExtensionRepoBuckets", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/ExtensionRepoBucket" - } - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ] - } - }, - "/extension-repository/{bucketName}" : { - "get" : { - "tags" : [ "extension repository" ], - "summary" : "Get extension repo groups", - "description" : "Gets the groups in the extension repository in the given bucket. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getExtensionRepoGroups", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketName", - "in" : "path", - "description" : "The bucket name", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/ExtensionRepoGroup" - } - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/extension-repository/{bucketName}/{groupId}" : { - "get" : { - "tags" : [ "extension repository" ], - "summary" : "Get extension repo artifacts", - "description" : "Gets the artifacts in the extension repository in the given bucket and group. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getExtensionRepoArtifacts", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketName", - "in" : "path", - "description" : "The bucket name", - "required" : true, - "type" : "string" - }, { - "name" : "groupId", - "in" : "path", - "description" : "The group id", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/ExtensionRepoArtifact" - } - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/extension-repository/{bucketName}/{groupId}/{artifactId}" : { - "get" : { - "tags" : [ "extension repository" ], - "summary" : "Get extension repo versions", - "description" : "Gets the versions in the extension repository for the given bucket, group, and artifact. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getExtensionRepoVersions", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketName", - "in" : "path", - "description" : "The bucket name", - "required" : true, - "type" : "string" - }, { - "name" : "groupId", - "in" : "path", - "description" : "The group identifier", - "required" : true, - "type" : "string" - }, { - "name" : "artifactId", - "in" : "path", - "description" : "The artifact identifier", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/ExtensionRepoVersionSummary" - } - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/extension-repository/{bucketName}/{groupId}/{artifactId}/{version}" : { - "get" : { - "tags" : [ "extension repository" ], - "summary" : "Get extension repo version", - "description" : "Gets information about the version in the given bucket, group, and artifact. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getExtensionRepoVersion", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketName", - "in" : "path", - "description" : "The bucket name", - "required" : true, - "type" : "string" - }, { - "name" : "groupId", - "in" : "path", - "description" : "The group identifier", - "required" : true, - "type" : "string" - }, { - "name" : "artifactId", - "in" : "path", - "description" : "The artifact identifier", - "required" : true, - "type" : "string" - }, { - "name" : "version", - "in" : "path", - "description" : "The version", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ExtensionRepoVersion" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/extension-repository/{bucketName}/{groupId}/{artifactId}/{version}/content" : { - "get" : { - "tags" : [ "extension repository" ], - "summary" : "Get extension repo version content", - "description" : "Gets the binary content of the bundle with the given bucket, group, artifact, and version. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getExtensionRepoVersionContent", - "consumes" : [ "*/*" ], - "produces" : [ "application/octet-stream" ], - "parameters" : [ { - "name" : "bucketName", - "in" : "path", - "description" : "The bucket name", - "required" : true, - "type" : "string" - }, { - "name" : "groupId", - "in" : "path", - "description" : "The group identifier", - "required" : true, - "type" : "string" - }, { - "name" : "artifactId", - "in" : "path", - "description" : "The artifact identifier", - "required" : true, - "type" : "string" - }, { - "name" : "version", - "in" : "path", - "description" : "The version", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "type" : "string", - "format" : "byte" - } - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/extension-repository/{bucketName}/{groupId}/{artifactId}/{version}/extensions" : { - "get" : { - "tags" : [ "extension repository" ], - "summary" : "Get extension repo extensions", - "description" : "Gets information about the extensions in the given bucket, group, artifact, and version. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getExtensionRepoVersionExtensions", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketName", - "in" : "path", - "description" : "The bucket name", - "required" : true, - "type" : "string" - }, { - "name" : "groupId", - "in" : "path", - "description" : "The group identifier", - "required" : true, - "type" : "string" - }, { - "name" : "artifactId", - "in" : "path", - "description" : "The artifact identifier", - "required" : true, - "type" : "string" - }, { - "name" : "version", - "in" : "path", - "description" : "The version", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/ExtensionMetadata" - } - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/extension-repository/{bucketName}/{groupId}/{artifactId}/{version}/extensions/{name}" : { - "get" : { - "tags" : [ "extension repository" ], - "summary" : "Get extension repo extension", - "description" : "Gets information about the extension with the given name in the given bucket, group, artifact, and version. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getExtensionRepoVersionExtension", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketName", - "in" : "path", - "description" : "The bucket name", - "required" : true, - "type" : "string" - }, { - "name" : "groupId", - "in" : "path", - "description" : "The group identifier", - "required" : true, - "type" : "string" - }, { - "name" : "artifactId", - "in" : "path", - "description" : "The artifact identifier", - "required" : true, - "type" : "string" - }, { - "name" : "version", - "in" : "path", - "description" : "The version", - "required" : true, - "type" : "string" - }, { - "name" : "name", - "in" : "path", - "description" : "The fully qualified name of the extension", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/Extension" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/extension-repository/{bucketName}/{groupId}/{artifactId}/{version}/extensions/{name}/docs" : { - "get" : { - "tags" : [ "extension repository" ], - "summary" : "Get extension repo extension docs", - "description" : "Gets the documentation for the extension with the given name in the given bucket, group, artifact, and version. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getExtensionRepoVersionExtensionDocs", - "consumes" : [ "*/*" ], - "produces" : [ "text/html" ], - "parameters" : [ { - "name" : "bucketName", - "in" : "path", - "description" : "The bucket name", - "required" : true, - "type" : "string" - }, { - "name" : "groupId", - "in" : "path", - "description" : "The group identifier", - "required" : true, - "type" : "string" - }, { - "name" : "artifactId", - "in" : "path", - "description" : "The artifact identifier", - "required" : true, - "type" : "string" - }, { - "name" : "version", - "in" : "path", - "description" : "The version", - "required" : true, - "type" : "string" - }, { - "name" : "name", - "in" : "path", - "description" : "The fully qualified name of the extension", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/extension-repository/{bucketName}/{groupId}/{artifactId}/{version}/extensions/{name}/docs/additional-details" : { - "get" : { - "tags" : [ "extension repository" ], - "summary" : "Get extension repo extension details", - "description" : "Gets the additional details documentation for the extension with the given name in the given bucket, group, artifact, and version. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getExtensionRepoVersionExtensionAdditionalDetailsDocs", - "consumes" : [ "*/*" ], - "produces" : [ "text/html" ], - "parameters" : [ { - "name" : "bucketName", - "in" : "path", - "description" : "The bucket name", - "required" : true, - "type" : "string" - }, { - "name" : "groupId", - "in" : "path", - "description" : "The group identifier", - "required" : true, - "type" : "string" - }, { - "name" : "artifactId", - "in" : "path", - "description" : "The artifact identifier", - "required" : true, - "type" : "string" - }, { - "name" : "version", - "in" : "path", - "description" : "The version", - "required" : true, - "type" : "string" - }, { - "name" : "name", - "in" : "path", - "description" : "The fully qualified name of the extension", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/extension-repository/{bucketName}/{groupId}/{artifactId}/{version}/sha256" : { - "get" : { - "tags" : [ "extension repository" ], - "summary" : "Get extension repo version checksum", - "description" : "Gets the hex representation of the SHA-256 digest for the binary content of the bundle with the given bucket, group, artifact, and version.\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getExtensionRepoVersionSha256", - "consumes" : [ "*/*" ], - "produces" : [ "text/plain" ], - "parameters" : [ { - "name" : "bucketName", - "in" : "path", - "description" : "The bucket name", - "required" : true, - "type" : "string" - }, { - "name" : "groupId", - "in" : "path", - "description" : "The group identifier", - "required" : true, - "type" : "string" - }, { - "name" : "artifactId", - "in" : "path", - "description" : "The artifact identifier", - "required" : true, - "type" : "string" - }, { - "name" : "version", - "in" : "path", - "description" : "The version", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/extension-repository/{groupId}/{artifactId}/{version}/sha256" : { - "get" : { - "tags" : [ "extension repository" ], - "summary" : "Get global extension repo version checksum", - "description" : "Gets the hex representation of the SHA-256 digest for the binary content with the given bucket, group, artifact, and version. Since the same group-artifact-version can exist in multiple buckets, this will return the checksum of the first one returned. This will be consistent since the checksum must be the same when existing in multiple buckets. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getGlobalExtensionRepoVersionSha256", - "consumes" : [ "*/*" ], - "produces" : [ "text/plain" ], - "parameters" : [ { - "name" : "groupId", - "in" : "path", - "description" : "The group identifier", - "required" : true, - "type" : "string" - }, { - "name" : "artifactId", - "in" : "path", - "description" : "The artifact identifier", - "required" : true, - "type" : "string" - }, { - "name" : "version", - "in" : "path", - "description" : "The version", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ] - } - }, - "/extensions" : { - "get" : { - "tags" : [ "extensions" ], - "summary" : "Get all extensions", - "description" : "Gets the metadata for all extensions that match the filter params and are part of bundles located in buckets the current user is authorized for. If the user is not authorized to any buckets, an empty result set will be returned.\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getExtensions", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bundleType", - "in" : "query", - "description" : "The type of bundles to return", - "required" : false, - "type" : "string", - "enum" : [ "nifi-nar", "minifi-cpp" ] - }, { - "name" : "extensionType", - "in" : "query", - "description" : "The type of extensions to return", - "required" : false, - "type" : "string", - "enum" : [ "PROCESSOR", "CONTROLLER_SERVICE", "REPORTING_TASK" ] - }, { - "name" : "tag", - "in" : "query", - "description" : "The tags to filter on, will be used in an OR statement", - "required" : false, - "type" : "array", - "items" : { - "type" : "string" - }, - "collectionFormat" : "multi" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ExtensionMetadataContainer" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ] - } - }, - "/extensions/provided-service-api" : { - "get" : { - "tags" : [ "extensions" ], - "summary" : "Get extensions providing service API", - "description" : "Gets the metadata for extensions that provide the specified API and are part of bundles located in buckets the current user is authorized for. If the user is not authorized to any buckets, an empty result set will be returned.\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getExtensionsProvidingServiceAPI", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "className", - "in" : "query", - "description" : "The name of the service API class", - "required" : true, - "type" : "string" - }, { - "name" : "groupId", - "in" : "query", - "description" : "The groupId of the bundle containing the service API class", - "required" : true, - "type" : "string" - }, { - "name" : "artifactId", - "in" : "query", - "description" : "The artifactId of the bundle containing the service API class", - "required" : true, - "type" : "string" - }, { - "name" : "version", - "in" : "query", - "description" : "The version of the bundle containing the service API class", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ExtensionMetadataContainer" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ] - } - }, - "/extensions/tags" : { - "get" : { - "tags" : [ "extensions" ], - "summary" : "Get extension tags", - "description" : "Gets all the extension tags known to this NiFi Registry instance, along with the number of extensions that have the given tag.\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getTags", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/TagCount" - } - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ] - } - }, - "/flows/fields" : { - "get" : { - "tags" : [ "flows" ], - "summary" : "Get flow fields", - "description" : "Retrieves the flow field names that can be used for searching or sorting on flows.", - "operationId" : "getAvailableFlowFields", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/Fields" - } - } - }, - "security" : [ { - "Authorization" : [ ] - } ] - } - }, - "/flows/{flowId}" : { - "get" : { - "tags" : [ "flows" ], - "summary" : "Get flow", - "description" : "Gets a flow by id.", - "operationId" : "globalGetFlow", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "flowId", - "in" : "path", - "description" : "The flow identifier", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlow" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/flows/{flowId}/versions" : { - "get" : { - "tags" : [ "flows" ], - "summary" : "Get flow versions", - "description" : "Gets summary information for all versions of a given flow. Versions are ordered newest->oldest.", - "operationId" : "globalGetFlowVersions", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "flowId", - "in" : "path", - "description" : "The flow identifier", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/VersionedFlowSnapshotMetadata" - } - } - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/flows/{flowId}/versions/latest" : { - "get" : { - "tags" : [ "flows" ], - "summary" : "Get latest flow version", - "description" : "Gets the latest version of a flow, including metadata and flow content.", - "operationId" : "globalGetLatestFlowVersion", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "flowId", - "in" : "path", - "description" : "The flow identifier", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlowSnapshot" - } - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/flows/{flowId}/versions/latest/metadata" : { - "get" : { - "tags" : [ "flows" ], - "summary" : "Get latest flow version metadata", - "description" : "Gets the metadata for the latest version of a flow.", - "operationId" : "globalGetLatestFlowVersionMetadata", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "flowId", - "in" : "path", - "description" : "The flow identifier", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlowSnapshotMetadata" - } - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/flows/{flowId}/versions/{versionNumber}" : { - "get" : { - "tags" : [ "flows" ], - "summary" : "Get flow version", - "description" : "Gets the given version of a flow, including metadata and flow content.", - "operationId" : "globalGetFlowVersion", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "flowId", - "in" : "path", - "description" : "The flow identifier", - "required" : true, - "type" : "string" - }, { - "name" : "versionNumber", - "in" : "path", - "description" : "The version number", - "required" : true, - "type" : "integer", - "pattern" : "\\d+", - "format" : "int32" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlowSnapshot" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/items" : { - "get" : { - "tags" : [ "items" ], - "summary" : "Get all items", - "description" : "Get items across all buckets. The returned items will include only items from buckets for which the user is authorized. If the user is not authorized to any buckets, an empty list will be returned.", - "operationId" : "getItems", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/BucketItem" - } - } - }, - "401" : { - "description" : "Client could not be authenticated." - } - }, - "security" : [ { - "Authorization" : [ ] - } ] - } - }, - "/items/fields" : { - "get" : { - "tags" : [ "items" ], - "summary" : "Get item fields", - "description" : "Retrieves the item field names for searching or sorting on bucket items.", - "operationId" : "getAvailableBucketItemFields", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/Fields" - } - } - }, - "security" : [ { - "Authorization" : [ ] - } ] - } - }, - "/items/{bucketId}" : { - "get" : { - "tags" : [ "items" ], - "summary" : "Get bucket items", - "description" : "Gets the items located in the given bucket.", - "operationId" : "getItemsInBucket", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketId", - "in" : "path", - "description" : "The bucket identifier", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/BucketItem" - } - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/policies" : { - "get" : { - "tags" : [ "policies" ], - "summary" : "Get all access policies", - "description" : "", - "operationId" : "getAccessPolicies", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/AccessPolicy" - } - } - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/policies", - "action" : "read" - } - }, - "post" : { - "tags" : [ "policies" ], - "summary" : "Create access policy", - "description" : "", - "operationId" : "createAccessPolicy", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The access policy configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/AccessPolicy" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/AccessPolicy" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid. The NiFi Registry might not be configured to use a ConfigurableAccessPolicyProvider." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/policies", - "action" : "write" - } - } - }, - "/policies/resources" : { - "get" : { - "tags" : [ "policies" ], - "summary" : "Get available resources", - "description" : "Gets the available resources that support access/authorization policies", - "operationId" : "getResources", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/Resource" - } - } - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/policies", - "action" : "read" - } - } - }, - "/policies/{action}/{resource}" : { - "get" : { - "tags" : [ "policies" ], - "summary" : "Get access policy for resource", - "description" : "Gets an access policy for the specified action and resource", - "operationId" : "getAccessPolicyForResource", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "action", - "in" : "path", - "description" : "The request action.", - "required" : true, - "type" : "string", - "enum" : [ "read", "write", "delete" ] - }, { - "name" : "resource", - "in" : "path", - "description" : "The resource of the policy.", - "required" : true, - "type" : "string", - "pattern" : ".+" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/AccessPolicy" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/policies", - "action" : "read" - } - } - }, - "/policies/{id}" : { - "get" : { - "tags" : [ "policies" ], - "summary" : "Get access policy", - "description" : "", - "operationId" : "getAccessPolicy", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The access policy id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/AccessPolicy" - } - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/policies", - "action" : "read" - } - }, - "put" : { - "tags" : [ "policies" ], - "summary" : "Update access policy", - "description" : "", - "operationId" : "updateAccessPolicy", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The access policy id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The access policy configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/AccessPolicy" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/AccessPolicy" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid. The NiFi Registry might not be configured to use a ConfigurableAccessPolicyProvider." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/policies", - "action" : "write" - } - }, - "delete" : { - "tags" : [ "policies" ], - "summary" : "Delete access policy", - "description" : "", - "operationId" : "removeAccessPolicy", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The version is used to verify the client is working with the latest version of the entity.", - "required" : true, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The access policy id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/AccessPolicy" - } - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid. The NiFi Registry might not be configured to use a ConfigurableAccessPolicyProvider." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/policies", - "action" : "delete" - } - } - }, - "/tenants/user-groups" : { - "get" : { - "tags" : [ "tenants" ], - "summary" : "Get user groups", - "description" : "\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getUserGroups", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/UserGroup" - } - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/tenants", - "action" : "read" - } - }, - "post" : { - "tags" : [ "tenants" ], - "summary" : "Create user group", - "description" : "\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "createUserGroup", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The user group configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/UserGroup" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/UserGroup" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/tenants", - "action" : "write" - } - } - }, - "/tenants/user-groups/{id}" : { - "get" : { - "tags" : [ "tenants" ], - "summary" : "Get user group", - "description" : "\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getUserGroup", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The user group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/UserGroup" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/tenants", - "action" : "read" - } - }, - "put" : { - "tags" : [ "tenants" ], - "summary" : "Update user group", - "description" : "\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "updateUserGroup", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The user group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The user group configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/UserGroup" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/UserGroup" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/tenants", - "action" : "write" - } - }, - "delete" : { - "tags" : [ "tenants" ], - "summary" : "Delete user group", - "description" : "\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "removeUserGroup", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The version is used to verify the client is working with the latest version of the entity.", - "required" : true, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The user group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/UserGroup" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/tenants", - "action" : "delete" - } - } - }, - "/tenants/users" : { - "get" : { - "tags" : [ "tenants" ], - "summary" : "Get all users", - "description" : "\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getUsers", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/User" - } - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/tenants", - "action" : "read" - } - }, - "post" : { - "tags" : [ "tenants" ], - "summary" : "Create user", - "description" : "\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "createUser", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The user configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/User" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/User" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/tenants", - "action" : "write" - } - } - }, - "/tenants/users/{id}" : { - "get" : { - "tags" : [ "tenants" ], - "summary" : "Get user", - "description" : "\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getUser", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The user id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/User" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/tenants", - "action" : "read" - } - }, - "put" : { - "tags" : [ "tenants" ], - "summary" : "Update user", - "description" : "\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "updateUser", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The user id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The user configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/User" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/User" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/tenants", - "action" : "write" - } - }, - "delete" : { - "tags" : [ "tenants" ], - "summary" : "Delete user", - "description" : "\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "removeUser", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The version is used to verify the client is working with the latest version of the entity.", - "required" : true, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The user id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/User" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/tenants", - "action" : "delete" - } - } - } - }, - "securityDefinitions" : { - "Authorization" : { - "description" : "NiFi Registry Auth Token (JWT)", - "type" : "apiKey", - "name" : "Authorization", - "in" : "header" - }, - "BasicAuth" : { - "description" : "HTTP Basic Auth", - "type" : "basic" - } - }, - "definitions" : { - "AccessPolicy" : { - "type" : "object", - "required" : [ "action", "resource" ], - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The id of the policy. Set by server at creation time.", - "readOnly" : true - }, - "resource" : { - "type" : "string", - "description" : "The resource for this access policy." - }, - "action" : { - "type" : "string", - "description" : "The action associated with this access policy.", - "enum" : [ "read", "write", "delete" ] - }, - "configurable" : { - "type" : "boolean", - "description" : "Indicates if this access policy is configurable, based on which Authorizer has been configured to manage it.", - "readOnly" : true - }, - "revision" : { - "description" : "The revision of this entity used for optimistic-locking during updates.", - "readOnly" : true, - "$ref" : "#/definitions/RevisionInfo" - }, - "users" : { - "type" : "array", - "description" : "The set of user IDs associated with this access policy.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/Tenant" - } - }, - "userGroups" : { - "type" : "array", - "description" : "The set of user group IDs associated with this access policy.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/Tenant" - } - } - } - }, - "AccessPolicySummary" : { - "type" : "object", - "required" : [ "action", "resource" ], - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The id of the policy. Set by server at creation time.", - "readOnly" : true - }, - "resource" : { - "type" : "string", - "description" : "The resource for this access policy." - }, - "action" : { - "type" : "string", - "description" : "The action associated with this access policy.", - "enum" : [ "read", "write", "delete" ] - }, - "configurable" : { - "type" : "boolean", - "description" : "Indicates if this access policy is configurable, based on which Authorizer has been configured to manage it.", - "readOnly" : true - }, - "revision" : { - "description" : "The revision of this entity used for optimistic-locking during updates.", - "readOnly" : true, - "$ref" : "#/definitions/RevisionInfo" - } - } - }, - "AllowableValue" : { - "type" : "object", - "properties" : { - "value" : { - "type" : "string", - "description" : "The value of the allowable value" - }, - "displayName" : { - "type" : "string", - "description" : "The display name of the allowable value" - }, - "description" : { - "type" : "string", - "description" : "The description of the allowable value" - } - } - }, - "Attribute" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The name of the attribute" - }, - "description" : { - "type" : "string", - "description" : "The description of the attribute" - } - } - }, - "BatchSize" : { - "type" : "object", - "properties" : { - "count" : { - "type" : "integer", - "format" : "int32", - "description" : "Preferred number of flow files to include in a transaction." - }, - "size" : { - "type" : "string", - "description" : "Preferred number of bytes to include in a transaction." - }, - "duration" : { - "type" : "string", - "description" : "Preferred amount of time that a transaction should span." - } - } - }, - "Bucket" : { - "type" : "object", - "required" : [ "name" ], - "properties" : { - "link" : { - "description" : "An WebLink to this entity.", - "readOnly" : true, - "$ref" : "#/definitions/JaxbLink" - }, - "identifier" : { - "type" : "string", - "description" : "An ID to uniquely identify this object.", - "readOnly" : true - }, - "name" : { - "type" : "string", - "description" : "The name of the bucket." - }, - "createdTimestamp" : { - "type" : "integer", - "format" : "int64", - "description" : "The timestamp of when the bucket was first created. This is set by the server at creation time.", - "readOnly" : true, - "minimum" : 1 - }, - "description" : { - "type" : "string", - "description" : "A description of the bucket." - }, - "allowBundleRedeploy" : { - "type" : "boolean", - "description" : "Indicates if this bucket allows the same version of an extension bundle to be redeployed and thus overwrite the existing artifact. By default this is false." - }, - "allowPublicRead" : { - "type" : "boolean", - "description" : "Indicates if this bucket allows read access to unauthenticated anonymous users" - }, - "permissions" : { - "description" : "The access that the current user has to this bucket.", - "readOnly" : true, - "$ref" : "#/definitions/Permissions" - }, - "revision" : { - "description" : "The revision of this entity used for optimistic-locking during updates.", - "readOnly" : true, - "$ref" : "#/definitions/RevisionInfo" - } - } - }, - "BucketItem" : { - "type" : "object", - "required" : [ "bucketIdentifier", "name", "type" ], - "properties" : { - "link" : { - "description" : "An WebLink to this entity.", - "readOnly" : true, - "$ref" : "#/definitions/JaxbLink" - }, - "identifier" : { - "type" : "string", - "description" : "An ID to uniquely identify this object.", - "readOnly" : true - }, - "name" : { - "type" : "string", - "description" : "The name of the item." - }, - "description" : { - "type" : "string", - "description" : "A description of the item." - }, - "bucketIdentifier" : { - "type" : "string", - "description" : "The identifier of the bucket this items belongs to. This cannot be changed after the item is created." - }, - "bucketName" : { - "type" : "string", - "description" : "The name of the bucket this items belongs to.", - "readOnly" : true - }, - "createdTimestamp" : { - "type" : "integer", - "format" : "int64", - "description" : "The timestamp of when the item was created, as milliseconds since epoch.", - "readOnly" : true, - "minimum" : 1 - }, - "modifiedTimestamp" : { - "type" : "integer", - "format" : "int64", - "description" : "The timestamp of when the item was last modified, as milliseconds since epoch.", - "readOnly" : true, - "minimum" : 1 - }, - "type" : { - "type" : "string", - "description" : "The type of item.", - "enum" : [ "Flow", "Bundle" ] - }, - "permissions" : { - "description" : "The access that the current user has to the bucket containing this item.", - "readOnly" : true, - "$ref" : "#/definitions/Permissions" - } - } - }, - "BuildInfo" : { - "type" : "object", - "properties" : { - "buildTool" : { - "type" : "string", - "description" : "The tool used to build the version of the bundle" - }, - "buildFlags" : { - "type" : "string", - "description" : "The flags used to build the version of the bundle" - }, - "buildBranch" : { - "type" : "string", - "description" : "The branch used to build the version of the bundle" - }, - "buildTag" : { - "type" : "string", - "description" : "The tag used to build the version of the bundle" - }, - "buildRevision" : { - "type" : "string", - "description" : "The revision used to build the version of the bundle" - }, - "built" : { - "type" : "integer", - "format" : "int64", - "description" : "The timestamp the version of the bundle was built" - }, - "builtBy" : { - "type" : "string", - "description" : "The identity of the user that performed the build" - } - } - }, - "Bundle" : { - "type" : "object", - "properties" : { - "group" : { - "type" : "string", - "description" : "The group of the bundle" - }, - "artifact" : { - "type" : "string", - "description" : "The artifact of the bundle" - }, - "version" : { - "type" : "string", - "description" : "The version of the bundle" - } - } - }, - "BundleInfo" : { - "type" : "object", - "properties" : { - "bucketId" : { - "type" : "string", - "description" : "The id of the bucket where the bundle is located" - }, - "bucketName" : { - "type" : "string", - "description" : "The name of the bucket where the bundle is located" - }, - "bundleId" : { - "type" : "string", - "description" : "The id of the bundle" - }, - "bundleType" : { - "type" : "string", - "description" : "The type of bundle (i.e. a NiFi NAR vs MiNiFi CPP)", - "enum" : [ "NIFI_NAR", "MINIFI_CPP" ] - }, - "groupId" : { - "type" : "string", - "description" : "The group id of the bundle" - }, - "artifactId" : { - "type" : "string", - "description" : "The artifact id of the bundle" - }, - "version" : { - "type" : "string", - "description" : "The version of the bundle" - }, - "systemApiVersion" : { - "type" : "string", - "description" : "The version of the system API the bundle was built against" - } - } - }, - "BundleVersion" : { - "type" : "object", - "required" : [ "versionMetadata" ], - "properties" : { - "link" : { - "description" : "An WebLink to this entity.", - "readOnly" : true, - "$ref" : "#/definitions/JaxbLink" - }, - "versionMetadata" : { - "description" : "The metadata about this version of the extension bundle", - "$ref" : "#/definitions/BundleVersionMetadata" - }, - "dependencies" : { - "type" : "array", - "description" : "The set of other bundle versions that this version is dependent on", - "readOnly" : true, - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/BundleVersionDependency" - } - }, - "bundle" : { - "description" : "The bundle this version is for", - "readOnly" : true, - "$ref" : "#/definitions/ExtensionBundle" - }, - "bucket" : { - "description" : "The bucket that the extension bundle belongs to", - "$ref" : "#/definitions/Bucket" - }, - "filename" : { - "type" : "string" - } - } - }, - "BundleVersionDependency" : { - "type" : "object", - "properties" : { - "groupId" : { - "type" : "string", - "description" : "The group id of the bundle dependency" - }, - "artifactId" : { - "type" : "string", - "description" : "The artifact id of the bundle dependency" - }, - "version" : { - "type" : "string", - "description" : "The version of the bundle dependency" - } - } - }, - "BundleVersionMetadata" : { - "type" : "object", - "required" : [ "bucketId", "buildInfo", "contentSize", "sha256Supplied" ], - "properties" : { - "link" : { - "description" : "An WebLink to this entity.", - "readOnly" : true, - "$ref" : "#/definitions/JaxbLink" - }, - "id" : { - "type" : "string", - "description" : "The id of this version of the extension bundle" - }, - "bundleId" : { - "type" : "string", - "description" : "The id of the extension bundle this version is for" - }, - "bucketId" : { - "type" : "string", - "description" : "The id of the bucket the extension bundle belongs to" - }, - "groupId" : { - "type" : "string" - }, - "artifactId" : { - "type" : "string" - }, - "version" : { - "type" : "string", - "description" : "The version of the extension bundle" - }, - "timestamp" : { - "type" : "integer", - "format" : "int64", - "description" : "The timestamp of the create date of this version", - "minimum" : 1 - }, - "author" : { - "type" : "string", - "description" : "The identity that created this version" - }, - "description" : { - "type" : "string", - "description" : "The description for this version" - }, - "sha256" : { - "type" : "string", - "description" : "The hex representation of the SHA-256 digest of the binary content for this version" - }, - "sha256Supplied" : { - "type" : "boolean", - "description" : "Whether or not the client supplied a SHA-256 when uploading the bundle" - }, - "contentSize" : { - "type" : "integer", - "format" : "int64", - "description" : "The size of the binary content for this version in bytes", - "minimum" : 0 - }, - "systemApiVersion" : { - "type" : "string", - "description" : "The version of the system API that this bundle version was built against" - }, - "buildInfo" : { - "description" : "The build information about this version", - "$ref" : "#/definitions/BuildInfo" - } - } - }, - "ComponentDifference" : { - "type" : "object", - "properties" : { - "valueA" : { - "type" : "string", - "description" : "The earlier value from the difference." - }, - "valueB" : { - "type" : "string", - "description" : "The newer value from the difference." - }, - "changeDescription" : { - "type" : "string", - "description" : "The description of the change." - }, - "differenceType" : { - "type" : "string", - "description" : "The key to the difference." - }, - "differenceTypeDescription" : { - "type" : "string", - "description" : "The description of the change type." - } - } - }, - "ComponentDifferenceGroup" : { - "type" : "object", - "properties" : { - "componentId" : { - "type" : "string", - "description" : "The id of the component whose changes are grouped together." - }, - "componentName" : { - "type" : "string", - "description" : "The name of the component whose changes are grouped together." - }, - "componentType" : { - "type" : "string", - "description" : "The type of component these changes relate to." - }, - "processGroupId" : { - "type" : "string", - "description" : "The process group id for this component." - }, - "differences" : { - "type" : "array", - "description" : "The list of changes related to this component between the 2 versions.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ComponentDifference" - } - } - } - }, - "ConnectableComponent" : { - "type" : "object", - "required" : [ "groupId", "id", "type" ], - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the connectable component." - }, - "type" : { - "type" : "string", - "description" : "The type of component the connectable is.", - "enum" : [ "PROCESSOR", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "INPUT_PORT", "OUTPUT_PORT", "FUNNEL" ] - }, - "groupId" : { - "type" : "string", - "description" : "The id of the group that the connectable component resides in" - }, - "name" : { - "type" : "string", - "description" : "The name of the connectable component" - }, - "comments" : { - "type" : "string", - "description" : "The comments for the connectable component." - }, - "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" - } - } - }, - "ControllerServiceAPI" : { - "type" : "object", - "properties" : { - "type" : { - "type" : "string", - "description" : "The fully qualified name of the service interface." - }, - "bundle" : { - "description" : "The details of the artifact that bundled this service interface.", - "$ref" : "#/definitions/Bundle" - } - } - }, - "ControllerServiceDefinition" : { - "type" : "object", - "properties" : { - "className" : { - "type" : "string", - "description" : "The class name of the service API" - }, - "groupId" : { - "type" : "string", - "description" : "The group id of the service API" - }, - "artifactId" : { - "type" : "string", - "description" : "The artifact id of the service API" - }, - "version" : { - "type" : "string", - "description" : "The version of the service API" - } - } - }, - "CurrentUser" : { - "type" : "object", - "properties" : { - "identity" : { - "type" : "string", - "description" : "The identity of the current user", - "readOnly" : true - }, - "anonymous" : { - "type" : "boolean", - "description" : "Indicates if the current user is anonymous", - "readOnly" : true - }, - "loginSupported" : { - "type" : "boolean", - "description" : "Indicates if the NiFi Registry instance supports logging in" - }, - "resourcePermissions" : { - "description" : "The access that the current user has to top level resources", - "readOnly" : true, - "$ref" : "#/definitions/ResourcePermissions" - }, - "oidcloginSupported" : { - "type" : "boolean", - "description" : "Indicates if the NiFi Registry instance supports logging in with an OIDC provider" - } - } - }, - "DefaultSchedule" : { - "type" : "object", - "properties" : { - "strategy" : { - "type" : "string", - "description" : "The default scheduling strategy" - }, - "period" : { - "type" : "string", - "description" : "The default scheduling period" - }, - "concurrentTasks" : { - "type" : "string", - "description" : "The default concurrent tasks" - } - } - }, - "DefaultSettings" : { - "type" : "object", - "properties" : { - "yieldDuration" : { - "type" : "string", - "description" : "The default yield duration" - }, - "penaltyDuration" : { - "type" : "string", - "description" : "The default penalty duration" - }, - "bulletinLevel" : { - "type" : "string", - "description" : "The default bulletin level" - } - } - }, - "Dependency" : { - "type" : "object", - "properties" : { - "propertyName" : { - "type" : "string", - "description" : "The name of the dependent property" - }, - "propertyDisplayName" : { - "type" : "string", - "description" : "The display name of the dependent property" - }, - "dependentValues" : { - "description" : "The values of the dependent property that enable the depending property", - "$ref" : "#/definitions/DependentValues" - } - } - }, - "DependentValues" : { - "type" : "object", - "properties" : { - "values" : { - "type" : "array", - "xml" : { - "name" : "dependentValue" - }, - "description" : "The dependent values", - "items" : { - "type" : "string", - "xml" : { - "name" : "dependentValue" - } - } - } - } - }, - "DeprecationNotice" : { - "type" : "object", - "properties" : { - "reason" : { - "type" : "string", - "description" : "The reason for the deprecation" - }, - "alternatives" : { - "type" : "array", - "xml" : { - "wrapped" : true - }, - "description" : "The alternatives to use", - "items" : { - "type" : "string", - "xml" : { - "name" : "alternative" - } - } - } - } - }, - "DynamicProperty" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The description of the dynamic property name" - }, - "value" : { - "type" : "string", - "description" : "The description of the dynamic property value" - }, - "description" : { - "type" : "string", - "description" : "The description of the dynamic property" - }, - "expressionLanguageScope" : { - "type" : "string", - "description" : "The scope of the expression language support", - "enum" : [ "NONE", "VARIABLE_REGISTRY", "FLOWFILE_ATTRIBUTES" ] - }, - "expressionLanguageSupported" : { - "type" : "boolean", - "description" : "Whether or not expression language is supported" - } - } - }, - "DynamicRelationship" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The description of the dynamic relationship name" - }, - "description" : { - "type" : "string", - "description" : "The description of the dynamic relationship" - } - } - }, - "Extension" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The name of the extension" - }, - "type" : { - "type" : "string", - "description" : "The type of the extension", - "enum" : [ "PROCESSOR", "CONTROLLER_SERVICE", "REPORTING_TASK" ] - }, - "deprecationNotice" : { - "description" : "The deprecation notice of the extension", - "$ref" : "#/definitions/DeprecationNotice" - }, - "description" : { - "type" : "string", - "description" : "The description of the extension" - }, - "tags" : { - "type" : "array", - "xml" : { - "wrapped" : true - }, - "description" : "The tags of the extension", - "items" : { - "type" : "string", - "xml" : { - "name" : "tag" - } - } - }, - "properties" : { - "type" : "array", - "xml" : { - "wrapped" : true - }, - "description" : "The properties of the extension", - "items" : { - "xml" : { - "name" : "property" - }, - "$ref" : "#/definitions/Property" - } - }, - "dynamicProperties" : { - "type" : "array", - "xml" : { - "wrapped" : true - }, - "description" : "The dynamic properties of the extension", - "items" : { - "xml" : { - "name" : "dynamicProperty" - }, - "$ref" : "#/definitions/DynamicProperty" - } - }, - "relationships" : { - "type" : "array", - "xml" : { - "wrapped" : true - }, - "description" : "The relationships of the extension", - "items" : { - "xml" : { - "name" : "relationship" - }, - "$ref" : "#/definitions/Relationship" - } - }, - "dynamicRelationship" : { - "description" : "The dynamic relationships of the extension", - "$ref" : "#/definitions/DynamicRelationship" - }, - "readsAttributes" : { - "type" : "array", - "xml" : { - "wrapped" : true - }, - "description" : "The attributes read from flow files by the extension", - "items" : { - "xml" : { - "name" : "readsAttribute" - }, - "$ref" : "#/definitions/Attribute" - } - }, - "writesAttributes" : { - "type" : "array", - "xml" : { - "wrapped" : true - }, - "description" : "The attributes written to flow files by the extension", - "items" : { - "xml" : { - "name" : "writesAttribute" - }, - "$ref" : "#/definitions/Attribute" - } - }, - "stateful" : { - "description" : "The information about how the extension stores state", - "$ref" : "#/definitions/Stateful" - }, - "restricted" : { - "description" : "The restrictions of the extension", - "$ref" : "#/definitions/Restricted" - }, - "inputRequirement" : { - "type" : "string", - "description" : "The input requirement of the extension", - "enum" : [ "INPUT_REQUIRED", "INPUT_ALLOWED", "INPUT_FORBIDDEN" ] - }, - "systemResourceConsiderations" : { - "type" : "array", - "xml" : { - "wrapped" : true - }, - "description" : "The resource considerations of the extension", - "items" : { - "xml" : { - "name" : "systemResourceConsideration" - }, - "$ref" : "#/definitions/SystemResourceConsideration" - } - }, - "seeAlso" : { - "type" : "array", - "xml" : { - "wrapped" : true - }, - "description" : "The names of other extensions to see", - "items" : { - "type" : "string", - "xml" : { - "name" : "see" - } - } - }, - "providedServiceAPIs" : { - "type" : "array", - "xml" : { - "wrapped" : true - }, - "description" : "The service APIs provided by this extension", - "items" : { - "xml" : { - "name" : "providedServiceAPI" - }, - "$ref" : "#/definitions/ProvidedServiceAPI" - } - }, - "defaultSettings" : { - "description" : "The default settings for a processor", - "$ref" : "#/definitions/DefaultSettings" - }, - "defaultSchedule" : { - "description" : "The default schedule for a processor reporting task", - "$ref" : "#/definitions/DefaultSchedule" - }, - "triggerSerially" : { - "type" : "boolean", - "description" : "Indicates that a processor should be triggered serially" - }, - "triggerWhenEmpty" : { - "type" : "boolean", - "description" : "Indicates that a processor should be triggered when the incoming queues are empty" - }, - "triggerWhenAnyDestinationAvailable" : { - "type" : "boolean", - "description" : "Indicates that a processor should be triggered when any destinations have space for flow files" - }, - "supportsBatching" : { - "type" : "boolean", - "description" : "Indicates that a processor supports batching" - }, - "eventDriven" : { - "type" : "boolean", - "description" : "Indicates that a processor supports event driven scheduling" - }, - "primaryNodeOnly" : { - "type" : "boolean", - "description" : "Indicates that a processor should be scheduled only on the primary node" - }, - "sideEffectFree" : { - "type" : "boolean", - "description" : "Indicates that a processor is side effect free" - } - } - }, - "ExtensionBundle" : { - "type" : "object", - "required" : [ "bucketIdentifier", "bundleType", "name", "type" ], - "properties" : { - "link" : { - "description" : "An WebLink to this entity.", - "readOnly" : true, - "$ref" : "#/definitions/JaxbLink" - }, - "identifier" : { - "type" : "string", - "description" : "An ID to uniquely identify this object.", - "readOnly" : true - }, - "name" : { - "type" : "string", - "description" : "The name of the item." - }, - "description" : { - "type" : "string", - "description" : "A description of the item." - }, - "bucketIdentifier" : { - "type" : "string", - "description" : "The identifier of the bucket this items belongs to. This cannot be changed after the item is created." - }, - "bucketName" : { - "type" : "string", - "description" : "The name of the bucket this items belongs to.", - "readOnly" : true - }, - "createdTimestamp" : { - "type" : "integer", - "format" : "int64", - "description" : "The timestamp of when the item was created, as milliseconds since epoch.", - "readOnly" : true, - "minimum" : 1 - }, - "modifiedTimestamp" : { - "type" : "integer", - "format" : "int64", - "description" : "The timestamp of when the item was last modified, as milliseconds since epoch.", - "readOnly" : true, - "minimum" : 1 - }, - "type" : { - "type" : "string", - "description" : "The type of item.", - "enum" : [ "Flow", "Bundle" ] - }, - "permissions" : { - "description" : "The access that the current user has to the bucket containing this item.", - "readOnly" : true, - "$ref" : "#/definitions/Permissions" - }, - "bundleType" : { - "type" : "string", - "description" : "The type of the extension bundle", - "enum" : [ "NIFI_NAR", "MINIFI_CPP" ] - }, - "groupId" : { - "type" : "string", - "description" : "The group id of the extension bundle" - }, - "artifactId" : { - "type" : "string", - "description" : "The artifact id of the extension bundle" - }, - "versionCount" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of versions of this extension bundle.", - "readOnly" : true, - "minimum" : 0 - } - } - }, - "ExtensionFilterParams" : { - "type" : "object", - "properties" : { - "bundleType" : { - "type" : "string", - "description" : "The type of bundle", - "enum" : [ "NIFI_NAR", "MINIFI_CPP" ] - }, - "extensionType" : { - "type" : "string", - "description" : "The type of extension", - "enum" : [ "PROCESSOR", "CONTROLLER_SERVICE", "REPORTING_TASK" ] - }, - "tags" : { - "type" : "array", - "description" : "The tags", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - } - } - }, - "ExtensionMetadata" : { - "type" : "object", - "properties" : { - "link" : { - "description" : "An WebLink to this entity.", - "readOnly" : true, - "$ref" : "#/definitions/JaxbLink" - }, - "name" : { - "type" : "string", - "description" : "The name of the extension" - }, - "displayName" : { - "type" : "string", - "description" : "The display name of the extension" - }, - "type" : { - "type" : "string", - "description" : "The type of the extension", - "enum" : [ "PROCESSOR", "CONTROLLER_SERVICE", "REPORTING_TASK" ] - }, - "description" : { - "type" : "string", - "description" : "The description of the extension" - }, - "deprecationNotice" : { - "description" : "The deprecation notice of the extension", - "$ref" : "#/definitions/DeprecationNotice" - }, - "tags" : { - "type" : "array", - "description" : "The tags of the extension", - "items" : { - "type" : "string" - } - }, - "restricted" : { - "description" : "The restrictions of the extension", - "$ref" : "#/definitions/Restricted" - }, - "providedServiceAPIs" : { - "type" : "array", - "description" : "The service APIs provided by the extension", - "items" : { - "$ref" : "#/definitions/ProvidedServiceAPI" - } - }, - "bundleInfo" : { - "description" : "The information for the bundle where this extension is located", - "$ref" : "#/definitions/BundleInfo" - }, - "hasAdditionalDetails" : { - "type" : "boolean", - "description" : "Whether or not the extension has additional detail documentation" - }, - "linkDocs" : { - "description" : "A WebLink to the documentation for this extension.", - "readOnly" : true, - "$ref" : "#/definitions/JaxbLink" - } - } - }, - "ExtensionMetadataContainer" : { - "type" : "object", - "properties" : { - "numResults" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of extensions in the response" - }, - "filterParams" : { - "description" : "The filter parameters submitted for the request", - "$ref" : "#/definitions/ExtensionFilterParams" - }, - "extensions" : { - "type" : "array", - "description" : "The metadata for the extensions", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ExtensionMetadata" - } - } - } - }, - "ExtensionRepoArtifact" : { - "type" : "object", - "properties" : { - "link" : { - "description" : "An WebLink to this entity.", - "readOnly" : true, - "$ref" : "#/definitions/JaxbLink" - }, - "bucketName" : { - "type" : "string", - "description" : "The bucket name" - }, - "groupId" : { - "type" : "string", - "description" : "The group id" - }, - "artifactId" : { - "type" : "string", - "description" : "The artifact id" - } - } - }, - "ExtensionRepoBucket" : { - "type" : "object", - "properties" : { - "link" : { - "description" : "An WebLink to this entity.", - "readOnly" : true, - "$ref" : "#/definitions/JaxbLink" - }, - "bucketName" : { - "type" : "string", - "description" : "The name of the bucket" - } - } - }, - "ExtensionRepoGroup" : { - "type" : "object", - "properties" : { - "link" : { - "description" : "An WebLink to this entity.", - "readOnly" : true, - "$ref" : "#/definitions/JaxbLink" - }, - "bucketName" : { - "type" : "string", - "description" : "The bucket name" - }, - "groupId" : { - "type" : "string", - "description" : "The group id" - } - } - }, - "ExtensionRepoVersion" : { - "type" : "object", - "properties" : { - "extensionsLink" : { - "description" : "The WebLink to view the metadata about the extensions contained in the extension bundle.", - "readOnly" : true, - "$ref" : "#/definitions/JaxbLink" - }, - "downloadLink" : { - "description" : "The WebLink to download this version of the extension bundle.", - "readOnly" : true, - "$ref" : "#/definitions/JaxbLink" - }, - "sha256Link" : { - "description" : "The WebLink to retrieve the SHA-256 digest for this version of the extension bundle.", - "readOnly" : true, - "$ref" : "#/definitions/JaxbLink" - }, - "sha256Supplied" : { - "description" : "Indicates if the client supplied a SHA-256 when uploading this version of the extension bundle.", - "readOnly" : true, - "$ref" : "#/definitions/JaxbLink" - } - } - }, - "ExtensionRepoVersionSummary" : { - "type" : "object", - "properties" : { - "link" : { - "description" : "An WebLink to this entity.", - "readOnly" : true, - "$ref" : "#/definitions/JaxbLink" - }, - "bucketName" : { - "type" : "string", - "description" : "The bucket name" - }, - "groupId" : { - "type" : "string", - "description" : "The group id" - }, - "artifactId" : { - "type" : "string", - "description" : "The artifact id" - }, - "version" : { - "type" : "string", - "description" : "The version" - }, - "author" : { - "type" : "string", - "description" : "The identity of the user that created this version" - }, - "timestamp" : { - "type" : "integer", - "format" : "int64", - "description" : "The timestamp of when this version was created" - } - } - }, - "ExternalControllerServiceReference" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The identifier of the controller service" - }, - "name" : { - "type" : "string", - "description" : "The name of the controller service" - } - } - }, - "Fields" : { - "type" : "object", - "properties" : { - "fields" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - } - } - }, - "JaxbLink" : { - "type" : "object", - "properties" : { - "href" : { - "type" : "string", - "format" : "uri", - "xml" : { - "attribute" : true - }, - "description" : "The href for the link" - }, - "params" : { - "type" : "object", - "description" : "The params for the link", - "additionalProperties" : { - "type" : "string" - } - } - } - }, - "Permissions" : { - "type" : "object", - "properties" : { - "canRead" : { - "type" : "boolean", - "description" : "Indicates whether the user can read a given resource.", - "readOnly" : true - }, - "canWrite" : { - "type" : "boolean", - "description" : "Indicates whether the user can write a given resource.", - "readOnly" : true - }, - "canDelete" : { - "type" : "boolean", - "description" : "Indicates whether the user can delete a given resource.", - "readOnly" : true - } - } - }, - "Position" : { - "type" : "object", - "properties" : { - "x" : { - "type" : "number", - "format" : "double", - "description" : "The x coordinate." - }, - "y" : { - "type" : "number", - "format" : "double", - "description" : "The y coordinate." - } - }, - "description" : "The position of a component on the graph" - }, - "Property" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The name of the property" - }, - "displayName" : { - "type" : "string", - "description" : "The display name" - }, - "description" : { - "type" : "string", - "description" : "The description" - }, - "defaultValue" : { - "type" : "string", - "description" : "The default value" - }, - "controllerServiceDefinition" : { - "description" : "The controller service required by this property, or null if none is required", - "$ref" : "#/definitions/ControllerServiceDefinition" - }, - "allowableValues" : { - "type" : "array", - "xml" : { - "wrapped" : true - }, - "description" : "The allowable values for this property", - "items" : { - "xml" : { - "name" : "allowableValue" - }, - "$ref" : "#/definitions/AllowableValue" - } - }, - "required" : { - "type" : "boolean", - "description" : "Whether or not the property is required" - }, - "sensitive" : { - "type" : "boolean", - "description" : "Whether or not the property is sensitive" - }, - "expressionLanguageSupported" : { - "type" : "boolean", - "description" : "Whether or not expression language is supported" - }, - "expressionLanguageScope" : { - "type" : "string", - "description" : "The scope of expression language support", - "enum" : [ "NONE", "VARIABLE_REGISTRY", "FLOWFILE_ATTRIBUTES" ] - }, - "dynamicallyModifiesClasspath" : { - "type" : "boolean", - "description" : "Whether or not the processor dynamically modifies the classpath" - }, - "dynamic" : { - "type" : "boolean", - "description" : "Whether or not the processor is dynamic" - }, - "dependencies" : { - "type" : "array", - "xml" : { - "wrapped" : true - }, - "description" : "The properties that this property depends on", - "items" : { - "xml" : { - "name" : "dependency" - }, - "$ref" : "#/definitions/Dependency" - } - }, - "resourceDefinition" : { - "description" : "The optional resource definition", - "$ref" : "#/definitions/ResourceDefinition" - } - } - }, - "ProvidedServiceAPI" : { - "type" : "object", - "properties" : { - "className" : { - "type" : "string", - "description" : "The class name of the service API being provided" - }, - "groupId" : { - "type" : "string", - "description" : "The group id of the service API being provided" - }, - "artifactId" : { - "type" : "string", - "description" : "The artifact id of the service API being provided" - }, - "version" : { - "type" : "string", - "description" : "The version of the service API being provided" - } - } - }, - "RegistryAbout" : { - "type" : "object", - "properties" : { - "registryAboutVersion" : { - "type" : "string", - "description" : "The version string for this Nifi Registry", - "readOnly" : true - } - } - }, - "RegistryConfiguration" : { - "type" : "object", - "properties" : { - "supportsManagedAuthorizer" : { - "type" : "boolean", - "description" : "Whether this NiFi Registry supports a managed authorizer. Managed authorizers can visualize users, groups, and policies in the UI.", - "readOnly" : true - }, - "supportsConfigurableAuthorizer" : { - "type" : "boolean", - "description" : "Whether this NiFi Registry supports a configurable authorizer.", - "readOnly" : true - }, - "supportsConfigurableUsersAndGroups" : { - "type" : "boolean", - "description" : "Whether this NiFi Registry supports configurable users and groups.", - "readOnly" : true - } - } - }, - "Relationship" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The name of the relationship" - }, - "description" : { - "type" : "string", - "description" : "The description of the relationship" - }, - "autoTerminated" : { - "type" : "boolean", - "description" : "Whether or not the relationship is auto-terminated by default" - } - } - }, - "Resource" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The identifier of the resource.", - "readOnly" : true - }, - "name" : { - "type" : "string", - "description" : "The name of the resource.", - "readOnly" : true - } - } - }, - "ResourceDefinition" : { - "type" : "object", - "properties" : { - "cardinality" : { - "type" : "string", - "description" : "The cardinality of the resource definition", - "enum" : [ "SINGLE", "MULTIPLE" ] - }, - "resourceTypes" : { - "type" : "array", - "xml" : { - "wrapped" : true - }, - "description" : "The types of resources", - "items" : { - "type" : "string", - "xml" : { - "name" : "resourceType" - }, - "enum" : [ "FILE", "DIRECTORY", "TEXT", "URL" ] - } - } - } - }, - "ResourcePermissions" : { - "type" : "object", - "properties" : { - "buckets" : { - "description" : "The access that the current user has to the top level /buckets resource of this NiFi Registry (i.e., access to all buckets)", - "readOnly" : true, - "$ref" : "#/definitions/Permissions" - }, - "tenants" : { - "description" : "The access that the current user has to the top level /tenants resource of this NiFi Registry", - "readOnly" : true, - "$ref" : "#/definitions/Permissions" - }, - "policies" : { - "description" : "The access that the current user has to the top level /policies resource of this NiFi Registry", - "readOnly" : true, - "$ref" : "#/definitions/Permissions" - }, - "proxy" : { - "description" : "The access that the current user has to the top level /proxy resource of this NiFi Registry", - "readOnly" : true, - "$ref" : "#/definitions/Permissions" - }, - "anyTopLevelResource" : { - "description" : "The access that the current user has to any top level resources (a logical 'OR' of all other values)", - "readOnly" : true, - "$ref" : "#/definitions/Permissions" - } - } - }, - "Restricted" : { - "type" : "object", - "properties" : { - "generalRestrictionExplanation" : { - "type" : "string", - "description" : "The general restriction for the extension, or null if only specific restrictions exist" - }, - "restrictions" : { - "type" : "array", - "xml" : { - "wrapped" : true - }, - "description" : "The specific restrictions", - "items" : { - "xml" : { - "name" : "restriction" - }, - "$ref" : "#/definitions/Restriction" - } - } - } - }, - "Restriction" : { - "type" : "object", - "properties" : { - "requiredPermission" : { - "type" : "string", - "description" : "The permission required for this restriction" - }, - "explanation" : { - "type" : "string", - "description" : "The explanation of this restriction" - } - } - }, - "RevisionInfo" : { - "type" : "object", - "properties" : { - "clientId" : { - "type" : "string", - "description" : "A client identifier used to make a request. By including a client identifier, the API can allow multiple requests without needing the current revision. Due to the asynchronous nature of requests/responses this was implemented to allow the client to make numerous requests without having to wait for the previous response to come back." - }, - "version" : { - "type" : "integer", - "format" : "int64", - "description" : "NiFi Registry employs an optimistic locking strategy where the client must include a revision in their request when performing an update. In a response to a mutable flow request, this field represents the updated base version." - }, - "lastModifier" : { - "type" : "string", - "description" : "The user that last modified the entity.", - "readOnly" : true - } - }, - "description" : "The revision information for an entity managed through the REST API." - }, - "Stateful" : { - "type" : "object", - "properties" : { - "description" : { - "type" : "string", - "description" : "The description for how the extension stores state" - }, - "scopes" : { - "type" : "array", - "xml" : { - "wrapped" : true - }, - "description" : "The scopes used to store state", - "items" : { - "type" : "string", - "xml" : { - "name" : "scope" - }, - "enum" : [ "CLUSTER", "LOCAL" ] - } - } - } - }, - "SystemResourceConsideration" : { - "type" : "object", - "properties" : { - "resource" : { - "type" : "string", - "description" : "The resource to consider" - }, - "description" : { - "type" : "string", - "description" : "The description of how the resource is affected" - } - } - }, - "TagCount" : { - "type" : "object", - "properties" : { - "tag" : { - "type" : "string", - "description" : "The tag label" - }, - "count" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of occurrences of the given tag" - } - } - }, - "Tenant" : { - "type" : "object", - "required" : [ "identity" ], - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The computer-generated identifier of the tenant.", - "readOnly" : true - }, - "identity" : { - "type" : "string", - "description" : "The human-facing identity of the tenant. This can only be changed if the tenant is configurable." - }, - "configurable" : { - "type" : "boolean", - "description" : "Indicates if this tenant is configurable, based on which UserGroupProvider has been configured to manage it.", - "readOnly" : true - }, - "resourcePermissions" : { - "description" : "A summary top-level resource access policies granted to this tenant.", - "readOnly" : true, - "$ref" : "#/definitions/ResourcePermissions" - }, - "accessPolicies" : { - "type" : "array", - "description" : "The access policies granted to this tenant.", - "readOnly" : true, - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/AccessPolicySummary" - } - }, - "revision" : { - "description" : "The revision of this entity used for optimistic-locking during updates.", - "readOnly" : true, - "$ref" : "#/definitions/RevisionInfo" - } - } - }, - "User" : { - "type" : "object", - "required" : [ "identity" ], - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The computer-generated identifier of the tenant.", - "readOnly" : true - }, - "identity" : { - "type" : "string", - "description" : "The human-facing identity of the tenant. This can only be changed if the tenant is configurable." - }, - "configurable" : { - "type" : "boolean", - "description" : "Indicates if this tenant is configurable, based on which UserGroupProvider has been configured to manage it.", - "readOnly" : true - }, - "resourcePermissions" : { - "description" : "A summary top-level resource access policies granted to this tenant.", - "readOnly" : true, - "$ref" : "#/definitions/ResourcePermissions" - }, - "accessPolicies" : { - "type" : "array", - "description" : "The access policies granted to this tenant.", - "readOnly" : true, - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/AccessPolicySummary" - } - }, - "revision" : { - "description" : "The revision of this entity used for optimistic-locking during updates.", - "readOnly" : true, - "$ref" : "#/definitions/RevisionInfo" - }, - "userGroups" : { - "type" : "array", - "description" : "The groups to which the user belongs.", - "readOnly" : true, - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/Tenant" - } - } - } - }, - "UserGroup" : { - "type" : "object", - "required" : [ "identity" ], - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The computer-generated identifier of the tenant.", - "readOnly" : true - }, - "identity" : { - "type" : "string", - "description" : "The human-facing identity of the tenant. This can only be changed if the tenant is configurable." - }, - "configurable" : { - "type" : "boolean", - "description" : "Indicates if this tenant is configurable, based on which UserGroupProvider has been configured to manage it.", - "readOnly" : true - }, - "resourcePermissions" : { - "description" : "A summary top-level resource access policies granted to this tenant.", - "readOnly" : true, - "$ref" : "#/definitions/ResourcePermissions" - }, - "accessPolicies" : { - "type" : "array", - "description" : "The access policies granted to this tenant.", - "readOnly" : true, - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/AccessPolicySummary" - } - }, - "revision" : { - "description" : "The revision of this entity used for optimistic-locking during updates.", - "readOnly" : true, - "$ref" : "#/definitions/RevisionInfo" - }, - "users" : { - "type" : "array", - "description" : "The users that belong to this user group. This can only be changed if this group is configurable.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/Tenant" - } - } - } - }, - "VersionedConnection" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The component's unique identifier" - }, - "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" - }, - "comments" : { - "type" : "string", - "description" : "The user-supplied comments for the component" - }, - "position" : { - "description" : "The component's position on the graph", - "$ref" : "#/definitions/Position" - }, - "source" : { - "description" : "The source of the connection.", - "$ref" : "#/definitions/ConnectableComponent" - }, - "destination" : { - "description" : "The destination of the connection.", - "$ref" : "#/definitions/ConnectableComponent" - }, - "labelIndex" : { - "type" : "integer", - "format" : "int32", - "description" : "The index of the bend point where to place the connection label." - }, - "zIndex" : { - "type" : "integer", - "format" : "int64", - "description" : "The z index of the connection." - }, - "selectedRelationships" : { - "type" : "array", - "description" : "The selected relationship that comprise the connection.", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - }, - "backPressureObjectThreshold" : { - "type" : "integer", - "format" : "int64", - "description" : "The object count threshold for determining when back pressure is applied. Updating this value is a passive change in the sense that it won't impact whether existing files over the limit are affected but it does help feeder processors to stop pushing too much into this work queue." - }, - "backPressureDataSizeThreshold" : { - "type" : "string", - "description" : "The object data size threshold for determining when back pressure is applied. Updating this value is a passive change in the sense that it won't impact whether existing files over the limit are affected but it does help feeder processors to stop pushing too much into this work queue." - }, - "flowFileExpiration" : { - "type" : "string", - "description" : "The amount of time a flow file may be in the flow before it will be automatically aged out of the flow. Once a flow file reaches this age it will be terminated from the flow the next time a processor attempts to start work on it." - }, - "prioritizers" : { - "type" : "array", - "description" : "The comparators used to prioritize the queue.", - "items" : { - "type" : "string" - } - }, - "bends" : { - "type" : "array", - "description" : "The bend points on the connection.", - "items" : { - "$ref" : "#/definitions/Position" - } - }, - "loadBalanceStrategy" : { - "type" : "string", - "description" : "The Strategy to use for load balancing data across the cluster, or null, if no Load Balance Strategy has been specified.", - "enum" : [ "DO_NOT_LOAD_BALANCE", "PARTITION_BY_ATTRIBUTE", "ROUND_ROBIN", "SINGLE_NODE" ] - }, - "partitioningAttribute" : { - "type" : "string", - "description" : "The attribute to use for partitioning data as it is load balanced across the cluster. If the Load Balance Strategy is configured to use PARTITION_BY_ATTRIBUTE, the value returned by this method is the name of the FlowFile Attribute that will be used to determine which node in the cluster should receive a given FlowFile. If the Load Balance Strategy is unset or is set to any other value, the Partitioning Attribute has no effect." - }, - "loadBalanceCompression" : { - "type" : "string", - "description" : "Whether or not compression should be used when transferring FlowFiles between nodes", - "enum" : [ "DO_NOT_COMPRESS", "COMPRESS_ATTRIBUTES_ONLY", "COMPRESS_ATTRIBUTES_AND_CONTENT" ] - }, - "componentType" : { - "type" : "string", - "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE", "REPORTING_TASK", "PARAMETER_CONTEXT", "TEMPLATE" ] - }, - "groupIdentifier" : { - "type" : "string", - "description" : "The ID of the Process Group that this component belongs to" - } - } - }, - "VersionedControllerService" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The component's unique identifier" - }, - "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" - }, - "comments" : { - "type" : "string", - "description" : "The user-supplied comments for the component" - }, - "position" : { - "description" : "The component's position on the graph", - "$ref" : "#/definitions/Position" - }, - "type" : { - "type" : "string", - "description" : "The type of the extension component" - }, - "bundle" : { - "description" : "Information about the bundle from which the component came", - "$ref" : "#/definitions/Bundle" - }, - "properties" : { - "type" : "object", - "description" : "The properties for the component. Properties whose value is not set will only contain the property name.", - "additionalProperties" : { - "type" : "string" - } - }, - "propertyDescriptors" : { - "type" : "object", - "description" : "The property descriptors for the component.", - "additionalProperties" : { - "$ref" : "#/definitions/VersionedPropertyDescriptor" - } - }, - "controllerServiceApis" : { - "type" : "array", - "description" : "Lists the APIs this Controller Service implements.", - "items" : { - "$ref" : "#/definitions/ControllerServiceAPI" - } - }, - "annotationData" : { - "type" : "string", - "description" : "The annotation for the controller service. This is how the custom UI relays configuration to the controller service." - }, - "scheduledState" : { - "type" : "string", - "description" : "The ScheduledState denoting whether the Controller Service is ENABLED or DISABLED", - "enum" : [ "ENABLED", "DISABLED", "RUNNING" ] - }, - "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", "PARAMETER_CONTEXT", "TEMPLATE" ] - }, - "groupIdentifier" : { - "type" : "string", - "description" : "The ID of the Process Group that this component belongs to" - } - } - }, - "VersionedFlow" : { - "type" : "object", - "required" : [ "bucketIdentifier", "name", "type" ], - "properties" : { - "link" : { - "description" : "An WebLink to this entity.", - "readOnly" : true, - "$ref" : "#/definitions/JaxbLink" - }, - "identifier" : { - "type" : "string", - "description" : "An ID to uniquely identify this object.", - "readOnly" : true - }, - "name" : { - "type" : "string", - "description" : "The name of the item." - }, - "description" : { - "type" : "string", - "description" : "A description of the item." - }, - "bucketIdentifier" : { - "type" : "string", - "description" : "The identifier of the bucket this items belongs to. This cannot be changed after the item is created." - }, - "bucketName" : { - "type" : "string", - "description" : "The name of the bucket this items belongs to.", - "readOnly" : true - }, - "createdTimestamp" : { - "type" : "integer", - "format" : "int64", - "description" : "The timestamp of when the item was created, as milliseconds since epoch.", - "readOnly" : true, - "minimum" : 1 - }, - "modifiedTimestamp" : { - "type" : "integer", - "format" : "int64", - "description" : "The timestamp of when the item was last modified, as milliseconds since epoch.", - "readOnly" : true, - "minimum" : 1 - }, - "type" : { - "type" : "string", - "description" : "The type of item.", - "enum" : [ "Flow", "Bundle" ] - }, - "permissions" : { - "description" : "The access that the current user has to the bucket containing this item.", - "readOnly" : true, - "$ref" : "#/definitions/Permissions" - }, - "versionCount" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of versions of this flow.", - "readOnly" : true, - "minimum" : 0 - }, - "revision" : { - "description" : "The revision of this entity used for optimistic-locking during updates.", - "readOnly" : true, - "$ref" : "#/definitions/RevisionInfo" - } - } - }, - "VersionedFlowCoordinates" : { - "type" : "object", - "properties" : { - "registryUrl" : { - "type" : "string", - "description" : "The URL of the Flow Registry that contains the flow" - }, - "bucketId" : { - "type" : "string", - "description" : "The UUID of the bucket that the flow resides in" - }, - "flowId" : { - "type" : "string", - "description" : "The UUID of the flow" - }, - "version" : { - "type" : "integer", - "format" : "int32", - "description" : "The version of the flow" - }, - "latest" : { - "type" : "boolean", - "description" : "Whether or not these coordinates point to the latest version of the flow" - } - } - }, - "VersionedFlowDifference" : { - "type" : "object", - "properties" : { - "bucketId" : { - "type" : "string", - "description" : "The id of the bucket that the flow is stored in." - }, - "flowId" : { - "type" : "string", - "description" : "The id of the flow that is being examined." - }, - "versionA" : { - "type" : "integer", - "format" : "int32", - "description" : "The earlier version from the diff operation." - }, - "versionB" : { - "type" : "integer", - "format" : "int32", - "description" : "The latter version from the diff operation." - }, - "componentDifferenceGroups" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ComponentDifferenceGroup" - } - } - } - }, - "VersionedFlowSnapshot" : { - "type" : "object", - "required" : [ "flowContents", "snapshotMetadata" ], - "properties" : { - "snapshotMetadata" : { - "description" : "The metadata for this snapshot", - "$ref" : "#/definitions/VersionedFlowSnapshotMetadata" - }, - "flowContents" : { - "description" : "The contents of the versioned flow", - "$ref" : "#/definitions/VersionedProcessGroup" - }, - "externalControllerServices" : { - "type" : "object", - "description" : "The information about controller services that exist outside this versioned flow, but are referenced by components within the versioned flow.", - "additionalProperties" : { - "$ref" : "#/definitions/ExternalControllerServiceReference" - } - }, - "parameterContexts" : { - "type" : "object", - "description" : "The parameter contexts referenced by process groups in the flow contents. The mapping is from the name of the context to the context instance, and it is expected that any context in this map is referenced by at least one process group in this flow.", - "additionalProperties" : { - "$ref" : "#/definitions/VersionedParameterContext" - } - }, - "flowEncodingVersion" : { - "type" : "string", - "description" : "The optional encoding version of the flow contents." - }, - "flow" : { - "description" : "The flow this snapshot is for", - "readOnly" : true, - "$ref" : "#/definitions/VersionedFlow" - }, - "bucket" : { - "description" : "The bucket where the flow is located", - "readOnly" : true, - "$ref" : "#/definitions/Bucket" - }, - "latest" : { - "type" : "boolean" - } - } - }, - "VersionedFlowSnapshotMetadata" : { - "type" : "object", - "required" : [ "bucketIdentifier", "flowIdentifier", "version" ], - "properties" : { - "link" : { - "description" : "An WebLink to this entity.", - "readOnly" : true, - "$ref" : "#/definitions/JaxbLink" - }, - "bucketIdentifier" : { - "type" : "string", - "description" : "The identifier of the bucket this snapshot belongs to." - }, - "flowIdentifier" : { - "type" : "string", - "description" : "The identifier of the flow this snapshot belongs to." - }, - "version" : { - "type" : "integer", - "format" : "int32", - "description" : "The version of this snapshot of the flow.", - "minimum" : -1 - }, - "timestamp" : { - "type" : "integer", - "format" : "int64", - "description" : "The timestamp when the flow was saved, as milliseconds since epoch.", - "readOnly" : true, - "minimum" : 1 - }, - "author" : { - "type" : "string", - "description" : "The user that created this snapshot of the flow.", - "readOnly" : true - }, - "comments" : { - "type" : "string", - "description" : "The comments provided by the user when creating the snapshot." - } - } - }, - "VersionedFunnel" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The component's unique identifier" - }, - "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" - }, - "comments" : { - "type" : "string", - "description" : "The user-supplied comments for the component" - }, - "position" : { - "description" : "The component's position on the graph", - "$ref" : "#/definitions/Position" - }, - "componentType" : { - "type" : "string", - "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE", "REPORTING_TASK", "PARAMETER_CONTEXT", "TEMPLATE" ] - }, - "groupIdentifier" : { - "type" : "string", - "description" : "The ID of the Process Group that this component belongs to" - } - } - }, - "VersionedLabel" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The component's unique identifier" - }, - "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" - }, - "comments" : { - "type" : "string", - "description" : "The user-supplied comments for the component" - }, - "position" : { - "description" : "The component's position on the graph", - "$ref" : "#/definitions/Position" - }, - "label" : { - "type" : "string", - "description" : "The text that appears in the label." - }, - "zIndex" : { - "type" : "integer", - "format" : "int64", - "description" : "The z index of the connection." - }, - "width" : { - "type" : "number", - "format" : "double", - "description" : "The width of the label in pixels when at a 1:1 scale." - }, - "height" : { - "type" : "number", - "format" : "double", - "description" : "The height of the label in pixels when at a 1:1 scale." - }, - "style" : { - "type" : "object", - "description" : "The styles for this label (font-size : 12px, background-color : #eee, etc).", - "additionalProperties" : { - "type" : "string" - } - }, - "componentType" : { - "type" : "string", - "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE", "REPORTING_TASK", "PARAMETER_CONTEXT", "TEMPLATE" ] - }, - "groupIdentifier" : { - "type" : "string", - "description" : "The ID of the Process Group that this component belongs to" - } - } - }, - "VersionedParameter" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The name of the parameter" - }, - "description" : { - "type" : "string", - "description" : "The description of the param" - }, - "sensitive" : { - "type" : "boolean", - "description" : "Whether or not the parameter value is sensitive" - }, - "value" : { - "type" : "string", - "description" : "The value of the parameter" - } - } - }, - "VersionedParameterContext" : { - "type" : "object", - "properties" : { - "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" - }, - "comments" : { - "type" : "string", - "description" : "The user-supplied comments for the component" - }, - "position" : { - "description" : "The component's position on the graph", - "$ref" : "#/definitions/Position" - }, - "parameters" : { - "type" : "array", - "description" : "The parameters in the context", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedParameter" - } - }, - "inheritedParameterContexts" : { - "type" : "array", - "description" : "The names of additional parameter contexts from which to inherit parameters", - "items" : { - "type" : "string" - } - }, - "description" : { - "type" : "string", - "description" : "The description of the parameter context" - }, - "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", "PARAMETER_CONTEXT", "TEMPLATE" ] - }, - "groupIdentifier" : { - "type" : "string", - "description" : "The ID of the Process Group that this component belongs to" - } - } - }, - "VersionedPort" : { - "type" : "object", - "properties" : { - "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" - }, - "comments" : { - "type" : "string", - "description" : "The user-supplied comments for the component" - }, - "position" : { - "description" : "The component's position on the graph", - "$ref" : "#/definitions/Position" - }, - "type" : { - "type" : "string", - "description" : "The type of port.", - "enum" : [ "INPUT_PORT", "OUTPUT_PORT" ] - }, - "concurrentlySchedulableTaskCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of tasks that should be concurrently scheduled for the port." - }, - "scheduledState" : { - "type" : "string", - "description" : "The scheduled state of the component", - "enum" : [ "ENABLED", "DISABLED", "RUNNING" ] - }, - "allowRemoteAccess" : { - "type" : "boolean", - "description" : "Whether or not this port allows remote access for site-to-site" - }, - "componentType" : { - "type" : "string", - "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE", "REPORTING_TASK", "PARAMETER_CONTEXT", "TEMPLATE" ] - }, - "groupIdentifier" : { - "type" : "string", - "description" : "The ID of the Process Group that this component belongs to" - } - } - }, - "VersionedProcessGroup" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The component's unique identifier" - }, - "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" - }, - "comments" : { - "type" : "string", - "description" : "The user-supplied comments for the component" - }, - "position" : { - "description" : "The component's position on the graph", - "$ref" : "#/definitions/Position" - }, - "processGroups" : { - "type" : "array", - "description" : "The child Process Groups", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedProcessGroup" - } - }, - "remoteProcessGroups" : { - "type" : "array", - "description" : "The Remote Process Groups", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedRemoteProcessGroup" - } - }, - "processors" : { - "type" : "array", - "description" : "The Processors", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedProcessor" - } - }, - "inputPorts" : { - "type" : "array", - "description" : "The Input Ports", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedPort" - } - }, - "outputPorts" : { - "type" : "array", - "description" : "The Output Ports", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedPort" - } - }, - "connections" : { - "type" : "array", - "description" : "The Connections", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedConnection" - } - }, - "labels" : { - "type" : "array", - "description" : "The Labels", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedLabel" - } - }, - "funnels" : { - "type" : "array", - "description" : "The Funnels", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedFunnel" - } - }, - "controllerServices" : { - "type" : "array", - "description" : "The Controller Services", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedControllerService" - } - }, - "versionedFlowCoordinates" : { - "description" : "The coordinates where the remote flow is stored, or null if the Process Group is not directly under Version Control", - "$ref" : "#/definitions/VersionedFlowCoordinates" - }, - "variables" : { - "type" : "object", - "description" : "The Variables in the Variable Registry for this Process Group (not including any ancestor or descendant Process Groups)", - "additionalProperties" : { - "type" : "string" - } - }, - "parameterContextName" : { - "type" : "string", - "description" : "The name of the parameter context used by this process group" - }, - "defaultFlowFileExpiration" : { - "type" : "string", - "description" : "The default FlowFile Expiration for this Process Group." - }, - "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." - }, - "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." - }, - "flowFileConcurrency" : { - "type" : "string", - "description" : "The configured FlowFile Concurrency for the Process Group" - }, - "flowFileOutboundPolicy" : { - "type" : "string", - "description" : "The FlowFile Outbound Policy for the Process Group" - }, - "componentType" : { - "type" : "string", - "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE", "REPORTING_TASK", "PARAMETER_CONTEXT", "TEMPLATE" ] - }, - "groupIdentifier" : { - "type" : "string", - "description" : "The ID of the Process Group that this component belongs to" - } - } - }, - "VersionedProcessor" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The component's unique identifier" - }, - "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" - }, - "comments" : { - "type" : "string", - "description" : "The user-supplied comments for the component" - }, - "position" : { - "description" : "The component's position on the graph", - "$ref" : "#/definitions/Position" - }, - "type" : { - "type" : "string", - "description" : "The type of the extension component" - }, - "bundle" : { - "description" : "Information about the bundle from which the component came", - "$ref" : "#/definitions/Bundle" - }, - "properties" : { - "type" : "object", - "description" : "The properties for the component. Properties whose value is not set will only contain the property name.", - "additionalProperties" : { - "type" : "string" - } - }, - "propertyDescriptors" : { - "type" : "object", - "description" : "The property descriptors for the component.", - "additionalProperties" : { - "$ref" : "#/definitions/VersionedPropertyDescriptor" - } - }, - "style" : { - "type" : "object", - "description" : "Stylistic data for rendering in a UI", - "additionalProperties" : { - "type" : "string" - } - }, - "annotationData" : { - "type" : "string", - "description" : "The annotation data for the processor used to relay configuration between a custom UI and the procesosr." - }, - "schedulingPeriod" : { - "type" : "string", - "description" : "The frequency with which to schedule the processor. The format of the value will depend on th value of schedulingStrategy." - }, - "schedulingStrategy" : { - "type" : "string", - "description" : "Indicates whether the processor should be scheduled to run in event or timer driven mode." - }, - "executionNode" : { - "type" : "string", - "description" : "Indicates the node where the process will execute." - }, - "penaltyDuration" : { - "type" : "string", - "description" : "The amout of time that is used when the process penalizes a flowfile." - }, - "yieldDuration" : { - "type" : "string", - "description" : "The amount of time that must elapse before this processor is scheduled again after yielding." - }, - "bulletinLevel" : { - "type" : "string", - "description" : "The level at which the processor will report bulletins." - }, - "runDurationMillis" : { - "type" : "integer", - "format" : "int64", - "description" : "The run duration for the processor in milliseconds." - }, - "concurrentlySchedulableTaskCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of tasks that should be concurrently schedule for the processor. If the processor doesn't allow parallol processing then any positive input will be ignored." - }, - "autoTerminatedRelationships" : { - "type" : "array", - "description" : "The names of all relationships that cause a flow file to be terminated if the relationship is not connected elsewhere. This property differs from the 'isAutoTerminate' property of the RelationshipDTO in that the RelationshipDTO is meant to depict the current configuration, whereas this property can be set in a DTO when updating a Processor in order to change which Relationships should be auto-terminated.", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - }, - "scheduledState" : { - "type" : "string", - "description" : "The scheduled state of the component", - "enum" : [ "ENABLED", "DISABLED", "RUNNING" ] - }, - "retryCount" : { - "type" : "integer", - "format" : "int32", - "description" : "Overall number of retries." - }, - "retriedRelationships" : { - "type" : "array", - "description" : "All the relationships should be retried.", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - }, - "backoffMechanism" : { - "type" : "string", - "description" : "Determines whether the FlowFile should be penalized or the processor should be yielded between retries.", - "enum" : [ "PENALIZE_FLOWFILE", "YIELD_PROCESSOR" ] - }, - "maxBackoffPeriod" : { - "type" : "string", - "description" : "Maximum amount of time to be waited during a retry period." - }, - "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", "PARAMETER_CONTEXT", "TEMPLATE" ] - }, - "groupIdentifier" : { - "type" : "string", - "description" : "The ID of the Process Group that this component belongs to" - } - } - }, - "VersionedPropertyDescriptor" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The name of the property" - }, - "displayName" : { - "type" : "string", - "description" : "The display name of the property" - }, - "identifiesControllerService" : { - "type" : "boolean", - "description" : "Whether or not the property provides the identifier of a Controller Service" - }, - "sensitive" : { - "type" : "boolean", - "description" : "Whether or not the property is considered sensitive" - }, - "resourceDefinition" : { - "description" : "Returns the Resource Definition that defines which type(s) of resource(s) this property references, if any", - "$ref" : "#/definitions/VersionedResourceDefinition" - } - } - }, - "VersionedRemoteGroupPort" : { - "type" : "object", - "properties" : { - "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" - }, - "comments" : { - "type" : "string", - "description" : "The user-supplied comments for the component" - }, - "position" : { - "description" : "The component's position on the graph", - "$ref" : "#/definitions/Position" - }, - "remoteGroupId" : { - "type" : "string", - "description" : "The id of the remote process group that the port resides in." - }, - "concurrentlySchedulableTaskCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of task that may transmit flowfiles to the target port concurrently." - }, - "useCompression" : { - "type" : "boolean", - "description" : "Whether the flowfiles are compressed when sent to the target port." - }, - "batchSize" : { - "description" : "The batch settings for data transmission.", - "$ref" : "#/definitions/BatchSize" - }, - "componentType" : { - "type" : "string", - "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE", "REPORTING_TASK", "PARAMETER_CONTEXT", "TEMPLATE" ] - }, - "targetId" : { - "type" : "string", - "description" : "The ID of the port on the target NiFi instance" - }, - "scheduledState" : { - "type" : "string", - "description" : "The scheduled state of the component", - "enum" : [ "ENABLED", "DISABLED", "RUNNING" ] - }, - "groupIdentifier" : { - "type" : "string", - "description" : "The ID of the Process Group that this component belongs to" - } - } - }, - "VersionedRemoteProcessGroup" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The component's unique identifier" - }, - "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" - }, - "comments" : { - "type" : "string", - "description" : "The user-supplied comments for the component" - }, - "position" : { - "description" : "The component's position on the graph", - "$ref" : "#/definitions/Position" - }, - "targetUri" : { - "type" : "string", - "description" : "[DEPRECATED] The target URI of the remote process group. If target uri is not set, but uris are set, then returns the first uri in the uris. If neither target uri nor uris are set, then returns null." - }, - "targetUris" : { - "type" : "string", - "description" : "The target URIs of the remote process group. If target uris is not set but target uri is set, then returns the single target uri. If neither target uris nor target uri is set, then returns null." - }, - "communicationsTimeout" : { - "type" : "string", - "description" : "The time period used for the timeout when communicating with the target." - }, - "yieldDuration" : { - "type" : "string", - "description" : "When yielding, this amount of time must elapse before the remote process group is scheduled again." - }, - "transportProtocol" : { - "type" : "string", - "description" : "The Transport Protocol that is used for Site-to-Site communications", - "enum" : [ "RAW", "HTTP" ] - }, - "localNetworkInterface" : { - "type" : "string", - "description" : "The local network interface to send/receive data. If not specified, any local address is used. If clustered, all nodes must have an interface with this identifier." - }, - "proxyHost" : { - "type" : "string" - }, - "proxyPort" : { - "type" : "integer", - "format" : "int32" - }, - "proxyUser" : { - "type" : "string" - }, - "inputPorts" : { - "type" : "array", - "description" : "A Set of Input Ports that can be connected to, in order to send data to the remote NiFi instance", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedRemoteGroupPort" - } - }, - "outputPorts" : { - "type" : "array", - "description" : "A Set of Output Ports that can be connected to, in order to pull data from the remote NiFi instance", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedRemoteGroupPort" - } - }, - "componentType" : { - "type" : "string", - "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE", "REPORTING_TASK", "PARAMETER_CONTEXT", "TEMPLATE" ] - }, - "groupIdentifier" : { - "type" : "string", - "description" : "The ID of the Process Group that this component belongs to" - } - } - }, - "VersionedResourceDefinition" : { - "type" : "object", - "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", - "uniqueItems" : true, - "items" : { - "type" : "string", - "enum" : [ "FILE", "DIRECTORY", "TEXT", "URL" ] - } - } - } - } - } -} \ No newline at end of file diff --git a/resources/client_gen/api_defs/registry-1.17.0.json b/resources/client_gen/api_defs/registry-1.17.0.json deleted file mode 100644 index b718516e..00000000 --- a/resources/client_gen/api_defs/registry-1.17.0.json +++ /dev/null @@ -1,7007 +0,0 @@ -{ - "swagger" : "2.0", - "info" : { - "description" : "The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components.", - "version" : "1.17.0", - "title" : "Apache NiFi Registry REST API", - "termsOfService" : "As described in the license", - "contact" : { - "name" : "Apache NiFi Registry", - "url" : "https://nifi.apache.org", - "email" : "dev@nifi.apache.org" - }, - "license" : { - "name" : "Apache 2.0 License", - "url" : "https://www.apache.org/licenses/LICENSE-2.0.html" - } - }, - "basePath" : "/nifi-registry-api", - "tags" : [ { - "name" : "about", - "description" : "Retrieves the version information for this NiFi Registry." - }, { - "name" : "access", - "description" : "Endpoints for obtaining an access token or checking access status." - }, { - "name" : "bucket bundles", - "description" : "Create extension bundles scoped to an existing bucket in the registry. " - }, { - "name" : "bucket flows", - "description" : "Create flows scoped to an existing bucket in the registry." - }, { - "name" : "buckets", - "description" : "Create named buckets in the registry to store NiFi objects such flows and extensions. Search for and retrieve existing buckets." - }, { - "name" : "bundles", - "description" : "Gets metadata about extension bundles and their versions. " - }, { - "name" : "config", - "description" : "Retrieves the configuration for this NiFi Registry." - }, { - "name" : "extension repository", - "description" : "Interact with extension bundles via the hierarchy of bucket/group/artifact/version. " - }, { - "name" : "extensions", - "description" : "Find and retrieve extensions. " - }, { - "name" : "flows", - "description" : "Gets metadata about flows." - }, { - "name" : "items", - "description" : "Retrieve items across all buckets for which the user is authorized." - }, { - "name" : "policies", - "description" : "Endpoint for managing access policies." - }, { - "name" : "tenants", - "description" : "Endpoint for managing users and user groups." - } ], - "schemes" : [ "http", "https" ], - "paths" : { - "/about" : { - "get" : { - "tags" : [ "about" ], - "summary" : "Get version", - "description" : "Gets the NiFi Registry version.", - "operationId" : "getVersion", - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/RegistryAbout" - } - } - }, - "security" : [ { - "Authorization" : [ ] - } ] - } - }, - "/access" : { - "get" : { - "tags" : [ "access" ], - "summary" : "Get access status", - "description" : "Returns the current client's authenticated identity and permissions to top-level resources", - "operationId" : "getAccessStatus", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/CurrentUser" - } - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid. The NiFi Registry might be running unsecured." - } - }, - "security" : [ { - "Authorization" : [ ] - } ] - } - }, - "/access/logout" : { - "delete" : { - "tags" : [ "access" ], - "summary" : "Performs a logout for other providers that have been issued a JWT.", - "description" : "\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "logOut", - "consumes" : [ "*/*" ], - "produces" : [ "*/*" ], - "responses" : { - "200" : { - "description" : "User was logged out successfully." - }, - "401" : { - "description" : "Authentication token provided was empty or not in the correct JWT format." - }, - "500" : { - "description" : "Client failed to log out." - } - } - } - }, - "/access/oidc/callback" : { - "get" : { - "tags" : [ "access" ], - "summary" : "Redirect/callback URI for processing the result of the OpenId Connect login sequence.", - "description" : "\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "oidcCallback", - "consumes" : [ "*/*" ], - "produces" : [ "*/*" ], - "responses" : { - "default" : { - "description" : "successful operation" - } - } - } - }, - "/access/oidc/exchange" : { - "post" : { - "tags" : [ "access" ], - "summary" : "Retrieves a JWT following a successful login sequence using the configured OpenId Connect provider.", - "description" : "\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "oidcExchange", - "consumes" : [ "*/*" ], - "produces" : [ "text/plain" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - } - } - } - }, - "/access/oidc/logout" : { - "delete" : { - "tags" : [ "access" ], - "summary" : "Performs a logout in the OpenId Provider.", - "description" : "\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "oidcLogout", - "consumes" : [ "*/*" ], - "produces" : [ "*/*" ], - "responses" : { - "default" : { - "description" : "successful operation" - } - } - } - }, - "/access/oidc/request" : { - "get" : { - "tags" : [ "access" ], - "summary" : "Initiates a request to authenticate through the configured OpenId Connect provider.", - "description" : "\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "oidcRequest", - "consumes" : [ "*/*" ], - "produces" : [ "*/*" ], - "responses" : { - "default" : { - "description" : "successful operation" - } - } - } - }, - "/access/token" : { - "post" : { - "tags" : [ "access" ], - "summary" : "Create token trying all providers", - "description" : "Creates a token for accessing the REST API via auto-detected method of verifying client identity claim credentials. The token returned is formatted as a JSON Web Token (JWT). The token is base64 encoded and comprised of three parts. The header, the body, and the signature. The expiration of the token is a contained within the body. The token can be used in the Authorization header in the format 'Authorization: Bearer '.", - "operationId" : "createAccessTokenByTryingAllProviders", - "consumes" : [ "*/*" ], - "produces" : [ "text/plain" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid. The NiFi Registry may not be configured to support login with username/password." - }, - "500" : { - "description" : "NiFi Registry was unable to complete the request because an unexpected error occurred." - } - } - } - }, - "/access/token/identity-provider" : { - "post" : { - "tags" : [ "access" ], - "summary" : "Create token using identity provider", - "description" : "Creates a token for accessing the REST API via a custom identity provider. The user credentials must be passed in a format understood by the custom identity provider, e.g., a third-party auth token in an HTTP header. The exact format of the user credentials expected by the custom identity provider can be discovered by 'GET /access/token/identity-provider/usage'. The token returned is formatted as a JSON Web Token (JWT). The token is base64 encoded and comprised of three parts. The header, the body, and the signature. The expiration of the token is a contained within the body. The token can be used in the Authorization header in the format 'Authorization: Bearer '.", - "operationId" : "createAccessTokenUsingIdentityProviderCredentials", - "consumes" : [ "*/*" ], - "produces" : [ "text/plain" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid. The NiFi Registry may not be configured to support login with customized credentials." - }, - "500" : { - "description" : "NiFi Registry was unable to complete the request because an unexpected error occurred." - } - } - } - }, - "/access/token/identity-provider/test" : { - "post" : { - "tags" : [ "access" ], - "summary" : "Test identity provider", - "description" : "Tests the format of the credentials against this identity provider without preforming authentication on the credentials to validate them. The user credentials should be passed in a format understood by the custom identity provider as defined by 'GET /access/token/identity-provider/usage'.", - "operationId" : "testIdentityProviderRecognizesCredentialsFormat", - "consumes" : [ "*/*" ], - "produces" : [ "text/plain" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "The format of the credentials were not recognized by the currently configured identity provider." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid. The NiFi Registry may not be configured to support login with customized credentials." - }, - "500" : { - "description" : "NiFi Registry was unable to complete the request because an unexpected error occurred." - } - } - } - }, - "/access/token/identity-provider/usage" : { - "get" : { - "tags" : [ "access" ], - "summary" : "Get identity provider usage", - "description" : "Provides a description of how the currently configured identity provider expects credentials to be passed to POST /access/token/identity-provider", - "operationId" : "getIdentityProviderUsageInstructions", - "consumes" : [ "*/*" ], - "produces" : [ "text/plain" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid. The NiFi Registry may not be configured to support login with customized credentials." - }, - "500" : { - "description" : "NiFi Registry was unable to complete the request because an unexpected error occurred." - } - } - } - }, - "/access/token/kerberos" : { - "post" : { - "tags" : [ "access" ], - "summary" : "Create token using kerberos", - "description" : "Creates a token for accessing the REST API via Kerberos Service Tickets or SPNEGO Tokens (which includes Kerberos Service Tickets). The token returned is formatted as a JSON Web Token (JWT). The token is base64 encoded and comprised of three parts. The header, the body, and the signature. The expiration of the token is a contained within the body. The token can be used in the Authorization header in the format 'Authorization: Bearer '.", - "operationId" : "createAccessTokenUsingKerberosTicket", - "consumes" : [ "*/*" ], - "produces" : [ "text/plain" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid. The NiFi Registry may not be configured to support login Kerberos credentials." - }, - "500" : { - "description" : "NiFi Registry was unable to complete the request because an unexpected error occurred." - } - } - } - }, - "/access/token/login" : { - "post" : { - "tags" : [ "access" ], - "summary" : "Create token using basic auth", - "description" : "Creates a token for accessing the REST API via username/password. The user credentials must be passed in standard HTTP Basic Auth format. That is: 'Authorization: Basic ', where is the base64 encoded value of ':'. The token returned is formatted as a JSON Web Token (JWT). The token is base64 encoded and comprised of three parts. The header, the body, and the signature. The expiration of the token is a contained within the body. The token can be used in the Authorization header in the format 'Authorization: Bearer '.", - "operationId" : "createAccessTokenUsingBasicAuthCredentials", - "consumes" : [ "*/*" ], - "produces" : [ "text/plain" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid. The NiFi Registry may not be configured to support login with username/password." - }, - "500" : { - "description" : "NiFi Registry was unable to complete the request because an unexpected error occurred." - } - }, - "security" : [ { - "BasicAuth" : [ ] - } ] - } - }, - "/buckets" : { - "get" : { - "tags" : [ "buckets" ], - "summary" : "Get all buckets", - "description" : "The returned list will include only buckets for which the user is authorized.If the user is not authorized for any buckets, this returns an empty list.", - "operationId" : "getBuckets", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/Bucket" - } - } - }, - "401" : { - "description" : "Client could not be authenticated." - } - }, - "security" : [ { - "Authorization" : [ ] - } ] - }, - "post" : { - "tags" : [ "buckets" ], - "summary" : "Create bucket", - "description" : "", - "operationId" : "createBucket", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The bucket to create", - "required" : true, - "schema" : { - "$ref" : "#/definitions/Bucket" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/Bucket" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets", - "action" : "write" - } - } - }, - "/buckets/fields" : { - "get" : { - "tags" : [ "buckets" ], - "summary" : "Get bucket fields", - "description" : "Retrieves bucket field names for searching or sorting on buckets.", - "operationId" : "getAvailableBucketFields", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/Fields" - } - } - }, - "security" : [ { - "Authorization" : [ ] - } ] - } - }, - "/buckets/{bucketId}" : { - "get" : { - "tags" : [ "buckets" ], - "summary" : "Get bucket", - "description" : "Gets the bucket with the given id.", - "operationId" : "getBucket", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketId", - "in" : "path", - "description" : "The bucket identifier", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/Bucket" - } - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - }, - "put" : { - "tags" : [ "buckets" ], - "summary" : "Update bucket", - "description" : "Updates the bucket with the given id.", - "operationId" : "updateBucket", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketId", - "in" : "path", - "description" : "The bucket identifier", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The updated bucket", - "required" : true, - "schema" : { - "$ref" : "#/definitions/Bucket" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/Bucket" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "write" - } - }, - "delete" : { - "tags" : [ "buckets" ], - "summary" : "Delete bucket", - "description" : "Deletes the bucket with the given id, along with all objects stored in the bucket", - "operationId" : "deleteBucket", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The version is used to verify the client is working with the latest version of the entity.", - "required" : true, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "bucketId", - "in" : "path", - "description" : "The bucket identifier", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/Bucket" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "delete" - } - } - }, - "/buckets/{bucketId}/bundles" : { - "get" : { - "tags" : [ "bucket bundles" ], - "summary" : "Get extension bundles by bucket", - "description" : "\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getExtensionBundles", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketId", - "in" : "path", - "description" : "The bucket identifier", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/ExtensionBundle" - } - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/buckets/{bucketId}/bundles/{bundleType}" : { - "post" : { - "tags" : [ "bucket bundles" ], - "summary" : "Create extension bundle version", - "description" : "Creates a version of an extension bundle by uploading a binary artifact. If an extension bundle already exists in the given bucket with the same group id and artifact id as that of the bundle being uploaded, then it will be added as a new version to the existing bundle. If an extension bundle does not already exist in the given bucket with the same group id and artifact id, then a new extension bundle will be created and this version will be added to the new bundle. Client's may optionally supply a SHA-256 in hex format through the multi-part form field 'sha256'. If supplied, then this value will be compared against the SHA-256 computed by the server, and the bundle will be rejected if the values do not match. If not supplied, the bundle will be accepted, but will be marked to indicate that the client did not supply a SHA-256 during creation. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "createExtensionBundleVersion", - "consumes" : [ "multipart/form-data" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketId", - "in" : "path", - "description" : "The bucket identifier", - "required" : true, - "type" : "string" - }, { - "name" : "bundleType", - "in" : "path", - "description" : "The type of the bundle", - "required" : true, - "type" : "string", - "enum" : [ "nifi-nar", "minifi-cpp" ] - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/BundleVersion" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "write" - } - } - }, - "/buckets/{bucketId}/flows" : { - "get" : { - "tags" : [ "bucket flows" ], - "summary" : "Get bucket flows", - "description" : "Retrieves all flows in the given bucket.", - "operationId" : "getFlows", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketId", - "in" : "path", - "description" : "The bucket identifier", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/VersionedFlow" - } - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - }, - "post" : { - "tags" : [ "bucket flows" ], - "summary" : "Create flow", - "description" : "Creates a flow in the given bucket. The flow id is created by the server and populated in the returned entity.", - "operationId" : "createFlow", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketId", - "in" : "path", - "description" : "The bucket identifier", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The details of the flow to create.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/VersionedFlow" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlow" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "write" - } - } - }, - "/buckets/{bucketId}/flows/{flowId}" : { - "get" : { - "tags" : [ "bucket flows" ], - "summary" : "Get bucket flow", - "description" : "Retrieves the flow with the given id in the given bucket.", - "operationId" : "getFlow", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketId", - "in" : "path", - "description" : "The bucket identifier", - "required" : true, - "type" : "string" - }, { - "name" : "flowId", - "in" : "path", - "description" : "The flow identifier", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlow" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - }, - "put" : { - "tags" : [ "bucket flows" ], - "summary" : "Update bucket flow", - "description" : "Updates the flow with the given id in the given bucket.", - "operationId" : "updateFlow", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketId", - "in" : "path", - "description" : "The bucket identifier", - "required" : true, - "type" : "string" - }, { - "name" : "flowId", - "in" : "path", - "description" : "The flow identifier", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The updated flow", - "required" : true, - "schema" : { - "$ref" : "#/definitions/VersionedFlow" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlow" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "write" - } - }, - "delete" : { - "tags" : [ "bucket flows" ], - "summary" : "Delete bucket flow", - "description" : "Deletes a flow, including all saved versions of that flow.", - "operationId" : "deleteFlow", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The version is used to verify the client is working with the latest version of the entity.", - "required" : true, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "bucketId", - "in" : "path", - "description" : "The bucket identifier", - "required" : true, - "type" : "string" - }, { - "name" : "flowId", - "in" : "path", - "description" : "The flow identifier", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlow" - } - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "delete" - } - } - }, - "/buckets/{bucketId}/flows/{flowId}/diff/{versionA}/{versionB}" : { - "get" : { - "tags" : [ "bucket flows" ], - "summary" : "Get bucket flow diff", - "description" : "Computes the differences between two given versions of a flow.", - "operationId" : "getFlowDiff", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketId", - "in" : "path", - "description" : "The bucket identifier", - "required" : true, - "type" : "string" - }, { - "name" : "flowId", - "in" : "path", - "description" : "The flow identifier", - "required" : true, - "type" : "string" - }, { - "name" : "versionA", - "in" : "path", - "description" : "The first version number", - "required" : true, - "type" : "integer", - "pattern" : "\\d+", - "format" : "int32" - }, { - "name" : "versionB", - "in" : "path", - "description" : "The second version number", - "required" : true, - "type" : "integer", - "pattern" : "\\d+", - "format" : "int32" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlowDifference" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/buckets/{bucketId}/flows/{flowId}/versions" : { - "get" : { - "tags" : [ "bucket flows" ], - "summary" : "Get bucket flow versions", - "description" : "Gets summary information for all versions of a flow. Versions are ordered newest->oldest.", - "operationId" : "getFlowVersions", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketId", - "in" : "path", - "description" : "The bucket identifier", - "required" : true, - "type" : "string" - }, { - "name" : "flowId", - "in" : "path", - "description" : "The flow identifier", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/VersionedFlowSnapshotMetadata" - } - } - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - }, - "post" : { - "tags" : [ "bucket flows" ], - "summary" : "Create flow version", - "description" : "Creates the next version of a flow. The version number of the object being created must be the next available version integer. Flow versions are immutable after they are created.", - "operationId" : "createFlowVersion", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketId", - "in" : "path", - "description" : "The bucket identifier", - "required" : true, - "type" : "string" - }, { - "name" : "flowId", - "in" : "path", - "description" : "The flow identifier", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The new versioned flow snapshot.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/VersionedFlowSnapshot" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlowSnapshot" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "write" - } - } - }, - "/buckets/{bucketId}/flows/{flowId}/versions/import" : { - "post" : { - "tags" : [ "bucket flows" ], - "summary" : "Import flow version", - "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", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketId", - "in" : "path", - "description" : "The bucket identifier", - "required" : true, - "type" : "string" - }, { - "name" : "flowId", - "in" : "path", - "description" : "The flow identifier", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "file", - "required" : false, - "schema" : { - "$ref" : "#/definitions/VersionedFlowSnapshot" - } - }, { - "name" : "Comments", - "in" : "header", - "required" : false, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlowSnapshot" - } - }, - "201" : { - "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." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "write" - } - } - }, - "/buckets/{bucketId}/flows/{flowId}/versions/latest" : { - "get" : { - "tags" : [ "bucket flows" ], - "summary" : "Get latest bucket flow version content", - "description" : "Gets the latest version of a flow, including the metadata and content of the flow.", - "operationId" : "getLatestFlowVersion", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketId", - "in" : "path", - "description" : "The bucket identifier", - "required" : true, - "type" : "string" - }, { - "name" : "flowId", - "in" : "path", - "description" : "The flow identifier", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlowSnapshot" - } - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/buckets/{bucketId}/flows/{flowId}/versions/latest/metadata" : { - "get" : { - "tags" : [ "bucket flows" ], - "summary" : "Get latest bucket flow version metadata", - "description" : "Gets the metadata for the latest version of a flow.", - "operationId" : "getLatestFlowVersionMetadata", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketId", - "in" : "path", - "description" : "The bucket identifier", - "required" : true, - "type" : "string" - }, { - "name" : "flowId", - "in" : "path", - "description" : "The flow identifier", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlowSnapshotMetadata" - } - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/buckets/{bucketId}/flows/{flowId}/versions/{versionNumber}" : { - "get" : { - "tags" : [ "bucket flows" ], - "summary" : "Get bucket flow version", - "description" : "Gets the given version of a flow, including the metadata and content for the version.", - "operationId" : "getFlowVersion", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketId", - "in" : "path", - "description" : "The bucket identifier", - "required" : true, - "type" : "string" - }, { - "name" : "flowId", - "in" : "path", - "description" : "The flow identifier", - "required" : true, - "type" : "string" - }, { - "name" : "versionNumber", - "in" : "path", - "description" : "The version number", - "required" : true, - "type" : "integer", - "pattern" : "\\d+", - "format" : "int32" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlowSnapshot" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/buckets/{bucketId}/flows/{flowId}/versions/{versionNumber}/export" : { - "get" : { - "tags" : [ "bucket flows" ], - "summary" : "Exports specified bucket flow version content", - "description" : "Exports the specified version of a flow, including the metadata and content of the flow.", - "operationId" : "exportVersionedFlow", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketId", - "in" : "path", - "description" : "The bucket identifier", - "required" : true, - "type" : "string" - }, { - "name" : "flowId", - "in" : "path", - "description" : "The flow identifier", - "required" : true, - "type" : "string" - }, { - "name" : "versionNumber", - "in" : "path", - "description" : "The version number", - "required" : true, - "type" : "integer", - "pattern" : "\\d+", - "format" : "int32" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlowSnapshot" - } - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/bundles" : { - "get" : { - "tags" : [ "bundles" ], - "summary" : "Get all bundles", - "description" : "Gets the metadata for all bundles across all authorized buckets with optional filters applied. The returned results will include only items from buckets for which the user is authorized. If the user is not authorized to any buckets, an empty list will be returned. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getBundles", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketName", - "in" : "query", - "description" : "Optional bucket name to filter results. The value may be an exact match, or a wildcard, such as 'My Bucket%' to select all bundles where the bucket name starts with 'My Bucket'.", - "required" : false, - "type" : "string" - }, { - "name" : "groupId", - "in" : "query", - "description" : "Optional groupId to filter results. The value may be an exact match, or a wildcard, such as 'com.%' to select all bundles where the groupId starts with 'com.'.", - "required" : false, - "type" : "string" - }, { - "name" : "artifactId", - "in" : "query", - "description" : "Optional artifactId to filter results. The value may be an exact match, or a wildcard, such as 'nifi-%' to select all bundles where the artifactId starts with 'nifi-'.", - "required" : false, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/ExtensionBundle" - } - } - }, - "401" : { - "description" : "Client could not be authenticated." - } - }, - "security" : [ { - "Authorization" : [ ] - } ] - } - }, - "/bundles/versions" : { - "get" : { - "tags" : [ "bundles" ], - "summary" : "Get all bundle versions", - "description" : "Gets the metadata about extension bundle versions across all authorized buckets with optional filters applied. If the user is not authorized to any buckets, an empty list will be returned. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getBundleVersions", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "groupId", - "in" : "query", - "description" : "Optional groupId to filter results. The value may be an exact match, or a wildcard, such as 'com.%' to select all bundle versions where the groupId starts with 'com.'.", - "required" : false, - "type" : "string" - }, { - "name" : "artifactId", - "in" : "query", - "description" : "Optional artifactId to filter results. The value may be an exact match, or a wildcard, such as 'nifi-%' to select all bundle versions where the artifactId starts with 'nifi-'.", - "required" : false, - "type" : "string" - }, { - "name" : "version", - "in" : "query", - "description" : "Optional version to filter results. The value maye be an exact match, or a wildcard, such as '1.0.%' to select all bundle versions where the version starts with '1.0.'.", - "required" : false, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/BundleVersionMetadata" - } - } - }, - "401" : { - "description" : "Client could not be authenticated." - } - }, - "security" : [ { - "Authorization" : [ ] - } ] - } - }, - "/bundles/{bundleId}" : { - "get" : { - "tags" : [ "bundles" ], - "summary" : "Get bundle", - "description" : "Gets the metadata about an extension bundle. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "globalGetExtensionBundle", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bundleId", - "in" : "path", - "description" : "The extension bundle identifier", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ExtensionBundle" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - }, - "delete" : { - "tags" : [ "bundles" ], - "summary" : "Delete bundle", - "description" : "Deletes the given extension bundle and all of it's versions. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "globalDeleteExtensionBundle", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bundleId", - "in" : "path", - "description" : "The extension bundle identifier", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ExtensionBundle" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "write" - } - } - }, - "/bundles/{bundleId}/versions" : { - "get" : { - "tags" : [ "bundles" ], - "summary" : "Get bundle versions", - "description" : "Gets the metadata for the versions of the given extension bundle. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "globalGetBundleVersions", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bundleId", - "in" : "path", - "description" : "The extension bundle identifier", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/BundleVersionMetadata" - } - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/bundles/{bundleId}/versions/{version}" : { - "get" : { - "tags" : [ "bundles" ], - "summary" : "Get bundle version", - "description" : "Gets the descriptor for the given version of the given extension bundle. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "globalGetBundleVersion", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bundleId", - "in" : "path", - "description" : "The extension bundle identifier", - "required" : true, - "type" : "string" - }, { - "name" : "version", - "in" : "path", - "description" : "The version of the bundle", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/BundleVersion" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - }, - "delete" : { - "tags" : [ "bundles" ], - "summary" : "Delete bundle version", - "description" : "Deletes the given extension bundle version and it's associated binary content. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "globalDeleteBundleVersion", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bundleId", - "in" : "path", - "description" : "The extension bundle identifier", - "required" : true, - "type" : "string" - }, { - "name" : "version", - "in" : "path", - "description" : "The version of the bundle", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/BundleVersion" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "write" - } - } - }, - "/bundles/{bundleId}/versions/{version}/content" : { - "get" : { - "tags" : [ "bundles" ], - "summary" : "Get bundle version content", - "description" : "Gets the binary content for the given version of the given extension bundle. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "globalGetBundleVersionContent", - "consumes" : [ "*/*" ], - "produces" : [ "application/octet-stream" ], - "parameters" : [ { - "name" : "bundleId", - "in" : "path", - "description" : "The extension bundle identifier", - "required" : true, - "type" : "string" - }, { - "name" : "version", - "in" : "path", - "description" : "The version of the bundle", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "type" : "string", - "format" : "byte" - } - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/bundles/{bundleId}/versions/{version}/extensions" : { - "get" : { - "tags" : [ "bundles" ], - "summary" : "Get bundle version extensions", - "description" : "Gets the metadata about the extensions in the given extension bundle version. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "globalGetBundleVersionExtensions", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bundleId", - "in" : "path", - "description" : "The extension bundle identifier", - "required" : true, - "type" : "string" - }, { - "name" : "version", - "in" : "path", - "description" : "The version of the bundle", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/ExtensionMetadata" - } - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/bundles/{bundleId}/versions/{version}/extensions/{name}" : { - "get" : { - "tags" : [ "bundles" ], - "summary" : "Get bundle version extension", - "description" : "Gets the metadata about the extension with the given name in the given extension bundle version. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "globalGetBundleVersionExtension", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bundleId", - "in" : "path", - "description" : "The extension bundle identifier", - "required" : true, - "type" : "string" - }, { - "name" : "version", - "in" : "path", - "description" : "The version of the bundle", - "required" : true, - "type" : "string" - }, { - "name" : "name", - "in" : "path", - "description" : "The fully qualified name of the extension", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/Extension" - } - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/bundles/{bundleId}/versions/{version}/extensions/{name}/docs" : { - "get" : { - "tags" : [ "bundles" ], - "summary" : "Get bundle version extension docs", - "description" : "Gets the documentation for the given extension in the given extension bundle version. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getBundleVersionExtensionDocs", - "consumes" : [ "*/*" ], - "produces" : [ "text/html" ], - "parameters" : [ { - "name" : "bundleId", - "in" : "path", - "description" : "The extension bundle identifier", - "required" : true, - "type" : "string" - }, { - "name" : "version", - "in" : "path", - "description" : "The version of the bundle", - "required" : true, - "type" : "string" - }, { - "name" : "name", - "in" : "path", - "description" : "The fully qualified name of the extension", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/bundles/{bundleId}/versions/{version}/extensions/{name}/docs/additional-details" : { - "get" : { - "tags" : [ "bundles" ], - "summary" : "Get bundle version extension docs details", - "description" : "Gets the additional details documentation for the given extension in the given extension bundle version. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getBundleVersionExtensionAdditionalDetailsDocs", - "consumes" : [ "*/*" ], - "produces" : [ "text/html" ], - "parameters" : [ { - "name" : "bundleId", - "in" : "path", - "description" : "The extension bundle identifier", - "required" : true, - "type" : "string" - }, { - "name" : "version", - "in" : "path", - "description" : "The version of the bundle", - "required" : true, - "type" : "string" - }, { - "name" : "name", - "in" : "path", - "description" : "The fully qualified name of the extension", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/config" : { - "get" : { - "tags" : [ "config" ], - "summary" : "Get configration", - "description" : "Gets the NiFi Registry configurations.", - "operationId" : "getConfiguration", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/RegistryConfiguration" - } - }, - "401" : { - "description" : "Client could not be authenticated." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/policies,/tenants", - "action" : "read" - } - } - }, - "/extension-repository" : { - "get" : { - "tags" : [ "extension repository" ], - "summary" : "Get extension repo buckets", - "description" : "Gets the names of the buckets the current user is authorized for in order to browse the repo by bucket. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getExtensionRepoBuckets", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/ExtensionRepoBucket" - } - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ] - } - }, - "/extension-repository/{bucketName}" : { - "get" : { - "tags" : [ "extension repository" ], - "summary" : "Get extension repo groups", - "description" : "Gets the groups in the extension repository in the given bucket. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getExtensionRepoGroups", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketName", - "in" : "path", - "description" : "The bucket name", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/ExtensionRepoGroup" - } - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/extension-repository/{bucketName}/{groupId}" : { - "get" : { - "tags" : [ "extension repository" ], - "summary" : "Get extension repo artifacts", - "description" : "Gets the artifacts in the extension repository in the given bucket and group. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getExtensionRepoArtifacts", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketName", - "in" : "path", - "description" : "The bucket name", - "required" : true, - "type" : "string" - }, { - "name" : "groupId", - "in" : "path", - "description" : "The group id", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/ExtensionRepoArtifact" - } - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/extension-repository/{bucketName}/{groupId}/{artifactId}" : { - "get" : { - "tags" : [ "extension repository" ], - "summary" : "Get extension repo versions", - "description" : "Gets the versions in the extension repository for the given bucket, group, and artifact. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getExtensionRepoVersions", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketName", - "in" : "path", - "description" : "The bucket name", - "required" : true, - "type" : "string" - }, { - "name" : "groupId", - "in" : "path", - "description" : "The group identifier", - "required" : true, - "type" : "string" - }, { - "name" : "artifactId", - "in" : "path", - "description" : "The artifact identifier", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/ExtensionRepoVersionSummary" - } - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/extension-repository/{bucketName}/{groupId}/{artifactId}/{version}" : { - "get" : { - "tags" : [ "extension repository" ], - "summary" : "Get extension repo version", - "description" : "Gets information about the version in the given bucket, group, and artifact. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getExtensionRepoVersion", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketName", - "in" : "path", - "description" : "The bucket name", - "required" : true, - "type" : "string" - }, { - "name" : "groupId", - "in" : "path", - "description" : "The group identifier", - "required" : true, - "type" : "string" - }, { - "name" : "artifactId", - "in" : "path", - "description" : "The artifact identifier", - "required" : true, - "type" : "string" - }, { - "name" : "version", - "in" : "path", - "description" : "The version", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ExtensionRepoVersion" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/extension-repository/{bucketName}/{groupId}/{artifactId}/{version}/content" : { - "get" : { - "tags" : [ "extension repository" ], - "summary" : "Get extension repo version content", - "description" : "Gets the binary content of the bundle with the given bucket, group, artifact, and version. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getExtensionRepoVersionContent", - "consumes" : [ "*/*" ], - "produces" : [ "application/octet-stream" ], - "parameters" : [ { - "name" : "bucketName", - "in" : "path", - "description" : "The bucket name", - "required" : true, - "type" : "string" - }, { - "name" : "groupId", - "in" : "path", - "description" : "The group identifier", - "required" : true, - "type" : "string" - }, { - "name" : "artifactId", - "in" : "path", - "description" : "The artifact identifier", - "required" : true, - "type" : "string" - }, { - "name" : "version", - "in" : "path", - "description" : "The version", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "type" : "string", - "format" : "byte" - } - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/extension-repository/{bucketName}/{groupId}/{artifactId}/{version}/extensions" : { - "get" : { - "tags" : [ "extension repository" ], - "summary" : "Get extension repo extensions", - "description" : "Gets information about the extensions in the given bucket, group, artifact, and version. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getExtensionRepoVersionExtensions", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketName", - "in" : "path", - "description" : "The bucket name", - "required" : true, - "type" : "string" - }, { - "name" : "groupId", - "in" : "path", - "description" : "The group identifier", - "required" : true, - "type" : "string" - }, { - "name" : "artifactId", - "in" : "path", - "description" : "The artifact identifier", - "required" : true, - "type" : "string" - }, { - "name" : "version", - "in" : "path", - "description" : "The version", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/ExtensionMetadata" - } - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/extension-repository/{bucketName}/{groupId}/{artifactId}/{version}/extensions/{name}" : { - "get" : { - "tags" : [ "extension repository" ], - "summary" : "Get extension repo extension", - "description" : "Gets information about the extension with the given name in the given bucket, group, artifact, and version. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getExtensionRepoVersionExtension", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketName", - "in" : "path", - "description" : "The bucket name", - "required" : true, - "type" : "string" - }, { - "name" : "groupId", - "in" : "path", - "description" : "The group identifier", - "required" : true, - "type" : "string" - }, { - "name" : "artifactId", - "in" : "path", - "description" : "The artifact identifier", - "required" : true, - "type" : "string" - }, { - "name" : "version", - "in" : "path", - "description" : "The version", - "required" : true, - "type" : "string" - }, { - "name" : "name", - "in" : "path", - "description" : "The fully qualified name of the extension", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/Extension" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/extension-repository/{bucketName}/{groupId}/{artifactId}/{version}/extensions/{name}/docs" : { - "get" : { - "tags" : [ "extension repository" ], - "summary" : "Get extension repo extension docs", - "description" : "Gets the documentation for the extension with the given name in the given bucket, group, artifact, and version. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getExtensionRepoVersionExtensionDocs", - "consumes" : [ "*/*" ], - "produces" : [ "text/html" ], - "parameters" : [ { - "name" : "bucketName", - "in" : "path", - "description" : "The bucket name", - "required" : true, - "type" : "string" - }, { - "name" : "groupId", - "in" : "path", - "description" : "The group identifier", - "required" : true, - "type" : "string" - }, { - "name" : "artifactId", - "in" : "path", - "description" : "The artifact identifier", - "required" : true, - "type" : "string" - }, { - "name" : "version", - "in" : "path", - "description" : "The version", - "required" : true, - "type" : "string" - }, { - "name" : "name", - "in" : "path", - "description" : "The fully qualified name of the extension", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/extension-repository/{bucketName}/{groupId}/{artifactId}/{version}/extensions/{name}/docs/additional-details" : { - "get" : { - "tags" : [ "extension repository" ], - "summary" : "Get extension repo extension details", - "description" : "Gets the additional details documentation for the extension with the given name in the given bucket, group, artifact, and version. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getExtensionRepoVersionExtensionAdditionalDetailsDocs", - "consumes" : [ "*/*" ], - "produces" : [ "text/html" ], - "parameters" : [ { - "name" : "bucketName", - "in" : "path", - "description" : "The bucket name", - "required" : true, - "type" : "string" - }, { - "name" : "groupId", - "in" : "path", - "description" : "The group identifier", - "required" : true, - "type" : "string" - }, { - "name" : "artifactId", - "in" : "path", - "description" : "The artifact identifier", - "required" : true, - "type" : "string" - }, { - "name" : "version", - "in" : "path", - "description" : "The version", - "required" : true, - "type" : "string" - }, { - "name" : "name", - "in" : "path", - "description" : "The fully qualified name of the extension", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/extension-repository/{bucketName}/{groupId}/{artifactId}/{version}/sha256" : { - "get" : { - "tags" : [ "extension repository" ], - "summary" : "Get extension repo version checksum", - "description" : "Gets the hex representation of the SHA-256 digest for the binary content of the bundle with the given bucket, group, artifact, and version.\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getExtensionRepoVersionSha256", - "consumes" : [ "*/*" ], - "produces" : [ "text/plain" ], - "parameters" : [ { - "name" : "bucketName", - "in" : "path", - "description" : "The bucket name", - "required" : true, - "type" : "string" - }, { - "name" : "groupId", - "in" : "path", - "description" : "The group identifier", - "required" : true, - "type" : "string" - }, { - "name" : "artifactId", - "in" : "path", - "description" : "The artifact identifier", - "required" : true, - "type" : "string" - }, { - "name" : "version", - "in" : "path", - "description" : "The version", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/extension-repository/{groupId}/{artifactId}/{version}/sha256" : { - "get" : { - "tags" : [ "extension repository" ], - "summary" : "Get global extension repo version checksum", - "description" : "Gets the hex representation of the SHA-256 digest for the binary content with the given bucket, group, artifact, and version. Since the same group-artifact-version can exist in multiple buckets, this will return the checksum of the first one returned. This will be consistent since the checksum must be the same when existing in multiple buckets. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getGlobalExtensionRepoVersionSha256", - "consumes" : [ "*/*" ], - "produces" : [ "text/plain" ], - "parameters" : [ { - "name" : "groupId", - "in" : "path", - "description" : "The group identifier", - "required" : true, - "type" : "string" - }, { - "name" : "artifactId", - "in" : "path", - "description" : "The artifact identifier", - "required" : true, - "type" : "string" - }, { - "name" : "version", - "in" : "path", - "description" : "The version", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ] - } - }, - "/extensions" : { - "get" : { - "tags" : [ "extensions" ], - "summary" : "Get all extensions", - "description" : "Gets the metadata for all extensions that match the filter params and are part of bundles located in buckets the current user is authorized for. If the user is not authorized to any buckets, an empty result set will be returned.\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getExtensions", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bundleType", - "in" : "query", - "description" : "The type of bundles to return", - "required" : false, - "type" : "string", - "enum" : [ "nifi-nar", "minifi-cpp" ] - }, { - "name" : "extensionType", - "in" : "query", - "description" : "The type of extensions to return", - "required" : false, - "type" : "string", - "enum" : [ "PROCESSOR", "CONTROLLER_SERVICE", "REPORTING_TASK" ] - }, { - "name" : "tag", - "in" : "query", - "description" : "The tags to filter on, will be used in an OR statement", - "required" : false, - "type" : "array", - "items" : { - "type" : "string" - }, - "collectionFormat" : "multi" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ExtensionMetadataContainer" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ] - } - }, - "/extensions/provided-service-api" : { - "get" : { - "tags" : [ "extensions" ], - "summary" : "Get extensions providing service API", - "description" : "Gets the metadata for extensions that provide the specified API and are part of bundles located in buckets the current user is authorized for. If the user is not authorized to any buckets, an empty result set will be returned.\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getExtensionsProvidingServiceAPI", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "className", - "in" : "query", - "description" : "The name of the service API class", - "required" : true, - "type" : "string" - }, { - "name" : "groupId", - "in" : "query", - "description" : "The groupId of the bundle containing the service API class", - "required" : true, - "type" : "string" - }, { - "name" : "artifactId", - "in" : "query", - "description" : "The artifactId of the bundle containing the service API class", - "required" : true, - "type" : "string" - }, { - "name" : "version", - "in" : "query", - "description" : "The version of the bundle containing the service API class", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ExtensionMetadataContainer" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ] - } - }, - "/extensions/tags" : { - "get" : { - "tags" : [ "extensions" ], - "summary" : "Get extension tags", - "description" : "Gets all the extension tags known to this NiFi Registry instance, along with the number of extensions that have the given tag.\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getTags", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/TagCount" - } - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ] - } - }, - "/flows/fields" : { - "get" : { - "tags" : [ "flows" ], - "summary" : "Get flow fields", - "description" : "Retrieves the flow field names that can be used for searching or sorting on flows.", - "operationId" : "getAvailableFlowFields", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/Fields" - } - } - }, - "security" : [ { - "Authorization" : [ ] - } ] - } - }, - "/flows/{flowId}" : { - "get" : { - "tags" : [ "flows" ], - "summary" : "Get flow", - "description" : "Gets a flow by id.", - "operationId" : "globalGetFlow", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "flowId", - "in" : "path", - "description" : "The flow identifier", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlow" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/flows/{flowId}/versions" : { - "get" : { - "tags" : [ "flows" ], - "summary" : "Get flow versions", - "description" : "Gets summary information for all versions of a given flow. Versions are ordered newest->oldest.", - "operationId" : "globalGetFlowVersions", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "flowId", - "in" : "path", - "description" : "The flow identifier", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/VersionedFlowSnapshotMetadata" - } - } - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/flows/{flowId}/versions/latest" : { - "get" : { - "tags" : [ "flows" ], - "summary" : "Get latest flow version", - "description" : "Gets the latest version of a flow, including metadata and flow content.", - "operationId" : "globalGetLatestFlowVersion", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "flowId", - "in" : "path", - "description" : "The flow identifier", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlowSnapshot" - } - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/flows/{flowId}/versions/latest/metadata" : { - "get" : { - "tags" : [ "flows" ], - "summary" : "Get latest flow version metadata", - "description" : "Gets the metadata for the latest version of a flow.", - "operationId" : "globalGetLatestFlowVersionMetadata", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "flowId", - "in" : "path", - "description" : "The flow identifier", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlowSnapshotMetadata" - } - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/flows/{flowId}/versions/{versionNumber}" : { - "get" : { - "tags" : [ "flows" ], - "summary" : "Get flow version", - "description" : "Gets the given version of a flow, including metadata and flow content.", - "operationId" : "globalGetFlowVersion", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "flowId", - "in" : "path", - "description" : "The flow identifier", - "required" : true, - "type" : "string" - }, { - "name" : "versionNumber", - "in" : "path", - "description" : "The version number", - "required" : true, - "type" : "integer", - "pattern" : "\\d+", - "format" : "int32" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlowSnapshot" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/items" : { - "get" : { - "tags" : [ "items" ], - "summary" : "Get all items", - "description" : "Get items across all buckets. The returned items will include only items from buckets for which the user is authorized. If the user is not authorized to any buckets, an empty list will be returned.", - "operationId" : "getItems", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/BucketItem" - } - } - }, - "401" : { - "description" : "Client could not be authenticated." - } - }, - "security" : [ { - "Authorization" : [ ] - } ] - } - }, - "/items/fields" : { - "get" : { - "tags" : [ "items" ], - "summary" : "Get item fields", - "description" : "Retrieves the item field names for searching or sorting on bucket items.", - "operationId" : "getAvailableBucketItemFields", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/Fields" - } - } - }, - "security" : [ { - "Authorization" : [ ] - } ] - } - }, - "/items/{bucketId}" : { - "get" : { - "tags" : [ "items" ], - "summary" : "Get bucket items", - "description" : "Gets the items located in the given bucket.", - "operationId" : "getItemsInBucket", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketId", - "in" : "path", - "description" : "The bucket identifier", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/BucketItem" - } - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/policies" : { - "get" : { - "tags" : [ "policies" ], - "summary" : "Get all access policies", - "description" : "", - "operationId" : "getAccessPolicies", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/AccessPolicy" - } - } - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/policies", - "action" : "read" - } - }, - "post" : { - "tags" : [ "policies" ], - "summary" : "Create access policy", - "description" : "", - "operationId" : "createAccessPolicy", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The access policy configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/AccessPolicy" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/AccessPolicy" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid. The NiFi Registry might not be configured to use a ConfigurableAccessPolicyProvider." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/policies", - "action" : "write" - } - } - }, - "/policies/resources" : { - "get" : { - "tags" : [ "policies" ], - "summary" : "Get available resources", - "description" : "Gets the available resources that support access/authorization policies", - "operationId" : "getResources", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/Resource" - } - } - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/policies", - "action" : "read" - } - } - }, - "/policies/{action}/{resource}" : { - "get" : { - "tags" : [ "policies" ], - "summary" : "Get access policy for resource", - "description" : "Gets an access policy for the specified action and resource", - "operationId" : "getAccessPolicyForResource", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "action", - "in" : "path", - "description" : "The request action.", - "required" : true, - "type" : "string", - "enum" : [ "read", "write", "delete" ] - }, { - "name" : "resource", - "in" : "path", - "description" : "The resource of the policy.", - "required" : true, - "type" : "string", - "pattern" : ".+" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/AccessPolicy" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/policies", - "action" : "read" - } - } - }, - "/policies/{id}" : { - "get" : { - "tags" : [ "policies" ], - "summary" : "Get access policy", - "description" : "", - "operationId" : "getAccessPolicy", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The access policy id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/AccessPolicy" - } - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/policies", - "action" : "read" - } - }, - "put" : { - "tags" : [ "policies" ], - "summary" : "Update access policy", - "description" : "", - "operationId" : "updateAccessPolicy", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The access policy id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The access policy configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/AccessPolicy" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/AccessPolicy" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid. The NiFi Registry might not be configured to use a ConfigurableAccessPolicyProvider." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/policies", - "action" : "write" - } - }, - "delete" : { - "tags" : [ "policies" ], - "summary" : "Delete access policy", - "description" : "", - "operationId" : "removeAccessPolicy", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The version is used to verify the client is working with the latest version of the entity.", - "required" : true, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The access policy id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/AccessPolicy" - } - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid. The NiFi Registry might not be configured to use a ConfigurableAccessPolicyProvider." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/policies", - "action" : "delete" - } - } - }, - "/tenants/user-groups" : { - "get" : { - "tags" : [ "tenants" ], - "summary" : "Get user groups", - "description" : "\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getUserGroups", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/UserGroup" - } - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/tenants", - "action" : "read" - } - }, - "post" : { - "tags" : [ "tenants" ], - "summary" : "Create user group", - "description" : "\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "createUserGroup", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The user group configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/UserGroup" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/UserGroup" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/tenants", - "action" : "write" - } - } - }, - "/tenants/user-groups/{id}" : { - "get" : { - "tags" : [ "tenants" ], - "summary" : "Get user group", - "description" : "\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getUserGroup", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The user group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/UserGroup" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/tenants", - "action" : "read" - } - }, - "put" : { - "tags" : [ "tenants" ], - "summary" : "Update user group", - "description" : "\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "updateUserGroup", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The user group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The user group configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/UserGroup" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/UserGroup" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/tenants", - "action" : "write" - } - }, - "delete" : { - "tags" : [ "tenants" ], - "summary" : "Delete user group", - "description" : "\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "removeUserGroup", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The version is used to verify the client is working with the latest version of the entity.", - "required" : true, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The user group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/UserGroup" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/tenants", - "action" : "delete" - } - } - }, - "/tenants/users" : { - "get" : { - "tags" : [ "tenants" ], - "summary" : "Get all users", - "description" : "\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getUsers", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/User" - } - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/tenants", - "action" : "read" - } - }, - "post" : { - "tags" : [ "tenants" ], - "summary" : "Create user", - "description" : "\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "createUser", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The user configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/User" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/User" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/tenants", - "action" : "write" - } - } - }, - "/tenants/users/{id}" : { - "get" : { - "tags" : [ "tenants" ], - "summary" : "Get user", - "description" : "\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getUser", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The user id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/User" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/tenants", - "action" : "read" - } - }, - "put" : { - "tags" : [ "tenants" ], - "summary" : "Update user", - "description" : "\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "updateUser", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The user id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The user configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/User" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/User" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/tenants", - "action" : "write" - } - }, - "delete" : { - "tags" : [ "tenants" ], - "summary" : "Delete user", - "description" : "\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "removeUser", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The version is used to verify the client is working with the latest version of the entity.", - "required" : true, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The user id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/User" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/tenants", - "action" : "delete" - } - } - } - }, - "securityDefinitions" : { - "Authorization" : { - "description" : "NiFi Registry Auth Token (JWT)", - "type" : "apiKey", - "name" : "Authorization", - "in" : "header" - }, - "BasicAuth" : { - "description" : "HTTP Basic Auth", - "type" : "basic" - } - }, - "definitions" : { - "AccessPolicy" : { - "type" : "object", - "required" : [ "action", "resource" ], - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The id of the policy. Set by server at creation time.", - "readOnly" : true - }, - "resource" : { - "type" : "string", - "description" : "The resource for this access policy." - }, - "action" : { - "type" : "string", - "description" : "The action associated with this access policy.", - "enum" : [ "read", "write", "delete" ] - }, - "configurable" : { - "type" : "boolean", - "description" : "Indicates if this access policy is configurable, based on which Authorizer has been configured to manage it.", - "readOnly" : true - }, - "revision" : { - "description" : "The revision of this entity used for optimistic-locking during updates.", - "readOnly" : true, - "$ref" : "#/definitions/RevisionInfo" - }, - "users" : { - "type" : "array", - "description" : "The set of user IDs associated with this access policy.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/Tenant" - } - }, - "userGroups" : { - "type" : "array", - "description" : "The set of user group IDs associated with this access policy.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/Tenant" - } - } - } - }, - "AccessPolicySummary" : { - "type" : "object", - "required" : [ "action", "resource" ], - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The id of the policy. Set by server at creation time.", - "readOnly" : true - }, - "resource" : { - "type" : "string", - "description" : "The resource for this access policy." - }, - "action" : { - "type" : "string", - "description" : "The action associated with this access policy.", - "enum" : [ "read", "write", "delete" ] - }, - "configurable" : { - "type" : "boolean", - "description" : "Indicates if this access policy is configurable, based on which Authorizer has been configured to manage it.", - "readOnly" : true - }, - "revision" : { - "description" : "The revision of this entity used for optimistic-locking during updates.", - "readOnly" : true, - "$ref" : "#/definitions/RevisionInfo" - } - } - }, - "AllowableValue" : { - "type" : "object", - "properties" : { - "value" : { - "type" : "string", - "description" : "The value of the allowable value" - }, - "displayName" : { - "type" : "string", - "description" : "The display name of the allowable value" - }, - "description" : { - "type" : "string", - "description" : "The description of the allowable value" - } - } - }, - "Attribute" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The name of the attribute" - }, - "description" : { - "type" : "string", - "description" : "The description of the attribute" - } - } - }, - "BatchSize" : { - "type" : "object", - "properties" : { - "count" : { - "type" : "integer", - "format" : "int32", - "description" : "Preferred number of flow files to include in a transaction." - }, - "size" : { - "type" : "string", - "description" : "Preferred number of bytes to include in a transaction." - }, - "duration" : { - "type" : "string", - "description" : "Preferred amount of time that a transaction should span." - } - } - }, - "Bucket" : { - "type" : "object", - "required" : [ "name" ], - "properties" : { - "link" : { - "description" : "An WebLink to this entity.", - "readOnly" : true, - "$ref" : "#/definitions/JaxbLink" - }, - "identifier" : { - "type" : "string", - "description" : "An ID to uniquely identify this object.", - "readOnly" : true - }, - "name" : { - "type" : "string", - "description" : "The name of the bucket." - }, - "createdTimestamp" : { - "type" : "integer", - "format" : "int64", - "description" : "The timestamp of when the bucket was first created. This is set by the server at creation time.", - "readOnly" : true, - "minimum" : 1 - }, - "description" : { - "type" : "string", - "description" : "A description of the bucket." - }, - "allowBundleRedeploy" : { - "type" : "boolean", - "description" : "Indicates if this bucket allows the same version of an extension bundle to be redeployed and thus overwrite the existing artifact. By default this is false." - }, - "allowPublicRead" : { - "type" : "boolean", - "description" : "Indicates if this bucket allows read access to unauthenticated anonymous users" - }, - "permissions" : { - "description" : "The access that the current user has to this bucket.", - "readOnly" : true, - "$ref" : "#/definitions/Permissions" - }, - "revision" : { - "description" : "The revision of this entity used for optimistic-locking during updates.", - "readOnly" : true, - "$ref" : "#/definitions/RevisionInfo" - } - } - }, - "BucketItem" : { - "type" : "object", - "required" : [ "bucketIdentifier", "name", "type" ], - "properties" : { - "link" : { - "description" : "An WebLink to this entity.", - "readOnly" : true, - "$ref" : "#/definitions/JaxbLink" - }, - "identifier" : { - "type" : "string", - "description" : "An ID to uniquely identify this object.", - "readOnly" : true - }, - "name" : { - "type" : "string", - "description" : "The name of the item." - }, - "description" : { - "type" : "string", - "description" : "A description of the item." - }, - "bucketIdentifier" : { - "type" : "string", - "description" : "The identifier of the bucket this items belongs to. This cannot be changed after the item is created." - }, - "bucketName" : { - "type" : "string", - "description" : "The name of the bucket this items belongs to.", - "readOnly" : true - }, - "createdTimestamp" : { - "type" : "integer", - "format" : "int64", - "description" : "The timestamp of when the item was created, as milliseconds since epoch.", - "readOnly" : true, - "minimum" : 1 - }, - "modifiedTimestamp" : { - "type" : "integer", - "format" : "int64", - "description" : "The timestamp of when the item was last modified, as milliseconds since epoch.", - "readOnly" : true, - "minimum" : 1 - }, - "type" : { - "type" : "string", - "description" : "The type of item.", - "enum" : [ "Flow", "Bundle" ] - }, - "permissions" : { - "description" : "The access that the current user has to the bucket containing this item.", - "readOnly" : true, - "$ref" : "#/definitions/Permissions" - } - } - }, - "BuildInfo" : { - "type" : "object", - "properties" : { - "buildTool" : { - "type" : "string", - "description" : "The tool used to build the version of the bundle" - }, - "buildFlags" : { - "type" : "string", - "description" : "The flags used to build the version of the bundle" - }, - "buildBranch" : { - "type" : "string", - "description" : "The branch used to build the version of the bundle" - }, - "buildTag" : { - "type" : "string", - "description" : "The tag used to build the version of the bundle" - }, - "buildRevision" : { - "type" : "string", - "description" : "The revision used to build the version of the bundle" - }, - "built" : { - "type" : "integer", - "format" : "int64", - "description" : "The timestamp the version of the bundle was built" - }, - "builtBy" : { - "type" : "string", - "description" : "The identity of the user that performed the build" - } - } - }, - "Bundle" : { - "type" : "object", - "properties" : { - "group" : { - "type" : "string", - "description" : "The group of the bundle" - }, - "artifact" : { - "type" : "string", - "description" : "The artifact of the bundle" - }, - "version" : { - "type" : "string", - "description" : "The version of the bundle" - } - } - }, - "BundleInfo" : { - "type" : "object", - "properties" : { - "bucketId" : { - "type" : "string", - "description" : "The id of the bucket where the bundle is located" - }, - "bucketName" : { - "type" : "string", - "description" : "The name of the bucket where the bundle is located" - }, - "bundleId" : { - "type" : "string", - "description" : "The id of the bundle" - }, - "bundleType" : { - "type" : "string", - "description" : "The type of bundle (i.e. a NiFi NAR vs MiNiFi CPP)", - "enum" : [ "NIFI_NAR", "MINIFI_CPP" ] - }, - "groupId" : { - "type" : "string", - "description" : "The group id of the bundle" - }, - "artifactId" : { - "type" : "string", - "description" : "The artifact id of the bundle" - }, - "version" : { - "type" : "string", - "description" : "The version of the bundle" - }, - "systemApiVersion" : { - "type" : "string", - "description" : "The version of the system API the bundle was built against" - } - } - }, - "BundleVersion" : { - "type" : "object", - "required" : [ "versionMetadata" ], - "properties" : { - "link" : { - "description" : "An WebLink to this entity.", - "readOnly" : true, - "$ref" : "#/definitions/JaxbLink" - }, - "versionMetadata" : { - "description" : "The metadata about this version of the extension bundle", - "$ref" : "#/definitions/BundleVersionMetadata" - }, - "dependencies" : { - "type" : "array", - "description" : "The set of other bundle versions that this version is dependent on", - "readOnly" : true, - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/BundleVersionDependency" - } - }, - "bundle" : { - "description" : "The bundle this version is for", - "readOnly" : true, - "$ref" : "#/definitions/ExtensionBundle" - }, - "bucket" : { - "description" : "The bucket that the extension bundle belongs to", - "$ref" : "#/definitions/Bucket" - }, - "filename" : { - "type" : "string" - } - } - }, - "BundleVersionDependency" : { - "type" : "object", - "properties" : { - "groupId" : { - "type" : "string", - "description" : "The group id of the bundle dependency" - }, - "artifactId" : { - "type" : "string", - "description" : "The artifact id of the bundle dependency" - }, - "version" : { - "type" : "string", - "description" : "The version of the bundle dependency" - } - } - }, - "BundleVersionMetadata" : { - "type" : "object", - "required" : [ "bucketId", "buildInfo", "contentSize", "sha256Supplied" ], - "properties" : { - "link" : { - "description" : "An WebLink to this entity.", - "readOnly" : true, - "$ref" : "#/definitions/JaxbLink" - }, - "id" : { - "type" : "string", - "description" : "The id of this version of the extension bundle" - }, - "bundleId" : { - "type" : "string", - "description" : "The id of the extension bundle this version is for" - }, - "bucketId" : { - "type" : "string", - "description" : "The id of the bucket the extension bundle belongs to" - }, - "groupId" : { - "type" : "string" - }, - "artifactId" : { - "type" : "string" - }, - "version" : { - "type" : "string", - "description" : "The version of the extension bundle" - }, - "timestamp" : { - "type" : "integer", - "format" : "int64", - "description" : "The timestamp of the create date of this version", - "minimum" : 1 - }, - "author" : { - "type" : "string", - "description" : "The identity that created this version" - }, - "description" : { - "type" : "string", - "description" : "The description for this version" - }, - "sha256" : { - "type" : "string", - "description" : "The hex representation of the SHA-256 digest of the binary content for this version" - }, - "sha256Supplied" : { - "type" : "boolean", - "description" : "Whether or not the client supplied a SHA-256 when uploading the bundle" - }, - "contentSize" : { - "type" : "integer", - "format" : "int64", - "description" : "The size of the binary content for this version in bytes", - "minimum" : 0 - }, - "systemApiVersion" : { - "type" : "string", - "description" : "The version of the system API that this bundle version was built against" - }, - "buildInfo" : { - "description" : "The build information about this version", - "$ref" : "#/definitions/BuildInfo" - } - } - }, - "ComponentDifference" : { - "type" : "object", - "properties" : { - "valueA" : { - "type" : "string", - "description" : "The earlier value from the difference." - }, - "valueB" : { - "type" : "string", - "description" : "The newer value from the difference." - }, - "changeDescription" : { - "type" : "string", - "description" : "The description of the change." - }, - "differenceType" : { - "type" : "string", - "description" : "The key to the difference." - }, - "differenceTypeDescription" : { - "type" : "string", - "description" : "The description of the change type." - } - } - }, - "ComponentDifferenceGroup" : { - "type" : "object", - "properties" : { - "componentId" : { - "type" : "string", - "description" : "The id of the component whose changes are grouped together." - }, - "componentName" : { - "type" : "string", - "description" : "The name of the component whose changes are grouped together." - }, - "componentType" : { - "type" : "string", - "description" : "The type of component these changes relate to." - }, - "processGroupId" : { - "type" : "string", - "description" : "The process group id for this component." - }, - "differences" : { - "type" : "array", - "description" : "The list of changes related to this component between the 2 versions.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ComponentDifference" - } - } - } - }, - "ConnectableComponent" : { - "type" : "object", - "required" : [ "groupId", "id", "type" ], - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the connectable component." - }, - "type" : { - "type" : "string", - "description" : "The type of component the connectable is.", - "enum" : [ "PROCESSOR", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "INPUT_PORT", "OUTPUT_PORT", "FUNNEL" ] - }, - "groupId" : { - "type" : "string", - "description" : "The id of the group that the connectable component resides in" - }, - "name" : { - "type" : "string", - "description" : "The name of the connectable component" - }, - "comments" : { - "type" : "string", - "description" : "The comments for the connectable component." - }, - "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" - } - } - }, - "ControllerServiceAPI" : { - "type" : "object", - "properties" : { - "type" : { - "type" : "string", - "description" : "The fully qualified name of the service interface." - }, - "bundle" : { - "description" : "The details of the artifact that bundled this service interface.", - "$ref" : "#/definitions/Bundle" - } - } - }, - "ControllerServiceDefinition" : { - "type" : "object", - "properties" : { - "className" : { - "type" : "string", - "description" : "The class name of the service API" - }, - "groupId" : { - "type" : "string", - "description" : "The group id of the service API" - }, - "artifactId" : { - "type" : "string", - "description" : "The artifact id of the service API" - }, - "version" : { - "type" : "string", - "description" : "The version of the service API" - } - } - }, - "CurrentUser" : { - "type" : "object", - "properties" : { - "identity" : { - "type" : "string", - "description" : "The identity of the current user", - "readOnly" : true - }, - "anonymous" : { - "type" : "boolean", - "description" : "Indicates if the current user is anonymous", - "readOnly" : true - }, - "loginSupported" : { - "type" : "boolean", - "description" : "Indicates if the NiFi Registry instance supports logging in" - }, - "resourcePermissions" : { - "description" : "The access that the current user has to top level resources", - "readOnly" : true, - "$ref" : "#/definitions/ResourcePermissions" - }, - "oidcloginSupported" : { - "type" : "boolean", - "description" : "Indicates if the NiFi Registry instance supports logging in with an OIDC provider" - } - } - }, - "DefaultSchedule" : { - "type" : "object", - "properties" : { - "strategy" : { - "type" : "string", - "description" : "The default scheduling strategy" - }, - "period" : { - "type" : "string", - "description" : "The default scheduling period" - }, - "concurrentTasks" : { - "type" : "string", - "description" : "The default concurrent tasks" - } - } - }, - "DefaultSettings" : { - "type" : "object", - "properties" : { - "yieldDuration" : { - "type" : "string", - "description" : "The default yield duration" - }, - "penaltyDuration" : { - "type" : "string", - "description" : "The default penalty duration" - }, - "bulletinLevel" : { - "type" : "string", - "description" : "The default bulletin level" - } - } - }, - "Dependency" : { - "type" : "object", - "properties" : { - "propertyName" : { - "type" : "string", - "description" : "The name of the dependent property" - }, - "propertyDisplayName" : { - "type" : "string", - "description" : "The display name of the dependent property" - }, - "dependentValues" : { - "description" : "The values of the dependent property that enable the depending property", - "$ref" : "#/definitions/DependentValues" - } - } - }, - "DependentValues" : { - "type" : "object", - "properties" : { - "values" : { - "type" : "array", - "xml" : { - "name" : "dependentValue" - }, - "description" : "The dependent values", - "items" : { - "type" : "string", - "xml" : { - "name" : "dependentValue" - } - } - } - } - }, - "DeprecationNotice" : { - "type" : "object", - "properties" : { - "reason" : { - "type" : "string", - "description" : "The reason for the deprecation" - }, - "alternatives" : { - "type" : "array", - "xml" : { - "wrapped" : true - }, - "description" : "The alternatives to use", - "items" : { - "type" : "string", - "xml" : { - "name" : "alternative" - } - } - } - } - }, - "DynamicProperty" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The description of the dynamic property name" - }, - "value" : { - "type" : "string", - "description" : "The description of the dynamic property value" - }, - "description" : { - "type" : "string", - "description" : "The description of the dynamic property" - }, - "expressionLanguageScope" : { - "type" : "string", - "description" : "The scope of the expression language support", - "enum" : [ "NONE", "VARIABLE_REGISTRY", "FLOWFILE_ATTRIBUTES" ] - }, - "expressionLanguageSupported" : { - "type" : "boolean", - "description" : "Whether or not expression language is supported" - } - } - }, - "DynamicRelationship" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The description of the dynamic relationship name" - }, - "description" : { - "type" : "string", - "description" : "The description of the dynamic relationship" - } - } - }, - "Extension" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The name of the extension" - }, - "type" : { - "type" : "string", - "description" : "The type of the extension", - "enum" : [ "PROCESSOR", "CONTROLLER_SERVICE", "REPORTING_TASK" ] - }, - "deprecationNotice" : { - "description" : "The deprecation notice of the extension", - "$ref" : "#/definitions/DeprecationNotice" - }, - "description" : { - "type" : "string", - "description" : "The description of the extension" - }, - "tags" : { - "type" : "array", - "xml" : { - "wrapped" : true - }, - "description" : "The tags of the extension", - "items" : { - "type" : "string", - "xml" : { - "name" : "tag" - } - } - }, - "properties" : { - "type" : "array", - "xml" : { - "wrapped" : true - }, - "description" : "The properties of the extension", - "items" : { - "xml" : { - "name" : "property" - }, - "$ref" : "#/definitions/Property" - } - }, - "dynamicProperties" : { - "type" : "array", - "xml" : { - "wrapped" : true - }, - "description" : "The dynamic properties of the extension", - "items" : { - "xml" : { - "name" : "dynamicProperty" - }, - "$ref" : "#/definitions/DynamicProperty" - } - }, - "relationships" : { - "type" : "array", - "xml" : { - "wrapped" : true - }, - "description" : "The relationships of the extension", - "items" : { - "xml" : { - "name" : "relationship" - }, - "$ref" : "#/definitions/Relationship" - } - }, - "dynamicRelationship" : { - "description" : "The dynamic relationships of the extension", - "$ref" : "#/definitions/DynamicRelationship" - }, - "readsAttributes" : { - "type" : "array", - "xml" : { - "wrapped" : true - }, - "description" : "The attributes read from flow files by the extension", - "items" : { - "xml" : { - "name" : "readsAttribute" - }, - "$ref" : "#/definitions/Attribute" - } - }, - "writesAttributes" : { - "type" : "array", - "xml" : { - "wrapped" : true - }, - "description" : "The attributes written to flow files by the extension", - "items" : { - "xml" : { - "name" : "writesAttribute" - }, - "$ref" : "#/definitions/Attribute" - } - }, - "stateful" : { - "description" : "The information about how the extension stores state", - "$ref" : "#/definitions/Stateful" - }, - "restricted" : { - "description" : "The restrictions of the extension", - "$ref" : "#/definitions/Restricted" - }, - "inputRequirement" : { - "type" : "string", - "description" : "The input requirement of the extension", - "enum" : [ "INPUT_REQUIRED", "INPUT_ALLOWED", "INPUT_FORBIDDEN" ] - }, - "systemResourceConsiderations" : { - "type" : "array", - "xml" : { - "wrapped" : true - }, - "description" : "The resource considerations of the extension", - "items" : { - "xml" : { - "name" : "systemResourceConsideration" - }, - "$ref" : "#/definitions/SystemResourceConsideration" - } - }, - "seeAlso" : { - "type" : "array", - "xml" : { - "wrapped" : true - }, - "description" : "The names of other extensions to see", - "items" : { - "type" : "string", - "xml" : { - "name" : "see" - } - } - }, - "providedServiceAPIs" : { - "type" : "array", - "xml" : { - "wrapped" : true - }, - "description" : "The service APIs provided by this extension", - "items" : { - "xml" : { - "name" : "providedServiceAPI" - }, - "$ref" : "#/definitions/ProvidedServiceAPI" - } - }, - "defaultSettings" : { - "description" : "The default settings for a processor", - "$ref" : "#/definitions/DefaultSettings" - }, - "defaultSchedule" : { - "description" : "The default schedule for a processor reporting task", - "$ref" : "#/definitions/DefaultSchedule" - }, - "triggerSerially" : { - "type" : "boolean", - "description" : "Indicates that a processor should be triggered serially" - }, - "triggerWhenEmpty" : { - "type" : "boolean", - "description" : "Indicates that a processor should be triggered when the incoming queues are empty" - }, - "triggerWhenAnyDestinationAvailable" : { - "type" : "boolean", - "description" : "Indicates that a processor should be triggered when any destinations have space for flow files" - }, - "supportsBatching" : { - "type" : "boolean", - "description" : "Indicates that a processor supports batching" - }, - "eventDriven" : { - "type" : "boolean", - "description" : "Indicates that a processor supports event driven scheduling" - }, - "primaryNodeOnly" : { - "type" : "boolean", - "description" : "Indicates that a processor should be scheduled only on the primary node" - }, - "sideEffectFree" : { - "type" : "boolean", - "description" : "Indicates that a processor is side effect free" - } - } - }, - "ExtensionBundle" : { - "type" : "object", - "required" : [ "bucketIdentifier", "bundleType", "name", "type" ], - "properties" : { - "link" : { - "description" : "An WebLink to this entity.", - "readOnly" : true, - "$ref" : "#/definitions/JaxbLink" - }, - "identifier" : { - "type" : "string", - "description" : "An ID to uniquely identify this object.", - "readOnly" : true - }, - "name" : { - "type" : "string", - "description" : "The name of the item." - }, - "description" : { - "type" : "string", - "description" : "A description of the item." - }, - "bucketIdentifier" : { - "type" : "string", - "description" : "The identifier of the bucket this items belongs to. This cannot be changed after the item is created." - }, - "bucketName" : { - "type" : "string", - "description" : "The name of the bucket this items belongs to.", - "readOnly" : true - }, - "createdTimestamp" : { - "type" : "integer", - "format" : "int64", - "description" : "The timestamp of when the item was created, as milliseconds since epoch.", - "readOnly" : true, - "minimum" : 1 - }, - "modifiedTimestamp" : { - "type" : "integer", - "format" : "int64", - "description" : "The timestamp of when the item was last modified, as milliseconds since epoch.", - "readOnly" : true, - "minimum" : 1 - }, - "type" : { - "type" : "string", - "description" : "The type of item.", - "enum" : [ "Flow", "Bundle" ] - }, - "permissions" : { - "description" : "The access that the current user has to the bucket containing this item.", - "readOnly" : true, - "$ref" : "#/definitions/Permissions" - }, - "bundleType" : { - "type" : "string", - "description" : "The type of the extension bundle", - "enum" : [ "NIFI_NAR", "MINIFI_CPP" ] - }, - "groupId" : { - "type" : "string", - "description" : "The group id of the extension bundle" - }, - "artifactId" : { - "type" : "string", - "description" : "The artifact id of the extension bundle" - }, - "versionCount" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of versions of this extension bundle.", - "readOnly" : true, - "minimum" : 0 - } - } - }, - "ExtensionFilterParams" : { - "type" : "object", - "properties" : { - "bundleType" : { - "type" : "string", - "description" : "The type of bundle", - "enum" : [ "NIFI_NAR", "MINIFI_CPP" ] - }, - "extensionType" : { - "type" : "string", - "description" : "The type of extension", - "enum" : [ "PROCESSOR", "CONTROLLER_SERVICE", "REPORTING_TASK" ] - }, - "tags" : { - "type" : "array", - "description" : "The tags", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - } - } - }, - "ExtensionMetadata" : { - "type" : "object", - "properties" : { - "link" : { - "description" : "An WebLink to this entity.", - "readOnly" : true, - "$ref" : "#/definitions/JaxbLink" - }, - "name" : { - "type" : "string", - "description" : "The name of the extension" - }, - "displayName" : { - "type" : "string", - "description" : "The display name of the extension" - }, - "type" : { - "type" : "string", - "description" : "The type of the extension", - "enum" : [ "PROCESSOR", "CONTROLLER_SERVICE", "REPORTING_TASK" ] - }, - "description" : { - "type" : "string", - "description" : "The description of the extension" - }, - "deprecationNotice" : { - "description" : "The deprecation notice of the extension", - "$ref" : "#/definitions/DeprecationNotice" - }, - "tags" : { - "type" : "array", - "description" : "The tags of the extension", - "items" : { - "type" : "string" - } - }, - "restricted" : { - "description" : "The restrictions of the extension", - "$ref" : "#/definitions/Restricted" - }, - "providedServiceAPIs" : { - "type" : "array", - "description" : "The service APIs provided by the extension", - "items" : { - "$ref" : "#/definitions/ProvidedServiceAPI" - } - }, - "bundleInfo" : { - "description" : "The information for the bundle where this extension is located", - "$ref" : "#/definitions/BundleInfo" - }, - "hasAdditionalDetails" : { - "type" : "boolean", - "description" : "Whether or not the extension has additional detail documentation" - }, - "linkDocs" : { - "description" : "A WebLink to the documentation for this extension.", - "readOnly" : true, - "$ref" : "#/definitions/JaxbLink" - } - } - }, - "ExtensionMetadataContainer" : { - "type" : "object", - "properties" : { - "numResults" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of extensions in the response" - }, - "filterParams" : { - "description" : "The filter parameters submitted for the request", - "$ref" : "#/definitions/ExtensionFilterParams" - }, - "extensions" : { - "type" : "array", - "description" : "The metadata for the extensions", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ExtensionMetadata" - } - } - } - }, - "ExtensionRepoArtifact" : { - "type" : "object", - "properties" : { - "link" : { - "description" : "An WebLink to this entity.", - "readOnly" : true, - "$ref" : "#/definitions/JaxbLink" - }, - "bucketName" : { - "type" : "string", - "description" : "The bucket name" - }, - "groupId" : { - "type" : "string", - "description" : "The group id" - }, - "artifactId" : { - "type" : "string", - "description" : "The artifact id" - } - } - }, - "ExtensionRepoBucket" : { - "type" : "object", - "properties" : { - "link" : { - "description" : "An WebLink to this entity.", - "readOnly" : true, - "$ref" : "#/definitions/JaxbLink" - }, - "bucketName" : { - "type" : "string", - "description" : "The name of the bucket" - } - } - }, - "ExtensionRepoGroup" : { - "type" : "object", - "properties" : { - "link" : { - "description" : "An WebLink to this entity.", - "readOnly" : true, - "$ref" : "#/definitions/JaxbLink" - }, - "bucketName" : { - "type" : "string", - "description" : "The bucket name" - }, - "groupId" : { - "type" : "string", - "description" : "The group id" - } - } - }, - "ExtensionRepoVersion" : { - "type" : "object", - "properties" : { - "extensionsLink" : { - "description" : "The WebLink to view the metadata about the extensions contained in the extension bundle.", - "readOnly" : true, - "$ref" : "#/definitions/JaxbLink" - }, - "downloadLink" : { - "description" : "The WebLink to download this version of the extension bundle.", - "readOnly" : true, - "$ref" : "#/definitions/JaxbLink" - }, - "sha256Link" : { - "description" : "The WebLink to retrieve the SHA-256 digest for this version of the extension bundle.", - "readOnly" : true, - "$ref" : "#/definitions/JaxbLink" - }, - "sha256Supplied" : { - "description" : "Indicates if the client supplied a SHA-256 when uploading this version of the extension bundle.", - "readOnly" : true, - "$ref" : "#/definitions/JaxbLink" - } - } - }, - "ExtensionRepoVersionSummary" : { - "type" : "object", - "properties" : { - "link" : { - "description" : "An WebLink to this entity.", - "readOnly" : true, - "$ref" : "#/definitions/JaxbLink" - }, - "bucketName" : { - "type" : "string", - "description" : "The bucket name" - }, - "groupId" : { - "type" : "string", - "description" : "The group id" - }, - "artifactId" : { - "type" : "string", - "description" : "The artifact id" - }, - "version" : { - "type" : "string", - "description" : "The version" - }, - "author" : { - "type" : "string", - "description" : "The identity of the user that created this version" - }, - "timestamp" : { - "type" : "integer", - "format" : "int64", - "description" : "The timestamp of when this version was created" - } - } - }, - "ExternalControllerServiceReference" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The identifier of the controller service" - }, - "name" : { - "type" : "string", - "description" : "The name of the controller service" - } - } - }, - "Fields" : { - "type" : "object", - "properties" : { - "fields" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - } - } - }, - "JaxbLink" : { - "type" : "object", - "properties" : { - "href" : { - "type" : "string", - "format" : "uri", - "xml" : { - "attribute" : true - }, - "description" : "The href for the link" - }, - "params" : { - "type" : "object", - "description" : "The params for the link", - "additionalProperties" : { - "type" : "string" - } - } - } - }, - "Permissions" : { - "type" : "object", - "properties" : { - "canRead" : { - "type" : "boolean", - "description" : "Indicates whether the user can read a given resource.", - "readOnly" : true - }, - "canWrite" : { - "type" : "boolean", - "description" : "Indicates whether the user can write a given resource.", - "readOnly" : true - }, - "canDelete" : { - "type" : "boolean", - "description" : "Indicates whether the user can delete a given resource.", - "readOnly" : true - } - } - }, - "Position" : { - "type" : "object", - "properties" : { - "x" : { - "type" : "number", - "format" : "double", - "description" : "The x coordinate." - }, - "y" : { - "type" : "number", - "format" : "double", - "description" : "The y coordinate." - } - }, - "description" : "The position of a component on the graph" - }, - "Property" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The name of the property" - }, - "displayName" : { - "type" : "string", - "description" : "The display name" - }, - "description" : { - "type" : "string", - "description" : "The description" - }, - "defaultValue" : { - "type" : "string", - "description" : "The default value" - }, - "controllerServiceDefinition" : { - "description" : "The controller service required by this property, or null if none is required", - "$ref" : "#/definitions/ControllerServiceDefinition" - }, - "allowableValues" : { - "type" : "array", - "xml" : { - "wrapped" : true - }, - "description" : "The allowable values for this property", - "items" : { - "xml" : { - "name" : "allowableValue" - }, - "$ref" : "#/definitions/AllowableValue" - } - }, - "required" : { - "type" : "boolean", - "description" : "Whether or not the property is required" - }, - "sensitive" : { - "type" : "boolean", - "description" : "Whether or not the property is sensitive" - }, - "expressionLanguageSupported" : { - "type" : "boolean", - "description" : "Whether or not expression language is supported" - }, - "expressionLanguageScope" : { - "type" : "string", - "description" : "The scope of expression language support", - "enum" : [ "NONE", "VARIABLE_REGISTRY", "FLOWFILE_ATTRIBUTES" ] - }, - "dynamicallyModifiesClasspath" : { - "type" : "boolean", - "description" : "Whether or not the processor dynamically modifies the classpath" - }, - "dynamic" : { - "type" : "boolean", - "description" : "Whether or not the processor is dynamic" - }, - "dependencies" : { - "type" : "array", - "xml" : { - "wrapped" : true - }, - "description" : "The properties that this property depends on", - "items" : { - "xml" : { - "name" : "dependency" - }, - "$ref" : "#/definitions/Dependency" - } - }, - "resourceDefinition" : { - "description" : "The optional resource definition", - "$ref" : "#/definitions/ResourceDefinition" - } - } - }, - "ProvidedServiceAPI" : { - "type" : "object", - "properties" : { - "className" : { - "type" : "string", - "description" : "The class name of the service API being provided" - }, - "groupId" : { - "type" : "string", - "description" : "The group id of the service API being provided" - }, - "artifactId" : { - "type" : "string", - "description" : "The artifact id of the service API being provided" - }, - "version" : { - "type" : "string", - "description" : "The version of the service API being provided" - } - } - }, - "RegistryAbout" : { - "type" : "object", - "properties" : { - "registryAboutVersion" : { - "type" : "string", - "description" : "The version string for this Nifi Registry", - "readOnly" : true - } - } - }, - "RegistryConfiguration" : { - "type" : "object", - "properties" : { - "supportsManagedAuthorizer" : { - "type" : "boolean", - "description" : "Whether this NiFi Registry supports a managed authorizer. Managed authorizers can visualize users, groups, and policies in the UI.", - "readOnly" : true - }, - "supportsConfigurableAuthorizer" : { - "type" : "boolean", - "description" : "Whether this NiFi Registry supports a configurable authorizer.", - "readOnly" : true - }, - "supportsConfigurableUsersAndGroups" : { - "type" : "boolean", - "description" : "Whether this NiFi Registry supports configurable users and groups.", - "readOnly" : true - } - } - }, - "Relationship" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The name of the relationship" - }, - "description" : { - "type" : "string", - "description" : "The description of the relationship" - }, - "autoTerminated" : { - "type" : "boolean", - "description" : "Whether or not the relationship is auto-terminated by default" - } - } - }, - "Resource" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The identifier of the resource.", - "readOnly" : true - }, - "name" : { - "type" : "string", - "description" : "The name of the resource.", - "readOnly" : true - } - } - }, - "ResourceDefinition" : { - "type" : "object", - "properties" : { - "cardinality" : { - "type" : "string", - "description" : "The cardinality of the resource definition", - "enum" : [ "SINGLE", "MULTIPLE" ] - }, - "resourceTypes" : { - "type" : "array", - "xml" : { - "wrapped" : true - }, - "description" : "The types of resources", - "items" : { - "type" : "string", - "xml" : { - "name" : "resourceType" - }, - "enum" : [ "FILE", "DIRECTORY", "TEXT", "URL" ] - } - } - } - }, - "ResourcePermissions" : { - "type" : "object", - "properties" : { - "buckets" : { - "description" : "The access that the current user has to the top level /buckets resource of this NiFi Registry (i.e., access to all buckets)", - "readOnly" : true, - "$ref" : "#/definitions/Permissions" - }, - "tenants" : { - "description" : "The access that the current user has to the top level /tenants resource of this NiFi Registry", - "readOnly" : true, - "$ref" : "#/definitions/Permissions" - }, - "policies" : { - "description" : "The access that the current user has to the top level /policies resource of this NiFi Registry", - "readOnly" : true, - "$ref" : "#/definitions/Permissions" - }, - "proxy" : { - "description" : "The access that the current user has to the top level /proxy resource of this NiFi Registry", - "readOnly" : true, - "$ref" : "#/definitions/Permissions" - }, - "anyTopLevelResource" : { - "description" : "The access that the current user has to any top level resources (a logical 'OR' of all other values)", - "readOnly" : true, - "$ref" : "#/definitions/Permissions" - } - } - }, - "Restricted" : { - "type" : "object", - "properties" : { - "generalRestrictionExplanation" : { - "type" : "string", - "description" : "The general restriction for the extension, or null if only specific restrictions exist" - }, - "restrictions" : { - "type" : "array", - "xml" : { - "wrapped" : true - }, - "description" : "The specific restrictions", - "items" : { - "xml" : { - "name" : "restriction" - }, - "$ref" : "#/definitions/Restriction" - } - } - } - }, - "Restriction" : { - "type" : "object", - "properties" : { - "requiredPermission" : { - "type" : "string", - "description" : "The permission required for this restriction" - }, - "explanation" : { - "type" : "string", - "description" : "The explanation of this restriction" - } - } - }, - "RevisionInfo" : { - "type" : "object", - "properties" : { - "clientId" : { - "type" : "string", - "description" : "A client identifier used to make a request. By including a client identifier, the API can allow multiple requests without needing the current revision. Due to the asynchronous nature of requests/responses this was implemented to allow the client to make numerous requests without having to wait for the previous response to come back." - }, - "version" : { - "type" : "integer", - "format" : "int64", - "description" : "NiFi Registry employs an optimistic locking strategy where the client must include a revision in their request when performing an update. In a response to a mutable flow request, this field represents the updated base version." - }, - "lastModifier" : { - "type" : "string", - "description" : "The user that last modified the entity.", - "readOnly" : true - } - }, - "description" : "The revision information for an entity managed through the REST API." - }, - "Stateful" : { - "type" : "object", - "properties" : { - "description" : { - "type" : "string", - "description" : "The description for how the extension stores state" - }, - "scopes" : { - "type" : "array", - "xml" : { - "wrapped" : true - }, - "description" : "The scopes used to store state", - "items" : { - "type" : "string", - "xml" : { - "name" : "scope" - }, - "enum" : [ "CLUSTER", "LOCAL" ] - } - } - } - }, - "SystemResourceConsideration" : { - "type" : "object", - "properties" : { - "resource" : { - "type" : "string", - "description" : "The resource to consider" - }, - "description" : { - "type" : "string", - "description" : "The description of how the resource is affected" - } - } - }, - "TagCount" : { - "type" : "object", - "properties" : { - "tag" : { - "type" : "string", - "description" : "The tag label" - }, - "count" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of occurrences of the given tag" - } - } - }, - "Tenant" : { - "type" : "object", - "required" : [ "identity" ], - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The computer-generated identifier of the tenant.", - "readOnly" : true - }, - "identity" : { - "type" : "string", - "description" : "The human-facing identity of the tenant. This can only be changed if the tenant is configurable." - }, - "configurable" : { - "type" : "boolean", - "description" : "Indicates if this tenant is configurable, based on which UserGroupProvider has been configured to manage it.", - "readOnly" : true - }, - "resourcePermissions" : { - "description" : "A summary top-level resource access policies granted to this tenant.", - "readOnly" : true, - "$ref" : "#/definitions/ResourcePermissions" - }, - "accessPolicies" : { - "type" : "array", - "description" : "The access policies granted to this tenant.", - "readOnly" : true, - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/AccessPolicySummary" - } - }, - "revision" : { - "description" : "The revision of this entity used for optimistic-locking during updates.", - "readOnly" : true, - "$ref" : "#/definitions/RevisionInfo" - } - } - }, - "User" : { - "type" : "object", - "required" : [ "identity" ], - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The computer-generated identifier of the tenant.", - "readOnly" : true - }, - "identity" : { - "type" : "string", - "description" : "The human-facing identity of the tenant. This can only be changed if the tenant is configurable." - }, - "configurable" : { - "type" : "boolean", - "description" : "Indicates if this tenant is configurable, based on which UserGroupProvider has been configured to manage it.", - "readOnly" : true - }, - "resourcePermissions" : { - "description" : "A summary top-level resource access policies granted to this tenant.", - "readOnly" : true, - "$ref" : "#/definitions/ResourcePermissions" - }, - "accessPolicies" : { - "type" : "array", - "description" : "The access policies granted to this tenant.", - "readOnly" : true, - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/AccessPolicySummary" - } - }, - "revision" : { - "description" : "The revision of this entity used for optimistic-locking during updates.", - "readOnly" : true, - "$ref" : "#/definitions/RevisionInfo" - }, - "userGroups" : { - "type" : "array", - "description" : "The groups to which the user belongs.", - "readOnly" : true, - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/Tenant" - } - } - } - }, - "UserGroup" : { - "type" : "object", - "required" : [ "identity" ], - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The computer-generated identifier of the tenant.", - "readOnly" : true - }, - "identity" : { - "type" : "string", - "description" : "The human-facing identity of the tenant. This can only be changed if the tenant is configurable." - }, - "configurable" : { - "type" : "boolean", - "description" : "Indicates if this tenant is configurable, based on which UserGroupProvider has been configured to manage it.", - "readOnly" : true - }, - "resourcePermissions" : { - "description" : "A summary top-level resource access policies granted to this tenant.", - "readOnly" : true, - "$ref" : "#/definitions/ResourcePermissions" - }, - "accessPolicies" : { - "type" : "array", - "description" : "The access policies granted to this tenant.", - "readOnly" : true, - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/AccessPolicySummary" - } - }, - "revision" : { - "description" : "The revision of this entity used for optimistic-locking during updates.", - "readOnly" : true, - "$ref" : "#/definitions/RevisionInfo" - }, - "users" : { - "type" : "array", - "description" : "The users that belong to this user group. This can only be changed if this group is configurable.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/Tenant" - } - } - } - }, - "VersionedConnection" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The component's unique identifier" - }, - "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" - }, - "comments" : { - "type" : "string", - "description" : "The user-supplied comments for the component" - }, - "position" : { - "description" : "The component's position on the graph", - "$ref" : "#/definitions/Position" - }, - "source" : { - "description" : "The source of the connection.", - "$ref" : "#/definitions/ConnectableComponent" - }, - "destination" : { - "description" : "The destination of the connection.", - "$ref" : "#/definitions/ConnectableComponent" - }, - "labelIndex" : { - "type" : "integer", - "format" : "int32", - "description" : "The index of the bend point where to place the connection label." - }, - "zIndex" : { - "type" : "integer", - "format" : "int64", - "description" : "The z index of the connection." - }, - "selectedRelationships" : { - "type" : "array", - "description" : "The selected relationship that comprise the connection.", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - }, - "backPressureObjectThreshold" : { - "type" : "integer", - "format" : "int64", - "description" : "The object count threshold for determining when back pressure is applied. Updating this value is a passive change in the sense that it won't impact whether existing files over the limit are affected but it does help feeder processors to stop pushing too much into this work queue." - }, - "backPressureDataSizeThreshold" : { - "type" : "string", - "description" : "The object data size threshold for determining when back pressure is applied. Updating this value is a passive change in the sense that it won't impact whether existing files over the limit are affected but it does help feeder processors to stop pushing too much into this work queue." - }, - "flowFileExpiration" : { - "type" : "string", - "description" : "The amount of time a flow file may be in the flow before it will be automatically aged out of the flow. Once a flow file reaches this age it will be terminated from the flow the next time a processor attempts to start work on it." - }, - "prioritizers" : { - "type" : "array", - "description" : "The comparators used to prioritize the queue.", - "items" : { - "type" : "string" - } - }, - "bends" : { - "type" : "array", - "description" : "The bend points on the connection.", - "items" : { - "$ref" : "#/definitions/Position" - } - }, - "loadBalanceStrategy" : { - "type" : "string", - "description" : "The Strategy to use for load balancing data across the cluster, or null, if no Load Balance Strategy has been specified.", - "enum" : [ "DO_NOT_LOAD_BALANCE", "PARTITION_BY_ATTRIBUTE", "ROUND_ROBIN", "SINGLE_NODE" ] - }, - "partitioningAttribute" : { - "type" : "string", - "description" : "The attribute to use for partitioning data as it is load balanced across the cluster. If the Load Balance Strategy is configured to use PARTITION_BY_ATTRIBUTE, the value returned by this method is the name of the FlowFile Attribute that will be used to determine which node in the cluster should receive a given FlowFile. If the Load Balance Strategy is unset or is set to any other value, the Partitioning Attribute has no effect." - }, - "loadBalanceCompression" : { - "type" : "string", - "description" : "Whether or not compression should be used when transferring FlowFiles between nodes", - "enum" : [ "DO_NOT_COMPRESS", "COMPRESS_ATTRIBUTES_ONLY", "COMPRESS_ATTRIBUTES_AND_CONTENT" ] - }, - "componentType" : { - "type" : "string", - "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE", "REPORTING_TASK", "PARAMETER_CONTEXT", "TEMPLATE" ] - }, - "groupIdentifier" : { - "type" : "string", - "description" : "The ID of the Process Group that this component belongs to" - } - } - }, - "VersionedControllerService" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The component's unique identifier" - }, - "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" - }, - "comments" : { - "type" : "string", - "description" : "The user-supplied comments for the component" - }, - "position" : { - "description" : "The component's position on the graph", - "$ref" : "#/definitions/Position" - }, - "type" : { - "type" : "string", - "description" : "The type of the extension component" - }, - "bundle" : { - "description" : "Information about the bundle from which the component came", - "$ref" : "#/definitions/Bundle" - }, - "properties" : { - "type" : "object", - "description" : "The properties for the component. Properties whose value is not set will only contain the property name.", - "additionalProperties" : { - "type" : "string" - } - }, - "propertyDescriptors" : { - "type" : "object", - "description" : "The property descriptors for the component.", - "additionalProperties" : { - "$ref" : "#/definitions/VersionedPropertyDescriptor" - } - }, - "controllerServiceApis" : { - "type" : "array", - "description" : "Lists the APIs this Controller Service implements.", - "items" : { - "$ref" : "#/definitions/ControllerServiceAPI" - } - }, - "annotationData" : { - "type" : "string", - "description" : "The annotation for the controller service. This is how the custom UI relays configuration to the controller service." - }, - "scheduledState" : { - "type" : "string", - "description" : "The ScheduledState denoting whether the Controller Service is ENABLED or DISABLED", - "enum" : [ "ENABLED", "DISABLED", "RUNNING" ] - }, - "bulletinLevel" : { - "type" : "string", - "description" : "The level at which the controller service will report bulletins." - }, - "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", "PARAMETER_CONTEXT", "TEMPLATE" ] - }, - "groupIdentifier" : { - "type" : "string", - "description" : "The ID of the Process Group that this component belongs to" - } - } - }, - "VersionedFlow" : { - "type" : "object", - "required" : [ "bucketIdentifier", "name", "type" ], - "properties" : { - "link" : { - "description" : "An WebLink to this entity.", - "readOnly" : true, - "$ref" : "#/definitions/JaxbLink" - }, - "identifier" : { - "type" : "string", - "description" : "An ID to uniquely identify this object.", - "readOnly" : true - }, - "name" : { - "type" : "string", - "description" : "The name of the item." - }, - "description" : { - "type" : "string", - "description" : "A description of the item." - }, - "bucketIdentifier" : { - "type" : "string", - "description" : "The identifier of the bucket this items belongs to. This cannot be changed after the item is created." - }, - "bucketName" : { - "type" : "string", - "description" : "The name of the bucket this items belongs to.", - "readOnly" : true - }, - "createdTimestamp" : { - "type" : "integer", - "format" : "int64", - "description" : "The timestamp of when the item was created, as milliseconds since epoch.", - "readOnly" : true, - "minimum" : 1 - }, - "modifiedTimestamp" : { - "type" : "integer", - "format" : "int64", - "description" : "The timestamp of when the item was last modified, as milliseconds since epoch.", - "readOnly" : true, - "minimum" : 1 - }, - "type" : { - "type" : "string", - "description" : "The type of item.", - "enum" : [ "Flow", "Bundle" ] - }, - "permissions" : { - "description" : "The access that the current user has to the bucket containing this item.", - "readOnly" : true, - "$ref" : "#/definitions/Permissions" - }, - "versionCount" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of versions of this flow.", - "readOnly" : true, - "minimum" : 0 - }, - "revision" : { - "description" : "The revision of this entity used for optimistic-locking during updates.", - "readOnly" : true, - "$ref" : "#/definitions/RevisionInfo" - } - } - }, - "VersionedFlowCoordinates" : { - "type" : "object", - "properties" : { - "registryUrl" : { - "type" : "string", - "description" : "The URL of the Flow Registry that contains the flow" - }, - "bucketId" : { - "type" : "string", - "description" : "The UUID of the bucket that the flow resides in" - }, - "flowId" : { - "type" : "string", - "description" : "The UUID of the flow" - }, - "version" : { - "type" : "integer", - "format" : "int32", - "description" : "The version of the flow" - }, - "latest" : { - "type" : "boolean", - "description" : "Whether or not these coordinates point to the latest version of the flow" - } - } - }, - "VersionedFlowDifference" : { - "type" : "object", - "properties" : { - "bucketId" : { - "type" : "string", - "description" : "The id of the bucket that the flow is stored in." - }, - "flowId" : { - "type" : "string", - "description" : "The id of the flow that is being examined." - }, - "versionA" : { - "type" : "integer", - "format" : "int32", - "description" : "The earlier version from the diff operation." - }, - "versionB" : { - "type" : "integer", - "format" : "int32", - "description" : "The latter version from the diff operation." - }, - "componentDifferenceGroups" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ComponentDifferenceGroup" - } - } - } - }, - "VersionedFlowSnapshot" : { - "type" : "object", - "required" : [ "flowContents", "snapshotMetadata" ], - "properties" : { - "snapshotMetadata" : { - "description" : "The metadata for this snapshot", - "$ref" : "#/definitions/VersionedFlowSnapshotMetadata" - }, - "flowContents" : { - "description" : "The contents of the versioned flow", - "$ref" : "#/definitions/VersionedProcessGroup" - }, - "externalControllerServices" : { - "type" : "object", - "description" : "The information about controller services that exist outside this versioned flow, but are referenced by components within the versioned flow.", - "additionalProperties" : { - "$ref" : "#/definitions/ExternalControllerServiceReference" - } - }, - "parameterContexts" : { - "type" : "object", - "description" : "The parameter contexts referenced by process groups in the flow contents. The mapping is from the name of the context to the context instance, and it is expected that any context in this map is referenced by at least one process group in this flow.", - "additionalProperties" : { - "$ref" : "#/definitions/VersionedParameterContext" - } - }, - "flowEncodingVersion" : { - "type" : "string", - "description" : "The optional encoding version of the flow contents." - }, - "flow" : { - "description" : "The flow this snapshot is for", - "readOnly" : true, - "$ref" : "#/definitions/VersionedFlow" - }, - "bucket" : { - "description" : "The bucket where the flow is located", - "readOnly" : true, - "$ref" : "#/definitions/Bucket" - }, - "latest" : { - "type" : "boolean" - } - } - }, - "VersionedFlowSnapshotMetadata" : { - "type" : "object", - "required" : [ "bucketIdentifier", "flowIdentifier", "version" ], - "properties" : { - "link" : { - "description" : "An WebLink to this entity.", - "readOnly" : true, - "$ref" : "#/definitions/JaxbLink" - }, - "bucketIdentifier" : { - "type" : "string", - "description" : "The identifier of the bucket this snapshot belongs to." - }, - "flowIdentifier" : { - "type" : "string", - "description" : "The identifier of the flow this snapshot belongs to." - }, - "version" : { - "type" : "integer", - "format" : "int32", - "description" : "The version of this snapshot of the flow.", - "minimum" : -1 - }, - "timestamp" : { - "type" : "integer", - "format" : "int64", - "description" : "The timestamp when the flow was saved, as milliseconds since epoch.", - "readOnly" : true, - "minimum" : 1 - }, - "author" : { - "type" : "string", - "description" : "The user that created this snapshot of the flow.", - "readOnly" : true - }, - "comments" : { - "type" : "string", - "description" : "The comments provided by the user when creating the snapshot." - } - } - }, - "VersionedFunnel" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The component's unique identifier" - }, - "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" - }, - "comments" : { - "type" : "string", - "description" : "The user-supplied comments for the component" - }, - "position" : { - "description" : "The component's position on the graph", - "$ref" : "#/definitions/Position" - }, - "componentType" : { - "type" : "string", - "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE", "REPORTING_TASK", "PARAMETER_CONTEXT", "TEMPLATE" ] - }, - "groupIdentifier" : { - "type" : "string", - "description" : "The ID of the Process Group that this component belongs to" - } - } - }, - "VersionedLabel" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The component's unique identifier" - }, - "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" - }, - "comments" : { - "type" : "string", - "description" : "The user-supplied comments for the component" - }, - "position" : { - "description" : "The component's position on the graph", - "$ref" : "#/definitions/Position" - }, - "label" : { - "type" : "string", - "description" : "The text that appears in the label." - }, - "zIndex" : { - "type" : "integer", - "format" : "int64", - "description" : "The z index of the connection." - }, - "width" : { - "type" : "number", - "format" : "double", - "description" : "The width of the label in pixels when at a 1:1 scale." - }, - "height" : { - "type" : "number", - "format" : "double", - "description" : "The height of the label in pixels when at a 1:1 scale." - }, - "style" : { - "type" : "object", - "description" : "The styles for this label (font-size : 12px, background-color : #eee, etc).", - "additionalProperties" : { - "type" : "string" - } - }, - "componentType" : { - "type" : "string", - "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE", "REPORTING_TASK", "PARAMETER_CONTEXT", "TEMPLATE" ] - }, - "groupIdentifier" : { - "type" : "string", - "description" : "The ID of the Process Group that this component belongs to" - } - } - }, - "VersionedParameter" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The name of the parameter" - }, - "description" : { - "type" : "string", - "description" : "The description of the param" - }, - "sensitive" : { - "type" : "boolean", - "description" : "Whether or not the parameter value is sensitive" - }, - "value" : { - "type" : "string", - "description" : "The value of the parameter" - } - } - }, - "VersionedParameterContext" : { - "type" : "object", - "properties" : { - "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" - }, - "comments" : { - "type" : "string", - "description" : "The user-supplied comments for the component" - }, - "position" : { - "description" : "The component's position on the graph", - "$ref" : "#/definitions/Position" - }, - "parameters" : { - "type" : "array", - "description" : "The parameters in the context", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedParameter" - } - }, - "inheritedParameterContexts" : { - "type" : "array", - "description" : "The names of additional parameter contexts from which to inherit parameters", - "items" : { - "type" : "string" - } - }, - "description" : { - "type" : "string", - "description" : "The description of the parameter context" - }, - "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", "PARAMETER_CONTEXT", "TEMPLATE" ] - }, - "groupIdentifier" : { - "type" : "string", - "description" : "The ID of the Process Group that this component belongs to" - } - } - }, - "VersionedPort" : { - "type" : "object", - "properties" : { - "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" - }, - "comments" : { - "type" : "string", - "description" : "The user-supplied comments for the component" - }, - "position" : { - "description" : "The component's position on the graph", - "$ref" : "#/definitions/Position" - }, - "type" : { - "type" : "string", - "description" : "The type of port.", - "enum" : [ "INPUT_PORT", "OUTPUT_PORT" ] - }, - "concurrentlySchedulableTaskCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of tasks that should be concurrently scheduled for the port." - }, - "scheduledState" : { - "type" : "string", - "description" : "The scheduled state of the component", - "enum" : [ "ENABLED", "DISABLED", "RUNNING" ] - }, - "allowRemoteAccess" : { - "type" : "boolean", - "description" : "Whether or not this port allows remote access for site-to-site" - }, - "componentType" : { - "type" : "string", - "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE", "REPORTING_TASK", "PARAMETER_CONTEXT", "TEMPLATE" ] - }, - "groupIdentifier" : { - "type" : "string", - "description" : "The ID of the Process Group that this component belongs to" - } - } - }, - "VersionedProcessGroup" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The component's unique identifier" - }, - "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" - }, - "comments" : { - "type" : "string", - "description" : "The user-supplied comments for the component" - }, - "position" : { - "description" : "The component's position on the graph", - "$ref" : "#/definitions/Position" - }, - "processGroups" : { - "type" : "array", - "description" : "The child Process Groups", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedProcessGroup" - } - }, - "remoteProcessGroups" : { - "type" : "array", - "description" : "The Remote Process Groups", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedRemoteProcessGroup" - } - }, - "processors" : { - "type" : "array", - "description" : "The Processors", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedProcessor" - } - }, - "inputPorts" : { - "type" : "array", - "description" : "The Input Ports", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedPort" - } - }, - "outputPorts" : { - "type" : "array", - "description" : "The Output Ports", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedPort" - } - }, - "connections" : { - "type" : "array", - "description" : "The Connections", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedConnection" - } - }, - "labels" : { - "type" : "array", - "description" : "The Labels", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedLabel" - } - }, - "funnels" : { - "type" : "array", - "description" : "The Funnels", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedFunnel" - } - }, - "controllerServices" : { - "type" : "array", - "description" : "The Controller Services", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedControllerService" - } - }, - "versionedFlowCoordinates" : { - "description" : "The coordinates where the remote flow is stored, or null if the Process Group is not directly under Version Control", - "$ref" : "#/definitions/VersionedFlowCoordinates" - }, - "variables" : { - "type" : "object", - "description" : "The Variables in the Variable Registry for this Process Group (not including any ancestor or descendant Process Groups)", - "additionalProperties" : { - "type" : "string" - } - }, - "parameterContextName" : { - "type" : "string", - "description" : "The name of the parameter context used by this process group" - }, - "defaultFlowFileExpiration" : { - "type" : "string", - "description" : "The default FlowFile Expiration for this Process Group." - }, - "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." - }, - "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." - }, - "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", "PARAMETER_CONTEXT", "TEMPLATE" ] - }, - "flowFileConcurrency" : { - "type" : "string", - "description" : "The configured FlowFile Concurrency for the Process Group" - }, - "flowFileOutboundPolicy" : { - "type" : "string", - "description" : "The FlowFile Outbound Policy for the Process Group" - }, - "groupIdentifier" : { - "type" : "string", - "description" : "The ID of the Process Group that this component belongs to" - } - } - }, - "VersionedProcessor" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The component's unique identifier" - }, - "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" - }, - "comments" : { - "type" : "string", - "description" : "The user-supplied comments for the component" - }, - "position" : { - "description" : "The component's position on the graph", - "$ref" : "#/definitions/Position" - }, - "type" : { - "type" : "string", - "description" : "The type of the extension component" - }, - "bundle" : { - "description" : "Information about the bundle from which the component came", - "$ref" : "#/definitions/Bundle" - }, - "properties" : { - "type" : "object", - "description" : "The properties for the component. Properties whose value is not set will only contain the property name.", - "additionalProperties" : { - "type" : "string" - } - }, - "propertyDescriptors" : { - "type" : "object", - "description" : "The property descriptors for the component.", - "additionalProperties" : { - "$ref" : "#/definitions/VersionedPropertyDescriptor" - } - }, - "style" : { - "type" : "object", - "description" : "Stylistic data for rendering in a UI", - "additionalProperties" : { - "type" : "string" - } - }, - "annotationData" : { - "type" : "string", - "description" : "The annotation data for the processor used to relay configuration between a custom UI and the procesosr." - }, - "schedulingPeriod" : { - "type" : "string", - "description" : "The frequency with which to schedule the processor. The format of the value will depend on th value of schedulingStrategy." - }, - "schedulingStrategy" : { - "type" : "string", - "description" : "Indicates whether the processor should be scheduled to run in event or timer driven mode." - }, - "executionNode" : { - "type" : "string", - "description" : "Indicates the node where the process will execute." - }, - "penaltyDuration" : { - "type" : "string", - "description" : "The amout of time that is used when the process penalizes a flowfile." - }, - "yieldDuration" : { - "type" : "string", - "description" : "The amount of time that must elapse before this processor is scheduled again after yielding." - }, - "bulletinLevel" : { - "type" : "string", - "description" : "The level at which the processor will report bulletins." - }, - "runDurationMillis" : { - "type" : "integer", - "format" : "int64", - "description" : "The run duration for the processor in milliseconds." - }, - "concurrentlySchedulableTaskCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of tasks that should be concurrently schedule for the processor. If the processor doesn't allow parallol processing then any positive input will be ignored." - }, - "autoTerminatedRelationships" : { - "type" : "array", - "description" : "The names of all relationships that cause a flow file to be terminated if the relationship is not connected elsewhere. This property differs from the 'isAutoTerminate' property of the RelationshipDTO in that the RelationshipDTO is meant to depict the current configuration, whereas this property can be set in a DTO when updating a Processor in order to change which Relationships should be auto-terminated.", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - }, - "scheduledState" : { - "type" : "string", - "description" : "The scheduled state of the component", - "enum" : [ "ENABLED", "DISABLED", "RUNNING" ] - }, - "retryCount" : { - "type" : "integer", - "format" : "int32", - "description" : "Overall number of retries." - }, - "retriedRelationships" : { - "type" : "array", - "description" : "All the relationships should be retried.", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - }, - "backoffMechanism" : { - "type" : "string", - "description" : "Determines whether the FlowFile should be penalized or the processor should be yielded between retries.", - "enum" : [ "PENALIZE_FLOWFILE", "YIELD_PROCESSOR" ] - }, - "maxBackoffPeriod" : { - "type" : "string", - "description" : "Maximum amount of time to be waited during a retry period." - }, - "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", "PARAMETER_CONTEXT", "TEMPLATE" ] - }, - "groupIdentifier" : { - "type" : "string", - "description" : "The ID of the Process Group that this component belongs to" - } - } - }, - "VersionedPropertyDescriptor" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The name of the property" - }, - "displayName" : { - "type" : "string", - "description" : "The display name of the property" - }, - "identifiesControllerService" : { - "type" : "boolean", - "description" : "Whether or not the property provides the identifier of a Controller Service" - }, - "sensitive" : { - "type" : "boolean", - "description" : "Whether or not the property is considered sensitive" - }, - "resourceDefinition" : { - "description" : "Returns the Resource Definition that defines which type(s) of resource(s) this property references, if any", - "$ref" : "#/definitions/VersionedResourceDefinition" - } - } - }, - "VersionedRemoteGroupPort" : { - "type" : "object", - "properties" : { - "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" - }, - "comments" : { - "type" : "string", - "description" : "The user-supplied comments for the component" - }, - "position" : { - "description" : "The component's position on the graph", - "$ref" : "#/definitions/Position" - }, - "remoteGroupId" : { - "type" : "string", - "description" : "The id of the remote process group that the port resides in." - }, - "concurrentlySchedulableTaskCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of task that may transmit flowfiles to the target port concurrently." - }, - "useCompression" : { - "type" : "boolean", - "description" : "Whether the flowfiles are compressed when sent to the target port." - }, - "batchSize" : { - "description" : "The batch settings for data transmission.", - "$ref" : "#/definitions/BatchSize" - }, - "componentType" : { - "type" : "string", - "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE", "REPORTING_TASK", "PARAMETER_CONTEXT", "TEMPLATE" ] - }, - "targetId" : { - "type" : "string", - "description" : "The ID of the port on the target NiFi instance" - }, - "scheduledState" : { - "type" : "string", - "description" : "The scheduled state of the component", - "enum" : [ "ENABLED", "DISABLED", "RUNNING" ] - }, - "groupIdentifier" : { - "type" : "string", - "description" : "The ID of the Process Group that this component belongs to" - } - } - }, - "VersionedRemoteProcessGroup" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The component's unique identifier" - }, - "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" - }, - "comments" : { - "type" : "string", - "description" : "The user-supplied comments for the component" - }, - "position" : { - "description" : "The component's position on the graph", - "$ref" : "#/definitions/Position" - }, - "targetUri" : { - "type" : "string", - "description" : "[DEPRECATED] The target URI of the remote process group. If target uri is not set, but uris are set, then returns the first uri in the uris. If neither target uri nor uris are set, then returns null." - }, - "targetUris" : { - "type" : "string", - "description" : "The target URIs of the remote process group. If target uris is not set but target uri is set, then returns the single target uri. If neither target uris nor target uri is set, then returns null." - }, - "communicationsTimeout" : { - "type" : "string", - "description" : "The time period used for the timeout when communicating with the target." - }, - "yieldDuration" : { - "type" : "string", - "description" : "When yielding, this amount of time must elapse before the remote process group is scheduled again." - }, - "transportProtocol" : { - "type" : "string", - "description" : "The Transport Protocol that is used for Site-to-Site communications", - "enum" : [ "RAW", "HTTP" ] - }, - "localNetworkInterface" : { - "type" : "string", - "description" : "The local network interface to send/receive data. If not specified, any local address is used. If clustered, all nodes must have an interface with this identifier." - }, - "proxyHost" : { - "type" : "string" - }, - "proxyPort" : { - "type" : "integer", - "format" : "int32" - }, - "proxyUser" : { - "type" : "string" - }, - "inputPorts" : { - "type" : "array", - "description" : "A Set of Input Ports that can be connected to, in order to send data to the remote NiFi instance", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedRemoteGroupPort" - } - }, - "outputPorts" : { - "type" : "array", - "description" : "A Set of Output Ports that can be connected to, in order to pull data from the remote NiFi instance", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedRemoteGroupPort" - } - }, - "componentType" : { - "type" : "string", - "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE", "REPORTING_TASK", "PARAMETER_CONTEXT", "TEMPLATE" ] - }, - "groupIdentifier" : { - "type" : "string", - "description" : "The ID of the Process Group that this component belongs to" - } - } - }, - "VersionedResourceDefinition" : { - "type" : "object", - "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", - "uniqueItems" : true, - "items" : { - "type" : "string", - "enum" : [ "FILE", "DIRECTORY", "TEXT", "URL" ] - } - } - } - } - } -} \ No newline at end of file diff --git a/resources/client_gen/api_defs/registry-1.19.0rc1.json b/resources/client_gen/api_defs/registry-1.19.0rc1.json deleted file mode 100644 index 6d4e5caa..00000000 --- a/resources/client_gen/api_defs/registry-1.19.0rc1.json +++ /dev/null @@ -1,7062 +0,0 @@ -{ - "swagger" : "2.0", - "info" : { - "description" : "The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components.", - "version" : "1.19.0", - "title" : "Apache NiFi Registry REST API", - "termsOfService" : "As described in the license", - "contact" : { - "name" : "Apache NiFi Registry", - "url" : "https://nifi.apache.org", - "email" : "dev@nifi.apache.org" - }, - "license" : { - "name" : "Apache 2.0 License", - "url" : "https://www.apache.org/licenses/LICENSE-2.0.html" - } - }, - "basePath" : "/nifi-registry-api", - "tags" : [ { - "name" : "about", - "description" : "Retrieves the version information for this NiFi Registry." - }, { - "name" : "access", - "description" : "Endpoints for obtaining an access token or checking access status." - }, { - "name" : "bucket bundles", - "description" : "Create extension bundles scoped to an existing bucket in the registry. " - }, { - "name" : "bucket flows", - "description" : "Create flows scoped to an existing bucket in the registry." - }, { - "name" : "buckets", - "description" : "Create named buckets in the registry to store NiFi objects such flows and extensions. Search for and retrieve existing buckets." - }, { - "name" : "bundles", - "description" : "Gets metadata about extension bundles and their versions. " - }, { - "name" : "config", - "description" : "Retrieves the configuration for this NiFi Registry." - }, { - "name" : "extension repository", - "description" : "Interact with extension bundles via the hierarchy of bucket/group/artifact/version. " - }, { - "name" : "extensions", - "description" : "Find and retrieve extensions. " - }, { - "name" : "flows", - "description" : "Gets metadata about flows." - }, { - "name" : "items", - "description" : "Retrieve items across all buckets for which the user is authorized." - }, { - "name" : "policies", - "description" : "Endpoint for managing access policies." - }, { - "name" : "tenants", - "description" : "Endpoint for managing users and user groups." - } ], - "schemes" : [ "http", "https" ], - "paths" : { - "/about" : { - "get" : { - "tags" : [ "about" ], - "summary" : "Get version", - "description" : "Gets the NiFi Registry version.", - "operationId" : "getVersion", - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/RegistryAbout" - } - } - }, - "security" : [ { - "Authorization" : [ ] - } ] - } - }, - "/access" : { - "get" : { - "tags" : [ "access" ], - "summary" : "Get access status", - "description" : "Returns the current client's authenticated identity and permissions to top-level resources", - "operationId" : "getAccessStatus", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/CurrentUser" - } - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid. The NiFi Registry might be running unsecured." - } - }, - "security" : [ { - "Authorization" : [ ] - } ] - } - }, - "/access/logout" : { - "delete" : { - "tags" : [ "access" ], - "summary" : "Performs a logout for other providers that have been issued a JWT.", - "description" : "\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "logOut", - "consumes" : [ "*/*" ], - "produces" : [ "*/*" ], - "responses" : { - "200" : { - "description" : "User was logged out successfully." - }, - "401" : { - "description" : "Authentication token provided was empty or not in the correct JWT format." - }, - "500" : { - "description" : "Client failed to log out." - } - } - } - }, - "/access/oidc/callback" : { - "get" : { - "tags" : [ "access" ], - "summary" : "Redirect/callback URI for processing the result of the OpenId Connect login sequence.", - "description" : "\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "oidcCallback", - "consumes" : [ "*/*" ], - "produces" : [ "*/*" ], - "responses" : { - "default" : { - "description" : "successful operation" - } - } - } - }, - "/access/oidc/exchange" : { - "post" : { - "tags" : [ "access" ], - "summary" : "Retrieves a JWT following a successful login sequence using the configured OpenId Connect provider.", - "description" : "\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "oidcExchange", - "consumes" : [ "*/*" ], - "produces" : [ "text/plain" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - } - } - } - }, - "/access/oidc/logout" : { - "delete" : { - "tags" : [ "access" ], - "summary" : "Performs a logout in the OpenId Provider.", - "description" : "\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "oidcLogout", - "consumes" : [ "*/*" ], - "produces" : [ "*/*" ], - "responses" : { - "default" : { - "description" : "successful operation" - } - } - } - }, - "/access/oidc/request" : { - "get" : { - "tags" : [ "access" ], - "summary" : "Initiates a request to authenticate through the configured OpenId Connect provider.", - "description" : "\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "oidcRequest", - "consumes" : [ "*/*" ], - "produces" : [ "*/*" ], - "responses" : { - "default" : { - "description" : "successful operation" - } - } - } - }, - "/access/token" : { - "post" : { - "tags" : [ "access" ], - "summary" : "Create token trying all providers", - "description" : "Creates a token for accessing the REST API via auto-detected method of verifying client identity claim credentials. The token returned is formatted as a JSON Web Token (JWT). The token is base64 encoded and comprised of three parts. The header, the body, and the signature. The expiration of the token is a contained within the body. The token can be used in the Authorization header in the format 'Authorization: Bearer '.", - "operationId" : "createAccessTokenByTryingAllProviders", - "consumes" : [ "*/*" ], - "produces" : [ "text/plain" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid. The NiFi Registry may not be configured to support login with username/password." - }, - "500" : { - "description" : "NiFi Registry was unable to complete the request because an unexpected error occurred." - } - } - } - }, - "/access/token/identity-provider" : { - "post" : { - "tags" : [ "access" ], - "summary" : "Create token using identity provider", - "description" : "Creates a token for accessing the REST API via a custom identity provider. The user credentials must be passed in a format understood by the custom identity provider, e.g., a third-party auth token in an HTTP header. The exact format of the user credentials expected by the custom identity provider can be discovered by 'GET /access/token/identity-provider/usage'. The token returned is formatted as a JSON Web Token (JWT). The token is base64 encoded and comprised of three parts. The header, the body, and the signature. The expiration of the token is a contained within the body. The token can be used in the Authorization header in the format 'Authorization: Bearer '.", - "operationId" : "createAccessTokenUsingIdentityProviderCredentials", - "consumes" : [ "*/*" ], - "produces" : [ "text/plain" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid. The NiFi Registry may not be configured to support login with customized credentials." - }, - "500" : { - "description" : "NiFi Registry was unable to complete the request because an unexpected error occurred." - } - } - } - }, - "/access/token/identity-provider/test" : { - "post" : { - "tags" : [ "access" ], - "summary" : "Test identity provider", - "description" : "Tests the format of the credentials against this identity provider without preforming authentication on the credentials to validate them. The user credentials should be passed in a format understood by the custom identity provider as defined by 'GET /access/token/identity-provider/usage'.", - "operationId" : "testIdentityProviderRecognizesCredentialsFormat", - "consumes" : [ "*/*" ], - "produces" : [ "text/plain" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "The format of the credentials were not recognized by the currently configured identity provider." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid. The NiFi Registry may not be configured to support login with customized credentials." - }, - "500" : { - "description" : "NiFi Registry was unable to complete the request because an unexpected error occurred." - } - } - } - }, - "/access/token/identity-provider/usage" : { - "get" : { - "tags" : [ "access" ], - "summary" : "Get identity provider usage", - "description" : "Provides a description of how the currently configured identity provider expects credentials to be passed to POST /access/token/identity-provider", - "operationId" : "getIdentityProviderUsageInstructions", - "consumes" : [ "*/*" ], - "produces" : [ "text/plain" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid. The NiFi Registry may not be configured to support login with customized credentials." - }, - "500" : { - "description" : "NiFi Registry was unable to complete the request because an unexpected error occurred." - } - } - } - }, - "/access/token/kerberos" : { - "post" : { - "tags" : [ "access" ], - "summary" : "Create token using kerberos", - "description" : "Creates a token for accessing the REST API via Kerberos Service Tickets or SPNEGO Tokens (which includes Kerberos Service Tickets). The token returned is formatted as a JSON Web Token (JWT). The token is base64 encoded and comprised of three parts. The header, the body, and the signature. The expiration of the token is a contained within the body. The token can be used in the Authorization header in the format 'Authorization: Bearer '.", - "operationId" : "createAccessTokenUsingKerberosTicket", - "consumes" : [ "*/*" ], - "produces" : [ "text/plain" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid. The NiFi Registry may not be configured to support login Kerberos credentials." - }, - "500" : { - "description" : "NiFi Registry was unable to complete the request because an unexpected error occurred." - } - } - } - }, - "/access/token/login" : { - "post" : { - "tags" : [ "access" ], - "summary" : "Create token using basic auth", - "description" : "Creates a token for accessing the REST API via username/password. The user credentials must be passed in standard HTTP Basic Auth format. That is: 'Authorization: Basic ', where is the base64 encoded value of ':'. The token returned is formatted as a JSON Web Token (JWT). The token is base64 encoded and comprised of three parts. The header, the body, and the signature. The expiration of the token is a contained within the body. The token can be used in the Authorization header in the format 'Authorization: Bearer '.", - "operationId" : "createAccessTokenUsingBasicAuthCredentials", - "consumes" : [ "*/*" ], - "produces" : [ "text/plain" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid. The NiFi Registry may not be configured to support login with username/password." - }, - "500" : { - "description" : "NiFi Registry was unable to complete the request because an unexpected error occurred." - } - }, - "security" : [ { - "BasicAuth" : [ ] - } ] - } - }, - "/buckets" : { - "get" : { - "tags" : [ "buckets" ], - "summary" : "Get all buckets", - "description" : "The returned list will include only buckets for which the user is authorized.If the user is not authorized for any buckets, this returns an empty list.", - "operationId" : "getBuckets", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/Bucket" - } - } - }, - "401" : { - "description" : "Client could not be authenticated." - } - }, - "security" : [ { - "Authorization" : [ ] - } ] - }, - "post" : { - "tags" : [ "buckets" ], - "summary" : "Create bucket", - "description" : "", - "operationId" : "createBucket", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The bucket to create", - "required" : true, - "schema" : { - "$ref" : "#/definitions/Bucket" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/Bucket" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets", - "action" : "write" - } - } - }, - "/buckets/fields" : { - "get" : { - "tags" : [ "buckets" ], - "summary" : "Get bucket fields", - "description" : "Retrieves bucket field names for searching or sorting on buckets.", - "operationId" : "getAvailableBucketFields", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/Fields" - } - } - }, - "security" : [ { - "Authorization" : [ ] - } ] - } - }, - "/buckets/{bucketId}" : { - "get" : { - "tags" : [ "buckets" ], - "summary" : "Get bucket", - "description" : "Gets the bucket with the given id.", - "operationId" : "getBucket", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketId", - "in" : "path", - "description" : "The bucket identifier", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/Bucket" - } - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - }, - "put" : { - "tags" : [ "buckets" ], - "summary" : "Update bucket", - "description" : "Updates the bucket with the given id.", - "operationId" : "updateBucket", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketId", - "in" : "path", - "description" : "The bucket identifier", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The updated bucket", - "required" : true, - "schema" : { - "$ref" : "#/definitions/Bucket" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/Bucket" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "write" - } - }, - "delete" : { - "tags" : [ "buckets" ], - "summary" : "Delete bucket", - "description" : "Deletes the bucket with the given id, along with all objects stored in the bucket", - "operationId" : "deleteBucket", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The version is used to verify the client is working with the latest version of the entity.", - "required" : true, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "bucketId", - "in" : "path", - "description" : "The bucket identifier", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/Bucket" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "delete" - } - } - }, - "/buckets/{bucketId}/bundles" : { - "get" : { - "tags" : [ "bucket bundles" ], - "summary" : "Get extension bundles by bucket", - "description" : "\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getExtensionBundles", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketId", - "in" : "path", - "description" : "The bucket identifier", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/ExtensionBundle" - } - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/buckets/{bucketId}/bundles/{bundleType}" : { - "post" : { - "tags" : [ "bucket bundles" ], - "summary" : "Create extension bundle version", - "description" : "Creates a version of an extension bundle by uploading a binary artifact. If an extension bundle already exists in the given bucket with the same group id and artifact id as that of the bundle being uploaded, then it will be added as a new version to the existing bundle. If an extension bundle does not already exist in the given bucket with the same group id and artifact id, then a new extension bundle will be created and this version will be added to the new bundle. Client's may optionally supply a SHA-256 in hex format through the multi-part form field 'sha256'. If supplied, then this value will be compared against the SHA-256 computed by the server, and the bundle will be rejected if the values do not match. If not supplied, the bundle will be accepted, but will be marked to indicate that the client did not supply a SHA-256 during creation. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "createExtensionBundleVersion", - "consumes" : [ "multipart/form-data" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketId", - "in" : "path", - "description" : "The bucket identifier", - "required" : true, - "type" : "string" - }, { - "name" : "bundleType", - "in" : "path", - "description" : "The type of the bundle", - "required" : true, - "type" : "string", - "enum" : [ "nifi-nar", "minifi-cpp" ] - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/BundleVersion" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "write" - } - } - }, - "/buckets/{bucketId}/flows" : { - "get" : { - "tags" : [ "bucket flows" ], - "summary" : "Get bucket flows", - "description" : "Retrieves all flows in the given bucket.", - "operationId" : "getFlows", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketId", - "in" : "path", - "description" : "The bucket identifier", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/VersionedFlow" - } - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - }, - "post" : { - "tags" : [ "bucket flows" ], - "summary" : "Create flow", - "description" : "Creates a flow in the given bucket. The flow id is created by the server and populated in the returned entity.", - "operationId" : "createFlow", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketId", - "in" : "path", - "description" : "The bucket identifier", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The details of the flow to create.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/VersionedFlow" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlow" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "write" - } - } - }, - "/buckets/{bucketId}/flows/{flowId}" : { - "get" : { - "tags" : [ "bucket flows" ], - "summary" : "Get bucket flow", - "description" : "Retrieves the flow with the given id in the given bucket.", - "operationId" : "getFlow", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketId", - "in" : "path", - "description" : "The bucket identifier", - "required" : true, - "type" : "string" - }, { - "name" : "flowId", - "in" : "path", - "description" : "The flow identifier", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlow" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - }, - "put" : { - "tags" : [ "bucket flows" ], - "summary" : "Update bucket flow", - "description" : "Updates the flow with the given id in the given bucket.", - "operationId" : "updateFlow", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketId", - "in" : "path", - "description" : "The bucket identifier", - "required" : true, - "type" : "string" - }, { - "name" : "flowId", - "in" : "path", - "description" : "The flow identifier", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The updated flow", - "required" : true, - "schema" : { - "$ref" : "#/definitions/VersionedFlow" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlow" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "write" - } - }, - "delete" : { - "tags" : [ "bucket flows" ], - "summary" : "Delete bucket flow", - "description" : "Deletes a flow, including all saved versions of that flow.", - "operationId" : "deleteFlow", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The version is used to verify the client is working with the latest version of the entity.", - "required" : true, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "bucketId", - "in" : "path", - "description" : "The bucket identifier", - "required" : true, - "type" : "string" - }, { - "name" : "flowId", - "in" : "path", - "description" : "The flow identifier", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlow" - } - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "delete" - } - } - }, - "/buckets/{bucketId}/flows/{flowId}/diff/{versionA}/{versionB}" : { - "get" : { - "tags" : [ "bucket flows" ], - "summary" : "Get bucket flow diff", - "description" : "Computes the differences between two given versions of a flow.", - "operationId" : "getFlowDiff", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketId", - "in" : "path", - "description" : "The bucket identifier", - "required" : true, - "type" : "string" - }, { - "name" : "flowId", - "in" : "path", - "description" : "The flow identifier", - "required" : true, - "type" : "string" - }, { - "name" : "versionA", - "in" : "path", - "description" : "The first version number", - "required" : true, - "type" : "integer", - "pattern" : "\\d+", - "format" : "int32" - }, { - "name" : "versionB", - "in" : "path", - "description" : "The second version number", - "required" : true, - "type" : "integer", - "pattern" : "\\d+", - "format" : "int32" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlowDifference" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/buckets/{bucketId}/flows/{flowId}/versions" : { - "get" : { - "tags" : [ "bucket flows" ], - "summary" : "Get bucket flow versions", - "description" : "Gets summary information for all versions of a flow. Versions are ordered newest->oldest.", - "operationId" : "getFlowVersions", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketId", - "in" : "path", - "description" : "The bucket identifier", - "required" : true, - "type" : "string" - }, { - "name" : "flowId", - "in" : "path", - "description" : "The flow identifier", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/VersionedFlowSnapshotMetadata" - } - } - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - }, - "post" : { - "tags" : [ "bucket flows" ], - "summary" : "Create flow version", - "description" : "Creates the next version of a flow. The version number of the object being created must be the next available version integer. Flow versions are immutable after they are created.", - "operationId" : "createFlowVersion", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketId", - "in" : "path", - "description" : "The bucket identifier", - "required" : true, - "type" : "string" - }, { - "name" : "flowId", - "in" : "path", - "description" : "The flow identifier", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The new versioned flow snapshot.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/VersionedFlowSnapshot" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlowSnapshot" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "write" - } - } - }, - "/buckets/{bucketId}/flows/{flowId}/versions/import" : { - "post" : { - "tags" : [ "bucket flows" ], - "summary" : "Import flow version", - "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", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketId", - "in" : "path", - "description" : "The bucket identifier", - "required" : true, - "type" : "string" - }, { - "name" : "flowId", - "in" : "path", - "description" : "The flow identifier", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "file", - "required" : false, - "schema" : { - "$ref" : "#/definitions/VersionedFlowSnapshot" - } - }, { - "name" : "Comments", - "in" : "header", - "required" : false, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlowSnapshot" - } - }, - "201" : { - "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." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "write" - } - } - }, - "/buckets/{bucketId}/flows/{flowId}/versions/latest" : { - "get" : { - "tags" : [ "bucket flows" ], - "summary" : "Get latest bucket flow version content", - "description" : "Gets the latest version of a flow, including the metadata and content of the flow.", - "operationId" : "getLatestFlowVersion", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketId", - "in" : "path", - "description" : "The bucket identifier", - "required" : true, - "type" : "string" - }, { - "name" : "flowId", - "in" : "path", - "description" : "The flow identifier", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlowSnapshot" - } - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/buckets/{bucketId}/flows/{flowId}/versions/latest/metadata" : { - "get" : { - "tags" : [ "bucket flows" ], - "summary" : "Get latest bucket flow version metadata", - "description" : "Gets the metadata for the latest version of a flow.", - "operationId" : "getLatestFlowVersionMetadata", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketId", - "in" : "path", - "description" : "The bucket identifier", - "required" : true, - "type" : "string" - }, { - "name" : "flowId", - "in" : "path", - "description" : "The flow identifier", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlowSnapshotMetadata" - } - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/buckets/{bucketId}/flows/{flowId}/versions/{versionNumber}" : { - "get" : { - "tags" : [ "bucket flows" ], - "summary" : "Get bucket flow version", - "description" : "Gets the given version of a flow, including the metadata and content for the version.", - "operationId" : "getFlowVersion", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketId", - "in" : "path", - "description" : "The bucket identifier", - "required" : true, - "type" : "string" - }, { - "name" : "flowId", - "in" : "path", - "description" : "The flow identifier", - "required" : true, - "type" : "string" - }, { - "name" : "versionNumber", - "in" : "path", - "description" : "The version number", - "required" : true, - "type" : "integer", - "pattern" : "\\d+", - "format" : "int32" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlowSnapshot" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/buckets/{bucketId}/flows/{flowId}/versions/{versionNumber}/export" : { - "get" : { - "tags" : [ "bucket flows" ], - "summary" : "Exports specified bucket flow version content", - "description" : "Exports the specified version of a flow, including the metadata and content of the flow.", - "operationId" : "exportVersionedFlow", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketId", - "in" : "path", - "description" : "The bucket identifier", - "required" : true, - "type" : "string" - }, { - "name" : "flowId", - "in" : "path", - "description" : "The flow identifier", - "required" : true, - "type" : "string" - }, { - "name" : "versionNumber", - "in" : "path", - "description" : "The version number", - "required" : true, - "type" : "integer", - "pattern" : "\\d+", - "format" : "int32" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlowSnapshot" - } - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/bundles" : { - "get" : { - "tags" : [ "bundles" ], - "summary" : "Get all bundles", - "description" : "Gets the metadata for all bundles across all authorized buckets with optional filters applied. The returned results will include only items from buckets for which the user is authorized. If the user is not authorized to any buckets, an empty list will be returned. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getBundles", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketName", - "in" : "query", - "description" : "Optional bucket name to filter results. The value may be an exact match, or a wildcard, such as 'My Bucket%' to select all bundles where the bucket name starts with 'My Bucket'.", - "required" : false, - "type" : "string" - }, { - "name" : "groupId", - "in" : "query", - "description" : "Optional groupId to filter results. The value may be an exact match, or a wildcard, such as 'com.%' to select all bundles where the groupId starts with 'com.'.", - "required" : false, - "type" : "string" - }, { - "name" : "artifactId", - "in" : "query", - "description" : "Optional artifactId to filter results. The value may be an exact match, or a wildcard, such as 'nifi-%' to select all bundles where the artifactId starts with 'nifi-'.", - "required" : false, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/ExtensionBundle" - } - } - }, - "401" : { - "description" : "Client could not be authenticated." - } - }, - "security" : [ { - "Authorization" : [ ] - } ] - } - }, - "/bundles/versions" : { - "get" : { - "tags" : [ "bundles" ], - "summary" : "Get all bundle versions", - "description" : "Gets the metadata about extension bundle versions across all authorized buckets with optional filters applied. If the user is not authorized to any buckets, an empty list will be returned. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getBundleVersions", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "groupId", - "in" : "query", - "description" : "Optional groupId to filter results. The value may be an exact match, or a wildcard, such as 'com.%' to select all bundle versions where the groupId starts with 'com.'.", - "required" : false, - "type" : "string" - }, { - "name" : "artifactId", - "in" : "query", - "description" : "Optional artifactId to filter results. The value may be an exact match, or a wildcard, such as 'nifi-%' to select all bundle versions where the artifactId starts with 'nifi-'.", - "required" : false, - "type" : "string" - }, { - "name" : "version", - "in" : "query", - "description" : "Optional version to filter results. The value maye be an exact match, or a wildcard, such as '1.0.%' to select all bundle versions where the version starts with '1.0.'.", - "required" : false, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/BundleVersionMetadata" - } - } - }, - "401" : { - "description" : "Client could not be authenticated." - } - }, - "security" : [ { - "Authorization" : [ ] - } ] - } - }, - "/bundles/{bundleId}" : { - "get" : { - "tags" : [ "bundles" ], - "summary" : "Get bundle", - "description" : "Gets the metadata about an extension bundle. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "globalGetExtensionBundle", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bundleId", - "in" : "path", - "description" : "The extension bundle identifier", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ExtensionBundle" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - }, - "delete" : { - "tags" : [ "bundles" ], - "summary" : "Delete bundle", - "description" : "Deletes the given extension bundle and all of it's versions. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "globalDeleteExtensionBundle", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bundleId", - "in" : "path", - "description" : "The extension bundle identifier", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ExtensionBundle" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "write" - } - } - }, - "/bundles/{bundleId}/versions" : { - "get" : { - "tags" : [ "bundles" ], - "summary" : "Get bundle versions", - "description" : "Gets the metadata for the versions of the given extension bundle. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "globalGetBundleVersions", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bundleId", - "in" : "path", - "description" : "The extension bundle identifier", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/BundleVersionMetadata" - } - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/bundles/{bundleId}/versions/{version}" : { - "get" : { - "tags" : [ "bundles" ], - "summary" : "Get bundle version", - "description" : "Gets the descriptor for the given version of the given extension bundle. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "globalGetBundleVersion", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bundleId", - "in" : "path", - "description" : "The extension bundle identifier", - "required" : true, - "type" : "string" - }, { - "name" : "version", - "in" : "path", - "description" : "The version of the bundle", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/BundleVersion" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - }, - "delete" : { - "tags" : [ "bundles" ], - "summary" : "Delete bundle version", - "description" : "Deletes the given extension bundle version and it's associated binary content. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "globalDeleteBundleVersion", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bundleId", - "in" : "path", - "description" : "The extension bundle identifier", - "required" : true, - "type" : "string" - }, { - "name" : "version", - "in" : "path", - "description" : "The version of the bundle", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/BundleVersion" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "write" - } - } - }, - "/bundles/{bundleId}/versions/{version}/content" : { - "get" : { - "tags" : [ "bundles" ], - "summary" : "Get bundle version content", - "description" : "Gets the binary content for the given version of the given extension bundle. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "globalGetBundleVersionContent", - "consumes" : [ "*/*" ], - "produces" : [ "application/octet-stream" ], - "parameters" : [ { - "name" : "bundleId", - "in" : "path", - "description" : "The extension bundle identifier", - "required" : true, - "type" : "string" - }, { - "name" : "version", - "in" : "path", - "description" : "The version of the bundle", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "type" : "string", - "format" : "byte" - } - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/bundles/{bundleId}/versions/{version}/extensions" : { - "get" : { - "tags" : [ "bundles" ], - "summary" : "Get bundle version extensions", - "description" : "Gets the metadata about the extensions in the given extension bundle version. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "globalGetBundleVersionExtensions", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bundleId", - "in" : "path", - "description" : "The extension bundle identifier", - "required" : true, - "type" : "string" - }, { - "name" : "version", - "in" : "path", - "description" : "The version of the bundle", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/ExtensionMetadata" - } - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/bundles/{bundleId}/versions/{version}/extensions/{name}" : { - "get" : { - "tags" : [ "bundles" ], - "summary" : "Get bundle version extension", - "description" : "Gets the metadata about the extension with the given name in the given extension bundle version. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "globalGetBundleVersionExtension", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bundleId", - "in" : "path", - "description" : "The extension bundle identifier", - "required" : true, - "type" : "string" - }, { - "name" : "version", - "in" : "path", - "description" : "The version of the bundle", - "required" : true, - "type" : "string" - }, { - "name" : "name", - "in" : "path", - "description" : "The fully qualified name of the extension", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/Extension" - } - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/bundles/{bundleId}/versions/{version}/extensions/{name}/docs" : { - "get" : { - "tags" : [ "bundles" ], - "summary" : "Get bundle version extension docs", - "description" : "Gets the documentation for the given extension in the given extension bundle version. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getBundleVersionExtensionDocs", - "consumes" : [ "*/*" ], - "produces" : [ "text/html" ], - "parameters" : [ { - "name" : "bundleId", - "in" : "path", - "description" : "The extension bundle identifier", - "required" : true, - "type" : "string" - }, { - "name" : "version", - "in" : "path", - "description" : "The version of the bundle", - "required" : true, - "type" : "string" - }, { - "name" : "name", - "in" : "path", - "description" : "The fully qualified name of the extension", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/bundles/{bundleId}/versions/{version}/extensions/{name}/docs/additional-details" : { - "get" : { - "tags" : [ "bundles" ], - "summary" : "Get bundle version extension docs details", - "description" : "Gets the additional details documentation for the given extension in the given extension bundle version. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getBundleVersionExtensionAdditionalDetailsDocs", - "consumes" : [ "*/*" ], - "produces" : [ "text/html" ], - "parameters" : [ { - "name" : "bundleId", - "in" : "path", - "description" : "The extension bundle identifier", - "required" : true, - "type" : "string" - }, { - "name" : "version", - "in" : "path", - "description" : "The version of the bundle", - "required" : true, - "type" : "string" - }, { - "name" : "name", - "in" : "path", - "description" : "The fully qualified name of the extension", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/config" : { - "get" : { - "tags" : [ "config" ], - "summary" : "Get configration", - "description" : "Gets the NiFi Registry configurations.", - "operationId" : "getConfiguration", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/RegistryConfiguration" - } - }, - "401" : { - "description" : "Client could not be authenticated." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/policies,/tenants", - "action" : "read" - } - } - }, - "/extension-repository" : { - "get" : { - "tags" : [ "extension repository" ], - "summary" : "Get extension repo buckets", - "description" : "Gets the names of the buckets the current user is authorized for in order to browse the repo by bucket. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getExtensionRepoBuckets", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/ExtensionRepoBucket" - } - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ] - } - }, - "/extension-repository/{bucketName}" : { - "get" : { - "tags" : [ "extension repository" ], - "summary" : "Get extension repo groups", - "description" : "Gets the groups in the extension repository in the given bucket. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getExtensionRepoGroups", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketName", - "in" : "path", - "description" : "The bucket name", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/ExtensionRepoGroup" - } - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/extension-repository/{bucketName}/{groupId}" : { - "get" : { - "tags" : [ "extension repository" ], - "summary" : "Get extension repo artifacts", - "description" : "Gets the artifacts in the extension repository in the given bucket and group. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getExtensionRepoArtifacts", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketName", - "in" : "path", - "description" : "The bucket name", - "required" : true, - "type" : "string" - }, { - "name" : "groupId", - "in" : "path", - "description" : "The group id", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/ExtensionRepoArtifact" - } - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/extension-repository/{bucketName}/{groupId}/{artifactId}" : { - "get" : { - "tags" : [ "extension repository" ], - "summary" : "Get extension repo versions", - "description" : "Gets the versions in the extension repository for the given bucket, group, and artifact. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getExtensionRepoVersions", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketName", - "in" : "path", - "description" : "The bucket name", - "required" : true, - "type" : "string" - }, { - "name" : "groupId", - "in" : "path", - "description" : "The group identifier", - "required" : true, - "type" : "string" - }, { - "name" : "artifactId", - "in" : "path", - "description" : "The artifact identifier", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/ExtensionRepoVersionSummary" - } - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/extension-repository/{bucketName}/{groupId}/{artifactId}/{version}" : { - "get" : { - "tags" : [ "extension repository" ], - "summary" : "Get extension repo version", - "description" : "Gets information about the version in the given bucket, group, and artifact. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getExtensionRepoVersion", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketName", - "in" : "path", - "description" : "The bucket name", - "required" : true, - "type" : "string" - }, { - "name" : "groupId", - "in" : "path", - "description" : "The group identifier", - "required" : true, - "type" : "string" - }, { - "name" : "artifactId", - "in" : "path", - "description" : "The artifact identifier", - "required" : true, - "type" : "string" - }, { - "name" : "version", - "in" : "path", - "description" : "The version", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ExtensionRepoVersion" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/extension-repository/{bucketName}/{groupId}/{artifactId}/{version}/content" : { - "get" : { - "tags" : [ "extension repository" ], - "summary" : "Get extension repo version content", - "description" : "Gets the binary content of the bundle with the given bucket, group, artifact, and version. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getExtensionRepoVersionContent", - "consumes" : [ "*/*" ], - "produces" : [ "application/octet-stream" ], - "parameters" : [ { - "name" : "bucketName", - "in" : "path", - "description" : "The bucket name", - "required" : true, - "type" : "string" - }, { - "name" : "groupId", - "in" : "path", - "description" : "The group identifier", - "required" : true, - "type" : "string" - }, { - "name" : "artifactId", - "in" : "path", - "description" : "The artifact identifier", - "required" : true, - "type" : "string" - }, { - "name" : "version", - "in" : "path", - "description" : "The version", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "type" : "string", - "format" : "byte" - } - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/extension-repository/{bucketName}/{groupId}/{artifactId}/{version}/extensions" : { - "get" : { - "tags" : [ "extension repository" ], - "summary" : "Get extension repo extensions", - "description" : "Gets information about the extensions in the given bucket, group, artifact, and version. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getExtensionRepoVersionExtensions", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketName", - "in" : "path", - "description" : "The bucket name", - "required" : true, - "type" : "string" - }, { - "name" : "groupId", - "in" : "path", - "description" : "The group identifier", - "required" : true, - "type" : "string" - }, { - "name" : "artifactId", - "in" : "path", - "description" : "The artifact identifier", - "required" : true, - "type" : "string" - }, { - "name" : "version", - "in" : "path", - "description" : "The version", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/ExtensionMetadata" - } - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/extension-repository/{bucketName}/{groupId}/{artifactId}/{version}/extensions/{name}" : { - "get" : { - "tags" : [ "extension repository" ], - "summary" : "Get extension repo extension", - "description" : "Gets information about the extension with the given name in the given bucket, group, artifact, and version. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getExtensionRepoVersionExtension", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketName", - "in" : "path", - "description" : "The bucket name", - "required" : true, - "type" : "string" - }, { - "name" : "groupId", - "in" : "path", - "description" : "The group identifier", - "required" : true, - "type" : "string" - }, { - "name" : "artifactId", - "in" : "path", - "description" : "The artifact identifier", - "required" : true, - "type" : "string" - }, { - "name" : "version", - "in" : "path", - "description" : "The version", - "required" : true, - "type" : "string" - }, { - "name" : "name", - "in" : "path", - "description" : "The fully qualified name of the extension", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/Extension" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/extension-repository/{bucketName}/{groupId}/{artifactId}/{version}/extensions/{name}/docs" : { - "get" : { - "tags" : [ "extension repository" ], - "summary" : "Get extension repo extension docs", - "description" : "Gets the documentation for the extension with the given name in the given bucket, group, artifact, and version. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getExtensionRepoVersionExtensionDocs", - "consumes" : [ "*/*" ], - "produces" : [ "text/html" ], - "parameters" : [ { - "name" : "bucketName", - "in" : "path", - "description" : "The bucket name", - "required" : true, - "type" : "string" - }, { - "name" : "groupId", - "in" : "path", - "description" : "The group identifier", - "required" : true, - "type" : "string" - }, { - "name" : "artifactId", - "in" : "path", - "description" : "The artifact identifier", - "required" : true, - "type" : "string" - }, { - "name" : "version", - "in" : "path", - "description" : "The version", - "required" : true, - "type" : "string" - }, { - "name" : "name", - "in" : "path", - "description" : "The fully qualified name of the extension", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/extension-repository/{bucketName}/{groupId}/{artifactId}/{version}/extensions/{name}/docs/additional-details" : { - "get" : { - "tags" : [ "extension repository" ], - "summary" : "Get extension repo extension details", - "description" : "Gets the additional details documentation for the extension with the given name in the given bucket, group, artifact, and version. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getExtensionRepoVersionExtensionAdditionalDetailsDocs", - "consumes" : [ "*/*" ], - "produces" : [ "text/html" ], - "parameters" : [ { - "name" : "bucketName", - "in" : "path", - "description" : "The bucket name", - "required" : true, - "type" : "string" - }, { - "name" : "groupId", - "in" : "path", - "description" : "The group identifier", - "required" : true, - "type" : "string" - }, { - "name" : "artifactId", - "in" : "path", - "description" : "The artifact identifier", - "required" : true, - "type" : "string" - }, { - "name" : "version", - "in" : "path", - "description" : "The version", - "required" : true, - "type" : "string" - }, { - "name" : "name", - "in" : "path", - "description" : "The fully qualified name of the extension", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/extension-repository/{bucketName}/{groupId}/{artifactId}/{version}/sha256" : { - "get" : { - "tags" : [ "extension repository" ], - "summary" : "Get extension repo version checksum", - "description" : "Gets the hex representation of the SHA-256 digest for the binary content of the bundle with the given bucket, group, artifact, and version.\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getExtensionRepoVersionSha256", - "consumes" : [ "*/*" ], - "produces" : [ "text/plain" ], - "parameters" : [ { - "name" : "bucketName", - "in" : "path", - "description" : "The bucket name", - "required" : true, - "type" : "string" - }, { - "name" : "groupId", - "in" : "path", - "description" : "The group identifier", - "required" : true, - "type" : "string" - }, { - "name" : "artifactId", - "in" : "path", - "description" : "The artifact identifier", - "required" : true, - "type" : "string" - }, { - "name" : "version", - "in" : "path", - "description" : "The version", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/extension-repository/{groupId}/{artifactId}/{version}/sha256" : { - "get" : { - "tags" : [ "extension repository" ], - "summary" : "Get global extension repo version checksum", - "description" : "Gets the hex representation of the SHA-256 digest for the binary content with the given bucket, group, artifact, and version. Since the same group-artifact-version can exist in multiple buckets, this will return the checksum of the first one returned. This will be consistent since the checksum must be the same when existing in multiple buckets. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getGlobalExtensionRepoVersionSha256", - "consumes" : [ "*/*" ], - "produces" : [ "text/plain" ], - "parameters" : [ { - "name" : "groupId", - "in" : "path", - "description" : "The group identifier", - "required" : true, - "type" : "string" - }, { - "name" : "artifactId", - "in" : "path", - "description" : "The artifact identifier", - "required" : true, - "type" : "string" - }, { - "name" : "version", - "in" : "path", - "description" : "The version", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ] - } - }, - "/extensions" : { - "get" : { - "tags" : [ "extensions" ], - "summary" : "Get all extensions", - "description" : "Gets the metadata for all extensions that match the filter params and are part of bundles located in buckets the current user is authorized for. If the user is not authorized to any buckets, an empty result set will be returned.\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getExtensions", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bundleType", - "in" : "query", - "description" : "The type of bundles to return", - "required" : false, - "type" : "string", - "enum" : [ "nifi-nar", "minifi-cpp" ] - }, { - "name" : "extensionType", - "in" : "query", - "description" : "The type of extensions to return", - "required" : false, - "type" : "string", - "enum" : [ "PROCESSOR", "CONTROLLER_SERVICE", "REPORTING_TASK" ] - }, { - "name" : "tag", - "in" : "query", - "description" : "The tags to filter on, will be used in an OR statement", - "required" : false, - "type" : "array", - "items" : { - "type" : "string" - }, - "collectionFormat" : "multi" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ExtensionMetadataContainer" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ] - } - }, - "/extensions/provided-service-api" : { - "get" : { - "tags" : [ "extensions" ], - "summary" : "Get extensions providing service API", - "description" : "Gets the metadata for extensions that provide the specified API and are part of bundles located in buckets the current user is authorized for. If the user is not authorized to any buckets, an empty result set will be returned.\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getExtensionsProvidingServiceAPI", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "className", - "in" : "query", - "description" : "The name of the service API class", - "required" : true, - "type" : "string" - }, { - "name" : "groupId", - "in" : "query", - "description" : "The groupId of the bundle containing the service API class", - "required" : true, - "type" : "string" - }, { - "name" : "artifactId", - "in" : "query", - "description" : "The artifactId of the bundle containing the service API class", - "required" : true, - "type" : "string" - }, { - "name" : "version", - "in" : "query", - "description" : "The version of the bundle containing the service API class", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ExtensionMetadataContainer" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ] - } - }, - "/extensions/tags" : { - "get" : { - "tags" : [ "extensions" ], - "summary" : "Get extension tags", - "description" : "Gets all the extension tags known to this NiFi Registry instance, along with the number of extensions that have the given tag.\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getTags", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/TagCount" - } - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ] - } - }, - "/flows/fields" : { - "get" : { - "tags" : [ "flows" ], - "summary" : "Get flow fields", - "description" : "Retrieves the flow field names that can be used for searching or sorting on flows.", - "operationId" : "getAvailableFlowFields", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/Fields" - } - } - }, - "security" : [ { - "Authorization" : [ ] - } ] - } - }, - "/flows/{flowId}" : { - "get" : { - "tags" : [ "flows" ], - "summary" : "Get flow", - "description" : "Gets a flow by id.", - "operationId" : "globalGetFlow", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "flowId", - "in" : "path", - "description" : "The flow identifier", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlow" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/flows/{flowId}/versions" : { - "get" : { - "tags" : [ "flows" ], - "summary" : "Get flow versions", - "description" : "Gets summary information for all versions of a given flow. Versions are ordered newest->oldest.", - "operationId" : "globalGetFlowVersions", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "flowId", - "in" : "path", - "description" : "The flow identifier", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/VersionedFlowSnapshotMetadata" - } - } - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/flows/{flowId}/versions/latest" : { - "get" : { - "tags" : [ "flows" ], - "summary" : "Get latest flow version", - "description" : "Gets the latest version of a flow, including metadata and flow content.", - "operationId" : "globalGetLatestFlowVersion", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "flowId", - "in" : "path", - "description" : "The flow identifier", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlowSnapshot" - } - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/flows/{flowId}/versions/latest/metadata" : { - "get" : { - "tags" : [ "flows" ], - "summary" : "Get latest flow version metadata", - "description" : "Gets the metadata for the latest version of a flow.", - "operationId" : "globalGetLatestFlowVersionMetadata", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "flowId", - "in" : "path", - "description" : "The flow identifier", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlowSnapshotMetadata" - } - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/flows/{flowId}/versions/{versionNumber}" : { - "get" : { - "tags" : [ "flows" ], - "summary" : "Get flow version", - "description" : "Gets the given version of a flow, including metadata and flow content.", - "operationId" : "globalGetFlowVersion", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "flowId", - "in" : "path", - "description" : "The flow identifier", - "required" : true, - "type" : "string" - }, { - "name" : "versionNumber", - "in" : "path", - "description" : "The version number", - "required" : true, - "type" : "integer", - "pattern" : "\\d+", - "format" : "int32" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlowSnapshot" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/items" : { - "get" : { - "tags" : [ "items" ], - "summary" : "Get all items", - "description" : "Get items across all buckets. The returned items will include only items from buckets for which the user is authorized. If the user is not authorized to any buckets, an empty list will be returned.", - "operationId" : "getItems", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/BucketItem" - } - } - }, - "401" : { - "description" : "Client could not be authenticated." - } - }, - "security" : [ { - "Authorization" : [ ] - } ] - } - }, - "/items/fields" : { - "get" : { - "tags" : [ "items" ], - "summary" : "Get item fields", - "description" : "Retrieves the item field names for searching or sorting on bucket items.", - "operationId" : "getAvailableBucketItemFields", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/Fields" - } - } - }, - "security" : [ { - "Authorization" : [ ] - } ] - } - }, - "/items/{bucketId}" : { - "get" : { - "tags" : [ "items" ], - "summary" : "Get bucket items", - "description" : "Gets the items located in the given bucket.", - "operationId" : "getItemsInBucket", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketId", - "in" : "path", - "description" : "The bucket identifier", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/BucketItem" - } - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/policies" : { - "get" : { - "tags" : [ "policies" ], - "summary" : "Get all access policies", - "description" : "", - "operationId" : "getAccessPolicies", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/AccessPolicy" - } - } - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/policies", - "action" : "read" - } - }, - "post" : { - "tags" : [ "policies" ], - "summary" : "Create access policy", - "description" : "", - "operationId" : "createAccessPolicy", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The access policy configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/AccessPolicy" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/AccessPolicy" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid. The NiFi Registry might not be configured to use a ConfigurableAccessPolicyProvider." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/policies", - "action" : "write" - } - } - }, - "/policies/resources" : { - "get" : { - "tags" : [ "policies" ], - "summary" : "Get available resources", - "description" : "Gets the available resources that support access/authorization policies", - "operationId" : "getResources", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/Resource" - } - } - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/policies", - "action" : "read" - } - } - }, - "/policies/{action}/{resource}" : { - "get" : { - "tags" : [ "policies" ], - "summary" : "Get access policy for resource", - "description" : "Gets an access policy for the specified action and resource", - "operationId" : "getAccessPolicyForResource", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "action", - "in" : "path", - "description" : "The request action.", - "required" : true, - "type" : "string", - "enum" : [ "read", "write", "delete" ] - }, { - "name" : "resource", - "in" : "path", - "description" : "The resource of the policy.", - "required" : true, - "type" : "string", - "pattern" : ".+" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/AccessPolicy" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/policies", - "action" : "read" - } - } - }, - "/policies/{id}" : { - "get" : { - "tags" : [ "policies" ], - "summary" : "Get access policy", - "description" : "", - "operationId" : "getAccessPolicy", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The access policy id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/AccessPolicy" - } - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/policies", - "action" : "read" - } - }, - "put" : { - "tags" : [ "policies" ], - "summary" : "Update access policy", - "description" : "", - "operationId" : "updateAccessPolicy", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The access policy id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The access policy configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/AccessPolicy" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/AccessPolicy" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid. The NiFi Registry might not be configured to use a ConfigurableAccessPolicyProvider." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/policies", - "action" : "write" - } - }, - "delete" : { - "tags" : [ "policies" ], - "summary" : "Delete access policy", - "description" : "", - "operationId" : "removeAccessPolicy", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The version is used to verify the client is working with the latest version of the entity.", - "required" : true, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The access policy id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/AccessPolicy" - } - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid. The NiFi Registry might not be configured to use a ConfigurableAccessPolicyProvider." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/policies", - "action" : "delete" - } - } - }, - "/tenants/user-groups" : { - "get" : { - "tags" : [ "tenants" ], - "summary" : "Get user groups", - "description" : "\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getUserGroups", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/UserGroup" - } - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/tenants", - "action" : "read" - } - }, - "post" : { - "tags" : [ "tenants" ], - "summary" : "Create user group", - "description" : "\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "createUserGroup", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The user group configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/UserGroup" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/UserGroup" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/tenants", - "action" : "write" - } - } - }, - "/tenants/user-groups/{id}" : { - "get" : { - "tags" : [ "tenants" ], - "summary" : "Get user group", - "description" : "\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getUserGroup", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The user group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/UserGroup" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/tenants", - "action" : "read" - } - }, - "put" : { - "tags" : [ "tenants" ], - "summary" : "Update user group", - "description" : "\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "updateUserGroup", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The user group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The user group configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/UserGroup" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/UserGroup" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/tenants", - "action" : "write" - } - }, - "delete" : { - "tags" : [ "tenants" ], - "summary" : "Delete user group", - "description" : "\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "removeUserGroup", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The version is used to verify the client is working with the latest version of the entity.", - "required" : true, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The user group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/UserGroup" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/tenants", - "action" : "delete" - } - } - }, - "/tenants/users" : { - "get" : { - "tags" : [ "tenants" ], - "summary" : "Get all users", - "description" : "\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getUsers", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/User" - } - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/tenants", - "action" : "read" - } - }, - "post" : { - "tags" : [ "tenants" ], - "summary" : "Create user", - "description" : "\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "createUser", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The user configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/User" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/User" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/tenants", - "action" : "write" - } - } - }, - "/tenants/users/{id}" : { - "get" : { - "tags" : [ "tenants" ], - "summary" : "Get user", - "description" : "\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getUser", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The user id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/User" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/tenants", - "action" : "read" - } - }, - "put" : { - "tags" : [ "tenants" ], - "summary" : "Update user", - "description" : "\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "updateUser", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The user id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The user configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/User" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/User" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/tenants", - "action" : "write" - } - }, - "delete" : { - "tags" : [ "tenants" ], - "summary" : "Delete user", - "description" : "\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "removeUser", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The version is used to verify the client is working with the latest version of the entity.", - "required" : true, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The user id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/User" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/tenants", - "action" : "delete" - } - } - } - }, - "securityDefinitions" : { - "Authorization" : { - "description" : "NiFi Registry Auth Token (JWT)", - "type" : "apiKey", - "name" : "Authorization", - "in" : "header" - }, - "BasicAuth" : { - "description" : "HTTP Basic Auth", - "type" : "basic" - } - }, - "definitions" : { - "AccessPolicy" : { - "type" : "object", - "required" : [ "action", "resource" ], - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The id of the policy. Set by server at creation time.", - "readOnly" : true - }, - "resource" : { - "type" : "string", - "description" : "The resource for this access policy." - }, - "action" : { - "type" : "string", - "description" : "The action associated with this access policy.", - "enum" : [ "read", "write", "delete" ] - }, - "configurable" : { - "type" : "boolean", - "description" : "Indicates if this access policy is configurable, based on which Authorizer has been configured to manage it.", - "readOnly" : true - }, - "revision" : { - "description" : "The revision of this entity used for optimistic-locking during updates.", - "readOnly" : true, - "$ref" : "#/definitions/RevisionInfo" - }, - "users" : { - "type" : "array", - "description" : "The set of user IDs associated with this access policy.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/Tenant" - } - }, - "userGroups" : { - "type" : "array", - "description" : "The set of user group IDs associated with this access policy.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/Tenant" - } - } - } - }, - "AccessPolicySummary" : { - "type" : "object", - "required" : [ "action", "resource" ], - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The id of the policy. Set by server at creation time.", - "readOnly" : true - }, - "resource" : { - "type" : "string", - "description" : "The resource for this access policy." - }, - "action" : { - "type" : "string", - "description" : "The action associated with this access policy.", - "enum" : [ "read", "write", "delete" ] - }, - "configurable" : { - "type" : "boolean", - "description" : "Indicates if this access policy is configurable, based on which Authorizer has been configured to manage it.", - "readOnly" : true - }, - "revision" : { - "description" : "The revision of this entity used for optimistic-locking during updates.", - "readOnly" : true, - "$ref" : "#/definitions/RevisionInfo" - } - } - }, - "AllowableValue" : { - "type" : "object", - "properties" : { - "value" : { - "type" : "string", - "description" : "The value of the allowable value" - }, - "displayName" : { - "type" : "string", - "description" : "The display name of the allowable value" - }, - "description" : { - "type" : "string", - "description" : "The description of the allowable value" - } - } - }, - "Attribute" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The name of the attribute" - }, - "description" : { - "type" : "string", - "description" : "The description of the attribute" - } - } - }, - "BatchSize" : { - "type" : "object", - "properties" : { - "count" : { - "type" : "integer", - "format" : "int32", - "description" : "Preferred number of flow files to include in a transaction." - }, - "size" : { - "type" : "string", - "description" : "Preferred number of bytes to include in a transaction." - }, - "duration" : { - "type" : "string", - "description" : "Preferred amount of time that a transaction should span." - } - } - }, - "Bucket" : { - "type" : "object", - "required" : [ "name" ], - "properties" : { - "link" : { - "description" : "An WebLink to this entity.", - "readOnly" : true, - "$ref" : "#/definitions/JaxbLink" - }, - "identifier" : { - "type" : "string", - "description" : "An ID to uniquely identify this object.", - "readOnly" : true - }, - "name" : { - "type" : "string", - "description" : "The name of the bucket." - }, - "createdTimestamp" : { - "type" : "integer", - "format" : "int64", - "description" : "The timestamp of when the bucket was first created. This is set by the server at creation time.", - "readOnly" : true, - "minimum" : 1 - }, - "description" : { - "type" : "string", - "description" : "A description of the bucket." - }, - "allowBundleRedeploy" : { - "type" : "boolean", - "description" : "Indicates if this bucket allows the same version of an extension bundle to be redeployed and thus overwrite the existing artifact. By default this is false." - }, - "allowPublicRead" : { - "type" : "boolean", - "description" : "Indicates if this bucket allows read access to unauthenticated anonymous users" - }, - "permissions" : { - "description" : "The access that the current user has to this bucket.", - "readOnly" : true, - "$ref" : "#/definitions/Permissions" - }, - "revision" : { - "description" : "The revision of this entity used for optimistic-locking during updates.", - "readOnly" : true, - "$ref" : "#/definitions/RevisionInfo" - } - } - }, - "BucketItem" : { - "type" : "object", - "required" : [ "bucketIdentifier", "name", "type" ], - "properties" : { - "link" : { - "description" : "An WebLink to this entity.", - "readOnly" : true, - "$ref" : "#/definitions/JaxbLink" - }, - "identifier" : { - "type" : "string", - "description" : "An ID to uniquely identify this object.", - "readOnly" : true - }, - "name" : { - "type" : "string", - "description" : "The name of the item." - }, - "description" : { - "type" : "string", - "description" : "A description of the item." - }, - "bucketIdentifier" : { - "type" : "string", - "description" : "The identifier of the bucket this items belongs to. This cannot be changed after the item is created." - }, - "bucketName" : { - "type" : "string", - "description" : "The name of the bucket this items belongs to.", - "readOnly" : true - }, - "createdTimestamp" : { - "type" : "integer", - "format" : "int64", - "description" : "The timestamp of when the item was created, as milliseconds since epoch.", - "readOnly" : true, - "minimum" : 1 - }, - "modifiedTimestamp" : { - "type" : "integer", - "format" : "int64", - "description" : "The timestamp of when the item was last modified, as milliseconds since epoch.", - "readOnly" : true, - "minimum" : 1 - }, - "type" : { - "type" : "string", - "description" : "The type of item.", - "enum" : [ "Flow", "Bundle" ] - }, - "permissions" : { - "description" : "The access that the current user has to the bucket containing this item.", - "readOnly" : true, - "$ref" : "#/definitions/Permissions" - } - } - }, - "BuildInfo" : { - "type" : "object", - "properties" : { - "buildTool" : { - "type" : "string", - "description" : "The tool used to build the version of the bundle" - }, - "buildFlags" : { - "type" : "string", - "description" : "The flags used to build the version of the bundle" - }, - "buildBranch" : { - "type" : "string", - "description" : "The branch used to build the version of the bundle" - }, - "buildTag" : { - "type" : "string", - "description" : "The tag used to build the version of the bundle" - }, - "buildRevision" : { - "type" : "string", - "description" : "The revision used to build the version of the bundle" - }, - "built" : { - "type" : "integer", - "format" : "int64", - "description" : "The timestamp the version of the bundle was built" - }, - "builtBy" : { - "type" : "string", - "description" : "The identity of the user that performed the build" - } - } - }, - "Bundle" : { - "type" : "object", - "properties" : { - "group" : { - "type" : "string", - "description" : "The group of the bundle" - }, - "artifact" : { - "type" : "string", - "description" : "The artifact of the bundle" - }, - "version" : { - "type" : "string", - "description" : "The version of the bundle" - } - } - }, - "BundleInfo" : { - "type" : "object", - "properties" : { - "bucketId" : { - "type" : "string", - "description" : "The id of the bucket where the bundle is located" - }, - "bucketName" : { - "type" : "string", - "description" : "The name of the bucket where the bundle is located" - }, - "bundleId" : { - "type" : "string", - "description" : "The id of the bundle" - }, - "bundleType" : { - "type" : "string", - "description" : "The type of bundle (i.e. a NiFi NAR vs MiNiFi CPP)", - "enum" : [ "NIFI_NAR", "MINIFI_CPP" ] - }, - "groupId" : { - "type" : "string", - "description" : "The group id of the bundle" - }, - "artifactId" : { - "type" : "string", - "description" : "The artifact id of the bundle" - }, - "version" : { - "type" : "string", - "description" : "The version of the bundle" - }, - "systemApiVersion" : { - "type" : "string", - "description" : "The version of the system API the bundle was built against" - } - } - }, - "BundleVersion" : { - "type" : "object", - "required" : [ "versionMetadata" ], - "properties" : { - "link" : { - "description" : "An WebLink to this entity.", - "readOnly" : true, - "$ref" : "#/definitions/JaxbLink" - }, - "versionMetadata" : { - "description" : "The metadata about this version of the extension bundle", - "$ref" : "#/definitions/BundleVersionMetadata" - }, - "dependencies" : { - "type" : "array", - "description" : "The set of other bundle versions that this version is dependent on", - "readOnly" : true, - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/BundleVersionDependency" - } - }, - "bundle" : { - "description" : "The bundle this version is for", - "readOnly" : true, - "$ref" : "#/definitions/ExtensionBundle" - }, - "bucket" : { - "description" : "The bucket that the extension bundle belongs to", - "$ref" : "#/definitions/Bucket" - }, - "filename" : { - "type" : "string" - } - } - }, - "BundleVersionDependency" : { - "type" : "object", - "properties" : { - "groupId" : { - "type" : "string", - "description" : "The group id of the bundle dependency" - }, - "artifactId" : { - "type" : "string", - "description" : "The artifact id of the bundle dependency" - }, - "version" : { - "type" : "string", - "description" : "The version of the bundle dependency" - } - } - }, - "BundleVersionMetadata" : { - "type" : "object", - "required" : [ "bucketId", "buildInfo", "contentSize", "sha256Supplied" ], - "properties" : { - "link" : { - "description" : "An WebLink to this entity.", - "readOnly" : true, - "$ref" : "#/definitions/JaxbLink" - }, - "id" : { - "type" : "string", - "description" : "The id of this version of the extension bundle" - }, - "bundleId" : { - "type" : "string", - "description" : "The id of the extension bundle this version is for" - }, - "bucketId" : { - "type" : "string", - "description" : "The id of the bucket the extension bundle belongs to" - }, - "groupId" : { - "type" : "string" - }, - "artifactId" : { - "type" : "string" - }, - "version" : { - "type" : "string", - "description" : "The version of the extension bundle" - }, - "timestamp" : { - "type" : "integer", - "format" : "int64", - "description" : "The timestamp of the create date of this version", - "minimum" : 1 - }, - "author" : { - "type" : "string", - "description" : "The identity that created this version" - }, - "description" : { - "type" : "string", - "description" : "The description for this version" - }, - "sha256" : { - "type" : "string", - "description" : "The hex representation of the SHA-256 digest of the binary content for this version" - }, - "sha256Supplied" : { - "type" : "boolean", - "description" : "Whether or not the client supplied a SHA-256 when uploading the bundle" - }, - "contentSize" : { - "type" : "integer", - "format" : "int64", - "description" : "The size of the binary content for this version in bytes", - "minimum" : 0 - }, - "systemApiVersion" : { - "type" : "string", - "description" : "The version of the system API that this bundle version was built against" - }, - "buildInfo" : { - "description" : "The build information about this version", - "$ref" : "#/definitions/BuildInfo" - } - } - }, - "ComponentDifference" : { - "type" : "object", - "properties" : { - "valueA" : { - "type" : "string", - "description" : "The earlier value from the difference." - }, - "valueB" : { - "type" : "string", - "description" : "The newer value from the difference." - }, - "changeDescription" : { - "type" : "string", - "description" : "The description of the change." - }, - "differenceType" : { - "type" : "string", - "description" : "The key to the difference." - }, - "differenceTypeDescription" : { - "type" : "string", - "description" : "The description of the change type." - } - } - }, - "ComponentDifferenceGroup" : { - "type" : "object", - "properties" : { - "componentId" : { - "type" : "string", - "description" : "The id of the component whose changes are grouped together." - }, - "componentName" : { - "type" : "string", - "description" : "The name of the component whose changes are grouped together." - }, - "componentType" : { - "type" : "string", - "description" : "The type of component these changes relate to." - }, - "processGroupId" : { - "type" : "string", - "description" : "The process group id for this component." - }, - "differences" : { - "type" : "array", - "description" : "The list of changes related to this component between the 2 versions.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ComponentDifference" - } - } - } - }, - "ConnectableComponent" : { - "type" : "object", - "required" : [ "groupId", "id", "type" ], - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the connectable component." - }, - "type" : { - "type" : "string", - "description" : "The type of component the connectable is.", - "enum" : [ "PROCESSOR", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "INPUT_PORT", "OUTPUT_PORT", "FUNNEL" ] - }, - "groupId" : { - "type" : "string", - "description" : "The id of the group that the connectable component resides in" - }, - "name" : { - "type" : "string", - "description" : "The name of the connectable component" - }, - "comments" : { - "type" : "string", - "description" : "The comments for the connectable component." - }, - "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" - } - } - }, - "ControllerServiceAPI" : { - "type" : "object", - "properties" : { - "type" : { - "type" : "string", - "description" : "The fully qualified name of the service interface." - }, - "bundle" : { - "description" : "The details of the artifact that bundled this service interface.", - "$ref" : "#/definitions/Bundle" - } - } - }, - "ControllerServiceDefinition" : { - "type" : "object", - "properties" : { - "className" : { - "type" : "string", - "description" : "The class name of the service API" - }, - "groupId" : { - "type" : "string", - "description" : "The group id of the service API" - }, - "artifactId" : { - "type" : "string", - "description" : "The artifact id of the service API" - }, - "version" : { - "type" : "string", - "description" : "The version of the service API" - } - } - }, - "CurrentUser" : { - "type" : "object", - "properties" : { - "identity" : { - "type" : "string", - "description" : "The identity of the current user", - "readOnly" : true - }, - "anonymous" : { - "type" : "boolean", - "description" : "Indicates if the current user is anonymous", - "readOnly" : true - }, - "loginSupported" : { - "type" : "boolean", - "description" : "Indicates if the NiFi Registry instance supports logging in" - }, - "resourcePermissions" : { - "description" : "The access that the current user has to top level resources", - "readOnly" : true, - "$ref" : "#/definitions/ResourcePermissions" - }, - "oidcloginSupported" : { - "type" : "boolean", - "description" : "Indicates if the NiFi Registry instance supports logging in with an OIDC provider" - } - } - }, - "DefaultSchedule" : { - "type" : "object", - "properties" : { - "strategy" : { - "type" : "string", - "description" : "The default scheduling strategy" - }, - "period" : { - "type" : "string", - "description" : "The default scheduling period" - }, - "concurrentTasks" : { - "type" : "string", - "description" : "The default concurrent tasks" - } - } - }, - "DefaultSettings" : { - "type" : "object", - "properties" : { - "yieldDuration" : { - "type" : "string", - "description" : "The default yield duration" - }, - "penaltyDuration" : { - "type" : "string", - "description" : "The default penalty duration" - }, - "bulletinLevel" : { - "type" : "string", - "description" : "The default bulletin level" - } - } - }, - "Dependency" : { - "type" : "object", - "properties" : { - "propertyName" : { - "type" : "string", - "description" : "The name of the dependent property" - }, - "propertyDisplayName" : { - "type" : "string", - "description" : "The display name of the dependent property" - }, - "dependentValues" : { - "description" : "The values of the dependent property that enable the depending property", - "$ref" : "#/definitions/DependentValues" - } - } - }, - "DependentValues" : { - "type" : "object", - "properties" : { - "values" : { - "type" : "array", - "xml" : { - "name" : "dependentValue" - }, - "description" : "The dependent values", - "items" : { - "type" : "string", - "xml" : { - "name" : "dependentValue" - } - } - } - } - }, - "DeprecationNotice" : { - "type" : "object", - "properties" : { - "reason" : { - "type" : "string", - "description" : "The reason for the deprecation" - }, - "alternatives" : { - "type" : "array", - "xml" : { - "wrapped" : true - }, - "description" : "The alternatives to use", - "items" : { - "type" : "string", - "xml" : { - "name" : "alternative" - } - } - } - } - }, - "DynamicProperty" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The description of the dynamic property name" - }, - "value" : { - "type" : "string", - "description" : "The description of the dynamic property value" - }, - "description" : { - "type" : "string", - "description" : "The description of the dynamic property" - }, - "expressionLanguageScope" : { - "type" : "string", - "description" : "The scope of the expression language support", - "enum" : [ "NONE", "VARIABLE_REGISTRY", "FLOWFILE_ATTRIBUTES" ] - }, - "expressionLanguageSupported" : { - "type" : "boolean", - "description" : "Whether or not expression language is supported" - } - } - }, - "DynamicRelationship" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The description of the dynamic relationship name" - }, - "description" : { - "type" : "string", - "description" : "The description of the dynamic relationship" - } - } - }, - "Extension" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The name of the extension" - }, - "type" : { - "type" : "string", - "description" : "The type of the extension", - "enum" : [ "PROCESSOR", "CONTROLLER_SERVICE", "REPORTING_TASK" ] - }, - "deprecationNotice" : { - "description" : "The deprecation notice of the extension", - "$ref" : "#/definitions/DeprecationNotice" - }, - "description" : { - "type" : "string", - "description" : "The description of the extension" - }, - "tags" : { - "type" : "array", - "xml" : { - "wrapped" : true - }, - "description" : "The tags of the extension", - "items" : { - "type" : "string", - "xml" : { - "name" : "tag" - } - } - }, - "properties" : { - "type" : "array", - "xml" : { - "wrapped" : true - }, - "description" : "The properties of the extension", - "items" : { - "xml" : { - "name" : "property" - }, - "$ref" : "#/definitions/Property" - } - }, - "dynamicProperties" : { - "type" : "array", - "xml" : { - "wrapped" : true - }, - "description" : "The dynamic properties of the extension", - "items" : { - "xml" : { - "name" : "dynamicProperty" - }, - "$ref" : "#/definitions/DynamicProperty" - } - }, - "relationships" : { - "type" : "array", - "xml" : { - "wrapped" : true - }, - "description" : "The relationships of the extension", - "items" : { - "xml" : { - "name" : "relationship" - }, - "$ref" : "#/definitions/Relationship" - } - }, - "dynamicRelationship" : { - "description" : "The dynamic relationships of the extension", - "$ref" : "#/definitions/DynamicRelationship" - }, - "readsAttributes" : { - "type" : "array", - "xml" : { - "wrapped" : true - }, - "description" : "The attributes read from flow files by the extension", - "items" : { - "xml" : { - "name" : "readsAttribute" - }, - "$ref" : "#/definitions/Attribute" - } - }, - "writesAttributes" : { - "type" : "array", - "xml" : { - "wrapped" : true - }, - "description" : "The attributes written to flow files by the extension", - "items" : { - "xml" : { - "name" : "writesAttribute" - }, - "$ref" : "#/definitions/Attribute" - } - }, - "stateful" : { - "description" : "The information about how the extension stores state", - "$ref" : "#/definitions/Stateful" - }, - "restricted" : { - "description" : "The restrictions of the extension", - "$ref" : "#/definitions/Restricted" - }, - "inputRequirement" : { - "type" : "string", - "description" : "The input requirement of the extension", - "enum" : [ "INPUT_REQUIRED", "INPUT_ALLOWED", "INPUT_FORBIDDEN" ] - }, - "systemResourceConsiderations" : { - "type" : "array", - "xml" : { - "wrapped" : true - }, - "description" : "The resource considerations of the extension", - "items" : { - "xml" : { - "name" : "systemResourceConsideration" - }, - "$ref" : "#/definitions/SystemResourceConsideration" - } - }, - "seeAlso" : { - "type" : "array", - "xml" : { - "wrapped" : true - }, - "description" : "The names of other extensions to see", - "items" : { - "type" : "string", - "xml" : { - "name" : "see" - } - } - }, - "providedServiceAPIs" : { - "type" : "array", - "xml" : { - "wrapped" : true - }, - "description" : "The service APIs provided by this extension", - "items" : { - "xml" : { - "name" : "providedServiceAPI" - }, - "$ref" : "#/definitions/ProvidedServiceAPI" - } - }, - "defaultSettings" : { - "description" : "The default settings for a processor", - "$ref" : "#/definitions/DefaultSettings" - }, - "defaultSchedule" : { - "description" : "The default schedule for a processor reporting task", - "$ref" : "#/definitions/DefaultSchedule" - }, - "triggerSerially" : { - "type" : "boolean", - "description" : "Indicates that a processor should be triggered serially" - }, - "triggerWhenEmpty" : { - "type" : "boolean", - "description" : "Indicates that a processor should be triggered when the incoming queues are empty" - }, - "triggerWhenAnyDestinationAvailable" : { - "type" : "boolean", - "description" : "Indicates that a processor should be triggered when any destinations have space for flow files" - }, - "supportsBatching" : { - "type" : "boolean", - "description" : "Indicates that a processor supports batching" - }, - "eventDriven" : { - "type" : "boolean", - "description" : "Indicates that a processor supports event driven scheduling" - }, - "primaryNodeOnly" : { - "type" : "boolean", - "description" : "Indicates that a processor should be scheduled only on the primary node" - }, - "sideEffectFree" : { - "type" : "boolean", - "description" : "Indicates that a processor is side effect free" - } - } - }, - "ExtensionBundle" : { - "type" : "object", - "required" : [ "bucketIdentifier", "bundleType", "name", "type" ], - "properties" : { - "link" : { - "description" : "An WebLink to this entity.", - "readOnly" : true, - "$ref" : "#/definitions/JaxbLink" - }, - "identifier" : { - "type" : "string", - "description" : "An ID to uniquely identify this object.", - "readOnly" : true - }, - "name" : { - "type" : "string", - "description" : "The name of the item." - }, - "description" : { - "type" : "string", - "description" : "A description of the item." - }, - "bucketIdentifier" : { - "type" : "string", - "description" : "The identifier of the bucket this items belongs to. This cannot be changed after the item is created." - }, - "bucketName" : { - "type" : "string", - "description" : "The name of the bucket this items belongs to.", - "readOnly" : true - }, - "createdTimestamp" : { - "type" : "integer", - "format" : "int64", - "description" : "The timestamp of when the item was created, as milliseconds since epoch.", - "readOnly" : true, - "minimum" : 1 - }, - "modifiedTimestamp" : { - "type" : "integer", - "format" : "int64", - "description" : "The timestamp of when the item was last modified, as milliseconds since epoch.", - "readOnly" : true, - "minimum" : 1 - }, - "type" : { - "type" : "string", - "description" : "The type of item.", - "enum" : [ "Flow", "Bundle" ] - }, - "permissions" : { - "description" : "The access that the current user has to the bucket containing this item.", - "readOnly" : true, - "$ref" : "#/definitions/Permissions" - }, - "bundleType" : { - "type" : "string", - "description" : "The type of the extension bundle", - "enum" : [ "NIFI_NAR", "MINIFI_CPP" ] - }, - "groupId" : { - "type" : "string", - "description" : "The group id of the extension bundle" - }, - "artifactId" : { - "type" : "string", - "description" : "The artifact id of the extension bundle" - }, - "versionCount" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of versions of this extension bundle.", - "readOnly" : true, - "minimum" : 0 - } - } - }, - "ExtensionFilterParams" : { - "type" : "object", - "properties" : { - "bundleType" : { - "type" : "string", - "description" : "The type of bundle", - "enum" : [ "NIFI_NAR", "MINIFI_CPP" ] - }, - "extensionType" : { - "type" : "string", - "description" : "The type of extension", - "enum" : [ "PROCESSOR", "CONTROLLER_SERVICE", "REPORTING_TASK" ] - }, - "tags" : { - "type" : "array", - "description" : "The tags", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - } - } - }, - "ExtensionMetadata" : { - "type" : "object", - "properties" : { - "link" : { - "description" : "An WebLink to this entity.", - "readOnly" : true, - "$ref" : "#/definitions/JaxbLink" - }, - "name" : { - "type" : "string", - "description" : "The name of the extension" - }, - "displayName" : { - "type" : "string", - "description" : "The display name of the extension" - }, - "type" : { - "type" : "string", - "description" : "The type of the extension", - "enum" : [ "PROCESSOR", "CONTROLLER_SERVICE", "REPORTING_TASK" ] - }, - "description" : { - "type" : "string", - "description" : "The description of the extension" - }, - "deprecationNotice" : { - "description" : "The deprecation notice of the extension", - "$ref" : "#/definitions/DeprecationNotice" - }, - "tags" : { - "type" : "array", - "description" : "The tags of the extension", - "items" : { - "type" : "string" - } - }, - "restricted" : { - "description" : "The restrictions of the extension", - "$ref" : "#/definitions/Restricted" - }, - "providedServiceAPIs" : { - "type" : "array", - "description" : "The service APIs provided by the extension", - "items" : { - "$ref" : "#/definitions/ProvidedServiceAPI" - } - }, - "bundleInfo" : { - "description" : "The information for the bundle where this extension is located", - "$ref" : "#/definitions/BundleInfo" - }, - "hasAdditionalDetails" : { - "type" : "boolean", - "description" : "Whether or not the extension has additional detail documentation" - }, - "linkDocs" : { - "description" : "A WebLink to the documentation for this extension.", - "readOnly" : true, - "$ref" : "#/definitions/JaxbLink" - } - } - }, - "ExtensionMetadataContainer" : { - "type" : "object", - "properties" : { - "numResults" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of extensions in the response" - }, - "filterParams" : { - "description" : "The filter parameters submitted for the request", - "$ref" : "#/definitions/ExtensionFilterParams" - }, - "extensions" : { - "type" : "array", - "description" : "The metadata for the extensions", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ExtensionMetadata" - } - } - } - }, - "ExtensionRepoArtifact" : { - "type" : "object", - "properties" : { - "link" : { - "description" : "An WebLink to this entity.", - "readOnly" : true, - "$ref" : "#/definitions/JaxbLink" - }, - "bucketName" : { - "type" : "string", - "description" : "The bucket name" - }, - "groupId" : { - "type" : "string", - "description" : "The group id" - }, - "artifactId" : { - "type" : "string", - "description" : "The artifact id" - } - } - }, - "ExtensionRepoBucket" : { - "type" : "object", - "properties" : { - "link" : { - "description" : "An WebLink to this entity.", - "readOnly" : true, - "$ref" : "#/definitions/JaxbLink" - }, - "bucketName" : { - "type" : "string", - "description" : "The name of the bucket" - } - } - }, - "ExtensionRepoGroup" : { - "type" : "object", - "properties" : { - "link" : { - "description" : "An WebLink to this entity.", - "readOnly" : true, - "$ref" : "#/definitions/JaxbLink" - }, - "bucketName" : { - "type" : "string", - "description" : "The bucket name" - }, - "groupId" : { - "type" : "string", - "description" : "The group id" - } - } - }, - "ExtensionRepoVersion" : { - "type" : "object", - "properties" : { - "extensionsLink" : { - "description" : "The WebLink to view the metadata about the extensions contained in the extension bundle.", - "readOnly" : true, - "$ref" : "#/definitions/JaxbLink" - }, - "downloadLink" : { - "description" : "The WebLink to download this version of the extension bundle.", - "readOnly" : true, - "$ref" : "#/definitions/JaxbLink" - }, - "sha256Link" : { - "description" : "The WebLink to retrieve the SHA-256 digest for this version of the extension bundle.", - "readOnly" : true, - "$ref" : "#/definitions/JaxbLink" - }, - "sha256Supplied" : { - "description" : "Indicates if the client supplied a SHA-256 when uploading this version of the extension bundle.", - "readOnly" : true, - "$ref" : "#/definitions/JaxbLink" - } - } - }, - "ExtensionRepoVersionSummary" : { - "type" : "object", - "properties" : { - "link" : { - "description" : "An WebLink to this entity.", - "readOnly" : true, - "$ref" : "#/definitions/JaxbLink" - }, - "bucketName" : { - "type" : "string", - "description" : "The bucket name" - }, - "groupId" : { - "type" : "string", - "description" : "The group id" - }, - "artifactId" : { - "type" : "string", - "description" : "The artifact id" - }, - "version" : { - "type" : "string", - "description" : "The version" - }, - "author" : { - "type" : "string", - "description" : "The identity of the user that created this version" - }, - "timestamp" : { - "type" : "integer", - "format" : "int64", - "description" : "The timestamp of when this version was created" - } - } - }, - "ExternalControllerServiceReference" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The identifier of the controller service" - }, - "name" : { - "type" : "string", - "description" : "The name of the controller service" - } - } - }, - "Fields" : { - "type" : "object", - "properties" : { - "fields" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - } - } - }, - "JaxbLink" : { - "type" : "object", - "properties" : { - "href" : { - "type" : "string", - "format" : "uri", - "xml" : { - "attribute" : true - }, - "description" : "The href for the link" - }, - "params" : { - "type" : "object", - "description" : "The params for the link", - "additionalProperties" : { - "type" : "string" - } - } - } - }, - "ParameterProviderReference" : { - "type" : "object", - "properties" : { - "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." - }, - "bundle" : { - "description" : "The details of the artifact that bundled this parameter provider.", - "$ref" : "#/definitions/Bundle" - } - } - }, - "Permissions" : { - "type" : "object", - "properties" : { - "canRead" : { - "type" : "boolean", - "description" : "Indicates whether the user can read a given resource.", - "readOnly" : true - }, - "canWrite" : { - "type" : "boolean", - "description" : "Indicates whether the user can write a given resource.", - "readOnly" : true - }, - "canDelete" : { - "type" : "boolean", - "description" : "Indicates whether the user can delete a given resource.", - "readOnly" : true - } - } - }, - "Position" : { - "type" : "object", - "properties" : { - "x" : { - "type" : "number", - "format" : "double", - "description" : "The x coordinate." - }, - "y" : { - "type" : "number", - "format" : "double", - "description" : "The y coordinate." - } - }, - "description" : "The position of a component on the graph" - }, - "Property" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The name of the property" - }, - "displayName" : { - "type" : "string", - "description" : "The display name" - }, - "description" : { - "type" : "string", - "description" : "The description" - }, - "defaultValue" : { - "type" : "string", - "description" : "The default value" - }, - "controllerServiceDefinition" : { - "description" : "The controller service required by this property, or null if none is required", - "$ref" : "#/definitions/ControllerServiceDefinition" - }, - "allowableValues" : { - "type" : "array", - "xml" : { - "wrapped" : true - }, - "description" : "The allowable values for this property", - "items" : { - "xml" : { - "name" : "allowableValue" - }, - "$ref" : "#/definitions/AllowableValue" - } - }, - "required" : { - "type" : "boolean", - "description" : "Whether or not the property is required" - }, - "sensitive" : { - "type" : "boolean", - "description" : "Whether or not the property is sensitive" - }, - "expressionLanguageSupported" : { - "type" : "boolean", - "description" : "Whether or not expression language is supported" - }, - "expressionLanguageScope" : { - "type" : "string", - "description" : "The scope of expression language support", - "enum" : [ "NONE", "VARIABLE_REGISTRY", "FLOWFILE_ATTRIBUTES" ] - }, - "dynamicallyModifiesClasspath" : { - "type" : "boolean", - "description" : "Whether or not the processor dynamically modifies the classpath" - }, - "dynamic" : { - "type" : "boolean", - "description" : "Whether or not the processor is dynamic" - }, - "dependencies" : { - "type" : "array", - "xml" : { - "wrapped" : true - }, - "description" : "The properties that this property depends on", - "items" : { - "xml" : { - "name" : "dependency" - }, - "$ref" : "#/definitions/Dependency" - } - }, - "resourceDefinition" : { - "description" : "The optional resource definition", - "$ref" : "#/definitions/ResourceDefinition" - } - } - }, - "ProvidedServiceAPI" : { - "type" : "object", - "properties" : { - "className" : { - "type" : "string", - "description" : "The class name of the service API being provided" - }, - "groupId" : { - "type" : "string", - "description" : "The group id of the service API being provided" - }, - "artifactId" : { - "type" : "string", - "description" : "The artifact id of the service API being provided" - }, - "version" : { - "type" : "string", - "description" : "The version of the service API being provided" - } - } - }, - "RegistryAbout" : { - "type" : "object", - "properties" : { - "registryAboutVersion" : { - "type" : "string", - "description" : "The version string for this Nifi Registry", - "readOnly" : true - } - } - }, - "RegistryConfiguration" : { - "type" : "object", - "properties" : { - "supportsManagedAuthorizer" : { - "type" : "boolean", - "description" : "Whether this NiFi Registry supports a managed authorizer. Managed authorizers can visualize users, groups, and policies in the UI.", - "readOnly" : true - }, - "supportsConfigurableAuthorizer" : { - "type" : "boolean", - "description" : "Whether this NiFi Registry supports a configurable authorizer.", - "readOnly" : true - }, - "supportsConfigurableUsersAndGroups" : { - "type" : "boolean", - "description" : "Whether this NiFi Registry supports configurable users and groups.", - "readOnly" : true - } - } - }, - "Relationship" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The name of the relationship" - }, - "description" : { - "type" : "string", - "description" : "The description of the relationship" - }, - "autoTerminated" : { - "type" : "boolean", - "description" : "Whether or not the relationship is auto-terminated by default" - } - } - }, - "Resource" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The identifier of the resource.", - "readOnly" : true - }, - "name" : { - "type" : "string", - "description" : "The name of the resource.", - "readOnly" : true - } - } - }, - "ResourceDefinition" : { - "type" : "object", - "properties" : { - "cardinality" : { - "type" : "string", - "description" : "The cardinality of the resource definition", - "enum" : [ "SINGLE", "MULTIPLE" ] - }, - "resourceTypes" : { - "type" : "array", - "xml" : { - "wrapped" : true - }, - "description" : "The types of resources", - "items" : { - "type" : "string", - "xml" : { - "name" : "resourceType" - }, - "enum" : [ "FILE", "DIRECTORY", "TEXT", "URL" ] - } - } - } - }, - "ResourcePermissions" : { - "type" : "object", - "properties" : { - "buckets" : { - "description" : "The access that the current user has to the top level /buckets resource of this NiFi Registry (i.e., access to all buckets)", - "readOnly" : true, - "$ref" : "#/definitions/Permissions" - }, - "tenants" : { - "description" : "The access that the current user has to the top level /tenants resource of this NiFi Registry", - "readOnly" : true, - "$ref" : "#/definitions/Permissions" - }, - "policies" : { - "description" : "The access that the current user has to the top level /policies resource of this NiFi Registry", - "readOnly" : true, - "$ref" : "#/definitions/Permissions" - }, - "proxy" : { - "description" : "The access that the current user has to the top level /proxy resource of this NiFi Registry", - "readOnly" : true, - "$ref" : "#/definitions/Permissions" - }, - "anyTopLevelResource" : { - "description" : "The access that the current user has to any top level resources (a logical 'OR' of all other values)", - "readOnly" : true, - "$ref" : "#/definitions/Permissions" - } - } - }, - "Restricted" : { - "type" : "object", - "properties" : { - "generalRestrictionExplanation" : { - "type" : "string", - "description" : "The general restriction for the extension, or null if only specific restrictions exist" - }, - "restrictions" : { - "type" : "array", - "xml" : { - "wrapped" : true - }, - "description" : "The specific restrictions", - "items" : { - "xml" : { - "name" : "restriction" - }, - "$ref" : "#/definitions/Restriction" - } - } - } - }, - "Restriction" : { - "type" : "object", - "properties" : { - "requiredPermission" : { - "type" : "string", - "description" : "The permission required for this restriction" - }, - "explanation" : { - "type" : "string", - "description" : "The explanation of this restriction" - } - } - }, - "RevisionInfo" : { - "type" : "object", - "properties" : { - "clientId" : { - "type" : "string", - "description" : "A client identifier used to make a request. By including a client identifier, the API can allow multiple requests without needing the current revision. Due to the asynchronous nature of requests/responses this was implemented to allow the client to make numerous requests without having to wait for the previous response to come back." - }, - "version" : { - "type" : "integer", - "format" : "int64", - "description" : "NiFi Registry employs an optimistic locking strategy where the client must include a revision in their request when performing an update. In a response to a mutable flow request, this field represents the updated base version." - }, - "lastModifier" : { - "type" : "string", - "description" : "The user that last modified the entity.", - "readOnly" : true - } - }, - "description" : "The revision information for an entity managed through the REST API." - }, - "Stateful" : { - "type" : "object", - "properties" : { - "description" : { - "type" : "string", - "description" : "The description for how the extension stores state" - }, - "scopes" : { - "type" : "array", - "xml" : { - "wrapped" : true - }, - "description" : "The scopes used to store state", - "items" : { - "type" : "string", - "xml" : { - "name" : "scope" - }, - "enum" : [ "CLUSTER", "LOCAL" ] - } - } - } - }, - "SystemResourceConsideration" : { - "type" : "object", - "properties" : { - "resource" : { - "type" : "string", - "description" : "The resource to consider" - }, - "description" : { - "type" : "string", - "description" : "The description of how the resource is affected" - } - } - }, - "TagCount" : { - "type" : "object", - "properties" : { - "tag" : { - "type" : "string", - "description" : "The tag label" - }, - "count" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of occurrences of the given tag" - } - } - }, - "Tenant" : { - "type" : "object", - "required" : [ "identity" ], - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The computer-generated identifier of the tenant.", - "readOnly" : true - }, - "identity" : { - "type" : "string", - "description" : "The human-facing identity of the tenant. This can only be changed if the tenant is configurable." - }, - "configurable" : { - "type" : "boolean", - "description" : "Indicates if this tenant is configurable, based on which UserGroupProvider has been configured to manage it.", - "readOnly" : true - }, - "resourcePermissions" : { - "description" : "A summary top-level resource access policies granted to this tenant.", - "readOnly" : true, - "$ref" : "#/definitions/ResourcePermissions" - }, - "accessPolicies" : { - "type" : "array", - "description" : "The access policies granted to this tenant.", - "readOnly" : true, - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/AccessPolicySummary" - } - }, - "revision" : { - "description" : "The revision of this entity used for optimistic-locking during updates.", - "readOnly" : true, - "$ref" : "#/definitions/RevisionInfo" - } - } - }, - "User" : { - "type" : "object", - "required" : [ "identity" ], - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The computer-generated identifier of the tenant.", - "readOnly" : true - }, - "identity" : { - "type" : "string", - "description" : "The human-facing identity of the tenant. This can only be changed if the tenant is configurable." - }, - "configurable" : { - "type" : "boolean", - "description" : "Indicates if this tenant is configurable, based on which UserGroupProvider has been configured to manage it.", - "readOnly" : true - }, - "resourcePermissions" : { - "description" : "A summary top-level resource access policies granted to this tenant.", - "readOnly" : true, - "$ref" : "#/definitions/ResourcePermissions" - }, - "accessPolicies" : { - "type" : "array", - "description" : "The access policies granted to this tenant.", - "readOnly" : true, - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/AccessPolicySummary" - } - }, - "revision" : { - "description" : "The revision of this entity used for optimistic-locking during updates.", - "readOnly" : true, - "$ref" : "#/definitions/RevisionInfo" - }, - "userGroups" : { - "type" : "array", - "description" : "The groups to which the user belongs.", - "readOnly" : true, - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/Tenant" - } - } - } - }, - "UserGroup" : { - "type" : "object", - "required" : [ "identity" ], - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The computer-generated identifier of the tenant.", - "readOnly" : true - }, - "identity" : { - "type" : "string", - "description" : "The human-facing identity of the tenant. This can only be changed if the tenant is configurable." - }, - "configurable" : { - "type" : "boolean", - "description" : "Indicates if this tenant is configurable, based on which UserGroupProvider has been configured to manage it.", - "readOnly" : true - }, - "resourcePermissions" : { - "description" : "A summary top-level resource access policies granted to this tenant.", - "readOnly" : true, - "$ref" : "#/definitions/ResourcePermissions" - }, - "accessPolicies" : { - "type" : "array", - "description" : "The access policies granted to this tenant.", - "readOnly" : true, - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/AccessPolicySummary" - } - }, - "revision" : { - "description" : "The revision of this entity used for optimistic-locking during updates.", - "readOnly" : true, - "$ref" : "#/definitions/RevisionInfo" - }, - "users" : { - "type" : "array", - "description" : "The users that belong to this user group. This can only be changed if this group is configurable.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/Tenant" - } - } - } - }, - "VersionedConnection" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The component's unique identifier" - }, - "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" - }, - "comments" : { - "type" : "string", - "description" : "The user-supplied comments for the component" - }, - "position" : { - "description" : "The component's position on the graph", - "$ref" : "#/definitions/Position" - }, - "source" : { - "description" : "The source of the connection.", - "$ref" : "#/definitions/ConnectableComponent" - }, - "destination" : { - "description" : "The destination of the connection.", - "$ref" : "#/definitions/ConnectableComponent" - }, - "labelIndex" : { - "type" : "integer", - "format" : "int32", - "description" : "The index of the bend point where to place the connection label." - }, - "zIndex" : { - "type" : "integer", - "format" : "int64", - "description" : "The z index of the connection." - }, - "selectedRelationships" : { - "type" : "array", - "description" : "The selected relationship that comprise the connection.", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - }, - "backPressureObjectThreshold" : { - "type" : "integer", - "format" : "int64", - "description" : "The object count threshold for determining when back pressure is applied. Updating this value is a passive change in the sense that it won't impact whether existing files over the limit are affected but it does help feeder processors to stop pushing too much into this work queue." - }, - "backPressureDataSizeThreshold" : { - "type" : "string", - "description" : "The object data size threshold for determining when back pressure is applied. Updating this value is a passive change in the sense that it won't impact whether existing files over the limit are affected but it does help feeder processors to stop pushing too much into this work queue." - }, - "flowFileExpiration" : { - "type" : "string", - "description" : "The amount of time a flow file may be in the flow before it will be automatically aged out of the flow. Once a flow file reaches this age it will be terminated from the flow the next time a processor attempts to start work on it." - }, - "prioritizers" : { - "type" : "array", - "description" : "The comparators used to prioritize the queue.", - "items" : { - "type" : "string" - } - }, - "bends" : { - "type" : "array", - "description" : "The bend points on the connection.", - "items" : { - "$ref" : "#/definitions/Position" - } - }, - "loadBalanceStrategy" : { - "type" : "string", - "description" : "The Strategy to use for load balancing data across the cluster, or null, if no Load Balance Strategy has been specified.", - "enum" : [ "DO_NOT_LOAD_BALANCE", "PARTITION_BY_ATTRIBUTE", "ROUND_ROBIN", "SINGLE_NODE" ] - }, - "partitioningAttribute" : { - "type" : "string", - "description" : "The attribute to use for partitioning data as it is load balanced across the cluster. If the Load Balance Strategy is configured to use PARTITION_BY_ATTRIBUTE, the value returned by this method is the name of the FlowFile Attribute that will be used to determine which node in the cluster should receive a given FlowFile. If the Load Balance Strategy is unset or is set to any other value, the Partitioning Attribute has no effect." - }, - "loadBalanceCompression" : { - "type" : "string", - "description" : "Whether or not compression should be used when transferring FlowFiles between nodes", - "enum" : [ "DO_NOT_COMPRESS", "COMPRESS_ATTRIBUTES_ONLY", "COMPRESS_ATTRIBUTES_AND_CONTENT" ] - }, - "componentType" : { - "type" : "string", - "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE", "REPORTING_TASK", "PARAMETER_CONTEXT", "PARAMETER_PROVIDER", "TEMPLATE", "FLOW_REGISTRY_CLIENT" ] - }, - "groupIdentifier" : { - "type" : "string", - "description" : "The ID of the Process Group that this component belongs to" - } - } - }, - "VersionedControllerService" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The component's unique identifier" - }, - "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" - }, - "comments" : { - "type" : "string", - "description" : "The user-supplied comments for the component" - }, - "position" : { - "description" : "The component's position on the graph", - "$ref" : "#/definitions/Position" - }, - "type" : { - "type" : "string", - "description" : "The type of the extension component" - }, - "bundle" : { - "description" : "Information about the bundle from which the component came", - "$ref" : "#/definitions/Bundle" - }, - "properties" : { - "type" : "object", - "description" : "The properties for the component. Properties whose value is not set will only contain the property name.", - "additionalProperties" : { - "type" : "string" - } - }, - "propertyDescriptors" : { - "type" : "object", - "description" : "The property descriptors for the component.", - "additionalProperties" : { - "$ref" : "#/definitions/VersionedPropertyDescriptor" - } - }, - "controllerServiceApis" : { - "type" : "array", - "description" : "Lists the APIs this Controller Service implements.", - "items" : { - "$ref" : "#/definitions/ControllerServiceAPI" - } - }, - "annotationData" : { - "type" : "string", - "description" : "The annotation for the controller service. This is how the custom UI relays configuration to the controller service." - }, - "scheduledState" : { - "type" : "string", - "description" : "The ScheduledState denoting whether the Controller Service is ENABLED or DISABLED", - "enum" : [ "ENABLED", "DISABLED", "RUNNING" ] - }, - "bulletinLevel" : { - "type" : "string", - "description" : "The level at which the controller service will report bulletins." - }, - "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", "PARAMETER_CONTEXT", "PARAMETER_PROVIDER", "TEMPLATE", "FLOW_REGISTRY_CLIENT" ] - }, - "groupIdentifier" : { - "type" : "string", - "description" : "The ID of the Process Group that this component belongs to" - } - } - }, - "VersionedFlow" : { - "type" : "object", - "required" : [ "bucketIdentifier", "name", "type" ], - "properties" : { - "link" : { - "description" : "An WebLink to this entity.", - "readOnly" : true, - "$ref" : "#/definitions/JaxbLink" - }, - "identifier" : { - "type" : "string", - "description" : "An ID to uniquely identify this object.", - "readOnly" : true - }, - "name" : { - "type" : "string", - "description" : "The name of the item." - }, - "description" : { - "type" : "string", - "description" : "A description of the item." - }, - "bucketIdentifier" : { - "type" : "string", - "description" : "The identifier of the bucket this items belongs to. This cannot be changed after the item is created." - }, - "bucketName" : { - "type" : "string", - "description" : "The name of the bucket this items belongs to.", - "readOnly" : true - }, - "createdTimestamp" : { - "type" : "integer", - "format" : "int64", - "description" : "The timestamp of when the item was created, as milliseconds since epoch.", - "readOnly" : true, - "minimum" : 1 - }, - "modifiedTimestamp" : { - "type" : "integer", - "format" : "int64", - "description" : "The timestamp of when the item was last modified, as milliseconds since epoch.", - "readOnly" : true, - "minimum" : 1 - }, - "type" : { - "type" : "string", - "description" : "The type of item.", - "enum" : [ "Flow", "Bundle" ] - }, - "permissions" : { - "description" : "The access that the current user has to the bucket containing this item.", - "readOnly" : true, - "$ref" : "#/definitions/Permissions" - }, - "versionCount" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of versions of this flow.", - "readOnly" : true, - "minimum" : 0 - }, - "revision" : { - "description" : "The revision of this entity used for optimistic-locking during updates.", - "readOnly" : true, - "$ref" : "#/definitions/RevisionInfo" - } - } - }, - "VersionedFlowCoordinates" : { - "type" : "object", - "properties" : { - "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" - }, - "registryUrl" : { - "type" : "string", - "description" : "The URL of the Flow Registry that contains the flow" - }, - "bucketId" : { - "type" : "string", - "description" : "The UUID of the bucket that the flow resides in" - }, - "flowId" : { - "type" : "string", - "description" : "The UUID of the flow" - }, - "version" : { - "type" : "integer", - "format" : "int32", - "description" : "The version of the flow" - }, - "latest" : { - "type" : "boolean", - "description" : "Whether or not these coordinates point to the latest version of the flow" - } - } - }, - "VersionedFlowDifference" : { - "type" : "object", - "properties" : { - "bucketId" : { - "type" : "string", - "description" : "The id of the bucket that the flow is stored in." - }, - "flowId" : { - "type" : "string", - "description" : "The id of the flow that is being examined." - }, - "versionA" : { - "type" : "integer", - "format" : "int32", - "description" : "The earlier version from the diff operation." - }, - "versionB" : { - "type" : "integer", - "format" : "int32", - "description" : "The latter version from the diff operation." - }, - "componentDifferenceGroups" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ComponentDifferenceGroup" - } - } - } - }, - "VersionedFlowSnapshot" : { - "type" : "object", - "required" : [ "flowContents", "snapshotMetadata" ], - "properties" : { - "snapshotMetadata" : { - "description" : "The metadata for this snapshot", - "$ref" : "#/definitions/VersionedFlowSnapshotMetadata" - }, - "flowContents" : { - "description" : "The contents of the versioned flow", - "$ref" : "#/definitions/VersionedProcessGroup" - }, - "externalControllerServices" : { - "type" : "object", - "description" : "The information about controller services that exist outside this versioned flow, but are referenced by components within the versioned flow.", - "additionalProperties" : { - "$ref" : "#/definitions/ExternalControllerServiceReference" - } - }, - "parameterProviders" : { - "type" : "object", - "description" : "Contains basic information about parameter providers referenced in the versioned flow.", - "additionalProperties" : { - "$ref" : "#/definitions/ParameterProviderReference" - } - }, - "parameterContexts" : { - "type" : "object", - "description" : "The parameter contexts referenced by process groups in the flow contents. The mapping is from the name of the context to the context instance, and it is expected that any context in this map is referenced by at least one process group in this flow.", - "additionalProperties" : { - "$ref" : "#/definitions/VersionedParameterContext" - } - }, - "flowEncodingVersion" : { - "type" : "string", - "description" : "The optional encoding version of the flow contents." - }, - "flow" : { - "description" : "The flow this snapshot is for", - "readOnly" : true, - "$ref" : "#/definitions/VersionedFlow" - }, - "bucket" : { - "description" : "The bucket where the flow is located", - "readOnly" : true, - "$ref" : "#/definitions/Bucket" - }, - "latest" : { - "type" : "boolean" - } - } - }, - "VersionedFlowSnapshotMetadata" : { - "type" : "object", - "required" : [ "bucketIdentifier", "flowIdentifier", "version" ], - "properties" : { - "link" : { - "description" : "An WebLink to this entity.", - "readOnly" : true, - "$ref" : "#/definitions/JaxbLink" - }, - "bucketIdentifier" : { - "type" : "string", - "description" : "The identifier of the bucket this snapshot belongs to." - }, - "flowIdentifier" : { - "type" : "string", - "description" : "The identifier of the flow this snapshot belongs to." - }, - "version" : { - "type" : "integer", - "format" : "int32", - "description" : "The version of this snapshot of the flow.", - "minimum" : -1 - }, - "timestamp" : { - "type" : "integer", - "format" : "int64", - "description" : "The timestamp when the flow was saved, as milliseconds since epoch.", - "readOnly" : true, - "minimum" : 1 - }, - "author" : { - "type" : "string", - "description" : "The user that created this snapshot of the flow.", - "readOnly" : true - }, - "comments" : { - "type" : "string", - "description" : "The comments provided by the user when creating the snapshot." - } - } - }, - "VersionedFunnel" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The component's unique identifier" - }, - "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" - }, - "comments" : { - "type" : "string", - "description" : "The user-supplied comments for the component" - }, - "position" : { - "description" : "The component's position on the graph", - "$ref" : "#/definitions/Position" - }, - "componentType" : { - "type" : "string", - "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE", "REPORTING_TASK", "PARAMETER_CONTEXT", "PARAMETER_PROVIDER", "TEMPLATE", "FLOW_REGISTRY_CLIENT" ] - }, - "groupIdentifier" : { - "type" : "string", - "description" : "The ID of the Process Group that this component belongs to" - } - } - }, - "VersionedLabel" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The component's unique identifier" - }, - "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" - }, - "comments" : { - "type" : "string", - "description" : "The user-supplied comments for the component" - }, - "position" : { - "description" : "The component's position on the graph", - "$ref" : "#/definitions/Position" - }, - "label" : { - "type" : "string", - "description" : "The text that appears in the label." - }, - "zIndex" : { - "type" : "integer", - "format" : "int64", - "description" : "The z index of the connection." - }, - "width" : { - "type" : "number", - "format" : "double", - "description" : "The width of the label in pixels when at a 1:1 scale." - }, - "height" : { - "type" : "number", - "format" : "double", - "description" : "The height of the label in pixels when at a 1:1 scale." - }, - "style" : { - "type" : "object", - "description" : "The styles for this label (font-size : 12px, background-color : #eee, etc).", - "additionalProperties" : { - "type" : "string" - } - }, - "componentType" : { - "type" : "string", - "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE", "REPORTING_TASK", "PARAMETER_CONTEXT", "PARAMETER_PROVIDER", "TEMPLATE", "FLOW_REGISTRY_CLIENT" ] - }, - "groupIdentifier" : { - "type" : "string", - "description" : "The ID of the Process Group that this component belongs to" - } - } - }, - "VersionedParameter" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The name of the parameter" - }, - "description" : { - "type" : "string", - "description" : "The description of the param" - }, - "sensitive" : { - "type" : "boolean", - "description" : "Whether or not the parameter value is sensitive" - }, - "provided" : { - "type" : "boolean", - "description" : "Whether or not the parameter value is provided by a ParameterProvider" - }, - "value" : { - "type" : "string", - "description" : "The value of the parameter" - } - } - }, - "VersionedParameterContext" : { - "type" : "object", - "properties" : { - "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" - }, - "comments" : { - "type" : "string", - "description" : "The user-supplied comments for the component" - }, - "position" : { - "description" : "The component's position on the graph", - "$ref" : "#/definitions/Position" - }, - "parameters" : { - "type" : "array", - "description" : "The parameters in the context", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedParameter" - } - }, - "inheritedParameterContexts" : { - "type" : "array", - "description" : "The names of additional parameter contexts from which to inherit parameters", - "items" : { - "type" : "string" - } - }, - "description" : { - "type" : "string", - "description" : "The description of the parameter context" - }, - "parameterProvider" : { - "type" : "string", - "description" : "The identifier of an optional parameter provider" - }, - "parameterGroupName" : { - "type" : "string", - "description" : "The corresponding parameter group name fetched from the parameter provider, if applicable" - }, - "synchronized" : { - "type" : "boolean", - "description" : "True if the parameter provider is set and the context should receive updates when its parameters are next fetched" - }, - "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", "PARAMETER_CONTEXT", "PARAMETER_PROVIDER", "TEMPLATE", "FLOW_REGISTRY_CLIENT" ] - }, - "groupIdentifier" : { - "type" : "string", - "description" : "The ID of the Process Group that this component belongs to" - } - } - }, - "VersionedPort" : { - "type" : "object", - "properties" : { - "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" - }, - "comments" : { - "type" : "string", - "description" : "The user-supplied comments for the component" - }, - "position" : { - "description" : "The component's position on the graph", - "$ref" : "#/definitions/Position" - }, - "type" : { - "type" : "string", - "description" : "The type of port.", - "enum" : [ "INPUT_PORT", "OUTPUT_PORT" ] - }, - "concurrentlySchedulableTaskCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of tasks that should be concurrently scheduled for the port." - }, - "scheduledState" : { - "type" : "string", - "description" : "The scheduled state of the component", - "enum" : [ "ENABLED", "DISABLED", "RUNNING" ] - }, - "allowRemoteAccess" : { - "type" : "boolean", - "description" : "Whether or not this port allows remote access for site-to-site" - }, - "componentType" : { - "type" : "string", - "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE", "REPORTING_TASK", "PARAMETER_CONTEXT", "PARAMETER_PROVIDER", "TEMPLATE", "FLOW_REGISTRY_CLIENT" ] - }, - "groupIdentifier" : { - "type" : "string", - "description" : "The ID of the Process Group that this component belongs to" - } - } - }, - "VersionedProcessGroup" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The component's unique identifier" - }, - "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" - }, - "comments" : { - "type" : "string", - "description" : "The user-supplied comments for the component" - }, - "position" : { - "description" : "The component's position on the graph", - "$ref" : "#/definitions/Position" - }, - "processGroups" : { - "type" : "array", - "description" : "The child Process Groups", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedProcessGroup" - } - }, - "remoteProcessGroups" : { - "type" : "array", - "description" : "The Remote Process Groups", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedRemoteProcessGroup" - } - }, - "processors" : { - "type" : "array", - "description" : "The Processors", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedProcessor" - } - }, - "inputPorts" : { - "type" : "array", - "description" : "The Input Ports", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedPort" - } - }, - "outputPorts" : { - "type" : "array", - "description" : "The Output Ports", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedPort" - } - }, - "connections" : { - "type" : "array", - "description" : "The Connections", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedConnection" - } - }, - "labels" : { - "type" : "array", - "description" : "The Labels", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedLabel" - } - }, - "funnels" : { - "type" : "array", - "description" : "The Funnels", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedFunnel" - } - }, - "controllerServices" : { - "type" : "array", - "description" : "The Controller Services", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedControllerService" - } - }, - "versionedFlowCoordinates" : { - "description" : "The coordinates where the remote flow is stored, or null if the Process Group is not directly under Version Control", - "$ref" : "#/definitions/VersionedFlowCoordinates" - }, - "variables" : { - "type" : "object", - "description" : "The Variables in the Variable Registry for this Process Group (not including any ancestor or descendant Process Groups)", - "additionalProperties" : { - "type" : "string" - } - }, - "parameterContextName" : { - "type" : "string", - "description" : "The name of the parameter context used by this process group" - }, - "defaultFlowFileExpiration" : { - "type" : "string", - "description" : "The default FlowFile Expiration for this Process Group." - }, - "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." - }, - "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." - }, - "flowFileConcurrency" : { - "type" : "string", - "description" : "The configured FlowFile Concurrency for the Process Group" - }, - "flowFileOutboundPolicy" : { - "type" : "string", - "description" : "The FlowFile Outbound Policy for the Process Group" - }, - "componentType" : { - "type" : "string", - "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE", "REPORTING_TASK", "PARAMETER_CONTEXT", "PARAMETER_PROVIDER", "TEMPLATE", "FLOW_REGISTRY_CLIENT" ] - }, - "groupIdentifier" : { - "type" : "string", - "description" : "The ID of the Process Group that this component belongs to" - } - } - }, - "VersionedProcessor" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The component's unique identifier" - }, - "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" - }, - "comments" : { - "type" : "string", - "description" : "The user-supplied comments for the component" - }, - "position" : { - "description" : "The component's position on the graph", - "$ref" : "#/definitions/Position" - }, - "type" : { - "type" : "string", - "description" : "The type of the extension component" - }, - "bundle" : { - "description" : "Information about the bundle from which the component came", - "$ref" : "#/definitions/Bundle" - }, - "properties" : { - "type" : "object", - "description" : "The properties for the component. Properties whose value is not set will only contain the property name.", - "additionalProperties" : { - "type" : "string" - } - }, - "propertyDescriptors" : { - "type" : "object", - "description" : "The property descriptors for the component.", - "additionalProperties" : { - "$ref" : "#/definitions/VersionedPropertyDescriptor" - } - }, - "style" : { - "type" : "object", - "description" : "Stylistic data for rendering in a UI", - "additionalProperties" : { - "type" : "string" - } - }, - "annotationData" : { - "type" : "string", - "description" : "The annotation data for the processor used to relay configuration between a custom UI and the procesosr." - }, - "schedulingPeriod" : { - "type" : "string", - "description" : "The frequency with which to schedule the processor. The format of the value will depend on th value of schedulingStrategy." - }, - "schedulingStrategy" : { - "type" : "string", - "description" : "Indicates whether the processor should be scheduled to run in event or timer driven mode." - }, - "executionNode" : { - "type" : "string", - "description" : "Indicates the node where the process will execute." - }, - "penaltyDuration" : { - "type" : "string", - "description" : "The amout of time that is used when the process penalizes a flowfile." - }, - "yieldDuration" : { - "type" : "string", - "description" : "The amount of time that must elapse before this processor is scheduled again after yielding." - }, - "bulletinLevel" : { - "type" : "string", - "description" : "The level at which the processor will report bulletins." - }, - "runDurationMillis" : { - "type" : "integer", - "format" : "int64", - "description" : "The run duration for the processor in milliseconds." - }, - "concurrentlySchedulableTaskCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of tasks that should be concurrently schedule for the processor. If the processor doesn't allow parallol processing then any positive input will be ignored." - }, - "autoTerminatedRelationships" : { - "type" : "array", - "description" : "The names of all relationships that cause a flow file to be terminated if the relationship is not connected elsewhere. This property differs from the 'isAutoTerminate' property of the RelationshipDTO in that the RelationshipDTO is meant to depict the current configuration, whereas this property can be set in a DTO when updating a Processor in order to change which Relationships should be auto-terminated.", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - }, - "scheduledState" : { - "type" : "string", - "description" : "The scheduled state of the component", - "enum" : [ "ENABLED", "DISABLED", "RUNNING" ] - }, - "retryCount" : { - "type" : "integer", - "format" : "int32", - "description" : "Overall number of retries." - }, - "retriedRelationships" : { - "type" : "array", - "description" : "All the relationships should be retried.", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - }, - "backoffMechanism" : { - "type" : "string", - "description" : "Determines whether the FlowFile should be penalized or the processor should be yielded between retries.", - "enum" : [ "PENALIZE_FLOWFILE", "YIELD_PROCESSOR" ] - }, - "maxBackoffPeriod" : { - "type" : "string", - "description" : "Maximum amount of time to be waited during a retry period." - }, - "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", "PARAMETER_CONTEXT", "PARAMETER_PROVIDER", "TEMPLATE", "FLOW_REGISTRY_CLIENT" ] - }, - "groupIdentifier" : { - "type" : "string", - "description" : "The ID of the Process Group that this component belongs to" - } - } - }, - "VersionedPropertyDescriptor" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The name of the property" - }, - "displayName" : { - "type" : "string", - "description" : "The display name of the property" - }, - "identifiesControllerService" : { - "type" : "boolean", - "description" : "Whether or not the property provides the identifier of a Controller Service" - }, - "sensitive" : { - "type" : "boolean", - "description" : "Whether or not the property is considered sensitive" - }, - "resourceDefinition" : { - "description" : "Returns the Resource Definition that defines which type(s) of resource(s) this property references, if any", - "$ref" : "#/definitions/VersionedResourceDefinition" - } - } - }, - "VersionedRemoteGroupPort" : { - "type" : "object", - "properties" : { - "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" - }, - "comments" : { - "type" : "string", - "description" : "The user-supplied comments for the component" - }, - "position" : { - "description" : "The component's position on the graph", - "$ref" : "#/definitions/Position" - }, - "remoteGroupId" : { - "type" : "string", - "description" : "The id of the remote process group that the port resides in." - }, - "concurrentlySchedulableTaskCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of task that may transmit flowfiles to the target port concurrently." - }, - "useCompression" : { - "type" : "boolean", - "description" : "Whether the flowfiles are compressed when sent to the target port." - }, - "batchSize" : { - "description" : "The batch settings for data transmission.", - "$ref" : "#/definitions/BatchSize" - }, - "componentType" : { - "type" : "string", - "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE", "REPORTING_TASK", "PARAMETER_CONTEXT", "PARAMETER_PROVIDER", "TEMPLATE", "FLOW_REGISTRY_CLIENT" ] - }, - "targetId" : { - "type" : "string", - "description" : "The ID of the port on the target NiFi instance" - }, - "scheduledState" : { - "type" : "string", - "description" : "The scheduled state of the component", - "enum" : [ "ENABLED", "DISABLED", "RUNNING" ] - }, - "groupIdentifier" : { - "type" : "string", - "description" : "The ID of the Process Group that this component belongs to" - } - } - }, - "VersionedRemoteProcessGroup" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The component's unique identifier" - }, - "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" - }, - "comments" : { - "type" : "string", - "description" : "The user-supplied comments for the component" - }, - "position" : { - "description" : "The component's position on the graph", - "$ref" : "#/definitions/Position" - }, - "targetUri" : { - "type" : "string", - "description" : "[DEPRECATED] The target URI of the remote process group. If target uri is not set, but uris are set, then returns the first uri in the uris. If neither target uri nor uris are set, then returns null." - }, - "targetUris" : { - "type" : "string", - "description" : "The target URIs of the remote process group. If target uris is not set but target uri is set, then returns the single target uri. If neither target uris nor target uri is set, then returns null." - }, - "communicationsTimeout" : { - "type" : "string", - "description" : "The time period used for the timeout when communicating with the target." - }, - "yieldDuration" : { - "type" : "string", - "description" : "When yielding, this amount of time must elapse before the remote process group is scheduled again." - }, - "transportProtocol" : { - "type" : "string", - "description" : "The Transport Protocol that is used for Site-to-Site communications", - "enum" : [ "RAW", "HTTP" ] - }, - "localNetworkInterface" : { - "type" : "string", - "description" : "The local network interface to send/receive data. If not specified, any local address is used. If clustered, all nodes must have an interface with this identifier." - }, - "proxyHost" : { - "type" : "string" - }, - "proxyPort" : { - "type" : "integer", - "format" : "int32" - }, - "proxyUser" : { - "type" : "string" - }, - "proxyPassword" : { - "type" : "string" - }, - "inputPorts" : { - "type" : "array", - "description" : "A Set of Input Ports that can be connected to, in order to send data to the remote NiFi instance", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedRemoteGroupPort" - } - }, - "outputPorts" : { - "type" : "array", - "description" : "A Set of Output Ports that can be connected to, in order to pull data from the remote NiFi instance", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedRemoteGroupPort" - } - }, - "componentType" : { - "type" : "string", - "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE", "REPORTING_TASK", "PARAMETER_CONTEXT", "PARAMETER_PROVIDER", "TEMPLATE", "FLOW_REGISTRY_CLIENT" ] - }, - "groupIdentifier" : { - "type" : "string", - "description" : "The ID of the Process Group that this component belongs to" - } - } - }, - "VersionedResourceDefinition" : { - "type" : "object", - "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", - "uniqueItems" : true, - "items" : { - "type" : "string", - "enum" : [ "FILE", "DIRECTORY", "TEXT", "URL" ] - } - } - } - } - } -} \ No newline at end of file diff --git a/resources/client_gen/api_defs/registry-1.23.2.json b/resources/client_gen/api_defs/registry-1.23.2.json deleted file mode 100644 index f18bf9b1..00000000 --- a/resources/client_gen/api_defs/registry-1.23.2.json +++ /dev/null @@ -1,7117 +0,0 @@ -{ - "swagger" : "2.0", - "info" : { - "description" : "The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components.", - "version" : "1.23.2", - "title" : "Apache NiFi Registry REST API", - "termsOfService" : "As described in the license", - "contact" : { - "name" : "Apache NiFi Registry", - "url" : "https://nifi.apache.org", - "email" : "dev@nifi.apache.org" - }, - "license" : { - "name" : "Apache 2.0 License", - "url" : "https://www.apache.org/licenses/LICENSE-2.0.html" - } - }, - "basePath" : "/nifi-registry-api", - "tags" : [ { - "name" : "about", - "description" : "Retrieves the version information for this NiFi Registry." - }, { - "name" : "access", - "description" : "Endpoints for obtaining an access token or checking access status." - }, { - "name" : "bucket bundles", - "description" : "Create extension bundles scoped to an existing bucket in the registry. " - }, { - "name" : "bucket flows", - "description" : "Create flows scoped to an existing bucket in the registry." - }, { - "name" : "buckets", - "description" : "Create named buckets in the registry to store NiFi objects such flows and extensions. Search for and retrieve existing buckets." - }, { - "name" : "bundles", - "description" : "Gets metadata about extension bundles and their versions. " - }, { - "name" : "config", - "description" : "Retrieves the configuration for this NiFi Registry." - }, { - "name" : "extension repository", - "description" : "Interact with extension bundles via the hierarchy of bucket/group/artifact/version. " - }, { - "name" : "extensions", - "description" : "Find and retrieve extensions. " - }, { - "name" : "flows", - "description" : "Gets metadata about flows." - }, { - "name" : "items", - "description" : "Retrieve items across all buckets for which the user is authorized." - }, { - "name" : "policies", - "description" : "Endpoint for managing access policies." - }, { - "name" : "tenants", - "description" : "Endpoint for managing users and user groups." - } ], - "schemes" : [ "http", "https" ], - "paths" : { - "/about" : { - "get" : { - "tags" : [ "about" ], - "summary" : "Get version", - "description" : "Gets the NiFi Registry version.", - "operationId" : "getVersion", - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/RegistryAbout" - } - } - }, - "security" : [ { - "Authorization" : [ ] - } ] - } - }, - "/access" : { - "get" : { - "tags" : [ "access" ], - "summary" : "Get access status", - "description" : "Returns the current client's authenticated identity and permissions to top-level resources", - "operationId" : "getAccessStatus", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/CurrentUser" - } - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid. The NiFi Registry might be running unsecured." - } - }, - "security" : [ { - "Authorization" : [ ] - } ] - } - }, - "/access/logout" : { - "delete" : { - "tags" : [ "access" ], - "summary" : "Performs a logout for other providers that have been issued a JWT.", - "description" : "\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "logout", - "consumes" : [ "*/*" ], - "produces" : [ "*/*" ], - "responses" : { - "200" : { - "description" : "User was logged out successfully." - }, - "401" : { - "description" : "Authentication token provided was empty or not in the correct JWT format." - }, - "500" : { - "description" : "Client failed to log out." - } - } - } - }, - "/access/logout/complete" : { - "get" : { - "tags" : [ "access" ], - "summary" : "Completes the logout sequence.", - "description" : "\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "logoutComplete", - "consumes" : [ "*/*" ], - "produces" : [ "*/*" ], - "responses" : { - "200" : { - "description" : "User was logged out successfully." - }, - "401" : { - "description" : "Authentication token provided was empty or not in the correct JWT format." - }, - "500" : { - "description" : "Client failed to log out." - } - } - } - }, - "/access/oidc/callback" : { - "get" : { - "tags" : [ "access" ], - "summary" : "Redirect/callback URI for processing the result of the OpenId Connect login sequence.", - "description" : "\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "oidcCallback", - "consumes" : [ "*/*" ], - "produces" : [ "*/*" ], - "responses" : { - "default" : { - "description" : "successful operation" - } - } - } - }, - "/access/oidc/exchange" : { - "post" : { - "tags" : [ "access" ], - "summary" : "Retrieves a JWT following a successful login sequence using the configured OpenId Connect provider.", - "description" : "\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "oidcExchange", - "consumes" : [ "*/*" ], - "produces" : [ "text/plain" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - } - } - } - }, - "/access/oidc/logout" : { - "get" : { - "tags" : [ "access" ], - "summary" : "Performs a logout in the OpenId Provider.", - "description" : "\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "oidcLogout", - "consumes" : [ "*/*" ], - "produces" : [ "*/*" ], - "responses" : { - "default" : { - "description" : "successful operation" - } - } - } - }, - "/access/oidc/logout/callback" : { - "get" : { - "tags" : [ "access" ], - "summary" : "Redirect/callback URI for processing the result of the OpenId Connect logout sequence.", - "description" : "\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "oidcLogoutCallback", - "consumes" : [ "*/*" ], - "produces" : [ "*/*" ], - "responses" : { - "default" : { - "description" : "successful operation" - } - } - } - }, - "/access/oidc/request" : { - "get" : { - "tags" : [ "access" ], - "summary" : "Initiates a request to authenticate through the configured OpenId Connect provider.", - "description" : "\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "oidcRequest", - "consumes" : [ "*/*" ], - "produces" : [ "*/*" ], - "responses" : { - "default" : { - "description" : "successful operation" - } - } - } - }, - "/access/token" : { - "post" : { - "tags" : [ "access" ], - "summary" : "Create token trying all providers", - "description" : "Creates a token for accessing the REST API via auto-detected method of verifying client identity claim credentials. The token returned is formatted as a JSON Web Token (JWT). The token is base64 encoded and comprised of three parts. The header, the body, and the signature. The expiration of the token is a contained within the body. The token can be used in the Authorization header in the format 'Authorization: Bearer '.", - "operationId" : "createAccessTokenByTryingAllProviders", - "consumes" : [ "*/*" ], - "produces" : [ "text/plain" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid. The NiFi Registry may not be configured to support login with username/password." - }, - "500" : { - "description" : "NiFi Registry was unable to complete the request because an unexpected error occurred." - } - } - } - }, - "/access/token/identity-provider" : { - "post" : { - "tags" : [ "access" ], - "summary" : "Create token using identity provider", - "description" : "Creates a token for accessing the REST API via a custom identity provider. The user credentials must be passed in a format understood by the custom identity provider, e.g., a third-party auth token in an HTTP header. The exact format of the user credentials expected by the custom identity provider can be discovered by 'GET /access/token/identity-provider/usage'. The token returned is formatted as a JSON Web Token (JWT). The token is base64 encoded and comprised of three parts. The header, the body, and the signature. The expiration of the token is a contained within the body. The token can be used in the Authorization header in the format 'Authorization: Bearer '.", - "operationId" : "createAccessTokenUsingIdentityProviderCredentials", - "consumes" : [ "*/*" ], - "produces" : [ "text/plain" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid. The NiFi Registry may not be configured to support login with customized credentials." - }, - "500" : { - "description" : "NiFi Registry was unable to complete the request because an unexpected error occurred." - } - } - } - }, - "/access/token/identity-provider/test" : { - "post" : { - "tags" : [ "access" ], - "summary" : "Test identity provider", - "description" : "Tests the format of the credentials against this identity provider without preforming authentication on the credentials to validate them. The user credentials should be passed in a format understood by the custom identity provider as defined by 'GET /access/token/identity-provider/usage'.", - "operationId" : "testIdentityProviderRecognizesCredentialsFormat", - "consumes" : [ "*/*" ], - "produces" : [ "text/plain" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "The format of the credentials were not recognized by the currently configured identity provider." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid. The NiFi Registry may not be configured to support login with customized credentials." - }, - "500" : { - "description" : "NiFi Registry was unable to complete the request because an unexpected error occurred." - } - } - } - }, - "/access/token/identity-provider/usage" : { - "get" : { - "tags" : [ "access" ], - "summary" : "Get identity provider usage", - "description" : "Provides a description of how the currently configured identity provider expects credentials to be passed to POST /access/token/identity-provider", - "operationId" : "getIdentityProviderUsageInstructions", - "consumes" : [ "*/*" ], - "produces" : [ "text/plain" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid. The NiFi Registry may not be configured to support login with customized credentials." - }, - "500" : { - "description" : "NiFi Registry was unable to complete the request because an unexpected error occurred." - } - } - } - }, - "/access/token/kerberos" : { - "post" : { - "tags" : [ "access" ], - "summary" : "Create token using kerberos", - "description" : "Creates a token for accessing the REST API via Kerberos Service Tickets or SPNEGO Tokens (which includes Kerberos Service Tickets). The token returned is formatted as a JSON Web Token (JWT). The token is base64 encoded and comprised of three parts. The header, the body, and the signature. The expiration of the token is a contained within the body. The token can be used in the Authorization header in the format 'Authorization: Bearer '.", - "operationId" : "createAccessTokenUsingKerberosTicket", - "consumes" : [ "*/*" ], - "produces" : [ "text/plain" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid. The NiFi Registry may not be configured to support login Kerberos credentials." - }, - "500" : { - "description" : "NiFi Registry was unable to complete the request because an unexpected error occurred." - } - } - } - }, - "/access/token/login" : { - "post" : { - "tags" : [ "access" ], - "summary" : "Create token using basic auth", - "description" : "Creates a token for accessing the REST API via username/password. The user credentials must be passed in standard HTTP Basic Auth format. That is: 'Authorization: Basic ', where is the base64 encoded value of ':'. The token returned is formatted as a JSON Web Token (JWT). The token is base64 encoded and comprised of three parts. The header, the body, and the signature. The expiration of the token is a contained within the body. The token can be used in the Authorization header in the format 'Authorization: Bearer '.", - "operationId" : "createAccessTokenUsingBasicAuthCredentials", - "consumes" : [ "*/*" ], - "produces" : [ "text/plain" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid. The NiFi Registry may not be configured to support login with username/password." - }, - "500" : { - "description" : "NiFi Registry was unable to complete the request because an unexpected error occurred." - } - }, - "security" : [ { - "BasicAuth" : [ ] - } ] - } - }, - "/buckets" : { - "get" : { - "tags" : [ "buckets" ], - "summary" : "Get all buckets", - "description" : "The returned list will include only buckets for which the user is authorized.If the user is not authorized for any buckets, this returns an empty list.", - "operationId" : "getBuckets", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/Bucket" - } - } - }, - "401" : { - "description" : "Client could not be authenticated." - } - }, - "security" : [ { - "Authorization" : [ ] - } ] - }, - "post" : { - "tags" : [ "buckets" ], - "summary" : "Create bucket", - "description" : "", - "operationId" : "createBucket", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The bucket to create", - "required" : true, - "schema" : { - "$ref" : "#/definitions/Bucket" - } - }, { - "name" : "preserveSourceProperties", - "in" : "query", - "description" : "Whether source properties like identifier should be kept", - "required" : false, - "type" : "boolean" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/Bucket" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets", - "action" : "write" - } - } - }, - "/buckets/fields" : { - "get" : { - "tags" : [ "buckets" ], - "summary" : "Get bucket fields", - "description" : "Retrieves bucket field names for searching or sorting on buckets.", - "operationId" : "getAvailableBucketFields", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/Fields" - } - } - }, - "security" : [ { - "Authorization" : [ ] - } ] - } - }, - "/buckets/{bucketId}" : { - "get" : { - "tags" : [ "buckets" ], - "summary" : "Get bucket", - "description" : "Gets the bucket with the given id.", - "operationId" : "getBucket", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketId", - "in" : "path", - "description" : "The bucket identifier", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/Bucket" - } - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - }, - "put" : { - "tags" : [ "buckets" ], - "summary" : "Update bucket", - "description" : "Updates the bucket with the given id.", - "operationId" : "updateBucket", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketId", - "in" : "path", - "description" : "The bucket identifier", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The updated bucket", - "required" : true, - "schema" : { - "$ref" : "#/definitions/Bucket" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/Bucket" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "write" - } - }, - "delete" : { - "tags" : [ "buckets" ], - "summary" : "Delete bucket", - "description" : "Deletes the bucket with the given id, along with all objects stored in the bucket", - "operationId" : "deleteBucket", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The version is used to verify the client is working with the latest version of the entity.", - "required" : true, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "bucketId", - "in" : "path", - "description" : "The bucket identifier", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/Bucket" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "delete" - } - } - }, - "/buckets/{bucketId}/bundles" : { - "get" : { - "tags" : [ "bucket bundles" ], - "summary" : "Get extension bundles by bucket", - "description" : "\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getExtensionBundles", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketId", - "in" : "path", - "description" : "The bucket identifier", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/ExtensionBundle" - } - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/buckets/{bucketId}/bundles/{bundleType}" : { - "post" : { - "tags" : [ "bucket bundles" ], - "summary" : "Create extension bundle version", - "description" : "Creates a version of an extension bundle by uploading a binary artifact. If an extension bundle already exists in the given bucket with the same group id and artifact id as that of the bundle being uploaded, then it will be added as a new version to the existing bundle. If an extension bundle does not already exist in the given bucket with the same group id and artifact id, then a new extension bundle will be created and this version will be added to the new bundle. Client's may optionally supply a SHA-256 in hex format through the multi-part form field 'sha256'. If supplied, then this value will be compared against the SHA-256 computed by the server, and the bundle will be rejected if the values do not match. If not supplied, the bundle will be accepted, but will be marked to indicate that the client did not supply a SHA-256 during creation. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "createExtensionBundleVersion", - "consumes" : [ "multipart/form-data" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketId", - "in" : "path", - "description" : "The bucket identifier", - "required" : true, - "type" : "string" - }, { - "name" : "bundleType", - "in" : "path", - "description" : "The type of the bundle", - "required" : true, - "type" : "string", - "enum" : [ "nifi-nar", "minifi-cpp" ] - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/BundleVersion" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "write" - } - } - }, - "/buckets/{bucketId}/flows" : { - "get" : { - "tags" : [ "bucket flows" ], - "summary" : "Get bucket flows", - "description" : "Retrieves all flows in the given bucket.", - "operationId" : "getFlows", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketId", - "in" : "path", - "description" : "The bucket identifier", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/VersionedFlow" - } - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - }, - "post" : { - "tags" : [ "bucket flows" ], - "summary" : "Create flow", - "description" : "Creates a flow in the given bucket. The flow id is created by the server and populated in the returned entity.", - "operationId" : "createFlow", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketId", - "in" : "path", - "description" : "The bucket identifier", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The details of the flow to create.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/VersionedFlow" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlow" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "write" - } - } - }, - "/buckets/{bucketId}/flows/{flowId}" : { - "get" : { - "tags" : [ "bucket flows" ], - "summary" : "Get bucket flow", - "description" : "Retrieves the flow with the given id in the given bucket.", - "operationId" : "getFlow", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketId", - "in" : "path", - "description" : "The bucket identifier", - "required" : true, - "type" : "string" - }, { - "name" : "flowId", - "in" : "path", - "description" : "The flow identifier", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlow" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - }, - "put" : { - "tags" : [ "bucket flows" ], - "summary" : "Update bucket flow", - "description" : "Updates the flow with the given id in the given bucket.", - "operationId" : "updateFlow", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketId", - "in" : "path", - "description" : "The bucket identifier", - "required" : true, - "type" : "string" - }, { - "name" : "flowId", - "in" : "path", - "description" : "The flow identifier", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The updated flow", - "required" : true, - "schema" : { - "$ref" : "#/definitions/VersionedFlow" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlow" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "write" - } - }, - "delete" : { - "tags" : [ "bucket flows" ], - "summary" : "Delete bucket flow", - "description" : "Deletes a flow, including all saved versions of that flow.", - "operationId" : "deleteFlow", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The version is used to verify the client is working with the latest version of the entity.", - "required" : true, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "bucketId", - "in" : "path", - "description" : "The bucket identifier", - "required" : true, - "type" : "string" - }, { - "name" : "flowId", - "in" : "path", - "description" : "The flow identifier", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlow" - } - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "delete" - } - } - }, - "/buckets/{bucketId}/flows/{flowId}/diff/{versionA}/{versionB}" : { - "get" : { - "tags" : [ "bucket flows" ], - "summary" : "Get bucket flow diff", - "description" : "Computes the differences between two given versions of a flow.", - "operationId" : "getFlowDiff", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketId", - "in" : "path", - "description" : "The bucket identifier", - "required" : true, - "type" : "string" - }, { - "name" : "flowId", - "in" : "path", - "description" : "The flow identifier", - "required" : true, - "type" : "string" - }, { - "name" : "versionA", - "in" : "path", - "description" : "The first version number", - "required" : true, - "type" : "integer", - "pattern" : "\\d+", - "format" : "int32" - }, { - "name" : "versionB", - "in" : "path", - "description" : "The second version number", - "required" : true, - "type" : "integer", - "pattern" : "\\d+", - "format" : "int32" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlowDifference" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/buckets/{bucketId}/flows/{flowId}/versions" : { - "get" : { - "tags" : [ "bucket flows" ], - "summary" : "Get bucket flow versions", - "description" : "Gets summary information for all versions of a flow. Versions are ordered newest->oldest.", - "operationId" : "getFlowVersions", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketId", - "in" : "path", - "description" : "The bucket identifier", - "required" : true, - "type" : "string" - }, { - "name" : "flowId", - "in" : "path", - "description" : "The flow identifier", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/VersionedFlowSnapshotMetadata" - } - } - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - }, - "post" : { - "tags" : [ "bucket flows" ], - "summary" : "Create flow version", - "description" : "Creates the next version of a flow. The version number of the object being created must be the next available version integer. Flow versions are immutable after they are created.", - "operationId" : "createFlowVersion", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketId", - "in" : "path", - "description" : "The bucket identifier", - "required" : true, - "type" : "string" - }, { - "name" : "flowId", - "in" : "path", - "description" : "The flow identifier", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The new versioned flow snapshot.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/VersionedFlowSnapshot" - } - }, { - "name" : "preserveSourceProperties", - "in" : "query", - "description" : "Whether source properties like author should be kept", - "required" : false, - "type" : "boolean" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlowSnapshot" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "write" - } - } - }, - "/buckets/{bucketId}/flows/{flowId}/versions/import" : { - "post" : { - "tags" : [ "bucket flows" ], - "summary" : "Import flow version", - "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", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketId", - "in" : "path", - "description" : "The bucket identifier", - "required" : true, - "type" : "string" - }, { - "name" : "flowId", - "in" : "path", - "description" : "The flow identifier", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "file", - "required" : false, - "schema" : { - "$ref" : "#/definitions/VersionedFlowSnapshot" - } - }, { - "name" : "Comments", - "in" : "header", - "required" : false, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlowSnapshot" - } - }, - "201" : { - "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." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "write" - } - } - }, - "/buckets/{bucketId}/flows/{flowId}/versions/latest" : { - "get" : { - "tags" : [ "bucket flows" ], - "summary" : "Get latest bucket flow version content", - "description" : "Gets the latest version of a flow, including the metadata and content of the flow.", - "operationId" : "getLatestFlowVersion", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketId", - "in" : "path", - "description" : "The bucket identifier", - "required" : true, - "type" : "string" - }, { - "name" : "flowId", - "in" : "path", - "description" : "The flow identifier", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlowSnapshot" - } - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/buckets/{bucketId}/flows/{flowId}/versions/latest/metadata" : { - "get" : { - "tags" : [ "bucket flows" ], - "summary" : "Get latest bucket flow version metadata", - "description" : "Gets the metadata for the latest version of a flow.", - "operationId" : "getLatestFlowVersionMetadata", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketId", - "in" : "path", - "description" : "The bucket identifier", - "required" : true, - "type" : "string" - }, { - "name" : "flowId", - "in" : "path", - "description" : "The flow identifier", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlowSnapshotMetadata" - } - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/buckets/{bucketId}/flows/{flowId}/versions/{versionNumber}" : { - "get" : { - "tags" : [ "bucket flows" ], - "summary" : "Get bucket flow version", - "description" : "Gets the given version of a flow, including the metadata and content for the version.", - "operationId" : "getFlowVersion", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketId", - "in" : "path", - "description" : "The bucket identifier", - "required" : true, - "type" : "string" - }, { - "name" : "flowId", - "in" : "path", - "description" : "The flow identifier", - "required" : true, - "type" : "string" - }, { - "name" : "versionNumber", - "in" : "path", - "description" : "The version number", - "required" : true, - "type" : "integer", - "pattern" : "\\d+", - "format" : "int32" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlowSnapshot" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/buckets/{bucketId}/flows/{flowId}/versions/{versionNumber}/export" : { - "get" : { - "tags" : [ "bucket flows" ], - "summary" : "Exports specified bucket flow version content", - "description" : "Exports the specified version of a flow, including the metadata and content of the flow.", - "operationId" : "exportVersionedFlow", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketId", - "in" : "path", - "description" : "The bucket identifier", - "required" : true, - "type" : "string" - }, { - "name" : "flowId", - "in" : "path", - "description" : "The flow identifier", - "required" : true, - "type" : "string" - }, { - "name" : "versionNumber", - "in" : "path", - "description" : "The version number", - "required" : true, - "type" : "integer", - "pattern" : "\\d+", - "format" : "int32" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlowSnapshot" - } - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/bundles" : { - "get" : { - "tags" : [ "bundles" ], - "summary" : "Get all bundles", - "description" : "Gets the metadata for all bundles across all authorized buckets with optional filters applied. The returned results will include only items from buckets for which the user is authorized. If the user is not authorized to any buckets, an empty list will be returned. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getBundles", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketName", - "in" : "query", - "description" : "Optional bucket name to filter results. The value may be an exact match, or a wildcard, such as 'My Bucket%' to select all bundles where the bucket name starts with 'My Bucket'.", - "required" : false, - "type" : "string" - }, { - "name" : "groupId", - "in" : "query", - "description" : "Optional groupId to filter results. The value may be an exact match, or a wildcard, such as 'com.%' to select all bundles where the groupId starts with 'com.'.", - "required" : false, - "type" : "string" - }, { - "name" : "artifactId", - "in" : "query", - "description" : "Optional artifactId to filter results. The value may be an exact match, or a wildcard, such as 'nifi-%' to select all bundles where the artifactId starts with 'nifi-'.", - "required" : false, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/ExtensionBundle" - } - } - }, - "401" : { - "description" : "Client could not be authenticated." - } - }, - "security" : [ { - "Authorization" : [ ] - } ] - } - }, - "/bundles/versions" : { - "get" : { - "tags" : [ "bundles" ], - "summary" : "Get all bundle versions", - "description" : "Gets the metadata about extension bundle versions across all authorized buckets with optional filters applied. If the user is not authorized to any buckets, an empty list will be returned. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getBundleVersions", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "groupId", - "in" : "query", - "description" : "Optional groupId to filter results. The value may be an exact match, or a wildcard, such as 'com.%' to select all bundle versions where the groupId starts with 'com.'.", - "required" : false, - "type" : "string" - }, { - "name" : "artifactId", - "in" : "query", - "description" : "Optional artifactId to filter results. The value may be an exact match, or a wildcard, such as 'nifi-%' to select all bundle versions where the artifactId starts with 'nifi-'.", - "required" : false, - "type" : "string" - }, { - "name" : "version", - "in" : "query", - "description" : "Optional version to filter results. The value maye be an exact match, or a wildcard, such as '1.0.%' to select all bundle versions where the version starts with '1.0.'.", - "required" : false, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/BundleVersionMetadata" - } - } - }, - "401" : { - "description" : "Client could not be authenticated." - } - }, - "security" : [ { - "Authorization" : [ ] - } ] - } - }, - "/bundles/{bundleId}" : { - "get" : { - "tags" : [ "bundles" ], - "summary" : "Get bundle", - "description" : "Gets the metadata about an extension bundle. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "globalGetExtensionBundle", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bundleId", - "in" : "path", - "description" : "The extension bundle identifier", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ExtensionBundle" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - }, - "delete" : { - "tags" : [ "bundles" ], - "summary" : "Delete bundle", - "description" : "Deletes the given extension bundle and all of it's versions. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "globalDeleteExtensionBundle", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bundleId", - "in" : "path", - "description" : "The extension bundle identifier", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ExtensionBundle" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "write" - } - } - }, - "/bundles/{bundleId}/versions" : { - "get" : { - "tags" : [ "bundles" ], - "summary" : "Get bundle versions", - "description" : "Gets the metadata for the versions of the given extension bundle. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "globalGetBundleVersions", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bundleId", - "in" : "path", - "description" : "The extension bundle identifier", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/BundleVersionMetadata" - } - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/bundles/{bundleId}/versions/{version}" : { - "get" : { - "tags" : [ "bundles" ], - "summary" : "Get bundle version", - "description" : "Gets the descriptor for the given version of the given extension bundle. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "globalGetBundleVersion", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bundleId", - "in" : "path", - "description" : "The extension bundle identifier", - "required" : true, - "type" : "string" - }, { - "name" : "version", - "in" : "path", - "description" : "The version of the bundle", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/BundleVersion" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - }, - "delete" : { - "tags" : [ "bundles" ], - "summary" : "Delete bundle version", - "description" : "Deletes the given extension bundle version and it's associated binary content. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "globalDeleteBundleVersion", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bundleId", - "in" : "path", - "description" : "The extension bundle identifier", - "required" : true, - "type" : "string" - }, { - "name" : "version", - "in" : "path", - "description" : "The version of the bundle", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/BundleVersion" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "write" - } - } - }, - "/bundles/{bundleId}/versions/{version}/content" : { - "get" : { - "tags" : [ "bundles" ], - "summary" : "Get bundle version content", - "description" : "Gets the binary content for the given version of the given extension bundle. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "globalGetBundleVersionContent", - "consumes" : [ "*/*" ], - "produces" : [ "application/octet-stream" ], - "parameters" : [ { - "name" : "bundleId", - "in" : "path", - "description" : "The extension bundle identifier", - "required" : true, - "type" : "string" - }, { - "name" : "version", - "in" : "path", - "description" : "The version of the bundle", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "type" : "string", - "format" : "byte" - } - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/bundles/{bundleId}/versions/{version}/extensions" : { - "get" : { - "tags" : [ "bundles" ], - "summary" : "Get bundle version extensions", - "description" : "Gets the metadata about the extensions in the given extension bundle version. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "globalGetBundleVersionExtensions", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bundleId", - "in" : "path", - "description" : "The extension bundle identifier", - "required" : true, - "type" : "string" - }, { - "name" : "version", - "in" : "path", - "description" : "The version of the bundle", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/ExtensionMetadata" - } - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/bundles/{bundleId}/versions/{version}/extensions/{name}" : { - "get" : { - "tags" : [ "bundles" ], - "summary" : "Get bundle version extension", - "description" : "Gets the metadata about the extension with the given name in the given extension bundle version. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "globalGetBundleVersionExtension", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bundleId", - "in" : "path", - "description" : "The extension bundle identifier", - "required" : true, - "type" : "string" - }, { - "name" : "version", - "in" : "path", - "description" : "The version of the bundle", - "required" : true, - "type" : "string" - }, { - "name" : "name", - "in" : "path", - "description" : "The fully qualified name of the extension", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/Extension" - } - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/bundles/{bundleId}/versions/{version}/extensions/{name}/docs" : { - "get" : { - "tags" : [ "bundles" ], - "summary" : "Get bundle version extension docs", - "description" : "Gets the documentation for the given extension in the given extension bundle version. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getBundleVersionExtensionDocs", - "consumes" : [ "*/*" ], - "produces" : [ "text/html" ], - "parameters" : [ { - "name" : "bundleId", - "in" : "path", - "description" : "The extension bundle identifier", - "required" : true, - "type" : "string" - }, { - "name" : "version", - "in" : "path", - "description" : "The version of the bundle", - "required" : true, - "type" : "string" - }, { - "name" : "name", - "in" : "path", - "description" : "The fully qualified name of the extension", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/bundles/{bundleId}/versions/{version}/extensions/{name}/docs/additional-details" : { - "get" : { - "tags" : [ "bundles" ], - "summary" : "Get bundle version extension docs details", - "description" : "Gets the additional details documentation for the given extension in the given extension bundle version. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getBundleVersionExtensionAdditionalDetailsDocs", - "consumes" : [ "*/*" ], - "produces" : [ "text/html" ], - "parameters" : [ { - "name" : "bundleId", - "in" : "path", - "description" : "The extension bundle identifier", - "required" : true, - "type" : "string" - }, { - "name" : "version", - "in" : "path", - "description" : "The version of the bundle", - "required" : true, - "type" : "string" - }, { - "name" : "name", - "in" : "path", - "description" : "The fully qualified name of the extension", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/config" : { - "get" : { - "tags" : [ "config" ], - "summary" : "Get configration", - "description" : "Gets the NiFi Registry configurations.", - "operationId" : "getConfiguration", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/RegistryConfiguration" - } - }, - "401" : { - "description" : "Client could not be authenticated." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/policies,/tenants", - "action" : "read" - } - } - }, - "/extension-repository" : { - "get" : { - "tags" : [ "extension repository" ], - "summary" : "Get extension repo buckets", - "description" : "Gets the names of the buckets the current user is authorized for in order to browse the repo by bucket. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getExtensionRepoBuckets", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/ExtensionRepoBucket" - } - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ] - } - }, - "/extension-repository/{bucketName}" : { - "get" : { - "tags" : [ "extension repository" ], - "summary" : "Get extension repo groups", - "description" : "Gets the groups in the extension repository in the given bucket. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getExtensionRepoGroups", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketName", - "in" : "path", - "description" : "The bucket name", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/ExtensionRepoGroup" - } - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/extension-repository/{bucketName}/{groupId}" : { - "get" : { - "tags" : [ "extension repository" ], - "summary" : "Get extension repo artifacts", - "description" : "Gets the artifacts in the extension repository in the given bucket and group. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getExtensionRepoArtifacts", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketName", - "in" : "path", - "description" : "The bucket name", - "required" : true, - "type" : "string" - }, { - "name" : "groupId", - "in" : "path", - "description" : "The group id", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/ExtensionRepoArtifact" - } - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/extension-repository/{bucketName}/{groupId}/{artifactId}" : { - "get" : { - "tags" : [ "extension repository" ], - "summary" : "Get extension repo versions", - "description" : "Gets the versions in the extension repository for the given bucket, group, and artifact. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getExtensionRepoVersions", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketName", - "in" : "path", - "description" : "The bucket name", - "required" : true, - "type" : "string" - }, { - "name" : "groupId", - "in" : "path", - "description" : "The group identifier", - "required" : true, - "type" : "string" - }, { - "name" : "artifactId", - "in" : "path", - "description" : "The artifact identifier", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/ExtensionRepoVersionSummary" - } - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/extension-repository/{bucketName}/{groupId}/{artifactId}/{version}" : { - "get" : { - "tags" : [ "extension repository" ], - "summary" : "Get extension repo version", - "description" : "Gets information about the version in the given bucket, group, and artifact. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getExtensionRepoVersion", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketName", - "in" : "path", - "description" : "The bucket name", - "required" : true, - "type" : "string" - }, { - "name" : "groupId", - "in" : "path", - "description" : "The group identifier", - "required" : true, - "type" : "string" - }, { - "name" : "artifactId", - "in" : "path", - "description" : "The artifact identifier", - "required" : true, - "type" : "string" - }, { - "name" : "version", - "in" : "path", - "description" : "The version", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ExtensionRepoVersion" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/extension-repository/{bucketName}/{groupId}/{artifactId}/{version}/content" : { - "get" : { - "tags" : [ "extension repository" ], - "summary" : "Get extension repo version content", - "description" : "Gets the binary content of the bundle with the given bucket, group, artifact, and version. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getExtensionRepoVersionContent", - "consumes" : [ "*/*" ], - "produces" : [ "application/octet-stream" ], - "parameters" : [ { - "name" : "bucketName", - "in" : "path", - "description" : "The bucket name", - "required" : true, - "type" : "string" - }, { - "name" : "groupId", - "in" : "path", - "description" : "The group identifier", - "required" : true, - "type" : "string" - }, { - "name" : "artifactId", - "in" : "path", - "description" : "The artifact identifier", - "required" : true, - "type" : "string" - }, { - "name" : "version", - "in" : "path", - "description" : "The version", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "type" : "string", - "format" : "byte" - } - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/extension-repository/{bucketName}/{groupId}/{artifactId}/{version}/extensions" : { - "get" : { - "tags" : [ "extension repository" ], - "summary" : "Get extension repo extensions", - "description" : "Gets information about the extensions in the given bucket, group, artifact, and version. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getExtensionRepoVersionExtensions", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketName", - "in" : "path", - "description" : "The bucket name", - "required" : true, - "type" : "string" - }, { - "name" : "groupId", - "in" : "path", - "description" : "The group identifier", - "required" : true, - "type" : "string" - }, { - "name" : "artifactId", - "in" : "path", - "description" : "The artifact identifier", - "required" : true, - "type" : "string" - }, { - "name" : "version", - "in" : "path", - "description" : "The version", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/ExtensionMetadata" - } - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/extension-repository/{bucketName}/{groupId}/{artifactId}/{version}/extensions/{name}" : { - "get" : { - "tags" : [ "extension repository" ], - "summary" : "Get extension repo extension", - "description" : "Gets information about the extension with the given name in the given bucket, group, artifact, and version. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getExtensionRepoVersionExtension", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketName", - "in" : "path", - "description" : "The bucket name", - "required" : true, - "type" : "string" - }, { - "name" : "groupId", - "in" : "path", - "description" : "The group identifier", - "required" : true, - "type" : "string" - }, { - "name" : "artifactId", - "in" : "path", - "description" : "The artifact identifier", - "required" : true, - "type" : "string" - }, { - "name" : "version", - "in" : "path", - "description" : "The version", - "required" : true, - "type" : "string" - }, { - "name" : "name", - "in" : "path", - "description" : "The fully qualified name of the extension", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/Extension" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/extension-repository/{bucketName}/{groupId}/{artifactId}/{version}/extensions/{name}/docs" : { - "get" : { - "tags" : [ "extension repository" ], - "summary" : "Get extension repo extension docs", - "description" : "Gets the documentation for the extension with the given name in the given bucket, group, artifact, and version. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getExtensionRepoVersionExtensionDocs", - "consumes" : [ "*/*" ], - "produces" : [ "text/html" ], - "parameters" : [ { - "name" : "bucketName", - "in" : "path", - "description" : "The bucket name", - "required" : true, - "type" : "string" - }, { - "name" : "groupId", - "in" : "path", - "description" : "The group identifier", - "required" : true, - "type" : "string" - }, { - "name" : "artifactId", - "in" : "path", - "description" : "The artifact identifier", - "required" : true, - "type" : "string" - }, { - "name" : "version", - "in" : "path", - "description" : "The version", - "required" : true, - "type" : "string" - }, { - "name" : "name", - "in" : "path", - "description" : "The fully qualified name of the extension", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/extension-repository/{bucketName}/{groupId}/{artifactId}/{version}/extensions/{name}/docs/additional-details" : { - "get" : { - "tags" : [ "extension repository" ], - "summary" : "Get extension repo extension details", - "description" : "Gets the additional details documentation for the extension with the given name in the given bucket, group, artifact, and version. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getExtensionRepoVersionExtensionAdditionalDetailsDocs", - "consumes" : [ "*/*" ], - "produces" : [ "text/html" ], - "parameters" : [ { - "name" : "bucketName", - "in" : "path", - "description" : "The bucket name", - "required" : true, - "type" : "string" - }, { - "name" : "groupId", - "in" : "path", - "description" : "The group identifier", - "required" : true, - "type" : "string" - }, { - "name" : "artifactId", - "in" : "path", - "description" : "The artifact identifier", - "required" : true, - "type" : "string" - }, { - "name" : "version", - "in" : "path", - "description" : "The version", - "required" : true, - "type" : "string" - }, { - "name" : "name", - "in" : "path", - "description" : "The fully qualified name of the extension", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/extension-repository/{bucketName}/{groupId}/{artifactId}/{version}/sha256" : { - "get" : { - "tags" : [ "extension repository" ], - "summary" : "Get extension repo version checksum", - "description" : "Gets the hex representation of the SHA-256 digest for the binary content of the bundle with the given bucket, group, artifact, and version.\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getExtensionRepoVersionSha256", - "consumes" : [ "*/*" ], - "produces" : [ "text/plain" ], - "parameters" : [ { - "name" : "bucketName", - "in" : "path", - "description" : "The bucket name", - "required" : true, - "type" : "string" - }, { - "name" : "groupId", - "in" : "path", - "description" : "The group identifier", - "required" : true, - "type" : "string" - }, { - "name" : "artifactId", - "in" : "path", - "description" : "The artifact identifier", - "required" : true, - "type" : "string" - }, { - "name" : "version", - "in" : "path", - "description" : "The version", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/extension-repository/{groupId}/{artifactId}/{version}/sha256" : { - "get" : { - "tags" : [ "extension repository" ], - "summary" : "Get global extension repo version checksum", - "description" : "Gets the hex representation of the SHA-256 digest for the binary content with the given bucket, group, artifact, and version. Since the same group-artifact-version can exist in multiple buckets, this will return the checksum of the first one returned. This will be consistent since the checksum must be the same when existing in multiple buckets. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getGlobalExtensionRepoVersionSha256", - "consumes" : [ "*/*" ], - "produces" : [ "text/plain" ], - "parameters" : [ { - "name" : "groupId", - "in" : "path", - "description" : "The group identifier", - "required" : true, - "type" : "string" - }, { - "name" : "artifactId", - "in" : "path", - "description" : "The artifact identifier", - "required" : true, - "type" : "string" - }, { - "name" : "version", - "in" : "path", - "description" : "The version", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ] - } - }, - "/extensions" : { - "get" : { - "tags" : [ "extensions" ], - "summary" : "Get all extensions", - "description" : "Gets the metadata for all extensions that match the filter params and are part of bundles located in buckets the current user is authorized for. If the user is not authorized to any buckets, an empty result set will be returned.\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getExtensions", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bundleType", - "in" : "query", - "description" : "The type of bundles to return", - "required" : false, - "type" : "string", - "enum" : [ "nifi-nar", "minifi-cpp" ] - }, { - "name" : "extensionType", - "in" : "query", - "description" : "The type of extensions to return", - "required" : false, - "type" : "string", - "enum" : [ "PROCESSOR", "CONTROLLER_SERVICE", "REPORTING_TASK" ] - }, { - "name" : "tag", - "in" : "query", - "description" : "The tags to filter on, will be used in an OR statement", - "required" : false, - "type" : "array", - "items" : { - "type" : "string" - }, - "collectionFormat" : "multi" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ExtensionMetadataContainer" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ] - } - }, - "/extensions/provided-service-api" : { - "get" : { - "tags" : [ "extensions" ], - "summary" : "Get extensions providing service API", - "description" : "Gets the metadata for extensions that provide the specified API and are part of bundles located in buckets the current user is authorized for. If the user is not authorized to any buckets, an empty result set will be returned.\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getExtensionsProvidingServiceAPI", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "className", - "in" : "query", - "description" : "The name of the service API class", - "required" : true, - "type" : "string" - }, { - "name" : "groupId", - "in" : "query", - "description" : "The groupId of the bundle containing the service API class", - "required" : true, - "type" : "string" - }, { - "name" : "artifactId", - "in" : "query", - "description" : "The artifactId of the bundle containing the service API class", - "required" : true, - "type" : "string" - }, { - "name" : "version", - "in" : "query", - "description" : "The version of the bundle containing the service API class", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ExtensionMetadataContainer" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ] - } - }, - "/extensions/tags" : { - "get" : { - "tags" : [ "extensions" ], - "summary" : "Get extension tags", - "description" : "Gets all the extension tags known to this NiFi Registry instance, along with the number of extensions that have the given tag.\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getTags", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/TagCount" - } - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ] - } - }, - "/flows/fields" : { - "get" : { - "tags" : [ "flows" ], - "summary" : "Get flow fields", - "description" : "Retrieves the flow field names that can be used for searching or sorting on flows.", - "operationId" : "getAvailableFlowFields", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/Fields" - } - } - }, - "security" : [ { - "Authorization" : [ ] - } ] - } - }, - "/flows/{flowId}" : { - "get" : { - "tags" : [ "flows" ], - "summary" : "Get flow", - "description" : "Gets a flow by id.", - "operationId" : "globalGetFlow", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "flowId", - "in" : "path", - "description" : "The flow identifier", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlow" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/flows/{flowId}/versions" : { - "get" : { - "tags" : [ "flows" ], - "summary" : "Get flow versions", - "description" : "Gets summary information for all versions of a given flow. Versions are ordered newest->oldest.", - "operationId" : "globalGetFlowVersions", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "flowId", - "in" : "path", - "description" : "The flow identifier", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/VersionedFlowSnapshotMetadata" - } - } - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/flows/{flowId}/versions/latest" : { - "get" : { - "tags" : [ "flows" ], - "summary" : "Get latest flow version", - "description" : "Gets the latest version of a flow, including metadata and flow content.", - "operationId" : "globalGetLatestFlowVersion", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "flowId", - "in" : "path", - "description" : "The flow identifier", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlowSnapshot" - } - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/flows/{flowId}/versions/latest/metadata" : { - "get" : { - "tags" : [ "flows" ], - "summary" : "Get latest flow version metadata", - "description" : "Gets the metadata for the latest version of a flow.", - "operationId" : "globalGetLatestFlowVersionMetadata", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "flowId", - "in" : "path", - "description" : "The flow identifier", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlowSnapshotMetadata" - } - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/flows/{flowId}/versions/{versionNumber}" : { - "get" : { - "tags" : [ "flows" ], - "summary" : "Get flow version", - "description" : "Gets the given version of a flow, including metadata and flow content.", - "operationId" : "globalGetFlowVersion", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "flowId", - "in" : "path", - "description" : "The flow identifier", - "required" : true, - "type" : "string" - }, { - "name" : "versionNumber", - "in" : "path", - "description" : "The version number", - "required" : true, - "type" : "integer", - "pattern" : "\\d+", - "format" : "int32" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlowSnapshot" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/items" : { - "get" : { - "tags" : [ "items" ], - "summary" : "Get all items", - "description" : "Get items across all buckets. The returned items will include only items from buckets for which the user is authorized. If the user is not authorized to any buckets, an empty list will be returned.", - "operationId" : "getItems", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/BucketItem" - } - } - }, - "401" : { - "description" : "Client could not be authenticated." - } - }, - "security" : [ { - "Authorization" : [ ] - } ] - } - }, - "/items/fields" : { - "get" : { - "tags" : [ "items" ], - "summary" : "Get item fields", - "description" : "Retrieves the item field names for searching or sorting on bucket items.", - "operationId" : "getAvailableBucketItemFields", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/Fields" - } - } - }, - "security" : [ { - "Authorization" : [ ] - } ] - } - }, - "/items/{bucketId}" : { - "get" : { - "tags" : [ "items" ], - "summary" : "Get bucket items", - "description" : "Gets the items located in the given bucket.", - "operationId" : "getItemsInBucket", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketId", - "in" : "path", - "description" : "The bucket identifier", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/BucketItem" - } - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/policies" : { - "get" : { - "tags" : [ "policies" ], - "summary" : "Get all access policies", - "description" : "", - "operationId" : "getAccessPolicies", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/AccessPolicy" - } - } - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/policies", - "action" : "read" - } - }, - "post" : { - "tags" : [ "policies" ], - "summary" : "Create access policy", - "description" : "", - "operationId" : "createAccessPolicy", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The access policy configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/AccessPolicy" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/AccessPolicy" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid. The NiFi Registry might not be configured to use a ConfigurableAccessPolicyProvider." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/policies", - "action" : "write" - } - } - }, - "/policies/resources" : { - "get" : { - "tags" : [ "policies" ], - "summary" : "Get available resources", - "description" : "Gets the available resources that support access/authorization policies", - "operationId" : "getResources", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/Resource" - } - } - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/policies", - "action" : "read" - } - } - }, - "/policies/{action}/{resource}" : { - "get" : { - "tags" : [ "policies" ], - "summary" : "Get access policy for resource", - "description" : "Gets an access policy for the specified action and resource", - "operationId" : "getAccessPolicyForResource", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "action", - "in" : "path", - "description" : "The request action.", - "required" : true, - "type" : "string", - "enum" : [ "read", "write", "delete" ] - }, { - "name" : "resource", - "in" : "path", - "description" : "The resource of the policy.", - "required" : true, - "type" : "string", - "pattern" : ".+" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/AccessPolicy" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/policies", - "action" : "read" - } - } - }, - "/policies/{id}" : { - "get" : { - "tags" : [ "policies" ], - "summary" : "Get access policy", - "description" : "", - "operationId" : "getAccessPolicy", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The access policy id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/AccessPolicy" - } - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/policies", - "action" : "read" - } - }, - "put" : { - "tags" : [ "policies" ], - "summary" : "Update access policy", - "description" : "", - "operationId" : "updateAccessPolicy", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The access policy id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The access policy configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/AccessPolicy" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/AccessPolicy" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid. The NiFi Registry might not be configured to use a ConfigurableAccessPolicyProvider." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/policies", - "action" : "write" - } - }, - "delete" : { - "tags" : [ "policies" ], - "summary" : "Delete access policy", - "description" : "", - "operationId" : "removeAccessPolicy", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The version is used to verify the client is working with the latest version of the entity.", - "required" : true, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The access policy id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/AccessPolicy" - } - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid. The NiFi Registry might not be configured to use a ConfigurableAccessPolicyProvider." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/policies", - "action" : "delete" - } - } - }, - "/tenants/user-groups" : { - "get" : { - "tags" : [ "tenants" ], - "summary" : "Get user groups", - "description" : "\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getUserGroups", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/UserGroup" - } - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/tenants", - "action" : "read" - } - }, - "post" : { - "tags" : [ "tenants" ], - "summary" : "Create user group", - "description" : "\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "createUserGroup", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The user group configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/UserGroup" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/UserGroup" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/tenants", - "action" : "write" - } - } - }, - "/tenants/user-groups/{id}" : { - "get" : { - "tags" : [ "tenants" ], - "summary" : "Get user group", - "description" : "\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getUserGroup", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The user group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/UserGroup" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/tenants", - "action" : "read" - } - }, - "put" : { - "tags" : [ "tenants" ], - "summary" : "Update user group", - "description" : "\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "updateUserGroup", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The user group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The user group configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/UserGroup" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/UserGroup" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/tenants", - "action" : "write" - } - }, - "delete" : { - "tags" : [ "tenants" ], - "summary" : "Delete user group", - "description" : "\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "removeUserGroup", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The version is used to verify the client is working with the latest version of the entity.", - "required" : true, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The user group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/UserGroup" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/tenants", - "action" : "delete" - } - } - }, - "/tenants/users" : { - "get" : { - "tags" : [ "tenants" ], - "summary" : "Get all users", - "description" : "\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getUsers", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/User" - } - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/tenants", - "action" : "read" - } - }, - "post" : { - "tags" : [ "tenants" ], - "summary" : "Create user", - "description" : "\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "createUser", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The user configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/User" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/User" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/tenants", - "action" : "write" - } - } - }, - "/tenants/users/{id}" : { - "get" : { - "tags" : [ "tenants" ], - "summary" : "Get user", - "description" : "\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getUser", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The user id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/User" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/tenants", - "action" : "read" - } - }, - "put" : { - "tags" : [ "tenants" ], - "summary" : "Update user", - "description" : "\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "updateUser", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The user id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The user configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/User" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/User" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/tenants", - "action" : "write" - } - }, - "delete" : { - "tags" : [ "tenants" ], - "summary" : "Delete user", - "description" : "\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "removeUser", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The version is used to verify the client is working with the latest version of the entity.", - "required" : true, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The user id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/User" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/tenants", - "action" : "delete" - } - } - } - }, - "securityDefinitions" : { - "Authorization" : { - "description" : "NiFi Registry Auth Token (JWT)", - "type" : "apiKey", - "name" : "Authorization", - "in" : "header" - }, - "BasicAuth" : { - "description" : "HTTP Basic Auth", - "type" : "basic" - } - }, - "definitions" : { - "AccessPolicy" : { - "type" : "object", - "required" : [ "action", "resource" ], - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The id of the policy. Set by server at creation time.", - "readOnly" : true - }, - "resource" : { - "type" : "string", - "description" : "The resource for this access policy." - }, - "action" : { - "type" : "string", - "description" : "The action associated with this access policy.", - "enum" : [ "read", "write", "delete" ] - }, - "configurable" : { - "type" : "boolean", - "description" : "Indicates if this access policy is configurable, based on which Authorizer has been configured to manage it.", - "readOnly" : true - }, - "revision" : { - "description" : "The revision of this entity used for optimistic-locking during updates.", - "readOnly" : true, - "$ref" : "#/definitions/RevisionInfo" - }, - "users" : { - "type" : "array", - "description" : "The set of user IDs associated with this access policy.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/Tenant" - } - }, - "userGroups" : { - "type" : "array", - "description" : "The set of user group IDs associated with this access policy.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/Tenant" - } - } - } - }, - "AccessPolicySummary" : { - "type" : "object", - "required" : [ "action", "resource" ], - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The id of the policy. Set by server at creation time.", - "readOnly" : true - }, - "resource" : { - "type" : "string", - "description" : "The resource for this access policy." - }, - "action" : { - "type" : "string", - "description" : "The action associated with this access policy.", - "enum" : [ "read", "write", "delete" ] - }, - "configurable" : { - "type" : "boolean", - "description" : "Indicates if this access policy is configurable, based on which Authorizer has been configured to manage it.", - "readOnly" : true - }, - "revision" : { - "description" : "The revision of this entity used for optimistic-locking during updates.", - "readOnly" : true, - "$ref" : "#/definitions/RevisionInfo" - } - } - }, - "AllowableValue" : { - "type" : "object", - "properties" : { - "value" : { - "type" : "string", - "description" : "The value of the allowable value" - }, - "displayName" : { - "type" : "string", - "description" : "The display name of the allowable value" - }, - "description" : { - "type" : "string", - "description" : "The description of the allowable value" - } - } - }, - "Attribute" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The name of the attribute" - }, - "description" : { - "type" : "string", - "description" : "The description of the attribute" - } - } - }, - "BatchSize" : { - "type" : "object", - "properties" : { - "count" : { - "type" : "integer", - "format" : "int32", - "description" : "Preferred number of flow files to include in a transaction." - }, - "size" : { - "type" : "string", - "description" : "Preferred number of bytes to include in a transaction." - }, - "duration" : { - "type" : "string", - "description" : "Preferred amount of time that a transaction should span." - } - } - }, - "Bucket" : { - "type" : "object", - "required" : [ "name" ], - "properties" : { - "link" : { - "description" : "An WebLink to this entity.", - "readOnly" : true, - "$ref" : "#/definitions/JaxbLink" - }, - "identifier" : { - "type" : "string", - "description" : "An ID to uniquely identify this object.", - "readOnly" : true - }, - "name" : { - "type" : "string", - "description" : "The name of the bucket." - }, - "createdTimestamp" : { - "type" : "integer", - "format" : "int64", - "description" : "The timestamp of when the bucket was first created. This is set by the server at creation time.", - "readOnly" : true, - "minimum" : 1 - }, - "description" : { - "type" : "string", - "description" : "A description of the bucket." - }, - "allowBundleRedeploy" : { - "type" : "boolean", - "description" : "Indicates if this bucket allows the same version of an extension bundle to be redeployed and thus overwrite the existing artifact. By default this is false." - }, - "allowPublicRead" : { - "type" : "boolean", - "description" : "Indicates if this bucket allows read access to unauthenticated anonymous users" - }, - "permissions" : { - "description" : "The access that the current user has to this bucket.", - "readOnly" : true, - "$ref" : "#/definitions/Permissions" - }, - "revision" : { - "description" : "The revision of this entity used for optimistic-locking during updates.", - "readOnly" : true, - "$ref" : "#/definitions/RevisionInfo" - } - } - }, - "BucketItem" : { - "type" : "object", - "required" : [ "bucketIdentifier", "name", "type" ], - "properties" : { - "link" : { - "description" : "An WebLink to this entity.", - "readOnly" : true, - "$ref" : "#/definitions/JaxbLink" - }, - "identifier" : { - "type" : "string", - "description" : "An ID to uniquely identify this object.", - "readOnly" : true - }, - "name" : { - "type" : "string", - "description" : "The name of the item." - }, - "description" : { - "type" : "string", - "description" : "A description of the item." - }, - "bucketIdentifier" : { - "type" : "string", - "description" : "The identifier of the bucket this items belongs to. This cannot be changed after the item is created." - }, - "bucketName" : { - "type" : "string", - "description" : "The name of the bucket this items belongs to.", - "readOnly" : true - }, - "createdTimestamp" : { - "type" : "integer", - "format" : "int64", - "description" : "The timestamp of when the item was created, as milliseconds since epoch.", - "readOnly" : true, - "minimum" : 1 - }, - "modifiedTimestamp" : { - "type" : "integer", - "format" : "int64", - "description" : "The timestamp of when the item was last modified, as milliseconds since epoch.", - "readOnly" : true, - "minimum" : 1 - }, - "type" : { - "type" : "string", - "description" : "The type of item.", - "enum" : [ "Flow", "Bundle" ] - }, - "permissions" : { - "description" : "The access that the current user has to the bucket containing this item.", - "readOnly" : true, - "$ref" : "#/definitions/Permissions" - } - } - }, - "BuildInfo" : { - "type" : "object", - "properties" : { - "buildTool" : { - "type" : "string", - "description" : "The tool used to build the version of the bundle" - }, - "buildFlags" : { - "type" : "string", - "description" : "The flags used to build the version of the bundle" - }, - "buildBranch" : { - "type" : "string", - "description" : "The branch used to build the version of the bundle" - }, - "buildTag" : { - "type" : "string", - "description" : "The tag used to build the version of the bundle" - }, - "buildRevision" : { - "type" : "string", - "description" : "The revision used to build the version of the bundle" - }, - "built" : { - "type" : "integer", - "format" : "int64", - "description" : "The timestamp the version of the bundle was built" - }, - "builtBy" : { - "type" : "string", - "description" : "The identity of the user that performed the build" - } - } - }, - "Bundle" : { - "type" : "object", - "properties" : { - "group" : { - "type" : "string", - "description" : "The group of the bundle" - }, - "artifact" : { - "type" : "string", - "description" : "The artifact of the bundle" - }, - "version" : { - "type" : "string", - "description" : "The version of the bundle" - } - } - }, - "BundleInfo" : { - "type" : "object", - "properties" : { - "bucketId" : { - "type" : "string", - "description" : "The id of the bucket where the bundle is located" - }, - "bucketName" : { - "type" : "string", - "description" : "The name of the bucket where the bundle is located" - }, - "bundleId" : { - "type" : "string", - "description" : "The id of the bundle" - }, - "bundleType" : { - "type" : "string", - "description" : "The type of bundle (i.e. a NiFi NAR vs MiNiFi CPP)", - "enum" : [ "NIFI_NAR", "MINIFI_CPP" ] - }, - "groupId" : { - "type" : "string", - "description" : "The group id of the bundle" - }, - "artifactId" : { - "type" : "string", - "description" : "The artifact id of the bundle" - }, - "version" : { - "type" : "string", - "description" : "The version of the bundle" - }, - "systemApiVersion" : { - "type" : "string", - "description" : "The version of the system API the bundle was built against" - } - } - }, - "BundleVersion" : { - "type" : "object", - "required" : [ "versionMetadata" ], - "properties" : { - "link" : { - "description" : "An WebLink to this entity.", - "readOnly" : true, - "$ref" : "#/definitions/JaxbLink" - }, - "versionMetadata" : { - "description" : "The metadata about this version of the extension bundle", - "$ref" : "#/definitions/BundleVersionMetadata" - }, - "dependencies" : { - "type" : "array", - "description" : "The set of other bundle versions that this version is dependent on", - "readOnly" : true, - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/BundleVersionDependency" - } - }, - "bundle" : { - "description" : "The bundle this version is for", - "readOnly" : true, - "$ref" : "#/definitions/ExtensionBundle" - }, - "bucket" : { - "description" : "The bucket that the extension bundle belongs to", - "$ref" : "#/definitions/Bucket" - }, - "filename" : { - "type" : "string" - } - } - }, - "BundleVersionDependency" : { - "type" : "object", - "properties" : { - "groupId" : { - "type" : "string", - "description" : "The group id of the bundle dependency" - }, - "artifactId" : { - "type" : "string", - "description" : "The artifact id of the bundle dependency" - }, - "version" : { - "type" : "string", - "description" : "The version of the bundle dependency" - } - } - }, - "BundleVersionMetadata" : { - "type" : "object", - "required" : [ "bucketId", "buildInfo", "contentSize", "sha256Supplied" ], - "properties" : { - "link" : { - "description" : "An WebLink to this entity.", - "readOnly" : true, - "$ref" : "#/definitions/JaxbLink" - }, - "id" : { - "type" : "string", - "description" : "The id of this version of the extension bundle" - }, - "bundleId" : { - "type" : "string", - "description" : "The id of the extension bundle this version is for" - }, - "bucketId" : { - "type" : "string", - "description" : "The id of the bucket the extension bundle belongs to" - }, - "groupId" : { - "type" : "string" - }, - "artifactId" : { - "type" : "string" - }, - "version" : { - "type" : "string", - "description" : "The version of the extension bundle" - }, - "timestamp" : { - "type" : "integer", - "format" : "int64", - "description" : "The timestamp of the create date of this version", - "minimum" : 1 - }, - "author" : { - "type" : "string", - "description" : "The identity that created this version" - }, - "description" : { - "type" : "string", - "description" : "The description for this version" - }, - "sha256" : { - "type" : "string", - "description" : "The hex representation of the SHA-256 digest of the binary content for this version" - }, - "sha256Supplied" : { - "type" : "boolean", - "description" : "Whether or not the client supplied a SHA-256 when uploading the bundle" - }, - "contentSize" : { - "type" : "integer", - "format" : "int64", - "description" : "The size of the binary content for this version in bytes", - "minimum" : 0 - }, - "systemApiVersion" : { - "type" : "string", - "description" : "The version of the system API that this bundle version was built against" - }, - "buildInfo" : { - "description" : "The build information about this version", - "$ref" : "#/definitions/BuildInfo" - } - } - }, - "ComponentDifference" : { - "type" : "object", - "properties" : { - "valueA" : { - "type" : "string", - "description" : "The earlier value from the difference." - }, - "valueB" : { - "type" : "string", - "description" : "The newer value from the difference." - }, - "changeDescription" : { - "type" : "string", - "description" : "The description of the change." - }, - "differenceType" : { - "type" : "string", - "description" : "The key to the difference." - }, - "differenceTypeDescription" : { - "type" : "string", - "description" : "The description of the change type." - } - } - }, - "ComponentDifferenceGroup" : { - "type" : "object", - "properties" : { - "componentId" : { - "type" : "string", - "description" : "The id of the component whose changes are grouped together." - }, - "componentName" : { - "type" : "string", - "description" : "The name of the component whose changes are grouped together." - }, - "componentType" : { - "type" : "string", - "description" : "The type of component these changes relate to." - }, - "processGroupId" : { - "type" : "string", - "description" : "The process group id for this component." - }, - "differences" : { - "type" : "array", - "description" : "The list of changes related to this component between the 2 versions.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ComponentDifference" - } - } - } - }, - "ConnectableComponent" : { - "type" : "object", - "required" : [ "groupId", "id", "type" ], - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the connectable component." - }, - "type" : { - "type" : "string", - "description" : "The type of component the connectable is.", - "enum" : [ "PROCESSOR", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "INPUT_PORT", "OUTPUT_PORT", "FUNNEL" ] - }, - "groupId" : { - "type" : "string", - "description" : "The id of the group that the connectable component resides in" - }, - "name" : { - "type" : "string", - "description" : "The name of the connectable component" - }, - "comments" : { - "type" : "string", - "description" : "The comments for the connectable component." - }, - "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" - } - } - }, - "ControllerServiceAPI" : { - "type" : "object", - "properties" : { - "type" : { - "type" : "string", - "description" : "The fully qualified name of the service interface." - }, - "bundle" : { - "description" : "The details of the artifact that bundled this service interface.", - "$ref" : "#/definitions/Bundle" - } - } - }, - "ControllerServiceDefinition" : { - "type" : "object", - "properties" : { - "className" : { - "type" : "string", - "description" : "The class name of the service API" - }, - "groupId" : { - "type" : "string", - "description" : "The group id of the service API" - }, - "artifactId" : { - "type" : "string", - "description" : "The artifact id of the service API" - }, - "version" : { - "type" : "string", - "description" : "The version of the service API" - } - } - }, - "CurrentUser" : { - "type" : "object", - "properties" : { - "identity" : { - "type" : "string", - "description" : "The identity of the current user", - "readOnly" : true - }, - "anonymous" : { - "type" : "boolean", - "description" : "Indicates if the current user is anonymous", - "readOnly" : true - }, - "loginSupported" : { - "type" : "boolean", - "description" : "Indicates if the NiFi Registry instance supports logging in" - }, - "resourcePermissions" : { - "description" : "The access that the current user has to top level resources", - "readOnly" : true, - "$ref" : "#/definitions/ResourcePermissions" - }, - "oidcloginSupported" : { - "type" : "boolean", - "description" : "Indicates if the NiFi Registry instance supports logging in with an OIDC provider" - } - } - }, - "DefaultSchedule" : { - "type" : "object", - "properties" : { - "strategy" : { - "type" : "string", - "description" : "The default scheduling strategy" - }, - "period" : { - "type" : "string", - "description" : "The default scheduling period" - }, - "concurrentTasks" : { - "type" : "string", - "description" : "The default concurrent tasks" - } - } - }, - "DefaultSettings" : { - "type" : "object", - "properties" : { - "yieldDuration" : { - "type" : "string", - "description" : "The default yield duration" - }, - "penaltyDuration" : { - "type" : "string", - "description" : "The default penalty duration" - }, - "bulletinLevel" : { - "type" : "string", - "description" : "The default bulletin level" - } - } - }, - "Dependency" : { - "type" : "object", - "properties" : { - "propertyName" : { - "type" : "string", - "description" : "The name of the dependent property" - }, - "propertyDisplayName" : { - "type" : "string", - "description" : "The display name of the dependent property" - }, - "dependentValues" : { - "description" : "The values of the dependent property that enable the depending property", - "$ref" : "#/definitions/DependentValues" - } - } - }, - "DependentValues" : { - "type" : "object", - "properties" : { - "values" : { - "type" : "array", - "xml" : { - "name" : "dependentValue" - }, - "description" : "The dependent values", - "items" : { - "type" : "string", - "xml" : { - "name" : "dependentValue" - } - } - } - } - }, - "DeprecationNotice" : { - "type" : "object", - "properties" : { - "reason" : { - "type" : "string", - "description" : "The reason for the deprecation" - }, - "alternatives" : { - "type" : "array", - "xml" : { - "wrapped" : true - }, - "description" : "The alternatives to use", - "items" : { - "type" : "string", - "xml" : { - "name" : "alternative" - } - } - } - } - }, - "DynamicProperty" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The description of the dynamic property name" - }, - "value" : { - "type" : "string", - "description" : "The description of the dynamic property value" - }, - "description" : { - "type" : "string", - "description" : "The description of the dynamic property" - }, - "expressionLanguageScope" : { - "type" : "string", - "description" : "The scope of the expression language support", - "enum" : [ "NONE", "VARIABLE_REGISTRY", "FLOWFILE_ATTRIBUTES" ] - }, - "expressionLanguageSupported" : { - "type" : "boolean", - "description" : "Whether or not expression language is supported" - } - } - }, - "DynamicRelationship" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The description of the dynamic relationship name" - }, - "description" : { - "type" : "string", - "description" : "The description of the dynamic relationship" - } - } - }, - "Extension" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The name of the extension" - }, - "type" : { - "type" : "string", - "description" : "The type of the extension", - "enum" : [ "PROCESSOR", "CONTROLLER_SERVICE", "REPORTING_TASK" ] - }, - "deprecationNotice" : { - "description" : "The deprecation notice of the extension", - "$ref" : "#/definitions/DeprecationNotice" - }, - "description" : { - "type" : "string", - "description" : "The description of the extension" - }, - "tags" : { - "type" : "array", - "xml" : { - "wrapped" : true - }, - "description" : "The tags of the extension", - "items" : { - "type" : "string", - "xml" : { - "name" : "tag" - } - } - }, - "properties" : { - "type" : "array", - "xml" : { - "wrapped" : true - }, - "description" : "The properties of the extension", - "items" : { - "xml" : { - "name" : "property" - }, - "$ref" : "#/definitions/Property" - } - }, - "supportsSensitiveDynamicProperties" : { - "type" : "boolean" - }, - "dynamicProperties" : { - "type" : "array", - "xml" : { - "wrapped" : true - }, - "description" : "The dynamic properties of the extension", - "items" : { - "xml" : { - "name" : "dynamicProperty" - }, - "$ref" : "#/definitions/DynamicProperty" - } - }, - "relationships" : { - "type" : "array", - "xml" : { - "wrapped" : true - }, - "description" : "The relationships of the extension", - "items" : { - "xml" : { - "name" : "relationship" - }, - "$ref" : "#/definitions/Relationship" - } - }, - "dynamicRelationship" : { - "description" : "The dynamic relationships of the extension", - "$ref" : "#/definitions/DynamicRelationship" - }, - "readsAttributes" : { - "type" : "array", - "xml" : { - "wrapped" : true - }, - "description" : "The attributes read from flow files by the extension", - "items" : { - "xml" : { - "name" : "readsAttribute" - }, - "$ref" : "#/definitions/Attribute" - } - }, - "writesAttributes" : { - "type" : "array", - "xml" : { - "wrapped" : true - }, - "description" : "The attributes written to flow files by the extension", - "items" : { - "xml" : { - "name" : "writesAttribute" - }, - "$ref" : "#/definitions/Attribute" - } - }, - "stateful" : { - "description" : "The information about how the extension stores state", - "$ref" : "#/definitions/Stateful" - }, - "restricted" : { - "description" : "The restrictions of the extension", - "$ref" : "#/definitions/Restricted" - }, - "inputRequirement" : { - "type" : "string", - "description" : "The input requirement of the extension", - "enum" : [ "INPUT_REQUIRED", "INPUT_ALLOWED", "INPUT_FORBIDDEN" ] - }, - "systemResourceConsiderations" : { - "type" : "array", - "xml" : { - "wrapped" : true - }, - "description" : "The resource considerations of the extension", - "items" : { - "xml" : { - "name" : "systemResourceConsideration" - }, - "$ref" : "#/definitions/SystemResourceConsideration" - } - }, - "seeAlso" : { - "type" : "array", - "xml" : { - "wrapped" : true - }, - "description" : "The names of other extensions to see", - "items" : { - "type" : "string", - "xml" : { - "name" : "see" - } - } - }, - "providedServiceAPIs" : { - "type" : "array", - "xml" : { - "wrapped" : true - }, - "description" : "The service APIs provided by this extension", - "items" : { - "xml" : { - "name" : "providedServiceAPI" - }, - "$ref" : "#/definitions/ProvidedServiceAPI" - } - }, - "defaultSettings" : { - "description" : "The default settings for a processor", - "$ref" : "#/definitions/DefaultSettings" - }, - "defaultSchedule" : { - "description" : "The default schedule for a processor reporting task", - "$ref" : "#/definitions/DefaultSchedule" - }, - "triggerSerially" : { - "type" : "boolean", - "description" : "Indicates that a processor should be triggered serially" - }, - "triggerWhenEmpty" : { - "type" : "boolean", - "description" : "Indicates that a processor should be triggered when the incoming queues are empty" - }, - "triggerWhenAnyDestinationAvailable" : { - "type" : "boolean", - "description" : "Indicates that a processor should be triggered when any destinations have space for flow files" - }, - "supportsBatching" : { - "type" : "boolean", - "description" : "Indicates that a processor supports batching" - }, - "eventDriven" : { - "type" : "boolean", - "description" : "Indicates that a processor supports event driven scheduling" - }, - "primaryNodeOnly" : { - "type" : "boolean", - "description" : "Indicates that a processor should be scheduled only on the primary node" - }, - "sideEffectFree" : { - "type" : "boolean", - "description" : "Indicates that a processor is side effect free" - } - } - }, - "ExtensionBundle" : { - "type" : "object", - "required" : [ "bucketIdentifier", "bundleType", "name", "type" ], - "properties" : { - "link" : { - "description" : "An WebLink to this entity.", - "readOnly" : true, - "$ref" : "#/definitions/JaxbLink" - }, - "identifier" : { - "type" : "string", - "description" : "An ID to uniquely identify this object.", - "readOnly" : true - }, - "name" : { - "type" : "string", - "description" : "The name of the item." - }, - "description" : { - "type" : "string", - "description" : "A description of the item." - }, - "bucketIdentifier" : { - "type" : "string", - "description" : "The identifier of the bucket this items belongs to. This cannot be changed after the item is created." - }, - "bucketName" : { - "type" : "string", - "description" : "The name of the bucket this items belongs to.", - "readOnly" : true - }, - "createdTimestamp" : { - "type" : "integer", - "format" : "int64", - "description" : "The timestamp of when the item was created, as milliseconds since epoch.", - "readOnly" : true, - "minimum" : 1 - }, - "modifiedTimestamp" : { - "type" : "integer", - "format" : "int64", - "description" : "The timestamp of when the item was last modified, as milliseconds since epoch.", - "readOnly" : true, - "minimum" : 1 - }, - "type" : { - "type" : "string", - "description" : "The type of item.", - "enum" : [ "Flow", "Bundle" ] - }, - "permissions" : { - "description" : "The access that the current user has to the bucket containing this item.", - "readOnly" : true, - "$ref" : "#/definitions/Permissions" - }, - "bundleType" : { - "type" : "string", - "description" : "The type of the extension bundle", - "enum" : [ "NIFI_NAR", "MINIFI_CPP" ] - }, - "groupId" : { - "type" : "string", - "description" : "The group id of the extension bundle" - }, - "artifactId" : { - "type" : "string", - "description" : "The artifact id of the extension bundle" - }, - "versionCount" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of versions of this extension bundle.", - "readOnly" : true, - "minimum" : 0 - } - } - }, - "ExtensionFilterParams" : { - "type" : "object", - "properties" : { - "bundleType" : { - "type" : "string", - "description" : "The type of bundle", - "enum" : [ "NIFI_NAR", "MINIFI_CPP" ] - }, - "extensionType" : { - "type" : "string", - "description" : "The type of extension", - "enum" : [ "PROCESSOR", "CONTROLLER_SERVICE", "REPORTING_TASK" ] - }, - "tags" : { - "type" : "array", - "description" : "The tags", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - } - } - }, - "ExtensionMetadata" : { - "type" : "object", - "properties" : { - "link" : { - "description" : "An WebLink to this entity.", - "readOnly" : true, - "$ref" : "#/definitions/JaxbLink" - }, - "name" : { - "type" : "string", - "description" : "The name of the extension" - }, - "displayName" : { - "type" : "string", - "description" : "The display name of the extension" - }, - "type" : { - "type" : "string", - "description" : "The type of the extension", - "enum" : [ "PROCESSOR", "CONTROLLER_SERVICE", "REPORTING_TASK" ] - }, - "description" : { - "type" : "string", - "description" : "The description of the extension" - }, - "deprecationNotice" : { - "description" : "The deprecation notice of the extension", - "$ref" : "#/definitions/DeprecationNotice" - }, - "tags" : { - "type" : "array", - "description" : "The tags of the extension", - "items" : { - "type" : "string" - } - }, - "restricted" : { - "description" : "The restrictions of the extension", - "$ref" : "#/definitions/Restricted" - }, - "providedServiceAPIs" : { - "type" : "array", - "description" : "The service APIs provided by the extension", - "items" : { - "$ref" : "#/definitions/ProvidedServiceAPI" - } - }, - "bundleInfo" : { - "description" : "The information for the bundle where this extension is located", - "$ref" : "#/definitions/BundleInfo" - }, - "hasAdditionalDetails" : { - "type" : "boolean", - "description" : "Whether or not the extension has additional detail documentation" - }, - "linkDocs" : { - "description" : "A WebLink to the documentation for this extension.", - "readOnly" : true, - "$ref" : "#/definitions/JaxbLink" - } - } - }, - "ExtensionMetadataContainer" : { - "type" : "object", - "properties" : { - "numResults" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of extensions in the response" - }, - "filterParams" : { - "description" : "The filter parameters submitted for the request", - "$ref" : "#/definitions/ExtensionFilterParams" - }, - "extensions" : { - "type" : "array", - "description" : "The metadata for the extensions", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ExtensionMetadata" - } - } - } - }, - "ExtensionRepoArtifact" : { - "type" : "object", - "properties" : { - "link" : { - "description" : "An WebLink to this entity.", - "readOnly" : true, - "$ref" : "#/definitions/JaxbLink" - }, - "bucketName" : { - "type" : "string", - "description" : "The bucket name" - }, - "groupId" : { - "type" : "string", - "description" : "The group id" - }, - "artifactId" : { - "type" : "string", - "description" : "The artifact id" - } - } - }, - "ExtensionRepoBucket" : { - "type" : "object", - "properties" : { - "link" : { - "description" : "An WebLink to this entity.", - "readOnly" : true, - "$ref" : "#/definitions/JaxbLink" - }, - "bucketName" : { - "type" : "string", - "description" : "The name of the bucket" - } - } - }, - "ExtensionRepoGroup" : { - "type" : "object", - "properties" : { - "link" : { - "description" : "An WebLink to this entity.", - "readOnly" : true, - "$ref" : "#/definitions/JaxbLink" - }, - "bucketName" : { - "type" : "string", - "description" : "The bucket name" - }, - "groupId" : { - "type" : "string", - "description" : "The group id" - } - } - }, - "ExtensionRepoVersion" : { - "type" : "object", - "properties" : { - "extensionsLink" : { - "description" : "The WebLink to view the metadata about the extensions contained in the extension bundle.", - "readOnly" : true, - "$ref" : "#/definitions/JaxbLink" - }, - "downloadLink" : { - "description" : "The WebLink to download this version of the extension bundle.", - "readOnly" : true, - "$ref" : "#/definitions/JaxbLink" - }, - "sha256Link" : { - "description" : "The WebLink to retrieve the SHA-256 digest for this version of the extension bundle.", - "readOnly" : true, - "$ref" : "#/definitions/JaxbLink" - }, - "sha256Supplied" : { - "description" : "Indicates if the client supplied a SHA-256 when uploading this version of the extension bundle.", - "readOnly" : true, - "$ref" : "#/definitions/JaxbLink" - } - } - }, - "ExtensionRepoVersionSummary" : { - "type" : "object", - "properties" : { - "link" : { - "description" : "An WebLink to this entity.", - "readOnly" : true, - "$ref" : "#/definitions/JaxbLink" - }, - "bucketName" : { - "type" : "string", - "description" : "The bucket name" - }, - "groupId" : { - "type" : "string", - "description" : "The group id" - }, - "artifactId" : { - "type" : "string", - "description" : "The artifact id" - }, - "version" : { - "type" : "string", - "description" : "The version" - }, - "author" : { - "type" : "string", - "description" : "The identity of the user that created this version" - }, - "timestamp" : { - "type" : "integer", - "format" : "int64", - "description" : "The timestamp of when this version was created" - } - } - }, - "ExternalControllerServiceReference" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The identifier of the controller service" - }, - "name" : { - "type" : "string", - "description" : "The name of the controller service" - } - } - }, - "Fields" : { - "type" : "object", - "properties" : { - "fields" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - } - } - }, - "JaxbLink" : { - "type" : "object", - "properties" : { - "href" : { - "type" : "string", - "format" : "uri", - "xml" : { - "attribute" : true - }, - "description" : "The href for the link" - }, - "params" : { - "type" : "object", - "description" : "The params for the link", - "additionalProperties" : { - "type" : "string" - } - } - } - }, - "ParameterProviderReference" : { - "type" : "object", - "properties" : { - "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." - }, - "bundle" : { - "description" : "The details of the artifact that bundled this parameter provider.", - "$ref" : "#/definitions/Bundle" - } - } - }, - "Permissions" : { - "type" : "object", - "properties" : { - "canRead" : { - "type" : "boolean", - "description" : "Indicates whether the user can read a given resource.", - "readOnly" : true - }, - "canWrite" : { - "type" : "boolean", - "description" : "Indicates whether the user can write a given resource.", - "readOnly" : true - }, - "canDelete" : { - "type" : "boolean", - "description" : "Indicates whether the user can delete a given resource.", - "readOnly" : true - } - } - }, - "Position" : { - "type" : "object", - "properties" : { - "x" : { - "type" : "number", - "format" : "double", - "description" : "The x coordinate." - }, - "y" : { - "type" : "number", - "format" : "double", - "description" : "The y coordinate." - } - }, - "description" : "The position of a component on the graph" - }, - "Property" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The name of the property" - }, - "displayName" : { - "type" : "string", - "description" : "The display name" - }, - "description" : { - "type" : "string", - "description" : "The description" - }, - "defaultValue" : { - "type" : "string", - "description" : "The default value" - }, - "controllerServiceDefinition" : { - "description" : "The controller service required by this property, or null if none is required", - "$ref" : "#/definitions/ControllerServiceDefinition" - }, - "allowableValues" : { - "type" : "array", - "xml" : { - "wrapped" : true - }, - "description" : "The allowable values for this property", - "items" : { - "xml" : { - "name" : "allowableValue" - }, - "$ref" : "#/definitions/AllowableValue" - } - }, - "required" : { - "type" : "boolean", - "description" : "Whether or not the property is required" - }, - "sensitive" : { - "type" : "boolean", - "description" : "Whether or not the property is sensitive" - }, - "expressionLanguageSupported" : { - "type" : "boolean", - "description" : "Whether or not expression language is supported" - }, - "expressionLanguageScope" : { - "type" : "string", - "description" : "The scope of expression language support", - "enum" : [ "NONE", "VARIABLE_REGISTRY", "FLOWFILE_ATTRIBUTES" ] - }, - "dynamicallyModifiesClasspath" : { - "type" : "boolean", - "description" : "Whether or not the processor dynamically modifies the classpath" - }, - "dynamic" : { - "type" : "boolean", - "description" : "Whether or not the processor is dynamic" - }, - "dependencies" : { - "type" : "array", - "xml" : { - "wrapped" : true - }, - "description" : "The properties that this property depends on", - "items" : { - "xml" : { - "name" : "dependency" - }, - "$ref" : "#/definitions/Dependency" - } - }, - "resourceDefinition" : { - "description" : "The optional resource definition", - "$ref" : "#/definitions/ResourceDefinition" - } - } - }, - "ProvidedServiceAPI" : { - "type" : "object", - "properties" : { - "className" : { - "type" : "string", - "description" : "The class name of the service API being provided" - }, - "groupId" : { - "type" : "string", - "description" : "The group id of the service API being provided" - }, - "artifactId" : { - "type" : "string", - "description" : "The artifact id of the service API being provided" - }, - "version" : { - "type" : "string", - "description" : "The version of the service API being provided" - } - } - }, - "RegistryAbout" : { - "type" : "object", - "properties" : { - "registryAboutVersion" : { - "type" : "string", - "description" : "The version string for this Nifi Registry", - "readOnly" : true - } - } - }, - "RegistryConfiguration" : { - "type" : "object", - "properties" : { - "supportsManagedAuthorizer" : { - "type" : "boolean", - "description" : "Whether this NiFi Registry supports a managed authorizer. Managed authorizers can visualize users, groups, and policies in the UI.", - "readOnly" : true - }, - "supportsConfigurableAuthorizer" : { - "type" : "boolean", - "description" : "Whether this NiFi Registry supports a configurable authorizer.", - "readOnly" : true - }, - "supportsConfigurableUsersAndGroups" : { - "type" : "boolean", - "description" : "Whether this NiFi Registry supports configurable users and groups.", - "readOnly" : true - } - } - }, - "Relationship" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The name of the relationship" - }, - "description" : { - "type" : "string", - "description" : "The description of the relationship" - }, - "autoTerminated" : { - "type" : "boolean", - "description" : "Whether or not the relationship is auto-terminated by default" - } - } - }, - "Resource" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The identifier of the resource.", - "readOnly" : true - }, - "name" : { - "type" : "string", - "description" : "The name of the resource.", - "readOnly" : true - } - } - }, - "ResourceDefinition" : { - "type" : "object", - "properties" : { - "cardinality" : { - "type" : "string", - "description" : "The cardinality of the resource definition", - "enum" : [ "SINGLE", "MULTIPLE" ] - }, - "resourceTypes" : { - "type" : "array", - "xml" : { - "wrapped" : true - }, - "description" : "The types of resources", - "items" : { - "type" : "string", - "xml" : { - "name" : "resourceType" - }, - "enum" : [ "FILE", "DIRECTORY", "TEXT", "URL" ] - } - } - } - }, - "ResourcePermissions" : { - "type" : "object", - "properties" : { - "buckets" : { - "description" : "The access that the current user has to the top level /buckets resource of this NiFi Registry (i.e., access to all buckets)", - "readOnly" : true, - "$ref" : "#/definitions/Permissions" - }, - "tenants" : { - "description" : "The access that the current user has to the top level /tenants resource of this NiFi Registry", - "readOnly" : true, - "$ref" : "#/definitions/Permissions" - }, - "policies" : { - "description" : "The access that the current user has to the top level /policies resource of this NiFi Registry", - "readOnly" : true, - "$ref" : "#/definitions/Permissions" - }, - "proxy" : { - "description" : "The access that the current user has to the top level /proxy resource of this NiFi Registry", - "readOnly" : true, - "$ref" : "#/definitions/Permissions" - }, - "anyTopLevelResource" : { - "description" : "The access that the current user has to any top level resources (a logical 'OR' of all other values)", - "readOnly" : true, - "$ref" : "#/definitions/Permissions" - } - } - }, - "Restricted" : { - "type" : "object", - "properties" : { - "generalRestrictionExplanation" : { - "type" : "string", - "description" : "The general restriction for the extension, or null if only specific restrictions exist" - }, - "restrictions" : { - "type" : "array", - "xml" : { - "wrapped" : true - }, - "description" : "The specific restrictions", - "items" : { - "xml" : { - "name" : "restriction" - }, - "$ref" : "#/definitions/Restriction" - } - } - } - }, - "Restriction" : { - "type" : "object", - "properties" : { - "requiredPermission" : { - "type" : "string", - "description" : "The permission required for this restriction" - }, - "explanation" : { - "type" : "string", - "description" : "The explanation of this restriction" - } - } - }, - "RevisionInfo" : { - "type" : "object", - "properties" : { - "clientId" : { - "type" : "string", - "description" : "A client identifier used to make a request. By including a client identifier, the API can allow multiple requests without needing the current revision. Due to the asynchronous nature of requests/responses this was implemented to allow the client to make numerous requests without having to wait for the previous response to come back." - }, - "version" : { - "type" : "integer", - "format" : "int64", - "description" : "NiFi Registry employs an optimistic locking strategy where the client must include a revision in their request when performing an update. In a response to a mutable flow request, this field represents the updated base version." - }, - "lastModifier" : { - "type" : "string", - "description" : "The user that last modified the entity.", - "readOnly" : true - } - }, - "description" : "The revision information for an entity managed through the REST API." - }, - "Stateful" : { - "type" : "object", - "properties" : { - "description" : { - "type" : "string", - "description" : "The description for how the extension stores state" - }, - "scopes" : { - "type" : "array", - "xml" : { - "wrapped" : true - }, - "description" : "The scopes used to store state", - "items" : { - "type" : "string", - "xml" : { - "name" : "scope" - }, - "enum" : [ "CLUSTER", "LOCAL" ] - } - } - } - }, - "SystemResourceConsideration" : { - "type" : "object", - "properties" : { - "resource" : { - "type" : "string", - "description" : "The resource to consider" - }, - "description" : { - "type" : "string", - "description" : "The description of how the resource is affected" - } - } - }, - "TagCount" : { - "type" : "object", - "properties" : { - "tag" : { - "type" : "string", - "description" : "The tag label" - }, - "count" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of occurrences of the given tag" - } - } - }, - "Tenant" : { - "type" : "object", - "required" : [ "identity" ], - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The computer-generated identifier of the tenant.", - "readOnly" : true - }, - "identity" : { - "type" : "string", - "description" : "The human-facing identity of the tenant. This can only be changed if the tenant is configurable." - }, - "configurable" : { - "type" : "boolean", - "description" : "Indicates if this tenant is configurable, based on which UserGroupProvider has been configured to manage it.", - "readOnly" : true - }, - "resourcePermissions" : { - "description" : "A summary top-level resource access policies granted to this tenant.", - "readOnly" : true, - "$ref" : "#/definitions/ResourcePermissions" - }, - "accessPolicies" : { - "type" : "array", - "description" : "The access policies granted to this tenant.", - "readOnly" : true, - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/AccessPolicySummary" - } - }, - "revision" : { - "description" : "The revision of this entity used for optimistic-locking during updates.", - "readOnly" : true, - "$ref" : "#/definitions/RevisionInfo" - } - } - }, - "User" : { - "type" : "object", - "required" : [ "identity" ], - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The computer-generated identifier of the tenant.", - "readOnly" : true - }, - "identity" : { - "type" : "string", - "description" : "The human-facing identity of the tenant. This can only be changed if the tenant is configurable." - }, - "configurable" : { - "type" : "boolean", - "description" : "Indicates if this tenant is configurable, based on which UserGroupProvider has been configured to manage it.", - "readOnly" : true - }, - "resourcePermissions" : { - "description" : "A summary top-level resource access policies granted to this tenant.", - "readOnly" : true, - "$ref" : "#/definitions/ResourcePermissions" - }, - "accessPolicies" : { - "type" : "array", - "description" : "The access policies granted to this tenant.", - "readOnly" : true, - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/AccessPolicySummary" - } - }, - "revision" : { - "description" : "The revision of this entity used for optimistic-locking during updates.", - "readOnly" : true, - "$ref" : "#/definitions/RevisionInfo" - }, - "userGroups" : { - "type" : "array", - "description" : "The groups to which the user belongs.", - "readOnly" : true, - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/Tenant" - } - } - } - }, - "UserGroup" : { - "type" : "object", - "required" : [ "identity" ], - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The computer-generated identifier of the tenant.", - "readOnly" : true - }, - "identity" : { - "type" : "string", - "description" : "The human-facing identity of the tenant. This can only be changed if the tenant is configurable." - }, - "configurable" : { - "type" : "boolean", - "description" : "Indicates if this tenant is configurable, based on which UserGroupProvider has been configured to manage it.", - "readOnly" : true - }, - "resourcePermissions" : { - "description" : "A summary top-level resource access policies granted to this tenant.", - "readOnly" : true, - "$ref" : "#/definitions/ResourcePermissions" - }, - "accessPolicies" : { - "type" : "array", - "description" : "The access policies granted to this tenant.", - "readOnly" : true, - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/AccessPolicySummary" - } - }, - "revision" : { - "description" : "The revision of this entity used for optimistic-locking during updates.", - "readOnly" : true, - "$ref" : "#/definitions/RevisionInfo" - }, - "users" : { - "type" : "array", - "description" : "The users that belong to this user group. This can only be changed if this group is configurable.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/Tenant" - } - } - } - }, - "VersionedConnection" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The component's unique identifier" - }, - "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" - }, - "comments" : { - "type" : "string", - "description" : "The user-supplied comments for the component" - }, - "position" : { - "description" : "The component's position on the graph", - "$ref" : "#/definitions/Position" - }, - "source" : { - "description" : "The source of the connection.", - "$ref" : "#/definitions/ConnectableComponent" - }, - "destination" : { - "description" : "The destination of the connection.", - "$ref" : "#/definitions/ConnectableComponent" - }, - "labelIndex" : { - "type" : "integer", - "format" : "int32", - "description" : "The index of the bend point where to place the connection label." - }, - "zIndex" : { - "type" : "integer", - "format" : "int64", - "description" : "The z index of the connection." - }, - "selectedRelationships" : { - "type" : "array", - "description" : "The selected relationship that comprise the connection.", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - }, - "backPressureObjectThreshold" : { - "type" : "integer", - "format" : "int64", - "description" : "The object count threshold for determining when back pressure is applied. Updating this value is a passive change in the sense that it won't impact whether existing files over the limit are affected but it does help feeder processors to stop pushing too much into this work queue." - }, - "backPressureDataSizeThreshold" : { - "type" : "string", - "description" : "The object data size threshold for determining when back pressure is applied. Updating this value is a passive change in the sense that it won't impact whether existing files over the limit are affected but it does help feeder processors to stop pushing too much into this work queue." - }, - "flowFileExpiration" : { - "type" : "string", - "description" : "The amount of time a flow file may be in the flow before it will be automatically aged out of the flow. Once a flow file reaches this age it will be terminated from the flow the next time a processor attempts to start work on it." - }, - "prioritizers" : { - "type" : "array", - "description" : "The comparators used to prioritize the queue.", - "items" : { - "type" : "string" - } - }, - "bends" : { - "type" : "array", - "description" : "The bend points on the connection.", - "items" : { - "$ref" : "#/definitions/Position" - } - }, - "loadBalanceStrategy" : { - "type" : "string", - "description" : "The Strategy to use for load balancing data across the cluster, or null, if no Load Balance Strategy has been specified.", - "enum" : [ "DO_NOT_LOAD_BALANCE", "PARTITION_BY_ATTRIBUTE", "ROUND_ROBIN", "SINGLE_NODE" ] - }, - "partitioningAttribute" : { - "type" : "string", - "description" : "The attribute to use for partitioning data as it is load balanced across the cluster. If the Load Balance Strategy is configured to use PARTITION_BY_ATTRIBUTE, the value returned by this method is the name of the FlowFile Attribute that will be used to determine which node in the cluster should receive a given FlowFile. If the Load Balance Strategy is unset or is set to any other value, the Partitioning Attribute has no effect." - }, - "loadBalanceCompression" : { - "type" : "string", - "description" : "Whether or not compression should be used when transferring FlowFiles between nodes", - "enum" : [ "DO_NOT_COMPRESS", "COMPRESS_ATTRIBUTES_ONLY", "COMPRESS_ATTRIBUTES_AND_CONTENT" ] - }, - "componentType" : { - "type" : "string", - "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE", "REPORTING_TASK", "PARAMETER_CONTEXT", "PARAMETER_PROVIDER", "TEMPLATE", "FLOW_REGISTRY_CLIENT" ] - }, - "groupIdentifier" : { - "type" : "string", - "description" : "The ID of the Process Group that this component belongs to" - } - } - }, - "VersionedControllerService" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The component's unique identifier" - }, - "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" - }, - "comments" : { - "type" : "string", - "description" : "The user-supplied comments for the component" - }, - "position" : { - "description" : "The component's position on the graph", - "$ref" : "#/definitions/Position" - }, - "type" : { - "type" : "string", - "description" : "The type of the extension component" - }, - "bundle" : { - "description" : "Information about the bundle from which the component came", - "$ref" : "#/definitions/Bundle" - }, - "properties" : { - "type" : "object", - "description" : "The properties for the component. Properties whose value is not set will only contain the property name.", - "additionalProperties" : { - "type" : "string" - } - }, - "propertyDescriptors" : { - "type" : "object", - "description" : "The property descriptors for the component.", - "additionalProperties" : { - "$ref" : "#/definitions/VersionedPropertyDescriptor" - } - }, - "controllerServiceApis" : { - "type" : "array", - "description" : "Lists the APIs this Controller Service implements.", - "items" : { - "$ref" : "#/definitions/ControllerServiceAPI" - } - }, - "annotationData" : { - "type" : "string", - "description" : "The annotation for the controller service. This is how the custom UI relays configuration to the controller service." - }, - "scheduledState" : { - "type" : "string", - "description" : "The ScheduledState denoting whether the Controller Service is ENABLED or DISABLED", - "enum" : [ "ENABLED", "DISABLED", "RUNNING" ] - }, - "bulletinLevel" : { - "type" : "string", - "description" : "The level at which the controller service will report bulletins." - }, - "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", "PARAMETER_CONTEXT", "PARAMETER_PROVIDER", "TEMPLATE", "FLOW_REGISTRY_CLIENT" ] - }, - "groupIdentifier" : { - "type" : "string", - "description" : "The ID of the Process Group that this component belongs to" - } - } - }, - "VersionedFlow" : { - "type" : "object", - "required" : [ "bucketIdentifier", "name", "type" ], - "properties" : { - "link" : { - "description" : "An WebLink to this entity.", - "readOnly" : true, - "$ref" : "#/definitions/JaxbLink" - }, - "identifier" : { - "type" : "string", - "description" : "An ID to uniquely identify this object.", - "readOnly" : true - }, - "name" : { - "type" : "string", - "description" : "The name of the item." - }, - "description" : { - "type" : "string", - "description" : "A description of the item." - }, - "bucketIdentifier" : { - "type" : "string", - "description" : "The identifier of the bucket this items belongs to. This cannot be changed after the item is created." - }, - "bucketName" : { - "type" : "string", - "description" : "The name of the bucket this items belongs to.", - "readOnly" : true - }, - "createdTimestamp" : { - "type" : "integer", - "format" : "int64", - "description" : "The timestamp of when the item was created, as milliseconds since epoch.", - "readOnly" : true, - "minimum" : 1 - }, - "modifiedTimestamp" : { - "type" : "integer", - "format" : "int64", - "description" : "The timestamp of when the item was last modified, as milliseconds since epoch.", - "readOnly" : true, - "minimum" : 1 - }, - "type" : { - "type" : "string", - "description" : "The type of item.", - "enum" : [ "Flow", "Bundle" ] - }, - "permissions" : { - "description" : "The access that the current user has to the bucket containing this item.", - "readOnly" : true, - "$ref" : "#/definitions/Permissions" - }, - "versionCount" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of versions of this flow.", - "readOnly" : true, - "minimum" : 0 - }, - "revision" : { - "description" : "The revision of this entity used for optimistic-locking during updates.", - "readOnly" : true, - "$ref" : "#/definitions/RevisionInfo" - } - } - }, - "VersionedFlowCoordinates" : { - "type" : "object", - "properties" : { - "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" - }, - "registryUrl" : { - "type" : "string", - "description" : "The URL of the Flow Registry that contains the flow" - }, - "bucketId" : { - "type" : "string", - "description" : "The UUID of the bucket that the flow resides in" - }, - "flowId" : { - "type" : "string", - "description" : "The UUID of the flow" - }, - "version" : { - "type" : "integer", - "format" : "int32", - "description" : "The version of the flow" - }, - "latest" : { - "type" : "boolean", - "description" : "Whether or not these coordinates point to the latest version of the flow" - } - } - }, - "VersionedFlowDifference" : { - "type" : "object", - "properties" : { - "bucketId" : { - "type" : "string", - "description" : "The id of the bucket that the flow is stored in." - }, - "flowId" : { - "type" : "string", - "description" : "The id of the flow that is being examined." - }, - "versionA" : { - "type" : "integer", - "format" : "int32", - "description" : "The earlier version from the diff operation." - }, - "versionB" : { - "type" : "integer", - "format" : "int32", - "description" : "The latter version from the diff operation." - }, - "componentDifferenceGroups" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ComponentDifferenceGroup" - } - } - } - }, - "VersionedFlowSnapshot" : { - "type" : "object", - "required" : [ "flowContents", "snapshotMetadata" ], - "properties" : { - "snapshotMetadata" : { - "description" : "The metadata for this snapshot", - "$ref" : "#/definitions/VersionedFlowSnapshotMetadata" - }, - "flowContents" : { - "description" : "The contents of the versioned flow", - "$ref" : "#/definitions/VersionedProcessGroup" - }, - "externalControllerServices" : { - "type" : "object", - "description" : "The information about controller services that exist outside this versioned flow, but are referenced by components within the versioned flow.", - "additionalProperties" : { - "$ref" : "#/definitions/ExternalControllerServiceReference" - } - }, - "parameterProviders" : { - "type" : "object", - "description" : "Contains basic information about parameter providers referenced in the versioned flow.", - "additionalProperties" : { - "$ref" : "#/definitions/ParameterProviderReference" - } - }, - "parameterContexts" : { - "type" : "object", - "description" : "The parameter contexts referenced by process groups in the flow contents. The mapping is from the name of the context to the context instance, and it is expected that any context in this map is referenced by at least one process group in this flow.", - "additionalProperties" : { - "$ref" : "#/definitions/VersionedParameterContext" - } - }, - "flowEncodingVersion" : { - "type" : "string", - "description" : "The optional encoding version of the flow contents." - }, - "flow" : { - "description" : "The flow this snapshot is for", - "readOnly" : true, - "$ref" : "#/definitions/VersionedFlow" - }, - "bucket" : { - "description" : "The bucket where the flow is located", - "readOnly" : true, - "$ref" : "#/definitions/Bucket" - }, - "latest" : { - "type" : "boolean" - } - } - }, - "VersionedFlowSnapshotMetadata" : { - "type" : "object", - "required" : [ "bucketIdentifier", "flowIdentifier", "version" ], - "properties" : { - "link" : { - "description" : "An WebLink to this entity.", - "readOnly" : true, - "$ref" : "#/definitions/JaxbLink" - }, - "bucketIdentifier" : { - "type" : "string", - "description" : "The identifier of the bucket this snapshot belongs to." - }, - "flowIdentifier" : { - "type" : "string", - "description" : "The identifier of the flow this snapshot belongs to." - }, - "version" : { - "type" : "integer", - "format" : "int32", - "description" : "The version of this snapshot of the flow.", - "minimum" : -1 - }, - "timestamp" : { - "type" : "integer", - "format" : "int64", - "description" : "The timestamp when the flow was saved, as milliseconds since epoch.", - "readOnly" : true, - "minimum" : 1 - }, - "author" : { - "type" : "string", - "description" : "The user that created this snapshot of the flow.", - "readOnly" : true - }, - "comments" : { - "type" : "string", - "description" : "The comments provided by the user when creating the snapshot." - } - } - }, - "VersionedFunnel" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The component's unique identifier" - }, - "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" - }, - "comments" : { - "type" : "string", - "description" : "The user-supplied comments for the component" - }, - "position" : { - "description" : "The component's position on the graph", - "$ref" : "#/definitions/Position" - }, - "componentType" : { - "type" : "string", - "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE", "REPORTING_TASK", "PARAMETER_CONTEXT", "PARAMETER_PROVIDER", "TEMPLATE", "FLOW_REGISTRY_CLIENT" ] - }, - "groupIdentifier" : { - "type" : "string", - "description" : "The ID of the Process Group that this component belongs to" - } - } - }, - "VersionedLabel" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The component's unique identifier" - }, - "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" - }, - "comments" : { - "type" : "string", - "description" : "The user-supplied comments for the component" - }, - "position" : { - "description" : "The component's position on the graph", - "$ref" : "#/definitions/Position" - }, - "label" : { - "type" : "string", - "description" : "The text that appears in the label." - }, - "zIndex" : { - "type" : "integer", - "format" : "int64", - "description" : "The z index of the connection." - }, - "width" : { - "type" : "number", - "format" : "double", - "description" : "The width of the label in pixels when at a 1:1 scale." - }, - "height" : { - "type" : "number", - "format" : "double", - "description" : "The height of the label in pixels when at a 1:1 scale." - }, - "style" : { - "type" : "object", - "description" : "The styles for this label (font-size : 12px, background-color : #eee, etc).", - "additionalProperties" : { - "type" : "string" - } - }, - "componentType" : { - "type" : "string", - "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE", "REPORTING_TASK", "PARAMETER_CONTEXT", "PARAMETER_PROVIDER", "TEMPLATE", "FLOW_REGISTRY_CLIENT" ] - }, - "groupIdentifier" : { - "type" : "string", - "description" : "The ID of the Process Group that this component belongs to" - } - } - }, - "VersionedParameter" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The name of the parameter" - }, - "description" : { - "type" : "string", - "description" : "The description of the param" - }, - "sensitive" : { - "type" : "boolean", - "description" : "Whether or not the parameter value is sensitive" - }, - "provided" : { - "type" : "boolean", - "description" : "Whether or not the parameter value is provided by a ParameterProvider" - }, - "value" : { - "type" : "string", - "description" : "The value of the parameter" - } - } - }, - "VersionedParameterContext" : { - "type" : "object", - "properties" : { - "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" - }, - "comments" : { - "type" : "string", - "description" : "The user-supplied comments for the component" - }, - "position" : { - "description" : "The component's position on the graph", - "$ref" : "#/definitions/Position" - }, - "parameters" : { - "type" : "array", - "description" : "The parameters in the context", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedParameter" - } - }, - "inheritedParameterContexts" : { - "type" : "array", - "description" : "The names of additional parameter contexts from which to inherit parameters", - "items" : { - "type" : "string" - } - }, - "description" : { - "type" : "string", - "description" : "The description of the parameter context" - }, - "parameterProvider" : { - "type" : "string", - "description" : "The identifier of an optional parameter provider" - }, - "parameterGroupName" : { - "type" : "string", - "description" : "The corresponding parameter group name fetched from the parameter provider, if applicable" - }, - "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", "PARAMETER_CONTEXT", "PARAMETER_PROVIDER", "TEMPLATE", "FLOW_REGISTRY_CLIENT" ] - }, - "synchronized" : { - "type" : "boolean", - "description" : "True if the parameter provider is set and the context should receive updates when its parameters are next fetched" - }, - "groupIdentifier" : { - "type" : "string", - "description" : "The ID of the Process Group that this component belongs to" - } - } - }, - "VersionedPort" : { - "type" : "object", - "properties" : { - "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" - }, - "comments" : { - "type" : "string", - "description" : "The user-supplied comments for the component" - }, - "position" : { - "description" : "The component's position on the graph", - "$ref" : "#/definitions/Position" - }, - "type" : { - "type" : "string", - "description" : "The type of port.", - "enum" : [ "INPUT_PORT", "OUTPUT_PORT" ] - }, - "concurrentlySchedulableTaskCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of tasks that should be concurrently scheduled for the port." - }, - "scheduledState" : { - "type" : "string", - "description" : "The scheduled state of the component", - "enum" : [ "ENABLED", "DISABLED", "RUNNING" ] - }, - "allowRemoteAccess" : { - "type" : "boolean", - "description" : "Whether or not this port allows remote access for site-to-site" - }, - "componentType" : { - "type" : "string", - "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE", "REPORTING_TASK", "PARAMETER_CONTEXT", "PARAMETER_PROVIDER", "TEMPLATE", "FLOW_REGISTRY_CLIENT" ] - }, - "groupIdentifier" : { - "type" : "string", - "description" : "The ID of the Process Group that this component belongs to" - } - } - }, - "VersionedProcessGroup" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The component's unique identifier" - }, - "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" - }, - "comments" : { - "type" : "string", - "description" : "The user-supplied comments for the component" - }, - "position" : { - "description" : "The component's position on the graph", - "$ref" : "#/definitions/Position" - }, - "processGroups" : { - "type" : "array", - "description" : "The child Process Groups", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedProcessGroup" - } - }, - "remoteProcessGroups" : { - "type" : "array", - "description" : "The Remote Process Groups", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedRemoteProcessGroup" - } - }, - "processors" : { - "type" : "array", - "description" : "The Processors", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedProcessor" - } - }, - "inputPorts" : { - "type" : "array", - "description" : "The Input Ports", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedPort" - } - }, - "outputPorts" : { - "type" : "array", - "description" : "The Output Ports", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedPort" - } - }, - "connections" : { - "type" : "array", - "description" : "The Connections", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedConnection" - } - }, - "labels" : { - "type" : "array", - "description" : "The Labels", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedLabel" - } - }, - "funnels" : { - "type" : "array", - "description" : "The Funnels", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedFunnel" - } - }, - "controllerServices" : { - "type" : "array", - "description" : "The Controller Services", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedControllerService" - } - }, - "versionedFlowCoordinates" : { - "description" : "The coordinates where the remote flow is stored, or null if the Process Group is not directly under Version Control", - "$ref" : "#/definitions/VersionedFlowCoordinates" - }, - "variables" : { - "type" : "object", - "description" : "The Variables in the Variable Registry for this Process Group (not including any ancestor or descendant Process Groups)", - "additionalProperties" : { - "type" : "string" - } - }, - "parameterContextName" : { - "type" : "string", - "description" : "The name of the parameter context used by this process group" - }, - "defaultFlowFileExpiration" : { - "type" : "string", - "description" : "The default FlowFile Expiration for this Process Group." - }, - "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." - }, - "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." - }, - "logFileSuffix" : { - "type" : "string", - "description" : "The log file suffix for this Process Group for dedicated logging." - }, - "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", "PARAMETER_CONTEXT", "PARAMETER_PROVIDER", "TEMPLATE", "FLOW_REGISTRY_CLIENT" ] - }, - "flowFileConcurrency" : { - "type" : "string", - "description" : "The configured FlowFile Concurrency for the Process Group" - }, - "flowFileOutboundPolicy" : { - "type" : "string", - "description" : "The FlowFile Outbound Policy for the Process Group" - }, - "groupIdentifier" : { - "type" : "string", - "description" : "The ID of the Process Group that this component belongs to" - } - } - }, - "VersionedProcessor" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The component's unique identifier" - }, - "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" - }, - "comments" : { - "type" : "string", - "description" : "The user-supplied comments for the component" - }, - "position" : { - "description" : "The component's position on the graph", - "$ref" : "#/definitions/Position" - }, - "type" : { - "type" : "string", - "description" : "The type of the extension component" - }, - "bundle" : { - "description" : "Information about the bundle from which the component came", - "$ref" : "#/definitions/Bundle" - }, - "properties" : { - "type" : "object", - "description" : "The properties for the component. Properties whose value is not set will only contain the property name.", - "additionalProperties" : { - "type" : "string" - } - }, - "propertyDescriptors" : { - "type" : "object", - "description" : "The property descriptors for the component.", - "additionalProperties" : { - "$ref" : "#/definitions/VersionedPropertyDescriptor" - } - }, - "style" : { - "type" : "object", - "description" : "Stylistic data for rendering in a UI", - "additionalProperties" : { - "type" : "string" - } - }, - "annotationData" : { - "type" : "string", - "description" : "The annotation data for the processor used to relay configuration between a custom UI and the procesosr." - }, - "schedulingPeriod" : { - "type" : "string", - "description" : "The frequency with which to schedule the processor. The format of the value will depend on th value of schedulingStrategy." - }, - "schedulingStrategy" : { - "type" : "string", - "description" : "Indicates whether the processor should be scheduled to run in event or timer driven mode." - }, - "executionNode" : { - "type" : "string", - "description" : "Indicates the node where the process will execute." - }, - "penaltyDuration" : { - "type" : "string", - "description" : "The amout of time that is used when the process penalizes a flowfile." - }, - "yieldDuration" : { - "type" : "string", - "description" : "The amount of time that must elapse before this processor is scheduled again after yielding." - }, - "bulletinLevel" : { - "type" : "string", - "description" : "The level at which the processor will report bulletins." - }, - "runDurationMillis" : { - "type" : "integer", - "format" : "int64", - "description" : "The run duration for the processor in milliseconds." - }, - "concurrentlySchedulableTaskCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of tasks that should be concurrently schedule for the processor. If the processor doesn't allow parallol processing then any positive input will be ignored." - }, - "autoTerminatedRelationships" : { - "type" : "array", - "description" : "The names of all relationships that cause a flow file to be terminated if the relationship is not connected elsewhere. This property differs from the 'isAutoTerminate' property of the RelationshipDTO in that the RelationshipDTO is meant to depict the current configuration, whereas this property can be set in a DTO when updating a Processor in order to change which Relationships should be auto-terminated.", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - }, - "scheduledState" : { - "type" : "string", - "description" : "The scheduled state of the component", - "enum" : [ "ENABLED", "DISABLED", "RUNNING" ] - }, - "retryCount" : { - "type" : "integer", - "format" : "int32", - "description" : "Overall number of retries." - }, - "retriedRelationships" : { - "type" : "array", - "description" : "All the relationships should be retried.", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - }, - "backoffMechanism" : { - "type" : "string", - "description" : "Determines whether the FlowFile should be penalized or the processor should be yielded between retries.", - "enum" : [ "PENALIZE_FLOWFILE", "YIELD_PROCESSOR" ] - }, - "maxBackoffPeriod" : { - "type" : "string", - "description" : "Maximum amount of time to be waited during a retry period." - }, - "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", "PARAMETER_CONTEXT", "PARAMETER_PROVIDER", "TEMPLATE", "FLOW_REGISTRY_CLIENT" ] - }, - "groupIdentifier" : { - "type" : "string", - "description" : "The ID of the Process Group that this component belongs to" - } - } - }, - "VersionedPropertyDescriptor" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The name of the property" - }, - "displayName" : { - "type" : "string", - "description" : "The display name of the property" - }, - "identifiesControllerService" : { - "type" : "boolean", - "description" : "Whether or not the property provides the identifier of a Controller Service" - }, - "sensitive" : { - "type" : "boolean", - "description" : "Whether or not the property is considered sensitive" - }, - "resourceDefinition" : { - "description" : "Returns the Resource Definition that defines which type(s) of resource(s) this property references, if any", - "$ref" : "#/definitions/VersionedResourceDefinition" - } - } - }, - "VersionedRemoteGroupPort" : { - "type" : "object", - "properties" : { - "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" - }, - "comments" : { - "type" : "string", - "description" : "The user-supplied comments for the component" - }, - "position" : { - "description" : "The component's position on the graph", - "$ref" : "#/definitions/Position" - }, - "remoteGroupId" : { - "type" : "string", - "description" : "The id of the remote process group that the port resides in." - }, - "concurrentlySchedulableTaskCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of task that may transmit flowfiles to the target port concurrently." - }, - "useCompression" : { - "type" : "boolean", - "description" : "Whether the flowfiles are compressed when sent to the target port." - }, - "batchSize" : { - "description" : "The batch settings for data transmission.", - "$ref" : "#/definitions/BatchSize" - }, - "componentType" : { - "type" : "string", - "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE", "REPORTING_TASK", "PARAMETER_CONTEXT", "PARAMETER_PROVIDER", "TEMPLATE", "FLOW_REGISTRY_CLIENT" ] - }, - "targetId" : { - "type" : "string", - "description" : "The ID of the port on the target NiFi instance" - }, - "scheduledState" : { - "type" : "string", - "description" : "The scheduled state of the component", - "enum" : [ "ENABLED", "DISABLED", "RUNNING" ] - }, - "groupIdentifier" : { - "type" : "string", - "description" : "The ID of the Process Group that this component belongs to" - } - } - }, - "VersionedRemoteProcessGroup" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The component's unique identifier" - }, - "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" - }, - "comments" : { - "type" : "string", - "description" : "The user-supplied comments for the component" - }, - "position" : { - "description" : "The component's position on the graph", - "$ref" : "#/definitions/Position" - }, - "targetUri" : { - "type" : "string", - "description" : "[DEPRECATED] The target URI of the remote process group. If target uri is not set, but uris are set, then returns the first uri in the uris. If neither target uri nor uris are set, then returns null." - }, - "targetUris" : { - "type" : "string", - "description" : "The target URIs of the remote process group. If target uris is not set but target uri is set, then returns the single target uri. If neither target uris nor target uri is set, then returns null." - }, - "communicationsTimeout" : { - "type" : "string", - "description" : "The time period used for the timeout when communicating with the target." - }, - "yieldDuration" : { - "type" : "string", - "description" : "When yielding, this amount of time must elapse before the remote process group is scheduled again." - }, - "transportProtocol" : { - "type" : "string", - "description" : "The Transport Protocol that is used for Site-to-Site communications", - "enum" : [ "RAW", "HTTP" ] - }, - "localNetworkInterface" : { - "type" : "string", - "description" : "The local network interface to send/receive data. If not specified, any local address is used. If clustered, all nodes must have an interface with this identifier." - }, - "proxyHost" : { - "type" : "string" - }, - "proxyPort" : { - "type" : "integer", - "format" : "int32" - }, - "proxyUser" : { - "type" : "string" - }, - "proxyPassword" : { - "type" : "string" - }, - "inputPorts" : { - "type" : "array", - "description" : "A Set of Input Ports that can be connected to, in order to send data to the remote NiFi instance", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedRemoteGroupPort" - } - }, - "outputPorts" : { - "type" : "array", - "description" : "A Set of Output Ports that can be connected to, in order to pull data from the remote NiFi instance", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedRemoteGroupPort" - } - }, - "componentType" : { - "type" : "string", - "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE", "REPORTING_TASK", "PARAMETER_CONTEXT", "PARAMETER_PROVIDER", "TEMPLATE", "FLOW_REGISTRY_CLIENT" ] - }, - "groupIdentifier" : { - "type" : "string", - "description" : "The ID of the Process Group that this component belongs to" - } - } - }, - "VersionedResourceDefinition" : { - "type" : "object", - "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", - "uniqueItems" : true, - "items" : { - "type" : "string", - "enum" : [ "FILE", "DIRECTORY", "TEXT", "URL" ] - } - } - } - } - } -} \ No newline at end of file diff --git a/resources/client_gen/api_defs/registry-1.27.0.json b/resources/client_gen/api_defs/registry-1.27.0.json deleted file mode 100644 index 2a1b9a03..00000000 --- a/resources/client_gen/api_defs/registry-1.27.0.json +++ /dev/null @@ -1,7129 +0,0 @@ -{ - "swagger" : "2.0", - "info" : { - "description" : "The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components.", - "version" : "1.27.0", - "title" : "Apache NiFi Registry REST API", - "termsOfService" : "As described in the license", - "contact" : { - "name" : "Apache NiFi Registry", - "url" : "https://nifi.apache.org", - "email" : "dev@nifi.apache.org" - }, - "license" : { - "name" : "Apache 2.0 License", - "url" : "https://www.apache.org/licenses/LICENSE-2.0.html" - } - }, - "basePath" : "/nifi-registry-api", - "tags" : [ { - "name" : "about", - "description" : "Retrieves the version information for this NiFi Registry." - }, { - "name" : "access", - "description" : "Endpoints for obtaining an access token or checking access status." - }, { - "name" : "bucket bundles", - "description" : "Create extension bundles scoped to an existing bucket in the registry. " - }, { - "name" : "bucket flows", - "description" : "Create flows scoped to an existing bucket in the registry." - }, { - "name" : "buckets", - "description" : "Create named buckets in the registry to store NiFi objects such flows and extensions. Search for and retrieve existing buckets." - }, { - "name" : "bundles", - "description" : "Gets metadata about extension bundles and their versions. " - }, { - "name" : "config", - "description" : "Retrieves the configuration for this NiFi Registry." - }, { - "name" : "extension repository", - "description" : "Interact with extension bundles via the hierarchy of bucket/group/artifact/version. " - }, { - "name" : "extensions", - "description" : "Find and retrieve extensions. " - }, { - "name" : "flows", - "description" : "Gets metadata about flows." - }, { - "name" : "items", - "description" : "Retrieve items across all buckets for which the user is authorized." - }, { - "name" : "policies", - "description" : "Endpoint for managing access policies." - }, { - "name" : "tenants", - "description" : "Endpoint for managing users and user groups." - } ], - "schemes" : [ "http", "https" ], - "paths" : { - "/about" : { - "get" : { - "tags" : [ "about" ], - "summary" : "Get version", - "description" : "Gets the NiFi Registry version.", - "operationId" : "getVersion", - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/RegistryAbout" - } - } - }, - "security" : [ { - "Authorization" : [ ] - } ] - } - }, - "/access" : { - "get" : { - "tags" : [ "access" ], - "summary" : "Get access status", - "description" : "Returns the current client's authenticated identity and permissions to top-level resources", - "operationId" : "getAccessStatus", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/CurrentUser" - } - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid. The NiFi Registry might be running unsecured." - } - }, - "security" : [ { - "Authorization" : [ ] - } ] - } - }, - "/access/logout" : { - "delete" : { - "tags" : [ "access" ], - "summary" : "Performs a logout for other providers that have been issued a JWT.", - "description" : "\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "logout", - "consumes" : [ "*/*" ], - "produces" : [ "*/*" ], - "responses" : { - "200" : { - "description" : "User was logged out successfully." - }, - "401" : { - "description" : "Authentication token provided was empty or not in the correct JWT format." - }, - "500" : { - "description" : "Client failed to log out." - } - } - } - }, - "/access/logout/complete" : { - "get" : { - "tags" : [ "access" ], - "summary" : "Completes the logout sequence.", - "description" : "\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "logoutComplete", - "consumes" : [ "*/*" ], - "produces" : [ "*/*" ], - "responses" : { - "200" : { - "description" : "User was logged out successfully." - }, - "401" : { - "description" : "Authentication token provided was empty or not in the correct JWT format." - }, - "500" : { - "description" : "Client failed to log out." - } - } - } - }, - "/access/oidc/callback" : { - "get" : { - "tags" : [ "access" ], - "summary" : "Redirect/callback URI for processing the result of the OpenId Connect login sequence.", - "description" : "\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "oidcCallback", - "consumes" : [ "*/*" ], - "produces" : [ "*/*" ], - "responses" : { - "default" : { - "description" : "successful operation" - } - } - } - }, - "/access/oidc/exchange" : { - "post" : { - "tags" : [ "access" ], - "summary" : "Retrieves a JWT following a successful login sequence using the configured OpenId Connect provider.", - "description" : "\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "oidcExchange", - "consumes" : [ "*/*" ], - "produces" : [ "text/plain" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - } - } - } - }, - "/access/oidc/logout" : { - "get" : { - "tags" : [ "access" ], - "summary" : "Performs a logout in the OpenId Provider.", - "description" : "\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "oidcLogout", - "consumes" : [ "*/*" ], - "produces" : [ "*/*" ], - "responses" : { - "default" : { - "description" : "successful operation" - } - } - } - }, - "/access/oidc/logout/callback" : { - "get" : { - "tags" : [ "access" ], - "summary" : "Redirect/callback URI for processing the result of the OpenId Connect logout sequence.", - "description" : "\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "oidcLogoutCallback", - "consumes" : [ "*/*" ], - "produces" : [ "*/*" ], - "responses" : { - "default" : { - "description" : "successful operation" - } - } - } - }, - "/access/oidc/request" : { - "get" : { - "tags" : [ "access" ], - "summary" : "Initiates a request to authenticate through the configured OpenId Connect provider.", - "description" : "\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "oidcRequest", - "consumes" : [ "*/*" ], - "produces" : [ "*/*" ], - "responses" : { - "default" : { - "description" : "successful operation" - } - } - } - }, - "/access/token" : { - "post" : { - "tags" : [ "access" ], - "summary" : "Create token trying all providers", - "description" : "Creates a token for accessing the REST API via auto-detected method of verifying client identity claim credentials. The token returned is formatted as a JSON Web Token (JWT). The token is base64 encoded and comprised of three parts. The header, the body, and the signature. The expiration of the token is a contained within the body. The token can be used in the Authorization header in the format 'Authorization: Bearer '.", - "operationId" : "createAccessTokenByTryingAllProviders", - "consumes" : [ "*/*" ], - "produces" : [ "text/plain" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid. The NiFi Registry may not be configured to support login with username/password." - }, - "500" : { - "description" : "NiFi Registry was unable to complete the request because an unexpected error occurred." - } - } - } - }, - "/access/token/identity-provider" : { - "post" : { - "tags" : [ "access" ], - "summary" : "Create token using identity provider", - "description" : "Creates a token for accessing the REST API via a custom identity provider. The user credentials must be passed in a format understood by the custom identity provider, e.g., a third-party auth token in an HTTP header. The exact format of the user credentials expected by the custom identity provider can be discovered by 'GET /access/token/identity-provider/usage'. The token returned is formatted as a JSON Web Token (JWT). The token is base64 encoded and comprised of three parts. The header, the body, and the signature. The expiration of the token is a contained within the body. The token can be used in the Authorization header in the format 'Authorization: Bearer '.", - "operationId" : "createAccessTokenUsingIdentityProviderCredentials", - "consumes" : [ "*/*" ], - "produces" : [ "text/plain" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid. The NiFi Registry may not be configured to support login with customized credentials." - }, - "500" : { - "description" : "NiFi Registry was unable to complete the request because an unexpected error occurred." - } - } - } - }, - "/access/token/identity-provider/test" : { - "post" : { - "tags" : [ "access" ], - "summary" : "Test identity provider", - "description" : "Tests the format of the credentials against this identity provider without preforming authentication on the credentials to validate them. The user credentials should be passed in a format understood by the custom identity provider as defined by 'GET /access/token/identity-provider/usage'.", - "operationId" : "testIdentityProviderRecognizesCredentialsFormat", - "consumes" : [ "*/*" ], - "produces" : [ "text/plain" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "The format of the credentials were not recognized by the currently configured identity provider." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid. The NiFi Registry may not be configured to support login with customized credentials." - }, - "500" : { - "description" : "NiFi Registry was unable to complete the request because an unexpected error occurred." - } - } - } - }, - "/access/token/identity-provider/usage" : { - "get" : { - "tags" : [ "access" ], - "summary" : "Get identity provider usage", - "description" : "Provides a description of how the currently configured identity provider expects credentials to be passed to POST /access/token/identity-provider", - "operationId" : "getIdentityProviderUsageInstructions", - "consumes" : [ "*/*" ], - "produces" : [ "text/plain" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid. The NiFi Registry may not be configured to support login with customized credentials." - }, - "500" : { - "description" : "NiFi Registry was unable to complete the request because an unexpected error occurred." - } - } - } - }, - "/access/token/kerberos" : { - "post" : { - "tags" : [ "access" ], - "summary" : "Create token using kerberos", - "description" : "Creates a token for accessing the REST API via Kerberos Service Tickets or SPNEGO Tokens (which includes Kerberos Service Tickets). The token returned is formatted as a JSON Web Token (JWT). The token is base64 encoded and comprised of three parts. The header, the body, and the signature. The expiration of the token is a contained within the body. The token can be used in the Authorization header in the format 'Authorization: Bearer '.", - "operationId" : "createAccessTokenUsingKerberosTicket", - "consumes" : [ "*/*" ], - "produces" : [ "text/plain" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid. The NiFi Registry may not be configured to support login Kerberos credentials." - }, - "500" : { - "description" : "NiFi Registry was unable to complete the request because an unexpected error occurred." - } - } - } - }, - "/access/token/login" : { - "post" : { - "tags" : [ "access" ], - "summary" : "Create token using basic auth", - "description" : "Creates a token for accessing the REST API via username/password. The user credentials must be passed in standard HTTP Basic Auth format. That is: 'Authorization: Basic ', where is the base64 encoded value of ':'. The token returned is formatted as a JSON Web Token (JWT). The token is base64 encoded and comprised of three parts. The header, the body, and the signature. The expiration of the token is a contained within the body. The token can be used in the Authorization header in the format 'Authorization: Bearer '.", - "operationId" : "createAccessTokenUsingBasicAuthCredentials", - "consumes" : [ "*/*" ], - "produces" : [ "text/plain" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid. The NiFi Registry may not be configured to support login with username/password." - }, - "500" : { - "description" : "NiFi Registry was unable to complete the request because an unexpected error occurred." - } - }, - "security" : [ { - "BasicAuth" : [ ] - } ] - } - }, - "/buckets" : { - "get" : { - "tags" : [ "buckets" ], - "summary" : "Get all buckets", - "description" : "The returned list will include only buckets for which the user is authorized.If the user is not authorized for any buckets, this returns an empty list.", - "operationId" : "getBuckets", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/Bucket" - } - } - }, - "401" : { - "description" : "Client could not be authenticated." - } - }, - "security" : [ { - "Authorization" : [ ] - } ] - }, - "post" : { - "tags" : [ "buckets" ], - "summary" : "Create bucket", - "description" : "", - "operationId" : "createBucket", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The bucket to create", - "required" : true, - "schema" : { - "$ref" : "#/definitions/Bucket" - } - }, { - "name" : "preserveSourceProperties", - "in" : "query", - "description" : "Whether source properties like identifier should be kept", - "required" : false, - "type" : "boolean" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/Bucket" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets", - "action" : "write" - } - } - }, - "/buckets/fields" : { - "get" : { - "tags" : [ "buckets" ], - "summary" : "Get bucket fields", - "description" : "Retrieves bucket field names for searching or sorting on buckets.", - "operationId" : "getAvailableBucketFields", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/Fields" - } - } - }, - "security" : [ { - "Authorization" : [ ] - } ] - } - }, - "/buckets/{bucketId}" : { - "get" : { - "tags" : [ "buckets" ], - "summary" : "Get bucket", - "description" : "Gets the bucket with the given id.", - "operationId" : "getBucket", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketId", - "in" : "path", - "description" : "The bucket identifier", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/Bucket" - } - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - }, - "put" : { - "tags" : [ "buckets" ], - "summary" : "Update bucket", - "description" : "Updates the bucket with the given id.", - "operationId" : "updateBucket", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketId", - "in" : "path", - "description" : "The bucket identifier", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The updated bucket", - "required" : true, - "schema" : { - "$ref" : "#/definitions/Bucket" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/Bucket" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "write" - } - }, - "delete" : { - "tags" : [ "buckets" ], - "summary" : "Delete bucket", - "description" : "Deletes the bucket with the given id, along with all objects stored in the bucket", - "operationId" : "deleteBucket", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The version is used to verify the client is working with the latest version of the entity.", - "required" : true, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "bucketId", - "in" : "path", - "description" : "The bucket identifier", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/Bucket" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "delete" - } - } - }, - "/buckets/{bucketId}/bundles" : { - "get" : { - "tags" : [ "bucket bundles" ], - "summary" : "Get extension bundles by bucket", - "description" : "\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getExtensionBundles", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketId", - "in" : "path", - "description" : "The bucket identifier", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/ExtensionBundle" - } - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/buckets/{bucketId}/bundles/{bundleType}" : { - "post" : { - "tags" : [ "bucket bundles" ], - "summary" : "Create extension bundle version", - "description" : "Creates a version of an extension bundle by uploading a binary artifact. If an extension bundle already exists in the given bucket with the same group id and artifact id as that of the bundle being uploaded, then it will be added as a new version to the existing bundle. If an extension bundle does not already exist in the given bucket with the same group id and artifact id, then a new extension bundle will be created and this version will be added to the new bundle. Client's may optionally supply a SHA-256 in hex format through the multi-part form field 'sha256'. If supplied, then this value will be compared against the SHA-256 computed by the server, and the bundle will be rejected if the values do not match. If not supplied, the bundle will be accepted, but will be marked to indicate that the client did not supply a SHA-256 during creation. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "createExtensionBundleVersion", - "consumes" : [ "multipart/form-data" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketId", - "in" : "path", - "description" : "The bucket identifier", - "required" : true, - "type" : "string" - }, { - "name" : "bundleType", - "in" : "path", - "description" : "The type of the bundle", - "required" : true, - "type" : "string", - "enum" : [ "nifi-nar", "minifi-cpp" ] - }, { - "name" : "file", - "in" : "formData", - "description" : "The binary content of the bundle file being uploaded.", - "required" : true, - "type" : "file" - }, { - "name" : "sha256", - "in" : "formData", - "description" : "Optional sha256 of the provided bundle", - "required" : false, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/BundleVersion" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "write" - } - } - }, - "/buckets/{bucketId}/flows" : { - "get" : { - "tags" : [ "bucket flows" ], - "summary" : "Get bucket flows", - "description" : "Retrieves all flows in the given bucket.", - "operationId" : "getFlows", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketId", - "in" : "path", - "description" : "The bucket identifier", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/VersionedFlow" - } - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - }, - "post" : { - "tags" : [ "bucket flows" ], - "summary" : "Create flow", - "description" : "Creates a flow in the given bucket. The flow id is created by the server and populated in the returned entity.", - "operationId" : "createFlow", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketId", - "in" : "path", - "description" : "The bucket identifier", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The details of the flow to create.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/VersionedFlow" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlow" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "write" - } - } - }, - "/buckets/{bucketId}/flows/{flowId}" : { - "get" : { - "tags" : [ "bucket flows" ], - "summary" : "Get bucket flow", - "description" : "Retrieves the flow with the given id in the given bucket.", - "operationId" : "getFlow", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketId", - "in" : "path", - "description" : "The bucket identifier", - "required" : true, - "type" : "string" - }, { - "name" : "flowId", - "in" : "path", - "description" : "The flow identifier", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlow" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - }, - "put" : { - "tags" : [ "bucket flows" ], - "summary" : "Update bucket flow", - "description" : "Updates the flow with the given id in the given bucket.", - "operationId" : "updateFlow", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketId", - "in" : "path", - "description" : "The bucket identifier", - "required" : true, - "type" : "string" - }, { - "name" : "flowId", - "in" : "path", - "description" : "The flow identifier", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The updated flow", - "required" : true, - "schema" : { - "$ref" : "#/definitions/VersionedFlow" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlow" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "write" - } - }, - "delete" : { - "tags" : [ "bucket flows" ], - "summary" : "Delete bucket flow", - "description" : "Deletes a flow, including all saved versions of that flow.", - "operationId" : "deleteFlow", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The version is used to verify the client is working with the latest version of the entity.", - "required" : true, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "bucketId", - "in" : "path", - "description" : "The bucket identifier", - "required" : true, - "type" : "string" - }, { - "name" : "flowId", - "in" : "path", - "description" : "The flow identifier", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlow" - } - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "delete" - } - } - }, - "/buckets/{bucketId}/flows/{flowId}/diff/{versionA}/{versionB}" : { - "get" : { - "tags" : [ "bucket flows" ], - "summary" : "Get bucket flow diff", - "description" : "Computes the differences between two given versions of a flow.", - "operationId" : "getFlowDiff", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketId", - "in" : "path", - "description" : "The bucket identifier", - "required" : true, - "type" : "string" - }, { - "name" : "flowId", - "in" : "path", - "description" : "The flow identifier", - "required" : true, - "type" : "string" - }, { - "name" : "versionA", - "in" : "path", - "description" : "The first version number", - "required" : true, - "type" : "integer", - "pattern" : "\\d+", - "format" : "int32" - }, { - "name" : "versionB", - "in" : "path", - "description" : "The second version number", - "required" : true, - "type" : "integer", - "pattern" : "\\d+", - "format" : "int32" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlowDifference" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/buckets/{bucketId}/flows/{flowId}/versions" : { - "get" : { - "tags" : [ "bucket flows" ], - "summary" : "Get bucket flow versions", - "description" : "Gets summary information for all versions of a flow. Versions are ordered newest->oldest.", - "operationId" : "getFlowVersions", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketId", - "in" : "path", - "description" : "The bucket identifier", - "required" : true, - "type" : "string" - }, { - "name" : "flowId", - "in" : "path", - "description" : "The flow identifier", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/VersionedFlowSnapshotMetadata" - } - } - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - }, - "post" : { - "tags" : [ "bucket flows" ], - "summary" : "Create flow version", - "description" : "Creates the next version of a flow. The version number of the object being created must be the next available version integer. Flow versions are immutable after they are created.", - "operationId" : "createFlowVersion", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketId", - "in" : "path", - "description" : "The bucket identifier", - "required" : true, - "type" : "string" - }, { - "name" : "flowId", - "in" : "path", - "description" : "The flow identifier", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The new versioned flow snapshot.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/VersionedFlowSnapshot" - } - }, { - "name" : "preserveSourceProperties", - "in" : "query", - "description" : "Whether source properties like author should be kept", - "required" : false, - "type" : "boolean" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlowSnapshot" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "write" - } - } - }, - "/buckets/{bucketId}/flows/{flowId}/versions/import" : { - "post" : { - "tags" : [ "bucket flows" ], - "summary" : "Import flow version", - "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", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketId", - "in" : "path", - "description" : "The bucket identifier", - "required" : true, - "type" : "string" - }, { - "name" : "flowId", - "in" : "path", - "description" : "The flow identifier", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "file", - "required" : false, - "schema" : { - "$ref" : "#/definitions/VersionedFlowSnapshot" - } - }, { - "name" : "Comments", - "in" : "header", - "required" : false, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlowSnapshot" - } - }, - "201" : { - "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." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "write" - } - } - }, - "/buckets/{bucketId}/flows/{flowId}/versions/latest" : { - "get" : { - "tags" : [ "bucket flows" ], - "summary" : "Get latest bucket flow version content", - "description" : "Gets the latest version of a flow, including the metadata and content of the flow.", - "operationId" : "getLatestFlowVersion", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketId", - "in" : "path", - "description" : "The bucket identifier", - "required" : true, - "type" : "string" - }, { - "name" : "flowId", - "in" : "path", - "description" : "The flow identifier", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlowSnapshot" - } - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/buckets/{bucketId}/flows/{flowId}/versions/latest/metadata" : { - "get" : { - "tags" : [ "bucket flows" ], - "summary" : "Get latest bucket flow version metadata", - "description" : "Gets the metadata for the latest version of a flow.", - "operationId" : "getLatestFlowVersionMetadata", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketId", - "in" : "path", - "description" : "The bucket identifier", - "required" : true, - "type" : "string" - }, { - "name" : "flowId", - "in" : "path", - "description" : "The flow identifier", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlowSnapshotMetadata" - } - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/buckets/{bucketId}/flows/{flowId}/versions/{versionNumber}" : { - "get" : { - "tags" : [ "bucket flows" ], - "summary" : "Get bucket flow version", - "description" : "Gets the given version of a flow, including the metadata and content for the version.", - "operationId" : "getFlowVersion", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketId", - "in" : "path", - "description" : "The bucket identifier", - "required" : true, - "type" : "string" - }, { - "name" : "flowId", - "in" : "path", - "description" : "The flow identifier", - "required" : true, - "type" : "string" - }, { - "name" : "versionNumber", - "in" : "path", - "description" : "The version number", - "required" : true, - "type" : "integer", - "pattern" : "\\d+", - "format" : "int32" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlowSnapshot" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/buckets/{bucketId}/flows/{flowId}/versions/{versionNumber}/export" : { - "get" : { - "tags" : [ "bucket flows" ], - "summary" : "Exports specified bucket flow version content", - "description" : "Exports the specified version of a flow, including the metadata and content of the flow.", - "operationId" : "exportVersionedFlow", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketId", - "in" : "path", - "description" : "The bucket identifier", - "required" : true, - "type" : "string" - }, { - "name" : "flowId", - "in" : "path", - "description" : "The flow identifier", - "required" : true, - "type" : "string" - }, { - "name" : "versionNumber", - "in" : "path", - "description" : "The version number", - "required" : true, - "type" : "integer", - "pattern" : "\\d+", - "format" : "int32" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlowSnapshot" - } - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/bundles" : { - "get" : { - "tags" : [ "bundles" ], - "summary" : "Get all bundles", - "description" : "Gets the metadata for all bundles across all authorized buckets with optional filters applied. The returned results will include only items from buckets for which the user is authorized. If the user is not authorized to any buckets, an empty list will be returned. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getBundles", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketName", - "in" : "query", - "description" : "Optional bucket name to filter results. The value may be an exact match, or a wildcard, such as 'My Bucket%' to select all bundles where the bucket name starts with 'My Bucket'.", - "required" : false, - "type" : "string" - }, { - "name" : "groupId", - "in" : "query", - "description" : "Optional groupId to filter results. The value may be an exact match, or a wildcard, such as 'com.%' to select all bundles where the groupId starts with 'com.'.", - "required" : false, - "type" : "string" - }, { - "name" : "artifactId", - "in" : "query", - "description" : "Optional artifactId to filter results. The value may be an exact match, or a wildcard, such as 'nifi-%' to select all bundles where the artifactId starts with 'nifi-'.", - "required" : false, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/ExtensionBundle" - } - } - }, - "401" : { - "description" : "Client could not be authenticated." - } - }, - "security" : [ { - "Authorization" : [ ] - } ] - } - }, - "/bundles/versions" : { - "get" : { - "tags" : [ "bundles" ], - "summary" : "Get all bundle versions", - "description" : "Gets the metadata about extension bundle versions across all authorized buckets with optional filters applied. If the user is not authorized to any buckets, an empty list will be returned. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getBundleVersions", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "groupId", - "in" : "query", - "description" : "Optional groupId to filter results. The value may be an exact match, or a wildcard, such as 'com.%' to select all bundle versions where the groupId starts with 'com.'.", - "required" : false, - "type" : "string" - }, { - "name" : "artifactId", - "in" : "query", - "description" : "Optional artifactId to filter results. The value may be an exact match, or a wildcard, such as 'nifi-%' to select all bundle versions where the artifactId starts with 'nifi-'.", - "required" : false, - "type" : "string" - }, { - "name" : "version", - "in" : "query", - "description" : "Optional version to filter results. The value maye be an exact match, or a wildcard, such as '1.0.%' to select all bundle versions where the version starts with '1.0.'.", - "required" : false, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/BundleVersionMetadata" - } - } - }, - "401" : { - "description" : "Client could not be authenticated." - } - }, - "security" : [ { - "Authorization" : [ ] - } ] - } - }, - "/bundles/{bundleId}" : { - "get" : { - "tags" : [ "bundles" ], - "summary" : "Get bundle", - "description" : "Gets the metadata about an extension bundle. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "globalGetExtensionBundle", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bundleId", - "in" : "path", - "description" : "The extension bundle identifier", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ExtensionBundle" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - }, - "delete" : { - "tags" : [ "bundles" ], - "summary" : "Delete bundle", - "description" : "Deletes the given extension bundle and all of it's versions. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "globalDeleteExtensionBundle", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bundleId", - "in" : "path", - "description" : "The extension bundle identifier", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ExtensionBundle" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "write" - } - } - }, - "/bundles/{bundleId}/versions" : { - "get" : { - "tags" : [ "bundles" ], - "summary" : "Get bundle versions", - "description" : "Gets the metadata for the versions of the given extension bundle. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "globalGetBundleVersions", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bundleId", - "in" : "path", - "description" : "The extension bundle identifier", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/BundleVersionMetadata" - } - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/bundles/{bundleId}/versions/{version}" : { - "get" : { - "tags" : [ "bundles" ], - "summary" : "Get bundle version", - "description" : "Gets the descriptor for the given version of the given extension bundle. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "globalGetBundleVersion", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bundleId", - "in" : "path", - "description" : "The extension bundle identifier", - "required" : true, - "type" : "string" - }, { - "name" : "version", - "in" : "path", - "description" : "The version of the bundle", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/BundleVersion" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - }, - "delete" : { - "tags" : [ "bundles" ], - "summary" : "Delete bundle version", - "description" : "Deletes the given extension bundle version and it's associated binary content. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "globalDeleteBundleVersion", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bundleId", - "in" : "path", - "description" : "The extension bundle identifier", - "required" : true, - "type" : "string" - }, { - "name" : "version", - "in" : "path", - "description" : "The version of the bundle", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/BundleVersion" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "write" - } - } - }, - "/bundles/{bundleId}/versions/{version}/content" : { - "get" : { - "tags" : [ "bundles" ], - "summary" : "Get bundle version content", - "description" : "Gets the binary content for the given version of the given extension bundle. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "globalGetBundleVersionContent", - "consumes" : [ "*/*" ], - "produces" : [ "application/octet-stream" ], - "parameters" : [ { - "name" : "bundleId", - "in" : "path", - "description" : "The extension bundle identifier", - "required" : true, - "type" : "string" - }, { - "name" : "version", - "in" : "path", - "description" : "The version of the bundle", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "type" : "string", - "format" : "byte" - } - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/bundles/{bundleId}/versions/{version}/extensions" : { - "get" : { - "tags" : [ "bundles" ], - "summary" : "Get bundle version extensions", - "description" : "Gets the metadata about the extensions in the given extension bundle version. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "globalGetBundleVersionExtensions", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bundleId", - "in" : "path", - "description" : "The extension bundle identifier", - "required" : true, - "type" : "string" - }, { - "name" : "version", - "in" : "path", - "description" : "The version of the bundle", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/ExtensionMetadata" - } - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/bundles/{bundleId}/versions/{version}/extensions/{name}" : { - "get" : { - "tags" : [ "bundles" ], - "summary" : "Get bundle version extension", - "description" : "Gets the metadata about the extension with the given name in the given extension bundle version. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "globalGetBundleVersionExtension", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bundleId", - "in" : "path", - "description" : "The extension bundle identifier", - "required" : true, - "type" : "string" - }, { - "name" : "version", - "in" : "path", - "description" : "The version of the bundle", - "required" : true, - "type" : "string" - }, { - "name" : "name", - "in" : "path", - "description" : "The fully qualified name of the extension", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/Extension" - } - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/bundles/{bundleId}/versions/{version}/extensions/{name}/docs" : { - "get" : { - "tags" : [ "bundles" ], - "summary" : "Get bundle version extension docs", - "description" : "Gets the documentation for the given extension in the given extension bundle version. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getBundleVersionExtensionDocs", - "consumes" : [ "*/*" ], - "produces" : [ "text/html" ], - "parameters" : [ { - "name" : "bundleId", - "in" : "path", - "description" : "The extension bundle identifier", - "required" : true, - "type" : "string" - }, { - "name" : "version", - "in" : "path", - "description" : "The version of the bundle", - "required" : true, - "type" : "string" - }, { - "name" : "name", - "in" : "path", - "description" : "The fully qualified name of the extension", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/bundles/{bundleId}/versions/{version}/extensions/{name}/docs/additional-details" : { - "get" : { - "tags" : [ "bundles" ], - "summary" : "Get bundle version extension docs details", - "description" : "Gets the additional details documentation for the given extension in the given extension bundle version. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getBundleVersionExtensionAdditionalDetailsDocs", - "consumes" : [ "*/*" ], - "produces" : [ "text/html" ], - "parameters" : [ { - "name" : "bundleId", - "in" : "path", - "description" : "The extension bundle identifier", - "required" : true, - "type" : "string" - }, { - "name" : "version", - "in" : "path", - "description" : "The version of the bundle", - "required" : true, - "type" : "string" - }, { - "name" : "name", - "in" : "path", - "description" : "The fully qualified name of the extension", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/config" : { - "get" : { - "tags" : [ "config" ], - "summary" : "Get configration", - "description" : "Gets the NiFi Registry configurations.", - "operationId" : "getConfiguration", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/RegistryConfiguration" - } - }, - "401" : { - "description" : "Client could not be authenticated." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/policies,/tenants", - "action" : "read" - } - } - }, - "/extension-repository" : { - "get" : { - "tags" : [ "extension repository" ], - "summary" : "Get extension repo buckets", - "description" : "Gets the names of the buckets the current user is authorized for in order to browse the repo by bucket. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getExtensionRepoBuckets", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/ExtensionRepoBucket" - } - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ] - } - }, - "/extension-repository/{bucketName}" : { - "get" : { - "tags" : [ "extension repository" ], - "summary" : "Get extension repo groups", - "description" : "Gets the groups in the extension repository in the given bucket. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getExtensionRepoGroups", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketName", - "in" : "path", - "description" : "The bucket name", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/ExtensionRepoGroup" - } - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/extension-repository/{bucketName}/{groupId}" : { - "get" : { - "tags" : [ "extension repository" ], - "summary" : "Get extension repo artifacts", - "description" : "Gets the artifacts in the extension repository in the given bucket and group. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getExtensionRepoArtifacts", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketName", - "in" : "path", - "description" : "The bucket name", - "required" : true, - "type" : "string" - }, { - "name" : "groupId", - "in" : "path", - "description" : "The group id", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/ExtensionRepoArtifact" - } - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/extension-repository/{bucketName}/{groupId}/{artifactId}" : { - "get" : { - "tags" : [ "extension repository" ], - "summary" : "Get extension repo versions", - "description" : "Gets the versions in the extension repository for the given bucket, group, and artifact. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getExtensionRepoVersions", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketName", - "in" : "path", - "description" : "The bucket name", - "required" : true, - "type" : "string" - }, { - "name" : "groupId", - "in" : "path", - "description" : "The group identifier", - "required" : true, - "type" : "string" - }, { - "name" : "artifactId", - "in" : "path", - "description" : "The artifact identifier", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/ExtensionRepoVersionSummary" - } - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/extension-repository/{bucketName}/{groupId}/{artifactId}/{version}" : { - "get" : { - "tags" : [ "extension repository" ], - "summary" : "Get extension repo version", - "description" : "Gets information about the version in the given bucket, group, and artifact. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getExtensionRepoVersion", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketName", - "in" : "path", - "description" : "The bucket name", - "required" : true, - "type" : "string" - }, { - "name" : "groupId", - "in" : "path", - "description" : "The group identifier", - "required" : true, - "type" : "string" - }, { - "name" : "artifactId", - "in" : "path", - "description" : "The artifact identifier", - "required" : true, - "type" : "string" - }, { - "name" : "version", - "in" : "path", - "description" : "The version", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ExtensionRepoVersion" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/extension-repository/{bucketName}/{groupId}/{artifactId}/{version}/content" : { - "get" : { - "tags" : [ "extension repository" ], - "summary" : "Get extension repo version content", - "description" : "Gets the binary content of the bundle with the given bucket, group, artifact, and version. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getExtensionRepoVersionContent", - "consumes" : [ "*/*" ], - "produces" : [ "application/octet-stream" ], - "parameters" : [ { - "name" : "bucketName", - "in" : "path", - "description" : "The bucket name", - "required" : true, - "type" : "string" - }, { - "name" : "groupId", - "in" : "path", - "description" : "The group identifier", - "required" : true, - "type" : "string" - }, { - "name" : "artifactId", - "in" : "path", - "description" : "The artifact identifier", - "required" : true, - "type" : "string" - }, { - "name" : "version", - "in" : "path", - "description" : "The version", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "type" : "string", - "format" : "byte" - } - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/extension-repository/{bucketName}/{groupId}/{artifactId}/{version}/extensions" : { - "get" : { - "tags" : [ "extension repository" ], - "summary" : "Get extension repo extensions", - "description" : "Gets information about the extensions in the given bucket, group, artifact, and version. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getExtensionRepoVersionExtensions", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketName", - "in" : "path", - "description" : "The bucket name", - "required" : true, - "type" : "string" - }, { - "name" : "groupId", - "in" : "path", - "description" : "The group identifier", - "required" : true, - "type" : "string" - }, { - "name" : "artifactId", - "in" : "path", - "description" : "The artifact identifier", - "required" : true, - "type" : "string" - }, { - "name" : "version", - "in" : "path", - "description" : "The version", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/ExtensionMetadata" - } - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/extension-repository/{bucketName}/{groupId}/{artifactId}/{version}/extensions/{name}" : { - "get" : { - "tags" : [ "extension repository" ], - "summary" : "Get extension repo extension", - "description" : "Gets information about the extension with the given name in the given bucket, group, artifact, and version. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getExtensionRepoVersionExtension", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketName", - "in" : "path", - "description" : "The bucket name", - "required" : true, - "type" : "string" - }, { - "name" : "groupId", - "in" : "path", - "description" : "The group identifier", - "required" : true, - "type" : "string" - }, { - "name" : "artifactId", - "in" : "path", - "description" : "The artifact identifier", - "required" : true, - "type" : "string" - }, { - "name" : "version", - "in" : "path", - "description" : "The version", - "required" : true, - "type" : "string" - }, { - "name" : "name", - "in" : "path", - "description" : "The fully qualified name of the extension", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/Extension" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/extension-repository/{bucketName}/{groupId}/{artifactId}/{version}/extensions/{name}/docs" : { - "get" : { - "tags" : [ "extension repository" ], - "summary" : "Get extension repo extension docs", - "description" : "Gets the documentation for the extension with the given name in the given bucket, group, artifact, and version. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getExtensionRepoVersionExtensionDocs", - "consumes" : [ "*/*" ], - "produces" : [ "text/html" ], - "parameters" : [ { - "name" : "bucketName", - "in" : "path", - "description" : "The bucket name", - "required" : true, - "type" : "string" - }, { - "name" : "groupId", - "in" : "path", - "description" : "The group identifier", - "required" : true, - "type" : "string" - }, { - "name" : "artifactId", - "in" : "path", - "description" : "The artifact identifier", - "required" : true, - "type" : "string" - }, { - "name" : "version", - "in" : "path", - "description" : "The version", - "required" : true, - "type" : "string" - }, { - "name" : "name", - "in" : "path", - "description" : "The fully qualified name of the extension", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/extension-repository/{bucketName}/{groupId}/{artifactId}/{version}/extensions/{name}/docs/additional-details" : { - "get" : { - "tags" : [ "extension repository" ], - "summary" : "Get extension repo extension details", - "description" : "Gets the additional details documentation for the extension with the given name in the given bucket, group, artifact, and version. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getExtensionRepoVersionExtensionAdditionalDetailsDocs", - "consumes" : [ "*/*" ], - "produces" : [ "text/html" ], - "parameters" : [ { - "name" : "bucketName", - "in" : "path", - "description" : "The bucket name", - "required" : true, - "type" : "string" - }, { - "name" : "groupId", - "in" : "path", - "description" : "The group identifier", - "required" : true, - "type" : "string" - }, { - "name" : "artifactId", - "in" : "path", - "description" : "The artifact identifier", - "required" : true, - "type" : "string" - }, { - "name" : "version", - "in" : "path", - "description" : "The version", - "required" : true, - "type" : "string" - }, { - "name" : "name", - "in" : "path", - "description" : "The fully qualified name of the extension", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/extension-repository/{bucketName}/{groupId}/{artifactId}/{version}/sha256" : { - "get" : { - "tags" : [ "extension repository" ], - "summary" : "Get extension repo version checksum", - "description" : "Gets the hex representation of the SHA-256 digest for the binary content of the bundle with the given bucket, group, artifact, and version.\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getExtensionRepoVersionSha256", - "consumes" : [ "*/*" ], - "produces" : [ "text/plain" ], - "parameters" : [ { - "name" : "bucketName", - "in" : "path", - "description" : "The bucket name", - "required" : true, - "type" : "string" - }, { - "name" : "groupId", - "in" : "path", - "description" : "The group identifier", - "required" : true, - "type" : "string" - }, { - "name" : "artifactId", - "in" : "path", - "description" : "The artifact identifier", - "required" : true, - "type" : "string" - }, { - "name" : "version", - "in" : "path", - "description" : "The version", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/extension-repository/{groupId}/{artifactId}/{version}/sha256" : { - "get" : { - "tags" : [ "extension repository" ], - "summary" : "Get global extension repo version checksum", - "description" : "Gets the hex representation of the SHA-256 digest for the binary content with the given bucket, group, artifact, and version. Since the same group-artifact-version can exist in multiple buckets, this will return the checksum of the first one returned. This will be consistent since the checksum must be the same when existing in multiple buckets. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getGlobalExtensionRepoVersionSha256", - "consumes" : [ "*/*" ], - "produces" : [ "text/plain" ], - "parameters" : [ { - "name" : "groupId", - "in" : "path", - "description" : "The group identifier", - "required" : true, - "type" : "string" - }, { - "name" : "artifactId", - "in" : "path", - "description" : "The artifact identifier", - "required" : true, - "type" : "string" - }, { - "name" : "version", - "in" : "path", - "description" : "The version", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ] - } - }, - "/extensions" : { - "get" : { - "tags" : [ "extensions" ], - "summary" : "Get all extensions", - "description" : "Gets the metadata for all extensions that match the filter params and are part of bundles located in buckets the current user is authorized for. If the user is not authorized to any buckets, an empty result set will be returned.\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getExtensions", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bundleType", - "in" : "query", - "description" : "The type of bundles to return", - "required" : false, - "type" : "string", - "enum" : [ "nifi-nar", "minifi-cpp" ] - }, { - "name" : "extensionType", - "in" : "query", - "description" : "The type of extensions to return", - "required" : false, - "type" : "string", - "enum" : [ "PROCESSOR", "CONTROLLER_SERVICE", "REPORTING_TASK" ] - }, { - "name" : "tag", - "in" : "query", - "description" : "The tags to filter on, will be used in an OR statement", - "required" : false, - "type" : "array", - "items" : { - "type" : "string" - }, - "collectionFormat" : "multi" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ExtensionMetadataContainer" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ] - } - }, - "/extensions/provided-service-api" : { - "get" : { - "tags" : [ "extensions" ], - "summary" : "Get extensions providing service API", - "description" : "Gets the metadata for extensions that provide the specified API and are part of bundles located in buckets the current user is authorized for. If the user is not authorized to any buckets, an empty result set will be returned.\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getExtensionsProvidingServiceAPI", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "className", - "in" : "query", - "description" : "The name of the service API class", - "required" : true, - "type" : "string" - }, { - "name" : "groupId", - "in" : "query", - "description" : "The groupId of the bundle containing the service API class", - "required" : true, - "type" : "string" - }, { - "name" : "artifactId", - "in" : "query", - "description" : "The artifactId of the bundle containing the service API class", - "required" : true, - "type" : "string" - }, { - "name" : "version", - "in" : "query", - "description" : "The version of the bundle containing the service API class", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ExtensionMetadataContainer" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ] - } - }, - "/extensions/tags" : { - "get" : { - "tags" : [ "extensions" ], - "summary" : "Get extension tags", - "description" : "Gets all the extension tags known to this NiFi Registry instance, along with the number of extensions that have the given tag.\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getTags", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/TagCount" - } - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ] - } - }, - "/flows/fields" : { - "get" : { - "tags" : [ "flows" ], - "summary" : "Get flow fields", - "description" : "Retrieves the flow field names that can be used for searching or sorting on flows.", - "operationId" : "getAvailableFlowFields", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/Fields" - } - } - }, - "security" : [ { - "Authorization" : [ ] - } ] - } - }, - "/flows/{flowId}" : { - "get" : { - "tags" : [ "flows" ], - "summary" : "Get flow", - "description" : "Gets a flow by id.", - "operationId" : "globalGetFlow", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "flowId", - "in" : "path", - "description" : "The flow identifier", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlow" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/flows/{flowId}/versions" : { - "get" : { - "tags" : [ "flows" ], - "summary" : "Get flow versions", - "description" : "Gets summary information for all versions of a given flow. Versions are ordered newest->oldest.", - "operationId" : "globalGetFlowVersions", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "flowId", - "in" : "path", - "description" : "The flow identifier", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/VersionedFlowSnapshotMetadata" - } - } - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/flows/{flowId}/versions/latest" : { - "get" : { - "tags" : [ "flows" ], - "summary" : "Get latest flow version", - "description" : "Gets the latest version of a flow, including metadata and flow content.", - "operationId" : "globalGetLatestFlowVersion", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "flowId", - "in" : "path", - "description" : "The flow identifier", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlowSnapshot" - } - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/flows/{flowId}/versions/latest/metadata" : { - "get" : { - "tags" : [ "flows" ], - "summary" : "Get latest flow version metadata", - "description" : "Gets the metadata for the latest version of a flow.", - "operationId" : "globalGetLatestFlowVersionMetadata", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "flowId", - "in" : "path", - "description" : "The flow identifier", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlowSnapshotMetadata" - } - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/flows/{flowId}/versions/{versionNumber}" : { - "get" : { - "tags" : [ "flows" ], - "summary" : "Get flow version", - "description" : "Gets the given version of a flow, including metadata and flow content.", - "operationId" : "globalGetFlowVersion", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "flowId", - "in" : "path", - "description" : "The flow identifier", - "required" : true, - "type" : "string" - }, { - "name" : "versionNumber", - "in" : "path", - "description" : "The version number", - "required" : true, - "type" : "integer", - "pattern" : "\\d+", - "format" : "int32" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlowSnapshot" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/items" : { - "get" : { - "tags" : [ "items" ], - "summary" : "Get all items", - "description" : "Get items across all buckets. The returned items will include only items from buckets for which the user is authorized. If the user is not authorized to any buckets, an empty list will be returned.", - "operationId" : "getItems", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/BucketItem" - } - } - }, - "401" : { - "description" : "Client could not be authenticated." - } - }, - "security" : [ { - "Authorization" : [ ] - } ] - } - }, - "/items/fields" : { - "get" : { - "tags" : [ "items" ], - "summary" : "Get item fields", - "description" : "Retrieves the item field names for searching or sorting on bucket items.", - "operationId" : "getAvailableBucketItemFields", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/Fields" - } - } - }, - "security" : [ { - "Authorization" : [ ] - } ] - } - }, - "/items/{bucketId}" : { - "get" : { - "tags" : [ "items" ], - "summary" : "Get bucket items", - "description" : "Gets the items located in the given bucket.", - "operationId" : "getItemsInBucket", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketId", - "in" : "path", - "description" : "The bucket identifier", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/BucketItem" - } - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/policies" : { - "get" : { - "tags" : [ "policies" ], - "summary" : "Get all access policies", - "description" : "", - "operationId" : "getAccessPolicies", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/AccessPolicy" - } - } - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/policies", - "action" : "read" - } - }, - "post" : { - "tags" : [ "policies" ], - "summary" : "Create access policy", - "description" : "", - "operationId" : "createAccessPolicy", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The access policy configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/AccessPolicy" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/AccessPolicy" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid. The NiFi Registry might not be configured to use a ConfigurableAccessPolicyProvider." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/policies", - "action" : "write" - } - } - }, - "/policies/resources" : { - "get" : { - "tags" : [ "policies" ], - "summary" : "Get available resources", - "description" : "Gets the available resources that support access/authorization policies", - "operationId" : "getResources", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/Resource" - } - } - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/policies", - "action" : "read" - } - } - }, - "/policies/{action}/{resource}" : { - "get" : { - "tags" : [ "policies" ], - "summary" : "Get access policy for resource", - "description" : "Gets an access policy for the specified action and resource", - "operationId" : "getAccessPolicyForResource", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "action", - "in" : "path", - "description" : "The request action.", - "required" : true, - "type" : "string", - "enum" : [ "read", "write", "delete" ] - }, { - "name" : "resource", - "in" : "path", - "description" : "The resource of the policy.", - "required" : true, - "type" : "string", - "pattern" : ".+" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/AccessPolicy" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/policies", - "action" : "read" - } - } - }, - "/policies/{id}" : { - "get" : { - "tags" : [ "policies" ], - "summary" : "Get access policy", - "description" : "", - "operationId" : "getAccessPolicy", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The access policy id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/AccessPolicy" - } - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/policies", - "action" : "read" - } - }, - "put" : { - "tags" : [ "policies" ], - "summary" : "Update access policy", - "description" : "", - "operationId" : "updateAccessPolicy", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The access policy id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The access policy configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/AccessPolicy" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/AccessPolicy" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid. The NiFi Registry might not be configured to use a ConfigurableAccessPolicyProvider." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/policies", - "action" : "write" - } - }, - "delete" : { - "tags" : [ "policies" ], - "summary" : "Delete access policy", - "description" : "", - "operationId" : "removeAccessPolicy", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The version is used to verify the client is working with the latest version of the entity.", - "required" : true, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The access policy id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/AccessPolicy" - } - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid. The NiFi Registry might not be configured to use a ConfigurableAccessPolicyProvider." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/policies", - "action" : "delete" - } - } - }, - "/tenants/user-groups" : { - "get" : { - "tags" : [ "tenants" ], - "summary" : "Get user groups", - "description" : "\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getUserGroups", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/UserGroup" - } - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/tenants", - "action" : "read" - } - }, - "post" : { - "tags" : [ "tenants" ], - "summary" : "Create user group", - "description" : "\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "createUserGroup", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The user group configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/UserGroup" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/UserGroup" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/tenants", - "action" : "write" - } - } - }, - "/tenants/user-groups/{id}" : { - "get" : { - "tags" : [ "tenants" ], - "summary" : "Get user group", - "description" : "\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getUserGroup", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The user group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/UserGroup" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/tenants", - "action" : "read" - } - }, - "put" : { - "tags" : [ "tenants" ], - "summary" : "Update user group", - "description" : "\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "updateUserGroup", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The user group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The user group configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/UserGroup" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/UserGroup" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/tenants", - "action" : "write" - } - }, - "delete" : { - "tags" : [ "tenants" ], - "summary" : "Delete user group", - "description" : "\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "removeUserGroup", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The version is used to verify the client is working with the latest version of the entity.", - "required" : true, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The user group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/UserGroup" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/tenants", - "action" : "delete" - } - } - }, - "/tenants/users" : { - "get" : { - "tags" : [ "tenants" ], - "summary" : "Get all users", - "description" : "\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getUsers", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/User" - } - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/tenants", - "action" : "read" - } - }, - "post" : { - "tags" : [ "tenants" ], - "summary" : "Create user", - "description" : "\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "createUser", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The user configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/User" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/User" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/tenants", - "action" : "write" - } - } - }, - "/tenants/users/{id}" : { - "get" : { - "tags" : [ "tenants" ], - "summary" : "Get user", - "description" : "\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getUser", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The user id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/User" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/tenants", - "action" : "read" - } - }, - "put" : { - "tags" : [ "tenants" ], - "summary" : "Update user", - "description" : "\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "updateUser", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The user id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The user configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/User" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/User" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/tenants", - "action" : "write" - } - }, - "delete" : { - "tags" : [ "tenants" ], - "summary" : "Delete user", - "description" : "\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "removeUser", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The version is used to verify the client is working with the latest version of the entity.", - "required" : true, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The user id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/User" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/tenants", - "action" : "delete" - } - } - } - }, - "securityDefinitions" : { - "Authorization" : { - "description" : "NiFi Registry Auth Token (JWT)", - "type" : "apiKey", - "name" : "Authorization", - "in" : "header" - }, - "BasicAuth" : { - "description" : "HTTP Basic Auth", - "type" : "basic" - } - }, - "definitions" : { - "AccessPolicy" : { - "type" : "object", - "required" : [ "action", "resource" ], - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The id of the policy. Set by server at creation time.", - "readOnly" : true - }, - "resource" : { - "type" : "string", - "description" : "The resource for this access policy." - }, - "action" : { - "type" : "string", - "description" : "The action associated with this access policy.", - "enum" : [ "read", "write", "delete" ] - }, - "configurable" : { - "type" : "boolean", - "description" : "Indicates if this access policy is configurable, based on which Authorizer has been configured to manage it.", - "readOnly" : true - }, - "revision" : { - "description" : "The revision of this entity used for optimistic-locking during updates.", - "readOnly" : true, - "$ref" : "#/definitions/RevisionInfo" - }, - "users" : { - "type" : "array", - "description" : "The set of user IDs associated with this access policy.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/Tenant" - } - }, - "userGroups" : { - "type" : "array", - "description" : "The set of user group IDs associated with this access policy.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/Tenant" - } - } - } - }, - "AccessPolicySummary" : { - "type" : "object", - "required" : [ "action", "resource" ], - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The id of the policy. Set by server at creation time.", - "readOnly" : true - }, - "resource" : { - "type" : "string", - "description" : "The resource for this access policy." - }, - "action" : { - "type" : "string", - "description" : "The action associated with this access policy.", - "enum" : [ "read", "write", "delete" ] - }, - "configurable" : { - "type" : "boolean", - "description" : "Indicates if this access policy is configurable, based on which Authorizer has been configured to manage it.", - "readOnly" : true - }, - "revision" : { - "description" : "The revision of this entity used for optimistic-locking during updates.", - "readOnly" : true, - "$ref" : "#/definitions/RevisionInfo" - } - } - }, - "AllowableValue" : { - "type" : "object", - "properties" : { - "value" : { - "type" : "string", - "description" : "The value of the allowable value" - }, - "displayName" : { - "type" : "string", - "description" : "The display name of the allowable value" - }, - "description" : { - "type" : "string", - "description" : "The description of the allowable value" - } - } - }, - "Attribute" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The name of the attribute" - }, - "description" : { - "type" : "string", - "description" : "The description of the attribute" - } - } - }, - "BatchSize" : { - "type" : "object", - "properties" : { - "count" : { - "type" : "integer", - "format" : "int32", - "description" : "Preferred number of flow files to include in a transaction." - }, - "size" : { - "type" : "string", - "description" : "Preferred number of bytes to include in a transaction." - }, - "duration" : { - "type" : "string", - "description" : "Preferred amount of time that a transaction should span." - } - } - }, - "Bucket" : { - "type" : "object", - "required" : [ "name" ], - "properties" : { - "link" : { - "description" : "An WebLink to this entity.", - "readOnly" : true, - "$ref" : "#/definitions/JaxbLink" - }, - "identifier" : { - "type" : "string", - "description" : "An ID to uniquely identify this object.", - "readOnly" : true - }, - "name" : { - "type" : "string", - "description" : "The name of the bucket." - }, - "createdTimestamp" : { - "type" : "integer", - "format" : "int64", - "description" : "The timestamp of when the bucket was first created. This is set by the server at creation time.", - "readOnly" : true, - "minimum" : 1 - }, - "description" : { - "type" : "string", - "description" : "A description of the bucket." - }, - "allowBundleRedeploy" : { - "type" : "boolean", - "description" : "Indicates if this bucket allows the same version of an extension bundle to be redeployed and thus overwrite the existing artifact. By default this is false." - }, - "allowPublicRead" : { - "type" : "boolean", - "description" : "Indicates if this bucket allows read access to unauthenticated anonymous users" - }, - "permissions" : { - "description" : "The access that the current user has to this bucket.", - "readOnly" : true, - "$ref" : "#/definitions/Permissions" - }, - "revision" : { - "description" : "The revision of this entity used for optimistic-locking during updates.", - "readOnly" : true, - "$ref" : "#/definitions/RevisionInfo" - } - } - }, - "BucketItem" : { - "type" : "object", - "required" : [ "bucketIdentifier", "name", "type" ], - "properties" : { - "link" : { - "description" : "An WebLink to this entity.", - "readOnly" : true, - "$ref" : "#/definitions/JaxbLink" - }, - "identifier" : { - "type" : "string", - "description" : "An ID to uniquely identify this object.", - "readOnly" : true - }, - "name" : { - "type" : "string", - "description" : "The name of the item." - }, - "description" : { - "type" : "string", - "description" : "A description of the item." - }, - "bucketIdentifier" : { - "type" : "string", - "description" : "The identifier of the bucket this items belongs to. This cannot be changed after the item is created." - }, - "bucketName" : { - "type" : "string", - "description" : "The name of the bucket this items belongs to.", - "readOnly" : true - }, - "createdTimestamp" : { - "type" : "integer", - "format" : "int64", - "description" : "The timestamp of when the item was created, as milliseconds since epoch.", - "readOnly" : true, - "minimum" : 1 - }, - "modifiedTimestamp" : { - "type" : "integer", - "format" : "int64", - "description" : "The timestamp of when the item was last modified, as milliseconds since epoch.", - "readOnly" : true, - "minimum" : 1 - }, - "type" : { - "type" : "string", - "description" : "The type of item.", - "enum" : [ "Flow", "Bundle" ] - }, - "permissions" : { - "description" : "The access that the current user has to the bucket containing this item.", - "readOnly" : true, - "$ref" : "#/definitions/Permissions" - } - } - }, - "BuildInfo" : { - "type" : "object", - "properties" : { - "buildTool" : { - "type" : "string", - "description" : "The tool used to build the version of the bundle" - }, - "buildFlags" : { - "type" : "string", - "description" : "The flags used to build the version of the bundle" - }, - "buildBranch" : { - "type" : "string", - "description" : "The branch used to build the version of the bundle" - }, - "buildTag" : { - "type" : "string", - "description" : "The tag used to build the version of the bundle" - }, - "buildRevision" : { - "type" : "string", - "description" : "The revision used to build the version of the bundle" - }, - "built" : { - "type" : "integer", - "format" : "int64", - "description" : "The timestamp the version of the bundle was built" - }, - "builtBy" : { - "type" : "string", - "description" : "The identity of the user that performed the build" - } - } - }, - "Bundle" : { - "type" : "object", - "properties" : { - "group" : { - "type" : "string", - "description" : "The group of the bundle" - }, - "artifact" : { - "type" : "string", - "description" : "The artifact of the bundle" - }, - "version" : { - "type" : "string", - "description" : "The version of the bundle" - } - } - }, - "BundleInfo" : { - "type" : "object", - "properties" : { - "bucketId" : { - "type" : "string", - "description" : "The id of the bucket where the bundle is located" - }, - "bucketName" : { - "type" : "string", - "description" : "The name of the bucket where the bundle is located" - }, - "bundleId" : { - "type" : "string", - "description" : "The id of the bundle" - }, - "bundleType" : { - "type" : "string", - "description" : "The type of bundle (i.e. a NiFi NAR vs MiNiFi CPP)", - "enum" : [ "NIFI_NAR", "MINIFI_CPP" ] - }, - "groupId" : { - "type" : "string", - "description" : "The group id of the bundle" - }, - "artifactId" : { - "type" : "string", - "description" : "The artifact id of the bundle" - }, - "version" : { - "type" : "string", - "description" : "The version of the bundle" - }, - "systemApiVersion" : { - "type" : "string", - "description" : "The version of the system API the bundle was built against" - } - } - }, - "BundleVersion" : { - "type" : "object", - "required" : [ "versionMetadata" ], - "properties" : { - "link" : { - "description" : "An WebLink to this entity.", - "readOnly" : true, - "$ref" : "#/definitions/JaxbLink" - }, - "versionMetadata" : { - "description" : "The metadata about this version of the extension bundle", - "$ref" : "#/definitions/BundleVersionMetadata" - }, - "dependencies" : { - "type" : "array", - "description" : "The set of other bundle versions that this version is dependent on", - "readOnly" : true, - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/BundleVersionDependency" - } - }, - "bundle" : { - "description" : "The bundle this version is for", - "readOnly" : true, - "$ref" : "#/definitions/ExtensionBundle" - }, - "bucket" : { - "description" : "The bucket that the extension bundle belongs to", - "$ref" : "#/definitions/Bucket" - }, - "filename" : { - "type" : "string" - } - } - }, - "BundleVersionDependency" : { - "type" : "object", - "properties" : { - "groupId" : { - "type" : "string", - "description" : "The group id of the bundle dependency" - }, - "artifactId" : { - "type" : "string", - "description" : "The artifact id of the bundle dependency" - }, - "version" : { - "type" : "string", - "description" : "The version of the bundle dependency" - } - } - }, - "BundleVersionMetadata" : { - "type" : "object", - "required" : [ "bucketId", "buildInfo", "contentSize", "sha256Supplied" ], - "properties" : { - "link" : { - "description" : "An WebLink to this entity.", - "readOnly" : true, - "$ref" : "#/definitions/JaxbLink" - }, - "id" : { - "type" : "string", - "description" : "The id of this version of the extension bundle" - }, - "bundleId" : { - "type" : "string", - "description" : "The id of the extension bundle this version is for" - }, - "bucketId" : { - "type" : "string", - "description" : "The id of the bucket the extension bundle belongs to" - }, - "groupId" : { - "type" : "string" - }, - "artifactId" : { - "type" : "string" - }, - "version" : { - "type" : "string", - "description" : "The version of the extension bundle" - }, - "timestamp" : { - "type" : "integer", - "format" : "int64", - "description" : "The timestamp of the create date of this version", - "minimum" : 1 - }, - "author" : { - "type" : "string", - "description" : "The identity that created this version" - }, - "description" : { - "type" : "string", - "description" : "The description for this version" - }, - "sha256" : { - "type" : "string", - "description" : "The hex representation of the SHA-256 digest of the binary content for this version" - }, - "sha256Supplied" : { - "type" : "boolean", - "description" : "Whether or not the client supplied a SHA-256 when uploading the bundle" - }, - "contentSize" : { - "type" : "integer", - "format" : "int64", - "description" : "The size of the binary content for this version in bytes", - "minimum" : 0 - }, - "systemApiVersion" : { - "type" : "string", - "description" : "The version of the system API that this bundle version was built against" - }, - "buildInfo" : { - "description" : "The build information about this version", - "$ref" : "#/definitions/BuildInfo" - } - } - }, - "ComponentDifference" : { - "type" : "object", - "properties" : { - "valueA" : { - "type" : "string", - "description" : "The earlier value from the difference." - }, - "valueB" : { - "type" : "string", - "description" : "The newer value from the difference." - }, - "changeDescription" : { - "type" : "string", - "description" : "The description of the change." - }, - "differenceType" : { - "type" : "string", - "description" : "The key to the difference." - }, - "differenceTypeDescription" : { - "type" : "string", - "description" : "The description of the change type." - } - } - }, - "ComponentDifferenceGroup" : { - "type" : "object", - "properties" : { - "componentId" : { - "type" : "string", - "description" : "The id of the component whose changes are grouped together." - }, - "componentName" : { - "type" : "string", - "description" : "The name of the component whose changes are grouped together." - }, - "componentType" : { - "type" : "string", - "description" : "The type of component these changes relate to." - }, - "processGroupId" : { - "type" : "string", - "description" : "The process group id for this component." - }, - "differences" : { - "type" : "array", - "description" : "The list of changes related to this component between the 2 versions.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ComponentDifference" - } - } - } - }, - "ConnectableComponent" : { - "type" : "object", - "required" : [ "groupId", "id", "type" ], - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the connectable component." - }, - "type" : { - "type" : "string", - "description" : "The type of component the connectable is.", - "enum" : [ "PROCESSOR", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "INPUT_PORT", "OUTPUT_PORT", "FUNNEL" ] - }, - "groupId" : { - "type" : "string", - "description" : "The id of the group that the connectable component resides in" - }, - "name" : { - "type" : "string", - "description" : "The name of the connectable component" - }, - "comments" : { - "type" : "string", - "description" : "The comments for the connectable component." - }, - "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" - } - } - }, - "ControllerServiceAPI" : { - "type" : "object", - "properties" : { - "type" : { - "type" : "string", - "description" : "The fully qualified name of the service interface." - }, - "bundle" : { - "description" : "The details of the artifact that bundled this service interface.", - "$ref" : "#/definitions/Bundle" - } - } - }, - "ControllerServiceDefinition" : { - "type" : "object", - "properties" : { - "className" : { - "type" : "string", - "description" : "The class name of the service API" - }, - "groupId" : { - "type" : "string", - "description" : "The group id of the service API" - }, - "artifactId" : { - "type" : "string", - "description" : "The artifact id of the service API" - }, - "version" : { - "type" : "string", - "description" : "The version of the service API" - } - } - }, - "CurrentUser" : { - "type" : "object", - "properties" : { - "identity" : { - "type" : "string", - "description" : "The identity of the current user", - "readOnly" : true - }, - "anonymous" : { - "type" : "boolean", - "description" : "Indicates if the current user is anonymous", - "readOnly" : true - }, - "loginSupported" : { - "type" : "boolean", - "description" : "Indicates if the NiFi Registry instance supports logging in" - }, - "resourcePermissions" : { - "description" : "The access that the current user has to top level resources", - "readOnly" : true, - "$ref" : "#/definitions/ResourcePermissions" - }, - "oidcloginSupported" : { - "type" : "boolean", - "description" : "Indicates if the NiFi Registry instance supports logging in with an OIDC provider" - } - } - }, - "DefaultSchedule" : { - "type" : "object", - "properties" : { - "strategy" : { - "type" : "string", - "description" : "The default scheduling strategy" - }, - "period" : { - "type" : "string", - "description" : "The default scheduling period" - }, - "concurrentTasks" : { - "type" : "string", - "description" : "The default concurrent tasks" - } - } - }, - "DefaultSettings" : { - "type" : "object", - "properties" : { - "yieldDuration" : { - "type" : "string", - "description" : "The default yield duration" - }, - "penaltyDuration" : { - "type" : "string", - "description" : "The default penalty duration" - }, - "bulletinLevel" : { - "type" : "string", - "description" : "The default bulletin level" - } - } - }, - "Dependency" : { - "type" : "object", - "properties" : { - "propertyName" : { - "type" : "string", - "description" : "The name of the dependent property" - }, - "propertyDisplayName" : { - "type" : "string", - "description" : "The display name of the dependent property" - }, - "dependentValues" : { - "description" : "The values of the dependent property that enable the depending property", - "$ref" : "#/definitions/DependentValues" - } - } - }, - "DependentValues" : { - "type" : "object", - "properties" : { - "values" : { - "type" : "array", - "xml" : { - "name" : "dependentValue" - }, - "description" : "The dependent values", - "items" : { - "type" : "string", - "xml" : { - "name" : "dependentValue" - } - } - } - } - }, - "DeprecationNotice" : { - "type" : "object", - "properties" : { - "reason" : { - "type" : "string", - "description" : "The reason for the deprecation" - }, - "alternatives" : { - "type" : "array", - "xml" : { - "wrapped" : true - }, - "description" : "The alternatives to use", - "items" : { - "type" : "string", - "xml" : { - "name" : "alternative" - } - } - } - } - }, - "DynamicProperty" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The description of the dynamic property name" - }, - "value" : { - "type" : "string", - "description" : "The description of the dynamic property value" - }, - "description" : { - "type" : "string", - "description" : "The description of the dynamic property" - }, - "expressionLanguageScope" : { - "type" : "string", - "description" : "The scope of the expression language support", - "enum" : [ "NONE", "VARIABLE_REGISTRY", "FLOWFILE_ATTRIBUTES" ] - }, - "expressionLanguageSupported" : { - "type" : "boolean", - "description" : "Whether or not expression language is supported" - } - } - }, - "DynamicRelationship" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The description of the dynamic relationship name" - }, - "description" : { - "type" : "string", - "description" : "The description of the dynamic relationship" - } - } - }, - "Extension" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The name of the extension" - }, - "type" : { - "type" : "string", - "description" : "The type of the extension", - "enum" : [ "PROCESSOR", "CONTROLLER_SERVICE", "REPORTING_TASK" ] - }, - "deprecationNotice" : { - "description" : "The deprecation notice of the extension", - "$ref" : "#/definitions/DeprecationNotice" - }, - "description" : { - "type" : "string", - "description" : "The description of the extension" - }, - "tags" : { - "type" : "array", - "xml" : { - "wrapped" : true - }, - "description" : "The tags of the extension", - "items" : { - "type" : "string", - "xml" : { - "name" : "tag" - } - } - }, - "properties" : { - "type" : "array", - "xml" : { - "wrapped" : true - }, - "description" : "The properties of the extension", - "items" : { - "xml" : { - "name" : "property" - }, - "$ref" : "#/definitions/Property" - } - }, - "supportsSensitiveDynamicProperties" : { - "type" : "boolean" - }, - "dynamicProperties" : { - "type" : "array", - "xml" : { - "wrapped" : true - }, - "description" : "The dynamic properties of the extension", - "items" : { - "xml" : { - "name" : "dynamicProperty" - }, - "$ref" : "#/definitions/DynamicProperty" - } - }, - "relationships" : { - "type" : "array", - "xml" : { - "wrapped" : true - }, - "description" : "The relationships of the extension", - "items" : { - "xml" : { - "name" : "relationship" - }, - "$ref" : "#/definitions/Relationship" - } - }, - "dynamicRelationship" : { - "description" : "The dynamic relationships of the extension", - "$ref" : "#/definitions/DynamicRelationship" - }, - "readsAttributes" : { - "type" : "array", - "xml" : { - "wrapped" : true - }, - "description" : "The attributes read from flow files by the extension", - "items" : { - "xml" : { - "name" : "readsAttribute" - }, - "$ref" : "#/definitions/Attribute" - } - }, - "writesAttributes" : { - "type" : "array", - "xml" : { - "wrapped" : true - }, - "description" : "The attributes written to flow files by the extension", - "items" : { - "xml" : { - "name" : "writesAttribute" - }, - "$ref" : "#/definitions/Attribute" - } - }, - "stateful" : { - "description" : "The information about how the extension stores state", - "$ref" : "#/definitions/Stateful" - }, - "restricted" : { - "description" : "The restrictions of the extension", - "$ref" : "#/definitions/Restricted" - }, - "inputRequirement" : { - "type" : "string", - "description" : "The input requirement of the extension", - "enum" : [ "INPUT_REQUIRED", "INPUT_ALLOWED", "INPUT_FORBIDDEN" ] - }, - "systemResourceConsiderations" : { - "type" : "array", - "xml" : { - "wrapped" : true - }, - "description" : "The resource considerations of the extension", - "items" : { - "xml" : { - "name" : "systemResourceConsideration" - }, - "$ref" : "#/definitions/SystemResourceConsideration" - } - }, - "seeAlso" : { - "type" : "array", - "xml" : { - "wrapped" : true - }, - "description" : "The names of other extensions to see", - "items" : { - "type" : "string", - "xml" : { - "name" : "see" - } - } - }, - "providedServiceAPIs" : { - "type" : "array", - "xml" : { - "wrapped" : true - }, - "description" : "The service APIs provided by this extension", - "items" : { - "xml" : { - "name" : "providedServiceAPI" - }, - "$ref" : "#/definitions/ProvidedServiceAPI" - } - }, - "defaultSettings" : { - "description" : "The default settings for a processor", - "$ref" : "#/definitions/DefaultSettings" - }, - "defaultSchedule" : { - "description" : "The default schedule for a processor reporting task", - "$ref" : "#/definitions/DefaultSchedule" - }, - "triggerSerially" : { - "type" : "boolean", - "description" : "Indicates that a processor should be triggered serially" - }, - "triggerWhenEmpty" : { - "type" : "boolean", - "description" : "Indicates that a processor should be triggered when the incoming queues are empty" - }, - "triggerWhenAnyDestinationAvailable" : { - "type" : "boolean", - "description" : "Indicates that a processor should be triggered when any destinations have space for flow files" - }, - "supportsBatching" : { - "type" : "boolean", - "description" : "Indicates that a processor supports batching" - }, - "eventDriven" : { - "type" : "boolean", - "description" : "Indicates that a processor supports event driven scheduling" - }, - "primaryNodeOnly" : { - "type" : "boolean", - "description" : "Indicates that a processor should be scheduled only on the primary node" - }, - "sideEffectFree" : { - "type" : "boolean", - "description" : "Indicates that a processor is side effect free" - } - } - }, - "ExtensionBundle" : { - "type" : "object", - "required" : [ "bucketIdentifier", "bundleType", "name", "type" ], - "properties" : { - "link" : { - "description" : "An WebLink to this entity.", - "readOnly" : true, - "$ref" : "#/definitions/JaxbLink" - }, - "identifier" : { - "type" : "string", - "description" : "An ID to uniquely identify this object.", - "readOnly" : true - }, - "name" : { - "type" : "string", - "description" : "The name of the item." - }, - "description" : { - "type" : "string", - "description" : "A description of the item." - }, - "bucketIdentifier" : { - "type" : "string", - "description" : "The identifier of the bucket this items belongs to. This cannot be changed after the item is created." - }, - "bucketName" : { - "type" : "string", - "description" : "The name of the bucket this items belongs to.", - "readOnly" : true - }, - "createdTimestamp" : { - "type" : "integer", - "format" : "int64", - "description" : "The timestamp of when the item was created, as milliseconds since epoch.", - "readOnly" : true, - "minimum" : 1 - }, - "modifiedTimestamp" : { - "type" : "integer", - "format" : "int64", - "description" : "The timestamp of when the item was last modified, as milliseconds since epoch.", - "readOnly" : true, - "minimum" : 1 - }, - "type" : { - "type" : "string", - "description" : "The type of item.", - "enum" : [ "Flow", "Bundle" ] - }, - "permissions" : { - "description" : "The access that the current user has to the bucket containing this item.", - "readOnly" : true, - "$ref" : "#/definitions/Permissions" - }, - "bundleType" : { - "type" : "string", - "description" : "The type of the extension bundle", - "enum" : [ "NIFI_NAR", "MINIFI_CPP" ] - }, - "groupId" : { - "type" : "string", - "description" : "The group id of the extension bundle" - }, - "artifactId" : { - "type" : "string", - "description" : "The artifact id of the extension bundle" - }, - "versionCount" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of versions of this extension bundle.", - "readOnly" : true, - "minimum" : 0 - } - } - }, - "ExtensionFilterParams" : { - "type" : "object", - "properties" : { - "bundleType" : { - "type" : "string", - "description" : "The type of bundle", - "enum" : [ "NIFI_NAR", "MINIFI_CPP" ] - }, - "extensionType" : { - "type" : "string", - "description" : "The type of extension", - "enum" : [ "PROCESSOR", "CONTROLLER_SERVICE", "REPORTING_TASK" ] - }, - "tags" : { - "type" : "array", - "description" : "The tags", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - } - } - }, - "ExtensionMetadata" : { - "type" : "object", - "properties" : { - "link" : { - "description" : "An WebLink to this entity.", - "readOnly" : true, - "$ref" : "#/definitions/JaxbLink" - }, - "name" : { - "type" : "string", - "description" : "The name of the extension" - }, - "displayName" : { - "type" : "string", - "description" : "The display name of the extension" - }, - "type" : { - "type" : "string", - "description" : "The type of the extension", - "enum" : [ "PROCESSOR", "CONTROLLER_SERVICE", "REPORTING_TASK" ] - }, - "description" : { - "type" : "string", - "description" : "The description of the extension" - }, - "deprecationNotice" : { - "description" : "The deprecation notice of the extension", - "$ref" : "#/definitions/DeprecationNotice" - }, - "tags" : { - "type" : "array", - "description" : "The tags of the extension", - "items" : { - "type" : "string" - } - }, - "restricted" : { - "description" : "The restrictions of the extension", - "$ref" : "#/definitions/Restricted" - }, - "providedServiceAPIs" : { - "type" : "array", - "description" : "The service APIs provided by the extension", - "items" : { - "$ref" : "#/definitions/ProvidedServiceAPI" - } - }, - "bundleInfo" : { - "description" : "The information for the bundle where this extension is located", - "$ref" : "#/definitions/BundleInfo" - }, - "hasAdditionalDetails" : { - "type" : "boolean", - "description" : "Whether or not the extension has additional detail documentation" - }, - "linkDocs" : { - "description" : "A WebLink to the documentation for this extension.", - "readOnly" : true, - "$ref" : "#/definitions/JaxbLink" - } - } - }, - "ExtensionMetadataContainer" : { - "type" : "object", - "properties" : { - "numResults" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of extensions in the response" - }, - "filterParams" : { - "description" : "The filter parameters submitted for the request", - "$ref" : "#/definitions/ExtensionFilterParams" - }, - "extensions" : { - "type" : "array", - "description" : "The metadata for the extensions", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ExtensionMetadata" - } - } - } - }, - "ExtensionRepoArtifact" : { - "type" : "object", - "properties" : { - "link" : { - "description" : "An WebLink to this entity.", - "readOnly" : true, - "$ref" : "#/definitions/JaxbLink" - }, - "bucketName" : { - "type" : "string", - "description" : "The bucket name" - }, - "groupId" : { - "type" : "string", - "description" : "The group id" - }, - "artifactId" : { - "type" : "string", - "description" : "The artifact id" - } - } - }, - "ExtensionRepoBucket" : { - "type" : "object", - "properties" : { - "link" : { - "description" : "An WebLink to this entity.", - "readOnly" : true, - "$ref" : "#/definitions/JaxbLink" - }, - "bucketName" : { - "type" : "string", - "description" : "The name of the bucket" - } - } - }, - "ExtensionRepoGroup" : { - "type" : "object", - "properties" : { - "link" : { - "description" : "An WebLink to this entity.", - "readOnly" : true, - "$ref" : "#/definitions/JaxbLink" - }, - "bucketName" : { - "type" : "string", - "description" : "The bucket name" - }, - "groupId" : { - "type" : "string", - "description" : "The group id" - } - } - }, - "ExtensionRepoVersion" : { - "type" : "object", - "properties" : { - "extensionsLink" : { - "description" : "The WebLink to view the metadata about the extensions contained in the extension bundle.", - "readOnly" : true, - "$ref" : "#/definitions/JaxbLink" - }, - "downloadLink" : { - "description" : "The WebLink to download this version of the extension bundle.", - "readOnly" : true, - "$ref" : "#/definitions/JaxbLink" - }, - "sha256Link" : { - "description" : "The WebLink to retrieve the SHA-256 digest for this version of the extension bundle.", - "readOnly" : true, - "$ref" : "#/definitions/JaxbLink" - }, - "sha256Supplied" : { - "description" : "Indicates if the client supplied a SHA-256 when uploading this version of the extension bundle.", - "readOnly" : true, - "$ref" : "#/definitions/JaxbLink" - } - } - }, - "ExtensionRepoVersionSummary" : { - "type" : "object", - "properties" : { - "link" : { - "description" : "An WebLink to this entity.", - "readOnly" : true, - "$ref" : "#/definitions/JaxbLink" - }, - "bucketName" : { - "type" : "string", - "description" : "The bucket name" - }, - "groupId" : { - "type" : "string", - "description" : "The group id" - }, - "artifactId" : { - "type" : "string", - "description" : "The artifact id" - }, - "version" : { - "type" : "string", - "description" : "The version" - }, - "author" : { - "type" : "string", - "description" : "The identity of the user that created this version" - }, - "timestamp" : { - "type" : "integer", - "format" : "int64", - "description" : "The timestamp of when this version was created" - } - } - }, - "ExternalControllerServiceReference" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The identifier of the controller service" - }, - "name" : { - "type" : "string", - "description" : "The name of the controller service" - } - } - }, - "Fields" : { - "type" : "object", - "properties" : { - "fields" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - } - } - }, - "JaxbLink" : { - "type" : "object", - "properties" : { - "href" : { - "type" : "string", - "format" : "uri", - "xml" : { - "attribute" : true - }, - "description" : "The href for the link" - }, - "params" : { - "type" : "object", - "description" : "The params for the link", - "additionalProperties" : { - "type" : "string" - } - } - } - }, - "ParameterProviderReference" : { - "type" : "object", - "properties" : { - "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." - }, - "bundle" : { - "description" : "The details of the artifact that bundled this parameter provider.", - "$ref" : "#/definitions/Bundle" - } - } - }, - "Permissions" : { - "type" : "object", - "properties" : { - "canRead" : { - "type" : "boolean", - "description" : "Indicates whether the user can read a given resource.", - "readOnly" : true - }, - "canWrite" : { - "type" : "boolean", - "description" : "Indicates whether the user can write a given resource.", - "readOnly" : true - }, - "canDelete" : { - "type" : "boolean", - "description" : "Indicates whether the user can delete a given resource.", - "readOnly" : true - } - } - }, - "Position" : { - "type" : "object", - "properties" : { - "x" : { - "type" : "number", - "format" : "double", - "description" : "The x coordinate." - }, - "y" : { - "type" : "number", - "format" : "double", - "description" : "The y coordinate." - } - }, - "description" : "The position of a component on the graph" - }, - "Property" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The name of the property" - }, - "displayName" : { - "type" : "string", - "description" : "The display name" - }, - "description" : { - "type" : "string", - "description" : "The description" - }, - "defaultValue" : { - "type" : "string", - "description" : "The default value" - }, - "controllerServiceDefinition" : { - "description" : "The controller service required by this property, or null if none is required", - "$ref" : "#/definitions/ControllerServiceDefinition" - }, - "allowableValues" : { - "type" : "array", - "xml" : { - "wrapped" : true - }, - "description" : "The allowable values for this property", - "items" : { - "xml" : { - "name" : "allowableValue" - }, - "$ref" : "#/definitions/AllowableValue" - } - }, - "required" : { - "type" : "boolean", - "description" : "Whether or not the property is required" - }, - "sensitive" : { - "type" : "boolean", - "description" : "Whether or not the property is sensitive" - }, - "expressionLanguageSupported" : { - "type" : "boolean", - "description" : "Whether or not expression language is supported" - }, - "expressionLanguageScope" : { - "type" : "string", - "description" : "The scope of expression language support", - "enum" : [ "NONE", "VARIABLE_REGISTRY", "FLOWFILE_ATTRIBUTES" ] - }, - "dynamicallyModifiesClasspath" : { - "type" : "boolean", - "description" : "Whether or not the processor dynamically modifies the classpath" - }, - "dynamic" : { - "type" : "boolean", - "description" : "Whether or not the processor is dynamic" - }, - "dependencies" : { - "type" : "array", - "xml" : { - "wrapped" : true - }, - "description" : "The properties that this property depends on", - "items" : { - "xml" : { - "name" : "dependency" - }, - "$ref" : "#/definitions/Dependency" - } - }, - "resourceDefinition" : { - "description" : "The optional resource definition", - "$ref" : "#/definitions/ResourceDefinition" - } - } - }, - "ProvidedServiceAPI" : { - "type" : "object", - "properties" : { - "className" : { - "type" : "string", - "description" : "The class name of the service API being provided" - }, - "groupId" : { - "type" : "string", - "description" : "The group id of the service API being provided" - }, - "artifactId" : { - "type" : "string", - "description" : "The artifact id of the service API being provided" - }, - "version" : { - "type" : "string", - "description" : "The version of the service API being provided" - } - } - }, - "RegistryAbout" : { - "type" : "object", - "properties" : { - "registryAboutVersion" : { - "type" : "string", - "description" : "The version string for this Nifi Registry", - "readOnly" : true - } - } - }, - "RegistryConfiguration" : { - "type" : "object", - "properties" : { - "supportsManagedAuthorizer" : { - "type" : "boolean", - "description" : "Whether this NiFi Registry supports a managed authorizer. Managed authorizers can visualize users, groups, and policies in the UI.", - "readOnly" : true - }, - "supportsConfigurableAuthorizer" : { - "type" : "boolean", - "description" : "Whether this NiFi Registry supports a configurable authorizer.", - "readOnly" : true - }, - "supportsConfigurableUsersAndGroups" : { - "type" : "boolean", - "description" : "Whether this NiFi Registry supports configurable users and groups.", - "readOnly" : true - } - } - }, - "Relationship" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The name of the relationship" - }, - "description" : { - "type" : "string", - "description" : "The description of the relationship" - }, - "autoTerminated" : { - "type" : "boolean", - "description" : "Whether or not the relationship is auto-terminated by default" - } - } - }, - "Resource" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The identifier of the resource.", - "readOnly" : true - }, - "name" : { - "type" : "string", - "description" : "The name of the resource.", - "readOnly" : true - } - } - }, - "ResourceDefinition" : { - "type" : "object", - "properties" : { - "cardinality" : { - "type" : "string", - "description" : "The cardinality of the resource definition", - "enum" : [ "SINGLE", "MULTIPLE" ] - }, - "resourceTypes" : { - "type" : "array", - "xml" : { - "wrapped" : true - }, - "description" : "The types of resources", - "items" : { - "type" : "string", - "xml" : { - "name" : "resourceType" - }, - "enum" : [ "FILE", "DIRECTORY", "TEXT", "URL" ] - } - } - } - }, - "ResourcePermissions" : { - "type" : "object", - "properties" : { - "buckets" : { - "description" : "The access that the current user has to the top level /buckets resource of this NiFi Registry (i.e., access to all buckets)", - "readOnly" : true, - "$ref" : "#/definitions/Permissions" - }, - "tenants" : { - "description" : "The access that the current user has to the top level /tenants resource of this NiFi Registry", - "readOnly" : true, - "$ref" : "#/definitions/Permissions" - }, - "policies" : { - "description" : "The access that the current user has to the top level /policies resource of this NiFi Registry", - "readOnly" : true, - "$ref" : "#/definitions/Permissions" - }, - "proxy" : { - "description" : "The access that the current user has to the top level /proxy resource of this NiFi Registry", - "readOnly" : true, - "$ref" : "#/definitions/Permissions" - }, - "anyTopLevelResource" : { - "description" : "The access that the current user has to any top level resources (a logical 'OR' of all other values)", - "readOnly" : true, - "$ref" : "#/definitions/Permissions" - } - } - }, - "Restricted" : { - "type" : "object", - "properties" : { - "generalRestrictionExplanation" : { - "type" : "string", - "description" : "The general restriction for the extension, or null if only specific restrictions exist" - }, - "restrictions" : { - "type" : "array", - "xml" : { - "wrapped" : true - }, - "description" : "The specific restrictions", - "items" : { - "xml" : { - "name" : "restriction" - }, - "$ref" : "#/definitions/Restriction" - } - } - } - }, - "Restriction" : { - "type" : "object", - "properties" : { - "requiredPermission" : { - "type" : "string", - "description" : "The permission required for this restriction" - }, - "explanation" : { - "type" : "string", - "description" : "The explanation of this restriction" - } - } - }, - "RevisionInfo" : { - "type" : "object", - "properties" : { - "clientId" : { - "type" : "string", - "description" : "A client identifier used to make a request. By including a client identifier, the API can allow multiple requests without needing the current revision. Due to the asynchronous nature of requests/responses this was implemented to allow the client to make numerous requests without having to wait for the previous response to come back." - }, - "version" : { - "type" : "integer", - "format" : "int64", - "description" : "NiFi Registry employs an optimistic locking strategy where the client must include a revision in their request when performing an update. In a response to a mutable flow request, this field represents the updated base version." - }, - "lastModifier" : { - "type" : "string", - "description" : "The user that last modified the entity.", - "readOnly" : true - } - }, - "description" : "The revision information for an entity managed through the REST API." - }, - "Stateful" : { - "type" : "object", - "properties" : { - "description" : { - "type" : "string", - "description" : "The description for how the extension stores state" - }, - "scopes" : { - "type" : "array", - "xml" : { - "wrapped" : true - }, - "description" : "The scopes used to store state", - "items" : { - "type" : "string", - "xml" : { - "name" : "scope" - }, - "enum" : [ "CLUSTER", "LOCAL" ] - } - } - } - }, - "SystemResourceConsideration" : { - "type" : "object", - "properties" : { - "resource" : { - "type" : "string", - "description" : "The resource to consider" - }, - "description" : { - "type" : "string", - "description" : "The description of how the resource is affected" - } - } - }, - "TagCount" : { - "type" : "object", - "properties" : { - "tag" : { - "type" : "string", - "description" : "The tag label" - }, - "count" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of occurrences of the given tag" - } - } - }, - "Tenant" : { - "type" : "object", - "required" : [ "identity" ], - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The computer-generated identifier of the tenant.", - "readOnly" : true - }, - "identity" : { - "type" : "string", - "description" : "The human-facing identity of the tenant. This can only be changed if the tenant is configurable." - }, - "configurable" : { - "type" : "boolean", - "description" : "Indicates if this tenant is configurable, based on which UserGroupProvider has been configured to manage it.", - "readOnly" : true - }, - "resourcePermissions" : { - "description" : "A summary top-level resource access policies granted to this tenant.", - "readOnly" : true, - "$ref" : "#/definitions/ResourcePermissions" - }, - "accessPolicies" : { - "type" : "array", - "description" : "The access policies granted to this tenant.", - "readOnly" : true, - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/AccessPolicySummary" - } - }, - "revision" : { - "description" : "The revision of this entity used for optimistic-locking during updates.", - "readOnly" : true, - "$ref" : "#/definitions/RevisionInfo" - } - } - }, - "User" : { - "type" : "object", - "required" : [ "identity" ], - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The computer-generated identifier of the tenant.", - "readOnly" : true - }, - "identity" : { - "type" : "string", - "description" : "The human-facing identity of the tenant. This can only be changed if the tenant is configurable." - }, - "configurable" : { - "type" : "boolean", - "description" : "Indicates if this tenant is configurable, based on which UserGroupProvider has been configured to manage it.", - "readOnly" : true - }, - "resourcePermissions" : { - "description" : "A summary top-level resource access policies granted to this tenant.", - "readOnly" : true, - "$ref" : "#/definitions/ResourcePermissions" - }, - "accessPolicies" : { - "type" : "array", - "description" : "The access policies granted to this tenant.", - "readOnly" : true, - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/AccessPolicySummary" - } - }, - "revision" : { - "description" : "The revision of this entity used for optimistic-locking during updates.", - "readOnly" : true, - "$ref" : "#/definitions/RevisionInfo" - }, - "userGroups" : { - "type" : "array", - "description" : "The groups to which the user belongs.", - "readOnly" : true, - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/Tenant" - } - } - } - }, - "UserGroup" : { - "type" : "object", - "required" : [ "identity" ], - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The computer-generated identifier of the tenant.", - "readOnly" : true - }, - "identity" : { - "type" : "string", - "description" : "The human-facing identity of the tenant. This can only be changed if the tenant is configurable." - }, - "configurable" : { - "type" : "boolean", - "description" : "Indicates if this tenant is configurable, based on which UserGroupProvider has been configured to manage it.", - "readOnly" : true - }, - "resourcePermissions" : { - "description" : "A summary top-level resource access policies granted to this tenant.", - "readOnly" : true, - "$ref" : "#/definitions/ResourcePermissions" - }, - "accessPolicies" : { - "type" : "array", - "description" : "The access policies granted to this tenant.", - "readOnly" : true, - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/AccessPolicySummary" - } - }, - "revision" : { - "description" : "The revision of this entity used for optimistic-locking during updates.", - "readOnly" : true, - "$ref" : "#/definitions/RevisionInfo" - }, - "users" : { - "type" : "array", - "description" : "The users that belong to this user group. This can only be changed if this group is configurable.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/Tenant" - } - } - } - }, - "VersionedConnection" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The component's unique identifier" - }, - "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" - }, - "comments" : { - "type" : "string", - "description" : "The user-supplied comments for the component" - }, - "position" : { - "description" : "The component's position on the graph", - "$ref" : "#/definitions/Position" - }, - "source" : { - "description" : "The source of the connection.", - "$ref" : "#/definitions/ConnectableComponent" - }, - "destination" : { - "description" : "The destination of the connection.", - "$ref" : "#/definitions/ConnectableComponent" - }, - "labelIndex" : { - "type" : "integer", - "format" : "int32", - "description" : "The index of the bend point where to place the connection label." - }, - "zIndex" : { - "type" : "integer", - "format" : "int64", - "description" : "The z index of the connection." - }, - "selectedRelationships" : { - "type" : "array", - "description" : "The selected relationship that comprise the connection.", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - }, - "backPressureObjectThreshold" : { - "type" : "integer", - "format" : "int64", - "description" : "The object count threshold for determining when back pressure is applied. Updating this value is a passive change in the sense that it won't impact whether existing files over the limit are affected but it does help feeder processors to stop pushing too much into this work queue." - }, - "backPressureDataSizeThreshold" : { - "type" : "string", - "description" : "The object data size threshold for determining when back pressure is applied. Updating this value is a passive change in the sense that it won't impact whether existing files over the limit are affected but it does help feeder processors to stop pushing too much into this work queue." - }, - "flowFileExpiration" : { - "type" : "string", - "description" : "The amount of time a flow file may be in the flow before it will be automatically aged out of the flow. Once a flow file reaches this age it will be terminated from the flow the next time a processor attempts to start work on it." - }, - "prioritizers" : { - "type" : "array", - "description" : "The comparators used to prioritize the queue.", - "items" : { - "type" : "string" - } - }, - "bends" : { - "type" : "array", - "description" : "The bend points on the connection.", - "items" : { - "$ref" : "#/definitions/Position" - } - }, - "loadBalanceStrategy" : { - "type" : "string", - "description" : "The Strategy to use for load balancing data across the cluster, or null, if no Load Balance Strategy has been specified.", - "enum" : [ "DO_NOT_LOAD_BALANCE", "PARTITION_BY_ATTRIBUTE", "ROUND_ROBIN", "SINGLE_NODE" ] - }, - "partitioningAttribute" : { - "type" : "string", - "description" : "The attribute to use for partitioning data as it is load balanced across the cluster. If the Load Balance Strategy is configured to use PARTITION_BY_ATTRIBUTE, the value returned by this method is the name of the FlowFile Attribute that will be used to determine which node in the cluster should receive a given FlowFile. If the Load Balance Strategy is unset or is set to any other value, the Partitioning Attribute has no effect." - }, - "loadBalanceCompression" : { - "type" : "string", - "description" : "Whether or not compression should be used when transferring FlowFiles between nodes", - "enum" : [ "DO_NOT_COMPRESS", "COMPRESS_ATTRIBUTES_ONLY", "COMPRESS_ATTRIBUTES_AND_CONTENT" ] - }, - "componentType" : { - "type" : "string", - "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE", "REPORTING_TASK", "PARAMETER_CONTEXT", "PARAMETER_PROVIDER", "TEMPLATE", "FLOW_REGISTRY_CLIENT" ] - }, - "groupIdentifier" : { - "type" : "string", - "description" : "The ID of the Process Group that this component belongs to" - } - } - }, - "VersionedControllerService" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The component's unique identifier" - }, - "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" - }, - "comments" : { - "type" : "string", - "description" : "The user-supplied comments for the component" - }, - "position" : { - "description" : "The component's position on the graph", - "$ref" : "#/definitions/Position" - }, - "type" : { - "type" : "string", - "description" : "The type of the extension component" - }, - "bundle" : { - "description" : "Information about the bundle from which the component came", - "$ref" : "#/definitions/Bundle" - }, - "properties" : { - "type" : "object", - "description" : "The properties for the component. Properties whose value is not set will only contain the property name.", - "additionalProperties" : { - "type" : "string" - } - }, - "propertyDescriptors" : { - "type" : "object", - "description" : "The property descriptors for the component.", - "additionalProperties" : { - "$ref" : "#/definitions/VersionedPropertyDescriptor" - } - }, - "controllerServiceApis" : { - "type" : "array", - "description" : "Lists the APIs this Controller Service implements.", - "items" : { - "$ref" : "#/definitions/ControllerServiceAPI" - } - }, - "annotationData" : { - "type" : "string", - "description" : "The annotation for the controller service. This is how the custom UI relays configuration to the controller service." - }, - "scheduledState" : { - "type" : "string", - "description" : "The ScheduledState denoting whether the Controller Service is ENABLED or DISABLED", - "enum" : [ "ENABLED", "DISABLED", "RUNNING" ] - }, - "bulletinLevel" : { - "type" : "string", - "description" : "The level at which the controller service will report bulletins." - }, - "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", "PARAMETER_CONTEXT", "PARAMETER_PROVIDER", "TEMPLATE", "FLOW_REGISTRY_CLIENT" ] - }, - "groupIdentifier" : { - "type" : "string", - "description" : "The ID of the Process Group that this component belongs to" - } - } - }, - "VersionedFlow" : { - "type" : "object", - "required" : [ "bucketIdentifier", "name", "type" ], - "properties" : { - "link" : { - "description" : "An WebLink to this entity.", - "readOnly" : true, - "$ref" : "#/definitions/JaxbLink" - }, - "identifier" : { - "type" : "string", - "description" : "An ID to uniquely identify this object.", - "readOnly" : true - }, - "name" : { - "type" : "string", - "description" : "The name of the item." - }, - "description" : { - "type" : "string", - "description" : "A description of the item." - }, - "bucketIdentifier" : { - "type" : "string", - "description" : "The identifier of the bucket this items belongs to. This cannot be changed after the item is created." - }, - "bucketName" : { - "type" : "string", - "description" : "The name of the bucket this items belongs to.", - "readOnly" : true - }, - "createdTimestamp" : { - "type" : "integer", - "format" : "int64", - "description" : "The timestamp of when the item was created, as milliseconds since epoch.", - "readOnly" : true, - "minimum" : 1 - }, - "modifiedTimestamp" : { - "type" : "integer", - "format" : "int64", - "description" : "The timestamp of when the item was last modified, as milliseconds since epoch.", - "readOnly" : true, - "minimum" : 1 - }, - "type" : { - "type" : "string", - "description" : "The type of item.", - "enum" : [ "Flow", "Bundle" ] - }, - "permissions" : { - "description" : "The access that the current user has to the bucket containing this item.", - "readOnly" : true, - "$ref" : "#/definitions/Permissions" - }, - "versionCount" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of versions of this flow.", - "readOnly" : true, - "minimum" : 0 - }, - "revision" : { - "description" : "The revision of this entity used for optimistic-locking during updates.", - "readOnly" : true, - "$ref" : "#/definitions/RevisionInfo" - } - } - }, - "VersionedFlowCoordinates" : { - "type" : "object", - "properties" : { - "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" - }, - "registryUrl" : { - "type" : "string", - "description" : "The URL of the Flow Registry that contains the flow" - }, - "bucketId" : { - "type" : "string", - "description" : "The UUID of the bucket that the flow resides in" - }, - "flowId" : { - "type" : "string", - "description" : "The UUID of the flow" - }, - "version" : { - "type" : "integer", - "format" : "int32", - "description" : "The version of the flow" - }, - "latest" : { - "type" : "boolean", - "description" : "Whether or not these coordinates point to the latest version of the flow" - } - } - }, - "VersionedFlowDifference" : { - "type" : "object", - "properties" : { - "bucketId" : { - "type" : "string", - "description" : "The id of the bucket that the flow is stored in." - }, - "flowId" : { - "type" : "string", - "description" : "The id of the flow that is being examined." - }, - "versionA" : { - "type" : "integer", - "format" : "int32", - "description" : "The earlier version from the diff operation." - }, - "versionB" : { - "type" : "integer", - "format" : "int32", - "description" : "The latter version from the diff operation." - }, - "componentDifferenceGroups" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ComponentDifferenceGroup" - } - } - } - }, - "VersionedFlowSnapshot" : { - "type" : "object", - "required" : [ "flowContents", "snapshotMetadata" ], - "properties" : { - "snapshotMetadata" : { - "description" : "The metadata for this snapshot", - "$ref" : "#/definitions/VersionedFlowSnapshotMetadata" - }, - "flowContents" : { - "description" : "The contents of the versioned flow", - "$ref" : "#/definitions/VersionedProcessGroup" - }, - "externalControllerServices" : { - "type" : "object", - "description" : "The information about controller services that exist outside this versioned flow, but are referenced by components within the versioned flow.", - "additionalProperties" : { - "$ref" : "#/definitions/ExternalControllerServiceReference" - } - }, - "parameterProviders" : { - "type" : "object", - "description" : "Contains basic information about parameter providers referenced in the versioned flow.", - "additionalProperties" : { - "$ref" : "#/definitions/ParameterProviderReference" - } - }, - "parameterContexts" : { - "type" : "object", - "description" : "The parameter contexts referenced by process groups in the flow contents. The mapping is from the name of the context to the context instance, and it is expected that any context in this map is referenced by at least one process group in this flow.", - "additionalProperties" : { - "$ref" : "#/definitions/VersionedParameterContext" - } - }, - "flowEncodingVersion" : { - "type" : "string", - "description" : "The optional encoding version of the flow contents." - }, - "flow" : { - "description" : "The flow this snapshot is for", - "readOnly" : true, - "$ref" : "#/definitions/VersionedFlow" - }, - "bucket" : { - "description" : "The bucket where the flow is located", - "readOnly" : true, - "$ref" : "#/definitions/Bucket" - }, - "latest" : { - "type" : "boolean" - } - } - }, - "VersionedFlowSnapshotMetadata" : { - "type" : "object", - "required" : [ "bucketIdentifier", "flowIdentifier", "version" ], - "properties" : { - "link" : { - "description" : "An WebLink to this entity.", - "readOnly" : true, - "$ref" : "#/definitions/JaxbLink" - }, - "bucketIdentifier" : { - "type" : "string", - "description" : "The identifier of the bucket this snapshot belongs to." - }, - "flowIdentifier" : { - "type" : "string", - "description" : "The identifier of the flow this snapshot belongs to." - }, - "version" : { - "type" : "integer", - "format" : "int32", - "description" : "The version of this snapshot of the flow.", - "minimum" : -1 - }, - "timestamp" : { - "type" : "integer", - "format" : "int64", - "description" : "The timestamp when the flow was saved, as milliseconds since epoch.", - "readOnly" : true, - "minimum" : 1 - }, - "author" : { - "type" : "string", - "description" : "The user that created this snapshot of the flow.", - "readOnly" : true - }, - "comments" : { - "type" : "string", - "description" : "The comments provided by the user when creating the snapshot." - } - } - }, - "VersionedFunnel" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The component's unique identifier" - }, - "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" - }, - "comments" : { - "type" : "string", - "description" : "The user-supplied comments for the component" - }, - "position" : { - "description" : "The component's position on the graph", - "$ref" : "#/definitions/Position" - }, - "componentType" : { - "type" : "string", - "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE", "REPORTING_TASK", "PARAMETER_CONTEXT", "PARAMETER_PROVIDER", "TEMPLATE", "FLOW_REGISTRY_CLIENT" ] - }, - "groupIdentifier" : { - "type" : "string", - "description" : "The ID of the Process Group that this component belongs to" - } - } - }, - "VersionedLabel" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The component's unique identifier" - }, - "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" - }, - "comments" : { - "type" : "string", - "description" : "The user-supplied comments for the component" - }, - "position" : { - "description" : "The component's position on the graph", - "$ref" : "#/definitions/Position" - }, - "label" : { - "type" : "string", - "description" : "The text that appears in the label." - }, - "zIndex" : { - "type" : "integer", - "format" : "int64", - "description" : "The z index of the connection." - }, - "width" : { - "type" : "number", - "format" : "double", - "description" : "The width of the label in pixels when at a 1:1 scale." - }, - "height" : { - "type" : "number", - "format" : "double", - "description" : "The height of the label in pixels when at a 1:1 scale." - }, - "style" : { - "type" : "object", - "description" : "The styles for this label (font-size : 12px, background-color : #eee, etc).", - "additionalProperties" : { - "type" : "string" - } - }, - "componentType" : { - "type" : "string", - "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE", "REPORTING_TASK", "PARAMETER_CONTEXT", "PARAMETER_PROVIDER", "TEMPLATE", "FLOW_REGISTRY_CLIENT" ] - }, - "groupIdentifier" : { - "type" : "string", - "description" : "The ID of the Process Group that this component belongs to" - } - } - }, - "VersionedParameter" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The name of the parameter" - }, - "description" : { - "type" : "string", - "description" : "The description of the param" - }, - "sensitive" : { - "type" : "boolean", - "description" : "Whether or not the parameter value is sensitive" - }, - "provided" : { - "type" : "boolean", - "description" : "Whether or not the parameter value is provided by a ParameterProvider" - }, - "value" : { - "type" : "string", - "description" : "The value of the parameter" - } - } - }, - "VersionedParameterContext" : { - "type" : "object", - "properties" : { - "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" - }, - "comments" : { - "type" : "string", - "description" : "The user-supplied comments for the component" - }, - "position" : { - "description" : "The component's position on the graph", - "$ref" : "#/definitions/Position" - }, - "parameters" : { - "type" : "array", - "description" : "The parameters in the context", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedParameter" - } - }, - "inheritedParameterContexts" : { - "type" : "array", - "description" : "The names of additional parameter contexts from which to inherit parameters", - "items" : { - "type" : "string" - } - }, - "description" : { - "type" : "string", - "description" : "The description of the parameter context" - }, - "parameterProvider" : { - "type" : "string", - "description" : "The identifier of an optional parameter provider" - }, - "parameterGroupName" : { - "type" : "string", - "description" : "The corresponding parameter group name fetched from the parameter provider, if applicable" - }, - "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", "PARAMETER_CONTEXT", "PARAMETER_PROVIDER", "TEMPLATE", "FLOW_REGISTRY_CLIENT" ] - }, - "synchronized" : { - "type" : "boolean", - "description" : "True if the parameter provider is set and the context should receive updates when its parameters are next fetched" - }, - "groupIdentifier" : { - "type" : "string", - "description" : "The ID of the Process Group that this component belongs to" - } - } - }, - "VersionedPort" : { - "type" : "object", - "properties" : { - "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" - }, - "comments" : { - "type" : "string", - "description" : "The user-supplied comments for the component" - }, - "position" : { - "description" : "The component's position on the graph", - "$ref" : "#/definitions/Position" - }, - "type" : { - "type" : "string", - "description" : "The type of port.", - "enum" : [ "INPUT_PORT", "OUTPUT_PORT" ] - }, - "concurrentlySchedulableTaskCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of tasks that should be concurrently scheduled for the port." - }, - "scheduledState" : { - "type" : "string", - "description" : "The scheduled state of the component", - "enum" : [ "ENABLED", "DISABLED", "RUNNING" ] - }, - "allowRemoteAccess" : { - "type" : "boolean", - "description" : "Whether or not this port allows remote access for site-to-site" - }, - "componentType" : { - "type" : "string", - "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE", "REPORTING_TASK", "PARAMETER_CONTEXT", "PARAMETER_PROVIDER", "TEMPLATE", "FLOW_REGISTRY_CLIENT" ] - }, - "groupIdentifier" : { - "type" : "string", - "description" : "The ID of the Process Group that this component belongs to" - } - } - }, - "VersionedProcessGroup" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The component's unique identifier" - }, - "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" - }, - "comments" : { - "type" : "string", - "description" : "The user-supplied comments for the component" - }, - "position" : { - "description" : "The component's position on the graph", - "$ref" : "#/definitions/Position" - }, - "processGroups" : { - "type" : "array", - "description" : "The child Process Groups", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedProcessGroup" - } - }, - "remoteProcessGroups" : { - "type" : "array", - "description" : "The Remote Process Groups", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedRemoteProcessGroup" - } - }, - "processors" : { - "type" : "array", - "description" : "The Processors", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedProcessor" - } - }, - "inputPorts" : { - "type" : "array", - "description" : "The Input Ports", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedPort" - } - }, - "outputPorts" : { - "type" : "array", - "description" : "The Output Ports", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedPort" - } - }, - "connections" : { - "type" : "array", - "description" : "The Connections", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedConnection" - } - }, - "labels" : { - "type" : "array", - "description" : "The Labels", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedLabel" - } - }, - "funnels" : { - "type" : "array", - "description" : "The Funnels", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedFunnel" - } - }, - "controllerServices" : { - "type" : "array", - "description" : "The Controller Services", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedControllerService" - } - }, - "versionedFlowCoordinates" : { - "description" : "The coordinates where the remote flow is stored, or null if the Process Group is not directly under Version Control", - "$ref" : "#/definitions/VersionedFlowCoordinates" - }, - "variables" : { - "type" : "object", - "description" : "The Variables in the Variable Registry for this Process Group (not including any ancestor or descendant Process Groups)", - "additionalProperties" : { - "type" : "string" - } - }, - "parameterContextName" : { - "type" : "string", - "description" : "The name of the parameter context used by this process group" - }, - "defaultFlowFileExpiration" : { - "type" : "string", - "description" : "The default FlowFile Expiration for this Process Group." - }, - "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." - }, - "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." - }, - "logFileSuffix" : { - "type" : "string", - "description" : "The log file suffix for this Process Group for dedicated logging." - }, - "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", "PARAMETER_CONTEXT", "PARAMETER_PROVIDER", "TEMPLATE", "FLOW_REGISTRY_CLIENT" ] - }, - "flowFileOutboundPolicy" : { - "type" : "string", - "description" : "The FlowFile Outbound Policy for the Process Group" - }, - "flowFileConcurrency" : { - "type" : "string", - "description" : "The configured FlowFile Concurrency for the Process Group" - }, - "groupIdentifier" : { - "type" : "string", - "description" : "The ID of the Process Group that this component belongs to" - } - } - }, - "VersionedProcessor" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The component's unique identifier" - }, - "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" - }, - "comments" : { - "type" : "string", - "description" : "The user-supplied comments for the component" - }, - "position" : { - "description" : "The component's position on the graph", - "$ref" : "#/definitions/Position" - }, - "type" : { - "type" : "string", - "description" : "The type of the extension component" - }, - "bundle" : { - "description" : "Information about the bundle from which the component came", - "$ref" : "#/definitions/Bundle" - }, - "properties" : { - "type" : "object", - "description" : "The properties for the component. Properties whose value is not set will only contain the property name.", - "additionalProperties" : { - "type" : "string" - } - }, - "propertyDescriptors" : { - "type" : "object", - "description" : "The property descriptors for the component.", - "additionalProperties" : { - "$ref" : "#/definitions/VersionedPropertyDescriptor" - } - }, - "style" : { - "type" : "object", - "description" : "Stylistic data for rendering in a UI", - "additionalProperties" : { - "type" : "string" - } - }, - "annotationData" : { - "type" : "string", - "description" : "The annotation data for the processor used to relay configuration between a custom UI and the procesosr." - }, - "schedulingPeriod" : { - "type" : "string", - "description" : "The frequency with which to schedule the processor. The format of the value will depend on th value of schedulingStrategy." - }, - "schedulingStrategy" : { - "type" : "string", - "description" : "Indicates whether the processor should be scheduled to run in event or timer driven mode." - }, - "executionNode" : { - "type" : "string", - "description" : "Indicates the node where the process will execute." - }, - "penaltyDuration" : { - "type" : "string", - "description" : "The amout of time that is used when the process penalizes a flowfile." - }, - "yieldDuration" : { - "type" : "string", - "description" : "The amount of time that must elapse before this processor is scheduled again after yielding." - }, - "bulletinLevel" : { - "type" : "string", - "description" : "The level at which the processor will report bulletins." - }, - "runDurationMillis" : { - "type" : "integer", - "format" : "int64", - "description" : "The run duration for the processor in milliseconds." - }, - "concurrentlySchedulableTaskCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of tasks that should be concurrently schedule for the processor. If the processor doesn't allow parallol processing then any positive input will be ignored." - }, - "autoTerminatedRelationships" : { - "type" : "array", - "description" : "The names of all relationships that cause a flow file to be terminated if the relationship is not connected elsewhere. This property differs from the 'isAutoTerminate' property of the RelationshipDTO in that the RelationshipDTO is meant to depict the current configuration, whereas this property can be set in a DTO when updating a Processor in order to change which Relationships should be auto-terminated.", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - }, - "scheduledState" : { - "type" : "string", - "description" : "The scheduled state of the component", - "enum" : [ "ENABLED", "DISABLED", "RUNNING" ] - }, - "retryCount" : { - "type" : "integer", - "format" : "int32", - "description" : "Overall number of retries." - }, - "retriedRelationships" : { - "type" : "array", - "description" : "All the relationships should be retried.", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - }, - "backoffMechanism" : { - "type" : "string", - "description" : "Determines whether the FlowFile should be penalized or the processor should be yielded between retries.", - "enum" : [ "PENALIZE_FLOWFILE", "YIELD_PROCESSOR" ] - }, - "maxBackoffPeriod" : { - "type" : "string", - "description" : "Maximum amount of time to be waited during a retry period." - }, - "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", "PARAMETER_CONTEXT", "PARAMETER_PROVIDER", "TEMPLATE", "FLOW_REGISTRY_CLIENT" ] - }, - "groupIdentifier" : { - "type" : "string", - "description" : "The ID of the Process Group that this component belongs to" - } - } - }, - "VersionedPropertyDescriptor" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The name of the property" - }, - "displayName" : { - "type" : "string", - "description" : "The display name of the property" - }, - "identifiesControllerService" : { - "type" : "boolean", - "description" : "Whether or not the property provides the identifier of a Controller Service" - }, - "sensitive" : { - "type" : "boolean", - "description" : "Whether or not the property is considered sensitive" - }, - "resourceDefinition" : { - "description" : "Returns the Resource Definition that defines which type(s) of resource(s) this property references, if any", - "$ref" : "#/definitions/VersionedResourceDefinition" - } - } - }, - "VersionedRemoteGroupPort" : { - "type" : "object", - "properties" : { - "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" - }, - "comments" : { - "type" : "string", - "description" : "The user-supplied comments for the component" - }, - "position" : { - "description" : "The component's position on the graph", - "$ref" : "#/definitions/Position" - }, - "remoteGroupId" : { - "type" : "string", - "description" : "The id of the remote process group that the port resides in." - }, - "concurrentlySchedulableTaskCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of task that may transmit flowfiles to the target port concurrently." - }, - "useCompression" : { - "type" : "boolean", - "description" : "Whether the flowfiles are compressed when sent to the target port." - }, - "batchSize" : { - "description" : "The batch settings for data transmission.", - "$ref" : "#/definitions/BatchSize" - }, - "componentType" : { - "type" : "string", - "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE", "REPORTING_TASK", "PARAMETER_CONTEXT", "PARAMETER_PROVIDER", "TEMPLATE", "FLOW_REGISTRY_CLIENT" ] - }, - "targetId" : { - "type" : "string", - "description" : "The ID of the port on the target NiFi instance" - }, - "scheduledState" : { - "type" : "string", - "description" : "The scheduled state of the component", - "enum" : [ "ENABLED", "DISABLED", "RUNNING" ] - }, - "groupIdentifier" : { - "type" : "string", - "description" : "The ID of the Process Group that this component belongs to" - } - } - }, - "VersionedRemoteProcessGroup" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The component's unique identifier" - }, - "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" - }, - "comments" : { - "type" : "string", - "description" : "The user-supplied comments for the component" - }, - "position" : { - "description" : "The component's position on the graph", - "$ref" : "#/definitions/Position" - }, - "targetUri" : { - "type" : "string", - "description" : "[DEPRECATED] The target URI of the remote process group. If target uri is not set, but uris are set, then returns the first uri in the uris. If neither target uri nor uris are set, then returns null." - }, - "targetUris" : { - "type" : "string", - "description" : "The target URIs of the remote process group. If target uris is not set but target uri is set, then returns the single target uri. If neither target uris nor target uri is set, then returns null." - }, - "communicationsTimeout" : { - "type" : "string", - "description" : "The time period used for the timeout when communicating with the target." - }, - "yieldDuration" : { - "type" : "string", - "description" : "When yielding, this amount of time must elapse before the remote process group is scheduled again." - }, - "transportProtocol" : { - "type" : "string", - "description" : "The Transport Protocol that is used for Site-to-Site communications", - "enum" : [ "RAW", "HTTP" ] - }, - "localNetworkInterface" : { - "type" : "string", - "description" : "The local network interface to send/receive data. If not specified, any local address is used. If clustered, all nodes must have an interface with this identifier." - }, - "proxyHost" : { - "type" : "string" - }, - "proxyPort" : { - "type" : "integer", - "format" : "int32" - }, - "proxyUser" : { - "type" : "string" - }, - "proxyPassword" : { - "type" : "string" - }, - "inputPorts" : { - "type" : "array", - "description" : "A Set of Input Ports that can be connected to, in order to send data to the remote NiFi instance", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedRemoteGroupPort" - } - }, - "outputPorts" : { - "type" : "array", - "description" : "A Set of Output Ports that can be connected to, in order to pull data from the remote NiFi instance", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedRemoteGroupPort" - } - }, - "componentType" : { - "type" : "string", - "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE", "REPORTING_TASK", "PARAMETER_CONTEXT", "PARAMETER_PROVIDER", "TEMPLATE", "FLOW_REGISTRY_CLIENT" ] - }, - "groupIdentifier" : { - "type" : "string", - "description" : "The ID of the Process Group that this component belongs to" - } - } - }, - "VersionedResourceDefinition" : { - "type" : "object", - "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", - "uniqueItems" : true, - "items" : { - "type" : "string", - "enum" : [ "FILE", "DIRECTORY", "TEXT", "URL" ] - } - } - } - } - } -} \ No newline at end of file diff --git a/resources/client_gen/api_defs/registry-1.28.1.json b/resources/client_gen/api_defs/registry-1.28.1.json deleted file mode 100644 index 938be500..00000000 --- a/resources/client_gen/api_defs/registry-1.28.1.json +++ /dev/null @@ -1,7129 +0,0 @@ -{ - "swagger" : "2.0", - "info" : { - "description" : "The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components.", - "version" : "1.28.1", - "title" : "Apache NiFi Registry REST API", - "termsOfService" : "As described in the license", - "contact" : { - "name" : "Apache NiFi Registry", - "url" : "https://nifi.apache.org", - "email" : "dev@nifi.apache.org" - }, - "license" : { - "name" : "Apache 2.0 License", - "url" : "https://www.apache.org/licenses/LICENSE-2.0.html" - } - }, - "basePath" : "/nifi-registry-api", - "tags" : [ { - "name" : "about", - "description" : "Retrieves the version information for this NiFi Registry." - }, { - "name" : "access", - "description" : "Endpoints for obtaining an access token or checking access status." - }, { - "name" : "bucket bundles", - "description" : "Create extension bundles scoped to an existing bucket in the registry. " - }, { - "name" : "bucket flows", - "description" : "Create flows scoped to an existing bucket in the registry." - }, { - "name" : "buckets", - "description" : "Create named buckets in the registry to store NiFi objects such flows and extensions. Search for and retrieve existing buckets." - }, { - "name" : "bundles", - "description" : "Gets metadata about extension bundles and their versions. " - }, { - "name" : "config", - "description" : "Retrieves the configuration for this NiFi Registry." - }, { - "name" : "extension repository", - "description" : "Interact with extension bundles via the hierarchy of bucket/group/artifact/version. " - }, { - "name" : "extensions", - "description" : "Find and retrieve extensions. " - }, { - "name" : "flows", - "description" : "Gets metadata about flows." - }, { - "name" : "items", - "description" : "Retrieve items across all buckets for which the user is authorized." - }, { - "name" : "policies", - "description" : "Endpoint for managing access policies." - }, { - "name" : "tenants", - "description" : "Endpoint for managing users and user groups." - } ], - "schemes" : [ "http", "https" ], - "paths" : { - "/about" : { - "get" : { - "tags" : [ "about" ], - "summary" : "Get version", - "description" : "Gets the NiFi Registry version.", - "operationId" : "getVersion", - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/RegistryAbout" - } - } - }, - "security" : [ { - "Authorization" : [ ] - } ] - } - }, - "/access" : { - "get" : { - "tags" : [ "access" ], - "summary" : "Get access status", - "description" : "Returns the current client's authenticated identity and permissions to top-level resources", - "operationId" : "getAccessStatus", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/CurrentUser" - } - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid. The NiFi Registry might be running unsecured." - } - }, - "security" : [ { - "Authorization" : [ ] - } ] - } - }, - "/access/logout" : { - "delete" : { - "tags" : [ "access" ], - "summary" : "Performs a logout for other providers that have been issued a JWT.", - "description" : "\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "logout", - "consumes" : [ "*/*" ], - "produces" : [ "*/*" ], - "responses" : { - "200" : { - "description" : "User was logged out successfully." - }, - "401" : { - "description" : "Authentication token provided was empty or not in the correct JWT format." - }, - "500" : { - "description" : "Client failed to log out." - } - } - } - }, - "/access/logout/complete" : { - "get" : { - "tags" : [ "access" ], - "summary" : "Completes the logout sequence.", - "description" : "\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "logoutComplete", - "consumes" : [ "*/*" ], - "produces" : [ "*/*" ], - "responses" : { - "200" : { - "description" : "User was logged out successfully." - }, - "401" : { - "description" : "Authentication token provided was empty or not in the correct JWT format." - }, - "500" : { - "description" : "Client failed to log out." - } - } - } - }, - "/access/oidc/callback" : { - "get" : { - "tags" : [ "access" ], - "summary" : "Redirect/callback URI for processing the result of the OpenId Connect login sequence.", - "description" : "\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "oidcCallback", - "consumes" : [ "*/*" ], - "produces" : [ "*/*" ], - "responses" : { - "default" : { - "description" : "successful operation" - } - } - } - }, - "/access/oidc/exchange" : { - "post" : { - "tags" : [ "access" ], - "summary" : "Retrieves a JWT following a successful login sequence using the configured OpenId Connect provider.", - "description" : "\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "oidcExchange", - "consumes" : [ "*/*" ], - "produces" : [ "text/plain" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - } - } - } - }, - "/access/oidc/logout" : { - "get" : { - "tags" : [ "access" ], - "summary" : "Performs a logout in the OpenId Provider.", - "description" : "\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "oidcLogout", - "consumes" : [ "*/*" ], - "produces" : [ "*/*" ], - "responses" : { - "default" : { - "description" : "successful operation" - } - } - } - }, - "/access/oidc/logout/callback" : { - "get" : { - "tags" : [ "access" ], - "summary" : "Redirect/callback URI for processing the result of the OpenId Connect logout sequence.", - "description" : "\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "oidcLogoutCallback", - "consumes" : [ "*/*" ], - "produces" : [ "*/*" ], - "responses" : { - "default" : { - "description" : "successful operation" - } - } - } - }, - "/access/oidc/request" : { - "get" : { - "tags" : [ "access" ], - "summary" : "Initiates a request to authenticate through the configured OpenId Connect provider.", - "description" : "\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "oidcRequest", - "consumes" : [ "*/*" ], - "produces" : [ "*/*" ], - "responses" : { - "default" : { - "description" : "successful operation" - } - } - } - }, - "/access/token" : { - "post" : { - "tags" : [ "access" ], - "summary" : "Create token trying all providers", - "description" : "Creates a token for accessing the REST API via auto-detected method of verifying client identity claim credentials. The token returned is formatted as a JSON Web Token (JWT). The token is base64 encoded and comprised of three parts. The header, the body, and the signature. The expiration of the token is a contained within the body. The token can be used in the Authorization header in the format 'Authorization: Bearer '.", - "operationId" : "createAccessTokenByTryingAllProviders", - "consumes" : [ "*/*" ], - "produces" : [ "text/plain" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid. The NiFi Registry may not be configured to support login with username/password." - }, - "500" : { - "description" : "NiFi Registry was unable to complete the request because an unexpected error occurred." - } - } - } - }, - "/access/token/identity-provider" : { - "post" : { - "tags" : [ "access" ], - "summary" : "Create token using identity provider", - "description" : "Creates a token for accessing the REST API via a custom identity provider. The user credentials must be passed in a format understood by the custom identity provider, e.g., a third-party auth token in an HTTP header. The exact format of the user credentials expected by the custom identity provider can be discovered by 'GET /access/token/identity-provider/usage'. The token returned is formatted as a JSON Web Token (JWT). The token is base64 encoded and comprised of three parts. The header, the body, and the signature. The expiration of the token is a contained within the body. The token can be used in the Authorization header in the format 'Authorization: Bearer '.", - "operationId" : "createAccessTokenUsingIdentityProviderCredentials", - "consumes" : [ "*/*" ], - "produces" : [ "text/plain" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid. The NiFi Registry may not be configured to support login with customized credentials." - }, - "500" : { - "description" : "NiFi Registry was unable to complete the request because an unexpected error occurred." - } - } - } - }, - "/access/token/identity-provider/test" : { - "post" : { - "tags" : [ "access" ], - "summary" : "Test identity provider", - "description" : "Tests the format of the credentials against this identity provider without preforming authentication on the credentials to validate them. The user credentials should be passed in a format understood by the custom identity provider as defined by 'GET /access/token/identity-provider/usage'.", - "operationId" : "testIdentityProviderRecognizesCredentialsFormat", - "consumes" : [ "*/*" ], - "produces" : [ "text/plain" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "The format of the credentials were not recognized by the currently configured identity provider." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid. The NiFi Registry may not be configured to support login with customized credentials." - }, - "500" : { - "description" : "NiFi Registry was unable to complete the request because an unexpected error occurred." - } - } - } - }, - "/access/token/identity-provider/usage" : { - "get" : { - "tags" : [ "access" ], - "summary" : "Get identity provider usage", - "description" : "Provides a description of how the currently configured identity provider expects credentials to be passed to POST /access/token/identity-provider", - "operationId" : "getIdentityProviderUsageInstructions", - "consumes" : [ "*/*" ], - "produces" : [ "text/plain" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid. The NiFi Registry may not be configured to support login with customized credentials." - }, - "500" : { - "description" : "NiFi Registry was unable to complete the request because an unexpected error occurred." - } - } - } - }, - "/access/token/kerberos" : { - "post" : { - "tags" : [ "access" ], - "summary" : "Create token using kerberos", - "description" : "Creates a token for accessing the REST API via Kerberos Service Tickets or SPNEGO Tokens (which includes Kerberos Service Tickets). The token returned is formatted as a JSON Web Token (JWT). The token is base64 encoded and comprised of three parts. The header, the body, and the signature. The expiration of the token is a contained within the body. The token can be used in the Authorization header in the format 'Authorization: Bearer '.", - "operationId" : "createAccessTokenUsingKerberosTicket", - "consumes" : [ "*/*" ], - "produces" : [ "text/plain" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid. The NiFi Registry may not be configured to support login Kerberos credentials." - }, - "500" : { - "description" : "NiFi Registry was unable to complete the request because an unexpected error occurred." - } - } - } - }, - "/access/token/login" : { - "post" : { - "tags" : [ "access" ], - "summary" : "Create token using basic auth", - "description" : "Creates a token for accessing the REST API via username/password. The user credentials must be passed in standard HTTP Basic Auth format. That is: 'Authorization: Basic ', where is the base64 encoded value of ':'. The token returned is formatted as a JSON Web Token (JWT). The token is base64 encoded and comprised of three parts. The header, the body, and the signature. The expiration of the token is a contained within the body. The token can be used in the Authorization header in the format 'Authorization: Bearer '.", - "operationId" : "createAccessTokenUsingBasicAuthCredentials", - "consumes" : [ "*/*" ], - "produces" : [ "text/plain" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid. The NiFi Registry may not be configured to support login with username/password." - }, - "500" : { - "description" : "NiFi Registry was unable to complete the request because an unexpected error occurred." - } - }, - "security" : [ { - "BasicAuth" : [ ] - } ] - } - }, - "/buckets" : { - "get" : { - "tags" : [ "buckets" ], - "summary" : "Get all buckets", - "description" : "The returned list will include only buckets for which the user is authorized.If the user is not authorized for any buckets, this returns an empty list.", - "operationId" : "getBuckets", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/Bucket" - } - } - }, - "401" : { - "description" : "Client could not be authenticated." - } - }, - "security" : [ { - "Authorization" : [ ] - } ] - }, - "post" : { - "tags" : [ "buckets" ], - "summary" : "Create bucket", - "description" : "", - "operationId" : "createBucket", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The bucket to create", - "required" : true, - "schema" : { - "$ref" : "#/definitions/Bucket" - } - }, { - "name" : "preserveSourceProperties", - "in" : "query", - "description" : "Whether source properties like identifier should be kept", - "required" : false, - "type" : "boolean" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/Bucket" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets", - "action" : "write" - } - } - }, - "/buckets/fields" : { - "get" : { - "tags" : [ "buckets" ], - "summary" : "Get bucket fields", - "description" : "Retrieves bucket field names for searching or sorting on buckets.", - "operationId" : "getAvailableBucketFields", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/Fields" - } - } - }, - "security" : [ { - "Authorization" : [ ] - } ] - } - }, - "/buckets/{bucketId}" : { - "get" : { - "tags" : [ "buckets" ], - "summary" : "Get bucket", - "description" : "Gets the bucket with the given id.", - "operationId" : "getBucket", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketId", - "in" : "path", - "description" : "The bucket identifier", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/Bucket" - } - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - }, - "put" : { - "tags" : [ "buckets" ], - "summary" : "Update bucket", - "description" : "Updates the bucket with the given id.", - "operationId" : "updateBucket", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketId", - "in" : "path", - "description" : "The bucket identifier", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The updated bucket", - "required" : true, - "schema" : { - "$ref" : "#/definitions/Bucket" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/Bucket" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "write" - } - }, - "delete" : { - "tags" : [ "buckets" ], - "summary" : "Delete bucket", - "description" : "Deletes the bucket with the given id, along with all objects stored in the bucket", - "operationId" : "deleteBucket", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The version is used to verify the client is working with the latest version of the entity.", - "required" : true, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "bucketId", - "in" : "path", - "description" : "The bucket identifier", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/Bucket" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "delete" - } - } - }, - "/buckets/{bucketId}/bundles" : { - "get" : { - "tags" : [ "bucket bundles" ], - "summary" : "Get extension bundles by bucket", - "description" : "\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getExtensionBundles", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketId", - "in" : "path", - "description" : "The bucket identifier", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/ExtensionBundle" - } - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/buckets/{bucketId}/bundles/{bundleType}" : { - "post" : { - "tags" : [ "bucket bundles" ], - "summary" : "Create extension bundle version", - "description" : "Creates a version of an extension bundle by uploading a binary artifact. If an extension bundle already exists in the given bucket with the same group id and artifact id as that of the bundle being uploaded, then it will be added as a new version to the existing bundle. If an extension bundle does not already exist in the given bucket with the same group id and artifact id, then a new extension bundle will be created and this version will be added to the new bundle. Client's may optionally supply a SHA-256 in hex format through the multi-part form field 'sha256'. If supplied, then this value will be compared against the SHA-256 computed by the server, and the bundle will be rejected if the values do not match. If not supplied, the bundle will be accepted, but will be marked to indicate that the client did not supply a SHA-256 during creation. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "createExtensionBundleVersion", - "consumes" : [ "multipart/form-data" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketId", - "in" : "path", - "description" : "The bucket identifier", - "required" : true, - "type" : "string" - }, { - "name" : "bundleType", - "in" : "path", - "description" : "The type of the bundle", - "required" : true, - "type" : "string", - "enum" : [ "nifi-nar", "minifi-cpp" ] - }, { - "name" : "file", - "in" : "formData", - "description" : "The binary content of the bundle file being uploaded.", - "required" : true, - "type" : "file" - }, { - "name" : "sha256", - "in" : "formData", - "description" : "Optional sha256 of the provided bundle", - "required" : false, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/BundleVersion" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "write" - } - } - }, - "/buckets/{bucketId}/flows" : { - "get" : { - "tags" : [ "bucket flows" ], - "summary" : "Get bucket flows", - "description" : "Retrieves all flows in the given bucket.", - "operationId" : "getFlows", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketId", - "in" : "path", - "description" : "The bucket identifier", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/VersionedFlow" - } - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - }, - "post" : { - "tags" : [ "bucket flows" ], - "summary" : "Create flow", - "description" : "Creates a flow in the given bucket. The flow id is created by the server and populated in the returned entity.", - "operationId" : "createFlow", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketId", - "in" : "path", - "description" : "The bucket identifier", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The details of the flow to create.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/VersionedFlow" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlow" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "write" - } - } - }, - "/buckets/{bucketId}/flows/{flowId}" : { - "get" : { - "tags" : [ "bucket flows" ], - "summary" : "Get bucket flow", - "description" : "Retrieves the flow with the given id in the given bucket.", - "operationId" : "getFlow", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketId", - "in" : "path", - "description" : "The bucket identifier", - "required" : true, - "type" : "string" - }, { - "name" : "flowId", - "in" : "path", - "description" : "The flow identifier", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlow" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - }, - "put" : { - "tags" : [ "bucket flows" ], - "summary" : "Update bucket flow", - "description" : "Updates the flow with the given id in the given bucket.", - "operationId" : "updateFlow", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketId", - "in" : "path", - "description" : "The bucket identifier", - "required" : true, - "type" : "string" - }, { - "name" : "flowId", - "in" : "path", - "description" : "The flow identifier", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The updated flow", - "required" : true, - "schema" : { - "$ref" : "#/definitions/VersionedFlow" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlow" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "write" - } - }, - "delete" : { - "tags" : [ "bucket flows" ], - "summary" : "Delete bucket flow", - "description" : "Deletes a flow, including all saved versions of that flow.", - "operationId" : "deleteFlow", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The version is used to verify the client is working with the latest version of the entity.", - "required" : true, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "bucketId", - "in" : "path", - "description" : "The bucket identifier", - "required" : true, - "type" : "string" - }, { - "name" : "flowId", - "in" : "path", - "description" : "The flow identifier", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlow" - } - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "delete" - } - } - }, - "/buckets/{bucketId}/flows/{flowId}/diff/{versionA}/{versionB}" : { - "get" : { - "tags" : [ "bucket flows" ], - "summary" : "Get bucket flow diff", - "description" : "Computes the differences between two given versions of a flow.", - "operationId" : "getFlowDiff", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketId", - "in" : "path", - "description" : "The bucket identifier", - "required" : true, - "type" : "string" - }, { - "name" : "flowId", - "in" : "path", - "description" : "The flow identifier", - "required" : true, - "type" : "string" - }, { - "name" : "versionA", - "in" : "path", - "description" : "The first version number", - "required" : true, - "type" : "integer", - "pattern" : "\\d+", - "format" : "int32" - }, { - "name" : "versionB", - "in" : "path", - "description" : "The second version number", - "required" : true, - "type" : "integer", - "pattern" : "\\d+", - "format" : "int32" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlowDifference" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/buckets/{bucketId}/flows/{flowId}/versions" : { - "get" : { - "tags" : [ "bucket flows" ], - "summary" : "Get bucket flow versions", - "description" : "Gets summary information for all versions of a flow. Versions are ordered newest->oldest.", - "operationId" : "getFlowVersions", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketId", - "in" : "path", - "description" : "The bucket identifier", - "required" : true, - "type" : "string" - }, { - "name" : "flowId", - "in" : "path", - "description" : "The flow identifier", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/VersionedFlowSnapshotMetadata" - } - } - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - }, - "post" : { - "tags" : [ "bucket flows" ], - "summary" : "Create flow version", - "description" : "Creates the next version of a flow. The version number of the object being created must be the next available version integer. Flow versions are immutable after they are created.", - "operationId" : "createFlowVersion", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketId", - "in" : "path", - "description" : "The bucket identifier", - "required" : true, - "type" : "string" - }, { - "name" : "flowId", - "in" : "path", - "description" : "The flow identifier", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The new versioned flow snapshot.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/VersionedFlowSnapshot" - } - }, { - "name" : "preserveSourceProperties", - "in" : "query", - "description" : "Whether source properties like author should be kept", - "required" : false, - "type" : "boolean" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlowSnapshot" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "write" - } - } - }, - "/buckets/{bucketId}/flows/{flowId}/versions/import" : { - "post" : { - "tags" : [ "bucket flows" ], - "summary" : "Import flow version", - "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", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketId", - "in" : "path", - "description" : "The bucket identifier", - "required" : true, - "type" : "string" - }, { - "name" : "flowId", - "in" : "path", - "description" : "The flow identifier", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "file", - "required" : false, - "schema" : { - "$ref" : "#/definitions/VersionedFlowSnapshot" - } - }, { - "name" : "Comments", - "in" : "header", - "required" : false, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlowSnapshot" - } - }, - "201" : { - "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." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "write" - } - } - }, - "/buckets/{bucketId}/flows/{flowId}/versions/latest" : { - "get" : { - "tags" : [ "bucket flows" ], - "summary" : "Get latest bucket flow version content", - "description" : "Gets the latest version of a flow, including the metadata and content of the flow.", - "operationId" : "getLatestFlowVersion", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketId", - "in" : "path", - "description" : "The bucket identifier", - "required" : true, - "type" : "string" - }, { - "name" : "flowId", - "in" : "path", - "description" : "The flow identifier", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlowSnapshot" - } - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/buckets/{bucketId}/flows/{flowId}/versions/latest/metadata" : { - "get" : { - "tags" : [ "bucket flows" ], - "summary" : "Get latest bucket flow version metadata", - "description" : "Gets the metadata for the latest version of a flow.", - "operationId" : "getLatestFlowVersionMetadata", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketId", - "in" : "path", - "description" : "The bucket identifier", - "required" : true, - "type" : "string" - }, { - "name" : "flowId", - "in" : "path", - "description" : "The flow identifier", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlowSnapshotMetadata" - } - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/buckets/{bucketId}/flows/{flowId}/versions/{versionNumber}" : { - "get" : { - "tags" : [ "bucket flows" ], - "summary" : "Get bucket flow version", - "description" : "Gets the given version of a flow, including the metadata and content for the version.", - "operationId" : "getFlowVersion", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketId", - "in" : "path", - "description" : "The bucket identifier", - "required" : true, - "type" : "string" - }, { - "name" : "flowId", - "in" : "path", - "description" : "The flow identifier", - "required" : true, - "type" : "string" - }, { - "name" : "versionNumber", - "in" : "path", - "description" : "The version number", - "required" : true, - "type" : "integer", - "pattern" : "\\d+", - "format" : "int32" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlowSnapshot" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/buckets/{bucketId}/flows/{flowId}/versions/{versionNumber}/export" : { - "get" : { - "tags" : [ "bucket flows" ], - "summary" : "Exports specified bucket flow version content", - "description" : "Exports the specified version of a flow, including the metadata and content of the flow.", - "operationId" : "exportVersionedFlow", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketId", - "in" : "path", - "description" : "The bucket identifier", - "required" : true, - "type" : "string" - }, { - "name" : "flowId", - "in" : "path", - "description" : "The flow identifier", - "required" : true, - "type" : "string" - }, { - "name" : "versionNumber", - "in" : "path", - "description" : "The version number", - "required" : true, - "type" : "integer", - "pattern" : "\\d+", - "format" : "int32" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlowSnapshot" - } - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/bundles" : { - "get" : { - "tags" : [ "bundles" ], - "summary" : "Get all bundles", - "description" : "Gets the metadata for all bundles across all authorized buckets with optional filters applied. The returned results will include only items from buckets for which the user is authorized. If the user is not authorized to any buckets, an empty list will be returned. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getBundles", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketName", - "in" : "query", - "description" : "Optional bucket name to filter results. The value may be an exact match, or a wildcard, such as 'My Bucket%' to select all bundles where the bucket name starts with 'My Bucket'.", - "required" : false, - "type" : "string" - }, { - "name" : "groupId", - "in" : "query", - "description" : "Optional groupId to filter results. The value may be an exact match, or a wildcard, such as 'com.%' to select all bundles where the groupId starts with 'com.'.", - "required" : false, - "type" : "string" - }, { - "name" : "artifactId", - "in" : "query", - "description" : "Optional artifactId to filter results. The value may be an exact match, or a wildcard, such as 'nifi-%' to select all bundles where the artifactId starts with 'nifi-'.", - "required" : false, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/ExtensionBundle" - } - } - }, - "401" : { - "description" : "Client could not be authenticated." - } - }, - "security" : [ { - "Authorization" : [ ] - } ] - } - }, - "/bundles/versions" : { - "get" : { - "tags" : [ "bundles" ], - "summary" : "Get all bundle versions", - "description" : "Gets the metadata about extension bundle versions across all authorized buckets with optional filters applied. If the user is not authorized to any buckets, an empty list will be returned. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getBundleVersions", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "groupId", - "in" : "query", - "description" : "Optional groupId to filter results. The value may be an exact match, or a wildcard, such as 'com.%' to select all bundle versions where the groupId starts with 'com.'.", - "required" : false, - "type" : "string" - }, { - "name" : "artifactId", - "in" : "query", - "description" : "Optional artifactId to filter results. The value may be an exact match, or a wildcard, such as 'nifi-%' to select all bundle versions where the artifactId starts with 'nifi-'.", - "required" : false, - "type" : "string" - }, { - "name" : "version", - "in" : "query", - "description" : "Optional version to filter results. The value maye be an exact match, or a wildcard, such as '1.0.%' to select all bundle versions where the version starts with '1.0.'.", - "required" : false, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/BundleVersionMetadata" - } - } - }, - "401" : { - "description" : "Client could not be authenticated." - } - }, - "security" : [ { - "Authorization" : [ ] - } ] - } - }, - "/bundles/{bundleId}" : { - "get" : { - "tags" : [ "bundles" ], - "summary" : "Get bundle", - "description" : "Gets the metadata about an extension bundle. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "globalGetExtensionBundle", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bundleId", - "in" : "path", - "description" : "The extension bundle identifier", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ExtensionBundle" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - }, - "delete" : { - "tags" : [ "bundles" ], - "summary" : "Delete bundle", - "description" : "Deletes the given extension bundle and all of it's versions. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "globalDeleteExtensionBundle", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bundleId", - "in" : "path", - "description" : "The extension bundle identifier", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ExtensionBundle" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "write" - } - } - }, - "/bundles/{bundleId}/versions" : { - "get" : { - "tags" : [ "bundles" ], - "summary" : "Get bundle versions", - "description" : "Gets the metadata for the versions of the given extension bundle. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "globalGetBundleVersions", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bundleId", - "in" : "path", - "description" : "The extension bundle identifier", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/BundleVersionMetadata" - } - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/bundles/{bundleId}/versions/{version}" : { - "get" : { - "tags" : [ "bundles" ], - "summary" : "Get bundle version", - "description" : "Gets the descriptor for the given version of the given extension bundle. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "globalGetBundleVersion", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bundleId", - "in" : "path", - "description" : "The extension bundle identifier", - "required" : true, - "type" : "string" - }, { - "name" : "version", - "in" : "path", - "description" : "The version of the bundle", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/BundleVersion" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - }, - "delete" : { - "tags" : [ "bundles" ], - "summary" : "Delete bundle version", - "description" : "Deletes the given extension bundle version and it's associated binary content. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "globalDeleteBundleVersion", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bundleId", - "in" : "path", - "description" : "The extension bundle identifier", - "required" : true, - "type" : "string" - }, { - "name" : "version", - "in" : "path", - "description" : "The version of the bundle", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/BundleVersion" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "write" - } - } - }, - "/bundles/{bundleId}/versions/{version}/content" : { - "get" : { - "tags" : [ "bundles" ], - "summary" : "Get bundle version content", - "description" : "Gets the binary content for the given version of the given extension bundle. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "globalGetBundleVersionContent", - "consumes" : [ "*/*" ], - "produces" : [ "application/octet-stream" ], - "parameters" : [ { - "name" : "bundleId", - "in" : "path", - "description" : "The extension bundle identifier", - "required" : true, - "type" : "string" - }, { - "name" : "version", - "in" : "path", - "description" : "The version of the bundle", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "type" : "string", - "format" : "byte" - } - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/bundles/{bundleId}/versions/{version}/extensions" : { - "get" : { - "tags" : [ "bundles" ], - "summary" : "Get bundle version extensions", - "description" : "Gets the metadata about the extensions in the given extension bundle version. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "globalGetBundleVersionExtensions", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bundleId", - "in" : "path", - "description" : "The extension bundle identifier", - "required" : true, - "type" : "string" - }, { - "name" : "version", - "in" : "path", - "description" : "The version of the bundle", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/ExtensionMetadata" - } - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/bundles/{bundleId}/versions/{version}/extensions/{name}" : { - "get" : { - "tags" : [ "bundles" ], - "summary" : "Get bundle version extension", - "description" : "Gets the metadata about the extension with the given name in the given extension bundle version. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "globalGetBundleVersionExtension", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bundleId", - "in" : "path", - "description" : "The extension bundle identifier", - "required" : true, - "type" : "string" - }, { - "name" : "version", - "in" : "path", - "description" : "The version of the bundle", - "required" : true, - "type" : "string" - }, { - "name" : "name", - "in" : "path", - "description" : "The fully qualified name of the extension", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/Extension" - } - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/bundles/{bundleId}/versions/{version}/extensions/{name}/docs" : { - "get" : { - "tags" : [ "bundles" ], - "summary" : "Get bundle version extension docs", - "description" : "Gets the documentation for the given extension in the given extension bundle version. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getBundleVersionExtensionDocs", - "consumes" : [ "*/*" ], - "produces" : [ "text/html" ], - "parameters" : [ { - "name" : "bundleId", - "in" : "path", - "description" : "The extension bundle identifier", - "required" : true, - "type" : "string" - }, { - "name" : "version", - "in" : "path", - "description" : "The version of the bundle", - "required" : true, - "type" : "string" - }, { - "name" : "name", - "in" : "path", - "description" : "The fully qualified name of the extension", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/bundles/{bundleId}/versions/{version}/extensions/{name}/docs/additional-details" : { - "get" : { - "tags" : [ "bundles" ], - "summary" : "Get bundle version extension docs details", - "description" : "Gets the additional details documentation for the given extension in the given extension bundle version. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getBundleVersionExtensionAdditionalDetailsDocs", - "consumes" : [ "*/*" ], - "produces" : [ "text/html" ], - "parameters" : [ { - "name" : "bundleId", - "in" : "path", - "description" : "The extension bundle identifier", - "required" : true, - "type" : "string" - }, { - "name" : "version", - "in" : "path", - "description" : "The version of the bundle", - "required" : true, - "type" : "string" - }, { - "name" : "name", - "in" : "path", - "description" : "The fully qualified name of the extension", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/config" : { - "get" : { - "tags" : [ "config" ], - "summary" : "Get configration", - "description" : "Gets the NiFi Registry configurations.", - "operationId" : "getConfiguration", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/RegistryConfiguration" - } - }, - "401" : { - "description" : "Client could not be authenticated." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/policies,/tenants", - "action" : "read" - } - } - }, - "/extension-repository" : { - "get" : { - "tags" : [ "extension repository" ], - "summary" : "Get extension repo buckets", - "description" : "Gets the names of the buckets the current user is authorized for in order to browse the repo by bucket. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getExtensionRepoBuckets", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/ExtensionRepoBucket" - } - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ] - } - }, - "/extension-repository/{bucketName}" : { - "get" : { - "tags" : [ "extension repository" ], - "summary" : "Get extension repo groups", - "description" : "Gets the groups in the extension repository in the given bucket. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getExtensionRepoGroups", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketName", - "in" : "path", - "description" : "The bucket name", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/ExtensionRepoGroup" - } - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/extension-repository/{bucketName}/{groupId}" : { - "get" : { - "tags" : [ "extension repository" ], - "summary" : "Get extension repo artifacts", - "description" : "Gets the artifacts in the extension repository in the given bucket and group. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getExtensionRepoArtifacts", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketName", - "in" : "path", - "description" : "The bucket name", - "required" : true, - "type" : "string" - }, { - "name" : "groupId", - "in" : "path", - "description" : "The group id", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/ExtensionRepoArtifact" - } - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/extension-repository/{bucketName}/{groupId}/{artifactId}" : { - "get" : { - "tags" : [ "extension repository" ], - "summary" : "Get extension repo versions", - "description" : "Gets the versions in the extension repository for the given bucket, group, and artifact. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getExtensionRepoVersions", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketName", - "in" : "path", - "description" : "The bucket name", - "required" : true, - "type" : "string" - }, { - "name" : "groupId", - "in" : "path", - "description" : "The group identifier", - "required" : true, - "type" : "string" - }, { - "name" : "artifactId", - "in" : "path", - "description" : "The artifact identifier", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/ExtensionRepoVersionSummary" - } - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/extension-repository/{bucketName}/{groupId}/{artifactId}/{version}" : { - "get" : { - "tags" : [ "extension repository" ], - "summary" : "Get extension repo version", - "description" : "Gets information about the version in the given bucket, group, and artifact. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getExtensionRepoVersion", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketName", - "in" : "path", - "description" : "The bucket name", - "required" : true, - "type" : "string" - }, { - "name" : "groupId", - "in" : "path", - "description" : "The group identifier", - "required" : true, - "type" : "string" - }, { - "name" : "artifactId", - "in" : "path", - "description" : "The artifact identifier", - "required" : true, - "type" : "string" - }, { - "name" : "version", - "in" : "path", - "description" : "The version", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ExtensionRepoVersion" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/extension-repository/{bucketName}/{groupId}/{artifactId}/{version}/content" : { - "get" : { - "tags" : [ "extension repository" ], - "summary" : "Get extension repo version content", - "description" : "Gets the binary content of the bundle with the given bucket, group, artifact, and version. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getExtensionRepoVersionContent", - "consumes" : [ "*/*" ], - "produces" : [ "application/octet-stream" ], - "parameters" : [ { - "name" : "bucketName", - "in" : "path", - "description" : "The bucket name", - "required" : true, - "type" : "string" - }, { - "name" : "groupId", - "in" : "path", - "description" : "The group identifier", - "required" : true, - "type" : "string" - }, { - "name" : "artifactId", - "in" : "path", - "description" : "The artifact identifier", - "required" : true, - "type" : "string" - }, { - "name" : "version", - "in" : "path", - "description" : "The version", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "type" : "string", - "format" : "byte" - } - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/extension-repository/{bucketName}/{groupId}/{artifactId}/{version}/extensions" : { - "get" : { - "tags" : [ "extension repository" ], - "summary" : "Get extension repo extensions", - "description" : "Gets information about the extensions in the given bucket, group, artifact, and version. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getExtensionRepoVersionExtensions", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketName", - "in" : "path", - "description" : "The bucket name", - "required" : true, - "type" : "string" - }, { - "name" : "groupId", - "in" : "path", - "description" : "The group identifier", - "required" : true, - "type" : "string" - }, { - "name" : "artifactId", - "in" : "path", - "description" : "The artifact identifier", - "required" : true, - "type" : "string" - }, { - "name" : "version", - "in" : "path", - "description" : "The version", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/ExtensionMetadata" - } - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/extension-repository/{bucketName}/{groupId}/{artifactId}/{version}/extensions/{name}" : { - "get" : { - "tags" : [ "extension repository" ], - "summary" : "Get extension repo extension", - "description" : "Gets information about the extension with the given name in the given bucket, group, artifact, and version. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getExtensionRepoVersionExtension", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketName", - "in" : "path", - "description" : "The bucket name", - "required" : true, - "type" : "string" - }, { - "name" : "groupId", - "in" : "path", - "description" : "The group identifier", - "required" : true, - "type" : "string" - }, { - "name" : "artifactId", - "in" : "path", - "description" : "The artifact identifier", - "required" : true, - "type" : "string" - }, { - "name" : "version", - "in" : "path", - "description" : "The version", - "required" : true, - "type" : "string" - }, { - "name" : "name", - "in" : "path", - "description" : "The fully qualified name of the extension", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/Extension" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/extension-repository/{bucketName}/{groupId}/{artifactId}/{version}/extensions/{name}/docs" : { - "get" : { - "tags" : [ "extension repository" ], - "summary" : "Get extension repo extension docs", - "description" : "Gets the documentation for the extension with the given name in the given bucket, group, artifact, and version. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getExtensionRepoVersionExtensionDocs", - "consumes" : [ "*/*" ], - "produces" : [ "text/html" ], - "parameters" : [ { - "name" : "bucketName", - "in" : "path", - "description" : "The bucket name", - "required" : true, - "type" : "string" - }, { - "name" : "groupId", - "in" : "path", - "description" : "The group identifier", - "required" : true, - "type" : "string" - }, { - "name" : "artifactId", - "in" : "path", - "description" : "The artifact identifier", - "required" : true, - "type" : "string" - }, { - "name" : "version", - "in" : "path", - "description" : "The version", - "required" : true, - "type" : "string" - }, { - "name" : "name", - "in" : "path", - "description" : "The fully qualified name of the extension", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/extension-repository/{bucketName}/{groupId}/{artifactId}/{version}/extensions/{name}/docs/additional-details" : { - "get" : { - "tags" : [ "extension repository" ], - "summary" : "Get extension repo extension details", - "description" : "Gets the additional details documentation for the extension with the given name in the given bucket, group, artifact, and version. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getExtensionRepoVersionExtensionAdditionalDetailsDocs", - "consumes" : [ "*/*" ], - "produces" : [ "text/html" ], - "parameters" : [ { - "name" : "bucketName", - "in" : "path", - "description" : "The bucket name", - "required" : true, - "type" : "string" - }, { - "name" : "groupId", - "in" : "path", - "description" : "The group identifier", - "required" : true, - "type" : "string" - }, { - "name" : "artifactId", - "in" : "path", - "description" : "The artifact identifier", - "required" : true, - "type" : "string" - }, { - "name" : "version", - "in" : "path", - "description" : "The version", - "required" : true, - "type" : "string" - }, { - "name" : "name", - "in" : "path", - "description" : "The fully qualified name of the extension", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/extension-repository/{bucketName}/{groupId}/{artifactId}/{version}/sha256" : { - "get" : { - "tags" : [ "extension repository" ], - "summary" : "Get extension repo version checksum", - "description" : "Gets the hex representation of the SHA-256 digest for the binary content of the bundle with the given bucket, group, artifact, and version.\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getExtensionRepoVersionSha256", - "consumes" : [ "*/*" ], - "produces" : [ "text/plain" ], - "parameters" : [ { - "name" : "bucketName", - "in" : "path", - "description" : "The bucket name", - "required" : true, - "type" : "string" - }, { - "name" : "groupId", - "in" : "path", - "description" : "The group identifier", - "required" : true, - "type" : "string" - }, { - "name" : "artifactId", - "in" : "path", - "description" : "The artifact identifier", - "required" : true, - "type" : "string" - }, { - "name" : "version", - "in" : "path", - "description" : "The version", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/extension-repository/{groupId}/{artifactId}/{version}/sha256" : { - "get" : { - "tags" : [ "extension repository" ], - "summary" : "Get global extension repo version checksum", - "description" : "Gets the hex representation of the SHA-256 digest for the binary content with the given bucket, group, artifact, and version. Since the same group-artifact-version can exist in multiple buckets, this will return the checksum of the first one returned. This will be consistent since the checksum must be the same when existing in multiple buckets. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getGlobalExtensionRepoVersionSha256", - "consumes" : [ "*/*" ], - "produces" : [ "text/plain" ], - "parameters" : [ { - "name" : "groupId", - "in" : "path", - "description" : "The group identifier", - "required" : true, - "type" : "string" - }, { - "name" : "artifactId", - "in" : "path", - "description" : "The artifact identifier", - "required" : true, - "type" : "string" - }, { - "name" : "version", - "in" : "path", - "description" : "The version", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "string" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ] - } - }, - "/extensions" : { - "get" : { - "tags" : [ "extensions" ], - "summary" : "Get all extensions", - "description" : "Gets the metadata for all extensions that match the filter params and are part of bundles located in buckets the current user is authorized for. If the user is not authorized to any buckets, an empty result set will be returned.\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getExtensions", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bundleType", - "in" : "query", - "description" : "The type of bundles to return", - "required" : false, - "type" : "string", - "enum" : [ "nifi-nar", "minifi-cpp" ] - }, { - "name" : "extensionType", - "in" : "query", - "description" : "The type of extensions to return", - "required" : false, - "type" : "string", - "enum" : [ "PROCESSOR", "CONTROLLER_SERVICE", "REPORTING_TASK" ] - }, { - "name" : "tag", - "in" : "query", - "description" : "The tags to filter on, will be used in an OR statement", - "required" : false, - "type" : "array", - "items" : { - "type" : "string" - }, - "collectionFormat" : "multi" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ExtensionMetadataContainer" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ] - } - }, - "/extensions/provided-service-api" : { - "get" : { - "tags" : [ "extensions" ], - "summary" : "Get extensions providing service API", - "description" : "Gets the metadata for extensions that provide the specified API and are part of bundles located in buckets the current user is authorized for. If the user is not authorized to any buckets, an empty result set will be returned.\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getExtensionsProvidingServiceAPI", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "className", - "in" : "query", - "description" : "The name of the service API class", - "required" : true, - "type" : "string" - }, { - "name" : "groupId", - "in" : "query", - "description" : "The groupId of the bundle containing the service API class", - "required" : true, - "type" : "string" - }, { - "name" : "artifactId", - "in" : "query", - "description" : "The artifactId of the bundle containing the service API class", - "required" : true, - "type" : "string" - }, { - "name" : "version", - "in" : "query", - "description" : "The version of the bundle containing the service API class", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ExtensionMetadataContainer" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ] - } - }, - "/extensions/tags" : { - "get" : { - "tags" : [ "extensions" ], - "summary" : "Get extension tags", - "description" : "Gets all the extension tags known to this NiFi Registry instance, along with the number of extensions that have the given tag.\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getTags", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/TagCount" - } - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ] - } - }, - "/flows/fields" : { - "get" : { - "tags" : [ "flows" ], - "summary" : "Get flow fields", - "description" : "Retrieves the flow field names that can be used for searching or sorting on flows.", - "operationId" : "getAvailableFlowFields", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/Fields" - } - } - }, - "security" : [ { - "Authorization" : [ ] - } ] - } - }, - "/flows/{flowId}" : { - "get" : { - "tags" : [ "flows" ], - "summary" : "Get flow", - "description" : "Gets a flow by id.", - "operationId" : "globalGetFlow", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "flowId", - "in" : "path", - "description" : "The flow identifier", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlow" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/flows/{flowId}/versions" : { - "get" : { - "tags" : [ "flows" ], - "summary" : "Get flow versions", - "description" : "Gets summary information for all versions of a given flow. Versions are ordered newest->oldest.", - "operationId" : "globalGetFlowVersions", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "flowId", - "in" : "path", - "description" : "The flow identifier", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/VersionedFlowSnapshotMetadata" - } - } - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/flows/{flowId}/versions/latest" : { - "get" : { - "tags" : [ "flows" ], - "summary" : "Get latest flow version", - "description" : "Gets the latest version of a flow, including metadata and flow content.", - "operationId" : "globalGetLatestFlowVersion", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "flowId", - "in" : "path", - "description" : "The flow identifier", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlowSnapshot" - } - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/flows/{flowId}/versions/latest/metadata" : { - "get" : { - "tags" : [ "flows" ], - "summary" : "Get latest flow version metadata", - "description" : "Gets the metadata for the latest version of a flow.", - "operationId" : "globalGetLatestFlowVersionMetadata", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "flowId", - "in" : "path", - "description" : "The flow identifier", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlowSnapshotMetadata" - } - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/flows/{flowId}/versions/{versionNumber}" : { - "get" : { - "tags" : [ "flows" ], - "summary" : "Get flow version", - "description" : "Gets the given version of a flow, including metadata and flow content.", - "operationId" : "globalGetFlowVersion", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "flowId", - "in" : "path", - "description" : "The flow identifier", - "required" : true, - "type" : "string" - }, { - "name" : "versionNumber", - "in" : "path", - "description" : "The version number", - "required" : true, - "type" : "integer", - "pattern" : "\\d+", - "format" : "int32" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VersionedFlowSnapshot" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/items" : { - "get" : { - "tags" : [ "items" ], - "summary" : "Get all items", - "description" : "Get items across all buckets. The returned items will include only items from buckets for which the user is authorized. If the user is not authorized to any buckets, an empty list will be returned.", - "operationId" : "getItems", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/BucketItem" - } - } - }, - "401" : { - "description" : "Client could not be authenticated." - } - }, - "security" : [ { - "Authorization" : [ ] - } ] - } - }, - "/items/fields" : { - "get" : { - "tags" : [ "items" ], - "summary" : "Get item fields", - "description" : "Retrieves the item field names for searching or sorting on bucket items.", - "operationId" : "getAvailableBucketItemFields", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/Fields" - } - } - }, - "security" : [ { - "Authorization" : [ ] - } ] - } - }, - "/items/{bucketId}" : { - "get" : { - "tags" : [ "items" ], - "summary" : "Get bucket items", - "description" : "Gets the items located in the given bucket.", - "operationId" : "getItemsInBucket", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "bucketId", - "in" : "path", - "description" : "The bucket identifier", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/BucketItem" - } - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/buckets/{bucketId}", - "action" : "read" - } - } - }, - "/policies" : { - "get" : { - "tags" : [ "policies" ], - "summary" : "Get all access policies", - "description" : "", - "operationId" : "getAccessPolicies", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/AccessPolicy" - } - } - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/policies", - "action" : "read" - } - }, - "post" : { - "tags" : [ "policies" ], - "summary" : "Create access policy", - "description" : "", - "operationId" : "createAccessPolicy", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The access policy configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/AccessPolicy" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/AccessPolicy" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid. The NiFi Registry might not be configured to use a ConfigurableAccessPolicyProvider." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/policies", - "action" : "write" - } - } - }, - "/policies/resources" : { - "get" : { - "tags" : [ "policies" ], - "summary" : "Get available resources", - "description" : "Gets the available resources that support access/authorization policies", - "operationId" : "getResources", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/Resource" - } - } - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/policies", - "action" : "read" - } - } - }, - "/policies/{action}/{resource}" : { - "get" : { - "tags" : [ "policies" ], - "summary" : "Get access policy for resource", - "description" : "Gets an access policy for the specified action and resource", - "operationId" : "getAccessPolicyForResource", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "action", - "in" : "path", - "description" : "The request action.", - "required" : true, - "type" : "string", - "enum" : [ "read", "write", "delete" ] - }, { - "name" : "resource", - "in" : "path", - "description" : "The resource of the policy.", - "required" : true, - "type" : "string", - "pattern" : ".+" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/AccessPolicy" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/policies", - "action" : "read" - } - } - }, - "/policies/{id}" : { - "get" : { - "tags" : [ "policies" ], - "summary" : "Get access policy", - "description" : "", - "operationId" : "getAccessPolicy", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The access policy id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/AccessPolicy" - } - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/policies", - "action" : "read" - } - }, - "put" : { - "tags" : [ "policies" ], - "summary" : "Update access policy", - "description" : "", - "operationId" : "updateAccessPolicy", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The access policy id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The access policy configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/AccessPolicy" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/AccessPolicy" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid. The NiFi Registry might not be configured to use a ConfigurableAccessPolicyProvider." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/policies", - "action" : "write" - } - }, - "delete" : { - "tags" : [ "policies" ], - "summary" : "Delete access policy", - "description" : "", - "operationId" : "removeAccessPolicy", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The version is used to verify the client is working with the latest version of the entity.", - "required" : true, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The access policy id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/AccessPolicy" - } - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid. The NiFi Registry might not be configured to use a ConfigurableAccessPolicyProvider." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/policies", - "action" : "delete" - } - } - }, - "/tenants/user-groups" : { - "get" : { - "tags" : [ "tenants" ], - "summary" : "Get user groups", - "description" : "\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getUserGroups", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/UserGroup" - } - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/tenants", - "action" : "read" - } - }, - "post" : { - "tags" : [ "tenants" ], - "summary" : "Create user group", - "description" : "\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "createUserGroup", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The user group configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/UserGroup" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/UserGroup" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/tenants", - "action" : "write" - } - } - }, - "/tenants/user-groups/{id}" : { - "get" : { - "tags" : [ "tenants" ], - "summary" : "Get user group", - "description" : "\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getUserGroup", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The user group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/UserGroup" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/tenants", - "action" : "read" - } - }, - "put" : { - "tags" : [ "tenants" ], - "summary" : "Update user group", - "description" : "\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "updateUserGroup", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The user group id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The user group configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/UserGroup" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/UserGroup" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/tenants", - "action" : "write" - } - }, - "delete" : { - "tags" : [ "tenants" ], - "summary" : "Delete user group", - "description" : "\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "removeUserGroup", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The version is used to verify the client is working with the latest version of the entity.", - "required" : true, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The user group id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/UserGroup" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/tenants", - "action" : "delete" - } - } - }, - "/tenants/users" : { - "get" : { - "tags" : [ "tenants" ], - "summary" : "Get all users", - "description" : "\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getUsers", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/User" - } - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/tenants", - "action" : "read" - } - }, - "post" : { - "tags" : [ "tenants" ], - "summary" : "Create user", - "description" : "\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "createUser", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "The user configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/User" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/User" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/tenants", - "action" : "write" - } - } - }, - "/tenants/users/{id}" : { - "get" : { - "tags" : [ "tenants" ], - "summary" : "Get user", - "description" : "\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "getUser", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The user id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/User" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/tenants", - "action" : "read" - } - }, - "put" : { - "tags" : [ "tenants" ], - "summary" : "Update user", - "description" : "\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "updateUser", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "The user id.", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "description" : "The user configuration details.", - "required" : true, - "schema" : { - "$ref" : "#/definitions/User" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/User" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/tenants", - "action" : "write" - } - }, - "delete" : { - "tags" : [ "tenants" ], - "summary" : "Delete user", - "description" : "\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", - "operationId" : "removeUser", - "consumes" : [ "*/*" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "version", - "in" : "query", - "description" : "The version is used to verify the client is working with the latest version of the entity.", - "required" : true, - "type" : "string" - }, { - "name" : "clientId", - "in" : "query", - "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", - "required" : false, - "type" : "string" - }, { - "name" : "id", - "in" : "path", - "description" : "The user id.", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/User" - } - }, - "400" : { - "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." - }, - "401" : { - "description" : "Client could not be authenticated." - }, - "403" : { - "description" : "Client is not authorized to make this request." - }, - "404" : { - "description" : "The specified resource could not be found." - }, - "409" : { - "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." - } - }, - "security" : [ { - "Authorization" : [ ] - } ], - "x-access-policy" : { - "resource" : "/tenants", - "action" : "delete" - } - } - } - }, - "securityDefinitions" : { - "Authorization" : { - "description" : "NiFi Registry Auth Token (JWT)", - "type" : "apiKey", - "name" : "Authorization", - "in" : "header" - }, - "BasicAuth" : { - "description" : "HTTP Basic Auth", - "type" : "basic" - } - }, - "definitions" : { - "AccessPolicy" : { - "type" : "object", - "required" : [ "action", "resource" ], - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The id of the policy. Set by server at creation time.", - "readOnly" : true - }, - "resource" : { - "type" : "string", - "description" : "The resource for this access policy." - }, - "action" : { - "type" : "string", - "description" : "The action associated with this access policy.", - "enum" : [ "read", "write", "delete" ] - }, - "configurable" : { - "type" : "boolean", - "description" : "Indicates if this access policy is configurable, based on which Authorizer has been configured to manage it.", - "readOnly" : true - }, - "revision" : { - "description" : "The revision of this entity used for optimistic-locking during updates.", - "readOnly" : true, - "$ref" : "#/definitions/RevisionInfo" - }, - "users" : { - "type" : "array", - "description" : "The set of user IDs associated with this access policy.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/Tenant" - } - }, - "userGroups" : { - "type" : "array", - "description" : "The set of user group IDs associated with this access policy.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/Tenant" - } - } - } - }, - "AccessPolicySummary" : { - "type" : "object", - "required" : [ "action", "resource" ], - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The id of the policy. Set by server at creation time.", - "readOnly" : true - }, - "resource" : { - "type" : "string", - "description" : "The resource for this access policy." - }, - "action" : { - "type" : "string", - "description" : "The action associated with this access policy.", - "enum" : [ "read", "write", "delete" ] - }, - "configurable" : { - "type" : "boolean", - "description" : "Indicates if this access policy is configurable, based on which Authorizer has been configured to manage it.", - "readOnly" : true - }, - "revision" : { - "description" : "The revision of this entity used for optimistic-locking during updates.", - "readOnly" : true, - "$ref" : "#/definitions/RevisionInfo" - } - } - }, - "AllowableValue" : { - "type" : "object", - "properties" : { - "value" : { - "type" : "string", - "description" : "The value of the allowable value" - }, - "displayName" : { - "type" : "string", - "description" : "The display name of the allowable value" - }, - "description" : { - "type" : "string", - "description" : "The description of the allowable value" - } - } - }, - "Attribute" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The name of the attribute" - }, - "description" : { - "type" : "string", - "description" : "The description of the attribute" - } - } - }, - "BatchSize" : { - "type" : "object", - "properties" : { - "count" : { - "type" : "integer", - "format" : "int32", - "description" : "Preferred number of flow files to include in a transaction." - }, - "size" : { - "type" : "string", - "description" : "Preferred number of bytes to include in a transaction." - }, - "duration" : { - "type" : "string", - "description" : "Preferred amount of time that a transaction should span." - } - } - }, - "Bucket" : { - "type" : "object", - "required" : [ "name" ], - "properties" : { - "link" : { - "description" : "An WebLink to this entity.", - "readOnly" : true, - "$ref" : "#/definitions/JaxbLink" - }, - "identifier" : { - "type" : "string", - "description" : "An ID to uniquely identify this object.", - "readOnly" : true - }, - "name" : { - "type" : "string", - "description" : "The name of the bucket." - }, - "createdTimestamp" : { - "type" : "integer", - "format" : "int64", - "description" : "The timestamp of when the bucket was first created. This is set by the server at creation time.", - "readOnly" : true, - "minimum" : 1 - }, - "description" : { - "type" : "string", - "description" : "A description of the bucket." - }, - "allowBundleRedeploy" : { - "type" : "boolean", - "description" : "Indicates if this bucket allows the same version of an extension bundle to be redeployed and thus overwrite the existing artifact. By default this is false." - }, - "allowPublicRead" : { - "type" : "boolean", - "description" : "Indicates if this bucket allows read access to unauthenticated anonymous users" - }, - "permissions" : { - "description" : "The access that the current user has to this bucket.", - "readOnly" : true, - "$ref" : "#/definitions/Permissions" - }, - "revision" : { - "description" : "The revision of this entity used for optimistic-locking during updates.", - "readOnly" : true, - "$ref" : "#/definitions/RevisionInfo" - } - } - }, - "BucketItem" : { - "type" : "object", - "required" : [ "bucketIdentifier", "name", "type" ], - "properties" : { - "link" : { - "description" : "An WebLink to this entity.", - "readOnly" : true, - "$ref" : "#/definitions/JaxbLink" - }, - "identifier" : { - "type" : "string", - "description" : "An ID to uniquely identify this object.", - "readOnly" : true - }, - "name" : { - "type" : "string", - "description" : "The name of the item." - }, - "description" : { - "type" : "string", - "description" : "A description of the item." - }, - "bucketIdentifier" : { - "type" : "string", - "description" : "The identifier of the bucket this items belongs to. This cannot be changed after the item is created." - }, - "bucketName" : { - "type" : "string", - "description" : "The name of the bucket this items belongs to.", - "readOnly" : true - }, - "createdTimestamp" : { - "type" : "integer", - "format" : "int64", - "description" : "The timestamp of when the item was created, as milliseconds since epoch.", - "readOnly" : true, - "minimum" : 1 - }, - "modifiedTimestamp" : { - "type" : "integer", - "format" : "int64", - "description" : "The timestamp of when the item was last modified, as milliseconds since epoch.", - "readOnly" : true, - "minimum" : 1 - }, - "type" : { - "type" : "string", - "description" : "The type of item.", - "enum" : [ "Flow", "Bundle" ] - }, - "permissions" : { - "description" : "The access that the current user has to the bucket containing this item.", - "readOnly" : true, - "$ref" : "#/definitions/Permissions" - } - } - }, - "BuildInfo" : { - "type" : "object", - "properties" : { - "buildTool" : { - "type" : "string", - "description" : "The tool used to build the version of the bundle" - }, - "buildFlags" : { - "type" : "string", - "description" : "The flags used to build the version of the bundle" - }, - "buildBranch" : { - "type" : "string", - "description" : "The branch used to build the version of the bundle" - }, - "buildTag" : { - "type" : "string", - "description" : "The tag used to build the version of the bundle" - }, - "buildRevision" : { - "type" : "string", - "description" : "The revision used to build the version of the bundle" - }, - "built" : { - "type" : "integer", - "format" : "int64", - "description" : "The timestamp the version of the bundle was built" - }, - "builtBy" : { - "type" : "string", - "description" : "The identity of the user that performed the build" - } - } - }, - "Bundle" : { - "type" : "object", - "properties" : { - "group" : { - "type" : "string", - "description" : "The group of the bundle" - }, - "artifact" : { - "type" : "string", - "description" : "The artifact of the bundle" - }, - "version" : { - "type" : "string", - "description" : "The version of the bundle" - } - } - }, - "BundleInfo" : { - "type" : "object", - "properties" : { - "bucketId" : { - "type" : "string", - "description" : "The id of the bucket where the bundle is located" - }, - "bucketName" : { - "type" : "string", - "description" : "The name of the bucket where the bundle is located" - }, - "bundleId" : { - "type" : "string", - "description" : "The id of the bundle" - }, - "bundleType" : { - "type" : "string", - "description" : "The type of bundle (i.e. a NiFi NAR vs MiNiFi CPP)", - "enum" : [ "NIFI_NAR", "MINIFI_CPP" ] - }, - "groupId" : { - "type" : "string", - "description" : "The group id of the bundle" - }, - "artifactId" : { - "type" : "string", - "description" : "The artifact id of the bundle" - }, - "version" : { - "type" : "string", - "description" : "The version of the bundle" - }, - "systemApiVersion" : { - "type" : "string", - "description" : "The version of the system API the bundle was built against" - } - } - }, - "BundleVersion" : { - "type" : "object", - "required" : [ "versionMetadata" ], - "properties" : { - "link" : { - "description" : "An WebLink to this entity.", - "readOnly" : true, - "$ref" : "#/definitions/JaxbLink" - }, - "versionMetadata" : { - "description" : "The metadata about this version of the extension bundle", - "$ref" : "#/definitions/BundleVersionMetadata" - }, - "dependencies" : { - "type" : "array", - "description" : "The set of other bundle versions that this version is dependent on", - "readOnly" : true, - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/BundleVersionDependency" - } - }, - "bundle" : { - "description" : "The bundle this version is for", - "readOnly" : true, - "$ref" : "#/definitions/ExtensionBundle" - }, - "bucket" : { - "description" : "The bucket that the extension bundle belongs to", - "$ref" : "#/definitions/Bucket" - }, - "filename" : { - "type" : "string" - } - } - }, - "BundleVersionDependency" : { - "type" : "object", - "properties" : { - "groupId" : { - "type" : "string", - "description" : "The group id of the bundle dependency" - }, - "artifactId" : { - "type" : "string", - "description" : "The artifact id of the bundle dependency" - }, - "version" : { - "type" : "string", - "description" : "The version of the bundle dependency" - } - } - }, - "BundleVersionMetadata" : { - "type" : "object", - "required" : [ "bucketId", "buildInfo", "contentSize", "sha256Supplied" ], - "properties" : { - "link" : { - "description" : "An WebLink to this entity.", - "readOnly" : true, - "$ref" : "#/definitions/JaxbLink" - }, - "id" : { - "type" : "string", - "description" : "The id of this version of the extension bundle" - }, - "bundleId" : { - "type" : "string", - "description" : "The id of the extension bundle this version is for" - }, - "bucketId" : { - "type" : "string", - "description" : "The id of the bucket the extension bundle belongs to" - }, - "groupId" : { - "type" : "string" - }, - "artifactId" : { - "type" : "string" - }, - "version" : { - "type" : "string", - "description" : "The version of the extension bundle" - }, - "timestamp" : { - "type" : "integer", - "format" : "int64", - "description" : "The timestamp of the create date of this version", - "minimum" : 1 - }, - "author" : { - "type" : "string", - "description" : "The identity that created this version" - }, - "description" : { - "type" : "string", - "description" : "The description for this version" - }, - "sha256" : { - "type" : "string", - "description" : "The hex representation of the SHA-256 digest of the binary content for this version" - }, - "sha256Supplied" : { - "type" : "boolean", - "description" : "Whether or not the client supplied a SHA-256 when uploading the bundle" - }, - "contentSize" : { - "type" : "integer", - "format" : "int64", - "description" : "The size of the binary content for this version in bytes", - "minimum" : 0 - }, - "systemApiVersion" : { - "type" : "string", - "description" : "The version of the system API that this bundle version was built against" - }, - "buildInfo" : { - "description" : "The build information about this version", - "$ref" : "#/definitions/BuildInfo" - } - } - }, - "ComponentDifference" : { - "type" : "object", - "properties" : { - "valueA" : { - "type" : "string", - "description" : "The earlier value from the difference." - }, - "valueB" : { - "type" : "string", - "description" : "The newer value from the difference." - }, - "changeDescription" : { - "type" : "string", - "description" : "The description of the change." - }, - "differenceType" : { - "type" : "string", - "description" : "The key to the difference." - }, - "differenceTypeDescription" : { - "type" : "string", - "description" : "The description of the change type." - } - } - }, - "ComponentDifferenceGroup" : { - "type" : "object", - "properties" : { - "componentId" : { - "type" : "string", - "description" : "The id of the component whose changes are grouped together." - }, - "componentName" : { - "type" : "string", - "description" : "The name of the component whose changes are grouped together." - }, - "componentType" : { - "type" : "string", - "description" : "The type of component these changes relate to." - }, - "processGroupId" : { - "type" : "string", - "description" : "The process group id for this component." - }, - "differences" : { - "type" : "array", - "description" : "The list of changes related to this component between the 2 versions.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ComponentDifference" - } - } - } - }, - "ConnectableComponent" : { - "type" : "object", - "required" : [ "groupId", "id", "type" ], - "properties" : { - "id" : { - "type" : "string", - "description" : "The id of the connectable component." - }, - "type" : { - "type" : "string", - "description" : "The type of component the connectable is.", - "enum" : [ "PROCESSOR", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "INPUT_PORT", "OUTPUT_PORT", "FUNNEL" ] - }, - "groupId" : { - "type" : "string", - "description" : "The id of the group that the connectable component resides in" - }, - "name" : { - "type" : "string", - "description" : "The name of the connectable component" - }, - "comments" : { - "type" : "string", - "description" : "The comments for the connectable component." - }, - "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" - } - } - }, - "ControllerServiceAPI" : { - "type" : "object", - "properties" : { - "type" : { - "type" : "string", - "description" : "The fully qualified name of the service interface." - }, - "bundle" : { - "description" : "The details of the artifact that bundled this service interface.", - "$ref" : "#/definitions/Bundle" - } - } - }, - "ControllerServiceDefinition" : { - "type" : "object", - "properties" : { - "className" : { - "type" : "string", - "description" : "The class name of the service API" - }, - "groupId" : { - "type" : "string", - "description" : "The group id of the service API" - }, - "artifactId" : { - "type" : "string", - "description" : "The artifact id of the service API" - }, - "version" : { - "type" : "string", - "description" : "The version of the service API" - } - } - }, - "CurrentUser" : { - "type" : "object", - "properties" : { - "identity" : { - "type" : "string", - "description" : "The identity of the current user", - "readOnly" : true - }, - "anonymous" : { - "type" : "boolean", - "description" : "Indicates if the current user is anonymous", - "readOnly" : true - }, - "loginSupported" : { - "type" : "boolean", - "description" : "Indicates if the NiFi Registry instance supports logging in" - }, - "resourcePermissions" : { - "description" : "The access that the current user has to top level resources", - "readOnly" : true, - "$ref" : "#/definitions/ResourcePermissions" - }, - "oidcloginSupported" : { - "type" : "boolean", - "description" : "Indicates if the NiFi Registry instance supports logging in with an OIDC provider" - } - } - }, - "DefaultSchedule" : { - "type" : "object", - "properties" : { - "strategy" : { - "type" : "string", - "description" : "The default scheduling strategy" - }, - "period" : { - "type" : "string", - "description" : "The default scheduling period" - }, - "concurrentTasks" : { - "type" : "string", - "description" : "The default concurrent tasks" - } - } - }, - "DefaultSettings" : { - "type" : "object", - "properties" : { - "yieldDuration" : { - "type" : "string", - "description" : "The default yield duration" - }, - "penaltyDuration" : { - "type" : "string", - "description" : "The default penalty duration" - }, - "bulletinLevel" : { - "type" : "string", - "description" : "The default bulletin level" - } - } - }, - "Dependency" : { - "type" : "object", - "properties" : { - "propertyName" : { - "type" : "string", - "description" : "The name of the dependent property" - }, - "propertyDisplayName" : { - "type" : "string", - "description" : "The display name of the dependent property" - }, - "dependentValues" : { - "description" : "The values of the dependent property that enable the depending property", - "$ref" : "#/definitions/DependentValues" - } - } - }, - "DependentValues" : { - "type" : "object", - "properties" : { - "values" : { - "type" : "array", - "xml" : { - "name" : "dependentValue" - }, - "description" : "The dependent values", - "items" : { - "type" : "string", - "xml" : { - "name" : "dependentValue" - } - } - } - } - }, - "DeprecationNotice" : { - "type" : "object", - "properties" : { - "reason" : { - "type" : "string", - "description" : "The reason for the deprecation" - }, - "alternatives" : { - "type" : "array", - "xml" : { - "wrapped" : true - }, - "description" : "The alternatives to use", - "items" : { - "type" : "string", - "xml" : { - "name" : "alternative" - } - } - } - } - }, - "DynamicProperty" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The description of the dynamic property name" - }, - "value" : { - "type" : "string", - "description" : "The description of the dynamic property value" - }, - "description" : { - "type" : "string", - "description" : "The description of the dynamic property" - }, - "expressionLanguageScope" : { - "type" : "string", - "description" : "The scope of the expression language support", - "enum" : [ "NONE", "VARIABLE_REGISTRY", "FLOWFILE_ATTRIBUTES" ] - }, - "expressionLanguageSupported" : { - "type" : "boolean", - "description" : "Whether or not expression language is supported" - } - } - }, - "DynamicRelationship" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The description of the dynamic relationship name" - }, - "description" : { - "type" : "string", - "description" : "The description of the dynamic relationship" - } - } - }, - "Extension" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The name of the extension" - }, - "type" : { - "type" : "string", - "description" : "The type of the extension", - "enum" : [ "PROCESSOR", "CONTROLLER_SERVICE", "REPORTING_TASK" ] - }, - "deprecationNotice" : { - "description" : "The deprecation notice of the extension", - "$ref" : "#/definitions/DeprecationNotice" - }, - "description" : { - "type" : "string", - "description" : "The description of the extension" - }, - "tags" : { - "type" : "array", - "xml" : { - "wrapped" : true - }, - "description" : "The tags of the extension", - "items" : { - "type" : "string", - "xml" : { - "name" : "tag" - } - } - }, - "properties" : { - "type" : "array", - "xml" : { - "wrapped" : true - }, - "description" : "The properties of the extension", - "items" : { - "xml" : { - "name" : "property" - }, - "$ref" : "#/definitions/Property" - } - }, - "supportsSensitiveDynamicProperties" : { - "type" : "boolean" - }, - "dynamicProperties" : { - "type" : "array", - "xml" : { - "wrapped" : true - }, - "description" : "The dynamic properties of the extension", - "items" : { - "xml" : { - "name" : "dynamicProperty" - }, - "$ref" : "#/definitions/DynamicProperty" - } - }, - "relationships" : { - "type" : "array", - "xml" : { - "wrapped" : true - }, - "description" : "The relationships of the extension", - "items" : { - "xml" : { - "name" : "relationship" - }, - "$ref" : "#/definitions/Relationship" - } - }, - "dynamicRelationship" : { - "description" : "The dynamic relationships of the extension", - "$ref" : "#/definitions/DynamicRelationship" - }, - "readsAttributes" : { - "type" : "array", - "xml" : { - "wrapped" : true - }, - "description" : "The attributes read from flow files by the extension", - "items" : { - "xml" : { - "name" : "readsAttribute" - }, - "$ref" : "#/definitions/Attribute" - } - }, - "writesAttributes" : { - "type" : "array", - "xml" : { - "wrapped" : true - }, - "description" : "The attributes written to flow files by the extension", - "items" : { - "xml" : { - "name" : "writesAttribute" - }, - "$ref" : "#/definitions/Attribute" - } - }, - "stateful" : { - "description" : "The information about how the extension stores state", - "$ref" : "#/definitions/Stateful" - }, - "restricted" : { - "description" : "The restrictions of the extension", - "$ref" : "#/definitions/Restricted" - }, - "inputRequirement" : { - "type" : "string", - "description" : "The input requirement of the extension", - "enum" : [ "INPUT_REQUIRED", "INPUT_ALLOWED", "INPUT_FORBIDDEN" ] - }, - "systemResourceConsiderations" : { - "type" : "array", - "xml" : { - "wrapped" : true - }, - "description" : "The resource considerations of the extension", - "items" : { - "xml" : { - "name" : "systemResourceConsideration" - }, - "$ref" : "#/definitions/SystemResourceConsideration" - } - }, - "seeAlso" : { - "type" : "array", - "xml" : { - "wrapped" : true - }, - "description" : "The names of other extensions to see", - "items" : { - "type" : "string", - "xml" : { - "name" : "see" - } - } - }, - "providedServiceAPIs" : { - "type" : "array", - "xml" : { - "wrapped" : true - }, - "description" : "The service APIs provided by this extension", - "items" : { - "xml" : { - "name" : "providedServiceAPI" - }, - "$ref" : "#/definitions/ProvidedServiceAPI" - } - }, - "defaultSettings" : { - "description" : "The default settings for a processor", - "$ref" : "#/definitions/DefaultSettings" - }, - "defaultSchedule" : { - "description" : "The default schedule for a processor reporting task", - "$ref" : "#/definitions/DefaultSchedule" - }, - "triggerSerially" : { - "type" : "boolean", - "description" : "Indicates that a processor should be triggered serially" - }, - "triggerWhenEmpty" : { - "type" : "boolean", - "description" : "Indicates that a processor should be triggered when the incoming queues are empty" - }, - "triggerWhenAnyDestinationAvailable" : { - "type" : "boolean", - "description" : "Indicates that a processor should be triggered when any destinations have space for flow files" - }, - "supportsBatching" : { - "type" : "boolean", - "description" : "Indicates that a processor supports batching" - }, - "eventDriven" : { - "type" : "boolean", - "description" : "Indicates that a processor supports event driven scheduling" - }, - "primaryNodeOnly" : { - "type" : "boolean", - "description" : "Indicates that a processor should be scheduled only on the primary node" - }, - "sideEffectFree" : { - "type" : "boolean", - "description" : "Indicates that a processor is side effect free" - } - } - }, - "ExtensionBundle" : { - "type" : "object", - "required" : [ "bucketIdentifier", "bundleType", "name", "type" ], - "properties" : { - "link" : { - "description" : "An WebLink to this entity.", - "readOnly" : true, - "$ref" : "#/definitions/JaxbLink" - }, - "identifier" : { - "type" : "string", - "description" : "An ID to uniquely identify this object.", - "readOnly" : true - }, - "name" : { - "type" : "string", - "description" : "The name of the item." - }, - "description" : { - "type" : "string", - "description" : "A description of the item." - }, - "bucketIdentifier" : { - "type" : "string", - "description" : "The identifier of the bucket this items belongs to. This cannot be changed after the item is created." - }, - "bucketName" : { - "type" : "string", - "description" : "The name of the bucket this items belongs to.", - "readOnly" : true - }, - "createdTimestamp" : { - "type" : "integer", - "format" : "int64", - "description" : "The timestamp of when the item was created, as milliseconds since epoch.", - "readOnly" : true, - "minimum" : 1 - }, - "modifiedTimestamp" : { - "type" : "integer", - "format" : "int64", - "description" : "The timestamp of when the item was last modified, as milliseconds since epoch.", - "readOnly" : true, - "minimum" : 1 - }, - "type" : { - "type" : "string", - "description" : "The type of item.", - "enum" : [ "Flow", "Bundle" ] - }, - "permissions" : { - "description" : "The access that the current user has to the bucket containing this item.", - "readOnly" : true, - "$ref" : "#/definitions/Permissions" - }, - "bundleType" : { - "type" : "string", - "description" : "The type of the extension bundle", - "enum" : [ "NIFI_NAR", "MINIFI_CPP" ] - }, - "groupId" : { - "type" : "string", - "description" : "The group id of the extension bundle" - }, - "artifactId" : { - "type" : "string", - "description" : "The artifact id of the extension bundle" - }, - "versionCount" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of versions of this extension bundle.", - "readOnly" : true, - "minimum" : 0 - } - } - }, - "ExtensionFilterParams" : { - "type" : "object", - "properties" : { - "bundleType" : { - "type" : "string", - "description" : "The type of bundle", - "enum" : [ "NIFI_NAR", "MINIFI_CPP" ] - }, - "extensionType" : { - "type" : "string", - "description" : "The type of extension", - "enum" : [ "PROCESSOR", "CONTROLLER_SERVICE", "REPORTING_TASK" ] - }, - "tags" : { - "type" : "array", - "description" : "The tags", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - } - } - }, - "ExtensionMetadata" : { - "type" : "object", - "properties" : { - "link" : { - "description" : "An WebLink to this entity.", - "readOnly" : true, - "$ref" : "#/definitions/JaxbLink" - }, - "name" : { - "type" : "string", - "description" : "The name of the extension" - }, - "displayName" : { - "type" : "string", - "description" : "The display name of the extension" - }, - "type" : { - "type" : "string", - "description" : "The type of the extension", - "enum" : [ "PROCESSOR", "CONTROLLER_SERVICE", "REPORTING_TASK" ] - }, - "description" : { - "type" : "string", - "description" : "The description of the extension" - }, - "deprecationNotice" : { - "description" : "The deprecation notice of the extension", - "$ref" : "#/definitions/DeprecationNotice" - }, - "tags" : { - "type" : "array", - "description" : "The tags of the extension", - "items" : { - "type" : "string" - } - }, - "restricted" : { - "description" : "The restrictions of the extension", - "$ref" : "#/definitions/Restricted" - }, - "providedServiceAPIs" : { - "type" : "array", - "description" : "The service APIs provided by the extension", - "items" : { - "$ref" : "#/definitions/ProvidedServiceAPI" - } - }, - "bundleInfo" : { - "description" : "The information for the bundle where this extension is located", - "$ref" : "#/definitions/BundleInfo" - }, - "hasAdditionalDetails" : { - "type" : "boolean", - "description" : "Whether or not the extension has additional detail documentation" - }, - "linkDocs" : { - "description" : "A WebLink to the documentation for this extension.", - "readOnly" : true, - "$ref" : "#/definitions/JaxbLink" - } - } - }, - "ExtensionMetadataContainer" : { - "type" : "object", - "properties" : { - "numResults" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of extensions in the response" - }, - "filterParams" : { - "description" : "The filter parameters submitted for the request", - "$ref" : "#/definitions/ExtensionFilterParams" - }, - "extensions" : { - "type" : "array", - "description" : "The metadata for the extensions", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ExtensionMetadata" - } - } - } - }, - "ExtensionRepoArtifact" : { - "type" : "object", - "properties" : { - "link" : { - "description" : "An WebLink to this entity.", - "readOnly" : true, - "$ref" : "#/definitions/JaxbLink" - }, - "bucketName" : { - "type" : "string", - "description" : "The bucket name" - }, - "groupId" : { - "type" : "string", - "description" : "The group id" - }, - "artifactId" : { - "type" : "string", - "description" : "The artifact id" - } - } - }, - "ExtensionRepoBucket" : { - "type" : "object", - "properties" : { - "link" : { - "description" : "An WebLink to this entity.", - "readOnly" : true, - "$ref" : "#/definitions/JaxbLink" - }, - "bucketName" : { - "type" : "string", - "description" : "The name of the bucket" - } - } - }, - "ExtensionRepoGroup" : { - "type" : "object", - "properties" : { - "link" : { - "description" : "An WebLink to this entity.", - "readOnly" : true, - "$ref" : "#/definitions/JaxbLink" - }, - "bucketName" : { - "type" : "string", - "description" : "The bucket name" - }, - "groupId" : { - "type" : "string", - "description" : "The group id" - } - } - }, - "ExtensionRepoVersion" : { - "type" : "object", - "properties" : { - "extensionsLink" : { - "description" : "The WebLink to view the metadata about the extensions contained in the extension bundle.", - "readOnly" : true, - "$ref" : "#/definitions/JaxbLink" - }, - "downloadLink" : { - "description" : "The WebLink to download this version of the extension bundle.", - "readOnly" : true, - "$ref" : "#/definitions/JaxbLink" - }, - "sha256Link" : { - "description" : "The WebLink to retrieve the SHA-256 digest for this version of the extension bundle.", - "readOnly" : true, - "$ref" : "#/definitions/JaxbLink" - }, - "sha256Supplied" : { - "description" : "Indicates if the client supplied a SHA-256 when uploading this version of the extension bundle.", - "readOnly" : true, - "$ref" : "#/definitions/JaxbLink" - } - } - }, - "ExtensionRepoVersionSummary" : { - "type" : "object", - "properties" : { - "link" : { - "description" : "An WebLink to this entity.", - "readOnly" : true, - "$ref" : "#/definitions/JaxbLink" - }, - "bucketName" : { - "type" : "string", - "description" : "The bucket name" - }, - "groupId" : { - "type" : "string", - "description" : "The group id" - }, - "artifactId" : { - "type" : "string", - "description" : "The artifact id" - }, - "version" : { - "type" : "string", - "description" : "The version" - }, - "author" : { - "type" : "string", - "description" : "The identity of the user that created this version" - }, - "timestamp" : { - "type" : "integer", - "format" : "int64", - "description" : "The timestamp of when this version was created" - } - } - }, - "ExternalControllerServiceReference" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The identifier of the controller service" - }, - "name" : { - "type" : "string", - "description" : "The name of the controller service" - } - } - }, - "Fields" : { - "type" : "object", - "properties" : { - "fields" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - } - } - }, - "JaxbLink" : { - "type" : "object", - "properties" : { - "href" : { - "type" : "string", - "format" : "uri", - "xml" : { - "attribute" : true - }, - "description" : "The href for the link" - }, - "params" : { - "type" : "object", - "description" : "The params for the link", - "additionalProperties" : { - "type" : "string" - } - } - } - }, - "ParameterProviderReference" : { - "type" : "object", - "properties" : { - "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." - }, - "bundle" : { - "description" : "The details of the artifact that bundled this parameter provider.", - "$ref" : "#/definitions/Bundle" - } - } - }, - "Permissions" : { - "type" : "object", - "properties" : { - "canRead" : { - "type" : "boolean", - "description" : "Indicates whether the user can read a given resource.", - "readOnly" : true - }, - "canWrite" : { - "type" : "boolean", - "description" : "Indicates whether the user can write a given resource.", - "readOnly" : true - }, - "canDelete" : { - "type" : "boolean", - "description" : "Indicates whether the user can delete a given resource.", - "readOnly" : true - } - } - }, - "Position" : { - "type" : "object", - "properties" : { - "x" : { - "type" : "number", - "format" : "double", - "description" : "The x coordinate." - }, - "y" : { - "type" : "number", - "format" : "double", - "description" : "The y coordinate." - } - }, - "description" : "The position of a component on the graph" - }, - "Property" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The name of the property" - }, - "displayName" : { - "type" : "string", - "description" : "The display name" - }, - "description" : { - "type" : "string", - "description" : "The description" - }, - "defaultValue" : { - "type" : "string", - "description" : "The default value" - }, - "controllerServiceDefinition" : { - "description" : "The controller service required by this property, or null if none is required", - "$ref" : "#/definitions/ControllerServiceDefinition" - }, - "allowableValues" : { - "type" : "array", - "xml" : { - "wrapped" : true - }, - "description" : "The allowable values for this property", - "items" : { - "xml" : { - "name" : "allowableValue" - }, - "$ref" : "#/definitions/AllowableValue" - } - }, - "required" : { - "type" : "boolean", - "description" : "Whether or not the property is required" - }, - "sensitive" : { - "type" : "boolean", - "description" : "Whether or not the property is sensitive" - }, - "expressionLanguageSupported" : { - "type" : "boolean", - "description" : "Whether or not expression language is supported" - }, - "expressionLanguageScope" : { - "type" : "string", - "description" : "The scope of expression language support", - "enum" : [ "NONE", "VARIABLE_REGISTRY", "FLOWFILE_ATTRIBUTES" ] - }, - "dynamicallyModifiesClasspath" : { - "type" : "boolean", - "description" : "Whether or not the processor dynamically modifies the classpath" - }, - "dynamic" : { - "type" : "boolean", - "description" : "Whether or not the processor is dynamic" - }, - "dependencies" : { - "type" : "array", - "xml" : { - "wrapped" : true - }, - "description" : "The properties that this property depends on", - "items" : { - "xml" : { - "name" : "dependency" - }, - "$ref" : "#/definitions/Dependency" - } - }, - "resourceDefinition" : { - "description" : "The optional resource definition", - "$ref" : "#/definitions/ResourceDefinition" - } - } - }, - "ProvidedServiceAPI" : { - "type" : "object", - "properties" : { - "className" : { - "type" : "string", - "description" : "The class name of the service API being provided" - }, - "groupId" : { - "type" : "string", - "description" : "The group id of the service API being provided" - }, - "artifactId" : { - "type" : "string", - "description" : "The artifact id of the service API being provided" - }, - "version" : { - "type" : "string", - "description" : "The version of the service API being provided" - } - } - }, - "RegistryAbout" : { - "type" : "object", - "properties" : { - "registryAboutVersion" : { - "type" : "string", - "description" : "The version string for this Nifi Registry", - "readOnly" : true - } - } - }, - "RegistryConfiguration" : { - "type" : "object", - "properties" : { - "supportsManagedAuthorizer" : { - "type" : "boolean", - "description" : "Whether this NiFi Registry supports a managed authorizer. Managed authorizers can visualize users, groups, and policies in the UI.", - "readOnly" : true - }, - "supportsConfigurableAuthorizer" : { - "type" : "boolean", - "description" : "Whether this NiFi Registry supports a configurable authorizer.", - "readOnly" : true - }, - "supportsConfigurableUsersAndGroups" : { - "type" : "boolean", - "description" : "Whether this NiFi Registry supports configurable users and groups.", - "readOnly" : true - } - } - }, - "Relationship" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The name of the relationship" - }, - "description" : { - "type" : "string", - "description" : "The description of the relationship" - }, - "autoTerminated" : { - "type" : "boolean", - "description" : "Whether or not the relationship is auto-terminated by default" - } - } - }, - "Resource" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The identifier of the resource.", - "readOnly" : true - }, - "name" : { - "type" : "string", - "description" : "The name of the resource.", - "readOnly" : true - } - } - }, - "ResourceDefinition" : { - "type" : "object", - "properties" : { - "cardinality" : { - "type" : "string", - "description" : "The cardinality of the resource definition", - "enum" : [ "SINGLE", "MULTIPLE" ] - }, - "resourceTypes" : { - "type" : "array", - "xml" : { - "wrapped" : true - }, - "description" : "The types of resources", - "items" : { - "type" : "string", - "xml" : { - "name" : "resourceType" - }, - "enum" : [ "FILE", "DIRECTORY", "TEXT", "URL" ] - } - } - } - }, - "ResourcePermissions" : { - "type" : "object", - "properties" : { - "buckets" : { - "description" : "The access that the current user has to the top level /buckets resource of this NiFi Registry (i.e., access to all buckets)", - "readOnly" : true, - "$ref" : "#/definitions/Permissions" - }, - "tenants" : { - "description" : "The access that the current user has to the top level /tenants resource of this NiFi Registry", - "readOnly" : true, - "$ref" : "#/definitions/Permissions" - }, - "policies" : { - "description" : "The access that the current user has to the top level /policies resource of this NiFi Registry", - "readOnly" : true, - "$ref" : "#/definitions/Permissions" - }, - "proxy" : { - "description" : "The access that the current user has to the top level /proxy resource of this NiFi Registry", - "readOnly" : true, - "$ref" : "#/definitions/Permissions" - }, - "anyTopLevelResource" : { - "description" : "The access that the current user has to any top level resources (a logical 'OR' of all other values)", - "readOnly" : true, - "$ref" : "#/definitions/Permissions" - } - } - }, - "Restricted" : { - "type" : "object", - "properties" : { - "generalRestrictionExplanation" : { - "type" : "string", - "description" : "The general restriction for the extension, or null if only specific restrictions exist" - }, - "restrictions" : { - "type" : "array", - "xml" : { - "wrapped" : true - }, - "description" : "The specific restrictions", - "items" : { - "xml" : { - "name" : "restriction" - }, - "$ref" : "#/definitions/Restriction" - } - } - } - }, - "Restriction" : { - "type" : "object", - "properties" : { - "requiredPermission" : { - "type" : "string", - "description" : "The permission required for this restriction" - }, - "explanation" : { - "type" : "string", - "description" : "The explanation of this restriction" - } - } - }, - "RevisionInfo" : { - "type" : "object", - "properties" : { - "clientId" : { - "type" : "string", - "description" : "A client identifier used to make a request. By including a client identifier, the API can allow multiple requests without needing the current revision. Due to the asynchronous nature of requests/responses this was implemented to allow the client to make numerous requests without having to wait for the previous response to come back." - }, - "version" : { - "type" : "integer", - "format" : "int64", - "description" : "NiFi Registry employs an optimistic locking strategy where the client must include a revision in their request when performing an update. In a response to a mutable flow request, this field represents the updated base version." - }, - "lastModifier" : { - "type" : "string", - "description" : "The user that last modified the entity.", - "readOnly" : true - } - }, - "description" : "The revision information for an entity managed through the REST API." - }, - "Stateful" : { - "type" : "object", - "properties" : { - "description" : { - "type" : "string", - "description" : "The description for how the extension stores state" - }, - "scopes" : { - "type" : "array", - "xml" : { - "wrapped" : true - }, - "description" : "The scopes used to store state", - "items" : { - "type" : "string", - "xml" : { - "name" : "scope" - }, - "enum" : [ "CLUSTER", "LOCAL" ] - } - } - } - }, - "SystemResourceConsideration" : { - "type" : "object", - "properties" : { - "resource" : { - "type" : "string", - "description" : "The resource to consider" - }, - "description" : { - "type" : "string", - "description" : "The description of how the resource is affected" - } - } - }, - "TagCount" : { - "type" : "object", - "properties" : { - "tag" : { - "type" : "string", - "description" : "The tag label" - }, - "count" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of occurrences of the given tag" - } - } - }, - "Tenant" : { - "type" : "object", - "required" : [ "identity" ], - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The computer-generated identifier of the tenant.", - "readOnly" : true - }, - "identity" : { - "type" : "string", - "description" : "The human-facing identity of the tenant. This can only be changed if the tenant is configurable." - }, - "configurable" : { - "type" : "boolean", - "description" : "Indicates if this tenant is configurable, based on which UserGroupProvider has been configured to manage it.", - "readOnly" : true - }, - "resourcePermissions" : { - "description" : "A summary top-level resource access policies granted to this tenant.", - "readOnly" : true, - "$ref" : "#/definitions/ResourcePermissions" - }, - "accessPolicies" : { - "type" : "array", - "description" : "The access policies granted to this tenant.", - "readOnly" : true, - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/AccessPolicySummary" - } - }, - "revision" : { - "description" : "The revision of this entity used for optimistic-locking during updates.", - "readOnly" : true, - "$ref" : "#/definitions/RevisionInfo" - } - } - }, - "User" : { - "type" : "object", - "required" : [ "identity" ], - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The computer-generated identifier of the tenant.", - "readOnly" : true - }, - "identity" : { - "type" : "string", - "description" : "The human-facing identity of the tenant. This can only be changed if the tenant is configurable." - }, - "configurable" : { - "type" : "boolean", - "description" : "Indicates if this tenant is configurable, based on which UserGroupProvider has been configured to manage it.", - "readOnly" : true - }, - "resourcePermissions" : { - "description" : "A summary top-level resource access policies granted to this tenant.", - "readOnly" : true, - "$ref" : "#/definitions/ResourcePermissions" - }, - "accessPolicies" : { - "type" : "array", - "description" : "The access policies granted to this tenant.", - "readOnly" : true, - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/AccessPolicySummary" - } - }, - "revision" : { - "description" : "The revision of this entity used for optimistic-locking during updates.", - "readOnly" : true, - "$ref" : "#/definitions/RevisionInfo" - }, - "userGroups" : { - "type" : "array", - "description" : "The groups to which the user belongs.", - "readOnly" : true, - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/Tenant" - } - } - } - }, - "UserGroup" : { - "type" : "object", - "required" : [ "identity" ], - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The computer-generated identifier of the tenant.", - "readOnly" : true - }, - "identity" : { - "type" : "string", - "description" : "The human-facing identity of the tenant. This can only be changed if the tenant is configurable." - }, - "configurable" : { - "type" : "boolean", - "description" : "Indicates if this tenant is configurable, based on which UserGroupProvider has been configured to manage it.", - "readOnly" : true - }, - "resourcePermissions" : { - "description" : "A summary top-level resource access policies granted to this tenant.", - "readOnly" : true, - "$ref" : "#/definitions/ResourcePermissions" - }, - "accessPolicies" : { - "type" : "array", - "description" : "The access policies granted to this tenant.", - "readOnly" : true, - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/AccessPolicySummary" - } - }, - "revision" : { - "description" : "The revision of this entity used for optimistic-locking during updates.", - "readOnly" : true, - "$ref" : "#/definitions/RevisionInfo" - }, - "users" : { - "type" : "array", - "description" : "The users that belong to this user group. This can only be changed if this group is configurable.", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/Tenant" - } - } - } - }, - "VersionedConnection" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The component's unique identifier" - }, - "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" - }, - "comments" : { - "type" : "string", - "description" : "The user-supplied comments for the component" - }, - "position" : { - "description" : "The component's position on the graph", - "$ref" : "#/definitions/Position" - }, - "source" : { - "description" : "The source of the connection.", - "$ref" : "#/definitions/ConnectableComponent" - }, - "destination" : { - "description" : "The destination of the connection.", - "$ref" : "#/definitions/ConnectableComponent" - }, - "labelIndex" : { - "type" : "integer", - "format" : "int32", - "description" : "The index of the bend point where to place the connection label." - }, - "zIndex" : { - "type" : "integer", - "format" : "int64", - "description" : "The z index of the connection." - }, - "selectedRelationships" : { - "type" : "array", - "description" : "The selected relationship that comprise the connection.", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - }, - "backPressureObjectThreshold" : { - "type" : "integer", - "format" : "int64", - "description" : "The object count threshold for determining when back pressure is applied. Updating this value is a passive change in the sense that it won't impact whether existing files over the limit are affected but it does help feeder processors to stop pushing too much into this work queue." - }, - "backPressureDataSizeThreshold" : { - "type" : "string", - "description" : "The object data size threshold for determining when back pressure is applied. Updating this value is a passive change in the sense that it won't impact whether existing files over the limit are affected but it does help feeder processors to stop pushing too much into this work queue." - }, - "flowFileExpiration" : { - "type" : "string", - "description" : "The amount of time a flow file may be in the flow before it will be automatically aged out of the flow. Once a flow file reaches this age it will be terminated from the flow the next time a processor attempts to start work on it." - }, - "prioritizers" : { - "type" : "array", - "description" : "The comparators used to prioritize the queue.", - "items" : { - "type" : "string" - } - }, - "bends" : { - "type" : "array", - "description" : "The bend points on the connection.", - "items" : { - "$ref" : "#/definitions/Position" - } - }, - "loadBalanceStrategy" : { - "type" : "string", - "description" : "The Strategy to use for load balancing data across the cluster, or null, if no Load Balance Strategy has been specified.", - "enum" : [ "DO_NOT_LOAD_BALANCE", "PARTITION_BY_ATTRIBUTE", "ROUND_ROBIN", "SINGLE_NODE" ] - }, - "partitioningAttribute" : { - "type" : "string", - "description" : "The attribute to use for partitioning data as it is load balanced across the cluster. If the Load Balance Strategy is configured to use PARTITION_BY_ATTRIBUTE, the value returned by this method is the name of the FlowFile Attribute that will be used to determine which node in the cluster should receive a given FlowFile. If the Load Balance Strategy is unset or is set to any other value, the Partitioning Attribute has no effect." - }, - "loadBalanceCompression" : { - "type" : "string", - "description" : "Whether or not compression should be used when transferring FlowFiles between nodes", - "enum" : [ "DO_NOT_COMPRESS", "COMPRESS_ATTRIBUTES_ONLY", "COMPRESS_ATTRIBUTES_AND_CONTENT" ] - }, - "componentType" : { - "type" : "string", - "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE", "REPORTING_TASK", "PARAMETER_CONTEXT", "PARAMETER_PROVIDER", "TEMPLATE", "FLOW_REGISTRY_CLIENT" ] - }, - "groupIdentifier" : { - "type" : "string", - "description" : "The ID of the Process Group that this component belongs to" - } - } - }, - "VersionedControllerService" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The component's unique identifier" - }, - "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" - }, - "comments" : { - "type" : "string", - "description" : "The user-supplied comments for the component" - }, - "position" : { - "description" : "The component's position on the graph", - "$ref" : "#/definitions/Position" - }, - "type" : { - "type" : "string", - "description" : "The type of the extension component" - }, - "bundle" : { - "description" : "Information about the bundle from which the component came", - "$ref" : "#/definitions/Bundle" - }, - "properties" : { - "type" : "object", - "description" : "The properties for the component. Properties whose value is not set will only contain the property name.", - "additionalProperties" : { - "type" : "string" - } - }, - "propertyDescriptors" : { - "type" : "object", - "description" : "The property descriptors for the component.", - "additionalProperties" : { - "$ref" : "#/definitions/VersionedPropertyDescriptor" - } - }, - "controllerServiceApis" : { - "type" : "array", - "description" : "Lists the APIs this Controller Service implements.", - "items" : { - "$ref" : "#/definitions/ControllerServiceAPI" - } - }, - "annotationData" : { - "type" : "string", - "description" : "The annotation for the controller service. This is how the custom UI relays configuration to the controller service." - }, - "scheduledState" : { - "type" : "string", - "description" : "The ScheduledState denoting whether the Controller Service is ENABLED or DISABLED", - "enum" : [ "ENABLED", "DISABLED", "RUNNING" ] - }, - "bulletinLevel" : { - "type" : "string", - "description" : "The level at which the controller service will report bulletins." - }, - "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", "PARAMETER_CONTEXT", "PARAMETER_PROVIDER", "TEMPLATE", "FLOW_REGISTRY_CLIENT" ] - }, - "groupIdentifier" : { - "type" : "string", - "description" : "The ID of the Process Group that this component belongs to" - } - } - }, - "VersionedFlow" : { - "type" : "object", - "required" : [ "bucketIdentifier", "name", "type" ], - "properties" : { - "link" : { - "description" : "An WebLink to this entity.", - "readOnly" : true, - "$ref" : "#/definitions/JaxbLink" - }, - "identifier" : { - "type" : "string", - "description" : "An ID to uniquely identify this object.", - "readOnly" : true - }, - "name" : { - "type" : "string", - "description" : "The name of the item." - }, - "description" : { - "type" : "string", - "description" : "A description of the item." - }, - "bucketIdentifier" : { - "type" : "string", - "description" : "The identifier of the bucket this items belongs to. This cannot be changed after the item is created." - }, - "bucketName" : { - "type" : "string", - "description" : "The name of the bucket this items belongs to.", - "readOnly" : true - }, - "createdTimestamp" : { - "type" : "integer", - "format" : "int64", - "description" : "The timestamp of when the item was created, as milliseconds since epoch.", - "readOnly" : true, - "minimum" : 1 - }, - "modifiedTimestamp" : { - "type" : "integer", - "format" : "int64", - "description" : "The timestamp of when the item was last modified, as milliseconds since epoch.", - "readOnly" : true, - "minimum" : 1 - }, - "type" : { - "type" : "string", - "description" : "The type of item.", - "enum" : [ "Flow", "Bundle" ] - }, - "permissions" : { - "description" : "The access that the current user has to the bucket containing this item.", - "readOnly" : true, - "$ref" : "#/definitions/Permissions" - }, - "versionCount" : { - "type" : "integer", - "format" : "int64", - "description" : "The number of versions of this flow.", - "readOnly" : true, - "minimum" : 0 - }, - "revision" : { - "description" : "The revision of this entity used for optimistic-locking during updates.", - "readOnly" : true, - "$ref" : "#/definitions/RevisionInfo" - } - } - }, - "VersionedFlowCoordinates" : { - "type" : "object", - "properties" : { - "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" - }, - "registryUrl" : { - "type" : "string", - "description" : "The URL of the Flow Registry that contains the flow" - }, - "bucketId" : { - "type" : "string", - "description" : "The UUID of the bucket that the flow resides in" - }, - "flowId" : { - "type" : "string", - "description" : "The UUID of the flow" - }, - "version" : { - "type" : "integer", - "format" : "int32", - "description" : "The version of the flow" - }, - "latest" : { - "type" : "boolean", - "description" : "Whether or not these coordinates point to the latest version of the flow" - } - } - }, - "VersionedFlowDifference" : { - "type" : "object", - "properties" : { - "bucketId" : { - "type" : "string", - "description" : "The id of the bucket that the flow is stored in." - }, - "flowId" : { - "type" : "string", - "description" : "The id of the flow that is being examined." - }, - "versionA" : { - "type" : "integer", - "format" : "int32", - "description" : "The earlier version from the diff operation." - }, - "versionB" : { - "type" : "integer", - "format" : "int32", - "description" : "The latter version from the diff operation." - }, - "componentDifferenceGroups" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ComponentDifferenceGroup" - } - } - } - }, - "VersionedFlowSnapshot" : { - "type" : "object", - "required" : [ "flowContents", "snapshotMetadata" ], - "properties" : { - "snapshotMetadata" : { - "description" : "The metadata for this snapshot", - "$ref" : "#/definitions/VersionedFlowSnapshotMetadata" - }, - "flowContents" : { - "description" : "The contents of the versioned flow", - "$ref" : "#/definitions/VersionedProcessGroup" - }, - "externalControllerServices" : { - "type" : "object", - "description" : "The information about controller services that exist outside this versioned flow, but are referenced by components within the versioned flow.", - "additionalProperties" : { - "$ref" : "#/definitions/ExternalControllerServiceReference" - } - }, - "parameterProviders" : { - "type" : "object", - "description" : "Contains basic information about parameter providers referenced in the versioned flow.", - "additionalProperties" : { - "$ref" : "#/definitions/ParameterProviderReference" - } - }, - "parameterContexts" : { - "type" : "object", - "description" : "The parameter contexts referenced by process groups in the flow contents. The mapping is from the name of the context to the context instance, and it is expected that any context in this map is referenced by at least one process group in this flow.", - "additionalProperties" : { - "$ref" : "#/definitions/VersionedParameterContext" - } - }, - "flowEncodingVersion" : { - "type" : "string", - "description" : "The optional encoding version of the flow contents." - }, - "flow" : { - "description" : "The flow this snapshot is for", - "readOnly" : true, - "$ref" : "#/definitions/VersionedFlow" - }, - "bucket" : { - "description" : "The bucket where the flow is located", - "readOnly" : true, - "$ref" : "#/definitions/Bucket" - }, - "latest" : { - "type" : "boolean" - } - } - }, - "VersionedFlowSnapshotMetadata" : { - "type" : "object", - "required" : [ "bucketIdentifier", "flowIdentifier", "version" ], - "properties" : { - "link" : { - "description" : "An WebLink to this entity.", - "readOnly" : true, - "$ref" : "#/definitions/JaxbLink" - }, - "bucketIdentifier" : { - "type" : "string", - "description" : "The identifier of the bucket this snapshot belongs to." - }, - "flowIdentifier" : { - "type" : "string", - "description" : "The identifier of the flow this snapshot belongs to." - }, - "version" : { - "type" : "integer", - "format" : "int32", - "description" : "The version of this snapshot of the flow.", - "minimum" : -1 - }, - "timestamp" : { - "type" : "integer", - "format" : "int64", - "description" : "The timestamp when the flow was saved, as milliseconds since epoch.", - "readOnly" : true, - "minimum" : 1 - }, - "author" : { - "type" : "string", - "description" : "The user that created this snapshot of the flow.", - "readOnly" : true - }, - "comments" : { - "type" : "string", - "description" : "The comments provided by the user when creating the snapshot." - } - } - }, - "VersionedFunnel" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The component's unique identifier" - }, - "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" - }, - "comments" : { - "type" : "string", - "description" : "The user-supplied comments for the component" - }, - "position" : { - "description" : "The component's position on the graph", - "$ref" : "#/definitions/Position" - }, - "componentType" : { - "type" : "string", - "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE", "REPORTING_TASK", "PARAMETER_CONTEXT", "PARAMETER_PROVIDER", "TEMPLATE", "FLOW_REGISTRY_CLIENT" ] - }, - "groupIdentifier" : { - "type" : "string", - "description" : "The ID of the Process Group that this component belongs to" - } - } - }, - "VersionedLabel" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The component's unique identifier" - }, - "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" - }, - "comments" : { - "type" : "string", - "description" : "The user-supplied comments for the component" - }, - "position" : { - "description" : "The component's position on the graph", - "$ref" : "#/definitions/Position" - }, - "label" : { - "type" : "string", - "description" : "The text that appears in the label." - }, - "zIndex" : { - "type" : "integer", - "format" : "int64", - "description" : "The z index of the connection." - }, - "width" : { - "type" : "number", - "format" : "double", - "description" : "The width of the label in pixels when at a 1:1 scale." - }, - "height" : { - "type" : "number", - "format" : "double", - "description" : "The height of the label in pixels when at a 1:1 scale." - }, - "style" : { - "type" : "object", - "description" : "The styles for this label (font-size : 12px, background-color : #eee, etc).", - "additionalProperties" : { - "type" : "string" - } - }, - "componentType" : { - "type" : "string", - "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE", "REPORTING_TASK", "PARAMETER_CONTEXT", "PARAMETER_PROVIDER", "TEMPLATE", "FLOW_REGISTRY_CLIENT" ] - }, - "groupIdentifier" : { - "type" : "string", - "description" : "The ID of the Process Group that this component belongs to" - } - } - }, - "VersionedParameter" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The name of the parameter" - }, - "description" : { - "type" : "string", - "description" : "The description of the param" - }, - "sensitive" : { - "type" : "boolean", - "description" : "Whether or not the parameter value is sensitive" - }, - "provided" : { - "type" : "boolean", - "description" : "Whether or not the parameter value is provided by a ParameterProvider" - }, - "value" : { - "type" : "string", - "description" : "The value of the parameter" - } - } - }, - "VersionedParameterContext" : { - "type" : "object", - "properties" : { - "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" - }, - "comments" : { - "type" : "string", - "description" : "The user-supplied comments for the component" - }, - "position" : { - "description" : "The component's position on the graph", - "$ref" : "#/definitions/Position" - }, - "parameters" : { - "type" : "array", - "description" : "The parameters in the context", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedParameter" - } - }, - "inheritedParameterContexts" : { - "type" : "array", - "description" : "The names of additional parameter contexts from which to inherit parameters", - "items" : { - "type" : "string" - } - }, - "description" : { - "type" : "string", - "description" : "The description of the parameter context" - }, - "parameterProvider" : { - "type" : "string", - "description" : "The identifier of an optional parameter provider" - }, - "parameterGroupName" : { - "type" : "string", - "description" : "The corresponding parameter group name fetched from the parameter provider, if applicable" - }, - "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", "PARAMETER_CONTEXT", "PARAMETER_PROVIDER", "TEMPLATE", "FLOW_REGISTRY_CLIENT" ] - }, - "synchronized" : { - "type" : "boolean", - "description" : "True if the parameter provider is set and the context should receive updates when its parameters are next fetched" - }, - "groupIdentifier" : { - "type" : "string", - "description" : "The ID of the Process Group that this component belongs to" - } - } - }, - "VersionedPort" : { - "type" : "object", - "properties" : { - "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" - }, - "comments" : { - "type" : "string", - "description" : "The user-supplied comments for the component" - }, - "position" : { - "description" : "The component's position on the graph", - "$ref" : "#/definitions/Position" - }, - "type" : { - "type" : "string", - "description" : "The type of port.", - "enum" : [ "INPUT_PORT", "OUTPUT_PORT" ] - }, - "concurrentlySchedulableTaskCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of tasks that should be concurrently scheduled for the port." - }, - "scheduledState" : { - "type" : "string", - "description" : "The scheduled state of the component", - "enum" : [ "ENABLED", "DISABLED", "RUNNING" ] - }, - "allowRemoteAccess" : { - "type" : "boolean", - "description" : "Whether or not this port allows remote access for site-to-site" - }, - "componentType" : { - "type" : "string", - "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE", "REPORTING_TASK", "PARAMETER_CONTEXT", "PARAMETER_PROVIDER", "TEMPLATE", "FLOW_REGISTRY_CLIENT" ] - }, - "groupIdentifier" : { - "type" : "string", - "description" : "The ID of the Process Group that this component belongs to" - } - } - }, - "VersionedProcessGroup" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The component's unique identifier" - }, - "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" - }, - "comments" : { - "type" : "string", - "description" : "The user-supplied comments for the component" - }, - "position" : { - "description" : "The component's position on the graph", - "$ref" : "#/definitions/Position" - }, - "processGroups" : { - "type" : "array", - "description" : "The child Process Groups", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedProcessGroup" - } - }, - "remoteProcessGroups" : { - "type" : "array", - "description" : "The Remote Process Groups", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedRemoteProcessGroup" - } - }, - "processors" : { - "type" : "array", - "description" : "The Processors", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedProcessor" - } - }, - "inputPorts" : { - "type" : "array", - "description" : "The Input Ports", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedPort" - } - }, - "outputPorts" : { - "type" : "array", - "description" : "The Output Ports", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedPort" - } - }, - "connections" : { - "type" : "array", - "description" : "The Connections", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedConnection" - } - }, - "labels" : { - "type" : "array", - "description" : "The Labels", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedLabel" - } - }, - "funnels" : { - "type" : "array", - "description" : "The Funnels", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedFunnel" - } - }, - "controllerServices" : { - "type" : "array", - "description" : "The Controller Services", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedControllerService" - } - }, - "versionedFlowCoordinates" : { - "description" : "The coordinates where the remote flow is stored, or null if the Process Group is not directly under Version Control", - "$ref" : "#/definitions/VersionedFlowCoordinates" - }, - "variables" : { - "type" : "object", - "description" : "The Variables in the Variable Registry for this Process Group (not including any ancestor or descendant Process Groups)", - "additionalProperties" : { - "type" : "string" - } - }, - "parameterContextName" : { - "type" : "string", - "description" : "The name of the parameter context used by this process group" - }, - "defaultFlowFileExpiration" : { - "type" : "string", - "description" : "The default FlowFile Expiration for this Process Group." - }, - "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." - }, - "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." - }, - "logFileSuffix" : { - "type" : "string", - "description" : "The log file suffix for this Process Group for dedicated logging." - }, - "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", "PARAMETER_CONTEXT", "PARAMETER_PROVIDER", "TEMPLATE", "FLOW_REGISTRY_CLIENT" ] - }, - "flowFileOutboundPolicy" : { - "type" : "string", - "description" : "The FlowFile Outbound Policy for the Process Group" - }, - "flowFileConcurrency" : { - "type" : "string", - "description" : "The configured FlowFile Concurrency for the Process Group" - }, - "groupIdentifier" : { - "type" : "string", - "description" : "The ID of the Process Group that this component belongs to" - } - } - }, - "VersionedProcessor" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The component's unique identifier" - }, - "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" - }, - "comments" : { - "type" : "string", - "description" : "The user-supplied comments for the component" - }, - "position" : { - "description" : "The component's position on the graph", - "$ref" : "#/definitions/Position" - }, - "type" : { - "type" : "string", - "description" : "The type of the extension component" - }, - "bundle" : { - "description" : "Information about the bundle from which the component came", - "$ref" : "#/definitions/Bundle" - }, - "properties" : { - "type" : "object", - "description" : "The properties for the component. Properties whose value is not set will only contain the property name.", - "additionalProperties" : { - "type" : "string" - } - }, - "propertyDescriptors" : { - "type" : "object", - "description" : "The property descriptors for the component.", - "additionalProperties" : { - "$ref" : "#/definitions/VersionedPropertyDescriptor" - } - }, - "style" : { - "type" : "object", - "description" : "Stylistic data for rendering in a UI", - "additionalProperties" : { - "type" : "string" - } - }, - "annotationData" : { - "type" : "string", - "description" : "The annotation data for the processor used to relay configuration between a custom UI and the procesosr." - }, - "schedulingPeriod" : { - "type" : "string", - "description" : "The frequency with which to schedule the processor. The format of the value will depend on th value of schedulingStrategy." - }, - "schedulingStrategy" : { - "type" : "string", - "description" : "Indicates whether the processor should be scheduled to run in event or timer driven mode." - }, - "executionNode" : { - "type" : "string", - "description" : "Indicates the node where the process will execute." - }, - "penaltyDuration" : { - "type" : "string", - "description" : "The amout of time that is used when the process penalizes a flowfile." - }, - "yieldDuration" : { - "type" : "string", - "description" : "The amount of time that must elapse before this processor is scheduled again after yielding." - }, - "bulletinLevel" : { - "type" : "string", - "description" : "The level at which the processor will report bulletins." - }, - "runDurationMillis" : { - "type" : "integer", - "format" : "int64", - "description" : "The run duration for the processor in milliseconds." - }, - "concurrentlySchedulableTaskCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of tasks that should be concurrently schedule for the processor. If the processor doesn't allow parallol processing then any positive input will be ignored." - }, - "autoTerminatedRelationships" : { - "type" : "array", - "description" : "The names of all relationships that cause a flow file to be terminated if the relationship is not connected elsewhere. This property differs from the 'isAutoTerminate' property of the RelationshipDTO in that the RelationshipDTO is meant to depict the current configuration, whereas this property can be set in a DTO when updating a Processor in order to change which Relationships should be auto-terminated.", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - }, - "scheduledState" : { - "type" : "string", - "description" : "The scheduled state of the component", - "enum" : [ "ENABLED", "DISABLED", "RUNNING" ] - }, - "retryCount" : { - "type" : "integer", - "format" : "int32", - "description" : "Overall number of retries." - }, - "retriedRelationships" : { - "type" : "array", - "description" : "All the relationships should be retried.", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - }, - "backoffMechanism" : { - "type" : "string", - "description" : "Determines whether the FlowFile should be penalized or the processor should be yielded between retries.", - "enum" : [ "PENALIZE_FLOWFILE", "YIELD_PROCESSOR" ] - }, - "maxBackoffPeriod" : { - "type" : "string", - "description" : "Maximum amount of time to be waited during a retry period." - }, - "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", "PARAMETER_CONTEXT", "PARAMETER_PROVIDER", "TEMPLATE", "FLOW_REGISTRY_CLIENT" ] - }, - "groupIdentifier" : { - "type" : "string", - "description" : "The ID of the Process Group that this component belongs to" - } - } - }, - "VersionedPropertyDescriptor" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The name of the property" - }, - "displayName" : { - "type" : "string", - "description" : "The display name of the property" - }, - "identifiesControllerService" : { - "type" : "boolean", - "description" : "Whether or not the property provides the identifier of a Controller Service" - }, - "sensitive" : { - "type" : "boolean", - "description" : "Whether or not the property is considered sensitive" - }, - "resourceDefinition" : { - "description" : "Returns the Resource Definition that defines which type(s) of resource(s) this property references, if any", - "$ref" : "#/definitions/VersionedResourceDefinition" - } - } - }, - "VersionedRemoteGroupPort" : { - "type" : "object", - "properties" : { - "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" - }, - "comments" : { - "type" : "string", - "description" : "The user-supplied comments for the component" - }, - "position" : { - "description" : "The component's position on the graph", - "$ref" : "#/definitions/Position" - }, - "remoteGroupId" : { - "type" : "string", - "description" : "The id of the remote process group that the port resides in." - }, - "concurrentlySchedulableTaskCount" : { - "type" : "integer", - "format" : "int32", - "description" : "The number of task that may transmit flowfiles to the target port concurrently." - }, - "useCompression" : { - "type" : "boolean", - "description" : "Whether the flowfiles are compressed when sent to the target port." - }, - "batchSize" : { - "description" : "The batch settings for data transmission.", - "$ref" : "#/definitions/BatchSize" - }, - "componentType" : { - "type" : "string", - "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE", "REPORTING_TASK", "PARAMETER_CONTEXT", "PARAMETER_PROVIDER", "TEMPLATE", "FLOW_REGISTRY_CLIENT" ] - }, - "targetId" : { - "type" : "string", - "description" : "The ID of the port on the target NiFi instance" - }, - "scheduledState" : { - "type" : "string", - "description" : "The scheduled state of the component", - "enum" : [ "ENABLED", "DISABLED", "RUNNING" ] - }, - "groupIdentifier" : { - "type" : "string", - "description" : "The ID of the Process Group that this component belongs to" - } - } - }, - "VersionedRemoteProcessGroup" : { - "type" : "object", - "properties" : { - "identifier" : { - "type" : "string", - "description" : "The component's unique identifier" - }, - "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" - }, - "comments" : { - "type" : "string", - "description" : "The user-supplied comments for the component" - }, - "position" : { - "description" : "The component's position on the graph", - "$ref" : "#/definitions/Position" - }, - "targetUri" : { - "type" : "string", - "description" : "[DEPRECATED] The target URI of the remote process group. If target uri is not set, but uris are set, then returns the first uri in the uris. If neither target uri nor uris are set, then returns null." - }, - "targetUris" : { - "type" : "string", - "description" : "The target URIs of the remote process group. If target uris is not set but target uri is set, then returns the single target uri. If neither target uris nor target uri is set, then returns null." - }, - "communicationsTimeout" : { - "type" : "string", - "description" : "The time period used for the timeout when communicating with the target." - }, - "yieldDuration" : { - "type" : "string", - "description" : "When yielding, this amount of time must elapse before the remote process group is scheduled again." - }, - "transportProtocol" : { - "type" : "string", - "description" : "The Transport Protocol that is used for Site-to-Site communications", - "enum" : [ "RAW", "HTTP" ] - }, - "localNetworkInterface" : { - "type" : "string", - "description" : "The local network interface to send/receive data. If not specified, any local address is used. If clustered, all nodes must have an interface with this identifier." - }, - "proxyHost" : { - "type" : "string" - }, - "proxyPort" : { - "type" : "integer", - "format" : "int32" - }, - "proxyUser" : { - "type" : "string" - }, - "proxyPassword" : { - "type" : "string" - }, - "inputPorts" : { - "type" : "array", - "description" : "A Set of Input Ports that can be connected to, in order to send data to the remote NiFi instance", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedRemoteGroupPort" - } - }, - "outputPorts" : { - "type" : "array", - "description" : "A Set of Output Ports that can be connected to, in order to pull data from the remote NiFi instance", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VersionedRemoteGroupPort" - } - }, - "componentType" : { - "type" : "string", - "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE", "REPORTING_TASK", "PARAMETER_CONTEXT", "PARAMETER_PROVIDER", "TEMPLATE", "FLOW_REGISTRY_CLIENT" ] - }, - "groupIdentifier" : { - "type" : "string", - "description" : "The ID of the Process Group that this component belongs to" - } - } - }, - "VersionedResourceDefinition" : { - "type" : "object", - "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", - "uniqueItems" : true, - "items" : { - "type" : "string", - "enum" : [ "FILE", "DIRECTORY", "TEXT", "URL" ] - } - } - } - } - } -} \ No newline at end of file diff --git a/resources/client_gen/api_defs/registry-2.5.0.json b/resources/client_gen/api_defs/registry-2.5.0.json new file mode 100644 index 00000000..6571fa74 --- /dev/null +++ b/resources/client_gen/api_defs/registry-2.5.0.json @@ -0,0 +1,7218 @@ +{ + "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.5.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 maye 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" ] + } + }, { + "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 flow files 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 flow files 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." + } + } + }, + "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" ] + } + } + }, + "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" : { + "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 flow files 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 flow files" + }, + "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" ] + }, + "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 flow files 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" ] + }, + "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" ] + } + } + }, + "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 + }, + "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" + }, + "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" + }, + "className" : { + "type" : "string", + "description" : "The class name of the service API being provided" + }, + "groupId" : { + "type" : "string", + "description" : "The group id of the service API being provided" + }, + "version" : { + "type" : "string", + "description" : "The version of the service API being provided" + } + } + }, + "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" + }, + "requiredPermission" : { + "type" : "string", + "description" : "The permission required for this restriction" + } + } + }, + "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" + } + } + }, + "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" ] + }, + "destination" : { + "$ref" : "#/components/schemas/ConnectableComponent" + }, + "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." + }, + "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", + "enum" : [ "DO_NOT_COMPRESS, COMPRESS_ATTRIBUTES_ONLY, COMPRESS_ATTRIBUTES_AND_CONTENT" ] + }, + "loadBalanceStrategy" : { + "type" : "string", + "description" : "The Strategy to use for load balancing data across the cluster, or null, if no Load Balance Strategy has been specified.", + "enum" : [ "DO_NOT_LOAD_BALANCE, PARTITION_BY_ATTRIBUTE, ROUND_ROBIN, SINGLE_NODE" ] + }, + "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" + }, + "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" ] + }, + "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" ] + }, + "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" ] + }, + "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." + } + } + }, + "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" ] + }, + "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" ] + }, + "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" ] + }, + "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 procesosr." + }, + "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.", + "enum" : [ "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" + }, + "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" ] + }, + "concurrentlySchedulableTaskCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of tasks that should be concurrently schedule for the processor. If the processor doesn't allow parallol processing then any positive input will be ignored." + }, + "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 amout 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" + }, + "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" ] + }, + "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" ] + }, + "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", + "enum" : [ "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/apply_augmentations.sh b/resources/client_gen/apply_augmentations.sh new file mode 100644 index 00000000..b39b3143 --- /dev/null +++ b/resources/client_gen/apply_augmentations.sh @@ -0,0 +1,60 @@ +#!/usr/bin/env bash +set -euo pipefail + +# Apply all augmentation scripts for a given service to an OpenAPI JSON. +# Usage: ./apply_augmentations.sh +# +# Looks for Python scripts under resources/client_gen/augmentations matching: +# common_*.py for all services +# nifi_*.py for service=nifi +# registry_*.py for service=registry +# Applies them in sorted filename order, chaining input->output. +# +# Each augmentation script must accept: + +script_dir="$(cd "$(dirname "$0")" && pwd)" +aug_dir="${script_dir}/augmentations" + +service="${1:-}" +in_json="${2:-}" +out_json="${3:-}" + +if [ -z "${service}" ] || [ -z "${in_json}" ] || [ -z "${out_json}" ]; then + echo "Usage: $0 " >&2 + exit 1 +fi + +if [ ! -f "${in_json}" ]; then + echo "ERROR: input JSON not found: ${in_json}" >&2 + exit 1 +fi + +mkdir -p "${aug_dir}" + +tmp_work="${out_json}.tmp.work" +cp "${in_json}" "${tmp_work}" + +shopt -s nullglob +applied=0 +# First apply any common augmentations (service-agnostic) +for aug in "${aug_dir}/common"_*.py; do + next="${tmp_work}.next" + echo "Applying augmentation: $(basename "$aug")" + python "$aug" "${tmp_work}" "${next}" + mv "${next}" "${tmp_work}" + applied=$((applied+1)) +done + +# Then apply service-specific augmentations +for aug in "${aug_dir}/${service}"_*.py; do + next="${tmp_work}.next" + echo "Applying augmentation: $(basename "$aug")" + python "$aug" "${tmp_work}" "${next}" + mv "${next}" "${tmp_work}" + applied=$((applied+1)) +done +shopt -u nullglob + +mv "${tmp_work}" "${out_json}" +echo "APPLIED ${applied} augmentation(s) -> ${out_json}" + diff --git a/resources/client_gen/augmentations/common_normalize_enums.py b/resources/client_gen/augmentations/common_normalize_enums.py new file mode 100644 index 00000000..50204828 --- /dev/null +++ b/resources/client_gen/augmentations/common_normalize_enums.py @@ -0,0 +1,40 @@ +#!/usr/bin/env python3 +import json, sys + +def split(enum_list): + if isinstance(enum_list, list) and len(enum_list) == 1 and isinstance(enum_list[0], str) and "," in enum_list[0]: + return [p.strip() for p in enum_list[0].split(',') if p.strip()] + return enum_list + +def dedupe(seq): + seen = set(); out = [] + for item in seq: + key = json.dumps(item, sort_keys=True) if not isinstance(item, (str, int, float, bool, type(None))) else item + if key not in seen: + seen.add(key); out.append(item) + return out + +def walk(node): + if isinstance(node, dict): + if 'enum' in node and isinstance(node['enum'], list): + node['enum'] = dedupe(split(node['enum'])) + for k, v in list(node.items()): + node[k] = walk(v) + return node + if isinstance(node, list): + return [walk(x) for x in node] + return node + +def main(): + if len(sys.argv) != 3: + print('Usage: common_normalize_enums.py ') + sys.exit(1) + with open(sys.argv[1], 'r') as f: + data = json.load(f) + data = walk(data) + with open(sys.argv[2], 'w') as f: + json.dump(data, f, indent=2) + +if __name__ == '__main__': + main() + diff --git a/resources/client_gen/augmentations/nifi_security.py b/resources/client_gen/augmentations/nifi_security.py new file mode 100644 index 00000000..cdb87aa5 --- /dev/null +++ b/resources/client_gen/augmentations/nifi_security.py @@ -0,0 +1,29 @@ +#!/usr/bin/env python3 +import json, sys + +LOGIN_PATH = "/access/token" +BASE_PREFIX = "/nifi-api" + +def main(): + if len(sys.argv) != 3: + print("Usage: nifi_security.py ") + sys.exit(1) + inp, outp = sys.argv[1], sys.argv[2] + with open(inp, 'r') as f: + spec = json.load(f) + components = spec.setdefault("components", {}) + schemes = components.setdefault("securitySchemes", {}) + schemes.setdefault("bearerAuth", {"type": "http", "scheme": "bearer", "bearerFormat": "JWT"}) + spec["security"] = [{"bearerAuth": []}] + paths = spec.get("paths", {}) + def resolve(path_suffix): + return BASE_PREFIX + path_suffix if (BASE_PREFIX + path_suffix) in paths else path_suffix + login_key = resolve(LOGIN_PATH) + if login_key in paths and "post" in paths[login_key]: + paths[login_key]["post"]["security"] = [] + with open(outp, 'w') as f: + json.dump(spec, f, indent=2) + +if __name__ == '__main__': + main() + diff --git a/resources/client_gen/augmentations/registry_security.py b/resources/client_gen/augmentations/registry_security.py new file mode 100644 index 00000000..2d022ae1 --- /dev/null +++ b/resources/client_gen/augmentations/registry_security.py @@ -0,0 +1,34 @@ +#!/usr/bin/env python3 +import json, sys + +LOGIN_PATH = "/access/token/login" +TRY_ALL_PATH = "/access/token" +BASE_PREFIX = "/nifi-registry-api" + +def main(): + if len(sys.argv) != 3: + print("Usage: registry_security.py ") + sys.exit(1) + inp, outp = sys.argv[1], sys.argv[2] + with open(inp, 'r') as f: + spec = json.load(f) + components = spec.setdefault("components", {}) + schemes = components.setdefault("securitySchemes", {}) + schemes.setdefault("basicAuth", {"type": "http", "scheme": "basic"}) + schemes.setdefault("bearerAuth", {"type": "http", "scheme": "bearer", "bearerFormat": "JWT"}) + spec["security"] = [{"bearerAuth": []}] + paths = spec.get("paths", {}) + def resolve(path_suffix): + return BASE_PREFIX + path_suffix if (BASE_PREFIX + path_suffix) in paths else path_suffix + login_key = resolve(LOGIN_PATH) + try_all_key = resolve(TRY_ALL_PATH) + if login_key in paths and "post" in paths[login_key]: + paths[login_key]["post"]["security"] = [{"basicAuth": []}] + if try_all_key in paths and "post" in paths[try_all_key]: + paths[try_all_key]["post"]["security"] = [] + with open(outp, 'w') as f: + json.dump(spec, f, indent=2) + +if __name__ == '__main__': + main() + diff --git a/resources/client_gen/fetch_nifi_openapi.sh b/resources/client_gen/fetch_nifi_openapi.sh new file mode 100644 index 00000000..7d6a0427 --- /dev/null +++ b/resources/client_gen/fetch_nifi_openapi.sh @@ -0,0 +1,140 @@ +#!/usr/bin/env bash +set -euo pipefail + +# Fetch NiFi OpenAPI spec from a running container by copying from filesystem. +# Usage: NIFI_VERSION=2.5.0 ./fetch_nifi_openapi.sh [container_name] + +script_dir="$(cd "$(dirname "$0")" && pwd)" +api_defs_dir="${script_dir}/api_defs" +nifi_version="${NIFI_VERSION:-2.5.0}" +container_name="${1:-${NIFI_CONTAINER:-nifi-single}}" + +if ! docker ps --format '{{.Names}}' | grep -q "^${container_name}$"; then + echo "ERROR: Container '${container_name}' not running. Start a compose profile first." >&2 + exit 1 +fi + +echo "Searching for NiFi OpenAPI/Swagger spec inside container '${container_name}'" +spec_path=$(docker exec "${container_name}" sh -lc "set -e; find /opt -type f \ + \( -iname '*openapi*.json' -o -iname '*swagger*.json' \) 2>/dev/null | head -n 1") || true + +if [ -z "${spec_path}" ]; then + echo "ERROR: Could not locate an OpenAPI/Swagger JSON inside ${container_name}" >&2 + exit 1 +fi + +mkdir -p "${api_defs_dir}" +out_file="${api_defs_dir}/nifi-${nifi_version}.json" +tmp_file="${api_defs_dir}/.nifi-openapi-tmp.json" + +echo "Copying '${spec_path}' to '${out_file}'" +docker cp "${container_name}:${spec_path}" "${tmp_file}" + +# Ensure JSON extension and pretty minimal check +mv "${tmp_file}" "${out_file}" +echo "WROTE ${out_file}" +exit 0 +#!/usr/bin/env bash +set -euo pipefail + +# Attempt to obtain NiFi OpenAPI/Swagger from a running container (compose) or a disposable one. +# Writes to resources/client_gen/api_defs/nifi-.yaml or .json depending on source. + +script_dir="$(cd "$(dirname "$0")" && pwd)" +api_defs_dir="${script_dir}/api_defs" +mkdir -p "${api_defs_dir}" + +container_name="${NIFI_CONTAINER:-nifi}" +base_url_env="${NIFI_API_ENDPOINT:-}" + +# Require a running container (compose) unless NIFI_API_ENDPOINT is provided +if [[ -z "${base_url_env}" ]]; then + if ! docker ps --format '{{.Names}}' | grep -qx "${container_name}"; then + echo "Container '${container_name}' is not running. Start it with:" + echo " docker compose -f resources/docker/latest/docker-compose.yml up -d" + exit 1 + fi +fi + +# Determine mapped port for 8443 +if [[ -n "${base_url_env}" ]]; then + base_url="${base_url_env}" +else + host_port="$(docker inspect -f '{{ (index (index .NetworkSettings.Ports "8443/tcp") 0).HostPort }}' "${container_name}" 2>/dev/null || true)" + base_url="" + if [[ -n "${host_port}" && "${host_port}" != "" ]]; then + base_url="https://localhost:${host_port}" + echo "Resolved mapped host port for 8443/tcp -> ${host_port}" + else + # Fall back to container IP if compose-style networking (not ideal for localhost access) + ip="$(docker inspect -f '{{range .NetworkSettings.Networks}}{{.IPAddress}}{{end}}' "${container_name}")" + base_url="https://${ip}:8443" + echo "Using container IP fallback ${ip}:8443" + fi +fi + +echo "Using base URL: ${base_url}" + +# Wait for readiness +echo -n "Waiting for NiFi to be ready" +for i in {1..300}; do + code=$(curl -k -s -o /dev/null -w "%{http_code}" "${base_url}/nifi-api/flow/about" || true) + if [[ "$code" == "200" || "$code" == "401" ]]; then + echo " - ready (${code})" + break + fi + echo -n "." + sleep 2 + if [[ $i -eq 300 ]]; then + echo "\nNiFi did not become ready in time" >&2 + exit 1 + fi +done + +# Try to discover version from about; if empty, will fill later based on file path or spec info +version="" +if command -v jq >/dev/null 2>&1; then + version=$(curl -k -sS "${base_url}/nifi-api/flow/about" 2>/dev/null | jq -r '(.about.version // .about.buildTag // empty)' 2>/dev/null || true) +fi + +echo "Detected NiFi version: ${version}" + +echo "Searching container for swagger/openapi artifacts..." +container_spec_path=$(docker exec "${container_name}" bash -lc "set -e; \ + find /opt/nifi -type f \ + \( -name openapi.yaml -o -name openapi.json -o -name swagger.yaml -o -name swagger.json \) 2>/dev/null \ + | sort | head -n 1") + +if [[ -z "${container_spec_path}" ]]; then + echo "No swagger/openapi file found in NiFi container. NiFi typically does not publish the spec at runtime." >&2 + echo "Fallback options:" >&2 + echo " - Build from source using the swagger maven plugin at the appropriate module and copy the output." >&2 + echo " - Provide a prebuilt spec file manually under ${api_defs_dir}/nifi-${version}.json (or .yaml)." >&2 + exit 2 +fi + +ext="${container_spec_path##*.}" +# If version is still empty, try to parse from the path (e.g., nifi-web-api-2.5.0.war) +if [[ -z "${version}" ]]; then + parsed="$(basename "${container_spec_path}" | sed -n 's/.*-\([0-9][0-9.]*\)\.war.*/\1/p')" + if [[ -n "${parsed}" ]]; then + version="${parsed}" + else + # Last fallback: read .info.version if JSON + if [[ "${ext}" == "json" ]] && command -v jq >/dev/null 2>&1; then + tmpfile="${api_defs_dir}/nifi-tmp.json" + docker cp "${container_name}:${container_spec_path}" "${tmpfile}" + v2=$(jq -r '(.info.version // empty)' "${tmpfile}" || true) + if [[ -n "${v2}" ]]; then version="${v2}"; fi + rm -f "${tmpfile}" + fi + fi +fi + +outfile="${api_defs_dir}/nifi-${version}.${ext}" +echo "Copying ${container_spec_path} -> ${outfile}" +docker cp "${container_name}:${container_spec_path}" "${outfile}" +echo "Wrote ${outfile}" + +echo "Done." + diff --git a/resources/client_gen/fetch_registry_openapi.sh b/resources/client_gen/fetch_registry_openapi.sh new file mode 100644 index 00000000..6f10f32c --- /dev/null +++ b/resources/client_gen/fetch_registry_openapi.sh @@ -0,0 +1,171 @@ +#!/usr/bin/env bash +set -euo pipefail + +# Fetch NiFi Registry OpenAPI spec from a running container by copying from filesystem, +# falling back to the HTTP endpoint if present. +# Usage: NIFI_VERSION=2.5.0 ./fetch_registry_openapi.sh [container_name] + +script_dir="$(cd "$(dirname "$0")" && pwd)" +api_defs_dir="${script_dir}/api_defs" +reg_version="${NIFI_VERSION:-2.5.0}" +container_name="${1:-${REGISTRY_CONTAINER:-registry-single}}" + +if ! docker ps --format '{{.Names}}' | grep -q "^${container_name}$"; then + echo "ERROR: Container '${container_name}' not running. Start a compose profile first." >&2 + exit 1 +fi + +mkdir -p "${api_defs_dir}" +out_file="${api_defs_dir}/registry-${reg_version}.json" +tmp_file="${api_defs_dir}/.registry-openapi-tmp.json" + +# Try filesystem copy first +echo "Searching for Registry OpenAPI JSON inside '${container_name}'" +spec_path=$(docker exec "${container_name}" sh -lc "set -e; find /opt -type f \ + \( -iname '*openapi*.json' -o -iname '*swagger*.json' \) 2>/dev/null | head -n 1") || true +if [ -n "${spec_path}" ]; then + echo "Copying '${spec_path}' to '${out_file}'" + docker cp "${container_name}:${spec_path}" "${tmp_file}" + mv "${tmp_file}" "${out_file}" +echo "WROTE ${out_file}" +exit 0 +fi + +# Fallback to HTTP(S) endpoint; prefer REGISTRY_API_ENDPOINT if provided +echo "Falling back to /nifi-registry-api/swagger.json" +base_url="${REGISTRY_API_ENDPOINT:-}" +try_urls=() +if [ -n "${base_url}" ]; then + try_urls+=("${base_url}/swagger.json") +fi +# Common local defaults +try_urls+=( + "https://localhost:18443/nifi-registry-api/swagger.json" + "http://localhost:18080/nifi-registry-api/swagger.json" +) + +set +e +rc=1 +for u in "${try_urls[@]}"; do + echo " trying ${u}" + curl -fsSk "${u}" -o "${tmp_file}" + rc=$? + [ $rc -eq 0 ] && { echo " fetched ${u}"; break; } +done +set -e +if [ $rc -ne 0 ]; then + echo "ERROR: Unable to fetch Registry OpenAPI via HTTP fallback" >&2 + exit 1 +fi +mv "${tmp_file}" "${out_file}" +echo "WROTE ${out_file}" +#!/usr/bin/env bash +set -euo pipefail + +# Fetch the NiFi Registry OpenAPI/Swagger from a running compose service 'registry' +# and store it under api_defs/registry-.yaml or .json + +script_dir="$(cd "$(dirname "$0")" && pwd)" +api_defs_dir="${script_dir}/api_defs" +mkdir -p "${api_defs_dir}" + +container_name="${REGISTRY_CONTAINER:-registry}" +if ! docker ps --format '{{.Names}}' | grep -qx "${container_name}"; then + echo "Container '${container_name}' is not running. Start it with:" + echo " docker compose -f resources/docker/latest/docker-compose.yml up -d" + exit 1 +fi + +# Determine mapped host port for container's 18080/tcp +echo "Resolving mapped host port..." +host_port="$(docker inspect -f '{{ (index (index .NetworkSettings.Ports "18080/tcp") 0).HostPort }}' "${container_name}")" +if [[ -z "${host_port}" || "${host_port}" == "" ]]; then + echo "Failed to resolve mapped host port for 18080/tcp" >&2 + exit 1 +fi +base_url="http://localhost:${host_port}" +echo "Registry base URL: ${base_url}" + +# Wait for service readiness (about endpoint) +echo -n "Waiting for NiFi Registry to become ready" +for i in {1..60}; do + if curl -fsS "${base_url}/nifi-registry-api/about" >/dev/null 2>&1; then + echo " - ready" + break + fi + echo -n "." + sleep 2 + if [[ $i -eq 60 ]]; then + echo "\nRegistry did not become ready in time" >&2 + exit 1 + fi +done + +version="" +if command -v jq >/dev/null 2>&1; then + version=$(curl -fsS "${base_url}/nifi-registry-api/about" | jq -r '(.registryAboutVersion // .about.version // empty)') || true +fi +if [[ -z "${version}" ]]; then + version="${image##*:}" +fi + +# Try fetching via HTTP endpoints first +declare -a http_paths=( + "/nifi-registry-api/openapi.json" + "/nifi-registry-api/swagger.json" + "/nifi-registry-api/api-docs" +) +spec_json="" +for p in "${http_paths[@]}"; do + if spec_json=$(curl -fsS "${base_url}${p}" 2>/dev/null); then + outfile="${api_defs_dir}/registry-${version}.json" + echo "Fetched spec from ${p}; writing ${outfile}" + printf '%s' "${spec_json}" > "${outfile}" + echo "Done." + exit 0 + fi +done + +echo "HTTP spec endpoints not found; copying from container filesystem" + +# Find openapi/swagger file inside the container (prefer JSON for consistency) +container_spec_path=$(docker exec "${container_name}" sh -lc ' + set -e; + for name in swagger.json openapi.json swagger.yaml openapi.yaml; do + res=$(find /opt/nifi-registry -type f -name "$name" 2>/dev/null | head -n 1) + if [ -n "$res" ]; then echo "$res"; break; fi + done +') + +if [[ -z "${container_spec_path}" ]]; then + echo "Unable to locate openapi/swagger file inside container" >&2 + exit 1 +fi + +ext="${container_spec_path##*.}" +# If YAML found but JSON is expected, convert when jq is available +dest="${api_defs_dir}/registry-${version}.json" +if [[ "${ext}" == "json" ]]; then + echo "Copying ${container_spec_path} -> ${dest}" + docker cp "${container_name}:${container_spec_path}" "${dest}" +else + # Try convert YAML->JSON using yq if installed; otherwise copy YAML but name with .yaml + if command -v yq >/dev/null 2>&1; then + tmp_yaml="${api_defs_dir}/registry-${version}.yaml" + echo "Copying ${container_spec_path} -> ${tmp_yaml} and converting to JSON" + docker cp "${container_name}:${container_spec_path}" "${tmp_yaml}" + yq -o=json "${tmp_yaml}" > "${dest}" + rm -f "${tmp_yaml}" + else + dest_yaml="${api_defs_dir}/registry-${version}.yaml" + echo "Copying ${container_spec_path} -> ${dest_yaml} (no yq available for conversion)" + docker cp "${container_name}:${container_spec_path}" "${dest_yaml}" + echo "Wrote ${dest_yaml}" + echo "Done." + exit 0 + fi +fi +echo "Wrote ${dest}" + +echo "Done." + diff --git a/resources/client_gen/generate_api_client.sh b/resources/client_gen/generate_api_client.sh index 7d796fcc..29cc95cd 100755 --- a/resources/client_gen/generate_api_client.sh +++ b/resources/client_gen/generate_api_client.sh @@ -1,36 +1,110 @@ #!/usr/bin/env bash +set -euo pipefail -# Instructions -# You will need Java installed on the local machine +# Resolve directories regardless of invocation cwd +script_dir="$(cd "$(dirname "$0")" && pwd)" +repo_root="$(cd "${script_dir}/../.." && pwd)" -# A new client is generated from the Swagger Def, and then manually merged into -# NiPyApi so that changes may be assessed, tests written, and trouble avoided +# Instructions +# - Requires Java and either wget or curl +# - Generates client from OpenAPI and syncs apis/models/core client files into nipyapi # Params -echo Exporting Params -export wv_client_name=${wv_client_name:-registry} - -export wv_codegen_filename=${wv_codegen_filename:-swagger-codegen-cli-2.4.41.jar} -export wv_tmp_dir=${wv_tmp_dir:-${HOME}/Projects/tmp} -export wv_client_dir=${wv_tmp_dir}/${wv_client_name} -export wv_mustache_dir=./swagger_templates -export wv_api_def_dir=./api_defs - -export wv_codegen_url=https://repo1.maven.org/maven2/io/swagger/swagger-codegen-cli/2.4.41/${wv_codegen_filename} -export wv_swagger_def=$(ls ${wv_api_def_dir} | grep ${wv_client_name} | sort -V | tail -1) - -echo Prepping Workspace -mkdir -p ${wv_tmp_dir} -echo "{ \"packageName\": \"${wv_client_name}\" }" > ${wv_tmp_dir}/${wv_client_name}.conf.json - -echo Downloading ${wv_codegen_filename} -wget -N ${wv_codegen_url} -P ${wv_tmp_dir} - -java -jar ${wv_tmp_dir}/${wv_codegen_filename} generate \ - --lang python \ - --config ${wv_tmp_dir}/${wv_client_name}.conf.json \ - --api-package apis \ - --model-package models \ - --template-dir ${wv_mustache_dir} \ - --input-spec ${wv_api_def_dir}/${wv_swagger_def} \ - --output ${wv_client_dir} +export wv_client_name=${wv_client_name:-all} # one of: nifi|registry|all +export wv_spec_variant=${wv_spec_variant:-augmented} # one of: augmented|base + +# Codegen/tooling cache and working directory (repo-local by default) +export wv_codegen_version=${wv_codegen_version:-3.0.68} +export wv_codegen_filename=${wv_codegen_filename:-swagger-codegen-cli-${wv_codegen_version}.jar} +export wv_cache_dir=${wv_cache_dir:-"${script_dir}/_cache"} +export wv_tmp_dir=${wv_tmp_dir:-"${script_dir}/_tmp"} +export wv_client_dir="${wv_tmp_dir}/${wv_client_name}" +export wv_mustache_dir="${script_dir}/swagger_templates" +export wv_api_def_dir="${script_dir}/api_defs" + +export wv_codegen_url="https://repo1.maven.org/maven2/io/swagger/codegen/v3/swagger-codegen-cli/${wv_codegen_version}/${wv_codegen_filename}" + +# Preflight checks +command -v java >/dev/null 2>&1 || { echo "ERROR: Java not found on PATH" >&2; exit 1; } +[ -d "${wv_mustache_dir}" ] || { echo "ERROR: mustache template dir not found: ${wv_mustache_dir}" >&2; exit 1; } +[ -d "${wv_api_def_dir}" ] || { echo "ERROR: api_defs dir not found: ${wv_api_def_dir}" >&2; exit 1; } + +mkdir -p "${wv_cache_dir}" "${wv_tmp_dir}" + +# Download codegen jar if missing +if [ ! -f "${wv_cache_dir}/${wv_codegen_filename}" ]; then + echo "Downloading ${wv_codegen_filename} to ${wv_cache_dir}" + if command -v wget >/dev/null 2>&1; then + wget -q --show-progress -O "${wv_cache_dir}/${wv_codegen_filename}" "${wv_codegen_url}" + else + curl -fL --retry 3 --retry-delay 2 -o "${wv_cache_dir}/${wv_codegen_filename}" "${wv_codegen_url}" + fi +fi + + +generate_and_sync() { + local client_name="$1" + local client_dir="${wv_tmp_dir}/${client_name}" + local swagger_def + if [ "${wv_spec_variant}" = "augmented" ]; then + # Prefer augmented specs (e.g., nifi-.augmented.json) + swagger_def=$(ls "${wv_api_def_dir}" | grep "^${client_name}-" | grep -E 'augmented\.json$' | sort -V | tail -1 || true) + fi + if [ -z "${swagger_def:-}" ]; then + # Fall back to base spec (exclude augmented files) + swagger_def=$(ls "${wv_api_def_dir}" | grep "^${client_name}-" | grep -v 'augmented\.json$' | sort -V | tail -1 || true) + fi + if [ -z "${swagger_def}" ]; then + echo "ERROR: No API definition found for ${client_name} in ${wv_api_def_dir}" >&2 + echo "Hint: run 'make fetch-openapi' to fetch and augment specs from running containers." >&2 + exit 1 + fi + # Create per-client config (python3-only, suppress timestamps) + mkdir -p "${wv_tmp_dir}" + cat > "${wv_tmp_dir}/${client_name}.conf.json" <&2 + exit 1 + fi + + echo "Syncing generated client into ${repo_root}/nipyapi/${client_name}" + target_pkg="${repo_root}/nipyapi/${client_name}" + mkdir -p "${target_pkg}/apis" "${target_pkg}/models" + rsync -a --delete "${client_dir}/${client_name}/apis/" "${target_pkg}/apis/" + rsync -a --delete "${client_dir}/${client_name}/models/" "${target_pkg}/models/" + for f in api_client.py rest.py configuration.py __init__.py; do + if [ -f "${client_dir}/${client_name}/${f}" ]; then + cp "${client_dir}/${client_name}/${f}" "${target_pkg}/${f}" + fi + done +} + +if [ "${wv_client_name}" = "all" ]; then + for c in nifi registry; do + generate_and_sync "$c" + done +else + generate_and_sync "${wv_client_name}" +fi + +echo Done. diff --git a/resources/client_gen/swagger_templates/README.mustache b/resources/client_gen/swagger_templates/README.mustache index 0c0d6a9d..692a4229 100644 --- a/resources/client_gen/swagger_templates/README.mustache +++ b/resources/client_gen/swagger_templates/README.mustache @@ -57,7 +57,7 @@ import time import {{{packageName}}} from {{{packageName}}}.rest import ApiException from pprint import pprint -{{#apiInfo}}{{#apis}}{{#-first}}{{#operations}}{{#operation}}{{#-first}}{{#hasAuthMethods}}{{#authMethods}}{{#isBasic}} +{{#apiInfo}}{{#apis}}{{#operations}}{{#operation}}{{#hasAuthMethods}}{{#authMethods}}{{#isBasic}} # Configure HTTP basic authorization: {{{name}}} {{{packageName}}}.configuration.username = 'YOUR_USERNAME' {{{packageName}}}.configuration.password = 'YOUR_PASSWORD'{{/isBasic}}{{#isApiKey}} @@ -79,7 +79,7 @@ try: pprint(api_response){{/returnType}} except ApiException as e: print("Exception when calling {{classname}}->{{operationId}}: %s\n" % e) -{{/-first}}{{/operation}}{{/operations}}{{/-first}}{{/apis}}{{/apiInfo}} +{{/operation}}{{/operations}}{{/apis}}{{/apiInfo}} ``` ## Documentation for API Endpoints diff --git a/resources/client_gen/swagger_templates/__init__package.mustache b/resources/client_gen/swagger_templates/__init__package.mustache index 042241a7..bfb48042 100644 --- a/resources/client_gen/swagger_templates/__init__package.mustache +++ b/resources/client_gen/swagger_templates/__init__package.mustache @@ -1,6 +1,4 @@ {{>partial_header}} - - # import models into sdk package {{#models}}{{#model}}from .models.{{classFilename}} import {{classname}} {{/model}}{{/models}} diff --git a/resources/client_gen/swagger_templates/api.mustache b/resources/client_gen/swagger_templates/api.mustache index e748ee6f..c3b497f2 100644 --- a/resources/client_gen/swagger_templates/api.mustache +++ b/resources/client_gen/swagger_templates/api.mustache @@ -29,32 +29,26 @@ class {{classname}}(object): def {{operationId}}(self, {{#sortParamsByRequiredFlag}}{{#allParams}}{{#required}}{{paramName}}, {{/required}}{{/allParams}}{{/sortParamsByRequiredFlag}}**kwargs): """ {{#summary}} - {{{summary}}} + {{{summary}}}. {{/summary}} {{#notes}} + {{{notes}}} + {{/notes}} - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> -{{#sortParamsByRequiredFlag}} - >>> thread = api.{{operationId}}({{#allParams}}{{#required}}{{paramName}}, {{/required}}{{/allParams}}callback=callback_function) -{{/sortParamsByRequiredFlag}} -{{^sortParamsByRequiredFlag}} - >>> thread = api.{{operationId}}({{#allParams}}{{#required}}{{paramName}}={{paramName}}_value, {{/required}}{{/allParams}}callback=callback_function) -{{/sortParamsByRequiredFlag}} - - :param callback function: The callback function - for asynchronous request. (optional) + 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 + ``{{operationId}}_with_http_info()`` method instead. + + Args: {{#allParams}} - :param {{dataType}} {{paramName}}:{{#description}} {{{description}}}{{/description}}{{#required}} (required){{/required}}{{#optional}}(optional){{/optional}} + {{paramName}} ({{#isPrimitiveType}}{{dataType}}{{/isPrimitiveType}}{{^isPrimitiveType}}:class:`~nipyapi.{{packageName}}.models.{{dataType}}`{{/isPrimitiveType}}):{{#description}} + {{{description}}}{{/description}}{{#required}} (required){{/required}}{{#optional}} (optional){{/optional}} {{/allParams}} - :return: {{#returnType}}{{returnType}}{{/returnType}}{{^returnType}}None{{/returnType}} - If the method is called asynchronously, - returns the request thread. + + Returns: + {{#returnType}}{{#returnTypeIsPrimitive}}{{returnType}}{{/returnTypeIsPrimitive}}{{^returnTypeIsPrimitive}}:class:`~nipyapi.{{packageName}}.models.{{returnType}}`{{/returnTypeIsPrimitive}}: The response data.{{/returnType}}{{^returnType}}None{{/returnType}} """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): @@ -66,36 +60,29 @@ class {{classname}}(object): def {{operationId}}_with_http_info(self, {{#sortParamsByRequiredFlag}}{{#allParams}}{{#required}}{{paramName}}, {{/required}}{{/allParams}}{{/sortParamsByRequiredFlag}}**kwargs): """ {{#summary}} - {{{summary}}} + {{{summary}}}. {{/summary}} {{#notes}} + {{{notes}}} + {{/notes}} - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> -{{#sortParamsByRequiredFlag}} - >>> thread = api.{{operationId}}_with_http_info({{#allParams}}{{#required}}{{paramName}}, {{/required}}{{/allParams}}callback=callback_function) -{{/sortParamsByRequiredFlag}} -{{^sortParamsByRequiredFlag}} - >>> thread = api.{{operationId}}_with_http_info({{#allParams}}{{#required}}{{paramName}}={{paramName}}_value, {{/required}}{{/allParams}}callback=callback_function) -{{/sortParamsByRequiredFlag}} - - :param callback function: The callback function - for asynchronous request. (optional) + 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 ``{{operationId}}()`` method instead. + + Args: {{#allParams}} - :param {{dataType}} {{paramName}}:{{#description}} {{{description}}}{{/description}}{{#required}} (required){{/required}}{{#optional}}(optional{{#defaultValue}}, default to {{{.}}}{{/defaultValue}}){{/optional}} + {{paramName}} ({{#isPrimitiveType}}{{dataType}}{{/isPrimitiveType}}{{^isPrimitiveType}}:class:`~nipyapi.{{packageName}}.models.{{dataType}}`{{/isPrimitiveType}}):{{#description}} + {{{description}}}{{/description}}{{#required}} (required){{/required}}{{#optional}} (optional{{#defaultValue}}, default to {{{.}}}{{/defaultValue}}){{/optional}} {{/allParams}} - :return: {{#returnType}}{{returnType}}{{/returnType}}{{^returnType}}None{{/returnType}} - If the method is called asynchronously, - returns the request thread. + + Returns: + tuple: ({{#returnType}}{{#returnTypeIsPrimitive}}{{returnType}}{{/returnTypeIsPrimitive}}{{^returnTypeIsPrimitive}}:class:`~nipyapi.{{packageName}}.models.{{returnType}}`{{/returnTypeIsPrimitive}}{{/returnType}}{{^returnType}}None{{/returnType}}, status_code, headers) - Response data with HTTP details. """ all_params = [{{#allParams}}'{{paramName}}'{{#hasMore}}, {{/hasMore}}{{/allParams}}] - all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -136,7 +123,7 @@ class {{classname}}(object): raise ValueError("Invalid value for parameter `{{paramName}}` when calling `{{operationId}}`, must be a value greater than {{^exclusiveMinimum}}or equal to {{/exclusiveMinimum}}`{{minimum}}`") {{/minimum}} {{#pattern}} - if '{{paramName}}' in params and not re.search('{{{vendorExtensions.x-regex}}}', params['{{paramName}}']{{#vendorExtensions.x-modifiers}}{{#-first}}, flags={{/-first}}re.{{.}}{{^-last}} | {{/-last}}{{/vendorExtensions.x-modifiers}}): + if '{{paramName}}' in params and not re.search('{{{vendorExtensions.x-regex}}}', params['{{paramName}}']): raise ValueError("Invalid value for parameter `{{paramName}}` when calling `{{operationId}}`, must conform to the pattern `{{{pattern}}}`") {{/pattern}} {{#maxItems}} @@ -148,9 +135,7 @@ class {{classname}}(object): raise ValueError("Invalid value for parameter `{{paramName}}` when calling `{{operationId}}`, number of items must be greater than or equal to `{{minItems}}`") {{/minItems}} {{/hasValidation}} -{{#-last}} - -{{/-last}} + {{/allParams}} collection_formats = {} @@ -201,7 +186,7 @@ class {{classname}}(object): {{/hasConsumes}} # Authentication setting - auth_settings = ['tokenAuth'{{#authMethods}}, '{{name}}'{{/authMethods}}] + auth_settings = [{{#authMethods}}'{{name}}'{{#hasMore}}, {{/hasMore}}{{/authMethods}}] return self.api_client.call_api('{{{path}}}', '{{httpMethod}}', path_params, @@ -212,7 +197,6 @@ class {{classname}}(object): files=local_var_files, response_type={{#returnType}}'{{returnType}}'{{/returnType}}{{^returnType}}None{{/returnType}}, auth_settings=auth_settings, - callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), diff --git a/resources/client_gen/swagger_templates/api_client.mustache b/resources/client_gen/swagger_templates/api_client.mustache index d895efc9..b441e11c 100644 --- a/resources/client_gen/swagger_templates/api_client.mustache +++ b/resources/client_gen/swagger_templates/api_client.mustache @@ -5,7 +5,6 @@ import re import json import mimetypes import tempfile -import threading from datetime import date, datetime from urllib.parse import quote @@ -82,7 +81,7 @@ class ApiClient(object): def __call_api(self, resource_path, method, path_params=None, query_params=None, header_params=None, body=None, post_params=None, files=None, - response_type=None, auth_settings=None, callback=None, + response_type=None, auth_settings=None, _return_http_data_only=None, collection_formats=None, _preload_content=True, _request_timeout=None): @@ -149,12 +148,7 @@ class ApiClient(object): else: return_data = None - if callback: - if _return_http_data_only: - callback(return_data) - else: - callback((return_data, response_data.status, response_data.headers)) - elif _return_http_data_only: + if _return_http_data_only: return (return_data) else: return (return_data, response_data.status, response_data.headers) @@ -246,7 +240,7 @@ class ApiClient(object): if type(klass) == str: if klass.startswith('list['): - sub_kls = re.match('list\[(.*)\]', klass).group(1) + sub_kls = re.match(r'list\[(.*)\]', klass).group(1) if isinstance(data, dict): # ok, we got a single instance when we may have gotten a list return self.__deserialize(data, sub_kls) @@ -254,7 +248,7 @@ class ApiClient(object): for sub_data in data] if klass.startswith('dict('): - sub_kls = re.match('dict\(([^,]*), (.*)\)', klass).group(2) + sub_kls = re.match(r'dict\(([^,]*), (.*)\)', klass).group(2) return {k: self.__deserialize(v, sub_kls) for k, v in data.items()} @@ -278,12 +272,11 @@ class ApiClient(object): def call_api(self, resource_path, method, path_params=None, query_params=None, header_params=None, body=None, post_params=None, files=None, - response_type=None, auth_settings=None, callback=None, + response_type=None, auth_settings=None, _return_http_data_only=None, collection_formats=None, _preload_content=True, _request_timeout=None): """ Makes the HTTP request (synchronous) and return the deserialized data. - To make an async request, define a function for callback. :param resource_path: Path to method endpoint. :param method: Method to call. @@ -298,9 +291,6 @@ class ApiClient(object): :param response: Response data type. :param files dict: key -> filename, value -> filepath, for `multipart/form-data`. - :param callback function: Callback function for asynchronous request. - If provide this parameter, - the request will be called asynchronously. :param _return_http_data_only: response data without head status code and headers :param collection_formats: dict of collection formats for path, query, header, and post parameters. @@ -315,23 +305,11 @@ class ApiClient(object): If parameter callback is None, then the method will return the response directly. """ - if callback is None: - return self.__call_api(resource_path, method, - path_params, query_params, header_params, - body, post_params, files, - response_type, auth_settings, callback, - _return_http_data_only, collection_formats, _preload_content, _request_timeout) - else: - thread = threading.Thread(target=self.__call_api, - args=(resource_path, method, - path_params, query_params, - header_params, body, - post_params, files, - response_type, auth_settings, - callback, _return_http_data_only, - collection_formats, _preload_content, _request_timeout)) - thread.start() - return thread + return self.__call_api(resource_path, method, + path_params, query_params, header_params, + body, post_params, files, + response_type, auth_settings, + _return_http_data_only, collection_formats, _preload_content, _request_timeout) def request(self, method, url, query_params=None, headers=None, post_params=None, body=None, _preload_content=True, _request_timeout=None): diff --git a/resources/client_gen/swagger_templates/api_doc.mustache b/resources/client_gen/swagger_templates/api_doc.mustache index 4d574ce9..cb594622 100644 --- a/resources/client_gen/swagger_templates/api_doc.mustache +++ b/resources/client_gen/swagger_templates/api_doc.mustache @@ -49,9 +49,10 @@ except ApiException as e: ``` ### Parameters -{{^allParams}}This endpoint does not need any parameter.{{/allParams}}{{#allParams}}{{#-last}} +{{^allParams}}This endpoint does not need any parameter.{{/allParams}}{{#allParams}} Name | Type | Description | Notes -------------- | ------------- | ------------- | -------------{{/-last}}{{/allParams}} +------------- | ------------- | ------------- | ------------- +{{/allParams}} {{#allParams}} **{{paramName}}** | {{#isFile}}**{{dataType}}**{{/isFile}}{{^isFile}}{{#isPrimitiveType}}**{{dataType}}**{{/isPrimitiveType}}{{^isPrimitiveType}}[**{{dataType}}**]({{baseType}}.md){{/isPrimitiveType}}{{/isFile}}| {{description}} | {{^required}}[optional] {{/required}}{{#defaultValue}}[default to {{defaultValue}}]{{/defaultValue}} {{/allParams}} @@ -61,7 +62,7 @@ Name | Type | Description | Notes ### Authorization -{{^authMethods}}No authorization required{{/authMethods}}{{#authMethods}}[{{{name}}}](../README.md#{{{name}}}){{^-last}}, {{/-last}}{{/authMethods}} +{{^authMethods}}No authorization required{{/authMethods}}{{#authMethods}}[{{{name}}}](../README.md#{{{name}}}){{/authMethods}} ### HTTP request headers diff --git a/resources/client_gen/swagger_templates/configuration.mustache b/resources/client_gen/swagger_templates/configuration.mustache index b9a73ae5..71f9383a 100644 --- a/resources/client_gen/swagger_templates/configuration.mustache +++ b/resources/client_gen/swagger_templates/configuration.mustache @@ -77,6 +77,8 @@ class Configuration(object): self.key_file = None # client key password self.key_password = None + # Set this to false to skip hostname verification when calling API from https server. + self.disable_host_check = None # Alternative TLS configuration: set this to an instance of ssl.SSLContext or urllib3.util.ssl_.SSLContext self.ssl_context = None @@ -201,19 +203,12 @@ class Configuration(object): :return: The Auth Settings information dict. """ return { - 'tokenAuth': + 'bearerAuth': { 'type': 'api_key', 'in': 'header', 'key': 'Authorization', - 'value': self.get_api_key_with_prefix('tokenAuth') - }, - 'basicAuth': - { - 'type': 'basic', - 'in': 'header', - 'key': 'Authorization', - 'value': self.get_basic_auth_token() + 'value': self.get_api_key_with_prefix('bearerAuth') }, {{#authMethods}} {{#isApiKey}} diff --git a/resources/client_gen/swagger_templates/model.mustache b/resources/client_gen/swagger_templates/model.mustache index c326e5bb..c272023b 100644 --- a/resources/client_gen/swagger_templates/model.mustache +++ b/resources/client_gen/swagger_templates/model.mustache @@ -83,12 +83,14 @@ class {{classname}}(object): :type: {{datatype}} """ {{#required}} +{{^isReadOnly}} if {{name}} is None: raise ValueError("Invalid value for `{{name}}`, must not be `None`") +{{/isReadOnly}} {{/required}} {{#isEnum}} {{#isContainer}} - allowed_values = [{{#allowableValues}}{{#values}}{{#items.isString}}"{{/items.isString}}{{{this}}}{{#items.isString}}"{{/items.isString}}{{^-last}}, {{/-last}}{{/values}}{{/allowableValues}}] + allowed_values = [{{#allowableValues}}{{#enumVars}}{{{value}}}, {{/enumVars}}{{/allowableValues}}] {{#isListContainer}} if not set({{{name}}}).issubset(set(allowed_values)): raise ValueError( @@ -107,7 +109,7 @@ class {{classname}}(object): {{/isMapContainer}} {{/isContainer}} {{^isContainer}} - allowed_values = [{{#allowableValues}}{{#values}}{{#isString}}"{{/isString}}{{{this}}}{{#isString}}"{{/isString}}{{^-last}}, {{/-last}}{{/values}}{{/allowableValues}}] + 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}" @@ -134,8 +136,8 @@ class {{classname}}(object): raise ValueError("Invalid value for `{{name}}`, must be a value greater than {{^exclusiveMinimum}}or equal to {{/exclusiveMinimum}}`{{minimum}}`") {{/minimum}} {{#pattern}} - if {{name}} is not None and not re.search('{{{vendorExtensions.x-regex}}}', {{name}}{{#vendorExtensions.x-modifiers}}{{#-first}}, flags={{/-first}}re.{{.}}{{^-last}} | {{/-last}}{{/vendorExtensions.x-modifiers}}): - raise ValueError("Invalid value for `{{name}}`, must be a follow pattern or equal to `{{{pattern}}}`") + if {{name}} is not None and not re.search('{{{vendorExtensions.x-regex}}}', {{name}}): + raise ValueError("Invalid value for `{{name}}`, must match pattern `{{{pattern}}}`") {{/pattern}} {{#maxItems}} if {{name}} is not None and len({{name}}) > {{maxItems}}: diff --git a/resources/client_gen/swagger_templates/rest.mustache b/resources/client_gen/swagger_templates/rest.mustache index c8dd4aa8..07f06c7c 100644 --- a/resources/client_gen/swagger_templates/rest.mustache +++ b/resources/client_gen/swagger_templates/rest.mustache @@ -56,7 +56,7 @@ class RESTClientObject(object): cert_reqs = ssl.CERT_REQUIRED if config.verify_ssl else ssl.CERT_NONE # ca_certs - ca_certs = (config.ssl_ca_cert if config.ssl_ca_cert + ca_certs = (config.ssl_ca_cert if config.ssl_ca_cert else certifi.where()) # cert_file @@ -74,42 +74,30 @@ class RESTClientObject(object): # proxy proxy = config.proxy - # https pool manager + # Common pool manager parameters + pool_kwargs = { + 'num_pools': pools_size, + 'maxsize': maxsize, + 'cert_reqs': cert_reqs, + 'ca_certs': ca_certs, + 'cert_file': cert_file, + 'key_file': key_file, + 'key_password': key_password, + 'ssl_context': ssl_context, + } + + # Only override hostname checking when user explicitly disables it + # Default urllib3 behavior (secure hostname checking) is used otherwise + if config.disable_host_check is True: + pool_kwargs['assert_hostname'] = False + + # Create appropriate pool manager based on proxy configuration if proxy and "socks" not in str(proxy): - self.pool_manager = urllib3.ProxyManager( - num_pools=pools_size, - maxsize=maxsize, - cert_reqs=cert_reqs, - ca_certs=ca_certs, - cert_file=cert_file, - key_file=key_file, - key_password=key_password, - ssl_context=ssl_context, - proxy_url=proxy - ) + self.pool_manager = urllib3.ProxyManager(proxy_url=proxy, **pool_kwargs) elif proxy and "socks" in str(proxy): - self.pool_manager = urllib3.contrib.socks.SOCKSProxyManager( - num_pools=pools_size, - maxsize=maxsize, - cert_reqs=cert_reqs, - ca_certs=ca_certs, - cert_file=cert_file, - key_file=key_file, - key_password=key_password, - ssl_context=ssl_context, - proxy_url=proxy - ) + self.pool_manager = urllib3.contrib.socks.SOCKSProxyManager(proxy_url=proxy, **pool_kwargs) else: - self.pool_manager = urllib3.PoolManager( - num_pools=pools_size, - maxsize=maxsize, - cert_reqs=cert_reqs, - ca_certs=ca_certs, - cert_file=cert_file, - key_file=key_file, - key_password=key_password, - ssl_context=ssl_context - ) + self.pool_manager = urllib3.PoolManager(**pool_kwargs) def request(self, method, url, query_params=None, headers=None, @@ -291,7 +279,7 @@ class ApiException(Exception): self.status = http_resp.status self.reason = http_resp.reason self.body = http_resp.data - self.headers = (http_resp.headers if hasattr(http_resp, 'headers') + self.headers = (http_resp.headers if hasattr(http_resp, 'headers') else http_resp.getheaders()) else: self.status = status diff --git a/resources/client_gen/swagger_templates/tox.mustache b/resources/client_gen/swagger_templates/tox.mustache deleted file mode 100644 index 7a628bda..00000000 --- a/resources/client_gen/swagger_templates/tox.mustache +++ /dev/null @@ -1,10 +0,0 @@ -[tox] -envlist = py3 - -[testenv] -deps=-r{toxinidir}/requirements.txt - -r{toxinidir}/test-requirements.txt - -commands= - nosetests \ - [] \ No newline at end of file diff --git a/resources/docker/compose.yml b/resources/docker/compose.yml new file mode 100644 index 00000000..bdfa9758 --- /dev/null +++ b/resources/docker/compose.yml @@ -0,0 +1,229 @@ +services: + # Secure LDAP profile + nifi-ldap: + image: apache/nifi:${NIFI_VERSION} + container_name: nifi-ldap + hostname: nifi-ldap + profiles: ["secure-ldap"] + ports: + - "9444:8443" + volumes: + - ../certs:/certs:ro + networks: [nipynet] + env_file: + - ../certs/nifi.env + environment: + - AUTH=ldap + # Provide TLS keystore/truststore for secure.sh + - KEYSTORE_PATH=/certs/nifi/keystore.p12 + - KEYSTORE_TYPE=PKCS12 + - KEYSTORE_PASSWORD=${CERT_PASSWORD:-changeit} + - TRUSTSTORE_PATH=/certs/truststore/truststore.p12 + - TRUSTSTORE_TYPE=PKCS12 + - TRUSTSTORE_PASSWORD=${CERT_PASSWORD:-changeit} + - INITIAL_ADMIN_IDENTITY=einstein + - LDAP_AUTHENTICATION_STRATEGY=SIMPLE + - LDAP_MANAGER_DN=cn=read-only-admin,dc=example,dc=com + - LDAP_MANAGER_PASSWORD=password + - LDAP_USER_SEARCH_BASE=dc=example,dc=com + - LDAP_USER_SEARCH_FILTER=(uid={0}) + - LDAP_IDENTITY_STRATEGY=USE_USERNAME + - LDAP_URL=ldap://ldap.forumsys.com:389 + - NIFI_WEB_PROXY_HOST=localhost:9444,localhost:8443 + + registry-ldap: + image: apache/nifi-registry:${NIFI_VERSION} + container_name: registry-ldap + hostname: registry-ldap + profiles: ["secure-ldap"] + ports: + - "18444:18443" + volumes: + - ../certs:/certs:ro + networks: [nipynet] + env_file: + - ../certs/registry.env + environment: + - NIFI_REGISTRY_WEB_HTTPS_PORT=18443 + - AUTH=ldap + # Provide TLS keystore/truststore for secure.sh + - KEYSTORE_PATH=/certs/registry/keystore.p12 + - KEYSTORE_TYPE=PKCS12 + - KEYSTORE_PASSWORD=${CERT_PASSWORD:-changeit} + - TRUSTSTORE_PATH=/certs/truststore/truststore.p12 + - TRUSTSTORE_TYPE=PKCS12 + - TRUSTSTORE_PASSWORD=${CERT_PASSWORD:-changeit} + - INITIAL_ADMIN_IDENTITY=einstein + - LDAP_AUTHENTICATION_STRATEGY=SIMPLE + - LDAP_MANAGER_DN=cn=read-only-admin,dc=example,dc=com + - LDAP_MANAGER_PASSWORD=password + - LDAP_USER_SEARCH_BASE=dc=example,dc=com + - LDAP_USER_SEARCH_FILTER=(uid={0}) + - LDAP_IDENTITY_STRATEGY=USE_USERNAME + - LDAP_URL=ldap://ldap.forumsys.com:389 + + # Secure mTLS profile + nifi-mtls: + image: apache/nifi:${NIFI_VERSION} + container_name: nifi-mtls + hostname: nifi-mtls + profiles: ["secure-mtls"] + ports: + - "9445:8443" + volumes: + - ../certs:/certs:ro + env_file: + - ../certs/nifi.env + environment: + - AUTH=tls + # Provide TLS keystore/truststore for secure.sh (two-way SSL) + - KEYSTORE_PATH=/certs/nifi/keystore.p12 + - KEYSTORE_TYPE=PKCS12 + - KEYSTORE_PASSWORD=${CERT_PASSWORD:-changeit} + - TRUSTSTORE_PATH=/certs/truststore/truststore.p12 + - TRUSTSTORE_TYPE=PKCS12 + - TRUSTSTORE_PASSWORD=${CERT_PASSWORD:-changeit} + - INITIAL_ADMIN_IDENTITY=C=US, O=NiPyAPI, CN=user1 + - NIFI_WEB_PROXY_HOST=localhost:9445,localhost:8443 + - NIFI_WEB_HTTPS_PORT=8443 + - NIFI_WEB_HTTPS_HOST=0.0.0.0 + - NIFI_SECURITY_NEEDCLIENTAUTH=true + - NIFI_SECURITY_USER_AUTHORIZER=managed-authorizer + - NIFI_SECURITY_USER_LOGIN_IDENTITY_PROVIDER= + - NIFI_SECURITY_ALLOW_ANONYMOUS_AUTHENTICATION=false + networks: [nipynet] + + registry-mtls: + image: apache/nifi-registry:${NIFI_VERSION} + container_name: registry-mtls + hostname: registry-mtls + profiles: ["secure-mtls"] + ports: + - "18445:18443" + volumes: + - ../certs:/certs:ro + env_file: + - ../certs/registry.env + environment: + - AUTH=tls + # Provide TLS keystore/truststore for secure.sh (two-way SSL) + - KEYSTORE_PATH=/certs/registry/keystore.p12 + - KEYSTORE_TYPE=PKCS12 + - KEYSTORE_PASSWORD=${CERT_PASSWORD:-changeit} + - TRUSTSTORE_PATH=/certs/truststore/truststore.p12 + - TRUSTSTORE_TYPE=PKCS12 + - TRUSTSTORE_PASSWORD=${CERT_PASSWORD:-changeit} + - INITIAL_ADMIN_IDENTITY=C=US, O=NiPyAPI, CN=user1 + - NIFI_REGISTRY_WEB_HTTPS_PORT=18443 + - NIFI_REGISTRY_WEB_HTTPS_HOST=0.0.0.0 + - NIFI_REGISTRY_SECURITY_NEEDCLIENTAUTH=true + - NIFI_REGISTRY_SECURITY_USER_AUTHORIZER=managed-authorizer + - NIFI_REGISTRY_SECURITY_IDENTITY_PROVIDER= + - NIFI_REGISTRY_SECURITY_ALLOW_ANONYMOUS_AUTHENTICATION=false + networks: [nipynet] + + # Simple single-user profile (HTTP with basic credentials) + nifi-single: + image: apache/nifi:${NIFI_VERSION} + container_name: nifi-single + hostname: nifi-single + profiles: ["single-user"] + ports: + - "9443:8443" + environment: + - SINGLE_USER_CREDENTIALS_USERNAME=einstein + - SINGLE_USER_CREDENTIALS_PASSWORD=password1234 + - NIFI_WEB_PROXY_HOST=localhost:9443,localhost:8443 + networks: [nipynet] + + registry-single: + image: apache/nifi-registry:${NIFI_VERSION} + container_name: registry-single + hostname: registry-single + profiles: ["single-user"] + ports: + - "18080:18080" + environment: + - SINGLE_USER_CREDENTIALS_USERNAME=einstein + - SINGLE_USER_CREDENTIALS_PASSWORD=password1234 + # Defaults to HTTP on 18080 in single-user mode + networks: [nipynet] + + # Keycloak OIDC Identity Provider + keycloak: + image: quay.io/keycloak/keycloak:23.0 + container_name: keycloak-oidc + hostname: keycloak-oidc + profiles: ["secure-oidc"] + ports: + - "8080:8080" + volumes: + - ./keycloak-realm.json:/opt/keycloak/data/import/realm.json:ro + environment: + - KEYCLOAK_ADMIN=admin + - KEYCLOAK_ADMIN_PASSWORD=password + - KC_HOSTNAME_STRICT=false + - KC_HOSTNAME_STRICT_HTTPS=false + - KC_HTTP_ENABLED=true + - KC_HEALTH_ENABLED=true + - KC_HOSTNAME=localhost + - KC_HOSTNAME_PORT=8080 + command: ["start-dev", "--import-realm"] + networks: [nipynet] + healthcheck: + test: ["CMD-SHELL", "exec 3<>/dev/tcp/127.0.0.1/8080;echo -e 'GET /health/ready HTTP/1.1\r\nhost: http://localhost\r\nConnection: close\r\n\r\n' >&3;grep OK <&3"] + interval: 10s + timeout: 5s + retries: 3 + start_period: 90s + + # NiFi with OIDC authentication + nifi-oidc: + image: apache/nifi:${NIFI_VERSION} + container_name: nifi-oidc + hostname: nifi-oidc + profiles: ["secure-oidc"] + ports: + - "9446:8443" + volumes: + - ../certs:/certs:ro + env_file: + - ../certs/nifi.env + environment: + - AUTH=oidc + - KEYSTORE_PATH=/certs/nifi/keystore.p12 + - KEYSTORE_TYPE=PKCS12 + - KEYSTORE_PASSWORD=${CERT_PASSWORD:-changeit} + - TRUSTSTORE_PATH=/certs/truststore/truststore.p12 + - TRUSTSTORE_TYPE=PKCS12 + - TRUSTSTORE_PASSWORD=${CERT_PASSWORD:-changeit} + - INITIAL_ADMIN_IDENTITY=einstein@example.com + - NIFI_SECURITY_USER_OIDC_DISCOVERY_URL=http://keycloak-oidc:8080/realms/nipyapi/.well-known/openid-configuration + - NIFI_SECURITY_USER_OIDC_CLIENT_ID=nipyapi-client + - NIFI_SECURITY_USER_OIDC_CLIENT_SECRET=nipyapi-secret + - NIFI_SECURITY_USER_OIDC_CLAIM_IDENTIFYING_USER=email + - NIFI_SECURITY_USER_AUTHORIZER=managed-authorizer + - NIFI_SECURITY_USER_LOGIN_IDENTITY_PROVIDER= + - NIFI_SECURITY_ALLOW_ANONYMOUS_AUTHENTICATION=false + - NIFI_WEB_PROXY_HOST=localhost:9446,localhost:8443 + networks: [nipynet] + depends_on: + keycloak: + condition: service_healthy + + # Registry for OIDC profile (simple HTTP for now) + registry-oidc: + image: apache/nifi-registry:${NIFI_VERSION} + container_name: registry-oidc + hostname: registry-oidc + profiles: ["secure-oidc"] + ports: + - "18446:18080" + environment: + - SINGLE_USER_CREDENTIALS_USERNAME=einstein + - SINGLE_USER_CREDENTIALS_PASSWORD=password1234 + networks: [nipynet] + +networks: + nipynet: + driver: bridge diff --git a/resources/docker/dockerhub/Dockerfile b/resources/docker/dockerhub/Dockerfile deleted file mode 100644 index 160b95a8..00000000 --- a/resources/docker/dockerhub/Dockerfile +++ /dev/null @@ -1,42 +0,0 @@ -# Licensed to the Apache Software Foundation (ASF) under one -# or more contributor license agreements. See the NOTICE file -# distributed with this work for additional information -# regarding copyright ownership. The ASF licenses this file -# to you under the Apache License, Version 2.0 (the -# "License"); you may not use this file except in compliance -# with the License. You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, -# software distributed under the License is distributed on an -# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY -# KIND, either express or implied. See the License for the -# specific language governing permissions and limitations -# under the License. -# - -FROM python:3.8-alpine - -LABEL maintainer="Dan Chaffelson " -LABEL site="https://github.com/Chaffelson/nipyapi" - -ENV PYTHONUNBUFFERED=0 -ENV TZ=${TZ:-"Europe/London"} -ENV BRANCH=${BRANCH:-"master"} - -RUN apk update && apk upgrade \ - && apk add --no-cache --virtual .build-deps git gcc libffi-dev musl-dev \ - libressl-dev ca-certificates python3-dev linux-headers tzdata \ - && apk add --no-cache libxslt-dev libxml2-dev libgcrypt-dev \ - && cp /usr/share/zoneinfo/${TZ} /etc/localtime && echo ${TZ} > /etc/timezone \ - && git clone -b ${BRANCH} --depth 1 https://github.com/Chaffelson/nipyapi.git /nipyapi \ - && cd /nipyapi \ - && pip install --no-cache -r requirements.txt \ - && apk del .build-deps - - -WORKDIR /nipyapi -ENV PYTHONPATH=/nipyapi - -ENTRYPOINT ["python3"] diff --git a/resources/docker/keycloak-realm.json b/resources/docker/keycloak-realm.json new file mode 100644 index 00000000..caae121c --- /dev/null +++ b/resources/docker/keycloak-realm.json @@ -0,0 +1,130 @@ +{ + "realm": "nipyapi", + "enabled": true, + "displayName": "NiPyAPI Test Realm", + "displayNameHtml": "
NiPyAPI Test Realm
", + "loginTheme": "keycloak", + "adminTheme": "keycloak", + "accountTheme": "keycloak", + "emailTheme": "keycloak", + "sslRequired": "none", + "registrationAllowed": false, + "registrationEmailAsUsername": true, + "rememberMe": true, + "verifyEmail": false, + "loginWithEmailAllowed": true, + "duplicateEmailsAllowed": false, + "resetPasswordAllowed": true, + "editUsernameAllowed": false, + "bruteForceProtected": false, + "permanentLockout": false, + "accessTokenLifespan": 3600, + "accessTokenLifespanForImplicitFlow": 900, + "ssoSessionIdleTimeout": 1800, + "ssoSessionMaxLifespan": 36000, + "offlineSessionIdleTimeout": 2592000, + "offlineSessionMaxLifespanEnabled": false, + "accessCodeLifespan": 60, + "accessCodeLifespanUserAction": 300, + "accessCodeLifespanLogin": 1800, + "users": [ + { + "username": "einstein", + "enabled": true, + "emailVerified": true, + "firstName": "Albert", + "lastName": "Einstein", + "email": "einstein@example.com", + "credentials": [ + { + "type": "password", + "value": "password1234", + "temporary": false + } + ], + "realmRoles": [ + "user" + ] + } + ], + "roles": { + "realm": [ + { + "name": "user", + "description": "Standard user role" + } + ] + }, + "clients": [ + { + "clientId": "nipyapi-client", + "name": "NiPyAPI Client", + "description": "OpenID Connect client for NiPyAPI testing", + "enabled": true, + "clientAuthenticatorType": "client-secret", + "secret": "nipyapi-secret", + "redirectUris": [ + "https://localhost:9446/nifi-api/access/oidc/callback", + "https://localhost:9446/nifi-api/access/oidc/logoutCallback" + ], + "webOrigins": [ + "https://localhost:9446" + ], + "protocol": "openid-connect", + "publicClient": false, + "bearerOnly": false, + "consentRequired": false, + "standardFlowEnabled": true, + "implicitFlowEnabled": false, + "directAccessGrantsEnabled": true, + "serviceAccountsEnabled": false, + "authorizationServicesEnabled": false, + "fullScopeAllowed": true, + "nodeReRegistrationTimeout": -1, + "protocolMappers": [ + { + "name": "email", + "protocol": "openid-connect", + "protocolMapper": "oidc-usermodel-property-mapper", + "consentRequired": false, + "config": { + "userinfo.token.claim": "true", + "user.attribute": "email", + "id.token.claim": "true", + "access.token.claim": "true", + "claim.name": "email", + "jsonType.label": "String" + } + }, + { + "name": "given_name", + "protocol": "openid-connect", + "protocolMapper": "oidc-usermodel-property-mapper", + "consentRequired": false, + "config": { + "userinfo.token.claim": "true", + "user.attribute": "firstName", + "id.token.claim": "true", + "access.token.claim": "true", + "claim.name": "given_name", + "jsonType.label": "String" + } + }, + { + "name": "family_name", + "protocol": "openid-connect", + "protocolMapper": "oidc-usermodel-property-mapper", + "consentRequired": false, + "config": { + "userinfo.token.claim": "true", + "user.attribute": "lastName", + "id.token.claim": "true", + "access.token.claim": "true", + "claim.name": "family_name", + "jsonType.label": "String" + } + } + ] + } + ] +} diff --git a/resources/docker/latest/docker-compose.yml b/resources/docker/latest/docker-compose.yml deleted file mode 100644 index 46e93196..00000000 --- a/resources/docker/latest/docker-compose.yml +++ /dev/null @@ -1,16 +0,0 @@ -services: - nifi: - image: apache/nifi:1.28.1 - container_name: nifi - hostname: nifi - ports: - - "8443:8443" - environment: - - SINGLE_USER_CREDENTIALS_USERNAME=nobel - - SINGLE_USER_CREDENTIALS_PASSWORD=supersecret1! - registry: - image: apache/nifi-registry:1.28.1 - container_name: registry - hostname: registry - ports: - - "18080:18080" diff --git a/resources/docker/latest/readme.md b/resources/docker/latest/readme.md deleted file mode 100644 index c02b57b6..00000000 --- a/resources/docker/latest/readme.md +++ /dev/null @@ -1,23 +0,0 @@ -# Docker Compose for NiPyApi test environment - -## Pre-Requisites - -- install docker-compose [https://docs.docker.com/compose/install/](https://docs.docker.com/compose/install/) - -## Usage - -Start a cluster: - -- ```docker-compose up -d ``` - -Stop a cluster: - -- ```docker-compose stop``` - -## Environment Details - -- Apache NiFi 1.5.0 available on port 8080 -- Apache NiFi-Registry 0.1.0 available on port 18080 - -### Notes -None diff --git a/resources/docker/localdev/Dockerfile b/resources/docker/localdev/Dockerfile deleted file mode 100644 index 1e47193c..00000000 --- a/resources/docker/localdev/Dockerfile +++ /dev/null @@ -1,41 +0,0 @@ -# Licensed to the Apache Software Foundation (ASF) under one -# or more contributor license agreements. See the NOTICE file -# distributed with this work for additional information -# regarding copyright ownership. The ASF licenses this file -# to you under the Apache License, Version 2.0 (the -# "License"); you may not use this file except in compliance -# with the License. You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, -# software distributed under the License is distributed on an -# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY -# KIND, either express or implied. See the License for the -# specific language governing permissions and limitations -# under the License. -# - -FROM python:3.6-alpine - -LABEL maintainer="Dan Chaffelson " -LABEL site="https://github.com/Chaffelson/nipyapi" - -ENV PYTHONUNBUFFERED=0 -ENV TZ=${TZ:-"Europe/London"} -ENV BRANCH=${BRANCH:-"master"} - -RUN apk update && apk upgrade \ - && apk add --no-cache --virtual .build-deps git gcc libffi-dev musl-dev \ - libressl-dev ca-certificates python3-dev linux-headers tzdata \ - && apk add --no-cache libxslt-dev libxml2-dev libgcrypt-dev \ - && cp /usr/share/zoneinfo/${TZ} /etc/localtime && echo ${TZ} > /etc/timezone - -COPY . /nipyapi -WORKDIR /nipyapi - -RUN pip install --no-cache --no-use-pep517 -r requirements.txt - -ENV PYTHONPATH=/nipyapi - -ENTRYPOINT ["python3"] diff --git a/resources/docker/secure-ldap/docker-compose.yml b/resources/docker/secure-ldap/docker-compose.yml deleted file mode 100644 index fd97cf40..00000000 --- a/resources/docker/secure-ldap/docker-compose.yml +++ /dev/null @@ -1,51 +0,0 @@ -services: - secure-nifi: - image: apache/nifi:1.28.1 - container_name: secure-nifi - hostname: secure-nifi - ports: - - "9443:8443" - volumes: - - ../../../nipyapi/demo/keys:/opt/certs:z # Min docker version tested 18, does not work on old docker - environment: - - AUTH=ldap - - KEYSTORE_PATH=/opt/certs/localhost-ks.jks - - KEYSTORE_TYPE=JKS - - KEYSTORE_PASSWORD=localhostKeystorePassword - - TRUSTSTORE_PATH=/opt/certs/localhost-ts.jks - - TRUSTSTORE_PASSWORD=localhostTruststorePassword - - TRUSTSTORE_TYPE=JKS - - INITIAL_ADMIN_IDENTITY=nobel - - LDAP_AUTHENTICATION_STRATEGY=SIMPLE - - LDAP_MANAGER_DN=cn=read-only-admin,dc=example,dc=com - - LDAP_MANAGER_PASSWORD=password - - LDAP_USER_SEARCH_BASE=dc=example,dc=com - - LDAP_USER_SEARCH_FILTER=(uid={0}) - - LDAP_IDENTITY_STRATEGY=USE_USERNAME - - LDAP_URL=ldap://ldap.forumsys.com:389 - - NIFI_WEB_PROXY_HOST=localhost:9443,localhost:8443 - secure-registry: - image: apache/nifi-registry:1.28.1 - container_name: secure-registry - hostname: secure-registry - ports: - - "18443:18443" - volumes: - - ../../../nipyapi/demo/keys:/opt/certs:z - environment: - - NIFI_REGISTRY_WEB_HTTPS_PORT=18443 - - AUTH=ldap - - KEYSTORE_PATH=/opt/certs/localhost-ks.jks - - KEYSTORE_TYPE=JKS - - KEYSTORE_PASSWORD=localhostKeystorePassword - - TRUSTSTORE_PATH=/opt/certs/localhost-ts.jks - - TRUSTSTORE_PASSWORD=localhostTruststorePassword - - TRUSTSTORE_TYPE=JKS - - INITIAL_ADMIN_IDENTITY=nobel - - LDAP_AUTHENTICATION_STRATEGY=SIMPLE - - LDAP_MANAGER_DN=cn=read-only-admin,dc=example,dc=com - - LDAP_MANAGER_PASSWORD=password - - LDAP_USER_SEARCH_BASE=dc=example,dc=com - - LDAP_USER_SEARCH_FILTER=(uid={0}) - - LDAP_IDENTITY_STRATEGY=USE_USERNAME - - LDAP_URL=ldap://ldap.forumsys.com:389 diff --git a/resources/docker/secure-mtls/docker-compose.yml b/resources/docker/secure-mtls/docker-compose.yml deleted file mode 100644 index 16c907c5..00000000 --- a/resources/docker/secure-mtls/docker-compose.yml +++ /dev/null @@ -1,59 +0,0 @@ -services: - secure-nifi: - image: apache/nifi:1.28.1 - container_name: secure-nifi - hostname: secure-nifi - ports: - - "9443:8443" - volumes: - - ../../../nipyapi/demo/keys:/opt/certs:z - environment: - - AUTH=tls - - KEYSTORE_PATH=/opt/certs/localhost-ks.jks - - KEYSTORE_TYPE=JKS - - KEYSTORE_PASSWORD=localhostKeystorePassword - - TRUSTSTORE_PATH=/opt/certs/localhost-ts.jks - - TRUSTSTORE_PASSWORD=localhostTruststorePassword - - TRUSTSTORE_TYPE=JKS - - INITIAL_ADMIN_IDENTITY=CN=user1, OU=nifi - - NIFI_WEB_PROXY_HOST=localhost:9443,localhost:8443 - - NIFI_WEB_HTTPS_PORT=8443 - - NIFI_WEB_HTTPS_HOST=0.0.0.0 - - NIFI_SECURITY_NEEDCLIENTAUTH=true - - NIFI_SECURITY_USER_AUTHORIZER=managed-authorizer - - NIFI_SECURITY_USER_LOGIN_IDENTITY_PROVIDER= - - NIFI_SECURITY_ALLOW_ANONYMOUS_AUTHENTICATION=false - - SINGLE_USER_CREDENTIALS_USERNAME= - - SINGLE_USER_CREDENTIALS_PASSWORD= - networks: - - nifi-net - - secure-registry: - image: apache/nifi-registry:1.28.1 - container_name: secure-registry - hostname: secure-registry - ports: - - "18443:18443" - volumes: - - ../../../nipyapi/demo/keys:/opt/certs:z - environment: - - AUTH=tls - - KEYSTORE_PATH=/opt/certs/localhost-ks.jks - - KEYSTORE_TYPE=JKS - - KEYSTORE_PASSWORD=localhostKeystorePassword - - TRUSTSTORE_PATH=/opt/certs/localhost-ts.jks - - TRUSTSTORE_PASSWORD=localhostTruststorePassword - - TRUSTSTORE_TYPE=JKS - - INITIAL_ADMIN_IDENTITY=CN=user1, OU=nifi - - NIFI_REGISTRY_WEB_HTTPS_PORT=18443 - - NIFI_REGISTRY_WEB_HTTPS_HOST=0.0.0.0 - - NIFI_REGISTRY_SECURITY_NEEDCLIENTAUTH=true - - NIFI_REGISTRY_SECURITY_USER_AUTHORIZER=managed-authorizer - - NIFI_REGISTRY_SECURITY_IDENTITY_PROVIDER= - - NIFI_REGISTRY_SECURITY_ALLOW_ANONYMOUS_AUTHENTICATION=false - networks: - - nifi-net - -networks: - nifi-net: - driver: bridge \ No newline at end of file diff --git a/resources/docker/tox-full/docker-compose.yml b/resources/docker/tox-full/docker-compose.yml deleted file mode 100644 index 340298d6..00000000 --- a/resources/docker/tox-full/docker-compose.yml +++ /dev/null @@ -1,50 +0,0 @@ -services: - nifi-192: - image: apache/nifi:1.9.2 - container_name: nifi-192 - hostname: nifi-192 - ports: - - "10192:8080" - nifi-127: - image: apache/nifi:1.27.0 - container_name: nifi-127 - hostname: nifi-127 - ports: - - "10127:10127" - environment: - - SINGLE_USER_CREDENTIALS_USERNAME=nobel - - SINGLE_USER_CREDENTIALS_PASSWORD=supersecret1! - - NIFI_WEB_HTTPS_PORT=10127 - nifi: - image: apache/nifi:1.28.1 - container_name: nifi - hostname: nifi - ports: - - "8443:8443" - environment: - - SINGLE_USER_CREDENTIALS_USERNAME=nobel - - SINGLE_USER_CREDENTIALS_PASSWORD=supersecret1! - registry-030: - image: apache/nifi-registry:0.3.0 - container_name: registry-030 - hostname: registry-030 - ports: - - "18030:18030" - environment: - - NIFI_REGISTRY_WEB_HTTP_PORT=18030 - registry-127: - image: apache/nifi-registry:1.27.0 - container_name: registry-127 - hostname: registry-127 - ports: - - "18127:18127" - environment: - - NIFI_REGISTRY_WEB_HTTP_PORT=18127 - registry: - image: apache/nifi-registry:1.28.1 - container_name: registry - hostname: registry - ports: - - "18080:18080" - environment: - - NIFI_REGISTRY_WEB_HTTP_PORT=18080 diff --git a/resources/docker/tox-full/readme.md b/resources/docker/tox-full/readme.md deleted file mode 100644 index 8b029d3a..00000000 --- a/resources/docker/tox-full/readme.md +++ /dev/null @@ -1,19 +0,0 @@ -# Docker Compose for NiPyApi test environment - -## Pre-Requisites - -- install docker-compose [https://docs.docker.com/compose/install/](https://docs.docker.com/compose/install/) - -## Usage - -Start a cluster: - -- ```docker-compose up -d ``` - -Stop a cluster: - -- ```docker-compose stop``` - - -### Notes -Where possible the latest version will be available on the default port, with older versions on identifiable ports for back testing diff --git a/resources/scripts/test_distribution.py b/resources/scripts/test_distribution.py new file mode 100644 index 00000000..7904016d --- /dev/null +++ b/resources/scripts/test_distribution.py @@ -0,0 +1,138 @@ +#!/usr/bin/env python3 +""" +Distribution validation script for nipyapi. + +Tests that a built wheel/sdist can be installed and imported in a clean environment. +This should be run as part of the release process to ensure the packaged distribution +actually works before publishing to PyPI. + +Usage: + python resources/scripts/test_distribution.py + +Or via make: + make test-dist +""" +import tempfile +import subprocess +import sys +import os +import glob + +def validate_distribution(): + """Test that the built wheel can be imported and used in a clean environment.""" + + # Find wheel file + wheels = glob.glob('dist/*.whl') + if not wheels: + print("โŒ No wheel found in dist/ directory") + print("Run 'make dist' first to build distribution") + return False + + wheel_file = wheels[0] + wheel_name = os.path.basename(wheel_file) + + print(f"๐Ÿงช Testing distribution: {wheel_name}") + + with tempfile.TemporaryDirectory() as tmpdir: + venv_path = os.path.join(tmpdir, 'test_env') + + print("๐Ÿ“ฆ Creating clean virtual environment...") + try: + subprocess.run([ + sys.executable, '-m', 'venv', venv_path + ], check=True, capture_output=True) + except subprocess.CalledProcessError as e: + print(f"โŒ Failed to create virtual environment: {e}") + return False + + # Set up paths for the virtual environment + if os.name == 'nt': # Windows + pip_path = os.path.join(venv_path, 'Scripts', 'pip') + python_path = os.path.join(venv_path, 'Scripts', 'python') + else: # Unix/Linux/macOS + pip_path = os.path.join(venv_path, 'bin', 'pip') + python_path = os.path.join(venv_path, 'bin', 'python') + + print(f"๐Ÿ“ฅ Installing wheel: {wheel_name}") + try: + subprocess.run([ + pip_path, 'install', wheel_file + ], check=True, capture_output=True) + except subprocess.CalledProcessError as e: + print(f"โŒ Failed to install wheel: {e}") + return False + + print("๐Ÿ” Testing imports and basic functionality...") + + test_script = ''' +import sys +try: + print("=== Import Tests ===") + + # Test main import + import nipyapi + print(f"โœ… nipyapi imported: {nipyapi.__version__}") + + # Test core modules + import nipyapi.canvas + import nipyapi.security + import nipyapi.utils + print("โœ… Core modules imported successfully") + + # Test generated API clients + import nipyapi.nifi + import nipyapi.registry + print("โœ… Generated API clients imported successfully") + + # Test basic functionality + test_data = {"test": "data", "numbers": [1, 2, 3]} + yaml_output = nipyapi.utils.dump(test_data, mode="yaml") + json_output = nipyapi.utils.dump(test_data, mode="json") + + # Test round-trip + loaded_yaml = nipyapi.utils.load(yaml_output) + loaded_json = nipyapi.utils.load(json_output) + + if loaded_yaml == test_data and loaded_json == test_data: + print("โœ… YAML/JSON round-trip functionality works") + else: + print("โŒ YAML/JSON round-trip failed") + sys.exit(1) + + print("โœ… All import and functionality tests passed!") + +except Exception as e: + print(f"โŒ Test failed: {e}") + import traceback + traceback.print_exc() + sys.exit(1) +''' + + try: + result = subprocess.run([ + python_path, '-c', test_script + ], capture_output=True, text=True, timeout=30) + + print(result.stdout) + + if result.stderr: + print(f"STDERR: {result.stderr}") + + if result.returncode != 0: + print("โŒ Import tests failed!") + return False + + except subprocess.TimeoutExpired: + print("โŒ Test timed out after 30 seconds") + return False + except subprocess.CalledProcessError as e: + print(f"โŒ Test execution failed: {e}") + return False + + print("๐ŸŽ‰ Distribution validation successful!") + print("The built wheel can be installed and imported correctly.") + return True + +if __name__ == "__main__": + success = validate_distribution() + sys.exit(0 if success else 1) diff --git a/resources/scripts/wait_ready.py b/resources/scripts/wait_ready.py new file mode 100644 index 00000000..ba82e383 --- /dev/null +++ b/resources/scripts/wait_ready.py @@ -0,0 +1,93 @@ +#!/usr/bin/env python3 +""" +Readiness probe for NiFi and NiFi Registry using nipyapi profiles and client functions. + +Environment: + - NIPYAPI_PROFILE (required): Profile name to configure endpoints and SSL settings + - WAIT_TIMEOUT (optional, default=60): Timeout in seconds for readiness checks + +Endpoints and SSL configuration are read from the specified profile. +Tests both UI and API endpoints with fallback logic using enhanced client functions. +""" +import os +import sys +import logging +from datetime import datetime + +import nipyapi.utils +import nipyapi.profiles + +# Configure logging to show nipyapi connection attempt details +logging.basicConfig( + level=logging.INFO, + format='%(message)s' +) + + +def wait_for_endpoint(url: str, name: str, timeout: int = 60) -> bool: + """Wait for an endpoint to be ready using nipyapi client functions.""" + print(f"[{datetime.now().isoformat(timespec='seconds')}] Waiting for {name} (timeout={timeout}s)") + + try: + result = nipyapi.utils.wait_to_complete( + nipyapi.utils.is_endpoint_up, + url, + nipyapi_delay=3, + nipyapi_max_wait=timeout + ) + if result: + print(f" READY: {name}") + return True + except ValueError: # Timeout + pass + + print(f" NOT READY within {timeout}s: {name}") + return False + + +def main() -> int: + profile_name = os.getenv('NIPYAPI_PROFILE') + timeout = int(os.getenv('WAIT_TIMEOUT', '60')) + + if not profile_name: + print("ERROR: NIPYAPI_PROFILE must be set") + return 2 + + # Configure using profile system (default file resolution handled automatically) + try: + nipyapi.profiles.switch(profile_name, login=False) + config = nipyapi.profiles.resolve_profile_config(profile_name=profile_name) + print(f"Using profile: {profile_name}") + nifi_url = config.get('nifi_url') + registry_url = config.get('registry_url') + except Exception as e: + print(f"ERROR: Failed to configure profile {profile_name}: {e}") + return 2 + + results = [] + + # Check NiFi if configured + if nifi_url: + nifi_ui = nifi_url.replace('/nifi-api', '/nifi/') + ok1 = (wait_for_endpoint(nifi_ui, 'NiFi UI', timeout) or + wait_for_endpoint(nifi_url + '/flow/about', 'NiFi API', timeout)) + results.append(ok1) + + # Check Registry if configured + if registry_url: + registry_ui = registry_url.replace('/nifi-registry-api', '/nifi-registry/') + ok2 = (wait_for_endpoint(registry_ui, 'Registry UI', timeout) or + wait_for_endpoint(registry_url + '/about', 'Registry API', timeout)) + results.append(ok2) + + if not results: + print("ERROR: No endpoints configured in profile") + return 2 + + rc = 0 if all(results) else 1 + print(f"Overall readiness: {'READY' if rc == 0 else 'NOT READY'}") + return rc + + +if __name__ == '__main__': + sys.exit(main()) diff --git a/resources/test_setup/setup_centos7.sh b/resources/test_setup/setup_centos7.sh deleted file mode 100644 index 9a86e1da..00000000 --- a/resources/test_setup/setup_centos7.sh +++ /dev/null @@ -1,19 +0,0 @@ -#!/usr/bin/env bash - -set -x -set -e -set -u - -sudo yum-config-manager --add-repo https://download.docker.com/linux/centos/docker-ce.repo -sudo yum update -y -sudo yum install -y centos-release-scl yum-utils device-mapper-persistent-data lvm2 -sudo yum install -y rh-python38 docker -sudo systemctl start docker -sudo curl -L "https://github.com/docker/compose/releases/download/1.29.2/docker-compose-$(uname -s)-$(uname -m)" -o /usr/local/bin/docker-compose -sudo chmod +x /usr/local/bin/docker-compose -sudo ln -s /usr/local/bin/docker-compose /usr/bin/docker-compose -source /opt/rh/rh-python38/enable -pip install --upgrade pip -pip install -r ../../requirements.txt -pip install -r ../../requirements_dev.txts - diff --git a/setup.cfg b/setup.cfg index dd64434a..38c48753 100644 --- a/setup.cfg +++ b/setup.cfg @@ -1,15 +1,32 @@ -[bumpversion] -current_version = 0.22.0 -commit = True -tag = True +[bdist_wheel] +universal = 1 -[bumpversion:file:setup.py] -search = proj_version = '{current_version}' -replace = proj_version = '{new_version}' +[flake8] +max-line-length = 100 +exclude = + .git, + __pycache__, + build, + dist, + docs, + resources/client_gen/, + tests/, + nipyapi/nifi/, + nipyapi/registry/ -[bumpversion:file:nipyapi/__init__.py] -search = __version__ = '{current_version}' -replace = __version__ = '{new_version}' +[coverage:run] +source = nipyapi +omit = + nipyapi/nifi/* + nipyapi/registry/* + nipyapi/_version.py + */tests/* + */test_* -[bdist_wheel] -universal = 1 +[coverage:report] +exclude_lines = + pragma: no cover + def __repr__ + raise AssertionError + raise NotImplementedError + if __name__ == .__main__.: diff --git a/setup.py b/setup.py index 2ef75d7a..e8b84391 100644 --- a/setup.py +++ b/setup.py @@ -1,65 +1,12 @@ #!/usr/bin/env python # -*- coding: utf-8 -*- -"""The setup script.""" +"""Legacy shim delegating to declarative config. -from setuptools import setup, find_packages +Setuptools will pick metadata from pyproject.toml. Keep a minimal setup() call +for compatibility with tooling that still invokes setup.py. +""" -with open('README.rst') as readme_file: - readme = readme_file.read() +from setuptools import setup -with open('docs/history.rst') as history_file: - history = history_file.read() - -proj_version = '0.22.0' - -with open('requirements.txt') as reqs_file: - requirements = reqs_file.read().splitlines() - -tests_require=[ - 'pytest>=7.2.0' -] - -extras_require={ - 'demo': ['docker>=2.5.1'] -} - -setup( - name='nipyapi', - version=proj_version, - description="Nifi-Python-Api: A convenient Python wrapper for the Apache NiFi Rest API", - long_description=readme + '\n\n' + history, - author="Daniel Chaffelson", - author_email='chaffelson@gmail.com', - url='https://github.com/Chaffelson/nipyapi', - download_url='https://github.com/Chaffelson/nipyapi/archive/' + proj_version + '.tar.gz', - packages=find_packages( - include=['nipyapi'], - exclude=['*.tests', '*.tests.*', 'tests.*', 'tests'] - ), - include_package_data=True, - install_requires=requirements, - tests_require=tests_require, - extras_require=extras_require, - license="Apache Software License 2.0", - zip_safe=False, - keywords=['nipyapi', 'nifi', 'api', 'wrapper'], - classifiers=[ - 'Development Status :: 3 - Alpha', - 'Environment :: Console', - 'Intended Audience :: Developers', - 'Intended Audience :: System Administrators', - 'License :: OSI Approved :: Apache Software License', - 'Natural Language :: English', - 'Operating System :: MacOS', - 'Operating System :: Microsoft :: Windows', - 'Operating System :: POSIX :: Linux', - 'Programming Language :: Python :: 3', - 'Programming Language :: Python :: 3.9', - 'Programming Language :: Python :: 3.10', - 'Programming Language :: Python :: 3.11', - 'Programming Language :: Python :: 3.12', - 'Topic :: Software Development :: User Interfaces' - ], - test_suite='tests' -) +setup() diff --git a/tests/conftest.py b/tests/conftest.py index 2619ac7b..f73c1bbc 100644 --- a/tests/conftest.py +++ b/tests/conftest.py @@ -2,22 +2,32 @@ import logging import pytest -from os import path +import os from collections import namedtuple -from time import sleep import nipyapi +import nipyapi.profiles log = logging.getLogger(__name__) -# Test Suite Controls -test_default = True # Default to True for release -test_ldap = False # Default to False for release -test_mtls = False # Default to False for release -test_regression = False # Default to False for release + +ACTIVE_PROFILE = os.getenv('NIPYAPI_PROFILE', 'single-user').strip() + +# Validate profile early and fail fast +if ACTIVE_PROFILE not in ('single-user', 'secure-ldap', 'secure-mtls', 'secure-oidc'): + raise ValueError(f"Invalid NIPYAPI_PROFILE: {ACTIVE_PROFILE}. Must be one of: single-user, secure-ldap, secure-mtls, secure-oidc") + +def _flag(name: str, default: bool = False) -> bool: + val = os.getenv(name) + if val is None: + return default + return str(val).strip().lower() in ("1", "true", "yes", "on") + +SKIP_TEARDOWN = _flag('SKIP_TEARDOWN', default=False) +ACTIVE_CONFIG = None + # Test Configuration parameters -test_host = nipyapi.config.default_host test_basename = "nipyapi_test" test_pg_name = test_basename + "_ProcessGroup" test_another_pg_name = test_basename + "_AnotherProcessGroup" @@ -40,113 +50,6 @@ test_user_name = test_basename + '_user' test_user_group_name = test_basename + '_user_group' -test_resource_dir = 'resources' -# Test template filenames should match the template PG name -test_templates = { - 'basic': test_basename + 'Template_00', - 'greedy': test_basename + 'Template_00_greedy', - 'complex': test_basename + 'Template_01' -} - -# Determining test environment -# Mostly because loading up all the environments takes too long - -default_nifi_endpoints = [('https://' + test_host + ':8443/nifi-api', True, True, 'nobel', 'supersecret1!')] -regress_nifi_endpoints = [ - ('http://' + test_host + ':10192/nifi-api', True, True, None, None), - ('https://' + test_host + ':10127/nifi-api', True, True, 'nobel', 'supersecret1!'), -] -ldap_nifi_endpoints = [('https://' + test_host + ':9443/nifi-api', True, True, 'nobel', 'password')] -mtls_nifi_endpoints = [('https://' + test_host + ':9443/nifi-api', True, False, None, None)] -default_registry_endpoints = [ - (('http://' + test_host + ':18080/nifi-registry-api', True, True, None, None), - 'http://registry:18080', - ('https://' + test_host + ':8443/nifi-api', True, True, 'nobel', 'supersecret1!') - ) -] -regress_registry_endpoints = [ - (('http://' + test_host + ':18030/nifi-registry-api', True, True, None, None), - 'http://registry-030:18030', - ('http://' + test_host + ':10192/nifi-api', True, True, None, None) - ), - (('http://' + test_host + ':18127/nifi-registry-api', True, True, None, None), - 'http://registry-127:18127', - ('https://' + test_host + ':10127/nifi-api', True, True, 'nobel', 'supersecret1!') - ) - ] -ldap_registry_endpoints = [ - (('https://' + test_host + ':18443/nifi-registry-api', True, True, None, None), - 'https://secure-registry:18443', - ('https://' + test_host + ':9443/nifi-api', True, True, 'nobel', 'password') - )] -mtls_registry_endpoints = [ - (('https://' + test_host + ':18443/nifi-registry-api', True, False, None, None), - 'https://secure-registry:18443', - ('https://' + test_host + ':9443/nifi-api', True, False, None, None) - )] - -log.info("Setting up Test Endpoints") -# Note that these endpoints are assumed to be available -# look in Nipyapi/test_env_config/docker_compose_full_test for -# convenient Docker configs and port mappings. - -# NOTE: it is important that the latest version is the last in the list -# So that after a parametrized test we leave the single tests against -# The latest release without bulking the test suite ensuring they change -# back each time. -nifi_test_endpoints = [] -registry_test_endpoints = [] -if test_default or test_regression or test_ldap: - # Added because nifi-1.15+ automatically self-signs certificates for single user mode - nipyapi.config.nifi_config.verify_ssl = False - nipyapi.config.disable_insecure_request_warnings = True -if test_default: - nifi_test_endpoints += default_nifi_endpoints - registry_test_endpoints += default_registry_endpoints -if test_regression: - nifi_test_endpoints += regress_nifi_endpoints - registry_test_endpoints += regress_registry_endpoints -if test_ldap: - nifi_test_endpoints += ldap_nifi_endpoints - registry_test_endpoints += ldap_registry_endpoints -if test_mtls: - nifi_test_endpoints += mtls_nifi_endpoints - registry_test_endpoints += mtls_registry_endpoints - - -# 'regress' generates tests against previous versions of NiFi or sub-projects. -# If you are using regression, note that you have to create NiFi objects within -# the Test itself. This is because the fixture is generated before the -# PyTest parametrize call, making the order -# new test_func > fixtures > parametrize > run_test_func > teardown > next -def pytest_generate_tests(metafunc): - log.info("Metafunc Fixturenames are %s", metafunc.fixturenames) - if 'regress_nifi' in metafunc.fixturenames: - log.info("NiFi Regression testing requested for ({0})." - .format(metafunc.function.__name__)) - metafunc.parametrize( - argnames='regress_nifi', - argvalues=nifi_test_endpoints, - indirect=True - ) - elif 'regress_flow_reg' in metafunc.fixturenames: - log.info("NiFi Flow Registry Regression testing requested for ({0})." - .format(metafunc.function.__name__)) - metafunc.parametrize( - argnames='regress_flow_reg', - argvalues=registry_test_endpoints, - indirect=True - ) - - -# Note that it's important that the regress function is the first called if -# you are stacking fixtures -@pytest.fixture(scope="function") -def regress_nifi(request): - log.info("NiFi Regression test setup called against endpoint %s", - request.param[0]) - nipyapi.utils.set_endpoint(*request.param) - def remove_test_registry_client(): _ = [nipyapi.versioning.delete_registry_client(li) for @@ -155,126 +58,82 @@ def remove_test_registry_client(): ] -def ensure_registry_client(uri): - # Fetch the ssl context from the controller service if it exists - print('generating registry client for url {}'.format(uri)) - ssl_context = nipyapi.canvas.get_controller(test_ssl_controller_name, 'name') - if 'https' in uri: - if ssl_context is None: - ssl_context = nipyapi.security.create_ssl_context_controller_service( - parent_pg=nipyapi.canvas.get_process_group(nipyapi.canvas.get_root_pg_id(), 'id'), - name=test_ssl_controller_name, - keystore_file='/opt/certs/localhost-ks.jks', - keystore_password='localhostKeystorePassword', - truststore_file='/opt/certs/localhost-ts.jks', - truststore_password='localhostTruststorePassword' - ) - nipyapi.canvas.schedule_controller(ssl_context, scheduled=True, refresh=True) - try: - client = nipyapi.versioning.create_registry_client( - name=test_registry_client_name + uri, - uri=uri, - description=uri, - ssl_context_service=ssl_context - ) - except ValueError as e: - if 'already exists with the name' in str(e): - client = nipyapi.versioning.get_registry_client( - identifier=test_registry_client_name + uri - ) - else: - raise e - if isinstance(client, nipyapi.nifi.FlowRegistryClientEntity): - return client - else: - raise ValueError("Could not create Registry Client") - - -@pytest.fixture(scope="function") -def regress_flow_reg(request): - log.info("NiFi-Registry regression test called against endpoints %s", - request.param[0][0]) - # Set Registry connection - nipyapi.utils.set_endpoint(*request.param[0]) - # Set paired NiFi connection - nipyapi.utils.set_endpoint(*request.param[2]) - # because pytest won't let you easily cascade parameters through fixtures - # we set the docker URI in the config for retrieval later on - nipyapi.config.registry_local_name = request.param[1] +def _wait_until_service_up(gui_url: str): + if not nipyapi.utils.wait_to_complete( + nipyapi.utils.is_endpoint_up, + gui_url, + nipyapi_delay=nipyapi.config.long_retry_delay, + nipyapi_max_wait=nipyapi.config.long_max_wait): + pytest.exit(f"Expected Service endpoint ({gui_url}) is not responding") # Tests that the Docker test environment is available before running test suite @pytest.fixture(scope="session", autouse=True) def session_setup(request): log.info("Commencing test session setup") - for this_endpoint in nifi_test_endpoints + [x[0] for x in registry_test_endpoints]: - url = this_endpoint[0] - log.debug("Now Checking URL [{0}]".format(url)) - nipyapi.utils.set_endpoint(*this_endpoint) - # ssl and login will only work if https is in the url, else will silently skip - gui_url = url.replace('-api', '') - if not nipyapi.utils.wait_to_complete( - nipyapi.utils.is_endpoint_up, - gui_url, - nipyapi_delay=nipyapi.config.long_retry_delay, - nipyapi_max_wait=nipyapi.config.long_max_wait): - pytest.exit( - "Expected Service endpoint ({0}) is not responding" - .format(gui_url) + global ACTIVE_CONFIG + + # Resolve configuration once for the entire session + profiles_path = nipyapi.utils.resolve_relative_paths('examples/profiles.yml') + ACTIVE_CONFIG = nipyapi.profiles.resolve_profile_config( + profile_name=ACTIVE_PROFILE, profiles_file_path=profiles_path + ) + + # Configure authentication and SSL using standardized profiles system + nipyapi.profiles.switch(ACTIVE_PROFILE, profiles_file=profiles_path) + log.info("Profile configured: %s", ACTIVE_PROFILE) + + # NiFi readiness check + _wait_until_service_up(nipyapi.config.nifi_config.host.replace('/nifi-api', '/nifi')) + if not nipyapi.canvas.get_root_pg_id(): + raise ValueError("No Response from NiFi test call") + + # NiFi security bootstrapping for secure profiles + if ACTIVE_PROFILE in ('secure-ldap', 'secure-mtls', 'secure-oidc'): + try: + nipyapi.security.bootstrap_security_policies(service='nifi') + log.info("NiFi security policies bootstrapped for %s profile", ACTIVE_PROFILE) + except Exception as e: + log.warning("Security policy bootstrap failed (environment may need setup): %s", e) + if ACTIVE_PROFILE == 'secure-oidc': + log.info("For OIDC: Run 'make sandbox NIPYAPI_PROFILE=secure-oidc' first") + raise + cleanup_nifi() + + # Registry setup (authentication already configured by profiles.switch above) + if nipyapi.config.registry_config.host: + registry_ui_url = nipyapi.config.registry_config.host.replace('/nifi-registry-api', '/nifi-registry') + _wait_until_service_up(registry_ui_url) + + # Registry security bootstrapping + try: + nipyapi.security.bootstrap_security_policies( + service='registry', nifi_proxy_identity=ACTIVE_CONFIG.get('nifi_proxy_identity') ) - # Test API client connection - if 'nifi-api' in url: - if not nipyapi.canvas.get_root_pg_id(): - raise ValueError("No Response from NiFi test call") - # that should've created a new API client connection - api_host = nipyapi.config.nifi_config.api_client.host - if api_host != url: - raise ValueError("Client expected [{0}], but got [{1}] " - "instead".format(url, api_host)) - log.info("Tested NiFi client connection, got response from %s", - url) - if url in [x[0] for x in ldap_nifi_endpoints + mtls_nifi_endpoints]: - nipyapi.security.bootstrap_security_policies(service='nifi') - cleanup_nifi() - elif 'nifi-registry-api' in url: - if nipyapi.registry.FlowsApi().get_available_flow_fields(): - log.info("Tested NiFi-Registry client connection, got " - "response from %s", url) - if 'https://' in url: - # Create user first - nifi_cert_user = nipyapi.security.create_service_user( - identity="CN=localhost, OU=nifi", - service="registry", - strict=False - ) - # Then bootstrap policies with that user - nipyapi.security.bootstrap_security_policies(service='registry', user_identity=nifi_cert_user) - cleanup_reg() - else: - raise ValueError("No Response from NiFi-Registry test call") - else: - raise ValueError("Bad API Endpoint") - for reg_service in registry_test_endpoints: - # needs to run after policy bootstrap - if 'https' in reg_service[1]: - _ = ensure_registry_client(reg_service[1]) + except Exception: + pass + cleanup_reg() + + # Ensure a registry client exists for all profiles + registry_internal_url = ACTIVE_CONFIG.get('registry_internal_url') or nipyapi.config.registry_config.host + _ = nipyapi.versioning.ensure_registry_client( + name=test_registry_client_name, + uri=registry_internal_url, + description=f"Test Registry Client -> {registry_internal_url}" + ) + request.addfinalizer(final_cleanup) log.info("Completing Test Session Setup") def remove_test_templates(): - if nipyapi.utils.enforce_max_ver('2', True): - pass - # Templates are not supported in NiFi 2 - else: - all_templates = nipyapi.templates.list_all_templates(native=False) - if all_templates is not None: - for this_template in all_templates: - if test_basename in this_template.template.name: - nipyapi.templates.delete_template(this_template.id) + # Templates are not supported in NiFi 2.x and the feature is removed from NiPyAPI + return None def remove_test_pgs(): + if SKIP_TEARDOWN: + return None _ = [ nipyapi.canvas.delete_process_group(x, True, True) for x in nipyapi.nifi.ProcessGroupsApi().get_process_groups('root').process_groups @@ -283,6 +142,8 @@ def remove_test_pgs(): def remove_test_processors(): + if SKIP_TEARDOWN: + return None _ = [ nipyapi.canvas.delete_processor(x, force=True) for x in nipyapi.canvas.list_all_processors() @@ -291,6 +152,8 @@ def remove_test_processors(): def remove_test_funnels(): + if SKIP_TEARDOWN: + return None # Note that Funnels cannot be given labels so scoping is by PG only remove_test_connections() _ = [ @@ -300,6 +163,8 @@ def remove_test_funnels(): def remove_test_parameter_contexts(): + if SKIP_TEARDOWN: + return None if nipyapi.utils.check_version('1.10.0') < 1: _ = [ nipyapi.parameters.delete_parameter_context(li) for li @@ -311,30 +176,43 @@ def remove_test_parameter_contexts(): def remove_test_buckets(): + if SKIP_TEARDOWN: + return None _ = [nipyapi.versioning.delete_registry_bucket(li) for li in nipyapi.versioning.list_registry_buckets() if test_bucket_name in li.name] def final_cleanup(): - for this_endpoint in nifi_test_endpoints + [x[0] for x in registry_test_endpoints]: - url = this_endpoint[0] - nipyapi.utils.set_endpoint(*this_endpoint) - if 'nifi-api' in url: - cleanup_nifi() - if (test_ldap or test_mtls) and 'https' in url: - remove_test_service_user_groups('nifi') - remove_test_service_users('nifi') - # removes secure registry client and ssl context service - remove_test_controllers(include_reporting_tasks=True) - elif 'nifi-registry-api' in url: - cleanup_reg() - if (test_ldap or test_mtls) and 'https' in url: - remove_test_service_user_groups('registry') - remove_test_service_users('registry') + if SKIP_TEARDOWN: + log.info("SKIP_TEARDOWN is true; skipping final cleanup") + return None + + # Re-authenticate before cleanup to ensure we have a valid session + # (Some tests may have modified authentication state) + try: + nipyapi.profiles.switch(ACTIVE_PROFILE) + log.debug("Re-authenticated for final cleanup") + except Exception as e: + log.warning("Failed to re-authenticate for cleanup, skipping: %s", e) + return None + + # Cleanup NiFi using authenticated session + cleanup_nifi() + if ACTIVE_PROFILE in ('secure-ldap', 'secure-mtls') and 'https' in ACTIVE_CONFIG['nifi_url']: + remove_test_service_user_groups('nifi') + remove_test_service_users('nifi') + remove_test_controllers(include_reporting_tasks=True) + # Cleanup Registry using authenticated session + cleanup_reg() + if ACTIVE_PROFILE in ('secure-ldap', 'secure-mtls') and 'https' in ACTIVE_CONFIG['registry_url']: + remove_test_service_user_groups('registry') + remove_test_service_users('registry') def remove_test_service_users(service='both'): + if SKIP_TEARDOWN: + return None if service == 'nifi' or service == 'both': _ = [ nipyapi.security.remove_service_user(x, 'nifi') @@ -352,6 +230,8 @@ def remove_test_service_users(service='both'): def remove_test_service_user_groups(service='both'): + if SKIP_TEARDOWN: + return None if service == 'nifi' or service == 'both': _ = [ nipyapi.security.remove_service_user_group(x, 'nifi') for x in @@ -367,14 +247,15 @@ def remove_test_service_user_groups(service='both'): def cleanup_nifi(): + if SKIP_TEARDOWN: + log.info("SKIP_TEARDOWN is true; skipping cleanup_nifi") + return None # Only bulk-cleanup universally compatible components # Ideally we would clean each test environment, but it's too slow to do it # per test, so we rely on individual fixture cleanup log.info("Bulk cleanup called on host %s", nipyapi.config.nifi_config.host) - # Check if NiFi version is 2 or newer - if nipyapi.utils.check_version('2', service='nifi') == 1: # We're on an older version - remove_test_templates() + remove_test_pgs() remove_test_connections() remove_test_controllers() @@ -385,6 +266,8 @@ def cleanup_nifi(): remove_test_parameter_contexts() def remove_test_rpgs(): + if SKIP_TEARDOWN: + return None _ = [ nipyapi.canvas.delete_remote_process_group(x) for x in nipyapi.canvas.list_all_remote_process_groups() @@ -392,6 +275,8 @@ def remove_test_rpgs(): def remove_test_connections(): + if SKIP_TEARDOWN: + return None # Funnels don't have a name, have to go by type _ = [ nipyapi.canvas.delete_connection(x, True) @@ -403,6 +288,8 @@ def remove_test_connections(): def remove_test_ports(): + if SKIP_TEARDOWN: + return None _ = [ nipyapi.canvas.delete_port(x) for x in nipyapi.canvas.list_all_by_kind('input_ports') @@ -416,59 +303,30 @@ def remove_test_ports(): def remove_test_controllers(include_reporting_tasks=False): + if SKIP_TEARDOWN: + return None _ = [nipyapi.canvas.delete_controller(li, True) for li in nipyapi.canvas.list_all_controllers(include_reporting_tasks=include_reporting_tasks) if test_basename in li.component.name] def cleanup_reg(): + if SKIP_TEARDOWN: + log.info("SKIP_TEARDOWN is true; skipping cleanup_reg") + return None # Bulk cleanup for tests involving NiFi Registry remove_test_pgs() remove_test_buckets() - if (test_ldap or test_mtls) and 'https' in nipyapi.registry.configuration.host: + if ACTIVE_PROFILE in ('secure-ldap', 'secure-mtls') and 'https' in nipyapi.registry.configuration.host: remove_test_service_user_groups('registry') remove_test_service_users('registry') @pytest.fixture(name='fix_templates', scope='function') def fixture_templates(request, fix_pg): - log.info("Creating PyTest Fixture fix_templates on endpoint %s", - nipyapi.config.nifi_config.host) - FixtureTemplates = namedtuple( - 'FixtureTemplates', ('pg', 'b_file', 'b_name', 'c_file', - 'c_name', 'g_name', 'g_file') - ) - f_pg = fix_pg - f_b_file = path.join( - path.dirname(__file__), - test_resource_dir, - test_templates['basic'] + '.xml' - ) - f_b_name = 'nipyapi_testTemplate_00' - f_c_file = path.join( - path.dirname(__file__), - test_resource_dir, - test_templates['complex'] + '.xml' - ) - f_c_name = 'nipyapi_testTemplate_01' - f_g_file = path.join( - path.dirname(__file__), - test_resource_dir, - test_templates['greedy'] + '.xml' - ) - f_g_name = 'nipyapi_testTemplate_00_greedy' - out = FixtureTemplates( - pg=f_pg, - b_name=f_b_name, - c_name=f_c_name, - g_name=f_g_name, - b_file=f_b_file, - g_file=f_g_file, - c_file=f_c_file - ) + # Legacy fixture removed; keep a stub so parametrized tests wonโ€™t break during transition request.addfinalizer(remove_test_templates) - log.info("- Returning PyTest Fixture fix_templates") - return out + return None @pytest.fixture(name='fix_pg') @@ -563,9 +421,8 @@ def __init__(self): pass def __call__(self, name=test_bucket_name, suffix=''): - return nipyapi.versioning.create_registry_bucket( - name + suffix - ) + target_name = name + suffix + return nipyapi.versioning.ensure_registry_bucket(target_name) request.addfinalizer(remove_test_buckets) return Dummy() @@ -577,7 +434,11 @@ def fixture_ver_flow(request, fix_bucket, fix_pg, fix_proc): 'FixtureVerFlow', ('client', 'bucket', 'pg', 'proc', 'info', 'flow', 'snapshot', 'dto') ) - f_reg_client = ensure_registry_client(nipyapi.config.registry_local_name) + f_reg_client = nipyapi.versioning.ensure_registry_client( + name=test_registry_client_name, + uri=ACTIVE_CONFIG['registry_internal_url'], + description=f"Test Registry Client -> {ACTIVE_CONFIG['registry_internal_url']}" + ) assert f_reg_client is not None f_pg = fix_pg.generate() f_bucket = fix_bucket() @@ -590,12 +451,29 @@ def fixture_ver_flow(request, fix_bucket, fix_pg, fix_proc): comment='NiPyApi Test', desc='NiPyApi Test' ) - sleep(0.5) - f_flow = nipyapi.versioning.get_flow_in_bucket( - bucket_id=f_bucket.identifier, - identifier=f_info.version_control_information.flow_id, - identifier_type='id' - ) + + # Wait for flow to be available in registry instead of arbitrary sleep + def _check_flow_available(): + try: + flow = nipyapi.versioning.get_flow_in_bucket( + bucket_id=f_bucket.identifier, + identifier=f_info.version_control_information.flow_id, + identifier_type='id' + ) + return flow if flow else False + except Exception: + return False + + flow_result = nipyapi.utils.wait_to_complete( + _check_flow_available, + nipyapi_delay=0.1, # Check every 100ms instead of sleeping for 500ms + nipyapi_max_wait=10 # Wait up to 10 seconds max + ) + + if not flow_result: + raise RuntimeError("Flow not available in registry after save_flow_ver") + + f_flow = flow_result f_snapshot = nipyapi.versioning.get_latest_flow_ver( f_bucket.identifier, f_flow.identifier @@ -715,3 +593,20 @@ def __call__(self, name=test_user_group_name, suffix=''): ) request.addfinalizer(remove_test_service_user_groups) return Dummy() + + +@pytest.fixture(name='fix_profiles', scope='function') +def fixture_profiles(): + """Fixture providing test profile data for profile tests.""" + return { + 'complete': { + 'nifi_url': 'https://localhost:9444/nifi-api', + 'nifi_user': 'einstein', + 'nifi_pass': 'password', + 'oidc_token_endpoint': 'https://keycloak/token' + }, + 'sparse': { + 'nifi_url': 'https://localhost:9444/nifi-api' + # Missing many keys + } + } diff --git a/tests/resources/nipyapi_testFlow_00.xml b/tests/resources/nipyapi_testFlow_00.xml deleted file mode 100644 index 98102438..00000000 --- a/tests/resources/nipyapi_testFlow_00.xml +++ /dev/null @@ -1,82 +0,0 @@ - - - 10 - 5 - - 55f8fd87-0160-1000-f513-59a60afd7c60 - NiFi Flow - - - - 561b5a67-0160-1000-2471-e9e8fb700670 - test - - - - 561b865e-0160-1000-a29c-a029515d9818 - GenerateFlowFile - - - - org.apache.nifi.processors.standard.GenerateFlowFile - - org.apache.nifi - nifi-standard-nar - 1.2.0.3.0.0.0-453 - - 1 - 0 sec - 30 sec - 1 sec - WARN - false - STOPPED - TIMER_DRIVEN - ALL - 0 - - File Size - 0B - - - Batch Size - 1 - - - Data Format - Text - - - Unique FlowFiles - false - - - generate-ff-custom-text - - - - 561b8e25-0160-1000-825b-1cd6fd7d1fa3 - - - - 561b97e7-0160-1000-0231-fb3ecf3852e7 - - - 1 - 0 - 561b865e-0160-1000-a29c-a029515d9818 - 561b5a67-0160-1000-2471-e9e8fb700670 - PROCESSOR - 561b8e25-0160-1000-825b-1cd6fd7d1fa3 - 561b5a67-0160-1000-2471-e9e8fb700670 - FUNNEL - success - 10000 - 1 GB - 0 sec - - - - - - diff --git a/tests/resources/nipyapi_testTemplate_00.xml b/tests/resources/nipyapi_testTemplate_00.xml deleted file mode 100644 index c1f0fc1d..00000000 --- a/tests/resources/nipyapi_testTemplate_00.xml +++ /dev/null @@ -1,251 +0,0 @@ - - diff --git a/tests/resources/nipyapi_testTemplate_00_greedy.xml b/tests/resources/nipyapi_testTemplate_00_greedy.xml deleted file mode 100644 index c2134e33..00000000 --- a/tests/resources/nipyapi_testTemplate_00_greedy.xml +++ /dev/null @@ -1,251 +0,0 @@ - - diff --git a/tests/resources/nipyapi_testTemplate_01.xml b/tests/resources/nipyapi_testTemplate_01.xml deleted file mode 100644 index 6b044cb1..00000000 --- a/tests/resources/nipyapi_testTemplate_01.xml +++ /dev/null @@ -1,1821 +0,0 @@ - -